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>
38 #include "qemu/ctype.h"
39 #include "qemu/cutils.h"
40 #include "qemu/error-report.h"
42 void strpadcpy(char *buf
, int buf_size
, const char *str
, char pad
)
44 int len
= qemu_strnlen(str
, buf_size
);
45 memcpy(buf
, str
, len
);
46 memset(buf
+ len
, pad
, buf_size
- len
);
49 void pstrcpy(char *buf
, int buf_size
, const char *str
)
59 if (c
== 0 || q
>= buf
+ buf_size
- 1)
66 /* strcat and truncate. */
67 char *pstrcat(char *buf
, int buf_size
, const char *s
)
72 pstrcpy(buf
+ len
, buf_size
- len
, s
);
76 int strstart(const char *str
, const char *val
, const char **ptr
)
92 int stristart(const char *str
, const char *val
, const char **ptr
)
98 if (qemu_toupper(*p
) != qemu_toupper(*q
))
108 /* XXX: use host strnlen if available ? */
109 int qemu_strnlen(const char *s
, int max_len
)
113 for(i
= 0; i
< max_len
; i
++) {
121 char *qemu_strsep(char **input
, const char *delim
)
123 char *result
= *input
;
124 if (result
!= NULL
) {
127 for (p
= result
; *p
!= '\0'; p
++) {
128 if (strchr(delim
, *p
)) {
142 time_t mktimegm(struct tm
*tm
)
145 int y
= tm
->tm_year
+ 1900, m
= tm
->tm_mon
+ 1, d
= tm
->tm_mday
;
150 t
= 86400ULL * (d
+ (153 * m
- 457) / 5 + 365 * y
+ y
/ 4 - y
/ 100 +
152 t
+= 3600 * tm
->tm_hour
+ 60 * tm
->tm_min
+ tm
->tm_sec
;
156 static int64_t suffix_mul(char suffix
, int64_t unit
)
158 switch (qemu_toupper(suffix
)) {
166 return unit
* unit
* unit
;
168 return unit
* unit
* unit
* unit
;
170 return unit
* unit
* unit
* unit
* unit
;
172 return unit
* unit
* unit
* unit
* unit
* unit
;
178 * Convert size string to bytes.
180 * The size parsing supports the following syntaxes
181 * - 12345 - decimal, scale determined by @default_suffix and @unit
182 * - 12345{bBkKmMgGtTpPeE} - decimal, scale determined by suffix and @unit
183 * - 12345.678{kKmMgGtTpPeE} - decimal, scale determined by suffix, and
184 * fractional portion is truncated to byte
185 * - 0x7fEE - hexadecimal, unit determined by @default_suffix
187 * The following cause a deprecation warning, and may be removed in the future
188 * - 0xabc{kKmMgGtTpP} - hex with scaling suffix
190 * The following are intentionally not supported
191 * - octal, such as 08
192 * - fractional hex, such as 0x1.8
193 * - floating point exponents, such as 1e3
195 * The end pointer will be returned in *end, if not NULL. If there is
196 * no fraction, the input can be decimal or hexadecimal; if there is a
197 * fraction, then the input must be decimal and there must be a suffix
198 * (possibly by @default_suffix) larger than Byte, and the fractional
199 * portion may suffer from precision loss or rounding. The input must
202 * Return -ERANGE on overflow (with *@end advanced), and -EINVAL on
203 * other error (with *@end left unchanged).
205 static int do_strtosz(const char *nptr
, const char **end
,
206 const char default_suffix
, int64_t unit
,
210 const char *endptr
, *f
;
213 uint64_t val
, valf
= 0;
216 /* Parse integral portion as decimal. */
217 retval
= qemu_strtou64(nptr
, &endptr
, 10, &val
);
221 if (memchr(nptr
, '-', endptr
- nptr
) != NULL
) {
226 if (val
== 0 && (*endptr
== 'x' || *endptr
== 'X')) {
227 /* Input looks like hex, reparse, and insist on no fraction. */
228 retval
= qemu_strtou64(nptr
, &endptr
, 16, &val
);
232 if (*endptr
== '.') {
238 } else if (*endptr
== '.') {
240 * Input looks like a fraction. Make sure even 1.k works
241 * without fractional digits. If we see an exponent, treat
242 * the entire input as invalid instead.
247 retval
= qemu_strtod_finite(f
, &endptr
, &fraction
);
250 } else if (memchr(f
, 'e', endptr
- f
) || memchr(f
, 'E', endptr
- f
)) {
255 /* Extract into a 64-bit fixed-point fraction. */
256 valf
= (uint64_t)(fraction
* 0x1p
64);
260 mul
= suffix_mul(c
, unit
);
263 warn_report("Using a multiplier suffix on hex numbers "
264 "is deprecated: %s", nptr
);
268 mul
= suffix_mul(default_suffix
, unit
);
272 /* When a fraction is present, a scale is required. */
281 /* Compute exact result: 64.64 x 64.0 -> 128.64 fixed point */
282 mulu64(&val
, &valh
, val
, mul
);
283 mulu64(&valf
, &tmp
, valf
, mul
);
287 /* Round 0.5 upward. */
292 /* Report overflow. */
304 } else if (*endptr
) {
314 int qemu_strtosz(const char *nptr
, const char **end
, uint64_t *result
)
316 return do_strtosz(nptr
, end
, 'B', 1024, result
);
319 int qemu_strtosz_MiB(const char *nptr
, const char **end
, uint64_t *result
)
321 return do_strtosz(nptr
, end
, 'M', 1024, result
);
324 int qemu_strtosz_metric(const char *nptr
, const char **end
, uint64_t *result
)
326 return do_strtosz(nptr
, end
, 'B', 1000, result
);
330 * Helper function for error checking after strtol() and the like
332 static int check_strtox_error(const char *nptr
, char *ep
,
333 const char **endptr
, bool check_zero
,
338 /* Windows has a bug in that it fails to parse 0 from "0x" in base 16 */
339 if (check_zero
&& ep
== nptr
&& libc_errno
== 0) {
343 if (strtol(nptr
, &tmp
, 10) == 0 && errno
== 0 &&
344 (*tmp
== 'x' || *tmp
== 'X')) {
353 /* Turn "no conversion" into an error */
354 if (libc_errno
== 0 && ep
== nptr
) {
358 /* Fail when we're expected to consume the string, but didn't */
359 if (!endptr
&& *ep
) {
367 * Convert string @nptr to an integer, and store it in @result.
369 * This is a wrapper around strtol() that is harder to misuse.
370 * Semantics of @nptr, @endptr, @base match strtol() with differences
373 * @nptr may be null, and no conversion is performed then.
375 * If no conversion is performed, store @nptr in *@endptr and return
378 * If @endptr is null, and the string isn't fully converted, return
379 * -EINVAL. This is the case when the pointer that would be stored in
380 * a non-null @endptr points to a character other than '\0'.
382 * If the conversion overflows @result, store INT_MAX in @result,
383 * and return -ERANGE.
385 * If the conversion underflows @result, store INT_MIN in @result,
386 * and return -ERANGE.
388 * Else store the converted value in @result, and return zero.
390 int qemu_strtoi(const char *nptr
, const char **endptr
, int base
,
396 assert((unsigned) base
<= 36 && base
!= 1);
405 lresult
= strtoll(nptr
, &ep
, base
);
406 if (lresult
< INT_MIN
) {
409 } else if (lresult
> INT_MAX
) {
415 return check_strtox_error(nptr
, ep
, endptr
, lresult
== 0, errno
);
419 * Convert string @nptr to an unsigned integer, and store it in @result.
421 * This is a wrapper around strtoul() that is harder to misuse.
422 * Semantics of @nptr, @endptr, @base match strtoul() with differences
425 * @nptr may be null, and no conversion is performed then.
427 * If no conversion is performed, store @nptr in *@endptr and return
430 * If @endptr is null, and the string isn't fully converted, return
431 * -EINVAL. This is the case when the pointer that would be stored in
432 * a non-null @endptr points to a character other than '\0'.
434 * If the conversion overflows @result, store UINT_MAX in @result,
435 * and return -ERANGE.
437 * Else store the converted value in @result, and return zero.
439 * Note that a number with a leading minus sign gets converted without
440 * the minus sign, checked for overflow (see above), then negated (in
441 * @result's type). This is exactly how strtoul() works.
443 int qemu_strtoui(const char *nptr
, const char **endptr
, int base
,
444 unsigned int *result
)
449 assert((unsigned) base
<= 36 && base
!= 1);
458 lresult
= strtoull(nptr
, &ep
, base
);
460 /* Windows returns 1 for negative out-of-range values. */
461 if (errno
== ERANGE
) {
464 if (lresult
> UINT_MAX
) {
467 } else if (lresult
< INT_MIN
) {
474 return check_strtox_error(nptr
, ep
, endptr
, lresult
== 0, errno
);
478 * Convert string @nptr to a long integer, and store it in @result.
480 * This is a wrapper around strtol() that is harder to misuse.
481 * Semantics of @nptr, @endptr, @base match strtol() with differences
484 * @nptr may be null, and no conversion is performed then.
486 * If no conversion is performed, store @nptr in *@endptr and return
489 * If @endptr is null, and the string isn't fully converted, return
490 * -EINVAL. This is the case when the pointer that would be stored in
491 * a non-null @endptr points to a character other than '\0'.
493 * If the conversion overflows @result, store LONG_MAX in @result,
494 * and return -ERANGE.
496 * If the conversion underflows @result, store LONG_MIN in @result,
497 * and return -ERANGE.
499 * Else store the converted value in @result, and return zero.
501 int qemu_strtol(const char *nptr
, const char **endptr
, int base
,
506 assert((unsigned) base
<= 36 && base
!= 1);
515 *result
= strtol(nptr
, &ep
, base
);
516 return check_strtox_error(nptr
, ep
, endptr
, *result
== 0, errno
);
520 * Convert string @nptr to an unsigned long, and store it in @result.
522 * This is a wrapper around strtoul() that is harder to misuse.
523 * Semantics of @nptr, @endptr, @base match strtoul() with differences
526 * @nptr may be null, and no conversion is performed then.
528 * If no conversion is performed, store @nptr in *@endptr and return
531 * If @endptr is null, and the string isn't fully converted, return
532 * -EINVAL. This is the case when the pointer that would be stored in
533 * a non-null @endptr points to a character other than '\0'.
535 * If the conversion overflows @result, store ULONG_MAX in @result,
536 * and return -ERANGE.
538 * Else store the converted value in @result, and return zero.
540 * Note that a number with a leading minus sign gets converted without
541 * the minus sign, checked for overflow (see above), then negated (in
542 * @result's type). This is exactly how strtoul() works.
544 int qemu_strtoul(const char *nptr
, const char **endptr
, int base
,
545 unsigned long *result
)
549 assert((unsigned) base
<= 36 && base
!= 1);
558 *result
= strtoul(nptr
, &ep
, base
);
559 /* Windows returns 1 for negative out-of-range values. */
560 if (errno
== ERANGE
) {
563 return check_strtox_error(nptr
, ep
, endptr
, *result
== 0, errno
);
567 * Convert string @nptr to an int64_t.
569 * Works like qemu_strtol(), except it stores INT64_MAX on overflow,
570 * and INT64_MIN on underflow.
572 int qemu_strtoi64(const char *nptr
, const char **endptr
, int base
,
577 assert((unsigned) base
<= 36 && base
!= 1);
585 /* This assumes int64_t is long long TODO relax */
586 QEMU_BUILD_BUG_ON(sizeof(int64_t) != sizeof(long long));
588 *result
= strtoll(nptr
, &ep
, base
);
589 return check_strtox_error(nptr
, ep
, endptr
, *result
== 0, errno
);
593 * Convert string @nptr to an uint64_t.
595 * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow.
597 int qemu_strtou64(const char *nptr
, const char **endptr
, int base
,
602 assert((unsigned) base
<= 36 && base
!= 1);
610 /* This assumes uint64_t is unsigned long long TODO relax */
611 QEMU_BUILD_BUG_ON(sizeof(uint64_t) != sizeof(unsigned long long));
613 *result
= strtoull(nptr
, &ep
, base
);
614 /* Windows returns 1 for negative out-of-range values. */
615 if (errno
== ERANGE
) {
618 return check_strtox_error(nptr
, ep
, endptr
, *result
== 0, errno
);
622 * Convert string @nptr to a double.
624 * This is a wrapper around strtod() that is harder to misuse.
625 * Semantics of @nptr and @endptr match strtod() with differences
628 * @nptr may be null, and no conversion is performed then.
630 * If no conversion is performed, store @nptr in *@endptr and return
633 * If @endptr is null, and the string isn't fully converted, return
634 * -EINVAL. This is the case when the pointer that would be stored in
635 * a non-null @endptr points to a character other than '\0'.
637 * If the conversion overflows, store +/-HUGE_VAL in @result, depending
638 * on the sign, and return -ERANGE.
640 * If the conversion underflows, store +/-0.0 in @result, depending on the
641 * sign, and return -ERANGE.
643 * Else store the converted value in @result, and return zero.
645 int qemu_strtod(const char *nptr
, const char **endptr
, double *result
)
657 *result
= strtod(nptr
, &ep
);
658 return check_strtox_error(nptr
, ep
, endptr
, false, errno
);
662 * Convert string @nptr to a finite double.
664 * Works like qemu_strtod(), except that "NaN" and "inf" are rejected
665 * with -EINVAL and no conversion is performed.
667 int qemu_strtod_finite(const char *nptr
, const char **endptr
, double *result
)
672 ret
= qemu_strtod(nptr
, endptr
, &tmp
);
673 if (!ret
&& !isfinite(tmp
)) {
680 if (ret
!= -EINVAL
) {
687 * Searches for the first occurrence of 'c' in 's', and returns a pointer
688 * to the trailing null byte if none was found.
690 #ifndef HAVE_STRCHRNUL
691 const char *qemu_strchrnul(const char *s
, int c
)
693 const char *e
= strchr(s
, c
);
704 * @s: String to parse
705 * @value: Destination for parsed integer value
706 * @endptr: Destination for pointer to first character not consumed
707 * @base: integer base, between 2 and 36 inclusive, or 0
709 * Parse unsigned integer
711 * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
712 * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
714 * If @s is null, or @base is invalid, or @s doesn't start with an
715 * integer in the syntax above, set *@value to 0, *@endptr to @s, and
718 * Set *@endptr to point right beyond the parsed integer (even if the integer
719 * overflows or is negative, all digits will be parsed and *@endptr will
720 * point right beyond them).
722 * If the integer is negative, set *@value to 0, and return -ERANGE.
724 * If the integer overflows unsigned long long, set *@value to
725 * ULLONG_MAX, and return -ERANGE.
727 * Else, set *@value to the parsed integer, and return 0.
729 int parse_uint(const char *s
, unsigned long long *value
, char **endptr
,
733 char *endp
= (char *)s
;
734 unsigned long long val
= 0;
736 assert((unsigned) base
<= 36 && base
!= 1);
743 val
= strtoull(s
, &endp
, base
);
754 /* make sure we reject negative numbers: */
755 while (qemu_isspace(*s
)) {
773 * @s: String to parse
774 * @value: Destination for parsed integer value
775 * @base: integer base, between 2 and 36 inclusive, or 0
777 * Parse unsigned integer from entire string
779 * Have the same behavior of parse_uint(), but with an additional check
780 * for additional data after the parsed number. If extra characters are present
781 * after the parsed number, the function will return -EINVAL, and *@v will
784 int parse_uint_full(const char *s
, unsigned long long *value
, int base
)
789 r
= parse_uint(s
, value
, &endp
, base
);
801 int qemu_parse_fd(const char *param
)
807 fd
= strtol(param
, &endptr
, 10);
808 if (param
== endptr
/* no conversion performed */ ||
809 errno
!= 0 /* not representable as long; possibly others */ ||
810 *endptr
!= '\0' /* final string not empty */ ||
811 fd
< 0 /* invalid as file descriptor */ ||
812 fd
> INT_MAX
/* not representable as int */) {
819 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
820 * Input is limited to 14-bit numbers
822 int uleb128_encode_small(uint8_t *out
, uint32_t n
)
824 g_assert(n
<= 0x3fff);
829 *out
++ = (n
& 0x7f) | 0x80;
835 int uleb128_decode_small(const uint8_t *in
, uint32_t *n
)
842 /* we exceed 14 bit number */
852 * helper to parse debug environment variables
854 int parse_debug_env(const char *name
, int max
, int initial
)
856 char *debug_env
= getenv(name
);
864 debug
= strtol(debug_env
, &inv
, 10);
865 if (inv
== debug_env
) {
868 if (debug
< 0 || debug
> max
|| errno
!= 0) {
869 warn_report("%s not in [0, %d]", name
, max
);
876 * Return human readable string for size @val.
877 * @val can be anything that uint64_t allows (no more than "16 EiB").
878 * Use IEC binary units like KiB, MiB, and so forth.
879 * Caller is responsible for passing it to g_free().
881 char *size_to_str(uint64_t val
)
883 static const char *suffixes
[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
888 * The exponent (returned in i) minus one gives us
889 * floor(log2(val * 1024 / 1000). The correction makes us
890 * switch to the higher power when the integer part is >= 1000.
891 * (see e41b509d68afb1f for more info)
893 frexp(val
/ (1000.0 / 1024.0), &i
);
895 div
= 1ULL << (i
* 10);
897 return g_strdup_printf("%0.3g %sB", (double)val
/ div
, suffixes
[i
]);
900 char *freq_to_str(uint64_t freq_hz
)
902 static const char *const suffixes
[] = { "", "K", "M", "G", "T", "P", "E" };
903 double freq
= freq_hz
;
906 while (freq
>= 1000.0) {
910 assert(idx
< ARRAY_SIZE(suffixes
));
912 return g_strdup_printf("%0.3g %sHz", freq
, suffixes
[idx
]);
915 int qemu_pstrcmp0(const char **str1
, const char **str2
)
917 return g_strcmp0(*str1
, *str2
);
920 static inline bool starts_with_prefix(const char *dir
)
922 size_t prefix_len
= strlen(CONFIG_PREFIX
);
923 return !memcmp(dir
, CONFIG_PREFIX
, prefix_len
) &&
924 (!dir
[prefix_len
] || G_IS_DIR_SEPARATOR(dir
[prefix_len
]));
927 /* Return the next path component in dir, and store its length in *p_len. */
928 static inline const char *next_component(const char *dir
, int *p_len
)
931 while ((*dir
&& G_IS_DIR_SEPARATOR(*dir
)) ||
932 (*dir
== '.' && (G_IS_DIR_SEPARATOR(dir
[1]) || dir
[1] == '\0'))) {
936 while (dir
[len
] && !G_IS_DIR_SEPARATOR(dir
[len
])) {
943 static const char *exec_dir
;
945 void qemu_init_exec_dir(const char *argv0
)
956 len
= GetModuleFileName(NULL
, buf
, sizeof(buf
) - 1);
963 while (p
!= buf
&& *p
!= '\\') {
967 if (access(buf
, R_OK
) == 0) {
968 exec_dir
= g_strdup(buf
);
970 exec_dir
= CONFIG_BINDIR
;
980 #if defined(__linux__)
983 len
= readlink("/proc/self/exe", buf
, sizeof(buf
) - 1);
989 #elif defined(__FreeBSD__) \
990 || (defined(__NetBSD__) && defined(KERN_PROC_PATHNAME))
992 #if defined(__FreeBSD__)
993 static int mib
[4] = {CTL_KERN
, KERN_PROC
, KERN_PROC_PATHNAME
, -1};
995 static int mib
[4] = {CTL_KERN
, KERN_PROC_ARGS
, -1, KERN_PROC_PATHNAME
};
997 size_t len
= sizeof(buf
) - 1;
1000 if (!sysctl(mib
, ARRAY_SIZE(mib
), buf
, &len
, NULL
, 0) &&
1002 buf
[sizeof(buf
) - 1] = '\0';
1006 #elif defined(__APPLE__)
1008 char fpath
[PATH_MAX
];
1009 uint32_t len
= sizeof(fpath
);
1010 if (_NSGetExecutablePath(fpath
, &len
) == 0) {
1011 p
= realpath(fpath
, buf
);
1017 #elif defined(__HAIKU__)
1023 while (get_next_image_info(0, &c
, &ii
) == B_OK
) {
1024 if (ii
.type
== B_APP_IMAGE
) {
1025 strncpy(buf
, ii
.name
, sizeof(buf
));
1026 buf
[sizeof(buf
) - 1] = 0;
1033 /* If we don't have any way of figuring out the actual executable
1034 location then try argv[0]. */
1036 p
= realpath(argv0
, buf
);
1039 exec_dir
= g_path_get_dirname(p
);
1041 exec_dir
= CONFIG_BINDIR
;
1046 const char *qemu_get_exec_dir(void)
1051 char *get_relocated_path(const char *dir
)
1053 size_t prefix_len
= strlen(CONFIG_PREFIX
);
1054 const char *bindir
= CONFIG_BINDIR
;
1055 const char *exec_dir
= qemu_get_exec_dir();
1057 int len_dir
, len_bindir
;
1059 /* Fail if qemu_init_exec_dir was not called. */
1060 assert(exec_dir
[0]);
1061 if (!starts_with_prefix(dir
) || !starts_with_prefix(bindir
)) {
1062 return g_strdup(dir
);
1065 result
= g_string_new(exec_dir
);
1067 /* Advance over common components. */
1068 len_dir
= len_bindir
= prefix_len
;
1071 bindir
+= len_bindir
;
1072 dir
= next_component(dir
, &len_dir
);
1073 bindir
= next_component(bindir
, &len_bindir
);
1074 } while (len_dir
&& len_dir
== len_bindir
&& !memcmp(dir
, bindir
, len_dir
));
1076 /* Ascend from bindir to the common prefix with dir. */
1077 while (len_bindir
) {
1078 bindir
+= len_bindir
;
1079 g_string_append(result
, "/..");
1080 bindir
= next_component(bindir
, &len_bindir
);
1084 assert(G_IS_DIR_SEPARATOR(dir
[-1]));
1085 g_string_append(result
, dir
- 1);
1087 return g_string_free(result
, false);