From patchwork Wed Dec 26 17:15:36 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= X-Patchwork-Id: 10743221 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 79EC113BF for ; Wed, 26 Dec 2018 17:17:43 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 5C52828574 for ; Wed, 26 Dec 2018 17:17:43 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 4E44F286A9; Wed, 26 Dec 2018 17:17:43 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id B7C2928574 for ; Wed, 26 Dec 2018 17:17:42 +0000 (UTC) Received: from localhost ([127.0.0.1]:47339 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gcCoP-0000Ml-BV for patchwork-qemu-devel@patchwork.kernel.org; Wed, 26 Dec 2018 12:17:41 -0500 Received: from eggs.gnu.org ([208.118.235.92]:46746) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gcCml-0006st-5v for qemu-devel@nongnu.org; Wed, 26 Dec 2018 12:16:00 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gcCmk-0005B6-4W for qemu-devel@nongnu.org; Wed, 26 Dec 2018 12:15:59 -0500 Received: from mx1.redhat.com ([209.132.183.28]:45766) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gcCmj-00056r-Qj; Wed, 26 Dec 2018 12:15:58 -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 DBF64C0587F4; Wed, 26 Dec 2018 17:15:56 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-51.brq.redhat.com [10.40.204.51]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 42E035D9C9; Wed, 26 Dec 2018 17:15:53 +0000 (UTC) From: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Date: Wed, 26 Dec 2018 18:15:36 +0100 Message-Id: <20181226171538.21984-2-philmd@redhat.com> In-Reply-To: <20181226171538.21984-1-philmd@redhat.com> References: <20181226171538.21984-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.32]); Wed, 26 Dec 2018 17:15:56 +0000 (UTC) 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 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: David Hildenbrand , qemu-trivial@nongnu.org, Cornelia Huck , Markus Armbruster , Michael Roth , Gerd Hoffmann , Paolo Bonzini , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP 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é --- 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); const char *qemu_ether_ntoa(const MACAddr *mac); -char *size_to_str(uint64_t val); void page_size_init(void); /* 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, uint64_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 *result); +/** + * 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") 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 @@ */ #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; } -/* - * 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[] = { "", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" }; From patchwork Wed Dec 26 17:15:37 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= X-Patchwork-Id: 10743239 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id ACF076C2 for ; Wed, 26 Dec 2018 17:24:21 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 8FD13287AC for ; Wed, 26 Dec 2018 17:24:21 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 835F3287B1; Wed, 26 Dec 2018 17:24:21 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id DAE9D287AC for ; Wed, 26 Dec 2018 17:24:20 +0000 (UTC) Received: from localhost ([127.0.0.1]:47413 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gcCuq-0000e6-3G for patchwork-qemu-devel@patchwork.kernel.org; Wed, 26 Dec 2018 12:24:20 -0500 Received: from eggs.gnu.org ([208.118.235.92]:46836) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gcCmu-00074s-Vs for qemu-devel@nongnu.org; Wed, 26 Dec 2018 12:16:10 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gcCmr-0005KJ-0K for qemu-devel@nongnu.org; Wed, 26 Dec 2018 12:16:08 -0500 Received: from mx1.redhat.com ([209.132.183.28]:45816) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gcCmq-0005K0-PQ; Wed, 26 Dec 2018 12:16:04 -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 D7C73C029435; Wed, 26 Dec 2018 17:16:03 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-51.brq.redhat.com [10.40.204.51]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 86BDD5D9C9; Wed, 26 Dec 2018 17:15:57 +0000 (UTC) From: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Date: Wed, 26 Dec 2018 18:15:37 +0100 Message-Id: <20181226171538.21984-3-philmd@redhat.com> In-Reply-To: <20181226171538.21984-1-philmd@redhat.com> References: <20181226171538.21984-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.32]); Wed, 26 Dec 2018 17:16:04 +0000 (UTC) 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 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 , David Hildenbrand , qemu-trivial@nongnu.org, Cornelia Huck , Markus Armbruster , Michael Roth , Halil Pasic , Christian Borntraeger , "open list:S390" , "open list:PowerPC" , Gerd Hoffmann , Paolo Bonzini , David Gibson , =?utf-8?q?Philippe_Mathieu-Daud?= =?utf-8?q?=C3=A9?= , Richard Henderson Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP Introduced in cd390083ad1, these macros don't need to be in a generic header. Add documentation to justify their use. Signed-off-by: Philippe Mathieu-Daudé Reviewed-by: Stefano Garzarella --- 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 | 24 ++++++++++++++++++++++++ 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, 32 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 @@ */ #include "qemu/osdep.h" -#include "qemu-common.h" +#include "qemu/cutils.h" #include "hw/qdev.h" #include "qapi/error.h" 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 @@ */ #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 @@ */ #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); -#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); 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..cb06a5adab 100644 --- a/include/qemu/cutils.h +++ b/include/qemu/cutils.h @@ -3,6 +3,30 @@ #include "qemu/fprintf-fn.h" +/** 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 @@ */ #include "qemu/osdep.h" +#include "qemu/cutils.h" #include "qapi/error.h" -#include "qemu-common.h" 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 @@ */ #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 @@ */ #include "qemu/osdep.h" -#include "qemu-common.h" +#include "qemu/cutils.h" #include "qemu/id.h" 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 @@ */ #include "qemu/osdep.h" -#include "qemu-common.h" #include "qemu/readline.h" #include "qemu/cutils.h" From patchwork Wed Dec 26 17:15:38 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= X-Patchwork-Id: 10743229 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 9F5486C2 for ; Wed, 26 Dec 2018 17:20:58 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 7EFA22863C for ; Wed, 26 Dec 2018 17:20:58 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 70C472878C; Wed, 26 Dec 2018 17:20:58 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id C21AA28786 for ; Wed, 26 Dec 2018 17:20:56 +0000 (UTC) Received: from localhost ([127.0.0.1]:47368 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gcCrY-0004Tu-0K for patchwork-qemu-devel@patchwork.kernel.org; Wed, 26 Dec 2018 12:20:56 -0500 Received: from eggs.gnu.org ([208.118.235.92]:46949) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gcCn9-0007GF-RJ for qemu-devel@nongnu.org; Wed, 26 Dec 2018 12:16:27 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gcCn6-0005SJ-1E for qemu-devel@nongnu.org; Wed, 26 Dec 2018 12:16:23 -0500 Received: from mx1.redhat.com ([209.132.183.28]:56554) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gcCn4-0005Qw-LA; Wed, 26 Dec 2018 12:16:19 -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 5FCD780F6C; Wed, 26 Dec 2018 17:16:17 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-51.brq.redhat.com [10.40.204.51]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 836215D9C9; Wed, 26 Dec 2018 17:16:04 +0000 (UTC) From: =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Date: Wed, 26 Dec 2018 18:15:38 +0100 Message-Id: <20181226171538.21984-4-philmd@redhat.com> In-Reply-To: <20181226171538.21984-1-philmd@redhat.com> References: <20181226171538.21984-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.27]); Wed, 26 Dec 2018 17:16:17 +0000 (UTC) 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 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: David Hildenbrand , qemu-trivial@nongnu.org, Cornelia Huck , Markus Armbruster , Michael Roth , Gerd Hoffmann , Paolo Bonzini , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP 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é --- 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 cb06a5adab..fa22152e07 100644 --- a/include/qemu/cutils.h +++ b/include/qemu/cutils.h @@ -46,6 +46,7 @@ * bytes and then add a NUL */ void pstrcpy(char *buf, int buf_size, const char *str); + /** * strpadcpy: * @buf: buffer to copy string into @@ -59,6 +60,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 @@ -76,6 +78,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 @@ -93,6 +96,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 @@ -109,6 +113,7 @@ int strstart(const char *str, const char *val, const char **ptr); * false otherwise. */ int stristart(const char *str, const char *val, const char **ptr); + /** * qemu_strnlen: * @s: string @@ -125,6 +130,7 @@ int stristart(const char *str, const char *val, const char **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 @@ -146,6 +152,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) { @@ -154,27 +170,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 *result); +/** + * 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 optional + * '+' 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 integer + * 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 present + * 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); 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; } -/** - * 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); } -/** - * 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); } -/** - * 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); } -/** - * 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); } -/** - * 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 **endptr, int base, return check_strtox_error(nptr, ep, endptr, errno); } -/** - * 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 **endptr, int base, return check_strtox_error(nptr, ep, endptr, errno); } -/** - * 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); } -/** - * 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 *result) { double tmp; @@ -614,10 +475,6 @@ int qemu_strtod_finite(const char *nptr, const char **endptr, double *result) return ret; } -/** - * 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 -/** - * 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 optional - * '+' 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 integer - * 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; } -/** - * 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 present - * 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;