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