tests/qapi-schema/qapi-schema-test.json

   1 # *-*- Mode: Python -*-*
   2
   3 # This file is a stress test of supported qapi constructs that must
   4 # parse and compile correctly.
   5
   6 # Whitelists to permit QAPI rule violations
   7 { 'pragma': {
   8     # Commands allowed to return a non-dictionary:
   9     'returns-whitelist': [
  10         'guest-get-time',
  11         'guest-sync' ] } }
  12
  13 { 'struct': 'TestStruct',
  14   'data': { 'integer': 'int', 'boolean': 'bool', 'string': 'str' } }
  15
  16 # for testing enums
  17 { 'struct': 'NestedEnumsOne',
  18   'data': { 'enum1': 'EnumOne',   # Intentional forward reference
  19             '*enum2': 'EnumOne', 'enum3': 'EnumOne', '*enum4': 'EnumOne' } }
  20
  21 # An empty enum, although unusual, is currently acceptable
  22 { 'enum': 'MyEnum', 'data': [ ] }
  23
  24 # Likewise for an empty struct, including an empty base
  25 { 'struct': 'Empty1', 'data': { } }
  26 { 'struct': 'Empty2', 'base': 'Empty1', 'data': { } }
  27
  28 { 'command': 'user_def_cmd0', 'data': 'Empty2', 'returns': 'Empty2' }
  29
  30 # for testing override of default naming heuristic
  31 { 'enum': 'QEnumTwo',
  32   'prefix': 'QENUM_TWO',
  33   'data': [ 'value1', 'value2' ] }
  34
  35 # for testing nested structs
  36 { 'struct': 'UserDefOne',
  37   'base': 'UserDefZero',        # intentional forward reference
  38   'data': { 'string': 'str',
  39             '*enum1': 'EnumOne' } }   # intentional forward reference
  40
  41 { 'enum': 'EnumOne',
  42   'data': [ 'value1', 'value2', 'value3' ] }
  43
  44 { 'struct': 'UserDefZero',
  45   'data': { 'integer': 'int' } }
  46
  47 { 'struct': 'UserDefTwoDictDict',
  48   'data': { 'userdef': 'UserDefOne', 'string': 'str' } }
  49
  50 { 'struct': 'UserDefTwoDict',
  51   'data': { 'string1': 'str',
  52             'dict2': 'UserDefTwoDictDict',
  53             '*dict3': 'UserDefTwoDictDict' } }
  54
  55 { 'struct': 'UserDefTwo',
  56   'data': { 'string0': 'str',
  57             'dict1': 'UserDefTwoDict' } }
  58
  59 # dummy struct to force generation of array types not otherwise mentioned
  60 { 'struct': 'ForceArrays',
  61   'data': { 'unused1':['UserDefOne'], 'unused2':['UserDefTwo'],
  62             'unused3':['TestStruct'] } }
  63
  64 # for testing unions
  65 # Among other things, test that a name collision between branches does
  66 # not cause any problems (since only one branch can be in use at a time),
  67 # by intentionally using two branches that both have a C member 'a_b'
  68 { 'struct': 'UserDefA',
  69   'data': { 'boolean': 'bool', '*a_b': 'int' } }
  70
  71 { 'struct': 'UserDefB',
  72   'data': { 'intb': 'int', '*a-b': 'bool' } }
  73
  74 { 'union': 'UserDefFlatUnion',
  75   'base': 'UserDefUnionBase',   # intentional forward reference
  76   'discriminator': 'enum1',
  77   'data': { 'value1' : 'UserDefA',
  78             'value2' : 'UserDefB',
  79             'value3' : 'UserDefB' } }
  80
  81 { 'struct': 'UserDefUnionBase',
  82   'base': 'UserDefZero',
  83   'data': { 'string': 'str', 'enum1': 'EnumOne' } }
  84
  85 # this variant of UserDefFlatUnion defaults to a union that uses members with
  86 # allocated types to test corner cases in the cleanup/dealloc visitor
  87 { 'union': 'UserDefFlatUnion2',
  88   'base': { '*integer': 'int', 'string': 'str', 'enum1': 'QEnumTwo' },
  89   'discriminator': 'enum1',
  90   'data': { 'value1' : 'UserDefC', # intentional forward reference
  91             'value2' : 'UserDefB' } }
  92
  93 { 'struct': 'WrapAlternate',
  94   'data': { 'alt': 'UserDefAlternate' } }
  95 { 'alternate': 'UserDefAlternate',
  96   'data': { 'udfu': 'UserDefFlatUnion', 'e': 'EnumOne', 'i': 'int',
  97             'n': 'null' } }
  98
  99 { 'struct': 'UserDefC',
 100   'data': { 'string1': 'str', 'string2': 'str' } }
 101
 102 # for testing use of 'number' within alternates
 103 { 'alternate': 'AltEnumBool', 'data': { 'e': 'EnumOne', 'b': 'bool' } }
 104 { 'alternate': 'AltEnumNum', 'data': { 'e': 'EnumOne', 'n': 'number' } }
 105 { 'alternate': 'AltNumEnum', 'data': { 'n': 'number', 'e': 'EnumOne' } }
 106 { 'alternate': 'AltEnumInt', 'data': { 'e': 'EnumOne', 'i': 'int' } }
 107
 108 # for testing use of 'str' within alternates
 109 { 'alternate': 'AltStrObj', 'data': { 's': 'str', 'o': 'TestStruct' } }
 110
 111 # for testing native lists
 112 { 'union': 'UserDefNativeListUnion',
 113   'data': { 'integer': ['int'],
 114             's8': ['int8'],
 115             's16': ['int16'],
 116             's32': ['int32'],
 117             's64': ['int64'],
 118             'u8': ['uint8'],
 119             'u16': ['uint16'],
 120             'u32': ['uint32'],
 121             'u64': ['uint64'],
 122             'number': ['number'],
 123             'boolean': ['bool'],
 124             'string': ['str'],
 125             'sizes': ['size'],
 126             'any': ['any'] } }
 127
 128 # testing commands
 129 { 'command': 'user_def_cmd', 'data': {} }
 130 { 'command': 'user_def_cmd1', 'data': {'ud1a': 'UserDefOne'} }
 131 { 'command': 'user_def_cmd2',
 132   'data': {'ud1a': 'UserDefOne', '*ud1b': 'UserDefOne'},
 133   'returns': 'UserDefTwo' }
 134
 135 # Returning a non-dictionary requires a name from the whitelist
 136 { 'command': 'guest-get-time', 'data': {'a': 'int', '*b': 'int' },
 137   'returns': 'int' }
 138 { 'command': 'guest-sync', 'data': { 'arg': 'any' }, 'returns': 'any' }
 139 { 'command': 'boxed-struct', 'boxed': true, 'data': 'UserDefZero' }
 140 { 'command': 'boxed-union', 'data': 'UserDefNativeListUnion', 'boxed': true }
 141
 142 # For testing integer range flattening in opts-visitor. The following schema
 143 # corresponds to the option format:
 144 #
 145 # -userdef i64=3-6,i64=-5--1,u64=2,u16=1,u16=7-12
 146 #
 147 # For simplicity, this example doesn't use [type=]discriminator nor optargs
 148 # specific to discriminator values.
 149 { 'struct': 'UserDefOptions',
 150   'data': {
 151     '*i64' : [ 'int'    ],
 152     '*u64' : [ 'uint64' ],
 153     '*u16' : [ 'uint16' ],
 154     '*i64x':   'int'     ,
 155     '*u64x':   'uint64'  } }
 156
 157 # testing event
 158 { 'struct': 'EventStructOne',
 159   'data': { 'struct1': 'UserDefOne', 'string': 'str', '*enum2': 'EnumOne' } }
 160
 161 { 'event': 'EVENT_A' }
 162 { 'event': 'EVENT_B',
 163   'data': { } }
 164 { 'event': 'EVENT_C',
 165   'data': { '*a': 'int', '*b': 'UserDefOne', 'c': 'str' } }
 166 { 'event': 'EVENT_D',
 167   'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3': 'EnumOne' } }
 168 { 'event': 'EVENT_E', 'boxed': true, 'data': 'UserDefZero' }
 169 { 'event': 'EVENT_F', 'boxed': true, 'data': 'UserDefAlternate' }
 170
 171 # test that we correctly compile downstream extensions, as well as munge
 172 # ticklish names
 173 { 'enum': '__org.qemu_x-Enum', 'data': [ '__org.qemu_x-value' ] }
 174 { 'struct': '__org.qemu_x-Base',
 175   'data': { '__org.qemu_x-member1': '__org.qemu_x-Enum' } }
 176 { 'struct': '__org.qemu_x-Struct', 'base': '__org.qemu_x-Base',
 177   'data': { '__org.qemu_x-member2': 'str', '*wchar-t': 'int' } }
 178 { 'union': '__org.qemu_x-Union1', 'data': { '__org.qemu_x-branch': 'str' } }
 179 { 'struct': '__org.qemu_x-Struct2',
 180   'data': { 'array': ['__org.qemu_x-Union1'] } }
 181 { 'union': '__org.qemu_x-Union2', 'base': '__org.qemu_x-Base',
 182   'discriminator': '__org.qemu_x-member1',
 183   'data': { '__org.qemu_x-value': '__org.qemu_x-Struct2' } }
 184 { 'alternate': '__org.qemu_x-Alt',
 185   'data': { '__org.qemu_x-branch': 'str', 'b': '__org.qemu_x-Base' } }
 186 { 'event': '__ORG.QEMU_X-EVENT', 'data': '__org.qemu_x-Struct' }
 187 { 'command': '__org.qemu_x-command',
 188   'data': { 'a': ['__org.qemu_x-Enum'], 'b': ['__org.qemu_x-Struct'],
 189             'c': '__org.qemu_x-Union2', 'd': '__org.qemu_x-Alt' },
 190   'returns': '__org.qemu_x-Union1' }