blob: ba4a9d165f1bed3c39651387def0008fc793fbd6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 Red Black Trees
3 (C) 1999 Andrea Arcangeli <andrea@suse.de>
4 (C) 2002 David Woodhouse <dwmw2@infradead.org>
Michel Lespinasse46b61352012-10-08 16:31:11 -07005 (C) 2012 Michel Lespinasse <walken@google.com>
6
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
21 linux/lib/rbtree.c
22*/
23
Michel Lespinasse9c079ad2012-10-08 16:31:33 -070024#include <linux/rbtree_augmented.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050025#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
Michel Lespinasse5bc91882012-10-08 16:30:47 -070027/*
28 * red-black trees properties: http://en.wikipedia.org/wiki/Rbtree
29 *
30 * 1) A node is either red or black
31 * 2) The root is black
32 * 3) All leaves (NULL) are black
33 * 4) Both children of every red node are black
34 * 5) Every simple path from root to leaves contains the same number
35 * of black nodes.
36 *
37 * 4 and 5 give the O(log n) guarantee, since 4 implies you cannot have two
38 * consecutive red nodes in a path and every red node is therefore followed by
39 * a black. So if B is the number of black nodes on every simple path (as per
40 * 5), then the longest possible path due to 4 is 2B.
41 *
42 * We shall indicate color with case, where black nodes are uppercase and red
Michel Lespinasse6280d232012-10-08 16:30:57 -070043 * nodes will be lowercase. Unknown color nodes shall be drawn as red within
44 * parentheses and have some accompanying text comment.
Michel Lespinasse5bc91882012-10-08 16:30:47 -070045 */
46
Peter Zijlstrad72da4a2015-05-27 11:09:36 +093047/*
48 * Notes on lockless lookups:
49 *
50 * All stores to the tree structure (rb_left and rb_right) must be done using
51 * WRITE_ONCE(). And we must not inadvertently cause (temporary) loops in the
52 * tree structure as seen in program order.
53 *
54 * These two requirements will allow lockless iteration of the tree -- not
55 * correct iteration mind you, tree rotations are not atomic so a lookup might
56 * miss entire subtrees.
57 *
58 * But they do guarantee that any such traversal will only see valid elements
59 * and that it will indeed complete -- does not get stuck in a loop.
60 *
61 * It also guarantees that if the lookup returns an element it is the 'correct'
62 * one. But not returning an element does _NOT_ mean it's not present.
63 *
64 * NOTE:
65 *
66 * Stores to __rb_parent_color are not important for simple lookups so those
67 * are left undone as of now. Nor did I check for loops involving parent
68 * pointers.
69 */
70
Michel Lespinasse46b61352012-10-08 16:31:11 -070071static inline void rb_set_black(struct rb_node *rb)
72{
73 rb->__rb_parent_color |= RB_BLACK;
74}
75
Michel Lespinasse5bc91882012-10-08 16:30:47 -070076static inline struct rb_node *rb_red_parent(struct rb_node *red)
77{
78 return (struct rb_node *)red->__rb_parent_color;
79}
80
Michel Lespinasse5bc91882012-10-08 16:30:47 -070081/*
82 * Helper function for rotations:
83 * - old's parent and color get assigned to new
84 * - old gets assigned new as a parent and 'color' as a color.
85 */
86static inline void
87__rb_rotate_set_parents(struct rb_node *old, struct rb_node *new,
88 struct rb_root *root, int color)
89{
90 struct rb_node *parent = rb_parent(old);
91 new->__rb_parent_color = old->__rb_parent_color;
92 rb_set_parent_color(old, new, color);
Michel Lespinasse7abc7042012-10-08 16:31:07 -070093 __rb_change_child(old, new, parent, root);
Michel Lespinasse5bc91882012-10-08 16:30:47 -070094}
95
Michel Lespinasse14b94af2012-10-08 16:31:17 -070096static __always_inline void
97__rb_insert(struct rb_node *node, struct rb_root *root,
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -070098 bool newleft, struct rb_node **leftmost,
Michel Lespinasse14b94af2012-10-08 16:31:17 -070099 void (*augment_rotate)(struct rb_node *old, struct rb_node *new))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100{
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700101 struct rb_node *parent = rb_red_parent(node), *gparent, *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -0700103 if (newleft)
104 *leftmost = node;
105
Michel Lespinasse6d584522012-10-08 16:30:44 -0700106 while (true) {
107 /*
Davidlohr Bueso2aadf7f2017-09-08 16:14:39 -0700108 * Loop invariant: node is red.
Michel Lespinasse6d584522012-10-08 16:30:44 -0700109 */
Davidlohr Bueso2aadf7f2017-09-08 16:14:39 -0700110 if (unlikely(!parent)) {
111 /*
112 * The inserted node is root. Either this is the
113 * first node, or we recursed at Case 1 below and
114 * are no longer violating 4).
115 */
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700116 rb_set_parent_color(node, NULL, RB_BLACK);
Michel Lespinasse6d584522012-10-08 16:30:44 -0700117 break;
Davidlohr Bueso2aadf7f2017-09-08 16:14:39 -0700118 }
119
120 /*
121 * If there is a black parent, we are done.
122 * Otherwise, take some corrective action as,
123 * per 4), we don't want a red root or two
124 * consecutive red nodes.
125 */
126 if(rb_is_black(parent))
Michel Lespinasse6d584522012-10-08 16:30:44 -0700127 break;
128
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700129 gparent = rb_red_parent(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Michel Lespinasse59633ab2012-10-08 16:31:02 -0700131 tmp = gparent->rb_right;
132 if (parent != tmp) { /* parent == gparent->rb_left */
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700133 if (tmp && rb_is_red(tmp)) {
134 /*
Davidlohr Bueso35dc67d2017-09-08 16:14:42 -0700135 * Case 1 - node's uncle is red (color flips).
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700136 *
137 * G g
138 * / \ / \
139 * p u --> P U
140 * / /
Wei Yang1b9c53e2014-08-08 14:22:14 -0700141 * n n
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700142 *
143 * However, since g's parent might be red, and
144 * 4) does not allow this, we need to recurse
145 * at g.
146 */
147 rb_set_parent_color(tmp, gparent, RB_BLACK);
148 rb_set_parent_color(parent, gparent, RB_BLACK);
149 node = gparent;
150 parent = rb_parent(node);
151 rb_set_parent_color(node, parent, RB_RED);
152 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 }
154
Michel Lespinasse59633ab2012-10-08 16:31:02 -0700155 tmp = parent->rb_right;
156 if (node == tmp) {
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700157 /*
Davidlohr Bueso35dc67d2017-09-08 16:14:42 -0700158 * Case 2 - node's uncle is black and node is
159 * the parent's right child (left rotate at parent).
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700160 *
161 * G G
162 * / \ / \
163 * p U --> n U
164 * \ /
165 * n p
166 *
167 * This still leaves us in violation of 4), the
168 * continuation into Case 3 will fix that.
169 */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930170 tmp = node->rb_left;
171 WRITE_ONCE(parent->rb_right, tmp);
172 WRITE_ONCE(node->rb_left, parent);
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700173 if (tmp)
174 rb_set_parent_color(tmp, parent,
175 RB_BLACK);
176 rb_set_parent_color(parent, node, RB_RED);
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700177 augment_rotate(parent, node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 parent = node;
Michel Lespinasse59633ab2012-10-08 16:31:02 -0700179 tmp = node->rb_right;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 }
181
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700182 /*
Davidlohr Bueso35dc67d2017-09-08 16:14:42 -0700183 * Case 3 - node's uncle is black and node is
184 * the parent's left child (right rotate at gparent).
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700185 *
186 * G P
187 * / \ / \
188 * p U --> n g
189 * / \
190 * n U
191 */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930192 WRITE_ONCE(gparent->rb_left, tmp); /* == parent->rb_right */
193 WRITE_ONCE(parent->rb_right, gparent);
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700194 if (tmp)
195 rb_set_parent_color(tmp, gparent, RB_BLACK);
196 __rb_rotate_set_parents(gparent, parent, root, RB_RED);
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700197 augment_rotate(gparent, parent);
Michel Lespinasse1f052862012-10-08 16:30:42 -0700198 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 } else {
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700200 tmp = gparent->rb_left;
201 if (tmp && rb_is_red(tmp)) {
202 /* Case 1 - color flips */
203 rb_set_parent_color(tmp, gparent, RB_BLACK);
204 rb_set_parent_color(parent, gparent, RB_BLACK);
205 node = gparent;
206 parent = rb_parent(node);
207 rb_set_parent_color(node, parent, RB_RED);
208 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 }
210
Michel Lespinasse59633ab2012-10-08 16:31:02 -0700211 tmp = parent->rb_left;
212 if (node == tmp) {
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700213 /* Case 2 - right rotate at parent */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930214 tmp = node->rb_right;
215 WRITE_ONCE(parent->rb_left, tmp);
216 WRITE_ONCE(node->rb_right, parent);
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700217 if (tmp)
218 rb_set_parent_color(tmp, parent,
219 RB_BLACK);
220 rb_set_parent_color(parent, node, RB_RED);
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700221 augment_rotate(parent, node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 parent = node;
Michel Lespinasse59633ab2012-10-08 16:31:02 -0700223 tmp = node->rb_left;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 }
225
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700226 /* Case 3 - left rotate at gparent */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930227 WRITE_ONCE(gparent->rb_right, tmp); /* == parent->rb_left */
228 WRITE_ONCE(parent->rb_left, gparent);
Michel Lespinasse5bc91882012-10-08 16:30:47 -0700229 if (tmp)
230 rb_set_parent_color(tmp, gparent, RB_BLACK);
231 __rb_rotate_set_parents(gparent, parent, root, RB_RED);
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700232 augment_rotate(gparent, parent);
Michel Lespinasse1f052862012-10-08 16:30:42 -0700233 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 }
235 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Michel Lespinasse3cb7a562013-01-11 14:32:20 -0800238/*
239 * Inline version for rb_erase() use - we want to be able to inline
240 * and eliminate the dummy_rotate callback there
241 */
242static __always_inline void
243____rb_erase_color(struct rb_node *parent, struct rb_root *root,
Michel Lespinasse9c079ad2012-10-08 16:31:33 -0700244 void (*augment_rotate)(struct rb_node *old, struct rb_node *new))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
Michel Lespinasse46b61352012-10-08 16:31:11 -0700246 struct rb_node *node = NULL, *sibling, *tmp1, *tmp2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Michel Lespinassed6ff1272012-10-08 16:30:50 -0700248 while (true) {
249 /*
Michel Lespinasse46b61352012-10-08 16:31:11 -0700250 * Loop invariants:
251 * - node is black (or NULL on first iteration)
252 * - node is not the root (parent is not NULL)
253 * - All leaf paths going through parent and node have a
254 * black node count that is 1 lower than other leaf paths.
Michel Lespinassed6ff1272012-10-08 16:30:50 -0700255 */
Michel Lespinasse59633ab2012-10-08 16:31:02 -0700256 sibling = parent->rb_right;
257 if (node != sibling) { /* node == parent->rb_left */
Michel Lespinasse6280d232012-10-08 16:30:57 -0700258 if (rb_is_red(sibling)) {
259 /*
260 * Case 1 - left rotate at parent
261 *
262 * P S
263 * / \ / \
264 * N s --> p Sr
265 * / \ / \
266 * Sl Sr N Sl
267 */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930268 tmp1 = sibling->rb_left;
269 WRITE_ONCE(parent->rb_right, tmp1);
270 WRITE_ONCE(sibling->rb_left, parent);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700271 rb_set_parent_color(tmp1, parent, RB_BLACK);
272 __rb_rotate_set_parents(parent, sibling, root,
273 RB_RED);
Michel Lespinasse9c079ad2012-10-08 16:31:33 -0700274 augment_rotate(parent, sibling);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700275 sibling = tmp1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 }
Michel Lespinasse6280d232012-10-08 16:30:57 -0700277 tmp1 = sibling->rb_right;
278 if (!tmp1 || rb_is_black(tmp1)) {
279 tmp2 = sibling->rb_left;
280 if (!tmp2 || rb_is_black(tmp2)) {
281 /*
282 * Case 2 - sibling color flip
283 * (p could be either color here)
284 *
285 * (p) (p)
286 * / \ / \
287 * N S --> N s
288 * / \ / \
289 * Sl Sr Sl Sr
290 *
Michel Lespinasse46b61352012-10-08 16:31:11 -0700291 * This leaves us violating 5) which
292 * can be fixed by flipping p to black
293 * if it was red, or by recursing at p.
294 * p is red when coming from Case 1.
Michel Lespinasse6280d232012-10-08 16:30:57 -0700295 */
296 rb_set_parent_color(sibling, parent,
297 RB_RED);
Michel Lespinasse46b61352012-10-08 16:31:11 -0700298 if (rb_is_red(parent))
299 rb_set_black(parent);
300 else {
301 node = parent;
302 parent = rb_parent(node);
303 if (parent)
304 continue;
305 }
306 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 }
Michel Lespinasse6280d232012-10-08 16:30:57 -0700308 /*
309 * Case 3 - right rotate at sibling
310 * (p could be either color here)
311 *
312 * (p) (p)
313 * / \ / \
Jie Chence093a02016-12-12 16:46:17 -0800314 * N S --> N sl
Michel Lespinasse6280d232012-10-08 16:30:57 -0700315 * / \ \
Jie Chence093a02016-12-12 16:46:17 -0800316 * sl Sr S
Michel Lespinasse6280d232012-10-08 16:30:57 -0700317 * \
318 * Sr
Jie Chence093a02016-12-12 16:46:17 -0800319 *
320 * Note: p might be red, and then both
321 * p and sl are red after rotation(which
322 * breaks property 4). This is fixed in
323 * Case 4 (in __rb_rotate_set_parents()
324 * which set sl the color of p
325 * and set p RB_BLACK)
326 *
327 * (p) (sl)
328 * / \ / \
329 * N sl --> P S
330 * \ / \
331 * S N Sr
332 * \
333 * Sr
Michel Lespinasse6280d232012-10-08 16:30:57 -0700334 */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930335 tmp1 = tmp2->rb_right;
336 WRITE_ONCE(sibling->rb_left, tmp1);
337 WRITE_ONCE(tmp2->rb_right, sibling);
338 WRITE_ONCE(parent->rb_right, tmp2);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700339 if (tmp1)
340 rb_set_parent_color(tmp1, sibling,
341 RB_BLACK);
Michel Lespinasse9c079ad2012-10-08 16:31:33 -0700342 augment_rotate(sibling, tmp2);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700343 tmp1 = sibling;
344 sibling = tmp2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 }
Michel Lespinasse6280d232012-10-08 16:30:57 -0700346 /*
347 * Case 4 - left rotate at parent + color flips
348 * (p and sl could be either color here.
349 * After rotation, p becomes black, s acquires
350 * p's color, and sl keeps its color)
351 *
352 * (p) (s)
353 * / \ / \
354 * N S --> P Sr
355 * / \ / \
356 * (sl) sr N (sl)
357 */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930358 tmp2 = sibling->rb_left;
359 WRITE_ONCE(parent->rb_right, tmp2);
360 WRITE_ONCE(sibling->rb_left, parent);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700361 rb_set_parent_color(tmp1, sibling, RB_BLACK);
362 if (tmp2)
363 rb_set_parent(tmp2, parent);
364 __rb_rotate_set_parents(parent, sibling, root,
365 RB_BLACK);
Michel Lespinasse9c079ad2012-10-08 16:31:33 -0700366 augment_rotate(parent, sibling);
Michel Lespinassee125d142012-10-08 16:30:54 -0700367 break;
Michel Lespinassed6ff1272012-10-08 16:30:50 -0700368 } else {
Michel Lespinasse6280d232012-10-08 16:30:57 -0700369 sibling = parent->rb_left;
370 if (rb_is_red(sibling)) {
371 /* Case 1 - right rotate at parent */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930372 tmp1 = sibling->rb_right;
373 WRITE_ONCE(parent->rb_left, tmp1);
374 WRITE_ONCE(sibling->rb_right, parent);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700375 rb_set_parent_color(tmp1, parent, RB_BLACK);
376 __rb_rotate_set_parents(parent, sibling, root,
377 RB_RED);
Michel Lespinasse9c079ad2012-10-08 16:31:33 -0700378 augment_rotate(parent, sibling);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700379 sibling = tmp1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 }
Michel Lespinasse6280d232012-10-08 16:30:57 -0700381 tmp1 = sibling->rb_left;
382 if (!tmp1 || rb_is_black(tmp1)) {
383 tmp2 = sibling->rb_right;
384 if (!tmp2 || rb_is_black(tmp2)) {
385 /* Case 2 - sibling color flip */
386 rb_set_parent_color(sibling, parent,
387 RB_RED);
Michel Lespinasse46b61352012-10-08 16:31:11 -0700388 if (rb_is_red(parent))
389 rb_set_black(parent);
390 else {
391 node = parent;
392 parent = rb_parent(node);
393 if (parent)
394 continue;
395 }
396 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 }
Jie Chence093a02016-12-12 16:46:17 -0800398 /* Case 3 - left rotate at sibling */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930399 tmp1 = tmp2->rb_left;
400 WRITE_ONCE(sibling->rb_right, tmp1);
401 WRITE_ONCE(tmp2->rb_left, sibling);
402 WRITE_ONCE(parent->rb_left, tmp2);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700403 if (tmp1)
404 rb_set_parent_color(tmp1, sibling,
405 RB_BLACK);
Michel Lespinasse9c079ad2012-10-08 16:31:33 -0700406 augment_rotate(sibling, tmp2);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700407 tmp1 = sibling;
408 sibling = tmp2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 }
Jie Chence093a02016-12-12 16:46:17 -0800410 /* Case 4 - right rotate at parent + color flips */
Peter Zijlstrad72da4a2015-05-27 11:09:36 +0930411 tmp2 = sibling->rb_right;
412 WRITE_ONCE(parent->rb_left, tmp2);
413 WRITE_ONCE(sibling->rb_right, parent);
Michel Lespinasse6280d232012-10-08 16:30:57 -0700414 rb_set_parent_color(tmp1, sibling, RB_BLACK);
415 if (tmp2)
416 rb_set_parent(tmp2, parent);
417 __rb_rotate_set_parents(parent, sibling, root,
418 RB_BLACK);
Michel Lespinasse9c079ad2012-10-08 16:31:33 -0700419 augment_rotate(parent, sibling);
Michel Lespinassee125d142012-10-08 16:30:54 -0700420 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 }
422 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423}
Michel Lespinasse3cb7a562013-01-11 14:32:20 -0800424
425/* Non-inline version for rb_erase_augmented() use */
426void __rb_erase_color(struct rb_node *parent, struct rb_root *root,
427 void (*augment_rotate)(struct rb_node *old, struct rb_node *new))
428{
429 ____rb_erase_color(parent, root, augment_rotate);
430}
Michel Lespinasse9c079ad2012-10-08 16:31:33 -0700431EXPORT_SYMBOL(__rb_erase_color);
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700432
433/*
434 * Non-augmented rbtree manipulation functions.
435 *
436 * We use dummy augmented callbacks here, and have the compiler optimize them
437 * out of the rb_insert_color() and rb_erase() function definitions.
438 */
439
440static inline void dummy_propagate(struct rb_node *node, struct rb_node *stop) {}
441static inline void dummy_copy(struct rb_node *old, struct rb_node *new) {}
442static inline void dummy_rotate(struct rb_node *old, struct rb_node *new) {}
443
444static const struct rb_augment_callbacks dummy_callbacks = {
Kees Cookf231aeb2017-02-24 15:01:04 -0800445 .propagate = dummy_propagate,
446 .copy = dummy_copy,
447 .rotate = dummy_rotate
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700448};
449
450void rb_insert_color(struct rb_node *node, struct rb_root *root)
451{
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -0700452 __rb_insert(node, root, false, NULL, dummy_rotate);
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700453}
454EXPORT_SYMBOL(rb_insert_color);
455
456void rb_erase(struct rb_node *node, struct rb_root *root)
457{
Michel Lespinasse3cb7a562013-01-11 14:32:20 -0800458 struct rb_node *rebalance;
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -0700459 rebalance = __rb_erase_augmented(node, root,
460 NULL, &dummy_callbacks);
Michel Lespinasse3cb7a562013-01-11 14:32:20 -0800461 if (rebalance)
462 ____rb_erase_color(rebalance, root, dummy_rotate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463}
464EXPORT_SYMBOL(rb_erase);
465
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -0700466void rb_insert_color_cached(struct rb_node *node,
467 struct rb_root_cached *root, bool leftmost)
468{
469 __rb_insert(node, &root->rb_root, leftmost,
470 &root->rb_leftmost, dummy_rotate);
471}
472EXPORT_SYMBOL(rb_insert_color_cached);
473
474void rb_erase_cached(struct rb_node *node, struct rb_root_cached *root)
475{
476 struct rb_node *rebalance;
477 rebalance = __rb_erase_augmented(node, &root->rb_root,
478 &root->rb_leftmost, &dummy_callbacks);
479 if (rebalance)
480 ____rb_erase_color(rebalance, &root->rb_root, dummy_rotate);
481}
482EXPORT_SYMBOL(rb_erase_cached);
483
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700484/*
485 * Augmented rbtree manipulation functions.
486 *
487 * This instantiates the same __always_inline functions as in the non-augmented
488 * case, but this time with user-defined callbacks.
489 */
490
491void __rb_insert_augmented(struct rb_node *node, struct rb_root *root,
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -0700492 bool newleft, struct rb_node **leftmost,
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700493 void (*augment_rotate)(struct rb_node *old, struct rb_node *new))
494{
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -0700495 __rb_insert(node, root, newleft, leftmost, augment_rotate);
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700496}
497EXPORT_SYMBOL(__rb_insert_augmented);
498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499/*
500 * This function returns the first node (in sort order) of the tree.
501 */
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000502struct rb_node *rb_first(const struct rb_root *root)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503{
504 struct rb_node *n;
505
506 n = root->rb_node;
507 if (!n)
508 return NULL;
509 while (n->rb_left)
510 n = n->rb_left;
511 return n;
512}
513EXPORT_SYMBOL(rb_first);
514
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000515struct rb_node *rb_last(const struct rb_root *root)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516{
517 struct rb_node *n;
518
519 n = root->rb_node;
520 if (!n)
521 return NULL;
522 while (n->rb_right)
523 n = n->rb_right;
524 return n;
525}
526EXPORT_SYMBOL(rb_last);
527
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000528struct rb_node *rb_next(const struct rb_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
David Woodhouse55a98102006-04-21 13:35:51 +0100530 struct rb_node *parent;
531
Michel Lespinasse4c199a92012-10-08 16:30:32 -0700532 if (RB_EMPTY_NODE(node))
Jens Axboe10fd48f2006-07-11 21:15:52 +0200533 return NULL;
534
Michel Lespinasse7ce6ff92012-10-08 16:31:01 -0700535 /*
536 * If we have a right-hand child, go down and then left as far
537 * as we can.
538 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 if (node->rb_right) {
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -0700540 node = node->rb_right;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 while (node->rb_left)
542 node=node->rb_left;
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000543 return (struct rb_node *)node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 }
545
Michel Lespinasse7ce6ff92012-10-08 16:31:01 -0700546 /*
547 * No right-hand children. Everything down and left is smaller than us,
548 * so any 'next' node must be in the general direction of our parent.
549 * Go up the tree; any time the ancestor is a right-hand child of its
550 * parent, keep going up. First time it's a left-hand child of its
551 * parent, said parent is our 'next' node.
552 */
David Woodhouse55a98102006-04-21 13:35:51 +0100553 while ((parent = rb_parent(node)) && node == parent->rb_right)
554 node = parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
David Woodhouse55a98102006-04-21 13:35:51 +0100556 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557}
558EXPORT_SYMBOL(rb_next);
559
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000560struct rb_node *rb_prev(const struct rb_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561{
David Woodhouse55a98102006-04-21 13:35:51 +0100562 struct rb_node *parent;
563
Michel Lespinasse4c199a92012-10-08 16:30:32 -0700564 if (RB_EMPTY_NODE(node))
Jens Axboe10fd48f2006-07-11 21:15:52 +0200565 return NULL;
566
Michel Lespinasse7ce6ff92012-10-08 16:31:01 -0700567 /*
568 * If we have a left-hand child, go down and then right as far
569 * as we can.
570 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 if (node->rb_left) {
Davidlohr Buesocd9e61e2017-09-08 16:14:36 -0700572 node = node->rb_left;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 while (node->rb_right)
574 node=node->rb_right;
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000575 return (struct rb_node *)node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 }
577
Michel Lespinasse7ce6ff92012-10-08 16:31:01 -0700578 /*
579 * No left-hand children. Go up till we find an ancestor which
580 * is a right-hand child of its parent.
581 */
David Woodhouse55a98102006-04-21 13:35:51 +0100582 while ((parent = rb_parent(node)) && node == parent->rb_left)
583 node = parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
David Woodhouse55a98102006-04-21 13:35:51 +0100585 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586}
587EXPORT_SYMBOL(rb_prev);
588
589void rb_replace_node(struct rb_node *victim, struct rb_node *new,
590 struct rb_root *root)
591{
David Woodhouse55a98102006-04-21 13:35:51 +0100592 struct rb_node *parent = rb_parent(victim);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
David Howellsc1adf202016-07-01 07:53:51 +0100594 /* Copy the pointers/colour from the victim to the replacement */
595 *new = *victim;
596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 /* Set the surrounding nodes to point to the replacement */
David Howellsc1adf202016-07-01 07:53:51 +0100598 if (victim->rb_left)
599 rb_set_parent(victim->rb_left, new);
600 if (victim->rb_right)
601 rb_set_parent(victim->rb_right, new);
Michel Lespinasse7abc7042012-10-08 16:31:07 -0700602 __rb_change_child(victim, new, parent, root);
David Howellsc1adf202016-07-01 07:53:51 +0100603}
604EXPORT_SYMBOL(rb_replace_node);
605
606void rb_replace_node_rcu(struct rb_node *victim, struct rb_node *new,
607 struct rb_root *root)
608{
609 struct rb_node *parent = rb_parent(victim);
610
611 /* Copy the pointers/colour from the victim to the replacement */
612 *new = *victim;
613
614 /* Set the surrounding nodes to point to the replacement */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 if (victim->rb_left)
David Woodhouse55a98102006-04-21 13:35:51 +0100616 rb_set_parent(victim->rb_left, new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 if (victim->rb_right)
David Woodhouse55a98102006-04-21 13:35:51 +0100618 rb_set_parent(victim->rb_right, new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
David Howellsc1adf202016-07-01 07:53:51 +0100620 /* Set the parent's pointer to the new node last after an RCU barrier
621 * so that the pointers onwards are seen to be set correctly when doing
622 * an RCU walk over the tree.
623 */
624 __rb_change_child_rcu(victim, new, parent, root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625}
David Howellsc1adf202016-07-01 07:53:51 +0100626EXPORT_SYMBOL(rb_replace_node_rcu);
Cody P Schafer9dee5c52013-09-11 14:25:10 -0700627
628static struct rb_node *rb_left_deepest_node(const struct rb_node *node)
629{
630 for (;;) {
631 if (node->rb_left)
632 node = node->rb_left;
633 else if (node->rb_right)
634 node = node->rb_right;
635 else
636 return (struct rb_node *)node;
637 }
638}
639
640struct rb_node *rb_next_postorder(const struct rb_node *node)
641{
642 const struct rb_node *parent;
643 if (!node)
644 return NULL;
645 parent = rb_parent(node);
646
647 /* If we're sitting on node, we've already seen our children */
648 if (parent && node == parent->rb_left && parent->rb_right) {
649 /* If we are the parent's left node, go to the parent's right
650 * node then all the way down to the left */
651 return rb_left_deepest_node(parent->rb_right);
652 } else
653 /* Otherwise we are the parent's right node, and the parent
654 * should be next */
655 return (struct rb_node *)parent;
656}
657EXPORT_SYMBOL(rb_next_postorder);
658
659struct rb_node *rb_first_postorder(const struct rb_root *root)
660{
661 if (!root->rb_node)
662 return NULL;
663
664 return rb_left_deepest_node(root->rb_node);
665}
666EXPORT_SYMBOL(rb_first_postorder);