astobj2: Only define ao2_bt() once.
[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_UNLINK | OBJ_POINTER | OBJ_NODATA);
1194         __ao2_callback_debug(c, flags, ao2_match_by_addr, user_data, tag, file, line, func);
1195
1196         return NULL;
1197 }
1198
1199 void *__ao2_unlink(struct ao2_container *c, void *user_data, int flags)
1200 {
1201         if (!INTERNAL_OBJ(user_data)) {
1202                 /* Sanity checks. */
1203                 ast_assert(0);
1204                 return NULL;
1205         }
1206
1207         flags |= (OBJ_UNLINK | OBJ_POINTER | OBJ_NODATA);
1208         __ao2_callback(c, flags, ao2_match_by_addr, user_data);
1209
1210         return NULL;
1211 }
1212
1213 /*!
1214  * \brief special callback that matches all
1215  */
1216 static int cb_true(void *user_data, void *arg, int flags)
1217 {
1218         return CMP_MATCH;
1219 }
1220
1221 /*!
1222  * \brief similar to cb_true, but is an ao2_callback_data_fn instead
1223  */
1224 static int cb_true_data(void *user_data, void *arg, void *data, int flags)
1225 {
1226         return CMP_MATCH;
1227 }
1228
1229 /*! Allow enough room for container specific traversal state structs */
1230 #define AO2_TRAVERSAL_STATE_SIZE        100
1231
1232 /*!
1233  * \internal
1234  * \brief Traverse the container.  (internal)
1235  *
1236  * \param self Container to operate upon.
1237  * \param flags search_flags to control traversing the container
1238  * \param cb_fn Comparison callback function.
1239  * \param arg Comparison callback arg parameter.
1240  * \param data Data comparison callback data parameter.
1241  * \param type Type of comparison callback cb_fn.
1242  * \param tag used for debugging.
1243  * \param file Debug file name invoked from
1244  * \param line Debug line invoked from
1245  * \param func Debug function name invoked from
1246  *
1247  * \retval NULL on failure or no matching object found.
1248  *
1249  * \retval object found if OBJ_MULTIPLE is not set in the flags
1250  * parameter.
1251  *
1252  * \retval ao2_iterator pointer if OBJ_MULTIPLE is set in the
1253  * flags parameter.  The iterator must be destroyed with
1254  * ao2_iterator_destroy() when the caller no longer needs it.
1255  */
1256 static void *internal_ao2_traverse(struct ao2_container *self, enum search_flags flags,
1257         void *cb_fn, void *arg, void *data, enum ao2_callback_type type,
1258         const char *tag, const char *file, int line, const char *func)
1259 {
1260         void *ret;
1261         ao2_callback_fn *cb_default = NULL;
1262         ao2_callback_data_fn *cb_withdata = NULL;
1263         struct ao2_container_node *node;
1264         void *traversal_state;
1265
1266         enum ao2_lock_req orig_lock;
1267         struct ao2_container *multi_container = NULL;
1268         struct ao2_iterator *multi_iterator = NULL;
1269
1270         if (!INTERNAL_OBJ(self) || !self->v_table || !self->v_table->traverse_first
1271                 || !self->v_table->traverse_next) {
1272                 /* Sanity checks. */
1273                 ast_assert(0);
1274                 return NULL;
1275         }
1276
1277         /*
1278          * This logic is used so we can support OBJ_MULTIPLE with OBJ_NODATA
1279          * turned off.  This if statement checks for the special condition
1280          * where multiple items may need to be returned.
1281          */
1282         if ((flags & (OBJ_MULTIPLE | OBJ_NODATA)) == OBJ_MULTIPLE) {
1283                 /* we need to return an ao2_iterator with the results,
1284                  * as there could be more than one. the iterator will
1285                  * hold the only reference to a container that has all the
1286                  * matching objects linked into it, so when the iterator
1287                  * is destroyed, the container will be automatically
1288                  * destroyed as well.
1289                  */
1290                 multi_container = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL,
1291                         NULL, "OBJ_MULTIPLE return container creation");
1292                 if (!multi_container) {
1293                         return NULL;
1294                 }
1295                 if (!(multi_iterator = ast_calloc(1, sizeof(*multi_iterator)))) {
1296                         ao2_t_ref(multi_container, -1, "OBJ_MULTIPLE interator creation failed.");
1297                         return NULL;
1298                 }
1299         }
1300
1301         if (!cb_fn) {
1302                 /* Match everything if no callback match function provided. */
1303                 if (type == AO2_CALLBACK_WITH_DATA) {
1304                         cb_withdata = cb_true_data;
1305                 } else {
1306                         cb_default = cb_true;
1307                 }
1308         } else {
1309                 /*
1310                  * We do this here to avoid the per object casting penalty (even
1311                  * though that is probably optimized away anyway).
1312                  */
1313                 if (type == AO2_CALLBACK_WITH_DATA) {
1314                         cb_withdata = cb_fn;
1315                 } else {
1316                         cb_default = cb_fn;
1317                 }
1318         }
1319
1320         /* avoid modifications to the content */
1321         if (flags & OBJ_NOLOCK) {
1322                 if (flags & OBJ_UNLINK) {
1323                         orig_lock = adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
1324                 } else {
1325                         orig_lock = adjust_lock(self, AO2_LOCK_REQ_RDLOCK, 1);
1326                 }
1327         } else {
1328                 orig_lock = AO2_LOCK_REQ_MUTEX;
1329                 if (flags & OBJ_UNLINK) {
1330                         ao2_wrlock(self);
1331                 } else {
1332                         ao2_rdlock(self);
1333                 }
1334         }
1335
1336         /* Create a buffer for the traversal state. */
1337         traversal_state = alloca(AO2_TRAVERSAL_STATE_SIZE);
1338
1339         ret = NULL;
1340         for (node = self->v_table->traverse_first(self, flags, arg, traversal_state);
1341                 node;
1342                 node = self->v_table->traverse_next(self, traversal_state, node)) {
1343                 int match;
1344
1345                 /* Visit the current node. */
1346                 match = (CMP_MATCH | CMP_STOP);
1347                 if (type == AO2_CALLBACK_WITH_DATA) {
1348                         match &= cb_withdata(node->obj, arg, data, flags);
1349                 } else {
1350                         match &= cb_default(node->obj, arg, flags);
1351                 }
1352                 if (match == 0) {
1353                         /* no match, no stop, continue */
1354                         continue;
1355                 }
1356                 if (match == CMP_STOP) {
1357                         /* no match but stop, we are done */
1358                         break;
1359                 }
1360
1361                 /*
1362                  * CMP_MATCH is set here
1363                  *
1364                  * we found the object, performing operations according to flags
1365                  */
1366                 if (node->obj) {
1367                         /* The object is still in the container. */
1368                         if (!(flags & OBJ_NODATA)) {
1369                                 /*
1370                                  * We are returning the object, record the value.  It is
1371                                  * important to handle this case before the unlink.
1372                                  */
1373                                 if (multi_container) {
1374                                         /*
1375                                          * Link the object into the container that will hold the
1376                                          * results.
1377                                          */
1378                                         if (tag) {
1379                                                 __ao2_link_debug(multi_container, node->obj, flags,
1380                                                         tag, file, line, func);
1381                                         } else {
1382                                                 __ao2_link(multi_container, node->obj, flags);
1383                                         }
1384                                 } else {
1385                                         ret = node->obj;
1386                                         /* Returning a single object. */
1387                                         if (!(flags & OBJ_UNLINK)) {
1388                                                 /*
1389                                                  * Bump the ref count since we are not going to unlink and
1390                                                  * transfer the container's object ref to the returned object.
1391                                                  */
1392                                                 if (tag) {
1393                                                         __ao2_ref_debug(ret, 1, tag, file, line, func);
1394                                                 } else {
1395                                                         ao2_t_ref(ret, 1, "Traversal found object");
1396                                                 }
1397                                         }
1398                                 }
1399                         }
1400
1401                         if (flags & OBJ_UNLINK) {
1402                                 /* update number of elements */
1403                                 ast_atomic_fetchadd_int(&self->elements, -1);
1404 #if defined(AST_DEVMODE)
1405                                 {
1406                                         int empty = self->nodes - self->elements;
1407
1408                                         if (self->max_empty_nodes < empty) {
1409                                                 self->max_empty_nodes = empty;
1410                                         }
1411                                 }
1412                                 switch (self->v_table->type) {
1413                                 case AO2_CONTAINER_RTTI_HASH:
1414                                         hash_ao2_unlink_node_stat(self, node);
1415                                         break;
1416                                 case AO2_CONTAINER_RTTI_RBTREE:
1417                                         break;
1418                                 }
1419 #endif  /* defined(AST_DEVMODE) */
1420
1421                                 /*
1422                                  * - When unlinking and not returning the result, OBJ_NODATA is
1423                                  * set, the ref from the container must be decremented.
1424                                  *
1425                                  * - When unlinking with a multi_container the ref from the
1426                                  * original container must be decremented.  This is because the
1427                                  * result is returned in a new container that already holds its
1428                                  * own ref for the object.
1429                                  *
1430                                  * If the ref from the original container is not accounted for
1431                                  * here a memory leak occurs.
1432                                  */
1433                                 if (multi_container || (flags & OBJ_NODATA)) {
1434                                         if (tag) {
1435                                                 __ao2_ref_debug(node->obj, -1, tag, file, line, func);
1436                                         } else {
1437                                                 ao2_t_ref(node->obj, -1, "Unlink container obj reference.");
1438                                         }
1439                                 }
1440                                 node->obj = NULL;
1441
1442                                 /* Unref the node from the container. */
1443                                 __ao2_ref(node, -1);
1444                         }
1445                 }
1446
1447                 if ((match & CMP_STOP) || !(flags & OBJ_MULTIPLE)) {
1448                         /* We found our only (or last) match, so we are done */
1449                         break;
1450                 }
1451         }
1452         if (self->v_table->traverse_cleanup) {
1453                 self->v_table->traverse_cleanup(traversal_state);
1454         }
1455         if (node) {
1456                 /* Unref the node from self->v_table->traverse_first/traverse_next() */
1457                 __ao2_ref(node, -1);
1458         }
1459
1460         if (flags & OBJ_NOLOCK) {
1461                 adjust_lock(self, orig_lock, 0);
1462         } else {
1463                 ao2_unlock(self);
1464         }
1465
1466         /* if multi_container was created, we are returning multiple objects */
1467         if (multi_container) {
1468                 *multi_iterator = ao2_iterator_init(multi_container,
1469                         AO2_ITERATOR_UNLINK | AO2_ITERATOR_MALLOCD);
1470                 ao2_t_ref(multi_container, -1,
1471                         "OBJ_MULTIPLE for multiple objects traversal complete.");
1472                 return multi_iterator;
1473         } else {
1474                 return ret;
1475         }
1476 }
1477
1478 void *__ao2_callback_debug(struct ao2_container *c, enum search_flags flags,
1479         ao2_callback_fn *cb_fn, void *arg, const char *tag, const char *file, int line,
1480         const char *func)
1481 {
1482         return internal_ao2_traverse(c, flags, cb_fn, arg, NULL, AO2_CALLBACK_DEFAULT, tag, file, line, func);
1483 }
1484
1485 void *__ao2_callback(struct ao2_container *c, enum search_flags flags,
1486         ao2_callback_fn *cb_fn, void *arg)
1487 {
1488         return internal_ao2_traverse(c, flags, cb_fn, arg, NULL, AO2_CALLBACK_DEFAULT, NULL, NULL, 0, NULL);
1489 }
1490
1491 void *__ao2_callback_data_debug(struct ao2_container *c, enum search_flags flags,
1492         ao2_callback_data_fn *cb_fn, void *arg, void *data, const char *tag, const char *file,
1493         int line, const char *func)
1494 {
1495         return internal_ao2_traverse(c, flags, cb_fn, arg, data, AO2_CALLBACK_WITH_DATA, tag, file, line, func);
1496 }
1497
1498 void *__ao2_callback_data(struct ao2_container *c, enum search_flags flags,
1499         ao2_callback_data_fn *cb_fn, void *arg, void *data)
1500 {
1501         return internal_ao2_traverse(c, flags, cb_fn, arg, data, AO2_CALLBACK_WITH_DATA, NULL, NULL, 0, NULL);
1502 }
1503
1504 /*!
1505  * the find function just invokes the default callback with some reasonable flags.
1506  */
1507 void *__ao2_find_debug(struct ao2_container *c, const void *arg, enum search_flags flags,
1508         const char *tag, const char *file, int line, const char *func)
1509 {
1510         void *arged = (void *) arg;/* Done to avoid compiler const warning */
1511
1512         if (!c) {
1513                 /* Sanity checks. */
1514                 ast_assert(0);
1515                 return NULL;
1516         }
1517         return __ao2_callback_debug(c, flags, c->cmp_fn, arged, tag, file, line, func);
1518 }
1519
1520 void *__ao2_find(struct ao2_container *c, const void *arg, enum search_flags flags)
1521 {
1522         void *arged = (void *) arg;/* Done to avoid compiler const warning */
1523
1524         if (!c) {
1525                 /* Sanity checks. */
1526                 ast_assert(0);
1527                 return NULL;
1528         }
1529         return __ao2_callback(c, flags, c->cmp_fn, arged);
1530 }
1531
1532 /*!
1533  * initialize an iterator so we start from the first object
1534  */
1535 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags)
1536 {
1537         struct ao2_iterator a = {
1538                 .c = c,
1539                 .flags = flags
1540         };
1541
1542         ao2_t_ref(c, +1, "Init iterator with container.");
1543
1544         return a;
1545 }
1546
1547 void ao2_iterator_restart(struct ao2_iterator *iter)
1548 {
1549         /* Release the last container node reference if we have one. */
1550         if (iter->last_node) {
1551                 enum ao2_lock_req orig_lock;
1552
1553                 /*
1554                  * Do a read lock in case the container node unref does not
1555                  * destroy the node.  If the container node is destroyed then
1556                  * the lock will be upgraded to a write lock.
1557                  */
1558                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
1559                         orig_lock = adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
1560                 } else {
1561                         orig_lock = AO2_LOCK_REQ_MUTEX;
1562                         ao2_rdlock(iter->c);
1563                 }
1564
1565                 __ao2_ref(iter->last_node, -1);
1566                 iter->last_node = NULL;
1567
1568                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
1569                         adjust_lock(iter->c, orig_lock, 0);
1570                 } else {
1571                         ao2_unlock(iter->c);
1572                 }
1573         }
1574
1575         /* The iteration is no longer complete. */
1576         iter->complete = 0;
1577 }
1578
1579 void ao2_iterator_destroy(struct ao2_iterator *iter)
1580 {
1581         /* Release any last container node reference. */
1582         ao2_iterator_restart(iter);
1583
1584         /* Release the iterated container reference. */
1585         ao2_t_ref(iter->c, -1, "Unref iterator in ao2_iterator_destroy");
1586         iter->c = NULL;
1587
1588         /* Free the malloced iterator. */
1589         if (iter->flags & AO2_ITERATOR_MALLOCD) {
1590                 ast_free(iter);
1591         }
1592 }
1593
1594 void ao2_iterator_cleanup(struct ao2_iterator *iter)
1595 {
1596         if (iter) {
1597                 ao2_iterator_destroy(iter);
1598         }
1599 }
1600
1601 /*
1602  * move to the next element in the container.
1603  */
1604 static void *internal_ao2_iterator_next(struct ao2_iterator *iter, const char *tag, const char *file, int line, const char *func)
1605 {
1606         enum ao2_lock_req orig_lock;
1607         struct ao2_container_node *node;
1608         void *ret;
1609
1610         if (!INTERNAL_OBJ(iter->c) || !iter->c->v_table || !iter->c->v_table->iterator_next) {
1611                 /* Sanity checks. */
1612                 ast_assert(0);
1613                 return NULL;
1614         }
1615
1616         if (iter->complete) {
1617                 /* Don't return any more objects. */
1618                 return NULL;
1619         }
1620
1621         if (iter->flags & AO2_ITERATOR_DONTLOCK) {
1622                 if (iter->flags & AO2_ITERATOR_UNLINK) {
1623                         orig_lock = adjust_lock(iter->c, AO2_LOCK_REQ_WRLOCK, 1);
1624                 } else {
1625                         orig_lock = adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
1626                 }
1627         } else {
1628                 orig_lock = AO2_LOCK_REQ_MUTEX;
1629                 if (iter->flags & AO2_ITERATOR_UNLINK) {
1630                         ao2_wrlock(iter->c);
1631                 } else {
1632                         ao2_rdlock(iter->c);
1633                 }
1634         }
1635
1636         node = iter->c->v_table->iterator_next(iter->c, iter->last_node, iter->flags);
1637         if (node) {
1638                 ret = node->obj;
1639
1640                 if (iter->flags & AO2_ITERATOR_UNLINK) {
1641                         /* update number of elements */
1642                         ast_atomic_fetchadd_int(&iter->c->elements, -1);
1643 #if defined(AST_DEVMODE)
1644                         {
1645                                 int empty = iter->c->nodes - iter->c->elements;
1646
1647                                 if (iter->c->max_empty_nodes < empty) {
1648                                         iter->c->max_empty_nodes = empty;
1649                                 }
1650                         }
1651                         switch (iter->c->v_table->type) {
1652                         case AO2_CONTAINER_RTTI_HASH:
1653                                 hash_ao2_unlink_node_stat(iter->c, node);
1654                                 break;
1655                         case AO2_CONTAINER_RTTI_RBTREE:
1656                                 break;
1657                         }
1658 #endif  /* defined(AST_DEVMODE) */
1659
1660                         /* Transfer the object ref from the container to the returned object. */
1661                         node->obj = NULL;
1662
1663                         /* Transfer the container's node ref to the iterator. */
1664                 } else {
1665                         /* Bump ref of returned object */
1666                         if (tag) {
1667                                 __ao2_ref_debug(ret, +1, tag, file, line, func);
1668                         } else {
1669                                 ao2_t_ref(ret, +1, "Next iterator object.");
1670                         }
1671
1672                         /* Bump the container's node ref for the iterator. */
1673                         __ao2_ref(node, +1);
1674                 }
1675         } else {
1676                 /* The iteration has completed. */
1677                 iter->complete = 1;
1678                 ret = NULL;
1679         }
1680
1681         /* Replace the iterator's node */
1682         if (iter->last_node) {
1683                 __ao2_ref(iter->last_node, -1);
1684         }
1685         iter->last_node = node;
1686
1687         if (iter->flags & AO2_ITERATOR_DONTLOCK) {
1688                 adjust_lock(iter->c, orig_lock, 0);
1689         } else {
1690                 ao2_unlock(iter->c);
1691         }
1692
1693         return ret;
1694 }
1695
1696 void *__ao2_iterator_next_debug(struct ao2_iterator *iter, const char *tag, const char *file, int line, const char *func)
1697 {
1698         return internal_ao2_iterator_next(iter, tag, file, line, func);
1699 }
1700
1701 void *__ao2_iterator_next(struct ao2_iterator *iter)
1702 {
1703         return internal_ao2_iterator_next(iter, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__);
1704 }
1705
1706 static void container_destruct(void *_c)
1707 {
1708         struct ao2_container *c = _c;
1709
1710         /* Unlink any stored objects in the container. */
1711         c->destroying = 1;
1712         __ao2_callback(c, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
1713
1714         /* Perform any extra container cleanup. */
1715         if (c->v_table && c->v_table->destroy) {
1716                 c->v_table->destroy(c);
1717         }
1718
1719 #ifdef AO2_DEBUG
1720         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
1721 #endif
1722 }
1723
1724 static void container_destruct_debug(void *_c)
1725 {
1726         struct ao2_container *c = _c;
1727
1728         /* Unlink any stored objects in the container. */
1729         c->destroying = 1;
1730         __ao2_callback_debug(c, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL,
1731                 "container_destruct_debug called", __FILE__, __LINE__, __PRETTY_FUNCTION__);
1732
1733         /* Perform any extra container cleanup. */
1734         if (c->v_table && c->v_table->destroy) {
1735                 c->v_table->destroy(c);
1736         }
1737
1738 #ifdef AO2_DEBUG
1739         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
1740 #endif
1741 }
1742
1743 /*!
1744  * \internal
1745  * \brief Put obj into the arg container.
1746  * \since 11.0
1747  *
1748  * \param obj  pointer to the (user-defined part) of an object.
1749  * \param arg callback argument from ao2_callback()
1750  * \param flags flags from ao2_callback()
1751  *
1752  * \retval 0 on success.
1753  * \retval CMP_STOP|CMP_MATCH on error.
1754  */
1755 static int dup_obj_cb(void *obj, void *arg, int flags)
1756 {
1757         struct ao2_container *dest = arg;
1758
1759         return __ao2_link(dest, obj, OBJ_NOLOCK) ? 0 : (CMP_MATCH | CMP_STOP);
1760 }
1761
1762 int ao2_container_dup(struct ao2_container *dest, struct ao2_container *src, enum search_flags flags)
1763 {
1764         void *obj;
1765         int res = 0;
1766
1767         if (!(flags & OBJ_NOLOCK)) {
1768                 ao2_rdlock(src);
1769                 ao2_wrlock(dest);
1770         }
1771         obj = __ao2_callback(src, OBJ_NOLOCK, dup_obj_cb, dest);
1772         if (obj) {
1773                 /* Failed to put this obj into the dest container. */
1774                 ao2_t_ref(obj, -1, "Failed to put this object into the dest container.");
1775
1776                 /* Remove all items from the dest container. */
1777                 __ao2_callback(dest, OBJ_NOLOCK | OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL,
1778                         NULL);
1779                 res = -1;
1780         }
1781         if (!(flags & OBJ_NOLOCK)) {
1782                 ao2_unlock(dest);
1783                 ao2_unlock(src);
1784         }
1785
1786         return res;
1787 }
1788
1789 struct ao2_container *__ao2_container_clone(struct ao2_container *orig, enum search_flags flags)
1790 {
1791         struct ao2_container *clone;
1792         int failed;
1793
1794         /* Create the clone container with the same properties as the original. */
1795         if (!INTERNAL_OBJ(orig) || !orig->v_table || !orig->v_table->alloc_empty_clone) {
1796                 /* Sanity checks. */
1797                 ast_assert(0);
1798                 return NULL;
1799         }
1800         clone = orig->v_table->alloc_empty_clone(orig);
1801         if (!clone) {
1802                 return NULL;
1803         }
1804
1805         if (flags & OBJ_NOLOCK) {
1806                 ao2_wrlock(clone);
1807         }
1808         failed = ao2_container_dup(clone, orig, flags);
1809         if (flags & OBJ_NOLOCK) {
1810                 ao2_unlock(clone);
1811         }
1812         if (failed) {
1813                 /* Object copy into the clone container failed. */
1814                 ao2_t_ref(clone, -1, "Clone creation failed.");
1815                 clone = NULL;
1816         }
1817         return clone;
1818 }
1819
1820 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)
1821 {
1822         struct ao2_container *clone;
1823         int failed;
1824
1825         /* Create the clone container with the same properties as the original. */
1826         if (!INTERNAL_OBJ(orig) || !orig->v_table || !orig->v_table->alloc_empty_clone_debug) {
1827                 /* Sanity checks. */
1828                 ast_assert(0);
1829                 return NULL;
1830         }
1831         clone = orig->v_table->alloc_empty_clone_debug(orig, tag, file, line, func, ref_debug);
1832         if (!clone) {
1833                 return NULL;
1834         }
1835
1836         if (flags & OBJ_NOLOCK) {
1837                 ao2_wrlock(clone);
1838         }
1839         failed = ao2_container_dup(clone, orig, flags);
1840         if (flags & OBJ_NOLOCK) {
1841                 ao2_unlock(clone);
1842         }
1843         if (failed) {
1844                 /* Object copy into the clone container failed. */
1845                 if (ref_debug) {
1846                         __ao2_ref_debug(clone, -1, tag, file, line, func);
1847                 } else {
1848                         ao2_t_ref(clone, -1, "Clone creation failed.");
1849                 }
1850                 clone = NULL;
1851         }
1852         return clone;
1853 }
1854
1855 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)
1856 {
1857         if (!INTERNAL_OBJ(self) || !self->v_table) {
1858                 prnt(where, "Invalid container\n");
1859                 ast_assert(0);
1860                 return;
1861         }
1862
1863         if (!(flags & OBJ_NOLOCK)) {
1864                 ao2_rdlock(self);
1865         }
1866         if (name) {
1867                 prnt(where, "Container name: %s\n", name);
1868         }
1869 #if defined(AST_DEVMODE)
1870         if (self->v_table->dump) {
1871                 self->v_table->dump(self, where, prnt, prnt_obj);
1872         } else
1873 #endif  /* defined(AST_DEVMODE) */
1874         {
1875                 prnt(where, "Container dump not available.\n");
1876         }
1877         if (!(flags & OBJ_NOLOCK)) {
1878                 ao2_unlock(self);
1879         }
1880 }
1881
1882 void ao2_container_stats(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt)
1883 {
1884         if (!INTERNAL_OBJ(self) || !self->v_table) {
1885                 prnt(where, "Invalid container\n");
1886                 ast_assert(0);
1887                 return;
1888         }
1889
1890         if (!(flags & OBJ_NOLOCK)) {
1891                 ao2_rdlock(self);
1892         }
1893         if (name) {
1894                 prnt(where, "Container name: %s\n", name);
1895         }
1896         prnt(where, "Number of objects: %d\n", self->elements);
1897 #if defined(AST_DEVMODE)
1898         prnt(where, "Number of nodes: %d\n", self->nodes);
1899         prnt(where, "Number of empty nodes: %d\n", self->nodes - self->elements);
1900         /*
1901          * XXX
1902          * If the max_empty_nodes count gets out of single digits you
1903          * likely have a code path where ao2_iterator_destroy() is not
1904          * called.
1905          *
1906          * Empty nodes do not harm the container but they do make
1907          * container operations less efficient.
1908          */
1909         prnt(where, "Maximum empty nodes: %d\n", self->max_empty_nodes);
1910         if (self->v_table->stats) {
1911                 self->v_table->stats(self, where, prnt);
1912         }
1913 #endif  /* defined(AST_DEVMODE) */
1914         if (!(flags & OBJ_NOLOCK)) {
1915                 ao2_unlock(self);
1916         }
1917 }
1918
1919 int ao2_container_check(struct ao2_container *self, enum search_flags flags)
1920 {
1921         int res = 0;
1922
1923         if (!INTERNAL_OBJ(self) || !self->v_table) {
1924                 /* Sanity checks. */
1925                 ast_assert(0);
1926                 return -1;
1927         }
1928 #if defined(AST_DEVMODE)
1929         if (!self->v_table->integrity) {
1930                 /* No ingetrigy check available.  Assume container is ok. */
1931                 return 0;
1932         }
1933
1934         if (!(flags & OBJ_NOLOCK)) {
1935                 ao2_rdlock(self);
1936         }
1937         res = self->v_table->integrity(self);
1938         if (!(flags & OBJ_NOLOCK)) {
1939                 ao2_unlock(self);
1940         }
1941 #endif  /* defined(AST_DEVMODE) */
1942         return res;
1943 }
1944
1945 /*!
1946  * A structure to create a linked list of entries,
1947  * used within a bucket.
1948  */
1949 struct hash_bucket_node {
1950         /*!
1951          * \brief Items common to all container nodes.
1952          * \note Must be first in the specific node struct.
1953          */
1954         struct ao2_container_node common;
1955         /*! Next node links in the list. */
1956         AST_DLLIST_ENTRY(hash_bucket_node) links;
1957         /*! Hash bucket holding the node. */
1958         int my_bucket;
1959 };
1960
1961 struct hash_bucket {
1962         /*! List of objects held in the bucket. */
1963         AST_DLLIST_HEAD_NOLOCK(, hash_bucket_node) list;
1964 #if defined(AST_DEVMODE)
1965         /*! Number of elements currently in the bucket. */
1966         int elements;
1967         /*! Maximum number of elements in the bucket. */
1968         int max_elements;
1969 #endif  /* defined(AST_DEVMODE) */
1970 };
1971
1972 /*!
1973  * A hash container in addition to values common to all
1974  * container types, stores the hash callback function, the
1975  * number of hash buckets, and the hash bucket heads.
1976  */
1977 struct ao2_container_hash {
1978         /*!
1979          * \brief Items common to all containers.
1980          * \note Must be first in the specific container struct.
1981          */
1982         struct ao2_container common;
1983         ao2_hash_fn *hash_fn;
1984         /*! Number of hash buckets in this container. */
1985         int n_buckets;
1986         /*! Hash bucket array of n_buckets.  Variable size. */
1987         struct hash_bucket buckets[0];
1988 };
1989
1990 /*!
1991  * \internal
1992  * \brief Create an empty copy of this container.
1993  * \since 12.0.0
1994  *
1995  * \param self Container to operate upon.
1996  *
1997  * \retval empty-clone-container on success.
1998  * \retval NULL on error.
1999  */
2000 static struct ao2_container *hash_ao2_alloc_empty_clone(struct ao2_container_hash *self)
2001 {
2002         struct astobj2 *orig_obj;
2003         unsigned int ao2_options;
2004
2005         /* Get container ao2 options. */
2006         orig_obj = INTERNAL_OBJ(self);
2007         if (!orig_obj) {
2008                 return NULL;
2009         }
2010         ao2_options = orig_obj->priv_data.options;
2011
2012         return ao2_t_container_alloc_hash(ao2_options, self->common.options, self->n_buckets,
2013                 self->hash_fn, self->common.sort_fn, self->common.cmp_fn, "Clone hash container");
2014 }
2015
2016 /*!
2017  * \internal
2018  * \brief Create an empty copy of this container. (Debug version)
2019  * \since 12.0.0
2020  *
2021  * \param self Container to operate upon.
2022  * \param tag used for debugging.
2023  * \param file Debug file name invoked from
2024  * \param line Debug line invoked from
2025  * \param func Debug function name invoked from
2026  * \param ref_debug TRUE if to output a debug reference message.
2027  *
2028  * \retval empty-clone-container on success.
2029  * \retval NULL on error.
2030  */
2031 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)
2032 {
2033         struct astobj2 *orig_obj;
2034         unsigned int ao2_options;
2035
2036         /* Get container ao2 options. */
2037         orig_obj = INTERNAL_OBJ(self);
2038         if (!orig_obj) {
2039                 return NULL;
2040         }
2041         ao2_options = orig_obj->priv_data.options;
2042
2043         return __ao2_container_alloc_hash_debug(ao2_options, self->common.options,
2044                 self->n_buckets, self->hash_fn, self->common.sort_fn, self->common.cmp_fn,
2045                 tag, file, line, func, ref_debug);
2046 }
2047
2048 /*!
2049  * \internal
2050  * \brief Destroy a hash container list node.
2051  * \since 12.0.0
2052  *
2053  * \param v_doomed Container node to destroy.
2054  *
2055  * \details
2056  * The container node unlinks itself from the container as part
2057  * of its destruction.  The node must be destroyed while the
2058  * container is already locked.
2059  *
2060  * \note The container must be locked when the node is
2061  * unreferenced.
2062  *
2063  * \return Nothing
2064  */
2065 static void hash_ao2_node_destructor(void *v_doomed)
2066 {
2067         struct hash_bucket_node *doomed = v_doomed;
2068
2069         if (doomed->common.is_linked) {
2070                 struct ao2_container_hash *my_container;
2071                 struct hash_bucket *bucket;
2072
2073                 /*
2074                  * Promote to write lock if not already there.  Since
2075                  * adjust_lock() can potentially release and block waiting for a
2076                  * write lock, care must be taken to ensure that node references
2077                  * are released before releasing the container references.
2078                  *
2079                  * Node references held by an iterator can only be held while
2080                  * the iterator also holds a reference to the container.  These
2081                  * node references must be unreferenced before the container can
2082                  * be unreferenced to ensure that the node will not get a
2083                  * negative reference and the destructor called twice for the
2084                  * same node.
2085                  */
2086                 my_container = (struct ao2_container_hash *) doomed->common.my_container;
2087                 adjust_lock(my_container, AO2_LOCK_REQ_WRLOCK, 1);
2088
2089 #if defined(AO2_DEBUG) && defined(AST_DEVMODE)
2090                 /*
2091                  * XXX chan_iax2 plays games with the hash function so we cannot
2092                  * routinely do an integrity check on this type of container.
2093                  * chan_iax2 should be changed to not abuse the hash function.
2094                  */
2095                 if (!my_container->common.destroying
2096                         && my_container->common.sort_fn
2097                         && ao2_container_check(doomed->common.my_container, OBJ_NOLOCK)) {
2098                         ast_log(LOG_ERROR, "Container integrity failed before node deletion.\n");
2099                 }
2100 #endif  /* defined(AO2_DEBUG) && defined(AST_DEVMODE) */
2101                 bucket = &my_container->buckets[doomed->my_bucket];
2102                 AST_DLLIST_REMOVE(&bucket->list, doomed, links);
2103                 AO2_DEVMODE_STAT(--my_container->common.nodes);
2104         }
2105
2106         /*
2107          * We could have an object in the node if the container is being
2108          * destroyed or the node had not been linked in yet.
2109          */
2110         if (doomed->common.obj) {
2111                 ao2_t_ref(doomed->common.obj, -1, "Container node destruction");
2112                 doomed->common.obj = NULL;
2113         }
2114 }
2115
2116 /*!
2117  * \internal
2118  * \brief Create a new container node.
2119  * \since 12.0.0
2120  *
2121  * \param self Container to operate upon.
2122  * \param obj_new Object to put into the node.
2123  * \param tag used for debugging.
2124  * \param file Debug file name invoked from
2125  * \param line Debug line invoked from
2126  * \param func Debug function name invoked from
2127  *
2128  * \retval initialized-node on success.
2129  * \retval NULL on error.
2130  */
2131 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)
2132 {
2133         struct hash_bucket_node *node;
2134         int i;
2135
2136         node = __ao2_alloc(sizeof(*node), hash_ao2_node_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
2137         if (!node) {
2138                 return NULL;
2139         }
2140
2141         i = abs(self->hash_fn(obj_new, OBJ_POINTER));
2142         i %= self->n_buckets;
2143
2144         if (tag) {
2145                 __ao2_ref_debug(obj_new, +1, tag, file, line, func);
2146         } else {
2147                 ao2_t_ref(obj_new, +1, "Container node creation");
2148         }
2149         node->common.obj = obj_new;
2150         node->common.my_container = (struct ao2_container *) self;
2151         node->my_bucket = i;
2152
2153         return node;
2154 }
2155
2156 /*!
2157  * \internal
2158  * \brief Insert a node into this container.
2159  * \since 12.0.0
2160  *
2161  * \param self Container to operate upon.
2162  * \param node Container node to insert into the container.
2163  *
2164  * \return enum ao2_container_insert value.
2165  */
2166 static enum ao2_container_insert hash_ao2_insert_node(struct ao2_container_hash *self, struct hash_bucket_node *node)
2167 {
2168         int cmp;
2169         struct hash_bucket *bucket;
2170         struct hash_bucket_node *cur;
2171         ao2_sort_fn *sort_fn;
2172         uint32_t options;
2173
2174         bucket = &self->buckets[node->my_bucket];
2175         sort_fn = self->common.sort_fn;
2176         options = self->common.options;
2177
2178         if (options & AO2_CONTAINER_ALLOC_OPT_INSERT_BEGIN) {
2179                 if (sort_fn) {
2180                         AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_BEGIN(&bucket->list, cur, links) {
2181                                 cmp = sort_fn(cur->common.obj, node->common.obj, OBJ_POINTER);
2182                                 if (cmp > 0) {
2183                                         continue;
2184                                 }
2185                                 if (cmp < 0) {
2186                                         AST_DLLIST_INSERT_AFTER_CURRENT(node, links);
2187                                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
2188                                 }
2189                                 switch (options & AO2_CONTAINER_ALLOC_OPT_DUPS_MASK) {
2190                                 default:
2191                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW:
2192                                         break;
2193                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT:
2194                                         /* Reject all objects with the same key. */
2195                                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
2196                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT:
2197                                         if (cur->common.obj == node->common.obj) {
2198                                                 /* Reject inserting the same object */
2199                                                 return AO2_CONTAINER_INSERT_NODE_REJECTED;
2200                                         }
2201                                         break;
2202                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE:
2203                                         SWAP(cur->common.obj, node->common.obj);
2204                                         return AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED;
2205                                 }
2206                         }
2207                         AST_DLLIST_TRAVERSE_BACKWARDS_SAFE_END;
2208                 }
2209                 AST_DLLIST_INSERT_HEAD(&bucket->list, node, links);
2210         } else {
2211                 if (sort_fn) {
2212                         AST_DLLIST_TRAVERSE_SAFE_BEGIN(&bucket->list, cur, links) {
2213                                 cmp = sort_fn(cur->common.obj, node->common.obj, OBJ_POINTER);
2214                                 if (cmp < 0) {
2215                                         continue;
2216                                 }
2217                                 if (cmp > 0) {
2218                                         AST_DLLIST_INSERT_BEFORE_CURRENT(node, links);
2219                                         return AO2_CONTAINER_INSERT_NODE_INSERTED;
2220                                 }
2221                                 switch (options & AO2_CONTAINER_ALLOC_OPT_DUPS_MASK) {
2222                                 default:
2223                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW:
2224                                         break;
2225                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT:
2226                                         /* Reject all objects with the same key. */
2227                                         return AO2_CONTAINER_INSERT_NODE_REJECTED;
2228                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT:
2229                                         if (cur->common.obj == node->common.obj) {
2230                                                 /* Reject inserting the same object */
2231                                                 return AO2_CONTAINER_INSERT_NODE_REJECTED;
2232                                         }
2233                                         break;
2234                                 case AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE:
2235                                         SWAP(cur->common.obj, node->common.obj);
2236                                         return AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED;
2237                                 }
2238                         }
2239                         AST_DLLIST_TRAVERSE_SAFE_END;
2240                 }
2241                 AST_DLLIST_INSERT_TAIL(&bucket->list, node, links);
2242         }
2243         return AO2_CONTAINER_INSERT_NODE_INSERTED;
2244 }
2245
2246 /*! Traversal state to restart a hash container traversal. */
2247 struct hash_traversal_state {
2248         /*! Active sort function in the traversal if not NULL. */
2249         ao2_sort_fn *sort_fn;
2250         /*! Node returned in the sorted starting hash bucket if OBJ_CONTINUE flag set. (Reffed) */
2251         struct hash_bucket_node *first_node;
2252         /*! Saved comparison callback arg pointer. */
2253         void *arg;
2254         /*! Starting hash bucket */
2255         int bucket_start;
2256         /*! Stopping hash bucket */
2257         int bucket_last;
2258         /*! Saved search flags to control traversing the container. */
2259         enum search_flags flags;
2260         /*! TRUE if it is a descending search */
2261         unsigned int descending:1;
2262         /*! TRUE if the starting bucket needs to be rechecked because of sorting skips. */
2263         unsigned int recheck_starting_bucket:1;
2264 };
2265
2266 struct hash_traversal_state_check {
2267         /*
2268          * If we have a division by zero compile error here then there
2269          * is not enough room for the state.  Increase AO2_TRAVERSAL_STATE_SIZE.
2270          */
2271         char check[1 / (AO2_TRAVERSAL_STATE_SIZE / sizeof(struct hash_traversal_state))];
2272 };
2273
2274 /*!
2275  * \internal
2276  * \brief Find the first hash container node in a traversal.
2277  * \since 12.0.0
2278  *
2279  * \param self Container to operate upon.
2280  * \param flags search_flags to control traversing the container
2281  * \param arg Comparison callback arg parameter.
2282  * \param state Traversal state to restart hash container traversal.
2283  *
2284  * \retval node-ptr of found node (Reffed).
2285  * \retval NULL when no node found.
2286  */
2287 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)
2288 {
2289         struct hash_bucket_node *node;
2290         int bucket_cur;
2291         int cmp;
2292
2293         memset(state, 0, sizeof(*state));
2294         state->arg = arg;
2295         state->flags = flags;
2296
2297         /* Determine traversal order. */
2298         switch (flags & OBJ_ORDER_MASK) {
2299         case OBJ_ORDER_POST:
2300         case OBJ_ORDER_DESCENDING:
2301                 state->descending = 1;
2302                 break;
2303         case OBJ_ORDER_PRE:
2304         case OBJ_ORDER_ASCENDING:
2305         default:
2306                 break;
2307         }
2308
2309         /*
2310          * If lookup by pointer or search key, run the hash and optional
2311          * sort functions.  Otherwise, traverse the whole container.
2312          */
2313         if (flags & (OBJ_POINTER | OBJ_KEY)) {
2314                 /* we know hash can handle this case */
2315                 bucket_cur = abs(self->hash_fn(arg, flags & (OBJ_POINTER | OBJ_KEY)));
2316                 bucket_cur %= self->n_buckets;
2317                 state->sort_fn = self->common.sort_fn;
2318         } else {
2319                 /* don't know, let's scan all buckets */
2320                 bucket_cur = -1;
2321                 state->sort_fn = (flags & OBJ_PARTIAL_KEY) ? self->common.sort_fn : NULL;
2322         }
2323
2324         if (state->descending) {
2325                 /*
2326                  * Determine the search boundaries of a descending traversal.
2327                  *
2328                  * bucket_cur downto state->bucket_last
2329                  */
2330                 if (bucket_cur < 0) {
2331                         bucket_cur = self->n_buckets - 1;
2332                         state->bucket_last = 0;
2333                 } else {
2334                         state->bucket_last = bucket_cur;
2335                 }
2336                 if (flags & OBJ_CONTINUE) {
2337                         state->bucket_last = 0;
2338                         if (state->sort_fn) {
2339                                 state->recheck_starting_bucket = 1;
2340                         }
2341                 }
2342                 state->bucket_start = bucket_cur;
2343
2344                 /* For each bucket */
2345                 for (; state->bucket_last <= bucket_cur; --bucket_cur) {
2346                         /* For each node in the bucket. */
2347                         for (node = AST_DLLIST_LAST(&self->buckets[bucket_cur].list);
2348                                 node;
2349                                 node = AST_DLLIST_PREV(node, links)) {
2350                                 if (!node->common.obj) {
2351                                         /* Node is empty */
2352                                         continue;
2353                                 }
2354
2355                                 if (state->sort_fn) {
2356                                         /* Filter node through the sort_fn */
2357                                         cmp = state->sort_fn(node->common.obj, arg,
2358                                                 flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY));
2359                                         if (cmp > 0) {
2360                                                 continue;
2361                                         }
2362                                         if (flags & OBJ_CONTINUE) {
2363                                                 /* Remember first node when we wrap around. */
2364                                                 __ao2_ref(node, +1);
2365                                                 state->first_node = node;
2366
2367                                                 /* From now on all nodes are matching */
2368                                                 state->sort_fn = NULL;
2369                                         } else if (cmp < 0) {
2370                                                 /* No more nodes in this bucket are possible to match. */
2371                                                 break;
2372                                         }
2373                                 }
2374
2375                                 /* We have the first traversal node */
2376                                 __ao2_ref(node, +1);
2377                                 return node;
2378                         }
2379
2380                         /* Was this the starting bucket? */
2381                         if (bucket_cur == state->bucket_start
2382                                 && (flags & OBJ_CONTINUE)
2383                                 && (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY))) {
2384                                 /* In case the bucket was empty or none of the nodes matched. */
2385                                 state->sort_fn = NULL;
2386                         }
2387
2388                         /* Was this the first container bucket? */
2389                         if (bucket_cur == 0
2390                                 && (flags & OBJ_CONTINUE)
2391                                 && (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY))) {
2392                                 /* Move to the end to ensure we check every bucket */
2393                                 bucket_cur = self->n_buckets;
2394                                 state->bucket_last = state->bucket_start + 1;
2395                                 if (state->recheck_starting_bucket) {
2396                                         /*
2397                                          * We have to recheck the first part of the starting bucket
2398                                          * because of sorting skips.
2399                                          */
2400                                         state->recheck_starting_bucket = 0;
2401                                         --state->bucket_last;
2402                                 }
2403                         }
2404                 }
2405         } else {
2406                 /*
2407                  * Determine the search boundaries of an ascending traversal.
2408                  *
2409                  * bucket_cur to state->bucket_last-1
2410                  */
2411                 if (bucket_cur < 0) {
2412                         bucket_cur = 0;
2413                         state->bucket_last = self->n_buckets;
2414                 } else {
2415                         state->bucket_last = bucket_cur + 1;
2416                 }
2417                 if (flags & OBJ_CONTINUE) {
2418                         state->bucket_last = self->n_buckets;
2419                         if (state->sort_fn) {
2420                                 state->recheck_starting_bucket = 1;
2421                         }
2422                 }
2423                 state->bucket_start = bucket_cur;
2424
2425                 /* For each bucket */
2426                 for (; bucket_cur < state->bucket_last; ++bucket_cur) {
2427                         /* For each node in the bucket. */
2428                         for (node = AST_DLLIST_FIRST(&self->buckets[bucket_cur].list);
2429                                 node;
2430                                 node = AST_DLLIST_NEXT(node, links)) {
2431                                 if (!node->common.obj) {
2432                                         /* Node is empty */
2433                                         continue;
2434                                 }
2435
2436                                 if (state->sort_fn) {
2437                                         /* Filter node through the sort_fn */
2438                                         cmp = state->sort_fn(node->common.obj, arg,
2439                                                 flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY));
2440                                         if (cmp < 0) {
2441                                                 continue;
2442                                         }
2443                                         if (flags & OBJ_CONTINUE) {
2444                                                 /* Remember first node when we wrap around. */
2445                                                 __ao2_ref(node, +1);
2446                                                 state->first_node = node;
2447
2448                                                 /* From now on all nodes are matching */
2449                                                 state->sort_fn = NULL;
2450                                         } else if (cmp > 0) {
2451                                                 /* No more nodes in this bucket are possible to match. */
2452                                                 break;
2453                                         }
2454                                 }
2455
2456                                 /* We have the first traversal node */
2457                                 __ao2_ref(node, +1);
2458                                 return node;
2459                         }
2460
2461                         /* Was this the starting bucket? */
2462                         if (bucket_cur == state->bucket_start
2463                                 && (flags & OBJ_CONTINUE)
2464                                 && (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY))) {
2465                                 /* In case the bucket was empty or none of the nodes matched. */
2466                                 state->sort_fn = NULL;
2467                         }
2468
2469                         /* Was this the last container bucket? */
2470                         if (bucket_cur == self->n_buckets - 1
2471                                 && (flags & OBJ_CONTINUE)
2472                                 && (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY))) {
2473                                 /* Move to the beginning to ensure we check every bucket */
2474                                 bucket_cur = -1;
2475                                 state->bucket_last = state->bucket_start;
2476                                 if (state->recheck_starting_bucket) {
2477                                         /*
2478                                          * We have to recheck the first part of the starting bucket
2479                                          * because of sorting skips.
2480                                          */
2481                                         state->recheck_starting_bucket = 0;
2482                                         ++state->bucket_last;
2483                                 }
2484                         }
2485                 }
2486         }
2487
2488         return NULL;
2489 }
2490
2491 /*!
2492  * \internal
2493  * \brief Find the next hash container node in a traversal.
2494  * \since 12.0.0
2495  *
2496  * \param self Container to operate upon.
2497  * \param state Traversal state to restart hash container traversal.
2498  * \param prev Previous node returned by the traversal search functions.
2499  *    The ref ownership is passed back to this function.
2500  *
2501  * \retval node-ptr of found node (Reffed).
2502  * \retval NULL when no node found.
2503  */
2504 static struct hash_bucket_node *hash_ao2_find_next(struct ao2_container_hash *self, struct hash_traversal_state *state, struct hash_bucket_node *prev)
2505 {
2506         struct hash_bucket_node *node;
2507         void *arg;
2508         enum search_flags flags;
2509         int bucket_cur;
2510         int cmp;
2511
2512         arg = state->arg;
2513         flags = state->flags;
2514         bucket_cur = prev->my_bucket;
2515         node = prev;
2516
2517         /*
2518          * This function is structured the same as hash_ao2_find_first()
2519          * intentionally.  We are resuming the search loops from
2520          * hash_ao2_find_first() in order to find the next node.  The
2521          * search loops must be resumed where hash_ao2_find_first()
2522          * returned with the first node.
2523          */
2524         if (state->descending) {
2525                 goto hash_descending_resume;
2526
2527                 /* For each bucket */
2528                 for (; state->bucket_last <= bucket_cur; --bucket_cur) {
2529                         /* For each node in the bucket. */
2530                         for (node = AST_DLLIST_LAST(&self->buckets[bucket_cur].list);
2531                                 node;
2532                                 node = AST_DLLIST_PREV(node, links)) {
2533                                 if (node == state->first_node) {
2534                                         /* We have wrapped back to the starting point. */
2535                                         __ao2_ref(prev, -1);
2536                                         return NULL;
2537                                 }
2538                                 if (!node->common.obj) {
2539                                         /* Node is empty */
2540                                         continue;
2541                                 }
2542
2543                                 if (state->sort_fn) {
2544                                         /* Filter node through the sort_fn */
2545                                         cmp = state->sort_fn(node->common.obj, arg,
2546                                                 flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY));
2547                                         if (cmp > 0) {
2548                                                 continue;
2549                                         }
2550                                         if (cmp < 0) {
2551                                                 /* No more nodes in this bucket are possible to match. */
2552                                                 break;
2553                                         }
2554                                 }
2555
2556                                 /* We have the next traversal node */
2557                                 __ao2_ref(node, +1);
2558
2559                                 /*
2560                                  * Dereferencing the prev node may result in our next node
2561                                  * object being removed by another thread.  This could happen if
2562                                  * the container uses RW locks and the container was read
2563                                  * locked.
2564                                  */
2565                                 __ao2_ref(prev, -1);
2566                                 if (node->common.obj) {
2567                                         return node;
2568                                 }
2569                                 prev = node;
2570
2571 hash_descending_resume:;
2572                         }
2573
2574                         /* Was this the first container bucket? */
2575                         if (bucket_cur == 0
2576                                 && (flags & OBJ_CONTINUE)
2577                                 && (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY))) {
2578                                 /* Move to the end to ensure we check every bucket */
2579                                 bucket_cur = self->n_buckets;
2580                                 state->bucket_last = state->bucket_start + 1;
2581                                 if (state->recheck_starting_bucket) {
2582                                         /*
2583                                          * We have to recheck the first part of the starting bucket
2584                                          * because of sorting skips.
2585                                          */
2586                                         state->recheck_starting_bucket = 0;
2587                                         --state->bucket_last;
2588                                 }
2589                         }
2590                 }
2591         } else {
2592                 goto hash_ascending_resume;
2593
2594                 /* For each bucket */
2595                 for (; bucket_cur < state->bucket_last; ++bucket_cur) {
2596                         /* For each node in the bucket. */
2597                         for (node = AST_DLLIST_FIRST(&self->buckets[bucket_cur].list);
2598                                 node;
2599                                 node = AST_DLLIST_NEXT(node, links)) {
2600                                 if (node == state->first_node) {
2601                                         /* We have wrapped back to the starting point. */
2602                                         __ao2_ref(prev, -1);
2603                                         return NULL;
2604                                 }
2605                                 if (!node->common.obj) {
2606                                         /* Node is empty */
2607                                         continue;
2608                                 }
2609
2610                                 if (state->sort_fn) {
2611                                         /* Filter node through the sort_fn */
2612                                         cmp = state->sort_fn(node->common.obj, arg,
2613                                                 flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY));
2614                                         if (cmp < 0) {
2615                                                 continue;
2616                                         }
2617                                         if (cmp > 0) {
2618                                                 /* No more nodes in this bucket are possible to match. */
2619                                                 break;
2620                                         }
2621                                 }
2622
2623                                 /* We have the next traversal node */
2624                                 __ao2_ref(node, +1);
2625
2626                                 /*
2627                                  * Dereferencing the prev node may result in our next node
2628                                  * object being removed by another thread.  This could happen if
2629                                  * the container uses RW locks and the container was read
2630                                  * locked.
2631                                  */
2632                                 __ao2_ref(prev, -1);
2633                                 if (node->common.obj) {
2634                                         return node;
2635                                 }
2636                                 prev = node;
2637
2638 hash_ascending_resume:;
2639                         }
2640
2641                         /* Was this the last container bucket? */
2642                         if (bucket_cur == self->n_buckets - 1
2643                                 && (flags & OBJ_CONTINUE)
2644                                 && (flags & (OBJ_POINTER | OBJ_KEY | OBJ_PARTIAL_KEY))) {
2645                                 /* Move to the beginning to ensure we check every bucket */
2646                                 bucket_cur = -1;
2647                                 state->bucket_last = state->bucket_start;
2648                                 if (state->recheck_starting_bucket) {
2649                                         /*
2650                                          * We have to recheck the first part of the starting bucket
2651                                          * because of sorting skips.
2652                                          */
2653                                         state->recheck_starting_bucket = 0;
2654                                         ++state->bucket_last;
2655                                 }
2656                         }
2657                 }
2658         }
2659
2660         /* No more nodes in the container left to traverse. */
2661         __ao2_ref(prev, -1);
2662         return NULL;
2663 }
2664
2665 /*!
2666  * \internal
2667  * \brief Cleanup the hash container traversal state.
2668  * \since 12.0.0
2669  *
2670  * \param state Traversal state to cleanup.
2671  *
2672  * \return Nothing
2673  */
2674 static void hash_ao2_find_cleanup(struct hash_traversal_state *state)
2675 {
2676         if (state->first_node) {
2677                 __ao2_ref(state->first_node, -1);
2678         }
2679 }
2680
2681 /*!
2682  * \internal
2683  * \brief Find the next non-empty iteration node in the container.
2684  * \since 12.0.0
2685  *
2686  * \param self Container to operate upon.
2687  * \param node Previous node returned by the iterator.
2688  * \param flags search_flags to control iterating the container.
2689  *   Only AO2_ITERATOR_DESCENDING is useful by the method.
2690  *
2691  * \note The container is already locked.
2692  *
2693  * \retval node on success.
2694  * \retval NULL on error or no more nodes in the container.
2695  */
2696 static struct hash_bucket_node *hash_ao2_iterator_next(struct ao2_container_hash *self, struct hash_bucket_node *node, enum ao2_iterator_flags flags)
2697 {
2698         int cur_bucket;
2699
2700         if (flags & AO2_ITERATOR_DESCENDING) {
2701                 if (node) {
2702                         cur_bucket = node->my_bucket;
2703
2704                         /* Find next non-empty node. */
2705                         for (;;) {
2706                                 node = AST_DLLIST_PREV(node, links);
2707                                 if (!node) {
2708                                         break;
2709                                 }
2710                                 if (node->common.obj) {
2711                                         /* Found a non-empty node. */
2712                                         return node;
2713                                 }
2714                         }
2715                 } else {
2716                         /* Find first non-empty node. */
2717                         cur_bucket = self->n_buckets;
2718                 }
2719
2720                 /* Find a non-empty node in the remaining buckets */
2721                 while (0 <= --cur_bucket) {
2722                         node = AST_DLLIST_LAST(&self->buckets[cur_bucket].list);
2723                         while (node) {
2724                                 if (node->common.obj) {
2725                                         /* Found a non-empty node. */
2726                                         return node;
2727                                 }
2728                                 node = AST_DLLIST_PREV(node, links);
2729                         }
2730                 }
2731         } else {
2732                 if (node) {
2733                         cur_bucket = node->my_bucket;
2734
2735                         /* Find next non-empty node. */
2736                         for (;;) {
2737                                 node = AST_DLLIST_NEXT(node, links);
2738                                 if (!node) {
2739                                         break;
2740                                 }
2741                                 if (node->common.obj) {
2742                                         /* Found a non-empty node. */
2743                                         return node;
2744                                 }
2745                         }
2746                 } else {
2747                         /* Find first non-empty node. */
2748                         cur_bucket = -1;
2749                 }
2750
2751                 /* Find a non-empty node in the remaining buckets */
2752                 while (++cur_bucket < self->n_buckets) {
2753                         node = AST_DLLIST_FIRST(&self->buckets[cur_bucket].list);
2754                         while (node) {
2755                                 if (node->common.obj) {
2756                                         /* Found a non-empty node. */
2757                                         return node;
2758                                 }
2759                                 node = AST_DLLIST_NEXT(node, links);
2760                         }
2761                 }
2762         }
2763
2764         /* No more nodes to visit in the container. */
2765         return NULL;
2766 }
2767
2768 #if defined(AST_DEVMODE)
2769 /*!
2770  * \internal
2771  * \brief Increment the hash container linked object statistic.
2772  * \since 12.0.0
2773  *
2774  * \param hash Container to operate upon.
2775  * \param hash_node Container node linking object to.
2776  *
2777  * \return Nothing
2778  */
2779 static void hash_ao2_link_node_stat(struct ao2_container *hash, struct ao2_container_node *hash_node)
2780 {
2781         struct ao2_container_hash *self = (struct ao2_container_hash *) hash;
2782         struct hash_bucket_node *node = (struct hash_bucket_node *) hash_node;
2783         int i = node->my_bucket;
2784
2785         ++self->buckets[i].elements;
2786         if (self->buckets[i].max_elements < self->buckets[i].elements) {
2787                 self->buckets[i].max_elements = self->buckets[i].elements;
2788         }
2789 }
2790 #endif  /* defined(AST_DEVMODE) */
2791
2792 #if defined(AST_DEVMODE)
2793 /*!
2794  * \internal
2795  * \brief Decrement the hash container linked object statistic.
2796  * \since 12.0.0
2797  *
2798  * \param hash Container to operate upon.
2799  * \param hash_node Container node unlinking object from.
2800  *
2801  * \return Nothing
2802  */
2803 static void hash_ao2_unlink_node_stat(struct ao2_container *hash, struct ao2_container_node *hash_node)
2804 {
2805         struct ao2_container_hash *self = (struct ao2_container_hash *) hash;
2806         struct hash_bucket_node *node = (struct hash_bucket_node *) hash_node;
2807
2808         --self->buckets[node->my_bucket].elements;
2809 }
2810 #endif  /* defined(AST_DEVMODE) */
2811
2812 /*!
2813  * \internal
2814  *
2815  * \brief Destroy this container.
2816  * \since 12.0.0
2817  *
2818  * \param self Container to operate upon.
2819  *
2820  * \return Nothing
2821  */
2822 static void hash_ao2_destroy(struct ao2_container_hash *self)
2823 {
2824         int idx;
2825
2826         /* Check that the container no longer has any nodes */
2827         for (idx = self->n_buckets; idx--;) {
2828                 if (!AST_DLLIST_EMPTY(&self->buckets[idx].list)) {
2829                         ast_log(LOG_ERROR, "Node ref leak.  Hash container still has nodes!\n");
2830                         ast_assert(0);
2831                         break;
2832                 }
2833         }
2834 }
2835
2836 #if defined(AST_DEVMODE)
2837 /*!
2838  * \internal
2839  * \brief Display contents of the specified container.
2840  * \since 12.0.0
2841  *
2842  * \param self Container to dump.
2843  * \param where User data needed by prnt to determine where to put output.
2844  * \param prnt Print output callback function to use.
2845  * \param prnt_obj Callback function to print the given object's key. (NULL if not available)
2846  *
2847  * \return Nothing
2848  */
2849 static void hash_ao2_dump(struct ao2_container_hash *self, void *where, ao2_prnt_fn *prnt, ao2_prnt_obj_fn *prnt_obj)
2850 {
2851 #define FORMAT  "%6s, %16s, %16s, %16s, %16s, %s\n"
2852 #define FORMAT2 "%6d, %16p, %16p, %16p, %16p, "
2853
2854         int bucket;
2855         int suppressed_buckets = 0;
2856         struct hash_bucket_node *node;
2857
2858         prnt(where, "Number of buckets: %d\n\n", self->n_buckets);
2859
2860         prnt(where, FORMAT, "Bucket", "Node", "Prev", "Next", "Obj", "Key");
2861         for (bucket = 0; bucket < self->n_buckets; ++bucket) {
2862                 node = AST_DLLIST_FIRST(&self->buckets[bucket].list);
2863                 if (node) {
2864                         suppressed_buckets = 0;
2865                         do {
2866                                 prnt(where, FORMAT2,
2867                                         bucket,
2868                                         node,
2869                                         AST_DLLIST_PREV(node, links),
2870                                         AST_DLLIST_NEXT(node, links),
2871                                         node->common.obj);
2872                                 if (node->common.obj && prnt_obj) {
2873                                         prnt_obj(node->common.obj, where, prnt);
2874                                 }
2875                                 prnt(where, "\n");
2876
2877                                 node = AST_DLLIST_NEXT(node, links);
2878                         } while (node);
2879                 } else if (!suppressed_buckets) {
2880                         suppressed_buckets = 1;
2881                         prnt(where, "...\n");
2882                 }
2883         }
2884
2885 #undef FORMAT
2886 #undef FORMAT2
2887 }
2888 #endif  /* defined(AST_DEVMODE) */
2889
2890 #if defined(AST_DEVMODE)
2891 /*!
2892  * \internal
2893  * \brief Display statistics of the specified container.
2894  * \since 12.0.0
2895  *
2896  * \param self Container to display statistics.
2897  * \param where User data needed by prnt to determine where to put output.
2898  * \param prnt Print output callback function to use.
2899  *
2900  * \note The container is already locked for reading.
2901  *
2902  * \return Nothing
2903  */
2904 static void hash_ao2_stats(struct ao2_container_hash *self, void *where, ao2_prnt_fn *prnt)
2905 {
2906 #define FORMAT  "%10.10s %10.10s %10.10s\n"
2907 #define FORMAT2 "%10d %10d %10d\n"
2908
2909         int bucket;
2910         int suppressed_buckets = 0;
2911
2912         prnt(where, "Number of buckets: %d\n\n", self->n_buckets);
2913
2914         prnt(where, FORMAT, "Bucket", "Objects", "Max");
2915         for (bucket = 0; bucket < self->n_buckets; ++bucket) {
2916                 if (self->buckets[bucket].max_elements) {
2917                         suppressed_buckets = 0;
2918                         prnt(where, FORMAT2, bucket, self->buckets[bucket].elements,
2919                                 self->buckets[bucket].max_elements);
2920                 } else if (!suppressed_buckets) {
2921                         suppressed_buckets = 1;
2922                         prnt(where, "...\n");
2923                 }
2924         }
2925
2926 #undef FORMAT
2927 #undef FORMAT2
2928 }
2929 #endif  /* defined(AST_DEVMODE) */
2930
2931 #if defined(AST_DEVMODE)
2932 /*!
2933  * \internal
2934  * \brief Perform an integrity check on the specified container.
2935  * \since 12.0.0
2936  *
2937  * \param self Container to check integrity.
2938  *
2939  * \note The container is already locked for reading.
2940  *
2941  * \retval 0 on success.
2942  * \retval -1 on error.
2943  */
2944 static int hash_ao2_integrity(struct ao2_container_hash *self)
2945 {
2946         int bucket_exp;
2947         int bucket;
2948         int count_obj;
2949         int count_total_obj;
2950         int count_total_node;
2951         void *obj_last;
2952         struct hash_bucket_node *node;
2953         struct hash_bucket_node *prev;
2954         struct hash_bucket_node *next;
2955
2956         count_total_obj = 0;
2957         count_total_node = 0;
2958
2959         /* For each bucket in the container. */
2960         for (bucket = 0; bucket < self->n_buckets; ++bucket) {
2961                 if (!AST_DLLIST_FIRST(&self->buckets[bucket].list)
2962                         && !AST_DLLIST_LAST(&self->buckets[bucket].list)) {
2963                         /* The bucket list is empty. */
2964                         continue;
2965                 }
2966
2967                 count_obj = 0;
2968                 obj_last = NULL;
2969
2970                 /* Check bucket list links and nodes. */
2971                 node = AST_DLLIST_LAST(&self->buckets[bucket].list);
2972                 if (!node) {
2973                         ast_log(LOG_ERROR, "Bucket %d list tail is NULL when it should not be!\n",
2974                                 bucket);
2975                         return -1;
2976                 }
2977                 if (AST_DLLIST_NEXT(node, links)) {
2978                         ast_log(LOG_ERROR, "Bucket %d list tail node is not the last node!\n",
2979                                 bucket);
2980                         return -1;
2981                 }
2982                 node = AST_DLLIST_FIRST(&self->buckets[bucket].list);
2983                 if (!node) {
2984                         ast_log(LOG_ERROR, "Bucket %d list head is NULL when it should not be!\n",
2985                                 bucket);
2986                         return -1;
2987                 }
2988                 if (AST_DLLIST_PREV(node, links)) {
2989                         ast_log(LOG_ERROR, "Bucket %d list head node is not the first node!\n",
2990                                 bucket);
2991                         return -1;
2992                 }
2993                 for (; node; node = next) {
2994                         /* Check backward link. */
2995                         prev = AST_DLLIST_PREV(node, links);
2996                         if (prev) {
2997                                 if (prev == node) {
2998                                         ast_log(LOG_ERROR, "Bucket %d list node's prev pointer points to itself!\n",
2999                                                 bucket);
3000                                         return -1;
3001                                 }
3002                                 if (node != AST_DLLIST_NEXT(prev, links)) {
3003                                         ast_log(LOG_ERROR, "Bucket %d list node's prev node does not link back!\n",
3004                                                 bucket);
3005                                         return -1;
3006                                 }
3007                         } else if (node != AST_DLLIST_FIRST(&self->buckets[bucket].list)) {
3008                                 ast_log(LOG_ERROR, "Bucket %d backward list chain is broken!\n",
3009                                         bucket);
3010                                 return -1;
3011                         }
3012
3013                         /* Check forward link. */
3014                         next = AST_DLLIST_NEXT(node, links);
3015                         if (next) {
3016                                 if (next == node) {
3017                                         ast_log(LOG_ERROR, "Bucket %d list node's next pointer points to itself!\n",
3018                                                 bucket);
3019                                         return -1;
3020                                 }
3021                                 if (node != AST_DLLIST_PREV(next, links)) {
3022                                         ast_log(LOG_ERROR, "Bucket %d list node's next node does not link back!\n",
3023                                                 bucket);
3024                                         return -1;
3025                                 }
3026                         } else if (node != AST_DLLIST_LAST(&self->buckets[bucket].list)) {
3027                                 ast_log(LOG_ERROR, "Bucket %d forward list chain is broken!\n",
3028                                         bucket);
3029                                 return -1;
3030                         }
3031
3032                         if (bucket != node->my_bucket) {
3033                                 ast_log(LOG_ERROR, "Bucket %d node claims to be in bucket %d!\n",
3034                                         bucket, node->my_bucket);
3035                                 return -1;
3036                         }
3037
3038                         ++count_total_node;
3039                         if (!node->common.obj) {
3040                                 /* Node is empty. */
3041                                 continue;
3042                         }
3043                         ++count_obj;
3044
3045                         /* Check container hash key for expected bucket. */
3046                         bucket_exp = abs(self->hash_fn(node->common.obj, OBJ_POINTER));
3047                         bucket_exp %= self->n_buckets;
3048                         if (bucket != bucket_exp) {
3049                                 ast_log(LOG_ERROR, "Bucket %d node hashes to bucket %d!\n",
3050                                         bucket, bucket_exp);
3051                                 return -1;
3052                         }
3053
3054                         /* Check sort if configured. */
3055                         if (self->common.sort_fn) {
3056                                 if (obj_last
3057                                         && self->common.sort_fn(obj_last, node->common.obj, OBJ_POINTER) > 0) {
3058                                         ast_log(LOG_ERROR, "Bucket %d nodes out of sorted order!\n",
3059                                                 bucket);
3060                                         return -1;
3061                                 }
3062                                 obj_last = node->common.obj;
3063                         }
3064                 }
3065
3066                 /* Check bucket obj count statistic. */
3067                 if (count_obj != self->buckets[bucket].elements) {
3068                         ast_log(LOG_ERROR, "Bucket %d object count of %d does not match stat of %d!\n",
3069                                 bucket, count_obj, self->buckets[bucket].elements);
3070                         return -1;
3071                 }
3072
3073                 /* Accumulate found object counts. */
3074                 count_total_obj += count_obj;
3075         }
3076
3077         /* Check total obj count. */
3078         if (count_total_obj != ao2_container_count(&self->common)) {
3079                 ast_log(LOG_ERROR,
3080                         "Total object count of %d does not match ao2_container_count() of %d!\n",
3081                         count_total_obj, ao2_container_count(&self->common));
3082                 return -1;
3083         }
3084
3085         /* Check total node count. */
3086         if (count_total_node != self->common.nodes) {
3087                 ast_log(LOG_ERROR, "Total node count of %d does not match stat of %d!\n",
3088                         count_total_node, self->common.nodes);
3089                 return -1;
3090         }
3091
3092         return 0;
3093 }
3094 #endif  /* defined(AST_DEVMODE) */
3095
3096 /*! Hash container virtual method table. */
3097 static const struct ao2_container_methods v_table_hash = {
3098         .type = AO2_CONTAINER_RTTI_HASH,
3099         .alloc_empty_clone = (ao2_container_alloc_empty_clone_fn) hash_ao2_alloc_empty_clone,
3100         .alloc_empty_clone_debug =
3101                 (ao2_container_alloc_empty_clone_debug_fn) hash_ao2_alloc_empty_clone_debug,
3102         .new_node = (ao2_container_new_node_fn) hash_ao2_new_node,
3103         .insert = (ao2_container_insert_fn) hash_ao2_insert_node,
3104         .traverse_first = (ao2_container_find_first_fn) hash_ao2_find_first,
3105         .traverse_next = (ao2_container_find_next_fn) hash_ao2_find_next,
3106         .traverse_cleanup = (ao2_container_find_cleanup_fn) hash_ao2_find_cleanup,
3107         .iterator_next = (ao2_iterator_next_fn) hash_ao2_iterator_next,
3108         .destroy = (ao2_container_destroy_fn) hash_ao2_destroy,
3109 #if defined(AST_DEVMODE)
3110         .dump = (ao2_container_display) hash_ao2_dump,
3111         .stats = (ao2_container_statistics) hash_ao2_stats,
3112         .integrity = (ao2_container_integrity) hash_ao2_integrity,
3113 #endif  /* defined(AST_DEVMODE) */
3114 };
3115
3116 /*!
3117  * \brief always zero hash function
3118  *
3119  * it is convenient to have a hash function that always returns 0.
3120  * This is basically used when we want to have a container that is
3121  * a simple linked list.
3122  *
3123  * \returns 0
3124  */
3125 static int hash_zero(const void *user_obj, const int flags)
3126 {
3127         return 0;
3128 }
3129
3130 /*!
3131  * \brief Initialize a hash container with the desired number of buckets.
3132  *
3133  * \param self Container to initialize.
3134  * \param options Container behaviour options (See enum ao2_container_opts)
3135  * \param n_buckets Number of buckets for hash
3136  * \param hash_fn Pointer to a function computing a hash value.
3137  * \param sort_fn Pointer to a sort function.
3138  * \param cmp_fn Pointer to a compare function used by ao2_find.
3139  *
3140  * \return A pointer to a struct container.
3141  */
3142 static struct ao2_container *hash_ao2_container_init(
3143         struct ao2_container_hash *self, unsigned int options, unsigned int n_buckets,
3144         ao2_hash_fn *hash_fn, ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn)
3145 {
3146         if (!self) {
3147                 return NULL;
3148         }
3149
3150         self->common.v_table = &v_table_hash;
3151         self->common.sort_fn = sort_fn;
3152         self->common.cmp_fn = cmp_fn;
3153         self->common.options = options;
3154         self->hash_fn = hash_fn ? hash_fn : hash_zero;
3155         self->n_buckets = n_buckets;
3156
3157 #ifdef AO2_DEBUG
3158         ast_atomic_fetchadd_int(&ao2.total_containers, 1);
3159 #endif
3160
3161         return (struct ao2_container *) self;
3162 }
3163
3164 struct ao2_container *__ao2_container_alloc_hash(unsigned int ao2_options,
3165         unsigned int container_options, unsigned int n_buckets, ao2_hash_fn *hash_fn,
3166         ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn)
3167 {
3168         unsigned int num_buckets;
3169         size_t container_size;
3170         struct ao2_container_hash *self;
3171
3172         num_buckets = hash_fn ? n_buckets : 1;
3173         container_size = sizeof(struct ao2_container_hash) + num_buckets * sizeof(struct hash_bucket);
3174
3175         self = ao2_t_alloc_options(container_size, container_destruct, ao2_options,
3176                 "New hash container");
3177         return hash_ao2_container_init(self, container_options, num_buckets,
3178                 hash_fn, sort_fn, cmp_fn);
3179 }
3180
3181 struct ao2_container *__ao2_container_alloc_hash_debug(unsigned int ao2_options,