51e72bc1dd
JSON uses "name":value, but many of our visitor interfaces were called with visit_type_FOO(v, &value, name, errp). This can be a bit confusing to have to mentally swap the parameter order to match JSON order. It's particularly bad for visit_start_struct(), where the 'name' parameter is smack in the middle of the otherwise-related group of 'obj, kind, size' parameters! It's time to do a global swap of the parameter ordering, so that the 'name' parameter is always immediately after the Visitor argument. Additional reason in favor of the swap: the existing include/qjson.h prefers listing 'name' first in json_prop_*(), and I have plans to unify that file with the qapi visitors; listing 'name' first in qapi will minimize churn to the (admittedly few) qjson.h clients. Later patches will then fix docs, object.h, visitor-impl.h, and those clients to match. Done by first patching scripts/qapi*.py by hand to make generated files do what I want, then by running the following Coccinelle script to affect the rest of the code base: $ spatch --sp-file script `git grep -l '\bvisit_' -- '**/*.[ch]'` I then had to apply some touchups (Coccinelle insisted on TAB indentation in visitor.h, and botched the signature of visit_type_enum() by rewriting 'const char *const strings[]' to the syntactically invalid 'const char*const[] strings'). The movement of parameters is sufficient to provoke compiler errors if any callers were missed. // Part 1: Swap declaration order @@ type TV, TErr, TObj, T1, T2; identifier OBJ, ARG1, ARG2; @@ void visit_start_struct -(TV v, TObj OBJ, T1 ARG1, const char *name, T2 ARG2, TErr errp) +(TV v, const char *name, TObj OBJ, T1 ARG1, T2 ARG2, TErr errp) { ... } @@ type bool, TV, T1; identifier ARG1; @@ bool visit_optional -(TV v, T1 ARG1, const char *name) +(TV v, const char *name, T1 ARG1) { ... } @@ type TV, TErr, TObj, T1; identifier OBJ, ARG1; @@ void visit_get_next_type -(TV v, TObj OBJ, T1 ARG1, const char *name, TErr errp) +(TV v, const char *name, TObj OBJ, T1 ARG1, TErr errp) { ... } @@ type TV, TErr, TObj, T1, T2; identifier OBJ, ARG1, ARG2; @@ void visit_type_enum -(TV v, TObj OBJ, T1 ARG1, T2 ARG2, const char *name, TErr errp) +(TV v, const char *name, TObj OBJ, T1 ARG1, T2 ARG2, TErr errp) { ... } @@ type TV, TErr, TObj; identifier OBJ; identifier VISIT_TYPE =~ "^visit_type_"; @@ void VISIT_TYPE -(TV v, TObj OBJ, const char *name, TErr errp) +(TV v, const char *name, TObj OBJ, TErr errp) { ... } // Part 2: swap caller order @@ expression V, NAME, OBJ, ARG1, ARG2, ERR; identifier VISIT_TYPE =~ "^visit_type_"; @@ ( -visit_start_struct(V, OBJ, ARG1, NAME, ARG2, ERR) +visit_start_struct(V, NAME, OBJ, ARG1, ARG2, ERR) | -visit_optional(V, ARG1, NAME) +visit_optional(V, NAME, ARG1) | -visit_get_next_type(V, OBJ, ARG1, NAME, ERR) +visit_get_next_type(V, NAME, OBJ, ARG1, ERR) | -visit_type_enum(V, OBJ, ARG1, ARG2, NAME, ERR) +visit_type_enum(V, NAME, OBJ, ARG1, ARG2, ERR) | -VISIT_TYPE(V, OBJ, NAME, ERR) +VISIT_TYPE(V, NAME, OBJ, ERR) ) Signed-off-by: Eric Blake <eblake@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-Id: <1454075341-13658-19-git-send-email-eblake@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
254 lines
7.6 KiB
C
254 lines
7.6 KiB
C
#include <glib.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)
|
|
{
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
__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 = 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;
|
|
QmpInputVisitor *qiv;
|
|
|
|
ud2_dict = qdict_new();
|
|
qdict_put_obj(ud2_dict, "string0", QOBJECT(qstring_from_str(text)));
|
|
|
|
qiv = qmp_input_visitor_new(QOBJECT(ud2_dict));
|
|
visit_type_UserDefTwo(qmp_input_get_visitor(qiv), NULL, &ud2, &err);
|
|
qmp_input_visitor_cleanup(qiv);
|
|
QDECREF(ud2_dict);
|
|
}
|
|
|
|
/* verify partial success */
|
|
assert(ud2 != NULL);
|
|
assert(ud2->string0 != NULL);
|
|
assert(strcmp(ud2->string0, text) == 0);
|
|
assert(ud2->dict1 == NULL);
|
|
|
|
/* confirm & release construction error */
|
|
error_free_or_abort(&err);
|
|
|
|
/* 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;
|
|
}
|