2 * Core Definitions for QAPI/QMP Command Registry
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/qobject-output-visitor.h"
17 #include "qapi/visitor-impl.h"
18 #include "qemu/queue.h"
19 #include "qapi/qmp/qbool.h"
20 #include "qapi/qmp/qdict.h"
21 #include "qapi/qmp/qlist.h"
22 #include "qapi/qmp/qnull.h"
23 #include "qapi/qmp/qnum.h"
24 #include "qapi/qmp/qstring.h"
26 typedef struct QStackEntry {
28 void *qapi; /* sanity check that caller uses same pointer */
29 QSLIST_ENTRY(QStackEntry) node;
32 struct QObjectOutputVisitor {
34 QSLIST_HEAD(, QStackEntry) stack; /* Stack of unfinished containers */
35 QObject *root; /* Root of the output visit */
36 QObject **result; /* User's storage location for result */
39 #define qobject_output_add(qov, name, value) \
40 qobject_output_add_obj(qov, name, QOBJECT(value))
41 #define qobject_output_push(qov, value, qapi) \
42 qobject_output_push_obj(qov, QOBJECT(value), qapi)
44 static QObjectOutputVisitor *to_qov(Visitor *v)
46 return container_of(v, QObjectOutputVisitor, visitor);
49 /* Push @value onto the stack of current QObjects being built */
50 static void qobject_output_push_obj(QObjectOutputVisitor *qov, QObject *value,
53 QStackEntry *e = g_malloc0(sizeof(*e));
59 QSLIST_INSERT_HEAD(&qov->stack, e, node);
62 /* Pop a value off the stack of QObjects being built, and return it. */
63 static QObject *qobject_output_pop(QObjectOutputVisitor *qov, void *qapi)
65 QStackEntry *e = QSLIST_FIRST(&qov->stack);
69 assert(e->qapi == qapi);
70 QSLIST_REMOVE_HEAD(&qov->stack, node);
77 /* Add @value to the current QObject being built.
78 * If the stack is visiting a dictionary or list, @value is now owned
79 * by that container. Otherwise, @value is now the root. */
80 static void qobject_output_add_obj(QObjectOutputVisitor *qov, const char *name,
83 QStackEntry *e = QSLIST_FIRST(&qov->stack);
84 QObject *cur = e ? e->value : NULL;
87 /* Don't allow reuse of visitor on more than one root */
91 switch (qobject_type(cur)) {
94 qdict_put_obj(qobject_to(QDict, cur), name, value);
98 qlist_append_obj(qobject_to(QList, cur), value);
101 g_assert_not_reached();
106 static bool qobject_output_start_struct(Visitor *v, const char *name,
107 void **obj, size_t unused, Error **errp)
109 QObjectOutputVisitor *qov = to_qov(v);
110 QDict *dict = qdict_new();
112 qobject_output_add(qov, name, dict);
113 qobject_output_push(qov, dict, obj);
117 static void qobject_output_end_struct(Visitor *v, void **obj)
119 QObjectOutputVisitor *qov = to_qov(v);
120 QObject *value = qobject_output_pop(qov, obj);
121 assert(qobject_type(value) == QTYPE_QDICT);
124 static bool qobject_output_start_list(Visitor *v, const char *name,
125 GenericList **listp, size_t size,
128 QObjectOutputVisitor *qov = to_qov(v);
129 QList *list = qlist_new();
131 qobject_output_add(qov, name, list);
132 qobject_output_push(qov, list, listp);
136 static GenericList *qobject_output_next_list(Visitor *v, GenericList *tail,
142 static void qobject_output_end_list(Visitor *v, void **obj)
144 QObjectOutputVisitor *qov = to_qov(v);
145 QObject *value = qobject_output_pop(qov, obj);
146 assert(qobject_type(value) == QTYPE_QLIST);
149 static bool qobject_output_type_int64(Visitor *v, const char *name,
150 int64_t *obj, Error **errp)
152 QObjectOutputVisitor *qov = to_qov(v);
153 qobject_output_add(qov, name, qnum_from_int(*obj));
157 static bool qobject_output_type_uint64(Visitor *v, const char *name,
158 uint64_t *obj, Error **errp)
160 QObjectOutputVisitor *qov = to_qov(v);
161 qobject_output_add(qov, name, qnum_from_uint(*obj));
165 static bool qobject_output_type_bool(Visitor *v, const char *name, bool *obj,
168 QObjectOutputVisitor *qov = to_qov(v);
169 qobject_output_add(qov, name, qbool_from_bool(*obj));
173 static bool qobject_output_type_str(Visitor *v, const char *name, char **obj,
176 QObjectOutputVisitor *qov = to_qov(v);
178 qobject_output_add(qov, name, qstring_from_str(*obj));
180 qobject_output_add(qov, name, qstring_from_str(""));
185 static bool qobject_output_type_number(Visitor *v, const char *name,
186 double *obj, Error **errp)
188 QObjectOutputVisitor *qov = to_qov(v);
189 qobject_output_add(qov, name, qnum_from_double(*obj));
193 static bool qobject_output_type_any(Visitor *v, const char *name,
194 QObject **obj, Error **errp)
196 QObjectOutputVisitor *qov = to_qov(v);
198 qobject_output_add_obj(qov, name, qobject_ref(*obj));
202 static bool qobject_output_type_null(Visitor *v, const char *name,
203 QNull **obj, Error **errp)
205 QObjectOutputVisitor *qov = to_qov(v);
206 qobject_output_add(qov, name, qnull());
210 /* Finish building, and return the root object.
211 * The root object is never null. The caller becomes the object's
212 * owner, and should use qobject_unref() when done with it. */
213 static void qobject_output_complete(Visitor *v, void *opaque)
215 QObjectOutputVisitor *qov = to_qov(v);
217 /* A visit must have occurred, with each start paired with end. */
218 assert(qov->root && QSLIST_EMPTY(&qov->stack));
219 assert(opaque == qov->result);
221 *qov->result = qobject_ref(qov->root);
225 static void qobject_output_free(Visitor *v)
227 QObjectOutputVisitor *qov = to_qov(v);
230 while (!QSLIST_EMPTY(&qov->stack)) {
231 e = QSLIST_FIRST(&qov->stack);
232 QSLIST_REMOVE_HEAD(&qov->stack, node);
236 qobject_unref(qov->root);
240 Visitor *qobject_output_visitor_new(QObject **result)
242 QObjectOutputVisitor *v;
244 v = g_malloc0(sizeof(*v));
246 v->visitor.type = VISITOR_OUTPUT;
247 v->visitor.start_struct = qobject_output_start_struct;
248 v->visitor.end_struct = qobject_output_end_struct;
249 v->visitor.start_list = qobject_output_start_list;
250 v->visitor.next_list = qobject_output_next_list;
251 v->visitor.end_list = qobject_output_end_list;
252 v->visitor.type_int64 = qobject_output_type_int64;
253 v->visitor.type_uint64 = qobject_output_type_uint64;
254 v->visitor.type_bool = qobject_output_type_bool;
255 v->visitor.type_str = qobject_output_type_str;
256 v->visitor.type_number = qobject_output_type_number;
257 v->visitor.type_any = qobject_output_type_any;
258 v->visitor.type_null = qobject_output_type_null;
259 v->visitor.complete = qobject_output_complete;
260 v->visitor.free = qobject_output_free;