include/linux/rbtree.h

   1 /*
   2   Red Black Trees
   3   (C) 1999  Andrea Arcangeli <andrea@suse.de>
   4
   5  * SPDX-License-Identifier:     GPL-2.0+
   6
   7   linux/include/linux/rbtree.h
   8
   9   To use rbtrees you'll have to implement your own insert and search cores.
  10   This will avoid us to use callbacks and to drop drammatically performances.
  11   I know it's not the cleaner way,  but in C (not in C++) to get
  12   performances and genericity...
  13
  14   See Documentation/rbtree.txt for documentation and samples.
  15 */
  16
  17 #ifndef _LINUX_RBTREE_H
  18 #define _LINUX_RBTREE_H
  19
  20 #define __UBOOT__
  21 #ifndef __UBOOT__
  22 #include <linux/kernel.h>
  23 #endif
  24 #include <linux/stddef.h>
  25
  26 struct rb_node {
  27         unsigned long  __rb_parent_color;
  28         struct rb_node *rb_right;
  29         struct rb_node *rb_left;
  30 } __attribute__((aligned(sizeof(long))));
  31     /* The alignment might seem pointless, but allegedly CRIS needs it */
  32
  33 struct rb_root {
  34         struct rb_node *rb_node;
  35 };
  36
  37
  38 #define rb_parent(r)   ((struct rb_node *)((r)->__rb_parent_color & ~3))
  39
  40 #define RB_ROOT (struct rb_root) { NULL, }
  41 #define rb_entry(ptr, type, member) container_of(ptr, type, member)
  42
  43 #define RB_EMPTY_ROOT(root)  ((root)->rb_node == NULL)
  44
  45 /* 'empty' nodes are nodes that are known not to be inserted in an rbree */
  46 #define RB_EMPTY_NODE(node)  \
  47         ((node)->__rb_parent_color == (unsigned long)(node))
  48 #define RB_CLEAR_NODE(node)  \
  49         ((node)->__rb_parent_color = (unsigned long)(node))
  50
  51
  52 extern void rb_insert_color(struct rb_node *, struct rb_root *);
  53 extern void rb_erase(struct rb_node *, struct rb_root *);
  54
  55
  56 /* Find logical next and previous nodes in a tree */
  57 extern struct rb_node *rb_next(const struct rb_node *);
  58 extern struct rb_node *rb_prev(const struct rb_node *);
  59 extern struct rb_node *rb_first(const struct rb_root *);
  60 extern struct rb_node *rb_last(const struct rb_root *);
  61
  62 /* Postorder iteration - always visit the parent after its children */
  63 extern struct rb_node *rb_first_postorder(const struct rb_root *);
  64 extern struct rb_node *rb_next_postorder(const struct rb_node *);
  65
  66 /* Fast replacement of a single node without remove/rebalance/add/rebalance */
  67 extern void rb_replace_node(struct rb_node *victim, struct rb_node *new,
  68                             struct rb_root *root);
  69
  70 static inline void rb_link_node(struct rb_node * node, struct rb_node * parent,
  71                                 struct rb_node ** rb_link)
  72 {
  73         node->__rb_parent_color = (unsigned long)parent;
  74         node->rb_left = node->rb_right = NULL;
  75
  76         *rb_link = node;
  77 }
  78
  79 #define rb_entry_safe(ptr, type, member) \
  80         ({ typeof(ptr) ____ptr = (ptr); \
  81            ____ptr ? rb_entry(____ptr, type, member) : NULL; \
  82         })
  83
  84 /**
  85  * rbtree_postorder_for_each_entry_safe - iterate over rb_root in post order of
  86  * given type safe against removal of rb_node entry
  87  *
  88  * @pos:        the 'type *' to use as a loop cursor.
  89  * @n:          another 'type *' to use as temporary storage
  90  * @root:       'rb_root *' of the rbtree.
  91  * @field:      the name of the rb_node field within 'type'.
  92  */
  93 #define rbtree_postorder_for_each_entry_safe(pos, n, root, field) \
  94         for (pos = rb_entry_safe(rb_first_postorder(root), typeof(*pos), field); \
  95              pos && ({ n = rb_entry_safe(rb_next_postorder(&pos->field), \
  96                         typeof(*pos), field); 1; }); \
  97              pos = n)
  98
  99 #endif  /* _LINUX_RBTREE_H */