sys/vfs/hammer/hammer_btree.c

   1 /*
   2  * Copyright (c) 2007-2008 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/vfs/hammer/hammer_btree.c,v 1.66 2008/07/07 22:42:35 dillon Exp $
  35  */
  36
  37 /*
  38  * HAMMER B-Tree index
  39  *
  40  * HAMMER implements a modified B+Tree.  In documentation this will
  41  * simply be refered to as the HAMMER B-Tree.  Basically a HAMMER B-Tree
  42  * looks like a B+Tree (A B-Tree which stores its records only at the leafs
  43  * of the tree), but adds two additional boundary elements which describe
  44  * the left-most and right-most element a node is able to represent.  In
  45  * otherwords, we have boundary elements at the two ends of a B-Tree node
  46  * instead of sub-tree pointers.
  47  *
  48  * A B-Tree internal node looks like this:
  49  *
  50  *      B N N N N N N B   <-- boundary and internal elements
  51  *       S S S S S S S    <-- subtree pointers
  52  *
  53  * A B-Tree leaf node basically looks like this:
  54  *
  55  *      L L L L L L L L   <-- leaf elemenets
  56  *
  57  * The radix for an internal node is 1 less then a leaf but we get a
  58  * number of significant benefits for our troubles.
  59  *
  60  * The big benefit to using a B-Tree containing boundary information
  61  * is that it is possible to cache pointers into the middle of the tree
  62  * and not have to start searches, insertions, OR deletions at the root
  63  * node.   In particular, searches are able to progress in a definitive
  64  * direction from any point in the tree without revisting nodes.  This
  65  * greatly improves the efficiency of many operations, most especially
  66  * record appends.
  67  *
  68  * B-Trees also make the stacking of trees fairly straightforward.
  69  *
  70  * INSERTIONS:  A search performed with the intention of doing
  71  * an insert will guarantee that the terminal leaf node is not full by
  72  * splitting full nodes.  Splits occur top-down during the dive down the
  73  * B-Tree.
  74  *
  75  * DELETIONS: A deletion makes no attempt to proactively balance the
  76  * tree and will recursively remove nodes that become empty.  If a
  77  * deadlock occurs a deletion may not be able to remove an empty leaf.
  78  * Deletions never allow internal nodes to become empty (that would blow
  79  * up the boundaries).
  80  */
  81 #include "hammer.h"
  82 #include <sys/buf.h>
  83 #include <sys/buf2.h>
  84
  85 static int btree_search(hammer_cursor_t cursor, int flags);
  86 static int btree_split_internal(hammer_cursor_t cursor);
  87 static int btree_split_leaf(hammer_cursor_t cursor);
  88 static int btree_remove(hammer_cursor_t cursor);
  89 static int btree_node_is_full(hammer_node_ondisk_t node);
  90 static int hammer_btree_mirror_propagate(hammer_cursor_t cursor,
  91                         hammer_tid_t mirror_tid);
  92 static void hammer_make_separator(hammer_base_elm_t key1,
  93                         hammer_base_elm_t key2, hammer_base_elm_t dest);
  94
  95 /*
  96  * Iterate records after a search.  The cursor is iterated forwards past
  97  * the current record until a record matching the key-range requirements
  98  * is found.  ENOENT is returned if the iteration goes past the ending
  99  * key.
 100  *
 101  * The iteration is inclusive of key_beg and can be inclusive or exclusive
 102  * of key_end depending on whether HAMMER_CURSOR_END_INCLUSIVE is set.
 103  *
 104  * When doing an as-of search (cursor->asof != 0), key_beg.create_tid
 105  * may be modified by B-Tree functions.
 106  *
 107  * cursor->key_beg may or may not be modified by this function during
 108  * the iteration.  XXX future - in case of an inverted lock we may have
 109  * to reinitiate the lookup and set key_beg to properly pick up where we
 110  * left off.
 111  *
 112  * NOTE!  EDEADLK *CANNOT* be returned by this procedure.
 113  */
 114 int
 115 hammer_btree_iterate(hammer_cursor_t cursor)
 116 {
 117         hammer_node_ondisk_t node;
 118         hammer_btree_elm_t elm;
 119         int error;
 120         int r;
 121         int s;
 122
 123         /*
 124          * Skip past the current record
 125          */
 126         node = cursor->node->ondisk;
 127         if (node == NULL)
 128                 return(ENOENT);
 129         if (cursor->index < node->count &&
 130             (cursor->flags & HAMMER_CURSOR_ATEDISK)) {
 131                 ++cursor->index;
 132         }
 133
 134         /*
 135          * Loop until an element is found or we are done.
 136          */
 137         for (;;) {
 138                 /*
 139                  * We iterate up the tree and then index over one element
 140                  * while we are at the last element in the current node.
 141                  *
 142                  * If we are at the root of the filesystem, cursor_up
 143                  * returns ENOENT.
 144                  *
 145                  * XXX this could be optimized by storing the information in
 146                  * the parent reference.
 147                  *
 148                  * XXX we can lose the node lock temporarily, this could mess
 149                  * up our scan.
 150                  */
 151                 ++hammer_stats_btree_iterations;
 152                 hammer_flusher_clean_loose_ios(cursor->trans->hmp);
 153
 154                 if (cursor->index == node->count) {
 155                         if (hammer_debug_btree) {
 156                                 kprintf("BRACKETU %016llx[%d] -> %016llx[%d] (td=%p)\n",
 157                                         cursor->node->node_offset,
 158                                         cursor->index,
 159                                         (cursor->parent ? cursor->parent->node_offset : -1),
 160                                         cursor->parent_index,
 161                                         curthread);
 162                         }
 163                         KKASSERT(cursor->parent == NULL || cursor->parent->ondisk->elms[cursor->parent_index].internal.subtree_offset == cursor->node->node_offset);
 164                         error = hammer_cursor_up(cursor);
 165                         if (error)
 166                                 break;
 167                         /* reload stale pointer */
 168                         node = cursor->node->ondisk;
 169                         KKASSERT(cursor->index != node->count);
 170
 171                         /*
 172                          * If we are reblocking we want to return internal
 173                          * nodes.
 174                          */
 175                         if (cursor->flags & HAMMER_CURSOR_REBLOCKING) {
 176                                 cursor->flags |= HAMMER_CURSOR_ATEDISK;
 177                                 return(0);
 178                         }
 179                         ++cursor->index;
 180                         continue;
 181                 }
 182
 183                 /*
 184                  * Check internal or leaf element.  Determine if the record
 185                  * at the cursor has gone beyond the end of our range.
 186                  *
 187                  * We recurse down through internal nodes.
 188                  */
 189                 if (node->type == HAMMER_BTREE_TYPE_INTERNAL) {
 190                         elm = &node->elms[cursor->index];
 191
 192                         r = hammer_btree_cmp(&cursor->key_end, &elm[0].base);
 193                         s = hammer_btree_cmp(&cursor->key_beg, &elm[1].base);
 194                         if (hammer_debug_btree) {
 195                                 kprintf("BRACKETL %016llx[%d] %016llx %02x %016llx lo=%02x %d (td=%p)\n",
 196                                         cursor->node->node_offset,
 197                                         cursor->index,
 198                                         elm[0].internal.base.obj_id,
 199                                         elm[0].internal.base.rec_type,
 200                                         elm[0].internal.base.key,
 201                                         elm[0].internal.base.localization,
 202                                         r,
 203                                         curthread
 204                                 );
 205                                 kprintf("BRACKETR %016llx[%d] %016llx %02x %016llx lo=%02x %d\n",
 206                                         cursor->node->node_offset,
 207                                         cursor->index + 1,
 208                                         elm[1].internal.base.obj_id,
 209                                         elm[1].internal.base.rec_type,
 210                                         elm[1].internal.base.key,
 211                                         elm[1].internal.base.localization,
 212                                         s
 213                                 );
 214                         }
 215
 216                         if (r < 0) {
 217                                 error = ENOENT;
 218                                 break;
 219                         }
 220                         if (r == 0 && (cursor->flags &
 221                                        HAMMER_CURSOR_END_INCLUSIVE) == 0) {
 222                                 error = ENOENT;
 223                                 break;
 224                         }
 225                         KKASSERT(s <= 0);
 226
 227                         /*
 228                          * Better not be zero
 229                          */
 230                         KKASSERT(elm->internal.subtree_offset != 0);
 231
 232                         /*
 233                          * If running the mirror filter see if we can skip
 234                          * the entire sub-tree.
 235                          */
 236                         if (cursor->flags & HAMMER_CURSOR_MIRROR_FILTERED) {
 237                                 if (elm->internal.mirror_tid <
 238                                     cursor->mirror_tid) {
 239                                         ++cursor->index;
 240                                         continue;
 241                                 }
 242                         }
 243
 244                         error = hammer_cursor_down(cursor);
 245                         if (error)
 246                                 break;
 247                         KKASSERT(cursor->index == 0);
 248                         /* reload stale pointer */
 249                         node = cursor->node->ondisk;
 250                         continue;
 251                 } else {
 252                         elm = &node->elms[cursor->index];
 253                         r = hammer_btree_cmp(&cursor->key_end, &elm->base);
 254                         if (hammer_debug_btree) {
 255                                 kprintf("ELEMENT  %016llx:%d %c %016llx %02x %016llx lo=%02x %d\n",
 256                                         cursor->node->node_offset,
 257                                         cursor->index,
 258                                         (elm[0].leaf.base.btype ?
 259                                          elm[0].leaf.base.btype : '?'),
 260                                         elm[0].leaf.base.obj_id,
 261                                         elm[0].leaf.base.rec_type,
 262                                         elm[0].leaf.base.key,
 263                                         elm[0].leaf.base.localization,
 264                                         r
 265                                 );
 266                         }
 267                         if (r < 0) {
 268                                 error = ENOENT;
 269                                 break;
 270                         }
 271
 272                         /*
 273                          * We support both end-inclusive and
 274                          * end-exclusive searches.
 275                          */
 276                         if (r == 0 &&
 277                            (cursor->flags & HAMMER_CURSOR_END_INCLUSIVE) == 0) {
 278                                 error = ENOENT;
 279                                 break;
 280                         }
 281
 282                         switch(elm->leaf.base.btype) {
 283                         case HAMMER_BTREE_TYPE_RECORD:
 284                                 if ((cursor->flags & HAMMER_CURSOR_ASOF) &&
 285                                     hammer_btree_chkts(cursor->asof, &elm->base)) {
 286                                         ++cursor->index;
 287                                         continue;
 288                                 }
 289                                 break;
 290                         default:
 291                                 error = EINVAL;
 292                                 break;
 293                         }
 294                         if (error)
 295                                 break;
 296                 }
 297                 /*
 298                  * node pointer invalid after loop
 299                  */
 300
 301                 /*
 302                  * Return entry
 303                  */
 304                 if (hammer_debug_btree) {
 305                         int i = cursor->index;
 306                         hammer_btree_elm_t elm = &cursor->node->ondisk->elms[i];
 307                         kprintf("ITERATE  %p:%d %016llx %02x %016llx lo=%02x\n",
 308                                 cursor->node, i,
 309                                 elm->internal.base.obj_id,
 310                                 elm->internal.base.rec_type,
 311                                 elm->internal.base.key,
 312                                 elm->internal.base.localization
 313                         );
 314                 }
 315                 return(0);
 316         }
 317         return(error);
 318 }
 319
 320 /*
 321  * Iterate in the reverse direction.  This is used by the pruning code to
 322  * avoid overlapping records.
 323  */
 324 int
 325 hammer_btree_iterate_reverse(hammer_cursor_t cursor)
 326 {
 327         hammer_node_ondisk_t node;
 328         hammer_btree_elm_t elm;
 329         int error;
 330         int r;
 331         int s;
 332
 333         /*
 334          * Skip past the current record.  For various reasons the cursor
 335          * may end up set to -1 or set to point at the end of the current
 336          * node.  These cases must be addressed.
 337          */
 338         node = cursor->node->ondisk;
 339         if (node == NULL)
 340                 return(ENOENT);
 341         if (cursor->index != -1 &&
 342             (cursor->flags & HAMMER_CURSOR_ATEDISK)) {
 343                 --cursor->index;
 344         }
 345         if (cursor->index == cursor->node->ondisk->count)
 346                 --cursor->index;
 347
 348         /*
 349          * Loop until an element is found or we are done.
 350          */
 351         for (;;) {
 352                 ++hammer_stats_btree_iterations;
 353                 hammer_flusher_clean_loose_ios(cursor->trans->hmp);
 354
 355                 /*
 356                  * We iterate up the tree and then index over one element
 357                  * while we are at the last element in the current node.
 358                  */
 359                 if (cursor->index == -1) {
 360                         error = hammer_cursor_up(cursor);
 361                         if (error) {
 362                                 cursor->index = 0; /* sanity */
 363                                 break;
 364                         }
 365                         /* reload stale pointer */
 366                         node = cursor->node->ondisk;
 367                         KKASSERT(cursor->index != node->count);
 368                         --cursor->index;
 369                         continue;
 370                 }
 371
 372                 /*
 373                  * Check internal or leaf element.  Determine if the record
 374                  * at the cursor has gone beyond the end of our range.
 375                  *
 376                  * We recurse down through internal nodes.
 377                  */
 378                 KKASSERT(cursor->index != node->count);
 379                 if (node->type == HAMMER_BTREE_TYPE_INTERNAL) {
 380                         elm = &node->elms[cursor->index];
 381                         r = hammer_btree_cmp(&cursor->key_end, &elm[0].base);
 382                         s = hammer_btree_cmp(&cursor->key_beg, &elm[1].base);
 383                         if (hammer_debug_btree) {
 384                                 kprintf("BRACKETL %016llx[%d] %016llx %02x %016llx lo=%02x %d\n",
 385                                         cursor->node->node_offset,
 386                                         cursor->index,
 387                                         elm[0].internal.base.obj_id,
 388                                         elm[0].internal.base.rec_type,
 389                                         elm[0].internal.base.key,
 390                                         elm[0].internal.base.localization,
 391                                         r
 392                                 );
 393                                 kprintf("BRACKETR %016llx[%d] %016llx %02x %016llx lo=%02x %d\n",
 394                                         cursor->node->node_offset,
 395                                         cursor->index + 1,
 396                                         elm[1].internal.base.obj_id,
 397                                         elm[1].internal.base.rec_type,
 398                                         elm[1].internal.base.key,
 399                                         elm[1].internal.base.localization,
 400                                         s
 401                                 );
 402                         }
 403
 404                         if (s >= 0) {
 405                                 error = ENOENT;
 406                                 break;
 407                         }
 408                         KKASSERT(r >= 0);
 409
 410                         /*
 411                          * Better not be zero
 412                          */
 413                         KKASSERT(elm->internal.subtree_offset != 0);
 414
 415                         error = hammer_cursor_down(cursor);
 416                         if (error)
 417                                 break;
 418                         KKASSERT(cursor->index == 0);
 419                         /* reload stale pointer */
 420                         node = cursor->node->ondisk;
 421
 422                         /* this can assign -1 if the leaf was empty */
 423                         cursor->index = node->count - 1;
 424                         continue;
 425                 } else {
 426                         elm = &node->elms[cursor->index];
 427                         s = hammer_btree_cmp(&cursor->key_beg, &elm->base);
 428                         if (hammer_debug_btree) {
 429                                 kprintf("ELEMENT  %016llx:%d %c %016llx %02x %016llx lo=%02x %d\n",
 430                                         cursor->node->node_offset,
 431                                         cursor->index,
 432                                         (elm[0].leaf.base.btype ?
 433                                          elm[0].leaf.base.btype : '?'),
 434                                         elm[0].leaf.base.obj_id,
 435                                         elm[0].leaf.base.rec_type,
 436                                         elm[0].leaf.base.key,
 437                                         elm[0].leaf.base.localization,
 438                                         s
 439                                 );
 440                         }
 441                         if (s > 0) {
 442                                 error = ENOENT;
 443                                 break;
 444                         }
 445
 446                         switch(elm->leaf.base.btype) {
 447                         case HAMMER_BTREE_TYPE_RECORD:
 448                                 if ((cursor->flags & HAMMER_CURSOR_ASOF) &&
 449                                     hammer_btree_chkts(cursor->asof, &elm->base)) {
 450                                         --cursor->index;
 451                                         continue;
 452                                 }
 453                                 break;
 454                         default:
 455                                 error = EINVAL;
 456                                 break;
 457                         }
 458                         if (error)
 459                                 break;
 460                 }
 461                 /*
 462                  * node pointer invalid after loop
 463                  */
 464
 465                 /*
 466                  * Return entry
 467                  */
 468                 if (hammer_debug_btree) {
 469                         int i = cursor->index;
 470                         hammer_btree_elm_t elm = &cursor->node->ondisk->elms[i];
 471                         kprintf("ITERATE  %p:%d %016llx %02x %016llx lo=%02x\n",
 472                                 cursor->node, i,
 473                                 elm->internal.base.obj_id,
 474                                 elm->internal.base.rec_type,
 475                                 elm->internal.base.key,
 476                                 elm->internal.base.localization
 477                         );
 478                 }
 479                 return(0);
 480         }
 481         return(error);
 482 }
 483
 484 /*
 485  * Lookup cursor->key_beg.  0 is returned on success, ENOENT if the entry
 486  * could not be found, EDEADLK if inserting and a retry is needed, and a
 487  * fatal error otherwise.  When retrying, the caller must terminate the
 488  * cursor and reinitialize it.  EDEADLK cannot be returned if not inserting.
 489  *
 490  * The cursor is suitably positioned for a deletion on success, and suitably
 491  * positioned for an insertion on ENOENT if HAMMER_CURSOR_INSERT was
 492  * specified.
 493  *
 494  * The cursor may begin anywhere, the search will traverse the tree in
 495  * either direction to locate the requested element.
 496  *
 497  * Most of the logic implementing historical searches is handled here.  We
 498  * do an initial lookup with create_tid set to the asof TID.  Due to the
 499  * way records are laid out, a backwards iteration may be required if
 500  * ENOENT is returned to locate the historical record.  Here's the
 501  * problem:
 502  *
 503  * create_tid:    10      15       20
 504  *                   LEAF1   LEAF2
 505  * records:         (11)        (18)
 506  *
 507  * Lets say we want to do a lookup AS-OF timestamp 17.  We will traverse
 508  * LEAF2 but the only record in LEAF2 has a create_tid of 18, which is
 509  * not visible and thus causes ENOENT to be returned.  We really need
 510  * to check record 11 in LEAF1.  If it also fails then the search fails
 511  * (e.g. it might represent the range 11-16 and thus still not match our
 512  * AS-OF timestamp of 17).  Note that LEAF1 could be empty, requiring
 513  * further iterations.
 514  *
 515  * If this case occurs btree_search() will set HAMMER_CURSOR_CREATE_CHECK
 516  * and the cursor->create_check TID if an iteration might be needed.
 517  * In the above example create_check would be set to 14.
 518  */
 519 int
 520 hammer_btree_lookup(hammer_cursor_t cursor)
 521 {
 522         int error;
 523
 524         ++hammer_stats_btree_lookups;
 525         if (cursor->flags & HAMMER_CURSOR_ASOF) {
 526                 KKASSERT((cursor->flags & HAMMER_CURSOR_INSERT) == 0);
 527                 cursor->key_beg.create_tid = cursor->asof;
 528                 for (;;) {
 529                         cursor->flags &= ~HAMMER_CURSOR_CREATE_CHECK;
 530                         error = btree_search(cursor, 0);
 531                         if (error != ENOENT ||
 532                             (cursor->flags & HAMMER_CURSOR_CREATE_CHECK) == 0) {
 533                                 /*
 534                                  * Stop if no error.
 535                                  * Stop if error other then ENOENT.
 536                                  * Stop if ENOENT and not special case.
 537                                  */
 538                                 break;
 539                         }
 540                         if (hammer_debug_btree) {
 541                                 kprintf("CREATE_CHECK %016llx\n",
 542                                         cursor->create_check);
 543                         }
 544                         cursor->key_beg.create_tid = cursor->create_check;
 545                         /* loop */
 546                 }
 547         } else {
 548                 error = btree_search(cursor, 0);
 549         }
 550         if (error == 0)
 551                 error = hammer_btree_extract(cursor, cursor->flags);
 552         return(error);
 553 }
 554
 555 /*
 556  * Execute the logic required to start an iteration.  The first record
 557  * located within the specified range is returned and iteration control
 558  * flags are adjusted for successive hammer_btree_iterate() calls.
 559  */
 560 int
 561 hammer_btree_first(hammer_cursor_t cursor)
 562 {
 563         int error;
 564
 565         error = hammer_btree_lookup(cursor);
 566         if (error == ENOENT) {
 567                 cursor->flags &= ~HAMMER_CURSOR_ATEDISK;
 568                 error = hammer_btree_iterate(cursor);
 569         }
 570         cursor->flags |= HAMMER_CURSOR_ATEDISK;
 571         return(error);
 572 }
 573
 574 /*
 575  * Similarly but for an iteration in the reverse direction.
 576  *
 577  * Set ATEDISK when iterating backwards to skip the current entry,
 578  * which after an ENOENT lookup will be pointing beyond our end point.
 579  */
 580 int
 581 hammer_btree_last(hammer_cursor_t cursor)
 582 {
 583         struct hammer_base_elm save;
 584         int error;
 585
 586         save = cursor->key_beg;
 587         cursor->key_beg = cursor->key_end;
 588         error = hammer_btree_lookup(cursor);
 589         cursor->key_beg = save;
 590         if (error == ENOENT ||
 591             (cursor->flags & HAMMER_CURSOR_END_INCLUSIVE) == 0) {
 592                 cursor->flags |= HAMMER_CURSOR_ATEDISK;
 593                 error = hammer_btree_iterate_reverse(cursor);
 594         }
 595         cursor->flags |= HAMMER_CURSOR_ATEDISK;
 596         return(error);
 597 }
 598
 599 /*
 600  * Extract the record and/or data associated with the cursor's current
 601  * position.  Any prior record or data stored in the cursor is replaced.
 602  * The cursor must be positioned at a leaf node.
 603  *
 604  * NOTE: All extractions occur at the leaf of the B-Tree.
 605  */
 606 int
 607 hammer_btree_extract(hammer_cursor_t cursor, int flags)
 608 {
 609         hammer_mount_t hmp;
 610         hammer_node_ondisk_t node;
 611         hammer_btree_elm_t elm;
 612         hammer_off_t data_off;
 613         int32_t data_len;
 614         int error;
 615
 616         /*
 617          * The case where the data reference resolves to the same buffer
 618          * as the record reference must be handled.
 619          */
 620         node = cursor->node->ondisk;
 621         elm = &node->elms[cursor->index];
 622         cursor->data = NULL;
 623         hmp = cursor->node->hmp;
 624
 625         /*
 626          * There is nothing to extract for an internal element.
 627          */
 628         if (node->type == HAMMER_BTREE_TYPE_INTERNAL)
 629                 return(EINVAL);
 630
 631         /*
 632          * Only record types have data.
 633          */
 634         KKASSERT(node->type == HAMMER_BTREE_TYPE_LEAF);
 635         cursor->leaf = &elm->leaf;
 636
 637         if ((flags & HAMMER_CURSOR_GET_DATA) == 0)
 638                 return(0);
 639         if (elm->leaf.base.btype != HAMMER_BTREE_TYPE_RECORD)
 640                 return(0);
 641         data_off = elm->leaf.data_offset;
 642         data_len = elm->leaf.data_len;
 643         if (data_off == 0)
 644                 return(0);
 645
 646         /*
 647          * Load the data
 648          */
 649         KKASSERT(data_len >= 0 && data_len <= HAMMER_XBUFSIZE);
 650         cursor->data = hammer_bread_ext(hmp, data_off, data_len,
 651                                         &error, &cursor->data_buffer);
 652         if (hammer_crc_test_leaf(cursor->data, &elm->leaf) == 0)
 653                 Debugger("CRC FAILED: DATA");
 654         return(error);
 655 }
 656
 657
 658 /*
 659  * Insert a leaf element into the B-Tree at the current cursor position.
 660  * The cursor is positioned such that the element at and beyond the cursor
 661  * are shifted to make room for the new record.
 662  *
 663  * The caller must call hammer_btree_lookup() with the HAMMER_CURSOR_INSERT
 664  * flag set and that call must return ENOENT before this function can be
 665  * called.
 666  *
 667  * The caller may depend on the cursor's exclusive lock after return to
 668  * interlock frontend visibility (see HAMMER_RECF_CONVERT_DELETE).
 669  *
 670  * ENOSPC is returned if there is no room to insert a new record.
 671  */
 672 int
 673 hammer_btree_insert(hammer_cursor_t cursor, hammer_btree_leaf_elm_t elm,
 674                     int *doprop)
 675 {
 676         hammer_node_ondisk_t node;
 677         int i;
 678         int error;
 679
 680         *doprop = 0;
 681         if ((error = hammer_cursor_upgrade_node(cursor)) != 0)
 682                 return(error);
 683         ++hammer_stats_btree_inserts;
 684
 685         /*
 686          * Insert the element at the leaf node and update the count in the
 687          * parent.  It is possible for parent to be NULL, indicating that
 688          * the filesystem's ROOT B-Tree node is a leaf itself, which is
 689          * possible.  The root inode can never be deleted so the leaf should
 690          * never be empty.
 691          *
 692          * Remember that the right-hand boundary is not included in the
 693          * count.
 694          */
 695         hammer_modify_node_all(cursor->trans, cursor->node);
 696         node = cursor->node->ondisk;
 697         i = cursor->index;
 698         KKASSERT(elm->base.btype != 0);
 699         KKASSERT(node->type == HAMMER_BTREE_TYPE_LEAF);
 700         KKASSERT(node->count < HAMMER_BTREE_LEAF_ELMS);
 701         if (i != node->count) {
 702                 bcopy(&node->elms[i], &node->elms[i+1],
 703                       (node->count - i) * sizeof(*elm));
 704         }
 705         node->elms[i].leaf = *elm;
 706         ++node->count;
 707         hammer_cursor_inserted_element(cursor->node, i);
 708
 709         /*
 710          * Update the leaf node's aggregate mirror_tid for mirroring
 711          * support.
 712          */
 713         if (node->mirror_tid < elm->base.delete_tid) {
 714                 node->mirror_tid = elm->base.delete_tid;
 715                 *doprop = 1;
 716         }
 717         if (node->mirror_tid < elm->base.create_tid) {
 718                 node->mirror_tid = elm->base.create_tid;
 719                 *doprop = 1;
 720         }
 721         hammer_modify_node_done(cursor->node);
 722
 723         /*
 724          * Debugging sanity checks.
 725          */
 726         KKASSERT(hammer_btree_cmp(cursor->left_bound, &elm->base) <= 0);
 727         KKASSERT(hammer_btree_cmp(cursor->right_bound, &elm->base) > 0);
 728         if (i) {
 729                 KKASSERT(hammer_btree_cmp(&node->elms[i-1].leaf.base, &elm->base) < 0);
 730         }
 731         if (i != node->count - 1)
 732                 KKASSERT(hammer_btree_cmp(&node->elms[i+1].leaf.base, &elm->base) > 0);
 733
 734         return(0);
 735 }
 736
 737 /*
 738  * Delete a record from the B-Tree at the current cursor position.
 739  * The cursor is positioned such that the current element is the one
 740  * to be deleted.
 741  *
 742  * On return the cursor will be positioned after the deleted element and
 743  * MAY point to an internal node.  It will be suitable for the continuation
 744  * of an iteration but not for an insertion or deletion.
 745  *
 746  * Deletions will attempt to partially rebalance the B-Tree in an upward
 747  * direction, but will terminate rather then deadlock.  Empty internal nodes
 748  * are never allowed by a deletion which deadlocks may end up giving us an
 749  * empty leaf.  The pruner will clean up and rebalance the tree.
 750  *
 751  * This function can return EDEADLK, requiring the caller to retry the
 752  * operation after clearing the deadlock.
 753  */
 754 int
 755 hammer_btree_delete(hammer_cursor_t cursor)
 756 {
 757         hammer_node_ondisk_t ondisk;
 758         hammer_node_t node;
 759         hammer_node_t parent;
 760         int error;
 761         int i;
 762
 763         if ((error = hammer_cursor_upgrade(cursor)) != 0)
 764                 return(error);
 765         ++hammer_stats_btree_deletes;
 766
 767         /*
 768          * Delete the element from the leaf node.
 769          *
 770          * Remember that leaf nodes do not have boundaries.
 771          */
 772         node = cursor->node;
 773         ondisk = node->ondisk;
 774         i = cursor->index;
 775
 776         KKASSERT(ondisk->type == HAMMER_BTREE_TYPE_LEAF);
 777         KKASSERT(i >= 0 && i < ondisk->count);
 778         hammer_modify_node_all(cursor->trans, node);
 779         if (i + 1 != ondisk->count) {
 780                 bcopy(&ondisk->elms[i+1], &ondisk->elms[i],
 781                       (ondisk->count - i - 1) * sizeof(ondisk->elms[0]));
 782         }
 783         --ondisk->count;
 784         hammer_modify_node_done(node);
 785         hammer_cursor_deleted_element(node, i);
 786
 787         /*
 788          * Validate local parent
 789          */
 790         if (ondisk->parent) {
 791                 parent = cursor->parent;
 792
 793                 KKASSERT(parent != NULL);
 794                 KKASSERT(parent->node_offset == ondisk->parent);
 795         }
 796
 797         /*
 798          * If the leaf becomes empty it must be detached from the parent,
 799          * potentially recursing through to the filesystem root.
 800          *
 801          * This may reposition the cursor at one of the parent's of the
 802          * current node.
 803          *
 804          * Ignore deadlock errors, that simply means that btree_remove
 805          * was unable to recurse and had to leave us with an empty leaf.
 806          */
 807         KKASSERT(cursor->index <= ondisk->count);
 808         if (ondisk->count == 0) {
 809                 error = btree_remove(cursor);
 810                 if (error == EDEADLK)
 811                         error = 0;
 812         } else {
 813                 error = 0;
 814         }
 815         KKASSERT(cursor->parent == NULL ||
 816                  cursor->parent_index < cursor->parent->ondisk->count);
 817         return(error);
 818 }
 819
 820 /*
 821  * PRIMAY B-TREE SEARCH SUPPORT PROCEDURE
 822  *
 823  * Search the filesystem B-Tree for cursor->key_beg, return the matching node.
 824  *
 825  * The search can begin ANYWHERE in the B-Tree.  As a first step the search
 826  * iterates up the tree as necessary to properly position itself prior to
 827  * actually doing the sarch.
 828  *
 829  * INSERTIONS: The search will split full nodes and leaves on its way down
 830  * and guarentee that the leaf it ends up on is not full.  If we run out
 831  * of space the search continues to the leaf (to position the cursor for
 832  * the spike), but ENOSPC is returned.
 833  *
 834  * The search is only guarenteed to end up on a leaf if an error code of 0
 835  * is returned, or if inserting and an error code of ENOENT is returned.
 836  * Otherwise it can stop at an internal node.  On success a search returns
 837  * a leaf node.
 838  *
 839  * COMPLEXITY WARNING!  This is the core B-Tree search code for the entire
 840  * filesystem, and it is not simple code.  Please note the following facts:
 841  *
 842  * - Internal node recursions have a boundary on the left AND right.  The
 843  *   right boundary is non-inclusive.  The create_tid is a generic part
 844  *   of the key for internal nodes.
 845  *
 846  * - Leaf nodes contain terminal elements only now.
 847  *
 848  * - Filesystem lookups typically set HAMMER_CURSOR_ASOF, indicating a
 849  *   historical search.  ASOF and INSERT are mutually exclusive.  When
 850  *   doing an as-of lookup btree_search() checks for a right-edge boundary
 851  *   case.  If while recursing down the left-edge differs from the key
 852  *   by ONLY its create_tid, HAMMER_CURSOR_CREATE_CHECK is set along
 853  *   with cursor->create_check.  This is used by btree_lookup() to iterate.
 854  *   The iteration backwards because as-of searches can wind up going
 855  *   down the wrong branch of the B-Tree.
 856  */
 857 static
 858 int
 859 btree_search(hammer_cursor_t cursor, int flags)
 860 {
 861         hammer_node_ondisk_t node;
 862         hammer_btree_elm_t elm;
 863         int error;
 864         int enospc = 0;
 865         int i;
 866         int r;
 867         int s;
 868
 869         flags |= cursor->flags;
 870         ++hammer_stats_btree_searches;
 871
 872         if (hammer_debug_btree) {
 873                 kprintf("SEARCH   %016llx[%d] %016llx %02x key=%016llx cre=%016llx lo=%02x (td = %p)\n",
 874                         cursor->node->node_offset,
 875                         cursor->index,
 876                         cursor->key_beg.obj_id,
 877                         cursor->key_beg.rec_type,
 878                         cursor->key_beg.key,
 879                         cursor->key_beg.create_tid,
 880                         cursor->key_beg.localization,
 881                         curthread
 882                 );
 883                 if (cursor->parent)
 884                     kprintf("SEARCHP %016llx[%d] (%016llx/%016llx %016llx/%016llx) (%p/%p %p/%p)\n",
 885                         cursor->parent->node_offset, cursor->parent_index,
 886                         cursor->left_bound->obj_id,
 887                         cursor->parent->ondisk->elms[cursor->parent_index].internal.base.obj_id,
 888                         cursor->right_bound->obj_id,
 889                         cursor->parent->ondisk->elms[cursor->parent_index+1].internal.base.obj_id,
 890                         cursor->left_bound,
 891                         &cursor->parent->ondisk->elms[cursor->parent_index],
 892                         cursor->right_bound,
 893                         &cursor->parent->ondisk->elms[cursor->parent_index+1]
 894                     );
 895         }
 896
 897         /*
 898          * Move our cursor up the tree until we find a node whos range covers
 899          * the key we are trying to locate.
 900          *
 901          * The left bound is inclusive, the right bound is non-inclusive.
 902          * It is ok to cursor up too far.
 903          */
 904         for (;;) {
 905                 r = hammer_btree_cmp(&cursor->key_beg, cursor->left_bound);
 906                 s = hammer_btree_cmp(&cursor->key_beg, cursor->right_bound);
 907                 if (r >= 0 && s < 0)
 908                         break;
 909                 KKASSERT(cursor->parent);
 910                 ++hammer_stats_btree_iterations;
 911                 error = hammer_cursor_up(cursor);
 912                 if (error)
 913                         goto done;
 914         }
 915
 916         /*
 917          * The delete-checks below are based on node, not parent.  Set the
 918          * initial delete-check based on the parent.
 919          */
 920         if (r == 1) {
 921                 KKASSERT(cursor->left_bound->create_tid != 1);
 922                 cursor->create_check = cursor->left_bound->create_tid - 1;
 923                 cursor->flags |= HAMMER_CURSOR_CREATE_CHECK;
 924         }
 925
 926         /*
 927          * We better have ended up with a node somewhere.
 928          */
 929         KKASSERT(cursor->node != NULL);
 930
 931         /*
 932          * If we are inserting we can't start at a full node if the parent
 933          * is also full (because there is no way to split the node),
 934          * continue running up the tree until the requirement is satisfied
 935          * or we hit the root of the filesystem.
 936          *
 937          * (If inserting we aren't doing an as-of search so we don't have
 938          *  to worry about create_check).
 939          */
 940         while ((flags & HAMMER_CURSOR_INSERT) && enospc == 0) {
 941                 if (cursor->node->ondisk->type == HAMMER_BTREE_TYPE_INTERNAL) {
 942                         if (btree_node_is_full(cursor->node->ondisk) == 0)
 943                                 break;
 944                 } else {
 945                         if (btree_node_is_full(cursor->node->ondisk) ==0)
 946                                 break;
 947                 }
 948                 if (cursor->node->ondisk->parent == 0 ||
 949                     cursor->parent->ondisk->count != HAMMER_BTREE_INT_ELMS) {
 950                         break;
 951                 }
 952                 ++hammer_stats_btree_iterations;
 953                 error = hammer_cursor_up(cursor);
 954                 /* node may have become stale */
 955                 if (error)
 956                         goto done;
 957         }
 958
 959         /*
 960          * Push down through internal nodes to locate the requested key.
 961          */
 962         node = cursor->node->ondisk;
 963         while (node->type == HAMMER_BTREE_TYPE_INTERNAL) {
 964                 /*
 965                  * Scan the node to find the subtree index to push down into.
 966                  * We go one-past, then back-up.
 967                  *
 968                  * We must proactively remove deleted elements which may
 969                  * have been left over from a deadlocked btree_remove().
 970                  *
 971                  * The left and right boundaries are included in the loop
 972                  * in order to detect edge cases.
 973                  *
 974                  * If the separator only differs by create_tid (r == 1)
 975                  * and we are doing an as-of search, we may end up going
 976                  * down a branch to the left of the one containing the
 977                  * desired key.  This requires numerous special cases.
 978                  */
 979                 ++hammer_stats_btree_iterations;
 980                 if (hammer_debug_btree) {
 981                         kprintf("SEARCH-I %016llx count=%d\n",
 982                                 cursor->node->node_offset,
 983                                 node->count);
 984                 }
 985
 986                 /*
 987                  * Try to shortcut the search before dropping into the
 988                  * linear loop.  Locate the first node where r <= 1.
 989                  */
 990                 i = hammer_btree_search_node(&cursor->key_beg, node);
 991                 while (i <= node->count) {
 992                         ++hammer_stats_btree_elements;
 993                         elm = &node->elms[i];
 994                         r = hammer_btree_cmp(&cursor->key_beg, &elm->base);
 995                         if (hammer_debug_btree > 2) {
 996                                 kprintf(" IELM %p %d r=%d\n",
 997                                         &node->elms[i], i, r);
 998                         }
 999                         if (r < 0)
1000                                 break;
1001                         if (r == 1) {
1002                                 KKASSERT(elm->base.create_tid != 1);
1003                                 cursor->create_check = elm->base.create_tid - 1;
1004                                 cursor->flags |= HAMMER_CURSOR_CREATE_CHECK;
1005                         }
1006                         ++i;
1007                 }
1008                 if (hammer_debug_btree) {
1009                         kprintf("SEARCH-I preI=%d/%d r=%d\n",
1010                                 i, node->count, r);
1011                 }
1012
1013                 /*
1014                  * These cases occur when the parent's idea of the boundary
1015                  * is wider then the child's idea of the boundary, and
1016                  * require special handling.  If not inserting we can
1017                  * terminate the search early for these cases but the
1018                  * child's boundaries cannot be unconditionally modified.
1019                  */
1020                 if (i == 0) {
1021                         /*
1022                          * If i == 0 the search terminated to the LEFT of the
1023                          * left_boundary but to the RIGHT of the parent's left
1024                          * boundary.
1025                          */
1026                         u_int8_t save;
1027
1028                         elm = &node->elms[0];
1029
1030                         /*
1031                          * If we aren't inserting we can stop here.
1032                          */
1033                         if ((flags & (HAMMER_CURSOR_INSERT |
1034                                       HAMMER_CURSOR_PRUNING)) == 0) {
1035                                 cursor->index = 0;
1036                                 return(ENOENT);
1037                         }
1038
1039                         /*
1040                          * Correct a left-hand boundary mismatch.
1041                          *
1042                          * We can only do this if we can upgrade the lock,
1043                          * and synchronized as a background cursor (i.e.
1044                          * inserting or pruning).
1045                          *
1046                          * WARNING: We can only do this if inserting, i.e.
1047                          * we are running on the backend.
1048                          */
1049                         if ((error = hammer_cursor_upgrade(cursor)) != 0)
1050                                 return(error);
1051                         KKASSERT(cursor->flags & HAMMER_CURSOR_BACKEND);
1052                         hammer_modify_node_field(cursor->trans, cursor->node,
1053                                                  elms[0]);
1054                         save = node->elms[0].base.btype;
1055                         node->elms[0].base = *cursor->left_bound;
1056                         node->elms[0].base.btype = save;
1057                         hammer_modify_node_done(cursor->node);
1058                 } else if (i == node->count + 1) {
1059                         /*
1060                          * If i == node->count + 1 the search terminated to
1061                          * the RIGHT of the right boundary but to the LEFT
1062                          * of the parent's right boundary.  If we aren't
1063                          * inserting we can stop here.
1064                          *
1065                          * Note that the last element in this case is
1066                          * elms[i-2] prior to adjustments to 'i'.
1067                          */
1068                         --i;
1069                         if ((flags & (HAMMER_CURSOR_INSERT |
1070                                       HAMMER_CURSOR_PRUNING)) == 0) {
1071                                 cursor->index = i;
1072                                 return (ENOENT);
1073                         }
1074
1075                         /*
1076                          * Correct a right-hand boundary mismatch.
1077                          * (actual push-down record is i-2 prior to
1078                          * adjustments to i).
1079                          *
1080                          * We can only do this if we can upgrade the lock,
1081                          * and synchronized as a background cursor (i.e.
1082                          * inserting or pruning).
1083                          *
1084                          * WARNING: We can only do this if inserting, i.e.
1085                          * we are running on the backend.
1086                          */
1087                         if ((error = hammer_cursor_upgrade(cursor)) != 0)
1088                                 return(error);
1089                         elm = &node->elms[i];
1090                         KKASSERT(cursor->flags & HAMMER_CURSOR_BACKEND);
1091                         hammer_modify_node(cursor->trans, cursor->node,
1092                                            &elm->base, sizeof(elm->base));
1093                         elm->base = *cursor->right_bound;
1094                         hammer_modify_node_done(cursor->node);
1095                         --i;
1096                 } else {
1097                         /*
1098                          * The push-down index is now i - 1.  If we had
1099                          * terminated on the right boundary this will point
1100                          * us at the last element.
1101                          */
1102                         --i;
1103                 }
1104                 cursor->index = i;
1105                 elm = &node->elms[i];
1106
1107                 if (hammer_debug_btree) {
1108                         kprintf("RESULT-I %016llx[%d] %016llx %02x "
1109                                 "key=%016llx cre=%016llx lo=%02x\n",
1110                                 cursor->node->node_offset,
1111                                 i,
1112                                 elm->internal.base.obj_id,
1113                                 elm->internal.base.rec_type,
1114                                 elm->internal.base.key,
1115                                 elm->internal.base.create_tid,
1116                                 elm->internal.base.localization
1117                         );
1118                 }
1119
1120                 /*
1121                  * We better have a valid subtree offset.
1122                  */
1123                 KKASSERT(elm->internal.subtree_offset != 0);
1124
1125                 /*
1126                  * Handle insertion and deletion requirements.
1127                  *
1128                  * If inserting split full nodes.  The split code will
1129                  * adjust cursor->node and cursor->index if the current
1130                  * index winds up in the new node.
1131                  *
1132                  * If inserting and a left or right edge case was detected,
1133                  * we cannot correct the left or right boundary and must
1134                  * prepend and append an empty leaf node in order to make
1135                  * the boundary correction.
1136                  *
1137                  * If we run out of space we set enospc and continue on
1138                  * to a leaf to provide the spike code with a good point
1139                  * of entry.
1140                  */
1141                 if ((flags & HAMMER_CURSOR_INSERT) && enospc == 0) {
1142                         if (btree_node_is_full(node)) {
1143                                 error = btree_split_internal(cursor);
1144                                 if (error) {
1145                                         if (error != ENOSPC)
1146                                                 goto done;
1147                                         enospc = 1;
1148                                 }
1149                                 /*
1150                                  * reload stale pointers
1151                                  */
1152                                 i = cursor->index;
1153                                 node = cursor->node->ondisk;
1154                         }
1155                 }
1156
1157                 /*
1158                  * Push down (push into new node, existing node becomes
1159                  * the parent) and continue the search.
1160                  */
1161                 error = hammer_cursor_down(cursor);
1162                 /* node may have become stale */
1163                 if (error)
1164                         goto done;
1165                 node = cursor->node->ondisk;
1166         }
1167
1168         /*
1169          * We are at a leaf, do a linear search of the key array.
1170          *
1171          * On success the index is set to the matching element and 0
1172          * is returned.
1173          *
1174          * On failure the index is set to the insertion point and ENOENT
1175          * is returned.
1176          *
1177          * Boundaries are not stored in leaf nodes, so the index can wind
1178          * up to the left of element 0 (index == 0) or past the end of
1179          * the array (index == node->count).  It is also possible that the
1180          * leaf might be empty.
1181          */
1182         ++hammer_stats_btree_iterations;
1183         KKASSERT (node->type == HAMMER_BTREE_TYPE_LEAF);
1184         KKASSERT(node->count <= HAMMER_BTREE_LEAF_ELMS);
1185         if (hammer_debug_btree) {
1186                 kprintf("SEARCH-L %016llx count=%d\n",
1187                         cursor->node->node_offset,
1188                         node->count);
1189         }
1190
1191         /*
1192          * Try to shortcut the search before dropping into the
1193          * linear loop.  Locate the first node where r <= 1.
1194          */
1195         i = hammer_btree_search_node(&cursor->key_beg, node);
1196         while (i < node->count) {
1197                 ++hammer_stats_btree_elements;
1198                 elm = &node->elms[i];
1199
1200                 r = hammer_btree_cmp(&cursor->key_beg, &elm->leaf.base);
1201
1202                 if (hammer_debug_btree > 1)
1203                         kprintf("  ELM %p %d r=%d\n", &node->elms[i], i, r);
1204
1205                 /*
1206                  * We are at a record element.  Stop if we've flipped past
1207                  * key_beg, not counting the create_tid test.  Allow the
1208                  * r == 1 case (key_beg > element but differs only by its
1209                  * create_tid) to fall through to the AS-OF check.
1210                  */
1211                 KKASSERT (elm->leaf.base.btype == HAMMER_BTREE_TYPE_RECORD);
1212
1213                 if (r < 0)
1214                         goto failed;
1215                 if (r > 1) {
1216                         ++i;
1217                         continue;
1218                 }
1219
1220                 /*
1221                  * Check our as-of timestamp against the element.
1222                  */
1223                 if (flags & HAMMER_CURSOR_ASOF) {
1224                         if (hammer_btree_chkts(cursor->asof,
1225                                                &node->elms[i].base) != 0) {
1226                                 ++i;
1227                                 continue;
1228                         }
1229                         /* success */
1230                 } else {
1231                         if (r > 0) {    /* can only be +1 */
1232                                 ++i;
1233                                 continue;
1234                         }
1235                         /* success */
1236                 }
1237                 cursor->index = i;
1238                 error = 0;
1239                 if (hammer_debug_btree) {
1240                         kprintf("RESULT-L %016llx[%d] (SUCCESS)\n",
1241                                 cursor->node->node_offset, i);
1242                 }
1243                 goto done;
1244         }
1245
1246         /*
1247          * The search of the leaf node failed.  i is the insertion point.
1248          */
1249 failed:
1250         if (hammer_debug_btree) {
1251                 kprintf("RESULT-L %016llx[%d] (FAILED)\n",
1252                         cursor->node->node_offset, i);
1253         }
1254
1255         /*
1256          * No exact match was found, i is now at the insertion point.
1257          *
1258          * If inserting split a full leaf before returning.  This
1259          * may have the side effect of adjusting cursor->node and
1260          * cursor->index.
1261          */
1262         cursor->index = i;
1263         if ((flags & HAMMER_CURSOR_INSERT) && enospc == 0 &&
1264              btree_node_is_full(node)) {
1265                 error = btree_split_leaf(cursor);
1266                 if (error) {
1267                         if (error != ENOSPC)
1268                                 goto done;
1269                         enospc = 1;
1270                 }
1271                 /*
1272                  * reload stale pointers
1273                  */
1274                 /* NOT USED
1275                 i = cursor->index;
1276                 node = &cursor->node->internal;
1277                 */
1278         }
1279
1280         /*
1281          * We reached a leaf but did not find the key we were looking for.
1282          * If this is an insert we will be properly positioned for an insert
1283          * (ENOENT) or spike (ENOSPC) operation.
1284          */
1285         error = enospc ? ENOSPC : ENOENT;
1286 done:
1287         return(error);
1288 }
1289
1290 /*
1291  * Heuristical search for the first element whos comparison is <= 1.  May
1292  * return an index whos compare result is > 1 but may only return an index
1293  * whos compare result is <= 1 if it is the first element with that result.
1294  */
1295 int
1296 hammer_btree_search_node(hammer_base_elm_t elm, hammer_node_ondisk_t node)
1297 {
1298         int b;
1299         int s;
1300         int i;
1301         int r;
1302
1303         /*
1304          * Don't bother if the node does not have very many elements
1305          */
1306         b = 0;
1307         s = node->count;
1308         while (s - b > 4) {
1309                 i = b + (s - b) / 2;
1310                 ++hammer_stats_btree_elements;
1311                 r = hammer_btree_cmp(elm, &node->elms[i].leaf.base);
1312                 if (r <= 1) {
1313                         s = i;
1314                 } else {
1315                         b = i;
1316                 }
1317         }
1318         return(b);
1319 }
1320
1321
1322 /************************************************************************
1323  *                         SPLITTING AND MERGING                        *
1324  ************************************************************************
1325  *
1326  * These routines do all the dirty work required to split and merge nodes.
1327  */
1328
1329 /*
1330  * Split an internal node into two nodes and move the separator at the split
1331  * point to the parent.
1332  *
1333  * (cursor->node, cursor->index) indicates the element the caller intends
1334  * to push into.  We will adjust node and index if that element winds
1335  * up in the split node.
1336  *
1337  * If we are at the root of the filesystem a new root must be created with
1338  * two elements, one pointing to the original root and one pointing to the
1339  * newly allocated split node.
1340  */
1341 static
1342 int
1343 btree_split_internal(hammer_cursor_t cursor)
1344 {
1345         hammer_node_ondisk_t ondisk;
1346         hammer_node_t node;
1347         hammer_node_t parent;
1348         hammer_node_t new_node;
1349         hammer_btree_elm_t elm;
1350         hammer_btree_elm_t parent_elm;
1351         hammer_node_locklist_t locklist = NULL;
1352         hammer_mount_t hmp = cursor->trans->hmp;
1353         int parent_index;
1354         int made_root;
1355         int split;
1356         int error;
1357         int i;
1358         const int esize = sizeof(*elm);
1359
1360         error = hammer_btree_lock_children(cursor, &locklist);
1361         if (error)
1362                 goto done;
1363         if ((error = hammer_cursor_upgrade(cursor)) != 0)
1364                 goto done;
1365         ++hammer_stats_btree_splits;
1366
1367         /*
1368          * We are splitting but elms[split] will be promoted to the parent,
1369          * leaving the right hand node with one less element.  If the
1370          * insertion point will be on the left-hand side adjust the split
1371          * point to give the right hand side one additional node.
1372          */
1373         node = cursor->node;
1374         ondisk = node->ondisk;
1375         split = (ondisk->count + 1) / 2;
1376         if (cursor->index <= split)
1377                 --split;
1378
1379         /*
1380          * If we are at the root of the filesystem, create a new root node
1381          * with 1 element and split normally.  Avoid making major
1382          * modifications until we know the whole operation will work.
1383          */
1384         if (ondisk->parent == 0) {
1385                 parent = hammer_alloc_btree(cursor->trans, &error);
1386                 if (parent == NULL)
1387                         goto done;
1388                 hammer_lock_ex(&parent->lock);
1389                 hammer_modify_node_noundo(cursor->trans, parent);
1390                 ondisk = parent->ondisk;
1391                 ondisk->count = 1;
1392                 ondisk->parent = 0;
1393                 ondisk->mirror_tid = node->ondisk->mirror_tid;
1394                 ondisk->type = HAMMER_BTREE_TYPE_INTERNAL;
1395                 ondisk->elms[0].base = hmp->root_btree_beg;
1396                 ondisk->elms[0].base.btype = node->ondisk->type;
1397                 ondisk->elms[0].internal.subtree_offset = node->node_offset;
1398                 ondisk->elms[1].base = hmp->root_btree_end;
1399                 hammer_modify_node_done(parent);
1400                 /* ondisk->elms[1].base.btype - not used */
1401                 made_root = 1;
1402                 parent_index = 0;       /* index of current node in parent */
1403         } else {
1404                 made_root = 0;
1405                 parent = cursor->parent;
1406                 parent_index = cursor->parent_index;
1407         }
1408
1409         /*
1410          * Split node into new_node at the split point.
1411          *
1412          *  B O O O P N N B     <-- P = node->elms[split]
1413          *   0 1 2 3 4 5 6      <-- subtree indices
1414          *
1415          *       x x P x x
1416          *        s S S s
1417          *         /   \
1418          *  B O O O B    B N N B        <--- inner boundary points are 'P'
1419          *   0 1 2 3      4 5 6
1420          *
1421          */
1422         new_node = hammer_alloc_btree(cursor->trans, &error);
1423         if (new_node == NULL) {
1424                 if (made_root) {
1425                         hammer_unlock(&parent->lock);
1426                         hammer_delete_node(cursor->trans, parent);
1427                         hammer_rel_node(parent);
1428                 }
1429                 goto done;
1430         }
1431         hammer_lock_ex(&new_node->lock);
1432
1433         /*
1434          * Create the new node.  P becomes the left-hand boundary in the
1435          * new node.  Copy the right-hand boundary as well.
1436          *
1437          * elm is the new separator.
1438          */
1439         hammer_modify_node_noundo(cursor->trans, new_node);
1440         hammer_modify_node_all(cursor->trans, node);
1441         ondisk = node->ondisk;
1442         elm = &ondisk->elms[split];
1443         bcopy(elm, &new_node->ondisk->elms[0],
1444               (ondisk->count - split + 1) * esize);
1445         new_node->ondisk->count = ondisk->count - split;
1446         new_node->ondisk->parent = parent->node_offset;
1447         new_node->ondisk->type = HAMMER_BTREE_TYPE_INTERNAL;
1448         new_node->ondisk->mirror_tid = ondisk->mirror_tid;
1449         KKASSERT(ondisk->type == new_node->ondisk->type);
1450         hammer_cursor_split_node(node, new_node, split);
1451
1452         /*
1453          * Cleanup the original node.  Elm (P) becomes the new boundary,
1454          * its subtree_offset was moved to the new node.  If we had created
1455          * a new root its parent pointer may have changed.
1456          */
1457         elm->internal.subtree_offset = 0;
1458         ondisk->count = split;
1459
1460         /*
1461          * Insert the separator into the parent, fixup the parent's
1462          * reference to the original node, and reference the new node.
1463          * The separator is P.
1464          *
1465          * Remember that base.count does not include the right-hand boundary.
1466          */
1467         hammer_modify_node_all(cursor->trans, parent);
1468         ondisk = parent->ondisk;
1469         KKASSERT(ondisk->count != HAMMER_BTREE_INT_ELMS);
1470         parent_elm = &ondisk->elms[parent_index+1];
1471         bcopy(parent_elm, parent_elm + 1,
1472               (ondisk->count - parent_index) * esize);
1473         parent_elm->internal.base = elm->base;  /* separator P */
1474         parent_elm->internal.base.btype = new_node->ondisk->type;
1475         parent_elm->internal.subtree_offset = new_node->node_offset;
1476         parent_elm->internal.mirror_tid = new_node->ondisk->mirror_tid;
1477         ++ondisk->count;
1478         hammer_modify_node_done(parent);
1479         hammer_cursor_inserted_element(parent, parent_index + 1);
1480
1481         /*
1482          * The children of new_node need their parent pointer set to new_node.
1483          * The children have already been locked by
1484          * hammer_btree_lock_children().
1485          */
1486         for (i = 0; i < new_node->ondisk->count; ++i) {
1487                 elm = &new_node->ondisk->elms[i];
1488                 error = btree_set_parent(cursor->trans, new_node, elm);
1489                 if (error) {
1490                         panic("btree_split_internal: btree-fixup problem");
1491                 }
1492         }
1493         hammer_modify_node_done(new_node);
1494
1495         /*
1496          * The filesystem's root B-Tree pointer may have to be updated.
1497          */
1498         if (made_root) {
1499                 hammer_volume_t volume;
1500
1501                 volume = hammer_get_root_volume(hmp, &error);
1502                 KKASSERT(error == 0);
1503
1504                 hammer_modify_volume_field(cursor->trans, volume,
1505                                            vol0_btree_root);
1506                 volume->ondisk->vol0_btree_root = parent->node_offset;
1507                 hammer_modify_volume_done(volume);
1508                 node->ondisk->parent = parent->node_offset;
1509                 if (cursor->parent) {
1510                         hammer_unlock(&cursor->parent->lock);
1511                         hammer_rel_node(cursor->parent);
1512                 }
1513                 cursor->parent = parent;        /* lock'd and ref'd */
1514                 hammer_rel_volume(volume, 0);
1515         }
1516         hammer_modify_node_done(node);
1517
1518         /*
1519          * Ok, now adjust the cursor depending on which element the original
1520          * index was pointing at.  If we are >= the split point the push node
1521          * is now in the new node.
1522          *
1523          * NOTE: If we are at the split point itself we cannot stay with the
1524          * original node because the push index will point at the right-hand
1525          * boundary, which is illegal.
1526          *
1527          * NOTE: The cursor's parent or parent_index must be adjusted for
1528          * the case where a new parent (new root) was created, and the case
1529          * where the cursor is now pointing at the split node.
1530          */
1531         if (cursor->index >= split) {
1532                 cursor->parent_index = parent_index + 1;
1533                 cursor->index -= split;
1534                 hammer_unlock(&cursor->node->lock);
1535                 hammer_rel_node(cursor->node);
1536                 cursor->node = new_node;        /* locked and ref'd */
1537         } else {
1538                 cursor->parent_index = parent_index;
1539                 hammer_unlock(&new_node->lock);
1540                 hammer_rel_node(new_node);
1541         }
1542
1543         /*
1544          * Fixup left and right bounds
1545          */
1546         parent_elm = &parent->ondisk->elms[cursor->parent_index];
1547         cursor->left_bound = &parent_elm[0].internal.base;
1548         cursor->right_bound = &parent_elm[1].internal.base;
1549         KKASSERT(hammer_btree_cmp(cursor->left_bound,
1550                  &cursor->node->ondisk->elms[0].internal.base) <= 0);
1551         KKASSERT(hammer_btree_cmp(cursor->right_bound,
1552                  &cursor->node->ondisk->elms[cursor->node->ondisk->count].internal.base) >= 0);
1553
1554 done:
1555         hammer_btree_unlock_children(&locklist);
1556         hammer_cursor_downgrade(cursor);
1557         return (error);
1558 }
1559
1560 /*
1561  * Same as the above, but splits a full leaf node.
1562  *
1563  * This function
1564  */
1565 static
1566 int
1567 btree_split_leaf(hammer_cursor_t cursor)
1568 {
1569         hammer_node_ondisk_t ondisk;
1570         hammer_node_t parent;
1571         hammer_node_t leaf;
1572         hammer_mount_t hmp;
1573         hammer_node_t new_leaf;
1574         hammer_btree_elm_t elm;
1575         hammer_btree_elm_t parent_elm;
1576         hammer_base_elm_t mid_boundary;
1577         int parent_index;
1578         int made_root;
1579         int split;
1580         int error;
1581         const size_t esize = sizeof(*elm);
1582
1583         if ((error = hammer_cursor_upgrade(cursor)) != 0)
1584                 return(error);
1585         ++hammer_stats_btree_splits;
1586
1587         KKASSERT(hammer_btree_cmp(cursor->left_bound,
1588                  &cursor->node->ondisk->elms[0].leaf.base) <= 0);
1589         KKASSERT(hammer_btree_cmp(cursor->right_bound,
1590                  &cursor->node->ondisk->elms[cursor->node->ondisk->count-1].leaf.base) > 0);
1591
1592         /*
1593          * Calculate the split point.  If the insertion point will be on
1594          * the left-hand side adjust the split point to give the right
1595          * hand side one additional node.
1596          *
1597          * Spikes are made up of two leaf elements which cannot be
1598          * safely split.
1599          */
1600         leaf = cursor->node;
1601         ondisk = leaf->ondisk;
1602         split = (ondisk->count + 1) / 2;
1603         if (cursor->index <= split)
1604                 --split;
1605         error = 0;
1606         hmp = leaf->hmp;
1607
1608         elm = &ondisk->elms[split];
1609
1610         KKASSERT(hammer_btree_cmp(cursor->left_bound, &elm[-1].leaf.base) <= 0);
1611         KKASSERT(hammer_btree_cmp(cursor->left_bound, &elm->leaf.base) <= 0);
1612         KKASSERT(hammer_btree_cmp(cursor->right_bound, &elm->leaf.base) > 0);
1613         KKASSERT(hammer_btree_cmp(cursor->right_bound, &elm[1].leaf.base) > 0);
1614
1615         /*
1616          * If we are at the root of the tree, create a new root node with
1617          * 1 element and split normally.  Avoid making major modifications
1618          * until we know the whole operation will work.
1619          */
1620         if (ondisk->parent == 0) {
1621                 parent = hammer_alloc_btree(cursor->trans, &error);
1622                 if (parent == NULL)
1623                         goto done;
1624                 hammer_lock_ex(&parent->lock);
1625                 hammer_modify_node_noundo(cursor->trans, parent);
1626                 ondisk = parent->ondisk;
1627                 ondisk->count = 1;
1628                 ondisk->parent = 0;
1629                 ondisk->mirror_tid = leaf->ondisk->mirror_tid;
1630                 ondisk->type = HAMMER_BTREE_TYPE_INTERNAL;
1631                 ondisk->elms[0].base = hmp->root_btree_beg;
1632                 ondisk->elms[0].base.btype = leaf->ondisk->type;
1633                 ondisk->elms[0].internal.subtree_offset = leaf->node_offset;
1634                 ondisk->elms[1].base = hmp->root_btree_end;
1635                 /* ondisk->elms[1].base.btype = not used */
1636                 hammer_modify_node_done(parent);
1637                 made_root = 1;
1638                 parent_index = 0;       /* insertion point in parent */
1639         } else {
1640                 made_root = 0;
1641                 parent = cursor->parent;
1642                 parent_index = cursor->parent_index;
1643         }
1644
1645         /*
1646          * Split leaf into new_leaf at the split point.  Select a separator
1647          * value in-between the two leafs but with a bent towards the right
1648          * leaf since comparisons use an 'elm >= separator' inequality.
1649          *
1650          *  L L L L L L L L
1651          *
1652          *       x x P x x
1653          *        s S S s
1654          *         /   \
1655          *  L L L L     L L L L
1656          */
1657         new_leaf = hammer_alloc_btree(cursor->trans, &error);
1658         if (new_leaf == NULL) {
1659                 if (made_root) {
1660                         hammer_unlock(&parent->lock);
1661                         hammer_delete_node(cursor->trans, parent);
1662                         hammer_rel_node(parent);
1663                 }
1664                 goto done;
1665         }
1666         hammer_lock_ex(&new_leaf->lock);
1667
1668         /*
1669          * Create the new node and copy the leaf elements from the split
1670          * point on to the new node.
1671          */
1672         hammer_modify_node_all(cursor->trans, leaf);
1673         hammer_modify_node_noundo(cursor->trans, new_leaf);
1674         ondisk = leaf->ondisk;
1675         elm = &ondisk->elms[split];
1676         bcopy(elm, &new_leaf->ondisk->elms[0], (ondisk->count - split) * esize);
1677         new_leaf->ondisk->count = ondisk->count - split;
1678         new_leaf->ondisk->parent = parent->node_offset;
1679         new_leaf->ondisk->type = HAMMER_BTREE_TYPE_LEAF;
1680         new_leaf->ondisk->mirror_tid = ondisk->mirror_tid;
1681         KKASSERT(ondisk->type == new_leaf->ondisk->type);
1682         hammer_modify_node_done(new_leaf);
1683         hammer_cursor_split_node(leaf, new_leaf, split);
1684
1685         /*
1686          * Cleanup the original node.  Because this is a leaf node and
1687          * leaf nodes do not have a right-hand boundary, there
1688          * aren't any special edge cases to clean up.  We just fixup the
1689          * count.
1690          */
1691         ondisk->count = split;
1692
1693         /*
1694          * Insert the separator into the parent, fixup the parent's
1695          * reference to the original node, and reference the new node.
1696          * The separator is P.
1697          *
1698          * Remember that base.count does not include the right-hand boundary.
1699          * We are copying parent_index+1 to parent_index+2, not +0 to +1.
1700          */
1701         hammer_modify_node_all(cursor->trans, parent);
1702         ondisk = parent->ondisk;
1703         KKASSERT(split != 0);
1704         KKASSERT(ondisk->count != HAMMER_BTREE_INT_ELMS);
1705         parent_elm = &ondisk->elms[parent_index+1];
1706         bcopy(parent_elm, parent_elm + 1,
1707               (ondisk->count - parent_index) * esize);
1708
1709         hammer_make_separator(&elm[-1].base, &elm[0].base, &parent_elm->base);
1710         parent_elm->internal.base.btype = new_leaf->ondisk->type;
1711         parent_elm->internal.subtree_offset = new_leaf->node_offset;
1712         parent_elm->internal.mirror_tid = new_leaf->ondisk->mirror_tid;
1713         mid_boundary = &parent_elm->base;
1714         ++ondisk->count;
1715         hammer_modify_node_done(parent);
1716         hammer_cursor_inserted_element(parent, parent_index + 1);
1717
1718         /*
1719          * The filesystem's root B-Tree pointer may have to be updated.
1720          */
1721         if (made_root) {
1722                 hammer_volume_t volume;
1723
1724                 volume = hammer_get_root_volume(hmp, &error);
1725                 KKASSERT(error == 0);
1726
1727                 hammer_modify_volume_field(cursor->trans, volume,
1728                                            vol0_btree_root);
1729                 volume->ondisk->vol0_btree_root = parent->node_offset;
1730                 hammer_modify_volume_done(volume);
1731                 leaf->ondisk->parent = parent->node_offset;
1732                 if (cursor->parent) {
1733                         hammer_unlock(&cursor->parent->lock);
1734                         hammer_rel_node(cursor->parent);
1735                 }
1736                 cursor->parent = parent;        /* lock'd and ref'd */
1737                 hammer_rel_volume(volume, 0);
1738         }
1739         hammer_modify_node_done(leaf);
1740
1741         /*
1742          * Ok, now adjust the cursor depending on which element the original
1743          * index was pointing at.  If we are >= the split point the push node
1744          * is now in the new node.
1745          *
1746          * NOTE: If we are at the split point itself we need to select the
1747          * old or new node based on where key_beg's insertion point will be.
1748          * If we pick the wrong side the inserted element will wind up in
1749          * the wrong leaf node and outside that node's bounds.
1750          */
1751         if (cursor->index > split ||
1752             (cursor->index == split &&
1753              hammer_btree_cmp(&cursor->key_beg, mid_boundary) >= 0)) {
1754                 cursor->parent_index = parent_index + 1;
1755                 cursor->index -= split;
1756                 hammer_unlock(&cursor->node->lock);
1757                 hammer_rel_node(cursor->node);
1758                 cursor->node = new_leaf;
1759         } else {
1760                 cursor->parent_index = parent_index;
1761                 hammer_unlock(&new_leaf->lock);
1762                 hammer_rel_node(new_leaf);
1763         }
1764
1765         /*
1766          * Fixup left and right bounds
1767          */
1768         parent_elm = &parent->ondisk->elms[cursor->parent_index];
1769         cursor->left_bound = &parent_elm[0].internal.base;
1770         cursor->right_bound = &parent_elm[1].internal.base;
1771
1772         /*
1773          * Assert that the bounds are correct.
1774          */
1775         KKASSERT(hammer_btree_cmp(cursor->left_bound,
1776                  &cursor->node->ondisk->elms[0].leaf.base) <= 0);
1777         KKASSERT(hammer_btree_cmp(cursor->right_bound,
1778                  &cursor->node->ondisk->elms[cursor->node->ondisk->count-1].leaf.base) > 0);
1779         KKASSERT(hammer_btree_cmp(cursor->left_bound, &cursor->key_beg) <= 0);
1780         KKASSERT(hammer_btree_cmp(cursor->right_bound, &cursor->key_beg) > 0);
1781
1782 done:
1783         hammer_cursor_downgrade(cursor);
1784         return (error);
1785 }
1786
1787 #if 0
1788
1789 /*
1790  * Recursively correct the right-hand boundary's create_tid to (tid) as
1791  * long as the rest of the key matches.  We have to recurse upward in
1792  * the tree as well as down the left side of each parent's right node.
1793  *
1794  * Return EDEADLK if we were only partially successful, forcing the caller
1795  * to try again.  The original cursor is not modified.  This routine can
1796  * also fail with EDEADLK if it is forced to throw away a portion of its
1797  * record history.
1798  *
1799  * The caller must pass a downgraded cursor to us (otherwise we can't dup it).
1800  */
1801 struct hammer_rhb {
1802         TAILQ_ENTRY(hammer_rhb) entry;
1803         hammer_node_t   node;
1804         int             index;
1805 };
1806
1807 TAILQ_HEAD(hammer_rhb_list, hammer_rhb);
1808
1809 int
1810 hammer_btree_correct_rhb(hammer_cursor_t cursor, hammer_tid_t tid)
1811 {
1812         struct hammer_rhb_list rhb_list;
1813         hammer_base_elm_t elm;
1814         hammer_node_t orig_node;
1815         struct hammer_rhb *rhb;
1816         int orig_index;
1817         int error;
1818
1819         TAILQ_INIT(&rhb_list);
1820
1821         /*
1822          * Save our position so we can restore it on return.  This also
1823          * gives us a stable 'elm'.
1824          */
1825         orig_node = cursor->node;
1826         hammer_ref_node(orig_node);
1827         hammer_lock_sh(&orig_node->lock);
1828         orig_index = cursor->index;
1829         elm = &orig_node->ondisk->elms[orig_index].base;
1830
1831         /*
1832          * Now build a list of parents going up, allocating a rhb
1833          * structure for each one.
1834          */
1835         while (cursor->parent) {
1836                 /*
1837                  * Stop if we no longer have any right-bounds to fix up
1838                  */
1839                 if (elm->obj_id != cursor->right_bound->obj_id ||
1840                     elm->rec_type != cursor->right_bound->rec_type ||
1841                     elm->key != cursor->right_bound->key) {
1842                         break;
1843                 }
1844
1845                 /*
1846                  * Stop if the right-hand bound's create_tid does not
1847                  * need to be corrected.
1848                  */
1849                 if (cursor->right_bound->create_tid >= tid)
1850                         break;
1851
1852                 rhb = kmalloc(sizeof(*rhb), M_HAMMER, M_WAITOK|M_ZERO);
1853                 rhb->node = cursor->parent;
1854                 rhb->index = cursor->parent_index;
1855                 hammer_ref_node(rhb->node);
1856                 hammer_lock_sh(&rhb->node->lock);
1857                 TAILQ_INSERT_HEAD(&rhb_list, rhb, entry);
1858
1859                 hammer_cursor_up(cursor);
1860         }
1861
1862         /*
1863          * now safely adjust the right hand bound for each rhb.  This may
1864          * also require taking the right side of the tree and iterating down
1865          * ITS left side.
1866          */
1867         error = 0;
1868         while (error == 0 && (rhb = TAILQ_FIRST(&rhb_list)) != NULL) {
1869                 error = hammer_cursor_seek(cursor, rhb->node, rhb->index);
1870                 if (error)
1871                         break;
1872                 TAILQ_REMOVE(&rhb_list, rhb, entry);
1873                 hammer_unlock(&rhb->node->lock);
1874                 hammer_rel_node(rhb->node);
1875                 kfree(rhb, M_HAMMER);
1876
1877                 switch (cursor->node->ondisk->type) {
1878                 case HAMMER_BTREE_TYPE_INTERNAL:
1879                         /*
1880                          * Right-boundary for parent at internal node
1881                          * is one element to the right of the element whos
1882                          * right boundary needs adjusting.  We must then
1883                          * traverse down the left side correcting any left
1884                          * bounds (which may now be too far to the left).
1885                          */
1886                         ++cursor->index;
1887                         error = hammer_btree_correct_lhb(cursor, tid);
1888                         break;
1889                 default:
1890                         panic("hammer_btree_correct_rhb(): Bad node type");
1891                         error = EINVAL;
1892                         break;
1893                 }
1894         }
1895
1896         /*
1897          * Cleanup
1898          */
1899         while ((rhb = TAILQ_FIRST(&rhb_list)) != NULL) {
1900                 TAILQ_REMOVE(&rhb_list, rhb, entry);
1901                 hammer_unlock(&rhb->node->lock);
1902                 hammer_rel_node(rhb->node);
1903                 kfree(rhb, M_HAMMER);
1904         }
1905         error = hammer_cursor_seek(cursor, orig_node, orig_index);
1906         hammer_unlock(&orig_node->lock);
1907         hammer_rel_node(orig_node);
1908         return (error);
1909 }
1910
1911 /*
1912  * Similar to rhb (in fact, rhb calls lhb), but corrects the left hand
1913  * bound going downward starting at the current cursor position.
1914  *
1915  * This function does not restore the cursor after use.
1916  */
1917 int
1918 hammer_btree_correct_lhb(hammer_cursor_t cursor, hammer_tid_t tid)
1919 {
1920         struct hammer_rhb_list rhb_list;
1921         hammer_base_elm_t elm;
1922         hammer_base_elm_t cmp;
1923         struct hammer_rhb *rhb;
1924         int error;
1925
1926         TAILQ_INIT(&rhb_list);
1927
1928         cmp = &cursor->node->ondisk->elms[cursor->index].base;
1929
1930         /*
1931          * Record the node and traverse down the left-hand side for all
1932          * matching records needing a boundary correction.
1933          */
1934         error = 0;
1935         for (;;) {
1936                 rhb = kmalloc(sizeof(*rhb), M_HAMMER, M_WAITOK|M_ZERO);
1937                 rhb->node = cursor->node;
1938                 rhb->index = cursor->index;
1939                 hammer_ref_node(rhb->node);
1940                 hammer_lock_sh(&rhb->node->lock);
1941                 TAILQ_INSERT_HEAD(&rhb_list, rhb, entry);
1942
1943                 if (cursor->node->ondisk->type == HAMMER_BTREE_TYPE_INTERNAL) {
1944                         /*
1945                          * Nothing to traverse down if we are at the right
1946                          * boundary of an internal node.
1947                          */
1948                         if (cursor->index == cursor->node->ondisk->count)
1949                                 break;
1950                 } else {
1951                         elm = &cursor->node->ondisk->elms[cursor->index].base;
1952                         if (elm->btype == HAMMER_BTREE_TYPE_RECORD)
1953                                 break;
1954                         panic("Illegal leaf record type %02x", elm->btype);
1955                 }
1956                 error = hammer_cursor_down(cursor);
1957                 if (error)
1958                         break;
1959
1960                 elm = &cursor->node->ondisk->elms[cursor->index].base;
1961                 if (elm->obj_id != cmp->obj_id ||
1962                     elm->rec_type != cmp->rec_type ||
1963                     elm->key != cmp->key) {
1964                         break;
1965                 }
1966                 if (elm->create_tid >= tid)
1967                         break;
1968
1969         }
1970
1971         /*
1972          * Now we can safely adjust the left-hand boundary from the bottom-up.
1973          * The last element we remove from the list is the caller's right hand
1974          * boundary, which must also be adjusted.
1975          */
1976         while (error == 0 && (rhb = TAILQ_FIRST(&rhb_list)) != NULL) {
1977                 error = hammer_cursor_seek(cursor, rhb->node, rhb->index);
1978                 if (error)
1979                         break;
1980                 TAILQ_REMOVE(&rhb_list, rhb, entry);
1981                 hammer_unlock(&rhb->node->lock);
1982                 hammer_rel_node(rhb->node);
1983                 kfree(rhb, M_HAMMER);
1984
1985                 elm = &cursor->node->ondisk->elms[cursor->index].base;
1986                 if (cursor->node->ondisk->type == HAMMER_BTREE_TYPE_INTERNAL) {
1987                         hammer_modify_node(cursor->trans, cursor->node,
1988                                            &elm->create_tid,
1989                                            sizeof(elm->create_tid));
1990                         elm->create_tid = tid;
1991                         hammer_modify_node_done(cursor->node);
1992                 } else {
1993                         panic("hammer_btree_correct_lhb(): Bad element type");
1994                 }
1995         }
1996
1997         /*
1998          * Cleanup
1999          */
2000         while ((rhb = TAILQ_FIRST(&rhb_list)) != NULL) {
2001                 TAILQ_REMOVE(&rhb_list, rhb, entry);
2002                 hammer_unlock(&rhb->node->lock);
2003                 hammer_rel_node(rhb->node);
2004                 kfree(rhb, M_HAMMER);
2005         }
2006         return (error);
2007 }
2008
2009 #endif
2010
2011 /*
2012  * Attempt to remove the locked, empty or want-to-be-empty B-Tree node at
2013  * (cursor->node).  Returns 0 on success, EDEADLK if we could not complete
2014  * the operation due to a deadlock, or some other error.
2015  *
2016  * This routine is always called with an empty, locked leaf but may recurse
2017  * into want-to-be-empty parents as part of its operation.
2018  *
2019  * It should also be noted that when removing empty leaves we must be sure
2020  * to test and update mirror_tid because another thread may have deadlocked
2021  * against us (or someone) trying to propagate it up and cannot retry once
2022  * the node has been deleted.
2023  *
2024  * On return the cursor may end up pointing to an internal node, suitable
2025  * for further iteration but not for an immediate insertion or deletion.
2026  */
2027 static int
2028 btree_remove(hammer_cursor_t cursor)
2029 {
2030         hammer_node_ondisk_t ondisk;
2031         hammer_btree_elm_t elm;
2032         hammer_node_t node;
2033         hammer_node_t parent;
2034         const int esize = sizeof(*elm);
2035         int error;
2036
2037         node = cursor->node;
2038
2039         /*
2040          * When deleting the root of the filesystem convert it to
2041          * an empty leaf node.  Internal nodes cannot be empty.
2042          */
2043         ondisk = node->ondisk;
2044         if (ondisk->parent == 0) {
2045                 KKASSERT(cursor->parent == NULL);
2046                 hammer_modify_node_all(cursor->trans, node);
2047                 KKASSERT(ondisk == node->ondisk);
2048                 ondisk->type = HAMMER_BTREE_TYPE_LEAF;
2049                 ondisk->count = 0;
2050                 hammer_modify_node_done(node);
2051                 cursor->index = 0;
2052                 return(0);
2053         }
2054
2055         parent = cursor->parent;
2056         hammer_cursor_removed_node(node, parent, cursor->parent_index);
2057
2058         /*
2059          * Attempt to remove the parent's reference to the child.  If the
2060          * parent would become empty we have to recurse.  If we fail we
2061          * leave the parent pointing to an empty leaf node.
2062          */
2063         if (parent->ondisk->count == 1) {
2064                 /*
2065                  * This special cursor_up_locked() call leaves the original
2066                  * node exclusively locked and referenced, leaves the
2067                  * original parent locked (as the new node), and locks the
2068                  * new parent.  It can return EDEADLK.
2069                  */
2070                 error = hammer_cursor_up_locked(cursor);
2071                 if (error == 0) {
2072                         error = btree_remove(cursor);
2073                         if (error == 0) {
2074                                 hammer_modify_node_all(cursor->trans, node);
2075                                 ondisk = node->ondisk;
2076                                 ondisk->type = HAMMER_BTREE_TYPE_DELETED;
2077                                 ondisk->count = 0;
2078                                 hammer_modify_node_done(node);
2079                                 hammer_flush_node(node);
2080                                 hammer_delete_node(cursor->trans, node);
2081                         } else {
2082                                 kprintf("Warning: BTREE_REMOVE: Defering "
2083                                         "parent removal1 @ %016llx, skipping\n",
2084                                         node->node_offset);
2085                         }
2086                         hammer_unlock(&node->lock);
2087                         hammer_rel_node(node);
2088                 } else {
2089                         kprintf("Warning: BTREE_REMOVE: Defering parent "
2090                                 "removal2 @ %016llx, skipping\n",
2091                                 node->node_offset);
2092                 }
2093         } else {
2094                 KKASSERT(parent->ondisk->count > 1);
2095
2096                 /*
2097                  * Delete the subtree reference in the parent
2098                  */
2099                 hammer_modify_node_all(cursor->trans, parent);
2100                 ondisk = parent->ondisk;
2101                 KKASSERT(ondisk->type == HAMMER_BTREE_TYPE_INTERNAL);
2102
2103                 elm = &ondisk->elms[cursor->parent_index];
2104                 KKASSERT(elm->internal.subtree_offset == node->node_offset);
2105                 KKASSERT(ondisk->count > 0);
2106                 bcopy(&elm[1], &elm[0],
2107                       (ondisk->count - cursor->parent_index) * esize);
2108                 --ondisk->count;
2109                 hammer_modify_node_done(parent);
2110                 hammer_flush_node(node);
2111                 hammer_delete_node(cursor->trans, node);
2112
2113                 /*
2114                  * cursor->node is invalid, cursor up to make the cursor
2115                  * valid again.
2116                  */
2117                 error = hammer_cursor_up(cursor);
2118         }
2119         return (error);
2120 }
2121
2122 /*
2123  * Propagate cursor->trans->tid up the B-Tree starting at the current
2124  * cursor position using pseudofs info gleaned from the passed inode.
2125  *
2126  * The passed inode has no relationship to the cursor position other
2127  * then being in the same pseudofs as the insertion or deletion we
2128  * are propagating the mirror_tid for.
2129  */
2130 void
2131 hammer_btree_do_propagation(hammer_cursor_t cursor, hammer_inode_t ip,
2132                             hammer_btree_leaf_elm_t leaf)
2133 {
2134         hammer_pseudofs_inmem_t pfsm;
2135         hammer_cursor_t ncursor;
2136         hammer_tid_t mirror_tid;
2137         int error;
2138
2139         /*
2140          * We only propagate the mirror_tid up if we are in master or slave
2141          * mode.  We do not bother if we are in no-mirror mode.
2142          */
2143         pfsm = ip->pfsm;
2144         KKASSERT(pfsm != NULL);
2145         if (pfsm->pfsd.master_id < 0 &&
2146             (pfsm->pfsd.mirror_flags & HAMMER_PFSD_SLAVE) == 0) {
2147                 return;
2148         }
2149
2150         /*
2151          * This is a bit of a hack because we cannot deadlock or return
2152          * EDEADLK here.  The related operation has already completed and
2153          * we must propagate the mirror_tid now regardless.
2154          *
2155          * Generate a new cursor which inherits the original's locks and
2156          * unlock the original.  Use the new cursor to propagate the
2157          * mirror_tid.  Then clean up the new cursor and reacquire locks
2158          * on the original.
2159          *
2160          * hammer_dup_cursor() cannot dup locks.  The dup inherits the
2161          * original's locks and the original is tracked and must be
2162          * re-locked.
2163          */
2164         mirror_tid = cursor->node->ondisk->mirror_tid;
2165         KKASSERT(mirror_tid != 0);
2166         ncursor = kmalloc(sizeof(*ncursor), M_HAMMER, M_WAITOK | M_ZERO);
2167         hammer_dup_cursor(cursor, ncursor);
2168         error = hammer_btree_mirror_propagate(ncursor, mirror_tid);
2169         KKASSERT(error == 0);
2170         hammer_done_cursor(ncursor);
2171         kfree(ncursor, M_HAMMER);
2172         hammer_lock_cursor(cursor);     /* shared-lock */
2173 }
2174
2175
2176 /*
2177  * Propagate a mirror TID update upwards through the B-Tree to the root.
2178  *
2179  * A locked internal node must be passed in.  The node will remain locked
2180  * on return.
2181  *
2182  * This function syncs mirror_tid at the specified internal node's element,
2183  * adjusts the node's aggregation mirror_tid, and then recurses upwards.
2184  */
2185 static int
2186 hammer_btree_mirror_propagate(hammer_cursor_t cursor, hammer_tid_t mirror_tid)
2187 {
2188         hammer_btree_internal_elm_t elm;
2189         hammer_node_t node;
2190         int error;
2191
2192         for (;;) {
2193                 error = hammer_cursor_up(cursor);
2194                 if (error == 0)
2195                         error = hammer_cursor_upgrade(cursor);
2196                 while (error == EDEADLK) {
2197                         hammer_recover_cursor(cursor);
2198                         error = hammer_cursor_upgrade(cursor);
2199                 }
2200                 if (error)
2201                         break;
2202                 node = cursor->node;
2203                 KKASSERT (node->ondisk->type == HAMMER_BTREE_TYPE_INTERNAL);
2204
2205                 /*
2206                  * Adjust the node's element
2207                  */
2208                 elm = &node->ondisk->elms[cursor->index].internal;
2209                 if (elm->mirror_tid >= mirror_tid)
2210                         break;
2211                 hammer_modify_node(cursor->trans, node, &elm->mirror_tid,
2212                                    sizeof(elm->mirror_tid));
2213                 elm->mirror_tid = mirror_tid;
2214                 hammer_modify_node_done(node);
2215
2216                 /*
2217                  * Adjust the node's mirror_tid aggregator
2218                  */
2219                 if (node->ondisk->mirror_tid >= mirror_tid)
2220                         return(0);
2221                 hammer_modify_node_field(cursor->trans, node, mirror_tid);
2222                 node->ondisk->mirror_tid = mirror_tid;
2223                 hammer_modify_node_done(node);
2224         }
2225         if (error == ENOENT)
2226                 error = 0;
2227         return(error);
2228 }
2229
2230 hammer_node_t
2231 hammer_btree_get_parent(hammer_node_t node, int *parent_indexp, int *errorp,
2232                         int try_exclusive)
2233 {
2234         hammer_node_t parent;
2235         hammer_btree_elm_t elm;
2236         int i;
2237
2238         /*
2239          * Get the node
2240          */
2241         parent = hammer_get_node(node->hmp, node->ondisk->parent, 0, errorp);
2242         if (*errorp) {
2243                 KKASSERT(parent == NULL);
2244                 return(NULL);
2245         }
2246         KKASSERT ((parent->flags & HAMMER_NODE_DELETED) == 0);
2247
2248         /*
2249          * Lock the node
2250          */
2251         if (try_exclusive) {
2252                 if (hammer_lock_ex_try(&parent->lock)) {
2253                         hammer_rel_node(parent);
2254                         *errorp = EDEADLK;
2255                         return(NULL);
2256                 }
2257         } else {
2258                 hammer_lock_sh(&parent->lock);
2259         }
2260
2261         /*
2262          * Figure out which element in the parent is pointing to the
2263          * child.
2264          */
2265         if (node->ondisk->count) {
2266                 i = hammer_btree_search_node(&node->ondisk->elms[0].base,
2267                                              parent->ondisk);
2268         } else {
2269                 i = 0;
2270         }
2271         while (i < parent->ondisk->count) {
2272                 elm = &parent->ondisk->elms[i];
2273                 if (elm->internal.subtree_offset == node->node_offset)
2274                         break;
2275                 ++i;
2276         }
2277         if (i == parent->ondisk->count) {
2278                 hammer_unlock(&parent->lock);
2279                 panic("Bad B-Tree link: parent %p node %p\n", parent, node);
2280         }
2281         *parent_indexp = i;
2282         KKASSERT(*errorp == 0);
2283         return(parent);
2284 }
2285
2286 /*
2287  * The element (elm) has been moved to a new internal node (node).
2288  *
2289  * If the element represents a pointer to an internal node that node's
2290  * parent must be adjusted to the element's new location.
2291  *
2292  * XXX deadlock potential here with our exclusive locks
2293  */
2294 int
2295 btree_set_parent(hammer_transaction_t trans, hammer_node_t node,
2296                  hammer_btree_elm_t elm)
2297 {
2298         hammer_node_t child;
2299         int error;
2300
2301         error = 0;
2302
2303         switch(elm->base.btype) {
2304         case HAMMER_BTREE_TYPE_INTERNAL:
2305         case HAMMER_BTREE_TYPE_LEAF:
2306                 child = hammer_get_node(node->hmp, elm->internal.subtree_offset,
2307                                         0, &error);
2308                 if (error == 0) {
2309                         hammer_modify_node_field(trans, child, parent);
2310                         child->ondisk->parent = node->node_offset;
2311                         hammer_modify_node_done(child);
2312                         hammer_rel_node(child);
2313                 }
2314                 break;
2315         default:
2316                 break;
2317         }
2318         return(error);
2319 }
2320
2321 /*
2322  * Exclusively lock all the children of node.  This is used by the split
2323  * code to prevent anyone from accessing the children of a cursor node
2324  * while we fix-up its parent offset.
2325  *
2326  * If we don't lock the children we can really mess up cursors which block
2327  * trying to cursor-up into our node.
2328  *
2329  * On failure EDEADLK (or some other error) is returned.  If a deadlock
2330  * error is returned the cursor is adjusted to block on termination.
2331  */
2332 int
2333 hammer_btree_lock_children(hammer_cursor_t cursor,
2334                            struct hammer_node_locklist **locklistp)
2335 {
2336         hammer_node_t node;
2337         hammer_node_locklist_t item;
2338         hammer_node_ondisk_t ondisk;
2339         hammer_btree_elm_t elm;
2340         hammer_node_t child;
2341         int error;
2342         int i;
2343
2344         node = cursor->node;
2345         ondisk = node->ondisk;
2346         error = 0;
2347
2348         /*
2349          * We really do not want to block on I/O with exclusive locks held,
2350          * pre-get the children before trying to lock the mess.
2351          */
2352         for (i = 0; i < ondisk->count; ++i) {
2353                 ++hammer_stats_btree_elements;
2354                 elm = &ondisk->elms[i];
2355                 if (elm->base.btype != HAMMER_BTREE_TYPE_LEAF &&
2356                     elm->base.btype != HAMMER_BTREE_TYPE_INTERNAL) {
2357                         continue;
2358                 }
2359                 child = hammer_get_node(node->hmp,
2360                                         elm->internal.subtree_offset,
2361                                         0, &error);
2362                 if (child)
2363                         hammer_rel_node(child);
2364         }
2365
2366         /*
2367          * Do it for real
2368          */
2369         for (i = 0; error == 0 && i < ondisk->count; ++i) {
2370                 ++hammer_stats_btree_elements;
2371                 elm = &ondisk->elms[i];
2372
2373                 switch(elm->base.btype) {
2374                 case HAMMER_BTREE_TYPE_INTERNAL:
2375                 case HAMMER_BTREE_TYPE_LEAF:
2376                         KKASSERT(elm->internal.subtree_offset != 0);
2377                         child = hammer_get_node(node->hmp,
2378                                                 elm->internal.subtree_offset,
2379                                                 0, &error);
2380                         break;
2381                 default:
2382                         child = NULL;
2383                         break;
2384                 }
2385                 if (child) {
2386                         if (hammer_lock_ex_try(&child->lock) != 0) {
2387                                 if (cursor->deadlk_node == NULL) {
2388                                         cursor->deadlk_node = child;
2389                                         hammer_ref_node(cursor->deadlk_node);
2390                                 }
2391                                 error = EDEADLK;
2392                                 hammer_rel_node(child);
2393                         } else {
2394                                 item = kmalloc(sizeof(*item),
2395                                                 M_HAMMER, M_WAITOK);
2396                                 item->next = *locklistp;
2397                                 item->node = child;
2398                                 *locklistp = item;
2399                         }
2400                 }
2401         }
2402         if (error)
2403                 hammer_btree_unlock_children(locklistp);
2404         return(error);
2405 }
2406
2407
2408 /*
2409  * Release previously obtained node locks.
2410  */
2411 void
2412 hammer_btree_unlock_children(struct hammer_node_locklist **locklistp)
2413 {
2414         hammer_node_locklist_t item;
2415
2416         while ((item = *locklistp) != NULL) {
2417                 *locklistp = item->next;
2418                 hammer_unlock(&item->node->lock);
2419                 hammer_rel_node(item->node);
2420                 kfree(item, M_HAMMER);
2421         }
2422 }
2423
2424 /************************************************************************
2425  *                         MISCELLANIOUS SUPPORT                        *
2426  ************************************************************************/
2427
2428 /*
2429  * Compare two B-Tree elements, return -N, 0, or +N (e.g. similar to strcmp).
2430  *
2431  * Note that for this particular function a return value of -1, 0, or +1
2432  * can denote a match if create_tid is otherwise discounted.  A create_tid
2433  * of zero is considered to be 'infinity' in comparisons.
2434  *
2435  * See also hammer_rec_rb_compare() and hammer_rec_cmp() in hammer_object.c.
2436  */
2437 int
2438 hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2)
2439 {
2440         if (key1->localization < key2->localization)
2441                 return(-5);
2442         if (key1->localization > key2->localization)
2443                 return(5);
2444
2445         if (key1->obj_id < key2->obj_id)
2446                 return(-4);
2447         if (key1->obj_id > key2->obj_id)
2448                 return(4);
2449
2450         if (key1->rec_type < key2->rec_type)
2451                 return(-3);
2452         if (key1->rec_type > key2->rec_type)
2453                 return(3);
2454
2455         if (key1->key < key2->key)
2456                 return(-2);
2457         if (key1->key > key2->key)
2458                 return(2);
2459
2460         /*
2461          * A create_tid of zero indicates a record which is undeletable
2462          * and must be considered to have a value of positive infinity.
2463          */
2464         if (key1->create_tid == 0) {
2465                 if (key2->create_tid == 0)
2466                         return(0);
2467                 return(1);
2468         }
2469         if (key2->create_tid == 0)
2470                 return(-1);
2471         if (key1->create_tid < key2->create_tid)
2472                 return(-1);
2473         if (key1->create_tid > key2->create_tid)
2474                 return(1);
2475         return(0);
2476 }
2477
2478 /*
2479  * Test a timestamp against an element to determine whether the
2480  * element is visible.  A timestamp of 0 means 'infinity'.
2481  */
2482 int
2483 hammer_btree_chkts(hammer_tid_t asof, hammer_base_elm_t base)
2484 {
2485         if (asof == 0) {
2486                 if (base->delete_tid)
2487                         return(1);
2488                 return(0);
2489         }
2490         if (asof < base->create_tid)
2491                 return(-1);
2492         if (base->delete_tid && asof >= base->delete_tid)
2493                 return(1);
2494         return(0);
2495 }
2496
2497 /*
2498  * Create a separator half way inbetween key1 and key2.  For fields just
2499  * one unit apart, the separator will match key2.  key1 is on the left-hand
2500  * side and key2 is on the right-hand side.
2501  *
2502  * key2 must be >= the separator.  It is ok for the separator to match key2.
2503  *
2504  * NOTE: Even if key1 does not match key2, the separator may wind up matching
2505  * key2.
2506  *
2507  * NOTE: It might be beneficial to just scrap this whole mess and just
2508  * set the separator to key2.
2509  */
2510 #define MAKE_SEPARATOR(key1, key2, dest, field) \
2511         dest->field = key1->field + ((key2->field - key1->field + 1) >> 1);
2512
2513 static void
2514 hammer_make_separator(hammer_base_elm_t key1, hammer_base_elm_t key2,
2515                       hammer_base_elm_t dest)
2516 {
2517         bzero(dest, sizeof(*dest));
2518
2519         dest->rec_type = key2->rec_type;
2520         dest->key = key2->key;
2521         dest->obj_id = key2->obj_id;
2522         dest->create_tid = key2->create_tid;
2523
2524         MAKE_SEPARATOR(key1, key2, dest, localization);
2525         if (key1->localization == key2->localization) {
2526                 MAKE_SEPARATOR(key1, key2, dest, obj_id);
2527                 if (key1->obj_id == key2->obj_id) {
2528                         MAKE_SEPARATOR(key1, key2, dest, rec_type);
2529                         if (key1->rec_type == key2->rec_type) {
2530                                 MAKE_SEPARATOR(key1, key2, dest, key);
2531                                 /*
2532                                  * Don't bother creating a separator for
2533                                  * create_tid, which also conveniently avoids
2534                                  * having to handle the create_tid == 0
2535                                  * (infinity) case.  Just leave create_tid
2536                                  * set to key2.
2537                                  *
2538                                  * Worst case, dest matches key2 exactly,
2539                                  * which is acceptable.
2540                                  */
2541                         }
2542                 }
2543         }
2544 }
2545
2546 #undef MAKE_SEPARATOR
2547
2548 /*
2549  * Return whether a generic internal or leaf node is full
2550  */
2551 static int
2552 btree_node_is_full(hammer_node_ondisk_t node)
2553 {
2554         switch(node->type) {
2555         case HAMMER_BTREE_TYPE_INTERNAL:
2556                 if (node->count == HAMMER_BTREE_INT_ELMS)
2557                         return(1);
2558                 break;
2559         case HAMMER_BTREE_TYPE_LEAF:
2560                 if (node->count == HAMMER_BTREE_LEAF_ELMS)
2561                         return(1);
2562                 break;
2563         default:
2564                 panic("illegal btree subtype");
2565         }
2566         return(0);
2567 }
2568
2569 #if 0
2570 static int
2571 btree_max_elements(u_int8_t type)
2572 {
2573         if (type == HAMMER_BTREE_TYPE_LEAF)
2574                 return(HAMMER_BTREE_LEAF_ELMS);
2575         if (type == HAMMER_BTREE_TYPE_INTERNAL)
2576                 return(HAMMER_BTREE_INT_ELMS);
2577         panic("btree_max_elements: bad type %d\n", type);
2578 }
2579 #endif
2580
2581 void
2582 hammer_print_btree_node(hammer_node_ondisk_t ondisk)
2583 {
2584         hammer_btree_elm_t elm;
2585         int i;
2586
2587         kprintf("node %p count=%d parent=%016llx type=%c\n",
2588                 ondisk, ondisk->count, ondisk->parent, ondisk->type);
2589
2590         /*
2591          * Dump both boundary elements if an internal node
2592          */
2593         if (ondisk->type == HAMMER_BTREE_TYPE_INTERNAL) {
2594                 for (i = 0; i <= ondisk->count; ++i) {
2595                         elm = &ondisk->elms[i];
2596                         hammer_print_btree_elm(elm, ondisk->type, i);
2597                 }
2598         } else {
2599                 for (i = 0; i < ondisk->count; ++i) {
2600                         elm = &ondisk->elms[i];
2601                         hammer_print_btree_elm(elm, ondisk->type, i);
2602                 }
2603         }
2604 }
2605
2606 void
2607 hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i)
2608 {
2609         kprintf("  %2d", i);
2610         kprintf("\tobj_id       = %016llx\n", elm->base.obj_id);
2611         kprintf("\tkey          = %016llx\n", elm->base.key);
2612         kprintf("\tcreate_tid   = %016llx\n", elm->base.create_tid);
2613         kprintf("\tdelete_tid   = %016llx\n", elm->base.delete_tid);
2614         kprintf("\trec_type     = %04x\n", elm->base.rec_type);
2615         kprintf("\tobj_type     = %02x\n", elm->base.obj_type);
2616         kprintf("\tbtype        = %02x (%c)\n",
2617                 elm->base.btype,
2618                 (elm->base.btype ? elm->base.btype : '?'));
2619         kprintf("\tlocalization = %02x\n", elm->base.localization);
2620
2621         switch(type) {
2622         case HAMMER_BTREE_TYPE_INTERNAL:
2623                 kprintf("\tsubtree_off  = %016llx\n",
2624                         elm->internal.subtree_offset);
2625                 break;
2626         case HAMMER_BTREE_TYPE_RECORD:
2627                 kprintf("\tdata_offset  = %016llx\n", elm->leaf.data_offset);
2628                 kprintf("\tdata_len     = %08x\n", elm->leaf.data_len);
2629                 kprintf("\tdata_crc     = %08x\n", elm->leaf.data_crc);
2630                 break;
2631         }
2632 }