blob: a16be19a130545ce44fc4f8c6a3f9fde866b9159 [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>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
20 linux/lib/rbtree.c
21*/
22
23#include <linux/rbtree.h>
24#include <linux/module.h>
25
26static void __rb_rotate_left(struct rb_node *node, struct rb_root *root)
27{
28 struct rb_node *right = node->rb_right;
David Woodhouse55a98102006-04-21 13:35:51 +010029 struct rb_node *parent = rb_parent(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31 if ((node->rb_right = right->rb_left))
David Woodhouse55a98102006-04-21 13:35:51 +010032 rb_set_parent(right->rb_left, node);
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 right->rb_left = node;
34
David Woodhouse55a98102006-04-21 13:35:51 +010035 rb_set_parent(right, parent);
36
37 if (parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 {
David Woodhouse55a98102006-04-21 13:35:51 +010039 if (node == parent->rb_left)
40 parent->rb_left = right;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 else
David Woodhouse55a98102006-04-21 13:35:51 +010042 parent->rb_right = right;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 }
44 else
45 root->rb_node = right;
David Woodhouse55a98102006-04-21 13:35:51 +010046 rb_set_parent(node, right);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047}
48
49static void __rb_rotate_right(struct rb_node *node, struct rb_root *root)
50{
51 struct rb_node *left = node->rb_left;
David Woodhouse55a98102006-04-21 13:35:51 +010052 struct rb_node *parent = rb_parent(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54 if ((node->rb_left = left->rb_right))
David Woodhouse55a98102006-04-21 13:35:51 +010055 rb_set_parent(left->rb_right, node);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 left->rb_right = node;
57
David Woodhouse55a98102006-04-21 13:35:51 +010058 rb_set_parent(left, parent);
59
60 if (parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 {
David Woodhouse55a98102006-04-21 13:35:51 +010062 if (node == parent->rb_right)
63 parent->rb_right = left;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 else
David Woodhouse55a98102006-04-21 13:35:51 +010065 parent->rb_left = left;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 }
67 else
68 root->rb_node = left;
David Woodhouse55a98102006-04-21 13:35:51 +010069 rb_set_parent(node, left);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070}
71
72void rb_insert_color(struct rb_node *node, struct rb_root *root)
73{
74 struct rb_node *parent, *gparent;
75
David Woodhouse55a98102006-04-21 13:35:51 +010076 while ((parent = rb_parent(node)) && rb_is_red(parent))
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 {
David Woodhouse55a98102006-04-21 13:35:51 +010078 gparent = rb_parent(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80 if (parent == gparent->rb_left)
81 {
82 {
83 register struct rb_node *uncle = gparent->rb_right;
David Woodhouse55a98102006-04-21 13:35:51 +010084 if (uncle && rb_is_red(uncle))
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 {
David Woodhouse55a98102006-04-21 13:35:51 +010086 rb_set_black(uncle);
87 rb_set_black(parent);
88 rb_set_red(gparent);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 node = gparent;
90 continue;
91 }
92 }
93
94 if (parent->rb_right == node)
95 {
96 register struct rb_node *tmp;
97 __rb_rotate_left(parent, root);
98 tmp = parent;
99 parent = node;
100 node = tmp;
101 }
102
David Woodhouse55a98102006-04-21 13:35:51 +0100103 rb_set_black(parent);
104 rb_set_red(gparent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 __rb_rotate_right(gparent, root);
106 } else {
107 {
108 register struct rb_node *uncle = gparent->rb_left;
David Woodhouse55a98102006-04-21 13:35:51 +0100109 if (uncle && rb_is_red(uncle))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 {
David Woodhouse55a98102006-04-21 13:35:51 +0100111 rb_set_black(uncle);
112 rb_set_black(parent);
113 rb_set_red(gparent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 node = gparent;
115 continue;
116 }
117 }
118
119 if (parent->rb_left == node)
120 {
121 register struct rb_node *tmp;
122 __rb_rotate_right(parent, root);
123 tmp = parent;
124 parent = node;
125 node = tmp;
126 }
127
David Woodhouse55a98102006-04-21 13:35:51 +0100128 rb_set_black(parent);
129 rb_set_red(gparent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 __rb_rotate_left(gparent, root);
131 }
132 }
133
David Woodhouse55a98102006-04-21 13:35:51 +0100134 rb_set_black(root->rb_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135}
136EXPORT_SYMBOL(rb_insert_color);
137
138static void __rb_erase_color(struct rb_node *node, struct rb_node *parent,
139 struct rb_root *root)
140{
141 struct rb_node *other;
142
David Woodhouse55a98102006-04-21 13:35:51 +0100143 while ((!node || rb_is_black(node)) && node != root->rb_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 {
145 if (parent->rb_left == node)
146 {
147 other = parent->rb_right;
David Woodhouse55a98102006-04-21 13:35:51 +0100148 if (rb_is_red(other))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 {
David Woodhouse55a98102006-04-21 13:35:51 +0100150 rb_set_black(other);
151 rb_set_red(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 __rb_rotate_left(parent, root);
153 other = parent->rb_right;
154 }
David Woodhouse55a98102006-04-21 13:35:51 +0100155 if ((!other->rb_left || rb_is_black(other->rb_left)) &&
156 (!other->rb_right || rb_is_black(other->rb_right)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 {
David Woodhouse55a98102006-04-21 13:35:51 +0100158 rb_set_red(other);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 node = parent;
David Woodhouse55a98102006-04-21 13:35:51 +0100160 parent = rb_parent(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 }
162 else
163 {
David Woodhouse55a98102006-04-21 13:35:51 +0100164 if (!other->rb_right || rb_is_black(other->rb_right))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 {
Wolfram Strepp55a63992009-03-31 15:23:45 -0700166 rb_set_black(other->rb_left);
David Woodhouse55a98102006-04-21 13:35:51 +0100167 rb_set_red(other);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 __rb_rotate_right(other, root);
169 other = parent->rb_right;
170 }
David Woodhouse2f3243a2006-06-05 20:19:05 +0100171 rb_set_color(other, rb_color(parent));
David Woodhouse55a98102006-04-21 13:35:51 +0100172 rb_set_black(parent);
Wolfram Strepp55a63992009-03-31 15:23:45 -0700173 rb_set_black(other->rb_right);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 __rb_rotate_left(parent, root);
175 node = root->rb_node;
176 break;
177 }
178 }
179 else
180 {
181 other = parent->rb_left;
David Woodhouse55a98102006-04-21 13:35:51 +0100182 if (rb_is_red(other))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 {
David Woodhouse55a98102006-04-21 13:35:51 +0100184 rb_set_black(other);
185 rb_set_red(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 __rb_rotate_right(parent, root);
187 other = parent->rb_left;
188 }
David Woodhouse55a98102006-04-21 13:35:51 +0100189 if ((!other->rb_left || rb_is_black(other->rb_left)) &&
190 (!other->rb_right || rb_is_black(other->rb_right)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 {
David Woodhouse55a98102006-04-21 13:35:51 +0100192 rb_set_red(other);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 node = parent;
David Woodhouse55a98102006-04-21 13:35:51 +0100194 parent = rb_parent(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 }
196 else
197 {
David Woodhouse55a98102006-04-21 13:35:51 +0100198 if (!other->rb_left || rb_is_black(other->rb_left))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 {
Wolfram Strepp55a63992009-03-31 15:23:45 -0700200 rb_set_black(other->rb_right);
David Woodhouse55a98102006-04-21 13:35:51 +0100201 rb_set_red(other);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 __rb_rotate_left(other, root);
203 other = parent->rb_left;
204 }
David Woodhouse2f3243a2006-06-05 20:19:05 +0100205 rb_set_color(other, rb_color(parent));
David Woodhouse55a98102006-04-21 13:35:51 +0100206 rb_set_black(parent);
Wolfram Strepp55a63992009-03-31 15:23:45 -0700207 rb_set_black(other->rb_left);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 __rb_rotate_right(parent, root);
209 node = root->rb_node;
210 break;
211 }
212 }
213 }
214 if (node)
David Woodhouse55a98102006-04-21 13:35:51 +0100215 rb_set_black(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216}
217
218void rb_erase(struct rb_node *node, struct rb_root *root)
219{
220 struct rb_node *child, *parent;
221 int color;
222
223 if (!node->rb_left)
224 child = node->rb_right;
225 else if (!node->rb_right)
226 child = node->rb_left;
227 else
228 {
229 struct rb_node *old = node, *left;
230
231 node = node->rb_right;
232 while ((left = node->rb_left) != NULL)
233 node = left;
Wolfram Strepp16c047a2009-06-16 15:34:11 -0700234
235 if (rb_parent(old)) {
236 if (rb_parent(old)->rb_left == old)
237 rb_parent(old)->rb_left = node;
238 else
239 rb_parent(old)->rb_right = node;
240 } else
241 root->rb_node = node;
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 child = node->rb_right;
David Woodhouse55a98102006-04-21 13:35:51 +0100244 parent = rb_parent(node);
David Woodhouse2f3243a2006-06-05 20:19:05 +0100245 color = rb_color(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
David Woodhouse55a98102006-04-21 13:35:51 +0100247 if (parent == old) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 parent = node;
Wolfram Strepp4c601172009-06-16 15:34:12 -0700249 } else {
250 if (child)
251 rb_set_parent(child, parent);
David Woodhouse1975e592006-04-21 13:30:36 +0100252 parent->rb_left = child;
Wolfram Strepp4b324122009-06-16 15:34:13 -0700253
254 node->rb_right = old->rb_right;
255 rb_set_parent(old->rb_right, node);
Wolfram Strepp4c601172009-06-16 15:34:12 -0700256 }
David Woodhouse1975e592006-04-21 13:30:36 +0100257
David Woodhouse2f3243a2006-06-05 20:19:05 +0100258 node->rb_parent_color = old->rb_parent_color;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 node->rb_left = old->rb_left;
David Woodhouse55a98102006-04-21 13:35:51 +0100260 rb_set_parent(old->rb_left, node);
Wolfram Strepp4b324122009-06-16 15:34:13 -0700261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 goto color;
263 }
264
David Woodhouse55a98102006-04-21 13:35:51 +0100265 parent = rb_parent(node);
David Woodhouse2f3243a2006-06-05 20:19:05 +0100266 color = rb_color(node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
268 if (child)
David Woodhouse55a98102006-04-21 13:35:51 +0100269 rb_set_parent(child, parent);
Peter Zijlstrab945d6b2010-05-29 15:31:43 +0200270 if (parent)
271 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 if (parent->rb_left == node)
273 parent->rb_left = child;
274 else
275 parent->rb_right = child;
Pallipadi, Venkatesh17d9ddc2010-02-10 15:23:44 -0800276 }
Peter Zijlstrab945d6b2010-05-29 15:31:43 +0200277 else
278 root->rb_node = child;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280 color:
281 if (color == RB_BLACK)
282 __rb_erase_color(child, parent, root);
283}
284EXPORT_SYMBOL(rb_erase);
285
Peter Zijlstrab945d6b2010-05-29 15:31:43 +0200286static void rb_augment_path(struct rb_node *node, rb_augment_f func, void *data)
287{
288 struct rb_node *parent;
289
290up:
291 func(node, data);
292 parent = rb_parent(node);
293 if (!parent)
294 return;
295
296 if (node == parent->rb_left && parent->rb_right)
297 func(parent->rb_right, data);
298 else if (parent->rb_left)
299 func(parent->rb_left, data);
300
301 node = parent;
302 goto up;
303}
304
305/*
306 * after inserting @node into the tree, update the tree to account for
307 * both the new entry and any damage done by rebalance
308 */
309void rb_augment_insert(struct rb_node *node, rb_augment_f func, void *data)
310{
311 if (node->rb_left)
312 node = node->rb_left;
313 else if (node->rb_right)
314 node = node->rb_right;
315
316 rb_augment_path(node, func, data);
317}
Andreas Gruenbacher0b6bb662011-01-26 15:55:36 +0100318EXPORT_SYMBOL(rb_augment_insert);
Peter Zijlstrab945d6b2010-05-29 15:31:43 +0200319
320/*
321 * before removing the node, find the deepest node on the rebalance path
322 * that will still be there after @node gets removed
323 */
324struct rb_node *rb_augment_erase_begin(struct rb_node *node)
325{
326 struct rb_node *deepest;
327
328 if (!node->rb_right && !node->rb_left)
329 deepest = rb_parent(node);
330 else if (!node->rb_right)
331 deepest = node->rb_left;
332 else if (!node->rb_left)
333 deepest = node->rb_right;
334 else {
335 deepest = rb_next(node);
336 if (deepest->rb_right)
337 deepest = deepest->rb_right;
338 else if (rb_parent(deepest) != node)
339 deepest = rb_parent(deepest);
340 }
341
342 return deepest;
343}
Andreas Gruenbacher0b6bb662011-01-26 15:55:36 +0100344EXPORT_SYMBOL(rb_augment_erase_begin);
Peter Zijlstrab945d6b2010-05-29 15:31:43 +0200345
346/*
347 * after removal, update the tree to account for the removed entry
348 * and any rebalance damage.
349 */
350void rb_augment_erase_end(struct rb_node *node, rb_augment_f func, void *data)
351{
352 if (node)
353 rb_augment_path(node, func, data);
354}
Andreas Gruenbacher0b6bb662011-01-26 15:55:36 +0100355EXPORT_SYMBOL(rb_augment_erase_end);
Peter Zijlstrab945d6b2010-05-29 15:31:43 +0200356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357/*
358 * This function returns the first node (in sort order) of the tree.
359 */
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000360struct rb_node *rb_first(const struct rb_root *root)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361{
362 struct rb_node *n;
363
364 n = root->rb_node;
365 if (!n)
366 return NULL;
367 while (n->rb_left)
368 n = n->rb_left;
369 return n;
370}
371EXPORT_SYMBOL(rb_first);
372
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000373struct rb_node *rb_last(const struct rb_root *root)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374{
375 struct rb_node *n;
376
377 n = root->rb_node;
378 if (!n)
379 return NULL;
380 while (n->rb_right)
381 n = n->rb_right;
382 return n;
383}
384EXPORT_SYMBOL(rb_last);
385
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000386struct rb_node *rb_next(const struct rb_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387{
David Woodhouse55a98102006-04-21 13:35:51 +0100388 struct rb_node *parent;
389
Jens Axboe10fd48f2006-07-11 21:15:52 +0200390 if (rb_parent(node) == node)
391 return NULL;
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 /* If we have a right-hand child, go down and then left as far
394 as we can. */
395 if (node->rb_right) {
396 node = node->rb_right;
397 while (node->rb_left)
398 node=node->rb_left;
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000399 return (struct rb_node *)node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 }
401
402 /* No right-hand children. Everything down and left is
403 smaller than us, so any 'next' node must be in the general
404 direction of our parent. Go up the tree; any time the
405 ancestor is a right-hand child of its parent, keep going
406 up. First time it's a left-hand child of its parent, said
407 parent is our 'next' node. */
David Woodhouse55a98102006-04-21 13:35:51 +0100408 while ((parent = rb_parent(node)) && node == parent->rb_right)
409 node = parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
David Woodhouse55a98102006-04-21 13:35:51 +0100411 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412}
413EXPORT_SYMBOL(rb_next);
414
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000415struct rb_node *rb_prev(const struct rb_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416{
David Woodhouse55a98102006-04-21 13:35:51 +0100417 struct rb_node *parent;
418
Jens Axboe10fd48f2006-07-11 21:15:52 +0200419 if (rb_parent(node) == node)
420 return NULL;
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 /* If we have a left-hand child, go down and then right as far
423 as we can. */
424 if (node->rb_left) {
425 node = node->rb_left;
426 while (node->rb_right)
427 node=node->rb_right;
Artem Bityutskiyf4b477c2009-01-10 11:12:09 +0000428 return (struct rb_node *)node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 }
430
431 /* No left-hand children. Go up till we find an ancestor which
432 is a right-hand child of its parent */
David Woodhouse55a98102006-04-21 13:35:51 +0100433 while ((parent = rb_parent(node)) && node == parent->rb_left)
434 node = parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
David Woodhouse55a98102006-04-21 13:35:51 +0100436 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437}
438EXPORT_SYMBOL(rb_prev);
439
440void rb_replace_node(struct rb_node *victim, struct rb_node *new,
441 struct rb_root *root)
442{
David Woodhouse55a98102006-04-21 13:35:51 +0100443 struct rb_node *parent = rb_parent(victim);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
445 /* Set the surrounding nodes to point to the replacement */
446 if (parent) {
447 if (victim == parent->rb_left)
448 parent->rb_left = new;
449 else
450 parent->rb_right = new;
451 } else {
452 root->rb_node = new;
453 }
454 if (victim->rb_left)
David Woodhouse55a98102006-04-21 13:35:51 +0100455 rb_set_parent(victim->rb_left, new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 if (victim->rb_right)
David Woodhouse55a98102006-04-21 13:35:51 +0100457 rb_set_parent(victim->rb_right, new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459 /* Copy the pointers/colour from the victim to the replacement */
460 *new = *victim;
461}
462EXPORT_SYMBOL(rb_replace_node);