uct/tree.h

   1 #ifndef ZZGO_UCT_TREE_H
   2 #define ZZGO_UCT_TREE_H
   3
   4 /* Management of UCT trees. See diagram below for the node structure.
   5  *
   6  * Two allocation methods are supported for the tree nodes:
   7  *
   8  * - calloc/free: each node is allocated with one calloc.
   9  *   After a move, all nodes except the subtree rooted at
  10  *   the played move are freed one by one with free().
  11  *   Since this can be very slow (seen 9s and loss on time because
  12  *   of this) the nodes are freed in a background thread.
  13  *   We still reserve enough memory for the next move in case
  14  *   the background thread doesn't free nodes fast enough.
  15  *
  16  * - fast_alloc: a large buffer is allocated once, and each
  17  *   node allocation takes some of this buffer. After a move
  18  *   is played, no memory if freed if the buffer still has
  19  *   enough free space. Otherwise the subtree rooted at the
  20  *   played move is copied to a temporary buffer, pruning it
  21  *   if necessary to fit in this small buffer. We copy by
  22  *   preference nodes with largest number of playouts.
  23  *   Then the temporary buffer is copied back to the original
  24  *   buffer, which has now plenty of space.
  25  *   Once the fast_alloc mode is proven reliable, the
  26  *   calloc/free method will be removed. */
  27
  28 #include <stdbool.h>
  29 #include <pthread.h>
  30 #include "move.h"
  31 #include "stats.h"
  32 #include "probdist.h"
  33
  34 struct board;
  35 struct uct;
  36
  37 /*
  38  *            +------+
  39  *            | node |
  40  *            +------+
  41  *          / <- parent
  42  * +------+   v- sibling +------+
  43  * | node | ------------ | node |
  44  * +------+              +------+
  45  *    | <- children          |
  46  * +------+   +------+   +------+   +------+
  47  * | node | - | node |   | node | - | node |
  48  * +------+   +------+   +------+   +------+
  49  */
  50
  51 /* TODO: Performance would benefit from a reorganization:
  52  * (i) Allocate all children of a node within a single block.
  53  * (ii) Keep all u stats together, and all amaf stats together.
  54  * Currently, rave_update is top source of cache misses, and
  55  * there is large memory overhead for having all nodes separate. */
  56
  57 struct tree_node {
  58         hash_t hash;
  59         struct tree_node *parent, *sibling, *children;
  60
  61         /*** From here on, struct is saved/loaded from opening book */
  62
  63         unsigned short depth; // just for statistics
  64
  65         /* Common Fate Graph distance from parent, but at most TREE_NODE_D_MAX+1 */
  66 #define TREE_NODE_D_MAX 3
  67         unsigned char d;
  68
  69 #define TREE_HINT_INVALID 1 // don't go to this node, invalid move
  70         unsigned char hints;
  71
  72         /* coord is usually coord_t, but this is very space-sensitive. */
  73         short coord;
  74
  75         /* In case multiple threads walk the tree, is_expanded is set
  76          * atomically. Only the first thread setting it expands the node.
  77          * The node goes through 3 states:
  78          *   1) children == null, is_expanded == false: leaf node
  79          *   2) children == null, is_expanded == true: one thread currently expanding
  80          *   2) children != null, is_expanded == true: fully expanded node */
  81         bool is_expanded;
  82
  83         struct move_stats u;
  84         struct move_stats prior;
  85         /* XXX: Should be way for policies to add their own stats */
  86         struct move_stats amaf;
  87         /* Stats before starting playout; used for distributed engine. */
  88         struct move_stats pu;
  89 };
  90
  91 struct tree_hash;
  92
  93 struct tree {
  94         struct board *board;
  95         struct tree_node *root;
  96         struct board_symmetry root_symmetry;
  97         enum stone root_color;
  98
  99         /* Whether to use any extra komi during score counting. This is
 100          * tree-specific variable since this can arbitrarily change between
 101          * moves. */
 102         bool use_extra_komi;
 103         /* The value of applied extra komi. For DYNKOMI_LINEAR, this value
 104          * is only informative, the actual value is computed per simulation
 105          * based on leaf node depth. */
 106         float extra_komi;
 107
 108         /* We merge local (non-tenuki) sequences for both colors, occuring
 109          * anywhere in the tree; nodes are created on-demand, special 'pass'
 110          * nodes represent tenuki. Only u move_stats are used, prior and amaf
 111          * is ignored. Values in root node are ignored. */
 112         /* The values in the tree can be either "raw" or "tempered"
 113          * (representing difference against parent node in the main tree),
 114          * controlled by local_tree setting. */
 115         struct tree_node *ltree_black;
 116         // Of course even in white tree, winrates are from b's perspective
 117         // as anywhere else. ltree_white has white-first sequences as children.
 118         struct tree_node *ltree_white;
 119         // Aging factor; 2 means halve all playout values after each turn.
 120         // 1 means don't age at all.
 121         float ltree_aging;
 122
 123         /* Hash table used when working as slave for the distributed engine.
 124          * Maps coordinate path to tree node. */
 125         struct tree_hash *htable;
 126         int hbits;
 127
 128         // Statistics
 129         int max_depth;
 130         volatile unsigned long nodes_size; // byte size of all allocated nodes
 131         unsigned long max_tree_size; // maximum byte size for entire tree, > 0 only for fast_alloc
 132         void *nodes; // nodes buffer, only for fast_alloc
 133 };
 134
 135 /* Warning: all functions below except tree_expand_node & tree_leaf_node are THREAD-UNSAFE! */
 136 struct tree *tree_init(struct board *board, enum stone color, unsigned long max_tree_size, float ltree_aging, int hbits);
 137 void tree_done(struct tree *tree);
 138 void tree_dump(struct tree *tree, int thres);
 139 void tree_save(struct tree *tree, struct board *b, int thres);
 140 void tree_load(struct tree *tree, struct board *b);
 141
 142 struct tree_node *tree_get_node(struct tree *tree, struct tree_node *node, coord_t c, bool create);
 143 struct tree_node *tree_garbage_collect(struct tree *tree, unsigned long max_size, struct tree_node *node);
 144 void tree_promote_node(struct tree *tree, struct tree_node **node);
 145 bool tree_promote_at(struct tree *tree, struct board *b, coord_t c);
 146
 147 void tree_expand_node(struct tree *tree, struct tree_node *node, struct board *b, enum stone color, struct uct *u, int parity);
 148 struct tree_node *tree_lnode_for_node(struct tree *tree, struct tree_node *ni, struct tree_node *lni, int tenuki_d);
 149
 150 static bool tree_leaf_node(struct tree_node *node);
 151
 152 /* Get black parity from parity within the tree. */
 153 #define tree_parity(tree, parity) \
 154         (tree->root_color == S_WHITE ? (parity) : -1 * (parity))
 155
 156 /* Get a 0..1 value to maximize; @parity is parity within the tree. */
 157 #define tree_node_get_value(tree, parity, value) \
 158         (tree_parity(tree, parity) > 0 ? value : 1 - value)
 159
 160 static inline bool
 161 tree_leaf_node(struct tree_node *node)
 162 {
 163         return !(node->children);
 164 }
 165
 166 /* Leave always at least 10% memory free for the next move: */
 167 #define MIN_FREE_MEM_PERCENT 10ULL
 168
 169 #endif