1 /* $NetBSD: rbtree.h,v 1.14 2025/10/29 08:08:44 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 #if !defined(_KERNEL) && !defined(_STANDALONE) 36 #include <stddef.h> 37 #include <stdint.h> 38 #else 39 #include <sys/types.h> 40 #endif 41 42 #ifdef RBDEBUG 43 #include <sys/queue.h> 44 #if !defined(_KERNEL) && !defined(_STANDALONE) 45 #include <stdbool.h> 46 #endif 47 #endif 48 49 #ifdef __BEGIN_DECLS 50 __BEGIN_DECLS 51 #endif 52 53 typedef struct rb_node { 54 struct rb_node *rb_nodes[2]; 55 #define RB_DIR_LEFT 0 56 #define RB_DIR_RIGHT 1 57 #define RB_DIR_OTHER 1 58 #define rb_left rb_nodes[RB_DIR_LEFT] 59 #define rb_right rb_nodes[RB_DIR_RIGHT] 60 61 /* 62 * rb_info contains the two flags and the parent back pointer. 63 * We put the two flags in the low two bits since we know that 64 * rb_node will have an alignment of 4 or 8 bytes. 65 */ 66 uintptr_t rb_info; 67 #define RB_FLAG_POSITION (uintptr_t)0x2 68 #define RB_FLAG_RED (uintptr_t)0x1 69 #define RB_FLAG_MASK (RB_FLAG_POSITION|RB_FLAG_RED) 70 #define RB_FATHER(rb) \ 71 ((struct rb_node *)((rb)->rb_info & ~RB_FLAG_MASK)) 72 #define RB_SET_FATHER(rb, father) \ 73 ((void)((rb)->rb_info = (uintptr_t)(father)|((rb)->rb_info & RB_FLAG_MASK))) 74 75 #define RB_SENTINEL_P(rb) ((rb) == NULL) 76 #define RB_LEFT_SENTINEL_P(rb) RB_SENTINEL_P((rb)->rb_left) 77 #define RB_RIGHT_SENTINEL_P(rb) RB_SENTINEL_P((rb)->rb_right) 78 #define RB_FATHER_SENTINEL_P(rb) RB_SENTINEL_P(RB_FATHER((rb))) 79 #define RB_CHILDLESS_P(rb) \ 80 (RB_SENTINEL_P(rb) || (RB_LEFT_SENTINEL_P(rb) && RB_RIGHT_SENTINEL_P(rb))) 81 #define RB_TWOCHILDREN_P(rb) \ 82 (!RB_SENTINEL_P(rb) && !RB_LEFT_SENTINEL_P(rb) && !RB_RIGHT_SENTINEL_P(rb)) 83 84 #define RB_POSITION(rb) \ 85 (((rb)->rb_info & RB_FLAG_POSITION) ? RB_DIR_RIGHT : RB_DIR_LEFT) 86 #define RB_RIGHT_P(rb) (RB_POSITION(rb) == RB_DIR_RIGHT) 87 #define RB_LEFT_P(rb) (RB_POSITION(rb) == RB_DIR_LEFT) 88 #define RB_RED_P(rb) (!RB_SENTINEL_P(rb) && ((rb)->rb_info & RB_FLAG_RED) != 0) 89 #define RB_BLACK_P(rb) (RB_SENTINEL_P(rb) || ((rb)->rb_info & RB_FLAG_RED) == 0) 90 #define RB_MARK_RED(rb) ((void)((rb)->rb_info |= RB_FLAG_RED)) 91 #define RB_MARK_BLACK(rb) ((void)((rb)->rb_info &= ~RB_FLAG_RED)) 92 #define RB_INVERT_COLOR(rb) ((void)((rb)->rb_info ^= RB_FLAG_RED)) 93 #define RB_ROOT_P(rbt, rb) ((rbt)->rbt_root == (rb)) 94 #define RB_SET_POSITION(rb, position) \ 95 ((void)((position) ? ((rb)->rb_info |= RB_FLAG_POSITION) : \ 96 ((rb)->rb_info &= ~RB_FLAG_POSITION))) 97 #define RB_ZERO_PROPERTIES(rb) ((void)((rb)->rb_info &= ~RB_FLAG_MASK)) 98 #define RB_COPY_PROPERTIES(dst, src) \ 99 ((void)((dst)->rb_info ^= ((dst)->rb_info ^ (src)->rb_info) & RB_FLAG_MASK)) 100 #define RB_SWAP_PROPERTIES(a, b) do { \ 101 uintptr_t xorinfo = ((a)->rb_info ^ (b)->rb_info) & RB_FLAG_MASK; \ 102 (a)->rb_info ^= xorinfo; \ 103 (b)->rb_info ^= xorinfo; \ 104 } while (0) 105 #ifdef RBDEBUG 106 TAILQ_ENTRY(rb_node) rb_link; 107 #endif 108 } rb_node_t; 109 110 #define RB_TREE_MIN(T) rb_tree_iterate((T), NULL, RB_DIR_LEFT) 111 #define RB_TREE_MAX(T) rb_tree_iterate((T), NULL, RB_DIR_RIGHT) 112 #define RB_TREE_NEXT(T, N) rb_tree_iterate((T), (N), RB_DIR_RIGHT) 113 #define RB_TREE_PREV(T, N) rb_tree_iterate((T), (N), RB_DIR_LEFT) 114 #define RB_TREE_FOREACH(N, T) \ 115 for ((N) = RB_TREE_MIN(T); (N); (N) = RB_TREE_NEXT((T), (N))) 116 #define RB_TREE_FOREACH_REVERSE(N, T) \ 117 for ((N) = RB_TREE_MAX(T); (N); (N) = RB_TREE_PREV((T), (N))) 118 #define RB_TREE_FOREACH_SAFE(N, T, S) \ 119 for ((N) = RB_TREE_MIN(T); \ 120 (N) && ((S) = RB_TREE_NEXT((T), (N)), 1); \ 121 (N) = (S)) 122 #define RB_TREE_FOREACH_REVERSE_SAFE(N, T, S) \ 123 for ((N) = RB_TREE_MAX(T); \ 124 (N) && ((S) = RB_TREE_PREV((T), (N)), 1); \ 125 (N) = (S)) 126 127 #ifdef RBDEBUG 128 TAILQ_HEAD(rb_node_qh, rb_node); 129 130 #define RB_TAILQ_REMOVE(a, b, c) TAILQ_REMOVE(a, b, c) 131 #define RB_TAILQ_INIT(a) TAILQ_INIT(a) 132 #define RB_TAILQ_INSERT_HEAD(a, b, c) TAILQ_INSERT_HEAD(a, b, c) 133 #define RB_TAILQ_INSERT_BEFORE(a, b, c) TAILQ_INSERT_BEFORE(a, b, c) 134 #define RB_TAILQ_INSERT_AFTER(a, b, c, d) TAILQ_INSERT_AFTER(a, b, c, d) 135 136 #define RBDEBUG_TREE_INITIALIZER(t) \ 137 .rbt_nodes = TAILQ_HEAD_INITIALIZER((t).rbt_nodes), 138 #else 139 #define RB_TAILQ_REMOVE(a, b, c) do { } while (0) 140 #define RB_TAILQ_INIT(a) do { } while (0) 141 #define RB_TAILQ_INSERT_HEAD(a, b, c) do { } while (0) 142 #define RB_TAILQ_INSERT_BEFORE(a, b, c) do { } while (0) 143 #define RB_TAILQ_INSERT_AFTER(a, b, c, d) do { } while (0) 144 145 #define RBDEBUG_TREE_INITIALIZER(t) /* nothing */ 146 #endif /* RBDEBUG */ 147 148 /* 149 * rbto_compare_nodes_fn: 150 * return a positive value if the first node > the second node. 151 * return a negative value if the first node < the second node. 152 * return 0 if they are considered same. 153 * 154 * rbto_compare_key_fn: 155 * return a positive value if the node > the key. 156 * return a negative value if the node < the key. 157 * return 0 if they are considered same. 158 */ 159 160 typedef signed int (*rbto_compare_nodes_fn)(void *, const void *, const void *); 161 typedef signed int (*rbto_compare_key_fn)(void *, const void *, const void *); 162 163 typedef struct { 164 rbto_compare_nodes_fn rbto_compare_nodes; 165 rbto_compare_key_fn rbto_compare_key; 166 size_t rbto_node_offset; 167 void *rbto_context; 168 } rb_tree_ops_t; 169 170 typedef struct rb_tree { 171 struct rb_node *rbt_root; 172 const rb_tree_ops_t *rbt_ops; 173 struct rb_node *rbt_minmax[2]; 174 #ifdef RBDEBUG 175 struct rb_node_qh rbt_nodes; 176 #endif 177 #ifdef RBSTATS 178 unsigned int rbt_count; 179 unsigned int rbt_insertions; 180 unsigned int rbt_removals; 181 unsigned int rbt_insertion_rebalance_calls; 182 unsigned int rbt_insertion_rebalance_passes; 183 unsigned int rbt_removal_rebalance_calls; 184 unsigned int rbt_removal_rebalance_passes; 185 #endif 186 } rb_tree_t; 187 188 #ifdef RBSTATS 189 #define RBSTAT_INC(v) ((void)((v)++)) 190 #define RBSTAT_DEC(v) ((void)((v)--)) 191 #else 192 #define RBSTAT_INC(v) do { } while (0) 193 #define RBSTAT_DEC(v) do { } while (0) 194 #endif 195 196 #define RB_TREE_INIT_TYPECHECK(t) \ 197 0*sizeof(&(t) - (struct rb_tree *)0) 198 199 #define RB_TREE_INITIALIZER(t, ops) \ 200 { \ 201 .rbt_ops = (ops) + RB_TREE_INIT_TYPECHECK(t), \ 202 RBDEBUG_TREE_INITIALIZER(t) \ 203 } 204 205 void rb_tree_init(rb_tree_t *, const rb_tree_ops_t *); 206 void * rb_tree_insert_node(rb_tree_t *, void *); 207 void * rb_tree_find_node(rb_tree_t *, const void *); 208 void * rb_tree_find_node_geq(rb_tree_t *, const void *); 209 void * rb_tree_find_node_leq(rb_tree_t *, const void *); 210 void rb_tree_remove_node(rb_tree_t *, void *); 211 void * rb_tree_iterate(rb_tree_t *, void *, const unsigned int); 212 #ifdef RBDEBUG 213 void rb_tree_check(const rb_tree_t *, bool); 214 #endif 215 #ifdef RBSTATS 216 void rb_tree_depths(const rb_tree_t *, size_t *); 217 #endif 218 219 #ifdef __END_DECLS 220 __END_DECLS 221 #endif 222 223 #endif /* _SYS_RBTREE_H_*/ 224
Indexes created Thu Nov 06 06:09:52 GMT 2025