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 2067fea575SJohn Snowfrom .schema import ( 2167fea575SJohn Snow QAPISchemaArrayType, 2267fea575SJohn Snow QAPISchemaBuiltinType, 2367fea575SJohn Snow QAPISchemaType, 2467fea575SJohn Snow) 25fb0bc835SMarkus Armbruster 26fb0bc835SMarkus Armbruster 2784bece7dSJohn Snowdef _make_tree(obj, ifcond, extra=None): 2824cfd6adSMarkus Armbruster if extra is None: 2924cfd6adSMarkus Armbruster extra = {} 3024cfd6adSMarkus Armbruster if ifcond: 3124cfd6adSMarkus Armbruster extra['if'] = ifcond 3224cfd6adSMarkus Armbruster if extra: 3324cfd6adSMarkus Armbruster return (obj, extra) 3424cfd6adSMarkus Armbruster return obj 3524cfd6adSMarkus Armbruster 3624cfd6adSMarkus Armbruster 37*05556960SJohn Snowdef _tree_to_qlit(obj, level=0, dict_value=False): 387d0f982bSMarc-André Lureau 397d0f982bSMarc-André Lureau def indent(level): 407d0f982bSMarc-André Lureau return level * 4 * ' ' 417d0f982bSMarc-André Lureau 42d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 438c643361SEric Blake ifobj, extra = obj 448c643361SEric Blake ifcond = extra.get('if') 458c643361SEric Blake comment = extra.get('comment') 46*05556960SJohn Snow 47*05556960SJohn Snow # NB: _tree_to_qlit is called recursively on the values of a 48*05556960SJohn Snow # key:value pair; those values can't be decorated with 49*05556960SJohn Snow # comments or conditionals. 50*05556960SJohn Snow msg = "dict values cannot have attached comments or if-conditionals." 51*05556960SJohn Snow assert not dict_value, msg 52*05556960SJohn Snow 538c643361SEric Blake ret = '' 548c643361SEric Blake if comment: 558c643361SEric Blake ret += indent(level) + '/* %s */\n' % comment 568c643361SEric Blake if ifcond: 578c643361SEric Blake ret += gen_if(ifcond) 582e8a843dSMarkus Armbruster ret += _tree_to_qlit(ifobj, level) 598c643361SEric Blake if ifcond: 608c643361SEric Blake ret += '\n' + gen_endif(ifcond) 61d626b6c1SMarc-André Lureau return ret 62d626b6c1SMarc-André Lureau 637d0f982bSMarc-André Lureau ret = '' 64*05556960SJohn Snow if not dict_value: 657d0f982bSMarc-André Lureau ret += indent(level) 66fb0bc835SMarkus Armbruster if obj is None: 677d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 68fb0bc835SMarkus Armbruster elif isinstance(obj, str): 697d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 70fb0bc835SMarkus Armbruster elif isinstance(obj, list): 712e8a843dSMarkus Armbruster elts = [_tree_to_qlit(elt, level + 1).strip('\n') 72fb0bc835SMarkus Armbruster for elt in obj] 737d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 747d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 7540bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 767d0f982bSMarc-André Lureau ret += indent(level) + '}))' 77fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 787d0f982bSMarc-André Lureau elts = [] 797d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 807d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 812e8a843dSMarkus Armbruster (to_c_string(key), 822e8a843dSMarkus Armbruster _tree_to_qlit(value, level + 1, True))) 837d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 847d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 857d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 867d0f982bSMarc-André Lureau ret += indent(level) + '}))' 87876c6751SPeter Xu elif isinstance(obj, bool): 88876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 89fb0bc835SMarkus Armbruster else: 90fb0bc835SMarkus Armbruster assert False # not implemented 9140bb1376SMarc-André Lureau if level > 0: 9240bb1376SMarc-André Lureau ret += ',' 93fb0bc835SMarkus Armbruster return ret 94fb0bc835SMarkus Armbruster 95fb0bc835SMarkus Armbruster 96fb0bc835SMarkus Armbrusterdef to_c_string(string): 97fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 98fb0bc835SMarkus Armbruster 99fb0bc835SMarkus Armbruster 10071b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 101fb0bc835SMarkus Armbruster 10271b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 1032cae67bcSMarkus Armbruster super().__init__( 1042cae67bcSMarkus Armbruster prefix, 'qapi-introspect', 10571b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 10671b3f045SMarkus Armbruster self._unmask = unmask 10771b3f045SMarkus Armbruster self._schema = None 1082e8a843dSMarkus Armbruster self._trees = [] 109fb0bc835SMarkus Armbruster self._used_types = [] 110fb0bc835SMarkus Armbruster self._name_map = {} 11171b3f045SMarkus Armbruster self._genc.add(mcgen(''' 11271b3f045SMarkus Armbruster#include "qemu/osdep.h" 113eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 11471b3f045SMarkus Armbruster 11571b3f045SMarkus Armbruster''', 11671b3f045SMarkus Armbruster prefix=prefix)) 11771b3f045SMarkus Armbruster 11871b3f045SMarkus Armbruster def visit_begin(self, schema): 11971b3f045SMarkus Armbruster self._schema = schema 120fb0bc835SMarkus Armbruster 121fb0bc835SMarkus Armbruster def visit_end(self): 122fb0bc835SMarkus Armbruster # visit the types that are actually used 123fb0bc835SMarkus Armbruster for typ in self._used_types: 124fb0bc835SMarkus Armbruster typ.visit(self) 125fb0bc835SMarkus Armbruster # generate C 1267d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 12771b3f045SMarkus Armbruster self._genh.add(mcgen(''' 1287d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 1297d0f982bSMarc-André Lureau 1307d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 131fb0bc835SMarkus Armbruster''', 13271b3f045SMarkus Armbruster c_name=c_name(name))) 13371b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1347d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 135fb0bc835SMarkus Armbruster''', 136fb0bc835SMarkus Armbruster c_name=c_name(name), 1372e8a843dSMarkus Armbruster c_string=_tree_to_qlit(self._trees))) 138fb0bc835SMarkus Armbruster self._schema = None 1392e8a843dSMarkus Armbruster self._trees = [] 14071b3f045SMarkus Armbruster self._used_types = [] 14171b3f045SMarkus Armbruster self._name_map = {} 142fb0bc835SMarkus Armbruster 143fb0bc835SMarkus Armbruster def visit_needed(self, entity): 144fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 145fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 146fb0bc835SMarkus Armbruster 147fb0bc835SMarkus Armbruster def _name(self, name): 148fb0bc835SMarkus Armbruster if self._unmask: 149fb0bc835SMarkus Armbruster return name 150fb0bc835SMarkus Armbruster if name not in self._name_map: 151fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 152fb0bc835SMarkus Armbruster return self._name_map[name] 153fb0bc835SMarkus Armbruster 154fb0bc835SMarkus Armbruster def _use_type(self, typ): 1556b67bcacSJohn Snow assert self._schema is not None 1566b67bcacSJohn Snow 157fb0bc835SMarkus Armbruster # Map the various integer types to plain int 158fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 159fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 160fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 161fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 162fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 163fb0bc835SMarkus Armbruster # Add type to work queue if new 164fb0bc835SMarkus Armbruster if typ not in self._used_types: 165fb0bc835SMarkus Armbruster self._used_types.append(typ) 166fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 1671aa806ccSEric Blake # type names as integers to reduce the temptation. Also, it 1681aa806ccSEric Blake # saves a few characters on the wire. 169fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 170fb0bc835SMarkus Armbruster return typ.name 171fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 172fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 173fb0bc835SMarkus Armbruster return self._name(typ.name) 174fb0bc835SMarkus Armbruster 17584bece7dSJohn Snow @staticmethod 17684bece7dSJohn Snow def _gen_features(features): 17784bece7dSJohn Snow return [_make_tree(f.name, f.ifcond) for f in features] 17884bece7dSJohn Snow 1792e8a843dSMarkus Armbruster def _gen_tree(self, name, mtype, obj, ifcond, features): 18024cfd6adSMarkus Armbruster extra = None 181fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 1828c643361SEric Blake if not self._unmask: 1838c643361SEric Blake # Output a comment to make it easy to map masked names 1848c643361SEric Blake # back to the source when reading the generated output. 18524cfd6adSMarkus Armbruster extra = {'comment': '"%s" = %s' % (self._name(name), name)} 186fb0bc835SMarkus Armbruster name = self._name(name) 187fb0bc835SMarkus Armbruster obj['name'] = name 188fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 18984bece7dSJohn Snow if features: 19084bece7dSJohn Snow obj['features'] = self._gen_features(features) 19184bece7dSJohn Snow self._trees.append(_make_tree(obj, ifcond, extra)) 192fb0bc835SMarkus Armbruster 193fb0bc835SMarkus Armbruster def _gen_member(self, member): 19424cfd6adSMarkus Armbruster obj = {'name': member.name, 'type': self._use_type(member.type)} 195fb0bc835SMarkus Armbruster if member.optional: 19624cfd6adSMarkus Armbruster obj['default'] = None 19784bece7dSJohn Snow if member.features: 19884bece7dSJohn Snow obj['features'] = self._gen_features(member.features) 19984bece7dSJohn Snow return _make_tree(obj, member.ifcond) 200fb0bc835SMarkus Armbruster 201fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 202fb0bc835SMarkus Armbruster return {'tag': tag_name, 203fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 204fb0bc835SMarkus Armbruster 205fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 20624cfd6adSMarkus Armbruster obj = {'case': variant.name, 'type': self._use_type(variant.type)} 20784bece7dSJohn Snow return _make_tree(obj, variant.ifcond) 208fb0bc835SMarkus Armbruster 209fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 2102e8a843dSMarkus Armbruster self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None) 211fb0bc835SMarkus Armbruster 212013b4efcSMarkus Armbruster def visit_enum_type(self, name, info, ifcond, features, members, prefix): 2132e8a843dSMarkus Armbruster self._gen_tree(name, 'enum', 21424cfd6adSMarkus Armbruster {'values': [_make_tree(m.name, m.ifcond, None) 21524cfd6adSMarkus Armbruster for m in members]}, 216013b4efcSMarkus Armbruster ifcond, features) 217fb0bc835SMarkus Armbruster 218fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 219fb0bc835SMarkus Armbruster element = self._use_type(element_type) 2202e8a843dSMarkus Armbruster self._gen_tree('[' + element + ']', 'array', {'element-type': element}, 221013b4efcSMarkus Armbruster ifcond, None) 222fb0bc835SMarkus Armbruster 2237b3bc9e2SMarkus Armbruster def visit_object_type_flat(self, name, info, ifcond, features, 2247b3bc9e2SMarkus Armbruster members, variants): 225fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 226fb0bc835SMarkus Armbruster if variants: 227fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 228fb0bc835SMarkus Armbruster variants.variants)) 2296a8c0b51SKevin Wolf 2302e8a843dSMarkus Armbruster self._gen_tree(name, 'object', obj, ifcond, features) 231fb0bc835SMarkus Armbruster 232013b4efcSMarkus Armbruster def visit_alternate_type(self, name, info, ifcond, features, variants): 2332e8a843dSMarkus Armbruster self._gen_tree(name, 'alternate', 2348ee06f61SMarc-André Lureau {'members': [ 23524cfd6adSMarkus Armbruster _make_tree({'type': self._use_type(m.type)}, 23624cfd6adSMarkus Armbruster m.ifcond, None) 237013b4efcSMarkus Armbruster for m in variants.variants]}, 238013b4efcSMarkus Armbruster ifcond, features) 239fb0bc835SMarkus Armbruster 2407b3bc9e2SMarkus Armbruster def visit_command(self, name, info, ifcond, features, 2417b3bc9e2SMarkus Armbruster arg_type, ret_type, gen, success_response, boxed, 24204f22362SKevin Wolf allow_oob, allow_preconfig, coroutine): 2436b67bcacSJohn Snow assert self._schema is not None 2446b67bcacSJohn Snow 245fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 246fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 24725b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 24825b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 24925b1ef31SMarkus Armbruster if allow_oob: 25025b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 2512e8a843dSMarkus Armbruster self._gen_tree(name, 'command', obj, ifcond, features) 25223394b4cSPeter Krempa 253013b4efcSMarkus Armbruster def visit_event(self, name, info, ifcond, features, arg_type, boxed): 2546b67bcacSJohn Snow assert self._schema is not None 255fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 2562e8a843dSMarkus Armbruster self._gen_tree(name, 'event', {'arg-type': self._use_type(arg_type)}, 257013b4efcSMarkus Armbruster ifcond, features) 258fb0bc835SMarkus Armbruster 259fb0bc835SMarkus Armbruster 260fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 261fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 262fb0bc835SMarkus Armbruster schema.visit(vis) 26371b3f045SMarkus Armbruster vis.write(output_dir) 264