1""" 2QAPI introspection generator 3 4Copyright (C) 2015-2018 Red Hat, Inc. 5 6Authors: 7 Markus Armbruster <armbru@redhat.com> 8 9This work is licensed under the terms of the GNU GPL, version 2. 10See the COPYING file in the top-level directory. 11""" 12 13from qapi.common import * 14 15 16def to_qlit(obj, level=0, suppress_first_indent=False): 17 18 def indent(level): 19 return level * 4 * ' ' 20 21 ret = '' 22 if not suppress_first_indent: 23 ret += indent(level) 24 if obj is None: 25 ret += 'QLIT_QNULL' 26 elif isinstance(obj, str): 27 ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 28 elif isinstance(obj, list): 29 elts = [to_qlit(elt, level + 1) 30 for elt in obj] 31 elts.append(indent(level + 1) + "{}") 32 ret += 'QLIT_QLIST(((QLitObject[]) {\n' 33 ret += '\n'.join(elts) + '\n' 34 ret += indent(level) + '}))' 35 elif isinstance(obj, dict): 36 elts = [] 37 for key, value in sorted(obj.items()): 38 elts.append(indent(level + 1) + '{ %s, %s }' % 39 (to_c_string(key), to_qlit(value, level + 1, True))) 40 elts.append(indent(level + 1) + '{}') 41 ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 42 ret += ',\n'.join(elts) + '\n' 43 ret += indent(level) + '}))' 44 elif isinstance(obj, bool): 45 ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 46 else: 47 assert False # not implemented 48 if level > 0: 49 ret += ',' 50 return ret 51 52 53def to_c_string(string): 54 return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 55 56 57class QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 58 59 def __init__(self, prefix, unmask): 60 QAPISchemaMonolithicCVisitor.__init__( 61 self, prefix, 'qapi-introspect', 62 ' * QAPI/QMP schema introspection', __doc__) 63 self._unmask = unmask 64 self._schema = None 65 self._qlits = [] 66 self._used_types = [] 67 self._name_map = {} 68 self._genc.add(mcgen(''' 69#include "qemu/osdep.h" 70#include "%(prefix)sqapi-introspect.h" 71 72''', 73 prefix=prefix)) 74 75 def visit_begin(self, schema): 76 self._schema = schema 77 78 def visit_end(self): 79 # visit the types that are actually used 80 for typ in self._used_types: 81 typ.visit(self) 82 # generate C 83 # TODO can generate awfully long lines 84 name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 85 self._genh.add(mcgen(''' 86#include "qapi/qmp/qlit.h" 87 88extern const QLitObject %(c_name)s; 89''', 90 c_name=c_name(name))) 91 self._genc.add(mcgen(''' 92const QLitObject %(c_name)s = %(c_string)s; 93''', 94 c_name=c_name(name), 95 c_string=to_qlit(self._qlits))) 96 self._schema = None 97 self._qlits = [] 98 self._used_types = [] 99 self._name_map = {} 100 101 def visit_needed(self, entity): 102 # Ignore types on first pass; visit_end() will pick up used types 103 return not isinstance(entity, QAPISchemaType) 104 105 def _name(self, name): 106 if self._unmask: 107 return name 108 if name not in self._name_map: 109 self._name_map[name] = '%d' % len(self._name_map) 110 return self._name_map[name] 111 112 def _use_type(self, typ): 113 # Map the various integer types to plain int 114 if typ.json_type() == 'int': 115 typ = self._schema.lookup_type('int') 116 elif (isinstance(typ, QAPISchemaArrayType) and 117 typ.element_type.json_type() == 'int'): 118 typ = self._schema.lookup_type('intList') 119 # Add type to work queue if new 120 if typ not in self._used_types: 121 self._used_types.append(typ) 122 # Clients should examine commands and events, not types. Hide 123 # type names to reduce the temptation. Also saves a few 124 # characters. 125 if isinstance(typ, QAPISchemaBuiltinType): 126 return typ.name 127 if isinstance(typ, QAPISchemaArrayType): 128 return '[' + self._use_type(typ.element_type) + ']' 129 return self._name(typ.name) 130 131 def _gen_qlit(self, name, mtype, obj): 132 if mtype not in ('command', 'event', 'builtin', 'array'): 133 name = self._name(name) 134 obj['name'] = name 135 obj['meta-type'] = mtype 136 self._qlits.append(obj) 137 138 def _gen_member(self, member): 139 ret = {'name': member.name, 'type': self._use_type(member.type)} 140 if member.optional: 141 ret['default'] = None 142 return ret 143 144 def _gen_variants(self, tag_name, variants): 145 return {'tag': tag_name, 146 'variants': [self._gen_variant(v) for v in variants]} 147 148 def _gen_variant(self, variant): 149 return {'case': variant.name, 'type': self._use_type(variant.type)} 150 151 def visit_builtin_type(self, name, info, json_type): 152 self._gen_qlit(name, 'builtin', {'json-type': json_type}) 153 154 def visit_enum_type(self, name, info, ifcond, values, prefix): 155 self._gen_qlit(name, 'enum', {'values': values}) 156 157 def visit_array_type(self, name, info, ifcond, element_type): 158 element = self._use_type(element_type) 159 self._gen_qlit('[' + element + ']', 'array', {'element-type': element}) 160 161 def visit_object_type_flat(self, name, info, ifcond, members, variants): 162 obj = {'members': [self._gen_member(m) for m in members]} 163 if variants: 164 obj.update(self._gen_variants(variants.tag_member.name, 165 variants.variants)) 166 self._gen_qlit(name, 'object', obj) 167 168 def visit_alternate_type(self, name, info, ifcond, variants): 169 self._gen_qlit(name, 'alternate', 170 {'members': [{'type': self._use_type(m.type)} 171 for m in variants.variants]}) 172 173 def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, 174 success_response, boxed, allow_oob, allow_preconfig): 175 arg_type = arg_type or self._schema.the_empty_object_type 176 ret_type = ret_type or self._schema.the_empty_object_type 177 self._gen_qlit(name, 'command', 178 {'arg-type': self._use_type(arg_type), 179 'ret-type': self._use_type(ret_type), 180 'allow-oob': allow_oob, 181 'allow-preconfig': allow_preconfig}) 182 183 def visit_event(self, name, info, ifcond, arg_type, boxed): 184 arg_type = arg_type or self._schema.the_empty_object_type 185 self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)}) 186 187 188def gen_introspect(schema, output_dir, prefix, opt_unmask): 189 vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 190 schema.visit(vis) 191 vis.write(output_dir) 192