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