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