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 13fb0bc835SMarkus Armbrusterfrom qapi.common import * 14e6c42b96SMarkus Armbrusterfrom qapi.gen import QAPISchemaMonolithicCVisitor 15e6c42b96SMarkus Armbrusterfrom qapi.schema import (QAPISchemaArrayType, QAPISchemaBuiltinType, 16e6c42b96SMarkus Armbruster QAPISchemaType) 17fb0bc835SMarkus Armbruster 18fb0bc835SMarkus Armbruster 197d0f982bSMarc-André Lureaudef to_qlit(obj, level=0, suppress_first_indent=False): 207d0f982bSMarc-André Lureau 217d0f982bSMarc-André Lureau def indent(level): 227d0f982bSMarc-André Lureau return level * 4 * ' ' 237d0f982bSMarc-André Lureau 24d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 258c643361SEric Blake ifobj, extra = obj 268c643361SEric Blake ifcond = extra.get('if') 278c643361SEric Blake comment = extra.get('comment') 288c643361SEric Blake ret = '' 298c643361SEric Blake if comment: 308c643361SEric Blake ret += indent(level) + '/* %s */\n' % comment 318c643361SEric Blake if ifcond: 328c643361SEric Blake ret += gen_if(ifcond) 33d626b6c1SMarc-André Lureau ret += to_qlit(ifobj, level) 348c643361SEric Blake if ifcond: 358c643361SEric Blake ret += '\n' + gen_endif(ifcond) 36d626b6c1SMarc-André Lureau return ret 37d626b6c1SMarc-André Lureau 387d0f982bSMarc-André Lureau ret = '' 397d0f982bSMarc-André Lureau if not suppress_first_indent: 407d0f982bSMarc-André Lureau ret += indent(level) 41fb0bc835SMarkus Armbruster if obj is None: 427d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 43fb0bc835SMarkus Armbruster elif isinstance(obj, str): 447d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 45fb0bc835SMarkus Armbruster elif isinstance(obj, list): 46d626b6c1SMarc-André Lureau elts = [to_qlit(elt, level + 1).strip('\n') 47fb0bc835SMarkus Armbruster for elt in obj] 487d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 497d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 5040bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 517d0f982bSMarc-André Lureau ret += indent(level) + '}))' 52fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 537d0f982bSMarc-André Lureau elts = [] 547d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 557d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 567d0f982bSMarc-André Lureau (to_c_string(key), to_qlit(value, level + 1, True))) 577d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 587d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 597d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 607d0f982bSMarc-André Lureau ret += indent(level) + '}))' 61876c6751SPeter Xu elif isinstance(obj, bool): 62876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 63fb0bc835SMarkus Armbruster else: 64fb0bc835SMarkus Armbruster assert False # not implemented 6540bb1376SMarc-André Lureau if level > 0: 6640bb1376SMarc-André Lureau ret += ',' 67fb0bc835SMarkus Armbruster return ret 68fb0bc835SMarkus Armbruster 69fb0bc835SMarkus Armbruster 70fb0bc835SMarkus Armbrusterdef to_c_string(string): 71fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 72fb0bc835SMarkus Armbruster 73fb0bc835SMarkus Armbruster 7471b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 75fb0bc835SMarkus Armbruster 7671b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 772cae67bcSMarkus Armbruster super().__init__( 782cae67bcSMarkus Armbruster prefix, 'qapi-introspect', 7971b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 8071b3f045SMarkus Armbruster self._unmask = unmask 8171b3f045SMarkus Armbruster self._schema = None 827d0f982bSMarc-André Lureau self._qlits = [] 83fb0bc835SMarkus Armbruster self._used_types = [] 84fb0bc835SMarkus Armbruster self._name_map = {} 8571b3f045SMarkus Armbruster self._genc.add(mcgen(''' 8671b3f045SMarkus Armbruster#include "qemu/osdep.h" 87eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 8871b3f045SMarkus Armbruster 8971b3f045SMarkus Armbruster''', 9071b3f045SMarkus Armbruster prefix=prefix)) 9171b3f045SMarkus Armbruster 9271b3f045SMarkus Armbruster def visit_begin(self, schema): 9371b3f045SMarkus Armbruster self._schema = schema 94fb0bc835SMarkus Armbruster 95fb0bc835SMarkus Armbruster def visit_end(self): 96fb0bc835SMarkus Armbruster # visit the types that are actually used 97fb0bc835SMarkus Armbruster for typ in self._used_types: 98fb0bc835SMarkus Armbruster typ.visit(self) 99fb0bc835SMarkus Armbruster # generate C 1007d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 10171b3f045SMarkus Armbruster self._genh.add(mcgen(''' 1027d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 1037d0f982bSMarc-André Lureau 1047d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 105fb0bc835SMarkus Armbruster''', 10671b3f045SMarkus Armbruster c_name=c_name(name))) 10771b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1087d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 109fb0bc835SMarkus Armbruster''', 110fb0bc835SMarkus Armbruster c_name=c_name(name), 111da112e83SMarkus Armbruster c_string=to_qlit(self._qlits))) 112fb0bc835SMarkus Armbruster self._schema = None 1137d0f982bSMarc-André Lureau self._qlits = [] 11471b3f045SMarkus Armbruster self._used_types = [] 11571b3f045SMarkus Armbruster self._name_map = {} 116fb0bc835SMarkus Armbruster 117fb0bc835SMarkus Armbruster def visit_needed(self, entity): 118fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 119fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 120fb0bc835SMarkus Armbruster 121fb0bc835SMarkus Armbruster def _name(self, name): 122fb0bc835SMarkus Armbruster if self._unmask: 123fb0bc835SMarkus Armbruster return name 124fb0bc835SMarkus Armbruster if name not in self._name_map: 125fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 126fb0bc835SMarkus Armbruster return self._name_map[name] 127fb0bc835SMarkus Armbruster 128fb0bc835SMarkus Armbruster def _use_type(self, typ): 129fb0bc835SMarkus Armbruster # Map the various integer types to plain int 130fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 131fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 132fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 133fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 134fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 135fb0bc835SMarkus Armbruster # Add type to work queue if new 136fb0bc835SMarkus Armbruster if typ not in self._used_types: 137fb0bc835SMarkus Armbruster self._used_types.append(typ) 138fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 1391aa806ccSEric Blake # type names as integers to reduce the temptation. Also, it 1401aa806ccSEric Blake # saves a few characters on the wire. 141fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 142fb0bc835SMarkus Armbruster return typ.name 143fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 144fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 145fb0bc835SMarkus Armbruster return self._name(typ.name) 146fb0bc835SMarkus Armbruster 147*013b4efcSMarkus Armbruster def _gen_qlit(self, name, mtype, obj, ifcond, features): 1488c643361SEric Blake extra = {} 149fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 1508c643361SEric Blake if not self._unmask: 1518c643361SEric Blake # Output a comment to make it easy to map masked names 1528c643361SEric Blake # back to the source when reading the generated output. 1538c643361SEric Blake extra['comment'] = '"%s" = %s' % (self._name(name), name) 154fb0bc835SMarkus Armbruster name = self._name(name) 155fb0bc835SMarkus Armbruster obj['name'] = name 156fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 157*013b4efcSMarkus Armbruster if features: 158*013b4efcSMarkus Armbruster obj['features'] = [(f.name, {'if': f.ifcond}) for f in features] 1598c643361SEric Blake if ifcond: 1608c643361SEric Blake extra['if'] = ifcond 1618c643361SEric Blake if extra: 1628c643361SEric Blake self._qlits.append((obj, extra)) 1638c643361SEric Blake else: 1648c643361SEric Blake self._qlits.append(obj) 165fb0bc835SMarkus Armbruster 166fb0bc835SMarkus Armbruster def _gen_member(self, member): 167fb0bc835SMarkus Armbruster ret = {'name': member.name, 'type': self._use_type(member.type)} 168fb0bc835SMarkus Armbruster if member.optional: 169fb0bc835SMarkus Armbruster ret['default'] = None 1708ee06f61SMarc-André Lureau if member.ifcond: 1718ee06f61SMarc-André Lureau ret = (ret, {'if': member.ifcond}) 172fb0bc835SMarkus Armbruster return ret 173fb0bc835SMarkus Armbruster 174fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 175fb0bc835SMarkus Armbruster return {'tag': tag_name, 176fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 177fb0bc835SMarkus Armbruster 178fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 1798ee06f61SMarc-André Lureau return ({'case': variant.name, 'type': self._use_type(variant.type)}, 1808ee06f61SMarc-André Lureau {'if': variant.ifcond}) 181fb0bc835SMarkus Armbruster 182fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 183*013b4efcSMarkus Armbruster self._gen_qlit(name, 'builtin', {'json-type': json_type}, [], None) 184fb0bc835SMarkus Armbruster 185*013b4efcSMarkus Armbruster def visit_enum_type(self, name, info, ifcond, features, members, prefix): 1861962bd39SMarc-André Lureau self._gen_qlit(name, 'enum', 1878ee06f61SMarc-André Lureau {'values': 1888ee06f61SMarc-André Lureau [(m.name, {'if': m.ifcond}) for m in members]}, 189*013b4efcSMarkus Armbruster ifcond, features) 190fb0bc835SMarkus Armbruster 191fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 192fb0bc835SMarkus Armbruster element = self._use_type(element_type) 193d626b6c1SMarc-André Lureau self._gen_qlit('[' + element + ']', 'array', {'element-type': element}, 194*013b4efcSMarkus Armbruster ifcond, None) 195fb0bc835SMarkus Armbruster 1966a8c0b51SKevin Wolf def visit_object_type_flat(self, name, info, ifcond, members, variants, 1976a8c0b51SKevin Wolf features): 198fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 199fb0bc835SMarkus Armbruster if variants: 200fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 201fb0bc835SMarkus Armbruster variants.variants)) 2026a8c0b51SKevin Wolf 203*013b4efcSMarkus Armbruster self._gen_qlit(name, 'object', obj, ifcond, features) 204fb0bc835SMarkus Armbruster 205*013b4efcSMarkus Armbruster def visit_alternate_type(self, name, info, ifcond, features, variants): 2067d0f982bSMarc-André Lureau self._gen_qlit(name, 'alternate', 2078ee06f61SMarc-André Lureau {'members': [ 2088ee06f61SMarc-André Lureau ({'type': self._use_type(m.type)}, {'if': m.ifcond}) 209*013b4efcSMarkus Armbruster for m in variants.variants]}, 210*013b4efcSMarkus Armbruster ifcond, features) 211fb0bc835SMarkus Armbruster 212fbf09a2fSMarc-André Lureau def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, 21323394b4cSPeter Krempa success_response, boxed, allow_oob, allow_preconfig, 21423394b4cSPeter Krempa features): 215fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 216fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 21725b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 21825b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 21925b1ef31SMarkus Armbruster if allow_oob: 22025b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 221*013b4efcSMarkus Armbruster self._gen_qlit(name, 'command', obj, ifcond, features) 22223394b4cSPeter Krempa 223*013b4efcSMarkus Armbruster def visit_event(self, name, info, ifcond, features, arg_type, boxed): 224fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 225d626b6c1SMarc-André Lureau self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)}, 226*013b4efcSMarkus Armbruster ifcond, features) 227fb0bc835SMarkus Armbruster 228fb0bc835SMarkus Armbruster 229fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 230fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 231fb0bc835SMarkus Armbruster schema.visit(vis) 23271b3f045SMarkus Armbruster vis.write(output_dir) 233