Merged revisions 378935 via svnmerge from
[asterisk/asterisk.git] / include / asterisk / utils.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 /*! \file
20  * \brief Utility functions
21  */
22
23 #ifndef _ASTERISK_UTILS_H
24 #define _ASTERISK_UTILS_H
25
26 #include "asterisk/network.h"
27
28 #include <time.h>       /* we want to override localtime_r */
29 #include <unistd.h>
30 #include <string.h>
31
32 #include "asterisk/lock.h"
33 #include "asterisk/time.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/localtime.h"
36 #include "asterisk/stringfields.h"
37
38 /*!
39 \note \verbatim
40    Note:
41    It is very important to use only unsigned variables to hold
42    bit flags, as otherwise you can fall prey to the compiler's
43    sign-extension antics if you try to use the top two bits in
44    your variable.
45
46    The flag macros below use a set of compiler tricks to verify
47    that the caller is using an "unsigned int" variable to hold
48    the flags, and nothing else. If the caller uses any other
49    type of variable, a warning message similar to this:
50
51    warning: comparison of distinct pointer types lacks cast
52    will be generated.
53
54    The "dummy" variable below is used to make these comparisons.
55
56    Also note that at -O2 or above, this type-safety checking
57    does _not_ produce any additional object code at all.
58  \endverbatim
59 */
60
61 extern unsigned int __unsigned_int_flags_dummy;
62
63 #define ast_test_flag(p,flag)           ({ \
64                                         typeof ((p)->flags) __p = (p)->flags; \
65                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
66                                         (void) (&__p == &__x); \
67                                         ((p)->flags & (flag)); \
68                                         })
69
70 #define ast_set_flag(p,flag)            do { \
71                                         typeof ((p)->flags) __p = (p)->flags; \
72                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
73                                         (void) (&__p == &__x); \
74                                         ((p)->flags |= (flag)); \
75                                         } while(0)
76
77 #define ast_clear_flag(p,flag)          do { \
78                                         typeof ((p)->flags) __p = (p)->flags; \
79                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
80                                         (void) (&__p == &__x); \
81                                         ((p)->flags &= ~(flag)); \
82                                         } while(0)
83
84 #define ast_copy_flags(dest,src,flagz)  do { \
85                                         typeof ((dest)->flags) __d = (dest)->flags; \
86                                         typeof ((src)->flags) __s = (src)->flags; \
87                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
88                                         (void) (&__d == &__x); \
89                                         (void) (&__s == &__x); \
90                                         (dest)->flags &= ~(flagz); \
91                                         (dest)->flags |= ((src)->flags & (flagz)); \
92                                         } while (0)
93
94 #define ast_set2_flag(p,value,flag)     do { \
95                                         typeof ((p)->flags) __p = (p)->flags; \
96                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
97                                         (void) (&__p == &__x); \
98                                         if (value) \
99                                                 (p)->flags |= (flag); \
100                                         else \
101                                                 (p)->flags &= ~(flag); \
102                                         } while (0)
103
104 #define ast_set_flags_to(p,flag,value)  do { \
105                                         typeof ((p)->flags) __p = (p)->flags; \
106                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
107                                         (void) (&__p == &__x); \
108                                         (p)->flags &= ~(flag); \
109                                         (p)->flags |= (value); \
110                                         } while (0)
111
112
113 /* The following 64-bit flag code can most likely be erased after app_dial
114    is reorganized to either reduce the large number of options, or handle
115    them in some other way. At the time of this writing, app_dial would be
116    the only user of 64-bit option flags */
117
118 extern uint64_t __unsigned_int_flags_dummy64;
119
120 #define ast_test_flag64(p,flag)                 ({ \
121                                         typeof ((p)->flags) __p = (p)->flags; \
122                                         typeof (__unsigned_int_flags_dummy64) __x = 0; \
123                                         (void) (&__p == &__x); \
124                                         ((p)->flags & (flag)); \
125                                         })
126
127 #define ast_set_flag64(p,flag)          do { \
128                                         typeof ((p)->flags) __p = (p)->flags; \
129                                         typeof (__unsigned_int_flags_dummy64) __x = 0; \
130                                         (void) (&__p == &__x); \
131                                         ((p)->flags |= (flag)); \
132                                         } while(0)
133
134 #define ast_clear_flag64(p,flag)                do { \
135                                         typeof ((p)->flags) __p = (p)->flags; \
136                                         typeof (__unsigned_int_flags_dummy64) __x = 0; \
137                                         (void) (&__p == &__x); \
138                                         ((p)->flags &= ~(flag)); \
139                                         } while(0)
140
141 #define ast_copy_flags64(dest,src,flagz)        do { \
142                                         typeof ((dest)->flags) __d = (dest)->flags; \
143                                         typeof ((src)->flags) __s = (src)->flags; \
144                                         typeof (__unsigned_int_flags_dummy64) __x = 0; \
145                                         (void) (&__d == &__x); \
146                                         (void) (&__s == &__x); \
147                                         (dest)->flags &= ~(flagz); \
148                                         (dest)->flags |= ((src)->flags & (flagz)); \
149                                         } while (0)
150
151 #define ast_set2_flag64(p,value,flag)   do { \
152                                         typeof ((p)->flags) __p = (p)->flags; \
153                                         typeof (__unsigned_int_flags_dummy64) __x = 0; \
154                                         (void) (&__p == &__x); \
155                                         if (value) \
156                                                 (p)->flags |= (flag); \
157                                         else \
158                                                 (p)->flags &= ~(flag); \
159                                         } while (0)
160
161 #define ast_set_flags_to64(p,flag,value)        do { \
162                                         typeof ((p)->flags) __p = (p)->flags; \
163                                         typeof (__unsigned_int_flags_dummy64) __x = 0; \
164                                         (void) (&__p == &__x); \
165                                         (p)->flags &= ~(flag); \
166                                         (p)->flags |= (value); \
167                                         } while (0)
168
169
170 /* Non-type checking variations for non-unsigned int flags.  You
171    should only use non-unsigned int flags where required by
172    protocol etc and if you know what you're doing :)  */
173 #define ast_test_flag_nonstd(p,flag) \
174                                         ((p)->flags & (flag))
175
176 #define ast_set_flag_nonstd(p,flag)             do { \
177                                         ((p)->flags |= (flag)); \
178                                         } while(0)
179
180 #define ast_clear_flag_nonstd(p,flag)           do { \
181                                         ((p)->flags &= ~(flag)); \
182                                         } while(0)
183
184 #define ast_copy_flags_nonstd(dest,src,flagz)   do { \
185                                         (dest)->flags &= ~(flagz); \
186                                         (dest)->flags |= ((src)->flags & (flagz)); \
187                                         } while (0)
188
189 #define ast_set2_flag_nonstd(p,value,flag)      do { \
190                                         if (value) \
191                                                 (p)->flags |= (flag); \
192                                         else \
193                                                 (p)->flags &= ~(flag); \
194                                         } while (0)
195
196 #define AST_FLAGS_ALL UINT_MAX
197
198 /*! \brief Structure used to handle boolean flags */
199 struct ast_flags {
200         unsigned int flags;
201 };
202
203 /*! \brief Structure used to handle a large number of boolean flags == used only in app_dial? */
204 struct ast_flags64 {
205         uint64_t flags;
206 };
207
208 struct ast_hostent {
209         struct hostent hp;
210         char buf[1024];
211 };
212
213 /*! \brief Thread-safe gethostbyname function to use in Asterisk */
214 struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp);
215
216 /*! \brief Produces MD5 hash based on input string */
217 void ast_md5_hash(char *output, const char *input);
218 /*! \brief Produces SHA1 hash based on input string */
219 void ast_sha1_hash(char *output, const char *input);
220 /*! \brief Produces SHA1 hash based on input string, stored in uint8_t array */
221 void ast_sha1_hash_uint(uint8_t *digest, const char *input);
222
223 int ast_base64encode_full(char *dst, const unsigned char *src, int srclen, int max, int linebreaks);
224
225 #undef MIN
226 #define MIN(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); ((__a > __b) ? __b : __a);})
227 #undef MAX
228 #define MAX(a, b) ({ typeof(a) __a = (a); typeof(b) __b = (b); ((__a < __b) ? __b : __a);})
229
230 #define SWAP(a,b) do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
231
232 /*!
233  * \brief Encode data in base64
234  * \param dst the destination buffer
235  * \param src the source data to be encoded
236  * \param srclen the number of bytes present in the source buffer
237  * \param max the maximum number of bytes to write into the destination
238  *        buffer, *including* the terminating NULL character.
239  */
240 int ast_base64encode(char *dst, const unsigned char *src, int srclen, int max);
241
242 /*!
243  * \brief Decode data from base64
244  * \param dst the destination buffer
245  * \param src the source buffer
246  * \param max The maximum number of bytes to write into the destination
247  *            buffer.  Note that this function will not ensure that the
248  *            destination buffer is NULL terminated.  So, in general,
249  *            this parameter should be sizeof(dst) - 1.
250  */
251 int ast_base64decode(unsigned char *dst, const char *src, int max);
252
253 #define AST_URI_ALPHANUM     (1 << 0)
254 #define AST_URI_MARK         (1 << 1)
255 #define AST_URI_UNRESERVED   (AST_URI_ALPHANUM | AST_URI_MARK)
256 #define AST_URI_LEGACY_SPACE (1 << 2)
257
258 #define AST_URI_SIP_USER_UNRESERVED (1 << 20)
259
260 extern const struct ast_flags ast_uri_http;
261 extern const struct ast_flags ast_uri_http_legacy;
262 extern const struct ast_flags ast_uri_sip_user;
263
264 /*!
265  * \brief Turn text string to URI-encoded %XX version
266  *
267  * This function encodes characters according to the rules presented in RFC
268  * 2396 and/or RFC 3261 section 19.1.2 and section 25.1.
269  *
270  * Outbuf needs to have more memory allocated than the instring to have room
271  * for the expansion. Every byte that is converted is replaced by three ASCII
272  * characters.
273  *
274  * \param string string to be converted
275  * \param outbuf resulting encoded string
276  * \param buflen size of output buffer
277  * \param spec flags describing how the encoding should be performed
278  * \return a pointer to the uri encoded string
279  */
280 char *ast_uri_encode(const char *string, char *outbuf, int buflen, struct ast_flags spec);
281
282 /*!
283  * \brief Decode URI, URN, URL (overwrite string)
284  *
285  * \note The ast_uri_http_legacy decode spec flag will cause this function to
286  * decode '+' as ' '.
287  *
288  * \param s string to be decoded
289  * \param spec flags describing how the decoding should be performed
290  */
291 void ast_uri_decode(char *s, struct ast_flags spec);
292
293 /*! ast_xml_escape
294         \brief Escape reserved characters for use in XML.
295
296         If \a outbuf is too short, the output string will be truncated.
297         Regardless, the output will always be null terminated.
298
299         \param string String to be converted
300         \param outbuf Resulting encoded string
301         \param buflen Size of output buffer
302         \return 0 for success
303         \return -1 if buflen is too short.
304  */
305 int ast_xml_escape(const char *string, char *outbuf, size_t buflen);
306
307 /*!
308  * \brief Escape characters found in a quoted string.
309  *
310  * \note This function escapes quoted characters based on the 'qdtext' set of
311  * allowed characters from RFC 3261 section 25.1.
312  *
313  * \param string string to be escaped
314  * \param outbuf resulting escaped string
315  * \param buflen size of output buffer
316  * \return a pointer to the escaped string
317  */
318 char *ast_escape_quoted(const char *string, char *outbuf, int buflen);
319
320 static force_inline void ast_slinear_saturated_add(short *input, short *value)
321 {
322         int res;
323
324         res = (int) *input + *value;
325         if (res > 32767)
326                 *input = 32767;
327         else if (res < -32767)
328                 *input = -32767;
329         else
330                 *input = (short) res;
331 }
332
333 static force_inline void ast_slinear_saturated_subtract(short *input, short *value)
334 {
335         int res;
336
337         res = (int) *input - *value;
338         if (res > 32767)
339                 *input = 32767;
340         else if (res < -32767)
341                 *input = -32767;
342         else
343                 *input = (short) res;
344 }
345
346 static force_inline void ast_slinear_saturated_multiply(short *input, short *value)
347 {
348         int res;
349
350         res = (int) *input * *value;
351         if (res > 32767)
352                 *input = 32767;
353         else if (res < -32767)
354                 *input = -32767;
355         else
356                 *input = (short) res;
357 }
358
359 static force_inline void ast_slinear_saturated_divide(short *input, short *value)
360 {
361         *input /= *value;
362 }
363
364 #ifdef localtime_r
365 #undef localtime_r
366 #endif
367 #define localtime_r __dont_use_localtime_r_use_ast_localtime_instead__
368
369 int ast_utils_init(void);
370 int ast_wait_for_input(int fd, int ms);
371
372 /*!
373  * \brief Try to write string, but wait no more than ms milliseconds
374  * before timing out.
375  *
376  * \note If you are calling ast_carefulwrite, it is assumed that you are calling
377  * it on a file descriptor that _DOES_ have NONBLOCK set.  This way,
378  * there is only one system call made to do a write, unless we actually
379  * have a need to wait.  This way, we get better performance.
380  */
381 int ast_carefulwrite(int fd, char *s, int len, int timeoutms);
382
383 /*!
384  * \brief Write data to a file stream with a timeout
385  *
386  * \param f the file stream to write to
387  * \param fd the file description to poll on to know when the file stream can
388  *        be written to without blocking.
389  * \param s the buffer to write from
390  * \param len the number of bytes to write
391  * \param timeoutms The maximum amount of time to block in this function trying
392  *        to write, specified in milliseconds.
393  *
394  * \note This function assumes that the associated file stream has been set up
395  *       as non-blocking.
396  *
397  * \retval 0 success
398  * \retval -1 error
399  */
400 int ast_careful_fwrite(FILE *f, int fd, const char *s, size_t len, int timeoutms);
401
402 /*
403  * Thread management support (should be moved to lock.h or a different header)
404  */
405
406 #define AST_STACKSIZE (((sizeof(void *) * 8 * 8) - 16) * 1024)
407
408 #if defined(LOW_MEMORY)
409 #define AST_BACKGROUND_STACKSIZE (((sizeof(void *) * 8 * 2) - 16) * 1024)
410 #else
411 #define AST_BACKGROUND_STACKSIZE AST_STACKSIZE
412 #endif
413
414 void ast_register_thread(char *name);
415 void ast_unregister_thread(void *id);
416
417 int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
418                              void *data, size_t stacksize, const char *file, const char *caller,
419                              int line, const char *start_fn);
420
421 int ast_pthread_create_detached_stack(pthread_t *thread, pthread_attr_t *attr, void*(*start_routine)(void *),
422                                  void *data, size_t stacksize, const char *file, const char *caller,
423                                  int line, const char *start_fn);
424
425 #define ast_pthread_create(a, b, c, d)                          \
426         ast_pthread_create_stack(a, b, c, d,                    \
427                 0, __FILE__, __FUNCTION__, __LINE__, #c)
428
429 #define ast_pthread_create_detached(a, b, c, d)                 \
430         ast_pthread_create_detached_stack(a, b, c, d,           \
431                 0, __FILE__, __FUNCTION__, __LINE__, #c)
432
433 #define ast_pthread_create_background(a, b, c, d)               \
434         ast_pthread_create_stack(a, b, c, d,                    \
435                 AST_BACKGROUND_STACKSIZE,                       \
436                 __FILE__, __FUNCTION__, __LINE__, #c)
437
438 #define ast_pthread_create_detached_background(a, b, c, d)      \
439         ast_pthread_create_detached_stack(a, b, c, d,           \
440                 AST_BACKGROUND_STACKSIZE,                       \
441                 __FILE__, __FUNCTION__, __LINE__, #c)
442
443 /* End of thread management support */
444
445 /*!
446  * \brief Replace '^' in a string with ','
447  * \param s String within which to replace characters
448  */
449 void ast_replace_subargument_delimiter(char *s);
450
451 /*!
452  * \brief Process a string to find and replace characters
453  * \param start The string to analyze
454  * \param find The character to find
455  * \param replace_with The character that will replace the one we are looking for
456  */
457 char *ast_process_quotes_and_slashes(char *start, char find, char replace_with);
458
459 long int ast_random(void);
460
461
462 /*!
463  * \brief free() wrapper
464  *
465  * ast_free_ptr should be used when a function pointer for free() needs to be passed
466  * as the argument to a function. Otherwise, astmm will cause seg faults.
467  */
468 #ifdef __AST_DEBUG_MALLOC
469 static void ast_free_ptr(void *ptr) attribute_unused;
470 static void ast_free_ptr(void *ptr)
471 {
472         ast_free(ptr);
473 }
474 #else
475 #define ast_free free
476 #define ast_free_ptr ast_free
477 #endif
478
479 #ifndef __AST_DEBUG_MALLOC
480
481 #define MALLOC_FAILURE_MSG \
482         ast_log(LOG_ERROR, "Memory Allocation Failure in function %s at line %d of %s\n", func, lineno, file);
483 /*!
484  * \brief A wrapper for malloc()
485  *
486  * ast_malloc() is a wrapper for malloc() that will generate an Asterisk log
487  * message in the case that the allocation fails.
488  *
489  * The argument and return value are the same as malloc()
490  */
491 #define ast_malloc(len) \
492         _ast_malloc((len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
493
494 AST_INLINE_API(
495 void * attribute_malloc _ast_malloc(size_t len, const char *file, int lineno, const char *func),
496 {
497         void *p;
498
499         if (!(p = malloc(len)))
500                 MALLOC_FAILURE_MSG;
501
502         return p;
503 }
504 )
505
506 /*!
507  * \brief A wrapper for calloc()
508  *
509  * ast_calloc() is a wrapper for calloc() that will generate an Asterisk log
510  * message in the case that the allocation fails.
511  *
512  * The arguments and return value are the same as calloc()
513  */
514 #define ast_calloc(num, len) \
515         _ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
516
517 AST_INLINE_API(
518 void * attribute_malloc _ast_calloc(size_t num, size_t len, const char *file, int lineno, const char *func),
519 {
520         void *p;
521
522         if (!(p = calloc(num, len)))
523                 MALLOC_FAILURE_MSG;
524
525         return p;
526 }
527 )
528
529 /*!
530  * \brief A wrapper for calloc() for use in cache pools
531  *
532  * ast_calloc_cache() is a wrapper for calloc() that will generate an Asterisk log
533  * message in the case that the allocation fails. When memory debugging is in use,
534  * the memory allocated by this function will be marked as 'cache' so it can be
535  * distinguished from normal memory allocations.
536  *
537  * The arguments and return value are the same as calloc()
538  */
539 #define ast_calloc_cache(num, len) \
540         _ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
541
542 /*!
543  * \brief A wrapper for realloc()
544  *
545  * ast_realloc() is a wrapper for realloc() that will generate an Asterisk log
546  * message in the case that the allocation fails.
547  *
548  * The arguments and return value are the same as realloc()
549  */
550 #define ast_realloc(p, len) \
551         _ast_realloc((p), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
552
553 AST_INLINE_API(
554 void * attribute_malloc _ast_realloc(void *p, size_t len, const char *file, int lineno, const char *func),
555 {
556         void *newp;
557
558         if (!(newp = realloc(p, len)))
559                 MALLOC_FAILURE_MSG;
560
561         return newp;
562 }
563 )
564
565 /*!
566  * \brief A wrapper for strdup()
567  *
568  * ast_strdup() is a wrapper for strdup() that will generate an Asterisk log
569  * message in the case that the allocation fails.
570  *
571  * ast_strdup(), unlike strdup(), can safely accept a NULL argument. If a NULL
572  * argument is provided, ast_strdup will return NULL without generating any
573  * kind of error log message.
574  *
575  * The argument and return value are the same as strdup()
576  */
577 #define ast_strdup(str) \
578         _ast_strdup((str), __FILE__, __LINE__, __PRETTY_FUNCTION__)
579
580 AST_INLINE_API(
581 char * attribute_malloc _ast_strdup(const char *str, const char *file, int lineno, const char *func),
582 {
583         char *newstr = NULL;
584
585         if (str) {
586                 if (!(newstr = strdup(str)))
587                         MALLOC_FAILURE_MSG;
588         }
589
590         return newstr;
591 }
592 )
593
594 /*!
595  * \brief A wrapper for strndup()
596  *
597  * ast_strndup() is a wrapper for strndup() that will generate an Asterisk log
598  * message in the case that the allocation fails.
599  *
600  * ast_strndup(), unlike strndup(), can safely accept a NULL argument for the
601  * string to duplicate. If a NULL argument is provided, ast_strdup will return
602  * NULL without generating any kind of error log message.
603  *
604  * The arguments and return value are the same as strndup()
605  */
606 #define ast_strndup(str, len) \
607         _ast_strndup((str), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
608
609 AST_INLINE_API(
610 char * attribute_malloc _ast_strndup(const char *str, size_t len, const char *file, int lineno, const char *func),
611 {
612         char *newstr = NULL;
613
614         if (str) {
615                 if (!(newstr = strndup(str, len)))
616                         MALLOC_FAILURE_MSG;
617         }
618
619         return newstr;
620 }
621 )
622
623 /*!
624  * \brief A wrapper for asprintf()
625  *
626  * ast_asprintf() is a wrapper for asprintf() that will generate an Asterisk log
627  * message in the case that the allocation fails.
628  *
629  * The arguments and return value are the same as asprintf()
630  */
631 #define ast_asprintf(ret, fmt, ...) \
632         _ast_asprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, fmt, __VA_ARGS__)
633
634 int __attribute__((format(printf, 5, 6)))
635         _ast_asprintf(char **ret, const char *file, int lineno, const char *func, const char *fmt, ...);
636
637 /*!
638  * \brief A wrapper for vasprintf()
639  *
640  * ast_vasprintf() is a wrapper for vasprintf() that will generate an Asterisk log
641  * message in the case that the allocation fails.
642  *
643  * The arguments and return value are the same as vasprintf()
644  */
645 #define ast_vasprintf(ret, fmt, ap) \
646         _ast_vasprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, (fmt), (ap))
647
648 AST_INLINE_API(
649 __attribute__((format(printf, 5, 0)))
650 int _ast_vasprintf(char **ret, const char *file, int lineno, const char *func, const char *fmt, va_list ap),
651 {
652         int res;
653
654         if ((res = vasprintf(ret, fmt, ap)) == -1)
655                 MALLOC_FAILURE_MSG;
656
657         return res;
658 }
659 )
660
661 #endif /* AST_DEBUG_MALLOC */
662
663 /*!
664   \brief call __builtin_alloca to ensure we get gcc builtin semantics
665   \param size The size of the buffer we want allocated
666
667   This macro will attempt to allocate memory from the stack.  If it fails
668   you won't get a NULL returned, but a SEGFAULT if you're lucky.
669 */
670 #define ast_alloca(size) __builtin_alloca(size)
671
672 #if !defined(ast_strdupa) && defined(__GNUC__)
673 /*!
674  * \brief duplicate a string in memory from the stack
675  * \param s The string to duplicate
676  *
677  * This macro will duplicate the given string.  It returns a pointer to the stack
678  * allocatted memory for the new string.
679  */
680 #define ast_strdupa(s)                                                    \
681         (__extension__                                                    \
682         ({                                                                \
683                 const char *__old = (s);                                  \
684                 size_t __len = strlen(__old) + 1;                         \
685                 char *__new = __builtin_alloca(__len);                    \
686                 memcpy (__new, __old, __len);                             \
687                 __new;                                                    \
688         }))
689 #endif
690
691 /*!
692  * \brief Disable PMTU discovery on a socket
693  * \param sock The socket to manipulate
694  * \return Nothing
695  *
696  * On Linux, UDP sockets default to sending packets with the Dont Fragment (DF)
697  * bit set. This is supposedly done to allow the application to do PMTU
698  * discovery, but Asterisk does not do this.
699  *
700  * Because of this, UDP packets sent by Asterisk that are larger than the MTU
701  * of any hop in the path will be lost. This function can be called on a socket
702  * to ensure that the DF bit will not be set.
703  */
704 void ast_enable_packet_fragmentation(int sock);
705
706 /*!
707  * \brief Recursively create directory path
708  * \param path The directory path to create
709  * \param mode The permissions with which to try to create the directory
710  * \return 0 on success or an error code otherwise
711  *
712  * Creates a directory path, creating parent directories as needed.
713  */
714 int ast_mkdir(const char *path, int mode);
715
716 #define ARRAY_LEN(a) (size_t) (sizeof(a) / sizeof(0[a]))
717
718
719 /* Definition for Digest authorization */
720 struct ast_http_digest {
721         AST_DECLARE_STRING_FIELDS(
722                 AST_STRING_FIELD(username);
723                 AST_STRING_FIELD(nonce);
724                 AST_STRING_FIELD(uri);
725                 AST_STRING_FIELD(realm);
726                 AST_STRING_FIELD(domain);
727                 AST_STRING_FIELD(response);
728                 AST_STRING_FIELD(cnonce);
729                 AST_STRING_FIELD(opaque);
730                 AST_STRING_FIELD(nc);
731         );
732         int qop;                /* Flag set to 1, if we send/recv qop="quth" */
733 };
734
735 /*!
736  * \brief Parse digest authorization header.
737  * \return Returns -1 if we have no auth or something wrong with digest.
738  * \note This function may be used for Digest request and responce header.
739  * request arg is set to nonzero, if we parse Digest Request.
740  * pedantic arg can be set to nonzero if we need to do addition Digest check.
741  */
742 int ast_parse_digest(const char *digest, struct ast_http_digest *d, int request, int pedantic);
743
744
745 #ifdef AST_DEVMODE
746 void __ast_assert_failed(int condition, const char *condition_str, const char *file, int line, const char *function);
747 #define ast_assert(a) _ast_assert(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
748 static void force_inline _ast_assert(int condition, const char *condition_str, const char *file, int line, const char *function)
749 {
750         if (__builtin_expect(!condition, 1)) {
751                 __ast_assert_failed(condition, condition_str, file, line, function);
752         }
753 }
754 #else
755 #define ast_assert(a)
756 #endif
757
758 /*!
759  * \brief Force a crash if DO_CRASH is defined.
760  *
761  * \note If DO_CRASH is not defined then the function returns.
762  *
763  * \return Nothing
764  */
765 void ast_do_crash(void);
766
767 #include "asterisk/strings.h"
768
769 /*!
770  * \brief Return the number of bytes used in the alignment of type.
771  * \param type
772  * \return The number of bytes required for alignment.
773  *
774  * This is really just __alignof__(), but tucked away in this header so we
775  * don't have to look at the nasty underscores in the source.
776  */
777 #define ast_alignof(type) __alignof__(type)
778
779 /*!
780  * \brief Increase offset so it is a multiple of the required alignment of type.
781  * \param offset The value that should be increased.
782  * \param type The data type that offset should be aligned to.
783  * \return The smallest multiple of alignof(type) larger than or equal to offset.
784  * \see ast_make_room_for()
785  *
786  * Many systems prefer integers to be stored on aligned on memory locations.
787  * This macro will increase an offset so a value of the supplied type can be
788  * safely be stored on such a memory location.
789  *
790  * Examples:
791  * ast_align_for(0x17, int64_t) ==> 0x18
792  * ast_align_for(0x18, int64_t) ==> 0x18
793  * ast_align_for(0x19, int64_t) ==> 0x20
794  *
795  * Don't mind the ugliness, the compiler will optimize it.
796  */
797 #define ast_align_for(offset, type) (((offset + __alignof__(type) - 1) / __alignof__(type)) * __alignof__(type))
798
799 /*!
800  * \brief Increase offset by the required alignment of type and make sure it is
801  *        a multiple of said alignment.
802  * \param offset The value that should be increased.
803  * \param type The data type that room should be reserved for.
804  * \return The smallest multiple of alignof(type) larger than or equal to offset
805  *         plus alignof(type).
806  * \see ast_align_for()
807  *
808  * A use case for this is when prepending length fields of type int to a buffer.
809  * If you keep the offset a multiple of the alignment of the integer type,
810  * a next block of length+buffer will have the length field automatically
811  * aligned.
812  *
813  * Examples:
814  * ast_make_room_for(0x17, int64_t) ==> 0x20
815  * ast_make_room_for(0x18, int64_t) ==> 0x20
816  * ast_make_room_for(0x19, int64_t) ==> 0x28
817  *
818  * Don't mind the ugliness, the compiler will optimize it.
819  */
820 #define ast_make_room_for(offset, type) (((offset + (2 * __alignof__(type) - 1)) / __alignof__(type)) * __alignof__(type))
821
822 /*!
823  * \brief An Entity ID is essentially a MAC address, brief and unique
824  */
825 struct ast_eid {
826         unsigned char eid[6];
827 } __attribute__((__packed__));
828
829 /*!
830  * \brief Global EID
831  *
832  * This is set in asterisk.conf, or determined automatically by taking the mac
833  * address of an Ethernet interface on the system.
834  */
835 extern struct ast_eid ast_eid_default;
836
837 /*!
838  * \brief Fill in an ast_eid with the default eid of this machine
839  * \since 1.6.1
840  */
841 void ast_set_default_eid(struct ast_eid *eid);
842
843 /*!
844  * \brief Convert an EID to a string
845  * \since 1.6.1
846  */
847 char *ast_eid_to_str(char *s, int maxlen, struct ast_eid *eid);
848
849 /*!
850  * \brief Convert a string into an EID
851  *
852  * This function expects an EID in the format:
853  *    00:11:22:33:44:55
854  *
855  * \return 0 success, non-zero failure
856  * \since 1.6.1
857  */
858 int ast_str_to_eid(struct ast_eid *eid, const char *s);
859
860 /*!
861  * \brief Compare two EIDs
862  *
863  * \return 0 if the two are the same, non-zero otherwise
864  * \since 1.6.1
865  */
866 int ast_eid_cmp(const struct ast_eid *eid1, const struct ast_eid *eid2);
867
868 /*!
869  * \brief Get current thread ID
870  * \return the ID if platform is supported, else -1
871  */
872 int ast_get_tid(void);
873
874 /*!
875  * \brief Resolve a binary to a full pathname
876  * \param binary Name of the executable to resolve
877  * \param fullpath Buffer to hold the complete pathname
878  * \param fullpath_size Size of \a fullpath
879  * \retval NULL \a binary was not found or the environment variable PATH is not set
880  * \return \a fullpath
881  */
882 char *ast_utils_which(const char *binary, char *fullpath, size_t fullpath_size);
883
884 /*!
885  * \brief Declare a variable that will call a destructor function when it goes out of scope.
886  *
887  * Resource Allocation Is Initialization (RAII) variable declaration.
888  *
889  * \since 11.0
890  * \param vartype The type of the variable
891  * \param varname The name of the variable
892  * \param initval The initial value of the variable
893  * \param dtor The destructor function of type' void func(vartype *)'
894  *
895  * \code
896  * void mything_cleanup(struct mything *t)
897  * {
898  *     if (t) {
899  *         ast_free(t->stuff);
900  *     }
901  * }
902  *
903  * void do_stuff(const char *name)
904  * {
905  *     RAII_VAR(struct mything *, thing, mything_alloc(name), mything_cleanup);
906  *     ...
907  * }
908  * \endcode
909  *
910  * \note This macro is especially useful for working with ao2 objects. A common idiom
911  * would be a function that needed to look up an ao2 object and might have several error
912  * conditions after the allocation that would normally need to unref the ao2 object.
913  * With RAII_VAR, it is possible to just return and leave the cleanup to the destructor
914  * function. For example:
915  *
916  * \code
917  * void do_stuff(const char *name)
918  * {
919  *     RAII_VAR(struct mything *, thing, find_mything(name), ao2_cleanup);
920  *     if (!thing) {
921  *         return;
922  *     }
923  *     if (error) {
924  *         return;
925  *     }
926  *     do_stuff_with_thing(thing);
927  * }
928  * \endcode
929  */
930 #define RAII_VAR(vartype, varname, initval, dtor) \
931     /* Prototype needed due to http://gcc.gnu.org/bugzilla/show_bug.cgi?id=36774 */ \
932     auto void _dtor_ ## varname (vartype * v); \
933     void _dtor_ ## varname (vartype * v) { dtor(*v); } \
934     vartype varname __attribute__((cleanup(_dtor_ ## varname))) = (initval)
935
936 #endif /* _ASTERISK_UTILS_H */