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
25 #include "qemu/osdep.h"
26 #include "qemu/host-utils.h"
30 #include <sys/sysctl.h>
35 #include <sys/sysctl.h>
39 #include <kernel/image.h>
43 #include <mach-o/dyld.h>
51 #include "qemu/ctype.h"
52 #include "qemu/cutils.h"
53 #include "qemu/error-report.h"
55 void strpadcpy(char *buf, int buf_size, const char *str, char pad)
57 int len = qemu_strnlen(str, buf_size);
58 memcpy(buf, str, len);
59 memset(buf + len, pad, buf_size - len);
62 void pstrcpy(char *buf, int buf_size, const char *str)
72 if (c == 0 || q >= buf + buf_size - 1)
79 /* strcat and truncate. */
80 char *pstrcat(char *buf, int buf_size, const char *s)
85 pstrcpy(buf + len, buf_size - len, s);
89 int strstart(const char *str, const char *val, const char **ptr)
105 int stristart(const char *str, const char *val, const char **ptr)
111 if (qemu_toupper(*p) != qemu_toupper(*q))
121 /* XXX: use host strnlen if available ? */
122 int qemu_strnlen(const char *s, int max_len)
126 for(i = 0; i < max_len; i++) {
134 char *qemu_strsep(char **input, const char *delim)
136 char *result = *input;
137 if (result != NULL) {
140 for (p = result; *p != '\0'; p++) {
141 if (strchr(delim, *p)) {
155 time_t mktimegm(struct tm *tm)
158 int y = tm->tm_year + 1900, m = tm->tm_mon + 1, d = tm->tm_mday;
163 t = 86400ULL * (d + (153 * m - 457) / 5 + 365 * y + y / 4 - y / 100 +
165 t += 3600 * tm->tm_hour + 60 * tm->tm_min + tm->tm_sec;
169 static int64_t suffix_mul(char suffix, int64_t unit)
171 switch (qemu_toupper(suffix)) {
179 return unit * unit * unit;
181 return unit * unit * unit * unit;
183 return unit * unit * unit * unit * unit;
185 return unit * unit * unit * unit * unit * unit;
191 * Convert size string to bytes.
193 * The size parsing supports the following syntaxes
194 * - 12345 - decimal, scale determined by @default_suffix and @unit
195 * - 12345{bBkKmMgGtTpPeE} - decimal, scale determined by suffix and @unit
196 * - 12345.678{kKmMgGtTpPeE} - decimal, scale determined by suffix, and
197 * fractional portion is truncated to byte
198 * - 0x7fEE - hexadecimal, unit determined by @default_suffix
200 * The following cause a deprecation warning, and may be removed in the future
201 * - 0xabc{kKmMgGtTpP} - hex with scaling suffix
203 * The following are intentionally not supported
204 * - octal, such as 08
205 * - fractional hex, such as 0x1.8
206 * - floating point exponents, such as 1e3
208 * The end pointer will be returned in *end, if not NULL. If there is
209 * no fraction, the input can be decimal or hexadecimal; if there is a
210 * fraction, then the input must be decimal and there must be a suffix
211 * (possibly by @default_suffix) larger than Byte, and the fractional
212 * portion may suffer from precision loss or rounding. The input must
215 * Return -ERANGE on overflow (with *@end advanced), and -EINVAL on
216 * other error (with *@end left unchanged).
218 static int do_strtosz(const char *nptr, const char **end,
219 const char default_suffix, int64_t unit,
223 const char *endptr, *f;
226 uint64_t val, valf = 0;
229 /* Parse integral portion as decimal. */
230 retval = qemu_strtou64(nptr, &endptr, 10, &val);
234 if (memchr(nptr, '-', endptr - nptr) != NULL) {
239 if (val == 0 && (*endptr == 'x' || *endptr == 'X')) {
240 /* Input looks like hex, reparse, and insist on no fraction. */
241 retval = qemu_strtou64(nptr, &endptr, 16, &val);
245 if (*endptr == '.') {
251 } else if (*endptr == '.') {
253 * Input looks like a fraction. Make sure even 1.k works
254 * without fractional digits. If we see an exponent, treat
255 * the entire input as invalid instead.
260 retval = qemu_strtod_finite(f, &endptr, &fraction);
263 } else if (memchr(f, 'e', endptr - f) || memchr(f, 'E', endptr - f)) {
268 /* Extract into a 64-bit fixed-point fraction. */
269 valf = (uint64_t)(fraction * 0x1p64);
273 mul = suffix_mul(c, unit);
276 warn_report("Using a multiplier suffix on hex numbers "
277 "is deprecated: %s", nptr);
281 mul = suffix_mul(default_suffix, unit);
285 /* When a fraction is present, a scale is required. */
294 /* Compute exact result: 64.64 x 64.0 -> 128.64 fixed point */
295 mulu64(&val, &valh, val, mul);
296 mulu64(&valf, &tmp, valf, mul);
300 /* Round 0.5 upward. */
305 /* Report overflow. */
317 } else if (*endptr) {
327 int qemu_strtosz(const char *nptr, const char **end, uint64_t *result)
329 return do_strtosz(nptr, end, 'B', 1024, result);
332 int qemu_strtosz_MiB(const char *nptr, const char **end, uint64_t *result)
334 return do_strtosz(nptr, end, 'M', 1024, result);
337 int qemu_strtosz_metric(const char *nptr, const char **end, uint64_t *result)
339 return do_strtosz(nptr, end, 'B', 1000, result);
343 * Helper function for error checking after strtol() and the like
345 static int check_strtox_error(const char *nptr, char *ep,
346 const char **endptr, bool check_zero,
351 /* Windows has a bug in that it fails to parse 0 from "0x" in base 16 */
352 if (check_zero && ep == nptr && libc_errno == 0) {
356 if (strtol(nptr, &tmp, 10) == 0 && errno == 0 &&
357 (*tmp == 'x' || *tmp == 'X')) {
366 /* Turn "no conversion" into an error */
367 if (libc_errno == 0 && ep == nptr) {
371 /* Fail when we're expected to consume the string, but didn't */
372 if (!endptr && *ep) {
380 * Convert string @nptr to an integer, and store it in @result.
382 * This is a wrapper around strtol() that is harder to misuse.
383 * Semantics of @nptr, @endptr, @base match strtol() with differences
386 * @nptr may be null, and no conversion is performed then.
388 * If no conversion is performed, store @nptr in *@endptr and return
391 * If @endptr is null, and the string isn't fully converted, return
392 * -EINVAL. This is the case when the pointer that would be stored in
393 * a non-null @endptr points to a character other than '\0'.
395 * If the conversion overflows @result, store INT_MAX in @result,
396 * and return -ERANGE.
398 * If the conversion underflows @result, store INT_MIN in @result,
399 * and return -ERANGE.
401 * Else store the converted value in @result, and return zero.
403 int qemu_strtoi(const char *nptr, const char **endptr, int base,
409 assert((unsigned) base <= 36 && base != 1);
418 lresult = strtoll(nptr, &ep, base);
419 if (lresult < INT_MIN) {
422 } else if (lresult > INT_MAX) {
428 return check_strtox_error(nptr, ep, endptr, lresult == 0, errno);
432 * Convert string @nptr to an unsigned integer, and store it in @result.
434 * This is a wrapper around strtoul() that is harder to misuse.
435 * Semantics of @nptr, @endptr, @base match strtoul() with differences
438 * @nptr may be null, and no conversion is performed then.
440 * If no conversion is performed, store @nptr in *@endptr and return
443 * If @endptr is null, and the string isn't fully converted, return
444 * -EINVAL. This is the case when the pointer that would be stored in
445 * a non-null @endptr points to a character other than '\0'.
447 * If the conversion overflows @result, store UINT_MAX in @result,
448 * and return -ERANGE.
450 * Else store the converted value in @result, and return zero.
452 * Note that a number with a leading minus sign gets converted without
453 * the minus sign, checked for overflow (see above), then negated (in
454 * @result's type). This is exactly how strtoul() works.
456 int qemu_strtoui(const char *nptr, const char **endptr, int base,
457 unsigned int *result)
462 assert((unsigned) base <= 36 && base != 1);
471 lresult = strtoull(nptr, &ep, base);
473 /* Windows returns 1 for negative out-of-range values. */
474 if (errno == ERANGE) {
477 if (lresult > UINT_MAX) {
480 } else if (lresult < INT_MIN) {
487 return check_strtox_error(nptr, ep, endptr, lresult == 0, errno);
491 * Convert string @nptr to a long integer, and store it in @result.
493 * This is a wrapper around strtol() that is harder to misuse.
494 * Semantics of @nptr, @endptr, @base match strtol() with differences
497 * @nptr may be null, and no conversion is performed then.
499 * If no conversion is performed, store @nptr in *@endptr and return
502 * If @endptr is null, and the string isn't fully converted, return
503 * -EINVAL. This is the case when the pointer that would be stored in
504 * a non-null @endptr points to a character other than '\0'.
506 * If the conversion overflows @result, store LONG_MAX in @result,
507 * and return -ERANGE.
509 * If the conversion underflows @result, store LONG_MIN in @result,
510 * and return -ERANGE.
512 * Else store the converted value in @result, and return zero.
514 int qemu_strtol(const char *nptr, const char **endptr, int base,
519 assert((unsigned) base <= 36 && base != 1);
528 *result = strtol(nptr, &ep, base);
529 return check_strtox_error(nptr, ep, endptr, *result == 0, errno);
533 * Convert string @nptr to an unsigned long, and store it in @result.
535 * This is a wrapper around strtoul() that is harder to misuse.
536 * Semantics of @nptr, @endptr, @base match strtoul() with differences
539 * @nptr may be null, and no conversion is performed then.
541 * If no conversion is performed, store @nptr in *@endptr and return
544 * If @endptr is null, and the string isn't fully converted, return
545 * -EINVAL. This is the case when the pointer that would be stored in
546 * a non-null @endptr points to a character other than '\0'.
548 * If the conversion overflows @result, store ULONG_MAX in @result,
549 * and return -ERANGE.
551 * Else store the converted value in @result, and return zero.
553 * Note that a number with a leading minus sign gets converted without
554 * the minus sign, checked for overflow (see above), then negated (in
555 * @result's type). This is exactly how strtoul() works.
557 int qemu_strtoul(const char *nptr, const char **endptr, int base,
558 unsigned long *result)
562 assert((unsigned) base <= 36 && base != 1);
571 *result = strtoul(nptr, &ep, base);
572 /* Windows returns 1 for negative out-of-range values. */
573 if (errno == ERANGE) {
576 return check_strtox_error(nptr, ep, endptr, *result == 0, errno);
580 * Convert string @nptr to an int64_t.
582 * Works like qemu_strtol(), except it stores INT64_MAX on overflow,
583 * and INT64_MIN on underflow.
585 int qemu_strtoi64(const char *nptr, const char **endptr, int base,
590 assert((unsigned) base <= 36 && base != 1);
598 /* This assumes int64_t is long long TODO relax */
599 QEMU_BUILD_BUG_ON(sizeof(int64_t) != sizeof(long long));
601 *result = strtoll(nptr, &ep, base);
602 return check_strtox_error(nptr, ep, endptr, *result == 0, errno);
606 * Convert string @nptr to an uint64_t.
608 * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow.
610 int qemu_strtou64(const char *nptr, const char **endptr, int base,
615 assert((unsigned) base <= 36 && base != 1);
623 /* This assumes uint64_t is unsigned long long TODO relax */
624 QEMU_BUILD_BUG_ON(sizeof(uint64_t) != sizeof(unsigned long long));
626 *result = strtoull(nptr, &ep, base);
627 /* Windows returns 1 for negative out-of-range values. */
628 if (errno == ERANGE) {
631 return check_strtox_error(nptr, ep, endptr, *result == 0, errno);
635 * Convert string @nptr to a double.
637 * This is a wrapper around strtod() that is harder to misuse.
638 * Semantics of @nptr and @endptr match strtod() with differences
641 * @nptr may be null, and no conversion is performed then.
643 * If no conversion is performed, store @nptr in *@endptr and return
646 * If @endptr is null, and the string isn't fully converted, return
647 * -EINVAL. This is the case when the pointer that would be stored in
648 * a non-null @endptr points to a character other than '\0'.
650 * If the conversion overflows, store +/-HUGE_VAL in @result, depending
651 * on the sign, and return -ERANGE.
653 * If the conversion underflows, store +/-0.0 in @result, depending on the
654 * sign, and return -ERANGE.
656 * Else store the converted value in @result, and return zero.
658 int qemu_strtod(const char *nptr, const char **endptr, double *result)
670 *result = strtod(nptr, &ep);
671 return check_strtox_error(nptr, ep, endptr, false, errno);
675 * Convert string @nptr to a finite double.
677 * Works like qemu_strtod(), except that "NaN" and "inf" are rejected
678 * with -EINVAL and no conversion is performed.
680 int qemu_strtod_finite(const char *nptr, const char **endptr, double *result)
685 ret = qemu_strtod(nptr, endptr, &tmp);
686 if (!ret && !isfinite(tmp)) {
693 if (ret != -EINVAL) {
700 * Searches for the first occurrence of 'c' in 's', and returns a pointer
701 * to the trailing null byte if none was found.
703 #ifndef HAVE_STRCHRNUL
704 const char *qemu_strchrnul(const char *s, int c)
706 const char *e = strchr(s, c);
717 * @s: String to parse
718 * @value: Destination for parsed integer value
719 * @endptr: Destination for pointer to first character not consumed
720 * @base: integer base, between 2 and 36 inclusive, or 0
722 * Parse unsigned integer
724 * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
725 * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
727 * If @s is null, or @base is invalid, or @s doesn't start with an
728 * integer in the syntax above, set *@value to 0, *@endptr to @s, and
731 * Set *@endptr to point right beyond the parsed integer (even if the integer
732 * overflows or is negative, all digits will be parsed and *@endptr will
733 * point right beyond them).
735 * If the integer is negative, set *@value to 0, and return -ERANGE.
737 * If the integer overflows unsigned long long, set *@value to
738 * ULLONG_MAX, and return -ERANGE.
740 * Else, set *@value to the parsed integer, and return 0.
742 int parse_uint(const char *s, unsigned long long *value, char **endptr,
746 char *endp = (char *)s;
747 unsigned long long val = 0;
749 assert((unsigned) base <= 36 && base != 1);
756 val = strtoull(s, &endp, base);
767 /* make sure we reject negative numbers: */
768 while (qemu_isspace(*s)) {
786 * @s: String to parse
787 * @value: Destination for parsed integer value
788 * @base: integer base, between 2 and 36 inclusive, or 0
790 * Parse unsigned integer from entire string
792 * Have the same behavior of parse_uint(), but with an additional check
793 * for additional data after the parsed number. If extra characters are present
794 * after the parsed number, the function will return -EINVAL, and *@v will
797 int parse_uint_full(const char *s, unsigned long long *value, int base)
802 r = parse_uint(s, value, &endp, base);
814 int qemu_parse_fd(const char *param)
820 fd = strtol(param, &endptr, 10);
821 if (param == endptr /* no conversion performed */ ||
822 errno != 0 /* not representable as long; possibly others */ ||
823 *endptr != '\0' /* final string not empty */ ||
824 fd < 0 /* invalid as file descriptor */ ||
825 fd > INT_MAX /* not representable as int */) {
832 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
833 * Input is limited to 14-bit numbers
835 int uleb128_encode_small(uint8_t *out, uint32_t n)
837 g_assert(n <= 0x3fff);
842 *out++ = (n & 0x7f) | 0x80;
848 int uleb128_decode_small(const uint8_t *in, uint32_t *n)
855 /* we exceed 14 bit number */
865 * helper to parse debug environment variables
867 int parse_debug_env(const char *name, int max, int initial)
869 char *debug_env = getenv(name);
877 debug = strtol(debug_env, &inv, 10);
878 if (inv == debug_env) {
881 if (debug < 0 || debug > max || errno != 0) {
882 warn_report("%s not in [0, %d]", name, max);
888 const char *si_prefix(unsigned int exp10)
890 static const char *prefixes[] = {
891 "a", "f", "p", "n", "u", "m", "", "K", "M", "G", "T", "P", "E"
895 assert(exp10 % 3 == 0 && exp10 / 3 < ARRAY_SIZE(prefixes));
896 return prefixes[exp10 / 3];
899 const char *iec_binary_prefix(unsigned int exp2)
901 static const char *prefixes[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
903 assert(exp2 % 10 == 0 && exp2 / 10 < ARRAY_SIZE(prefixes));
904 return prefixes[exp2 / 10];
908 * Return human readable string for size @val.
909 * @val can be anything that uint64_t allows (no more than "16 EiB").
910 * Use IEC binary units like KiB, MiB, and so forth.
911 * Caller is responsible for passing it to g_free().
913 char *size_to_str(uint64_t val)
919 * The exponent (returned in i) minus one gives us
920 * floor(log2(val * 1024 / 1000). The correction makes us
921 * switch to the higher power when the integer part is >= 1000.
922 * (see e41b509d68afb1f for more info)
924 frexp(val / (1000.0 / 1024.0), &i);
925 i = (i - 1) / 10 * 10;
928 return g_strdup_printf("%0.3g %sB", (double)val / div, iec_binary_prefix(i));
931 char *freq_to_str(uint64_t freq_hz)
933 double freq = freq_hz;
936 while (freq >= 1000.0) {
941 return g_strdup_printf("%0.3g %sHz", freq, si_prefix(exp10));
944 int qemu_pstrcmp0(const char **str1, const char **str2)
946 return g_strcmp0(*str1, *str2);
949 static inline bool starts_with_prefix(const char *dir)
951 size_t prefix_len = strlen(CONFIG_PREFIX);
952 return !memcmp(dir, CONFIG_PREFIX, prefix_len) &&
953 (!dir[prefix_len] || G_IS_DIR_SEPARATOR(dir[prefix_len]));
956 /* Return the next path component in dir, and store its length in *p_len. */
957 static inline const char *next_component(const char *dir, int *p_len)
960 while ((*dir && G_IS_DIR_SEPARATOR(*dir)) ||
961 (*dir == '.' && (G_IS_DIR_SEPARATOR(dir[1]) || dir[1] == '\0'))) {
965 while (dir[len] && !G_IS_DIR_SEPARATOR(dir[len])) {
972 static const char *exec_dir;
974 void qemu_init_exec_dir(const char *argv0)
985 len = GetModuleFileName(NULL, buf, sizeof(buf) - 1);
992 while (p != buf && *p != '\\') {
996 if (access(buf, R_OK) == 0) {
997 exec_dir = g_strdup(buf);
999 exec_dir = CONFIG_BINDIR;
1009 #if defined(__linux__)
1012 len = readlink("/proc/self/exe", buf, sizeof(buf) - 1);
1018 #elif defined(__FreeBSD__) \
1019 || (defined(__NetBSD__) && defined(KERN_PROC_PATHNAME))
1021 #if defined(__FreeBSD__)
1022 static int mib[4] = {CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1};
1024 static int mib[4] = {CTL_KERN, KERN_PROC_ARGS, -1, KERN_PROC_PATHNAME};
1026 size_t len = sizeof(buf) - 1;
1029 if (!sysctl(mib, ARRAY_SIZE(mib), buf, &len, NULL, 0) &&
1031 buf[sizeof(buf) - 1] = '\0';
1035 #elif defined(__APPLE__)
1037 char fpath[PATH_MAX];
1038 uint32_t len = sizeof(fpath);
1039 if (_NSGetExecutablePath(fpath, &len) == 0) {
1040 p = realpath(fpath, buf);
1046 #elif defined(__HAIKU__)
1052 while (get_next_image_info(0, &c, &ii) == B_OK) {
1053 if (ii.type == B_APP_IMAGE) {
1054 strncpy(buf, ii.name, sizeof(buf));
1055 buf[sizeof(buf) - 1] = 0;
1062 /* If we don't have any way of figuring out the actual executable
1063 location then try argv[0]. */
1065 p = realpath(argv0, buf);
1068 exec_dir = g_path_get_dirname(p);
1070 exec_dir = CONFIG_BINDIR;
1075 const char *qemu_get_exec_dir(void)
1080 char *get_relocated_path(const char *dir)
1082 size_t prefix_len = strlen(CONFIG_PREFIX);
1083 const char *bindir = CONFIG_BINDIR;
1084 const char *exec_dir = qemu_get_exec_dir();
1086 int len_dir, len_bindir;
1088 /* Fail if qemu_init_exec_dir was not called. */
1089 assert(exec_dir[0]);
1091 result = g_string_new(exec_dir);
1092 g_string_append(result, "/qemu-bundle");
1093 if (access(result->str, R_OK) == 0) {
1095 size_t size = mbsrtowcs(NULL, &dir, 0, &(mbstate_t){0}) + 1;
1096 PWSTR wdir = g_new(WCHAR, size);
1097 mbsrtowcs(wdir, &dir, size, &(mbstate_t){0});
1099 PCWSTR wdir_skipped_root;
1100 PathCchSkipRoot(wdir, &wdir_skipped_root);
1102 size = wcsrtombs(NULL, &wdir_skipped_root, 0, &(mbstate_t){0});
1103 char *cursor = result->str + result->len;
1104 g_string_set_size(result, result->len + size);
1105 wcsrtombs(cursor, &wdir_skipped_root, size + 1, &(mbstate_t){0});
1108 g_string_append(result, dir);
1110 } else if (!starts_with_prefix(dir) || !starts_with_prefix(bindir)) {
1111 g_string_assign(result, dir);
1113 g_string_assign(result, exec_dir);
1115 /* Advance over common components. */
1116 len_dir = len_bindir = prefix_len;
1119 bindir += len_bindir;
1120 dir = next_component(dir, &len_dir);
1121 bindir = next_component(bindir, &len_bindir);
1122 } while (len_dir && len_dir == len_bindir && !memcmp(dir, bindir, len_dir));
1124 /* Ascend from bindir to the common prefix with dir. */
1125 while (len_bindir) {
1126 bindir += len_bindir;
1127 g_string_append(result, "/..");
1128 bindir = next_component(bindir, &len_bindir);
1132 assert(G_IS_DIR_SEPARATOR(dir[-1]));
1133 g_string_append(result, dir - 1);
1137 return g_string_free(result, false);