008c803cc59a999269d0f32be7f50870c0cb3c8b
[asterisk/asterisk.git] / main / astobj2.c
1 /*
2  * astobj2 - replacement containers for asterisk data structures.
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 Functions implementing astobj2 objects.
20  *
21  * \author Richard Mudgett <rmudgett@digium.com>
22  */
23
24 /*** MODULEINFO
25         <support_level>core</support_level>
26  ***/
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/_private.h"
33 #include "asterisk/astobj2.h"
34 #include "asterisk/dlinkedlists.h"
35 #include "asterisk/utils.h"
36 #include "asterisk/cli.h"
37 #define REF_FILE "/tmp/refs"
38
39 #if defined(TEST_FRAMEWORK)
40 /* We are building with the test framework enabled so enable AO2 debug tests as well. */
41 #define AO2_DEBUG 1
42 #endif  /* defined(TEST_FRAMEWORK) */
43
44 /*!
45  * astobj2 objects are always preceded by this data structure,
46  * which contains a reference counter,
47  * option flags and a pointer to a destructor.
48  * The refcount is used to decide when it is time to
49  * invoke the destructor.
50  * The magic number is used for consistency check.
51  */
52 struct __priv_data {
53         int ref_counter;
54         ao2_destructor_fn destructor_fn;
55         /*! User data size for stats */
56         size_t data_size;
57         /*! The ao2 object option flags */
58         uint32_t options;
59         /*! magic number.  This is used to verify that a pointer passed in is a
60          *  valid astobj2 */
61         uint32_t magic;
62 };
63
64 #define AO2_MAGIC       0xa570b123
65
66 /*!
67  * What an astobj2 object looks like: fixed-size private data
68  * followed by variable-size user data.
69  */
70 struct astobj2 {
71         struct __priv_data priv_data;
72         void *user_data[0];
73 };
74
75 struct ao2_lock_priv {
76         ast_mutex_t lock;
77 };
78
79 /* AstObj2 with recursive lock. */
80 struct astobj2_lock {
81         struct ao2_lock_priv mutex;
82         struct __priv_data priv_data;
83         void *user_data[0];
84 };
85
86 struct ao2_rwlock_priv {
87         ast_rwlock_t lock;
88         /*! Count of the number of threads holding a lock on this object. -1 if it is the write lock. */
89         int num_lockers;
90 };
91
92 /* AstObj2 with RW lock. */
93 struct astobj2_rwlock {
94         struct ao2_rwlock_priv rwlock;
95         struct __priv_data priv_data;
96         void *user_data[0];
97 };
98
99 #if defined(AST_DEVMODE)
100 #define AO2_DEVMODE_STAT(stat)  stat
101 #else
102 #define AO2_DEVMODE_STAT(stat)
103 #endif  /* defined(AST_DEVMODE) */
104
105 #ifdef AO2_DEBUG
106 struct ao2_stats {
107         volatile int total_objects;
108         volatile int total_mem;
109         volatile int total_containers;
110         volatile int total_refs;
111         volatile int total_locked;
112 };
113
114 static struct ao2_stats ao2;
115 #endif
116
117 #ifdef HAVE_BKTR
118 #include <execinfo.h>    /* for backtrace */
119 #endif
120
121 void ao2_bt(void)
122 {
123 #ifdef HAVE_BKTR
124         int depth;
125         int idx;
126 #define N1      20
127         void *addresses[N1];
128         char **strings;
129
130         depth = backtrace(addresses, N1);
131         strings = ast_bt_get_symbols(addresses, depth);
132         ast_verbose("backtrace returned: %d\n", depth);
133         for (idx = 0; idx < depth; ++idx) {
134                 ast_verbose("%d: %p %s\n", idx, addresses[idx], strings[idx]);
135         }
136         ast_std_free(strings);
137 #endif
138 }
139
140 #define INTERNAL_OBJ_MUTEX(user_data) \
141         ((struct astobj2_lock *) (((char *) (user_data)) - sizeof(struct astobj2_lock)))
142
143 #define INTERNAL_OBJ_RWLOCK(user_data) \
144         ((struct astobj2_rwlock *) (((char *) (user_data)) - sizeof(struct astobj2_rwlock)))
145
146 /*!
147  * \brief convert from a pointer _p to a user-defined object
148  *
149  * \return the pointer to the astobj2 structure
150  */
151 static inline struct astobj2 *INTERNAL_OBJ(void *user_data)
152 {
153         struct astobj2 *p;
154
155         if (!user_data) {
156                 ast_log(LOG_ERROR, "user_data is NULL\n");
157                 return NULL;
158         }
159
160         p = (struct astobj2 *) ((char *) user_data - sizeof(*p));
161         if (AO2_MAGIC != p->priv_data.magic) {
162                 if (p->priv_data.magic) {
163                         ast_log(LOG_ERROR, "bad magic number 0x%x for object %p\n",
164                                 p->priv_data.magic, user_data);
165                 } else {
166                         ast_log(LOG_ERROR,
167                                 "bad magic number for object %p. Object is likely destroyed.\n",
168                                 user_data);
169                 }
170                 return NULL;
171         }
172
173         return p;
174 }
175
176 /*!
177  * \brief convert from a pointer _p to an astobj2 object
178  *
179  * \return the pointer to the user-defined portion.
180  */
181 #define EXTERNAL_OBJ(_p)        ((_p) == NULL ? NULL : (_p)->user_data)
182
183 int __ao2_lock(void *user_data, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var)
184 {
185         struct astobj2 *obj = INTERNAL_OBJ(user_data);
186         struct astobj2_lock *obj_mutex;
187         struct astobj2_rwlock *obj_rwlock;
188         int res = 0;
189
190         if (obj == NULL) {
191                 ast_assert(0);
192                 return -1;
193         }
194
195         switch (obj->priv_data.options & AO2_ALLOC_OPT_LOCK_MASK) {
196         case AO2_ALLOC_OPT_LOCK_MUTEX:
197                 obj_mutex = INTERNAL_OBJ_MUTEX(user_data);
198                 res = __ast_pthread_mutex_lock(file, line, func, var, &obj_mutex->mutex.lock);
199 #ifdef AO2_DEBUG
200                 if (!res) {
201                         ast_atomic_fetchadd_int(&ao2.total_locked, 1);
202                 }
203 #endif
204                 break;
205         case AO2_ALLOC_OPT_LOCK_RWLOCK:
206                 obj_rwlock = INTERNAL_OBJ_RWLOCK(user_data);
207                 switch (lock_how) {
208                 case AO2_LOCK_REQ_MUTEX:
209                 case AO2_LOCK_REQ_WRLOCK:
210                         res = __ast_rwlock_wrlock(file, line, func, &obj_rwlock->rwlock.lock, var);
211                         if (!res) {
212                                 ast_atomic_fetchadd_int(&obj_rwlock->rwlock.num_lockers, -1);
213 #ifdef AO2_DEBUG
214                                 ast_atomic_fetchadd_int(&ao2.total_locked, 1);
215 #endif
216                         }
217                         break;
218                 case AO2_LOCK_REQ_RDLOCK:
219                         res = __ast_rwlock_rdlock(file, line, func, &obj_rwlock->rwlock.lock, var);
220                         if (!res) {
221                                 ast_atomic_fetchadd_int(&obj_rwlock->rwlock.num_lockers, +1);
222 #ifdef AO2_DEBUG
223                                 ast_atomic_fetchadd_int(&ao2.total_locked, 1);
224 #endif
225                         }
226                         break;
227                 }
228                 break;
229         case AO2_ALLOC_OPT_LOCK_NOLOCK:
230                 /* The ao2 object has no lock. */
231                 break;
232         default:
233                 ast_log(__LOG_ERROR, file, line, func, "Invalid lock option on ao2 object %p\n",
234                         user_data);
235                 return -1;
236         }
237
238         return res;
239 }
240
241 int __ao2_unlock(void *user_data, const char *file, const char *func, int line, const char *var)
242 {
243         struct astobj2 *obj = INTERNAL_OBJ(user_data);
244         struct astobj2_lock *obj_mutex;
245         struct astobj2_rwlock *obj_rwlock;
246         int res = 0;
247         int current_value;
248
249         if (obj == NULL) {
250                 ast_assert(0);
251                 return -1;
252         }
253
254         switch (obj->priv_data.options & AO2_ALLOC_OPT_LOCK_MASK) {
255         case AO2_ALLOC_OPT_LOCK_MUTEX:
256                 obj_mutex = INTERNAL_OBJ_MUTEX(user_data);
257                 res = __ast_pthread_mutex_unlock(file, line, func, var, &obj_mutex->mutex.lock);
258 #ifdef AO2_DEBUG
259                 if (!res) {
260                         ast_atomic_fetchadd_int(&ao2.total_locked, -1);
261                 }
262 #endif
263                 break;
264         case AO2_ALLOC_OPT_LOCK_RWLOCK:
265                 obj_rwlock = INTERNAL_OBJ_RWLOCK(user_data);
266
267                 current_value = ast_atomic_fetchadd_int(&obj_rwlock->rwlock.num_lockers, -1) - 1;
268                 if (current_value < 0) {
269                         /* It was a WRLOCK that we are unlocking.  Fix the count. */
270                         ast_atomic_fetchadd_int(&obj_rwlock->rwlock.num_lockers, -current_value);
271                 }
272                 res = __ast_rwlock_unlock(file, line, func, &obj_rwlock->rwlock.lock, var);
273 #ifdef AO2_DEBUG
274                 if (!res) {
275                         ast_atomic_fetchadd_int(&ao2.total_locked, -1);
276                 }
277 #endif
278                 break;
279         case AO2_ALLOC_OPT_LOCK_NOLOCK:
280                 /* The ao2 object has no lock. */
281                 break;
282         default:
283                 ast_log(__LOG_ERROR, file, line, func, "Invalid lock option on ao2 object %p\n",
284                         user_data);
285                 res = -1;
286                 break;
287         }
288         return res;
289 }
290
291 int __ao2_trylock(void *user_data, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var)
292 {
293         struct astobj2 *obj = INTERNAL_OBJ(user_data);
294         struct astobj2_lock *obj_mutex;
295         struct astobj2_rwlock *obj_rwlock;
296         int res = 0;
297
298         if (obj == NULL) {
299                 ast_assert(0);
300                 return -1;
301         }
302
303         switch (obj->priv_data.options & AO2_ALLOC_OPT_LOCK_MASK) {
304         case AO2_ALLOC_OPT_LOCK_MUTEX:
305                 obj_mutex = INTERNAL_OBJ_MUTEX(user_data);
306                 res = __ast_pthread_mutex_trylock(file, line, func, var, &obj_mutex->mutex.lock);
307 #ifdef AO2_DEBUG
308                 if (!res) {
309                         ast_atomic_fetchadd_int(&ao2.total_locked, 1);
310                 }
311 #endif
312                 break;
313         case AO2_ALLOC_OPT_LOCK_RWLOCK:
314                 obj_rwlock = INTERNAL_OBJ_RWLOCK(user_data);
315                 switch (lock_how) {
316                 case AO2_LOCK_REQ_MUTEX:
317                 case AO2_LOCK_REQ_WRLOCK:
318                         res = __ast_rwlock_trywrlock(file, line, func, &obj_rwlock->rwlock.lock, var);
319                         if (!res) {
320                                 ast_atomic_fetchadd_int(&obj_rwlock->rwlock.num_lockers, -1);
321 #ifdef AO2_DEBUG
322                                 ast_atomic_fetchadd_int(&ao2.total_locked, 1);
323 #endif
324                         }
325                         break;
326                 case AO2_LOCK_REQ_RDLOCK:
327                         res = __ast_rwlock_tryrdlock(file, line, func, &obj_rwlock->rwlock.lock, var);
328                         if (!res) {
329                                 ast_atomic_fetchadd_int(&obj_rwlock->rwlock.num_lockers, +1);
330 #ifdef AO2_DEBUG
331                                 ast_atomic_fetchadd_int(&ao2.total_locked, 1);
332 #endif
333                         }
334                         break;
335                 }
336                 break;
337         case AO2_ALLOC_OPT_LOCK_NOLOCK:
338                 /* The ao2 object has no lock. */
339                 return 0;
340         default:
341                 ast_log(__LOG_ERROR, file, line, func, "Invalid lock option on ao2 object %p\n",
342                         user_data);
343                 return -1;
344         }
345
346
347         return res;
348 }
349
350 /*!
351  * \internal
352  * \brief Adjust an object's lock to the requested level.
353  *
354  * \param user_data An ao2 object to adjust lock level.
355  * \param lock_how What level to adjust lock.
356  * \param keep_stronger TRUE if keep original lock level if it is stronger.
357  *
358  * \pre The ao2 object is already locked.
359  *
360  * \details
361  * An ao2 object with a RWLOCK will have its lock level adjusted
362  * to the specified level if it is not already there.  An ao2
363  * object with a different type of lock is not affected.
364  *
365  * \return Original lock level.
366  */
367 static enum ao2_lock_req adjust_lock(void *user_data, enum ao2_lock_req lock_how, int keep_stronger)
368 {
369         struct astobj2 *obj = INTERNAL_OBJ(user_data);
370         struct astobj2_rwlock *obj_rwlock;
371         enum ao2_lock_req orig_lock;
372
373         switch (obj->priv_data.options & AO2_ALLOC_OPT_LOCK_MASK) {
374         case AO2_ALLOC_OPT_LOCK_RWLOCK:
375                 obj_rwlock = INTERNAL_OBJ_RWLOCK(user_data);
376                 if (obj_rwlock->rwlock.num_lockers < 0) {
377                         orig_lock = AO2_LOCK_REQ_WRLOCK;
378                 } else {
379                         orig_lock = AO2_LOCK_REQ_RDLOCK;
380                 }
381                 switch (lock_how) {
382                 case AO2_LOCK_REQ_MUTEX:
383                         lock_how = AO2_LOCK_REQ_WRLOCK;
384                         /* Fall through */
385                 case AO2_LOCK_REQ_WRLOCK:
386                         if (lock_how != orig_lock) {
387                                 /* Switch from read lock to write lock. */
388                                 ao2_unlock(user_data);
389                                 ao2_wrlock(user_data);
390                         }
391                         break;
392                 case AO2_LOCK_REQ_RDLOCK:
393                         if (!keep_stronger && lock_how != orig_lock) {
394                                 /* Switch from write lock to read lock. */
395                                 ao2_unlock(user_data);
396                                 ao2_rdlock(user_data);
397                         }
398                         break;
399                 }
400                 break;
401         default:
402                 ast_log(LOG_ERROR, "Invalid lock option on ao2 object %p\n", user_data);
403                 /* Fall through */
404         case AO2_ALLOC_OPT_LOCK_NOLOCK:
405         case AO2_ALLOC_OPT_LOCK_MUTEX:
406                 orig_lock = AO2_LOCK_REQ_MUTEX;
407                 break;
408         }
409
410         return orig_lock;
411 }
412
413 void *ao2_object_get_lockaddr(void *user_data)
414 {
415         struct astobj2 *obj = INTERNAL_OBJ(user_data);
416         struct astobj2_lock *obj_mutex;
417
418         if (obj == NULL) {
419                 ast_assert(0);
420                 return NULL;
421         }
422
423         switch (obj->priv_data.options & AO2_ALLOC_OPT_LOCK_MASK) {
424         case AO2_ALLOC_OPT_LOCK_MUTEX:
425                 obj_mutex = INTERNAL_OBJ_MUTEX(user_data);
426                 return &obj_mutex->mutex.lock;
427         default:
428                 break;
429         }
430
431         return NULL;
432 }
433
434 static int internal_ao2_ref(void *user_data, int delta, const char *file, int line, const char *func)
435 {
436         struct astobj2 *obj = INTERNAL_OBJ(user_data);
437         struct astobj2_lock *obj_mutex;
438         struct astobj2_rwlock *obj_rwlock;
439         int current_value;
440         int ret;
441
442         if (obj == NULL) {
443                 ast_assert(0);
444                 return -1;
445         }
446
447         /* if delta is 0, just return the refcount */
448         if (delta == 0) {
449                 return obj->priv_data.ref_counter;
450         }
451
452         /* we modify with an atomic operation the reference counter */
453         ret = ast_atomic_fetchadd_int(&obj->priv_data.ref_counter, delta);
454         current_value = ret + delta;
455
456 #ifdef AO2_DEBUG
457         ast_atomic_fetchadd_int(&ao2.total_refs, delta);
458 #endif
459
460         if (0 < current_value) {
461                 /* The object still lives. */
462                 return ret;
463         }
464
465         /* this case must never happen */
466         if (current_value < 0) {
467                 ast_log(__LOG_ERROR, file, line, func,
468                         "Invalid refcount %d on ao2 object %p\n", current_value, user_data);
469         }
470
471         /* last reference, destroy the object */
472         if (obj->priv_data.destructor_fn != NULL) {
473                 obj->priv_data.destructor_fn(user_data);
474         }
475
476 #ifdef AO2_DEBUG
477         ast_atomic_fetchadd_int(&ao2.total_mem, - obj->priv_data.data_size);
478         ast_atomic_fetchadd_int(&ao2.total_objects, -1);
479 #endif
480
481         switch (obj->priv_data.options & AO2_ALLOC_OPT_LOCK_MASK) {
482         case AO2_ALLOC_OPT_LOCK_MUTEX:
483                 obj_mutex = INTERNAL_OBJ_MUTEX(user_data);
484                 ast_mutex_destroy(&obj_mutex->mutex.lock);
485
486                 /*
487                  * For safety, zero-out the astobj2_lock header and also the
488                  * first word of the user-data, which we make sure is always
489                  * allocated.
490                  */
491                 memset(obj_mutex, '\0', sizeof(*obj_mutex) + sizeof(void *) );
492                 ast_free(obj_mutex);
493                 break;
494         case AO2_ALLOC_OPT_LOCK_RWLOCK:
495                 obj_rwlock = INTERNAL_OBJ_RWLOCK(user_data);
496                 ast_rwlock_destroy(&obj_rwlock->rwlock.lock);
497
498                 /*
499                  * For safety, zero-out the astobj2_rwlock header and also the
500                  * first word of the user-data, which we make sure is always
501                  * allocated.
502                  */
503                 memset(obj_rwlock, '\0', sizeof(*obj_rwlock) + sizeof(void *) );
504                 ast_free(obj_rwlock);
505                 break;
506         case AO2_ALLOC_OPT_LOCK_NOLOCK:
507                 /*
508                  * For safety, zero-out the astobj2 header and also the first
509                  * word of the user-data, which we make sure is always
510                  * allocated.
511                  */
512                 memset(obj, '\0', sizeof(*obj) + sizeof(void *) );
513                 ast_free(obj);
514                 break;
515         default:
516                 ast_log(__LOG_ERROR, file, line, func,
517                         "Invalid lock option on ao2 object %p\n", user_data);
518                 break;
519         }
520
521         return ret;
522 }
523
524 int __ao2_ref_debug(void *user_data, int delta, const char *tag, const char *file, int line, const char *func)
525 {
526         struct astobj2 *obj = INTERNAL_OBJ(user_data);
527
528         if (obj == NULL) {
529                 ast_log_backtrace();
530                 ast_assert(0);
531                 return -1;
532         }
533
534         if (delta != 0) {
535                 FILE *refo = fopen(REF_FILE, "a");
536                 if (refo) {
537                         fprintf(refo, "%p %s%d   %s:%d:%s (%s) [@%d]\n", user_data, (delta < 0 ? "" : "+"),
538                                 delta, file, line, func, tag, obj->priv_data.ref_counter);
539                         fclose(refo);
540                 }
541         }
542         if (obj->priv_data.ref_counter + delta == 0 && obj->priv_data.destructor_fn != NULL) { /* this isn't protected with lock; just for o/p */
543                 FILE *refo = fopen(REF_FILE, "a");
544                 if (refo) {
545                         fprintf(refo, "%p **call destructor** %s:%d:%s (%s)\n", user_data, file, line, func, tag);
546                         fclose(refo);
547                 }
548         }
549         return internal_ao2_ref(user_data, delta, file, line, func);
550 }
551
552 int __ao2_ref(void *user_data, int delta)
553 {
554         return internal_ao2_ref(user_data, delta, __FILE__, __LINE__, __FUNCTION__);
555 }
556
557 void __ao2_cleanup_debug(void *obj, const char *file, int line, const char *function)
558 {
559         if (obj) {
560                 __ao2_ref_debug(obj, -1, "ao2_cleanup", file, line, function);
561         }
562 }
563
564 void __ao2_cleanup(void *obj)
565 {
566         if (obj) {
567                 ao2_ref(obj, -1);
568         }
569 }
570
571 static void *internal_ao2_alloc(size_t data_size, ao2_destructor_fn destructor_fn, unsigned int options, const char *file, int line, const char *func)
572 {
573         /* allocation */
574         struct astobj2 *obj;
575         struct astobj2_lock *obj_mutex;
576         struct astobj2_rwlock *obj_rwlock;
577
578         if (data_size < sizeof(void *)) {
579                 /*
580                  * We always alloc at least the size of a void *,
581                  * for debugging purposes.
582                  */
583                 data_size = sizeof(void *);
584         }
585
586         switch (options & AO2_ALLOC_OPT_LOCK_MASK) {
587         case AO2_ALLOC_OPT_LOCK_MUTEX:
588 #if defined(__AST_DEBUG_MALLOC)
589                 obj_mutex = __ast_calloc(1, sizeof(*obj_mutex) + data_size, file, line, func);
590 #else
591                 obj_mutex = ast_calloc(1, sizeof(*obj_mutex) + data_size);
592 #endif
593                 if (obj_mutex == NULL) {
594                         return NULL;
595                 }
596
597                 ast_mutex_init(&obj_mutex->mutex.lock);
598                 obj = (struct astobj2 *) &obj_mutex->priv_data;
599                 break;
600         case AO2_ALLOC_OPT_LOCK_RWLOCK:
601 #if defined(__AST_DEBUG_MALLOC)
602                 obj_rwlock = __ast_calloc(1, sizeof(*obj_rwlock) + data_size, file, line, func);
603 #else
604                 obj_rwlock = ast_calloc(1, sizeof(*obj_rwlock) + data_size);
605 #endif
606                 if (obj_rwlock == NULL) {
607                         return NULL;
608                 }
609
610                 ast_rwlock_init(&obj_rwlock->rwlock.lock);
611                 obj = (struct astobj2 *) &obj_rwlock->priv_data;
612                 break;
613         case AO2_ALLOC_OPT_LOCK_NOLOCK:
614 #if defined(__AST_DEBUG_MALLOC)
615                 obj = __ast_calloc(1, sizeof(*obj) + data_size, file, line, func);
616 #else
617                 obj = ast_calloc(1, sizeof(*obj) + data_size);
618 #endif
619                 if (obj == NULL) {
620                         return NULL;
621                 }
622                 break;
623         default:
624                 /* Invalid option value. */
625                 ast_log(__LOG_DEBUG, file, line, func, "Invalid lock option requested\n");
626                 return NULL;
627         }
628
629         /* Initialize common ao2 values. */
630         obj->priv_data.ref_counter = 1;
631         obj->priv_data.destructor_fn = destructor_fn;   /* can be NULL */
632         obj->priv_data.data_size = data_size;
633         obj->priv_data.options = options;
634         obj->priv_data.magic = AO2_MAGIC;
635
636 #ifdef AO2_DEBUG
637         ast_atomic_fetchadd_int(&ao2.total_objects, 1);
638         ast_atomic_fetchadd_int(&ao2.total_mem, data_size);
639         ast_atomic_fetchadd_int(&ao2.total_refs, 1);
640 #endif
641
642         /* return a pointer to the user data */
643         return EXTERNAL_OBJ(obj);
644 }
645
646 void *__ao2_alloc_debug(size_t data_size, ao2_destructor_fn destructor_fn, unsigned int options, const char *tag,
647         const char *file, int line, const char *func, int ref_debug)
648 {
649         /* allocation */
650         void *obj;
651         FILE *refo;
652
653         if ((obj = internal_ao2_alloc(data_size, destructor_fn, options, file, line, func)) == NULL) {
654                 return NULL;
655         }
656
657         if (ref_debug && (refo = fopen(REF_FILE, "a"))) {
658                 fprintf(refo, "%p =1   %s:%d:%s (%s)\n", obj, file, line, func, tag);
659                 fclose(refo);
660         }
661
662         /* return a pointer to the user data */
663         return obj;
664 }
665
666 void *__ao2_alloc(size_t data_size, ao2_destructor_fn destructor_fn, unsigned int options)
667 {
668         return internal_ao2_alloc(data_size, destructor_fn, options, __FILE__, __LINE__, __FUNCTION__);
669 }
670
671
672 void __ao2_global_obj_release(struct ao2_global_obj *holder, const char *tag, const char *file, int line, const char *func, const char *name)
673 {
674         if (!holder) {
675                 /* For sanity */
676                 ast_log(LOG_ERROR, "Must be called with a global object!\n");
677                 ast_assert(0);
678                 return;
679         }
680         if (__ast_rwlock_wrlock(file, line, func, &holder->lock, name)) {
681                 /* Could not get the write lock. */
682                 ast_assert(0);
683                 return;
684         }
685
686         /* Release the held ao2 object. */
687         if (holder->obj) {
688                 if (tag) {
689                         __ao2_ref_debug(holder->obj, -1, tag, file, line, func);
690                 } else {
691                         __ao2_ref(holder->obj, -1);
692                 }
693                 holder->obj = NULL;
694         }
695
696         __ast_rwlock_unlock(file, line, func, &holder->lock, name);
697 }
698
699 void *__ao2_global_obj_replace(struct ao2_global_obj *holder, void *obj, const char *tag, const char *file, int line, const char *func, const char *name)
700 {
701         void *obj_old;
702
703         if (!holder) {
704                 /* For sanity */
705                 ast_log(LOG_ERROR, "Must be called with a global object!\n");
706                 ast_assert(0);
707                 return NULL;
708         }
709         if (__ast_rwlock_wrlock(file, line, func, &holder->lock, name)) {
710                 /* Could not get the write lock. */
711                 ast_assert(0);
712                 return NULL;
713         }
714
715         if (obj) {
716                 if (tag) {
717                         __ao2_ref_debug(obj, +1, tag, file, line, func);
718                 } else {
719                         __ao2_ref(obj, +1);
720                 }
721         }
722         obj_old = holder->obj;
723         holder->obj = obj;
724
725         __ast_rwlock_unlock(file, line, func, &holder->lock, name);
726
727         return obj_old;
728 }
729
730 int __ao2_global_obj_replace_unref(struct ao2_global_obj *holder, void *obj, const char *tag, const char *file, int line, const char *func, const char *name)
731 {
732         void *obj_old;
733
734         obj_old = __ao2_global_obj_replace(holder, obj, tag, file, line, func, name);
735         if (obj_old) {
736                 if (tag) {
737                         __ao2_ref_debug(obj_old, -1, tag, file, line, func);
738                 } else {
739                         __ao2_ref(obj_old, -1);
740                 }
741                 return 1;
742         }
743         return 0;
744 }
745
746 void *__ao2_global_obj_ref(struct ao2_global_obj *holder, const char *tag, const char *file, int line, const char *func, const char *name)
747 {
748         void *obj;
749
750         if (!holder) {
751                 /* For sanity */
752                 ast_log(LOG_ERROR, "Must be called with a global object!\n");
753                 ast_assert(0);
754                 return NULL;
755         }
756
757         if (__ast_rwlock_rdlock(file, line, func, &holder->lock, name)) {
758                 /* Could not get the read lock. */
759                 ast_assert(0);
760                 return NULL;
761         }
762
763         obj = holder->obj;
764         if (obj) {
765                 if (tag) {
766                         __ao2_ref_debug(obj, +1, tag, file, line, func);
767                 } else {
768                         __ao2_ref(obj, +1);
769                 }
770         }
771
772         __ast_rwlock_unlock(file, line, func, &holder->lock, name);
773
774         return obj;
775 }
776
777 enum ao2_callback_type {
778         AO2_CALLBACK_DEFAULT,
779         AO2_CALLBACK_WITH_DATA,
780 };
781
782 enum ao2_container_insert {
783         /*! The node was inserted into the container. */
784         AO2_CONTAINER_INSERT_NODE_INSERTED,
785         /*! The node object replaced an existing node object. */
786         AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED,
787         /*! The node was rejected (duplicate). */
788         AO2_CONTAINER_INSERT_NODE_REJECTED,
789 };
790
791 enum ao2_container_rtti {
792         /*! This is a hash container */
793         AO2_CONTAINER_RTTI_HASH,
794         /*! This is a red-black tree container */
795         AO2_CONTAINER_RTTI_RBTREE,
796 };
797
798 /*!
799  * \brief Generic container node.
800  *
801  * \details This is the base container node type that contains
802  * values common to all container nodes.
803  */
804 struct ao2_container_node {
805         /*! Stored object in node. */
806         void *obj;
807         /*! Container holding the node.  (Does not hold a reference.) */
808         struct ao2_container *my_container;
809         /*! TRUE if the node is linked into the container. */
810         unsigned int is_linked:1;
811 };
812
813 /*!
814  * \brief Destroy this container.
815  *
816  * \param self Container to operate upon.
817  *
818  * \return Nothing
819  */
820 typedef void (*ao2_container_destroy_fn)(struct ao2_container *self);
821
822 /*!
823  * \brief Create an empty copy of this container.
824  *
825  * \param self Container to operate upon.
826  *
827  * \retval empty-container on success.
828  * \retval NULL on error.
829  */
830 typedef struct ao2_container *(*ao2_container_alloc_empty_clone_fn)(struct ao2_container *self);
831
832 /*!
833  * \brief Create an empty copy of this container. (Debug version)
834  *
835  * \param self Container to operate upon.
836  * \param tag used for debugging.
837  * \param file Debug file name invoked from
838  * \param line Debug line invoked from
839  * \param func Debug function name invoked from
840  * \param ref_debug TRUE if to output a debug reference message.
841  *
842  * \retval empty-container on success.
843  * \retval NULL on error.
844  */
845 typedef struct ao2_container *(*ao2_container_alloc_empty_clone_debug_fn)(struct ao2_container *self, const char *tag, const char *file, int line, const char *func, int ref_debug);
846
847 /*!
848  * \brief Create a new container node.
849  *
850  * \param self Container to operate upon.
851  * \param obj_new Object to put into the node.
852  * \param tag used for debugging.
853  * \param file Debug file name invoked from
854  * \param line Debug line invoked from
855  * \param func Debug function name invoked from
856  *
857  * \retval initialized-node on success.
858  * \retval NULL on error.
859  */
860 typedef struct ao2_container_node *(*ao2_container_new_node_fn)(struct ao2_container *self, void *obj_new, const char *tag, const char *file, int line, const char *func);
861
862 /*!
863  * \brief Insert a node into this container.
864  *
865  * \param self Container to operate upon.
866  * \param node Container node to insert into the container.
867  *
868  * \return enum ao2_container_insert value.
869  */
870 typedef enum ao2_container_insert (*ao2_container_insert_fn)(struct ao2_container *self, struct ao2_container_node *node);
871
872 /*!
873  * \brief Find the first container node in a traversal.
874  *
875  * \param self Container to operate upon.
876  * \param flags search_flags to control traversing the container
877  * \param arg Comparison callback arg parameter.
878  * \param v_state Traversal state to restart container traversal.
879  *
880  * \retval node-ptr of found node (Reffed).
881  * \retval NULL when no node found.
882  */
883 typedef struct ao2_container_node *(*ao2_container_find_first_fn)(struct ao2_container *self, enum search_flags flags, void *arg, void *v_state);
884
885 /*!
886  * \brief Find the next container node in a traversal.
887  *
888  * \param self Container to operate upon.
889  * \param v_state Traversal state to restart container traversal.
890  * \param prev Previous node returned by the traversal search functions.
891  *    The ref ownership is passed back to this function.
892  *
893  * \retval node-ptr of found node (Reffed).
894  * \retval NULL when no node found.
895  */
896 typedef struct ao2_container_node *(*ao2_container_find_next_fn)(struct ao2_container *self, void *v_state, struct ao2_container_node *prev);
897
898 /*!
899  * \brief Cleanup the container traversal state.
900  *
901  * \param v_state Traversal state to cleanup.
902  *
903  * \return Nothing
904  */
905 typedef void (*ao2_container_find_cleanup_fn)(void *v_state);
906
907 /*!
908  * \brief Find the next non-empty iteration node in the container.
909  *
910  * \param self Container to operate upon.
911  * \param prev Previous node returned by the iterator.
912  * \param flags search_flags to control iterating the container.
913  *   Only AO2_ITERATOR_DESCENDING is useful by the method.
914  *
915  * \note The container is already locked.
916  *
917  * \retval node on success.
918  * \retval NULL on error or no more nodes in the container.
919  */
920 typedef struct ao2_container_node *(*ao2_iterator_next_fn)(struct ao2_container *self, struct ao2_container_node *prev, enum ao2_iterator_flags flags);
921
922 /*!
923  * \brief Display contents of the specified container.
924  *
925  * \param self Container to dump.
926  * \param where User data needed by prnt to determine where to put output.
927  * \param prnt Print output callback function to use.
928  * \param prnt_obj Callback function to print the given object's key. (NULL if not available)
929  *
930  * \return Nothing
931  */
932 typedef void (*ao2_container_display)(struct ao2_container *self, void *where, ao2_prnt_fn *prnt, ao2_prnt_obj_fn *prnt_obj);
933
934 /*!
935  * \brief Display statistics of the specified container.
936  *
937  * \param self Container to display statistics.
938  * \param where User data needed by prnt to determine where to put output.
939  * \param prnt Print output callback function to use.
940  *
941  * \note The container is already locked for reading.
942  *
943  * \return Nothing
944  */
945 typedef void (*ao2_container_statistics)(struct ao2_container *self, void *where, ao2_prnt_fn *prnt);
946
947 /*!
948  * \brief Perform an integrity check on the specified container.
949  *
950  * \param self Container to check integrity.
951  *
952  * \note The container is already locked for reading.
953  *
954  * \retval 0 on success.
955  * \retval -1 on error.
956  */
957 typedef int (*ao2_container_integrity)(struct ao2_container *self);
958
959 /*! Container virtual methods template. */
960 struct ao2_container_methods {
961         /*! Run Time Type Identification */
962         enum ao2_container_rtti type;
963         /*! Destroy this container. */
964         ao2_container_destroy_fn destroy;
965         /*! \brief Create an empty copy of this container. */
966         ao2_container_alloc_empty_clone_fn alloc_empty_clone;
967         /*! \brief Create an empty copy of this container. (Debug version) */
968         ao2_container_alloc_empty_clone_debug_fn alloc_empty_clone_debug;
969         /*! Create a new container node. */
970         ao2_container_new_node_fn new_node;
971         /*! Insert a node into this container. */
972         ao2_container_insert_fn insert;
973         /*! Traverse the container, find the first node. */
974         ao2_container_find_first_fn traverse_first;
975         /*! Traverse the container, find the next node. */
976         ao2_container_find_next_fn traverse_next;
977         /*! Traverse the container, cleanup state. */
978         ao2_container_find_cleanup_fn traverse_cleanup;
979         /*! Find the next iteration element in the container. */
980         ao2_iterator_next_fn iterator_next;
981 #if defined(AST_DEVMODE)
982         /*! Display container contents. (Method for debug purposes) */
983         ao2_container_display dump;
984         /*! Display container debug statistics. (Method for debug purposes) */
985         ao2_container_statistics stats;
986         /*! Perform an integrity check on the container. (Method for debug purposes) */
987         ao2_container_integrity integrity;
988 #endif  /* defined(AST_DEVMODE) */
989 };
990
991 /*!
992  * \brief Generic container type.
993  *
994  * \details This is the base container type that contains values
995  * common to all container types.
996  *
997  * \todo Linking and unlinking container objects is typically
998  * expensive, as it involves a malloc()/free() of a small object
999  * which is very inefficient.  To optimize this, we can allocate
1000  * larger arrays of container nodes when we run out of them, and
1001  * then manage our own freelist.  This will be more efficient as
1002  * we can do the freelist management while we hold the lock
1003  * (that we need anyway).
1004  */
1005 struct ao2_container {
1006         /*! Container virtual method table. */
1007         const struct ao2_container_methods *v_table;
1008         /*! Container sort function if the container is sorted. */
1009         ao2_sort_fn *sort_fn;
1010         /*! Container traversal matching function for ao2_find. */
1011         ao2_callback_fn *cmp_fn;
1012         /*! The container option flags */
1013         uint32_t options;
1014         /*! Number of elements in the container. */
1015         int elements;
1016 #if defined(AST_DEVMODE)
1017         /*! Number of nodes in the container. */
1018         int nodes;
1019         /*! Maximum number of empty nodes in the container. (nodes - elements) */
1020         int max_empty_nodes;
1021 #endif  /* defined(AST_DEVMODE) */
1022         /*!
1023          * \brief TRUE if the container is being destroyed.
1024          *
1025          * \note The destruction traversal should override any requested
1026          * search order to do the most efficient order for destruction.
1027          *
1028          * \note There should not be any empty nodes in the container
1029          * during destruction.  If there are then an error needs to be
1030          * issued about container node reference leaks.
1031          */
1032         unsigned int destroying:1;
1033 };
1034
1035 /*!
1036  * return the number of elements in the container
1037  */
1038 int ao2_container_count(struct ao2_container *c)
1039 {
1040         return ast_atomic_fetchadd_int(&c->elements, 0);
1041 }
1042
1043 #if defined(AST_DEVMODE)
1044 static void hash_ao2_link_node_stat(struct ao2_container *hash, struct ao2_container_node *hash_node);
1045 static void hash_ao2_unlink_node_stat(struct ao2_container *hash, struct ao2_container_node *hash_node);
1046 #endif  /* defined(AST_DEVMODE) */
1047
1048 /*!
1049  * \internal
1050  * \brief Link an object into this container.  (internal)
1051  *
1052  * \param self Container to operate upon.
1053  * \param obj_new Object to insert into the container.
1054  * \param flags search_flags to control linking the object.  (OBJ_NOLOCK)
1055  * \param tag used for debugging.
1056  * \param file Debug file name invoked from
1057  * \param line Debug line invoked from
1058  * \param func Debug function name invoked from
1059  *
1060  * \retval 0 on errors.
1061  * \retval 1 on success.
1062  */
1063 static int internal_ao2_link(struct ao2_container *self, void *obj_new, int flags, const char *tag, const char *file, int line, const char *func)
1064 {
1065         int res;
1066         enum ao2_lock_req orig_lock;
1067         struct ao2_container_node *node;
1068
1069         if (!INTERNAL_OBJ(obj_new) || !INTERNAL_OBJ(self)
1070                 || !self->v_table || !self->v_table->new_node || !self->v_table->insert) {
1071                 /* Sanity checks. */
1072                 ast_assert(0);
1073                 return 0;
1074         }
1075
1076         if (flags & OBJ_NOLOCK) {
1077                 orig_lock = adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
1078         } else {
1079                 ao2_wrlock(self);
1080                 orig_lock = AO2_LOCK_REQ_MUTEX;
1081         }
1082
1083         res = 0;
1084         node = self->v_table->new_node(self, obj_new, tag, file, line, func);
1085         if (node) {
1086 #if defined(AO2_DEBUG) && defined(AST_DEVMODE)
1087                 switch (self->v_table->type) {
1088                 case AO2_CONTAINER_RTTI_HASH:
1089                         if (!self->sort_fn) {
1090                                 /*
1091                                  * XXX chan_iax2 plays games with the hash function so we cannot
1092                                  * routinely do an integrity check on this type of container.
1093                                  * chan_iax2 should be changed to not abuse the hash function.
1094                                  */
1095                                 break;
1096                         }
1097                         /* Fall through. */
1098                 case AO2_CONTAINER_RTTI_RBTREE:
1099                         if (ao2_container_check(self, OBJ_NOLOCK)) {
1100                                 ast_log(LOG_ERROR, "Container integrity failed before insert.\n");
1101                         }
1102                         break;
1103                 }
1104 #endif  /* defined(AO2_DEBUG) && defined(AST_DEVMODE) */
1105                 /* Insert the new node. */
1106                 switch (self->v_table->insert(self, node)) {
1107                 case AO2_CONTAINER_INSERT_NODE_INSERTED:
1108                         node->is_linked = 1;
1109                         ast_atomic_fetchadd_int(&self->elements, 1);
1110 #if defined(AST_DEVMODE)
1111                         AO2_DEVMODE_STAT(++self->nodes);
1112                         switch (self->v_table->type) {
1113                         case AO2_CONTAINER_RTTI_HASH:
1114                                 hash_ao2_link_node_stat(self, node);
1115                                 break;
1116                         case AO2_CONTAINER_RTTI_RBTREE:
1117                                 break;
1118                         }
1119 #endif  /* defined(AST_DEVMODE) */
1120
1121                         res = 1;
1122                         break;
1123                 case AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED:
1124                         res = 1;
1125                         /* Fall through */
1126                 case AO2_CONTAINER_INSERT_NODE_REJECTED:
1127                         __ao2_ref(node, -1);
1128                         break;
1129                 }
1130 #if defined(AO2_DEBUG) && defined(AST_DEVMODE)
1131                 if (res) {
1132                         switch (self->v_table->type) {
1133                         case AO2_CONTAINER_RTTI_HASH:
1134                                 if (!self->sort_fn) {
1135                                         /*
1136                                          * XXX chan_iax2 plays games with the hash function so we cannot
1137                                          * routinely do an integrity check on this type of container.
1138                                          * chan_iax2 should be changed to not abuse the hash function.
1139                                          */
1140                                         break;
1141                                 }
1142                                 /* Fall through. */
1143                         case AO2_CONTAINER_RTTI_RBTREE:
1144                                 if (ao2_container_check(self, OBJ_NOLOCK)) {
1145                                         ast_log(LOG_ERROR, "Container integrity failed after insert.\n");
1146                                 }
1147                                 break;
1148                         }
1149                 }
1150 #endif  /* defined(AO2_DEBUG) && defined(AST_DEVMODE) */
1151         }
1152
1153         if (flags & OBJ_NOLOCK) {
1154                 adjust_lock(self, orig_lock, 0);
1155         } else {
1156                 ao2_unlock(self);
1157         }
1158
1159         return res;
1160 }
1161
1162 int __ao2_link_debug(struct ao2_container *c, void *obj_new, int flags, const char *tag, const char *file, int line, const char *func)
1163 {
1164         return internal_ao2_link(c, obj_new, flags, tag, file, line, func);
1165 }
1166
1167 int __ao2_link(struct ao2_container *c, void *obj_new, int flags)
1168 {
1169         return internal_ao2_link(c, obj_new, flags, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__);
1170 }
1171
1172 /*!
1173  * \brief another convenience function is a callback that matches on address
1174  */
1175 int ao2_match_by_addr(void *user_data, void *arg, int flags)
1176 {
1177         return (user_data == arg) ? (CMP_MATCH | CMP_STOP) : 0;
1178 }
1179
1180 /*
1181  * Unlink an object from the container
1182  * and destroy the associated * bucket_entry structure.
1183  */
1184 void *__ao2_unlink_debug(struct ao2_container *c, void *user_data, int flags,
1185         const char *tag, const char *file, int line, const char *func)
1186 {
1187         if (!INTERNAL_OBJ(user_data)) {
1188                 /* Sanity checks. */
1189                 ast_assert(0);
1190                 return NULL;
1191         }
1192
1193         flags &= ~OBJ_SEARCH_MASK;
1194         flags |= (OBJ_UNLINK | OBJ_SEARCH_OBJECT | OBJ_NODATA);
1195         __ao2_callback_debug(c, flags, ao2_match_by_addr, user_data, tag, file, line, func);
1196
1197         return NULL;
1198 }
1199
1200 void *__ao2_unlink(struct ao2_container *c, void *user_data, int flags)
1201 {
1202         if (!INTERNAL_OBJ(user_data)) {
1203                 /* Sanity checks. */
1204                 ast_assert(0);
1205                 return NULL;
1206         }
1207
1208         flags &= ~OBJ_SEARCH_MASK;
1209         flags |= (OBJ_UNLINK | OBJ_SEARCH_OBJECT | OBJ_NODATA);
1210         __ao2_callback(c, flags, ao2_match_by_addr, user_data);
1211
1212         return NULL;
1213 }
1214
1215 /*!
1216  * \brief special callback that matches all
1217  */
1218 static int cb_true(void *user_data, void *arg, int flags)
1219 {
1220         return CMP_MATCH;
1221 }
1222
1223 /*!
1224  * \brief similar to cb_true, but is an ao2_callback_data_fn instead
1225  */
1226 static int cb_true_data(void *user_data, void *arg, void *data, int flags)
1227 {
1228         return CMP_MATCH;
1229 }
1230
1231 /*! Allow enough room for container specific traversal state structs */
1232 #define AO2_TRAVERSAL_STATE_SIZE        100
1233
1234 /*!
1235  * \internal
1236  * \brief Traverse the container.  (internal)
1237  *
1238  * \param self Container to operate upon.
1239  * \param flags search_flags to control traversing the container
1240  * \param cb_fn Comparison callback function.
1241  * \param arg Comparison callback arg parameter.
1242  * \param data Data comparison callback data parameter.
1243  * \param type Type of comparison callback cb_fn.
1244  * \param tag used for debugging.
1245  * \param file Debug file name invoked from
1246  * \param line Debug line invoked from
1247  * \param func Debug function name invoked from
1248  *
1249  * \retval NULL on failure or no matching object found.
1250  *
1251  * \retval object found if OBJ_MULTIPLE is not set in the flags
1252  * parameter.
1253  *
1254  * \retval ao2_iterator pointer if OBJ_MULTIPLE is set in the
1255  * flags parameter.  The iterator must be destroyed with
1256  * ao2_iterator_destroy() when the caller no longer needs it.
1257  */
1258 static void *internal_ao2_traverse(struct ao2_container *self, enum search_flags flags,
1259         void *cb_fn, void *arg, void *data, enum ao2_callback_type type,
1260         const char *tag, const char *file, int line, const char *func)
1261 {
1262         void *ret;
1263         ao2_callback_fn *cb_default = NULL;
1264         ao2_callback_data_fn *cb_withdata = NULL;
1265         struct ao2_container_node *node;
1266         void *traversal_state;
1267
1268         enum ao2_lock_req orig_lock;
1269         struct ao2_container *multi_container = NULL;
1270         struct ao2_iterator *multi_iterator = NULL;
1271
1272         if (!INTERNAL_OBJ(self) || !self->v_table || !self->v_table->traverse_first
1273                 || !self->v_table->traverse_next) {
1274                 /* Sanity checks. */
1275                 ast_assert(0);
1276                 return NULL;
1277         }
1278
1279         /*
1280          * This logic is used so we can support OBJ_MULTIPLE with OBJ_NODATA
1281          * turned off.  This if statement checks for the special condition
1282          * where multiple items may need to be returned.
1283          */
1284         if ((flags & (OBJ_MULTIPLE | OBJ_NODATA)) == OBJ_MULTIPLE) {
1285                 /* we need to return an ao2_iterator with the results,
1286                  * as there could be more than one. the iterator will
1287                  * hold the only reference to a container that has all the
1288                  * matching objects linked into it, so when the iterator
1289                  * is destroyed, the container will be automatically
1290                  * destroyed as well.
1291                  */
1292                 multi_container = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL,
1293                         NULL, "OBJ_MULTIPLE return container creation");
1294                 if (!multi_container) {
1295                         return NULL;
1296                 }
1297                 if (!(multi_iterator = ast_calloc(1, sizeof(*multi_iterator)))) {
1298                         ao2_t_ref(multi_container, -1, "OBJ_MULTIPLE interator creation failed.");
1299                         return NULL;
1300                 }
1301         }
1302
1303         if (!cb_fn) {
1304                 /* Match everything if no callback match function provided. */
1305                 if (type == AO2_CALLBACK_WITH_DATA) {
1306                         cb_withdata = cb_true_data;
1307                 } else {
1308                         cb_default = cb_true;
1309                 }
1310         } else {
1311                 /*
1312                  * We do this here to avoid the per object casting penalty (even
1313                  * though that is probably optimized away anyway).
1314                  */
1315                 if (type == AO2_CALLBACK_WITH_DATA) {
1316                         cb_withdata = cb_fn;
1317                 } else {
1318                         cb_default = cb_fn;
1319                 }
1320         }
1321
1322         /* avoid modifications to the content */
1323         if (flags & OBJ_NOLOCK) {
1324                 if (flags & OBJ_UNLINK) {
1325                         orig_lock = adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
1326                 } else {
1327                         orig_lock = adjust_lock(self, AO2_LOCK_REQ_RDLOCK, 1);
1328                 }
1329         } else {
1330                 orig_lock = AO2_LOCK_REQ_MUTEX;
1331                 if (flags & OBJ_UNLINK) {
1332                         ao2_wrlock(self);
1333                 } else {
1334                         ao2_rdlock(self);
1335                 }
1336         }
1337
1338         /* Create a buffer for the traversal state. */
1339         traversal_state = alloca(AO2_TRAVERSAL_STATE_SIZE);
1340
1341         ret = NULL;
1342         for (node = self->v_table->traverse_first(self, flags, arg, traversal_state);
1343                 node;
1344                 node = self->v_table->traverse_next(self, traversal_state, node)) {
1345                 int match;
1346
1347                 /* Visit the current node. */
1348                 match = (CMP_MATCH | CMP_STOP);
1349                 if (type == AO2_CALLBACK_WITH_DATA) {
1350                         match &= cb_withdata(node->obj, arg, data, flags);
1351                 } else {
1352                         match &= cb_default(node->obj, arg, flags);
1353                 }
1354                 if (match == 0) {
1355                         /* no match, no stop, continue */
1356                         continue;
1357                 }
1358                 if (match == CMP_STOP) {
1359                         /* no match but stop, we are done */
1360                         break;
1361                 }
1362
1363                 /*
1364                  * CMP_MATCH is set here
1365                  *
1366                  * we found the object, performing operations according to flags
1367                  */
1368                 if (node->obj) {
1369                         /* The object is still in the container. */
1370                         if (!(flags & OBJ_NODATA)) {
1371                                 /*
1372                                  * We are returning the object, record the value.  It is
1373                                  * important to handle this case before the unlink.
1374                                  */
1375                                 if (multi_container) {
1376                                         /*
1377                                          * Link the object into the container that will hold the
1378                                          * results.
1379                                          */
1380                                         if (tag) {
1381                                                 __ao2_link_debug(multi_container, node->obj, flags,
1382                                                         tag, file, line, func);
1383                                         } else {
1384                                                 __ao2_link(multi_container, node->obj, flags);
1385                                         }
1386                                 } else {
1387                                         ret = node->obj;
1388                                         /* Returning a single object. */
1389                                         if (!(flags & OBJ_UNLINK)) {
1390                                                 /*
1391                                                  * Bump the ref count since we are not going to unlink and
1392                                                  * transfer the container's object ref to the returned object.
1393                                                  */
1394                                                 if (tag) {
1395                                                         __ao2_ref_debug(ret, 1, tag, file, line, func);
1396                                                 } else {
1397                                                         ao2_t_ref(ret, 1, "Traversal found object");
1398                                                 }
1399                                         }
1400                                 }
1401                         }
1402
1403                         if (flags & OBJ_UNLINK) {
1404                                 /* update number of elements */
1405                                 ast_atomic_fetchadd_int(&self->elements, -1);
1406 #if defined(AST_DEVMODE)
1407                                 {
1408                                         int empty = self->nodes - self->elements;
1409
1410                                         if (self->max_empty_nodes < empty) {
1411                                                 self->max_empty_nodes = empty;
1412                                         }
1413                                 }
1414                                 switch (self->v_table->type) {
1415                                 case AO2_CONTAINER_RTTI_HASH:
1416                                         hash_ao2_unlink_node_stat(self, node);
1417                                         break;
1418                                 case AO2_CONTAINER_RTTI_RBTREE:
1419                                         break;
1420                                 }
1421 #endif  /* defined(AST_DEVMODE) */
1422
1423                                 /*
1424                                  * - When unlinking and not returning the result, OBJ_NODATA is
1425                                  * set, the ref from the container must be decremented.
1426                                  *
1427                                  * - When unlinking with a multi_container the ref from the
1428                                  * original container must be decremented.  This is because the
1429                                  * result is returned in a new container that already holds its
1430                                  * own ref for the object.
1431                                  *
1432                                  * If the ref from the original container is not accounted for
1433                                  * here a memory leak occurs.
1434                                  */
1435                                 if (multi_container || (flags & OBJ_NODATA)) {
1436                                         if (tag) {
1437                                                 __ao2_ref_debug(node->obj, -1, tag, file, line, func);
1438                                         } else {
1439                                                 ao2_t_ref(node->obj, -1, "Unlink container obj reference.");
1440                                         }
1441                                 }
1442                                 node->obj = NULL;
1443
1444                                 /* Unref the node from the container. */
1445                                 __ao2_ref(node, -1);
1446                         }
1447                 }
1448
1449                 if ((match & CMP_STOP) || !(flags & OBJ_MULTIPLE)) {
1450                         /* We found our only (or last) match, so we are done */
1451                         break;
1452                 }
1453         }
1454         if (self->v_table->traverse_cleanup) {
1455                 self->v_table->traverse_cleanup(traversal_state);
1456         }
1457         if (node) {
1458                 /* Unref the node from self->v_table->traverse_first/traverse_next() */
1459                 __ao2_ref(node, -1);
1460         }
1461
1462         if (flags & OBJ_NOLOCK) {
1463                 adjust_lock(self, orig_lock, 0);
1464         } else {
1465                 ao2_unlock(self);
1466         }
1467
1468         /* if multi_container was created, we are returning multiple objects */
1469         if (multi_container) {
1470                 *multi_iterator = ao2_iterator_init(multi_container,
1471                         AO2_ITERATOR_UNLINK | AO2_ITERATOR_MALLOCD);
1472                 ao2_t_ref(multi_container, -1,
1473                         "OBJ_MULTIPLE for multiple objects traversal complete.");
1474                 return multi_iterator;
1475         } else {
1476                 return ret;
1477         }
1478 }
1479
1480 void *__ao2_callback_debug(struct ao2_container *c, enum search_flags flags,
1481         ao2_callback_fn *cb_fn, void *arg, const char *tag, const char *file, int line,
1482         const char *func)
1483 {
1484         return internal_ao2_traverse(c, flags, cb_fn, arg, NULL, AO2_CALLBACK_DEFAULT, tag, file, line, func);
1485 }
1486
1487 void *__ao2_callback(struct ao2_container *c, enum search_flags flags,
1488         ao2_callback_fn *cb_fn, void *arg)
1489 {
1490         return internal_ao2_traverse(c, flags, cb_fn, arg, NULL, AO2_CALLBACK_DEFAULT, NULL, NULL, 0, NULL);
1491 }
1492
1493 void *__ao2_callback_data_debug(struct ao2_container *c, enum search_flags flags,
1494         ao2_callback_data_fn *cb_fn, void *arg, void *data, const char *tag, const char *file,
1495         int line, const char *func)
1496 {
1497         return internal_ao2_traverse(c, flags, cb_fn, arg, data, AO2_CALLBACK_WITH_DATA, tag, file, line, func);
1498 }
1499
1500 void *__ao2_callback_data(struct ao2_container *c, enum search_flags flags,
1501         ao2_callback_data_fn *cb_fn, void *arg, void *data)
1502 {
1503         return internal_ao2_traverse(c, flags, cb_fn, arg, data, AO2_CALLBACK_WITH_DATA, NULL, NULL, 0, NULL);
1504 }
1505
1506 /*!
1507  * the find function just invokes the default callback with some reasonable flags.
1508  */
1509 void *__ao2_find_debug(struct ao2_container *c, const void *arg, enum search_flags flags,
1510         const char *tag, const char *file, int line, const char *func)
1511 {
1512         void *arged = (void *) arg;/* Done to avoid compiler const warning */
1513
1514         if (!c) {
1515                 /* Sanity checks. */
1516                 ast_assert(0);
1517                 return NULL;
1518         }
1519         return __ao2_callback_debug(c, flags, c->cmp_fn, arged, tag, file, line, func);
1520 }
1521
1522 void *__ao2_find(struct ao2_container *c, const void *arg, enum search_flags flags)
1523 {
1524         void *arged = (void *) arg;/* Done to avoid compiler const warning */
1525
1526         if (!c) {
1527                 /* Sanity checks. */
1528                 ast_assert(0);
1529                 return NULL;
1530         }
1531         return __ao2_callback(c, flags, c->cmp_fn, arged);
1532 }
1533
1534 /*!
1535  * initialize an iterator so we start from the first object
1536  */
1537 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags)
1538 {
1539         struct ao2_iterator a = {
1540                 .c = c,
1541                 .flags = flags
1542         };
1543
1544         ao2_t_ref(c, +1, "Init iterator with container.");
1545
1546         return a;
1547 }
1548
1549 void ao2_iterator_restart(struct ao2_iterator *iter)
1550 {
1551         /* Release the last container node reference if we have one. */
1552         if (iter->last_node) {
1553                 enum ao2_lock_req orig_lock;
1554
1555                 /*
1556                  * Do a read lock in case the container node unref does not
1557                  * destroy the node.  If the container node is destroyed then
1558                  * the lock will be upgraded to a write lock.
1559                  */
1560                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
1561                         orig_lock = adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
1562                 } else {
1563                         orig_lock = AO2_LOCK_REQ_MUTEX;
1564                         ao2_rdlock(iter->c);
1565                 }
1566
1567                 __ao2_ref(iter->last_node, -1);
1568                 iter->last_node = NULL;
1569
1570                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
1571                         adjust_lock(iter->c, orig_lock, 0);
1572                 } else {
1573                         ao2_unlock(iter->c);
1574                 }
1575         }
1576
1577         /* The iteration is no longer complete. */
1578         iter->complete = 0;
1579 }
1580
1581 void ao2_iterator_destroy(struct ao2_iterator *iter)
1582 {
1583         /* Release any last container node reference. */
1584         ao2_iterator_restart(iter);
1585
1586         /* Release the iterated container reference. */
1587         ao2_t_ref(iter->c, -1, "Unref iterator in ao2_iterator_destroy");
1588         iter->c = NULL;
1589
1590         /* Free the malloced iterator. */
1591         if (iter->flags & AO2_ITERATOR_MALLOCD) {
1592                 ast_free(iter);
1593         }
1594 }
1595
1596 void ao2_iterator_cleanup(struct ao2_iterator *iter)
1597 {
1598         if (iter) {
1599                 ao2_iterator_destroy(iter);
1600         }
1601 }
1602
1603 /*
1604  * move to the next element in the container.
1605  */
1606 static void *internal_ao2_iterator_next(struct ao2_iterator *iter, const char *tag, const char *file, int line, const char *func)
1607 {
1608         enum ao2_lock_req orig_lock;
1609         struct ao2_container_node *node;
1610         void *ret;
1611
1612         if (!INTERNAL_OBJ(iter->c) || !iter->c->v_table || !iter->c->v_table->iterator_next) {
1613                 /* Sanity checks. */
1614                 ast_assert(0);
1615                 return NULL;
1616         }
1617
1618         if (iter->complete) {
1619                 /* Don't return any more objects. */
1620                 return NULL;
1621         }
1622
1623         if (iter->flags & AO2_ITERATOR_DONTLOCK) {
1624                 if (iter->flags & AO2_ITERATOR_UNLINK) {
1625                         orig_lock = adjust_lock(iter->c, AO2_LOCK_REQ_WRLOCK, 1);
1626                 } else {
1627                         orig_lock = adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
1628                 }
1629         } else {
1630                 orig_lock = AO2_LOCK_REQ_MUTEX;
1631                 if (iter->flags & AO2_ITERATOR_UNLINK) {
1632                         ao2_wrlock(iter->c);
1633                 } else {
1634                         ao2_rdlock(iter->c);
1635                 }
1636         }
1637
1638         node = iter->c->v_table->iterator_next(iter->c, iter->last_node, iter->flags);
1639         if (node) {
1640                 ret = node->obj;
1641
1642                 if (iter->flags & AO2_ITERATOR_UNLINK) {
1643                         /* update number of elements */
1644                         ast_atomic_fetchadd_int(&iter->c->elements, -1);
1645 #if defined(AST_DEVMODE)
1646                         {
1647                                 int empty = iter->c->nodes - iter->c->elements;
1648
1649                                 if (iter->c->max_empty_nodes < empty) {
1650                                         iter->c->max_empty_nodes = empty;
1651                                 }
1652                         }
1653                         switch (iter->c->v_table->type) {
1654                         case AO2_CONTAINER_RTTI_HASH:
1655                                 hash_ao2_unlink_node_stat(iter->c, node);
1656                                 break;
1657                         case AO2_CONTAINER_RTTI_RBTREE:
1658                                 break;
1659                         }
1660 #endif  /* defined(AST_DEVMODE) */
1661
1662                         /* Transfer the object ref from the container to the returned object. */
1663                         node->obj = NULL;
1664
1665                         /* Transfer the container's node ref to the iterator. */
1666                 } else {
1667                         /* Bump ref of returned object */
1668                         if (tag) {
1669                                 __ao2_ref_debug(ret, +1, tag, file, line, func);
1670                         } else {
1671                                 ao2_t_ref(ret, +1, "Next iterator object.");
1672                         }
1673
1674                         /* Bump the container's node ref for the iterator. */
1675                         __ao2_ref(node, +1);
1676                 }
1677         } else {
1678                 /* The iteration has completed. */
1679                 iter->complete = 1;
1680                 ret = NULL;
1681         }
1682
1683         /* Replace the iterator's node */
1684         if (iter->last_node) {
1685                 __ao2_ref(iter->last_node, -1);
1686         }
1687         iter->last_node = node;
1688
1689         if (iter->flags & AO2_ITERATOR_DONTLOCK) {
1690                 adjust_lock(iter->c, orig_lock, 0);
1691         } else {
1692                 ao2_unlock(iter->c);
1693         }
1694
1695         return ret;
1696 }
1697
1698 void *__ao2_iterator_next_debug(struct ao2_iterator *iter, const char *tag, const char *file, int line, const char *func)
1699 {
1700         return internal_ao2_iterator_next(iter, tag, file, line, func);
1701 }
1702
1703 void *__ao2_iterator_next(struct ao2_iterator *iter)
1704 {
1705         return internal_ao2_iterator_next(iter, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__);
1706 }
1707
1708 static void container_destruct(void *_c)
1709 {
1710         struct ao2_container *c = _c;
1711
1712         /* Unlink any stored objects in the container. */
1713         c->destroying = 1;
1714         __ao2_callback(c, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
1715
1716         /* Perform any extra container cleanup. */
1717         if (c->v_table && c->v_table->destroy) {
1718                 c->v_table->destroy(c);
1719         }
1720
1721 #ifdef AO2_DEBUG
1722         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
1723 #endif
1724 }
1725
1726 static void container_destruct_debug(void *_c)
1727 {
1728         struct ao2_container *c = _c;
1729
1730         /* Unlink any stored objects in the container. */
1731         c->destroying = 1;
1732         __ao2_callback_debug(c, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL,
1733                 "container_destruct_debug called", __FILE__, __LINE__, __PRETTY_FUNCTION__);
1734
1735         /* Perform any extra container cleanup. */
1736         if (c->v_table && c->v_table->destroy) {
1737                 c->v_table->destroy(c);
1738         }
1739
1740 #ifdef AO2_DEBUG
1741         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
1742 #endif
1743 }
1744
1745 /*!
1746  * \internal
1747  * \brief Put obj into the arg container.
1748  * \since 11.0
1749  *
1750  * \param obj  pointer to the (user-defined part) of an object.
1751  * \param arg callback argument from ao2_callback()
1752  * \param flags flags from ao2_callback()
1753  *
1754  * \retval 0 on success.
1755  * \retval CMP_STOP|CMP_MATCH on error.
1756  */
1757 static int dup_obj_cb(void *obj, void *arg, int flags)
1758 {
1759         struct ao2_container *dest = arg;
1760
1761         return __ao2_link(dest, obj, OBJ_NOLOCK) ? 0 : (CMP_MATCH | CMP_STOP);
1762 }
1763
1764 int ao2_container_dup(struct ao2_container *dest, struct ao2_container *src, enum search_flags flags)
1765 {
1766         void *obj;
1767         int res = 0;
1768
1769         if (!(flags & OBJ_NOLOCK)) {
1770                 ao2_rdlock(src);
1771                 ao2_wrlock(dest);
1772         }
1773         obj = __ao2_callback(src, OBJ_NOLOCK, dup_obj_cb, dest);
1774         if (obj) {
1775                 /* Failed to put this obj into the dest container. */
1776                 ao2_t_ref(obj, -1, "Failed to put this object into the dest container.");
1777
1778                 /* Remove all items from the dest container. */
1779                 __ao2_callback(dest, OBJ_NOLOCK | OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL,
1780                         NULL);
1781                 res = -1;
1782         }
1783         if (!(flags & OBJ_NOLOCK)) {
1784                 ao2_unlock(dest);
1785                 ao2_unlock(src);
1786         }
1787
1788         return res;
1789 }
1790
1791 struct ao2_container *__ao2_container_clone(struct ao2_container *orig, enum search_flags flags)
1792 {
1793         struct ao2_container *clone;
1794         int failed;
1795
1796         /* Create the clone container with the same properties as the original. */
1797         if (!INTERNAL_OBJ(orig) || !orig->v_table || !orig->v_table->alloc_empty_clone) {
1798                 /* Sanity checks. */
1799                 ast_assert(0);
1800                 return NULL;
1801         }
1802         clone = orig->v_table->alloc_empty_clone(orig);
1803         if (!clone) {
1804                 return NULL;
1805         }
1806
1807         if (flags & OBJ_NOLOCK) {
1808                 ao2_wrlock(clone);
1809         }
1810         failed = ao2_container_dup(clone, orig, flags);
1811         if (flags & OBJ_NOLOCK) {
1812                 ao2_unlock(clone);
1813         }
1814         if (failed) {
1815                 /* Object copy into the clone container failed. */
1816                 ao2_t_ref(clone, -1, "Clone creation failed.");
1817                 clone = NULL;
1818         }
1819         return clone;
1820 }
1821
1822 struct ao2_container *__ao2_container_clone_debug(struct ao2_container *orig, enum search_flags flags, const char *tag, const char *file, int line, const char *func, int ref_debug)
1823 {
1824         struct ao2_container *clone;
1825         int failed;
1826
1827         /* Create the clone container with the same properties as the original. */
1828         if (!INTERNAL_OBJ(orig) || !orig->v_table || !orig->v_table->alloc_empty_clone_debug) {
1829                 /* Sanity checks. */
1830                 ast_assert(0);
1831                 return NULL;
1832         }
1833         clone = orig->v_table->alloc_empty_clone_debug(orig, tag, file, line, func, ref_debug);
1834         if (!clone) {
1835                 return NULL;
1836         }
1837
1838         if (flags & OBJ_NOLOCK) {
1839                 ao2_wrlock(clone);
1840         }
1841         failed = ao2_container_dup(clone, orig, flags);
1842         if (flags & OBJ_NOLOCK) {
1843                 ao2_unlock(clone);
1844         }
1845         if (failed) {
1846                 /* Object copy into the clone container failed. */
1847                 if (ref_debug) {
1848                         __ao2_ref_debug(clone, -1, tag, file, line, func);
1849                 } else {
1850                         ao2_t_ref(clone, -1, "Clone creation failed.");
1851                 }
1852                 clone = NULL;
1853         }
1854         return clone;
1855 }
1856
1857 void ao2_container_dump(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt, ao2_prnt_obj_fn *prnt_obj)
1858 {
1859         if (!INTERNAL_OBJ(self) || !self->v_table) {
1860                 prnt(where, "Invalid container\n");
1861                 ast_assert(0);
1862                 return;
1863         }
1864
1865         if (!(flags & OBJ_NOLOCK)) {
1866                 ao2_rdlock(self);
1867         }
1868         if (name) {
1869                 prnt(where, "Container name: %s\n", name);
1870         }
1871 #if defined(AST_DEVMODE)
1872         if (self->v_table->dump) {
1873                 self->v_table->dump(self, where, prnt, prnt_obj);
1874         } else
1875 #endif  /* defined(AST_DEVMODE) */
1876         {
1877                 prnt(where, "Container dump not available.\n");
1878         }
1879         if (!(flags & OBJ_NOLOCK)) {
1880                 ao2_unlock(self);
1881         }
1882 }
1883
1884 void ao2_container_stats(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt)
1885 {
1886         if (!INTERNAL_OBJ(self) || !self->v_table) {
1887                 prnt(where, "Invalid container\n");
1888                 ast_assert(0);
1889                 return;
1890         }
1891
1892         if (!(flags & OBJ_NOLOCK)) {
1893                 ao2_rdlock(self);
1894         }
1895         if (name) {
1896                 prnt(where, "Container name: %s\n", name);
1897         }
1898         prnt(where, "Number of objects: %d\n", self->elements);
1899 #if defined(AST_DEVMODE)
1900         prnt(where, "Number of nodes: %d\n", self->nodes);
1901         prnt(where, "Number of empty nodes: %d\n", self->nodes - self->elements);
1902         /*
1903          * XXX
1904          * If the max_empty_nodes count gets out of single digits you
1905          * likely have a code path where ao2_iterator_destroy() is not
1906          * called.
1907          *
1908          * Empty nodes do not harm the container but they do make
1909          * container operations less efficient.
1910          */
1911         prnt(where, "Maximum empty nodes: %d\n", self->max_empty_nodes);
1912         if (self->v_table->stats) {
1913                 self->v_table->stats(self, where, prnt);
1914         }
1915 #endif  /* defined(AST_DEVMODE) */
1916         if (!(flags & OBJ_NOLOCK)) {
1917                 ao2_unlock(self);
1918         }
1919 }
1920
1921 int ao2_container_check(struct ao2_container *self, enum search_flags flags)
1922 {
1923         int res = 0;
1924
1925         if (!INTERNAL_OBJ(self) || !self->v_table) {
1926                 /* Sanity checks. */
1927                 ast_assert(0);
1928                 return -1;
1929         }
1930 #if defined(AST_DEVMODE)
1931         if (!self->v_table->integrity) {
1932                 /* No ingetrigy check available.  Assume container is ok. */
1933                 return 0;
1934         }
1935
1936         if (!(flags & OBJ_NOLOCK)) {
1937                 ao2_rdlock(self);
1938         }
1939         res = self->v_table->integrity(self);
1940         if (!(flags & OBJ_NOLOCK)) {
1941                 ao2_unlock(self);
1942         }
1943 #endif  /* defined(AST_DEVMODE) */
1944         return res;
1945 }
1946
1947 /*!
1948  * A structure to create a linked list of entries,
1949  * used within a bucket.
1950  */
1951 struct hash_bucket_node {
1952         /*!
1953          * \brief Items common to all container nodes.
1954          * \note Must be first in the specific node struct.
1955          */
1956         struct ao2_container_node common;
1957         /*! Next node links in the list. */
1958         AST_DLLIST_ENTRY(hash_bucket_node) links;
1959         /*! Hash bucket holding the node. */
1960         int my_bucket;
1961 };
1962
1963 struct hash_bucket {
1964         /*! List of objects held in the bucket. */
1965         AST_DLLIST_HEAD_NOLOCK(, hash_bucket_node) list;
1966 #if defined(AST_DEVMODE)
1967         /*! Number of elements currently in the bucket. */
1968         int elements;
1969         /*! Maximum number of elements in the bucket. */
1970         int max_elements;
1971 #endif  /* defined(AST_DEVMODE) */
1972 };
1973
1974 /*!
1975  * A hash container in addition to values common to all
1976  * container types, stores the hash callback function, the
1977  * number of hash buckets, and the hash bucket heads.
1978  */
1979 struct ao2_container_hash {
1980         /*!
1981          * \brief Items common to all containers.
1982          * \note Must be first in the specific container struct.
1983          */
1984         struct ao2_container common;
1985         ao2_hash_fn *hash_fn;
1986         /*! Number of hash buckets in this container. */
1987         int n_buckets;
1988         /*! Hash bucket array of n_buckets.  Variable size. */
1989         struct hash_bucket buckets[0];
1990 };
1991
1992 /*!
1993  * \internal
1994  * \brief Create an empty copy of this container.
1995  * \since 12.0.0
1996  *
1997  * \param self Container to operate upon.
1998  *
1999  * \retval empty-clone-container on success.
2000  * \retval NULL on error.
2001  */
2002 static struct ao2_container *hash_ao2_alloc_empty_clone(struct ao2_container_hash *self)
2003 {
2004         struct astobj2 *orig_obj;
2005         unsigned int ao2_options;
2006
2007         /* Get container ao2 options. */
2008         orig_obj = INTERNAL_OBJ(self);
2009         if (!orig_obj) {
2010                 return NULL;
2011         }
2012         ao2_options = orig_obj->priv_data.options;
2013
2014         return ao2_t_container_alloc_hash(ao2_options, self->common.options, self->n_buckets,
2015                 self->hash_fn, self->common.sort_fn, self->common.cmp_fn, "Clone hash container");
2016 }
2017
2018 /*!
2019  * \internal
2020  * \brief Create an empty copy of this container. (Debug version)
2021  * \since 12.0.0
2022  *
2023  * \param self Container to operate upon.
2024  * \param tag used for debugging.
2025  * \param file Debug file name invoked from
2026  * \param line Debug line invoked from
2027  * \param func Debug function name invoked from
2028  * \param ref_debug TRUE if to output a debug reference message.
2029  *
2030  * \retval empty-clone-container on success.
2031  * \retval NULL on error.
2032  */
2033 static struct ao2_container *hash_ao2_alloc_empty_clone_debug(struct ao2_container_hash *self, const char *tag, const char *file, int line, const char *func, int ref_debug)
2034 {
2035         struct astobj2 *orig_obj;
2036         unsigned int ao2_options;
2037
2038         /* Get container ao2 options. */
2039         orig_obj = INTERNAL_OBJ(self);
2040         if (!orig_obj) {
2041                 return NULL;
2042         }
2043         ao2_options = orig_obj->priv_data.options;
2044
2045         return __ao2_container_alloc_hash_debug(ao2_options, self->common.options,
2046                 self->n_buckets, self->hash_fn, self->common.sort_fn, self->common.cmp_fn,
2047                 tag, file, line, func, ref_debug);
2048 }
2049
2050 /*!
2051  * \internal
2052  * \brief Destroy a hash container list node.
2053  * \since 12.0.0
2054  *
2055  * \param v_doomed Container node to destroy.
2056  *
2057  * \details
2058  * The container node unlinks itself from the container as part
2059  * of its destruction.  The node must be destroyed while the
2060  * container is already locked.
2061  *
2062  * \note The container must be locked when the node is
2063  * unreferenced.
2064  *
2065  * \return Nothing
2066  */
2067 static void hash_ao2_node_destructor(void *v_doomed)
2068 {
2069         struct hash_bucket_node *doomed = v_doomed;
2070
2071         if (doomed->common.is_linked) {
2072                 struct ao2_container_hash *my_container;
2073                 struct hash_bucket *bucket;
2074
2075                 /*
2076                  * Promote to write lock if not already there.  Since
2077                  * adjust_lock() can potentially release and block waiting for a
2078                  * write lock, care must be taken to ensure that node references
2079                  * are released before releasing the container references.
2080                  *
2081                  * Node references held by an iterator can only be held while
2082                  * the iterator also holds a reference to the container.  These
2083                  * node references must be unreferenced before the container can
2084                  * be unreferenced to ensure that the node will not get a
2085                  * negative reference and the destructor called twice for the
2086                  * same node.
2087                  */
2088                 my_container = (struct ao2_container_hash *) doomed->common.my_container;
2089                 adjust_lock(my_container, AO2_LOCK_REQ_WRLOCK, 1);
2090
2091 #if defined(AO2_DEBUG) && defined(AST_DEVMODE)
2092                 /*
2093                  * XXX chan_iax2 plays games with the hash function so we cannot
2094                  * routinely do an integrity check on this type of container.
2095                  * chan_iax2 should be changed to not abuse the hash function.
2096                  */
2097                 if (!my_container->common.destroying
2098                         && my_container->common.sort_fn
2099                         && ao2_container_check(doomed->common.my_container, OBJ_NOLOCK)) {
2100                         ast_log(LOG_ERROR, "Container integrity failed before node deletion.\n");
2101                 }
2102 #endif  /* defined(AO2_DEBUG) && defined(AST_DEVMODE) */
2103                 bucket = &my_container->buckets[doomed->my_bucket];
2104                 AST_DLLIST_REMOVE(&bucket->list, doomed, links);
2105                 AO2_DEVMODE_STAT(--my_container->common.nodes);
2106         }
2107
2108         /*
2109          * We could have an object in the node if the container is being
2110          * destroyed or the node had not been linked in yet.
2111          */
2112         if (doomed->common.obj) {
2113                 ao2_t_ref(doomed->common.obj, -1, "Container node destruction");
2114                 doomed->common.obj = NULL;
2115         }
2116 }
2117
2118 /*!
2119  * \internal
2120  * \brief Create a new container node.
2121  * \since 12.0.0
2122  *
2123  * \param self Container to operate upon.
2124  * \param obj_new Object to put into the node.
2125  * \param tag used for debugging.
2126  * \param file Debug file name invoked from
2127  * \param line Debug line invoked from
2128  * \param func Debug function name invoked from
2129  *
2130  * \retval initialized-node on success.
2131  * \retval NULL on error.
2132  */
2133 static struct hash_bucket_node *hash_ao2_new_node(struct ao2_container_hash *self, void *obj_new, const char *tag, const char *file, int line, const char *func)
2134 {
2135         struct hash_bucket_node *node;
2136         int i;
2137
2138         node = __ao2_alloc(sizeof(*node), hash_ao2_node_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
2139         if (!node) {
2140                 return NULL;
2141         }
2142
2143         i = abs(self->hash_fn(obj_new, OBJ_SEARCH_OBJECT));
2144         i %= self->n_buckets;
2145
2146         if (tag) {
2147                 __ao2_ref_debug(obj_new, +1, tag, file, line, func);
2148         } else {
2149                 ao2_t_ref(obj_new, +1, "Container node creation");
2150         }
2151         node->common.obj = obj_new;
2152         node->common.my_container = (struct ao2_container *) self;
2153         node->my_bucket = i;
2154
2155         return node;
2156 }
2157
2158 /*!
2159  * \internal
2160  * \brief Insert a node into this container.
2161  * \since 12.0.0
2162  *
2163  * \param self Container to operate upon.
2164  * \param node Container node to insert into the container.
2165  *
2166  * \return enum ao2_container_insert value.
2167  */
2168 static enum ao2_container_insert hash_ao2_insert_node(struct ao2_container_hash *self, struct hash_bucket_node *node)
2169 {
2170         int cmp;
2171         struct hash_bucket *bucket;
2172         struct hash_bucket_node *cur;
2173         ao2_sort_fn *sort_fn;
2174         uint32_t options;
2175
2176         bucket = &self->buckets[node->my_bucket];
2177         sort_fn = self->common.sort_fn;
2178         options = self->common.options;
2179
2180         if (options & AO2_CONTAINER_ALLOC_OPT_INSERT_BEGIN) {
2181                 if (sort_fn) {
2182                         AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_BEGIN(&bucket->list, cur, links) {
2183                                 cmp = sort_fn(cur->common.obj, node->common.obj, OBJ_SEARCH_OBJECT);
2184                                 if (cmp > 0) {
2185                                         continue;
2186                                 }
2187                                 if (cmp < 0) {
2188                                         AST_DLLIST_INSERT_AFTER_CURRENT(node, links);
2189                                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
2190                                 }
2191                                 switch (options & AO2_CONTAINER_ALLOC_OPT_DUPS_MASK) {
2192                                 default:
2193                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW:
2194                                         break;
2195                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT:
2196                                         /* Reject all objects with the same key. */
2197                                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
2198                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT:
2199                                         if (cur->common.obj == node->common.obj) {
2200                                                 /* Reject inserting the same object */
2201                                                 return AO2_CONTAINER_INSERT_NODE_REJECTED;
2202                                         }
2203                                         break;
2204                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE:
2205                                         SWAP(cur->common.obj, node->common.obj);
2206                                         return AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED;
2207                                 }
2208                         }
2209                         AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_END;
2210                 }
2211                 AST_DLLIST_INSERT_HEAD(&bucket->list, node, links);
2212         } else {
2213                 if (sort_fn) {
2214                         AST_DLLIST_TRAVERSE_SAFE_BEGIN(&bucket->list, cur, links) {
2215                                 cmp = sort_fn(cur->common.obj, node->common.obj, OBJ_SEARCH_OBJECT);
2216                                 if (cmp < 0) {
2217                                         continue;
2218                                 }
2219                                 if (cmp > 0) {
2220                                         AST_DLLIST_INSERT_BEFORE_CURRENT(node, links);
2221                                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
2222                                 }
2223                                 switch (options & AO2_CONTAINER_ALLOC_OPT_DUPS_MASK) {
2224                                 default:
2225                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW:
2226                                         break;
2227                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT:
2228                                         /* Reject all objects with the same key. */
2229                                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
2230                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT:
2231                                         if (cur->common.obj == node->common.obj) {
2232                                                 /* Reject inserting the same object */
2233                                                 return AO2_CONTAINER_INSERT_NODE_REJECTED;
2234                                         }
2235                                         break;
2236                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE:
2237                                         SWAP(cur->common.obj, node->common.obj);
2238                                         return AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED;
2239                                 }
2240                         }
2241                         AST_DLLIST_TRAVERSE_SAFE_END;
2242                 }
2243                 AST_DLLIST_INSERT_TAIL(&bucket->list, node, links);
2244         }
2245         return AO2_CONTAINER_INSERT_NODE_INSERTED;
2246 }
2247
2248 /*! Traversal state to restart a hash container traversal. */
2249 struct hash_traversal_state {
2250         /*! Active sort function in the traversal if not NULL. */
2251         ao2_sort_fn *sort_fn;
2252         /*! Node returned in the sorted starting hash bucket if OBJ_CONTINUE flag set. (Reffed) */
2253         struct hash_bucket_node *first_node;
2254         /*! Saved comparison callback arg pointer. */
2255         void *arg;
2256         /*! Starting hash bucket */
2257         int bucket_start;
2258         /*! Stopping hash bucket */
2259         int bucket_last;
2260         /*! Saved search flags to control traversing the container. */
2261         enum search_flags flags;
2262         /*! TRUE if it is a descending search */
2263         unsigned int descending:1;
2264         /*! TRUE if the starting bucket needs to be rechecked because of sorting skips. */
2265         unsigned int recheck_starting_bucket:1;
2266 };
2267
2268 struct hash_traversal_state_check {
2269         /*
2270          * If we have a division by zero compile error here then there
2271          * is not enough room for the state.  Increase AO2_TRAVERSAL_STATE_SIZE.
2272          */
2273         char check[1 / (AO2_TRAVERSAL_STATE_SIZE / sizeof(struct hash_traversal_state))];
2274 };
2275
2276 /*!
2277  * \internal
2278  * \brief Find the first hash container node in a traversal.
2279  * \since 12.0.0
2280  *
2281  * \param self Container to operate upon.
2282  * \param flags search_flags to control traversing the container
2283  * \param arg Comparison callback arg parameter.
2284  * \param state Traversal state to restart hash container traversal.
2285  *
2286  * \retval node-ptr of found node (Reffed).
2287  * \retval NULL when no node found.
2288  */
2289 static struct hash_bucket_node *hash_ao2_find_first(struct ao2_container_hash *self, enum search_flags flags, void *arg, struct hash_traversal_state *state)
2290 {
2291         struct hash_bucket_node *node;
2292         int bucket_cur;
2293         int cmp;
2294
2295         memset(state, 0, sizeof(*state));
2296         state->arg = arg;
2297         state->flags = flags;
2298
2299         /* Determine traversal order. */
2300         switch (flags & OBJ_ORDER_MASK) {
2301         case OBJ_ORDER_POST:
2302         case OBJ_ORDER_DESCENDING:
2303                 state->descending = 1;
2304                 break;
2305         case OBJ_ORDER_PRE:
2306         case OBJ_ORDER_ASCENDING:
2307         default:
2308                 break;
2309         }
2310
2311         /*
2312          * If lookup by pointer or search key, run the hash and optional
2313          * sort functions.  Otherwise, traverse the whole container.
2314          */
2315         switch (flags & OBJ_SEARCH_MASK) {
2316         case OBJ_SEARCH_OBJECT:
2317         case OBJ_SEARCH_KEY:
2318                 /* we know hash can handle this case */
2319                 bucket_cur = abs(self->hash_fn(arg, flags & OBJ_SEARCH_MASK));
2320                 bucket_cur %= self->n_buckets;
2321                 state->sort_fn = self->common.sort_fn;
2322                 break;
2323         case OBJ_SEARCH_PARTIAL_KEY:
2324                 /* scan all buckets for partial key matches */
2325                 bucket_cur = -1;
2326                 state->sort_fn = self->common.sort_fn;
2327                 break;
2328         default:
2329                 /* don't know, let's scan all buckets */
2330                 bucket_cur = -1;
2331                 state->sort_fn = NULL;
2332                 break;
2333         }
2334
2335         if (state->descending) {
2336                 /*
2337                  * Determine the search boundaries of a descending traversal.
2338                  *
2339                  * bucket_cur downto state->bucket_last
2340                  */
2341                 if (bucket_cur < 0) {
2342                         bucket_cur = self->n_buckets - 1;
2343                         state->bucket_last = 0;
2344                 } else {
2345                         state->bucket_last = bucket_cur;
2346                 }
2347                 if (flags & OBJ_CONTINUE) {
2348                         state->bucket_last = 0;
2349                         if (state->sort_fn) {
2350                                 state->recheck_starting_bucket = 1;
2351                         }
2352                 }
2353                 state->bucket_start = bucket_cur;
2354
2355                 /* For each bucket */
2356                 for (; state->bucket_last <= bucket_cur; --bucket_cur) {
2357                         /* For each node in the bucket. */
2358                         for (node = AST_DLLIST_LAST(&self->buckets[bucket_cur].list);
2359                                 node;
2360                                 node = AST_DLLIST_PREV(node, links)) {
2361                                 if (!node->common.obj) {
2362                                         /* Node is empty */
2363                                         continue;
2364                                 }
2365
2366                                 if (state->sort_fn) {
2367                                         /* Filter node through the sort_fn */
2368                                         cmp = state->sort_fn(node->common.obj, arg, flags & OBJ_SEARCH_MASK);
2369                                         if (cmp > 0) {
2370                                                 continue;
2371                                         }
2372                                         if (flags & OBJ_CONTINUE) {
2373                                                 /* Remember first node when we wrap around. */
2374                                                 __ao2_ref(node, +1);
2375                                                 state->first_node = node;
2376
2377                                                 /* From now on all nodes are matching */
2378                                                 state->sort_fn = NULL;
2379                                         } else if (cmp < 0) {
2380                                                 /* No more nodes in this bucket are possible to match. */
2381                                                 break;
2382                                         }
2383                                 }
2384
2385                                 /* We have the first traversal node */
2386                                 __ao2_ref(node, +1);
2387                                 return node;
2388                         }
2389
2390                         /* Was this the starting bucket? */
2391                         if (bucket_cur == state->bucket_start
2392                                 && (flags & OBJ_CONTINUE)
2393                                 && (flags & OBJ_SEARCH_MASK) != OBJ_SEARCH_NONE) {
2394                                 /* In case the bucket was empty or none of the nodes matched. */
2395                                 state->sort_fn = NULL;
2396                         }
2397
2398                         /* Was this the first container bucket? */
2399                         if (bucket_cur == 0
2400                                 && (flags & OBJ_CONTINUE)
2401                                 && (flags & OBJ_SEARCH_MASK) != OBJ_SEARCH_NONE) {
2402                                 /* Move to the end to ensure we check every bucket */
2403                                 bucket_cur = self->n_buckets;
2404                                 state->bucket_last = state->bucket_start + 1;
2405                                 if (state->recheck_starting_bucket) {
2406                                         /*
2407                                          * We have to recheck the first part of the starting bucket
2408                                          * because of sorting skips.
2409                                          */
2410                                         state->recheck_starting_bucket = 0;
2411                                         --state->bucket_last;
2412                                 }
2413                         }
2414                 }
2415         } else {
2416                 /*
2417                  * Determine the search boundaries of an ascending traversal.
2418                  *
2419                  * bucket_cur to state->bucket_last-1
2420                  */
2421                 if (bucket_cur < 0) {
2422                         bucket_cur = 0;
2423                         state->bucket_last = self->n_buckets;
2424                 } else {
2425                         state->bucket_last = bucket_cur + 1;
2426                 }
2427                 if (flags & OBJ_CONTINUE) {
2428                         state->bucket_last = self->n_buckets;
2429                         if (state->sort_fn) {
2430                                 state->recheck_starting_bucket = 1;
2431                         }
2432                 }
2433                 state->bucket_start = bucket_cur;
2434
2435                 /* For each bucket */
2436                 for (; bucket_cur < state->bucket_last; ++bucket_cur) {
2437                         /* For each node in the bucket. */
2438                         for (node = AST_DLLIST_FIRST(&self->buckets[bucket_cur].list);
2439                                 node;
2440                                 node = AST_DLLIST_NEXT(node, links)) {
2441                                 if (!node->common.obj) {
2442                                         /* Node is empty */
2443                                         continue;
2444                                 }
2445
2446                                 if (state->sort_fn) {
2447                                         /* Filter node through the sort_fn */
2448                                         cmp = state->sort_fn(node->common.obj, arg, flags & OBJ_SEARCH_MASK);
2449                                         if (cmp < 0) {
2450                                                 continue;
2451                                         }
2452                                         if (flags & OBJ_CONTINUE) {
2453                                                 /* Remember first node when we wrap around. */
2454                                                 __ao2_ref(node, +1);
2455                                                 state->first_node = node;
2456
2457                                                 /* From now on all nodes are matching */
2458                                                 state->sort_fn = NULL;
2459                                         } else if (cmp > 0) {
2460                                                 /* No more nodes in this bucket are possible to match. */
2461                                                 break;
2462                                         }
2463                                 }
2464
2465                                 /* We have the first traversal node */
2466                                 __ao2_ref(node, +1);
2467                                 return node;
2468                         }
2469
2470                         /* Was this the starting bucket? */
2471                         if (bucket_cur == state->bucket_start
2472                                 && (flags & OBJ_CONTINUE)
2473                                 && (flags & OBJ_SEARCH_MASK) != OBJ_SEARCH_NONE) {
2474                                 /* In case the bucket was empty or none of the nodes matched. */
2475                                 state->sort_fn = NULL;
2476                         }
2477
2478                         /* Was this the last container bucket? */
2479                         if (bucket_cur == self->n_buckets - 1
2480                                 && (flags & OBJ_CONTINUE)
2481                                 && (flags & OBJ_SEARCH_MASK) != OBJ_SEARCH_NONE) {
2482                                 /* Move to the beginning to ensure we check every bucket */
2483                                 bucket_cur = -1;
2484                                 state->bucket_last = state->bucket_start;
2485                                 if (state->recheck_starting_bucket) {
2486                                         /*
2487                                          * We have to recheck the first part of the starting bucket
2488                                          * because of sorting skips.
2489                                          */
2490                                         state->recheck_starting_bucket = 0;
2491                                         ++state->bucket_last;
2492                                 }
2493                         }
2494                 }
2495         }
2496
2497         return NULL;
2498 }
2499
2500 /*!
2501  * \internal
2502  * \brief Find the next hash container node in a traversal.
2503  * \since 12.0.0
2504  *
2505  * \param self Container to operate upon.
2506  * \param state Traversal state to restart hash container traversal.
2507  * \param prev Previous node returned by the traversal search functions.
2508  *    The ref ownership is passed back to this function.
2509  *
2510  * \retval node-ptr of found node (Reffed).
2511  * \retval NULL when no node found.
2512  */
2513 static struct hash_bucket_node *hash_ao2_find_next(struct ao2_container_hash *self, struct hash_traversal_state *state, struct hash_bucket_node *prev)
2514 {
2515         struct hash_bucket_node *node;
2516         void *arg;
2517         enum search_flags flags;
2518         int bucket_cur;
2519         int cmp;
2520
2521         arg = state->arg;
2522         flags = state->flags;
2523         bucket_cur = prev->my_bucket;
2524         node = prev;
2525
2526         /*
2527          * This function is structured the same as hash_ao2_find_first()
2528          * intentionally.  We are resuming the search loops from
2529          * hash_ao2_find_first() in order to find the next node.  The
2530          * search loops must be resumed where hash_ao2_find_first()
2531          * returned with the first node.
2532          */
2533         if (state->descending) {
2534                 goto hash_descending_resume;
2535
2536                 /* For each bucket */
2537                 for (; state->bucket_last <= bucket_cur; --bucket_cur) {
2538                         /* For each node in the bucket. */
2539                         for (node = AST_DLLIST_LAST(&self->buckets[bucket_cur].list);
2540                                 node;
2541                                 node = AST_DLLIST_PREV(node, links)) {
2542                                 if (node == state->first_node) {
2543                                         /* We have wrapped back to the starting point. */
2544                                         __ao2_ref(prev, -1);
2545                                         return NULL;
2546                                 }
2547                                 if (!node->common.obj) {
2548                                         /* Node is empty */
2549                                         continue;
2550                                 }
2551
2552                                 if (state->sort_fn) {
2553                                         /* Filter node through the sort_fn */
2554                                         cmp = state->sort_fn(node->common.obj, arg, flags & OBJ_SEARCH_MASK);
2555                                         if (cmp > 0) {
2556                                                 continue;
2557                                         }
2558                                         if (cmp < 0) {
2559                                                 /* No more nodes in this bucket are possible to match. */
2560                                                 break;
2561                                         }
2562                                 }
2563
2564                                 /* We have the next traversal node */
2565                                 __ao2_ref(node, +1);
2566
2567                                 /*
2568                                  * Dereferencing the prev node may result in our next node
2569                                  * object being removed by another thread.  This could happen if
2570                                  * the container uses RW locks and the container was read
2571                                  * locked.
2572                                  */
2573                                 __ao2_ref(prev, -1);
2574                                 if (node->common.obj) {
2575                                         return node;
2576                                 }
2577                                 prev = node;
2578
2579 hash_descending_resume:;
2580                         }
2581
2582                         /* Was this the first container bucket? */
2583                         if (bucket_cur == 0
2584                                 && (flags & OBJ_CONTINUE)
2585                                 && (flags & OBJ_SEARCH_MASK) != OBJ_SEARCH_NONE) {
2586                                 /* Move to the end to ensure we check every bucket */
2587                                 bucket_cur = self->n_buckets;
2588                                 state->bucket_last = state->bucket_start + 1;
2589                                 if (state->recheck_starting_bucket) {
2590                                         /*
2591                                          * We have to recheck the first part of the starting bucket
2592                                          * because of sorting skips.
2593                                          */
2594                                         state->recheck_starting_bucket = 0;
2595                                         --state->bucket_last;
2596                                 }
2597                         }
2598                 }
2599         } else {
2600                 goto hash_ascending_resume;
2601
2602                 /* For each bucket */
2603                 for (; bucket_cur < state->bucket_last; ++bucket_cur) {
2604                         /* For each node in the bucket. */
2605                         for (node = AST_DLLIST_FIRST(&self->buckets[bucket_cur].list);
2606                                 node;
2607                                 node = AST_DLLIST_NEXT(node, links)) {
2608                                 if (node == state->first_node) {
2609                                         /* We have wrapped back to the starting point. */
2610                                         __ao2_ref(prev, -1);
2611                                         return NULL;
2612                                 }
2613                                 if (!node->common.obj) {
2614                                         /* Node is empty */
2615                                         continue;
2616                                 }
2617
2618                                 if (state->sort_fn) {
2619                                         /* Filter node through the sort_fn */
2620                                         cmp = state->sort_fn(node->common.obj, arg, flags & OBJ_SEARCH_MASK);
2621                                         if (cmp < 0) {
2622                                                 continue;
2623                                         }
2624                                         if (cmp > 0) {
2625                                                 /* No more nodes in this bucket are possible to match. */
2626                                                 break;
2627                                         }
2628                                 }
2629
2630                                 /* We have the next traversal node */
2631                                 __ao2_ref(node, +1);
2632
2633                                 /*
2634                                  * Dereferencing the prev node may result in our next node
2635                                  * object being removed by another thread.  This could happen if
2636                                  * the container uses RW locks and the container was read
2637                                  * locked.
2638                                  */
2639                                 __ao2_ref(prev, -1);
2640                                 if (node->common.obj) {
2641                                         return node;
2642                                 }
2643                                 prev = node;
2644
2645 hash_ascending_resume:;
2646                         }
2647
2648                         /* Was this the last container bucket? */
2649                         if (bucket_cur == self->n_buckets - 1
2650                                 && (flags & OBJ_CONTINUE)
2651                                 && (flags & OBJ_SEARCH_MASK) != OBJ_SEARCH_NONE) {
2652                                 /* Move to the beginning to ensure we check every bucket */
2653                                 bucket_cur = -1;
2654                                 state->bucket_last = state->bucket_start;
2655                                 if (state->recheck_starting_bucket) {
2656                                         /*
2657                                          * We have to recheck the first part of the starting bucket
2658                                          * because of sorting skips.
2659                                          */
2660                                         state->recheck_starting_bucket = 0;
2661                                         ++state->bucket_last;
2662                                 }
2663                         }
2664                 }
2665         }
2666
2667         /* No more nodes in the container left to traverse. */
2668         __ao2_ref(prev, -1);
2669         return NULL;
2670 }
2671
2672 /*!
2673  * \internal
2674  * \brief Cleanup the hash container traversal state.
2675  * \since 12.0.0
2676  *
2677  * \param state Traversal state to cleanup.
2678  *
2679  * \return Nothing
2680  */
2681 static void hash_ao2_find_cleanup(struct hash_traversal_state *state)
2682 {
2683         if (state->first_node) {
2684                 __ao2_ref(state->first_node, -1);
2685         }
2686 }
2687
2688 /*!
2689  * \internal
2690  * \brief Find the next non-empty iteration node in the container.
2691  * \since 12.0.0
2692  *
2693  * \param self Container to operate upon.
2694  * \param node Previous node returned by the iterator.
2695  * \param flags search_flags to control iterating the container.
2696  *   Only AO2_ITERATOR_DESCENDING is useful by the method.
2697  *
2698  * \note The container is already locked.
2699  *
2700  * \retval node on success.
2701  * \retval NULL on error or no more nodes in the container.
2702  */
2703 static struct hash_bucket_node *hash_ao2_iterator_next(struct ao2_container_hash *self, struct hash_bucket_node *node, enum ao2_iterator_flags flags)
2704 {
2705         int cur_bucket;
2706
2707         if (flags & AO2_ITERATOR_DESCENDING) {
2708                 if (node) {
2709                         cur_bucket = node->my_bucket;
2710
2711                         /* Find next non-empty node. */
2712                         for (;;) {
2713                                 node = AST_DLLIST_PREV(node, links);
2714                                 if (!node) {
2715                                         break;
2716                                 }
2717                                 if (node->common.obj) {
2718                                         /* Found a non-empty node. */
2719                                         return node;
2720                                 }
2721                         }
2722                 } else {
2723                         /* Find first non-empty node. */
2724                         cur_bucket = self->n_buckets;
2725                 }
2726
2727                 /* Find a non-empty node in the remaining buckets */
2728                 while (0 <= --cur_bucket) {
2729                         node = AST_DLLIST_LAST(&self->buckets[cur_bucket].list);
2730                         while (node) {
2731                                 if (node->common.obj) {
2732                                         /* Found a non-empty node. */
2733                                         return node;
2734                                 }
2735                                 node = AST_DLLIST_PREV(node, links);
2736                         }
2737                 }
2738         } else {
2739                 if (node) {
2740                         cur_bucket = node->my_bucket;
2741
2742                         /* Find next non-empty node. */
2743                         for (;;) {
2744                                 node = AST_DLLIST_NEXT(node, links);
2745                                 if (!node) {
2746                                         break;
2747                                 }
2748                                 if (node->common.obj) {
2749                                         /* Found a non-empty node. */
2750                                         return node;
2751                                 }
2752                         }
2753                 } else {
2754                         /* Find first non-empty node. */
2755                         cur_bucket = -1;
2756                 }
2757
2758                 /* Find a non-empty node in the remaining buckets */
2759                 while (++cur_bucket < self->n_buckets) {
2760                         node = AST_DLLIST_FIRST(&self->buckets[cur_bucket].list);
2761                         while (node) {
2762                                 if (node->common.obj) {
2763                                         /* Found a non-empty node. */
2764                                         return node;
2765                                 }
2766                                 node = AST_DLLIST_NEXT(node, links);
2767                         }
2768                 }
2769         }
2770
2771         /* No more nodes to visit in the container. */
2772         return NULL;
2773 }
2774
2775 #if defined(AST_DEVMODE)
2776 /*!
2777  * \internal
2778  * \brief Increment the hash container linked object statistic.
2779  * \since 12.0.0
2780  *
2781  * \param hash Container to operate upon.
2782  * \param hash_node Container node linking object to.
2783  *
2784  * \return Nothing
2785  */
2786 static void hash_ao2_link_node_stat(struct ao2_container *hash, struct ao2_container_node *hash_node)
2787 {
2788         struct ao2_container_hash *self = (struct ao2_container_hash *) hash;
2789         struct hash_bucket_node *node = (struct hash_bucket_node *) hash_node;
2790         int i = node->my_bucket;
2791
2792         ++self->buckets[i].elements;
2793         if (self->buckets[i].max_elements < self->buckets[i].elements) {
2794                 self->buckets[i].max_elements = self->buckets[i].elements;
2795         }
2796 }
2797 #endif  /* defined(AST_DEVMODE) */
2798
2799 #if defined(AST_DEVMODE)
2800 /*!
2801  * \internal
2802  * \brief Decrement the hash container linked object statistic.
2803  * \since 12.0.0
2804  *
2805  * \param hash Container to operate upon.
2806  * \param hash_node Container node unlinking object from.
2807  *
2808  * \return Nothing
2809  */
2810 static void hash_ao2_unlink_node_stat(struct ao2_container *hash, struct ao2_container_node *hash_node)
2811 {
2812         struct ao2_container_hash *self = (struct ao2_container_hash *) hash;
2813         struct hash_bucket_node *node = (struct hash_bucket_node *) hash_node;
2814
2815         --self->buckets[node->my_bucket].elements;
2816 }
2817 #endif  /* defined(AST_DEVMODE) */
2818
2819 /*!
2820  * \internal
2821  *
2822  * \brief Destroy this container.
2823  * \since 12.0.0
2824  *
2825  * \param self Container to operate upon.
2826  *
2827  * \return Nothing
2828  */
2829 static void hash_ao2_destroy(struct ao2_container_hash *self)
2830 {
2831         int idx;
2832
2833         /* Check that the container no longer has any nodes */
2834         for (idx = self->n_buckets; idx--;) {
2835                 if (!AST_DLLIST_EMPTY(&self->buckets[idx].list)) {
2836                         ast_log(LOG_ERROR, "Node ref leak.  Hash container still has nodes!\n");
2837                         ast_assert(0);
2838                         break;
2839                 }
2840         }
2841 }
2842
2843 #if defined(AST_DEVMODE)
2844 /*!
2845  * \internal
2846  * \brief Display contents of the specified container.
2847  * \since 12.0.0
2848  *
2849  * \param self Container to dump.
2850  * \param where User data needed by prnt to determine where to put output.
2851  * \param prnt Print output callback function to use.
2852  * \param prnt_obj Callback function to print the given object's key. (NULL if not available)
2853  *
2854  * \return Nothing
2855  */
2856 static void hash_ao2_dump(struct ao2_container_hash *self, void *where, ao2_prnt_fn *prnt, ao2_prnt_obj_fn *prnt_obj)
2857 {
2858 #define FORMAT  "%6s, %16s, %16s, %16s, %16s, %s\n"
2859 #define FORMAT2 "%6d, %16p, %16p, %16p, %16p, "
2860
2861         int bucket;
2862         int suppressed_buckets = 0;
2863         struct hash_bucket_node *node;
2864
2865         prnt(where, "Number of buckets: %d\n\n", self->n_buckets);
2866
2867         prnt(where, FORMAT, "Bucket", "Node", "Prev", "Next", "Obj", "Key");
2868         for (bucket = 0; bucket < self->n_buckets; ++bucket) {
2869                 node = AST_DLLIST_FIRST(&self->buckets[bucket].list);
2870                 if (node) {
2871                         suppressed_buckets = 0;
2872                         do {
2873                                 prnt(where, FORMAT2,
2874                                         bucket,
2875                                         node,
2876                                         AST_DLLIST_PREV(node, links),
2877                                         AST_DLLIST_NEXT(node, links),
2878                                         node->common.obj);
2879                                 if (node->common.obj && prnt_obj) {
2880                                         prnt_obj(node->common.obj, where, prnt);
2881                                 }
2882                                 prnt(where, "\n");
2883
2884                                 node = AST_DLLIST_NEXT(node, links);
2885                         } while (node);
2886                 } else if (!suppressed_buckets) {
2887                         suppressed_buckets = 1;
2888                         prnt(where, "...\n");
2889                 }
2890         }
2891
2892 #undef FORMAT
2893 #undef FORMAT2
2894 }
2895 #endif  /* defined(AST_DEVMODE) */
2896
2897 #if defined(AST_DEVMODE)
2898 /*!
2899  * \internal
2900  * \brief Display statistics of the specified container.
2901  * \since 12.0.0
2902  *
2903  * \param self Container to display statistics.
2904  * \param where User data needed by prnt to determine where to put output.
2905  * \param prnt Print output callback function to use.
2906  *
2907  * \note The container is already locked for reading.
2908  *
2909  * \return Nothing
2910  */
2911 static void hash_ao2_stats(struct ao2_container_hash *self, void *where, ao2_prnt_fn *prnt)
2912 {
2913 #define FORMAT  "%10.10s %10.10s %10.10s\n"
2914 #define FORMAT2 "%10d %10d %10d\n"
2915
2916         int bucket;
2917         int suppressed_buckets = 0;
2918
2919         prnt(where, "Number of buckets: %d\n\n", self->n_buckets);
2920
2921         prnt(where, FORMAT, "Bucket", "Objects", "Max");
2922         for (bucket = 0; bucket < self->n_buckets; ++bucket) {
2923                 if (self->buckets[bucket].max_elements) {
2924                         suppressed_buckets = 0;
2925                         prnt(where, FORMAT2, bucket, self->buckets[bucket].elements,
2926                                 self->buckets[bucket].max_elements);
2927                 } else if (!suppressed_buckets) {
2928                         suppressed_buckets = 1;
2929                         prnt(where, "...\n");
2930                 }
2931         }
2932
2933 #undef FORMAT
2934 #undef FORMAT2
2935 }
2936 #endif  /* defined(AST_DEVMODE) */
2937
2938 #if defined(AST_DEVMODE)
2939 /*!
2940  * \internal
2941  * \brief Perform an integrity check on the specified container.
2942  * \since 12.0.0
2943  *
2944  * \param self Container to check integrity.
2945  *
2946  * \note The container is already locked for reading.
2947  *
2948  * \retval 0 on success.
2949  * \retval -1 on error.
2950  */
2951 static int hash_ao2_integrity(struct ao2_container_hash *self)
2952 {
2953         int bucket_exp;
2954         int bucket;
2955         int count_obj;
2956         int count_total_obj;
2957         int count_total_node;
2958         void *obj_last;
2959         struct hash_bucket_node *node;
2960         struct hash_bucket_node *prev;
2961         struct hash_bucket_node *next;
2962
2963         count_total_obj = 0;
2964         count_total_node = 0;
2965
2966         /* For each bucket in the container. */
2967         for (bucket = 0; bucket < self->n_buckets; ++bucket) {
2968                 if (!AST_DLLIST_FIRST(&self->buckets[bucket].list)
2969                         && !AST_DLLIST_LAST(&self->buckets[bucket].list)) {
2970                         /* The bucket list is empty. */
2971                         continue;
2972                 }
2973
2974                 count_obj = 0;
2975                 obj_last = NULL;
2976
2977                 /* Check bucket list links and nodes. */
2978                 node = AST_DLLIST_LAST(&self->buckets[bucket].list);
2979                 if (!node) {
2980                         ast_log(LOG_ERROR, "Bucket %d list tail is NULL when it should not be!\n",
2981                                 bucket);
2982                         return -1;
2983                 }
2984                 if (AST_DLLIST_NEXT(node, links)) {
2985                         ast_log(LOG_ERROR, "Bucket %d list tail node is not the last node!\n",
2986                                 bucket);
2987                         return -1;
2988                 }
2989                 node = AST_DLLIST_FIRST(&self->buckets[bucket].list);
2990                 if (!node) {
2991                         ast_log(LOG_ERROR, "Bucket %d list head is NULL when it should not be!\n",
2992                                 bucket);
2993                         return -1;
2994                 }
2995                 if (AST_DLLIST_PREV(node, links)) {
2996                         ast_log(LOG_ERROR, "Bucket %d list head node is not the first node!\n",
2997                                 bucket);
2998                         return -1;
2999                 }
3000                 for (; node; node = next) {
3001                         /* Check backward link. */
3002                         prev = AST_DLLIST_PREV(node, links);
3003                         if (prev) {
3004                                 if (prev == node) {
3005                                         ast_log(LOG_ERROR, "Bucket %d list node's prev pointer points to itself!\n",
3006                                                 bucket);
3007                                         return -1;
3008                                 }
3009                                 if (node != AST_DLLIST_NEXT(prev, links)) {
3010                                         ast_log(LOG_ERROR, "Bucket %d list node's prev node does not link back!\n",
3011                                                 bucket);
3012                                         return -1;
3013                                 }
3014                         } else if (node != AST_DLLIST_FIRST(&self->buckets[bucket].list)) {
3015                                 ast_log(LOG_ERROR, "Bucket %d backward list chain is broken!\n",
3016                                         bucket);
3017                                 return -1;
3018                         }
3019
3020                         /* Check forward link. */
3021                         next = AST_DLLIST_NEXT(node, links);
3022                         if (next) {
3023                                 if (next == node) {
3024                                         ast_log(LOG_ERROR, "Bucket %d list node's next pointer points to itself!\n",
3025                                                 bucket);
3026                                         return -1;
3027                                 }
3028                                 if (node != AST_DLLIST_PREV(next, links)) {
3029                                         ast_log(LOG_ERROR, "Bucket %d list node's next node does not link back!\n",
3030                                                 bucket);
3031                                         return -1;
3032                                 }
3033                         } else if (node != AST_DLLIST_LAST(&self->buckets[bucket].list)) {
3034                                 ast_log(LOG_ERROR, "Bucket %d forward list chain is broken!\n",
3035                                         bucket);
3036                                 return -1;
3037                         }
3038
3039                         if (bucket != node->my_bucket) {
3040                                 ast_log(LOG_ERROR, "Bucket %d node claims to be in bucket %d!\n",
3041                                         bucket, node->my_bucket);
3042                                 return -1;
3043                         }
3044
3045                         ++count_total_node;
3046                         if (!node->common.obj) {
3047                                 /* Node is empty. */
3048                                 continue;
3049                         }
3050                         ++count_obj;
3051
3052                         /* Check container hash key for expected bucket. */
3053                         bucket_exp = abs(self->hash_fn(node->common.obj, OBJ_SEARCH_OBJECT));
3054                         bucket_exp %= self->n_buckets;
3055                         if (bucket != bucket_exp) {
3056                                 ast_log(LOG_ERROR, "Bucket %d node hashes to bucket %d!\n",
3057                                         bucket, bucket_exp);
3058                                 return -1;
3059                         }
3060
3061                         /* Check sort if configured. */
3062                         if (self->common.sort_fn) {
3063                                 if (obj_last
3064                                         && self->common.sort_fn(obj_last, node->common.obj, OBJ_SEARCH_OBJECT) > 0) {
3065                                         ast_log(LOG_ERROR, "Bucket %d nodes out of sorted order!\n",
3066                                                 bucket);
3067                                         return -1;
3068                                 }
3069                                 obj_last = node->common.obj;
3070                         }
3071                 }
3072
3073                 /* Check bucket obj count statistic. */
3074                 if (count_obj != self->buckets[bucket].elements) {
3075                         ast_log(LOG_ERROR, "Bucket %d object count of %d does not match stat of %d!\n",
3076                                 bucket, count_obj, self->buckets[bucket].elements);
3077                         return -1;
3078                 }
3079
3080                 /* Accumulate found object counts. */
3081                 count_total_obj += count_obj;
3082         }
3083
3084         /* Check total obj count. */
3085         if (count_total_obj != ao2_container_count(&self->common)) {
3086                 ast_log(LOG_ERROR,
3087                         "Total object count of %d does not match ao2_container_count() of %d!\n",
3088                         count_total_obj, ao2_container_count(&self->common));
3089                 return -1;
3090         }
3091
3092         /* Check total node count. */
3093         if (count_total_node != self->common.nodes) {
3094                 ast_log(LOG_ERROR, "Total node count of %d does not match stat of %d!\n",
3095                         count_total_node, self->common.nodes);
3096                 return -1;
3097         }
3098
3099         return 0;
3100 }
3101 #endif  /* defined(AST_DEVMODE) */
3102
3103 /*! Hash container virtual method table. */
3104 static const struct ao2_container_methods v_table_hash = {
3105         .type = AO2_CONTAINER_RTTI_HASH,
3106         .alloc_empty_clone = (ao2_container_alloc_empty_clone_fn) hash_ao2_alloc_empty_clone,
3107         .alloc_empty_clone_debug =
3108                 (ao2_container_alloc_empty_clone_debug_fn) hash_ao2_alloc_empty_clone_debug,
3109         .new_node = (ao2_container_new_node_fn) hash_ao2_new_node,
3110         .insert = (ao2_container_insert_fn) hash_ao2_insert_node,
3111         .traverse_first = (ao2_container_find_first_fn) hash_ao2_find_first,
3112         .traverse_next = (ao2_container_find_next_fn) hash_ao2_find_next,
3113         .traverse_cleanup = (ao2_container_find_cleanup_fn) hash_ao2_find_cleanup,
3114         .iterator_next = (ao2_iterator_next_fn) hash_ao2_iterator_next,
3115         .destroy = (ao2_container_destroy_fn) hash_ao2_destroy,
3116 #if defined(AST_DEVMODE)
3117         .dump = (ao2_container_display) hash_ao2_dump,
3118         .stats = (ao2_container_statistics) hash_ao2_stats,
3119         .integrity = (ao2_container_integrity) hash_ao2_integrity,
3120 #endif  /* defined(AST_DEVMODE) */
3121 };
3122
3123 /*!
3124  * \brief always zero hash function
3125  *
3126  * it is convenient to have a hash function that always returns 0.
3127  * This is basically used when we want to have a container that is
3128  * a simple linked list.
3129  *
3130  * \returns 0
3131  */
3132 static int hash_zero(const void *user_obj, const int flags)
3133 {
3134         return 0;
3135 }
3136
3137 /*!
3138  * \brief Initialize a hash container with the desired number of buckets.
3139  *
3140  * \param self Container to initialize.
3141  * \param options Container behaviour options (See enum ao2_container_opts)
3142  * \param n_buckets Number of buckets for hash
3143  * \param hash_fn Pointer to a function computing a hash value.
3144  * \param sort_fn Pointer to a sort function.
3145  * \param cmp_fn Pointer to a compare function used by ao2_find.
3146  *
3147  * \return A pointer to a struct container.
3148  */
3149 static struct ao2_container *hash_ao2_container_init(
3150         struct ao2_container_hash *self, unsigned int options, unsigned int n_buckets,
3151         ao2_hash_fn *hash_fn, ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn)
3152 {
3153         if (!self) {
3154                 return NULL;
3155         }
3156
3157         self->common.v_table = &v_table_hash;
3158         self->common.sort_fn = sort_fn;
3159         self->common.cmp_fn = cmp_fn;
3160         self->common.options = options;
3161         self->hash_fn = hash_fn ? hash_fn : hash_zero;
3162         self->n_buckets = n_buckets;
3163
3164 #ifdef AO2_DEBUG
3165         ast_atomic_fetchadd_int(&ao2.total_containers, 1);
3166 #endif
3167
3168         return (struct ao2_container *) self;
3169 }
3170
3171 struct ao2_container *__ao2_container_alloc_hash(unsigned int ao2_options,
3172         unsigned int container_options, unsigned int n_buckets, ao2_hash_fn *hash_fn,
3173         ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn)
3174 {
3175         unsigned int num_buckets;
3176         size_t container_size;
3177         struct ao2_container_hash *self;
3178
3179         num_buckets = hash_fn ? n_buckets : 1;
3180         container_size = sizeof(struct ao2_container_hash) + num_buckets * sizeof(struct hash_bucket);
3181
3182         self = ao2_t_alloc_options(container_size, container_destruct, ao2_options,
3183                 "New hash container");
3184         return hash_ao2_container_init(self, container_options, num_buckets,
3185                 hash_fn, sort_fn, cmp_fn);
3186 }
3187
3188 struct ao2_container *__ao2_container_alloc_hash_debug(unsigned int ao2_options,
3189         unsigned int container_options, unsigned int n_buckets, ao2_hash_fn *hash_fn,
3190         ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn,
3191         const char *tag, const char *file, int line, const char *func, int ref_debug)
3192 {
3193         unsigned int num_buckets;
3194         size_t container_size;
3195         struct ao2_container_hash *self;
3196
3197         num_buckets = hash_fn ? n_buckets : 1;
3198         container_size = sizeof(struct ao2_container_hash) + num_buckets * sizeof(struct hash_bucket);
3199
3200         self = __ao2_alloc_debug(container_size,
3201                 ref_debug ? container_destruct_debug : container_destruct, ao2_options,
3202                 tag, file, line, func, ref_debug);
3203         return hash_ao2_container_init(self, container_options, num_buckets, hash_fn,
3204                 sort_fn, cmp_fn);
3205 }
3206
3207 struct ao2_container *__ao2_container_alloc_list(unsigned int ao2_options,
3208         unsigned int container_options, ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn)
3209 {
3210         return __ao2_container_alloc_hash(ao2_options, container_options, 1, NULL, sort_fn,
3211                 cmp_fn);
3212 }
3213
3214 struct ao2_container *__ao2_container_alloc_list_debug(unsigned int ao2_options,
3215         unsigned int container_options, ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn,
3216         const char *tag, const char *file, int line, const char *func, int ref_debug)
3217 {
3218         return __ao2_container_alloc_hash_debug(ao2_options, container_options, 1, NULL,
3219                 sort_fn, cmp_fn, tag, file, line, func, ref_debug);
3220 }
3221
3222 /*!
3223  * A structure to hold the object held by the container and
3224  * where it is located in it.
3225  *
3226  * A red-black tree has the following properties:
3227  *
3228  * 1) Every node is either black or red.
3229  *
3230  * 2) The root is black.
3231  *
3232  * 3) If a node has a NULL child, that "child" is considered
3233  * black.
3234  *
3235  * 4) If a node is red, then both of its children are black.
3236  *
3237  * 5) Every path from a node to a descendant NULL child has the
3238  * same number of black nodes.  (Including the black NULL
3239  * child.)
3240  */
3241 struct rbtree_node {
3242         /*!
3243          * \brief Items common to all container nodes.
3244          * \note Must be first in the specific node struct.
3245          */
3246         struct ao2_container_node common;
3247         /*! Parent node of this node. NULL if this is the root node. */
3248         struct rbtree_node *parent;
3249         /*! Left child node of this node.  NULL if does not have this child. */
3250         struct rbtree_node *left;
3251         /*! Right child node of this node.  NULL if does not have this child. */
3252         struct rbtree_node *right;
3253         /*! TRUE if the node is red. */
3254         unsigned int is_red:1;
3255 };
3256
3257 /*!
3258  * A rbtree container in addition to values common to all
3259  * container types, stores the pointer to the root node of the
3260  * tree.
3261  */
3262 struct ao2_container_rbtree {
3263         /*!
3264          * \brief Items common to all containers.
3265          * \note Must be first in the specific container struct.
3266          */
3267         struct ao2_container common;
3268         /*! Root node of the tree.  NULL if the tree is empty. */
3269         struct rbtree_node *root;
3270 #if defined(AST_DEVMODE)
3271         struct {
3272                 /*! Fixup insert left cases 1-3 */
3273                 int fixup_insert_left[3];
3274                 /*! Fixup insert right cases 1-3 */
3275                 int fixup_insert_right[3];
3276                 /*! Fixup delete left cases 1-4 */
3277                 int fixup_delete_left[4];
3278                 /*! Fixup delete right cases 1-4 */
3279                 int fixup_delete_right[4];
3280                 /*! Deletion of node with number of children (0-2). */
3281                 int delete_children[3];
3282         } stats;
3283 #endif  /* defined(AST_DEVMODE) */
3284 };
3285
3286 /*!
3287  * \internal
3288  * \brief Get the most left node in the tree.
3289  * \since 12.0.0
3290  *
3291  * \param node Starting node to find the most left node.
3292  *
3293  * \return Left most node.  Never NULL.
3294  */
3295 static struct rbtree_node *rb_node_most_left(struct rbtree_node *node)
3296 {
3297         while (node->left) {
3298                 node = node->left;
3299         }
3300
3301         return node;
3302 }
3303
3304 /*!
3305  * \internal
3306  * \brief Get the most right node in the tree.
3307  * \since 12.0.0
3308  *
3309  * \param node Starting node to find the most right node.
3310  *
3311  * \return Right most node.  Never NULL.
3312  */
3313 static struct rbtree_node *rb_node_most_right(struct rbtree_node *node)
3314 {
3315         while (node->right) {
3316                 node = node->right;
3317         }
3318
3319         return node;
3320 }
3321
3322 /*!
3323  * \internal
3324  * \brief Get the next node in ascending sequence.
3325  * \since 12.0.0
3326  *
3327  * \param node Starting node to find the next node.
3328  *
3329  * \retval node on success.
3330  * \retval NULL if no node.
3331  */
3332 static struct rbtree_node *rb_node_next(struct rbtree_node *node)
3333 {
3334         if (node->right) {
3335                 return rb_node_most_left(node->right);
3336         }
3337
3338         /* Find the parent that the node is a left child of. */
3339         while (node->parent) {
3340                 if (node->parent->left == node) {
3341                         /* We are the left child.  The parent is the next node. */
3342                         return node->parent;
3343                 }
3344                 node = node->parent;
3345         }
3346         return NULL;
3347 }
3348
3349 /*!
3350  * \internal
3351  * \brief Get the next node in descending sequence.
3352  * \since 12.0.0
3353  *
3354  * \param node Starting node to find the previous node.
3355  *
3356  * \retval node on success.
3357  * \retval NULL if no node.
3358  */
3359 static struct rbtree_node *rb_node_prev(struct rbtree_node *node)
3360 {
3361         if (node->left) {
3362                 return rb_node_most_right(node->left);
3363         }
3364
3365         /* Find the parent that the node is a right child of. */
3366         while (node->parent) {
3367                 if (node->parent->right == node) {
3368                         /* We are the right child.  The parent is the previous node. */
3369                         return node->parent;
3370                 }
3371                 node = node->parent;
3372         }
3373         return NULL;
3374 }
3375
3376 /*!
3377  * \internal
3378  * \brief Get the next node in pre-order sequence.
3379  * \since 12.0.0
3380  *
3381  * \param node Starting node to find the next node.
3382  *
3383  * \retval node on success.
3384  * \retval NULL if no node.
3385  */
3386 static struct rbtree_node *rb_node_pre(struct rbtree_node *node)
3387 {
3388         /* Visit the children if the node has any. */
3389         if (node->left) {
3390                 return node->left;
3391         }
3392         if (node->right) {
3393                 return node->right;
3394         }
3395
3396         /* Time to go back up. */
3397         for (;;) {
3398                 if (!node->parent) {
3399                         return NULL;
3400                 }
3401                 if (node->parent->left == node && node->parent->right) {
3402                         /*
3403                          * We came up the left child and there's a right child.  Visit
3404                          * it.
3405                          */
3406                         return node->parent->right;
3407                 }
3408                 node = node->parent;
3409         }
3410 }
3411
3412 /*!
3413  * \internal
3414  * \brief Get the next node in post-order sequence.
3415  * \since 12.0.0
3416  *
3417  * \param node Starting node to find the next node.
3418  *
3419  * \retval node on success.
3420  * \retval NULL if no node.
3421  */
3422 static struct rbtree_node *rb_node_post(struct rbtree_node *node)
3423 {
3424         /* This node's children have already been visited. */
3425         for (;;) {
3426                 if (!node->parent) {
3427                         return NULL;
3428                 }
3429                 if (node->parent->left == node) {
3430                         /* We came up the left child. */
3431                         node = node->parent;
3432
3433                         /*
3434                          * Find the right child's left most childless node.
3435                          */
3436                         while (node->right) {
3437                                 node = rb_node_most_left(node->right);
3438                         }
3439
3440                         /*
3441                          * This node's left child has already been visited or it doesn't
3442                          * have any children.
3443                          */
3444                         return node;
3445                 }
3446
3447                 /*
3448                  * We came up the right child.
3449                  *
3450                  * This node's children have already been visited.  Time to
3451                  * visit the parent.
3452                  */
3453                 return node->parent;
3454         }
3455 }
3456
3457 /*!
3458  * \internal
3459  * \brief Get the next non-empty node in ascending sequence.
3460  * \since 12.0.0
3461  *
3462  * \param node Starting node to find the next node.
3463  *
3464  * \retval node on success.
3465  * \retval NULL if no node.
3466  */
3467 static struct rbtree_node *rb_node_next_full(struct rbtree_node *node)
3468 {
3469         for (;;) {
3470                 node = rb_node_next(node);
3471                 if (!node || node->common.obj) {
3472                         return node;
3473                 }
3474         }
3475 }
3476
3477 /*!
3478  * \internal
3479  * \brief Get the next non-empty node in descending sequence.
3480  * \since 12.0.0
3481  *
3482  * \param node Starting node to find the previous node.
3483  *
3484  * \retval node on success.
3485  * \retval NULL if no node.
3486  */
3487 static struct rbtree_node *rb_node_prev_full(struct rbtree_node *node)
3488 {
3489         for (;;) {
3490                 node = rb_node_prev(node);
3491                 if (!node || node->common.obj) {
3492                         return node;
3493                 }
3494         }
3495 }
3496
3497 enum equal_node_bias {
3498         /*! Bias search toward first matching node in the container. */
3499         BIAS_FIRST,
3500         /*! Bias search toward any matching node. */
3501         BIAS_EQUAL,
3502         /*! Bias search toward last matching node in the container. */
3503         BIAS_LAST,
3504 };
3505
3506 enum empty_node_direction {
3507         GO_LEFT,
3508         GO_RIGHT,
3509 };
3510
3511 /*!
3512  * \internal
3513  * \brief Determine which way to go from an empty node.
3514  * \since 12.0.0
3515  *
3516  * \param empty Empty node to determine which side obj_right goes on.
3517  * \param sort_fn Sort comparison function for non-empty nodes.
3518  * \param obj_right pointer to the (user-defined part) of an object.
3519  * \param flags flags from ao2_callback()
3520  *   OBJ_SEARCH_OBJECT - if set, 'obj_right', is an object.
3521  *   OBJ_SEARCH_KEY - if set, 'obj_right', is a search key item that is not an object.
3522  *   OBJ_SEARCH_PARTIAL_KEY - if set, 'obj_right', is a partial search key item that is not an object.
3523  * \param bias How to bias search direction for duplicates
3524  *
3525  * \return enum empty_node_direction to proceed.
3526  */
3527 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)
3528 {
3529         int cmp;
3530         struct rbtree_node *cur;
3531         struct rbtree_node *right_most;
3532
3533         /* Try for a quick definite go left. */
3534         if (!empty->left) {
3535                 /* The empty node has no left child. */
3536                 return GO_RIGHT;
3537         }
3538         right_most = rb_node_most_right(empty->left);
3539         if (right_most->common.obj) {
3540                 cmp = sort_fn(right_most->common.obj, obj_right, flags);
3541                 if (cmp < 0) {
3542                         return GO_RIGHT;
3543                 }
3544                 if (cmp == 0 && bias == BIAS_LAST) {
3545                         return GO_RIGHT;
3546                 }
3547                 return GO_LEFT;
3548         }
3549
3550         /* Try for a quick definite go right. */
3551         if (!empty->right) {
3552                 /* The empty node has no right child. */
3553                 return GO_LEFT;
3554         }
3555         cur = rb_node_most_left(empty->right);
3556         if (cur->common.obj) {
3557                 cmp = sort_fn(cur->common.obj, obj_right, flags);
3558                 if (cmp > 0) {
3559                         return GO_LEFT;
3560                 }
3561                 if (cmp == 0 && bias == BIAS_FIRST) {
3562                         return GO_LEFT;
3563                 }
3564                 return GO_RIGHT;
3565         }
3566
3567         /*
3568          * Have to scan the previous nodes from the right_most node of
3569          * the left subtree for the first non-empty node to determine
3570          * direction.
3571          */
3572         cur = right_most;
3573         for (;;) {
3574                 /* Find previous node. */
3575                 if (cur->left) {
3576                         cur = rb_node_most_right(cur->left);
3577                 } else {
3578                         /* Find the parent that the node is a right child of. */
3579                         for (;;) {
3580                                 if (cur->parent == empty) {
3581                                         /* The left side of the empty node is all empty nodes. */
3582                                         return GO_RIGHT;
3583                                 }
3584                                 if (cur->parent->right == cur) {
3585                                         /* We are the right child.  The parent is the previous node. */
3586                                         cur = cur->parent;
3587                                         break;
3588                                 }
3589                                 cur = cur->parent;
3590                         }
3591                 }
3592
3593                 if (cur->common.obj) {
3594                         cmp = sort_fn(cur->common.obj, obj_right, flags);
3595                         if (cmp < 0) {
3596                                 return GO_RIGHT;
3597                         }
3598                         if (cmp == 0 && bias == BIAS_LAST) {
3599                                 return GO_RIGHT;
3600                         }
3601                         return GO_LEFT;
3602                 }
3603         }
3604 }
3605
3606 /*!
3607  * \internal
3608  * \brief Tree node rotation left.
3609  * \since 12.0.0
3610  *
3611  * \param self Container holding node.
3612  * \param node Node to perform a left rotation with.
3613  *
3614  *        p                         p
3615  *        |     Left rotation       |
3616  *        N        --->             Ch
3617  *       / \                       / \
3618  *      a  Ch                     N   c
3619  *        / \                    / \
3620  *       b   c                  a   b
3621  *
3622  * N = node
3623  * Ch = child
3624  * p = parent
3625  * a,b,c = other nodes that are unaffected by the rotation.
3626  *
3627  * \note It is assumed that the node's right child exists.
3628  *
3629  * \return Nothing
3630  */
3631 static void rb_rotate_left(struct ao2_container_rbtree *self, struct rbtree_node *node)
3632 {
3633         struct rbtree_node *child;      /*!< Node's right child. */
3634
3635         child = node->right;
3636
3637         /* Link the node's parent to the child. */
3638         if (!node->parent) {
3639                 /* Node is the root so we get a new root node. */
3640                 self->root = child;
3641         } else if (node->parent->left == node) {
3642                 /* Node is a left child. */
3643                 node->parent->left = child;
3644         } else {
3645                 /* Node is a right child. */
3646                 node->parent->right = child;
3647         }
3648         child->parent = node->parent;
3649
3650         /* Link node's right subtree to the child's left subtree. */
3651         node->right = child->left;
3652         if (node->right) {
3653                 node->right->parent = node;
3654         }
3655
3656         /* Link the node to the child's left. */
3657         node->parent = child;
3658         child->left = node;
3659 }
3660
3661 /*!
3662  * \internal
3663  * \brief Tree node rotation right.
3664  * \since 12.0.0
3665  *
3666  * \param self Container holding node.
3667  * \param node Node to perform a right rotation with.
3668  *
3669  *        p                         p
3670  *        |     Right rotation      |
3671  *        Ch                        N
3672  *       / \       <---            / \
3673  *      a  N                      Ch  c
3674  *        / \                    / \
3675  *       b   c                  a   b
3676  *
3677  * N = node
3678  * Ch = child
3679  * p = parent
3680  * a,b,c = other nodes that are unaffected by the rotation.
3681  *
3682  * \note It is assumed that the node's left child exists.
3683  *
3684  * \return Nothing
3685  */
3686 static void rb_rotate_right(struct ao2_container_rbtree *self, struct rbtree_node *node)
3687 {
3688         struct rbtree_node *child;      /*!< Node's left child. */
3689
3690         child = node->left;
3691
3692         /* Link the node's parent to the child. */
3693         if (!node->parent) {
3694                 /* Node is the root so we get a new root node. */
3695                 self->root = child;
3696         } else if (node->parent->right == node) {
3697                 /* Node is a right child. */
3698                 node->parent->right = child;
3699         } else {
3700                 /* Node is a left child. */
3701                 node->parent->left = child;
3702         }
3703         child->parent = node->parent;
3704
3705         /* Link node's left subtree to the child's right subtree. */
3706         node->left = child->right;
3707         if (node->left) {
3708                 node->left->parent = node;
3709         }
3710
3711         /* Link the node to the child's right. */
3712         node->parent = child;
3713         child->right = node;
3714 }
3715
3716 /*!
3717  * \internal
3718  * \brief Create an empty copy of this container.
3719  * \since 12.0.0
3720  *
3721  * \param self Container to operate upon.
3722  *
3723  * \retval empty-clone-container on success.
3724  * \retval NULL on error.
3725  */
3726 static struct ao2_container *rb_ao2_alloc_empty_clone(struct ao2_container_rbtree *self)