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