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