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