Fix memory leak in repeated SPGIST index scans.

spgendscan neglected to pfree all the memory allocated by spgbeginscan.
It's possible to get away with that in most normal queries, since the
memory is allocated in the executor's per-query context which is about
to get deleted anyway; but it causes severe memory leakage during
creation or filling of large exclusion-constraint indexes.

Also, document that amendscan is supposed to free what ambeginscan
allocates.  The docs' lack of clarity on that point probably caused this
bug to begin with.  (There is discussion of changing that API spec going
forward, but I don't think it'd be appropriate for the back branches.)

Per report from Bruno Wolff.  It's been like this since the beginning,
so back-patch to all active branches.

In HEAD, also fix an independent leak caused by commit 2a6368343
(allocating memory during spgrescan instead of spgbeginscan, which
might be all right if it got cleaned up, but it didn't).  And do a bit
of code beautification on that commit, too.

Discussion: https://postgr.es/m/20181024012314.GA27428@wolff.to
This commit is contained in:
Tom Lane 2018-10-31 17:04:43 -04:00
parent 7dd8b3ca82
commit 82dd1c2714
2 changed files with 10 additions and 1 deletions

View File

@ -455,7 +455,8 @@ amendscan (IndexScanDesc scan);
</programlisting>
End a scan and release resources. The <literal>scan</> struct itself
should not be freed, but any locks or pins taken internally by the
access method must be released.
access method must be released, as well as any other memory allocated
by <function>ambeginscan</function> and other scan-related functions.
</para>
<para>

View File

@ -236,6 +236,14 @@ spgendscan(PG_FUNCTION_ARGS)
MemoryContextDelete(so->tempCxt);
if (so->keyData)
pfree(so->keyData);
if (so->state.deadTupleStorage)
pfree(so->state.deadTupleStorage);
pfree(so);
PG_RETURN_VOID();
}