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