Merged revisions 80362 via svnmerge from
[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/lock.h"
21
22 /*! \file 
23  *
24  * \brief Object Model implementing objects and containers.
25
26 These functions implement an abstraction for objects (with
27 locks and reference counts) and containers for these user-defined objects,
28 supporting locking, reference counting and callbacks.
29
30 The internal implementation of the container is opaque to the user,
31 so we can use different data structures as needs arise.
32
33 At the moment, however, the only internal data structure is a hash
34 table. When other structures will be implemented, the initialization
35 function may change.
36
37 USAGE - OBJECTS
38
39 An object is a block of memory that must be allocated with the
40 function ao2_alloc(), and for which the system keeps track (with
41 abit of help from the programmer) of the number of references around.
42 When an object has no more references, it is destroyed, by first
43 invoking whatever 'destructor' function the programmer specifies
44 (it can be NULL), and then freeing the memory.
45 This way objects can be shared without worrying who is in charge
46 of freeing them.
47
48 Basically, creating an object requires the size of the object and
49 and a pointer to the destructor function:
50  
51     struct foo *o;
52  
53     o = ao2_alloc(sizeof(struct foo), my_destructor_fn);
54
55 The object returned has a refcount = 1.
56 Note that the memory for the object is allocated and zeroed.
57 - We cannot realloc() the object itself.
58 - We cannot call free(o) to dispose of the object; rather we
59   tell the system that we do not need the reference anymore:
60
61     ao2_ref(o, -1)
62
63   causing the destructor to be called (and then memory freed) when
64   the refcount goes to 0. This is also available as ao2_unref(o),
65   and returns NULL as a convenience, so you can do things like
66         o = ao2_unref(o);
67   and clean the original pointer to prevent errors.
68
69 - ao2_ref(o, +1) can be used to modify the refcount on the
70   object in case we want to pass it around.
71         
72
73 - other calls on the object are ao2_lock(obj), ao2_unlock(),
74   ao2_trylock(), to manipulate the lock.
75
76
77 USAGE - CONTAINERS
78
79 A containers is an abstract data structure where we can store
80 objects, search them (hopefully in an efficient way), and iterate
81 or apply a callback function to them. A container is just an object
82 itself.
83
84 A container must first be allocated, specifying the initial
85 parameters. At the moment, this is done as follows:
86
87     <b>Sample Usage:</b>
88     \code
89
90     ao2_container *c;
91
92     c = ao2_container_alloc(MAX_BUCKETS, my_hash_fn, my_cmp_fn, my_dump_fn);
93
94 where
95 - MAX_BUCKETS is the number of buckets in the hash table,
96 - my_hash_fn() is the (user-supplied) function that returns a
97   hash key for the object (further reduced moduly MAX_BUCKETS
98   by the container's code);
99 - my_cmp_fn() is the default comparison function used when doing
100   searches on the container,
101 - my_dump_fn() is a helper function used only for debugging.
102
103 A container knows little or nothing about the object itself,
104 other than the fact that it has been created by ao2_alloc()
105 All knowledge of the (user-defined) internals of the object
106 is left to the (user-supplied) functions passed as arguments
107 to ao2_container_alloc().
108
109 If we want to insert the object in the container, we should
110 initialize its fields -- especially, those used by my_hash_fn() --
111 to compute the bucket to use.
112 Once done, we can link an object to a container with
113
114     ao2_link(c, o);
115
116 The function returns NULL in case of errors (and the object
117 is not inserted in the container). Other values mean success
118 (we are not supposed to use the value as a pointer to anything).
119
120 \note inserting the object in the container grabs the reference
121 to the object (which is now owned by the container) so we do not
122 need to drop ours when we are done.
123
124 \note While an object o is in a container, we expect that
125 my_hash_fn(o) will always return the same value. The function
126 does not lock the object to be computed, so modifications of
127 those fields that affect the computation of the hash should
128 be done by extractiong the object from the container, and
129 reinserting it after the change (this is not terribly expensive).
130
131 \note A container with a single buckets is effectively a linked
132 list. However there is no ordering among elements.
133
134 Objects implement a reference counter keeping the count
135 of the number of references that reference an object.
136
137 When this number becomes zero the destructor will be
138 called and the object will be free'd.
139  */
140
141 /*!
142  * Invoked just before freeing the memory for the object.
143  * It is passed a pointer to user data.
144  */
145 typedef void (*ao2_destructor_fn)(void *);
146
147 void ao2_bt(void);      /* backtrace */
148 /*!
149  * Allocate and initialize an object.
150  * 
151  * \param data_size The sizeof() of user-defined structure.
152  * \param destructor_fn The function destructor (can be NULL)
153  * \return A pointer to user data. 
154  *
155  * Allocates a struct astobj2 with sufficient space for the
156  * user-defined structure.
157  * \notes:
158  * - storage is zeroed; XXX maybe we want a flag to enable/disable this.
159  * - the refcount of the object just created is 1
160  * - the returned pointer cannot be free()'d or realloc()'ed;
161  *   rather, we just call ao2_ref(o, -1);
162  */
163 void *ao2_alloc(const size_t data_size, ao2_destructor_fn destructor_fn);
164
165 /*!
166  * Reference/unreference an object and return the old refcount.
167  *
168  * \param o A pointer to the object
169  * \param delta Value to add to the reference counter.
170  * \return The value of the reference counter before the operation.
171  *
172  * Increase/decrease the reference counter according
173  * the value of delta.
174  *
175  * If the refcount goes to zero, the object is destroyed.
176  *
177  * \note The object must not be locked by the caller of this function, as
178  *       it is invalid to try to unlock it after releasing the reference.
179  *
180  * \note if we know the pointer to an object, it is because we
181  * have a reference count to it, so the only case when the object
182  * can go away is when we release our reference, and it is
183  * the last one in existence.
184  */
185 int ao2_ref(void *o, int delta);
186
187 /*!
188  * Lock an object.
189  * 
190  * \param a A pointer to the object we want lock.
191  * \return 0 on success, other values on error.
192  */
193 int ao2_lock(void *a);
194
195 /*!
196  * Unlock an object.
197  * 
198  * \param a A pointer to the object we want unlock.
199  * \return 0 on success, other values on error.
200  */
201 int ao2_unlock(void *a);
202
203 /*!
204  *
205  * Containers
206
207 containers are data structures meant to store several objects,
208 and perform various operations on them.
209 Internally, objects are stored in lists, hash tables or other
210 data structures depending on the needs.
211
212 NOTA BENE: at the moment the only container we support is the
213 hash table and its degenerate form, the list.
214
215 Operations on container include:
216
217     c = ao2_container_alloc(size, cmp_fn, hash_fn)
218         allocate a container with desired size and default compare
219         and hash function
220
221     ao2_find(c, arg, flags)
222         returns zero or more element matching a given criteria
223         (specified as arg). Flags indicate how many results we
224         want (only one or all matching entries), and whether we
225         should unlink the object from the container.
226
227     ao2_callback(c, flags, fn, arg)
228         apply fn(obj, arg) to all objects in the container.
229         Similar to find. fn() can tell when to stop, and
230         do anything with the object including unlinking it.
231         Note that the entire operation is run with the container
232         locked, so noone else can change its content while we work on it.
233         However, we pay this with the fact that doing
234         anything blocking in the callback keeps the container
235         blocked.
236         The mechanism is very flexible because the callback function fn()
237         can do basically anything e.g. counting, deleting records, etc.
238         possibly using arg to store the results.
239    
240     iterate on a container
241         this is done with the following sequence
242
243             ao2_container *c = ... // our container
244             ao2_iterator i;
245             void *o;
246
247             i = ao2_iterator_init(c, flags);
248      
249             while ( (o = ao2_iterator_next(&i)) ) {
250                 ... do something on o ...
251                 ao2_ref(o, -1);
252             }
253
254         The difference with the callback is that the control
255         on how to iterate is left to us.
256
257     ao2_ref(c, -1)
258         dropping a reference to a container destroys it, very simple!
259  
260 Containers are astobj2 object themselves, and this is why their
261 implementation is simple too.
262
263  */
264
265 /*!
266  * We can perform different operation on an object. We do this
267  * according the following flags.
268  */
269 enum search_flags {
270         /*! unlink the object found */
271         OBJ_UNLINK       = (1 << 0),
272         /*! on match, don't return the object or increase its reference count. */
273         OBJ_NODATA       = (1 << 1),
274         /*! don't stop at the first match 
275          *  \note This is not fully implemented. */
276         OBJ_MULTIPLE = (1 << 2),
277         /*! obj is an object of the same type as the one being searched for.
278          *  This implies that it can be passed to the object's hash function
279          *  for optimized searching. */
280         OBJ_POINTER      = (1 << 3),
281 };
282
283 /*!
284  * Type of a generic function to generate a hash value from an object.
285  *
286  */
287 typedef int (*ao2_hash_fn)(const void *obj, const int flags);
288
289 /*!
290  * valid callback results:
291  * We return a combination of
292  * CMP_MATCH when the object matches the request,
293  * and CMP_STOP when we should not continue the search further.
294  */
295 enum _cb_results {
296         CMP_MATCH       = 0x1,
297         CMP_STOP        = 0x2,
298 };
299
300 /*!
301  * generic function to compare objects.
302  * This, as other callbacks, should return a combination of
303  * _cb_results as described above.
304  *
305  * \param o     object from container
306  * \param arg   search parameters (directly from ao2_find)
307  * \param flags passed directly from ao2_find
308  *      XXX explain.
309  */
310
311 /*!
312  * Type of a generic callback function
313  * \param obj  pointer to the (user-defined part) of an object.
314  * \param arg callback argument from ao2_callback()
315  * \param flags flags from ao2_callback()
316  * The return values are the same as a compare function.
317  * In fact, they are the same thing.
318  */
319 typedef int (*ao2_callback_fn)(void *obj, void *arg, int flags);
320
321 /*!
322  * Here start declarations of containers.
323  */
324
325 /*!
326  * This structure contains the total number of buckets 
327  * and variable size array of object pointers.
328  * It is opaque, defined in astobj2.c, so we only need
329  * a type declaration.
330  */
331 typedef struct __ao2_container ao2_container;
332
333 /*!
334  * Allocate and initialize a container 
335  * with the desired number of buckets.
336  * 
337  * We allocate space for a struct astobj_container, struct container
338  * and the buckets[] array.
339  *
340  * \param my_hash_fn Pointer to a function computing a hash value.
341  * \param my_cmp_fn Pointer to a function comparating key-value 
342  *                      with a string. (can be NULL)
343  * \return A pointer to a struct container.
344  *
345  * destructor is set implicitly.
346  */
347 ao2_container *ao2_container_alloc(const uint n_buckets,
348                 ao2_hash_fn hash_fn, ao2_callback_fn cmp_fn);
349
350 /*!
351  * Returns the number of elements in a container.
352  */
353 int ao2_container_count(ao2_container *c);
354
355 /*
356  * Here we have functions to manage objects.
357  *
358  * We can use the functions below on any kind of 
359  * object defined by the user.
360  */
361 /*!
362  * Add an object to a container.
363  *
364  * \param c the container to operate on.
365  * \param obj the object to be added.
366  * \return NULL on errors, other values on success.
367  *
368  * This function insert an object in a container according its key.
369  *
370  * \note Remember to set the key before calling this function.
371  */
372 void *ao2_link(ao2_container *c, void *newobj);
373 void *ao2_unlink(ao2_container *c, void *newobj);
374
375 /*! \struct Used as return value if the flag OBJ_MULTIPLE is set */
376 struct ao2_list {
377         struct ao2_list *next;
378         void *obj;      /* pointer to the user portion of the object */
379 };
380
381 /*!
382  * ao2_callback() and astob2_find() are the same thing with only one difference:
383  * the latter uses as a callback the function passed as my_cmp_f() at
384  * the time of the creation of the container.
385  * 
386  * \param c A pointer to the container to operate on.
387  * \param arg passed to the callback.
388  * \param flags A set of flags specifying the operation to perform,
389         partially used by the container code, but also passed to
390         the callback.
391  * \return      A pointer to the object found/marked, 
392  *              a pointer to a list of objects matching comparison function,
393  *              NULL if not found.
394  * If the function returns any objects, their refcount is incremented,
395  * and the caller is in charge of decrementing them once done.
396  * Also, in case of multiple values returned, the list used
397  * to store the objects must be freed by the caller.
398  *
399  * This function searches through a container and performs operations
400  * on objects according on flags passed.
401  * XXX describe better
402  * The comparison is done calling the compare function set implicitly. 
403  * The p pointer can be a pointer to an object or to a key, 
404  * we can say this looking at flags value.
405  * If p points to an object we will search for the object pointed
406  * by this value, otherwise we serch for a key value.
407  * If the key is not uniq we only find the first matching valued.
408  * If we use the OBJ_MARK flags, we mark all the objects matching 
409  * the condition.
410  *
411  * The use of flags argument is the follow:
412  *
413  *      OBJ_UNLINK              unlinks the object found
414  *      OBJ_NODATA              on match, do return an object
415  *                              Callbacks use OBJ_NODATA as a default
416  *                              functions such as find() do
417  *      OBJ_MULTIPLE            return multiple matches
418  *                              Default for _find() is no.
419  *                              to a key (not yet supported)
420  *      OBJ_POINTER             the pointer is an object pointer
421  *
422  * In case we return a list, the callee must take care to destroy 
423  * that list when no longer used.
424  *
425  * \note When the returned object is no longer in use, ao2_ref() should
426  * be used to free the additional reference possibly created by this function.
427  */
428 /* XXX order of arguments to find */
429 void *ao2_find(ao2_container *c, void *arg, enum search_flags flags);
430 void *ao2_callback(ao2_container *c,
431         enum search_flags flags,
432         ao2_callback_fn cb_fn, void *arg);
433
434 /*!
435  *
436
437 When we need to walk through a container, we use
438 ao2_iterator to keep track of the current position.
439
440 Because the navigation is typically done without holding the
441 lock on the container across the loop,
442 objects can be inserted or deleted or moved
443 while we work. As a consequence, there is no guarantee that
444 the we manage to touch all the elements on the list, or it
445 is possible that we touch the same object multiple times.
446
447 An iterator must be first initialized with ao2_iterator_init(),
448 then we can use o = ao2_iterator_next() to move from one
449 element to the next. Remember that the object returned by
450 ao2_iterator_next() has its refcount incremented,
451 and the reference must be explicitly released when done with it.
452 Example:
453
454     \code
455
456     ao2_container *c = ... // the container we want to iterate on
457     ao2_iterator i;
458     struct my_obj *o;
459
460     i = ao2_iterator_init(c, flags);
461  
462     while ( (o = ao2_iterator_next(&i)) ) {
463         ... do something on o ...
464         ao2_ref(o, -1);
465     }
466
467     \endcode
468
469  */
470
471 /*!
472  * You are not supposed to know the internals of an iterator!
473  * We would like the iterator to be opaque, unfortunately
474  * its size needs to be known if we want to store it around
475  * without too much trouble.
476  * Anyways...
477  * The iterator has a pointer to the container, and a flags
478  * field specifying various things e.g. whether the container
479  * should be locked or not while navigating on it.
480  * The iterator "points" to the current object, which is identified
481  * by three values:
482  * - a bucket number;
483  * - the object_id, which is also the container version number
484  *   when the object was inserted. This identifies the object
485  *   univoquely, however reaching the desired object requires
486  *   scanning a list.
487  * - a pointer, and a container version when we saved the pointer.
488  *   If the container has not changed its version number, then we
489  *   can safely follow the pointer to reach the object in constant time.
490  * Details are in the implementation of ao2_iterator_next()
491  * A freshly-initialized iterator has bucket=0, version = 0.
492  */
493
494 struct __ao2_iterator {
495         /*! the container */
496         ao2_container *c;
497         /*! operation flags */
498         int flags;
499 #define F_AO2I_DONTLOCK 1       /*!< don't lock when iterating */
500         /*! current bucket */
501         int bucket;
502         /*! container version */
503         uint c_version;
504         /*! pointer to the current object */
505         void *obj;
506         /*! container version when the object was created */
507         uint version;
508 };              
509 typedef struct __ao2_iterator ao2_iterator;
510
511 ao2_iterator ao2_iterator_init(ao2_container *c, int flags);
512
513 void *ao2_iterator_next(ao2_iterator *a);
514
515 #endif /* _ASTERISK_ASTOBJ2_H */