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"
29 #include "qemu-common.h"
30 #include "qemu/sockets.h"
33 #include "qemu/ctype.h"
34 #include "qemu/cutils.h"
35 #include "qemu/error-report.h"
37 void strpadcpy(char *buf
, int buf_size
, const char *str
, char pad
)
39 int len
= qemu_strnlen(str
, buf_size
);
40 memcpy(buf
, str
, len
);
41 memset(buf
+ len
, pad
, buf_size
- len
);
44 void pstrcpy(char *buf
, int buf_size
, const char *str
)
54 if (c
== 0 || q
>= buf
+ buf_size
- 1)
61 /* strcat and truncate. */
62 char *pstrcat(char *buf
, int buf_size
, const char *s
)
67 pstrcpy(buf
+ len
, buf_size
- len
, s
);
71 int strstart(const char *str
, const char *val
, const char **ptr
)
87 int stristart(const char *str
, const char *val
, const char **ptr
)
93 if (qemu_toupper(*p
) != qemu_toupper(*q
))
103 /* XXX: use host strnlen if available ? */
104 int qemu_strnlen(const char *s
, int max_len
)
108 for(i
= 0; i
< max_len
; i
++) {
116 char *qemu_strsep(char **input
, const char *delim
)
118 char *result
= *input
;
119 if (result
!= NULL
) {
122 for (p
= result
; *p
!= '\0'; p
++) {
123 if (strchr(delim
, *p
)) {
137 time_t mktimegm(struct tm
*tm
)
140 int y
= tm
->tm_year
+ 1900, m
= tm
->tm_mon
+ 1, d
= tm
->tm_mday
;
145 t
= 86400ULL * (d
+ (153 * m
- 457) / 5 + 365 * y
+ y
/ 4 - y
/ 100 +
147 t
+= 3600 * tm
->tm_hour
+ 60 * tm
->tm_min
+ tm
->tm_sec
;
152 * Make sure data goes on disk, but if possible do not bother to
153 * write out the inode just for timestamp updates.
155 * Unfortunately even in 2009 many operating systems do not support
156 * fdatasync and have to fall back to fsync.
158 int qemu_fdatasync(int fd
)
160 #ifdef CONFIG_FDATASYNC
161 return fdatasync(fd
);
168 * Sync changes made to the memory mapped file back to the backing
169 * storage. For POSIX compliant systems this will fallback
170 * to regular msync call. Otherwise it will trigger whole file sync
171 * (including the metadata case there is no support to skip that otherwise)
173 * @addr - start of the memory area to be synced
174 * @length - length of the are to be synced
175 * @fd - file descriptor for the file to be synced
176 * (mandatory only for POSIX non-compliant systems)
178 int qemu_msync(void *addr
, size_t length
, int fd
)
181 size_t align_mask
= ~(qemu_real_host_page_size
- 1);
184 * There are no strict reqs as per the length of mapping
185 * to be synced. Still the length needs to follow the address
186 * alignment changes. Additionally - round the size to the multiple
189 length
+= ((uintptr_t)addr
& (qemu_real_host_page_size
- 1));
190 length
= (length
+ ~align_mask
) & align_mask
;
192 addr
= (void *)((uintptr_t)addr
& align_mask
);
194 return msync(addr
, length
, MS_SYNC
);
195 #else /* CONFIG_POSIX */
197 * Perform the sync based on the file descriptor
198 * The sync range will most probably be wider than the one
199 * requested - but it will still get the job done
201 return qemu_fdatasync(fd
);
202 #endif /* CONFIG_POSIX */
206 /* Sets a specific flag */
207 int fcntl_setfl(int fd
, int flag
)
211 flags
= fcntl(fd
, F_GETFL
);
215 if (fcntl(fd
, F_SETFL
, flags
| flag
) == -1)
222 static int64_t suffix_mul(char suffix
, int64_t unit
)
224 switch (qemu_toupper(suffix
)) {
232 return unit
* unit
* unit
;
234 return unit
* unit
* unit
* unit
;
236 return unit
* unit
* unit
* unit
* unit
;
238 return unit
* unit
* unit
* unit
* unit
* unit
;
244 * Convert size string to bytes.
246 * The size parsing supports the following syntaxes
247 * - 12345 - decimal, scale determined by @default_suffix and @unit
248 * - 12345{bBkKmMgGtTpPeE} - decimal, scale determined by suffix and @unit
249 * - 12345.678{kKmMgGtTpPeE} - decimal, scale determined by suffix, and
250 * fractional portion is truncated to byte
251 * - 0x7fEE - hexadecimal, unit determined by @default_suffix
253 * The following cause a deprecation warning, and may be removed in the future
254 * - 0xabc{kKmMgGtTpP} - hex with scaling suffix
256 * The following are intentionally not supported
257 * - octal, such as 08
258 * - fractional hex, such as 0x1.8
259 * - floating point exponents, such as 1e3
261 * The end pointer will be returned in *end, if not NULL. If there is
262 * no fraction, the input can be decimal or hexadecimal; if there is a
263 * fraction, then the input must be decimal and there must be a suffix
264 * (possibly by @default_suffix) larger than Byte, and the fractional
265 * portion may suffer from precision loss or rounding. The input must
268 * Return -ERANGE on overflow (with *@end advanced), and -EINVAL on
269 * other error (with *@end left unchanged).
271 static int do_strtosz(const char *nptr
, const char **end
,
272 const char default_suffix
, int64_t unit
,
276 const char *endptr
, *f
;
279 uint64_t val
, valf
= 0;
282 /* Parse integral portion as decimal. */
283 retval
= qemu_strtou64(nptr
, &endptr
, 10, &val
);
287 if (memchr(nptr
, '-', endptr
- nptr
) != NULL
) {
292 if (val
== 0 && (*endptr
== 'x' || *endptr
== 'X')) {
293 /* Input looks like hex, reparse, and insist on no fraction. */
294 retval
= qemu_strtou64(nptr
, &endptr
, 16, &val
);
298 if (*endptr
== '.') {
304 } else if (*endptr
== '.') {
306 * Input looks like a fraction. Make sure even 1.k works
307 * without fractional digits. If we see an exponent, treat
308 * the entire input as invalid instead.
313 retval
= qemu_strtod_finite(f
, &endptr
, &fraction
);
316 } else if (memchr(f
, 'e', endptr
- f
) || memchr(f
, 'E', endptr
- f
)) {
321 /* Extract into a 64-bit fixed-point fraction. */
322 valf
= (uint64_t)(fraction
* 0x1p
64);
326 mul
= suffix_mul(c
, unit
);
329 warn_report("Using a multiplier suffix on hex numbers "
330 "is deprecated: %s", nptr
);
334 mul
= suffix_mul(default_suffix
, unit
);
338 /* When a fraction is present, a scale is required. */
347 /* Compute exact result: 64.64 x 64.0 -> 128.64 fixed point */
348 mulu64(&val
, &valh
, val
, mul
);
349 mulu64(&valf
, &tmp
, valf
, mul
);
353 /* Round 0.5 upward. */
358 /* Report overflow. */
370 } else if (*endptr
) {
380 int qemu_strtosz(const char *nptr
, const char **end
, uint64_t *result
)
382 return do_strtosz(nptr
, end
, 'B', 1024, result
);
385 int qemu_strtosz_MiB(const char *nptr
, const char **end
, uint64_t *result
)
387 return do_strtosz(nptr
, end
, 'M', 1024, result
);
390 int qemu_strtosz_metric(const char *nptr
, const char **end
, uint64_t *result
)
392 return do_strtosz(nptr
, end
, 'B', 1000, result
);
396 * Helper function for error checking after strtol() and the like
398 static int check_strtox_error(const char *nptr
, char *ep
,
399 const char **endptr
, bool check_zero
,
404 /* Windows has a bug in that it fails to parse 0 from "0x" in base 16 */
405 if (check_zero
&& ep
== nptr
&& libc_errno
== 0) {
409 if (strtol(nptr
, &tmp
, 10) == 0 && errno
== 0 &&
410 (*tmp
== 'x' || *tmp
== 'X')) {
419 /* Turn "no conversion" into an error */
420 if (libc_errno
== 0 && ep
== nptr
) {
424 /* Fail when we're expected to consume the string, but didn't */
425 if (!endptr
&& *ep
) {
433 * Convert string @nptr to an integer, and store it in @result.
435 * This is a wrapper around strtol() that is harder to misuse.
436 * Semantics of @nptr, @endptr, @base match strtol() with differences
439 * @nptr may be null, and no conversion is performed then.
441 * If no conversion is performed, store @nptr in *@endptr and return
444 * If @endptr is null, and the string isn't fully converted, return
445 * -EINVAL. This is the case when the pointer that would be stored in
446 * a non-null @endptr points to a character other than '\0'.
448 * If the conversion overflows @result, store INT_MAX in @result,
449 * and return -ERANGE.
451 * If the conversion underflows @result, store INT_MIN in @result,
452 * and return -ERANGE.
454 * Else store the converted value in @result, and return zero.
456 int qemu_strtoi(const char *nptr
, const char **endptr
, int base
,
462 assert((unsigned) base
<= 36 && base
!= 1);
471 lresult
= strtoll(nptr
, &ep
, base
);
472 if (lresult
< INT_MIN
) {
475 } else if (lresult
> INT_MAX
) {
481 return check_strtox_error(nptr
, ep
, endptr
, lresult
== 0, errno
);
485 * Convert string @nptr to an unsigned integer, and store it in @result.
487 * This is a wrapper around strtoul() that is harder to misuse.
488 * Semantics of @nptr, @endptr, @base match strtoul() with differences
491 * @nptr may be null, and no conversion is performed then.
493 * If no conversion is performed, store @nptr in *@endptr and return
496 * If @endptr is null, and the string isn't fully converted, return
497 * -EINVAL. This is the case when the pointer that would be stored in
498 * a non-null @endptr points to a character other than '\0'.
500 * If the conversion overflows @result, store UINT_MAX in @result,
501 * and return -ERANGE.
503 * Else store the converted value in @result, and return zero.
505 * Note that a number with a leading minus sign gets converted without
506 * the minus sign, checked for overflow (see above), then negated (in
507 * @result's type). This is exactly how strtoul() works.
509 int qemu_strtoui(const char *nptr
, const char **endptr
, int base
,
510 unsigned int *result
)
515 assert((unsigned) base
<= 36 && base
!= 1);
524 lresult
= strtoull(nptr
, &ep
, base
);
526 /* Windows returns 1 for negative out-of-range values. */
527 if (errno
== ERANGE
) {
530 if (lresult
> UINT_MAX
) {
533 } else if (lresult
< INT_MIN
) {
540 return check_strtox_error(nptr
, ep
, endptr
, lresult
== 0, errno
);
544 * Convert string @nptr to a long integer, and store it in @result.
546 * This is a wrapper around strtol() that is harder to misuse.
547 * Semantics of @nptr, @endptr, @base match strtol() with differences
550 * @nptr may be null, and no conversion is performed then.
552 * If no conversion is performed, store @nptr in *@endptr and return
555 * If @endptr is null, and the string isn't fully converted, return
556 * -EINVAL. This is the case when the pointer that would be stored in
557 * a non-null @endptr points to a character other than '\0'.
559 * If the conversion overflows @result, store LONG_MAX in @result,
560 * and return -ERANGE.
562 * If the conversion underflows @result, store LONG_MIN in @result,
563 * and return -ERANGE.
565 * Else store the converted value in @result, and return zero.
567 int qemu_strtol(const char *nptr
, const char **endptr
, int base
,
572 assert((unsigned) base
<= 36 && base
!= 1);
581 *result
= strtol(nptr
, &ep
, base
);
582 return check_strtox_error(nptr
, ep
, endptr
, *result
== 0, errno
);
586 * Convert string @nptr to an unsigned long, and store it in @result.
588 * This is a wrapper around strtoul() that is harder to misuse.
589 * Semantics of @nptr, @endptr, @base match strtoul() with differences
592 * @nptr may be null, and no conversion is performed then.
594 * If no conversion is performed, store @nptr in *@endptr and return
597 * If @endptr is null, and the string isn't fully converted, return
598 * -EINVAL. This is the case when the pointer that would be stored in
599 * a non-null @endptr points to a character other than '\0'.
601 * If the conversion overflows @result, store ULONG_MAX in @result,
602 * and return -ERANGE.
604 * Else store the converted value in @result, and return zero.
606 * Note that a number with a leading minus sign gets converted without
607 * the minus sign, checked for overflow (see above), then negated (in
608 * @result's type). This is exactly how strtoul() works.
610 int qemu_strtoul(const char *nptr
, const char **endptr
, int base
,
611 unsigned long *result
)
615 assert((unsigned) base
<= 36 && base
!= 1);
624 *result
= strtoul(nptr
, &ep
, base
);
625 /* Windows returns 1 for negative out-of-range values. */
626 if (errno
== ERANGE
) {
629 return check_strtox_error(nptr
, ep
, endptr
, *result
== 0, errno
);
633 * Convert string @nptr to an int64_t.
635 * Works like qemu_strtol(), except it stores INT64_MAX on overflow,
636 * and INT64_MIN on underflow.
638 int qemu_strtoi64(const char *nptr
, const char **endptr
, int base
,
643 assert((unsigned) base
<= 36 && base
!= 1);
651 /* This assumes int64_t is long long TODO relax */
652 QEMU_BUILD_BUG_ON(sizeof(int64_t) != sizeof(long long));
654 *result
= strtoll(nptr
, &ep
, base
);
655 return check_strtox_error(nptr
, ep
, endptr
, *result
== 0, errno
);
659 * Convert string @nptr to an uint64_t.
661 * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow.
663 int qemu_strtou64(const char *nptr
, const char **endptr
, int base
,
668 assert((unsigned) base
<= 36 && base
!= 1);
676 /* This assumes uint64_t is unsigned long long TODO relax */
677 QEMU_BUILD_BUG_ON(sizeof(uint64_t) != sizeof(unsigned long long));
679 *result
= strtoull(nptr
, &ep
, base
);
680 /* Windows returns 1 for negative out-of-range values. */
681 if (errno
== ERANGE
) {
684 return check_strtox_error(nptr
, ep
, endptr
, *result
== 0, errno
);
688 * Convert string @nptr to a double.
690 * This is a wrapper around strtod() that is harder to misuse.
691 * Semantics of @nptr and @endptr match strtod() with differences
694 * @nptr may be null, and no conversion is performed then.
696 * If no conversion is performed, store @nptr in *@endptr and return
699 * If @endptr is null, and the string isn't fully converted, return
700 * -EINVAL. This is the case when the pointer that would be stored in
701 * a non-null @endptr points to a character other than '\0'.
703 * If the conversion overflows, store +/-HUGE_VAL in @result, depending
704 * on the sign, and return -ERANGE.
706 * If the conversion underflows, store +/-0.0 in @result, depending on the
707 * sign, and return -ERANGE.
709 * Else store the converted value in @result, and return zero.
711 int qemu_strtod(const char *nptr
, const char **endptr
, double *result
)
723 *result
= strtod(nptr
, &ep
);
724 return check_strtox_error(nptr
, ep
, endptr
, false, errno
);
728 * Convert string @nptr to a finite double.
730 * Works like qemu_strtod(), except that "NaN" and "inf" are rejected
731 * with -EINVAL and no conversion is performed.
733 int qemu_strtod_finite(const char *nptr
, const char **endptr
, double *result
)
738 ret
= qemu_strtod(nptr
, endptr
, &tmp
);
739 if (!ret
&& !isfinite(tmp
)) {
746 if (ret
!= -EINVAL
) {
753 * Searches for the first occurrence of 'c' in 's', and returns a pointer
754 * to the trailing null byte if none was found.
756 #ifndef HAVE_STRCHRNUL
757 const char *qemu_strchrnul(const char *s
, int c
)
759 const char *e
= strchr(s
, c
);
770 * @s: String to parse
771 * @value: Destination for parsed integer value
772 * @endptr: Destination for pointer to first character not consumed
773 * @base: integer base, between 2 and 36 inclusive, or 0
775 * Parse unsigned integer
777 * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
778 * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
780 * If @s is null, or @base is invalid, or @s doesn't start with an
781 * integer in the syntax above, set *@value to 0, *@endptr to @s, and
784 * Set *@endptr to point right beyond the parsed integer (even if the integer
785 * overflows or is negative, all digits will be parsed and *@endptr will
786 * point right beyond them).
788 * If the integer is negative, set *@value to 0, and return -ERANGE.
790 * If the integer overflows unsigned long long, set *@value to
791 * ULLONG_MAX, and return -ERANGE.
793 * Else, set *@value to the parsed integer, and return 0.
795 int parse_uint(const char *s
, unsigned long long *value
, char **endptr
,
799 char *endp
= (char *)s
;
800 unsigned long long val
= 0;
802 assert((unsigned) base
<= 36 && base
!= 1);
809 val
= strtoull(s
, &endp
, base
);
820 /* make sure we reject negative numbers: */
821 while (qemu_isspace(*s
)) {
839 * @s: String to parse
840 * @value: Destination for parsed integer value
841 * @base: integer base, between 2 and 36 inclusive, or 0
843 * Parse unsigned integer from entire string
845 * Have the same behavior of parse_uint(), but with an additional check
846 * for additional data after the parsed number. If extra characters are present
847 * after the parsed number, the function will return -EINVAL, and *@v will
850 int parse_uint_full(const char *s
, unsigned long long *value
, int base
)
855 r
= parse_uint(s
, value
, &endp
, base
);
867 int qemu_parse_fd(const char *param
)
873 fd
= strtol(param
, &endptr
, 10);
874 if (param
== endptr
/* no conversion performed */ ||
875 errno
!= 0 /* not representable as long; possibly others */ ||
876 *endptr
!= '\0' /* final string not empty */ ||
877 fd
< 0 /* invalid as file descriptor */ ||
878 fd
> INT_MAX
/* not representable as int */) {
885 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
886 * Input is limited to 14-bit numbers
888 int uleb128_encode_small(uint8_t *out
, uint32_t n
)
890 g_assert(n
<= 0x3fff);
895 *out
++ = (n
& 0x7f) | 0x80;
901 int uleb128_decode_small(const uint8_t *in
, uint32_t *n
)
908 /* we exceed 14 bit number */
918 * helper to parse debug environment variables
920 int parse_debug_env(const char *name
, int max
, int initial
)
922 char *debug_env
= getenv(name
);
930 debug
= strtol(debug_env
, &inv
, 10);
931 if (inv
== debug_env
) {
934 if (debug
< 0 || debug
> max
|| errno
!= 0) {
935 warn_report("%s not in [0, %d]", name
, max
);
942 * Helper to print ethernet mac address
944 const char *qemu_ether_ntoa(const MACAddr
*mac
)
948 snprintf(ret
, sizeof(ret
), "%02x:%02x:%02x:%02x:%02x:%02x",
949 mac
->a
[0], mac
->a
[1], mac
->a
[2], mac
->a
[3], mac
->a
[4], mac
->a
[5]);
955 * Return human readable string for size @val.
956 * @val can be anything that uint64_t allows (no more than "16 EiB").
957 * Use IEC binary units like KiB, MiB, and so forth.
958 * Caller is responsible for passing it to g_free().
960 char *size_to_str(uint64_t val
)
962 static const char *suffixes
[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
967 * The exponent (returned in i) minus one gives us
968 * floor(log2(val * 1024 / 1000). The correction makes us
969 * switch to the higher power when the integer part is >= 1000.
970 * (see e41b509d68afb1f for more info)
972 frexp(val
/ (1000.0 / 1024.0), &i
);
974 div
= 1ULL << (i
* 10);
976 return g_strdup_printf("%0.3g %sB", (double)val
/ div
, suffixes
[i
]);
979 char *freq_to_str(uint64_t freq_hz
)
981 static const char *const suffixes
[] = { "", "K", "M", "G", "T", "P", "E" };
982 double freq
= freq_hz
;
985 while (freq
>= 1000.0) {
989 assert(idx
< ARRAY_SIZE(suffixes
));
991 return g_strdup_printf("%0.3g %sHz", freq
, suffixes
[idx
]);
994 int qemu_pstrcmp0(const char **str1
, const char **str2
)
996 return g_strcmp0(*str1
, *str2
);
999 static inline bool starts_with_prefix(const char *dir
)
1001 size_t prefix_len
= strlen(CONFIG_PREFIX
);
1002 return !memcmp(dir
, CONFIG_PREFIX
, prefix_len
) &&
1003 (!dir
[prefix_len
] || G_IS_DIR_SEPARATOR(dir
[prefix_len
]));
1006 /* Return the next path component in dir, and store its length in *p_len. */
1007 static inline const char *next_component(const char *dir
, int *p_len
)
1010 while ((*dir
&& G_IS_DIR_SEPARATOR(*dir
)) ||
1011 (*dir
== '.' && (G_IS_DIR_SEPARATOR(dir
[1]) || dir
[1] == '\0'))) {
1015 while (dir
[len
] && !G_IS_DIR_SEPARATOR(dir
[len
])) {
1022 char *get_relocated_path(const char *dir
)
1024 size_t prefix_len
= strlen(CONFIG_PREFIX
);
1025 const char *bindir
= CONFIG_BINDIR
;
1026 const char *exec_dir
= qemu_get_exec_dir();
1028 int len_dir
, len_bindir
;
1030 /* Fail if qemu_init_exec_dir was not called. */
1031 assert(exec_dir
[0]);
1032 if (!starts_with_prefix(dir
) || !starts_with_prefix(bindir
)) {
1033 return g_strdup(dir
);
1036 result
= g_string_new(exec_dir
);
1038 /* Advance over common components. */
1039 len_dir
= len_bindir
= prefix_len
;
1042 bindir
+= len_bindir
;
1043 dir
= next_component(dir
, &len_dir
);
1044 bindir
= next_component(bindir
, &len_bindir
);
1045 } while (len_dir
&& len_dir
== len_bindir
&& !memcmp(dir
, bindir
, len_dir
));
1047 /* Ascend from bindir to the common prefix with dir. */
1048 while (len_bindir
) {
1049 bindir
+= len_bindir
;
1050 g_string_append(result
, "/..");
1051 bindir
= next_component(bindir
, &len_bindir
);
1055 assert(G_IS_DIR_SEPARATOR(dir
[-1]));
1056 g_string_append(result
, dir
- 1);