00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020 #include "asterisk.h"
00021
00022 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 222152 $")
00023
00024 #include "asterisk/astobj2.h"
00025 #include "asterisk/utils.h"
00026 #include "asterisk/cli.h"
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038 struct __priv_data {
00039 ast_mutex_t lock;
00040 int ref_counter;
00041 ao2_destructor_fn destructor_fn;
00042
00043 size_t data_size;
00044
00045
00046 uint32_t magic;
00047 };
00048
00049 #define AO2_MAGIC 0xa570b123
00050
00051
00052
00053
00054
00055 struct astobj2 {
00056 struct __priv_data priv_data;
00057 void *user_data[0];
00058 };
00059
00060 #ifdef AST_DEVMODE
00061 #define AO2_DEBUG 1
00062 #endif
00063
00064 #ifdef AO2_DEBUG
00065 struct ao2_stats {
00066 volatile int total_objects;
00067 volatile int total_mem;
00068 volatile int total_containers;
00069 volatile int total_refs;
00070 volatile int total_locked;
00071 };
00072
00073 static struct ao2_stats ao2;
00074 #endif
00075
00076 #ifndef HAVE_BKTR
00077 void ao2_bt(void) {}
00078 #else
00079 #include <execinfo.h>
00080
00081 void ao2_bt(void)
00082 {
00083 int c, i;
00084 #define N1 20
00085 void *addresses[N1];
00086 char **strings;
00087
00088 c = backtrace(addresses, N1);
00089 strings = backtrace_symbols(addresses,c);
00090 ast_verbose("backtrace returned: %d\n", c);
00091 for(i = 0; i < c; i++) {
00092 ast_verbose("%d: %p %s\n", i, addresses[i], strings[i]);
00093 }
00094 free(strings);
00095 }
00096 #endif
00097
00098
00099
00100
00101
00102
00103 static inline struct astobj2 *INTERNAL_OBJ(void *user_data)
00104 {
00105 struct astobj2 *p;
00106
00107 if (!user_data) {
00108 ast_log(LOG_ERROR, "user_data is NULL\n");
00109 return NULL;
00110 }
00111
00112 p = (struct astobj2 *) ((char *) user_data - sizeof(*p));
00113 if (AO2_MAGIC != (p->priv_data.magic) ) {
00114 ast_log(LOG_ERROR, "bad magic number 0x%x for %p\n", p->priv_data.magic, p);
00115 p = NULL;
00116 }
00117
00118 return p;
00119 }
00120
00121
00122
00123
00124
00125
00126 #define EXTERNAL_OBJ(_p) ((_p) == NULL ? NULL : (_p)->user_data)
00127
00128 #ifndef DEBUG_THREADS
00129 int ao2_lock(void *user_data)
00130 #else
00131 int __ao2_lock(void *user_data, const char *file, const char *func, int line, const char *var)
00132 #endif
00133 {
00134 struct astobj2 *p = INTERNAL_OBJ(user_data);
00135
00136 if (p == NULL)
00137 return -1;
00138
00139 #ifdef AO2_DEBUG
00140 ast_atomic_fetchadd_int(&ao2.total_locked, 1);
00141 #endif
00142
00143 #ifndef DEBUG_THREADS
00144 return ast_mutex_lock(&p->priv_data.lock);
00145 #else
00146 return __ast_pthread_mutex_lock(file, line, func, var, &p->priv_data.lock);
00147 #endif
00148 }
00149
00150 #ifndef DEBUG_THREADS
00151 int ao2_trylock(void *user_data)
00152 #else
00153 int __ao2_trylock(void *user_data, const char *file, const char *func, int line, const char *var)
00154 #endif
00155 {
00156 struct astobj2 *p = INTERNAL_OBJ(user_data);
00157 int res;
00158
00159 if (p == NULL)
00160 return -1;
00161
00162 #ifndef DEBUG_THREADS
00163 res = ast_mutex_trylock(&p->priv_data.lock);
00164 #else
00165 res = __ast_pthread_mutex_trylock(file, line, func, var, &p->priv_data.lock);
00166 #endif
00167
00168 #ifdef AO2_DEBUG
00169 if (!res) {
00170 ast_atomic_fetchadd_int(&ao2.total_locked, 1);
00171 }
00172 #endif
00173
00174 return res;
00175 }
00176
00177 #ifndef DEBUG_THREADS
00178 int ao2_unlock(void *user_data)
00179 #else
00180 int __ao2_unlock(void *user_data, const char *file, const char *func, int line, const char *var)
00181 #endif
00182 {
00183 struct astobj2 *p = INTERNAL_OBJ(user_data);
00184
00185 if (p == NULL)
00186 return -1;
00187
00188 #ifdef AO2_DEBUG
00189 ast_atomic_fetchadd_int(&ao2.total_locked, -1);
00190 #endif
00191
00192 #ifndef DEBUG_THREADS
00193 return ast_mutex_unlock(&p->priv_data.lock);
00194 #else
00195 return __ast_pthread_mutex_unlock(file, line, func, var, &p->priv_data.lock);
00196 #endif
00197 }
00198
00199
00200
00201
00202 int ao2_ref(void *user_data, const int delta)
00203 {
00204 int current_value;
00205 int ret;
00206 struct astobj2 *obj = INTERNAL_OBJ(user_data);
00207
00208 if (obj == NULL)
00209 return -1;
00210
00211
00212 if (delta == 0)
00213 return (obj->priv_data.ref_counter);
00214
00215
00216 ret = ast_atomic_fetchadd_int(&obj->priv_data.ref_counter, delta);
00217 current_value = ret + delta;
00218
00219 #ifdef AO2_DEBUG
00220 ast_atomic_fetchadd_int(&ao2.total_refs, delta);
00221 #endif
00222
00223
00224 if (current_value < 0)
00225 ast_log(LOG_ERROR, "refcount %d on object %p\n", current_value, user_data);
00226
00227 if (current_value <= 0) {
00228 if (obj->priv_data.destructor_fn != NULL)
00229 obj->priv_data.destructor_fn(user_data);
00230
00231 ast_mutex_destroy(&obj->priv_data.lock);
00232 #ifdef AO2_DEBUG
00233 ast_atomic_fetchadd_int(&ao2.total_mem, - obj->priv_data.data_size);
00234 ast_atomic_fetchadd_int(&ao2.total_objects, -1);
00235 #endif
00236
00237
00238
00239 bzero(obj, sizeof(struct astobj2 *) + sizeof(void *) );
00240 free(obj);
00241 }
00242
00243 return ret;
00244 }
00245
00246
00247
00248
00249
00250 void *ao2_alloc(size_t data_size, ao2_destructor_fn destructor_fn)
00251 {
00252
00253 struct astobj2 *obj;
00254
00255 if (data_size < sizeof(void *))
00256 data_size = sizeof(void *);
00257
00258 obj = ast_calloc(1, sizeof(*obj) + data_size);
00259
00260 if (obj == NULL)
00261 return NULL;
00262
00263 ast_mutex_init(&obj->priv_data.lock);
00264 obj->priv_data.magic = AO2_MAGIC;
00265 obj->priv_data.data_size = data_size;
00266 obj->priv_data.ref_counter = 1;
00267 obj->priv_data.destructor_fn = destructor_fn;
00268
00269 #ifdef AO2_DEBUG
00270 ast_atomic_fetchadd_int(&ao2.total_objects, 1);
00271 ast_atomic_fetchadd_int(&ao2.total_mem, data_size);
00272 ast_atomic_fetchadd_int(&ao2.total_refs, 1);
00273 #endif
00274
00275
00276 return EXTERNAL_OBJ(obj);
00277 }
00278
00279
00280 static void container_destruct(void *c);
00281
00282
00283 AST_LIST_HEAD_NOLOCK(bucket, bucket_list);
00284
00285
00286
00287
00288
00289
00290
00291
00292
00293
00294
00295
00296
00297
00298
00299
00300
00301
00302
00303
00304
00305
00306
00307 struct ao2_container {
00308 ao2_hash_fn hash_fn;
00309 ao2_callback_fn cmp_fn;
00310 int n_buckets;
00311
00312 int elements;
00313
00314 int version;
00315
00316 struct bucket buckets[0];
00317 };
00318
00319
00320
00321
00322
00323
00324
00325
00326
00327
00328 static int hash_zero(const void *user_obj, const int flags)
00329 {
00330 return 0;
00331 }
00332
00333
00334
00335
00336 struct ao2_container *
00337 ao2_container_alloc(const unsigned int n_buckets, ao2_hash_fn hash_fn,
00338 ao2_callback_fn cmp_fn)
00339 {
00340
00341
00342 size_t container_size = sizeof(struct ao2_container) + n_buckets * sizeof(struct bucket);
00343
00344 struct ao2_container *c = ao2_alloc(container_size, container_destruct);
00345
00346 if (!c)
00347 return NULL;
00348
00349 c->version = 1;
00350 c->n_buckets = n_buckets;
00351 c->hash_fn = hash_fn ? hash_fn : hash_zero;
00352 c->cmp_fn = cmp_fn;
00353
00354 #ifdef AO2_DEBUG
00355 ast_atomic_fetchadd_int(&ao2.total_containers, 1);
00356 #endif
00357
00358 return c;
00359 }
00360
00361
00362
00363
00364 int ao2_container_count(struct ao2_container *c)
00365 {
00366 return c->elements;
00367 }
00368
00369
00370
00371
00372
00373
00374 struct bucket_list {
00375 AST_LIST_ENTRY(bucket_list) entry;
00376 int version;
00377 struct astobj2 *astobj;
00378 };
00379
00380
00381
00382
00383 void *__ao2_link(struct ao2_container *c, void *user_data, int iax2_hack)
00384 {
00385 int i;
00386
00387 struct bucket_list *p;
00388 struct astobj2 *obj = INTERNAL_OBJ(user_data);
00389
00390 if (!obj)
00391 return NULL;
00392
00393 if (INTERNAL_OBJ(c) == NULL)
00394 return NULL;
00395
00396 p = ast_calloc(1, sizeof(*p));
00397 if (!p)
00398 return NULL;
00399
00400 i = abs(c->hash_fn(user_data, OBJ_POINTER));
00401
00402 ao2_lock(c);
00403 i %= c->n_buckets;
00404 p->astobj = obj;
00405 p->version = ast_atomic_fetchadd_int(&c->version, 1);
00406 if (iax2_hack)
00407 AST_LIST_INSERT_HEAD(&c->buckets[i], p, entry);
00408 else
00409 AST_LIST_INSERT_TAIL(&c->buckets[i], p, entry);
00410 ast_atomic_fetchadd_int(&c->elements, 1);
00411 ao2_ref(user_data, +1);
00412 ao2_unlock(c);
00413
00414 return p;
00415 }
00416
00417
00418
00419
00420 int ao2_match_by_addr(void *user_data, void *arg, int flags)
00421 {
00422 return (user_data == arg) ? (CMP_MATCH | CMP_STOP) : 0;
00423 }
00424
00425
00426
00427
00428
00429 void *ao2_unlink(struct ao2_container *c, void *user_data)
00430 {
00431 if (INTERNAL_OBJ(user_data) == NULL)
00432 return NULL;
00433
00434 ao2_callback(c, OBJ_UNLINK | OBJ_POINTER | OBJ_NODATA, ao2_match_by_addr, user_data);
00435
00436 return NULL;
00437 }
00438
00439
00440
00441
00442 static int cb_true(void *user_data, void *arg, int flags)
00443 {
00444 return CMP_MATCH;
00445 }
00446
00447
00448
00449
00450
00451
00452 void *ao2_callback(struct ao2_container *c,
00453 const enum search_flags flags,
00454 ao2_callback_fn cb_fn, void *arg)
00455 {
00456 int i, start, last;
00457 void *ret = NULL;
00458
00459 if (INTERNAL_OBJ(c) == NULL)
00460 return NULL;
00461
00462 if ((flags & (OBJ_MULTIPLE | OBJ_NODATA)) == OBJ_MULTIPLE) {
00463 ast_log(LOG_WARNING, "multiple data return not implemented yet (flags %x)\n", flags);
00464 return NULL;
00465 }
00466
00467
00468 #if 0
00469
00470
00471
00472
00473 if (flags & OBJ_POINTER)
00474 cb_fn = match_by_addr;
00475 else
00476 #endif
00477 if (cb_fn == NULL)
00478 cb_fn = cb_true;
00479
00480
00481
00482
00483
00484
00485 if ((flags & OBJ_POINTER))
00486 start = i = c->hash_fn(arg, flags & OBJ_POINTER) % c->n_buckets;
00487 else
00488 start = i = -1;
00489
00490
00491 if (i < 0) {
00492 start = i = 0;
00493 last = c->n_buckets;
00494 } else if ((flags & OBJ_CONTINUE)) {
00495 last = c->n_buckets;
00496 } else {
00497 last = i + 1;
00498 }
00499
00500 ao2_lock(c);
00501
00502 for (; i < last ; i++) {
00503
00504 struct bucket_list *cur;
00505
00506 AST_LIST_TRAVERSE_SAFE_BEGIN(&c->buckets[i], cur, entry) {
00507 int match = cb_fn(EXTERNAL_OBJ(cur->astobj), arg, flags) & (CMP_MATCH | CMP_STOP);
00508
00509
00510 if (match == 0) {
00511 continue;
00512 } else if (match == CMP_STOP) {
00513 i = last;
00514 break;
00515 }
00516
00517 if (!(flags & OBJ_NODATA)) {
00518
00519 ret = EXTERNAL_OBJ(cur->astobj);
00520 ao2_ref(ret, 1);
00521 }
00522
00523 if (flags & OBJ_UNLINK) {
00524 struct bucket_list *x = cur;
00525
00526
00527 ast_atomic_fetchadd_int(&c->version, 1);
00528 AST_LIST_REMOVE_CURRENT(&c->buckets[i], entry);
00529
00530 ast_atomic_fetchadd_int(&c->elements, -1);
00531 ao2_ref(EXTERNAL_OBJ(x->astobj), -1);
00532 free(x);
00533 }
00534
00535 if ((match & CMP_STOP) || (flags & OBJ_MULTIPLE) == 0) {
00536
00537 i = last;
00538 break;
00539 }
00540 if (!(flags & OBJ_NODATA)) {
00541 #if 0
00542
00543
00544
00545
00546 #endif
00547 }
00548 }
00549 AST_LIST_TRAVERSE_SAFE_END
00550
00551 if (ret) {
00552
00553 break;
00554 }
00555
00556 if (i == c->n_buckets - 1 && (flags & OBJ_POINTER) && (flags & OBJ_CONTINUE)) {
00557
00558 i = -1;
00559 last = start;
00560 }
00561 }
00562 ao2_unlock(c);
00563 return ret;
00564 }
00565
00566
00567
00568
00569 void *ao2_find(struct ao2_container *c, void *arg, enum search_flags flags)
00570 {
00571 return ao2_callback(c, flags, c->cmp_fn, arg);
00572 }
00573
00574
00575
00576
00577 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags)
00578 {
00579 struct ao2_iterator a = {
00580 .c = c,
00581 .flags = flags
00582 };
00583
00584 ao2_ref(c, +1);
00585
00586 return a;
00587 }
00588
00589
00590
00591
00592 void ao2_iterator_destroy(struct ao2_iterator *i)
00593 {
00594 ao2_ref(i->c, -1);
00595 i->c = NULL;
00596 }
00597
00598
00599
00600
00601 void * ao2_iterator_next(struct ao2_iterator *a)
00602 {
00603 int lim;
00604 struct bucket_list *p = NULL;
00605 void *ret = NULL;
00606
00607 if (INTERNAL_OBJ(a->c) == NULL)
00608 return NULL;
00609
00610 if (!(a->flags & AO2_ITERATOR_DONTLOCK))
00611 ao2_lock(a->c);
00612
00613
00614
00615
00616 if (a->c->version == a->c_version && (p = a->obj) ) {
00617 if ( (p = AST_LIST_NEXT(p, entry)) )
00618 goto found;
00619
00620 a->bucket++;
00621 a->version = 0;
00622 a->obj = NULL;
00623 }
00624
00625 lim = a->c->n_buckets;
00626
00627
00628
00629
00630
00631
00632
00633 for (; a->bucket < lim; a->bucket++, a->version = 0) {
00634
00635 AST_LIST_TRAVERSE(&a->c->buckets[a->bucket], p, entry) {
00636 if (p->version > a->version)
00637 goto found;
00638 }
00639 }
00640
00641 found:
00642 if (p) {
00643 a->version = p->version;
00644 a->obj = p;
00645 a->c_version = a->c->version;
00646 ret = EXTERNAL_OBJ(p->astobj);
00647
00648 ao2_ref(ret, 1);
00649 }
00650
00651 if (!(a->flags & AO2_ITERATOR_DONTLOCK))
00652 ao2_unlock(a->c);
00653
00654 return ret;
00655 }
00656
00657
00658
00659
00660 static int cd_cb(void *obj, void *arg, int flag)
00661 {
00662 ao2_ref(obj, -1);
00663 return 0;
00664 }
00665
00666 static void container_destruct(void *_c)
00667 {
00668 struct ao2_container *c = _c;
00669 int i;
00670
00671 ao2_callback(c, OBJ_UNLINK, cd_cb, NULL);
00672
00673 for (i = 0; i < c->n_buckets; i++) {
00674 struct bucket_list *cur;
00675
00676 while ((cur = AST_LIST_REMOVE_HEAD(&c->buckets[i], entry))) {
00677 ast_free(cur);
00678 }
00679 }
00680
00681 #ifdef AO2_DEBUG
00682 ast_atomic_fetchadd_int(&ao2.total_containers, -1);
00683 #endif
00684 }
00685
00686 #ifdef AO2_DEBUG
00687 static int print_cb(void *obj, void *arg, int flag)
00688 {
00689 int *fd = arg;
00690 char *s = (char *)obj;
00691
00692 ast_cli(*fd, "string <%s>\n", s);
00693 return 0;
00694 }
00695
00696
00697
00698
00699 static int handle_astobj2_stats(int fd, int argc, char *argv[])
00700 {
00701 ast_cli(fd, "Objects : %d\n", ao2.total_objects);
00702 ast_cli(fd, "Containers : %d\n", ao2.total_containers);
00703 ast_cli(fd, "Memory : %d\n", ao2.total_mem);
00704 ast_cli(fd, "Locked : %d\n", ao2.total_locked);
00705 ast_cli(fd, "Refs : %d\n", ao2.total_refs);
00706 return 0;
00707 }
00708
00709
00710
00711
00712 static int handle_astobj2_test(int fd, int argc, char *argv[])
00713 {
00714 struct ao2_container *c1;
00715 int i, lim;
00716 char *obj;
00717 static int prof_id = -1;
00718
00719 if (prof_id == -1)
00720 prof_id = ast_add_profile("ao2_alloc", 0);
00721
00722 ast_cli(fd, "argc %d argv %s %s %s\n", argc, argv[0], argv[1], argv[2]);
00723 lim = atoi(argv[2]);
00724 ast_cli(fd, "called astobj_test\n");
00725
00726 handle_astobj2_stats(fd, 0, NULL);
00727
00728
00729
00730
00731 c1 = ao2_container_alloc(100, NULL , NULL );
00732 ast_cli(fd, "container allocated as %p\n", c1);
00733
00734
00735
00736
00737
00738
00739 for (i = 0; i < lim; i++) {
00740 ast_mark(prof_id, 1 );
00741 obj = ao2_alloc(80, NULL);
00742 ast_mark(prof_id, 0 );
00743 ast_cli(fd, "object %d allocated as %p\n", i, obj);
00744 sprintf(obj, "-- this is obj %d --", i);
00745 ao2_link(c1, obj);
00746 }
00747 ast_cli(fd, "testing callbacks\n");
00748 ao2_callback(c1, 0, print_cb, &fd);
00749
00750 ast_cli(fd, "testing iterators, remove every second object\n");
00751 {
00752 struct ao2_iterator ai;
00753 int x = 0;
00754
00755 ai = ao2_iterator_init(c1, 0);
00756 while ( (obj = ao2_iterator_next(&ai)) ) {
00757 ast_cli(fd, "iterator on <%s>\n", obj);
00758 if (x++ & 1)
00759 ao2_unlink(c1, obj);
00760 ao2_ref(obj, -1);
00761 }
00762 ast_cli(fd, "testing iterators again\n");
00763 ai = ao2_iterator_init(c1, 0);
00764 while ( (obj = ao2_iterator_next(&ai)) ) {
00765 ast_cli(fd, "iterator on <%s>\n", obj);
00766 ao2_ref(obj, -1);
00767 }
00768 }
00769 ast_cli(fd, "testing callbacks again\n");
00770 ao2_callback(c1, 0, print_cb, &fd);
00771
00772 ast_verbose("now you should see an error message:\n");
00773 ao2_ref(&i, -1);
00774
00775 ast_cli(fd, "destroy container\n");
00776 ao2_ref(c1, -1);
00777 handle_astobj2_stats(fd, 0, NULL);
00778 return 0;
00779 }
00780
00781 static struct ast_cli_entry cli_astobj2[] = {
00782 { { "astobj2", "stats", NULL },
00783 handle_astobj2_stats, "Print astobj2 statistics", },
00784 { { "astobj2", "test", NULL } , handle_astobj2_test, "Test astobj2", },
00785 };
00786 #endif
00787
00788 int astobj2_init(void)
00789 {
00790 #ifdef AO2_DEBUG
00791 ast_cli_register_multiple(cli_astobj2, ARRAY_LEN(cli_astobj2));
00792 #endif
00793
00794 return 0;
00795 }