1 /* $NetBSD: rbtree.h,v 1.13 2025/10/22 12:34:00 roy Exp $ */ 2 3 /*- 4 * Copyright (c) 2001 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Matt Thomas <matt (at) 3am-software.com>. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #ifndef _SYS_RBTREE_H_ 33 #define _SYS_RBTREE_H_ 34 35 #include <sys/types.h> 36 37 #ifdef RBDEBUG 38 #include <sys/queue.h> 39 #if !defined(_KERNEL) && !defined(_STANDALONE) 40 #include <stdbool.h> 41 #endif 42 #endif 43 44 #ifdef __BEGIN_DECLS 45 __BEGIN_DECLS 46 #endif 47 48 typedef struct rb_node { 49 struct rb_node *rb_nodes[2]; 50 #define RB_DIR_LEFT 0 51 #define RB_DIR_RIGHT 1 52 #define RB_DIR_OTHER 1 53 #define rb_left rb_nodes[RB_DIR_LEFT] 54 #define rb_right rb_nodes[RB_DIR_RIGHT] 55 56 /* 57 * rb_info contains the two flags and the parent back pointer. 58 * We put the two flags in the low two bits since we know that 59 * rb_node will have an alignment of 4 or 8 bytes. 60 */ 61 uintptr_t rb_info; 62 #define RB_FLAG_POSITION (uintptr_t)0x2 63 #define RB_FLAG_RED (uintptr_t)0x1 64 #define RB_FLAG_MASK (RB_FLAG_POSITION|RB_FLAG_RED) 65 #define RB_FATHER(rb) \ 66 ((struct rb_node *)((rb)->rb_info & ~RB_FLAG_MASK)) 67 #define RB_SET_FATHER(rb, father) \ 68 ((void)((rb)->rb_info = (uintptr_t)(father)|((rb)->rb_info & RB_FLAG_MASK))) 69 70 #define RB_SENTINEL_P(rb) ((rb) == NULL) 71 #define RB_LEFT_SENTINEL_P(rb) RB_SENTINEL_P((rb)->rb_left) 72 #define RB_RIGHT_SENTINEL_P(rb) RB_SENTINEL_P((rb)->rb_right) 73 #define RB_FATHER_SENTINEL_P(rb) RB_SENTINEL_P(RB_FATHER((rb))) 74 #define RB_CHILDLESS_P(rb) \ 75 (RB_SENTINEL_P(rb) || (RB_LEFT_SENTINEL_P(rb) && RB_RIGHT_SENTINEL_P(rb))) 76 #define RB_TWOCHILDREN_P(rb) \ 77 (!RB_SENTINEL_P(rb) && !RB_LEFT_SENTINEL_P(rb) && !RB_RIGHT_SENTINEL_P(rb)) 78 79 #define RB_POSITION(rb) \ 80 (((rb)->rb_info & RB_FLAG_POSITION) ? RB_DIR_RIGHT : RB_DIR_LEFT) 81 #define RB_RIGHT_P(rb) (RB_POSITION(rb) == RB_DIR_RIGHT) 82 #define RB_LEFT_P(rb) (RB_POSITION(rb) == RB_DIR_LEFT) 83 #define RB_RED_P(rb) (!RB_SENTINEL_P(rb) && ((rb)->rb_info & RB_FLAG_RED) != 0) 84 #define RB_BLACK_P(rb) (RB_SENTINEL_P(rb) || ((rb)->rb_info & RB_FLAG_RED) == 0) 85 #define RB_MARK_RED(rb) ((void)((rb)->rb_info |= RB_FLAG_RED)) 86 #define RB_MARK_BLACK(rb) ((void)((rb)->rb_info &= ~RB_FLAG_RED)) 87 #define RB_INVERT_COLOR(rb) ((void)((rb)->rb_info ^= RB_FLAG_RED)) 88 #define RB_ROOT_P(rbt, rb) ((rbt)->rbt_root == (rb)) 89 #define RB_SET_POSITION(rb, position) \ 90 ((void)((position) ? ((rb)->rb_info |= RB_FLAG_POSITION) : \ 91 ((rb)->rb_info &= ~RB_FLAG_POSITION))) 92 #define RB_ZERO_PROPERTIES(rb) ((void)((rb)->rb_info &= ~RB_FLAG_MASK)) 93 #define RB_COPY_PROPERTIES(dst, src) \ 94 ((void)((dst)->rb_info ^= ((dst)->rb_info ^ (src)->rb_info) & RB_FLAG_MASK)) 95 #define RB_SWAP_PROPERTIES(a, b) do { \ 96 uintptr_t xorinfo = ((a)->rb_info ^ (b)->rb_info) & RB_FLAG_MASK; \ 97 (a)->rb_info ^= xorinfo; \ 98 (b)->rb_info ^= xorinfo; \ 99 } while (0) 100 #ifdef RBDEBUG 101 TAILQ_ENTRY(rb_node) rb_link; 102 #endif 103 } rb_node_t; 104 105 #define RB_TREE_MIN(T) rb_tree_iterate((T), NULL, RB_DIR_LEFT) 106 #define RB_TREE_MAX(T) rb_tree_iterate((T), NULL, RB_DIR_RIGHT) 107 #define RB_TREE_NEXT(T, N) rb_tree_iterate((T), (N), RB_DIR_RIGHT) 108 #define RB_TREE_PREV(T, N) rb_tree_iterate((T), (N), RB_DIR_LEFT) 109 #define RB_TREE_FOREACH(N, T) \ 110 for ((N) = RB_TREE_MIN(T); (N); (N) = RB_TREE_NEXT((T), (N))) 111 #define RB_TREE_FOREACH_REVERSE(N, T) \ 112 for ((N) = RB_TREE_MAX(T); (N); (N) = RB_TREE_PREV((T), (N))) 113 #define RB_TREE_FOREACH_SAFE(N, T, S) \ 114 for ((N) = RB_TREE_MIN(T); \ 115 (N) && ((S) = RB_TREE_NEXT((T), (N)), 1); \ 116 (N) = (S)) 117 #define RB_TREE_FOREACH_REVERSE_SAFE(N, T, S) \ 118 for ((N) = RB_TREE_MAX(T); \ 119 (N) && ((S) = RB_TREE_PREV((T), (N)), 1); \ 120 (N) = (S)) 121 122 #ifdef RBDEBUG 123 TAILQ_HEAD(rb_node_qh, rb_node); 124 125 #define RB_TAILQ_REMOVE(a, b, c) TAILQ_REMOVE(a, b, c) 126 #define RB_TAILQ_INIT(a) TAILQ_INIT(a) 127 #define RB_TAILQ_INSERT_HEAD(a, b, c) TAILQ_INSERT_HEAD(a, b, c) 128 #define RB_TAILQ_INSERT_BEFORE(a, b, c) TAILQ_INSERT_BEFORE(a, b, c) 129 #define RB_TAILQ_INSERT_AFTER(a, b, c, d) TAILQ_INSERT_AFTER(a, b, c, d) 130 131 #define RBDEBUG_TREE_INITIALIZER(t) \ 132 .rbt_nodes = TAILQ_HEAD_INITIALIZER((t).rbt_nodes), 133 #else 134 #define RB_TAILQ_REMOVE(a, b, c) do { } while (0) 135 #define RB_TAILQ_INIT(a) do { } while (0) 136 #define RB_TAILQ_INSERT_HEAD(a, b, c) do { } while (0) 137 #define RB_TAILQ_INSERT_BEFORE(a, b, c) do { } while (0) 138 #define RB_TAILQ_INSERT_AFTER(a, b, c, d) do { } while (0) 139 140 #define RBDEBUG_TREE_INITIALIZER(t) /* nothing */ 141 #endif /* RBDEBUG */ 142 143 /* 144 * rbto_compare_nodes_fn: 145 * return a positive value if the first node > the second node. 146 * return a negative value if the first node < the second node. 147 * return 0 if they are considered same. 148 * 149 * rbto_compare_key_fn: 150 * return a positive value if the node > the key. 151 * return a negative value if the node < the key. 152 * return 0 if they are considered same. 153 */ 154 155 typedef signed int (*rbto_compare_nodes_fn)(void *, const void *, const void *); 156 typedef signed int (*rbto_compare_key_fn)(void *, const void *, const void *); 157 158 typedef struct { 159 rbto_compare_nodes_fn rbto_compare_nodes; 160 rbto_compare_key_fn rbto_compare_key; 161 size_t rbto_node_offset; 162 void *rbto_context; 163 } rb_tree_ops_t; 164 165 typedef struct rb_tree { 166 struct rb_node *rbt_root; 167 const rb_tree_ops_t *rbt_ops; 168 struct rb_node *rbt_minmax[2]; 169 #ifdef RBDEBUG 170 struct rb_node_qh rbt_nodes; 171 #endif 172 #ifdef RBSTATS 173 unsigned int rbt_count; 174 unsigned int rbt_insertions; 175 unsigned int rbt_removals; 176 unsigned int rbt_insertion_rebalance_calls; 177 unsigned int rbt_insertion_rebalance_passes; 178 unsigned int rbt_removal_rebalance_calls; 179 unsigned int rbt_removal_rebalance_passes; 180 #endif 181 } rb_tree_t; 182 183 #ifdef RBSTATS 184 #define RBSTAT_INC(v) ((void)((v)++)) 185 #define RBSTAT_DEC(v) ((void)((v)--)) 186 #else 187 #define RBSTAT_INC(v) do { } while (0) 188 #define RBSTAT_DEC(v) do { } while (0) 189 #endif 190 191 #define RB_TREE_INIT_TYPECHECK(t) \ 192 0*sizeof(&(t) - (struct rb_tree *)0) 193 194 #define RB_TREE_INITIALIZER(t, ops) \ 195 { \ 196 .rbt_ops = (ops) + RB_TREE_INIT_TYPECHECK(t), \ 197 RBDEBUG_TREE_INITIALIZER(t) \ 198 } 199 200 void rb_tree_init(rb_tree_t *, const rb_tree_ops_t *); 201 void * rb_tree_insert_node(rb_tree_t *, void *); 202 void * rb_tree_find_node(rb_tree_t *, const void *); 203 void * rb_tree_find_node_geq(rb_tree_t *, const void *); 204 void * rb_tree_find_node_leq(rb_tree_t *, const void *); 205 void rb_tree_remove_node(rb_tree_t *, void *); 206 void * rb_tree_iterate(rb_tree_t *, void *, const unsigned int); 207 #ifdef RBDEBUG 208 void rb_tree_check(const rb_tree_t *, bool); 209 #endif 210 #ifdef RBSTATS 211 void rb_tree_depths(const rb_tree_t *, size_t *); 212 #endif 213 214 #ifdef __END_DECLS 215 __END_DECLS 216 #endif 217 218 #endif /* _SYS_RBTREE_H_*/ 219
Indexes created Thu Oct 23 18:09:57 GMT 2025