Merged revisions 118953 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 #ifdef HAVE_BKTR
544                 struct ast_bt *backtrace;
545 #endif
546         } locks[AST_MAX_LOCKS];
547         /*! This is the number of locks currently held by this thread.
548          *  The index (num_locks - 1) has the info on the last one in the
549          *  locks member */
550         unsigned int num_locks;
551         /*! Protects the contents of the locks member 
552          * Intentionally not ast_mutex_t */
553         pthread_mutex_t lock;
554         AST_LIST_ENTRY(thr_lock_info) entry;
555 };
556
557 /*! 
558  * \brief Locked when accessing the lock_infos list 
559  */
560 AST_MUTEX_DEFINE_STATIC(lock_infos_lock);
561 /*!
562  * \brief A list of each thread's lock info 
563  */
564 static AST_LIST_HEAD_NOLOCK_STATIC(lock_infos, thr_lock_info);
565
566 /*!
567  * \brief Destroy a thread's lock info
568  *
569  * This gets called automatically when the thread stops
570  */
571 static void lock_info_destroy(void *data)
572 {
573         struct thr_lock_info *lock_info = data;
574
575         pthread_mutex_lock(&lock_infos_lock.mutex);
576         AST_LIST_REMOVE(&lock_infos, lock_info, entry);
577         pthread_mutex_unlock(&lock_infos_lock.mutex);
578
579         pthread_mutex_destroy(&lock_info->lock);
580         if (lock_info->thread_name)
581                 free((void *) lock_info->thread_name);
582         free(lock_info);
583 }
584
585 /*!
586  * \brief The thread storage key for per-thread lock info
587  */
588 AST_THREADSTORAGE_CUSTOM(thread_lock_info, NULL, lock_info_destroy);
589 #ifdef HAVE_BKTR
590 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
591         int line_num, const char *func, const char *lock_name, void *lock_addr, struct ast_bt *bt)
592 #else
593 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
594         int line_num, const char *func, const char *lock_name, void *lock_addr)
595 #endif
596 {
597         struct thr_lock_info *lock_info;
598         int i;
599
600         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
601                 return;
602
603         pthread_mutex_lock(&lock_info->lock);
604
605         for (i = 0; i < lock_info->num_locks; i++) {
606                 if (lock_info->locks[i].lock_addr == lock_addr) {
607                         lock_info->locks[i].times_locked++;
608 #ifdef HAVE_BKTR
609                         lock_info->locks[i].backtrace = bt;
610 #endif
611                         pthread_mutex_unlock(&lock_info->lock);
612                         return;
613                 }
614         }
615
616         if (lock_info->num_locks == AST_MAX_LOCKS) {
617                 /* Can't use ast_log here, because it will cause infinite recursion */
618                 fprintf(stderr, "XXX ERROR XXX A thread holds more locks than '%d'."
619                         "  Increase AST_MAX_LOCKS!\n", AST_MAX_LOCKS);
620                 pthread_mutex_unlock(&lock_info->lock);
621                 return;
622         }
623
624         if (i && lock_info->locks[i - 1].pending == -1) {
625                 /* The last lock on the list was one that this thread tried to lock but
626                  * failed at doing so.  It has now moved on to something else, so remove
627                  * the old lock from the list. */
628                 i--;
629                 lock_info->num_locks--;
630                 memset(&lock_info->locks[i], 0, sizeof(lock_info->locks[0]));
631         }
632
633         lock_info->locks[i].file = filename;
634         lock_info->locks[i].line_num = line_num;
635         lock_info->locks[i].func = func;
636         lock_info->locks[i].lock_name = lock_name;
637         lock_info->locks[i].lock_addr = lock_addr;
638         lock_info->locks[i].times_locked = 1;
639         lock_info->locks[i].type = type;
640         lock_info->locks[i].pending = 1;
641 #ifdef HAVE_BKTR
642         lock_info->locks[i].backtrace = bt;
643 #endif
644         lock_info->num_locks++;
645
646         pthread_mutex_unlock(&lock_info->lock);
647 }
648
649 void ast_mark_lock_acquired(void *lock_addr)
650 {
651         struct thr_lock_info *lock_info;
652
653         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
654                 return;
655
656         pthread_mutex_lock(&lock_info->lock);
657         if (lock_info->locks[lock_info->num_locks - 1].lock_addr == lock_addr) {
658                 lock_info->locks[lock_info->num_locks - 1].pending = 0;
659         }
660         pthread_mutex_unlock(&lock_info->lock);
661 }
662
663 void ast_mark_lock_failed(void *lock_addr)
664 {
665         struct thr_lock_info *lock_info;
666
667         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
668                 return;
669
670         pthread_mutex_lock(&lock_info->lock);
671         if (lock_info->locks[lock_info->num_locks - 1].lock_addr == lock_addr) {
672                 lock_info->locks[lock_info->num_locks - 1].pending = -1;
673                 lock_info->locks[lock_info->num_locks - 1].times_locked--;
674         }
675         pthread_mutex_unlock(&lock_info->lock);
676 }
677 #ifdef HAVE_BKTR
678 void ast_remove_lock_info(void *lock_addr, struct ast_bt *bt)
679 #else
680 int ast_find_lock_info(void *lock_addr, const char **filename, int *lineno, const char **func, const char **mutex_name)
681 {
682         struct thr_lock_info *lock_info;
683         int i = 0;
684
685         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
686                 return -1;
687
688         pthread_mutex_lock(&lock_info->lock);
689
690         for (i = lock_info->num_locks - 1; i >= 0; i--) {
691                 if (lock_info->locks[i].lock_addr == lock_addr)
692                         break;
693         }
694
695         if (i == -1) {
696                 /* Lock not found :( */
697                 pthread_mutex_unlock(&lock_info->lock);
698                 return -1;
699         }
700
701         *filename = lock_info->locks[i].file;
702         *lineno = lock_info->locks[i].line_num;
703         *func = lock_info->locks[i].func;
704         *mutex_name = lock_info->locks[i].lock_name;
705         return 0;
706 }
707
708 void ast_remove_lock_info(void *lock_addr)
709 #endif
710 {
711         struct thr_lock_info *lock_info;
712         int i = 0;
713
714         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
715                 return;
716
717         pthread_mutex_lock(&lock_info->lock);
718
719         for (i = lock_info->num_locks - 1; i >= 0; i--) {
720                 if (lock_info->locks[i].lock_addr == lock_addr)
721                         break;
722         }
723
724         if (i == -1) {
725                 /* Lock not found :( */
726                 pthread_mutex_unlock(&lock_info->lock);
727                 return;
728         }
729
730         if (lock_info->locks[i].times_locked > 1) {
731                 lock_info->locks[i].times_locked--;
732 #ifdef HAVE_BKTR
733                 lock_info->locks[i].backtrace = bt;
734 #endif
735                 pthread_mutex_unlock(&lock_info->lock);
736                 return;
737         }
738
739         if (i < lock_info->num_locks - 1) {
740                 /* Not the last one ... *should* be rare! */
741                 memmove(&lock_info->locks[i], &lock_info->locks[i + 1], 
742                         (lock_info->num_locks - (i + 1)) * sizeof(lock_info->locks[0]));
743         }
744
745         lock_info->num_locks--;
746
747         pthread_mutex_unlock(&lock_info->lock);
748 }
749
750 static const char *locktype2str(enum ast_lock_type type)
751 {
752         switch (type) {
753         case AST_MUTEX:
754                 return "MUTEX";
755         case AST_RDLOCK:
756                 return "RDLOCK";
757         case AST_WRLOCK:
758                 return "WRLOCK";
759         }
760
761         return "UNKNOWN";
762 }
763
764 #ifdef HAVE_BKTR
765 static void append_backtrace_information(struct ast_str **str, struct ast_bt *bt)
766 {
767         char **symbols;
768
769         if (!bt) {
770                 ast_str_append(str, 0, "\tNo backtrace to print\n");
771                 return;
772         }
773
774         if ((symbols = backtrace_symbols(bt->addresses, bt->num_frames))) {
775                 int frame_iterator;
776                 
777                 for (frame_iterator = 0; frame_iterator < bt->num_frames; ++frame_iterator) {
778                         ast_str_append(str, 0, "\t%s\n", symbols[frame_iterator]);
779                 }
780
781                 free(symbols);
782         } else {
783                 ast_str_append(str, 0, "\tCouldn't retrieve backtrace symbols\n");
784         }
785 }
786 #endif
787
788 static void append_lock_information(struct ast_str **str, struct thr_lock_info *lock_info, int i)
789 {
790         int j;
791         ast_mutex_t *lock;
792         
793         ast_str_append(str, 0, "=== ---> %sLock #%d (%s): %s %d %s %s %p (%d)\n", 
794                                    lock_info->locks[i].pending > 0 ? "Waiting for " : 
795                                    lock_info->locks[i].pending < 0 ? "Tried and failed to get " : "", i,
796                                    lock_info->locks[i].file, 
797                                    locktype2str(lock_info->locks[i].type),
798                                    lock_info->locks[i].line_num,
799                                    lock_info->locks[i].func, lock_info->locks[i].lock_name,
800                                    lock_info->locks[i].lock_addr, 
801                                    lock_info->locks[i].times_locked);
802 #ifdef HAVE_BKTR
803         append_backtrace_information(str, lock_info->locks[i].backtrace);
804 #endif
805         
806         if (!lock_info->locks[i].pending || lock_info->locks[i].pending == -1)
807                 return;
808         
809         /* We only have further details for mutexes right now */
810         if (lock_info->locks[i].type != AST_MUTEX)
811                 return;
812         
813         lock = lock_info->locks[i].lock_addr;
814         
815         ast_reentrancy_lock(lock);
816         for (j = 0; *str && j < lock->reentrancy; j++) {
817                 ast_str_append(str, 0, "=== --- ---> Locked Here: %s line %d (%s)\n",
818                                            lock->file[j], lock->lineno[j], lock->func[j]);
819         }
820         ast_reentrancy_unlock(lock);    
821 }
822
823
824 /*! This function can help you find highly temporal locks; locks that happen for a 
825     short time, but at unexpected times, usually at times that create a deadlock,
826         Why is this thing locked right then? Who is locking it? Who am I fighting
827     with for this lock? 
828
829         To answer such questions, just call this routine before you would normally try
830         to aquire a lock. It doesn't do anything if the lock is not acquired. If the
831         lock is taken, it will publish a line or two to the console via ast_log().
832
833         Sometimes, the lock message is pretty uninformative. For instance, you might
834         find that the lock is being aquired deep within the astobj2 code; this tells
835         you little about higher level routines that call the astobj2 routines.
836         But, using gdb, you can set a break at the ast_log below, and for that
837         breakpoint, you can set the commands:
838           where
839           cont
840         which will give a stack trace and continue. -- that aught to do the job!
841
842 */
843 void log_show_lock(void *this_lock_addr)
844 {
845         struct thr_lock_info *lock_info;
846         struct ast_str *str;
847
848         if (!(str = ast_str_create(4096))) {
849                 ast_log(LOG_NOTICE,"Could not create str\n");
850                 return;
851         }
852         
853
854         pthread_mutex_lock(&lock_infos_lock.mutex);
855         AST_LIST_TRAVERSE(&lock_infos, lock_info, entry) {
856                 int i;
857                 pthread_mutex_lock(&lock_info->lock);
858                 for (i = 0; str && i < lock_info->num_locks; i++) {
859                         /* ONLY show info about this particular lock, if
860                            it's acquired... */
861                         if (lock_info->locks[i].lock_addr == this_lock_addr) {
862                                 append_lock_information(&str, lock_info, i);
863                                 ast_log(LOG_NOTICE, "%s", str->str);
864                                 break;
865                         }
866                 }
867                 pthread_mutex_unlock(&lock_info->lock);
868         }
869         pthread_mutex_unlock(&lock_infos_lock.mutex);
870         ast_free(str);
871 }
872
873
874 static char *handle_show_locks(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
875 {
876         struct thr_lock_info *lock_info;
877         struct ast_str *str;
878
879         if (!(str = ast_str_create(4096)))
880                 return CLI_FAILURE;
881
882         switch (cmd) {
883         case CLI_INIT:
884                 e->command = "core show locks";
885                 e->usage =
886                         "Usage: core show locks\n"
887                         "       This command is for lock debugging.  It prints out which locks\n"
888                         "are owned by each active thread.\n";
889                 return NULL;
890
891         case CLI_GENERATE:
892                 return NULL;
893         }
894
895         ast_str_append(&str, 0, "\n" 
896                        "=======================================================================\n"
897                        "=== Currently Held Locks ==============================================\n"
898                        "=======================================================================\n"
899                        "===\n"
900                        "=== <pending> <lock#> (<file>): <lock type> <line num> <function> <lock name> <lock addr> (times locked)\n"
901                        "===\n");
902
903         if (!str)
904                 return CLI_FAILURE;
905
906         pthread_mutex_lock(&lock_infos_lock.mutex);
907         AST_LIST_TRAVERSE(&lock_infos, lock_info, entry) {
908                 int i;
909                 if (lock_info->num_locks) {
910                         ast_str_append(&str, 0, "=== Thread ID: %d (%s)\n", (int) lock_info->thread_id,
911                                 lock_info->thread_name);
912                         pthread_mutex_lock(&lock_info->lock);
913                         for (i = 0; str && i < lock_info->num_locks; i++) {
914                                 append_lock_information(&str, lock_info, i);
915                         }
916                         pthread_mutex_unlock(&lock_info->lock);
917                         if (!str)
918                                 break;
919                         ast_str_append(&str, 0, "=== -------------------------------------------------------------------\n"
920                                        "===\n");
921                         if (!str)
922                                 break;
923                 }
924         }
925         pthread_mutex_unlock(&lock_infos_lock.mutex);
926
927         if (!str)
928                 return CLI_FAILURE;
929
930         ast_str_append(&str, 0, "=======================================================================\n"
931                        "\n");
932
933         if (!str)
934                 return CLI_FAILURE;
935
936         ast_cli(a->fd, "%s", str->str);
937
938         ast_free(str);
939
940         return CLI_SUCCESS;
941 }
942
943 static struct ast_cli_entry utils_cli[] = {
944         AST_CLI_DEFINE(handle_show_locks, "Show which locks are held by which thread"),
945 };
946
947 #endif /* DEBUG_THREADS */
948
949 /*
950  * support for 'show threads'. The start routine is wrapped by
951  * dummy_start(), so that ast_register_thread() and
952  * ast_unregister_thread() know the thread identifier.
953  */
954 struct thr_arg {
955         void *(*start_routine)(void *);
956         void *data;
957         char *name;
958 };
959
960 /*
961  * on OS/X, pthread_cleanup_push() and pthread_cleanup_pop()
962  * are odd macros which start and end a block, so they _must_ be
963  * used in pairs (the latter with a '1' argument to call the
964  * handler on exit.
965  * On BSD we don't need this, but we keep it for compatibility.
966  */
967 static void *dummy_start(void *data)
968 {
969         void *ret;
970         struct thr_arg a = *((struct thr_arg *) data);  /* make a local copy */
971 #ifdef DEBUG_THREADS
972         struct thr_lock_info *lock_info;
973         pthread_mutexattr_t mutex_attr;
974 #endif
975
976         /* note that even though data->name is a pointer to allocated memory,
977            we are not freeing it here because ast_register_thread is going to
978            keep a copy of the pointer and then ast_unregister_thread will
979            free the memory
980         */
981         ast_free(data);
982         ast_register_thread(a.name);
983         pthread_cleanup_push(ast_unregister_thread, (void *) pthread_self());
984
985 #ifdef DEBUG_THREADS
986         if (!(lock_info = ast_threadstorage_get(&thread_lock_info, sizeof(*lock_info))))
987                 return NULL;
988
989         lock_info->thread_id = pthread_self();
990         lock_info->thread_name = strdup(a.name);
991
992         pthread_mutexattr_init(&mutex_attr);
993         pthread_mutexattr_settype(&mutex_attr, AST_MUTEX_KIND);
994         pthread_mutex_init(&lock_info->lock, &mutex_attr);
995         pthread_mutexattr_destroy(&mutex_attr);
996
997         pthread_mutex_lock(&lock_infos_lock.mutex); /* Intentionally not the wrapper */
998         AST_LIST_INSERT_TAIL(&lock_infos, lock_info, entry);
999         pthread_mutex_unlock(&lock_infos_lock.mutex); /* Intentionally not the wrapper */
1000 #endif /* DEBUG_THREADS */
1001
1002         ret = a.start_routine(a.data);
1003
1004         pthread_cleanup_pop(1);
1005
1006         return ret;
1007 }
1008
1009 #endif /* !LOW_MEMORY */
1010
1011 int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
1012                              void *data, size_t stacksize, const char *file, const char *caller,
1013                              int line, const char *start_fn)
1014 {
1015 #if !defined(LOW_MEMORY)
1016         struct thr_arg *a;
1017 #endif
1018
1019         if (!attr) {
1020                 attr = alloca(sizeof(*attr));
1021                 pthread_attr_init(attr);
1022         }
1023
1024 #ifdef __linux__
1025         /* On Linux, pthread_attr_init() defaults to PTHREAD_EXPLICIT_SCHED,
1026            which is kind of useless. Change this here to
1027            PTHREAD_INHERIT_SCHED; that way the -p option to set realtime
1028            priority will propagate down to new threads by default.
1029            This does mean that callers cannot set a different priority using
1030            PTHREAD_EXPLICIT_SCHED in the attr argument; instead they must set
1031            the priority afterwards with pthread_setschedparam(). */
1032         if ((errno = pthread_attr_setinheritsched(attr, PTHREAD_INHERIT_SCHED)))
1033                 ast_log(LOG_WARNING, "pthread_attr_setinheritsched: %s\n", strerror(errno));
1034 #endif
1035
1036         if (!stacksize)
1037                 stacksize = AST_STACKSIZE;
1038
1039         if ((errno = pthread_attr_setstacksize(attr, stacksize ? stacksize : AST_STACKSIZE)))
1040                 ast_log(LOG_WARNING, "pthread_attr_setstacksize: %s\n", strerror(errno));
1041
1042 #if !defined(LOW_MEMORY)
1043         if ((a = ast_malloc(sizeof(*a)))) {
1044                 a->start_routine = start_routine;
1045                 a->data = data;
1046                 start_routine = dummy_start;
1047                 asprintf(&a->name, "%-20s started at [%5d] %s %s()",
1048                          start_fn, line, file, caller);
1049                 data = a;
1050         }
1051 #endif /* !LOW_MEMORY */
1052
1053         return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
1054 }
1055
1056
1057 int ast_pthread_create_detached_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
1058                              void *data, size_t stacksize, const char *file, const char *caller,
1059                              int line, const char *start_fn)
1060 {
1061         unsigned char attr_destroy = 0;
1062         int res;
1063
1064         if (!attr) {
1065                 attr = alloca(sizeof(*attr));
1066                 pthread_attr_init(attr);
1067                 attr_destroy = 1;
1068         }
1069
1070         if ((errno = pthread_attr_setdetachstate(attr, PTHREAD_CREATE_DETACHED)))
1071                 ast_log(LOG_WARNING, "pthread_attr_setdetachstate: %s\n", strerror(errno));
1072
1073         res = ast_pthread_create_stack(thread, attr, start_routine, data, 
1074                                        stacksize, file, caller, line, start_fn);
1075
1076         if (attr_destroy)
1077                 pthread_attr_destroy(attr);
1078
1079         return res;
1080 }
1081
1082 int ast_wait_for_input(int fd, int ms)
1083 {
1084         struct pollfd pfd[1];
1085         memset(pfd, 0, sizeof(pfd));
1086         pfd[0].fd = fd;
1087         pfd[0].events = POLLIN|POLLPRI;
1088         return poll(pfd, 1, ms);
1089 }
1090
1091 /*!
1092  * Try to write string, but wait no more than ms milliseconds before timing out.
1093  *
1094  * \note The code assumes that the file descriptor has NONBLOCK set,
1095  * so there is only one system call made to do a write, unless we actually
1096  * have a need to wait.  This way, we get better performance.
1097  * If the descriptor is blocking, all assumptions on the guaranteed
1098  * detail do not apply anymore.
1099  * Also note that in the current implementation, the delay is per-write,
1100  * so you still have no guarantees, anyways.
1101  * Fortunately the routine is only used in a few places (cli.c, manager.c,
1102  * res_agi.c) so it is reasonably easy to check how it behaves there.
1103  *
1104  * XXX We either need to fix the code, or fix the documentation.
1105  */
1106 int ast_carefulwrite(int fd, char *s, int len, int timeoutms) 
1107 {
1108         /* Try to write string, but wait no more than ms milliseconds
1109            before timing out */
1110         int res = 0;
1111         struct pollfd fds[1];
1112         while (len) {
1113                 res = write(fd, s, len);
1114                 if ((res < 0) && (errno != EAGAIN)) {
1115                         return -1;
1116                 }
1117                 if (res < 0)
1118                         res = 0;
1119                 len -= res;
1120                 s += res;
1121                 res = 0;
1122                 if (len) {
1123                         fds[0].fd = fd;
1124                         fds[0].events = POLLOUT;
1125                         /* Wait until writable again */
1126                         res = poll(fds, 1, timeoutms);
1127                         if (res < 1)
1128                                 return -1;
1129                 }
1130         }
1131         return res;
1132 }
1133
1134 char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes)
1135 {
1136         char *e;
1137         char *q;
1138
1139         s = ast_strip(s);
1140         if ((q = strchr(beg_quotes, *s)) && *q != '\0') {
1141                 e = s + strlen(s) - 1;
1142                 if (*e == *(end_quotes + (q - beg_quotes))) {
1143                         s++;
1144                         *e = '\0';
1145                 }
1146         }
1147
1148         return s;
1149 }
1150
1151 char *ast_unescape_semicolon(char *s)
1152 {
1153         char *e;
1154         char *work = s;
1155
1156         while ((e = strchr(work, ';'))) {
1157                 if ((e > work) && (*(e-1) == '\\')) {
1158                         memmove(e - 1, e, strlen(e) + 1);
1159                         work = e;
1160                 } else {
1161                         work = e + 1;
1162                 }
1163         }
1164
1165         return s;
1166 }
1167
1168 /* !\brief unescape some C sequences in place, return pointer to the original string.
1169  */
1170 char *ast_unescape_c(char *src)
1171 {
1172         char c, *ret, *dst;
1173
1174         if (src == NULL)
1175                 return NULL;
1176         for (ret = dst = src; (c = *src++); *dst++ = c ) {
1177                 if (c != '\\')
1178                         continue;       /* copy char at the end of the loop */
1179                 switch ((c = *src++)) {
1180                 case '\0':      /* special, trailing '\' */
1181                         c = '\\';
1182                         break;
1183                 case 'b':       /* backspace */
1184                         c = '\b';
1185                         break;
1186                 case 'f':       /* form feed */
1187                         c = '\f';
1188                         break;
1189                 case 'n':
1190                         c = '\n';
1191                         break;
1192                 case 'r':
1193                         c = '\r';
1194                         break;
1195                 case 't':
1196                         c = '\t';
1197                         break;
1198                 }
1199                 /* default, use the char literally */
1200         }
1201         *dst = '\0';
1202         return ret;
1203 }
1204
1205 int ast_build_string_va(char **buffer, size_t *space, const char *fmt, va_list ap)
1206 {
1207         int result;
1208
1209         if (!buffer || !*buffer || !space || !*space)
1210                 return -1;
1211
1212         result = vsnprintf(*buffer, *space, fmt, ap);
1213
1214         if (result < 0)
1215                 return -1;
1216         else if (result > *space)
1217                 result = *space;
1218
1219         *buffer += result;
1220         *space -= result;
1221         return 0;
1222 }
1223
1224 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...)
1225 {
1226         va_list ap;
1227         int result;
1228
1229         va_start(ap, fmt);
1230         result = ast_build_string_va(buffer, space, fmt, ap);
1231         va_end(ap);
1232
1233         return result;
1234 }
1235
1236 int ast_true(const char *s)
1237 {
1238         if (ast_strlen_zero(s))
1239                 return 0;
1240
1241         /* Determine if this is a true value */
1242         if (!strcasecmp(s, "yes") ||
1243             !strcasecmp(s, "true") ||
1244             !strcasecmp(s, "y") ||
1245             !strcasecmp(s, "t") ||
1246             !strcasecmp(s, "1") ||
1247             !strcasecmp(s, "on"))
1248                 return -1;
1249
1250         return 0;
1251 }
1252
1253 int ast_false(const char *s)
1254 {
1255         if (ast_strlen_zero(s))
1256                 return 0;
1257
1258         /* Determine if this is a false value */
1259         if (!strcasecmp(s, "no") ||
1260             !strcasecmp(s, "false") ||
1261             !strcasecmp(s, "n") ||
1262             !strcasecmp(s, "f") ||
1263             !strcasecmp(s, "0") ||
1264             !strcasecmp(s, "off"))
1265                 return -1;
1266
1267         return 0;
1268 }
1269
1270 #define ONE_MILLION     1000000
1271 /*
1272  * put timeval in a valid range. usec is 0..999999
1273  * negative values are not allowed and truncated.
1274  */
1275 static struct timeval tvfix(struct timeval a)
1276 {
1277         if (a.tv_usec >= ONE_MILLION) {
1278                 ast_log(LOG_WARNING, "warning too large timestamp %ld.%ld\n",
1279                         (long)a.tv_sec, (long int) a.tv_usec);
1280                 a.tv_sec += a.tv_usec / ONE_MILLION;
1281                 a.tv_usec %= ONE_MILLION;
1282         } else if (a.tv_usec < 0) {
1283                 ast_log(LOG_WARNING, "warning negative timestamp %ld.%ld\n",
1284                         (long)a.tv_sec, (long int) a.tv_usec);
1285                 a.tv_usec = 0;
1286         }
1287         return a;
1288 }
1289
1290 struct timeval ast_tvadd(struct timeval a, struct timeval b)
1291 {
1292         /* consistency checks to guarantee usec in 0..999999 */
1293         a = tvfix(a);
1294         b = tvfix(b);
1295         a.tv_sec += b.tv_sec;
1296         a.tv_usec += b.tv_usec;
1297         if (a.tv_usec >= ONE_MILLION) {
1298                 a.tv_sec++;
1299                 a.tv_usec -= ONE_MILLION;
1300         }
1301         return a;
1302 }
1303
1304 struct timeval ast_tvsub(struct timeval a, struct timeval b)
1305 {
1306         /* consistency checks to guarantee usec in 0..999999 */
1307         a = tvfix(a);
1308         b = tvfix(b);
1309         a.tv_sec -= b.tv_sec;
1310         a.tv_usec -= b.tv_usec;
1311         if (a.tv_usec < 0) {
1312                 a.tv_sec-- ;
1313                 a.tv_usec += ONE_MILLION;
1314         }
1315         return a;
1316 }
1317 #undef ONE_MILLION
1318
1319 /*! \brief glibc puts a lock inside random(3), so that the results are thread-safe.
1320  * BSD libc (and others) do not. */
1321
1322 #ifndef linux
1323 AST_MUTEX_DEFINE_STATIC(randomlock);
1324 #endif
1325
1326 long int ast_random(void)
1327 {
1328         long int res;
1329 #ifdef HAVE_DEV_URANDOM
1330         if (dev_urandom_fd >= 0) {
1331                 int read_res = read(dev_urandom_fd, &res, sizeof(res));
1332                 if (read_res > 0) {
1333                         long int rm = RAND_MAX;
1334                         res = res < 0 ? ~res : res;
1335                         rm++;
1336                         return res % rm;
1337                 }
1338         }
1339 #endif
1340 #ifdef linux
1341         res = random();
1342 #else
1343         ast_mutex_lock(&randomlock);
1344         res = random();
1345         ast_mutex_unlock(&randomlock);
1346 #endif
1347         return res;
1348 }
1349
1350 char *ast_process_quotes_and_slashes(char *start, char find, char replace_with)
1351 {
1352         char *dataPut = start;
1353         int inEscape = 0;
1354         int inQuotes = 0;
1355
1356         for (; *start; start++) {
1357                 if (inEscape) {
1358                         *dataPut++ = *start;       /* Always goes verbatim */
1359                         inEscape = 0;
1360                 } else {
1361                         if (*start == '\\') {
1362                                 inEscape = 1;      /* Do not copy \ into the data */
1363                         } else if (*start == '\'') {
1364                                 inQuotes = 1 - inQuotes;   /* Do not copy ' into the data */
1365                         } else {
1366                                 /* Replace , with |, unless in quotes */
1367                                 *dataPut++ = inQuotes ? *start : ((*start == find) ? replace_with : *start);
1368                         }
1369                 }
1370         }
1371         if (start != dataPut)
1372                 *dataPut = 0;
1373         return dataPut;
1374 }
1375
1376 void ast_join(char *s, size_t len, char * const w[])
1377 {
1378         int x, ofs = 0;
1379         const char *src;
1380
1381         /* Join words into a string */
1382         if (!s)
1383                 return;
1384         for (x = 0; ofs < len && w[x]; x++) {
1385                 if (x > 0)
1386                         s[ofs++] = ' ';
1387                 for (src = w[x]; *src && ofs < len; src++)
1388                         s[ofs++] = *src;
1389         }
1390         if (ofs == len)
1391                 ofs--;
1392         s[ofs] = '\0';
1393 }
1394
1395 /*
1396  * stringfields support routines.
1397  */
1398
1399 const char __ast_string_field_empty[] = ""; /*!< the empty string */
1400
1401 /*! \brief add a new block to the pool.
1402  * We can only allocate from the topmost pool, so the
1403  * fields in *mgr reflect the size of that only.
1404  */
1405 static int add_string_pool(struct ast_string_field_mgr *mgr,
1406         struct ast_string_field_pool **pool_head, size_t size)
1407 {
1408         struct ast_string_field_pool *pool;
1409
1410         if (!(pool = ast_calloc(1, sizeof(*pool) + size)))
1411                 return -1;
1412         
1413         pool->prev = *pool_head;
1414         *pool_head = pool;
1415         mgr->size = size;
1416         mgr->used = 0;
1417
1418         return 0;
1419 }
1420
1421 /*
1422  * This is an internal API, code should not use it directly.
1423  * It initializes all fields as empty, then uses 'size' for 3 functions:
1424  * size > 0 means initialize the pool list with a pool of given size.
1425  *      This must be called right after allocating the object.
1426  * size = 0 means release all pools except the most recent one.
1427  *      This is useful to e.g. reset an object to the initial value.
1428  * size < 0 means release all pools.
1429  *      This must be done before destroying the object.
1430  */
1431 int __ast_string_field_init(struct ast_string_field_mgr *mgr,
1432         struct ast_string_field_pool **pool_head, int size)
1433 {
1434         const char **p = (const char **)pool_head + 1;
1435         struct ast_string_field_pool *cur = *pool_head;
1436
1437         /* clear fields - this is always necessary */
1438         while ((struct ast_string_field_mgr *)p != mgr)
1439                 *p++ = __ast_string_field_empty;
1440         if (size > 0) {                 /* allocate the initial pool */
1441                 *pool_head = NULL;
1442                 return add_string_pool(mgr, pool_head, size);
1443         }
1444         if (size < 0) {                 /* reset all pools */
1445                 *pool_head = NULL;
1446         } else {                        /* preserve the first pool */
1447                 if (cur == NULL) {
1448                         ast_log(LOG_WARNING, "trying to reset empty pool\n");
1449                         return -1;
1450                 }
1451                 cur = cur->prev;
1452                 (*pool_head)->prev = NULL;
1453                 mgr->used = 0;
1454         }
1455         while (cur) {
1456                 struct ast_string_field_pool *prev = cur->prev;
1457                 ast_free(cur);
1458                 cur = prev;
1459         }
1460         return 0;
1461 }
1462
1463 ast_string_field __ast_string_field_alloc_space(struct ast_string_field_mgr *mgr,
1464         struct ast_string_field_pool **pool_head, size_t needed)
1465 {
1466         char *result = NULL;
1467         size_t space = mgr->size - mgr->used;
1468
1469         if (__builtin_expect(needed > space, 0)) {
1470                 size_t new_size = mgr->size * 2;
1471
1472                 while (new_size < needed)
1473                         new_size *= 2;
1474
1475                 if (add_string_pool(mgr, pool_head, new_size))
1476                         return NULL;
1477         }
1478
1479         result = (*pool_head)->base + mgr->used;
1480         mgr->used += needed;
1481         return result;
1482 }
1483
1484 __attribute((format (printf, 4, 0)))
1485 void __ast_string_field_ptr_build_va(struct ast_string_field_mgr *mgr,
1486         struct ast_string_field_pool **pool_head,
1487         const ast_string_field *ptr, const char *format, va_list ap1, va_list ap2)
1488 {
1489         size_t needed;
1490         char *dst = (*pool_head)->base + mgr->used;
1491         const char **p = (const char **)ptr;
1492         size_t space = mgr->size - mgr->used;
1493
1494         /* try to write using available space */
1495         needed = vsnprintf(dst, space, format, ap1) + 1;
1496
1497         va_end(ap1);
1498
1499         if (needed > space) {   /* if it fails, reallocate */
1500                 size_t new_size = mgr->size * 2;
1501
1502                 while (new_size < needed)
1503                         new_size *= 2;
1504
1505                 if (add_string_pool(mgr, pool_head, new_size))
1506                         return;
1507
1508                 dst = (*pool_head)->base + mgr->used;
1509                 vsprintf(dst, format, ap2);
1510         }
1511
1512         *p = dst;
1513         mgr->used += needed;
1514 }
1515
1516 __attribute((format (printf, 4, 5)))
1517 void __ast_string_field_ptr_build(struct ast_string_field_mgr *mgr,
1518         struct ast_string_field_pool **pool_head,
1519         const ast_string_field *ptr, const char *format, ...)
1520 {
1521         va_list ap1, ap2;
1522
1523         va_start(ap1, format);
1524         va_start(ap2, format);          /* va_copy does not exist on FreeBSD */
1525
1526         __ast_string_field_ptr_build_va(mgr, pool_head, ptr, format, ap1, ap2);
1527
1528         va_end(ap1);
1529         va_end(ap2);
1530 }
1531 /* end of stringfields support */
1532
1533 AST_MUTEX_DEFINE_STATIC(fetchadd_m); /* used for all fetc&add ops */
1534
1535 int ast_atomic_fetchadd_int_slow(volatile int *p, int v)
1536 {
1537         int ret;
1538         ast_mutex_lock(&fetchadd_m);
1539         ret = *p;
1540         *p += v;
1541         ast_mutex_unlock(&fetchadd_m);
1542         return ret;
1543 }
1544
1545 /*! \brief
1546  * get values from config variables.
1547  */
1548 int ast_get_timeval(const char *src, struct timeval *dst, struct timeval _default, int *consumed)
1549 {
1550         long double dtv = 0.0;
1551         int scanned;
1552
1553         if (dst == NULL)
1554                 return -1;
1555
1556         *dst = _default;
1557
1558         if (ast_strlen_zero(src))
1559                 return -1;
1560
1561         /* only integer at the moment, but one day we could accept more formats */
1562         if (sscanf(src, "%Lf%n", &dtv, &scanned) > 0) {
1563                 dst->tv_sec = dtv;
1564                 dst->tv_usec = (dtv - dst->tv_sec) * 1000000.0;
1565                 if (consumed)
1566                         *consumed = scanned;
1567                 return 0;
1568         } else
1569                 return -1;
1570 }
1571
1572 /*! \brief
1573  * get values from config variables.
1574  */
1575 int ast_get_time_t(const char *src, time_t *dst, time_t _default, int *consumed)
1576 {
1577         long t;
1578         int scanned;
1579
1580         if (dst == NULL)
1581                 return -1;
1582
1583         *dst = _default;
1584
1585         if (ast_strlen_zero(src))
1586                 return -1;
1587
1588         /* only integer at the moment, but one day we could accept more formats */
1589         if (sscanf(src, "%ld%n", &t, &scanned) == 1) {
1590                 *dst = t;
1591                 if (consumed)
1592                         *consumed = scanned;
1593                 return 0;
1594         } else
1595                 return -1;
1596 }
1597
1598 /*!
1599  * core handler for dynamic strings.
1600  * This is not meant to be called directly, but rather through the
1601  * various wrapper macros
1602  *      ast_str_set(...)
1603  *      ast_str_append(...)
1604  *      ast_str_set_va(...)
1605  *      ast_str_append_va(...)
1606  */
1607
1608 __attribute__((format (printf, 4, 0)))
1609 int __ast_str_helper(struct ast_str **buf, size_t max_len,
1610         int append, const char *fmt, va_list ap)
1611 {
1612         int res, need;
1613         int offset = (append && (*buf)->len) ? (*buf)->used : 0;
1614
1615         if (max_len < 0)
1616                 max_len = (*buf)->len;  /* don't exceed the allocated space */
1617         /*
1618          * Ask vsnprintf how much space we need. Remember that vsnprintf
1619          * does not count the final '\0' so we must add 1.
1620          */
1621         res = vsnprintf((*buf)->str + offset, (*buf)->len - offset, fmt, ap);
1622
1623         need = res + offset + 1;
1624         /*
1625          * If there is not enough space and we are below the max length,
1626          * reallocate the buffer and return a message telling to retry.
1627          */
1628         if (need > (*buf)->len && (max_len == 0 || (*buf)->len < max_len) ) {
1629                 if (max_len && max_len < need)  /* truncate as needed */
1630                         need = max_len;
1631                 else if (max_len == 0)  /* if unbounded, give more room for next time */
1632                         need += 16 + need/4;
1633                 if (0)  /* debugging */
1634                         ast_verbose("extend from %d to %d\n", (int)(*buf)->len, need);
1635                 if (ast_str_make_space(buf, need)) {
1636                         ast_verbose("failed to extend from %d to %d\n", (int)(*buf)->len, need);
1637                         return AST_DYNSTR_BUILD_FAILED;
1638                 }
1639                 (*buf)->str[offset] = '\0';     /* Truncate the partial write. */
1640
1641                 /* va_end() and va_start() must be done before calling
1642                  * vsnprintf() again. */
1643                 return AST_DYNSTR_BUILD_RETRY;
1644         }
1645         /* update space used, keep in mind the truncation */
1646         (*buf)->used = (res + offset > (*buf)->len) ? (*buf)->len : res + offset;
1647
1648         return res;
1649 }
1650
1651 void ast_enable_packet_fragmentation(int sock)
1652 {
1653 #if defined(HAVE_IP_MTU_DISCOVER)
1654         int val = IP_PMTUDISC_DONT;
1655         
1656         if (setsockopt(sock, IPPROTO_IP, IP_MTU_DISCOVER, &val, sizeof(val)))
1657                 ast_log(LOG_WARNING, "Unable to disable PMTU discovery. Large UDP packets may fail to be delivered when sent from this socket.\n");
1658 #endif /* HAVE_IP_MTU_DISCOVER */
1659 }
1660
1661 int ast_mkdir(const char *path, int mode)
1662 {
1663         char *ptr;
1664         int len = strlen(path), count = 0, x, piececount = 0;
1665         char *tmp = ast_strdupa(path);
1666         char **pieces;
1667         char *fullpath = alloca(len + 1);
1668         int res = 0;
1669
1670         for (ptr = tmp; *ptr; ptr++) {
1671                 if (*ptr == '/')
1672                         count++;
1673         }
1674
1675         /* Count the components to the directory path */
1676         pieces = alloca(count * sizeof(*pieces));
1677         for (ptr = tmp; *ptr; ptr++) {
1678                 if (*ptr == '/') {
1679                         *ptr = '\0';
1680                         pieces[piececount++] = ptr + 1;
1681                 }
1682         }
1683
1684         *fullpath = '\0';
1685         for (x = 0; x < piececount; x++) {
1686                 /* This looks funky, but the buffer is always ideally-sized, so it's fine. */
1687                 strcat(fullpath, "/");
1688                 strcat(fullpath, pieces[x]);
1689                 res = mkdir(fullpath, mode);
1690                 if (res && errno != EEXIST)
1691                         return errno;
1692         }
1693         return 0;
1694 }
1695
1696 int ast_utils_init(void)
1697 {
1698 #ifdef HAVE_DEV_URANDOM
1699         dev_urandom_fd = open("/dev/urandom", O_RDONLY);
1700 #endif
1701         base64_init();
1702 #ifdef DEBUG_THREADS
1703 #if !defined(LOW_MEMORY)
1704         ast_cli_register_multiple(utils_cli, sizeof(utils_cli) / sizeof(utils_cli[0]));
1705 #endif
1706 #endif
1707         return 0;
1708 }
1709
1710 #ifndef __AST_DEBUG_MALLOC
1711 int _ast_asprintf(char **ret, const char *file, int lineno, const char *func, const char *fmt, ...)
1712 {
1713         int res;
1714         va_list ap;
1715
1716         va_start(ap, fmt);
1717         if ((res = vasprintf(ret, fmt, ap)) == -1) {
1718                 MALLOC_FAILURE_MSG;
1719         }
1720         va_end(ap);
1721
1722         return res;
1723 }
1724 #endif