Adding upstream version 1:10.0.2+ds.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
This commit is contained in:
parent
bf2768bd0f
commit
ea34ddeea6
GPG key ID:
BCC918A2ABD66424
37998 changed files with 9510514 additions and 0 deletions
420
scripts/qapi/commands.py
Normal file
420
scripts/qapi/commands.py
Normal file
|
|
@ -0,0 +1,420 @@
|
|||
"""
|
||||
QAPI command marshaller generator
|
||||
|
||||
Copyright IBM, Corp. 2011
|
||||
Copyright (C) 2014-2018 Red Hat, Inc.
|
||||
|
||||
Authors:
|
||||
Anthony Liguori <aliguori@us.ibm.com>
|
||||
Michael Roth <mdroth@linux.vnet.ibm.com>
|
||||
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.
|
||||
"""
|
||||
|
||||
from typing import (
|
||||
Dict,
|
||||
List,
|
||||
Optional,
|
||||
Set,
|
||||
)
|
||||
|
||||
from .common import c_name, mcgen
|
||||
from .gen import (
|
||||
QAPIGenC,
|
||||
QAPISchemaModularCVisitor,
|
||||
build_params,
|
||||
gen_features,
|
||||
ifcontext,
|
||||
)
|
||||
from .schema import (
|
||||
QAPISchema,
|
||||
QAPISchemaFeature,
|
||||
QAPISchemaIfCond,
|
||||
QAPISchemaObjectType,
|
||||
QAPISchemaType,
|
||||
)
|
||||
from .source import QAPISourceInfo
|
||||
|
||||
|
||||
def gen_command_decl(name: str,
|
||||
arg_type: Optional[QAPISchemaObjectType],
|
||||
boxed: bool,
|
||||
ret_type: Optional[QAPISchemaType],
|
||||
coroutine: bool) -> str:
|
||||
return mcgen('''
|
||||
%(c_type)s %(coroutine_fn)sqmp_%(c_name)s(%(params)s);
|
||||
''',
|
||||
c_type=(ret_type and ret_type.c_type()) or 'void',
|
||||
coroutine_fn='coroutine_fn ' if coroutine else '',
|
||||
c_name=c_name(name),
|
||||
params=build_params(arg_type, boxed, 'Error **errp'))
|
||||
|
||||
|
||||
def gen_call(name: str,
|
||||
arg_type: Optional[QAPISchemaObjectType],
|
||||
boxed: bool,
|
||||
ret_type: Optional[QAPISchemaType],
|
||||
gen_tracing: bool) -> str:
|
||||
ret = ''
|
||||
|
||||
argstr = ''
|
||||
if boxed:
|
||||
assert arg_type
|
||||
argstr = '&arg, '
|
||||
elif arg_type:
|
||||
assert not arg_type.branches
|
||||
for memb in arg_type.members:
|
||||
assert not memb.ifcond.is_present()
|
||||
if memb.need_has():
|
||||
argstr += 'arg.has_%s, ' % c_name(memb.name)
|
||||
argstr += 'arg.%s, ' % c_name(memb.name)
|
||||
|
||||
lhs = ''
|
||||
if ret_type:
|
||||
lhs = 'retval = '
|
||||
|
||||
name = c_name(name)
|
||||
upper = name.upper()
|
||||
|
||||
if gen_tracing:
|
||||
ret += mcgen('''
|
||||
|
||||
if (trace_event_get_state_backends(TRACE_QMP_ENTER_%(upper)s)) {
|
||||
g_autoptr(GString) req_json = qobject_to_json(QOBJECT(args));
|
||||
|
||||
trace_qmp_enter_%(name)s(req_json->str);
|
||||
}
|
||||
''',
|
||||
upper=upper, name=name)
|
||||
|
||||
ret += mcgen('''
|
||||
|
||||
%(lhs)sqmp_%(name)s(%(args)s&err);
|
||||
''',
|
||||
name=name, args=argstr, lhs=lhs)
|
||||
|
||||
ret += mcgen('''
|
||||
if (err) {
|
||||
''')
|
||||
|
||||
if gen_tracing:
|
||||
ret += mcgen('''
|
||||
trace_qmp_exit_%(name)s(error_get_pretty(err), false);
|
||||
''',
|
||||
name=name)
|
||||
|
||||
ret += mcgen('''
|
||||
error_propagate(errp, err);
|
||||
goto out;
|
||||
}
|
||||
''')
|
||||
|
||||
if ret_type:
|
||||
ret += mcgen('''
|
||||
|
||||
qmp_marshal_output_%(c_name)s(retval, ret, errp);
|
||||
''',
|
||||
c_name=ret_type.c_name())
|
||||
|
||||
if gen_tracing:
|
||||
if ret_type:
|
||||
ret += mcgen('''
|
||||
|
||||
if (trace_event_get_state_backends(TRACE_QMP_EXIT_%(upper)s)) {
|
||||
g_autoptr(GString) ret_json = qobject_to_json(*ret);
|
||||
|
||||
trace_qmp_exit_%(name)s(ret_json->str, true);
|
||||
}
|
||||
''',
|
||||
upper=upper, name=name)
|
||||
else:
|
||||
ret += mcgen('''
|
||||
|
||||
trace_qmp_exit_%(name)s("{}", true);
|
||||
''',
|
||||
name=name)
|
||||
|
||||
return ret
|
||||
|
||||
|
||||
def gen_marshal_output(ret_type: QAPISchemaType) -> str:
|
||||
return mcgen('''
|
||||
|
||||
static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in,
|
||||
QObject **ret_out, Error **errp)
|
||||
{
|
||||
Visitor *v;
|
||||
|
||||
v = qobject_output_visitor_new_qmp(ret_out);
|
||||
if (visit_type_%(c_name)s(v, "unused", &ret_in, errp)) {
|
||||
visit_complete(v, ret_out);
|
||||
}
|
||||
visit_free(v);
|
||||
v = qapi_dealloc_visitor_new();
|
||||
visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
|
||||
visit_free(v);
|
||||
}
|
||||
''',
|
||||
c_type=ret_type.c_type(), c_name=ret_type.c_name())
|
||||
|
||||
|
||||
def build_marshal_proto(name: str,
|
||||
coroutine: bool) -> str:
|
||||
return ('void %(coroutine_fn)sqmp_marshal_%(c_name)s(%(params)s)' % {
|
||||
'coroutine_fn': 'coroutine_fn ' if coroutine else '',
|
||||
'c_name': c_name(name),
|
||||
'params': 'QDict *args, QObject **ret, Error **errp',
|
||||
})
|
||||
|
||||
|
||||
def gen_marshal_decl(name: str,
|
||||
coroutine: bool) -> str:
|
||||
return mcgen('''
|
||||
%(proto)s;
|
||||
''',
|
||||
proto=build_marshal_proto(name, coroutine))
|
||||
|
||||
|
||||
def gen_trace(name: str) -> str:
|
||||
return mcgen('''
|
||||
qmp_enter_%(name)s(const char *json) "%%s"
|
||||
qmp_exit_%(name)s(const char *result, bool succeeded) "%%s %%d"
|
||||
''',
|
||||
name=c_name(name))
|
||||
|
||||
|
||||
def gen_marshal(name: str,
|
||||
arg_type: Optional[QAPISchemaObjectType],
|
||||
boxed: bool,
|
||||
ret_type: Optional[QAPISchemaType],
|
||||
gen_tracing: bool,
|
||||
coroutine: bool) -> str:
|
||||
have_args = boxed or (arg_type and not arg_type.is_empty())
|
||||
if have_args:
|
||||
assert arg_type is not None
|
||||
arg_type_c_name = arg_type.c_name()
|
||||
|
||||
ret = mcgen('''
|
||||
|
||||
%(proto)s
|
||||
{
|
||||
Error *err = NULL;
|
||||
bool ok = false;
|
||||
Visitor *v;
|
||||
''',
|
||||
proto=build_marshal_proto(name, coroutine))
|
||||
|
||||
if ret_type:
|
||||
ret += mcgen('''
|
||||
%(c_type)s retval;
|
||||
''',
|
||||
c_type=ret_type.c_type())
|
||||
|
||||
if have_args:
|
||||
ret += mcgen('''
|
||||
%(c_name)s arg = {0};
|
||||
''',
|
||||
c_name=arg_type_c_name)
|
||||
|
||||
ret += mcgen('''
|
||||
|
||||
v = qobject_input_visitor_new_qmp(QOBJECT(args));
|
||||
if (!visit_start_struct(v, NULL, NULL, 0, errp)) {
|
||||
goto out;
|
||||
}
|
||||
''')
|
||||
|
||||
if have_args:
|
||||
ret += mcgen('''
|
||||
if (visit_type_%(c_arg_type)s_members(v, &arg, errp)) {
|
||||
ok = visit_check_struct(v, errp);
|
||||
}
|
||||
''',
|
||||
c_arg_type=arg_type_c_name)
|
||||
else:
|
||||
ret += mcgen('''
|
||||
ok = visit_check_struct(v, errp);
|
||||
''')
|
||||
|
||||
ret += mcgen('''
|
||||
visit_end_struct(v, NULL);
|
||||
if (!ok) {
|
||||
goto out;
|
||||
}
|
||||
''')
|
||||
|
||||
ret += gen_call(name, arg_type, boxed, ret_type, gen_tracing)
|
||||
|
||||
ret += mcgen('''
|
||||
|
||||
out:
|
||||
visit_free(v);
|
||||
''')
|
||||
|
||||
ret += mcgen('''
|
||||
v = qapi_dealloc_visitor_new();
|
||||
visit_start_struct(v, NULL, NULL, 0, NULL);
|
||||
''')
|
||||
|
||||
if have_args:
|
||||
ret += mcgen('''
|
||||
visit_type_%(c_arg_type)s_members(v, &arg, NULL);
|
||||
''',
|
||||
c_arg_type=arg_type_c_name)
|
||||
|
||||
ret += mcgen('''
|
||||
visit_end_struct(v, NULL);
|
||||
visit_free(v);
|
||||
''')
|
||||
|
||||
ret += mcgen('''
|
||||
}
|
||||
''')
|
||||
return ret
|
||||
|
||||
|
||||
def gen_register_command(name: str,
|
||||
features: List[QAPISchemaFeature],
|
||||
success_response: bool,
|
||||
allow_oob: bool,
|
||||
allow_preconfig: bool,
|
||||
coroutine: bool) -> str:
|
||||
options = []
|
||||
|
||||
if not success_response:
|
||||
options += ['QCO_NO_SUCCESS_RESP']
|
||||
if allow_oob:
|
||||
options += ['QCO_ALLOW_OOB']
|
||||
if allow_preconfig:
|
||||
options += ['QCO_ALLOW_PRECONFIG']
|
||||
if coroutine:
|
||||
options += ['QCO_COROUTINE']
|
||||
|
||||
ret = mcgen('''
|
||||
qmp_register_command(cmds, "%(name)s",
|
||||
qmp_marshal_%(c_name)s, %(opts)s, %(feats)s);
|
||||
''',
|
||||
name=name, c_name=c_name(name),
|
||||
opts=' | '.join(options) or 0,
|
||||
feats=gen_features(features))
|
||||
return ret
|
||||
|
||||
|
||||
class QAPISchemaGenCommandVisitor(QAPISchemaModularCVisitor):
|
||||
def __init__(self, prefix: str, gen_tracing: bool):
|
||||
super().__init__(
|
||||
prefix, 'qapi-commands',
|
||||
' * Schema-defined QAPI/QMP commands', None, __doc__,
|
||||
gen_tracing=gen_tracing)
|
||||
self._visited_ret_types: Dict[QAPIGenC, Set[QAPISchemaType]] = {}
|
||||
self._gen_tracing = gen_tracing
|
||||
|
||||
def _begin_user_module(self, name: str) -> None:
|
||||
self._visited_ret_types[self._genc] = set()
|
||||
commands = self._module_basename('qapi-commands', name)
|
||||
types = self._module_basename('qapi-types', name)
|
||||
visit = self._module_basename('qapi-visit', name)
|
||||
self._genc.add(mcgen('''
|
||||
#include "qemu/osdep.h"
|
||||
#include "qapi/compat-policy.h"
|
||||
#include "qapi/visitor.h"
|
||||
#include "qobject/qdict.h"
|
||||
#include "qapi/dealloc-visitor.h"
|
||||
#include "qapi/error.h"
|
||||
#include "%(visit)s.h"
|
||||
#include "%(commands)s.h"
|
||||
''',
|
||||
commands=commands, visit=visit))
|
||||
|
||||
if self._gen_tracing and commands != 'qapi-commands':
|
||||
self._genc.add(mcgen('''
|
||||
#include "qobject/qjson.h"
|
||||
#include "trace/trace-%(nm)s_trace_events.h"
|
||||
''',
|
||||
nm=c_name(commands, protect=False)))
|
||||
# We use c_name(commands, protect=False) to turn '-' into '_', to
|
||||
# match .underscorify() in trace/meson.build
|
||||
|
||||
self._genh.add(mcgen('''
|
||||
#include "%(types)s.h"
|
||||
|
||||
''',
|
||||
types=types))
|
||||
|
||||
def visit_begin(self, schema: QAPISchema) -> None:
|
||||
self._add_module('./init', ' * QAPI Commands initialization')
|
||||
self._genh.add(mcgen('''
|
||||
#include "qapi/qmp-registry.h"
|
||||
|
||||
void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
|
||||
''',
|
||||
c_prefix=c_name(self._prefix, protect=False)))
|
||||
self._genc.add(mcgen('''
|
||||
#include "qemu/osdep.h"
|
||||
#include "%(prefix)sqapi-commands.h"
|
||||
#include "%(prefix)sqapi-init-commands.h"
|
||||
#include "%(prefix)sqapi-features.h"
|
||||
|
||||
void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds)
|
||||
{
|
||||
QTAILQ_INIT(cmds);
|
||||
|
||||
''',
|
||||
prefix=self._prefix,
|
||||
c_prefix=c_name(self._prefix, protect=False)))
|
||||
|
||||
def visit_end(self) -> None:
|
||||
with self._temp_module('./init'):
|
||||
self._genc.add(mcgen('''
|
||||
}
|
||||
'''))
|
||||
|
||||
def visit_command(self,
|
||||
name: str,
|
||||
info: Optional[QAPISourceInfo],
|
||||
ifcond: QAPISchemaIfCond,
|
||||
features: List[QAPISchemaFeature],
|
||||
arg_type: Optional[QAPISchemaObjectType],
|
||||
ret_type: Optional[QAPISchemaType],
|
||||
gen: bool,
|
||||
success_response: bool,
|
||||
boxed: bool,
|
||||
allow_oob: bool,
|
||||
allow_preconfig: bool,
|
||||
coroutine: bool) -> None:
|
||||
if not gen:
|
||||
return
|
||||
# FIXME: If T is a user-defined type, the user is responsible
|
||||
# for making this work, i.e. to make T's condition the
|
||||
# conjunction of the T-returning commands' conditions. If T
|
||||
# is a built-in type, this isn't possible: the
|
||||
# qmp_marshal_output_T() will be generated unconditionally.
|
||||
if ret_type and ret_type not in self._visited_ret_types[self._genc]:
|
||||
self._visited_ret_types[self._genc].add(ret_type)
|
||||
with ifcontext(ret_type.ifcond,
|
||||
self._genh, self._genc):
|
||||
self._genc.add(gen_marshal_output(ret_type))
|
||||
with ifcontext(ifcond, self._genh, self._genc):
|
||||
self._genh.add(gen_command_decl(name, arg_type, boxed,
|
||||
ret_type, coroutine))
|
||||
self._genh.add(gen_marshal_decl(name, coroutine))
|
||||
self._genc.add(gen_marshal(name, arg_type, boxed, ret_type,
|
||||
self._gen_tracing, coroutine))
|
||||
if self._gen_tracing:
|
||||
self._gen_trace_events.add(gen_trace(name))
|
||||
with self._temp_module('./init'):
|
||||
with ifcontext(ifcond, self._genh, self._genc):
|
||||
self._genc.add(gen_register_command(
|
||||
name, features, success_response, allow_oob,
|
||||
allow_preconfig, coroutine))
|
||||
|
||||
|
||||
def gen_commands(schema: QAPISchema,
|
||||
output_dir: str,
|
||||
prefix: str,
|
||||
gen_tracing: bool) -> None:
|
||||
vis = QAPISchemaGenCommandVisitor(prefix, gen_tracing)
|
||||
schema.visit(vis)
|
||||
vis.write(output_dir)
|
||||
Loading…
Add table
Add a link
Reference in a new issue