Remove ABI differences that occured when compiling with DEBUG_THREADS.
[asterisk/asterisk.git] / include / asterisk / astobj2.h
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 #ifndef _ASTERISK_ASTOBJ2_H
18 #define _ASTERISK_ASTOBJ2_H
19
20 #include "asterisk/compat.h"
21 #include "asterisk/linkedlists.h"
22
23 /*! \file
24  * \ref AstObj2
25  *
26  * \page AstObj2 Object Model implementing objects and containers.
27
28 This module implements an abstraction for objects (with locks and
29 reference counts), and containers for these user-defined objects,
30 also supporting locking, reference counting and callbacks.
31
32 The internal implementation of objects and containers is opaque to the user,
33 so we can use different data structures as needs arise.
34
35 \section AstObj2_UsageObjects USAGE - OBJECTS
36
37 An ao2 object is a block of memory that the user code can access,
38 and for which the system keeps track (with a bit of help from the
39 programmer) of the number of references around.  When an object has
40 no more references (refcount == 0), it is destroyed, by first
41 invoking whatever 'destructor' function the programmer specifies
42 (it can be NULL if none is necessary), and then freeing the memory.
43 This way objects can be shared without worrying who is in charge
44 of freeing them.
45 As an additional feature, ao2 objects are associated to individual
46 locks.
47
48 Creating an object requires the size of the object and
49 and a pointer to the destructor function:
50
51     struct foo *o;
52
53     o = ao2_alloc(sizeof(struct foo), my_destructor_fn);
54
55 The value returned points to the user-visible portion of the objects
56 (user-data), but is also used as an identifier for all object-related
57 operations such as refcount and lock manipulations.
58
59 On return from ao2_alloc():
60
61  - the object has a refcount = 1;
62  - the memory for the object is allocated dynamically and zeroed;
63  - we cannot realloc() the object itself;
64  - we cannot call free(o) to dispose of the object. Rather, we
65    tell the system that we do not need the reference anymore:
66
67     ao2_ref(o, -1)
68
69   causing the destructor to be called (and then memory freed) when
70   the refcount goes to 0.
71
72 - ao2_ref(o, +1) can be used to modify the refcount on the
73   object in case we want to pass it around.
74
75 - ao2_lock(obj), ao2_unlock(obj), ao2_trylock(obj) can be used
76   to manipulate the lock associated with the object.
77
78
79 \section AstObj2_UsageContainers USAGE - CONTAINERS
80
81 An ao2 container is an abstract data structure where we can store
82 ao2 objects, search them (hopefully in an efficient way), and iterate
83 or apply a callback function to them. A container is just an ao2 object
84 itself.
85
86 A container must first be allocated, specifying the initial
87 parameters. At the moment, this is done as follows:
88
89     <b>Sample Usage:</b>
90     \code
91
92     struct ao2_container *c;
93
94     c = ao2_container_alloc(MAX_BUCKETS, my_hash_fn, my_cmp_fn);
95     \endcode
96
97 where
98
99 - MAX_BUCKETS is the number of buckets in the hash table,
100 - my_hash_fn() is the (user-supplied) function that returns a
101   hash key for the object (further reduced modulo MAX_BUCKETS
102   by the container's code);
103 - my_cmp_fn() is the default comparison function used when doing
104   searches on the container,
105
106 A container knows little or nothing about the objects it stores,
107 other than the fact that they have been created by ao2_alloc().
108 All knowledge of the (user-defined) internals of the objects
109 is left to the (user-supplied) functions passed as arguments
110 to ao2_container_alloc().
111
112 If we want to insert an object in a container, we should
113 initialize its fields -- especially, those used by my_hash_fn() --
114 to compute the bucket to use.
115 Once done, we can link an object to a container with
116
117     ao2_link(c, o);
118
119 The function returns NULL in case of errors (and the object
120 is not inserted in the container). Other values mean success
121 (we are not supposed to use the value as a pointer to anything).
122 Linking an object to a container increases its refcount by 1
123 automatically.
124
125 \note While an object o is in a container, we expect that
126 my_hash_fn(o) will always return the same value. The function
127 does not lock the object to be computed, so modifications of
128 those fields that affect the computation of the hash should
129 be done by extracting the object from the container, and
130 reinserting it after the change (this is not terribly expensive).
131
132 \note A container with a single buckets is effectively a linked
133 list. However there is no ordering among elements.
134
135 - \ref AstObj2_Containers
136 - \ref astobj2.h All documentation for functions and data structures
137
138  */
139
140 /*
141 \note DEBUGGING REF COUNTS BIBLE:
142 An interface to help debug refcounting is provided
143 in this package. It is dependent on the REF_DEBUG macro being
144 defined in a source file, before the #include of astobj2.h,
145 and in using variants of the normal ao2_xxxx functions
146 that are named ao2_t_xxxx instead, with an extra argument, a string,
147 that will be printed out into /tmp/refs when the refcount for an
148 object is changed.
149
150   these ao2_t_xxxx variants are provided:
151
152 ao2_t_alloc(arg1, arg2, arg3)
153 ao2_t_ref(arg1,arg2,arg3)
154 ao2_t_container_alloc(arg1,arg2,arg3,arg4)
155 ao2_t_link(arg1, arg2, arg3)
156 ao2_t_unlink(arg1, arg2, arg3)
157 ao2_t_callback(arg1,arg2,arg3,arg4,arg5)
158 ao2_t_find(arg1,arg2,arg3,arg4)
159 ao2_t_iterator_next(arg1, arg2)
160
161 If you study each argument list, you will see that these functions all have
162 one extra argument that their ao2_xxx counterpart. The last argument in
163 each case is supposed to be a string pointer, a "tag", that should contain
164 enough of an explanation, that you can pair operations that increment the
165 ref count, with operations that are meant to decrement the refcount.
166
167 Each of these calls will generate at least one line of output in /tmp/refs.
168 These lines look like this:
169 ...
170 0x8756f00 =1   chan_sip.c:22240:load_module (allocate users)
171 0x86e3408 =1   chan_sip.c:22241:load_module (allocate peers)
172 0x86dd380 =1   chan_sip.c:22242:load_module (allocate peers_by_ip)
173 0x822d020 =1   chan_sip.c:22243:load_module (allocate dialogs)
174 0x8930fd8 =1   chan_sip.c:20025:build_peer (allocate a peer struct)
175 0x8930fd8 +1   chan_sip.c:21467:reload_config (link peer into peer table) [@1]
176 0x8930fd8 -1   chan_sip.c:2370:unref_peer (unref_peer: from reload_config) [@2]
177 0x89318b0 =1   chan_sip.c:20025:build_peer (allocate a peer struct)
178 0x89318b0 +1   chan_sip.c:21467:reload_config (link peer into peer table) [@1]
179 0x89318b0 -1   chan_sip.c:2370:unref_peer (unref_peer: from reload_config) [@2]
180 0x8930218 =1   chan_sip.c:20025:build_peer (allocate a peer struct)
181 0x8930218 +1   chan_sip.c:21539:reload_config (link peer into peers table) [@1]
182 0x868c040 -1   chan_sip.c:2424:dialog_unlink_all (unset the relatedpeer->call field in tandem with relatedpeer field itself) [@2]
183 0x868c040 -1   chan_sip.c:2443:dialog_unlink_all (Let's unbump the count in the unlink so the poor pvt can disappear if it is time) [@1]
184 0x868c040 **call destructor** chan_sip.c:2443:dialog_unlink_all (Let's unbump the count in the unlink so the poor pvt can disappear if it is time)
185 0x8cc07e8 -1   chan_sip.c:2370:unref_peer (unsetting a dialog relatedpeer field in sip_destroy) [@3]
186 0x8cc07e8 +1   chan_sip.c:3876:find_peer (ao2_find in peers table) [@2]
187 0x8cc07e8 -1   chan_sip.c:2370:unref_peer (unref_peer, from sip_devicestate, release ref from find_peer) [@3]
188 ...
189
190 The first column is the object address.
191 The second column reflects how the operation affected the ref count
192     for that object. Creation sets the ref count to 1 (=1).
193     increment or decrement and amount are specified (-1/+1).
194 The remainder of the line specifies where in the file the call was made,
195     and the function name, and the tag supplied in the function call.
196
197 The **call destructor** is specified when the the destroy routine is
198 run for an object. It does not affect the ref count, but is important
199 in debugging, because it is possible to have the astobj2 system run it
200 multiple times on the same object, commonly fatal to asterisk.
201
202 Sometimes you have some helper functions to do object ref/unref
203 operations. Using these normally hides the place where these
204 functions were called. To get the location where these functions
205 were called to appear in /tmp/refs, you can do this sort of thing:
206
207 #ifdef REF_DEBUG
208 #define dialog_ref(arg1,arg2) dialog_ref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
209 #define dialog_unref(arg1,arg2) dialog_unref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
210 static struct sip_pvt *dialog_ref_debug(struct sip_pvt *p, char *tag, const char *file, int line, const char *func)
211 {
212         if (p)
213                 ao2_ref_debug(p, 1, tag, file, line, func);
214         else
215                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
216         return p;
217 }
218
219 static struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, char *tag, const char *file, int line, const char *func)
220 {
221         if (p)
222                 ao2_ref_debug(p, -1, tag, file, line, func);
223         return NULL;
224 }
225 #else
226 static struct sip_pvt *dialog_ref(struct sip_pvt *p, char *tag)
227 {
228         if (p)
229                 ao2_ref(p, 1);
230         else
231                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
232         return p;
233 }
234
235 static struct sip_pvt *dialog_unref(struct sip_pvt *p, char *tag)
236 {
237         if (p)
238                 ao2_ref(p, -1);
239         return NULL;
240 }
241 #endif
242
243 In the above code, note that the "normal" helper funcs call ao2_ref() as
244 normal, and the "helper" functions call ao2_ref_debug directly with the
245 file, function, and line number info provided. You might find this
246 well worth the effort to help track these function calls in the code.
247
248 To find out why objects are not destroyed (a common bug), you can
249 edit the source file to use the ao2_t_* variants, add the #define REF_DEBUG 1
250 before the #include "asterisk/astobj2.h" line, and add a descriptive
251 tag to each call. Recompile, and run Asterisk, exit asterisk with
252 "stop gracefully", which should result in every object being destroyed.
253 Then, you can "sort -k 1 /tmp/refs > x1" to get a sorted list of
254 all the objects, or you can use "util/refcounter" to scan the file
255 for you and output any problems it finds.
256
257 The above may seem astronomically more work than it is worth to debug
258 reference counts, which may be true in "simple" situations, but for
259 more complex situations, it is easily worth 100 times this effort to
260 help find problems.
261
262 To debug, pair all calls so that each call that increments the
263 refcount is paired with a corresponding call that decrements the
264 count for the same reason. Hopefully, you will be left with one
265 or more unpaired calls. This is where you start your search!
266
267 For instance, here is an example of this for a dialog object in
268 chan_sip, that was not getting destroyed, after I moved the lines around
269 to pair operations:
270
271    0x83787a0 =1   chan_sip.c:5733:sip_alloc (allocate a dialog(pvt) struct)
272    0x83787a0 -1   chan_sip.c:19173:sip_poke_peer (unref dialog at end of sip_poke_peer, obtained from sip_alloc, just before it goes out of scope) [@4]
273
274    0x83787a0 +1   chan_sip.c:5854:sip_alloc (link pvt into dialogs table) [@1]
275    0x83787a0 -1   chan_sip.c:19150:sip_poke_peer (About to change the callid -- remove the old name) [@3]
276    0x83787a0 +1   chan_sip.c:19152:sip_poke_peer (Linking in under new name) [@2]
277    0x83787a0 -1   chan_sip.c:2399:dialog_unlink_all (unlinking dialog via ao2_unlink) [@5]
278
279    0x83787a0 +1   chan_sip.c:19130:sip_poke_peer (copy sip alloc from p to peer->call) [@2]
280
281
282    0x83787a0 +1   chan_sip.c:2996:__sip_reliable_xmit (__sip_reliable_xmit: setting pkt->owner) [@3]
283    0x83787a0 -1   chan_sip.c:2425:dialog_unlink_all (remove all current packets in this dialog, and the pointer to the dialog too as part of __sip_destroy) [@4]
284
285    0x83787a0 +1   chan_sip.c:22356:unload_module (iterate thru dialogs) [@4]
286    0x83787a0 -1   chan_sip.c:22359:unload_module (toss dialog ptr from iterator_next) [@5]
287
288
289    0x83787a0 +1   chan_sip.c:22373:unload_module (iterate thru dialogs) [@3]
290    0x83787a0 -1   chan_sip.c:22375:unload_module (throw away iterator result) [@2]
291
292    0x83787a0 +1   chan_sip.c:2397:dialog_unlink_all (Let's bump the count in the unlink so it doesn't accidentally become dead before we are done) [@4]
293    0x83787a0 -1   chan_sip.c:2436:dialog_unlink_all (Let's unbump the count in the unlink so the poor pvt can disappear if it is time) [@3]
294
295 As you can see, only one unbalanced operation is in the list, a ref count increment when
296 the peer->call was set, but no corresponding decrement was made...
297
298 Hopefully this helps you narrow your search and find those bugs.
299
300 THE ART OF REFERENCE COUNTING
301 (by Steve Murphy)
302 SOME TIPS for complicated code, and ref counting:
303
304 1. Theoretically, passing a refcounted object pointer into a function
305 call is an act of copying the reference, and could be refcounted.
306 But, upon examination, this sort of refcounting will explode the amount
307 of code you have to enter, and for no tangible benefit, beyond
308 creating more possible failure points/bugs. It will even
309 complicate your code and make debugging harder, slow down your program
310 doing useless increments and decrements of the ref counts.
311
312 2. It is better to track places where a ref counted pointer
313 is copied into a structure or stored. Make sure to decrement the refcount
314 of any previous pointer that might have been there, if setting
315 this field might erase a previous pointer. ao2_find and iterate_next
316 internally increment the ref count when they return a pointer, so
317 you need to decrement the count before the pointer goes out of scope.
318
319 3. Any time you decrement a ref count, it may be possible that the
320 object will be destroyed (freed) immediately by that call. If you
321 are destroying a series of fields in a refcounted object, and
322 any of the unref calls might possibly result in immediate destruction,
323 you can first increment the count to prevent such behavior, then
324 after the last test, decrement the pointer to allow the object
325 to be destroyed, if the refcount would be zero.
326
327 Example:
328
329         dialog_ref(dialog, "Let's bump the count in the unlink so it doesn't accidentally become dead before we are done");
330
331         ao2_t_unlink(dialogs, dialog, "unlinking dialog via ao2_unlink");
332
333         *//* Unlink us from the owner (channel) if we have one *//*
334         if (dialog->owner) {
335                 if (lockowner)
336                         ast_channel_lock(dialog->owner);
337                 ast_debug(1, "Detaching from channel %s\n", dialog->owner->name);
338                 dialog->owner->tech_pvt = dialog_unref(dialog->owner->tech_pvt, "resetting channel dialog ptr in unlink_all");
339                 if (lockowner)
340                         ast_channel_unlock(dialog->owner);
341         }
342         if (dialog->registry) {
343                 if (dialog->registry->call == dialog)
344                         dialog->registry->call = dialog_unref(dialog->registry->call, "nulling out the registry's call dialog field in unlink_all");
345                 dialog->registry = registry_unref(dialog->registry, "delete dialog->registry");
346         }
347     ...
348         dialog_unref(dialog, "Let's unbump the count in the unlink so the poor pvt can disappear if it is time");
349
350 In the above code, the ao2_t_unlink could end up destroying the dialog
351 object; if this happens, then the subsequent usages of the dialog
352 pointer could result in a core dump. So, we 'bump' the
353 count upwards before beginning, and then decrementing the count when
354 we are finished. This is analogous to 'locking' or 'protecting' operations
355 for a short while.
356
357 4. One of the most insidious problems I've run into when converting
358 code to do ref counted automatic destruction, is in the destruction
359 routines. Where a "destroy" routine had previously been called to
360 get rid of an object in non-refcounted code, the new regime demands
361 that you tear that "destroy" routine into two pieces, one that will
362 tear down the links and 'unref' them, and the other to actually free
363 and reset fields. A destroy routine that does any reference deletion
364 for its own object, will never be called. Another insidious problem
365 occurs in mutually referenced structures. As an example, a dialog contains
366 a pointer to a peer, and a peer contains a pointer to a dialog. Watch
367 out that the destruction of one doesn't depend on the destruction of the
368 other, as in this case a dependency loop will result in neither being
369 destroyed!
370
371 Given the above, you should be ready to do a good job!
372
373 murf
374
375 */
376
377
378
379 /*! \brief
380  * Typedef for an object destructor. This is called just before freeing
381  * the memory for the object. It is passed a pointer to the user-defined
382  * data of the object.
383  */
384 typedef void (*ao2_destructor_fn)(void *);
385
386
387 /*! \brief
388  * Allocate and initialize an object.
389  *
390  * \param data_size The sizeof() of the user-defined structure.
391  * \param destructor_fn The destructor function (can be NULL)
392  * \param debug_msg
393  * \return A pointer to user-data.
394  *
395  * Allocates a struct astobj2 with sufficient space for the
396  * user-defined structure.
397  * \note
398  * - storage is zeroed; XXX maybe we want a flag to enable/disable this.
399  * - the refcount of the object just created is 1
400  * - the returned pointer cannot be free()'d or realloc()'ed;
401  *   rather, we just call ao2_ref(o, -1);
402  *
403  * @{
404  */
405
406 #if defined(REF_DEBUG)
407
408 #define ao2_t_alloc(data_size, destructor_fn, debug_msg) __ao2_alloc_debug((data_size), (destructor_fn), (debug_msg),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
409 #define ao2_alloc(data_size, destructor_fn)              __ao2_alloc_debug((data_size), (destructor_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
410
411 #elif defined(__AST_DEBUG_MALLOC)
412
413 #define ao2_t_alloc(data_size, destructor_fn, debug_msg) __ao2_alloc_debug((data_size), (destructor_fn), (debug_msg),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
414 #define ao2_alloc(data_size, destructor_fn)              __ao2_alloc_debug((data_size), (destructor_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
415
416 #else
417
418 #define ao2_t_alloc(data_size, destructor_fn, debug_msg) __ao2_alloc((data_size), (destructor_fn))
419 #define ao2_alloc(data_size, destructor_fn)              __ao2_alloc((data_size), (destructor_fn))
420
421 #endif
422
423 void *__ao2_alloc_debug(const size_t data_size, ao2_destructor_fn destructor_fn, char *tag,
424                         const char *file, int line, const char *funcname, int ref_debug);
425 void *__ao2_alloc(const size_t data_size, ao2_destructor_fn destructor_fn);
426
427 /*! @} */
428
429 /*! \brief
430  * Reference/unreference an object and return the old refcount.
431  *
432  * \param o A pointer to the object
433  * \param delta Value to add to the reference counter.
434  * \return The value of the reference counter before the operation.
435  *
436  * Increase/decrease the reference counter according
437  * the value of delta.
438  *
439  * If the refcount goes to zero, the object is destroyed.
440  *
441  * \note The object must not be locked by the caller of this function, as
442  *       it is invalid to try to unlock it after releasing the reference.
443  *
444  * \note if we know the pointer to an object, it is because we
445  * have a reference count to it, so the only case when the object
446  * can go away is when we release our reference, and it is
447  * the last one in existence.
448  *
449  * @{
450  */
451
452 #ifdef REF_DEBUG
453
454 #define ao2_t_ref(o,delta,tag) __ao2_ref_debug((o), (delta), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
455 #define ao2_ref(o,delta)       __ao2_ref_debug((o), (delta), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
456
457 #else
458
459 #define ao2_t_ref(o,delta,tag) __ao2_ref((o), (delta))
460 #define ao2_ref(o,delta)       __ao2_ref((o), (delta))
461
462 #endif
463
464 int __ao2_ref_debug(void *o, int delta, char *tag, char *file, int line, const char *funcname);
465 int __ao2_ref(void *o, int delta);
466
467 /*! @} */
468
469 /*! \brief
470  * Lock an object.
471  *
472  * \param a A pointer to the object we want to lock.
473  * \return 0 on success, other values on error.
474  */
475 int __ao2_lock(void *a, const char *file, const char *func, int line, const char *var);
476 #define ao2_lock(a) __ao2_lock(a, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
477
478 /*! \brief
479  * Unlock an object.
480  *
481  * \param a A pointer to the object we want unlock.
482  * \return 0 on success, other values on error.
483  */
484 int __ao2_unlock(void *a, const char *file, const char *func, int line, const char *var);
485 #define ao2_unlock(a) __ao2_unlock(a, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
486
487 /*! \brief
488  * Try locking-- (don't block if fail)
489  *
490  * \param a A pointer to the object we want to lock.
491  * \return 0 on success, other values on error.
492  */
493 int __ao2_trylock(void *a, const char *file, const char *func, int line, const char *var);
494 #define ao2_trylock(a) __ao2_trylock(a, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
495
496 /*!
497  * \brief Return the lock address of an object
498  *
499  * \param[in] obj A pointer to the object we want.
500  * \return the address of the lock, else NULL.
501  *
502  * This function comes in handy mainly for debugging locking
503  * situations, where the locking trace code reports the
504  * lock address, this allows you to correlate against
505  * object address, to match objects to reported locks.
506  *
507  * \since 1.6.1
508  */
509 void *ao2_object_get_lockaddr(void *obj);
510
511 /*!
512  \page AstObj2_Containers AstObj2 Containers
513
514 Containers are data structures meant to store several objects,
515 and perform various operations on them.
516 Internally, objects are stored in lists, hash tables or other
517 data structures depending on the needs.
518
519 \note NOTA BENE: at the moment the only container we support is the
520         hash table and its degenerate form, the list.
521
522 Operations on container include:
523
524   -  c = \b ao2_container_alloc(size, hash_fn, cmp_fn)
525         allocate a container with desired size and default compare
526         and hash function
527          -The compare function returns an int, which
528          can be 0 for not found, CMP_STOP to stop end a traversal,
529          or CMP_MATCH if they are equal
530          -The hash function returns an int. The hash function
531          takes two argument, the object pointer and a flags field,
532
533   -  \b ao2_find(c, arg, flags)
534         returns zero or more element matching a given criteria
535         (specified as arg). 'c' is the container pointer. Flags
536     can be:
537         OBJ_UNLINK - to remove the object, once found, from the container.
538         OBJ_NODATA - don't return the object if found (no ref count change)
539         OBJ_MULTIPLE - don't stop at first match
540         OBJ_POINTER     - if set, 'arg' is an object pointer, and a hashtable
541                   search will be done. If not, a traversal is done.
542
543   -  \b ao2_callback(c, flags, fn, arg)
544         apply fn(obj, arg) to all objects in the container.
545         Similar to find. fn() can tell when to stop, and
546         do anything with the object including unlinking it.
547           - c is the container;
548       - flags can be
549              OBJ_UNLINK   - to remove the object, once found, from the container.
550              OBJ_NODATA   - don't return the object if found (no ref count change)
551              OBJ_MULTIPLE - don't stop at first match
552              OBJ_POINTER  - if set, 'arg' is an object pointer, and a hashtable
553                         search will be done. If not, a traversal is done through
554                         all the hashtable 'buckets'..
555       - fn is a func that returns int, and takes 3 args:
556         (void *obj, void *arg, int flags);
557           obj is an object
558           arg is the same as arg passed into ao2_callback
559           flags is the same as flags passed into ao2_callback
560          fn returns:
561            0: no match, keep going
562            CMP_STOP: stop search, no match
563            CMP_MATCH: This object is matched.
564
565         Note that the entire operation is run with the container
566         locked, so noone else can change its content while we work on it.
567         However, we pay this with the fact that doing
568         anything blocking in the callback keeps the container
569         blocked.
570         The mechanism is very flexible because the callback function fn()
571         can do basically anything e.g. counting, deleting records, etc.
572         possibly using arg to store the results.
573
574   -  \b iterate on a container
575         this is done with the following sequence
576
577 \code
578
579             struct ao2_container *c = ... // our container
580             struct ao2_iterator i;
581             void *o;
582
583             i = ao2_iterator_init(c, flags);
584
585             while ( (o = ao2_iterator_next(&i)) ) {
586                 ... do something on o ...
587                 ao2_ref(o, -1);
588             }
589
590             ao2_iterator_destroy(&i);
591 \endcode
592
593         The difference with the callback is that the control
594         on how to iterate is left to us.
595
596     - \b ao2_ref(c, -1)
597         dropping a reference to a container destroys it, very simple!
598
599 Containers are ao2 objects themselves, and this is why their
600 implementation is simple too.
601
602 Before declaring containers, we need to declare the types of the
603 arguments passed to the constructor - in turn, this requires
604 to define callback and hash functions and their arguments.
605
606 - \ref AstObj2
607 - \ref astobj2.h
608  */
609
610 /*! \brief
611  * Type of a generic callback function
612  * \param obj  pointer to the (user-defined part) of an object.
613  * \param arg callback argument from ao2_callback()
614  * \param flags flags from ao2_callback()
615  *
616  * The return values are a combination of enum _cb_results.
617  * Callback functions are used to search or manipulate objects in a container.
618  */
619 typedef int (ao2_callback_fn)(void *obj, void *arg, int flags);
620
621 /*! \brief
622  * Type of a generic callback function
623  * \param obj pointer to the (user-defined part) of an object.
624  * \param arg callback argument from ao2_callback()
625  * \param data arbitrary data from ao2_callback()
626  * \param flags flags from ao2_callback()
627  *
628  * The return values are a combination of enum _cb_results.
629  * Callback functions are used to search or manipulate objects in a container.
630  */
631 typedef int (ao2_callback_data_fn)(void *obj, void *arg, void *data, int flags);
632
633 /*! \brief a very common callback is one that matches by address. */
634 ao2_callback_fn ao2_match_by_addr;
635
636 /*! \brief
637  * A callback function will return a combination of CMP_MATCH and CMP_STOP.
638  * The latter will terminate the search in a container.
639  */
640 enum _cb_results {
641         CMP_MATCH       = 0x1,  /*!< the object matches the request */
642         CMP_STOP        = 0x2,  /*!< stop the search now */
643 };
644
645 /*! \brief
646  * Flags passed to ao2_callback() and ao2_hash_fn() to modify its behaviour.
647  */
648 enum search_flags {
649         /*! Unlink the object for which the callback function
650          *  returned CMP_MATCH.
651          */
652         OBJ_UNLINK       = (1 << 0),
653         /*! On match, don't return the object hence do not increase
654          *  its refcount.
655          */
656         OBJ_NODATA       = (1 << 1),
657         /*! Don't stop at the first match in ao2_callback() unless the result of
658          *  of the callback function == (CMP_STOP | CMP_MATCH).
659          */
660         OBJ_MULTIPLE = (1 << 2),
661         /*! obj is an object of the same type as the one being searched for,
662          *  so use the object's hash function for optimized searching.
663          *  The search function is unaffected (i.e. use the one passed as
664          *  argument, or match_by_addr if none specified).
665          */
666         OBJ_POINTER      = (1 << 3),
667         /*! 
668          * \brief Continue if a match is not found in the hashed out bucket
669          *
670          * This flag is to be used in combination with OBJ_POINTER.  This tells
671          * the ao2_callback() core to keep searching through the rest of the
672          * buckets if a match is not found in the starting bucket defined by
673          * the hash value on the argument.
674          */
675         OBJ_CONTINUE     = (1 << 4),
676 };
677
678 /*!
679  * Type of a generic function to generate a hash value from an object.
680  * flags is ignored at the moment. Eventually, it will include the
681  * value of OBJ_POINTER passed to ao2_callback().
682  */
683 typedef int (ao2_hash_fn)(const void *obj, const int flags);
684
685 /*! \name Object Containers
686  * Here start declarations of containers.
687  */
688 /*@{ */
689 struct ao2_container;
690
691 /*! \brief
692  * Allocate and initialize a container
693  * with the desired number of buckets.
694  *
695  * We allocate space for a struct astobj_container, struct container
696  * and the buckets[] array.
697  *
698  * \param n_buckets Number of buckets for hash
699  * \param hash_fn Pointer to a function computing a hash value.
700  * \param cmp_fn Pointer to a function comparating key-value
701  *                      with a string. (can be NULL)
702  * \return A pointer to a struct container.
703  *
704  * destructor is set implicitly.
705  */
706
707 #if defined(REF_DEBUG)
708
709 #define ao2_t_container_alloc(arg1,arg2,arg3,arg4) __ao2_container_alloc_debug((arg1), (arg2), (arg3), (arg4),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
710 #define ao2_container_alloc(arg1,arg2,arg3)        __ao2_container_alloc_debug((arg1), (arg2), (arg3), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
711
712 #elif defined(__AST_DEBUG_MALLOC)
713
714 #define ao2_t_container_alloc(arg1,arg2,arg3,arg4) __ao2_container_alloc_debug((arg1), (arg2), (arg3), (arg4),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
715 #define ao2_container_alloc(arg1,arg2,arg3)        __ao2_container_alloc_debug((arg1), (arg2), (arg3), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
716
717 #else
718
719 #define ao2_t_container_alloc(arg1,arg2,arg3,arg4) __ao2_container_alloc((arg1), (arg2), (arg3))
720 #define ao2_container_alloc(arg1,arg2,arg3)        __ao2_container_alloc((arg1), (arg2), (arg3))
721
722 #endif
723
724 struct ao2_container *__ao2_container_alloc(const unsigned int n_buckets,
725                                             ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn);
726 struct ao2_container *__ao2_container_alloc_debug(const unsigned int n_buckets,
727                                                   ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn,
728                                                   char *tag, char *file, int line, const char *funcname,
729                                                   int ref_debug);
730
731 /*! \brief
732  * Returns the number of elements in a container.
733  */
734 int ao2_container_count(struct ao2_container *c);
735
736 /*@} */
737
738 /*! \name Object Management
739  * Here we have functions to manage objects.
740  *
741  * We can use the functions below on any kind of
742  * object defined by the user.
743  */
744 /*@{ */
745
746 /*!
747  * \brief Add an object to a container.
748  *
749  * \param c the container to operate on.
750  * \param newobj the object to be added.
751  *
752  * \retval NULL on errors
753  * \retval newobj on success.
754  *
755  * This function inserts an object in a container according its key.
756  *
757  * \note Remember to set the key before calling this function.
758  *
759  * \note This function automatically increases the reference count to account
760  *       for the reference that the container now holds to the object.
761  */
762 #ifdef REF_DEBUG
763
764 #define ao2_t_link(arg1, arg2, arg3) __ao2_link_debug((arg1), (arg2), (arg3),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
765 #define ao2_link(arg1, arg2)         __ao2_link_debug((arg1), (arg2), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
766
767 #else
768
769 #define ao2_t_link(arg1, arg2, arg3) __ao2_link((arg1), (arg2))
770 #define ao2_link(arg1, arg2)         __ao2_link((arg1), (arg2))
771
772 #endif
773
774 void *__ao2_link_debug(struct ao2_container *c, void *new_obj, char *tag, char *file, int line, const char *funcname);
775 void *__ao2_link(struct ao2_container *c, void *newobj);
776
777 /*!
778  * \brief Remove an object from a container
779  *
780  * \param c the container
781  * \param obj the object to unlink
782  *
783  * \retval NULL, always
784  *
785  * \note The object requested to be unlinked must be valid.  However, if it turns
786  *       out that it is not in the container, this function is still safe to
787  *       be called.
788  *
789  * \note If the object gets unlinked from the container, the container's
790  *       reference to the object will be automatically released. (The
791  *       refcount will be decremented).
792  */
793 #ifdef REF_DEBUG
794
795 #define ao2_t_unlink(arg1, arg2, arg3) __ao2_unlink_debug((arg1), (arg2), (arg3),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
796 #define ao2_unlink(arg1, arg2)         __ao2_unlink_debug((arg1), (arg2), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
797
798 #else
799
800 #define ao2_t_unlink(arg1, arg2, arg3) __ao2_unlink((arg1), (arg2))
801 #define ao2_unlink(arg1, arg2)         __ao2_unlink((arg1), (arg2))
802
803 #endif
804
805 void *__ao2_unlink_debug(struct ao2_container *c, void *obj, char *tag, char *file, int line, const char *funcname);
806 void *__ao2_unlink(struct ao2_container *c, void *obj);
807
808
809 /*@} */
810
811 /*! \brief
812  * ao2_callback() is a generic function that applies cb_fn() to all objects
813  * in a container, as described below.
814  *
815  * \param c A pointer to the container to operate on.
816  * \param flags A set of flags specifying the operation to perform,
817         partially used by the container code, but also passed to
818         the callback.
819      - If OBJ_NODATA is set, ao2_callback will return NULL. No refcounts
820        of any of the traversed objects will be incremented.
821        On the converse, if it is NOT set (the default), The ref count
822        of each object for which CMP_MATCH was set will be incremented,
823        and you will have no way of knowing which those are, until
824        the multiple-object-return functionality is implemented.
825      - If OBJ_POINTER is set, the traversed items will be restricted
826        to the objects in the bucket that the object key hashes to.
827  * \param cb_fn A function pointer, that will be called on all
828     objects, to see if they match. This function returns CMP_MATCH
829     if the object is matches the criteria; CMP_STOP if the traversal
830     should immediately stop, or both (via bitwise ORing), if you find a
831     match and want to end the traversal, and 0 if the object is not a match,
832     but the traversal should continue. This is the function that is applied
833     to each object traversed. Its arguments are:
834         (void *obj, void *arg, int flags), where:
835           obj is an object
836           arg is the same as arg passed into ao2_callback
837           flags is the same as flags passed into ao2_callback (flags are
838            also used by ao2_callback).
839  * \param arg passed to the callback.
840  * \return when OBJ_MULTIPLE is not included in the flags parameter,
841  *         the return value will be either the object found or NULL if no
842  *         no matching object was found. if OBJ_MULTIPLE is included,
843  *         the return value will be a pointer to an ao2_iterator object,
844  *         which must be destroyed with ao2_iterator_destroy() when the
845  *         caller no longer needs it.
846  *
847  * If the function returns any objects, their refcount is incremented,
848  * and the caller is in charge of decrementing them once done.
849  *
850  * Typically, ao2_callback() is used for two purposes:
851  * - to perform some action (including removal from the container) on one
852  *   or more objects; in this case, cb_fn() can modify the object itself,
853  *   and to perform deletion should set CMP_MATCH on the matching objects,
854  *   and have OBJ_UNLINK set in flags.
855  * - to look for a specific object in a container; in this case, cb_fn()
856  *   should not modify the object, but just return a combination of
857  *   CMP_MATCH and CMP_STOP on the desired object.
858  * Other usages are also possible, of course.
859
860  * This function searches through a container and performs operations
861  * on objects according on flags passed.
862  * XXX describe better
863  * The comparison is done calling the compare function set implicitly.
864  * The p pointer can be a pointer to an object or to a key,
865  * we can say this looking at flags value.
866  * If p points to an object we will search for the object pointed
867  * by this value, otherwise we serch for a key value.
868  * If the key is not unique we only find the first matching valued.
869  *
870  * The use of flags argument is the follow:
871  *
872  *      OBJ_UNLINK              unlinks the object found
873  *      OBJ_NODATA              on match, do return an object
874  *                              Callbacks use OBJ_NODATA as a default
875  *                              functions such as find() do
876  *      OBJ_MULTIPLE            return multiple matches
877  *                              Default is no.
878  *      OBJ_POINTER             the pointer is an object pointer
879  *
880  * \note When the returned object is no longer in use, ao2_ref() should
881  * be used to free the additional reference possibly created by this function.
882  *
883  * @{
884  */
885 #ifdef REF_DEBUG
886
887 #define ao2_t_callback(c,flags,cb_fn,arg,tag) __ao2_callback_debug((c), (flags), (cb_fn), (arg), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
888 #define ao2_callback(c,flags,cb_fn,arg)       __ao2_callback_debug((c), (flags), (cb_fn), (arg), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
889
890 #else
891
892 #define ao2_t_callback(c,flags,cb_fn,arg,tag) __ao2_callback((c), (flags), (cb_fn), (arg))
893 #define ao2_callback(c,flags,cb_fn,arg)       __ao2_callback((c), (flags), (cb_fn), (arg))
894
895 #endif
896
897 void *__ao2_callback_debug(struct ao2_container *c, enum search_flags flags, ao2_callback_fn *cb_fn,
898                            void *arg, char *tag, char *file, int line, const char *funcname);
899 void *__ao2_callback(struct ao2_container *c, enum search_flags flags, ao2_callback_fn *cb_fn, void *arg);
900
901 /*! @} */
902
903 /*! \brief
904  * ao2_callback_data() is a generic function that applies cb_fn() to all objects
905  * in a container.  It is functionally identical to ao2_callback() except that
906  * instead of taking an ao2_callback_fn *, it takes an ao2_callback_data_fn *, and
907  * allows the caller to pass in arbitrary data.
908  *
909  * This call would be used instead of ao2_callback() when the caller needs to pass
910  * OBJ_POINTER as part of the flags argument (which in turn requires passing in a
911  * prototype ao2 object for 'arg') and also needs access to other non-global data
912  * to complete it's comparison or task.
913  *
914  * See the documentation for ao2_callback() for argument descriptions.
915  *
916  * \see ao2_callback()
917  */
918 #ifdef REF_DEBUG
919
920 #define ao2_t_callback_data(arg1,arg2,arg3,arg4,arg5,arg6) __ao2_callback_data_debug((arg1), (arg2), (arg3), (arg4), (arg5), (arg6), __FILE__, __LINE__, __PRETTY_FUNCTION__)
921 #define ao2_callback_data(arg1,arg2,arg3,arg4,arg5)        __ao2_callback_data_debug((arg1), (arg2), (arg3), (arg4), (arg5), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
922
923 #else
924
925 #define ao2_t_callback_data(arg1,arg2,arg3,arg4,arg5,arg6) __ao2_callback_data((arg1), (arg2), (arg3), (arg4), (arg5))
926 #define ao2_callback_data(arg1,arg2,arg3,arg4,arg5)        __ao2_callback_data((arg1), (arg2), (arg3), (arg4), (arg5))
927
928 #endif
929
930 void *__ao2_callback_data_debug(struct ao2_container *c, enum search_flags flags,
931                                 ao2_callback_data_fn *cb_fn, void *arg, void *data, char *tag,
932                                 char *file, int line, const char *funcname);
933 void *__ao2_callback_data(struct ao2_container *c, enum search_flags flags,
934                           ao2_callback_data_fn *cb_fn, void *arg, void *data);
935
936 /*! ao2_find() is a short hand for ao2_callback(c, flags, c->cmp_fn, arg)
937  * XXX possibly change order of arguments ?
938  */
939 #ifdef REF_DEBUG
940
941 #define ao2_t_find(arg1,arg2,arg3,arg4) __ao2_find_debug((arg1), (arg2), (arg3), (arg4), __FILE__, __LINE__, __PRETTY_FUNCTION__)
942 #define ao2_find(arg1,arg2,arg3)        __ao2_find_debug((arg1), (arg2), (arg3), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
943
944 #else
945
946 #define ao2_t_find(arg1,arg2,arg3,arg4) __ao2_find((arg1), (arg2), (arg3))
947 #define ao2_find(arg1,arg2,arg3)        __ao2_find((arg1), (arg2), (arg3))
948
949 #endif
950
951 void *__ao2_find_debug(struct ao2_container *c, void *arg, enum search_flags flags, char *tag,
952                        char *file, int line, const char *funcname);
953 void *__ao2_find(struct ao2_container *c, void *arg, enum search_flags flags);
954
955 /*! \brief
956  *
957  *
958  * When we need to walk through a container, we use an
959  * ao2_iterator to keep track of the current position.
960  *
961  * Because the navigation is typically done without holding the
962  * lock on the container across the loop, objects can be inserted or deleted
963  * or moved while we work. As a consequence, there is no guarantee that
964  * we manage to touch all the elements in the container, and it is possible
965  * that we touch the same object multiple times.
966  *
967  * However, within the current hash table container, the following is true:
968  *  - It is not possible to miss an object in the container while iterating
969  *    unless it gets added after the iteration begins and is added to a bucket
970  *    that is before the one the current object is in.  In this case, even if
971  *    you locked the container around the entire iteration loop, you still would
972  *    not see this object, because it would still be waiting on the container
973  *    lock so that it can be added.
974  *  - It would be extremely rare to see an object twice.  The only way this can
975  *    happen is if an object got unlinked from the container and added again
976  *    during the same iteration.  Furthermore, when the object gets added back,
977  *    it has to be in the current or later bucket for it to be seen again.
978  *
979  * An iterator must be first initialized with ao2_iterator_init(),
980  * then we can use o = ao2_iterator_next() to move from one
981  * element to the next. Remember that the object returned by
982  * ao2_iterator_next() has its refcount incremented,
983  * and the reference must be explicitly released when done with it.
984  *
985  * In addition, ao2_iterator_init() will hold a reference to the container
986  * being iterated, which will be freed when ao2_iterator_destroy() is called
987  * to free up the resources used by the iterator (if any).
988  *
989  * Example:
990  *
991  *  \code
992  *
993  *  struct ao2_container *c = ... // the container we want to iterate on
994  *  struct ao2_iterator i;
995  *  struct my_obj *o;
996  *
997  *  i = ao2_iterator_init(c, flags);
998  *
999  *  while ( (o = ao2_iterator_next(&i)) ) {
1000  *     ... do something on o ...
1001  *     ao2_ref(o, -1);
1002  *  }
1003  *
1004  *  ao2_iterator_destroy(&i);
1005  *
1006  *  \endcode
1007  *
1008  */
1009
1010 /*! \brief
1011  * The astobj2 iterator
1012  *
1013  * \note You are not supposed to know the internals of an iterator!
1014  * We would like the iterator to be opaque, unfortunately
1015  * its size needs to be known if we want to store it around
1016  * without too much trouble.
1017  * Anyways...
1018  * The iterator has a pointer to the container, and a flags
1019  * field specifying various things e.g. whether the container
1020  * should be locked or not while navigating on it.
1021  * The iterator "points" to the current object, which is identified
1022  * by three values:
1023  *
1024  * - a bucket number;
1025  * - the object_id, which is also the container version number
1026  *   when the object was inserted. This identifies the object
1027  *   uniquely, however reaching the desired object requires
1028  *   scanning a list.
1029  * - a pointer, and a container version when we saved the pointer.
1030  *   If the container has not changed its version number, then we
1031  *   can safely follow the pointer to reach the object in constant time.
1032  *
1033  * Details are in the implementation of ao2_iterator_next()
1034  * A freshly-initialized iterator has bucket=0, version=0.
1035  */
1036 struct ao2_iterator {
1037         /*! the container */
1038         struct ao2_container *c;
1039         /*! operation flags */
1040         int flags;
1041         /*! current bucket */
1042         int bucket;
1043         /*! container version */
1044         unsigned int c_version;
1045         /*! pointer to the current object */
1046         void *obj;
1047         /*! container version when the object was created */
1048         unsigned int version;
1049 };
1050
1051 /*! Flags that can be passed to ao2_iterator_init() to modify the behavior
1052  * of the iterator.
1053  */
1054 enum ao2_iterator_flags {
1055         /*! Prevents ao2_iterator_next() from locking the container
1056          * while retrieving the next object from it.
1057          */
1058         AO2_ITERATOR_DONTLOCK = (1 << 0),
1059         /*! Indicates that the iterator was dynamically allocated by
1060          * astobj2 API and should be freed by ao2_iterator_destroy().
1061          */
1062         AO2_ITERATOR_MALLOCD = (1 << 1),
1063         /*! Indicates that before the iterator returns an object from
1064          * the container being iterated, the object should be unlinked
1065          * from the container.
1066          */
1067         AO2_ITERATOR_UNLINK = (1 << 2),
1068 };
1069
1070 /*!
1071  * \brief Create an iterator for a container
1072  *
1073  * \param c the container
1074  * \param flags one or more flags from ao2_iterator_flags
1075  *
1076  * \retval the constructed iterator
1077  *
1078  * \note This function does \b not take a pointer to an iterator;
1079  *       rather, it returns an iterator structure that should be
1080  *       assigned to (overwriting) an existing iterator structure
1081  *       allocated on the stack or on the heap.
1082  *
1083  * This function will take a reference on the container being iterated.
1084  *
1085  */
1086 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags);
1087
1088 /*!
1089  * \brief Destroy a container iterator
1090  *
1091  * \param i the iterator to destroy
1092  *
1093  * \retval none
1094  *
1095  * This function will release the container reference held by the iterator
1096  * and any other resources it may be holding.
1097  *
1098  */
1099 void ao2_iterator_destroy(struct ao2_iterator *i);
1100
1101 #ifdef REF_DEBUG
1102
1103 #define ao2_t_iterator_next(arg1, arg2) __ao2_iterator_next_debug((arg1), (arg2),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1104 #define ao2_iterator_next(arg1)         __ao2_iterator_next_debug((arg1), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1105
1106 #else
1107
1108 #define ao2_t_iterator_next(arg1, arg2) __ao2_iterator_next((arg1))
1109 #define ao2_iterator_next(arg1)         __ao2_iterator_next((arg1))
1110
1111 #endif
1112
1113 void *__ao2_iterator_next_debug(struct ao2_iterator *a, char *tag, char *file, int line, const char *funcname);
1114 void *__ao2_iterator_next(struct ao2_iterator *a);
1115
1116 /* extra functions */
1117 void ao2_bt(void);      /* backtrace */
1118
1119 #endif /* _ASTERISK_ASTOBJ2_H */