c00da9fd41a681a7a94c9a660e0869f21e2370ef
[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                 || !self->v_table || !self->v_table->new_node || !self->v_table->insert) {
106                 /* Sanity checks. */
107                 ast_assert(0);
108                 return 0;
109         }
110
111         if (flags & OBJ_NOLOCK) {
112                 orig_lock = __adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
113         } else {
114                 ao2_wrlock(self);
115                 orig_lock = AO2_LOCK_REQ_MUTEX;
116         }
117
118         res = 0;
119         node = self->v_table->new_node(self, obj_new, tag, file, line, func);
120         if (node) {
121 #if defined(AO2_DEBUG)
122                 if (ao2_container_check(self, OBJ_NOLOCK)) {
123                         ast_log(LOG_ERROR, "Container integrity failed before insert.\n");
124                 }
125 #endif  /* defined(AO2_DEBUG) */
126
127                 /* Insert the new node. */
128                 switch (self->v_table->insert(self, node)) {
129                 case AO2_CONTAINER_INSERT_NODE_INSERTED:
130                         node->is_linked = 1;
131                         ast_atomic_fetchadd_int(&self->elements, 1);
132 #if defined(AO2_DEBUG)
133                         AO2_DEVMODE_STAT(++self->nodes);
134                         if (self->v_table->link_stat) {
135                                 self->v_table->link_stat(self, node);
136                         }
137 #endif  /* defined(AO2_DEBUG) */
138                         /* Fall through */
139                 case AO2_CONTAINER_INSERT_NODE_OBJ_REPLACED:
140 #if defined(AO2_DEBUG)
141                         if (ao2_container_check(self, OBJ_NOLOCK)) {
142                                 ast_log(LOG_ERROR, "Container integrity failed after insert or replace.\n");
143                         }
144 #endif  /* defined(AO2_DEBUG) */
145                         res = 1;
146                         break;
147                 case AO2_CONTAINER_INSERT_NODE_REJECTED:
148                         ao2_t_ref(node, -1, NULL);
149                         break;
150                 }
151         }
152
153         if (flags & OBJ_NOLOCK) {
154                 __adjust_lock(self, orig_lock, 0);
155         } else {
156                 ao2_unlock(self);
157         }
158
159         return res;
160 }
161
162 /*!
163  * \brief another convenience function is a callback that matches on address
164  */
165 int ao2_match_by_addr(void *user_data, void *arg, int flags)
166 {
167         return (user_data == arg) ? (CMP_MATCH | CMP_STOP) : 0;
168 }
169
170 /*
171  * Unlink an object from the container
172  * and destroy the associated * bucket_entry structure.
173  */
174 void *__ao2_unlink(struct ao2_container *c, void *user_data, int flags,
175         const char *tag, const char *file, int line, const char *func)
176 {
177         if (!__is_ao2_object(user_data, file, line, func)) {
178                 /* Sanity checks. */
179                 ast_assert(0);
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) || !self->v_table
245                 || !self->v_table->traverse_first || !self->v_table->traverse_next) {
246                 /* Sanity checks. */
247                 ast_assert(0);
248                 return NULL;
249         }
250
251         /*
252          * This logic is used so we can support OBJ_MULTIPLE with OBJ_NODATA
253          * turned off.  This if statement checks for the special condition
254          * where multiple items may need to be returned.
255          */
256         if ((flags & (OBJ_MULTIPLE | OBJ_NODATA)) == OBJ_MULTIPLE) {
257                 /* we need to return an ao2_iterator with the results,
258                  * as there could be more than one. the iterator will
259                  * hold the only reference to a container that has all the
260                  * matching objects linked into it, so when the iterator
261                  * is destroyed, the container will be automatically
262                  * destroyed as well.
263                  */
264                 multi_container = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL,
265                         NULL, "OBJ_MULTIPLE return container creation");
266                 if (!multi_container) {
267                         return NULL;
268                 }
269                 if (!(multi_iterator = ast_calloc(1, sizeof(*multi_iterator)))) {
270                         ao2_t_ref(multi_container, -1, "OBJ_MULTIPLE interator creation failed.");
271                         return NULL;
272                 }
273         }
274
275         if (!cb_fn) {
276                 /* Match everything if no callback match function provided. */
277                 if (type == AO2_CALLBACK_WITH_DATA) {
278                         cb_withdata = cb_true_data;
279                 } else {
280                         cb_default = cb_true;
281                 }
282         } else {
283                 /*
284                  * We do this here to avoid the per object casting penalty (even
285                  * though that is probably optimized away anyway).
286                  */
287                 if (type == AO2_CALLBACK_WITH_DATA) {
288                         cb_withdata = cb_fn;
289                 } else {
290                         cb_default = cb_fn;
291                 }
292         }
293
294         /* avoid modifications to the content */
295         if (flags & OBJ_NOLOCK) {
296                 if (flags & OBJ_UNLINK) {
297                         orig_lock = __adjust_lock(self, AO2_LOCK_REQ_WRLOCK, 1);
298                 } else {
299                         orig_lock = __adjust_lock(self, AO2_LOCK_REQ_RDLOCK, 1);
300                 }
301         } else {
302                 orig_lock = AO2_LOCK_REQ_MUTEX;
303                 if (flags & OBJ_UNLINK) {
304                         ao2_wrlock(self);
305                 } else {
306                         ao2_rdlock(self);
307                 }
308         }
309
310         /* Create a buffer for the traversal state. */
311         traversal_state = alloca(AO2_TRAVERSAL_STATE_SIZE);
312
313         ret = NULL;
314         for (node = self->v_table->traverse_first(self, flags, arg, traversal_state);
315                 node;
316                 node = self->v_table->traverse_next(self, traversal_state, node)) {
317                 int match;
318
319                 /* Visit the current node. */
320                 match = (CMP_MATCH | CMP_STOP);
321                 if (type == AO2_CALLBACK_WITH_DATA) {
322                         match &= cb_withdata(node->obj, arg, data, flags);
323                 } else {
324                         match &= cb_default(node->obj, arg, flags);
325                 }
326                 if (match == 0) {
327                         /* no match, no stop, continue */
328                         continue;
329                 }
330                 if (match == CMP_STOP) {
331                         /* no match but stop, we are done */
332                         break;
333                 }
334
335                 /*
336                  * CMP_MATCH is set here
337                  *
338                  * we found the object, performing operations according to flags
339                  */
340                 if (node->obj) {
341                         /* The object is still in the container. */
342                         if (!(flags & OBJ_NODATA)) {
343                                 /*
344                                  * We are returning the object, record the value.  It is
345                                  * important to handle this case before the unlink.
346                                  */
347                                 if (multi_container) {
348                                         /*
349                                          * Link the object into the container that will hold the
350                                          * results.
351                                          */
352                                         __ao2_link(multi_container, node->obj, flags, tag, file, line, func);
353                                 } else {
354                                         ret = node->obj;
355                                         /* Returning a single object. */
356                                         if (!(flags & OBJ_UNLINK)) {
357                                                 /*
358                                                  * Bump the ref count since we are not going to unlink and
359                                                  * transfer the container's object ref to the returned object.
360                                                  */
361                                                 __ao2_ref(ret, 1, tag ?: "Traversal found object", file, line, func);
362                                         }
363                                 }
364                         }
365
366                         if (flags & OBJ_UNLINK) {
367                                 int ulflag = AO2_UNLINK_NODE_UNREF_NODE | AO2_UNLINK_NODE_DEC_COUNT;
368                                 if (multi_container || (flags & OBJ_NODATA)) {
369                                         ulflag |= AO2_UNLINK_NODE_UNLINK_OBJECT;
370                                 }
371                                 __container_unlink_node_debug(node, ulflag, tag, file, line, func);
372                         }
373                 }
374
375                 if ((match & CMP_STOP) || !(flags & OBJ_MULTIPLE)) {
376                         /* We found our only (or last) match, so we are done */
377                         break;
378                 }
379         }
380         if (self->v_table->traverse_cleanup) {
381                 self->v_table->traverse_cleanup(traversal_state);
382         }
383         if (node) {
384                 /* Unref the node from self->v_table->traverse_first/traverse_next() */
385                 ao2_t_ref(node, -1, NULL);
386         }
387
388         if (flags & OBJ_NOLOCK) {
389                 __adjust_lock(self, orig_lock, 0);
390         } else {
391                 ao2_unlock(self);
392         }
393
394         /* if multi_container was created, we are returning multiple objects */
395         if (multi_container) {
396                 *multi_iterator = ao2_iterator_init(multi_container,
397                         AO2_ITERATOR_UNLINK | AO2_ITERATOR_MALLOCD);
398                 ao2_t_ref(multi_container, -1,
399                         "OBJ_MULTIPLE for multiple objects traversal complete.");
400                 return multi_iterator;
401         } else {
402                 return ret;
403         }
404 }
405
406 void *__ao2_callback(struct ao2_container *c, enum search_flags flags,
407         ao2_callback_fn *cb_fn, void *arg, const char *tag, const char *file, int line,
408         const char *func)
409 {
410         return internal_ao2_traverse(c, flags, cb_fn, arg, NULL, AO2_CALLBACK_DEFAULT, tag, file, line, func);
411 }
412
413 void *__ao2_callback_data(struct ao2_container *c, enum search_flags flags,
414         ao2_callback_data_fn *cb_fn, void *arg, void *data, const char *tag, const char *file,
415         int line, const char *func)
416 {
417         return internal_ao2_traverse(c, flags, cb_fn, arg, data, AO2_CALLBACK_WITH_DATA, tag, file, line, func);
418 }
419
420 /*!
421  * the find function just invokes the default callback with some reasonable flags.
422  */
423 void *__ao2_find(struct ao2_container *c, const void *arg, enum search_flags flags,
424         const char *tag, const char *file, int line, const char *func)
425 {
426         void *arged = (void *) arg;/* Done to avoid compiler const warning */
427
428         if (!c) {
429                 /* Sanity checks. */
430                 ast_assert(0);
431                 return NULL;
432         }
433         return __ao2_callback(c, flags, c->cmp_fn, arged, tag, file, line, func);
434 }
435
436 /*!
437  * initialize an iterator so we start from the first object
438  */
439 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags)
440 {
441         struct ao2_iterator a = {
442                 .c = c,
443                 .flags = flags
444         };
445
446         ao2_t_ref(c, +1, "Init iterator with container.");
447
448         return a;
449 }
450
451 void ao2_iterator_restart(struct ao2_iterator *iter)
452 {
453         if (!is_ao2_object(iter->c)) {
454                 ast_log(LOG_ERROR, "Iterator container is not valid.\n");
455                 ast_assert(0);
456                 return;
457         }
458
459         /* Release the last container node reference if we have one. */
460         if (iter->last_node) {
461                 enum ao2_lock_req orig_lock;
462
463                 if (!is_ao2_object(iter->c)) {
464                         /* Sanity check. */
465                         ast_assert(0);
466                         return;
467                 }
468
469                 /*
470                  * Do a read lock in case the container node unref does not
471                  * destroy the node.  If the container node is destroyed then
472                  * the lock will be upgraded to a write lock.
473                  */
474                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
475                         orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
476                 } else {
477                         orig_lock = AO2_LOCK_REQ_MUTEX;
478                         ao2_rdlock(iter->c);
479                 }
480
481                 ao2_t_ref(iter->last_node, -1, NULL);
482                 iter->last_node = NULL;
483
484                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
485                         __adjust_lock(iter->c, orig_lock, 0);
486                 } else {
487                         ao2_unlock(iter->c);
488                 }
489         }
490
491         /* The iteration is no longer complete. */
492         iter->complete = 0;
493 }
494
495 void ao2_iterator_destroy(struct ao2_iterator *iter)
496 {
497         /* Release any last container node reference. */
498         ao2_iterator_restart(iter);
499
500         /* Release the iterated container reference. */
501         ao2_t_ref(iter->c, -1, "Unref iterator in ao2_iterator_destroy");
502         iter->c = NULL;
503
504         /* Free the malloced iterator. */
505         if (iter->flags & AO2_ITERATOR_MALLOCD) {
506                 ast_free(iter);
507         }
508 }
509
510 void ao2_iterator_cleanup(struct ao2_iterator *iter)
511 {
512         if (iter) {
513                 ao2_iterator_destroy(iter);
514         }
515 }
516
517 void *__ao2_iterator_next(struct ao2_iterator *iter,
518         const char *tag, const char *file, int line, const char *func)
519 {
520         enum ao2_lock_req orig_lock;
521         struct ao2_container_node *node;
522         void *ret;
523
524         if (!__is_ao2_object(iter->c, file, line, func)
525                 || !iter->c->v_table || !iter->c->v_table->iterator_next) {
526                 /* Sanity checks. */
527                 ast_assert(0);
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                 || !orig->v_table || !orig->v_table->alloc_empty_clone) {
666                 /* Sanity checks. */
667                 ast_assert(0);
668                 return NULL;
669         }
670         clone = orig->v_table->alloc_empty_clone(orig, tag, file, line, func);
671         if (!clone) {
672                 return NULL;
673         }
674
675         if (flags & OBJ_NOLOCK) {
676                 ao2_wrlock(clone);
677         }
678         failed = ao2_container_dup(clone, orig, flags);
679         if (flags & OBJ_NOLOCK) {
680                 ao2_unlock(clone);
681         }
682         if (failed) {
683                 /* Object copy into the clone container failed. */
684                 __ao2_ref(clone, -1, tag ?: "Clone creation failed", file, line, func);
685                 clone = NULL;
686         }
687         return clone;
688 }
689
690 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)
691 {
692         if (!is_ao2_object(self) || !self->v_table) {
693                 prnt(where, "Invalid container\n");
694                 ast_assert(0);
695                 return;
696         }
697
698         if (!(flags & OBJ_NOLOCK)) {
699                 ao2_rdlock(self);
700         }
701         if (name) {
702                 prnt(where, "Container name: %s\n", name);
703         }
704 #if defined(AO2_DEBUG)
705         if (self->v_table->dump) {
706                 self->v_table->dump(self, where, prnt, prnt_obj);
707         } else
708 #endif  /* defined(AO2_DEBUG) */
709         {
710                 prnt(where, "Container dump not available.\n");
711         }
712         if (!(flags & OBJ_NOLOCK)) {
713                 ao2_unlock(self);
714         }
715 }
716
717 void ao2_container_stats(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt)
718 {
719         if (!is_ao2_object(self) || !self->v_table) {
720                 prnt(where, "Invalid container\n");
721                 ast_assert(0);
722                 return;
723         }
724
725         if (!(flags & OBJ_NOLOCK)) {
726                 ao2_rdlock(self);
727         }
728         if (name) {
729                 prnt(where, "Container name: %s\n", name);
730         }
731         prnt(where, "Number of objects: %d\n", self->elements);
732 #if defined(AO2_DEBUG)
733         prnt(where, "Number of nodes: %d\n", self->nodes);
734         prnt(where, "Number of empty nodes: %d\n", self->nodes - self->elements);
735         /*
736          * XXX
737          * If the max_empty_nodes count gets out of single digits you
738          * likely have a code path where ao2_iterator_destroy() is not
739          * called.
740          *
741          * Empty nodes do not harm the container but they do make
742          * container operations less efficient.
743          */
744         prnt(where, "Maximum empty nodes: %d\n", self->max_empty_nodes);
745         if (self->v_table->stats) {
746                 self->v_table->stats(self, where, prnt);
747         }
748 #endif  /* defined(AO2_DEBUG) */
749         if (!(flags & OBJ_NOLOCK)) {
750                 ao2_unlock(self);
751         }
752 }
753
754 int ao2_container_check(struct ao2_container *self, enum search_flags flags)
755 {
756         int res = 0;
757
758         if (!is_ao2_object(self) || !self->v_table) {
759                 /* Sanity checks. */
760                 ast_assert(0);
761                 return -1;
762         }
763 #if defined(AO2_DEBUG)
764         if (!self->v_table->integrity) {
765                 /* No ingetrigy check available.  Assume container is ok. */
766                 return 0;
767         }
768
769         if (!(flags & OBJ_NOLOCK)) {
770                 ao2_rdlock(self);
771         }
772         res = self->v_table->integrity(self);
773         if (!(flags & OBJ_NOLOCK)) {
774                 ao2_unlock(self);
775         }
776 #endif  /* defined(AO2_DEBUG) */
777         return res;
778 }
779
780 #if defined(AO2_DEBUG)
781 static struct ao2_container *reg_containers;
782
783 struct ao2_reg_container {
784         /*! Registered container pointer. */
785         struct ao2_container *registered;
786         /*! Callback function to print the given object's key. (NULL if not available) */
787         ao2_prnt_obj_fn *prnt_obj;
788         /*! Name container registered under. */
789         char name[1];
790 };
791
792 struct ao2_reg_partial_key {
793         /*! Length of partial key match. */
794         int len;
795         /*! Registration partial key name. */
796         const char *name;
797 };
798
799 struct ao2_reg_match {
800         /*! The nth match to find. */
801         int find_nth;
802         /*! Count of the matches already found. */
803         int count;
804 };
805 #endif  /* defined(AO2_DEBUG) */
806
807 #if defined(AO2_DEBUG)
808 static int ao2_reg_sort_cb(const void *obj_left, const void *obj_right, int flags)
809 {
810         const struct ao2_reg_container *reg_left = obj_left;
811         int cmp;
812
813         switch (flags & OBJ_SEARCH_MASK) {
814         case OBJ_SEARCH_OBJECT:
815                 {
816                         const struct ao2_reg_container *reg_right = obj_right;
817
818                         cmp = strcasecmp(reg_left->name, reg_right->name);
819                 }
820                 break;
821         case OBJ_SEARCH_KEY:
822                 {
823                         const char *name = obj_right;
824
825                         cmp = strcasecmp(reg_left->name, name);
826                 }
827                 break;
828         case OBJ_SEARCH_PARTIAL_KEY:
829                 {
830                         const struct ao2_reg_partial_key *partial_key = obj_right;
831
832                         cmp = strncasecmp(reg_left->name, partial_key->name, partial_key->len);
833                 }
834                 break;
835         default:
836                 /* Sort can only work on something with a full or partial key. */
837                 ast_assert(0);
838                 cmp = 0;
839                 break;
840         }
841         return cmp;
842 }
843 #endif  /* defined(AO2_DEBUG) */
844
845 #if defined(AO2_DEBUG)
846 static void ao2_reg_destructor(void *v_doomed)
847 {
848         struct ao2_reg_container *doomed = v_doomed;
849
850         if (doomed->registered) {
851                 ao2_t_ref(doomed->registered, -1, "Releasing registered container.");
852         }
853 }
854 #endif  /* defined(AO2_DEBUG) */
855
856 int ao2_container_register(const char *name, struct ao2_container *self, ao2_prnt_obj_fn *prnt_obj)
857 {
858         int res = 0;
859 #if defined(AO2_DEBUG)
860         struct ao2_reg_container *reg;
861
862         reg = ao2_t_alloc_options(sizeof(*reg) + strlen(name), ao2_reg_destructor,
863                 AO2_ALLOC_OPT_LOCK_NOLOCK, "Container registration object.");
864         if (!reg) {
865                 return -1;
866         }
867
868         /* Fill in registered entry */
869         ao2_t_ref(self, +1, "Registering container.");
870         reg->registered = self;
871         reg->prnt_obj = prnt_obj;
872         strcpy(reg->name, name);/* safe */
873
874         if (!ao2_t_link(reg_containers, reg, "Save registration object.")) {
875                 res = -1;
876         }
877
878         ao2_t_ref(reg, -1, "Done registering container.");
879 #endif  /* defined(AO2_DEBUG) */
880         return res;
881 }
882
883 void ao2_container_unregister(const char *name)
884 {
885 #if defined(AO2_DEBUG)
886         ao2_t_find(reg_containers, name, OBJ_UNLINK | OBJ_NODATA | OBJ_SEARCH_KEY,
887                 "Unregister container");
888 #endif  /* defined(AO2_DEBUG) */
889 }
890
891 #if defined(AO2_DEBUG)
892 static int ao2_complete_reg_cb(void *obj, void *arg, void *data, int flags)
893 {
894         struct ao2_reg_match *which = data;
895
896         /* ao2_reg_sort_cb() has already filtered the search to matching keys */
897         return (which->find_nth < ++which->count) ? (CMP_MATCH | CMP_STOP) : 0;
898 }
899 #endif  /* defined(AO2_DEBUG) */
900
901 #if defined(AO2_DEBUG)
902 static char *complete_container_names(struct ast_cli_args *a)
903 {
904         struct ao2_reg_partial_key partial_key;
905         struct ao2_reg_match which;
906         struct ao2_reg_container *reg;
907         char *name;
908
909         if (a->pos != 3) {
910                 return NULL;
911         }
912
913         partial_key.len = strlen(a->word);
914         partial_key.name = a->word;
915         which.find_nth = a->n;
916         which.count = 0;
917         reg = ao2_t_callback_data(reg_containers, partial_key.len ? OBJ_SEARCH_PARTIAL_KEY : 0,
918                 ao2_complete_reg_cb, &partial_key, &which, "Find partial registered container");
919         if (reg) {
920                 name = ast_strdup(reg->name);
921                 ao2_t_ref(reg, -1, "Done with registered container object.");
922         } else {
923                 name = NULL;
924         }
925         return name;
926 }
927 #endif  /* defined(AO2_DEBUG) */
928
929 #if defined(AO2_DEBUG)
930 AST_THREADSTORAGE(ao2_out_buf);
931
932 /*!
933  * \brief Print CLI output.
934  * \since 12.0.0
935  *
936  * \param where User data pointer needed to determine where to put output.
937  * \param fmt printf type format string.
938  *
939  * \return Nothing
940  */
941 static void cli_output(void *where, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
942 static void cli_output(void *where, const char *fmt, ...)
943 {
944         int res;
945         struct ast_str *buf;
946         va_list ap;
947
948         buf = ast_str_thread_get(&ao2_out_buf, 256);
949         if (!buf) {
950                 return;
951         }
952
953         va_start(ap, fmt);
954         res = ast_str_set_va(&buf, 0, fmt, ap);
955         va_end(ap);
956
957         if (res != AST_DYNSTR_BUILD_FAILED) {
958                 ast_cli(*(int *) where, "%s", ast_str_buffer(buf));
959         }
960 }
961 #endif  /* defined(AO2_DEBUG) */
962
963 #if defined(AO2_DEBUG)
964 /*! \brief Show container contents - CLI command */
965 static char *handle_cli_astobj2_container_dump(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
966 {
967         const char *name;
968         struct ao2_reg_container *reg;
969
970         switch (cmd) {
971         case CLI_INIT:
972                 e->command = "astobj2 container dump";
973                 e->usage =
974                         "Usage: astobj2 container dump <name>\n"
975                         "       Show contents of the container <name>.\n";
976                 return NULL;
977         case CLI_GENERATE:
978                 return complete_container_names(a);
979         }
980
981         if (a->argc != 4) {
982                 return CLI_SHOWUSAGE;
983         }
984
985         name = a->argv[3];
986         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
987         if (reg) {
988                 ao2_container_dump(reg->registered, 0, name, (void *) &a->fd, cli_output,
989                         reg->prnt_obj);
990                 ao2_t_ref(reg, -1, "Done with registered container object.");
991         } else {
992                 ast_cli(a->fd, "Container '%s' not found.\n", name);
993         }
994
995         return CLI_SUCCESS;
996 }
997 #endif  /* defined(AO2_DEBUG) */
998
999 #if defined(AO2_DEBUG)
1000 /*! \brief Show container statistics - CLI command */
1001 static char *handle_cli_astobj2_container_stats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1002 {
1003         const char *name;
1004         struct ao2_reg_container *reg;
1005
1006         switch (cmd) {
1007         case CLI_INIT:
1008                 e->command = "astobj2 container stats";
1009                 e->usage =
1010                         "Usage: astobj2 container stats <name>\n"
1011                         "       Show statistics about the specified container <name>.\n";
1012                 return NULL;
1013         case CLI_GENERATE:
1014                 return complete_container_names(a);
1015         }
1016
1017         if (a->argc != 4) {
1018                 return CLI_SHOWUSAGE;
1019         }
1020
1021         name = a->argv[3];
1022         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
1023         if (reg) {
1024                 ao2_container_stats(reg->registered, 0, name, (void *) &a->fd, cli_output);
1025                 ao2_t_ref(reg, -1, "Done with registered container object.");
1026         } else {
1027                 ast_cli(a->fd, "Container '%s' not found.\n", name);
1028         }
1029
1030         return CLI_SUCCESS;
1031 }
1032 #endif  /* defined(AO2_DEBUG) */
1033
1034 #if defined(AO2_DEBUG)
1035 /*! \brief Show container check results - CLI command */
1036 static char *handle_cli_astobj2_container_check(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1037 {
1038         const char *name;
1039         struct ao2_reg_container *reg;
1040
1041         switch (cmd) {
1042         case CLI_INIT:
1043                 e->command = "astobj2 container check";
1044                 e->usage =
1045                         "Usage: astobj2 container check <name>\n"
1046                         "       Perform a container integrity check on <name>.\n";
1047                 return NULL;
1048         case CLI_GENERATE:
1049                 return complete_container_names(a);
1050         }
1051
1052         if (a->argc != 4) {
1053                 return CLI_SHOWUSAGE;
1054         }
1055
1056         name = a->argv[3];
1057         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
1058         if (reg) {
1059                 ast_cli(a->fd, "Container check of '%s': %s.\n", name,
1060                         ao2_container_check(reg->registered, 0) ? "failed" : "OK");
1061                 ao2_t_ref(reg, -1, "Done with registered container object.");
1062         } else {
1063                 ast_cli(a->fd, "Container '%s' not found.\n", name);
1064         }
1065
1066         return CLI_SUCCESS;
1067 }
1068 #endif  /* defined(AO2_DEBUG) */
1069
1070 #if defined(AO2_DEBUG)
1071 static struct ast_cli_entry cli_astobj2[] = {
1072         AST_CLI_DEFINE(handle_cli_astobj2_container_dump, "Show container contents"),
1073         AST_CLI_DEFINE(handle_cli_astobj2_container_stats, "Show container statistics"),
1074         AST_CLI_DEFINE(handle_cli_astobj2_container_check, "Perform a container integrity check"),
1075 };
1076 #endif  /* defined(AO2_DEBUG) */
1077
1078 #if defined(AO2_DEBUG)
1079 static void container_cleanup(void)
1080 {
1081         ao2_t_ref(reg_containers, -1, "Releasing container registration container");
1082         reg_containers = NULL;
1083
1084         ast_cli_unregister_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
1085 }
1086 #endif  /* defined(AO2_DEBUG) */
1087
1088 int container_init(void)
1089 {
1090 #if defined(AO2_DEBUG)
1091         reg_containers = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_RWLOCK,
1092                 AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, ao2_reg_sort_cb, NULL,
1093                 "Container registration container.");
1094         if (!reg_containers) {
1095                 return -1;
1096         }
1097
1098         ast_cli_register_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
1099         ast_register_cleanup(container_cleanup);
1100 #endif  /* defined(AO2_DEBUG) */
1101
1102         return 0;
1103 }
1104