]>
Commit | Line | Data |
---|---|---|
2345c77c MR |
1 | /* |
2 | * Core Definitions for QAPI Visitor Classes | |
3 | * | |
7c91aabd | 4 | * Copyright (C) 2012-2016 Red Hat, Inc. |
2345c77c MR |
5 | * Copyright IBM, Corp. 2011 |
6 | * | |
7 | * Authors: | |
8 | * Anthony Liguori <[email protected]> | |
9 | * | |
10 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
11 | * See the COPYING.LIB file in the top-level directory. | |
12 | * | |
13 | */ | |
14 | ||
cbf21151 | 15 | #include "qemu/osdep.h" |
da34e65c | 16 | #include "qapi/error.h" |
7b1b5d19 PB |
17 | #include "qapi/qmp/qerror.h" |
18 | #include "qapi/visitor.h" | |
19 | #include "qapi/visitor-impl.h" | |
ebfd93b6 | 20 | #include "trace.h" |
2345c77c | 21 | |
3b098d56 EB |
22 | void visit_complete(Visitor *v, void *opaque) |
23 | { | |
24 | assert(v->type != VISITOR_OUTPUT || v->complete); | |
ebfd93b6 | 25 | trace_visit_complete(v, opaque); |
3b098d56 EB |
26 | if (v->complete) { |
27 | v->complete(v, opaque); | |
28 | } | |
29 | } | |
30 | ||
2c0ef9f4 EB |
31 | void visit_free(Visitor *v) |
32 | { | |
ebfd93b6 | 33 | trace_visit_free(v); |
2c0ef9f4 EB |
34 | if (v) { |
35 | v->free(v); | |
36 | } | |
37 | } | |
38 | ||
51e72bc1 | 39 | void visit_start_struct(Visitor *v, const char *name, void **obj, |
337283df | 40 | size_t size, Error **errp) |
2345c77c | 41 | { |
e58d695e EB |
42 | Error *err = NULL; |
43 | ||
ebfd93b6 | 44 | trace_visit_start_struct(v, name, obj, size); |
adfb264c EB |
45 | if (obj) { |
46 | assert(size); | |
a15fcc3c | 47 | assert(!(v->type & VISITOR_OUTPUT) || *obj); |
adfb264c | 48 | } |
e58d695e | 49 | v->start_struct(v, name, obj, size, &err); |
a15fcc3c | 50 | if (obj && (v->type & VISITOR_INPUT)) { |
e58d695e EB |
51 | assert(!err != !*obj); |
52 | } | |
53 | error_propagate(errp, err); | |
2345c77c MR |
54 | } |
55 | ||
15c2f669 | 56 | void visit_check_struct(Visitor *v, Error **errp) |
2345c77c | 57 | { |
ebfd93b6 | 58 | trace_visit_check_struct(v); |
15c2f669 EB |
59 | if (v->check_struct) { |
60 | v->check_struct(v, errp); | |
61 | } | |
62 | } | |
63 | ||
1158bb2a | 64 | void visit_end_struct(Visitor *v, void **obj) |
15c2f669 | 65 | { |
ebfd93b6 | 66 | trace_visit_end_struct(v, obj); |
1158bb2a | 67 | v->end_struct(v, obj); |
2345c77c MR |
68 | } |
69 | ||
d9f62dde EB |
70 | void visit_start_list(Visitor *v, const char *name, GenericList **list, |
71 | size_t size, Error **errp) | |
2345c77c | 72 | { |
d9f62dde EB |
73 | Error *err = NULL; |
74 | ||
75 | assert(!list || size >= sizeof(GenericList)); | |
ebfd93b6 | 76 | trace_visit_start_list(v, name, list, size); |
d9f62dde | 77 | v->start_list(v, name, list, size, &err); |
a15fcc3c | 78 | if (list && (v->type & VISITOR_INPUT)) { |
d9f62dde EB |
79 | assert(!(err && *list)); |
80 | } | |
81 | error_propagate(errp, err); | |
2345c77c MR |
82 | } |
83 | ||
d9f62dde | 84 | GenericList *visit_next_list(Visitor *v, GenericList *tail, size_t size) |
2345c77c | 85 | { |
d9f62dde | 86 | assert(tail && size >= sizeof(GenericList)); |
ebfd93b6 | 87 | trace_visit_next_list(v, tail, size); |
d9f62dde | 88 | return v->next_list(v, tail, size); |
2345c77c MR |
89 | } |
90 | ||
a4a1c70d MA |
91 | void visit_check_list(Visitor *v, Error **errp) |
92 | { | |
93 | trace_visit_check_list(v); | |
94 | if (v->check_list) { | |
95 | v->check_list(v, errp); | |
96 | } | |
97 | } | |
98 | ||
1158bb2a | 99 | void visit_end_list(Visitor *v, void **obj) |
2345c77c | 100 | { |
ebfd93b6 | 101 | trace_visit_end_list(v, obj); |
1158bb2a | 102 | v->end_list(v, obj); |
2345c77c MR |
103 | } |
104 | ||
dbf11922 EB |
105 | void visit_start_alternate(Visitor *v, const char *name, |
106 | GenericAlternate **obj, size_t size, | |
60390d2d | 107 | Error **errp) |
2345c77c | 108 | { |
e58d695e EB |
109 | Error *err = NULL; |
110 | ||
dbf11922 | 111 | assert(obj && size >= sizeof(GenericAlternate)); |
a15fcc3c | 112 | assert(!(v->type & VISITOR_OUTPUT) || *obj); |
60390d2d | 113 | trace_visit_start_alternate(v, name, obj, size); |
dbf11922 | 114 | if (v->start_alternate) { |
60390d2d | 115 | v->start_alternate(v, name, obj, size, &err); |
e58d695e | 116 | } |
a15fcc3c | 117 | if (v->type & VISITOR_INPUT) { |
e58d695e | 118 | assert(v->start_alternate && !err != !*obj); |
dbf11922 | 119 | } |
e58d695e | 120 | error_propagate(errp, err); |
dbf11922 EB |
121 | } |
122 | ||
1158bb2a | 123 | void visit_end_alternate(Visitor *v, void **obj) |
dbf11922 | 124 | { |
ebfd93b6 | 125 | trace_visit_end_alternate(v, obj); |
dbf11922 | 126 | if (v->end_alternate) { |
1158bb2a | 127 | v->end_alternate(v, obj); |
2345c77c MR |
128 | } |
129 | } | |
130 | ||
dbf11922 | 131 | bool visit_optional(Visitor *v, const char *name, bool *present) |
69dd62df | 132 | { |
ebfd93b6 | 133 | trace_visit_optional(v, name, present); |
dbf11922 EB |
134 | if (v->optional) { |
135 | v->optional(v, name, present); | |
69dd62df | 136 | } |
dbf11922 | 137 | return *present; |
69dd62df KW |
138 | } |
139 | ||
68ab47e4 EB |
140 | bool visit_is_input(Visitor *v) |
141 | { | |
142 | return v->type == VISITOR_INPUT; | |
143 | } | |
144 | ||
51e72bc1 | 145 | void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp) |
2345c77c | 146 | { |
adfb264c | 147 | assert(obj); |
ebfd93b6 | 148 | trace_visit_type_int(v, name, obj); |
0b2a0d6b | 149 | v->type_int64(v, name, obj, errp); |
2345c77c MR |
150 | } |
151 | ||
04e070d2 EB |
152 | static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name, |
153 | uint64_t max, const char *type, Error **errp) | |
154 | { | |
155 | Error *err = NULL; | |
156 | uint64_t value = *obj; | |
157 | ||
0b2a0d6b | 158 | v->type_uint64(v, name, &value, &err); |
04e070d2 EB |
159 | if (err) { |
160 | error_propagate(errp, err); | |
161 | } else if (value > max) { | |
162 | error_setg(errp, QERR_INVALID_PARAMETER_VALUE, | |
163 | name ? name : "null", type); | |
297a3646 | 164 | } else { |
297a3646 | 165 | *obj = value; |
4e27e819 MR |
166 | } |
167 | } | |
168 | ||
51e72bc1 EB |
169 | void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj, |
170 | Error **errp) | |
4e27e819 | 171 | { |
ebfd93b6 DB |
172 | uint64_t value; |
173 | ||
174 | trace_visit_type_uint8(v, name, obj); | |
175 | value = *obj; | |
04e070d2 EB |
176 | visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp); |
177 | *obj = value; | |
4e27e819 MR |
178 | } |
179 | ||
51e72bc1 | 180 | void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj, |
04e070d2 | 181 | Error **errp) |
4e27e819 | 182 | { |
ebfd93b6 DB |
183 | uint64_t value; |
184 | ||
185 | trace_visit_type_uint16(v, name, obj); | |
186 | value = *obj; | |
04e070d2 EB |
187 | visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp); |
188 | *obj = value; | |
189 | } | |
297a3646 | 190 | |
51e72bc1 | 191 | void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj, |
04e070d2 EB |
192 | Error **errp) |
193 | { | |
ebfd93b6 DB |
194 | uint64_t value; |
195 | ||
196 | trace_visit_type_uint32(v, name, obj); | |
197 | value = *obj; | |
04e070d2 EB |
198 | visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp); |
199 | *obj = value; | |
4e27e819 MR |
200 | } |
201 | ||
51e72bc1 | 202 | void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj, |
04e070d2 | 203 | Error **errp) |
4e27e819 | 204 | { |
adfb264c | 205 | assert(obj); |
ebfd93b6 | 206 | trace_visit_type_uint64(v, name, obj); |
0b2a0d6b | 207 | v->type_uint64(v, name, obj, errp); |
4e27e819 MR |
208 | } |
209 | ||
04e070d2 EB |
210 | static void visit_type_intN(Visitor *v, int64_t *obj, const char *name, |
211 | int64_t min, int64_t max, const char *type, | |
212 | Error **errp) | |
4e27e819 | 213 | { |
04e070d2 EB |
214 | Error *err = NULL; |
215 | int64_t value = *obj; | |
297a3646 | 216 | |
0b2a0d6b | 217 | v->type_int64(v, name, &value, &err); |
04e070d2 EB |
218 | if (err) { |
219 | error_propagate(errp, err); | |
220 | } else if (value < min || value > max) { | |
221 | error_setg(errp, QERR_INVALID_PARAMETER_VALUE, | |
222 | name ? name : "null", type); | |
297a3646 | 223 | } else { |
297a3646 | 224 | *obj = value; |
4e27e819 MR |
225 | } |
226 | } | |
227 | ||
51e72bc1 | 228 | void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp) |
4e27e819 | 229 | { |
ebfd93b6 DB |
230 | int64_t value; |
231 | ||
232 | trace_visit_type_int8(v, name, obj); | |
233 | value = *obj; | |
04e070d2 EB |
234 | visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp); |
235 | *obj = value; | |
236 | } | |
297a3646 | 237 | |
51e72bc1 EB |
238 | void visit_type_int16(Visitor *v, const char *name, int16_t *obj, |
239 | Error **errp) | |
04e070d2 | 240 | { |
ebfd93b6 DB |
241 | int64_t value; |
242 | ||
243 | trace_visit_type_int16(v, name, obj); | |
244 | value = *obj; | |
04e070d2 EB |
245 | visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t", errp); |
246 | *obj = value; | |
4e27e819 MR |
247 | } |
248 | ||
51e72bc1 EB |
249 | void visit_type_int32(Visitor *v, const char *name, int32_t *obj, |
250 | Error **errp) | |
4e27e819 | 251 | { |
ebfd93b6 DB |
252 | int64_t value; |
253 | ||
254 | trace_visit_type_int32(v, name, obj); | |
255 | value = *obj; | |
04e070d2 EB |
256 | visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t", errp); |
257 | *obj = value; | |
4e27e819 MR |
258 | } |
259 | ||
51e72bc1 EB |
260 | void visit_type_int64(Visitor *v, const char *name, int64_t *obj, |
261 | Error **errp) | |
4e27e819 | 262 | { |
adfb264c | 263 | assert(obj); |
ebfd93b6 | 264 | trace_visit_type_int64(v, name, obj); |
0b2a0d6b | 265 | v->type_int64(v, name, obj, errp); |
4e27e819 MR |
266 | } |
267 | ||
51e72bc1 EB |
268 | void visit_type_size(Visitor *v, const char *name, uint64_t *obj, |
269 | Error **errp) | |
092705d4 | 270 | { |
adfb264c | 271 | assert(obj); |
ebfd93b6 | 272 | trace_visit_type_size(v, name, obj); |
297a3646 | 273 | if (v->type_size) { |
0b2a0d6b | 274 | v->type_size(v, name, obj, errp); |
297a3646 | 275 | } else { |
0b2a0d6b | 276 | v->type_uint64(v, name, obj, errp); |
092705d4 LE |
277 | } |
278 | } | |
279 | ||
51e72bc1 | 280 | void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp) |
2345c77c | 281 | { |
adfb264c | 282 | assert(obj); |
ebfd93b6 | 283 | trace_visit_type_bool(v, name, obj); |
0b2a0d6b | 284 | v->type_bool(v, name, obj, errp); |
2345c77c MR |
285 | } |
286 | ||
51e72bc1 | 287 | void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp) |
2345c77c | 288 | { |
e58d695e EB |
289 | Error *err = NULL; |
290 | ||
291 | assert(obj); | |
adfb264c EB |
292 | /* TODO: Fix callers to not pass NULL when they mean "", so that we |
293 | * can enable: | |
a15fcc3c | 294 | assert(!(v->type & VISITOR_OUTPUT) || *obj); |
adfb264c | 295 | */ |
ebfd93b6 | 296 | trace_visit_type_str(v, name, obj); |
e58d695e | 297 | v->type_str(v, name, obj, &err); |
a15fcc3c | 298 | if (v->type & VISITOR_INPUT) { |
e58d695e EB |
299 | assert(!err != !*obj); |
300 | } | |
301 | error_propagate(errp, err); | |
2345c77c MR |
302 | } |
303 | ||
51e72bc1 EB |
304 | void visit_type_number(Visitor *v, const char *name, double *obj, |
305 | Error **errp) | |
2345c77c | 306 | { |
adfb264c | 307 | assert(obj); |
ebfd93b6 | 308 | trace_visit_type_number(v, name, obj); |
0b2a0d6b | 309 | v->type_number(v, name, obj, errp); |
2345c77c | 310 | } |
0f71a1e0 | 311 | |
51e72bc1 | 312 | void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp) |
28770e05 | 313 | { |
e58d695e EB |
314 | Error *err = NULL; |
315 | ||
316 | assert(obj); | |
adfb264c | 317 | assert(v->type != VISITOR_OUTPUT || *obj); |
ebfd93b6 | 318 | trace_visit_type_any(v, name, obj); |
e58d695e EB |
319 | v->type_any(v, name, obj, &err); |
320 | if (v->type == VISITOR_INPUT) { | |
321 | assert(!err != !*obj); | |
322 | } | |
323 | error_propagate(errp, err); | |
28770e05 MA |
324 | } |
325 | ||
d2f95f4d MA |
326 | void visit_type_null(Visitor *v, const char *name, QNull **obj, |
327 | Error **errp) | |
3bc97fd5 | 328 | { |
d2f95f4d MA |
329 | trace_visit_type_null(v, name, obj); |
330 | v->type_null(v, name, obj, errp); | |
3bc97fd5 EB |
331 | } |
332 | ||
983f52d4 | 333 | static void output_type_enum(Visitor *v, const char *name, int *obj, |
f7abe0ec | 334 | const QEnumLookup *lookup, Error **errp) |
0f71a1e0 | 335 | { |
0f71a1e0 PB |
336 | int value = *obj; |
337 | char *enum_str; | |
338 | ||
f7abe0ec MAL |
339 | /* |
340 | * TODO why is this an error, not an assertion? If assertion: | |
341 | * delete, and rely on qapi_enum_lookup() | |
342 | */ | |
343 | if (value < 0 || value >= lookup->size) { | |
c6bd8c70 | 344 | error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null"); |
0f71a1e0 PB |
345 | return; |
346 | } | |
347 | ||
f7abe0ec | 348 | enum_str = (char *)qapi_enum_lookup(lookup, value); |
51e72bc1 | 349 | visit_type_str(v, name, &enum_str, errp); |
0f71a1e0 PB |
350 | } |
351 | ||
983f52d4 | 352 | static void input_type_enum(Visitor *v, const char *name, int *obj, |
f7abe0ec | 353 | const QEnumLookup *lookup, Error **errp) |
0f71a1e0 | 354 | { |
297a3646 | 355 | Error *local_err = NULL; |
113e47ae | 356 | int64_t value; |
0f71a1e0 PB |
357 | char *enum_str; |
358 | ||
51e72bc1 | 359 | visit_type_str(v, name, &enum_str, &local_err); |
297a3646 MA |
360 | if (local_err) { |
361 | error_propagate(errp, local_err); | |
0f71a1e0 PB |
362 | return; |
363 | } | |
364 | ||
f7abe0ec | 365 | value = qapi_enum_parse(lookup, enum_str, -1, NULL); |
113e47ae | 366 | if (value < 0) { |
c6bd8c70 | 367 | error_setg(errp, QERR_INVALID_PARAMETER, enum_str); |
0f71a1e0 PB |
368 | g_free(enum_str); |
369 | return; | |
370 | } | |
371 | ||
372 | g_free(enum_str); | |
373 | *obj = value; | |
374 | } | |
983f52d4 EB |
375 | |
376 | void visit_type_enum(Visitor *v, const char *name, int *obj, | |
f7abe0ec | 377 | const QEnumLookup *lookup, Error **errp) |
983f52d4 | 378 | { |
f7abe0ec | 379 | assert(obj && lookup); |
6514532f | 380 | trace_visit_type_enum(v, name, obj); |
a15fcc3c EB |
381 | switch (v->type) { |
382 | case VISITOR_INPUT: | |
f7abe0ec | 383 | input_type_enum(v, name, obj, lookup, errp); |
a15fcc3c EB |
384 | break; |
385 | case VISITOR_OUTPUT: | |
f7abe0ec | 386 | output_type_enum(v, name, obj, lookup, errp); |
a15fcc3c EB |
387 | break; |
388 | case VISITOR_CLONE: | |
389 | /* nothing further to do, scalar value was already copied by | |
390 | * g_memdup() during visit_start_*() */ | |
391 | break; | |
392 | case VISITOR_DEALLOC: | |
393 | /* nothing to deallocate for a scalar */ | |
394 | break; | |
983f52d4 EB |
395 | } |
396 | } |