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