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 else: 45 assert False # not implemented 46 return ret 47 48 49def to_c_string(string): 50 return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"' 51 52 53class QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor): 54 55 def __init__(self, prefix, unmask): 56 QAPISchemaMonolithicCVisitor.__init__( 57 self, prefix, 'qapi-introspect', 58 ' * QAPI/QMP schema introspection', __doc__) 59 self._unmask = unmask 60 self._schema = None 61 self._qlits = [] 62 self._used_types = [] 63 self._name_map = {} 64 self._genc.add(mcgen(''' 65#include "qemu/osdep.h" 66#include "%(prefix)sqapi-introspect.h" 67 68''', 69 prefix=prefix)) 70 71 def visit_begin(self, schema): 72 self._schema = schema 73 74 def visit_end(self): 75 # visit the types that are actually used 76 qlits = self._qlits 77 self._qlits = [] 78 for typ in self._used_types: 79 typ.visit(self) 80 # generate C 81 # TODO can generate awfully long lines 82 qlits.extend(self._qlits) 83 name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit' 84 self._genh.add(mcgen(''' 85#include "qapi/qmp/qlit.h" 86 87extern const QLitObject %(c_name)s; 88''', 89 c_name=c_name(name))) 90 self._genc.add(mcgen(''' 91const QLitObject %(c_name)s = %(c_string)s; 92''', 93 c_name=c_name(name), 94 c_string=to_qlit(qlits))) 95 self._schema = None 96 self._qlits = [] 97 self._used_types = [] 98 self._name_map = {} 99 100 def visit_needed(self, entity): 101 # Ignore types on first pass; visit_end() will pick up used types 102 return not isinstance(entity, QAPISchemaType) 103 104 def _name(self, name): 105 if self._unmask: 106 return name 107 if name not in self._name_map: 108 self._name_map[name] = '%d' % len(self._name_map) 109 return self._name_map[name] 110 111 def _use_type(self, typ): 112 # Map the various integer types to plain int 113 if typ.json_type() == 'int': 114 typ = self._schema.lookup_type('int') 115 elif (isinstance(typ, QAPISchemaArrayType) and 116 typ.element_type.json_type() == 'int'): 117 typ = self._schema.lookup_type('intList') 118 # Add type to work queue if new 119 if typ not in self._used_types: 120 self._used_types.append(typ) 121 # Clients should examine commands and events, not types. Hide 122 # type names to reduce the temptation. Also saves a few 123 # characters. 124 if isinstance(typ, QAPISchemaBuiltinType): 125 return typ.name 126 if isinstance(typ, QAPISchemaArrayType): 127 return '[' + self._use_type(typ.element_type) + ']' 128 return self._name(typ.name) 129 130 def _gen_qlit(self, name, mtype, obj): 131 if mtype not in ('command', 'event', 'builtin', 'array'): 132 name = self._name(name) 133 obj['name'] = name 134 obj['meta-type'] = mtype 135 self._qlits.append(obj) 136 137 def _gen_member(self, member): 138 ret = {'name': member.name, 'type': self._use_type(member.type)} 139 if member.optional: 140 ret['default'] = None 141 return ret 142 143 def _gen_variants(self, tag_name, variants): 144 return {'tag': tag_name, 145 'variants': [self._gen_variant(v) for v in variants]} 146 147 def _gen_variant(self, variant): 148 return {'case': variant.name, 'type': self._use_type(variant.type)} 149 150 def visit_builtin_type(self, name, info, json_type): 151 self._gen_qlit(name, 'builtin', {'json-type': json_type}) 152 153 def visit_enum_type(self, name, info, values, prefix): 154 self._gen_qlit(name, 'enum', {'values': values}) 155 156 def visit_array_type(self, name, info, element_type): 157 element = self._use_type(element_type) 158 self._gen_qlit('[' + element + ']', 'array', {'element-type': element}) 159 160 def visit_object_type_flat(self, name, info, members, variants): 161 obj = {'members': [self._gen_member(m) for m in members]} 162 if variants: 163 obj.update(self._gen_variants(variants.tag_member.name, 164 variants.variants)) 165 self._gen_qlit(name, 'object', obj) 166 167 def visit_alternate_type(self, name, info, variants): 168 self._gen_qlit(name, 'alternate', 169 {'members': [{'type': self._use_type(m.type)} 170 for m in variants.variants]}) 171 172 def visit_command(self, name, info, arg_type, ret_type, 173 gen, success_response, boxed): 174 arg_type = arg_type or self._schema.the_empty_object_type 175 ret_type = ret_type or self._schema.the_empty_object_type 176 self._gen_qlit(name, 'command', 177 {'arg-type': self._use_type(arg_type), 178 'ret-type': self._use_type(ret_type)}) 179 180 def visit_event(self, name, info, arg_type, boxed): 181 arg_type = arg_type or self._schema.the_empty_object_type 182 self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)}) 183 184 185def gen_introspect(schema, output_dir, prefix, opt_unmask): 186 vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask) 187 schema.visit(vis) 188 vis.write(output_dir) 189