1840c532d18c028f362d9888943dec487695b54c
[dragonfly.git] / sys / vfs / hammer / hammer_btree.c
1 /*
2  * Copyright (c) 2007 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.12 2007/12/30 00:47:22 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 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  * INTER-CLUSTER ELEMENTS:  An element of an internal node may reference
71  * the root of another cluster rather then a node in the current cluster.
72  * This is known as an inter-cluster references.  Only B-Tree searches
73  * will cross cluster boundaries.  The rebalancing and collapse code does
74  * not attempt to move children between clusters.  A major effect of this
75  * is that we have to relax minimum element count requirements and allow
76  * trees to become somewhat unabalanced.
77  *
78  * INSERTIONS AND DELETIONS:  When inserting we split full nodes on our
79  * way down as an optimization.  I originally experimented with rebalancing
80  * nodes on the way down for deletions but it created a huge mess due to
81  * the way inter-cluster linkages work.  Instead, now I simply allow
82  * the tree to become unbalanced and allow leaf nodes to become empty.
83  * The delete code will try to clean things up from the bottom-up but
84  * will stop if related elements are not in-core or if it cannot get a node
85  * lock.
86  */
87 #include "hammer.h"
88 #include <sys/buf.h>
89 #include <sys/buf2.h>
90
91 static int btree_search(hammer_cursor_t cursor, int flags);
92 static int btree_split_internal(hammer_cursor_t cursor);
93 static int btree_split_leaf(hammer_cursor_t cursor);
94 static int btree_remove(hammer_cursor_t cursor);
95 static int btree_set_parent(hammer_node_t node, hammer_btree_elm_t elm);
96 #if 0
97 static int btree_rebalance(hammer_cursor_t cursor);
98 static int btree_collapse(hammer_cursor_t cursor);
99 #endif
100 static int btree_node_is_full(hammer_node_ondisk_t node);
101 static void hammer_make_separator(hammer_base_elm_t key1,
102                         hammer_base_elm_t key2, hammer_base_elm_t dest);
103
104 /*
105  * Iterate records after a search.  The cursor is iterated forwards past
106  * the current record until a record matching the key-range requirements
107  * is found.  ENOENT is returned if the iteration goes past the ending
108  * key.
109  *
110  * The iteration is inclusive of key_beg and can be inclusive or exclusive
111  * of key_end depending on whether HAMMER_CURSOR_END_INCLUSIVE is set.
112  *
113  * cursor->key_beg may or may not be modified by this function during
114  * the iteration.  XXX future - in case of an inverted lock we may have
115  * to reinitiate the lookup and set key_beg to properly pick up where we
116  * left off.
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                  * NOTE: This can pop us up to another cluster.
147                  *
148                  * If we are at the root of the root cluster, cursor_up
149                  * returns ENOENT.
150                  *
151                  * NOTE: hammer_cursor_up() will adjust cursor->key_beg
152                  * when told to re-search for the cluster tag.
153                  *
154                  * XXX this could be optimized by storing the information in
155                  * the parent reference.
156                  *
157                  * XXX we can lose the node lock temporarily, this could mess
158                  * up our scan.
159                  */
160                 if (cursor->index == node->count) {
161                         error = hammer_cursor_up(cursor, 0);
162                         if (error)
163                                 break;
164                         node = cursor->node->ondisk;
165                         KKASSERT(cursor->index != node->count);
166                         ++cursor->index;
167                         continue;
168                 }
169
170                 /*
171                  * Check internal or leaf element.  Determine if the record
172                  * at the cursor has gone beyond the end of our range.
173                  * Remember that our key range is end-exclusive.
174                  *
175                  * Generally we recurse down through internal nodes.  An
176                  * internal node can only be returned if INCLUSTER is set
177                  * and the node represents a cluster-push record.  Internal
178                  * elements do not contain create_tid/delete_tid information.
179                  */
180                 if (node->type == HAMMER_BTREE_TYPE_INTERNAL) {
181                         elm = &node->elms[cursor->index];
182                         r = hammer_btree_cmp(&cursor->key_end, &elm[0].base);
183                         s = hammer_btree_cmp(&cursor->key_beg, &elm[1].base);
184                         if (r < 0) {
185                                 error = ENOENT;
186                                 break;
187                         }
188                         if (r == 0 && (cursor->flags & HAMMER_CURSOR_END_INCLUSIVE) == 0) {
189                                 error = ENOENT;
190                                 break;
191                         }
192                         KKASSERT(s <= 0);
193                         if ((cursor->flags & HAMMER_CURSOR_INCLUSTER) == 0 ||
194                             elm->internal.rec_offset == 0) {
195                                 error = hammer_cursor_down(cursor);
196                                 if (error)
197                                         break;
198                                 KKASSERT(cursor->index == 0);
199                                 node = cursor->node->ondisk;
200                                 continue;
201                         }
202                 } else {
203                         elm = &node->elms[cursor->index];
204                         r = hammer_btree_cmp(&cursor->key_end, &elm->base);
205                         if (r < 0) {
206                                 error = ENOENT;
207                                 break;
208                         }
209                         if (r == 0 && (cursor->flags & HAMMER_CURSOR_END_INCLUSIVE) == 0) {
210                                 error = ENOENT;
211                                 break;
212                         }
213                         if ((cursor->flags & HAMMER_CURSOR_ALLHISTORY) == 0 &&
214                             hammer_btree_chkts(cursor->key_beg.create_tid,
215                                                &elm->base) != 0) {
216                                 ++cursor->index;
217                                 continue;
218                         }
219                 }
220
221                 /*
222                  * Return entry
223                  */
224                 return(0);
225         }
226         return(error);
227 }
228
229 /*
230  * Lookup cursor->key_beg.  0 is returned on success, ENOENT if the entry
231  * could not be found, and a fatal error otherwise.
232  * 
233  * The cursor is suitably positioned for a deletion on success, and suitably
234  * positioned for an insertion on ENOENT.
235  *
236  * The cursor may begin anywhere, the search will traverse clusters in
237  * either direction to locate the requested element.
238  */
239 int
240 hammer_btree_lookup(hammer_cursor_t cursor)
241 {
242         int error;
243
244         error = btree_search(cursor, 0);
245         if (error == 0 && cursor->flags)
246                 error = hammer_btree_extract(cursor, cursor->flags);
247         return(error);
248 }
249
250 /*
251  * Execute the logic required to start an iteration.  The first record
252  * located within the specified range is returned and iteration control
253  * flags are adjusted for successive hammer_btree_iterate() calls.
254  */
255 int
256 hammer_btree_first(hammer_cursor_t cursor)
257 {
258         int error;
259
260         error = hammer_btree_lookup(cursor);
261         if (error == ENOENT) {
262                 cursor->flags &= ~HAMMER_CURSOR_ATEDISK;
263                 error = hammer_btree_iterate(cursor);
264         }
265         cursor->flags |= HAMMER_CURSOR_ATEDISK;
266         return(error);
267 }
268
269 /*
270  * Extract the record and/or data associated with the cursor's current
271  * position.  Any prior record or data stored in the cursor is replaced.
272  * The cursor must be positioned at a leaf node.
273  *
274  * NOTE: Most extractions occur at the leaf of the B-Tree.  The only
275  *       extraction allowed at an internal element is at a cluster-push.
276  *       Cluster-push elements have records but no data.
277  */
278 int
279 hammer_btree_extract(hammer_cursor_t cursor, int flags)
280 {
281         hammer_node_ondisk_t node;
282         hammer_btree_elm_t elm;
283         hammer_cluster_t cluster;
284         u_int64_t buf_type;
285         int32_t cloff;
286         int32_t roff;
287         int error;
288
289         /*
290          * A cluster record type has no data reference, the information
291          * is stored directly in the record and B-Tree element.
292          *
293          * The case where the data reference resolves to the same buffer
294          * as the record reference must be handled.
295          */
296         node = cursor->node->ondisk;
297         elm = &node->elms[cursor->index];
298         cluster = cursor->node->cluster;
299         cursor->flags &= ~HAMMER_CURSOR_DATA_EMBEDDED;
300         cursor->data = NULL;
301         error = 0;
302
303         /*
304          * Internal elements can only be cluster pushes.  A cluster push has
305          * no data reference.
306          */
307         if (node->type == HAMMER_BTREE_TYPE_INTERNAL) {
308                 cloff = elm->leaf.rec_offset;
309                 KKASSERT(cloff != 0);
310                 cursor->record = hammer_bread(cluster, cloff,
311                                               HAMMER_FSBUF_RECORDS, &error,
312                                               &cursor->record_buffer);
313                 return(error);
314         }
315
316         /*
317          * Leaf element.
318          */
319         if ((flags & HAMMER_CURSOR_GET_RECORD) && error == 0) {
320                 cloff = elm->leaf.rec_offset;
321                 cursor->record = hammer_bread(cluster, cloff,
322                                               HAMMER_FSBUF_RECORDS, &error,
323                                               &cursor->record_buffer);
324         } else {
325                 cloff = 0;
326         }
327         if ((flags & HAMMER_CURSOR_GET_DATA) && error == 0) {
328                 if ((cloff ^ elm->leaf.data_offset) & ~HAMMER_BUFMASK) {
329                         /*
330                          * The data is not in the same buffer as the last
331                          * record we cached, but it could still be embedded
332                          * in a record.  Note that we may not have loaded the
333                          * record's buffer above, depending on flags.
334                          */
335                         if ((elm->leaf.rec_offset ^ elm->leaf.data_offset) &
336                             ~HAMMER_BUFMASK) {
337                                 if (elm->leaf.data_len & HAMMER_BUFMASK)
338                                         buf_type = HAMMER_FSBUF_DATA;
339                                 else
340                                         buf_type = 0;   /* pure data buffer */
341                         } else {
342                                 buf_type = HAMMER_FSBUF_RECORDS;
343                         }
344                         cursor->data = hammer_bread(cluster,
345                                                   elm->leaf.data_offset,
346                                                   buf_type, &error,
347                                                   &cursor->data_buffer);
348                 } else {
349                         /*
350                          * Data in same buffer as record.  Note that we
351                          * leave any existing data_buffer intact, even
352                          * though we don't use it in this case, in case
353                          * other records extracted during an iteration
354                          * go back to it.
355                          *
356                          * The data must be embedded in the record for this
357                          * case to be hit.
358                          *
359                          * Just assume the buffer type is correct.
360                          */
361                         cursor->data = (void *)
362                                 ((char *)cursor->record_buffer->ondisk +
363                                  (elm->leaf.data_offset & HAMMER_BUFMASK));
364                         roff = (char *)cursor->data - (char *)cursor->record;
365                         KKASSERT (roff >= 0 && roff < HAMMER_RECORD_SIZE);
366                         cursor->flags |= HAMMER_CURSOR_DATA_EMBEDDED;
367                 }
368         }
369         return(error);
370 }
371
372
373 /*
374  * Insert a leaf element into the B-Tree at the current cursor position.
375  * The cursor is positioned such that the element at and beyond the cursor
376  * are shifted to make room for the new record.
377  *
378  * The caller must call hammer_btree_lookup() with the HAMMER_CURSOR_INSERT
379  * flag set and that call must return ENOENT before this function can be
380  * called.
381  *
382  * ENOSPC is returned if there is no room to insert a new record.
383  */
384 int
385 hammer_btree_insert(hammer_cursor_t cursor, hammer_btree_elm_t elm)
386 {
387         hammer_node_ondisk_t parent;
388         hammer_node_ondisk_t node;
389         int i;
390
391 #if 0
392         /* HANDLED BY CALLER */
393         /*
394          * Issue a search to get our cursor at the right place.  The search
395          * will get us to a leaf node.
396          *
397          * The search also does some setup for our insert, so there is always
398          * room in the leaf.
399          */
400         error = btree_search(cursor, HAMMER_CURSOR_INSERT);
401         if (error != ENOENT) {
402                 if (error == 0)
403                         error = EEXIST;
404                 return (error);
405         }
406 #endif
407
408         /*
409          * Insert the element at the leaf node and update the count in the
410          * parent.  It is possible for parent to be NULL, indicating that
411          * the root of the B-Tree in the cluster is a leaf.  It is also
412          * possible for the leaf to be empty.
413          *
414          * Remember that the right-hand boundary is not included in the
415          * count.
416          */
417         node = cursor->node->ondisk;
418         i = cursor->index;
419         KKASSERT(node->type == HAMMER_BTREE_TYPE_LEAF);
420         KKASSERT(node->count < HAMMER_BTREE_LEAF_ELMS);
421         if (i != node->count) {
422                 bcopy(&node->elms[i], &node->elms[i+1],
423                       (node->count - i) * sizeof(*elm));
424         }
425         node->elms[i] = *elm;
426         ++node->count;
427         hammer_modify_node(cursor->node);
428
429         /*
430          * Adjust the sub-tree count in the parent.  note that the parent
431          * may be in a different cluster.
432          */
433         if (cursor->parent) {
434                 parent = cursor->parent->ondisk;
435                 i = cursor->parent_index;
436                 ++parent->elms[i].internal.subtree_count;
437                 KKASSERT(parent->elms[i].internal.subtree_count <= node->count);
438                 hammer_modify_node(cursor->parent);
439         }
440         return(0);
441 }
442
443 /*
444  * Delete a record from the B-Tree's at the current cursor position.
445  * The cursor is positioned such that the current element is the one
446  * to be deleted.
447  *
448  * On return the cursor will be positioned after the deleted element and
449  * MAY point to an internal node.  It will be suitable for the continuation
450  * of an iteration but not for an insertion or deletion.
451  *
452  * Deletions will attempt to partially rebalance the B-Tree in an upward
453  * direction.  It is possible to end up with empty leafs.  An empty internal
454  * node is impossible (worst case: it has one element pointing to an empty
455  * leaf).
456  */
457 int
458 hammer_btree_delete(hammer_cursor_t cursor)
459 {
460         hammer_node_ondisk_t ondisk;
461         hammer_node_t node;
462         hammer_node_t parent;
463         hammer_btree_elm_t elm;
464         int error;
465         int i;
466
467 #if 0
468         /* HANDLED BY CALLER */
469         /*
470          * Locate the leaf element to delete.  The search is also responsible
471          * for doing some of the rebalancing work on its way down.
472          */
473         error = btree_search(cursor, HAMMER_CURSOR_DELETE);
474         if (error)
475                 return (error);
476 #endif
477
478         /*
479          * Delete the element from the leaf node. 
480          *
481          * Remember that leaf nodes do not have boundaries.
482          */
483         node = cursor->node;
484         ondisk = node->ondisk;
485         i = cursor->index;
486
487         KKASSERT(ondisk->type == HAMMER_BTREE_TYPE_LEAF);
488         if (i + 1 != ondisk->count) {
489                 bcopy(&ondisk->elms[i+1], &ondisk->elms[i],
490                       (ondisk->count - i - 1) * sizeof(ondisk->elms[0]));
491         }
492         --ondisk->count;
493         hammer_modify_node(node);
494         if (cursor->parent != NULL) {
495                 /*
496                  * Adjust parent's notion of the leaf's count.  subtree_count
497                  * is only approximate, it is allowed to be too small but
498                  * never allowed to be too large.  Make sure we don't drop
499                  * the count below 0.
500                  */
501                 parent = cursor->parent;
502                 elm = &parent->ondisk->elms[cursor->parent_index];
503                 if (elm->internal.subtree_count)
504                         --elm->internal.subtree_count;
505                 KKASSERT(elm->internal.subtree_count <= ondisk->count);
506                 hammer_modify_node(parent);
507         }
508
509         /*
510          * It is possible, but not desireable, to stop here.  If the element
511          * count drops to 0 (which is allowed for a leaf), try recursively
512          * remove the B-Tree node.
513          *
514          * XXX rebalancing calls would go here too.
515          *
516          * This may reposition the cursor at one of the parent's of the
517          * current node.
518          */
519         if (ondisk->count == 0) {
520                 error = btree_remove(cursor);
521                 if (error == EAGAIN)
522                         error = 0;
523         } else {
524                 error = 0;
525         }
526         return(error);
527 }
528
529 /*
530  * PRIMAY B-TREE SEARCH SUPPORT PROCEDURE
531  *
532  * Search a cluster's B-Tree for cursor->key_beg, return the matching node.
533  *
534  * The search can begin ANYWHERE in the B-Tree.  As a first step the search
535  * iterates up the tree as necessary to properly position itself prior to
536  * actually doing the sarch.
537  * 
538  * INSERTIONS: The search will split full nodes and leaves on its way down
539  * and guarentee that the leaf it ends up on is not full.  If we run out
540  * of space the search continues to the leaf (to position the cursor for
541  * the spike), but ENOSPC is returned.
542  *
543  * DELETIONS: The search will rebalance the tree on its way down. XXX
544  *
545  * The search is only guarenteed to end up on a leaf if an error code of 0
546  * is returned, or if inserting and an error code of ENOENT is returned.
547  * Otherwise it can stop at an internal node.  On success a search returns
548  * a leaf node unless INCLUSTER is set and the search located a cluster push
549  * node (which is an internal node).
550  */
551 static 
552 int
553 btree_search(hammer_cursor_t cursor, int flags)
554 {
555         hammer_node_ondisk_t node;
556         hammer_cluster_t cluster;
557         int error;
558         int enospc = 0;
559         int i;
560         int r;
561
562         flags |= cursor->flags;
563
564         /*
565          * Move our cursor up the tree until we find a node whos range covers
566          * the key we are trying to locate.  This may move us between
567          * clusters.
568          *
569          * The left bound is inclusive, the right bound is non-inclusive.
570          * It is ok to cursor up too far so when cursoring across a cluster
571          * boundary.
572          *
573          * First see if we can skip the whole cluster.  hammer_cursor_up()
574          * handles both cases but this way we don't check the cluster
575          * bounds when going up the tree within a cluster.
576          *
577          * NOTE: If INCLUSTER is set and we are at the root of the cluster,
578          * hammer_cursor_up() will return ENOENT.
579          */
580         cluster = cursor->node->cluster;
581         while (
582             hammer_btree_cmp(&cursor->key_beg, &cluster->clu_btree_beg) < 0 ||
583             hammer_btree_cmp(&cursor->key_beg, &cluster->clu_btree_end) >= 0) {
584                 error = hammer_cursor_toroot(cursor);
585                 if (error)
586                         goto done;
587                 error = hammer_cursor_up(cursor, 0);
588                 if (error)
589                         goto done;
590                 cluster = cursor->node->cluster;
591         }
592
593         /*
594          * Deal with normal cursoring within a cluster.  The right bound
595          * is non-inclusive.  That is, the bounds form a separator.
596          */
597         while (hammer_btree_cmp(&cursor->key_beg, cursor->left_bound) < 0 ||
598                hammer_btree_cmp(&cursor->key_beg, cursor->right_bound) >= 0) {
599                 error = hammer_cursor_up(cursor, 0);
600                 if (error)
601                         goto done;
602         }
603
604         /*
605          * We better have ended up with a node somewhere, and our second
606          * while loop had better not have traversed up a cluster.
607          */
608         KKASSERT(cursor->node != NULL && cursor->node->cluster == cluster);
609
610         /*
611          * If we are inserting we can't start at a full node if the parent
612          * is also full (because there is no way to split the node),
613          * continue running up the tree until we hit the root of the
614          * root cluster or until the requirement is satisfied.
615          *
616          * NOTE: These cursor-up's CAN continue to cross cluster boundaries.
617          *
618          * XXX as an optimization it should be possible to unbalance the tree
619          * and stop at the root of the current cluster.
620          */
621         while (flags & HAMMER_CURSOR_INSERT) {
622                 if (btree_node_is_full(cursor->node->ondisk) == 0)
623                         break;
624                 if (cursor->parent == NULL)
625                         break;
626                 if (cursor->parent->ondisk->count != HAMMER_BTREE_INT_ELMS)
627                         break;
628                 error = hammer_cursor_up(cursor, 0);
629                 /* cluster and node are now may become stale */
630                 if (error)
631                         goto done;
632         }
633         /* cluster = cursor->node->cluster; not needed until next cluster = */
634
635 #if 0
636         /*
637          * If we are deleting we can't start at an internal node with only
638          * one element unless it is root, because all of our code assumes
639          * that internal nodes will never be empty.  Just do this generally
640          * for both leaf and internal nodes to get better balance.
641          *
642          * This handles the case where the cursor is sitting at a leaf and
643          * either the leaf or parent contain an insufficient number of
644          * elements.
645          *
646          * NOTE: These cursor-up's CAN continue to cross cluster boundaries.
647          *
648          * XXX NOTE: Iterations may not set this flag anyway.
649          */
650         while (flags & HAMMER_CURSOR_DELETE) {
651                 if (cursor->node->ondisk->count > 1)
652                         break;
653                 if (cursor->parent == NULL)
654                         break;
655                 KKASSERT(cursor->node->ondisk->count != 0);
656                 error = hammer_cursor_up(cursor, 0);
657                 /* cluster and node are now may become stale */
658                 if (error)
659                         goto done;
660         }
661 #endif
662
663 /*new_cluster:*/
664         /*
665          * Push down through internal nodes to locate the requested key.
666          */
667         cluster = cursor->node->cluster;
668         node = cursor->node->ondisk;
669         while (node->type == HAMMER_BTREE_TYPE_INTERNAL) {
670 #if 0
671                 /*
672                  * If we are a the root node and deleting, try to collapse
673                  * all of the root's children into the root.  This is the
674                  * only point where tree depth is reduced.
675                  *
676                  * XXX NOTE: Iterations may not set this flag anyway.
677                  */
678                 if ((flags & HAMMER_CURSOR_DELETE) && cursor->parent == NULL) {
679                         error = btree_collapse(cursor);
680                         /* node becomes stale after call */
681                         /* XXX ENOSPC */
682                         if (error)
683                                 goto done;
684                 }
685                 node = cursor->node->ondisk;
686 #endif
687                 /*
688                  * Scan the node to find the subtree index to push down into.
689                  * We go one-past, then back-up.
690                  */
691                 for (i = 0; i < node->count; ++i) {
692                         r = hammer_btree_cmp(&cursor->key_beg,
693                                              &node->elms[i].base);
694                         if (r < 0)
695                                 break;
696                 }
697
698                 /*
699                  * It is possible for the search to terminate at i == 0,
700                  * which is to the LEFT of the LEFT boundary but the RIGHT
701                  * of the parent's boundary on the left of the sub-tree
702                  * element.  This case can occur due to deletions (see
703                  * btree_remove()).
704                  *
705                  * When this case occurs an ENOENT return is guarenteed but
706                  * if inserting we must still terminate at a leaf.  The
707                  * solution is to make the node's left boundary inherit the
708                  * boundary stored in the parent.
709                  *
710                  * When doing this inheritance some fields in 'base' are
711                  * actually related to the internal element's child
712                  * specification and not to the key.  These have to be
713                  * retained.
714                  *
715                  * If we terminate at i == count it is still possible to
716                  * be to the RIGHT of the RIGHT boundary but still to the
717                  * LEFT of the parent's RIGHT boundary.  The solution is to
718                  * adjust the RIGHT boundary to match the parent.  This
719                  * case can occur due to deletions (see btree_remove()).
720                  */
721                 if (i == 0) {
722                         u_int8_t save;
723
724                         if ((flags & HAMMER_CURSOR_INSERT) == 0) {
725                                 cursor->index = 0;
726                                 return(ENOENT);
727                         }
728                         save = node->elms[0].subtree_type;
729                         node->elms[0].base = *cursor->left_bound;
730                         node->elms[0].subtree_type = save;
731                         hammer_modify_node(cursor->node);
732                 } else if (i == node->count) {
733                         /*
734                          * Terminate early if not inserting and the key is
735                          * beyond the uncorrected right hand boundary.  The
736                          * index must be PAST the last element to prevent an
737                          * iteration from returning elements to the left of
738                          * key_beg.
739                          */
740                         if ((flags & HAMMER_CURSOR_INSERT) == 0 &&
741                             hammer_btree_cmp(&cursor->key_beg,
742                                              &node->elms[i].base) >= 0
743                         ) {
744                                 cursor->index = i;
745                                 return(ENOENT);
746                         }
747
748                         /*
749                          * Correct a right-hand boundary mismatch.  The push
750                          * index is the last element (i-1).
751                          */
752                         if (hammer_btree_cmp(&node->elms[i].base,
753                                              cursor->right_bound) != 0) {
754                                 node->elms[i].base = *cursor->right_bound;
755                                 hammer_modify_node(cursor->node);
756                         }
757                         --i;
758                 } else {
759                         /*
760                          * The push-down index is now i - 1.
761                          */
762                         --i;
763                 }
764                 cursor->index = i;
765
766                 /*
767                  * Handle insertion and deletion requirements.
768                  *
769                  * If inserting split full nodes.  The split code will
770                  * adjust cursor->node and cursor->index if the current
771                  * index winds up in the new node.
772                  */
773                 if (flags & HAMMER_CURSOR_INSERT) {
774                         if (node->count == HAMMER_BTREE_INT_ELMS) {
775                                 error = btree_split_internal(cursor);
776                                 if (error) {
777                                         if (error != ENOSPC)
778                                                 goto done;
779                                         enospc = 1;
780                                         flags &= ~HAMMER_CURSOR_INSERT;
781                                 }
782                                 /*
783                                  * reload stale pointers
784                                  */
785                                 i = cursor->index;
786                                 node = cursor->node->ondisk;
787                         }
788                 }
789
790 #if 0
791                 /*
792                  * If deleting rebalance - do not allow the child to have
793                  * just one element or we will not be able to delete it.
794                  *
795                  * Neither internal or leaf nodes (except a root-leaf) are
796                  * allowed to drop to 0 elements.  (XXX - well, leaf nodes
797                  * can at the moment).
798                  *
799                  * Our separators may have been reorganized after rebalancing,
800                  * so we have to pop back up and rescan.
801                  *
802                  * XXX test for subtree_count < maxelms / 2, minus 1 or 2
803                  * for hysteresis?
804                  *
805                  * XXX NOTE: Iterations may not set this flag anyway.
806                  */
807                 if (flags & HAMMER_CURSOR_DELETE) {
808                         if (node->elms[i].internal.subtree_count <= 1) {
809                                 error = btree_rebalance(cursor);
810                                 if (error)
811                                         goto done;
812                                 /* cursor->index is invalid after call */
813                                 goto new_cluster;
814                         }
815                 }
816 #endif
817                 /*
818                  * Cluster pushes are done with internal elements.  If this
819                  * is a cluster push (rec_offset != 0), and INCLUSTER is set,
820                  * we stop here.
821                  *
822                  * However, because this is an internal node we have to
823                  * determine whether key_beg is within its range and return
824                  * 0 or ENOENT appropriately.
825                  */
826                 if ((flags & HAMMER_CURSOR_INCLUSTER) &&
827                     node->elms[i].internal.rec_offset) {
828                         r = hammer_btree_cmp(&cursor->key_beg,
829                                              &node->elms[i+1].base);
830                         error = (r < 0) ? 0 : (enospc ? ENOSPC : ENOENT);
831                         goto done;
832                 }
833
834                 /*
835                  * Push down (push into new node, existing node becomes
836                  * the parent) and continue the search.
837                  */
838                 error = hammer_cursor_down(cursor);
839                 /* node and cluster become stale */
840                 if (error)
841                         goto done;
842                 node = cursor->node->ondisk;
843                 cluster = cursor->node->cluster;
844         }
845
846         /*
847          * We are at a leaf, do a linear search of the key array.
848          *
849          * On success the index is set to the matching element and 0
850          * is returned.
851          *
852          * On failure the index is set to the insertion point and ENOENT
853          * is returned.
854          *
855          * Boundaries are not stored in leaf nodes, so the index can wind
856          * up to the left of element 0 (index == 0) or past the end of
857          * the array (index == node->count).
858          */
859         KKASSERT(node->count <= HAMMER_BTREE_LEAF_ELMS);
860
861         for (i = 0; i < node->count; ++i) {
862                 r = hammer_btree_cmp(&cursor->key_beg, &node->elms[i].base);
863
864                 /*
865                  * Stop if we've flipped past key_beg
866                  */
867                 if (r < 0)
868                         break;
869
870                 /*
871                  * Return an exact match
872                  */
873                 if (r == 0) {
874                         cursor->index = i;
875                         error = 0;
876                         goto done;
877                 }
878         }
879
880         /*
881          * No exact match was found, i is now at the insertion point.
882          *
883          * If inserting split a full leaf before returning.  This
884          * may have the side effect of adjusting cursor->node and
885          * cursor->index.
886          */
887         cursor->index = i;
888         if ((flags & HAMMER_CURSOR_INSERT) &&
889             node->count == HAMMER_BTREE_LEAF_ELMS) {
890                 error = btree_split_leaf(cursor);
891                 if (error) {
892                         if (error != ENOSPC)
893                                 goto done;
894                         enospc = 1;
895                         flags &= ~HAMMER_CURSOR_INSERT;
896                 }
897                 /*
898                  * reload stale pointers
899                  */
900                 /* NOT USED
901                 i = cursor->index;
902                 node = &cursor->node->internal;
903                 */
904         }
905
906         /*
907          * We reached a leaf but did not find the key we were looking for.
908          * If this is an insert we will be properly positioned for an insert
909          * (ENOENT) or spike (ENOSPC) operation.
910          */
911         error = enospc ? ENOSPC : ENOENT;
912 done:
913         return(error);
914 }
915
916
917 /************************************************************************
918  *                         SPLITTING AND MERGING                        *
919  ************************************************************************
920  *
921  * These routines do all the dirty work required to split and merge nodes.
922  */
923
924 /*
925  * Split an internal node into two nodes and move the separator at the split
926  * point to the parent.  Note that the parent's parent's element pointing
927  * to our parent will have an incorrect subtree_count (we don't update it).
928  * It will be low, which is ok.
929  *
930  * (cursor->node, cursor->index) indicates the element the caller intends
931  * to push into.  We will adjust node and index if that element winds
932  * up in the split node.
933  *
934  * If we are at the root of a cluster a new root must be created with two
935  * elements, one pointing to the original root and one pointing to the
936  * newly allocated split node.
937  *
938  * NOTE! Being at the root of a cluster is different from being at the
939  * root of the root cluster.  cursor->parent will not be NULL and
940  * cursor->node->ondisk.parent must be tested against 0.  Theoretically
941  * we could propogate the algorithm into the parent and deal with multiple
942  * 'roots' in the cluster header, but it's easier not to.
943  */
944 static
945 int
946 btree_split_internal(hammer_cursor_t cursor)
947 {
948         hammer_node_ondisk_t ondisk;
949         hammer_node_t node;
950         hammer_node_t parent;
951         hammer_node_t new_node;
952         hammer_btree_elm_t elm;
953         hammer_btree_elm_t parent_elm;
954         int parent_index;
955         int made_root;
956         int split;
957         int error;
958         int i;
959         const int esize = sizeof(*elm);
960
961         /* 
962          * We are splitting but elms[split] will be promoted to the parent,
963          * leaving the right hand node with one less element.  If the
964          * insertion point will be on the left-hand side adjust the split
965          * point to give the right hand side one additional node.
966          */
967         node = cursor->node;
968         ondisk = node->ondisk;
969         split = (ondisk->count + 1) / 2;
970         if (cursor->index <= split)
971                 --split;
972         error = 0;
973
974         /*
975          * If we are at the root of the cluster, create a new root node with
976          * 1 element and split normally.  Avoid making major modifications
977          * until we know the whole operation will work.
978          *
979          * The root of the cluster is different from the root of the root
980          * cluster.  Use the node's on-disk structure's parent offset to
981          * detect the case.
982          */
983         if (ondisk->parent == 0) {
984                 parent = hammer_alloc_btree(node->cluster, &error);
985                 if (parent == NULL)
986                         return(error);
987                 hammer_lock_ex(&parent->lock);
988                 ondisk = parent->ondisk;
989                 ondisk->count = 1;
990                 ondisk->parent = 0;
991                 ondisk->type = HAMMER_BTREE_TYPE_INTERNAL;
992                 ondisk->elms[0].base = node->cluster->clu_btree_beg;
993                 ondisk->elms[0].internal.subtree_type = node->ondisk->type;
994                 ondisk->elms[0].internal.subtree_offset = node->node_offset;
995                 ondisk->elms[1].base = node->cluster->clu_btree_end;
996                 made_root = 1;
997                 parent_index = 0;       /* index of current node in parent */
998         } else {
999                 made_root = 0;
1000                 parent = cursor->parent;
1001                 parent_index = cursor->parent_index;
1002                 KKASSERT(parent->cluster == node->cluster);
1003         }
1004
1005         /*
1006          * Split node into new_node at the split point.
1007          *
1008          *  B O O O P N N B     <-- P = node->elms[split]
1009          *   0 1 2 3 4 5 6      <-- subtree indices
1010          *
1011          *       x x P x x
1012          *        s S S s  
1013          *         /   \
1014          *  B O O O B    B N N B        <--- inner boundary points are 'P'
1015          *   0 1 2 3      4 5 6  
1016          *
1017          */
1018         new_node = hammer_alloc_btree(node->cluster, &error);
1019         if (new_node == NULL) {
1020                 if (made_root) {
1021                         hammer_unlock(&parent->lock);
1022                         hammer_free_btree(parent->cluster, parent->node_offset);
1023                         hammer_rel_node(parent);
1024                 }
1025                 return(error);
1026         }
1027         hammer_lock_ex(&new_node->lock);
1028
1029         /*
1030          * Create the new node.  P becomes the left-hand boundary in the
1031          * new node.  Copy the right-hand boundary as well.
1032          *
1033          * elm is the new separator.
1034          */
1035         ondisk = node->ondisk;
1036         elm = &ondisk->elms[split];
1037         bcopy(elm, &new_node->ondisk->elms[0],
1038               (ondisk->count - split + 1) * esize);
1039         new_node->ondisk->count = ondisk->count - split;
1040         new_node->ondisk->parent = parent->node_offset;
1041         new_node->ondisk->type = HAMMER_BTREE_TYPE_INTERNAL;
1042         KKASSERT(ondisk->type == new_node->ondisk->type);
1043
1044         /*
1045          * Cleanup the original node.  P becomes the new boundary, its
1046          * subtree_offset was moved to the new node.  If we had created
1047          * a new root its parent pointer may have changed.
1048          */
1049         elm->internal.subtree_offset = 0;
1050         ondisk->count = split;
1051
1052         /*
1053          * Insert the separator into the parent, fixup the parent's
1054          * reference to the original node, and reference the new node.
1055          * The separator is P.
1056          *
1057          * Remember that base.count does not include the right-hand boundary.
1058          */
1059         ondisk = parent->ondisk;
1060         KKASSERT(ondisk->count != HAMMER_BTREE_INT_ELMS);
1061         ondisk->elms[parent_index].internal.subtree_count = split;
1062         parent_elm = &ondisk->elms[parent_index+1];
1063         bcopy(parent_elm, parent_elm + 1,
1064               (ondisk->count - parent_index) * esize);
1065         parent_elm->internal.base = elm->base;  /* separator P */
1066         parent_elm->internal.subtree_offset = new_node->node_offset;
1067         parent_elm->internal.subtree_count = new_node->ondisk->count;
1068         parent_elm->internal.subtree_type = new_node->ondisk->type;
1069         ++ondisk->count;
1070
1071         /*
1072          * The children of new_node need their parent pointer set to new_node.
1073          */
1074         for (i = 0; i < new_node->ondisk->count; ++i) {
1075                 elm = &new_node->ondisk->elms[i];
1076                 error = btree_set_parent(new_node, elm);
1077                 if (error) {
1078                         panic("btree_split_internal: btree-fixup problem");
1079                 }
1080         }
1081
1082         /*
1083          * The cluster's root pointer may have to be updated.
1084          */
1085         if (made_root) {
1086                 node->cluster->ondisk->clu_btree_root = parent->node_offset;
1087                 hammer_modify_cluster(node->cluster);
1088                 node->ondisk->parent = parent->node_offset;
1089                 if (cursor->parent) {
1090                         hammer_unlock(&cursor->parent->lock);
1091                         hammer_rel_node(cursor->parent);
1092                 }
1093                 cursor->parent = parent;        /* lock'd and ref'd */
1094         }
1095
1096         hammer_modify_node(node);
1097         hammer_modify_node(new_node);
1098         hammer_modify_node(parent);
1099
1100         /*
1101          * Ok, now adjust the cursor depending on which element the original
1102          * index was pointing at.  If we are >= the split point the push node
1103          * is now in the new node.
1104          *
1105          * NOTE: If we are at the split point itself we cannot stay with the
1106          * original node because the push index will point at the right-hand
1107          * boundary, which is illegal.
1108          *
1109          * NOTE: The cursor's parent or parent_index must be adjusted for
1110          * the case where a new parent (new root) was created, and the case
1111          * where the cursor is now pointing at the split node.
1112          */
1113         if (cursor->index >= split) {
1114                 cursor->parent_index = parent_index + 1;
1115                 cursor->index -= split;
1116                 hammer_unlock(&cursor->node->lock);
1117                 hammer_rel_node(cursor->node);
1118                 cursor->node = new_node;        /* locked and ref'd */
1119         } else {
1120                 cursor->parent_index = parent_index;
1121                 hammer_unlock(&new_node->lock);
1122                 hammer_rel_node(new_node);
1123         }
1124
1125         /*
1126          * Fixup left and right bounds
1127          */
1128         parent_elm = &parent->ondisk->elms[cursor->parent_index];
1129         cursor->left_bound = &parent_elm[0].internal.base;
1130         cursor->right_bound = &parent_elm[1].internal.base;
1131
1132         return (0);
1133 }
1134
1135 /*
1136  * Same as the above, but splits a full leaf node.
1137  */
1138 static
1139 int
1140 btree_split_leaf(hammer_cursor_t cursor)
1141 {
1142         hammer_node_ondisk_t ondisk;
1143         hammer_node_t parent;
1144         hammer_node_t leaf;
1145         hammer_node_t new_leaf;
1146         hammer_btree_elm_t elm;
1147         hammer_btree_elm_t parent_elm;
1148         int parent_index;
1149         int made_root;
1150         int split;
1151         int error;
1152         const size_t esize = sizeof(*elm);
1153
1154         /* 
1155          * Calculate the split point.  If the insertion point will be on
1156          * the left-hand side adjust the split point to give the right
1157          * hand side one additional node.
1158          */
1159         leaf = cursor->node;
1160         ondisk = leaf->ondisk;
1161         split = (ondisk->count + 1) / 2;
1162         if (cursor->index <= split)
1163                 --split;
1164         error = 0;
1165
1166         /*
1167          * If we are at the root of the tree, create a new root node with
1168          * 1 element and split normally.  Avoid making major modifications
1169          * until we know the whole operation will work.
1170          */
1171         if (ondisk->parent == 0) {
1172                 parent = hammer_alloc_btree(leaf->cluster, &error);
1173                 if (parent == NULL)
1174                         return(error);
1175                 hammer_lock_ex(&parent->lock);
1176                 ondisk = parent->ondisk;
1177                 ondisk->count = 1;
1178                 ondisk->parent = 0;
1179                 ondisk->type = HAMMER_BTREE_TYPE_INTERNAL;
1180                 ondisk->elms[0].base = leaf->cluster->clu_btree_beg;
1181                 ondisk->elms[0].internal.subtree_type = leaf->ondisk->type;
1182                 ondisk->elms[0].internal.subtree_offset = leaf->node_offset;
1183                 ondisk->elms[1].base = leaf->cluster->clu_btree_end;
1184                 made_root = 1;
1185                 parent_index = 0;       /* insertion point in parent */
1186         } else {
1187                 made_root = 0;
1188                 parent = cursor->parent;
1189                 parent_index = cursor->parent_index;
1190                 KKASSERT(parent->cluster == leaf->cluster);
1191         }
1192
1193         /*
1194          * Split leaf into new_leaf at the split point.  Select a separator
1195          * value in-between the two leafs but with a bent towards the right
1196          * leaf since comparisons use an 'elm >= separator' inequality.
1197          *
1198          *  L L L L L L L L
1199          *
1200          *       x x P x x
1201          *        s S S s  
1202          *         /   \
1203          *  L L L L     L L L L
1204          */
1205         new_leaf = hammer_alloc_btree(leaf->cluster, &error);
1206         if (new_leaf == NULL) {
1207                 if (made_root) {
1208                         hammer_unlock(&parent->lock);
1209                         hammer_free_btree(parent->cluster, parent->node_offset);
1210                         hammer_rel_node(parent);
1211                 }
1212                 return(error);
1213         }
1214         hammer_lock_ex(&new_leaf->lock);
1215
1216         /*
1217          * Create the new node.  P become the left-hand boundary in the
1218          * new node.  Copy the right-hand boundary as well.
1219          */
1220         ondisk = leaf->ondisk;
1221         elm = &ondisk->elms[split];
1222         bcopy(elm, &new_leaf->ondisk->elms[0], (ondisk->count - split) * esize);
1223         new_leaf->ondisk->count = ondisk->count - split;
1224         new_leaf->ondisk->parent = parent->node_offset;
1225         new_leaf->ondisk->type = HAMMER_BTREE_TYPE_LEAF;
1226         KKASSERT(ondisk->type == new_leaf->ondisk->type);
1227
1228         /*
1229          * Cleanup the original node.  Because this is a leaf node and
1230          * leaf nodes do not have a right-hand boundary, there
1231          * aren't any special edge cases to clean up.  We just fixup the
1232          * count.
1233          */
1234         ondisk->count = split;
1235
1236         /*
1237          * Insert the separator into the parent, fixup the parent's
1238          * reference to the original node, and reference the new node.
1239          * The separator is P.
1240          *
1241          * Remember that base.count does not include the right-hand boundary.
1242          * We are copying parent_index+1 to parent_index+2, not +0 to +1.
1243          */
1244         ondisk = parent->ondisk;
1245         KKASSERT(ondisk->count != HAMMER_BTREE_INT_ELMS);
1246         ondisk->elms[parent_index].internal.subtree_count = split;
1247         parent_elm = &ondisk->elms[parent_index+1];
1248         bcopy(parent_elm, parent_elm + 1,
1249               (ondisk->count - parent_index) * esize);
1250         hammer_make_separator(&elm[-1].base, &elm[0].base, &parent_elm->base);
1251         parent_elm->internal.subtree_offset = new_leaf->node_offset;
1252         parent_elm->internal.subtree_count = new_leaf->ondisk->count;
1253         parent_elm->internal.subtree_type = new_leaf->ondisk->type;
1254         ++ondisk->count;
1255
1256         /*
1257          * The cluster's root pointer may have to be updated.
1258          */
1259         if (made_root) {
1260                 leaf->cluster->ondisk->clu_btree_root = parent->node_offset;
1261                 hammer_modify_cluster(leaf->cluster);
1262                 leaf->ondisk->parent = parent->node_offset;
1263                 if (cursor->parent) {
1264                         hammer_unlock(&cursor->parent->lock);
1265                         hammer_rel_node(cursor->parent);
1266                 }
1267                 cursor->parent = parent;        /* lock'd and ref'd */
1268         }
1269
1270         hammer_modify_node(leaf);
1271         hammer_modify_node(new_leaf);
1272         hammer_modify_node(parent);
1273
1274         /*
1275          * Ok, now adjust the cursor depending on which element the original
1276          * index was pointing at.  If we are >= the split point the push node
1277          * is now in the new node.
1278          *
1279          * NOTE: If we are at the split point itself we cannot stay with the
1280          * original node because the push index will point at the right-hand
1281          * boundary, which is illegal.
1282          */
1283         if (cursor->index >= split) {
1284                 cursor->parent_index = parent_index + 1;
1285                 cursor->index -= split;
1286                 hammer_unlock(&cursor->node->lock);
1287                 hammer_rel_node(cursor->node);
1288                 cursor->node = new_leaf;
1289         } else {
1290                 cursor->parent_index = parent_index;
1291                 hammer_unlock(&new_leaf->lock);
1292                 hammer_rel_node(new_leaf);
1293         }
1294
1295         /*
1296          * Fixup left and right bounds
1297          */
1298         parent_elm = &parent->ondisk->elms[cursor->parent_index];
1299         cursor->left_bound = &parent_elm[0].internal.base;
1300         cursor->right_bound = &parent_elm[1].internal.base;
1301
1302         return (0);
1303 }
1304
1305 /*
1306  * Attempt to remove the empty B-Tree node at (cursor->node).  Returns 0
1307  * on success, EAGAIN if we could not acquire the necessary locks, or some
1308  * other error.
1309  *
1310  * On return the cursor may end up pointing at an internal node, suitable
1311  * for further iteration but not for insertion or deletion.
1312  *
1313  * cursor->node may be an internal node or a leaf node.
1314  */
1315 int
1316 btree_remove(hammer_cursor_t cursor)
1317 {
1318         hammer_node_ondisk_t ondisk;
1319         hammer_btree_elm_t elm;
1320         hammer_node_t save;
1321         hammer_node_t node;
1322         hammer_node_t parent;
1323         int error;
1324         int i;
1325
1326         /*
1327          * If we are at the root of the root cluster there is nothing to
1328          * remove, but an internal node at the root of a cluster is not
1329          * allowed to be empty so convert it to a leaf node.
1330          */
1331         if (cursor->parent == NULL) {
1332                 ondisk = cursor->node->ondisk;
1333                 KKASSERT(ondisk->parent == 0);
1334                 ondisk->type = HAMMER_BTREE_TYPE_LEAF;
1335                 ondisk->count = 0;
1336                 hammer_modify_node(cursor->node);
1337                 kprintf("EMPTY ROOT OF ROOT CLUSTER -> LEAF\n");
1338                 return(0);
1339         }
1340
1341         /*
1342          * Retain a reference to cursor->node, ex-lock again (2 locks now)
1343          * so we do not lose the lock when we cursor around.
1344          */
1345         save = cursor->node;
1346         hammer_ref_node(save);
1347         hammer_lock_ex(&save->lock);
1348
1349         /*
1350          * We need to be able to lock the parent of the parent.  Do this
1351          * non-blocking and return EAGAIN if the lock cannot be acquired.
1352          * non-blocking is required in order to avoid a deadlock.
1353          *
1354          * After we cursor up, parent is moved to node and the new parent
1355          * is the parent of the parent.
1356          */
1357         error = hammer_cursor_up(cursor, 1);
1358         if (error) {
1359                 kprintf("BTREE_REMOVE: Cannot lock parent\n");
1360                 hammer_unlock(&save->lock);
1361                 hammer_rel_node(save);
1362                 return(error);
1363         }
1364
1365         /*
1366          * At this point we want to remove the element at (node, index),
1367          * which is now the (original) parent pointing to the saved node.
1368          * Removing the element allows us to then free the node it was
1369          * pointing to.
1370          *
1371          * However, an internal node is not allowed to have 0 elements, so
1372          * if the count would drop to 0 we have to recurse.  It is possible
1373          * for the recursion to fail.
1374          *
1375          * NOTE: The cursor is in an indeterminant position after recursing,
1376          * but will still be suitable for an iteration.
1377          */
1378         node = cursor->node;
1379         KKASSERT(node->ondisk->count > 0);
1380         if (node->ondisk->count == 1) {
1381                 error = btree_remove(cursor);
1382                 if (error == 0) {
1383                         kprintf("BTREE_REMOVE: Successful!\n");
1384                         hammer_flush_node(save);
1385                         hammer_free_btree(save->cluster, save->node_offset);
1386                 } else {
1387                         kprintf("BTREE_REMOVE: Recursion failed %d\n", error);
1388                 }
1389                 hammer_unlock(&save->lock);
1390                 hammer_rel_node(save);
1391                 return(error);
1392         }
1393
1394         /*
1395          * Remove the element at (node, index) and adjust the parent's
1396          * subtree_count.
1397          *
1398          * NOTE! If removing element 0 an internal node's left-hand boundary
1399          * will no longer match its parent.  If removing a mid-element the
1400          * boundary will no longer match a child's left hand or right hand
1401          * boundary.
1402          *
1403          *      BxBxBxB         remove a (x[0]): internal node's left-hand
1404          *       | | |                           boundary no longer matches
1405          *       a b c                           parent.
1406          *
1407          *                      remove b (x[1]): a's right hand boundary no
1408          *                                       longer matches parent.
1409          *
1410          *                      remove c (x[2]): b's right hand boundary no
1411          *                                       longer matches parent.
1412          *
1413          * These cases are corrected in btree_search().
1414          */
1415 #if 0
1416         kprintf("BTREE_REMOVE: Removing element %d\n", cursor->index);
1417 #endif
1418         ondisk = node->ondisk;
1419         i = cursor->index;
1420         bcopy(&ondisk->elms[i+1], &ondisk->elms[i],
1421               (ondisk->count - i) * sizeof(ondisk->elms[0]));
1422         --ondisk->count;
1423         hammer_modify_node(cursor->node);
1424
1425         /*
1426          * Adjust the parent-parent's (now parent) reference to the parent
1427          * (now node).
1428          */
1429         if ((parent = cursor->parent) != NULL) {
1430                 elm = &parent->ondisk->elms[cursor->parent_index];
1431                 if (elm->internal.subtree_count != ondisk->count) {
1432                         elm->internal.subtree_count = ondisk->count;
1433                         hammer_modify_node(parent);
1434                 }
1435                 if (elm->subtree_type != HAMMER_BTREE_TYPE_CLUSTER &&
1436                     elm->subtree_type != ondisk->type) {
1437                         elm->subtree_type = ondisk->type;
1438                         hammer_modify_node(parent);
1439                 }
1440         }
1441                 
1442         /*
1443          * Free the saved node.
1444          */
1445         hammer_flush_node(save);
1446         hammer_free_btree(save->cluster, save->node_offset);
1447         hammer_unlock(&save->lock);
1448         hammer_rel_node(save);
1449         return(0);
1450 }
1451
1452 /*
1453  * The child represented by the element in internal node node needs
1454  * to have its parent pointer adjusted.
1455  */
1456 static
1457 int
1458 btree_set_parent(hammer_node_t node, hammer_btree_elm_t elm)
1459 {
1460         hammer_volume_t volume;
1461         hammer_cluster_t cluster;
1462         hammer_node_t child;
1463         int error;
1464
1465         error = 0;
1466
1467         switch(elm->internal.subtree_type) {
1468         case HAMMER_BTREE_TYPE_LEAF:
1469         case HAMMER_BTREE_TYPE_INTERNAL:
1470                 child = hammer_get_node(node->cluster,
1471                                         elm->internal.subtree_offset, &error);
1472                 if (error == 0) {
1473                         hammer_lock_ex(&child->lock);
1474                         child->ondisk->parent = node->node_offset;
1475                         hammer_modify_node(child);
1476                         hammer_unlock(&child->lock);
1477                         hammer_rel_node(child);
1478                 }
1479                 break;
1480         case HAMMER_BTREE_TYPE_CLUSTER:
1481                 volume = hammer_get_volume(node->cluster->volume->hmp,
1482                                         elm->internal.subtree_vol_no, &error);
1483                 if (error)
1484                         break;
1485                 cluster = hammer_get_cluster(volume,
1486                                         elm->internal.subtree_clu_no,
1487                                         &error, 0);
1488                 hammer_rel_volume(volume, 0);
1489                 if (error)
1490                         break;
1491                 hammer_lock_ex(&cluster->io.lock);
1492                 cluster->ondisk->clu_btree_parent_offset = node->node_offset;
1493                 hammer_unlock(&cluster->io.lock);
1494                 KKASSERT(cluster->ondisk->clu_btree_parent_clu_no ==
1495                          node->cluster->clu_no);
1496                 KKASSERT(cluster->ondisk->clu_btree_parent_vol_no ==
1497                          node->cluster->volume->vol_no);
1498                 hammer_modify_cluster(cluster);
1499                 hammer_rel_cluster(cluster, 0);
1500                 break;
1501         default:
1502                 hammer_print_btree_elm(elm, HAMMER_BTREE_TYPE_INTERNAL, -1);
1503                 panic("btree_set_parent: bad subtree_type");
1504                 break; /* NOT REACHED */
1505         }
1506         return(error);
1507 }
1508
1509 #if 0
1510
1511 /*
1512  * This routine is called on the internal node (node) prior to recursing down
1513  * through (node, index) when the node referenced by (node, index) MIGHT
1514  * have too few elements for the caller to perform a deletion.
1515  *
1516  * cursor->index is invalid on return because the separators may have gotten
1517  * adjusted, the caller must rescan the node's elements.  The caller may set
1518  * cursor->index to -1 if it wants us to do a general rebalancing.
1519  *
1520  * This routine rebalances the children of the (node), collapsing children
1521  * together if possible.  On return each child will have at least L/2-1
1522  * elements unless the node only has one child.
1523  * 
1524  * NOTE: Because we do not update the parent's parent in the split code,
1525  * the subtree_count used by the caller may be incorrect.  We correct it
1526  * here.  Also note that we cannot change the depth of the tree's leaf
1527  * nodes here (see btree_collapse()).
1528  *
1529  * NOTE: We make no attempt to rebalance inter-cluster elements.
1530  */
1531 static
1532 int
1533 btree_rebalance(hammer_cursor_t cursor)
1534 {
1535         hammer_node_ondisk_t ondisk;
1536         hammer_node_t node;
1537         hammer_node_t children[HAMMER_BTREE_INT_ELMS];
1538         hammer_node_t child;
1539         hammer_btree_elm_t elm;
1540         hammer_btree_elm_t elms;
1541         int i, j, n, nelms, goal;
1542         int maxelms, halfelms;
1543         int error;
1544
1545         /*
1546          * If the elm being recursed through is an inter-cluster reference,
1547          * don't worry about it.
1548          */
1549         ondisk = cursor->node->ondisk;
1550         elm = &ondisk->elms[cursor->index];
1551         if (elm->internal.subtree_type == HAMMER_BTREE_TYPE_CLUSTER)
1552                 return(0);
1553
1554         KKASSERT(elm->internal.subtree_offset != 0);
1555         error = 0;
1556
1557         /*
1558          * Load the children of node and do any necessary corrections
1559          * to subtree_count.  subtree_count may be too low due to the
1560          * way insertions split nodes.  Get a count of the total number
1561          * of actual elements held by our children.
1562          */
1563         error = 0;
1564
1565         for (i = n = 0; i < node->base.count; ++i) {
1566                 struct hammer_btree_internal_elm *elm;
1567
1568                 elm = &node->elms[i];
1569                 children[i] = NULL;
1570                 child_buffer[i] = NULL; /* must be preinitialized for bread */
1571                 if (elm->subtree_offset == 0)
1572                         continue;
1573                 child = hammer_bread(cursor->cluster, elm->subtree_offset,
1574                                      HAMMER_FSBUF_BTREE, &error,
1575                                      &child_buffer[i], XXX);
1576                 children[i] = child;
1577                 if (child == NULL)
1578                         continue;
1579                 XXX
1580                 KKASSERT(node->base.subtype == child->base.type);
1581
1582                 /*
1583                  * Accumulate n for a good child, update the node's count
1584                  * if it was wrong.
1585                  */
1586                 if (node->elms[i].subtree_count != child->base.count) {
1587                         node->elms[i].subtree_count = child->base.count;
1588                 }
1589                 n += node->elms[i].subtree_count;
1590         }
1591         if (error)
1592                 goto failed;
1593
1594         /*
1595          * Collect all the children's elements together
1596          */
1597         nelms = n;
1598         elms = kmalloc(sizeof(*elms) * (nelms + 1), M_HAMMER, M_WAITOK|M_ZERO);
1599         for (i = n = 0; i < node->base.count; ++i) {
1600                 child = children[i];
1601                 for (j = 0; j < child->base.count; ++j) {
1602                         elms[n].owner = child;
1603                         if (node->base.subtype == HAMMER_BTREE_TYPE_LEAF)
1604                                 elms[n].u.leaf = child->leaf.elms[j];
1605                         else
1606                                 elms[n].u.internal = child->internal.elms[j];
1607                         ++n;
1608                 }
1609         }
1610         KKASSERT(n == nelms);
1611
1612         /*
1613          * Store a boundary in the elms array to ease the code below.  This
1614          * is only used if the children are internal nodes.
1615          */
1616         elms[n].u.internal = node->elms[i];
1617
1618         /*
1619          * Calculate the number of elements each child should have (goal) by
1620          * reducing the number of elements until we achieve at least
1621          * halfelms - 1 per child, unless we are a degenerate case.
1622          */
1623         maxelms = btree_max_elements(node->base.subtype);
1624         halfelms = maxelms / 2;
1625
1626         goal = halfelms - 1;
1627         while (i && n / i < goal)
1628                 --i;
1629
1630         /*
1631          * Now rebalance using the specified goal
1632          */
1633         for (i = n = 0; i < node->base.count; ++i) {
1634                 struct hammer_buffer *subchild_buffer = NULL;
1635                 struct hammer_btree_internal_node *subchild;
1636
1637                 child = children[i];
1638                 for (j = 0; j < goal && n < nelms; ++j) {
1639                         if (node->base.subtype == HAMMER_BTREE_TYPE_LEAF) {
1640                                 child->leaf.elms[j] = elms[n].u.leaf;
1641                         } else {
1642                                 child->internal.elms[j] = elms[n].u.internal;
1643                         }
1644
1645                         /*
1646                          * If the element's parent has changed we have to
1647                          * update the parent pointer.  This is somewhat
1648                          * expensive.
1649                          */
1650                         if (elms[n].owner != child &&
1651                             node->base.subtype == HAMMER_BTREE_TYPE_INTERNAL) {
1652                                 subchild = hammer_bread(cursor->cluster,
1653                                                         elms[n].u.internal.subtree_offset,
1654                                                         HAMMER_FSBUF_BTREE,
1655                                                         &error,
1656                                                         &subchild_buffer, XXX);
1657                                 if (subchild) {
1658                                         subchild->base.parent =
1659                                             hammer_bclu_offset(child_buffer[i],
1660                                                                 child);
1661                                         hammer_modify_buffer(subchild_buffer);
1662                                 }
1663                                 /* XXX error */
1664                         }
1665                         ++n;
1666                 }
1667                 /* 
1668                  * Set right boundary if the children are internal nodes.
1669                  */
1670                 if (node->base.subtype == HAMMER_BTREE_TYPE_INTERNAL)
1671                         child->internal.elms[j] = elms[n].u.internal;
1672                 child->base.count = j;
1673                 hammer_modify_buffer(child_buffer[i]);
1674                 if (subchild_buffer)
1675                         hammer_put_buffer(subchild_buffer, 0);
1676
1677                 /*
1678                  * If we have run out of elements, break out
1679                  */
1680                 if (n == nelms)
1681                         break;
1682         }
1683
1684         /*
1685          * Physically destroy any left-over children.  These children's
1686          * elements have been packed into prior children.  The node's
1687          * right hand boundary and count gets shifted to index i.
1688          *
1689          * The subtree count in the node's parent MUST be updated because
1690          * we are removing elements.  The subtree_count field is allowed to
1691          * be too small, but not too large!
1692          */
1693         if (i != node->base.count) {
1694                 n = i;
1695                 node->elms[n] = node->elms[node->base.count];
1696                 while (i < node->base.count) {
1697                         hammer_free_btree_ptr(child_buffer[i], children[i]);
1698                         hammer_put_buffer(child_buffer[i], 0);
1699                         ++i;
1700                 }
1701                 node->base.count = n;
1702                 if (cursor->parent) {
1703                         cursor->parent->elms[cursor->parent_index].subtree_count = n;
1704                         hammer_modify_buffer(cursor->parent_buffer);
1705                 }
1706         }
1707
1708         kfree(elms, M_HAMMER);
1709 failed:
1710         hammer_modify_buffer(cursor->node_buffer);
1711         for (i = 0; i < node->base.count; ++i) {
1712                 if (child_buffer[i])
1713                         hammer_put_buffer(child_buffer[i], 0);
1714         }
1715         return (error);
1716 }
1717
1718 /*
1719  * This routine is only called if the cursor is at the root node and the
1720  * root node is an internal node.  We attempt to collapse the root node
1721  * by replacing it with all of its children, reducing tree depth by one.
1722  *
1723  * This is the only way to reduce tree depth in a HAMMER filesystem.
1724  * Note that all leaf nodes are at the same depth.
1725  *
1726  * This is a fairly expensive operation because we not only have to load
1727  * the root's children, we also have to scan each child and adjust the
1728  * parent offset for each element in each child.  Nasty all around.
1729  */
1730 static
1731 int
1732 btree_collapse(hammer_cursor_t cursor)
1733 {
1734         hammer_btree_node_ondisk_t root, child;
1735         hammer_btree_node_ondisk_t children[HAMMER_BTREE_INT_ELMS];
1736         struct hammer_buffer *child_buffer[HAMMER_BTREE_INT_ELMS];
1737         int count;
1738         int i, j, n;
1739         int root_modified;
1740         int error;
1741         int32_t root_offset;
1742         u_int8_t subsubtype;
1743
1744         root = cursor->node;
1745         count = root->base.count;
1746         root_offset = hammer_bclu_offset(cursor->node_buffer, root);
1747
1748         /*
1749          * Sum up the number of children each element has.  This value is
1750          * only approximate due to the way the insertion node works.  It
1751          * may be too small but it will never be too large.
1752          *
1753          * Quickly terminate the collapse if the elements have too many
1754          * children.
1755          */
1756         KKASSERT(root->base.parent == 0);       /* must be root node */
1757         KKASSERT(root->base.type == HAMMER_BTREE_TYPE_INTERNAL);
1758         KKASSERT(count <= HAMMER_BTREE_INT_ELMS);
1759
1760         for (i = n = 0; i < count; ++i) {
1761                 n += root->internal.elms[i].subtree_count;
1762         }
1763         if (n > btree_max_elements(root->base.subtype))
1764                 return(0);
1765
1766         /*
1767          * Iterate through the elements again and correct the subtree_count.
1768          * Terminate the collapse if we wind up with too many.
1769          */
1770         error = 0;
1771         root_modified = 0;
1772
1773         for (i = n = 0; i < count; ++i) {
1774                 struct hammer_btree_internal_elm *elm;
1775
1776                 elm = &root->internal.elms[i];
1777                 child_buffer[i] = NULL;
1778                 children[i] = NULL;
1779                 if (elm->subtree_offset == 0)
1780                         continue;
1781                 child = hammer_bread(cursor->cluster, elm->subtree_offset,
1782                                      HAMMER_FSBUF_BTREE, &error,
1783                                      &child_buffer[i], XXX);
1784                 children[i] = child;
1785                 if (child == NULL)
1786                         continue;
1787                 KKASSERT(root->base.subtype == child->base.type);
1788
1789                 /*
1790                  * Accumulate n for a good child, update the root's count
1791                  * if it was wrong.
1792                  */
1793                 if (root->internal.elms[i].subtree_count != child->base.count) {
1794                         root->internal.elms[i].subtree_count = child->base.count;
1795                         root_modified = 1;
1796                 }
1797                 n += root->internal.elms[i].subtree_count;
1798         }
1799         if (error || n > btree_max_elements(root->base.subtype))
1800                 goto done;
1801
1802         /*
1803          * Ok, we can collapse the root.  If the root's children are leafs
1804          * the collapse is really simple.  If they are internal nodes the
1805          * collapse is not so simple because we have to fixup the parent
1806          * pointers for the root's children's children.
1807          *
1808          * When collapsing an internal node the far left and far right
1809          * element's boundaries should match the root's left and right
1810          * boundaries.
1811          */
1812         if (root->base.subtype == HAMMER_BTREE_TYPE_LEAF) {
1813                 for (i = n = 0; i < count; ++i) {
1814                         child = children[i];
1815                         for (j = 0; j < child->base.count; ++j) {
1816                                 root->leaf.elms[n] = child->leaf.elms[j];
1817                                 ++n;
1818                         }
1819                 }
1820                 root->base.type = root->base.subtype;
1821                 root->base.subtype = 0;
1822                 root->base.count = n;
1823                 root->leaf.link_left = 0;
1824                 root->leaf.link_right = 0;
1825         } else {
1826                 struct hammer_btree_internal_elm *elm;
1827                 struct hammer_btree_internal_node *subchild;
1828                 struct hammer_buffer *subchild_buffer = NULL;
1829
1830                 if (count) {
1831                         child = children[0];
1832                         subsubtype = child->base.subtype;
1833                         KKASSERT(child->base.count > 0);
1834                         KKASSERT(root->internal.elms[0].base.key ==
1835                                  child->internal.elms[0].base.key);
1836                         child = children[count-1];
1837                         KKASSERT(child->base.count > 0);
1838                         KKASSERT(root->internal.elms[count].base.key ==
1839                              child->internal.elms[child->base.count].base.key);
1840                 } else {
1841                         subsubtype = 0;
1842                 }
1843                 for (i = n = 0; i < count; ++i) {
1844                         child = children[i];
1845                         KKASSERT(child->base.subtype == subsubtype);
1846                         for (j = 0; j < child->base.count; ++j) {
1847                                 elm = &child->internal.elms[j];
1848
1849                                 root->internal.elms[n] = *elm;
1850                                 subchild = hammer_bread(cursor->cluster,
1851                                                         elm->subtree_offset,
1852                                                         HAMMER_FSBUF_BTREE,
1853                                                         &error,
1854                                                         &subchild_buffer,
1855                                                         XXX);
1856                                 if (subchild) {
1857                                         subchild->base.parent = root_offset;
1858                                         hammer_modify_buffer(subchild_buffer);
1859                                 }
1860                                 ++n;
1861                         }
1862                         /* make sure the right boundary is correct */
1863                         /* (this gets overwritten when the loop continues) */
1864                         /* XXX generate a new separator? */
1865                         root->internal.elms[n] = child->internal.elms[j];
1866                 }
1867                 root->base.type = HAMMER_BTREE_TYPE_INTERNAL;
1868                 root->base.subtype = subsubtype;
1869                 if (subchild_buffer)
1870                         hammer_put_buffer(subchild_buffer, 0);
1871         }
1872         root_modified = 1;
1873
1874         /*
1875          * Cleanup
1876          */
1877 done:
1878         if (root_modified)
1879                 hammer_modify_buffer(cursor->node_buffer);
1880         for (i = 0; i < count; ++i) {
1881                 if (child_buffer[i])
1882                         hammer_put_buffer(child_buffer[i], 0);
1883         }
1884         return(error);
1885 }
1886
1887 #endif
1888
1889 /************************************************************************
1890  *                         MISCELLANIOUS SUPPORT                        *
1891  ************************************************************************/
1892
1893 /*
1894  * Compare two B-Tree elements, return -N, 0, or +N (e.g. similar to strcmp).
1895  *
1896  * See also hammer_rec_rb_compare() and hammer_rec_cmp() in hammer_object.c.
1897  */
1898 int
1899 hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2)
1900 {
1901         if (key1->obj_id < key2->obj_id)
1902                 return(-4);
1903         if (key1->obj_id > key2->obj_id)
1904                 return(4);
1905
1906         if (key1->rec_type < key2->rec_type)
1907                 return(-3);
1908         if (key1->rec_type > key2->rec_type)
1909                 return(3);
1910
1911         if (key1->key < key2->key)
1912                 return(-2);
1913         if (key1->key > key2->key)
1914                 return(2);
1915         return(0);
1916 }
1917
1918 /*
1919  * Test a non-zero timestamp against an element to determine whether the
1920  * element is visible.
1921  */
1922 int
1923 hammer_btree_chkts(hammer_tid_t create_tid, hammer_base_elm_t base)
1924 {
1925         if (create_tid < base->create_tid)
1926                 return(-1);
1927         if (base->delete_tid && create_tid >= base->delete_tid)
1928                 return(1);
1929         return(0);
1930 }
1931
1932 /*
1933  * Create a separator half way inbetween key1 and key2.  For fields just
1934  * one unit apart, the separator will match key2.
1935  *
1936  * The handling of delete_tid is a little confusing.  It is only possible
1937  * to have one record in the B-Tree where all fields match except delete_tid.
1938  * This means, worse case, two adjacent elements may have a create_tid that
1939  * is one-apart and cause the separator to choose the right-hand element's
1940  * create_tid.  e.g.  (create,delete):  (1,x)(2,x) -> separator is (2,x).
1941  *
1942  * So all we have to do is set delete_tid to the right-hand element to
1943  * guarentee that the separator is properly between the two elements.
1944  */
1945 #define MAKE_SEPARATOR(key1, key2, dest, field) \
1946         dest->field = key1->field + ((key2->field - key1->field + 1) >> 1);
1947
1948 static void
1949 hammer_make_separator(hammer_base_elm_t key1, hammer_base_elm_t key2,
1950                       hammer_base_elm_t dest)
1951 {
1952         bzero(dest, sizeof(*dest));
1953         MAKE_SEPARATOR(key1, key2, dest, obj_id);
1954         MAKE_SEPARATOR(key1, key2, dest, rec_type);
1955         MAKE_SEPARATOR(key1, key2, dest, key);
1956         MAKE_SEPARATOR(key1, key2, dest, create_tid);
1957         dest->delete_tid = key2->delete_tid;
1958 }
1959
1960 #undef MAKE_SEPARATOR
1961
1962 /*
1963  * Return whether a generic internal or leaf node is full
1964  */
1965 static int
1966 btree_node_is_full(hammer_node_ondisk_t node)
1967 {
1968         switch(node->type) {
1969         case HAMMER_BTREE_TYPE_INTERNAL:
1970                 if (node->count == HAMMER_BTREE_INT_ELMS)
1971                         return(1);
1972                 break;
1973         case HAMMER_BTREE_TYPE_LEAF:
1974                 if (node->count == HAMMER_BTREE_LEAF_ELMS)
1975                         return(1);
1976                 break;
1977         default:
1978                 panic("illegal btree subtype");
1979         }
1980         return(0);
1981 }
1982
1983 #if 0
1984 static int
1985 btree_max_elements(u_int8_t type)
1986 {
1987         if (type == HAMMER_BTREE_TYPE_LEAF)
1988                 return(HAMMER_BTREE_LEAF_ELMS);
1989         if (type == HAMMER_BTREE_TYPE_INTERNAL)
1990                 return(HAMMER_BTREE_INT_ELMS);
1991         panic("btree_max_elements: bad type %d\n", type);
1992 }
1993 #endif
1994
1995 void
1996 hammer_print_btree_node(hammer_node_ondisk_t ondisk)
1997 {
1998         hammer_btree_elm_t elm;
1999         int i;
2000
2001         kprintf("node %p count=%d parent=%d type=%c\n",
2002                 ondisk, ondisk->count, ondisk->parent, ondisk->type);
2003
2004         /*
2005          * Dump both boundary elements if an internal node
2006          */
2007         if (ondisk->type == HAMMER_BTREE_TYPE_INTERNAL) {
2008                 for (i = 0; i <= ondisk->count; ++i) {
2009                         elm = &ondisk->elms[i];
2010                         hammer_print_btree_elm(elm, ondisk->type, i);
2011                 }
2012         } else {
2013                 for (i = 0; i < ondisk->count; ++i) {
2014                         elm = &ondisk->elms[i];
2015                         hammer_print_btree_elm(elm, ondisk->type, i);
2016                 }
2017         }
2018 }
2019
2020 void
2021 hammer_print_btree_elm(hammer_btree_elm_t elm, u_int8_t type, int i)
2022 {
2023         kprintf("  %2d", i);
2024         kprintf("\tobjid        = %016llx\n", elm->base.obj_id);
2025         kprintf("\tkey          = %016llx\n", elm->base.key);
2026         kprintf("\tcreate_tid   = %016llx\n", elm->base.create_tid);
2027         kprintf("\tdelete_tid   = %016llx\n", elm->base.delete_tid);
2028         kprintf("\trec_type     = %04x\n", elm->base.rec_type);
2029         kprintf("\tobj_type     = %02x\n", elm->base.obj_type);
2030         kprintf("\tsubtree_type = %02x\n", elm->subtree_type);
2031
2032         if (type == HAMMER_BTREE_TYPE_INTERNAL) {
2033                 if (elm->internal.rec_offset) {
2034                         kprintf("\tcluster_rec  = %08x\n",
2035                                 elm->internal.rec_offset);
2036                         kprintf("\tcluster_id   = %08x\n",
2037                                 elm->internal.subtree_clu_no);
2038                         kprintf("\tvolno        = %08x\n",
2039                                 elm->internal.subtree_vol_no);
2040                 } else {
2041                         kprintf("\tsubtree_off  = %08x\n",
2042                                 elm->internal.subtree_offset);
2043                 }
2044                 kprintf("\tsubtree_count= %d\n", elm->internal.subtree_count);
2045         } else {
2046                 kprintf("\trec_offset   = %08x\n", elm->leaf.rec_offset);
2047                 kprintf("\tdata_offset  = %08x\n", elm->leaf.data_offset);
2048                 kprintf("\tdata_len     = %08x\n", elm->leaf.data_len);
2049                 kprintf("\tdata_crc     = %08x\n", elm->leaf.data_crc);
2050         }
2051 }