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