c3df4779ff139eba8f5e3d40eb5a570da1b355f7
[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 /*!
321  * \brief Escape semicolons found in a string.
322  *
323  * \param string string to be escaped
324  * \param outbuf resulting escaped string
325  * \param buflen size of output buffer
326  * \return a pointer to the escaped string
327  */
328 char *ast_escape_semicolons(const char *string, char *outbuf, int buflen);
329
330 /*!
331  * \brief Unescape quotes in a string
332  *
333  * \param quote_str The string with quotes to be unescaped
334  *
335  * \note This function mutates the passed-in string.
336  */
337 void ast_unescape_quoted(char *quote_str);
338
339 static force_inline void ast_slinear_saturated_add(short *input, short *value)
340 {
341         int res;
342
343         res = (int) *input + *value;
344         if (res > 32767)
345                 *input = 32767;
346         else if (res < -32768)
347                 *input = -32768;
348         else
349                 *input = (short) res;
350 }
351
352 static force_inline void ast_slinear_saturated_subtract(short *input, short *value)
353 {
354         int res;
355
356         res = (int) *input - *value;
357         if (res > 32767)
358                 *input = 32767;
359         else if (res < -32768)
360                 *input = -32768;
361         else
362                 *input = (short) res;
363 }
364
365 static force_inline void ast_slinear_saturated_multiply(short *input, short *value)
366 {
367         int res;
368
369         res = (int) *input * *value;
370         if (res > 32767)
371                 *input = 32767;
372         else if (res < -32768)
373                 *input = -32768;
374         else
375                 *input = (short) res;
376 }
377
378 static force_inline void ast_slinear_saturated_divide(short *input, short *value)
379 {
380         *input /= *value;
381 }
382
383 #ifdef localtime_r
384 #undef localtime_r
385 #endif
386 #define localtime_r __dont_use_localtime_r_use_ast_localtime_instead__
387
388 int ast_utils_init(void);
389 int ast_wait_for_input(int fd, int ms);
390 int ast_wait_for_output(int fd, int ms);
391
392 /*!
393  * \brief Try to write string, but wait no more than ms milliseconds
394  * before timing out.
395  *
396  * \note If you are calling ast_carefulwrite, it is assumed that you are calling
397  * it on a file descriptor that _DOES_ have NONBLOCK set.  This way,
398  * there is only one system call made to do a write, unless we actually
399  * have a need to wait.  This way, we get better performance.
400  */
401 int ast_carefulwrite(int fd, char *s, int len, int timeoutms);
402
403 /*!
404  * \brief Write data to a file stream with a timeout
405  *
406  * \param f the file stream to write to
407  * \param fd the file description to poll on to know when the file stream can
408  *        be written to without blocking.
409  * \param s the buffer to write from
410  * \param len the number of bytes to write
411  * \param timeoutms The maximum amount of time to block in this function trying
412  *        to write, specified in milliseconds.
413  *
414  * \note This function assumes that the associated file stream has been set up
415  *       as non-blocking.
416  *
417  * \retval 0 success
418  * \retval -1 error
419  */
420 int ast_careful_fwrite(FILE *f, int fd, const char *s, size_t len, int timeoutms);
421
422 /*
423  * Thread management support (should be moved to lock.h or a different header)
424  */
425
426 #define AST_STACKSIZE (((sizeof(void *) * 8 * 8) - 16) * 1024)
427
428 #if defined(LOW_MEMORY)
429 #define AST_BACKGROUND_STACKSIZE (((sizeof(void *) * 8 * 2) - 16) * 1024)
430 #else
431 #define AST_BACKGROUND_STACKSIZE AST_STACKSIZE
432 #endif
433
434 void ast_register_thread(char *name);
435 void ast_unregister_thread(void *id);
436
437 int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
438                              void *data, size_t stacksize, const char *file, const char *caller,
439                              int line, const char *start_fn);
440
441 int ast_pthread_create_detached_stack(pthread_t *thread, pthread_attr_t *attr, void*(*start_routine)(void *),
442                                  void *data, size_t stacksize, const char *file, const char *caller,
443                                  int line, const char *start_fn);
444
445 #define ast_pthread_create(a, b, c, d)                          \
446         ast_pthread_create_stack(a, b, c, d,                    \
447                 0, __FILE__, __FUNCTION__, __LINE__, #c)
448
449 #define ast_pthread_create_detached(a, b, c, d)                 \
450         ast_pthread_create_detached_stack(a, b, c, d,           \
451                 0, __FILE__, __FUNCTION__, __LINE__, #c)
452
453 #define ast_pthread_create_background(a, b, c, d)               \
454         ast_pthread_create_stack(a, b, c, d,                    \
455                 AST_BACKGROUND_STACKSIZE,                       \
456                 __FILE__, __FUNCTION__, __LINE__, #c)
457
458 #define ast_pthread_create_detached_background(a, b, c, d)      \
459         ast_pthread_create_detached_stack(a, b, c, d,           \
460                 AST_BACKGROUND_STACKSIZE,                       \
461                 __FILE__, __FUNCTION__, __LINE__, #c)
462
463 /* End of thread management support */
464
465 /*!
466  * \brief Replace '^' in a string with ','
467  * \param s String within which to replace characters
468  */
469 void ast_replace_subargument_delimiter(char *s);
470
471 /*!
472  * \brief Process a string to find and replace characters
473  * \param start The string to analyze
474  * \param find The character to find
475  * \param replace_with The character that will replace the one we are looking for
476  */
477 char *ast_process_quotes_and_slashes(char *start, char find, char replace_with);
478
479 long int ast_random(void);
480
481 /*!
482  * \brief Returns a random number between 0.0 and 1.0, inclusive.
483  * \since 12
484  */
485 #define ast_random_double() (((double)ast_random()) / RAND_MAX)
486
487 /*!
488  * \brief DEBUG_CHAOS returns failure randomly
489  *
490  * DEBUG_CHAOS_RETURN(failure); can be used to fake
491  * failure of functions such as memory allocation,
492  * for the purposes of testing failure handling.
493  */
494 #ifdef DEBUG_CHAOS
495 #ifndef DEBUG_CHAOS_ALLOC_CHANCE
496 #define DEBUG_CHAOS_ALLOC_CHANCE 100000
497 #endif
498 /* Could #define DEBUG_CHAOS_ENABLE ast_fully_booted */
499 #ifndef DEBUG_CHAOS_ENABLE
500 #define DEBUG_CHAOS_ENABLE 1
501 #endif
502 #define DEBUG_CHAOS_RETURN(CHANCE, FAILURE) \
503         do { \
504                 if ((DEBUG_CHAOS_ENABLE) && (ast_random() % CHANCE == 0)) { \
505                         return FAILURE; \
506                 } \
507         } while (0)
508 #else
509 #define DEBUG_CHAOS_RETURN(c,f)
510 #endif
511
512
513 #ifndef __AST_DEBUG_MALLOC
514 #define ast_std_malloc malloc
515 #define ast_std_calloc calloc
516 #define ast_std_realloc realloc
517 #define ast_std_free free
518
519 /*!
520  * \brief free() wrapper
521  *
522  * ast_free_ptr should be used when a function pointer for free() needs to be passed
523  * as the argument to a function. Otherwise, astmm will cause seg faults.
524  */
525 #define ast_free free
526 #define ast_free_ptr ast_free
527
528 #if defined(AST_IN_CORE)
529 #define MALLOC_FAILURE_MSG \
530         ast_log_safe(LOG_ERROR, "Memory Allocation Failure in function %s at line %d of %s\n", func, lineno, file)
531 #else
532 #define MALLOC_FAILURE_MSG \
533         ast_log(LOG_ERROR, "Memory Allocation Failure in function %s at line %d of %s\n", func, lineno, file)
534 #endif
535
536 /*!
537  * \brief A wrapper for malloc()
538  *
539  * ast_malloc() is a wrapper for malloc() that will generate an Asterisk log
540  * message in the case that the allocation fails.
541  *
542  * The argument and return value are the same as malloc()
543  */
544 #define ast_malloc(len) \
545         _ast_malloc((len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
546
547 AST_INLINE_API(
548 void * attribute_malloc _ast_malloc(size_t len, const char *file, int lineno, const char *func),
549 {
550         void *p;
551
552         DEBUG_CHAOS_RETURN(DEBUG_CHAOS_ALLOC_CHANCE, NULL);
553
554         if (!(p = malloc(len))) {
555                 MALLOC_FAILURE_MSG;
556         }
557
558         return p;
559 }
560 )
561
562 /*!
563  * \brief A wrapper for calloc()
564  *
565  * ast_calloc() is a wrapper for calloc() that will generate an Asterisk log
566  * message in the case that the allocation fails.
567  *
568  * The arguments and return value are the same as calloc()
569  */
570 #define ast_calloc(num, len) \
571         _ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
572
573 AST_INLINE_API(
574 void * attribute_malloc _ast_calloc(size_t num, size_t len, const char *file, int lineno, const char *func),
575 {
576         void *p;
577
578         DEBUG_CHAOS_RETURN(DEBUG_CHAOS_ALLOC_CHANCE, NULL);
579
580         if (!(p = calloc(num, len))) {
581                 MALLOC_FAILURE_MSG;
582         }
583
584         return p;
585 }
586 )
587
588 /*!
589  * \brief A wrapper for calloc() for use in cache pools
590  *
591  * ast_calloc_cache() is a wrapper for calloc() that will generate an Asterisk log
592  * message in the case that the allocation fails. When memory debugging is in use,
593  * the memory allocated by this function will be marked as 'cache' so it can be
594  * distinguished from normal memory allocations.
595  *
596  * The arguments and return value are the same as calloc()
597  */
598 #define ast_calloc_cache(num, len) \
599         _ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
600
601 /*!
602  * \brief A wrapper for realloc()
603  *
604  * ast_realloc() is a wrapper for realloc() that will generate an Asterisk log
605  * message in the case that the allocation fails.
606  *
607  * The arguments and return value are the same as realloc()
608  */
609 #define ast_realloc(p, len) \
610         _ast_realloc((p), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
611
612 AST_INLINE_API(
613 void * attribute_malloc _ast_realloc(void *p, size_t len, const char *file, int lineno, const char *func),
614 {
615         void *newp;
616
617         DEBUG_CHAOS_RETURN(DEBUG_CHAOS_ALLOC_CHANCE, NULL);
618
619         if (!(newp = realloc(p, len))) {
620                 MALLOC_FAILURE_MSG;
621         }
622
623         return newp;
624 }
625 )
626
627 /*!
628  * \brief A wrapper for strdup()
629  *
630  * ast_strdup() is a wrapper for strdup() that will generate an Asterisk log
631  * message in the case that the allocation fails.
632  *
633  * ast_strdup(), unlike strdup(), can safely accept a NULL argument. If a NULL
634  * argument is provided, ast_strdup will return NULL without generating any
635  * kind of error log message.
636  *
637  * The argument and return value are the same as strdup()
638  */
639 #define ast_strdup(str) \
640         _ast_strdup((str), __FILE__, __LINE__, __PRETTY_FUNCTION__)
641
642 AST_INLINE_API(
643 char * attribute_malloc _ast_strdup(const char *str, const char *file, int lineno, const char *func),
644 {
645         char *newstr = NULL;
646
647         DEBUG_CHAOS_RETURN(DEBUG_CHAOS_ALLOC_CHANCE, NULL);
648
649         if (str) {
650                 if (!(newstr = strdup(str))) {
651                         MALLOC_FAILURE_MSG;
652                 }
653         }
654
655         return newstr;
656 }
657 )
658
659 /*!
660  * \brief A wrapper for strndup()
661  *
662  * ast_strndup() is a wrapper for strndup() that will generate an Asterisk log
663  * message in the case that the allocation fails.
664  *
665  * ast_strndup(), unlike strndup(), can safely accept a NULL argument for the
666  * string to duplicate. If a NULL argument is provided, ast_strdup will return
667  * NULL without generating any kind of error log message.
668  *
669  * The arguments and return value are the same as strndup()
670  */
671 #define ast_strndup(str, len) \
672         _ast_strndup((str), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
673
674 AST_INLINE_API(
675 char * attribute_malloc _ast_strndup(const char *str, size_t len, const char *file, int lineno, const char *func),
676 {
677         char *newstr = NULL;
678
679         DEBUG_CHAOS_RETURN(DEBUG_CHAOS_ALLOC_CHANCE, NULL);
680
681         if (str) {
682                 if (!(newstr = strndup(str, len))) {
683                         MALLOC_FAILURE_MSG;
684                 }
685         }
686
687         return newstr;
688 }
689 )
690
691 /*!
692  * \brief A wrapper for asprintf()
693  *
694  * ast_asprintf() is a wrapper for asprintf() that will generate an Asterisk log
695  * message in the case that the allocation fails.
696  *
697  * The arguments and return value are the same as asprintf()
698  */
699 #define ast_asprintf(ret, fmt, ...) \
700         _ast_asprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, fmt, __VA_ARGS__)
701
702 int __attribute__((format(printf, 5, 6)))
703         _ast_asprintf(char **ret, const char *file, int lineno, const char *func, const char *fmt, ...);
704
705 /*!
706  * \brief A wrapper for vasprintf()
707  *
708  * ast_vasprintf() is a wrapper for vasprintf() that will generate an Asterisk log
709  * message in the case that the allocation fails.
710  *
711  * The arguments and return value are the same as vasprintf()
712  */
713 #define ast_vasprintf(ret, fmt, ap) \
714         _ast_vasprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, (fmt), (ap))
715
716 AST_INLINE_API(
717 __attribute__((format(printf, 5, 0)))
718 int _ast_vasprintf(char **ret, const char *file, int lineno, const char *func, const char *fmt, va_list ap),
719 {
720         int res;
721
722         DEBUG_CHAOS_RETURN(DEBUG_CHAOS_ALLOC_CHANCE, -1);
723
724         if ((res = vasprintf(ret, fmt, ap)) == -1) {
725                 MALLOC_FAILURE_MSG;
726         }
727
728         return res;
729 }
730 )
731
732 #endif /* AST_DEBUG_MALLOC */
733
734 /*!
735   \brief call __builtin_alloca to ensure we get gcc builtin semantics
736   \param size The size of the buffer we want allocated
737
738   This macro will attempt to allocate memory from the stack.  If it fails
739   you won't get a NULL returned, but a SEGFAULT if you're lucky.
740 */
741 #define ast_alloca(size) __builtin_alloca(size)
742
743 #if !defined(ast_strdupa) && defined(__GNUC__)
744 /*!
745  * \brief duplicate a string in memory from the stack
746  * \param s The string to duplicate
747  *
748  * This macro will duplicate the given string.  It returns a pointer to the stack
749  * allocatted memory for the new string.
750  */
751 #define ast_strdupa(s)                                                    \
752         (__extension__                                                    \
753         ({                                                                \
754                 const char *__old = (s);                                  \
755                 size_t __len = strlen(__old) + 1;                         \
756                 char *__new = __builtin_alloca(__len);                    \
757                 memcpy (__new, __old, __len);                             \
758                 __new;                                                    \
759         }))
760 #endif
761
762 /*!
763  * \brief Disable PMTU discovery on a socket
764  * \param sock The socket to manipulate
765  * \return Nothing
766  *
767  * On Linux, UDP sockets default to sending packets with the Dont Fragment (DF)
768  * bit set. This is supposedly done to allow the application to do PMTU
769  * discovery, but Asterisk does not do this.
770  *
771  * Because of this, UDP packets sent by Asterisk that are larger than the MTU
772  * of any hop in the path will be lost. This function can be called on a socket
773  * to ensure that the DF bit will not be set.
774  */
775 void ast_enable_packet_fragmentation(int sock);
776
777 /*!
778  * \brief Recursively create directory path
779  * \param path The directory path to create
780  * \param mode The permissions with which to try to create the directory
781  * \return 0 on success or an error code otherwise
782  *
783  * Creates a directory path, creating parent directories as needed.
784  */
785 int ast_mkdir(const char *path, int mode);
786
787 /*!
788  * \brief Recursively create directory path, but only if it resolves within
789  * the given \a base_path.
790  *
791  * If \a base_path does not exist, it will not be created and this function
792  * returns \c EPERM.
793  *
794  * \param path The directory path to create
795  * \param mode The permissions with which to try to create the directory
796  * \return 0 on success or an error code otherwise
797  */
798 int ast_safe_mkdir(const char *base_path, const char *path, int mode);
799
800 #define ARRAY_LEN(a) (size_t) (sizeof(a) / sizeof(0[a]))
801
802 /*!
803  * \brief Checks to see if value is within the given bounds
804  *
805  * \param v the value to check
806  * \param min minimum lower bound (inclusive)
807  * \param max maximum upper bound (inclusive)
808  * \return 0 if value out of bounds, otherwise true (non-zero)
809  */
810 #define IN_BOUNDS(v, min, max) ((v) >= (min)) && ((v) <= (max))
811
812 /*!
813  * \brief Checks to see if value is within the bounds of the given array
814  *
815  * \param v the value to check
816  * \param a the array to bound check
817  * \return 0 if value out of bounds, otherwise true (non-zero)
818  */
819 #define ARRAY_IN_BOUNDS(v, a) IN_BOUNDS((int) (v), 0, ARRAY_LEN(a) - 1)
820
821 /* Definition for Digest authorization */
822 struct ast_http_digest {
823         AST_DECLARE_STRING_FIELDS(
824                 AST_STRING_FIELD(username);
825                 AST_STRING_FIELD(nonce);
826                 AST_STRING_FIELD(uri);
827                 AST_STRING_FIELD(realm);
828                 AST_STRING_FIELD(domain);
829                 AST_STRING_FIELD(response);
830                 AST_STRING_FIELD(cnonce);
831                 AST_STRING_FIELD(opaque);
832                 AST_STRING_FIELD(nc);
833         );
834         int qop;                /* Flag set to 1, if we send/recv qop="quth" */
835 };
836
837 /*!
838  * \brief Parse digest authorization header.
839  * \return Returns -1 if we have no auth or something wrong with digest.
840  * \note This function may be used for Digest request and responce header.
841  * request arg is set to nonzero, if we parse Digest Request.
842  * pedantic arg can be set to nonzero if we need to do addition Digest check.
843  */
844 int ast_parse_digest(const char *digest, struct ast_http_digest *d, int request, int pedantic);
845
846 #ifdef DO_CRASH
847 #define DO_CRASH_NORETURN attribute_noreturn
848 #else
849 #define DO_CRASH_NORETURN
850 #endif
851
852 #ifdef AST_DEVMODE
853 void DO_CRASH_NORETURN __ast_assert_failed(int condition, const char *condition_str, const char *file, int line, const char *function);
854 #define ast_assert(a) _ast_assert(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
855 static void force_inline _ast_assert(int condition, const char *condition_str, const char *file, int line, const char *function)
856 {
857         if (__builtin_expect(!condition, 1)) {
858                 __ast_assert_failed(condition, condition_str, file, line, function);
859         }
860 }
861 #else
862 #define ast_assert(a)
863 #endif
864
865 /*!
866  * \brief Force a crash if DO_CRASH is defined.
867  *
868  * \note If DO_CRASH is not defined then the function returns.
869  *
870  * \return Nothing
871  */
872 void DO_CRASH_NORETURN ast_do_crash(void);
873
874 #include "asterisk/strings.h"
875
876 /*!
877  * \brief Return the number of bytes used in the alignment of type.
878  * \param type
879  * \return The number of bytes required for alignment.
880  *
881  * This is really just __alignof__(), but tucked away in this header so we
882  * don't have to look at the nasty underscores in the source.
883  */
884 #define ast_alignof(type) __alignof__(type)
885
886 /*!
887  * \brief Increase offset so it is a multiple of the required alignment of type.
888  * \param offset The value that should be increased.
889  * \param type The data type that offset should be aligned to.
890  * \return The smallest multiple of alignof(type) larger than or equal to offset.
891  * \see ast_make_room_for()
892  *
893  * Many systems prefer integers to be stored on aligned on memory locations.
894  * This macro will increase an offset so a value of the supplied type can be
895  * safely be stored on such a memory location.
896  *
897  * Examples:
898  * ast_align_for(0x17, int64_t) ==> 0x18
899  * ast_align_for(0x18, int64_t) ==> 0x18
900  * ast_align_for(0x19, int64_t) ==> 0x20
901  *
902  * Don't mind the ugliness, the compiler will optimize it.
903  */
904 #define ast_align_for(offset, type) (((offset + __alignof__(type) - 1) / __alignof__(type)) * __alignof__(type))
905
906 /*!
907  * \brief Increase offset by the required alignment of type and make sure it is
908  *        a multiple of said alignment.
909  * \param offset The value that should be increased.
910  * \param type The data type that room should be reserved for.
911  * \return The smallest multiple of alignof(type) larger than or equal to offset
912  *         plus alignof(type).
913  * \see ast_align_for()
914  *
915  * A use case for this is when prepending length fields of type int to a buffer.
916  * If you keep the offset a multiple of the alignment of the integer type,
917  * a next block of length+buffer will have the length field automatically
918  * aligned.
919  *
920  * Examples:
921  * ast_make_room_for(0x17, int64_t) ==> 0x20
922  * ast_make_room_for(0x18, int64_t) ==> 0x20
923  * ast_make_room_for(0x19, int64_t) ==> 0x28
924  *
925  * Don't mind the ugliness, the compiler will optimize it.
926  */
927 #define ast_make_room_for(offset, type) (((offset + (2 * __alignof__(type) - 1)) / __alignof__(type)) * __alignof__(type))
928
929 /*!
930  * \brief An Entity ID is essentially a MAC address, brief and unique
931  */
932 struct ast_eid {
933         unsigned char eid[6];
934 } __attribute__((__packed__));
935
936 /*!
937  * \brief Global EID
938  *
939  * This is set in asterisk.conf, or determined automatically by taking the mac
940  * address of an Ethernet interface on the system.
941  */
942 extern struct ast_eid ast_eid_default;
943
944 /*!
945  * \brief Fill in an ast_eid with the default eid of this machine
946  * \since 1.6.1
947  */
948 void ast_set_default_eid(struct ast_eid *eid);
949
950 /*!
951  * \brief Convert an EID to a string
952  * \since 1.6.1
953  */
954 char *ast_eid_to_str(char *s, int maxlen, struct ast_eid *eid);
955
956 /*!
957  * \brief Convert a string into an EID
958  *
959  * This function expects an EID in the format:
960  *    00:11:22:33:44:55
961  *
962  * \return 0 success, non-zero failure
963  * \since 1.6.1
964  */
965 int ast_str_to_eid(struct ast_eid *eid, const char *s);
966
967 /*!
968  * \brief Compare two EIDs
969  *
970  * \return 0 if the two are the same, non-zero otherwise
971  * \since 1.6.1
972  */
973 int ast_eid_cmp(const struct ast_eid *eid1, const struct ast_eid *eid2);
974
975 /*!
976  * \brief Check if EID is empty
977  *
978  * \return 1 if the EID is empty, zero otherwise
979  * \since 13.12.0
980  */
981 int ast_eid_is_empty(const struct ast_eid *eid);
982
983 /*!
984  * \brief Get current thread ID
985  * \return the ID if platform is supported, else -1
986  */
987 int ast_get_tid(void);
988
989 /*!
990  * \brief Resolve a binary to a full pathname
991  * \param binary Name of the executable to resolve
992  * \param fullpath Buffer to hold the complete pathname
993  * \param fullpath_size Size of \a fullpath
994  * \retval NULL \a binary was not found or the environment variable PATH is not set
995  * \return \a fullpath
996  */
997 char *ast_utils_which(const char *binary, char *fullpath, size_t fullpath_size);
998
999 /*!
1000  * \brief Declare a variable that will call a destructor function when it goes out of scope.
1001  *
1002  * Resource Allocation Is Initialization (RAII) variable declaration.
1003  *
1004  * \since 11.0
1005  * \param vartype The type of the variable
1006  * \param varname The name of the variable
1007  * \param initval The initial value of the variable
1008  * \param dtor The destructor function of type' void func(vartype *)'
1009  *
1010  * \code
1011  * void mything_cleanup(struct mything *t)
1012  * {
1013  *     if (t) {
1014  *         ast_free(t->stuff);
1015  *     }
1016  * }
1017  *
1018  * void do_stuff(const char *name)
1019  * {
1020  *     RAII_VAR(struct mything *, thing, mything_alloc(name), mything_cleanup);
1021  *     ...
1022  * }
1023  * \endcode
1024  *
1025  * \note This macro is especially useful for working with ao2 objects. A common idiom
1026  * would be a function that needed to look up an ao2 object and might have several error
1027  * conditions after the allocation that would normally need to unref the ao2 object.
1028  * With RAII_VAR, it is possible to just return and leave the cleanup to the destructor
1029  * function. For example:
1030  *
1031  * \code
1032  * void do_stuff(const char *name)
1033  * {
1034  *     RAII_VAR(struct mything *, thing, find_mything(name), ao2_cleanup);
1035  *     if (!thing) {
1036  *         return;
1037  *     }
1038  *     if (error) {
1039  *         return;
1040  *     }
1041  *     do_stuff_with_thing(thing);
1042  * }
1043  * \endcode
1044  */
1045
1046 #if defined(__clang__)
1047 typedef void (^_raii_cleanup_block_t)(void);
1048 static inline void _raii_cleanup_block(_raii_cleanup_block_t *b) { (*b)(); }
1049
1050 #define RAII_VAR(vartype, varname, initval, dtor)                                                                \
1051     _raii_cleanup_block_t _raii_cleanup_ ## varname __attribute__((cleanup(_raii_cleanup_block),unused)) = NULL; \
1052     __block vartype varname = initval;                                                                           \
1053     _raii_cleanup_ ## varname = ^{ {(void)dtor(varname);} }
1054
1055 #elif defined(__GNUC__)
1056
1057 #define RAII_VAR(vartype, varname, initval, dtor)                              \
1058     auto void _dtor_ ## varname (vartype * v);                                 \
1059     void _dtor_ ## varname (vartype * v) { dtor(*v); }                         \
1060     vartype varname __attribute__((cleanup(_dtor_ ## varname))) = (initval)
1061
1062 #else
1063     #error "Cannot compile Asterisk: unknown and unsupported compiler."
1064 #endif /* #if __GNUC__ */
1065
1066 /*!
1067  * \brief Asterisk wrapper around crypt(3).
1068  *
1069  * The interpretation of the salt (which determines the password hashing
1070  * algorithm) is system specific. Application code should prefer to use
1071  * ast_crypt_encrypt() or ast_crypt_validate().
1072  *
1073  * The returned string is heap allocated, and should be freed with ast_free().
1074  *
1075  * \param key User's password to crypt.
1076  * \param salt Salt to crypt with.
1077  * \return Crypted password.
1078  * \return \c NULL on error.
1079  */
1080 char *ast_crypt(const char *key, const char *salt);
1081
1082 /*
1083  * \brief Asterisk wrapper around crypt(3) for encrypting passwords.
1084  *
1085  * This function will generate a random salt and encrypt the given password.
1086  *
1087  * The returned string is heap allocated, and should be freed with ast_free().
1088  *
1089  * \param key User's password to crypt.
1090  * \return Crypted password.
1091  * \return \c NULL on error.
1092  */
1093 char *ast_crypt_encrypt(const char *key);
1094
1095 /*
1096  * \brief Asterisk wrapper around crypt(3) for validating passwords.
1097  *
1098  * \param key User's password to validate.
1099  * \param expected Expected result from crypt.
1100  * \return True (non-zero) if \a key matches \a expected.
1101  * \return False (zero) if \a key doesn't match.
1102  */
1103 int ast_crypt_validate(const char *key, const char *expected);
1104
1105 /*
1106  * \brief Test that a file exists and is readable by the effective user.
1107  * \since 13.7.0
1108  *
1109  * \param filename File to test.
1110  * \return True (non-zero) if the file exists and is readable.
1111  * \return False (zero) if the file either doesn't exists or is not readable.
1112  */
1113 int ast_file_is_readable(const char *filename);
1114
1115 /*
1116  * \brief Compare 2 major.minor.patch.extra version strings.
1117  * \since 13.7.0
1118  *
1119  * \param version1.
1120  * \param version2.
1121  *
1122  * \return <0 if version 1 < version 2.
1123  * \return =0 if version 1 = version 2.
1124  * \return >0 if version 1 > version 2.
1125  */
1126 int ast_compare_versions(const char *version1, const char *version2);
1127
1128 #endif /* _ASTERISK_UTILS_H */