Merge "stasis: No need to keep a stasis type ref in a stasis msg or cache object."
[asterisk/asterisk.git] / main / astobj2_rbtree.c
1 /*
2  * astobj2_hash - RBTree implementation for astobj2.
3  *
4  * Copyright (C) 2006 Marta Carbone, Luigi Rizzo - Univ. di Pisa, Italy
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief RBTree functions implementing astobj2 containers.
20  *
21  * \author Richard Mudgett <rmudgett@digium.com>
22  */
23
24 #include "asterisk.h"
25
26 #include "asterisk/_private.h"
27 #include "asterisk/astobj2.h"
28 #include "asterisk/utils.h"
29 #include "astobj2_private.h"
30 #include "astobj2_container_private.h"
31
32 /*!
33  * A structure to hold the object held by the container and
34  * where it is located in it.
35  *
36  * A red-black tree has the following properties:
37  *
38  * 1) Every node is either black or red.
39  *
40  * 2) The root is black.
41  *
42  * 3) If a node has a NULL child, that "child" is considered
43  * black.
44  *
45  * 4) If a node is red, then both of its children are black.
46  *
47  * 5) Every path from a node to a descendant NULL child has the
48  * same number of black nodes.  (Including the black NULL
49  * child.)
50  */
51 struct rbtree_node {
52         /*!
53          * \brief Items common to all container nodes.
54          * \note Must be first in the specific node struct.
55          */
56         struct ao2_container_node common;
57         /*! Parent node of this node. NULL if this is the root node. */
58         struct rbtree_node *parent;
59         /*! Left child node of this node.  NULL if does not have this child. */
60         struct rbtree_node *left;
61         /*! Right child node of this node.  NULL if does not have this child. */
62         struct rbtree_node *right;
63         /*! TRUE if the node is red. */
64         unsigned int is_red:1;
65 };
66
67 /*!
68  * A rbtree container in addition to values common to all
69  * container types, stores the pointer to the root node of the
70  * tree.
71  */
72 struct ao2_container_rbtree {
73         /*!
74          * \brief Items common to all containers.
75          * \note Must be first in the specific container struct.
76          */
77         struct ao2_container common;
78         /*! Root node of the tree.  NULL if the tree is empty. */
79         struct rbtree_node *root;
80 #if defined(AO2_DEBUG)
81         struct {
82                 /*! Fixup insert left cases 1-3 */
83                 int fixup_insert_left[3];
84                 /*! Fixup insert right cases 1-3 */
85                 int fixup_insert_right[3];
86                 /*! Fixup delete left cases 1-4 */
87                 int fixup_delete_left[4];
88                 /*! Fixup delete right cases 1-4 */
89                 int fixup_delete_right[4];
90                 /*! Deletion of node with number of children (0-2). */
91                 int delete_children[3];
92         } stats;
93 #endif  /* defined(AO2_DEBUG) */
94 };
95
96 enum equal_node_bias {
97         /*! Bias search toward first matching node in the container. */
98         BIAS_FIRST,
99         /*! Bias search toward any matching node. */
100         BIAS_EQUAL,
101         /*! Bias search toward last matching node in the container. */
102         BIAS_LAST,
103 };
104
105 enum empty_node_direction {
106         GO_LEFT,
107         GO_RIGHT,
108 };
109
110 /*! Traversal state to restart a rbtree container traversal. */
111 struct rbtree_traversal_state {
112         /*! Active sort function in the traversal if not NULL. */
113         ao2_sort_fn *sort_fn;
114         /*! Saved comparison callback arg pointer. */
115         void *arg;
116         /*! Saved search flags to control traversing the container. */
117         enum search_flags flags;
118 };
119
120 struct rbtree_traversal_state_check {
121         /*
122          * If we have a division by zero compile error here then there
123          * is not enough room for the state.  Increase AO2_TRAVERSAL_STATE_SIZE.
124          */
125         char check[1 / (AO2_TRAVERSAL_STATE_SIZE / sizeof(struct rbtree_traversal_state))];
126 };
127
128 /*!
129  * \internal
130  * \brief Get the most left node in the tree.
131  * \since 12.0.0
132  *
133  * \param node Starting node to find the most left node.
134  *
135  * \return Left most node.  Never NULL.
136  */
137 static struct rbtree_node *rb_node_most_left(struct rbtree_node *node)
138 {
139         while (node->left) {
140                 node = node->left;
141         }
142
143         return node;
144 }
145
146 /*!
147  * \internal
148  * \brief Get the most right node in the tree.
149  * \since 12.0.0
150  *
151  * \param node Starting node to find the most right node.
152  *
153  * \return Right most node.  Never NULL.
154  */
155 static struct rbtree_node *rb_node_most_right(struct rbtree_node *node)
156 {
157         while (node->right) {
158                 node = node->right;
159         }
160
161         return node;
162 }
163
164 /*!
165  * \internal
166  * \brief Get the next node in ascending sequence.
167  * \since 12.0.0
168  *
169  * \param node Starting node to find the next node.
170  *
171  * \retval node on success.
172  * \retval NULL if no node.
173  */
174 static struct rbtree_node *rb_node_next(struct rbtree_node *node)
175 {
176         if (node->right) {
177                 return rb_node_most_left(node->right);
178         }
179
180         /* Find the parent that the node is a left child of. */
181         while (node->parent) {
182                 if (node->parent->left == node) {
183                         /* We are the left child.  The parent is the next node. */
184                         return node->parent;
185                 }
186                 node = node->parent;
187         }
188         return NULL;
189 }
190
191 /*!
192  * \internal
193  * \brief Get the next node in descending sequence.
194  * \since 12.0.0
195  *
196  * \param node Starting node to find the previous node.
197  *
198  * \retval node on success.
199  * \retval NULL if no node.
200  */
201 static struct rbtree_node *rb_node_prev(struct rbtree_node *node)
202 {
203         if (node->left) {
204                 return rb_node_most_right(node->left);
205         }
206
207         /* Find the parent that the node is a right child of. */
208         while (node->parent) {
209                 if (node->parent->right == node) {
210                         /* We are the right child.  The parent is the previous node. */
211                         return node->parent;
212                 }
213                 node = node->parent;
214         }
215         return NULL;
216 }
217
218 /*!
219  * \internal
220  * \brief Get the next node in pre-order sequence.
221  * \since 12.0.0
222  *
223  * \param node Starting node to find the next node.
224  *
225  * \retval node on success.
226  * \retval NULL if no node.
227  */
228 static struct rbtree_node *rb_node_pre(struct rbtree_node *node)
229 {
230         /* Visit the children if the node has any. */
231         if (node->left) {
232                 return node->left;
233         }
234         if (node->right) {
235                 return node->right;
236         }
237
238         /* Time to go back up. */
239         for (;;) {
240                 if (!node->parent) {
241                         return NULL;
242                 }
243                 if (node->parent->left == node && node->parent->right) {
244                         /*
245                          * We came up the left child and there's a right child.  Visit
246                          * it.
247                          */
248                         return node->parent->right;
249                 }
250                 node = node->parent;
251         }
252 }
253
254 /*!
255  * \internal
256  * \brief Get the next node in post-order sequence.
257  * \since 12.0.0
258  *
259  * \param node Starting node to find the next node.
260  *
261  * \retval node on success.
262  * \retval NULL if no node.
263  */
264 static struct rbtree_node *rb_node_post(struct rbtree_node *node)
265 {
266         /* This node's children have already been visited. */
267         for (;;) {
268                 if (!node->parent) {
269                         return NULL;
270                 }
271                 if (node->parent->left == node) {
272                         /* We came up the left child. */
273                         node = node->parent;
274
275                         /*
276                          * Find the right child's left most childless node.
277                          */
278                         while (node->right) {
279                                 node = rb_node_most_left(node->right);
280                         }
281
282                         /*
283                          * This node's left child has already been visited or it doesn't
284                          * have any children.
285                          */
286                         return node;
287                 }
288
289                 /*
290                  * We came up the right child.
291                  *
292                  * This node's children have already been visited.  Time to
293                  * visit the parent.
294                  */
295                 return node->parent;
296         }
297 }
298
299 /*!
300  * \internal
301  * \brief Get the next non-empty node in ascending sequence.
302  * \since 12.0.0
303  *
304  * \param node Starting node to find the next node.
305  *
306  * \retval node on success.
307  * \retval NULL if no node.
308  */
309 static struct rbtree_node *rb_node_next_full(struct rbtree_node *node)
310 {
311         for (;;) {
312                 node = rb_node_next(node);
313                 if (!node || node->common.obj) {
314                         return node;
315                 }
316         }
317 }
318
319 /*!
320  * \internal
321  * \brief Get the next non-empty node in descending sequence.
322  * \since 12.0.0
323  *
324  * \param node Starting node to find the previous node.
325  *
326  * \retval node on success.
327  * \retval NULL if no node.
328  */
329 static struct rbtree_node *rb_node_prev_full(struct rbtree_node *node)
330 {
331         for (;;) {
332                 node = rb_node_prev(node);
333                 if (!node || node->common.obj) {
334                         return node;
335                 }
336         }
337 }
338
339 /*!
340  * \internal
341  * \brief Determine which way to go from an empty node.
342  * \since 12.0.0
343  *
344  * \param empty Empty node to determine which side obj_right goes on.
345  * \param sort_fn Sort comparison function for non-empty nodes.
346  * \param obj_right pointer to the (user-defined part) of an object.
347  * \param flags flags from ao2_callback()
348  *   OBJ_SEARCH_OBJECT - if set, 'obj_right', is an object.
349  *   OBJ_SEARCH_KEY - if set, 'obj_right', is a search key item that is not an object.
350  *   OBJ_SEARCH_PARTIAL_KEY - if set, 'obj_right', is a partial search key item that is not an object.
351  * \param bias How to bias search direction for duplicates
352  *
353  * \return enum empty_node_direction to proceed.
354  */
355 static enum empty_node_direction rb_find_empty_direction(struct rbtree_node *empty, ao2_sort_fn *sort_fn, void *obj_right, enum search_flags flags, enum equal_node_bias bias)
356 {
357         int cmp;
358         struct rbtree_node *cur;
359         struct rbtree_node *right_most;
360
361         /* Try for a quick definite go left. */
362         if (!empty->left) {
363                 /* The empty node has no left child. */
364                 return GO_RIGHT;
365         }
366         right_most = rb_node_most_right(empty->left);
367         if (right_most->common.obj) {
368                 cmp = sort_fn(right_most->common.obj, obj_right, flags);
369                 if (cmp < 0) {
370                         return GO_RIGHT;
371                 }
372                 if (cmp == 0 && bias == BIAS_LAST) {
373                         return GO_RIGHT;
374                 }
375                 return GO_LEFT;
376         }
377
378         /* Try for a quick definite go right. */
379         if (!empty->right) {
380                 /* The empty node has no right child. */
381                 return GO_LEFT;
382         }
383         cur = rb_node_most_left(empty->right);
384         if (cur->common.obj) {
385                 cmp = sort_fn(cur->common.obj, obj_right, flags);
386                 if (cmp > 0) {
387                         return GO_LEFT;
388                 }
389                 if (cmp == 0 && bias == BIAS_FIRST) {
390                         return GO_LEFT;
391                 }
392                 return GO_RIGHT;
393         }
394
395         /*
396          * Have to scan the previous nodes from the right_most node of
397          * the left subtree for the first non-empty node to determine
398          * direction.
399          */
400         cur = right_most;
401         for (;;) {
402                 /* Find previous node. */
403                 if (cur->left) {
404                         cur = rb_node_most_right(cur->left);
405                 } else {
406                         /* Find the parent that the node is a right child of. */
407                         for (;;) {
408                                 if (cur->parent == empty) {
409                                         /* The left side of the empty node is all empty nodes. */
410                                         return GO_RIGHT;
411                                 }
412                                 if (cur->parent->right == cur) {
413                                         /* We are the right child.  The parent is the previous node. */
414                                         cur = cur->parent;
415                                         break;
416                                 }
417                                 cur = cur->parent;
418                         }
419                 }
420
421                 if (cur->common.obj) {
422                         cmp = sort_fn(cur->common.obj, obj_right, flags);
423                         if (cmp < 0) {
424                                 return GO_RIGHT;
425                         }
426                         if (cmp == 0 && bias == BIAS_LAST) {
427                                 return GO_RIGHT;
428                         }
429                         return GO_LEFT;
430                 }
431         }
432 }
433
434 /*!
435  * \internal
436  * \brief Tree node rotation left.
437  * \since 12.0.0
438  *
439  * \param self Container holding node.
440  * \param node Node to perform a left rotation with.
441  *
442  *        p                         p
443  *        |     Left rotation       |
444  *        N        --->             Ch
445  *       / \                       / \
446  *      a  Ch                     N   c
447  *        / \                    / \
448  *       b   c                  a   b
449  *
450  * N = node
451  * Ch = child
452  * p = parent
453  * a,b,c = other nodes that are unaffected by the rotation.
454  *
455  * \note It is assumed that the node's right child exists.
456  *
457  * \return Nothing
458  */
459 static void rb_rotate_left(struct ao2_container_rbtree *self, struct rbtree_node *node)
460 {
461         struct rbtree_node *child;      /*!< Node's right child. */
462
463         child = node->right;
464
465         /* Link the node's parent to the child. */
466         if (!node->parent) {
467                 /* Node is the root so we get a new root node. */
468                 self->root = child;
469         } else if (node->parent->left == node) {
470                 /* Node is a left child. */
471                 node->parent->left = child;
472         } else {
473                 /* Node is a right child. */
474                 node->parent->right = child;
475         }
476         child->parent = node->parent;
477
478         /* Link node's right subtree to the child's left subtree. */
479         node->right = child->left;
480         if (node->right) {
481                 node->right->parent = node;
482         }
483
484         /* Link the node to the child's left. */
485         node->parent = child;
486         child->left = node;
487 }
488
489 /*!
490  * \internal
491  * \brief Tree node rotation right.
492  * \since 12.0.0
493  *
494  * \param self Container holding node.
495  * \param node Node to perform a right rotation with.
496  *
497  *        p                         p
498  *        |     Right rotation      |
499  *        Ch                        N
500  *       / \       <---            / \
501  *      a  N                      Ch  c
502  *        / \                    / \
503  *       b   c                  a   b
504  *
505  * N = node
506  * Ch = child
507  * p = parent
508  * a,b,c = other nodes that are unaffected by the rotation.
509  *
510  * \note It is assumed that the node's left child exists.
511  *
512  * \return Nothing
513  */
514 static void rb_rotate_right(struct ao2_container_rbtree *self, struct rbtree_node *node)
515 {
516         struct rbtree_node *child;      /*!< Node's left child. */
517
518         child = node->left;
519
520         /* Link the node's parent to the child. */
521         if (!node->parent) {
522                 /* Node is the root so we get a new root node. */
523                 self->root = child;
524         } else if (node->parent->right == node) {
525                 /* Node is a right child. */
526                 node->parent->right = child;
527         } else {
528                 /* Node is a left child. */
529                 node->parent->left = child;
530         }
531         child->parent = node->parent;
532
533         /* Link node's left subtree to the child's right subtree. */
534         node->left = child->right;
535         if (node->left) {
536                 node->left->parent = node;
537         }
538
539         /* Link the node to the child's right. */
540         node->parent = child;
541         child->right = node;
542 }
543
544 /*!
545  * \internal
546  * \brief Create an empty copy of this container. (Debug version)
547  * \since 14.0.0
548  *
549  * \param self Container to operate upon.
550  * \param tag used for debugging.
551  * \param file Debug file name invoked from
552  * \param line Debug line invoked from
553  * \param func Debug function name invoked from
554  *
555  * \retval empty-clone-container on success.
556  * \retval NULL on error.
557  */
558 static struct ao2_container *rb_ao2_alloc_empty_clone(struct ao2_container_rbtree *self,
559         const char *tag, const char *file, int line, const char *func)
560 {
561         if (!__is_ao2_object(self, file, line, func)) {
562                 return NULL;
563         }
564
565         return __ao2_container_alloc_rbtree(ao2_options_get(self), self->common.options,
566                 self->common.sort_fn, self->common.cmp_fn, tag, file, line, func);
567 }
568
569 /*!
570  * \internal
571  * \brief Fixup the rbtree after deleting a node.
572  * \since 12.0.0
573  *
574  * \param self Container to operate upon.
575  * \param child Child of the node just deleted from the container.
576  *
577  * \note The child must be a dummy black node if there really
578  * was no child of the deleted node.  Otherwise, the caller must
579  * pass in the parent node and which child was deleted.  In
580  * addition, the fixup routine would be more complicated.
581  *
582  * \return Nothing
583  */
584 static void rb_delete_fixup(struct ao2_container_rbtree *self, struct rbtree_node *child)
585 {
586         struct rbtree_node *sibling;
587
588         while (self->root != child && !child->is_red) {
589                 if (child->parent->left == child) {
590                         /* Child is a left child. */
591                         sibling = child->parent->right;
592                         ast_assert(sibling != NULL);
593                         if (sibling->is_red) {
594                                 /* Case 1: The child's sibling is red. */
595                                 AO2_DEVMODE_STAT(++self->stats.fixup_delete_left[0]);
596                                 sibling->is_red = 0;
597                                 child->parent->is_red = 1;
598                                 rb_rotate_left(self, child->parent);
599                                 sibling = child->parent->right;
600                                 ast_assert(sibling != NULL);
601                         }
602                         /*
603                          * The sibling is black.  A black node must have two children,
604                          * or one red child, or no children.
605                          */
606                         if ((!sibling->left || !sibling->left->is_red)
607                                 && (!sibling->right || !sibling->right->is_red)) {
608                                 /*
609                                  * Case 2: The sibling is black and both of its children are black.
610                                  *
611                                  * This case handles the two black children or no children
612                                  * possibilities of a black node.
613                                  */
614                                 AO2_DEVMODE_STAT(++self->stats.fixup_delete_left[1]);
615                                 sibling->is_red = 1;
616                                 child = child->parent;
617                         } else {
618                                 /* At this point the sibling has at least one red child. */
619                                 if (!sibling->right || !sibling->right->is_red) {
620                                         /*
621                                          * Case 3: The sibling is black, its left child is red, and its
622                                          * right child is black.
623                                          */
624                                         AO2_DEVMODE_STAT(++self->stats.fixup_delete_left[2]);
625                                         ast_assert(sibling->left != NULL);
626                                         ast_assert(sibling->left->is_red);
627                                         sibling->left->is_red = 0;
628                                         sibling->is_red = 1;
629                                         rb_rotate_right(self, sibling);
630                                         sibling = child->parent->right;
631                                         ast_assert(sibling != NULL);
632                                 }
633                                 /* Case 4: The sibling is black and its right child is red. */
634                                 AO2_DEVMODE_STAT(++self->stats.fixup_delete_left[3]);
635                                 sibling->is_red = child->parent->is_red;
636                                 child->parent->is_red = 0;
637                                 if (sibling->right) {
638                                         sibling->right->is_red = 0;
639                                 }
640                                 rb_rotate_left(self, child->parent);
641                                 child = self->root;
642                         }
643                 } else {
644                         /* Child is a right child. */
645                         sibling = child->parent->left;
646                         ast_assert(sibling != NULL);
647                         if (sibling->is_red) {
648                                 /* Case 1: The child's sibling is red. */
649                                 AO2_DEVMODE_STAT(++self->stats.fixup_delete_right[0]);
650                                 sibling->is_red = 0;
651                                 child->parent->is_red = 1;
652                                 rb_rotate_right(self, child->parent);
653                                 sibling = child->parent->left;
654                                 ast_assert(sibling != NULL);
655                         }
656                         /*
657                          * The sibling is black.  A black node must have two children,
658                          * or one red child, or no children.
659                          */
660                         if ((!sibling->right || !sibling->right->is_red)
661                                 && (!sibling->left || !sibling->left->is_red)) {
662                                 /*
663                                  * Case 2: The sibling is black and both of its children are black.
664                                  *
665                                  * This case handles the two black children or no children
666                                  * possibilities of a black node.
667                                  */
668                                 AO2_DEVMODE_STAT(++self->stats.fixup_delete_right[1]);
669                                 sibling->is_red = 1;
670                                 child = child->parent;
671                         } else {
672                                 /* At this point the sibling has at least one red child. */
673                                 if (!sibling->left || !sibling->left->is_red) {
674                                         /*
675                                          * Case 3: The sibling is black, its right child is red, and its
676                                          * left child is black.
677                                          */
678                                         AO2_DEVMODE_STAT(++self->stats.fixup_delete_right[2]);
679                                         ast_assert(sibling->right != NULL);
680                                         ast_assert(sibling->right->is_red);
681                                         sibling->right->is_red = 0;
682                                         sibling->is_red = 1;
683                                         rb_rotate_left(self, sibling);
684                                         sibling = child->parent->left;
685                                         ast_assert(sibling != NULL);
686                                 }
687                                 /* Case 4: The sibling is black and its left child is red. */
688                                 AO2_DEVMODE_STAT(++self->stats.fixup_delete_right[3]);
689                                 sibling->is_red = child->parent->is_red;
690                                 child->parent->is_red = 0;
691                                 if (sibling->left) {
692                                         sibling->left->is_red = 0;
693                                 }
694                                 rb_rotate_right(self, child->parent);
695                                 child = self->root;
696                         }
697                 }
698         }
699
700         /*
701          * Case 2 could leave the child node red and it needs to leave
702          * with it black.
703          *
704          * Case 4 sets the child node to the root which of course must
705          * be black.
706          */
707         child->is_red = 0;
708 }
709
710 /*!
711  * \internal
712  * \brief Delete the doomed node from this container.
713  * \since 12.0.0
714  *
715  * \param self Container to operate upon.
716  * \param doomed Container node to delete from the container.
717  *
718  * \return Nothing
719  */
720 static void rb_delete_node(struct ao2_container_rbtree *self, struct rbtree_node *doomed)
721 {
722         struct rbtree_node *child;
723         int need_fixup;
724
725         if (doomed->left && doomed->right) {
726                 struct rbtree_node *next;
727                 int is_red;
728
729                 /*
730                  * The doomed node has two children.
731                  *
732                  * Find the next child node and swap it with the doomed node in
733                  * the tree.
734                  */
735                 AO2_DEVMODE_STAT(++self->stats.delete_children[2]);
736                 next = rb_node_most_left(doomed->right);
737                 SWAP(doomed->parent, next->parent);
738                 SWAP(doomed->left, next->left);
739                 SWAP(doomed->right, next->right);
740                 is_red = doomed->is_red;
741                 doomed->is_red = next->is_red;
742                 next->is_red = is_red;
743
744                 /* Link back in the next node. */
745                 if (!next->parent) {
746                         /* Doomed was the root so we get a new root node. */
747                         self->root = next;
748                 } else if (next->parent->left == doomed) {
749                         /* Doomed was the left child. */
750                         next->parent->left = next;
751                 } else {
752                         /* Doomed was the right child. */
753                         next->parent->right = next;
754                 }
755                 next->left->parent = next;
756                 if (next->right == next) {
757                         /* The next node was the right child of doomed. */
758                         next->right = doomed;
759                         doomed->parent = next;
760                 } else {
761                         next->right->parent = next;
762                         doomed->parent->left = doomed;
763                 }
764
765                 /* The doomed node has no left child now. */
766                 ast_assert(doomed->left == NULL);
767
768                 /*
769                  * We don't have to link the right child back in with doomed
770                  * since we are going to link it with doomed's parent anyway.
771                  */
772                 child = doomed->right;
773         } else {
774                 /* Doomed has at most one child. */
775                 child = doomed->left;
776                 if (!child) {
777                         child = doomed->right;
778                 }
779         }
780         if (child) {
781                 AO2_DEVMODE_STAT(++self->stats.delete_children[1]);
782         } else {
783                 AO2_DEVMODE_STAT(++self->stats.delete_children[0]);
784         }
785
786         need_fixup = (!doomed->is_red && !self->common.destroying);
787         if (need_fixup && !child) {
788                 /*
789                  * Use the doomed node as a place holder node for the
790                  * nonexistent child so we also don't have to pass to the fixup
791                  * routine the parent and which child the deleted node came
792                  * from.
793                  */
794                 rb_delete_fixup(self, doomed);
795                 ast_assert(doomed->left == NULL);
796                 ast_assert(doomed->right == NULL);
797                 ast_assert(!doomed->is_red);
798         }
799
800         /* Link the child in place of doomed. */
801         if (!doomed->parent) {
802                 /* Doomed was the root so we get a new root node. */
803                 self->root = child;
804         } else if (doomed->parent->left == doomed) {
805                 /* Doomed was the left child. */
806                 doomed->parent->left = child;
807         } else {
808                 /* Doomed was the right child. */
809                 doomed->parent->right = child;
810         }
811         if (child) {
812                 child->parent = doomed->parent;
813                 if (need_fixup) {
814                         rb_delete_fixup(self, child);
815                 }
816         }
817
818         AO2_DEVMODE_STAT(--self->common.nodes);
819 }
820
821 /*!
822  * \internal
823  * \brief Destroy a rbtree container node.
824  * \since 12.0.0
825  *
826  * \param v_doomed Container node to destroy.
827  *
828  * \details
829  * The container node unlinks itself from the container as part
830  * of its destruction.  The node must be destroyed while the
831  * container is already locked.
832  *
833  * \note The container must be locked when the node is
834  * unreferenced.
835  *
836  * \return Nothing
837  */
838 static void rb_ao2_node_destructor(void *v_doomed)
839 {
840         struct rbtree_node *doomed = v_doomed;
841
842         if (doomed->common.is_linked) {
843                 struct ao2_container_rbtree *my_container;
844
845                 /*
846                  * Promote to write lock if not already there.  Since
847                  * adjust_lock() can potentially release and block waiting for a
848                  * write lock, care must be taken to ensure that node references
849                  * are released before releasing the container references.
850                  *
851                  * Node references held by an iterator can only be held while
852                  * the iterator also holds a reference to the container.  These
853                  * node references must be unreferenced before the container can
854                  * be unreferenced to ensure that the node will not get a
855                  * negative reference and the destructor called twice for the
856                  * same node.
857                  */
858                 my_container = (struct ao2_container_rbtree *) doomed->common.my_container;
859 #ifdef AST_DEVMODE
860                 is_ao2_object(my_container);
861 #endif
862
863                 __adjust_lock(my_container, AO2_LOCK_REQ_WRLOCK, 1);
864
865 #if defined(AO2_DEBUG)
866                 if (!my_container->common.destroying
867                         && ao2_container_check(doomed->common.my_container, OBJ_NOLOCK)) {
868                         ast_log(LOG_ERROR, "Container integrity failed before node deletion.\n");
869                 }
870 #endif  /* defined(AO2_DEBUG) */
871                 rb_delete_node(my_container, doomed);
872 #if defined(AO2_DEBUG)
873                 if (!my_container->common.destroying
874                         && ao2_container_check(doomed->common.my_container, OBJ_NOLOCK)) {
875                         ast_log(LOG_ERROR, "Container integrity failed after node deletion.\n");
876                 }
877 #endif  /* defined(AO2_DEBUG) */
878         }
879
880         /*
881          * We could have an object in the node if the container is being
882          * destroyed or the node had not been linked in yet.
883          */
884         if (doomed->common.obj) {
885                 __container_unlink_node(&doomed->common, AO2_UNLINK_NODE_UNLINK_OBJECT);
886         }
887 }
888
889 /*!
890  * \internal
891  * \brief Create a new container node.
892  * \since 12.0.0
893  *
894  * \param self Container to operate upon.
895  * \param obj_new Object to put into the node.
896  * \param tag used for debugging.
897  * \param file Debug file name invoked from
898  * \param line Debug line invoked from
899  * \param func Debug function name invoked from
900  *
901  * \retval initialized-node on success.
902  * \retval NULL on error.
903  */
904 static struct rbtree_node *rb_ao2_new_node(struct ao2_container_rbtree *self, void *obj_new, const char *tag, const char *file, int line, const char *func)
905 {
906         struct rbtree_node *node;
907
908         node = ao2_t_alloc_options(sizeof(*node), rb_ao2_node_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK, NULL);
909         if (!node) {
910                 return NULL;
911         }
912
913         __ao2_ref(obj_new, +1, tag ?: "Container node creation", file, line, func);
914         node->common.obj = obj_new;
915         node->common.my_container = (struct ao2_container *) self;
916
917         return node;
918 }
919
920 /*!
921  * \internal
922  * \brief Fixup the rbtree after inserting a node.
923  * \since 12.0.0
924  *
925  * \param self Container to operate upon.
926  * \param node Container node just inserted into the container.
927  *
928  * \note The just inserted node is red.
929  *
930  * \return Nothing
931  */
932 static void rb_insert_fixup(struct ao2_container_rbtree *self, struct rbtree_node *node)
933 {
934         struct rbtree_node *g_parent;   /* Grand parent node. */
935
936         while (node->parent && node->parent->is_red) {
937                 g_parent = node->parent->parent;
938
939                 /* The grand parent must exist if the parent is red. */
940                 ast_assert(g_parent != NULL);
941
942                 if (node->parent == g_parent->left) {
943                         /* The parent is a left child. */
944                         if (g_parent->right && g_parent->right->is_red) {
945                                 /* Case 1: Push the black down from the grand parent node. */
946                                 AO2_DEVMODE_STAT(++self->stats.fixup_insert_left[0]);
947                                 g_parent->right->is_red = 0;
948                                 g_parent->left->is_red = 0;
949                                 g_parent->is_red = 1;
950
951                                 node = g_parent;
952                         } else {
953                                 /* The uncle node is black. */
954                                 if (node->parent->right == node) {
955                                         /*
956                                          * Case 2: The node is a right child.
957                                          *
958                                          * Which node is the grand parent does not change.
959                                          */
960                                         AO2_DEVMODE_STAT(++self->stats.fixup_insert_left[1]);
961                                         node = node->parent;
962                                         rb_rotate_left(self, node);
963                                 }
964                                 /* Case 3: The node is a left child. */
965                                 AO2_DEVMODE_STAT(++self->stats.fixup_insert_left[2]);
966                                 node->parent->is_red = 0;
967                                 g_parent->is_red = 1;
968                                 rb_rotate_right(self, g_parent);
969                         }
970                 } else {
971                         /* The parent is a right child. */
972                         if (g_parent->left && g_parent->left->is_red) {
973                                 /* Case 1: Push the black down from the grand parent node. */
974                                 AO2_DEVMODE_STAT(++self->stats.fixup_insert_right[0]);
975                                 g_parent->left->is_red = 0;
976                                 g_parent->right->is_red = 0;
977                                 g_parent->is_red = 1;
978
979                                 node = g_parent;
980                         } else {
981                                 /* The uncle node is black. */
982                                 if (node->parent->left == node) {
983                                         /*
984                                          * Case 2: The node is a left child.
985                                          *
986                                          * Which node is the grand parent does not change.
987                                          */
988                                         AO2_DEVMODE_STAT(++self->stats.fixup_insert_right[1]);
989                                         node = node->parent;
990                                         rb_rotate_right(self, node);
991                                 }
992                                 /* Case 3: The node is a right child. */
993                                 AO2_DEVMODE_STAT(++self->stats.fixup_insert_right[2]);
994                                 node->parent->is_red = 0;
995                                 g_parent->is_red = 1;
996                                 rb_rotate_left(self, g_parent);
997                         }
998                 }
999         }
1000
1001         /*
1002          * The root could be red here because:
1003          * 1) We just inserted the root node in an empty tree.
1004          *
1005          * 2) Case 1 could leave the root red if the grand parent were
1006          * the root.
1007          */
1008         self->root->is_red = 0;
1009 }
1010
1011 /*!
1012  * \internal
1013  * \brief Insert a node into this container.
1014  * \since 12.0.0
1015  *
1016  * \param self Container to operate upon.
1017  * \param node Container node to insert into the container.
1018  *
1019  * \return enum ao2_container_insert value.
1020  */
1021 static enum ao2_container_insert rb_ao2_insert_node(struct ao2_container_rbtree *self, struct rbtree_node *node)
1022 {
1023         int cmp;
1024         struct rbtree_node *cur;
1025         struct rbtree_node *next;
1026         ao2_sort_fn *sort_fn;
1027         uint32_t options;
1028         enum equal_node_bias bias;
1029
1030         if (!self->root) {
1031                 /* The tree is empty. */
1032                 self->root = node;
1033                 return AO2_CONTAINER_INSERT_NODE_INSERTED;
1034         }
1035
1036         sort_fn = self->common.sort_fn;
1037         options = self->common.options;
1038         switch (options & AO2_CONTAINER_ALLOC_OPT_DUPS_MASK) {
1039         default:
1040         case AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW:
1041                 if (options & AO2_CONTAINER_ALLOC_OPT_INSERT_BEGIN) {
1042                         bias = BIAS_FIRST;
1043                 } else {
1044                         bias = BIAS_LAST;
1045                 }
1046                 break;
1047         case AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT:
1048         case AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT:
1049         case AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE:
1050                 bias = BIAS_EQUAL;
1051                 break;
1052         }
1053
1054         /*
1055          * New nodes are always colored red when initially inserted into
1056          * the tree.  (Except for the root which is always black.)
1057          */
1058         node->is_red = 1;
1059
1060         /* Find node where normal insert would put a new node. */
1061         cur = self->root;
1062         for (;;) {
1063                 if (!cur->common.obj) {
1064                         /* Which direction do we go to insert this node? */
1065                         if (rb_find_empty_direction(cur, sort_fn, node->common.obj, OBJ_SEARCH_OBJECT, bias)
1066                                 == GO_LEFT) {
1067                                 if (cur->left) {
1068                                         cur = cur->left;
1069                                         continue;
1070                                 }
1071
1072                                 /* Node becomes a left child */
1073                                 cur->left = node;
1074                                 node->parent = cur;
1075                                 rb_insert_fixup(self, node);
1076                                 return AO2_CONTAINER_INSERT_NODE_INSERTED;
1077                         }
1078                         if (cur->right) {
1079                                 cur = cur->right;
1080                                 continue;
1081                         }
1082
1083                         /* Node becomes a right child */
1084                         cur->right = node;
1085                         node->parent = cur;
1086                         rb_insert_fixup(self, node);
1087                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
1088                 }
1089                 cmp = sort_fn(cur->common.obj, node->common.obj, OBJ_SEARCH_OBJECT);
1090                 if (cmp > 0) {
1091                         if (cur->left) {
1092                                 cur = cur->left;
1093                                 continue;
1094                         }
1095
1096                         /* Node becomes a left child */
1097                         cur->left = node;
1098                         node->parent = cur;
1099                         rb_insert_fixup(self, node);
1100                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
1101                 } else if (cmp < 0) {
1102                         if (cur->right) {
1103                                 cur = cur->right;
1104                                 continue;
1105                         }
1106
1107                         /* Node becomes a right child */
1108                         cur->right = node;
1109                         node->parent = cur;
1110                         rb_insert_fixup(self, node);
1111                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
1112                 }
1113                 switch (bias) {
1114                 case BIAS_FIRST:
1115                         /* Duplicate nodes unconditionally accepted. */
1116                         if (cur->left) {
1117                                 cur = cur->left;
1118                                 continue;
1119                         }
1120
1121                         /* Node becomes a left child */
1122                         cur->left = node;
1123                         node->parent = cur;
1124                         rb_insert_fixup(self, node);
1125                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
1126                 case BIAS_EQUAL:
1127                         break;
1128                 case BIAS_LAST:
1129                         /* Duplicate nodes unconditionally accepted. */
1130                         if (cur->right) {
1131                                 cur = cur->right;
1132                                 continue;
1133                         }
1134
1135                         /* Node becomes a right child */
1136                         cur->right = node;
1137                         node->parent = cur;
1138                         rb_insert_fixup(self, node);
1139                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
1140                 }
1141
1142                 break;
1143         }
1144
1145         /* Node is a dupliate */
1146         switch (options & AO2_CONTAINER_ALLOC_OPT_DUPS_MASK) {
1147         default:
1148         case AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW:
1149                 ast_assert(0);/* Case already handled by BIAS_FIRST/BIAS_LAST. */
1150                 return AO2_CONTAINER_INSERT_NODE_REJECTED;
1151         case AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT:
1152                 /* Reject all objects with the same key. */
1153                 return AO2_CONTAINER_INSERT_NODE_REJECTED;
1154         case AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT:
1155                 if (cur->common.obj == node->common.obj) {
1156                         /* Reject inserting the same object */
1157                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
1158                 }
1159                 next = cur;
1160                 if (options & AO2_CONTAINER_ALLOC_OPT_INSERT_BEGIN) {
1161                         /* Search to end of duplicates for the same object. */
1162                         for (;;) {
1163                                 next = rb_node_next_full(next);
1164                                 if (!next) {
1165                                         break;
1166                                 }
1167                                 if (next->common.obj == node->common.obj) {
1168                                         /* Reject inserting the same object */
1169                                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
1170                                 }
1171                                 cmp = sort_fn(next->common.obj, node->common.obj, OBJ_SEARCH_OBJECT);
1172                                 if (cmp) {
1173                                         break;
1174                                 }
1175                         }
1176
1177                         /* Find first duplicate node. */
1178                         for (;;) {
1179                                 next = rb_node_prev_full(cur);
1180                                 if (!next) {
1181                                         break;
1182                                 }
1183                                 if (next->common.obj == node->common.obj) {
1184                                         /* Reject inserting the same object */
1185                                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
1186                                 }
1187                                 cmp = sort_fn(next->common.obj, node->common.obj, OBJ_SEARCH_OBJECT);
1188                                 if (cmp) {
1189                                         break;
1190                                 }
1191                                 cur = next;
1192                         }
1193                         if (!cur->left) {
1194                                 /* Node becomes a left child */
1195                                 cur->left = node;
1196                         } else {
1197                                 /* Node becomes a right child */
1198                                 cur = rb_node_most_right(cur->left);
1199                                 cur->right = node;
1200                         }
1201                 } else {
1202                         /* Search to beginning of duplicates for the same object. */
1203                         for (;;) {
1204                                 next = rb_node_prev_full(next);
1205                                 if (!next) {
1206                                         break;
1207                                 }
1208                                 if (next->common.obj == node->common.obj) {
1209                                         /* Reject inserting the same object */
1210                                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
1211                                 }
1212                                 cmp = sort_fn(next->common.obj, node->common.obj, OBJ_SEARCH_OBJECT);
1213                                 if (cmp) {
1214                                         break;
1215                                 }
1216                         }
1217
1218                         /* Find last duplicate node. */
1219                         for (;;) {
1220                                 next = rb_node_next_full(cur);
1221                                 if (!next) {
1222                                         break;
1223                                 }
1224                                 if (next->common.obj == node->common.obj) {
1225                                         /* Reject inserting the same object */
1226                                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
1227                                 }
1228                                 cmp = sort_fn(next->common.obj, node->common.obj, OBJ_SEARCH_OBJECT);
1229                                 if (cmp) {
1230                                         break;
1231                                 }
1232                                 cur = next;
1233                         }
1234                         if (!cur->right) {
1235                                 /* Node becomes a right child */
1236                                 cur->right = node;
1237                         } else {
1238                                 /* Node becomes a left child */
1239                                 cur = rb_node_most_left(cur->right);
1240                                 cur->left = node;
1241                         }
1242                 }
1243                 break;
1244         case AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE:
1245                 SWAP(cur->common.obj, node->common.obj);
1246                 ao2_t_ref(node, -1, NULL);
1247                 return AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED;
1248         }
1249
1250         /* Complete inserting duplicate node. */
1251         node->parent = cur;
1252         rb_insert_fixup(self, node);
1253         return AO2_CONTAINER_INSERT_NODE_INSERTED;
1254 }
1255
1256 /*!
1257  * \internal
1258  * \brief Find the next rbtree container node in a traversal.
1259  * \since 12.0.0
1260  *
1261  * \param self Container to operate upon.
1262  * \param state Traversal state to restart rbtree container traversal.
1263  * \param prev Previous node returned by the traversal search functions.
1264  *    The ref ownership is passed back to this function.
1265  *
1266  * \retval node-ptr of found node (Reffed).
1267  * \retval NULL when no node found.
1268  */
1269 static struct rbtree_node *rb_ao2_find_next(struct ao2_container_rbtree *self, struct rbtree_traversal_state *state, struct rbtree_node *prev)
1270 {
1271         struct rbtree_node *node;
1272         void *arg;
1273         enum search_flags flags;
1274         int cmp;
1275
1276         arg = state->arg;
1277         flags = state->flags;
1278
1279         node = prev;
1280         for (;;) {
1281                 /* Find next node in traversal order. */
1282                 switch (flags & OBJ_ORDER_MASK) {
1283                 default:
1284                 case OBJ_ORDER_ASCENDING:
1285                         node = rb_node_next(node);
1286                         break;
1287                 case OBJ_ORDER_DESCENDING:
1288                         node = rb_node_prev(node);
1289                         break;
1290                 case OBJ_ORDER_PRE:
1291                         node = rb_node_pre(node);
1292                         break;
1293                 case OBJ_ORDER_POST:
1294                         node = rb_node_post(node);
1295                         break;
1296                 }
1297                 if (!node) {
1298                         /* No more nodes left to traverse. */
1299                         break;
1300                 }
1301                 if (!node->common.obj) {
1302                         /* Node is empty */
1303                         continue;
1304                 }
1305
1306                 if (state->sort_fn) {
1307                         /* Filter node through the sort_fn */
1308                         cmp = state->sort_fn(node->common.obj, arg, flags & OBJ_SEARCH_MASK);
1309                         if (cmp) {
1310                                 /* No more nodes in this container are possible to match. */
1311                                 break;
1312                         }
1313                 }
1314
1315                 /* We have the next traversal node */
1316                 ao2_t_ref(node, +1, NULL);
1317
1318                 /*
1319                  * Dereferencing the prev node may result in our next node
1320                  * object being removed by another thread.  This could happen if
1321                  * the container uses RW locks and the container was read
1322                  * locked.
1323                  */
1324                 ao2_t_ref(prev, -1, NULL);
1325                 if (node->common.obj) {
1326                         return node;
1327                 }
1328                 prev = node;
1329         }
1330
1331         /* No more nodes in the container left to traverse. */
1332         ao2_t_ref(prev, -1, NULL);
1333         return NULL;
1334 }
1335
1336 /*!
1337  * \internal
1338  * \brief Find an initial matching node.
1339  * \since 12.0.0
1340  *
1341  * \param self Container to operate upon.
1342  * \param obj_right pointer to the (user-defined part) of an object.
1343  * \param flags flags from ao2_callback()
1344  *   OBJ_SEARCH_OBJECT - if set, 'obj_right', is an object.
1345  *   OBJ_SEARCH_KEY - if set, 'obj_right', is a search key item that is not an object.
1346  *   OBJ_SEARCH_PARTIAL_KEY - if set, 'obj_right', is a partial search key item that is not an object.
1347  * \param bias How to bias search direction for duplicates
1348  *
1349  * \retval node on success.
1350  * \retval NULL if not found.
1351  */
1352 static struct rbtree_node *rb_find_initial(struct ao2_container_rbtree *self, void *obj_right, enum search_flags flags, enum equal_node_bias bias)
1353 {
1354         int cmp;
1355         enum search_flags sort_flags;
1356         struct rbtree_node *node;
1357         struct rbtree_node *next = NULL;
1358         ao2_sort_fn *sort_fn;
1359
1360         sort_flags = flags & OBJ_SEARCH_MASK;
1361         sort_fn = self->common.sort_fn;
1362
1363         /* Find node where normal search would find it. */
1364         node = self->root;
1365         if (!node) {
1366                 return NULL;
1367         }
1368         for (;;) {
1369                 if (!node->common.obj) {
1370                         /* Which direction do we go to find the node? */
1371                         if (rb_find_empty_direction(node, sort_fn, obj_right, sort_flags, bias)
1372                                 == GO_LEFT) {
1373                                 next = node->left;
1374                         } else {
1375                                 next = node->right;
1376                         }
1377                         if (!next) {
1378                                 switch (bias) {
1379                                 case BIAS_FIRST:
1380                                         /* Check successor node for match. */
1381                                         next = rb_node_next_full(node);
1382                                         break;
1383                                 case BIAS_EQUAL:
1384                                         break;
1385                                 case BIAS_LAST:
1386                                         /* Check previous node for match. */
1387                                         next = rb_node_prev_full(node);
1388                                         break;
1389                                 }
1390                                 if (next) {
1391                                         cmp = sort_fn(next->common.obj, obj_right, sort_flags);
1392                                         if (cmp == 0) {
1393                                                 /* Found the first/last matching node. */
1394                                                 return next;
1395                                         }
1396                                         next = NULL;
1397                                 }
1398
1399                                 /* No match found. */
1400                                 return next;
1401                         }
1402                 } else {
1403                         cmp = sort_fn(node->common.obj, obj_right, sort_flags);
1404                         if (cmp > 0) {
1405                                 next = node->left;
1406                         } else if (cmp < 0) {
1407                                 next = node->right;
1408                         } else {
1409                                 switch (bias) {
1410                                 case BIAS_FIRST:
1411                                         next = node->left;
1412                                         break;
1413                                 case BIAS_EQUAL:
1414                                         return node;
1415                                 case BIAS_LAST:
1416                                         next = node->right;
1417                                         break;
1418                                 }
1419                                 if (!next) {
1420                                         /* Found the first/last matching node. */
1421                                         return node;
1422                                 }
1423                         }
1424                         if (!next) {
1425                                 switch (bias) {
1426                                 case BIAS_FIRST:
1427                                         if (cmp < 0) {
1428                                                 /* Check successor node for match. */
1429                                                 next = rb_node_next_full(node);
1430                                         }
1431                                         break;
1432                                 case BIAS_EQUAL:
1433                                         break;
1434                                 case BIAS_LAST:
1435                                         if (cmp > 0) {
1436                                                 /* Check previous node for match. */
1437                                                 next = rb_node_prev_full(node);
1438                                         }
1439                                         break;
1440                                 }
1441                                 if (next) {
1442                                         cmp = sort_fn(next->common.obj, obj_right, sort_flags);
1443                                         if (cmp == 0) {
1444                                                 /* Found the first/last matching node. */
1445                                                 return next;
1446                                         }
1447                                 }
1448
1449                                 /* No match found. */
1450                                 return NULL;
1451                         }
1452                 }
1453                 node = next;
1454         }
1455 }
1456
1457 /*!
1458  * \internal
1459  * \brief Find the first rbtree container node in a traversal.
1460  * \since 12.0.0
1461  *
1462  * \param self Container to operate upon.
1463  * \param flags search_flags to control traversing the container
1464  * \param arg Comparison callback arg parameter.
1465  * \param state Traversal state to restart rbtree container traversal.
1466  *
1467  * \retval node-ptr of found node (Reffed).
1468  * \retval NULL when no node found.
1469  */
1470 static struct rbtree_node *rb_ao2_find_first(struct ao2_container_rbtree *self, enum search_flags flags, void *arg, struct rbtree_traversal_state *state)
1471 {
1472         struct rbtree_node *node;
1473         enum equal_node_bias bias;
1474
1475         if (self->common.destroying) {
1476                 /* Force traversal to be post order for tree destruction. */
1477                 flags = OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE | OBJ_ORDER_POST;
1478         }
1479
1480         memset(state, 0, sizeof(*state));
1481         state->arg = arg;
1482         state->flags = flags;
1483
1484         switch (flags & OBJ_SEARCH_MASK) {
1485         case OBJ_SEARCH_OBJECT:
1486         case OBJ_SEARCH_KEY:
1487         case OBJ_SEARCH_PARTIAL_KEY:
1488                 /* We are asked to do a directed search. */
1489                 state->sort_fn = self->common.sort_fn;
1490                 break;
1491         default:
1492                 /* Don't know, let's visit all nodes */
1493                 state->sort_fn = NULL;
1494                 break;
1495         }
1496
1497         if (!self->root) {
1498                 /* Tree is empty. */
1499                 return NULL;
1500         }
1501
1502         /* Find first traversal node. */
1503         switch (flags & OBJ_ORDER_MASK) {
1504         default:
1505         case OBJ_ORDER_ASCENDING:
1506                 if (!state->sort_fn) {
1507                         /* Find left most child. */
1508                         node = rb_node_most_left(self->root);
1509                         if (!node->common.obj) {
1510                                 node = rb_node_next_full(node);
1511                                 if (!node) {
1512                                         return NULL;
1513                                 }
1514                         }
1515                         break;
1516                 }
1517
1518                 /* Search for initial node. */
1519                 switch (self->common.options & AO2_CONTAINER_ALLOC_OPT_DUPS_MASK) {
1520                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT:
1521                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE:
1522                         if ((flags & OBJ_SEARCH_MASK) != OBJ_SEARCH_PARTIAL_KEY) {
1523                                 /* There are no duplicates allowed. */
1524                                 bias = BIAS_EQUAL;
1525                                 break;
1526                         }
1527                         /* Fall through */
1528                 default:
1529                 case AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW:
1530                 case AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT:
1531                         /* Find first duplicate node. */
1532                         bias = BIAS_FIRST;
1533                         break;
1534                 }
1535                 node = rb_find_initial(self, arg, flags, bias);
1536                 if (!node) {
1537                         return NULL;
1538                 }
1539                 break;
1540         case OBJ_ORDER_DESCENDING:
1541                 if (!state->sort_fn) {
1542                         /* Find right most child. */
1543                         node = rb_node_most_right(self->root);
1544                         if (!node->common.obj) {
1545                                 node = rb_node_prev_full(node);
1546                                 if (!node) {
1547                                         return NULL;
1548                                 }
1549                         }
1550                         break;
1551                 }
1552
1553                 /* Search for initial node. */
1554                 switch (self->common.options & AO2_CONTAINER_ALLOC_OPT_DUPS_MASK) {
1555                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT:
1556                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE:
1557                         if ((flags & OBJ_SEARCH_MASK) != OBJ_SEARCH_PARTIAL_KEY) {
1558                                 /* There are no duplicates allowed. */
1559                                 bias = BIAS_EQUAL;
1560                                 break;
1561                         }
1562                         /* Fall through */
1563                 default:
1564                 case AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW:
1565                 case AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT:
1566                         /* Find last duplicate node. */
1567                         bias = BIAS_LAST;
1568                         break;
1569                 }
1570                 node = rb_find_initial(self, arg, flags, bias);
1571                 if (!node) {
1572                         return NULL;
1573                 }
1574                 break;
1575         case OBJ_ORDER_PRE:
1576                 /* This is a tree structure traversal so we must visit all nodes. */
1577                 state->sort_fn = NULL;
1578
1579                 node = self->root;
1580
1581                 /* Find a non-empty node. */
1582                 while (!node->common.obj) {
1583                         node = rb_node_pre(node);
1584                         if (!node) {
1585                                 return NULL;
1586                         }
1587                 }
1588                 break;
1589         case OBJ_ORDER_POST:
1590                 /* This is a tree structure traversal so we must visit all nodes. */
1591                 state->sort_fn = NULL;
1592
1593                 /* Find the left most childless node. */
1594                 node = self->root;
1595                 for (;;) {
1596                         node = rb_node_most_left(node);
1597                         if (!node->right) {
1598                                 /* This node has no children. */
1599                                 break;
1600                         }
1601                         node = node->right;
1602                 }
1603
1604                 /* Find a non-empty node. */
1605                 while (!node->common.obj) {
1606                         node = rb_node_post(node);
1607                         if (!node) {
1608                                 return NULL;
1609                         }
1610                 }
1611                 break;
1612         }
1613
1614         /* We have the first traversal node */
1615         ao2_t_ref(node, +1, NULL);
1616         return node;
1617 }
1618
1619 /*!
1620  * \internal
1621  * \brief Find the next non-empty iteration node in the container.
1622  * \since 12.0.0
1623  *
1624  * \param self Container to operate upon.
1625  * \param node Previous node returned by the iterator.
1626  * \param flags search_flags to control iterating the container.
1627  *   Only AO2_ITERATOR_DESCENDING is useful by the method.
1628  *
1629  * \note The container is already locked.
1630  *
1631  * \retval node on success.
1632  * \retval NULL on error or no more nodes in the container.
1633  */
1634 static struct rbtree_node *rb_ao2_iterator_next(struct ao2_container_rbtree *self, struct rbtree_node *node, enum ao2_iterator_flags flags)
1635 {
1636         if (flags & AO2_ITERATOR_DESCENDING) {
1637                 if (!node) {
1638                         /* Find right most node. */
1639                         if (!self->root) {
1640                                 return NULL;
1641                         }
1642                         node = rb_node_most_right(self->root);
1643                         if (node->common.obj) {
1644                                 /* Found a non-empty node. */
1645                                 return node;
1646                         }
1647                 }
1648                 /* Find next non-empty node. */
1649                 node = rb_node_prev_full(node);
1650         } else {
1651                 if (!node) {
1652                         /* Find left most node. */
1653                         if (!self->root) {
1654                                 return NULL;
1655                         }
1656                         node = rb_node_most_left(self->root);
1657                         if (node->common.obj) {
1658                                 /* Found a non-empty node. */
1659                                 return node;
1660                         }
1661                 }
1662                 /* Find next non-empty node. */
1663                 node = rb_node_next_full(node);
1664         }
1665
1666         return node;
1667 }
1668
1669 /*!
1670  * \internal
1671  *
1672  * \brief Destroy this container.
1673  * \since 12.0.0
1674  *
1675  * \param self Container to operate upon.
1676  *
1677  * \return Nothing
1678  */
1679 static void rb_ao2_destroy(struct ao2_container_rbtree *self)
1680 {
1681         /* Check that the container no longer has any nodes */
1682         if (self->root) {
1683                 ast_log(LOG_ERROR, "Node ref leak.  Red-Black tree container still has nodes!\n");
1684                 ast_assert(0);
1685         }
1686 }
1687
1688 #if defined(AO2_DEBUG)
1689 /*!
1690  * \internal
1691  * \brief Display contents of the specified container.
1692  * \since 12.0.0
1693  *
1694  * \param self Container to dump.
1695  * \param where User data needed by prnt to determine where to put output.
1696  * \param prnt Print output callback function to use.
1697  * \param prnt_obj Callback function to print the given object's key. (NULL if not available)
1698  *
1699  * \return Nothing
1700  */
1701 static void rb_ao2_dump(struct ao2_container_rbtree *self, void *where, ao2_prnt_fn *prnt, ao2_prnt_obj_fn *prnt_obj)
1702 {
1703 #define FORMAT  "%16s, %16s, %16s, %16s, %5s, %16s, %s\n"
1704 #define FORMAT2 "%16p, %16p, %16p, %16p, %5s, %16p, "
1705
1706         struct rbtree_node *node;
1707
1708         prnt(where, FORMAT, "Node", "Parent", "Left", "Right", "Color", "Obj", "Key");
1709         for (node = self->root; node; node = rb_node_pre(node)) {
1710                 prnt(where, FORMAT2,
1711                         node,
1712                         node->parent,
1713                         node->left,
1714                         node->right,
1715                         node->is_red ? "Red" : "Black",
1716                         node->common.obj);
1717                 if (node->common.obj && prnt_obj) {
1718                         prnt_obj(node->common.obj, where, prnt);
1719                 }
1720                 prnt(where, "\n");
1721         }
1722
1723 #undef FORMAT
1724 #undef FORMAT2
1725 }
1726 #endif  /* defined(AO2_DEBUG) */
1727
1728 #if defined(AO2_DEBUG)
1729 /*!
1730  * \internal
1731  * \brief Display statistics of the specified container.
1732  * \since 12.0.0
1733  *
1734  * \param self Container to display statistics.
1735  * \param where User data needed by prnt to determine where to put output.
1736  * \param prnt Print output callback function to use.
1737  *
1738  * \note The container is already locked for reading.
1739  *
1740  * \return Nothing
1741  */
1742 static void rb_ao2_stats(struct ao2_container_rbtree *self, void *where, ao2_prnt_fn *prnt)
1743 {
1744         int idx;
1745
1746         for (idx = 0; idx < ARRAY_LEN(self->stats.fixup_insert_left); ++idx) {
1747                 prnt(where, "Number of left insert fixups case %d: %d\n", idx + 1,
1748                         self->stats.fixup_insert_left[idx]);
1749         }
1750         for (idx = 0; idx < ARRAY_LEN(self->stats.fixup_insert_right); ++idx) {
1751                 prnt(where, "Number of right insert fixups case %d: %d\n", idx + 1,
1752                         self->stats.fixup_insert_right[idx]);
1753         }
1754
1755         for (idx = 0; idx < ARRAY_LEN(self->stats.delete_children); ++idx) {
1756                 prnt(where, "Number of nodes deleted with %d children: %d\n", idx,
1757                         self->stats.delete_children[idx]);
1758         }
1759         for (idx = 0; idx < ARRAY_LEN(self->stats.fixup_delete_left); ++idx) {
1760                 prnt(where, "Number of left delete fixups case %d: %d\n", idx + 1,
1761                         self->stats.fixup_delete_left[idx]);
1762         }
1763         for (idx = 0; idx < ARRAY_LEN(self->stats.fixup_delete_right); ++idx) {
1764                 prnt(where, "Number of right delete fixups case %d: %d\n", idx + 1,
1765                         self->stats.fixup_delete_right[idx]);
1766         }
1767 }
1768 #endif  /* defined(AO2_DEBUG) */
1769
1770 #if defined(AO2_DEBUG)
1771 /*!
1772  * \internal
1773  * \brief Check the black height of the given node.
1774  * \since 12.0.0
1775  *
1776  * \param node Node to check black height.
1777  *
1778  * \retval black-height of node on success.
1779  * \retval -1 on error.  Node black height did not balance.
1780  */
1781 static int rb_check_black_height(struct rbtree_node *node)
1782 {
1783         int height_left;
1784         int height_right;
1785
1786         if (!node) {
1787                 /* A NULL child is a black node. */
1788                 return 0;
1789         }
1790
1791         height_left = rb_check_black_height(node->left);
1792         if (height_left < 0) {
1793                 return -1;
1794         }
1795         height_right = rb_check_black_height(node->right);
1796         if (height_right < 0) {
1797                 return -1;
1798         }
1799         if (height_left != height_right) {
1800                 ast_log(LOG_ERROR,
1801                         "Tree node black height of children does not match! L:%d != R:%d\n",
1802                         height_left, height_right);
1803                 return -1;
1804         }
1805         if (!node->is_red) {
1806                 /* The node itself is black. */
1807                 ++height_left;
1808         }
1809         return height_left;
1810 }
1811
1812 #endif  /* defined(AO2_DEBUG) */
1813
1814 #if defined(AO2_DEBUG)
1815 /*!
1816  * \internal
1817  * \brief Perform an integrity check on the specified container.
1818  * \since 12.0.0
1819  *
1820  * \param self Container to check integrity.
1821  *
1822  * \note The container is already locked for reading.
1823  *
1824  * \retval 0 on success.
1825  * \retval -1 on error.
1826  */
1827 static int rb_ao2_integrity(struct ao2_container_rbtree *self)
1828 {
1829         int res;
1830         int count_node;
1831         int count_obj;
1832         void *obj_last;
1833         struct rbtree_node *node;
1834
1835         res = 0;
1836
1837         count_node = 0;
1838         count_obj = 0;
1839
1840         /*
1841          * See the properties listed at struct rbtree_node definition.
1842          *
1843          * The rbtree properties 1 and 3 are not testable.
1844          *
1845          * Property 1 is not testable because we are not rebalancing at
1846          * this time so all nodes are either red or black.
1847          *
1848          * Property 3 is not testable because it is the definition of a
1849          * NULL child.
1850          */
1851         if (self->root) {
1852                 /* Check tree links. */
1853                 if (self->root->parent) {
1854                         if (self->root->parent == self->root) {
1855                                 ast_log(LOG_ERROR, "Tree root parent pointer points to itself!\n");
1856                         } else {
1857                                 ast_log(LOG_ERROR, "Tree root is not a root node!\n");
1858                         }
1859                         return -1;
1860                 }
1861                 if (self->root->is_red) {
1862                         /* Violation rbtree property 2. */
1863                         ast_log(LOG_ERROR, "Tree root is red!\n");
1864                         res = -1;
1865                 }
1866                 node = self->root;
1867                 do {
1868                         if (node->left) {
1869                                 if (node->left == node) {
1870                                         ast_log(LOG_ERROR, "Tree node's left pointer points to itself!\n");
1871                                         return -1;
1872                                 }
1873                                 if (node->left->parent != node) {
1874                                         ast_log(LOG_ERROR, "Tree node's left child does not link back!\n");
1875                                         return -1;
1876                                 }
1877                         }
1878                         if (node->right) {
1879                                 if (node->right == node) {
1880                                         ast_log(LOG_ERROR, "Tree node's right pointer points to itself!\n");
1881                                         return -1;
1882                                 }
1883                                 if (node->right->parent != node) {
1884                                         ast_log(LOG_ERROR, "Tree node's right child does not link back!\n");
1885                                         return -1;
1886                                 }
1887                         }
1888
1889                         /* Check red/black node flags. */
1890                         if (node->is_red) {
1891                                 /* A red node must have two black children or no children. */
1892                                 if (node->left && node->right) {
1893                                         /* Node has two children. */
1894                                         if (node->left->is_red) {
1895                                                 /* Violation rbtree property 4. */
1896                                                 ast_log(LOG_ERROR, "Tree node is red and its left child is red!\n");
1897                                                 res = -1;
1898                                         }
1899                                         if (node->right->is_red) {
1900                                                 /* Violation rbtree property 4. */
1901                                                 ast_log(LOG_ERROR, "Tree node is red and its right child is red!\n");
1902                                                 res = -1;
1903                                         }
1904                                 } else if (node->left || node->right) {
1905                                         /*
1906                                          * Violation rbtree property 4 if the child is red.
1907                                          * Violation rbtree property 5 if the child is black.
1908                                          */
1909                                         ast_log(LOG_ERROR, "Tree node is red and it only has one child!\n");
1910                                         res = -1;
1911                                 }
1912                         } else {
1913                                 /*
1914                                  * A black node must have two children, or one red child, or no
1915                                  * children.  If the black node has two children and only one of
1916                                  * them is red, that red child must have two children.
1917                                  */
1918                                 if (node->left && node->right) {
1919                                         /* Node has two children. */
1920                                         if (node->left->is_red != node->right->is_red) {
1921                                                 /* The children are not the same color. */
1922                                                 struct rbtree_node *red;
1923
1924                                                 if (node->left->is_red) {
1925                                                         red = node->left;
1926                                                 } else {
1927                                                         red = node->right;
1928                                                 }
1929                                                 if (!red->left || !red->right) {
1930                                                         /* Violation rbtree property 5. */
1931                                                         ast_log(LOG_ERROR,
1932                                                                 "Tree node is black and the red child does not have two children!\n");
1933                                                         res = -1;
1934                                                 }
1935                                         }
1936                                 } else if ((node->left && !node->left->is_red)
1937                                         || (node->right && !node->right->is_red)) {
1938                                         /* Violation rbtree property 5. */
1939                                         ast_log(LOG_ERROR, "Tree node is black and its only child is black!\n");
1940                                         res = -1;
1941                                 }
1942                         }
1943
1944                         /* Count nodes and objects. */
1945                         ++count_node;
1946                         if (node->common.obj) {
1947                                 ++count_obj;
1948                         }
1949
1950                         node = rb_node_pre(node);
1951                 } while (node);
1952
1953                 /* Check node key sort order. */
1954                 obj_last = NULL;
1955                 for (node = rb_node_most_left(self->root); node; node = rb_node_next(node)) {
1956                         if (!node->common.obj) {
1957                                 /* Node is empty. */
1958                                 continue;
1959                         }
1960
1961                         if (obj_last) {
1962                                 if (self->common.sort_fn(obj_last, node->common.obj, OBJ_SEARCH_OBJECT) > 0) {
1963                                         ast_log(LOG_ERROR, "Tree nodes are out of sorted order!\n");
1964                                         return -1;
1965                                 }
1966                         }
1967                         obj_last = node->common.obj;
1968                 }
1969
1970                 /* Completely check property 5 */
1971                 if (!res && rb_check_black_height(self->root) < 0) {
1972                         /* Violation rbtree property 5. */
1973                         res = -1;
1974                 }
1975         }
1976
1977         /* Check total obj count. */
1978         if (count_obj != ao2_container_count(&self->common)) {
1979                 ast_log(LOG_ERROR, "Total object count does not match ao2_container_count()!\n");
1980                 return -1;
1981         }
1982
1983         /* Check total node count. */
1984         if (count_node != self->common.nodes) {
1985                 ast_log(LOG_ERROR, "Total node count of %d does not match stat of %d!\n",
1986                         count_node, self->common.nodes);
1987                 return -1;
1988         }
1989
1990         return res;
1991 }
1992 #endif  /* defined(AO2_DEBUG) */
1993
1994 /*! rbtree container virtual method table. */
1995 static const struct ao2_container_methods v_table_rbtree = {
1996         .alloc_empty_clone = (ao2_container_alloc_empty_clone_fn) rb_ao2_alloc_empty_clone,
1997         .new_node = (ao2_container_new_node_fn) rb_ao2_new_node,
1998         .insert = (ao2_container_insert_fn) rb_ao2_insert_node,
1999         .traverse_first = (ao2_container_find_first_fn) rb_ao2_find_first,
2000         .traverse_next = (ao2_container_find_next_fn) rb_ao2_find_next,
2001         .iterator_next = (ao2_iterator_next_fn) rb_ao2_iterator_next,
2002         .destroy = (ao2_container_destroy_fn) rb_ao2_destroy,
2003 #if defined(AO2_DEBUG)
2004         .dump = (ao2_container_display) rb_ao2_dump,
2005         .stats = (ao2_container_statistics) rb_ao2_stats,
2006         .integrity = (ao2_container_integrity) rb_ao2_integrity,
2007 #endif  /* defined(AO2_DEBUG) */
2008 };
2009
2010 /*!
2011  * \brief Initialize a rbtree container.
2012  *
2013  * \param self Container to initialize.
2014  * \param options Container behaviour options (See enum ao2_container_opts)
2015  * \param sort_fn Pointer to a sort function.
2016  * \param cmp_fn Pointer to a compare function used by ao2_find.
2017  *
2018  * \return A pointer to a struct container.
2019  */
2020 static struct ao2_container *rb_ao2_container_init(struct ao2_container_rbtree *self,
2021         unsigned int options, ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn)
2022 {
2023         if (!self) {
2024                 return NULL;
2025         }
2026
2027         self->common.v_table = &v_table_rbtree;
2028         self->common.sort_fn = sort_fn;
2029         self->common.cmp_fn = cmp_fn;
2030         self->common.options = options;
2031
2032 #ifdef AO2_DEBUG
2033         ast_atomic_fetchadd_int(&ao2.total_containers, 1);
2034 #endif  /* defined(AO2_DEBUG) */
2035
2036         return (struct ao2_container *) self;
2037 }
2038
2039 struct ao2_container *__ao2_container_alloc_rbtree(unsigned int ao2_options, unsigned int container_options,
2040         ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn,
2041         const char *tag, const char *file, int line, const char *func)
2042 {
2043         struct ao2_container_rbtree *self;
2044
2045         if (!sort_fn) {
2046                 /* Sanity checks. */
2047                 ast_log(__LOG_ERROR, file, line, func, "Missing sort_fn()!\n");
2048                 return NULL;
2049         }
2050
2051         self = __ao2_alloc(sizeof(*self), container_destruct, ao2_options,
2052                 tag ?: __PRETTY_FUNCTION__, file, line, func);
2053         return rb_ao2_container_init(self, container_options, sort_fn, cmp_fn);
2054 }