pm: Add a stub for pm_destroy()
[akaros.git] / kern / include / 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 #pragma once
30
31 /* TODO: eventually we'll support some form of RCU and concurrent rb-tree
32  * usage.  When we do that, we'll need to grab these functions from Linux. */
33 #ifndef rcu_assign_pointer
34 #define rcu_assign_pointer(d, s) (d) = (s)
35 #endif
36
37 struct rb_node {
38         unsigned long  __rb_parent_color;
39         struct rb_node *rb_right;
40         struct rb_node *rb_left;
41 } __attribute__((aligned(sizeof(long))));
42     /* The alignment might seem pointless, but allegedly CRIS needs it */
43
44 struct rb_root {
45         struct rb_node *rb_node;
46 };
47
48
49 #define rb_parent(r)   ((struct rb_node *)((r)->__rb_parent_color & ~3))
50
51 #define RB_ROOT (struct rb_root) { NULL, }
52 #define rb_entry(ptr, type, member) container_of(ptr, type, member)
53
54 #define RB_EMPTY_ROOT(root)  (READ_ONCE((root)->rb_node) == NULL)
55
56 /* 'empty' nodes are nodes that are known not to be inserted in an rbtree */
57 #define RB_EMPTY_NODE(node)  \
58         ((node)->__rb_parent_color == (unsigned long)(node))
59 #define RB_CLEAR_NODE(node)  \
60         ((node)->__rb_parent_color = (unsigned long)(node))
61
62
63 extern void rb_insert_color(struct rb_node *, struct rb_root *);
64 extern void rb_erase(struct rb_node *, struct rb_root *);
65
66
67 /* Find logical next and previous nodes in a tree */
68 extern struct rb_node *rb_next(const struct rb_node *);
69 extern struct rb_node *rb_prev(const struct rb_node *);
70 extern struct rb_node *rb_first(const struct rb_root *);
71 extern struct rb_node *rb_last(const struct rb_root *);
72
73 /* Postorder iteration - always visit the parent after its children */
74 extern struct rb_node *rb_first_postorder(const struct rb_root *);
75 extern struct rb_node *rb_next_postorder(const struct rb_node *);
76
77 /* Fast replacement of a single node without remove/rebalance/add/rebalance */
78 extern void rb_replace_node(struct rb_node *victim, struct rb_node *new,
79                             struct rb_root *root);
80 extern void rb_replace_node_rcu(struct rb_node *victim, struct rb_node *new,
81                                 struct rb_root *root);
82
83 static inline void rb_link_node(struct rb_node *node, struct rb_node *parent,
84                                 struct rb_node **rb_link)
85 {
86         node->__rb_parent_color = (unsigned long)parent;
87         node->rb_left = node->rb_right = NULL;
88
89         *rb_link = node;
90 }
91
92 static inline void rb_link_node_rcu(struct rb_node *node, struct rb_node *parent,
93                                     struct rb_node **rb_link)
94 {
95         node->__rb_parent_color = (unsigned long)parent;
96         node->rb_left = node->rb_right = NULL;
97
98         rcu_assign_pointer(*rb_link, node);
99 }
100
101 #define rb_entry_safe(ptr, type, member) \
102         ({ typeof(ptr) ____ptr = (ptr); \
103            ____ptr ? rb_entry(____ptr, type, member) : NULL; \
104         })
105
106 /**
107  * rbtree_postorder_for_each_entry_safe - iterate in post-order over rb_root of
108  * given type allowing the backing memory of @pos to be invalidated
109  *
110  * @pos:        the 'type *' to use as a loop cursor.
111  * @n:          another 'type *' to use as temporary storage
112  * @root:       'rb_root *' of the rbtree.
113  * @field:      the name of the rb_node field within 'type'.
114  *
115  * rbtree_postorder_for_each_entry_safe() provides a similar guarantee as
116  * list_for_each_entry_safe() and allows the iteration to continue independent
117  * of changes to @pos by the body of the loop.
118  *
119  * Note, however, that it cannot handle other modifications that re-order the
120  * rbtree it is iterating over. This includes calling rb_erase() on @pos, as
121  * rb_erase() may rebalance the tree, causing us to miss some nodes.
122  */
123 #define rbtree_postorder_for_each_entry_safe(pos, n, root, field) \
124         for (pos = rb_entry_safe(rb_first_postorder(root), typeof(*pos), field); \
125              pos && ({ n = rb_entry_safe(rb_next_postorder(&pos->field), \
126                         typeof(*pos), field); 1; }); \
127              pos = n)