]> Git Repo - qemu.git/blob - util/cutils.c
Merge remote-tracking branch 'remotes/stefanberger/tags/pull-tpm-2018-12-04-1' into...
[qemu.git] / util / cutils.c
1 /*
2  * Simple C functions to supplement the C library
3  *
4  * Copyright (c) 2006 Fabrice Bellard
5  *
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:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
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
22  * THE SOFTWARE.
23  */
24 #include "qemu/osdep.h"
25 #include "qemu-common.h"
26 #include "qemu/host-utils.h"
27 #include <math.h>
28
29 #include "qemu/sockets.h"
30 #include "qemu/iov.h"
31 #include "net/net.h"
32 #include "qemu/cutils.h"
33 #include "qemu/error-report.h"
34
35 void strpadcpy(char *buf, int buf_size, const char *str, char pad)
36 {
37     int len = qemu_strnlen(str, buf_size);
38     memcpy(buf, str, len);
39     memset(buf + len, pad, buf_size - len);
40 }
41
42 void pstrcpy(char *buf, int buf_size, const char *str)
43 {
44     int c;
45     char *q = buf;
46
47     if (buf_size <= 0)
48         return;
49
50     for(;;) {
51         c = *str++;
52         if (c == 0 || q >= buf + buf_size - 1)
53             break;
54         *q++ = c;
55     }
56     *q = '\0';
57 }
58
59 /* strcat and truncate. */
60 char *pstrcat(char *buf, int buf_size, const char *s)
61 {
62     int len;
63     len = strlen(buf);
64     if (len < buf_size)
65         pstrcpy(buf + len, buf_size - len, s);
66     return buf;
67 }
68
69 int strstart(const char *str, const char *val, const char **ptr)
70 {
71     const char *p, *q;
72     p = str;
73     q = val;
74     while (*q != '\0') {
75         if (*p != *q)
76             return 0;
77         p++;
78         q++;
79     }
80     if (ptr)
81         *ptr = p;
82     return 1;
83 }
84
85 int stristart(const char *str, const char *val, const char **ptr)
86 {
87     const char *p, *q;
88     p = str;
89     q = val;
90     while (*q != '\0') {
91         if (qemu_toupper(*p) != qemu_toupper(*q))
92             return 0;
93         p++;
94         q++;
95     }
96     if (ptr)
97         *ptr = p;
98     return 1;
99 }
100
101 /* XXX: use host strnlen if available ? */
102 int qemu_strnlen(const char *s, int max_len)
103 {
104     int i;
105
106     for(i = 0; i < max_len; i++) {
107         if (s[i] == '\0') {
108             break;
109         }
110     }
111     return i;
112 }
113
114 char *qemu_strsep(char **input, const char *delim)
115 {
116     char *result = *input;
117     if (result != NULL) {
118         char *p;
119
120         for (p = result; *p != '\0'; p++) {
121             if (strchr(delim, *p)) {
122                 break;
123             }
124         }
125         if (*p == '\0') {
126             *input = NULL;
127         } else {
128             *p = '\0';
129             *input = p + 1;
130         }
131     }
132     return result;
133 }
134
135 time_t mktimegm(struct tm *tm)
136 {
137     time_t t;
138     int y = tm->tm_year + 1900, m = tm->tm_mon + 1, d = tm->tm_mday;
139     if (m < 3) {
140         m += 12;
141         y--;
142     }
143     t = 86400ULL * (d + (153 * m - 457) / 5 + 365 * y + y / 4 - y / 100 + 
144                  y / 400 - 719469);
145     t += 3600 * tm->tm_hour + 60 * tm->tm_min + tm->tm_sec;
146     return t;
147 }
148
149 /*
150  * Make sure data goes on disk, but if possible do not bother to
151  * write out the inode just for timestamp updates.
152  *
153  * Unfortunately even in 2009 many operating systems do not support
154  * fdatasync and have to fall back to fsync.
155  */
156 int qemu_fdatasync(int fd)
157 {
158 #ifdef CONFIG_FDATASYNC
159     return fdatasync(fd);
160 #else
161     return fsync(fd);
162 #endif
163 }
164
165 #ifndef _WIN32
166 /* Sets a specific flag */
167 int fcntl_setfl(int fd, int flag)
168 {
169     int flags;
170
171     flags = fcntl(fd, F_GETFL);
172     if (flags == -1)
173         return -errno;
174
175     if (fcntl(fd, F_SETFL, flags | flag) == -1)
176         return -errno;
177
178     return 0;
179 }
180 #endif
181
182 static int64_t suffix_mul(char suffix, int64_t unit)
183 {
184     switch (qemu_toupper(suffix)) {
185     case 'B':
186         return 1;
187     case 'K':
188         return unit;
189     case 'M':
190         return unit * unit;
191     case 'G':
192         return unit * unit * unit;
193     case 'T':
194         return unit * unit * unit * unit;
195     case 'P':
196         return unit * unit * unit * unit * unit;
197     case 'E':
198         return unit * unit * unit * unit * unit * unit;
199     }
200     return -1;
201 }
202
203 /*
204  * Convert string to bytes, allowing either B/b for bytes, K/k for KB,
205  * M/m for MB, G/g for GB or T/t for TB. End pointer will be returned
206  * in *end, if not NULL. Return -ERANGE on overflow, Return -EINVAL on
207  * other error.
208  */
209 static int do_strtosz(const char *nptr, char **end,
210                       const char default_suffix, int64_t unit,
211                       uint64_t *result)
212 {
213     int retval;
214     char *endptr;
215     unsigned char c;
216     int mul_required = 0;
217     double val, mul, integral, fraction;
218
219     errno = 0;
220     val = strtod(nptr, &endptr);
221     if (isnan(val) || endptr == nptr || errno != 0) {
222         retval = -EINVAL;
223         goto out;
224     }
225     fraction = modf(val, &integral);
226     if (fraction != 0) {
227         mul_required = 1;
228     }
229     c = *endptr;
230     mul = suffix_mul(c, unit);
231     if (mul >= 0) {
232         endptr++;
233     } else {
234         mul = suffix_mul(default_suffix, unit);
235         assert(mul >= 0);
236     }
237     if (mul == 1 && mul_required) {
238         retval = -EINVAL;
239         goto out;
240     }
241     /*
242      * Values >= 0xfffffffffffffc00 overflow uint64_t after their trip
243      * through double (53 bits of precision).
244      */
245     if ((val * mul >= 0xfffffffffffffc00) || val < 0) {
246         retval = -ERANGE;
247         goto out;
248     }
249     *result = val * mul;
250     retval = 0;
251
252 out:
253     if (end) {
254         *end = endptr;
255     } else if (*endptr) {
256         retval = -EINVAL;
257     }
258
259     return retval;
260 }
261
262 int qemu_strtosz(const char *nptr, char **end, uint64_t *result)
263 {
264     return do_strtosz(nptr, end, 'B', 1024, result);
265 }
266
267 int qemu_strtosz_MiB(const char *nptr, char **end, uint64_t *result)
268 {
269     return do_strtosz(nptr, end, 'M', 1024, result);
270 }
271
272 int qemu_strtosz_metric(const char *nptr, char **end, uint64_t *result)
273 {
274     return do_strtosz(nptr, end, 'B', 1000, result);
275 }
276
277 /**
278  * Helper function for error checking after strtol() and the like
279  */
280 static int check_strtox_error(const char *nptr, char *ep,
281                               const char **endptr, int libc_errno)
282 {
283     assert(ep >= nptr);
284     if (endptr) {
285         *endptr = ep;
286     }
287
288     /* Turn "no conversion" into an error */
289     if (libc_errno == 0 && ep == nptr) {
290         return -EINVAL;
291     }
292
293     /* Fail when we're expected to consume the string, but didn't */
294     if (!endptr && *ep) {
295         return -EINVAL;
296     }
297
298     return -libc_errno;
299 }
300
301 /**
302  * Convert string @nptr to an integer, and store it in @result.
303  *
304  * This is a wrapper around strtol() that is harder to misuse.
305  * Semantics of @nptr, @endptr, @base match strtol() with differences
306  * noted below.
307  *
308  * @nptr may be null, and no conversion is performed then.
309  *
310  * If no conversion is performed, store @nptr in *@endptr and return
311  * -EINVAL.
312  *
313  * If @endptr is null, and the string isn't fully converted, return
314  * -EINVAL.  This is the case when the pointer that would be stored in
315  * a non-null @endptr points to a character other than '\0'.
316  *
317  * If the conversion overflows @result, store INT_MAX in @result,
318  * and return -ERANGE.
319  *
320  * If the conversion underflows @result, store INT_MIN in @result,
321  * and return -ERANGE.
322  *
323  * Else store the converted value in @result, and return zero.
324  */
325 int qemu_strtoi(const char *nptr, const char **endptr, int base,
326                 int *result)
327 {
328     char *ep;
329     long long lresult;
330
331     assert((unsigned) base <= 36 && base != 1);
332     if (!nptr) {
333         if (endptr) {
334             *endptr = nptr;
335         }
336         return -EINVAL;
337     }
338
339     errno = 0;
340     lresult = strtoll(nptr, &ep, base);
341     if (lresult < INT_MIN) {
342         *result = INT_MIN;
343         errno = ERANGE;
344     } else if (lresult > INT_MAX) {
345         *result = INT_MAX;
346         errno = ERANGE;
347     } else {
348         *result = lresult;
349     }
350     return check_strtox_error(nptr, ep, endptr, errno);
351 }
352
353 /**
354  * Convert string @nptr to an unsigned integer, and store it in @result.
355  *
356  * This is a wrapper around strtoul() that is harder to misuse.
357  * Semantics of @nptr, @endptr, @base match strtoul() with differences
358  * noted below.
359  *
360  * @nptr may be null, and no conversion is performed then.
361  *
362  * If no conversion is performed, store @nptr in *@endptr and return
363  * -EINVAL.
364  *
365  * If @endptr is null, and the string isn't fully converted, return
366  * -EINVAL.  This is the case when the pointer that would be stored in
367  * a non-null @endptr points to a character other than '\0'.
368  *
369  * If the conversion overflows @result, store UINT_MAX in @result,
370  * and return -ERANGE.
371  *
372  * Else store the converted value in @result, and return zero.
373  *
374  * Note that a number with a leading minus sign gets converted without
375  * the minus sign, checked for overflow (see above), then negated (in
376  * @result's type).  This is exactly how strtoul() works.
377  */
378 int qemu_strtoui(const char *nptr, const char **endptr, int base,
379                  unsigned int *result)
380 {
381     char *ep;
382     long long lresult;
383
384     assert((unsigned) base <= 36 && base != 1);
385     if (!nptr) {
386         if (endptr) {
387             *endptr = nptr;
388         }
389         return -EINVAL;
390     }
391
392     errno = 0;
393     lresult = strtoull(nptr, &ep, base);
394
395     /* Windows returns 1 for negative out-of-range values.  */
396     if (errno == ERANGE) {
397         *result = -1;
398     } else {
399         if (lresult > UINT_MAX) {
400             *result = UINT_MAX;
401             errno = ERANGE;
402         } else if (lresult < INT_MIN) {
403             *result = UINT_MAX;
404             errno = ERANGE;
405         } else {
406             *result = lresult;
407         }
408     }
409     return check_strtox_error(nptr, ep, endptr, errno);
410 }
411
412 /**
413  * Convert string @nptr to a long integer, and store it in @result.
414  *
415  * This is a wrapper around strtol() that is harder to misuse.
416  * Semantics of @nptr, @endptr, @base match strtol() with differences
417  * noted below.
418  *
419  * @nptr may be null, and no conversion is performed then.
420  *
421  * If no conversion is performed, store @nptr in *@endptr and return
422  * -EINVAL.
423  *
424  * If @endptr is null, and the string isn't fully converted, return
425  * -EINVAL.  This is the case when the pointer that would be stored in
426  * a non-null @endptr points to a character other than '\0'.
427  *
428  * If the conversion overflows @result, store LONG_MAX in @result,
429  * and return -ERANGE.
430  *
431  * If the conversion underflows @result, store LONG_MIN in @result,
432  * and return -ERANGE.
433  *
434  * Else store the converted value in @result, and return zero.
435  */
436 int qemu_strtol(const char *nptr, const char **endptr, int base,
437                 long *result)
438 {
439     char *ep;
440
441     assert((unsigned) base <= 36 && base != 1);
442     if (!nptr) {
443         if (endptr) {
444             *endptr = nptr;
445         }
446         return -EINVAL;
447     }
448
449     errno = 0;
450     *result = strtol(nptr, &ep, base);
451     return check_strtox_error(nptr, ep, endptr, errno);
452 }
453
454 /**
455  * Convert string @nptr to an unsigned long, and store it in @result.
456  *
457  * This is a wrapper around strtoul() that is harder to misuse.
458  * Semantics of @nptr, @endptr, @base match strtoul() with differences
459  * noted below.
460  *
461  * @nptr may be null, and no conversion is performed then.
462  *
463  * If no conversion is performed, store @nptr in *@endptr and return
464  * -EINVAL.
465  *
466  * If @endptr is null, and the string isn't fully converted, return
467  * -EINVAL.  This is the case when the pointer that would be stored in
468  * a non-null @endptr points to a character other than '\0'.
469  *
470  * If the conversion overflows @result, store ULONG_MAX in @result,
471  * and return -ERANGE.
472  *
473  * Else store the converted value in @result, and return zero.
474  *
475  * Note that a number with a leading minus sign gets converted without
476  * the minus sign, checked for overflow (see above), then negated (in
477  * @result's type).  This is exactly how strtoul() works.
478  */
479 int qemu_strtoul(const char *nptr, const char **endptr, int base,
480                  unsigned long *result)
481 {
482     char *ep;
483
484     assert((unsigned) base <= 36 && base != 1);
485     if (!nptr) {
486         if (endptr) {
487             *endptr = nptr;
488         }
489         return -EINVAL;
490     }
491
492     errno = 0;
493     *result = strtoul(nptr, &ep, base);
494     /* Windows returns 1 for negative out-of-range values.  */
495     if (errno == ERANGE) {
496         *result = -1;
497     }
498     return check_strtox_error(nptr, ep, endptr, errno);
499 }
500
501 /**
502  * Convert string @nptr to an int64_t.
503  *
504  * Works like qemu_strtol(), except it stores INT64_MAX on overflow,
505  * and INT_MIN on underflow.
506  */
507 int qemu_strtoi64(const char *nptr, const char **endptr, int base,
508                  int64_t *result)
509 {
510     char *ep;
511
512     assert((unsigned) base <= 36 && base != 1);
513     if (!nptr) {
514         if (endptr) {
515             *endptr = nptr;
516         }
517         return -EINVAL;
518     }
519
520     errno = 0;
521     /* FIXME This assumes int64_t is long long */
522     *result = strtoll(nptr, &ep, base);
523     return check_strtox_error(nptr, ep, endptr, errno);
524 }
525
526 /**
527  * Convert string @nptr to an uint64_t.
528  *
529  * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow.
530  */
531 int qemu_strtou64(const char *nptr, const char **endptr, int base,
532                   uint64_t *result)
533 {
534     char *ep;
535
536     assert((unsigned) base <= 36 && base != 1);
537     if (!nptr) {
538         if (endptr) {
539             *endptr = nptr;
540         }
541         return -EINVAL;
542     }
543
544     errno = 0;
545     /* FIXME This assumes uint64_t is unsigned long long */
546     *result = strtoull(nptr, &ep, base);
547     /* Windows returns 1 for negative out-of-range values.  */
548     if (errno == ERANGE) {
549         *result = -1;
550     }
551     return check_strtox_error(nptr, ep, endptr, errno);
552 }
553
554 /**
555  * Searches for the first occurrence of 'c' in 's', and returns a pointer
556  * to the trailing null byte if none was found.
557  */
558 #ifndef HAVE_STRCHRNUL
559 const char *qemu_strchrnul(const char *s, int c)
560 {
561     const char *e = strchr(s, c);
562     if (!e) {
563         e = s + strlen(s);
564     }
565     return e;
566 }
567 #endif
568
569 /**
570  * parse_uint:
571  *
572  * @s: String to parse
573  * @value: Destination for parsed integer value
574  * @endptr: Destination for pointer to first character not consumed
575  * @base: integer base, between 2 and 36 inclusive, or 0
576  *
577  * Parse unsigned integer
578  *
579  * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single optional
580  * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits.
581  *
582  * If @s is null, or @base is invalid, or @s doesn't start with an
583  * integer in the syntax above, set *@value to 0, *@endptr to @s, and
584  * return -EINVAL.
585  *
586  * Set *@endptr to point right beyond the parsed integer (even if the integer
587  * overflows or is negative, all digits will be parsed and *@endptr will
588  * point right beyond them).
589  *
590  * If the integer is negative, set *@value to 0, and return -ERANGE.
591  *
592  * If the integer overflows unsigned long long, set *@value to
593  * ULLONG_MAX, and return -ERANGE.
594  *
595  * Else, set *@value to the parsed integer, and return 0.
596  */
597 int parse_uint(const char *s, unsigned long long *value, char **endptr,
598                int base)
599 {
600     int r = 0;
601     char *endp = (char *)s;
602     unsigned long long val = 0;
603
604     assert((unsigned) base <= 36 && base != 1);
605     if (!s) {
606         r = -EINVAL;
607         goto out;
608     }
609
610     errno = 0;
611     val = strtoull(s, &endp, base);
612     if (errno) {
613         r = -errno;
614         goto out;
615     }
616
617     if (endp == s) {
618         r = -EINVAL;
619         goto out;
620     }
621
622     /* make sure we reject negative numbers: */
623     while (isspace((unsigned char)*s)) {
624         s++;
625     }
626     if (*s == '-') {
627         val = 0;
628         r = -ERANGE;
629         goto out;
630     }
631
632 out:
633     *value = val;
634     *endptr = endp;
635     return r;
636 }
637
638 /**
639  * parse_uint_full:
640  *
641  * @s: String to parse
642  * @value: Destination for parsed integer value
643  * @base: integer base, between 2 and 36 inclusive, or 0
644  *
645  * Parse unsigned integer from entire string
646  *
647  * Have the same behavior of parse_uint(), but with an additional check
648  * for additional data after the parsed number. If extra characters are present
649  * after the parsed number, the function will return -EINVAL, and *@v will
650  * be set to 0.
651  */
652 int parse_uint_full(const char *s, unsigned long long *value, int base)
653 {
654     char *endp;
655     int r;
656
657     r = parse_uint(s, value, &endp, base);
658     if (r < 0) {
659         return r;
660     }
661     if (*endp) {
662         *value = 0;
663         return -EINVAL;
664     }
665
666     return 0;
667 }
668
669 int qemu_parse_fd(const char *param)
670 {
671     long fd;
672     char *endptr;
673
674     errno = 0;
675     fd = strtol(param, &endptr, 10);
676     if (param == endptr /* no conversion performed */                    ||
677         errno != 0      /* not representable as long; possibly others */ ||
678         *endptr != '\0' /* final string not empty */                     ||
679         fd < 0          /* invalid as file descriptor */                 ||
680         fd > INT_MAX    /* not representable as int */) {
681         return -1;
682     }
683     return fd;
684 }
685
686 /*
687  * Implementation of  ULEB128 (http://en.wikipedia.org/wiki/LEB128)
688  * Input is limited to 14-bit numbers
689  */
690 int uleb128_encode_small(uint8_t *out, uint32_t n)
691 {
692     g_assert(n <= 0x3fff);
693     if (n < 0x80) {
694         *out++ = n;
695         return 1;
696     } else {
697         *out++ = (n & 0x7f) | 0x80;
698         *out++ = n >> 7;
699         return 2;
700     }
701 }
702
703 int uleb128_decode_small(const uint8_t *in, uint32_t *n)
704 {
705     if (!(*in & 0x80)) {
706         *n = *in++;
707         return 1;
708     } else {
709         *n = *in++ & 0x7f;
710         /* we exceed 14 bit number */
711         if (*in & 0x80) {
712             return -1;
713         }
714         *n |= *in++ << 7;
715         return 2;
716     }
717 }
718
719 /*
720  * helper to parse debug environment variables
721  */
722 int parse_debug_env(const char *name, int max, int initial)
723 {
724     char *debug_env = getenv(name);
725     char *inv = NULL;
726     long debug;
727
728     if (!debug_env) {
729         return initial;
730     }
731     errno = 0;
732     debug = strtol(debug_env, &inv, 10);
733     if (inv == debug_env) {
734         return initial;
735     }
736     if (debug < 0 || debug > max || errno != 0) {
737         warn_report("%s not in [0, %d]", name, max);
738         return initial;
739     }
740     return debug;
741 }
742
743 /*
744  * Helper to print ethernet mac address
745  */
746 const char *qemu_ether_ntoa(const MACAddr *mac)
747 {
748     static char ret[18];
749
750     snprintf(ret, sizeof(ret), "%02x:%02x:%02x:%02x:%02x:%02x",
751              mac->a[0], mac->a[1], mac->a[2], mac->a[3], mac->a[4], mac->a[5]);
752
753     return ret;
754 }
755
756 /*
757  * Return human readable string for size @val.
758  * @val can be anything that uint64_t allows (no more than "16 EiB").
759  * Use IEC binary units like KiB, MiB, and so forth.
760  * Caller is responsible for passing it to g_free().
761  */
762 char *size_to_str(uint64_t val)
763 {
764     static const char *suffixes[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" };
765     unsigned long div;
766     int i;
767
768     /*
769      * The exponent (returned in i) minus one gives us
770      * floor(log2(val * 1024 / 1000).  The correction makes us
771      * switch to the higher power when the integer part is >= 1000.
772      * (see e41b509d68afb1f for more info)
773      */
774     frexp(val / (1000.0 / 1024.0), &i);
775     i = (i - 1) / 10;
776     div = 1ULL << (i * 10);
777
778     return g_strdup_printf("%0.3g %sB", (double)val / div, suffixes[i]);
779 }
780
781 int qemu_pstrcmp0(const char **str1, const char **str2)
782 {
783     return g_strcmp0(*str1, *str2);
784 }
This page took 0.067495 seconds and 4 git commands to generate.