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