Terry found this problem with running the expr2 parser on OSX. Make the #defines...
[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
29 /*!
30  * astobj2 objects are always preceded by this data structure,
31  * which contains a lock, a reference counter,
32  * the flags and a pointer to a destructor.
33  * The refcount is used to decide when it is time to
34  * invoke the destructor.
35  * The magic number is used for consistency check.
36  * XXX the lock is not always needed, and its initialization may be
37  * expensive. Consider making it external.
38  */
39 struct __priv_data {
40         ast_mutex_t lock;
41         int ref_counter;
42         ao2_destructor_fn destructor_fn;
43         /*! for stats */
44         size_t data_size;
45         /*! magic number.  This is used to verify that a pointer passed in is a
46          *  valid astobj2 */
47         uint32_t magic;
48 };
49
50 #define AO2_MAGIC       0xa570b123
51
52 /*!
53  * What an astobj2 object looks like: fixed-size private data
54  * followed by variable-size user data.
55  */
56 struct astobj2 {
57         struct __priv_data priv_data;
58         void *user_data[0];
59 };
60
61 #ifdef AST_DEVMODE
62 #define AO2_DEBUG 1
63 #endif
64
65 #ifdef AO2_DEBUG
66 struct ao2_stats {
67         volatile int total_objects;
68         volatile int total_mem;
69         volatile int total_containers;
70         volatile int total_refs;
71         volatile int total_locked;
72 };
73
74 static struct ao2_stats ao2;
75 #endif
76
77 #ifndef HAVE_BKTR       /* backtrace support */
78 void ao2_bt(void) {}
79 #else
80 #include <execinfo.h>    /* for backtrace */
81
82 void ao2_bt(void)
83 {
84     int c, i;
85 #define N1      20
86     void *addresses[N1];
87     char **strings;
88
89     c = backtrace(addresses, N1);
90     strings = backtrace_symbols(addresses,c);
91     ast_verbose("backtrace returned: %d\n", c);
92     for(i = 0; i < c; i++) {
93         ast_verbose("%d: %p %s\n", i, addresses[i], strings[i]);
94     }
95     free(strings);
96 }
97 #endif
98
99 /*!
100  * \brief convert from a pointer _p to a user-defined object
101  *
102  * \return the pointer to the astobj2 structure
103  */
104 static inline struct astobj2 *INTERNAL_OBJ(void *user_data)
105 {
106         struct astobj2 *p;
107
108         if (!user_data) {
109                 ast_log(LOG_ERROR, "user_data is NULL\n");
110                 return NULL;
111         }
112
113         p = (struct astobj2 *) ((char *) user_data - sizeof(*p));
114         if (AO2_MAGIC != (p->priv_data.magic) ) {
115                 ast_log(LOG_ERROR, "bad magic number 0x%x for %p\n", p->priv_data.magic, p);
116                 p = NULL;
117         }
118
119         return p;
120 }
121
122 /*!
123  * \brief convert from a pointer _p to an astobj2 object
124  *
125  * \return the pointer to the user-defined portion.
126  */
127 #define EXTERNAL_OBJ(_p)        ((_p) == NULL ? NULL : (_p)->user_data)
128
129 int ao2_lock(void *user_data)
130 {
131         struct astobj2 *p = INTERNAL_OBJ(user_data);
132
133         if (p == NULL)
134                 return -1;
135
136 #ifdef AO2_DEBUG
137         ast_atomic_fetchadd_int(&ao2.total_locked, 1);
138 #endif
139
140         return ast_mutex_lock(&p->priv_data.lock);
141 }
142
143 int ao2_unlock(void *user_data)
144 {
145         struct astobj2 *p = INTERNAL_OBJ(user_data);
146
147         if (p == NULL)
148                 return -1;
149
150 #ifdef AO2_DEBUG
151         ast_atomic_fetchadd_int(&ao2.total_locked, -1);
152 #endif
153
154         return ast_mutex_unlock(&p->priv_data.lock);
155 }
156
157 /*
158  * The argument is a pointer to the user portion.
159  */
160 int ao2_ref(void *user_data, const int delta)
161 {
162         int current_value;
163         int ret;
164         struct astobj2 *obj = INTERNAL_OBJ(user_data);
165
166         if (obj == NULL)
167                 return -1;
168
169         /* if delta is 0, just return the refcount */
170         if (delta == 0)
171                 return (obj->priv_data.ref_counter);
172
173         /* we modify with an atomic operation the reference counter */
174         ret = ast_atomic_fetchadd_int(&obj->priv_data.ref_counter, delta);
175         current_value = ret + delta;
176
177 #ifdef AO2_DEBUG        
178         ast_atomic_fetchadd_int(&ao2.total_refs, delta);
179 #endif
180
181         /* this case must never happen */
182         if (current_value < 0)
183                 ast_log(LOG_ERROR, "refcount %d on object %p\n", current_value, user_data);
184
185         if (current_value <= 0) { /* last reference, destroy the object */
186                 if (obj->priv_data.destructor_fn != NULL) 
187                         obj->priv_data.destructor_fn(user_data);
188
189                 ast_mutex_destroy(&obj->priv_data.lock);
190 #ifdef AO2_DEBUG
191                 ast_atomic_fetchadd_int(&ao2.total_mem, - obj->priv_data.data_size);
192                 ast_atomic_fetchadd_int(&ao2.total_objects, -1);
193 #endif
194                 /* for safety, zero-out the astobj2 header and also the
195                  * first word of the user-data, which we make sure is always
196                  * allocated. */
197                 bzero(obj, sizeof(struct astobj2 *) + sizeof(void *) );
198                 free(obj);
199         }
200
201         return ret;
202 }
203
204 /*
205  * We always alloc at least the size of a void *,
206  * for debugging purposes.
207  */
208 void *ao2_alloc(size_t data_size, ao2_destructor_fn destructor_fn)
209 {
210         /* allocation */
211         struct astobj2 *obj;
212
213         if (data_size < sizeof(void *))
214                 data_size = sizeof(void *);
215
216         obj = ast_calloc(1, sizeof(*obj) + data_size);
217
218         if (obj == NULL)
219                 return NULL;
220
221         ast_mutex_init(&obj->priv_data.lock);
222         obj->priv_data.magic = AO2_MAGIC;
223         obj->priv_data.data_size = data_size;
224         obj->priv_data.ref_counter = 1;
225         obj->priv_data.destructor_fn = destructor_fn;   /* can be NULL */
226
227 #ifdef AO2_DEBUG
228         ast_atomic_fetchadd_int(&ao2.total_objects, 1);
229         ast_atomic_fetchadd_int(&ao2.total_mem, data_size);
230         ast_atomic_fetchadd_int(&ao2.total_refs, 1);
231 #endif
232
233         /* return a pointer to the user data */
234         return EXTERNAL_OBJ(obj);
235 }
236
237 /* internal callback to destroy a container. */
238 static void container_destruct(void *c);
239
240 /* each bucket in the container is a tailq. */
241 AST_LIST_HEAD_NOLOCK(bucket, bucket_list);
242
243 /*!
244  * A container; stores the hash and callback functions, information on
245  * the size, the hash bucket heads, and a version number, starting at 0
246  * (for a newly created, empty container)
247  * and incremented every time an object is inserted or deleted.
248  * The assumption is that an object is never moved in a container,
249  * but removed and readded with the new number.
250  * The version number is especially useful when implementing iterators.
251  * In fact, we can associate a unique, monotonically increasing number to
252  * each object, which means that, within an iterator, we can store the
253  * version number of the current object, and easily look for the next one,
254  * which is the next one in the list with a higher number.
255  * Since all objects have a version >0, we can use 0 as a marker for
256  * 'we need the first object in the bucket'.
257  *
258  * \todo Linking and unlink objects is typically expensive, as it
259  * involves a malloc() of a small object which is very inefficient.
260  * To optimize this, we allocate larger arrays of bucket_list's
261  * when we run out of them, and then manage our own freelist.
262  * This will be more efficient as we can do the freelist management while
263  * we hold the lock (that we need anyways).
264  */
265 struct ao2_container {
266         ao2_hash_fn *hash_fn;
267         ao2_callback_fn *cmp_fn;
268         int n_buckets;
269         /*! Number of elements in the container */
270         int elements;
271         /*! described above */
272         int version;
273         /*! variable size */
274         struct bucket buckets[0];
275 };
276  
277 /*!
278  * \brief always zero hash function
279  *
280  * it is convenient to have a hash function that always returns 0.
281  * This is basically used when we want to have a container that is
282  * a simple linked list.
283  *
284  * \returns 0
285  */
286 static int hash_zero(const void *user_obj, const int flags)
287 {
288         return 0;
289 }
290
291 /*
292  * A container is just an object, after all!
293  */
294 struct ao2_container *
295 ao2_container_alloc(const uint n_buckets, ao2_hash_fn *hash_fn,
296                 ao2_callback_fn *cmp_fn)
297 {
298         /* XXX maybe consistency check on arguments ? */
299         /* compute the container size */
300         size_t container_size = sizeof(struct ao2_container) + n_buckets * sizeof(struct bucket);
301
302         struct ao2_container *c = ao2_alloc(container_size, container_destruct);
303
304         if (!c)
305                 return NULL;
306         
307         c->version = 1; /* 0 is a reserved value here */
308         c->n_buckets = n_buckets;
309         c->hash_fn = hash_fn ? hash_fn : hash_zero;
310         c->cmp_fn = cmp_fn;
311
312 #ifdef AO2_DEBUG
313         ast_atomic_fetchadd_int(&ao2.total_containers, 1);
314 #endif
315
316         return c;
317 }
318
319 /*!
320  * return the number of elements in the container
321  */
322 int ao2_container_count(struct ao2_container *c)
323 {
324         return c->elements;
325 }
326
327 /*!
328  * A structure to create a linked list of entries,
329  * used within a bucket.
330  * XXX \todo this should be private to the container code
331  */
332 struct bucket_list {
333         AST_LIST_ENTRY(bucket_list) entry;
334         int version;
335         struct astobj2 *astobj;         /* pointer to internal data */
336 }; 
337
338 /*
339  * link an object to a container
340  */
341 void *ao2_link(struct ao2_container *c, void *user_data)
342 {
343         int i;
344         /* create a new list entry */
345         struct bucket_list *p;
346         struct astobj2 *obj = INTERNAL_OBJ(user_data);
347         
348         if (!obj)
349                 return NULL;
350
351         if (INTERNAL_OBJ(c) == NULL)
352                 return NULL;
353
354         p = ast_calloc(1, sizeof(*p));
355         if (!p)
356                 return NULL;
357
358         i = c->hash_fn(user_data, OBJ_POINTER);
359
360         ao2_lock(c);
361         i %= c->n_buckets;
362         p->astobj = obj;
363         p->version = ast_atomic_fetchadd_int(&c->version, 1);
364         AST_LIST_INSERT_TAIL(&c->buckets[i], p, entry);
365         ast_atomic_fetchadd_int(&c->elements, 1);
366         ao2_ref(user_data, +1);
367         ao2_unlock(c);
368         
369         return p;
370 }
371
372 /*!
373  * \brief another convenience function is a callback that matches on address
374  */
375 int ao2_match_by_addr(void *user_data, void *arg, int flags)
376 {
377         return (user_data == arg) ? (CMP_MATCH | CMP_STOP) : 0;
378 }
379
380 /*
381  * Unlink an object from the container
382  * and destroy the associated * ao2_bucket_list structure.
383  */
384 void *ao2_unlink(struct ao2_container *c, void *user_data)
385 {
386         if (INTERNAL_OBJ(user_data) == NULL)    /* safety check on the argument */
387                 return NULL;
388
389         ao2_callback(c, OBJ_UNLINK | OBJ_POINTER | OBJ_NODATA, ao2_match_by_addr, user_data);
390
391         return NULL;
392 }
393
394 /*! 
395  * \brief special callback that matches all 
396  */ 
397 static int cb_true(void *user_data, void *arg, int flags)
398 {
399         return CMP_MATCH;
400 }
401
402 /*!
403  * Browse the container using different stategies accoding the flags.
404  * \return Is a pointer to an object or to a list of object if OBJ_MULTIPLE is 
405  * specified.
406  */
407 void *ao2_callback(struct ao2_container *c,
408         const enum search_flags flags,
409         ao2_callback_fn *cb_fn, void *arg)
410 {
411         int i, last;    /* search boundaries */
412         void *ret = NULL;
413
414         if (INTERNAL_OBJ(c) == NULL)    /* safety check on the argument */
415                 return NULL;
416
417         if ((flags & (OBJ_MULTIPLE | OBJ_NODATA)) == OBJ_MULTIPLE) {
418                 ast_log(LOG_WARNING, "multiple data return not implemented yet (flags %x)\n", flags);
419                 return NULL;
420         }
421
422         /* override the match function if necessary */
423         if (cb_fn == NULL)      /* if NULL, match everything */
424                 cb_fn = cb_true;
425         /*
426          * XXX this can be optimized.
427          * If we have a hash function and lookup by pointer,
428          * run the hash function. Otherwise, scan the whole container
429          * (this only for the time being. We need to optimize this.)
430          */
431         if ((flags & OBJ_POINTER))      /* we know hash can handle this case */
432                 i = c->hash_fn(arg, flags & OBJ_POINTER) % c->n_buckets;
433         else                    /* don't know, let's scan all buckets */
434                 i = -1;         /* XXX this must be fixed later. */
435
436         /* determine the search boundaries: i..last-1 */
437         if (i < 0) {
438                 i = 0;
439                 last = c->n_buckets;
440         } else {
441                 last = i + 1;
442         }
443
444         ao2_lock(c);    /* avoid modifications to the content */
445
446         for (; i < last ; i++) {
447                 /* scan the list with prev-cur pointers */
448                 struct bucket_list *cur;
449
450                 AST_LIST_TRAVERSE_SAFE_BEGIN(&c->buckets[i], cur, entry) {
451                         int match = cb_fn(EXTERNAL_OBJ(cur->astobj), arg, flags) & (CMP_MATCH | CMP_STOP);
452
453                         /* we found the object, performing operations according flags */
454                         if (match == 0) {       /* no match, no stop, continue */
455                                 continue;
456                         } else if (match == CMP_STOP) { /* no match but stop, we are done */
457                                 i = last;
458                                 break;
459                         }
460                         /* we have a match (CMP_MATCH) here */
461                         if (!(flags & OBJ_NODATA)) {    /* if must return the object, record the value */
462                                 /* it is important to handle this case before the unlink */
463                                 ret = EXTERNAL_OBJ(cur->astobj);
464                                 ao2_ref(ret, 1);
465                         }
466
467                         if (flags & OBJ_UNLINK) {       /* must unlink */
468                                 struct bucket_list *x = cur;
469
470                                 /* we are going to modify the container, so update version */
471                                 ast_atomic_fetchadd_int(&c->version, 1);
472                                 AST_LIST_REMOVE_CURRENT(entry);
473                                 /* update number of elements and version */
474                                 ast_atomic_fetchadd_int(&c->elements, -1);
475                                 ao2_ref(EXTERNAL_OBJ(x->astobj), -1);
476                                 free(x);        /* free the link record */
477                         }
478
479                         if ((match & CMP_STOP) || (flags & OBJ_MULTIPLE) == 0) {
480                                 /* We found the only match we need */
481                                 i = last;       /* force exit from outer loop */
482                                 break;
483                         }
484                         if (!(flags & OBJ_NODATA)) {
485 #if 0   /* XXX to be completed */
486                                 /*
487                                  * This is the multiple-return case. We need to link
488                                  * the object in a list. The refcount is already increased.
489                                  */
490 #endif
491                         }
492                 }
493                 AST_LIST_TRAVERSE_SAFE_END;
494         }
495         ao2_unlock(c);
496         return ret;
497 }
498
499 /*!
500  * the find function just invokes the default callback with some reasonable flags.
501  */
502 void *ao2_find(struct ao2_container *c, void *arg, enum search_flags flags)
503 {
504         return ao2_callback(c, flags, c->cmp_fn, arg);
505 }
506
507 /*!
508  * initialize an iterator so we start from the first object
509  */
510 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags)
511 {
512         struct ao2_iterator a = {
513                 .c = c,
514                 .flags = flags
515         };
516         
517         return a;
518 }
519
520 /*
521  * move to the next element in the container.
522  */
523 void * ao2_iterator_next(struct ao2_iterator *a)
524 {
525         int lim;
526         struct bucket_list *p = NULL;
527         void *ret = NULL;
528
529         if (INTERNAL_OBJ(a->c) == NULL)
530                 return NULL;
531
532         if (!(a->flags & F_AO2I_DONTLOCK))
533                 ao2_lock(a->c);
534
535         /* optimization. If the container is unchanged and
536          * we have a pointer, try follow it
537          */
538         if (a->c->version == a->c_version && (p = a->obj) ) {
539                 if ( (p = AST_LIST_NEXT(p, entry)) )
540                         goto found;
541                 /* nope, start from the next bucket */
542                 a->bucket++;
543                 a->version = 0;
544                 a->obj = NULL;
545         }
546
547         lim = a->c->n_buckets;
548
549         /* Browse the buckets array, moving to the next
550          * buckets if we don't find the entry in the current one.
551          * Stop when we find an element with version number greater
552          * than the current one (we reset the version to 0 when we
553          * switch buckets).
554          */
555         for (; a->bucket < lim; a->bucket++, a->version = 0) {
556                 /* scan the current bucket */
557                 AST_LIST_TRAVERSE(&a->c->buckets[a->bucket], p, entry) {
558                         if (p->version > a->version)
559                                 goto found;
560                 }
561         }
562
563 found:
564         if (p) {
565                 a->version = p->version;
566                 a->obj = p;
567                 a->c_version = a->c->version;
568                 ret = EXTERNAL_OBJ(p->astobj);
569                 /* inc refcount of returned object */
570                 ao2_ref(ret, 1);
571         }
572
573         if (!(a->flags & F_AO2I_DONTLOCK))
574                 ao2_unlock(a->c);
575
576         return ret;
577 }
578
579 /* callback for destroying container.
580  * we can make it simple as we know what it does
581  */
582 static int cd_cb(void *obj, void *arg, int flag)
583 {
584         ao2_ref(obj, -1);
585         return 0;
586 }
587         
588 static void container_destruct(void *_c)
589 {
590         struct ao2_container *c = _c;
591
592         ao2_callback(c, OBJ_UNLINK, cd_cb, NULL);
593
594 #ifdef AO2_DEBUG
595         ast_atomic_fetchadd_int(&ao2.total_containers, -1);
596 #endif
597 }
598
599 #ifdef AO2_DEBUG
600 static int print_cb(void *obj, void *arg, int flag)
601 {
602         int *fd = arg;
603         char *s = (char *)obj;
604
605         ast_cli(*fd, "string <%s>\n", s);
606         return 0;
607 }
608
609 /*
610  * Print stats
611  */
612 static char *handle_astobj2_stats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
613 {
614         switch (cmd) {
615         case CLI_INIT:
616                 e->command = "astobj2 stats";
617                 e->usage = "Usage: astobj2 stats\n"
618                            "       Show astobj2 stats\n";
619                 return NULL;
620         case CLI_GENERATE:
621                 return NULL;
622         }
623         ast_cli(a->fd, "Objects    : %d\n", ao2.total_objects);
624         ast_cli(a->fd, "Containers : %d\n", ao2.total_containers);
625         ast_cli(a->fd, "Memory     : %d\n", ao2.total_mem);
626         ast_cli(a->fd, "Locked     : %d\n", ao2.total_locked);
627         ast_cli(a->fd, "Refs       : %d\n", ao2.total_refs);
628         return CLI_SUCCESS;
629 }
630
631 /*
632  * This is testing code for astobj
633  */
634 static char *handle_astobj2_test(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
635 {
636         struct ao2_container *c1;
637         int i, lim;
638         char *obj;
639         static int prof_id = -1;
640         struct ast_cli_args fake_args = { a->fd, 0, NULL };
641
642         switch (cmd) {
643         case CLI_INIT:
644                 e->command = "astobj2 test";
645                 e->usage = "Usage: astobj2 test <num>\n"
646                            "       Runs astobj2 test. Creates 'num' objects,\n"
647                            "       and test iterators, callbacks and may be other stuff\n";
648                 return NULL;
649         case CLI_GENERATE:
650                 return NULL;
651         }
652
653         if (a->argc != 3) {
654                 return CLI_SHOWUSAGE;
655         }
656
657         if (prof_id == -1)
658                 prof_id = ast_add_profile("ao2_alloc", 0);
659
660         ast_cli(a->fd, "argc %d argv %s %s %s\n", a->argc, a->argv[0], a->argv[1], a->argv[2]);
661         lim = atoi(a->argv[2]);
662         ast_cli(a->fd, "called astobj_test\n");
663
664         handle_astobj2_stats(e, CLI_HANDLER, &fake_args);
665         /*
666          * allocate a container with no default callback, and no hash function.
667          * No hash means everything goes in the same bucket.
668          */
669         c1 = ao2_container_alloc(100, NULL /* no callback */, NULL /* no hash */);
670         ast_cli(a->fd, "container allocated as %p\n", c1);
671
672         /*
673          * fill the container with objects.
674          * ao2_alloc() gives us a reference which we pass to the
675          * container when we do the insert.
676          */
677         for (i = 0; i < lim; i++) {
678                 ast_mark(prof_id, 1 /* start */);
679                 obj = ao2_alloc(80, NULL);
680                 ast_mark(prof_id, 0 /* stop */);
681                 ast_cli(a->fd, "object %d allocated as %p\n", i, obj);
682                 sprintf(obj, "-- this is obj %d --", i);
683                 ao2_link(c1, obj);
684         }
685         ast_cli(a->fd, "testing callbacks\n");
686         ao2_callback(c1, 0, print_cb, &a->fd);
687
688         ast_cli(a->fd, "testing iterators, remove every second object\n");
689         {
690                 struct ao2_iterator ai;
691                 int x = 0;
692
693                 ai = ao2_iterator_init(c1, 0);
694                 while ( (obj = ao2_iterator_next(&ai)) ) {
695                         ast_cli(a->fd, "iterator on <%s>\n", obj);
696                         if (x++ & 1)
697                                 ao2_unlink(c1, obj);
698                         ao2_ref(obj, -1);
699                 }
700                 ast_cli(a->fd, "testing iterators again\n");
701                 ai = ao2_iterator_init(c1, 0);
702                 while ( (obj = ao2_iterator_next(&ai)) ) {
703                         ast_cli(a->fd, "iterator on <%s>\n", obj);
704                         ao2_ref(obj, -1);
705                 }
706         }
707         ast_cli(a->fd, "testing callbacks again\n");
708         ao2_callback(c1, 0, print_cb, &a->fd);
709
710         ast_verbose("now you should see an error message:\n");
711         ao2_ref(&i, -1);        /* i is not a valid object so we print an error here */
712
713         ast_cli(a->fd, "destroy container\n");
714         ao2_ref(c1, -1);        /* destroy container */
715         handle_astobj2_stats(e, CLI_HANDLER, &fake_args);
716         return CLI_SUCCESS;
717 }
718
719 static struct ast_cli_entry cli_astobj2[] = {
720         AST_CLI_DEFINE(handle_astobj2_stats, "Print astobj2 statistics"),
721         AST_CLI_DEFINE(handle_astobj2_test, "Test astobj2"),
722 };
723 #endif /* AO2_DEBUG */
724
725 int astobj2_init(void)
726 {
727 #ifdef AO2_DEBUG
728         ast_cli_register_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
729 #endif
730
731         return 0;
732 }