From nobody Sat Apr 27 07:09:06 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=listsout.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from listsout.gnu.org (209.51.188.17 [209.51.188.17]) by mx.zohomail.com with SMTPS id 1546626245456518.1102242955814; Fri, 4 Jan 2019 10:24:05 -0800 (PST) Received: from localhost ([127.0.0.1]:38016 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gfU8V-0005FE-FM for importer@patchew.org; Fri, 04 Jan 2019 13:23:59 -0500 Received: from eggs.gnu.org ([208.118.235.92]:56599) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gfTxS-00021z-Dv for qemu-devel@nongnu.org; Fri, 04 Jan 2019 13:12:36 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gfTxQ-0003Au-68 for qemu-devel@nongnu.org; Fri, 04 Jan 2019 13:12:34 -0500 Received: from mx1.redhat.com ([209.132.183.28]:38276) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gfTxP-0003AO-UM; Fri, 04 Jan 2019 13:12:32 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 1CD47637FF; Fri, 4 Jan 2019 18:12:31 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-119.brq.redhat.com [10.40.204.119]) by smtp.corp.redhat.com (Postfix) with ESMTPS id E42965D9C6; Fri, 4 Jan 2019 18:12:25 +0000 (UTC) From: =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Date: Fri, 4 Jan 2019 19:12:06 +0100 Message-Id: <20190104181208.7809-2-philmd@redhat.com> In-Reply-To: <20190104181208.7809-1-philmd@redhat.com> References: <20190104181208.7809-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.28]); Fri, 04 Jan 2019 18:12:31 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v2 1/3] util/cutils: Move size_to_str() from "qemu-common.h" to "cutils.h" X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Fam Zheng , Thomas Huth , David Hildenbrand , qemu-trivial@nongnu.org, Cornelia Huck , Michael Roth , Markus Armbruster , Halil Pasic , Christian Borntraeger , qemu-s390x@nongnu.org, qemu-ppc@nongnu.org, Gerd Hoffmann , David Gibson , Paolo Bonzini , Stefano Garzarella , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Richard Henderson Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" The size_to_str() function doesn't need to be in a generic header. It makes also sens to find this function in the same header than the opposite string to size functions: qemu_strtosz*(). Note than this function is already implemented in util/cutils.c. Since we introduce a new function in a header, we document it, using the previous comment from the source file. Signed-off-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Cornelia Huck Reviewed-by: David Gibson Reviewed-by: Eric Blake Reviewed-by: Stefano Garzarella --- include/qemu-common.h | 1 - include/qemu/cutils.h | 13 +++++++++++++ qapi/string-output-visitor.c | 2 +- util/cutils.c | 6 ------ 4 files changed, 14 insertions(+), 8 deletions(-) diff --git a/include/qemu-common.h b/include/qemu-common.h index ed60ba251d..760527294f 100644 --- a/include/qemu-common.h +++ b/include/qemu-common.h @@ -153,7 +153,6 @@ void qemu_hexdump(const char *buf, FILE *fp, const char= *prefix, size_t size); int parse_debug_env(const char *name, int max, int initial); =20 const char *qemu_ether_ntoa(const MACAddr *mac); -char *size_to_str(uint64_t val); void page_size_init(void); =20 /* returns non-zero if dump is in progress, otherwise zero is diff --git a/include/qemu/cutils.h b/include/qemu/cutils.h index d2dad3057c..9ee40470e3 100644 --- a/include/qemu/cutils.h +++ b/include/qemu/cutils.h @@ -157,6 +157,19 @@ int qemu_strtosz(const char *nptr, const char **end, u= int64_t *result); int qemu_strtosz_MiB(const char *nptr, const char **end, uint64_t *result); int qemu_strtosz_metric(const char *nptr, const char **end, uint64_t *resu= lt); =20 +/** + * size_to_str: + * + * Return human readable string for size @val. + * Use IEC binary units like KiB, MiB, and so forth. + * + * @val: The value to format. + * Can be anything that uint64_t allows (no more than "16 EiB"). + * + * Caller is responsible for passing it to g_free(). + */ +char *size_to_str(uint64_t val); + /* used to print char* safely */ #define STR_OR_NULL(str) ((str) ? (str) : "null") =20 diff --git a/qapi/string-output-visitor.c b/qapi/string-output-visitor.c index 7ab64468d9..edf268b373 100644 --- a/qapi/string-output-visitor.c +++ b/qapi/string-output-visitor.c @@ -11,9 +11,9 @@ */ =20 #include "qemu/osdep.h" -#include "qemu-common.h" #include "qapi/string-output-visitor.h" #include "qapi/visitor-impl.h" +#include "qemu/cutils.h" #include "qemu/host-utils.h" #include #include "qemu/range.h" diff --git a/util/cutils.c b/util/cutils.c index e098debdc0..a8a3a3ba3b 100644 --- a/util/cutils.c +++ b/util/cutils.c @@ -816,12 +816,6 @@ const char *qemu_ether_ntoa(const MACAddr *mac) return ret; } =20 -/* - * Return human readable string for size @val. - * @val can be anything that uint64_t allows (no more than "16 EiB"). - * Use IEC binary units like KiB, MiB, and so forth. - * Caller is responsible for passing it to g_free(). - */ char *size_to_str(uint64_t val) { static const char *suffixes[] =3D { "", "Ki", "Mi", "Gi", "Ti", "Pi", = "Ei" }; --=20 2.17.2 From nobody Sat Apr 27 07:09:06 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1546625689410528.2130876252194; Fri, 4 Jan 2019 10:14:49 -0800 (PST) Received: from localhost ([127.0.0.1]:37889 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gfTzc-0004Hg-3M for importer@patchew.org; Fri, 04 Jan 2019 13:14:48 -0500 Received: from eggs.gnu.org ([208.118.235.92]:56771) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gfTxd-0002HM-LW for qemu-devel@nongnu.org; Fri, 04 Jan 2019 13:12:46 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gfTxc-0003JG-GC for qemu-devel@nongnu.org; Fri, 04 Jan 2019 13:12:45 -0500 Received: from mx1.redhat.com ([209.132.183.28]:56458) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gfTxc-0003Ik-4V; Fri, 04 Jan 2019 13:12:44 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 49C74C0528CF; Fri, 4 Jan 2019 18:12:43 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-119.brq.redhat.com [10.40.204.119]) by smtp.corp.redhat.com (Postfix) with ESMTPS id A19575D9C6; Fri, 4 Jan 2019 18:12:31 +0000 (UTC) From: =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Date: Fri, 4 Jan 2019 19:12:07 +0100 Message-Id: <20190104181208.7809-3-philmd@redhat.com> In-Reply-To: <20190104181208.7809-1-philmd@redhat.com> References: <20190104181208.7809-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Fri, 04 Jan 2019 18:12:43 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v2 2/3] util/cutils: Move ctype macros to "cutils.h" X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Fam Zheng , Thomas Huth , David Hildenbrand , qemu-trivial@nongnu.org, Cornelia Huck , Michael Roth , Markus Armbruster , Halil Pasic , Christian Borntraeger , qemu-s390x@nongnu.org, qemu-ppc@nongnu.org, Gerd Hoffmann , David Gibson , Paolo Bonzini , Stefano Garzarella , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Richard Henderson Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Introduced in cd390083ad1, these macros don't need to be in a generic header. Add documentation to justify their use. Reviewed-by: Stefano Garzarella Signed-off-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: David Gibson --- v2: Fixed checkpatch warnings (tabs) --- hw/core/bus.c | 2 +- hw/core/qdev-properties.c | 1 + hw/s390x/s390-virtio-ccw.c | 1 + hw/scsi/scsi-generic.c | 2 +- include/qemu-common.h | 16 ---------------- include/qemu/cutils.h | 25 +++++++++++++++++++++++++ qapi/qapi-util.c | 2 +- qobject/json-parser.c | 1 - target/ppc/monitor.c | 1 + ui/keymaps.c | 1 + util/id.c | 2 +- util/readline.c | 1 - 12 files changed, 33 insertions(+), 22 deletions(-) diff --git a/hw/core/bus.c b/hw/core/bus.c index 4651f24486..dceb144075 100644 --- a/hw/core/bus.c +++ b/hw/core/bus.c @@ -18,7 +18,7 @@ */ =20 #include "qemu/osdep.h" -#include "qemu-common.h" +#include "qemu/cutils.h" #include "hw/qdev.h" #include "qapi/error.h" =20 diff --git a/hw/core/qdev-properties.c b/hw/core/qdev-properties.c index 943dc2654b..3bdebac361 100644 --- a/hw/core/qdev-properties.c +++ b/hw/core/qdev-properties.c @@ -1,4 +1,5 @@ #include "qemu/osdep.h" +#include "qemu/cutils.h" #include "net/net.h" #include "hw/qdev.h" #include "qapi/error.h" diff --git a/hw/s390x/s390-virtio-ccw.c b/hw/s390x/s390-virtio-ccw.c index fd9d0b0542..ed23bb7b3a 100644 --- a/hw/s390x/s390-virtio-ccw.c +++ b/hw/s390x/s390-virtio-ccw.c @@ -11,6 +11,7 @@ */ =20 #include "qemu/osdep.h" +#include "qemu/cutils.h" #include "qapi/error.h" #include "cpu.h" #include "hw/boards.h" diff --git a/hw/scsi/scsi-generic.c b/hw/scsi/scsi-generic.c index 7237b4162e..86f65fd474 100644 --- a/hw/scsi/scsi-generic.c +++ b/hw/scsi/scsi-generic.c @@ -12,8 +12,8 @@ */ =20 #include "qemu/osdep.h" +#include "qemu/cutils.h" #include "qapi/error.h" -#include "qemu-common.h" #include "qemu/error-report.h" #include "hw/scsi/scsi.h" #include "hw/scsi/emulation.h" diff --git a/include/qemu-common.h b/include/qemu-common.h index 760527294f..ed43ae286d 100644 --- a/include/qemu-common.h +++ b/include/qemu-common.h @@ -33,22 +33,6 @@ int qemu_main(int argc, char **argv, char **envp); void qemu_get_timedate(struct tm *tm, int offset); int qemu_timedate_diff(struct tm *tm); =20 -#define qemu_isalnum(c) isalnum((unsigned char)(c)) -#define qemu_isalpha(c) isalpha((unsigned char)(c)) -#define qemu_iscntrl(c) iscntrl((unsigned char)(c)) -#define qemu_isdigit(c) isdigit((unsigned char)(c)) -#define qemu_isgraph(c) isgraph((unsigned char)(c)) -#define qemu_islower(c) islower((unsigned char)(c)) -#define qemu_isprint(c) isprint((unsigned char)(c)) -#define qemu_ispunct(c) ispunct((unsigned char)(c)) -#define qemu_isspace(c) isspace((unsigned char)(c)) -#define qemu_isupper(c) isupper((unsigned char)(c)) -#define qemu_isxdigit(c) isxdigit((unsigned char)(c)) -#define qemu_tolower(c) tolower((unsigned char)(c)) -#define qemu_toupper(c) toupper((unsigned char)(c)) -#define qemu_isascii(c) isascii((unsigned char)(c)) -#define qemu_toascii(c) toascii((unsigned char)(c)) - void *qemu_oom_check(void *ptr); =20 ssize_t qemu_write_full(int fd, const void *buf, size_t count) diff --git a/include/qemu/cutils.h b/include/qemu/cutils.h index 9ee40470e3..644f2d75bd 100644 --- a/include/qemu/cutils.h +++ b/include/qemu/cutils.h @@ -3,6 +3,31 @@ =20 #include "qemu/fprintf-fn.h" =20 +/** + * unsigned ctype macros: + * + * The standards require that the argument for these functions + * is either EOF or a value that is representable in the type + * unsigned char. If the argument is of type char, it must be + * cast to unsigned char. This is what these macros do, + * avoiding 'signed to unsigned' conversion warnings. + */ +#define qemu_isalnum(c) isalnum((unsigned char)(c)) +#define qemu_isalpha(c) isalpha((unsigned char)(c)) +#define qemu_iscntrl(c) iscntrl((unsigned char)(c)) +#define qemu_isdigit(c) isdigit((unsigned char)(c)) +#define qemu_isgraph(c) isgraph((unsigned char)(c)) +#define qemu_islower(c) islower((unsigned char)(c)) +#define qemu_isprint(c) isprint((unsigned char)(c)) +#define qemu_ispunct(c) ispunct((unsigned char)(c)) +#define qemu_isspace(c) isspace((unsigned char)(c)) +#define qemu_isupper(c) isupper((unsigned char)(c)) +#define qemu_isxdigit(c) isxdigit((unsigned char)(c)) +#define qemu_tolower(c) tolower((unsigned char)(c)) +#define qemu_toupper(c) toupper((unsigned char)(c)) +#define qemu_isascii(c) isascii((unsigned char)(c)) +#define qemu_toascii(c) toascii((unsigned char)(c)) + /** * pstrcpy: * @buf: buffer to copy string into diff --git a/qapi/qapi-util.c b/qapi/qapi-util.c index e9b266bb70..ea93ae05d9 100644 --- a/qapi/qapi-util.c +++ b/qapi/qapi-util.c @@ -11,8 +11,8 @@ */ =20 #include "qemu/osdep.h" +#include "qemu/cutils.h" #include "qapi/error.h" -#include "qemu-common.h" =20 const char *qapi_enum_lookup(const QEnumLookup *lookup, int val) { diff --git a/qobject/json-parser.c b/qobject/json-parser.c index 7a7ae9e8d1..06316f3a53 100644 --- a/qobject/json-parser.c +++ b/qobject/json-parser.c @@ -15,7 +15,6 @@ #include "qemu/cutils.h" #include "qemu/unicode.h" #include "qapi/error.h" -#include "qemu-common.h" #include "qapi/qmp/qbool.h" #include "qapi/qmp/qdict.h" #include "qapi/qmp/qlist.h" diff --git a/target/ppc/monitor.c b/target/ppc/monitor.c index 14915119fc..dbcb921231 100644 --- a/target/ppc/monitor.c +++ b/target/ppc/monitor.c @@ -22,6 +22,7 @@ * THE SOFTWARE. */ #include "qemu/osdep.h" +#include "qemu/cutils.h" #include "cpu.h" #include "monitor/monitor.h" #include "monitor/hmp-target.h" diff --git a/ui/keymaps.c b/ui/keymaps.c index 085889b555..00b52a6db3 100644 --- a/ui/keymaps.c +++ b/ui/keymaps.c @@ -23,6 +23,7 @@ */ =20 #include "qemu/osdep.h" +#include "qemu/cutils.h" #include "keymaps.h" #include "sysemu/sysemu.h" #include "trace.h" diff --git a/util/id.c b/util/id.c index 6141352955..ca21a77522 100644 --- a/util/id.c +++ b/util/id.c @@ -11,7 +11,7 @@ */ =20 #include "qemu/osdep.h" -#include "qemu-common.h" +#include "qemu/cutils.h" #include "qemu/id.h" =20 bool id_wellformed(const char *id) diff --git a/util/readline.c b/util/readline.c index ec91ee0fea..f3d8b0698a 100644 --- a/util/readline.c +++ b/util/readline.c @@ -23,7 +23,6 @@ */ =20 #include "qemu/osdep.h" -#include "qemu-common.h" #include "qemu/readline.h" #include "qemu/cutils.h" =20 --=20 2.17.2 From nobody Sat Apr 27 07:09:06 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1546625778596309.95443434714275; Fri, 4 Jan 2019 10:16:18 -0800 (PST) Received: from localhost ([127.0.0.1]:37916 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gfU13-0006Ej-7D for importer@patchew.org; Fri, 04 Jan 2019 13:16:17 -0500 Received: from eggs.gnu.org ([208.118.235.92]:56987) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gfTyP-0003Jl-8v for qemu-devel@nongnu.org; Fri, 04 Jan 2019 13:13:35 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gfTyM-0003aS-3t for qemu-devel@nongnu.org; Fri, 04 Jan 2019 13:13:33 -0500 Received: from mx1.redhat.com ([209.132.183.28]:40068) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gfTyI-0003YY-7t; Fri, 04 Jan 2019 13:13:27 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id B5A7A7AE98; Fri, 4 Jan 2019 18:13:23 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-119.brq.redhat.com [10.40.204.119]) by smtp.corp.redhat.com (Postfix) with ESMTPS id C25F05D9C6; Fri, 4 Jan 2019 18:12:43 +0000 (UTC) From: =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Date: Fri, 4 Jan 2019 19:12:08 +0100 Message-Id: <20190104181208.7809-4-philmd@redhat.com> In-Reply-To: <20190104181208.7809-1-philmd@redhat.com> References: <20190104181208.7809-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.25]); Fri, 04 Jan 2019 18:13:23 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v2 3/3] util/cutils: Move function documentations to the header X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Fam Zheng , Thomas Huth , David Hildenbrand , qemu-trivial@nongnu.org, Cornelia Huck , Michael Roth , Markus Armbruster , Halil Pasic , Christian Borntraeger , qemu-s390x@nongnu.org, qemu-ppc@nongnu.org, Gerd Hoffmann , David Gibson , Paolo Bonzini , Stefano Garzarella , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Richard Henderson Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Many functions have documentation before the implementation in cutils.c. Since we expect documentation around the prototype declaration in headers, move the comments in cutils.h. Signed-off-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: David Gibson Reviewed-by: Stefano Garzarella --- include/qemu/cutils.h | 224 ++++++++++++++++++++++++++++++++++++++++++ util/cutils.c | 185 ---------------------------------- 2 files changed, 224 insertions(+), 185 deletions(-) diff --git a/include/qemu/cutils.h b/include/qemu/cutils.h index 644f2d75bd..f41b00ad37 100644 --- a/include/qemu/cutils.h +++ b/include/qemu/cutils.h @@ -47,6 +47,7 @@ * bytes and then add a NUL */ void pstrcpy(char *buf, int buf_size, const char *str); + /** * strpadcpy: * @buf: buffer to copy string into @@ -60,6 +61,7 @@ void pstrcpy(char *buf, int buf_size, const char *str); * first @buf_size characters of @str, with no terminator. */ void strpadcpy(char *buf, int buf_size, const char *str, char pad); + /** * pstrcat: * @buf: buffer containing existing string @@ -77,6 +79,7 @@ void strpadcpy(char *buf, int buf_size, const char *str, = char pad); * Returns: @buf. */ char *pstrcat(char *buf, int buf_size, const char *s); + /** * strstart: * @str: string to test @@ -94,6 +97,7 @@ char *pstrcat(char *buf, int buf_size, const char *s); * Returns: true if @str starts with prefix @val, false otherwise. */ int strstart(const char *str, const char *val, const char **ptr); + /** * stristart: * @str: string to test @@ -110,6 +114,7 @@ int strstart(const char *str, const char *val, const ch= ar **ptr); * false otherwise. */ int stristart(const char *str, const char *val, const char **ptr); + /** * qemu_strnlen: * @s: string @@ -126,6 +131,7 @@ int stristart(const char *str, const char *val, const c= har **ptr); * Returns: length of @s in bytes, or @max_len, whichever is smaller. */ int qemu_strnlen(const char *s, int max_len); + /** * qemu_strsep: * @input: pointer to string to parse @@ -147,6 +153,16 @@ int qemu_strnlen(const char *s, int max_len); * Returns: the pointer originally in @input. */ char *qemu_strsep(char **input, const char *delim); + +/** + * qemu_strchrnul: + * + * @s: String to parse. + * @c: Character to find. + * + * Searches for the first occurrence of @c in @s, and returns a pointer + * to the trailing null byte if none was found. + */ #ifdef HAVE_STRCHRNUL static inline const char *qemu_strchrnul(const char *s, int c) { @@ -155,27 +171,235 @@ static inline const char *qemu_strchrnul(const char = *s, int c) #else const char *qemu_strchrnul(const char *s, int c); #endif + time_t mktimegm(struct tm *tm); int qemu_fdatasync(int fd); int fcntl_setfl(int fd, int flag); int qemu_parse_fd(const char *param); + +/** + * qemu_strtoi: + * + * Convert string @nptr to an integer, and store it in @result. + * + * This is a wrapper around strtol() that is harder to misuse. + * Semantics of @nptr, @endptr, @base match strtol() with differences + * noted below. + * + * @nptr may be null, and no conversion is performed then. + * + * If no conversion is performed, store @nptr in *@endptr and return + * -EINVAL. + * + * If @endptr is null, and the string isn't fully converted, return + * -EINVAL. This is the case when the pointer that would be stored in + * a non-null @endptr points to a character other than '\0'. + * + * If the conversion overflows @result, store INT_MAX in @result, + * and return -ERANGE. + * + * If the conversion underflows @result, store INT_MIN in @result, + * and return -ERANGE. + * + * Else store the converted value in @result, and return zero. + */ int qemu_strtoi(const char *nptr, const char **endptr, int base, int *result); + +/** + * qemu_strtoui: + * + * Convert string @nptr to an unsigned integer, and store it in @result. + * + * This is a wrapper around strtoul() that is harder to misuse. + * Semantics of @nptr, @endptr, @base match strtoul() with differences + * noted below. + * + * @nptr may be null, and no conversion is performed then. + * + * If no conversion is performed, store @nptr in *@endptr and return + * -EINVAL. + * + * If @endptr is null, and the string isn't fully converted, return + * -EINVAL. This is the case when the pointer that would be stored in + * a non-null @endptr points to a character other than '\0'. + * + * If the conversion overflows @result, store UINT_MAX in @result, + * and return -ERANGE. + * + * Else store the converted value in @result, and return zero. + * + * Note that a number with a leading minus sign gets converted without + * the minus sign, checked for overflow (see above), then negated (in + * @result's type). This is exactly how strtoul() works. + */ int qemu_strtoui(const char *nptr, const char **endptr, int base, unsigned int *result); + +/** + * qemu_strtol: + * + * Convert string @nptr to a long integer, and store it in @result. + * + * This is a wrapper around strtol() that is harder to misuse. + * Semantics of @nptr, @endptr, @base match strtol() with differences + * noted below. + * + * @nptr may be null, and no conversion is performed then. + * + * If no conversion is performed, store @nptr in *@endptr and return + * -EINVAL. + * + * If @endptr is null, and the string isn't fully converted, return + * -EINVAL. This is the case when the pointer that would be stored in + * a non-null @endptr points to a character other than '\0'. + * + * If the conversion overflows @result, store LONG_MAX in @result, + * and return -ERANGE. + * + * If the conversion underflows @result, store LONG_MIN in @result, + * and return -ERANGE. + * + * Else store the converted value in @result, and return zero. + */ int qemu_strtol(const char *nptr, const char **endptr, int base, long *result); + +/** + * qemu_strtoul: + * + * Convert string @nptr to an unsigned long, and store it in @result. + * + * This is a wrapper around strtoul() that is harder to misuse. + * Semantics of @nptr, @endptr, @base match strtoul() with differences + * noted below. + * + * @nptr may be null, and no conversion is performed then. + * + * If no conversion is performed, store @nptr in *@endptr and return + * -EINVAL. + * + * If @endptr is null, and the string isn't fully converted, return + * -EINVAL. This is the case when the pointer that would be stored in + * a non-null @endptr points to a character other than '\0'. + * + * If the conversion overflows @result, store ULONG_MAX in @result, + * and return -ERANGE. + * + * Else store the converted value in @result, and return zero. + * + * Note that a number with a leading minus sign gets converted without + * the minus sign, checked for overflow (see above), then negated (in + * @result's type). This is exactly how strtoul() works. + */ + int qemu_strtoul(const char *nptr, const char **endptr, int base, unsigned long *result); + +/** + * qemu_strtoi64: + * + * Convert string @nptr to an int64_t. + * + * Works like qemu_strtol(), except it stores INT64_MAX on overflow, + * and INT_MIN on underflow. + */ int qemu_strtoi64(const char *nptr, const char **endptr, int base, int64_t *result); + +/** + * qemu_strtou64: + * + * Convert string @nptr to an uint64_t. + * + * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow. + */ int qemu_strtou64(const char *nptr, const char **endptr, int base, uint64_t *result); + +/** + * qemu_strtod: + * + * Convert string @nptr to a double. + * + * This is a wrapper around strtod() that is harder to misuse. + * Semantics of @nptr and @endptr match strtod() with differences + * noted below. + * + * @nptr may be null, and no conversion is performed then. + * + * If no conversion is performed, store @nptr in *@endptr and return + * -EINVAL. + * + * If @endptr is null, and the string isn't fully converted, return + * -EINVAL. This is the case when the pointer that would be stored in + * a non-null @endptr points to a character other than '\0'. + * + * If the conversion overflows, store +/-HUGE_VAL in @result, depending + * on the sign, and return -ERANGE. + * + * If the conversion underflows, store +/-0.0 in @result, depending on the + * sign, and return -ERANGE. + * + * Else store the converted value in @result, and return zero. + */ int qemu_strtod(const char *nptr, const char **endptr, double *result); + +/** + * qemu_strtod_finite: + * + * Convert string @nptr to a finite double. + * + * Works like qemu_strtod(), except that "NaN" and "inf" are rejected + * with -EINVAL and no conversion is performed. + */ int qemu_strtod_finite(const char *nptr, const char **endptr, double *resu= lt); =20 +/** + * parse_uint: + * + * @s: String to parse + * @value: Destination for parsed integer value + * @endptr: Destination for pointer to first character not consumed + * @base: integer base, between 2 and 36 inclusive, or 0 + * + * Parse unsigned integer + * + * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single opti= onal + * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits. + * + * If @s is null, or @base is invalid, or @s doesn't start with an + * integer in the syntax above, set *@value to 0, *@endptr to @s, and + * return -EINVAL. + * + * Set *@endptr to point right beyond the parsed integer (even if the inte= ger + * overflows or is negative, all digits will be parsed and *@endptr will + * point right beyond them). + * + * If the integer is negative, set *@value to 0, and return -ERANGE. + * + * If the integer overflows unsigned long long, set *@value to + * ULLONG_MAX, and return -ERANGE. + * + * Else, set *@value to the parsed integer, and return 0. + */ int parse_uint(const char *s, unsigned long long *value, char **endptr, int base); + +/** + * parse_uint_full: + * + * @s: String to parse + * @value: Destination for parsed integer value + * @base: integer base, between 2 and 36 inclusive, or 0 + * + * Parse unsigned integer from entire string + * + * Have the same behavior of parse_uint(), but with an additional check + * for additional data after the parsed number. If extra characters are pr= esent + * after the parsed number, the function will return -EINVAL, and *@v will + * be set to 0. + */ int parse_uint_full(const char *s, unsigned long long *value, int base); =20 int qemu_strtosz(const char *nptr, const char **end, uint64_t *result); diff --git a/util/cutils.c b/util/cutils.c index a8a3a3ba3b..a4c8858712 100644 --- a/util/cutils.c +++ b/util/cutils.c @@ -296,30 +296,6 @@ static int check_strtox_error(const char *nptr, char *= ep, return -libc_errno; } =20 -/** - * Convert string @nptr to an integer, and store it in @result. - * - * This is a wrapper around strtol() that is harder to misuse. - * Semantics of @nptr, @endptr, @base match strtol() with differences - * noted below. - * - * @nptr may be null, and no conversion is performed then. - * - * If no conversion is performed, store @nptr in *@endptr and return - * -EINVAL. - * - * If @endptr is null, and the string isn't fully converted, return - * -EINVAL. This is the case when the pointer that would be stored in - * a non-null @endptr points to a character other than '\0'. - * - * If the conversion overflows @result, store INT_MAX in @result, - * and return -ERANGE. - * - * If the conversion underflows @result, store INT_MIN in @result, - * and return -ERANGE. - * - * Else store the converted value in @result, and return zero. - */ int qemu_strtoi(const char *nptr, const char **endptr, int base, int *result) { @@ -348,31 +324,6 @@ int qemu_strtoi(const char *nptr, const char **endptr,= int base, return check_strtox_error(nptr, ep, endptr, errno); } =20 -/** - * Convert string @nptr to an unsigned integer, and store it in @result. - * - * This is a wrapper around strtoul() that is harder to misuse. - * Semantics of @nptr, @endptr, @base match strtoul() with differences - * noted below. - * - * @nptr may be null, and no conversion is performed then. - * - * If no conversion is performed, store @nptr in *@endptr and return - * -EINVAL. - * - * If @endptr is null, and the string isn't fully converted, return - * -EINVAL. This is the case when the pointer that would be stored in - * a non-null @endptr points to a character other than '\0'. - * - * If the conversion overflows @result, store UINT_MAX in @result, - * and return -ERANGE. - * - * Else store the converted value in @result, and return zero. - * - * Note that a number with a leading minus sign gets converted without - * the minus sign, checked for overflow (see above), then negated (in - * @result's type). This is exactly how strtoul() works. - */ int qemu_strtoui(const char *nptr, const char **endptr, int base, unsigned int *result) { @@ -407,30 +358,6 @@ int qemu_strtoui(const char *nptr, const char **endptr= , int base, return check_strtox_error(nptr, ep, endptr, errno); } =20 -/** - * Convert string @nptr to a long integer, and store it in @result. - * - * This is a wrapper around strtol() that is harder to misuse. - * Semantics of @nptr, @endptr, @base match strtol() with differences - * noted below. - * - * @nptr may be null, and no conversion is performed then. - * - * If no conversion is performed, store @nptr in *@endptr and return - * -EINVAL. - * - * If @endptr is null, and the string isn't fully converted, return - * -EINVAL. This is the case when the pointer that would be stored in - * a non-null @endptr points to a character other than '\0'. - * - * If the conversion overflows @result, store LONG_MAX in @result, - * and return -ERANGE. - * - * If the conversion underflows @result, store LONG_MIN in @result, - * and return -ERANGE. - * - * Else store the converted value in @result, and return zero. - */ int qemu_strtol(const char *nptr, const char **endptr, int base, long *result) { @@ -449,31 +376,6 @@ int qemu_strtol(const char *nptr, const char **endptr,= int base, return check_strtox_error(nptr, ep, endptr, errno); } =20 -/** - * Convert string @nptr to an unsigned long, and store it in @result. - * - * This is a wrapper around strtoul() that is harder to misuse. - * Semantics of @nptr, @endptr, @base match strtoul() with differences - * noted below. - * - * @nptr may be null, and no conversion is performed then. - * - * If no conversion is performed, store @nptr in *@endptr and return - * -EINVAL. - * - * If @endptr is null, and the string isn't fully converted, return - * -EINVAL. This is the case when the pointer that would be stored in - * a non-null @endptr points to a character other than '\0'. - * - * If the conversion overflows @result, store ULONG_MAX in @result, - * and return -ERANGE. - * - * Else store the converted value in @result, and return zero. - * - * Note that a number with a leading minus sign gets converted without - * the minus sign, checked for overflow (see above), then negated (in - * @result's type). This is exactly how strtoul() works. - */ int qemu_strtoul(const char *nptr, const char **endptr, int base, unsigned long *result) { @@ -496,12 +398,6 @@ int qemu_strtoul(const char *nptr, const char **endptr= , int base, return check_strtox_error(nptr, ep, endptr, errno); } =20 -/** - * Convert string @nptr to an int64_t. - * - * Works like qemu_strtol(), except it stores INT64_MAX on overflow, - * and INT_MIN on underflow. - */ int qemu_strtoi64(const char *nptr, const char **endptr, int base, int64_t *result) { @@ -521,11 +417,6 @@ int qemu_strtoi64(const char *nptr, const char **endpt= r, int base, return check_strtox_error(nptr, ep, endptr, errno); } =20 -/** - * Convert string @nptr to an uint64_t. - * - * Works like qemu_strtoul(), except it stores UINT64_MAX on overflow. - */ int qemu_strtou64(const char *nptr, const char **endptr, int base, uint64_t *result) { @@ -549,30 +440,6 @@ int qemu_strtou64(const char *nptr, const char **endpt= r, int base, return check_strtox_error(nptr, ep, endptr, errno); } =20 -/** - * Convert string @nptr to a double. - * - * This is a wrapper around strtod() that is harder to misuse. - * Semantics of @nptr and @endptr match strtod() with differences - * noted below. - * - * @nptr may be null, and no conversion is performed then. - * - * If no conversion is performed, store @nptr in *@endptr and return - * -EINVAL. - * - * If @endptr is null, and the string isn't fully converted, return - * -EINVAL. This is the case when the pointer that would be stored in - * a non-null @endptr points to a character other than '\0'. - * - * If the conversion overflows, store +/-HUGE_VAL in @result, depending - * on the sign, and return -ERANGE. - * - * If the conversion underflows, store +/-0.0 in @result, depending on the - * sign, and return -ERANGE. - * - * Else store the converted value in @result, and return zero. - */ int qemu_strtod(const char *nptr, const char **endptr, double *result) { char *ep; @@ -589,12 +456,6 @@ int qemu_strtod(const char *nptr, const char **endptr,= double *result) return check_strtox_error(nptr, ep, endptr, errno); } =20 -/** - * Convert string @nptr to a finite double. - * - * Works like qemu_strtod(), except that "NaN" and "inf" are rejected - * with -EINVAL and no conversion is performed. - */ int qemu_strtod_finite(const char *nptr, const char **endptr, double *resu= lt) { double tmp; @@ -614,10 +475,6 @@ int qemu_strtod_finite(const char *nptr, const char **= endptr, double *result) return ret; } =20 -/** - * Searches for the first occurrence of 'c' in 's', and returns a pointer - * to the trailing null byte if none was found. - */ #ifndef HAVE_STRCHRNUL const char *qemu_strchrnul(const char *s, int c) { @@ -629,34 +486,6 @@ const char *qemu_strchrnul(const char *s, int c) } #endif =20 -/** - * parse_uint: - * - * @s: String to parse - * @value: Destination for parsed integer value - * @endptr: Destination for pointer to first character not consumed - * @base: integer base, between 2 and 36 inclusive, or 0 - * - * Parse unsigned integer - * - * Parsed syntax is like strtoull()'s: arbitrary whitespace, a single opti= onal - * '+' or '-', an optional "0x" if @base is 0 or 16, one or more digits. - * - * If @s is null, or @base is invalid, or @s doesn't start with an - * integer in the syntax above, set *@value to 0, *@endptr to @s, and - * return -EINVAL. - * - * Set *@endptr to point right beyond the parsed integer (even if the inte= ger - * overflows or is negative, all digits will be parsed and *@endptr will - * point right beyond them). - * - * If the integer is negative, set *@value to 0, and return -ERANGE. - * - * If the integer overflows unsigned long long, set *@value to - * ULLONG_MAX, and return -ERANGE. - * - * Else, set *@value to the parsed integer, and return 0. - */ int parse_uint(const char *s, unsigned long long *value, char **endptr, int base) { @@ -698,20 +527,6 @@ out: return r; } =20 -/** - * parse_uint_full: - * - * @s: String to parse - * @value: Destination for parsed integer value - * @base: integer base, between 2 and 36 inclusive, or 0 - * - * Parse unsigned integer from entire string - * - * Have the same behavior of parse_uint(), but with an additional check - * for additional data after the parsed number. If extra characters are pr= esent - * after the parsed number, the function will return -EINVAL, and *@v will - * be set to 0. - */ int parse_uint_full(const char *s, unsigned long long *value, int base) { char *endp; --=20 2.17.2