Fix plancache refcount leak after error in ExecuteQuery.
authorTom Lane <[email protected]>
Wed, 16 Jun 2021 23:30:17 +0000 (19:30 -0400)
committerTom Lane <[email protected]>
Wed, 16 Jun 2021 23:30:17 +0000 (19:30 -0400)
When stuffing a plan from the plancache into a Portal, one is
not supposed to risk throwing an error between GetCachedPlan and
PortalDefineQuery; if that happens, the plan refcount incremented
by GetCachedPlan will be leaked.  I managed to break this rule
while refactoring code in 9dbf2b7d7.  There is no visible
consequence other than some memory leakage, and since nobody is
very likely to trigger the relevant error conditions many times
in a row, it's not surprising we haven't noticed.  Nonetheless,
it's a bug, so rearrange the order of operations to remove the
hazard.

Noted on the way to looking for a better fix for bug #17053.
This mistake is pretty old, so back-patch to all supported
branches.

src/backend/commands/prepare.c

index be7222f00330e40168c29e77ad16d10324399786..cb8ee3f7ed853f35f2b58778af71e7186515b950 100644 (file)
@@ -246,6 +246,17 @@ ExecuteQuery(ExecuteStmt *stmt, IntoClause *intoClause,
    cplan = GetCachedPlan(entry->plansource, paramLI, false, NULL);
    plan_list = cplan->stmt_list;
 
+   /*
+    * DO NOT add any logic that could possibly throw an error between
+    * GetCachedPlan and PortalDefineQuery, or you'll leak the plan refcount.
+    */
+   PortalDefineQuery(portal,
+                     NULL,
+                     query_string,
+                     entry->plansource->commandTag,
+                     plan_list,
+                     cplan);
+
    /*
     * For CREATE TABLE ... AS EXECUTE, we must verify that the prepared
     * statement is one that produces tuples.  Currently we insist that it be
@@ -289,13 +300,6 @@ ExecuteQuery(ExecuteStmt *stmt, IntoClause *intoClause,
        count = FETCH_ALL;
    }
 
-   PortalDefineQuery(portal,
-                     NULL,
-                     query_string,
-                     entry->plansource->commandTag,
-                     plan_list,
-                     cplan);
-
    /*
     * Run the portal as appropriate.
     */