Skip to contentSkip to conversation

qapi: Fix crash on redefinition with a different condition

PATCH In review Markus Armbruster 2 participants 2 messages Aug 6, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 qapi: Fix crash on redefinition with a different condition

QAPISchema._make_implicit_object_type() asserts that when an implicit object type is used multiple times, @ifcond is the same for all uses. It will be for legitimate uses, i.e. simple union branch wrapper types. A comment explains this.

The assertion fails when a command or event is redefined with a different condition. The redefinition is an error, but it's flagged only later.

Fixing the assertion would complicate matters further. Not worthwhile, drop it instead. We really need to get rid of simple unions.

Tweak test case redefined-event to cover redefinition with a different condition.

---
 scripts/qapi/schema.py                 | 22 +++++++++++-----------
 tests/qapi-schema/redefined-event.json |  2 +-
 2 files changed, 12 insertions(+), 12 deletions(-)
scripts/qapi/schema.py +11 -11
index d1d27ff7ee..a4ce3972a4 100644
@@ -997,18 +997,18 @@ def _make_implicit_object_type(self, name, info, ifcond, role, members):
         name = 'q_obj_%s-%s' % (name, role)
         typ = self.lookup_entity(name, QAPISchemaObjectType)
         if typ:
-            # The implicit object type has multiple users.  This can
-            # happen only for simple unions' implicit wrapper types.
-            # Its ifcond should be the disjunction of its user's
-            # ifconds.  Not implemented.  Instead, we always pass the
-            # wrapped type's ifcond, which is trivially the same for all
-            # users.  It's also necessary for the wrapper to compile.
-            # But it's not tight: the disjunction need not imply it.  We
-            # may end up compiling useless wrapper types.
+            # The implicit object type has multiple users.  This is
+            # either a duplicate definition (which will be flagged
+            # later), or an implicit wrapper type used for multiple
+            # simple unions.  In the latter case, ifcond should be the
+            # disjunction of its user's ifconds.  Not implemented.
+            # Instead, we always pass the wrapped type's ifcond, which
+            # is trivially the same for all users.  It's also
+            # necessary for the wrapper to compile.  But it's not
+            # tight: the disjunction need not imply it.  We may end up
+            # compiling useless wrapper types.
             # TODO kill simple unions or implement the disjunction
-
-            # pylint: disable=protected-access
-            assert (ifcond or []) == typ._ifcond
+            pass
         else:
             self._def_entity(QAPISchemaObjectType(
                 name, info, None, ifcond, None, None, members, None))
tests/qapi-schema/redefined-event.json +1 -1
index 7717e91c18..09eff18412 100644
@@ -1,3 +1,3 @@
 # we reject duplicate events
 { 'event': 'EVENT_A', 'data': { 'myint': 'int' } }
-{ 'event': 'EVENT_A', 'data': { 'myint': 'int' } }
+{ 'event': 'EVENT_A', 'data': { 'myint': 'int' }, 'if': 'defined(FOO)' }
Signature · 1 line
2.31.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 13 lines · Markus Armbruster

QAPISchema._make_implicit_object_type() asserts that when an implicit object type is used multiple times, @ifcond is the same for all uses. It will be for legitimate uses, i.e. simple union branch wrapper types. A comment explains this.

The assertion fails when a command or event is redefined with a different condition. The redefinition is an error, but it's flagged only later.

Fixing the assertion would complicate matters further. Not worthwhile, drop it instead. We really need to get rid of simple unions.

Quoted 5 lines

Tweak test case redefined-event to cover redefinition with a different condition.

---

6.2 material (this corner case doesn't fire in our 6.1 code base, and really only matters for developers adding new interfaces which won't happen in 6.1).

Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org