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): 22*8c643361SEric Blake ifobj, extra = obj 23*8c643361SEric Blake ifcond = extra.get('if') 24*8c643361SEric Blake comment = extra.get('comment') 25*8c643361SEric Blake ret = '' 26*8c643361SEric Blake if comment: 27*8c643361SEric Blake ret += indent(level) + '/* %s */\n' % comment 28*8c643361SEric Blake if ifcond: 29*8c643361SEric Blake ret += gen_if(ifcond) 30d626b6c1SMarc-André Lureau ret += to_qlit(ifobj, level) 31*8c643361SEric Blake if ifcond: 32*8c643361SEric Blake ret += '\n' + gen_endif(ifcond) 33d626b6c1SMarc-André Lureau return ret 34d626b6c1SMarc-André Lureau 357d0f982bSMarc-André Lureau ret = '' 367d0f982bSMarc-André Lureau if not suppress_first_indent: 377d0f982bSMarc-André Lureau ret += indent(level) 38fb0bc835SMarkus Armbruster if obj is None: 397d0f982bSMarc-André Lureau ret += 'QLIT_QNULL' 40fb0bc835SMarkus Armbruster elif isinstance(obj, str): 417d0f982bSMarc-André Lureau ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 42fb0bc835SMarkus Armbruster elif isinstance(obj, list): 43d626b6c1SMarc-André Lureau elts = [to_qlit(elt, level + 1).strip('\n') 44fb0bc835SMarkus Armbruster for elt in obj] 457d0f982bSMarc-André Lureau elts.append(indent(level + 1) + "{}") 467d0f982bSMarc-André Lureau ret += 'QLIT_QLIST(((QLitObject[]) {\n' 4740bb1376SMarc-André Lureau ret += '\n'.join(elts) + '\n' 487d0f982bSMarc-André Lureau ret += indent(level) + '}))' 49fb0bc835SMarkus Armbruster elif isinstance(obj, dict): 507d0f982bSMarc-André Lureau elts = [] 517d0f982bSMarc-André Lureau for key, value in sorted(obj.items()): 527d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{ %s, %s }' % 537d0f982bSMarc-André Lureau (to_c_string(key), to_qlit(value, level + 1, True))) 547d0f982bSMarc-André Lureau elts.append(indent(level + 1) + '{}') 557d0f982bSMarc-André Lureau ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 567d0f982bSMarc-André Lureau ret += ',\n'.join(elts) + '\n' 577d0f982bSMarc-André Lureau ret += indent(level) + '}))' 58876c6751SPeter Xu elif isinstance(obj, bool): 59876c6751SPeter Xu ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 60fb0bc835SMarkus Armbruster else: 61fb0bc835SMarkus Armbruster assert False # not implemented 6240bb1376SMarc-André Lureau if level > 0: 6340bb1376SMarc-André Lureau ret += ',' 64fb0bc835SMarkus Armbruster return ret 65fb0bc835SMarkus Armbruster 66fb0bc835SMarkus Armbruster 67fb0bc835SMarkus Armbrusterdef to_c_string(string): 68fb0bc835SMarkus Armbruster return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 69fb0bc835SMarkus Armbruster 70fb0bc835SMarkus Armbruster 7171b3f045SMarkus Armbrusterclass QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 72fb0bc835SMarkus Armbruster 7371b3f045SMarkus Armbruster def __init__(self, prefix, unmask): 7471b3f045SMarkus Armbruster QAPISchemaMonolithicCVisitor.__init__( 75eb815e24SMarkus Armbruster self, prefix, 'qapi-introspect', 7671b3f045SMarkus Armbruster ' * QAPI/QMP schema introspection', __doc__) 7771b3f045SMarkus Armbruster self._unmask = unmask 7871b3f045SMarkus Armbruster self._schema = None 797d0f982bSMarc-André Lureau self._qlits = [] 80fb0bc835SMarkus Armbruster self._used_types = [] 81fb0bc835SMarkus Armbruster self._name_map = {} 8271b3f045SMarkus Armbruster self._genc.add(mcgen(''' 8371b3f045SMarkus Armbruster#include "qemu/osdep.h" 84eb815e24SMarkus Armbruster#include "%(prefix)sqapi-introspect.h" 8571b3f045SMarkus Armbruster 8671b3f045SMarkus Armbruster''', 8771b3f045SMarkus Armbruster prefix=prefix)) 8871b3f045SMarkus Armbruster 8971b3f045SMarkus Armbruster def visit_begin(self, schema): 9071b3f045SMarkus Armbruster self._schema = schema 91fb0bc835SMarkus Armbruster 92fb0bc835SMarkus Armbruster def visit_end(self): 93fb0bc835SMarkus Armbruster # visit the types that are actually used 94fb0bc835SMarkus Armbruster for typ in self._used_types: 95fb0bc835SMarkus Armbruster typ.visit(self) 96fb0bc835SMarkus Armbruster # generate C 977d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 9871b3f045SMarkus Armbruster self._genh.add(mcgen(''' 997d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 1007d0f982bSMarc-André Lureau 1017d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 102fb0bc835SMarkus Armbruster''', 10371b3f045SMarkus Armbruster c_name=c_name(name))) 10471b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1057d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 106fb0bc835SMarkus Armbruster''', 107fb0bc835SMarkus Armbruster c_name=c_name(name), 108da112e83SMarkus Armbruster c_string=to_qlit(self._qlits))) 109fb0bc835SMarkus Armbruster self._schema = None 1107d0f982bSMarc-André Lureau self._qlits = [] 11171b3f045SMarkus Armbruster self._used_types = [] 11271b3f045SMarkus Armbruster self._name_map = {} 113fb0bc835SMarkus Armbruster 114fb0bc835SMarkus Armbruster def visit_needed(self, entity): 115fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 116fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 117fb0bc835SMarkus Armbruster 118fb0bc835SMarkus Armbruster def _name(self, name): 119fb0bc835SMarkus Armbruster if self._unmask: 120fb0bc835SMarkus Armbruster return name 121fb0bc835SMarkus Armbruster if name not in self._name_map: 122fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 123fb0bc835SMarkus Armbruster return self._name_map[name] 124fb0bc835SMarkus Armbruster 125fb0bc835SMarkus Armbruster def _use_type(self, typ): 126fb0bc835SMarkus Armbruster # Map the various integer types to plain int 127fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 128fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 129fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 130fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 131fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 132fb0bc835SMarkus Armbruster # Add type to work queue if new 133fb0bc835SMarkus Armbruster if typ not in self._used_types: 134fb0bc835SMarkus Armbruster self._used_types.append(typ) 135fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 1361aa806ccSEric Blake # type names as integers to reduce the temptation. Also, it 1371aa806ccSEric Blake # saves a few characters on the wire. 138fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 139fb0bc835SMarkus Armbruster return typ.name 140fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 141fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 142fb0bc835SMarkus Armbruster return self._name(typ.name) 143fb0bc835SMarkus Armbruster 144d626b6c1SMarc-André Lureau def _gen_qlit(self, name, mtype, obj, ifcond): 145*8c643361SEric Blake extra = {} 146fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 147*8c643361SEric Blake if not self._unmask: 148*8c643361SEric Blake # Output a comment to make it easy to map masked names 149*8c643361SEric Blake # back to the source when reading the generated output. 150*8c643361SEric Blake extra['comment'] = '"%s" = %s' % (self._name(name), name) 151fb0bc835SMarkus Armbruster name = self._name(name) 152fb0bc835SMarkus Armbruster obj['name'] = name 153fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 154*8c643361SEric Blake if ifcond: 155*8c643361SEric Blake extra['if'] = ifcond 156*8c643361SEric Blake if extra: 157*8c643361SEric Blake self._qlits.append((obj, extra)) 158*8c643361SEric Blake else: 159*8c643361SEric Blake self._qlits.append(obj) 160fb0bc835SMarkus Armbruster 161fb0bc835SMarkus Armbruster def _gen_member(self, member): 162fb0bc835SMarkus Armbruster ret = {'name': member.name, 'type': self._use_type(member.type)} 163fb0bc835SMarkus Armbruster if member.optional: 164fb0bc835SMarkus Armbruster ret['default'] = None 165fb0bc835SMarkus Armbruster return ret 166fb0bc835SMarkus Armbruster 167fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 168fb0bc835SMarkus Armbruster return {'tag': tag_name, 169fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 170fb0bc835SMarkus Armbruster 171fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 172fb0bc835SMarkus Armbruster return {'case': variant.name, 'type': self._use_type(variant.type)} 173fb0bc835SMarkus Armbruster 174fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 175d626b6c1SMarc-André Lureau self._gen_qlit(name, 'builtin', {'json-type': json_type}, []) 176fb0bc835SMarkus Armbruster 177fbf09a2fSMarc-André Lureau def visit_enum_type(self, name, info, ifcond, values, prefix): 178d626b6c1SMarc-André Lureau self._gen_qlit(name, 'enum', {'values': values}, ifcond) 179fb0bc835SMarkus Armbruster 180fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 181fb0bc835SMarkus Armbruster element = self._use_type(element_type) 182d626b6c1SMarc-André Lureau self._gen_qlit('[' + element + ']', 'array', {'element-type': element}, 183d626b6c1SMarc-André Lureau ifcond) 184fb0bc835SMarkus Armbruster 185fbf09a2fSMarc-André Lureau def visit_object_type_flat(self, name, info, ifcond, members, variants): 186fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 187fb0bc835SMarkus Armbruster if variants: 188fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 189fb0bc835SMarkus Armbruster variants.variants)) 190d626b6c1SMarc-André Lureau self._gen_qlit(name, 'object', obj, ifcond) 191fb0bc835SMarkus Armbruster 192fbf09a2fSMarc-André Lureau def visit_alternate_type(self, name, info, ifcond, variants): 1937d0f982bSMarc-André Lureau self._gen_qlit(name, 'alternate', 194fb0bc835SMarkus Armbruster {'members': [{'type': self._use_type(m.type)} 195d626b6c1SMarc-André Lureau for m in variants.variants]}, ifcond) 196fb0bc835SMarkus Armbruster 197fbf09a2fSMarc-André Lureau def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, 198d6fe3d02SIgor Mammedov success_response, boxed, allow_oob, allow_preconfig): 199fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 200fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 20125b1ef31SMarkus Armbruster obj = {'arg-type': self._use_type(arg_type), 20225b1ef31SMarkus Armbruster 'ret-type': self._use_type(ret_type)} 20325b1ef31SMarkus Armbruster if allow_oob: 20425b1ef31SMarkus Armbruster obj['allow-oob'] = allow_oob 20525b1ef31SMarkus Armbruster self._gen_qlit(name, 'command', obj, ifcond) 206fb0bc835SMarkus Armbruster 207fbf09a2fSMarc-André Lureau def visit_event(self, name, info, ifcond, arg_type, boxed): 208fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 209d626b6c1SMarc-André Lureau self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)}, 210d626b6c1SMarc-André Lureau ifcond) 211fb0bc835SMarkus Armbruster 212fb0bc835SMarkus Armbruster 213fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 214fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 215fb0bc835SMarkus Armbruster schema.visit(vis) 21671b3f045SMarkus Armbruster vis.write(output_dir) 217