util/cutils.c

   1 /*
   2  * Simple C functions to supplement the C library
   3  *
   4  * Copyright (c) 2006 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "qemu-common.h"
  25 #include "qemu/host-utils.h"
  26 #include <math.h>
  27 #include <limits.h>
  28 #include <errno.h>
  29
  30 #include "qemu/sockets.h"
  31 #include "qemu/iov.h"
  32 #include "net/net.h"
  33
  34 void strpadcpy(char *buf, int buf_size, const char *str, char pad)
  35 {
  36     int len = qemu_strnlen(str, buf_size);
  37     memcpy(buf, str, len);
  38     memset(buf + len, pad, buf_size - len);
  39 }
  40
  41 void pstrcpy(char *buf, int buf_size, const char *str)
  42 {
  43     int c;
  44     char *q = buf;
  45
  46     if (buf_size <= 0)
  47         return;
  48
  49     for(;;) {
  50         c = *str++;
  51         if (c == 0 || q >= buf + buf_size - 1)
  52             break;
  53         *q++ = c;
  54     }
  55     *q = '\0';
  56 }
  57
  58 /* strcat and truncate. */
  59 char *pstrcat(char *buf, int buf_size, const char *s)
  60 {
  61     int len;
  62     len = strlen(buf);
  63     if (len < buf_size)
  64         pstrcpy(buf + len, buf_size - len, s);
  65     return buf;
  66 }
  67
  68 int strstart(const char *str, const char *val, const char **ptr)
  69 {
  70     const char *p, *q;
  71     p = str;
  72     q = val;
  73     while (*q != '\0') {
  74         if (*p != *q)
  75             return 0;
  76         p++;
  77         q++;
  78     }
  79     if (ptr)
  80         *ptr = p;
  81     return 1;
  82 }
  83
  84 int stristart(const char *str, const char *val, const char **ptr)
  85 {
  86     const char *p, *q;
  87     p = str;
  88     q = val;
  89     while (*q != '\0') {
  90         if (qemu_toupper(*p) != qemu_toupper(*q))
  91             return 0;
  92         p++;
  93         q++;
  94     }
  95     if (ptr)
  96         *ptr = p;
  97     return 1;
  98 }
  99
 100 /* XXX: use host strnlen if available ? */
 101 int qemu_strnlen(const char *s, int max_len)
 102 {
 103     int i;
 104
 105     for(i = 0; i < max_len; i++) {
 106         if (s[i] == '\0') {
 107             break;
 108         }
 109     }
 110     return i;
 111 }
 112
 113 char *qemu_strsep(char **input, const char *delim)
 114 {
 115     char *result = *input;
 116     if (result != NULL) {
 117         char *p;
 118
 119         for (p = result; *p != '\0'; p++) {
 120             if (strchr(delim, *p)) {
 121                 break;
 122             }
 123         }
 124         if (*p == '\0') {
 125             *input = NULL;
 126         } else {
 127             *p = '\0';
 128             *input = p + 1;
 129         }
 130     }
 131     return result;
 132 }
 133
 134 time_t mktimegm(struct tm *tm)
 135 {
 136     time_t t;
 137     int y = tm->tm_year + 1900, m = tm->tm_mon + 1, d = tm->tm_mday;
 138     if (m < 3) {
 139         m += 12;
 140         y--;
 141     }
 142     t = 86400ULL * (d + (153 * m - 457) / 5 + 365 * y + y / 4 - y / 100 +
 143                  y / 400 - 719469);
 144     t += 3600 * tm->tm_hour + 60 * tm->tm_min + tm->tm_sec;
 145     return t;
 146 }
 147
 148 int qemu_fls(int i)
 149 {
 150     return 32 - clz32(i);
 151 }
 152
 153 /*
 154  * Make sure data goes on disk, but if possible do not bother to
 155  * write out the inode just for timestamp updates.
 156  *
 157  * Unfortunately even in 2009 many operating systems do not support
 158  * fdatasync and have to fall back to fsync.
 159  */
 160 int qemu_fdatasync(int fd)
 161 {
 162 #ifdef CONFIG_FDATASYNC
 163     return fdatasync(fd);
 164 #else
 165     return fsync(fd);
 166 #endif
 167 }
 168
 169 /*
 170  * Searches for an area with non-zero content in a buffer
 171  *
 172  * Attention! The len must be a multiple of
 173  * BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR * sizeof(VECTYPE)
 174  * and addr must be a multiple of sizeof(VECTYPE) due to
 175  * restriction of optimizations in this function.
 176  *
 177  * can_use_buffer_find_nonzero_offset() can be used to check
 178  * these requirements.
 179  *
 180  * The return value is the offset of the non-zero area rounded
 181  * down to a multiple of sizeof(VECTYPE) for the first
 182  * BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR chunks and down to
 183  * BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR * sizeof(VECTYPE)
 184  * afterwards.
 185  *
 186  * If the buffer is all zero the return value is equal to len.
 187  */
 188
 189 size_t buffer_find_nonzero_offset(const void *buf, size_t len)
 190 {
 191     const VECTYPE *p = buf;
 192     const VECTYPE zero = (VECTYPE){0};
 193     size_t i;
 194
 195     assert(can_use_buffer_find_nonzero_offset(buf, len));
 196
 197     if (!len) {
 198         return 0;
 199     }
 200
 201     for (i = 0; i < BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR; i++) {
 202         if (!ALL_EQ(p[i], zero)) {
 203             return i * sizeof(VECTYPE);
 204         }
 205     }
 206
 207     for (i = BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR;
 208          i < len / sizeof(VECTYPE);
 209          i += BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR) {
 210         VECTYPE tmp0 = VEC_OR(p[i + 0], p[i + 1]);
 211         VECTYPE tmp1 = VEC_OR(p[i + 2], p[i + 3]);
 212         VECTYPE tmp2 = VEC_OR(p[i + 4], p[i + 5]);
 213         VECTYPE tmp3 = VEC_OR(p[i + 6], p[i + 7]);
 214         VECTYPE tmp01 = VEC_OR(tmp0, tmp1);
 215         VECTYPE tmp23 = VEC_OR(tmp2, tmp3);
 216         if (!ALL_EQ(VEC_OR(tmp01, tmp23), zero)) {
 217             break;
 218         }
 219     }
 220
 221     return i * sizeof(VECTYPE);
 222 }
 223
 224 /*
 225  * Checks if a buffer is all zeroes
 226  *
 227  * Attention! The len must be a multiple of 4 * sizeof(long) due to
 228  * restriction of optimizations in this function.
 229  */
 230 bool buffer_is_zero(const void *buf, size_t len)
 231 {
 232     /*
 233      * Use long as the biggest available internal data type that fits into the
 234      * CPU register and unroll the loop to smooth out the effect of memory
 235      * latency.
 236      */
 237
 238     size_t i;
 239     long d0, d1, d2, d3;
 240     const long * const data = buf;
 241
 242     /* use vector optimized zero check if possible */
 243     if (can_use_buffer_find_nonzero_offset(buf, len)) {
 244         return buffer_find_nonzero_offset(buf, len) == len;
 245     }
 246
 247     assert(len % (4 * sizeof(long)) == 0);
 248     len /= sizeof(long);
 249
 250     for (i = 0; i < len; i += 4) {
 251         d0 = data[i + 0];
 252         d1 = data[i + 1];
 253         d2 = data[i + 2];
 254         d3 = data[i + 3];
 255
 256         if (d0 || d1 || d2 || d3) {
 257             return false;
 258         }
 259     }
 260
 261     return true;
 262 }
 263
 264 #ifndef _WIN32
 265 /* Sets a specific flag */
 266 int fcntl_setfl(int fd, int flag)
 267 {
 268     int flags;
 269
 270     flags = fcntl(fd, F_GETFL);
 271     if (flags == -1)
 272         return -errno;
 273
 274     if (fcntl(fd, F_SETFL, flags | flag) == -1)
 275         return -errno;
 276
 277     return 0;
 278 }
 279 #endif
 280
 281 static int64_t suffix_mul(char suffix, int64_t unit)
 282 {
 283     switch (qemu_toupper(suffix)) {
 284     case STRTOSZ_DEFSUFFIX_B:
 285         return 1;
 286     case STRTOSZ_DEFSUFFIX_KB:
 287         return unit;
 288     case STRTOSZ_DEFSUFFIX_MB:
 289         return unit * unit;
 290     case STRTOSZ_DEFSUFFIX_GB:
 291         return unit * unit * unit;
 292     case STRTOSZ_DEFSUFFIX_TB:
 293         return unit * unit * unit * unit;
 294     case STRTOSZ_DEFSUFFIX_PB:
 295         return unit * unit * unit * unit * unit;
 296     case STRTOSZ_DEFSUFFIX_EB:
 297         return unit * unit * unit * unit * unit * unit;
 298     }
 299     return -1;
 300 }
 301
 302 /*
 303  * Convert string to bytes, allowing either B/b for bytes, K/k for KB,
 304  * M/m for MB, G/g for GB or T/t for TB. End pointer will be returned
 305  * in *end, if not NULL. Return -ERANGE on overflow, Return -EINVAL on
 306  * other error.
 307  */
 308 int64_t strtosz_suffix_unit(const char *nptr, char **end,
 309                             const char default_suffix, int64_t unit)
 310 {
 311     int64_t retval = -EINVAL;
 312     char *endptr;
 313     unsigned char c;
 314     int mul_required = 0;
 315     double val, mul, integral, fraction;
 316
 317     errno = 0;
 318     val = strtod(nptr, &endptr);
 319     if (isnan(val) || endptr == nptr || errno != 0) {
 320         goto fail;
 321     }
 322     fraction = modf(val, &integral);
 323     if (fraction != 0) {
 324         mul_required = 1;
 325     }
 326     c = *endptr;
 327     mul = suffix_mul(c, unit);
 328     if (mul >= 0) {
 329         endptr++;
 330     } else {
 331         mul = suffix_mul(default_suffix, unit);
 332         assert(mul >= 0);
 333     }
 334     if (mul == 1 && mul_required) {
 335         goto fail;
 336     }
 337     if ((val * mul >= INT64_MAX) || val < 0) {
 338         retval = -ERANGE;
 339         goto fail;
 340     }
 341     retval = val * mul;
 342
 343 fail:
 344     if (end) {
 345         *end = endptr;
 346     }
 347
 348     return retval;
 349 }
 350
 351 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix)
 352 {
 353     return strtosz_suffix_unit(nptr, end, default_suffix, 1024);
 354 }
 355
 356 int64_t strtosz(const char *nptr, char **end)
 357 {
 358     return strtosz_suffix(nptr, end, STRTOSZ_DEFSUFFIX_MB);
 359 }
 360
 361 /**
 362  * Helper function for qemu_strto*l() functions.
 363  */
 364 static int check_strtox_error(const char **next, char *endptr,
 365                               int err)
 366 {
 367     if (!next && *endptr) {
 368         return -EINVAL;
 369     }
 370     if (next) {
 371         *next = endptr;
 372     }
 373     return -err;
 374 }
 375
 376 /**
 377  * QEMU wrappers for strtol(), strtoll(), strtoul(), strotull() C functions.
 378  *
 379  * Convert ASCII string @nptr to a long integer value
 380  * from the given @base. Parameters @nptr, @endptr, @base
 381  * follows same semantics as strtol() C function.
 382  *
 383  * Unlike from strtol() function, if @endptr is not NULL, this
 384  * function will return -EINVAL whenever it cannot fully convert
 385  * the string in @nptr with given @base to a long. This function returns
 386  * the result of the conversion only through the @result parameter.
 387  *
 388  * If NULL is passed in @endptr, then the whole string in @ntpr
 389  * is a number otherwise it returns -EINVAL.
 390  *
 391  * RETURN VALUE
 392  * Unlike from strtol() function, this wrapper returns either
 393  * -EINVAL or the errno set by strtol() function (e.g -ERANGE).
 394  * If the conversion overflows, -ERANGE is returned, and @result
 395  * is set to the max value of the desired type
 396  * (e.g. LONG_MAX, LLONG_MAX, ULONG_MAX, ULLONG_MAX). If the case
 397  * of underflow, -ERANGE is returned, and @result is set to the min
 398  * value of the desired type. For strtol(), strtoll(), @result is set to
 399  * LONG_MIN, LLONG_MIN, respectively, and for strtoul(), strtoull() it
 400  * is set to 0.
 401  */
 402 int qemu_strtol(const char *nptr, const char **endptr, int base,
 403                 long *result)
 404 {
 405     char *p;
 406     int err = 0;
 407     if (!nptr) {
 408         if (endptr) {
 409             *endptr = nptr;
 410         }
 411         err = -EINVAL;
 412     } else {
 413         errno = 0;
 414         *result = strtol(nptr, &p, base);
 415         err = check_strtox_error(endptr, p, errno);
 416     }
 417     return err;
 418 }
 419
 420 /**
 421  * Converts ASCII string to an unsigned long integer.
 422  *
 423  * If string contains a negative number, value will be converted to
 424  * the unsigned representation of the signed value, unless the original
 425  * (nonnegated) value would overflow, in this case, it will set @result
 426  * to ULONG_MAX, and return ERANGE.
 427  *
 428  * The same behavior holds, for qemu_strtoull() but sets @result to
 429  * ULLONG_MAX instead of ULONG_MAX.
 430  *
 431  * See qemu_strtol() documentation for more info.
 432  */
 433 int qemu_strtoul(const char *nptr, const char **endptr, int base,
 434                  unsigned long *result)
 435 {
 436     char *p;
 437     int err = 0;
 438     if (!nptr) {
 439         if (endptr) {
 440             *endptr = nptr;
 441         }
 442         err = -EINVAL;
 443     } else {
 444         errno = 0;
 445         *result = strtoul(nptr, &p, base);
 446         err = check_strtox_error(endptr, p, errno);
 447     }
 448     return err;
 449 }
 450
 451 /**
 452  * Converts ASCII string to a long long integer.
 453  *
 454  * See qemu_strtol() documentation for more info.
 455  */
 456 int qemu_strtoll(const char *nptr, const char **endptr, int base,
 457                  int64_t *result)
 458 {
 459     char *p;
 460     int err = 0;
 461     if (!nptr) {
 462         if (endptr) {
 463             *endptr = nptr;
 464         }
 465         err = -EINVAL;
 466     } else {
 467         errno = 0;
 468         *result = strtoll(nptr, &p, base);
 469         err = check_strtox_error(endptr, p, errno);
 470     }
 471     return err;
 472 }
 473
 474 /**
 475  * Converts ASCII string to an unsigned long long integer.
 476  *
 477  * See qemu_strtol() documentation for more info.
 478  */
 479 int qemu_strtoull(const char *nptr, const char **endptr, int base,
 480                   uint64_t *result)
 481 {
 482     char *p;
 483     int err = 0;
 484     if (!nptr) {
 485         if (endptr) {
 486             *endptr = nptr;
 487         }
 488         err = -EINVAL;
 489     } else {
 490         errno = 0;
 491         *result = strtoull(nptr, &p, base);
 492         err = check_strtox_error(endptr, p, errno);
 493     }
 494     return err;
 495 }
 496
 497 /**
 498  * parse_uint:
 499  *
 500  * @s: String to parse
 501  * @value: Destination for parsed integer value
 502  * @endptr: Destination for pointer to first character not consumed
 503  * @base: integer base, between 2 and 36 inclusive, or 0
 504  *
 505  * Parse unsigned integer
 506  *
 507  * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
 508  * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
 509  *
 510  * If @s is null, or @base is invalid, or @s doesn't start with an
 511  * integer in the syntax above, set *@value to 0, *@endptr to @s, and
 512  * return -EINVAL.
 513  *
 514  * Set *@endptr to point right beyond the parsed integer (even if the integer
 515  * overflows or is negative, all digits will be parsed and *@endptr will
 516  * point right beyond them).
 517  *
 518  * If the integer is negative, set *@value to 0, and return -ERANGE.
 519  *
 520  * If the integer overflows unsigned long long, set *@value to
 521  * ULLONG_MAX, and return -ERANGE.
 522  *
 523  * Else, set *@value to the parsed integer, and return 0.
 524  */
 525 int parse_uint(const char *s, unsigned long long *value, char **endptr,
 526                int base)
 527 {
 528     int r = 0;
 529     char *endp = (char *)s;
 530     unsigned long long val = 0;
 531
 532     if (!s) {
 533         r = -EINVAL;
 534         goto out;
 535     }
 536
 537     errno = 0;
 538     val = strtoull(s, &endp, base);
 539     if (errno) {
 540         r = -errno;
 541         goto out;
 542     }
 543
 544     if (endp == s) {
 545         r = -EINVAL;
 546         goto out;
 547     }
 548
 549     /* make sure we reject negative numbers: */
 550     while (isspace((unsigned char)*s)) {
 551         s++;
 552     }
 553     if (*s == '-') {
 554         val = 0;
 555         r = -ERANGE;
 556         goto out;
 557     }
 558
 559 out:
 560     *value = val;
 561     *endptr = endp;
 562     return r;
 563 }
 564
 565 /**
 566  * parse_uint_full:
 567  *
 568  * @s: String to parse
 569  * @value: Destination for parsed integer value
 570  * @base: integer base, between 2 and 36 inclusive, or 0
 571  *
 572  * Parse unsigned integer from entire string
 573  *
 574  * Have the same behavior of parse_uint(), but with an additional check
 575  * for additional data after the parsed number. If extra characters are present
 576  * after the parsed number, the function will return -EINVAL, and *@v will
 577  * be set to 0.
 578  */
 579 int parse_uint_full(const char *s, unsigned long long *value, int base)
 580 {
 581     char *endp;
 582     int r;
 583
 584     r = parse_uint(s, value, &endp, base);
 585     if (r < 0) {
 586         return r;
 587     }
 588     if (*endp) {
 589         *value = 0;
 590         return -EINVAL;
 591     }
 592
 593     return 0;
 594 }
 595
 596 int qemu_parse_fd(const char *param)
 597 {
 598     long fd;
 599     char *endptr;
 600
 601     errno = 0;
 602     fd = strtol(param, &endptr, 10);
 603     if (param == endptr /* no conversion performed */                    ||
 604         errno != 0      /* not representable as long; possibly others */ ||
 605         *endptr != '\0' /* final string not empty */                     ||
 606         fd < 0          /* invalid as file descriptor */                 ||
 607         fd > INT_MAX    /* not representable as int */) {
 608         return -1;
 609     }
 610     return fd;
 611 }
 612
 613 /* round down to the nearest power of 2*/
 614 int64_t pow2floor(int64_t value)
 615 {
 616     if (!is_power_of_2(value)) {
 617         value = 0x8000000000000000ULL >> clz64(value);
 618     }
 619     return value;
 620 }
 621
 622 /* round up to the nearest power of 2 (0 if overflow) */
 623 uint64_t pow2ceil(uint64_t value)
 624 {
 625     uint8_t nlz = clz64(value);
 626
 627     if (is_power_of_2(value)) {
 628         return value;
 629     }
 630     if (!nlz) {
 631         return 0;
 632     }
 633     return 1ULL << (64 - nlz);
 634 }
 635
 636 /*
 637  * Implementation of  ULEB128 (http://en.wikipedia.org/wiki/LEB128)
 638  * Input is limited to 14-bit numbers
 639  */
 640 int uleb128_encode_small(uint8_t *out, uint32_t n)
 641 {
 642     g_assert(n <= 0x3fff);
 643     if (n < 0x80) {
 644         *out++ = n;
 645         return 1;
 646     } else {
 647         *out++ = (n & 0x7f) | 0x80;
 648         *out++ = n >> 7;
 649         return 2;
 650     }
 651 }
 652
 653 int uleb128_decode_small(const uint8_t *in, uint32_t *n)
 654 {
 655     if (!(*in & 0x80)) {
 656         *n = *in++;
 657         return 1;
 658     } else {
 659         *n = *in++ & 0x7f;
 660         /* we exceed 14 bit number */
 661         if (*in & 0x80) {
 662             return -1;
 663         }
 664         *n |= *in++ << 7;
 665         return 2;
 666     }
 667 }
 668
 669 /*
 670  * helper to parse debug environment variables
 671  */
 672 int parse_debug_env(const char *name, int max, int initial)
 673 {
 674     char *debug_env = getenv(name);
 675     char *inv = NULL;
 676     long debug;
 677
 678     if (!debug_env) {
 679         return initial;
 680     }
 681     errno = 0;
 682     debug = strtol(debug_env, &inv, 10);
 683     if (inv == debug_env) {
 684         return initial;
 685     }
 686     if (debug < 0 || debug > max || errno != 0) {
 687         fprintf(stderr, "warning: %s not in [0, %d]", name, max);
 688         return initial;
 689     }
 690     return debug;
 691 }
 692
 693 /*
 694  * Helper to print ethernet mac address
 695  */
 696 const char *qemu_ether_ntoa(const MACAddr *mac)
 697 {
 698     static char ret[18];
 699
 700     snprintf(ret, sizeof(ret), "%02x:%02x:%02x:%02x:%02x:%02x",
 701              mac->a[0], mac->a[1], mac->a[2], mac->a[3], mac->a[4], mac->a[5]);
 702
 703     return ret;
 704 }