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_start_struct(Visitor
*v
, const char *name
, void **obj
,
24 size_t size
, Error
**errp
)
30 assert(v
->type
!= VISITOR_OUTPUT
|| *obj
);
32 v
->start_struct(v
, name
, obj
, size
, &err
);
33 if (obj
&& v
->type
== VISITOR_INPUT
) {
34 assert(!err
!= !*obj
);
36 error_propagate(errp
, err
);
39 void visit_end_struct(Visitor
*v
, Error
**errp
)
41 v
->end_struct(v
, errp
);
44 void visit_start_list(Visitor
*v
, const char *name
, Error
**errp
)
46 v
->start_list(v
, name
, errp
);
49 GenericList
*visit_next_list(Visitor
*v
, GenericList
**list
, size_t size
)
51 assert(list
&& size
>= sizeof(GenericList
));
52 return v
->next_list(v
, list
, size
);
55 void visit_end_list(Visitor
*v
)
60 void visit_start_alternate(Visitor
*v
, const char *name
,
61 GenericAlternate
**obj
, size_t size
,
62 bool promote_int
, Error
**errp
)
66 assert(obj
&& size
>= sizeof(GenericAlternate
));
67 assert(v
->type
!= VISITOR_OUTPUT
|| *obj
);
68 if (v
->start_alternate
) {
69 v
->start_alternate(v
, name
, obj
, size
, promote_int
, &err
);
71 if (v
->type
== VISITOR_INPUT
) {
72 assert(v
->start_alternate
&& !err
!= !*obj
);
74 error_propagate(errp
, err
);
77 void visit_end_alternate(Visitor
*v
)
79 if (v
->end_alternate
) {
84 bool visit_optional(Visitor
*v
, const char *name
, bool *present
)
87 v
->optional(v
, name
, present
);
92 void visit_type_int(Visitor
*v
, const char *name
, int64_t *obj
, Error
**errp
)
95 v
->type_int64(v
, name
, obj
, errp
);
98 static void visit_type_uintN(Visitor
*v
, uint64_t *obj
, const char *name
,
99 uint64_t max
, const char *type
, Error
**errp
)
102 uint64_t value
= *obj
;
104 v
->type_uint64(v
, name
, &value
, &err
);
106 error_propagate(errp
, err
);
107 } else if (value
> max
) {
108 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
109 name
? name
: "null", type
);
115 void visit_type_uint8(Visitor
*v
, const char *name
, uint8_t *obj
,
118 uint64_t value
= *obj
;
119 visit_type_uintN(v
, &value
, name
, UINT8_MAX
, "uint8_t", errp
);
123 void visit_type_uint16(Visitor
*v
, const char *name
, uint16_t *obj
,
126 uint64_t value
= *obj
;
127 visit_type_uintN(v
, &value
, name
, UINT16_MAX
, "uint16_t", errp
);
131 void visit_type_uint32(Visitor
*v
, const char *name
, uint32_t *obj
,
134 uint64_t value
= *obj
;
135 visit_type_uintN(v
, &value
, name
, UINT32_MAX
, "uint32_t", errp
);
139 void visit_type_uint64(Visitor
*v
, const char *name
, uint64_t *obj
,
143 v
->type_uint64(v
, name
, obj
, errp
);
146 static void visit_type_intN(Visitor
*v
, int64_t *obj
, const char *name
,
147 int64_t min
, int64_t max
, const char *type
,
151 int64_t value
= *obj
;
153 v
->type_int64(v
, name
, &value
, &err
);
155 error_propagate(errp
, err
);
156 } else if (value
< min
|| value
> max
) {
157 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
158 name
? name
: "null", type
);
164 void visit_type_int8(Visitor
*v
, const char *name
, int8_t *obj
, Error
**errp
)
166 int64_t value
= *obj
;
167 visit_type_intN(v
, &value
, name
, INT8_MIN
, INT8_MAX
, "int8_t", errp
);
171 void visit_type_int16(Visitor
*v
, const char *name
, int16_t *obj
,
174 int64_t value
= *obj
;
175 visit_type_intN(v
, &value
, name
, INT16_MIN
, INT16_MAX
, "int16_t", errp
);
179 void visit_type_int32(Visitor
*v
, const char *name
, int32_t *obj
,
182 int64_t value
= *obj
;
183 visit_type_intN(v
, &value
, name
, INT32_MIN
, INT32_MAX
, "int32_t", errp
);
187 void visit_type_int64(Visitor
*v
, const char *name
, int64_t *obj
,
191 v
->type_int64(v
, name
, obj
, errp
);
194 void visit_type_size(Visitor
*v
, const char *name
, uint64_t *obj
,
199 v
->type_size(v
, name
, obj
, errp
);
201 v
->type_uint64(v
, name
, obj
, errp
);
205 void visit_type_bool(Visitor
*v
, const char *name
, bool *obj
, Error
**errp
)
208 v
->type_bool(v
, name
, obj
, errp
);
211 void visit_type_str(Visitor
*v
, const char *name
, char **obj
, Error
**errp
)
216 /* TODO: Fix callers to not pass NULL when they mean "", so that we
218 assert(v->type != VISITOR_OUTPUT || *obj);
220 v
->type_str(v
, name
, obj
, &err
);
221 if (v
->type
== VISITOR_INPUT
) {
222 assert(!err
!= !*obj
);
224 error_propagate(errp
, err
);
227 void visit_type_number(Visitor
*v
, const char *name
, double *obj
,
231 v
->type_number(v
, name
, obj
, errp
);
234 void visit_type_any(Visitor
*v
, const char *name
, QObject
**obj
, Error
**errp
)
239 assert(v
->type
!= VISITOR_OUTPUT
|| *obj
);
240 v
->type_any(v
, name
, obj
, &err
);
241 if (v
->type
== VISITOR_INPUT
) {
242 assert(!err
!= !*obj
);
244 error_propagate(errp
, err
);
247 void visit_type_null(Visitor
*v
, const char *name
, Error
**errp
)
249 v
->type_null(v
, name
, errp
);
252 static void output_type_enum(Visitor
*v
, const char *name
, int *obj
,
253 const char *const strings
[], Error
**errp
)
259 while (strings
[i
++] != NULL
);
260 if (value
< 0 || value
>= i
- 1) {
261 error_setg(errp
, QERR_INVALID_PARAMETER
, name
? name
: "null");
265 enum_str
= (char *)strings
[value
];
266 visit_type_str(v
, name
, &enum_str
, errp
);
269 static void input_type_enum(Visitor
*v
, const char *name
, int *obj
,
270 const char *const strings
[], Error
**errp
)
272 Error
*local_err
= NULL
;
276 visit_type_str(v
, name
, &enum_str
, &local_err
);
278 error_propagate(errp
, local_err
);
282 while (strings
[value
] != NULL
) {
283 if (strcmp(strings
[value
], enum_str
) == 0) {
289 if (strings
[value
] == NULL
) {
290 error_setg(errp
, QERR_INVALID_PARAMETER
, enum_str
);
299 void visit_type_enum(Visitor
*v
, const char *name
, int *obj
,
300 const char *const strings
[], Error
**errp
)
302 assert(obj
&& strings
);
303 if (v
->type
== VISITOR_INPUT
) {
304 input_type_enum(v
, name
, obj
, strings
, errp
);
305 } else if (v
->type
== VISITOR_OUTPUT
) {
306 output_type_enum(v
, name
, obj
, strings
, errp
);