astobj2: Add backtrace to log_bad_ao2.
[asterisk/asterisk.git] / main / astobj2_container.c
1 /* astobj2 - replacement containers for asterisk data structures.
2  *
3  * Copyright (C) 2006 Marta Carbone, Luigi Rizzo - Univ. di Pisa, Italy
4  *
5  * See http://www.asterisk.org for more information about
6  * the Asterisk project. Please do not directly contact
7  * any of the maintainers of this project for assistance;
8  * the project provides a web site, mailing lists and IRC
9  * channels for your use.
10  *
11  * This program is free software, distributed under the terms of
12  * the GNU General Public License Version 2. See the LICENSE file
13  * at the top of the source tree.
14  */
15
16 /*! \file
17  *
18  * \brief Functions implementing astobj2 objects.
19  *
20  * \author Richard Mudgett <rmudgett@digium.com>
21  */
22
23 #include "asterisk.h"
24
25 ASTERISK_REGISTER_FILE()
26
27 #include "asterisk/_private.h"
28 #include "asterisk/astobj2.h"
29 #include "astobj2_private.h"
30 #include "astobj2_container_private.h"
31 #include "asterisk/cli.h"
32
33 /*!
34  * return the number of elements in the container
35  */
36 int ao2_container_count(struct ao2_container *c)
37 {
38         return ast_atomic_fetchadd_int(&c->elements, 0);
39 }
40
41 int __container_unlink_node_debug(struct ao2_container_node *node, uint32_t flags,
42         const char *tag, const char *file, int line, const char *func)
43 {
44         struct ao2_container *container = node->my_container;
45
46         if (container == NULL && (flags & AO2_UNLINK_NODE_DEC_COUNT)) {
47                 return 0;
48         }
49
50         if ((flags & AO2_UNLINK_NODE_UNLINK_OBJECT)
51                 && !(flags & AO2_UNLINK_NODE_NOUNREF_OBJECT)) {
52                 __ao2_ref(node->obj, -1, tag ?: "Remove obj from container", file, line, func);
53         }
54
55         node->obj = NULL;
56
57         if (flags & AO2_UNLINK_NODE_DEC_COUNT) {
58                 ast_atomic_fetchadd_int(&container->elements, -1);
59 #if defined(AO2_DEBUG)
60                 {
61                         int empty = container->nodes - container->elements;
62
63                         if (container->max_empty_nodes < empty) {
64                                 container->max_empty_nodes = empty;
65                         }
66                         if (container->v_table->unlink_stat) {
67                                 container->v_table->unlink_stat(container, node);
68                         }
69                 }
70 #endif  /* defined(AO2_DEBUG) */
71         }
72
73         if (flags & AO2_UNLINK_NODE_UNREF_NODE) {
74                 /* Remove node from container */
75                 ao2_t_ref(node, -1, NULL);
76         }
77
78         return 1;
79 }
80
81 /*!
82  * \internal
83  * \brief Link an object into this container.  (internal)
84  *
85  * \param self Container to operate upon.
86  * \param obj_new Object to insert into the container.
87  * \param flags search_flags to control linking the object.  (OBJ_NOLOCK)
88  * \param tag used for debugging.
89  * \param file Debug file name invoked from
90  * \param line Debug line invoked from
91  * \param func Debug function name invoked from
92  *
93  * \retval 0 on errors.
94  * \retval 1 on success.
95  */
96 int __ao2_link(struct ao2_container *self, void *obj_new, int flags,
97         const char *tag, const char *file, int line, const char *func)
98 {
99         int res;
100         enum ao2_lock_req orig_lock;
101         struct ao2_container_node *node;
102
103         if (!__is_ao2_object(obj_new, file, line, func)
104                 || !__is_ao2_object(self, file, line, func)) {
105                 return 0;
106         }
107
108         if (!self->v_table || !self->v_table->new_node || !self->v_table->insert) {
109                 /* Sanity checks. */
110                 __ast_assert_failed(0, "invalid container v_table", file, line, func);
111                 return 0;
112         }
113
114         if (flags & OBJ_NOLOCK) {
115                 orig_lock = __adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
116         } else {
117                 ao2_wrlock(self);
118                 orig_lock = AO2_LOCK_REQ_MUTEX;
119         }
120
121         res = 0;
122         node = self->v_table->new_node(self, obj_new, tag, file, line, func);
123         if (node) {
124 #if defined(AO2_DEBUG)
125                 if (ao2_container_check(self, OBJ_NOLOCK)) {
126                         ast_log(LOG_ERROR, "Container integrity failed before insert.\n");
127                 }
128 #endif  /* defined(AO2_DEBUG) */
129
130                 /* Insert the new node. */
131                 switch (self->v_table->insert(self, node)) {
132                 case AO2_CONTAINER_INSERT_NODE_INSERTED:
133                         node->is_linked = 1;
134                         ast_atomic_fetchadd_int(&self->elements, 1);
135 #if defined(AO2_DEBUG)
136                         AO2_DEVMODE_STAT(++self->nodes);
137                         if (self->v_table->link_stat) {
138                                 self->v_table->link_stat(self, node);
139                         }
140 #endif  /* defined(AO2_DEBUG) */
141                         /* Fall through */
142                 case AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED:
143 #if defined(AO2_DEBUG)
144                         if (ao2_container_check(self, OBJ_NOLOCK)) {
145                                 ast_log(LOG_ERROR, "Container integrity failed after insert or replace.\n");
146                         }
147 #endif  /* defined(AO2_DEBUG) */
148                         res = 1;
149                         break;
150                 case AO2_CONTAINER_INSERT_NODE_REJECTED:
151                         ao2_t_ref(node, -1, NULL);
152                         break;
153                 }
154         }
155
156         if (flags & OBJ_NOLOCK) {
157                 __adjust_lock(self, orig_lock, 0);
158         } else {
159                 ao2_unlock(self);
160         }
161
162         return res;
163 }
164
165 /*!
166  * \brief another convenience function is a callback that matches on address
167  */
168 int ao2_match_by_addr(void *user_data, void *arg, int flags)
169 {
170         return (user_data == arg) ? (CMP_MATCH | CMP_STOP) : 0;
171 }
172
173 /*
174  * Unlink an object from the container
175  * and destroy the associated * bucket_entry structure.
176  */
177 void *__ao2_unlink(struct ao2_container *c, void *user_data, int flags,
178         const char *tag, const char *file, int line, const char *func)
179 {
180         if (!__is_ao2_object(user_data, file, line, func)) {
181                 /* Sanity checks. */
182                 return NULL;
183         }
184
185         flags &= ~OBJ_SEARCH_MASK;
186         flags |= (OBJ_UNLINK | OBJ_SEARCH_OBJECT | OBJ_NODATA);
187         __ao2_callback(c, flags, ao2_match_by_addr, user_data, tag, file, line, func);
188
189         return NULL;
190 }
191
192 /*!
193  * \brief special callback that matches all
194  */
195 static int cb_true(void *user_data, void *arg, int flags)
196 {
197         return CMP_MATCH;
198 }
199
200 /*!
201  * \brief similar to cb_true, but is an ao2_callback_data_fn instead
202  */
203 static int cb_true_data(void *user_data, void *arg, void *data, int flags)
204 {
205         return CMP_MATCH;
206 }
207
208 /*!
209  * \internal
210  * \brief Traverse the container.  (internal)
211  *
212  * \param self Container to operate upon.
213  * \param flags search_flags to control traversing the container
214  * \param cb_fn Comparison callback function.
215  * \param arg Comparison callback arg parameter.
216  * \param data Data comparison callback data parameter.
217  * \param type Type of comparison callback cb_fn.
218  * \param tag used for debugging.
219  * \param file Debug file name invoked from
220  * \param line Debug line invoked from
221  * \param func Debug function name invoked from
222  *
223  * \retval NULL on failure or no matching object found.
224  *
225  * \retval object found if OBJ_MULTIPLE is not set in the flags
226  * parameter.
227  *
228  * \retval ao2_iterator pointer if OBJ_MULTIPLE is set in the
229  * flags parameter.  The iterator must be destroyed with
230  * ao2_iterator_destroy() when the caller no longer needs it.
231  */
232 static void *internal_ao2_traverse(struct ao2_container *self, enum search_flags flags,
233         void *cb_fn, void *arg, void *data, enum ao2_callback_type type,
234         const char *tag, const char *file, int line, const char *func)
235 {
236         void *ret;
237         ao2_callback_fn *cb_default = NULL;
238         ao2_callback_data_fn *cb_withdata = NULL;
239         struct ao2_container_node *node;
240         void *traversal_state;
241
242         enum ao2_lock_req orig_lock;
243         struct ao2_container *multi_container = NULL;
244         struct ao2_iterator *multi_iterator = NULL;
245
246         if (!__is_ao2_object(self, file, line, func)) {
247                 return NULL;
248         }
249
250         if (!self->v_table
251                 || !self->v_table->traverse_first || !self->v_table->traverse_next) {
252                 /* Sanity checks. */
253                 __ast_assert_failed(0, "invalid container v_table", file, line, func);
254                 return NULL;
255         }
256
257         /*
258          * This logic is used so we can support OBJ_MULTIPLE with OBJ_NODATA
259          * turned off.  This if statement checks for the special condition
260          * where multiple items may need to be returned.
261          */
262         if ((flags & (OBJ_MULTIPLE | OBJ_NODATA)) == OBJ_MULTIPLE) {
263                 /* we need to return an ao2_iterator with the results,
264                  * as there could be more than one. the iterator will
265                  * hold the only reference to a container that has all the
266                  * matching objects linked into it, so when the iterator
267                  * is destroyed, the container will be automatically
268                  * destroyed as well.
269                  */
270                 multi_container = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL,
271                         NULL, "OBJ_MULTIPLE return container creation");
272                 if (!multi_container) {
273                         return NULL;
274                 }
275                 if (!(multi_iterator = ast_calloc(1, sizeof(*multi_iterator)))) {
276                         ao2_t_ref(multi_container, -1, "OBJ_MULTIPLE interator creation failed.");
277                         return NULL;
278                 }
279         }
280
281         if (!cb_fn) {
282                 /* Match everything if no callback match function provided. */
283                 if (type == AO2_CALLBACK_WITH_DATA) {
284                         cb_withdata = cb_true_data;
285                 } else {
286                         cb_default = cb_true;
287                 }
288         } else {
289                 /*
290                  * We do this here to avoid the per object casting penalty (even
291                  * though that is probably optimized away anyway).
292                  */
293                 if (type == AO2_CALLBACK_WITH_DATA) {
294                         cb_withdata = cb_fn;
295                 } else {
296                         cb_default = cb_fn;
297                 }
298         }
299
300         /* avoid modifications to the content */
301         if (flags & OBJ_NOLOCK) {
302                 if (flags & OBJ_UNLINK) {
303                         orig_lock = __adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
304                 } else {
305                         orig_lock = __adjust_lock(self, AO2_LOCK_REQ_RDLOCK, 1);
306                 }
307         } else {
308                 orig_lock = AO2_LOCK_REQ_MUTEX;
309                 if (flags & OBJ_UNLINK) {
310                         ao2_wrlock(self);
311                 } else {
312                         ao2_rdlock(self);
313                 }
314         }
315
316         /* Create a buffer for the traversal state. */
317         traversal_state = alloca(AO2_TRAVERSAL_STATE_SIZE);
318
319         ret = NULL;
320         for (node = self->v_table->traverse_first(self, flags, arg, traversal_state);
321                 node;
322                 node = self->v_table->traverse_next(self, traversal_state, node)) {
323                 int match;
324
325                 /* Visit the current node. */
326                 match = (CMP_MATCH | CMP_STOP);
327                 if (type == AO2_CALLBACK_WITH_DATA) {
328                         match &= cb_withdata(node->obj, arg, data, flags);
329                 } else {
330                         match &= cb_default(node->obj, arg, flags);
331                 }
332                 if (match == 0) {
333                         /* no match, no stop, continue */
334                         continue;
335                 }
336                 if (match == CMP_STOP) {
337                         /* no match but stop, we are done */
338                         break;
339                 }
340
341                 /*
342                  * CMP_MATCH is set here
343                  *
344                  * we found the object, performing operations according to flags
345                  */
346                 if (node->obj) {
347                         /* The object is still in the container. */
348                         if (!(flags & OBJ_NODATA)) {
349                                 /*
350                                  * We are returning the object, record the value.  It is
351                                  * important to handle this case before the unlink.
352                                  */
353                                 if (multi_container) {
354                                         /*
355                                          * Link the object into the container that will hold the
356                                          * results.
357                                          */
358                                         __ao2_link(multi_container, node->obj, flags, tag, file, line, func);
359                                 } else {
360                                         ret = node->obj;
361                                         /* Returning a single object. */
362                                         if (!(flags & OBJ_UNLINK)) {
363                                                 /*
364                                                  * Bump the ref count since we are not going to unlink and
365                                                  * transfer the container's object ref to the returned object.
366                                                  */
367                                                 __ao2_ref(ret, 1, tag ?: "Traversal found object", file, line, func);
368                                         }
369                                 }
370                         }
371
372                         if (flags & OBJ_UNLINK) {
373                                 int ulflag = AO2_UNLINK_NODE_UNREF_NODE | AO2_UNLINK_NODE_DEC_COUNT;
374                                 if (multi_container || (flags & OBJ_NODATA)) {
375                                         ulflag |= AO2_UNLINK_NODE_UNLINK_OBJECT;
376                                 }
377                                 __container_unlink_node_debug(node, ulflag, tag, file, line, func);
378                         }
379                 }
380
381                 if ((match & CMP_STOP) || !(flags & OBJ_MULTIPLE)) {
382                         /* We found our only (or last) match, so we are done */
383                         break;
384                 }
385         }
386         if (self->v_table->traverse_cleanup) {
387                 self->v_table->traverse_cleanup(traversal_state);
388         }
389         if (node) {
390                 /* Unref the node from self->v_table->traverse_first/traverse_next() */
391                 ao2_t_ref(node, -1, NULL);
392         }
393
394         if (flags & OBJ_NOLOCK) {
395                 __adjust_lock(self, orig_lock, 0);
396         } else {
397                 ao2_unlock(self);
398         }
399
400         /* if multi_container was created, we are returning multiple objects */
401         if (multi_container) {
402                 *multi_iterator = ao2_iterator_init(multi_container,
403                         AO2_ITERATOR_UNLINK | AO2_ITERATOR_MALLOCD);
404                 ao2_t_ref(multi_container, -1,
405                         "OBJ_MULTIPLE for multiple objects traversal complete.");
406                 return multi_iterator;
407         } else {
408                 return ret;
409         }
410 }
411
412 void *__ao2_callback(struct ao2_container *c, enum search_flags flags,
413         ao2_callback_fn *cb_fn, void *arg, const char *tag, const char *file, int line,
414         const char *func)
415 {
416         return internal_ao2_traverse(c, flags, cb_fn, arg, NULL, AO2_CALLBACK_DEFAULT, tag, file, line, func);
417 }
418
419 void *__ao2_callback_data(struct ao2_container *c, enum search_flags flags,
420         ao2_callback_data_fn *cb_fn, void *arg, void *data, const char *tag, const char *file,
421         int line, const char *func)
422 {
423         return internal_ao2_traverse(c, flags, cb_fn, arg, data, AO2_CALLBACK_WITH_DATA, tag, file, line, func);
424 }
425
426 /*!
427  * the find function just invokes the default callback with some reasonable flags.
428  */
429 void *__ao2_find(struct ao2_container *c, const void *arg, enum search_flags flags,
430         const char *tag, const char *file, int line, const char *func)
431 {
432         void *arged = (void *) arg;/* Done to avoid compiler const warning */
433
434         if (!c) {
435                 /* Sanity checks. */
436                 ast_assert(0);
437                 return NULL;
438         }
439         return __ao2_callback(c, flags, c->cmp_fn, arged, tag, file, line, func);
440 }
441
442 /*!
443  * initialize an iterator so we start from the first object
444  */
445 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags)
446 {
447         struct ao2_iterator a = {
448                 .c = c,
449                 .flags = flags
450         };
451
452         ao2_t_ref(c, +1, "Init iterator with container.");
453
454         return a;
455 }
456
457 void ao2_iterator_restart(struct ao2_iterator *iter)
458 {
459         if (!is_ao2_object(iter->c)) {
460                 /* Sanity check. */
461                 return;
462         }
463
464         /* Release the last container node reference if we have one. */
465         if (iter->last_node) {
466                 enum ao2_lock_req orig_lock;
467
468                 /*
469                  * Do a read lock in case the container node unref does not
470                  * destroy the node.  If the container node is destroyed then
471                  * the lock will be upgraded to a write lock.
472                  */
473                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
474                         orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
475                 } else {
476                         orig_lock = AO2_LOCK_REQ_MUTEX;
477                         ao2_rdlock(iter->c);
478                 }
479
480                 ao2_t_ref(iter->last_node, -1, NULL);
481                 iter->last_node = NULL;
482
483                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
484                         __adjust_lock(iter->c, orig_lock, 0);
485                 } else {
486                         ao2_unlock(iter->c);
487                 }
488         }
489
490         /* The iteration is no longer complete. */
491         iter->complete = 0;
492 }
493
494 void ao2_iterator_destroy(struct ao2_iterator *iter)
495 {
496         /* Release any last container node reference. */
497         ao2_iterator_restart(iter);
498
499         /* Release the iterated container reference. */
500         ao2_t_ref(iter->c, -1, "Unref iterator in ao2_iterator_destroy");
501         iter->c = NULL;
502
503         /* Free the malloced iterator. */
504         if (iter->flags & AO2_ITERATOR_MALLOCD) {
505                 ast_free(iter);
506         }
507 }
508
509 void ao2_iterator_cleanup(struct ao2_iterator *iter)
510 {
511         if (iter) {
512                 ao2_iterator_destroy(iter);
513         }
514 }
515
516 void *__ao2_iterator_next(struct ao2_iterator *iter,
517         const char *tag, const char *file, int line, const char *func)
518 {
519         enum ao2_lock_req orig_lock;
520         struct ao2_container_node *node;
521         void *ret;
522
523         if (!__is_ao2_object(iter->c, file, line, func)) {
524                 return NULL;
525         }
526
527         if (!iter->c->v_table || !iter->c->v_table->iterator_next) {
528                 /* Sanity checks. */
529                 __ast_assert_failed(0, "invalid iterator container v_table", file, line, func);
530                 return NULL;
531         }
532
533         if (iter->complete) {
534                 /* Don't return any more objects. */
535                 return NULL;
536         }
537
538         if (iter->flags & AO2_ITERATOR_DONTLOCK) {
539                 if (iter->flags & AO2_ITERATOR_UNLINK) {
540                         orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_WRLOCK, 1);
541                 } else {
542                         orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
543                 }
544         } else {
545                 orig_lock = AO2_LOCK_REQ_MUTEX;
546                 if (iter->flags & AO2_ITERATOR_UNLINK) {
547                         ao2_wrlock(iter->c);
548                 } else {
549                         ao2_rdlock(iter->c);
550                 }
551         }
552
553         node = iter->c->v_table->iterator_next(iter->c, iter->last_node, iter->flags);
554         if (node) {
555                 ret = node->obj;
556
557                 if (iter->flags & AO2_ITERATOR_UNLINK) {
558                         /* Transfer the object ref from the container to the returned object. */
559                         __container_unlink_node_debug(node, AO2_UNLINK_NODE_DEC_COUNT, tag, file, line, func);
560
561                         /* Transfer the container's node ref to the iterator. */
562                 } else {
563                         /* Bump ref of returned object */
564                         __ao2_ref(ret, +1, tag ?: "Next iterator object.", file, line, func);
565
566                         /* Bump the container's node ref for the iterator. */
567                         ao2_t_ref(node, +1, NULL);
568                 }
569         } else {
570                 /* The iteration has completed. */
571                 iter->complete = 1;
572                 ret = NULL;
573         }
574
575         /* Replace the iterator's node */
576         if (iter->last_node) {
577                 ao2_t_ref(iter->last_node, -1, NULL);
578         }
579         iter->last_node = node;
580
581         if (iter->flags & AO2_ITERATOR_DONTLOCK) {
582                 __adjust_lock(iter->c, orig_lock, 0);
583         } else {
584                 ao2_unlock(iter->c);
585         }
586
587         return ret;
588 }
589
590 int ao2_iterator_count(struct ao2_iterator *iter)
591 {
592         return ao2_container_count(iter->c);
593 }
594
595 void container_destruct(void *_c)
596 {
597         struct ao2_container *c = _c;
598
599         /* Unlink any stored objects in the container. */
600         c->destroying = 1;
601         ao2_t_callback(c, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL,
602                 "container_destruct called");
603
604         /* Perform any extra container cleanup. */
605         if (c->v_table && c->v_table->destroy) {
606                 c->v_table->destroy(c);
607         }
608
609 #if defined(AO2_DEBUG)
610         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
611 #endif
612 }
613
614 /*!
615  * \internal
616  * \brief Put obj into the arg container.
617  * \since 11.0
618  *
619  * \param obj  pointer to the (user-defined part) of an object.
620  * \param arg callback argument from ao2_callback()
621  * \param flags flags from ao2_callback()
622  *
623  * \retval 0 on success.
624  * \retval CMP_STOP|CMP_MATCH on error.
625  */
626 static int dup_obj_cb(void *obj, void *arg, int flags)
627 {
628         struct ao2_container *dest = arg;
629
630         return ao2_t_link_flags(dest, obj, OBJ_NOLOCK, NULL) ? 0 : (CMP_MATCH | CMP_STOP);
631 }
632
633 int ao2_container_dup(struct ao2_container *dest, struct ao2_container *src, enum search_flags flags)
634 {
635         void *obj;
636         int res = 0;
637
638         if (!(flags & OBJ_NOLOCK)) {
639                 ao2_rdlock(src);
640                 ao2_wrlock(dest);
641         }
642         obj = ao2_callback(src, OBJ_NOLOCK, dup_obj_cb, dest);
643         if (obj) {
644                 /* Failed to put this obj into the dest container. */
645                 ao2_t_ref(obj, -1, "Failed to put this object into the dest container.");
646
647                 /* Remove all items from the dest container. */
648                 ao2_t_callback(dest, OBJ_NOLOCK | OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL,
649                         NULL, NULL);
650                 res = -1;
651         }
652         if (!(flags & OBJ_NOLOCK)) {
653                 ao2_unlock(dest);
654                 ao2_unlock(src);
655         }
656
657         return res;
658 }
659
660 struct ao2_container *__ao2_container_clone(struct ao2_container *orig, enum search_flags flags, const char *tag, const char *file, int line, const char *func)
661 {
662         struct ao2_container *clone;
663         int failed;
664
665         /* Create the clone container with the same properties as the original. */
666         if (!__is_ao2_object(orig, file, line, func)) {
667                 return NULL;
668         }
669
670         if (!orig->v_table || !orig->v_table->alloc_empty_clone) {
671                 /* Sanity checks. */
672                 __ast_assert_failed(0, "invalid container v_table", file, line, func);
673                 return NULL;
674         }
675
676         clone = orig->v_table->alloc_empty_clone(orig, tag, file, line, func);
677         if (!clone) {
678                 return NULL;
679         }
680
681         if (flags & OBJ_NOLOCK) {
682                 ao2_wrlock(clone);
683         }
684         failed = ao2_container_dup(clone, orig, flags);
685         if (flags & OBJ_NOLOCK) {
686                 ao2_unlock(clone);
687         }
688         if (failed) {
689                 /* Object copy into the clone container failed. */
690                 __ao2_ref(clone, -1, tag ?: "Clone creation failed", file, line, func);
691                 clone = NULL;
692         }
693         return clone;
694 }
695
696 void ao2_container_dump(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt, ao2_prnt_obj_fn *prnt_obj)
697 {
698         if (!is_ao2_object(self) || !self->v_table) {
699                 prnt(where, "Invalid container\n");
700                 ast_assert(0);
701                 return;
702         }
703
704         if (!(flags & OBJ_NOLOCK)) {
705                 ao2_rdlock(self);
706         }
707         if (name) {
708                 prnt(where, "Container name: %s\n", name);
709         }
710 #if defined(AO2_DEBUG)
711         if (self->v_table->dump) {
712                 self->v_table->dump(self, where, prnt, prnt_obj);
713         } else
714 #endif  /* defined(AO2_DEBUG) */
715         {
716                 prnt(where, "Container dump not available.\n");
717         }
718         if (!(flags & OBJ_NOLOCK)) {
719                 ao2_unlock(self);
720         }
721 }
722
723 void ao2_container_stats(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt)
724 {
725         if (!is_ao2_object(self) || !self->v_table) {
726                 prnt(where, "Invalid container\n");
727                 ast_assert(0);
728                 return;
729         }
730
731         if (!(flags & OBJ_NOLOCK)) {
732                 ao2_rdlock(self);
733         }
734         if (name) {
735                 prnt(where, "Container name: %s\n", name);
736         }
737         prnt(where, "Number of objects: %d\n", self->elements);
738 #if defined(AO2_DEBUG)
739         prnt(where, "Number of nodes: %d\n", self->nodes);
740         prnt(where, "Number of empty nodes: %d\n", self->nodes - self->elements);
741         /*
742          * XXX
743          * If the max_empty_nodes count gets out of single digits you
744          * likely have a code path where ao2_iterator_destroy() is not
745          * called.
746          *
747          * Empty nodes do not harm the container but they do make
748          * container operations less efficient.
749          */
750         prnt(where, "Maximum empty nodes: %d\n", self->max_empty_nodes);
751         if (self->v_table->stats) {
752                 self->v_table->stats(self, where, prnt);
753         }
754 #endif  /* defined(AO2_DEBUG) */
755         if (!(flags & OBJ_NOLOCK)) {
756                 ao2_unlock(self);
757         }
758 }
759
760 int ao2_container_check(struct ao2_container *self, enum search_flags flags)
761 {
762         int res = 0;
763
764         if (!is_ao2_object(self) || !self->v_table) {
765                 /* Sanity checks. */
766                 ast_assert(0);
767                 return -1;
768         }
769 #if defined(AO2_DEBUG)
770         if (!self->v_table->integrity) {
771                 /* No ingetrigy check available.  Assume container is ok. */
772                 return 0;
773         }
774
775         if (!(flags & OBJ_NOLOCK)) {
776                 ao2_rdlock(self);
777         }
778         res = self->v_table->integrity(self);
779         if (!(flags & OBJ_NOLOCK)) {
780                 ao2_unlock(self);
781         }
782 #endif  /* defined(AO2_DEBUG) */
783         return res;
784 }
785
786 #if defined(AO2_DEBUG)
787 static struct ao2_container *reg_containers;
788
789 struct ao2_reg_container {
790         /*! Registered container pointer. */
791         struct ao2_container *registered;
792         /*! Callback function to print the given object's key. (NULL if not available) */
793         ao2_prnt_obj_fn *prnt_obj;
794         /*! Name container registered under. */
795         char name[1];
796 };
797
798 struct ao2_reg_partial_key {
799         /*! Length of partial key match. */
800         int len;
801         /*! Registration partial key name. */
802         const char *name;
803 };
804
805 struct ao2_reg_match {
806         /*! The nth match to find. */
807         int find_nth;
808         /*! Count of the matches already found. */
809         int count;
810 };
811 #endif  /* defined(AO2_DEBUG) */
812
813 #if defined(AO2_DEBUG)
814 static int ao2_reg_sort_cb(const void *obj_left, const void *obj_right, int flags)
815 {
816         const struct ao2_reg_container *reg_left = obj_left;
817         int cmp;
818
819         switch (flags & OBJ_SEARCH_MASK) {
820         case OBJ_SEARCH_OBJECT:
821                 {
822                         const struct ao2_reg_container *reg_right = obj_right;
823
824                         cmp = strcasecmp(reg_left->name, reg_right->name);
825                 }
826                 break;
827         case OBJ_SEARCH_KEY:
828                 {
829                         const char *name = obj_right;
830
831                         cmp = strcasecmp(reg_left->name, name);
832                 }
833                 break;
834         case OBJ_SEARCH_PARTIAL_KEY:
835                 {
836                         const struct ao2_reg_partial_key *partial_key = obj_right;
837
838                         cmp = strncasecmp(reg_left->name, partial_key->name, partial_key->len);
839                 }
840                 break;
841         default:
842                 /* Sort can only work on something with a full or partial key. */
843                 ast_assert(0);
844                 cmp = 0;
845                 break;
846         }
847         return cmp;
848 }
849 #endif  /* defined(AO2_DEBUG) */
850
851 #if defined(AO2_DEBUG)
852 static void ao2_reg_destructor(void *v_doomed)
853 {
854         struct ao2_reg_container *doomed = v_doomed;
855
856         if (doomed->registered) {
857                 ao2_t_ref(doomed->registered, -1, "Releasing registered container.");
858         }
859 }
860 #endif  /* defined(AO2_DEBUG) */
861
862 int ao2_container_register(const char *name, struct ao2_container *self, ao2_prnt_obj_fn *prnt_obj)
863 {
864         int res = 0;
865 #if defined(AO2_DEBUG)
866         struct ao2_reg_container *reg;
867
868         reg = ao2_t_alloc_options(sizeof(*reg) + strlen(name), ao2_reg_destructor,
869                 AO2_ALLOC_OPT_LOCK_NOLOCK, "Container registration object.");
870         if (!reg) {
871                 return -1;
872         }
873
874         /* Fill in registered entry */
875         ao2_t_ref(self, +1, "Registering container.");
876         reg->registered = self;
877         reg->prnt_obj = prnt_obj;
878         strcpy(reg->name, name);/* safe */
879
880         if (!ao2_t_link(reg_containers, reg, "Save registration object.")) {
881                 res = -1;
882         }
883
884         ao2_t_ref(reg, -1, "Done registering container.");
885 #endif  /* defined(AO2_DEBUG) */
886         return res;
887 }
888
889 void ao2_container_unregister(const char *name)
890 {
891 #if defined(AO2_DEBUG)
892         ao2_t_find(reg_containers, name, OBJ_UNLINK | OBJ_NODATA | OBJ_SEARCH_KEY,
893                 "Unregister container");
894 #endif  /* defined(AO2_DEBUG) */
895 }
896
897 #if defined(AO2_DEBUG)
898 static int ao2_complete_reg_cb(void *obj, void *arg, void *data, int flags)
899 {
900         struct ao2_reg_match *which = data;
901
902         /* ao2_reg_sort_cb() has already filtered the search to matching keys */
903         return (which->find_nth < ++which->count) ? (CMP_MATCH | CMP_STOP) : 0;
904 }
905 #endif  /* defined(AO2_DEBUG) */
906
907 #if defined(AO2_DEBUG)
908 static char *complete_container_names(struct ast_cli_args *a)
909 {
910         struct ao2_reg_partial_key partial_key;
911         struct ao2_reg_match which;
912         struct ao2_reg_container *reg;
913         char *name;
914
915         if (a->pos != 3) {
916                 return NULL;
917         }
918
919         partial_key.len = strlen(a->word);
920         partial_key.name = a->word;
921         which.find_nth = a->n;
922         which.count = 0;
923         reg = ao2_t_callback_data(reg_containers, partial_key.len ? OBJ_SEARCH_PARTIAL_KEY : 0,
924                 ao2_complete_reg_cb, &partial_key, &which, "Find partial registered container");
925         if (reg) {
926                 name = ast_strdup(reg->name);
927                 ao2_t_ref(reg, -1, "Done with registered container object.");
928         } else {
929                 name = NULL;
930         }
931         return name;
932 }
933 #endif  /* defined(AO2_DEBUG) */
934
935 #if defined(AO2_DEBUG)
936 AST_THREADSTORAGE(ao2_out_buf);
937
938 /*!
939  * \brief Print CLI output.
940  * \since 12.0.0
941  *
942  * \param where User data pointer needed to determine where to put output.
943  * \param fmt printf type format string.
944  *
945  * \return Nothing
946  */
947 static void cli_output(void *where, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
948 static void cli_output(void *where, const char *fmt, ...)
949 {
950         int res;
951         struct ast_str *buf;
952         va_list ap;
953
954         buf = ast_str_thread_get(&ao2_out_buf, 256);
955         if (!buf) {
956                 return;
957         }
958
959         va_start(ap, fmt);
960         res = ast_str_set_va(&buf, 0, fmt, ap);
961         va_end(ap);
962
963         if (res != AST_DYNSTR_BUILD_FAILED) {
964                 ast_cli(*(int *) where, "%s", ast_str_buffer(buf));
965         }
966 }
967 #endif  /* defined(AO2_DEBUG) */
968
969 #if defined(AO2_DEBUG)
970 /*! \brief Show container contents - CLI command */
971 static char *handle_cli_astobj2_container_dump(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
972 {
973         const char *name;
974         struct ao2_reg_container *reg;
975
976         switch (cmd) {
977         case CLI_INIT:
978                 e->command = "astobj2 container dump";
979                 e->usage =
980                         "Usage: astobj2 container dump <name>\n"
981                         "       Show contents of the container <name>.\n";
982                 return NULL;
983         case CLI_GENERATE:
984                 return complete_container_names(a);
985         }
986
987         if (a->argc != 4) {
988                 return CLI_SHOWUSAGE;
989         }
990
991         name = a->argv[3];
992         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
993         if (reg) {
994                 ao2_container_dump(reg->registered, 0, name, (void *) &a->fd, cli_output,
995                         reg->prnt_obj);
996                 ao2_t_ref(reg, -1, "Done with registered container object.");
997         } else {
998                 ast_cli(a->fd, "Container '%s' not found.\n", name);
999         }
1000
1001         return CLI_SUCCESS;
1002 }
1003 #endif  /* defined(AO2_DEBUG) */
1004
1005 #if defined(AO2_DEBUG)
1006 /*! \brief Show container statistics - CLI command */
1007 static char *handle_cli_astobj2_container_stats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1008 {
1009         const char *name;
1010         struct ao2_reg_container *reg;
1011
1012         switch (cmd) {
1013         case CLI_INIT:
1014                 e->command = "astobj2 container stats";
1015                 e->usage =
1016                         "Usage: astobj2 container stats <name>\n"
1017                         "       Show statistics about the specified container <name>.\n";
1018                 return NULL;
1019         case CLI_GENERATE:
1020                 return complete_container_names(a);
1021         }
1022
1023         if (a->argc != 4) {
1024                 return CLI_SHOWUSAGE;
1025         }
1026
1027         name = a->argv[3];
1028         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
1029         if (reg) {
1030                 ao2_container_stats(reg->registered, 0, name, (void *) &a->fd, cli_output);
1031                 ao2_t_ref(reg, -1, "Done with registered container object.");
1032         } else {
1033                 ast_cli(a->fd, "Container '%s' not found.\n", name);
1034         }
1035
1036         return CLI_SUCCESS;
1037 }
1038 #endif  /* defined(AO2_DEBUG) */
1039
1040 #if defined(AO2_DEBUG)
1041 /*! \brief Show container check results - CLI command */
1042 static char *handle_cli_astobj2_container_check(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1043 {
1044         const char *name;
1045         struct ao2_reg_container *reg;
1046
1047         switch (cmd) {
1048         case CLI_INIT:
1049                 e->command = "astobj2 container check";
1050                 e->usage =
1051                         "Usage: astobj2 container check <name>\n"
1052                         "       Perform a container integrity check on <name>.\n";
1053                 return NULL;
1054         case CLI_GENERATE:
1055                 return complete_container_names(a);
1056         }
1057
1058         if (a->argc != 4) {
1059                 return CLI_SHOWUSAGE;
1060         }
1061
1062         name = a->argv[3];
1063         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
1064         if (reg) {
1065                 ast_cli(a->fd, "Container check of '%s': %s.\n", name,
1066                         ao2_container_check(reg->registered, 0) ? "failed" : "OK");
1067                 ao2_t_ref(reg, -1, "Done with registered container object.");
1068         } else {
1069                 ast_cli(a->fd, "Container '%s' not found.\n", name);
1070         }
1071
1072         return CLI_SUCCESS;
1073 }
1074 #endif  /* defined(AO2_DEBUG) */
1075
1076 #if defined(AO2_DEBUG)
1077 static struct ast_cli_entry cli_astobj2[] = {
1078         AST_CLI_DEFINE(handle_cli_astobj2_container_dump, "Show container contents"),
1079         AST_CLI_DEFINE(handle_cli_astobj2_container_stats, "Show container statistics"),
1080         AST_CLI_DEFINE(handle_cli_astobj2_container_check, "Perform a container integrity check"),
1081 };
1082 #endif  /* defined(AO2_DEBUG) */
1083
1084 #if defined(AO2_DEBUG)
1085 static void container_cleanup(void)
1086 {
1087         ao2_t_ref(reg_containers, -1, "Releasing container registration container");
1088         reg_containers = NULL;
1089
1090         ast_cli_unregister_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
1091 }
1092 #endif  /* defined(AO2_DEBUG) */
1093
1094 int container_init(void)
1095 {
1096 #if defined(AO2_DEBUG)
1097         reg_containers = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_RWLOCK,
1098                 AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, ao2_reg_sort_cb, NULL,
1099                 "Container registration container.");
1100         if (!reg_containers) {
1101                 return -1;
1102         }
1103
1104         ast_cli_register_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
1105         ast_register_cleanup(container_cleanup);
1106 #endif  /* defined(AO2_DEBUG) */
1107
1108         return 0;
1109 }
1110