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
{
35 QSLIST_HEAD(, QStackEntry
) stack
; /* Stack of unfinished containers */
36 QObject
*root
; /* Root of the output visit */
37 QObject
**result
; /* User's storage location for result */
40 #define qobject_output_add(qov, name, value) \
41 qobject_output_add_obj(qov, name, QOBJECT(value))
42 #define qobject_output_push(qov, value, qapi) \
43 qobject_output_push_obj(qov, QOBJECT(value), qapi)
45 static QObjectOutputVisitor
*to_qov(Visitor
*v
)
47 return container_of(v
, QObjectOutputVisitor
, visitor
);
50 /* Push @value onto the stack of current QObjects being built */
51 static void qobject_output_push_obj(QObjectOutputVisitor
*qov
, QObject
*value
,
54 QStackEntry
*e
= g_malloc0(sizeof(*e
));
60 QSLIST_INSERT_HEAD(&qov
->stack
, e
, node
);
63 /* Pop a value off the stack of QObjects being built, and return it. */
64 static QObject
*qobject_output_pop(QObjectOutputVisitor
*qov
, void *qapi
)
66 QStackEntry
*e
= QSLIST_FIRST(&qov
->stack
);
70 assert(e
->qapi
== qapi
);
71 QSLIST_REMOVE_HEAD(&qov
->stack
, node
);
78 /* Add @value to the current QObject being built.
79 * If the stack is visiting a dictionary or list, @value is now owned
80 * by that container. Otherwise, @value is now the root. */
81 static void qobject_output_add_obj(QObjectOutputVisitor
*qov
, const char *name
,
84 QStackEntry
*e
= QSLIST_FIRST(&qov
->stack
);
85 QObject
*cur
= e
? e
->value
: NULL
;
88 /* Don't allow reuse of visitor on more than one root */
92 switch (qobject_type(cur
)) {
95 qdict_put_obj(qobject_to(QDict
, cur
), name
, value
);
99 qlist_append_obj(qobject_to(QList
, cur
), value
);
102 g_assert_not_reached();
107 static bool qobject_output_start_struct(Visitor
*v
, const char *name
,
108 void **obj
, size_t unused
, Error
**errp
)
110 QObjectOutputVisitor
*qov
= to_qov(v
);
111 QDict
*dict
= qdict_new();
113 qobject_output_add(qov
, name
, dict
);
114 qobject_output_push(qov
, dict
, obj
);
118 static void qobject_output_end_struct(Visitor
*v
, void **obj
)
120 QObjectOutputVisitor
*qov
= to_qov(v
);
121 QObject
*value
= qobject_output_pop(qov
, obj
);
122 assert(qobject_type(value
) == QTYPE_QDICT
);
125 static bool qobject_output_start_list(Visitor
*v
, const char *name
,
126 GenericList
**listp
, size_t size
,
129 QObjectOutputVisitor
*qov
= to_qov(v
);
130 QList
*list
= qlist_new();
132 qobject_output_add(qov
, name
, list
);
133 qobject_output_push(qov
, list
, listp
);
137 static GenericList
*qobject_output_next_list(Visitor
*v
, GenericList
*tail
,
143 static void qobject_output_end_list(Visitor
*v
, void **obj
)
145 QObjectOutputVisitor
*qov
= to_qov(v
);
146 QObject
*value
= qobject_output_pop(qov
, obj
);
147 assert(qobject_type(value
) == QTYPE_QLIST
);
150 static bool qobject_output_type_int64(Visitor
*v
, const char *name
,
151 int64_t *obj
, Error
**errp
)
153 QObjectOutputVisitor
*qov
= to_qov(v
);
154 qobject_output_add(qov
, name
, qnum_from_int(*obj
));
158 static bool qobject_output_type_uint64(Visitor
*v
, const char *name
,
159 uint64_t *obj
, Error
**errp
)
161 QObjectOutputVisitor
*qov
= to_qov(v
);
162 qobject_output_add(qov
, name
, qnum_from_uint(*obj
));
166 static bool qobject_output_type_bool(Visitor
*v
, const char *name
, bool *obj
,
169 QObjectOutputVisitor
*qov
= to_qov(v
);
170 qobject_output_add(qov
, name
, qbool_from_bool(*obj
));
174 static bool qobject_output_type_str(Visitor
*v
, const char *name
, char **obj
,
177 QObjectOutputVisitor
*qov
= to_qov(v
);
179 qobject_output_add(qov
, name
, qstring_from_str(*obj
));
181 qobject_output_add(qov
, name
, qstring_from_str(""));
186 static bool qobject_output_type_number(Visitor
*v
, const char *name
,
187 double *obj
, Error
**errp
)
189 QObjectOutputVisitor
*qov
= to_qov(v
);
190 qobject_output_add(qov
, name
, qnum_from_double(*obj
));
194 static bool qobject_output_type_any(Visitor
*v
, const char *name
,
195 QObject
**obj
, Error
**errp
)
197 QObjectOutputVisitor
*qov
= to_qov(v
);
199 qobject_output_add_obj(qov
, name
, qobject_ref(*obj
));
203 static bool qobject_output_type_null(Visitor
*v
, const char *name
,
204 QNull
**obj
, Error
**errp
)
206 QObjectOutputVisitor
*qov
= to_qov(v
);
207 qobject_output_add(qov
, name
, qnull());
211 static bool qobject_output_deprecated(Visitor
*v
, const char *name
)
213 return v
->compat_policy
.deprecated_output
!= COMPAT_POLICY_OUTPUT_HIDE
;
216 /* Finish building, and return the root object.
217 * The root object is never null. The caller becomes the object's
218 * owner, and should use qobject_unref() when done with it. */
219 static void qobject_output_complete(Visitor
*v
, void *opaque
)
221 QObjectOutputVisitor
*qov
= to_qov(v
);
223 /* A visit must have occurred, with each start paired with end. */
224 assert(qov
->root
&& QSLIST_EMPTY(&qov
->stack
));
225 assert(opaque
== qov
->result
);
227 *qov
->result
= qobject_ref(qov
->root
);
231 static void qobject_output_free(Visitor
*v
)
233 QObjectOutputVisitor
*qov
= to_qov(v
);
236 while (!QSLIST_EMPTY(&qov
->stack
)) {
237 e
= QSLIST_FIRST(&qov
->stack
);
238 QSLIST_REMOVE_HEAD(&qov
->stack
, node
);
242 qobject_unref(qov
->root
);
246 Visitor
*qobject_output_visitor_new(QObject
**result
)
248 QObjectOutputVisitor
*v
;
250 v
= g_malloc0(sizeof(*v
));
252 v
->visitor
.type
= VISITOR_OUTPUT
;
253 v
->visitor
.start_struct
= qobject_output_start_struct
;
254 v
->visitor
.end_struct
= qobject_output_end_struct
;
255 v
->visitor
.start_list
= qobject_output_start_list
;
256 v
->visitor
.next_list
= qobject_output_next_list
;
257 v
->visitor
.end_list
= qobject_output_end_list
;
258 v
->visitor
.type_int64
= qobject_output_type_int64
;
259 v
->visitor
.type_uint64
= qobject_output_type_uint64
;
260 v
->visitor
.type_bool
= qobject_output_type_bool
;
261 v
->visitor
.type_str
= qobject_output_type_str
;
262 v
->visitor
.type_number
= qobject_output_type_number
;
263 v
->visitor
.type_any
= qobject_output_type_any
;
264 v
->visitor
.type_null
= qobject_output_type_null
;
265 v
->visitor
.deprecated
= qobject_output_deprecated
;
266 v
->visitor
.complete
= qobject_output_complete
;
267 v
->visitor
.free
= qobject_output_free
;