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 13e6c42b96SMarkus Armbrusterimport string 14e6c42b96SMarkus Armbruster 15fb0bc835SMarkus Armbrusterfrom qapi.common import * 16e6c42b96SMarkus Armbrusterfrom qapi.gen import QAPISchemaMonolithicCVisitor 17e6c42b96SMarkus Armbrusterfrom qapi.schema import (QAPISchemaArrayType, QAPISchemaBuiltinType, 18e6c42b96SMarkus Armbruster QAPISchemaType) 19fb0bc835SMarkus Armbruster 20fb0bc835SMarkus Armbruster 217d0f982bSMarc-André Lureaudef to_qlit(obj, level=0, suppress_first_indent=False): 227d0f982bSMarc-André Lureau 237d0f982bSMarc-André Lureau def indent(level): 247d0f982bSMarc-André Lureau return level * 4 * ' ' 257d0f982bSMarc-André Lureau 26d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 278c643361SEric Blake ifobj, extra = obj 288c643361SEric Blake ifcond = extra.get('if') 298c643361SEric Blake comment = extra.get('comment') 308c643361SEric Blake ret = '' 318c643361SEric Blake if comment: 328c643361SEric Blake ret += indent(level) + '/* %s */\n' % comment 338c643361SEric Blake if ifcond: 348c643361SEric Blake ret += gen_if(ifcond) 35d626b6c1SMarc-André Lureau ret += to_qlit(ifobj, level) 368c643361SEric Blake if ifcond: 378c643361SEric Blake ret += '\n' + gen_endif(ifcond) 38d626b6c1SMarc-André Lureau return ret 39d626b6c1SMarc-André Lureau 407d0f982bSMarc-André Lureau ret = '' 417d0f982bSMarc-André Lureau if not suppress_first_indent: 427d0f982bSMarc-André Lureau ret += indent(level) 43fb0bc835SMarkus Armbruster if obj is None: 447d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 45fb0bc835SMarkus Armbruster elif isinstance(obj, str): 467d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 47fb0bc835SMarkus Armbruster elif isinstance(obj, list): 48d626b6c1SMarc-André Lureau elts = [to_qlit(elt, level + 1).strip('\n') 49fb0bc835SMarkus Armbruster for elt in obj] 507d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 517d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 5240bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 537d0f982bSMarc-André Lureau ret += indent(level) + '}))' 54fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 557d0f982bSMarc-André Lureau elts = [] 567d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 577d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 587d0f982bSMarc-André Lureau (to_c_string(key), to_qlit(value, level + 1, True))) 597d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 607d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 617d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 627d0f982bSMarc-André Lureau ret += indent(level) + '}))' 63876c6751SPeter Xu elif isinstance(obj, bool): 64876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 65fb0bc835SMarkus Armbruster else: 66fb0bc835SMarkus Armbruster assert False # not implemented 6740bb1376SMarc-André Lureau if level > 0: 6840bb1376SMarc-André Lureau ret += ',' 69fb0bc835SMarkus Armbruster return ret 70fb0bc835SMarkus Armbruster 71fb0bc835SMarkus Armbruster 72fb0bc835SMarkus Armbrusterdef to_c_string(string): 73fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 74fb0bc835SMarkus Armbruster 75fb0bc835SMarkus Armbruster 7671b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 77fb0bc835SMarkus Armbruster 7871b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 7971b3f045SMarkus Armbruster QAPISchemaMonolithicCVisitor.__init__( 80eb815e24SMarkus Armbruster self, prefix, 'qapi-introspect', 8171b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 8271b3f045SMarkus Armbruster self._unmask = unmask 8371b3f045SMarkus Armbruster self._schema = None 847d0f982bSMarc-André Lureau self._qlits = [] 85fb0bc835SMarkus Armbruster self._used_types = [] 86fb0bc835SMarkus Armbruster self._name_map = {} 8771b3f045SMarkus Armbruster self._genc.add(mcgen(''' 8871b3f045SMarkus Armbruster#include "qemu/osdep.h" 89eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 9071b3f045SMarkus Armbruster 9171b3f045SMarkus Armbruster''', 9271b3f045SMarkus Armbruster prefix=prefix)) 9371b3f045SMarkus Armbruster 9471b3f045SMarkus Armbruster def visit_begin(self, schema): 9571b3f045SMarkus Armbruster self._schema = schema 96fb0bc835SMarkus Armbruster 97fb0bc835SMarkus Armbruster def visit_end(self): 98fb0bc835SMarkus Armbruster # visit the types that are actually used 99fb0bc835SMarkus Armbruster for typ in self._used_types: 100fb0bc835SMarkus Armbruster typ.visit(self) 101fb0bc835SMarkus Armbruster # generate C 1027d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 10371b3f045SMarkus Armbruster self._genh.add(mcgen(''' 1047d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 1057d0f982bSMarc-André Lureau 1067d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 107fb0bc835SMarkus Armbruster''', 10871b3f045SMarkus Armbruster c_name=c_name(name))) 10971b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1107d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 111fb0bc835SMarkus Armbruster''', 112fb0bc835SMarkus Armbruster c_name=c_name(name), 113da112e83SMarkus Armbruster c_string=to_qlit(self._qlits))) 114fb0bc835SMarkus Armbruster self._schema = None 1157d0f982bSMarc-André Lureau self._qlits = [] 11671b3f045SMarkus Armbruster self._used_types = [] 11771b3f045SMarkus Armbruster self._name_map = {} 118fb0bc835SMarkus Armbruster 119fb0bc835SMarkus Armbruster def visit_needed(self, entity): 120fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 121fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 122fb0bc835SMarkus Armbruster 123fb0bc835SMarkus Armbruster def _name(self, name): 124fb0bc835SMarkus Armbruster if self._unmask: 125fb0bc835SMarkus Armbruster return name 126fb0bc835SMarkus Armbruster if name not in self._name_map: 127fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 128fb0bc835SMarkus Armbruster return self._name_map[name] 129fb0bc835SMarkus Armbruster 130fb0bc835SMarkus Armbruster def _use_type(self, typ): 131fb0bc835SMarkus Armbruster # Map the various integer types to plain int 132fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 133fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 134fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 135fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 136fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 137fb0bc835SMarkus Armbruster # Add type to work queue if new 138fb0bc835SMarkus Armbruster if typ not in self._used_types: 139fb0bc835SMarkus Armbruster self._used_types.append(typ) 140fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 1411aa806ccSEric Blake # type names as integers to reduce the temptation. Also, it 1421aa806ccSEric Blake # saves a few characters on the wire. 143fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 144fb0bc835SMarkus Armbruster return typ.name 145fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 146fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 147fb0bc835SMarkus Armbruster return self._name(typ.name) 148fb0bc835SMarkus Armbruster 149d626b6c1SMarc-André Lureau def _gen_qlit(self, name, mtype, obj, ifcond): 1508c643361SEric Blake extra = {} 151fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 1528c643361SEric Blake if not self._unmask: 1538c643361SEric Blake # Output a comment to make it easy to map masked names 1548c643361SEric Blake # back to the source when reading the generated output. 1558c643361SEric Blake extra['comment'] = '"%s" = %s' % (self._name(name), name) 156fb0bc835SMarkus Armbruster name = self._name(name) 157fb0bc835SMarkus Armbruster obj['name'] = name 158fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 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): 183d626b6c1SMarc-André Lureau self._gen_qlit(name, 'builtin', {'json-type': json_type}, []) 184fb0bc835SMarkus Armbruster 1851962bd39SMarc-André Lureau def visit_enum_type(self, name, info, ifcond, 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]}, 1898ee06f61SMarc-André Lureau ifcond) 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}, 194d626b6c1SMarc-André Lureau ifcond) 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 if features: 2036a8c0b51SKevin Wolf obj['features'] = [(f.name, {'if': f.ifcond}) for f in features] 2046a8c0b51SKevin Wolf 205d626b6c1SMarc-André Lureau self._gen_qlit(name, 'object', obj, ifcond) 206fb0bc835SMarkus Armbruster 207fbf09a2fSMarc-André Lureau def visit_alternate_type(self, name, info, ifcond, variants): 2087d0f982bSMarc-André Lureau self._gen_qlit(name, 'alternate', 2098ee06f61SMarc-André Lureau {'members': [ 2108ee06f61SMarc-André Lureau ({'type': self._use_type(m.type)}, {'if': m.ifcond}) 211d626b6c1SMarc-André Lureau for m in variants.variants]}, ifcond) 212fb0bc835SMarkus Armbruster 213fbf09a2fSMarc-André Lureau def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, 214*23394b4cSPeter Krempa success_response, boxed, allow_oob, allow_preconfig, 215*23394b4cSPeter Krempa features): 216fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 217fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 21825b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 21925b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 22025b1ef31SMarkus Armbruster if allow_oob: 22125b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 222*23394b4cSPeter Krempa 223*23394b4cSPeter Krempa if features: 224*23394b4cSPeter Krempa obj['features'] = [(f.name, {'if': f.ifcond}) for f in features] 225*23394b4cSPeter Krempa 22625b1ef31SMarkus Armbruster self._gen_qlit(name, 'command', obj, ifcond) 227fb0bc835SMarkus Armbruster 228fbf09a2fSMarc-André Lureau def visit_event(self, name, info, ifcond, arg_type, boxed): 229fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 230d626b6c1SMarc-André Lureau self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)}, 231d626b6c1SMarc-André Lureau ifcond) 232fb0bc835SMarkus Armbruster 233fb0bc835SMarkus Armbruster 234fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 235fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 236fb0bc835SMarkus Armbruster schema.visit(vis) 23771b3f045SMarkus Armbruster vis.write(output_dir) 238