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