blob: 3cd662bd6bb6ed162482f5b928192af24ab119ba [file] [log] [blame]
Michael Roth06d64c62011-07-19 14:50:41 -05001#
2# QAPI visitor generator
3#
4# Copyright IBM, Corp. 2011
Eric Blake6540e9f2015-04-10 15:07:59 -06005# Copyright (C) 2014-2015 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
15from ordereddict import OrderedDict
16from qapi import *
Markus Armbruster297a3642014-05-07 09:53:54 +020017import re
Michael Roth06d64c62011-07-19 14:50:41 -050018
Markus Armbruster8c07edd2015-06-30 09:27:04 +020019implicit_structs_seen = set()
Markus Armbruster8c3f8e72015-06-26 10:19:11 +020020struct_fields_seen = set()
Markus Armbrusterbe3c7712014-05-07 09:53:50 +020021
22def generate_visit_implicit_struct(type):
Markus Armbruster8c07edd2015-06-30 09:27:04 +020023 if type in implicit_structs_seen:
Markus Armbrusterbe3c7712014-05-07 09:53:50 +020024 return ''
Markus Armbruster8c07edd2015-06-30 09:27:04 +020025 implicit_structs_seen.add(type)
Markus Armbruster8c3f8e72015-06-26 10:19:11 +020026 ret = ''
27 if type not in struct_fields_seen:
28 # Need a forward declaration
29 ret += mcgen('''
30
31static void visit_type_%(c_type)s_fields(Visitor *m, %(c_type)s **obj, Error **errp);
32''',
33 c_type=type_name(type))
34
35 ret += mcgen('''
Markus Armbrusterbe3c7712014-05-07 09:53:50 +020036
37static void visit_type_implicit_%(c_type)s(Visitor *m, %(c_type)s **obj, Error **errp)
38{
39 Error *err = NULL;
40
41 visit_start_implicit_struct(m, (void **)obj, sizeof(%(c_type)s), &err);
42 if (!err) {
Markus Armbruster297a3642014-05-07 09:53:54 +020043 visit_type_%(c_type)s_fields(m, obj, errp);
Markus Armbrusterbe3c7712014-05-07 09:53:50 +020044 visit_end_implicit_struct(m, &err);
45 }
46 error_propagate(errp, err);
47}
48''',
49 c_type=type_name(type))
Markus Armbruster8c3f8e72015-06-26 10:19:11 +020050 return ret
Markus Armbrusterbe3c7712014-05-07 09:53:50 +020051
Eric Blakea82b9822015-05-04 09:05:34 -060052def generate_visit_struct_fields(name, members, base = None):
Markus Armbruster8c3f8e72015-06-26 10:19:11 +020053 struct_fields_seen.add(name)
54
Kevin Wolfd131c892013-07-02 16:18:35 +020055 ret = ''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020056
Markus Armbrusterbe3c7712014-05-07 09:53:50 +020057 if base:
58 ret += generate_visit_implicit_struct(base)
59
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020060 ret += mcgen('''
61
Eric Blakea82b9822015-05-04 09:05:34 -060062static void visit_type_%(name)s_fields(Visitor *m, %(name)s **obj, Error **errp)
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020063{
64 Error *err = NULL;
Markus Armbruster3a864e72015-07-01 16:55:15 +020065
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020066''',
Eric Blake83a02702015-05-14 06:50:57 -060067 name=c_name(name))
Kevin Wolf50f2bdc2013-07-03 15:58:57 +020068 push_indent()
Paolo Bonzinid1953252012-07-17 16:17:04 +020069
Kevin Wolf622f5572013-09-19 11:56:36 +020070 if base:
71 ret += mcgen('''
Eric Blakea82b9822015-05-04 09:05:34 -060072visit_type_implicit_%(type)s(m, &(*obj)->%(c_name)s, &err);
Markus Armbruster297a3642014-05-07 09:53:54 +020073if (err) {
74 goto out;
75}
Kevin Wolf622f5572013-09-19 11:56:36 +020076''',
Eric Blake18df5152015-05-14 06:50:48 -060077 type=type_name(base), c_name=c_name('base'))
Kevin Wolf622f5572013-09-19 11:56:36 +020078
Eric Blake6b5abc72015-05-04 09:05:33 -060079 for argname, argentry, optional in parse_args(members):
Michael Roth06d64c62011-07-19 14:50:41 -050080 if optional:
81 ret += mcgen('''
Eric Blakea82b9822015-05-04 09:05:34 -060082visit_optional(m, &(*obj)->has_%(c_name)s, "%(name)s", &err);
83if (!err && (*obj)->has_%(c_name)s) {
Michael Roth06d64c62011-07-19 14:50:41 -050084''',
Eric Blake18df5152015-05-14 06:50:48 -060085 c_name=c_name(argname), name=argname)
Michael Roth06d64c62011-07-19 14:50:41 -050086 push_indent()
87
Eric Blake6b5abc72015-05-04 09:05:33 -060088 ret += mcgen('''
Eric Blakea82b9822015-05-04 09:05:34 -060089visit_type_%(type)s(m, &(*obj)->%(c_name)s, "%(name)s", &err);
Michael Roth06d64c62011-07-19 14:50:41 -050090''',
Eric Blake18df5152015-05-14 06:50:48 -060091 type=type_name(argentry), c_name=c_name(argname),
Eric Blake6b5abc72015-05-04 09:05:33 -060092 name=argname)
Michael Roth06d64c62011-07-19 14:50:41 -050093
94 if optional:
95 pop_indent()
96 ret += mcgen('''
97}
Paolo Bonzinid1953252012-07-17 16:17:04 +020098''')
Markus Armbruster297a3642014-05-07 09:53:54 +020099 ret += mcgen('''
100if (err) {
101 goto out;
102}
103''')
Paolo Bonzinid1953252012-07-17 16:17:04 +0200104
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200105 pop_indent()
Markus Armbruster297a3642014-05-07 09:53:54 +0200106 if re.search('^ *goto out\\;', ret, re.MULTILINE):
107 ret += mcgen('''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200108
Markus Armbruster297a3642014-05-07 09:53:54 +0200109out:
110''')
111 ret += mcgen('''
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200112 error_propagate(errp, err);
113}
114''')
Kevin Wolfd131c892013-07-02 16:18:35 +0200115 return ret
116
117
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200118def generate_visit_struct_body(name):
Eric Blake2f52e202015-07-30 16:33:07 -0600119 # FIXME: if *obj is NULL on entry, and visit_start_struct() assigns to
120 # *obj, but then visit_type_FOO_fields() fails, we should clean up *obj
121 # rather than leaving it non-NULL. As currently written, the caller must
122 # call qapi_free_FOO() to avoid a memory leak of the partial FOO.
Kevin Wolfd131c892013-07-02 16:18:35 +0200123 ret = mcgen('''
Markus Armbruster297a3642014-05-07 09:53:54 +0200124 Error *err = NULL;
125
Eric Blake83a02702015-05-14 06:50:57 -0600126 visit_start_struct(m, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200127 if (!err) {
128 if (*obj) {
Eric Blake83a02702015-05-14 06:50:57 -0600129 visit_type_%(c_name)s_fields(m, obj, errp);
Markus Armbruster297a3642014-05-07 09:53:54 +0200130 }
131 visit_end_struct(m, &err);
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200132 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200133 error_propagate(errp, err);
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200134''',
Eric Blake83a02702015-05-14 06:50:57 -0600135 name=name, c_name=c_name(name))
Kevin Wolfd131c892013-07-02 16:18:35 +0200136
Michael Roth06d64c62011-07-19 14:50:41 -0500137 return ret
138
Kevin Wolf14d36302013-09-18 17:22:02 +0200139def generate_visit_struct(expr):
140
Eric Blakefd41dd42015-05-04 09:05:25 -0600141 name = expr['struct']
Kevin Wolf14d36302013-09-18 17:22:02 +0200142 members = expr['data']
Kevin Wolf622f5572013-09-19 11:56:36 +0200143 base = expr.get('base')
Kevin Wolf14d36302013-09-18 17:22:02 +0200144
Eric Blakea82b9822015-05-04 09:05:34 -0600145 ret = generate_visit_struct_fields(name, members, base)
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200146
147 ret += mcgen('''
Michael Roth06d64c62011-07-19 14:50:41 -0500148
Amos Kong638ca8a2014-06-10 19:25:51 +0800149void visit_type_%(name)s(Visitor *m, %(name)s **obj, const char *name, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500150{
Michael Roth06d64c62011-07-19 14:50:41 -0500151''',
Eric Blake83a02702015-05-14 06:50:57 -0600152 name=c_name(name))
Paolo Bonzinid1953252012-07-17 16:17:04 +0200153
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200154 ret += generate_visit_struct_body(name)
Michael Roth06d64c62011-07-19 14:50:41 -0500155
156 ret += mcgen('''
Michael Roth06d64c62011-07-19 14:50:41 -0500157}
158''')
159 return ret
160
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200161def generate_visit_list(name):
Michael Roth06d64c62011-07-19 14:50:41 -0500162 return mcgen('''
163
Amos Kong638ca8a2014-06-10 19:25:51 +0800164void visit_type_%(name)sList(Visitor *m, %(name)sList **obj, const char *name, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500165{
Paolo Bonzinid1953252012-07-17 16:17:04 +0200166 Error *err = NULL;
Markus Armbruster297a3642014-05-07 09:53:54 +0200167 GenericList *i, **prev;
Michael Roth06d64c62011-07-19 14:50:41 -0500168
Markus Armbruster297a3642014-05-07 09:53:54 +0200169 visit_start_list(m, name, &err);
170 if (err) {
171 goto out;
Paolo Bonzinib6f04742012-03-22 12:51:06 +0100172 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200173
174 for (prev = (GenericList **)obj;
175 !err && (i = visit_next_list(m, prev, &err)) != NULL;
176 prev = &i) {
177 %(name)sList *native_i = (%(name)sList *)i;
178 visit_type_%(name)s(m, &native_i->value, NULL, &err);
179 }
180
181 error_propagate(errp, err);
182 err = NULL;
183 visit_end_list(m, &err);
184out:
185 error_propagate(errp, err);
Michael Roth06d64c62011-07-19 14:50:41 -0500186}
187''',
Eric Blakefce384b2015-05-14 06:50:56 -0600188 name=type_name(name))
Michael Roth06d64c62011-07-19 14:50:41 -0500189
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200190def generate_visit_enum(name):
Michael Roth06d64c62011-07-19 14:50:41 -0500191 return mcgen('''
192
Markus Armbruster40b3ade2015-06-26 17:21:42 +0200193void visit_type_%(c_name)s(Visitor *m, %(c_name)s *obj, const char *name, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500194{
Markus Armbruster40b3ade2015-06-26 17:21:42 +0200195 visit_type_enum(m, (int *)obj, %(c_name)s_lookup, "%(name)s", name, errp);
Michael Roth06d64c62011-07-19 14:50:41 -0500196}
197''',
Markus Armbruster40b3ade2015-06-26 17:21:42 +0200198 c_name=c_name(name), name=name)
Michael Roth06d64c62011-07-19 14:50:41 -0500199
Eric Blake811d04f2015-05-04 09:05:10 -0600200def generate_visit_alternate(name, members):
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200201 ret = mcgen('''
202
Amos Kong638ca8a2014-06-10 19:25:51 +0800203void visit_type_%(name)s(Visitor *m, %(name)s **obj, const char *name, Error **errp)
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200204{
205 Error *err = NULL;
206
Markus Armbruster297a3642014-05-07 09:53:54 +0200207 visit_start_implicit_struct(m, (void**) obj, sizeof(%(name)s), &err);
208 if (err) {
209 goto out;
210 }
211 visit_get_next_type(m, (int*) &(*obj)->kind, %(name)s_qtypes, name, &err);
212 if (err) {
213 goto out_end;
214 }
215 switch ((*obj)->kind) {
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200216''',
Eric Blaked1f07c82015-05-14 06:51:00 -0600217 name=c_name(name))
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200218
Eric Blakeab916fa2015-05-04 09:05:13 -0600219 # For alternate, always use the default enum type automatically generated
Eric Blaked1f07c82015-05-14 06:51:00 -0600220 # as name + 'Kind'
221 disc_type = c_name(name) + 'Kind'
Wenchao Xiab0b58192014-03-04 18:44:36 -0800222
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200223 for key in members:
Eric Blakeb52c4b92015-05-04 09:05:00 -0600224 assert (members[key] in builtin_types.keys()
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200225 or find_struct(members[key])
Max Reitze775ba72014-08-20 19:59:34 +0200226 or find_union(members[key])
Eric Blakeab916fa2015-05-04 09:05:13 -0600227 or find_enum(members[key])), "Invalid alternate member"
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200228
Markus Armbruster7c81c612015-05-14 06:50:50 -0600229 enum_full_value = c_enum_const(disc_type, key)
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200230 ret += mcgen('''
Markus Armbruster297a3642014-05-07 09:53:54 +0200231 case %(enum_full_value)s:
232 visit_type_%(c_type)s(m, &(*obj)->%(c_name)s, name, &err);
233 break;
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200234''',
Wenchao Xiab0b58192014-03-04 18:44:36 -0800235 enum_full_value = enum_full_value,
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200236 c_type = type_name(members[key]),
Eric Blake18df5152015-05-14 06:50:48 -0600237 c_name = c_name(key))
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200238
239 ret += mcgen('''
Markus Armbruster297a3642014-05-07 09:53:54 +0200240 default:
241 abort();
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200242 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200243out_end:
244 error_propagate(errp, err);
245 err = NULL;
246 visit_end_implicit_struct(m, &err);
247out:
248 error_propagate(errp, err);
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200249}
250''')
251
252 return ret
253
254
Kevin Wolf0aef92b2013-07-02 16:20:04 +0200255def generate_visit_union(expr):
256
257 name = expr['union']
258 members = expr['data']
259
260 base = expr.get('base')
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200261 discriminator = expr.get('discriminator')
Kevin Wolf0aef92b2013-07-02 16:20:04 +0200262
Wenchao Xiabceae762014-03-06 17:08:56 -0800263 enum_define = discriminator_find_enum_define(expr)
264 if enum_define:
265 # Use the enum type as discriminator
266 ret = ""
Eric Blake857af5f2015-05-14 06:50:59 -0600267 disc_type = c_name(enum_define['enum_name'])
Wenchao Xiabceae762014-03-06 17:08:56 -0800268 else:
Eric Blakea8d4a2e2015-05-04 09:05:07 -0600269 # There will always be a discriminator in the C switch code, by default
Eric Blakebb337292015-05-14 06:50:58 -0600270 # it is an enum type generated silently
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200271 ret = generate_visit_enum(name + 'Kind')
Eric Blakebb337292015-05-14 06:50:58 -0600272 disc_type = c_name(name) + 'Kind'
Michael Roth06d64c62011-07-19 14:50:41 -0500273
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200274 if base:
Eric Blakea8d4a2e2015-05-04 09:05:07 -0600275 assert discriminator
276 base_fields = find_struct(base)['data'].copy()
277 del base_fields[discriminator]
Eric Blakea82b9822015-05-04 09:05:34 -0600278 ret += generate_visit_struct_fields(name, base_fields)
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200279
Markus Armbrusterbe3c7712014-05-07 09:53:50 +0200280 if discriminator:
281 for key in members:
282 ret += generate_visit_implicit_struct(members[key])
283
Michael Roth06d64c62011-07-19 14:50:41 -0500284 ret += mcgen('''
285
Markus Armbruster40b3ade2015-06-26 17:21:42 +0200286void visit_type_%(c_name)s(Visitor *m, %(c_name)s **obj, const char *name, Error **errp)
Michael Roth06d64c62011-07-19 14:50:41 -0500287{
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100288 Error *err = NULL;
289
Markus Armbruster40b3ade2015-06-26 17:21:42 +0200290 visit_start_struct(m, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200291 if (err) {
292 goto out;
293 }
294 if (*obj) {
Michael Roth06d64c62011-07-19 14:50:41 -0500295''',
Markus Armbruster40b3ade2015-06-26 17:21:42 +0200296 c_name=c_name(name), name=name)
Michael Roth06d64c62011-07-19 14:50:41 -0500297
Kevin Wolf0aef92b2013-07-02 16:20:04 +0200298 if base:
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200299 ret += mcgen('''
Markus Armbruster468866b2014-05-07 09:53:47 +0200300 visit_type_%(name)s_fields(m, obj, &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200301 if (err) {
302 goto out_obj;
303 }
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200304''',
Eric Blake857af5f2015-05-14 06:50:59 -0600305 name=c_name(name))
Kevin Wolf0aef92b2013-07-02 16:20:04 +0200306
Richard Henderson7b75d9d2013-10-31 13:26:01 -0700307 if not discriminator:
Markus Armbruster0f61af32015-07-31 10:30:04 +0200308 tag = 'kind'
Wenchao Xiabceae762014-03-06 17:08:56 -0800309 disc_key = "type"
Richard Henderson7b75d9d2013-10-31 13:26:01 -0700310 else:
Markus Armbruster0f61af32015-07-31 10:30:04 +0200311 tag = discriminator
Wenchao Xiabceae762014-03-06 17:08:56 -0800312 disc_key = discriminator
Kevin Wolf0aef92b2013-07-02 16:20:04 +0200313 ret += mcgen('''
Markus Armbruster0f61af32015-07-31 10:30:04 +0200314 visit_type_%(disc_type)s(m, &(*obj)->%(c_tag)s, "%(disc_key)s", &err);
Markus Armbruster297a3642014-05-07 09:53:54 +0200315 if (err) {
316 goto out_obj;
317 }
Michael Rothcee2ded2014-09-18 15:36:40 -0500318 if (!visit_start_union(m, !!(*obj)->data, &err) || err) {
319 goto out_obj;
320 }
Markus Armbruster0f61af32015-07-31 10:30:04 +0200321 switch ((*obj)->%(c_tag)s) {
Kevin Wolf0aef92b2013-07-02 16:20:04 +0200322''',
Wenchao Xiabceae762014-03-06 17:08:56 -0800323 disc_type = disc_type,
Markus Armbruster0f61af32015-07-31 10:30:04 +0200324 c_tag=c_name(tag),
Wenchao Xiabceae762014-03-06 17:08:56 -0800325 disc_key = disc_key)
Kevin Wolf0aef92b2013-07-02 16:20:04 +0200326
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100327 for key in members:
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200328 if not discriminator:
329 fmt = 'visit_type_%(c_type)s(m, &(*obj)->%(c_name)s, "data", &err);'
330 else:
Markus Armbrusterbe3c7712014-05-07 09:53:50 +0200331 fmt = 'visit_type_implicit_%(c_type)s(m, &(*obj)->%(c_name)s, &err);'
Kevin Wolf50f2bdc2013-07-03 15:58:57 +0200332
Markus Armbruster7c81c612015-05-14 06:50:50 -0600333 enum_full_value = c_enum_const(disc_type, key)
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100334 ret += mcgen('''
Markus Armbruster297a3642014-05-07 09:53:54 +0200335 case %(enum_full_value)s:
336 ''' + fmt + '''
337 break;
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100338''',
Wenchao Xiab0b58192014-03-04 18:44:36 -0800339 enum_full_value = enum_full_value,
Michael Rothc664aef2013-05-10 17:46:01 -0500340 c_type=type_name(members[key]),
Eric Blake18df5152015-05-14 06:50:48 -0600341 c_name=c_name(key))
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100342
343 ret += mcgen('''
Markus Armbruster297a3642014-05-07 09:53:54 +0200344 default:
345 abort();
Paolo Bonzinid1953252012-07-17 16:17:04 +0200346 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200347out_obj:
Paolo Bonzinid1953252012-07-17 16:17:04 +0200348 error_propagate(errp, err);
349 err = NULL;
Michael Rothcee2ded2014-09-18 15:36:40 -0500350 visit_end_union(m, !!(*obj)->data, &err);
351 error_propagate(errp, err);
352 err = NULL;
Markus Armbruster468866b2014-05-07 09:53:47 +0200353 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200354 visit_end_struct(m, &err);
355out:
356 error_propagate(errp, err);
Paolo Bonzinidc8fb6d2012-03-06 18:55:56 +0100357}
358''')
359
Michael Roth06d64c62011-07-19 14:50:41 -0500360 return ret
361
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200362def generate_declaration(name, builtin_type=False):
Michael Roth7c946bc2013-05-10 17:46:02 -0500363 ret = ""
364 if not builtin_type:
Eric Blake83a02702015-05-14 06:50:57 -0600365 name = c_name(name)
Michael Roth7c946bc2013-05-10 17:46:02 -0500366 ret += mcgen('''
Michael Roth06d64c62011-07-19 14:50:41 -0500367
Amos Kong638ca8a2014-06-10 19:25:51 +0800368void visit_type_%(name)s(Visitor *m, %(name)s **obj, const char *name, Error **errp);
Michael Roth06d64c62011-07-19 14:50:41 -0500369''',
Eric Blake6540e9f2015-04-10 15:07:59 -0600370 name=name)
Michael Roth06d64c62011-07-19 14:50:41 -0500371
Eric Blake6540e9f2015-04-10 15:07:59 -0600372 ret += mcgen('''
Amos Kong638ca8a2014-06-10 19:25:51 +0800373void visit_type_%(name)sList(Visitor *m, %(name)sList **obj, const char *name, Error **errp);
Michael Roth06d64c62011-07-19 14:50:41 -0500374''',
375 name=name)
376
377 return ret
378
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200379def generate_enum_declaration(name):
Eric Blake6540e9f2015-04-10 15:07:59 -0600380 ret = mcgen('''
Amos Kong638ca8a2014-06-10 19:25:51 +0800381void visit_type_%(name)sList(Visitor *m, %(name)sList **obj, const char *name, Error **errp);
Amos Kongb9c4b482012-08-31 10:56:23 +0800382''',
Eric Blakefce384b2015-05-14 06:50:56 -0600383 name=c_name(name))
Amos Kongb9c4b482012-08-31 10:56:23 +0800384
385 return ret
386
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200387def generate_decl_enum(name):
Michael Roth06d64c62011-07-19 14:50:41 -0500388 return mcgen('''
389
Amos Kong638ca8a2014-06-10 19:25:51 +0800390void visit_type_%(name)s(Visitor *m, %(name)s *obj, const char *name, Error **errp);
Michael Roth06d64c62011-07-19 14:50:41 -0500391''',
Eric Blakefce384b2015-05-14 06:50:56 -0600392 name=c_name(name))
Michael Roth06d64c62011-07-19 14:50:41 -0500393
Michael Roth7c946bc2013-05-10 17:46:02 -0500394do_builtins = False
Avi Kivity8d3bc512011-12-27 16:02:16 +0200395
Markus Armbruster2114f5a2015-04-02 13:12:21 +0200396(input_file, output_dir, do_c, do_h, prefix, opts) = \
397 parse_command_line("b", ["builtins"])
Avi Kivity8d3bc512011-12-27 16:02:16 +0200398
Markus Armbruster2114f5a2015-04-02 13:12:21 +0200399for o, a in opts:
400 if o in ("-b", "--builtins"):
401 do_builtins = True
Michael Roth06d64c62011-07-19 14:50:41 -0500402
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200403c_comment = '''
404/*
405 * schema-defined QAPI visitor functions
406 *
407 * Copyright IBM, Corp. 2011
408 *
409 * Authors:
410 * Anthony Liguori <aliguori@us.ibm.com>
411 *
412 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
413 * See the COPYING.LIB file in the top-level directory.
414 *
415 */
416'''
417h_comment = '''
418/*
419 * schema-defined QAPI visitor functions
420 *
421 * Copyright IBM, Corp. 2011
422 *
423 * Authors:
424 * Anthony Liguori <aliguori@us.ibm.com>
425 *
426 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
427 * See the COPYING.LIB file in the top-level directory.
428 *
429 */
430'''
Michael Roth06d64c62011-07-19 14:50:41 -0500431
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200432(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
433 'qapi-visit.c', 'qapi-visit.h',
434 c_comment, h_comment)
Michael Roth06d64c62011-07-19 14:50:41 -0500435
436fdef.write(mcgen('''
Paolo Bonzini79ee7df2012-12-06 11:22:34 +0100437#include "qemu-common.h"
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200438#include "%(prefix)sqapi-visit.h"
Michael Roth06d64c62011-07-19 14:50:41 -0500439''',
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200440 prefix = prefix))
Michael Roth06d64c62011-07-19 14:50:41 -0500441
442fdecl.write(mcgen('''
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +0100443#include "qapi/visitor.h"
Michael Roth06d64c62011-07-19 14:50:41 -0500444#include "%(prefix)sqapi-types.h"
Michael Roth7c946bc2013-05-10 17:46:02 -0500445
Michael Roth06d64c62011-07-19 14:50:41 -0500446''',
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200447 prefix=prefix))
Michael Roth06d64c62011-07-19 14:50:41 -0500448
LluĂ­s Vilanova33aaad52014-05-02 15:52:35 +0200449exprs = parse_schema(input_file)
Michael Roth06d64c62011-07-19 14:50:41 -0500450
Michael Roth7c946bc2013-05-10 17:46:02 -0500451# to avoid header dependency hell, we always generate declarations
452# for built-in types in our header files and simply guard them
453fdecl.write(guardstart("QAPI_VISIT_BUILTIN_VISITOR_DECL"))
Eric Blakeb52c4b92015-05-04 09:05:00 -0600454for typename in builtin_types.keys():
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200455 fdecl.write(generate_declaration(typename, builtin_type=True))
Michael Roth7c946bc2013-05-10 17:46:02 -0500456fdecl.write(guardend("QAPI_VISIT_BUILTIN_VISITOR_DECL"))
457
458# ...this doesn't work for cases where we link in multiple objects that
459# have the functions defined, so we use -b option to provide control
460# over these cases
461if do_builtins:
Eric Blakeb52c4b92015-05-04 09:05:00 -0600462 for typename in builtin_types.keys():
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200463 fdef.write(generate_visit_list(typename))
Michael Roth7c946bc2013-05-10 17:46:02 -0500464
Michael Roth06d64c62011-07-19 14:50:41 -0500465for expr in exprs:
Eric Blakefd41dd42015-05-04 09:05:25 -0600466 if expr.has_key('struct'):
Kevin Wolf14d36302013-09-18 17:22:02 +0200467 ret = generate_visit_struct(expr)
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200468 ret += generate_visit_list(expr['struct'])
Michael Roth06d64c62011-07-19 14:50:41 -0500469 fdef.write(ret)
470
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200471 ret = generate_declaration(expr['struct'])
Michael Roth06d64c62011-07-19 14:50:41 -0500472 fdecl.write(ret)
473 elif expr.has_key('union'):
Kevin Wolf0aef92b2013-07-02 16:20:04 +0200474 ret = generate_visit_union(expr)
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200475 ret += generate_visit_list(expr['union'])
Michael Roth06d64c62011-07-19 14:50:41 -0500476 fdef.write(ret)
477
Wenchao Xiabceae762014-03-06 17:08:56 -0800478 enum_define = discriminator_find_enum_define(expr)
479 ret = ""
480 if not enum_define:
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200481 ret = generate_decl_enum('%sKind' % expr['union'])
482 ret += generate_declaration(expr['union'])
Michael Roth06d64c62011-07-19 14:50:41 -0500483 fdecl.write(ret)
Eric Blakeab916fa2015-05-04 09:05:13 -0600484 elif expr.has_key('alternate'):
485 ret = generate_visit_alternate(expr['alternate'], expr['data'])
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200486 ret += generate_visit_list(expr['alternate'])
Eric Blakeab916fa2015-05-04 09:05:13 -0600487 fdef.write(ret)
488
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200489 ret = generate_decl_enum('%sKind' % expr['alternate'])
490 ret += generate_declaration(expr['alternate'])
Eric Blakeab916fa2015-05-04 09:05:13 -0600491 fdecl.write(ret)
Michael Roth06d64c62011-07-19 14:50:41 -0500492 elif expr.has_key('enum'):
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200493 ret = generate_visit_list(expr['enum'])
494 ret += generate_visit_enum(expr['enum'])
Michael Roth06d64c62011-07-19 14:50:41 -0500495 fdef.write(ret)
496
Markus Armbruster5aa05d32015-06-28 21:36:26 +0200497 ret = generate_decl_enum(expr['enum'])
498 ret += generate_enum_declaration(expr['enum'])
Michael Roth06d64c62011-07-19 14:50:41 -0500499 fdecl.write(ret)
500
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200501close_output(fdef, fdecl)