Extend the thread storage API such that a custom initialization function can
[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  *
23  * \brief Definitions to aid in the use of thread local storage
24 */
25
26 #ifndef ASTERISK_THREADSTORAGE_H
27 #define ASTERISK_THREADSTORAGE_H
28
29 #include <pthread.h>
30
31 #include "asterisk/utils.h"
32 #include "asterisk/inline_api.h"
33
34 /*!
35  * \brief data for a thread locally stored variable
36  */
37 struct ast_threadstorage {
38         /*! Ensure that the key is only initialized by one thread */
39         pthread_once_t once;
40         /*! The key used to retrieve this thread's data */
41         pthread_key_t key;
42         /*! The function that initializes the key */
43         void (*key_init)(void);
44         /*! Custom initialization function specific to the object */
45         void (*custom_init)(void *);
46 };
47
48 /*!
49  * \brief Define a thread storage variable
50  *
51  * \arg name The name of the thread storage object
52  *
53  * This macro would be used to declare an instance of thread storage in a file.
54  *
55  * Example usage:
56  * \code
57  * AST_THREADSTORAGE(my_buf);
58  * \endcode
59  */
60 #define AST_THREADSTORAGE(name) \
61         AST_THREADSTORAGE_CUSTOM(name, NULL, NULL) 
62
63 /*!
64  * \brief Define a thread storage variable, with custom initialization and cleanup
65  *
66  * \arg name The name of the thread storage object
67  * \arg init This is a custom that will be called after each thread specific
68  *           object is allocated, with the allocated block of memory passed
69  *           as the argument.
70  * \arg cleanup This is a custom function that will be called instead of ast_free
71  *              when the thread goes away.  Note that if this is used, it *MUST*
72  *              call free on the allocated memory.
73  *
74  * Example usage:
75  * \code
76  * AST_THREADSTORAGE(my_buf, my_init, my_cleanup);
77  * \endcode
78  */
79 #define AST_THREADSTORAGE_CUSTOM(name, c_init, c_cleanup) \
80 static void init_##name(void);                            \
81 static struct ast_threadstorage name = {                  \
82         .once = PTHREAD_ONCE_INIT,                        \
83         .key_init = init_##name,                          \
84         .custom_init = c_init,                            \
85 };                                                        \
86 static void init_##name(void)                             \
87 {                                                         \
88         pthread_key_create(&(name).key, c_cleanup);       \
89 }
90
91 /*!
92  * \brief Retrieve thread storage
93  *
94  * \arg ts This is a pointer to the thread storage structure declared by using
95  *      the AST_THREADSTORAGE macro.  If declared with 
96  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
97  *      (&my_buf).
98  * \arg init_size This is the amount of space to be allocated the first time
99  *      this thread requests its data. Thus, this should be the size that the
100  *      code accessing this thread storage is assuming the size to be.
101  *
102  * \return This function will return the thread local storage associated with
103  *         the thread storage management variable passed as the first argument.
104  *         The result will be NULL in the case of a memory allocation error.
105  *
106  * Example usage:
107  * \code
108  * AST_THREADSTORAGE(my_buf, my_buf_init);
109  * #define MY_BUF_SIZE   128
110  * ...
111  * void my_func(const char *fmt, ...)
112  * {
113  *      void *buf;
114  *
115  *      if (!(buf = ast_threadstorage_get(&my_buf, MY_BUF_SIZE)))
116  *           return;
117  *      ...
118  * }
119  * \endcode
120  */
121 AST_INLINE_API(
122 void *ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size),
123 {
124         void *buf;
125
126         pthread_once(&ts->once, ts->key_init);
127         if (!(buf = pthread_getspecific(ts->key))) {
128                 if (!(buf = ast_calloc(1, init_size)))
129                         return NULL;
130                 if (ts->custom_init)
131                         ts->custom_init(buf);
132                 pthread_setspecific(ts->key, buf);
133         }
134
135         return buf;
136 }
137 )
138
139 void __ast_threadstorage_cleanup(void *);
140
141 /*!
142  * \brief A dynamic length string
143  */
144 struct ast_dynamic_str {
145         /* The current maximum length of the string */
146         size_t len;
147         /* The string buffer */
148         char str[0];
149 };
150
151 /*!
152  * \brief Create a dynamic length string
153  *
154  * \arg init_len This is the initial length of the string buffer
155  *
156  * \return This function returns a pointer to the dynamic string length.  The
157  *         result will be NULL in the case of a memory allocation error.
158  *
159  * /note The result of this function is dynamically allocated memory, and must
160  *       be free()'d after it is no longer needed.
161  */
162 AST_INLINE_API(
163 struct ast_dynamic_str * attribute_malloc ast_dynamic_str_create(size_t init_len),
164 {
165         struct ast_dynamic_str *buf;
166
167         if (!(buf = ast_calloc(1, sizeof(*buf) + init_len)))
168                 return NULL;
169         
170         buf->len = init_len;
171
172         return buf;
173 }
174 )
175
176 /*!
177  * \brief Retrieve a thread locally stored dynamic string
178  *
179  * \arg ts This is a pointer to the thread storage structure declared by using
180  *      the AST_THREADSTORAGE macro.  If declared with 
181  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
182  *      (&my_buf).
183  * \arg init_len This is the initial length of the thread's dynamic string. The
184  *      current length may be bigger if previous operations in this thread have
185  *      caused it to increase.
186  *
187  * \return This function will return the thread locally storaged dynamic string
188  *         associated with the thread storage management variable passed as the
189  *         first argument.
190  *         The result will be NULL in the case of a memory allocation error.
191  *
192  * Example usage:
193  * \code
194  * AST_THREADSTORAGE(my_str, my_str_init);
195  * #define MY_STR_INIT_SIZE   128
196  * ...
197  * void my_func(const char *fmt, ...)
198  * {
199  *      struct ast_dynamic_str *buf;
200  *
201  *      if (!(buf = ast_dynamic_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
202  *           return;
203  *      ...
204  * }
205  * \endcode
206  */
207 AST_INLINE_API(
208 struct ast_dynamic_str *ast_dynamic_str_thread_get(struct ast_threadstorage *ts,
209         size_t init_len),
210 {
211         struct ast_dynamic_str *buf;
212
213         if (!(buf = ast_threadstorage_get(ts, sizeof(*buf) + init_len)))
214                 return NULL;
215         
216         if (!buf->len)
217                 buf->len = init_len;
218
219         return buf;
220 }
221 )
222
223 /*!
224  * \brief Error codes from ast_dynamic_str_thread_build_va()
225  */
226 enum {
227         /*! An error has occured and the contents of the dynamic string
228          *  are undefined */
229         AST_DYNSTR_BUILD_FAILED = -1,
230         /*! The buffer size for the dynamic string had to be increased, and
231          *  ast_dynamic_str_thread_build_va() needs to be called again after
232          *  a va_end() and va_start().
233          */
234         AST_DYNSTR_BUILD_RETRY = -2
235 };
236
237 /*!
238  * \brief Set a thread locally stored dynamic string from a va_list
239  *
240  * \arg buf This is the address of a pointer to an ast_dynamic_str which should
241  *      have been retrieved using ast_dynamic_str_thread_get.  It will need to
242  *      be updated in the case that the buffer has to be reallocated to
243  *      accomodate a longer string than what it currently has space for.
244  * \arg max_len This is the maximum length to allow the string buffer to grow
245  *      to.  If this is set to 0, then there is no maximum length.
246  * \arg ts This is a pointer to the thread storage structure declared by using
247  *      the AST_THREADSTORAGE macro.  If declared with 
248  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
249  *      (&my_buf).
250  * \arg fmt This is the format string (printf style)
251  * \arg ap This is the va_list
252  *
253  * \return The return value of this function is the same as that of the printf
254  *         family of functions.
255  *
256  * Example usage:
257  * \code
258  * AST_THREADSTORAGE(my_str, my_str_init);
259  * #define MY_STR_INIT_SIZE   128
260  * ...
261  * void my_func(const char *fmt, ...)
262  * {
263  *      struct ast_dynamic_str *buf;
264  *      va_list ap;
265  *
266  *      if (!(buf = ast_dynamic_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
267  *           return;
268  *      ...
269  *      va_start(fmt, ap);
270  *      ast_dynamic_str_thread_set_va(&buf, 0, &my_str, fmt, ap);
271  *      va_end(ap);
272  * 
273  *      printf("This is the string we just built: %s\n", buf->str);
274  *      ...
275  * }
276  * \endcode
277  */
278 #define ast_dynamic_str_thread_set_va(buf, max_len, ts, fmt, ap)                 \
279         ({                                                                       \
280                 int __res;                                                       \
281                 while ((__res = ast_dynamic_str_thread_build_va(buf, max_len,    \
282                         ts, 0, fmt, ap)) == AST_DYNSTR_BUILD_RETRY) {            \
283                         va_end(ap);                                              \
284                         va_start(ap, fmt);                                       \
285                 }                                                                \
286                 (__res);                                                         \
287         })
288
289 /*!
290  * \brief Append to a thread local dynamic string using a va_list
291  *
292  * The arguments, return values, and usage of this are the same as those for
293  * ast_dynamic_str_thread_set_va().  However, instead of setting a new value
294  * for the string, this will append to the current value.
295  */
296 #define ast_dynamic_str_thread_append_va(buf, max_len, ts, fmt, ap)              \
297         ({                                                                       \
298                 int __res;                                                       \
299                 while ((__res = ast_dynamic_str_thread_build_va(buf, max_len,    \
300                         ts, 1, fmt, ap)) == AST_DYNSTR_BUILD_RETRY) {            \
301                         va_end(ap);                                              \
302                         va_start(ap, fmt);                                       \
303                 }                                                                \
304                 (__res);                                                         \
305         })
306
307 /*!
308  * \brief Core functionality of ast_dynamic_str_thread_(set|append)_va
309  *
310  * The arguments to this function are the same as those described for
311  * ast_dynamic_str_thread_set_va except for an addition argument, append.
312  * If append is non-zero, this will append to the current string instead of
313  * writing over it.
314  */
315 int ast_dynamic_str_thread_build_va(struct ast_dynamic_str **buf, size_t max_len,
316         struct ast_threadstorage *ts, int append, const char *fmt, va_list ap);
317
318 /*!
319  * \brief Set a thread locally stored dynamic string using variable arguments
320  *
321  * \arg buf This is the address of a pointer to an ast_dynamic_str which should
322  *      have been retrieved using ast_dynamic_str_thread_get.  It will need to
323  *      be updated in the case that the buffer has to be reallocated to
324  *      accomodate a longer string than what it currently has space for.
325  * \arg max_len This is the maximum length to allow the string buffer to grow
326  *      to.  If this is set to 0, then there is no maximum length.
327  * \arg ts This is a pointer to the thread storage structure declared by using
328  *      the AST_THREADSTORAGE macro.  If declared with 
329  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
330  *      (&my_buf).
331  * \arg fmt This is the format string (printf style)
332  *
333  * \return The return value of this function is the same as that of the printf
334  *         family of functions.
335  *
336  * Example usage:
337  * \code
338  * AST_THREADSTORAGE(my_str, my_str_init);
339  * #define MY_STR_INIT_SIZE   128
340  * ...
341  * void my_func(int arg1, int arg2)
342  * {
343  *      struct ast_dynamic_str *buf;
344  *      va_list ap;
345  *
346  *      if (!(buf = ast_dynamic_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
347  *           return;
348  *      ...
349  *      ast_dynamic_str_thread_set(&buf, 0, &my_str, "arg1: %d  arg2: %d\n",
350  *           arg1, arg2);
351  * 
352  *      printf("This is the string we just built: %s\n", buf->str);
353  *      ...
354  * }
355  * \endcode
356  */
357 AST_INLINE_API(
358 int __attribute__ ((format (printf, 4, 5))) ast_dynamic_str_thread_set(
359         struct ast_dynamic_str **buf, size_t max_len, 
360         struct ast_threadstorage *ts, const char *fmt, ...),
361 {
362         int res;
363         va_list ap;
364
365         va_start(ap, fmt);
366         res = ast_dynamic_str_thread_set_va(buf, max_len, ts, fmt, ap);
367         va_end(ap);
368
369         return res;
370 }
371 )
372
373 /*!
374  * \brief Append to a thread local dynamic string
375  *
376  * The arguments, return values, and usage of this function are the same as
377  * ast_dynamic_str_thread_set().  However, instead of setting a new value for
378  * the string, this function appends to the current value.
379  */
380 AST_INLINE_API(
381 int __attribute__ ((format (printf, 4, 5))) ast_dynamic_str_thread_append(
382         struct ast_dynamic_str **buf, size_t max_len, 
383         struct ast_threadstorage *ts, const char *fmt, ...),
384 {
385         int res;
386         va_list ap;
387
388         va_start(ap, fmt);
389         res = ast_dynamic_str_thread_append_va(buf, max_len, ts, fmt, ap);
390         va_end(ap);
391
392         return res;
393 }
394 )
395
396 /*!
397  * \brief Set a dynamic string
398  *
399  * \arg buf This is the address of a pointer to an ast_dynamic_str.  It will
400  *      need to be updated in the case that the buffer has to be reallocated to
401  *      accomodate a longer string than what it currently has space for.
402  * \arg max_len This is the maximum length to allow the string buffer to grow
403  *      to.  If this is set to 0, then there is no maximum length.
404  *
405  * \return The return value of this function is the same as that of the printf
406  *         family of functions.
407  */
408 AST_INLINE_API(
409 int __attribute__ ((format (printf, 3, 4))) ast_dynamic_str_set(
410         struct ast_dynamic_str **buf, size_t max_len,
411         const char *fmt, ...),
412 {
413         int res;
414         va_list ap;
415         
416         va_start(ap, fmt);
417         res = ast_dynamic_str_thread_set_va(buf, max_len, NULL, fmt, ap);
418         va_end(ap);
419
420         return res;
421 }
422 )
423
424 /*!
425  * \brief Append to a dynatic string
426  *
427  * The arguments, return values, and usage of this function are the same as
428  * ast_dynamic_str_set().  However, this function appends to the string instead
429  * of setting a new value.
430  */
431 AST_INLINE_API(
432 int __attribute__ ((format (printf, 3, 4))) ast_dynamic_str_append(
433         struct ast_dynamic_str **buf, size_t max_len,
434         const char *fmt, ...),
435 {
436         int res;
437         va_list ap;
438         
439         va_start(ap, fmt);
440         res = ast_dynamic_str_thread_append_va(buf, max_len, NULL, fmt, ap);
441         va_end(ap);
442
443         return res;
444 }
445 )
446
447 #endif /* ASTERISK_THREADSTORAGE_H */