provide an alternate getloadavg implementation and a fallback for systems that don...
[asterisk/asterisk.git] / utils.c
diff --git a/utils.c b/utils.c
index 742b487..054258c 100755 (executable)
--- a/utils.c
+++ b/utils.c
@@ -1,50 +1,62 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Utility functions
+ * Copyright (C) 1999 - 2005, Digium, Inc.
  *
- * Copyright (C)  2004 - 2005, Digium, Inc.
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
  *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief Utility functions
+ *
+ * \note These are important for portability and security,
+ * so please use them in favour of other routines.
+ * Please consult the CODING GUIDELINES for more information.
  */
 
-#ifdef Linux   /* For strcasestr */
-#define __USE_GNU
-#endif
 #include <ctype.h>
 #include <string.h>
 #include <unistd.h>
 #include <stdlib.h>
 #include <errno.h>
+#include <stdarg.h>
 #include <stdio.h>
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
 
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
 #include "asterisk/lock.h"
-#include "asterisk/utils.h"
 #include "asterisk/io.h"
 #include "asterisk/logger.h"
 #include "asterisk/md5.h"
+#include "asterisk/options.h"
+
+#define AST_API_MODULE         /* ensure that inlinable API functions will be built in this module if required */
+#include "asterisk/strings.h"
+
+#define AST_API_MODULE         /* ensure that inlinable API functions will be built in this module if required */
+#include "asterisk/time.h"
+
+#define AST_API_MODULE         /* ensure that inlinable API functions will be built in this module if required */
+#include "asterisk/utils.h"
 
 static char base64[64];
 static char b2a[256];
 
-char *ast_strip(char *buf)
-{
-       char *start;
-       /* Strip off trailing whitespace, returns, etc */
-       while (!ast_strlen_zero(buf) && (buf[strlen(buf)-1]<33))
-               buf[strlen(buf)-1] = '\0';
-       start = buf;
-       /* Strip off leading whitespace, returns, etc */
-       while (*start && (*start < 33))
-               *start++ = '\0';
-       return start;
-}
-
 #if defined(__FreeBSD__) || defined(__OpenBSD__) || defined( __NetBSD__ ) || defined(__APPLE__)
 
 /* duh? ERANGE value copied from web... */
@@ -53,7 +65,10 @@ char *ast_strip(char *buf)
 
 AST_MUTEX_DEFINE_STATIC(__mutex);
 
-/* Recursive replacement for gethostbyname for BSD-based systems */
+/* Recursive replacement for gethostbyname for BSD-based systems.  This
+routine is derived from code originally written and placed in the public 
+domain by Enzo Michelangeli <em@em.no-ip.com> */
+
 static int gethostbyname_r (const char *name, struct hostent *ret, char *buf,
                                size_t buflen, struct hostent **result, 
                                int *h_errnop) 
@@ -151,13 +166,14 @@ static int gethostbyname_r (const char *name, struct hostent *ret, char *buf,
 
 #endif
 
-/* Re-entrant (thread safe) version of gethostbyname that replaces the 
+/*! \brief Re-entrant (thread safe) version of gethostbyname that replaces the 
    standard gethostbyname (which is not thread safe)
 */
 struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp)
 {
        int res;
        int herrno;
+       int dots=0;
        const char *s;
        struct hostent *result = NULL;
        /* Although it is perfectly legitimate to lookup a pure integer, for
@@ -167,12 +183,24 @@ struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp)
        s = host;
        res = 0;
        while(s && *s) {
-               if (!isdigit(*s))
+               if (*s == '.')
+                       dots++;
+               else if (!isdigit(*s))
                        break;
                s++;
        }
-       if (!s || !*s)
+       if (!s || !*s) {
+               /* Forge a reply for IP's to avoid octal IP's being interpreted as octal */
+               if (dots != 3)
+                       return NULL;
+               memset(hp, 0, sizeof(struct ast_hostent));
+               hp->hp.h_addr_list = (void *) hp->buf;
+               hp->hp.h_addr = hp->buf + sizeof(void *);
+               if (inet_pton(AF_INET, host, hp->hp.h_addr) > 0)
+                       return &hp->hp;
                return NULL;
+               
+       }
 #ifdef SOLARIS
        result = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &herrno);
 
@@ -188,9 +216,6 @@ struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp)
 }
 
 
-/* This is a regression test for recursive mutexes.
-   test_for_thread_safety() will return 0 if recursive mutex locks are
-   working properly, and non-zero if they are not working properly. */
 
 AST_MUTEX_DEFINE_STATIC(test_lock);
 AST_MUTEX_DEFINE_STATIC(test_lock2);
@@ -198,6 +223,9 @@ static pthread_t test_thread;
 static int lock_count = 0;
 static int test_errors = 0;
 
+/*! \brief This is a regression test for recursive mutexes.
+   test_for_thread_safety() will return 0 if recursive mutex locks are
+   working properly, and non-zero if they are not working properly. */
 static void *test_thread_body(void *data) 
 { 
        ast_mutex_lock(&test_lock);
@@ -249,22 +277,23 @@ int test_for_thread_safety(void)
        return(test_errors);          /* return 0 on success. */
 }
 
-/*--- ast_md5_hash: Produce 16 char MD5 hash of value. ---*/
+/*! \brief ast_md5_hash: Produce 16 char MD5 hash of value. ---*/
 void ast_md5_hash(char *output, char *input)
 {
-               struct MD5Context md5;
-               unsigned char digest[16];
-               char *ptr;
-               int x;
-               MD5Init(&md5);
-               MD5Update(&md5, input, strlen(input));
-               MD5Final(digest, &md5);
-               ptr = output;
-               for (x=0;x<16;x++)
-                       ptr += sprintf(ptr, "%2.2x", digest[x]);
+       struct MD5Context md5;
+       unsigned char digest[16];
+       char *ptr;
+       int x;
+
+       MD5Init(&md5);
+       MD5Update(&md5, (unsigned char *)input, strlen(input));
+       MD5Final(digest, &md5);
+       ptr = output;
+       for (x=0; x<16; x++)
+               ptr += sprintf(ptr, "%2.2x", digest[x]);
 }
 
-int ast_base64decode(unsigned char *dst, char *src, int max)
+int ast_base64decode(unsigned char *dst, const char *src, int max)
 {
        int cnt = 0;
        unsigned int byte = 0;
@@ -302,7 +331,7 @@ int ast_base64decode(unsigned char *dst, char *src, int max)
        return cnt;
 }
 
-int ast_base64encode(char *dst, unsigned char *src, int srclen, int max)
+int ast_base64encode(char *dst, const unsigned char *src, int srclen, int max)
 {
        int cnt = 0;
        unsigned int byte = 0;
@@ -379,7 +408,66 @@ static void base64_init(void)
 #endif
 }
 
-/* Recursive thread safe replacement of inet_ntoa */
+/*! \brief  ast_uri_encode: Turn text string to URI-encoded %XX version ---*/
+/*     At this point, we're converting from ISO-8859-x (8-bit), not UTF8
+       as in the SIP protocol spec 
+       If doreserved == 1 we will convert reserved characters also.
+       RFC 2396, section 2.4
+       outbuf needs to have more memory allocated than the instring
+       to have room for the expansion. Every char that is converted
+       is replaced by three ASCII characters.
+
+       Note: The doreserved option is needed for replaces header in
+       SIP transfers.
+*/
+char *ast_uri_encode(char *string, char *outbuf, int buflen, int doreserved) 
+{
+       char *reserved = ";/?:@&=+$, "; /* Reserved chars */
+
+       char *ptr  = string;    /* Start with the string */
+       char *out = NULL;
+       char *buf = NULL;
+
+       strncpy(outbuf, string, buflen);
+
+       /* If there's no characters to convert, just go through and don't do anything */
+       while (*ptr) {
+               if (((unsigned char) *ptr) > 127 || (doreserved && strchr(reserved, *ptr)) ) {
+                       /* Oops, we need to start working here */
+                       if (!buf) {
+                               buf = outbuf;
+                               out = buf + (ptr - string) ;    /* Set output ptr */
+                       }
+                       out += sprintf(out, "%%%02x", (unsigned char) *ptr);
+               } else if (buf) {
+                       *out = *ptr;    /* Continue copying the string */
+                       out++;
+               } 
+               ptr++;
+       }
+       if (buf)
+               *out = '\0';
+       return outbuf;
+}
+
+/*! \brief  ast_uri_decode: Decode SIP URI, URN, URL (overwrite the string)  ---*/
+void ast_uri_decode(char *s) 
+{
+       char *o;
+       unsigned int tmp;
+
+       for (o = s; *s; s++, o++) {
+               if (*s == '%' && strlen(s) > 2 && sscanf(s + 1, "%2x", &tmp) == 1) {
+                       /* have '%', two chars and correct parsing */
+                       *o = tmp;
+                       s += 2; /* Will be incremented once more when we break out */
+               } else /* all other cases, just copy */
+                       *o = *s;
+       }
+       *o = '\0';
+}
+
+/*! \brief  ast_inet_ntoa: Recursive thread safe replacement of inet_ntoa */
 const char *ast_inet_ntoa(char *buf, int bufsiz, struct in_addr ia)
 {
        return inet_ntop(AF_INET, &ia, buf, bufsiz);
@@ -393,7 +481,8 @@ int ast_utils_init(void)
 
 #ifndef __linux__
 #undef pthread_create /* For ast_pthread_create function only */
-#endif /* ! LINUX */
+#endif /* !__linux__ */
+
 int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *), void *data, size_t stacksize)
 {
        pthread_attr_t lattr;
@@ -401,6 +490,19 @@ int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*st
                pthread_attr_init(&lattr);
                attr = &lattr;
        }
+#ifdef __linux__
+       /* On Linux, pthread_attr_init() defaults to PTHREAD_EXPLICIT_SCHED,
+          which is kind of useless. Change this here to
+          PTHREAD_INHERIT_SCHED; that way the -p option to set realtime
+          priority will propagate down to new threads by default.
+          This does mean that callers cannot set a different priority using
+          PTHREAD_EXPLICIT_SCHED in the attr argument; instead they must set
+          the priority afterwards with pthread_setschedparam(). */
+       errno = pthread_attr_setinheritsched(attr, PTHREAD_INHERIT_SCHED);
+       if (errno)
+               ast_log(LOG_WARNING, "pthread_attr_setinheritsched returned non-zero: %s\n", strerror(errno));
+#endif
+
        if (!stacksize)
                stacksize = AST_STACKSIZE;
        errno = pthread_attr_setstacksize(attr, stacksize);
@@ -418,22 +520,153 @@ int ast_wait_for_input(int fd, int ms)
        return poll(pfd, 1, ms);
 }
 
-/* Case-insensitive substring matching */
-#ifndef LINUX
+char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes)
+{
+       char *e;
+       char *q;
+
+       s = ast_strip(s);
+       if ((q = strchr(beg_quotes, *s))) {
+               e = s + strlen(s) - 1;
+               if (*e == *(end_quotes + (q - beg_quotes))) {
+                       s++;
+                       *e = '\0';
+               }
+       }
+
+       return s;
+}
+
+int ast_build_string_va(char **buffer, size_t *space, const char *fmt, va_list ap)
+{
+       int result;
+
+       if (!buffer || !*buffer || !space || !*space)
+               return -1;
+
+       result = vsnprintf(*buffer, *space, fmt, ap);
+
+       if (result < 0)
+               return -1;
+       else if (result > *space)
+               result = *space;
+
+       *buffer += result;
+       *space -= result;
+       return 0;
+}
+
+int ast_build_string(char **buffer, size_t *space, const char *fmt, ...)
+{
+       va_list ap;
+       int result;
+
+       va_start(ap, fmt);
+       result = ast_build_string_va(buffer, space, fmt, ap);
+       va_end(ap);
+
+       return result;
+}
+
+int ast_true(const char *s)
+{
+       if (ast_strlen_zero(s))
+               return 0;
+
+       /* Determine if this is a true value */
+       if (!strcasecmp(s, "yes") ||
+           !strcasecmp(s, "true") ||
+           !strcasecmp(s, "y") ||
+           !strcasecmp(s, "t") ||
+           !strcasecmp(s, "1") ||
+           !strcasecmp(s, "on"))
+               return -1;
+
+       return 0;
+}
+
+int ast_false(const char *s)
+{
+       if (ast_strlen_zero(s))
+               return 0;
+
+       /* Determine if this is a false value */
+       if (!strcasecmp(s, "no") ||
+           !strcasecmp(s, "false") ||
+           !strcasecmp(s, "n") ||
+           !strcasecmp(s, "f") ||
+           !strcasecmp(s, "0") ||
+           !strcasecmp(s, "off"))
+               return -1;
+
+       return 0;
+}
+
+#define ONE_MILLION    1000000
+/*
+ * put timeval in a valid range. usec is 0..999999
+ * negative values are not allowed and truncated.
+ */
+static struct timeval tvfix(struct timeval a)
+{
+       if (a.tv_usec >= ONE_MILLION) {
+               ast_log(LOG_WARNING, "warning too large timestamp %ld.%ld\n",
+                       a.tv_sec, (long int) a.tv_usec);
+               a.tv_sec += a.tv_usec % ONE_MILLION;
+               a.tv_usec %= ONE_MILLION;
+       } else if (a.tv_usec < 0) {
+               ast_log(LOG_WARNING, "warning negative timestamp %ld.%ld\n",
+                               a.tv_sec, (long int) a.tv_usec);
+               a.tv_usec = 0;
+       }
+       return a;
+}
+
+struct timeval ast_tvadd(struct timeval a, struct timeval b)
+{
+       /* consistency checks to guarantee usec in 0..999999 */
+       a = tvfix(a);
+       b = tvfix(b);
+       a.tv_sec += b.tv_sec;
+       a.tv_usec += b.tv_usec;
+       if (a.tv_usec >= ONE_MILLION) {
+               a.tv_sec++;
+               a.tv_usec -= ONE_MILLION;
+       }
+       return a;
+}
+
+struct timeval ast_tvsub(struct timeval a, struct timeval b)
+{
+       /* consistency checks to guarantee usec in 0..999999 */
+       a = tvfix(a);
+       b = tvfix(b);
+       a.tv_sec -= b.tv_sec;
+       a.tv_usec -= b.tv_usec;
+       if (a.tv_usec < 0) {
+               a.tv_sec-- ;
+               a.tv_usec += ONE_MILLION;
+       }
+       return a;
+}
+#undef ONE_MILLION
+
+#ifndef HAVE_STRCASESTR
 static char *upper(const char *orig, char *buf, int bufsize)
 {
-       int i;
-       memset(buf, 0, bufsize);
-       for (i=0; i<bufsize - 1; i++) {
+       int i = 0;
+
+       while (i < (bufsize - 1) && orig[i]) {
                buf[i] = toupper(orig[i]);
-               if (orig[i] == '\0') {
-                       break;
-               }
+               i++;
        }
+
+       buf[i] = '\0';
+
        return buf;
 }
 
-char *ast_strcasestr(const char *haystack, const char *needle)
+char *strcasestr(const char *haystack, const char *needle)
 {
        char *u1, *u2;
        int u1len = strlen(haystack) + 1, u2len = strlen(needle) + 1;
@@ -449,7 +682,7 @@ char *ast_strcasestr(const char *haystack, const char *needle)
                offset = strstr(upper(haystack, u1, u1len), upper(needle, u2, u2len));
                if (offset) {
                        /* Return the offset into the original string */
-                       return ((char *)((unsigned int)haystack + (unsigned int)(offset - u1)));
+                       return ((char *)((unsigned long)haystack + (unsigned long)(offset - u1)));
                } else {
                        return NULL;
                }
@@ -458,4 +691,210 @@ char *ast_strcasestr(const char *haystack, const char *needle)
                return NULL;
        }
 }
-#endif /* LINUX */
+#endif /* !HAVE_STRCASESTR */
+
+#ifndef HAVE_STRNLEN
+size_t strnlen(const char *s, size_t n)
+{
+       size_t len;
+
+       for (len=0; len < n; len++)
+               if (s[len] == '\0')
+                       break;
+
+       return len;
+}
+#endif /* !HAVE_STRNLEN */
+
+#if !defined(HAVE_STRNDUP) && !defined(__AST_DEBUG_MALLOC)
+char *strndup(const char *s, size_t n)
+{
+       size_t len = strnlen(s, n);
+       char *new = malloc(len + 1);
+
+       if (!new)
+               return NULL;
+
+       new[len] = '\0';
+       return memcpy(new, s, len);
+}
+#endif /* !defined(HAVE_STRNDUP) && !defined(__AST_DEBUG_MALLOC) */
+
+#if !defined(HAVE_VASPRINTF) && !defined(__AST_DEBUG_MALLOC)
+int vasprintf(char **strp, const char *fmt, va_list ap)
+{
+       int size;
+       va_list ap2;
+       char s;
+
+       *strp = NULL;
+       va_copy(ap2, ap);
+       size = vsnprintf(&s, 1, fmt, ap2);
+       va_end(ap2);
+       *strp = malloc(size + 1);
+       if (!*strp)
+               return -1;
+       vsnprintf(*strp, size + 1, fmt, ap);
+
+       return size;
+}
+#endif /* !defined(HAVE_VASPRINTF) && !defined(__AST_DEBUG_MALLOC) */
+
+#ifndef HAVE_STRTOQ
+#define LONG_MIN        (-9223372036854775807L-1L)
+                                        /* min value of a "long int" */
+#define LONG_MAX        9223372036854775807L
+                                        /* max value of a "long int" */
+
+/*
+ * Convert a string to a quad integer.
+ *
+ * Ignores `locale' stuff.  Assumes that the upper and lower case
+ * alphabets and digits are each contiguous.
+ */
+uint64_t strtoq(const char *nptr, char **endptr, int base)
+{
+        const char *s;
+        uint64_t acc;
+        unsigned char c;
+        uint64_t qbase, cutoff;
+        int neg, any, cutlim;
+
+        /*
+         * Skip white space and pick up leading +/- sign if any.
+         * If base is 0, allow 0x for hex and 0 for octal, else
+         * assume decimal; if base is already 16, allow 0x.
+         */
+        s = nptr;
+        do {
+                c = *s++;
+        } while (isspace(c));
+        if (c == '-') {
+                neg = 1;
+                c = *s++;
+        } else {
+                neg = 0;
+                if (c == '+')
+                        c = *s++;
+        }
+        if ((base == 0 || base == 16) &&
+            c == '\0' && (*s == 'x' || *s == 'X')) {
+                c = s[1];
+                s += 2;
+                base = 16;
+        }
+        if (base == 0)
+                base = c == '\0' ? 8 : 10;
+
+        /*
+         * Compute the cutoff value between legal numbers and illegal
+         * numbers.  That is the largest legal value, divided by the
+         * base.  An input number that is greater than this value, if
+         * followed by a legal input character, is too big.  One that
+         * is equal to this value may be valid or not; the limit
+         * between valid and invalid numbers is then based on the last
+         * digit.  For instance, if the range for quads is
+         * [-9223372036854775808..9223372036854775807] and the input base
+         * is 10, cutoff will be set to 922337203685477580 and cutlim to
+         * either 7 (neg==0) or 8 (neg==1), meaning that if we have
+         * accumulated a value > 922337203685477580, or equal but the
+         * next digit is > 7 (or 8), the number is too big, and we will
+         * return a range error.
+         *
+         * Set any if any `digits' consumed; make it negative to indicate
+         * overflow.
+         */
+        qbase = (unsigned)base;
+        cutoff = neg ? (uint64_t)-(LONG_MIN + LONG_MAX) + LONG_MAX : LONG_MAX;
+        cutlim = cutoff % qbase;
+        cutoff /= qbase;
+        for (acc = 0, any = 0;; c = *s++) {
+                if (!isascii(c))
+                        break;
+                if (isdigit(c))
+                        c -= '\0';
+                else if (isalpha(c))
+                        c -= isupper(c) ? 'A' - 10 : 'a' - 10;
+                else
+                        break;
+                if (c >= base)
+                        break;
+                if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
+                        any = -1;
+                else {
+                        any = 1;
+                        acc *= qbase;
+                        acc += c;
+                }
+        }
+        if (any < 0) {
+                acc = neg ? LONG_MIN : LONG_MAX;
+        } else if (neg)
+                acc = -acc;
+        if (endptr != 0)
+                *((const char **)endptr) = any ? s - 1 : nptr;
+        return acc;
+}
+#endif /* !HAVE_STRTOQ */
+
+#if (!defined(getloadavg))
+#ifdef linux
+/* Alternative method of getting load avg on Linux only */
+int getloadavg(double *list, int nelem)
+{
+       FILE *LOADAVG;
+       double avg[3] = { 0.0, 0.0, 0.0 };
+       int i, res = -1;
+
+       if ((LOADAVG = fopen("/proc/loadavg", "r"))) {
+               fscanf(LOADAVG, "%lf %lf %lf", &avg[0], &avg[1], &avg[2]);
+               res = 0;
+               fclose(LOADAVG);
+       }
+
+       for (i = 0; (i < nelem) && (i < 3); i++) {
+               list[i] = avg[i];
+       }
+
+       return res;
+}
+#else /* !linux */
+/* Return something that won't cancel the call, but still return -1, in case
+ * we correct the implementation to check return value */
+int getloadavg(double *list, int nelem)
+{
+       int i;
+
+       for (i = 0; i < nelem; i++) {
+               list[i] = 0.1;
+       }
+       return -1;
+}
+#endif /* linux */
+#endif /* !defined(getloadavg) */
+
+char *ast_process_quotes_and_slashes(char *start, char find, char replace_with)
+{
+       char *dataPut = start;
+       int inEscape = 0;
+       int inQuotes = 0;
+
+       for (; *start; start++) {
+               if (inEscape) {
+                       *dataPut++ = *start;       /* Always goes verbatim */
+                       inEscape = 0;
+               } else {
+                       if (*start == '\\') {
+                               inEscape = 1;      /* Do not copy \ into the data */
+                       } else if (*start == '\'') {
+                               inQuotes = 1-inQuotes;   /* Do not copy ' into the data */
+                       } else {
+                               /* Replace , with |, unless in quotes */
+                               *dataPut++ = inQuotes ? *start : ((*start==find) ? replace_with : *start);
+                       }
+               }
+       }
+       if (start != dataPut)
+               *dataPut = 0;
+       return dataPut;
+}