c0e17e10cc6e013060dbfa4c2af581de4a0b9aae
[asterisk/asterisk.git] / include / asterisk / astobj2.h
1 /*
2  * astobj2 - replacement containers for asterisk data structures.
3  *
4  * Copyright (C) 2006 Marta Carbone, Luigi Rizzo - Univ. di Pisa, Italy
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 #ifndef _ASTERISK_ASTOBJ2_H
18 #define _ASTERISK_ASTOBJ2_H
19
20 #include "asterisk/compat.h"
21 #include "asterisk/linkedlists.h"
22
23 /*! \file
24  * \ref AstObj2
25  *
26  * \page AstObj2 Object Model implementing objects and containers.
27
28 This module implements an abstraction for objects (with locks and
29 reference counts), and containers for these user-defined objects,
30 also supporting locking, reference counting and callbacks.
31
32 The internal implementation of objects and containers is opaque to the user,
33 so we can use different data structures as needs arise.
34
35 \section AstObj2_UsageObjects USAGE - OBJECTS
36
37 An ao2 object is a block of memory that the user code can access,
38 and for which the system keeps track (with a bit of help from the
39 programmer) of the number of references around.  When an object has
40 no more references (refcount == 0), it is destroyed, by first
41 invoking whatever 'destructor' function the programmer specifies
42 (it can be NULL if none is necessary), and then freeing the memory.
43 This way objects can be shared without worrying who is in charge
44 of freeing them.
45 As an additional feature, ao2 objects are associated to individual
46 locks.
47
48 Creating an object requires the size of the object and
49 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  * \return 0 on success, other values on error.
526  */
527 int __ao2_lock(void *a, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var);
528 #define ao2_lock(a) __ao2_lock(a, AO2_LOCK_REQ_MUTEX, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
529 #define ao2_rdlock(a) __ao2_lock(a, AO2_LOCK_REQ_RDLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
530 #define ao2_wrlock(a) __ao2_lock(a, AO2_LOCK_REQ_WRLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
531
532 /*! \brief
533  * Unlock an object.
534  *
535  * \param a A pointer to the object we want unlock.
536  * \return 0 on success, other values on error.
537  */
538 int __ao2_unlock(void *a, const char *file, const char *func, int line, const char *var);
539 #define ao2_unlock(a) __ao2_unlock(a, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
540
541 /*! \brief
542  * Try locking-- (don't block if fail)
543  *
544  * \param a A pointer to the object we want to lock.
545  * \return 0 on success, other values on error.
546  */
547 int __ao2_trylock(void *a, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var);
548 #define ao2_trylock(a) __ao2_trylock(a, AO2_LOCK_REQ_MUTEX, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
549 #define ao2_tryrdlock(a) __ao2_trylock(a, AO2_LOCK_REQ_RDLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
550 #define ao2_trywrlock(a) __ao2_trylock(a, AO2_LOCK_REQ_WRLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)
551
552 /*!
553  * \brief Return the mutex lock address of an object
554  *
555  * \param[in] obj A pointer to the object we want.
556  * \return the address of the mutex lock, else NULL.
557  *
558  * This function comes in handy mainly for debugging locking
559  * situations, where the locking trace code reports the
560  * lock address, this allows you to correlate against
561  * object address, to match objects to reported locks.
562  *
563  * \since 1.6.1
564  */
565 void *ao2_object_get_lockaddr(void *obj);
566
567
568 /*! Global ao2 array container base structure. */
569 struct ao2_global_obj {
570         /*! Access lock to the global ao2 array container. */
571         ast_rwlock_t lock;
572         /*! Number of elements in the global ao2 array container. */
573         unsigned int num_elements;
574         /*! Global ao2 array container array. */
575         void *obj[0];
576 };
577
578 /*!
579  * \brief Define a structure to be used to hold a global array of ao2 objects, statically initialized.
580  * \since 11.0
581  *
582  * \param name This will be the name of the defined structure.
583  * \param num_objects Number of ao2 objects to contain.
584  *
585  * \details
586  * This macro creates a structure definition that can be used to
587  * hold an array of ao2 objects accessible using an API.  The
588  * structure is allocated and initialized to be empty.
589  *
590  * Example usage:
591  * \code
592  * static AO2_GLOBAL_OBJ_STATIC(global_cfg, 10);
593  * \endcode
594  *
595  * This would define \c struct \c global_cfg, intended to hold
596  * an array of ao2 objects accessible using an API.
597  */
598 #ifndef HAVE_PTHREAD_RWLOCK_INITIALIZER
599 #define AO2_GLOBAL_OBJ_STATIC(name, num_objects)                                                \
600         struct name {                                                                                                           \
601                 struct ao2_global_obj global;                                                                   \
602                 void *objs[num_objects];                                                                                \
603         } name;                                                                                                                         \
604         static void  __attribute__((constructor)) __init_##name(void)           \
605         {                                                                                                                                       \
606                 unsigned int idx = (num_objects);                                                               \
607                 ast_rwlock_init(&name.global.lock);                                                             \
608                 name.global.num_elements = idx;                                                                 \
609                 while (idx--) {                                                                                                 \
610                         name.global.obj[idx] = NULL;                                                            \
611                 }                                                                                                                               \
612         }                                                                                                                                       \
613         static void  __attribute__((destructor)) __fini_##name(void)            \
614         {                                                                                                                                       \
615                 unsigned int idx = (num_objects);                                                               \
616                 while (idx--) {                                                                                                 \
617                         if (name.global.obj[idx]) {                                                                     \
618                                 ao2_ref(name.global.obj[idx], -1);                                              \
619                                 name.global.obj[idx] = NULL;                                                    \
620                         }                                                                                                                       \
621                 }                                                                                                                               \
622                 ast_rwlock_destroy(&name.global.lock);                                                  \
623         }                                                                                                                                       \
624         struct __dummy_##name
625 #else
626 #define AO2_GLOBAL_OBJ_STATIC(name, num_objects)                                                \
627         struct name {                                                                                                           \
628                 struct ao2_global_obj global;                                                                   \
629                 void *objs[num_objects];                                                                                \
630         } name = {                                                                                                                      \
631                 .global.lock = AST_RWLOCK_INIT_VALUE,                                                   \
632                 .global.num_elements = (num_objects),                                                   \
633         }
634 #endif
635
636 /*!
637  * \brief Release all global ao2 objects in the global array.
638  * \since 11.0
639  *
640  * \param array Global ao2 object array container.
641  * \param tag used for debugging
642  *
643  * \return Nothing
644  */
645 #define ao2_t_global_obj_release(array, tag)    \
646         __ao2_global_obj_release(&array.global, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #array)
647 #define ao2_global_obj_release(array)   \
648         __ao2_global_obj_release(&array.global, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, #array)
649
650 void __ao2_global_obj_release(struct ao2_global_obj *array, const char *tag, const char *file, int line, const char *func, const char *name);
651
652 /*!
653  * \brief Replace a global ao2 object in the global array.
654  * \since 11.0
655  *
656  * \param array Global ao2 object array container.
657  * \param idx Index to replace in the array.
658  * \param obj Object to put into the array.  Can be NULL.
659  * \param tag used for debugging
660  *
661  * \note This function automatically increases the reference
662  * count to account for the reference that the global array now
663  * holds to the object.
664  *
665  * \retval Reference to previous global ao2 object stored at the index.
666  * \retval NULL if no object available.
667  */
668 #define ao2_t_global_obj_replace(array, idx, obj, tag)  \
669         __ao2_global_obj_replace(&array.global, (idx), (obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #array)
670 #define ao2_global_obj_replace(array, idx, obj) \
671         __ao2_global_obj_replace(&array.global, (idx), (obj), "", __FILE__, __LINE__, __PRETTY_FUNCTION__, #array)
672
673 void *__ao2_global_obj_replace(struct ao2_global_obj *array, unsigned int idx, void *obj, const char *tag, const char *file, int line, const char *func, const char *name);
674
675 /*!
676  * \brief Get a reference to the object stored in the ao2 global array.
677  * \since 11.0
678  *
679  * \param array Global ao2 object array container.
680  * \param idx Index to get an object reference in the array.
681  * \param tag used for debugging
682  *
683  * \retval Reference to current global ao2 object stored at the index.
684  * \retval NULL if no object available.
685  */
686 #define ao2_t_global_obj_ref(array, idx, tag)   \
687         __ao2_global_obj_ref(&array.global, (idx), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #array)
688 #define ao2_global_obj_ref(array, idx)  \
689         __ao2_global_obj_ref(&array.global, (idx), "", __FILE__, __LINE__, __PRETTY_FUNCTION__, #array)
690
691 void *__ao2_global_obj_ref(struct ao2_global_obj *array, unsigned int idx, const char *tag, const char *file, int line, const char *func, const char *name);
692
693
694 /*!
695  \page AstObj2_Containers AstObj2 Containers
696
697 Containers are data structures meant to store several objects,
698 and perform various operations on them.
699 Internally, objects are stored in lists, hash tables or other
700 data structures depending on the needs.
701
702 \note NOTA BENE: at the moment the only container we support is the
703     hash table and its degenerate form, the list.
704
705 Operations on container include:
706
707   -  c = \b ao2_container_alloc(size, hash_fn, cmp_fn)
708     allocate a container with desired size and default compare
709     and hash function
710          -The compare function returns an int, which
711          can be 0 for not found, CMP_STOP to stop end a traversal,
712          or CMP_MATCH if they are equal
713          -The hash function returns an int. The hash function
714          takes two argument, the object pointer and a flags field,
715
716   -  \b ao2_find(c, arg, flags)
717     returns zero or more elements matching a given criteria
718     (specified as arg). 'c' is the container pointer. Flags
719     can be:
720     OBJ_UNLINK - to remove the object, once found, from the container.
721     OBJ_NODATA - don't return the object if found (no ref count change)
722     OBJ_MULTIPLE - don't stop at first match
723     OBJ_POINTER - if set, 'arg' is an object pointer, and a hash table
724                   search will be done. If not, a traversal is done.
725     OBJ_KEY - if set, 'arg', is a hashable item that is not an object.
726               Similar to OBJ_POINTER and mutually exclusive.
727
728   -  \b ao2_callback(c, flags, fn, arg)
729     apply fn(obj, arg) to all objects in the container.
730     Similar to find. fn() can tell when to stop, and
731     do anything with the object including unlinking it.
732       - c is the container;
733       - flags can be
734          OBJ_UNLINK   - to remove the object, once found, from the container.
735          OBJ_NODATA   - don't return the object if found (no ref count change)
736          OBJ_MULTIPLE - don't stop at first match
737          OBJ_POINTER  - if set, 'arg' is an object pointer, and a hash table
738                         search will be done. If not, a traversal is done through
739                         all the hash table 'buckets'..
740          OBJ_KEY      - if set, 'arg', is a hashable item that is not an object.
741                         Similar to OBJ_POINTER and mutually exclusive.
742       - fn is a func that returns int, and takes 3 args:
743         (void *obj, void *arg, int flags);
744           obj is an object
745           arg is the same as arg passed into ao2_callback
746           flags is the same as flags passed into ao2_callback
747          fn returns:
748            0: no match, keep going
749            CMP_STOP: stop search, no match
750            CMP_MATCH: This object is matched.
751
752     Note that the entire operation is run with the container
753     locked, so nobody else can change its content while we work on it.
754     However, we pay this with the fact that doing
755     anything blocking in the callback keeps the container
756     blocked.
757     The mechanism is very flexible because the callback function fn()
758     can do basically anything e.g. counting, deleting records, etc.
759     possibly using arg to store the results.
760
761   -  \b iterate on a container
762     this is done with the following sequence
763
764 \code
765
766         struct ao2_container *c = ... // our container
767         struct ao2_iterator i;
768         void *o;
769
770         i = ao2_iterator_init(c, flags);
771
772         while ((o = ao2_iterator_next(&i))) {
773             ... do something on o ...
774             ao2_ref(o, -1);
775         }
776
777         ao2_iterator_destroy(&i);
778 \endcode
779
780     The difference with the callback is that the control
781     on how to iterate is left to us.
782
783     - \b ao2_ref(c, -1)
784     dropping a reference to a container destroys it, very simple!
785
786 Containers are ao2 objects themselves, and this is why their
787 implementation is simple too.
788
789 Before declaring containers, we need to declare the types of the
790 arguments passed to the constructor - in turn, this requires
791 to define callback and hash functions and their arguments.
792
793 - \ref AstObj2
794 - \ref astobj2.h
795  */
796
797 /*! \brief
798  * Type of a generic callback function
799  * \param obj  pointer to the (user-defined part) of an object.
800  * \param arg callback argument from ao2_callback()
801  * \param flags flags from ao2_callback()
802  *
803  * The return values are a combination of enum _cb_results.
804  * Callback functions are used to search or manipulate objects in a container.
805  */
806 typedef int (ao2_callback_fn)(void *obj, void *arg, int flags);
807
808 /*! \brief
809  * Type of a generic callback function
810  * \param obj pointer to the (user-defined part) of an object.
811  * \param arg callback argument from ao2_callback()
812  * \param data arbitrary data from ao2_callback()
813  * \param flags flags from ao2_callback()
814  *
815  * The return values are a combination of enum _cb_results.
816  * Callback functions are used to search or manipulate objects in a container.
817  */
818 typedef int (ao2_callback_data_fn)(void *obj, void *arg, void *data, int flags);
819
820 /*! \brief A common ao2_callback is one that matches by address. */
821 int ao2_match_by_addr(void *obj, void *arg, int flags);
822
823 /*! \brief
824  * A callback function will return a combination of CMP_MATCH and CMP_STOP.
825  * The latter will terminate the search in a container.
826  */
827 enum _cb_results {
828         CMP_MATCH       = 0x1,  /*!< the object matches the request */
829         CMP_STOP        = 0x2,  /*!< stop the search now */
830 };
831
832 /*! \brief
833  * Flags passed to ao2_callback() and ao2_hash_fn() to modify its behaviour.
834  */
835 enum search_flags {
836         /*!
837          * Unlink the object for which the callback function returned
838          * CMP_MATCH.
839          */
840         OBJ_UNLINK = (1 << 0),
841         /*!
842          * On match, don't return the object hence do not increase its
843          * refcount.
844          */
845         OBJ_NODATA = (1 << 1),
846         /*!
847          * Don't stop at the first match in ao2_callback() unless the
848          * result of of the callback function has the CMP_STOP bit set.
849          */
850         OBJ_MULTIPLE = (1 << 2),
851         /*!
852          * The given obj is an object of the same type as the one being
853          * searched for, so use the object's hash function for optimized
854          * searching.
855          *
856          * The matching function is unaffected (i.e. The cb_fn argument
857          * to ao2_callback).
858          */
859         OBJ_POINTER = (1 << 3),
860         /*!
861          * \brief Continue if a match is not found in the hashed out bucket
862          *
863          * This flag is to be used in combination with OBJ_POINTER.  This tells
864          * the ao2_callback() core to keep searching through the rest of the
865          * buckets if a match is not found in the starting bucket defined by
866          * the hash value on the argument.
867          */
868         OBJ_CONTINUE = (1 << 4),
869         /*!
870          * \brief Assume that the ao2_container is already locked.
871          *
872          * \note For ao2_containers that have mutexes, no locking will
873          * be done.
874          *
875          * \note For ao2_containers that have RWLOCKs, the lock will be
876          * promoted to write mode as needed.  The lock will be returned
877          * to the original locked state.
878          *
879          * \note Only use this flag if the ao2_container is manually
880          * locked already.
881          */
882         OBJ_NOLOCK = (1 << 5),
883         /*!
884          * \brief The data is hashable, but is not an object.
885          *
886          * \details
887          * This can be used when you want to be able to pass custom data
888          * to the container's stored ao2_hash_fn and ao2_find
889          * ao2_callback_fn functions that is not a full object, but
890          * perhaps just a string.
891          *
892          * \note OBJ_KEY and OBJ_POINTER are mutually exclusive options.
893          */
894         OBJ_KEY = (1 << 6),
895 };
896
897 /*!
898  * Type of a generic function to generate a hash value from an object.
899  * flags is ignored at the moment. Eventually, it will include the
900  * value of OBJ_POINTER passed to ao2_callback().
901  */
902 typedef int (ao2_hash_fn)(const void *obj, int flags);
903
904 /*! \name Object Containers
905  * Here start declarations of containers.
906  */
907 /*@{ */
908 struct ao2_container;
909
910 /*!
911  * \brief Allocate and initialize a hash container with the desired number of buckets.
912  *
913  * \details
914  * We allocate space for a struct astobj_container, struct container
915  * and the buckets[] array.
916  *
917  * \param options Container ao2 object options (See enum ao2_alloc_opts)
918  * \param n_buckets Number of buckets for hash
919  * \param hash_fn Pointer to a function computing a hash value. (NULL if everyting goes in first bucket.)
920  * \param cmp_fn Pointer to a compare function used by ao2_find. (NULL to match everything)
921  * \param tag used for debugging.
922  *
923  * \return A pointer to a struct container.
924  *
925  * \note Destructor is set implicitly.
926  */
927
928 #if defined(REF_DEBUG)
929
930 #define ao2_t_container_alloc_options(options, n_buckets, hash_fn, cmp_fn, tag) \
931         __ao2_container_alloc_debug((options), (n_buckets), (hash_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
932 #define ao2_container_alloc_options(options, n_buckets, hash_fn, cmp_fn) \
933         __ao2_container_alloc_debug((options), (n_buckets), (hash_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
934
935 #define ao2_t_container_alloc(n_buckets, hash_fn, cmp_fn, tag) \
936         __ao2_container_alloc_debug(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
937 #define ao2_container_alloc(n_buckets, hash_fn, cmp_fn) \
938         __ao2_container_alloc_debug(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
939
940 #elif defined(__AST_DEBUG_MALLOC)
941
942 #define ao2_t_container_alloc_options(options, n_buckets, hash_fn, cmp_fn, tag) \
943         __ao2_container_alloc_debug((options), (n_buckets), (hash_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
944 #define ao2_container_alloc_options(options, n_buckets, hash_fn, cmp_fn) \
945         __ao2_container_alloc_debug((options), (n_buckets), (hash_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
946
947 #define ao2_t_container_alloc(n_buckets, hash_fn, cmp_fn, tag) \
948         __ao2_container_alloc_debug(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
949 #define ao2_container_alloc(n_buckets, hash_fn, cmp_fn) \
950         __ao2_container_alloc_debug(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
951
952 #else
953
954 #define ao2_t_container_alloc_options(options, n_buckets, hash_fn, cmp_fn, tag) \
955         __ao2_container_alloc((options), (n_buckets), (hash_fn), (cmp_fn))
956 #define ao2_container_alloc_options(options, n_buckets, hash_fn, cmp_fn) \
957         __ao2_container_alloc((options), (n_buckets), (hash_fn), (cmp_fn))
958
959 #define ao2_t_container_alloc(n_buckets, hash_fn, cmp_fn, tag) \
960         __ao2_container_alloc(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn))
961 #define ao2_container_alloc(n_buckets, hash_fn, cmp_fn) \
962         __ao2_container_alloc(AO2_ALLOC_OPT_LOCK_MUTEX, (n_buckets), (hash_fn), (cmp_fn))
963
964 #endif
965
966 struct ao2_container *__ao2_container_alloc(unsigned int options,
967         unsigned int n_buckets, ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn);
968 struct ao2_container *__ao2_container_alloc_debug(unsigned int options,
969         unsigned int n_buckets, ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn,
970         const char *tag, const char *file, int line, const char *func, int ref_debug);
971
972 /*! \brief
973  * Returns the number of elements in a container.
974  */
975 int ao2_container_count(struct ao2_container *c);
976
977 /*!
978  * \brief Copy all object references in the src container into the dest container.
979  * \since 11.0
980  *
981  * \param dest Container to copy src object references into.
982  * \param src Container to copy all object references from.
983  * \param flags OBJ_NOLOCK if a lock is already held on both containers.
984  *    Otherwise, the src container is locked first.
985  *
986  * \pre The dest container must be empty.  If the duplication fails, the
987  * dest container will be returned empty.
988  *
989  * \note This can potentially be expensive because a malloc is
990  * needed for every object in the src container.
991  *
992  * \retval 0 on success.
993  * \retval -1 on error.
994  */
995 int ao2_container_dup(struct ao2_container *dest, struct ao2_container *src, enum search_flags flags);
996
997 /*!
998  * \brief Create a clone/copy of the given container.
999  * \since 11.0
1000  *
1001  * \param orig Container to copy all object references from.
1002  * \param flags OBJ_NOLOCK if a lock is already held on the container.
1003  *
1004  * \note This can potentially be expensive because a malloc is
1005  * needed for every object in the orig container.
1006  *
1007  * \retval Clone container on success.
1008  * \retval NULL on error.
1009  */
1010 struct ao2_container *__ao2_container_clone(struct ao2_container *orig, enum search_flags flags);
1011 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);
1012 #if defined(REF_DEBUG)
1013
1014 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone_debug(orig, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1015 #define ao2_container_clone(orig, flags)                __ao2_container_clone_debug(orig, flags, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, 1)
1016
1017 #elif defined(__AST_DEBUG_MALLOC)
1018
1019 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone_debug(orig, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1020 #define ao2_container_clone(orig, flags)                __ao2_container_clone_debug(orig, flags, "", __FILE__, __LINE__, __PRETTY_FUNCTION__, 0)
1021
1022 #else
1023
1024 #define ao2_t_container_clone(orig, flags, tag) __ao2_container_clone(orig, flags)
1025 #define ao2_container_clone(orig, flags)                __ao2_container_clone(orig, flags)
1026
1027 #endif
1028
1029 /*@} */
1030
1031 /*! \name Object Management
1032  * Here we have functions to manage objects.
1033  *
1034  * We can use the functions below on any kind of
1035  * object defined by the user.
1036  */
1037 /*@{ */
1038
1039 /*!
1040  * \brief Add an object to a container.
1041  *
1042  * \param container The container to operate on.
1043  * \param obj The object to be added.
1044  * \param flags search_flags to control linking the object.  (OBJ_NOLOCK)
1045  * \param tag used for debugging.
1046  *
1047  * \retval NULL on errors.
1048  * \retval !NULL on success.
1049  *
1050  * This function inserts an object in a container according its key.
1051  *
1052  * \note Remember to set the key before calling this function.
1053  *
1054  * \note This function automatically increases the reference count to account
1055  *       for the reference that the container now holds to the object.
1056  */
1057 #ifdef REF_DEBUG
1058
1059 #define ao2_t_link(container, obj, tag)                                 __ao2_link_debug((container), (obj), 0, (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1060 #define ao2_link(container, obj)                                                __ao2_link_debug((container), (obj), 0, "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1061
1062 #define ao2_t_link_flags(container, obj, flags, tag)    __ao2_link_debug((container), (obj), (flags), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1063 #define ao2_link_flags(container, obj, flags)                   __ao2_link_debug((container), (obj), (flags), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1064
1065 #else
1066
1067 #define ao2_t_link(container, obj, tag)                                 __ao2_link((container), (obj), 0)
1068 #define ao2_link(container, obj)                                                __ao2_link((container), (obj), 0)
1069
1070 #define ao2_t_link_flags(container, obj, flags, tag)    __ao2_link((container), (obj), (flags))
1071 #define ao2_link_flags(container, obj, flags)                   __ao2_link((container), (obj), (flags))
1072
1073 #endif
1074
1075 void *__ao2_link_debug(struct ao2_container *c, void *obj_new, int flags, const char *tag, const char *file, int line, const char *func);
1076 void *__ao2_link(struct ao2_container *c, void *obj_new, int flags);
1077
1078 /*!
1079  * \brief Remove an object from a container
1080  *
1081  * \param container The container to operate on.
1082  * \param obj The object to unlink.
1083  * \param flags search_flags to control unlinking the object.  (OBJ_NOLOCK)
1084  * \param tag used for debugging.
1085  *
1086  * \retval NULL, always
1087  *
1088  * \note The object requested to be unlinked must be valid.  However, if it turns
1089  *       out that it is not in the container, this function is still safe to
1090  *       be called.
1091  *
1092  * \note If the object gets unlinked from the container, the container's
1093  *       reference to the object will be automatically released. (The
1094  *       refcount will be decremented).
1095  */
1096 #ifdef REF_DEBUG
1097
1098 #define ao2_t_unlink(container, obj, tag)                               __ao2_unlink_debug((container), (obj), 0, (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1099 #define ao2_unlink(container, obj)                                              __ao2_unlink_debug((container), (obj), 0, "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1100
1101 #define ao2_t_unlink_flags(container, obj, flags, tag)  __ao2_unlink_debug((container), (obj), (flags), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1102 #define ao2_unlink_flags(container, obj, flags)                 __ao2_unlink_debug((container), (obj), (flags), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1103
1104 #else
1105
1106 #define ao2_t_unlink(container, obj, tag)                               __ao2_unlink((container), (obj), 0)
1107 #define ao2_unlink(container, obj)                                              __ao2_unlink((container), (obj), 0)
1108
1109 #define ao2_t_unlink_flags(container, obj, flags, tag)  __ao2_unlink((container), (obj), (flags))
1110 #define ao2_unlink_flags(container, obj, flags)                 __ao2_unlink((container), (obj), (flags))
1111
1112 #endif
1113
1114 void *__ao2_unlink_debug(struct ao2_container *c, void *obj, int flags, const char *tag, const char *file, int line, const char *func);
1115 void *__ao2_unlink(struct ao2_container *c, void *obj, int flags);
1116
1117
1118 /*@} */
1119
1120 /*! \brief
1121  * ao2_callback() is a generic function that applies cb_fn() to all objects
1122  * in a container, as described below.
1123  *
1124  * \param c A pointer to the container to operate on.
1125  * \param flags A set of flags specifying the operation to perform,
1126  *  partially used by the container code, but also passed to
1127  *  the callback.
1128  *   - If OBJ_NODATA is set, ao2_callback will return NULL. No refcounts
1129  *     of any of the traversed objects will be incremented.
1130  *     On the converse, if it is NOT set (the default), the ref count
1131  *     of the first matching object will be incremented and returned.  If
1132  *     OBJ_MULTIPLE is set, the ref count of all matching objects will
1133  *     be incremented in an iterator for a temporary container and returned.
1134  *   - If OBJ_POINTER is set, the traversed items will be restricted
1135  *     to the objects in the bucket that the object key hashes to.
1136  * \param cb_fn A function pointer, that will be called on all
1137  *  objects, to see if they match. This function returns CMP_MATCH
1138  *  if the object is matches the criteria; CMP_STOP if the traversal
1139  *  should immediately stop, or both (via bitwise ORing), if you find a
1140  *  match and want to end the traversal, and 0 if the object is not a match,
1141  *  but the traversal should continue. This is the function that is applied
1142  *  to each object traversed. Its arguments are:
1143  *      (void *obj, void *arg, int flags), where:
1144  *        obj is an object
1145  *        arg is the same as arg passed into ao2_callback
1146  *        flags is the same as flags passed into ao2_callback (flags are
1147  *         also used by ao2_callback).
1148  * \param arg passed to the callback.
1149  * \param tag used for debugging.
1150  *
1151  * \retval NULL on failure or no matching object found.
1152  *
1153  * \retval object found if OBJ_MULTIPLE is not set in the flags
1154  * parameter.
1155  *
1156  * \retval ao2_iterator pointer if OBJ_MULTIPLE is set in the
1157  * flags parameter.  The iterator must be destroyed with
1158  * ao2_iterator_destroy() when the caller no longer needs it.
1159  *
1160  * If the function returns any objects, their refcount is incremented,
1161  * and the caller is in charge of decrementing them once done.
1162  *
1163  * Typically, ao2_callback() is used for two purposes:
1164  * - to perform some action (including removal from the container) on one
1165  *   or more objects; in this case, cb_fn() can modify the object itself,
1166  *   and to perform deletion should set CMP_MATCH on the matching objects,
1167  *   and have OBJ_UNLINK set in flags.
1168  * - to look for a specific object in a container; in this case, cb_fn()
1169  *   should not modify the object, but just return a combination of
1170  *   CMP_MATCH and CMP_STOP on the desired object.
1171  * Other usages are also possible, of course.
1172  *
1173  * This function searches through a container and performs operations
1174  * on objects according on flags passed.
1175  * XXX describe better
1176  * The comparison is done calling the compare function set implicitly.
1177  * The arg pointer can be a pointer to an object or to a key,
1178  * we can say this looking at flags value.
1179  * If arg points to an object we will search for the object pointed
1180  * by this value, otherwise we search for a key value.
1181  * If the key is not unique we only find the first matching value.
1182  *
1183  * The use of flags argument is the follow:
1184  *
1185  *      OBJ_UNLINK              unlinks the object found
1186  *      OBJ_NODATA              on match, do return an object
1187  *                              Callbacks use OBJ_NODATA as a default
1188  *                              functions such as find() do
1189  *      OBJ_MULTIPLE            return multiple matches
1190  *                              Default is no.
1191  *      OBJ_POINTER             the pointer is an object pointer
1192  *      OBJ_KEY                 the pointer is to a hashable key
1193  *
1194  * \note When the returned object is no longer in use, ao2_ref() should
1195  * be used to free the additional reference possibly created by this function.
1196  *
1197  * @{
1198  */
1199 #ifdef REF_DEBUG
1200
1201 #define ao2_t_callback(c, flags, cb_fn, arg, tag) \
1202         __ao2_callback_debug((c), (flags), (cb_fn), (arg), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1203 #define ao2_callback(c, flags, cb_fn, arg) \
1204         __ao2_callback_debug((c), (flags), (cb_fn), (arg), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1205
1206 #else
1207
1208 #define ao2_t_callback(c, flags, cb_fn, arg, tag) \
1209         __ao2_callback((c), (flags), (cb_fn), (arg))
1210 #define ao2_callback(c, flags, cb_fn, arg) \
1211         __ao2_callback((c), (flags), (cb_fn), (arg))
1212
1213 #endif
1214
1215 void *__ao2_callback_debug(struct ao2_container *c, enum search_flags flags,
1216         ao2_callback_fn *cb_fn, void *arg, const char *tag, const char *file, int line,
1217         const char *func);
1218 void *__ao2_callback(struct ao2_container *c, enum search_flags flags, ao2_callback_fn *cb_fn, void *arg);
1219
1220 /*! @} */
1221
1222 /*! \brief
1223  * ao2_callback_data() is a generic function that applies cb_fn() to all objects
1224  * in a container.  It is functionally identical to ao2_callback() except that
1225  * instead of taking an ao2_callback_fn *, it takes an ao2_callback_data_fn *, and
1226  * allows the caller to pass in arbitrary data.
1227  *
1228  * This call would be used instead of ao2_callback() when the caller needs to pass
1229  * OBJ_POINTER as part of the flags argument (which in turn requires passing in a
1230  * prototype ao2 object for 'arg') and also needs access to other non-global data
1231  * to complete it's comparison or task.
1232  *
1233  * See the documentation for ao2_callback() for argument descriptions.
1234  *
1235  * \see ao2_callback()
1236  */
1237 #ifdef REF_DEBUG
1238
1239 #define ao2_t_callback_data(container, flags, cb_fn, arg, data, tag) \
1240         __ao2_callback_data_debug((container), (flags), (cb_fn), (arg), (data), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1241 #define ao2_callback_data(container, flags, cb_fn, arg, data) \
1242         __ao2_callback_data_debug((container), (flags), (cb_fn), (arg), (data), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1243
1244 #else
1245
1246 #define ao2_t_callback_data(container, flags, cb_fn, arg, data, tag) \
1247         __ao2_callback_data((container), (flags), (cb_fn), (arg), (data))
1248 #define ao2_callback_data(container, flags, cb_fn, arg, data) \
1249         __ao2_callback_data((container), (flags), (cb_fn), (arg), (data))
1250
1251 #endif
1252
1253 void *__ao2_callback_data_debug(struct ao2_container *c, enum search_flags flags,
1254         ao2_callback_data_fn *cb_fn, void *arg, void *data, const char *tag, const char *file,
1255         int line, const char *func);
1256 void *__ao2_callback_data(struct ao2_container *c, enum search_flags flags,
1257         ao2_callback_data_fn *cb_fn, void *arg, void *data);
1258
1259 /*! ao2_find() is a short hand for ao2_callback(c, flags, c->cmp_fn, arg)
1260  * XXX possibly change order of arguments ?
1261  */
1262 #ifdef REF_DEBUG
1263
1264 #define ao2_t_find(container, arg, flags, tag) \
1265         __ao2_find_debug((container), (arg), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1266 #define ao2_find(container, arg, flags) \
1267         __ao2_find_debug((container), (arg), (flags), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
1268
1269 #else
1270
1271 #define ao2_t_find(container, arg, flags, tag) \
1272         __ao2_find((container), (arg), (flags))
1273 #define ao2_find(container, arg, flags) \
1274         __ao2_find((container), (arg), (flags))
1275
1276 #endif
1277
1278 void *__ao2_find_debug(struct ao2_container *c, const void *arg, enum search_flags flags,
1279         const char *tag, const char *file, int line, const char *func);
1280 void *__ao2_find(struct ao2_container *c, const void *arg, enum search_flags flags);
1281
1282 /*! \brief
1283  *
1284  *
1285  * When we need to walk through a container, we use an
1286  * ao2_iterator to keep track of the current position.
1287  *
1288  * Because the navigation is typically done without holding the
1289  * lock on the container across the loop, objects can be inserted or deleted
1290  * or moved while we work. As a consequence, there is no guarantee that
1291  * we manage to touch all the elements in the container, and it is possible
1292  * that we touch the same object multiple times.
1293  *
1294  * However, within the current hash table container, the following is true:
1295  *  - It is not possible to miss an object in the container while iterating
1296  *    unless it gets added after the iteration begins and is added to a bucket
1297  *    that is before the one the current object is in.  In this case, even if
1298  *    you locked the container around the entire iteration loop, you still would
1299  *    not see this object, because it would still be waiting on the container
1300  *    lock so that it can be added.
1301  *  - It would be extremely rare to see an object twice.  The only way this can
1302  *    happen is if an object got unlinked from the container and added again
1303  *    during the same iteration.  Furthermore, when the object gets added back,
1304  *    it has to be in the current or later bucket for it to be seen again.
1305  *
1306  * An iterator must be first initialized with ao2_iterator_init(),
1307  * then we can use o = ao2_iterator_next() to move from one
1308  * element to the next. Remember that the object returned by
1309  * ao2_iterator_next() has its refcount incremented,
1310  * and the reference must be explicitly released when done with it.
1311  *
1312  * In addition, ao2_iterator_init() will hold a reference to the container
1313  * being iterated, which will be freed when ao2_iterator_destroy() is called
1314  * to free up the resources used by the iterator (if any).
1315  *
1316  * Example:
1317  *
1318  *  \code
1319  *
1320  *  struct ao2_container *c = ... // the container we want to iterate on
1321  *  struct ao2_iterator i;
1322  *  struct my_obj *o;
1323  *
1324  *  i = ao2_iterator_init(c, flags);
1325  *
1326  *  while ((o = ao2_iterator_next(&i))) {
1327  *     ... do something on o ...
1328  *     ao2_ref(o, -1);
1329  *  }
1330  *
1331  *  ao2_iterator_destroy(&i);
1332  *
1333  *  \endcode
1334  *
1335  */
1336
1337 /*! \brief
1338  * The astobj2 iterator
1339  *
1340  * \note You are not supposed to know the internals of an iterator!
1341  * We would like the iterator to be opaque, unfortunately
1342  * its size needs to be known if we want to store it around
1343  * without too much trouble.
1344  * Anyways...
1345  * The iterator has a pointer to the container, and a flags
1346  * field specifying various things e.g. whether the container
1347  * should be locked or not while navigating on it.
1348  * The iterator "points" to the current object, which is identified
1349  * by three values:
1350  *
1351  * - a bucket number;
1352  * - the object_id, which is also the container version number
1353  *   when the object was inserted. This identifies the object
1354  *   uniquely, however reaching the desired object requires
1355  *   scanning a list.
1356  * - a pointer, and a container version when we saved the pointer.
1357  *   If the container has not changed its version number, then we
1358  *   can safely follow the pointer to reach the object in constant time.
1359  *
1360  * Details are in the implementation of ao2_iterator_next()
1361  * A freshly-initialized iterator has bucket=0, version=0.
1362  */
1363 struct ao2_iterator {
1364         /*! the container */
1365         struct ao2_container *c;
1366         /*! operation flags */
1367         int flags;
1368         /*! current bucket */
1369         int bucket;
1370         /*! container version */
1371         unsigned int c_version;
1372         /*! pointer to the current object */
1373         void *obj;
1374         /*! container version when the object was created */
1375         unsigned int version;
1376 };
1377
1378 /*! Flags that can be passed to ao2_iterator_init() to modify the behavior
1379  * of the iterator.
1380  */
1381 enum ao2_iterator_flags {
1382         /*!
1383          * \brief Assume that the ao2_container is already locked.
1384          *
1385          * \note For ao2_containers that have mutexes, no locking will
1386          * be done.
1387          *
1388          * \note For ao2_containers that have RWLOCKs, the lock will be
1389          * promoted to write mode as needed.  The lock will be returned
1390          * to the original locked state.
1391          *
1392          * \note Only use this flag if the ao2_container is manually
1393          * locked already.
1394          */
1395         AO2_ITERATOR_DONTLOCK = (1 << 0),
1396         /*!
1397          * Indicates that the iterator was dynamically allocated by
1398          * astobj2 API and should be freed by ao2_iterator_destroy().
1399          */
1400         AO2_ITERATOR_MALLOCD = (1 << 1),
1401         /*!
1402          * Indicates that before the iterator returns an object from
1403          * the container being iterated, the object should be unlinked
1404          * from the container.
1405          */
1406         AO2_ITERATOR_UNLINK = (1 << 2),
1407 };
1408
1409 /*!
1410  * \brief Create an iterator for a container
1411  *
1412  * \param c the container
1413  * \param flags one or more flags from ao2_iterator_flags
1414  *
1415  * \retval the constructed iterator
1416  *
1417  * \note This function does \b not take a pointer to an iterator;
1418  *       rather, it returns an iterator structure that should be
1419  *       assigned to (overwriting) an existing iterator structure
1420  *       allocated on the stack or on the heap.
1421  *
1422  * This function will take a reference on the container being iterated.
1423  *
1424  */
1425 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags);
1426
1427 /*!
1428  * \brief Destroy a container iterator
1429  *
1430  * \param iter the iterator to destroy
1431  *
1432  * \retval none
1433  *
1434  * This function will release the container reference held by the iterator
1435  * and any other resources it may be holding.
1436  *
1437  */
1438 #if defined(TEST_FRAMEWORK)
1439 void ao2_iterator_destroy(struct ao2_iterator *iter) __attribute__((noinline));
1440 #else
1441 void ao2_iterator_destroy(struct ao2_iterator *iter);
1442 #endif
1443 #ifdef REF_DEBUG
1444
1445 #define ao2_t_iterator_next(iter, tag) __ao2_iterator_next_debug((iter), (tag),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1446 #define ao2_iterator_next(iter)        __ao2_iterator_next_debug((iter), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
1447
1448 #else
1449
1450 #define ao2_t_iterator_next(iter, tag) __ao2_iterator_next((iter))
1451 #define ao2_iterator_next(iter)        __ao2_iterator_next((iter))
1452
1453 #endif
1454
1455 void *__ao2_iterator_next_debug(struct ao2_iterator *iter, const char *tag, const char *file, int line, const char *func);
1456 void *__ao2_iterator_next(struct ao2_iterator *iter);
1457
1458 /* extra functions */
1459 void ao2_bt(void);      /* backtrace */
1460
1461 #endif /* _ASTERISK_ASTOBJ2_H */