1*0a6a1f1dSLionel Sambuc /* $NetBSD: rb.c,v 1.13 2014/08/22 17:19:48 matt Exp $ */
2b6cbf720SGianluca Guida
3b6cbf720SGianluca Guida /*-
4b6cbf720SGianluca Guida * Copyright (c) 2001 The NetBSD Foundation, Inc.
5b6cbf720SGianluca Guida * All rights reserved.
6b6cbf720SGianluca Guida *
7b6cbf720SGianluca Guida * This code is derived from software contributed to The NetBSD Foundation
8b6cbf720SGianluca Guida * by Matt Thomas <matt@3am-software.com>.
9b6cbf720SGianluca Guida *
10b6cbf720SGianluca Guida * Redistribution and use in source and binary forms, with or without
11b6cbf720SGianluca Guida * modification, are permitted provided that the following conditions
12b6cbf720SGianluca Guida * are met:
13b6cbf720SGianluca Guida * 1. Redistributions of source code must retain the above copyright
14b6cbf720SGianluca Guida * notice, this list of conditions and the following disclaimer.
15b6cbf720SGianluca Guida * 2. Redistributions in binary form must reproduce the above copyright
16b6cbf720SGianluca Guida * notice, this list of conditions and the following disclaimer in the
17b6cbf720SGianluca Guida * documentation and/or other materials provided with the distribution.
18b6cbf720SGianluca Guida *
19b6cbf720SGianluca Guida * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20b6cbf720SGianluca Guida * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21b6cbf720SGianluca Guida * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22b6cbf720SGianluca Guida * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23b6cbf720SGianluca Guida * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24b6cbf720SGianluca Guida * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25b6cbf720SGianluca Guida * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26b6cbf720SGianluca Guida * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27b6cbf720SGianluca Guida * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28b6cbf720SGianluca Guida * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29b6cbf720SGianluca Guida * POSSIBILITY OF SUCH DAMAGE.
30b6cbf720SGianluca Guida */
31b6cbf720SGianluca Guida
32b6cbf720SGianluca Guida #if !defined(_KERNEL) && !defined(_STANDALONE)
33b6cbf720SGianluca Guida #include <sys/types.h>
34b6cbf720SGianluca Guida #include <stddef.h>
35b6cbf720SGianluca Guida #include <assert.h>
36b6cbf720SGianluca Guida #include <stdbool.h>
37b6cbf720SGianluca Guida #ifdef RBDEBUG
38b6cbf720SGianluca Guida #define KASSERT(s) assert(s)
39b6cbf720SGianluca Guida #else
40b6cbf720SGianluca Guida #define KASSERT(s) do { } while (/*CONSTCOND*/ 0)
41b6cbf720SGianluca Guida #endif
42*0a6a1f1dSLionel Sambuc __RCSID("$NetBSD: rb.c,v 1.13 2014/08/22 17:19:48 matt Exp $");
43b6cbf720SGianluca Guida #else
44b6cbf720SGianluca Guida #include <lib/libkern/libkern.h>
45*0a6a1f1dSLionel Sambuc __KERNEL_RCSID(0, "$NetBSD: rb.c,v 1.13 2014/08/22 17:19:48 matt Exp $");
46b6cbf720SGianluca Guida #endif
47b6cbf720SGianluca Guida
48b6cbf720SGianluca Guida #ifdef _LIBC
49b6cbf720SGianluca Guida __weak_alias(rb_tree_init, _rb_tree_init)
50b6cbf720SGianluca Guida __weak_alias(rb_tree_find_node, _rb_tree_find_node)
51b6cbf720SGianluca Guida __weak_alias(rb_tree_find_node_geq, _rb_tree_find_node_geq)
52b6cbf720SGianluca Guida __weak_alias(rb_tree_find_node_leq, _rb_tree_find_node_leq)
53b6cbf720SGianluca Guida __weak_alias(rb_tree_insert_node, _rb_tree_insert_node)
54b6cbf720SGianluca Guida __weak_alias(rb_tree_remove_node, _rb_tree_remove_node)
55b6cbf720SGianluca Guida __weak_alias(rb_tree_iterate, _rb_tree_iterate)
56b6cbf720SGianluca Guida #ifdef RBDEBUG
57b6cbf720SGianluca Guida __weak_alias(rb_tree_check, _rb_tree_check)
58b6cbf720SGianluca Guida __weak_alias(rb_tree_depths, _rb_tree_depths)
59b6cbf720SGianluca Guida #endif
60b6cbf720SGianluca Guida
61b6cbf720SGianluca Guida #include "namespace.h"
62b6cbf720SGianluca Guida #endif
63b6cbf720SGianluca Guida
64b6cbf720SGianluca Guida #ifdef RBTEST
65b6cbf720SGianluca Guida #include "rbtree.h"
66b6cbf720SGianluca Guida #else
67b6cbf720SGianluca Guida #include <sys/rbtree.h>
68b6cbf720SGianluca Guida #endif
69b6cbf720SGianluca Guida
70b6cbf720SGianluca Guida static void rb_tree_insert_rebalance(struct rb_tree *, struct rb_node *);
71b6cbf720SGianluca Guida static void rb_tree_removal_rebalance(struct rb_tree *, struct rb_node *,
72b6cbf720SGianluca Guida unsigned int);
73b6cbf720SGianluca Guida #ifdef RBDEBUG
74b6cbf720SGianluca Guida static const struct rb_node *rb_tree_iterate_const(const struct rb_tree *,
75b6cbf720SGianluca Guida const struct rb_node *, const unsigned int);
76b6cbf720SGianluca Guida static bool rb_tree_check_node(const struct rb_tree *, const struct rb_node *,
77b6cbf720SGianluca Guida const struct rb_node *, bool);
78b6cbf720SGianluca Guida #else
79b6cbf720SGianluca Guida #define rb_tree_check_node(a, b, c, d) true
80b6cbf720SGianluca Guida #endif
81b6cbf720SGianluca Guida
82b6cbf720SGianluca Guida #define RB_NODETOITEM(rbto, rbn) \
83b6cbf720SGianluca Guida ((void *)((uintptr_t)(rbn) - (rbto)->rbto_node_offset))
84b6cbf720SGianluca Guida #define RB_ITEMTONODE(rbto, rbn) \
85b6cbf720SGianluca Guida ((rb_node_t *)((uintptr_t)(rbn) + (rbto)->rbto_node_offset))
86b6cbf720SGianluca Guida
87b6cbf720SGianluca Guida #define RB_SENTINEL_NODE NULL
88b6cbf720SGianluca Guida
89b6cbf720SGianluca Guida void
rb_tree_init(struct rb_tree * rbt,const rb_tree_ops_t * ops)90b6cbf720SGianluca Guida rb_tree_init(struct rb_tree *rbt, const rb_tree_ops_t *ops)
91b6cbf720SGianluca Guida {
92b6cbf720SGianluca Guida
93b6cbf720SGianluca Guida rbt->rbt_ops = ops;
94f14fb602SLionel Sambuc rbt->rbt_root = RB_SENTINEL_NODE;
95b6cbf720SGianluca Guida RB_TAILQ_INIT(&rbt->rbt_nodes);
96b6cbf720SGianluca Guida #ifndef RBSMALL
97b6cbf720SGianluca Guida rbt->rbt_minmax[RB_DIR_LEFT] = rbt->rbt_root; /* minimum node */
98b6cbf720SGianluca Guida rbt->rbt_minmax[RB_DIR_RIGHT] = rbt->rbt_root; /* maximum node */
99b6cbf720SGianluca Guida #endif
100b6cbf720SGianluca Guida #ifdef RBSTATS
101b6cbf720SGianluca Guida rbt->rbt_count = 0;
102b6cbf720SGianluca Guida rbt->rbt_insertions = 0;
103b6cbf720SGianluca Guida rbt->rbt_removals = 0;
104b6cbf720SGianluca Guida rbt->rbt_insertion_rebalance_calls = 0;
105b6cbf720SGianluca Guida rbt->rbt_insertion_rebalance_passes = 0;
106b6cbf720SGianluca Guida rbt->rbt_removal_rebalance_calls = 0;
107b6cbf720SGianluca Guida rbt->rbt_removal_rebalance_passes = 0;
108b6cbf720SGianluca Guida #endif
109b6cbf720SGianluca Guida }
110b6cbf720SGianluca Guida
111b6cbf720SGianluca Guida void *
rb_tree_find_node(struct rb_tree * rbt,const void * key)112b6cbf720SGianluca Guida rb_tree_find_node(struct rb_tree *rbt, const void *key)
113b6cbf720SGianluca Guida {
114b6cbf720SGianluca Guida const rb_tree_ops_t *rbto = rbt->rbt_ops;
115b6cbf720SGianluca Guida rbto_compare_key_fn compare_key = rbto->rbto_compare_key;
116b6cbf720SGianluca Guida struct rb_node *parent = rbt->rbt_root;
117b6cbf720SGianluca Guida
118b6cbf720SGianluca Guida while (!RB_SENTINEL_P(parent)) {
119b6cbf720SGianluca Guida void *pobj = RB_NODETOITEM(rbto, parent);
120b6cbf720SGianluca Guida const signed int diff = (*compare_key)(rbto->rbto_context,
121b6cbf720SGianluca Guida pobj, key);
122b6cbf720SGianluca Guida if (diff == 0)
123b6cbf720SGianluca Guida return pobj;
124b6cbf720SGianluca Guida parent = parent->rb_nodes[diff < 0];
125b6cbf720SGianluca Guida }
126b6cbf720SGianluca Guida
127b6cbf720SGianluca Guida return NULL;
128b6cbf720SGianluca Guida }
129b6cbf720SGianluca Guida
130b6cbf720SGianluca Guida void *
rb_tree_find_node_geq(struct rb_tree * rbt,const void * key)131b6cbf720SGianluca Guida rb_tree_find_node_geq(struct rb_tree *rbt, const void *key)
132b6cbf720SGianluca Guida {
133b6cbf720SGianluca Guida const rb_tree_ops_t *rbto = rbt->rbt_ops;
134b6cbf720SGianluca Guida rbto_compare_key_fn compare_key = rbto->rbto_compare_key;
135b6cbf720SGianluca Guida struct rb_node *parent = rbt->rbt_root, *last = NULL;
136b6cbf720SGianluca Guida
137b6cbf720SGianluca Guida while (!RB_SENTINEL_P(parent)) {
138b6cbf720SGianluca Guida void *pobj = RB_NODETOITEM(rbto, parent);
139b6cbf720SGianluca Guida const signed int diff = (*compare_key)(rbto->rbto_context,
140b6cbf720SGianluca Guida pobj, key);
141b6cbf720SGianluca Guida if (diff == 0)
142b6cbf720SGianluca Guida return pobj;
143b6cbf720SGianluca Guida if (diff > 0)
144b6cbf720SGianluca Guida last = parent;
145b6cbf720SGianluca Guida parent = parent->rb_nodes[diff < 0];
146b6cbf720SGianluca Guida }
147b6cbf720SGianluca Guida
148*0a6a1f1dSLionel Sambuc return last == NULL ? NULL : RB_NODETOITEM(rbto, last);
149b6cbf720SGianluca Guida }
150b6cbf720SGianluca Guida
151b6cbf720SGianluca Guida void *
rb_tree_find_node_leq(struct rb_tree * rbt,const void * key)152b6cbf720SGianluca Guida rb_tree_find_node_leq(struct rb_tree *rbt, const void *key)
153b6cbf720SGianluca Guida {
154b6cbf720SGianluca Guida const rb_tree_ops_t *rbto = rbt->rbt_ops;
155b6cbf720SGianluca Guida rbto_compare_key_fn compare_key = rbto->rbto_compare_key;
156b6cbf720SGianluca Guida struct rb_node *parent = rbt->rbt_root, *last = NULL;
157b6cbf720SGianluca Guida
158b6cbf720SGianluca Guida while (!RB_SENTINEL_P(parent)) {
159b6cbf720SGianluca Guida void *pobj = RB_NODETOITEM(rbto, parent);
160b6cbf720SGianluca Guida const signed int diff = (*compare_key)(rbto->rbto_context,
161b6cbf720SGianluca Guida pobj, key);
162b6cbf720SGianluca Guida if (diff == 0)
163b6cbf720SGianluca Guida return pobj;
164b6cbf720SGianluca Guida if (diff < 0)
165b6cbf720SGianluca Guida last = parent;
166b6cbf720SGianluca Guida parent = parent->rb_nodes[diff < 0];
167b6cbf720SGianluca Guida }
168b6cbf720SGianluca Guida
169*0a6a1f1dSLionel Sambuc return last == NULL ? NULL : RB_NODETOITEM(rbto, last);
170b6cbf720SGianluca Guida }
171b6cbf720SGianluca Guida
172b6cbf720SGianluca Guida void *
rb_tree_insert_node(struct rb_tree * rbt,void * object)173b6cbf720SGianluca Guida rb_tree_insert_node(struct rb_tree *rbt, void *object)
174b6cbf720SGianluca Guida {
175b6cbf720SGianluca Guida const rb_tree_ops_t *rbto = rbt->rbt_ops;
176b6cbf720SGianluca Guida rbto_compare_nodes_fn compare_nodes = rbto->rbto_compare_nodes;
177b6cbf720SGianluca Guida struct rb_node *parent, *tmp, *self = RB_ITEMTONODE(rbto, object);
178b6cbf720SGianluca Guida unsigned int position;
179b6cbf720SGianluca Guida bool rebalance;
180b6cbf720SGianluca Guida
181b6cbf720SGianluca Guida RBSTAT_INC(rbt->rbt_insertions);
182b6cbf720SGianluca Guida
183b6cbf720SGianluca Guida tmp = rbt->rbt_root;
184b6cbf720SGianluca Guida /*
185b6cbf720SGianluca Guida * This is a hack. Because rbt->rbt_root is just a struct rb_node *,
186b6cbf720SGianluca Guida * just like rb_node->rb_nodes[RB_DIR_LEFT], we can use this fact to
187b6cbf720SGianluca Guida * avoid a lot of tests for root and know that even at root,
188b6cbf720SGianluca Guida * updating RB_FATHER(rb_node)->rb_nodes[RB_POSITION(rb_node)] will
189b6cbf720SGianluca Guida * update rbt->rbt_root.
190b6cbf720SGianluca Guida */
191b6cbf720SGianluca Guida parent = (struct rb_node *)(void *)&rbt->rbt_root;
192b6cbf720SGianluca Guida position = RB_DIR_LEFT;
193b6cbf720SGianluca Guida
194b6cbf720SGianluca Guida /*
195b6cbf720SGianluca Guida * Find out where to place this new leaf.
196b6cbf720SGianluca Guida */
197b6cbf720SGianluca Guida while (!RB_SENTINEL_P(tmp)) {
198b6cbf720SGianluca Guida void *tobj = RB_NODETOITEM(rbto, tmp);
199b6cbf720SGianluca Guida const signed int diff = (*compare_nodes)(rbto->rbto_context,
200b6cbf720SGianluca Guida tobj, object);
201b6cbf720SGianluca Guida if (__predict_false(diff == 0)) {
202b6cbf720SGianluca Guida /*
203b6cbf720SGianluca Guida * Node already exists; return it.
204b6cbf720SGianluca Guida */
205b6cbf720SGianluca Guida return tobj;
206b6cbf720SGianluca Guida }
207b6cbf720SGianluca Guida parent = tmp;
208b6cbf720SGianluca Guida position = (diff < 0);
209b6cbf720SGianluca Guida tmp = parent->rb_nodes[position];
210b6cbf720SGianluca Guida }
211b6cbf720SGianluca Guida
212b6cbf720SGianluca Guida #ifdef RBDEBUG
213b6cbf720SGianluca Guida {
214b6cbf720SGianluca Guida struct rb_node *prev = NULL, *next = NULL;
215b6cbf720SGianluca Guida
216b6cbf720SGianluca Guida if (position == RB_DIR_RIGHT)
217b6cbf720SGianluca Guida prev = parent;
218b6cbf720SGianluca Guida else if (tmp != rbt->rbt_root)
219b6cbf720SGianluca Guida next = parent;
220b6cbf720SGianluca Guida
221b6cbf720SGianluca Guida /*
222b6cbf720SGianluca Guida * Verify our sequential position
223b6cbf720SGianluca Guida */
224b6cbf720SGianluca Guida KASSERT(prev == NULL || !RB_SENTINEL_P(prev));
225b6cbf720SGianluca Guida KASSERT(next == NULL || !RB_SENTINEL_P(next));
226b6cbf720SGianluca Guida if (prev != NULL && next == NULL)
227b6cbf720SGianluca Guida next = TAILQ_NEXT(prev, rb_link);
228b6cbf720SGianluca Guida if (prev == NULL && next != NULL)
229b6cbf720SGianluca Guida prev = TAILQ_PREV(next, rb_node_qh, rb_link);
230b6cbf720SGianluca Guida KASSERT(prev == NULL || !RB_SENTINEL_P(prev));
231b6cbf720SGianluca Guida KASSERT(next == NULL || !RB_SENTINEL_P(next));
232b6cbf720SGianluca Guida KASSERT(prev == NULL || (*compare_nodes)(rbto->rbto_context,
233b6cbf720SGianluca Guida RB_NODETOITEM(rbto, prev), RB_NODETOITEM(rbto, self)) < 0);
234b6cbf720SGianluca Guida KASSERT(next == NULL || (*compare_nodes)(rbto->rbto_context,
235b6cbf720SGianluca Guida RB_NODETOITEM(rbto, self), RB_NODETOITEM(rbto, next)) < 0);
236b6cbf720SGianluca Guida }
237b6cbf720SGianluca Guida #endif
238b6cbf720SGianluca Guida
239b6cbf720SGianluca Guida /*
240b6cbf720SGianluca Guida * Initialize the node and insert as a leaf into the tree.
241b6cbf720SGianluca Guida */
242b6cbf720SGianluca Guida RB_SET_FATHER(self, parent);
243b6cbf720SGianluca Guida RB_SET_POSITION(self, position);
244b6cbf720SGianluca Guida if (__predict_false(parent == (struct rb_node *)(void *)&rbt->rbt_root)) {
245b6cbf720SGianluca Guida RB_MARK_BLACK(self); /* root is always black */
246b6cbf720SGianluca Guida #ifndef RBSMALL
247b6cbf720SGianluca Guida rbt->rbt_minmax[RB_DIR_LEFT] = self;
248b6cbf720SGianluca Guida rbt->rbt_minmax[RB_DIR_RIGHT] = self;
249b6cbf720SGianluca Guida #endif
250b6cbf720SGianluca Guida rebalance = false;
251b6cbf720SGianluca Guida } else {
252b6cbf720SGianluca Guida KASSERT(position == RB_DIR_LEFT || position == RB_DIR_RIGHT);
253b6cbf720SGianluca Guida #ifndef RBSMALL
254b6cbf720SGianluca Guida /*
255b6cbf720SGianluca Guida * Keep track of the minimum and maximum nodes. If our
256b6cbf720SGianluca Guida * parent is a minmax node and we on their min/max side,
257b6cbf720SGianluca Guida * we must be the new min/max node.
258b6cbf720SGianluca Guida */
259b6cbf720SGianluca Guida if (parent == rbt->rbt_minmax[position])
260b6cbf720SGianluca Guida rbt->rbt_minmax[position] = self;
261b6cbf720SGianluca Guida #endif /* !RBSMALL */
262b6cbf720SGianluca Guida /*
263b6cbf720SGianluca Guida * All new nodes are colored red. We only need to rebalance
264b6cbf720SGianluca Guida * if our parent is also red.
265b6cbf720SGianluca Guida */
266b6cbf720SGianluca Guida RB_MARK_RED(self);
267b6cbf720SGianluca Guida rebalance = RB_RED_P(parent);
268b6cbf720SGianluca Guida }
269b6cbf720SGianluca Guida KASSERT(RB_SENTINEL_P(parent->rb_nodes[position]));
270b6cbf720SGianluca Guida self->rb_left = parent->rb_nodes[position];
271b6cbf720SGianluca Guida self->rb_right = parent->rb_nodes[position];
272b6cbf720SGianluca Guida parent->rb_nodes[position] = self;
273b6cbf720SGianluca Guida KASSERT(RB_CHILDLESS_P(self));
274b6cbf720SGianluca Guida
275b6cbf720SGianluca Guida /*
276b6cbf720SGianluca Guida * Insert the new node into a sorted list for easy sequential access
277b6cbf720SGianluca Guida */
278b6cbf720SGianluca Guida RBSTAT_INC(rbt->rbt_count);
279b6cbf720SGianluca Guida #ifdef RBDEBUG
280b6cbf720SGianluca Guida if (RB_ROOT_P(rbt, self)) {
281b6cbf720SGianluca Guida RB_TAILQ_INSERT_HEAD(&rbt->rbt_nodes, self, rb_link);
282b6cbf720SGianluca Guida } else if (position == RB_DIR_LEFT) {
283b6cbf720SGianluca Guida KASSERT((*compare_nodes)(rbto->rbto_context,
284b6cbf720SGianluca Guida RB_NODETOITEM(rbto, self),
285b6cbf720SGianluca Guida RB_NODETOITEM(rbto, RB_FATHER(self))) < 0);
286b6cbf720SGianluca Guida RB_TAILQ_INSERT_BEFORE(RB_FATHER(self), self, rb_link);
287b6cbf720SGianluca Guida } else {
288b6cbf720SGianluca Guida KASSERT((*compare_nodes)(rbto->rbto_context,
289b6cbf720SGianluca Guida RB_NODETOITEM(rbto, RB_FATHER(self)),
290b6cbf720SGianluca Guida RB_NODETOITEM(rbto, self)) < 0);
291b6cbf720SGianluca Guida RB_TAILQ_INSERT_AFTER(&rbt->rbt_nodes, RB_FATHER(self),
292b6cbf720SGianluca Guida self, rb_link);
293b6cbf720SGianluca Guida }
294b6cbf720SGianluca Guida #endif
295b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, self, NULL, !rebalance));
296b6cbf720SGianluca Guida
297b6cbf720SGianluca Guida /*
298b6cbf720SGianluca Guida * Rebalance tree after insertion
299b6cbf720SGianluca Guida */
300b6cbf720SGianluca Guida if (rebalance) {
301b6cbf720SGianluca Guida rb_tree_insert_rebalance(rbt, self);
302b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, self, NULL, true));
303b6cbf720SGianluca Guida }
304b6cbf720SGianluca Guida
305b6cbf720SGianluca Guida /* Succesfully inserted, return our node pointer. */
306b6cbf720SGianluca Guida return object;
307b6cbf720SGianluca Guida }
308b6cbf720SGianluca Guida
309b6cbf720SGianluca Guida /*
310b6cbf720SGianluca Guida * Swap the location and colors of 'self' and its child @ which. The child
311b6cbf720SGianluca Guida * can not be a sentinel node. This is our rotation function. However,
312b6cbf720SGianluca Guida * since it preserves coloring, it great simplifies both insertion and
313b6cbf720SGianluca Guida * removal since rotation almost always involves the exchanging of colors
314b6cbf720SGianluca Guida * as a separate step.
315b6cbf720SGianluca Guida */
316b6cbf720SGianluca Guida /*ARGSUSED*/
317b6cbf720SGianluca Guida static void
rb_tree_reparent_nodes(struct rb_tree * rbt,struct rb_node * old_father,const unsigned int which)318b6cbf720SGianluca Guida rb_tree_reparent_nodes(struct rb_tree *rbt, struct rb_node *old_father,
319b6cbf720SGianluca Guida const unsigned int which)
320b6cbf720SGianluca Guida {
321b6cbf720SGianluca Guida const unsigned int other = which ^ RB_DIR_OTHER;
322b6cbf720SGianluca Guida struct rb_node * const grandpa = RB_FATHER(old_father);
323b6cbf720SGianluca Guida struct rb_node * const old_child = old_father->rb_nodes[which];
324b6cbf720SGianluca Guida struct rb_node * const new_father = old_child;
325b6cbf720SGianluca Guida struct rb_node * const new_child = old_father;
326b6cbf720SGianluca Guida
327b6cbf720SGianluca Guida KASSERT(which == RB_DIR_LEFT || which == RB_DIR_RIGHT);
328b6cbf720SGianluca Guida
329b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(old_child));
330b6cbf720SGianluca Guida KASSERT(RB_FATHER(old_child) == old_father);
331b6cbf720SGianluca Guida
332b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, old_father, NULL, false));
333b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, old_child, NULL, false));
334b6cbf720SGianluca Guida KASSERT(RB_ROOT_P(rbt, old_father) ||
335b6cbf720SGianluca Guida rb_tree_check_node(rbt, grandpa, NULL, false));
336b6cbf720SGianluca Guida
337b6cbf720SGianluca Guida /*
338b6cbf720SGianluca Guida * Exchange descendant linkages.
339b6cbf720SGianluca Guida */
340b6cbf720SGianluca Guida grandpa->rb_nodes[RB_POSITION(old_father)] = new_father;
341b6cbf720SGianluca Guida new_child->rb_nodes[which] = old_child->rb_nodes[other];
342b6cbf720SGianluca Guida new_father->rb_nodes[other] = new_child;
343b6cbf720SGianluca Guida
344b6cbf720SGianluca Guida /*
345b6cbf720SGianluca Guida * Update ancestor linkages
346b6cbf720SGianluca Guida */
347b6cbf720SGianluca Guida RB_SET_FATHER(new_father, grandpa);
348b6cbf720SGianluca Guida RB_SET_FATHER(new_child, new_father);
349b6cbf720SGianluca Guida
350b6cbf720SGianluca Guida /*
351b6cbf720SGianluca Guida * Exchange properties between new_father and new_child. The only
352b6cbf720SGianluca Guida * change is that new_child's position is now on the other side.
353b6cbf720SGianluca Guida */
354b6cbf720SGianluca Guida #if 0
355b6cbf720SGianluca Guida {
356b6cbf720SGianluca Guida struct rb_node tmp;
357b6cbf720SGianluca Guida tmp.rb_info = 0;
358b6cbf720SGianluca Guida RB_COPY_PROPERTIES(&tmp, old_child);
359b6cbf720SGianluca Guida RB_COPY_PROPERTIES(new_father, old_father);
360b6cbf720SGianluca Guida RB_COPY_PROPERTIES(new_child, &tmp);
361b6cbf720SGianluca Guida }
362b6cbf720SGianluca Guida #else
363b6cbf720SGianluca Guida RB_SWAP_PROPERTIES(new_father, new_child);
364b6cbf720SGianluca Guida #endif
365b6cbf720SGianluca Guida RB_SET_POSITION(new_child, other);
366b6cbf720SGianluca Guida
367b6cbf720SGianluca Guida /*
368b6cbf720SGianluca Guida * Make sure to reparent the new child to ourself.
369b6cbf720SGianluca Guida */
370b6cbf720SGianluca Guida if (!RB_SENTINEL_P(new_child->rb_nodes[which])) {
371b6cbf720SGianluca Guida RB_SET_FATHER(new_child->rb_nodes[which], new_child);
372b6cbf720SGianluca Guida RB_SET_POSITION(new_child->rb_nodes[which], which);
373b6cbf720SGianluca Guida }
374b6cbf720SGianluca Guida
375b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, new_father, NULL, false));
376b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, new_child, NULL, false));
377b6cbf720SGianluca Guida KASSERT(RB_ROOT_P(rbt, new_father) ||
378b6cbf720SGianluca Guida rb_tree_check_node(rbt, grandpa, NULL, false));
379b6cbf720SGianluca Guida }
380b6cbf720SGianluca Guida
381b6cbf720SGianluca Guida static void
rb_tree_insert_rebalance(struct rb_tree * rbt,struct rb_node * self)382b6cbf720SGianluca Guida rb_tree_insert_rebalance(struct rb_tree *rbt, struct rb_node *self)
383b6cbf720SGianluca Guida {
384b6cbf720SGianluca Guida struct rb_node * father = RB_FATHER(self);
385b6cbf720SGianluca Guida struct rb_node * grandpa = RB_FATHER(father);
386b6cbf720SGianluca Guida struct rb_node * uncle;
387b6cbf720SGianluca Guida unsigned int which;
388b6cbf720SGianluca Guida unsigned int other;
389b6cbf720SGianluca Guida
390b6cbf720SGianluca Guida KASSERT(!RB_ROOT_P(rbt, self));
391b6cbf720SGianluca Guida KASSERT(RB_RED_P(self));
392b6cbf720SGianluca Guida KASSERT(RB_RED_P(father));
393b6cbf720SGianluca Guida RBSTAT_INC(rbt->rbt_insertion_rebalance_calls);
394b6cbf720SGianluca Guida
395b6cbf720SGianluca Guida for (;;) {
396b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(self));
397b6cbf720SGianluca Guida
398b6cbf720SGianluca Guida KASSERT(RB_RED_P(self));
399b6cbf720SGianluca Guida KASSERT(RB_RED_P(father));
400b6cbf720SGianluca Guida /*
401b6cbf720SGianluca Guida * We are red and our parent is red, therefore we must have a
402b6cbf720SGianluca Guida * grandfather and he must be black.
403b6cbf720SGianluca Guida */
404b6cbf720SGianluca Guida grandpa = RB_FATHER(father);
405b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(grandpa));
406b6cbf720SGianluca Guida KASSERT(RB_DIR_RIGHT == 1 && RB_DIR_LEFT == 0);
407b6cbf720SGianluca Guida which = (father == grandpa->rb_right);
408b6cbf720SGianluca Guida other = which ^ RB_DIR_OTHER;
409b6cbf720SGianluca Guida uncle = grandpa->rb_nodes[other];
410b6cbf720SGianluca Guida
411b6cbf720SGianluca Guida if (RB_BLACK_P(uncle))
412b6cbf720SGianluca Guida break;
413b6cbf720SGianluca Guida
414b6cbf720SGianluca Guida RBSTAT_INC(rbt->rbt_insertion_rebalance_passes);
415b6cbf720SGianluca Guida /*
416b6cbf720SGianluca Guida * Case 1: our uncle is red
417b6cbf720SGianluca Guida * Simply invert the colors of our parent and
418b6cbf720SGianluca Guida * uncle and make our grandparent red. And
419b6cbf720SGianluca Guida * then solve the problem up at his level.
420b6cbf720SGianluca Guida */
421b6cbf720SGianluca Guida RB_MARK_BLACK(uncle);
422b6cbf720SGianluca Guida RB_MARK_BLACK(father);
423b6cbf720SGianluca Guida if (__predict_false(RB_ROOT_P(rbt, grandpa))) {
424b6cbf720SGianluca Guida /*
425b6cbf720SGianluca Guida * If our grandpa is root, don't bother
426b6cbf720SGianluca Guida * setting him to red, just return.
427b6cbf720SGianluca Guida */
428b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(grandpa));
429b6cbf720SGianluca Guida return;
430b6cbf720SGianluca Guida }
431b6cbf720SGianluca Guida RB_MARK_RED(grandpa);
432b6cbf720SGianluca Guida self = grandpa;
433b6cbf720SGianluca Guida father = RB_FATHER(self);
434b6cbf720SGianluca Guida KASSERT(RB_RED_P(self));
435b6cbf720SGianluca Guida if (RB_BLACK_P(father)) {
436b6cbf720SGianluca Guida /*
437b6cbf720SGianluca Guida * If our greatgrandpa is black, we're done.
438b6cbf720SGianluca Guida */
439b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(rbt->rbt_root));
440b6cbf720SGianluca Guida return;
441b6cbf720SGianluca Guida }
442b6cbf720SGianluca Guida }
443b6cbf720SGianluca Guida
444b6cbf720SGianluca Guida KASSERT(!RB_ROOT_P(rbt, self));
445b6cbf720SGianluca Guida KASSERT(RB_RED_P(self));
446b6cbf720SGianluca Guida KASSERT(RB_RED_P(father));
447b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(uncle));
448b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(grandpa));
449b6cbf720SGianluca Guida /*
450b6cbf720SGianluca Guida * Case 2&3: our uncle is black.
451b6cbf720SGianluca Guida */
452b6cbf720SGianluca Guida if (self == father->rb_nodes[other]) {
453b6cbf720SGianluca Guida /*
454b6cbf720SGianluca Guida * Case 2: we are on the same side as our uncle
455b6cbf720SGianluca Guida * Swap ourselves with our parent so this case
456b6cbf720SGianluca Guida * becomes case 3. Basically our parent becomes our
457b6cbf720SGianluca Guida * child.
458b6cbf720SGianluca Guida */
459b6cbf720SGianluca Guida rb_tree_reparent_nodes(rbt, father, other);
460b6cbf720SGianluca Guida KASSERT(RB_FATHER(father) == self);
461b6cbf720SGianluca Guida KASSERT(self->rb_nodes[which] == father);
462b6cbf720SGianluca Guida KASSERT(RB_FATHER(self) == grandpa);
463b6cbf720SGianluca Guida self = father;
464b6cbf720SGianluca Guida father = RB_FATHER(self);
465b6cbf720SGianluca Guida }
466b6cbf720SGianluca Guida KASSERT(RB_RED_P(self) && RB_RED_P(father));
467b6cbf720SGianluca Guida KASSERT(grandpa->rb_nodes[which] == father);
468b6cbf720SGianluca Guida /*
469b6cbf720SGianluca Guida * Case 3: we are opposite a child of a black uncle.
470b6cbf720SGianluca Guida * Swap our parent and grandparent. Since our grandfather
471b6cbf720SGianluca Guida * is black, our father will become black and our new sibling
472b6cbf720SGianluca Guida * (former grandparent) will become red.
473b6cbf720SGianluca Guida */
474b6cbf720SGianluca Guida rb_tree_reparent_nodes(rbt, grandpa, which);
475b6cbf720SGianluca Guida KASSERT(RB_FATHER(self) == father);
476b6cbf720SGianluca Guida KASSERT(RB_FATHER(self)->rb_nodes[RB_POSITION(self) ^ RB_DIR_OTHER] == grandpa);
477b6cbf720SGianluca Guida KASSERT(RB_RED_P(self));
478b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(father));
479b6cbf720SGianluca Guida KASSERT(RB_RED_P(grandpa));
480b6cbf720SGianluca Guida
481b6cbf720SGianluca Guida /*
482b6cbf720SGianluca Guida * Final step: Set the root to black.
483b6cbf720SGianluca Guida */
484b6cbf720SGianluca Guida RB_MARK_BLACK(rbt->rbt_root);
485b6cbf720SGianluca Guida }
486b6cbf720SGianluca Guida
487b6cbf720SGianluca Guida static void
rb_tree_prune_node(struct rb_tree * rbt,struct rb_node * self,bool rebalance)488b6cbf720SGianluca Guida rb_tree_prune_node(struct rb_tree *rbt, struct rb_node *self, bool rebalance)
489b6cbf720SGianluca Guida {
490b6cbf720SGianluca Guida const unsigned int which = RB_POSITION(self);
491b6cbf720SGianluca Guida struct rb_node *father = RB_FATHER(self);
492b6cbf720SGianluca Guida #ifndef RBSMALL
493b6cbf720SGianluca Guida const bool was_root = RB_ROOT_P(rbt, self);
494b6cbf720SGianluca Guida #endif
495b6cbf720SGianluca Guida
496b6cbf720SGianluca Guida KASSERT(rebalance || (RB_ROOT_P(rbt, self) || RB_RED_P(self)));
497b6cbf720SGianluca Guida KASSERT(!rebalance || RB_BLACK_P(self));
498b6cbf720SGianluca Guida KASSERT(RB_CHILDLESS_P(self));
499b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, self, NULL, false));
500b6cbf720SGianluca Guida
501b6cbf720SGianluca Guida /*
502b6cbf720SGianluca Guida * Since we are childless, we know that self->rb_left is pointing
503b6cbf720SGianluca Guida * to the sentinel node.
504b6cbf720SGianluca Guida */
505b6cbf720SGianluca Guida father->rb_nodes[which] = self->rb_left;
506b6cbf720SGianluca Guida
507b6cbf720SGianluca Guida /*
508b6cbf720SGianluca Guida * Remove ourselves from the node list, decrement the count,
509b6cbf720SGianluca Guida * and update min/max.
510b6cbf720SGianluca Guida */
511b6cbf720SGianluca Guida RB_TAILQ_REMOVE(&rbt->rbt_nodes, self, rb_link);
512b6cbf720SGianluca Guida RBSTAT_DEC(rbt->rbt_count);
513b6cbf720SGianluca Guida #ifndef RBSMALL
514b6cbf720SGianluca Guida if (__predict_false(rbt->rbt_minmax[RB_POSITION(self)] == self)) {
515b6cbf720SGianluca Guida rbt->rbt_minmax[RB_POSITION(self)] = father;
516b6cbf720SGianluca Guida /*
517b6cbf720SGianluca Guida * When removing the root, rbt->rbt_minmax[RB_DIR_LEFT] is
518b6cbf720SGianluca Guida * updated automatically, but we also need to update
519b6cbf720SGianluca Guida * rbt->rbt_minmax[RB_DIR_RIGHT];
520b6cbf720SGianluca Guida */
521b6cbf720SGianluca Guida if (__predict_false(was_root)) {
522b6cbf720SGianluca Guida rbt->rbt_minmax[RB_DIR_RIGHT] = father;
523b6cbf720SGianluca Guida }
524b6cbf720SGianluca Guida }
525b6cbf720SGianluca Guida RB_SET_FATHER(self, NULL);
526b6cbf720SGianluca Guida #endif
527b6cbf720SGianluca Guida
528b6cbf720SGianluca Guida /*
529b6cbf720SGianluca Guida * Rebalance if requested.
530b6cbf720SGianluca Guida */
531b6cbf720SGianluca Guida if (rebalance)
532b6cbf720SGianluca Guida rb_tree_removal_rebalance(rbt, father, which);
533b6cbf720SGianluca Guida KASSERT(was_root || rb_tree_check_node(rbt, father, NULL, true));
534b6cbf720SGianluca Guida }
535b6cbf720SGianluca Guida
536b6cbf720SGianluca Guida /*
537b6cbf720SGianluca Guida * When deleting an interior node
538b6cbf720SGianluca Guida */
539b6cbf720SGianluca Guida static void
rb_tree_swap_prune_and_rebalance(struct rb_tree * rbt,struct rb_node * self,struct rb_node * standin)540b6cbf720SGianluca Guida rb_tree_swap_prune_and_rebalance(struct rb_tree *rbt, struct rb_node *self,
541b6cbf720SGianluca Guida struct rb_node *standin)
542b6cbf720SGianluca Guida {
543b6cbf720SGianluca Guida const unsigned int standin_which = RB_POSITION(standin);
544b6cbf720SGianluca Guida unsigned int standin_other = standin_which ^ RB_DIR_OTHER;
545b6cbf720SGianluca Guida struct rb_node *standin_son;
546b6cbf720SGianluca Guida struct rb_node *standin_father = RB_FATHER(standin);
547b6cbf720SGianluca Guida bool rebalance = RB_BLACK_P(standin);
548b6cbf720SGianluca Guida
549b6cbf720SGianluca Guida if (standin_father == self) {
550b6cbf720SGianluca Guida /*
551b6cbf720SGianluca Guida * As a child of self, any childen would be opposite of
552b6cbf720SGianluca Guida * our parent.
553b6cbf720SGianluca Guida */
554b6cbf720SGianluca Guida KASSERT(RB_SENTINEL_P(standin->rb_nodes[standin_other]));
555b6cbf720SGianluca Guida standin_son = standin->rb_nodes[standin_which];
556b6cbf720SGianluca Guida } else {
557b6cbf720SGianluca Guida /*
558b6cbf720SGianluca Guida * Since we aren't a child of self, any childen would be
559b6cbf720SGianluca Guida * on the same side as our parent.
560b6cbf720SGianluca Guida */
561b6cbf720SGianluca Guida KASSERT(RB_SENTINEL_P(standin->rb_nodes[standin_which]));
562b6cbf720SGianluca Guida standin_son = standin->rb_nodes[standin_other];
563b6cbf720SGianluca Guida }
564b6cbf720SGianluca Guida
565b6cbf720SGianluca Guida /*
566b6cbf720SGianluca Guida * the node we are removing must have two children.
567b6cbf720SGianluca Guida */
568b6cbf720SGianluca Guida KASSERT(RB_TWOCHILDREN_P(self));
569b6cbf720SGianluca Guida /*
570b6cbf720SGianluca Guida * If standin has a child, it must be red.
571b6cbf720SGianluca Guida */
572b6cbf720SGianluca Guida KASSERT(RB_SENTINEL_P(standin_son) || RB_RED_P(standin_son));
573b6cbf720SGianluca Guida
574b6cbf720SGianluca Guida /*
575b6cbf720SGianluca Guida * Verify things are sane.
576b6cbf720SGianluca Guida */
577b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, self, NULL, false));
578b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, standin, NULL, false));
579b6cbf720SGianluca Guida
580b6cbf720SGianluca Guida if (__predict_false(RB_RED_P(standin_son))) {
581b6cbf720SGianluca Guida /*
582b6cbf720SGianluca Guida * We know we have a red child so if we flip it to black
583b6cbf720SGianluca Guida * we don't have to rebalance.
584b6cbf720SGianluca Guida */
585b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, standin_son, NULL, true));
586b6cbf720SGianluca Guida RB_MARK_BLACK(standin_son);
587b6cbf720SGianluca Guida rebalance = false;
588b6cbf720SGianluca Guida
589b6cbf720SGianluca Guida if (standin_father == self) {
590b6cbf720SGianluca Guida KASSERT(RB_POSITION(standin_son) == standin_which);
591b6cbf720SGianluca Guida } else {
592b6cbf720SGianluca Guida KASSERT(RB_POSITION(standin_son) == standin_other);
593b6cbf720SGianluca Guida /*
594b6cbf720SGianluca Guida * Change the son's parentage to point to his grandpa.
595b6cbf720SGianluca Guida */
596b6cbf720SGianluca Guida RB_SET_FATHER(standin_son, standin_father);
597b6cbf720SGianluca Guida RB_SET_POSITION(standin_son, standin_which);
598b6cbf720SGianluca Guida }
599b6cbf720SGianluca Guida }
600b6cbf720SGianluca Guida
601b6cbf720SGianluca Guida if (standin_father == self) {
602b6cbf720SGianluca Guida /*
603b6cbf720SGianluca Guida * If we are about to delete the standin's father, then when
604b6cbf720SGianluca Guida * we call rebalance, we need to use ourselves as our father.
605b6cbf720SGianluca Guida * Otherwise remember our original father. Also, sincef we are
606b6cbf720SGianluca Guida * our standin's father we only need to reparent the standin's
607b6cbf720SGianluca Guida * brother.
608b6cbf720SGianluca Guida *
609b6cbf720SGianluca Guida * | R --> S |
610b6cbf720SGianluca Guida * | Q S --> Q T |
611b6cbf720SGianluca Guida * | t --> |
612b6cbf720SGianluca Guida */
613b6cbf720SGianluca Guida KASSERT(RB_SENTINEL_P(standin->rb_nodes[standin_other]));
614b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(self->rb_nodes[standin_other]));
615b6cbf720SGianluca Guida KASSERT(self->rb_nodes[standin_which] == standin);
616b6cbf720SGianluca Guida /*
617b6cbf720SGianluca Guida * Have our son/standin adopt his brother as his new son.
618b6cbf720SGianluca Guida */
619b6cbf720SGianluca Guida standin_father = standin;
620b6cbf720SGianluca Guida } else {
621b6cbf720SGianluca Guida /*
622b6cbf720SGianluca Guida * | R --> S . |
623b6cbf720SGianluca Guida * | / \ | T --> / \ | / |
624b6cbf720SGianluca Guida * | ..... | S --> ..... | T |
625b6cbf720SGianluca Guida *
626b6cbf720SGianluca Guida * Sever standin's connection to his father.
627b6cbf720SGianluca Guida */
628b6cbf720SGianluca Guida standin_father->rb_nodes[standin_which] = standin_son;
629b6cbf720SGianluca Guida /*
630b6cbf720SGianluca Guida * Adopt the far son.
631b6cbf720SGianluca Guida */
632b6cbf720SGianluca Guida standin->rb_nodes[standin_other] = self->rb_nodes[standin_other];
633b6cbf720SGianluca Guida RB_SET_FATHER(standin->rb_nodes[standin_other], standin);
634b6cbf720SGianluca Guida KASSERT(RB_POSITION(self->rb_nodes[standin_other]) == standin_other);
635b6cbf720SGianluca Guida /*
636b6cbf720SGianluca Guida * Use standin_other because we need to preserve standin_which
637b6cbf720SGianluca Guida * for the removal_rebalance.
638b6cbf720SGianluca Guida */
639b6cbf720SGianluca Guida standin_other = standin_which;
640b6cbf720SGianluca Guida }
641b6cbf720SGianluca Guida
642b6cbf720SGianluca Guida /*
643b6cbf720SGianluca Guida * Move the only remaining son to our standin. If our standin is our
644b6cbf720SGianluca Guida * son, this will be the only son needed to be moved.
645b6cbf720SGianluca Guida */
646b6cbf720SGianluca Guida KASSERT(standin->rb_nodes[standin_other] != self->rb_nodes[standin_other]);
647b6cbf720SGianluca Guida standin->rb_nodes[standin_other] = self->rb_nodes[standin_other];
648b6cbf720SGianluca Guida RB_SET_FATHER(standin->rb_nodes[standin_other], standin);
649b6cbf720SGianluca Guida
650b6cbf720SGianluca Guida /*
651b6cbf720SGianluca Guida * Now copy the result of self to standin and then replace
652b6cbf720SGianluca Guida * self with standin in the tree.
653b6cbf720SGianluca Guida */
654b6cbf720SGianluca Guida RB_COPY_PROPERTIES(standin, self);
655b6cbf720SGianluca Guida RB_SET_FATHER(standin, RB_FATHER(self));
656b6cbf720SGianluca Guida RB_FATHER(standin)->rb_nodes[RB_POSITION(standin)] = standin;
657b6cbf720SGianluca Guida
658b6cbf720SGianluca Guida /*
659b6cbf720SGianluca Guida * Remove ourselves from the node list, decrement the count,
660b6cbf720SGianluca Guida * and update min/max.
661b6cbf720SGianluca Guida */
662b6cbf720SGianluca Guida RB_TAILQ_REMOVE(&rbt->rbt_nodes, self, rb_link);
663b6cbf720SGianluca Guida RBSTAT_DEC(rbt->rbt_count);
664b6cbf720SGianluca Guida #ifndef RBSMALL
665b6cbf720SGianluca Guida if (__predict_false(rbt->rbt_minmax[RB_POSITION(self)] == self))
666b6cbf720SGianluca Guida rbt->rbt_minmax[RB_POSITION(self)] = RB_FATHER(self);
667b6cbf720SGianluca Guida RB_SET_FATHER(self, NULL);
668b6cbf720SGianluca Guida #endif
669b6cbf720SGianluca Guida
670b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, standin, NULL, false));
671b6cbf720SGianluca Guida KASSERT(RB_FATHER_SENTINEL_P(standin)
672b6cbf720SGianluca Guida || rb_tree_check_node(rbt, standin_father, NULL, false));
673b6cbf720SGianluca Guida KASSERT(RB_LEFT_SENTINEL_P(standin)
674b6cbf720SGianluca Guida || rb_tree_check_node(rbt, standin->rb_left, NULL, false));
675b6cbf720SGianluca Guida KASSERT(RB_RIGHT_SENTINEL_P(standin)
676b6cbf720SGianluca Guida || rb_tree_check_node(rbt, standin->rb_right, NULL, false));
677b6cbf720SGianluca Guida
678b6cbf720SGianluca Guida if (!rebalance)
679b6cbf720SGianluca Guida return;
680b6cbf720SGianluca Guida
681b6cbf720SGianluca Guida rb_tree_removal_rebalance(rbt, standin_father, standin_which);
682b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, standin, NULL, true));
683b6cbf720SGianluca Guida }
684b6cbf720SGianluca Guida
685b6cbf720SGianluca Guida /*
686b6cbf720SGianluca Guida * We could do this by doing
687b6cbf720SGianluca Guida * rb_tree_node_swap(rbt, self, which);
688b6cbf720SGianluca Guida * rb_tree_prune_node(rbt, self, false);
689b6cbf720SGianluca Guida *
690b6cbf720SGianluca Guida * But it's more efficient to just evalate and recolor the child.
691b6cbf720SGianluca Guida */
692b6cbf720SGianluca Guida static void
rb_tree_prune_blackred_branch(struct rb_tree * rbt,struct rb_node * self,unsigned int which)693b6cbf720SGianluca Guida rb_tree_prune_blackred_branch(struct rb_tree *rbt, struct rb_node *self,
694b6cbf720SGianluca Guida unsigned int which)
695b6cbf720SGianluca Guida {
696b6cbf720SGianluca Guida struct rb_node *father = RB_FATHER(self);
697b6cbf720SGianluca Guida struct rb_node *son = self->rb_nodes[which];
698b6cbf720SGianluca Guida #ifndef RBSMALL
699b6cbf720SGianluca Guida const bool was_root = RB_ROOT_P(rbt, self);
700b6cbf720SGianluca Guida #endif
701b6cbf720SGianluca Guida
702b6cbf720SGianluca Guida KASSERT(which == RB_DIR_LEFT || which == RB_DIR_RIGHT);
703b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(self) && RB_RED_P(son));
704b6cbf720SGianluca Guida KASSERT(!RB_TWOCHILDREN_P(son));
705b6cbf720SGianluca Guida KASSERT(RB_CHILDLESS_P(son));
706b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, self, NULL, false));
707b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, son, NULL, false));
708b6cbf720SGianluca Guida
709b6cbf720SGianluca Guida /*
710b6cbf720SGianluca Guida * Remove ourselves from the tree and give our former child our
711b6cbf720SGianluca Guida * properties (position, color, root).
712b6cbf720SGianluca Guida */
713b6cbf720SGianluca Guida RB_COPY_PROPERTIES(son, self);
714b6cbf720SGianluca Guida father->rb_nodes[RB_POSITION(son)] = son;
715b6cbf720SGianluca Guida RB_SET_FATHER(son, father);
716b6cbf720SGianluca Guida
717b6cbf720SGianluca Guida /*
718b6cbf720SGianluca Guida * Remove ourselves from the node list, decrement the count,
719b6cbf720SGianluca Guida * and update minmax.
720b6cbf720SGianluca Guida */
721b6cbf720SGianluca Guida RB_TAILQ_REMOVE(&rbt->rbt_nodes, self, rb_link);
722b6cbf720SGianluca Guida RBSTAT_DEC(rbt->rbt_count);
723b6cbf720SGianluca Guida #ifndef RBSMALL
724b6cbf720SGianluca Guida if (__predict_false(was_root)) {
725b6cbf720SGianluca Guida KASSERT(rbt->rbt_minmax[which] == son);
726b6cbf720SGianluca Guida rbt->rbt_minmax[which ^ RB_DIR_OTHER] = son;
727b6cbf720SGianluca Guida } else if (rbt->rbt_minmax[RB_POSITION(self)] == self) {
728b6cbf720SGianluca Guida rbt->rbt_minmax[RB_POSITION(self)] = son;
729b6cbf720SGianluca Guida }
730b6cbf720SGianluca Guida RB_SET_FATHER(self, NULL);
731b6cbf720SGianluca Guida #endif
732b6cbf720SGianluca Guida
733b6cbf720SGianluca Guida KASSERT(was_root || rb_tree_check_node(rbt, father, NULL, true));
734b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, son, NULL, true));
735b6cbf720SGianluca Guida }
736b6cbf720SGianluca Guida
737b6cbf720SGianluca Guida void
rb_tree_remove_node(struct rb_tree * rbt,void * object)738b6cbf720SGianluca Guida rb_tree_remove_node(struct rb_tree *rbt, void *object)
739b6cbf720SGianluca Guida {
740b6cbf720SGianluca Guida const rb_tree_ops_t *rbto = rbt->rbt_ops;
741b6cbf720SGianluca Guida struct rb_node *standin, *self = RB_ITEMTONODE(rbto, object);
742b6cbf720SGianluca Guida unsigned int which;
743b6cbf720SGianluca Guida
744b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(self));
745b6cbf720SGianluca Guida RBSTAT_INC(rbt->rbt_removals);
746b6cbf720SGianluca Guida
747b6cbf720SGianluca Guida /*
748b6cbf720SGianluca Guida * In the following diagrams, we (the node to be removed) are S. Red
749b6cbf720SGianluca Guida * nodes are lowercase. T could be either red or black.
750b6cbf720SGianluca Guida *
751b6cbf720SGianluca Guida * Remember the major axiom of the red-black tree: the number of
752b6cbf720SGianluca Guida * black nodes from the root to each leaf is constant across all
753b6cbf720SGianluca Guida * leaves, only the number of red nodes varies.
754b6cbf720SGianluca Guida *
755b6cbf720SGianluca Guida * Thus removing a red leaf doesn't require any other changes to a
756b6cbf720SGianluca Guida * red-black tree. So if we must remove a node, attempt to rearrange
757b6cbf720SGianluca Guida * the tree so we can remove a red node.
758b6cbf720SGianluca Guida *
759b6cbf720SGianluca Guida * The simpliest case is a childless red node or a childless root node:
760b6cbf720SGianluca Guida *
761b6cbf720SGianluca Guida * | T --> T | or | R --> * |
762b6cbf720SGianluca Guida * | s --> * |
763b6cbf720SGianluca Guida */
764b6cbf720SGianluca Guida if (RB_CHILDLESS_P(self)) {
765b6cbf720SGianluca Guida const bool rebalance = RB_BLACK_P(self) && !RB_ROOT_P(rbt, self);
766b6cbf720SGianluca Guida rb_tree_prune_node(rbt, self, rebalance);
767b6cbf720SGianluca Guida return;
768b6cbf720SGianluca Guida }
769b6cbf720SGianluca Guida KASSERT(!RB_CHILDLESS_P(self));
770b6cbf720SGianluca Guida if (!RB_TWOCHILDREN_P(self)) {
771b6cbf720SGianluca Guida /*
772b6cbf720SGianluca Guida * The next simpliest case is the node we are deleting is
773b6cbf720SGianluca Guida * black and has one red child.
774b6cbf720SGianluca Guida *
775b6cbf720SGianluca Guida * | T --> T --> T |
776b6cbf720SGianluca Guida * | S --> R --> R |
777b6cbf720SGianluca Guida * | r --> s --> * |
778b6cbf720SGianluca Guida */
779b6cbf720SGianluca Guida which = RB_LEFT_SENTINEL_P(self) ? RB_DIR_RIGHT : RB_DIR_LEFT;
780b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(self));
781b6cbf720SGianluca Guida KASSERT(RB_RED_P(self->rb_nodes[which]));
782b6cbf720SGianluca Guida KASSERT(RB_CHILDLESS_P(self->rb_nodes[which]));
783b6cbf720SGianluca Guida rb_tree_prune_blackred_branch(rbt, self, which);
784b6cbf720SGianluca Guida return;
785b6cbf720SGianluca Guida }
786b6cbf720SGianluca Guida KASSERT(RB_TWOCHILDREN_P(self));
787b6cbf720SGianluca Guida
788b6cbf720SGianluca Guida /*
789b6cbf720SGianluca Guida * We invert these because we prefer to remove from the inside of
790b6cbf720SGianluca Guida * the tree.
791b6cbf720SGianluca Guida */
792b6cbf720SGianluca Guida which = RB_POSITION(self) ^ RB_DIR_OTHER;
793b6cbf720SGianluca Guida
794b6cbf720SGianluca Guida /*
795b6cbf720SGianluca Guida * Let's find the node closes to us opposite of our parent
796b6cbf720SGianluca Guida * Now swap it with ourself, "prune" it, and rebalance, if needed.
797b6cbf720SGianluca Guida */
798b6cbf720SGianluca Guida standin = RB_ITEMTONODE(rbto, rb_tree_iterate(rbt, object, which));
799b6cbf720SGianluca Guida rb_tree_swap_prune_and_rebalance(rbt, self, standin);
800b6cbf720SGianluca Guida }
801b6cbf720SGianluca Guida
802b6cbf720SGianluca Guida static void
rb_tree_removal_rebalance(struct rb_tree * rbt,struct rb_node * parent,unsigned int which)803b6cbf720SGianluca Guida rb_tree_removal_rebalance(struct rb_tree *rbt, struct rb_node *parent,
804b6cbf720SGianluca Guida unsigned int which)
805b6cbf720SGianluca Guida {
806b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(parent));
807b6cbf720SGianluca Guida KASSERT(RB_SENTINEL_P(parent->rb_nodes[which]));
808b6cbf720SGianluca Guida KASSERT(which == RB_DIR_LEFT || which == RB_DIR_RIGHT);
809b6cbf720SGianluca Guida RBSTAT_INC(rbt->rbt_removal_rebalance_calls);
810b6cbf720SGianluca Guida
811b6cbf720SGianluca Guida while (RB_BLACK_P(parent->rb_nodes[which])) {
812b6cbf720SGianluca Guida unsigned int other = which ^ RB_DIR_OTHER;
813b6cbf720SGianluca Guida struct rb_node *brother = parent->rb_nodes[other];
814b6cbf720SGianluca Guida
815b6cbf720SGianluca Guida RBSTAT_INC(rbt->rbt_removal_rebalance_passes);
816b6cbf720SGianluca Guida
817b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(brother));
818b6cbf720SGianluca Guida /*
819b6cbf720SGianluca Guida * For cases 1, 2a, and 2b, our brother's children must
820b6cbf720SGianluca Guida * be black and our father must be black
821b6cbf720SGianluca Guida */
822b6cbf720SGianluca Guida if (RB_BLACK_P(parent)
823b6cbf720SGianluca Guida && RB_BLACK_P(brother->rb_left)
824b6cbf720SGianluca Guida && RB_BLACK_P(brother->rb_right)) {
825b6cbf720SGianluca Guida if (RB_RED_P(brother)) {
826b6cbf720SGianluca Guida /*
827b6cbf720SGianluca Guida * Case 1: Our brother is red, swap its
828b6cbf720SGianluca Guida * position (and colors) with our parent.
829b6cbf720SGianluca Guida * This should now be case 2b (unless C or E
830b6cbf720SGianluca Guida * has a red child which is case 3; thus no
831b6cbf720SGianluca Guida * explicit branch to case 2b).
832b6cbf720SGianluca Guida *
833b6cbf720SGianluca Guida * B -> D
834b6cbf720SGianluca Guida * A d -> b E
835b6cbf720SGianluca Guida * C E -> A C
836b6cbf720SGianluca Guida */
837b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(parent));
838b6cbf720SGianluca Guida rb_tree_reparent_nodes(rbt, parent, other);
839b6cbf720SGianluca Guida brother = parent->rb_nodes[other];
840b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(brother));
841b6cbf720SGianluca Guida KASSERT(RB_RED_P(parent));
842b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(brother));
843b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, brother, NULL, false));
844b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, parent, NULL, false));
845b6cbf720SGianluca Guida } else {
846b6cbf720SGianluca Guida /*
847b6cbf720SGianluca Guida * Both our parent and brother are black.
848b6cbf720SGianluca Guida * Change our brother to red, advance up rank
849b6cbf720SGianluca Guida * and go through the loop again.
850b6cbf720SGianluca Guida *
851b6cbf720SGianluca Guida * B -> *B
852b6cbf720SGianluca Guida * *A D -> A d
853b6cbf720SGianluca Guida * C E -> C E
854b6cbf720SGianluca Guida */
855b6cbf720SGianluca Guida RB_MARK_RED(brother);
856b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(brother->rb_left));
857b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(brother->rb_right));
858b6cbf720SGianluca Guida if (RB_ROOT_P(rbt, parent))
859b6cbf720SGianluca Guida return; /* root == parent == black */
860b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, brother, NULL, false));
861b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, parent, NULL, false));
862b6cbf720SGianluca Guida which = RB_POSITION(parent);
863b6cbf720SGianluca Guida parent = RB_FATHER(parent);
864b6cbf720SGianluca Guida continue;
865b6cbf720SGianluca Guida }
866b6cbf720SGianluca Guida }
867b6cbf720SGianluca Guida /*
868b6cbf720SGianluca Guida * Avoid an else here so that case 2a above can hit either
869b6cbf720SGianluca Guida * case 2b, 3, or 4.
870b6cbf720SGianluca Guida */
871b6cbf720SGianluca Guida if (RB_RED_P(parent)
872b6cbf720SGianluca Guida && RB_BLACK_P(brother)
873b6cbf720SGianluca Guida && RB_BLACK_P(brother->rb_left)
874b6cbf720SGianluca Guida && RB_BLACK_P(brother->rb_right)) {
875b6cbf720SGianluca Guida KASSERT(RB_RED_P(parent));
876b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(brother));
877b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(brother->rb_left));
878b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(brother->rb_right));
879b6cbf720SGianluca Guida /*
880b6cbf720SGianluca Guida * We are black, our father is red, our brother and
881b6cbf720SGianluca Guida * both nephews are black. Simply invert/exchange the
882b6cbf720SGianluca Guida * colors of our father and brother (to black and red
883b6cbf720SGianluca Guida * respectively).
884b6cbf720SGianluca Guida *
885b6cbf720SGianluca Guida * | f --> F |
886b6cbf720SGianluca Guida * | * B --> * b |
887b6cbf720SGianluca Guida * | N N --> N N |
888b6cbf720SGianluca Guida */
889b6cbf720SGianluca Guida RB_MARK_BLACK(parent);
890b6cbf720SGianluca Guida RB_MARK_RED(brother);
891b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, brother, NULL, true));
892b6cbf720SGianluca Guida break; /* We're done! */
893b6cbf720SGianluca Guida } else {
894b6cbf720SGianluca Guida /*
895b6cbf720SGianluca Guida * Our brother must be black and have at least one
896b6cbf720SGianluca Guida * red child (it may have two).
897b6cbf720SGianluca Guida */
898b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(brother));
899b6cbf720SGianluca Guida KASSERT(RB_RED_P(brother->rb_nodes[which]) ||
900b6cbf720SGianluca Guida RB_RED_P(brother->rb_nodes[other]));
901b6cbf720SGianluca Guida if (RB_BLACK_P(brother->rb_nodes[other])) {
902b6cbf720SGianluca Guida /*
903b6cbf720SGianluca Guida * Case 3: our brother is black, our near
904b6cbf720SGianluca Guida * nephew is red, and our far nephew is black.
905b6cbf720SGianluca Guida * Swap our brother with our near nephew.
906b6cbf720SGianluca Guida * This result in a tree that matches case 4.
907b6cbf720SGianluca Guida * (Our father could be red or black).
908b6cbf720SGianluca Guida *
909b6cbf720SGianluca Guida * | F --> F |
910b6cbf720SGianluca Guida * | x B --> x B |
911b6cbf720SGianluca Guida * | n --> n |
912b6cbf720SGianluca Guida */
913b6cbf720SGianluca Guida KASSERT(RB_RED_P(brother->rb_nodes[which]));
914b6cbf720SGianluca Guida rb_tree_reparent_nodes(rbt, brother, which);
915b6cbf720SGianluca Guida KASSERT(RB_FATHER(brother) == parent->rb_nodes[other]);
916b6cbf720SGianluca Guida brother = parent->rb_nodes[other];
917b6cbf720SGianluca Guida KASSERT(RB_RED_P(brother->rb_nodes[other]));
918b6cbf720SGianluca Guida }
919b6cbf720SGianluca Guida /*
920b6cbf720SGianluca Guida * Case 4: our brother is black and our far nephew
921b6cbf720SGianluca Guida * is red. Swap our father and brother locations and
922b6cbf720SGianluca Guida * change our far nephew to black. (these can be
923b6cbf720SGianluca Guida * done in either order so we change the color first).
924b6cbf720SGianluca Guida * The result is a valid red-black tree and is a
925b6cbf720SGianluca Guida * terminal case. (again we don't care about the
926b6cbf720SGianluca Guida * father's color)
927b6cbf720SGianluca Guida *
928b6cbf720SGianluca Guida * If the father is red, we will get a red-black-black
929b6cbf720SGianluca Guida * tree:
930b6cbf720SGianluca Guida * | f -> f --> b |
931b6cbf720SGianluca Guida * | B -> B --> F N |
932b6cbf720SGianluca Guida * | n -> N --> |
933b6cbf720SGianluca Guida *
934b6cbf720SGianluca Guida * If the father is black, we will get an all black
935b6cbf720SGianluca Guida * tree:
936b6cbf720SGianluca Guida * | F -> F --> B |
937b6cbf720SGianluca Guida * | B -> B --> F N |
938b6cbf720SGianluca Guida * | n -> N --> |
939b6cbf720SGianluca Guida *
940b6cbf720SGianluca Guida * If we had two red nephews, then after the swap,
941b6cbf720SGianluca Guida * our former father would have a red grandson.
942b6cbf720SGianluca Guida */
943b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(brother));
944b6cbf720SGianluca Guida KASSERT(RB_RED_P(brother->rb_nodes[other]));
945b6cbf720SGianluca Guida RB_MARK_BLACK(brother->rb_nodes[other]);
946b6cbf720SGianluca Guida rb_tree_reparent_nodes(rbt, parent, other);
947b6cbf720SGianluca Guida break; /* We're done! */
948b6cbf720SGianluca Guida }
949b6cbf720SGianluca Guida }
950b6cbf720SGianluca Guida KASSERT(rb_tree_check_node(rbt, parent, NULL, true));
951b6cbf720SGianluca Guida }
952b6cbf720SGianluca Guida
953b6cbf720SGianluca Guida void *
rb_tree_iterate(struct rb_tree * rbt,void * object,const unsigned int direction)954b6cbf720SGianluca Guida rb_tree_iterate(struct rb_tree *rbt, void *object, const unsigned int direction)
955b6cbf720SGianluca Guida {
956b6cbf720SGianluca Guida const rb_tree_ops_t *rbto = rbt->rbt_ops;
957b6cbf720SGianluca Guida const unsigned int other = direction ^ RB_DIR_OTHER;
958b6cbf720SGianluca Guida struct rb_node *self;
959b6cbf720SGianluca Guida
960b6cbf720SGianluca Guida KASSERT(direction == RB_DIR_LEFT || direction == RB_DIR_RIGHT);
961b6cbf720SGianluca Guida
962b6cbf720SGianluca Guida if (object == NULL) {
963b6cbf720SGianluca Guida #ifndef RBSMALL
964b6cbf720SGianluca Guida if (RB_SENTINEL_P(rbt->rbt_root))
965b6cbf720SGianluca Guida return NULL;
966b6cbf720SGianluca Guida return RB_NODETOITEM(rbto, rbt->rbt_minmax[direction]);
967b6cbf720SGianluca Guida #else
968b6cbf720SGianluca Guida self = rbt->rbt_root;
969b6cbf720SGianluca Guida if (RB_SENTINEL_P(self))
970b6cbf720SGianluca Guida return NULL;
971b6cbf720SGianluca Guida while (!RB_SENTINEL_P(self->rb_nodes[direction]))
972b6cbf720SGianluca Guida self = self->rb_nodes[direction];
973b6cbf720SGianluca Guida return RB_NODETOITEM(rbto, self);
974b6cbf720SGianluca Guida #endif /* !RBSMALL */
975b6cbf720SGianluca Guida }
976b6cbf720SGianluca Guida self = RB_ITEMTONODE(rbto, object);
977b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(self));
978b6cbf720SGianluca Guida /*
979b6cbf720SGianluca Guida * We can't go any further in this direction. We proceed up in the
980b6cbf720SGianluca Guida * opposite direction until our parent is in direction we want to go.
981b6cbf720SGianluca Guida */
982b6cbf720SGianluca Guida if (RB_SENTINEL_P(self->rb_nodes[direction])) {
983b6cbf720SGianluca Guida while (!RB_ROOT_P(rbt, self)) {
984b6cbf720SGianluca Guida if (other == RB_POSITION(self))
985b6cbf720SGianluca Guida return RB_NODETOITEM(rbto, RB_FATHER(self));
986b6cbf720SGianluca Guida self = RB_FATHER(self);
987b6cbf720SGianluca Guida }
988b6cbf720SGianluca Guida return NULL;
989b6cbf720SGianluca Guida }
990b6cbf720SGianluca Guida
991b6cbf720SGianluca Guida /*
992b6cbf720SGianluca Guida * Advance down one in current direction and go down as far as possible
993b6cbf720SGianluca Guida * in the opposite direction.
994b6cbf720SGianluca Guida */
995b6cbf720SGianluca Guida self = self->rb_nodes[direction];
996b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(self));
997b6cbf720SGianluca Guida while (!RB_SENTINEL_P(self->rb_nodes[other]))
998b6cbf720SGianluca Guida self = self->rb_nodes[other];
999b6cbf720SGianluca Guida return RB_NODETOITEM(rbto, self);
1000b6cbf720SGianluca Guida }
1001b6cbf720SGianluca Guida
1002b6cbf720SGianluca Guida #ifdef RBDEBUG
1003b6cbf720SGianluca Guida static const struct rb_node *
rb_tree_iterate_const(const struct rb_tree * rbt,const struct rb_node * self,const unsigned int direction)1004b6cbf720SGianluca Guida rb_tree_iterate_const(const struct rb_tree *rbt, const struct rb_node *self,
1005b6cbf720SGianluca Guida const unsigned int direction)
1006b6cbf720SGianluca Guida {
1007b6cbf720SGianluca Guida const unsigned int other = direction ^ RB_DIR_OTHER;
1008b6cbf720SGianluca Guida KASSERT(direction == RB_DIR_LEFT || direction == RB_DIR_RIGHT);
1009b6cbf720SGianluca Guida
1010b6cbf720SGianluca Guida if (self == NULL) {
1011b6cbf720SGianluca Guida #ifndef RBSMALL
1012b6cbf720SGianluca Guida if (RB_SENTINEL_P(rbt->rbt_root))
1013b6cbf720SGianluca Guida return NULL;
1014b6cbf720SGianluca Guida return rbt->rbt_minmax[direction];
1015b6cbf720SGianluca Guida #else
1016b6cbf720SGianluca Guida self = rbt->rbt_root;
1017b6cbf720SGianluca Guida if (RB_SENTINEL_P(self))
1018b6cbf720SGianluca Guida return NULL;
1019b6cbf720SGianluca Guida while (!RB_SENTINEL_P(self->rb_nodes[direction]))
1020b6cbf720SGianluca Guida self = self->rb_nodes[direction];
1021b6cbf720SGianluca Guida return self;
1022b6cbf720SGianluca Guida #endif /* !RBSMALL */
1023b6cbf720SGianluca Guida }
1024b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(self));
1025b6cbf720SGianluca Guida /*
1026b6cbf720SGianluca Guida * We can't go any further in this direction. We proceed up in the
1027b6cbf720SGianluca Guida * opposite direction until our parent is in direction we want to go.
1028b6cbf720SGianluca Guida */
1029b6cbf720SGianluca Guida if (RB_SENTINEL_P(self->rb_nodes[direction])) {
1030b6cbf720SGianluca Guida while (!RB_ROOT_P(rbt, self)) {
1031b6cbf720SGianluca Guida if (other == RB_POSITION(self))
1032b6cbf720SGianluca Guida return RB_FATHER(self);
1033b6cbf720SGianluca Guida self = RB_FATHER(self);
1034b6cbf720SGianluca Guida }
1035b6cbf720SGianluca Guida return NULL;
1036b6cbf720SGianluca Guida }
1037b6cbf720SGianluca Guida
1038b6cbf720SGianluca Guida /*
1039b6cbf720SGianluca Guida * Advance down one in current direction and go down as far as possible
1040b6cbf720SGianluca Guida * in the opposite direction.
1041b6cbf720SGianluca Guida */
1042b6cbf720SGianluca Guida self = self->rb_nodes[direction];
1043b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(self));
1044b6cbf720SGianluca Guida while (!RB_SENTINEL_P(self->rb_nodes[other]))
1045b6cbf720SGianluca Guida self = self->rb_nodes[other];
1046b6cbf720SGianluca Guida return self;
1047b6cbf720SGianluca Guida }
1048b6cbf720SGianluca Guida
1049b6cbf720SGianluca Guida static unsigned int
rb_tree_count_black(const struct rb_node * self)1050b6cbf720SGianluca Guida rb_tree_count_black(const struct rb_node *self)
1051b6cbf720SGianluca Guida {
1052b6cbf720SGianluca Guida unsigned int left, right;
1053b6cbf720SGianluca Guida
1054b6cbf720SGianluca Guida if (RB_SENTINEL_P(self))
1055b6cbf720SGianluca Guida return 0;
1056b6cbf720SGianluca Guida
1057b6cbf720SGianluca Guida left = rb_tree_count_black(self->rb_left);
1058b6cbf720SGianluca Guida right = rb_tree_count_black(self->rb_right);
1059b6cbf720SGianluca Guida
1060b6cbf720SGianluca Guida KASSERT(left == right);
1061b6cbf720SGianluca Guida
1062b6cbf720SGianluca Guida return left + RB_BLACK_P(self);
1063b6cbf720SGianluca Guida }
1064b6cbf720SGianluca Guida
1065b6cbf720SGianluca Guida static bool
rb_tree_check_node(const struct rb_tree * rbt,const struct rb_node * self,const struct rb_node * prev,bool red_check)1066b6cbf720SGianluca Guida rb_tree_check_node(const struct rb_tree *rbt, const struct rb_node *self,
1067b6cbf720SGianluca Guida const struct rb_node *prev, bool red_check)
1068b6cbf720SGianluca Guida {
1069b6cbf720SGianluca Guida const rb_tree_ops_t *rbto = rbt->rbt_ops;
1070b6cbf720SGianluca Guida rbto_compare_nodes_fn compare_nodes = rbto->rbto_compare_nodes;
1071b6cbf720SGianluca Guida
1072b6cbf720SGianluca Guida KASSERT(!RB_SENTINEL_P(self));
1073b6cbf720SGianluca Guida KASSERT(prev == NULL || (*compare_nodes)(rbto->rbto_context,
1074b6cbf720SGianluca Guida RB_NODETOITEM(rbto, prev), RB_NODETOITEM(rbto, self)) < 0);
1075b6cbf720SGianluca Guida
1076b6cbf720SGianluca Guida /*
1077b6cbf720SGianluca Guida * Verify our relationship to our parent.
1078b6cbf720SGianluca Guida */
1079b6cbf720SGianluca Guida if (RB_ROOT_P(rbt, self)) {
1080b6cbf720SGianluca Guida KASSERT(self == rbt->rbt_root);
1081b6cbf720SGianluca Guida KASSERT(RB_POSITION(self) == RB_DIR_LEFT);
1082b6cbf720SGianluca Guida KASSERT(RB_FATHER(self)->rb_nodes[RB_DIR_LEFT] == self);
1083b6cbf720SGianluca Guida KASSERT(RB_FATHER(self) == (const struct rb_node *) &rbt->rbt_root);
1084b6cbf720SGianluca Guida } else {
1085b6cbf720SGianluca Guida int diff = (*compare_nodes)(rbto->rbto_context,
1086b6cbf720SGianluca Guida RB_NODETOITEM(rbto, self),
1087b6cbf720SGianluca Guida RB_NODETOITEM(rbto, RB_FATHER(self)));
1088b6cbf720SGianluca Guida
1089b6cbf720SGianluca Guida KASSERT(self != rbt->rbt_root);
1090b6cbf720SGianluca Guida KASSERT(!RB_FATHER_SENTINEL_P(self));
1091b6cbf720SGianluca Guida if (RB_POSITION(self) == RB_DIR_LEFT) {
1092b6cbf720SGianluca Guida KASSERT(diff < 0);
1093b6cbf720SGianluca Guida KASSERT(RB_FATHER(self)->rb_nodes[RB_DIR_LEFT] == self);
1094b6cbf720SGianluca Guida } else {
1095b6cbf720SGianluca Guida KASSERT(diff > 0);
1096b6cbf720SGianluca Guida KASSERT(RB_FATHER(self)->rb_nodes[RB_DIR_RIGHT] == self);
1097b6cbf720SGianluca Guida }
1098b6cbf720SGianluca Guida }
1099b6cbf720SGianluca Guida
1100b6cbf720SGianluca Guida /*
1101b6cbf720SGianluca Guida * Verify our position in the linked list against the tree itself.
1102b6cbf720SGianluca Guida */
1103b6cbf720SGianluca Guida {
1104b6cbf720SGianluca Guida const struct rb_node *prev0 = rb_tree_iterate_const(rbt, self, RB_DIR_LEFT);
1105b6cbf720SGianluca Guida const struct rb_node *next0 = rb_tree_iterate_const(rbt, self, RB_DIR_RIGHT);
1106b6cbf720SGianluca Guida KASSERT(prev0 == TAILQ_PREV(self, rb_node_qh, rb_link));
1107b6cbf720SGianluca Guida KASSERT(next0 == TAILQ_NEXT(self, rb_link));
1108b6cbf720SGianluca Guida #ifndef RBSMALL
1109b6cbf720SGianluca Guida KASSERT(prev0 != NULL || self == rbt->rbt_minmax[RB_DIR_LEFT]);
1110b6cbf720SGianluca Guida KASSERT(next0 != NULL || self == rbt->rbt_minmax[RB_DIR_RIGHT]);
1111b6cbf720SGianluca Guida #endif
1112b6cbf720SGianluca Guida }
1113b6cbf720SGianluca Guida
1114b6cbf720SGianluca Guida /*
1115b6cbf720SGianluca Guida * The root must be black.
1116b6cbf720SGianluca Guida * There can never be two adjacent red nodes.
1117b6cbf720SGianluca Guida */
1118b6cbf720SGianluca Guida if (red_check) {
1119b6cbf720SGianluca Guida KASSERT(!RB_ROOT_P(rbt, self) || RB_BLACK_P(self));
1120b6cbf720SGianluca Guida (void) rb_tree_count_black(self);
1121b6cbf720SGianluca Guida if (RB_RED_P(self)) {
1122b6cbf720SGianluca Guida const struct rb_node *brother;
1123b6cbf720SGianluca Guida KASSERT(!RB_ROOT_P(rbt, self));
1124b6cbf720SGianluca Guida brother = RB_FATHER(self)->rb_nodes[RB_POSITION(self) ^ RB_DIR_OTHER];
1125b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(RB_FATHER(self)));
1126b6cbf720SGianluca Guida /*
1127b6cbf720SGianluca Guida * I'm red and have no children, then I must either
1128b6cbf720SGianluca Guida * have no brother or my brother also be red and
1129b6cbf720SGianluca Guida * also have no children. (black count == 0)
1130b6cbf720SGianluca Guida */
1131b6cbf720SGianluca Guida KASSERT(!RB_CHILDLESS_P(self)
1132b6cbf720SGianluca Guida || RB_SENTINEL_P(brother)
1133b6cbf720SGianluca Guida || RB_RED_P(brother)
1134b6cbf720SGianluca Guida || RB_CHILDLESS_P(brother));
1135b6cbf720SGianluca Guida /*
1136b6cbf720SGianluca Guida * If I'm not childless, I must have two children
1137b6cbf720SGianluca Guida * and they must be both be black.
1138b6cbf720SGianluca Guida */
1139b6cbf720SGianluca Guida KASSERT(RB_CHILDLESS_P(self)
1140b6cbf720SGianluca Guida || (RB_TWOCHILDREN_P(self)
1141b6cbf720SGianluca Guida && RB_BLACK_P(self->rb_left)
1142b6cbf720SGianluca Guida && RB_BLACK_P(self->rb_right)));
1143b6cbf720SGianluca Guida /*
1144b6cbf720SGianluca Guida * If I'm not childless, thus I have black children,
1145b6cbf720SGianluca Guida * then my brother must either be black or have two
1146b6cbf720SGianluca Guida * black children.
1147b6cbf720SGianluca Guida */
1148b6cbf720SGianluca Guida KASSERT(RB_CHILDLESS_P(self)
1149b6cbf720SGianluca Guida || RB_BLACK_P(brother)
1150b6cbf720SGianluca Guida || (RB_TWOCHILDREN_P(brother)
1151b6cbf720SGianluca Guida && RB_BLACK_P(brother->rb_left)
1152b6cbf720SGianluca Guida && RB_BLACK_P(brother->rb_right)));
1153b6cbf720SGianluca Guida } else {
1154b6cbf720SGianluca Guida /*
1155b6cbf720SGianluca Guida * If I'm black and have one child, that child must
1156b6cbf720SGianluca Guida * be red and childless.
1157b6cbf720SGianluca Guida */
1158b6cbf720SGianluca Guida KASSERT(RB_CHILDLESS_P(self)
1159b6cbf720SGianluca Guida || RB_TWOCHILDREN_P(self)
1160b6cbf720SGianluca Guida || (!RB_LEFT_SENTINEL_P(self)
1161b6cbf720SGianluca Guida && RB_RIGHT_SENTINEL_P(self)
1162b6cbf720SGianluca Guida && RB_RED_P(self->rb_left)
1163b6cbf720SGianluca Guida && RB_CHILDLESS_P(self->rb_left))
1164b6cbf720SGianluca Guida || (!RB_RIGHT_SENTINEL_P(self)
1165b6cbf720SGianluca Guida && RB_LEFT_SENTINEL_P(self)
1166b6cbf720SGianluca Guida && RB_RED_P(self->rb_right)
1167b6cbf720SGianluca Guida && RB_CHILDLESS_P(self->rb_right)));
1168b6cbf720SGianluca Guida
1169b6cbf720SGianluca Guida /*
1170b6cbf720SGianluca Guida * If I'm a childless black node and my parent is
1171b6cbf720SGianluca Guida * black, my 2nd closet relative away from my parent
1172b6cbf720SGianluca Guida * is either red or has a red parent or red children.
1173b6cbf720SGianluca Guida */
1174b6cbf720SGianluca Guida if (!RB_ROOT_P(rbt, self)
1175b6cbf720SGianluca Guida && RB_CHILDLESS_P(self)
1176b6cbf720SGianluca Guida && RB_BLACK_P(RB_FATHER(self))) {
1177b6cbf720SGianluca Guida const unsigned int which = RB_POSITION(self);
1178b6cbf720SGianluca Guida const unsigned int other = which ^ RB_DIR_OTHER;
1179b6cbf720SGianluca Guida const struct rb_node *relative0, *relative;
1180b6cbf720SGianluca Guida
1181b6cbf720SGianluca Guida relative0 = rb_tree_iterate_const(rbt,
1182b6cbf720SGianluca Guida self, other);
1183b6cbf720SGianluca Guida KASSERT(relative0 != NULL);
1184b6cbf720SGianluca Guida relative = rb_tree_iterate_const(rbt,
1185b6cbf720SGianluca Guida relative0, other);
1186b6cbf720SGianluca Guida KASSERT(relative != NULL);
1187b6cbf720SGianluca Guida KASSERT(RB_SENTINEL_P(relative->rb_nodes[which]));
1188b6cbf720SGianluca Guida #if 0
1189b6cbf720SGianluca Guida KASSERT(RB_RED_P(relative)
1190b6cbf720SGianluca Guida || RB_RED_P(relative->rb_left)
1191b6cbf720SGianluca Guida || RB_RED_P(relative->rb_right)
1192b6cbf720SGianluca Guida || RB_RED_P(RB_FATHER(relative)));
1193b6cbf720SGianluca Guida #endif
1194b6cbf720SGianluca Guida }
1195b6cbf720SGianluca Guida }
1196b6cbf720SGianluca Guida /*
1197b6cbf720SGianluca Guida * A grandparent's children must be real nodes and not
1198b6cbf720SGianluca Guida * sentinels. First check out grandparent.
1199b6cbf720SGianluca Guida */
1200b6cbf720SGianluca Guida KASSERT(RB_ROOT_P(rbt, self)
1201b6cbf720SGianluca Guida || RB_ROOT_P(rbt, RB_FATHER(self))
1202b6cbf720SGianluca Guida || RB_TWOCHILDREN_P(RB_FATHER(RB_FATHER(self))));
1203b6cbf720SGianluca Guida /*
1204b6cbf720SGianluca Guida * If we are have grandchildren on our left, then
1205b6cbf720SGianluca Guida * we must have a child on our right.
1206b6cbf720SGianluca Guida */
1207b6cbf720SGianluca Guida KASSERT(RB_LEFT_SENTINEL_P(self)
1208b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_left)
1209b6cbf720SGianluca Guida || !RB_RIGHT_SENTINEL_P(self));
1210b6cbf720SGianluca Guida /*
1211b6cbf720SGianluca Guida * If we are have grandchildren on our right, then
1212b6cbf720SGianluca Guida * we must have a child on our left.
1213b6cbf720SGianluca Guida */
1214b6cbf720SGianluca Guida KASSERT(RB_RIGHT_SENTINEL_P(self)
1215b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_right)
1216b6cbf720SGianluca Guida || !RB_LEFT_SENTINEL_P(self));
1217b6cbf720SGianluca Guida
1218b6cbf720SGianluca Guida /*
1219b6cbf720SGianluca Guida * If we have a child on the left and it doesn't have two
1220b6cbf720SGianluca Guida * children make sure we don't have great-great-grandchildren on
1221b6cbf720SGianluca Guida * the right.
1222b6cbf720SGianluca Guida */
1223b6cbf720SGianluca Guida KASSERT(RB_TWOCHILDREN_P(self->rb_left)
1224b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_right)
1225b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_right->rb_left)
1226b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_right->rb_left->rb_left)
1227b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_right->rb_left->rb_right)
1228b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_right->rb_right)
1229b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_right->rb_right->rb_left)
1230b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_right->rb_right->rb_right));
1231b6cbf720SGianluca Guida
1232b6cbf720SGianluca Guida /*
1233b6cbf720SGianluca Guida * If we have a child on the right and it doesn't have two
1234b6cbf720SGianluca Guida * children make sure we don't have great-great-grandchildren on
1235b6cbf720SGianluca Guida * the left.
1236b6cbf720SGianluca Guida */
1237b6cbf720SGianluca Guida KASSERT(RB_TWOCHILDREN_P(self->rb_right)
1238b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_left)
1239b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_left->rb_left)
1240b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_left->rb_left->rb_left)
1241b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_left->rb_left->rb_right)
1242b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_left->rb_right)
1243b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_left->rb_right->rb_left)
1244b6cbf720SGianluca Guida || RB_CHILDLESS_P(self->rb_left->rb_right->rb_right));
1245b6cbf720SGianluca Guida
1246b6cbf720SGianluca Guida /*
1247b6cbf720SGianluca Guida * If we are fully interior node, then our predecessors and
1248b6cbf720SGianluca Guida * successors must have no children in our direction.
1249b6cbf720SGianluca Guida */
1250b6cbf720SGianluca Guida if (RB_TWOCHILDREN_P(self)) {
1251b6cbf720SGianluca Guida const struct rb_node *prev0;
1252b6cbf720SGianluca Guida const struct rb_node *next0;
1253b6cbf720SGianluca Guida
1254b6cbf720SGianluca Guida prev0 = rb_tree_iterate_const(rbt, self, RB_DIR_LEFT);
1255b6cbf720SGianluca Guida KASSERT(prev0 != NULL);
1256b6cbf720SGianluca Guida KASSERT(RB_RIGHT_SENTINEL_P(prev0));
1257b6cbf720SGianluca Guida
1258b6cbf720SGianluca Guida next0 = rb_tree_iterate_const(rbt, self, RB_DIR_RIGHT);
1259b6cbf720SGianluca Guida KASSERT(next0 != NULL);
1260b6cbf720SGianluca Guida KASSERT(RB_LEFT_SENTINEL_P(next0));
1261b6cbf720SGianluca Guida }
1262b6cbf720SGianluca Guida }
1263b6cbf720SGianluca Guida
1264b6cbf720SGianluca Guida return true;
1265b6cbf720SGianluca Guida }
1266b6cbf720SGianluca Guida
1267b6cbf720SGianluca Guida void
rb_tree_check(const struct rb_tree * rbt,bool red_check)1268b6cbf720SGianluca Guida rb_tree_check(const struct rb_tree *rbt, bool red_check)
1269b6cbf720SGianluca Guida {
1270b6cbf720SGianluca Guida const struct rb_node *self;
1271b6cbf720SGianluca Guida const struct rb_node *prev;
1272b6cbf720SGianluca Guida #ifdef RBSTATS
1273b6cbf720SGianluca Guida unsigned int count = 0;
1274b6cbf720SGianluca Guida #endif
1275b6cbf720SGianluca Guida
1276b6cbf720SGianluca Guida KASSERT(rbt->rbt_root != NULL);
1277b6cbf720SGianluca Guida KASSERT(RB_LEFT_P(rbt->rbt_root));
1278b6cbf720SGianluca Guida
1279b6cbf720SGianluca Guida #if defined(RBSTATS) && !defined(RBSMALL)
1280b6cbf720SGianluca Guida KASSERT(rbt->rbt_count > 1
1281b6cbf720SGianluca Guida || rbt->rbt_minmax[RB_DIR_LEFT] == rbt->rbt_minmax[RB_DIR_RIGHT]);
1282b6cbf720SGianluca Guida #endif
1283b6cbf720SGianluca Guida
1284b6cbf720SGianluca Guida prev = NULL;
1285b6cbf720SGianluca Guida TAILQ_FOREACH(self, &rbt->rbt_nodes, rb_link) {
1286b6cbf720SGianluca Guida rb_tree_check_node(rbt, self, prev, false);
1287b6cbf720SGianluca Guida #ifdef RBSTATS
1288b6cbf720SGianluca Guida count++;
1289b6cbf720SGianluca Guida #endif
1290b6cbf720SGianluca Guida }
1291b6cbf720SGianluca Guida #ifdef RBSTATS
1292b6cbf720SGianluca Guida KASSERT(rbt->rbt_count == count);
1293b6cbf720SGianluca Guida #endif
1294b6cbf720SGianluca Guida if (red_check) {
1295b6cbf720SGianluca Guida KASSERT(RB_BLACK_P(rbt->rbt_root));
1296b6cbf720SGianluca Guida KASSERT(RB_SENTINEL_P(rbt->rbt_root)
1297b6cbf720SGianluca Guida || rb_tree_count_black(rbt->rbt_root));
1298b6cbf720SGianluca Guida
1299b6cbf720SGianluca Guida /*
1300b6cbf720SGianluca Guida * The root must be black.
1301b6cbf720SGianluca Guida * There can never be two adjacent red nodes.
1302b6cbf720SGianluca Guida */
1303b6cbf720SGianluca Guida TAILQ_FOREACH(self, &rbt->rbt_nodes, rb_link) {
1304b6cbf720SGianluca Guida rb_tree_check_node(rbt, self, NULL, true);
1305b6cbf720SGianluca Guida }
1306b6cbf720SGianluca Guida }
1307b6cbf720SGianluca Guida }
1308b6cbf720SGianluca Guida #endif /* RBDEBUG */
1309b6cbf720SGianluca Guida
1310b6cbf720SGianluca Guida #ifdef RBSTATS
1311b6cbf720SGianluca Guida static void
rb_tree_mark_depth(const struct rb_tree * rbt,const struct rb_node * self,size_t * depths,size_t depth)1312b6cbf720SGianluca Guida rb_tree_mark_depth(const struct rb_tree *rbt, const struct rb_node *self,
1313b6cbf720SGianluca Guida size_t *depths, size_t depth)
1314b6cbf720SGianluca Guida {
1315b6cbf720SGianluca Guida if (RB_SENTINEL_P(self))
1316b6cbf720SGianluca Guida return;
1317b6cbf720SGianluca Guida
1318b6cbf720SGianluca Guida if (RB_TWOCHILDREN_P(self)) {
1319b6cbf720SGianluca Guida rb_tree_mark_depth(rbt, self->rb_left, depths, depth + 1);
1320b6cbf720SGianluca Guida rb_tree_mark_depth(rbt, self->rb_right, depths, depth + 1);
1321b6cbf720SGianluca Guida return;
1322b6cbf720SGianluca Guida }
1323b6cbf720SGianluca Guida depths[depth]++;
1324b6cbf720SGianluca Guida if (!RB_LEFT_SENTINEL_P(self)) {
1325b6cbf720SGianluca Guida rb_tree_mark_depth(rbt, self->rb_left, depths, depth + 1);
1326b6cbf720SGianluca Guida }
1327b6cbf720SGianluca Guida if (!RB_RIGHT_SENTINEL_P(self)) {
1328b6cbf720SGianluca Guida rb_tree_mark_depth(rbt, self->rb_right, depths, depth + 1);
1329b6cbf720SGianluca Guida }
1330b6cbf720SGianluca Guida }
1331b6cbf720SGianluca Guida
1332b6cbf720SGianluca Guida void
rb_tree_depths(const struct rb_tree * rbt,size_t * depths)1333b6cbf720SGianluca Guida rb_tree_depths(const struct rb_tree *rbt, size_t *depths)
1334b6cbf720SGianluca Guida {
1335b6cbf720SGianluca Guida rb_tree_mark_depth(rbt, rbt->rbt_root, depths, 1);
1336b6cbf720SGianluca Guida }
1337b6cbf720SGianluca Guida #endif /* RBSTATS */
1338