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