]> git.proxmox.com Git - mirror_qemu.git/blame - qapi/qapi-visit-core.c
hmp: Eliminate a variable in hmp_migrate_set_parameter()
[mirror_qemu.git] / qapi / qapi-visit-core.c
CommitLineData
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 <aliguori@us.ibm.com>
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
22void 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
31void visit_free(Visitor *v)
32{
ebfd93b6 33 trace_visit_free(v);
2c0ef9f4
EB
34 if (v) {
35 v->free(v);
36 }
37}
38
51e72bc1 39void 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 56void 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 64void 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
70void 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 84GenericList *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
91void 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 99void 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
105void 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 123void 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 131bool 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
140bool visit_is_input(Visitor *v)
141{
142 return v->type == VISITOR_INPUT;
143}
144
8e08bf4e
MA
145bool visit_is_dealloc(Visitor *v)
146{
147 return v->type == VISITOR_DEALLOC;
148}
149
51e72bc1 150void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
2345c77c 151{
adfb264c 152 assert(obj);
ebfd93b6 153 trace_visit_type_int(v, name, obj);
0b2a0d6b 154 v->type_int64(v, name, obj, errp);
2345c77c
MR
155}
156
04e070d2
EB
157static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name,
158 uint64_t max, const char *type, Error **errp)
159{
160 Error *err = NULL;
161 uint64_t value = *obj;
162
faad584a
MA
163 assert(v->type == VISITOR_INPUT || value <= max);
164
0b2a0d6b 165 v->type_uint64(v, name, &value, &err);
04e070d2
EB
166 if (err) {
167 error_propagate(errp, err);
168 } else if (value > max) {
faad584a 169 assert(v->type == VISITOR_INPUT);
04e070d2
EB
170 error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
171 name ? name : "null", type);
297a3646 172 } else {
297a3646 173 *obj = value;
4e27e819
MR
174 }
175}
176
51e72bc1
EB
177void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
178 Error **errp)
4e27e819 179{
ebfd93b6
DB
180 uint64_t value;
181
182 trace_visit_type_uint8(v, name, obj);
183 value = *obj;
04e070d2
EB
184 visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp);
185 *obj = value;
4e27e819
MR
186}
187
51e72bc1 188void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
04e070d2 189 Error **errp)
4e27e819 190{
ebfd93b6
DB
191 uint64_t value;
192
193 trace_visit_type_uint16(v, name, obj);
194 value = *obj;
04e070d2
EB
195 visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp);
196 *obj = value;
197}
297a3646 198
51e72bc1 199void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
04e070d2
EB
200 Error **errp)
201{
ebfd93b6
DB
202 uint64_t value;
203
204 trace_visit_type_uint32(v, name, obj);
205 value = *obj;
04e070d2
EB
206 visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp);
207 *obj = value;
4e27e819
MR
208}
209
51e72bc1 210void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
04e070d2 211 Error **errp)
4e27e819 212{
adfb264c 213 assert(obj);
ebfd93b6 214 trace_visit_type_uint64(v, name, obj);
0b2a0d6b 215 v->type_uint64(v, name, obj, errp);
4e27e819
MR
216}
217
04e070d2
EB
218static void visit_type_intN(Visitor *v, int64_t *obj, const char *name,
219 int64_t min, int64_t max, const char *type,
220 Error **errp)
4e27e819 221{
04e070d2
EB
222 Error *err = NULL;
223 int64_t value = *obj;
297a3646 224
faad584a
MA
225 assert(v->type == VISITOR_INPUT || (value >= min && value <= max));
226
0b2a0d6b 227 v->type_int64(v, name, &value, &err);
04e070d2
EB
228 if (err) {
229 error_propagate(errp, err);
230 } else if (value < min || value > max) {
faad584a 231 assert(v->type == VISITOR_INPUT);
04e070d2
EB
232 error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
233 name ? name : "null", type);
297a3646 234 } else {
297a3646 235 *obj = value;
4e27e819
MR
236 }
237}
238
51e72bc1 239void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp)
4e27e819 240{
ebfd93b6
DB
241 int64_t value;
242
243 trace_visit_type_int8(v, name, obj);
244 value = *obj;
04e070d2
EB
245 visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp);
246 *obj = value;
247}
297a3646 248
51e72bc1
EB
249void visit_type_int16(Visitor *v, const char *name, int16_t *obj,
250 Error **errp)
04e070d2 251{
ebfd93b6
DB
252 int64_t value;
253
254 trace_visit_type_int16(v, name, obj);
255 value = *obj;
04e070d2
EB
256 visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t", errp);
257 *obj = value;
4e27e819
MR
258}
259
51e72bc1
EB
260void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
261 Error **errp)
4e27e819 262{
ebfd93b6
DB
263 int64_t value;
264
265 trace_visit_type_int32(v, name, obj);
266 value = *obj;
04e070d2
EB
267 visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t", errp);
268 *obj = value;
4e27e819
MR
269}
270
51e72bc1
EB
271void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
272 Error **errp)
4e27e819 273{
adfb264c 274 assert(obj);
ebfd93b6 275 trace_visit_type_int64(v, name, obj);
0b2a0d6b 276 v->type_int64(v, name, obj, errp);
4e27e819
MR
277}
278
51e72bc1
EB
279void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
280 Error **errp)
092705d4 281{
adfb264c 282 assert(obj);
ebfd93b6 283 trace_visit_type_size(v, name, obj);
297a3646 284 if (v->type_size) {
0b2a0d6b 285 v->type_size(v, name, obj, errp);
297a3646 286 } else {
0b2a0d6b 287 v->type_uint64(v, name, obj, errp);
092705d4
LE
288 }
289}
290
51e72bc1 291void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
2345c77c 292{
adfb264c 293 assert(obj);
ebfd93b6 294 trace_visit_type_bool(v, name, obj);
0b2a0d6b 295 v->type_bool(v, name, obj, errp);
2345c77c
MR
296}
297
51e72bc1 298void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
2345c77c 299{
e58d695e
EB
300 Error *err = NULL;
301
302 assert(obj);
adfb264c
EB
303 /* TODO: Fix callers to not pass NULL when they mean "", so that we
304 * can enable:
a15fcc3c 305 assert(!(v->type & VISITOR_OUTPUT) || *obj);
adfb264c 306 */
ebfd93b6 307 trace_visit_type_str(v, name, obj);
e58d695e 308 v->type_str(v, name, obj, &err);
a15fcc3c 309 if (v->type & VISITOR_INPUT) {
e58d695e
EB
310 assert(!err != !*obj);
311 }
312 error_propagate(errp, err);
2345c77c
MR
313}
314
51e72bc1
EB
315void visit_type_number(Visitor *v, const char *name, double *obj,
316 Error **errp)
2345c77c 317{
adfb264c 318 assert(obj);
ebfd93b6 319 trace_visit_type_number(v, name, obj);
0b2a0d6b 320 v->type_number(v, name, obj, errp);
2345c77c 321}
0f71a1e0 322
51e72bc1 323void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
28770e05 324{
e58d695e
EB
325 Error *err = NULL;
326
327 assert(obj);
adfb264c 328 assert(v->type != VISITOR_OUTPUT || *obj);
ebfd93b6 329 trace_visit_type_any(v, name, obj);
e58d695e
EB
330 v->type_any(v, name, obj, &err);
331 if (v->type == VISITOR_INPUT) {
332 assert(!err != !*obj);
333 }
334 error_propagate(errp, err);
28770e05
MA
335}
336
d2f95f4d
MA
337void visit_type_null(Visitor *v, const char *name, QNull **obj,
338 Error **errp)
3bc97fd5 339{
d2f95f4d
MA
340 trace_visit_type_null(v, name, obj);
341 v->type_null(v, name, obj, errp);
3bc97fd5
EB
342}
343
983f52d4 344static void output_type_enum(Visitor *v, const char *name, int *obj,
f7abe0ec 345 const QEnumLookup *lookup, Error **errp)
0f71a1e0 346{
0f71a1e0
PB
347 int value = *obj;
348 char *enum_str;
349
f7abe0ec 350 enum_str = (char *)qapi_enum_lookup(lookup, value);
51e72bc1 351 visit_type_str(v, name, &enum_str, errp);
0f71a1e0
PB
352}
353
983f52d4 354static void input_type_enum(Visitor *v, const char *name, int *obj,
f7abe0ec 355 const QEnumLookup *lookup, Error **errp)
0f71a1e0 356{
297a3646 357 Error *local_err = NULL;
113e47ae 358 int64_t value;
0f71a1e0
PB
359 char *enum_str;
360
51e72bc1 361 visit_type_str(v, name, &enum_str, &local_err);
297a3646
MA
362 if (local_err) {
363 error_propagate(errp, local_err);
0f71a1e0
PB
364 return;
365 }
366
f7abe0ec 367 value = qapi_enum_parse(lookup, enum_str, -1, NULL);
113e47ae 368 if (value < 0) {
c6bd8c70 369 error_setg(errp, QERR_INVALID_PARAMETER, enum_str);
0f71a1e0
PB
370 g_free(enum_str);
371 return;
372 }
373
374 g_free(enum_str);
375 *obj = value;
376}
983f52d4
EB
377
378void visit_type_enum(Visitor *v, const char *name, int *obj,
f7abe0ec 379 const QEnumLookup *lookup, Error **errp)
983f52d4 380{
f7abe0ec 381 assert(obj && lookup);
6514532f 382 trace_visit_type_enum(v, name, obj);
a15fcc3c
EB
383 switch (v->type) {
384 case VISITOR_INPUT:
f7abe0ec 385 input_type_enum(v, name, obj, lookup, errp);
a15fcc3c
EB
386 break;
387 case VISITOR_OUTPUT:
f7abe0ec 388 output_type_enum(v, name, obj, lookup, errp);
a15fcc3c
EB
389 break;
390 case VISITOR_CLONE:
391 /* nothing further to do, scalar value was already copied by
392 * g_memdup() during visit_start_*() */
393 break;
394 case VISITOR_DEALLOC:
395 /* nothing to deallocate for a scalar */
396 break;
983f52d4
EB
397 }
398}