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 20*67fea575SJohn Snowfrom .schema import ( 21*67fea575SJohn Snow QAPISchemaArrayType, 22*67fea575SJohn Snow QAPISchemaBuiltinType, 23*67fea575SJohn Snow QAPISchemaType, 24*67fea575SJohn Snow) 25fb0bc835SMarkus Armbruster 26fb0bc835SMarkus Armbruster 2724cfd6adSMarkus Armbrusterdef _make_tree(obj, ifcond, features, extra=None): 2824cfd6adSMarkus Armbruster if extra is None: 2924cfd6adSMarkus Armbruster extra = {} 3024cfd6adSMarkus Armbruster if ifcond: 3124cfd6adSMarkus Armbruster extra['if'] = ifcond 3224cfd6adSMarkus Armbruster if features: 3324cfd6adSMarkus Armbruster obj['features'] = [(f.name, {'if': f.ifcond}) for f in features] 3424cfd6adSMarkus Armbruster if extra: 3524cfd6adSMarkus Armbruster return (obj, extra) 3624cfd6adSMarkus Armbruster return obj 3724cfd6adSMarkus Armbruster 3824cfd6adSMarkus Armbruster 392e8a843dSMarkus Armbrusterdef _tree_to_qlit(obj, level=0, suppress_first_indent=False): 407d0f982bSMarc-André Lureau 417d0f982bSMarc-André Lureau def indent(level): 427d0f982bSMarc-André Lureau return level * 4 * ' ' 437d0f982bSMarc-André Lureau 44d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 458c643361SEric Blake ifobj, extra = obj 468c643361SEric Blake ifcond = extra.get('if') 478c643361SEric Blake comment = extra.get('comment') 488c643361SEric Blake ret = '' 498c643361SEric Blake if comment: 508c643361SEric Blake ret += indent(level) + '/* %s */\n' % comment 518c643361SEric Blake if ifcond: 528c643361SEric Blake ret += gen_if(ifcond) 532e8a843dSMarkus Armbruster ret += _tree_to_qlit(ifobj, level) 548c643361SEric Blake if ifcond: 558c643361SEric Blake ret += '\n' + gen_endif(ifcond) 56d626b6c1SMarc-André Lureau return ret 57d626b6c1SMarc-André Lureau 587d0f982bSMarc-André Lureau ret = '' 597d0f982bSMarc-André Lureau if not suppress_first_indent: 607d0f982bSMarc-André Lureau ret += indent(level) 61fb0bc835SMarkus Armbruster if obj is None: 627d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 63fb0bc835SMarkus Armbruster elif isinstance(obj, str): 647d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 65fb0bc835SMarkus Armbruster elif isinstance(obj, list): 662e8a843dSMarkus Armbruster elts = [_tree_to_qlit(elt, level + 1).strip('\n') 67fb0bc835SMarkus Armbruster for elt in obj] 687d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 697d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 7040bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 717d0f982bSMarc-André Lureau ret += indent(level) + '}))' 72fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 737d0f982bSMarc-André Lureau elts = [] 747d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 757d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 762e8a843dSMarkus Armbruster (to_c_string(key), 772e8a843dSMarkus Armbruster _tree_to_qlit(value, level + 1, True))) 787d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 797d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 807d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 817d0f982bSMarc-André Lureau ret += indent(level) + '}))' 82876c6751SPeter Xu elif isinstance(obj, bool): 83876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 84fb0bc835SMarkus Armbruster else: 85fb0bc835SMarkus Armbruster assert False # not implemented 8640bb1376SMarc-André Lureau if level > 0: 8740bb1376SMarc-André Lureau ret += ',' 88fb0bc835SMarkus Armbruster return ret 89fb0bc835SMarkus Armbruster 90fb0bc835SMarkus Armbruster 91fb0bc835SMarkus Armbrusterdef to_c_string(string): 92fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 93fb0bc835SMarkus Armbruster 94fb0bc835SMarkus Armbruster 9571b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 96fb0bc835SMarkus Armbruster 9771b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 982cae67bcSMarkus Armbruster super().__init__( 992cae67bcSMarkus Armbruster prefix, 'qapi-introspect', 10071b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 10171b3f045SMarkus Armbruster self._unmask = unmask 10271b3f045SMarkus Armbruster self._schema = None 1032e8a843dSMarkus Armbruster self._trees = [] 104fb0bc835SMarkus Armbruster self._used_types = [] 105fb0bc835SMarkus Armbruster self._name_map = {} 10671b3f045SMarkus Armbruster self._genc.add(mcgen(''' 10771b3f045SMarkus Armbruster#include "qemu/osdep.h" 108eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 10971b3f045SMarkus Armbruster 11071b3f045SMarkus Armbruster''', 11171b3f045SMarkus Armbruster prefix=prefix)) 11271b3f045SMarkus Armbruster 11371b3f045SMarkus Armbruster def visit_begin(self, schema): 11471b3f045SMarkus Armbruster self._schema = schema 115fb0bc835SMarkus Armbruster 116fb0bc835SMarkus Armbruster def visit_end(self): 117fb0bc835SMarkus Armbruster # visit the types that are actually used 118fb0bc835SMarkus Armbruster for typ in self._used_types: 119fb0bc835SMarkus Armbruster typ.visit(self) 120fb0bc835SMarkus Armbruster # generate C 1217d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 12271b3f045SMarkus Armbruster self._genh.add(mcgen(''' 1237d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 1247d0f982bSMarc-André Lureau 1257d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 126fb0bc835SMarkus Armbruster''', 12771b3f045SMarkus Armbruster c_name=c_name(name))) 12871b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1297d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 130fb0bc835SMarkus Armbruster''', 131fb0bc835SMarkus Armbruster c_name=c_name(name), 1322e8a843dSMarkus Armbruster c_string=_tree_to_qlit(self._trees))) 133fb0bc835SMarkus Armbruster self._schema = None 1342e8a843dSMarkus Armbruster self._trees = [] 13571b3f045SMarkus Armbruster self._used_types = [] 13671b3f045SMarkus Armbruster self._name_map = {} 137fb0bc835SMarkus Armbruster 138fb0bc835SMarkus Armbruster def visit_needed(self, entity): 139fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 140fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 141fb0bc835SMarkus Armbruster 142fb0bc835SMarkus Armbruster def _name(self, name): 143fb0bc835SMarkus Armbruster if self._unmask: 144fb0bc835SMarkus Armbruster return name 145fb0bc835SMarkus Armbruster if name not in self._name_map: 146fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 147fb0bc835SMarkus Armbruster return self._name_map[name] 148fb0bc835SMarkus Armbruster 149fb0bc835SMarkus Armbruster def _use_type(self, typ): 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 1682e8a843dSMarkus Armbruster def _gen_tree(self, name, mtype, obj, ifcond, features): 16924cfd6adSMarkus Armbruster extra = None 170fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 1718c643361SEric Blake if not self._unmask: 1728c643361SEric Blake # Output a comment to make it easy to map masked names 1738c643361SEric Blake # back to the source when reading the generated output. 17424cfd6adSMarkus Armbruster extra = {'comment': '"%s" = %s' % (self._name(name), name)} 175fb0bc835SMarkus Armbruster name = self._name(name) 176fb0bc835SMarkus Armbruster obj['name'] = name 177fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 17824cfd6adSMarkus Armbruster self._trees.append(_make_tree(obj, ifcond, features, extra)) 179fb0bc835SMarkus Armbruster 180fb0bc835SMarkus Armbruster def _gen_member(self, member): 18124cfd6adSMarkus Armbruster obj = {'name': member.name, 'type': self._use_type(member.type)} 182fb0bc835SMarkus Armbruster if member.optional: 18324cfd6adSMarkus Armbruster obj['default'] = None 18484ab0086SMarkus Armbruster return _make_tree(obj, member.ifcond, member.features) 185fb0bc835SMarkus Armbruster 186fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 187fb0bc835SMarkus Armbruster return {'tag': tag_name, 188fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 189fb0bc835SMarkus Armbruster 190fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 19124cfd6adSMarkus Armbruster obj = {'case': variant.name, 'type': self._use_type(variant.type)} 19224cfd6adSMarkus Armbruster return _make_tree(obj, variant.ifcond, None) 193fb0bc835SMarkus Armbruster 194fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 1952e8a843dSMarkus Armbruster self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None) 196fb0bc835SMarkus Armbruster 197013b4efcSMarkus Armbruster def visit_enum_type(self, name, info, ifcond, features, members, prefix): 1982e8a843dSMarkus Armbruster self._gen_tree(name, 'enum', 19924cfd6adSMarkus Armbruster {'values': [_make_tree(m.name, m.ifcond, None) 20024cfd6adSMarkus Armbruster for m in members]}, 201013b4efcSMarkus Armbruster ifcond, features) 202fb0bc835SMarkus Armbruster 203fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 204fb0bc835SMarkus Armbruster element = self._use_type(element_type) 2052e8a843dSMarkus Armbruster self._gen_tree('[' + element + ']', 'array', {'element-type': element}, 206013b4efcSMarkus Armbruster ifcond, None) 207fb0bc835SMarkus Armbruster 2087b3bc9e2SMarkus Armbruster def visit_object_type_flat(self, name, info, ifcond, features, 2097b3bc9e2SMarkus Armbruster members, variants): 210fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 211fb0bc835SMarkus Armbruster if variants: 212fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 213fb0bc835SMarkus Armbruster variants.variants)) 2146a8c0b51SKevin Wolf 2152e8a843dSMarkus Armbruster self._gen_tree(name, 'object', obj, ifcond, features) 216fb0bc835SMarkus Armbruster 217013b4efcSMarkus Armbruster def visit_alternate_type(self, name, info, ifcond, features, variants): 2182e8a843dSMarkus Armbruster self._gen_tree(name, 'alternate', 2198ee06f61SMarc-André Lureau {'members': [ 22024cfd6adSMarkus Armbruster _make_tree({'type': self._use_type(m.type)}, 22124cfd6adSMarkus Armbruster m.ifcond, None) 222013b4efcSMarkus Armbruster for m in variants.variants]}, 223013b4efcSMarkus Armbruster ifcond, features) 224fb0bc835SMarkus Armbruster 2257b3bc9e2SMarkus Armbruster def visit_command(self, name, info, ifcond, features, 2267b3bc9e2SMarkus Armbruster arg_type, ret_type, gen, success_response, boxed, 22704f22362SKevin Wolf allow_oob, allow_preconfig, coroutine): 228fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 229fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 23025b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 23125b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 23225b1ef31SMarkus Armbruster if allow_oob: 23325b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 2342e8a843dSMarkus Armbruster self._gen_tree(name, 'command', obj, ifcond, features) 23523394b4cSPeter Krempa 236013b4efcSMarkus Armbruster def visit_event(self, name, info, ifcond, features, arg_type, boxed): 237fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 2382e8a843dSMarkus Armbruster self._gen_tree(name, 'event', {'arg-type': self._use_type(arg_type)}, 239013b4efcSMarkus Armbruster ifcond, features) 240fb0bc835SMarkus Armbruster 241fb0bc835SMarkus Armbruster 242fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 243fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 244fb0bc835SMarkus Armbruster schema.visit(vis) 24571b3f045SMarkus Armbruster vis.write(output_dir) 246