]> git.proxmox.com Git - mirror_qemu.git/blame - qapi/qobject-output-visitor.c
exec.c: subpage->sub_section is already initialized to 0
[mirror_qemu.git] / qapi / qobject-output-visitor.c
CommitLineData
e4e6aa14
MR
1/*
2 * Core Definitions for QAPI/QMP Command Registry
3 *
08f9541d 4 * Copyright (C) 2012-2016 Red Hat, Inc.
e4e6aa14
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"
b3db211f 16#include "qapi/qobject-output-visitor.h"
7b1b5d19 17#include "qapi/visitor-impl.h"
1de7afc9 18#include "qemu/queue.h"
6b673957 19#include "qapi/qmp/qbool.h"
452fcdbc 20#include "qapi/qmp/qdict.h"
47e6b297 21#include "qapi/qmp/qlist.h"
15280c36
MA
22#include "qapi/qmp/qnull.h"
23#include "qapi/qmp/qnum.h"
6b673957 24#include "qapi/qmp/qstring.h"
e4e6aa14 25
7d5e199a 26typedef struct QStackEntry {
e4e6aa14 27 QObject *value;
1158bb2a 28 void *qapi; /* sanity check that caller uses same pointer */
fc76ae8b 29 QSLIST_ENTRY(QStackEntry) node;
e4e6aa14
MR
30} QStackEntry;
31
7d5e199a 32struct QObjectOutputVisitor {
e4e6aa14 33 Visitor visitor;
fc76ae8b 34 QSLIST_HEAD(, QStackEntry) stack; /* Stack of unfinished containers */
455ba08a 35 QObject *root; /* Root of the output visit */
3b098d56 36 QObject **result; /* User's storage location for result */
e4e6aa14
MR
37};
38
7d5e199a
DB
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)
e4e6aa14 43
7d5e199a 44static QObjectOutputVisitor *to_qov(Visitor *v)
e4e6aa14 45{
7d5e199a 46 return container_of(v, QObjectOutputVisitor, visitor);
e4e6aa14
MR
47}
48
a8615640 49/* Push @value onto the stack of current QObjects being built */
7d5e199a
DB
50static void qobject_output_push_obj(QObjectOutputVisitor *qov, QObject *value,
51 void *qapi)
e4e6aa14 52{
7267c094 53 QStackEntry *e = g_malloc0(sizeof(*e));
e4e6aa14 54
455ba08a 55 assert(qov->root);
a8615640 56 assert(value);
e4e6aa14 57 e->value = value;
1158bb2a 58 e->qapi = qapi;
fc76ae8b 59 QSLIST_INSERT_HEAD(&qov->stack, e, node);
e4e6aa14
MR
60}
61
a8615640 62/* Pop a value off the stack of QObjects being built, and return it. */
7d5e199a 63static QObject *qobject_output_pop(QObjectOutputVisitor *qov, void *qapi)
e4e6aa14 64{
fc76ae8b 65 QStackEntry *e = QSLIST_FIRST(&qov->stack);
e4e6aa14 66 QObject *value;
a8615640
EB
67
68 assert(e);
1158bb2a 69 assert(e->qapi == qapi);
fc76ae8b 70 QSLIST_REMOVE_HEAD(&qov->stack, node);
e4e6aa14 71 value = e->value;
a8615640 72 assert(value);
7267c094 73 g_free(e);
e4e6aa14
MR
74 return value;
75}
76
a8615640
EB
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. */
7d5e199a
DB
80static void qobject_output_add_obj(QObjectOutputVisitor *qov, const char *name,
81 QObject *value)
e4e6aa14 82{
fc76ae8b 83 QStackEntry *e = QSLIST_FIRST(&qov->stack);
455ba08a 84 QObject *cur = e ? e->value : NULL;
e4e6aa14 85
455ba08a 86 if (!cur) {
56a6f02b
EB
87 /* Don't allow reuse of visitor on more than one root */
88 assert(!qov->root);
455ba08a
EB
89 qov->root = value;
90 } else {
91 switch (qobject_type(cur)) {
92 case QTYPE_QDICT:
93 assert(name);
7dc847eb 94 qdict_put_obj(qobject_to(QDict, cur), name, value);
455ba08a
EB
95 break;
96 case QTYPE_QLIST:
56a6f02b 97 assert(!name);
7dc847eb 98 qlist_append_obj(qobject_to(QList, cur), value);
455ba08a
EB
99 break;
100 default:
101 g_assert_not_reached();
102 }
e4e6aa14
MR
103 }
104}
105
7d5e199a
DB
106static void qobject_output_start_struct(Visitor *v, const char *name,
107 void **obj, size_t unused, Error **errp)
e4e6aa14 108{
7d5e199a 109 QObjectOutputVisitor *qov = to_qov(v);
e4e6aa14
MR
110 QDict *dict = qdict_new();
111
7d5e199a
DB
112 qobject_output_add(qov, name, dict);
113 qobject_output_push(qov, dict, obj);
e4e6aa14
MR
114}
115
7d5e199a 116static void qobject_output_end_struct(Visitor *v, void **obj)
e4e6aa14 117{
7d5e199a
DB
118 QObjectOutputVisitor *qov = to_qov(v);
119 QObject *value = qobject_output_pop(qov, obj);
56a6f02b 120 assert(qobject_type(value) == QTYPE_QDICT);
e4e6aa14
MR
121}
122
7d5e199a
DB
123static void qobject_output_start_list(Visitor *v, const char *name,
124 GenericList **listp, size_t size,
125 Error **errp)
e4e6aa14 126{
7d5e199a 127 QObjectOutputVisitor *qov = to_qov(v);
e4e6aa14
MR
128 QList *list = qlist_new();
129
7d5e199a
DB
130 qobject_output_add(qov, name, list);
131 qobject_output_push(qov, list, listp);
e4e6aa14
MR
132}
133
7d5e199a
DB
134static GenericList *qobject_output_next_list(Visitor *v, GenericList *tail,
135 size_t size)
e4e6aa14 136{
d9f62dde 137 return tail->next;
e4e6aa14
MR
138}
139
7d5e199a 140static void qobject_output_end_list(Visitor *v, void **obj)
e4e6aa14 141{
7d5e199a
DB
142 QObjectOutputVisitor *qov = to_qov(v);
143 QObject *value = qobject_output_pop(qov, obj);
56a6f02b 144 assert(qobject_type(value) == QTYPE_QLIST);
e4e6aa14
MR
145}
146
7d5e199a
DB
147static void qobject_output_type_int64(Visitor *v, const char *name,
148 int64_t *obj, Error **errp)
e4e6aa14 149{
7d5e199a 150 QObjectOutputVisitor *qov = to_qov(v);
01b2ffce 151 qobject_output_add(qov, name, qnum_from_int(*obj));
e4e6aa14
MR
152}
153
7d5e199a
DB
154static void qobject_output_type_uint64(Visitor *v, const char *name,
155 uint64_t *obj, Error **errp)
f755dea7 156{
7d5e199a 157 QObjectOutputVisitor *qov = to_qov(v);
5923f85f 158 qobject_output_add(qov, name, qnum_from_uint(*obj));
f755dea7
EB
159}
160
7d5e199a
DB
161static void qobject_output_type_bool(Visitor *v, const char *name, bool *obj,
162 Error **errp)
e4e6aa14 163{
7d5e199a
DB
164 QObjectOutputVisitor *qov = to_qov(v);
165 qobject_output_add(qov, name, qbool_from_bool(*obj));
e4e6aa14
MR
166}
167
7d5e199a
DB
168static void qobject_output_type_str(Visitor *v, const char *name, char **obj,
169 Error **errp)
e4e6aa14 170{
7d5e199a 171 QObjectOutputVisitor *qov = to_qov(v);
e4e6aa14 172 if (*obj) {
7d5e199a 173 qobject_output_add(qov, name, qstring_from_str(*obj));
e4e6aa14 174 } else {
7d5e199a 175 qobject_output_add(qov, name, qstring_from_str(""));
e4e6aa14
MR
176 }
177}
178
7d5e199a
DB
179static void qobject_output_type_number(Visitor *v, const char *name,
180 double *obj, Error **errp)
e4e6aa14 181{
7d5e199a 182 QObjectOutputVisitor *qov = to_qov(v);
01b2ffce 183 qobject_output_add(qov, name, qnum_from_double(*obj));
e4e6aa14
MR
184}
185
7d5e199a
DB
186static void qobject_output_type_any(Visitor *v, const char *name,
187 QObject **obj, Error **errp)
28770e05 188{
7d5e199a 189 QObjectOutputVisitor *qov = to_qov(v);
f5a74a5a
MAL
190
191 qobject_output_add_obj(qov, name, qobject_ref(*obj));
28770e05
MA
192}
193
d2f95f4d
MA
194static void qobject_output_type_null(Visitor *v, const char *name,
195 QNull **obj, Error **errp)
3bc97fd5 196{
7d5e199a 197 QObjectOutputVisitor *qov = to_qov(v);
006ca09f 198 qobject_output_add(qov, name, qnull());
3bc97fd5
EB
199}
200
56a6f02b
EB
201/* Finish building, and return the root object.
202 * The root object is never null. The caller becomes the object's
cb3e7f08 203 * owner, and should use qobject_unref() when done with it. */
7d5e199a 204static void qobject_output_complete(Visitor *v, void *opaque)
e4e6aa14 205{
7d5e199a 206 QObjectOutputVisitor *qov = to_qov(v);
3b098d56 207
56a6f02b 208 /* A visit must have occurred, with each start paired with end. */
fc76ae8b 209 assert(qov->root && QSLIST_EMPTY(&qov->stack));
3b098d56 210 assert(opaque == qov->result);
56a6f02b 211
f5a74a5a 212 *qov->result = qobject_ref(qov->root);
3b098d56 213 qov->result = NULL;
e4e6aa14
MR
214}
215
7d5e199a 216static void qobject_output_free(Visitor *v)
2c0ef9f4 217{
7d5e199a 218 QObjectOutputVisitor *qov = to_qov(v);
fc76ae8b 219 QStackEntry *e;
e4e6aa14 220
fc76ae8b
PB
221 while (!QSLIST_EMPTY(&qov->stack)) {
222 e = QSLIST_FIRST(&qov->stack);
223 QSLIST_REMOVE_HEAD(&qov->stack, node);
7267c094 224 g_free(e);
e4e6aa14
MR
225 }
226
cb3e7f08 227 qobject_unref(qov->root);
1830f22a 228 g_free(qov);
e4e6aa14
MR
229}
230
7d5e199a 231Visitor *qobject_output_visitor_new(QObject **result)
e4e6aa14 232{
7d5e199a 233 QObjectOutputVisitor *v;
e4e6aa14 234
7267c094 235 v = g_malloc0(sizeof(*v));
e4e6aa14 236
983f52d4 237 v->visitor.type = VISITOR_OUTPUT;
7d5e199a
DB
238 v->visitor.start_struct = qobject_output_start_struct;
239 v->visitor.end_struct = qobject_output_end_struct;
240 v->visitor.start_list = qobject_output_start_list;
241 v->visitor.next_list = qobject_output_next_list;
242 v->visitor.end_list = qobject_output_end_list;
243 v->visitor.type_int64 = qobject_output_type_int64;
244 v->visitor.type_uint64 = qobject_output_type_uint64;
245 v->visitor.type_bool = qobject_output_type_bool;
246 v->visitor.type_str = qobject_output_type_str;
247 v->visitor.type_number = qobject_output_type_number;
248 v->visitor.type_any = qobject_output_type_any;
249 v->visitor.type_null = qobject_output_type_null;
250 v->visitor.complete = qobject_output_complete;
251 v->visitor.free = qobject_output_free;
e4e6aa14 252
3b098d56
EB
253 *result = NULL;
254 v->result = result;
e4e6aa14 255
3b098d56 256 return &v->visitor;
e4e6aa14 257}