block: directly invoke .bdrv_* from emulation functions
[qemu.git] / scripts / qapi-commands.py
blobc947ba4208c20986c6edad27e59b1d86874df90a
2 # QAPI command marshaller generator
4 # Copyright IBM, Corp. 2011
6 # Authors:
7 # Anthony Liguori <aliguori@us.ibm.com>
8 # Michael Roth <mdroth@linux.vnet.ibm.com>
10 # This work is licensed under the terms of the GNU GPLv2.
11 # See the COPYING.LIB file in the top-level directory.
13 from ordereddict import OrderedDict
14 from qapi import *
15 import sys
16 import os
17 import getopt
18 import errno
20 def type_visitor(name):
21 if type(name) == list:
22 return 'visit_type_%sList' % name[0]
23 else:
24 return 'visit_type_%s' % name
26 def generate_decl_enum(name, members, genlist=True):
27 return mcgen('''
29 void %(visitor)s(Visitor *m, %(name)s * obj, const char *name, Error **errp);
30 ''',
31 visitor=type_visitor(name))
33 def generate_command_decl(name, args, ret_type):
34 arglist=""
35 for argname, argtype, optional, structured in parse_args(args):
36 argtype = c_type(argtype)
37 if argtype == "char *":
38 argtype = "const char *"
39 if optional:
40 arglist += "bool has_%s, " % c_var(argname)
41 arglist += "%s %s, " % (argtype, c_var(argname))
42 return mcgen('''
43 %(ret_type)s qmp_%(name)s(%(args)sError **errp);
44 ''',
45 ret_type=c_type(ret_type), name=c_var(name), args=arglist).strip()
47 def gen_sync_call(name, args, ret_type, indent=0):
48 ret = ""
49 arglist=""
50 retval=""
51 if ret_type:
52 retval = "retval = "
53 for argname, argtype, optional, structured in parse_args(args):
54 if optional:
55 arglist += "has_%s, " % c_var(argname)
56 arglist += "%s, " % (c_var(argname))
57 push_indent(indent)
58 ret = mcgen('''
59 %(retval)sqmp_%(name)s(%(args)serrp);
61 ''',
62 name=c_var(name), args=arglist, retval=retval).rstrip()
63 if ret_type:
64 ret += "\n" + mcgen(''''
65 %(marshal_output_call)s
66 ''',
67 marshal_output_call=gen_marshal_output_call(name, ret_type)).rstrip()
68 pop_indent(indent)
69 return ret.rstrip()
72 def gen_marshal_output_call(name, ret_type):
73 if not ret_type:
74 return ""
75 return "qmp_marshal_output_%s(retval, ret, errp);" % c_var(name)
77 def gen_visitor_output_containers_decl(ret_type):
78 ret = ""
79 push_indent()
80 if ret_type:
81 ret += mcgen('''
82 QmpOutputVisitor *mo;
83 QapiDeallocVisitor *md;
84 Visitor *v;
85 ''')
86 pop_indent()
88 return ret
90 def gen_visitor_input_containers_decl(args):
91 ret = ""
93 push_indent()
94 if len(args) > 0:
95 ret += mcgen('''
96 QmpInputVisitor *mi;
97 QapiDeallocVisitor *md;
98 Visitor *v;
99 ''')
100 pop_indent()
102 return ret.rstrip()
104 def gen_visitor_input_vars_decl(args):
105 ret = ""
106 push_indent()
107 for argname, argtype, optional, structured in parse_args(args):
108 if optional:
109 ret += mcgen('''
110 bool has_%(argname)s = false;
111 ''',
112 argname=c_var(argname))
113 if c_type(argtype).endswith("*"):
114 ret += mcgen('''
115 %(argtype)s %(argname)s = NULL;
116 ''',
117 argname=c_var(argname), argtype=c_type(argtype))
118 else:
119 ret += mcgen('''
120 %(argtype)s %(argname)s;
121 ''',
122 argname=c_var(argname), argtype=c_type(argtype))
124 pop_indent()
125 return ret.rstrip()
127 def gen_visitor_input_block(args, obj, dealloc=False):
128 ret = ""
129 if len(args) == 0:
130 return ret
132 push_indent()
134 if dealloc:
135 ret += mcgen('''
136 md = qapi_dealloc_visitor_new();
137 v = qapi_dealloc_get_visitor(md);
138 ''')
139 else:
140 ret += mcgen('''
141 mi = qmp_input_visitor_new(%(obj)s);
142 v = qmp_input_get_visitor(mi);
143 ''',
144 obj=obj)
146 for argname, argtype, optional, structured in parse_args(args):
147 if optional:
148 ret += mcgen('''
149 visit_start_optional(v, &has_%(c_name)s, "%(name)s", errp);
150 if (has_%(c_name)s) {
151 ''',
152 c_name=c_var(argname), name=argname)
153 push_indent()
154 ret += mcgen('''
155 %(visitor)s(v, &%(c_name)s, "%(name)s", errp);
156 ''',
157 c_name=c_var(argname), name=argname, argtype=argtype,
158 visitor=type_visitor(argtype))
159 if optional:
160 pop_indent()
161 ret += mcgen('''
163 visit_end_optional(v, errp);
164 ''')
166 if dealloc:
167 ret += mcgen('''
168 qapi_dealloc_visitor_cleanup(md);
169 ''')
170 else:
171 ret += mcgen('''
172 qmp_input_visitor_cleanup(mi);
173 ''')
174 pop_indent()
175 return ret.rstrip()
177 def gen_marshal_output(name, args, ret_type, middle_mode):
178 if not ret_type:
179 return ""
181 ret = mcgen('''
182 static void qmp_marshal_output_%(c_name)s(%(c_ret_type)s ret_in, QObject **ret_out, Error **errp)
184 QapiDeallocVisitor *md = qapi_dealloc_visitor_new();
185 QmpOutputVisitor *mo = qmp_output_visitor_new();
186 Visitor *v;
188 v = qmp_output_get_visitor(mo);
189 %(visitor)s(v, &ret_in, "unused", errp);
190 if (!error_is_set(errp)) {
191 *ret_out = qmp_output_get_qobject(mo);
193 qmp_output_visitor_cleanup(mo);
194 v = qapi_dealloc_get_visitor(md);
195 %(visitor)s(v, &ret_in, "unused", errp);
196 qapi_dealloc_visitor_cleanup(md);
198 ''',
199 c_ret_type=c_type(ret_type), c_name=c_var(name),
200 visitor=type_visitor(ret_type))
202 return ret
204 def gen_marshal_input_decl(name, args, ret_type, middle_mode):
205 if middle_mode:
206 return 'int qmp_marshal_input_%s(Monitor *mon, const QDict *qdict, QObject **ret)' % c_var(name)
207 else:
208 return 'static void qmp_marshal_input_%s(QDict *args, QObject **ret, Error **errp)' % c_var(name)
212 def gen_marshal_input(name, args, ret_type, middle_mode):
213 hdr = gen_marshal_input_decl(name, args, ret_type, middle_mode)
215 ret = mcgen('''
216 %(header)s
218 ''',
219 header=hdr)
221 if middle_mode:
222 ret += mcgen('''
223 Error *local_err = NULL;
224 Error **errp = &local_err;
225 QDict *args = (QDict *)qdict;
226 ''')
228 if ret_type:
229 if c_type(ret_type).endswith("*"):
230 retval = " %s retval = NULL;" % c_type(ret_type)
231 else:
232 retval = " %s retval;" % c_type(ret_type)
233 ret += mcgen('''
234 %(retval)s
235 ''',
236 retval=retval)
238 if len(args) > 0:
239 ret += mcgen('''
240 %(visitor_input_containers_decl)s
241 %(visitor_input_vars_decl)s
243 %(visitor_input_block)s
245 ''',
246 visitor_input_containers_decl=gen_visitor_input_containers_decl(args),
247 visitor_input_vars_decl=gen_visitor_input_vars_decl(args),
248 visitor_input_block=gen_visitor_input_block(args, "QOBJECT(args)"))
249 else:
250 ret += mcgen('''
251 (void)args;
252 ''')
254 ret += mcgen('''
255 if (error_is_set(errp)) {
256 goto out;
258 %(sync_call)s
259 ''',
260 sync_call=gen_sync_call(name, args, ret_type, indent=4))
261 ret += mcgen('''
263 out:
264 ''')
265 ret += mcgen('''
266 %(visitor_input_block_cleanup)s
267 ''',
268 visitor_input_block_cleanup=gen_visitor_input_block(args, None,
269 dealloc=True))
271 if middle_mode:
272 ret += mcgen('''
274 if (local_err) {
275 qerror_report_err(local_err);
276 error_free(local_err);
277 return -1;
279 return 0;
280 ''')
281 else:
282 ret += mcgen('''
283 return;
284 ''')
286 ret += mcgen('''
288 ''')
290 return ret
292 def gen_registry(commands):
293 registry=""
294 push_indent()
295 for cmd in commands:
296 registry += mcgen('''
297 qmp_register_command("%(name)s", qmp_marshal_input_%(c_name)s);
298 ''',
299 name=cmd['command'], c_name=c_var(cmd['command']))
300 pop_indent()
301 ret = mcgen('''
302 static void qmp_init_marshal(void)
304 %(registry)s
307 qapi_init(qmp_init_marshal);
308 ''',
309 registry=registry.rstrip())
310 return ret
312 def gen_command_decl_prologue(header, guard, prefix=""):
313 ret = mcgen('''
314 /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
317 * schema-defined QAPI function prototypes
319 * Copyright IBM, Corp. 2011
321 * Authors:
322 * Anthony Liguori <aliguori@us.ibm.com>
324 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
325 * See the COPYING.LIB file in the top-level directory.
329 #ifndef %(guard)s
330 #define %(guard)s
332 #include "%(prefix)sqapi-types.h"
333 #include "error.h"
335 ''',
336 header=basename(header), guard=guardname(header), prefix=prefix)
337 return ret
339 def gen_command_def_prologue(prefix="", proxy=False):
340 ret = mcgen('''
341 /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
344 * schema-defined QMP->QAPI command dispatch
346 * Copyright IBM, Corp. 2011
348 * Authors:
349 * Anthony Liguori <aliguori@us.ibm.com>
351 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
352 * See the COPYING.LIB file in the top-level directory.
356 #include "qemu-objects.h"
357 #include "qapi/qmp-core.h"
358 #include "qapi/qapi-visit-core.h"
359 #include "qapi/qmp-output-visitor.h"
360 #include "qapi/qmp-input-visitor.h"
361 #include "qapi/qapi-dealloc-visitor.h"
362 #include "%(prefix)sqapi-types.h"
363 #include "%(prefix)sqapi-visit.h"
365 ''',
366 prefix=prefix)
367 if not proxy:
368 ret += '#include "%sqmp-commands.h"' % prefix
369 return ret + "\n\n"
372 try:
373 opts, args = getopt.gnu_getopt(sys.argv[1:], "p:o:m", ["prefix=", "output-dir=", "type=", "middle"])
374 except getopt.GetoptError, err:
375 print str(err)
376 sys.exit(1)
378 output_dir = ""
379 prefix = ""
380 dispatch_type = "sync"
381 c_file = 'qmp-marshal.c'
382 h_file = 'qmp-commands.h'
383 middle_mode = False
385 for o, a in opts:
386 if o in ("-p", "--prefix"):
387 prefix = a
388 elif o in ("-o", "--output-dir"):
389 output_dir = a + "/"
390 elif o in ("-t", "--type"):
391 dispatch_type = a
392 elif o in ("-m", "--middle"):
393 middle_mode = True
395 c_file = output_dir + prefix + c_file
396 h_file = output_dir + prefix + h_file
398 try:
399 os.makedirs(output_dir)
400 except os.error, e:
401 if e.errno != errno.EEXIST:
402 raise
404 exprs = parse_schema(sys.stdin)
405 commands = filter(lambda expr: expr.has_key('command'), exprs)
407 if dispatch_type == "sync":
408 fdecl = open(h_file, 'w')
409 fdef = open(c_file, 'w')
410 ret = gen_command_decl_prologue(header=basename(h_file), guard=guardname(h_file), prefix=prefix)
411 fdecl.write(ret)
412 ret = gen_command_def_prologue(prefix=prefix)
413 fdef.write(ret)
415 for cmd in commands:
416 arglist = []
417 ret_type = None
418 if cmd.has_key('data'):
419 arglist = cmd['data']
420 if cmd.has_key('returns'):
421 ret_type = cmd['returns']
422 ret = generate_command_decl(cmd['command'], arglist, ret_type) + "\n"
423 fdecl.write(ret)
424 if ret_type:
425 ret = gen_marshal_output(cmd['command'], arglist, ret_type, middle_mode) + "\n"
426 fdef.write(ret)
428 if middle_mode:
429 fdecl.write('%s;\n' % gen_marshal_input_decl(cmd['command'], arglist, ret_type, middle_mode))
431 ret = gen_marshal_input(cmd['command'], arglist, ret_type, middle_mode) + "\n"
432 fdef.write(ret)
434 fdecl.write("\n#endif\n");
436 if not middle_mode:
437 ret = gen_registry(commands)
438 fdef.write(ret)
440 fdef.flush()
441 fdef.close()
442 fdecl.flush()
443 fdecl.close()