2 QAPI command marshaller generator
4 Copyright IBM, Corp. 2011
5 Copyright (C) 2014-2018 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.
16 from qapi
.common
import *
19 def gen_command_decl(name
, arg_type
, boxed
, 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
=build_params(arg_type
, boxed
, 'Error **errp'))
28 def gen_call(name
, arg_type
, boxed
, ret_type
):
33 assert arg_type
and not arg_type
.is_empty()
36 assert not arg_type
.variants
37 for memb
in arg_type
.members
:
39 argstr
+= 'arg.has_%s, ' % c_name(memb
.name
)
40 argstr
+= 'arg.%s, ' % c_name(memb
.name
)
48 %(lhs)sqmp_%(c_name)s(%(args)s&err);
50 c_name
=c_name(name
), args
=argstr
, lhs
=lhs
)
57 qmp_marshal_output_%(c_name)s(retval, ret, &err);
59 c_name
=ret_type
.c_name())
63 def gen_marshal_output(ret_type
):
66 static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp)
71 v = qobject_output_visitor_new(ret_out);
72 visit_type_%(c_name)s(v, "unused", &ret_in, &err);
74 visit_complete(v, ret_out);
76 error_propagate(errp, err);
78 v = qapi_dealloc_visitor_new();
79 visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
83 c_type
=ret_type
.c_type(), c_name
=ret_type
.c_name())
86 def build_marshal_proto(name
):
87 return ('void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)'
91 def gen_marshal_decl(name
):
95 proto
=build_marshal_proto(name
))
98 def gen_marshal(name
, arg_type
, boxed
, ret_type
):
99 have_args
= arg_type
and not arg_type
.is_empty()
107 proto
=build_marshal_proto(name
))
113 c_type
=ret_type
.c_type())
116 visit_members
= ('visit_type_%s_members(v, &arg, &err);'
120 %(c_name)s arg = {0};
123 c_name
=arg_type
.c_name())
134 v = qobject_input_visitor_new(QOBJECT(args));
135 visit_start_struct(v, NULL, NULL, 0, &err);
141 visit_check_struct(v, &err);
143 visit_end_struct(v, NULL);
148 visit_members
=visit_members
)
156 ret
+= gen_call(name
, arg_type
, boxed
, ret_type
)
161 error_propagate(errp, err);
166 visit_members
= ('visit_type_%s_members(v, &arg, NULL);'
176 v = qapi_dealloc_visitor_new();
177 visit_start_struct(v, NULL, NULL, 0, NULL);
179 visit_end_struct(v, NULL);
182 visit_members
=visit_members
)
196 def gen_register_command(name
, success_response
):
197 options
= 'QCO_NO_OPTIONS'
198 if not success_response
:
199 options
= 'QCO_NO_SUCCESS_RESP'
202 qmp_register_command(cmds, "%(name)s",
203 qmp_marshal_%(c_name)s, %(opts)s);
205 name
=name
, c_name
=c_name(name
),
210 def gen_registry(registry
, prefix
):
213 void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds)
218 c_prefix
=c_name(prefix
, protect
=False))
226 class QAPISchemaGenCommandVisitor(QAPISchemaModularCVisitor
):
228 def __init__(self
, prefix
):
229 QAPISchemaModularCVisitor
.__init
__(
230 self
, prefix
, 'qapi-commands',
231 ' * Schema-defined QAPI/QMP commands', __doc__
)
233 self
._visited
_ret
_types
= {}
235 def _begin_module(self
, name
):
236 self
._visited
_ret
_types
[self
._genc
] = set()
237 commands
= self
._module
_basename
('qapi-commands', name
)
238 types
= self
._module
_basename
('qapi-types', name
)
239 visit
= self
._module
_basename
('qapi-visit', name
)
240 self
._genc
.add(mcgen('''
241 #include "qemu/osdep.h"
242 #include "qemu-common.h"
243 #include "qemu/module.h"
244 #include "qapi/visitor.h"
245 #include "qapi/qmp/qdict.h"
246 #include "qapi/qobject-output-visitor.h"
247 #include "qapi/qobject-input-visitor.h"
248 #include "qapi/dealloc-visitor.h"
249 #include "qapi/error.h"
250 #include "%(visit)s.h"
251 #include "%(commands)s.h"
254 commands
=commands
, visit
=visit
))
255 self
._genh
.add(mcgen('''
256 #include "%(types)s.h"
257 #include "qapi/qmp/dispatch.h"
263 (genc
, genh
) = self
._module
[self
._main
_module
]
265 void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
267 c_prefix
=c_name(self
._prefix
, protect
=False)))
268 genc
.add(gen_registry(self
._regy
, self
._prefix
))
270 def visit_command(self
, name
, info
, arg_type
, ret_type
,
271 gen
, success_response
, boxed
):
274 self
._genh
.add(gen_command_decl(name
, arg_type
, boxed
, ret_type
))
275 if ret_type
and ret_type
not in self
._visited
_ret
_types
[self
._genc
]:
276 self
._visited
_ret
_types
[self
._genc
].add(ret_type
)
277 self
._genc
.add(gen_marshal_output(ret_type
))
278 self
._genh
.add(gen_marshal_decl(name
))
279 self
._genc
.add(gen_marshal(name
, arg_type
, boxed
, ret_type
))
280 self
._regy
+= gen_register_command(name
, success_response
)
283 def gen_commands(schema
, output_dir
, prefix
):
284 vis
= QAPISchemaGenCommandVisitor(prefix
)
286 vis
.write(output_dir
)