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 167d0f982bSMarc-André Lureaudef to_qlit(obj, level=0, suppress_first_indent=False): 177d0f982bSMarc-André Lureau 187d0f982bSMarc-André Lureau def indent(level): 197d0f982bSMarc-André Lureau return level * 4 * ' ' 207d0f982bSMarc-André Lureau 21d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 22d626b6c1SMarc-André Lureau ifobj, ifcond = obj 23d626b6c1SMarc-André Lureau ret = gen_if(ifcond) 24d626b6c1SMarc-André Lureau ret += to_qlit(ifobj, level) 25d626b6c1SMarc-André Lureau endif = gen_endif(ifcond) 26d626b6c1SMarc-André Lureau if endif: 27d626b6c1SMarc-André Lureau ret += '\n' + endif 28d626b6c1SMarc-André Lureau return ret 29d626b6c1SMarc-André Lureau 307d0f982bSMarc-André Lureau ret = '' 317d0f982bSMarc-André Lureau if not suppress_first_indent: 327d0f982bSMarc-André Lureau ret += indent(level) 33fb0bc835SMarkus Armbruster if obj is None: 347d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 35fb0bc835SMarkus Armbruster elif isinstance(obj, str): 367d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 37fb0bc835SMarkus Armbruster elif isinstance(obj, list): 38d626b6c1SMarc-André Lureau elts = [to_qlit(elt, level + 1).strip('\n') 39fb0bc835SMarkus Armbruster for elt in obj] 407d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 417d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 4240bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 437d0f982bSMarc-André Lureau ret += indent(level) + '}))' 44fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 457d0f982bSMarc-André Lureau elts = [] 467d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 477d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 487d0f982bSMarc-André Lureau (to_c_string(key), to_qlit(value, level + 1, True))) 497d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 507d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 517d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 527d0f982bSMarc-André Lureau ret += indent(level) + '}))' 53876c6751SPeter Xu elif isinstance(obj, bool): 54876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 55fb0bc835SMarkus Armbruster else: 56fb0bc835SMarkus Armbruster assert False # not implemented 5740bb1376SMarc-André Lureau if level > 0: 5840bb1376SMarc-André Lureau ret += ',' 59fb0bc835SMarkus Armbruster return ret 60fb0bc835SMarkus Armbruster 61fb0bc835SMarkus Armbruster 62fb0bc835SMarkus Armbrusterdef to_c_string(string): 63fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 64fb0bc835SMarkus Armbruster 65fb0bc835SMarkus Armbruster 6671b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 67fb0bc835SMarkus Armbruster 6871b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 6971b3f045SMarkus Armbruster QAPISchemaMonolithicCVisitor.__init__( 70eb815e24SMarkus Armbruster self, prefix, 'qapi-introspect', 7171b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 7271b3f045SMarkus Armbruster self._unmask = unmask 7371b3f045SMarkus Armbruster self._schema = None 747d0f982bSMarc-André Lureau self._qlits = [] 75fb0bc835SMarkus Armbruster self._used_types = [] 76fb0bc835SMarkus Armbruster self._name_map = {} 7771b3f045SMarkus Armbruster self._genc.add(mcgen(''' 7871b3f045SMarkus Armbruster#include "qemu/osdep.h" 79eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 8071b3f045SMarkus Armbruster 8171b3f045SMarkus Armbruster''', 8271b3f045SMarkus Armbruster prefix=prefix)) 8371b3f045SMarkus Armbruster 8471b3f045SMarkus Armbruster def visit_begin(self, schema): 8571b3f045SMarkus Armbruster self._schema = schema 86fb0bc835SMarkus Armbruster 87fb0bc835SMarkus Armbruster def visit_end(self): 88fb0bc835SMarkus Armbruster # visit the types that are actually used 89fb0bc835SMarkus Armbruster for typ in self._used_types: 90fb0bc835SMarkus Armbruster typ.visit(self) 91fb0bc835SMarkus Armbruster # generate C 927d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 9371b3f045SMarkus Armbruster self._genh.add(mcgen(''' 947d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 957d0f982bSMarc-André Lureau 967d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 97fb0bc835SMarkus Armbruster''', 9871b3f045SMarkus Armbruster c_name=c_name(name))) 9971b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1007d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 101fb0bc835SMarkus Armbruster''', 102fb0bc835SMarkus Armbruster c_name=c_name(name), 103da112e83SMarkus Armbruster c_string=to_qlit(self._qlits))) 104fb0bc835SMarkus Armbruster self._schema = None 1057d0f982bSMarc-André Lureau self._qlits = [] 10671b3f045SMarkus Armbruster self._used_types = [] 10771b3f045SMarkus Armbruster self._name_map = {} 108fb0bc835SMarkus Armbruster 109fb0bc835SMarkus Armbruster def visit_needed(self, entity): 110fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 111fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 112fb0bc835SMarkus Armbruster 113fb0bc835SMarkus Armbruster def _name(self, name): 114fb0bc835SMarkus Armbruster if self._unmask: 115fb0bc835SMarkus Armbruster return name 116fb0bc835SMarkus Armbruster if name not in self._name_map: 117fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 118fb0bc835SMarkus Armbruster return self._name_map[name] 119fb0bc835SMarkus Armbruster 120fb0bc835SMarkus Armbruster def _use_type(self, typ): 121fb0bc835SMarkus Armbruster # Map the various integer types to plain int 122fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 123fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 124fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 125fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 126fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 127fb0bc835SMarkus Armbruster # Add type to work queue if new 128fb0bc835SMarkus Armbruster if typ not in self._used_types: 129fb0bc835SMarkus Armbruster self._used_types.append(typ) 130fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 131*1aa806ccSEric Blake # type names as integers to reduce the temptation. Also, it 132*1aa806ccSEric Blake # saves a few characters on the wire. 133fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 134fb0bc835SMarkus Armbruster return typ.name 135fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 136fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 137fb0bc835SMarkus Armbruster return self._name(typ.name) 138fb0bc835SMarkus Armbruster 139d626b6c1SMarc-André Lureau def _gen_qlit(self, name, mtype, obj, ifcond): 140fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 141fb0bc835SMarkus Armbruster name = self._name(name) 142fb0bc835SMarkus Armbruster obj['name'] = name 143fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 144d626b6c1SMarc-André Lureau self._qlits.append((obj, ifcond)) 145fb0bc835SMarkus Armbruster 146fb0bc835SMarkus Armbruster def _gen_member(self, member): 147fb0bc835SMarkus Armbruster ret = {'name': member.name, 'type': self._use_type(member.type)} 148fb0bc835SMarkus Armbruster if member.optional: 149fb0bc835SMarkus Armbruster ret['default'] = None 150fb0bc835SMarkus Armbruster return ret 151fb0bc835SMarkus Armbruster 152fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 153fb0bc835SMarkus Armbruster return {'tag': tag_name, 154fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 155fb0bc835SMarkus Armbruster 156fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 157fb0bc835SMarkus Armbruster return {'case': variant.name, 'type': self._use_type(variant.type)} 158fb0bc835SMarkus Armbruster 159fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 160d626b6c1SMarc-André Lureau self._gen_qlit(name, 'builtin', {'json-type': json_type}, []) 161fb0bc835SMarkus Armbruster 162fbf09a2fSMarc-André Lureau def visit_enum_type(self, name, info, ifcond, values, prefix): 163d626b6c1SMarc-André Lureau self._gen_qlit(name, 'enum', {'values': values}, ifcond) 164fb0bc835SMarkus Armbruster 165fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 166fb0bc835SMarkus Armbruster element = self._use_type(element_type) 167d626b6c1SMarc-André Lureau self._gen_qlit('[' + element + ']', 'array', {'element-type': element}, 168d626b6c1SMarc-André Lureau ifcond) 169fb0bc835SMarkus Armbruster 170fbf09a2fSMarc-André Lureau def visit_object_type_flat(self, name, info, ifcond, members, variants): 171fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 172fb0bc835SMarkus Armbruster if variants: 173fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 174fb0bc835SMarkus Armbruster variants.variants)) 175d626b6c1SMarc-André Lureau self._gen_qlit(name, 'object', obj, ifcond) 176fb0bc835SMarkus Armbruster 177fbf09a2fSMarc-André Lureau def visit_alternate_type(self, name, info, ifcond, variants): 1787d0f982bSMarc-André Lureau self._gen_qlit(name, 'alternate', 179fb0bc835SMarkus Armbruster {'members': [{'type': self._use_type(m.type)} 180d626b6c1SMarc-André Lureau for m in variants.variants]}, ifcond) 181fb0bc835SMarkus Armbruster 182fbf09a2fSMarc-André Lureau def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, 183d6fe3d02SIgor Mammedov success_response, boxed, allow_oob, allow_preconfig): 184fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 185fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 18625b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 18725b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 18825b1ef31SMarkus Armbruster if allow_oob: 18925b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 19025b1ef31SMarkus Armbruster self._gen_qlit(name, 'command', obj, ifcond) 191fb0bc835SMarkus Armbruster 192fbf09a2fSMarc-André Lureau def visit_event(self, name, info, ifcond, arg_type, boxed): 193fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 194d626b6c1SMarc-André Lureau self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)}, 195d626b6c1SMarc-André Lureau ifcond) 196fb0bc835SMarkus Armbruster 197fb0bc835SMarkus Armbruster 198fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 199fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 200fb0bc835SMarkus Armbruster schema.visit(vis) 20171b3f045SMarkus Armbruster vis.write(output_dir) 202