Fix compiler warnings on Fedora 26 / GCC 7.
[asterisk/asterisk.git] / main / utils.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief Utility functions
20  *
21  * \note These are important for portability and security,
22  * so please use them in favour of other routines.
23  * Please consult the CODING GUIDELINES for more information.
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 #include <ctype.h>
33 #include <fcntl.h>
34 #include <sys/stat.h>
35 #include <sys/syscall.h>
36 #include <unistd.h>
37 #if defined(__APPLE__)
38 #include <mach/mach.h>
39 #elif defined(HAVE_SYS_THR_H)
40 #include <sys/thr.h>
41 #endif
42
43 #include "asterisk/network.h"
44 #include "asterisk/ast_version.h"
45
46 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in lock.h if required */
47 #include "asterisk/lock.h"
48 #include "asterisk/io.h"
49 #include "asterisk/md5.h"
50 #include "asterisk/sha1.h"
51 #include "asterisk/cli.h"
52 #include "asterisk/linkedlists.h"
53 #include "asterisk/astobj2.h"
54
55 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
56 #include "asterisk/strings.h"
57
58 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
59 #include "asterisk/time.h"
60
61 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
62 #include "asterisk/utils.h"
63
64 #define AST_API_MODULE
65 #include "asterisk/threadstorage.h"
66
67 #define AST_API_MODULE
68 #include "asterisk/config.h"
69
70 #define AST_API_MODULE
71 #include "asterisk/alertpipe.h"
72
73 static char base64[64];
74 static char b2a[256];
75
76 AST_THREADSTORAGE(inet_ntoa_buf);
77
78 #if !defined(HAVE_GETHOSTBYNAME_R_5) && !defined(HAVE_GETHOSTBYNAME_R_6)
79
80 #define ERANGE 34       /*!< duh? ERANGE value copied from web... */
81 #undef gethostbyname
82
83 AST_MUTEX_DEFINE_STATIC(__mutex);
84
85 /*! \brief Reentrant replacement for gethostbyname for BSD-based systems.
86 \note This
87 routine is derived from code originally written and placed in the public
88 domain by Enzo Michelangeli <em@em.no-ip.com> */
89
90 static int gethostbyname_r (const char *name, struct hostent *ret, char *buf,
91                                 size_t buflen, struct hostent **result,
92                                 int *h_errnop)
93 {
94         int hsave;
95         struct hostent *ph;
96         ast_mutex_lock(&__mutex); /* begin critical area */
97         hsave = h_errno;
98
99         ph = gethostbyname(name);
100         *h_errnop = h_errno; /* copy h_errno to *h_herrnop */
101         if (ph == NULL) {
102                 *result = NULL;
103         } else {
104                 char **p, **q;
105                 char *pbuf;
106                 int nbytes = 0;
107                 int naddr = 0, naliases = 0;
108                 /* determine if we have enough space in buf */
109
110                 /* count how many addresses */
111                 for (p = ph->h_addr_list; *p != 0; p++) {
112                         nbytes += ph->h_length; /* addresses */
113                         nbytes += sizeof(*p); /* pointers */
114                         naddr++;
115                 }
116                 nbytes += sizeof(*p); /* one more for the terminating NULL */
117
118                 /* count how many aliases, and total length of strings */
119                 for (p = ph->h_aliases; *p != 0; p++) {
120                         nbytes += (strlen(*p)+1); /* aliases */
121                         nbytes += sizeof(*p);  /* pointers */
122                         naliases++;
123                 }
124                 nbytes += sizeof(*p); /* one more for the terminating NULL */
125
126                 /* here nbytes is the number of bytes required in buffer */
127                 /* as a terminator must be there, the minimum value is ph->h_length */
128                 if (nbytes > buflen) {
129                         *result = NULL;
130                         ast_mutex_unlock(&__mutex); /* end critical area */
131                         return ERANGE; /* not enough space in buf!! */
132                 }
133
134                 /* There is enough space. Now we need to do a deep copy! */
135                 /* Allocation in buffer:
136                         from [0] to [(naddr-1) * sizeof(*p)]:
137                         pointers to addresses
138                         at [naddr * sizeof(*p)]:
139                         NULL
140                         from [(naddr+1) * sizeof(*p)] to [(naddr+naliases) * sizeof(*p)] :
141                         pointers to aliases
142                         at [(naddr+naliases+1) * sizeof(*p)]:
143                         NULL
144                         then naddr addresses (fixed length), and naliases aliases (asciiz).
145                 */
146
147                 *ret = *ph;   /* copy whole structure (not its address!) */
148
149                 /* copy addresses */
150                 q = (char **)buf; /* pointer to pointers area (type: char **) */
151                 ret->h_addr_list = q; /* update pointer to address list */
152                 pbuf = buf + ((naddr + naliases + 2) * sizeof(*p)); /* skip that area */
153                 for (p = ph->h_addr_list; *p != 0; p++) {
154                         memcpy(pbuf, *p, ph->h_length); /* copy address bytes */
155                         *q++ = pbuf; /* the pointer is the one inside buf... */
156                         pbuf += ph->h_length; /* advance pbuf */
157                 }
158                 *q++ = NULL; /* address list terminator */
159
160                 /* copy aliases */
161                 ret->h_aliases = q; /* update pointer to aliases list */
162                 for (p = ph->h_aliases; *p != 0; p++) {
163                         strcpy(pbuf, *p); /* copy alias strings */
164                         *q++ = pbuf; /* the pointer is the one inside buf... */
165                         pbuf += strlen(*p); /* advance pbuf */
166                         *pbuf++ = 0; /* string terminator */
167                 }
168                 *q++ = NULL; /* terminator */
169
170                 strcpy(pbuf, ph->h_name); /* copy alias strings */
171                 ret->h_name = pbuf;
172                 pbuf += strlen(ph->h_name); /* advance pbuf */
173                 *pbuf++ = 0; /* string terminator */
174
175                 *result = ret;  /* and let *result point to structure */
176
177         }
178         h_errno = hsave;  /* restore h_errno */
179         ast_mutex_unlock(&__mutex); /* end critical area */
180
181         return (*result == NULL); /* return 0 on success, non-zero on error */
182 }
183
184
185 #endif
186
187 /*! \brief Re-entrant (thread safe) version of gethostbyname that replaces the
188    standard gethostbyname (which is not thread safe)
189 */
190 struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp)
191 {
192         int res;
193         int herrno;
194         int dots = 0;
195         const char *s;
196         struct hostent *result = NULL;
197         /* Although it is perfectly legitimate to lookup a pure integer, for
198            the sake of the sanity of people who like to name their peers as
199            integers, we break with tradition and refuse to look up a
200            pure integer */
201         s = host;
202         res = 0;
203         while (s && *s) {
204                 if (*s == '.')
205                         dots++;
206                 else if (!isdigit(*s))
207                         break;
208                 s++;
209         }
210         if (!s || !*s) {
211                 /* Forge a reply for IP's to avoid octal IP's being interpreted as octal */
212                 if (dots != 3)
213                         return NULL;
214                 memset(hp, 0, sizeof(struct ast_hostent));
215                 hp->hp.h_addrtype = AF_INET;
216                 hp->hp.h_addr_list = (void *) hp->buf;
217                 hp->hp.h_addr = hp->buf + sizeof(void *);
218                 /* For AF_INET, this will always be 4 */
219                 hp->hp.h_length = 4;
220                 if (inet_pton(AF_INET, host, hp->hp.h_addr) > 0)
221                         return &hp->hp;
222                 return NULL;
223
224         }
225 #ifdef HAVE_GETHOSTBYNAME_R_5
226         result = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &herrno);
227
228         if (!result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
229                 return NULL;
230 #else
231         res = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &result, &herrno);
232
233         if (res || !result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
234                 return NULL;
235 #endif
236         return &hp->hp;
237 }
238
239 /*! \brief Produce 32 char MD5 hash of value. */
240 void ast_md5_hash(char *output, const char *input)
241 {
242         struct MD5Context md5;
243         unsigned char digest[16];
244         char *ptr;
245         int x;
246
247         MD5Init(&md5);
248         MD5Update(&md5, (const unsigned char *) input, strlen(input));
249         MD5Final(digest, &md5);
250         ptr = output;
251         for (x = 0; x < 16; x++)
252                 ptr += sprintf(ptr, "%02hhx", digest[x]);
253 }
254
255 /*! \brief Produce 40 char SHA1 hash of value. */
256 void ast_sha1_hash(char *output, const char *input)
257 {
258         struct SHA1Context sha;
259         char *ptr;
260         int x;
261         uint8_t Message_Digest[20];
262
263         SHA1Reset(&sha);
264
265         SHA1Input(&sha, (const unsigned char *) input, strlen(input));
266
267         SHA1Result(&sha, Message_Digest);
268         ptr = output;
269         for (x = 0; x < 20; x++)
270                 ptr += sprintf(ptr, "%02hhx", Message_Digest[x]);
271 }
272
273 /*! \brief Produce a 20 byte SHA1 hash of value. */
274 void ast_sha1_hash_uint(uint8_t *digest, const char *input)
275 {
276         struct SHA1Context sha;
277
278         SHA1Reset(&sha);
279
280         SHA1Input(&sha, (const unsigned char *) input, strlen(input));
281
282         SHA1Result(&sha, digest);
283 }
284
285 /*! \brief decode BASE64 encoded text */
286 int ast_base64decode(unsigned char *dst, const char *src, int max)
287 {
288         int cnt = 0;
289         unsigned int byte = 0;
290         unsigned int bits = 0;
291         int incnt = 0;
292         while(*src && *src != '=' && (cnt < max)) {
293                 /* Shift in 6 bits of input */
294                 byte <<= 6;
295                 byte |= (b2a[(int)(*src)]) & 0x3f;
296                 bits += 6;
297                 src++;
298                 incnt++;
299                 /* If we have at least 8 bits left over, take that character
300                    off the top */
301                 if (bits >= 8)  {
302                         bits -= 8;
303                         *dst = (byte >> bits) & 0xff;
304                         dst++;
305                         cnt++;
306                 }
307         }
308         /* Don't worry about left over bits, they're extra anyway */
309         return cnt;
310 }
311
312 /*! \brief encode text to BASE64 coding */
313 int ast_base64encode_full(char *dst, const unsigned char *src, int srclen, int max, int linebreaks)
314 {
315         int cnt = 0;
316         int col = 0;
317         unsigned int byte = 0;
318         int bits = 0;
319         int cntin = 0;
320         /* Reserve space for null byte at end of string */
321         max--;
322         while ((cntin < srclen) && (cnt < max)) {
323                 byte <<= 8;
324                 byte |= *(src++);
325                 bits += 8;
326                 cntin++;
327                 if ((bits == 24) && (cnt + 4 <= max)) {
328                         *dst++ = base64[(byte >> 18) & 0x3f];
329                         *dst++ = base64[(byte >> 12) & 0x3f];
330                         *dst++ = base64[(byte >> 6) & 0x3f];
331                         *dst++ = base64[byte & 0x3f];
332                         cnt += 4;
333                         col += 4;
334                         bits = 0;
335                         byte = 0;
336                 }
337                 if (linebreaks && (cnt < max) && (col == 64)) {
338                         *dst++ = '\n';
339                         cnt++;
340                         col = 0;
341                 }
342         }
343         if (bits && (cnt + 4 <= max)) {
344                 /* Add one last character for the remaining bits,
345                    padding the rest with 0 */
346                 byte <<= 24 - bits;
347                 *dst++ = base64[(byte >> 18) & 0x3f];
348                 *dst++ = base64[(byte >> 12) & 0x3f];
349                 if (bits == 16)
350                         *dst++ = base64[(byte >> 6) & 0x3f];
351                 else
352                         *dst++ = '=';
353                 *dst++ = '=';
354                 cnt += 4;
355         }
356         if (linebreaks && (cnt < max)) {
357                 *dst++ = '\n';
358                 cnt++;
359         }
360         *dst = '\0';
361         return cnt;
362 }
363
364 int ast_base64encode(char *dst, const unsigned char *src, int srclen, int max)
365 {
366         return ast_base64encode_full(dst, src, srclen, max, 0);
367 }
368
369 static void base64_init(void)
370 {
371         int x;
372         memset(b2a, -1, sizeof(b2a));
373         /* Initialize base-64 Conversion table */
374         for (x = 0; x < 26; x++) {
375                 /* A-Z */
376                 base64[x] = 'A' + x;
377                 b2a['A' + x] = x;
378                 /* a-z */
379                 base64[x + 26] = 'a' + x;
380                 b2a['a' + x] = x + 26;
381                 /* 0-9 */
382                 if (x < 10) {
383                         base64[x + 52] = '0' + x;
384                         b2a['0' + x] = x + 52;
385                 }
386         }
387         base64[62] = '+';
388         base64[63] = '/';
389         b2a[(int)'+'] = 62;
390         b2a[(int)'/'] = 63;
391 }
392
393 const struct ast_flags ast_uri_http = {AST_URI_UNRESERVED};
394 const struct ast_flags ast_uri_http_legacy = {AST_URI_LEGACY_SPACE | AST_URI_UNRESERVED};
395 const struct ast_flags ast_uri_sip_user = {AST_URI_UNRESERVED | AST_URI_SIP_USER_UNRESERVED};
396
397 char *ast_uri_encode(const char *string, char *outbuf, int buflen, struct ast_flags spec)
398 {
399         const char *ptr  = string;      /* Start with the string */
400         char *out = outbuf;
401         const char *mark = "-_.!~*'()"; /* no encode set, RFC 2396 section 2.3, RFC 3261 sec 25 */
402         const char *user_unreserved = "&=+$,;?/"; /* user-unreserved set, RFC 3261 sec 25 */
403
404         while (*ptr && out - outbuf < buflen - 1) {
405                 if (ast_test_flag(&spec, AST_URI_LEGACY_SPACE) && *ptr == ' ') {
406                         /* for legacy encoding, encode spaces as '+' */
407                         *out = '+';
408                         out++;
409                 } else if (!(ast_test_flag(&spec, AST_URI_MARK)
410                                 && strchr(mark, *ptr))
411                         && !(ast_test_flag(&spec, AST_URI_ALPHANUM)
412                                 && ((*ptr >= '0' && *ptr <= '9')
413                                 || (*ptr >= 'A' && *ptr <= 'Z')
414                                 || (*ptr >= 'a' && *ptr <= 'z')))
415                         && !(ast_test_flag(&spec, AST_URI_SIP_USER_UNRESERVED)
416                                 && strchr(user_unreserved, *ptr))) {
417
418                         if (out - outbuf >= buflen - 3) {
419                                 break;
420                         }
421                         out += sprintf(out, "%%%02hhX", (unsigned char) *ptr);
422                 } else {
423                         *out = *ptr;    /* Continue copying the string */
424                         out++;
425                 }
426                 ptr++;
427         }
428
429         if (buflen) {
430                 *out = '\0';
431         }
432
433         return outbuf;
434 }
435
436 void ast_uri_decode(char *s, struct ast_flags spec)
437 {
438         char *o;
439         unsigned int tmp;
440
441         for (o = s; *s; s++, o++) {
442                 if (ast_test_flag(&spec, AST_URI_LEGACY_SPACE) && *s == '+') {
443                         /* legacy mode, decode '+' as space */
444                         *o = ' ';
445                 } else if (*s == '%' && s[1] != '\0' && s[2] != '\0' && sscanf(s + 1, "%2x", &tmp) == 1) {
446                         /* have '%', two chars and correct parsing */
447                         *o = tmp;
448                         s += 2; /* Will be incremented once more when we break out */
449                 } else /* all other cases, just copy */
450                         *o = *s;
451         }
452         *o = '\0';
453 }
454
455 char *ast_escape_quoted(const char *string, char *outbuf, int buflen)
456 {
457         const char *ptr  = string;
458         char *out = outbuf;
459         char *allow = "\t\v !"; /* allow LWS (minus \r and \n) and "!" */
460
461         while (*ptr && out - outbuf < buflen - 1) {
462                 if (!(strchr(allow, *ptr))
463                         && !(*ptr >= '#' && *ptr <= '[') /* %x23 - %x5b */
464                         && !(*ptr >= ']' && *ptr <= '~') /* %x5d - %x7e */
465                         && !((unsigned char) *ptr > 0x7f)) {             /* UTF8-nonascii */
466
467                         if (out - outbuf >= buflen - 2) {
468                                 break;
469                         }
470                         out += sprintf(out, "\\%c", (unsigned char) *ptr);
471                 } else {
472                         *out = *ptr;
473                         out++;
474                 }
475                 ptr++;
476         }
477
478         if (buflen) {
479                 *out = '\0';
480         }
481
482         return outbuf;
483 }
484
485 char *ast_escape_semicolons(const char *string, char *outbuf, int buflen)
486 {
487         const char *ptr = string;
488         char *out = outbuf;
489
490         if (string == NULL || outbuf == NULL) {
491                 ast_assert(string != NULL && outbuf != NULL);
492                 return NULL;
493         }
494
495         while (*ptr && out - outbuf < buflen - 1) {
496                 if (*ptr == ';') {
497                         if (out - outbuf >= buflen - 2) {
498                                 break;
499                         }
500                         strcpy(out, "\\;");
501                         out += 2;
502                 } else {
503                         *out = *ptr;
504                         out++;
505                 }
506                 ptr++;
507         }
508
509         if (buflen) {
510                 *out = '\0';
511         }
512
513         return outbuf;
514 }
515
516 void ast_unescape_quoted(char *quote_str)
517 {
518         int esc_pos;
519         int unesc_pos;
520         int quote_str_len = strlen(quote_str);
521
522         for (esc_pos = 0, unesc_pos = 0;
523                 esc_pos < quote_str_len;
524                 esc_pos++, unesc_pos++) {
525                 if (quote_str[esc_pos] == '\\') {
526                         /* at least one more char and current is \\ */
527                         esc_pos++;
528                         if (esc_pos >= quote_str_len) {
529                                 break;
530                         }
531                 }
532
533                 quote_str[unesc_pos] = quote_str[esc_pos];
534         }
535         quote_str[unesc_pos] = '\0';
536 }
537
538 int ast_xml_escape(const char *string, char * const outbuf, const size_t buflen)
539 {
540         char *dst = outbuf;
541         char *end = outbuf + buflen - 1; /* save one for the null terminator */
542
543         /* Handle the case for the empty output buffer */
544         if (buflen == 0) {
545                 return -1;
546         }
547
548         /* Escaping rules from http://www.w3.org/TR/REC-xml/#syntax */
549         /* This also prevents partial entities at the end of a string */
550         while (*string && dst < end) {
551                 const char *entity = NULL;
552                 int len = 0;
553
554                 switch (*string) {
555                 case '<':
556                         entity = "&lt;";
557                         len = 4;
558                         break;
559                 case '&':
560                         entity = "&amp;";
561                         len = 5;
562                         break;
563                 case '>':
564                         /* necessary if ]]> is in the string; easier to escape them all */
565                         entity = "&gt;";
566                         len = 4;
567                         break;
568                 case '\'':
569                         /* necessary in single-quoted strings; easier to escape them all */
570                         entity = "&apos;";
571                         len = 6;
572                         break;
573                 case '"':
574                         /* necessary in double-quoted strings; easier to escape them all */
575                         entity = "&quot;";
576                         len = 6;
577                         break;
578                 default:
579                         *dst++ = *string++;
580                         break;
581                 }
582
583                 if (entity) {
584                         ast_assert(len == strlen(entity));
585                         if (end - dst < len) {
586                                 /* no room for the entity; stop */
587                                 break;
588                         }
589                         /* just checked for length; strcpy is fine */
590                         strcpy(dst, entity);
591                         dst += len;
592                         ++string;
593                 }
594         }
595         /* Write null terminator */
596         *dst = '\0';
597         /* If any chars are left in string, return failure */
598         return *string == '\0' ? 0 : -1;
599 }
600
601 /*! \brief  ast_inet_ntoa: Recursive thread safe replacement of inet_ntoa */
602 const char *ast_inet_ntoa(struct in_addr ia)
603 {
604         char *buf;
605
606         if (!(buf = ast_threadstorage_get(&inet_ntoa_buf, INET_ADDRSTRLEN)))
607                 return "";
608
609         return inet_ntop(AF_INET, &ia, buf, INET_ADDRSTRLEN);
610 }
611
612 static int dev_urandom_fd = -1;
613
614 #ifndef __linux__
615 #undef pthread_create /* For ast_pthread_create function only */
616 #endif /* !__linux__ */
617
618 #ifdef DEBUG_THREADS
619
620 #if !defined(LOW_MEMORY)
621 /*! \brief A reasonable maximum number of locks a thread would be holding ... */
622 #define AST_MAX_LOCKS 64
623
624 /* Allow direct use of pthread_mutex_t and friends */
625 #undef pthread_mutex_t
626 #undef pthread_mutex_lock
627 #undef pthread_mutex_unlock
628 #undef pthread_mutex_init
629 #undef pthread_mutex_destroy
630
631 /*!
632  * \brief Keep track of which locks a thread holds
633  *
634  * There is an instance of this struct for every active thread
635  */
636 struct thr_lock_info {
637         /*! The thread's ID */
638         pthread_t thread_id;
639         /*! The thread name which includes where the thread was started */
640         const char *thread_name;
641         /*! This is the actual container of info for what locks this thread holds */
642         struct {
643                 const char *file;
644                 const char *func;
645                 const char *lock_name;
646                 void *lock_addr;
647                 int times_locked;
648                 int line_num;
649                 enum ast_lock_type type;
650                 /*! This thread is waiting on this lock */
651                 int pending:2;
652                 /*! A condition has suspended this lock */
653                 int suspended:1;
654 #ifdef HAVE_BKTR
655                 struct ast_bt *backtrace;
656 #endif
657         } locks[AST_MAX_LOCKS];
658         /*! This is the number of locks currently held by this thread.
659          *  The index (num_locks - 1) has the info on the last one in the
660          *  locks member */
661         unsigned int num_locks;
662         /*! The LWP id (which GDB prints) */
663         int lwp;
664         /*! Protects the contents of the locks member
665          * Intentionally not ast_mutex_t */
666         pthread_mutex_t lock;
667         AST_LIST_ENTRY(thr_lock_info) entry;
668 };
669
670 /*!
671  * \brief Locked when accessing the lock_infos list
672  */
673 AST_MUTEX_DEFINE_STATIC(lock_infos_lock);
674 /*!
675  * \brief A list of each thread's lock info
676  */
677 static AST_LIST_HEAD_NOLOCK_STATIC(lock_infos, thr_lock_info);
678
679 /*!
680  * \brief Destroy a thread's lock info
681  *
682  * This gets called automatically when the thread stops
683  */
684 static void lock_info_destroy(void *data)
685 {
686         struct thr_lock_info *lock_info = data;
687         int i;
688
689         pthread_mutex_lock(&lock_infos_lock.mutex);
690         AST_LIST_REMOVE(&lock_infos, lock_info, entry);
691         pthread_mutex_unlock(&lock_infos_lock.mutex);
692
693
694         for (i = 0; i < lock_info->num_locks; i++) {
695                 if (lock_info->locks[i].pending == -1) {
696                         /* This just means that the last lock this thread went for was by
697                          * using trylock, and it failed.  This is fine. */
698                         break;
699                 }
700
701                 ast_log(LOG_ERROR,
702                         "Thread '%s' still has a lock! - '%s' (%p) from '%s' in %s:%d!\n",
703                         lock_info->thread_name,
704                         lock_info->locks[i].lock_name,
705                         lock_info->locks[i].lock_addr,
706                         lock_info->locks[i].func,
707                         lock_info->locks[i].file,
708                         lock_info->locks[i].line_num
709                 );
710         }
711
712         pthread_mutex_destroy(&lock_info->lock);
713         if (lock_info->thread_name) {
714                 ast_free((void *) lock_info->thread_name);
715         }
716         ast_free(lock_info);
717 }
718
719 /*!
720  * \brief The thread storage key for per-thread lock info
721  */
722 AST_THREADSTORAGE_CUSTOM(thread_lock_info, NULL, lock_info_destroy);
723 #endif /* ! LOW_MEMORY */
724
725 #ifdef HAVE_BKTR
726 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
727         int line_num, const char *func, const char *lock_name, void *lock_addr, struct ast_bt *bt)
728 #else
729 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
730         int line_num, const char *func, const char *lock_name, void *lock_addr)
731 #endif
732 {
733 #if !defined(LOW_MEMORY)
734         struct thr_lock_info *lock_info;
735         int i;
736
737         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
738                 return;
739
740         pthread_mutex_lock(&lock_info->lock);
741
742         for (i = 0; i < lock_info->num_locks; i++) {
743                 if (lock_info->locks[i].lock_addr == lock_addr) {
744                         lock_info->locks[i].times_locked++;
745 #ifdef HAVE_BKTR
746                         lock_info->locks[i].backtrace = bt;
747 #endif
748                         pthread_mutex_unlock(&lock_info->lock);
749                         return;
750                 }
751         }
752
753         if (lock_info->num_locks == AST_MAX_LOCKS) {
754                 /* Can't use ast_log here, because it will cause infinite recursion */
755                 fprintf(stderr, "XXX ERROR XXX A thread holds more locks than '%d'."
756                         "  Increase AST_MAX_LOCKS!\n", AST_MAX_LOCKS);
757                 pthread_mutex_unlock(&lock_info->lock);
758                 return;
759         }
760
761         if (i && lock_info->locks[i - 1].pending == -1) {
762                 /* The last lock on the list was one that this thread tried to lock but
763                  * failed at doing so.  It has now moved on to something else, so remove
764                  * the old lock from the list. */
765                 i--;
766                 lock_info->num_locks--;
767                 memset(&lock_info->locks[i], 0, sizeof(lock_info->locks[0]));
768         }
769
770         lock_info->locks[i].file = filename;
771         lock_info->locks[i].line_num = line_num;
772         lock_info->locks[i].func = func;
773         lock_info->locks[i].lock_name = lock_name;
774         lock_info->locks[i].lock_addr = lock_addr;
775         lock_info->locks[i].times_locked = 1;
776         lock_info->locks[i].type = type;
777         lock_info->locks[i].pending = 1;
778 #ifdef HAVE_BKTR
779         lock_info->locks[i].backtrace = bt;
780 #endif
781         lock_info->num_locks++;
782
783         pthread_mutex_unlock(&lock_info->lock);
784 #endif /* ! LOW_MEMORY */
785 }
786
787 void ast_mark_lock_acquired(void *lock_addr)
788 {
789 #if !defined(LOW_MEMORY)
790         struct thr_lock_info *lock_info;
791
792         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
793                 return;
794
795         pthread_mutex_lock(&lock_info->lock);
796         if (lock_info->locks[lock_info->num_locks - 1].lock_addr == lock_addr) {
797                 lock_info->locks[lock_info->num_locks - 1].pending = 0;
798         }
799         pthread_mutex_unlock(&lock_info->lock);
800 #endif /* ! LOW_MEMORY */
801 }
802
803 void ast_mark_lock_failed(void *lock_addr)
804 {
805 #if !defined(LOW_MEMORY)
806         struct thr_lock_info *lock_info;
807
808         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
809                 return;
810
811         pthread_mutex_lock(&lock_info->lock);
812         if (lock_info->locks[lock_info->num_locks - 1].lock_addr == lock_addr) {
813                 lock_info->locks[lock_info->num_locks - 1].pending = -1;
814                 lock_info->locks[lock_info->num_locks - 1].times_locked--;
815         }
816         pthread_mutex_unlock(&lock_info->lock);
817 #endif /* ! LOW_MEMORY */
818 }
819
820 int ast_find_lock_info(void *lock_addr, char *filename, size_t filename_size, int *lineno, char *func, size_t func_size, char *mutex_name, size_t mutex_name_size)
821 {
822 #if !defined(LOW_MEMORY)
823         struct thr_lock_info *lock_info;
824         int i = 0;
825
826         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
827                 return -1;
828
829         pthread_mutex_lock(&lock_info->lock);
830
831         for (i = lock_info->num_locks - 1; i >= 0; i--) {
832                 if (lock_info->locks[i].lock_addr == lock_addr)
833                         break;
834         }
835
836         if (i == -1) {
837                 /* Lock not found :( */
838                 pthread_mutex_unlock(&lock_info->lock);
839                 return -1;
840         }
841
842         ast_copy_string(filename, lock_info->locks[i].file, filename_size);
843         *lineno = lock_info->locks[i].line_num;
844         ast_copy_string(func, lock_info->locks[i].func, func_size);
845         ast_copy_string(mutex_name, lock_info->locks[i].lock_name, mutex_name_size);
846
847         pthread_mutex_unlock(&lock_info->lock);
848
849         return 0;
850 #else /* if defined(LOW_MEMORY) */
851         return -1;
852 #endif
853 }
854
855 void ast_suspend_lock_info(void *lock_addr)
856 {
857 #if !defined(LOW_MEMORY)
858         struct thr_lock_info *lock_info;
859         int i = 0;
860
861         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info)))) {
862                 return;
863         }
864
865         pthread_mutex_lock(&lock_info->lock);
866
867         for (i = lock_info->num_locks - 1; i >= 0; i--) {
868                 if (lock_info->locks[i].lock_addr == lock_addr)
869                         break;
870         }
871
872         if (i == -1) {
873                 /* Lock not found :( */
874                 pthread_mutex_unlock(&lock_info->lock);
875                 return;
876         }
877
878         lock_info->locks[i].suspended = 1;
879
880         pthread_mutex_unlock(&lock_info->lock);
881 #endif /* ! LOW_MEMORY */
882 }
883
884 void ast_restore_lock_info(void *lock_addr)
885 {
886 #if !defined(LOW_MEMORY)
887         struct thr_lock_info *lock_info;
888         int i = 0;
889
890         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
891                 return;
892
893         pthread_mutex_lock(&lock_info->lock);
894
895         for (i = lock_info->num_locks - 1; i >= 0; i--) {
896                 if (lock_info->locks[i].lock_addr == lock_addr)
897                         break;
898         }
899
900         if (i == -1) {
901                 /* Lock not found :( */
902                 pthread_mutex_unlock(&lock_info->lock);
903                 return;
904         }
905
906         lock_info->locks[i].suspended = 0;
907
908         pthread_mutex_unlock(&lock_info->lock);
909 #endif /* ! LOW_MEMORY */
910 }
911
912
913 #ifdef HAVE_BKTR
914 void ast_remove_lock_info(void *lock_addr, struct ast_bt *bt)
915 #else
916 void ast_remove_lock_info(void *lock_addr)
917 #endif
918 {
919 #if !defined(LOW_MEMORY)
920         struct thr_lock_info *lock_info;
921         int i = 0;
922
923         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
924                 return;
925
926         pthread_mutex_lock(&lock_info->lock);
927
928         for (i = lock_info->num_locks - 1; i >= 0; i--) {
929                 if (lock_info->locks[i].lock_addr == lock_addr)
930                         break;
931         }
932
933         if (i == -1) {
934                 /* Lock not found :( */
935                 pthread_mutex_unlock(&lock_info->lock);
936                 return;
937         }
938
939         if (lock_info->locks[i].times_locked > 1) {
940                 lock_info->locks[i].times_locked--;
941 #ifdef HAVE_BKTR
942                 lock_info->locks[i].backtrace = bt;
943 #endif
944                 pthread_mutex_unlock(&lock_info->lock);
945                 return;
946         }
947
948         if (i < lock_info->num_locks - 1) {
949                 /* Not the last one ... *should* be rare! */
950                 memmove(&lock_info->locks[i], &lock_info->locks[i + 1],
951                         (lock_info->num_locks - (i + 1)) * sizeof(lock_info->locks[0]));
952         }
953
954         lock_info->num_locks--;
955
956         pthread_mutex_unlock(&lock_info->lock);
957 #endif /* ! LOW_MEMORY */
958 }
959
960 #if !defined(LOW_MEMORY)
961 static const char *locktype2str(enum ast_lock_type type)
962 {
963         switch (type) {
964         case AST_MUTEX:
965                 return "MUTEX";
966         case AST_RDLOCK:
967                 return "RDLOCK";
968         case AST_WRLOCK:
969                 return "WRLOCK";
970         }
971
972         return "UNKNOWN";
973 }
974
975 #ifdef HAVE_BKTR
976 static void append_backtrace_information(struct ast_str **str, struct ast_bt *bt)
977 {
978         char **symbols;
979         int num_frames;
980
981         if (!bt) {
982                 ast_str_append(str, 0, "\tNo backtrace to print\n");
983                 return;
984         }
985
986         /* store frame count locally to avoid the memory corruption that
987          * sometimes happens on virtualized CentOS 6.x systems */
988         num_frames = bt->num_frames;
989         if ((symbols = ast_bt_get_symbols(bt->addresses, num_frames))) {
990                 int frame_iterator;
991
992                 for (frame_iterator = 0; frame_iterator < num_frames; ++frame_iterator) {
993                         ast_str_append(str, 0, "\t%s\n", symbols[frame_iterator]);
994                 }
995
996                 ast_std_free(symbols);
997         } else {
998                 ast_str_append(str, 0, "\tCouldn't retrieve backtrace symbols\n");
999         }
1000 }
1001 #endif
1002
1003 static void append_lock_information(struct ast_str **str, struct thr_lock_info *lock_info, int i)
1004 {
1005         int j;
1006         ast_mutex_t *lock;
1007         struct ast_lock_track *lt;
1008
1009         ast_str_append(str, 0, "=== ---> %sLock #%d (%s): %s %d %s %s %p (%d%s)\n",
1010                                    lock_info->locks[i].pending > 0 ? "Waiting for " :
1011                                    lock_info->locks[i].pending < 0 ? "Tried and failed to get " : "", i,
1012                                    lock_info->locks[i].file,
1013                                    locktype2str(lock_info->locks[i].type),
1014                                    lock_info->locks[i].line_num,
1015                                    lock_info->locks[i].func, lock_info->locks[i].lock_name,
1016                                    lock_info->locks[i].lock_addr,
1017                                    lock_info->locks[i].times_locked,
1018                                    lock_info->locks[i].suspended ? " - suspended" : "");
1019 #ifdef HAVE_BKTR
1020         append_backtrace_information(str, lock_info->locks[i].backtrace);
1021 #endif
1022
1023         if (!lock_info->locks[i].pending || lock_info->locks[i].pending == -1)
1024                 return;
1025
1026         /* We only have further details for mutexes right now */
1027         if (lock_info->locks[i].type != AST_MUTEX)
1028                 return;
1029
1030         lock = lock_info->locks[i].lock_addr;
1031         lt = lock->track;
1032         ast_reentrancy_lock(lt);
1033         for (j = 0; *str && j < lt->reentrancy; j++) {
1034                 ast_str_append(str, 0, "=== --- ---> Locked Here: %s line %d (%s)\n",
1035                                            lt->file[j], lt->lineno[j], lt->func[j]);
1036         }
1037         ast_reentrancy_unlock(lt);
1038 }
1039 #endif /* ! LOW_MEMORY */
1040
1041 /*! This function can help you find highly temporal locks; locks that happen for a
1042     short time, but at unexpected times, usually at times that create a deadlock,
1043         Why is this thing locked right then? Who is locking it? Who am I fighting
1044     with for this lock?
1045
1046         To answer such questions, just call this routine before you would normally try
1047         to aquire a lock. It doesn't do anything if the lock is not acquired. If the
1048         lock is taken, it will publish a line or two to the console via ast_log().
1049
1050         Sometimes, the lock message is pretty uninformative. For instance, you might
1051         find that the lock is being aquired deep within the astobj2 code; this tells
1052         you little about higher level routines that call the astobj2 routines.
1053         But, using gdb, you can set a break at the ast_log below, and for that
1054         breakpoint, you can set the commands:
1055           where
1056           cont
1057         which will give a stack trace and continue. -- that aught to do the job!
1058
1059 */
1060 void ast_log_show_lock(void *this_lock_addr)
1061 {
1062 #if !defined(LOW_MEMORY)
1063         struct thr_lock_info *lock_info;
1064         struct ast_str *str;
1065
1066         if (!(str = ast_str_create(4096))) {
1067                 ast_log(LOG_NOTICE,"Could not create str\n");
1068                 return;
1069         }
1070
1071
1072         pthread_mutex_lock(&lock_infos_lock.mutex);
1073         AST_LIST_TRAVERSE(&lock_infos, lock_info, entry) {
1074                 int i;
1075                 pthread_mutex_lock(&lock_info->lock);
1076                 for (i = 0; str && i < lock_info->num_locks; i++) {
1077                         /* ONLY show info about this particular lock, if
1078                            it's acquired... */
1079                         if (lock_info->locks[i].lock_addr == this_lock_addr) {
1080                                 append_lock_information(&str, lock_info, i);
1081                                 ast_log(LOG_NOTICE, "%s", ast_str_buffer(str));
1082                                 break;
1083                         }
1084                 }
1085                 pthread_mutex_unlock(&lock_info->lock);
1086         }
1087         pthread_mutex_unlock(&lock_infos_lock.mutex);
1088         ast_free(str);
1089 #endif /* ! LOW_MEMORY */
1090 }
1091
1092
1093 struct ast_str *ast_dump_locks(void)
1094 {
1095 #if !defined(LOW_MEMORY)
1096         struct thr_lock_info *lock_info;
1097         struct ast_str *str;
1098
1099         if (!(str = ast_str_create(4096))) {
1100                 return NULL;
1101         }
1102
1103         ast_str_append(&str, 0, "\n"
1104                        "=======================================================================\n"
1105                        "=== %s\n"
1106                        "=== Currently Held Locks\n"
1107                        "=======================================================================\n"
1108                        "===\n"
1109                        "=== <pending> <lock#> (<file>): <lock type> <line num> <function> <lock name> <lock addr> (times locked)\n"
1110                        "===\n", ast_get_version());
1111
1112         if (!str) {
1113                 return NULL;
1114         }
1115
1116         pthread_mutex_lock(&lock_infos_lock.mutex);
1117         AST_LIST_TRAVERSE(&lock_infos, lock_info, entry) {
1118                 int i;
1119                 int header_printed = 0;
1120                 pthread_mutex_lock(&lock_info->lock);
1121                 for (i = 0; str && i < lock_info->num_locks; i++) {
1122                         /* Don't show suspended locks */
1123                         if (lock_info->locks[i].suspended) {
1124                                 continue;
1125                         }
1126
1127                         if (!header_printed) {
1128                                 if (lock_info->lwp != -1) {
1129                                         ast_str_append(&str, 0, "=== Thread ID: 0x%lx LWP:%d (%s)\n",
1130                                                 (long unsigned) lock_info->thread_id, lock_info->lwp, lock_info->thread_name);
1131                                 } else {
1132                                         ast_str_append(&str, 0, "=== Thread ID: 0x%lx (%s)\n",
1133                                                 (long unsigned) lock_info->thread_id, lock_info->thread_name);
1134                                 }
1135                                 header_printed = 1;
1136                         }
1137
1138                         append_lock_information(&str, lock_info, i);
1139                 }
1140                 pthread_mutex_unlock(&lock_info->lock);
1141                 if (!str) {
1142                         break;
1143                 }
1144                 if (header_printed) {
1145                         ast_str_append(&str, 0, "=== -------------------------------------------------------------------\n"
1146                                 "===\n");
1147                 }
1148                 if (!str) {
1149                         break;
1150                 }
1151         }
1152         pthread_mutex_unlock(&lock_infos_lock.mutex);
1153
1154         if (!str) {
1155                 return NULL;
1156         }
1157
1158         ast_str_append(&str, 0, "=======================================================================\n"
1159                        "\n");
1160
1161         return str;
1162 #else /* if defined(LOW_MEMORY) */
1163         return NULL;
1164 #endif
1165 }
1166
1167 #if !defined(LOW_MEMORY)
1168 static char *handle_show_locks(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1169 {
1170         struct ast_str *str;
1171
1172         switch (cmd) {
1173         case CLI_INIT:
1174                 e->command = "core show locks";
1175                 e->usage =
1176                         "Usage: core show locks\n"
1177                         "       This command is for lock debugging.  It prints out which locks\n"
1178                         "are owned by each active thread.\n";
1179                 ast_cli_allow_at_shutdown(e);
1180                 return NULL;
1181
1182         case CLI_GENERATE:
1183                 return NULL;
1184         }
1185
1186         str = ast_dump_locks();
1187         if (!str) {
1188                 return CLI_FAILURE;
1189         }
1190
1191         ast_cli(a->fd, "%s", ast_str_buffer(str));
1192
1193         ast_free(str);
1194
1195         return CLI_SUCCESS;
1196 }
1197
1198 static struct ast_cli_entry utils_cli[] = {
1199         AST_CLI_DEFINE(handle_show_locks, "Show which locks are held by which thread"),
1200 };
1201 #endif /* ! LOW_MEMORY */
1202 #endif /* DEBUG_THREADS */
1203
1204 #if !defined(LOW_MEMORY)
1205 /*
1206  * support for 'show threads'. The start routine is wrapped by
1207  * dummy_start(), so that ast_register_thread() and
1208  * ast_unregister_thread() know the thread identifier.
1209  */
1210 struct thr_arg {
1211         void *(*start_routine)(void *);
1212         void *data;
1213         char *name;
1214 };
1215
1216 /*
1217  * on OS/X, pthread_cleanup_push() and pthread_cleanup_pop()
1218  * are odd macros which start and end a block, so they _must_ be
1219  * used in pairs (the latter with a '1' argument to call the
1220  * handler on exit.
1221  * On BSD we don't need this, but we keep it for compatibility.
1222  */
1223 static void *dummy_start(void *data)
1224 {
1225         void *ret;
1226         struct thr_arg a = *((struct thr_arg *) data);  /* make a local copy */
1227 #ifdef DEBUG_THREADS
1228         struct thr_lock_info *lock_info;
1229         pthread_mutexattr_t mutex_attr;
1230
1231         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
1232                 return NULL;
1233
1234         lock_info->thread_id = pthread_self();
1235         lock_info->lwp = ast_get_tid();
1236         lock_info->thread_name = ast_strdup(a.name);
1237
1238         pthread_mutexattr_init(&mutex_attr);
1239         pthread_mutexattr_settype(&mutex_attr, AST_MUTEX_KIND);
1240         pthread_mutex_init(&lock_info->lock, &mutex_attr);
1241         pthread_mutexattr_destroy(&mutex_attr);
1242
1243         pthread_mutex_lock(&lock_infos_lock.mutex); /* Intentionally not the wrapper */
1244         AST_LIST_INSERT_TAIL(&lock_infos, lock_info, entry);
1245         pthread_mutex_unlock(&lock_infos_lock.mutex); /* Intentionally not the wrapper */
1246 #endif /* DEBUG_THREADS */
1247
1248         /* note that even though data->name is a pointer to allocated memory,
1249            we are not freeing it here because ast_register_thread is going to
1250            keep a copy of the pointer and then ast_unregister_thread will
1251            free the memory
1252         */
1253         ast_free(data);
1254         ast_register_thread(a.name);
1255         pthread_cleanup_push(ast_unregister_thread, (void *) pthread_self());
1256
1257         ret = a.start_routine(a.data);
1258
1259         pthread_cleanup_pop(1);
1260
1261         return ret;
1262 }
1263
1264 #endif /* !LOW_MEMORY */
1265
1266 int ast_background_stacksize(void)
1267 {
1268 #if !defined(LOW_MEMORY)
1269         return AST_STACKSIZE;
1270 #else
1271         return AST_STACKSIZE_LOW;
1272 #endif
1273 }
1274
1275 int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
1276                              void *data, size_t stacksize, const char *file, const char *caller,
1277                              int line, const char *start_fn)
1278 {
1279 #if !defined(LOW_MEMORY)
1280         struct thr_arg *a;
1281 #endif
1282
1283         if (!attr) {
1284                 attr = ast_alloca(sizeof(*attr));
1285                 pthread_attr_init(attr);
1286         }
1287
1288 #if defined(__linux__) || defined(__FreeBSD__)
1289         /* On Linux and FreeBSD , pthread_attr_init() defaults to PTHREAD_EXPLICIT_SCHED,
1290            which is kind of useless. Change this here to
1291            PTHREAD_INHERIT_SCHED; that way the -p option to set realtime
1292            priority will propagate down to new threads by default.
1293            This does mean that callers cannot set a different priority using
1294            PTHREAD_EXPLICIT_SCHED in the attr argument; instead they must set
1295            the priority afterwards with pthread_setschedparam(). */
1296         if ((errno = pthread_attr_setinheritsched(attr, PTHREAD_INHERIT_SCHED)))
1297                 ast_log(LOG_WARNING, "pthread_attr_setinheritsched: %s\n", strerror(errno));
1298 #endif
1299
1300         if (!stacksize)
1301                 stacksize = AST_STACKSIZE;
1302
1303         if ((errno = pthread_attr_setstacksize(attr, stacksize ? stacksize : AST_STACKSIZE)))
1304                 ast_log(LOG_WARNING, "pthread_attr_setstacksize: %s\n", strerror(errno));
1305
1306 #if !defined(LOW_MEMORY)
1307         if ((a = ast_malloc(sizeof(*a)))) {
1308                 a->start_routine = start_routine;
1309                 a->data = data;
1310                 start_routine = dummy_start;
1311                 if (ast_asprintf(&a->name, "%-20s started at [%5d] %s %s()",
1312                              start_fn, line, file, caller) < 0) {
1313                         a->name = NULL;
1314                 }
1315                 data = a;
1316         }
1317 #endif /* !LOW_MEMORY */
1318
1319         return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
1320 }
1321
1322
1323 int ast_pthread_create_detached_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
1324                              void *data, size_t stacksize, const char *file, const char *caller,
1325                              int line, const char *start_fn)
1326 {
1327         unsigned char attr_destroy = 0;
1328         int res;
1329
1330         if (!attr) {
1331                 attr = ast_alloca(sizeof(*attr));
1332                 pthread_attr_init(attr);
1333                 attr_destroy = 1;
1334         }
1335
1336         if ((errno = pthread_attr_setdetachstate(attr, PTHREAD_CREATE_DETACHED)))
1337                 ast_log(LOG_WARNING, "pthread_attr_setdetachstate: %s\n", strerror(errno));
1338
1339         res = ast_pthread_create_stack(thread, attr, start_routine, data,
1340                                        stacksize, file, caller, line, start_fn);
1341
1342         if (attr_destroy)
1343                 pthread_attr_destroy(attr);
1344
1345         return res;
1346 }
1347
1348 int ast_wait_for_input(int fd, int ms)
1349 {
1350         struct pollfd pfd[1];
1351
1352         memset(pfd, 0, sizeof(pfd));
1353         pfd[0].fd = fd;
1354         pfd[0].events = POLLIN | POLLPRI;
1355         return ast_poll(pfd, 1, ms);
1356 }
1357
1358 int ast_wait_for_output(int fd, int ms)
1359 {
1360         struct pollfd pfd[1];
1361
1362         memset(pfd, 0, sizeof(pfd));
1363         pfd[0].fd = fd;
1364         pfd[0].events = POLLOUT;
1365         return ast_poll(pfd, 1, ms);
1366 }
1367
1368 static int wait_for_output(int fd, int timeoutms)
1369 {
1370         struct pollfd pfd = {
1371                 .fd = fd,
1372                 .events = POLLOUT,
1373         };
1374         int res;
1375         struct timeval start = ast_tvnow();
1376         int elapsed = 0;
1377
1378         /* poll() until the fd is writable without blocking */
1379         while ((res = ast_poll(&pfd, 1, timeoutms - elapsed)) <= 0) {
1380                 if (res == 0) {
1381                         /* timed out. */
1382 #ifndef STANDALONE
1383                         ast_debug(1, "Timed out trying to write\n");
1384 #endif
1385                         return -1;
1386                 } else if (res == -1) {
1387                         /* poll() returned an error, check to see if it was fatal */
1388
1389                         if (errno == EINTR || errno == EAGAIN) {
1390                                 elapsed = ast_tvdiff_ms(ast_tvnow(), start);
1391                                 if (elapsed >= timeoutms) {
1392                                         return -1;
1393                                 }
1394                                 /* This was an acceptable error, go back into poll() */
1395                                 continue;
1396                         }
1397
1398                         /* Fatal error, bail. */
1399                         ast_log(LOG_ERROR, "poll returned error: %s\n", strerror(errno));
1400
1401                         return -1;
1402                 }
1403                 elapsed = ast_tvdiff_ms(ast_tvnow(), start);
1404                 if (elapsed >= timeoutms) {
1405                         return -1;
1406                 }
1407         }
1408
1409         return 0;
1410 }
1411
1412 /*!
1413  * Try to write string, but wait no more than ms milliseconds before timing out.
1414  *
1415  * \note The code assumes that the file descriptor has NONBLOCK set,
1416  * so there is only one system call made to do a write, unless we actually
1417  * have a need to wait.  This way, we get better performance.
1418  * If the descriptor is blocking, all assumptions on the guaranteed
1419  * detail do not apply anymore.
1420  */
1421 int ast_carefulwrite(int fd, char *s, int len, int timeoutms)
1422 {
1423         struct timeval start = ast_tvnow();
1424         int res = 0;
1425         int elapsed = 0;
1426
1427         while (len) {
1428                 if (wait_for_output(fd, timeoutms - elapsed)) {
1429                         return -1;
1430                 }
1431
1432                 res = write(fd, s, len);
1433
1434                 if (res < 0 && errno != EAGAIN && errno != EINTR) {
1435                         /* fatal error from write() */
1436                         if (errno == EPIPE) {
1437 #ifndef STANDALONE
1438                                 ast_debug(1, "write() failed due to reading end being closed: %s\n", strerror(errno));
1439 #endif
1440                         } else {
1441                                 ast_log(LOG_ERROR, "write() returned error: %s\n", strerror(errno));
1442                         }
1443                         return -1;
1444                 }
1445
1446                 if (res < 0) {
1447                         /* It was an acceptable error */
1448                         res = 0;
1449                 }
1450
1451                 /* Update how much data we have left to write */
1452                 len -= res;
1453                 s += res;
1454                 res = 0;
1455
1456                 elapsed = ast_tvdiff_ms(ast_tvnow(), start);
1457                 if (elapsed >= timeoutms) {
1458                         /* We've taken too long to write
1459                          * This is only an error condition if we haven't finished writing. */
1460                         res = len ? -1 : 0;
1461                         break;
1462                 }
1463         }
1464
1465         return res;
1466 }
1467
1468 char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes)
1469 {
1470         char *e;
1471         char *q;
1472
1473         s = ast_strip(s);
1474         if ((q = strchr(beg_quotes, *s)) && *q != '\0') {
1475                 e = s + strlen(s) - 1;
1476                 if (*e == *(end_quotes + (q - beg_quotes))) {
1477                         s++;
1478                         *e = '\0';
1479                 }
1480         }
1481
1482         return s;
1483 }
1484
1485 char *ast_strsep(char **iss, const char sep, uint32_t flags)
1486 {
1487         char *st = *iss;
1488         char *is;
1489         int inquote = 0;
1490         int found = 0;
1491         char stack[8];
1492
1493         if (ast_strlen_zero(st)) {
1494                 return NULL;
1495         }
1496
1497         memset(stack, 0, sizeof(stack));
1498
1499         for(is = st; *is; is++) {
1500                 if (*is == '\\') {
1501                         if (*++is != '\0') {
1502                                 is++;
1503                         } else {
1504                                 break;
1505                         }
1506                 }
1507
1508                 if (*is == '\'' || *is == '"') {
1509                         if (*is == stack[inquote]) {
1510                                 stack[inquote--] = '\0';
1511                         } else {
1512                                 if (++inquote >= sizeof(stack)) {
1513                                         return NULL;
1514                                 }
1515                                 stack[inquote] = *is;
1516                         }
1517                 }
1518
1519                 if (*is == sep && !inquote) {
1520                         *is = '\0';
1521                         found = 1;
1522                         *iss = is + 1;
1523                         break;
1524                 }
1525         }
1526         if (!found) {
1527                 *iss = NULL;
1528         }
1529
1530         if (flags & AST_STRSEP_STRIP) {
1531                 st = ast_strip_quoted(st, "'\"", "'\"");
1532         }
1533
1534         if (flags & AST_STRSEP_TRIM) {
1535                 st = ast_strip(st);
1536         }
1537
1538         if (flags & AST_STRSEP_UNESCAPE) {
1539                 ast_unescape_quoted(st);
1540         }
1541
1542         return st;
1543 }
1544
1545 char *ast_unescape_semicolon(char *s)
1546 {
1547         char *e;
1548         char *work = s;
1549
1550         while ((e = strchr(work, ';'))) {
1551                 if ((e > work) && (*(e-1) == '\\')) {
1552                         memmove(e - 1, e, strlen(e) + 1);
1553                         work = e;
1554                 } else {
1555                         work = e + 1;
1556                 }
1557         }
1558
1559         return s;
1560 }
1561
1562 /* !\brief unescape some C sequences in place, return pointer to the original string.
1563  */
1564 char *ast_unescape_c(char *src)
1565 {
1566         char c, *ret, *dst;
1567
1568         if (src == NULL)
1569                 return NULL;
1570         for (ret = dst = src; (c = *src++); *dst++ = c ) {
1571                 if (c != '\\')
1572                         continue;       /* copy char at the end of the loop */
1573                 switch ((c = *src++)) {
1574                 case '\0':      /* special, trailing '\' */
1575                         c = '\\';
1576                         break;
1577                 case 'b':       /* backspace */
1578                         c = '\b';
1579                         break;
1580                 case 'f':       /* form feed */
1581                         c = '\f';
1582                         break;
1583                 case 'n':
1584                         c = '\n';
1585                         break;
1586                 case 'r':
1587                         c = '\r';
1588                         break;
1589                 case 't':
1590                         c = '\t';
1591                         break;
1592                 }
1593                 /* default, use the char literally */
1594         }
1595         *dst = '\0';
1596         return ret;
1597 }
1598
1599 /*
1600  * Standard escape sequences - Note, '\0' is not included as a valid character
1601  * to escape, but instead is used here as a NULL terminator for the string.
1602  */
1603 char escape_sequences[] = {
1604         '\a', '\b', '\f', '\n', '\r', '\t', '\v', '\\', '\'', '\"', '\?', '\0'
1605 };
1606
1607 /*
1608  * Standard escape sequences output map (has to maintain matching order with
1609  * escape_sequences). '\0' is included here as a NULL terminator for the string.
1610  */
1611 static char escape_sequences_map[] = {
1612         'a', 'b', 'f', 'n', 'r', 't', 'v', '\\', '\'', '"', '?', '\0'
1613 };
1614
1615 char *ast_escape(char *dest, const char *s, size_t size, const char *to_escape)
1616 {
1617         char *p;
1618         char *c;
1619
1620         if (!dest || !size) {
1621                 return dest;
1622         }
1623         if (ast_strlen_zero(s)) {
1624                 *dest = '\0';
1625                 return dest;
1626         }
1627
1628         if (ast_strlen_zero(to_escape)) {
1629                 ast_copy_string(dest, s, size);
1630                 return dest;
1631         }
1632
1633         for (p = dest; *s && --size; ++s, ++p) {
1634                 /* If in the list of characters to escape then escape it */
1635                 if (strchr(to_escape, *s)) {
1636                         if (!--size) {
1637                                 /* Not enough room left for the escape sequence. */
1638                                 break;
1639                         }
1640
1641                         /*
1642                          * See if the character to escape is part of the standard escape
1643                          * sequences. If so we'll have to use its mapped counterpart
1644                          * otherwise just use the current character.
1645                          */
1646                         c = strchr(escape_sequences, *s);
1647                         *p++ = '\\';
1648                         *p = c ? escape_sequences_map[c - escape_sequences] : *s;
1649                 } else {
1650                         *p = *s;
1651                 }
1652         }
1653         *p = '\0';
1654
1655         return dest;
1656 }
1657
1658 char *ast_escape_c(char *dest, const char *s, size_t size)
1659 {
1660         /*
1661          * Note - This is an optimized version of ast_escape. When looking only
1662          * for escape_sequences a couple of checks used in the generic case can
1663          * be left out thus making it slightly more efficient.
1664          */
1665         char *p;
1666         char *c;
1667
1668         if (!dest || !size) {
1669                 return dest;
1670         }
1671         if (ast_strlen_zero(s)) {
1672                 *dest = '\0';
1673                 return dest;
1674         }
1675
1676         for (p = dest; *s && --size; ++s, ++p) {
1677                 /*
1678                  * See if the character to escape is part of the standard escape
1679                  * sequences. If so use its mapped counterpart.
1680                  */
1681                 c = strchr(escape_sequences, *s);
1682                 if (c) {
1683                         if (!--size) {
1684                                 /* Not enough room left for the escape sequence. */
1685                                 break;
1686                         }
1687
1688                         *p++ = '\\';
1689                         *p = escape_sequences_map[c - escape_sequences];
1690                 } else {
1691                         *p = *s;
1692                 }
1693         }
1694         *p = '\0';
1695
1696         return dest;
1697 }
1698
1699 static char *escape_alloc(const char *s, size_t *size)
1700 {
1701         if (!s) {
1702                 return NULL;
1703         }
1704
1705         /*
1706          * The result string needs to be twice the size of the given
1707          * string just in case every character in it needs to be escaped.
1708          */
1709         *size = strlen(s) * 2 + 1;
1710         return ast_malloc(*size);
1711 }
1712
1713 char *ast_escape_alloc(const char *s, const char *to_escape)
1714 {
1715         size_t size = 0;
1716         char *dest = escape_alloc(s, &size);
1717
1718         return ast_escape(dest, s, size, to_escape);
1719 }
1720
1721 char *ast_escape_c_alloc(const char *s)
1722 {
1723         size_t size = 0;
1724         char *dest = escape_alloc(s, &size);
1725
1726         return ast_escape_c(dest, s, size);
1727 }
1728
1729 int ast_build_string_va(char **buffer, size_t *space, const char *fmt, va_list ap)
1730 {
1731         int result;
1732
1733         if (!buffer || !*buffer || !space || !*space)
1734                 return -1;
1735
1736         result = vsnprintf(*buffer, *space, fmt, ap);
1737
1738         if (result < 0)
1739                 return -1;
1740         else if (result > *space)
1741                 result = *space;
1742
1743         *buffer += result;
1744         *space -= result;
1745         return 0;
1746 }
1747
1748 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...)
1749 {
1750         va_list ap;
1751         int result;
1752
1753         va_start(ap, fmt);
1754         result = ast_build_string_va(buffer, space, fmt, ap);
1755         va_end(ap);
1756
1757         return result;
1758 }
1759
1760 int ast_regex_string_to_regex_pattern(const char *regex_string, struct ast_str **regex_pattern)
1761 {
1762         int regex_len = strlen(regex_string);
1763         int ret = 3;
1764
1765         /* Chop off the leading / if there is one */
1766         if ((regex_len >= 1) && (regex_string[0] == '/')) {
1767                 ast_str_set(regex_pattern, 0, "%s", regex_string + 1);
1768                 ret -= 2;
1769         }
1770
1771         /* Chop off the ending / if there is one */
1772         if ((regex_len > 1) && (regex_string[regex_len - 1] == '/')) {
1773                 ast_str_truncate(*regex_pattern, -1);
1774                 ret -= 1;
1775         }
1776
1777         return ret;
1778 }
1779
1780 int ast_true(const char *s)
1781 {
1782         if (ast_strlen_zero(s))
1783                 return 0;
1784
1785         /* Determine if this is a true value */
1786         if (!strcasecmp(s, "yes") ||
1787             !strcasecmp(s, "true") ||
1788             !strcasecmp(s, "y") ||
1789             !strcasecmp(s, "t") ||
1790             !strcasecmp(s, "1") ||
1791             !strcasecmp(s, "on"))
1792                 return -1;
1793
1794         return 0;
1795 }
1796
1797 int ast_false(const char *s)
1798 {
1799         if (ast_strlen_zero(s))
1800                 return 0;
1801
1802         /* Determine if this is a false value */
1803         if (!strcasecmp(s, "no") ||
1804             !strcasecmp(s, "false") ||
1805             !strcasecmp(s, "n") ||
1806             !strcasecmp(s, "f") ||
1807             !strcasecmp(s, "0") ||
1808             !strcasecmp(s, "off"))
1809                 return -1;
1810
1811         return 0;
1812 }
1813
1814 #define ONE_MILLION     1000000
1815 /*
1816  * put timeval in a valid range. usec is 0..999999
1817  * negative values are not allowed and truncated.
1818  */
1819 static struct timeval tvfix(struct timeval a)
1820 {
1821         if (a.tv_usec >= ONE_MILLION) {
1822                 ast_log(LOG_WARNING, "warning too large timestamp %ld.%ld\n",
1823                         (long)a.tv_sec, (long int) a.tv_usec);
1824                 a.tv_sec += a.tv_usec / ONE_MILLION;
1825                 a.tv_usec %= ONE_MILLION;
1826         } else if (a.tv_usec < 0) {
1827                 ast_log(LOG_WARNING, "warning negative timestamp %ld.%ld\n",
1828                         (long)a.tv_sec, (long int) a.tv_usec);
1829                 a.tv_usec = 0;
1830         }
1831         return a;
1832 }
1833
1834 struct timeval ast_tvadd(struct timeval a, struct timeval b)
1835 {
1836         /* consistency checks to guarantee usec in 0..999999 */
1837         a = tvfix(a);
1838         b = tvfix(b);
1839         a.tv_sec += b.tv_sec;
1840         a.tv_usec += b.tv_usec;
1841         if (a.tv_usec >= ONE_MILLION) {
1842                 a.tv_sec++;
1843                 a.tv_usec -= ONE_MILLION;
1844         }
1845         return a;
1846 }
1847
1848 struct timeval ast_tvsub(struct timeval a, struct timeval b)
1849 {
1850         /* consistency checks to guarantee usec in 0..999999 */
1851         a = tvfix(a);
1852         b = tvfix(b);
1853         a.tv_sec -= b.tv_sec;
1854         a.tv_usec -= b.tv_usec;
1855         if (a.tv_usec < 0) {
1856                 a.tv_sec-- ;
1857                 a.tv_usec += ONE_MILLION;
1858         }
1859         return a;
1860 }
1861
1862 int ast_remaining_ms(struct timeval start, int max_ms)
1863 {
1864         int ms;
1865
1866         if (max_ms < 0) {
1867                 ms = max_ms;
1868         } else {
1869                 ms = max_ms - ast_tvdiff_ms(ast_tvnow(), start);
1870                 if (ms < 0) {
1871                         ms = 0;
1872                 }
1873         }
1874
1875         return ms;
1876 }
1877
1878 void ast_format_duration_hh_mm_ss(int duration, char *buf, size_t length)
1879 {
1880         int durh, durm, durs;
1881         durh = duration / 3600;
1882         durm = (duration % 3600) / 60;
1883         durs = duration % 60;
1884         snprintf(buf, length, "%02d:%02d:%02d", durh, durm, durs);
1885 }
1886
1887 #undef ONE_MILLION
1888
1889 #ifndef linux
1890 AST_MUTEX_DEFINE_STATIC(randomlock);
1891 #endif
1892
1893 long int ast_random(void)
1894 {
1895         long int res;
1896
1897         if (dev_urandom_fd >= 0) {
1898                 int read_res = read(dev_urandom_fd, &res, sizeof(res));
1899                 if (read_res > 0) {
1900                         long int rm = RAND_MAX;
1901                         res = res < 0 ? ~res : res;
1902                         rm++;
1903                         return res % rm;
1904                 }
1905         }
1906
1907         /* XXX - Thread safety really depends on the libc, not the OS.
1908          *
1909          * But... popular Linux libc's (uClibc, glibc, eglibc), all have a
1910          * somewhat thread safe random(3) (results are random, but not
1911          * reproducible). The libc's for other systems (BSD, et al.), not so
1912          * much.
1913          */
1914 #ifdef linux
1915         res = random();
1916 #else
1917         ast_mutex_lock(&randomlock);
1918         res = random();
1919         ast_mutex_unlock(&randomlock);
1920 #endif
1921         return res;
1922 }
1923
1924 void ast_replace_subargument_delimiter(char *s)
1925 {
1926         for (; *s; s++) {
1927                 if (*s == '^') {
1928                         *s = ',';
1929                 }
1930         }
1931 }
1932
1933 char *ast_process_quotes_and_slashes(char *start, char find, char replace_with)
1934 {
1935         char *dataPut = start;
1936         int inEscape = 0;
1937         int inQuotes = 0;
1938
1939         for (; *start; start++) {
1940                 if (inEscape) {
1941                         *dataPut++ = *start;       /* Always goes verbatim */
1942                         inEscape = 0;
1943                 } else {
1944                         if (*start == '\\') {
1945                                 inEscape = 1;      /* Do not copy \ into the data */
1946                         } else if (*start == '\'') {
1947                                 inQuotes = 1 - inQuotes;   /* Do not copy ' into the data */
1948                         } else {
1949                                 /* Replace , with |, unless in quotes */
1950                                 *dataPut++ = inQuotes ? *start : ((*start == find) ? replace_with : *start);
1951                         }
1952                 }
1953         }
1954         if (start != dataPut)
1955                 *dataPut = 0;
1956         return dataPut;
1957 }
1958
1959 void ast_join_delim(char *s, size_t len, const char * const w[], unsigned int size, char delim)
1960 {
1961         int x, ofs = 0;
1962         const char *src;
1963
1964         /* Join words into a string */
1965         if (!s)
1966                 return;
1967         for (x = 0; ofs < len && x < size && w[x] ; x++) {
1968                 if (x > 0)
1969                         s[ofs++] = delim;
1970                 for (src = w[x]; *src && ofs < len; src++)
1971                         s[ofs++] = *src;
1972         }
1973         if (ofs == len)
1974                 ofs--;
1975         s[ofs] = '\0';
1976 }
1977
1978 char *ast_to_camel_case_delim(const char *s, const char *delim)
1979 {
1980         char *res = ast_strdup(s);
1981         char *front, *back, *buf = res;
1982         int size;
1983
1984         front = strtok_r(buf, delim, &back);
1985
1986         while (front) {
1987                 size = strlen(front);
1988                 *front = toupper(*front);
1989                 ast_copy_string(buf, front, size + 1);
1990                 buf += size;
1991                 front = strtok_r(NULL, delim, &back);
1992         }
1993
1994         return res;
1995 }
1996
1997 AST_MUTEX_DEFINE_STATIC(fetchadd_m); /* used for all fetc&add ops */
1998
1999 int ast_atomic_fetchadd_int_slow(volatile int *p, int v)
2000 {
2001         int ret;
2002         ast_mutex_lock(&fetchadd_m);
2003         ret = *p;
2004         *p += v;
2005         ast_mutex_unlock(&fetchadd_m);
2006         return ret;
2007 }
2008
2009 /*! \brief
2010  * get values from config variables.
2011  */
2012 int ast_get_timeval(const char *src, struct timeval *dst, struct timeval _default, int *consumed)
2013 {
2014         long double dtv = 0.0;
2015         int scanned;
2016
2017         if (dst == NULL)
2018                 return -1;
2019
2020         *dst = _default;
2021
2022         if (ast_strlen_zero(src))
2023                 return -1;
2024
2025         /* only integer at the moment, but one day we could accept more formats */
2026         if (sscanf(src, "%30Lf%n", &dtv, &scanned) > 0) {
2027                 dst->tv_sec = dtv;
2028                 dst->tv_usec = (dtv - dst->tv_sec) * 1000000.0;
2029                 if (consumed)
2030                         *consumed = scanned;
2031                 return 0;
2032         } else
2033                 return -1;
2034 }
2035
2036 /*! \brief
2037  * get values from config variables.
2038  */
2039 int ast_get_time_t(const char *src, time_t *dst, time_t _default, int *consumed)
2040 {
2041         long t;
2042         int scanned;
2043
2044         if (dst == NULL)
2045                 return -1;
2046
2047         *dst = _default;
2048
2049         if (ast_strlen_zero(src))
2050                 return -1;
2051
2052         /* only integer at the moment, but one day we could accept more formats */
2053         if (sscanf(src, "%30ld%n", &t, &scanned) == 1) {
2054                 *dst = t;
2055                 if (consumed)
2056                         *consumed = scanned;
2057                 return 0;
2058         } else
2059                 return -1;
2060 }
2061
2062 void ast_enable_packet_fragmentation(int sock)
2063 {
2064 #if defined(HAVE_IP_MTU_DISCOVER)
2065         int val = IP_PMTUDISC_DONT;
2066
2067         if (setsockopt(sock, IPPROTO_IP, IP_MTU_DISCOVER, &val, sizeof(val)))
2068                 ast_log(LOG_WARNING, "Unable to disable PMTU discovery. Large UDP packets may fail to be delivered when sent from this socket.\n");
2069 #endif /* HAVE_IP_MTU_DISCOVER */
2070 }
2071
2072 int ast_mkdir(const char *path, int mode)
2073 {
2074         char *ptr;
2075         int len = strlen(path), count = 0, x, piececount = 0;
2076         char *tmp = ast_strdupa(path);
2077         char **pieces;
2078         char *fullpath = ast_alloca(len + 1);
2079         int res = 0;
2080
2081         for (ptr = tmp; *ptr; ptr++) {
2082                 if (*ptr == '/')
2083                         count++;
2084         }
2085
2086         /* Count the components to the directory path */
2087         pieces = ast_alloca(count * sizeof(*pieces));
2088         for (ptr = tmp; *ptr; ptr++) {
2089                 if (*ptr == '/') {
2090                         *ptr = '\0';
2091                         pieces[piececount++] = ptr + 1;
2092                 }
2093         }
2094
2095         *fullpath = '\0';
2096         for (x = 0; x < piececount; x++) {
2097                 /* This looks funky, but the buffer is always ideally-sized, so it's fine. */
2098                 strcat(fullpath, "/");
2099                 strcat(fullpath, pieces[x]);
2100                 res = mkdir(fullpath, mode);
2101                 if (res && errno != EEXIST)
2102                         return errno;
2103         }
2104         return 0;
2105 }
2106
2107 static int safe_mkdir(const char *base_path, char *path, int mode)
2108 {
2109         RAII_VAR(char *, absolute_path, NULL, ast_std_free);
2110
2111         absolute_path = realpath(path, NULL);
2112
2113         if (absolute_path) {
2114                 /* Path exists, but is it in the right place? */
2115                 if (!ast_begins_with(absolute_path, base_path)) {
2116                         return EPERM;
2117                 }
2118
2119                 /* It is in the right place! */
2120                 return 0;
2121         } else {
2122                 /* Path doesn't exist. */
2123
2124                 /* The slash terminating the subpath we're checking */
2125                 char *path_term = strchr(path, '/');
2126                 /* True indicates the parent path is within base_path */
2127                 int parent_is_safe = 0;
2128                 int res;
2129
2130                 while (path_term) {
2131                         RAII_VAR(char *, absolute_subpath, NULL, ast_std_free);
2132
2133                         /* Truncate the path one past the slash */
2134                         char c = *(path_term + 1);
2135                         *(path_term + 1) = '\0';
2136                         absolute_subpath = realpath(path, NULL);
2137
2138                         if (absolute_subpath) {
2139                                 /* Subpath exists, but is it safe? */
2140                                 parent_is_safe = ast_begins_with(
2141                                         absolute_subpath, base_path);
2142                         } else if (parent_is_safe) {
2143                                 /* Subpath does not exist, but parent is safe
2144                                  * Create it */
2145                                 res = mkdir(path, mode);
2146                                 if (res != 0) {
2147                                         ast_assert(errno != EEXIST);
2148                                         return errno;
2149                                 }
2150                         } else {
2151                                 /* Subpath did not exist, parent was not safe
2152                                  * Fail! */
2153                                 errno = EPERM;
2154                                 return errno;
2155                         }
2156                         /* Restore the path */
2157                         *(path_term + 1) = c;
2158                         /* Move on to the next slash */
2159                         path_term = strchr(path_term + 1, '/');
2160                 }
2161
2162                 /* Now to build the final path, but only if it's safe */
2163                 if (!parent_is_safe) {
2164                         errno = EPERM;
2165                         return errno;
2166                 }
2167
2168                 res = mkdir(path, mode);
2169                 if (res != 0 && errno != EEXIST) {
2170                         return errno;
2171                 }
2172
2173                 return 0;
2174         }
2175 }
2176
2177 int ast_safe_mkdir(const char *base_path, const char *path, int mode)
2178 {
2179         RAII_VAR(char *, absolute_base_path, NULL, ast_std_free);
2180         RAII_VAR(char *, p, NULL, ast_free);
2181
2182         if (base_path == NULL || path == NULL) {
2183                 errno = EFAULT;
2184                 return errno;
2185         }
2186
2187         p = ast_strdup(path);
2188         if (p == NULL) {
2189                 errno = ENOMEM;
2190                 return errno;
2191         }
2192
2193         absolute_base_path = realpath(base_path, NULL);
2194         if (absolute_base_path == NULL) {
2195                 return errno;
2196         }
2197
2198         return safe_mkdir(absolute_base_path, p, mode);
2199 }
2200
2201 static void utils_shutdown(void)
2202 {
2203         close(dev_urandom_fd);
2204         dev_urandom_fd = -1;
2205 #if defined(DEBUG_THREADS) && !defined(LOW_MEMORY)
2206         ast_cli_unregister_multiple(utils_cli, ARRAY_LEN(utils_cli));
2207 #endif
2208 }
2209
2210 int ast_utils_init(void)
2211 {
2212         dev_urandom_fd = open("/dev/urandom", O_RDONLY);
2213         base64_init();
2214 #ifdef DEBUG_THREADS
2215 #if !defined(LOW_MEMORY)
2216         ast_cli_register_multiple(utils_cli, ARRAY_LEN(utils_cli));
2217 #endif
2218 #endif
2219         ast_register_cleanup(utils_shutdown);
2220         return 0;
2221 }
2222
2223
2224 /*!
2225  *\brief Parse digest authorization header.
2226  *\return Returns -1 if we have no auth or something wrong with digest.
2227  *\note This function may be used for Digest request and responce header.
2228  * request arg is set to nonzero, if we parse Digest Request.
2229  * pedantic arg can be set to nonzero if we need to do addition Digest check.
2230  */
2231 int ast_parse_digest(const char *digest, struct ast_http_digest *d, int request, int pedantic) {
2232         char *c;
2233         struct ast_str *str = ast_str_create(16);
2234
2235         /* table of recognised keywords, and places where they should be copied */
2236         const struct x {
2237                 const char *key;
2238                 const ast_string_field *field;
2239         } *i, keys[] = {
2240                 { "username=", &d->username },
2241                 { "realm=", &d->realm },
2242                 { "nonce=", &d->nonce },
2243                 { "uri=", &d->uri },
2244                 { "domain=", &d->domain },
2245                 { "response=", &d->response },
2246                 { "cnonce=", &d->cnonce },
2247                 { "opaque=", &d->opaque },
2248                 /* Special cases that cannot be directly copied */
2249                 { "algorithm=", NULL },
2250                 { "qop=", NULL },
2251                 { "nc=", NULL },
2252                 { NULL, 0 },
2253         };
2254
2255         if (ast_strlen_zero(digest) || !d || !str) {
2256                 ast_free(str);
2257                 return -1;
2258         }
2259
2260         ast_str_set(&str, 0, "%s", digest);
2261
2262         c = ast_skip_blanks(ast_str_buffer(str));
2263
2264         if (strncasecmp(c, "Digest ", strlen("Digest "))) {
2265                 ast_log(LOG_WARNING, "Missing Digest.\n");
2266                 ast_free(str);
2267                 return -1;
2268         }
2269         c += strlen("Digest ");
2270
2271         /* lookup for keys/value pair */
2272         while (c && *c && *(c = ast_skip_blanks(c))) {
2273                 /* find key */
2274                 for (i = keys; i->key != NULL; i++) {
2275                         char *src, *separator;
2276                         int unescape = 0;
2277                         if (strncasecmp(c, i->key, strlen(i->key)) != 0) {
2278                                 continue;
2279                         }
2280
2281                         /* Found. Skip keyword, take text in quotes or up to the separator. */
2282                         c += strlen(i->key);
2283                         if (*c == '"') {
2284                                 src = ++c;
2285                                 separator = "\"";
2286                                 unescape = 1;
2287                         } else {
2288                                 src = c;
2289                                 separator = ",";
2290                         }
2291                         strsep(&c, separator); /* clear separator and move ptr */
2292                         if (unescape) {
2293                                 ast_unescape_c(src);
2294                         }
2295                         if (i->field) {
2296                                 ast_string_field_ptr_set(d, i->field, src);
2297                         } else {
2298                                 /* Special cases that require additional procesing */
2299                                 if (!strcasecmp(i->key, "algorithm=")) {
2300                                         if (strcasecmp(src, "MD5")) {
2301                                                 ast_log(LOG_WARNING, "Digest algorithm: \"%s\" not supported.\n", src);
2302                                                 ast_free(str);
2303                                                 return -1;
2304                                         }
2305                                 } else if (!strcasecmp(i->key, "qop=") && !strcasecmp(src, "auth")) {
2306                                         d->qop = 1;
2307                                 } else if (!strcasecmp(i->key, "nc=")) {
2308                                         unsigned long u;
2309                                         if (sscanf(src, "%30lx", &u) != 1) {
2310                                                 ast_log(LOG_WARNING, "Incorrect Digest nc value: \"%s\".\n", src);
2311                                                 ast_free(str);
2312                                                 return -1;
2313                                         }
2314                                         ast_string_field_set(d, nc, src);
2315                                 }
2316                         }
2317                         break;
2318                 }
2319                 if (i->key == NULL) { /* not found, try ',' */
2320                         strsep(&c, ",");
2321                 }
2322         }
2323         ast_free(str);
2324
2325         /* Digest checkout */
2326         if (ast_strlen_zero(d->realm) || ast_strlen_zero(d->nonce)) {
2327                 /* "realm" and "nonce" MUST be always exist */
2328                 return -1;
2329         }
2330
2331         if (!request) {
2332                 /* Additional check for Digest response */
2333                 if (ast_strlen_zero(d->username) || ast_strlen_zero(d->uri) || ast_strlen_zero(d->response)) {
2334                         return -1;
2335                 }
2336
2337                 if (pedantic && d->qop && (ast_strlen_zero(d->cnonce) || ast_strlen_zero(d->nc))) {
2338                         return -1;
2339                 }
2340         }
2341
2342         return 0;
2343 }
2344
2345 #ifndef __AST_DEBUG_MALLOC
2346 int __ast_asprintf(const char *file, int lineno, const char *func, char **ret, const char *fmt, ...)
2347 {
2348         int res;
2349         va_list ap;
2350
2351         va_start(ap, fmt);
2352         if ((res = vasprintf(ret, fmt, ap)) == -1) {
2353                 MALLOC_FAILURE_MSG;
2354         }
2355         va_end(ap);
2356
2357         return res;
2358 }
2359 #endif
2360
2361 int ast_get_tid(void)
2362 {
2363         int ret = -1;
2364 #if defined (__linux) && defined(SYS_gettid)
2365         ret = syscall(SYS_gettid); /* available since Linux 1.4.11 */
2366 #elif defined(__sun)
2367         ret = pthread_self();
2368 #elif defined(__APPLE__)
2369         ret = mach_thread_self();
2370         mach_port_deallocate(mach_task_self(), ret);
2371 #elif defined(__FreeBSD__) && defined(HAVE_SYS_THR_H)
2372         long lwpid;
2373         thr_self(&lwpid); /* available since sys/thr.h creation 2003 */
2374         ret = lwpid;
2375 #endif
2376         return ret;
2377 }
2378
2379 char *ast_utils_which(const char *binary, char *fullpath, size_t fullpath_size)
2380 {
2381         const char *envPATH = getenv("PATH");
2382         char *tpath, *path;
2383         struct stat unused;
2384         if (!envPATH) {
2385                 return NULL;
2386         }
2387         tpath = ast_strdupa(envPATH);
2388         while ((path = strsep(&tpath, ":"))) {
2389                 snprintf(fullpath, fullpath_size, "%s/%s", path, binary);
2390                 if (!stat(fullpath, &unused)) {
2391                         return fullpath;
2392                 }
2393         }
2394         return NULL;
2395 }
2396
2397 int ast_check_ipv6(void)
2398 {
2399         int udp6_socket = socket(AF_INET6, SOCK_DGRAM, 0);
2400
2401         if (udp6_socket < 0) {
2402                 return 0;
2403         }
2404
2405         close(udp6_socket);
2406         return 1;
2407 }
2408
2409 void DO_CRASH_NORETURN ast_do_crash(void)
2410 {
2411 #if defined(DO_CRASH)
2412         abort();
2413         /*
2414          * Just in case abort() doesn't work or something else super
2415          * silly, and for Qwell's amusement.
2416          */
2417         *((int *) 0) = 0;
2418 #endif  /* defined(DO_CRASH) */
2419 }
2420
2421 void DO_CRASH_NORETURN __ast_assert_failed(int condition, const char *condition_str, const char *file, int line, const char *function)
2422 {
2423         /*
2424          * Attempt to put it into the logger, but hope that at least
2425          * someone saw the message on stderr ...
2426          */
2427         fprintf(stderr, "FRACK!, Failed assertion %s (%d) at line %d in %s of %s\n",
2428                 condition_str, condition, line, function, file);
2429         ast_log(__LOG_ERROR, file, line, function, "FRACK!, Failed assertion %s (%d)\n",
2430                 condition_str, condition);
2431
2432         /* Generate a backtrace for the assert */
2433         ast_log_backtrace();
2434
2435         /*
2436          * Give the logger a chance to get the message out, just in case
2437          * we abort(), or Asterisk crashes due to whatever problem just
2438          * happened after we exit ast_assert().
2439          */
2440         usleep(1);
2441         ast_do_crash();
2442 }
2443
2444 char *ast_eid_to_str(char *s, int maxlen, struct ast_eid *eid)
2445 {
2446         int x;
2447         char *os = s;
2448         if (maxlen < 18) {
2449                 if (s && (maxlen > 0)) {
2450                         *s = '\0';
2451                 }
2452         } else {
2453                 for (x = 0; x < 5; x++) {
2454                         sprintf(s, "%02hhx:", eid->eid[x]);
2455                         s += 3;
2456                 }
2457                 sprintf(s, "%02hhx", eid->eid[5]);
2458         }
2459         return os;
2460 }
2461
2462 #if defined(__OpenBSD__) || defined(__NetBSD__) || defined(__FreeBSD__) || defined(__Darwin__)
2463 #include <ifaddrs.h>
2464 #include <net/if_dl.h>
2465
2466 void ast_set_default_eid(struct ast_eid *eid)
2467 {
2468         struct ifaddrs *ifap, *ifaphead;
2469         int rtnerr;
2470         const struct sockaddr_dl *sdl;
2471         int alen;
2472         caddr_t ap;
2473         char eid_str[20];
2474         unsigned char empty_mac[6] = {0, 0, 0, 0, 0, 0};
2475         unsigned char full_mac[6]  = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
2476
2477         rtnerr = getifaddrs(&ifaphead);
2478         if (rtnerr) {
2479                 ast_log(LOG_WARNING, "No ethernet interface found for seeding global EID. "
2480                         "You will have to set it manually.\n");
2481                 return;
2482         }
2483
2484         if (!ifaphead) {
2485                 ast_log(LOG_WARNING, "No ethernet interface found for seeding global EID. "
2486                         "You will have to set it manually.\n");
2487                 return;
2488         }
2489
2490         for (ifap = ifaphead; ifap; ifap = ifap->ifa_next) {
2491                 if (ifap->ifa_addr->sa_family != AF_LINK) {
2492                         continue;
2493                 }
2494
2495                 sdl = (const struct sockaddr_dl *) ifap->ifa_addr;
2496                 ap = ((caddr_t) ((sdl)->sdl_data + (sdl)->sdl_nlen));
2497                 alen = sdl->sdl_alen;
2498                 if (alen != 6 || !(memcmp(ap, &empty_mac, 6) && memcmp(ap, &full_mac, 6))) {
2499                         continue;
2500                 }
2501
2502                 memcpy(eid, ap, sizeof(*eid));
2503                 ast_debug(1, "Seeding global EID '%s'\n",
2504                                 ast_eid_to_str(eid_str, sizeof(eid_str), eid));
2505                 freeifaddrs(ifaphead);
2506                 return;
2507         }
2508
2509         ast_log(LOG_WARNING, "No ethernet interface found for seeding global EID. "
2510                 "You will have to set it manually.\n");
2511         freeifaddrs(ifaphead);
2512
2513         return;
2514 }
2515
2516 #elif defined(SOLARIS)
2517 #include <sys/sockio.h>
2518 #include <net/if_arp.h>
2519
2520 void ast_set_default_eid(struct ast_eid *eid)
2521 {
2522         int s;
2523         int x;
2524         int res = 0;
2525         struct lifreq *ifr = NULL;
2526         struct lifnum ifn;
2527         struct lifconf ifc;
2528         struct arpreq ar;
2529         struct sockaddr_in *sa, *sa2;
2530         char *buf = NULL;
2531         char eid_str[20];
2532         int bufsz;
2533         unsigned char empty_mac[6] = {0, 0, 0, 0, 0, 0};
2534         unsigned char full_mac[6]  = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
2535
2536         s = socket(AF_INET, SOCK_STREAM, 0);
2537         if (s <= 0) {
2538                 ast_log(LOG_WARNING, "Unable to open a socket for seeding global EID. "
2539                         " You will have to set it manually.\n");
2540                 return;
2541         }
2542
2543         /* Get a count of interfaces on the machine */
2544         ifn.lifn_family = AF_UNSPEC;
2545         ifn.lifn_flags = 0;
2546         ifn.lifn_count = 0;
2547         if (ioctl(s, SIOCGLIFNUM, &ifn) < 0) {
2548                 ast_log(LOG_WARNING, "No ethernet interface found for seeding global EID. "
2549                         " You will have to set it manually.\n");
2550                 close(s);
2551                 return;
2552         }
2553
2554         bufsz = ifn.lifn_count * sizeof(struct lifreq);
2555         if (!(buf = ast_malloc(bufsz))) {
2556                 ast_log(LOG_WARNING, "Unable to allocate memory for seeding global EID. "
2557                         "You will have to set it manually.\n");
2558                 close(s);
2559                 return;
2560         }
2561         memset(buf, 0, bufsz);
2562
2563         /* Get a list of interfaces on the machine */
2564         ifc.lifc_len = bufsz;
2565         ifc.lifc_buf = buf;
2566         ifc.lifc_family = AF_UNSPEC;
2567         ifc.lifc_flags = 0;
2568         if (ioctl(s, SIOCGLIFCONF, &ifc) < 0) {
2569                 ast_log(LOG_WARNING, "No ethernet interface found for seeding global EID. "
2570                         "You will have to set it manually.\n");
2571                 ast_free(buf);
2572                 close(s);
2573                 return;
2574         }
2575
2576         for (ifr = (struct lifreq *)buf, x = 0; x < ifn.lifn_count; ifr++, x++) {
2577                 unsigned char *p;
2578
2579                 sa = (struct sockaddr_in *)&(ifr->lifr_addr);
2580                 sa2 = (struct sockaddr_in *)&(ar.arp_pa);
2581                 *sa2 = *sa;
2582
2583                 if(ioctl(s, SIOCGARP, &ar) >= 0) {
2584                         p = (unsigned char *)&(ar.arp_ha.sa_data);
2585                         if (!(memcmp(p, &empty_mac, 6) && memcmp(p, &full_mac, 6))) {
2586                                 continue;
2587                         }
2588
2589                         memcpy(eid, p, sizeof(*eid));
2590                         ast_debug(1, "Seeding global EID '%s'\n",
2591                                 ast_eid_to_str(eid_str, sizeof(eid_str), eid));
2592                         ast_free(buf);
2593                         close(s);
2594                         return;
2595                 }
2596         }
2597
2598         ast_log(LOG_WARNING, "No ethernet interface found for seeding global EID. "
2599                 "You will have to set it manually.\n");
2600         ast_free(buf);
2601         close(s);
2602
2603         return;
2604 }
2605
2606 #else
2607 void ast_set_default_eid(struct ast_eid *eid)
2608 {
2609         int s;
2610         int i;
2611         struct ifreq *ifr;
2612         struct ifreq *ifrp;
2613         struct ifconf ifc;
2614         char *buf = NULL;
2615         char eid_str[20];
2616         int bufsz, num_interfaces;
2617         unsigned char empty_mac[6] = {0, 0, 0, 0, 0, 0};
2618         unsigned char full_mac[6]  = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
2619
2620         s = socket(AF_INET, SOCK_STREAM, 0);
2621         if (s <= 0) {
2622                 ast_log(LOG_WARNING, "Unable to open socket for seeding global EID. "
2623                         "You will have to set it manually.\n");
2624                 return;
2625         }
2626
2627         ifc.ifc_len = 0;
2628         ifc.ifc_buf = NULL;
2629         if (ioctl(s, SIOCGIFCONF, &ifc) || ifc.ifc_len <= 0) {
2630                 ast_log(LOG_WARNING, "No ethernet interface found for seeding global EID. "
2631                         "You will have to set it manually.\n");
2632                 close(s);
2633                 return;
2634         }
2635         bufsz = ifc.ifc_len;
2636
2637         if (!(buf = ast_malloc(bufsz))) {
2638                 ast_log(LOG_WARNING, "Unable to allocate memory for seeding global EID. "
2639                         "You will have to set it manually.\n");
2640                 close(s);
2641                 return;
2642         }
2643
2644         ifc.ifc_buf = buf;
2645         if (ioctl(s, SIOCGIFCONF, &ifc) < 0) {
2646                 ast_log(LOG_WARNING, "Unable to retrieve ethernet interfaces for seeding global EID. "
2647                         "You will have to set it manually.\n");
2648                 ast_free(buf);
2649                 close(s);
2650                 return;
2651         }
2652
2653         ifrp = ifc.ifc_req;
2654         num_interfaces = ifc.ifc_len / sizeof(*ifr);
2655
2656         for (i = 0; i < num_interfaces; i++) {
2657                 ifr = &ifrp[i];
2658                 if (!ioctl(s, SIOCGIFHWADDR, ifr)) {
2659                         unsigned char *hwaddr = (unsigned char *) ifr->ifr_hwaddr.sa_data;
2660
2661                         if (!(memcmp(hwaddr, &empty_mac, 6) && memcmp(hwaddr, &full_mac, 6))) {
2662                                 continue;
2663                         }
2664
2665                         memcpy(eid, hwaddr, sizeof(*eid));
2666                         ast_debug(1, "Seeding global EID '%s' from '%s' using 'siocgifhwaddr'\n",
2667                                 ast_eid_to_str(eid_str, sizeof(eid_str), eid), ifr->ifr_name);
2668                         ast_free(buf);
2669                         close(s);
2670                         return;
2671                 }
2672         }
2673
2674         ast_log(LOG_WARNING, "No ethernet interface found for seeding global EID. "
2675                 "You will have to set it manually.\n");
2676         ast_free(buf);
2677         close(s);
2678
2679         return;
2680 }
2681 #endif /* LINUX */
2682
2683 int ast_str_to_eid(struct ast_eid *eid, const char *s)
2684 {
2685         unsigned int eid_int[6];
2686         int x;
2687
2688         if (sscanf(s, "%2x:%2x:%2x:%2x:%2x:%2x", &eid_int[0], &eid_int[1], &eid_int[2],
2689                  &eid_int[3], &eid_int[4], &eid_int[5]) != 6) {
2690                         return -1;
2691         }
2692
2693         for (x = 0; x < 6; x++) {
2694                 eid->eid[x] = eid_int[x];
2695         }
2696
2697         return 0;
2698 }
2699
2700 int ast_eid_cmp(const struct ast_eid *eid1, const struct ast_eid *eid2)
2701 {
2702         return memcmp(eid1, eid2, sizeof(*eid1));
2703 }
2704
2705 int ast_eid_is_empty(const struct ast_eid *eid)
2706 {
2707         struct ast_eid empty_eid;
2708
2709         memset(&empty_eid, 0, sizeof(empty_eid));
2710         return memcmp(eid, &empty_eid, sizeof(empty_eid)) ? 0 : 1;
2711 }
2712
2713 int ast_file_is_readable(const char *filename)
2714 {
2715 #if defined(HAVE_EACCESS) || defined(HAVE_EUIDACCESS)
2716 #if defined(HAVE_EUIDACCESS) && !defined(HAVE_EACCESS)
2717 #define eaccess euidaccess
2718 #endif
2719         return eaccess(filename, R_OK) == 0;
2720 #else
2721         int fd = open(filename, O_RDONLY |  O_NONBLOCK);
2722         if (fd < 0) {
2723                 return 0;
2724         }
2725         close(fd);
2726         return 1;
2727 #endif
2728 }
2729
2730 int ast_compare_versions(const char *version1, const char *version2)
2731 {
2732         unsigned int major[2] = { 0 };
2733         unsigned int minor[2] = { 0 };
2734         unsigned int patch[2] = { 0 };
2735         unsigned int extra[2] = { 0 };
2736         int res;
2737
2738         sscanf(version1, "%u.%u.%u.%u", &major[0], &minor[0], &patch[0], &extra[0]);
2739         sscanf(version2, "%u.%u.%u.%u", &major[1], &minor[1], &patch[1], &extra[1]);
2740
2741         res = major[0] - major[1];
2742         if (res) {
2743                 return res;
2744         }
2745         res = minor[0] - minor[1];
2746         if (res) {
2747                 return res;
2748         }
2749         res = patch[0] - patch[1];
2750         if (res) {
2751                 return res;
2752         }
2753         return extra[0] - extra[1];
2754 }