blob: cc447ecaccb378f5a51411bb126d822775066421 [file] [log] [blame]
Michael Roth06d64c62011-07-19 14:50:41 -05001#
2# QAPI visitor generator
3#
4# Copyright IBM, Corp. 2011
Eric Blake92b09ba2016-01-29 06:48:47 -07005# Copyright (C) 2014-2016 Red Hat, Inc.
Michael Roth06d64c62011-07-19 14:50:41 -05006#
7# Authors:
8# Anthony Liguori <aliguori@us.ibm.com>
9# Michael Roth <mdroth@linux.vnet.ibm.com>
Markus Armbruster297a3642014-05-07 09:53:54 +020010# Markus Armbruster <armbru@redhat.com>
Michael Roth06d64c62011-07-19 14:50:41 -050011#
Markus Armbruster678e48a2014-03-01 08:40:34 +010012# This work is licensed under the terms of the GNU GPL, version 2.
13# See the COPYING file in the top-level directory.
Michael Roth06d64c62011-07-19 14:50:41 -050014
Michael Roth06d64c62011-07-19 14:50:41 -050015from qapi import *
Michael Roth06d64c62011-07-19 14:50:41 -050016
Markus Armbrustere98859a2015-09-16 13:06:16 +020017
Markus Armbruster60f85462015-09-16 13:06:17 +020018def gen_visit_decl(name, scalar=False):
19 c_type = c_name(name) + ' *'
20 if not scalar:
21 c_type += '*'
22 return mcgen('''
Eric Blake51e72bc2016-01-29 06:48:54 -070023void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
Markus Armbruster60f85462015-09-16 13:06:17 +020024''',
25 c_name=c_name(name), c_type=c_type)
26
27
Eric Blake4d91e912016-03-03 09:16:45 -070028def gen_visit_members_decl(name):
Eric Blake2208d642016-02-17 23:48:25 -070029 return mcgen('''
Markus Armbruster8c3f8e72015-06-26 10:19:11 +020030
Eric Blake4d91e912016-03-03 09:16:45 -070031void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
Markus Armbruster8c3f8e72015-06-26 10:19:11 +020032''',
Eric Blake4d91e912016-03-03 09:16:45 -070033 c_name=c_name(name))
Eric Blaked02cf372015-10-26 16:34:46 -060034
35
Eric Blake14f00c62016-03-03 09:16:43 -070036def gen_visit_object_members(name, base, members, variants):
Eric Blake4d91e912016-03-03 09:16:45 -070037 ret = mcgen('''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020038
Eric Blake4d91e912016-03-03 09:16:45 -070039void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020040{
41 Error *err = NULL;
Markus Armbruster3a864e72015-07-01 16:55:15 +020042
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020043''',
Eric Blake4d91e912016-03-03 09:16:45 -070044 c_name=c_name(name))
Paolo Bonzinid1953252012-07-17 16:17:04 +020045
Kevin Wolf622f5572013-09-19 11:56:36 +020046 if base:
47 ret += mcgen('''
Eric Blakec81200b2016-03-03 09:16:44 -070048 visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, &err);
Eric Blakefa274ed2016-07-13 21:50:17 -060049 if (err) {
50 goto out;
51 }
Kevin Wolf622f5572013-09-19 11:56:36 +020052''',
Eric Blakeddf21902015-10-26 16:34:49 -060053 c_type=base.c_name())
Kevin Wolf622f5572013-09-19 11:56:36 +020054
Eric Blake12f254f2016-03-17 16:48:35 -060055 for memb in members:
56 if memb.optional:
57 ret += mcgen('''
58 if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
59''',
60 name=memb.name, c_name=c_name(memb.name))
61 push_indent()
62 ret += mcgen('''
63 visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err);
Eric Blakefa274ed2016-07-13 21:50:17 -060064 if (err) {
65 goto out;
66 }
Eric Blake12f254f2016-03-17 16:48:35 -060067''',
68 c_type=memb.type.c_name(), name=memb.name,
69 c_name=c_name(memb.name))
Eric Blake12f254f2016-03-17 16:48:35 -060070 if memb.optional:
71 pop_indent()
72 ret += mcgen('''
73 }
74''')
Paolo Bonzinid1953252012-07-17 16:17:04 +020075
Eric Blake9a5cd422016-02-17 23:48:20 -070076 if variants:
77 ret += mcgen('''
Eric Blake65551902016-02-17 23:48:22 -070078 switch (obj->%(c_name)s) {
Eric Blake9a5cd422016-02-17 23:48:20 -070079''',
80 c_name=c_name(variants.tag_member.name))
81
82 for var in variants.variants:
Eric Blake9a5cd422016-02-17 23:48:20 -070083 ret += mcgen('''
84 case %(case)s:
Eric Blake32bafa82016-03-17 16:48:37 -060085 visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err);
86 break;
Eric Blake9a5cd422016-02-17 23:48:20 -070087''',
88 case=c_enum_const(variants.tag_member.type.name,
89 var.name,
Eric Blake32bafa82016-03-17 16:48:37 -060090 variants.tag_member.type.prefix),
91 c_type=var.type.c_name(), c_name=c_name(var.name))
Eric Blake9a5cd422016-02-17 23:48:20 -070092
93 ret += mcgen('''
94 default:
95 abort();
96 }
97''')
98
Eric Blake12f254f2016-03-17 16:48:35 -060099 # 'goto out' produced for base, for each member, and if variants were
100 # present
Eric Blake9a5cd422016-02-17 23:48:20 -0700101 if base or members or variants:
Markus Armbruster297a3642014-05-07 09:53:54 +0200102 ret += mcgen('''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200103
Markus Armbruster297a3642014-05-07 09:53:54 +0200104out:
105''')
106 ret += mcgen('''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200107 error_propagate(errp, err);
108}
109''')
Kevin Wolfd131c892013-07-02 16:18:35 +0200110 return ret
111
112
Markus Armbruster441cbac2015-09-16 13:06:10 +0200113def gen_visit_list(name, element_type):
Michael Roth06d64c62011-07-19 14:50:41 -0500114 return mcgen('''
115
Eric Blake51e72bc2016-01-29 06:48:54 -0700116void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500117{
Paolo Bonzinid1953252012-07-17 16:17:04 +0200118 Error *err = NULL;
Eric Blaked9f62dd2016-04-28 15:45:31 -0600119 %(c_name)s *tail;
120 size_t size = sizeof(**obj);
Michael Roth06d64c62011-07-19 14:50:41 -0500121
Eric Blaked9f62dd2016-04-28 15:45:31 -0600122 visit_start_list(v, name, (GenericList **)obj, size, &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200123 if (err) {
124 goto out;
Paolo Bonzinib6f04742012-03-22 12:51:06 +0100125 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200126
Eric Blaked9f62dd2016-04-28 15:45:31 -0600127 for (tail = *obj; tail;
128 tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
129 visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err);
130 if (err) {
131 break;
132 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200133 }
134
Markus Armbrustera4a1c702017-03-03 13:32:45 +0100135 if (!err) {
136 visit_check_list(v, &err);
137 }
Eric Blake1158bb22016-06-09 10:48:34 -0600138 visit_end_list(v, (void **)obj);
Eric Blake68ab47e2016-04-28 15:45:32 -0600139 if (err && visit_is_input(v)) {
140 qapi_free_%(c_name)s(*obj);
141 *obj = NULL;
142 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200143out:
144 error_propagate(errp, err);
Michael Roth06d64c62011-07-19 14:50:41 -0500145}
146''',
Markus Armbrustere98859a2015-09-16 13:06:16 +0200147 c_name=c_name(name), c_elt_type=element_type.c_name())
Michael Roth06d64c62011-07-19 14:50:41 -0500148
Markus Armbrustere98859a2015-09-16 13:06:16 +0200149
150def gen_visit_enum(name):
Michael Roth06d64c62011-07-19 14:50:41 -0500151 return mcgen('''
152
Eric Blake51e72bc2016-01-29 06:48:54 -0700153void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500154{
Eric Blake395a2332016-01-29 06:48:52 -0700155 int value = *obj;
Eric Blake337283d2016-01-29 06:48:57 -0700156 visit_type_enum(v, name, &value, %(c_name)s_lookup, errp);
Eric Blake395a2332016-01-29 06:48:52 -0700157 *obj = value;
Michael Roth06d64c62011-07-19 14:50:41 -0500158}
159''',
Eric Blake337283d2016-01-29 06:48:57 -0700160 c_name=c_name(name))
Michael Roth06d64c62011-07-19 14:50:41 -0500161
Markus Armbrustere98859a2015-09-16 13:06:16 +0200162
Markus Armbruster441cbac2015-09-16 13:06:10 +0200163def gen_visit_alternate(name, variants):
Eric Blaked00341a2015-12-01 22:20:51 -0700164 promote_int = 'true'
Eric Blakebecceed2016-02-17 23:48:26 -0700165 ret = ''
Eric Blaked00341a2015-12-01 22:20:51 -0700166 for var in variants.variants:
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400167 if var.type.alternate_qtype() == 'QTYPE_QNUM':
Eric Blaked00341a2015-12-01 22:20:51 -0700168 promote_int = 'false'
169
Eric Blakebecceed2016-02-17 23:48:26 -0700170 ret += mcgen('''
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200171
Eric Blake51e72bc2016-01-29 06:48:54 -0700172void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200173{
174 Error *err = NULL;
175
Eric Blakedbf11922016-02-17 23:48:29 -0700176 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
177 %(promote_int)s, &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200178 if (err) {
179 goto out;
180 }
Eric Blake9b4e38f2016-06-15 11:37:51 -0600181 if (!*obj) {
182 goto out_obj;
183 }
Eric Blake150d0562015-10-26 16:34:52 -0600184 switch ((*obj)->type) {
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200185''',
Eric Blakebecceed2016-02-17 23:48:26 -0700186 c_name=c_name(name), promote_int=promote_int)
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200187
Markus Armbruster441cbac2015-09-16 13:06:10 +0200188 for var in variants.variants:
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200189 ret += mcgen('''
Markus Armbrustere98859a2015-09-16 13:06:16 +0200190 case %(case)s:
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200191''',
Eric Blakebecceed2016-02-17 23:48:26 -0700192 case=var.type.alternate_qtype())
193 if isinstance(var.type, QAPISchemaObjectType):
194 ret += mcgen('''
195 visit_start_struct(v, name, NULL, 0, &err);
196 if (err) {
197 break;
198 }
Eric Blakec81200b2016-03-03 09:16:44 -0700199 visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
Eric Blake15c2f662016-04-28 15:45:27 -0600200 if (!err) {
201 visit_check_struct(v, &err);
202 }
Eric Blake1158bb22016-06-09 10:48:34 -0600203 visit_end_struct(v, NULL);
Eric Blakebecceed2016-02-17 23:48:26 -0700204''',
205 c_type=var.type.c_name(),
206 c_name=c_name(var.name))
207 else:
208 ret += mcgen('''
209 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
210''',
211 c_type=var.type.c_name(),
212 c_name=c_name(var.name))
213 ret += mcgen('''
214 break;
215''')
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200216
217 ret += mcgen('''
Eric Blake9b4e38f2016-06-15 11:37:51 -0600218 case QTYPE_NONE:
219 abort();
Markus Armbruster297a3642014-05-07 09:53:54 +0200220 default:
Eric Blake0426d532015-12-01 22:20:48 -0700221 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
222 "%(name)s");
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200223 }
Eric Blake9b4e38f2016-06-15 11:37:51 -0600224out_obj:
Eric Blake1158bb22016-06-09 10:48:34 -0600225 visit_end_alternate(v, (void **)obj);
Eric Blake68ab47e2016-04-28 15:45:32 -0600226 if (err && visit_is_input(v)) {
227 qapi_free_%(c_name)s(*obj);
228 *obj = NULL;
229 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200230out:
231 error_propagate(errp, err);
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200232}
Eric Blake0426d532015-12-01 22:20:48 -0700233''',
Eric Blake68ab47e2016-04-28 15:45:32 -0600234 name=name, c_name=c_name(name))
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200235
236 return ret
237
Markus Armbrustere98859a2015-09-16 13:06:16 +0200238
Markus Armbruster59d9e842016-02-17 23:48:21 -0700239def gen_visit_object(name, base, members, variants):
Eric Blake7ce106a2016-03-17 16:48:30 -0600240 return mcgen('''
Michael Roth06d64c62011-07-19 14:50:41 -0500241
Eric Blake51e72bc2016-01-29 06:48:54 -0700242void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500243{
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100244 Error *err = NULL;
245
Eric Blake337283d2016-01-29 06:48:57 -0700246 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200247 if (err) {
248 goto out;
249 }
Eric Blakee36c7142015-09-29 16:21:11 -0600250 if (!*obj) {
251 goto out_obj;
252 }
Eric Blakec81200b2016-03-03 09:16:44 -0700253 visit_type_%(c_name)s_members(v, *obj, &err);
Eric Blake15c2f662016-04-28 15:45:27 -0600254 if (err) {
255 goto out_obj;
256 }
257 visit_check_struct(v, &err);
Eric Blake9a5cd422016-02-17 23:48:20 -0700258out_obj:
Eric Blake1158bb22016-06-09 10:48:34 -0600259 visit_end_struct(v, (void **)obj);
Eric Blake68ab47e2016-04-28 15:45:32 -0600260 if (err && visit_is_input(v)) {
261 qapi_free_%(c_name)s(*obj);
262 *obj = NULL;
263 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200264out:
265 error_propagate(errp, err);
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100266}
Eric Blake9a5cd422016-02-17 23:48:20 -0700267''',
268 c_name=c_name(name))
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100269
Markus Armbrustere98859a2015-09-16 13:06:16 +0200270
Markus Armbruster441cbac2015-09-16 13:06:10 +0200271class QAPISchemaGenVisitVisitor(QAPISchemaVisitor):
272 def __init__(self):
273 self.decl = None
274 self.defn = None
275 self._btin = None
276
277 def visit_begin(self, schema):
278 self.decl = ''
279 self.defn = ''
280 self._btin = guardstart('QAPI_VISIT_BUILTIN')
281
282 def visit_end(self):
283 # To avoid header dependency hell, we always generate
284 # declarations for built-in types in our header files and
285 # simply guard them. See also do_builtins (command line
286 # option -b).
287 self._btin += guardend('QAPI_VISIT_BUILTIN')
288 self.decl = self._btin + self.decl
289 self._btin = None
290
291 def visit_enum_type(self, name, info, values, prefix):
Eric Blake7264f5c2015-12-01 22:20:47 -0700292 # Special case for our lone builtin enum type
293 # TODO use something cleaner than existence of info
294 if not info:
295 self._btin += gen_visit_decl(name, scalar=True)
296 if do_builtins:
297 self.defn += gen_visit_enum(name)
298 else:
299 self.decl += gen_visit_decl(name, scalar=True)
300 self.defn += gen_visit_enum(name)
Markus Armbruster441cbac2015-09-16 13:06:10 +0200301
302 def visit_array_type(self, name, info, element_type):
303 decl = gen_visit_decl(name)
304 defn = gen_visit_list(name, element_type)
305 if isinstance(element_type, QAPISchemaBuiltinType):
306 self._btin += decl
307 if do_builtins:
308 self.defn += defn
309 else:
310 self.decl += decl
311 self.defn += defn
312
313 def visit_object_type(self, name, info, base, members, variants):
Eric Blake7ce106a2016-03-17 16:48:30 -0600314 # Nothing to do for the special empty builtin
315 if name == 'q_empty':
316 return
Eric Blake4d91e912016-03-03 09:16:45 -0700317 self.decl += gen_visit_members_decl(name)
Eric Blake7ce106a2016-03-17 16:48:30 -0600318 self.defn += gen_visit_object_members(name, base, members, variants)
319 # TODO Worth changing the visitor signature, so we could
320 # directly use rather than repeat type.is_implicit()?
321 if not name.startswith('q_'):
322 # only explicit types need an allocating visit
323 self.decl += gen_visit_decl(name)
324 self.defn += gen_visit_object(name, base, members, variants)
Markus Armbruster441cbac2015-09-16 13:06:10 +0200325
326 def visit_alternate_type(self, name, info, variants):
327 self.decl += gen_visit_decl(name)
328 self.defn += gen_visit_alternate(name, variants)
329
330# If you link code generated from multiple schemata, you want only one
331# instance of the code for built-in types. Generate it only when
332# do_builtins, enabled by command line option -b. See also
333# QAPISchemaGenVisitVisitor.visit_end().
Michael Roth7c946bc2013-05-10 17:46:02 -0500334do_builtins = False
Avi Kivity8d3bc512011-12-27 16:02:16 +0200335
Markus Armbruster2114f5a2015-04-02 13:12:21 +0200336(input_file, output_dir, do_c, do_h, prefix, opts) = \
Markus Armbrusteref801a92017-03-15 13:57:08 +0100337 parse_command_line('b', ['builtins'])
Avi Kivity8d3bc512011-12-27 16:02:16 +0200338
Markus Armbruster2114f5a2015-04-02 13:12:21 +0200339for o, a in opts:
Markus Armbrusteref801a92017-03-15 13:57:08 +0100340 if o in ('-b', '--builtins'):
Markus Armbruster2114f5a2015-04-02 13:12:21 +0200341 do_builtins = True
Michael Roth06d64c62011-07-19 14:50:41 -0500342
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200343c_comment = '''
344/*
345 * schema-defined QAPI visitor functions
346 *
347 * Copyright IBM, Corp. 2011
348 *
349 * Authors:
350 * Anthony Liguori <aliguori@us.ibm.com>
351 *
352 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
353 * See the COPYING.LIB file in the top-level directory.
354 *
355 */
356'''
357h_comment = '''
358/*
359 * schema-defined QAPI visitor functions
360 *
361 * Copyright IBM, Corp. 2011
362 *
363 * Authors:
364 * Anthony Liguori <aliguori@us.ibm.com>
365 *
366 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
367 * See the COPYING.LIB file in the top-level directory.
368 *
369 */
370'''
Michael Roth06d64c62011-07-19 14:50:41 -0500371
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200372(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
373 'qapi-visit.c', 'qapi-visit.h',
374 c_comment, h_comment)
Michael Roth06d64c62011-07-19 14:50:41 -0500375
376fdef.write(mcgen('''
Eric Blake9167ebd2016-02-08 08:36:46 -0700377#include "qemu/osdep.h"
Paolo Bonzini79ee7df2012-12-06 11:22:34 +0100378#include "qemu-common.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +0100379#include "qapi/error.h"
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200380#include "%(prefix)sqapi-visit.h"
Michael Roth06d64c62011-07-19 14:50:41 -0500381''',
Markus Armbrustere98859a2015-09-16 13:06:16 +0200382 prefix=prefix))
Michael Roth06d64c62011-07-19 14:50:41 -0500383
384fdecl.write(mcgen('''
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +0100385#include "qapi/visitor.h"
Eric Blake0426d532015-12-01 22:20:48 -0700386#include "qapi/qmp/qerror.h"
Michael Roth06d64c62011-07-19 14:50:41 -0500387#include "%(prefix)sqapi-types.h"
Michael Roth7c946bc2013-05-10 17:46:02 -0500388
Michael Roth06d64c62011-07-19 14:50:41 -0500389''',
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200390 prefix=prefix))
Michael Roth06d64c62011-07-19 14:50:41 -0500391
Markus Armbruster441cbac2015-09-16 13:06:10 +0200392schema = QAPISchema(input_file)
393gen = QAPISchemaGenVisitVisitor()
394schema.visit(gen)
395fdef.write(gen.defn)
396fdecl.write(gen.decl)
Michael Roth06d64c62011-07-19 14:50:41 -0500397
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200398close_output(fdef, fdecl)