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"
34 void strpadcpy(char *buf
, int buf_size
, const char *str
, char pad
)
36 int len
= qemu_strnlen(str
, buf_size
);
37 memcpy(buf
, str
, len
);
38 memset(buf
+ len
, pad
, buf_size
- len
);
41 void pstrcpy(char *buf
, int buf_size
, const char *str
)
51 if (c
== 0 || q
>= buf
+ buf_size
- 1)
58 /* strcat and truncate. */
59 char *pstrcat(char *buf
, int buf_size
, const char *s
)
64 pstrcpy(buf
+ len
, buf_size
- len
, s
);
68 int strstart(const char *str
, const char *val
, const char **ptr
)
84 int stristart(const char *str
, const char *val
, const char **ptr
)
90 if (qemu_toupper(*p
) != qemu_toupper(*q
))
100 /* XXX: use host strnlen if available ? */
101 int qemu_strnlen(const char *s
, int max_len
)
105 for(i
= 0; i
< max_len
; i
++) {
113 char *qemu_strsep(char **input
, const char *delim
)
115 char *result
= *input
;
116 if (result
!= NULL
) {
119 for (p
= result
; *p
!= '\0'; p
++) {
120 if (strchr(delim
, *p
)) {
134 time_t mktimegm(struct tm
*tm
)
137 int y
= tm
->tm_year
+ 1900, m
= tm
->tm_mon
+ 1, d
= tm
->tm_mday
;
142 t
= 86400ULL * (d
+ (153 * m
- 457) / 5 + 365 * y
+ y
/ 4 - y
/ 100 +
144 t
+= 3600 * tm
->tm_hour
+ 60 * tm
->tm_min
+ tm
->tm_sec
;
149 * Make sure data goes on disk, but if possible do not bother to
150 * write out the inode just for timestamp updates.
152 * Unfortunately even in 2009 many operating systems do not support
153 * fdatasync and have to fall back to fsync.
155 int qemu_fdatasync(int fd
)
157 #ifdef CONFIG_FDATASYNC
158 return fdatasync(fd
);
164 /* vector definitions */
167 /* The altivec.h header says we're allowed to undef these for
168 * C++ compatibility. Here we don't care about C++, but we
169 * undef them anyway to avoid namespace pollution.
174 #define VECTYPE __vector unsigned char
175 #define SPLAT(p) vec_splat(vec_ld(0, p), 0)
176 #define ALL_EQ(v1, v2) vec_all_eq(v1, v2)
177 #define VEC_OR(v1, v2) ((v1) | (v2))
178 /* altivec.h may redefine the bool macro as vector type.
179 * Reset it to POSIX semantics. */
181 #elif defined __SSE2__
182 #include <emmintrin.h>
183 #define VECTYPE __m128i
184 #define SPLAT(p) _mm_set1_epi8(*(p))
185 #define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
186 #define VEC_OR(v1, v2) (_mm_or_si128(v1, v2))
187 #elif defined(__aarch64__)
188 #include "arm_neon.h"
189 #define VECTYPE uint64x2_t
190 #define ALL_EQ(v1, v2) \
191 ((vgetq_lane_u64(v1, 0) == vgetq_lane_u64(v2, 0)) && \
192 (vgetq_lane_u64(v1, 1) == vgetq_lane_u64(v2, 1)))
193 #define VEC_OR(v1, v2) ((v1) | (v2))
195 #define VECTYPE unsigned long
196 #define SPLAT(p) (*(p) * (~0UL / 255))
197 #define ALL_EQ(v1, v2) ((v1) == (v2))
198 #define VEC_OR(v1, v2) ((v1) | (v2))
201 #define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
204 can_use_buffer_find_nonzero_offset_inner(const void *buf
, size_t len
)
206 return (len
% (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
207 * sizeof(VECTYPE
)) == 0
208 && ((uintptr_t) buf
) % sizeof(VECTYPE
) == 0);
212 * Searches for an area with non-zero content in a buffer
214 * Attention! The len must be a multiple of
215 * BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR * sizeof(VECTYPE)
216 * and addr must be a multiple of sizeof(VECTYPE) due to
217 * restriction of optimizations in this function.
219 * can_use_buffer_find_nonzero_offset_inner() can be used to
220 * check these requirements.
222 * The return value is the offset of the non-zero area rounded
223 * down to a multiple of sizeof(VECTYPE) for the first
224 * BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR chunks and down to
225 * BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR * sizeof(VECTYPE)
228 * If the buffer is all zero the return value is equal to len.
231 static size_t buffer_find_nonzero_offset_inner(const void *buf
, size_t len
)
233 const VECTYPE
*p
= buf
;
234 const VECTYPE zero
= (VECTYPE
){0};
237 assert(can_use_buffer_find_nonzero_offset_inner(buf
, len
));
243 for (i
= 0; i
< BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
; i
++) {
244 if (!ALL_EQ(p
[i
], zero
)) {
245 return i
* sizeof(VECTYPE
);
249 for (i
= BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
;
250 i
< len
/ sizeof(VECTYPE
);
251 i
+= BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
) {
252 VECTYPE tmp0
= VEC_OR(p
[i
+ 0], p
[i
+ 1]);
253 VECTYPE tmp1
= VEC_OR(p
[i
+ 2], p
[i
+ 3]);
254 VECTYPE tmp2
= VEC_OR(p
[i
+ 4], p
[i
+ 5]);
255 VECTYPE tmp3
= VEC_OR(p
[i
+ 6], p
[i
+ 7]);
256 VECTYPE tmp01
= VEC_OR(tmp0
, tmp1
);
257 VECTYPE tmp23
= VEC_OR(tmp2
, tmp3
);
258 if (!ALL_EQ(VEC_OR(tmp01
, tmp23
), zero
)) {
263 return i
* sizeof(VECTYPE
);
266 #if defined CONFIG_AVX2_OPT
267 #pragma GCC push_options
268 #pragma GCC target("avx2")
270 #include <immintrin.h>
272 #define AVX2_VECTYPE __m256i
273 #define AVX2_SPLAT(p) _mm256_set1_epi8(*(p))
274 #define AVX2_ALL_EQ(v1, v2) \
275 (_mm256_movemask_epi8(_mm256_cmpeq_epi8(v1, v2)) == 0xFFFFFFFF)
276 #define AVX2_VEC_OR(v1, v2) (_mm256_or_si256(v1, v2))
279 can_use_buffer_find_nonzero_offset_avx2(const void *buf
, size_t len
)
281 return (len
% (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
282 * sizeof(AVX2_VECTYPE
)) == 0
283 && ((uintptr_t) buf
) % sizeof(AVX2_VECTYPE
) == 0);
286 static size_t buffer_find_nonzero_offset_avx2(const void *buf
, size_t len
)
288 const AVX2_VECTYPE
*p
= buf
;
289 const AVX2_VECTYPE zero
= (AVX2_VECTYPE
){0};
292 assert(can_use_buffer_find_nonzero_offset_avx2(buf
, len
));
298 for (i
= 0; i
< BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
; i
++) {
299 if (!AVX2_ALL_EQ(p
[i
], zero
)) {
300 return i
* sizeof(AVX2_VECTYPE
);
304 for (i
= BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
;
305 i
< len
/ sizeof(AVX2_VECTYPE
);
306 i
+= BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
) {
307 AVX2_VECTYPE tmp0
= AVX2_VEC_OR(p
[i
+ 0], p
[i
+ 1]);
308 AVX2_VECTYPE tmp1
= AVX2_VEC_OR(p
[i
+ 2], p
[i
+ 3]);
309 AVX2_VECTYPE tmp2
= AVX2_VEC_OR(p
[i
+ 4], p
[i
+ 5]);
310 AVX2_VECTYPE tmp3
= AVX2_VEC_OR(p
[i
+ 6], p
[i
+ 7]);
311 AVX2_VECTYPE tmp01
= AVX2_VEC_OR(tmp0
, tmp1
);
312 AVX2_VECTYPE tmp23
= AVX2_VEC_OR(tmp2
, tmp3
);
313 if (!AVX2_ALL_EQ(AVX2_VEC_OR(tmp01
, tmp23
), zero
)) {
318 return i
* sizeof(AVX2_VECTYPE
);
321 static bool avx2_support(void)
325 if (__get_cpuid_max(0, NULL
) < 7) {
329 __cpuid_count(7, 0, a
, b
, c
, d
);
334 bool can_use_buffer_find_nonzero_offset(const void *buf
, size_t len
) \
335 __attribute__ ((ifunc("can_use_buffer_find_nonzero_offset_ifunc")));
336 size_t buffer_find_nonzero_offset(const void *buf
, size_t len
) \
337 __attribute__ ((ifunc("buffer_find_nonzero_offset_ifunc")));
339 static void *buffer_find_nonzero_offset_ifunc(void)
341 typeof(buffer_find_nonzero_offset
) *func
= (avx2_support()) ?
342 buffer_find_nonzero_offset_avx2
: buffer_find_nonzero_offset_inner
;
347 static void *can_use_buffer_find_nonzero_offset_ifunc(void)
349 typeof(can_use_buffer_find_nonzero_offset
) *func
= (avx2_support()) ?
350 can_use_buffer_find_nonzero_offset_avx2
:
351 can_use_buffer_find_nonzero_offset_inner
;
355 #pragma GCC pop_options
357 bool can_use_buffer_find_nonzero_offset(const void *buf
, size_t len
)
359 return can_use_buffer_find_nonzero_offset_inner(buf
, len
);
362 size_t buffer_find_nonzero_offset(const void *buf
, size_t len
)
364 return buffer_find_nonzero_offset_inner(buf
, len
);
369 * Checks if a buffer is all zeroes
371 * Attention! The len must be a multiple of 4 * sizeof(long) due to
372 * restriction of optimizations in this function.
374 bool buffer_is_zero(const void *buf
, size_t len
)
377 * Use long as the biggest available internal data type that fits into the
378 * CPU register and unroll the loop to smooth out the effect of memory
384 const long * const data
= buf
;
386 /* use vector optimized zero check if possible */
387 if (can_use_buffer_find_nonzero_offset(buf
, len
)) {
388 return buffer_find_nonzero_offset(buf
, len
) == len
;
391 assert(len
% (4 * sizeof(long)) == 0);
394 for (i
= 0; i
< len
; i
+= 4) {
400 if (d0
|| d1
|| d2
|| d3
) {
409 /* Sets a specific flag */
410 int fcntl_setfl(int fd
, int flag
)
414 flags
= fcntl(fd
, F_GETFL
);
418 if (fcntl(fd
, F_SETFL
, flags
| flag
) == -1)
425 static int64_t suffix_mul(char suffix
, int64_t unit
)
427 switch (qemu_toupper(suffix
)) {
428 case QEMU_STRTOSZ_DEFSUFFIX_B
:
430 case QEMU_STRTOSZ_DEFSUFFIX_KB
:
432 case QEMU_STRTOSZ_DEFSUFFIX_MB
:
434 case QEMU_STRTOSZ_DEFSUFFIX_GB
:
435 return unit
* unit
* unit
;
436 case QEMU_STRTOSZ_DEFSUFFIX_TB
:
437 return unit
* unit
* unit
* unit
;
438 case QEMU_STRTOSZ_DEFSUFFIX_PB
:
439 return unit
* unit
* unit
* unit
* unit
;
440 case QEMU_STRTOSZ_DEFSUFFIX_EB
:
441 return unit
* unit
* unit
* unit
* unit
* unit
;
447 * Convert string to bytes, allowing either B/b for bytes, K/k for KB,
448 * M/m for MB, G/g for GB or T/t for TB. End pointer will be returned
449 * in *end, if not NULL. Return -ERANGE on overflow, Return -EINVAL on
452 int64_t qemu_strtosz_suffix_unit(const char *nptr
, char **end
,
453 const char default_suffix
, int64_t unit
)
455 int64_t retval
= -EINVAL
;
458 int mul_required
= 0;
459 double val
, mul
, integral
, fraction
;
462 val
= strtod(nptr
, &endptr
);
463 if (isnan(val
) || endptr
== nptr
|| errno
!= 0) {
466 fraction
= modf(val
, &integral
);
471 mul
= suffix_mul(c
, unit
);
475 mul
= suffix_mul(default_suffix
, unit
);
478 if (mul
== 1 && mul_required
) {
481 if ((val
* mul
>= INT64_MAX
) || val
< 0) {
495 int64_t qemu_strtosz_suffix(const char *nptr
, char **end
,
496 const char default_suffix
)
498 return qemu_strtosz_suffix_unit(nptr
, end
, default_suffix
, 1024);
501 int64_t qemu_strtosz(const char *nptr
, char **end
)
503 return qemu_strtosz_suffix(nptr
, end
, QEMU_STRTOSZ_DEFSUFFIX_MB
);
507 * Helper function for qemu_strto*l() functions.
509 static int check_strtox_error(const char *p
, char *endptr
, const char **next
,
512 /* If no conversion was performed, prefer BSD behavior over glibc
515 if (err
== 0 && endptr
== p
) {
518 if (!next
&& *endptr
) {
528 * QEMU wrappers for strtol(), strtoll(), strtoul(), strotull() C functions.
530 * Convert ASCII string @nptr to a long integer value
531 * from the given @base. Parameters @nptr, @endptr, @base
532 * follows same semantics as strtol() C function.
534 * Unlike from strtol() function, if @endptr is not NULL, this
535 * function will return -EINVAL whenever it cannot fully convert
536 * the string in @nptr with given @base to a long. This function returns
537 * the result of the conversion only through the @result parameter.
539 * If NULL is passed in @endptr, then the whole string in @ntpr
540 * is a number otherwise it returns -EINVAL.
543 * Unlike from strtol() function, this wrapper returns either
544 * -EINVAL or the errno set by strtol() function (e.g -ERANGE).
545 * If the conversion overflows, -ERANGE is returned, and @result
546 * is set to the max value of the desired type
547 * (e.g. LONG_MAX, LLONG_MAX, ULONG_MAX, ULLONG_MAX). If the case
548 * of underflow, -ERANGE is returned, and @result is set to the min
549 * value of the desired type. For strtol(), strtoll(), @result is set to
550 * LONG_MIN, LLONG_MIN, respectively, and for strtoul(), strtoull() it
553 int qemu_strtol(const char *nptr
, const char **endptr
, int base
,
565 *result
= strtol(nptr
, &p
, base
);
566 err
= check_strtox_error(nptr
, p
, endptr
, errno
);
572 * Converts ASCII string to an unsigned long integer.
574 * If string contains a negative number, value will be converted to
575 * the unsigned representation of the signed value, unless the original
576 * (nonnegated) value would overflow, in this case, it will set @result
577 * to ULONG_MAX, and return ERANGE.
579 * The same behavior holds, for qemu_strtoull() but sets @result to
580 * ULLONG_MAX instead of ULONG_MAX.
582 * See qemu_strtol() documentation for more info.
584 int qemu_strtoul(const char *nptr
, const char **endptr
, int base
,
585 unsigned long *result
)
596 *result
= strtoul(nptr
, &p
, base
);
597 /* Windows returns 1 for negative out-of-range values. */
598 if (errno
== ERANGE
) {
601 err
= check_strtox_error(nptr
, p
, endptr
, errno
);
607 * Converts ASCII string to a long long integer.
609 * See qemu_strtol() documentation for more info.
611 int qemu_strtoll(const char *nptr
, const char **endptr
, int base
,
623 *result
= strtoll(nptr
, &p
, base
);
624 err
= check_strtox_error(nptr
, p
, endptr
, errno
);
630 * Converts ASCII string to an unsigned long long integer.
632 * See qemu_strtol() documentation for more info.
634 int qemu_strtoull(const char *nptr
, const char **endptr
, int base
,
646 *result
= strtoull(nptr
, &p
, base
);
647 /* Windows returns 1 for negative out-of-range values. */
648 if (errno
== ERANGE
) {
651 err
= check_strtox_error(nptr
, p
, endptr
, errno
);
659 * @s: String to parse
660 * @value: Destination for parsed integer value
661 * @endptr: Destination for pointer to first character not consumed
662 * @base: integer base, between 2 and 36 inclusive, or 0
664 * Parse unsigned integer
666 * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
667 * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
669 * If @s is null, or @base is invalid, or @s doesn't start with an
670 * integer in the syntax above, set *@value to 0, *@endptr to @s, and
673 * Set *@endptr to point right beyond the parsed integer (even if the integer
674 * overflows or is negative, all digits will be parsed and *@endptr will
675 * point right beyond them).
677 * If the integer is negative, set *@value to 0, and return -ERANGE.
679 * If the integer overflows unsigned long long, set *@value to
680 * ULLONG_MAX, and return -ERANGE.
682 * Else, set *@value to the parsed integer, and return 0.
684 int parse_uint(const char *s
, unsigned long long *value
, char **endptr
,
688 char *endp
= (char *)s
;
689 unsigned long long val
= 0;
697 val
= strtoull(s
, &endp
, base
);
708 /* make sure we reject negative numbers: */
709 while (isspace((unsigned char)*s
)) {
727 * @s: String to parse
728 * @value: Destination for parsed integer value
729 * @base: integer base, between 2 and 36 inclusive, or 0
731 * Parse unsigned integer from entire string
733 * Have the same behavior of parse_uint(), but with an additional check
734 * for additional data after the parsed number. If extra characters are present
735 * after the parsed number, the function will return -EINVAL, and *@v will
738 int parse_uint_full(const char *s
, unsigned long long *value
, int base
)
743 r
= parse_uint(s
, value
, &endp
, base
);
755 int qemu_parse_fd(const char *param
)
761 fd
= strtol(param
, &endptr
, 10);
762 if (param
== endptr
/* no conversion performed */ ||
763 errno
!= 0 /* not representable as long; possibly others */ ||
764 *endptr
!= '\0' /* final string not empty */ ||
765 fd
< 0 /* invalid as file descriptor */ ||
766 fd
> INT_MAX
/* not representable as int */) {
773 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
774 * Input is limited to 14-bit numbers
776 int uleb128_encode_small(uint8_t *out
, uint32_t n
)
778 g_assert(n
<= 0x3fff);
783 *out
++ = (n
& 0x7f) | 0x80;
789 int uleb128_decode_small(const uint8_t *in
, uint32_t *n
)
796 /* we exceed 14 bit number */
806 * helper to parse debug environment variables
808 int parse_debug_env(const char *name
, int max
, int initial
)
810 char *debug_env
= getenv(name
);
818 debug
= strtol(debug_env
, &inv
, 10);
819 if (inv
== debug_env
) {
822 if (debug
< 0 || debug
> max
|| errno
!= 0) {
823 fprintf(stderr
, "warning: %s not in [0, %d]", name
, max
);
830 * Helper to print ethernet mac address
832 const char *qemu_ether_ntoa(const MACAddr
*mac
)
836 snprintf(ret
, sizeof(ret
), "%02x:%02x:%02x:%02x:%02x:%02x",
837 mac
->a
[0], mac
->a
[1], mac
->a
[2], mac
->a
[3], mac
->a
[4], mac
->a
[5]);