openkylin
/
qemu
mirror of https://gitee.com/openkylin/qemu.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

qapi: Smooth visitor error checking in generated code 

Use visitor functions' return values to check for failure.  Eliminate
error_propagate() that are now unnecessary.  Delete @err that are now
unused.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20200707160613.848843-41-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2020-07-07 18:06:08 +02:00
parent b11a093c60
commit cdd2b228b9
3 changed files with 55 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/devel/qapi-code-gen.txt
View File

@ -1420,8 +1420,6 @@ Example:
bool visit_type_UserDefOne_members(Visitor *v, UserDefOne *obj, Error **errp) bool visit_type_UserDefOne_members(Visitor *v, UserDefOne *obj, Error **errp)
{ {
Error *err = NULL;
if (!visit_type_int(v, "integer", &obj->integer, errp)) { if (!visit_type_int(v, "integer", &obj->integer, errp)) {
return false; return false;
} }
@ -1430,13 +1428,12 @@ Example:
return false; return false;
} }
} }
error_propagate(errp, err); return true;
return !err;
} }
bool visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne **obj, Error **errp) bool visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne **obj, Error **errp)
{ {
Error *err = NULL; bool ok = false;
if (!visit_start_struct(v, name, (void **)obj, sizeof(UserDefOne), errp)) { if (!visit_start_struct(v, name, (void **)obj, sizeof(UserDefOne), errp)) {
return false; return false;
@ -1446,24 +1443,22 @@ Example:
assert(visit_is_dealloc(v)); assert(visit_is_dealloc(v));
goto out_obj; goto out_obj;
} }
visit_type_UserDefOne_members(v, *obj, &err); if (!visit_type_UserDefOne_members(v, *obj, errp)) {
if (err) {
goto out_obj; goto out_obj;
} }
visit_check_struct(v, &err); ok = visit_check_struct(v, errp);
out_obj: out_obj:
visit_end_struct(v, (void **)obj); visit_end_struct(v, (void **)obj);
if (err && visit_is_input(v)) { if (!ok && visit_is_input(v)) {
qapi_free_UserDefOne(*obj); qapi_free_UserDefOne(*obj);
*obj = NULL; *obj = NULL;
} }
error_propagate(errp, err); return ok;
return !err;
} }
bool visit_type_UserDefOneList(Visitor *v, const char *name, UserDefOneList **obj, Error **errp) bool visit_type_UserDefOneList(Visitor *v, const char *name, UserDefOneList **obj, Error **errp)
{ {
Error *err = NULL; bool ok = false;
UserDefOneList *tail; UserDefOneList *tail;
size_t size = sizeof(**obj); size_t size = sizeof(**obj);
@ -1473,33 +1468,27 @@ Example:
for (tail = *obj; tail; for (tail = *obj; tail;
tail = (UserDefOneList *)visit_next_list(v, (GenericList *)tail, size)) { tail = (UserDefOneList *)visit_next_list(v, (GenericList *)tail, size)) {
visit_type_UserDefOne(v, NULL, &tail->value, &err); if (!visit_type_UserDefOne(v, NULL, &tail->value, errp)) {
if (err) { goto out_obj;
break;
} }
} }
if (!err) { ok = visit_check_list(v, errp);
visit_check_list(v, &err); out_obj:
}
visit_end_list(v, (void **)obj); visit_end_list(v, (void **)obj);
if (err && visit_is_input(v)) { if (!ok && visit_is_input(v)) {
qapi_free_UserDefOneList(*obj); qapi_free_UserDefOneList(*obj);
*obj = NULL; *obj = NULL;
} }
error_propagate(errp, err); return ok;
return !err;
} }
bool visit_type_q_obj_my_command_arg_members(Visitor *v, q_obj_my_command_arg *obj, Error **errp) bool visit_type_q_obj_my_command_arg_members(Visitor *v, q_obj_my_command_arg *obj, Error **errp)
{ {
Error *err = NULL;
if (!visit_type_UserDefOneList(v, "arg1", &obj->arg1, errp)) { if (!visit_type_UserDefOneList(v, "arg1", &obj->arg1, errp)) {
return false; return false;
} }
error_propagate(errp, err); return true;
return !err;
} }
[Uninteresting stuff omitted...] [Uninteresting stuff omitted...]
@ -1554,15 +1543,12 @@ Example:
static void qmp_marshal_output_UserDefOne(UserDefOne *ret_in, QObject **ret_out, Error **errp) static void qmp_marshal_output_UserDefOne(UserDefOne *ret_in, QObject **ret_out, Error **errp)
{ {
Error *err = NULL;
Visitor *v; Visitor *v;
v = qobject_output_visitor_new(ret_out); v = qobject_output_visitor_new(ret_out);
visit_type_UserDefOne(v, "unused", &ret_in, &err); if (visit_type_UserDefOne(v, "unused", &ret_in, errp)) {
if (!err) {
visit_complete(v, ret_out); visit_complete(v, ret_out);
} }
error_propagate(errp, err);
visit_free(v); visit_free(v);
v = qapi_dealloc_visitor_new(); v = qapi_dealloc_visitor_new();
visit_type_UserDefOne(v, "unused", &ret_in, NULL); visit_type_UserDefOne(v, "unused", &ret_in, NULL);
@ -1572,33 +1558,32 @@ Example:
void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp) void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp)
{ {
Error *err = NULL; Error *err = NULL;
bool ok = false;
Visitor *v; Visitor *v;
UserDefOne *retval; UserDefOne *retval;
q_obj_my_command_arg arg = {0}; q_obj_my_command_arg arg = {0};
v = qobject_input_visitor_new(QOBJECT(args)); v = qobject_input_visitor_new(QOBJECT(args));
visit_start_struct(v, NULL, NULL, 0, &err); if (!visit_start_struct(v, NULL, NULL, 0, errp)) {
if (err) {
goto out; goto out;
} }
visit_type_q_obj_my_command_arg_members(v, &arg, &err); if (visit_type_q_obj_my_command_arg_members(v, &arg, errp)) {
if (!err) { ok = visit_check_struct(v, errp);
visit_check_struct(v, &err);
} }
visit_end_struct(v, NULL); visit_end_struct(v, NULL);
if (err) { if (!ok) {
goto out; goto out;
} }
retval = qmp_my_command(arg.arg1, &err); retval = qmp_my_command(arg.arg1, &err);
error_propagate(errp, err);
if (err) { if (err) {
goto out; goto out;
} }
qmp_marshal_output_UserDefOne(retval, ret, &err); qmp_marshal_output_UserDefOne(retval, ret, errp);
out: out:
error_propagate(errp, err);
visit_free(v); visit_free(v);
v = qapi_dealloc_visitor_new(); v = qapi_dealloc_visitor_new();
visit_start_struct(v, NULL, NULL, 0, NULL); visit_start_struct(v, NULL, NULL, 0, NULL);
@ -1606,6 +1591,7 @@ Example:
visit_end_struct(v, NULL); visit_end_struct(v, NULL);
visit_free(v); visit_free(v);
} }
[Uninteresting stuff omitted...] [Uninteresting stuff omitted...]
$ cat qapi-generated/example-qapi-init-commands.h $ cat qapi-generated/example-qapi-init-commands.h
[Uninteresting stuff omitted...] [Uninteresting stuff omitted...]

22
scripts/qapi/commands.py
View File

@ -47,6 +47,7 @@ def gen_call(name, arg_type, boxed, ret_type):
ret = mcgen(''' ret = mcgen('''
%(lhs)sqmp_%(c_name)s(%(args)s&err); %(lhs)sqmp_%(c_name)s(%(args)s&err);
error_propagate(errp, err);
''', ''',
c_name=c_name(name), args=argstr, lhs=lhs) c_name=c_name(name), args=argstr, lhs=lhs)
if ret_type: if ret_type:
@ -55,7 +56,7 @@ def gen_call(name, arg_type, boxed, ret_type):
goto out; goto out;
} }
qmp_marshal_output_%(c_name)s(retval, ret, &err); qmp_marshal_output_%(c_name)s(retval, ret, errp);
''', ''',
c_name=ret_type.c_name()) c_name=ret_type.c_name())
return ret return ret
@ -66,15 +67,12 @@ def gen_marshal_output(ret_type):
static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp) static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp)
{ {
Error *err = NULL;
Visitor *v; Visitor *v;
v = qobject_output_visitor_new(ret_out); v = qobject_output_visitor_new(ret_out);
visit_type_%(c_name)s(v, "unused", &ret_in, &err); if (visit_type_%(c_name)s(v, "unused", &ret_in, errp)) {
if (!err) {
visit_complete(v, ret_out); visit_complete(v, ret_out);
} }
error_propagate(errp, err);
visit_free(v); visit_free(v);
v = qapi_dealloc_visitor_new(); v = qapi_dealloc_visitor_new();
visit_type_%(c_name)s(v, "unused", &ret_in, NULL); visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
@ -104,6 +102,7 @@ def gen_marshal(name, arg_type, boxed, ret_type):
%(proto)s %(proto)s
{ {
Error *err = NULL; Error *err = NULL;
bool ok = false;
Visitor *v; Visitor *v;
''', ''',
proto=build_marshal_proto(name)) proto=build_marshal_proto(name))
@ -123,28 +122,26 @@ def gen_marshal(name, arg_type, boxed, ret_type):
ret += mcgen(''' ret += mcgen('''
v = qobject_input_visitor_new(QOBJECT(args)); v = qobject_input_visitor_new(QOBJECT(args));
visit_start_struct(v, NULL, NULL, 0, &err); if (!visit_start_struct(v, NULL, NULL, 0, errp)) {
if (err) {
goto out; goto out;
} }
''') ''')
if have_args: if have_args:
ret += mcgen(''' ret += mcgen('''
visit_type_%(c_arg_type)s_members(v, &arg, &err); if (visit_type_%(c_arg_type)s_members(v, &arg, errp)) {
if (!err) { ok = visit_check_struct(v, errp);
visit_check_struct(v, &err);
} }
''', ''',
c_arg_type=arg_type.c_name()) c_arg_type=arg_type.c_name())
else: else:
ret += mcgen(''' ret += mcgen('''
visit_check_struct(v, &err); ok = visit_check_struct(v, errp);
''') ''')
ret += mcgen(''' ret += mcgen('''
visit_end_struct(v, NULL); visit_end_struct(v, NULL);
if (err) { if (!ok) {
goto out; goto out;
} }
''') ''')
@ -154,7 +151,6 @@ def gen_marshal(name, arg_type, boxed, ret_type):
ret += mcgen(''' ret += mcgen('''
out: out:
error_propagate(errp, err);
visit_free(v); visit_free(v);
''') ''')

57
scripts/qapi/visit.py
View File

@ -41,8 +41,6 @@ def gen_visit_object_members(name, base, members, variants):
bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp) bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
{ {
Error *err = NULL;
''', ''',
c_name=c_name(name)) c_name=c_name(name))
@ -97,8 +95,7 @@ def gen_visit_object_members(name, base, members, variants):
else: else:
ret += mcgen(''' ret += mcgen('''
case %(case)s: case %(case)s:
visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err); return visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, errp);
break;
''', ''',
case=case_str, case=case_str,
c_type=var.type.c_name(), c_name=c_name(var.name)) c_type=var.type.c_name(), c_name=c_name(var.name))
@ -111,8 +108,7 @@ def gen_visit_object_members(name, base, members, variants):
''') ''')
ret += mcgen(''' ret += mcgen('''
error_propagate(errp, err); return true;
return !err;
} }
''') ''')
return ret return ret
@ -123,7 +119,7 @@ def gen_visit_list(name, element_type):
bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
{ {
Error *err = NULL; bool ok = false;
%(c_name)s *tail; %(c_name)s *tail;
size_t size = sizeof(**obj); size_t size = sizeof(**obj);
@ -133,22 +129,19 @@ def gen_visit_list(name, element_type):
for (tail = *obj; tail; for (tail = *obj; tail;
tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) { tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err); if (!visit_type_%(c_elt_type)s(v, NULL, &tail->value, errp)) {
if (err) { goto out_obj;
break;
} }
} }
if (!err) { ok = visit_check_list(v, errp);
visit_check_list(v, &err); out_obj:
}
visit_end_list(v, (void **)obj); visit_end_list(v, (void **)obj);
if (err && visit_is_input(v)) { if (!ok && visit_is_input(v)) {
qapi_free_%(c_name)s(*obj); qapi_free_%(c_name)s(*obj);
*obj = NULL; *obj = NULL;
} }
error_propagate(errp, err); return ok;
return !err;
} }
''', ''',
c_name=c_name(name), c_elt_type=element_type.c_name()) c_name=c_name(name), c_elt_type=element_type.c_name())
@ -173,7 +166,7 @@ def gen_visit_alternate(name, variants):
bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
{ {
Error *err = NULL; bool ok = false;
if (!visit_start_alternate(v, name, (GenericAlternate **)obj, if (!visit_start_alternate(v, name, (GenericAlternate **)obj,
sizeof(**obj), errp)) { sizeof(**obj), errp)) {
@ -182,6 +175,7 @@ def gen_visit_alternate(name, variants):
if (!*obj) { if (!*obj) {
/* incomplete */ /* incomplete */
assert(visit_is_dealloc(v)); assert(visit_is_dealloc(v));
ok = true;
goto out_obj; goto out_obj;
} }
switch ((*obj)->type) { switch ((*obj)->type) {
@ -196,13 +190,11 @@ def gen_visit_alternate(name, variants):
case=var.type.alternate_qtype()) case=var.type.alternate_qtype())
if isinstance(var.type, QAPISchemaObjectType): if isinstance(var.type, QAPISchemaObjectType):
ret += mcgen(''' ret += mcgen('''
visit_start_struct(v, name, NULL, 0, &err); if (!visit_start_struct(v, name, NULL, 0, errp)) {
if (err) {
break; break;
} }
visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err); if (visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, errp)) {
if (!err) { ok = visit_check_struct(v, errp);
visit_check_struct(v, &err);
} }
visit_end_struct(v, NULL); visit_end_struct(v, NULL);
''', ''',
@ -210,7 +202,7 @@ def gen_visit_alternate(name, variants):
c_name=c_name(var.name)) c_name=c_name(var.name))
else: else:
ret += mcgen(''' ret += mcgen('''
visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err); ok = visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, errp);
''', ''',
c_type=var.type.c_name(), c_type=var.type.c_name(),
c_name=c_name(var.name)) c_name=c_name(var.name))
@ -224,7 +216,7 @@ def gen_visit_alternate(name, variants):
abort(); abort();
default: default:
assert(visit_is_input(v)); assert(visit_is_input(v));
error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null", error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
"%(name)s"); "%(name)s");
/* Avoid passing invalid *obj to qapi_free_%(c_name)s() */ /* Avoid passing invalid *obj to qapi_free_%(c_name)s() */
g_free(*obj); g_free(*obj);
@ -232,12 +224,11 @@ def gen_visit_alternate(name, variants):
} }
out_obj: out_obj:
visit_end_alternate(v, (void **)obj); visit_end_alternate(v, (void **)obj);
if (err && visit_is_input(v)) { if (!ok && visit_is_input(v)) {
qapi_free_%(c_name)s(*obj); qapi_free_%(c_name)s(*obj);
*obj = NULL; *obj = NULL;
} }
error_propagate(errp, err); return ok;
return !err;
} }
''', ''',
name=name, c_name=c_name(name)) name=name, c_name=c_name(name))
@ -250,7 +241,7 @@ def gen_visit_object(name, base, members, variants):
bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
{ {
Error *err = NULL; bool ok = false;
if (!visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), errp)) { if (!visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), errp)) {
return false; return false;
@ -260,19 +251,17 @@ def gen_visit_object(name, base, members, variants):
assert(visit_is_dealloc(v)); assert(visit_is_dealloc(v));
goto out_obj; goto out_obj;
} }
visit_type_%(c_name)s_members(v, *obj, &err); if (!visit_type_%(c_name)s_members(v, *obj, errp)) {
if (err) {
goto out_obj; goto out_obj;
} }
visit_check_struct(v, &err); ok = visit_check_struct(v, errp);
out_obj: out_obj:
visit_end_struct(v, (void **)obj); visit_end_struct(v, (void **)obj);
if (err && visit_is_input(v)) { if (!ok && visit_is_input(v)) {
qapi_free_%(c_name)s(*obj); qapi_free_%(c_name)s(*obj);
*obj = NULL; *obj = NULL;
} }
error_propagate(errp, err); return ok;
return !err;
} }
''', ''',
c_name=c_name(name)) c_name=c_name(name))