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