23394b4c39
Similarly to features for struct types introduce the feature flags also
for commands. This will allow notifying management layers of fixes and
compatible changes in the behaviour of a command which may not be
detectable any other way.
The changes were heavily inspired by commit 6a8c0b5102.
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20191018081454.21369-3-armbru@redhat.com>
238 lines
8.2 KiB
Python
238 lines
8.2 KiB
Python
"""
|
|
QAPI introspection generator
|
|
|
|
Copyright (C) 2015-2018 Red Hat, Inc.
|
|
|
|
Authors:
|
|
Markus Armbruster <armbru@redhat.com>
|
|
|
|
This work is licensed under the terms of the GNU GPL, version 2.
|
|
See the COPYING file in the top-level directory.
|
|
"""
|
|
|
|
import string
|
|
|
|
from qapi.common import *
|
|
from qapi.gen import QAPISchemaMonolithicCVisitor
|
|
from qapi.schema import (QAPISchemaArrayType, QAPISchemaBuiltinType,
|
|
QAPISchemaType)
|
|
|
|
|
|
def to_qlit(obj, level=0, suppress_first_indent=False):
|
|
|
|
def indent(level):
|
|
return level * 4 * ' '
|
|
|
|
if isinstance(obj, tuple):
|
|
ifobj, extra = obj
|
|
ifcond = extra.get('if')
|
|
comment = extra.get('comment')
|
|
ret = ''
|
|
if comment:
|
|
ret += indent(level) + '/* %s */\n' % comment
|
|
if ifcond:
|
|
ret += gen_if(ifcond)
|
|
ret += to_qlit(ifobj, level)
|
|
if ifcond:
|
|
ret += '\n' + gen_endif(ifcond)
|
|
return ret
|
|
|
|
ret = ''
|
|
if not suppress_first_indent:
|
|
ret += indent(level)
|
|
if obj is None:
|
|
ret += 'QLIT_QNULL'
|
|
elif isinstance(obj, str):
|
|
ret += 'QLIT_QSTR(' + to_c_string(obj) + ')'
|
|
elif isinstance(obj, list):
|
|
elts = [to_qlit(elt, level + 1).strip('\n')
|
|
for elt in obj]
|
|
elts.append(indent(level + 1) + "{}")
|
|
ret += 'QLIT_QLIST(((QLitObject[]) {\n'
|
|
ret += '\n'.join(elts) + '\n'
|
|
ret += indent(level) + '}))'
|
|
elif isinstance(obj, dict):
|
|
elts = []
|
|
for key, value in sorted(obj.items()):
|
|
elts.append(indent(level + 1) + '{ %s, %s }' %
|
|
(to_c_string(key), to_qlit(value, level + 1, True)))
|
|
elts.append(indent(level + 1) + '{}')
|
|
ret += 'QLIT_QDICT(((QLitDictEntry[]) {\n'
|
|
ret += ',\n'.join(elts) + '\n'
|
|
ret += indent(level) + '}))'
|
|
elif isinstance(obj, bool):
|
|
ret += 'QLIT_QBOOL(%s)' % ('true' if obj else 'false')
|
|
else:
|
|
assert False # not implemented
|
|
if level > 0:
|
|
ret += ','
|
|
return ret
|
|
|
|
|
|
def to_c_string(string):
|
|
return '"' + string.replace('\\', r'\\').replace('"', r'\"') + '"'
|
|
|
|
|
|
class QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor):
|
|
|
|
def __init__(self, prefix, unmask):
|
|
QAPISchemaMonolithicCVisitor.__init__(
|
|
self, prefix, 'qapi-introspect',
|
|
' * QAPI/QMP schema introspection', __doc__)
|
|
self._unmask = unmask
|
|
self._schema = None
|
|
self._qlits = []
|
|
self._used_types = []
|
|
self._name_map = {}
|
|
self._genc.add(mcgen('''
|
|
#include "qemu/osdep.h"
|
|
#include "%(prefix)sqapi-introspect.h"
|
|
|
|
''',
|
|
prefix=prefix))
|
|
|
|
def visit_begin(self, schema):
|
|
self._schema = schema
|
|
|
|
def visit_end(self):
|
|
# visit the types that are actually used
|
|
for typ in self._used_types:
|
|
typ.visit(self)
|
|
# generate C
|
|
name = c_name(self._prefix, protect=False) + 'qmp_schema_qlit'
|
|
self._genh.add(mcgen('''
|
|
#include "qapi/qmp/qlit.h"
|
|
|
|
extern const QLitObject %(c_name)s;
|
|
''',
|
|
c_name=c_name(name)))
|
|
self._genc.add(mcgen('''
|
|
const QLitObject %(c_name)s = %(c_string)s;
|
|
''',
|
|
c_name=c_name(name),
|
|
c_string=to_qlit(self._qlits)))
|
|
self._schema = None
|
|
self._qlits = []
|
|
self._used_types = []
|
|
self._name_map = {}
|
|
|
|
def visit_needed(self, entity):
|
|
# Ignore types on first pass; visit_end() will pick up used types
|
|
return not isinstance(entity, QAPISchemaType)
|
|
|
|
def _name(self, name):
|
|
if self._unmask:
|
|
return name
|
|
if name not in self._name_map:
|
|
self._name_map[name] = '%d' % len(self._name_map)
|
|
return self._name_map[name]
|
|
|
|
def _use_type(self, typ):
|
|
# Map the various integer types to plain int
|
|
if typ.json_type() == 'int':
|
|
typ = self._schema.lookup_type('int')
|
|
elif (isinstance(typ, QAPISchemaArrayType) and
|
|
typ.element_type.json_type() == 'int'):
|
|
typ = self._schema.lookup_type('intList')
|
|
# Add type to work queue if new
|
|
if typ not in self._used_types:
|
|
self._used_types.append(typ)
|
|
# Clients should examine commands and events, not types. Hide
|
|
# type names as integers to reduce the temptation. Also, it
|
|
# saves a few characters on the wire.
|
|
if isinstance(typ, QAPISchemaBuiltinType):
|
|
return typ.name
|
|
if isinstance(typ, QAPISchemaArrayType):
|
|
return '[' + self._use_type(typ.element_type) + ']'
|
|
return self._name(typ.name)
|
|
|
|
def _gen_qlit(self, name, mtype, obj, ifcond):
|
|
extra = {}
|
|
if mtype not in ('command', 'event', 'builtin', 'array'):
|
|
if not self._unmask:
|
|
# Output a comment to make it easy to map masked names
|
|
# back to the source when reading the generated output.
|
|
extra['comment'] = '"%s" = %s' % (self._name(name), name)
|
|
name = self._name(name)
|
|
obj['name'] = name
|
|
obj['meta-type'] = mtype
|
|
if ifcond:
|
|
extra['if'] = ifcond
|
|
if extra:
|
|
self._qlits.append((obj, extra))
|
|
else:
|
|
self._qlits.append(obj)
|
|
|
|
def _gen_member(self, member):
|
|
ret = {'name': member.name, 'type': self._use_type(member.type)}
|
|
if member.optional:
|
|
ret['default'] = None
|
|
if member.ifcond:
|
|
ret = (ret, {'if': member.ifcond})
|
|
return ret
|
|
|
|
def _gen_variants(self, tag_name, variants):
|
|
return {'tag': tag_name,
|
|
'variants': [self._gen_variant(v) for v in variants]}
|
|
|
|
def _gen_variant(self, variant):
|
|
return ({'case': variant.name, 'type': self._use_type(variant.type)},
|
|
{'if': variant.ifcond})
|
|
|
|
def visit_builtin_type(self, name, info, json_type):
|
|
self._gen_qlit(name, 'builtin', {'json-type': json_type}, [])
|
|
|
|
def visit_enum_type(self, name, info, ifcond, members, prefix):
|
|
self._gen_qlit(name, 'enum',
|
|
{'values':
|
|
[(m.name, {'if': m.ifcond}) for m in members]},
|
|
ifcond)
|
|
|
|
def visit_array_type(self, name, info, ifcond, element_type):
|
|
element = self._use_type(element_type)
|
|
self._gen_qlit('[' + element + ']', 'array', {'element-type': element},
|
|
ifcond)
|
|
|
|
def visit_object_type_flat(self, name, info, ifcond, members, variants,
|
|
features):
|
|
obj = {'members': [self._gen_member(m) for m in members]}
|
|
if variants:
|
|
obj.update(self._gen_variants(variants.tag_member.name,
|
|
variants.variants))
|
|
if features:
|
|
obj['features'] = [(f.name, {'if': f.ifcond}) for f in features]
|
|
|
|
self._gen_qlit(name, 'object', obj, ifcond)
|
|
|
|
def visit_alternate_type(self, name, info, ifcond, variants):
|
|
self._gen_qlit(name, 'alternate',
|
|
{'members': [
|
|
({'type': self._use_type(m.type)}, {'if': m.ifcond})
|
|
for m in variants.variants]}, ifcond)
|
|
|
|
def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
|
|
success_response, boxed, allow_oob, allow_preconfig,
|
|
features):
|
|
arg_type = arg_type or self._schema.the_empty_object_type
|
|
ret_type = ret_type or self._schema.the_empty_object_type
|
|
obj = {'arg-type': self._use_type(arg_type),
|
|
'ret-type': self._use_type(ret_type)}
|
|
if allow_oob:
|
|
obj['allow-oob'] = allow_oob
|
|
|
|
if features:
|
|
obj['features'] = [(f.name, {'if': f.ifcond}) for f in features]
|
|
|
|
self._gen_qlit(name, 'command', obj, ifcond)
|
|
|
|
def visit_event(self, name, info, ifcond, arg_type, boxed):
|
|
arg_type = arg_type or self._schema.the_empty_object_type
|
|
self._gen_qlit(name, 'event', {'arg-type': self._use_type(arg_type)},
|
|
ifcond)
|
|
|
|
|
|
def gen_introspect(schema, output_dir, prefix, opt_unmask):
|
|
vis = QAPISchemaGenIntrospectVisitor(prefix, opt_unmask)
|
|
schema.visit(vis)
|
|
vis.write(output_dir)
|