]>
Commit | Line | Data |
---|---|---|
5ddeec83 MA |
1 | """ |
2 | QAPI visitor generator | |
3 | ||
4 | Copyright IBM, Corp. 2011 | |
5 | Copyright (C) 2014-2018 Red Hat, Inc. | |
6 | ||
7 | Authors: | |
8 | Anthony Liguori <aliguori@us.ibm.com> | |
9 | Michael Roth <mdroth@linux.vnet.ibm.com> | |
10 | Markus Armbruster <armbru@redhat.com> | |
11 | ||
12 | This work is licensed under the terms of the GNU GPL, version 2. | |
13 | See the COPYING file in the top-level directory. | |
14 | """ | |
06d64c62 | 15 | |
fb0bc835 | 16 | from qapi.common import * |
06d64c62 | 17 | |
e98859a9 | 18 | |
60f8546a MA |
19 | def gen_visit_decl(name, scalar=False): |
20 | c_type = c_name(name) + ' *' | |
21 | if not scalar: | |
22 | c_type += '*' | |
23 | return mcgen(''' | |
51e72bc1 | 24 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp); |
60f8546a MA |
25 | ''', |
26 | c_name=c_name(name), c_type=c_type) | |
27 | ||
28 | ||
4d91e911 | 29 | def gen_visit_members_decl(name): |
2208d649 | 30 | return mcgen(''' |
8c3f8e77 | 31 | |
4d91e911 | 32 | void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp); |
8c3f8e77 | 33 | ''', |
4d91e911 | 34 | c_name=c_name(name)) |
d02cf377 EB |
35 | |
36 | ||
14f00c6c | 37 | def gen_visit_object_members(name, base, members, variants): |
4d91e911 | 38 | ret = mcgen(''' |
50f2bdc7 | 39 | |
4d91e911 | 40 | void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp) |
50f2bdc7 KW |
41 | { |
42 | Error *err = NULL; | |
3a864e7c | 43 | |
50f2bdc7 | 44 | ''', |
4d91e911 | 45 | c_name=c_name(name)) |
d195325b | 46 | |
622f557f KW |
47 | if base: |
48 | ret += mcgen(''' | |
c81200b0 | 49 | visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, &err); |
fa274ed6 EB |
50 | if (err) { |
51 | goto out; | |
52 | } | |
622f557f | 53 | ''', |
ddf21908 | 54 | c_type=base.c_name()) |
622f557f | 55 | |
12f254fd | 56 | for memb in members: |
8ee06f61 | 57 | ret += gen_if(memb.ifcond) |
12f254fd EB |
58 | if memb.optional: |
59 | ret += mcgen(''' | |
60 | if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) { | |
61 | ''', | |
62 | name=memb.name, c_name=c_name(memb.name)) | |
63 | push_indent() | |
64 | ret += mcgen(''' | |
65 | visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err); | |
fa274ed6 EB |
66 | if (err) { |
67 | goto out; | |
68 | } | |
12f254fd EB |
69 | ''', |
70 | c_type=memb.type.c_name(), name=memb.name, | |
71 | c_name=c_name(memb.name)) | |
12f254fd EB |
72 | if memb.optional: |
73 | pop_indent() | |
74 | ret += mcgen(''' | |
75 | } | |
76 | ''') | |
8ee06f61 | 77 | ret += gen_endif(memb.ifcond) |
d195325b | 78 | |
9a5cd424 EB |
79 | if variants: |
80 | ret += mcgen(''' | |
65551903 | 81 | switch (obj->%(c_name)s) { |
9a5cd424 EB |
82 | ''', |
83 | c_name=c_name(variants.tag_member.name)) | |
84 | ||
85 | for var in variants.variants: | |
800877bb AN |
86 | case_str = c_enum_const(variants.tag_member.type.name, |
87 | var.name, | |
88 | variants.tag_member.type.prefix) | |
8ee06f61 | 89 | ret += gen_if(var.ifcond) |
800877bb AN |
90 | if var.type.name == 'q_empty': |
91 | # valid variant and nothing to do | |
92 | ret += mcgen(''' | |
93 | case %(case)s: | |
94 | break; | |
95 | ''', | |
96 | case=case_str) | |
97 | else: | |
98 | ret += mcgen(''' | |
9a5cd424 | 99 | case %(case)s: |
32bafa8f EB |
100 | visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err); |
101 | break; | |
9a5cd424 | 102 | ''', |
800877bb AN |
103 | case=case_str, |
104 | c_type=var.type.c_name(), c_name=c_name(var.name)) | |
9a5cd424 | 105 | |
8ee06f61 | 106 | ret += gen_endif(var.ifcond) |
9a5cd424 EB |
107 | ret += mcgen(''' |
108 | default: | |
109 | abort(); | |
110 | } | |
111 | ''') | |
112 | ||
12f254fd EB |
113 | # 'goto out' produced for base, for each member, and if variants were |
114 | # present | |
9a5cd424 | 115 | if base or members or variants: |
297a3646 | 116 | ret += mcgen(''' |
50f2bdc7 | 117 | |
297a3646 MA |
118 | out: |
119 | ''') | |
120 | ret += mcgen(''' | |
50f2bdc7 KW |
121 | error_propagate(errp, err); |
122 | } | |
123 | ''') | |
d131c897 KW |
124 | return ret |
125 | ||
126 | ||
441cbac0 | 127 | def gen_visit_list(name, element_type): |
06d64c62 MR |
128 | return mcgen(''' |
129 | ||
51e72bc1 | 130 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 131 | { |
d195325b | 132 | Error *err = NULL; |
d9f62dde EB |
133 | %(c_name)s *tail; |
134 | size_t size = sizeof(**obj); | |
06d64c62 | 135 | |
d9f62dde | 136 | visit_start_list(v, name, (GenericList **)obj, size, &err); |
297a3646 MA |
137 | if (err) { |
138 | goto out; | |
139 | } | |
140 | ||
d9f62dde EB |
141 | for (tail = *obj; tail; |
142 | tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) { | |
143 | visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err); | |
144 | if (err) { | |
145 | break; | |
146 | } | |
06d64c62 | 147 | } |
297a3646 | 148 | |
a4a1c70d MA |
149 | if (!err) { |
150 | visit_check_list(v, &err); | |
151 | } | |
1158bb2a | 152 | visit_end_list(v, (void **)obj); |
68ab47e4 EB |
153 | if (err && visit_is_input(v)) { |
154 | qapi_free_%(c_name)s(*obj); | |
155 | *obj = NULL; | |
156 | } | |
297a3646 MA |
157 | out: |
158 | error_propagate(errp, err); | |
06d64c62 MR |
159 | } |
160 | ''', | |
e98859a9 | 161 | c_name=c_name(name), c_elt_type=element_type.c_name()) |
06d64c62 | 162 | |
e98859a9 MA |
163 | |
164 | def gen_visit_enum(name): | |
06d64c62 MR |
165 | return mcgen(''' |
166 | ||
51e72bc1 | 167 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp) |
06d64c62 | 168 | { |
395a233f | 169 | int value = *obj; |
f7abe0ec | 170 | visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp); |
395a233f | 171 | *obj = value; |
06d64c62 MR |
172 | } |
173 | ''', | |
337283df | 174 | c_name=c_name(name)) |
06d64c62 | 175 | |
e98859a9 | 176 | |
441cbac0 | 177 | def gen_visit_alternate(name, variants): |
60390d2d | 178 | ret = mcgen(''' |
69dd62df | 179 | |
51e72bc1 | 180 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
69dd62df KW |
181 | { |
182 | Error *err = NULL; | |
183 | ||
dbf11922 | 184 | visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj), |
60390d2d | 185 | &err); |
297a3646 MA |
186 | if (err) { |
187 | goto out; | |
188 | } | |
9b4e38fe EB |
189 | if (!*obj) { |
190 | goto out_obj; | |
191 | } | |
150d0564 | 192 | switch ((*obj)->type) { |
69dd62df | 193 | ''', |
b736e25a | 194 | c_name=c_name(name)) |
69dd62df | 195 | |
441cbac0 | 196 | for var in variants.variants: |
8ee06f61 | 197 | ret += gen_if(var.ifcond) |
69dd62df | 198 | ret += mcgen(''' |
e98859a9 | 199 | case %(case)s: |
becceedc EB |
200 | ''', |
201 | case=var.type.alternate_qtype()) | |
202 | if isinstance(var.type, QAPISchemaObjectType): | |
203 | ret += mcgen(''' | |
204 | visit_start_struct(v, name, NULL, 0, &err); | |
205 | if (err) { | |
206 | break; | |
207 | } | |
c81200b0 | 208 | visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err); |
15c2f669 EB |
209 | if (!err) { |
210 | visit_check_struct(v, &err); | |
211 | } | |
1158bb2a | 212 | visit_end_struct(v, NULL); |
becceedc EB |
213 | ''', |
214 | c_type=var.type.c_name(), | |
215 | c_name=c_name(var.name)) | |
216 | else: | |
217 | ret += mcgen(''' | |
51e72bc1 | 218 | visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err); |
69dd62df | 219 | ''', |
becceedc EB |
220 | c_type=var.type.c_name(), |
221 | c_name=c_name(var.name)) | |
222 | ret += mcgen(''' | |
223 | break; | |
224 | ''') | |
8ee06f61 | 225 | ret += gen_endif(var.ifcond) |
69dd62df KW |
226 | |
227 | ret += mcgen(''' | |
9b4e38fe EB |
228 | case QTYPE_NONE: |
229 | abort(); | |
297a3646 | 230 | default: |
0426d53c EB |
231 | error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null", |
232 | "%(name)s"); | |
69dd62df | 233 | } |
9b4e38fe | 234 | out_obj: |
1158bb2a | 235 | visit_end_alternate(v, (void **)obj); |
68ab47e4 EB |
236 | if (err && visit_is_input(v)) { |
237 | qapi_free_%(c_name)s(*obj); | |
238 | *obj = NULL; | |
239 | } | |
297a3646 MA |
240 | out: |
241 | error_propagate(errp, err); | |
69dd62df | 242 | } |
0426d53c | 243 | ''', |
68ab47e4 | 244 | name=name, c_name=c_name(name)) |
69dd62df KW |
245 | |
246 | return ret | |
247 | ||
e98859a9 | 248 | |
59d9e84c | 249 | def gen_visit_object(name, base, members, variants): |
7ce106a9 | 250 | return mcgen(''' |
06d64c62 | 251 | |
51e72bc1 | 252 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 253 | { |
dc8fb6df PB |
254 | Error *err = NULL; |
255 | ||
337283df | 256 | visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err); |
297a3646 MA |
257 | if (err) { |
258 | goto out; | |
259 | } | |
e36c714e EB |
260 | if (!*obj) { |
261 | goto out_obj; | |
262 | } | |
c81200b0 | 263 | visit_type_%(c_name)s_members(v, *obj, &err); |
15c2f669 EB |
264 | if (err) { |
265 | goto out_obj; | |
266 | } | |
267 | visit_check_struct(v, &err); | |
9a5cd424 | 268 | out_obj: |
1158bb2a | 269 | visit_end_struct(v, (void **)obj); |
68ab47e4 EB |
270 | if (err && visit_is_input(v)) { |
271 | qapi_free_%(c_name)s(*obj); | |
272 | *obj = NULL; | |
273 | } | |
297a3646 MA |
274 | out: |
275 | error_propagate(errp, err); | |
dc8fb6df | 276 | } |
9a5cd424 EB |
277 | ''', |
278 | c_name=c_name(name)) | |
dc8fb6df | 279 | |
e98859a9 | 280 | |
cdb6610a | 281 | class QAPISchemaGenVisitVisitor(QAPISchemaModularCVisitor): |
71b3f045 | 282 | |
cdb6610a MA |
283 | def __init__(self, prefix): |
284 | QAPISchemaModularCVisitor.__init__( | |
71b3f045 MA |
285 | self, prefix, 'qapi-visit', ' * Schema-defined QAPI visitors', |
286 | __doc__) | |
c2e196a9 | 287 | self._add_system_module(None, ' * Built-in QAPI visitors') |
cdb6610a MA |
288 | self._genc.preamble_add(mcgen(''' |
289 | #include "qemu/osdep.h" | |
cdb6610a | 290 | #include "qapi/error.h" |
eb815e24 | 291 | #include "qapi/qapi-builtin-visit.h" |
cdb6610a MA |
292 | ''')) |
293 | self._genh.preamble_add(mcgen(''' | |
294 | #include "qapi/visitor.h" | |
eb815e24 | 295 | #include "qapi/qapi-builtin-types.h" |
cdb6610a MA |
296 | |
297 | ''', | |
298 | prefix=prefix)) | |
299 | ||
dcac6471 | 300 | def _begin_user_module(self, name): |
9af23989 MA |
301 | types = self._module_basename('qapi-types', name) |
302 | visit = self._module_basename('qapi-visit', name) | |
71b3f045 MA |
303 | self._genc.preamble_add(mcgen(''' |
304 | #include "qemu/osdep.h" | |
71b3f045 MA |
305 | #include "qapi/error.h" |
306 | #include "qapi/qmp/qerror.h" | |
9af23989 | 307 | #include "%(visit)s.h" |
71b3f045 | 308 | ''', |
a48e7542 | 309 | visit=visit)) |
71b3f045 | 310 | self._genh.preamble_add(mcgen(''' |
eb815e24 | 311 | #include "qapi/qapi-builtin-visit.h" |
9af23989 | 312 | #include "%(types)s.h" |
441cbac0 | 313 | |
71b3f045 | 314 | ''', |
9af23989 | 315 | types=types)) |
441cbac0 | 316 | |
1962bd39 | 317 | def visit_enum_type(self, name, info, ifcond, members, prefix): |
9f88c662 MA |
318 | with ifcontext(ifcond, self._genh, self._genc): |
319 | self._genh.add(gen_visit_decl(name, scalar=True)) | |
320 | self._genc.add(gen_visit_enum(name)) | |
441cbac0 | 321 | |
fbf09a2f | 322 | def visit_array_type(self, name, info, ifcond, element_type): |
9f88c662 MA |
323 | with ifcontext(ifcond, self._genh, self._genc): |
324 | self._genh.add(gen_visit_decl(name)) | |
325 | self._genc.add(gen_visit_list(name, element_type)) | |
441cbac0 | 326 | |
fbf09a2f | 327 | def visit_object_type(self, name, info, ifcond, base, members, variants): |
7ce106a9 EB |
328 | # Nothing to do for the special empty builtin |
329 | if name == 'q_empty': | |
330 | return | |
9f88c662 MA |
331 | with ifcontext(ifcond, self._genh, self._genc): |
332 | self._genh.add(gen_visit_members_decl(name)) | |
333 | self._genc.add(gen_visit_object_members(name, base, | |
334 | members, variants)) | |
335 | # TODO Worth changing the visitor signature, so we could | |
336 | # directly use rather than repeat type.is_implicit()? | |
337 | if not name.startswith('q_'): | |
338 | # only explicit types need an allocating visit | |
339 | self._genh.add(gen_visit_decl(name)) | |
340 | self._genc.add(gen_visit_object(name, base, members, variants)) | |
441cbac0 | 341 | |
fbf09a2f | 342 | def visit_alternate_type(self, name, info, ifcond, variants): |
9f88c662 MA |
343 | with ifcontext(ifcond, self._genh, self._genc): |
344 | self._genh.add(gen_visit_decl(name)) | |
345 | self._genc.add(gen_visit_alternate(name, variants)) | |
441cbac0 | 346 | |
8d3bc517 | 347 | |
fb0bc835 | 348 | def gen_visit(schema, output_dir, prefix, opt_builtins): |
cdb6610a | 349 | vis = QAPISchemaGenVisitVisitor(prefix) |
26df4e7f | 350 | schema.visit(vis) |
cdb6610a | 351 | vis.write(output_dir, opt_builtins) |