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