astobj2: Remove OBJ_CONTINUE support.
[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/lock.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 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 re-inserting 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_xxx functions
146 that are named ao2_t_xxx 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_xxx 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 than 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 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, const 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         }
217         return p;
218 }
219
220 static struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, const char *tag, const char *file, int line, const char *func)
221 {
222         if (p) {
223                 ao2_ref_debug(p, -1, tag, file, line, func);
224         }
225         return NULL;
226 }
227 #else
228 static struct sip_pvt *dialog_ref(struct sip_pvt *p, const char *tag)
229 {
230         if (p) {
231                 ao2_ref(p, 1);
232         } else {
233                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
234         }
235         return p;
236 }
237
238 static struct sip_pvt *dialog_unref(struct sip_pvt *p, const char *tag)
239 {
240         if (p) {
241                 ao2_ref(p, -1);
242         }
243         return NULL;
244 }
245 #endif
246
247 In the above code, note that the "normal" helper funcs call ao2_ref() as
248 normal, and the "helper" functions call ao2_ref_debug directly with the
249 file, function, and line number info provided. You might find this
250 well worth the effort to help track these function calls in the code.
251
252 To find out why objects are not destroyed (a common bug), you can
253 edit the source file to use the ao2_t_* variants, add the #define REF_DEBUG 1
254 before the #include "asterisk/astobj2.h" line, and add a descriptive
255 tag to each call. Recompile, and run Asterisk, exit asterisk with
256 "stop gracefully", which should result in every object being destroyed.
257 Then, you can "sort -k 1 /tmp/refs > x1" to get a sorted list of
258 all the objects, or you can use "util/refcounter" to scan the file
259 for you and output any problems it finds.
260
261 The above may seem astronomically more work than it is worth to debug
262 reference counts, which may be true in "simple" situations, but for
263 more complex situations, it is easily worth 100 times this effort to
264 help find problems.
265
266 To debug, pair all calls so that each call that increments the
267 refcount is paired with a corresponding call that decrements the
268 count for the same reason. Hopefully, you will be left with one
269 or more unpaired calls. This is where you start your search!
270
271 For instance, here is an example of this for a dialog object in
272 chan_sip, that was not getting destroyed, after I moved the lines around
273 to pair operations:
274
275    0x83787a0 =1   chan_sip.c:5733:sip_alloc (allocate a dialog(pvt) struct)
276    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]
277
278    0x83787a0 +1   chan_sip.c:5854:sip_alloc (link pvt into dialogs table) [@1]
279    0x83787a0 -1   chan_sip.c:19150:sip_poke_peer (About to change the callid -- remove the old name) [@3]
280    0x83787a0 +1   chan_sip.c:19152:sip_poke_peer (Linking in under new name) [@2]
281    0x83787a0 -1   chan_sip.c:2399:dialog_unlink_all (unlinking dialog via ao2_unlink) [@5]
282
283    0x83787a0 +1   chan_sip.c:19130:sip_poke_peer (copy sip alloc from p to peer->call) [@2]
284
285
286    0x83787a0 +1   chan_sip.c:2996:__sip_reliable_xmit (__sip_reliable_xmit: setting pkt->owner) [@3]
287    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]
288
289    0x83787a0 +1   chan_sip.c:22356:unload_module (iterate thru dialogs) [@4]
290    0x83787a0 -1   chan_sip.c:22359:unload_module (toss dialog ptr from iterator_next) [@5]
291
292
293    0x83787a0 +1   chan_sip.c:22373:unload_module (iterate thru dialogs) [@3]
294    0x83787a0 -1   chan_sip.c:22375:unload_module (throw away iterator result) [@2]
295
296    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]
297    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]
298
299 As you can see, only one unbalanced operation is in the list, a ref count increment when
300 the peer->call was set, but no corresponding decrement was made...
301
302 Hopefully this helps you narrow your search and find those bugs.
303
304 THE ART OF REFERENCE COUNTING
305 (by Steve Murphy)
306 SOME TIPS for complicated code, and ref counting:
307
308 1. Theoretically, passing a refcounted object pointer into a function
309 call is an act of copying the reference, and could be refcounted.
310 But, upon examination, this sort of refcounting will explode the amount
311 of code you have to enter, and for no tangible benefit, beyond
312 creating more possible failure points/bugs. It will even
313 complicate your code and make debugging harder, slow down your program
314 doing useless increments and decrements of the ref counts.
315
316 2. It is better to track places where a ref counted pointer
317 is copied into a structure or stored. Make sure to decrement the refcount
318 of any previous pointer that might have been there, if setting
319 this field might erase a previous pointer. ao2_find and iterate_next
320 internally increment the ref count when they return a pointer, so
321 you need to decrement the count before the pointer goes out of scope.
322
323 3. Any time you decrement a ref count, it may be possible that the
324 object will be destroyed (freed) immediately by that call. If you
325 are destroying a series of fields in a refcounted object, and
326 any of the unref calls might possibly result in immediate destruction,
327 you can first increment the count to prevent such behavior, then
328 after the last test, decrement the pointer to allow the object
329 to be destroyed, if the refcount would be zero.
330
331 Example:
332
333         dialog_ref(dialog, "Let's bump the count in the unlink so it doesn't accidentally become dead before we are done");
334
335         ao2_t_unlink(dialogs, dialog, "unlinking dialog via ao2_unlink");
336
337         *//* Unlink us from the owner (channel) if we have one *//*
338         if (dialog->owner) {
339                 if (lockowner) {
340                         ast_channel_lock(dialog->owner);
341                 }
342                 ast_debug(1, "Detaching from channel %s\n", dialog->owner->name);
343                 dialog->owner->tech_pvt = dialog_unref(dialog->owner->tech_pvt, "resetting channel dialog ptr in unlink_all");
344                 if (lockowner) {
345                         ast_channel_unlock(dialog->owner);
346                 }
347         }
348         if (dialog->registry) {
349                 if (dialog->registry->call == dialog) {
350                         dialog->registry->call = dialog_unref(dialog->registry->call, "nulling out the registry's call dialog field in unlink_all");
351                 }
352                 dialog->registry = registry_unref(dialog->registry, "delete dialog->registry");
353         }
354         ...
355         dialog_unref(dialog, "Let's unbump the count in the unlink so the poor pvt can disappear if it is time");
356
357 In the above code, the ao2_t_unlink could end up destroying the dialog
358 object; if this happens, then the subsequent usages of the dialog
359 pointer could result in a core dump. So, we 'bump' the
360 count upwards before beginning, and then decrementing the count when
361 we are finished. This is analogous to 'locking' or 'protecting' operations
362 for a short while.
363
364 4. One of the most insidious problems I've run into when converting
365 code to do ref counted automatic destruction, is in the destruction
366 routines. Where a "destroy" routine had previously been called to
367 get rid of an object in non-refcounted code, the new regime demands
368 that you tear that "destroy" routine into two pieces, one that will
369 tear down the links and 'unref' them, and the other to actually free
370 and reset fields. A destroy routine that does any reference deletion
371 for its own object, will never be called. Another insidious problem
372 occurs in mutually referenced structures. As an example, a dialog contains
373 a pointer to a peer, and a peer contains a pointer to a dialog. Watch
374 out that the destruction of one doesn't depend on the destruction of the
375 other, as in this case a dependency loop will result in neither being
376 destroyed!
377
378 Given the above, you should be ready to do a good job!
379
380 murf
381
382 */
383
384
385
386 /*!
387  * \brief Typedef for an object destructor.
388  *
389  * \param vdoomed Object to destroy.
390  *
391  * \details
392  * This is called just before freeing the memory for the object.
393  * It is passed a pointer to the user-defined data of the
394  * object.
395  *
396  * \return Nothing
397  */
398 typedef void (*ao2_destructor_fn)(void *vdoomed);
399
400 /*! \brief Options available when allocating an ao2 object. */
401 enum ao2_alloc_opts {
402         /*! The ao2 object has a recursive mutex lock associated with it. */
403         AO2_ALLOC_OPT_LOCK_MUTEX = (0 << 0),
404         /*! The ao2 object has a non-recursive read/write lock associated with it. */
405         AO2_ALLOC_OPT_LOCK_RWLOCK = (1 << 0),
406         /*! The ao2 object has no lock associated with it. */
407         AO2_ALLOC_OPT_LOCK_NOLOCK = (2 << 0),
408         /*! The ao2 object locking option field mask. */
409         AO2_ALLOC_OPT_LOCK_MASK = (3 << 0),
410 };
411
412 /*!
413  * \brief Allocate and initialize an object.
414  *
415  * \param data_size The sizeof() of the user-defined structure.
416  * \param destructor_fn The destructor function (can be NULL)
417  * \param options The ao2 object options (See enum ao2_alloc_opts)
418  * \param debug_msg An ao2 object debug tracing message.
419  * \return A pointer to user-data.
420  *
421  * \details
422  * Allocates a struct astobj2 with sufficient space for the
423  * user-defined structure.
424  * \note
425  * - storage is zeroed; XXX maybe we want a flag to enable/disable this.
426  * - the refcount of the object just created is 1
427  * - the returned pointer cannot be free()'d or realloc()'ed;
428  *   rather, we just call ao2_ref(o, -1);
429  *
430  * @{
431  */
432
433 #if defined(REF_DEBUG)
434
435 #define ao2_t_alloc_options(data_size, destructor_fn, options, debug_msg) \
436         __ao2_alloc_debug((data_size), (destructor_fn), (options), (debug_msg),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
437 #define ao2_alloc_options(data_size, destructor_fn, options) \
438         __ao2_alloc_debug((data_size), (destructor_fn), (options), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
439
440 #define ao2_t_alloc(data_size, destructor_fn, debug_msg) \
441         __ao2_alloc_debug((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX, (debug_msg),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
442 #define ao2_alloc(data_size, destructor_fn) \
443         __ao2_alloc_debug((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX, "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
444
445 #elif defined(__AST_DEBUG_MALLOC)
446
447 #define ao2_t_alloc_options(data_size, destructor_fn, options, debug_msg) \
448         __ao2_alloc_debug((data_size), (destructor_fn), (options), (debug_msg),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
449 #define ao2_alloc_options(data_size, destructor_fn, options) \
450         __ao2_alloc_debug((data_size), (destructor_fn), (options), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
451
452 #define ao2_t_alloc(data_size, destructor_fn, debug_msg) \
453         __ao2_alloc_debug((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX, (debug_msg),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
454 #define ao2_alloc(data_size, destructor_fn) \
455         __ao2_alloc_debug((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX, "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
456
457 #else
458
459 #define ao2_t_alloc_options(data_size, destructor_fn, options, debug_msg) \
460         __ao2_alloc((data_size), (destructor_fn), (options))
461 #define ao2_alloc_options(data_size, destructor_fn, options) \
462         __ao2_alloc((data_size), (destructor_fn), (options))
463
464 #define ao2_t_alloc(data_size, destructor_fn, debug_msg) \
465         __ao2_alloc((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX)
466 #define ao2_alloc(data_size, destructor_fn) \
467         __ao2_alloc((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX)
468
469 #endif
470
471 void *__ao2_alloc_debug(size_t data_size, ao2_destructor_fn destructor_fn, unsigned int options, const char *tag,
472         const char *file, int line, const char *func, int ref_debug) attribute_warn_unused_result;
473 void *__ao2_alloc(size_t data_size, ao2_destructor_fn destructor_fn, unsigned int options) attribute_warn_unused_result;
474
475 /*! @} */
476
477 /*! \brief
478  * Reference/unreference an object and return the old refcount.
479  *
480  * \param o A pointer to the object
481  * \param delta Value to add to the reference counter.
482  * \param tag used for debugging
483  * \return The value of the reference counter before the operation.
484  *
485  * Increase/decrease the reference counter according
486  * the value of delta.
487  *
488  * If the refcount goes to zero, the object is destroyed.
489  *
490  * \note The object must not be locked by the caller of this function, as
491  *       it is invalid to try to unlock it after releasing the reference.
492  *
493  * \note if we know the pointer to an object, it is because we
494  * have a reference count to it, so the only case when the object
495  * can go away is when we release our reference, and it is
496  * the last one in existence.
497  *
498  * @{
499  */
500
501 #ifdef REF_DEBUG
502
503 #define ao2_t_ref(o,delta,tag) __ao2_ref_debug((o), (delta), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
504 #define ao2_ref(o,delta)       __ao2_ref_debug((o), (delta), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
505
506 #else
507
508 #define ao2_t_ref(o,delta,tag) __ao2_ref((o), (delta))
509 #define ao2_ref(o,delta)       __ao2_ref((o), (delta))
510
511 #endif
512
513 /*!
514  * \since 12
515  * \brief Bump refcount on an AO2 object by one, returning the object.
516  *
517  * This is useful for inlining a ref bump, and you don't care about the ref
518  * count. Also \c NULL safe, for even more convenience.
519  *
520  * \param obj AO2 object to bump the refcount on.
521  * \retval The given \a obj pointer.
522  */
523 #define ao2_bump(obj)                                           \
524         ({                                                      \
525                 typeof(obj) __obj_ ## __LINE__ = (obj);         \
526                 if (__obj_ ## __LINE__) {                       \
527                         ao2_ref(__obj_ ## __LINE__, +1);        \
528                 }                                               \
529                 __obj_ ## __LINE__;                             \
530         })
531
532 int __ao2_ref_debug(void *o, int delta, const char *tag, const char *file, int line, const char *func);
533 int __ao2_ref(void *o, int delta);
534
535 /*! @} */
536
537 /*! \brief Which lock to request. */
538 enum ao2_lock_req {
539         /*! Request the mutex lock be acquired. */
540         AO2_LOCK_REQ_MUTEX,
541         /*! Request the read lock be acquired. */
542         AO2_LOCK_REQ_RDLOCK,
543         /*! Request the write lock be acquired. */
544         AO2_LOCK_REQ_WRLOCK,
545 };
546
547 /*! \brief
548  * Lock an object.
549  *
550  * \param a A pointer to the object we want to lock.
551  * \param lock_how, file, func, line, var
552  * \return 0 on success, other values on error.
553  */
554 int __ao2_lock(void *a, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var);
555 #define ao2_lock(a) __ao2_lock(a, AO2_LOCK_REQ_MUTEX, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
556 #define ao2_rdlock(a) __ao2_lock(a, AO2_LOCK_REQ_RDLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
557 #define ao2_wrlock(a) __ao2_lock(a, AO2_LOCK_REQ_WRLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
558
559 /*! \brief
560  * Unlock an object.
561  *
562  * \param a A pointer to the object we want unlock.
563  * \param file, func, line, var
564  * \return 0 on success, other values on error.
565  */
566 int __ao2_unlock(void *a, const char *file, const char *func, int line, const char *var);
567 #define ao2_unlock(a) __ao2_unlock(a, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
568
569 /*! \brief
570  * Try locking-- (don't block if fail)
571  *
572  * \param a A pointer to the object we want to lock.
573  * \param lock_how, file, func, line, var
574  * \return 0 on success, other values on error.
575  */
576 int __ao2_trylock(void *a, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var);
577 #define ao2_trylock(a) __ao2_trylock(a, AO2_LOCK_REQ_MUTEX, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
578 #define ao2_tryrdlock(a) __ao2_trylock(a, AO2_LOCK_REQ_RDLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
579 #define ao2_trywrlock(a) __ao2_trylock(a, AO2_LOCK_REQ_WRLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
580
581 /*!
582  * \brief Return the mutex lock address of an object
583  *
584  * \param[in] obj A pointer to the object we want.
585  * \return the address of the mutex lock, else NULL.
586  *
587  * This function comes in handy mainly for debugging locking
588  * situations, where the locking trace code reports the
589  * lock address, this allows you to correlate against
590  * object address, to match objects to reported locks.
591  *
592  * \since 1.6.1
593  */
594 void *ao2_object_get_lockaddr(void *obj);
595
596
597 /*! Global ao2 object holder structure. */
598 struct ao2_global_obj {
599         /*! Access lock to the held ao2 object. */
600         ast_rwlock_t lock;
601         /*! Global ao2 object. */
602         void *obj;
603 };
604
605 /*!
606  * \brief Define a global object holder to be used to hold an ao2 object, statically initialized.
607  * \since 11.0
608  *
609  * \param name This will be the name of the object holder.
610  *
611  * \details
612  * This macro creates a global object holder that can be used to
613  * hold an ao2 object accessible using the API.  The structure is
614  * allocated and initialized to be empty.
615  *
616  * Example usage:
617  * \code
618  * static AO2_GLOBAL_OBJ_STATIC(global_cfg);
619  * \endcode
620  *
621  * This defines global_cfg, intended to hold an ao2 object
622  * accessible using an API.
623  */
624 #ifndef HAVE_PTHREAD_RWLOCK_INITIALIZER
625 #define AO2_GLOBAL_OBJ_STATIC(name)                                                                             \
626         struct ao2_global_obj name;                                                                                     \
627         static void  __attribute__((constructor)) __init_##name(void)           \
628         {                                                                                                                                       \
629                 ast_rwlock_init(&name.lock);                                                                    \
630                 name.obj = NULL;                                                                                                \
631         }                                                                                                                                       \
632         static void  __attribute__((destructor)) __fini_##name(void)            \
633         {                                                                                                                                       \
634                 if (name.obj) {                                                                                                 \
635                         ao2_ref(name.obj, -1);                                                                          \
636                         name.obj = NULL;                                                                                        \
637                 }                                                                                                                               \
638                 ast_rwlock_destroy(&name.lock);                                                                 \
639         }                                                                                                                                       \
640         struct __dummy_##name
641 #else
642 #define AO2_GLOBAL_OBJ_STATIC(name)                                                                             \
643         struct ao2_global_obj name = {                                                                          \
644                 .lock = AST_RWLOCK_INIT_VALUE,                                                                  \
645         }
646 #endif
647
648 /*!
649  * \brief Release the ao2 object held in the global holder.
650  * \since 11.0
651  *
652  * \param holder Global ao2 object holder.
653  * \param tag used for debugging
654  *
655  * \return Nothing
656  */
657 #ifdef REF_DEBUG
658 #define ao2_t_global_obj_release(holder, tag)   \
659         __ao2_global_obj_release(&holder, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
660 #define ao2_global_obj_release(holder)  \
661         __ao2_global_obj_release(&holder, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
662
663 #else
664
665 #define ao2_t_global_obj_release(holder, tag)   \
666         __ao2_global_obj_release(&holder, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
667 #define ao2_global_obj_release(holder)  \
668         __ao2_global_obj_release(&holder, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
669 #endif
670
671 void __ao2_global_obj_release(struct ao2_global_obj *holder, const char *tag, const char *file, int line, const char *func, const char *name);
672
673 /*!
674  * \brief Replace an ao2 object in the global holder.
675  * \since 11.0
676  *
677  * \param holder Global ao2 object holder.
678  * \param obj Object to put into the holder.  Can be NULL.
679  * \param tag used for debugging
680  *
681  * \note This function automatically increases the reference
682  * count to account for the reference that the global holder now
683  * holds to the object.
684  *
685  * \retval Reference to previous global ao2 object stored.
686  * \retval NULL if no object available.
687  */
688 #ifdef REF_DEBUG
689 #define ao2_t_global_obj_replace(holder, obj, tag)      \
690         __ao2_global_obj_replace(&holder, (obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
691 #define ao2_global_obj_replace(holder, obj)     \
692         __ao2_global_obj_replace(&holder, (obj), "", __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
693
694 #else
695
696 #define ao2_t_global_obj_replace(holder, obj, tag)      \
697         __ao2_global_obj_replace(&holder, (obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
698 #define ao2_global_obj_replace(holder, obj)     \
699         __ao2_global_obj_replace(&holder, (obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
700 #endif
701
702 void *__ao2_global_obj_replace(struct ao2_global_obj *holder, void *obj, const char *tag, const char *file, int line, const char *func, const char *name) attribute_warn_unused_result;
703
704 /*!
705  * \brief Replace an ao2 object in the global holder, throwing away any old object.
706  * \since 11.0
707  *
708  * \param holder Global ao2 object holder.
709  * \param obj Object to put into the holder.  Can be NULL.
710  * \param tag used for debugging
711  *
712  * \note This function automatically increases the reference
713  * count to account for the reference that the global holder now
714  * holds to the object.  It also decreases the reference count
715  * of any object being replaced.
716  *
717  * \retval 0 The global object was previously empty
718  * \retval 1 The global object was not previously empty
719  */
720 #ifdef REF_DEBUG
721 #define ao2_t_global_obj_replace_unref(holder, obj, tag)        \
722         __ao2_global_obj_replace_unref(&holder, (obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
723 #define ao2_global_obj_replace_unref(holder, obj)       \
724         __ao2_global_obj_replace_unref(&holder, (obj), "", __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
725
726 #else
727
728 #define ao2_t_global_obj_replace_unref(holder, obj, tag)        \
729         __ao2_global_obj_replace_unref(&holder, (obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
730 #define ao2_global_obj_replace_unref(holder, obj)       \
731         __ao2_global_obj_replace_unref(&holder, (obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
732 #endif
733
734 int __ao2_global_obj_replace_unref(struct ao2_global_obj *holder, void *obj, const char *tag, const char *file, int line, const char *func, const char *name);
735
736 /*!
737  * \brief Get a reference to the object stored in the global holder.
738  * \since 11.0
739  *
740  * \param holder Global ao2 object holder.
741  * \param tag used for debugging
742  *
743  * \retval Reference to current ao2 object stored in the holder.
744  * \retval NULL if no object available.
745  */
746 #ifdef REF_DEBUG
747 #define ao2_t_global_obj_ref(holder, tag)       \
748         __ao2_global_obj_ref(&holder, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
749 #define ao2_global_obj_ref(holder)      \
750         __ao2_global_obj_ref(&holder, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
751
752 #else
753
754 #define ao2_t_global_obj_ref(holder, tag)       \
755         __ao2_global_obj_ref(&holder, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
756 #define ao2_global_obj_ref(holder)      \
757         __ao2_global_obj_ref(&holder, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
758 #endif
759
760 void *__ao2_global_obj_ref(struct ao2_global_obj *holder, const char *tag, const char *file, int line, const char *func, const char *name) attribute_warn_unused_result;
761
762
763 /*!
764  \page AstObj2_Containers AstObj2 Containers
765
766 Containers are data structures meant to store several objects,
767 and perform various operations on them.
768 Internally, objects are stored in lists, hash tables or other
769 data structures depending on the needs.
770
771 \note NOTA BENE: at the moment the only container we support is the
772     hash table and its degenerate form, the list.
773
774 Operations on container include:
775
776   -  c = \b ao2_container_alloc(size, hash_fn, cmp_fn)
777     allocate a container with desired size and default compare
778     and hash function
779          -The compare function returns an int, which
780          can be 0 for not found, CMP_STOP to stop end a traversal,
781          or CMP_MATCH if they are equal
782          -The hash function returns an int. The hash function
783          takes two argument, the object pointer and a flags field,
784
785   -  \b ao2_find(c, arg, flags)
786     returns zero or more elements matching a given criteria
787     (specified as arg). 'c' is the container pointer. Flags
788     can be:
789     OBJ_UNLINK - to remove the object, once found, from the container.
790     OBJ_NODATA - don't return the object if found (no ref count change)
791     OBJ_MULTIPLE - don't stop at first match
792     OBJ_SEARCH_OBJECT - if set, 'arg' is an object pointer, and a hash table
793                   search will be done. If not, a traversal is done.
794     OBJ_SEARCH_KEY - if set, 'arg', is a search key item that is not an object.
795               Similar to OBJ_SEARCH_OBJECT and mutually exclusive.
796     OBJ_SEARCH_PARTIAL_KEY - if set, 'arg', is a partial search key item that is not an object.
797               Similar to OBJ_SEARCH_KEY and mutually exclusive.
798
799   -  \b ao2_callback(c, flags, fn, arg)
800     apply fn(obj, arg) to all objects in the container.
801     Similar to find. fn() can tell when to stop, and
802     do anything with the object including unlinking it.
803       - c is the container;
804       - flags can be
805          OBJ_UNLINK   - to remove the object, once found, from the container.
806          OBJ_NODATA   - don't return the object if found (no ref count change)
807          OBJ_MULTIPLE - don't stop at first match
808          OBJ_SEARCH_OBJECT - if set, 'arg' is an object pointer, and a hash table
809                         search will be done. If not, a traversal is done through
810                         all the hash table 'buckets'..
811          OBJ_SEARCH_KEY - if set, 'arg', is a search key item that is not an object.
812                         Similar to OBJ_SEARCH_OBJECT and mutually exclusive.
813          OBJ_SEARCH_PARTIAL_KEY - if set, 'arg', is a partial search key item that is not an object.
814                         Similar to OBJ_SEARCH_KEY and mutually exclusive.
815       - fn is a func that returns int, and takes 3 args:
816         (void *obj, void *arg, int flags);
817           obj is an object
818           arg is the same as arg passed into ao2_callback
819           flags is the same as flags passed into ao2_callback
820          fn returns:
821            0: no match, keep going
822            CMP_STOP: stop search, no match
823            CMP_MATCH: This object is matched.
824
825     Note that the entire operation is run with the container
826     locked, so nobody else can change its content while we work on it.
827     However, we pay this with the fact that doing
828     anything blocking in the callback keeps the container
829     blocked.
830     The mechanism is very flexible because the callback function fn()
831     can do basically anything e.g. counting, deleting records, etc.
832     possibly using arg to store the results.
833
834   -  \b iterate on a container
835     this is done with the following sequence
836
837 \code
838
839         struct ao2_container *c = ... // our container
840         struct ao2_iterator i;
841         void *o;
842
843         i = ao2_iterator_init(c, flags);
844
845         while ((o = ao2_iterator_next(&i))) {
846             ... do something on o ...
847             ao2_ref(o, -1);
848         }
849
850         ao2_iterator_destroy(&i);
851 \endcode
852
853     The difference with the callback is that the control
854     on how to iterate is left to us.
855
856     - \b ao2_ref(c, -1)
857     dropping a reference to a container destroys it, very simple!
858
859 Containers are ao2 objects themselves, and this is why their
860 implementation is simple too.
861
862 Before declaring containers, we need to declare the types of the
863 arguments passed to the constructor - in turn, this requires
864 to define callback and hash functions and their arguments.
865
866 - \ref AstObj2
867 - \ref astobj2.h
868  */
869
870 /*! \brief
871  * A callback function will return a combination of CMP_MATCH and CMP_STOP.
872  * The latter will terminate the search in a container.
873  */
874 enum _cb_results {
875         CMP_MATCH       = 0x1,  /*!< the object matches the request */
876         CMP_STOP        = 0x2,  /*!< stop the search now */
877 };
878
879 /*!
880  * \brief Flags passed to ao2_callback_fn(), ao2_hash_fn(), and ao2_sort_fn() to modify behaviour.
881  */
882 enum search_flags {
883         /*!
884          * Unlink the object for which the callback function returned
885          * CMP_MATCH.
886          */
887         OBJ_UNLINK = (1 << 0),
888         /*!
889          * On match, don't return the object hence do not increase its
890          * refcount.
891          */
892         OBJ_NODATA = (1 << 1),
893         /*!
894          * Don't stop at the first match in ao2_callback() unless the
895          * result of of the callback function has the CMP_STOP bit set.
896          */
897         OBJ_MULTIPLE = (1 << 2),
898         /*!
899          * \brief Assume that the ao2_container is already locked.
900          *
901          * \note For ao2_containers that have mutexes, no locking will
902          * be done.
903          *
904          * \note For ao2_containers that have RWLOCKs, the lock will be
905          * promoted to write mode as needed.  The lock will be returned
906          * to the original locked state.
907          *
908          * \note Only use this flag if the ao2_container is manually
909          * locked already.
910          */
911         OBJ_NOLOCK = (1 << 4),
912
913         /*!
914          * \brief Search option field mask.
915          *
916          * \todo Eventually OBJ_SEARCH_MASK will shrink to a two bit
917          * field when the codebase is made to use the search field
918          * values as a field instead of independent bits.
919          */
920         OBJ_SEARCH_MASK = (0x07 << 5),
921         /*! \brief The arg parameter has no meaning to the astobj2 code. */
922         OBJ_SEARCH_NONE = (0 << 5),
923         /*!
924          * \brief The arg parameter is an object of the same type.
925          *
926          * \details
927          * The arg parameter is an object of the same type as the one
928          * being searched for, so use the object's ao2_hash_fn and/or
929          * ao2_sort_fn functions for optimized searching.
930          *
931          * \note The supplied ao2_callback_fn is called after the
932          * container nodes have been filtered by the ao2_hash_fn and/or
933          * ao2_sort_fn functions.
934          */
935         OBJ_SEARCH_OBJECT = (1 << 5),
936         /*!
937          * \brief The arg parameter is a search key, but is not an object.
938          *
939          * \details
940          * This can be used when you want to be able to pass custom data
941          * to the container's stored ao2_hash_fn, ao2_sort_fn, and
942          * ao2_find ao2_callback_fn functions that is not a full object,
943          * but perhaps just a string.
944          *
945          * \note The supplied ao2_callback_fn is called after the
946          * container nodes have been filtered by the ao2_hash_fn and/or
947          * ao2_sort_fn functions.
948          */
949         OBJ_SEARCH_KEY = (2 << 5),
950         /*!
951          * \brief The arg parameter is a partial search key similar to OBJ_SEARCH_KEY.
952          *
953          * \details
954          * The partial key can be used by the ao2_sort_fn to guide the
955          * search to find a contiguous subset of a sorted container.
956          * For example, a sorted container holds: "A", "B", "Bert",
957          * "Beth", "Earnie".  Doing a partial key search with "B" will
958          * find the sorted subset of all held objects starting with "B".
959          *
960          * \note The supplied ao2_callback_fn is called after the
961          * container nodes have been filtered by the ao2_sort_fn
962          * function.
963          */
964         OBJ_SEARCH_PARTIAL_KEY = (4 << 5),
965
966         /*! \brief Traverse order option field mask. */
967         OBJ_ORDER_MASK = (0x03 << 8),
968         /*! \brief Traverse in ascending order (First to last container object) */
969         OBJ_ORDER_ASCENDING = (0 << 8),
970         /*! \brief Traverse in descending order (Last to first container object) */
971         OBJ_ORDER_DESCENDING = (1 << 8),
972         /*!
973          * \brief Traverse in pre-order (Node then children, for tree container)
974          *
975          * \note For non-tree containers, it is up to the container type
976          * to make the best interpretation of the order.  For list and
977          * hash containers, this also means ascending order because a
978          * binary tree can degenerate into a list.
979          */
980         OBJ_ORDER_PRE = (2 << 8),
981         /*!
982          * \brief Traverse in post-order (Children then node, for tree container)
983          *
984          * \note For non-tree containers, it is up to the container type
985          * to make the best interpretation of the order.  For list and
986          * hash containers, this also means descending order because a
987          * binary tree can degenerate into a list.
988          */
989         OBJ_ORDER_POST = (3 << 8),
990 };
991
992 /*
993  * Deprecated backward compatible flag names.
994  *
995  * Note: OBJ_POINTER, OBJ_KEY, and OBJ_PARTIAL_KEY are mutually
996  * exclusive.
997  */
998 #define OBJ_POINTER             OBJ_SEARCH_OBJECT               /*!< Deprecated name */
999 #define OBJ_KEY                 OBJ_SEARCH_KEY                  /*!< Deprecated name */
1000 #define OBJ_PARTIAL_KEY OBJ_SEARCH_PARTIAL_KEY  /*!< Deprecated name */
1001
1002 /*!
1003  * \brief Options available when allocating an ao2 container object.
1004  *
1005  * \note Each option is open to some interpretation by the
1006  * container type as long as it makes sense with the option
1007  * name.
1008  */
1009 enum ao2_container_opts {
1010         /*!
1011          * \brief Insert objects at the beginning of the container.
1012          * (Otherwise it is the opposite; insert at the end.)
1013          *
1014          * \note If an ao2_sort_fn is provided, the object is inserted
1015          * before any objects with duplicate keys.
1016          *
1017          * \note Hash containers insert the object in the computed hash
1018          * bucket in the indicated manner.
1019          */
1020         AO2_CONTAINER_ALLOC_OPT_INSERT_BEGIN = (1 << 0),
1021
1022         /*!
1023          * \brief The ao2 container objects with duplicate keys option field mask.
1024          */
1025         AO2_CONTAINER_ALLOC_OPT_DUPS_MASK = (3 << 1),
1026         /*!
1027          * \brief Allow objects with duplicate keys in container.
1028          */
1029         AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW = (0 << 1),
1030         /*!
1031          * \brief Reject objects with duplicate keys in container.
1032          *
1033          * \note The container must be sorted.  i.e. have an
1034          * ao2_sort_fn.
1035          */
1036         AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT = (1 << 1),
1037         /*!
1038          * \brief Reject duplicate objects in container.
1039          *
1040          * \details Don't link the same object into the container twice.
1041          * However, you can link a different object with the same key.
1042          *
1043          * \note The container must be sorted.  i.e. have an
1044          * ao2_sort_fn.
1045          *
1046          * \note It is assumed that the objects are located where the
1047          * search key says they should be located.
1048          */
1049         AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT = (2 << 1),
1050         /*!
1051          * \brief Replace objects with duplicate keys in container.
1052          *
1053          * \details The existing duplicate object is removed and the new
1054          * object takes the old object's place.
1055          *
1056          * \note The container must be sorted.  i.e. have an
1057          * ao2_sort_fn.
1058          */
1059         AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE = (3 << 1),
1060 };
1061
1062 /*!
1063  * \brief Type of a generic callback function
1064  * \param obj  pointer to the (user-defined part) of an object.
1065  * \param arg callback argument from ao2_callback()
1066  * \param flags flags from ao2_callback()
1067  *   OBJ_SEARCH_OBJECT - if set, 'arg', is an object.
1068  *   OBJ_SEARCH_KEY - if set, 'arg', is a search key item that is not an object.
1069  *   OBJ_SEARCH_PARTIAL_KEY - if set, 'arg', is a partial search key item that is not an object.
1070  *
1071  * The return values are a combination of enum _cb_results.
1072  * Callback functions are used to search or manipulate objects in a container.
1073  */
1074 typedef int (ao2_callback_fn)(void *obj, void *arg, int flags);
1075
1076 /*! \brief A common ao2_callback is one that matches by address. */
1077 int ao2_match_by_addr(void *obj, void *arg, int flags);
1078
1079 /*!
1080  * \brief Type of a generic callback function
1081  * \param obj pointer to the (user-defined part) of an object.
1082  * \param arg callback argument from ao2_callback()
1083  * \param data arbitrary data from ao2_callback()
1084  * \param flags flags from ao2_callback()
1085  *   OBJ_SEARCH_OBJECT - if set, 'arg', is an object.
1086  *   OBJ_SEARCH_KEY - if set, 'arg', is a search key item that is not an object.
1087  *   OBJ_SEARCH_PARTIAL_KEY - if set, 'arg', is a partial search key item that is not an object.
1088  *
1089  * The return values are a combination of enum _cb_results.
1090  * Callback functions are used to search or manipulate objects in a container.
1091  */
1092 typedef int (ao2_callback_data_fn)(void *obj, void *arg, void *data, int flags);
1093
1094 /*!
1095  * Type of a generic function to generate a hash value from an object.
1096  *
1097  * \param obj pointer to the (user-defined part) of an object.
1098  * \param flags flags from ao2_callback()
1099  *   OBJ_SEARCH_OBJECT - if set, 'obj', is an object.
1100  *   OBJ_SEARCH_KEY - if set, 'obj', is a search key item that is not an object.
1101  *
1102  * \note This function must be idempotent.
1103  *
1104  * \return Computed hash value.
1105  */
1106 typedef int (ao2_hash_fn)(const void *obj, int flags);
1107
1108 /*!
1109  * \brief Type of generic container sort function.
1110  *
1111  * \param obj_left pointer to the (user-defined part) of an object.
1112  * \param obj_right pointer to the (user-defined part) of an object.
1113  * \param flags flags from ao2_callback()
1114  *   OBJ_SEARCH_OBJECT - if set, 'obj_right', is an object.
1115  *   OBJ_SEARCH_KEY - if set, 'obj_right', is a search key item that is not an object.
1116  *   OBJ_SEARCH_PARTIAL_KEY - if set, 'obj_right', is a partial search key item that is not an object.
1117  *
1118  * \note This function must be idempotent.
1119  *
1120  * \retval <0 if obj_left < obj_right
1121  * \retval =0 if obj_left == obj_right
1122  * \retval >0 if obj_left > obj_right
1123  */
1124 typedef int (ao2_sort_fn)(const void *obj_left, const void *obj_right, int flags);
1125
1126 /*! \name Object Containers
1127  * Here start declarations of containers.
1128  */
1129 /*@{ */
1130 struct ao2_container;
1131
1132 /*!
1133  * \brief Allocate and initialize a hash container with the desired number of buckets.
1134  *
1135  * \details
1136  * We allocate space for a struct astobj_container, struct container
1137  * and the buckets[] array.
1138  *
1139  * \param options Container ao2 object options (See enum ao2_alloc_opts)
1140  * \param n_buckets Number of buckets for hash
1141  * \param hash_fn Pointer to a function computing a hash value. (NULL if everyting goes in first bucket.)
1142  * \param cmp_fn Pointer to a compare function used by ao2_find. (NULL to match everything)
1143  * \param tag used for debugging.
1144  *
1145  * \return A pointer to a struct container.
1146  *
1147  * \note Destructor is set implicitly.
1148  * \note This is legacy container creation that is mapped to the new method.
1149  */
1150
1151 #define ao2_t_container_alloc_options(options, n_buckets, hash_fn, cmp_fn, tag) \
1152         ao2_t_container_alloc_hash((options), 0, (n_buckets), (hash_fn), NULL, (cmp_fn), (tag))
1153 #define ao2_container_alloc_options(options, n_buckets, hash_fn, cmp_fn) \
1154         ao2_container_alloc_hash((options), 0, (n_buckets), (hash_fn), NULL, (cmp_fn))
1155
1156 #define ao2_t_container_alloc(n_buckets, hash_fn, cmp_fn, tag) \
1157         ao2_t_container_alloc_options(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), (tag))
1158 #define ao2_container_alloc(n_buckets, hash_fn, cmp_fn) \
1159         ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn))
1160
1161 /*!
1162  * \brief Allocate and initialize a hash container with the desired number of buckets.
1163  *
1164  * \details
1165  * We allocate space for a struct astobj_container, struct container
1166  * and the buckets[] array.
1167  *
1168  * \param ao2_options Container ao2 object options (See enum ao2_alloc_opts)
1169  * \param container_options Container behaviour options (See enum ao2_container_opts)
1170  * \param n_buckets Number of buckets for hash
1171  * \param hash_fn Pointer to a function computing a hash value. (NULL if everyting goes in first bucket.)
1172  * \param sort_fn Pointer to a sort function. (NULL to not sort the buckets.)
1173  * \param cmp_fn Pointer to a compare function used by ao2_find. (NULL to match everything)
1174  * \param tag used for debugging.
1175  *
1176  * \return A pointer to a struct container.
1177  *
1178  * \note Destructor is set implicitly.
1179  */
1180
1181 #if defined(REF_DEBUG)
1182
1183 #define ao2_t_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn, tag) \
1184         __ao2_container_alloc_hash_debug((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1185 #define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn) \
1186         __ao2_container_alloc_hash_debug((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1187
1188 #elif defined(__AST_DEBUG_MALLOC)
1189
1190 #define ao2_t_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn, tag) \
1191         __ao2_container_alloc_hash_debug((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1192 #define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn) \
1193         __ao2_container_alloc_hash_debug((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1194
1195 #else
1196
1197 #define ao2_t_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn, tag) \
1198         __ao2_container_alloc_hash((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn))
1199 #define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn) \
1200         __ao2_container_alloc_hash((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn))
1201
1202 #endif
1203
1204 struct ao2_container *__ao2_container_alloc_hash(unsigned int ao2_options,
1205         unsigned int container_options, unsigned int n_buckets, ao2_hash_fn *hash_fn,
1206         ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn) attribute_warn_unused_result;
1207 struct ao2_container *__ao2_container_alloc_hash_debug(unsigned int ao2_options,
1208         unsigned int container_options, unsigned int n_buckets, ao2_hash_fn *hash_fn,
1209         ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn,
1210         const char *tag, const char *file, int line, const char *func, int ref_debug) attribute_warn_unused_result;
1211
1212 /*!
1213  * \brief Allocate and initialize a list container.
1214  *
1215  * \param ao2_options Container ao2 object options (See enum ao2_alloc_opts)
1216  * \param container_options Container behaviour options (See enum ao2_container_opts)
1217  * \param sort_fn Pointer to a sort function. (NULL if list not sorted.)
1218  * \param cmp_fn Pointer to a compare function used by ao2_find. (NULL to match everything)
1219  * \param tag used for debugging.
1220  *
1221  * \return A pointer to a struct container.
1222  *
1223  * \note Destructor is set implicitly.
1224  * \note Implemented as a degenerate hash table.
1225  */
1226
1227 #if defined(REF_DEBUG)
1228
1229 #define ao2_t_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn, tag) \
1230         __ao2_container_alloc_list_debug((ao2_options), (container_options), (sort_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1231 #define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn) \
1232         __ao2_container_alloc_list_debug((ao2_options), (container_options), (sort_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1233
1234 #elif defined(__AST_DEBUG_MALLOC)
1235
1236 #define ao2_t_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn, tag) \
1237         __ao2_container_alloc_list_debug((ao2_options), (container_options), (sort_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1238 #define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn) \
1239         __ao2_container_alloc_list_debug((ao2_options), (container_options), (sort_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1240
1241 #else
1242
1243 #define ao2_t_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn, tag) \
1244         __ao2_container_alloc_list((ao2_options), (container_options), (sort_fn), (cmp_fn))
1245 #define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn) \
1246         __ao2_container_alloc_list((ao2_options), (container_options), (sort_fn), (cmp_fn))
1247
1248 #endif
1249
1250 struct ao2_container *__ao2_container_alloc_list(unsigned int ao2_options,
1251         unsigned int container_options, ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn) attribute_warn_unused_result;
1252 struct ao2_container *__ao2_container_alloc_list_debug(unsigned int ao2_options,
1253         unsigned int container_options, ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn,
1254         const char *tag, const char *file, int line, const char *func, int ref_debug) attribute_warn_unused_result;
1255
1256 /*!
1257  * \brief Allocate and initialize a red-black tree container.
1258  *
1259  * \param ao2_options Container ao2 object options (See enum ao2_alloc_opts)
1260  * \param container_options Container behaviour options (See enum ao2_container_opts)
1261  * \param sort_fn Pointer to a sort function.
1262  * \param cmp_fn Pointer to a compare function used by ao2_find. (NULL to match everything)
1263  * \param tag used for debugging.
1264  *
1265  * \return A pointer to a struct container.
1266  *
1267  * \note Destructor is set implicitly.
1268  */
1269
1270 #if defined(REF_DEBUG)
1271
1272 #define ao2_t_container_alloc_rbtree(ao2_options, container_options, sort_fn, cmp_fn, tag) \
1273         __ao2_container_alloc_rbtree_debug((ao2_options), (container_options), (sort_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1274 #define ao2_container_alloc_rbtree(ao2_options, container_options, sort_fn, cmp_fn) \
1275         __ao2_container_alloc_rbtree_debug((ao2_options), (container_options), (sort_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1276
1277 #elif defined(__AST_DEBUG_MALLOC)
1278
1279 #define ao2_t_container_alloc_rbtree(ao2_options, container_options, sort_fn, cmp_fn, tag) \
1280         __ao2_container_alloc_rbtree_debug((ao2_options), (container_options), (sort_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1281 #define ao2_container_alloc_rbtree(ao2_options, container_options, sort_fn, cmp_fn) \
1282         __ao2_container_alloc_rbtree_debug((ao2_options), (container_options), (sort_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1283
1284 #else
1285
1286 #define ao2_t_container_alloc_rbtree(ao2_options, container_options, sort_fn, cmp_fn, tag) \
1287         __ao2_container_alloc_rbtree((ao2_options), (container_options), (sort_fn), (cmp_fn))
1288 #define ao2_container_alloc_rbtree(ao2_options, container_options, sort_fn, cmp_fn) \
1289         __ao2_container_alloc_rbtree((ao2_options), (container_options), (sort_fn), (cmp_fn))
1290
1291 #endif
1292
1293 struct ao2_container *__ao2_container_alloc_rbtree(unsigned int ao2_options, unsigned int container_options,
1294         ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn) attribute_warn_unused_result;
1295 struct ao2_container *__ao2_container_alloc_rbtree_debug(unsigned int ao2_options, unsigned int container_options,
1296         ao2_sort_fn *sort_fn, ao2_callback_fn *cmp_fn,
1297         const char *tag, const char *file, int line, const char *func, int ref_debug) attribute_warn_unused_result;
1298
1299 /*! \brief
1300  * Returns the number of elements in a container.
1301  */
1302 int ao2_container_count(struct ao2_container *c);
1303
1304 /*!
1305  * \brief Copy all object references in the src container into the dest container.
1306  * \since 11.0
1307  *
1308  * \param dest Container to copy src object references into.
1309  * \param src Container to copy all object references from.
1310  * \param flags OBJ_NOLOCK if a lock is already held on both containers.
1311  *    Otherwise, the src container is locked first.
1312  *
1313  * \pre The dest container must be empty.  If the duplication fails, the
1314  * dest container will be returned empty.
1315  *
1316  * \note This can potentially be expensive because a malloc is
1317  * needed for every object in the src container.
1318  *
1319  * \retval 0 on success.
1320  * \retval -1 on error.
1321  */
1322 int ao2_container_dup(struct ao2_container *dest, struct ao2_container *src, enum search_flags flags);
1323
1324 /*!
1325  * \brief Create a clone/copy of the given container.
1326  * \since 11.0
1327  *
1328  * \param orig Container to copy all object references from.
1329  * \param flags OBJ_NOLOCK if a lock is already held on the container.
1330  *
1331  * \note This can potentially be expensive because a malloc is
1332  * needed for every object in the orig container.
1333  *
1334  * \retval Clone container on success.
1335  * \retval NULL on error.
1336  */
1337 struct ao2_container *__ao2_container_clone(struct ao2_container *orig, enum search_flags flags) attribute_warn_unused_result;
1338 struct ao2_container *__ao2_container_clone_debug(struct ao2_container *orig, enum search_flags flags, const char *tag, const char *file, int line, const char *func, int ref_debug) attribute_warn_unused_result;
1339 #if defined(REF_DEBUG)
1340
1341 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone_debug(orig, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1342 #define ao2_container_clone(orig, flags)                __ao2_container_clone_debug(orig, flags, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1343
1344 #elif defined(__AST_DEBUG_MALLOC)
1345
1346 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone_debug(orig, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1347 #define ao2_container_clone(orig, flags)                __ao2_container_clone_debug(orig, flags, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1348
1349 #else
1350
1351 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone(orig, flags)
1352 #define ao2_container_clone(orig, flags)                __ao2_container_clone(orig, flags)
1353
1354 #endif
1355
1356 /*!
1357  * \brief Print output.
1358  * \since 12.0.0
1359  *
1360  * \param where User data pointer needed to determine where to put output.
1361  * \param fmt printf type format string.
1362  *
1363  * \return Nothing
1364  */
1365 typedef void (ao2_prnt_fn)(void *where, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
1366
1367 /*!
1368  * \brief Print object key.
1369  * \since 12.0.0
1370  *
1371  * \param v_obj A pointer to the object we want the key printed.
1372  * \param where User data needed by prnt to determine where to put output.
1373  * \param prnt Print output callback function to use.
1374  *
1375  * \return Nothing
1376  */
1377 typedef void (ao2_prnt_obj_fn)(void *v_obj, void *where, ao2_prnt_fn *prnt);
1378
1379 /*!
1380  * \brief Display contents of the specified container.
1381  * \since 12.0.0
1382  *
1383  * \param self Container to dump.
1384  * \param flags OBJ_NOLOCK if a lock is already held on the container.
1385  * \param name Container name.  (NULL if anonymous)
1386  * \param where User data needed by prnt to determine where to put output.
1387  * \param prnt Print output callback function to use.
1388  * \param prnt_obj Callback function to print the given object's key. (NULL if not available)
1389  *
1390  * \return Nothing
1391  */
1392 void ao2_container_dump(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt, ao2_prnt_obj_fn *prnt_obj);
1393
1394 /*!
1395  * \brief Display statistics of the specified container.
1396  * \since 12.0.0
1397  *
1398  * \param self Container to display statistics.
1399  * \param flags OBJ_NOLOCK if a lock is already held on the container.
1400  * \param name Container name.  (NULL if anonymous)
1401  * \param where User data needed by prnt to determine where to put output.
1402  * \param prnt Print output callback function to use.
1403  *
1404  * \return Nothing
1405  */
1406 void ao2_container_stats(struct ao2_container *self, enum search_flags flags, const char *name, void *where, ao2_prnt_fn *prnt);
1407
1408 /*!
1409  * \brief Perform an integrity check on the specified container.
1410  * \since 12.0.0
1411  *
1412  * \param self Container to check integrity.
1413  * \param flags OBJ_NOLOCK if a lock is already held on the container.
1414  *
1415  * \retval 0 on success.
1416  * \retval -1 on error.
1417  */
1418 int ao2_container_check(struct ao2_container *self, enum search_flags flags);
1419
1420 /*!
1421  * \brief Register a container for CLI stats and integrity check.
1422  * \since 12.0.0
1423  *
1424  * \param name Name to register the container under.
1425  * \param self Container to register.
1426  * \param prnt_obj Callback function to print the given object's key. (NULL if not available)
1427  *
1428  * \retval 0 on success.
1429  * \retval -1 on error.
1430  */
1431 int ao2_container_register(const char *name, struct ao2_container *self, ao2_prnt_obj_fn *prnt_obj);
1432
1433 /*!
1434  * \brief Unregister a container for CLI stats and integrity check.
1435  * \since 12.0.0
1436  *
1437  * \param name Name the container is registered under.
1438  *
1439  * \return Nothing
1440  */
1441 void ao2_container_unregister(const char *name);
1442
1443 /*@} */
1444
1445 /*! \name Object Management
1446  * Here we have functions to manage objects.
1447  *
1448  * We can use the functions below on any kind of
1449  * object defined by the user.
1450  */
1451 /*@{ */
1452
1453 /*!
1454  * \brief Add an object to a container.
1455  *
1456  * \param container The container to operate on.
1457  * \param obj The object to be added.
1458  * \param tag used for debugging.
1459  *
1460  * \retval 0 on errors.
1461  * \retval 1 on success.
1462  *
1463  * This function inserts an object in a container according its key.
1464  *
1465  * \note Remember to set the key before calling this function.
1466  *
1467  * \note This function automatically increases the reference count to account
1468  *       for the reference that the container now holds to the object.
1469  */
1470 #ifdef REF_DEBUG
1471
1472 #define ao2_t_link(container, obj, tag)                                 __ao2_link_debug((container), (obj), 0, (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1473 #define ao2_link(container, obj)                                                __ao2_link_debug((container), (obj), 0, "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1474
1475 /*!
1476  * \brief Add an object to a container.
1477  *
1478  * \param container The container to operate on.
1479  * \param obj The object to be added.
1480  * \param flags search_flags to control linking the object.  (OBJ_NOLOCK)
1481  * \param tag used for debugging.
1482  *
1483  * \retval 0 on errors.
1484  * \retval 1 on success.
1485  *
1486  * This function inserts an object in a container according its key.
1487  *
1488  * \note Remember to set the key before calling this function.
1489  *
1490  * \note This function automatically increases the reference count to account
1491  *       for the reference that the container now holds to the object.
1492  */
1493 #define ao2_t_link_flags(container, obj, flags, tag)    __ao2_link_debug((container), (obj), (flags), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1494 #define ao2_link_flags(container, obj, flags)                   __ao2_link_debug((container), (obj), (flags), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1495
1496 #else
1497
1498 #define ao2_t_link(container, obj, tag)                                 __ao2_link((container), (obj), 0)
1499 #define ao2_link(container, obj)                                                __ao2_link((container), (obj), 0)
1500
1501 #define ao2_t_link_flags(container, obj, flags, tag)    __ao2_link((container), (obj), (flags))
1502 #define ao2_link_flags(container, obj, flags)                   __ao2_link((container), (obj), (flags))
1503
1504 #endif
1505
1506 int __ao2_link_debug(struct ao2_container *c, void *obj_new, int flags, const char *tag, const char *file, int line, const char *func);
1507 int __ao2_link(struct ao2_container *c, void *obj_new, int flags);
1508
1509 /*!
1510  * \brief Remove an object from a container
1511  *
1512  * \param container The container to operate on.
1513  * \param obj The object to unlink.
1514  * \param tag used for debugging.
1515  *
1516  * \retval NULL, always
1517  *
1518  * \note The object requested to be unlinked must be valid.  However, if it turns
1519  *       out that it is not in the container, this function is still safe to
1520  *       be called.
1521  *
1522  * \note If the object gets unlinked from the container, the container's
1523  *       reference to the object will be automatically released. (The
1524  *       refcount will be decremented).
1525  */
1526 #ifdef REF_DEBUG
1527
1528 #define ao2_t_unlink(container, obj, tag)                               __ao2_unlink_debug((container), (obj), 0, (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1529 #define ao2_unlink(container, obj)                                              __ao2_unlink_debug((container), (obj), 0, "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1530
1531 /*!
1532  * \brief Remove an object from a container
1533  *
1534  * \param container The container to operate on.
1535  * \param obj The object to unlink.
1536  * \param flags search_flags to control unlinking the object.  (OBJ_NOLOCK)
1537  * \param tag used for debugging.
1538  *
1539  * \retval NULL, always
1540  *
1541  * \note The object requested to be unlinked must be valid.  However, if it turns
1542  *       out that it is not in the container, this function is still safe to
1543  *       be called.
1544  *
1545  * \note If the object gets unlinked from the container, the container's
1546  *       reference to the object will be automatically released. (The
1547  *       refcount will be decremented).
1548  */
1549
1550 #define ao2_t_unlink_flags(container, obj, flags, tag)  __ao2_unlink_debug((container), (obj), (flags), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1551 #define ao2_unlink_flags(container, obj, flags)                 __ao2_unlink_debug((container), (obj), (flags), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1552
1553 #else
1554
1555 #define ao2_t_unlink(container, obj, tag)                               __ao2_unlink((container), (obj), 0)
1556 #define ao2_unlink(container, obj)                                              __ao2_unlink((container), (obj), 0)
1557
1558 #define ao2_t_unlink_flags(container, obj, flags, tag)  __ao2_unlink((container), (obj), (flags))
1559 #define ao2_unlink_flags(container, obj, flags)                 __ao2_unlink((container), (obj), (flags))
1560
1561 #endif
1562
1563 void *__ao2_unlink_debug(struct ao2_container *c, void *obj, int flags, const char *tag, const char *file, int line, const char *func);
1564 void *__ao2_unlink(struct ao2_container *c, void *obj, int flags);
1565
1566
1567 /*@} */
1568
1569 /*! \brief
1570  * ao2_callback() is a generic function that applies cb_fn() to all objects
1571  * in a container, as described below.
1572  *
1573  * \param c A pointer to the container to operate on.
1574  * \param flags A set of flags specifying the operation to perform,
1575  *  partially used by the container code, but also passed to
1576  *  the callback.
1577  *   - If OBJ_NODATA is set, ao2_callback will return NULL. No refcounts
1578  *     of any of the traversed objects will be incremented.
1579  *     On the converse, if it is NOT set (the default), the ref count
1580  *     of the first matching object will be incremented and returned.
1581  *   - If OBJ_MULTIPLE is set, the ref count of all matching objects will
1582  *     be incremented in an iterator for a temporary container and returned.
1583  *   - If OBJ_SEARCH_OBJECT is set, the traversed items will be restricted
1584  *     to the objects in the bucket that the object key hashes to.
1585  *   - If OBJ_SEARCH_KEY is set, the traversed items will be restricted
1586  *     to the objects in the bucket that the object key hashes to.
1587  * \param cb_fn A function pointer, that will be called on all
1588  *  objects, to see if they match. This function returns CMP_MATCH
1589  *  if the object is matches the criteria; CMP_STOP if the traversal
1590  *  should immediately stop, or both (via bitwise ORing), if you find a
1591  *  match and want to end the traversal, and 0 if the object is not a match,
1592  *  but the traversal should continue. This is the function that is applied
1593  *  to each object traversed. Its arguments are:
1594  *      (void *obj, void *arg, int flags), where:
1595  *        obj is an object
1596  *        arg is the same as arg passed into ao2_callback
1597  *        flags is the same as flags passed into ao2_callback (flags are
1598  *         also used by ao2_callback).
1599  * \param arg passed to the callback.
1600  * \param tag used for debugging.
1601  *
1602  * \retval NULL on failure or no matching object found.
1603  *
1604  * \retval object found if OBJ_MULTIPLE is not set in the flags
1605  * parameter.
1606  *
1607  * \retval ao2_iterator pointer if OBJ_MULTIPLE is set in the
1608  * flags parameter.  The iterator must be destroyed with
1609  * ao2_iterator_destroy() when the caller no longer needs it.
1610  *
1611  * If the function returns any objects, their refcount is incremented,
1612  * and the caller is in charge of decrementing them once done.
1613  *
1614  * Typically, ao2_callback() is used for two purposes:
1615  * - to perform some action (including removal from the container) on one
1616  *   or more objects; in this case, cb_fn() can modify the object itself,
1617  *   and to perform deletion should set CMP_MATCH on the matching objects,
1618  *   and have OBJ_UNLINK set in flags.
1619  * - to look for a specific object in a container; in this case, cb_fn()
1620  *   should not modify the object, but just return a combination of
1621  *   CMP_MATCH and CMP_STOP on the desired object.
1622  * Other usages are also possible, of course.
1623  *
1624  * This function searches through a container and performs operations
1625  * on objects according on flags passed.
1626  * XXX describe better
1627  * The comparison is done calling the compare function set implicitly.
1628  * The arg pointer can be a pointer to an object or to a key,
1629  * we can say this looking at flags value.
1630  * If arg points to an object we will search for the object pointed
1631  * by this value, otherwise we search for a key value.
1632  * If the key is not unique we only find the first matching value.
1633  *
1634  * The use of flags argument is the follow:
1635  *
1636  *      OBJ_UNLINK              unlinks the object found
1637  *      OBJ_NODATA              on match, do return an object
1638  *                              Callbacks use OBJ_NODATA as a default
1639  *                              functions such as find() do
1640  *      OBJ_MULTIPLE            return multiple matches
1641  *                              Default is no.
1642  *      OBJ_SEARCH_OBJECT       the pointer is to an object
1643  *      OBJ_SEARCH_KEY          the pointer is to a search key
1644  *      OBJ_SEARCH_PARTIAL_KEY  the pointer is to a partial search key
1645  *
1646  * \note When the returned object is no longer in use, ao2_ref() should
1647  * be used to free the additional reference possibly created by this function.
1648  *
1649  * @{
1650  */
1651 #ifdef REF_DEBUG
1652
1653 #define ao2_t_callback(c, flags, cb_fn, arg, tag) \
1654         __ao2_callback_debug((c), (flags), (cb_fn), (arg), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1655 #define ao2_callback(c, flags, cb_fn, arg) \
1656         __ao2_callback_debug((c), (flags), (cb_fn), (arg), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1657
1658 #else
1659
1660 #define ao2_t_callback(c, flags, cb_fn, arg, tag) \
1661         __ao2_callback((c), (flags), (cb_fn), (arg))
1662 #define ao2_callback(c, flags, cb_fn, arg) \
1663         __ao2_callback((c), (flags), (cb_fn), (arg))
1664
1665 #endif
1666
1667 void *__ao2_callback_debug(struct ao2_container *c, enum search_flags flags,
1668         ao2_callback_fn *cb_fn, void *arg, const char *tag, const char *file, int line,
1669         const char *func);
1670 void *__ao2_callback(struct ao2_container *c, enum search_flags flags, ao2_callback_fn *cb_fn, void *arg);
1671
1672 /*! @} */
1673
1674 /*! \brief
1675  * ao2_callback_data() is a generic function that applies cb_fn() to all objects
1676  * in a container.  It is functionally identical to ao2_callback() except that
1677  * instead of taking an ao2_callback_fn *, it takes an ao2_callback_data_fn *, and
1678  * allows the caller to pass in arbitrary data.
1679  *
1680  * This call would be used instead of ao2_callback() when the caller needs to pass
1681  * OBJ_SEARCH_OBJECT, OBJ_SEARCH_KEY, or OBJ_SEARCH_PARTIAL_KEY as part of the flags
1682  * argument (which in turn requires passing in a known pointer type for 'arg') and
1683  * also needs access to other non-global data to complete it's comparison or task.
1684  *
1685  * See the documentation for ao2_callback() for argument descriptions.
1686  *
1687  * \see ao2_callback()
1688  */
1689 #ifdef REF_DEBUG
1690
1691 #define ao2_t_callback_data(container, flags, cb_fn, arg, data, tag) \
1692         __ao2_callback_data_debug((container), (flags), (cb_fn), (arg), (data), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1693 #define ao2_callback_data(container, flags, cb_fn, arg, data) \
1694         __ao2_callback_data_debug((container), (flags), (cb_fn), (arg), (data), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1695
1696 #else
1697
1698 #define ao2_t_callback_data(container, flags, cb_fn, arg, data, tag) \
1699         __ao2_callback_data((container), (flags), (cb_fn), (arg), (data))
1700 #define ao2_callback_data(container, flags, cb_fn, arg, data) \
1701         __ao2_callback_data((container), (flags), (cb_fn), (arg), (data))
1702
1703 #endif
1704
1705 void *__ao2_callback_data_debug(struct ao2_container *c, enum search_flags flags,
1706         ao2_callback_data_fn *cb_fn, void *arg, void *data, const char *tag, const char *file,
1707         int line, const char *func);
1708 void *__ao2_callback_data(struct ao2_container *c, enum search_flags flags,
1709         ao2_callback_data_fn *cb_fn, void *arg, void *data);
1710
1711 /*! ao2_find() is a short hand for ao2_callback(c, flags, c->cmp_fn, arg)
1712  * XXX possibly change order of arguments ?
1713  */
1714 #ifdef REF_DEBUG
1715
1716 #define ao2_t_find(container, arg, flags, tag) \
1717         __ao2_find_debug((container), (arg), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1718 #define ao2_find(container, arg, flags) \
1719         __ao2_find_debug((container), (arg), (flags), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1720
1721 #else
1722
1723 #define ao2_t_find(container, arg, flags, tag) \
1724         __ao2_find((container), (arg), (flags))
1725 #define ao2_find(container, arg, flags) \
1726         __ao2_find((container), (arg), (flags))
1727
1728 #endif
1729
1730 void *__ao2_find_debug(struct ao2_container *c, const void *arg, enum search_flags flags,
1731         const char *tag, const char *file, int line, const char *func);
1732 void *__ao2_find(struct ao2_container *c, const void *arg, enum search_flags flags);
1733
1734 /*! \brief
1735  *
1736  *
1737  * When we need to walk through a container, we use an
1738  * ao2_iterator to keep track of the current position.
1739  *
1740  * Because the navigation is typically done without holding the
1741  * lock on the container across the loop, objects can be
1742  * inserted or deleted or moved while we work.  As a
1743  * consequence, there is no guarantee that we manage to touch
1744  * all the elements in the container, and it is possible that we
1745  * touch the same object multiple times.
1746  *
1747  * An iterator must be first initialized with
1748  * ao2_iterator_init(), then we can use o = ao2_iterator_next()
1749  * to move from one element to the next.  Remember that the
1750  * object returned by ao2_iterator_next() has its refcount
1751  * incremented, and the reference must be explicitly released
1752  * when done with it.
1753  *
1754  * In addition, ao2_iterator_init() will hold a reference to the
1755  * container being iterated and the last container node found.
1756  * Thes objects will be unreffed when ao2_iterator_destroy() is
1757  * called to free up the resources used by the iterator (if
1758  * any).
1759  *
1760  * Example:
1761  *
1762  *  \code
1763  *
1764  *  struct ao2_container *c = ... // the container we want to iterate on
1765  *  struct ao2_iterator i;
1766  *  struct my_obj *o;
1767  *
1768  *  i = ao2_iterator_init(c, flags);
1769  *
1770  *  while ((o = ao2_iterator_next(&i))) {
1771  *     ... do something on o ...
1772  *     ao2_ref(o, -1);
1773  *  }
1774  *
1775  *  ao2_iterator_restart(&i);
1776  *  while ((o = ao2_iterator_next(&i))) {
1777  *     ... do something on o ...
1778  *     ao2_ref(o, -1);
1779  *  }
1780  *
1781  *  ao2_iterator_destroy(&i);
1782  *
1783  *  \endcode
1784  *
1785  */
1786
1787 /*!
1788  * \brief The astobj2 iterator
1789  *
1790  * \note You are not supposed to know the internals of an iterator!
1791  * We would like the iterator to be opaque, unfortunately
1792  * its size needs to be known if we want to store it around
1793  * without too much trouble.
1794  * Anyways...
1795  * The iterator has a pointer to the container, and a flags
1796  * field specifying various things e.g. whether the container
1797  * should be locked or not while navigating on it.
1798  * The iterator "points" to the current container node.
1799  *
1800  * Details are in the implementation of ao2_iterator_next()
1801  */
1802 struct ao2_iterator {
1803         /*! The container (Has a reference) */
1804         struct ao2_container *c;
1805         /*! Last container node (Has a reference) */
1806         void *last_node;
1807         /*! Nonzero if the iteration has completed. */
1808         int complete;
1809         /*! operation flags (enum ao2_iterator_flags) */
1810         int flags;
1811 };
1812
1813 /*! Flags that can be passed to ao2_iterator_init() to modify the behavior
1814  * of the iterator.
1815  */
1816 enum ao2_iterator_flags {
1817         /*!
1818          * \brief Assume that the ao2_container is already locked.
1819          *
1820          * \note For ao2_containers that have mutexes, no locking will
1821          * be done.
1822          *
1823          * \note For ao2_containers that have RWLOCKs, the lock will be
1824          * promoted to write mode as needed.  The lock will be returned
1825          * to the original locked state.
1826          *
1827          * \note Only use this flag if the ao2_container is manually
1828          * locked already.  You should hold the lock until after
1829          * ao2_iterator_destroy().  If you must release the lock then
1830          * you must at least hold the lock whenever you call an
1831          * ao2_iterator_xxx function with this iterator.
1832          */
1833         AO2_ITERATOR_DONTLOCK = (1 << 0),
1834         /*!
1835          * Indicates that the iterator was dynamically allocated by
1836          * astobj2 API and should be freed by ao2_iterator_destroy().
1837          */
1838         AO2_ITERATOR_MALLOCD = (1 << 1),
1839         /*!
1840          * Indicates that before the iterator returns an object from
1841          * the container being iterated, the object should be unlinked
1842          * from the container.
1843          */
1844         AO2_ITERATOR_UNLINK = (1 << 2),
1845         /*!
1846          * Iterate in descending order (Last to first container object)
1847          * (Otherwise ascending order)
1848          *
1849          * \note Other traversal orders such as pre-order and post-order
1850          * do not make sense because they require the container
1851          * structure to be static during the traversal.  Iterators just
1852          * about guarantee that is not going to happen because the
1853          * container is allowed to change by other threads during the
1854          * iteration.
1855          */
1856         AO2_ITERATOR_DESCENDING = (1 << 3),
1857 };
1858
1859 /*!
1860  * \brief Create an iterator for a container
1861  *
1862  * \param c the container
1863  * \param flags one or more flags from ao2_iterator_flags.
1864  *
1865  * \retval the constructed iterator
1866  *
1867  * \note This function does \b not take a pointer to an iterator;
1868  *       rather, it returns an iterator structure that should be
1869  *       assigned to (overwriting) an existing iterator structure
1870  *       allocated on the stack or on the heap.
1871  *
1872  * This function will take a reference on the container being iterated.
1873  */
1874 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result;
1875
1876 /*!
1877  * \brief Destroy a container iterator
1878  *
1879  * \param iter the iterator to destroy
1880  *
1881  * \retval none
1882  *
1883  * This function will release the container reference held by the iterator
1884  * and any other resources it may be holding.
1885  */
1886 #if defined(TEST_FRAMEWORK)
1887 void ao2_iterator_destroy(struct ao2_iterator *iter) __attribute__((noinline));
1888 #else
1889 void ao2_iterator_destroy(struct ao2_iterator *iter);
1890 #endif  /* defined(TEST_FRAMEWORK) */
1891
1892 #ifdef REF_DEBUG
1893
1894 #define ao2_t_iterator_next(iter, tag) __ao2_iterator_next_debug((iter), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1895 #define ao2_iterator_next(iter)        __ao2_iterator_next_debug((iter), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1896
1897 #else
1898
1899 #define ao2_t_iterator_next(iter, tag) __ao2_iterator_next((iter))
1900 #define ao2_iterator_next(iter)        __ao2_iterator_next((iter))
1901
1902 #endif
1903
1904 void *__ao2_iterator_next_debug(struct ao2_iterator *iter, const char *tag, const char *file, int line, const char *func) attribute_warn_unused_result;
1905 void *__ao2_iterator_next(struct ao2_iterator *iter) attribute_warn_unused_result;
1906
1907 /*!
1908  * \brief Restart an iteration.
1909  *
1910  * \param iter the iterator to restart
1911  *
1912  * \note A restart is not going to have any effect if the
1913  * iterator was created with the AO2_ITERATOR_UNLINK flag.  Any
1914  * previous objects returned were removed from the container.
1915  *
1916  * \retval none
1917  */
1918 void ao2_iterator_restart(struct ao2_iterator *iter);
1919
1920 /* extra functions */
1921 void ao2_bt(void);      /* backtrace */
1922
1923 /*! gcc __attribute__(cleanup()) functions
1924  * \note they must be able to handle NULL parameters because most of the
1925  * allocation/find functions can fail and we don't want to try to tear
1926  * down a NULL */
1927 void __ao2_cleanup(void *obj);
1928 void __ao2_cleanup_debug(void *obj, const char *file, int line, const char *function);
1929 #ifdef REF_DEBUG
1930 #define ao2_cleanup(obj) __ao2_cleanup_debug((obj), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1931 #else
1932 #define ao2_cleanup(obj) __ao2_cleanup(obj)
1933 #endif
1934 void ao2_iterator_cleanup(struct ao2_iterator *iter);
1935
1936 #endif /* _ASTERISK_ASTOBJ2_H */