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