Turn on the ability to pass command and event arguments in
a single boxed parameter, which must name a non-empty type
(although the type can be a struct with all optional members).
For structs, it makes it possible to pass a single qapi type
instead of a breakout of all struct members (useful if the
arguments are already in a struct or if the number of members
is large); for other complex types, it is now possible to use
a union or alternate as the data for a command or event.
The empty type may be technically feasible if needed down the
road, but it's easier to forbid it now and relax things to allow
it later, than it is to allow it now and have to special case
how the generated 'q_empty' type is handled (see commit 7ce106a9
for reasons why nothing is generated for the empty type). An
alternate type is never considered empty, but now that a boxed
type can be either an object or an alternate, we have to provide
a trivial QAPISchemaAlternateType.is_empty(). The new call to
arg_type.is_empty() during QAPISchemaCommand.check() requires
that we first check the type in question; but there is no chance
of introducing a cycle since objects do not refer back to commands.
We still have a split in syntax checking between ad-hoc parsing
up front (merely validates that 'boxed' has a sane value) and
during .check() methods (if 'boxed' is set, then 'data' must name
a non-empty user-defined type).
Generated code is unchanged, as long as no client uses the
new feature.
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <1468468228-27827-10-git-send-email-eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Test files renamed to *-boxed-*]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
266 lines
7.7 KiB
C
266 lines
7.7 KiB
C
#include "qemu/osdep.h"
|
|
#include "qemu-common.h"
|
|
#include "qapi/qmp/types.h"
|
|
#include "test-qmp-commands.h"
|
|
#include "qapi/qmp/dispatch.h"
|
|
#include "qemu/module.h"
|
|
#include "qapi/qmp-input-visitor.h"
|
|
#include "tests/test-qapi-types.h"
|
|
#include "tests/test-qapi-visit.h"
|
|
|
|
void qmp_user_def_cmd(Error **errp)
|
|
{
|
|
}
|
|
|
|
Empty2 *qmp_user_def_cmd0(Error **errp)
|
|
{
|
|
return g_new0(Empty2, 1);
|
|
}
|
|
|
|
void qmp_user_def_cmd1(UserDefOne * ud1, Error **errp)
|
|
{
|
|
}
|
|
|
|
UserDefTwo *qmp_user_def_cmd2(UserDefOne *ud1a,
|
|
bool has_udb1, UserDefOne *ud1b,
|
|
Error **errp)
|
|
{
|
|
UserDefTwo *ret;
|
|
UserDefOne *ud1c = g_malloc0(sizeof(UserDefOne));
|
|
UserDefOne *ud1d = g_malloc0(sizeof(UserDefOne));
|
|
|
|
ud1c->string = strdup(ud1a->string);
|
|
ud1c->integer = ud1a->integer;
|
|
ud1d->string = strdup(has_udb1 ? ud1b->string : "blah0");
|
|
ud1d->integer = has_udb1 ? ud1b->integer : 0;
|
|
|
|
ret = g_new0(UserDefTwo, 1);
|
|
ret->string0 = strdup("blah1");
|
|
ret->dict1 = g_new0(UserDefTwoDict, 1);
|
|
ret->dict1->string1 = strdup("blah2");
|
|
ret->dict1->dict2 = g_new0(UserDefTwoDictDict, 1);
|
|
ret->dict1->dict2->userdef = ud1c;
|
|
ret->dict1->dict2->string = strdup("blah3");
|
|
ret->dict1->dict3 = g_new0(UserDefTwoDictDict, 1);
|
|
ret->dict1->has_dict3 = true;
|
|
ret->dict1->dict3->userdef = ud1d;
|
|
ret->dict1->dict3->string = strdup("blah4");
|
|
|
|
return ret;
|
|
}
|
|
|
|
int64_t qmp_guest_get_time(int64_t a, bool has_b, int64_t b, Error **errp)
|
|
{
|
|
return a + (has_b ? b : 0);
|
|
}
|
|
|
|
QObject *qmp_guest_sync(QObject *arg, Error **errp)
|
|
{
|
|
return arg;
|
|
}
|
|
|
|
void qmp_boxed_struct(UserDefZero *arg, Error **errp)
|
|
{
|
|
}
|
|
|
|
void qmp_boxed_union(UserDefNativeListUnion *arg, Error **errp)
|
|
{
|
|
}
|
|
|
|
__org_qemu_x_Union1 *qmp___org_qemu_x_command(__org_qemu_x_EnumList *a,
|
|
__org_qemu_x_StructList *b,
|
|
__org_qemu_x_Union2 *c,
|
|
__org_qemu_x_Alt *d,
|
|
Error **errp)
|
|
{
|
|
__org_qemu_x_Union1 *ret = g_new0(__org_qemu_x_Union1, 1);
|
|
|
|
ret->type = ORG_QEMU_X_UNION1_KIND___ORG_QEMU_X_BRANCH;
|
|
ret->u.__org_qemu_x_branch.data = strdup("blah1");
|
|
|
|
/* Also test that 'wchar-t' was munged to 'q_wchar_t' */
|
|
if (b && b->value && !b->value->has_q_wchar_t) {
|
|
b->value->q_wchar_t = 1;
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
|
|
/* test commands with no input and no return value */
|
|
static void test_dispatch_cmd(void)
|
|
{
|
|
QDict *req = qdict_new();
|
|
QObject *resp;
|
|
|
|
qdict_put_obj(req, "execute", QOBJECT(qstring_from_str("user_def_cmd")));
|
|
|
|
resp = qmp_dispatch(QOBJECT(req));
|
|
assert(resp != NULL);
|
|
assert(!qdict_haskey(qobject_to_qdict(resp), "error"));
|
|
|
|
qobject_decref(resp);
|
|
QDECREF(req);
|
|
}
|
|
|
|
/* test commands that return an error due to invalid parameters */
|
|
static void test_dispatch_cmd_error(void)
|
|
{
|
|
QDict *req = qdict_new();
|
|
QObject *resp;
|
|
|
|
qdict_put_obj(req, "execute", QOBJECT(qstring_from_str("user_def_cmd2")));
|
|
|
|
resp = qmp_dispatch(QOBJECT(req));
|
|
assert(resp != NULL);
|
|
assert(qdict_haskey(qobject_to_qdict(resp), "error"));
|
|
|
|
qobject_decref(resp);
|
|
QDECREF(req);
|
|
}
|
|
|
|
static QObject *test_qmp_dispatch(QDict *req)
|
|
{
|
|
QObject *resp_obj;
|
|
QDict *resp;
|
|
QObject *ret;
|
|
|
|
resp_obj = qmp_dispatch(QOBJECT(req));
|
|
assert(resp_obj);
|
|
resp = qobject_to_qdict(resp_obj);
|
|
assert(resp && !qdict_haskey(resp, "error"));
|
|
ret = qdict_get(resp, "return");
|
|
assert(ret);
|
|
qobject_incref(ret);
|
|
qobject_decref(resp_obj);
|
|
return ret;
|
|
}
|
|
|
|
/* test commands that involve both input parameters and return values */
|
|
static void test_dispatch_cmd_io(void)
|
|
{
|
|
QDict *req = qdict_new();
|
|
QDict *args = qdict_new();
|
|
QDict *args3 = qdict_new();
|
|
QDict *ud1a = qdict_new();
|
|
QDict *ud1b = qdict_new();
|
|
QDict *ret, *ret_dict, *ret_dict_dict, *ret_dict_dict_userdef;
|
|
QDict *ret_dict_dict2, *ret_dict_dict2_userdef;
|
|
QInt *ret3;
|
|
|
|
qdict_put_obj(ud1a, "integer", QOBJECT(qint_from_int(42)));
|
|
qdict_put_obj(ud1a, "string", QOBJECT(qstring_from_str("hello")));
|
|
qdict_put_obj(ud1b, "integer", QOBJECT(qint_from_int(422)));
|
|
qdict_put_obj(ud1b, "string", QOBJECT(qstring_from_str("hello2")));
|
|
qdict_put_obj(args, "ud1a", QOBJECT(ud1a));
|
|
qdict_put_obj(args, "ud1b", QOBJECT(ud1b));
|
|
qdict_put_obj(req, "arguments", QOBJECT(args));
|
|
qdict_put_obj(req, "execute", QOBJECT(qstring_from_str("user_def_cmd2")));
|
|
|
|
ret = qobject_to_qdict(test_qmp_dispatch(req));
|
|
|
|
assert(!strcmp(qdict_get_str(ret, "string0"), "blah1"));
|
|
ret_dict = qdict_get_qdict(ret, "dict1");
|
|
assert(!strcmp(qdict_get_str(ret_dict, "string1"), "blah2"));
|
|
ret_dict_dict = qdict_get_qdict(ret_dict, "dict2");
|
|
ret_dict_dict_userdef = qdict_get_qdict(ret_dict_dict, "userdef");
|
|
assert(qdict_get_int(ret_dict_dict_userdef, "integer") == 42);
|
|
assert(!strcmp(qdict_get_str(ret_dict_dict_userdef, "string"), "hello"));
|
|
assert(!strcmp(qdict_get_str(ret_dict_dict, "string"), "blah3"));
|
|
ret_dict_dict2 = qdict_get_qdict(ret_dict, "dict3");
|
|
ret_dict_dict2_userdef = qdict_get_qdict(ret_dict_dict2, "userdef");
|
|
assert(qdict_get_int(ret_dict_dict2_userdef, "integer") == 422);
|
|
assert(!strcmp(qdict_get_str(ret_dict_dict2_userdef, "string"), "hello2"));
|
|
assert(!strcmp(qdict_get_str(ret_dict_dict2, "string"), "blah4"));
|
|
QDECREF(ret);
|
|
|
|
qdict_put(args3, "a", qint_from_int(66));
|
|
qdict_put(req, "arguments", args3);
|
|
qdict_put(req, "execute", qstring_from_str("guest-get-time"));
|
|
|
|
ret3 = qobject_to_qint(test_qmp_dispatch(req));
|
|
assert(qint_get_int(ret3) == 66);
|
|
QDECREF(ret3);
|
|
|
|
QDECREF(req);
|
|
}
|
|
|
|
/* test generated dealloc functions for generated types */
|
|
static void test_dealloc_types(void)
|
|
{
|
|
UserDefOne *ud1test, *ud1a, *ud1b;
|
|
UserDefOneList *ud1list;
|
|
|
|
ud1test = g_malloc0(sizeof(UserDefOne));
|
|
ud1test->integer = 42;
|
|
ud1test->string = g_strdup("hi there 42");
|
|
|
|
qapi_free_UserDefOne(ud1test);
|
|
|
|
ud1a = g_malloc0(sizeof(UserDefOne));
|
|
ud1a->integer = 43;
|
|
ud1a->string = g_strdup("hi there 43");
|
|
|
|
ud1b = g_malloc0(sizeof(UserDefOne));
|
|
ud1b->integer = 44;
|
|
ud1b->string = g_strdup("hi there 44");
|
|
|
|
ud1list = g_malloc0(sizeof(UserDefOneList));
|
|
ud1list->value = ud1a;
|
|
ud1list->next = g_malloc0(sizeof(UserDefOneList));
|
|
ud1list->next->value = ud1b;
|
|
|
|
qapi_free_UserDefOneList(ud1list);
|
|
}
|
|
|
|
/* test generated deallocation on an object whose construction was prematurely
|
|
* terminated due to an error */
|
|
static void test_dealloc_partial(void)
|
|
{
|
|
static const char text[] = "don't leak me";
|
|
|
|
UserDefTwo *ud2 = NULL;
|
|
Error *err = NULL;
|
|
|
|
/* create partial object */
|
|
{
|
|
QDict *ud2_dict;
|
|
Visitor *v;
|
|
|
|
ud2_dict = qdict_new();
|
|
qdict_put_obj(ud2_dict, "string0", QOBJECT(qstring_from_str(text)));
|
|
|
|
v = qmp_input_visitor_new(QOBJECT(ud2_dict), true);
|
|
visit_type_UserDefTwo(v, NULL, &ud2, &err);
|
|
visit_free(v);
|
|
QDECREF(ud2_dict);
|
|
}
|
|
|
|
/* verify that visit_type_XXX() cleans up properly on error */
|
|
error_free_or_abort(&err);
|
|
assert(!ud2);
|
|
|
|
/* Manually create a partial object, leaving ud2->dict1 at NULL */
|
|
ud2 = g_new0(UserDefTwo, 1);
|
|
ud2->string0 = g_strdup(text);
|
|
|
|
/* tear down partial object */
|
|
qapi_free_UserDefTwo(ud2);
|
|
}
|
|
|
|
|
|
int main(int argc, char **argv)
|
|
{
|
|
g_test_init(&argc, &argv, NULL);
|
|
|
|
g_test_add_func("/0.15/dispatch_cmd", test_dispatch_cmd);
|
|
g_test_add_func("/0.15/dispatch_cmd_error", test_dispatch_cmd_error);
|
|
g_test_add_func("/0.15/dispatch_cmd_io", test_dispatch_cmd_io);
|
|
g_test_add_func("/0.15/dealloc_types", test_dealloc_types);
|
|
g_test_add_func("/0.15/dealloc_partial", test_dealloc_partial);
|
|
|
|
module_call_init(MODULE_INIT_QAPI);
|
|
g_test_run();
|
|
|
|
return 0;
|
|
}
|