]>
git.ipfire.org Git - thirdparty/qemu.git/blob - util/cutils.c
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/sockets.h"
32 #include "qemu/ctype.h"
33 #include "qemu/cutils.h"
34 #include "qemu/error-report.h"
36 void strpadcpy(char *buf
, int buf_size
, const char *str
, char pad
)
38 int len
= qemu_strnlen(str
, buf_size
);
39 memcpy(buf
, str
, len
);
40 memset(buf
+ len
, pad
, buf_size
- len
);
43 void pstrcpy(char *buf
, int buf_size
, const char *str
)
53 if (c
== 0 || q
>= buf
+ buf_size
- 1)
60 /* strcat and truncate. */
61 char *pstrcat(char *buf
, int buf_size
, const char *s
)
66 pstrcpy(buf
+ len
, buf_size
- len
, s
);
70 int strstart(const char *str
, const char *val
, const char **ptr
)
86 int stristart(const char *str
, const char *val
, const char **ptr
)
92 if (qemu_toupper(*p
) != qemu_toupper(*q
))
102 /* XXX: use host strnlen if available ? */
103 int qemu_strnlen(const char *s
, int max_len
)
107 for(i
= 0; i
< max_len
; i
++) {
115 char *qemu_strsep(char **input
, const char *delim
)
117 char *result
= *input
;
118 if (result
!= NULL
) {
121 for (p
= result
; *p
!= '\0'; p
++) {
122 if (strchr(delim
, *p
)) {
136 time_t mktimegm(struct tm
*tm
)
139 int y
= tm
->tm_year
+ 1900, m
= tm
->tm_mon
+ 1, d
= tm
->tm_mday
;
144 t
= 86400ULL * (d
+ (153 * m
- 457) / 5 + 365 * y
+ y
/ 4 - y
/ 100 +
146 t
+= 3600 * tm
->tm_hour
+ 60 * tm
->tm_min
+ tm
->tm_sec
;
151 * Make sure data goes on disk, but if possible do not bother to
152 * write out the inode just for timestamp updates.
154 * Unfortunately even in 2009 many operating systems do not support
155 * fdatasync and have to fall back to fsync.
157 int qemu_fdatasync(int fd
)
159 #ifdef CONFIG_FDATASYNC
160 return fdatasync(fd
);
167 /* Sets a specific flag */
168 int fcntl_setfl(int fd
, int flag
)
172 flags
= fcntl(fd
, F_GETFL
);
176 if (fcntl(fd
, F_SETFL
, flags
| flag
) == -1)
183 static int64_t suffix_mul(char suffix
, int64_t unit
)
185 switch (qemu_toupper(suffix
)) {
193 return unit
* unit
* unit
;
195 return unit
* unit
* unit
* unit
;
197 return unit
* unit
* unit
* unit
* unit
;
199 return unit
* unit
* unit
* unit
* unit
* unit
;
205 * Convert string to bytes, allowing either B/b for bytes, K/k for KB,
206 * M/m for MB, G/g for GB or T/t for TB. End pointer will be returned
207 * in *end, if not NULL. Return -ERANGE on overflow, and -EINVAL on
210 static int do_strtosz(const char *nptr
, const char **end
,
211 const char default_suffix
, int64_t unit
,
217 int mul_required
= 0;
218 double val
, mul
, integral
, fraction
;
220 retval
= qemu_strtod_finite(nptr
, &endptr
, &val
);
224 fraction
= modf(val
, &integral
);
229 mul
= suffix_mul(c
, unit
);
233 mul
= suffix_mul(default_suffix
, unit
);
236 if (mul
== 1 && mul_required
) {
241 * Values >= 0xfffffffffffffc00 overflow uint64_t after their trip
242 * through double (53 bits of precision).
244 if ((val
* mul
>= 0xfffffffffffffc00) || val
< 0) {
254 } else if (*endptr
) {
261 int qemu_strtosz(const char *nptr
, const char **end
, uint64_t *result
)
263 return do_strtosz(nptr
, end
, 'B', 1024, result
);
266 int qemu_strtosz_MiB(const char *nptr
, const char **end
, uint64_t *result
)
268 return do_strtosz(nptr
, end
, 'M', 1024, result
);
271 int qemu_strtosz_metric(const char *nptr
, const char **end
, uint64_t *result
)
273 return do_strtosz(nptr
, end
, 'B', 1000, result
);
277 * Helper function for error checking after strtol() and the like
279 static int check_strtox_error(const char *nptr
, char *ep
,
280 const char **endptr
, int libc_errno
)
287 /* Turn "no conversion" into an error */
288 if (libc_errno
== 0 && ep
== nptr
) {
292 /* Fail when we're expected to consume the string, but didn't */
293 if (!endptr
&& *ep
) {
301 * Convert string @nptr to an integer, and store it in @result.
303 * This is a wrapper around strtol() that is harder to misuse.
304 * Semantics of @nptr, @endptr, @base match strtol() with differences
307 * @nptr may be null, and no conversion is performed then.
309 * If no conversion is performed, store @nptr in *@endptr and return
312 * If @endptr is null, and the string isn't fully converted, return
313 * -EINVAL. This is the case when the pointer that would be stored in
314 * a non-null @endptr points to a character other than '\0'.
316 * If the conversion overflows @result, store INT_MAX in @result,
317 * and return -ERANGE.
319 * If the conversion underflows @result, store INT_MIN in @result,
320 * and return -ERANGE.
322 * Else store the converted value in @result, and return zero.
324 int qemu_strtoi(const char *nptr
, const char **endptr
, int base
,
330 assert((unsigned) base
<= 36 && base
!= 1);
339 lresult
= strtoll(nptr
, &ep
, base
);
340 if (lresult
< INT_MIN
) {
343 } else if (lresult
> INT_MAX
) {
349 return check_strtox_error(nptr
, ep
, endptr
, errno
);
353 * Convert string @nptr to an unsigned integer, and store it in @result.
355 * This is a wrapper around strtoul() that is harder to misuse.
356 * Semantics of @nptr, @endptr, @base match strtoul() with differences
359 * @nptr may be null, and no conversion is performed then.
361 * If no conversion is performed, store @nptr in *@endptr and return
364 * If @endptr is null, and the string isn't fully converted, return
365 * -EINVAL. This is the case when the pointer that would be stored in
366 * a non-null @endptr points to a character other than '\0'.
368 * If the conversion overflows @result, store UINT_MAX in @result,
369 * and return -ERANGE.
371 * Else store the converted value in @result, and return zero.
373 * Note that a number with a leading minus sign gets converted without
374 * the minus sign, checked for overflow (see above), then negated (in
375 * @result's type). This is exactly how strtoul() works.
377 int qemu_strtoui(const char *nptr
, const char **endptr
, int base
,
378 unsigned int *result
)
383 assert((unsigned) base
<= 36 && base
!= 1);
392 lresult
= strtoull(nptr
, &ep
, base
);
394 /* Windows returns 1 for negative out-of-range values. */
395 if (errno
== ERANGE
) {
398 if (lresult
> UINT_MAX
) {
401 } else if (lresult
< INT_MIN
) {
408 return check_strtox_error(nptr
, ep
, endptr
, errno
);
412 * Convert string @nptr to a long integer, and store it in @result.
414 * This is a wrapper around strtol() that is harder to misuse.
415 * Semantics of @nptr, @endptr, @base match strtol() with differences
418 * @nptr may be null, and no conversion is performed then.
420 * If no conversion is performed, store @nptr in *@endptr and return
423 * If @endptr is null, and the string isn't fully converted, return
424 * -EINVAL. This is the case when the pointer that would be stored in
425 * a non-null @endptr points to a character other than '\0'.
427 * If the conversion overflows @result, store LONG_MAX in @result,
428 * and return -ERANGE.
430 * If the conversion underflows @result, store LONG_MIN in @result,
431 * and return -ERANGE.
433 * Else store the converted value in @result, and return zero.
435 int qemu_strtol(const char *nptr
, const char **endptr
, int base
,
440 assert((unsigned) base
<= 36 && base
!= 1);
449 *result
= strtol(nptr
, &ep
, base
);
450 return check_strtox_error(nptr
, ep
, endptr
, errno
);
454 * Convert string @nptr to an unsigned long, and store it in @result.
456 * This is a wrapper around strtoul() that is harder to misuse.
457 * Semantics of @nptr, @endptr, @base match strtoul() with differences
460 * @nptr may be null, and no conversion is performed then.
462 * If no conversion is performed, store @nptr in *@endptr and return
465 * If @endptr is null, and the string isn't fully converted, return
466 * -EINVAL. This is the case when the pointer that would be stored in
467 * a non-null @endptr points to a character other than '\0'.
469 * If the conversion overflows @result, store ULONG_MAX in @result,
470 * and return -ERANGE.
472 * Else store the converted value in @result, and return zero.
474 * Note that a number with a leading minus sign gets converted without
475 * the minus sign, checked for overflow (see above), then negated (in
476 * @result's type). This is exactly how strtoul() works.
478 int qemu_strtoul(const char *nptr
, const char **endptr
, int base
,
479 unsigned long *result
)
483 assert((unsigned) base
<= 36 && base
!= 1);
492 *result
= strtoul(nptr
, &ep
, base
);
493 /* Windows returns 1 for negative out-of-range values. */
494 if (errno
== ERANGE
) {
497 return check_strtox_error(nptr
, ep
, endptr
, errno
);
501 * Convert string @nptr to an int64_t.
503 * Works like qemu_strtol(), except it stores INT64_MAX on overflow,
504 * and INT_MIN on underflow.
506 int qemu_strtoi64(const char *nptr
, const char **endptr
, int base
,
511 assert((unsigned) base
<= 36 && base
!= 1);
520 /* FIXME This assumes int64_t is long long */
521 *result
= strtoll(nptr
, &ep
, base
);
522 return check_strtox_error(nptr
, ep
, endptr
, errno
);
526 * Convert string @nptr to an uint64_t.
528 * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow.
530 int qemu_strtou64(const char *nptr
, const char **endptr
, int base
,
535 assert((unsigned) base
<= 36 && base
!= 1);
544 /* FIXME This assumes uint64_t is unsigned long long */
545 *result
= strtoull(nptr
, &ep
, base
);
546 /* Windows returns 1 for negative out-of-range values. */
547 if (errno
== ERANGE
) {
550 return check_strtox_error(nptr
, ep
, endptr
, errno
);
554 * Convert string @nptr to a double.
556 * This is a wrapper around strtod() that is harder to misuse.
557 * Semantics of @nptr and @endptr match strtod() with differences
560 * @nptr may be null, and no conversion is performed then.
562 * If no conversion is performed, store @nptr in *@endptr and return
565 * If @endptr is null, and the string isn't fully converted, return
566 * -EINVAL. This is the case when the pointer that would be stored in
567 * a non-null @endptr points to a character other than '\0'.
569 * If the conversion overflows, store +/-HUGE_VAL in @result, depending
570 * on the sign, and return -ERANGE.
572 * If the conversion underflows, store +/-0.0 in @result, depending on the
573 * sign, and return -ERANGE.
575 * Else store the converted value in @result, and return zero.
577 int qemu_strtod(const char *nptr
, const char **endptr
, double *result
)
589 *result
= strtod(nptr
, &ep
);
590 return check_strtox_error(nptr
, ep
, endptr
, errno
);
594 * Convert string @nptr to a finite double.
596 * Works like qemu_strtod(), except that "NaN" and "inf" are rejected
597 * with -EINVAL and no conversion is performed.
599 int qemu_strtod_finite(const char *nptr
, const char **endptr
, double *result
)
604 ret
= qemu_strtod(nptr
, endptr
, &tmp
);
605 if (!ret
&& !isfinite(tmp
)) {
612 if (ret
!= -EINVAL
) {
619 * Searches for the first occurrence of 'c' in 's', and returns a pointer
620 * to the trailing null byte if none was found.
622 #ifndef HAVE_STRCHRNUL
623 const char *qemu_strchrnul(const char *s
, int c
)
625 const char *e
= strchr(s
, c
);
636 * @s: String to parse
637 * @value: Destination for parsed integer value
638 * @endptr: Destination for pointer to first character not consumed
639 * @base: integer base, between 2 and 36 inclusive, or 0
641 * Parse unsigned integer
643 * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
644 * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
646 * If @s is null, or @base is invalid, or @s doesn't start with an
647 * integer in the syntax above, set *@value to 0, *@endptr to @s, and
650 * Set *@endptr to point right beyond the parsed integer (even if the integer
651 * overflows or is negative, all digits will be parsed and *@endptr will
652 * point right beyond them).
654 * If the integer is negative, set *@value to 0, and return -ERANGE.
656 * If the integer overflows unsigned long long, set *@value to
657 * ULLONG_MAX, and return -ERANGE.
659 * Else, set *@value to the parsed integer, and return 0.
661 int parse_uint(const char *s
, unsigned long long *value
, char **endptr
,
665 char *endp
= (char *)s
;
666 unsigned long long val
= 0;
668 assert((unsigned) base
<= 36 && base
!= 1);
675 val
= strtoull(s
, &endp
, base
);
686 /* make sure we reject negative numbers: */
687 while (qemu_isspace(*s
)) {
705 * @s: String to parse
706 * @value: Destination for parsed integer value
707 * @base: integer base, between 2 and 36 inclusive, or 0
709 * Parse unsigned integer from entire string
711 * Have the same behavior of parse_uint(), but with an additional check
712 * for additional data after the parsed number. If extra characters are present
713 * after the parsed number, the function will return -EINVAL, and *@v will
716 int parse_uint_full(const char *s
, unsigned long long *value
, int base
)
721 r
= parse_uint(s
, value
, &endp
, base
);
733 int qemu_parse_fd(const char *param
)
739 fd
= strtol(param
, &endptr
, 10);
740 if (param
== endptr
/* no conversion performed */ ||
741 errno
!= 0 /* not representable as long; possibly others */ ||
742 *endptr
!= '\0' /* final string not empty */ ||
743 fd
< 0 /* invalid as file descriptor */ ||
744 fd
> INT_MAX
/* not representable as int */) {
751 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
752 * Input is limited to 14-bit numbers
754 int uleb128_encode_small(uint8_t *out
, uint32_t n
)
756 g_assert(n
<= 0x3fff);
761 *out
++ = (n
& 0x7f) | 0x80;
767 int uleb128_decode_small(const uint8_t *in
, uint32_t *n
)
774 /* we exceed 14 bit number */
784 * helper to parse debug environment variables
786 int parse_debug_env(const char *name
, int max
, int initial
)
788 char *debug_env
= getenv(name
);
796 debug
= strtol(debug_env
, &inv
, 10);
797 if (inv
== debug_env
) {
800 if (debug
< 0 || debug
> max
|| errno
!= 0) {
801 warn_report("%s not in [0, %d]", name
, max
);
808 * Helper to print ethernet mac address
810 const char *qemu_ether_ntoa(const MACAddr
*mac
)
814 snprintf(ret
, sizeof(ret
), "%02x:%02x:%02x:%02x:%02x:%02x",
815 mac
->a
[0], mac
->a
[1], mac
->a
[2], mac
->a
[3], mac
->a
[4], mac
->a
[5]);
821 * Return human readable string for size @val.
822 * @val can be anything that uint64_t allows (no more than "16 EiB").
823 * Use IEC binary units like KiB, MiB, and so forth.
824 * Caller is responsible for passing it to g_free().
826 char *size_to_str(uint64_t val
)
828 static const char *suffixes
[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
833 * The exponent (returned in i) minus one gives us
834 * floor(log2(val * 1024 / 1000). The correction makes us
835 * switch to the higher power when the integer part is >= 1000.
836 * (see e41b509d68afb1f for more info)
838 frexp(val
/ (1000.0 / 1024.0), &i
);
840 div
= 1ULL << (i
* 10);
842 return g_strdup_printf("%0.3g %sB", (double)val
/ div
, suffixes
[i
]);
845 int qemu_pstrcmp0(const char **str1
, const char **str2
)
847 return g_strcmp0(*str1
, *str2
);