blob: 96f2491c16c968c49f6c7bad876455e8a4408d07 [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 *
Markus Armbruster297a3642014-05-07 09:53:54 +020016import re
Michael Roth06d64c62011-07-19 14:50:41 -050017
Markus Armbrustere98859a2015-09-16 13:06:16 +020018
Markus Armbruster60f85462015-09-16 13:06:17 +020019def gen_visit_decl(name, scalar=False):
20 c_type = c_name(name) + ' *'
21 if not scalar:
22 c_type += '*'
23 return mcgen('''
Eric Blake51e72bc2016-01-29 06:48:54 -070024void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
Markus Armbruster60f85462015-09-16 13:06:17 +020025''',
26 c_name=c_name(name), c_type=c_type)
27
28
Eric Blake4d91e912016-03-03 09:16:45 -070029def gen_visit_members_decl(name):
Eric Blake2208d642016-02-17 23:48:25 -070030 return mcgen('''
Markus Armbruster8c3f8e72015-06-26 10:19:11 +020031
Eric Blake4d91e912016-03-03 09:16:45 -070032void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
Markus Armbruster8c3f8e72015-06-26 10:19:11 +020033''',
Eric Blake4d91e912016-03-03 09:16:45 -070034 c_name=c_name(name))
Eric Blaked02cf372015-10-26 16:34:46 -060035
36
Eric Blake14f00c62016-03-03 09:16:43 -070037def gen_visit_object_members(name, base, members, variants):
Eric Blake4d91e912016-03-03 09:16:45 -070038 ret = mcgen('''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020039
Eric Blake4d91e912016-03-03 09:16:45 -070040void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020041{
42 Error *err = NULL;
Markus Armbruster3a864e72015-07-01 16:55:15 +020043
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020044''',
Eric Blake4d91e912016-03-03 09:16:45 -070045 c_name=c_name(name))
Paolo Bonzinid1953252012-07-17 16:17:04 +020046
Kevin Wolf622f5572013-09-19 11:56:36 +020047 if base:
48 ret += mcgen('''
Eric Blakec81200b2016-03-03 09:16:44 -070049 visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, &err);
Eric Blakefa274ed2016-07-13 21:50:17 -060050 if (err) {
51 goto out;
52 }
Kevin Wolf622f5572013-09-19 11:56:36 +020053''',
Eric Blakeddf21902015-10-26 16:34:49 -060054 c_type=base.c_name())
Kevin Wolf622f5572013-09-19 11:56:36 +020055
Eric Blake12f254f2016-03-17 16:48:35 -060056 for memb in members:
57 if memb.optional:
58 ret += mcgen('''
59 if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
60''',
61 name=memb.name, c_name=c_name(memb.name))
62 push_indent()
63 ret += mcgen('''
64 visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err);
Eric Blakefa274ed2016-07-13 21:50:17 -060065 if (err) {
66 goto out;
67 }
Eric Blake12f254f2016-03-17 16:48:35 -060068''',
69 c_type=memb.type.c_name(), name=memb.name,
70 c_name=c_name(memb.name))
Eric Blake12f254f2016-03-17 16:48:35 -060071 if memb.optional:
72 pop_indent()
73 ret += mcgen('''
74 }
75''')
Paolo Bonzinid1953252012-07-17 16:17:04 +020076
Eric Blake9a5cd422016-02-17 23:48:20 -070077 if variants:
78 ret += mcgen('''
Eric Blake65551902016-02-17 23:48:22 -070079 switch (obj->%(c_name)s) {
Eric Blake9a5cd422016-02-17 23:48:20 -070080''',
81 c_name=c_name(variants.tag_member.name))
82
83 for var in variants.variants:
Eric Blake9a5cd422016-02-17 23:48:20 -070084 ret += mcgen('''
85 case %(case)s:
Eric Blake32bafa82016-03-17 16:48:37 -060086 visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err);
87 break;
Eric Blake9a5cd422016-02-17 23:48:20 -070088''',
89 case=c_enum_const(variants.tag_member.type.name,
90 var.name,
Eric Blake32bafa82016-03-17 16:48:37 -060091 variants.tag_member.type.prefix),
92 c_type=var.type.c_name(), c_name=c_name(var.name))
Eric Blake9a5cd422016-02-17 23:48:20 -070093
94 ret += mcgen('''
95 default:
96 abort();
97 }
98''')
99
Eric Blake12f254f2016-03-17 16:48:35 -0600100 # 'goto out' produced for base, for each member, and if variants were
101 # present
Eric Blake9a5cd422016-02-17 23:48:20 -0700102 if base or members or variants:
Markus Armbruster297a3642014-05-07 09:53:54 +0200103 ret += mcgen('''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200104
Markus Armbruster297a3642014-05-07 09:53:54 +0200105out:
106''')
107 ret += mcgen('''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200108 error_propagate(errp, err);
109}
110''')
Kevin Wolfd131c892013-07-02 16:18:35 +0200111 return ret
112
113
Markus Armbruster441cbac2015-09-16 13:06:10 +0200114def gen_visit_list(name, element_type):
Michael Roth06d64c62011-07-19 14:50:41 -0500115 return mcgen('''
116
Eric Blake51e72bc2016-01-29 06:48:54 -0700117void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500118{
Paolo Bonzinid1953252012-07-17 16:17:04 +0200119 Error *err = NULL;
Eric Blaked9f62dd2016-04-28 15:45:31 -0600120 %(c_name)s *tail;
121 size_t size = sizeof(**obj);
Michael Roth06d64c62011-07-19 14:50:41 -0500122
Eric Blaked9f62dd2016-04-28 15:45:31 -0600123 visit_start_list(v, name, (GenericList **)obj, size, &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200124 if (err) {
125 goto out;
Paolo Bonzinib6f04742012-03-22 12:51:06 +0100126 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200127
Eric Blaked9f62dd2016-04-28 15:45:31 -0600128 for (tail = *obj; tail;
129 tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
130 visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err);
131 if (err) {
132 break;
133 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200134 }
135
Eric Blake1158bb22016-06-09 10:48:34 -0600136 visit_end_list(v, (void **)obj);
Eric Blake68ab47e2016-04-28 15:45:32 -0600137 if (err && visit_is_input(v)) {
138 qapi_free_%(c_name)s(*obj);
139 *obj = NULL;
140 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200141out:
142 error_propagate(errp, err);
Michael Roth06d64c62011-07-19 14:50:41 -0500143}
144''',
Markus Armbrustere98859a2015-09-16 13:06:16 +0200145 c_name=c_name(name), c_elt_type=element_type.c_name())
Michael Roth06d64c62011-07-19 14:50:41 -0500146
Markus Armbrustere98859a2015-09-16 13:06:16 +0200147
148def gen_visit_enum(name):
Michael Roth06d64c62011-07-19 14:50:41 -0500149 return mcgen('''
150
Eric Blake51e72bc2016-01-29 06:48:54 -0700151void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500152{
Eric Blake395a2332016-01-29 06:48:52 -0700153 int value = *obj;
Eric Blake337283d2016-01-29 06:48:57 -0700154 visit_type_enum(v, name, &value, %(c_name)s_lookup, errp);
Eric Blake395a2332016-01-29 06:48:52 -0700155 *obj = value;
Michael Roth06d64c62011-07-19 14:50:41 -0500156}
157''',
Eric Blake337283d2016-01-29 06:48:57 -0700158 c_name=c_name(name))
Michael Roth06d64c62011-07-19 14:50:41 -0500159
Markus Armbrustere98859a2015-09-16 13:06:16 +0200160
Markus Armbruster441cbac2015-09-16 13:06:10 +0200161def gen_visit_alternate(name, variants):
Eric Blaked00341a2015-12-01 22:20:51 -0700162 promote_int = 'true'
Eric Blakebecceed2016-02-17 23:48:26 -0700163 ret = ''
Eric Blaked00341a2015-12-01 22:20:51 -0700164 for var in variants.variants:
165 if var.type.alternate_qtype() == 'QTYPE_QINT':
166 promote_int = 'false'
167
Eric Blakebecceed2016-02-17 23:48:26 -0700168 ret += mcgen('''
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200169
Eric Blake51e72bc2016-01-29 06:48:54 -0700170void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200171{
172 Error *err = NULL;
173
Eric Blakedbf11922016-02-17 23:48:29 -0700174 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
175 %(promote_int)s, &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200176 if (err) {
177 goto out;
178 }
Eric Blake9b4e38f2016-06-15 11:37:51 -0600179 if (!*obj) {
180 goto out_obj;
181 }
Eric Blake150d0562015-10-26 16:34:52 -0600182 switch ((*obj)->type) {
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200183''',
Eric Blakebecceed2016-02-17 23:48:26 -0700184 c_name=c_name(name), promote_int=promote_int)
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200185
Markus Armbruster441cbac2015-09-16 13:06:10 +0200186 for var in variants.variants:
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200187 ret += mcgen('''
Markus Armbrustere98859a2015-09-16 13:06:16 +0200188 case %(case)s:
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200189''',
Eric Blakebecceed2016-02-17 23:48:26 -0700190 case=var.type.alternate_qtype())
191 if isinstance(var.type, QAPISchemaObjectType):
192 ret += mcgen('''
193 visit_start_struct(v, name, NULL, 0, &err);
194 if (err) {
195 break;
196 }
Eric Blakec81200b2016-03-03 09:16:44 -0700197 visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
Eric Blake15c2f662016-04-28 15:45:27 -0600198 if (!err) {
199 visit_check_struct(v, &err);
200 }
Eric Blake1158bb22016-06-09 10:48:34 -0600201 visit_end_struct(v, NULL);
Eric Blakebecceed2016-02-17 23:48:26 -0700202''',
203 c_type=var.type.c_name(),
204 c_name=c_name(var.name))
205 else:
206 ret += mcgen('''
207 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
208''',
209 c_type=var.type.c_name(),
210 c_name=c_name(var.name))
211 ret += mcgen('''
212 break;
213''')
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200214
215 ret += mcgen('''
Eric Blake9b4e38f2016-06-15 11:37:51 -0600216 case QTYPE_NONE:
217 abort();
Markus Armbruster297a3642014-05-07 09:53:54 +0200218 default:
Eric Blake0426d532015-12-01 22:20:48 -0700219 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
220 "%(name)s");
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200221 }
Eric Blake9b4e38f2016-06-15 11:37:51 -0600222out_obj:
Eric Blake1158bb22016-06-09 10:48:34 -0600223 visit_end_alternate(v, (void **)obj);
Eric Blake68ab47e2016-04-28 15:45:32 -0600224 if (err && visit_is_input(v)) {
225 qapi_free_%(c_name)s(*obj);
226 *obj = NULL;
227 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200228out:
229 error_propagate(errp, err);
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200230}
Eric Blake0426d532015-12-01 22:20:48 -0700231''',
Eric Blake68ab47e2016-04-28 15:45:32 -0600232 name=name, c_name=c_name(name))
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200233
234 return ret
235
Markus Armbrustere98859a2015-09-16 13:06:16 +0200236
Markus Armbruster59d9e842016-02-17 23:48:21 -0700237def gen_visit_object(name, base, members, variants):
Eric Blake7ce106a2016-03-17 16:48:30 -0600238 return mcgen('''
Michael Roth06d64c62011-07-19 14:50:41 -0500239
Eric Blake51e72bc2016-01-29 06:48:54 -0700240void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500241{
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100242 Error *err = NULL;
243
Eric Blake337283d2016-01-29 06:48:57 -0700244 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200245 if (err) {
246 goto out;
247 }
Eric Blakee36c7142015-09-29 16:21:11 -0600248 if (!*obj) {
249 goto out_obj;
250 }
Eric Blakec81200b2016-03-03 09:16:44 -0700251 visit_type_%(c_name)s_members(v, *obj, &err);
Eric Blake15c2f662016-04-28 15:45:27 -0600252 if (err) {
253 goto out_obj;
254 }
255 visit_check_struct(v, &err);
Eric Blake9a5cd422016-02-17 23:48:20 -0700256out_obj:
Eric Blake1158bb22016-06-09 10:48:34 -0600257 visit_end_struct(v, (void **)obj);
Eric Blake68ab47e2016-04-28 15:45:32 -0600258 if (err && visit_is_input(v)) {
259 qapi_free_%(c_name)s(*obj);
260 *obj = NULL;
261 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200262out:
263 error_propagate(errp, err);
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100264}
Eric Blake9a5cd422016-02-17 23:48:20 -0700265''',
266 c_name=c_name(name))
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100267
Markus Armbrustere98859a2015-09-16 13:06:16 +0200268
Markus Armbruster441cbac2015-09-16 13:06:10 +0200269class QAPISchemaGenVisitVisitor(QAPISchemaVisitor):
270 def __init__(self):
271 self.decl = None
272 self.defn = None
273 self._btin = None
274
275 def visit_begin(self, schema):
276 self.decl = ''
277 self.defn = ''
278 self._btin = guardstart('QAPI_VISIT_BUILTIN')
279
280 def visit_end(self):
281 # To avoid header dependency hell, we always generate
282 # declarations for built-in types in our header files and
283 # simply guard them. See also do_builtins (command line
284 # option -b).
285 self._btin += guardend('QAPI_VISIT_BUILTIN')
286 self.decl = self._btin + self.decl
287 self._btin = None
288
289 def visit_enum_type(self, name, info, values, prefix):
Eric Blake7264f5c2015-12-01 22:20:47 -0700290 # Special case for our lone builtin enum type
291 # TODO use something cleaner than existence of info
292 if not info:
293 self._btin += gen_visit_decl(name, scalar=True)
294 if do_builtins:
295 self.defn += gen_visit_enum(name)
296 else:
297 self.decl += gen_visit_decl(name, scalar=True)
298 self.defn += gen_visit_enum(name)
Markus Armbruster441cbac2015-09-16 13:06:10 +0200299
300 def visit_array_type(self, name, info, element_type):
301 decl = gen_visit_decl(name)
302 defn = gen_visit_list(name, element_type)
303 if isinstance(element_type, QAPISchemaBuiltinType):
304 self._btin += decl
305 if do_builtins:
306 self.defn += defn
307 else:
308 self.decl += decl
309 self.defn += defn
310
311 def visit_object_type(self, name, info, base, members, variants):
Eric Blake7ce106a2016-03-17 16:48:30 -0600312 # Nothing to do for the special empty builtin
313 if name == 'q_empty':
314 return
Eric Blake4d91e912016-03-03 09:16:45 -0700315 self.decl += gen_visit_members_decl(name)
Eric Blake7ce106a2016-03-17 16:48:30 -0600316 self.defn += gen_visit_object_members(name, base, members, variants)
317 # TODO Worth changing the visitor signature, so we could
318 # directly use rather than repeat type.is_implicit()?
319 if not name.startswith('q_'):
320 # only explicit types need an allocating visit
321 self.decl += gen_visit_decl(name)
322 self.defn += gen_visit_object(name, base, members, variants)
Markus Armbruster441cbac2015-09-16 13:06:10 +0200323
324 def visit_alternate_type(self, name, info, variants):
325 self.decl += gen_visit_decl(name)
326 self.defn += gen_visit_alternate(name, variants)
327
328# If you link code generated from multiple schemata, you want only one
329# instance of the code for built-in types. Generate it only when
330# do_builtins, enabled by command line option -b. See also
331# QAPISchemaGenVisitVisitor.visit_end().
Michael Roth7c946bc2013-05-10 17:46:02 -0500332do_builtins = False
Avi Kivity8d3bc512011-12-27 16:02:16 +0200333
Markus Armbruster2114f5a2015-04-02 13:12:21 +0200334(input_file, output_dir, do_c, do_h, prefix, opts) = \
335 parse_command_line("b", ["builtins"])
Avi Kivity8d3bc512011-12-27 16:02:16 +0200336
Markus Armbruster2114f5a2015-04-02 13:12:21 +0200337for o, a in opts:
338 if o in ("-b", "--builtins"):
339 do_builtins = True
Michael Roth06d64c62011-07-19 14:50:41 -0500340
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200341c_comment = '''
342/*
343 * schema-defined QAPI visitor functions
344 *
345 * Copyright IBM, Corp. 2011
346 *
347 * Authors:
348 * Anthony Liguori <aliguori@us.ibm.com>
349 *
350 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
351 * See the COPYING.LIB file in the top-level directory.
352 *
353 */
354'''
355h_comment = '''
356/*
357 * schema-defined QAPI visitor functions
358 *
359 * Copyright IBM, Corp. 2011
360 *
361 * Authors:
362 * Anthony Liguori <aliguori@us.ibm.com>
363 *
364 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
365 * See the COPYING.LIB file in the top-level directory.
366 *
367 */
368'''
Michael Roth06d64c62011-07-19 14:50:41 -0500369
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200370(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
371 'qapi-visit.c', 'qapi-visit.h',
372 c_comment, h_comment)
Michael Roth06d64c62011-07-19 14:50:41 -0500373
374fdef.write(mcgen('''
Eric Blake9167ebd2016-02-08 08:36:46 -0700375#include "qemu/osdep.h"
Paolo Bonzini79ee7df2012-12-06 11:22:34 +0100376#include "qemu-common.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +0100377#include "qapi/error.h"
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200378#include "%(prefix)sqapi-visit.h"
Michael Roth06d64c62011-07-19 14:50:41 -0500379''',
Markus Armbrustere98859a2015-09-16 13:06:16 +0200380 prefix=prefix))
Michael Roth06d64c62011-07-19 14:50:41 -0500381
382fdecl.write(mcgen('''
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +0100383#include "qapi/visitor.h"
Eric Blake0426d532015-12-01 22:20:48 -0700384#include "qapi/qmp/qerror.h"
Michael Roth06d64c62011-07-19 14:50:41 -0500385#include "%(prefix)sqapi-types.h"
Michael Roth7c946bc2013-05-10 17:46:02 -0500386
Michael Roth06d64c62011-07-19 14:50:41 -0500387''',
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200388 prefix=prefix))
Michael Roth06d64c62011-07-19 14:50:41 -0500389
Markus Armbruster441cbac2015-09-16 13:06:10 +0200390schema = QAPISchema(input_file)
391gen = QAPISchemaGenVisitVisitor()
392schema.visit(gen)
393fdef.write(gen.defn)
394fdecl.write(gen.decl)
Michael Roth06d64c62011-07-19 14:50:41 -0500395
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200396close_output(fdef, fdecl)