To make deallocating partially constructed objects work, the visit_type_STRUCT() need to succeed without doing anything when passed a null object. Commitcdd2b228b9
"qapi: Smooth visitor error checking in generated code" broke that. To reproduce, run tests/test-qobject-input-visitor with AddressSanitizer: ==4353==ERROR: LeakSanitizer: detected memory leaks Direct leak of 16 byte(s) in 1 object(s) allocated from: #0 0x7f192d0c5d28 in __interceptor_calloc (/usr/lib/x86_64-linux-gnu/libasan.so.4+0xded28) #1 0x7f192cd21b10 in g_malloc0 (/usr/lib/x86_64-linux-gnu/libglib-2.0.so.0+0x51b10) #2 0x556725f6bbee in visit_next_list qapi/qapi-visit-core.c:86 #3 0x556725f49e15 in visit_type_UserDefOneList tests/test-qapi-visit.c:474 #4 0x556725f4489b in test_visitor_in_fail_struct_in_list tests/test-qobject-input-visitor.c:1086 #5 0x7f192cd42f29 (/usr/lib/x86_64-linux-gnu/libglib-2.0.so.0+0x72f29) SUMMARY: AddressSanitizer: 16 byte(s) leaked in 1 allocation(s). Test case /visitor/input/fail/struct-in-list feeds a list with a bad element to the QObject input visitor. Visiting that element duly fails, and aborts the visit with the list only partially constructed: the faulty object is null. Cleaning up the partially constructed list visits that null object, fails, and aborts the visit before the list node gets freed. Fix the the generated visit_type_STRUCT() to succeed for null objects. Fixes:cdd2b228b9
Reported-by: Li Qiang <liq3ea@163.com> Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20200716150617.4027356-1-armbru@redhat.com> Tested-by: Li Qiang <liq3ea@gmail.com> Reviewed-by: Li Qiang <liq3ea@gmail.com>
343 lines
9.5 KiB
Python
343 lines
9.5 KiB
Python
"""
|
|
QAPI visitor generator
|
|
|
|
Copyright IBM, Corp. 2011
|
|
Copyright (C) 2014-2018 Red Hat, Inc.
|
|
|
|
Authors:
|
|
Anthony Liguori <aliguori@us.ibm.com>
|
|
Michael Roth <mdroth@linux.vnet.ibm.com>
|
|
Markus Armbruster <armbru@redhat.com>
|
|
|
|
This work is licensed under the terms of the GNU GPL, version 2.
|
|
See the COPYING file in the top-level directory.
|
|
"""
|
|
|
|
from qapi.common import *
|
|
from qapi.gen import QAPISchemaModularCVisitor, ifcontext
|
|
from qapi.schema import QAPISchemaObjectType
|
|
|
|
|
|
def gen_visit_decl(name, scalar=False):
|
|
c_type = c_name(name) + ' *'
|
|
if not scalar:
|
|
c_type += '*'
|
|
return mcgen('''
|
|
bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
|
|
''',
|
|
c_name=c_name(name), c_type=c_type)
|
|
|
|
|
|
def gen_visit_members_decl(name):
|
|
return mcgen('''
|
|
|
|
bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
|
|
''',
|
|
c_name=c_name(name))
|
|
|
|
|
|
def gen_visit_object_members(name, base, members, variants):
|
|
ret = mcgen('''
|
|
|
|
bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
|
|
{
|
|
''',
|
|
c_name=c_name(name))
|
|
|
|
if base:
|
|
ret += mcgen('''
|
|
if (!visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, errp)) {
|
|
return false;
|
|
}
|
|
''',
|
|
c_type=base.c_name())
|
|
|
|
for memb in members:
|
|
ret += gen_if(memb.ifcond)
|
|
if memb.optional:
|
|
ret += mcgen('''
|
|
if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
|
|
''',
|
|
name=memb.name, c_name=c_name(memb.name))
|
|
push_indent()
|
|
ret += mcgen('''
|
|
if (!visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, errp)) {
|
|
return false;
|
|
}
|
|
''',
|
|
c_type=memb.type.c_name(), name=memb.name,
|
|
c_name=c_name(memb.name))
|
|
if memb.optional:
|
|
pop_indent()
|
|
ret += mcgen('''
|
|
}
|
|
''')
|
|
ret += gen_endif(memb.ifcond)
|
|
|
|
if variants:
|
|
ret += mcgen('''
|
|
switch (obj->%(c_name)s) {
|
|
''',
|
|
c_name=c_name(variants.tag_member.name))
|
|
|
|
for var in variants.variants:
|
|
case_str = c_enum_const(variants.tag_member.type.name,
|
|
var.name,
|
|
variants.tag_member.type.prefix)
|
|
ret += gen_if(var.ifcond)
|
|
if var.type.name == 'q_empty':
|
|
# valid variant and nothing to do
|
|
ret += mcgen('''
|
|
case %(case)s:
|
|
break;
|
|
''',
|
|
case=case_str)
|
|
else:
|
|
ret += mcgen('''
|
|
case %(case)s:
|
|
return visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, errp);
|
|
''',
|
|
case=case_str,
|
|
c_type=var.type.c_name(), c_name=c_name(var.name))
|
|
|
|
ret += gen_endif(var.ifcond)
|
|
ret += mcgen('''
|
|
default:
|
|
abort();
|
|
}
|
|
''')
|
|
|
|
ret += mcgen('''
|
|
return true;
|
|
}
|
|
''')
|
|
return ret
|
|
|
|
|
|
def gen_visit_list(name, element_type):
|
|
return mcgen('''
|
|
|
|
bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
|
|
{
|
|
bool ok = false;
|
|
%(c_name)s *tail;
|
|
size_t size = sizeof(**obj);
|
|
|
|
if (!visit_start_list(v, name, (GenericList **)obj, size, errp)) {
|
|
return false;
|
|
}
|
|
|
|
for (tail = *obj; tail;
|
|
tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
|
|
if (!visit_type_%(c_elt_type)s(v, NULL, &tail->value, errp)) {
|
|
goto out_obj;
|
|
}
|
|
}
|
|
|
|
ok = visit_check_list(v, errp);
|
|
out_obj:
|
|
visit_end_list(v, (void **)obj);
|
|
if (!ok && visit_is_input(v)) {
|
|
qapi_free_%(c_name)s(*obj);
|
|
*obj = NULL;
|
|
}
|
|
return ok;
|
|
}
|
|
''',
|
|
c_name=c_name(name), c_elt_type=element_type.c_name())
|
|
|
|
|
|
def gen_visit_enum(name):
|
|
return mcgen('''
|
|
|
|
bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
|
|
{
|
|
int value = *obj;
|
|
bool ok = visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp);
|
|
*obj = value;
|
|
return ok;
|
|
}
|
|
''',
|
|
c_name=c_name(name))
|
|
|
|
|
|
def gen_visit_alternate(name, variants):
|
|
ret = mcgen('''
|
|
|
|
bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
|
|
{
|
|
bool ok = false;
|
|
|
|
if (!visit_start_alternate(v, name, (GenericAlternate **)obj,
|
|
sizeof(**obj), errp)) {
|
|
return false;
|
|
}
|
|
if (!*obj) {
|
|
/* incomplete */
|
|
assert(visit_is_dealloc(v));
|
|
ok = true;
|
|
goto out_obj;
|
|
}
|
|
switch ((*obj)->type) {
|
|
''',
|
|
c_name=c_name(name))
|
|
|
|
for var in variants.variants:
|
|
ret += gen_if(var.ifcond)
|
|
ret += mcgen('''
|
|
case %(case)s:
|
|
''',
|
|
case=var.type.alternate_qtype())
|
|
if isinstance(var.type, QAPISchemaObjectType):
|
|
ret += mcgen('''
|
|
if (!visit_start_struct(v, name, NULL, 0, errp)) {
|
|
break;
|
|
}
|
|
if (visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, errp)) {
|
|
ok = visit_check_struct(v, errp);
|
|
}
|
|
visit_end_struct(v, NULL);
|
|
''',
|
|
c_type=var.type.c_name(),
|
|
c_name=c_name(var.name))
|
|
else:
|
|
ret += mcgen('''
|
|
ok = visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, errp);
|
|
''',
|
|
c_type=var.type.c_name(),
|
|
c_name=c_name(var.name))
|
|
ret += mcgen('''
|
|
break;
|
|
''')
|
|
ret += gen_endif(var.ifcond)
|
|
|
|
ret += mcgen('''
|
|
case QTYPE_NONE:
|
|
abort();
|
|
default:
|
|
assert(visit_is_input(v));
|
|
error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
|
|
"%(name)s");
|
|
/* Avoid passing invalid *obj to qapi_free_%(c_name)s() */
|
|
g_free(*obj);
|
|
*obj = NULL;
|
|
}
|
|
out_obj:
|
|
visit_end_alternate(v, (void **)obj);
|
|
if (!ok && visit_is_input(v)) {
|
|
qapi_free_%(c_name)s(*obj);
|
|
*obj = NULL;
|
|
}
|
|
return ok;
|
|
}
|
|
''',
|
|
name=name, c_name=c_name(name))
|
|
|
|
return ret
|
|
|
|
|
|
def gen_visit_object(name, base, members, variants):
|
|
return mcgen('''
|
|
|
|
bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
|
|
{
|
|
bool ok = false;
|
|
|
|
if (!visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), errp)) {
|
|
return false;
|
|
}
|
|
if (!*obj) {
|
|
/* incomplete */
|
|
assert(visit_is_dealloc(v));
|
|
ok = true;
|
|
goto out_obj;
|
|
}
|
|
if (!visit_type_%(c_name)s_members(v, *obj, errp)) {
|
|
goto out_obj;
|
|
}
|
|
ok = visit_check_struct(v, errp);
|
|
out_obj:
|
|
visit_end_struct(v, (void **)obj);
|
|
if (!ok && visit_is_input(v)) {
|
|
qapi_free_%(c_name)s(*obj);
|
|
*obj = NULL;
|
|
}
|
|
return ok;
|
|
}
|
|
''',
|
|
c_name=c_name(name))
|
|
|
|
|
|
class QAPISchemaGenVisitVisitor(QAPISchemaModularCVisitor):
|
|
|
|
def __init__(self, prefix):
|
|
super().__init__(
|
|
prefix, 'qapi-visit', ' * Schema-defined QAPI visitors',
|
|
' * Built-in QAPI visitors', __doc__)
|
|
|
|
def _begin_system_module(self, name):
|
|
self._genc.preamble_add(mcgen('''
|
|
#include "qemu/osdep.h"
|
|
#include "qapi/error.h"
|
|
#include "qapi/qapi-builtin-visit.h"
|
|
'''))
|
|
self._genh.preamble_add(mcgen('''
|
|
#include "qapi/visitor.h"
|
|
#include "qapi/qapi-builtin-types.h"
|
|
|
|
'''))
|
|
|
|
def _begin_user_module(self, name):
|
|
types = self._module_basename('qapi-types', name)
|
|
visit = self._module_basename('qapi-visit', name)
|
|
self._genc.preamble_add(mcgen('''
|
|
#include "qemu/osdep.h"
|
|
#include "qapi/error.h"
|
|
#include "qapi/qmp/qerror.h"
|
|
#include "%(visit)s.h"
|
|
''',
|
|
visit=visit))
|
|
self._genh.preamble_add(mcgen('''
|
|
#include "qapi/qapi-builtin-visit.h"
|
|
#include "%(types)s.h"
|
|
|
|
''',
|
|
types=types))
|
|
|
|
def visit_enum_type(self, name, info, ifcond, features, members, prefix):
|
|
with ifcontext(ifcond, self._genh, self._genc):
|
|
self._genh.add(gen_visit_decl(name, scalar=True))
|
|
self._genc.add(gen_visit_enum(name))
|
|
|
|
def visit_array_type(self, name, info, ifcond, element_type):
|
|
with ifcontext(ifcond, self._genh, self._genc):
|
|
self._genh.add(gen_visit_decl(name))
|
|
self._genc.add(gen_visit_list(name, element_type))
|
|
|
|
def visit_object_type(self, name, info, ifcond, features,
|
|
base, members, variants):
|
|
# Nothing to do for the special empty builtin
|
|
if name == 'q_empty':
|
|
return
|
|
with ifcontext(ifcond, self._genh, self._genc):
|
|
self._genh.add(gen_visit_members_decl(name))
|
|
self._genc.add(gen_visit_object_members(name, base,
|
|
members, variants))
|
|
# TODO Worth changing the visitor signature, so we could
|
|
# directly use rather than repeat type.is_implicit()?
|
|
if not name.startswith('q_'):
|
|
# only explicit types need an allocating visit
|
|
self._genh.add(gen_visit_decl(name))
|
|
self._genc.add(gen_visit_object(name, base, members, variants))
|
|
|
|
def visit_alternate_type(self, name, info, ifcond, features, variants):
|
|
with ifcontext(ifcond, self._genh, self._genc):
|
|
self._genh.add(gen_visit_decl(name))
|
|
self._genc.add(gen_visit_alternate(name, variants))
|
|
|
|
|
|
def gen_visit(schema, output_dir, prefix, opt_builtins):
|
|
vis = QAPISchemaGenVisitVisitor(prefix)
|
|
schema.visit(vis)
|
|
vis.write(output_dir, opt_builtins)
|