core: Stop using AST_INLINE_API for allocator functions.
[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 #define AST_STACKSIZE_LOW (((sizeof(void *) * 8 * 2) - 16) * 1024)
428
429 int ast_background_stacksize(void);
430
431 #define AST_BACKGROUND_STACKSIZE ast_background_stacksize()
432
433 void ast_register_thread(char *name);
434 void ast_unregister_thread(void *id);
435
436 int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
437                              void *data, size_t stacksize, const char *file, const char *caller,
438                              int line, const char *start_fn);
439
440 int ast_pthread_create_detached_stack(pthread_t *thread, pthread_attr_t *attr, void*(*start_routine)(void *),
441                                  void *data, size_t stacksize, const char *file, const char *caller,
442                                  int line, const char *start_fn);
443
444 #define ast_pthread_create(a, b, c, d)                          \
445         ast_pthread_create_stack(a, b, c, d,                    \
446                 0, __FILE__, __FUNCTION__, __LINE__, #c)
447
448 #define ast_pthread_create_detached(a, b, c, d)                 \
449         ast_pthread_create_detached_stack(a, b, c, d,           \
450                 0, __FILE__, __FUNCTION__, __LINE__, #c)
451
452 #define ast_pthread_create_background(a, b, c, d)               \
453         ast_pthread_create_stack(a, b, c, d,                    \
454                 AST_BACKGROUND_STACKSIZE,                       \
455                 __FILE__, __FUNCTION__, __LINE__, #c)
456
457 #define ast_pthread_create_detached_background(a, b, c, d)      \
458         ast_pthread_create_detached_stack(a, b, c, d,           \
459                 AST_BACKGROUND_STACKSIZE,                       \
460                 __FILE__, __FUNCTION__, __LINE__, #c)
461
462 /* End of thread management support */
463
464 /*!
465  * \brief Replace '^' in a string with ','
466  * \param s String within which to replace characters
467  */
468 void ast_replace_subargument_delimiter(char *s);
469
470 /*!
471  * \brief Process a string to find and replace characters
472  * \param start The string to analyze
473  * \param find The character to find
474  * \param replace_with The character that will replace the one we are looking for
475  */
476 char *ast_process_quotes_and_slashes(char *start, char find, char replace_with);
477
478 long int ast_random(void);
479
480 /*!
481  * \brief Returns a random number between 0.0 and 1.0, inclusive.
482  * \since 12
483  */
484 #define ast_random_double() (((double)ast_random()) / RAND_MAX)
485
486 /*!
487  * \brief Disable PMTU discovery on a socket
488  * \param sock The socket to manipulate
489  * \return Nothing
490  *
491  * On Linux, UDP sockets default to sending packets with the Dont Fragment (DF)
492  * bit set. This is supposedly done to allow the application to do PMTU
493  * discovery, but Asterisk does not do this.
494  *
495  * Because of this, UDP packets sent by Asterisk that are larger than the MTU
496  * of any hop in the path will be lost. This function can be called on a socket
497  * to ensure that the DF bit will not be set.
498  */
499 void ast_enable_packet_fragmentation(int sock);
500
501 /*!
502  * \brief Recursively create directory path
503  * \param path The directory path to create
504  * \param mode The permissions with which to try to create the directory
505  * \return 0 on success or an error code otherwise
506  *
507  * Creates a directory path, creating parent directories as needed.
508  */
509 int ast_mkdir(const char *path, int mode);
510
511 /*!
512  * \brief Recursively create directory path, but only if it resolves within
513  * the given \a base_path.
514  *
515  * If \a base_path does not exist, it will not be created and this function
516  * returns \c EPERM.
517  *
518  * \param path The directory path to create
519  * \param mode The permissions with which to try to create the directory
520  * \return 0 on success or an error code otherwise
521  */
522 int ast_safe_mkdir(const char *base_path, const char *path, int mode);
523
524 #define ARRAY_LEN(a) (size_t) (sizeof(a) / sizeof(0[a]))
525
526 /*!
527  * \brief Checks to see if value is within the given bounds
528  *
529  * \param v the value to check
530  * \param min minimum lower bound (inclusive)
531  * \param max maximum upper bound (inclusive)
532  * \return 0 if value out of bounds, otherwise true (non-zero)
533  */
534 #define IN_BOUNDS(v, min, max) ((v) >= (min)) && ((v) <= (max))
535
536 /*!
537  * \brief Checks to see if value is within the bounds of the given array
538  *
539  * \param v the value to check
540  * \param a the array to bound check
541  * \return 0 if value out of bounds, otherwise true (non-zero)
542  */
543 #define ARRAY_IN_BOUNDS(v, a) IN_BOUNDS((int) (v), 0, ARRAY_LEN(a) - 1)
544
545 /* Definition for Digest authorization */
546 struct ast_http_digest {
547         AST_DECLARE_STRING_FIELDS(
548                 AST_STRING_FIELD(username);
549                 AST_STRING_FIELD(nonce);
550                 AST_STRING_FIELD(uri);
551                 AST_STRING_FIELD(realm);
552                 AST_STRING_FIELD(domain);
553                 AST_STRING_FIELD(response);
554                 AST_STRING_FIELD(cnonce);
555                 AST_STRING_FIELD(opaque);
556                 AST_STRING_FIELD(nc);
557         );
558         int qop;                /* Flag set to 1, if we send/recv qop="quth" */
559 };
560
561 /*!
562  * \brief Parse digest authorization header.
563  * \return Returns -1 if we have no auth or something wrong with digest.
564  * \note This function may be used for Digest request and responce header.
565  * request arg is set to nonzero, if we parse Digest Request.
566  * pedantic arg can be set to nonzero if we need to do addition Digest check.
567  */
568 int ast_parse_digest(const char *digest, struct ast_http_digest *d, int request, int pedantic);
569
570 #ifdef DO_CRASH
571 #define DO_CRASH_NORETURN attribute_noreturn
572 #else
573 #define DO_CRASH_NORETURN
574 #endif
575
576 void DO_CRASH_NORETURN __ast_assert_failed(int condition, const char *condition_str,
577         const char *file, int line, const char *function);
578
579 #ifdef AST_DEVMODE
580 #define ast_assert(a) _ast_assert(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
581 static void force_inline _ast_assert(int condition, const char *condition_str, const char *file, int line, const char *function)
582 {
583         if (__builtin_expect(!condition, 1)) {
584                 __ast_assert_failed(condition, condition_str, file, line, function);
585         }
586 }
587 #else
588 #define ast_assert(a)
589 #endif
590
591 /*!
592  * \brief Force a crash if DO_CRASH is defined.
593  *
594  * \note If DO_CRASH is not defined then the function returns.
595  *
596  * \return Nothing
597  */
598 void DO_CRASH_NORETURN ast_do_crash(void);
599
600 #include "asterisk/strings.h"
601
602 /*!
603  * \brief Return the number of bytes used in the alignment of type.
604  * \param type
605  * \return The number of bytes required for alignment.
606  *
607  * This is really just __alignof__(), but tucked away in this header so we
608  * don't have to look at the nasty underscores in the source.
609  */
610 #define ast_alignof(type) __alignof__(type)
611
612 /*!
613  * \brief Increase offset so it is a multiple of the required alignment of type.
614  * \param offset The value that should be increased.
615  * \param type The data type that offset should be aligned to.
616  * \return The smallest multiple of alignof(type) larger than or equal to offset.
617  * \see ast_make_room_for()
618  *
619  * Many systems prefer integers to be stored on aligned on memory locations.
620  * This macro will increase an offset so a value of the supplied type can be
621  * safely be stored on such a memory location.
622  *
623  * Examples:
624  * ast_align_for(0x17, int64_t) ==> 0x18
625  * ast_align_for(0x18, int64_t) ==> 0x18
626  * ast_align_for(0x19, int64_t) ==> 0x20
627  *
628  * Don't mind the ugliness, the compiler will optimize it.
629  */
630 #define ast_align_for(offset, type) (((offset + __alignof__(type) - 1) / __alignof__(type)) * __alignof__(type))
631
632 /*!
633  * \brief Increase offset by the required alignment of type and make sure it is
634  *        a multiple of said alignment.
635  * \param offset The value that should be increased.
636  * \param type The data type that room should be reserved for.
637  * \return The smallest multiple of alignof(type) larger than or equal to offset
638  *         plus alignof(type).
639  * \see ast_align_for()
640  *
641  * A use case for this is when prepending length fields of type int to a buffer.
642  * If you keep the offset a multiple of the alignment of the integer type,
643  * a next block of length+buffer will have the length field automatically
644  * aligned.
645  *
646  * Examples:
647  * ast_make_room_for(0x17, int64_t) ==> 0x20
648  * ast_make_room_for(0x18, int64_t) ==> 0x20
649  * ast_make_room_for(0x19, int64_t) ==> 0x28
650  *
651  * Don't mind the ugliness, the compiler will optimize it.
652  */
653 #define ast_make_room_for(offset, type) (((offset + (2 * __alignof__(type) - 1)) / __alignof__(type)) * __alignof__(type))
654
655 /*!
656  * \brief An Entity ID is essentially a MAC address, brief and unique
657  */
658 struct ast_eid {
659         unsigned char eid[6];
660 } __attribute__((__packed__));
661
662 /*!
663  * \brief Global EID
664  *
665  * This is set in asterisk.conf, or determined automatically by taking the mac
666  * address of an Ethernet interface on the system.
667  */
668 extern struct ast_eid ast_eid_default;
669
670 /*!
671  * \brief Fill in an ast_eid with the default eid of this machine
672  * \since 1.6.1
673  */
674 void ast_set_default_eid(struct ast_eid *eid);
675
676 /*!
677  * \brief Convert an EID to a string
678  * \since 1.6.1
679  */
680 char *ast_eid_to_str(char *s, int maxlen, struct ast_eid *eid);
681
682 /*!
683  * \brief Convert a string into an EID
684  *
685  * This function expects an EID in the format:
686  *    00:11:22:33:44:55
687  *
688  * \return 0 success, non-zero failure
689  * \since 1.6.1
690  */
691 int ast_str_to_eid(struct ast_eid *eid, const char *s);
692
693 /*!
694  * \brief Compare two EIDs
695  *
696  * \return 0 if the two are the same, non-zero otherwise
697  * \since 1.6.1
698  */
699 int ast_eid_cmp(const struct ast_eid *eid1, const struct ast_eid *eid2);
700
701 /*!
702  * \brief Check if EID is empty
703  *
704  * \return 1 if the EID is empty, zero otherwise
705  * \since 13.12.0
706  */
707 int ast_eid_is_empty(const struct ast_eid *eid);
708
709 /*!
710  * \brief Get current thread ID
711  * \return the ID if platform is supported, else -1
712  */
713 int ast_get_tid(void);
714
715 /*!
716  * \brief Resolve a binary to a full pathname
717  * \param binary Name of the executable to resolve
718  * \param fullpath Buffer to hold the complete pathname
719  * \param fullpath_size Size of \a fullpath
720  * \retval NULL \a binary was not found or the environment variable PATH is not set
721  * \return \a fullpath
722  */
723 char *ast_utils_which(const char *binary, char *fullpath, size_t fullpath_size);
724
725 /*!
726  * \brief Declare a variable that will call a destructor function when it goes out of scope.
727  *
728  * Resource Allocation Is Initialization (RAII) variable declaration.
729  *
730  * \since 11.0
731  * \param vartype The type of the variable
732  * \param varname The name of the variable
733  * \param initval The initial value of the variable
734  * \param dtor The destructor function of type' void func(vartype *)'
735  *
736  * \code
737  * void mything_cleanup(struct mything *t)
738  * {
739  *     if (t) {
740  *         ast_free(t->stuff);
741  *     }
742  * }
743  *
744  * void do_stuff(const char *name)
745  * {
746  *     RAII_VAR(struct mything *, thing, mything_alloc(name), mything_cleanup);
747  *     ...
748  * }
749  * \endcode
750  *
751  * \note This macro is especially useful for working with ao2 objects. A common idiom
752  * would be a function that needed to look up an ao2 object and might have several error
753  * conditions after the allocation that would normally need to unref the ao2 object.
754  * With RAII_VAR, it is possible to just return and leave the cleanup to the destructor
755  * function. For example:
756  *
757  * \code
758  * void do_stuff(const char *name)
759  * {
760  *     RAII_VAR(struct mything *, thing, find_mything(name), ao2_cleanup);
761  *     if (!thing) {
762  *         return;
763  *     }
764  *     if (error) {
765  *         return;
766  *     }
767  *     do_stuff_with_thing(thing);
768  * }
769  * \endcode
770  */
771
772 #if defined(__clang__)
773 typedef void (^_raii_cleanup_block_t)(void);
774 static inline void _raii_cleanup_block(_raii_cleanup_block_t *b) { (*b)(); }
775
776 #define RAII_VAR(vartype, varname, initval, dtor)                                                                \
777     _raii_cleanup_block_t _raii_cleanup_ ## varname __attribute__((cleanup(_raii_cleanup_block),unused)) = NULL; \
778     __block vartype varname = initval;                                                                           \
779     _raii_cleanup_ ## varname = ^{ {(void)dtor(varname);} }
780
781 #elif defined(__GNUC__)
782
783 #define RAII_VAR(vartype, varname, initval, dtor)                              \
784     auto void _dtor_ ## varname (vartype * v);                                 \
785     void _dtor_ ## varname (vartype * v) { dtor(*v); }                         \
786     vartype varname __attribute__((cleanup(_dtor_ ## varname))) = (initval)
787
788 #else
789     #error "Cannot compile Asterisk: unknown and unsupported compiler."
790 #endif /* #if __GNUC__ */
791
792 /*!
793  * \brief Asterisk wrapper around crypt(3).
794  *
795  * The interpretation of the salt (which determines the password hashing
796  * algorithm) is system specific. Application code should prefer to use
797  * ast_crypt_encrypt() or ast_crypt_validate().
798  *
799  * The returned string is heap allocated, and should be freed with ast_free().
800  *
801  * \param key User's password to crypt.
802  * \param salt Salt to crypt with.
803  * \return Crypted password.
804  * \return \c NULL on error.
805  */
806 char *ast_crypt(const char *key, const char *salt);
807
808 /*
809  * \brief Asterisk wrapper around crypt(3) for encrypting passwords.
810  *
811  * This function will generate a random salt and encrypt the given password.
812  *
813  * The returned string is heap allocated, and should be freed with ast_free().
814  *
815  * \param key User's password to crypt.
816  * \return Crypted password.
817  * \return \c NULL on error.
818  */
819 char *ast_crypt_encrypt(const char *key);
820
821 /*
822  * \brief Asterisk wrapper around crypt(3) for validating passwords.
823  *
824  * \param key User's password to validate.
825  * \param expected Expected result from crypt.
826  * \return True (non-zero) if \a key matches \a expected.
827  * \return False (zero) if \a key doesn't match.
828  */
829 int ast_crypt_validate(const char *key, const char *expected);
830
831 /*
832  * \brief Test that a file exists and is readable by the effective user.
833  * \since 13.7.0
834  *
835  * \param filename File to test.
836  * \return True (non-zero) if the file exists and is readable.
837  * \return False (zero) if the file either doesn't exists or is not readable.
838  */
839 int ast_file_is_readable(const char *filename);
840
841 /*
842  * \brief Compare 2 major.minor.patch.extra version strings.
843  * \since 13.7.0
844  *
845  * \param version1.
846  * \param version2.
847  *
848  * \return <0 if version 1 < version 2.
849  * \return =0 if version 1 = version 2.
850  * \return >0 if version 1 > version 2.
851  */
852 int ast_compare_versions(const char *version1, const char *version2);
853
854 /*
855  * \brief Test that an OS supports IPv6 Networking.
856  * \since 13.14.0
857  *
858  * \return True (non-zero) if the IPv6 supported.
859  * \return False (zero) if the OS doesn't support IPv6.
860  */
861 int ast_check_ipv6(void);
862
863 enum ast_fd_flag_operation {
864         AST_FD_FLAG_SET,
865         AST_FD_FLAG_CLEAR,
866 };
867
868 /*
869  * \brief Set flags on the given file descriptor
870  * \since 13.19
871  *
872  * If getting or setting flags of the given file descriptor fails, logs an
873  * error message.
874  *
875  * \param fd File descriptor to set flags on
876  * \param flags The flag(s) to set
877  *
878  * \return -1 on error
879  * \return 0 if successful
880  */
881 #define ast_fd_set_flags(fd, flags) \
882         __ast_fd_set_flags((fd), (flags), AST_FD_FLAG_SET, __FILE__, __LINE__, __PRETTY_FUNCTION__)
883
884 /*
885  * \brief Clear flags on the given file descriptor
886  * \since 13.19
887  *
888  * If getting or setting flags of the given file descriptor fails, logs an
889  * error message.
890  *
891  * \param fd File descriptor to clear flags on
892  * \param flags The flag(s) to clear
893  *
894  * \return -1 on error
895  * \return 0 if successful
896  */
897 #define ast_fd_clear_flags(fd, flags) \
898         __ast_fd_set_flags((fd), (flags), AST_FD_FLAG_CLEAR, __FILE__, __LINE__, __PRETTY_FUNCTION__)
899
900 int __ast_fd_set_flags(int fd, int flags, enum ast_fd_flag_operation op,
901         const char *file, int lineno, const char *function);
902
903 #endif /* _ASTERISK_UTILS_H */