include/linux/rbtree.h

   1 /*
   2   Red Black Trees
   3   (C) 1999  Andrea Arcangeli <andrea@suse.de>
   4
   5   This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or
   8   (at your option) any later version.
   9
  10   This program is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program; if not, write to the Free Software
  17   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18
  19   linux/include/linux/rbtree.h
  20
  21   To use rbtrees you'll have to implement your own insert and search cores.
  22   This will avoid us to use callbacks and to drop drammatically performances.
  23   I know it's not the cleaner way,  but in C (not in C++) to get
  24   performances and genericity...
  25
  26   See Documentation/rbtree.txt for documentation and samples.
  27 */
  28
  29 #ifndef _LINUX_RBTREE_H
  30 #define _LINUX_RBTREE_H
  31
  32 #include <linux/kernel.h>
  33 #include <linux/stddef.h>
  34
  35 struct rb_node {
  36         unsigned long  __rb_parent_color;
  37         struct rb_node *rb_right;
  38         struct rb_node *rb_left;
  39 } __attribute__((aligned(sizeof(long))));
  40     /* The alignment might seem pointless, but allegedly CRIS needs it */
  41
  42 struct rb_root {
  43         struct rb_node *rb_node;
  44 };
  45
  46
  47 #define rb_parent(r)   ((struct rb_node *)((r)->__rb_parent_color & ~3))
  48
  49 #define RB_ROOT (struct rb_root) { NULL, }
  50 #define rb_entry(ptr, type, member) container_of(ptr, type, member)
  51
  52 #define RB_EMPTY_ROOT(root)  ((root)->rb_node == NULL)
  53
  54 /* 'empty' nodes are nodes that are known not to be inserted in an rbree */
  55 #define RB_EMPTY_NODE(node)  \
  56         ((node)->__rb_parent_color == (unsigned long)(node))
  57 #define RB_CLEAR_NODE(node)  \
  58         ((node)->__rb_parent_color = (unsigned long)(node))
  59
  60
  61 extern void rb_insert_color(struct rb_node *, struct rb_root *);
  62 extern void rb_erase(struct rb_node *, struct rb_root *);
  63
  64
  65 struct rb_augment_callbacks {
  66         void (*propagate)(struct rb_node *node, struct rb_node *stop);
  67         void (*copy)(struct rb_node *old, struct rb_node *new);
  68         void (*rotate)(struct rb_node *old, struct rb_node *new);
  69 };
  70
  71 extern void __rb_insert_augmented(struct rb_node *node, struct rb_root *root,
  72         void (*augment_rotate)(struct rb_node *old, struct rb_node *new));
  73 extern void rb_erase_augmented(struct rb_node *node, struct rb_root *root,
  74                                const struct rb_augment_callbacks *augment);
  75 static inline void
  76 rb_insert_augmented(struct rb_node *node, struct rb_root *root,
  77                     const struct rb_augment_callbacks *augment)
  78 {
  79         __rb_insert_augmented(node, root, augment->rotate);
  80 }
  81
  82 #define RB_DECLARE_CALLBACKS(rbstatic, rbname, rbstruct, rbfield,             \
  83                              rbtype, rbaugmented, rbcompute)                  \
  84 static void rbname ## _propagate(struct rb_node *rb, struct rb_node *stop)    \
  85 {                                                                             \
  86         while (rb != stop) {                                                  \
  87                 rbstruct *node = rb_entry(rb, rbstruct, rbfield);             \
  88                 rbtype augmented = rbcompute(node);                           \
  89                 if (node->rbaugmented == augmented)                           \
  90                         break;                                                \
  91                 node->rbaugmented = augmented;                                \
  92                 rb = rb_parent(&node->rbfield);                               \
  93         }                                                                     \
  94 }                                                                             \
  95 static void rbname ## _copy(struct rb_node *rb_old, struct rb_node *rb_new)   \
  96 {                                                                             \
  97         rbstruct *old = rb_entry(rb_old, rbstruct, rbfield);                  \
  98         rbstruct *new = rb_entry(rb_new, rbstruct, rbfield);                  \
  99         new->rbaugmented = old->rbaugmented;                                  \
 100 }                                                                             \
 101 static void rbname ## _rotate(struct rb_node *rb_old, struct rb_node *rb_new) \
 102 {                                                                             \
 103         rbstruct *old = rb_entry(rb_old, rbstruct, rbfield);                  \
 104         rbstruct *new = rb_entry(rb_new, rbstruct, rbfield);                  \
 105         new->rbaugmented = old->rbaugmented;                                  \
 106         old->rbaugmented = rbcompute(old);                                    \
 107 }                                                                             \
 108 rbstatic const struct rb_augment_callbacks rbname = {                         \
 109         rbname ## _propagate, rbname ## _copy, rbname ## _rotate              \
 110 };
 111
 112
 113 /* Find logical next and previous nodes in a tree */
 114 extern struct rb_node *rb_next(const struct rb_node *);
 115 extern struct rb_node *rb_prev(const struct rb_node *);
 116 extern struct rb_node *rb_first(const struct rb_root *);
 117 extern struct rb_node *rb_last(const struct rb_root *);
 118
 119 /* Fast replacement of a single node without remove/rebalance/add/rebalance */
 120 extern void rb_replace_node(struct rb_node *victim, struct rb_node *new,
 121                             struct rb_root *root);
 122
 123 static inline void rb_link_node(struct rb_node * node, struct rb_node * parent,
 124                                 struct rb_node ** rb_link)
 125 {
 126         node->__rb_parent_color = (unsigned long)parent;
 127         node->rb_left = node->rb_right = NULL;
 128
 129         *rb_link = node;
 130 }
 131
 132 #endif  /* _LINUX_RBTREE_H */