2 # QAPI command marshaller generator
4 # Copyright IBM, Corp. 2011
5 # Copyright (C) 2014-2015 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_err_check(err
):
39 def gen_call(name
, arg_type
, ret_type
):
44 for memb
in arg_type
.members
:
46 argstr
+= 'has_%s, ' % c_name(memb
.name
)
47 argstr
+= '%s, ' % c_name(memb
.name
)
56 %(lhs)sqmp_%(c_name)s(%(args)s&local_err);
58 c_name
=c_name(name
), args
=argstr
, lhs
=lhs
)
60 ret
+= gen_err_check('local_err')
63 qmp_marshal_output_%(c_name)s(retval, ret, &local_err);
65 c_name
=ret_type
.c_name())
70 def gen_marshal_vars(arg_type
, ret_type
):
72 Error *local_err = NULL;
81 c_type
=ret_type
.c_type())
85 QmpInputVisitor *mi = qmp_input_visitor_new_strict(QOBJECT(args));
86 QapiDeallocVisitor *md;
90 for memb
in arg_type
.members
:
93 bool has_%(c_name)s = false;
95 c_name
=c_name(memb
.name
))
97 %(c_type)s %(c_name)s = %(c_null)s;
99 c_name
=c_name(memb
.name
),
100 c_type
=memb
.type.c_type(),
101 c_null
=memb
.type.c_null())
113 def gen_marshal_input_visit(arg_type
, dealloc
=False):
125 qmp_input_visitor_cleanup(mi);
126 md = qapi_dealloc_visitor_new();
127 v = qapi_dealloc_get_visitor(md);
130 errparg
= '&local_err'
133 v = qmp_input_get_visitor(mi);
136 for memb
in arg_type
.members
:
139 visit_optional(v, &has_%(c_name)s, "%(name)s", %(errp)s);
141 c_name
=c_name(memb
.name
), name
=memb
.name
,
143 ret
+= gen_err_check(errarg
)
145 if (has_%(c_name)s) {
147 c_name
=c_name(memb
.name
))
150 visit_type_%(c_type)s(v, &%(c_name)s, "%(name)s", %(errp)s);
152 c_name
=c_name(memb
.name
), name
=memb
.name
,
153 c_type
=memb
.type.c_name(), errp
=errparg
)
154 ret
+= gen_err_check(errarg
)
163 qapi_dealloc_visitor_cleanup(md);
169 def gen_marshal_output(ret_type
):
172 static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp)
174 Error *local_err = NULL;
175 QmpOutputVisitor *mo = qmp_output_visitor_new();
176 QapiDeallocVisitor *md;
179 v = qmp_output_get_visitor(mo);
180 visit_type_%(c_name)s(v, &ret_in, "unused", &local_err);
184 *ret_out = qmp_output_get_qobject(mo);
187 error_propagate(errp, local_err);
188 qmp_output_visitor_cleanup(mo);
189 md = qapi_dealloc_visitor_new();
190 v = qapi_dealloc_get_visitor(md);
191 visit_type_%(c_name)s(v, &ret_in, "unused", NULL);
192 qapi_dealloc_visitor_cleanup(md);
195 c_type
=ret_type
.c_type(), c_name
=ret_type
.c_name())
198 def gen_marshal_proto(name
):
199 ret
= 'void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)' % c_name(name
)
201 ret
= 'static ' + ret
205 def gen_marshal_decl(name
):
209 proto
=gen_marshal_proto(name
))
212 def gen_marshal(name
, arg_type
, ret_type
):
218 proto
=gen_marshal_proto(name
))
220 ret
+= gen_marshal_vars(arg_type
, ret_type
)
221 ret
+= gen_marshal_input_visit(arg_type
)
222 ret
+= gen_call(name
, arg_type
, ret_type
)
224 if re
.search('^ *goto out;', ret
, re
.MULTILINE
):
230 error_propagate(errp, local_err);
232 ret
+= gen_marshal_input_visit(arg_type
, dealloc
=True)
239 def gen_register_command(name
, success_response
):
241 options
= 'QCO_NO_OPTIONS'
242 if not success_response
:
243 options
= 'QCO_NO_SUCCESS_RESP'
246 qmp_register_command("%(name)s", qmp_marshal_%(c_name)s, %(opts)s);
248 name
=name
, c_name
=c_name(name
),
254 def gen_registry(registry
):
257 static void qmp_init_marshal(void)
264 qapi_init(qmp_init_marshal);
269 class QAPISchemaGenCommandVisitor(QAPISchemaVisitor
):
274 self
._visited
_ret
_types
= None
276 def visit_begin(self
, schema
):
280 self
._visited
_ret
_types
= set()
284 self
.defn
+= gen_registry(self
._regy
)
286 self
._visited
_ret
_types
= None
288 def visit_command(self
, name
, info
, arg_type
, ret_type
,
289 gen
, success_response
):
292 self
.decl
+= gen_command_decl(name
, arg_type
, ret_type
)
293 if ret_type
and ret_type
not in self
._visited
_ret
_types
:
294 self
._visited
_ret
_types
.add(ret_type
)
295 self
.defn
+= gen_marshal_output(ret_type
)
297 self
.decl
+= gen_marshal_decl(name
)
298 self
.defn
+= gen_marshal(name
, arg_type
, ret_type
)
300 self
._regy
+= gen_register_command(name
, success_response
)
305 (input_file
, output_dir
, do_c
, do_h
, prefix
, opts
) = \
306 parse_command_line("m", ["middle"])
309 if o
in ("-m", "--middle"):
314 * schema-defined QMP->QAPI command dispatch
316 * Copyright IBM, Corp. 2011
319 * Anthony Liguori <aliguori@us.ibm.com>
321 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
322 * See the COPYING.LIB file in the top-level directory.
328 * schema-defined QAPI function prototypes
330 * Copyright IBM, Corp. 2011
333 * Anthony Liguori <aliguori@us.ibm.com>
335 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
336 * See the COPYING.LIB file in the top-level directory.
341 (fdef
, fdecl
) = open_output(output_dir
, do_c
, do_h
, prefix
,
342 'qmp-marshal.c', 'qmp-commands.h',
343 c_comment
, h_comment
)
346 #include "qemu-common.h"
347 #include "qemu/module.h"
348 #include "qapi/qmp/types.h"
349 #include "qapi/qmp/dispatch.h"
350 #include "qapi/visitor.h"
351 #include "qapi/qmp-output-visitor.h"
352 #include "qapi/qmp-input-visitor.h"
353 #include "qapi/dealloc-visitor.h"
354 #include "%(prefix)sqapi-types.h"
355 #include "%(prefix)sqapi-visit.h"
356 #include "%(prefix)sqmp-commands.h"
361 fdecl
.write(mcgen('''
362 #include "%(prefix)sqapi-types.h"
363 #include "qapi/qmp/qdict.h"
364 #include "qapi/error.h"
369 schema
= QAPISchema(input_file
)
370 gen
= QAPISchemaGenCommandVisitor()
373 fdecl
.write(gen
.decl
)
375 close_output(fdef
, fdecl
)