Merged revisions 81778 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 /*! \file 
21  *
22  * \brief Object Model implementing objects and containers.
23
24 This module implements an abstraction for objects (with locks and
25 reference counts), and containers for these user-defined objects,
26 also supporting locking, reference counting and callbacks.
27
28 The internal implementation of objects and containers is opaque to the user,
29 so we can use different data structures as needs arise.
30
31 USAGE - OBJECTS
32
33 An ao2 object is a block of memory that the user code can access,
34 and for which the system keeps track (with a bit of help from the
35 programmer) of the number of references around.  When an object has
36 no more references (refcount == 0), it is destroyed, by first
37 invoking whatever 'destructor' function the programmer specifies
38 (it can be NULL if none is necessary), and then freeing the memory.
39 This way objects can be shared without worrying who is in charge
40 of freeing them.
41 As an additional feature, ao2 objects are associated to individual
42 locks.
43
44 Creating an object requires the size of the object and
45 and a pointer to the destructor function:
46  
47     struct foo *o;
48  
49     o = ao2_alloc(sizeof(struct foo), my_destructor_fn);
50
51 The value returned points to the user-visible portion of the objects
52 (user-data), but is also used as an identifier for all object-related
53 operations such as refcount and lock manipulations.
54
55 On return from ao2_alloc():
56 - the object has a refcount = 1;
57
58 - the memory for the object is allocated dynamically and zeroed;
59
60 - we cannot realloc() the object itself;
61
62 - we cannot call free(o) to dispose of the object. Rather, we
63   tell the system that we do not need the reference anymore:
64
65     ao2_ref(o, -1)
66
67   causing the destructor to be called (and then memory freed) when
68   the refcount goes to 0. This is also available as ao2_unref(o),
69   and returns NULL as a convenience, so you can do things like
70         o = ao2_unref(o);
71   and clean the original pointer to prevent errors.
72
73 - ao2_ref(o, +1) can be used to modify the refcount on the
74   object in case we want to pass it around.
75
76 - ao2_lock(obj), ao2_unlock(obj), ao2_trylock(obj) can be used
77   to manipulate the lock associated with the object.
78
79
80 USAGE - CONTAINERS
81
82 An ao2 container is an abstract data structure where we can store
83 ao2 objects, search them (hopefully in an efficient way), and iterate
84 or apply a callback function to them. A container is just an ao2 object
85 itself.
86
87 A container must first be allocated, specifying the initial
88 parameters. At the moment, this is done as follows:
89
90     <b>Sample Usage:</b>
91     \code
92
93     struct ao2_container *c;
94
95     c = ao2_container_alloc(MAX_BUCKETS, my_hash_fn, my_cmp_fn);
96     \endcode
97 where
98 - MAX_BUCKETS is the number of buckets in the hash table,
99 - my_hash_fn() is the (user-supplied) function that returns a
100   hash key for the object (further reduced modulo MAX_BUCKETS
101   by the container's code);
102 - my_cmp_fn() is the default comparison function used when doing
103   searches on the container,
104
105 A container knows little or nothing about the objects it stores,
106 other than the fact that they have been created by ao2_alloc().
107 All knowledge of the (user-defined) internals of the objects
108 is left to the (user-supplied) functions passed as arguments
109 to ao2_container_alloc().
110
111 If we want to insert an object in a container, we should
112 initialize its fields -- especially, those used by my_hash_fn() --
113 to compute the bucket to use.
114 Once done, we can link an object to a container with
115
116     ao2_link(c, o);
117
118 The function returns NULL in case of errors (and the object
119 is not inserted in the container). Other values mean success
120 (we are not supposed to use the value as a pointer to anything).
121
122 \note inserting an object in a container grabs the reference
123 to the object (which is now owned by the container), so we do not
124 need to drop our reference - in fact, we don't own it anymore,
125 so we are not even supposed to access the object as someone might
126 delete it.
127
128 \note While an object o is in a container, we expect that
129 my_hash_fn(o) will always return the same value. The function
130 does not lock the object to be computed, so modifications of
131 those fields that affect the computation of the hash should
132 be done by extracting the object from the container, and
133 reinserting it after the change (this is not terribly expensive).
134
135 \note A container with a single buckets is effectively a linked
136 list. However there is no ordering among elements.
137
138  */
139
140 /*!
141  * Typedef for an object destructor. This is called just before freeing
142  * the memory for the object. It is passed a pointer to the user-defined
143  * data of the object.
144  */
145 typedef void (*ao2_destructor_fn)(void *);
146
147
148 /*!
149  * Allocate and initialize an object.
150  * 
151  * \param data_size The sizeof() of the user-defined structure.
152  * \param destructor_fn The destructor function (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  * \note
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             struct ao2_container *c = ... // our container
244             struct 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 ao2 objects themselves, and this is why their
261 implementation is simple too.
262
263  */
264
265 /*!
266  * Before declaring containers, we need to declare the types of the
267  * arguments passed to the constructor - in turn, this requires
268  * to define callback and hash functions and their arguments.
269  */
270
271 /*!
272  * Type of a generic callback function
273  * \param obj  pointer to the (user-defined part) of an object.
274  * \param arg callback argument from ao2_callback()
275  * \param flags flags from ao2_callback()
276  * The return values are a combination of enum _cb_results.
277  * Callback functions are used to search or manipulate objects in a container,
278  */
279 typedef int (ao2_callback_fn)(void *obj, void *arg, int flags);
280
281 /*! a very common callback is one that matches by address. */
282 ao2_callback_fn ao2_match_by_addr;
283
284 /*!
285  * A callback function will return a combination of CMP_MATCH and CMP_STOP.
286  * The latter will terminate the search in a container.
287  */
288 enum _cb_results {
289         CMP_MATCH       = 0x1,  /*!< the object matches the request */
290         CMP_STOP        = 0x2,  /*!< stop the search now */
291 };
292
293 /*!
294  * Flags passed to ao2_callback() and ao2_hash_fn() to modify its behaviour.
295  */
296 enum search_flags {
297         /*! Unlink the object for which the callback function
298          *  returned CMP_MATCH . This is the only way to extract
299          *  objects from a container. */
300         OBJ_UNLINK       = (1 << 0),
301         /*! On match, don't return the object hence do not increase
302          *  its refcount. */
303         OBJ_NODATA       = (1 << 1),
304         /*! Don't stop at the first match in ao2_callback()
305          *  \note This is not fully implemented. */
306         OBJ_MULTIPLE = (1 << 2),
307         /*! obj is an object of the same type as the one being searched for,
308          *  so use the object's hash function for optimized searching.
309          *  The search function is unaffected (i.e. use the one passed as
310          *  argument, or match_by_addr if none specified). */
311         OBJ_POINTER      = (1 << 3),
312 };
313
314 /*!
315  * Type of a generic function to generate a hash value from an object.
316  * flags is ignored at the moment. Eventually, it will include the
317  * value of OBJ_POINTER passed to ao2_callback().
318  */
319 typedef int (ao2_hash_fn)(const void *obj, const int flags);
320
321 /*!
322  * Here start declarations of containers.
323  */
324 struct ao2_container;
325
326 /*!
327  * Allocate and initialize a container 
328  * with the desired number of buckets.
329  * 
330  * We allocate space for a struct astobj_container, struct container
331  * and the buckets[] array.
332  *
333  * \param n_buckets Number of buckets for hash
334  * \param hash_fn Pointer to a function computing a hash value.
335  * \param cmp_fn Pointer to a function comparating key-value 
336  *                      with a string. (can be NULL)
337  * \return A pointer to a struct container.
338  *
339  * destructor is set implicitly.
340  */
341 struct ao2_container *ao2_container_alloc(const uint n_buckets,
342                 ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn);
343
344 /*!
345  * Returns the number of elements in a container.
346  */
347 int ao2_container_count(struct ao2_container *c);
348
349 /*
350  * Here we have functions to manage objects.
351  *
352  * We can use the functions below on any kind of 
353  * object defined by the user.
354  */
355 /*!
356  * Add an object to a container.
357  *
358  * \param c the container to operate on.
359  * \param newobj the object to be added.
360  * \return NULL on errors, other values on success.
361  *
362  * This function insert an object in a container according its key.
363  *
364  * \note Remember to set the key before calling this function.
365  */
366 void *ao2_link(struct ao2_container *c, void *newobj);
367 void *ao2_unlink(struct ao2_container *c, void *newobj);
368
369 /*! \brief Used as return value if the flag OBJ_MULTIPLE is set */
370 struct ao2_list {
371         struct ao2_list *next;
372         void *obj;      /* pointer to the user portion of the object */
373 };
374
375 /*!
376  * ao2_callback() is a generic function that applies cb_fn() to all objects
377  * in a container, as described below.
378  * 
379  * \param c A pointer to the container to operate on.
380  * \param arg passed to the callback.
381  * \param flags A set of flags specifying the operation to perform,
382         partially used by the container code, but also passed to
383         the callback.
384  * \return      A pointer to the object found/marked, 
385  *              a pointer to a list of objects matching comparison function,
386  *              NULL if not found.
387  * If the function returns any objects, their refcount is incremented,
388  * and the caller is in charge of decrementing them once done.
389  * Also, in case of multiple values returned, the list used
390  * to store the objects must be freed by the caller.
391  *
392  * Typically, ao2_callback() is used for two purposes:
393  * - to perform some action (including removal from the container) on one
394  *   or more objects; in this case, cb_fn() can modify the object itself,
395  *   and to perform deletion should set CMP_MATCH on the matching objects,
396  *   and have OBJ_UNLINK set in flags.
397  * - to look for a specific object in a container; in this case, cb_fn()
398  *   should not modify the object, but just return a combination of
399  *   CMP_MATCH and CMP_STOP on the desired object.
400  * Other usages are also possible, of course.
401
402  * This function searches through a container and performs operations
403  * on objects according on flags passed.
404  * XXX describe better
405  * The comparison is done calling the compare function set implicitly. 
406  * The p pointer can be a pointer to an object or to a key, 
407  * we can say this looking at flags value.
408  * If p points to an object we will search for the object pointed
409  * by this value, otherwise we serch for a key value.
410  * If the key is not uniq we only find the first matching valued.
411  * If we use the OBJ_MARK flags, we mark all the objects matching 
412  * the condition.
413  *
414  * The use of flags argument is the follow:
415  *
416  *      OBJ_UNLINK              unlinks the object found
417  *      OBJ_NODATA              on match, do return an object
418  *                              Callbacks use OBJ_NODATA as a default
419  *                              functions such as find() do
420  *      OBJ_MULTIPLE            return multiple matches
421  *                              Default for _find() is no.
422  *                              to a key (not yet supported)
423  *      OBJ_POINTER             the pointer is an object pointer
424  *
425  * In case we return a list, the callee must take care to destroy 
426  * that list when no longer used.
427  *
428  * \note When the returned object is no longer in use, ao2_ref() should
429  * be used to free the additional reference possibly created by this function.
430  */
431 void *ao2_callback(struct ao2_container *c,
432         enum search_flags flags,
433         ao2_callback_fn *cb_fn, void *arg);
434
435 /*! ao2_find() is a short hand for ao2_callback(c, flags, c->cmp_fn, arg)
436  * XXX possibly change order of arguments ?
437  */
438 void *ao2_find(struct ao2_container *c, void *arg, enum search_flags flags);
439
440 /*!
441  *
442  *
443  * When we need to walk through a container, we use
444  * ao2_iterator to keep track of the current position.
445  * 
446  * Because the navigation is typically done without holding the
447  * lock on the container across the loop,
448  * objects can be inserted or deleted or moved
449  * while we work. As a consequence, there is no guarantee that
450  * the we manage to touch all the elements on the list, or it
451  * is possible that we touch the same object multiple times.
452  * However, within the current hash table container, the following is true:
453  *  - It is not possible to miss an object in the container while iterating
454  *    unless it gets added after the iteration begins and is added to a bucket
455  *    that is before the one the current object is in.  In this case, even if
456  *    you locked the container around the entire iteration loop, you still would
457  *    not see this object, because it would still be waiting on the container
458  *    lock so that it can be added.
459  *  - It would be extremely rare to see an object twice.  The only way this can
460  *    happen is if an object got unlinked from the container and added again 
461  *    during the same iteration.  Furthermore, when the object gets added back,
462  *    it has to be in the current or later bucket for it to be seen again.
463  *
464  * An iterator must be first initialized with ao2_iterator_init(),
465  * then we can use o = ao2_iterator_next() to move from one
466  * element to the next. Remember that the object returned by
467  * ao2_iterator_next() has its refcount incremented,
468  * and the reference must be explicitly released when done with it.
469  *
470  * Example:
471  *
472  *  \code
473  *
474  *  struct ao2_container *c = ... // the container we want to iterate on
475  *  struct ao2_iterator i;
476  *  struct my_obj *o;
477  *
478  *  i = ao2_iterator_init(c, flags);
479  *
480  *  while ( (o = ao2_iterator_next(&i)) ) {
481  *     ... do something on o ...
482  *     ao2_ref(o, -1);
483  *  }
484  *
485  *  \endcode
486  *
487  */
488
489 /*!
490  * You are not supposed to know the internals of an iterator!
491  * We would like the iterator to be opaque, unfortunately
492  * its size needs to be known if we want to store it around
493  * without too much trouble.
494  * Anyways...
495  * The iterator has a pointer to the container, and a flags
496  * field specifying various things e.g. whether the container
497  * should be locked or not while navigating on it.
498  * The iterator "points" to the current object, which is identified
499  * by three values:
500  * - a bucket number;
501  * - the object_id, which is also the container version number
502  *   when the object was inserted. This identifies the object
503  *   univoquely, however reaching the desired object requires
504  *   scanning a list.
505  * - a pointer, and a container version when we saved the pointer.
506  *   If the container has not changed its version number, then we
507  *   can safely follow the pointer to reach the object in constant time.
508  * Details are in the implementation of ao2_iterator_next()
509  * A freshly-initialized iterator has bucket=0, version = 0.
510  */
511
512 struct ao2_iterator {
513         /*! the container */
514         struct ao2_container *c;
515         /*! operation flags */
516         int flags;
517 #define F_AO2I_DONTLOCK 1       /*!< don't lock when iterating */
518         /*! current bucket */
519         int bucket;
520         /*! container version */
521         uint c_version;
522         /*! pointer to the current object */
523         void *obj;
524         /*! container version when the object was created */
525         uint version;
526 };
527
528 struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags);
529
530 void *ao2_iterator_next(struct ao2_iterator *a);
531
532 /* extra functions */
533 void ao2_bt(void);      /* backtrace */
534 #endif /* _ASTERISK_ASTOBJ2_H */