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.6 2007/04/19 19:06:01 dillon 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.
33 * This file defines data structures for different types of trees:
34 * splay trees and red-black trees.
36 * A splay tree is a self-organizing data structure. Every operation
37 * on the tree causes a splay to happen. The splay moves the requested
38 * node to the root of the tree and partly rebalances it.
40 * This has the benefit that request locality causes faster lookups as
41 * the requested nodes move to the top of the tree. On the other hand,
42 * every lookup causes memory writes.
44 * The Balance Theorem bounds the total access time for m operations
45 * and n inserts on an initially empty tree as O((m + n)lg n). The
46 * amortized cost for a sequence of m accesses to a splay tree is O(lg n);
48 * A red-black tree is a binary search tree with the node color as an
49 * extra attribute. It fulfills a set of conditions:
50 * - every search path from the root to a leaf consists of the
51 * same number of black nodes,
52 * - each red node (except for the root) has a black parent,
53 * - each leaf node is black.
55 * Every operation on a red-black tree is bounded as O(lg n).
56 * The maximum height of a red-black tree is 2lg (n+1).
59 #define SPLAY_HEAD(name, type) \
61 struct type *sph_root; /* root of the tree */ \
64 #define SPLAY_INITIALIZER(root) \
67 #define SPLAY_INIT(root) do { \
68 (root)->sph_root = NULL; \
69 } while (/*CONSTCOND*/ 0)
71 #define SPLAY_ENTRY(type) \
73 struct type *spe_left; /* left element */ \
74 struct type *spe_right; /* right element */ \
77 #define SPLAY_LEFT(elm, field) (elm)->field.spe_left
78 #define SPLAY_RIGHT(elm, field) (elm)->field.spe_right
79 #define SPLAY_ROOT(head) (head)->sph_root
80 #define SPLAY_EMPTY(head) (SPLAY_ROOT(head) == NULL)
82 /* SPLAY_ROTATE_{LEFT,RIGHT} expect that tmp hold SPLAY_{RIGHT,LEFT} */
83 #define SPLAY_ROTATE_RIGHT(head, tmp, field) do { \
84 SPLAY_LEFT((head)->sph_root, field) = SPLAY_RIGHT(tmp, field); \
85 SPLAY_RIGHT(tmp, field) = (head)->sph_root; \
86 (head)->sph_root = tmp; \
87 } while (/*CONSTCOND*/ 0)
89 #define SPLAY_ROTATE_LEFT(head, tmp, field) do { \
90 SPLAY_RIGHT((head)->sph_root, field) = SPLAY_LEFT(tmp, field); \
91 SPLAY_LEFT(tmp, field) = (head)->sph_root; \
92 (head)->sph_root = tmp; \
93 } while (/*CONSTCOND*/ 0)
95 #define SPLAY_LINKLEFT(head, tmp, field) do { \
96 SPLAY_LEFT(tmp, field) = (head)->sph_root; \
97 tmp = (head)->sph_root; \
98 (head)->sph_root = SPLAY_LEFT((head)->sph_root, field); \
99 } while (/*CONSTCOND*/ 0)
101 #define SPLAY_LINKRIGHT(head, tmp, field) do { \
102 SPLAY_RIGHT(tmp, field) = (head)->sph_root; \
103 tmp = (head)->sph_root; \
104 (head)->sph_root = SPLAY_RIGHT((head)->sph_root, field); \
105 } while (/*CONSTCOND*/ 0)
107 #define SPLAY_ASSEMBLE(head, node, left, right, field) do { \
108 SPLAY_RIGHT(left, field) = SPLAY_LEFT((head)->sph_root, field); \
109 SPLAY_LEFT(right, field) = SPLAY_RIGHT((head)->sph_root, field);\
110 SPLAY_LEFT((head)->sph_root, field) = SPLAY_RIGHT(node, field); \
111 SPLAY_RIGHT((head)->sph_root, field) = SPLAY_LEFT(node, field); \
112 } while (/*CONSTCOND*/ 0)
114 /* Generates prototypes and inline functions */
116 #define SPLAY_PROTOTYPE(name, type, field, cmp) \
117 void name##_SPLAY(struct name *, struct type *); \
118 void name##_SPLAY_MINMAX(struct name *, int); \
119 struct type *name##_SPLAY_INSERT(struct name *, struct type *); \
120 struct type *name##_SPLAY_REMOVE(struct name *, struct type *); \
122 /* Finds the node with the same key as elm */ \
123 static __inline struct type * \
124 name##_SPLAY_FIND(struct name *head, struct type *elm) \
126 if (SPLAY_EMPTY(head)) \
128 name##_SPLAY(head, elm); \
129 if ((cmp)(elm, (head)->sph_root) == 0) \
130 return (head->sph_root); \
134 static __inline struct type * \
135 name##_SPLAY_NEXT(struct name *head, struct type *elm) \
137 name##_SPLAY(head, elm); \
138 if (SPLAY_RIGHT(elm, field) != NULL) { \
139 elm = SPLAY_RIGHT(elm, field); \
140 while (SPLAY_LEFT(elm, field) != NULL) { \
141 elm = SPLAY_LEFT(elm, field); \
148 static __inline struct type * \
149 name##_SPLAY_MIN_MAX(struct name *head, int val) \
151 name##_SPLAY_MINMAX(head, val); \
152 return (SPLAY_ROOT(head)); \
155 /* Main splay operation.
156 * Moves node close to the key of elm to top
158 #define SPLAY_GENERATE(name, type, field, cmp) \
160 name##_SPLAY_INSERT(struct name *head, struct type *elm) \
162 if (SPLAY_EMPTY(head)) { \
163 SPLAY_LEFT(elm, field) = SPLAY_RIGHT(elm, field) = NULL; \
166 name##_SPLAY(head, elm); \
167 __comp = (cmp)(elm, (head)->sph_root); \
169 SPLAY_LEFT(elm, field) = SPLAY_LEFT((head)->sph_root, field);\
170 SPLAY_RIGHT(elm, field) = (head)->sph_root; \
171 SPLAY_LEFT((head)->sph_root, field) = NULL; \
172 } else if (__comp > 0) { \
173 SPLAY_RIGHT(elm, field) = SPLAY_RIGHT((head)->sph_root, field);\
174 SPLAY_LEFT(elm, field) = (head)->sph_root; \
175 SPLAY_RIGHT((head)->sph_root, field) = NULL; \
177 return ((head)->sph_root); \
179 (head)->sph_root = (elm); \
184 name##_SPLAY_REMOVE(struct name *head, struct type *elm) \
186 struct type *__tmp; \
187 if (SPLAY_EMPTY(head)) \
189 name##_SPLAY(head, elm); \
190 if ((cmp)(elm, (head)->sph_root) == 0) { \
191 if (SPLAY_LEFT((head)->sph_root, field) == NULL) { \
192 (head)->sph_root = SPLAY_RIGHT((head)->sph_root, field);\
194 __tmp = SPLAY_RIGHT((head)->sph_root, field); \
195 (head)->sph_root = SPLAY_LEFT((head)->sph_root, field);\
196 name##_SPLAY(head, elm); \
197 SPLAY_RIGHT((head)->sph_root, field) = __tmp; \
205 name##_SPLAY(struct name *head, struct type *elm) \
207 struct type __node, *__left, *__right, *__tmp; \
210 SPLAY_LEFT(&__node, field) = SPLAY_RIGHT(&__node, field) = NULL;\
211 __left = __right = &__node; \
213 while ((__comp = (cmp)(elm, (head)->sph_root)) != 0) { \
215 __tmp = SPLAY_LEFT((head)->sph_root, field); \
218 if ((cmp)(elm, __tmp) < 0){ \
219 SPLAY_ROTATE_RIGHT(head, __tmp, field); \
220 if (SPLAY_LEFT((head)->sph_root, field) == NULL)\
223 SPLAY_LINKLEFT(head, __right, field); \
224 } else if (__comp > 0) { \
225 __tmp = SPLAY_RIGHT((head)->sph_root, field); \
228 if ((cmp)(elm, __tmp) > 0){ \
229 SPLAY_ROTATE_LEFT(head, __tmp, field); \
230 if (SPLAY_RIGHT((head)->sph_root, field) == NULL)\
233 SPLAY_LINKRIGHT(head, __left, field); \
236 SPLAY_ASSEMBLE(head, &__node, __left, __right, field); \
239 /* Splay with either the minimum or the maximum element \
240 * Used to find minimum or maximum element in tree. \
242 void name##_SPLAY_MINMAX(struct name *head, int __comp) \
244 struct type __node, *__left, *__right, *__tmp; \
246 SPLAY_LEFT(&__node, field) = SPLAY_RIGHT(&__node, field) = NULL;\
247 __left = __right = &__node; \
251 __tmp = SPLAY_LEFT((head)->sph_root, field); \
255 SPLAY_ROTATE_RIGHT(head, __tmp, field); \
256 if (SPLAY_LEFT((head)->sph_root, field) == NULL)\
259 SPLAY_LINKLEFT(head, __right, field); \
260 } else if (__comp > 0) { \
261 __tmp = SPLAY_RIGHT((head)->sph_root, field); \
265 SPLAY_ROTATE_LEFT(head, __tmp, field); \
266 if (SPLAY_RIGHT((head)->sph_root, field) == NULL)\
269 SPLAY_LINKRIGHT(head, __left, field); \
272 SPLAY_ASSEMBLE(head, &__node, __left, __right, field); \
275 #define SPLAY_NEGINF -1
278 #define SPLAY_INSERT(name, x, y) name##_SPLAY_INSERT(x, y)
279 #define SPLAY_REMOVE(name, x, y) name##_SPLAY_REMOVE(x, y)
280 #define SPLAY_FIND(name, x, y) name##_SPLAY_FIND(x, y)
281 #define SPLAY_NEXT(name, x, y) name##_SPLAY_NEXT(x, y)
282 #define SPLAY_MIN(name, x) (SPLAY_EMPTY(x) ? NULL \
283 : name##_SPLAY_MIN_MAX(x, SPLAY_NEGINF))
284 #define SPLAY_MAX(name, x) (SPLAY_EMPTY(x) ? NULL \
285 : name##_SPLAY_MIN_MAX(x, SPLAY_INF))
287 #define SPLAY_FOREACH(x, name, head) \
288 for ((x) = SPLAY_MIN(name, head); \
290 (x) = SPLAY_NEXT(name, head, x))
292 /* Macros that define a red-black tree */
294 #define RB_SCAN_INFO(name, type) \
295 struct name##_scan_info { \
296 struct name##_scan_info *link; \
300 #define RB_HEAD(name, type) \
302 struct type *rbh_root; /* root of the tree */ \
303 struct name##_scan_info *rbh_inprog; /* scans in progress */ \
306 #define RB_INITIALIZER(root) \
309 #define RB_INIT(root) do { \
310 (root)->rbh_root = NULL; \
311 (root)->rbh_inprog = NULL; \
312 } while (/*CONSTCOND*/ 0)
316 #define RB_ENTRY(type) \
318 struct type *rbe_left; /* left element */ \
319 struct type *rbe_right; /* right element */ \
320 struct type *rbe_parent; /* parent element */ \
321 int rbe_color; /* node color */ \
324 #define RB_LEFT(elm, field) (elm)->field.rbe_left
325 #define RB_RIGHT(elm, field) (elm)->field.rbe_right
326 #define RB_PARENT(elm, field) (elm)->field.rbe_parent
327 #define RB_COLOR(elm, field) (elm)->field.rbe_color
328 #define RB_ROOT(head) (head)->rbh_root
329 #define RB_INPROG(head) (head)->rbh_inprog
330 #define RB_EMPTY(head) (RB_ROOT(head) == NULL)
332 #define RB_SET(elm, parent, field) do { \
333 RB_PARENT(elm, field) = parent; \
334 RB_LEFT(elm, field) = RB_RIGHT(elm, field) = NULL; \
335 RB_COLOR(elm, field) = RB_RED; \
336 } while (/*CONSTCOND*/ 0)
338 #define RB_SET_BLACKRED(black, red, field) do { \
339 RB_COLOR(black, field) = RB_BLACK; \
340 RB_COLOR(red, field) = RB_RED; \
341 } while (/*CONSTCOND*/ 0)
344 #define RB_AUGMENT(x)
347 #define RB_ROTATE_LEFT(head, elm, tmp, field) do { \
348 (tmp) = RB_RIGHT(elm, field); \
349 if ((RB_RIGHT(elm, field) = RB_LEFT(tmp, field)) != NULL) { \
350 RB_PARENT(RB_LEFT(tmp, field), field) = (elm); \
353 if ((RB_PARENT(tmp, field) = RB_PARENT(elm, field)) != NULL) { \
354 if ((elm) == RB_LEFT(RB_PARENT(elm, field), field)) \
355 RB_LEFT(RB_PARENT(elm, field), field) = (tmp); \
357 RB_RIGHT(RB_PARENT(elm, field), field) = (tmp); \
359 (head)->rbh_root = (tmp); \
360 RB_LEFT(tmp, field) = (elm); \
361 RB_PARENT(elm, field) = (tmp); \
363 if ((RB_PARENT(tmp, field))) \
364 RB_AUGMENT(RB_PARENT(tmp, field)); \
365 } while (/*CONSTCOND*/ 0)
367 #define RB_ROTATE_RIGHT(head, elm, tmp, field) do { \
368 (tmp) = RB_LEFT(elm, field); \
369 if ((RB_LEFT(elm, field) = RB_RIGHT(tmp, field)) != NULL) { \
370 RB_PARENT(RB_RIGHT(tmp, field), field) = (elm); \
373 if ((RB_PARENT(tmp, field) = RB_PARENT(elm, field)) != NULL) { \
374 if ((elm) == RB_LEFT(RB_PARENT(elm, field), field)) \
375 RB_LEFT(RB_PARENT(elm, field), field) = (tmp); \
377 RB_RIGHT(RB_PARENT(elm, field), field) = (tmp); \
379 (head)->rbh_root = (tmp); \
380 RB_RIGHT(tmp, field) = (elm); \
381 RB_PARENT(elm, field) = (tmp); \
383 if ((RB_PARENT(tmp, field))) \
384 RB_AUGMENT(RB_PARENT(tmp, field)); \
385 } while (/*CONSTCOND*/ 0)
387 /* Generates prototypes and inline functions */
388 #define RB_PROTOTYPE(name, type, field, cmp) \
389 struct type *name##_RB_REMOVE(struct name *, struct type *); \
390 struct type *name##_RB_INSERT(struct name *, struct type *); \
391 struct type *name##_RB_FIND(struct name *, struct type *); \
392 int name##_RB_SCAN(struct name *, int (*)(struct type *, void *), \
393 int (*)(struct type *, void *), void *); \
394 struct type *name##_RB_NEXT(struct type *); \
395 struct type *name##_RB_PREV(struct type *); \
396 struct type *name##_RB_MINMAX(struct name *, int); \
397 RB_SCAN_INFO(name, type) \
400 * A version which supplies a fast lookup routine for an exact match
401 * on a numeric field.
403 #define RB_PROTOTYPE2(name, type, field, cmp, datatype) \
404 RB_PROTOTYPE(name, type, field, cmp); \
405 struct type *name##_RB_LOOKUP(struct name *, datatype) \
408 * A version which supplies a fast lookup routine for a numeric
409 * field which resides within a ranged object, either using (begin,end),
410 * or using (begin,size).
412 #define RB_PROTOTYPE3(name, type, field, cmp, datatype) \
413 RB_PROTOTYPE2(name, type, field, cmp, datatype); \
414 struct type *name##_RB_RLOOKUP(struct name *, datatype) \
416 #define RB_PROTOTYPE4(name, type, field, cmp, datatype) \
417 RB_PROTOTYPE2(name, type, field, cmp, datatype); \
418 struct type *name##_RB_RLOOKUP(struct name *, datatype) \
420 #define RB_PROTOTYPEX(name, type, field, cmp, rcmp, datatype) \
421 RB_PROTOTYPE2(name, type, field, cmp, datatype); \
422 struct type *name##_RB_RLOOKUP(struct name *, datatype) \
424 /* Main rb operation.
425 * Moves node close to the key of elm to top
427 #define RB_GENERATE(name, type, field, cmp) \
429 name##_RB_INSERT_COLOR(struct name *head, struct type *elm) \
431 struct type *parent, *gparent, *tmp; \
432 while ((parent = RB_PARENT(elm, field)) != NULL && \
433 RB_COLOR(parent, field) == RB_RED) { \
434 gparent = RB_PARENT(parent, field); \
435 if (parent == RB_LEFT(gparent, field)) { \
436 tmp = RB_RIGHT(gparent, field); \
437 if (tmp && RB_COLOR(tmp, field) == RB_RED) { \
438 RB_COLOR(tmp, field) = RB_BLACK; \
439 RB_SET_BLACKRED(parent, gparent, field);\
443 if (RB_RIGHT(parent, field) == elm) { \
444 RB_ROTATE_LEFT(head, parent, tmp, field);\
449 RB_SET_BLACKRED(parent, gparent, field); \
450 RB_ROTATE_RIGHT(head, gparent, tmp, field); \
452 tmp = RB_LEFT(gparent, field); \
453 if (tmp && RB_COLOR(tmp, field) == RB_RED) { \
454 RB_COLOR(tmp, field) = RB_BLACK; \
455 RB_SET_BLACKRED(parent, gparent, field);\
459 if (RB_LEFT(parent, field) == elm) { \
460 RB_ROTATE_RIGHT(head, parent, tmp, field);\
465 RB_SET_BLACKRED(parent, gparent, field); \
466 RB_ROTATE_LEFT(head, gparent, tmp, field); \
469 RB_COLOR(head->rbh_root, field) = RB_BLACK; \
473 name##_RB_REMOVE_COLOR(struct name *head, struct type *parent, \
477 while ((elm == NULL || RB_COLOR(elm, field) == RB_BLACK) && \
478 elm != RB_ROOT(head)) { \
479 if (RB_LEFT(parent, field) == elm) { \
480 tmp = RB_RIGHT(parent, field); \
481 if (RB_COLOR(tmp, field) == RB_RED) { \
482 RB_SET_BLACKRED(tmp, parent, field); \
483 RB_ROTATE_LEFT(head, parent, tmp, field);\
484 tmp = RB_RIGHT(parent, field); \
486 if ((RB_LEFT(tmp, field) == NULL || \
487 RB_COLOR(RB_LEFT(tmp, field), field) == RB_BLACK) &&\
488 (RB_RIGHT(tmp, field) == NULL || \
489 RB_COLOR(RB_RIGHT(tmp, field), field) == RB_BLACK)) {\
490 RB_COLOR(tmp, field) = RB_RED; \
492 parent = RB_PARENT(elm, field); \
494 if (RB_RIGHT(tmp, field) == NULL || \
495 RB_COLOR(RB_RIGHT(tmp, field), field) == RB_BLACK) {\
496 struct type *oleft; \
497 if ((oleft = RB_LEFT(tmp, field)) \
499 RB_COLOR(oleft, field) = RB_BLACK;\
500 RB_COLOR(tmp, field) = RB_RED; \
501 RB_ROTATE_RIGHT(head, tmp, oleft, field);\
502 tmp = RB_RIGHT(parent, field); \
504 RB_COLOR(tmp, field) = RB_COLOR(parent, field);\
505 RB_COLOR(parent, field) = RB_BLACK; \
506 if (RB_RIGHT(tmp, field)) \
507 RB_COLOR(RB_RIGHT(tmp, field), field) = RB_BLACK;\
508 RB_ROTATE_LEFT(head, parent, tmp, field);\
509 elm = RB_ROOT(head); \
513 tmp = RB_LEFT(parent, field); \
514 if (RB_COLOR(tmp, field) == RB_RED) { \
515 RB_SET_BLACKRED(tmp, parent, field); \
516 RB_ROTATE_RIGHT(head, parent, tmp, field);\
517 tmp = RB_LEFT(parent, field); \
519 if ((RB_LEFT(tmp, field) == NULL || \
520 RB_COLOR(RB_LEFT(tmp, field), field) == RB_BLACK) &&\
521 (RB_RIGHT(tmp, field) == NULL || \
522 RB_COLOR(RB_RIGHT(tmp, field), field) == RB_BLACK)) {\
523 RB_COLOR(tmp, field) = RB_RED; \
525 parent = RB_PARENT(elm, field); \
527 if (RB_LEFT(tmp, field) == NULL || \
528 RB_COLOR(RB_LEFT(tmp, field), field) == RB_BLACK) {\
529 struct type *oright; \
530 if ((oright = RB_RIGHT(tmp, field)) \
532 RB_COLOR(oright, field) = RB_BLACK;\
533 RB_COLOR(tmp, field) = RB_RED; \
534 RB_ROTATE_LEFT(head, tmp, oright, field);\
535 tmp = RB_LEFT(parent, field); \
537 RB_COLOR(tmp, field) = RB_COLOR(parent, field);\
538 RB_COLOR(parent, field) = RB_BLACK; \
539 if (RB_LEFT(tmp, field)) \
540 RB_COLOR(RB_LEFT(tmp, field), field) = RB_BLACK;\
541 RB_ROTATE_RIGHT(head, parent, tmp, field);\
542 elm = RB_ROOT(head); \
548 RB_COLOR(elm, field) = RB_BLACK; \
552 name##_RB_REMOVE(struct name *head, struct type *elm) \
554 struct type *child, *parent, *old; \
555 struct name##_scan_info *inprog; \
558 for (inprog = RB_INPROG(head); inprog; inprog = inprog->link) { \
559 if (inprog->node == elm) \
560 inprog->node = RB_NEXT(name, head, elm); \
564 if (RB_LEFT(elm, field) == NULL) \
565 child = RB_RIGHT(elm, field); \
566 else if (RB_RIGHT(elm, field) == NULL) \
567 child = RB_LEFT(elm, field); \
570 elm = RB_RIGHT(elm, field); \
571 while ((left = RB_LEFT(elm, field)) != NULL) \
573 child = RB_RIGHT(elm, field); \
574 parent = RB_PARENT(elm, field); \
575 color = RB_COLOR(elm, field); \
577 RB_PARENT(child, field) = parent; \
579 if (RB_LEFT(parent, field) == elm) \
580 RB_LEFT(parent, field) = child; \
582 RB_RIGHT(parent, field) = child; \
583 RB_AUGMENT(parent); \
585 RB_ROOT(head) = child; \
586 if (RB_PARENT(elm, field) == old) \
588 (elm)->field = (old)->field; \
589 if (RB_PARENT(old, field)) { \
590 if (RB_LEFT(RB_PARENT(old, field), field) == old)\
591 RB_LEFT(RB_PARENT(old, field), field) = elm;\
593 RB_RIGHT(RB_PARENT(old, field), field) = elm;\
594 RB_AUGMENT(RB_PARENT(old, field)); \
596 RB_ROOT(head) = elm; \
597 RB_PARENT(RB_LEFT(old, field), field) = elm; \
598 if (RB_RIGHT(old, field)) \
599 RB_PARENT(RB_RIGHT(old, field), field) = elm; \
604 } while ((left = RB_PARENT(left, field)) != NULL); \
608 parent = RB_PARENT(elm, field); \
609 color = RB_COLOR(elm, field); \
611 RB_PARENT(child, field) = parent; \
613 if (RB_LEFT(parent, field) == elm) \
614 RB_LEFT(parent, field) = child; \
616 RB_RIGHT(parent, field) = child; \
617 RB_AUGMENT(parent); \
619 RB_ROOT(head) = child; \
621 if (color == RB_BLACK) \
622 name##_RB_REMOVE_COLOR(head, parent, child); \
626 /* Inserts a node into the RB tree */ \
628 name##_RB_INSERT(struct name *head, struct type *elm) \
631 struct type *parent = NULL; \
633 tmp = RB_ROOT(head); \
636 comp = (cmp)(elm, parent); \
638 tmp = RB_LEFT(tmp, field); \
640 tmp = RB_RIGHT(tmp, field); \
644 RB_SET(elm, parent, field); \
645 if (parent != NULL) { \
647 RB_LEFT(parent, field) = elm; \
649 RB_RIGHT(parent, field) = elm; \
650 RB_AUGMENT(parent); \
652 RB_ROOT(head) = elm; \
653 name##_RB_INSERT_COLOR(head, elm); \
657 /* Finds the node with the same key as elm */ \
659 name##_RB_FIND(struct name *head, struct type *elm) \
661 struct type *tmp = RB_ROOT(head); \
664 comp = cmp(elm, tmp); \
666 tmp = RB_LEFT(tmp, field); \
668 tmp = RB_RIGHT(tmp, field); \
676 * Issue a callback for all matching items. The scan function must \
677 * return < 0 for items below the desired range, 0 for items within \
678 * the range, and > 0 for items beyond the range. Any item may be \
679 * deleted while the scan is in progress. \
682 name##_SCANCMP_ALL(struct type *type, void *data) \
688 name##_RB_SCAN(struct name *head, \
689 int (*scancmp)(struct type *, void *), \
690 int (*callback)(struct type *, void *), \
693 struct name##_scan_info info; \
694 struct name##_scan_info **infopp; \
700 if (scancmp == NULL) \
701 scancmp = name##_SCANCMP_ALL; \
704 * Locate the first element. \
706 tmp = RB_ROOT(head); \
709 comp = scancmp(tmp, data); \
711 tmp = RB_RIGHT(tmp, field); \
712 } else if (comp > 0) { \
713 tmp = RB_LEFT(tmp, field); \
716 if (RB_LEFT(tmp, field) == NULL) \
718 tmp = RB_LEFT(tmp, field); \
723 info.node = RB_NEXT(name, head, best); \
724 info.link = RB_INPROG(head); \
725 RB_INPROG(head) = &info; \
726 while ((comp = callback(best, data)) >= 0) { \
729 if (best == NULL || scancmp(best, data) != 0) \
731 info.node = RB_NEXT(name, head, best); \
733 if (comp < 0) /* error or termination */ \
735 infopp = &RB_INPROG(head); \
736 while (*infopp != &info) \
737 infopp = &(*infopp)->link; \
738 *infopp = info.link; \
745 name##_RB_NEXT(struct type *elm) \
747 if (RB_RIGHT(elm, field)) { \
748 elm = RB_RIGHT(elm, field); \
749 while (RB_LEFT(elm, field)) \
750 elm = RB_LEFT(elm, field); \
752 if (RB_PARENT(elm, field) && \
753 (elm == RB_LEFT(RB_PARENT(elm, field), field))) \
754 elm = RB_PARENT(elm, field); \
756 while (RB_PARENT(elm, field) && \
757 (elm == RB_RIGHT(RB_PARENT(elm, field), field)))\
758 elm = RB_PARENT(elm, field); \
759 elm = RB_PARENT(elm, field); \
767 name##_RB_PREV(struct type *elm) \
769 if (RB_LEFT(elm, field)) { \
770 elm = RB_LEFT(elm, field); \
771 while (RB_RIGHT(elm, field)) \
772 elm = RB_RIGHT(elm, field); \
774 if (RB_PARENT(elm, field) && \
775 (elm == RB_RIGHT(RB_PARENT(elm, field), field))) \
776 elm = RB_PARENT(elm, field); \
778 while (RB_PARENT(elm, field) && \
779 (elm == RB_LEFT(RB_PARENT(elm, field), field)))\
780 elm = RB_PARENT(elm, field); \
781 elm = RB_PARENT(elm, field); \
788 name##_RB_MINMAX(struct name *head, int val) \
790 struct type *tmp = RB_ROOT(head); \
791 struct type *parent = NULL; \
795 tmp = RB_LEFT(tmp, field); \
797 tmp = RB_RIGHT(tmp, field); \
803 * This extended version implements a fast LOOKUP function given
804 * a numeric data type.
806 * The element whos index/offset field is exactly the specified value
807 * will be returned, or NULL.
809 #define RB_GENERATE2(name, type, field, cmp, datatype, indexfield) \
810 RB_GENERATE(name, type, field, cmp) \
813 name##_RB_LOOKUP(struct name *head, datatype value) \
817 tmp = RB_ROOT(head); \
819 if (value > tmp->indexfield) \
820 tmp = RB_RIGHT(tmp, field); \
821 else if (value < tmp->indexfield) \
822 tmp = RB_LEFT(tmp, field); \
830 * This extended version implements a fast ranged-based LOOKUP function
831 * given a numeric data type, for data types with a beginning and end
832 * (end is inclusive).
834 * The element whos range contains the specified value is returned, or NULL
836 #define RB_GENERATE3(name, type, field, cmp, datatype, begfield, endfield) \
837 RB_GENERATE2(name, type, field, cmp, datatype, begfield) \
840 name##_RB_RLOOKUP(struct name *head, datatype value) \
844 tmp = RB_ROOT(head); \
846 if (value >= tmp->begfield && value <= tmp->endfield) \
848 if (value > tmp->begfield) \
849 tmp = RB_RIGHT(tmp, field); \
851 tmp = RB_LEFT(tmp, field); \
857 * This extended version implements a fast ranged-based LOOKUP function
858 * given a numeric data type, for data types with a beginning and size.
860 * WARNING: The full range of the data type is not supported due to a
861 * boundary condition at the end, where (beginning + size) might overflow.
863 * The element whos range contains the specified value is returned, or NULL
865 #define RB_GENERATE4(name, type, field, cmp, datatype, begfield, sizefield) \
866 RB_GENERATE2(name, type, field, cmp, datatype, begfield) \
869 name##_RB_RLOOKUP(struct name *head, datatype value) \
873 tmp = RB_ROOT(head); \
875 if (value >= tmp->begfield && \
876 value < tmp->begfield + tmp->sizefield) { \
879 if (value > tmp->begfield) \
880 tmp = RB_RIGHT(tmp, field); \
882 tmp = RB_LEFT(tmp, field); \
888 * The 'X' version adds a generic ranged function using a callback instead
889 * of fixed functions.
891 #define RB_GENERATEX(name, type, field, cmp, rcmp, datatype, begfield) \
892 RB_GENERATE2(name, type, field, cmp, datatype, begfield) \
895 name##_RB_RLOOKUP(struct name *head, datatype value) \
900 tmp = RB_ROOT(head); \
902 r = rcmp(value, tmp); \
906 tmp = RB_RIGHT(tmp, field); \
908 tmp = RB_LEFT(tmp, field); \
917 #define RB_INSERT(name, root, elm) name##_RB_INSERT(root, elm)
918 #define RB_REMOVE(name, root, elm) name##_RB_REMOVE(root, elm)
919 #define RB_FIND(name, root, elm) name##_RB_FIND(root, elm)
920 #define RB_LOOKUP(name, root, value) name##_RB_LOOKUP(root, value)
921 #define RB_RLOOKUP(name, root, value) name##_RB_RLOOKUP(root, value)
922 #define RB_SCAN(name, root, cmp, callback, data) \
923 name##_RB_SCAN(root, cmp, callback, data)
924 #define RB_NEXT(name, root, elm) name##_RB_NEXT(elm)
925 #define RB_PREV(name, root, elm) name##_RB_PREV(elm)
926 #define RB_MIN(name, root) name##_RB_MINMAX(root, RB_NEGINF)
927 #define RB_MAX(name, root) name##_RB_MINMAX(root, RB_INF)
929 #define RB_FOREACH(x, name, head) \
930 for ((x) = RB_MIN(name, head); \
932 (x) = name##_RB_NEXT(x))
934 #endif /* _SYS_TREE_H_ */