2 * Core Definitions for QAPI Visitor Classes
4 * Copyright (C) 2012-2016 Red Hat, Inc.
5 * Copyright IBM, Corp. 2011
8 * Anthony Liguori <aliguori@us.ibm.com>
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.
15 #include "qemu/osdep.h"
16 #include "qapi/error.h"
17 #include "qemu-common.h"
18 #include "qapi/qmp/qobject.h"
19 #include "qapi/qmp/qerror.h"
20 #include "qapi/visitor.h"
21 #include "qapi/visitor-impl.h"
23 void visit_free(Visitor
*v
)
30 void visit_start_struct(Visitor
*v
, const char *name
, void **obj
,
31 size_t size
, Error
**errp
)
37 assert(v
->type
!= VISITOR_OUTPUT
|| *obj
);
39 v
->start_struct(v
, name
, obj
, size
, &err
);
40 if (obj
&& v
->type
== VISITOR_INPUT
) {
41 assert(!err
!= !*obj
);
43 error_propagate(errp
, err
);
46 void visit_check_struct(Visitor
*v
, Error
**errp
)
48 if (v
->check_struct
) {
49 v
->check_struct(v
, errp
);
53 void visit_end_struct(Visitor
*v
, void **obj
)
55 v
->end_struct(v
, obj
);
58 void visit_start_list(Visitor
*v
, const char *name
, GenericList
**list
,
59 size_t size
, Error
**errp
)
63 assert(!list
|| size
>= sizeof(GenericList
));
64 v
->start_list(v
, name
, list
, size
, &err
);
65 if (list
&& v
->type
== VISITOR_INPUT
) {
66 assert(!(err
&& *list
));
68 error_propagate(errp
, err
);
71 GenericList
*visit_next_list(Visitor
*v
, GenericList
*tail
, size_t size
)
73 assert(tail
&& size
>= sizeof(GenericList
));
74 return v
->next_list(v
, tail
, size
);
77 void visit_end_list(Visitor
*v
, void **obj
)
82 void visit_start_alternate(Visitor
*v
, const char *name
,
83 GenericAlternate
**obj
, size_t size
,
84 bool promote_int
, Error
**errp
)
88 assert(obj
&& size
>= sizeof(GenericAlternate
));
89 assert(v
->type
!= VISITOR_OUTPUT
|| *obj
);
90 if (v
->start_alternate
) {
91 v
->start_alternate(v
, name
, obj
, size
, promote_int
, &err
);
93 if (v
->type
== VISITOR_INPUT
) {
94 assert(v
->start_alternate
&& !err
!= !*obj
);
96 error_propagate(errp
, err
);
99 void visit_end_alternate(Visitor
*v
, void **obj
)
101 if (v
->end_alternate
) {
102 v
->end_alternate(v
, obj
);
106 bool visit_optional(Visitor
*v
, const char *name
, bool *present
)
109 v
->optional(v
, name
, present
);
114 bool visit_is_input(Visitor
*v
)
116 return v
->type
== VISITOR_INPUT
;
119 void visit_type_int(Visitor
*v
, const char *name
, int64_t *obj
, Error
**errp
)
122 v
->type_int64(v
, name
, obj
, errp
);
125 static void visit_type_uintN(Visitor
*v
, uint64_t *obj
, const char *name
,
126 uint64_t max
, const char *type
, Error
**errp
)
129 uint64_t value
= *obj
;
131 v
->type_uint64(v
, name
, &value
, &err
);
133 error_propagate(errp
, err
);
134 } else if (value
> max
) {
135 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
136 name
? name
: "null", type
);
142 void visit_type_uint8(Visitor
*v
, const char *name
, uint8_t *obj
,
145 uint64_t value
= *obj
;
146 visit_type_uintN(v
, &value
, name
, UINT8_MAX
, "uint8_t", errp
);
150 void visit_type_uint16(Visitor
*v
, const char *name
, uint16_t *obj
,
153 uint64_t value
= *obj
;
154 visit_type_uintN(v
, &value
, name
, UINT16_MAX
, "uint16_t", errp
);
158 void visit_type_uint32(Visitor
*v
, const char *name
, uint32_t *obj
,
161 uint64_t value
= *obj
;
162 visit_type_uintN(v
, &value
, name
, UINT32_MAX
, "uint32_t", errp
);
166 void visit_type_uint64(Visitor
*v
, const char *name
, uint64_t *obj
,
170 v
->type_uint64(v
, name
, obj
, errp
);
173 static void visit_type_intN(Visitor
*v
, int64_t *obj
, const char *name
,
174 int64_t min
, int64_t max
, const char *type
,
178 int64_t value
= *obj
;
180 v
->type_int64(v
, name
, &value
, &err
);
182 error_propagate(errp
, err
);
183 } else if (value
< min
|| value
> max
) {
184 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
185 name
? name
: "null", type
);
191 void visit_type_int8(Visitor
*v
, const char *name
, int8_t *obj
, Error
**errp
)
193 int64_t value
= *obj
;
194 visit_type_intN(v
, &value
, name
, INT8_MIN
, INT8_MAX
, "int8_t", errp
);
198 void visit_type_int16(Visitor
*v
, const char *name
, int16_t *obj
,
201 int64_t value
= *obj
;
202 visit_type_intN(v
, &value
, name
, INT16_MIN
, INT16_MAX
, "int16_t", errp
);
206 void visit_type_int32(Visitor
*v
, const char *name
, int32_t *obj
,
209 int64_t value
= *obj
;
210 visit_type_intN(v
, &value
, name
, INT32_MIN
, INT32_MAX
, "int32_t", errp
);
214 void visit_type_int64(Visitor
*v
, const char *name
, int64_t *obj
,
218 v
->type_int64(v
, name
, obj
, errp
);
221 void visit_type_size(Visitor
*v
, const char *name
, uint64_t *obj
,
226 v
->type_size(v
, name
, obj
, errp
);
228 v
->type_uint64(v
, name
, obj
, errp
);
232 void visit_type_bool(Visitor
*v
, const char *name
, bool *obj
, Error
**errp
)
235 v
->type_bool(v
, name
, obj
, errp
);
238 void visit_type_str(Visitor
*v
, const char *name
, char **obj
, Error
**errp
)
243 /* TODO: Fix callers to not pass NULL when they mean "", so that we
245 assert(v->type != VISITOR_OUTPUT || *obj);
247 v
->type_str(v
, name
, obj
, &err
);
248 if (v
->type
== VISITOR_INPUT
) {
249 assert(!err
!= !*obj
);
251 error_propagate(errp
, err
);
254 void visit_type_number(Visitor
*v
, const char *name
, double *obj
,
258 v
->type_number(v
, name
, obj
, errp
);
261 void visit_type_any(Visitor
*v
, const char *name
, QObject
**obj
, Error
**errp
)
266 assert(v
->type
!= VISITOR_OUTPUT
|| *obj
);
267 v
->type_any(v
, name
, obj
, &err
);
268 if (v
->type
== VISITOR_INPUT
) {
269 assert(!err
!= !*obj
);
271 error_propagate(errp
, err
);
274 void visit_type_null(Visitor
*v
, const char *name
, Error
**errp
)
276 v
->type_null(v
, name
, errp
);
279 static void output_type_enum(Visitor
*v
, const char *name
, int *obj
,
280 const char *const strings
[], Error
**errp
)
286 while (strings
[i
++] != NULL
);
287 if (value
< 0 || value
>= i
- 1) {
288 error_setg(errp
, QERR_INVALID_PARAMETER
, name
? name
: "null");
292 enum_str
= (char *)strings
[value
];
293 visit_type_str(v
, name
, &enum_str
, errp
);
296 static void input_type_enum(Visitor
*v
, const char *name
, int *obj
,
297 const char *const strings
[], Error
**errp
)
299 Error
*local_err
= NULL
;
303 visit_type_str(v
, name
, &enum_str
, &local_err
);
305 error_propagate(errp
, local_err
);
309 while (strings
[value
] != NULL
) {
310 if (strcmp(strings
[value
], enum_str
) == 0) {
316 if (strings
[value
] == NULL
) {
317 error_setg(errp
, QERR_INVALID_PARAMETER
, enum_str
);
326 void visit_type_enum(Visitor
*v
, const char *name
, int *obj
,
327 const char *const strings
[], Error
**errp
)
329 assert(obj
&& strings
);
330 if (v
->type
== VISITOR_INPUT
) {
331 input_type_enum(v
, name
, obj
, strings
, errp
);
332 } else if (v
->type
== VISITOR_OUTPUT
) {
333 output_type_enum(v
, name
, obj
, strings
, errp
);