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