From nobody Wed Nov 5 13:32:26 2025 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 1534409454598537.3304781184105; Thu, 16 Aug 2018 01:50:54 -0700 (PDT) Received: from localhost ([::1]:54302 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fqDzW-0001W6-C9 for importer@patchew.org; Thu, 16 Aug 2018 04:50:50 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:50604) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fqDmf-0000yj-HJ for qemu-devel@nongnu.org; Thu, 16 Aug 2018 04:37:34 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fqDmT-0005G2-41 for qemu-devel@nongnu.org; Thu, 16 Aug 2018 04:37:25 -0400 Received: from mx3-rdu2.redhat.com ([66.187.233.73]:57656 helo=mx1.redhat.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fqDmJ-00059N-Lk for qemu-devel@nongnu.org; Thu, 16 Aug 2018 04:37:16 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 804F572645 for ; Thu, 16 Aug 2018 08:37:04 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-116-56.ams2.redhat.com [10.36.116.56]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 3B9DC2166BA0; Thu, 16 Aug 2018 08:37:04 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id E62CC113865A; Thu, 16 Aug 2018 10:37:01 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Date: Thu, 16 Aug 2018 10:36:41 +0200 Message-Id: <20180816083701.3932-6-armbru@redhat.com> In-Reply-To: <20180816083701.3932-1-armbru@redhat.com> References: <20180816083701.3932-1-armbru@redhat.com> X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.2]); Thu, 16 Aug 2018 08:37:04 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.2]); Thu, 16 Aug 2018 08:37:04 +0000 (UTC) for IP:'10.11.54.6' DOMAIN:'int-mx06.intmail.prod.int.rdu2.redhat.com' HELO:'smtp.corp.redhat.com' FROM:'armbru@redhat.com' RCPT:'' X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 66.187.233.73 Subject: [Qemu-devel] [PULL 05/25] libqtest: Document calling conventions 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: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RDMRC_1 RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" From: Eric Blake We have two flavors of vararg usage in qtest: qtest_hmp() etc. work like sprintf(), and qtest_qmp() etc. work like qobject_from_jsonf(). Spell that out in the comments. Also add GCC_FMT_ATTR() to qtest_hmp() etc. so that the compiler can flag incorrect use. We have some cleanup work to do before we can do the same for qtest_qmp() etc. This would get us the same better-than-nothing checking we already have for qobject_from_jsonf(): common incorrect uses of supported conversion specifications will be flagged (e.g. passing a double for %d), but use of unsupported ones won't. Signed-off-by: Eric Blake Reviewed-by: Stefan Hajnoczi Reviewed-by: Markus Armbruster [Rebased, comment wording tweaked, commit message rewritten] Signed-off-by: Markus Armbruster Message-Id: <20180806065344.7103-6-armbru@redhat.com> --- tests/libqtest.h | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/tests/libqtest.h b/tests/libqtest.h index 3eecd5e9a7..da13ea00ef 100644 --- a/tests/libqtest.h +++ b/tests/libqtest.h @@ -76,7 +76,9 @@ void qtest_quit(QTestState *s); /** * qtest_qmp: * @s: #QTestState instance to operate on. - * @fmt...: QMP message to send to qemu + * @fmt...: QMP message to send to qemu, formatted like + * qobject_from_jsonf(). See parse_escape() for what's supported + * after '%'. * * Sends a QMP message to QEMU and returns the response. */ @@ -85,7 +87,9 @@ QDict *qtest_qmp(QTestState *s, const char *fmt, ...); /** * qtest_qmp_send: * @s: #QTestState instance to operate on. - * @fmt...: QMP message to send to qemu + * @fmt...: QMP message to send to qemu, formatted like + * qobject_from_jsonf(). See parse_escape() for what's supported + * after '%'. * * Sends a QMP message to QEMU and leaves the response in the stream. */ @@ -94,7 +98,9 @@ void qtest_qmp_send(QTestState *s, const char *fmt, ...); /** * qtest_qmpv: * @s: #QTestState instance to operate on. - * @fmt: QMP message to send to QEMU + * @fmt: QMP message to send to QEMU, formatted like + * qobject_from_jsonf(). See parse_escape() for what's supported + * after '%'. * @ap: QMP message arguments * * Sends a QMP message to QEMU and returns the response. @@ -104,7 +110,9 @@ QDict *qtest_qmpv(QTestState *s, const char *fmt, va_li= st ap); /** * qtest_qmp_vsend: * @s: #QTestState instance to operate on. - * @fmt: QMP message to send to QEMU + * @fmt: QMP message to send to QEMU, formatted like + * qobject_from_jsonf(). See parse_escape() for what's supported + * after '%'. * @ap: QMP message arguments * * Sends a QMP message to QEMU and leaves the response in the stream. @@ -153,7 +161,7 @@ char *qtest_hmp(QTestState *s, const char *fmt, ...) GC= C_FMT_ATTR(2, 3); /** * qtest_hmpv: * @s: #QTestState instance to operate on. - * @fmt: HMP command to send to QEMU + * @fmt: HMP command to send to QEMU, formats arguments like vsprintf(). * @ap: HMP command arguments * * Send HMP command to QEMU via QMP's human-monitor-command. @@ -161,7 +169,8 @@ char *qtest_hmp(QTestState *s, const char *fmt, ...) GC= C_FMT_ATTR(2, 3); * * Returns: the command's output. The caller should g_free() it. */ -char *qtest_hmpv(QTestState *s, const char *fmt, va_list ap); +char *qtest_hmpv(QTestState *s, const char *fmt, va_list ap) + GCC_FMT_ATTR(2, 0); =20 /** * qtest_get_irq: @@ -542,7 +551,9 @@ static inline void qtest_end(void) =20 /** * qmp: - * @fmt...: QMP message to send to qemu + * @fmt...: QMP message to send to qemu, formatted like + * qobject_from_jsonf(). See parse_escape() for what's supported + * after '%'. * * Sends a QMP message to QEMU and returns the response. */ @@ -550,7 +561,9 @@ QDict *qmp(const char *fmt, ...); =20 /** * qmp_send: - * @fmt...: QMP message to send to qemu + * @fmt...: QMP message to send to qemu, formatted like + * qobject_from_jsonf(). See parse_escape() for what's supported + * after '%'. * * Sends a QMP message to QEMU and leaves the response in the stream. */ --=20 2.17.1