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 "qapi/qmp-input-visitor.h"
18 #include "qapi/visitor-impl.h"
19 #include "qemu/queue.h"
20 #include "qemu-common.h"
21 #include "qapi/qmp/types.h"
22 #include "qapi/qmp/qerror.h"
24 #define QIV_STACK_SIZE 1024
26 typedef struct StackObject
28 QObject
*obj
; /* Object being visited */
29 void *qapi
; /* sanity check that caller uses same pointer */
31 GHashTable
*h
; /* If obj is dict: unvisited keys */
32 const QListEntry
*entry
; /* If obj is list: unvisited tail */
34 QSLIST_ENTRY(StackObject
) node
;
37 struct QmpInputVisitor
41 /* Root of visit at visitor creation. */
44 /* Stack of objects being visited (all entries will be either
46 QSLIST_HEAD(, StackObject
) stack
;
48 /* True to reject parse in visit_end_struct() if unvisited keys remain. */
52 static QmpInputVisitor
*to_qiv(Visitor
*v
)
54 return container_of(v
, QmpInputVisitor
, visitor
);
57 static QObject
*qmp_input_get_object(QmpInputVisitor
*qiv
,
65 if (QSLIST_EMPTY(&qiv
->stack
)) {
66 /* Starting at root, name is ignored. */
71 /* We are in a container; find the next element. */
72 tos
= QSLIST_FIRST(&qiv
->stack
);
76 if (qobject_type(qobj
) == QTYPE_QDICT
) {
78 ret
= qdict_get(qobject_to_qdict(qobj
), name
);
79 if (tos
->h
&& consume
&& ret
) {
80 bool removed
= g_hash_table_remove(tos
->h
, name
);
84 assert(qobject_type(qobj
) == QTYPE_QLIST
);
86 ret
= qlist_entry_obj(tos
->entry
);
89 tos
->entry
= qlist_next(tos
->entry
);
96 static void qdict_add_key(const char *key
, QObject
*obj
, void *opaque
)
98 GHashTable
*h
= opaque
;
99 g_hash_table_insert(h
, (gpointer
) key
, NULL
);
102 static const QListEntry
*qmp_input_push(QmpInputVisitor
*qiv
, QObject
*obj
,
103 void *qapi
, Error
**errp
)
106 StackObject
*tos
= g_new0(StackObject
, 1);
112 if (qiv
->strict
&& qobject_type(obj
) == QTYPE_QDICT
) {
113 h
= g_hash_table_new(g_str_hash
, g_str_equal
);
114 qdict_iter(qobject_to_qdict(obj
), qdict_add_key
, h
);
116 } else if (qobject_type(obj
) == QTYPE_QLIST
) {
117 tos
->entry
= qlist_first(qobject_to_qlist(obj
));
120 QSLIST_INSERT_HEAD(&qiv
->stack
, tos
, node
);
125 static void qmp_input_check_struct(Visitor
*v
, Error
**errp
)
127 QmpInputVisitor
*qiv
= to_qiv(v
);
128 StackObject
*tos
= QSLIST_FIRST(&qiv
->stack
);
130 assert(tos
&& !tos
->entry
);
132 GHashTable
*const top_ht
= tos
->h
;
137 g_hash_table_iter_init(&iter
, top_ht
);
138 if (g_hash_table_iter_next(&iter
, (void **)&key
, NULL
)) {
139 error_setg(errp
, QERR_QMP_EXTRA_MEMBER
, key
);
145 static void qmp_input_stack_object_free(StackObject
*tos
)
148 g_hash_table_unref(tos
->h
);
154 static void qmp_input_pop(Visitor
*v
, void **obj
)
156 QmpInputVisitor
*qiv
= to_qiv(v
);
157 StackObject
*tos
= QSLIST_FIRST(&qiv
->stack
);
159 assert(tos
&& tos
->qapi
== obj
);
160 QSLIST_REMOVE_HEAD(&qiv
->stack
, node
);
161 qmp_input_stack_object_free(tos
);
164 static void qmp_input_start_struct(Visitor
*v
, const char *name
, void **obj
,
165 size_t size
, Error
**errp
)
167 QmpInputVisitor
*qiv
= to_qiv(v
);
168 QObject
*qobj
= qmp_input_get_object(qiv
, name
, true);
174 if (!qobj
|| qobject_type(qobj
) != QTYPE_QDICT
) {
175 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
? name
: "null",
180 qmp_input_push(qiv
, qobj
, obj
, &err
);
182 error_propagate(errp
, err
);
187 *obj
= g_malloc0(size
);
192 static void qmp_input_start_list(Visitor
*v
, const char *name
,
193 GenericList
**list
, size_t size
, Error
**errp
)
195 QmpInputVisitor
*qiv
= to_qiv(v
);
196 QObject
*qobj
= qmp_input_get_object(qiv
, name
, true);
197 const QListEntry
*entry
;
199 if (!qobj
|| qobject_type(qobj
) != QTYPE_QLIST
) {
203 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
? name
: "null",
208 entry
= qmp_input_push(qiv
, qobj
, list
, errp
);
211 *list
= g_malloc0(size
);
218 static GenericList
*qmp_input_next_list(Visitor
*v
, GenericList
*tail
,
221 QmpInputVisitor
*qiv
= to_qiv(v
);
222 StackObject
*so
= QSLIST_FIRST(&qiv
->stack
);
227 tail
->next
= g_malloc0(size
);
232 static void qmp_input_start_alternate(Visitor
*v
, const char *name
,
233 GenericAlternate
**obj
, size_t size
,
234 bool promote_int
, Error
**errp
)
236 QmpInputVisitor
*qiv
= to_qiv(v
);
237 QObject
*qobj
= qmp_input_get_object(qiv
, name
, false);
241 error_setg(errp
, QERR_MISSING_PARAMETER
, name
? name
: "null");
244 *obj
= g_malloc0(size
);
245 (*obj
)->type
= qobject_type(qobj
);
246 if (promote_int
&& (*obj
)->type
== QTYPE_QINT
) {
247 (*obj
)->type
= QTYPE_QFLOAT
;
251 static void qmp_input_type_int64(Visitor
*v
, const char *name
, int64_t *obj
,
254 QmpInputVisitor
*qiv
= to_qiv(v
);
255 QInt
*qint
= qobject_to_qint(qmp_input_get_object(qiv
, name
, true));
258 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
? name
: "null",
263 *obj
= qint_get_int(qint
);
266 static void qmp_input_type_uint64(Visitor
*v
, const char *name
, uint64_t *obj
,
269 /* FIXME: qobject_to_qint mishandles values over INT64_MAX */
270 QmpInputVisitor
*qiv
= to_qiv(v
);
271 QInt
*qint
= qobject_to_qint(qmp_input_get_object(qiv
, name
, true));
274 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
? name
: "null",
279 *obj
= qint_get_int(qint
);
282 static void qmp_input_type_bool(Visitor
*v
, const char *name
, bool *obj
,
285 QmpInputVisitor
*qiv
= to_qiv(v
);
286 QBool
*qbool
= qobject_to_qbool(qmp_input_get_object(qiv
, name
, true));
289 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
? name
: "null",
294 *obj
= qbool_get_bool(qbool
);
297 static void qmp_input_type_str(Visitor
*v
, const char *name
, char **obj
,
300 QmpInputVisitor
*qiv
= to_qiv(v
);
301 QString
*qstr
= qobject_to_qstring(qmp_input_get_object(qiv
, name
, true));
305 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
? name
: "null",
310 *obj
= g_strdup(qstring_get_str(qstr
));
313 static void qmp_input_type_number(Visitor
*v
, const char *name
, double *obj
,
316 QmpInputVisitor
*qiv
= to_qiv(v
);
317 QObject
*qobj
= qmp_input_get_object(qiv
, name
, true);
321 qint
= qobject_to_qint(qobj
);
323 *obj
= qint_get_int(qobject_to_qint(qobj
));
327 qfloat
= qobject_to_qfloat(qobj
);
329 *obj
= qfloat_get_double(qobject_to_qfloat(qobj
));
333 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
? name
: "null",
337 static void qmp_input_type_any(Visitor
*v
, const char *name
, QObject
**obj
,
340 QmpInputVisitor
*qiv
= to_qiv(v
);
341 QObject
*qobj
= qmp_input_get_object(qiv
, name
, true);
344 error_setg(errp
, QERR_MISSING_PARAMETER
, name
? name
: "null");
349 qobject_incref(qobj
);
353 static void qmp_input_type_null(Visitor
*v
, const char *name
, Error
**errp
)
355 QmpInputVisitor
*qiv
= to_qiv(v
);
356 QObject
*qobj
= qmp_input_get_object(qiv
, name
, true);
359 error_setg(errp
, QERR_MISSING_PARAMETER
, name
? name
: "null");
363 if (qobject_type(qobj
) != QTYPE_QNULL
) {
364 error_setg(errp
, QERR_INVALID_PARAMETER_TYPE
, name
? name
: "null",
369 static void qmp_input_optional(Visitor
*v
, const char *name
, bool *present
)
371 QmpInputVisitor
*qiv
= to_qiv(v
);
372 QObject
*qobj
= qmp_input_get_object(qiv
, name
, false);
382 static void qmp_input_free(Visitor
*v
)
384 QmpInputVisitor
*qiv
= to_qiv(v
);
385 while (!QSLIST_EMPTY(&qiv
->stack
)) {
386 StackObject
*tos
= QSLIST_FIRST(&qiv
->stack
);
388 QSLIST_REMOVE_HEAD(&qiv
->stack
, node
);
389 qmp_input_stack_object_free(tos
);
392 qobject_decref(qiv
->root
);
396 Visitor
*qmp_input_visitor_new(QObject
*obj
, bool strict
)
401 v
= g_malloc0(sizeof(*v
));
403 v
->visitor
.type
= VISITOR_INPUT
;
404 v
->visitor
.start_struct
= qmp_input_start_struct
;
405 v
->visitor
.check_struct
= qmp_input_check_struct
;
406 v
->visitor
.end_struct
= qmp_input_pop
;
407 v
->visitor
.start_list
= qmp_input_start_list
;
408 v
->visitor
.next_list
= qmp_input_next_list
;
409 v
->visitor
.end_list
= qmp_input_pop
;
410 v
->visitor
.start_alternate
= qmp_input_start_alternate
;
411 v
->visitor
.type_int64
= qmp_input_type_int64
;
412 v
->visitor
.type_uint64
= qmp_input_type_uint64
;
413 v
->visitor
.type_bool
= qmp_input_type_bool
;
414 v
->visitor
.type_str
= qmp_input_type_str
;
415 v
->visitor
.type_number
= qmp_input_type_number
;
416 v
->visitor
.type_any
= qmp_input_type_any
;
417 v
->visitor
.type_null
= qmp_input_type_null
;
418 v
->visitor
.optional
= qmp_input_optional
;
419 v
->visitor
.free
= qmp_input_free
;