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