2 # QAPI command marshaller generator
4 # Copyright IBM, Corp. 2011
5 # Copyright (C) 2014-2016 Red Hat, Inc.
8 # Anthony Liguori <aliguori@us.ibm.com>
9 # Michael Roth <mdroth@linux.vnet.ibm.com>
10 # Markus Armbruster <armbru@redhat.com>
12 # This work is licensed under the terms of the GNU GPL, version 2.
13 # See the COPYING file in the top-level directory.
19 def gen_command_decl(name, arg_type, ret_type):
21 %(c_type)s qmp_%(c_name)s(%(params)s);
23 c_type=(ret_type and ret_type.c_type()) or 'void',
25 params=gen_params(arg_type, 'Error **errp'))
28 def gen_call(name, arg_type, ret_type):
33 assert not arg_type.variants
34 for memb in arg_type.members:
36 argstr += 'arg.has_%s, ' % c_name(memb.name)
37 argstr += 'arg.%s, ' % c_name(memb.name)
45 %(lhs)sqmp_%(c_name)s(%(args)s&err);
47 c_name=c_name(name), args=argstr, lhs=lhs)
49 ret += gen_err_check()
52 qmp_marshal_output_%(c_name)s(retval, ret, &err);
54 c_name=ret_type.c_name())
58 def gen_marshal_output(ret_type):
61 static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp)
64 QmpOutputVisitor *qov = qmp_output_visitor_new();
65 QapiDeallocVisitor *qdv;
68 v = qmp_output_get_visitor(qov);
69 visit_type_%(c_name)s(v, "unused", &ret_in, &err);
73 *ret_out = qmp_output_get_qobject(qov);
76 error_propagate(errp, err);
77 qmp_output_visitor_cleanup(qov);
78 qdv = qapi_dealloc_visitor_new();
79 v = qapi_dealloc_get_visitor(qdv);
80 visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
81 qapi_dealloc_visitor_cleanup(qdv);
84 c_type=ret_type.c_type(), c_name=ret_type.c_name())
87 def gen_marshal_proto(name):
88 ret = 'void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)' % c_name(name)
94 def gen_marshal_decl(name):
98 proto=gen_marshal_proto(name))
101 def gen_marshal(name, arg_type, ret_type):
108 proto=gen_marshal_proto(name))
114 c_type=ret_type.c_type())
116 if arg_type and arg_type.members:
118 QmpInputVisitor *qiv = qmp_input_visitor_new_strict(QOBJECT(args));
119 QapiDeallocVisitor *qdv;
121 %(c_name)s arg = {0};
123 v = qmp_input_get_visitor(qiv);
124 visit_type_%(c_name)s_members(v, &arg, &err);
129 c_name=arg_type.c_name())
137 ret += gen_call(name, arg_type, ret_type)
139 # 'goto out' produced above for arg_type, and by gen_call() for ret_type
140 if (arg_type and arg_type.members) or ret_type:
146 error_propagate(errp, err);
148 if arg_type and arg_type.members:
150 qmp_input_visitor_cleanup(qiv);
151 qdv = qapi_dealloc_visitor_new();
152 v = qapi_dealloc_get_visitor(qdv);
153 visit_type_%(c_name)s_members(v, &arg, NULL);
154 qapi_dealloc_visitor_cleanup(qdv);
156 c_name=arg_type.c_name())
164 def gen_register_command(name, success_response):
165 options = 'QCO_NO_OPTIONS'
166 if not success_response:
167 options = 'QCO_NO_SUCCESS_RESP'
170 qmp_register_command("%(name)s", qmp_marshal_%(c_name)s, %(opts)s);
172 name=name, c_name=c_name(name),
177 def gen_registry(registry):
180 static void qmp_init_marshal(void)
187 qapi_init(qmp_init_marshal);
192 class QAPISchemaGenCommandVisitor(QAPISchemaVisitor):
197 self._visited_ret_types = None
199 def visit_begin(self, schema):
203 self._visited_ret_types = set()
207 self.defn += gen_registry(self._regy)
209 self._visited_ret_types = None
211 def visit_command(self, name, info, arg_type, ret_type,
212 gen, success_response):
215 self.decl += gen_command_decl(name, arg_type, ret_type)
216 if ret_type and ret_type not in self._visited_ret_types:
217 self._visited_ret_types.add(ret_type)
218 self.defn += gen_marshal_output(ret_type)
220 self.decl += gen_marshal_decl(name)
221 self.defn += gen_marshal(name, arg_type, ret_type)
223 self._regy += gen_register_command(name, success_response)
228 (input_file, output_dir, do_c, do_h, prefix, opts) = \
229 parse_command_line("m", ["middle"])
232 if o in ("-m", "--middle"):
237 * schema-defined QMP->QAPI command dispatch
239 * Copyright IBM, Corp. 2011
242 * Anthony Liguori <aliguori@us.ibm.com>
244 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
245 * See the COPYING.LIB file in the top-level directory.
251 * schema-defined QAPI function prototypes
253 * Copyright IBM, Corp. 2011
256 * Anthony Liguori <aliguori@us.ibm.com>
258 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
259 * See the COPYING.LIB file in the top-level directory.
264 (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
265 'qmp-marshal.c', 'qmp-commands.h',
266 c_comment, h_comment)
269 #include "qemu/osdep.h"
270 #include "qemu-common.h"
271 #include "qemu/module.h"
272 #include "qapi/qmp/types.h"
273 #include "qapi/qmp/dispatch.h"
274 #include "qapi/visitor.h"
275 #include "qapi/qmp-output-visitor.h"
276 #include "qapi/qmp-input-visitor.h"
277 #include "qapi/dealloc-visitor.h"
278 #include "%(prefix)sqapi-types.h"
279 #include "%(prefix)sqapi-visit.h"
280 #include "%(prefix)sqmp-commands.h"
285 fdecl.write(mcgen('''
286 #include "%(prefix)sqapi-types.h"
287 #include "qapi/qmp/qdict.h"
288 #include "qapi/error.h"
293 schema = QAPISchema(input_file)
294 gen = QAPISchemaGenCommandVisitor()
297 fdecl.write(gen.decl)
299 close_output(fdef, fdecl)