2015-08-21 07:04:50 +00:00
|
|
|
/*
|
|
|
|
* String parsing visitor
|
|
|
|
*
|
2018-02-19 17:58:24 +00:00
|
|
|
* Copyright Red Hat, Inc. 2012-2016
|
2015-08-21 07:04:50 +00:00
|
|
|
*
|
|
|
|
* Author: Paolo Bonzini <pbonzini@redhat.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"
|
include/qemu/osdep.h: Don't include qapi/error.h
Commit 57cb38b included qapi/error.h into qemu/osdep.h to get the
Error typedef. Since then, we've moved to include qemu/osdep.h
everywhere. Its file comment explains: "To avoid getting into
possible circular include dependencies, this file should not include
any other QEMU headers, with the exceptions of config-host.h,
compiler.h, os-posix.h and os-win32.h, all of which are doing a
similar job to this file and are under similar constraints."
qapi/error.h doesn't do a similar job, and it doesn't adhere to
similar constraints: it includes qapi-types.h. That's in excess of
100KiB of crap most .c files don't actually need.
Add the typedef to qemu/typedefs.h, and include that instead of
qapi/error.h. Include qapi/error.h in .c files that need it and don't
get it now. Include qapi-types.h in qom/object.h for uint16List.
Update scripts/clean-includes accordingly. Update it further to match
reality: replace config.h by config-target.h, add sysemu/os-posix.h,
sysemu/os-win32.h. Update the list of includes in the qemu/osdep.h
comment quoted above similarly.
This reduces the number of objects depending on qapi/error.h from "all
of them" to less than a third. Unfortunately, the number depending on
qapi-types.h shrinks only a little. More work is needed for that one.
Backports commit da34e65cb4025728566d6504a99916f6e7e1dd6a from qemu
2018-02-22 04:05:15 +00:00
|
|
|
#include "qapi/error.h"
|
2015-08-21 07:04:50 +00:00
|
|
|
#include "qemu-common.h"
|
|
|
|
#include "qapi/string-input-visitor.h"
|
|
|
|
#include "qapi/visitor-impl.h"
|
|
|
|
#include "qapi/qmp/qerror.h"
|
|
|
|
#include "qemu/queue.h"
|
|
|
|
#include "qemu/range.h"
|
2017-01-19 11:50:28 +00:00
|
|
|
#include <stdlib.h> // strtoll
|
2015-08-21 07:04:50 +00:00
|
|
|
|
|
|
|
|
|
|
|
struct StringInputVisitor
|
|
|
|
{
|
|
|
|
Visitor visitor;
|
|
|
|
|
|
|
|
GList *ranges;
|
|
|
|
GList *cur_range;
|
|
|
|
int64_t cur;
|
|
|
|
|
|
|
|
const char *string;
|
|
|
|
};
|
|
|
|
|
2018-02-19 16:47:12 +00:00
|
|
|
static StringInputVisitor *to_siv(Visitor *v)
|
|
|
|
{
|
|
|
|
return container_of(v, StringInputVisitor, visitor);
|
|
|
|
}
|
|
|
|
|
2015-08-21 07:04:50 +00:00
|
|
|
static void free_range(void *range, void *dummy)
|
|
|
|
{
|
2016-12-21 14:28:36 +00:00
|
|
|
g_free(range);
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
|
2018-02-24 00:25:19 +00:00
|
|
|
static int parse_str(StringInputVisitor *siv, const char *name, Error **errp)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
|
|
|
char *str = (char *) siv->string;
|
|
|
|
long long start, end;
|
|
|
|
Range *cur;
|
|
|
|
char *endptr;
|
|
|
|
|
|
|
|
if (siv->ranges) {
|
2018-02-24 00:25:19 +00:00
|
|
|
return 0;
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
do {
|
|
|
|
errno = 0;
|
|
|
|
start = strtoll(str, &endptr, 0);
|
|
|
|
if (errno == 0 && endptr > str) {
|
|
|
|
if (*endptr == '\0') {
|
|
|
|
cur = g_malloc0(sizeof(*cur));
|
|
|
|
cur->begin = start;
|
|
|
|
cur->end = start + 1;
|
|
|
|
siv->ranges = g_list_insert_sorted_merged(siv->ranges, cur,
|
|
|
|
range_compare);
|
|
|
|
cur = NULL;
|
|
|
|
str = NULL;
|
|
|
|
} else if (*endptr == '-') {
|
|
|
|
str = endptr + 1;
|
|
|
|
errno = 0;
|
|
|
|
end = strtoll(str, &endptr, 0);
|
|
|
|
if (errno == 0 && endptr > str && start <= end &&
|
|
|
|
(start > INT64_MAX - 65536 ||
|
|
|
|
end < start + 65536)) {
|
|
|
|
if (*endptr == '\0') {
|
|
|
|
cur = g_malloc0(sizeof(*cur));
|
|
|
|
cur->begin = start;
|
|
|
|
cur->end = end + 1;
|
|
|
|
siv->ranges =
|
|
|
|
g_list_insert_sorted_merged(siv->ranges,
|
|
|
|
cur,
|
|
|
|
range_compare);
|
|
|
|
cur = NULL;
|
|
|
|
str = NULL;
|
|
|
|
} else if (*endptr == ',') {
|
|
|
|
str = endptr + 1;
|
|
|
|
cur = g_malloc0(sizeof(*cur));
|
|
|
|
cur->begin = start;
|
|
|
|
cur->end = end + 1;
|
|
|
|
siv->ranges =
|
|
|
|
g_list_insert_sorted_merged(siv->ranges,
|
|
|
|
cur,
|
|
|
|
range_compare);
|
|
|
|
cur = NULL;
|
|
|
|
} else {
|
|
|
|
goto error;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
goto error;
|
|
|
|
}
|
|
|
|
} else if (*endptr == ',') {
|
|
|
|
str = endptr + 1;
|
|
|
|
cur = g_malloc0(sizeof(*cur));
|
|
|
|
cur->begin = start;
|
|
|
|
cur->end = start + 1;
|
|
|
|
siv->ranges = g_list_insert_sorted_merged(siv->ranges,
|
|
|
|
cur,
|
|
|
|
range_compare);
|
|
|
|
cur = NULL;
|
|
|
|
} else {
|
|
|
|
goto error;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
goto error;
|
|
|
|
}
|
|
|
|
} while (str);
|
|
|
|
|
2018-02-24 00:25:19 +00:00
|
|
|
return 0;
|
2015-08-21 07:04:50 +00:00
|
|
|
error:
|
|
|
|
g_list_foreach(siv->ranges, free_range, NULL);
|
|
|
|
g_list_free(siv->ranges);
|
|
|
|
siv->ranges = NULL;
|
2018-02-24 00:25:19 +00:00
|
|
|
error_setg(errp, QERR_INVALID_PARAMETER_VALUE, name ? name : "null",
|
|
|
|
"an int64 value or range");
|
|
|
|
return -1;
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
qapi: Simplify semantics of visit_next_list()
The semantics of the list visit are somewhat baroque, with the
following pseudocode when FooList is used:
start()
for (prev = head; cur = next(prev); prev = &cur) {
visit(&cur->value)
}
Note that these semantics (advance before visit) requires that
the first call to next() return the list head, while all other
calls return the next element of the list; that is, every visitor
implementation is required to track extra state to decide whether
to return the input as-is, or to advance. It also requires an
argument of 'GenericList **' to next(), solely because the first
iteration might need to modify the caller's GenericList head, so
that all other calls have to do a layer of dereferencing.
Thankfully, we only have two uses of list visits in the entire
code base: one in spapr_drc (which completely avoids
visit_next_list(), feeding in integers from a different source
than uint8List), and one in qapi-visit.py. That is, all other
list visitors are generated in qapi-visit.c, and share the same
paradigm based on a qapi FooList type, so we can refactor how
lists are laid out with minimal churn among clients.
We can greatly simplify things by hoisting the special case
into the start() routine, and flipping the order in the loop
to visit before advance:
start(head)
for (tail = *head; tail; tail = next(tail)) {
visit(&tail->value)
}
With the simpler semantics, visitors have less state to track,
the argument to next() is reduced to 'GenericList *', and it
also becomes obvious whether an input visitor is allocating a
FooList during visit_start_list() (rather than the old way of
not knowing if an allocation happened until the first
visit_next_list()). As a minor drawback, we now allocate in
two functions instead of one, and have to pass the size to
both functions (unless we were to tweak the input visitors to
cache the size to start_list for reuse during next_list, but
that defeats the goal of less visitor state).
The signature of visit_start_list() is chosen to match
visit_start_struct(), with the new parameters after 'name'.
The spapr_drc case is a virtual visit, done by passing NULL for
list, similarly to how NULL is passed to visit_start_struct()
when a qapi type is not used in those visits. It was easy to
provide these semantics for qmp-output and dealloc visitors,
and a bit harder for qmp-input (several prerequisite patches
refactored things to make this patch straightforward). But it
turned out that the string and opts visitors munge enough other
state during visit_next_list() to make it easier to just
document and require a GenericList visit for now; an assertion
will remind us to adjust things if we need the semantics in the
future.
Several pre-requisite cleanup patches made the reshuffling of
the various visitors easier; particularly the qmp input visitor.
Backports commit d9f62dde1303286b24ac8ce88be27e2b9b9c5f46 from qemu
2018-02-24 00:44:26 +00:00
|
|
|
start_list(Visitor *v, const char *name, GenericList **list, size_t size,
|
|
|
|
Error **errp)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
2018-02-19 16:47:12 +00:00
|
|
|
StringInputVisitor *siv = to_siv(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
|
qapi: Simplify semantics of visit_next_list()
The semantics of the list visit are somewhat baroque, with the
following pseudocode when FooList is used:
start()
for (prev = head; cur = next(prev); prev = &cur) {
visit(&cur->value)
}
Note that these semantics (advance before visit) requires that
the first call to next() return the list head, while all other
calls return the next element of the list; that is, every visitor
implementation is required to track extra state to decide whether
to return the input as-is, or to advance. It also requires an
argument of 'GenericList **' to next(), solely because the first
iteration might need to modify the caller's GenericList head, so
that all other calls have to do a layer of dereferencing.
Thankfully, we only have two uses of list visits in the entire
code base: one in spapr_drc (which completely avoids
visit_next_list(), feeding in integers from a different source
than uint8List), and one in qapi-visit.py. That is, all other
list visitors are generated in qapi-visit.c, and share the same
paradigm based on a qapi FooList type, so we can refactor how
lists are laid out with minimal churn among clients.
We can greatly simplify things by hoisting the special case
into the start() routine, and flipping the order in the loop
to visit before advance:
start(head)
for (tail = *head; tail; tail = next(tail)) {
visit(&tail->value)
}
With the simpler semantics, visitors have less state to track,
the argument to next() is reduced to 'GenericList *', and it
also becomes obvious whether an input visitor is allocating a
FooList during visit_start_list() (rather than the old way of
not knowing if an allocation happened until the first
visit_next_list()). As a minor drawback, we now allocate in
two functions instead of one, and have to pass the size to
both functions (unless we were to tweak the input visitors to
cache the size to start_list for reuse during next_list, but
that defeats the goal of less visitor state).
The signature of visit_start_list() is chosen to match
visit_start_struct(), with the new parameters after 'name'.
The spapr_drc case is a virtual visit, done by passing NULL for
list, similarly to how NULL is passed to visit_start_struct()
when a qapi type is not used in those visits. It was easy to
provide these semantics for qmp-output and dealloc visitors,
and a bit harder for qmp-input (several prerequisite patches
refactored things to make this patch straightforward). But it
turned out that the string and opts visitors munge enough other
state during visit_next_list() to make it easier to just
document and require a GenericList visit for now; an assertion
will remind us to adjust things if we need the semantics in the
future.
Several pre-requisite cleanup patches made the reshuffling of
the various visitors easier; particularly the qmp input visitor.
Backports commit d9f62dde1303286b24ac8ce88be27e2b9b9c5f46 from qemu
2018-02-24 00:44:26 +00:00
|
|
|
/* We don't support visits without a list */
|
|
|
|
assert(list);
|
|
|
|
|
2018-02-24 00:25:19 +00:00
|
|
|
if (parse_str(siv, name, errp) < 0) {
|
qapi: Simplify semantics of visit_next_list()
The semantics of the list visit are somewhat baroque, with the
following pseudocode when FooList is used:
start()
for (prev = head; cur = next(prev); prev = &cur) {
visit(&cur->value)
}
Note that these semantics (advance before visit) requires that
the first call to next() return the list head, while all other
calls return the next element of the list; that is, every visitor
implementation is required to track extra state to decide whether
to return the input as-is, or to advance. It also requires an
argument of 'GenericList **' to next(), solely because the first
iteration might need to modify the caller's GenericList head, so
that all other calls have to do a layer of dereferencing.
Thankfully, we only have two uses of list visits in the entire
code base: one in spapr_drc (which completely avoids
visit_next_list(), feeding in integers from a different source
than uint8List), and one in qapi-visit.py. That is, all other
list visitors are generated in qapi-visit.c, and share the same
paradigm based on a qapi FooList type, so we can refactor how
lists are laid out with minimal churn among clients.
We can greatly simplify things by hoisting the special case
into the start() routine, and flipping the order in the loop
to visit before advance:
start(head)
for (tail = *head; tail; tail = next(tail)) {
visit(&tail->value)
}
With the simpler semantics, visitors have less state to track,
the argument to next() is reduced to 'GenericList *', and it
also becomes obvious whether an input visitor is allocating a
FooList during visit_start_list() (rather than the old way of
not knowing if an allocation happened until the first
visit_next_list()). As a minor drawback, we now allocate in
two functions instead of one, and have to pass the size to
both functions (unless we were to tweak the input visitors to
cache the size to start_list for reuse during next_list, but
that defeats the goal of less visitor state).
The signature of visit_start_list() is chosen to match
visit_start_struct(), with the new parameters after 'name'.
The spapr_drc case is a virtual visit, done by passing NULL for
list, similarly to how NULL is passed to visit_start_struct()
when a qapi type is not used in those visits. It was easy to
provide these semantics for qmp-output and dealloc visitors,
and a bit harder for qmp-input (several prerequisite patches
refactored things to make this patch straightforward). But it
turned out that the string and opts visitors munge enough other
state during visit_next_list() to make it easier to just
document and require a GenericList visit for now; an assertion
will remind us to adjust things if we need the semantics in the
future.
Several pre-requisite cleanup patches made the reshuffling of
the various visitors easier; particularly the qmp input visitor.
Backports commit d9f62dde1303286b24ac8ce88be27e2b9b9c5f46 from qemu
2018-02-24 00:44:26 +00:00
|
|
|
*list = NULL;
|
2018-02-24 00:25:19 +00:00
|
|
|
return;
|
|
|
|
}
|
2015-08-21 07:04:50 +00:00
|
|
|
|
|
|
|
siv->cur_range = g_list_first(siv->ranges);
|
|
|
|
if (siv->cur_range) {
|
|
|
|
Range *r = siv->cur_range->data;
|
|
|
|
if (r) {
|
|
|
|
siv->cur = r->begin;
|
|
|
|
}
|
qapi: Simplify semantics of visit_next_list()
The semantics of the list visit are somewhat baroque, with the
following pseudocode when FooList is used:
start()
for (prev = head; cur = next(prev); prev = &cur) {
visit(&cur->value)
}
Note that these semantics (advance before visit) requires that
the first call to next() return the list head, while all other
calls return the next element of the list; that is, every visitor
implementation is required to track extra state to decide whether
to return the input as-is, or to advance. It also requires an
argument of 'GenericList **' to next(), solely because the first
iteration might need to modify the caller's GenericList head, so
that all other calls have to do a layer of dereferencing.
Thankfully, we only have two uses of list visits in the entire
code base: one in spapr_drc (which completely avoids
visit_next_list(), feeding in integers from a different source
than uint8List), and one in qapi-visit.py. That is, all other
list visitors are generated in qapi-visit.c, and share the same
paradigm based on a qapi FooList type, so we can refactor how
lists are laid out with minimal churn among clients.
We can greatly simplify things by hoisting the special case
into the start() routine, and flipping the order in the loop
to visit before advance:
start(head)
for (tail = *head; tail; tail = next(tail)) {
visit(&tail->value)
}
With the simpler semantics, visitors have less state to track,
the argument to next() is reduced to 'GenericList *', and it
also becomes obvious whether an input visitor is allocating a
FooList during visit_start_list() (rather than the old way of
not knowing if an allocation happened until the first
visit_next_list()). As a minor drawback, we now allocate in
two functions instead of one, and have to pass the size to
both functions (unless we were to tweak the input visitors to
cache the size to start_list for reuse during next_list, but
that defeats the goal of less visitor state).
The signature of visit_start_list() is chosen to match
visit_start_struct(), with the new parameters after 'name'.
The spapr_drc case is a virtual visit, done by passing NULL for
list, similarly to how NULL is passed to visit_start_struct()
when a qapi type is not used in those visits. It was easy to
provide these semantics for qmp-output and dealloc visitors,
and a bit harder for qmp-input (several prerequisite patches
refactored things to make this patch straightforward). But it
turned out that the string and opts visitors munge enough other
state during visit_next_list() to make it easier to just
document and require a GenericList visit for now; an assertion
will remind us to adjust things if we need the semantics in the
future.
Several pre-requisite cleanup patches made the reshuffling of
the various visitors easier; particularly the qmp input visitor.
Backports commit d9f62dde1303286b24ac8ce88be27e2b9b9c5f46 from qemu
2018-02-24 00:44:26 +00:00
|
|
|
*list = g_malloc0(size);
|
|
|
|
} else {
|
|
|
|
*list = NULL;
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
qapi: Simplify semantics of visit_next_list()
The semantics of the list visit are somewhat baroque, with the
following pseudocode when FooList is used:
start()
for (prev = head; cur = next(prev); prev = &cur) {
visit(&cur->value)
}
Note that these semantics (advance before visit) requires that
the first call to next() return the list head, while all other
calls return the next element of the list; that is, every visitor
implementation is required to track extra state to decide whether
to return the input as-is, or to advance. It also requires an
argument of 'GenericList **' to next(), solely because the first
iteration might need to modify the caller's GenericList head, so
that all other calls have to do a layer of dereferencing.
Thankfully, we only have two uses of list visits in the entire
code base: one in spapr_drc (which completely avoids
visit_next_list(), feeding in integers from a different source
than uint8List), and one in qapi-visit.py. That is, all other
list visitors are generated in qapi-visit.c, and share the same
paradigm based on a qapi FooList type, so we can refactor how
lists are laid out with minimal churn among clients.
We can greatly simplify things by hoisting the special case
into the start() routine, and flipping the order in the loop
to visit before advance:
start(head)
for (tail = *head; tail; tail = next(tail)) {
visit(&tail->value)
}
With the simpler semantics, visitors have less state to track,
the argument to next() is reduced to 'GenericList *', and it
also becomes obvious whether an input visitor is allocating a
FooList during visit_start_list() (rather than the old way of
not knowing if an allocation happened until the first
visit_next_list()). As a minor drawback, we now allocate in
two functions instead of one, and have to pass the size to
both functions (unless we were to tweak the input visitors to
cache the size to start_list for reuse during next_list, but
that defeats the goal of less visitor state).
The signature of visit_start_list() is chosen to match
visit_start_struct(), with the new parameters after 'name'.
The spapr_drc case is a virtual visit, done by passing NULL for
list, similarly to how NULL is passed to visit_start_struct()
when a qapi type is not used in those visits. It was easy to
provide these semantics for qmp-output and dealloc visitors,
and a bit harder for qmp-input (several prerequisite patches
refactored things to make this patch straightforward). But it
turned out that the string and opts visitors munge enough other
state during visit_next_list() to make it easier to just
document and require a GenericList visit for now; an assertion
will remind us to adjust things if we need the semantics in the
future.
Several pre-requisite cleanup patches made the reshuffling of
the various visitors easier; particularly the qmp input visitor.
Backports commit d9f62dde1303286b24ac8ce88be27e2b9b9c5f46 from qemu
2018-02-24 00:44:26 +00:00
|
|
|
static GenericList *next_list(Visitor *v, GenericList *tail, size_t size)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
2018-02-19 16:47:12 +00:00
|
|
|
StringInputVisitor *siv = to_siv(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
Range *r;
|
|
|
|
|
|
|
|
if (!siv->ranges || !siv->cur_range) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
r = siv->cur_range->data;
|
|
|
|
if (!r) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2017-01-19 11:50:28 +00:00
|
|
|
if ((uint64_t)siv->cur < r->begin || (uint64_t)siv->cur >= r->end) {
|
2015-08-21 07:04:50 +00:00
|
|
|
siv->cur_range = g_list_next(siv->cur_range);
|
|
|
|
if (!siv->cur_range) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
r = siv->cur_range->data;
|
|
|
|
if (!r) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
siv->cur = r->begin;
|
|
|
|
}
|
|
|
|
|
qapi: Simplify semantics of visit_next_list()
The semantics of the list visit are somewhat baroque, with the
following pseudocode when FooList is used:
start()
for (prev = head; cur = next(prev); prev = &cur) {
visit(&cur->value)
}
Note that these semantics (advance before visit) requires that
the first call to next() return the list head, while all other
calls return the next element of the list; that is, every visitor
implementation is required to track extra state to decide whether
to return the input as-is, or to advance. It also requires an
argument of 'GenericList **' to next(), solely because the first
iteration might need to modify the caller's GenericList head, so
that all other calls have to do a layer of dereferencing.
Thankfully, we only have two uses of list visits in the entire
code base: one in spapr_drc (which completely avoids
visit_next_list(), feeding in integers from a different source
than uint8List), and one in qapi-visit.py. That is, all other
list visitors are generated in qapi-visit.c, and share the same
paradigm based on a qapi FooList type, so we can refactor how
lists are laid out with minimal churn among clients.
We can greatly simplify things by hoisting the special case
into the start() routine, and flipping the order in the loop
to visit before advance:
start(head)
for (tail = *head; tail; tail = next(tail)) {
visit(&tail->value)
}
With the simpler semantics, visitors have less state to track,
the argument to next() is reduced to 'GenericList *', and it
also becomes obvious whether an input visitor is allocating a
FooList during visit_start_list() (rather than the old way of
not knowing if an allocation happened until the first
visit_next_list()). As a minor drawback, we now allocate in
two functions instead of one, and have to pass the size to
both functions (unless we were to tweak the input visitors to
cache the size to start_list for reuse during next_list, but
that defeats the goal of less visitor state).
The signature of visit_start_list() is chosen to match
visit_start_struct(), with the new parameters after 'name'.
The spapr_drc case is a virtual visit, done by passing NULL for
list, similarly to how NULL is passed to visit_start_struct()
when a qapi type is not used in those visits. It was easy to
provide these semantics for qmp-output and dealloc visitors,
and a bit harder for qmp-input (several prerequisite patches
refactored things to make this patch straightforward). But it
turned out that the string and opts visitors munge enough other
state during visit_next_list() to make it easier to just
document and require a GenericList visit for now; an assertion
will remind us to adjust things if we need the semantics in the
future.
Several pre-requisite cleanup patches made the reshuffling of
the various visitors easier; particularly the qmp input visitor.
Backports commit d9f62dde1303286b24ac8ce88be27e2b9b9c5f46 from qemu
2018-02-24 00:44:26 +00:00
|
|
|
tail->next = g_malloc0(size);
|
|
|
|
return tail->next;
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
|
qapi: Simplify semantics of visit_next_list()
The semantics of the list visit are somewhat baroque, with the
following pseudocode when FooList is used:
start()
for (prev = head; cur = next(prev); prev = &cur) {
visit(&cur->value)
}
Note that these semantics (advance before visit) requires that
the first call to next() return the list head, while all other
calls return the next element of the list; that is, every visitor
implementation is required to track extra state to decide whether
to return the input as-is, or to advance. It also requires an
argument of 'GenericList **' to next(), solely because the first
iteration might need to modify the caller's GenericList head, so
that all other calls have to do a layer of dereferencing.
Thankfully, we only have two uses of list visits in the entire
code base: one in spapr_drc (which completely avoids
visit_next_list(), feeding in integers from a different source
than uint8List), and one in qapi-visit.py. That is, all other
list visitors are generated in qapi-visit.c, and share the same
paradigm based on a qapi FooList type, so we can refactor how
lists are laid out with minimal churn among clients.
We can greatly simplify things by hoisting the special case
into the start() routine, and flipping the order in the loop
to visit before advance:
start(head)
for (tail = *head; tail; tail = next(tail)) {
visit(&tail->value)
}
With the simpler semantics, visitors have less state to track,
the argument to next() is reduced to 'GenericList *', and it
also becomes obvious whether an input visitor is allocating a
FooList during visit_start_list() (rather than the old way of
not knowing if an allocation happened until the first
visit_next_list()). As a minor drawback, we now allocate in
two functions instead of one, and have to pass the size to
both functions (unless we were to tweak the input visitors to
cache the size to start_list for reuse during next_list, but
that defeats the goal of less visitor state).
The signature of visit_start_list() is chosen to match
visit_start_struct(), with the new parameters after 'name'.
The spapr_drc case is a virtual visit, done by passing NULL for
list, similarly to how NULL is passed to visit_start_struct()
when a qapi type is not used in those visits. It was easy to
provide these semantics for qmp-output and dealloc visitors,
and a bit harder for qmp-input (several prerequisite patches
refactored things to make this patch straightforward). But it
turned out that the string and opts visitors munge enough other
state during visit_next_list() to make it easier to just
document and require a GenericList visit for now; an assertion
will remind us to adjust things if we need the semantics in the
future.
Several pre-requisite cleanup patches made the reshuffling of
the various visitors easier; particularly the qmp input visitor.
Backports commit d9f62dde1303286b24ac8ce88be27e2b9b9c5f46 from qemu
2018-02-24 00:44:26 +00:00
|
|
|
static void end_list(Visitor *v)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2018-02-20 04:28:33 +00:00
|
|
|
static void parse_type_int64(Visitor *v, const char *name, int64_t *obj,
|
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
|
|
|
Error **errp)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
2018-02-19 16:47:12 +00:00
|
|
|
StringInputVisitor *siv = to_siv(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
|
|
|
|
if (!siv->string) {
|
2018-02-13 22:34:32 +00:00
|
|
|
error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
|
|
|
|
"integer");
|
2015-08-21 07:04:50 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2018-02-24 00:25:19 +00:00
|
|
|
if (parse_str(siv, name, errp) < 0) {
|
|
|
|
return;
|
|
|
|
}
|
2015-08-21 07:04:50 +00:00
|
|
|
|
|
|
|
if (!siv->ranges) {
|
|
|
|
goto error;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!siv->cur_range) {
|
|
|
|
Range *r;
|
|
|
|
|
|
|
|
siv->cur_range = g_list_first(siv->ranges);
|
|
|
|
if (!siv->cur_range) {
|
|
|
|
goto error;
|
|
|
|
}
|
|
|
|
|
|
|
|
r = siv->cur_range->data;
|
|
|
|
if (!r) {
|
|
|
|
goto error;
|
|
|
|
}
|
|
|
|
|
|
|
|
siv->cur = r->begin;
|
|
|
|
}
|
|
|
|
|
|
|
|
*obj = siv->cur;
|
|
|
|
siv->cur++;
|
|
|
|
return;
|
|
|
|
|
|
|
|
error:
|
2018-02-13 22:34:32 +00:00
|
|
|
error_setg(errp, QERR_INVALID_PARAMETER_VALUE, name,
|
|
|
|
"an int64 value or range");
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
|
2018-02-20 04:28:33 +00:00
|
|
|
static void parse_type_uint64(Visitor *v, const char *name, uint64_t *obj,
|
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
|
|
|
Error **errp)
|
|
|
|
{
|
|
|
|
/* FIXME: parse_type_int64 mishandles values over INT64_MAX */
|
|
|
|
int64_t i;
|
|
|
|
Error *err = NULL;
|
2018-02-20 04:28:33 +00:00
|
|
|
parse_type_int64(v, name, &i, &err);
|
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
|
|
|
if (err) {
|
|
|
|
error_propagate(errp, err);
|
|
|
|
} else {
|
|
|
|
*obj = i;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-02-20 04:28:33 +00:00
|
|
|
static void parse_type_bool(Visitor *v, const char *name, bool *obj,
|
2015-08-21 07:04:50 +00:00
|
|
|
Error **errp)
|
|
|
|
{
|
2018-02-19 16:47:12 +00:00
|
|
|
StringInputVisitor *siv = to_siv(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
|
|
|
|
if (siv->string) {
|
|
|
|
if (!strcasecmp(siv->string, "on") ||
|
|
|
|
!strcasecmp(siv->string, "yes") ||
|
|
|
|
!strcasecmp(siv->string, "true")) {
|
|
|
|
*obj = true;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if (!strcasecmp(siv->string, "off") ||
|
|
|
|
!strcasecmp(siv->string, "no") ||
|
|
|
|
!strcasecmp(siv->string, "false")) {
|
|
|
|
*obj = false;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-02-13 22:34:32 +00:00
|
|
|
error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
|
|
|
|
"boolean");
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
|
2018-02-20 04:28:33 +00:00
|
|
|
static void parse_type_str(Visitor *v, const char *name, char **obj,
|
2015-08-21 07:04:50 +00:00
|
|
|
Error **errp)
|
|
|
|
{
|
2018-02-19 16:47:12 +00:00
|
|
|
StringInputVisitor *siv = to_siv(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
if (siv->string) {
|
|
|
|
*obj = g_strdup(siv->string);
|
|
|
|
} else {
|
2018-02-23 19:53:21 +00:00
|
|
|
*obj = NULL;
|
2018-02-13 22:34:32 +00:00
|
|
|
error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
|
|
|
|
"string");
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-02-20 04:28:33 +00:00
|
|
|
static void parse_type_number(Visitor *v, const char *name, double *obj,
|
2015-08-21 07:04:50 +00:00
|
|
|
Error **errp)
|
|
|
|
{
|
2018-02-19 16:47:12 +00:00
|
|
|
StringInputVisitor *siv = to_siv(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
char *endp = (char *) siv->string;
|
|
|
|
double val;
|
|
|
|
|
|
|
|
errno = 0;
|
|
|
|
if (siv->string) {
|
|
|
|
val = strtod(siv->string, &endp);
|
|
|
|
}
|
|
|
|
if (!siv->string || errno || endp == siv->string || *endp) {
|
2018-02-13 22:34:32 +00:00
|
|
|
error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
|
|
|
|
"number");
|
2015-08-21 07:04:50 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
*obj = val;
|
|
|
|
}
|
|
|
|
|
2018-02-20 04:28:33 +00:00
|
|
|
static void parse_optional(Visitor *v, const char *name, bool *present)
|
2015-08-21 07:04:50 +00:00
|
|
|
{
|
2018-02-19 16:47:12 +00:00
|
|
|
StringInputVisitor *siv = to_siv(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
|
|
|
|
if (!siv->string) {
|
|
|
|
*present = false;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
*present = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
Visitor *string_input_get_visitor(StringInputVisitor *v)
|
|
|
|
{
|
|
|
|
return &v->visitor;
|
|
|
|
}
|
|
|
|
|
|
|
|
void string_input_visitor_cleanup(StringInputVisitor *v)
|
|
|
|
{
|
|
|
|
g_list_foreach(v->ranges, free_range, NULL);
|
|
|
|
g_list_free(v->ranges);
|
2016-12-21 14:28:36 +00:00
|
|
|
g_free(v);
|
2015-08-21 07:04:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
StringInputVisitor *string_input_visitor_new(const char *str)
|
|
|
|
{
|
|
|
|
StringInputVisitor *v;
|
|
|
|
|
|
|
|
v = g_malloc0(sizeof(*v));
|
|
|
|
|
2018-02-23 19:25:19 +00:00
|
|
|
v->visitor.type = VISITOR_INPUT;
|
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 = parse_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 = parse_type_uint64;
|
2017-01-10 04:57:12 +00:00
|
|
|
v->visitor.type_size = NULL;
|
2015-08-21 07:04:50 +00:00
|
|
|
v->visitor.type_bool = parse_type_bool;
|
|
|
|
v->visitor.type_str = parse_type_str;
|
|
|
|
v->visitor.type_number = parse_type_number;
|
|
|
|
v->visitor.start_list = start_list;
|
|
|
|
v->visitor.next_list = next_list;
|
|
|
|
v->visitor.end_list = end_list;
|
|
|
|
v->visitor.optional = parse_optional;
|
|
|
|
|
|
|
|
v->string = str;
|
|
|
|
return v;
|
|
|
|
}
|