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