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