xref: /openbmc/qemu/tests/qapi-schema/qapi-schema-test.json (revision ff8f06ee7680fb505079d33caaf8f5ebff0853bc) 
1# *-*- Mode: Python -*-*
2
3# for testing enums
4{ 'enum': 'EnumOne',
5  'data': [ 'value1', 'value2', 'value3' ] }
6{ 'struct': 'NestedEnumsOne',
7  'data': { 'enum1': 'EnumOne', '*enum2': 'EnumOne', 'enum3': 'EnumOne', '*enum4': 'EnumOne' } }
8
9# for testing override of default naming heuristic
10{ 'enum': 'QEnumTwo',
11  'prefix': 'QENUM_TWO',
12  'data': [ 'value1', 'value2' ] }
13
14# for testing nested structs
15{ 'struct': 'UserDefOne',
16  'base': 'UserDefZero',        # intentional forward reference
17  'data': { 'string': 'str', '*enum1': 'EnumOne' } }
18
19{ 'struct': 'UserDefZero',
20  'data': { 'integer': 'int' } }
21
22{ 'struct': 'UserDefTwoDictDict',
23  'data': { 'userdef': 'UserDefOne', 'string': 'str' } }
24
25{ 'struct': 'UserDefTwoDict',
26  'data': { 'string1': 'str',
27            'dict2': 'UserDefTwoDictDict',
28            '*dict3': 'UserDefTwoDictDict' } }
29
30{ 'struct': 'UserDefTwo',
31  'data': { 'string0': 'str',
32            'dict1': 'UserDefTwoDict' } }
33
34# for testing unions
35{ 'struct': 'UserDefA',
36  'data': { 'boolean': 'bool' } }
37
38{ 'struct': 'UserDefB',
39  'data': { 'intb': 'int' } }
40
41{ 'union': 'UserDefFlatUnion',
42  'base': 'UserDefUnionBase',   # intentional forward reference
43  'discriminator': 'enum1',
44  'data': { 'value1' : 'UserDefA',
45            'value2' : 'UserDefB',
46            'value3' : 'UserDefB' } }
47
48{ 'struct': 'UserDefUnionBase',
49  'base': 'UserDefZero',
50  'data': { 'string': 'str', 'enum1': 'EnumOne' } }
51
52# this variant of UserDefFlatUnion defaults to a union that uses fields with
53# allocated types to test corner cases in the cleanup/dealloc visitor
54{ 'union': 'UserDefFlatUnion2',
55  'base': 'UserDefUnionBase',
56  'discriminator': 'enum1',
57  'data': { 'value1' : 'UserDefC', # intentional forward reference
58            'value2' : 'UserDefB',
59            'value3' : 'UserDefA' } }
60
61{ 'alternate': 'UserDefAlternate',
62  'data': { 'uda': 'UserDefA', 's': 'str', 'i': 'int' } }
63
64{ 'struct': 'UserDefC',
65  'data': { 'string1': 'str', 'string2': 'str' } }
66
67# for testing native lists
68{ 'union': 'UserDefNativeListUnion',
69  'data': { 'integer': ['int'],
70            's8': ['int8'],
71            's16': ['int16'],
72            's32': ['int32'],
73            's64': ['int64'],
74            'u8': ['uint8'],
75            'u16': ['uint16'],
76            'u32': ['uint32'],
77            'u64': ['uint64'],
78            'number': ['number'],
79            'boolean': ['bool'],
80            'string': ['str'],
81            'sizes': ['size'],
82            'any': ['any'] } }
83
84# testing commands
85{ 'command': 'user_def_cmd', 'data': {} }
86{ 'command': 'user_def_cmd1', 'data': {'ud1a': 'UserDefOne'} }
87{ 'command': 'user_def_cmd2',
88  'data': {'ud1a': 'UserDefOne', '*ud1b': 'UserDefOne'},
89  'returns': 'UserDefTwo' }
90{ 'command': 'user_def_cmd3', 'data': {'a': 'int', '*b': 'int' },
91  'returns': 'int' }
92# note: command name 'guest-sync' chosen to avoid "cannot use built-in" error
93{ 'command': 'guest-sync', 'data': { 'arg': 'any' }, 'returns': 'any' }
94
95# For testing integer range flattening in opts-visitor. The following schema
96# corresponds to the option format:
97#
98# -userdef i64=3-6,i64=-5--1,u64=2,u16=1,u16=7-12
99#
100# For simplicity, this example doesn't use [type=]discriminator nor optargs
101# specific to discriminator values.
102{ 'struct': 'UserDefOptions',
103  'data': {
104    '*i64' : [ 'int'    ],
105    '*u64' : [ 'uint64' ],
106    '*u16' : [ 'uint16' ],
107    '*i64x':   'int'     ,
108    '*u64x':   'uint64'  } }
109
110# testing event
111{ 'struct': 'EventStructOne',
112  'data': { 'struct1': 'UserDefOne', 'string': 'str', '*enum2': 'EnumOne' } }
113
114{ 'event': 'EVENT_A' }
115{ 'event': 'EVENT_B',
116  'data': { } }
117{ 'event': 'EVENT_C',
118  'data': { '*a': 'int', '*b': 'UserDefOne', 'c': 'str' } }
119{ 'event': 'EVENT_D',
120  'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3': 'EnumOne' } }
121
122# test that we correctly compile downstream extensions
123{ 'enum': '__org.qemu_x-Enum', 'data': [ '__org.qemu_x-value' ] }
124{ 'struct': '__org.qemu_x-Base',
125  'data': { '__org.qemu_x-member1': '__org.qemu_x-Enum' } }
126{ 'struct': '__org.qemu_x-Struct', 'base': '__org.qemu_x-Base',
127  'data': { '__org.qemu_x-member2': 'str' } }
128{ 'union': '__org.qemu_x-Union1', 'data': { '__org.qemu_x-branch': 'str' } }
129{ 'struct': '__org.qemu_x-Struct2',
130  'data': { 'array': ['__org.qemu_x-Union1'] } }
131{ 'union': '__org.qemu_x-Union2', 'base': '__org.qemu_x-Base',
132  'discriminator': '__org.qemu_x-member1',
133  'data': { '__org.qemu_x-value': '__org.qemu_x-Struct2' } }
134{ 'alternate': '__org.qemu_x-Alt',
135  'data': { '__org.qemu_x-branch': 'str', 'b': '__org.qemu_x-Base' } }
136{ 'event': '__ORG.QEMU_X-EVENT', 'data': '__org.qemu_x-Struct' }
137{ 'command': '__org.qemu_x-command',
138  'data': { 'a': ['__org.qemu_x-Enum'], 'b': ['__org.qemu_x-Struct'],
139            'c': '__org.qemu_x-Union2', 'd': '__org.qemu_x-Alt' },
140  'returns': '__org.qemu_x-Union1' }
141