From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:43370) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XV6ca-0004T8-KT for qemu-devel@nongnu.org; Fri, 19 Sep 2014 18:25:53 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XV6cS-0004at-MS for qemu-devel@nongnu.org; Fri, 19 Sep 2014 18:25:44 -0400 Received: from mx1.redhat.com ([209.132.183.28]:35147) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XV6cS-0004Xc-Er for qemu-devel@nongnu.org; Fri, 19 Sep 2014 18:25:36 -0400 From: Eric Blake Date: Fri, 19 Sep 2014 16:24:59 -0600 Message-Id: <1411165504-18198-15-git-send-email-eblake@redhat.com> In-Reply-To: <1411165504-18198-1-git-send-email-eblake@redhat.com> References: <1411165504-18198-1-git-send-email-eblake@redhat.com> Subject: [Qemu-devel] [PATCH v4 14/19] qapi: More rigorous checking for type safety bypass List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: Luiz Capitulino , Fam Zheng , Markus Armbruster , wenchaoqemu@gmail.com Now that we have a way to validate every type, we can also be stricter about enforcing that callers that want to bypass type safety in generated code. Prior to this patch, it didn't matter what value was associated with the key 'gen', but it looked odd that 'gen':'yes' could result in bypassing the generated code. These changes also enforce the changes made earlier in the series for documentation and consolidation of using '**' as the wildcard type. Signed-off-by: Eric Blake --- scripts/qapi.py | 21 ++++++++++++++++----- tests/qapi-schema/type-bypass-bad-gen.err | 1 + tests/qapi-schema/type-bypass-bad-gen.exit | 2 +- tests/qapi-schema/type-bypass-bad-gen.json | 2 +- tests/qapi-schema/type-bypass-bad-gen.out | 3 --- tests/qapi-schema/type-bypass-no-gen.err | 1 + tests/qapi-schema/type-bypass-no-gen.exit | 2 +- tests/qapi-schema/type-bypass-no-gen.json | 2 +- tests/qapi-schema/type-bypass-no-gen.out | 3 --- 9 files changed, 22 insertions(+), 15 deletions(-) diff --git a/scripts/qapi.py b/scripts/qapi.py index 20c0ce9..15972c6 100644 --- a/scripts/qapi.py +++ b/scripts/qapi.py @@ -256,13 +256,13 @@ def discriminator_find_enum_define(expr): return find_enum(discriminator_type) def check_type(expr_info, source, data, allow_array = False, - allowed_names = [], allow_dict = True): + allowed_names = [], allow_dict = True, allow_star = False): global all_types if data is None: return - if data == '**': + if allow_star and data == '**': return # Check if array type for data is okay @@ -278,6 +278,10 @@ def check_type(expr_info, source, data, allow_array = False, # Check if type name for data is okay if isinstance(data, basestring): + if data == '**': + raise QAPIExprError(expr_info, + "%s uses '**' but did not request 'gen':'no'" + % source) if not data in all_types: raise QAPIExprError(expr_info, "%s references unknown type '%s'" @@ -299,24 +303,27 @@ def check_type(expr_info, source, data, allow_array = False, check_type(expr_info, "member '%s' of %s" % (key, source), value, allow_array=True, allowed_names=['built-in', 'union', 'struct', 'enum'], - allow_dict=True) + allow_dict=True, allow_star=allow_star) def check_command(expr, expr_info): global commands name = expr['command'] + allow_star = expr.has_key('gen') + if name in commands: raise QAPIExprError(expr_info, "command '%s' is already defined" % name) commands.append(name) check_type(expr_info, "'data' for command '%s'" % name, expr.get('data'), allow_array=True, - allowed_names=['union', 'struct']) + allowed_names=['union', 'struct'], allow_star=allow_star) check_type(expr_info, "'base' for command '%s'" % name, expr.get('base'), allowed_names=['struct'], allow_dict=False) check_type(expr_info, "'returns' for command '%s'" % name, expr.get('returns'), allow_array=True, - allowed_names=['built-in', 'union', 'struct', 'enum']) + allowed_names=['built-in', 'union', 'struct', 'enum'], + allow_star=allow_star) def check_event(expr, expr_info): global events @@ -450,6 +457,10 @@ def check_keys(expr_elem, meta, required, optional=[]): raise QAPIExprError(info, "%s '%s' has unknown key '%s'" % (meta, name, key)) + if (key == 'gen' or key == 'success-response') and value != 'no': + raise QAPIExprError(info, + "'%s' of %s '%s' should only have value 'no'" + % (key, meta, name)) for key in required: if not expr.has_key(key): raise QAPIExprError(info, diff --git a/tests/qapi-schema/type-bypass-bad-gen.err b/tests/qapi-schema/type-bypass-bad-gen.err index e69de29..c408364 100644 --- a/tests/qapi-schema/type-bypass-bad-gen.err +++ b/tests/qapi-schema/type-bypass-bad-gen.err @@ -0,0 +1 @@ +tests/qapi-schema/type-bypass-bad-gen.json:2: 'gen' of command 'foo' should only have value 'no' diff --git a/tests/qapi-schema/type-bypass-bad-gen.exit b/tests/qapi-schema/type-bypass-bad-gen.exit index 573541a..d00491f 100644 --- a/tests/qapi-schema/type-bypass-bad-gen.exit +++ b/tests/qapi-schema/type-bypass-bad-gen.exit @@ -1 +1 @@ -0 +1 diff --git a/tests/qapi-schema/type-bypass-bad-gen.json b/tests/qapi-schema/type-bypass-bad-gen.json index 6894526..5514b80 100644 --- a/tests/qapi-schema/type-bypass-bad-gen.json +++ b/tests/qapi-schema/type-bypass-bad-gen.json @@ -1,2 +1,2 @@ -# FIXME: 'gen' should only appear with value 'no' +# 'gen' should only appear with value 'no' { 'command': 'foo', 'gen': 'whatever' } diff --git a/tests/qapi-schema/type-bypass-bad-gen.out b/tests/qapi-schema/type-bypass-bad-gen.out index e678f2c..e69de29 100644 --- a/tests/qapi-schema/type-bypass-bad-gen.out +++ b/tests/qapi-schema/type-bypass-bad-gen.out @@ -1,3 +0,0 @@ -[OrderedDict([('command', 'foo'), ('gen', 'whatever')])] -[] -[] diff --git a/tests/qapi-schema/type-bypass-no-gen.err b/tests/qapi-schema/type-bypass-no-gen.err index e69de29..294ca2e 100644 --- a/tests/qapi-schema/type-bypass-no-gen.err +++ b/tests/qapi-schema/type-bypass-no-gen.err @@ -0,0 +1 @@ +tests/qapi-schema/type-bypass-no-gen.json:2: member 'arg' of 'data' for command 'unsafe' uses '**' but did not request 'gen':'no' diff --git a/tests/qapi-schema/type-bypass-no-gen.exit b/tests/qapi-schema/type-bypass-no-gen.exit index 573541a..d00491f 100644 --- a/tests/qapi-schema/type-bypass-no-gen.exit +++ b/tests/qapi-schema/type-bypass-no-gen.exit @@ -1 +1 @@ -0 +1 diff --git a/tests/qapi-schema/type-bypass-no-gen.json b/tests/qapi-schema/type-bypass-no-gen.json index 72c817f..49b5742 100644 --- a/tests/qapi-schema/type-bypass-no-gen.json +++ b/tests/qapi-schema/type-bypass-no-gen.json @@ -1,2 +1,2 @@ -# FIXME: type bypass should only work with 'gen':'no' +# type bypass only works with 'gen':'no' { 'command': 'unsafe', 'data': { 'arg': '**' }, 'returns': '**' } diff --git a/tests/qapi-schema/type-bypass-no-gen.out b/tests/qapi-schema/type-bypass-no-gen.out index 8b2a9ac..e69de29 100644 --- a/tests/qapi-schema/type-bypass-no-gen.out +++ b/tests/qapi-schema/type-bypass-no-gen.out @@ -1,3 +0,0 @@ -[OrderedDict([('command', 'unsafe'), ('data', OrderedDict([('arg', '**')])), ('returns', '**')])] -[] -[] -- 1.9.3