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