1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
#![cfg_attr(feature = "nightly", feature(integer_atomics))]

use std;

use atomics::*;
use super::*;
use std::sync::Mutex;
use std::ptr::{null, null_mut};
use smallvec::SmallVec;
use std::fmt;
use std::fmt::{Debug, Display, Formatter};

use tree_policy::TreePolicy;

/// You're not intended to use this class (use an `MCTSManager` instead),
/// but you can use it if you want to manage the threads yourself.
pub struct SearchTree<Spec: MCTS> {
    root_node: SearchNode<Spec>,
    root_state: Spec::State,
    tree_policy: Spec::TreePolicy,
    table: Spec::TranspositionTable,
    eval: Spec::Eval,
    manager: Spec,

    num_nodes: AtomicUsize,
    orphaned: Mutex<Vec<Box<SearchNode<Spec>>>>,
    transposition_table_hits: AtomicUsize,
    delayed_transposition_table_hits: AtomicUsize,
    expansion_contention_events: AtomicUsize,
}

struct NodeStats {
    visits: AtomicUsize,
    sum_evaluations: AtomicI64,
}

pub struct MoveInfo<Spec: MCTS> {
    mov: Move<Spec>,
    move_evaluation: MoveEvaluation<Spec>,
    child: AtomicPtr<SearchNode<Spec>>,
    owned: AtomicBool,
    stats: NodeStats,
}

pub struct SearchNode<Spec: MCTS> {
    moves: Vec<MoveInfo<Spec>>,
    data: Spec::NodeData,
    evaln: StateEvaluation<Spec>,
    stats: NodeStats,
}

impl<Spec: MCTS> SearchNode<Spec> {
    fn new(moves: Vec<MoveInfo<Spec>>,
            evaln: StateEvaluation<Spec>) -> Self {
        Self {
            moves,
            data: Default::default(),
            evaln,
            stats: NodeStats::new(),
        }
    }
}

impl<Spec: MCTS> MoveInfo<Spec> {
    fn new(mov: Move<Spec>, move_evaluation: MoveEvaluation<Spec>) -> Self {
        MoveInfo {
            mov,
            move_evaluation,
            child: AtomicPtr::default(),
            stats: NodeStats::new(),
            owned: AtomicBool::new(false),
        }
    }

    pub fn get_move(&self) -> &Move<Spec> {
        &self.mov
    }

    pub fn move_evaluation(&self) -> &MoveEvaluation<Spec> {
        &self.move_evaluation
    }

    pub fn visits(&self) -> u64 {
        self.stats.visits.load(Ordering::Relaxed) as u64
    }

    pub fn sum_rewards(&self) -> i64 {
        self.stats.sum_evaluations.load(Ordering::Relaxed) as i64
    }

    pub fn child(&self) -> Option<NodeHandle<Spec>> {
        let ptr = self.child.load(Ordering::Relaxed);
        if ptr == null_mut() {
            None
        } else {
            unsafe {Some(NodeHandle {node: &*ptr})}
        }
    }
}

impl<Spec: MCTS> Display for MoveInfo<Spec> where Move<Spec>: Display {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        let own_str = if self.owned.load(Ordering::Relaxed) {
            ""
        } else {
            " [child pointer is alias]"
        };
        if self.visits() == 0 {
            write!(f, "{} [0 visits]{}",
                self.mov,
                own_str)
        } else {
            write!(f, "{} [{} visit{}] [{} avg reward]{}",
                self.mov, self.visits(), if self.visits() == 1 {""} else {"s"},
                self.sum_rewards() as f64 / self.visits() as f64,
                own_str)
        }
    }
}

impl<Spec: MCTS> Debug for MoveInfo<Spec> where Move<Spec>: Debug {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        let own_str = if self.owned.load(Ordering::Relaxed) {
            ""
        } else {
            " [child pointer is alias]"
        };
        if self.visits() == 0 {
            write!(f, "{:?} [0 visits]{}",
                self.mov,
                own_str)
        } else {
            write!(f, "{:?} [{} visit{}] [{} avg reward]{}",
                self.mov, self.visits(), if self.visits() == 1 {""} else {"s"},
                self.sum_rewards() as f64 / self.visits() as f64,
                own_str)
        }
    }
}

impl<Spec: MCTS> Drop for MoveInfo<Spec> {
    fn drop(&mut self) {
        if !self.owned.load(Ordering::SeqCst) {
            return;
        }
        let ptr = self.child.load(Ordering::SeqCst);
        if ptr != null_mut() {
            unsafe {
                Box::from_raw(ptr);
            }
        }
    }
}

fn create_node<Spec: MCTS>(eval: &Spec::Eval, policy: &Spec::TreePolicy, state: &Spec::State,
        handle: Option<SearchHandle<Spec>>) -> SearchNode<Spec> {
    let moves = state.available_moves();
    let (move_eval, state_eval) = eval.evaluate_new_state(&state, &moves, handle);
    policy.validate_evaluations(&move_eval);
    let moves = moves.into_iter()
        .zip(move_eval.into_iter())
        .map(|(m, e)| MoveInfo::new(m, e))
        .collect();
    SearchNode::new(moves, state_eval)
}

fn is_cycle<T>(past: &[&T], current: &T) -> bool {
    past.iter().any(|x| *x as *const T == current as *const T)
}

impl<Spec: MCTS> SearchTree<Spec> {
    pub fn new(state: Spec::State, manager: Spec, tree_policy: Spec::TreePolicy, eval: Spec::Eval,
            table: Spec::TranspositionTable) -> Self {
        let root_node = create_node(&eval, &tree_policy, &state, None);
        Self {
            root_state: state,
            root_node,
            manager,
            tree_policy,
            eval,
            table,
            num_nodes: 1.into(),
            orphaned: Mutex::new(Vec::new()),
            transposition_table_hits: 0.into(),
            delayed_transposition_table_hits: 0.into(),
            expansion_contention_events: 0.into(),
        }
    }

    pub fn reset(self) -> Self {
        Self::new(self.root_state, self.manager, self.tree_policy, self.eval, self.table)
    }

    pub fn spec(&self) -> &Spec {
        &self.manager
    }

    pub fn num_nodes(&self) -> usize {
        self.num_nodes.load(Ordering::SeqCst)
    }

    #[inline(never)]
    pub fn playout(&self, tld: &mut ThreadData<Spec>) -> bool {
        const LARGE_DEPTH: usize = 64;
        let sentinel = IncreaseSentinel::new(&self.num_nodes);
        if sentinel.num_nodes >= self.manager.node_limit() {
            return false;
        }
        let mut state = self.root_state.clone();
        let mut path: SmallVec<[&MoveInfo<Spec>; LARGE_DEPTH]> = SmallVec::new();
        let mut node_path: SmallVec<[&SearchNode<Spec>; LARGE_DEPTH]> = SmallVec::new();
        let mut players: SmallVec<[Player<Spec>; LARGE_DEPTH]> = SmallVec::new();
        let mut did_we_create = false;
        let mut node = &self.root_node;
        loop {
            if node.moves.len() == 0 {
                break;
            }
            if path.len() >= self.manager.max_playout_length() {
                break;
            }
            let choice = self.tree_policy.choose_child(node.moves.iter(), self.make_handle(node, tld));
            choice.stats.down(&self.manager);
            players.push(state.current_player());
            path.push(choice);
            assert!(path.len() <= self.manager.max_playout_length(),
                "playout length exceeded maximum of {} (maybe the transposition table is creating an infinite loop?)",
                self.manager.max_playout_length());
            state.make_move(&choice.mov);
            let (new_node, new_did_we_create) = self.descend(&state, choice, node, tld);
            node = new_node;
            did_we_create = new_did_we_create;
            match self.manager.cycle_behaviour() {
                CycleBehaviour::Ignore => (),
                CycleBehaviour::PanicWhenCycleDetected => if is_cycle(&node_path, node) {
                    panic!("cycle detected! you should do one of the following:\n- make states acyclic\n- remove transposition table\n- change cycle_behaviour()");
                },
                CycleBehaviour::UseCurrentEvalWhenCycleDetected => if is_cycle(&node_path, node) {
                    break;
                },
                CycleBehaviour::UseThisEvalWhenCycleDetected(e) => if is_cycle(&node_path, node) {
                    self.finish_playout(&path, &node_path, &players, tld, &e);
                    return true;
                },
            };
            node_path.push(node);
            node.stats.down(&self.manager);
            if node.stats.visits.load(Ordering::Relaxed) as u64
                    <= self.manager.visits_before_expansion() {
                break;
            }
        }
        let new_evaln = if did_we_create {
            None
        } else {
            Some(self.eval.evaluate_existing_state(&state, &node.evaln, self.make_handle(node, tld)))
        };
        let evaln = new_evaln.as_ref().unwrap_or(&node.evaln);
        self.finish_playout(&path, &node_path, &players, tld, evaln);
        true
    }

    fn descend<'a, 'b>(&'a self, state: &Spec::State, choice: &MoveInfo<Spec>,
            current_node: &'b SearchNode<Spec>, tld: &'b mut ThreadData<Spec>)
            -> (&'a SearchNode<Spec>, bool) {
        let child = choice.child.load(Ordering::Relaxed) as *const _;
        if child != null() {
            return unsafe { (&*child, false) };
        }
        if let Some(node) = self.table.lookup(state, self.make_handle(current_node, tld)) {
            let child = choice.child.compare_and_swap(
                null_mut(),
                node as *const _ as *mut _,
                Ordering::Relaxed) as *const _;
            if child == null() {
                self.transposition_table_hits.fetch_add(1, Ordering::Relaxed);
                return (node, false);
            } else {
                return unsafe { (&*child, false) };
            }
        }
        let created = create_node(&self.eval, &self.tree_policy, state, Some(self.make_handle(current_node, tld)));
        let created = Box::into_raw(Box::new(created));
        let other_child = choice.child.compare_and_swap(
            null_mut(),
            created,
            Ordering::Relaxed);
        if other_child != null_mut() {
            self.expansion_contention_events.fetch_add(1, Ordering::Relaxed);
            unsafe {
                Box::from_raw(created);
                return (&*other_child, false);
            }
        }
        if let Some(existing) = self.table.insert(state, unsafe {&*created}, self.make_handle(current_node, tld)) {
            self.delayed_transposition_table_hits.fetch_add(1, Ordering::Relaxed);
            let existing_ptr = existing as *const _ as *mut _;
            choice.child.store(existing_ptr, Ordering::Relaxed);
            self.orphaned.lock().unwrap().push(unsafe { Box::from_raw(created) });
            return (existing, false);
        }
        choice.owned.store(true, Ordering::Relaxed);
        self.num_nodes.fetch_add(1, Ordering::Relaxed);
        unsafe { (&*created, true) }
    }

    fn finish_playout(&self,
            path: &[&MoveInfo<Spec>],
            node_path: &[&SearchNode<Spec>],
            players: &[Player<Spec>],
            tld: &mut ThreadData<Spec>,
            evaln: &StateEvaluation<Spec>) {
        for ((move_info, player), node) in
                path.iter()
                .zip(players.iter())
                .zip(node_path.iter())
                .rev() {
            let evaln_value = self.eval.interpret_evaluation_for_player(evaln, player);
            node.stats.up(&self.manager, evaln_value);
            move_info.stats.replace(&node.stats);
            unsafe {
                self.manager.on_backpropagation(&evaln, self.make_handle(&*move_info.child.load(Ordering::Relaxed), tld));
            }
        }
        self.manager.on_backpropagation(&evaln, self.make_handle(&self.root_node, tld));
    }

    fn make_handle<'a>(&'a self, node: &'a SearchNode<Spec>, tld: &'a mut ThreadData<Spec>)
            -> SearchHandle<'a, Spec> {
        SearchHandle {node, tld, manager: &self.manager}
    }

    pub fn root_state(&self) -> &Spec::State {
        &self.root_state
    }
    pub fn root_node(&self) -> NodeHandle<Spec> {
        NodeHandle {
            node: &self.root_node
        }
    }

    pub fn principal_variation(&self, num_moves: usize) -> Vec<MoveInfoHandle<Spec>> {
        let mut result = Vec::new();
        let mut crnt = &self.root_node;
        while crnt.moves.len() != 0 && result.len() < num_moves {
            let choice = self.manager.select_child_after_search(&crnt.moves);
            result.push(choice);
            let child = choice.child.load(Ordering::SeqCst) as *const SearchNode<Spec>;
            if child == null() {
                break;
            } else {
                unsafe {
                    crnt = &*child;
                }
            }
        }
        result
    }

    pub fn diagnose(&self) -> String {
        let mut s = String::new();
        s.push_str(&format!("{} nodes\n", thousands_separate(self.num_nodes.load(Ordering::Relaxed))));
        s.push_str(&format!("{} transposition table hits\n", thousands_separate(self.transposition_table_hits.load(Ordering::Relaxed))));
        s.push_str(&format!("{} delayed transposition table hits\n", thousands_separate(self.delayed_transposition_table_hits.load(Ordering::Relaxed))));
        s.push_str(&format!("{} expansion contention events\n", thousands_separate(self.expansion_contention_events.load(Ordering::Relaxed))));
        s.push_str(&format!("{} orphaned nodes\n", self.orphaned.lock().unwrap().len()));
        s
    }
}

pub type MoveInfoHandle<'a, Spec> = &'a MoveInfo<Spec>;

impl<Spec: MCTS> SearchTree<Spec> where Move<Spec>: Debug {
    pub fn debug_moves(&self) {
        let mut moves: Vec<&MoveInfo<Spec>> = self.root_node.moves.iter().collect();
        moves.sort_by_key(|x| -(x.visits() as i64));
        for mov in moves {
            println!("{:?}", mov);
        }
    }
}

impl<Spec: MCTS> SearchTree<Spec> where Move<Spec>: Display {
    pub fn display_moves(&self) {
        let mut moves: Vec<&MoveInfo<Spec>> = self.root_node.moves.iter().collect();
        moves.sort_by_key(|x| -(x.visits() as i64));
        for mov in moves {
            println!("{}", mov);
        }
    }
}

#[derive(Clone, Copy)]
pub struct NodeHandle<'a, Spec: 'a + MCTS> {
    node: &'a SearchNode<Spec>,
}

impl<'a, Spec: MCTS> NodeHandle<'a, Spec> {
    pub fn data(&self) -> &'a Spec::NodeData {
        &self.node.data
    }
    pub fn moves(&self) -> Moves<Spec> {
        Moves {
            iter: self.node.moves.iter()
        }
    }
    pub fn into_raw(&self) -> *const () {
        self.node as *const _ as *const ()
    }
    pub unsafe fn from_raw(ptr: *const ()) -> Self {
        NodeHandle {
            node: &*(ptr as *const SearchNode<Spec>)
        }
    }
}

#[derive(Clone)]
pub struct Moves<'a, Spec: 'a + MCTS> {
    iter: std::slice::Iter<'a, MoveInfo<Spec>>,
}

impl<'a, Spec: 'a + MCTS> Iterator for Moves<'a, Spec> {
    type Item = &'a MoveInfo<Spec>;
    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next()
    }
}

pub struct SearchHandle<'a, Spec: 'a + MCTS> {
    node: &'a SearchNode<Spec>,
    tld: &'a mut ThreadData<Spec>,
    manager: &'a Spec,
}

impl<'a, Spec: MCTS> SearchHandle<'a, Spec> {
    pub fn node(&self) -> NodeHandle<'a, Spec> {
        NodeHandle {node: self.node}
    }
    pub fn thread_data(&mut self) -> &mut ThreadData<Spec> {
        self.tld
    }
    pub fn mcts(&self) -> &'a Spec {
        self.manager
    }
}

impl NodeStats {
    fn new() -> Self {
        NodeStats {
            sum_evaluations: AtomicI64::new(0),
            visits: AtomicUsize::new(0),
        }
    }
    fn down<Spec: MCTS>(&self, manager: &Spec) {
        self.sum_evaluations.fetch_sub(manager.virtual_loss() as FakeI64, Ordering::Relaxed);
        self.visits.fetch_add(1, Ordering::Relaxed);
    }
    fn up<Spec: MCTS>(&self, manager: &Spec, evaln: i64) {
        let delta = evaln + manager.virtual_loss();
        self.sum_evaluations.fetch_add(delta as FakeI64, Ordering::Relaxed);
    }
    fn replace(&self, other: &NodeStats) {
        self.visits.store(other.visits.load(Ordering::Relaxed), Ordering::Relaxed);
        self.sum_evaluations.store(other.sum_evaluations.load(Ordering::Relaxed), Ordering::Relaxed);
    }
}

struct IncreaseSentinel<'a> {
    x: &'a AtomicUsize,
    num_nodes: usize
}

impl<'a> IncreaseSentinel<'a> {
    fn new(x: &'a AtomicUsize) -> Self {
        let num_nodes = x.fetch_add(1, Ordering::Relaxed);
        Self {x, num_nodes}
    }
}

impl<'a> Drop for IncreaseSentinel<'a> {
    fn drop(&mut self) {
        self.x.fetch_sub(1, Ordering::Relaxed);
    }
}