Remove constant conditionals (dead-code).
[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 void *__ao2_weakproxy_find(struct ao2_container *c, const void *arg, enum search_flags flags,
441         const char *tag, const char *file, int line, const char *func)
442 {
443         void *proxy;
444         void *obj = NULL;
445         enum ao2_lock_req orig_lock;
446
447         ast_assert(!!c);
448         ast_assert(flags & OBJ_SEARCH_MASK);
449         ast_assert(!(flags & ~(OBJ_SEARCH_MASK | OBJ_NOLOCK)));
450
451         if (flags & OBJ_NOLOCK) {
452                 orig_lock = __adjust_lock(c, AO2_LOCK_REQ_RDLOCK, 1);
453         } else {
454                 orig_lock = AO2_LOCK_REQ_RDLOCK;
455                 ao2_rdlock(c);
456         }
457
458         while ((proxy = ao2_find(c, arg, flags | OBJ_NOLOCK))) {
459                 obj = __ao2_weakproxy_get_object(proxy, 0, tag ?: __PRETTY_FUNCTION__, file, line, func);
460
461                 if (obj) {
462                         ao2_ref(proxy, -1);
463                         break;
464                 }
465
466                 /* Upgrade to a write lock */
467                 __adjust_lock(c, AO2_LOCK_REQ_WRLOCK, 1);
468                 ao2_unlink_flags(c, proxy, OBJ_NOLOCK);
469                 ao2_ref(proxy, -1);
470         }
471
472         if (flags & OBJ_NOLOCK) {
473                 /* We'll keep any upgraded lock */
474                 __adjust_lock(c, orig_lock, 1);
475         } else {
476                 ao2_unlock(c);
477         }
478
479         return obj;
480 }
481
482 /*!
483  * initialize an iterator so we start from the first object
484  */
485 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags)
486 {
487         struct ao2_iterator a = {
488                 .c = c,
489                 .flags = flags
490         };
491
492         ao2_t_ref(c, +1, "Init iterator with container.");
493
494         return a;
495 }
496
497 void ao2_iterator_restart(struct ao2_iterator *iter)
498 {
499         if (!is_ao2_object(iter->c)) {
500                 /* Sanity check. */
501                 return;
502         }
503
504         /* Release the last container node reference if we have one. */
505         if (iter->last_node) {
506                 enum ao2_lock_req orig_lock;
507
508                 /*
509                  * Do a read lock in case the container node unref does not
510                  * destroy the node.  If the container node is destroyed then
511                  * the lock will be upgraded to a write lock.
512                  */
513                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
514                         orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
515                 } else {
516                         orig_lock = AO2_LOCK_REQ_MUTEX;
517                         ao2_rdlock(iter->c);
518                 }
519
520                 ao2_t_ref(iter->last_node, -1, NULL);
521                 iter->last_node = NULL;
522
523                 if (iter->flags & AO2_ITERATOR_DONTLOCK) {
524                         __adjust_lock(iter->c, orig_lock, 0);
525                 } else {
526                         ao2_unlock(iter->c);
527                 }
528         }
529
530         /* The iteration is no longer complete. */
531         iter->complete = 0;
532 }
533
534 void ao2_iterator_destroy(struct ao2_iterator *iter)
535 {
536         /* Release any last container node reference. */
537         ao2_iterator_restart(iter);
538
539         /* Release the iterated container reference. */
540         ao2_t_ref(iter->c, -1, "Unref iterator in ao2_iterator_destroy");
541         iter->c = NULL;
542
543         /* Free the malloced iterator. */
544         if (iter->flags & AO2_ITERATOR_MALLOCD) {
545                 ast_free(iter);
546         }
547 }
548
549 void ao2_iterator_cleanup(struct ao2_iterator *iter)
550 {
551         if (iter) {
552                 ao2_iterator_destroy(iter);
553         }
554 }
555
556 void *__ao2_iterator_next(struct ao2_iterator *iter,
557         const char *tag, const char *file, int line, const char *func)
558 {
559         enum ao2_lock_req orig_lock;
560         struct ao2_container_node *node;
561         void *ret;
562
563         if (!__is_ao2_object(iter->c, file, line, func)) {
564                 return NULL;
565         }
566
567         if (!iter->c->v_table || !iter->c->v_table->iterator_next) {
568                 /* Sanity checks. */
569                 __ast_assert_failed(0, "invalid iterator container v_table", file, line, func);
570                 return NULL;
571         }
572
573         if (iter->complete) {
574                 /* Don't return any more objects. */
575                 return NULL;
576         }
577
578         if (iter->flags & AO2_ITERATOR_DONTLOCK) {
579                 if (iter->flags & AO2_ITERATOR_UNLINK) {
580                         orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_WRLOCK, 1);
581                 } else {
582                         orig_lock = __adjust_lock(iter->c, AO2_LOCK_REQ_RDLOCK, 1);
583                 }
584         } else {
585                 orig_lock = AO2_LOCK_REQ_MUTEX;
586                 if (iter->flags & AO2_ITERATOR_UNLINK) {
587                         ao2_wrlock(iter->c);
588                 } else {
589                         ao2_rdlock(iter->c);
590                 }
591         }
592
593         node = iter->c->v_table->iterator_next(iter->c, iter->last_node, iter->flags);
594         if (node) {
595                 ret = node->obj;
596
597                 if (iter->flags & AO2_ITERATOR_UNLINK) {
598                         /* Transfer the object ref from the container to the returned object. */
599                         __container_unlink_node_debug(node, AO2_UNLINK_NODE_DEC_COUNT, tag, file, line, func);
600
601                         /* Transfer the container's node ref to the iterator. */
602                 } else {
603                         /* Bump ref of returned object */
604                         __ao2_ref(ret, +1, tag ?: "Next iterator object.", file, line, func);
605
606                         /* Bump the container's node ref for the iterator. */
607                         ao2_t_ref(node, +1, NULL);
608                 }
609         } else {
610                 /* The iteration has completed. */
611                 iter->complete = 1;
612                 ret = NULL;
613         }
614
615         /* Replace the iterator's node */
616         if (iter->last_node) {
617                 ao2_t_ref(iter->last_node, -1, NULL);
618         }
619         iter->last_node = node;
620
621         if (iter->flags & AO2_ITERATOR_DONTLOCK) {
622                 __adjust_lock(iter->c, orig_lock, 0);
623         } else {
624                 ao2_unlock(iter->c);
625         }
626
627         return ret;
628 }
629
630 int ao2_iterator_count(struct ao2_iterator *iter)
631 {
632         return ao2_container_count(iter->c);
633 }
634
635 void container_destruct(void *_c)
636 {
637         struct ao2_container *c = _c;
638
639         /* Unlink any stored objects in the container. */
640         c->destroying = 1;
641         ao2_t_callback(c, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL,
642                 "container_destruct called");
643
644         /* Perform any extra container cleanup. */
645         if (c->v_table && c->v_table->destroy) {
646                 c->v_table->destroy(c);
647         }
648
649 #if defined(AO2_DEBUG)
650         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
651 #endif
652 }
653
654 /*!
655  * \internal
656  * \brief Put obj into the arg container.
657  * \since 11.0
658  *
659  * \param obj  pointer to the (user-defined part) of an object.
660  * \param arg callback argument from ao2_callback()
661  * \param flags flags from ao2_callback()
662  *
663  * \retval 0 on success.
664  * \retval CMP_STOP|CMP_MATCH on error.
665  */
666 static int dup_obj_cb(void *obj, void *arg, int flags)
667 {
668         struct ao2_container *dest = arg;
669
670         return ao2_t_link_flags(dest, obj, OBJ_NOLOCK, NULL) ? 0 : (CMP_MATCH | CMP_STOP);
671 }
672
673 int ao2_container_dup(struct ao2_container *dest, struct ao2_container *src, enum search_flags flags)
674 {
675         void *obj;
676         int res = 0;
677
678         if (!(flags & OBJ_NOLOCK)) {
679                 ao2_rdlock(src);
680                 ao2_wrlock(dest);
681         }
682         obj = ao2_callback(src, OBJ_NOLOCK, dup_obj_cb, dest);
683         if (obj) {
684                 /* Failed to put this obj into the dest container. */
685                 ao2_t_ref(obj, -1, "Failed to put this object into the dest container.");
686
687                 /* Remove all items from the dest container. */
688                 ao2_t_callback(dest, OBJ_NOLOCK | OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL,
689                         NULL, NULL);
690                 res = -1;
691         }
692         if (!(flags & OBJ_NOLOCK)) {
693                 ao2_unlock(dest);
694                 ao2_unlock(src);
695         }
696
697         return res;
698 }
699
700 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)
701 {
702         struct ao2_container *clone;
703         int failed;
704
705         /* Create the clone container with the same properties as the original. */
706         if (!__is_ao2_object(orig, file, line, func)) {
707                 return NULL;
708         }
709
710         if (!orig->v_table || !orig->v_table->alloc_empty_clone) {
711                 /* Sanity checks. */
712                 __ast_assert_failed(0, "invalid container v_table", file, line, func);
713                 return NULL;
714         }
715
716         clone = orig->v_table->alloc_empty_clone(orig, tag, file, line, func);
717         if (!clone) {
718                 return NULL;
719         }
720
721         if (flags & OBJ_NOLOCK) {
722                 ao2_wrlock(clone);
723         }
724         failed = ao2_container_dup(clone, orig, flags);
725         if (flags & OBJ_NOLOCK) {
726                 ao2_unlock(clone);
727         }
728         if (failed) {
729                 /* Object copy into the clone container failed. */
730                 __ao2_ref(clone, -1, tag ?: "Clone creation failed", file, line, func);
731                 clone = NULL;
732         }
733         return clone;
734 }
735
736 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)
737 {
738         if (!is_ao2_object(self) || !self->v_table) {
739                 prnt(where, "Invalid container\n");
740                 ast_assert(0);
741                 return;
742         }
743
744         if (!(flags & OBJ_NOLOCK)) {
745                 ao2_rdlock(self);
746         }
747         if (name) {
748                 prnt(where, "Container name: %s\n", name);
749         }
750 #if defined(AO2_DEBUG)
751         if (self->v_table->dump) {
752                 self->v_table->dump(self, where, prnt, prnt_obj);
753         } else
754 #endif  /* defined(AO2_DEBUG) */
755         {
756                 prnt(where, "Container dump not available.\n");
757         }
758         if (!(flags & OBJ_NOLOCK)) {
759                 ao2_unlock(self);
760         }
761 }
762
763 void ao2_container_stats(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt)
764 {
765         if (!is_ao2_object(self) || !self->v_table) {
766                 prnt(where, "Invalid container\n");
767                 ast_assert(0);
768                 return;
769         }
770
771         if (!(flags & OBJ_NOLOCK)) {
772                 ao2_rdlock(self);
773         }
774         if (name) {
775                 prnt(where, "Container name: %s\n", name);
776         }
777         prnt(where, "Number of objects: %d\n", self->elements);
778 #if defined(AO2_DEBUG)
779         prnt(where, "Number of nodes: %d\n", self->nodes);
780         prnt(where, "Number of empty nodes: %d\n", self->nodes - self->elements);
781         /*
782          * XXX
783          * If the max_empty_nodes count gets out of single digits you
784          * likely have a code path where ao2_iterator_destroy() is not
785          * called.
786          *
787          * Empty nodes do not harm the container but they do make
788          * container operations less efficient.
789          */
790         prnt(where, "Maximum empty nodes: %d\n", self->max_empty_nodes);
791         if (self->v_table->stats) {
792                 self->v_table->stats(self, where, prnt);
793         }
794 #endif  /* defined(AO2_DEBUG) */
795         if (!(flags & OBJ_NOLOCK)) {
796                 ao2_unlock(self);
797         }
798 }
799
800 int ao2_container_check(struct ao2_container *self, enum search_flags flags)
801 {
802         int res = 0;
803
804         if (!is_ao2_object(self) || !self->v_table) {
805                 /* Sanity checks. */
806                 ast_assert(0);
807                 return -1;
808         }
809 #if defined(AO2_DEBUG)
810         if (!self->v_table->integrity) {
811                 /* No ingetrigy check available.  Assume container is ok. */
812                 return 0;
813         }
814
815         if (!(flags & OBJ_NOLOCK)) {
816                 ao2_rdlock(self);
817         }
818         res = self->v_table->integrity(self);
819         if (!(flags & OBJ_NOLOCK)) {
820                 ao2_unlock(self);
821         }
822 #endif  /* defined(AO2_DEBUG) */
823         return res;
824 }
825
826 #if defined(AO2_DEBUG)
827 static struct ao2_container *reg_containers;
828
829 struct ao2_reg_container {
830         /*! Registered container pointer. */
831         struct ao2_container *registered;
832         /*! Callback function to print the given object's key. (NULL if not available) */
833         ao2_prnt_obj_fn *prnt_obj;
834         /*! Name container registered under. */
835         char name[1];
836 };
837
838 struct ao2_reg_partial_key {
839         /*! Length of partial key match. */
840         int len;
841         /*! Registration partial key name. */
842         const char *name;
843 };
844
845 struct ao2_reg_match {
846         /*! The nth match to find. */
847         int find_nth;
848         /*! Count of the matches already found. */
849         int count;
850 };
851 #endif  /* defined(AO2_DEBUG) */
852
853 #if defined(AO2_DEBUG)
854 static int ao2_reg_sort_cb(const void *obj_left, const void *obj_right, int flags)
855 {
856         const struct ao2_reg_container *reg_left = obj_left;
857         int cmp;
858
859         switch (flags & OBJ_SEARCH_MASK) {
860         case OBJ_SEARCH_OBJECT:
861                 {
862                         const struct ao2_reg_container *reg_right = obj_right;
863
864                         cmp = strcasecmp(reg_left->name, reg_right->name);
865                 }
866                 break;
867         case OBJ_SEARCH_KEY:
868                 {
869                         const char *name = obj_right;
870
871                         cmp = strcasecmp(reg_left->name, name);
872                 }
873                 break;
874         case OBJ_SEARCH_PARTIAL_KEY:
875                 {
876                         const struct ao2_reg_partial_key *partial_key = obj_right;
877
878                         cmp = strncasecmp(reg_left->name, partial_key->name, partial_key->len);
879                 }
880                 break;
881         default:
882                 /* Sort can only work on something with a full or partial key. */
883                 ast_assert(0);
884                 cmp = 0;
885                 break;
886         }
887         return cmp;
888 }
889 #endif  /* defined(AO2_DEBUG) */
890
891 #if defined(AO2_DEBUG)
892 static void ao2_reg_destructor(void *v_doomed)
893 {
894         struct ao2_reg_container *doomed = v_doomed;
895
896         if (doomed->registered) {
897                 ao2_t_ref(doomed->registered, -1, "Releasing registered container.");
898         }
899 }
900 #endif  /* defined(AO2_DEBUG) */
901
902 int ao2_container_register(const char *name, struct ao2_container *self, ao2_prnt_obj_fn *prnt_obj)
903 {
904         int res = 0;
905 #if defined(AO2_DEBUG)
906         struct ao2_reg_container *reg;
907
908         reg = ao2_t_alloc_options(sizeof(*reg) + strlen(name), ao2_reg_destructor,
909                 AO2_ALLOC_OPT_LOCK_NOLOCK, "Container registration object.");
910         if (!reg) {
911                 return -1;
912         }
913
914         /* Fill in registered entry */
915         ao2_t_ref(self, +1, "Registering container.");
916         reg->registered = self;
917         reg->prnt_obj = prnt_obj;
918         strcpy(reg->name, name);/* safe */
919
920         if (!ao2_t_link(reg_containers, reg, "Save registration object.")) {
921                 res = -1;
922         }
923
924         ao2_t_ref(reg, -1, "Done registering container.");
925 #endif  /* defined(AO2_DEBUG) */
926         return res;
927 }
928
929 void ao2_container_unregister(const char *name)
930 {
931 #if defined(AO2_DEBUG)
932         ao2_t_find(reg_containers, name, OBJ_UNLINK | OBJ_NODATA | OBJ_SEARCH_KEY,
933                 "Unregister container");
934 #endif  /* defined(AO2_DEBUG) */
935 }
936
937 #if defined(AO2_DEBUG)
938 static int ao2_complete_reg_cb(void *obj, void *arg, void *data, int flags)
939 {
940         struct ao2_reg_match *which = data;
941
942         /* ao2_reg_sort_cb() has already filtered the search to matching keys */
943         return (which->find_nth < ++which->count) ? (CMP_MATCH | CMP_STOP) : 0;
944 }
945 #endif  /* defined(AO2_DEBUG) */
946
947 #if defined(AO2_DEBUG)
948 static char *complete_container_names(struct ast_cli_args *a)
949 {
950         struct ao2_reg_partial_key partial_key;
951         struct ao2_reg_match which;
952         struct ao2_reg_container *reg;
953         char *name;
954
955         if (a->pos != 3) {
956                 return NULL;
957         }
958
959         partial_key.len = strlen(a->word);
960         partial_key.name = a->word;
961         which.find_nth = a->n;
962         which.count = 0;
963         reg = ao2_t_callback_data(reg_containers, partial_key.len ? OBJ_SEARCH_PARTIAL_KEY : 0,
964                 ao2_complete_reg_cb, &partial_key, &which, "Find partial registered container");
965         if (reg) {
966                 name = ast_strdup(reg->name);
967                 ao2_t_ref(reg, -1, "Done with registered container object.");
968         } else {
969                 name = NULL;
970         }
971         return name;
972 }
973 #endif  /* defined(AO2_DEBUG) */
974
975 #if defined(AO2_DEBUG)
976 AST_THREADSTORAGE(ao2_out_buf);
977
978 /*!
979  * \brief Print CLI output.
980  * \since 12.0.0
981  *
982  * \param where User data pointer needed to determine where to put output.
983  * \param fmt printf type format string.
984  *
985  * \return Nothing
986  */
987 static void cli_output(void *where, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
988 static void cli_output(void *where, const char *fmt, ...)
989 {
990         int res;
991         struct ast_str *buf;
992         va_list ap;
993
994         buf = ast_str_thread_get(&ao2_out_buf, 256);
995         if (!buf) {
996                 return;
997         }
998
999         va_start(ap, fmt);
1000         res = ast_str_set_va(&buf, 0, fmt, ap);
1001         va_end(ap);
1002
1003         if (res != AST_DYNSTR_BUILD_FAILED) {
1004                 ast_cli(*(int *) where, "%s", ast_str_buffer(buf));
1005         }
1006 }
1007 #endif  /* defined(AO2_DEBUG) */
1008
1009 #if defined(AO2_DEBUG)
1010 /*! \brief Show container contents - CLI command */
1011 static char *handle_cli_astobj2_container_dump(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1012 {
1013         const char *name;
1014         struct ao2_reg_container *reg;
1015
1016         switch (cmd) {
1017         case CLI_INIT:
1018                 e->command = "astobj2 container dump";
1019                 e->usage =
1020                         "Usage: astobj2 container dump <name>\n"
1021                         "       Show contents of the container <name>.\n";
1022                 return NULL;
1023         case CLI_GENERATE:
1024                 return complete_container_names(a);
1025         }
1026
1027         if (a->argc != 4) {
1028                 return CLI_SHOWUSAGE;
1029         }
1030
1031         name = a->argv[3];
1032         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
1033         if (reg) {
1034                 ao2_container_dump(reg->registered, 0, name, (void *) &a->fd, cli_output,
1035                         reg->prnt_obj);
1036                 ao2_t_ref(reg, -1, "Done with registered container object.");
1037         } else {
1038                 ast_cli(a->fd, "Container '%s' not found.\n", name);
1039         }
1040
1041         return CLI_SUCCESS;
1042 }
1043 #endif  /* defined(AO2_DEBUG) */
1044
1045 #if defined(AO2_DEBUG)
1046 /*! \brief Show container statistics - CLI command */
1047 static char *handle_cli_astobj2_container_stats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1048 {
1049         const char *name;
1050         struct ao2_reg_container *reg;
1051
1052         switch (cmd) {
1053         case CLI_INIT:
1054                 e->command = "astobj2 container stats";
1055                 e->usage =
1056                         "Usage: astobj2 container stats <name>\n"
1057                         "       Show statistics about the specified container <name>.\n";
1058                 return NULL;
1059         case CLI_GENERATE:
1060                 return complete_container_names(a);
1061         }
1062
1063         if (a->argc != 4) {
1064                 return CLI_SHOWUSAGE;
1065         }
1066
1067         name = a->argv[3];
1068         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
1069         if (reg) {
1070                 ao2_container_stats(reg->registered, 0, name, (void *) &a->fd, cli_output);
1071                 ao2_t_ref(reg, -1, "Done with registered container object.");
1072         } else {
1073                 ast_cli(a->fd, "Container '%s' not found.\n", name);
1074         }
1075
1076         return CLI_SUCCESS;
1077 }
1078 #endif  /* defined(AO2_DEBUG) */
1079
1080 #if defined(AO2_DEBUG)
1081 /*! \brief Show container check results - CLI command */
1082 static char *handle_cli_astobj2_container_check(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1083 {
1084         const char *name;
1085         struct ao2_reg_container *reg;
1086
1087         switch (cmd) {
1088         case CLI_INIT:
1089                 e->command = "astobj2 container check";
1090                 e->usage =
1091                         "Usage: astobj2 container check <name>\n"
1092                         "       Perform a container integrity check on <name>.\n";
1093                 return NULL;
1094         case CLI_GENERATE:
1095                 return complete_container_names(a);
1096         }
1097
1098         if (a->argc != 4) {
1099                 return CLI_SHOWUSAGE;
1100         }
1101
1102         name = a->argv[3];
1103         reg = ao2_t_find(reg_containers, name, OBJ_SEARCH_KEY, "Find registered container");
1104         if (reg) {
1105                 ast_cli(a->fd, "Container check of '%s': %s.\n", name,
1106                         ao2_container_check(reg->registered, 0) ? "failed" : "OK");
1107                 ao2_t_ref(reg, -1, "Done with registered container object.");
1108         } else {
1109                 ast_cli(a->fd, "Container '%s' not found.\n", name);
1110         }
1111
1112         return CLI_SUCCESS;
1113 }
1114 #endif  /* defined(AO2_DEBUG) */
1115
1116 #if defined(AO2_DEBUG)
1117 static struct ast_cli_entry cli_astobj2[] = {
1118         AST_CLI_DEFINE(handle_cli_astobj2_container_dump, "Show container contents"),
1119         AST_CLI_DEFINE(handle_cli_astobj2_container_stats, "Show container statistics"),
1120         AST_CLI_DEFINE(handle_cli_astobj2_container_check, "Perform a container integrity check"),
1121 };
1122 #endif  /* defined(AO2_DEBUG) */
1123
1124 #if defined(AO2_DEBUG)
1125 static void container_cleanup(void)
1126 {
1127         ao2_t_ref(reg_containers, -1, "Releasing container registration container");
1128         reg_containers = NULL;
1129
1130         ast_cli_unregister_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
1131 }
1132 #endif  /* defined(AO2_DEBUG) */
1133
1134 int container_init(void)
1135 {
1136 #if defined(AO2_DEBUG)
1137         reg_containers = ao2_t_container_alloc_list(AO2_ALLOC_OPT_LOCK_RWLOCK,
1138                 AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, ao2_reg_sort_cb, NULL,
1139                 "Container registration container.");
1140         if (!reg_containers) {
1141                 return -1;
1142         }
1143
1144         ast_cli_register_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
1145         ast_register_cleanup(container_cleanup);
1146 #endif  /* defined(AO2_DEBUG) */
1147
1148         return 0;
1149 }
1150