qapi-schema-test.json (12667B)
1 # *-*- Mode: Python -*-* 2 # vim: filetype=python 3 4 # This file is a stress test of supported qapi constructs that must 5 # parse and compile correctly. 6 7 # Whitelists to permit QAPI rule violations 8 { 'pragma': { 9 # Types whose member names may use '_' 10 'member-name-exceptions': [ 11 'UserDefA' 12 ], 13 # Commands allowed to return a non-dictionary: 14 'command-returns-exceptions': [ 15 'guest-get-time', 16 'guest-sync' ] } } 17 18 { 'struct': 'TestStruct', 19 'data': { 'integer': {'type': 'int'}, 'boolean': 'bool', 'string': 'str' } } 20 21 # for testing enums 22 { 'struct': 'NestedEnumsOne', 23 'data': { 'enum1': 'EnumOne', # Intentional forward reference 24 '*enum2': 'EnumOne', 'enum3': 'EnumOne', '*enum4': 'EnumOne' } } 25 26 # An empty enum, although unusual, is currently acceptable 27 { 'enum': 'MyEnum', 'data': [ ] } 28 29 # Likewise for an empty struct, including an empty base 30 { 'struct': 'Empty1', 'data': { } } 31 { 'struct': 'Empty2', 'base': 'Empty1', 'data': { } } 32 33 # Likewise for an empty union 34 { 'union': 'Union', 35 'base': { 'type': 'EnumOne' }, 'discriminator': 'type', 36 'data': { } } 37 38 { 'command': 'user-def-cmd0', 'data': 'Empty2', 'returns': 'Empty2' } 39 40 # for testing override of default naming heuristic 41 { 'enum': 'QEnumTwo', 42 'prefix': 'QENUM_TWO', 43 'data': [ 'value1', 'value2' ] } 44 45 # for testing nested structs 46 { 'struct': 'UserDefOne', 47 'base': 'UserDefZero', # intentional forward reference 48 'data': { 'string': 'str', 49 '*enum1': 'EnumOne' } } # intentional forward reference 50 51 { 'enum': 'EnumOne', 52 'data': [ 'value1', 'value2', 'value3', 'value4' ] } 53 54 { 'struct': 'UserDefZero', 55 'data': { 'integer': 'int' } } 56 57 { 'struct': 'UserDefTwoDictDict', 58 'data': { 'userdef': 'UserDefOne', 'string': 'str' } } 59 60 { 'struct': 'UserDefTwoDict', 61 'data': { 'string1': 'str', 62 'dict2': 'UserDefTwoDictDict', 63 '*dict3': 'UserDefTwoDictDict' } } 64 65 { 'struct': 'UserDefTwo', 66 'data': { 'string0': 'str', 67 'dict1': 'UserDefTwoDict' } } 68 69 { 'struct': 'UserDefThree', 70 'data': { 'string0': 'str' } } 71 72 # dummy struct to force generation of array types not otherwise mentioned 73 { 'struct': 'ForceArrays', 74 'data': { 'unused1':['UserDefOne'], 'unused2':['UserDefTwo'], 75 'unused3':['TestStruct'] } } 76 77 # for testing unions 78 # Among other things, test that a name collision between branches does 79 # not cause any problems (since only one branch can be in use at a time), 80 # by intentionally using two branches that both have a C member 'a_b' 81 { 'struct': 'UserDefA', 82 'data': { 'boolean': 'bool', '*a_b': 'int' } } 83 84 { 'struct': 'UserDefB', 85 'data': { 'intb': 'int', '*a-b': 'bool' } } 86 87 { 'union': 'UserDefFlatUnion', 88 'base': 'UserDefUnionBase', # intentional forward reference 89 'discriminator': 'enum1', 90 'data': { 'value1' : {'type': 'UserDefA'}, 91 'value2' : 'UserDefB', 92 'value3' : 'UserDefB' 93 # 'value4' defaults to empty 94 } } 95 96 { 'struct': 'UserDefUnionBase', 97 'base': 'UserDefZero', 98 'data': { 'string': 'str', 'enum1': 'EnumOne' } } 99 100 # this variant of UserDefFlatUnion defaults to a union that uses members with 101 # allocated types to test corner cases in the cleanup/dealloc visitor 102 { 'union': 'UserDefFlatUnion2', 103 'base': { '*integer': 'int', 'string': 'str', 'enum1': 'QEnumTwo' }, 104 'discriminator': 'enum1', 105 'data': { 'value1' : 'UserDefC', # intentional forward reference 106 'value2' : 'UserDefB' } } 107 108 { 'struct': 'WrapAlternate', 109 'data': { 'alt': 'UserDefAlternate' } } 110 { 'alternate': 'UserDefAlternate', 111 'data': { 'udfu': {'type': 'UserDefFlatUnion'}, 'e': 'EnumOne', 'i': 'int', 112 'n': 'null' } } 113 114 { 'struct': 'UserDefC', 115 'data': { 'string1': 'str', 'string2': 'str' } } 116 117 # for testing use of 'number' within alternates 118 { 'alternate': 'AltEnumBool', 'data': { 'e': 'EnumOne', 'b': 'bool' } } 119 { 'alternate': 'AltEnumNum', 'data': { 'e': 'EnumOne', 'n': 'number' } } 120 { 'alternate': 'AltNumEnum', 'data': { 'n': 'number', 'e': 'EnumOne' } } 121 { 'alternate': 'AltEnumInt', 'data': { 'e': 'EnumOne', 'i': 'int' } } 122 { 'alternate': 'AltListInt', 'data': { 'l': ['int'], 'i': 'int' } } 123 124 # for testing use of 'str' within alternates 125 { 'alternate': 'AltStrObj', 'data': { 's': 'str', 'o': 'TestStruct' } } 126 127 { 'struct': 'ArrayStruct', 128 'data': { 'integer': ['int'], 129 's8': ['int8'], 130 's16': ['int16'], 131 's32': ['int32'], 132 's64': ['int64'], 133 'u8': ['uint8'], 134 'u16': ['uint16'], 135 'u32': ['uint32'], 136 'u64': ['uint64'], 137 'number': ['number'], 138 'boolean': ['bool'], 139 'string': ['str'], 140 '*sz': ['size'], 141 '*any': ['any'], 142 '*user': ['Status'] } } # intentional forward ref. to sub-module 143 144 # for testing sub-modules 145 { 'include': 'include/sub-module.json' } 146 147 # testing commands 148 { 'command': 'user-def-cmd', 'data': {} } 149 { 'command': 'user-def-cmd1', 'data': {'ud1a': 'UserDefOne'} } 150 { 'command': 'user-def-cmd2', 151 'data': {'ud1a': {'type': 'UserDefOne'}, '*ud1b': 'UserDefOne'}, 152 'returns': 'UserDefTwo' } 153 154 { 'command': 'cmd-success-response', 'data': {}, 'success-response': false } 155 { 'command': 'coroutine-cmd', 'data': {}, 'coroutine': true } 156 157 # Returning a non-dictionary requires a name from the whitelist 158 { 'command': 'guest-get-time', 'data': {'a': 'int', '*b': 'int' }, 159 'returns': 'int' } 160 { 'command': 'guest-sync', 'data': { 'arg': 'any' }, 'returns': 'any' } 161 { 'command': 'boxed-struct', 'boxed': true, 'data': 'UserDefZero' } 162 { 'command': 'boxed-union', 'data': 'UserDefFlatUnion', 'boxed': true } 163 { 'command': 'boxed-empty', 'boxed': true, 'data': 'Empty1' } 164 165 # Smoke test on out-of-band and allow-preconfig-test 166 { 'command': 'test-flags-command', 'allow-oob': true, 'allow-preconfig': true } 167 168 # For testing integer range flattening in opts-visitor. The following schema 169 # corresponds to the option format: 170 # 171 # -userdef i64=3-6,i64=-5--1,u64=2,u16=1,u16=7-12 172 # 173 # For simplicity, this example doesn't use [type=]discriminator nor optargs 174 # specific to discriminator values. 175 { 'struct': 'UserDefOptions', 176 'data': { 177 '*i64' : [ 'int' ], 178 '*u64' : [ 'uint64' ], 179 '*u16' : [ 'uint16' ], 180 '*i64x': 'int' , 181 '*u64x': 'uint64' } } 182 183 # testing event 184 { 'struct': 'EventStructOne', 185 'data': { 'struct1': {'type': 'UserDefOne'}, 'string': 'str', '*enum2': 'EnumOne' } } 186 187 { 'event': 'EVENT_A' } 188 { 'event': 'EVENT_B', 189 'data': { } } 190 { 'event': 'EVENT_C', 191 'data': { '*a': 'int', '*b': 'UserDefOne', 'c': 'str' } } 192 { 'event': 'EVENT_D', 193 'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3': 'EnumOne' } } 194 { 'event': 'EVENT_E', 'boxed': true, 'data': 'UserDefZero' } 195 { 'event': 'EVENT_F', 'boxed': true, 'data': 'UserDefFlatUnion' } 196 { 'event': 'EVENT_G', 'boxed': true, 'data': 'Empty1' } 197 198 # test that we correctly compile downstream extensions, as well as munge 199 # ticklish names 200 # also test union and alternate with just one branch 201 { 'enum': '__org.qemu_x-Enum', 'data': [ '__org.qemu_x-value' ] } 202 { 'struct': '__org.qemu_x-Base', 203 'data': { '__org.qemu_x-member1': '__org.qemu_x-Enum' } } 204 { 'struct': '__org.qemu_x-Struct', 'base': '__org.qemu_x-Base', 205 'data': { '__org.qemu_x-member2': 'str', '*wchar-t': 'int' } } 206 { 'alternate': '__org.qemu_x-Alt1', 'data': { '__org.qemu_x-branch': 'str' } } 207 { 'struct': '__org.qemu_x-Struct2', 208 'data': { 'array': ['__org.qemu_x-Union'] } } 209 { 'union': '__org.qemu_x-Union', 'base': '__org.qemu_x-Base', 210 'discriminator': '__org.qemu_x-member1', 211 'data': { '__org.qemu_x-value': '__org.qemu_x-Struct2' } } 212 { 'alternate': '__org.qemu_x-Alt', 213 'data': { '__org.qemu_x-branch': '__org.qemu_x-Base' } } 214 { 'event': '__ORG.QEMU_X-EVENT', 'data': '__org.qemu_x-Struct' } 215 { 'command': '__org.qemu_x-command', 216 'data': { 'a': ['__org.qemu_x-Enum'], 'b': ['__org.qemu_x-Struct'], 217 'c': '__org.qemu_x-Union', 'd': '__org.qemu_x-Alt' } } 218 219 # test 'if' condition handling 220 221 { 'struct': 'TestIfStruct', 222 'data': { 'foo': 'int', 223 'bar': { 'type': 'int', 'if': 'TEST_IF_STRUCT_BAR'} }, 224 'if': 'TEST_IF_STRUCT' } 225 226 { 'enum': 'TestIfEnum', 227 'data': [ 'foo', { 'name' : 'bar', 'if': 'TEST_IF_ENUM_BAR' } ], 228 'if': 'TEST_IF_ENUM' } 229 230 { 'union': 'TestIfUnion', 231 'base': { 'type': 'TestIfEnum' }, 232 'discriminator': 'type', 233 'data': { 'foo': 'TestStruct', 234 'bar': { 'type': 'UserDefZero', 'if': 'TEST_IF_ENUM_BAR'} }, 235 'if': { 'all': ['TEST_IF_UNION', 'TEST_IF_STRUCT'] } } 236 237 { 'command': 'test-if-union-cmd', 238 'data': { 'union-cmd-arg': 'TestIfUnion' }, 239 'if': { 'all': ['TEST_IF_UNION', 'TEST_IF_STRUCT'] } } 240 241 { 'alternate': 'TestIfAlternate', 242 'data': { 'foo': 'int', 243 'bar': { 'type': 'TestStruct', 'if': 'TEST_IF_ALT_BAR'} }, 244 'if': { 'all': ['TEST_IF_ALT', 'TEST_IF_STRUCT'] } } 245 246 { 'command': 'test-if-alternate-cmd', 247 'data': { 'alt-cmd-arg': 'TestIfAlternate' }, 248 'if': { 'all': ['TEST_IF_ALT', 'TEST_IF_STRUCT'] } } 249 250 { 'command': 'test-if-cmd', 251 'data': { 252 'foo': 'TestIfStruct', 253 'bar': { 'type': 'TestIfEnum', 'if': 'TEST_IF_CMD_BAR' } }, 254 'returns': 'UserDefThree', 255 'if': { 'all': ['TEST_IF_CMD', 'TEST_IF_STRUCT'] } } 256 257 { 'command': 'test-cmd-return-def-three', 'returns': 'UserDefThree' } 258 259 { 'event': 'TEST_IF_EVENT', 260 'data': { 'foo': 'TestIfStruct', 261 'bar': { 'type': ['TestIfEnum'], 'if': 'TEST_IF_EVT_BAR' } }, 262 'if': { 'all': ['TEST_IF_EVT', 'TEST_IF_STRUCT'] } } 263 264 { 'event': 'TEST_IF_EVENT2', 'data': {}, 265 'if': { 'not': { 'any': [ { 'not': 'TEST_IF_EVT' }, 266 { 'not': 'TEST_IF_STRUCT' } ] } } } 267 268 # test 'features' 269 270 { 'struct': 'FeatureStruct0', 271 'data': { 'foo': 'int' }, 272 'features': [] } 273 { 'struct': 'FeatureStruct1', 274 'data': { 'foo': { 'type': 'int', 'features': [ 'deprecated' ] } }, 275 'features': [ 'feature1' ] } 276 { 'struct': 'FeatureStruct2', 277 'data': { 'foo': { 'type': 'int', 'features': [ 'unstable' ] } }, 278 'features': [ { 'name': 'feature1' } ] } 279 { 'struct': 'FeatureStruct3', 280 'data': { 'foo': 'int' }, 281 'features': [ 'feature1', 'feature2' ] } 282 { 'struct': 'FeatureStruct4', 283 'data': { 'namespace-test': 'int' }, 284 'features': [ 'namespace-test', 'int', 'name', 'if' ] } 285 286 { 'struct': 'CondFeatureStruct1', 287 'data': { 'foo': 'int' }, 288 'features': [ { 'name': 'feature1', 'if': 'TEST_IF_FEATURE_1'} ] } 289 { 'struct': 'CondFeatureStruct2', 290 'data': { 'foo': 'int' }, 291 'features': [ { 'name': 'feature1', 'if': 'TEST_IF_FEATURE_1'}, 292 { 'name': 'feature2', 'if': 'TEST_IF_FEATURE_2'} ] } 293 { 'struct': 'CondFeatureStruct3', 294 'data': { 'foo': 'int' }, 295 'features': [ { 'name': 'feature1', 296 'if': { 'all': [ 'TEST_IF_COND_1', 297 'TEST_IF_COND_2'] } } ] } 298 { 'struct': 'CondFeatureStruct4', 299 'data': { 'foo': 'int' }, 300 'features': [ { 'name': 'feature1', 301 'if': {'any': ['TEST_IF_COND_1', 302 'TEST_IF_COND_2'] } } ] } 303 304 { 'enum': 'FeatureEnum1', 305 'data': [ 'eins', 'zwei', 306 { 'name': 'drei', 'features': [ 'deprecated' ] } ], 307 'features': [ 'feature1' ] } 308 309 { 'union': 'FeatureUnion1', 310 'base': { 'tag': 'FeatureEnum1' }, 311 'discriminator': 'tag', 312 'data': { 'eins': 'FeatureStruct1' }, 313 'features': [ 'feature1' ] } 314 315 { 'alternate': 'FeatureAlternate1', 316 'data': { 'eins': 'FeatureStruct1' }, 317 'features': [ 'feature1' ] } 318 319 { 'command': 'test-features0', 320 'data': { '*fs0': 'FeatureStruct0', 321 '*fs1': 'FeatureStruct1', 322 '*fs2': 'FeatureStruct2', 323 '*fs3': 'FeatureStruct3', 324 '*fs4': 'FeatureStruct4', 325 '*cfs1': 'CondFeatureStruct1', 326 '*cfs2': 'CondFeatureStruct2', 327 '*cfs3': 'CondFeatureStruct3', 328 '*cfs4': 'CondFeatureStruct4' }, 329 'returns': 'FeatureStruct1', 330 'features': [] } 331 332 { 'command': 'test-command-features1', 333 'features': [ 'deprecated' ] } 334 { 'command': 'test-command-features3', 335 'features': [ 'unstable', 'feature1', 'feature2' ] } 336 337 { 'command': 'test-command-cond-features1', 338 'features': [ { 'name': 'feature1', 'if': 'TEST_IF_FEATURE_1'} ] } 339 { 'command': 'test-command-cond-features2', 340 'features': [ { 'name': 'feature1', 'if': 'TEST_IF_FEATURE_1'}, 341 { 'name': 'feature2', 'if': 'TEST_IF_FEATURE_2'} ] } 342 { 'command': 'test-command-cond-features3', 343 'features': [ { 'name': 'feature1', 344 'if': { 'all': [ 'TEST_IF_COND_1', 345 'TEST_IF_COND_2'] } } ] } 346 347 { 'event': 'TEST_EVENT_FEATURES0', 348 'data': 'FeatureStruct1' } 349 350 { 'event': 'TEST_EVENT_FEATURES1', 351 'features': [ 'deprecated' ] } 352 353 { 'event': 'TEST_EVENT_FEATURES2', 354 'features': [ 'unstable' ] }