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*5f50cedeSJohn Snowfrom typing import Optional 14*5f50cedeSJohn Snow 155af8263dSJohn Snowfrom .common import ( 165af8263dSJohn Snow c_name, 175af8263dSJohn Snow gen_endif, 185af8263dSJohn Snow gen_if, 195af8263dSJohn Snow mcgen, 205af8263dSJohn Snow) 217137a960SJohn Snowfrom .gen import QAPISchemaMonolithicCVisitor 2267fea575SJohn Snowfrom .schema import ( 2367fea575SJohn Snow QAPISchemaArrayType, 2467fea575SJohn Snow QAPISchemaBuiltinType, 2567fea575SJohn Snow QAPISchemaType, 2667fea575SJohn Snow) 27fb0bc835SMarkus Armbruster 28fb0bc835SMarkus Armbruster 29*5f50cedeSJohn Snowdef _make_tree(obj, ifcond, comment=None): 3024cfd6adSMarkus Armbruster extra = {} 3124cfd6adSMarkus Armbruster if ifcond: 3224cfd6adSMarkus Armbruster extra['if'] = ifcond 33*5f50cedeSJohn Snow if comment: 34*5f50cedeSJohn Snow extra['comment'] = comment 3524cfd6adSMarkus Armbruster return (obj, extra) 3624cfd6adSMarkus Armbruster 3724cfd6adSMarkus Armbruster 3805556960SJohn Snowdef _tree_to_qlit(obj, level=0, dict_value=False): 397d0f982bSMarc-André Lureau 407d0f982bSMarc-André Lureau def indent(level): 417d0f982bSMarc-André Lureau return level * 4 * ' ' 427d0f982bSMarc-André Lureau 43d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 448c643361SEric Blake ifobj, extra = obj 458c643361SEric Blake ifcond = extra.get('if') 468c643361SEric Blake comment = extra.get('comment') 4705556960SJohn Snow 4805556960SJohn Snow # NB: _tree_to_qlit is called recursively on the values of a 4905556960SJohn Snow # key:value pair; those values can't be decorated with 5005556960SJohn Snow # comments or conditionals. 5105556960SJohn Snow msg = "dict values cannot have attached comments or if-conditionals." 5205556960SJohn Snow assert not dict_value, msg 5305556960SJohn Snow 548c643361SEric Blake ret = '' 558c643361SEric Blake if comment: 568c643361SEric Blake ret += indent(level) + '/* %s */\n' % comment 578c643361SEric Blake if ifcond: 588c643361SEric Blake ret += gen_if(ifcond) 592e8a843dSMarkus Armbruster ret += _tree_to_qlit(ifobj, level) 608c643361SEric Blake if ifcond: 618c643361SEric Blake ret += '\n' + gen_endif(ifcond) 62d626b6c1SMarc-André Lureau return ret 63d626b6c1SMarc-André Lureau 647d0f982bSMarc-André Lureau ret = '' 6505556960SJohn Snow if not dict_value: 667d0f982bSMarc-André Lureau ret += indent(level) 67fb0bc835SMarkus Armbruster if obj is None: 687d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 69fb0bc835SMarkus Armbruster elif isinstance(obj, str): 707d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 71fb0bc835SMarkus Armbruster elif isinstance(obj, list): 722e8a843dSMarkus Armbruster elts = [_tree_to_qlit(elt, level + 1).strip('\n') 73fb0bc835SMarkus Armbruster for elt in obj] 747d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 757d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 7640bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 777d0f982bSMarc-André Lureau ret += indent(level) + '}))' 78fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 797d0f982bSMarc-André Lureau elts = [] 807d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 817d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 822e8a843dSMarkus Armbruster (to_c_string(key), 832e8a843dSMarkus Armbruster _tree_to_qlit(value, level + 1, True))) 847d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 857d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 867d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 877d0f982bSMarc-André Lureau ret += indent(level) + '}))' 88876c6751SPeter Xu elif isinstance(obj, bool): 89876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 90fb0bc835SMarkus Armbruster else: 91fb0bc835SMarkus Armbruster assert False # not implemented 9240bb1376SMarc-André Lureau if level > 0: 9340bb1376SMarc-André Lureau ret += ',' 94fb0bc835SMarkus Armbruster return ret 95fb0bc835SMarkus Armbruster 96fb0bc835SMarkus Armbruster 97fb0bc835SMarkus Armbrusterdef to_c_string(string): 98fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 99fb0bc835SMarkus Armbruster 100fb0bc835SMarkus Armbruster 10171b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 102fb0bc835SMarkus Armbruster 10371b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 1042cae67bcSMarkus Armbruster super().__init__( 1052cae67bcSMarkus Armbruster prefix, 'qapi-introspect', 10671b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 10771b3f045SMarkus Armbruster self._unmask = unmask 10871b3f045SMarkus Armbruster self._schema = None 1092e8a843dSMarkus Armbruster self._trees = [] 110fb0bc835SMarkus Armbruster self._used_types = [] 111fb0bc835SMarkus Armbruster self._name_map = {} 11271b3f045SMarkus Armbruster self._genc.add(mcgen(''' 11371b3f045SMarkus Armbruster#include "qemu/osdep.h" 114eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 11571b3f045SMarkus Armbruster 11671b3f045SMarkus Armbruster''', 11771b3f045SMarkus Armbruster prefix=prefix)) 11871b3f045SMarkus Armbruster 11971b3f045SMarkus Armbruster def visit_begin(self, schema): 12071b3f045SMarkus Armbruster self._schema = schema 121fb0bc835SMarkus Armbruster 122fb0bc835SMarkus Armbruster def visit_end(self): 123fb0bc835SMarkus Armbruster # visit the types that are actually used 124fb0bc835SMarkus Armbruster for typ in self._used_types: 125fb0bc835SMarkus Armbruster typ.visit(self) 126fb0bc835SMarkus Armbruster # generate C 1277d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 12871b3f045SMarkus Armbruster self._genh.add(mcgen(''' 1297d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 1307d0f982bSMarc-André Lureau 1317d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 132fb0bc835SMarkus Armbruster''', 13371b3f045SMarkus Armbruster c_name=c_name(name))) 13471b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1357d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 136fb0bc835SMarkus Armbruster''', 137fb0bc835SMarkus Armbruster c_name=c_name(name), 1382e8a843dSMarkus Armbruster c_string=_tree_to_qlit(self._trees))) 139fb0bc835SMarkus Armbruster self._schema = None 1402e8a843dSMarkus Armbruster self._trees = [] 14171b3f045SMarkus Armbruster self._used_types = [] 14271b3f045SMarkus Armbruster self._name_map = {} 143fb0bc835SMarkus Armbruster 144fb0bc835SMarkus Armbruster def visit_needed(self, entity): 145fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 146fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 147fb0bc835SMarkus Armbruster 148fb0bc835SMarkus Armbruster def _name(self, name): 149fb0bc835SMarkus Armbruster if self._unmask: 150fb0bc835SMarkus Armbruster return name 151fb0bc835SMarkus Armbruster if name not in self._name_map: 152fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 153fb0bc835SMarkus Armbruster return self._name_map[name] 154fb0bc835SMarkus Armbruster 155fb0bc835SMarkus Armbruster def _use_type(self, typ): 1566b67bcacSJohn Snow assert self._schema is not None 1576b67bcacSJohn Snow 158fb0bc835SMarkus Armbruster # Map the various integer types to plain int 159fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 160fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 161fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 162fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 163fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 164fb0bc835SMarkus Armbruster # Add type to work queue if new 165fb0bc835SMarkus Armbruster if typ not in self._used_types: 166fb0bc835SMarkus Armbruster self._used_types.append(typ) 167fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 1681aa806ccSEric Blake # type names as integers to reduce the temptation. Also, it 1691aa806ccSEric Blake # saves a few characters on the wire. 170fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 171fb0bc835SMarkus Armbruster return typ.name 172fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 173fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 174fb0bc835SMarkus Armbruster return self._name(typ.name) 175fb0bc835SMarkus Armbruster 17684bece7dSJohn Snow @staticmethod 17784bece7dSJohn Snow def _gen_features(features): 17884bece7dSJohn Snow return [_make_tree(f.name, f.ifcond) for f in features] 17984bece7dSJohn Snow 1802e8a843dSMarkus Armbruster def _gen_tree(self, name, mtype, obj, ifcond, features): 181*5f50cedeSJohn Snow comment: Optional[str] = None 182fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 1838c643361SEric Blake if not self._unmask: 1848c643361SEric Blake # Output a comment to make it easy to map masked names 1858c643361SEric Blake # back to the source when reading the generated output. 186*5f50cedeSJohn Snow comment = f'"{self._name(name)}" = {name}' 187fb0bc835SMarkus Armbruster name = self._name(name) 188fb0bc835SMarkus Armbruster obj['name'] = name 189fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 19084bece7dSJohn Snow if features: 19184bece7dSJohn Snow obj['features'] = self._gen_features(features) 192*5f50cedeSJohn Snow self._trees.append(_make_tree(obj, ifcond, comment)) 193fb0bc835SMarkus Armbruster 194fb0bc835SMarkus Armbruster def _gen_member(self, member): 19524cfd6adSMarkus Armbruster obj = {'name': member.name, 'type': self._use_type(member.type)} 196fb0bc835SMarkus Armbruster if member.optional: 19724cfd6adSMarkus Armbruster obj['default'] = None 19884bece7dSJohn Snow if member.features: 19984bece7dSJohn Snow obj['features'] = self._gen_features(member.features) 20084bece7dSJohn Snow return _make_tree(obj, member.ifcond) 201fb0bc835SMarkus Armbruster 202fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 203fb0bc835SMarkus Armbruster return {'tag': tag_name, 204fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 205fb0bc835SMarkus Armbruster 206fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 20724cfd6adSMarkus Armbruster obj = {'case': variant.name, 'type': self._use_type(variant.type)} 20884bece7dSJohn Snow return _make_tree(obj, variant.ifcond) 209fb0bc835SMarkus Armbruster 210fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 2112e8a843dSMarkus Armbruster self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None) 212fb0bc835SMarkus Armbruster 213013b4efcSMarkus Armbruster def visit_enum_type(self, name, info, ifcond, features, members, prefix): 2142e8a843dSMarkus Armbruster self._gen_tree(name, 'enum', 21524cfd6adSMarkus Armbruster {'values': [_make_tree(m.name, m.ifcond, None) 21624cfd6adSMarkus Armbruster for m in members]}, 217013b4efcSMarkus Armbruster ifcond, features) 218fb0bc835SMarkus Armbruster 219fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 220fb0bc835SMarkus Armbruster element = self._use_type(element_type) 2212e8a843dSMarkus Armbruster self._gen_tree('[' + element + ']', 'array', {'element-type': element}, 222013b4efcSMarkus Armbruster ifcond, None) 223fb0bc835SMarkus Armbruster 2247b3bc9e2SMarkus Armbruster def visit_object_type_flat(self, name, info, ifcond, features, 2257b3bc9e2SMarkus Armbruster members, variants): 226fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 227fb0bc835SMarkus Armbruster if variants: 228fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 229fb0bc835SMarkus Armbruster variants.variants)) 2306a8c0b51SKevin Wolf 2312e8a843dSMarkus Armbruster self._gen_tree(name, 'object', obj, ifcond, features) 232fb0bc835SMarkus Armbruster 233013b4efcSMarkus Armbruster def visit_alternate_type(self, name, info, ifcond, features, variants): 2342e8a843dSMarkus Armbruster self._gen_tree(name, 'alternate', 2358ee06f61SMarc-André Lureau {'members': [ 23624cfd6adSMarkus Armbruster _make_tree({'type': self._use_type(m.type)}, 23724cfd6adSMarkus Armbruster m.ifcond, None) 238013b4efcSMarkus Armbruster for m in variants.variants]}, 239013b4efcSMarkus Armbruster ifcond, features) 240fb0bc835SMarkus Armbruster 2417b3bc9e2SMarkus Armbruster def visit_command(self, name, info, ifcond, features, 2427b3bc9e2SMarkus Armbruster arg_type, ret_type, gen, success_response, boxed, 24304f22362SKevin Wolf allow_oob, allow_preconfig, coroutine): 2446b67bcacSJohn Snow assert self._schema is not None 2456b67bcacSJohn Snow 246fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 247fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 24825b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 24925b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 25025b1ef31SMarkus Armbruster if allow_oob: 25125b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 2522e8a843dSMarkus Armbruster self._gen_tree(name, 'command', obj, ifcond, features) 25323394b4cSPeter Krempa 254013b4efcSMarkus Armbruster def visit_event(self, name, info, ifcond, features, arg_type, boxed): 2556b67bcacSJohn Snow assert self._schema is not None 256fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 2572e8a843dSMarkus Armbruster self._gen_tree(name, 'event', {'arg-type': self._use_type(arg_type)}, 258013b4efcSMarkus Armbruster ifcond, features) 259fb0bc835SMarkus Armbruster 260fb0bc835SMarkus Armbruster 261fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 262fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 263fb0bc835SMarkus Armbruster schema.visit(vis) 26471b3f045SMarkus Armbruster vis.write(output_dir) 265