]> Git Repo - qemu.git/commitdiff
qapi: Use 'alternate' to replace anonymous union
authorEric Blake <[email protected]>
Mon, 4 May 2015 15:05:13 +0000 (09:05 -0600)
committerMarkus Armbruster <[email protected]>
Tue, 5 May 2015 16:39:00 +0000 (18:39 +0200)
Previous patches have led up to the point where I create the
new meta-type "'alternate':'Foo'".  See the previous patches
for documentation; I intentionally split as much work into
earlier patches to minimize the size of this patch, but a lot
of it is churn due to testsuite fallout after updating to the
new type.

Signed-off-by: Eric Blake <[email protected]>
Reviewed-by: Markus Armbruster <[email protected]>
Signed-off-by: Markus Armbruster <[email protected]>
24 files changed:
qapi/block-core.json
scripts/qapi-types.py
scripts/qapi-visit.py
scripts/qapi.py
tests/qapi-schema/alternate-array.err
tests/qapi-schema/alternate-array.json
tests/qapi-schema/alternate-base.err
tests/qapi-schema/alternate-base.json
tests/qapi-schema/alternate-clash.err
tests/qapi-schema/alternate-clash.json
tests/qapi-schema/alternate-conflict-dict.err
tests/qapi-schema/alternate-conflict-dict.json
tests/qapi-schema/alternate-conflict-string.err
tests/qapi-schema/alternate-conflict-string.json
tests/qapi-schema/alternate-good.json
tests/qapi-schema/alternate-good.out
tests/qapi-schema/alternate-nested.err
tests/qapi-schema/alternate-nested.json
tests/qapi-schema/alternate-unknown.err
tests/qapi-schema/alternate-unknown.json
tests/qapi-schema/flat-union-bad-discriminator.err
tests/qapi-schema/flat-union-bad-discriminator.json
tests/qapi-schema/qapi-schema-test.json
tests/qapi-schema/qapi-schema-test.out

index 1c17224c77211b76e19d4664a95ce91f8773325f..3d20e61deef35ffc4228ca1ad8eeaf26cc673e3e 100644 (file)
 #
 # Since: 2.2
 ##
-{ 'union': 'Qcow2OverlapChecks',
-  'discriminator': {},
+{ 'alternate': 'Qcow2OverlapChecks',
   'data': { 'flags': 'Qcow2OverlapCheckFlags',
             'mode':  'Qcow2OverlapCheckMode' } }
 
 #
 # Since: 1.7
 ##
-{ 'union': 'BlockdevRef',
-  'discriminator': {},
+{ 'alternate': 'BlockdevRef',
   'data': { 'definition': 'BlockdevOptions',
             'reference': 'str' } }
 
index c9e0201d10a406e5c1df46c165d49c125d1c3b74..9c8d68cfb4aac5769dda650bbc0266148c92c194 100644 (file)
@@ -172,7 +172,7 @@ typedef enum %(name)s
 
 def generate_alternate_qtypes(expr):
 
-    name = expr['union']
+    name = expr['alternate']
     members = expr['data']
 
     ret = mcgen('''
@@ -182,7 +182,7 @@ const int %(name)s_qtypes[QTYPE_MAX] = {
 
     for key in members:
         qtype = find_alternate_member_qtype(members[key])
-        assert qtype, "Invalid anonymous union member"
+        assert qtype, "Invalid alternate member"
 
         ret += mcgen('''
     [ %(qtype)s ] = %(abbrev)s_KIND_%(enum)s,
@@ -197,9 +197,9 @@ const int %(name)s_qtypes[QTYPE_MAX] = {
     return ret
 
 
-def generate_union(expr):
+def generate_union(expr, meta):
 
-    name = expr['union']
+    name = expr[meta]
     typeinfo = expr['data']
 
     base = expr.get('base')
@@ -243,7 +243,7 @@ struct %(name)s
     ret += mcgen('''
 };
 ''')
-    if discriminator == {}:
+    if meta == 'alternate':
         ret += mcgen('''
 extern const int %(name)s_qtypes[];
 ''',
@@ -407,8 +407,12 @@ for expr in exprs:
             ret += generate_enum('%sKind' % expr['union'], expr['data'].keys())
             fdef.write(generate_enum_lookup('%sKind' % expr['union'],
                                             expr['data'].keys()))
-        if expr.get('discriminator') == {}:
-            fdef.write(generate_alternate_qtypes(expr))
+    elif expr.has_key('alternate'):
+        ret += generate_fwd_struct(expr['alternate'], expr['data']) + "\n"
+        ret += generate_enum('%sKind' % expr['alternate'], expr['data'].keys())
+        fdef.write(generate_enum_lookup('%sKind' % expr['alternate'],
+                                        expr['data'].keys()))
+        fdef.write(generate_alternate_qtypes(expr))
     else:
         continue
     fdecl.write(ret)
@@ -438,11 +442,17 @@ for expr in exprs:
         ret += generate_type_cleanup_decl(expr['type'])
         fdef.write(generate_type_cleanup(expr['type']) + "\n")
     elif expr.has_key('union'):
-        ret += generate_union(expr)
+        ret += generate_union(expr, 'union')
         ret += generate_type_cleanup_decl(expr['union'] + "List")
         fdef.write(generate_type_cleanup(expr['union'] + "List") + "\n")
         ret += generate_type_cleanup_decl(expr['union'])
         fdef.write(generate_type_cleanup(expr['union']) + "\n")
+    elif expr.has_key('alternate'):
+        ret += generate_union(expr, 'alternate')
+        ret += generate_type_cleanup_decl(expr['alternate'] + "List")
+        fdef.write(generate_type_cleanup(expr['alternate'] + "List") + "\n")
+        ret += generate_type_cleanup_decl(expr['alternate'])
+        fdef.write(generate_type_cleanup(expr['alternate']) + "\n")
     elif expr.has_key('enum'):
         ret += generate_type_cleanup_decl(expr['enum'] + "List")
         fdef.write(generate_type_cleanup(expr['enum'] + "List") + "\n")
index 6bd2b6bfab82ce32d6c1b4be08b1abb955533fce..9222671ff824bc8365be2cc789bc49b2ccd4715c 100644 (file)
@@ -256,7 +256,7 @@ void visit_type_%(name)s(Visitor *m, %(name)s **obj, const char *name, Error **e
 ''',
     name=name)
 
-    # For anon union, always use the default enum type automatically generated
+    # For alternate, always use the default enum type automatically generated
     # as "'%sKind' % (name)"
     disc_type = '%sKind' % (name)
 
@@ -264,7 +264,7 @@ void visit_type_%(name)s(Visitor *m, %(name)s **obj, const char *name, Error **e
         assert (members[key] in builtin_types.keys()
             or find_struct(members[key])
             or find_union(members[key])
-            or find_enum(members[key])), "Invalid anonymous union member"
+            or find_enum(members[key])), "Invalid alternate member"
 
         enum_full_value = generate_enum_full_value(disc_type, key)
         ret += mcgen('''
@@ -300,10 +300,6 @@ def generate_visit_union(expr):
     base = expr.get('base')
     discriminator = expr.get('discriminator')
 
-    if discriminator == {}:
-        assert not base
-        return generate_visit_alternate(name, members)
-
     enum_define = discriminator_find_enum_define(expr)
     if enum_define:
         # Use the enum type as discriminator
@@ -568,6 +564,15 @@ for expr in exprs:
                                      expr['data'].keys())
         ret += generate_declaration(expr['union'], expr['data'])
         fdecl.write(ret)
+    elif expr.has_key('alternate'):
+        ret = generate_visit_alternate(expr['alternate'], expr['data'])
+        ret += generate_visit_list(expr['alternate'], expr['data'])
+        fdef.write(ret)
+
+        ret = generate_decl_enum('%sKind' % expr['alternate'],
+                                 expr['data'].keys())
+        ret += generate_declaration(expr['alternate'], expr['data'])
+        fdecl.write(ret)
     elif expr.has_key('enum'):
         ret = generate_visit_list(expr['enum'], expr['data'])
         ret += generate_visit_enum(expr['enum'], expr['data'])
index 0b88325abd21d34bc992c5ee6d83eeeefbdad7e4..05c38c5b00e879118e7b63177abf9eed080d9520 100644 (file)
@@ -281,7 +281,6 @@ def check_union(expr, expr_info):
                                 "along with base" %name)
 
     # Two types of unions, determined by discriminator.
-    assert discriminator != {}
 
     # With no discriminator it is a simple union.
     if discriminator is None:
@@ -344,17 +343,14 @@ def check_union(expr, expr_info):
             values[c_key] = key
 
 def check_alternate(expr, expr_info):
-    name = expr['union']
-    base = expr.get('base')
-    discriminator = expr.get('discriminator')
+    name = expr['alternate']
     members = expr['data']
     values = { 'MAX': '(automatic)' }
     types_seen = {}
 
-    assert discriminator == {}
-    if base is not None:
+    if expr.get('base') is not None:
         raise QAPIExprError(expr_info,
-                            "Anonymous union '%s' must not have a base"
+                            "Alternate '%s' must not have a base"
                             % name)
 
     # Check every branch
@@ -363,23 +359,23 @@ def check_alternate(expr, expr_info):
         c_key = _generate_enum_string(key)
         if c_key in values:
             raise QAPIExprError(expr_info,
-                                "Anonymous union '%s' member '%s' clashes "
-                                "with '%s'" % (name, key, values[c_key]))
+                                "Alternate '%s' member '%s' clashes with '%s'"
+                                % (name, key, values[c_key]))
         values[c_key] = key
 
         # Ensure alternates have no type conflicts.
         if isinstance(value, list):
             raise QAPIExprError(expr_info,
-                                "Anonymous union '%s' member '%s' must "
+                                "Alternate '%s' member '%s' must "
                                 "not be array type" % (name, key))
         qtype = find_alternate_member_qtype(value)
         if not qtype:
             raise QAPIExprError(expr_info,
-                                "Anonymous union '%s' member '%s' has "
+                                "Alternate '%s' member '%s' has "
                                 "invalid type '%s'" % (name, key, value))
         if qtype in types_seen:
             raise QAPIExprError(expr_info,
-                                "Anonymous union '%s' member '%s' can't "
+                                "Alternate '%s' member '%s' can't "
                                 "be distinguished from member '%s'"
                                 % (name, key, types_seen[qtype]))
         types_seen[qtype] = key
@@ -412,10 +408,9 @@ def check_exprs(schema):
         if expr.has_key('enum'):
             check_enum(expr, info)
         elif expr.has_key('union'):
-            if expr.get('discriminator') == {}:
-                check_alternate(expr, info)
-            else:
-                check_union(expr, info)
+            check_union(expr, info)
+        elif expr.has_key('alternate'):
+            check_alternate(expr, info)
         elif expr.has_key('event'):
             check_event(expr, info)
 
@@ -447,6 +442,8 @@ def parse_schema(input_file):
             if expr.has_key('union'):
                 if not discriminator_find_enum_define(expr):
                     add_enum('%sKind' % expr['union'])
+            elif expr.has_key('alternate'):
+                add_enum('%sKind' % expr['alternate'])
 
         # Final pass - validate that exprs make sense
         check_exprs(schema)
@@ -557,8 +554,7 @@ def find_struct(name):
 
 def add_union(definition):
     global union_types
-    if definition.get('discriminator') != {}:
-        union_types.append(definition)
+    union_types.append(definition)
 
 def find_union(name):
     global union_types
index 8d6ccc7325c961b26e91f403688acb14948949af..e2a5fc29bf28ff0476de35f43a9be8dee079284c 100644 (file)
@@ -1 +1 @@
-tests/qapi-schema/alternate-array.json:5: Anonymous union 'MyUnion' member 'two' must not be array type
+tests/qapi-schema/alternate-array.json:5: Alternate 'Alt' member 'two' must not be array type
index 0da1a641b37cbe903ea6516898c4cedf025259d9..fc0632f12887e4382e4bb673cba8bff5ebd55011 100644 (file)
@@ -1,8 +1,7 @@
-# we do not allow array branches in anonymous unions
+# we do not allow array branches in alternates
 # TODO: should we support this?
 { 'type': 'One',
   'data': { 'name': 'str' } }
-{ 'union': 'MyUnion',
-  'discriminator': {},
+{ 'alternate': 'Alt',
   'data': { 'one': 'One',
             'two': [ 'int' ] } }
index a2486b8407d1319695529a3412b3a82466313ccf..4a2566eed3f303ef5d05acf99dc85c07c8e58db6 100644 (file)
@@ -1 +1 @@
-tests/qapi-schema/alternate-base.json:4: Anonymous union 'MyUnion' must not have a base
+tests/qapi-schema/alternate-base.json:4: Alternate 'Alt' must not have a base
index dad7f029981b46c835b6eae1eb8439f4f3f15fab..66edc89640d2319622ed5de97f2d2a078c29c0be 100644 (file)
@@ -1,7 +1,6 @@
-# we reject anonymous union with base type
+# we reject alternate with base type
 { 'type': 'Base',
   'data': { 'string': 'str' } }
-{ 'union': 'MyUnion',
+{ 'alternate': 'Alt',
   'base': 'Base',
-  'discriminator': {},
   'data': { 'number': 'int' } }
index 8949f52b3e54337aaf93fb3c47d0e0e71a7def77..51bea3e2724ddfd14fe8bdd4fdeef94c72fc1c2f 100644 (file)
@@ -1 +1 @@
-tests/qapi-schema/alternate-clash.json:2: Anonymous union 'Union1' member 'ONE' clashes with 'one'
+tests/qapi-schema/alternate-clash.json:2: Alternate 'Alt1' member 'ONE' clashes with 'one'
index fa2d27ed5e7b51a09b6d0c916b389cd634216313..39479353bb1a53301734cf6476c62bca2fa286c4 100644 (file)
@@ -1,4 +1,3 @@
-# we detect C enum collisions in an anonymous union
-{ 'union': 'Union1',
-  'discriminator': {},
+# we detect C enum collisions in an alternate
+{ 'alternate': 'Alt1',
   'data': { 'one': 'str', 'ONE': 'int' } }
index 2d4550c5654ba389b9b16c60416cb94c227cfda9..0f411f4faf5c2c3c8b62c2c83a268b094265b829 100644 (file)
@@ -1 +1 @@
-tests/qapi-schema/alternate-conflict-dict.json:6: Anonymous union 'MyUnion' member 'two' can't be distinguished from member 'one'
+tests/qapi-schema/alternate-conflict-dict.json:6: Alternate 'Alt' member 'two' can't be distinguished from member 'one'
index ded302edae19733b72bca566b56d9fbf460b79cd..fcb3e36cd9b17d5e25c3164211b10b7a415c5210 100644 (file)
@@ -1,9 +1,8 @@
-# we reject anonymous unions with multiple object branches
+# we reject alternates with multiple object branches
 { 'type': 'One',
   'data': { 'name': 'str' } }
 { 'type': 'Two',
   'data': { 'value': 'int' } }
-{ 'union': 'MyUnion',
-  'discriminator': {},
+{ 'alternate': 'Alt',
   'data': { 'one': 'One',
             'two': 'Two' } }
index 271ddcdec8abaa5ec70ac7cd804e7dbeef817ac2..fc523b087903ec1cda14b3e43e8fcbac2b4fda0f 100644 (file)
@@ -1 +1 @@
-tests/qapi-schema/alternate-conflict-string.json:4: Anonymous union 'MyUnion' member 'two' can't be distinguished from member 'one'
+tests/qapi-schema/alternate-conflict-string.json:4: Alternate 'Alt' member 'two' can't be distinguished from member 'one'
index 3834a3ddfe1ea992f9bd829eb0ab82f359fd7252..72f04a820a9d281b7c5ec25c6c3e7a00c9b0fd95 100644 (file)
@@ -1,7 +1,6 @@
-# we reject anonymous unions with multiple string-like branches
+# we reject alternates with multiple string-like branches
 { 'enum': 'Enum',
   'data': [ 'hello', 'world' ] }
-{ 'union': 'MyUnion',
-  'discriminator': {},
+{ 'alternate': 'Alt',
   'data': { 'one': 'str',
             'two': 'Enum' } }
index 73d0993b39f1a1a166cda2215fff12e77d45d51d..99d614f138d6bf024452eab81274bdce2963a30f 100644 (file)
@@ -1,10 +1,9 @@
-# Working example of anonymous union
+# Working example of alternate
 { 'type': 'Data',
   'data': { '*number': 'int', '*name': 'str' } }
 { 'enum': 'Enum',
   'data': [ 'hello', 'world' ] }
-{ 'union': 'MyUnion',
-  'discriminator': {},
+{ 'alternate': 'Alt',
   'data': { 'value': 'int',
             'string': 'Enum',
             'struct': 'Data' } }
index b5117d1ab288da0ab6bd9fddb9419eff6fa1d84d..c3a6b7723c5d09487ebdf92a5e9ea1782b343cdd 100644 (file)
@@ -1,6 +1,6 @@
 [OrderedDict([('type', 'Data'), ('data', OrderedDict([('*number', 'int'), ('*name', 'str')]))]),
  OrderedDict([('enum', 'Enum'), ('data', ['hello', 'world'])]),
- OrderedDict([('union', 'MyUnion'), ('discriminator', OrderedDict()), ('data', OrderedDict([('value', 'int'), ('string', 'Enum'), ('struct', 'Data')]))])]
+ OrderedDict([('alternate', 'Alt'), ('data', OrderedDict([('value', 'int'), ('string', 'Enum'), ('struct', 'Data')]))])]
 [{'enum_name': 'Enum', 'enum_values': ['hello', 'world']},
- {'enum_name': 'MyUnionKind', 'enum_values': None}]
+ {'enum_name': 'AltKind', 'enum_values': None}]
 [OrderedDict([('type', 'Data'), ('data', OrderedDict([('*number', 'int'), ('*name', 'str')]))])]
index 59df96e1329b055cad4c26ec31564ef4550b8d29..00b05c601ec8cfbc2dd5873354e7359f0b8ca9b5 100644 (file)
@@ -1 +1 @@
-tests/qapi-schema/alternate-nested.json:5: Anonymous union 'Union2' member 'nested' has invalid type 'Union1'
+tests/qapi-schema/alternate-nested.json:4: Alternate 'Alt2' member 'nested' has invalid type 'Alt1'
index ed2b6b70550099f355300a59db23e415a153b638..c4233b9f333325f75218accabe971d408622e47a 100644 (file)
@@ -1,7 +1,5 @@
-# we reject a nested anonymous union branch
-{ 'union': 'Union1',
-  'discriminator': {},
+# we reject a nested alternate branch
+{ 'alternate': 'Alt1',
   'data': { 'name': 'str', 'value': 'int' } }
-{ 'union': 'Union2',
-  'discriminator': {},
-  'data': { 'nested': 'Union1' } }
+{ 'alternate': 'Alt2',
+  'data': { 'nested': 'Alt1' } }
index bf8e9aef6483b6caba83439e17569b80a73a93d1..7af1b4c5693b8805b88b6ad85893de6e00b037fa 100644 (file)
@@ -1 +1 @@
-tests/qapi-schema/alternate-unknown.json:2: Anonymous union 'Union' member 'unknown' has invalid type 'MissingType'
+tests/qapi-schema/alternate-unknown.json:2: Alternate 'Alt' member 'unknown' has invalid type 'MissingType'
index 0c305c282c686683010c515e1f0afa565e91c8be..ad5c1030286336de436a74d50e5e760b9fc1fac6 100644 (file)
@@ -1,4 +1,3 @@
-# we reject an anonymous union with unknown type in branch
-{ 'union': 'Union',
-  'discriminator': {},
+# we reject an alternate with unknown type in branch
+{ 'alternate': 'Alt',
   'data': { 'unknown': 'MissingType' } }
index 1661c52b03fb8732b07d5566aa91eebfaaa7a26a..507e2bab4a1fe4cb3d4385df4b470cc424717bb1 100644 (file)
@@ -1 +1 @@
-tests/qapi-schema/flat-union-bad-discriminator.json:10: Flat union 'TestUnion' discriminator must be a string
+tests/qapi-schema/flat-union-bad-discriminator.json:11: Flat union 'TestUnion' discriminator must be a string
index 3ce43e8356c19cb8cd1486a39f65c496efdfbef7..982f072555c4546647df9ff495deffa6be4e32fc 100644 (file)
@@ -1,4 +1,5 @@
 # we require the discriminator to be a string naming a base-type member
+# this tests the old syntax for anonymous unions before we added alternates
 { 'enum': 'TestEnum',
   'data': [ 'value1', 'value2' ] }
 { 'type': 'TestBase',
@@ -9,6 +10,6 @@
   'data': { 'integer': 'int' } }
 { 'union': 'TestUnion',
   'base': 'TestBase',
-  'discriminator': [],
+  'discriminator': {},
   'data': { 'kind1': 'TestTypeA',
             'kind2': 'TestTypeB' } }
index e1d35e1248d83226c01b667a372ab994b08196b3..dec8a7c108e6c2e5708c50a79fe869d09a63221a 100644 (file)
@@ -53,8 +53,7 @@
   'discriminator': 'enum1',
   'data': { 'value1' : 'UserDefC', 'value2' : 'UserDefB', 'value3' : 'UserDefA' } }
 
-{ 'union': 'UserDefAlternate',
-  'discriminator': {},
+{ 'alternate': 'UserDefAlternate',
   'data': { 'uda': 'UserDefA', 's': 'str', 'i': 'int' } }
 
 # for testing native lists
index b55ab8de10f88e80070709b232bccdd90969d276..313ecf3ad38829a0544b9d8156611be4ec2a20c1 100644 (file)
@@ -10,7 +10,7 @@
  OrderedDict([('type', 'UserDefUnionBase'), ('data', OrderedDict([('string', 'str'), ('enum1', 'EnumOne')]))]),
  OrderedDict([('union', 'UserDefFlatUnion'), ('base', 'UserDefUnionBase'), ('discriminator', 'enum1'), ('data', OrderedDict([('value1', 'UserDefA'), ('value2', 'UserDefB'), ('value3', 'UserDefB')]))]),
  OrderedDict([('union', 'UserDefFlatUnion2'), ('base', 'UserDefUnionBase'), ('discriminator', 'enum1'), ('data', OrderedDict([('value1', 'UserDefC'), ('value2', 'UserDefB'), ('value3', 'UserDefA')]))]),
- OrderedDict([('union', 'UserDefAlternate'), ('discriminator', OrderedDict()), ('data', OrderedDict([('uda', 'UserDefA'), ('s', 'str'), ('i', 'int')]))]),
+ OrderedDict([('alternate', 'UserDefAlternate'), ('data', OrderedDict([('uda', 'UserDefA'), ('s', 'str'), ('i', 'int')]))]),
  OrderedDict([('union', 'UserDefNativeListUnion'), ('data', OrderedDict([('integer', ['int']), ('s8', ['int8']), ('s16', ['int16']), ('s32', ['int32']), ('s64', ['int64']), ('u8', ['uint8']), ('u16', ['uint16']), ('u32', ['uint32']), ('u64', ['uint64']), ('number', ['number']), ('boolean', ['bool']), ('string', ['str']), ('sizes', ['size'])]))]),
  OrderedDict([('command', 'user_def_cmd'), ('data', OrderedDict())]),
  OrderedDict([('command', 'user_def_cmd1'), ('data', OrderedDict([('ud1a', 'UserDefOne')]))]),
This page took 0.059142 seconds and 4 git commands to generate.