14f193e34SMarkus Armbruster# *-*- Mode: Python -*-* 24f193e34SMarkus Armbruster 3625b251cSEric Blake# This file is a stress test of supported qapi constructs that must 4625b251cSEric Blake# parse and compile correctly. 5625b251cSEric Blake 61554a8faSMarkus Armbruster# Whitelists to permit QAPI rule violations 71554a8faSMarkus Armbruster{ 'pragma': { 81554a8faSMarkus Armbruster # Commands allowed to return a non-dictionary: 91554a8faSMarkus Armbruster 'returns-whitelist': [ 101554a8faSMarkus Armbruster 'guest-get-time', 111554a8faSMarkus Armbruster 'guest-sync' ] } } 121554a8faSMarkus Armbruster 13748053c9SEric Blake{ 'struct': 'TestStruct', 14748053c9SEric Blake 'data': { 'integer': 'int', 'boolean': 'bool', 'string': 'str' } } 15748053c9SEric Blake 164f193e34SMarkus Armbruster# for testing enums 17895a2a80SEric Blake{ 'struct': 'NestedEnumsOne', 1870478cefSEric Blake 'data': { 'enum1': 'EnumOne', # Intentional forward reference 1970478cefSEric Blake '*enum2': 'EnumOne', 'enum3': 'EnumOne', '*enum4': 'EnumOne' } } 204f193e34SMarkus Armbruster 21625b251cSEric Blake# An empty enum, although unusual, is currently acceptable 22625b251cSEric Blake{ 'enum': 'MyEnum', 'data': [ ] } 23625b251cSEric Blake 2419767083SEric Blake# Likewise for an empty struct, including an empty base 2519767083SEric Blake{ 'struct': 'Empty1', 'data': { } } 2619767083SEric Blake{ 'struct': 'Empty2', 'base': 'Empty1', 'data': { } } 2719767083SEric Blake 28972a1101SEric Blake{ 'command': 'user_def_cmd0', 'data': 'Empty2', 'returns': 'Empty2' } 29972a1101SEric Blake 30351d36e4SDaniel P. Berrange# for testing override of default naming heuristic 31351d36e4SDaniel P. Berrange{ 'enum': 'QEnumTwo', 32351d36e4SDaniel P. Berrange 'prefix': 'QENUM_TWO', 33351d36e4SDaniel P. Berrange 'data': [ 'value1', 'value2' ] } 34351d36e4SDaniel P. Berrange 354f193e34SMarkus Armbruster# for testing nested structs 368c3f8e77SMarkus Armbruster{ 'struct': 'UserDefOne', 378c3f8e77SMarkus Armbruster 'base': 'UserDefZero', # intentional forward reference 3870478cefSEric Blake 'data': { 'string': 'str', 3970478cefSEric Blake '*enum1': 'EnumOne' } } # intentional forward reference 4070478cefSEric Blake 4170478cefSEric Blake{ 'enum': 'EnumOne', 4270478cefSEric Blake 'data': [ 'value1', 'value2', 'value3' ] } 438c3f8e77SMarkus Armbruster 44895a2a80SEric Blake{ 'struct': 'UserDefZero', 45aabbd472SMarkus Armbruster 'data': { 'integer': 'int' } } 46aabbd472SMarkus Armbruster 476446a592SEric Blake{ 'struct': 'UserDefTwoDictDict', 486446a592SEric Blake 'data': { 'userdef': 'UserDefOne', 'string': 'str' } } 496446a592SEric Blake 506446a592SEric Blake{ 'struct': 'UserDefTwoDict', 516446a592SEric Blake 'data': { 'string1': 'str', 526446a592SEric Blake 'dict2': 'UserDefTwoDictDict', 536446a592SEric Blake '*dict3': 'UserDefTwoDictDict' } } 546446a592SEric Blake 55895a2a80SEric Blake{ 'struct': 'UserDefTwo', 564f193e34SMarkus Armbruster 'data': { 'string0': 'str', 576446a592SEric Blake 'dict1': 'UserDefTwoDict' } } 584f193e34SMarkus Armbruster 599f08c8ecSEric Blake# dummy struct to force generation of array types not otherwise mentioned 609f08c8ecSEric Blake{ 'struct': 'ForceArrays', 61748053c9SEric Blake 'data': { 'unused1':['UserDefOne'], 'unused2':['UserDefTwo'], 62748053c9SEric Blake 'unused3':['TestStruct'] } } 639f08c8ecSEric Blake 644f193e34SMarkus Armbruster# for testing unions 65d220fbcdSEric Blake# Among other things, test that a name collision between branches does 66d220fbcdSEric Blake# not cause any problems (since only one branch can be in use at a time), 67d220fbcdSEric Blake# by intentionally using two branches that both have a C member 'a_b' 68895a2a80SEric Blake{ 'struct': 'UserDefA', 69d220fbcdSEric Blake 'data': { 'boolean': 'bool', '*a_b': 'int' } } 704f193e34SMarkus Armbruster 71895a2a80SEric Blake{ 'struct': 'UserDefB', 72d220fbcdSEric Blake 'data': { 'intb': 'int', '*a-b': 'bool' } } 734f193e34SMarkus Armbruster 748c3f8e77SMarkus Armbruster{ 'union': 'UserDefFlatUnion', 758c3f8e77SMarkus Armbruster 'base': 'UserDefUnionBase', # intentional forward reference 768c3f8e77SMarkus Armbruster 'discriminator': 'enum1', 778c3f8e77SMarkus Armbruster 'data': { 'value1' : 'UserDefA', 788c3f8e77SMarkus Armbruster 'value2' : 'UserDefB', 798c3f8e77SMarkus Armbruster 'value3' : 'UserDefB' } } 80cb55111bSMichael Roth 81895a2a80SEric Blake{ 'struct': 'UserDefUnionBase', 8280e60a19SMarkus Armbruster 'base': 'UserDefZero', 835223070cSWenchao Xia 'data': { 'string': 'str', 'enum1': 'EnumOne' } } 845223070cSWenchao Xia 8514f00c6cSEric Blake# this variant of UserDefFlatUnion defaults to a union that uses members with 86cb55111bSMichael Roth# allocated types to test corner cases in the cleanup/dealloc visitor 87cb55111bSMichael Roth{ 'union': 'UserDefFlatUnion2', 88ac4338f8SEric Blake 'base': { '*integer': 'int', 'string': 'str', 'enum1': 'QEnumTwo' }, 89cb55111bSMichael Roth 'discriminator': 'enum1', 908c3f8e77SMarkus Armbruster 'data': { 'value1' : 'UserDefC', # intentional forward reference 919d3524b3SEric Blake 'value2' : 'UserDefB' } } 92cb55111bSMichael Roth 9368d07839SEric Blake{ 'struct': 'WrapAlternate', 9468d07839SEric Blake 'data': { 'alt': 'UserDefAlternate' } } 95ab916fadSEric Blake{ 'alternate': 'UserDefAlternate', 96*4d2d5c41SMarkus Armbruster 'data': { 'udfu': 'UserDefFlatUnion', 'e': 'EnumOne', 'i': 'int', 97*4d2d5c41SMarkus Armbruster 'n': 'null' } } 982c38b600SMarkus Armbruster 998c3f8e77SMarkus Armbruster{ 'struct': 'UserDefC', 1008c3f8e77SMarkus Armbruster 'data': { 'string1': 'str', 'string2': 'str' } } 1018c3f8e77SMarkus Armbruster 1029c51b441SEric Blake# for testing use of 'number' within alternates 1038168ca8eSMarkus Armbruster{ 'alternate': 'AltEnumBool', 'data': { 'e': 'EnumOne', 'b': 'bool' } } 1048168ca8eSMarkus Armbruster{ 'alternate': 'AltEnumNum', 'data': { 'e': 'EnumOne', 'n': 'number' } } 1058168ca8eSMarkus Armbruster{ 'alternate': 'AltNumEnum', 'data': { 'n': 'number', 'e': 'EnumOne' } } 1068168ca8eSMarkus Armbruster{ 'alternate': 'AltEnumInt', 'data': { 'e': 'EnumOne', 'i': 'int' } } 1079c51b441SEric Blake 108c0644771SMarkus Armbruster# for testing use of 'str' within alternates 109c0644771SMarkus Armbruster{ 'alternate': 'AltStrObj', 'data': { 's': 'str', 'o': 'TestStruct' } } 110c0644771SMarkus Armbruster 1114f193e34SMarkus Armbruster# for testing native lists 1124f193e34SMarkus Armbruster{ 'union': 'UserDefNativeListUnion', 1134f193e34SMarkus Armbruster 'data': { 'integer': ['int'], 1144f193e34SMarkus Armbruster 's8': ['int8'], 1154f193e34SMarkus Armbruster 's16': ['int16'], 1164f193e34SMarkus Armbruster 's32': ['int32'], 1174f193e34SMarkus Armbruster 's64': ['int64'], 1184f193e34SMarkus Armbruster 'u8': ['uint8'], 1194f193e34SMarkus Armbruster 'u16': ['uint16'], 1204f193e34SMarkus Armbruster 'u32': ['uint32'], 1214f193e34SMarkus Armbruster 'u64': ['uint64'], 1224f193e34SMarkus Armbruster 'number': ['number'], 1234f193e34SMarkus Armbruster 'boolean': ['bool'], 124cb17f79eSEric Blake 'string': ['str'], 12528770e05SMarkus Armbruster 'sizes': ['size'], 12628770e05SMarkus Armbruster 'any': ['any'] } } 1274f193e34SMarkus Armbruster 1284f193e34SMarkus Armbruster# testing commands 1294f193e34SMarkus Armbruster{ 'command': 'user_def_cmd', 'data': {} } 1304f193e34SMarkus Armbruster{ 'command': 'user_def_cmd1', 'data': {'ud1a': 'UserDefOne'} } 131ab22ad96SMarkus Armbruster{ 'command': 'user_def_cmd2', 132ab22ad96SMarkus Armbruster 'data': {'ud1a': 'UserDefOne', '*ud1b': 'UserDefOne'}, 133ab22ad96SMarkus Armbruster 'returns': 'UserDefTwo' } 134cae95eaeSEric Blake 135cae95eaeSEric Blake# Returning a non-dictionary requires a name from the whitelist 136cae95eaeSEric Blake{ 'command': 'guest-get-time', 'data': {'a': 'int', '*b': 'int' }, 137c2216a8aSMarkus Armbruster 'returns': 'int' } 13828770e05SMarkus Armbruster{ 'command': 'guest-sync', 'data': { 'arg': 'any' }, 'returns': 'any' } 139c818408eSEric Blake{ 'command': 'boxed-struct', 'boxed': true, 'data': 'UserDefZero' } 140c818408eSEric Blake{ 'command': 'boxed-union', 'data': 'UserDefNativeListUnion', 'boxed': true } 1413953e3a5SLaszlo Ersek 1423953e3a5SLaszlo Ersek# For testing integer range flattening in opts-visitor. The following schema 1433953e3a5SLaszlo Ersek# corresponds to the option format: 1443953e3a5SLaszlo Ersek# 1453953e3a5SLaszlo Ersek# -userdef i64=3-6,i64=-5--1,u64=2,u16=1,u16=7-12 1463953e3a5SLaszlo Ersek# 1473953e3a5SLaszlo Ersek# For simplicity, this example doesn't use [type=]discriminator nor optargs 1483953e3a5SLaszlo Ersek# specific to discriminator values. 149895a2a80SEric Blake{ 'struct': 'UserDefOptions', 1503953e3a5SLaszlo Ersek 'data': { 1513953e3a5SLaszlo Ersek '*i64' : [ 'int' ], 1523953e3a5SLaszlo Ersek '*u64' : [ 'uint64' ], 1533953e3a5SLaszlo Ersek '*u16' : [ 'uint16' ], 1543953e3a5SLaszlo Ersek '*i64x': 'int' , 1553953e3a5SLaszlo Ersek '*u64x': 'uint64' } } 156f6dadb02SWenchao Xia 157f6dadb02SWenchao Xia# testing event 158895a2a80SEric Blake{ 'struct': 'EventStructOne', 159f6dadb02SWenchao Xia 'data': { 'struct1': 'UserDefOne', 'string': 'str', '*enum2': 'EnumOne' } } 160f6dadb02SWenchao Xia 161f6dadb02SWenchao Xia{ 'event': 'EVENT_A' } 162f6dadb02SWenchao Xia{ 'event': 'EVENT_B', 163f6dadb02SWenchao Xia 'data': { } } 164f6dadb02SWenchao Xia{ 'event': 'EVENT_C', 165f6dadb02SWenchao Xia 'data': { '*a': 'int', '*b': 'UserDefOne', 'c': 'str' } } 166f6dadb02SWenchao Xia{ 'event': 'EVENT_D', 167f6dadb02SWenchao Xia 'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3': 'EnumOne' } } 168c818408eSEric Blake{ 'event': 'EVENT_E', 'boxed': true, 'data': 'UserDefZero' } 169c818408eSEric Blake{ 'event': 'EVENT_F', 'boxed': true, 'data': 'UserDefAlternate' } 170fce384b8SEric Blake 171c43567c1SEric Blake# test that we correctly compile downstream extensions, as well as munge 172c43567c1SEric Blake# ticklish names 173fce384b8SEric Blake{ 'enum': '__org.qemu_x-Enum', 'data': [ '__org.qemu_x-value' ] } 17483a02706SEric Blake{ 'struct': '__org.qemu_x-Base', 17583a02706SEric Blake 'data': { '__org.qemu_x-member1': '__org.qemu_x-Enum' } } 17683a02706SEric Blake{ 'struct': '__org.qemu_x-Struct', 'base': '__org.qemu_x-Base', 177c43567c1SEric Blake 'data': { '__org.qemu_x-member2': 'str', '*wchar-t': 'int' } } 178bb337290SEric Blake{ 'union': '__org.qemu_x-Union1', 'data': { '__org.qemu_x-branch': 'str' } } 179857af5f0SEric Blake{ 'struct': '__org.qemu_x-Struct2', 180857af5f0SEric Blake 'data': { 'array': ['__org.qemu_x-Union1'] } } 181857af5f0SEric Blake{ 'union': '__org.qemu_x-Union2', 'base': '__org.qemu_x-Base', 182857af5f0SEric Blake 'discriminator': '__org.qemu_x-member1', 183857af5f0SEric Blake 'data': { '__org.qemu_x-value': '__org.qemu_x-Struct2' } } 184d1f07c86SEric Blake{ 'alternate': '__org.qemu_x-Alt', 185d1f07c86SEric Blake 'data': { '__org.qemu_x-branch': 'str', 'b': '__org.qemu_x-Base' } } 186e3c4c3d7SEric Blake{ 'event': '__ORG.QEMU_X-EVENT', 'data': '__org.qemu_x-Struct' } 187e3c4c3d7SEric Blake{ 'command': '__org.qemu_x-command', 188e3c4c3d7SEric Blake 'data': { 'a': ['__org.qemu_x-Enum'], 'b': ['__org.qemu_x-Struct'], 189e3c4c3d7SEric Blake 'c': '__org.qemu_x-Union2', 'd': '__org.qemu_x-Alt' }, 190e3c4c3d7SEric Blake 'returns': '__org.qemu_x-Union1' } 191