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 * 14from qapi.gen import QAPISchemaMonolithicCVisitor 15from qapi.schema import (QAPISchemaArrayType, QAPISchemaBuiltinType, 16 QAPISchemaType) 17 18 19def _tree_to_qlit(obj, level=0, suppress_first_indent=False): 20 21 def indent(level): 22 return level * 4 * ' ' 23 24 if isinstance(obj, tuple): 25 ifobj, extra = obj 26 ifcond = extra.get('if') 27 comment = extra.get('comment') 28 ret = '' 29 if comment: 30 ret += indent(level) + '/* %s */\n' % comment 31 if ifcond: 32 ret += gen_if(ifcond) 33 ret += _tree_to_qlit(ifobj, level) 34 if ifcond: 35 ret += '\n' + gen_endif(ifcond) 36 return ret 37 38 ret = '' 39 if not suppress_first_indent: 40 ret += indent(level) 41 if obj is None: 42 ret += 'QLIT_QNULL' 43 elif isinstance(obj, str): 44 ret += 'QLIT_QSTR(' + to_c_string(obj) + ')' 45 elif isinstance(obj, list): 46 elts = [_tree_to_qlit(elt, level + 1).strip('\n') 47 for elt in obj] 48 elts.append(indent(level + 1) + "{}") 49 ret += 'QLIT_QLIST(((QLitObject[]) {\n' 50 ret += '\n'.join(elts) + '\n' 51 ret += indent(level) + '}))' 52 elif isinstance(obj, dict): 53 elts = [] 54 for key, value in sorted(obj.items()): 55 elts.append(indent(level + 1) + '{ %s, %s }' % 56 (to_c_string(key), 57 _tree_to_qlit(value, level + 1, True))) 58 elts.append(indent(level + 1) + '{}') 59 ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n' 60 ret += ',\n'.join(elts) + '\n' 61 ret += indent(level) + '}))' 62 elif isinstance(obj, bool): 63 ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false') 64 else: 65 assert False # not implemented 66 if level > 0: 67 ret += ',' 68 return ret 69 70 71def to_c_string(string): 72 return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 73 74 75class QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 76 77 def __init__(self, prefix, unmask): 78 super().__init__( 79 prefix, 'qapi-introspect', 80 ' * QAPI/QMP schema introspection', __doc__) 81 self._unmask = unmask 82 self._schema = None 83 self._trees = [] 84 self._used_types = [] 85 self._name_map = {} 86 self._genc.add(mcgen(''' 87#include "qemu/osdep.h" 88#include "%(prefix)sqapi-introspect.h" 89 90''', 91 prefix=prefix)) 92 93 def visit_begin(self, schema): 94 self._schema = schema 95 96 def visit_end(self): 97 # visit the types that are actually used 98 for typ in self._used_types: 99 typ.visit(self) 100 # generate C 101 name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 102 self._genh.add(mcgen(''' 103#include "qapi/qmp/qlit.h" 104 105extern const QLitObject %(c_name)s; 106''', 107 c_name=c_name(name))) 108 self._genc.add(mcgen(''' 109const QLitObject %(c_name)s = %(c_string)s; 110''', 111 c_name=c_name(name), 112 c_string=_tree_to_qlit(self._trees))) 113 self._schema = None 114 self._trees = [] 115 self._used_types = [] 116 self._name_map = {} 117 118 def visit_needed(self, entity): 119 # Ignore types on first pass; visit_end() will pick up used types 120 return not isinstance(entity, QAPISchemaType) 121 122 def _name(self, name): 123 if self._unmask: 124 return name 125 if name not in self._name_map: 126 self._name_map[name] = '%d' % len(self._name_map) 127 return self._name_map[name] 128 129 def _use_type(self, typ): 130 # Map the various integer types to plain int 131 if typ.json_type() == 'int': 132 typ = self._schema.lookup_type('int') 133 elif (isinstance(typ, QAPISchemaArrayType) and 134 typ.element_type.json_type() == 'int'): 135 typ = self._schema.lookup_type('intList') 136 # Add type to work queue if new 137 if typ not in self._used_types: 138 self._used_types.append(typ) 139 # Clients should examine commands and events, not types. Hide 140 # type names as integers to reduce the temptation. Also, it 141 # saves a few characters on the wire. 142 if isinstance(typ, QAPISchemaBuiltinType): 143 return typ.name 144 if isinstance(typ, QAPISchemaArrayType): 145 return '[' + self._use_type(typ.element_type) + ']' 146 return self._name(typ.name) 147 148 def _gen_tree(self, name, mtype, obj, ifcond, features): 149 extra = {} 150 if mtype not in ('command', 'event', 'builtin', 'array'): 151 if not self._unmask: 152 # Output a comment to make it easy to map masked names 153 # back to the source when reading the generated output. 154 extra['comment'] = '"%s" = %s' % (self._name(name), name) 155 name = self._name(name) 156 obj['name'] = name 157 obj['meta-type'] = mtype 158 if features: 159 obj['features'] = [(f.name, {'if': f.ifcond}) for f in features] 160 if ifcond: 161 extra['if'] = ifcond 162 if extra: 163 self._trees.append((obj, extra)) 164 else: 165 self._trees.append(obj) 166 167 def _gen_member(self, member): 168 ret = {'name': member.name, 'type': self._use_type(member.type)} 169 if member.optional: 170 ret['default'] = None 171 if member.ifcond: 172 ret = (ret, {'if': member.ifcond}) 173 return ret 174 175 def _gen_variants(self, tag_name, variants): 176 return {'tag': tag_name, 177 'variants': [self._gen_variant(v) for v in variants]} 178 179 def _gen_variant(self, variant): 180 return ({'case': variant.name, 'type': self._use_type(variant.type)}, 181 {'if': variant.ifcond}) 182 183 def visit_builtin_type(self, name, info, json_type): 184 self._gen_tree(name, 'builtin', {'json-type': json_type}, [], None) 185 186 def visit_enum_type(self, name, info, ifcond, features, members, prefix): 187 self._gen_tree(name, 'enum', 188 {'values': 189 [(m.name, {'if': m.ifcond}) for m in members]}, 190 ifcond, features) 191 192 def visit_array_type(self, name, info, ifcond, element_type): 193 element = self._use_type(element_type) 194 self._gen_tree('[' + element + ']', 'array', {'element-type': element}, 195 ifcond, None) 196 197 def visit_object_type_flat(self, name, info, ifcond, features, 198 members, variants): 199 obj = {'members': [self._gen_member(m) for m in members]} 200 if variants: 201 obj.update(self._gen_variants(variants.tag_member.name, 202 variants.variants)) 203 204 self._gen_tree(name, 'object', obj, ifcond, features) 205 206 def visit_alternate_type(self, name, info, ifcond, features, variants): 207 self._gen_tree(name, 'alternate', 208 {'members': [ 209 ({'type': self._use_type(m.type)}, {'if': m.ifcond}) 210 for m in variants.variants]}, 211 ifcond, features) 212 213 def visit_command(self, name, info, ifcond, features, 214 arg_type, ret_type, gen, success_response, boxed, 215 allow_oob, allow_preconfig): 216 arg_type = arg_type or self._schema.the_empty_object_type 217 ret_type = ret_type or self._schema.the_empty_object_type 218 obj = {'arg-type': self._use_type(arg_type), 219 'ret-type': self._use_type(ret_type)} 220 if allow_oob: 221 obj['allow-oob'] = allow_oob 222 self._gen_tree(name, 'command', obj, ifcond, features) 223 224 def visit_event(self, name, info, ifcond, features, arg_type, boxed): 225 arg_type = arg_type or self._schema.the_empty_object_type 226 self._gen_tree(name, 'event', {'arg-type': self._use_type(arg_type)}, 227 ifcond, features) 228 229 230def gen_introspect(schema, output_dir, prefix, opt_unmask): 231 vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 232 schema.visit(vis) 233 vis.write(output_dir) 234