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 * 14fb0bc835SMarkus Armbruster 15fb0bc835SMarkus Armbruster 16*7d0f982bSMarc-André Lureaudef to_qlit(obj, level=0, suppress_first_indent=False): 17*7d0f982bSMarc-André Lureau 18*7d0f982bSMarc-André Lureau def indent(level): 19*7d0f982bSMarc-André Lureau return level * 4 * ' ' 20*7d0f982bSMarc-André Lureau 21*7d0f982bSMarc-André Lureau ret = '' 22*7d0f982bSMarc-André Lureau if not suppress_first_indent: 23*7d0f982bSMarc-André Lureau ret += indent(level) 24fb0bc835SMarkus Armbruster if obj is None: 25*7d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 26fb0bc835SMarkus Armbruster elif isinstance(obj, str): 27*7d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 28fb0bc835SMarkus Armbruster elif isinstance(obj, list): 29*7d0f982bSMarc-André Lureau elts = [to_qlit(elt, level + 1) 30fb0bc835SMarkus Armbruster for elt in obj] 31*7d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 32*7d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 33*7d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 34*7d0f982bSMarc-André Lureau ret += indent(level) + '}))' 35fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 36*7d0f982bSMarc-André Lureau elts = [] 37*7d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 38*7d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 39*7d0f982bSMarc-André Lureau (to_c_string(key), to_qlit(value, level + 1, True))) 40*7d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 41*7d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 42*7d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 43*7d0f982bSMarc-André Lureau ret += indent(level) + '}))' 44fb0bc835SMarkus Armbruster else: 45fb0bc835SMarkus Armbruster assert False # not implemented 46fb0bc835SMarkus Armbruster return ret 47fb0bc835SMarkus Armbruster 48fb0bc835SMarkus Armbruster 49fb0bc835SMarkus Armbrusterdef to_c_string(string): 50fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 51fb0bc835SMarkus Armbruster 52fb0bc835SMarkus Armbruster 5371b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 54fb0bc835SMarkus Armbruster 5571b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 5671b3f045SMarkus Armbruster QAPISchemaMonolithicCVisitor.__init__( 57eb815e24SMarkus Armbruster self, prefix, 'qapi-introspect', 5871b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 5971b3f045SMarkus Armbruster self._unmask = unmask 6071b3f045SMarkus Armbruster self._schema = None 61*7d0f982bSMarc-André Lureau self._qlits = [] 62fb0bc835SMarkus Armbruster self._used_types = [] 63fb0bc835SMarkus Armbruster self._name_map = {} 6471b3f045SMarkus Armbruster self._genc.add(mcgen(''' 6571b3f045SMarkus Armbruster#include "qemu/osdep.h" 66eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 6771b3f045SMarkus Armbruster 6871b3f045SMarkus Armbruster''', 6971b3f045SMarkus Armbruster prefix=prefix)) 7071b3f045SMarkus Armbruster 7171b3f045SMarkus Armbruster def visit_begin(self, schema): 7271b3f045SMarkus Armbruster self._schema = schema 73fb0bc835SMarkus Armbruster 74fb0bc835SMarkus Armbruster def visit_end(self): 75fb0bc835SMarkus Armbruster # visit the types that are actually used 76*7d0f982bSMarc-André Lureau qlits = self._qlits 77*7d0f982bSMarc-André Lureau self._qlits = [] 78fb0bc835SMarkus Armbruster for typ in self._used_types: 79fb0bc835SMarkus Armbruster typ.visit(self) 80fb0bc835SMarkus Armbruster # generate C 81fb0bc835SMarkus Armbruster # TODO can generate awfully long lines 82*7d0f982bSMarc-André Lureau qlits.extend(self._qlits) 83*7d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 8471b3f045SMarkus Armbruster self._genh.add(mcgen(''' 85*7d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 86*7d0f982bSMarc-André Lureau 87*7d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 88fb0bc835SMarkus Armbruster''', 8971b3f045SMarkus Armbruster c_name=c_name(name))) 9071b3f045SMarkus Armbruster self._genc.add(mcgen(''' 91*7d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 92fb0bc835SMarkus Armbruster''', 93fb0bc835SMarkus Armbruster c_name=c_name(name), 94*7d0f982bSMarc-André Lureau c_string=to_qlit(qlits))) 95fb0bc835SMarkus Armbruster self._schema = None 96*7d0f982bSMarc-André Lureau self._qlits = [] 9771b3f045SMarkus Armbruster self._used_types = [] 9871b3f045SMarkus Armbruster self._name_map = {} 99fb0bc835SMarkus Armbruster 100fb0bc835SMarkus Armbruster def visit_needed(self, entity): 101fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 102fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 103fb0bc835SMarkus Armbruster 104fb0bc835SMarkus Armbruster def _name(self, name): 105fb0bc835SMarkus Armbruster if self._unmask: 106fb0bc835SMarkus Armbruster return name 107fb0bc835SMarkus Armbruster if name not in self._name_map: 108fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 109fb0bc835SMarkus Armbruster return self._name_map[name] 110fb0bc835SMarkus Armbruster 111fb0bc835SMarkus Armbruster def _use_type(self, typ): 112fb0bc835SMarkus Armbruster # Map the various integer types to plain int 113fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 114fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 115fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 116fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 117fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 118fb0bc835SMarkus Armbruster # Add type to work queue if new 119fb0bc835SMarkus Armbruster if typ not in self._used_types: 120fb0bc835SMarkus Armbruster self._used_types.append(typ) 121fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 122fb0bc835SMarkus Armbruster # type names to reduce the temptation. Also saves a few 123fb0bc835SMarkus Armbruster # characters. 124fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 125fb0bc835SMarkus Armbruster return typ.name 126fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 127fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 128fb0bc835SMarkus Armbruster return self._name(typ.name) 129fb0bc835SMarkus Armbruster 130*7d0f982bSMarc-André Lureau def _gen_qlit(self, name, mtype, obj): 131fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 132fb0bc835SMarkus Armbruster name = self._name(name) 133fb0bc835SMarkus Armbruster obj['name'] = name 134fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 135*7d0f982bSMarc-André Lureau self._qlits.append(obj) 136fb0bc835SMarkus Armbruster 137fb0bc835SMarkus Armbruster def _gen_member(self, member): 138fb0bc835SMarkus Armbruster ret = {'name': member.name, 'type': self._use_type(member.type)} 139fb0bc835SMarkus Armbruster if member.optional: 140fb0bc835SMarkus Armbruster ret['default'] = None 141fb0bc835SMarkus Armbruster return ret 142fb0bc835SMarkus Armbruster 143fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 144fb0bc835SMarkus Armbruster return {'tag': tag_name, 145fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 146fb0bc835SMarkus Armbruster 147fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 148fb0bc835SMarkus Armbruster return {'case': variant.name, 'type': self._use_type(variant.type)} 149fb0bc835SMarkus Armbruster 150fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 151*7d0f982bSMarc-André Lureau self._gen_qlit(name, 'builtin', {'json-type': json_type}) 152fb0bc835SMarkus Armbruster 153fb0bc835SMarkus Armbruster def visit_enum_type(self, name, info, values, prefix): 154*7d0f982bSMarc-André Lureau self._gen_qlit(name, 'enum', {'values': values}) 155fb0bc835SMarkus Armbruster 156fb0bc835SMarkus Armbruster def visit_array_type(self, name, info, element_type): 157fb0bc835SMarkus Armbruster element = self._use_type(element_type) 158*7d0f982bSMarc-André Lureau self._gen_qlit('[' + element + ']', 'array', {'element-type': element}) 159fb0bc835SMarkus Armbruster 160fb0bc835SMarkus Armbruster def visit_object_type_flat(self, name, info, members, variants): 161fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 162fb0bc835SMarkus Armbruster if variants: 163fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 164fb0bc835SMarkus Armbruster variants.variants)) 165*7d0f982bSMarc-André Lureau self._gen_qlit(name, 'object', obj) 166fb0bc835SMarkus Armbruster 167fb0bc835SMarkus Armbruster def visit_alternate_type(self, name, info, variants): 168*7d0f982bSMarc-André Lureau self._gen_qlit(name, 'alternate', 169fb0bc835SMarkus Armbruster {'members': [{'type': self._use_type(m.type)} 170fb0bc835SMarkus Armbruster for m in variants.variants]}) 171fb0bc835SMarkus Armbruster 172fb0bc835SMarkus Armbruster def visit_command(self, name, info, arg_type, ret_type, 173fb0bc835SMarkus Armbruster gen, success_response, boxed): 174fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 175fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 176*7d0f982bSMarc-André Lureau self._gen_qlit(name, 'command', 177fb0bc835SMarkus Armbruster {'arg-type': self._use_type(arg_type), 178fb0bc835SMarkus Armbruster 'ret-type': self._use_type(ret_type)}) 179fb0bc835SMarkus Armbruster 180fb0bc835SMarkus Armbruster def visit_event(self, name, info, arg_type, boxed): 181fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 182*7d0f982bSMarc-André Lureau self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)}) 183fb0bc835SMarkus Armbruster 184fb0bc835SMarkus Armbruster 185fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 186fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 187fb0bc835SMarkus Armbruster schema.visit(vis) 18871b3f045SMarkus Armbruster vis.write(output_dir) 189