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 21*d626b6c1SMarc-André Lureau if isinstance(obj, tuple): 22*d626b6c1SMarc-André Lureau ifobj, ifcond = obj 23*d626b6c1SMarc-André Lureau ret = gen_if(ifcond) 24*d626b6c1SMarc-André Lureau ret += to_qlit(ifobj, level) 25*d626b6c1SMarc-André Lureau endif = gen_endif(ifcond) 26*d626b6c1SMarc-André Lureau if endif: 27*d626b6c1SMarc-André Lureau ret += '\n' + endif 28*d626b6c1SMarc-André Lureau return ret 29*d626b6c1SMarc-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): 38*d626b6c1SMarc-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 92fb0bc835SMarkus Armbruster # TODO can generate awfully long lines 937d0f982bSMarc-André Lureau name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 9471b3f045SMarkus Armbruster self._genh.add(mcgen(''' 957d0f982bSMarc-André Lureau#include "qapi/qmp/qlit.h" 967d0f982bSMarc-André Lureau 977d0f982bSMarc-André Lureauextern const QLitObject %(c_name)s; 98fb0bc835SMarkus Armbruster''', 9971b3f045SMarkus Armbruster c_name=c_name(name))) 10071b3f045SMarkus Armbruster self._genc.add(mcgen(''' 1017d0f982bSMarc-André Lureauconst QLitObject %(c_name)s = %(c_string)s; 102fb0bc835SMarkus Armbruster''', 103fb0bc835SMarkus Armbruster c_name=c_name(name), 104da112e83SMarkus Armbruster c_string=to_qlit(self._qlits))) 105fb0bc835SMarkus Armbruster self._schema = None 1067d0f982bSMarc-André Lureau self._qlits = [] 10771b3f045SMarkus Armbruster self._used_types = [] 10871b3f045SMarkus Armbruster self._name_map = {} 109fb0bc835SMarkus Armbruster 110fb0bc835SMarkus Armbruster def visit_needed(self, entity): 111fb0bc835SMarkus Armbruster # Ignore types on first pass; visit_end() will pick up used types 112fb0bc835SMarkus Armbruster return not isinstance(entity, QAPISchemaType) 113fb0bc835SMarkus Armbruster 114fb0bc835SMarkus Armbruster def _name(self, name): 115fb0bc835SMarkus Armbruster if self._unmask: 116fb0bc835SMarkus Armbruster return name 117fb0bc835SMarkus Armbruster if name not in self._name_map: 118fb0bc835SMarkus Armbruster self._name_map[name] = '%d' % len(self._name_map) 119fb0bc835SMarkus Armbruster return self._name_map[name] 120fb0bc835SMarkus Armbruster 121fb0bc835SMarkus Armbruster def _use_type(self, typ): 122fb0bc835SMarkus Armbruster # Map the various integer types to plain int 123fb0bc835SMarkus Armbruster if typ.json_type() == 'int': 124fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('int') 125fb0bc835SMarkus Armbruster elif (isinstance(typ, QAPISchemaArrayType) and 126fb0bc835SMarkus Armbruster typ.element_type.json_type() == 'int'): 127fb0bc835SMarkus Armbruster typ = self._schema.lookup_type('intList') 128fb0bc835SMarkus Armbruster # Add type to work queue if new 129fb0bc835SMarkus Armbruster if typ not in self._used_types: 130fb0bc835SMarkus Armbruster self._used_types.append(typ) 131fb0bc835SMarkus Armbruster # Clients should examine commands and events, not types. Hide 132fb0bc835SMarkus Armbruster # type names to reduce the temptation. Also saves a few 133fb0bc835SMarkus Armbruster # characters. 134fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaBuiltinType): 135fb0bc835SMarkus Armbruster return typ.name 136fb0bc835SMarkus Armbruster if isinstance(typ, QAPISchemaArrayType): 137fb0bc835SMarkus Armbruster return '[' + self._use_type(typ.element_type) + ']' 138fb0bc835SMarkus Armbruster return self._name(typ.name) 139fb0bc835SMarkus Armbruster 140*d626b6c1SMarc-André Lureau def _gen_qlit(self, name, mtype, obj, ifcond): 141fb0bc835SMarkus Armbruster if mtype not in ('command', 'event', 'builtin', 'array'): 142fb0bc835SMarkus Armbruster name = self._name(name) 143fb0bc835SMarkus Armbruster obj['name'] = name 144fb0bc835SMarkus Armbruster obj['meta-type'] = mtype 145*d626b6c1SMarc-André Lureau self._qlits.append((obj, ifcond)) 146fb0bc835SMarkus Armbruster 147fb0bc835SMarkus Armbruster def _gen_member(self, member): 148fb0bc835SMarkus Armbruster ret = {'name': member.name, 'type': self._use_type(member.type)} 149fb0bc835SMarkus Armbruster if member.optional: 150fb0bc835SMarkus Armbruster ret['default'] = None 151fb0bc835SMarkus Armbruster return ret 152fb0bc835SMarkus Armbruster 153fb0bc835SMarkus Armbruster def _gen_variants(self, tag_name, variants): 154fb0bc835SMarkus Armbruster return {'tag': tag_name, 155fb0bc835SMarkus Armbruster 'variants': [self._gen_variant(v) for v in variants]} 156fb0bc835SMarkus Armbruster 157fb0bc835SMarkus Armbruster def _gen_variant(self, variant): 158fb0bc835SMarkus Armbruster return {'case': variant.name, 'type': self._use_type(variant.type)} 159fb0bc835SMarkus Armbruster 160fb0bc835SMarkus Armbruster def visit_builtin_type(self, name, info, json_type): 161*d626b6c1SMarc-André Lureau self._gen_qlit(name, 'builtin', {'json-type': json_type}, []) 162fb0bc835SMarkus Armbruster 163fbf09a2fSMarc-André Lureau def visit_enum_type(self, name, info, ifcond, values, prefix): 164*d626b6c1SMarc-André Lureau self._gen_qlit(name, 'enum', {'values': values}, ifcond) 165fb0bc835SMarkus Armbruster 166fbf09a2fSMarc-André Lureau def visit_array_type(self, name, info, ifcond, element_type): 167fb0bc835SMarkus Armbruster element = self._use_type(element_type) 168*d626b6c1SMarc-André Lureau self._gen_qlit('[' + element + ']', 'array', {'element-type': element}, 169*d626b6c1SMarc-André Lureau ifcond) 170fb0bc835SMarkus Armbruster 171fbf09a2fSMarc-André Lureau def visit_object_type_flat(self, name, info, ifcond, members, variants): 172fb0bc835SMarkus Armbruster obj = {'members': [self._gen_member(m) for m in members]} 173fb0bc835SMarkus Armbruster if variants: 174fb0bc835SMarkus Armbruster obj.update(self._gen_variants(variants.tag_member.name, 175fb0bc835SMarkus Armbruster variants.variants)) 176*d626b6c1SMarc-André Lureau self._gen_qlit(name, 'object', obj, ifcond) 177fb0bc835SMarkus Armbruster 178fbf09a2fSMarc-André Lureau def visit_alternate_type(self, name, info, ifcond, variants): 1797d0f982bSMarc-André Lureau self._gen_qlit(name, 'alternate', 180fb0bc835SMarkus Armbruster {'members': [{'type': self._use_type(m.type)} 181*d626b6c1SMarc-André Lureau for m in variants.variants]}, ifcond) 182fb0bc835SMarkus Armbruster 183fbf09a2fSMarc-André Lureau def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, 184d6fe3d02SIgor Mammedov success_response, boxed, allow_oob, allow_preconfig): 185fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 186fb0bc835SMarkus Armbruster ret_type = ret_type or self._schema.the_empty_object_type 1877d0f982bSMarc-André Lureau self._gen_qlit(name, 'command', 188fb0bc835SMarkus Armbruster {'arg-type': self._use_type(arg_type), 189876c6751SPeter Xu 'ret-type': self._use_type(ret_type), 190d6fe3d02SIgor Mammedov 'allow-oob': allow_oob, 191*d626b6c1SMarc-André Lureau 'allow-preconfig': allow_preconfig}, ifcond) 192fb0bc835SMarkus Armbruster 193fbf09a2fSMarc-André Lureau def visit_event(self, name, info, ifcond, arg_type, boxed): 194fb0bc835SMarkus Armbruster arg_type = arg_type or self._schema.the_empty_object_type 195*d626b6c1SMarc-André Lureau self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)}, 196*d626b6c1SMarc-André Lureau ifcond) 197fb0bc835SMarkus Armbruster 198fb0bc835SMarkus Armbruster 199fb0bc835SMarkus Armbrusterdef gen_introspect(schema, output_dir, prefix, opt_unmask): 200fb0bc835SMarkus Armbruster vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 201fb0bc835SMarkus Armbruster schema.visit(vis) 20271b3f045SMarkus Armbruster vis.write(output_dir) 203