1fb0bc835SMarkus Armbruster""" 2fb0bc835SMarkus ArmbrusterQAPI introspection generator 3fb0bc835SMarkus Armbruster 4fb0bc835SMarkus ArmbrusterCopyright (C) 2015-2018 Red Hat, Inc. 5fb0bc835SMarkus Armbruster 6fb0bc835SMarkus ArmbrusterAuthors: 7fb0bc835SMarkus Armbruster Markus Armbruster <armbru@redhat.com> 8fb0bc835SMarkus Armbruster 9fb0bc835SMarkus ArmbrusterThis work is licensed under the terms of the GNU GPL, version 2. 10fb0bc835SMarkus ArmbrusterSee the COPYING file in the top-level directory. 11fb0bc835SMarkus Armbruster""" 12fb0bc835SMarkus Armbruster 135af8263dSJohn Snowfrom .common import ( 145af8263dSJohn Snow c_name, 155af8263dSJohn Snow gen_endif, 165af8263dSJohn Snow gen_if, 175af8263dSJohn Snow mcgen, 185af8263dSJohn Snow) 197137a960SJohn Snowfrom .gen import QAPISchemaMonolithicCVisitor 2067fea575SJohn Snowfrom .schema import ( 2167fea575SJohn Snow QAPISchemaArrayType, 2267fea575SJohn Snow QAPISchemaBuiltinType, 2367fea575SJohn Snow QAPISchemaType, 2467fea575SJohn Snow) 25fb0bc835SMarkus Armbruster 26fb0bc835SMarkus Armbruster 27*84bece7dSJohn Snowdef _make_tree(obj, ifcond, extra=None): 2824cfd6adSMarkus Armbruster if extra is None: 2924cfd6adSMarkus Armbruster extra = {} 3024cfd6adSMarkus Armbruster if ifcond: 3124cfd6adSMarkus Armbruster extra['if'] = ifcond 3224cfd6adSMarkus Armbruster if extra: 3324cfd6adSMarkus Armbruster return (obj, extra) 3424cfd6adSMarkus Armbruster return obj 3524cfd6adSMarkus Armbruster 3624cfd6adSMarkus Armbruster 372e8a843dSMarkus Armbrusterdef _tree_to_qlit(obj, level=0, suppress_first_indent=False): 387d0f982bSMarc-André Lureau 397d0f982bSMarc-André Lureau def indent(level): 407d0f982bSMarc-André Lureau return level * 4 * ' ' 417d0f982bSMarc-André Lureau 42d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 438c643361SEric Blake ifobj, extra = obj 448c643361SEric Blake ifcond = extra.get('if') 458c643361SEric Blake comment = extra.get('comment') 468c643361SEric Blake ret = '' 478c643361SEric Blake if comment: 488c643361SEric Blake ret += indent(level) + '/* %s */\n' % comment 498c643361SEric Blake if ifcond: 508c643361SEric Blake ret += gen_if(ifcond) 512e8a843dSMarkus Armbruster ret += _tree_to_qlit(ifobj, level) 528c643361SEric Blake if ifcond: 538c643361SEric Blake ret += '\n' + gen_endif(ifcond) 54d626b6c1SMarc-André Lureau return ret 55d626b6c1SMarc-André Lureau 567d0f982bSMarc-André Lureau ret = '' 577d0f982bSMarc-André Lureau if not suppress_first_indent: 587d0f982bSMarc-André Lureau ret += indent(level) 59fb0bc835SMarkus Armbruster if obj is None: 607d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 61fb0bc835SMarkus Armbruster elif isinstance(obj, str): 627d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 63fb0bc835SMarkus Armbruster elif isinstance(obj, list): 642e8a843dSMarkus Armbruster elts = [_tree_to_qlit(elt, level + 1).strip('\n') 65fb0bc835SMarkus Armbruster for elt in obj] 667d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 677d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 6840bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 697d0f982bSMarc-André Lureau ret += indent(level) + '}))' 70fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 717d0f982bSMarc-André Lureau elts = [] 727d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 737d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 742e8a843dSMarkus Armbruster (to_c_string(key), 752e8a843dSMarkus Armbruster _tree_to_qlit(value, level + 1, True))) 767d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 777d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 787d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 797d0f982bSMarc-André Lureau ret += indent(level) + '}))' 80876c6751SPeter Xu elif isinstance(obj, bool): 81876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 82fb0bc835SMarkus Armbruster else: 83fb0bc835SMarkus Armbruster assert False # not implemented 8440bb1376SMarc-André Lureau if level > 0: 8540bb1376SMarc-André Lureau ret += ',' 86fb0bc835SMarkus Armbruster return ret 87fb0bc835SMarkus Armbruster 88fb0bc835SMarkus Armbruster 89fb0bc835SMarkus Armbrusterdef to_c_string(string): 90fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 91fb0bc835SMarkus Armbruster 92fb0bc835SMarkus Armbruster 9371b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 94fb0bc835SMarkus Armbruster 9571b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 962cae67bcSMarkus Armbruster super().__init__( 972cae67bcSMarkus Armbruster prefix, 'qapi-introspect', 9871b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 9971b3f045SMarkus Armbruster self._unmask = unmask 10071b3f045SMarkus Armbruster self._schema = None 1012e8a843dSMarkus Armbruster self._trees = [] 102fb0bc835SMarkus Armbruster self._used_types = [] 103fb0bc835SMarkus Armbruster self._name_map = {} 10471b3f045SMarkus Armbruster self._genc.add(mcgen(''' 10571b3f045SMarkus Armbruster#include "qemu/osdep.h" 106eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 10771b3f045SMarkus Armbruster 10871b3f045SMarkus Armbruster''', 10971b3f045SMarkus Armbruster prefix=prefix)) 11071b3f045SMarkus Armbruster 11171b3f045SMarkus Armbruster def visit_begin(self, schema): 11271b3f045SMarkus Armbruster self._schema = schema 113fb0bc835SMarkus Armbruster 114fb0bc835SMarkus Armbruster def visit_end(self): 115fb0bc835SMarkus Armbruster # visit the types that are actually used 116fb0bc835SMarkus Armbruster for typ in self._used_types: 117fb0bc835SMarkus Armbruster typ.visit(self) 118fb0bc835SMarkus Armbruster # generate C 1197d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 12071b3f045SMarkus Armbruster self._genh.add(mcgen(''' 1217d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 1227d0f982bSMarc-André Lureau 1237d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 124fb0bc835SMarkus Armbruster''', 12571b3f045SMarkus Armbruster c_name=c_name(name))) 12671b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1277d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 128fb0bc835SMarkus Armbruster''', 129fb0bc835SMarkus Armbruster c_name=c_name(name), 1302e8a843dSMarkus Armbruster c_string=_tree_to_qlit(self._trees))) 131fb0bc835SMarkus Armbruster self._schema = None 1322e8a843dSMarkus Armbruster self._trees = [] 13371b3f045SMarkus Armbruster self._used_types = [] 13471b3f045SMarkus Armbruster self._name_map = {} 135fb0bc835SMarkus Armbruster 136fb0bc835SMarkus Armbruster def visit_needed(self, entity): 137fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 138fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 139fb0bc835SMarkus Armbruster 140fb0bc835SMarkus Armbruster def _name(self, name): 141fb0bc835SMarkus Armbruster if self._unmask: 142fb0bc835SMarkus Armbruster return name 143fb0bc835SMarkus Armbruster if name not in self._name_map: 144fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 145fb0bc835SMarkus Armbruster return self._name_map[name] 146fb0bc835SMarkus Armbruster 147fb0bc835SMarkus Armbruster def _use_type(self, typ): 1486b67bcacSJohn Snow assert self._schema is not None 1496b67bcacSJohn Snow 150fb0bc835SMarkus Armbruster # Map the various integer types to plain int 151fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 152fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 153fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 154fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 155fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 156fb0bc835SMarkus Armbruster # Add type to work queue if new 157fb0bc835SMarkus Armbruster if typ not in self._used_types: 158fb0bc835SMarkus Armbruster self._used_types.append(typ) 159fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 1601aa806ccSEric Blake # type names as integers to reduce the temptation. Also, it 1611aa806ccSEric Blake # saves a few characters on the wire. 162fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 163fb0bc835SMarkus Armbruster return typ.name 164fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 165fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 166fb0bc835SMarkus Armbruster return self._name(typ.name) 167fb0bc835SMarkus Armbruster 168*84bece7dSJohn Snow @staticmethod 169*84bece7dSJohn Snow def _gen_features(features): 170*84bece7dSJohn Snow return [_make_tree(f.name, f.ifcond) for f in features] 171*84bece7dSJohn Snow 1722e8a843dSMarkus Armbruster def _gen_tree(self, name, mtype, obj, ifcond, features): 17324cfd6adSMarkus Armbruster extra = None 174fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 1758c643361SEric Blake if not self._unmask: 1768c643361SEric Blake # Output a comment to make it easy to map masked names 1778c643361SEric Blake # back to the source when reading the generated output. 17824cfd6adSMarkus Armbruster extra = {'comment': '"%s" = %s' % (self._name(name), name)} 179fb0bc835SMarkus Armbruster name = self._name(name) 180fb0bc835SMarkus Armbruster obj['name'] = name 181fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 182*84bece7dSJohn Snow if features: 183*84bece7dSJohn Snow obj['features'] = self._gen_features(features) 184*84bece7dSJohn Snow self._trees.append(_make_tree(obj, ifcond, extra)) 185fb0bc835SMarkus Armbruster 186fb0bc835SMarkus Armbruster def _gen_member(self, member): 18724cfd6adSMarkus Armbruster obj = {'name': member.name, 'type': self._use_type(member.type)} 188fb0bc835SMarkus Armbruster if member.optional: 18924cfd6adSMarkus Armbruster obj['default'] = None 190*84bece7dSJohn Snow if member.features: 191*84bece7dSJohn Snow obj['features'] = self._gen_features(member.features) 192*84bece7dSJohn Snow return _make_tree(obj, member.ifcond) 193fb0bc835SMarkus Armbruster 194fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 195fb0bc835SMarkus Armbruster return {'tag': tag_name, 196fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 197fb0bc835SMarkus Armbruster 198fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 19924cfd6adSMarkus Armbruster obj = {'case': variant.name, 'type': self._use_type(variant.type)} 200*84bece7dSJohn Snow return _make_tree(obj, variant.ifcond) 201fb0bc835SMarkus Armbruster 202fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 2032e8a843dSMarkus Armbruster self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None) 204fb0bc835SMarkus Armbruster 205013b4efcSMarkus Armbruster def visit_enum_type(self, name, info, ifcond, features, members, prefix): 2062e8a843dSMarkus Armbruster self._gen_tree(name, 'enum', 20724cfd6adSMarkus Armbruster {'values': [_make_tree(m.name, m.ifcond, None) 20824cfd6adSMarkus Armbruster for m in members]}, 209013b4efcSMarkus Armbruster ifcond, features) 210fb0bc835SMarkus Armbruster 211fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 212fb0bc835SMarkus Armbruster element = self._use_type(element_type) 2132e8a843dSMarkus Armbruster self._gen_tree('[' + element + ']', 'array', {'element-type': element}, 214013b4efcSMarkus Armbruster ifcond, None) 215fb0bc835SMarkus Armbruster 2167b3bc9e2SMarkus Armbruster def visit_object_type_flat(self, name, info, ifcond, features, 2177b3bc9e2SMarkus Armbruster members, variants): 218fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 219fb0bc835SMarkus Armbruster if variants: 220fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 221fb0bc835SMarkus Armbruster variants.variants)) 2226a8c0b51SKevin Wolf 2232e8a843dSMarkus Armbruster self._gen_tree(name, 'object', obj, ifcond, features) 224fb0bc835SMarkus Armbruster 225013b4efcSMarkus Armbruster def visit_alternate_type(self, name, info, ifcond, features, variants): 2262e8a843dSMarkus Armbruster self._gen_tree(name, 'alternate', 2278ee06f61SMarc-André Lureau {'members': [ 22824cfd6adSMarkus Armbruster _make_tree({'type': self._use_type(m.type)}, 22924cfd6adSMarkus Armbruster m.ifcond, None) 230013b4efcSMarkus Armbruster for m in variants.variants]}, 231013b4efcSMarkus Armbruster ifcond, features) 232fb0bc835SMarkus Armbruster 2337b3bc9e2SMarkus Armbruster def visit_command(self, name, info, ifcond, features, 2347b3bc9e2SMarkus Armbruster arg_type, ret_type, gen, success_response, boxed, 23504f22362SKevin Wolf allow_oob, allow_preconfig, coroutine): 2366b67bcacSJohn Snow assert self._schema is not None 2376b67bcacSJohn Snow 238fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 239fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 24025b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 24125b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 24225b1ef31SMarkus Armbruster if allow_oob: 24325b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 2442e8a843dSMarkus Armbruster self._gen_tree(name, 'command', obj, ifcond, features) 24523394b4cSPeter Krempa 246013b4efcSMarkus Armbruster def visit_event(self, name, info, ifcond, features, arg_type, boxed): 2476b67bcacSJohn Snow assert self._schema is not None 248fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 2492e8a843dSMarkus Armbruster self._gen_tree(name, 'event', {'arg-type': self._use_type(arg_type)}, 250013b4efcSMarkus Armbruster ifcond, features) 251fb0bc835SMarkus Armbruster 252fb0bc835SMarkus Armbruster 253fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 254fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 255fb0bc835SMarkus Armbruster schema.visit(vis) 25671b3f045SMarkus Armbruster vis.write(output_dir) 257