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 13*7137a960SJohn Snowfrom .common import * 14*7137a960SJohn Snowfrom .gen import QAPISchemaMonolithicCVisitor 15*7137a960SJohn Snowfrom .schema import (QAPISchemaArrayType, QAPISchemaBuiltinType, 16e6c42b96SMarkus Armbruster QAPISchemaType) 17fb0bc835SMarkus Armbruster 18fb0bc835SMarkus Armbruster 1924cfd6adSMarkus Armbrusterdef _make_tree(obj, ifcond, features, extra=None): 2024cfd6adSMarkus Armbruster if extra is None: 2124cfd6adSMarkus Armbruster extra = {} 2224cfd6adSMarkus Armbruster if ifcond: 2324cfd6adSMarkus Armbruster extra['if'] = ifcond 2424cfd6adSMarkus Armbruster if features: 2524cfd6adSMarkus Armbruster obj['features'] = [(f.name, {'if': f.ifcond}) for f in features] 2624cfd6adSMarkus Armbruster if extra: 2724cfd6adSMarkus Armbruster return (obj, extra) 2824cfd6adSMarkus Armbruster return obj 2924cfd6adSMarkus Armbruster 3024cfd6adSMarkus Armbruster 312e8a843dSMarkus Armbrusterdef _tree_to_qlit(obj, level=0, suppress_first_indent=False): 327d0f982bSMarc-André Lureau 337d0f982bSMarc-André Lureau def indent(level): 347d0f982bSMarc-André Lureau return level * 4 * ' ' 357d0f982bSMarc-André Lureau 36d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 378c643361SEric Blake ifobj, extra = obj 388c643361SEric Blake ifcond = extra.get('if') 398c643361SEric Blake comment = extra.get('comment') 408c643361SEric Blake ret = '' 418c643361SEric Blake if comment: 428c643361SEric Blake ret += indent(level) + '/* %s */\n' % comment 438c643361SEric Blake if ifcond: 448c643361SEric Blake ret += gen_if(ifcond) 452e8a843dSMarkus Armbruster ret += _tree_to_qlit(ifobj, level) 468c643361SEric Blake if ifcond: 478c643361SEric Blake ret += '\n' + gen_endif(ifcond) 48d626b6c1SMarc-André Lureau return ret 49d626b6c1SMarc-André Lureau 507d0f982bSMarc-André Lureau ret = '' 517d0f982bSMarc-André Lureau if not suppress_first_indent: 527d0f982bSMarc-André Lureau ret += indent(level) 53fb0bc835SMarkus Armbruster if obj is None: 547d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 55fb0bc835SMarkus Armbruster elif isinstance(obj, str): 567d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 57fb0bc835SMarkus Armbruster elif isinstance(obj, list): 582e8a843dSMarkus Armbruster elts = [_tree_to_qlit(elt, level + 1).strip('\n') 59fb0bc835SMarkus Armbruster for elt in obj] 607d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 617d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 6240bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 637d0f982bSMarc-André Lureau ret += indent(level) + '}))' 64fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 657d0f982bSMarc-André Lureau elts = [] 667d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 677d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 682e8a843dSMarkus Armbruster (to_c_string(key), 692e8a843dSMarkus Armbruster _tree_to_qlit(value, level + 1, True))) 707d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 717d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 727d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 737d0f982bSMarc-André Lureau ret += indent(level) + '}))' 74876c6751SPeter Xu elif isinstance(obj, bool): 75876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 76fb0bc835SMarkus Armbruster else: 77fb0bc835SMarkus Armbruster assert False # not implemented 7840bb1376SMarc-André Lureau if level > 0: 7940bb1376SMarc-André Lureau ret += ',' 80fb0bc835SMarkus Armbruster return ret 81fb0bc835SMarkus Armbruster 82fb0bc835SMarkus Armbruster 83fb0bc835SMarkus Armbrusterdef to_c_string(string): 84fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 85fb0bc835SMarkus Armbruster 86fb0bc835SMarkus Armbruster 8771b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 88fb0bc835SMarkus Armbruster 8971b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 902cae67bcSMarkus Armbruster super().__init__( 912cae67bcSMarkus Armbruster prefix, 'qapi-introspect', 9271b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 9371b3f045SMarkus Armbruster self._unmask = unmask 9471b3f045SMarkus Armbruster self._schema = None 952e8a843dSMarkus Armbruster self._trees = [] 96fb0bc835SMarkus Armbruster self._used_types = [] 97fb0bc835SMarkus Armbruster self._name_map = {} 9871b3f045SMarkus Armbruster self._genc.add(mcgen(''' 9971b3f045SMarkus Armbruster#include "qemu/osdep.h" 100eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 10171b3f045SMarkus Armbruster 10271b3f045SMarkus Armbruster''', 10371b3f045SMarkus Armbruster prefix=prefix)) 10471b3f045SMarkus Armbruster 10571b3f045SMarkus Armbruster def visit_begin(self, schema): 10671b3f045SMarkus Armbruster self._schema = schema 107fb0bc835SMarkus Armbruster 108fb0bc835SMarkus Armbruster def visit_end(self): 109fb0bc835SMarkus Armbruster # visit the types that are actually used 110fb0bc835SMarkus Armbruster for typ in self._used_types: 111fb0bc835SMarkus Armbruster typ.visit(self) 112fb0bc835SMarkus Armbruster # generate C 1137d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 11471b3f045SMarkus Armbruster self._genh.add(mcgen(''' 1157d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 1167d0f982bSMarc-André Lureau 1177d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 118fb0bc835SMarkus Armbruster''', 11971b3f045SMarkus Armbruster c_name=c_name(name))) 12071b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1217d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 122fb0bc835SMarkus Armbruster''', 123fb0bc835SMarkus Armbruster c_name=c_name(name), 1242e8a843dSMarkus Armbruster c_string=_tree_to_qlit(self._trees))) 125fb0bc835SMarkus Armbruster self._schema = None 1262e8a843dSMarkus Armbruster self._trees = [] 12771b3f045SMarkus Armbruster self._used_types = [] 12871b3f045SMarkus Armbruster self._name_map = {} 129fb0bc835SMarkus Armbruster 130fb0bc835SMarkus Armbruster def visit_needed(self, entity): 131fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 132fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 133fb0bc835SMarkus Armbruster 134fb0bc835SMarkus Armbruster def _name(self, name): 135fb0bc835SMarkus Armbruster if self._unmask: 136fb0bc835SMarkus Armbruster return name 137fb0bc835SMarkus Armbruster if name not in self._name_map: 138fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 139fb0bc835SMarkus Armbruster return self._name_map[name] 140fb0bc835SMarkus Armbruster 141fb0bc835SMarkus Armbruster def _use_type(self, typ): 142fb0bc835SMarkus Armbruster # Map the various integer types to plain int 143fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 144fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 145fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 146fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 147fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 148fb0bc835SMarkus Armbruster # Add type to work queue if new 149fb0bc835SMarkus Armbruster if typ not in self._used_types: 150fb0bc835SMarkus Armbruster self._used_types.append(typ) 151fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 1521aa806ccSEric Blake # type names as integers to reduce the temptation. Also, it 1531aa806ccSEric Blake # saves a few characters on the wire. 154fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 155fb0bc835SMarkus Armbruster return typ.name 156fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 157fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 158fb0bc835SMarkus Armbruster return self._name(typ.name) 159fb0bc835SMarkus Armbruster 1602e8a843dSMarkus Armbruster def _gen_tree(self, name, mtype, obj, ifcond, features): 16124cfd6adSMarkus Armbruster extra = None 162fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 1638c643361SEric Blake if not self._unmask: 1648c643361SEric Blake # Output a comment to make it easy to map masked names 1658c643361SEric Blake # back to the source when reading the generated output. 16624cfd6adSMarkus Armbruster extra = {'comment': '"%s" = %s' % (self._name(name), name)} 167fb0bc835SMarkus Armbruster name = self._name(name) 168fb0bc835SMarkus Armbruster obj['name'] = name 169fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 17024cfd6adSMarkus Armbruster self._trees.append(_make_tree(obj, ifcond, features, extra)) 171fb0bc835SMarkus Armbruster 172fb0bc835SMarkus Armbruster def _gen_member(self, member): 17324cfd6adSMarkus Armbruster obj = {'name': member.name, 'type': self._use_type(member.type)} 174fb0bc835SMarkus Armbruster if member.optional: 17524cfd6adSMarkus Armbruster obj['default'] = None 17684ab0086SMarkus Armbruster return _make_tree(obj, member.ifcond, member.features) 177fb0bc835SMarkus Armbruster 178fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 179fb0bc835SMarkus Armbruster return {'tag': tag_name, 180fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 181fb0bc835SMarkus Armbruster 182fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 18324cfd6adSMarkus Armbruster obj = {'case': variant.name, 'type': self._use_type(variant.type)} 18424cfd6adSMarkus Armbruster return _make_tree(obj, variant.ifcond, None) 185fb0bc835SMarkus Armbruster 186fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 1872e8a843dSMarkus Armbruster self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None) 188fb0bc835SMarkus Armbruster 189013b4efcSMarkus Armbruster def visit_enum_type(self, name, info, ifcond, features, members, prefix): 1902e8a843dSMarkus Armbruster self._gen_tree(name, 'enum', 19124cfd6adSMarkus Armbruster {'values': [_make_tree(m.name, m.ifcond, None) 19224cfd6adSMarkus Armbruster for m in members]}, 193013b4efcSMarkus Armbruster ifcond, features) 194fb0bc835SMarkus Armbruster 195fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 196fb0bc835SMarkus Armbruster element = self._use_type(element_type) 1972e8a843dSMarkus Armbruster self._gen_tree('[' + element + ']', 'array', {'element-type': element}, 198013b4efcSMarkus Armbruster ifcond, None) 199fb0bc835SMarkus Armbruster 2007b3bc9e2SMarkus Armbruster def visit_object_type_flat(self, name, info, ifcond, features, 2017b3bc9e2SMarkus Armbruster members, variants): 202fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 203fb0bc835SMarkus Armbruster if variants: 204fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 205fb0bc835SMarkus Armbruster variants.variants)) 2066a8c0b51SKevin Wolf 2072e8a843dSMarkus Armbruster self._gen_tree(name, 'object', obj, ifcond, features) 208fb0bc835SMarkus Armbruster 209013b4efcSMarkus Armbruster def visit_alternate_type(self, name, info, ifcond, features, variants): 2102e8a843dSMarkus Armbruster self._gen_tree(name, 'alternate', 2118ee06f61SMarc-André Lureau {'members': [ 21224cfd6adSMarkus Armbruster _make_tree({'type': self._use_type(m.type)}, 21324cfd6adSMarkus Armbruster m.ifcond, None) 214013b4efcSMarkus Armbruster for m in variants.variants]}, 215013b4efcSMarkus Armbruster ifcond, features) 216fb0bc835SMarkus Armbruster 2177b3bc9e2SMarkus Armbruster def visit_command(self, name, info, ifcond, features, 2187b3bc9e2SMarkus Armbruster arg_type, ret_type, gen, success_response, boxed, 21904f22362SKevin Wolf allow_oob, allow_preconfig, coroutine): 220fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 221fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 22225b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 22325b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 22425b1ef31SMarkus Armbruster if allow_oob: 22525b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 2262e8a843dSMarkus Armbruster self._gen_tree(name, 'command', obj, ifcond, features) 22723394b4cSPeter Krempa 228013b4efcSMarkus Armbruster def visit_event(self, name, info, ifcond, features, arg_type, boxed): 229fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 2302e8a843dSMarkus Armbruster self._gen_tree(name, 'event', {'arg-type': self._use_type(arg_type)}, 231013b4efcSMarkus Armbruster ifcond, features) 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