The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/rbtree.h

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

Cache object: 5dbab076b1bd8addf5c8437c881e5615

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.