Merge "core/frame: Fix ast_frdup() and ast_frisolate() for empty text frames"
[asterisk/asterisk.git] / main / strcompat.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 Compatibility functions for strsep and strtoq missing on Solaris
20  *
21  * .. and lots of other functions too.
22  */
23
24 /*** MODULEINFO
25         <support_level>core</support_level>
26  ***/
27
28 #define ASTMM_LIBC ASTMM_IGNORE
29 #include "asterisk.h"
30
31 #include <ctype.h>
32 #include <sys/time.h>       /* for getrlimit(2) */
33 #include <sys/resource.h>   /* for getrlimit(2) */
34 #include <sys/types.h>      /* for opendir(3) */
35 #include <dirent.h>         /* for opendir(3) */
36 #include <unistd.h>         /* for fcntl(2) */
37 #include <fcntl.h>          /* for fcntl(2) */
38
39 #include "asterisk/utils.h"
40
41 #ifndef HAVE_STRSEP
42 char *strsep(char **str, const char *delims)
43 {
44         char *token;
45
46         if (!*str) {
47                 /* No more tokens */
48                 return NULL;
49         }
50
51         token = *str;
52         while (**str != '\0') {
53                 if (strchr(delims, **str)) {
54                         **str = '\0';
55                         (*str)++;
56                         return token;
57                 }
58                 (*str)++;
59         }
60
61         /* There is no other token */
62         *str = NULL;
63
64         return token;
65 }
66 #endif
67
68 #ifndef HAVE_SETENV
69 int setenv(const char *name, const char *value, int overwrite)
70 {
71         unsigned char *buf;
72         int buflen;
73
74         if (!overwrite && getenv(name))
75                 return 0;
76
77         buflen = strlen(name) + strlen(value) + 2;
78         buf = ast_alloca(buflen);
79
80         snprintf(buf, buflen, "%s=%s", name, value);
81
82         return putenv(buf);
83 }
84 #endif
85
86 #ifndef HAVE_UNSETENV
87 int unsetenv(const char *name)
88 {
89         return setenv(name, "", 0);
90 }
91 #endif
92
93 #ifndef HAVE_STRCASESTR
94 static char *upper(const char *orig, char *buf, int bufsize)
95 {
96         int i = 0;
97
98         while (i < (bufsize - 1) && orig[i]) {
99                 buf[i] = toupper(orig[i]);
100                 i++;
101         }
102
103         buf[i] = '\0';
104
105         return buf;
106 }
107
108 char *strcasestr(const char *haystack, const char *needle)
109 {
110         char *u1, *u2;
111         char *offset;
112         int u1len = strlen(haystack) + 1, u2len = strlen(needle) + 1;
113
114         if (u2len > u1len) {
115                 /* Needle bigger than haystack */
116                 return NULL;
117         }
118         u1 = ast_alloca(u1len);
119         u2 = ast_alloca(u2len);
120         offset = strstr(upper(haystack, u1, u1len), upper(needle, u2, u2len));
121         if (offset) {
122                 /* Return the offset into the original string */
123                 return ((char *)((unsigned long)haystack + (unsigned long)(offset - u1)));
124         } else {
125                 return NULL;
126         }
127 }
128 #endif /* !HAVE_STRCASESTR */
129
130 #ifndef HAVE_STRNLEN
131 size_t strnlen(const char *s, size_t n)
132 {
133         size_t len;
134
135         for (len = 0; len < n; len++)
136                 if (s[len] == '\0')
137                         break;
138
139         return len;
140 }
141 #endif /* !HAVE_STRNLEN */
142
143 #if !defined(HAVE_STRNDUP)
144 char *strndup(const char *s, size_t n)
145 {
146         size_t len = strnlen(s, n);
147         char *new = malloc(len + 1);
148
149         if (!new)
150                 return NULL;
151
152         new[len] = '\0';
153         return memcpy(new, s, len);
154 }
155 #endif /* !defined(HAVE_STRNDUP) */
156
157 #if !defined(HAVE_VASPRINTF)
158 int vasprintf(char **strp, const char *fmt, va_list ap)
159 {
160         int size;
161         va_list ap2;
162         char s;
163
164         *strp = NULL;
165         va_copy(ap2, ap);
166         size = vsnprintf(&s, 1, fmt, ap2);
167         va_end(ap2);
168         *strp = malloc(size + 1);
169         if (!*strp)
170                 return -1;
171         vsnprintf(*strp, size + 1, fmt, ap);
172
173         return size;
174 }
175 #endif /* !defined(HAVE_VASPRINTF) */
176
177 #ifndef HAVE_TIMERSUB
178 void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
179 {
180         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
181         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
182         if (tvdiff->tv_usec < 0) {
183                 tvdiff->tv_sec --;
184                 tvdiff->tv_usec += 1000000;
185         }
186
187 }
188 #endif
189
190 /*
191  * Based on Code from bsd-asprintf from OpenSSH
192  * Copyright (c) 2004 Darren Tucker.
193  *
194  * Based originally on asprintf.c from OpenBSD:
195  * Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>
196  *
197  * Permission to use, copy, modify, and distribute this software for any
198  * purpose with or without fee is hereby granted, provided that the above
199  * copyright notice and this permission notice appear in all copies.
200  *
201  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
202  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
203  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
204  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
205  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
206  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
207  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
208  */
209 #if !defined(HAVE_ASPRINTF)
210 int asprintf(char **str, const char *fmt, ...)
211 {
212         va_list ap;
213         int ret;
214
215         *str = NULL;
216         va_start(ap, fmt);
217         ret = vasprintf(str, fmt, ap);
218         va_end(ap);
219
220         return ret;
221 }
222 #endif /* !defined(HAVE_ASPRINTF) */
223
224 #ifndef HAVE_STRTOQ
225 #ifndef LONG_MIN
226 #define LONG_MIN        (-9223372036854775807L-1L)
227                                          /* min value of a "long int" */
228 #endif
229 #ifndef LONG_MAX
230 #define LONG_MAX        9223372036854775807L
231                                          /* max value of a "long int" */
232 #endif
233
234 /*! \brief
235  * Convert a string to a quad integer.
236  *
237  * \note Ignores `locale' stuff.  Assumes that the upper and lower case
238  * alphabets and digits are each contiguous.
239  */
240 uint64_t strtoq(const char *nptr, char **endptr, int base)
241 {
242          const char *s;
243          uint64_t acc;
244          unsigned char c;
245          uint64_t qbase, cutoff;
246          int neg, any, cutlim;
247
248          /*
249           * Skip white space and pick up leading +/- sign if any.
250           * If base is 0, allow 0x for hex and 0 for octal, else
251           * assume decimal; if base is already 16, allow 0x.
252           */
253          s = nptr;
254          do {
255                  c = *s++;
256          } while (isspace(c));
257          if (c == '-') {
258                  neg = 1;
259                  c = *s++;
260          } else {
261                  neg = 0;
262                  if (c == '+')
263                          c = *s++;
264          }
265          if ((base == 0 || base == 16) &&
266              c == '\0' && (*s == 'x' || *s == 'X')) {
267                  c = s[1];
268                  s += 2;
269                  base = 16;
270          }
271          if (base == 0)
272                  base = c == '\0' ? 8 : 10;
273
274          /*
275           * Compute the cutoff value between legal numbers and illegal
276           * numbers.  That is the largest legal value, divided by the
277           * base.  An input number that is greater than this value, if
278           * followed by a legal input character, is too big.  One that
279           * is equal to this value may be valid or not; the limit
280           * between valid and invalid numbers is then based on the last
281           * digit.  For instance, if the range for quads is
282           * [-9223372036854775808..9223372036854775807] and the input base
283           * is 10, cutoff will be set to 922337203685477580 and cutlim to
284           * either 7 (neg==0) or 8 (neg==1), meaning that if we have
285           * accumulated a value > 922337203685477580, or equal but the
286           * next digit is > 7 (or 8), the number is too big, and we will
287           * return a range error.
288           *
289           * Set any if any `digits' consumed; make it negative to indicate
290           * overflow.
291           */
292          qbase = (unsigned)base;
293          cutoff = neg ? (uint64_t)-(LONG_MIN + LONG_MAX) + LONG_MAX : LONG_MAX;
294          cutlim = cutoff % qbase;
295          cutoff /= qbase;
296          for (acc = 0, any = 0;; c = *s++) {
297                  if (!isascii(c))
298                          break;
299                  if (isdigit(c))
300                          c -= '\0';
301                  else if (isalpha(c))
302                          c -= isupper(c) ? 'A' - 10 : 'a' - 10;
303                  else
304                          break;
305                  if (c >= base)
306                          break;
307                  if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
308                          any = -1;
309                  else {
310                          any = 1;
311                          acc *= qbase;
312                          acc += c;
313                  }
314          }
315          if (any < 0) {
316                  acc = neg ? LONG_MIN : LONG_MAX;
317          } else if (neg)
318                  acc = -acc;
319          if (endptr != 0)
320                  *((const char **)endptr) = any ? s - 1 : nptr;
321          return acc;
322 }
323 #endif /* !HAVE_STRTOQ */
324
325 #ifndef HAVE_GETLOADAVG
326 #ifdef linux
327 /*! \brief Alternative method of getting load avg on Linux only */
328 int getloadavg(double *list, int nelem)
329 {
330         FILE *LOADAVG;
331         double avg[3] = { 0.0, 0.0, 0.0 };
332         int i, res = -1;
333
334         if ((LOADAVG = fopen("/proc/loadavg", "r"))) {
335                 fscanf(LOADAVG, "%lf %lf %lf", &avg[0], &avg[1], &avg[2]);
336                 res = 0;
337                 fclose(LOADAVG);
338         }
339
340         for (i = 0; (i < nelem) && (i < 3); i++) {
341                 list[i] = avg[i];
342         }
343
344         return res;
345 }
346 #else /* !linux */
347 /*! \brief Return something that won't cancel the call, but still return -1, in case
348  * we correct the implementation to check return value */
349 int getloadavg(double *list, int nelem)
350 {
351         int i;
352
353         for (i = 0; i < nelem; i++) {
354                 list[i] = 0.1;
355         }
356         return -1;
357 }
358 #endif /* linux */
359 #endif /* !HAVE_GETLOADAVG */
360
361 #ifndef HAVE_NTOHLL
362 uint64_t ntohll(uint64_t net64)
363 {
364 #if BYTE_ORDER == BIG_ENDIAN
365         return net64;
366 #elif BYTE_ORDER == LITTLE_ENDIAN
367         union {
368                 unsigned char c[8];
369                 uint64_t u;
370         } number;
371         number.u = net64;
372         return
373                 (((uint64_t) number.c[0]) << 56) |
374                 (((uint64_t) number.c[1]) << 48) |
375                 (((uint64_t) number.c[2]) << 40) |
376                 (((uint64_t) number.c[3]) << 32) |
377                 (((uint64_t) number.c[4]) << 24) |
378                 (((uint64_t) number.c[5]) << 16) |
379                 (((uint64_t) number.c[6]) <<  8) |
380                 (((uint64_t) number.c[7]) <<  0);
381 #else
382         #error "Unknown byte order"
383 #endif
384 }
385 #endif
386
387 #ifndef HAVE_HTONLL
388 uint64_t htonll(uint64_t host64)
389 {
390 #if BYTE_ORDER == BIG_ENDIAN
391         return host64;
392 #elif BYTE_ORDER == LITTLE_ENDIAN
393         union {
394                 unsigned char c[8];
395                 uint64_t u;
396         } number;
397         number.u = host64;
398         return
399                 (((uint64_t) number.c[0]) << 56) |
400                 (((uint64_t) number.c[1]) << 48) |
401                 (((uint64_t) number.c[2]) << 40) |
402                 (((uint64_t) number.c[3]) << 32) |
403                 (((uint64_t) number.c[4]) << 24) |
404                 (((uint64_t) number.c[5]) << 16) |
405                 (((uint64_t) number.c[6]) <<  8) |
406                 (((uint64_t) number.c[7]) <<  0);
407 #else
408         #error "Unknown byte order"
409 #endif
410 }
411 #endif
412
413 #ifndef HAVE_FFSLL
414 int ffsll(long long n)
415 {
416         int i;
417         for (i = 0; i < 64; i++) {
418                 if ((1LL << i) & n) {
419                         return i + 1;
420                 }
421         }
422         return 0;
423 }
424 #endif
425
426 #ifndef HAVE_CLOSEFROM
427 void closefrom(int n)
428 {
429         long x;
430         struct rlimit rl;
431         DIR *dir;
432         char path[16], *result;
433         struct dirent *entry;
434
435         snprintf(path, sizeof(path), "/proc/%d/fd", (int) getpid());
436         if ((dir = opendir(path))) {
437                 while ((entry = readdir(dir))) {
438                         /* Skip . and .. */
439                         if (entry->d_name[0] == '.') {
440                                 continue;
441                         }
442                         if ((x = strtol(entry->d_name, &result, 10)) && x >= n) {
443 #ifdef STRICT_COMPAT
444                                 close(x);
445 #else
446                                 /* This isn't strictly compatible, but it's actually faster
447                                  * for our purposes to set the CLOEXEC flag than to close
448                                  * file descriptors.
449                                  */
450                                 long flags = fcntl(x, F_GETFD);
451                                 if (flags == -1 && errno == EBADF) {
452                                         continue;
453                                 }
454                                 fcntl(x, F_SETFD, flags | FD_CLOEXEC);
455 #endif
456                         }
457                 }
458                 closedir(dir);
459         } else {
460                 getrlimit(RLIMIT_NOFILE, &rl);
461                 if (rl.rlim_cur > 65535) {
462                         /* A more reasonable value.  Consider that the primary source of
463                          * file descriptors in Asterisk are UDP sockets, of which we are
464                          * limited to 65,535 per address.  We additionally limit that down
465                          * to about 10,000 sockets per protocol.  While the kernel will
466                          * allow us to set the fileno limit higher (up to 4.2 billion),
467                          * there really is no practical reason for it to be that high.
468                          */
469                         rl.rlim_cur = 65535;
470                 }
471                 for (x = n; x < rl.rlim_cur; x++) {
472 #ifdef STRICT_COMPAT
473                         close(x);
474 #else
475                         long flags = fcntl(x, F_GETFD);
476                         if (flags == -1 && errno == EBADF) {
477                                 continue;
478                         }
479                         fcntl(x, F_SETFD, flags | FD_CLOEXEC);
480 #endif
481                 }
482         }
483 }
484 #endif
485
486 #ifndef HAVE_MKDTEMP
487 /*      $OpenBSD: mktemp.c,v 1.30 2010/03/21 23:09:30 schwarze Exp $ */
488 /*
489  * Copyright (c) 1996-1998, 2008 Theo de Raadt
490  * Copyright (c) 1997, 2008-2009 Todd C. Miller
491  *
492  * Permission to use, copy, modify, and distribute this software for any
493  * purpose with or without fee is hereby granted, provided that the above
494  * copyright notice and this permission notice appear in all copies.
495  *
496  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
497  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
498  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
499  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
500  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
501  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
502  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
503  */
504
505 #define MKTEMP_NAME     0
506 #define MKTEMP_FILE     1
507 #define MKTEMP_DIR      2
508
509 #define TEMPCHARS       "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_."
510 #define NUM_CHARS       (sizeof(TEMPCHARS) - 1)
511
512 static int mktemp_internal(char *path, int slen, int mode)
513 {
514         char *start, *cp, *ep;
515         const char *tempchars = TEMPCHARS;
516         unsigned int r, tries;
517         struct stat sb;
518         size_t len;
519         int fd;
520
521         len = strlen(path);
522         if (len == 0 || slen >= len) {
523                 errno = EINVAL;
524                 return(-1);
525         }
526         ep = path + len - slen;
527
528         tries = 1;
529         for (start = ep; start > path && start[-1] == 'X'; start--) {
530                 if (tries < INT_MAX / NUM_CHARS) {
531                         tries *= NUM_CHARS;
532                 }
533         }
534         tries *= 2;
535
536         do {
537                 for (cp = start; cp != ep; cp++) {
538                         r = ast_random() % NUM_CHARS;
539                         *cp = tempchars[r];
540                 }
541
542                 switch (mode) {
543                 case MKTEMP_NAME:
544                         if (lstat(path, &sb) != 0) {
545                                 return (errno == ENOENT ? 0 : -1);
546                         }
547                         break;
548                 case MKTEMP_FILE:
549                         fd = open(path, O_CREAT | O_EXCL | O_RDWR, S_IRUSR | S_IWUSR);
550                         if (fd != -1 || errno != EEXIST) {
551                                 return (fd);
552                         }
553                         break;
554                 case MKTEMP_DIR:
555                         if (mkdir(path, S_IRUSR | S_IWUSR | S_IXUSR) == 0) {
556                                 return (0);
557                         }
558                         if (errno != EEXIST) {
559                                 return (-1);
560                         }
561                         break;
562                 }
563         } while (--tries);
564
565         errno = EEXIST;
566         return(-1);
567 }
568
569 char *mkdtemp(char *path)
570 {
571         return mktemp_internal(path, 0, MKTEMP_DIR) ? NULL : path;
572 }
573 #endif
574
575 #ifndef HAVE_ROUNDF
576 #ifndef HAVE_ROUND
577 float roundf(float x) {
578         if (x < 0.0) {
579                 return (float)(int)((x) - 0.5);
580         } else {
581                 return (float)(int)((x) + 0.5);
582         }
583 }
584 #endif
585 #endif