2015-08-21 07:04:50 +00:00
|
|
|
/*
|
|
|
|
* Dealloc Visitor
|
|
|
|
*
|
|
|
|
* Copyright IBM, Corp. 2011
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Michael Roth <mdroth@linux.vnet.ibm.com>
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
|
|
|
|
* See the COPYING.LIB file in the top-level directory.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2018-02-19 06:29:26 +00:00
|
|
|
#include "qemu/osdep.h"
|
2015-08-21 07:04:50 +00:00
|
|
|
#include "qapi/dealloc-visitor.h"
|
|
|
|
#include "qemu/queue.h"
|
|
|
|
#include "qemu-common.h"
|
|
|
|
#include "qapi/qmp/types.h"
|
|
|
|
#include "qapi/visitor-impl.h"
|
|
|
|
|
|
|
|
typedef struct StackEntry
|
|
|
|
{
|
|
|
|
void *value;
|
|
|
|
bool is_list_head;
|
|
|
|
QTAILQ_ENTRY(StackEntry) node;
|
|
|
|
} StackEntry;
|
|
|
|
|
|
|
|
struct QapiDeallocVisitor
|
|
|
|
{
|
|
|
|
Visitor visitor;
|
|
|
|
QTAILQ_HEAD(, StackEntry) stack;
|
|
|
|
bool is_list_head;
|
|
|
|
};
|
|
|
|
|
|
|
|
static QapiDeallocVisitor *to_qov(Visitor *v)
|
|
|
|
{
|
|
|
|
return container_of(v, QapiDeallocVisitor, visitor);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_push(QapiDeallocVisitor *qov, void *value)
|
|
|
|
{
|
|
|
|
StackEntry *e = g_malloc0(sizeof(*e));
|
|
|
|
|
|
|
|
e->value = value;
|
|
|
|
|
|
|
|
/* see if we're just pushing a list head tracker */
|
|
|
|
if (value == NULL) {
|
|
|
|
e->is_list_head = true;
|
|
|
|
}
|
|
|
|
QTAILQ_INSERT_HEAD(&qov->stack, e, node);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void *qapi_dealloc_pop(QapiDeallocVisitor *qov)
|
|
|
|
{
|
|
|
|
StackEntry *e = QTAILQ_FIRST(&qov->stack);
|
|
|
|
QObject *value;
|
|
|
|
QTAILQ_REMOVE(&qov->stack, e, node);
|
|
|
|
value = e->value;
|
2016-12-21 14:28:36 +00:00
|
|
|
g_free(e);
|
2015-08-21 07:04:50 +00:00
|
|
|
return value;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_start_struct(Visitor *v, void **obj, const char *kind,
|
|
|
|
const char *name, size_t unused,
|
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
QapiDeallocVisitor *qov = to_qov(v);
|
|
|
|
qapi_dealloc_push(qov, obj);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_end_struct(Visitor *v, Error **errp)
|
|
|
|
{
|
|
|
|
QapiDeallocVisitor *qov = to_qov(v);
|
|
|
|
void **obj = qapi_dealloc_pop(qov);
|
|
|
|
if (obj) {
|
2016-12-21 14:28:36 +00:00
|
|
|
g_free(*obj);
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_start_implicit_struct(Visitor *v,
|
|
|
|
void **obj,
|
|
|
|
size_t size,
|
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
QapiDeallocVisitor *qov = to_qov(v);
|
|
|
|
qapi_dealloc_push(qov, obj);
|
|
|
|
}
|
|
|
|
|
2018-02-19 17:58:24 +00:00
|
|
|
static void qapi_dealloc_end_implicit_struct(Visitor *v)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
|
|
|
QapiDeallocVisitor *qov = to_qov(v);
|
|
|
|
void **obj = qapi_dealloc_pop(qov);
|
|
|
|
if (obj) {
|
2016-12-21 14:28:36 +00:00
|
|
|
g_free(*obj);
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_start_list(Visitor *v, const char *name, Error **errp)
|
|
|
|
{
|
|
|
|
QapiDeallocVisitor *qov = to_qov(v);
|
|
|
|
qapi_dealloc_push(qov, NULL);
|
|
|
|
}
|
|
|
|
|
2018-02-19 17:58:24 +00:00
|
|
|
static GenericList *qapi_dealloc_next_list(Visitor *v, GenericList **listp)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
|
|
|
GenericList *list = *listp;
|
|
|
|
QapiDeallocVisitor *qov = to_qov(v);
|
|
|
|
StackEntry *e = QTAILQ_FIRST(&qov->stack);
|
|
|
|
|
|
|
|
if (e && e->is_list_head) {
|
|
|
|
e->is_list_head = false;
|
|
|
|
return list;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (list) {
|
|
|
|
list = list->next;
|
2016-12-21 14:28:36 +00:00
|
|
|
g_free(*listp);
|
2015-08-21 07:04:50 +00:00
|
|
|
return list;
|
|
|
|
}
|
|
|
|
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2018-02-19 17:58:24 +00:00
|
|
|
static void qapi_dealloc_end_list(Visitor *v)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
|
|
|
QapiDeallocVisitor *qov = to_qov(v);
|
|
|
|
void *obj = qapi_dealloc_pop(qov);
|
|
|
|
assert(obj == NULL); /* should've been list head tracker with no payload */
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_type_str(Visitor *v, char **obj, const char *name,
|
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
if (obj) {
|
2016-12-21 14:28:36 +00:00
|
|
|
g_free(*obj);
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
qapi: Prefer type_int64 over type_int in visitors
The qapi builtin type 'int' is basically shorthand for the type
'int64'. In fact, since no visitor was providing the optional
type_int64() callback, visit_type_int64() was just always falling
back to type_int(), cementing the equivalence between the types.
However, some visitors are providing a type_uint64() callback.
For purposes of code consistency, it is nicer if all visitors
use the paired type_int64/type_uint64 names rather than the
mismatched type_int/type_uint64. So this patch just renames
the signed int callbacks in place, dropping the type_int()
callback as redundant, and a later patch will focus on the
unsigned int callbacks.
Add some FIXMEs to questionable reuse of errp in code touched
by the rename, while at it (the reuse works as long as the
callbacks don't modify value when setting an error, but it's not
a good example to set) - a later patch will then fix those.
No change in functionality here, although further cleanups are
in the pipeline.
Backports commit 4c40314a35816de635e7170eaacdc0c35be83a8a from qemu
2018-02-19 16:53:19 +00:00
|
|
|
static void qapi_dealloc_type_int64(Visitor *v, int64_t *obj, const char *name,
|
|
|
|
Error **errp)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
qapi: Make all visitors supply uint64 callbacks
Our qapi visitor contract supports multiple integer visitors,
but left the type_uint64 visitor as optional (falling back on
type_int64); which in turn can lead to awkward behavior with
numbers larger than INT64_MAX (the user has to be aware of
twos complement, and deal with negatives).
This patch does not address the disparity in handling large
values as negatives. It merely moves the fallback from uint64
to int64 from the visitor core to the visitors, where the issue
can actually be fixed, by implementing the missing type_uint64()
callbacks on top of the respective type_int64() callbacks, and
with a FIXME comment explaining why that's wrong.
With that done, we now have a type_uint64() callback in every
driver, so we can make it mandatory from the core. And although
the type_int64() callback can cover the entire valid range of
type_uint{8,16,32} on valid user input, using type_uint64() to
avoid mixed signedness makes more sense.
Backports commit f755dea79dc81b0d6a8f6414e0672e165e28d8ba from qemu
2018-02-19 16:57:56 +00:00
|
|
|
static void qapi_dealloc_type_uint64(Visitor *v, uint64_t *obj,
|
|
|
|
const char *name, Error **errp)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2015-08-21 07:04:50 +00:00
|
|
|
static void qapi_dealloc_type_bool(Visitor *v, bool *obj, const char *name,
|
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_type_number(Visitor *v, double *obj, const char *name,
|
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_type_size(Visitor *v, uint64_t *obj, const char *name,
|
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
static void qapi_dealloc_type_enum(Visitor *v, int *obj, const char *strings[],
|
|
|
|
const char *kind, const char *name,
|
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
/* If there's no data present, the dealloc visitor has nothing to free.
|
|
|
|
* Thus, indicate to visitor code that the subsequent union fields can
|
|
|
|
* be skipped. This is not an error condition, since the cleanup of the
|
|
|
|
* rest of an object can continue unhindered, so leave errp unset in
|
|
|
|
* these cases.
|
|
|
|
*
|
|
|
|
* NOTE: In cases where we're attempting to deallocate an object that
|
|
|
|
* may have missing fields, the field indicating the union type may
|
|
|
|
* be missing. In such a case, it's possible we don't have enough
|
|
|
|
* information to differentiate data_present == false from a case where
|
|
|
|
* data *is* present but happens to be a scalar with a value of 0.
|
|
|
|
* This is okay, since in the case of the dealloc visitor there's no
|
|
|
|
* work that needs to done in either situation.
|
|
|
|
*
|
|
|
|
* The current inability in QAPI code to more thoroughly verify a union
|
|
|
|
* type in such cases will likely need to be addressed if we wish to
|
|
|
|
* implement this interface for other types of visitors in the future,
|
|
|
|
* however.
|
|
|
|
*/
|
|
|
|
static bool qapi_dealloc_start_union(Visitor *v, bool data_present,
|
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
return data_present;
|
|
|
|
}
|
|
|
|
|
|
|
|
Visitor *qapi_dealloc_get_visitor(QapiDeallocVisitor *v)
|
|
|
|
{
|
|
|
|
return &v->visitor;
|
|
|
|
}
|
|
|
|
|
|
|
|
void qapi_dealloc_visitor_cleanup(QapiDeallocVisitor *v)
|
|
|
|
{
|
2016-12-21 14:28:36 +00:00
|
|
|
g_free(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
QapiDeallocVisitor *qapi_dealloc_visitor_new(void)
|
|
|
|
{
|
|
|
|
QapiDeallocVisitor *v;
|
|
|
|
|
|
|
|
v = g_malloc0(sizeof(*v));
|
|
|
|
|
|
|
|
v->visitor.start_struct = qapi_dealloc_start_struct;
|
|
|
|
v->visitor.end_struct = qapi_dealloc_end_struct;
|
|
|
|
v->visitor.start_implicit_struct = qapi_dealloc_start_implicit_struct;
|
|
|
|
v->visitor.end_implicit_struct = qapi_dealloc_end_implicit_struct;
|
|
|
|
v->visitor.start_list = qapi_dealloc_start_list;
|
|
|
|
v->visitor.next_list = qapi_dealloc_next_list;
|
|
|
|
v->visitor.end_list = qapi_dealloc_end_list;
|
|
|
|
v->visitor.type_enum = qapi_dealloc_type_enum;
|
qapi: Prefer type_int64 over type_int in visitors
The qapi builtin type 'int' is basically shorthand for the type
'int64'. In fact, since no visitor was providing the optional
type_int64() callback, visit_type_int64() was just always falling
back to type_int(), cementing the equivalence between the types.
However, some visitors are providing a type_uint64() callback.
For purposes of code consistency, it is nicer if all visitors
use the paired type_int64/type_uint64 names rather than the
mismatched type_int/type_uint64. So this patch just renames
the signed int callbacks in place, dropping the type_int()
callback as redundant, and a later patch will focus on the
unsigned int callbacks.
Add some FIXMEs to questionable reuse of errp in code touched
by the rename, while at it (the reuse works as long as the
callbacks don't modify value when setting an error, but it's not
a good example to set) - a later patch will then fix those.
No change in functionality here, although further cleanups are
in the pipeline.
Backports commit 4c40314a35816de635e7170eaacdc0c35be83a8a from qemu
2018-02-19 16:53:19 +00:00
|
|
|
v->visitor.type_int64 = qapi_dealloc_type_int64;
|
qapi: Make all visitors supply uint64 callbacks
Our qapi visitor contract supports multiple integer visitors,
but left the type_uint64 visitor as optional (falling back on
type_int64); which in turn can lead to awkward behavior with
numbers larger than INT64_MAX (the user has to be aware of
twos complement, and deal with negatives).
This patch does not address the disparity in handling large
values as negatives. It merely moves the fallback from uint64
to int64 from the visitor core to the visitors, where the issue
can actually be fixed, by implementing the missing type_uint64()
callbacks on top of the respective type_int64() callbacks, and
with a FIXME comment explaining why that's wrong.
With that done, we now have a type_uint64() callback in every
driver, so we can make it mandatory from the core. And although
the type_int64() callback can cover the entire valid range of
type_uint{8,16,32} on valid user input, using type_uint64() to
avoid mixed signedness makes more sense.
Backports commit f755dea79dc81b0d6a8f6414e0672e165e28d8ba from qemu
2018-02-19 16:57:56 +00:00
|
|
|
v->visitor.type_uint64 = qapi_dealloc_type_uint64;
|
2015-08-21 07:04:50 +00:00
|
|
|
v->visitor.type_bool = qapi_dealloc_type_bool;
|
|
|
|
v->visitor.type_str = qapi_dealloc_type_str;
|
|
|
|
v->visitor.type_number = qapi_dealloc_type_number;
|
|
|
|
v->visitor.type_size = qapi_dealloc_type_size;
|
|
|
|
v->visitor.start_union = qapi_dealloc_start_union;
|
|
|
|
|
|
|
|
QTAILQ_INIT(&v->stack);
|
|
|
|
|
|
|
|
return v;
|
|
|
|
}
|