Tiny doxygen improvement
[asterisk/asterisk.git] / include / asterisk / threadstorage.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Digium, Inc.
5  *
6  * Russell Bryant <russell@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file threadstorage.h
21  * \author Russell Bryant <russell@digium.com>
22  * \brief Definitions to aid in the use of thread local storage
23  *
24  * \arg \ref AstThreadStorage
25  */
26
27 /*!
28  * \page AstThreadStorage The Asterisk Thread Storage API
29  *
30  *
31  * The POSIX threads (pthreads) API provides the ability to define thread
32  * specific data.  The functions and structures defined here are intended
33  * to centralize the code that is commonly used when using thread local
34  * storage.
35  *
36  * The motivation for using this code in Asterisk is for situations where
37  * storing data on a thread-specific basis can provide some amount of
38  * performance benefit.  For example, there are some call types in Asterisk
39  * where ast_frame structures must be allocated very rapidly (easily 50, 100,
40  * 200 times a second).  Instead of doing the equivalent of that many calls
41  * to malloc() and free() per second, thread local storage is used to keep a
42  * list of unused frame structures so that they can be continuously reused.
43  *
44  * - \ref threadstorage.h
45  */
46
47 #ifndef ASTERISK_THREADSTORAGE_H
48 #define ASTERISK_THREADSTORAGE_H
49
50 #include <pthread.h>
51
52 #include "asterisk/utils.h"
53 #include "asterisk/inline_api.h"
54
55 /*!
56  * \brief data for a thread locally stored variable
57  */
58 struct ast_threadstorage {
59         /*! Ensure that the key is only initialized by one thread */
60         pthread_once_t once;
61         /*! The key used to retrieve this thread's data */
62         pthread_key_t key;
63         /*! The function that initializes the key */
64         void (*key_init)(void);
65         /*! Custom initialization function specific to the object */
66         int (*custom_init)(void *);
67 };
68
69 /*!
70  * \brief Define a thread storage variable
71  *
72  * \arg name The name of the thread storage object
73  *
74  * This macro would be used to declare an instance of thread storage in a file.
75  *
76  * Example usage:
77  * \code
78  * AST_THREADSTORAGE(my_buf);
79  * \endcode
80  */
81 #define AST_THREADSTORAGE(name) \
82         AST_THREADSTORAGE_CUSTOM(name, NULL, ast_free) 
83
84 /*!
85  * \brief Define a thread storage variable, with custom initialization and cleanup
86  *
87  * \arg name The name of the thread storage object
88  * \arg init This is a custom function that will be called after each thread specific
89  *           object is allocated, with the allocated block of memory passed
90  *           as the argument.
91  * \arg cleanup This is a custom function that will be called instead of ast_free
92  *              when the thread goes away.  Note that if this is used, it *MUST*
93  *              call free on the allocated memory.
94  *
95  * Example usage:
96  * \code
97  * AST_THREADSTORAGE_CUSTOM(my_buf, my_init, my_cleanup);
98  * \endcode
99  */
100 #define AST_THREADSTORAGE_CUSTOM(name, c_init, c_cleanup) \
101 static void init_##name(void);                            \
102 static struct ast_threadstorage name = {                  \
103         .once = PTHREAD_ONCE_INIT,                        \
104         .key_init = init_##name,                          \
105         .custom_init = c_init,                            \
106 };                                                        \
107 static void init_##name(void)                             \
108 {                                                         \
109         pthread_key_create(&(name).key, c_cleanup);       \
110 }
111
112 /*!
113  * \brief Retrieve thread storage
114  *
115  * \arg ts This is a pointer to the thread storage structure declared by using
116  *      the AST_THREADSTORAGE macro.  If declared with 
117  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
118  *      (&my_buf).
119  * \arg init_size This is the amount of space to be allocated the first time
120  *      this thread requests its data. Thus, this should be the size that the
121  *      code accessing this thread storage is assuming the size to be.
122  *
123  * \return This function will return the thread local storage associated with
124  *         the thread storage management variable passed as the first argument.
125  *         The result will be NULL in the case of a memory allocation error.
126  *
127  * Example usage:
128  * \code
129  * AST_THREADSTORAGE(my_buf, my_buf_init);
130  * #define MY_BUF_SIZE   128
131  * ...
132  * void my_func(const char *fmt, ...)
133  * {
134  *      void *buf;
135  *
136  *      if (!(buf = ast_threadstorage_get(&my_buf, MY_BUF_SIZE)))
137  *           return;
138  *      ...
139  * }
140  * \endcode
141  */
142 AST_INLINE_API(
143 void *ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size),
144 {
145         void *buf;
146
147         pthread_once(&ts->once, ts->key_init);
148         if (!(buf = pthread_getspecific(ts->key))) {
149                 if (!(buf = ast_calloc(1, init_size)))
150                         return NULL;
151                 if (ts->custom_init && ts->custom_init(buf)) {
152                         free(buf);
153                         return NULL;
154                 }
155                 pthread_setspecific(ts->key, buf);
156         }
157
158         return buf;
159 }
160 )
161
162 void __ast_threadstorage_cleanup(void *);
163
164 /*!
165  * \brief A dynamic length string
166  */
167 struct ast_dynamic_str {
168         /* The current maximum length of the string */
169         size_t len;
170         /* The string buffer */
171         char str[0];
172 };
173
174 /*!
175  * \brief Create a dynamic length string
176  *
177  * \arg init_len This is the initial length of the string buffer
178  *
179  * \return This function returns a pointer to the dynamic string length.  The
180  *         result will be NULL in the case of a memory allocation error.
181  *
182  * /note The result of this function is dynamically allocated memory, and must
183  *       be free()'d after it is no longer needed.
184  */
185 AST_INLINE_API(
186 struct ast_dynamic_str * attribute_malloc ast_dynamic_str_create(size_t init_len),
187 {
188         struct ast_dynamic_str *buf;
189
190         if (!(buf = ast_calloc(1, sizeof(*buf) + init_len)))
191                 return NULL;
192         
193         buf->len = init_len;
194
195         return buf;
196 }
197 )
198
199 /*!
200  * \brief Retrieve a thread locally stored dynamic string
201  *
202  * \arg ts This is a pointer to the thread storage structure declared by using
203  *      the AST_THREADSTORAGE macro.  If declared with 
204  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
205  *      (&my_buf).
206  * \arg init_len This is the initial length of the thread's dynamic string. The
207  *      current length may be bigger if previous operations in this thread have
208  *      caused it to increase.
209  *
210  * \return This function will return the thread locally stored dynamic string
211  *         associated with the thread storage management variable passed as the
212  *         first argument.
213  *         The result will be NULL in the case of a memory allocation error.
214  *
215  * Example usage:
216  * \code
217  * AST_THREADSTORAGE(my_str, my_str_init);
218  * #define MY_STR_INIT_SIZE   128
219  * ...
220  * void my_func(const char *fmt, ...)
221  * {
222  *      struct ast_dynamic_str *buf;
223  *
224  *      if (!(buf = ast_dynamic_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
225  *           return;
226  *      ...
227  * }
228  * \endcode
229  */
230 AST_INLINE_API(
231 struct ast_dynamic_str *ast_dynamic_str_thread_get(struct ast_threadstorage *ts,
232         size_t init_len),
233 {
234         struct ast_dynamic_str *buf;
235
236         if (!(buf = ast_threadstorage_get(ts, sizeof(*buf) + init_len)))
237                 return NULL;
238         
239         if (!buf->len)
240                 buf->len = init_len;
241
242         return buf;
243 }
244 )
245
246 /*!
247  * \brief Error codes from ast_dynamic_str_thread_build_va()
248  */
249 enum {
250         /*! An error has occured and the contents of the dynamic string
251          *  are undefined */
252         AST_DYNSTR_BUILD_FAILED = -1,
253         /*! The buffer size for the dynamic string had to be increased, and
254          *  ast_dynamic_str_thread_build_va() needs to be called again after
255          *  a va_end() and va_start().
256          */
257         AST_DYNSTR_BUILD_RETRY = -2
258 };
259
260 /*!
261  * \brief Set a thread locally stored dynamic string from a va_list
262  *
263  * \arg buf This is the address of a pointer to an ast_dynamic_str which should
264  *      have been retrieved using ast_dynamic_str_thread_get.  It will need to
265  *      be updated in the case that the buffer has to be reallocated to
266  *      accommodate a longer string than what it currently has space for.
267  * \arg max_len This is the maximum length to allow the string buffer to grow
268  *      to.  If this is set to 0, then there is no maximum length.
269  * \arg ts This is a pointer to the thread storage structure declared by using
270  *      the AST_THREADSTORAGE macro.  If declared with 
271  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
272  *      (&my_buf).
273  * \arg fmt This is the format string (printf style)
274  * \arg ap This is the va_list
275  *
276  * \return The return value of this function is the same as that of the printf
277  *         family of functions.
278  *
279  * Example usage:
280  * \code
281  * AST_THREADSTORAGE(my_str, my_str_init);
282  * #define MY_STR_INIT_SIZE   128
283  * ...
284  * void my_func(const char *fmt, ...)
285  * {
286  *      struct ast_dynamic_str *buf;
287  *      va_list ap;
288  *
289  *      if (!(buf = ast_dynamic_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
290  *           return;
291  *      ...
292  *      va_start(fmt, ap);
293  *      ast_dynamic_str_thread_set_va(&buf, 0, &my_str, fmt, ap);
294  *      va_end(ap);
295  * 
296  *      printf("This is the string we just built: %s\n", buf->str);
297  *      ...
298  * }
299  * \endcode
300  */
301 #define ast_dynamic_str_thread_set_va(buf, max_len, ts, fmt, ap)                 \
302         ({                                                                       \
303                 int __res;                                                       \
304                 while ((__res = ast_dynamic_str_thread_build_va(buf, max_len,    \
305                         ts, 0, fmt, ap)) == AST_DYNSTR_BUILD_RETRY) {            \
306                         va_end(ap);                                              \
307                         va_start(ap, fmt);                                       \
308                 }                                                                \
309                 (__res);                                                         \
310         })
311
312 /*!
313  * \brief Append to a thread local dynamic string using a va_list
314  *
315  * The arguments, return values, and usage of this are the same as those for
316  * ast_dynamic_str_thread_set_va().  However, instead of setting a new value
317  * for the string, this will append to the current value.
318  */
319 #define ast_dynamic_str_thread_append_va(buf, max_len, ts, fmt, ap)              \
320         ({                                                                       \
321                 int __res;                                                       \
322                 while ((__res = ast_dynamic_str_thread_build_va(buf, max_len,    \
323                         ts, 1, fmt, ap)) == AST_DYNSTR_BUILD_RETRY) {            \
324                         va_end(ap);                                              \
325                         va_start(ap, fmt);                                       \
326                 }                                                                \
327                 (__res);                                                         \
328         })
329
330 /*!
331  * \brief Core functionality of ast_dynamic_str_thread_(set|append)_va
332  *
333  * The arguments to this function are the same as those described for
334  * ast_dynamic_str_thread_set_va except for an addition argument, append.
335  * If append is non-zero, this will append to the current string instead of
336  * writing over it.
337  *
338  * In the case that this function is called and the buffer was not large enough
339  * to hold the result, the partial write will be truncated, and the result
340  * AST_DYNSTR_BUILD_RETRY will be returned to indicate that the buffer size
341  * was increased, and the function should be called a second time.
342  *
343  * A return of AST_DYNSTR_BUILD_FAILED indicates a memory allocation error.
344  *
345  * A return value greater than or equal to zero indicates the number of
346  * characters that have been written, not including the terminating '\0'.
347  * In the append case, this only includes the number of characters appended.
348  *
349  * \note This function should never need to be called directly.  It should
350  *       through calling one of the other functions or macros defined in this
351  *       file.
352  */
353 int ast_dynamic_str_thread_build_va(struct ast_dynamic_str **buf, size_t max_len,
354         struct ast_threadstorage *ts, int append, const char *fmt, va_list ap);
355
356 /*!
357  * \brief Set a thread locally stored dynamic string using variable arguments
358  *
359  * \arg buf This is the address of a pointer to an ast_dynamic_str which should
360  *      have been retrieved using ast_dynamic_str_thread_get.  It will need to
361  *      be updated in the case that the buffer has to be reallocated to
362  *      accomodate a longer string than what it currently has space for.
363  * \arg max_len This is the maximum length to allow the string buffer to grow
364  *      to.  If this is set to 0, then there is no maximum length.
365  * \arg ts This is a pointer to the thread storage structure declared by using
366  *      the AST_THREADSTORAGE macro.  If declared with 
367  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
368  *      (&my_buf).
369  * \arg fmt This is the format string (printf style)
370  *
371  * \return The return value of this function is the same as that of the printf
372  *         family of functions.
373  *
374  * Example usage:
375  * \code
376  * AST_THREADSTORAGE(my_str, my_str_init);
377  * #define MY_STR_INIT_SIZE   128
378  * ...
379  * void my_func(int arg1, int arg2)
380  * {
381  *      struct ast_dynamic_str *buf;
382  *      va_list ap;
383  *
384  *      if (!(buf = ast_dynamic_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
385  *           return;
386  *      ...
387  *      ast_dynamic_str_thread_set(&buf, 0, &my_str, "arg1: %d  arg2: %d\n",
388  *           arg1, arg2);
389  * 
390  *      printf("This is the string we just built: %s\n", buf->str);
391  *      ...
392  * }
393  * \endcode
394  */
395 AST_INLINE_API(
396 int __attribute__ ((format (printf, 4, 5))) ast_dynamic_str_thread_set(
397         struct ast_dynamic_str **buf, size_t max_len, 
398         struct ast_threadstorage *ts, const char *fmt, ...),
399 {
400         int res;
401         va_list ap;
402
403         va_start(ap, fmt);
404         res = ast_dynamic_str_thread_set_va(buf, max_len, ts, fmt, ap);
405         va_end(ap);
406
407         return res;
408 }
409 )
410
411 /*!
412  * \brief Append to a thread local dynamic string
413  *
414  * The arguments, return values, and usage of this function are the same as
415  * ast_dynamic_str_thread_set().  However, instead of setting a new value for
416  * the string, this function appends to the current value.
417  */
418 AST_INLINE_API(
419 int __attribute__ ((format (printf, 4, 5))) ast_dynamic_str_thread_append(
420         struct ast_dynamic_str **buf, size_t max_len, 
421         struct ast_threadstorage *ts, const char *fmt, ...),
422 {
423         int res;
424         va_list ap;
425
426         va_start(ap, fmt);
427         res = ast_dynamic_str_thread_append_va(buf, max_len, ts, fmt, ap);
428         va_end(ap);
429
430         return res;
431 }
432 )
433
434 /*!
435  * \brief Set a dynamic string
436  *
437  * \arg buf This is the address of a pointer to an ast_dynamic_str.  It will
438  *      need to be updated in the case that the buffer has to be reallocated to
439  *      accommodate a longer string than what it currently has space for.
440  * \arg max_len This is the maximum length to allow the string buffer to grow
441  *      to.  If this is set to 0, then there is no maximum length.
442  *
443  * \return The return value of this function is the same as that of the printf
444  *         family of functions.
445  */
446 AST_INLINE_API(
447 int __attribute__ ((format (printf, 3, 4))) ast_dynamic_str_set(
448         struct ast_dynamic_str **buf, size_t max_len,
449         const char *fmt, ...),
450 {
451         int res;
452         va_list ap;
453         
454         va_start(ap, fmt);
455         res = ast_dynamic_str_thread_set_va(buf, max_len, NULL, fmt, ap);
456         va_end(ap);
457
458         return res;
459 }
460 )
461
462 /*!
463  * \brief Append to a dynamic string
464  *
465  * The arguments, return values, and usage of this function are the same as
466  * ast_dynamic_str_set().  However, this function appends to the string instead
467  * of setting a new value.
468  */
469 AST_INLINE_API(
470 int __attribute__ ((format (printf, 3, 4))) ast_dynamic_str_append(
471         struct ast_dynamic_str **buf, size_t max_len,
472         const char *fmt, ...),
473 {
474         int res;
475         va_list ap;
476         
477         va_start(ap, fmt);
478         res = ast_dynamic_str_thread_append_va(buf, max_len, NULL, fmt, ap);
479         va_end(ap);
480
481         return res;
482 }
483 )
484
485 #endif /* ASTERISK_THREADSTORAGE_H */