src/WINNT/afsd/cm_btree.h

   1 /*
   2  * Copyright 2007 Secure Endpoints Inc.
   3  *
   4  * All Rights Reserved.
   5  *
   6  * This software has been released under the terms of the IBM Public
   7  * License.  For details, see the LICENSE file in the top-level source
   8  * directory or online at http://www.openafs.org/dl/license10.html
   9  *
  10  * Thanks to Jan Jannink for B+ tree algorithms.
  11  */
  12
  13 #ifndef BPLUSTREE_H
  14 #define BPLUSTREE_H 1
  15
  16 /********       flag bits (5 of 16 used, 11 for magic value)    ********/
  17
  18 /* bits set at node creation/split/merge */
  19 #define isLEAF          0x01
  20 #define isROOT          0x02
  21 #define isDATA          0x04
  22
  23 /* bits set at key insertion/deletion */
  24 #define isFULL          0x08
  25 #define FEWEST          0x10
  26 #define FLAGS_MASK      0xFF
  27
  28 /* identifies data as being a B+tree node */
  29 #define BTREE_MAGIC           0xBEE0BEE0
  30 #define BTREE_MAGIC_MASK      0xFFFFFFFF
  31
  32
  33 /*************************      constants       ************************/
  34
  35 /* The maximum number of Entrys in one Node */
  36 #define MAX_FANOUT      9
  37
  38 /* corresponds to a NULL node pointer value */
  39 #define NONODE          NULL
  40
  41 /* special node slot values used in key search */
  42 #define BTERROR         -1
  43 #define BTUPPER         -2
  44 #define BTLOWER         -3
  45
  46
  47 /************************* Data Types **********************************/
  48 typedef struct node     *Nptr;
  49
  50 typedef struct key {
  51     char *name;
  52 } keyT;
  53
  54
  55 typedef struct dirdata {
  56     cm_fid_t    fid;
  57     char * longname;
  58     char * origname;
  59 } dataT;
  60
  61 typedef struct entry {
  62     keyT        key;
  63     Nptr        downNode;
  64 } Entry;
  65
  66 typedef struct inner {
  67     short       pairs;
  68     Nptr        firstNode;
  69 } Inner;
  70
  71
  72 typedef struct leaf {
  73     short       pairs;
  74     Nptr        nextNode;
  75 } Leaf;
  76
  77 typedef struct data {
  78     keyT        key;
  79     dataT       value;
  80     Nptr        next;
  81 } Data;
  82
  83 typedef struct node {
  84     Nptr                pool;
  85     unsigned short      number;
  86     unsigned short      flags;
  87     unsigned long       magic;
  88     union {
  89         Entry   e[MAX_FANOUT];  /* allows access to entry array */
  90         Inner   i;
  91         Leaf    l;
  92         Data    d;
  93     } X;
  94 } Node;
  95
  96
  97 typedef int (*KeyCmp)(keyT, keyT, int);
  98 #define EXACT_MATCH 0x01
  99
 100
 101 typedef struct tree {
 102     unsigned int        flags;          /* tree flags */
 103     unsigned int        poolsize;       /* # of nodes allocated for tree */
 104     Nptr                root;           /* pointer to root node */
 105     Nptr                leaf;           /* pointer to first leaf node in B+tree */
 106     unsigned int        fanout;         /* # of pointers to other nodes */
 107     unsigned int        minfanout;      /* usually minfanout == ceil(fanout/2) */
 108     unsigned int        height;         /* nodes traversed from root to leaves */
 109     Nptr                pool;           /* list of all nodes */
 110     Nptr                empty;          /* list of empty nodes */
 111     union {                             /* nodes to change in insert and delete */
 112         Nptr    split;                  /* protected by scp->dirlock write-lock */
 113         Nptr    merge;
 114     } branch;
 115     KeyCmp      keycmp;                 /* pointer to function comparing two keys */
 116     char message[1024];
 117 } Tree;
 118
 119 #define TREE_FLAGS_MASK                 0x01
 120 #define TREE_FLAG_UNIQUE_KEYS           0x01
 121
 122 /************************* B+ tree Public functions ****************/
 123 Tree    *initBtree(unsigned int poolsz, unsigned int fan, KeyCmp keyCmp);
 124 void    freeBtree(Tree *B);
 125
 126 #ifdef DEBUG_BTREE
 127 void    showNode(Tree *B, const char * str, Nptr node);
 128 void    showBtree(Tree *B);
 129 void    listBtreeValues(Tree *B, Nptr start, int count);
 130 void    listAllBtreeValues(Tree *B);
 131 void    listBtreeNodes(Tree *B, const char * where, Nptr node);
 132 void    findAllBtreeValues(Tree *B);
 133 #endif
 134
 135 void    insert(Tree *B, keyT key, dataT data);
 136 void    delete(Tree *B, keyT key);
 137 Nptr    lookup(Tree *B, keyT key);
 138
 139 /******************* cache manager directory operations ***************/
 140
 141 int  cm_BPlusDirLookup(cm_dirOp_t * op, char *entry, cm_fid_t * cfid);
 142 int  cm_BPlusDirLookupOriginalName(cm_dirOp_t * op, char * entry, char ** originalNameRetp);
 143 long cm_BPlusDirCreateEntry(cm_dirOp_t * op, char *entry, cm_fid_t * cfid);
 144 int  cm_BPlusDirDeleteEntry(cm_dirOp_t * op, char *entry);
 145 long cm_BPlusDirBuildTree(cm_scache_t *scp, cm_user_t *userp, cm_req_t* reqp);
 146 void cm_BPlusDumpStats(void);
 147 int cm_MemDumpBPlusStats(FILE *outputFile, char *cookie, int lock);
 148
 149
 150 /******************* directory enumeration operations ****************/
 151 typedef struct cm_direnum_entry {
 152     char *      name;
 153     cm_fid_t    fid;
 154     char        shortName[13];
 155 } cm_direnum_entry_t;
 156
 157 typedef struct cm_direnum {
 158     afs_uint32          count;
 159     afs_uint32          next;
 160     cm_direnum_entry_t  entry[1];
 161 } cm_direnum_t;
 162
 163 long cm_BPlusDirEnumerate(cm_scache_t *scp, afs_uint32 locked, char *maskp, cm_direnum_t **enumpp);
 164 long cm_BPlusDirNextEnumEntry(cm_direnum_t *enump, cm_direnum_entry_t **entrypp);
 165 long cm_BPlusDirFreeEnumeration(cm_direnum_t *enump);
 166 long cm_BPlusDirEnumTest(cm_scache_t * dscp, afs_uint32 locked);
 167
 168 long cm_InitBPlusDir(void);
 169
 170 /************ Statistic Counter ***************************************/
 171
 172 extern afs_uint32 bplus_free_tree;
 173 extern afs_uint32 bplus_dv_error;
 174 extern afs_uint64 bplus_free_time;
 175
 176
 177 /************ Accessor Macros *****************************************/
 178
 179 /* low level definition of Nptr value usage */
 180 #define nAdr(n) (n)->X
 181
 182 /* access keys and pointers in a node */
 183 #define getkey(j, q) (nAdr(j).e[(q)].key)
 184 #define getnode(j, q) (nAdr(j).e[(q)].downNode)
 185 #define setkey(j, q, v) ((q > 0) ? nAdr(j).e[(q)].key.name = strdup((v).name) : NULL)
 186 #define setnode(j, q, v) (nAdr(j).e[(q)].downNode = (v))
 187
 188 /* access tree flag values */
 189 #define settreeflags(B,v) (B->flags |= (v & TREE_FLAGS_MASK))
 190 #define gettreeflags(B)   (B->flags)
 191 #define cleartreeflags(B) (B->flags = 0);
 192
 193 /* access node flag values */
 194 #define setflag(j, v) ((j)->flags |= (v & FLAGS_MASK))
 195 #define clrflag(j, v) ((j)->flags &= ~(v & FLAGS_MASK))
 196 #define getflags(j) ((j)->flags & FLAGS_MASK)
 197 #define getmagic(j)  ((j)->magic & BTREE_MAGIC_MASK)
 198 #define clearflags(j) ((j)->flags = 0, (j)->magic = BTREE_MAGIC)
 199
 200
 201 /* check that a node is in fact a node */
 202 #define isnode(j) (((j) != NONODE) && (((j)->magic & BTREE_MAGIC_MASK) == BTREE_MAGIC) && !((j)->flags & isDATA))
 203 #define isntnode(j) ((j) == NONODE)
 204
 205
 206 /* test individual flag values */
 207 #define isinternal(j) (((j)->flags & isLEAF) == 0)
 208 #define isleaf(j) (((j)->flags & isLEAF) == isLEAF)
 209 #define isdata(j) (((j)->flags & isDATA) == isDATA)
 210 #ifndef DEBUG_BTREE
 211 #define isroot(j) (((j)->flags & isROOT) == isROOT)
 212 #define isfull(j) (((j)->flags & isFULL) == isFULL)
 213 #define isfew(j) (((j)->flags & FEWEST) == FEWEST)
 214 #else
 215 #define isroot(j) _isRoot(B, j)
 216 #define isfew(j) _isFew(B, j)
 217 #define isfull(j) _isFull(B, j)
 218 #endif
 219
 220 /* manage number of keys in a node */
 221 #define numentries(j) (nAdr(j).i.pairs)
 222 #define clearentries(j) (nAdr(j).i.pairs = 0)
 223 #define incentries(j) (nAdr(j).i.pairs++)
 224 #define decentries(j) (nAdr(j).i.pairs--)
 225
 226
 227 /* manage first/last node pointers in internal nodes */
 228 #define setfirstnode(j, v) (nAdr(j).i.firstNode = (v))
 229 #define getfirstnode(j) (nAdr(j).i.firstNode)
 230 #define getlastnode(j) (nAdr(j).e[nAdr(j).i.pairs].downNode)
 231
 232
 233 /* manage pointers to next nodes in leaf nodes */
 234 /* also used for free nodes list */
 235 #define setnextnode(j, v) (nAdr(j).l.nextNode = (v))
 236 #define getnextnode(j) (nAdr(j).l.nextNode)
 237
 238 /* manage pointers to all nodes list */
 239 #define setallnode(j, v) ((j)->pool = (v))
 240 #define getallnode(j) ((j)->pool)
 241
 242 /* manage access to data nodes */
 243 #define getdata(j) (nAdr(j).d)
 244 #define getdatavalue(j) (getdata(j).value)
 245 #define getdatakey(j)   (getdata(j).key)
 246 #define getdatanext(j)  (getdata(j).next)
 247
 248 /* shift/transfer entries for insertion/deletion */
 249 #define clrentry(j, q) _clrentry(j,q)
 250 #define pushentry(j, q, v) _pushentry(j, q, v)
 251 #define pullentry(j, q, v) _pullentry(j, q, v)
 252 #define xferentry(j, q, v, z) _xferentry(j, q, v, z)
 253 #define setentry(j, q, v, z) _setentry(j, q, v, z)
 254
 255 /* define number of B+tree nodes for free node pool */
 256 #define getpoolsize(B) ((B)->poolsize)
 257 #define setpoolsize(B,v) ((B)->poolsize = (v))
 258
 259 /* locations from which tree access begins */
 260 #define getroot(B) ((B)->root)
 261 #define setroot(B,v) ((B)->root = (v))
 262 #define getleaf(B) ((B)->leaf)
 263 #define setleaf(B,v) ((B)->leaf = (v))
 264
 265 /* define max/min number of pointers per node */
 266 #define getfanout(B) ((B)->fanout)
 267 #define setfanout(B,v) ((B)->fanout = (v) - 1)
 268 #define getminfanout(B,j) (isroot(j) ? (isleaf(j) ? 0 : 1) : (isleaf(j) ? (B)->fanout - (B)->minfanout: (B)->minfanout))
 269 #define setminfanout(B,v) ((B)->minfanout = (v) - 1)
 270
 271 /* manage B+tree height */
 272 #define inittreeheight(B) ((B)->height = 0)
 273 #define inctreeheight(B) ((B)->height++)
 274 #define dectreeheight(B) ((B)->height--)
 275 #define gettreeheight(B) ((B)->height)
 276
 277 /* access pool of free nodes */
 278 #define getfirstfreenode(B) ((B)->empty)
 279 #define setfirstfreenode(B,v) ((B)->empty = (v))
 280
 281 /* access all node list */
 282 #define getfirstallnode(B) ((B)->pool)
 283 #define setfirstallnode(B,v) ((B)->pool = (v))
 284
 285 /* handle split/merge points during insert/delete */
 286 #define getsplitpath(B) ((B)->branch.split)
 287 #define setsplitpath(B,v) ((B)->branch.split = (v))
 288 #define getmergepath(B) ((B)->branch.merge)
 289 #define setmergepath(B,v) ((B)->branch.merge = (v))
 290
 291 /* exploit function to compare two B+tree keys */
 292 #define comparekeys(B) (*(B)->keycmp)
 293 #define setcomparekeys(B,v) ((B)->keycmp = (v))
 294
 295 /* location containing B+tree class variables */
 296 #define setbplustree(B,v) ((B) = (Tree *)(v))
 297
 298 /* representation independent node numbering */
 299 #define setnodenumber(B,v,q) ((v)->number = (q))
 300 #define getnodenumber(B,v) ((v) != NONODE ? (v)->number : -1)
 301
 302 #endif /* BPLUSTREE_H */
 303