Repair rare failure of MULTIEXPR_SUBLINK subplans in inherited updates.
authorTom Lane <[email protected]>
Sat, 27 Aug 2022 16:11:20 +0000 (12:11 -0400)
committerTom Lane <[email protected]>
Sat, 27 Aug 2022 16:11:20 +0000 (12:11 -0400)
Prior to v14, if we have a MULTIEXPR SubPlan (that is, use of the syntax
UPDATE ... SET (c1, ...) = (SELECT ...)) in an UPDATE with an inherited
or partitioned target table, inheritance_planner() will clone the
targetlist and therefore also the MULTIEXPR SubPlan and the Param nodes
referencing it for each child target table.  Up to now, we've allowed
all the clones to share the underlying subplan as well as the output
parameter IDs -- that is, the runtime ParamExecData slots.  That
technique is borrowed from the far older code that supports initplans,
and it works okay in that case because the cloned SubPlan nodes are
essentially identical.  So it doesn't matter which one of the clones
the shared ParamExecData.execPlan field might point to.

However, this fails to hold for MULTIEXPR SubPlans, because they can
have nonempty "args" lists (values to be passed into the subplan), and
those lists could get mutated to different states in the various clones.
In the submitted reproducer, as well as the test case added here, one
clone contains Vars with varno OUTER_VAR where another has INNER_VAR,
because the child tables are respectively on the outer or inner side of
the join.  Sharing the execPlan pointer can result in trying to evaluate
an args list that doesn't match the local execution state, with mayhem
ensuing.  The result often is to trigger consistency checks in the
executor, but I believe this could end in a crash or incorrect updates.

To fix, assign new Param IDs to each of the cloned SubPlans, so that
they don't share ParamExecData slots at runtime.  It still seems fine
for the clones to share the underlying subplan, and extra ParamExecData
slots are cheap enough that this fix shouldn't cost much.

This has been busted since we invented MULTIEXPR SubPlans in 9.5.
Probably the lack of previous reports is because query plans in which
the different clones of a MULTIEXPR mutate to effectively-different
states are pretty rare.  There's no issue in v14 and later, because
without inheritance_planner() there's never a reason to clone
MULTIEXPR SubPlans.

Per bug #17596 from Andre Lin.  Patch v10-v13 only.

Discussion: https://postgr.es/m/17596-c5357f61427a81dc@postgresql.org

src/backend/executor/nodeSubplan.c
src/backend/optimizer/plan/planner.c
src/backend/optimizer/plan/subselect.c
src/include/optimizer/subselect.h
src/test/regress/expected/inherit.out
src/test/regress/sql/inherit.sql

index aa34f86e0ec07ea35c29b20ed62e35eb409ac201..64c17a6b192624559a2562d5da534682ce0b38c8 100644 (file)
@@ -246,6 +246,21 @@ ExecScanSubPlan(SubPlanState *node,
     * ones, so this should be safe.)  Unlike ExecReScanSetParamPlan, we do
     * *not* set bits in the parent plan node's chgParam, because we don't
     * want to cause a rescan of the parent.
+    *
+    * Note: we are also relying on MULTIEXPR SubPlans not sharing any output
+    * parameters with other SubPlans, because if one does then it is unclear
+    * which SubPlanState node the parameter's execPlan field will be pointing
+    * to when we come to evaluate the parameter.  We can allow plain initplan
+    * SubPlans to share output parameters, because it doesn't actually matter
+    * which initplan SubPlan we reference as long as they all point to the
+    * same underlying subplan.  However, that fails to hold for MULTIEXPRs
+    * because they can have non-empty args lists, and the "same" args might
+    * have mutated into different forms in different parts of a plan tree.
+    * There is not a problem in ordinary queries because MULTIEXPR will
+    * appear only in an UPDATE's top-level target list, so it won't get
+    * duplicated anyplace.  However, when inheritance_planner clones a
+    * partially-planned targetlist it must take care to assign non-duplicate
+    * param IDs to the cloned copy.
     */
    if (subLinkType == MULTIEXPR_SUBLINK)
    {
index ab84a347b39bd83574e965e8f738365abaa07283..f6a19274589b83e70528b617659e22c613505248 100644 (file)
@@ -1286,6 +1286,10 @@ inheritance_planner(PlannerInfo *root)
        /* hack to mark target relation as an inheritance partition */
        subroot->hasInheritedTarget = true;
 
+       /* Fix MULTIEXPR_SUBLINK params if any */
+       if (root->multiexpr_params)
+           SS_make_multiexprs_unique(root, subroot);
+
        /* Generate Path(s) for accessing this result relation */
        grouping_planner(subroot, true, 0.0 /* retrieve all tuples */ );
 
index cf0e5de3f437727d0450bca7fd265ab17c0d0114..7640e98a8da7523bf35026993c63d97184eafd46 100644 (file)
@@ -852,6 +852,101 @@ hash_ok_operator(OpExpr *expr)
    }
 }
 
+/*
+ * SS_make_multiexprs_unique
+ *
+ * After cloning an UPDATE targetlist that contains MULTIEXPR_SUBLINK
+ * SubPlans, inheritance_planner() must call this to assign new, unique Param
+ * IDs to the cloned MULTIEXPR_SUBLINKs' output parameters.  See notes in
+ * ExecScanSubPlan.
+ */
+void
+SS_make_multiexprs_unique(PlannerInfo *root, PlannerInfo *subroot)
+{
+   List       *new_multiexpr_params = NIL;
+   int         offset;
+   ListCell   *lc;
+
+   /*
+    * Find MULTIEXPR SubPlans in the cloned query.  We need only look at the
+    * top level of the targetlist.
+    */
+   foreach(lc, subroot->parse->targetList)
+   {
+       TargetEntry *tent = (TargetEntry *) lfirst(lc);
+       SubPlan    *splan;
+       Plan       *plan;
+       List       *params;
+
+       if (!IsA(tent->expr, SubPlan))
+           continue;
+       splan = (SubPlan *) tent->expr;
+       if (splan->subLinkType != MULTIEXPR_SUBLINK)
+           continue;
+
+       /* Found one, get the associated subplan */
+       plan = (Plan *) list_nth(root->glob->subplans, splan->plan_id - 1);
+
+       /*
+        * Generate new PARAM_EXEC Param nodes, and overwrite splan->setParam
+        * with their IDs.  This is just like what build_subplan did when it
+        * made the SubPlan node we're cloning.  But because the param IDs are
+        * assigned globally, we'll get new IDs.  (We assume here that the
+        * subroot's tlist is a clone we can scribble on.)
+        */
+       params = generate_subquery_params(root,
+                                         plan->targetlist,
+                                         &splan->setParam);
+
+       /*
+        * We will append the replacement-Params lists to
+        * root->multiexpr_params, but for the moment just make a local list.
+        * Since we lack easy access here to the original subLinkId, we have
+        * to fall back on the slightly shaky assumption that the MULTIEXPR
+        * SubPlans appear in the targetlist in subLinkId order.  This should
+        * be safe enough given the way that the parser builds the targetlist
+        * today.  I wouldn't want to rely on it going forward, but since this
+        * code has a limited lifespan it should be fine.  We can partially
+        * protect against problems with assertions below.
+        */
+       new_multiexpr_params = lappend(new_multiexpr_params, params);
+   }
+
+   /*
+    * Now we must find the Param nodes that reference the MULTIEXPR outputs
+    * and update their sublink IDs so they'll reference the new outputs.
+    * Fortunately, those too must be at top level of the cloned targetlist.
+    */
+   offset = list_length(root->multiexpr_params);
+
+   foreach(lc, subroot->parse->targetList)
+   {
+       TargetEntry *tent = (TargetEntry *) lfirst(lc);
+       Param      *p;
+       int         subqueryid;
+       int         colno;
+
+       if (!IsA(tent->expr, Param))
+           continue;
+       p = (Param *) tent->expr;
+       if (p->paramkind != PARAM_MULTIEXPR)
+           continue;
+       subqueryid = p->paramid >> 16;
+       colno = p->paramid & 0xFFFF;
+       Assert(subqueryid > 0 &&
+              subqueryid <= list_length(new_multiexpr_params));
+       Assert(colno > 0 &&
+              colno <= list_length((List *) list_nth(new_multiexpr_params,
+                                                     subqueryid - 1)));
+       subqueryid += offset;
+       p->paramid = (subqueryid << 16) + colno;
+   }
+
+   /* Finally, attach new replacement lists to the global list */
+   root->multiexpr_params = list_concat(root->multiexpr_params,
+                                        new_multiexpr_params);
+}
+
 
 /*
  * SS_process_ctes: process a query's WITH list
index 414ede500c7c2a229af6ca7640690a68f0950a55..04129c29ee0660491a6c66cb554979a060710451 100644 (file)
@@ -16,6 +16,7 @@
 #include "nodes/plannodes.h"
 #include "nodes/relation.h"
 
+extern void SS_make_multiexprs_unique(PlannerInfo *root, PlannerInfo *subroot);
 extern void SS_process_ctes(PlannerInfo *root);
 extern JoinExpr *convert_ANY_sublink_to_join(PlannerInfo *root,
                            SubLink *sublink,
index c28aa1bddf09ebc11cb999793a81e14c009bad42..2ac33facd302fc48c6b76612a0145ed090055541 100644 (file)
@@ -1697,6 +1697,55 @@ reset enable_seqscan;
 reset enable_indexscan;
 reset enable_bitmapscan;
 --
+-- Check handling of MULTIEXPR SubPlans in inherited updates
+--
+create table inhpar(f1 int, f2 name);
+insert into inhpar select generate_series(1,10);
+create table inhcld() inherits(inhpar);
+insert into inhcld select generate_series(11,10000);
+vacuum analyze inhcld;
+vacuum analyze inhpar;
+explain (verbose, costs off)
+update inhpar set (f1, f2) = (select p2.unique2, p2.stringu1
+                              from int4_tbl limit 1)
+from onek p2 where inhpar.f1 = p2.unique1;
+                                QUERY PLAN                                 
+---------------------------------------------------------------------------
+ Update on public.inhpar
+   Update on public.inhpar
+   Update on public.inhcld
+   ->  Merge Join
+         Output: $4, $5, (SubPlan 1 (returns $2,$3)), inhpar.ctid, p2.ctid
+         Merge Cond: (p2.unique1 = inhpar.f1)
+         ->  Index Scan using onek_unique1 on public.onek p2
+               Output: p2.unique2, p2.stringu1, p2.ctid, p2.unique1
+         ->  Sort
+               Output: inhpar.ctid, inhpar.f1
+               Sort Key: inhpar.f1
+               ->  Seq Scan on public.inhpar
+                     Output: inhpar.ctid, inhpar.f1
+         SubPlan 1 (returns $2,$3)
+           ->  Limit
+                 Output: (p2.unique2), (p2.stringu1)
+                 ->  Seq Scan on public.int4_tbl
+                       Output: p2.unique2, p2.stringu1
+   ->  Hash Join
+         Output: $6, $7, (SubPlan 1 (returns $2,$3)), inhcld.ctid, p2.ctid
+         Hash Cond: (inhcld.f1 = p2.unique1)
+         ->  Seq Scan on public.inhcld
+               Output: inhcld.ctid, inhcld.f1
+         ->  Hash
+               Output: p2.unique2, p2.stringu1, p2.ctid, p2.unique1
+               ->  Seq Scan on public.onek p2
+                     Output: p2.unique2, p2.stringu1, p2.ctid, p2.unique1
+(27 rows)
+
+update inhpar set (f1, f2) = (select p2.unique2, p2.stringu1
+                              from int4_tbl limit 1)
+from onek p2 where inhpar.f1 = p2.unique1;
+drop table inhpar cascade;
+NOTICE:  drop cascades to table inhcld
+--
 -- Check handling of a constant-null CHECK constraint
 --
 create table cnullparent (f1 int);
index e7ce65e406f3a73bf760c6653f17f49ee6ccaacf..9a8c52a3ebbee165cc8f434240f89d87bb56057a 100644 (file)
@@ -619,6 +619,26 @@ reset enable_seqscan;
 reset enable_indexscan;
 reset enable_bitmapscan;
 
+--
+-- Check handling of MULTIEXPR SubPlans in inherited updates
+--
+create table inhpar(f1 int, f2 name);
+insert into inhpar select generate_series(1,10);
+create table inhcld() inherits(inhpar);
+insert into inhcld select generate_series(11,10000);
+vacuum analyze inhcld;
+vacuum analyze inhpar;
+
+explain (verbose, costs off)
+update inhpar set (f1, f2) = (select p2.unique2, p2.stringu1
+                              from int4_tbl limit 1)
+from onek p2 where inhpar.f1 = p2.unique1;
+update inhpar set (f1, f2) = (select p2.unique2, p2.stringu1
+                              from int4_tbl limit 1)
+from onek p2 where inhpar.f1 = p2.unique1;
+
+drop table inhpar cascade;
+
 --
 -- Check handling of a constant-null CHECK constraint
 --