]>
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 EB |
56 | 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); | |
fa274ed6 EB |
65 | if (err) { |
66 | goto out; | |
67 | } | |
12f254fd EB |
68 | ''', |
69 | c_type=memb.type.c_name(), name=memb.name, | |
70 | c_name=c_name(memb.name)) | |
12f254fd EB |
71 | if memb.optional: |
72 | pop_indent() | |
73 | ret += mcgen(''' | |
74 | } | |
75 | ''') | |
d195325b | 76 | |
9a5cd424 EB |
77 | if variants: |
78 | ret += mcgen(''' | |
65551903 | 79 | switch (obj->%(c_name)s) { |
9a5cd424 EB |
80 | ''', |
81 | c_name=c_name(variants.tag_member.name)) | |
82 | ||
83 | for var in variants.variants: | |
9a5cd424 EB |
84 | ret += mcgen(''' |
85 | case %(case)s: | |
32bafa8f EB |
86 | visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err); |
87 | break; | |
9a5cd424 EB |
88 | ''', |
89 | case=c_enum_const(variants.tag_member.type.name, | |
90 | var.name, | |
32bafa8f EB |
91 | variants.tag_member.type.prefix), |
92 | c_type=var.type.c_name(), c_name=c_name(var.name)) | |
9a5cd424 EB |
93 | |
94 | ret += mcgen(''' | |
95 | default: | |
96 | abort(); | |
97 | } | |
98 | ''') | |
99 | ||
12f254fd EB |
100 | # 'goto out' produced for base, for each member, and if variants were |
101 | # present | |
9a5cd424 | 102 | if base or members or variants: |
297a3646 | 103 | ret += mcgen(''' |
50f2bdc7 | 104 | |
297a3646 MA |
105 | out: |
106 | ''') | |
107 | ret += mcgen(''' | |
50f2bdc7 KW |
108 | error_propagate(errp, err); |
109 | } | |
110 | ''') | |
d131c897 KW |
111 | return ret |
112 | ||
113 | ||
441cbac0 | 114 | def gen_visit_list(name, element_type): |
06d64c62 MR |
115 | return mcgen(''' |
116 | ||
51e72bc1 | 117 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 118 | { |
d195325b | 119 | Error *err = NULL; |
d9f62dde EB |
120 | %(c_name)s *tail; |
121 | size_t size = sizeof(**obj); | |
06d64c62 | 122 | |
d9f62dde | 123 | visit_start_list(v, name, (GenericList **)obj, size, &err); |
297a3646 MA |
124 | if (err) { |
125 | goto out; | |
126 | } | |
127 | ||
d9f62dde EB |
128 | 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 | } | |
06d64c62 | 134 | } |
297a3646 | 135 | |
a4a1c70d MA |
136 | if (!err) { |
137 | visit_check_list(v, &err); | |
138 | } | |
1158bb2a | 139 | visit_end_list(v, (void **)obj); |
68ab47e4 EB |
140 | if (err && visit_is_input(v)) { |
141 | qapi_free_%(c_name)s(*obj); | |
142 | *obj = NULL; | |
143 | } | |
297a3646 MA |
144 | out: |
145 | error_propagate(errp, err); | |
06d64c62 MR |
146 | } |
147 | ''', | |
e98859a9 | 148 | c_name=c_name(name), c_elt_type=element_type.c_name()) |
06d64c62 | 149 | |
e98859a9 MA |
150 | |
151 | def gen_visit_enum(name): | |
06d64c62 MR |
152 | return mcgen(''' |
153 | ||
51e72bc1 | 154 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp) |
06d64c62 | 155 | { |
395a233f | 156 | int value = *obj; |
f7abe0ec | 157 | visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp); |
395a233f | 158 | *obj = value; |
06d64c62 MR |
159 | } |
160 | ''', | |
337283df | 161 | c_name=c_name(name)) |
06d64c62 | 162 | |
e98859a9 | 163 | |
441cbac0 | 164 | def gen_visit_alternate(name, variants): |
60390d2d | 165 | ret = mcgen(''' |
69dd62df | 166 | |
51e72bc1 | 167 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
69dd62df KW |
168 | { |
169 | Error *err = NULL; | |
170 | ||
dbf11922 | 171 | visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj), |
60390d2d | 172 | &err); |
297a3646 MA |
173 | if (err) { |
174 | goto out; | |
175 | } | |
9b4e38fe EB |
176 | if (!*obj) { |
177 | goto out_obj; | |
178 | } | |
150d0564 | 179 | switch ((*obj)->type) { |
69dd62df | 180 | ''', |
60390d2d | 181 | c_name=c_name(name)) |
69dd62df | 182 | |
441cbac0 | 183 | for var in variants.variants: |
69dd62df | 184 | ret += mcgen(''' |
e98859a9 | 185 | case %(case)s: |
becceedc EB |
186 | ''', |
187 | case=var.type.alternate_qtype()) | |
188 | if isinstance(var.type, QAPISchemaObjectType): | |
189 | ret += mcgen(''' | |
190 | visit_start_struct(v, name, NULL, 0, &err); | |
191 | if (err) { | |
192 | break; | |
193 | } | |
c81200b0 | 194 | visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err); |
15c2f669 EB |
195 | if (!err) { |
196 | visit_check_struct(v, &err); | |
197 | } | |
1158bb2a | 198 | visit_end_struct(v, NULL); |
becceedc EB |
199 | ''', |
200 | c_type=var.type.c_name(), | |
201 | c_name=c_name(var.name)) | |
202 | else: | |
203 | ret += mcgen(''' | |
51e72bc1 | 204 | visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err); |
69dd62df | 205 | ''', |
becceedc EB |
206 | c_type=var.type.c_name(), |
207 | c_name=c_name(var.name)) | |
208 | ret += mcgen(''' | |
209 | break; | |
210 | ''') | |
69dd62df KW |
211 | |
212 | ret += mcgen(''' | |
9b4e38fe EB |
213 | case QTYPE_NONE: |
214 | abort(); | |
297a3646 | 215 | default: |
0426d53c EB |
216 | error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null", |
217 | "%(name)s"); | |
69dd62df | 218 | } |
9b4e38fe | 219 | out_obj: |
1158bb2a | 220 | visit_end_alternate(v, (void **)obj); |
68ab47e4 EB |
221 | if (err && visit_is_input(v)) { |
222 | qapi_free_%(c_name)s(*obj); | |
223 | *obj = NULL; | |
224 | } | |
297a3646 MA |
225 | out: |
226 | error_propagate(errp, err); | |
69dd62df | 227 | } |
0426d53c | 228 | ''', |
68ab47e4 | 229 | name=name, c_name=c_name(name)) |
69dd62df KW |
230 | |
231 | return ret | |
232 | ||
e98859a9 | 233 | |
59d9e84c | 234 | def gen_visit_object(name, base, members, variants): |
7ce106a9 | 235 | return mcgen(''' |
06d64c62 | 236 | |
51e72bc1 | 237 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 238 | { |
dc8fb6df PB |
239 | Error *err = NULL; |
240 | ||
337283df | 241 | visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err); |
297a3646 MA |
242 | if (err) { |
243 | goto out; | |
244 | } | |
e36c714e EB |
245 | if (!*obj) { |
246 | goto out_obj; | |
247 | } | |
c81200b0 | 248 | visit_type_%(c_name)s_members(v, *obj, &err); |
15c2f669 EB |
249 | if (err) { |
250 | goto out_obj; | |
251 | } | |
252 | visit_check_struct(v, &err); | |
9a5cd424 | 253 | out_obj: |
1158bb2a | 254 | visit_end_struct(v, (void **)obj); |
68ab47e4 EB |
255 | if (err && visit_is_input(v)) { |
256 | qapi_free_%(c_name)s(*obj); | |
257 | *obj = NULL; | |
258 | } | |
297a3646 MA |
259 | out: |
260 | error_propagate(errp, err); | |
dc8fb6df | 261 | } |
9a5cd424 EB |
262 | ''', |
263 | c_name=c_name(name)) | |
dc8fb6df | 264 | |
e98859a9 | 265 | |
cdb6610a | 266 | class QAPISchemaGenVisitVisitor(QAPISchemaModularCVisitor): |
71b3f045 | 267 | |
cdb6610a MA |
268 | def __init__(self, prefix): |
269 | QAPISchemaModularCVisitor.__init__( | |
71b3f045 MA |
270 | self, prefix, 'qapi-visit', ' * Schema-defined QAPI visitors', |
271 | __doc__) | |
cdb6610a MA |
272 | self._add_module(None, ' * Built-in QAPI visitors') |
273 | self._genc.preamble_add(mcgen(''' | |
274 | #include "qemu/osdep.h" | |
275 | #include "qemu-common.h" | |
276 | #include "qapi/error.h" | |
eb815e24 | 277 | #include "qapi/qapi-builtin-visit.h" |
cdb6610a MA |
278 | ''')) |
279 | self._genh.preamble_add(mcgen(''' | |
280 | #include "qapi/visitor.h" | |
eb815e24 | 281 | #include "qapi/qapi-builtin-types.h" |
cdb6610a MA |
282 | |
283 | ''', | |
284 | prefix=prefix)) | |
285 | ||
286 | def _begin_module(self, name): | |
9af23989 MA |
287 | types = self._module_basename('qapi-types', name) |
288 | visit = self._module_basename('qapi-visit', name) | |
71b3f045 MA |
289 | self._genc.preamble_add(mcgen(''' |
290 | #include "qemu/osdep.h" | |
291 | #include "qemu-common.h" | |
292 | #include "qapi/error.h" | |
293 | #include "qapi/qmp/qerror.h" | |
9af23989 | 294 | #include "%(visit)s.h" |
71b3f045 | 295 | ''', |
9af23989 | 296 | visit=visit, prefix=self._prefix)) |
71b3f045 | 297 | self._genh.preamble_add(mcgen(''' |
eb815e24 | 298 | #include "qapi/qapi-builtin-visit.h" |
9af23989 | 299 | #include "%(types)s.h" |
441cbac0 | 300 | |
71b3f045 | 301 | ''', |
9af23989 | 302 | types=types)) |
441cbac0 MA |
303 | |
304 | def visit_enum_type(self, name, info, values, prefix): | |
cdb6610a MA |
305 | self._genh.add(gen_visit_decl(name, scalar=True)) |
306 | self._genc.add(gen_visit_enum(name)) | |
441cbac0 MA |
307 | |
308 | def visit_array_type(self, name, info, element_type): | |
cdb6610a MA |
309 | self._genh.add(gen_visit_decl(name)) |
310 | self._genc.add(gen_visit_list(name, element_type)) | |
441cbac0 MA |
311 | |
312 | def visit_object_type(self, name, info, base, members, variants): | |
7ce106a9 EB |
313 | # Nothing to do for the special empty builtin |
314 | if name == 'q_empty': | |
315 | return | |
71b3f045 MA |
316 | self._genh.add(gen_visit_members_decl(name)) |
317 | self._genc.add(gen_visit_object_members(name, base, members, variants)) | |
7ce106a9 EB |
318 | # TODO Worth changing the visitor signature, so we could |
319 | # directly use rather than repeat type.is_implicit()? | |
320 | if not name.startswith('q_'): | |
321 | # only explicit types need an allocating visit | |
71b3f045 MA |
322 | self._genh.add(gen_visit_decl(name)) |
323 | self._genc.add(gen_visit_object(name, base, members, variants)) | |
441cbac0 MA |
324 | |
325 | def visit_alternate_type(self, name, info, variants): | |
71b3f045 MA |
326 | self._genh.add(gen_visit_decl(name)) |
327 | self._genc.add(gen_visit_alternate(name, variants)) | |
441cbac0 | 328 | |
8d3bc517 | 329 | |
fb0bc835 | 330 | def gen_visit(schema, output_dir, prefix, opt_builtins): |
cdb6610a | 331 | vis = QAPISchemaGenVisitVisitor(prefix) |
26df4e7f | 332 | schema.visit(vis) |
cdb6610a | 333 | vis.write(output_dir, opt_builtins) |