Merged revisions 46561 via svnmerge from
[asterisk/asterisk.git] / main / utils.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \brief Utility functions
20  *
21  * \note These are important for portability and security,
22  * so please use them in favour of other routines.
23  * Please consult the CODING GUIDELINES for more information.
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <ctype.h>
31 #include <string.h>
32 #include <unistd.h>
33 #include <stdlib.h>
34 #include <errno.h>
35 #include <stdarg.h>
36 #include <stdio.h>
37 #include <sys/types.h>
38 #include <sys/socket.h>
39 #include <netinet/in.h>
40 #include <arpa/inet.h>
41
42 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in lock.h if required */
43 #include "asterisk/lock.h"
44 #include "asterisk/io.h"
45 #include "asterisk/logger.h"
46 #include "asterisk/md5.h"
47 #include "asterisk/sha1.h"
48 #include "asterisk/options.h"
49
50 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
51 #include "asterisk/strings.h"
52
53 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
54 #include "asterisk/time.h"
55
56 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
57 #include "asterisk/stringfields.h"
58
59 #define AST_API_MODULE          /* ensure that inlinable API functions will be built in this module if required */
60 #include "asterisk/utils.h"
61
62 #define AST_API_MODULE
63 #include "asterisk/threadstorage.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)
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 SOLARIS
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
230
231 AST_MUTEX_DEFINE_STATIC(test_lock);
232 AST_MUTEX_DEFINE_STATIC(test_lock2);
233 static pthread_t test_thread; 
234 static int lock_count = 0;
235 static int test_errors = 0;
236
237 /*! \brief This is a regression test for recursive mutexes.
238    test_for_thread_safety() will return 0 if recursive mutex locks are
239    working properly, and non-zero if they are not working properly. */
240 static void *test_thread_body(void *data) 
241
242         ast_mutex_lock(&test_lock);
243         lock_count += 10;
244         if (lock_count != 10) 
245                 test_errors++;
246         ast_mutex_lock(&test_lock);
247         lock_count += 10;
248         if (lock_count != 20) 
249                 test_errors++;
250         ast_mutex_lock(&test_lock2);
251         ast_mutex_unlock(&test_lock);
252         lock_count -= 10;
253         if (lock_count != 10) 
254                 test_errors++;
255         ast_mutex_unlock(&test_lock);
256         lock_count -= 10;
257         ast_mutex_unlock(&test_lock2);
258         if (lock_count != 0) 
259                 test_errors++;
260         return NULL;
261
262
263 int test_for_thread_safety(void)
264
265         ast_mutex_lock(&test_lock2);
266         ast_mutex_lock(&test_lock);
267         lock_count += 1;
268         ast_mutex_lock(&test_lock);
269         lock_count += 1;
270         ast_pthread_create(&test_thread, NULL, test_thread_body, NULL); 
271         usleep(100);
272         if (lock_count != 2) 
273                 test_errors++;
274         ast_mutex_unlock(&test_lock);
275         lock_count -= 1;
276         usleep(100); 
277         if (lock_count != 1) 
278                 test_errors++;
279         ast_mutex_unlock(&test_lock);
280         lock_count -= 1;
281         if (lock_count != 0) 
282                 test_errors++;
283         ast_mutex_unlock(&test_lock2);
284         usleep(100);
285         if (lock_count != 0) 
286                 test_errors++;
287         pthread_join(test_thread, NULL);
288         return(test_errors);          /* return 0 on success. */
289 }
290
291 /*! \brief Produce 32 char MD5 hash of value. */
292 void ast_md5_hash(char *output, char *input)
293 {
294         struct MD5Context md5;
295         unsigned char digest[16];
296         char *ptr;
297         int x;
298
299         MD5Init(&md5);
300         MD5Update(&md5, (unsigned char *)input, strlen(input));
301         MD5Final(digest, &md5);
302         ptr = output;
303         for (x = 0; x < 16; x++)
304                 ptr += sprintf(ptr, "%2.2x", digest[x]);
305 }
306
307 /*! \brief Produce 40 char SHA1 hash of value. */
308 void ast_sha1_hash(char *output, char *input)
309 {
310         struct SHA1Context sha;
311         char *ptr;
312         int x;
313         uint8_t Message_Digest[20];
314
315         SHA1Reset(&sha);
316         
317         SHA1Input(&sha, (const unsigned char *) input, strlen(input));
318
319         SHA1Result(&sha, Message_Digest);
320         ptr = output;
321         for (x = 0; x < 20; x++)
322                 ptr += sprintf(ptr, "%2.2x", Message_Digest[x]);
323 }
324
325 /*! \brief decode BASE64 encoded text */
326 int ast_base64decode(unsigned char *dst, const char *src, int max)
327 {
328         int cnt = 0;
329         unsigned int byte = 0;
330         unsigned int bits = 0;
331         int incnt = 0;
332         while(*src && (cnt < max)) {
333                 /* Shift in 6 bits of input */
334                 byte <<= 6;
335                 byte |= (b2a[(int)(*src)]) & 0x3f;
336                 bits += 6;
337                 src++;
338                 incnt++;
339                 /* If we have at least 8 bits left over, take that character 
340                    off the top */
341                 if (bits >= 8)  {
342                         bits -= 8;
343                         *dst = (byte >> bits) & 0xff;
344                         dst++;
345                         cnt++;
346                 }
347         }
348         /* Dont worry about left over bits, they're extra anyway */
349         return cnt;
350 }
351
352 /*! \brief encode text to BASE64 coding */
353 int ast_base64encode_full(char *dst, const unsigned char *src, int srclen, int max, int linebreaks)
354 {
355         int cnt = 0;
356         int col = 0;
357         unsigned int byte = 0;
358         int bits = 0;
359         int cntin = 0;
360         /* Reserve space for null byte at end of string */
361         max--;
362         while ((cntin < srclen) && (cnt < max)) {
363                 byte <<= 8;
364                 byte |= *(src++);
365                 bits += 8;
366                 cntin++;
367                 if ((bits == 24) && (cnt + 4 <= max)) {
368                         *dst++ = base64[(byte >> 18) & 0x3f];
369                         *dst++ = base64[(byte >> 12) & 0x3f];
370                         *dst++ = base64[(byte >> 6) & 0x3f];
371                         *dst++ = base64[byte & 0x3f];
372                         cnt += 4;
373                         col += 4;
374                         bits = 0;
375                         byte = 0;
376                 }
377                 if (linebreaks && (cnt < max) && (col == 64)) {
378                         *dst++ = '\n';
379                         cnt++;
380                         col = 0;
381                 }
382         }
383         if (bits && (cnt + 4 <= max)) {
384                 /* Add one last character for the remaining bits, 
385                    padding the rest with 0 */
386                 byte <<= 24 - bits;
387                 *dst++ = base64[(byte >> 18) & 0x3f];
388                 *dst++ = base64[(byte >> 12) & 0x3f];
389                 if (bits == 16)
390                         *dst++ = base64[(byte >> 6) & 0x3f];
391                 else
392                         *dst++ = '=';
393                 *dst++ = '=';
394                 cnt += 4;
395         }
396         if (linebreaks && (cnt < max)) {
397                 *dst++ = '\n';
398                 cnt++;
399         }
400         *dst = '\0';
401         return cnt;
402 }
403
404 int ast_base64encode(char *dst, const unsigned char *src, int srclen, int max)
405 {
406         return ast_base64encode_full(dst, src, srclen, max, 0);
407 }
408
409 static void base64_init(void)
410 {
411         int x;
412         memset(b2a, -1, sizeof(b2a));
413         /* Initialize base-64 Conversion table */
414         for (x = 0; x < 26; x++) {
415                 /* A-Z */
416                 base64[x] = 'A' + x;
417                 b2a['A' + x] = x;
418                 /* a-z */
419                 base64[x + 26] = 'a' + x;
420                 b2a['a' + x] = x + 26;
421                 /* 0-9 */
422                 if (x < 10) {
423                         base64[x + 52] = '0' + x;
424                         b2a['0' + x] = x + 52;
425                 }
426         }
427         base64[62] = '+';
428         base64[63] = '/';
429         b2a[(int)'+'] = 62;
430         b2a[(int)'/'] = 63;
431 }
432
433 /*! \brief  ast_uri_encode: Turn text string to URI-encoded %XX version
434 \note   At this point, we're converting from ISO-8859-x (8-bit), not UTF8
435         as in the SIP protocol spec 
436         If doreserved == 1 we will convert reserved characters also.
437         RFC 2396, section 2.4
438         outbuf needs to have more memory allocated than the instring
439         to have room for the expansion. Every char that is converted
440         is replaced by three ASCII characters.
441
442         Note: The doreserved option is needed for replaces header in
443         SIP transfers.
444 */
445 char *ast_uri_encode(const char *string, char *outbuf, int buflen, int doreserved) 
446 {
447         char *reserved = ";/?:@&=+$, "; /* Reserved chars */
448
449         const char *ptr  = string;      /* Start with the string */
450         char *out = NULL;
451         char *buf = NULL;
452
453         ast_copy_string(outbuf, string, buflen);
454
455         /* If there's no characters to convert, just go through and don't do anything */
456         while (*ptr) {
457                 if (((unsigned char) *ptr) > 127 || (doreserved && strchr(reserved, *ptr)) ) {
458                         /* Oops, we need to start working here */
459                         if (!buf) {
460                                 buf = outbuf;
461                                 out = buf + (ptr - string) ;    /* Set output ptr */
462                         }
463                         out += sprintf(out, "%%%02x", (unsigned char) *ptr);
464                 } else if (buf) {
465                         *out = *ptr;    /* Continue copying the string */
466                         out++;
467                 } 
468                 ptr++;
469         }
470         if (buf)
471                 *out = '\0';
472         return outbuf;
473 }
474
475 /*! \brief  ast_uri_decode: Decode SIP URI, URN, URL (overwrite the string)  */
476 void ast_uri_decode(char *s) 
477 {
478         char *o;
479         unsigned int tmp;
480
481         for (o = s; *s; s++, o++) {
482                 if (*s == '%' && strlen(s) > 2 && sscanf(s + 1, "%2x", &tmp) == 1) {
483                         /* have '%', two chars and correct parsing */
484                         *o = tmp;
485                         s += 2; /* Will be incremented once more when we break out */
486                 } else /* all other cases, just copy */
487                         *o = *s;
488         }
489         *o = '\0';
490 }
491
492 /*! \brief  ast_inet_ntoa: Recursive thread safe replacement of inet_ntoa */
493 const char *ast_inet_ntoa(struct in_addr ia)
494 {
495         char *buf;
496
497         if (!(buf = ast_threadstorage_get(&inet_ntoa_buf, INET_ADDRSTRLEN)))
498                 return "";
499
500         return inet_ntop(AF_INET, &ia, buf, INET_ADDRSTRLEN);
501 }
502
503 int ast_utils_init(void)
504 {
505         base64_init();
506         return 0;
507 }
508
509 #ifndef __linux__
510 #undef pthread_create /* For ast_pthread_create function only */
511 #endif /* !__linux__ */
512
513 #if !defined(LOW_MEMORY)
514 /*
515  * support for 'show threads'. The start routine is wrapped by
516  * dummy_start(), so that ast_register_thread() and
517  * ast_unregister_thread() know the thread identifier.
518  */
519 struct thr_arg {
520         void *(*start_routine)(void *);
521         void *data;
522         char *name;
523 };
524
525 /*
526  * on OS/X, pthread_cleanup_push() and pthread_cleanup_pop()
527  * are odd macros which start and end a block, so they _must_ be
528  * used in pairs (the latter with a '1' argument to call the
529  * handler on exit.
530  * On BSD we don't need this, but we keep it for compatibility.
531  */
532 static void *dummy_start(void *data)
533 {
534         void *ret;
535         struct thr_arg a = *((struct thr_arg *) data);  /* make a local copy */
536
537         /* note that even though data->name is a pointer to allocated memory,
538            we are not freeing it here because ast_register_thread is going to
539            keep a copy of the pointer and then ast_unregister_thread will
540            free the memory
541         */
542         free(data);
543         ast_register_thread(a.name);
544         pthread_cleanup_push(ast_unregister_thread, (void *) pthread_self());
545         ret = a.start_routine(a.data);
546         pthread_cleanup_pop(1);
547
548         return ret;
549 }
550
551 #endif /* !LOW_MEMORY */
552
553 int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *),
554                              void *data, size_t stacksize, const char *file, const char *caller,
555                              int line, const char *start_fn)
556 {
557 #if !defined(LOW_MEMORY)
558         struct thr_arg *a;
559 #endif
560
561         if (!attr) {
562                 attr = alloca(sizeof(*attr));
563                 pthread_attr_init(attr);
564         }
565
566 #ifdef __linux__
567         /* On Linux, pthread_attr_init() defaults to PTHREAD_EXPLICIT_SCHED,
568            which is kind of useless. Change this here to
569            PTHREAD_INHERIT_SCHED; that way the -p option to set realtime
570            priority will propagate down to new threads by default.
571            This does mean that callers cannot set a different priority using
572            PTHREAD_EXPLICIT_SCHED in the attr argument; instead they must set
573            the priority afterwards with pthread_setschedparam(). */
574         if ((errno = pthread_attr_setinheritsched(attr, PTHREAD_INHERIT_SCHED)))
575                 ast_log(LOG_WARNING, "pthread_attr_setinheritsched: %s\n", strerror(errno));
576 #endif
577
578         if (!stacksize)
579                 stacksize = AST_STACKSIZE;
580
581         if ((errno = pthread_attr_setstacksize(attr, stacksize ? stacksize : AST_STACKSIZE)))
582                 ast_log(LOG_WARNING, "pthread_attr_setstacksize: %s\n", strerror(errno));
583
584 #if !defined(LOW_MEMORY)
585         if ((a = ast_malloc(sizeof(*a)))) {
586                 a->start_routine = start_routine;
587                 a->data = data;
588                 start_routine = dummy_start;
589                 asprintf(&a->name, "%-20s started at [%5d] %s %s()",
590                          start_fn, line, file, caller);
591                 data = a;
592         }
593 #endif /* !LOW_MEMORY */
594
595         return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
596 }
597
598 int ast_wait_for_input(int fd, int ms)
599 {
600         struct pollfd pfd[1];
601         memset(pfd, 0, sizeof(pfd));
602         pfd[0].fd = fd;
603         pfd[0].events = POLLIN|POLLPRI;
604         return poll(pfd, 1, ms);
605 }
606
607 int ast_carefulwrite(int fd, char *s, int len, int timeoutms) 
608 {
609         /* Try to write string, but wait no more than ms milliseconds
610            before timing out */
611         int res = 0;
612         struct pollfd fds[1];
613         while (len) {
614                 res = write(fd, s, len);
615                 if ((res < 0) && (errno != EAGAIN)) {
616                         return -1;
617                 }
618                 if (res < 0)
619                         res = 0;
620                 len -= res;
621                 s += res;
622                 res = 0;
623                 if (len) {
624                         fds[0].fd = fd;
625                         fds[0].events = POLLOUT;
626                         /* Wait until writable again */
627                         res = poll(fds, 1, timeoutms);
628                         if (res < 1)
629                                 return -1;
630                 }
631         }
632         return res;
633 }
634
635 char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes)
636 {
637         char *e;
638         char *q;
639
640         s = ast_strip(s);
641         if ((q = strchr(beg_quotes, *s))) {
642                 e = s + strlen(s) - 1;
643                 if (*e == *(end_quotes + (q - beg_quotes))) {
644                         s++;
645                         *e = '\0';
646                 }
647         }
648
649         return s;
650 }
651
652 int ast_build_string_va(char **buffer, size_t *space, const char *fmt, va_list ap)
653 {
654         int result;
655
656         if (!buffer || !*buffer || !space || !*space)
657                 return -1;
658
659         result = vsnprintf(*buffer, *space, fmt, ap);
660
661         if (result < 0)
662                 return -1;
663         else if (result > *space)
664                 result = *space;
665
666         *buffer += result;
667         *space -= result;
668         return 0;
669 }
670
671 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...)
672 {
673         va_list ap;
674         int result;
675
676         va_start(ap, fmt);
677         result = ast_build_string_va(buffer, space, fmt, ap);
678         va_end(ap);
679
680         return result;
681 }
682
683 int ast_true(const char *s)
684 {
685         if (ast_strlen_zero(s))
686                 return 0;
687
688         /* Determine if this is a true value */
689         if (!strcasecmp(s, "yes") ||
690             !strcasecmp(s, "true") ||
691             !strcasecmp(s, "y") ||
692             !strcasecmp(s, "t") ||
693             !strcasecmp(s, "1") ||
694             !strcasecmp(s, "on"))
695                 return -1;
696
697         return 0;
698 }
699
700 int ast_false(const char *s)
701 {
702         if (ast_strlen_zero(s))
703                 return 0;
704
705         /* Determine if this is a false value */
706         if (!strcasecmp(s, "no") ||
707             !strcasecmp(s, "false") ||
708             !strcasecmp(s, "n") ||
709             !strcasecmp(s, "f") ||
710             !strcasecmp(s, "0") ||
711             !strcasecmp(s, "off"))
712                 return -1;
713
714         return 0;
715 }
716
717 #define ONE_MILLION     1000000
718 /*
719  * put timeval in a valid range. usec is 0..999999
720  * negative values are not allowed and truncated.
721  */
722 static struct timeval tvfix(struct timeval a)
723 {
724         if (a.tv_usec >= ONE_MILLION) {
725                 ast_log(LOG_WARNING, "warning too large timestamp %ld.%ld\n",
726                         a.tv_sec, (long int) a.tv_usec);
727                 a.tv_sec += a.tv_usec / ONE_MILLION;
728                 a.tv_usec %= ONE_MILLION;
729         } else if (a.tv_usec < 0) {
730                 ast_log(LOG_WARNING, "warning negative timestamp %ld.%ld\n",
731                         a.tv_sec, (long int) a.tv_usec);
732                 a.tv_usec = 0;
733         }
734         return a;
735 }
736
737 struct timeval ast_tvadd(struct timeval a, struct timeval b)
738 {
739         /* consistency checks to guarantee usec in 0..999999 */
740         a = tvfix(a);
741         b = tvfix(b);
742         a.tv_sec += b.tv_sec;
743         a.tv_usec += b.tv_usec;
744         if (a.tv_usec >= ONE_MILLION) {
745                 a.tv_sec++;
746                 a.tv_usec -= ONE_MILLION;
747         }
748         return a;
749 }
750
751 struct timeval ast_tvsub(struct timeval a, struct timeval b)
752 {
753         /* consistency checks to guarantee usec in 0..999999 */
754         a = tvfix(a);
755         b = tvfix(b);
756         a.tv_sec -= b.tv_sec;
757         a.tv_usec -= b.tv_usec;
758         if (a.tv_usec < 0) {
759                 a.tv_sec-- ;
760                 a.tv_usec += ONE_MILLION;
761         }
762         return a;
763 }
764 #undef ONE_MILLION
765
766 /*! \brief glibc puts a lock inside random(3), so that the results are thread-safe.
767  * BSD libc (and others) do not. */
768 #ifndef linux
769
770 AST_MUTEX_DEFINE_STATIC(randomlock);
771
772 long int ast_random(void)
773 {
774         long int res;
775         ast_mutex_lock(&randomlock);
776         res = random();
777         ast_mutex_unlock(&randomlock);
778         return res;
779 }
780 #endif
781
782 char *ast_process_quotes_and_slashes(char *start, char find, char replace_with)
783 {
784         char *dataPut = start;
785         int inEscape = 0;
786         int inQuotes = 0;
787
788         for (; *start; start++) {
789                 if (inEscape) {
790                         *dataPut++ = *start;       /* Always goes verbatim */
791                         inEscape = 0;
792                 } else {
793                         if (*start == '\\') {
794                                 inEscape = 1;      /* Do not copy \ into the data */
795                         } else if (*start == '\'') {
796                                 inQuotes = 1 - inQuotes;   /* Do not copy ' into the data */
797                         } else {
798                                 /* Replace , with |, unless in quotes */
799                                 *dataPut++ = inQuotes ? *start : ((*start == find) ? replace_with : *start);
800                         }
801                 }
802         }
803         if (start != dataPut)
804                 *dataPut = 0;
805         return dataPut;
806 }
807
808 void ast_join(char *s, size_t len, char * const w[])
809 {
810         int x, ofs = 0;
811         const char *src;
812
813         /* Join words into a string */
814         if (!s)
815                 return;
816         for (x = 0; ofs < len && w[x]; x++) {
817                 if (x > 0)
818                         s[ofs++] = ' ';
819                 for (src = w[x]; *src && ofs < len; src++)
820                         s[ofs++] = *src;
821         }
822         if (ofs == len)
823                 ofs--;
824         s[ofs] = '\0';
825 }
826
827 const char __ast_string_field_empty[] = "";
828
829 static int add_string_pool(struct ast_string_field_mgr *mgr, size_t size)
830 {
831         struct ast_string_field_pool *pool;
832
833         if (!(pool = ast_calloc(1, sizeof(*pool) + size)))
834                 return -1;
835         
836         pool->prev = mgr->pool;
837         mgr->pool = pool;
838         mgr->size = size;
839         mgr->space = size;
840         mgr->used = 0;
841
842         return 0;
843 }
844
845 int __ast_string_field_init(struct ast_string_field_mgr *mgr, size_t size,
846                             ast_string_field *fields, int num_fields)
847 {
848         int index;
849
850         if (add_string_pool(mgr, size))
851                 return -1;
852
853         for (index = 0; index < num_fields; index++)
854                 fields[index] = __ast_string_field_empty;
855
856         return 0;
857 }
858
859 ast_string_field __ast_string_field_alloc_space(struct ast_string_field_mgr *mgr, size_t needed,
860                                                 ast_string_field *fields, int num_fields)
861 {
862         char *result = NULL;
863
864         if (__builtin_expect(needed > mgr->space, 0)) {
865                 size_t new_size = mgr->size * 2;
866
867                 while (new_size < needed)
868                         new_size *= 2;
869
870                 if (add_string_pool(mgr, new_size))
871                         return NULL;
872         }
873
874         result = mgr->pool->base + mgr->used;
875         mgr->used += needed;
876         mgr->space -= needed;
877         return result;
878 }
879
880 void __ast_string_field_index_build(struct ast_string_field_mgr *mgr,
881                                     ast_string_field *fields, int num_fields,
882                                     int index, const char *format, ...)
883 {
884         size_t needed;
885         va_list ap1, ap2;
886
887         va_start(ap1, format);
888         va_start(ap2, format);          /* va_copy does not exist on FreeBSD */
889
890         needed = vsnprintf(mgr->pool->base + mgr->used, mgr->space, format, ap1) + 1;
891
892         va_end(ap1);
893
894         if (needed > mgr->space) {
895                 size_t new_size = mgr->size * 2;
896
897                 while (new_size < needed)
898                         new_size *= 2;
899
900                 if (add_string_pool(mgr, new_size))
901                         return;
902
903                 vsprintf(mgr->pool->base + mgr->used, format, ap2);
904         }
905
906         fields[index] = mgr->pool->base + mgr->used;
907         mgr->used += needed;
908         mgr->space -= needed;
909
910         va_end(ap2);
911 }
912
913 AST_MUTEX_DEFINE_STATIC(fetchadd_m); /* used for all fetc&add ops */
914
915 int ast_atomic_fetchadd_int_slow(volatile int *p, int v)
916 {
917         int ret;
918         ast_mutex_lock(&fetchadd_m);
919         ret = *p;
920         *p += v;
921         ast_mutex_unlock(&fetchadd_m);
922         return ret;
923 }
924
925 /*! \brief
926  * get values from config variables.
927  */
928 int ast_get_time_t(const char *src, time_t *dst, time_t _default, int *consumed)
929 {
930         long t;
931         int scanned;
932
933         if (dst == NULL)
934                 return -1;
935
936         *dst = _default;
937
938         if (ast_strlen_zero(src))
939                 return -1;
940
941         /* only integer at the moment, but one day we could accept more formats */
942         if (sscanf(src, "%ld%n", &t, &scanned) == 1) {
943                 *dst = t;
944                 if (consumed)
945                         *consumed = scanned;
946                 return 0;
947         } else
948                 return -1;
949 }
950
951 int ast_dynamic_str_thread_build_va(struct ast_dynamic_str **buf, size_t max_len,
952         struct ast_threadstorage *ts, int append, const char *fmt, va_list ap)
953 {
954         int res;
955         int offset = (append && (*buf)->len) ? strlen((*buf)->str) : 0;
956
957         res = vsnprintf((*buf)->str + offset, (*buf)->len - offset, fmt, ap);
958
959         /* Check to see if there was not enough space in the string buffer to prepare
960          * the string.  Also, if a maximum length is present, make sure the current
961          * length is less than the maximum before increasing the size. */
962         if ((res + offset + 1) > (*buf)->len && (max_len ? ((*buf)->len < max_len) : 1)) {
963                 /* Set the new size of the string buffer to be the size needed
964                  * to hold the resulting string (res) plus one byte for the
965                  * terminating '\0'.  If this size is greater than the max, set
966                  * the new length to be the maximum allowed. */
967                 if (max_len)
968                         (*buf)->len = ((res + offset + 1) < max_len) ? (res + offset + 1) : max_len;
969                 else
970                         (*buf)->len = res + offset + 1;
971
972                 if (!(*buf = ast_realloc(*buf, (*buf)->len + sizeof(*(*buf)))))
973                         return AST_DYNSTR_BUILD_FAILED;
974
975                 if (append)
976                         (*buf)->str[offset] = '\0';
977
978                 if (ts)
979                         pthread_setspecific(ts->key, *buf);
980
981                 /* va_end() and va_start() must be done before calling
982                  * vsnprintf() again. */
983                 return AST_DYNSTR_BUILD_RETRY;
984         }
985
986         return res;
987 }
988
989 void ast_enable_packet_fragmentation(int sock)
990 {
991 #if defined(HAVE_IP_MTU_DISCOVER)
992         int val = IP_PMTUDISC_DONT;
993         
994         if (setsockopt(sock, IPPROTO_IP, IP_MTU_DISCOVER, &val, sizeof(val)))
995                 ast_log(LOG_WARNING, "Unable to disable PMTU discovery. Large UDP packets may fail to be delivered when sent from this socket.\n");
996 #endif /* HAVE_IP_MTU_DISCOVER */
997 }