OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

qapi: Detect collisions in C member names

Browse Source 
Detect attempts to declare two object members that would result
in the same C member name, by keying the 'seen' dictionary off
of the C name rather than the qapi name.  It also requires passing
info through the check_clash() methods.

This addresses a TODO and fixes the previously-broken
args-name-clash test.  The resulting error message demonstrates
the utility of the .describe() method added previously.  No change
to generated code.

Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <1447836791-369-17-git-send-email-eblake@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Eric Blake 2015-11-18 01:52:51 -07:00 committed by Markus Armbruster
parent 88d4ef8b5c
commit 27b60ab93b
5 changed files with 23 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
scripts/qapi.py
View File

@ -977,20 +977,23 @@ class QAPISchemaObjectType(QAPISchemaType):
self.base = schema.lookup_type(self._base_name)
assert isinstance(self.base, QAPISchemaObjectType)
self.base.check(schema)
self.base.check_clash(schema, seen)
self.base.check_clash(schema, self.info, seen)
for m in self.local_members:
m.check(schema)
m.check_clash(seen)
m.check_clash(self.info, seen)
self.members = seen.values()
if self.variants:
self.variants.check(schema, seen)
assert self.variants.tag_member in self.members
self.variants.check_clash(schema, seen)
self.variants.check_clash(schema, self.info, seen)
def check_clash(self, schema, seen):
# Check that the members of this type do not cause duplicate JSON fields,
# and update seen to track the members seen so far. Report any errors
# on behalf of info, which is not necessarily self.info
def check_clash(self, schema, info, seen):
assert not self.variants # not implemented
for m in self.members:
m.check_clash(seen)
m.check_clash(info, seen)
def is_implicit(self):
# See QAPISchema._make_implicit_object_type()
@ -1036,10 +1039,13 @@ class QAPISchemaObjectTypeMember(object):
self.type = schema.lookup_type(self._type_name)
assert self.type
def check_clash(self, seen):
# TODO change key of seen from QAPI name to C name
assert self.name not in seen
seen[self.name] = self
def check_clash(self, info, seen):
cname = c_name(self.name)
if cname in seen:
raise QAPIExprError(info,
"%s collides with %s"
% (self.describe(), seen[cname].describe()))
seen[cname] = self
def _pretty_owner(self):
owner = self.owner
@ -1080,7 +1086,8 @@ class QAPISchemaObjectTypeVariants(object):
def check(self, schema, seen):
if not self.tag_member: # flat union
self.tag_member = seen[self.tag_name]
self.tag_member = seen[c_name(self.tag_name)]
assert self.tag_name == self.tag_member.name
assert isinstance(self.tag_member.type, QAPISchemaEnumType)
for v in self.variants:
v.check(schema)
@ -1088,12 +1095,12 @@ class QAPISchemaObjectTypeVariants(object):
if isinstance(v.type, QAPISchemaObjectType):
v.type.check(schema)
def check_clash(self, schema, seen):
def check_clash(self, schema, info, seen):
for v in self.variants:
# Reset seen map for each variant, since qapi names from one
# branch do not affect another branch
assert isinstance(v.type, QAPISchemaObjectType)
v.type.check_clash(schema, dict(seen))
v.type.check_clash(schema, info, dict(seen))
class QAPISchemaObjectTypeVariant(QAPISchemaObjectTypeMember):

1
tests/qapi-schema/args-name-clash.err
View File

@ -0,0 +1 @@
tests/qapi-schema/args-name-clash.json:4: 'a_b' (parameter of oops) collides with 'a-b' (parameter of oops)

2
tests/qapi-schema/args-name-clash.exit
View File

@ -1 +1 @@
0
1

5
tests/qapi-schema/args-name-clash.json
View File

@ -1,5 +1,4 @@
# C member name collision
# FIXME - This parses, but fails to compile, because the C struct is given
# two 'a_b' members. Either reject this at parse time, or munge the C names
# to avoid the collision.
# Reject members that clash when mapped to C names (we would have two 'a_b'
# members).
{ 'command': 'oops', 'data': { 'a-b': 'str', 'a_b': 'str' } }

6
tests/qapi-schema/args-name-clash.out
View File

@ -1,6 +0,0 @@
object :empty
object :obj-oops-arg
member a-b: str optional=False
member a_b: str optional=False
command oops :obj-oops-arg -> None
gen=True success_response=True