1 /* $NetBSD: tree.h,v 1.8 2004/03/28 19:38:30 provos Exp $ */
2 /* $OpenBSD: tree.h,v 1.7 2002/10/17 21:51:54 art Exp $ */
3 /* $DragonFly: src/sys/sys/tree.h,v 1.11 2008/01/07 01:22:30 corecode Exp $ */
5 * Copyright 2002 Niels Provos <provos@citi.umich.edu>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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 the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 #ifndef _SYS_SPINLOCK_H_
33 #include <sys/spinlock.h>
36 void rb_spin_lock(struct spinlock *spin);
37 void rb_spin_unlock(struct spinlock *spin);
40 * This file defines data structures for different types of trees:
41 * splay trees and red-black trees.
43 * A splay tree is a self-organizing data structure. Every operation
44 * on the tree causes a splay to happen. The splay moves the requested
45 * node to the root of the tree and partly rebalances it.
47 * This has the benefit that request locality causes faster lookups as
48 * the requested nodes move to the top of the tree. On the other hand,
49 * every lookup causes memory writes.
51 * The Balance Theorem bounds the total access time for m operations
52 * and n inserts on an initially empty tree as O((m + n)lg n). The
53 * amortized cost for a sequence of m accesses to a splay tree is O(lg n);
55 * A red-black tree is a binary search tree with the node color as an
56 * extra attribute. It fulfills a set of conditions:
57 * - every search path from the root to a leaf consists of the
58 * same number of black nodes,
59 * - each red node (except for the root) has a black parent,
60 * - each leaf node is black.
62 * Every operation on a red-black tree is bounded as O(lg n).
63 * The maximum height of a red-black tree is 2lg (n+1).
66 #define SPLAY_HEAD(name, type) \
68 struct type *sph_root; /* root of the tree */ \
71 #define SPLAY_INITIALIZER(root) \
74 #define SPLAY_INIT(root) do { \
75 (root)->sph_root = NULL; \
76 } while (/*CONSTCOND*/ 0)
78 #define SPLAY_ENTRY(type) \
80 struct type *spe_left; /* left element */ \
81 struct type *spe_right; /* right element */ \
84 #define SPLAY_LEFT(elm, field) (elm)->field.spe_left
85 #define SPLAY_RIGHT(elm, field) (elm)->field.spe_right
86 #define SPLAY_ROOT(head) (head)->sph_root
87 #define SPLAY_EMPTY(head) (SPLAY_ROOT(head) == NULL)
89 /* SPLAY_ROTATE_{LEFT,RIGHT} expect that tmp hold SPLAY_{RIGHT,LEFT} */
90 #define SPLAY_ROTATE_RIGHT(head, tmp, field) do { \
91 SPLAY_LEFT((head)->sph_root, field) = SPLAY_RIGHT(tmp, field); \
92 SPLAY_RIGHT(tmp, field) = (head)->sph_root; \
93 (head)->sph_root = tmp; \
94 } while (/*CONSTCOND*/ 0)
96 #define SPLAY_ROTATE_LEFT(head, tmp, field) do { \
97 SPLAY_RIGHT((head)->sph_root, field) = SPLAY_LEFT(tmp, field); \
98 SPLAY_LEFT(tmp, field) = (head)->sph_root; \
99 (head)->sph_root = tmp; \
100 } while (/*CONSTCOND*/ 0)
102 #define SPLAY_LINKLEFT(head, tmp, field) do { \
103 SPLAY_LEFT(tmp, field) = (head)->sph_root; \
104 tmp = (head)->sph_root; \
105 (head)->sph_root = SPLAY_LEFT((head)->sph_root, field); \
106 } while (/*CONSTCOND*/ 0)
108 #define SPLAY_LINKRIGHT(head, tmp, field) do { \
109 SPLAY_RIGHT(tmp, field) = (head)->sph_root; \
110 tmp = (head)->sph_root; \
111 (head)->sph_root = SPLAY_RIGHT((head)->sph_root, field); \
112 } while (/*CONSTCOND*/ 0)
114 #define SPLAY_ASSEMBLE(head, node, left, right, field) do { \
115 SPLAY_RIGHT(left, field) = SPLAY_LEFT((head)->sph_root, field); \
116 SPLAY_LEFT(right, field) = SPLAY_RIGHT((head)->sph_root, field);\
117 SPLAY_LEFT((head)->sph_root, field) = SPLAY_RIGHT(node, field); \
118 SPLAY_RIGHT((head)->sph_root, field) = SPLAY_LEFT(node, field); \
119 } while (/*CONSTCOND*/ 0)
121 /* Generates prototypes and inline functions */
123 #define SPLAY_PROTOTYPE(name, type, field, cmp) \
124 void name##_SPLAY(struct name *, struct type *); \
125 void name##_SPLAY_MINMAX(struct name *, int); \
126 struct type *name##_SPLAY_INSERT(struct name *, struct type *); \
127 struct type *name##_SPLAY_REMOVE(struct name *, struct type *); \
129 /* Finds the node with the same key as elm */ \
130 static __inline struct type * \
131 name##_SPLAY_FIND(struct name *head, struct type *elm) \
133 if (SPLAY_EMPTY(head)) \
135 name##_SPLAY(head, elm); \
136 if ((cmp)(elm, (head)->sph_root) == 0) \
137 return (head->sph_root); \
141 static __inline struct type * \
142 name##_SPLAY_NEXT(struct name *head, struct type *elm) \
144 name##_SPLAY(head, elm); \
145 if (SPLAY_RIGHT(elm, field) != NULL) { \
146 elm = SPLAY_RIGHT(elm, field); \
147 while (SPLAY_LEFT(elm, field) != NULL) { \
148 elm = SPLAY_LEFT(elm, field); \
155 static __inline struct type * \
156 name##_SPLAY_MIN_MAX(struct name *head, int val) \
158 name##_SPLAY_MINMAX(head, val); \
159 return (SPLAY_ROOT(head)); \
162 /* Main splay operation.
163 * Moves node close to the key of elm to top
165 #define SPLAY_GENERATE(name, type, field, cmp) \
167 name##_SPLAY_INSERT(struct name *head, struct type *elm) \
169 if (SPLAY_EMPTY(head)) { \
170 SPLAY_LEFT(elm, field) = SPLAY_RIGHT(elm, field) = NULL; \
173 name##_SPLAY(head, elm); \
174 __comp = (cmp)(elm, (head)->sph_root); \
176 SPLAY_LEFT(elm, field) = SPLAY_LEFT((head)->sph_root, field);\
177 SPLAY_RIGHT(elm, field) = (head)->sph_root; \
178 SPLAY_LEFT((head)->sph_root, field) = NULL; \
179 } else if (__comp > 0) { \
180 SPLAY_RIGHT(elm, field) = SPLAY_RIGHT((head)->sph_root, field);\
181 SPLAY_LEFT(elm, field) = (head)->sph_root; \
182 SPLAY_RIGHT((head)->sph_root, field) = NULL; \
184 return ((head)->sph_root); \
186 (head)->sph_root = (elm); \
191 name##_SPLAY_REMOVE(struct name *head, struct type *elm) \
193 struct type *__tmp; \
194 if (SPLAY_EMPTY(head)) \
196 name##_SPLAY(head, elm); \
197 if ((cmp)(elm, (head)->sph_root) == 0) { \
198 if (SPLAY_LEFT((head)->sph_root, field) == NULL) { \
199 (head)->sph_root = SPLAY_RIGHT((head)->sph_root, field);\
201 __tmp = SPLAY_RIGHT((head)->sph_root, field); \
202 (head)->sph_root = SPLAY_LEFT((head)->sph_root, field);\
203 name##_SPLAY(head, elm); \
204 SPLAY_RIGHT((head)->sph_root, field) = __tmp; \
212 name##_SPLAY(struct name *head, struct type *elm) \
214 struct type __node, *__left, *__right, *__tmp; \
217 SPLAY_LEFT(&__node, field) = SPLAY_RIGHT(&__node, field) = NULL;\
218 __left = __right = &__node; \
220 while ((__comp = (cmp)(elm, (head)->sph_root)) != 0) { \
222 __tmp = SPLAY_LEFT((head)->sph_root, field); \
225 if ((cmp)(elm, __tmp) < 0){ \
226 SPLAY_ROTATE_RIGHT(head, __tmp, field); \
227 if (SPLAY_LEFT((head)->sph_root, field) == NULL)\
230 SPLAY_LINKLEFT(head, __right, field); \
231 } else if (__comp > 0) { \
232 __tmp = SPLAY_RIGHT((head)->sph_root, field); \
235 if ((cmp)(elm, __tmp) > 0){ \
236 SPLAY_ROTATE_LEFT(head, __tmp, field); \
237 if (SPLAY_RIGHT((head)->sph_root, field) == NULL)\
240 SPLAY_LINKRIGHT(head, __left, field); \
243 SPLAY_ASSEMBLE(head, &__node, __left, __right, field); \
246 /* Splay with either the minimum or the maximum element \
247 * Used to find minimum or maximum element in tree. \
249 void name##_SPLAY_MINMAX(struct name *head, int __comp) \
251 struct type __node, *__left, *__right, *__tmp; \
253 SPLAY_LEFT(&__node, field) = SPLAY_RIGHT(&__node, field) = NULL;\
254 __left = __right = &__node; \
258 __tmp = SPLAY_LEFT((head)->sph_root, field); \
262 SPLAY_ROTATE_RIGHT(head, __tmp, field); \
263 if (SPLAY_LEFT((head)->sph_root, field) == NULL)\
266 SPLAY_LINKLEFT(head, __right, field); \
267 } else if (__comp > 0) { \
268 __tmp = SPLAY_RIGHT((head)->sph_root, field); \
272 SPLAY_ROTATE_LEFT(head, __tmp, field); \
273 if (SPLAY_RIGHT((head)->sph_root, field) == NULL)\
276 SPLAY_LINKRIGHT(head, __left, field); \
279 SPLAY_ASSEMBLE(head, &__node, __left, __right, field); \
282 #define SPLAY_NEGINF -1
285 #define SPLAY_INSERT(name, x, y) name##_SPLAY_INSERT(x, y)
286 #define SPLAY_REMOVE(name, x, y) name##_SPLAY_REMOVE(x, y)
287 #define SPLAY_FIND(name, x, y) name##_SPLAY_FIND(x, y)
288 #define SPLAY_NEXT(name, x, y) name##_SPLAY_NEXT(x, y)
289 #define SPLAY_MIN(name, x) (SPLAY_EMPTY(x) ? NULL \
290 : name##_SPLAY_MIN_MAX(x, SPLAY_NEGINF))
291 #define SPLAY_MAX(name, x) (SPLAY_EMPTY(x) ? NULL \
292 : name##_SPLAY_MIN_MAX(x, SPLAY_INF))
294 #define SPLAY_FOREACH(x, name, head) \
295 for ((x) = SPLAY_MIN(name, head); \
297 (x) = SPLAY_NEXT(name, head, x))
300 * Macros that define a red-black tree
303 #define RB_SCAN_INFO(name, type) \
304 struct name##_scan_info { \
305 struct name##_scan_info *link; \
309 #define RB_HEAD(name, type) \
311 struct type *rbh_root; /* root of the tree */ \
312 struct name##_scan_info *rbh_inprog; /* scans in progress */ \
313 struct spinlock rbh_spin; \
316 #define RB_INITIALIZER(root) \
317 { NULL, NULL, SPINLOCK_INITIALIZER(root.spin) }
319 #define RB_INIT(root) do { \
320 (root)->rbh_root = NULL; \
321 (root)->rbh_inprog = NULL; \
322 } while (/*CONSTCOND*/ 0)
325 #define RB_SCAN_LOCK(spin) rb_spin_lock(spin)
326 #define RB_SCAN_UNLOCK(spin) rb_spin_unlock(spin)
328 #define RB_SCAN_LOCK(spin)
329 #define RB_SCAN_UNLOCK(spin)
334 #define RB_ENTRY(type) \
336 struct type *rbe_left; /* left element */ \
337 struct type *rbe_right; /* right element */ \
338 struct type *rbe_parent; /* parent element */ \
339 int rbe_color; /* node color */ \
342 #define RB_LEFT(elm, field) (elm)->field.rbe_left
343 #define RB_RIGHT(elm, field) (elm)->field.rbe_right
344 #define RB_PARENT(elm, field) (elm)->field.rbe_parent
345 #define RB_COLOR(elm, field) (elm)->field.rbe_color
346 #define RB_ROOT(head) (head)->rbh_root
347 #define RB_INPROG(head) (head)->rbh_inprog
348 #define RB_EMPTY(head) (RB_ROOT(head) == NULL)
350 #define RB_SET(elm, parent, field) do { \
351 RB_PARENT(elm, field) = parent; \
352 RB_LEFT(elm, field) = RB_RIGHT(elm, field) = NULL; \
353 RB_COLOR(elm, field) = RB_RED; \
354 } while (/*CONSTCOND*/ 0)
356 #define RB_SET_BLACKRED(black, red, field) do { \
357 RB_COLOR(black, field) = RB_BLACK; \
358 RB_COLOR(red, field) = RB_RED; \
359 } while (/*CONSTCOND*/ 0)
362 #define RB_AUGMENT(x) do {} while (0)
365 #define RB_ROTATE_LEFT(head, elm, tmp, field) do { \
366 (tmp) = RB_RIGHT(elm, field); \
367 if ((RB_RIGHT(elm, field) = RB_LEFT(tmp, field)) != NULL) { \
368 RB_PARENT(RB_LEFT(tmp, field), field) = (elm); \
371 if ((RB_PARENT(tmp, field) = RB_PARENT(elm, field)) != NULL) { \
372 if ((elm) == RB_LEFT(RB_PARENT(elm, field), field)) \
373 RB_LEFT(RB_PARENT(elm, field), field) = (tmp); \
375 RB_RIGHT(RB_PARENT(elm, field), field) = (tmp); \
377 (head)->rbh_root = (tmp); \
378 RB_LEFT(tmp, field) = (elm); \
379 RB_PARENT(elm, field) = (tmp); \
381 if ((RB_PARENT(tmp, field))) \
382 RB_AUGMENT(RB_PARENT(tmp, field)); \
383 } while (/*CONSTCOND*/ 0)
385 #define RB_ROTATE_RIGHT(head, elm, tmp, field) do { \
386 (tmp) = RB_LEFT(elm, field); \
387 if ((RB_LEFT(elm, field) = RB_RIGHT(tmp, field)) != NULL) { \
388 RB_PARENT(RB_RIGHT(tmp, field), field) = (elm); \
391 if ((RB_PARENT(tmp, field) = RB_PARENT(elm, field)) != NULL) { \
392 if ((elm) == RB_LEFT(RB_PARENT(elm, field), field)) \
393 RB_LEFT(RB_PARENT(elm, field), field) = (tmp); \
395 RB_RIGHT(RB_PARENT(elm, field), field) = (tmp); \
397 (head)->rbh_root = (tmp); \
398 RB_RIGHT(tmp, field) = (elm); \
399 RB_PARENT(elm, field) = (tmp); \
401 if ((RB_PARENT(tmp, field))) \
402 RB_AUGMENT(RB_PARENT(tmp, field)); \
403 } while (/*CONSTCOND*/ 0)
405 /* Generates prototypes and inline functions */
406 #define RB_PROTOTYPE(name, type, field, cmp) \
407 _RB_PROTOTYPE(name, type, field, cmp,)
408 #define RB_PROTOTYPE_STATIC(name, type, field, cmp) \
409 _RB_PROTOTYPE(name, type, field, cmp, __unused static)
411 #define _RB_PROTOTYPE(name, type, field, cmp, STORQUAL) \
412 STORQUAL struct type *name##_RB_REMOVE(struct name *, struct type *); \
413 STORQUAL struct type *name##_RB_INSERT(struct name *, struct type *); \
414 STORQUAL struct type *name##_RB_FIND(struct name *, struct type *); \
415 STORQUAL int name##_RB_SCAN(struct name *, int (*)(struct type *, void *),\
416 int (*)(struct type *, void *), void *); \
417 STORQUAL struct type *name##_RB_NEXT(struct type *); \
418 STORQUAL struct type *name##_RB_PREV(struct type *); \
419 STORQUAL struct type *name##_RB_MINMAX(struct name *, int); \
420 RB_SCAN_INFO(name, type) \
423 * A version which supplies a fast lookup routine for an exact match
424 * on a numeric field.
426 #define RB_PROTOTYPE2(name, type, field, cmp, datatype) \
427 RB_PROTOTYPE(name, type, field, cmp); \
428 struct type *name##_RB_LOOKUP(struct name *, datatype) \
431 * A version which supplies a fast lookup routine for a numeric
432 * field which resides within a ranged object, either using (begin,end),
433 * or using (begin,size).
435 #define RB_PROTOTYPE3(name, type, field, cmp, datatype) \
436 RB_PROTOTYPE2(name, type, field, cmp, datatype); \
437 struct type *name##_RB_RLOOKUP(struct name *, datatype) \
439 #define RB_PROTOTYPE4(name, type, field, cmp, datatype) \
440 RB_PROTOTYPE2(name, type, field, cmp, datatype); \
441 struct type *name##_RB_RLOOKUP(struct name *, datatype) \
443 #define RB_PROTOTYPEX(name, ext, type, field, cmp, datatype) \
444 RB_PROTOTYPE(name, type, field, cmp); \
445 struct type *name##_RB_LOOKUP_##ext (struct name *, datatype) \
447 /* Main rb operation.
448 * Moves node close to the key of elm to top
450 #define RB_GENERATE(name, type, field, cmp) \
451 _RB_GENERATE(name, type, field, cmp,)
453 #define RB_GENERATE_STATIC(name, type, field, cmp) \
454 _RB_GENERATE(name, type, field, cmp, __unused static)
456 #define _RB_GENERATE(name, type, field, cmp, STORQUAL) \
458 name##_RB_INSERT_COLOR(struct name *head, struct type *elm) \
460 struct type *parent, *gparent, *tmp; \
461 while ((parent = RB_PARENT(elm, field)) != NULL && \
462 RB_COLOR(parent, field) == RB_RED) { \
463 gparent = RB_PARENT(parent, field); \
464 if (parent == RB_LEFT(gparent, field)) { \
465 tmp = RB_RIGHT(gparent, field); \
466 if (tmp && RB_COLOR(tmp, field) == RB_RED) { \
467 RB_COLOR(tmp, field) = RB_BLACK; \
468 RB_SET_BLACKRED(parent, gparent, field);\
472 if (RB_RIGHT(parent, field) == elm) { \
473 RB_ROTATE_LEFT(head, parent, tmp, field);\
478 RB_SET_BLACKRED(parent, gparent, field); \
479 RB_ROTATE_RIGHT(head, gparent, tmp, field); \
481 tmp = RB_LEFT(gparent, field); \
482 if (tmp && RB_COLOR(tmp, field) == RB_RED) { \
483 RB_COLOR(tmp, field) = RB_BLACK; \
484 RB_SET_BLACKRED(parent, gparent, field);\
488 if (RB_LEFT(parent, field) == elm) { \
489 RB_ROTATE_RIGHT(head, parent, tmp, field);\
494 RB_SET_BLACKRED(parent, gparent, field); \
495 RB_ROTATE_LEFT(head, gparent, tmp, field); \
498 RB_COLOR(head->rbh_root, field) = RB_BLACK; \
502 name##_RB_REMOVE_COLOR(struct name *head, struct type *parent, \
506 while ((elm == NULL || RB_COLOR(elm, field) == RB_BLACK) && \
507 elm != RB_ROOT(head)) { \
508 if (RB_LEFT(parent, field) == elm) { \
509 tmp = RB_RIGHT(parent, field); \
510 if (RB_COLOR(tmp, field) == RB_RED) { \
511 RB_SET_BLACKRED(tmp, parent, field); \
512 RB_ROTATE_LEFT(head, parent, tmp, field);\
513 tmp = RB_RIGHT(parent, field); \
515 if ((RB_LEFT(tmp, field) == NULL || \
516 RB_COLOR(RB_LEFT(tmp, field), field) == RB_BLACK) &&\
517 (RB_RIGHT(tmp, field) == NULL || \
518 RB_COLOR(RB_RIGHT(tmp, field), field) == RB_BLACK)) {\
519 RB_COLOR(tmp, field) = RB_RED; \
521 parent = RB_PARENT(elm, field); \
523 if (RB_RIGHT(tmp, field) == NULL || \
524 RB_COLOR(RB_RIGHT(tmp, field), field) == RB_BLACK) {\
525 struct type *oleft; \
526 if ((oleft = RB_LEFT(tmp, field)) \
528 RB_COLOR(oleft, field) = RB_BLACK;\
529 RB_COLOR(tmp, field) = RB_RED; \
530 RB_ROTATE_RIGHT(head, tmp, oleft, field);\
531 tmp = RB_RIGHT(parent, field); \
533 RB_COLOR(tmp, field) = RB_COLOR(parent, field);\
534 RB_COLOR(parent, field) = RB_BLACK; \
535 if (RB_RIGHT(tmp, field)) \
536 RB_COLOR(RB_RIGHT(tmp, field), field) = RB_BLACK;\
537 RB_ROTATE_LEFT(head, parent, tmp, field);\
538 elm = RB_ROOT(head); \
542 tmp = RB_LEFT(parent, field); \
543 if (RB_COLOR(tmp, field) == RB_RED) { \
544 RB_SET_BLACKRED(tmp, parent, field); \
545 RB_ROTATE_RIGHT(head, parent, tmp, field);\
546 tmp = RB_LEFT(parent, field); \
548 if ((RB_LEFT(tmp, field) == NULL || \
549 RB_COLOR(RB_LEFT(tmp, field), field) == RB_BLACK) &&\
550 (RB_RIGHT(tmp, field) == NULL || \
551 RB_COLOR(RB_RIGHT(tmp, field), field) == RB_BLACK)) {\
552 RB_COLOR(tmp, field) = RB_RED; \
554 parent = RB_PARENT(elm, field); \
556 if (RB_LEFT(tmp, field) == NULL || \
557 RB_COLOR(RB_LEFT(tmp, field), field) == RB_BLACK) {\
558 struct type *oright; \
559 if ((oright = RB_RIGHT(tmp, field)) \
561 RB_COLOR(oright, field) = RB_BLACK;\
562 RB_COLOR(tmp, field) = RB_RED; \
563 RB_ROTATE_LEFT(head, tmp, oright, field);\
564 tmp = RB_LEFT(parent, field); \
566 RB_COLOR(tmp, field) = RB_COLOR(parent, field);\
567 RB_COLOR(parent, field) = RB_BLACK; \
568 if (RB_LEFT(tmp, field)) \
569 RB_COLOR(RB_LEFT(tmp, field), field) = RB_BLACK;\
570 RB_ROTATE_RIGHT(head, parent, tmp, field);\
571 elm = RB_ROOT(head); \
577 RB_COLOR(elm, field) = RB_BLACK; \
580 STORQUAL struct type * \
581 name##_RB_REMOVE(struct name *head, struct type *elm) \
583 struct type *child, *parent, *old; \
584 struct name##_scan_info *inprog; \
587 for (inprog = RB_INPROG(head); inprog; inprog = inprog->link) { \
588 if (inprog->node == elm) \
589 inprog->node = RB_NEXT(name, head, elm); \
593 if (RB_LEFT(elm, field) == NULL) \
594 child = RB_RIGHT(elm, field); \
595 else if (RB_RIGHT(elm, field) == NULL) \
596 child = RB_LEFT(elm, field); \
599 elm = RB_RIGHT(elm, field); \
600 while ((left = RB_LEFT(elm, field)) != NULL) \
602 child = RB_RIGHT(elm, field); \
603 parent = RB_PARENT(elm, field); \
604 color = RB_COLOR(elm, field); \
606 RB_PARENT(child, field) = parent; \
608 if (RB_LEFT(parent, field) == elm) \
609 RB_LEFT(parent, field) = child; \
611 RB_RIGHT(parent, field) = child; \
612 RB_AUGMENT(parent); \
614 RB_ROOT(head) = child; \
615 if (RB_PARENT(elm, field) == old) \
617 (elm)->field = (old)->field; \
618 if (RB_PARENT(old, field)) { \
619 if (RB_LEFT(RB_PARENT(old, field), field) == old)\
620 RB_LEFT(RB_PARENT(old, field), field) = elm;\
622 RB_RIGHT(RB_PARENT(old, field), field) = elm;\
623 RB_AUGMENT(RB_PARENT(old, field)); \
625 RB_ROOT(head) = elm; \
626 RB_PARENT(RB_LEFT(old, field), field) = elm; \
627 if (RB_RIGHT(old, field)) \
628 RB_PARENT(RB_RIGHT(old, field), field) = elm; \
633 } while ((left = RB_PARENT(left, field)) != NULL); \
637 parent = RB_PARENT(elm, field); \
638 color = RB_COLOR(elm, field); \
640 RB_PARENT(child, field) = parent; \
642 if (RB_LEFT(parent, field) == elm) \
643 RB_LEFT(parent, field) = child; \
645 RB_RIGHT(parent, field) = child; \
646 RB_AUGMENT(parent); \
648 RB_ROOT(head) = child; \
650 if (color == RB_BLACK) \
651 name##_RB_REMOVE_COLOR(head, parent, child); \
655 /* Inserts a node into the RB tree */ \
656 STORQUAL struct type * \
657 name##_RB_INSERT(struct name *head, struct type *elm) \
660 struct type *parent = NULL; \
662 tmp = RB_ROOT(head); \
665 comp = (cmp)(elm, parent); \
667 tmp = RB_LEFT(tmp, field); \
669 tmp = RB_RIGHT(tmp, field); \
673 RB_SET(elm, parent, field); \
674 if (parent != NULL) { \
676 RB_LEFT(parent, field) = elm; \
678 RB_RIGHT(parent, field) = elm; \
679 RB_AUGMENT(parent); \
681 RB_ROOT(head) = elm; \
682 name##_RB_INSERT_COLOR(head, elm); \
686 /* Finds the node with the same key as elm */ \
687 STORQUAL struct type * \
688 name##_RB_FIND(struct name *head, struct type *elm) \
690 struct type *tmp = RB_ROOT(head); \
693 comp = cmp(elm, tmp); \
695 tmp = RB_LEFT(tmp, field); \
697 tmp = RB_RIGHT(tmp, field); \
705 * Issue a callback for all matching items. The scan function must \
706 * return < 0 for items below the desired range, 0 for items within \
707 * the range, and > 0 for items beyond the range. Any item may be \
708 * deleted while the scan is in progress. \
711 name##_SCANCMP_ALL(struct type *type __unused, void *data __unused) \
716 static __inline void \
717 name##_scan_info_link(struct name##_scan_info *scan, struct name *head) \
719 RB_SCAN_LOCK(&head->rbh_spin); \
720 scan->link = RB_INPROG(head); \
721 RB_INPROG(head) = scan; \
722 RB_SCAN_UNLOCK(&head->rbh_spin); \
725 static __inline void \
726 name##_scan_info_done(struct name##_scan_info *scan, struct name *head) \
728 struct name##_scan_info **infopp; \
730 RB_SCAN_LOCK(&head->rbh_spin); \
731 infopp = &RB_INPROG(head); \
732 while (*infopp != scan) \
733 infopp = &(*infopp)->link; \
734 *infopp = scan->link; \
735 RB_SCAN_UNLOCK(&head->rbh_spin); \
739 name##_RB_SCAN(struct name *head, \
740 int (*scancmp)(struct type *, void *), \
741 int (*callback)(struct type *, void *), \
744 struct name##_scan_info info; \
750 if (scancmp == NULL) \
751 scancmp = name##_SCANCMP_ALL; \
754 * Locate the first element. \
756 tmp = RB_ROOT(head); \
759 comp = scancmp(tmp, data); \
761 tmp = RB_RIGHT(tmp, field); \
762 } else if (comp > 0) { \
763 tmp = RB_LEFT(tmp, field); \
766 if (RB_LEFT(tmp, field) == NULL) \
768 tmp = RB_LEFT(tmp, field); \
773 info.node = RB_NEXT(name, head, best); \
774 name##_scan_info_link(&info, head); \
775 while ((comp = callback(best, data)) >= 0) { \
778 if (best == NULL || scancmp(best, data) != 0) \
780 info.node = RB_NEXT(name, head, best); \
782 name##_scan_info_done(&info, head); \
783 if (comp < 0) /* error or termination */ \
790 STORQUAL struct type * \
791 name##_RB_NEXT(struct type *elm) \
793 if (RB_RIGHT(elm, field)) { \
794 elm = RB_RIGHT(elm, field); \
795 while (RB_LEFT(elm, field)) \
796 elm = RB_LEFT(elm, field); \
798 if (RB_PARENT(elm, field) && \
799 (elm == RB_LEFT(RB_PARENT(elm, field), field))) \
800 elm = RB_PARENT(elm, field); \
802 while (RB_PARENT(elm, field) && \
803 (elm == RB_RIGHT(RB_PARENT(elm, field), field)))\
804 elm = RB_PARENT(elm, field); \
805 elm = RB_PARENT(elm, field); \
812 STORQUAL struct type * \
813 name##_RB_PREV(struct type *elm) \
815 if (RB_LEFT(elm, field)) { \
816 elm = RB_LEFT(elm, field); \
817 while (RB_RIGHT(elm, field)) \
818 elm = RB_RIGHT(elm, field); \
820 if (RB_PARENT(elm, field) && \
821 (elm == RB_RIGHT(RB_PARENT(elm, field), field))) \
822 elm = RB_PARENT(elm, field); \
824 while (RB_PARENT(elm, field) && \
825 (elm == RB_LEFT(RB_PARENT(elm, field), field)))\
826 elm = RB_PARENT(elm, field); \
827 elm = RB_PARENT(elm, field); \
833 STORQUAL struct type * \
834 name##_RB_MINMAX(struct name *head, int val) \
836 struct type *tmp = RB_ROOT(head); \
837 struct type *parent = NULL; \
841 tmp = RB_LEFT(tmp, field); \
843 tmp = RB_RIGHT(tmp, field); \
849 * This extended version implements a fast LOOKUP function given
850 * a numeric data type.
852 * The element whos index/offset field is exactly the specified value
853 * will be returned, or NULL.
855 #define RB_GENERATE2(name, type, field, cmp, datatype, indexfield) \
856 RB_GENERATE(name, type, field, cmp) \
859 name##_RB_LOOKUP(struct name *head, datatype value) \
863 tmp = RB_ROOT(head); \
865 if (value > tmp->indexfield) \
866 tmp = RB_RIGHT(tmp, field); \
867 else if (value < tmp->indexfield) \
868 tmp = RB_LEFT(tmp, field); \
876 * This extended version implements a fast ranged-based LOOKUP function
877 * given a numeric data type, for data types with a beginning and end
878 * (end is inclusive).
880 * The element whos range contains the specified value is returned, or NULL
882 #define RB_GENERATE3(name, type, field, cmp, datatype, begfield, endfield) \
883 RB_GENERATE2(name, type, field, cmp, datatype, begfield) \
886 name##_RB_RLOOKUP(struct name *head, datatype value) \
890 tmp = RB_ROOT(head); \
892 if (value >= tmp->begfield && value <= tmp->endfield) \
894 if (value > tmp->begfield) \
895 tmp = RB_RIGHT(tmp, field); \
897 tmp = RB_LEFT(tmp, field); \
903 * This extended version implements a fast ranged-based LOOKUP function
904 * given a numeric data type, for data types with a beginning and size.
906 * WARNING: The full range of the data type is not supported due to a
907 * boundary condition at the end, where (beginning + size) might overflow.
909 * The element whos range contains the specified value is returned, or NULL
911 #define RB_GENERATE4(name, type, field, cmp, datatype, begfield, sizefield) \
912 RB_GENERATE2(name, type, field, cmp, datatype, begfield) \
915 name##_RB_RLOOKUP(struct name *head, datatype value) \
919 tmp = RB_ROOT(head); \
921 if (value >= tmp->begfield && \
922 value < tmp->begfield + tmp->sizefield) { \
925 if (value > tmp->begfield) \
926 tmp = RB_RIGHT(tmp, field); \
928 tmp = RB_LEFT(tmp, field); \
934 * This generates a custom lookup function for a red-black tree.
935 * Note that the macro may be used with a storage qualifier.
938 #define RB_GENERATE_XLOOKUP(name, ext, type, field, xcmp, datatype) \
939 _RB_GENERATE_XLOOKUP(name, ext, type, field, xcmp, datatype,)
940 #define RB_GENERATE_XLOOKUP_STATIC(name, ext, type, field, xcmp, datatype) \
941 _RB_GENERATE_XLOOKUP(name, ext, type, field, xcmp, datatype, __unused static)
943 #define _RB_GENERATE_XLOOKUP(name, ext, type, field, xcmp, datatype, STORQUAL)\
945 STORQUAL struct type * \
946 name##_RB_LOOKUP_##ext (struct name *head, datatype value) \
951 tmp = RB_ROOT(head); \
953 r = xcmp(value, tmp); \
957 tmp = RB_RIGHT(tmp, field); \
959 tmp = RB_LEFT(tmp, field); \
968 #define RB_INSERT(name, root, elm) name##_RB_INSERT(root, elm)
969 #define RB_REMOVE(name, root, elm) name##_RB_REMOVE(root, elm)
970 #define RB_FIND(name, root, elm) name##_RB_FIND(root, elm)
971 #define RB_LOOKUP(name, root, value) name##_RB_LOOKUP(root, value)
972 #define RB_RLOOKUP(name, root, value) name##_RB_RLOOKUP(root, value)
973 #define RB_SCAN(name, root, cmp, callback, data) \
974 name##_RB_SCAN(root, cmp, callback, data)
975 #define RB_FIRST(name, root) name##_RB_MINMAX(root, RB_NEGINF)
976 #define RB_NEXT(name, root, elm) name##_RB_NEXT(elm)
977 #define RB_PREV(name, root, elm) name##_RB_PREV(elm)
978 #define RB_MIN(name, root) name##_RB_MINMAX(root, RB_NEGINF)
979 #define RB_MAX(name, root) name##_RB_MINMAX(root, RB_INF)
981 #define RB_FOREACH(x, name, head) \
982 for ((x) = RB_MIN(name, head); \
984 (x) = name##_RB_NEXT(x))
986 #endif /* _SYS_TREE_H_ */