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
);
160 #elif defined(_WIN64)
161 /* TODO: Implement fsync for w64, too. */
169 /* Sets a specific flag */
170 int fcntl_setfl(int fd
, int flag
)
174 flags
= fcntl(fd
, F_GETFL
);
178 if (fcntl(fd
, F_SETFL
, flags
| flag
) == -1)
185 static int64_t suffix_mul(char suffix
, int64_t unit
)
187 switch (qemu_toupper(suffix
)) {
195 return unit
* unit
* unit
;
197 return unit
* unit
* unit
* unit
;
199 return unit
* unit
* unit
* unit
* unit
;
201 return unit
* unit
* unit
* unit
* unit
* unit
;
207 * Convert string to bytes, allowing either B/b for bytes, K/k for KB,
208 * M/m for MB, G/g for GB or T/t for TB. End pointer will be returned
209 * in *end, if not NULL. Return -ERANGE on overflow, and -EINVAL on
212 static int do_strtosz(const char *nptr
, const char **end
,
213 const char default_suffix
, int64_t unit
,
219 int mul_required
= 0;
220 double val
, mul
, integral
, fraction
;
222 retval
= qemu_strtod_finite(nptr
, &endptr
, &val
);
226 fraction
= modf(val
, &integral
);
231 mul
= suffix_mul(c
, unit
);
235 mul
= suffix_mul(default_suffix
, unit
);
238 if (mul
== 1 && mul_required
) {
243 * Values >= 0xfffffffffffffc00 overflow uint64_t after their trip
244 * through double (53 bits of precision).
246 if ((val
* mul
>= 0xfffffffffffffc00) || val
< 0) {
256 } else if (*endptr
) {
263 int qemu_strtosz(const char *nptr
, const char **end
, uint64_t *result
)
265 return do_strtosz(nptr
, end
, 'B', 1024, result
);
268 int qemu_strtosz_MiB(const char *nptr
, const char **end
, uint64_t *result
)
270 return do_strtosz(nptr
, end
, 'M', 1024, result
);
273 int qemu_strtosz_metric(const char *nptr
, const char **end
, uint64_t *result
)
275 return do_strtosz(nptr
, end
, 'B', 1000, result
);
279 * Helper function for error checking after strtol() and the like
281 static int check_strtox_error(const char *nptr
, char *ep
,
282 const char **endptr
, int libc_errno
)
289 /* Turn "no conversion" into an error */
290 if (libc_errno
== 0 && ep
== nptr
) {
294 /* Fail when we're expected to consume the string, but didn't */
295 if (!endptr
&& *ep
) {
303 * Convert string @nptr to an integer, and store it in @result.
305 * This is a wrapper around strtol() that is harder to misuse.
306 * Semantics of @nptr, @endptr, @base match strtol() with differences
309 * @nptr may be null, and no conversion is performed then.
311 * If no conversion is performed, store @nptr in *@endptr and return
314 * If @endptr is null, and the string isn't fully converted, return
315 * -EINVAL. This is the case when the pointer that would be stored in
316 * a non-null @endptr points to a character other than '\0'.
318 * If the conversion overflows @result, store INT_MAX in @result,
319 * and return -ERANGE.
321 * If the conversion underflows @result, store INT_MIN in @result,
322 * and return -ERANGE.
324 * Else store the converted value in @result, and return zero.
326 int qemu_strtoi(const char *nptr
, const char **endptr
, int base
,
332 assert((unsigned) base
<= 36 && base
!= 1);
341 lresult
= strtoll(nptr
, &ep
, base
);
342 if (lresult
< INT_MIN
) {
345 } else if (lresult
> INT_MAX
) {
351 return check_strtox_error(nptr
, ep
, endptr
, errno
);
355 * Convert string @nptr to an unsigned integer, and store it in @result.
357 * This is a wrapper around strtoul() that is harder to misuse.
358 * Semantics of @nptr, @endptr, @base match strtoul() with differences
361 * @nptr may be null, and no conversion is performed then.
363 * If no conversion is performed, store @nptr in *@endptr and return
366 * If @endptr is null, and the string isn't fully converted, return
367 * -EINVAL. This is the case when the pointer that would be stored in
368 * a non-null @endptr points to a character other than '\0'.
370 * If the conversion overflows @result, store UINT_MAX in @result,
371 * and return -ERANGE.
373 * Else store the converted value in @result, and return zero.
375 * Note that a number with a leading minus sign gets converted without
376 * the minus sign, checked for overflow (see above), then negated (in
377 * @result's type). This is exactly how strtoul() works.
379 int qemu_strtoui(const char *nptr
, const char **endptr
, int base
,
380 unsigned int *result
)
385 assert((unsigned) base
<= 36 && base
!= 1);
394 lresult
= strtoull(nptr
, &ep
, base
);
396 /* Windows returns 1 for negative out-of-range values. */
397 if (errno
== ERANGE
) {
400 if (lresult
> UINT_MAX
) {
403 } else if (lresult
< INT_MIN
) {
410 return check_strtox_error(nptr
, ep
, endptr
, errno
);
414 * Convert string @nptr to a long integer, and store it in @result.
416 * This is a wrapper around strtol() that is harder to misuse.
417 * Semantics of @nptr, @endptr, @base match strtol() with differences
420 * @nptr may be null, and no conversion is performed then.
422 * If no conversion is performed, store @nptr in *@endptr and return
425 * If @endptr is null, and the string isn't fully converted, return
426 * -EINVAL. This is the case when the pointer that would be stored in
427 * a non-null @endptr points to a character other than '\0'.
429 * If the conversion overflows @result, store LONG_MAX in @result,
430 * and return -ERANGE.
432 * If the conversion underflows @result, store LONG_MIN in @result,
433 * and return -ERANGE.
435 * Else store the converted value in @result, and return zero.
437 int qemu_strtol(const char *nptr
, const char **endptr
, int base
,
442 assert((unsigned) base
<= 36 && base
!= 1);
451 *result
= strtol(nptr
, &ep
, base
);
452 return check_strtox_error(nptr
, ep
, endptr
, errno
);
456 * Convert string @nptr to an unsigned long, and store it in @result.
458 * This is a wrapper around strtoul() that is harder to misuse.
459 * Semantics of @nptr, @endptr, @base match strtoul() with differences
462 * @nptr may be null, and no conversion is performed then.
464 * If no conversion is performed, store @nptr in *@endptr and return
467 * If @endptr is null, and the string isn't fully converted, return
468 * -EINVAL. This is the case when the pointer that would be stored in
469 * a non-null @endptr points to a character other than '\0'.
471 * If the conversion overflows @result, store ULONG_MAX in @result,
472 * and return -ERANGE.
474 * Else store the converted value in @result, and return zero.
476 * Note that a number with a leading minus sign gets converted without
477 * the minus sign, checked for overflow (see above), then negated (in
478 * @result's type). This is exactly how strtoul() works.
480 int qemu_strtoul(const char *nptr
, const char **endptr
, int base
,
481 unsigned long *result
)
485 assert((unsigned) base
<= 36 && base
!= 1);
494 *result
= strtoul(nptr
, &ep
, base
);
495 /* Windows returns 1 for negative out-of-range values. */
496 if (errno
== ERANGE
) {
499 return check_strtox_error(nptr
, ep
, endptr
, errno
);
503 * Convert string @nptr to an int64_t.
505 * Works like qemu_strtol(), except it stores INT64_MAX on overflow,
506 * and INT_MIN on underflow.
508 int qemu_strtoi64(const char *nptr
, const char **endptr
, int base
,
513 assert((unsigned) base
<= 36 && base
!= 1);
522 /* FIXME This assumes int64_t is long long */
523 *result
= strtoll(nptr
, &ep
, base
);
524 return check_strtox_error(nptr
, ep
, endptr
, errno
);
528 * Convert string @nptr to an uint64_t.
530 * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow.
532 int qemu_strtou64(const char *nptr
, const char **endptr
, int base
,
537 assert((unsigned) base
<= 36 && base
!= 1);
546 /* FIXME This assumes uint64_t is unsigned long long */
547 *result
= strtoull(nptr
, &ep
, base
);
548 /* Windows returns 1 for negative out-of-range values. */
549 if (errno
== ERANGE
) {
552 return check_strtox_error(nptr
, ep
, endptr
, errno
);
556 * Convert string @nptr to a double.
558 * This is a wrapper around strtod() that is harder to misuse.
559 * Semantics of @nptr and @endptr match strtod() with differences
562 * @nptr may be null, and no conversion is performed then.
564 * If no conversion is performed, store @nptr in *@endptr and return
567 * If @endptr is null, and the string isn't fully converted, return
568 * -EINVAL. This is the case when the pointer that would be stored in
569 * a non-null @endptr points to a character other than '\0'.
571 * If the conversion overflows, store +/-HUGE_VAL in @result, depending
572 * on the sign, and return -ERANGE.
574 * If the conversion underflows, store +/-0.0 in @result, depending on the
575 * sign, and return -ERANGE.
577 * Else store the converted value in @result, and return zero.
579 int qemu_strtod(const char *nptr
, const char **endptr
, double *result
)
591 *result
= strtod(nptr
, &ep
);
592 return check_strtox_error(nptr
, ep
, endptr
, errno
);
596 * Convert string @nptr to a finite double.
598 * Works like qemu_strtod(), except that "NaN" and "inf" are rejected
599 * with -EINVAL and no conversion is performed.
601 int qemu_strtod_finite(const char *nptr
, const char **endptr
, double *result
)
606 ret
= qemu_strtod(nptr
, endptr
, &tmp
);
607 if (!ret
&& !isfinite(tmp
)) {
614 if (ret
!= -EINVAL
) {
621 * Searches for the first occurrence of 'c' in 's', and returns a pointer
622 * to the trailing null byte if none was found.
624 #ifndef HAVE_STRCHRNUL
625 const char *qemu_strchrnul(const char *s
, int c
)
627 const char *e
= strchr(s
, c
);
638 * @s: String to parse
639 * @value: Destination for parsed integer value
640 * @endptr: Destination for pointer to first character not consumed
641 * @base: integer base, between 2 and 36 inclusive, or 0
643 * Parse unsigned integer
645 * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
646 * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
648 * If @s is null, or @base is invalid, or @s doesn't start with an
649 * integer in the syntax above, set *@value to 0, *@endptr to @s, and
652 * Set *@endptr to point right beyond the parsed integer (even if the integer
653 * overflows or is negative, all digits will be parsed and *@endptr will
654 * point right beyond them).
656 * If the integer is negative, set *@value to 0, and return -ERANGE.
658 * If the integer overflows unsigned long long, set *@value to
659 * ULLONG_MAX, and return -ERANGE.
661 * Else, set *@value to the parsed integer, and return 0.
663 int parse_uint(const char *s
, unsigned long long *value
, char **endptr
,
667 char *endp
= (char *)s
;
668 unsigned long long val
= 0;
670 assert((unsigned) base
<= 36 && base
!= 1);
677 val
= strtoull(s
, &endp
, base
);
688 /* make sure we reject negative numbers: */
689 while (isspace((unsigned char)*s
)) {
707 * @s: String to parse
708 * @value: Destination for parsed integer value
709 * @base: integer base, between 2 and 36 inclusive, or 0
711 * Parse unsigned integer from entire string
713 * Have the same behavior of parse_uint(), but with an additional check
714 * for additional data after the parsed number. If extra characters are present
715 * after the parsed number, the function will return -EINVAL, and *@v will
718 int parse_uint_full(const char *s
, unsigned long long *value
, int base
)
723 r
= parse_uint(s
, value
, &endp
, base
);
735 int qemu_parse_fd(const char *param
)
741 fd
= strtol(param
, &endptr
, 10);
742 if (param
== endptr
/* no conversion performed */ ||
743 errno
!= 0 /* not representable as long; possibly others */ ||
744 *endptr
!= '\0' /* final string not empty */ ||
745 fd
< 0 /* invalid as file descriptor */ ||
746 fd
> INT_MAX
/* not representable as int */) {
753 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
754 * Input is limited to 14-bit numbers
756 int uleb128_encode_small(uint8_t *out
, uint32_t n
)
758 g_assert(n
<= 0x3fff);
763 *out
++ = (n
& 0x7f) | 0x80;
769 int uleb128_decode_small(const uint8_t *in
, uint32_t *n
)
776 /* we exceed 14 bit number */
786 * helper to parse debug environment variables
788 int parse_debug_env(const char *name
, int max
, int initial
)
790 char *debug_env
= getenv(name
);
798 debug
= strtol(debug_env
, &inv
, 10);
799 if (inv
== debug_env
) {
802 if (debug
< 0 || debug
> max
|| errno
!= 0) {
803 warn_report("%s not in [0, %d]", name
, max
);
810 * Helper to print ethernet mac address
812 const char *qemu_ether_ntoa(const MACAddr
*mac
)
816 snprintf(ret
, sizeof(ret
), "%02x:%02x:%02x:%02x:%02x:%02x",
817 mac
->a
[0], mac
->a
[1], mac
->a
[2], mac
->a
[3], mac
->a
[4], mac
->a
[5]);
823 * Return human readable string for size @val.
824 * @val can be anything that uint64_t allows (no more than "16 EiB").
825 * Use IEC binary units like KiB, MiB, and so forth.
826 * Caller is responsible for passing it to g_free().
828 char *size_to_str(uint64_t val
)
830 static const char *suffixes
[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
835 * The exponent (returned in i) minus one gives us
836 * floor(log2(val * 1024 / 1000). The correction makes us
837 * switch to the higher power when the integer part is >= 1000.
838 * (see e41b509d68afb1f for more info)
840 frexp(val
/ (1000.0 / 1024.0), &i
);
842 div
= 1ULL << (i
* 10);
844 return g_strdup_printf("%0.3g %sB", (double)val
/ div
, suffixes
[i
]);
847 int qemu_pstrcmp0(const char **str1
, const char **str2
)
849 return g_strcmp0(*str1
, *str2
);