Clean up doxygen warnings
[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 hashable item that is not an object.
732               Similar to OBJ_POINTER and mutually exclusive.
733
734   -  \b ao2_callback(c, flags, fn, arg)
735     apply fn(obj, arg) to all objects in the container.
736     Similar to find. fn() can tell when to stop, and
737     do anything with the object including unlinking it.
738       - c is the container;
739       - flags can be
740          OBJ_UNLINK   - to remove the object, once found, from the container.
741          OBJ_NODATA   - don't return the object if found (no ref count change)
742          OBJ_MULTIPLE - don't stop at first match
743          OBJ_POINTER  - if set, 'arg' is an object pointer, and a hash table
744                         search will be done. If not, a traversal is done through
745                         all the hash table 'buckets'..
746          OBJ_KEY      - if set, 'arg', is a hashable item that is not an object.
747                         Similar to OBJ_POINTER and mutually exclusive.
748       - fn is a func that returns int, and takes 3 args:
749         (void *obj, void *arg, int flags);
750           obj is an object
751           arg is the same as arg passed into ao2_callback
752           flags is the same as flags passed into ao2_callback
753          fn returns:
754            0: no match, keep going
755            CMP_STOP: stop search, no match
756            CMP_MATCH: This object is matched.
757
758     Note that the entire operation is run with the container
759     locked, so nobody else can change its content while we work on it.
760     However, we pay this with the fact that doing
761     anything blocking in the callback keeps the container
762     blocked.
763     The mechanism is very flexible because the callback function fn()
764     can do basically anything e.g. counting, deleting records, etc.
765     possibly using arg to store the results.
766
767   -  \b iterate on a container
768     this is done with the following sequence
769
770 \code
771
772         struct ao2_container *c = ... // our container
773         struct ao2_iterator i;
774         void *o;
775
776         i = ao2_iterator_init(c, flags);
777
778         while ((o = ao2_iterator_next(&i))) {
779             ... do something on o ...
780             ao2_ref(o, -1);
781         }
782
783         ao2_iterator_destroy(&i);
784 \endcode
785
786     The difference with the callback is that the control
787     on how to iterate is left to us.
788
789     - \b ao2_ref(c, -1)
790     dropping a reference to a container destroys it, very simple!
791
792 Containers are ao2 objects themselves, and this is why their
793 implementation is simple too.
794
795 Before declaring containers, we need to declare the types of the
796 arguments passed to the constructor - in turn, this requires
797 to define callback and hash functions and their arguments.
798
799 - \ref AstObj2
800 - \ref astobj2.h
801  */
802
803 /*! \brief
804  * Type of a generic callback function
805  * \param obj  pointer to the (user-defined part) of an object.
806  * \param arg callback argument from ao2_callback()
807  * \param flags flags from ao2_callback()
808  *
809  * The return values are a combination of enum _cb_results.
810  * Callback functions are used to search or manipulate objects in a container.
811  */
812 typedef int (ao2_callback_fn)(void *obj, void *arg, int flags);
813
814 /*! \brief
815  * Type of a generic callback function
816  * \param obj pointer to the (user-defined part) of an object.
817  * \param arg callback argument from ao2_callback()
818  * \param data arbitrary data from ao2_callback()
819  * \param flags flags from ao2_callback()
820  *
821  * The return values are a combination of enum _cb_results.
822  * Callback functions are used to search or manipulate objects in a container.
823  */
824 typedef int (ao2_callback_data_fn)(void *obj, void *arg, void *data, int flags);
825
826 /*! \brief A common ao2_callback is one that matches by address. */
827 int ao2_match_by_addr(void *obj, void *arg, int flags);
828
829 /*! \brief
830  * A callback function will return a combination of CMP_MATCH and CMP_STOP.
831  * The latter will terminate the search in a container.
832  */
833 enum _cb_results {
834         CMP_MATCH       = 0x1,  /*!< the object matches the request */
835         CMP_STOP        = 0x2,  /*!< stop the search now */
836 };
837
838 /*! \brief
839  * Flags passed to ao2_callback() and ao2_hash_fn() to modify its behaviour.
840  */
841 enum search_flags {
842         /*!
843          * Unlink the object for which the callback function returned
844          * CMP_MATCH.
845          */
846         OBJ_UNLINK = (1 << 0),
847         /*!
848          * On match, don't return the object hence do not increase its
849          * refcount.
850          */
851         OBJ_NODATA = (1 << 1),
852         /*!
853          * Don't stop at the first match in ao2_callback() unless the
854          * result of of the callback function has the CMP_STOP bit set.
855          */
856         OBJ_MULTIPLE = (1 << 2),
857         /*!
858          * The given obj is an object of the same type as the one being
859          * searched for, so use the object's hash function for optimized
860          * searching.
861          *
862          * The matching function is unaffected (i.e. The cb_fn argument
863          * to ao2_callback).
864          */
865         OBJ_POINTER = (1 << 3),
866         /*!
867          * \brief Continue if a match is not found in the hashed out bucket
868          *
869          * This flag is to be used in combination with OBJ_POINTER.  This tells
870          * the ao2_callback() core to keep searching through the rest of the
871          * buckets if a match is not found in the starting bucket defined by
872          * the hash value on the argument.
873          */
874         OBJ_CONTINUE = (1 << 4),
875         /*!
876          * \brief Assume that the ao2_container is already locked.
877          *
878          * \note For ao2_containers that have mutexes, no locking will
879          * be done.
880          *
881          * \note For ao2_containers that have RWLOCKs, the lock will be
882          * promoted to write mode as needed.  The lock will be returned
883          * to the original locked state.
884          *
885          * \note Only use this flag if the ao2_container is manually
886          * locked already.
887          */
888         OBJ_NOLOCK = (1 << 5),
889         /*!
890          * \brief The data is hashable, but is not an object.
891          *
892          * \details
893          * This can be used when you want to be able to pass custom data
894          * to the container's stored ao2_hash_fn and ao2_find
895          * ao2_callback_fn functions that is not a full object, but
896          * perhaps just a string.
897          *
898          * \note OBJ_KEY and OBJ_POINTER are mutually exclusive options.
899          */
900         OBJ_KEY = (1 << 6),
901 };
902
903 /*!
904  * Type of a generic function to generate a hash value from an object.
905  * flags is ignored at the moment. Eventually, it will include the
906  * value of OBJ_POINTER passed to ao2_callback().
907  */
908 typedef int (ao2_hash_fn)(const void *obj, int flags);
909
910 /*! \name Object Containers
911  * Here start declarations of containers.
912  */
913 /*@{ */
914 struct ao2_container;
915
916 /*!
917  * \brief Allocate and initialize a hash container with the desired number of buckets.
918  *
919  * \details
920  * We allocate space for a struct astobj_container, struct container
921  * and the buckets[] array.
922  *
923  * \param options Container ao2 object options (See enum ao2_alloc_opts)
924  * \param n_buckets Number of buckets for hash
925  * \param hash_fn Pointer to a function computing a hash value. (NULL if everyting goes in first bucket.)
926  * \param cmp_fn Pointer to a compare function used by ao2_find. (NULL to match everything)
927  * \param tag used for debugging.
928  *
929  * \return A pointer to a struct container.
930  *
931  * \note Destructor is set implicitly.
932  */
933
934 #if defined(REF_DEBUG)
935
936 #define ao2_t_container_alloc_options(options, n_buckets, hash_fn, cmp_fn, tag) \
937         __ao2_container_alloc_debug((options), (n_buckets), (hash_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
938 #define ao2_container_alloc_options(options, n_buckets, hash_fn, cmp_fn) \
939         __ao2_container_alloc_debug((options), (n_buckets), (hash_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
940
941 #define ao2_t_container_alloc(n_buckets, hash_fn, cmp_fn, tag) \
942         __ao2_container_alloc_debug(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
943 #define ao2_container_alloc(n_buckets, hash_fn, cmp_fn) \
944         __ao2_container_alloc_debug(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
945
946 #elif defined(__AST_DEBUG_MALLOC)
947
948 #define ao2_t_container_alloc_options(options, n_buckets, hash_fn, cmp_fn, tag) \
949         __ao2_container_alloc_debug((options), (n_buckets), (hash_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
950 #define ao2_container_alloc_options(options, n_buckets, hash_fn, cmp_fn) \
951         __ao2_container_alloc_debug((options), (n_buckets), (hash_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
952
953 #define ao2_t_container_alloc(n_buckets, hash_fn, cmp_fn, tag) \
954         __ao2_container_alloc_debug(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
955 #define ao2_container_alloc(n_buckets, hash_fn, cmp_fn) \
956         __ao2_container_alloc_debug(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
957
958 #else
959
960 #define ao2_t_container_alloc_options(options, n_buckets, hash_fn, cmp_fn, tag) \
961         __ao2_container_alloc((options), (n_buckets), (hash_fn), (cmp_fn))
962 #define ao2_container_alloc_options(options, n_buckets, hash_fn, cmp_fn) \
963         __ao2_container_alloc((options), (n_buckets), (hash_fn), (cmp_fn))
964
965 #define ao2_t_container_alloc(n_buckets, hash_fn, cmp_fn, tag) \
966         __ao2_container_alloc(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn))
967 #define ao2_container_alloc(n_buckets, hash_fn, cmp_fn) \
968         __ao2_container_alloc(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn))
969
970 #endif
971
972 struct ao2_container *__ao2_container_alloc(unsigned int options,
973         unsigned int n_buckets, ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn);
974 struct ao2_container *__ao2_container_alloc_debug(unsigned int options,
975         unsigned int n_buckets, ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn,
976         const char *tag, const char *file, int line, const char *func, int ref_debug);
977
978 /*! \brief
979  * Returns the number of elements in a container.
980  */
981 int ao2_container_count(struct ao2_container *c);
982
983 /*!
984  * \brief Copy all object references in the src container into the dest container.
985  * \since 11.0
986  *
987  * \param dest Container to copy src object references into.
988  * \param src Container to copy all object references from.
989  * \param flags OBJ_NOLOCK if a lock is already held on both containers.
990  *    Otherwise, the src container is locked first.
991  *
992  * \pre The dest container must be empty.  If the duplication fails, the
993  * dest container will be returned empty.
994  *
995  * \note This can potentially be expensive because a malloc is
996  * needed for every object in the src container.
997  *
998  * \retval 0 on success.
999  * \retval -1 on error.
1000  */
1001 int ao2_container_dup(struct ao2_container *dest, struct ao2_container *src, enum search_flags flags);
1002
1003 /*!
1004  * \brief Create a clone/copy of the given container.
1005  * \since 11.0
1006  *
1007  * \param orig Container to copy all object references from.
1008  * \param flags OBJ_NOLOCK if a lock is already held on the container.
1009  *
1010  * \note This can potentially be expensive because a malloc is
1011  * needed for every object in the orig container.
1012  *
1013  * \retval Clone container on success.
1014  * \retval NULL on error.
1015  */
1016 struct ao2_container *__ao2_container_clone(struct ao2_container *orig, enum search_flags flags);
1017 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);
1018 #if defined(REF_DEBUG)
1019
1020 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone_debug(orig, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1021 #define ao2_container_clone(orig, flags)                __ao2_container_clone_debug(orig, flags, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1022
1023 #elif defined(__AST_DEBUG_MALLOC)
1024
1025 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone_debug(orig, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1026 #define ao2_container_clone(orig, flags)                __ao2_container_clone_debug(orig, flags, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1027
1028 #else
1029
1030 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone(orig, flags)
1031 #define ao2_container_clone(orig, flags)                __ao2_container_clone(orig, flags)
1032
1033 #endif
1034
1035 /*@} */
1036
1037 /*! \name Object Management
1038  * Here we have functions to manage objects.
1039  *
1040  * We can use the functions below on any kind of
1041  * object defined by the user.
1042  */
1043 /*@{ */
1044
1045 /*!
1046  * \brief Add an object to a container.
1047  *
1048  * \param container The container to operate on.
1049  * \param obj The object to be added.
1050  * \param tag used for debugging.
1051  *
1052  * \retval NULL on errors.
1053  * \retval !NULL on success.
1054  *
1055  * This function inserts an object in a container according its key.
1056  *
1057  * \note Remember to set the key before calling this function.
1058  *
1059  * \note This function automatically increases the reference count to account
1060  *       for the reference that the container now holds to the object.
1061  */
1062 #ifdef REF_DEBUG
1063
1064 #define ao2_t_link(container, obj, tag)                                 __ao2_link_debug((container), (obj), 0, (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1065 #define ao2_link(container, obj)                                                __ao2_link_debug((container), (obj), 0, "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1066
1067 /*!
1068  * \brief Add an object to a container.
1069  *
1070  * \param container The container to operate on.
1071  * \param obj The object to be added.
1072  * \param flags search_flags to control linking the object.  (OBJ_NOLOCK)
1073  * \param tag used for debugging.
1074  *
1075  * \retval NULL on errors.
1076  * \retval !NULL on success.
1077  *
1078  * This function inserts an object in a container according its key.
1079  *
1080  * \note Remember to set the key before calling this function.
1081  *
1082  * \note This function automatically increases the reference count to account
1083  *       for the reference that the container now holds to the object.
1084  */
1085 #define ao2_t_link_flags(container, obj, flags, tag)    __ao2_link_debug((container), (obj), (flags), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1086 #define ao2_link_flags(container, obj, flags)                   __ao2_link_debug((container), (obj), (flags), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1087
1088 #else
1089
1090 #define ao2_t_link(container, obj, tag)                                 __ao2_link((container), (obj), 0)
1091 #define ao2_link(container, obj)                                                __ao2_link((container), (obj), 0)
1092
1093 #define ao2_t_link_flags(container, obj, flags, tag)    __ao2_link((container), (obj), (flags))
1094 #define ao2_link_flags(container, obj, flags)                   __ao2_link((container), (obj), (flags))
1095
1096 #endif
1097
1098 void *__ao2_link_debug(struct ao2_container *c, void *obj_new, int flags, const char *tag, const char *file, int line, const char *func);
1099 void *__ao2_link(struct ao2_container *c, void *obj_new, int flags);
1100
1101 /*!
1102  * \brief Remove an object from a container
1103  *
1104  * \param container The container to operate on.
1105  * \param obj The object to unlink.
1106  * \param tag used for debugging.
1107  *
1108  * \retval NULL, always
1109  *
1110  * \note The object requested to be unlinked must be valid.  However, if it turns
1111  *       out that it is not in the container, this function is still safe to
1112  *       be called.
1113  *
1114  * \note If the object gets unlinked from the container, the container's
1115  *       reference to the object will be automatically released. (The
1116  *       refcount will be decremented).
1117  */
1118 #ifdef REF_DEBUG
1119
1120 #define ao2_t_unlink(container, obj, tag)                               __ao2_unlink_debug((container), (obj), 0, (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1121 #define ao2_unlink(container, obj)                                              __ao2_unlink_debug((container), (obj), 0, "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1122
1123 /*!
1124  * \brief Remove an object from a container
1125  *
1126  * \param container The container to operate on.
1127  * \param obj The object to unlink.
1128  * \param flags search_flags to control unlinking the object.  (OBJ_NOLOCK)
1129  * \param tag used for debugging.
1130  *
1131  * \retval NULL, always
1132  *
1133  * \note The object requested to be unlinked must be valid.  However, if it turns
1134  *       out that it is not in the container, this function is still safe to
1135  *       be called.
1136  *
1137  * \note If the object gets unlinked from the container, the container's
1138  *       reference to the object will be automatically released. (The
1139  *       refcount will be decremented).
1140  */
1141
1142 #define ao2_t_unlink_flags(container, obj, flags, tag)  __ao2_unlink_debug((container), (obj), (flags), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1143 #define ao2_unlink_flags(container, obj, flags)                 __ao2_unlink_debug((container), (obj), (flags), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1144
1145 #else
1146
1147 #define ao2_t_unlink(container, obj, tag)                               __ao2_unlink((container), (obj), 0)
1148 #define ao2_unlink(container, obj)                                              __ao2_unlink((container), (obj), 0)
1149
1150 #define ao2_t_unlink_flags(container, obj, flags, tag)  __ao2_unlink((container), (obj), (flags))
1151 #define ao2_unlink_flags(container, obj, flags)                 __ao2_unlink((container), (obj), (flags))
1152
1153 #endif
1154
1155 void *__ao2_unlink_debug(struct ao2_container *c, void *obj, int flags, const char *tag, const char *file, int line, const char *func);
1156 void *__ao2_unlink(struct ao2_container *c, void *obj, int flags);
1157
1158
1159 /*@} */
1160
1161 /*! \brief
1162  * ao2_callback() is a generic function that applies cb_fn() to all objects
1163  * in a container, as described below.
1164  *
1165  * \param c A pointer to the container to operate on.
1166  * \param flags A set of flags specifying the operation to perform,
1167  *  partially used by the container code, but also passed to
1168  *  the callback.
1169  *   - If OBJ_NODATA is set, ao2_callback will return NULL. No refcounts
1170  *     of any of the traversed objects will be incremented.
1171  *     On the converse, if it is NOT set (the default), the ref count
1172  *     of the first matching object will be incremented and returned.  If
1173  *     OBJ_MULTIPLE is set, the ref count of all matching objects will
1174  *     be incremented in an iterator for a temporary container and returned.
1175  *   - If OBJ_POINTER is set, the traversed items will be restricted
1176  *     to the objects in the bucket that the object key hashes to.
1177  * \param cb_fn A function pointer, that will be called on all
1178  *  objects, to see if they match. This function returns CMP_MATCH
1179  *  if the object is matches the criteria; CMP_STOP if the traversal
1180  *  should immediately stop, or both (via bitwise ORing), if you find a
1181  *  match and want to end the traversal, and 0 if the object is not a match,
1182  *  but the traversal should continue. This is the function that is applied
1183  *  to each object traversed. Its arguments are:
1184  *      (void *obj, void *arg, int flags), where:
1185  *        obj is an object
1186  *        arg is the same as arg passed into ao2_callback
1187  *        flags is the same as flags passed into ao2_callback (flags are
1188  *         also used by ao2_callback).
1189  * \param arg passed to the callback.
1190  * \param tag used for debugging.
1191  *
1192  * \retval NULL on failure or no matching object found.
1193  *
1194  * \retval object found if OBJ_MULTIPLE is not set in the flags
1195  * parameter.
1196  *
1197  * \retval ao2_iterator pointer if OBJ_MULTIPLE is set in the
1198  * flags parameter.  The iterator must be destroyed with
1199  * ao2_iterator_destroy() when the caller no longer needs it.
1200  *
1201  * If the function returns any objects, their refcount is incremented,
1202  * and the caller is in charge of decrementing them once done.
1203  *
1204  * Typically, ao2_callback() is used for two purposes:
1205  * - to perform some action (including removal from the container) on one
1206  *   or more objects; in this case, cb_fn() can modify the object itself,
1207  *   and to perform deletion should set CMP_MATCH on the matching objects,
1208  *   and have OBJ_UNLINK set in flags.
1209  * - to look for a specific object in a container; in this case, cb_fn()
1210  *   should not modify the object, but just return a combination of
1211  *   CMP_MATCH and CMP_STOP on the desired object.
1212  * Other usages are also possible, of course.
1213  *
1214  * This function searches through a container and performs operations
1215  * on objects according on flags passed.
1216  * XXX describe better
1217  * The comparison is done calling the compare function set implicitly.
1218  * The arg pointer can be a pointer to an object or to a key,
1219  * we can say this looking at flags value.
1220  * If arg points to an object we will search for the object pointed
1221  * by this value, otherwise we search for a key value.
1222  * If the key is not unique we only find the first matching value.
1223  *
1224  * The use of flags argument is the follow:
1225  *
1226  *      OBJ_UNLINK              unlinks the object found
1227  *      OBJ_NODATA              on match, do return an object
1228  *                              Callbacks use OBJ_NODATA as a default
1229  *                              functions such as find() do
1230  *      OBJ_MULTIPLE            return multiple matches
1231  *                              Default is no.
1232  *      OBJ_POINTER             the pointer is an object pointer
1233  *      OBJ_KEY                 the pointer is to a hashable key
1234  *
1235  * \note When the returned object is no longer in use, ao2_ref() should
1236  * be used to free the additional reference possibly created by this function.
1237  *
1238  * @{
1239  */
1240 #ifdef REF_DEBUG
1241
1242 #define ao2_t_callback(c, flags, cb_fn, arg, tag) \
1243         __ao2_callback_debug((c), (flags), (cb_fn), (arg), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1244 #define ao2_callback(c, flags, cb_fn, arg) \
1245         __ao2_callback_debug((c), (flags), (cb_fn), (arg), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1246
1247 #else
1248
1249 #define ao2_t_callback(c, flags, cb_fn, arg, tag) \
1250         __ao2_callback((c), (flags), (cb_fn), (arg))
1251 #define ao2_callback(c, flags, cb_fn, arg) \
1252         __ao2_callback((c), (flags), (cb_fn), (arg))
1253
1254 #endif
1255
1256 void *__ao2_callback_debug(struct ao2_container *c, enum search_flags flags,
1257         ao2_callback_fn *cb_fn, void *arg, const char *tag, const char *file, int line,
1258         const char *func);
1259 void *__ao2_callback(struct ao2_container *c, enum search_flags flags, ao2_callback_fn *cb_fn, void *arg);
1260
1261 /*! @} */
1262
1263 /*! \brief
1264  * ao2_callback_data() is a generic function that applies cb_fn() to all objects
1265  * in a container.  It is functionally identical to ao2_callback() except that
1266  * instead of taking an ao2_callback_fn *, it takes an ao2_callback_data_fn *, and
1267  * allows the caller to pass in arbitrary data.
1268  *
1269  * This call would be used instead of ao2_callback() when the caller needs to pass
1270  * OBJ_POINTER as part of the flags argument (which in turn requires passing in a
1271  * prototype ao2 object for 'arg') and also needs access to other non-global data
1272  * to complete it's comparison or task.
1273  *
1274  * See the documentation for ao2_callback() for argument descriptions.
1275  *
1276  * \see ao2_callback()
1277  */
1278 #ifdef REF_DEBUG
1279
1280 #define ao2_t_callback_data(container, flags, cb_fn, arg, data, tag) \
1281         __ao2_callback_data_debug((container), (flags), (cb_fn), (arg), (data), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1282 #define ao2_callback_data(container, flags, cb_fn, arg, data) \
1283         __ao2_callback_data_debug((container), (flags), (cb_fn), (arg), (data), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1284
1285 #else
1286
1287 #define ao2_t_callback_data(container, flags, cb_fn, arg, data, tag) \
1288         __ao2_callback_data((container), (flags), (cb_fn), (arg), (data))
1289 #define ao2_callback_data(container, flags, cb_fn, arg, data) \
1290         __ao2_callback_data((container), (flags), (cb_fn), (arg), (data))
1291
1292 #endif
1293
1294 void *__ao2_callback_data_debug(struct ao2_container *c, enum search_flags flags,
1295         ao2_callback_data_fn *cb_fn, void *arg, void *data, const char *tag, const char *file,
1296         int line, const char *func);
1297 void *__ao2_callback_data(struct ao2_container *c, enum search_flags flags,
1298         ao2_callback_data_fn *cb_fn, void *arg, void *data);
1299
1300 /*! ao2_find() is a short hand for ao2_callback(c, flags, c->cmp_fn, arg)
1301  * XXX possibly change order of arguments ?
1302  */
1303 #ifdef REF_DEBUG
1304
1305 #define ao2_t_find(container, arg, flags, tag) \
1306         __ao2_find_debug((container), (arg), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1307 #define ao2_find(container, arg, flags) \
1308         __ao2_find_debug((container), (arg), (flags), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1309
1310 #else
1311
1312 #define ao2_t_find(container, arg, flags, tag) \
1313         __ao2_find((container), (arg), (flags))
1314 #define ao2_find(container, arg, flags) \
1315         __ao2_find((container), (arg), (flags))
1316
1317 #endif
1318
1319 void *__ao2_find_debug(struct ao2_container *c, const void *arg, enum search_flags flags,
1320         const char *tag, const char *file, int line, const char *func);
1321 void *__ao2_find(struct ao2_container *c, const void *arg, enum search_flags flags);
1322
1323 /*! \brief
1324  *
1325  *
1326  * When we need to walk through a container, we use an
1327  * ao2_iterator to keep track of the current position.
1328  *
1329  * Because the navigation is typically done without holding the
1330  * lock on the container across the loop, objects can be inserted or deleted
1331  * or moved while we work. As a consequence, there is no guarantee that
1332  * we manage to touch all the elements in the container, and it is possible
1333  * that we touch the same object multiple times.
1334  *
1335  * However, within the current hash table container, the following is true:
1336  *  - It is not possible to miss an object in the container while iterating
1337  *    unless it gets added after the iteration begins and is added to a bucket
1338  *    that is before the one the current object is in.  In this case, even if
1339  *    you locked the container around the entire iteration loop, you still would
1340  *    not see this object, because it would still be waiting on the container
1341  *    lock so that it can be added.
1342  *  - It would be extremely rare to see an object twice.  The only way this can
1343  *    happen is if an object got unlinked from the container and added again
1344  *    during the same iteration.  Furthermore, when the object gets added back,
1345  *    it has to be in the current or later bucket for it to be seen again.
1346  *
1347  * An iterator must be first initialized with ao2_iterator_init(),
1348  * then we can use o = ao2_iterator_next() to move from one
1349  * element to the next. Remember that the object returned by
1350  * ao2_iterator_next() has its refcount incremented,
1351  * and the reference must be explicitly released when done with it.
1352  *
1353  * In addition, ao2_iterator_init() will hold a reference to the container
1354  * being iterated, which will be freed when ao2_iterator_destroy() is called
1355  * to free up the resources used by the iterator (if any).
1356  *
1357  * Example:
1358  *
1359  *  \code
1360  *
1361  *  struct ao2_container *c = ... // the container we want to iterate on
1362  *  struct ao2_iterator i;
1363  *  struct my_obj *o;
1364  *
1365  *  i = ao2_iterator_init(c, flags);
1366  *
1367  *  while ((o = ao2_iterator_next(&i))) {
1368  *     ... do something on o ...
1369  *     ao2_ref(o, -1);
1370  *  }
1371  *
1372  *  ao2_iterator_destroy(&i);
1373  *
1374  *  \endcode
1375  *
1376  */
1377
1378 /*! \brief
1379  * The astobj2 iterator
1380  *
1381  * \note You are not supposed to know the internals of an iterator!
1382  * We would like the iterator to be opaque, unfortunately
1383  * its size needs to be known if we want to store it around
1384  * without too much trouble.
1385  * Anyways...
1386  * The iterator has a pointer to the container, and a flags
1387  * field specifying various things e.g. whether the container
1388  * should be locked or not while navigating on it.
1389  * The iterator "points" to the current object, which is identified
1390  * by three values:
1391  *
1392  * - a bucket number;
1393  * - the object_id, which is also the container version number
1394  *   when the object was inserted. This identifies the object
1395  *   uniquely, however reaching the desired object requires
1396  *   scanning a list.
1397  * - a pointer, and a container version when we saved the pointer.
1398  *   If the container has not changed its version number, then we
1399  *   can safely follow the pointer to reach the object in constant time.
1400  *
1401  * Details are in the implementation of ao2_iterator_next()
1402  * A freshly-initialized iterator has bucket=0, version=0.
1403  */
1404 struct ao2_iterator {
1405         /*! the container */
1406         struct ao2_container *c;
1407         /*! operation flags */
1408         int flags;
1409         /*! current bucket */
1410         int bucket;
1411         /*! container version */
1412         unsigned int c_version;
1413         /*! pointer to the current object */
1414         void *obj;
1415         /*! container version when the object was created */
1416         unsigned int version;
1417 };
1418
1419 /*! Flags that can be passed to ao2_iterator_init() to modify the behavior
1420  * of the iterator.
1421  */
1422 enum ao2_iterator_flags {
1423         /*!
1424          * \brief Assume that the ao2_container is already locked.
1425          *
1426          * \note For ao2_containers that have mutexes, no locking will
1427          * be done.
1428          *
1429          * \note For ao2_containers that have RWLOCKs, the lock will be
1430          * promoted to write mode as needed.  The lock will be returned
1431          * to the original locked state.
1432          *
1433          * \note Only use this flag if the ao2_container is manually
1434          * locked already.
1435          */
1436         AO2_ITERATOR_DONTLOCK = (1 << 0),
1437         /*!
1438          * Indicates that the iterator was dynamically allocated by
1439          * astobj2 API and should be freed by ao2_iterator_destroy().
1440          */
1441         AO2_ITERATOR_MALLOCD = (1 << 1),
1442         /*!
1443          * Indicates that before the iterator returns an object from
1444          * the container being iterated, the object should be unlinked
1445          * from the container.
1446          */
1447         AO2_ITERATOR_UNLINK = (1 << 2),
1448 };
1449
1450 /*!
1451  * \brief Create an iterator for a container
1452  *
1453  * \param c the container
1454  * \param flags one or more flags from ao2_iterator_flags
1455  *
1456  * \retval the constructed iterator
1457  *
1458  * \note This function does \b not take a pointer to an iterator;
1459  *       rather, it returns an iterator structure that should be
1460  *       assigned to (overwriting) an existing iterator structure
1461  *       allocated on the stack or on the heap.
1462  *
1463  * This function will take a reference on the container being iterated.
1464  *
1465  */
1466 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags);
1467
1468 /*!
1469  * \brief Destroy a container iterator
1470  *
1471  * \param iter the iterator to destroy
1472  *
1473  * \retval none
1474  *
1475  * This function will release the container reference held by the iterator
1476  * and any other resources it may be holding.
1477  *
1478  */
1479 #if defined(TEST_FRAMEWORK)
1480 void ao2_iterator_destroy(struct ao2_iterator *iter) __attribute__((noinline));
1481 #else
1482 void ao2_iterator_destroy(struct ao2_iterator *iter);
1483 #endif
1484 #ifdef REF_DEBUG
1485
1486 #define ao2_t_iterator_next(iter, tag) __ao2_iterator_next_debug((iter), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1487 #define ao2_iterator_next(iter)        __ao2_iterator_next_debug((iter), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1488
1489 #else
1490
1491 #define ao2_t_iterator_next(iter, tag) __ao2_iterator_next((iter))
1492 #define ao2_iterator_next(iter)        __ao2_iterator_next((iter))
1493
1494 #endif
1495
1496 void *__ao2_iterator_next_debug(struct ao2_iterator *iter, const char *tag, const char *file, int line, const char *func);
1497 void *__ao2_iterator_next(struct ao2_iterator *iter);
1498
1499 /* extra functions */
1500 void ao2_bt(void);      /* backtrace */
1501
1502 /*! gcc __attribute__(cleanup()) functions
1503  * \note they must be able to handle NULL parameters because most of the
1504  * allocation/find functions can fail and we don't want to try to tear
1505  * down a NULL */
1506 void ao2_cleanup(void *obj);
1507 void ao2_iterator_cleanup(struct ao2_iterator *iter);
1508 #endif /* _ASTERISK_ASTOBJ2_H */