summaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorEric Blake <eblake@redhat.com>2015-07-30 16:33:07 -0600
committerMarkus Armbruster <armbru@redhat.com>2015-09-04 15:47:14 +0200
commit2f52e20597ebd55ede668b2b7d162a84f419b03e (patch)
tree661fd001dfeeab007a71e9469e42dae58f0f298d /scripts
parent999387782f736d7ac0083f4f02e2bc4ce7a9a27b (diff)
downloadhqemu-2f52e20597ebd55ede668b2b7d162a84f419b03e.zip
hqemu-2f52e20597ebd55ede668b2b7d162a84f419b03e.tar.gz
qapi: Document that input visitor semantics are prone to leaks
Most functions that can return a pointer or set an Error ** value are decent enough to guarantee a NULL return when reporting an error. Not so with our generated qapi visitor functions. If the caller is not careful to clean up partially-allocated objects on error, then the caller suffers a memory leak. Properly fixing it is probably complex enough to save for a later day, so merely document it for now. Signed-off-by: Eric Blake <eblake@redhat.com> Message-Id: <1438295587-19069-1-git-send-email-eblake@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts')
-rw-r--r--scripts/qapi-visit.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/scripts/qapi-visit.py b/scripts/qapi-visit.py
index 73f136f..eec5f1f 100644
--- a/scripts/qapi-visit.py
+++ b/scripts/qapi-visit.py
@@ -115,6 +115,10 @@ out:
def generate_visit_struct_body(name):
+ # FIXME: if *obj is NULL on entry, and visit_start_struct() assigns to
+ # *obj, but then visit_type_FOO_fields() fails, we should clean up *obj
+ # rather than leaving it non-NULL. As currently written, the caller must
+ # call qapi_free_FOO() to avoid a memory leak of the partial FOO.
ret = mcgen('''
Error *err = NULL;
OpenPOWER on IntegriCloud