Merged revisions 104102 via svnmerge from
[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 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <ctype.h>
31 #include <sys/stat.h>
32
33 #ifdef HAVE_DEV_URANDOM
34 #include <fcntl.h>
35 #endif
36
37 #include "asterisk/network.h"
38
39 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in lock.h if required */
40 #include "asterisk/lock.h"
41 #include "asterisk/io.h"
42 #include "asterisk/md5.h"
43 #include "asterisk/sha1.h"
44 #include "asterisk/cli.h"
45 #include "asterisk/linkedlists.h"
46
47 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
48 #include "asterisk/strings.h"
49
50 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
51 #include "asterisk/time.h"
52
53 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
54 #include "asterisk/stringfields.h"
55
56 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
57 #include "asterisk/utils.h"
58
59 #define AST_API_MODULE
60 #include "asterisk/threadstorage.h"
61
62 static char base64[64];
63 static char b2a[256];
64
65 AST_THREADSTORAGE(inet_ntoa_buf);
66
67 #if !defined(HAVE_GETHOSTBYNAME_R_5) && !defined(HAVE_GETHOSTBYNAME_R_6)
68
69 #define ERANGE 34       /*!< duh? ERANGE value copied from web... */
70 #undef gethostbyname
71
72 AST_MUTEX_DEFINE_STATIC(__mutex);
73
74 /*! \brief Reentrant replacement for gethostbyname for BSD-based systems.
75 \note This
76 routine is derived from code originally written and placed in the public 
77 domain by Enzo Michelangeli <em@em.no-ip.com> */
78
79 static int gethostbyname_r (const char *name, struct hostent *ret, char *buf,
80                                 size_t buflen, struct hostent **result, 
81                                 int *h_errnop) 
82 {
83         int hsave;
84         struct hostent *ph;
85         ast_mutex_lock(&__mutex); /* begin critical area */
86         hsave = h_errno;
87
88         ph = gethostbyname(name);
89         *h_errnop = h_errno; /* copy h_errno to *h_herrnop */
90         if (ph == NULL) {
91                 *result = NULL;
92         } else {
93                 char **p, **q;
94                 char *pbuf;
95                 int nbytes = 0;
96                 int naddr = 0, naliases = 0;
97                 /* determine if we have enough space in buf */
98
99                 /* count how many addresses */
100                 for (p = ph->h_addr_list; *p != 0; p++) {
101                         nbytes += ph->h_length; /* addresses */
102                         nbytes += sizeof(*p); /* pointers */
103                         naddr++;
104                 }
105                 nbytes += sizeof(*p); /* one more for the terminating NULL */
106
107                 /* count how many aliases, and total length of strings */
108                 for (p = ph->h_aliases; *p != 0; p++) {
109                         nbytes += (strlen(*p)+1); /* aliases */
110                         nbytes += sizeof(*p);  /* pointers */
111                         naliases++;
112                 }
113                 nbytes += sizeof(*p); /* one more for the terminating NULL */
114
115                 /* here nbytes is the number of bytes required in buffer */
116                 /* as a terminator must be there, the minimum value is ph->h_length */
117                 if (nbytes > buflen) {
118                         *result = NULL;
119                         ast_mutex_unlock(&__mutex); /* end critical area */
120                         return ERANGE; /* not enough space in buf!! */
121                 }
122
123                 /* There is enough space. Now we need to do a deep copy! */
124                 /* Allocation in buffer:
125                         from [0] to [(naddr-1) * sizeof(*p)]:
126                         pointers to addresses
127                         at [naddr * sizeof(*p)]:
128                         NULL
129                         from [(naddr+1) * sizeof(*p)] to [(naddr+naliases) * sizeof(*p)] :
130                         pointers to aliases
131                         at [(naddr+naliases+1) * sizeof(*p)]:
132                         NULL
133                         then naddr addresses (fixed length), and naliases aliases (asciiz).
134                 */
135
136                 *ret = *ph;   /* copy whole structure (not its address!) */
137
138                 /* copy addresses */
139                 q = (char **)buf; /* pointer to pointers area (type: char **) */
140                 ret->h_addr_list = q; /* update pointer to address list */
141                 pbuf = buf + ((naddr + naliases + 2) * sizeof(*p)); /* skip that area */
142                 for (p = ph->h_addr_list; *p != 0; p++) {
143                         memcpy(pbuf, *p, ph->h_length); /* copy address bytes */
144                         *q++ = pbuf; /* the pointer is the one inside buf... */
145                         pbuf += ph->h_length; /* advance pbuf */
146                 }
147                 *q++ = NULL; /* address list terminator */
148
149                 /* copy aliases */
150                 ret->h_aliases = q; /* update pointer to aliases list */
151                 for (p = ph->h_aliases; *p != 0; p++) {
152                         strcpy(pbuf, *p); /* copy alias strings */
153                         *q++ = pbuf; /* the pointer is the one inside buf... */
154                         pbuf += strlen(*p); /* advance pbuf */
155                         *pbuf++ = 0; /* string terminator */
156                 }
157                 *q++ = NULL; /* terminator */
158
159                 strcpy(pbuf, ph->h_name); /* copy alias strings */
160                 ret->h_name = pbuf;
161                 pbuf += strlen(ph->h_name); /* advance pbuf */
162                 *pbuf++ = 0; /* string terminator */
163
164                 *result = ret;  /* and let *result point to structure */
165
166         }
167         h_errno = hsave;  /* restore h_errno */
168         ast_mutex_unlock(&__mutex); /* end critical area */
169
170         return (*result == NULL); /* return 0 on success, non-zero on error */
171 }
172
173
174 #endif
175
176 /*! \brief Re-entrant (thread safe) version of gethostbyname that replaces the 
177    standard gethostbyname (which is not thread safe)
178 */
179 struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp)
180 {
181         int res;
182         int herrno;
183         int dots = 0;
184         const char *s;
185         struct hostent *result = NULL;
186         /* Although it is perfectly legitimate to lookup a pure integer, for
187            the sake of the sanity of people who like to name their peers as
188            integers, we break with tradition and refuse to look up a
189            pure integer */
190         s = host;
191         res = 0;
192         while (s && *s) {
193                 if (*s == '.')
194                         dots++;
195                 else if (!isdigit(*s))
196                         break;
197                 s++;
198         }
199         if (!s || !*s) {
200                 /* Forge a reply for IP's to avoid octal IP's being interpreted as octal */
201                 if (dots != 3)
202                         return NULL;
203                 memset(hp, 0, sizeof(struct ast_hostent));
204                 hp->hp.h_addrtype = AF_INET;
205                 hp->hp.h_addr_list = (void *) hp->buf;
206                 hp->hp.h_addr = hp->buf + sizeof(void *);
207                 if (inet_pton(AF_INET, host, hp->hp.h_addr) > 0)
208                         return &hp->hp;
209                 return NULL;
210                 
211         }
212 #ifdef HAVE_GETHOSTBYNAME_R_5
213         result = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &herrno);
214
215         if (!result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
216                 return NULL;
217 #else
218         res = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &result, &herrno);
219
220         if (res || !result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
221                 return NULL;
222 #endif
223         return &hp->hp;
224 }
225
226
227
228 AST_MUTEX_DEFINE_STATIC(test_lock);
229 AST_MUTEX_DEFINE_STATIC(test_lock2);
230 static pthread_t test_thread; 
231 static int lock_count = 0;
232 static int test_errors = 0;
233
234 /*! \brief This is a regression test for recursive mutexes.
235    test_for_thread_safety() will return 0 if recursive mutex locks are
236    working properly, and non-zero if they are not working properly. */
237 static void *test_thread_body(void *data) 
238
239         ast_mutex_lock(&test_lock);
240         lock_count += 10;
241         if (lock_count != 10) 
242                 test_errors++;
243         ast_mutex_lock(&test_lock);
244         lock_count += 10;
245         if (lock_count != 20) 
246                 test_errors++;
247         ast_mutex_lock(&test_lock2);
248         ast_mutex_unlock(&test_lock);
249         lock_count -= 10;
250         if (lock_count != 10) 
251                 test_errors++;
252         ast_mutex_unlock(&test_lock);
253         lock_count -= 10;
254         ast_mutex_unlock(&test_lock2);
255         if (lock_count != 0) 
256                 test_errors++;
257         return NULL;
258
259
260 int test_for_thread_safety(void)
261
262         ast_mutex_lock(&test_lock2);
263         ast_mutex_lock(&test_lock);
264         lock_count += 1;
265         ast_mutex_lock(&test_lock);
266         lock_count += 1;
267         ast_pthread_create(&test_thread, NULL, test_thread_body, NULL); 
268         usleep(100);
269         if (lock_count != 2) 
270                 test_errors++;
271         ast_mutex_unlock(&test_lock);
272         lock_count -= 1;
273         usleep(100); 
274         if (lock_count != 1) 
275                 test_errors++;
276         ast_mutex_unlock(&test_lock);
277         lock_count -= 1;
278         if (lock_count != 0) 
279                 test_errors++;
280         ast_mutex_unlock(&test_lock2);
281         usleep(100);
282         if (lock_count != 0) 
283                 test_errors++;
284         pthread_join(test_thread, NULL);
285         return(test_errors);          /* return 0 on success. */
286 }
287
288 /*! \brief Produce 32 char MD5 hash of value. */
289 void ast_md5_hash(char *output, char *input)
290 {
291         struct MD5Context md5;
292         unsigned char digest[16];
293         char *ptr;
294         int x;
295
296         MD5Init(&md5);
297         MD5Update(&md5, (unsigned char *)input, strlen(input));
298         MD5Final(digest, &md5);
299         ptr = output;
300         for (x = 0; x < 16; x++)
301                 ptr += sprintf(ptr, "%2.2x", digest[x]);
302 }
303
304 /*! \brief Produce 40 char SHA1 hash of value. */
305 void ast_sha1_hash(char *output, char *input)
306 {
307         struct SHA1Context sha;
308         char *ptr;
309         int x;
310         uint8_t Message_Digest[20];
311
312         SHA1Reset(&sha);
313         
314         SHA1Input(&sha, (const unsigned char *) input, strlen(input));
315
316         SHA1Result(&sha, Message_Digest);
317         ptr = output;
318         for (x = 0; x < 20; x++)
319                 ptr += sprintf(ptr, "%2.2x", Message_Digest[x]);
320 }
321
322 /*! \brief decode BASE64 encoded text */
323 int ast_base64decode(unsigned char *dst, const char *src, int max)
324 {
325         int cnt = 0;
326         unsigned int byte = 0;
327         unsigned int bits = 0;
328         int incnt = 0;
329         while (*src && (cnt < max)) {
330                 /* Shift in 6 bits of input */
331                 byte <<= 6;
332                 byte |= (b2a[(int)(*src)]) & 0x3f;
333                 bits += 6;
334                 src++;
335                 incnt++;
336                 /* If we have at least 8 bits left over, take that character 
337                    off the top */
338                 if (bits >= 8)  {
339                         bits -= 8;
340                         *dst = (byte >> bits) & 0xff;
341                         dst++;
342                         cnt++;
343                 }
344         }
345         /* Dont worry about left over bits, they're extra anyway */
346         return cnt;
347 }
348
349 /*! \brief encode text to BASE64 coding */
350 int ast_base64encode_full(char *dst, const unsigned char *src, int srclen, int max, int linebreaks)
351 {
352         int cnt = 0;
353         int col = 0;
354         unsigned int byte = 0;
355         int bits = 0;
356         int cntin = 0;
357         /* Reserve space for null byte at end of string */
358         max--;
359         while ((cntin < srclen) && (cnt < max)) {
360                 byte <<= 8;
361                 byte |= *(src++);
362                 bits += 8;
363                 cntin++;
364                 if ((bits == 24) && (cnt + 4 <= max)) {
365                         *dst++ = base64[(byte >> 18) & 0x3f];
366                         *dst++ = base64[(byte >> 12) & 0x3f];
367                         *dst++ = base64[(byte >> 6) & 0x3f];
368                         *dst++ = base64[byte & 0x3f];
369                         cnt += 4;
370                         col += 4;
371                         bits = 0;
372                         byte = 0;
373                 }
374                 if (linebreaks && (cnt < max) && (col == 64)) {
375                         *dst++ = '\n';
376                         cnt++;
377                         col = 0;
378                 }
379         }
380         if (bits && (cnt + 4 <= max)) {
381                 /* Add one last character for the remaining bits, 
382                    padding the rest with 0 */
383                 byte <<= 24 - bits;
384                 *dst++ = base64[(byte >> 18) & 0x3f];
385                 *dst++ = base64[(byte >> 12) & 0x3f];
386                 if (bits == 16)
387                         *dst++ = base64[(byte >> 6) & 0x3f];
388                 else
389                         *dst++ = '=';
390                 *dst++ = '=';
391                 cnt += 4;
392         }
393         if (linebreaks && (cnt < max)) {
394                 *dst++ = '\n';
395                 cnt++;
396         }
397         *dst = '\0';
398         return cnt;
399 }
400
401 int ast_base64encode(char *dst, const unsigned char *src, int srclen, int max)
402 {
403         return ast_base64encode_full(dst, src, srclen, max, 0);
404 }
405
406 static void base64_init(void)
407 {
408         int x;
409         memset(b2a, -1, sizeof(b2a));
410         /* Initialize base-64 Conversion table */
411         for (x = 0; x < 26; x++) {
412                 /* A-Z */
413                 base64[x] = 'A' + x;
414                 b2a['A' + x] = x;
415                 /* a-z */
416                 base64[x + 26] = 'a' + x;
417                 b2a['a' + x] = x + 26;
418                 /* 0-9 */
419                 if (x < 10) {
420                         base64[x + 52] = '0' + x;
421                         b2a['0' + x] = x + 52;
422                 }
423         }
424         base64[62] = '+';
425         base64[63] = '/';
426         b2a[(int)'+'] = 62;
427         b2a[(int)'/'] = 63;
428 }
429
430 /*! \brief  ast_uri_encode: Turn text string to URI-encoded %XX version
431 \note   At this point, we're converting from ISO-8859-x (8-bit), not UTF8
432         as in the SIP protocol spec 
433         If doreserved == 1 we will convert reserved characters also.
434         RFC 2396, section 2.4
435         outbuf needs to have more memory allocated than the instring
436         to have room for the expansion. Every char that is converted
437         is replaced by three ASCII characters.
438
439         Note: The doreserved option is needed for replaces header in
440         SIP transfers.
441 */
442 char *ast_uri_encode(const char *string, char *outbuf, int buflen, int doreserved) 
443 {
444         char *reserved = ";/?:@&=+$, "; /* Reserved chars */
445
446         const char *ptr  = string;      /* Start with the string */
447         char *out = NULL;
448         char *buf = NULL;
449
450         ast_copy_string(outbuf, string, buflen);
451
452         /* If there's no characters to convert, just go through and don't do anything */
453         while (*ptr) {
454                 if ((*ptr < 32 || (unsigned char) *ptr) > 127 || (doreserved && strchr(reserved, *ptr)) ) {
455                         /* Oops, we need to start working here */
456                         if (!buf) {
457                                 buf = outbuf;
458                                 out = buf + (ptr - string) ;    /* Set output ptr */
459                         }
460                         out += sprintf(out, "%%%02x", (unsigned char) *ptr);
461                 } else if (buf) {
462                         *out = *ptr;    /* Continue copying the string */
463                         out++;
464                 } 
465                 ptr++;
466         }
467         if (buf)
468                 *out = '\0';
469         return outbuf;
470 }
471
472 /*! \brief  ast_uri_decode: Decode SIP URI, URN, URL (overwrite the string)  */
473 void ast_uri_decode(char *s) 
474 {
475         char *o;
476         unsigned int tmp;
477
478         for (o = s; *s; s++, o++) {
479                 if (*s == '%' && strlen(s) > 2 && sscanf(s + 1, "%2x", &tmp) == 1) {
480                         /* have '%', two chars and correct parsing */
481                         *o = tmp;
482                         s += 2; /* Will be incremented once more when we break out */
483                 } else /* all other cases, just copy */
484                         *o = *s;
485         }
486         *o = '\0';
487 }
488
489 /*! \brief  ast_inet_ntoa: Recursive thread safe replacement of inet_ntoa */
490 const char *ast_inet_ntoa(struct in_addr ia)
491 {
492         char *buf;
493
494         if (!(buf = ast_threadstorage_get(&inet_ntoa_buf, INET_ADDRSTRLEN)))
495                 return "";
496
497         return inet_ntop(AF_INET, &ia, buf, INET_ADDRSTRLEN);
498 }
499
500 #ifdef HAVE_DEV_URANDOM
501 static int dev_urandom_fd;
502 #endif
503
504 #ifndef __linux__
505 #undef pthread_create /* For ast_pthread_create function only */
506 #endif /* !__linux__ */
507
508 #if !defined(LOW_MEMORY)
509
510 #ifdef DEBUG_THREADS
511
512 /*! \brief A reasonable maximum number of locks a thread would be holding ... */
513 #define AST_MAX_LOCKS 64
514
515 /* Allow direct use of pthread_mutex_t and friends */
516 #undef pthread_mutex_t
517 #undef pthread_mutex_lock
518 #undef pthread_mutex_unlock
519 #undef pthread_mutex_init
520 #undef pthread_mutex_destroy
521
522 /*! 
523  * \brief Keep track of which locks a thread holds 
524  *
525  * There is an instance of this struct for every active thread
526  */
527 struct thr_lock_info {
528         /*! The thread's ID */
529         pthread_t thread_id;
530         /*! The thread name which includes where the thread was started */
531         const char *thread_name;
532         /*! This is the actual container of info for what locks this thread holds */
533         struct {
534                 const char *file;
535                 int line_num;
536                 const char *func;
537                 const char *lock_name;
538                 void *lock_addr;
539                 int times_locked;
540                 enum ast_lock_type type;
541                 /*! This thread is waiting on this lock */
542                 int pending:2;
543         } locks[AST_MAX_LOCKS];
544         /*! This is the number of locks currently held by this thread.
545          *  The index (num_locks - 1) has the info on the last one in the
546          *  locks member */
547         unsigned int num_locks;
548         /*! Protects the contents of the locks member 
549          * Intentionally not ast_mutex_t */
550         pthread_mutex_t lock;
551         AST_LIST_ENTRY(thr_lock_info) entry;
552 };
553
554 /*! 
555  * \brief Locked when accessing the lock_infos list 
556  */
557 AST_MUTEX_DEFINE_STATIC(lock_infos_lock);
558 /*!
559  * \brief A list of each thread's lock info 
560  */
561 static AST_LIST_HEAD_NOLOCK_STATIC(lock_infos, thr_lock_info);
562
563 /*!
564  * \brief Destroy a thread's lock info
565  *
566  * This gets called automatically when the thread stops
567  */
568 static void lock_info_destroy(void *data)
569 {
570         struct thr_lock_info *lock_info = data;
571
572         pthread_mutex_lock(&lock_infos_lock.mutex);
573         AST_LIST_REMOVE(&lock_infos, lock_info, entry);
574         pthread_mutex_unlock(&lock_infos_lock.mutex);
575
576         pthread_mutex_destroy(&lock_info->lock);
577         if (lock_info->thread_name)
578                 free((void *) lock_info->thread_name);
579         free(lock_info);
580 }
581
582 /*!
583  * \brief The thread storage key for per-thread lock info
584  */
585 AST_THREADSTORAGE_CUSTOM(thread_lock_info, NULL, lock_info_destroy);
586
587 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
588         int line_num, const char *func, const char *lock_name, void *lock_addr)
589 {
590         struct thr_lock_info *lock_info;
591         int i;
592
593         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
594                 return;
595
596         pthread_mutex_lock(&lock_info->lock);
597
598         for (i = 0; i < lock_info->num_locks; i++) {
599                 if (lock_info->locks[i].lock_addr == lock_addr) {
600                         lock_info->locks[i].times_locked++;
601                         pthread_mutex_unlock(&lock_info->lock);
602                         return;
603                 }
604         }
605
606         if (lock_info->num_locks == AST_MAX_LOCKS) {
607                 /* Can't use ast_log here, because it will cause infinite recursion */
608                 fprintf(stderr, "XXX ERROR XXX A thread holds more locks than '%d'."
609                         "  Increase AST_MAX_LOCKS!\n", AST_MAX_LOCKS);
610                 pthread_mutex_unlock(&lock_info->lock);
611                 return;
612         }
613
614         if (i && lock_info->locks[i].pending == -1) {
615                 /* The last lock on the list was one that this thread tried to lock but
616                  * failed at doing so.  It has now moved on to something else, so remove
617                  * the old lock from the list. */
618                 i--;
619                 lock_info->num_locks--;
620                 memset(&lock_info->locks[i], 0, sizeof(lock_info->locks[0]));
621         }
622
623         lock_info->locks[i].file = filename;
624         lock_info->locks[i].line_num = line_num;
625         lock_info->locks[i].func = func;
626         lock_info->locks[i].lock_name = lock_name;
627         lock_info->locks[i].lock_addr = lock_addr;
628         lock_info->locks[i].times_locked = 1;
629         lock_info->locks[i].type = type;
630         lock_info->locks[i].pending = 1;
631         lock_info->num_locks++;
632
633         pthread_mutex_unlock(&lock_info->lock);
634 }
635
636 void ast_mark_lock_acquired(void)
637 {
638         struct thr_lock_info *lock_info;
639
640         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
641                 return;
642
643         pthread_mutex_lock(&lock_info->lock);
644         lock_info->locks[lock_info->num_locks - 1].pending = 0;
645         pthread_mutex_unlock(&lock_info->lock);
646 }
647
648 void ast_mark_lock_failed(void)
649 {
650         struct thr_lock_info *lock_info;
651
652         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
653                 return;
654
655         pthread_mutex_lock(&lock_info->lock);
656         lock_info->locks[lock_info->num_locks - 1].pending = -1;
657         lock_info->locks[lock_info->num_locks - 1].times_locked--;
658         pthread_mutex_unlock(&lock_info->lock);
659 }
660
661 void ast_remove_lock_info(void *lock_addr)
662 {
663         struct thr_lock_info *lock_info;
664         int i = 0;
665
666         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
667                 return;
668
669         pthread_mutex_lock(&lock_info->lock);
670
671         for (i = lock_info->num_locks - 1; i >= 0; i--) {
672                 if (lock_info->locks[i].lock_addr == lock_addr)
673                         break;
674         }
675
676         if (i == -1) {
677                 /* Lock not found :( */
678                 pthread_mutex_unlock(&lock_info->lock);
679                 return;
680         }
681
682         if (lock_info->locks[i].times_locked > 1) {
683                 lock_info->locks[i].times_locked--;
684                 pthread_mutex_unlock(&lock_info->lock);
685                 return;
686         }
687
688         if (i < lock_info->num_locks - 1) {
689                 /* Not the last one ... *should* be rare! */
690                 memmove(&lock_info->locks[i], &lock_info->locks[i + 1], 
691                         (lock_info->num_locks - (i + 1)) * sizeof(lock_info->locks[0]));
692         }
693
694         lock_info->num_locks--;
695
696         pthread_mutex_unlock(&lock_info->lock);
697 }
698
699 static const char *locktype2str(enum ast_lock_type type)
700 {
701         switch (type) {
702         case AST_MUTEX:
703                 return "MUTEX";
704         case AST_RDLOCK:
705                 return "RDLOCK";
706         case AST_WRLOCK:
707                 return "WRLOCK";
708         }
709
710         return "UNKNOWN";
711 }
712
713 static char *handle_show_locks(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
714 {
715         struct thr_lock_info *lock_info;
716         struct ast_str *str;
717
718         if (!(str = ast_str_create(4096)))
719                 return CLI_FAILURE;
720
721         switch (cmd) {
722         case CLI_INIT:
723                 e->command = "core show locks";
724                 e->usage =
725                         "Usage: core show locks\n"
726                         "       This command is for lock debugging.  It prints out which locks\n"
727                         "are owned by each active thread.\n";
728                 return NULL;
729
730         case CLI_GENERATE:
731                 return NULL;
732         }
733
734         ast_str_append(&str, 0, "\n" 
735                        "=======================================================================\n"
736                        "=== Currently Held Locks ==============================================\n"
737                        "=======================================================================\n"
738                        "===\n"
739                        "=== <file> <line num> <function> <lock name> <lock addr> (times locked)\n"
740                        "===\n");
741
742         if (!str)
743                 return CLI_FAILURE;
744
745         pthread_mutex_lock(&lock_infos_lock.mutex);
746         AST_LIST_TRAVERSE(&lock_infos, lock_info, entry) {
747                 int i;
748                 ast_str_append(&str, 0, "=== Thread ID: %d (%s)\n", (int) lock_info->thread_id,
749                         lock_info->thread_name);
750                 pthread_mutex_lock(&lock_info->lock);
751                 for (i = 0; str && i < lock_info->num_locks; i++) {
752                         int j;
753                         ast_mutex_t *lock;
754
755                         ast_str_append(&str, 0, "=== ---> %sLock #%d (%s): %s %d %s %s %p (%d)\n", 
756                                 lock_info->locks[i].pending > 0 ? "Waiting for " : 
757                                         lock_info->locks[i].pending < 0 ? "Tried and failed to get " : "", i,
758                                 lock_info->locks[i].file, 
759                                 locktype2str(lock_info->locks[i].type),
760                                 lock_info->locks[i].line_num,
761                                 lock_info->locks[i].func, lock_info->locks[i].lock_name,
762                                 lock_info->locks[i].lock_addr, 
763                                 lock_info->locks[i].times_locked);
764
765                         if (!lock_info->locks[i].pending || lock_info->locks[i].pending == -1)
766                                 continue;
767
768                         /* We only have further details for mutexes right now */
769                         if (lock_info->locks[i].type != AST_MUTEX)
770                                 continue;
771
772                         lock = lock_info->locks[i].lock_addr;
773
774                         ast_reentrancy_lock(lock);
775                         for (j = 0; str && j < lock->reentrancy; j++) {
776                                 ast_str_append(&str, 0, "=== --- ---> Locked Here: %s line %d (%s)\n",
777                                         lock->file[j], lock->lineno[j], lock->func[j]);
778                         }
779                         ast_reentrancy_unlock(lock);    
780                 }
781                 pthread_mutex_unlock(&lock_info->lock);
782                 if (!str)
783                         break;
784                 ast_str_append(&str, 0, "=== -------------------------------------------------------------------\n"
785                                "===\n");
786                 if (!str)
787                         break;
788         }
789         pthread_mutex_unlock(&lock_infos_lock.mutex);
790
791         if (!str)
792                 return CLI_FAILURE;
793
794         ast_str_append(&str, 0, "=======================================================================\n"
795                        "\n");
796
797         if (!str)
798                 return CLI_FAILURE;
799
800         ast_cli(a->fd, "%s", str->str);
801
802         ast_free(str);
803
804         return CLI_SUCCESS;
805 }
806
807 static struct ast_cli_entry utils_cli[] = {
808         AST_CLI_DEFINE(handle_show_locks, "Show which locks are held by which thread"),
809 };
810
811 #endif /* DEBUG_THREADS */
812
813 /*
814  * support for 'show threads'. The start routine is wrapped by
815  * dummy_start(), so that ast_register_thread() and
816  * ast_unregister_thread() know the thread identifier.
817  */
818 struct thr_arg {
819         void *(*start_routine)(void *);
820         void *data;
821         char *name;
822 };
823
824 /*
825  * on OS/X, pthread_cleanup_push() and pthread_cleanup_pop()
826  * are odd macros which start and end a block, so they _must_ be
827  * used in pairs (the latter with a '1' argument to call the
828  * handler on exit.
829  * On BSD we don't need this, but we keep it for compatibility.
830  */
831 static void *dummy_start(void *data)
832 {
833         void *ret;
834         struct thr_arg a = *((struct thr_arg *) data);  /* make a local copy */
835 #ifdef DEBUG_THREADS
836         struct thr_lock_info *lock_info;
837         pthread_mutexattr_t mutex_attr;
838 #endif
839
840         /* note that even though data->name is a pointer to allocated memory,
841            we are not freeing it here because ast_register_thread is going to
842            keep a copy of the pointer and then ast_unregister_thread will
843            free the memory
844         */
845         ast_free(data);
846         ast_register_thread(a.name);
847         pthread_cleanup_push(ast_unregister_thread, (void *) pthread_self());
848
849 #ifdef DEBUG_THREADS
850         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
851                 return NULL;
852
853         lock_info->thread_id = pthread_self();
854         lock_info->thread_name = strdup(a.name);
855
856         pthread_mutexattr_init(&mutex_attr);
857         pthread_mutexattr_settype(&mutex_attr, AST_MUTEX_KIND);
858         pthread_mutex_init(&lock_info->lock, &mutex_attr);
859         pthread_mutexattr_destroy(&mutex_attr);
860
861         pthread_mutex_lock(&lock_infos_lock.mutex); /* Intentionally not the wrapper */
862         AST_LIST_INSERT_TAIL(&lock_infos, lock_info, entry);
863         pthread_mutex_unlock(&lock_infos_lock.mutex); /* Intentionally not the wrapper */
864 #endif /* DEBUG_THREADS */
865
866         ret = a.start_routine(a.data);
867
868         pthread_cleanup_pop(1);
869
870         return ret;
871 }
872
873 #endif /* !LOW_MEMORY */
874
875 int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
876                              void *data, size_t stacksize, const char *file, const char *caller,
877                              int line, const char *start_fn)
878 {
879 #if !defined(LOW_MEMORY)
880         struct thr_arg *a;
881 #endif
882
883         if (!attr) {
884                 attr = alloca(sizeof(*attr));
885                 pthread_attr_init(attr);
886         }
887
888 #ifdef __linux__
889         /* On Linux, pthread_attr_init() defaults to PTHREAD_EXPLICIT_SCHED,
890            which is kind of useless. Change this here to
891            PTHREAD_INHERIT_SCHED; that way the -p option to set realtime
892            priority will propagate down to new threads by default.
893            This does mean that callers cannot set a different priority using
894            PTHREAD_EXPLICIT_SCHED in the attr argument; instead they must set
895            the priority afterwards with pthread_setschedparam(). */
896         if ((errno = pthread_attr_setinheritsched(attr, PTHREAD_INHERIT_SCHED)))
897                 ast_log(LOG_WARNING, "pthread_attr_setinheritsched: %s\n", strerror(errno));
898 #endif
899
900         if (!stacksize)
901                 stacksize = AST_STACKSIZE;
902
903         if ((errno = pthread_attr_setstacksize(attr, stacksize ? stacksize : AST_STACKSIZE)))
904                 ast_log(LOG_WARNING, "pthread_attr_setstacksize: %s\n", strerror(errno));
905
906 #if !defined(LOW_MEMORY)
907         if ((a = ast_malloc(sizeof(*a)))) {
908                 a->start_routine = start_routine;
909                 a->data = data;
910                 start_routine = dummy_start;
911                 asprintf(&a->name, "%-20s started at [%5d] %s %s()",
912                          start_fn, line, file, caller);
913                 data = a;
914         }
915 #endif /* !LOW_MEMORY */
916
917         return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
918 }
919
920
921 int ast_pthread_create_detached_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
922                              void *data, size_t stacksize, const char *file, const char *caller,
923                              int line, const char *start_fn)
924 {
925         unsigned char attr_destroy = 0;
926         int res;
927
928         if (!attr) {
929                 attr = alloca(sizeof(*attr));
930                 pthread_attr_init(attr);
931                 attr_destroy = 1;
932         }
933
934         if ((errno = pthread_attr_setdetachstate(attr, PTHREAD_CREATE_DETACHED)))
935                 ast_log(LOG_WARNING, "pthread_attr_setdetachstate: %s\n", strerror(errno));
936
937         res = ast_pthread_create_stack(thread, attr, start_routine, data, 
938                                        stacksize, file, caller, line, start_fn);
939
940         if (attr_destroy)
941                 pthread_attr_destroy(attr);
942
943         return res;
944 }
945
946 int ast_wait_for_input(int fd, int ms)
947 {
948         struct pollfd pfd[1];
949         memset(pfd, 0, sizeof(pfd));
950         pfd[0].fd = fd;
951         pfd[0].events = POLLIN|POLLPRI;
952         return poll(pfd, 1, ms);
953 }
954
955 /*!
956  * Try to write string, but wait no more than ms milliseconds before timing out.
957  *
958  * \note The code assumes that the file descriptor has NONBLOCK set,
959  * so there is only one system call made to do a write, unless we actually
960  * have a need to wait.  This way, we get better performance.
961  * If the descriptor is blocking, all assumptions on the guaranteed
962  * detail do not apply anymore.
963  * Also note that in the current implementation, the delay is per-write,
964  * so you still have no guarantees, anyways.
965  * Fortunately the routine is only used in a few places (cli.c, manager.c,
966  * res_agi.c) so it is reasonably easy to check how it behaves there.
967  *
968  * XXX We either need to fix the code, or fix the documentation.
969  */
970 int ast_carefulwrite(int fd, char *s, int len, int timeoutms) 
971 {
972         /* Try to write string, but wait no more than ms milliseconds
973            before timing out */
974         int res = 0;
975         struct pollfd fds[1];
976         while (len) {
977                 res = write(fd, s, len);
978                 if ((res < 0) && (errno != EAGAIN)) {
979                         return -1;
980                 }
981                 if (res < 0)
982                         res = 0;
983                 len -= res;
984                 s += res;
985                 res = 0;
986                 if (len) {
987                         fds[0].fd = fd;
988                         fds[0].events = POLLOUT;
989                         /* Wait until writable again */
990                         res = poll(fds, 1, timeoutms);
991                         if (res < 1)
992                                 return -1;
993                 }
994         }
995         return res;
996 }
997
998 char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes)
999 {
1000         char *e;
1001         char *q;
1002
1003         s = ast_strip(s);
1004         if ((q = strchr(beg_quotes, *s)) && *q != '\0') {
1005                 e = s + strlen(s) - 1;
1006                 if (*e == *(end_quotes + (q - beg_quotes))) {
1007                         s++;
1008                         *e = '\0';
1009                 }
1010         }
1011
1012         return s;
1013 }
1014
1015 char *ast_unescape_semicolon(char *s)
1016 {
1017         char *e;
1018         char *work = s;
1019
1020         while ((e = strchr(work, ';'))) {
1021                 if ((e > work) && (*(e-1) == '\\')) {
1022                         memmove(e - 1, e, strlen(e) + 1);
1023                         work = e;
1024                 } else {
1025                         work = e + 1;
1026                 }
1027         }
1028
1029         return s;
1030 }
1031
1032 /* !\brief unescape some C sequences in place, return pointer to the original string.
1033  */
1034 char *ast_unescape_c(char *src)
1035 {
1036         char c, *ret, *dst;
1037
1038         if (src == NULL)
1039                 return NULL;
1040         for (ret = dst = src; (c = *src++); *dst++ = c ) {
1041                 if (c != '\\')
1042                         continue;       /* copy char at the end of the loop */
1043                 switch ((c = *src++)) {
1044                 case '\0':      /* special, trailing '\' */
1045                         c = '\\';
1046                         break;
1047                 case 'b':       /* backspace */
1048                         c = '\b';
1049                         break;
1050                 case 'f':       /* form feed */
1051                         c = '\f';
1052                         break;
1053                 case 'n':
1054                         c = '\n';
1055                         break;
1056                 case 'r':
1057                         c = '\r';
1058                         break;
1059                 case 't':
1060                         c = '\t';
1061                         break;
1062                 }
1063                 /* default, use the char literally */
1064         }
1065         *dst = '\0';
1066         return ret;
1067 }
1068
1069 int ast_build_string_va(char **buffer, size_t *space, const char *fmt, va_list ap)
1070 {
1071         int result;
1072
1073         if (!buffer || !*buffer || !space || !*space)
1074                 return -1;
1075
1076         result = vsnprintf(*buffer, *space, fmt, ap);
1077
1078         if (result < 0)
1079                 return -1;
1080         else if (result > *space)
1081                 result = *space;
1082
1083         *buffer += result;
1084         *space -= result;
1085         return 0;
1086 }
1087
1088 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...)
1089 {
1090         va_list ap;
1091         int result;
1092
1093         va_start(ap, fmt);
1094         result = ast_build_string_va(buffer, space, fmt, ap);
1095         va_end(ap);
1096
1097         return result;
1098 }
1099
1100 int ast_true(const char *s)
1101 {
1102         if (ast_strlen_zero(s))
1103                 return 0;
1104
1105         /* Determine if this is a true value */
1106         if (!strcasecmp(s, "yes") ||
1107             !strcasecmp(s, "true") ||
1108             !strcasecmp(s, "y") ||
1109             !strcasecmp(s, "t") ||
1110             !strcasecmp(s, "1") ||
1111             !strcasecmp(s, "on"))
1112                 return -1;
1113
1114         return 0;
1115 }
1116
1117 int ast_false(const char *s)
1118 {
1119         if (ast_strlen_zero(s))
1120                 return 0;
1121
1122         /* Determine if this is a false value */
1123         if (!strcasecmp(s, "no") ||
1124             !strcasecmp(s, "false") ||
1125             !strcasecmp(s, "n") ||
1126             !strcasecmp(s, "f") ||
1127             !strcasecmp(s, "0") ||
1128             !strcasecmp(s, "off"))
1129                 return -1;
1130
1131         return 0;
1132 }
1133
1134 #define ONE_MILLION     1000000
1135 /*
1136  * put timeval in a valid range. usec is 0..999999
1137  * negative values are not allowed and truncated.
1138  */
1139 static struct timeval tvfix(struct timeval a)
1140 {
1141         if (a.tv_usec >= ONE_MILLION) {
1142                 ast_log(LOG_WARNING, "warning too large timestamp %ld.%ld\n",
1143                         a.tv_sec, (long int) a.tv_usec);
1144                 a.tv_sec += a.tv_usec / ONE_MILLION;
1145                 a.tv_usec %= ONE_MILLION;
1146         } else if (a.tv_usec < 0) {
1147                 ast_log(LOG_WARNING, "warning negative timestamp %ld.%ld\n",
1148                         a.tv_sec, (long int) a.tv_usec);
1149                 a.tv_usec = 0;
1150         }
1151         return a;
1152 }
1153
1154 struct timeval ast_tvadd(struct timeval a, struct timeval b)
1155 {
1156         /* consistency checks to guarantee usec in 0..999999 */
1157         a = tvfix(a);
1158         b = tvfix(b);
1159         a.tv_sec += b.tv_sec;
1160         a.tv_usec += b.tv_usec;
1161         if (a.tv_usec >= ONE_MILLION) {
1162                 a.tv_sec++;
1163                 a.tv_usec -= ONE_MILLION;
1164         }
1165         return a;
1166 }
1167
1168 struct timeval ast_tvsub(struct timeval a, struct timeval b)
1169 {
1170         /* consistency checks to guarantee usec in 0..999999 */
1171         a = tvfix(a);
1172         b = tvfix(b);
1173         a.tv_sec -= b.tv_sec;
1174         a.tv_usec -= b.tv_usec;
1175         if (a.tv_usec < 0) {
1176                 a.tv_sec-- ;
1177                 a.tv_usec += ONE_MILLION;
1178         }
1179         return a;
1180 }
1181 #undef ONE_MILLION
1182
1183 /*! \brief glibc puts a lock inside random(3), so that the results are thread-safe.
1184  * BSD libc (and others) do not. */
1185
1186 #ifndef linux
1187 AST_MUTEX_DEFINE_STATIC(randomlock);
1188 #endif
1189
1190 long int ast_random(void)
1191 {
1192         long int res;
1193 #ifdef HAVE_DEV_URANDOM
1194         if (dev_urandom_fd >= 0) {
1195                 int read_res = read(dev_urandom_fd, &res, sizeof(res));
1196                 if (read_res > 0) {
1197                         long int rm = RAND_MAX;
1198                         res = res < 0 ? ~res : res;
1199                         rm++;
1200                         return res % rm;
1201                 }
1202         }
1203 #endif
1204 #ifdef linux
1205         res = random();
1206 #else
1207         ast_mutex_lock(&randomlock);
1208         res = random();
1209         ast_mutex_unlock(&randomlock);
1210 #endif
1211         return res;
1212 }
1213
1214 char *ast_process_quotes_and_slashes(char *start, char find, char replace_with)
1215 {
1216         char *dataPut = start;
1217         int inEscape = 0;
1218         int inQuotes = 0;
1219
1220         for (; *start; start++) {
1221                 if (inEscape) {
1222                         *dataPut++ = *start;       /* Always goes verbatim */
1223                         inEscape = 0;
1224                 } else {
1225                         if (*start == '\\') {
1226                                 inEscape = 1;      /* Do not copy \ into the data */
1227                         } else if (*start == '\'') {
1228                                 inQuotes = 1 - inQuotes;   /* Do not copy ' into the data */
1229                         } else {
1230                                 /* Replace , with |, unless in quotes */
1231                                 *dataPut++ = inQuotes ? *start : ((*start == find) ? replace_with : *start);
1232                         }
1233                 }
1234         }
1235         if (start != dataPut)
1236                 *dataPut = 0;
1237         return dataPut;
1238 }
1239
1240 void ast_join(char *s, size_t len, char * const w[])
1241 {
1242         int x, ofs = 0;
1243         const char *src;
1244
1245         /* Join words into a string */
1246         if (!s)
1247                 return;
1248         for (x = 0; ofs < len && w[x]; x++) {
1249                 if (x > 0)
1250                         s[ofs++] = ' ';
1251                 for (src = w[x]; *src && ofs < len; src++)
1252                         s[ofs++] = *src;
1253         }
1254         if (ofs == len)
1255                 ofs--;
1256         s[ofs] = '\0';
1257 }
1258
1259 /*
1260  * stringfields support routines.
1261  */
1262
1263 const char __ast_string_field_empty[] = ""; /*!< the empty string */
1264
1265 /*! \brief add a new block to the pool.
1266  * We can only allocate from the topmost pool, so the
1267  * fields in *mgr reflect the size of that only.
1268  */
1269 static int add_string_pool(struct ast_string_field_mgr *mgr,
1270         struct ast_string_field_pool **pool_head, size_t size)
1271 {
1272         struct ast_string_field_pool *pool;
1273
1274         if (!(pool = ast_calloc(1, sizeof(*pool) + size)))
1275                 return -1;
1276         
1277         pool->prev = *pool_head;
1278         *pool_head = pool;
1279         mgr->size = size;
1280         mgr->used = 0;
1281
1282         return 0;
1283 }
1284
1285 /*
1286  * This is an internal API, code should not use it directly.
1287  * It initializes all fields as empty, then uses 'size' for 3 functions:
1288  * size > 0 means initialize the pool list with a pool of given size.
1289  *      This must be called right after allocating the object.
1290  * size = 0 means release all pools except the most recent one.
1291  *      This is useful to e.g. reset an object to the initial value.
1292  * size < 0 means release all pools.
1293  *      This must be done before destroying the object.
1294  */
1295 int __ast_string_field_init(struct ast_string_field_mgr *mgr,
1296         struct ast_string_field_pool **pool_head, int size)
1297 {
1298         const char **p = (const char **)pool_head + 1;
1299         struct ast_string_field_pool *cur = *pool_head;
1300
1301         /* clear fields - this is always necessary */
1302         while ((struct ast_string_field_mgr *)p != mgr)
1303                 *p++ = __ast_string_field_empty;
1304         if (size > 0) {                 /* allocate the initial pool */
1305                 *pool_head = NULL;
1306                 return add_string_pool(mgr, pool_head, size);
1307         }
1308         if (size < 0) {                 /* reset all pools */
1309                 *pool_head = NULL;
1310         } else {                        /* preserve the first pool */
1311                 if (cur == NULL) {
1312                         ast_log(LOG_WARNING, "trying to reset empty pool\n");
1313                         return -1;
1314                 }
1315                 cur = cur->prev;
1316                 (*pool_head)->prev = NULL;
1317                 mgr->used = 0;
1318         }
1319         while (cur) {
1320                 struct ast_string_field_pool *prev = cur->prev;
1321                 ast_free(cur);
1322                 cur = prev;
1323         }
1324         return 0;
1325 }
1326
1327 ast_string_field __ast_string_field_alloc_space(struct ast_string_field_mgr *mgr,
1328         struct ast_string_field_pool **pool_head, size_t needed)
1329 {
1330         char *result = NULL;
1331         size_t space = mgr->size - mgr->used;
1332
1333         if (__builtin_expect(needed > space, 0)) {
1334                 size_t new_size = mgr->size * 2;
1335
1336                 while (new_size < needed)
1337                         new_size *= 2;
1338
1339                 if (add_string_pool(mgr, pool_head, new_size))
1340                         return NULL;
1341         }
1342
1343         result = (*pool_head)->base + mgr->used;
1344         mgr->used += needed;
1345         return result;
1346 }
1347
1348 void __ast_string_field_ptr_build_va(struct ast_string_field_mgr *mgr,
1349         struct ast_string_field_pool **pool_head,
1350         const ast_string_field *ptr, const char *format, va_list ap1, va_list ap2)
1351 {
1352         size_t needed;
1353         char *dst = (*pool_head)->base + mgr->used;
1354         const char **p = (const char **)ptr;
1355         size_t space = mgr->size - mgr->used;
1356
1357         /* try to write using available space */
1358         needed = vsnprintf(dst, space, format, ap1) + 1;
1359
1360         va_end(ap1);
1361
1362         if (needed > space) {   /* if it fails, reallocate */
1363                 size_t new_size = mgr->size * 2;
1364
1365                 while (new_size < needed)
1366                         new_size *= 2;
1367
1368                 if (add_string_pool(mgr, pool_head, new_size))
1369                         return;
1370
1371                 dst = (*pool_head)->base + mgr->used;
1372                 vsprintf(dst, format, ap2);
1373         }
1374
1375         *p = dst;
1376         mgr->used += needed;
1377 }
1378
1379 void __ast_string_field_ptr_build(struct ast_string_field_mgr *mgr,
1380         struct ast_string_field_pool **pool_head,
1381         const ast_string_field *ptr, const char *format, ...)
1382 {
1383         va_list ap1, ap2;
1384
1385         va_start(ap1, format);
1386         va_start(ap2, format);          /* va_copy does not exist on FreeBSD */
1387
1388         __ast_string_field_ptr_build_va(mgr, pool_head, ptr, format, ap1, ap2);
1389
1390         va_end(ap1);
1391         va_end(ap2);
1392 }
1393 /* end of stringfields support */
1394
1395 AST_MUTEX_DEFINE_STATIC(fetchadd_m); /* used for all fetc&add ops */
1396
1397 int ast_atomic_fetchadd_int_slow(volatile int *p, int v)
1398 {
1399         int ret;
1400         ast_mutex_lock(&fetchadd_m);
1401         ret = *p;
1402         *p += v;
1403         ast_mutex_unlock(&fetchadd_m);
1404         return ret;
1405 }
1406
1407 /*! \brief
1408  * get values from config variables.
1409  */
1410 int ast_get_timeval(const char *src, struct timeval *dst, struct timeval _default, int *consumed)
1411 {
1412         long double dtv = 0.0;
1413         int scanned;
1414
1415         if (dst == NULL)
1416                 return -1;
1417
1418         *dst = _default;
1419
1420         if (ast_strlen_zero(src))
1421                 return -1;
1422
1423         /* only integer at the moment, but one day we could accept more formats */
1424         if (sscanf(src, "%Lf%n", &dtv, &scanned) > 0) {
1425                 dst->tv_sec = dtv;
1426                 dst->tv_usec = (dtv - dst->tv_sec) * 1000000.0;
1427                 if (consumed)
1428                         *consumed = scanned;
1429                 return 0;
1430         } else
1431                 return -1;
1432 }
1433
1434 /*! \brief
1435  * get values from config variables.
1436  */
1437 int ast_get_time_t(const char *src, time_t *dst, time_t _default, int *consumed)
1438 {
1439         long t;
1440         int scanned;
1441
1442         if (dst == NULL)
1443                 return -1;
1444
1445         *dst = _default;
1446
1447         if (ast_strlen_zero(src))
1448                 return -1;
1449
1450         /* only integer at the moment, but one day we could accept more formats */
1451         if (sscanf(src, "%ld%n", &t, &scanned) == 1) {
1452                 *dst = t;
1453                 if (consumed)
1454                         *consumed = scanned;
1455                 return 0;
1456         } else
1457                 return -1;
1458 }
1459
1460 /*!
1461  * core handler for dynamic strings.
1462  * This is not meant to be called directly, but rather through the
1463  * various wrapper macros
1464  *      ast_str_set(...)
1465  *      ast_str_append(...)
1466  *      ast_str_set_va(...)
1467  *      ast_str_append_va(...)
1468  */
1469 int __ast_str_helper(struct ast_str **buf, size_t max_len,
1470         int append, const char *fmt, va_list ap)
1471 {
1472         int res, need;
1473         int offset = (append && (*buf)->len) ? (*buf)->used : 0;
1474
1475         if (max_len < 0)
1476                 max_len = (*buf)->len;  /* don't exceed the allocated space */
1477         /*
1478          * Ask vsnprintf how much space we need. Remember that vsnprintf
1479          * does not count the final '\0' so we must add 1.
1480          */
1481         res = vsnprintf((*buf)->str + offset, (*buf)->len - offset, fmt, ap);
1482
1483         need = res + offset + 1;
1484         /*
1485          * If there is not enough space and we are below the max length,
1486          * reallocate the buffer and return a message telling to retry.
1487          */
1488         if (need > (*buf)->len && (max_len == 0 || (*buf)->len < max_len) ) {
1489                 if (max_len && max_len < need)  /* truncate as needed */
1490                         need = max_len;
1491                 else if (max_len == 0)  /* if unbounded, give more room for next time */
1492                         need += 16 + need/4;
1493                 if (0)  /* debugging */
1494                         ast_verbose("extend from %d to %d\n", (int)(*buf)->len, need);
1495                 if (ast_str_make_space(buf, need)) {
1496                         ast_verbose("failed to extend from %d to %d\n", (int)(*buf)->len, need);
1497                         return AST_DYNSTR_BUILD_FAILED;
1498                 }
1499                 (*buf)->str[offset] = '\0';     /* Truncate the partial write. */
1500
1501                 /* va_end() and va_start() must be done before calling
1502                  * vsnprintf() again. */
1503                 return AST_DYNSTR_BUILD_RETRY;
1504         }
1505         /* update space used, keep in mind the truncation */
1506         (*buf)->used = (res + offset > (*buf)->len) ? (*buf)->len : res + offset;
1507
1508         return res;
1509 }
1510
1511 void ast_enable_packet_fragmentation(int sock)
1512 {
1513 #if defined(HAVE_IP_MTU_DISCOVER)
1514         int val = IP_PMTUDISC_DONT;
1515         
1516         if (setsockopt(sock, IPPROTO_IP, IP_MTU_DISCOVER, &val, sizeof(val)))
1517                 ast_log(LOG_WARNING, "Unable to disable PMTU discovery. Large UDP packets may fail to be delivered when sent from this socket.\n");
1518 #endif /* HAVE_IP_MTU_DISCOVER */
1519 }
1520
1521 int ast_mkdir(const char *path, int mode)
1522 {
1523         char *ptr;
1524         int len = strlen(path), count = 0, x, piececount = 0;
1525         char *tmp = ast_strdupa(path);
1526         char **pieces;
1527         char *fullpath = alloca(len + 1);
1528         int res = 0;
1529
1530         for (ptr = tmp; *ptr; ptr++) {
1531                 if (*ptr == '/')
1532                         count++;
1533         }
1534
1535         /* Count the components to the directory path */
1536         pieces = alloca(count * sizeof(*pieces));
1537         for (ptr = tmp; *ptr; ptr++) {
1538                 if (*ptr == '/') {
1539                         *ptr = '\0';
1540                         pieces[piececount++] = ptr + 1;
1541                 }
1542         }
1543
1544         *fullpath = '\0';
1545         for (x = 0; x < piececount; x++) {
1546                 /* This looks funky, but the buffer is always ideally-sized, so it's fine. */
1547                 strcat(fullpath, "/");
1548                 strcat(fullpath, pieces[x]);
1549                 res = mkdir(fullpath, mode);
1550                 if (res && errno != EEXIST)
1551                         return errno;
1552         }
1553         return 0;
1554 }
1555
1556 int ast_utils_init(void)
1557 {
1558 #ifdef HAVE_DEV_URANDOM
1559         dev_urandom_fd = open("/dev/urandom", O_RDONLY);
1560 #endif
1561         base64_init();
1562 #ifdef DEBUG_THREADS
1563         ast_cli_register_multiple(utils_cli, sizeof(utils_cli) / sizeof(utils_cli[0]));
1564 #endif
1565         return 0;
1566 }