2 * Simple C functions to supplement the C library
4 * Copyright (c) 2006 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
24 #include "qemu/osdep.h"
25 #include "qemu-common.h"
26 #include "qemu/host-utils.h"
29 #include "qemu/sockets.h"
32 #include "qemu/cutils.h"
33 #include "qemu/error-report.h"
35 void strpadcpy(char *buf, int buf_size, const char *str, char pad)
37 int len = qemu_strnlen(str, buf_size);
38 memcpy(buf, str, len);
39 memset(buf + len, pad, buf_size - len);
42 void pstrcpy(char *buf, int buf_size, const char *str)
52 if (c == 0 || q >= buf + buf_size - 1)
59 /* strcat and truncate. */
60 char *pstrcat(char *buf, int buf_size, const char *s)
65 pstrcpy(buf + len, buf_size - len, s);
69 int strstart(const char *str, const char *val, const char **ptr)
85 int stristart(const char *str, const char *val, const char **ptr)
91 if (qemu_toupper(*p) != qemu_toupper(*q))
101 /* XXX: use host strnlen if available ? */
102 int qemu_strnlen(const char *s, int max_len)
106 for(i = 0; i < max_len; i++) {
114 char *qemu_strsep(char **input, const char *delim)
116 char *result = *input;
117 if (result != NULL) {
120 for (p = result; *p != '\0'; p++) {
121 if (strchr(delim, *p)) {
135 time_t mktimegm(struct tm *tm)
138 int y = tm->tm_year + 1900, m = tm->tm_mon + 1, d = tm->tm_mday;
143 t = 86400ULL * (d + (153 * m - 457) / 5 + 365 * y + y / 4 - y / 100 +
145 t += 3600 * tm->tm_hour + 60 * tm->tm_min + tm->tm_sec;
150 * Make sure data goes on disk, but if possible do not bother to
151 * write out the inode just for timestamp updates.
153 * Unfortunately even in 2009 many operating systems do not support
154 * fdatasync and have to fall back to fsync.
156 int qemu_fdatasync(int fd)
158 #ifdef CONFIG_FDATASYNC
159 return fdatasync(fd);
166 /* Sets a specific flag */
167 int fcntl_setfl(int fd, int flag)
171 flags = fcntl(fd, F_GETFL);
175 if (fcntl(fd, F_SETFL, flags | flag) == -1)
182 static int64_t suffix_mul(char suffix, int64_t unit)
184 switch (qemu_toupper(suffix)) {
192 return unit * unit * unit;
194 return unit * unit * unit * unit;
196 return unit * unit * unit * unit * unit;
198 return unit * unit * unit * unit * unit * unit;
204 * Convert string to bytes, allowing either B/b for bytes, K/k for KB,
205 * M/m for MB, G/g for GB or T/t for TB. End pointer will be returned
206 * in *end, if not NULL. Return -ERANGE on overflow, Return -EINVAL on
209 static int do_strtosz(const char *nptr, char **end,
210 const char default_suffix, int64_t unit,
216 int mul_required = 0;
217 double val, mul, integral, fraction;
220 val = strtod(nptr, &endptr);
221 if (isnan(val) || endptr == nptr || errno != 0) {
225 fraction = modf(val, &integral);
230 mul = suffix_mul(c, unit);
234 mul = suffix_mul(default_suffix, unit);
237 if (mul == 1 && mul_required) {
242 * Values >= 0xfffffffffffffc00 overflow uint64_t after their trip
243 * through double (53 bits of precision).
245 if ((val * mul >= 0xfffffffffffffc00) || val < 0) {
255 } else if (*endptr) {
262 int qemu_strtosz(const char *nptr, char **end, uint64_t *result)
264 return do_strtosz(nptr, end, 'B', 1024, result);
267 int qemu_strtosz_MiB(const char *nptr, char **end, uint64_t *result)
269 return do_strtosz(nptr, end, 'M', 1024, result);
272 int qemu_strtosz_metric(const char *nptr, char **end, uint64_t *result)
274 return do_strtosz(nptr, end, 'B', 1000, result);
278 * Helper function for error checking after strtol() and the like
280 static int check_strtox_error(const char *nptr, char *ep,
281 const char **endptr, int libc_errno)
288 /* Turn "no conversion" into an error */
289 if (libc_errno == 0 && ep == nptr) {
293 /* Fail when we're expected to consume the string, but didn't */
294 if (!endptr && *ep) {
302 * Convert string @nptr to an integer, and store it in @result.
304 * This is a wrapper around strtol() that is harder to misuse.
305 * Semantics of @nptr, @endptr, @base match strtol() with differences
308 * @nptr may be null, and no conversion is performed then.
310 * If no conversion is performed, store @nptr in *@endptr and return
313 * If @endptr is null, and the string isn't fully converted, return
314 * -EINVAL. This is the case when the pointer that would be stored in
315 * a non-null @endptr points to a character other than '\0'.
317 * If the conversion overflows @result, store INT_MAX in @result,
318 * and return -ERANGE.
320 * If the conversion underflows @result, store INT_MIN in @result,
321 * and return -ERANGE.
323 * Else store the converted value in @result, and return zero.
325 int qemu_strtoi(const char *nptr, const char **endptr, int base,
331 assert((unsigned) base <= 36 && base != 1);
340 lresult = strtoll(nptr, &ep, base);
341 if (lresult < INT_MIN) {
344 } else if (lresult > INT_MAX) {
350 return check_strtox_error(nptr, ep, endptr, errno);
354 * Convert string @nptr to an unsigned integer, and store it in @result.
356 * This is a wrapper around strtoul() that is harder to misuse.
357 * Semantics of @nptr, @endptr, @base match strtoul() with differences
360 * @nptr may be null, and no conversion is performed then.
362 * If no conversion is performed, store @nptr in *@endptr and return
365 * If @endptr is null, and the string isn't fully converted, return
366 * -EINVAL. This is the case when the pointer that would be stored in
367 * a non-null @endptr points to a character other than '\0'.
369 * If the conversion overflows @result, store UINT_MAX in @result,
370 * and return -ERANGE.
372 * Else store the converted value in @result, and return zero.
374 * Note that a number with a leading minus sign gets converted without
375 * the minus sign, checked for overflow (see above), then negated (in
376 * @result's type). This is exactly how strtoul() works.
378 int qemu_strtoui(const char *nptr, const char **endptr, int base,
379 unsigned int *result)
384 assert((unsigned) base <= 36 && base != 1);
393 lresult = strtoull(nptr, &ep, base);
395 /* Windows returns 1 for negative out-of-range values. */
396 if (errno == ERANGE) {
399 if (lresult > UINT_MAX) {
402 } else if (lresult < INT_MIN) {
409 return check_strtox_error(nptr, ep, endptr, errno);
413 * Convert string @nptr to a long integer, and store it in @result.
415 * This is a wrapper around strtol() that is harder to misuse.
416 * Semantics of @nptr, @endptr, @base match strtol() with differences
419 * @nptr may be null, and no conversion is performed then.
421 * If no conversion is performed, store @nptr in *@endptr and return
424 * If @endptr is null, and the string isn't fully converted, return
425 * -EINVAL. This is the case when the pointer that would be stored in
426 * a non-null @endptr points to a character other than '\0'.
428 * If the conversion overflows @result, store LONG_MAX in @result,
429 * and return -ERANGE.
431 * If the conversion underflows @result, store LONG_MIN in @result,
432 * and return -ERANGE.
434 * Else store the converted value in @result, and return zero.
436 int qemu_strtol(const char *nptr, const char **endptr, int base,
441 assert((unsigned) base <= 36 && base != 1);
450 *result = strtol(nptr, &ep, base);
451 return check_strtox_error(nptr, ep, endptr, errno);
455 * Convert string @nptr to an unsigned long, and store it in @result.
457 * This is a wrapper around strtoul() that is harder to misuse.
458 * Semantics of @nptr, @endptr, @base match strtoul() with differences
461 * @nptr may be null, and no conversion is performed then.
463 * If no conversion is performed, store @nptr in *@endptr and return
466 * If @endptr is null, and the string isn't fully converted, return
467 * -EINVAL. This is the case when the pointer that would be stored in
468 * a non-null @endptr points to a character other than '\0'.
470 * If the conversion overflows @result, store ULONG_MAX in @result,
471 * and return -ERANGE.
473 * Else store the converted value in @result, and return zero.
475 * Note that a number with a leading minus sign gets converted without
476 * the minus sign, checked for overflow (see above), then negated (in
477 * @result's type). This is exactly how strtoul() works.
479 int qemu_strtoul(const char *nptr, const char **endptr, int base,
480 unsigned long *result)
484 assert((unsigned) base <= 36 && base != 1);
493 *result = strtoul(nptr, &ep, base);
494 /* Windows returns 1 for negative out-of-range values. */
495 if (errno == ERANGE) {
498 return check_strtox_error(nptr, ep, endptr, errno);
502 * Convert string @nptr to an int64_t.
504 * Works like qemu_strtol(), except it stores INT64_MAX on overflow,
505 * and INT_MIN on underflow.
507 int qemu_strtoi64(const char *nptr, const char **endptr, int base,
512 assert((unsigned) base <= 36 && base != 1);
521 /* FIXME This assumes int64_t is long long */
522 *result = strtoll(nptr, &ep, base);
523 return check_strtox_error(nptr, ep, endptr, errno);
527 * Convert string @nptr to an uint64_t.
529 * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow.
531 int qemu_strtou64(const char *nptr, const char **endptr, int base,
536 assert((unsigned) base <= 36 && base != 1);
545 /* FIXME This assumes uint64_t is unsigned long long */
546 *result = strtoull(nptr, &ep, base);
547 /* Windows returns 1 for negative out-of-range values. */
548 if (errno == ERANGE) {
551 return check_strtox_error(nptr, ep, endptr, errno);
555 * Searches for the first occurrence of 'c' in 's', and returns a pointer
556 * to the trailing null byte if none was found.
558 #ifndef HAVE_STRCHRNUL
559 const char *qemu_strchrnul(const char *s, int c)
561 const char *e = strchr(s, c);
572 * @s: String to parse
573 * @value: Destination for parsed integer value
574 * @endptr: Destination for pointer to first character not consumed
575 * @base: integer base, between 2 and 36 inclusive, or 0
577 * Parse unsigned integer
579 * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
580 * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
582 * If @s is null, or @base is invalid, or @s doesn't start with an
583 * integer in the syntax above, set *@value to 0, *@endptr to @s, and
586 * Set *@endptr to point right beyond the parsed integer (even if the integer
587 * overflows or is negative, all digits will be parsed and *@endptr will
588 * point right beyond them).
590 * If the integer is negative, set *@value to 0, and return -ERANGE.
592 * If the integer overflows unsigned long long, set *@value to
593 * ULLONG_MAX, and return -ERANGE.
595 * Else, set *@value to the parsed integer, and return 0.
597 int parse_uint(const char *s, unsigned long long *value, char **endptr,
601 char *endp = (char *)s;
602 unsigned long long val = 0;
604 assert((unsigned) base <= 36 && base != 1);
611 val = strtoull(s, &endp, base);
622 /* make sure we reject negative numbers: */
623 while (isspace((unsigned char)*s)) {
641 * @s: String to parse
642 * @value: Destination for parsed integer value
643 * @base: integer base, between 2 and 36 inclusive, or 0
645 * Parse unsigned integer from entire string
647 * Have the same behavior of parse_uint(), but with an additional check
648 * for additional data after the parsed number. If extra characters are present
649 * after the parsed number, the function will return -EINVAL, and *@v will
652 int parse_uint_full(const char *s, unsigned long long *value, int base)
657 r = parse_uint(s, value, &endp, base);
669 int qemu_parse_fd(const char *param)
675 fd = strtol(param, &endptr, 10);
676 if (param == endptr /* no conversion performed */ ||
677 errno != 0 /* not representable as long; possibly others */ ||
678 *endptr != '\0' /* final string not empty */ ||
679 fd < 0 /* invalid as file descriptor */ ||
680 fd > INT_MAX /* not representable as int */) {
687 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
688 * Input is limited to 14-bit numbers
690 int uleb128_encode_small(uint8_t *out, uint32_t n)
692 g_assert(n <= 0x3fff);
697 *out++ = (n & 0x7f) | 0x80;
703 int uleb128_decode_small(const uint8_t *in, uint32_t *n)
710 /* we exceed 14 bit number */
720 * helper to parse debug environment variables
722 int parse_debug_env(const char *name, int max, int initial)
724 char *debug_env = getenv(name);
732 debug = strtol(debug_env, &inv, 10);
733 if (inv == debug_env) {
736 if (debug < 0 || debug > max || errno != 0) {
737 warn_report("%s not in [0, %d]", name, max);
744 * Helper to print ethernet mac address
746 const char *qemu_ether_ntoa(const MACAddr *mac)
750 snprintf(ret, sizeof(ret), "%02x:%02x:%02x:%02x:%02x:%02x",
751 mac->a[0], mac->a[1], mac->a[2], mac->a[3], mac->a[4], mac->a[5]);
757 * Return human readable string for size @val.
758 * @val can be anything that uint64_t allows (no more than "16 EiB").
759 * Use IEC binary units like KiB, MiB, and so forth.
760 * Caller is responsible for passing it to g_free().
762 char *size_to_str(uint64_t val)
764 static const char *suffixes[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
769 * The exponent (returned in i) minus one gives us
770 * floor(log2(val * 1024 / 1000). The correction makes us
771 * switch to the higher power when the integer part is >= 1000.
772 * (see e41b509d68afb1f for more info)
774 frexp(val / (1000.0 / 1024.0), &i);
776 div = 1ULL << (i * 10);
778 return g_strdup_printf("%0.3g %sB", (double)val / div, suffixes[i]);
781 int qemu_pstrcmp0(const char **str1, const char **str2)
783 return g_strcmp0(*str1, *str2);