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