Merge the rest of the FullyBooted patch
[asterisk/asterisk.git] / main / astobj2.c
1 /*
2  * astobj2 - replacement containers for asterisk data structures.
3  *
4  * Copyright (C) 2006 Marta Carbone, Luigi Rizzo - Univ. di Pisa, Italy
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*
18  * Function implementing astobj2 objects.
19  */
20 #include "asterisk.h"
21
22 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
23
24 #include "asterisk/_private.h"
25 #include "asterisk/astobj2.h"
26 #include "asterisk/utils.h"
27 #include "asterisk/cli.h"
28 #define REF_FILE "/tmp/refs"
29
30 /*!
31  * astobj2 objects are always preceded by this data structure,
32  * which contains a lock, a reference counter,
33  * the flags and a pointer to a destructor.
34  * The refcount is used to decide when it is time to
35  * invoke the destructor.
36  * The magic number is used for consistency check.
37  * XXX the lock is not always needed, and its initialization may be
38  * expensive. Consider making it external.
39  */
40 struct __priv_data {
41         ast_mutex_t lock;
42         int ref_counter;
43         ao2_destructor_fn destructor_fn;
44         /*! for stats */
45         size_t data_size;
46         /*! magic number.  This is used to verify that a pointer passed in is a
47          *  valid astobj2 */
48         uint32_t magic;
49 };
50
51 #define AO2_MAGIC       0xa570b123
52
53 /*!
54  * What an astobj2 object looks like: fixed-size private data
55  * followed by variable-size user data.
56  */
57 struct astobj2 {
58         struct __priv_data priv_data;
59         void *user_data[0];
60 };
61
62 #ifdef AST_DEVMODE
63 #define AO2_DEBUG 1
64 #endif
65
66 #ifdef AO2_DEBUG
67 struct ao2_stats {
68         volatile int total_objects;
69         volatile int total_mem;
70         volatile int total_containers;
71         volatile int total_refs;
72         volatile int total_locked;
73 };
74
75 static struct ao2_stats ao2;
76 #endif
77
78 #ifndef HAVE_BKTR       /* backtrace support */
79 void ao2_bt(void) {}
80 #else
81 #include <execinfo.h>    /* for backtrace */
82
83 void ao2_bt(void)
84 {
85         int c, i;
86 #define N1      20
87         void *addresses[N1];
88         char **strings;
89
90         c = backtrace(addresses, N1);
91         strings = backtrace_symbols(addresses,c);
92         ast_verbose("backtrace returned: %d\n", c);
93         for(i = 0; i < c; i++) {
94                 ast_verbose("%d: %p %s\n", i, addresses[i], strings[i]);
95         }
96         free(strings);
97 }
98 #endif
99
100 /*!
101  * \brief convert from a pointer _p to a user-defined object
102  *
103  * \return the pointer to the astobj2 structure
104  */
105 static inline struct astobj2 *INTERNAL_OBJ(void *user_data)
106 {
107         struct astobj2 *p;
108
109         if (!user_data) {
110                 ast_log(LOG_ERROR, "user_data is NULL\n");
111                 return NULL;
112         }
113
114         p = (struct astobj2 *) ((char *) user_data - sizeof(*p));
115         if (AO2_MAGIC != (p->priv_data.magic) ) {
116                 ast_log(LOG_ERROR, "bad magic number 0x%x for %p\n", p->priv_data.magic, p);
117                 p = NULL;
118         }
119
120         return p;
121 }
122
123 enum ao2_callback_type {
124         DEFAULT,
125         WITH_DATA,
126 };
127
128 /*!
129  * \brief convert from a pointer _p to an astobj2 object
130  *
131  * \return the pointer to the user-defined portion.
132  */
133 #define EXTERNAL_OBJ(_p)        ((_p) == NULL ? NULL : (_p)->user_data)
134
135 /* the underlying functions common to debug and non-debug versions */
136
137 static int internal_ao2_ref(void *user_data, const int delta);
138 static struct ao2_container *internal_ao2_container_alloc(struct ao2_container *c, const uint n_buckets, ao2_hash_fn *hash_fn,
139                                                           ao2_callback_fn *cmp_fn);
140 static struct bucket_entry *internal_ao2_link(struct ao2_container *c, void *user_data, const char *file, int line, const char *func);
141 static void *internal_ao2_callback(struct ao2_container *c,
142                                    const enum search_flags flags, void *cb_fn, void *arg, void *data, enum ao2_callback_type type,
143                                    char *tag, char *file, int line, const char *funcname);
144 static void *internal_ao2_iterator_next(struct ao2_iterator *a, struct bucket_entry **q);
145
146 int __ao2_lock(void *user_data, const char *file, const char *func, int line, const char *var)
147 {
148         struct astobj2 *p = INTERNAL_OBJ(user_data);
149
150         if (p == NULL)
151                 return -1;
152
153 #ifdef AO2_DEBUG
154         ast_atomic_fetchadd_int(&ao2.total_locked, 1);
155 #endif
156
157         return __ast_pthread_mutex_lock(file, line, func, var, &p->priv_data.lock);
158 }
159
160 int __ao2_unlock(void *user_data, const char *file, const char *func, int line, const char *var)
161 {
162         struct astobj2 *p = INTERNAL_OBJ(user_data);
163
164         if (p == NULL)
165                 return -1;
166
167 #ifdef AO2_DEBUG
168         ast_atomic_fetchadd_int(&ao2.total_locked, -1);
169 #endif
170
171         return __ast_pthread_mutex_unlock(file, line, func, var, &p->priv_data.lock);
172 }
173
174 int __ao2_trylock(void *user_data, const char *file, const char *func, int line, const char *var)
175 {
176         struct astobj2 *p = INTERNAL_OBJ(user_data);
177         int ret;
178         
179         if (p == NULL)
180                 return -1;
181         ret = __ast_pthread_mutex_trylock(file, line, func, var, &p->priv_data.lock);
182
183 #ifdef AO2_DEBUG
184         if (!ret)
185                 ast_atomic_fetchadd_int(&ao2.total_locked, 1);
186 #endif
187         return ret;
188 }
189
190 void *ao2_object_get_lockaddr(void *obj)
191 {
192         struct astobj2 *p = INTERNAL_OBJ(obj);
193         
194         if (p == NULL)
195                 return NULL;
196
197         return &p->priv_data.lock;
198 }
199
200 /*
201  * The argument is a pointer to the user portion.
202  */
203
204
205 int __ao2_ref_debug(void *user_data, const int delta, char *tag, char *file, int line, const char *funcname)
206 {
207         struct astobj2 *obj = INTERNAL_OBJ(user_data);
208         
209         if (obj == NULL)
210                 return -1;
211
212         if (delta != 0) {
213                 FILE *refo = fopen(REF_FILE,"a");
214                 fprintf(refo, "%p %s%d   %s:%d:%s (%s) [@%d]\n", user_data, (delta<0? "":"+"), delta, file, line, funcname, tag, obj ? obj->priv_data.ref_counter : -1);
215                 fclose(refo);
216         }
217         if (obj->priv_data.ref_counter + delta == 0 && obj->priv_data.destructor_fn != NULL) { /* this isn't protected with lock; just for o/p */
218                         FILE *refo = fopen(REF_FILE,"a");        
219                         fprintf(refo, "%p **call destructor** %s:%d:%s (%s)\n", user_data, file, line, funcname, tag);   
220                         fclose(refo);
221         }
222         return internal_ao2_ref(user_data, delta);
223 }
224
225 int __ao2_ref(void *user_data, const int delta)
226 {
227         struct astobj2 *obj = INTERNAL_OBJ(user_data);
228
229         if (obj == NULL)
230                 return -1;
231
232         return internal_ao2_ref(user_data, delta);
233 }
234
235 static int internal_ao2_ref(void *user_data, const int delta)
236 {
237         struct astobj2 *obj = INTERNAL_OBJ(user_data);
238         int current_value;
239         int ret;
240
241         if (obj == NULL)
242                 return -1;
243
244         /* if delta is 0, just return the refcount */
245         if (delta == 0)
246                 return (obj->priv_data.ref_counter);
247
248         /* we modify with an atomic operation the reference counter */
249         ret = ast_atomic_fetchadd_int(&obj->priv_data.ref_counter, delta);
250         current_value = ret + delta;
251
252 #ifdef AO2_DEBUG        
253         ast_atomic_fetchadd_int(&ao2.total_refs, delta);
254 #endif
255
256         /* this case must never happen */
257         if (current_value < 0)
258                 ast_log(LOG_ERROR, "refcount %d on object %p\n", current_value, user_data);
259
260         if (current_value <= 0) { /* last reference, destroy the object */
261                 if (obj->priv_data.destructor_fn != NULL) {
262                         obj->priv_data.destructor_fn(user_data);
263                 }
264
265                 ast_mutex_destroy(&obj->priv_data.lock);
266 #ifdef AO2_DEBUG
267                 ast_atomic_fetchadd_int(&ao2.total_mem, - obj->priv_data.data_size);
268                 ast_atomic_fetchadd_int(&ao2.total_objects, -1);
269 #endif
270                 /* for safety, zero-out the astobj2 header and also the
271                  * first word of the user-data, which we make sure is always
272                  * allocated. */
273                 memset(obj, '\0', sizeof(struct astobj2 *) + sizeof(void *) );
274                 ast_free(obj);
275         }
276
277         return ret;
278 }
279
280 /*
281  * We always alloc at least the size of a void *,
282  * for debugging purposes.
283  */
284 static void *internal_ao2_alloc(size_t data_size, ao2_destructor_fn destructor_fn, const char *file, int line, const char *funcname)
285 {
286         /* allocation */
287         struct astobj2 *obj;
288
289         if (data_size < sizeof(void *))
290                 data_size = sizeof(void *);
291
292 #if defined(__AST_DEBUG_MALLOC)
293         obj = __ast_calloc(1, sizeof(*obj) + data_size, file, line, funcname);
294 #else
295         obj = ast_calloc(1, sizeof(*obj) + data_size);
296 #endif
297
298         if (obj == NULL)
299                 return NULL;
300
301         ast_mutex_init(&obj->priv_data.lock);
302         obj->priv_data.magic = AO2_MAGIC;
303         obj->priv_data.data_size = data_size;
304         obj->priv_data.ref_counter = 1;
305         obj->priv_data.destructor_fn = destructor_fn;   /* can be NULL */
306
307 #ifdef AO2_DEBUG
308         ast_atomic_fetchadd_int(&ao2.total_objects, 1);
309         ast_atomic_fetchadd_int(&ao2.total_mem, data_size);
310         ast_atomic_fetchadd_int(&ao2.total_refs, 1);
311 #endif
312
313         /* return a pointer to the user data */
314         return EXTERNAL_OBJ(obj);
315 }
316
317 void *__ao2_alloc_debug(size_t data_size, ao2_destructor_fn destructor_fn, char *tag,
318                         const char *file, int line, const char *funcname, int ref_debug)
319 {
320         /* allocation */
321         void *obj;
322         FILE *refo = ref_debug ? fopen(REF_FILE,"a") : NULL;
323
324         if ((obj = internal_ao2_alloc(data_size, destructor_fn, file, line, funcname)) == NULL) {
325                 fclose(refo);
326                 return NULL;
327         }
328
329         if (refo) {
330                 fprintf(refo, "%p =1   %s:%d:%s (%s)\n", obj, file, line, funcname, tag);
331                 fclose(refo);
332         }
333
334         /* return a pointer to the user data */
335         return obj;
336 }
337
338 void *__ao2_alloc(size_t data_size, ao2_destructor_fn destructor_fn)
339 {
340         return internal_ao2_alloc(data_size, destructor_fn, __FILE__, __LINE__, __FUNCTION__);
341 }
342
343
344 /* internal callback to destroy a container. */
345 static void container_destruct(void *c);
346
347 /* internal callback to destroy a container. */
348 static void container_destruct_debug(void *c);
349
350 /* each bucket in the container is a tailq. */
351 AST_LIST_HEAD_NOLOCK(bucket, bucket_entry);
352
353 /*!
354  * A container; stores the hash and callback functions, information on
355  * the size, the hash bucket heads, and a version number, starting at 0
356  * (for a newly created, empty container)
357  * and incremented every time an object is inserted or deleted.
358  * The assumption is that an object is never moved in a container,
359  * but removed and readded with the new number.
360  * The version number is especially useful when implementing iterators.
361  * In fact, we can associate a unique, monotonically increasing number to
362  * each object, which means that, within an iterator, we can store the
363  * version number of the current object, and easily look for the next one,
364  * which is the next one in the list with a higher number.
365  * Since all objects have a version >0, we can use 0 as a marker for
366  * 'we need the first object in the bucket'.
367  *
368  * \todo Linking and unlink objects is typically expensive, as it
369  * involves a malloc() of a small object which is very inefficient.
370  * To optimize this, we allocate larger arrays of bucket_entry's
371  * when we run out of them, and then manage our own freelist.
372  * This will be more efficient as we can do the freelist management while
373  * we hold the lock (that we need anyways).
374  */
375 struct ao2_container {
376         ao2_hash_fn *hash_fn;
377         ao2_callback_fn *cmp_fn;
378         int n_buckets;
379         /*! Number of elements in the container */
380         int elements;
381         /*! described above */
382         int version;
383         /*! variable size */
384         struct bucket buckets[0];
385 };
386  
387 /*!
388  * \brief always zero hash function
389  *
390  * it is convenient to have a hash function that always returns 0.
391  * This is basically used when we want to have a container that is
392  * a simple linked list.
393  *
394  * \returns 0
395  */
396 static int hash_zero(const void *user_obj, const int flags)
397 {
398         return 0;
399 }
400
401 /*
402  * A container is just an object, after all!
403  */
404 static struct ao2_container *internal_ao2_container_alloc(struct ao2_container *c, const unsigned int n_buckets, ao2_hash_fn *hash_fn,
405                                                           ao2_callback_fn *cmp_fn)
406 {
407         /* XXX maybe consistency check on arguments ? */
408         /* compute the container size */
409
410         if (!c)
411                 return NULL;
412         
413         c->version = 1; /* 0 is a reserved value here */
414         c->n_buckets = hash_fn ? n_buckets : 1;
415         c->hash_fn = hash_fn ? hash_fn : hash_zero;
416         c->cmp_fn = cmp_fn;
417
418 #ifdef AO2_DEBUG
419         ast_atomic_fetchadd_int(&ao2.total_containers, 1);
420 #endif
421
422         return c;
423 }
424
425 struct ao2_container *__ao2_container_alloc_debug(const unsigned int n_buckets, ao2_hash_fn *hash_fn,
426                                                   ao2_callback_fn *cmp_fn, char *tag, char *file, int line,
427                                                   const char *funcname, int ref_debug)
428 {
429         /* XXX maybe consistency check on arguments ? */
430         /* compute the container size */
431         const unsigned int num_buckets = hash_fn ? n_buckets : 1;
432         size_t container_size = sizeof(struct ao2_container) + num_buckets * sizeof(struct bucket);
433         struct ao2_container *c = __ao2_alloc_debug(container_size, container_destruct_debug, tag, file, line, funcname, ref_debug);
434
435         return internal_ao2_container_alloc(c, num_buckets, hash_fn, cmp_fn);
436 }
437
438 struct ao2_container *__ao2_container_alloc(const unsigned int n_buckets, ao2_hash_fn *hash_fn,
439                                             ao2_callback_fn *cmp_fn)
440 {
441         /* XXX maybe consistency check on arguments ? */
442         /* compute the container size */
443
444         const unsigned int num_buckets = hash_fn ? n_buckets : 1;
445         size_t container_size = sizeof(struct ao2_container) + num_buckets * sizeof(struct bucket);
446         struct ao2_container *c = __ao2_alloc(container_size, container_destruct);
447
448         return internal_ao2_container_alloc(c, num_buckets, hash_fn, cmp_fn);
449 }
450
451 /*!
452  * return the number of elements in the container
453  */
454 int ao2_container_count(struct ao2_container *c)
455 {
456         return c->elements;
457 }
458
459 /*!
460  * A structure to create a linked list of entries,
461  * used within a bucket.
462  * XXX \todo this should be private to the container code
463  */
464 struct bucket_entry {
465         AST_LIST_ENTRY(bucket_entry) entry;
466         int version;
467         struct astobj2 *astobj;         /* pointer to internal data */
468 }; 
469
470 /*
471  * link an object to a container
472  */
473
474 static struct bucket_entry *internal_ao2_link(struct ao2_container *c, void *user_data, const char *file, int line, const char *func)
475 {
476         int i;
477         /* create a new list entry */
478         struct bucket_entry *p;
479         struct astobj2 *obj = INTERNAL_OBJ(user_data);
480
481         if (obj == NULL)
482                 return NULL;
483
484         if (INTERNAL_OBJ(c) == NULL)
485                 return NULL;
486
487         p = ast_calloc(1, sizeof(*p));
488         if (!p)
489                 return NULL;
490
491         i = abs(c->hash_fn(user_data, OBJ_POINTER));
492
493         ao2_lock(c);
494         i %= c->n_buckets;
495         p->astobj = obj;
496         p->version = ast_atomic_fetchadd_int(&c->version, 1);
497         AST_LIST_INSERT_TAIL(&c->buckets[i], p, entry);
498         ast_atomic_fetchadd_int(&c->elements, 1);
499
500         /* the last two operations (ao2_ref, ao2_unlock) must be done by the calling func */
501         return p;
502 }
503
504 void *__ao2_link_debug(struct ao2_container *c, void *user_data, char *tag, char *file, int line, const char *funcname)
505 {
506         struct bucket_entry *p = internal_ao2_link(c, user_data, file, line, funcname);
507
508         if (p) {
509                 __ao2_ref_debug(user_data, +1, tag, file, line, funcname);
510                 ao2_unlock(c);
511         }
512         return p;
513 }
514
515 void *__ao2_link(struct ao2_container *c, void *user_data)
516 {
517         struct bucket_entry *p = internal_ao2_link(c, user_data, __FILE__, __LINE__, __PRETTY_FUNCTION__);
518
519         if (p) {
520                 __ao2_ref(user_data, +1);
521                 ao2_unlock(c);
522         }
523         return p;
524 }
525
526 /*!
527  * \brief another convenience function is a callback that matches on address
528  */
529 int ao2_match_by_addr(void *user_data, void *arg, int flags)
530 {
531         return (user_data == arg) ? (CMP_MATCH | CMP_STOP) : 0;
532 }
533
534 /*
535  * Unlink an object from the container
536  * and destroy the associated * bucket_entry structure.
537  */
538 void *__ao2_unlink_debug(struct ao2_container *c, void *user_data, char *tag,
539                          char *file, int line, const char *funcname)
540 {
541         if (INTERNAL_OBJ(user_data) == NULL)    /* safety check on the argument */
542                 return NULL;
543
544         __ao2_callback_debug(c, OBJ_UNLINK | OBJ_POINTER | OBJ_NODATA, ao2_match_by_addr, user_data, tag, file, line, funcname);
545
546         return NULL;
547 }
548
549 void *__ao2_unlink(struct ao2_container *c, void *user_data)
550 {
551         if (INTERNAL_OBJ(user_data) == NULL)    /* safety check on the argument */
552                 return NULL;
553
554         __ao2_callback(c, OBJ_UNLINK | OBJ_POINTER | OBJ_NODATA, ao2_match_by_addr, user_data);
555
556         return NULL;
557 }
558
559 /*! 
560  * \brief special callback that matches all 
561  */ 
562 static int cb_true(void *user_data, void *arg, int flags)
563 {
564         return CMP_MATCH;
565 }
566
567 /*!
568  * \brief similar to cb_true, but is an ao2_callback_data_fn instead
569  */
570 static int cb_true_data(void *user_data, void *arg, void *data, int flags)
571 {
572         return CMP_MATCH;
573 }
574
575 /*!
576  * Browse the container using different stategies accoding the flags.
577  * \return Is a pointer to an object or to a list of object if OBJ_MULTIPLE is 
578  * specified.
579  * Luckily, for debug purposes, the added args (tag, file, line, funcname)
580  * aren't an excessive load to the system, as the callback should not be
581  * called as often as, say, the ao2_ref func is called.
582  */
583 static void *internal_ao2_callback(struct ao2_container *c,
584                                    const enum search_flags flags, void *cb_fn, void *arg, void *data, enum ao2_callback_type type,
585                                    char *tag, char *file, int line, const char *funcname)
586 {
587         int i, start, last;     /* search boundaries */
588         void *ret = NULL;
589         ao2_callback_fn *cb_default = NULL;
590         ao2_callback_data_fn *cb_withdata = NULL;
591         struct ao2_container *multi_container = NULL;
592         struct ao2_iterator *multi_iterator = NULL;
593
594         if (INTERNAL_OBJ(c) == NULL)    /* safety check on the argument */
595                 return NULL;
596
597         /*
598          * This logic is used so we can support OBJ_MULTIPLE with OBJ_NODATA
599          * turned off.  This if statement checks for the special condition
600          * where multiple items may need to be returned.
601          */
602         if ((flags & (OBJ_MULTIPLE | OBJ_NODATA)) == OBJ_MULTIPLE) {
603                 /* we need to return an ao2_iterator with the results,
604                  * as there could be more than one. the iterator will
605                  * hold the only reference to a container that has all the
606                  * matching objects linked into it, so when the iterator
607                  * is destroyed, the container will be automatically
608                  * destroyed as well.
609                  */
610                 if (!(multi_container = __ao2_container_alloc(1, NULL, NULL))) {
611                         return NULL;
612                 }
613                 if (!(multi_iterator = ast_calloc(1, sizeof(*multi_iterator)))) {
614                         ao2_ref(multi_container, -1);
615                         return NULL;
616                 }
617         }
618
619         /* override the match function if necessary */
620         if (cb_fn == NULL) { /* if NULL, match everything */
621                 if (type == WITH_DATA) {
622                         cb_withdata = cb_true_data;
623                 } else {
624                         cb_default = cb_true;
625                 }
626         } else {
627                 /* We do this here to avoid the per object casting penalty (even though
628                    that is probably optimized away anyway). */
629                 if (type == WITH_DATA) {
630                         cb_withdata = cb_fn;
631                 } else {
632                         cb_default = cb_fn;
633                 }
634         }
635
636         /*
637          * XXX this can be optimized.
638          * If we have a hash function and lookup by pointer,
639          * run the hash function. Otherwise, scan the whole container
640          * (this only for the time being. We need to optimize this.)
641          */
642         if ((flags & OBJ_POINTER))      /* we know hash can handle this case */
643                 start = i = c->hash_fn(arg, flags & OBJ_POINTER) % c->n_buckets;
644         else                    /* don't know, let's scan all buckets */
645                 start = i = -1;         /* XXX this must be fixed later. */
646
647         /* determine the search boundaries: i..last-1 */
648         if (i < 0) {
649                 start = i = 0;
650                 last = c->n_buckets;
651         } else if ((flags & OBJ_CONTINUE)) {
652                 last = c->n_buckets;
653         } else {
654                 last = i + 1;
655         }
656
657         ao2_lock(c);    /* avoid modifications to the content */
658
659         for (; i < last ; i++) {
660                 /* scan the list with prev-cur pointers */
661                 struct bucket_entry *cur;
662
663                 AST_LIST_TRAVERSE_SAFE_BEGIN(&c->buckets[i], cur, entry) {
664                         int match = (CMP_MATCH | CMP_STOP);
665
666                         if (type == WITH_DATA) {
667                                 match &= cb_withdata(EXTERNAL_OBJ(cur->astobj), arg, data, flags);
668                         } else {
669                                 match &= cb_default(EXTERNAL_OBJ(cur->astobj), arg, flags);
670                         }
671
672                         /* we found the object, performing operations according flags */
673                         if (match == 0) {       /* no match, no stop, continue */
674                                 continue;
675                         } else if (match == CMP_STOP) { /* no match but stop, we are done */
676                                 i = last;
677                                 break;
678                         }
679
680                         /* we have a match (CMP_MATCH) here */
681                         if (!(flags & OBJ_NODATA)) {    /* if must return the object, record the value */
682                                 /* it is important to handle this case before the unlink */
683                                 ret = EXTERNAL_OBJ(cur->astobj);
684                                 if (!(flags & (OBJ_UNLINK | OBJ_MULTIPLE))) {
685                                         if (tag)
686                                                 __ao2_ref_debug(ret, 1, tag, file, line, funcname);
687                                         else
688                                                 __ao2_ref(ret, 1);
689                                 }
690                         }
691
692                         /* If we are in OBJ_MULTIPLE mode and OBJ_NODATE is off, 
693                          * link the object into the container that will hold the results.
694                          */
695                         if (ret && (multi_container != NULL)) {
696                                 __ao2_link(multi_container, ret);
697                                 ret = NULL;
698                         }
699
700                         if (flags & OBJ_UNLINK) {       /* must unlink */
701                                 /* we are going to modify the container, so update version */
702                                 ast_atomic_fetchadd_int(&c->version, 1);
703                                 AST_LIST_REMOVE_CURRENT(entry);
704                                 /* update number of elements */
705                                 ast_atomic_fetchadd_int(&c->elements, -1);
706
707                                 /* - When unlinking and not returning the result, (OBJ_NODATA), the ref from the container
708                                  * must be decremented.
709                                  * - When unlinking with OBJ_MULTIPLE the ref from the original container
710                                  * must be decremented regardless if OBJ_NODATA is used. This is because the result is
711                                  * returned in a new container that already holds its own ref for the object. If the ref
712                                  * from the original container is not accounted for here a memory leak occurs. */
713                                 if (flags & (OBJ_NODATA | OBJ_MULTIPLE)) {
714                                         if (tag)
715                                                 __ao2_ref_debug(EXTERNAL_OBJ(cur->astobj), -1, tag, file, line, funcname);
716                                         else
717                                                 __ao2_ref(EXTERNAL_OBJ(cur->astobj), -1);
718                                 }
719                                 ast_free(cur);  /* free the link record */
720                         }
721
722                         if ((match & CMP_STOP) || !(flags & OBJ_MULTIPLE)) {
723                                 /* We found our only (or last) match, so force an exit from
724                                    the outside loop. */
725                                 i = last;
726                                 break;
727                         }
728                 }
729                 AST_LIST_TRAVERSE_SAFE_END;
730
731                 if (ret) {
732                         break;
733                 }
734
735                 if (i == c->n_buckets - 1 && (flags & OBJ_POINTER) && (flags & OBJ_CONTINUE)) {
736                         /* Move to the beginning to ensure we check every bucket */
737                         i = -1;
738                         last = start;
739                 }
740         }
741         ao2_unlock(c);
742
743         /* if multi_container was created, we are returning multiple objects */
744         if (multi_container != NULL) {
745                 *multi_iterator = ao2_iterator_init(multi_container,
746                                                     AO2_ITERATOR_DONTLOCK | AO2_ITERATOR_UNLINK | AO2_ITERATOR_MALLOCD);
747                 ao2_ref(multi_container, -1);
748                 return multi_iterator;
749         } else {
750                 return ret;
751         }
752 }
753
754 void *__ao2_callback_debug(struct ao2_container *c,
755                            const enum search_flags flags,
756                            ao2_callback_fn *cb_fn, void *arg,
757                            char *tag, char *file, int line, const char *funcname)
758 {
759         return internal_ao2_callback(c,flags, cb_fn, arg, NULL, DEFAULT, tag, file, line, funcname);
760 }
761
762 void *__ao2_callback(struct ao2_container *c, const enum search_flags flags,
763                      ao2_callback_fn *cb_fn, void *arg)
764 {
765         return internal_ao2_callback(c,flags, cb_fn, arg, NULL, DEFAULT, NULL, NULL, 0, NULL);
766 }
767
768 void *__ao2_callback_data_debug(struct ao2_container *c,
769                                 const enum search_flags flags,
770                                 ao2_callback_data_fn *cb_fn, void *arg, void *data,
771                                 char *tag, char *file, int line, const char *funcname)
772 {
773         return internal_ao2_callback(c, flags, cb_fn, arg, data, WITH_DATA, tag, file, line, funcname);
774 }
775
776 void *__ao2_callback_data(struct ao2_container *c, const enum search_flags flags,
777                           ao2_callback_data_fn *cb_fn, void *arg, void *data)
778 {
779         return internal_ao2_callback(c, flags, cb_fn, arg, data, WITH_DATA, NULL, NULL, 0, NULL);
780 }
781
782 /*!
783  * the find function just invokes the default callback with some reasonable flags.
784  */
785 void *__ao2_find_debug(struct ao2_container *c, void *arg, enum search_flags flags, char *tag, char *file, int line, const char *funcname)
786 {
787         return __ao2_callback_debug(c, flags, c->cmp_fn, arg, tag, file, line, funcname);
788 }
789
790 void *__ao2_find(struct ao2_container *c, void *arg, enum search_flags flags)
791 {
792         return __ao2_callback(c, flags, c->cmp_fn, arg);
793 }
794
795 /*!
796  * initialize an iterator so we start from the first object
797  */
798 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags)
799 {
800         struct ao2_iterator a = {
801                 .c = c,
802                 .flags = flags
803         };
804
805         ao2_ref(c, +1);
806         
807         return a;
808 }
809
810 /*!
811  * destroy an iterator
812  */
813 void ao2_iterator_destroy(struct ao2_iterator *i)
814 {
815         ao2_ref(i->c, -1);
816         if (i->flags & AO2_ITERATOR_MALLOCD) {
817                 ast_free(i);
818         } else {
819                 i->c = NULL;
820         }
821 }
822
823 /*
824  * move to the next element in the container.
825  */
826 static void *internal_ao2_iterator_next(struct ao2_iterator *a, struct bucket_entry **q)
827 {
828         int lim;
829         struct bucket_entry *p = NULL;
830         void *ret = NULL;
831
832         *q = NULL;
833         
834         if (INTERNAL_OBJ(a->c) == NULL)
835                 return NULL;
836
837         if (!(a->flags & AO2_ITERATOR_DONTLOCK))
838                 ao2_lock(a->c);
839
840         /* optimization. If the container is unchanged and
841          * we have a pointer, try follow it
842          */
843         if (a->c->version == a->c_version && (p = a->obj)) {
844                 if ((p = AST_LIST_NEXT(p, entry)))
845                         goto found;
846                 /* nope, start from the next bucket */
847                 a->bucket++;
848                 a->version = 0;
849                 a->obj = NULL;
850         }
851
852         lim = a->c->n_buckets;
853
854         /* Browse the buckets array, moving to the next
855          * buckets if we don't find the entry in the current one.
856          * Stop when we find an element with version number greater
857          * than the current one (we reset the version to 0 when we
858          * switch buckets).
859          */
860         for (; a->bucket < lim; a->bucket++, a->version = 0) {
861                 /* scan the current bucket */
862                 AST_LIST_TRAVERSE(&a->c->buckets[a->bucket], p, entry) {
863                         if (p->version > a->version)
864                                 goto found;
865                 }
866         }
867
868 found:
869         if (p) {
870                 ret = EXTERNAL_OBJ(p->astobj);
871                 if (a->flags & AO2_ITERATOR_UNLINK) {
872                         /* we are going to modify the container, so update version */
873                         ast_atomic_fetchadd_int(&a->c->version, 1);
874                         AST_LIST_REMOVE(&a->c->buckets[a->bucket], p, entry);
875                         /* update number of elements */
876                         ast_atomic_fetchadd_int(&a->c->elements, -1);
877                         a->version = 0;
878                         a->obj = NULL;
879                         a->c_version = a->c->version;
880                         ast_free(p);
881                 } else {
882                         a->version = p->version;
883                         a->obj = p;
884                         a->c_version = a->c->version;
885                         /* inc refcount of returned object */
886                         *q = p;
887                 }
888         }
889
890         return ret;
891 }
892
893 void *__ao2_iterator_next_debug(struct ao2_iterator *a, char *tag, char *file, int line, const char *funcname)
894 {
895         struct bucket_entry *p;
896         void *ret = NULL;
897
898         ret = internal_ao2_iterator_next(a, &p);
899         
900         if (p) {
901                 /* inc refcount of returned object */
902                 __ao2_ref_debug(ret, 1, tag, file, line, funcname);
903         }
904
905         if (!(a->flags & AO2_ITERATOR_DONTLOCK))
906                 ao2_unlock(a->c);
907
908         return ret;
909 }
910
911 void *__ao2_iterator_next(struct ao2_iterator *a)
912 {
913         struct bucket_entry *p = NULL;
914         void *ret = NULL;
915
916         ret = internal_ao2_iterator_next(a, &p);
917         
918         if (p) {
919                 /* inc refcount of returned object */
920                 __ao2_ref(ret, 1);
921         }
922
923         if (!(a->flags & AO2_ITERATOR_DONTLOCK))
924                 ao2_unlock(a->c);
925
926         return ret;
927 }
928
929 /* callback for destroying container.
930  * we can make it simple as we know what it does
931  */
932 static int cd_cb(void *obj, void *arg, int flag)
933 {
934         __ao2_ref(obj, -1);
935         return 0;
936 }
937         
938 static int cd_cb_debug(void *obj, void *arg, int flag)
939 {
940         __ao2_ref_debug(obj, -1, "deref object via container destroy",  __FILE__, __LINE__, __PRETTY_FUNCTION__);
941         return 0;
942 }
943         
944 static void container_destruct(void *_c)
945 {
946         struct ao2_container *c = _c;
947         int i;
948
949         __ao2_callback(c, OBJ_UNLINK, cd_cb, NULL);
950
951         for (i = 0; i < c->n_buckets; i++) {
952                 struct bucket_entry *current;
953
954                 while ((current = AST_LIST_REMOVE_HEAD(&c->buckets[i], entry))) {
955                         ast_free(current);
956                 }
957         }
958
959 #ifdef AO2_DEBUG
960         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
961 #endif
962 }
963
964 static void container_destruct_debug(void *_c)
965 {
966         struct ao2_container *c = _c;
967         int i;
968
969         __ao2_callback_debug(c, OBJ_UNLINK, cd_cb_debug, NULL, "container_destruct_debug called", __FILE__, __LINE__, __PRETTY_FUNCTION__);
970
971         for (i = 0; i < c->n_buckets; i++) {
972                 struct bucket_entry *current;
973
974                 while ((current = AST_LIST_REMOVE_HEAD(&c->buckets[i], entry))) {
975                         ast_free(current);
976                 }
977         }
978
979 #ifdef AO2_DEBUG
980         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
981 #endif
982 }
983
984 #ifdef AO2_DEBUG
985 static int print_cb(void *obj, void *arg, int flag)
986 {
987         struct ast_cli_args *a = (struct ast_cli_args *) arg;
988         char *s = (char *)obj;
989
990         ast_cli(a->fd, "string <%s>\n", s);
991         return 0;
992 }
993
994 /*
995  * Print stats
996  */
997 static char *handle_astobj2_stats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
998 {
999         switch (cmd) {
1000         case CLI_INIT:
1001                 e->command = "astobj2 show stats";
1002                 e->usage = "Usage: astobj2 show stats\n"
1003                            "       Show astobj2 show stats\n";
1004                 return NULL;
1005         case CLI_GENERATE:
1006                 return NULL;
1007         }
1008         ast_cli(a->fd, "Objects    : %d\n", ao2.total_objects);
1009         ast_cli(a->fd, "Containers : %d\n", ao2.total_containers);
1010         ast_cli(a->fd, "Memory     : %d\n", ao2.total_mem);
1011         ast_cli(a->fd, "Locked     : %d\n", ao2.total_locked);
1012         ast_cli(a->fd, "Refs       : %d\n", ao2.total_refs);
1013         return CLI_SUCCESS;
1014 }
1015
1016 /*
1017  * This is testing code for astobj
1018  */
1019 static char *handle_astobj2_test(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1020 {
1021         struct ao2_container *c1;
1022         int i, lim;
1023         char *obj;
1024         static int prof_id = -1;
1025         struct ast_cli_args fake_args = { a->fd, 0, NULL };
1026
1027         switch (cmd) {
1028         case CLI_INIT:
1029                 e->command = "astobj2 test";
1030                 e->usage = "Usage: astobj2 test <num>\n"
1031                            "       Runs astobj2 test. Creates 'num' objects,\n"
1032                            "       and test iterators, callbacks and may be other stuff\n";
1033                 return NULL;
1034         case CLI_GENERATE:
1035                 return NULL;
1036         }
1037
1038         if (a->argc != 3) {
1039                 return CLI_SHOWUSAGE;
1040         }
1041
1042         if (prof_id == -1)
1043                 prof_id = ast_add_profile("ao2_alloc", 0);
1044
1045         ast_cli(a->fd, "argc %d argv %s %s %s\n", a->argc, a->argv[0], a->argv[1], a->argv[2]);
1046         lim = atoi(a->argv[2]);
1047         ast_cli(a->fd, "called astobj_test\n");
1048
1049         handle_astobj2_stats(e, CLI_HANDLER, &fake_args);
1050         /*
1051          * allocate a container with no default callback, and no hash function.
1052          * No hash means everything goes in the same bucket.
1053          */
1054         c1 = ao2_t_container_alloc(100, NULL /* no callback */, NULL /* no hash */,"test");
1055         ast_cli(a->fd, "container allocated as %p\n", c1);
1056
1057         /*
1058          * fill the container with objects.
1059          * ao2_alloc() gives us a reference which we pass to the
1060          * container when we do the insert.
1061          */
1062         for (i = 0; i < lim; i++) {
1063                 ast_mark(prof_id, 1 /* start */);
1064                 obj = ao2_t_alloc(80, NULL,"test");
1065                 ast_mark(prof_id, 0 /* stop */);
1066                 ast_cli(a->fd, "object %d allocated as %p\n", i, obj);
1067                 sprintf(obj, "-- this is obj %d --", i);
1068                 ao2_link(c1, obj);
1069                 /* At this point, the refcount on obj is 2 due to the allocation
1070                  * and linking. We can go ahead and reduce the refcount by 1
1071                  * right here so that when the container is unreffed later, the
1072                  * objects will be freed
1073                  */
1074                 ao2_t_ref(obj, -1, "test");
1075         }
1076         ast_cli(a->fd, "testing callbacks\n");
1077         ao2_t_callback(c1, 0, print_cb, a, "test callback");
1078         ast_cli(a->fd, "testing iterators, remove every second object\n");
1079         {
1080                 struct ao2_iterator ai;
1081                 int x = 0;
1082
1083                 ai = ao2_iterator_init(c1, 0);
1084                 while ( (obj = ao2_t_iterator_next(&ai,"test")) ) {
1085                         ast_cli(a->fd, "iterator on <%s>\n", obj);
1086                         if (x++ & 1)
1087                                 ao2_t_unlink(c1, obj,"test");
1088                         ao2_t_ref(obj, -1,"test");
1089                 }
1090                 ao2_iterator_destroy(&ai);
1091                 ast_cli(a->fd, "testing iterators again\n");
1092                 ai = ao2_iterator_init(c1, 0);
1093                 while ( (obj = ao2_t_iterator_next(&ai,"test")) ) {
1094                         ast_cli(a->fd, "iterator on <%s>\n", obj);
1095                         ao2_t_ref(obj, -1,"test");
1096                 }
1097                 ao2_iterator_destroy(&ai);
1098         }
1099         ast_cli(a->fd, "testing callbacks again\n");
1100         ao2_t_callback(c1, 0, print_cb, a, "test callback");
1101
1102         ast_verbose("now you should see an error message:\n");
1103         ao2_t_ref(&i, -1, "");  /* i is not a valid object so we print an error here */
1104
1105         ast_cli(a->fd, "destroy container\n");
1106         ao2_t_ref(c1, -1, "");  /* destroy container */
1107         handle_astobj2_stats(e, CLI_HANDLER, &fake_args);
1108         return CLI_SUCCESS;
1109 }
1110
1111 static struct ast_cli_entry cli_astobj2[] = {
1112         AST_CLI_DEFINE(handle_astobj2_stats, "Print astobj2 statistics"),
1113         AST_CLI_DEFINE(handle_astobj2_test, "Test astobj2"),
1114 };
1115 #endif /* AO2_DEBUG */
1116
1117 int astobj2_init(void)
1118 {
1119 #ifdef AO2_DEBUG
1120         ast_cli_register_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
1121 #endif
1122
1123         return 0;
1124 }