From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 87261C6FD1D for ; Fri, 17 Mar 2023 05:49:39 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pd2xb-0003wy-73; Fri, 17 Mar 2023 01:49:03 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pd2xZ-0003vb-1n for qemu-devel@nongnu.org; Fri, 17 Mar 2023 01:49:01 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pd2xW-0006nV-Pt for qemu-devel@nongnu.org; Fri, 17 Mar 2023 01:49:00 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1679032138; 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: in-reply-to:in-reply-to:references:references; bh=0jovglnzZ/VwWnse2OfIvdzY10swywDghH13p++4DKk=; b=HCLfTVHQhVGVuWLquzvq3YSTUAoJ9L1hwUI6Pa8YRe6ZKijZZNyjYQYdhuWNwwBFkoWz+q YqDwVMSroGIUDQQcPc6q4N8nTQHhGBhb1qLUoNY8oZIRXPr/cUSGDZrkj0FFSu/Wi4FCh8 nzrfAQ9L8F/duZJvP8gGQRPTYBcTQcg= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-201-E_MAtWNJOJuAM3u4qY4ajg-1; Fri, 17 Mar 2023 01:48:54 -0400 X-MC-Unique: E_MAtWNJOJuAM3u4qY4ajg-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 1FF82811E7B; Fri, 17 Mar 2023 05:48:54 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.52]) by smtp.corp.redhat.com (Postfix) with ESMTPS id F27FB6B590; Fri, 17 Mar 2023 05:48:53 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id E449921E681C; Fri, 17 Mar 2023 06:48:52 +0100 (CET) From: Markus Armbruster To: Eric Blake Cc: Markus Armbruster , qemu-devel@nongnu.org, michael.roth@amd.com, marcandre.lureau@redhat.com, berrange@redhat.com, jsnow@redhat.com Subject: Re: [PATCH 08/14] qapi: Fix to reject 'data': 'mumble' in struct References: <20230316071325.492471-1-armbru@redhat.com> <20230316071325.492471-9-armbru@redhat.com> <20230317010258.c3nlbx3og26prfu3@redhat.com> Date: Fri, 17 Mar 2023 06:48:52 +0100 In-Reply-To: <20230317010258.c3nlbx3og26prfu3@redhat.com> (Eric Blake's message of "Thu, 16 Mar 2023 20:02:58 -0500") Message-ID: <87ttyknd17.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.1 on 10.11.54.5 Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, 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=-0.001, 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.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Eric Blake writes: > On Thu, Mar 16, 2023 at 08:13:19AM +0100, Markus Armbruster wrote: >> A struct's 'data' must be a JSON object defining the struct's members. >> The QAPI code generator incorrectly accepts a JSON string instead, and >> then crashes in QAPISchema._make_members() called from >> ._def_struct_type(). >> >> Fix to reject it, and add a test case. > > Nice catch; I see why the split into three functions earlier on > foreshadowed some subtle bug fixes to come. > >> +++ b/scripts/qapi/expr.py >> @@ -354,14 +354,14 @@ def check_type_name_or_array(value: Optional[object], >> source) >> >> >> -def check_type_name_or_implicit(value: Optional[object], >> - info: QAPISourceInfo, source: str, >> - parent_name: Optional[str]) -> None: >> +def check_type_implicit(value: Optional[object], >> + info: QAPISourceInfo, source: str, >> + parent_name: Optional[str]) -> None: > > At first I thought this was a straight rename... > >> """ >> Normalize and validate an optional implicit struct type. >> >> - Accept ``None``, ``str``, or a ``dict`` defining an implicit >> - struct type. The latter is normalized in place. >> + Accept ``None`` or a ``dict`` defining an implicit struct type. >> + The latter is normalized in place. >> >> :param value: The value to check. >> :param info: QAPI schema source file information. >> @@ -377,9 +377,6 @@ def check_type_name_or_implicit(value: Optional[object], >> if value is None: >> return >> >> - if isinstance(value, str): >> - return >> - >> if not isinstance(value, dict): >> raise QAPISemError(info, >> "%s should be an object or type name" % source) >> @@ -401,6 +398,15 @@ def check_type_name_or_implicit(value: Optional[object], >> check_type_name_or_array(arg['type'], info, key_source) >> >> >> +def check_type_name_or_implicit(value: Optional[object], >> + info: QAPISourceInfo, source: str, >> + parent_name: Optional[str]) -> None: >> + if value is None or isinstance(value, str): > > ...until I got here and saw that you kept the original name, and added > a new helper. Worth calling out the new function name > check_type_implicit() in the commit message? It would have spared me > a minute. Can do. > As earlier, you lost the doc comment. I'll leave it to your > discretion if it is important to copy one back in. I didn't duplicate the doc string, which means it moves from check_type_name_or_implicit() to check_type_implicit(), where the actual meat is. John, you added the doc string in commit a48653638fa (qapi/expr.py: Add docstrings). Do you have an opinion? >> + return >> + >> + check_type_implicit(value, info, source, parent_name) >> + >> + >> def check_features(features: Optional[object], >> info: QAPISourceInfo) -> None: >> """ >> @@ -486,7 +492,7 @@ def check_struct(expr: QAPIExpression) -> None: >> name = cast(str, expr['struct']) # Checked in check_exprs >> members = expr['data'] >> >> - check_type_name_or_implicit(members, expr.info, "'data'", name) >> + check_type_implicit(members, expr.info, "'data'", name) >> check_type_name(expr.get('base'), expr.info, "'base'") >> > > Reviewed-by: Eric Blake Thanks!