From nobody Fri Dec 19 20:53:05 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.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 ARC-Seal: i=1; a=rsa-sha256; t=1594244943; cv=none; d=zohomail.com; s=zohoarc; b=fLcfeda7hBX3rSRz/e1TJ0pLj1c/Dg7UhkE3BRkZkuHi9njymjk69+If04rLOr63BT1a1UPpFzf47xFxlW1eqfL2pDi+hOE/pn3oT6uuJ2kduMXo4OUT5ZYtUTwVOBSMJy2/vl5Y+I2+4q1dOHvQpnfkfiO3GT4McmZBGreyWPM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1594244943; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=fzkubUAyvoFplBa3p5RZsNjT84vbZjohm1jJEmwi/Ek=; b=KFrRLk81j8xve/Q4ias8K8fdyghRPmkwPNOLp6gSruHiInzflAL/U/Fv4Ee//XpQDLFqokhAPqZ9vmmXk6LC3pMRkMRsTCiLoD0mbFJJkDUEp12mTwrVoD+9DJtNfPrA4MFMHMD2gTwtoW2dgVIiK5SIZCRzrumJE0ZZTYzMs40= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.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 header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1594244943171173.61751174133497; Wed, 8 Jul 2020 14:49:03 -0700 (PDT) Received: from localhost ([::1]:44914 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jtHw5-0006Uv-PF for importer@patchew.org; Wed, 08 Jul 2020 17:49:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:35138) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jtHev-0004TD-Ad for qemu-devel@nongnu.org; Wed, 08 Jul 2020 17:31:17 -0400 Received: from us-smtp-1.mimecast.com ([205.139.110.61]:51636 helo=us-smtp-delivery-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1jtHes-0002aW-4o for qemu-devel@nongnu.org; Wed, 08 Jul 2020 17:31:16 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-68-XY3esrA5NwmaMjwcyDFhrg-1; Tue, 07 Jul 2020 17:25:23 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id EBC82107ACCA for ; Tue, 7 Jul 2020 21:25:22 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-112-143.ams2.redhat.com [10.36.112.143]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 712535BAC3; Tue, 7 Jul 2020 21:25:22 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id AD4B310C4AE4; Tue, 7 Jul 2020 23:25:04 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1594243873; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=fzkubUAyvoFplBa3p5RZsNjT84vbZjohm1jJEmwi/Ek=; b=I+zZ2m6zTDvZqpct7eEvj99am6WwuaIlyXWOJPioOVSViYBZuFvDjyKb80ADJ+JCnKqn6x GJg87UqUXZA/MsNoHR8BqtxnomQu4qeYQcRDUGnJ5eH/aC8Mi1CEo03a6Y5SvKThgSUp3Q JIozimrJ3QA0djkiQA5usrSDm7L/A34= X-MC-Unique: XY3esrA5NwmaMjwcyDFhrg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Subject: [PULL 40/53] qapi: Smooth visitor error checking in generated code Date: Tue, 7 Jul 2020 23:24:50 +0200 Message-Id: <20200707212503.1495927-41-armbru@redhat.com> In-Reply-To: <20200707212503.1495927-1-armbru@redhat.com> References: <20200707212503.1495927-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=armbru@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.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=lists.gnu.org; Received-SPF: pass client-ip=205.139.110.61; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-1.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/07/07 17:25:10 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -40 X-Spam_score: -4.1 X-Spam_bar: ---- X-Spam_report: (-4.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 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-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Use visitor functions' return values to check for failure. Eliminate error_propagate() that are now unnecessary. Delete @err that are now unused. Signed-off-by: Markus Armbruster Reviewed-by: Eric Blake Message-Id: <20200707160613.848843-41-armbru@redhat.com> --- docs/devel/qapi-code-gen.txt | 60 ++++++++++++++---------------------- scripts/qapi/commands.py | 22 ++++++------- scripts/qapi/visit.py | 57 ++++++++++++++-------------------- 3 files changed, 55 insertions(+), 84 deletions(-) diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt index 9bfc57063c..69eede6c28 100644 --- a/docs/devel/qapi-code-gen.txt +++ b/docs/devel/qapi-code-gen.txt @@ -1420,8 +1420,6 @@ Example: =20 bool visit_type_UserDefOne_members(Visitor *v, UserDefOne *obj, Error = **errp) { - Error *err =3D NULL; - if (!visit_type_int(v, "integer", &obj->integer, errp)) { return false; } @@ -1430,13 +1428,12 @@ Example: return false; } } - error_propagate(errp, err); - return !err; + return true; } =20 bool visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne **= obj, Error **errp) { - Error *err =3D NULL; + bool ok =3D false; =20 if (!visit_start_struct(v, name, (void **)obj, sizeof(UserDefOne),= errp)) { return false; @@ -1446,24 +1443,22 @@ Example: assert(visit_is_dealloc(v)); goto out_obj; } - visit_type_UserDefOne_members(v, *obj, &err); - if (err) { + if (!visit_type_UserDefOne_members(v, *obj, errp)) { goto out_obj; } - visit_check_struct(v, &err); + ok =3D visit_check_struct(v, errp); out_obj: visit_end_struct(v, (void **)obj); - if (err && visit_is_input(v)) { + if (!ok && visit_is_input(v)) { qapi_free_UserDefOne(*obj); *obj =3D NULL; } - error_propagate(errp, err); - return !err; + return ok; } =20 bool visit_type_UserDefOneList(Visitor *v, const char *name, UserDefOn= eList **obj, Error **errp) { - Error *err =3D NULL; + bool ok =3D false; UserDefOneList *tail; size_t size =3D sizeof(**obj); =20 @@ -1473,33 +1468,27 @@ Example: =20 for (tail =3D *obj; tail; tail =3D (UserDefOneList *)visit_next_list(v, (GenericList *)= tail, size)) { - visit_type_UserDefOne(v, NULL, &tail->value, &err); - if (err) { - break; + if (!visit_type_UserDefOne(v, NULL, &tail->value, errp)) { + goto out_obj; } } =20 - if (!err) { - visit_check_list(v, &err); - } + ok =3D visit_check_list(v, errp); + out_obj: visit_end_list(v, (void **)obj); - if (err && visit_is_input(v)) { + if (!ok && visit_is_input(v)) { qapi_free_UserDefOneList(*obj); *obj =3D NULL; } - error_propagate(errp, err); - return !err; + return ok; } =20 bool visit_type_q_obj_my_command_arg_members(Visitor *v, q_obj_my_comm= and_arg *obj, Error **errp) { - Error *err =3D NULL; - if (!visit_type_UserDefOneList(v, "arg1", &obj->arg1, errp)) { return false; } - error_propagate(errp, err); - return !err; + return true; } =20 [Uninteresting stuff omitted...] @@ -1554,15 +1543,12 @@ Example: =20 static void qmp_marshal_output_UserDefOne(UserDefOne *ret_in, QObject = **ret_out, Error **errp) { - Error *err =3D NULL; Visitor *v; =20 v =3D qobject_output_visitor_new(ret_out); - visit_type_UserDefOne(v, "unused", &ret_in, &err); - if (!err) { + if (visit_type_UserDefOne(v, "unused", &ret_in, errp)) { visit_complete(v, ret_out); } - error_propagate(errp, err); visit_free(v); v =3D qapi_dealloc_visitor_new(); visit_type_UserDefOne(v, "unused", &ret_in, NULL); @@ -1572,33 +1558,32 @@ Example: void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp) { Error *err =3D NULL; + bool ok =3D false; Visitor *v; UserDefOne *retval; q_obj_my_command_arg arg =3D {0}; =20 v =3D qobject_input_visitor_new(QOBJECT(args)); - visit_start_struct(v, NULL, NULL, 0, &err); - if (err) { + if (!visit_start_struct(v, NULL, NULL, 0, errp)) { goto out; } - visit_type_q_obj_my_command_arg_members(v, &arg, &err); - if (!err) { - visit_check_struct(v, &err); + if (visit_type_q_obj_my_command_arg_members(v, &arg, errp)) { + ok =3D visit_check_struct(v, errp); } visit_end_struct(v, NULL); - if (err) { + if (!ok) { goto out; } =20 retval =3D qmp_my_command(arg.arg1, &err); + error_propagate(errp, err); if (err) { goto out; } =20 - qmp_marshal_output_UserDefOne(retval, ret, &err); + qmp_marshal_output_UserDefOne(retval, ret, errp); =20 out: - error_propagate(errp, err); visit_free(v); v =3D qapi_dealloc_visitor_new(); visit_start_struct(v, NULL, NULL, 0, NULL); @@ -1606,6 +1591,7 @@ Example: visit_end_struct(v, NULL); visit_free(v); } + [Uninteresting stuff omitted...] $ cat qapi-generated/example-qapi-init-commands.h [Uninteresting stuff omitted...] diff --git a/scripts/qapi/commands.py b/scripts/qapi/commands.py index 6809b0fb6e..3cf9e1110b 100644 --- a/scripts/qapi/commands.py +++ b/scripts/qapi/commands.py @@ -47,6 +47,7 @@ def gen_call(name, arg_type, boxed, ret_type): ret =3D mcgen(''' =20 %(lhs)sqmp_%(c_name)s(%(args)s&err); + error_propagate(errp, err); ''', c_name=3Dc_name(name), args=3Dargstr, lhs=3Dlhs) if ret_type: @@ -55,7 +56,7 @@ def gen_call(name, arg_type, boxed, ret_type): goto out; } =20 - qmp_marshal_output_%(c_name)s(retval, ret, &err); + qmp_marshal_output_%(c_name)s(retval, ret, errp); ''', c_name=3Dret_type.c_name()) return ret @@ -66,15 +67,12 @@ def gen_marshal_output(ret_type): =20 static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret= _out, Error **errp) { - Error *err =3D NULL; Visitor *v; =20 v =3D qobject_output_visitor_new(ret_out); - visit_type_%(c_name)s(v, "unused", &ret_in, &err); - if (!err) { + if (visit_type_%(c_name)s(v, "unused", &ret_in, errp)) { visit_complete(v, ret_out); } - error_propagate(errp, err); visit_free(v); v =3D qapi_dealloc_visitor_new(); visit_type_%(c_name)s(v, "unused", &ret_in, NULL); @@ -104,6 +102,7 @@ def gen_marshal(name, arg_type, boxed, ret_type): %(proto)s { Error *err =3D NULL; + bool ok =3D false; Visitor *v; ''', proto=3Dbuild_marshal_proto(name)) @@ -123,28 +122,26 @@ def gen_marshal(name, arg_type, boxed, ret_type): ret +=3D mcgen(''' =20 v =3D qobject_input_visitor_new(QOBJECT(args)); - visit_start_struct(v, NULL, NULL, 0, &err); - if (err) { + if (!visit_start_struct(v, NULL, NULL, 0, errp)) { goto out; } ''') =20 if have_args: ret +=3D mcgen(''' - visit_type_%(c_arg_type)s_members(v, &arg, &err); - if (!err) { - visit_check_struct(v, &err); + if (visit_type_%(c_arg_type)s_members(v, &arg, errp)) { + ok =3D visit_check_struct(v, errp); } ''', c_arg_type=3Darg_type.c_name()) else: ret +=3D mcgen(''' - visit_check_struct(v, &err); + ok =3D visit_check_struct(v, errp); ''') =20 ret +=3D mcgen(''' visit_end_struct(v, NULL); - if (err) { + if (!ok) { goto out; } ''') @@ -154,7 +151,6 @@ def gen_marshal(name, arg_type, boxed, ret_type): ret +=3D mcgen(''' =20 out: - error_propagate(errp, err); visit_free(v); ''') =20 diff --git a/scripts/qapi/visit.py b/scripts/qapi/visit.py index ba0cf0b074..3fb2f30510 100644 --- a/scripts/qapi/visit.py +++ b/scripts/qapi/visit.py @@ -41,8 +41,6 @@ def gen_visit_object_members(name, base, members, variant= s): =20 bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **er= rp) { - Error *err =3D NULL; - ''', c_name=3Dc_name(name)) =20 @@ -97,8 +95,7 @@ bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s= *obj, Error **errp) else: ret +=3D mcgen(''' case %(case)s: - visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err); - break; + return visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, errp); ''', case=3Dcase_str, c_type=3Dvar.type.c_name(), c_name=3Dc_name(v= ar.name)) @@ -111,8 +108,7 @@ bool visit_type_%(c_name)s_members(Visitor *v, %(c_name= )s *obj, Error **errp) ''') =20 ret +=3D mcgen(''' - error_propagate(errp, err); - return !err; + return true; } ''') return ret @@ -123,7 +119,7 @@ def gen_visit_list(name, element_type): =20 bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj,= Error **errp) { - Error *err =3D NULL; + bool ok =3D false; %(c_name)s *tail; size_t size =3D sizeof(**obj); =20 @@ -133,22 +129,19 @@ bool visit_type_%(c_name)s(Visitor *v, const char *na= me, %(c_name)s **obj, Error =20 for (tail =3D *obj; tail; tail =3D (%(c_name)s *)visit_next_list(v, (GenericList *)tail, si= ze)) { - visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err); - if (err) { - break; + if (!visit_type_%(c_elt_type)s(v, NULL, &tail->value, errp)) { + goto out_obj; } } =20 - if (!err) { - visit_check_list(v, &err); - } + ok =3D visit_check_list(v, errp); +out_obj: visit_end_list(v, (void **)obj); - if (err && visit_is_input(v)) { + if (!ok && visit_is_input(v)) { qapi_free_%(c_name)s(*obj); *obj =3D NULL; } - error_propagate(errp, err); - return !err; + return ok; } ''', c_name=3Dc_name(name), c_elt_type=3Delement_type.c_name()) @@ -173,7 +166,7 @@ def gen_visit_alternate(name, variants): =20 bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj,= Error **errp) { - Error *err =3D NULL; + bool ok =3D false; =20 if (!visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj), errp)) { @@ -182,6 +175,7 @@ bool visit_type_%(c_name)s(Visitor *v, const char *name= , %(c_name)s **obj, Error if (!*obj) { /* incomplete */ assert(visit_is_dealloc(v)); + ok =3D true; goto out_obj; } switch ((*obj)->type) { @@ -196,13 +190,11 @@ bool visit_type_%(c_name)s(Visitor *v, const char *na= me, %(c_name)s **obj, Error case=3Dvar.type.alternate_qtype()) if isinstance(var.type, QAPISchemaObjectType): ret +=3D mcgen(''' - visit_start_struct(v, name, NULL, 0, &err); - if (err) { + if (!visit_start_struct(v, name, NULL, 0, errp)) { break; } - visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err); - if (!err) { - visit_check_struct(v, &err); + if (visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, errp))= { + ok =3D visit_check_struct(v, errp); } visit_end_struct(v, NULL); ''', @@ -210,7 +202,7 @@ bool visit_type_%(c_name)s(Visitor *v, const char *name= , %(c_name)s **obj, Error c_name=3Dc_name(var.name)) else: ret +=3D mcgen(''' - visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err); + ok =3D visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, errp); ''', c_type=3Dvar.type.c_name(), c_name=3Dc_name(var.name)) @@ -224,7 +216,7 @@ bool visit_type_%(c_name)s(Visitor *v, const char *name= , %(c_name)s **obj, Error abort(); default: assert(visit_is_input(v)); - error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null", + error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null", "%(name)s"); /* Avoid passing invalid *obj to qapi_free_%(c_name)s() */ g_free(*obj); @@ -232,12 +224,11 @@ bool visit_type_%(c_name)s(Visitor *v, const char *na= me, %(c_name)s **obj, Error } out_obj: visit_end_alternate(v, (void **)obj); - if (err && visit_is_input(v)) { + if (!ok && visit_is_input(v)) { qapi_free_%(c_name)s(*obj); *obj =3D NULL; } - error_propagate(errp, err); - return !err; + return ok; } ''', name=3Dname, c_name=3Dc_name(name)) @@ -250,7 +241,7 @@ def gen_visit_object(name, base, members, variants): =20 bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj,= Error **errp) { - Error *err =3D NULL; + bool ok =3D false; =20 if (!visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), err= p)) { return false; @@ -260,19 +251,17 @@ bool visit_type_%(c_name)s(Visitor *v, const char *na= me, %(c_name)s **obj, Error assert(visit_is_dealloc(v)); goto out_obj; } - visit_type_%(c_name)s_members(v, *obj, &err); - if (err) { + if (!visit_type_%(c_name)s_members(v, *obj, errp)) { goto out_obj; } - visit_check_struct(v, &err); + ok =3D visit_check_struct(v, errp); out_obj: visit_end_struct(v, (void **)obj); - if (err && visit_is_input(v)) { + if (!ok && visit_is_input(v)) { qapi_free_%(c_name)s(*obj); *obj =3D NULL; } - error_propagate(errp, err); - return !err; + return ok; } ''', c_name=3Dc_name(name)) --=20 2.26.2