From 24eea4f10fa7129bc6284a7317d413bed2b177b5 Mon Sep 17 00:00:00 2001 From: Amit Langote Date: Thu, 22 Aug 2024 19:38:13 +0900 Subject: [PATCH v55 5/5] Handle CachedPlan invalidation in the executor This commit makes changes to handle cases where a cached plan becomes invalid before deferred locks on prunable relations are taken. * Add checks at various points in ExecutorStart() and its called functions to determine if the plan becomes invalid. If detected, the function and its callers return immediately. A previous commit ensures any partially initialized PlanState tree objects are cleaned up appropriately. * Introduce ExecutorStartExt(), a wrapper over ExecutorStart(), to handle cases where plan initialization is aborted due to invalidation. ExecutorStartExt() creates a new transient CachedPlan if needed and retries execution. This new entry point is only required for sites using plancache.c. It requires passing the QueryDesc, eflags, CachedPlanSource, and query_index (index in CachedPlanSource.query_list). * Add GetSingleCachedPlan() in plancache.c to create a transient CachedPlan for a specified query in the given CachedPlanSource. Such CachedPlans are tracked in a separate global list for the plancache invalidation callbacks to check. This also adds isolation tests using the delay_execution test module to verify scenarios where a CachedPlan becomes invalid before the deferred locks are taken. All ExecutorStart_hook implementations now must add the following block after the ExecutorStart() call to ensure it doesn't work with an invalid plan: /* The plan may have become invalid during ExecutorStart() */ if (!ExecPlanStillValid(queryDesc->estate)) return; Reviewed-by: Robert Haas Discussion: https://postgr.es/m/CA+HiwqFGkMSge6TgC9KQzde0ohpAycLQuV7ooitEEpbKB0O_mg@mail.gmail.comk --- contrib/auto_explain/auto_explain.c | 4 + .../pg_stat_statements/pg_stat_statements.c | 4 + src/backend/commands/explain.c | 8 +- src/backend/commands/portalcmds.c | 1 + src/backend/commands/prepare.c | 10 +- src/backend/commands/trigger.c | 14 ++ src/backend/executor/README | 35 ++- src/backend/executor/execMain.c | 84 ++++++- src/backend/executor/execUtils.c | 3 +- src/backend/executor/spi.c | 19 +- src/backend/tcop/postgres.c | 4 +- src/backend/tcop/pquery.c | 31 ++- src/backend/utils/cache/plancache.c | 206 ++++++++++++++++ src/backend/utils/mmgr/portalmem.c | 4 +- src/include/commands/explain.h | 1 + src/include/commands/trigger.h | 1 + src/include/executor/execdesc.h | 1 + src/include/executor/executor.h | 17 ++ src/include/nodes/execnodes.h | 1 + src/include/utils/plancache.h | 26 ++ src/include/utils/portal.h | 4 +- src/test/modules/delay_execution/Makefile | 3 +- .../modules/delay_execution/delay_execution.c | 63 ++++- .../expected/cached-plan-inval.out | 230 ++++++++++++++++++ src/test/modules/delay_execution/meson.build | 1 + .../specs/cached-plan-inval.spec | 75 ++++++ 26 files changed, 814 insertions(+), 36 deletions(-) create mode 100644 src/test/modules/delay_execution/expected/cached-plan-inval.out create mode 100644 src/test/modules/delay_execution/specs/cached-plan-inval.spec diff --git a/contrib/auto_explain/auto_explain.c b/contrib/auto_explain/auto_explain.c index 677c135f59..9eb5e9a619 100644 --- a/contrib/auto_explain/auto_explain.c +++ b/contrib/auto_explain/auto_explain.c @@ -300,6 +300,10 @@ explain_ExecutorStart(QueryDesc *queryDesc, int eflags) else standard_ExecutorStart(queryDesc, eflags); + /* The plan may have become invalid during standard_ExecutorStart() */ + if (!ExecPlanStillValid(queryDesc->estate)) + return; + if (auto_explain_enabled()) { /* diff --git a/contrib/pg_stat_statements/pg_stat_statements.c b/contrib/pg_stat_statements/pg_stat_statements.c index 3c72e437f7..76642b557a 100644 --- a/contrib/pg_stat_statements/pg_stat_statements.c +++ b/contrib/pg_stat_statements/pg_stat_statements.c @@ -985,6 +985,10 @@ pgss_ExecutorStart(QueryDesc *queryDesc, int eflags) else standard_ExecutorStart(queryDesc, eflags); + /* The plan may have become invalid during standard_ExecutorStart() */ + if (!ExecPlanStillValid(queryDesc->estate)) + return; + /* * If query has queryId zero, don't track it. This prevents double * counting of optimizable statements that are directly contained in diff --git a/src/backend/commands/explain.c b/src/backend/commands/explain.c index 49f7370734..b7a0b8c05b 100644 --- a/src/backend/commands/explain.c +++ b/src/backend/commands/explain.c @@ -509,7 +509,8 @@ standard_ExplainOneQuery(Query *query, int cursorOptions, } /* run it (if needed) and produce output */ - ExplainOnePlan(plan, NULL, into, es, queryString, params, queryEnv, + ExplainOnePlan(plan, NULL, NULL, -1, into, es, queryString, params, + queryEnv, &planduration, (es->buffers ? &bufusage : NULL), es->memory ? &mem_counters : NULL); } @@ -618,6 +619,7 @@ ExplainOneUtility(Node *utilityStmt, IntoClause *into, ExplainState *es, */ void ExplainOnePlan(PlannedStmt *plannedstmt, CachedPlan *cplan, + CachedPlanSource *plansource, int query_index, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv, const instr_time *planduration, @@ -688,8 +690,8 @@ ExplainOnePlan(PlannedStmt *plannedstmt, CachedPlan *cplan, if (into) eflags |= GetIntoRelEFlags(into); - /* call ExecutorStart to prepare the plan for execution */ - ExecutorStart(queryDesc, eflags); + /* Call ExecutorStartExt to prepare the plan for execution. */ + ExecutorStartExt(queryDesc, eflags, plansource, query_index); /* Execute the plan for statistics if asked for */ if (es->analyze) diff --git a/src/backend/commands/portalcmds.c b/src/backend/commands/portalcmds.c index 4f6acf6719..4b1503c05e 100644 --- a/src/backend/commands/portalcmds.c +++ b/src/backend/commands/portalcmds.c @@ -107,6 +107,7 @@ PerformCursorOpen(ParseState *pstate, DeclareCursorStmt *cstmt, ParamListInfo pa queryString, CMDTAG_SELECT, /* cursor's query is always a SELECT */ list_make1(plan), + NULL, NULL); /*---------- diff --git a/src/backend/commands/prepare.c b/src/backend/commands/prepare.c index 311b9ebd5b..4cd79a6e3a 100644 --- a/src/backend/commands/prepare.c +++ b/src/backend/commands/prepare.c @@ -202,7 +202,8 @@ ExecuteQuery(ParseState *pstate, query_string, entry->plansource->commandTag, plan_list, - cplan); + cplan, + entry->plansource); /* * For CREATE TABLE ... AS EXECUTE, we must verify that the prepared @@ -583,6 +584,7 @@ ExplainExecuteQuery(ExecuteStmt *execstmt, IntoClause *into, ExplainState *es, MemoryContextCounters mem_counters; MemoryContext planner_ctx = NULL; MemoryContext saved_ctx = NULL; + int i = 0; if (es->memory) { @@ -655,8 +657,8 @@ ExplainExecuteQuery(ExecuteStmt *execstmt, IntoClause *into, ExplainState *es, PlannedStmt *pstmt = lfirst_node(PlannedStmt, p); if (pstmt->commandType != CMD_UTILITY) - ExplainOnePlan(pstmt, cplan, into, es, query_string, paramLI, - queryEnv, + ExplainOnePlan(pstmt, cplan, entry->plansource, i, + into, es, query_string, paramLI, queryEnv, &planduration, (es->buffers ? &bufusage : NULL), es->memory ? &mem_counters : NULL); else @@ -668,6 +670,8 @@ ExplainExecuteQuery(ExecuteStmt *execstmt, IntoClause *into, ExplainState *es, /* Separate plans with an appropriate separator */ if (lnext(plan_list, p) != NULL) ExplainSeparatePlans(es); + + i++; } if (estate) diff --git a/src/backend/commands/trigger.c b/src/backend/commands/trigger.c index 29d30bfb6f..e33b8f573b 100644 --- a/src/backend/commands/trigger.c +++ b/src/backend/commands/trigger.c @@ -5120,6 +5120,20 @@ AfterTriggerEndQuery(EState *estate) afterTriggers.query_depth--; } +/* ---------- + * AfterTriggerAbortQuery() + * + * Called by ExecutorEnd() if the query execution was aborted due to the + * plan becoming invalid during initialization. + * ---------- + */ +void +AfterTriggerAbortQuery(void) +{ + /* Revert the actions of AfterTriggerBeginQuery(). */ + afterTriggers.query_depth--; +} + /* * AfterTriggerFreeQuery diff --git a/src/backend/executor/README b/src/backend/executor/README index 642d63be61..c76a00b394 100644 --- a/src/backend/executor/README +++ b/src/backend/executor/README @@ -280,6 +280,28 @@ are typically reset to empty once per tuple. Per-tuple contexts are usually associated with ExprContexts, and commonly each PlanState node has its own ExprContext to evaluate its qual and targetlist expressions in. +Relation Locking +---------------- + +Typically, when the executor initializes a plan tree for execution, it doesn't +lock non-index relations if the plan tree is freshly generated and not derived +from a CachedPlan. This is because such locks have already been established +during the query's parsing, rewriting, and planning phases. However, with a +cached plan tree, some relations may remain unlocked. The function +AcquireExecutorLocks() only locks unprunable relations in the plan, deferring +the locking of prunable ones to executor initialization. This avoids +unnecessary locking of relations that will be pruned during "initial" runtime +pruning in ExecDoInitialPruning(). + +This approach creates a window where a cached plan tree with child tables +could become outdated if another backend modifies these tables before +ExecDoInitialPruning() locks them. As a result, the executor has the added duty +to verify the plan tree's validity whenever it locks a child table after +doing initial pruning. This validation is done by checking the CachedPlan.is_valid +attribute. If the plan tree is outdated (is_valid=false), the executor halts +further initialization, cleans up anything in EState that would have been +allocated up to that point, and retries execution after recreating the +invalid plan in the CachedPlan. Query Processing Control Flow ----------------------------- @@ -288,11 +310,13 @@ This is a sketch of control flow for full query processing: CreateQueryDesc - ExecutorStart + ExecutorStart or ExecutorStartExt CreateExecutorState creates per-query context - switch to per-query context to run ExecInitNode + switch to per-query context to run ExecDoInitialPruning and ExecInitNode AfterTriggerBeginQuery + ExecDoInitialPruning + does initial pruning and locks surviving partitions if needed ExecInitNode --- recursively scans plan tree ExecInitNode recurse into subsidiary nodes @@ -316,7 +340,12 @@ This is a sketch of control flow for full query processing: FreeQueryDesc -Per above comments, it's not really critical for ExecEndNode to free any +As mentioned in the "Relation Locking" section, if the plan tree is found to +be stale after locking partitions in ExecDoInitialPruning(), the control is +immediately returned to ExecutorStartExt(), which will create a new plan tree +and perform the steps starting from CreateExecutorState() again. + +Per above comments, it's not really critical for ExecEndPlan to free any memory; it'll all go away in FreeExecutorState anyway. However, we do need to be careful to close relations, drop buffer pins, etc, so we do need to scan the plan state tree to find these sorts of resources. diff --git a/src/backend/executor/execMain.c b/src/backend/executor/execMain.c index df1b5b2dc3..df117e9477 100644 --- a/src/backend/executor/execMain.c +++ b/src/backend/executor/execMain.c @@ -59,6 +59,7 @@ #include "utils/backend_status.h" #include "utils/lsyscache.h" #include "utils/partcache.h" +#include "utils/plancache.h" #include "utils/rls.h" #include "utils/snapmgr.h" @@ -137,6 +138,60 @@ ExecutorStart(QueryDesc *queryDesc, int eflags) standard_ExecutorStart(queryDesc, eflags); } +/* + * A variant of ExecutorStart() that handles cleanup and replanning if the + * input CachedPlan becomes invalid due to locks being taken during + * ExecutorStartInternal(). If that happens, a new CachedPlan is created + * only for the at the index 'query_index' in plansource->query_list, which + * is released separately from the original CachedPlan. + */ +void +ExecutorStartExt(QueryDesc *queryDesc, int eflags, + CachedPlanSource *plansource, + int query_index) +{ + if (queryDesc->cplan == NULL) + { + ExecutorStart(queryDesc, eflags); + return; + } + + while (1) + { + ExecutorStart(queryDesc, eflags); + if (!CachedPlanValid(queryDesc->cplan)) + { + CachedPlan *cplan; + + /* + * The plan got invalidated, so try with a new updated plan. + * + * But first undo what ExecutorStart() would've done. Mark + * execution as aborted to ensure that AFTER trigger state is + * properly reset. + */ + queryDesc->estate->es_aborted = true; + ExecutorEnd(queryDesc); + + cplan = GetSingleCachedPlan(plansource, query_index, + queryDesc->queryEnv); + + /* + * Install the new transient cplan into the QueryDesc replacing + * the old one so that executor initialization code can see it. + * Mark it as in use by us and ask FreeQueryDesc() to release it. + */ + cplan->refcount = 1; + queryDesc->cplan = cplan; + queryDesc->cplan_release = true; + queryDesc->plannedstmt = linitial_node(PlannedStmt, + queryDesc->cplan->stmt_list); + } + else + break; /* ExecutorStart() succeeded! */ + } +} + void standard_ExecutorStart(QueryDesc *queryDesc, int eflags) { @@ -320,6 +375,7 @@ standard_ExecutorRun(QueryDesc *queryDesc, estate = queryDesc->estate; Assert(estate != NULL); + Assert(!estate->es_aborted); Assert(!(estate->es_top_eflags & EXEC_FLAG_EXPLAIN_ONLY)); /* caller must ensure the query's snapshot is active */ @@ -426,8 +482,11 @@ standard_ExecutorFinish(QueryDesc *queryDesc) Assert(estate != NULL); Assert(!(estate->es_top_eflags & EXEC_FLAG_EXPLAIN_ONLY)); - /* This should be run once and only once per Executor instance */ - Assert(!estate->es_finished); + /* + * This should be run once and only once per Executor instance and never + * if the execution was aborted. + */ + Assert(!estate->es_finished && !estate->es_aborted); /* Switch into per-query memory context */ oldcontext = MemoryContextSwitchTo(estate->es_query_cxt); @@ -486,11 +545,10 @@ standard_ExecutorEnd(QueryDesc *queryDesc) Assert(estate != NULL); /* - * Check that ExecutorFinish was called, unless in EXPLAIN-only mode. This - * Assert is needed because ExecutorFinish is new as of 9.1, and callers - * might forget to call it. + * Check that ExecutorFinish was called, unless in EXPLAIN-only mode or if + * execution was aborted. */ - Assert(estate->es_finished || + Assert(estate->es_finished || estate->es_aborted || (estate->es_top_eflags & EXEC_FLAG_EXPLAIN_ONLY)); /* @@ -504,6 +562,14 @@ standard_ExecutorEnd(QueryDesc *queryDesc) UnregisterSnapshot(estate->es_snapshot); UnregisterSnapshot(estate->es_crosscheck_snapshot); + /* + * Reset AFTER trigger module if the query execution was aborted. + */ + if (estate->es_aborted && + !(estate->es_top_eflags & + (EXEC_FLAG_SKIP_TRIGGERS | EXEC_FLAG_EXPLAIN_ONLY))) + AfterTriggerAbortQuery(); + /* * Must switch out of context before destroying it */ @@ -962,6 +1028,9 @@ InitPlan(QueryDesc *queryDesc, int eflags) estate->es_part_prune_infos = plannedstmt->partPruneInfos; ExecDoInitialPruning(estate); + if (!ExecPlanStillValid(estate)) + return; + /* * Next, build the ExecRowMark array from the PlanRowMark(s), if any. */ @@ -2948,6 +3017,9 @@ EvalPlanQualStart(EPQState *epqstate, Plan *planTree) * the snapshot, rangetable, and external Param info. They need their own * copies of local state, including a tuple table, es_param_exec_vals, * result-rel info, etc. + * + * es_cachedplan is not copied because EPQ plan execution does not acquire + * any new locks that could invalidate the CachedPlan. */ rcestate->es_direction = ForwardScanDirection; rcestate->es_snapshot = parentestate->es_snapshot; diff --git a/src/backend/executor/execUtils.c b/src/backend/executor/execUtils.c index 67734979b0..435ae0df7a 100644 --- a/src/backend/executor/execUtils.c +++ b/src/backend/executor/execUtils.c @@ -147,6 +147,7 @@ CreateExecutorState(void) estate->es_top_eflags = 0; estate->es_instrument = 0; estate->es_finished = false; + estate->es_aborted = false; estate->es_exprcontexts = NIL; @@ -757,7 +758,7 @@ ExecInitRangeTable(EState *estate, List *rangeTable, List *permInfos) * ExecGetRangeTableRelation * Open the Relation for a range table entry, if not already done * - * The Relations will be closed again in ExecEndPlan(). + * The Relations will be closed in ExecEndPlan(). */ Relation ExecGetRangeTableRelation(EState *estate, Index rti) diff --git a/src/backend/executor/spi.c b/src/backend/executor/spi.c index 659bd6dcd9..f84f376c9c 100644 --- a/src/backend/executor/spi.c +++ b/src/backend/executor/spi.c @@ -70,7 +70,8 @@ static int _SPI_execute_plan(SPIPlanPtr plan, const SPIExecuteOptions *options, static ParamListInfo _SPI_convert_params(int nargs, Oid *argtypes, Datum *Values, const char *Nulls); -static int _SPI_pquery(QueryDesc *queryDesc, bool fire_triggers, uint64 tcount); +static int _SPI_pquery(QueryDesc *queryDesc, bool fire_triggers, uint64 tcount, + CachedPlanSource *plansource, int query_index); static void _SPI_error_callback(void *arg); @@ -1682,7 +1683,8 @@ SPI_cursor_open_internal(const char *name, SPIPlanPtr plan, query_string, plansource->commandTag, stmt_list, - cplan); + cplan, + plansource); /* * Set up options for portal. Default SCROLL type is chosen the same way @@ -2494,6 +2496,7 @@ _SPI_execute_plan(SPIPlanPtr plan, const SPIExecuteOptions *options, CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc1); List *stmt_list; ListCell *lc2; + int i = 0; spicallbackarg.query = plansource->query_string; @@ -2691,8 +2694,9 @@ _SPI_execute_plan(SPIPlanPtr plan, const SPIExecuteOptions *options, options->params, _SPI_current->queryEnv, 0); - res = _SPI_pquery(qdesc, fire_triggers, - canSetTag ? options->tcount : 0); + + res = _SPI_pquery(qdesc, fire_triggers, canSetTag ? options->tcount : 0, + plansource, i); FreeQueryDesc(qdesc); } else @@ -2789,6 +2793,8 @@ _SPI_execute_plan(SPIPlanPtr plan, const SPIExecuteOptions *options, my_res = res; goto fail; } + + i++; } /* Done with this plan, so release refcount */ @@ -2866,7 +2872,8 @@ _SPI_convert_params(int nargs, Oid *argtypes, } static int -_SPI_pquery(QueryDesc *queryDesc, bool fire_triggers, uint64 tcount) +_SPI_pquery(QueryDesc *queryDesc, bool fire_triggers, uint64 tcount, + CachedPlanSource *plansource, int query_index) { int operation = queryDesc->operation; int eflags; @@ -2922,7 +2929,7 @@ _SPI_pquery(QueryDesc *queryDesc, bool fire_triggers, uint64 tcount) else eflags = EXEC_FLAG_SKIP_TRIGGERS; - ExecutorStart(queryDesc, eflags); + ExecutorStartExt(queryDesc, eflags, plansource, query_index); ExecutorRun(queryDesc, ForwardScanDirection, tcount, true); diff --git a/src/backend/tcop/postgres.c b/src/backend/tcop/postgres.c index e394f1419a..b95c859655 100644 --- a/src/backend/tcop/postgres.c +++ b/src/backend/tcop/postgres.c @@ -1237,6 +1237,7 @@ exec_simple_query(const char *query_string) query_string, commandTag, plantree_list, + NULL, NULL); /* @@ -2039,7 +2040,8 @@ exec_bind_message(StringInfo input_message) query_string, psrc->commandTag, cplan->stmt_list, - cplan); + cplan, + psrc); /* Done with the snapshot used for parameter I/O and parsing/planning */ if (snapshot_set) diff --git a/src/backend/tcop/pquery.c b/src/backend/tcop/pquery.c index 6e8f6b1b8f..dbb0ffb771 100644 --- a/src/backend/tcop/pquery.c +++ b/src/backend/tcop/pquery.c @@ -19,6 +19,7 @@ #include "access/xact.h" #include "commands/prepare.h" +#include "executor/execdesc.h" #include "executor/tstoreReceiver.h" #include "miscadmin.h" #include "pg_trace.h" @@ -37,6 +38,8 @@ Portal ActivePortal = NULL; static void ProcessQuery(PlannedStmt *plan, CachedPlan *cplan, + CachedPlanSource *plansource, + int query_index, const char *sourceText, ParamListInfo params, QueryEnvironment *queryEnv, @@ -80,6 +83,7 @@ CreateQueryDesc(PlannedStmt *plannedstmt, qd->operation = plannedstmt->commandType; /* operation */ qd->plannedstmt = plannedstmt; /* plan */ qd->cplan = cplan; /* CachedPlan supplying the plannedstmt */ + qd->cplan_release = false; qd->sourceText = sourceText; /* query text */ qd->snapshot = RegisterSnapshot(snapshot); /* snapshot */ /* RI check snapshot */ @@ -114,6 +118,13 @@ FreeQueryDesc(QueryDesc *qdesc) UnregisterSnapshot(qdesc->snapshot); UnregisterSnapshot(qdesc->crosscheck_snapshot); + /* + * Release CachedPlan if requested. The CachedPlan is not associated with + * a ResourceOwner when cplan_release is true; see ExecutorStartExt(). + */ + if (qdesc->cplan_release) + ReleaseCachedPlan(qdesc->cplan, NULL); + /* Only the QueryDesc itself need be freed */ pfree(qdesc); } @@ -126,6 +137,8 @@ FreeQueryDesc(QueryDesc *qdesc) * * plan: the plan tree for the query * cplan: CachedPlan supplying the plan + * plansource: CachedPlanSource supplying the cplan + * query_index: index of the query in plansource->query_list * sourceText: the source text of the query * params: any parameters needed * dest: where to send results @@ -139,6 +152,8 @@ FreeQueryDesc(QueryDesc *qdesc) static void ProcessQuery(PlannedStmt *plan, CachedPlan *cplan, + CachedPlanSource *plansource, + int query_index, const char *sourceText, ParamListInfo params, QueryEnvironment *queryEnv, @@ -157,7 +172,7 @@ ProcessQuery(PlannedStmt *plan, /* * Call ExecutorStart to prepare the plan for execution */ - ExecutorStart(queryDesc, 0); + ExecutorStartExt(queryDesc, 0, plansource, query_index); /* * Run the plan to completion. @@ -518,9 +533,12 @@ PortalStart(Portal portal, ParamListInfo params, myeflags = eflags; /* - * Call ExecutorStart to prepare the plan for execution + * ExecutorStartExt() to prepare the plan for execution. If + * the portal is using a cached plan, it may get invalidated + * during plan intialization, in which case a new one is + * created and saved in the QueryDesc. */ - ExecutorStart(queryDesc, myeflags); + ExecutorStartExt(queryDesc, myeflags, portal->plansource, 0); /* * This tells PortalCleanup to shut down the executor @@ -1201,6 +1219,7 @@ PortalRunMulti(Portal portal, { bool active_snapshot_set = false; ListCell *stmtlist_item; + int i = 0; /* * If the destination is DestRemoteExecute, change to DestNone. The @@ -1283,6 +1302,8 @@ PortalRunMulti(Portal portal, /* statement can set tag string */ ProcessQuery(pstmt, portal->cplan, + portal->plansource, + i, portal->sourceText, portal->portalParams, portal->queryEnv, @@ -1293,6 +1314,8 @@ PortalRunMulti(Portal portal, /* stmt added by rewrite cannot set tag */ ProcessQuery(pstmt, portal->cplan, + portal->plansource, + i, portal->sourceText, portal->portalParams, portal->queryEnv, @@ -1357,6 +1380,8 @@ PortalRunMulti(Portal portal, */ if (lnext(portal->stmts, stmtlist_item) != NULL) CommandCounterIncrement(); + + i++; } /* Pop the snapshot if we pushed one. */ diff --git a/src/backend/utils/cache/plancache.c b/src/backend/utils/cache/plancache.c index 5b75dadf13..d33f871ea2 100644 --- a/src/backend/utils/cache/plancache.c +++ b/src/backend/utils/cache/plancache.c @@ -94,6 +94,14 @@ */ static dlist_head saved_plan_list = DLIST_STATIC_INIT(saved_plan_list); +/* + * Head of the backend's list of "standalone" CachedPlans that are not + * associated with a CachedPlanSource, created by GetSingleCachedPlan() for + * transient use by the executor in certain scenarios where they're needed + * only for one execution of the plan. + */ +static dlist_head standalone_plan_list = DLIST_STATIC_INIT(standalone_plan_list); + /* * This is the head of the backend's list of CachedExpressions. */ @@ -905,6 +913,8 @@ CheckCachedPlan(CachedPlanSource *plansource) * Planning work is done in the caller's memory context. The finished plan * is in a child memory context, which typically should get reparented * (unless this is a one-shot plan, in which case we don't copy the plan). + * + * Note: When changing this, you should also look at GetSingleCachedPlan(). */ static CachedPlan * BuildCachedPlan(CachedPlanSource *plansource, List *qlist, @@ -1034,6 +1044,7 @@ BuildCachedPlan(CachedPlanSource *plansource, List *qlist, plan->is_generic = generic; plan->is_saved = false; plan->is_valid = true; + plan->is_standalone = false; /* assign generation number to new plan */ plan->generation = ++(plansource->generation); @@ -1282,6 +1293,121 @@ GetCachedPlan(CachedPlanSource *plansource, ParamListInfo boundParams, return plan; } +/* + * Create a fresh CachedPlan for the query_index'th query in the provided + * CachedPlanSource. + * + * The created CachedPlan is standalone, meaning it is not tracked in the + * CachedPlanSource. The CachedPlan and its plan trees are allocated in a + * child context of the caller's memory context. The caller must ensure they + * remain valid until execution is complete, after which the plan should be + * released by calling ReleaseCachedPlan(). + * + * This function primarily supports ExecutorStartExt(), which handles cases + * where the original generic CachedPlan becomes invalid after prunable + * relations are locked. + */ +CachedPlan * +GetSingleCachedPlan(CachedPlanSource *plansource, int query_index, + QueryEnvironment *queryEnv) +{ + List *query_list = plansource->query_list, + *plan_list; + CachedPlan *plan = plansource->gplan; + MemoryContext oldcxt = CurrentMemoryContext, + plan_context; + PlannedStmt *plannedstmt; + + Assert(ActiveSnapshotSet()); + + /* Sanity checks */ + if (plan == NULL) + elog(ERROR, "GetSingleCachedPlan() called in the wrong context: plansource->gplan is NULL"); + else if (plan->is_valid) + elog(ERROR, "GetSingleCachedPlan() called in the wrong context: plansource->gplan->is_valid"); + + /* + * The plansource might have become invalid since GetCachedPlan(). See the + * comment in BuildCachedPlan() for details on why this might happen. + * + * The risk is greater here because this function is called from the + * executor, meaning much more processing may have occurred compared to + * when BuildCachedPlan() is called from GetCachedPlan(). + */ + if (!plansource->is_valid) + query_list = RevalidateCachedQuery(plansource, queryEnv); + Assert(query_list != NIL); + + /* + * Build a new generic plan for the query_index'th query, but make a copy + * to be scribbled on by the planner + */ + query_list = list_make1(copyObject(list_nth_node(Query, query_list, + query_index))); + plan_list = pg_plan_queries(query_list, plansource->query_string, + plansource->cursor_options, NULL); + + list_free_deep(query_list); + + /* + * Make a dedicated memory context for the CachedPlan and its subsidiary + * data so that we can release it in ReleaseCachedPlan() that will be + * called in FreeQueryDesc(). + */ + plan_context = AllocSetContextCreate(CurrentMemoryContext, + "Standalone CachedPlan", + ALLOCSET_START_SMALL_SIZES); + MemoryContextCopyAndSetIdentifier(plan_context, plansource->query_string); + + /* + * Copy plan into the new context. + */ + MemoryContextSwitchTo(plan_context); + plan_list = copyObject(plan_list); + + /* + * Create and fill the CachedPlan struct within the new context. + */ + plan = (CachedPlan *) palloc(sizeof(CachedPlan)); + plan->magic = CACHEDPLAN_MAGIC; + plan->stmt_list = plan_list; + + plan->planRoleId = GetUserId(); + Assert(list_length(plan_list) == 1); + plannedstmt = linitial_node(PlannedStmt, plan_list); + + /* + * CachedPlan is dependent on role either if RLS affected the rewrite + * phase or if a role dependency was injected during planning. And it's + * transient if any plan is marked so. + */ + plan->dependsOnRole = plansource->dependsOnRLS || plannedstmt->dependsOnRole; + if (plannedstmt->transientPlan) + { + Assert(TransactionIdIsNormal(TransactionXmin)); + plan->saved_xmin = TransactionXmin; + } + else + plan->saved_xmin = InvalidTransactionId; + plan->refcount = 0; + plan->context = plan_context; + plan->is_oneshot = false; + plan->is_generic = true; + plan->is_saved = false; + plan->is_valid = true; + plan->is_standalone = true; + plan->generation = 1; + MemoryContextSwitchTo(oldcxt); + + /* + * Add the entry to the global list of "standalone" cached plans. It is + * removed from the list by ReleaseCachedPlan(). + */ + dlist_push_tail(&standalone_plan_list, &plan->node); + + return plan; +} + /* * ReleaseCachedPlan: release active use of a cached plan. * @@ -1309,6 +1435,10 @@ ReleaseCachedPlan(CachedPlan *plan, ResourceOwner owner) /* Mark it no longer valid */ plan->magic = 0; + /* Remove from the global list if we are a standalone plan. */ + if (plan->is_standalone) + dlist_delete(&plan->node); + /* One-shot plans do not own their context, so we can't free them */ if (!plan->is_oneshot) MemoryContextDelete(plan->context); @@ -2066,6 +2196,33 @@ PlanCacheRelCallback(Datum arg, Oid relid) cexpr->is_valid = false; } } + + /* Finally, invalidate any standalone cached plans */ + dlist_foreach(iter, &standalone_plan_list) + { + CachedPlan *cplan = dlist_container(CachedPlan, + node, iter.cur); + + Assert(cplan->magic == CACHEDPLAN_MAGIC); + + if (cplan->is_valid) + { + ListCell *lc; + + foreach(lc, cplan->stmt_list) + { + PlannedStmt *plannedstmt = lfirst_node(PlannedStmt, lc); + + if (plannedstmt->commandType == CMD_UTILITY) + continue; /* Ignore utility statements */ + if ((relid == InvalidOid) ? plannedstmt->relationOids != NIL : + list_member_oid(plannedstmt->relationOids, relid)) + cplan->is_valid = false; + if (!cplan->is_valid) + break; /* out of stmt_list scan */ + } + } + } } /* @@ -2176,6 +2333,44 @@ PlanCacheObjectCallback(Datum arg, int cacheid, uint32 hashvalue) } } } + + /* Finally, invalidate any standalone cached plans */ + dlist_foreach(iter, &standalone_plan_list) + { + CachedPlan *cplan = dlist_container(CachedPlan, + node, iter.cur); + + Assert(cplan->magic == CACHEDPLAN_MAGIC); + + if (cplan->is_valid) + { + ListCell *lc; + + foreach(lc, cplan->stmt_list) + { + PlannedStmt *plannedstmt = lfirst_node(PlannedStmt, lc); + ListCell *lc3; + + if (plannedstmt->commandType == CMD_UTILITY) + continue; /* Ignore utility statements */ + foreach(lc3, plannedstmt->invalItems) + { + PlanInvalItem *item = (PlanInvalItem *) lfirst(lc3); + + if (item->cacheId != cacheid) + continue; + if (hashvalue == 0 || + item->hashValue == hashvalue) + { + cplan->is_valid = false; + break; /* out of invalItems scan */ + } + } + if (!cplan->is_valid) + break; /* out of stmt_list scan */ + } + } + } } /* @@ -2235,6 +2430,17 @@ ResetPlanCache(void) cexpr->is_valid = false; } + + /* Finally, invalidate any standalone cached plans */ + dlist_foreach(iter, &standalone_plan_list) + { + CachedPlan *cplan = dlist_container(CachedPlan, + node, iter.cur); + + Assert(cplan->magic == CACHEDPLAN_MAGIC); + + cplan->is_valid = false; + } } /* diff --git a/src/backend/utils/mmgr/portalmem.c b/src/backend/utils/mmgr/portalmem.c index 4a24613537..bf70fd4ce7 100644 --- a/src/backend/utils/mmgr/portalmem.c +++ b/src/backend/utils/mmgr/portalmem.c @@ -284,7 +284,8 @@ PortalDefineQuery(Portal portal, const char *sourceText, CommandTag commandTag, List *stmts, - CachedPlan *cplan) + CachedPlan *cplan, + CachedPlanSource *plansource) { Assert(PortalIsValid(portal)); Assert(portal->status == PORTAL_NEW); @@ -299,6 +300,7 @@ PortalDefineQuery(Portal portal, portal->commandTag = commandTag; portal->stmts = stmts; portal->cplan = cplan; + portal->plansource = plansource; portal->status = PORTAL_DEFINED; } diff --git a/src/include/commands/explain.h b/src/include/commands/explain.h index 21c71e0d53..a39989a950 100644 --- a/src/include/commands/explain.h +++ b/src/include/commands/explain.h @@ -104,6 +104,7 @@ extern void ExplainOneUtility(Node *utilityStmt, IntoClause *into, ParamListInfo params, QueryEnvironment *queryEnv); extern void ExplainOnePlan(PlannedStmt *plannedstmt, CachedPlan *cplan, + CachedPlanSource *plansource, int plan_index, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv, diff --git a/src/include/commands/trigger.h b/src/include/commands/trigger.h index 8a5a9fe642..db21561c8c 100644 --- a/src/include/commands/trigger.h +++ b/src/include/commands/trigger.h @@ -258,6 +258,7 @@ extern void ExecASTruncateTriggers(EState *estate, extern void AfterTriggerBeginXact(void); extern void AfterTriggerBeginQuery(void); extern void AfterTriggerEndQuery(EState *estate); +extern void AfterTriggerAbortQuery(void); extern void AfterTriggerFireDeferred(void); extern void AfterTriggerEndXact(bool isCommit); extern void AfterTriggerBeginSubXact(void); diff --git a/src/include/executor/execdesc.h b/src/include/executor/execdesc.h index 0e7245435d..f6cb6479c0 100644 --- a/src/include/executor/execdesc.h +++ b/src/include/executor/execdesc.h @@ -36,6 +36,7 @@ typedef struct QueryDesc CmdType operation; /* CMD_SELECT, CMD_UPDATE, etc. */ PlannedStmt *plannedstmt; /* planner's output (could be utility, too) */ CachedPlan *cplan; /* CachedPlan that supplies the plannedstmt */ + bool cplan_release; /* Should FreeQueryDesc() release cplan? */ const char *sourceText; /* source text of the query */ Snapshot snapshot; /* snapshot to use for query */ Snapshot crosscheck_snapshot; /* crosscheck for RI update/delete */ diff --git a/src/include/executor/executor.h b/src/include/executor/executor.h index 69c3ebff00..5bc0edb5a0 100644 --- a/src/include/executor/executor.h +++ b/src/include/executor/executor.h @@ -19,6 +19,7 @@ #include "nodes/lockoptions.h" #include "nodes/parsenodes.h" #include "utils/memutils.h" +#include "utils/plancache.h" /* @@ -198,6 +199,8 @@ ExecGetJunkAttribute(TupleTableSlot *slot, AttrNumber attno, bool *isNull) * prototypes from functions in execMain.c */ extern void ExecutorStart(QueryDesc *queryDesc, int eflags); +extern void ExecutorStartExt(QueryDesc *queryDesc, int eflags, + CachedPlanSource *plansource, int query_index); extern void standard_ExecutorStart(QueryDesc *queryDesc, int eflags); extern void ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count, bool execute_once); @@ -261,6 +264,19 @@ extern void ExecEndNode(PlanState *node); extern void ExecShutdownNode(PlanState *node); extern void ExecSetTupleBound(int64 tuples_needed, PlanState *child_node); +/* + * Is the CachedPlan in es_cachedplan still valid? + * + * Called from InitPlan() because invalidation messages that affect the plan + * might be received after locks have been taken on runtime-prunable relations. + * The caller should take appropriate action if the plan has become invalid. + */ +static inline bool +ExecPlanStillValid(EState *estate) +{ + return estate->es_cachedplan == NULL ? true : + CachedPlanValid(estate->es_cachedplan); +} /* ---------------------------------------------------------------- * ExecProcNode @@ -589,6 +605,7 @@ extern void ExecCreateScanSlotFromOuterPlan(EState *estate, extern bool ExecRelationIsTargetRelation(EState *estate, Index scanrelid); extern Relation ExecOpenScanRelation(EState *estate, Index scanrelid, int eflags); +extern Relation ExecOpenScanIndexRelation(EState *estate, Oid indexid, int lockmode); extern void ExecInitRangeTable(EState *estate, List *rangeTable, List *permInfos); extern void ExecCloseRangeTableRelations(EState *estate); diff --git a/src/include/nodes/execnodes.h b/src/include/nodes/execnodes.h index 57170818c0..f50b6b50a8 100644 --- a/src/include/nodes/execnodes.h +++ b/src/include/nodes/execnodes.h @@ -690,6 +690,7 @@ typedef struct EState int es_top_eflags; /* eflags passed to ExecutorStart */ int es_instrument; /* OR of InstrumentOption flags */ bool es_finished; /* true when ExecutorFinish is done */ + bool es_aborted; /* true when execution was aborted */ List *es_exprcontexts; /* List of ExprContexts within EState */ diff --git a/src/include/utils/plancache.h b/src/include/utils/plancache.h index 0b5ee007ca..154f68f671 100644 --- a/src/include/utils/plancache.h +++ b/src/include/utils/plancache.h @@ -18,6 +18,7 @@ #include "access/tupdesc.h" #include "lib/ilist.h" #include "nodes/params.h" +#include "nodes/parsenodes.h" #include "tcop/cmdtag.h" #include "utils/queryenvironment.h" #include "utils/resowner.h" @@ -152,6 +153,8 @@ typedef struct CachedPlan bool is_generic; /* is it a reusable generic plan? */ bool is_saved; /* is CachedPlan in a long-lived context? */ bool is_valid; /* is the stmt_list currently valid? */ + bool is_standalone; /* is it not associated with a + * CachedPlanSource? */ Oid planRoleId; /* Role ID the plan was created for */ bool dependsOnRole; /* is plan specific to that role? */ TransactionId saved_xmin; /* if valid, replan when TransactionXmin @@ -159,6 +162,12 @@ typedef struct CachedPlan int generation; /* parent's generation number for this plan */ int refcount; /* count of live references to this struct */ MemoryContext context; /* context containing this CachedPlan */ + + /* + * If the plan is not associated with a CachedPlanSource, it is saved in + * a separate global list. + */ + dlist_node node; /* list link, if is_standalone */ } CachedPlan; /* @@ -224,6 +233,10 @@ extern CachedPlan *GetCachedPlan(CachedPlanSource *plansource, ParamListInfo boundParams, ResourceOwner owner, QueryEnvironment *queryEnv); +extern CachedPlan *GetSingleCachedPlan(CachedPlanSource *plansource, + int query_index, + QueryEnvironment *queryEnv); + extern void ReleaseCachedPlan(CachedPlan *plan, ResourceOwner owner); extern bool CachedPlanAllowsSimpleValidityCheck(CachedPlanSource *plansource, @@ -245,4 +258,17 @@ CachedPlanRequiresLocking(CachedPlan *cplan) return cplan->is_generic; } +/* + * CachedPlanValid + * Returns whether a cached generic plan is still valid. + * + * Invoked by the executor to check if the plan has not been invalidated after + * taking locks during the initialization of the plan. + */ +static inline bool +CachedPlanValid(CachedPlan *cplan) +{ + return cplan->is_valid; +} + #endif /* PLANCACHE_H */ diff --git a/src/include/utils/portal.h b/src/include/utils/portal.h index 29f49829f2..58c3828d2c 100644 --- a/src/include/utils/portal.h +++ b/src/include/utils/portal.h @@ -138,6 +138,7 @@ typedef struct PortalData QueryCompletion qc; /* command completion data for executed query */ List *stmts; /* list of PlannedStmts */ CachedPlan *cplan; /* CachedPlan, if stmts are from one */ + CachedPlanSource *plansource; /* CachedPlanSource, for cplan */ ParamListInfo portalParams; /* params to pass to query */ QueryEnvironment *queryEnv; /* environment for query */ @@ -241,7 +242,8 @@ extern void PortalDefineQuery(Portal portal, const char *sourceText, CommandTag commandTag, List *stmts, - CachedPlan *cplan); + CachedPlan *cplan, + CachedPlanSource *plansource); extern PlannedStmt *PortalGetPrimaryStmt(Portal portal); extern void PortalCreateHoldStore(Portal portal); extern void PortalHashTableDeleteAll(void); diff --git a/src/test/modules/delay_execution/Makefile b/src/test/modules/delay_execution/Makefile index 70f24e846d..3eeb097fde 100644 --- a/src/test/modules/delay_execution/Makefile +++ b/src/test/modules/delay_execution/Makefile @@ -8,7 +8,8 @@ OBJS = \ delay_execution.o ISOLATION = partition-addition \ - partition-removal-1 + partition-removal-1 \ + cached-plan-inval ifdef USE_PGXS PG_CONFIG = pg_config diff --git a/src/test/modules/delay_execution/delay_execution.c b/src/test/modules/delay_execution/delay_execution.c index 155c8a8d55..304ca77f7b 100644 --- a/src/test/modules/delay_execution/delay_execution.c +++ b/src/test/modules/delay_execution/delay_execution.c @@ -1,14 +1,18 @@ /*------------------------------------------------------------------------- * * delay_execution.c - * Test module to allow delay between parsing and execution of a query. + * Test module to introduce delay at various points during execution of a + * query to test that execution proceeds safely in light of concurrent + * changes. * * The delay is implemented by taking and immediately releasing a specified * advisory lock. If another process has previously taken that lock, the * current process will be blocked until the lock is released; otherwise, * there's no effect. This allows an isolationtester script to reliably - * test behaviors where some specified action happens in another backend - * between parsing and execution of any desired query. + * test behaviors where some specified action happens in another backend in + * a couple of cases: 1) between parsing and execution of any desired query + * when using the planner_hook, 2) between RevalidateCachedQuery() and + * ExecutorStart() when using the ExecutorStart_hook. * * Copyright (c) 2020-2024, PostgreSQL Global Development Group * @@ -22,6 +26,7 @@ #include +#include "executor/executor.h" #include "optimizer/planner.h" #include "utils/builtins.h" #include "utils/guc.h" @@ -32,9 +37,11 @@ PG_MODULE_MAGIC; /* GUC: advisory lock ID to use. Zero disables the feature. */ static int post_planning_lock_id = 0; +static int executor_start_lock_id = 0; -/* Save previous planner hook user to be a good citizen */ +/* Save previous hook users to be a good citizen */ static planner_hook_type prev_planner_hook = NULL; +static ExecutorStart_hook_type prev_ExecutorStart_hook = NULL; /* planner_hook function to provide the desired delay */ @@ -70,11 +77,41 @@ delay_execution_planner(Query *parse, const char *query_string, return result; } +/* ExecutorStart_hook function to provide the desired delay */ +static void +delay_execution_ExecutorStart(QueryDesc *queryDesc, int eflags) +{ + /* If enabled, delay by taking and releasing the specified lock */ + if (executor_start_lock_id != 0) + { + DirectFunctionCall1(pg_advisory_lock_int8, + Int64GetDatum((int64) executor_start_lock_id)); + DirectFunctionCall1(pg_advisory_unlock_int8, + Int64GetDatum((int64) executor_start_lock_id)); + + /* + * Ensure that we notice any pending invalidations, since the advisory + * lock functions don't do this. + */ + AcceptInvalidationMessages(); + } + + /* Now start the executor, possibly via a previous hook user */ + if (prev_ExecutorStart_hook) + prev_ExecutorStart_hook(queryDesc, eflags); + else + standard_ExecutorStart(queryDesc, eflags); + + if (executor_start_lock_id != 0) + elog(NOTICE, "Finished ExecutorStart(): CachedPlan is %s", + CachedPlanValid(queryDesc->cplan) ? "valid" : "not valid"); +} + /* Module load function */ void _PG_init(void) { - /* Set up the GUC to control which lock is used */ + /* Set up GUCs to control which lock is used */ DefineCustomIntVariable("delay_execution.post_planning_lock_id", "Sets the advisory lock ID to be locked/unlocked after planning.", "Zero disables the delay.", @@ -86,10 +123,22 @@ _PG_init(void) NULL, NULL, NULL); - + DefineCustomIntVariable("delay_execution.executor_start_lock_id", + "Sets the advisory lock ID to be locked/unlocked before starting execution.", + "Zero disables the delay.", + &executor_start_lock_id, + 0, + 0, INT_MAX, + PGC_USERSET, + 0, + NULL, + NULL, + NULL); MarkGUCPrefixReserved("delay_execution"); - /* Install our hook */ + /* Install our hooks. */ prev_planner_hook = planner_hook; planner_hook = delay_execution_planner; + prev_ExecutorStart_hook = ExecutorStart_hook; + ExecutorStart_hook = delay_execution_ExecutorStart; } diff --git a/src/test/modules/delay_execution/expected/cached-plan-inval.out b/src/test/modules/delay_execution/expected/cached-plan-inval.out new file mode 100644 index 0000000000..e002cfbc9c --- /dev/null +++ b/src/test/modules/delay_execution/expected/cached-plan-inval.out @@ -0,0 +1,230 @@ +Parsed test spec with 2 sessions + +starting permutation: s1prep s2lock s1exec s2dropi s2unlock +step s1prep: SET plan_cache_mode = force_generic_plan; + PREPARE q AS SELECT * FROM foov WHERE a = $1 FOR UPDATE; + EXPLAIN (COSTS OFF) EXECUTE q (1); +QUERY PLAN +------------------------------------------------ +LockRows + -> Append + Subplans Removed: 2 + -> Bitmap Heap Scan on foo12_1 foo_1 + Recheck Cond: (a = $1) + -> Bitmap Index Scan on foo12_1_a + Index Cond: (a = $1) +(7 rows) + +step s2lock: SELECT pg_advisory_lock(12345); +pg_advisory_lock +---------------- + +(1 row) + +step s1exec: LOAD 'delay_execution'; + SET delay_execution.executor_start_lock_id = 12345; + EXPLAIN (COSTS OFF) EXECUTE q (1); +step s2dropi: DROP INDEX foo12_1_a; +step s2unlock: SELECT pg_advisory_unlock(12345); +pg_advisory_unlock +------------------ +t +(1 row) + +step s1exec: <... completed> +s1: NOTICE: Finished ExecutorStart(): CachedPlan is not valid +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +QUERY PLAN +------------------------------------- +LockRows + -> Append + Subplans Removed: 2 + -> Seq Scan on foo12_1 foo_1 + Filter: (a = $1) +(5 rows) + + +starting permutation: s1prep2 s2lock s1exec2 s2dropi s2unlock +step s1prep2: SET plan_cache_mode = force_generic_plan; + PREPARE q2 AS SELECT * FROM foov WHERE a = one() or a = two(); + EXPLAIN (COSTS OFF) EXECUTE q2; +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +QUERY PLAN +-------------------------------------------------- +Append + Subplans Removed: 1 + -> Bitmap Heap Scan on foo12_1 foo_1 + Recheck Cond: ((a = one()) OR (a = two())) + -> BitmapOr + -> Bitmap Index Scan on foo12_1_a + Index Cond: (a = one()) + -> Bitmap Index Scan on foo12_1_a + Index Cond: (a = two()) + -> Seq Scan on foo12_2 foo_2 + Filter: ((a = one()) OR (a = two())) +(11 rows) + +step s2lock: SELECT pg_advisory_lock(12345); +pg_advisory_lock +---------------- + +(1 row) + +step s1exec2: LOAD 'delay_execution'; + SET delay_execution.executor_start_lock_id = 12345; + EXPLAIN (COSTS OFF) EXECUTE q2; +step s2dropi: DROP INDEX foo12_1_a; +step s2unlock: SELECT pg_advisory_unlock(12345); +pg_advisory_unlock +------------------ +t +(1 row) + +step s1exec2: <... completed> +s1: NOTICE: Finished ExecutorStart(): CachedPlan is not valid +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +QUERY PLAN +-------------------------------------------- +Append + Subplans Removed: 1 + -> Seq Scan on foo12_1 foo_1 + Filter: ((a = one()) OR (a = two())) + -> Seq Scan on foo12_2 foo_2 + Filter: ((a = one()) OR (a = two())) +(6 rows) + + +starting permutation: s1prep3 s2lock s1exec3 s2dropi s2unlock +step s1prep3: SET plan_cache_mode = force_generic_plan; + PREPARE q3 AS UPDATE foov SET a = a WHERE a = one() or a = two(); + EXPLAIN (COSTS OFF) EXECUTE q3; +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +QUERY PLAN +-------------------------------------------------------- +Append + Subplans Removed: 1 + -> Bitmap Heap Scan on foo12_1 foo_1 + Recheck Cond: ((a = one()) OR (a = two())) + -> BitmapOr + -> Bitmap Index Scan on foo12_1_a + Index Cond: (a = one()) + -> Bitmap Index Scan on foo12_1_a + Index Cond: (a = two()) + -> Seq Scan on foo12_2 foo_2 + Filter: ((a = one()) OR (a = two())) + +Update on foo + Update on foo12_1 foo_1 + Update on foo12_2 foo_2 + -> Append + Subplans Removed: 1 + -> Bitmap Heap Scan on foo12_1 foo_1 + Recheck Cond: ((a = one()) OR (a = two())) + -> BitmapOr + -> Bitmap Index Scan on foo12_1_a + Index Cond: (a = one()) + -> Bitmap Index Scan on foo12_1_a + Index Cond: (a = two()) + -> Seq Scan on foo12_2 foo_2 + Filter: ((a = one()) OR (a = two())) +(26 rows) + +step s2lock: SELECT pg_advisory_lock(12345); +pg_advisory_lock +---------------- + +(1 row) + +step s1exec3: LOAD 'delay_execution'; + SET delay_execution.executor_start_lock_id = 12345; + EXPLAIN (COSTS OFF) EXECUTE q3; +step s2dropi: DROP INDEX foo12_1_a; +step s2unlock: SELECT pg_advisory_unlock(12345); +pg_advisory_unlock +------------------ +t +(1 row) + +step s1exec3: <... completed> +s1: NOTICE: Finished ExecutorStart(): CachedPlan is not valid +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +s1: NOTICE: Finished ExecutorStart(): CachedPlan is not valid +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +QUERY PLAN +-------------------------------------------------- +Append + Subplans Removed: 1 + -> Seq Scan on foo12_1 foo_1 + Filter: ((a = one()) OR (a = two())) + -> Seq Scan on foo12_2 foo_2 + Filter: ((a = one()) OR (a = two())) + +Update on foo + Update on foo12_1 foo_1 + Update on foo12_2 foo_2 + -> Append + Subplans Removed: 1 + -> Seq Scan on foo12_1 foo_1 + Filter: ((a = one()) OR (a = two())) + -> Seq Scan on foo12_2 foo_2 + Filter: ((a = one()) OR (a = two())) +(16 rows) + + +starting permutation: s1prep4 s2lock s1exec4 s2dropi s2unlock +step s1prep4: SET plan_cache_mode = force_generic_plan; + SET enable_seqscan TO off; + PREPARE q4 AS SELECT * FROM generate_series(1, 1) WHERE EXISTS (SELECT * FROM foov WHERE a = $1 FOR UPDATE); + EXPLAIN (COSTS OFF) EXECUTE q4 (1); +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +QUERY PLAN +--------------------------------------------------------------- +Result + One-Time Filter: (InitPlan 1).col1 + InitPlan 1 + -> LockRows + Disabled Nodes: 2 + -> Append + Disabled Nodes: 2 + Subplans Removed: 2 + -> Index Scan using foo12_1_a on foo12_1 foo_1 + Index Cond: (a = $1) + -> Function Scan on generate_series +(11 rows) + +step s2lock: SELECT pg_advisory_lock(12345); +pg_advisory_lock +---------------- + +(1 row) + +step s1exec4: LOAD 'delay_execution'; + SET delay_execution.executor_start_lock_id = 12345; + EXPLAIN (COSTS OFF) EXECUTE q4 (1); +step s2dropi: DROP INDEX foo12_1_a; +step s2unlock: SELECT pg_advisory_unlock(12345); +pg_advisory_unlock +------------------ +t +(1 row) + +step s1exec4: <... completed> +s1: NOTICE: Finished ExecutorStart(): CachedPlan is not valid +s1: NOTICE: Finished ExecutorStart(): CachedPlan is valid +QUERY PLAN +--------------------------------------------- +Result + One-Time Filter: (InitPlan 1).col1 + InitPlan 1 + -> LockRows + Disabled Nodes: 3 + -> Append + Disabled Nodes: 3 + Subplans Removed: 2 + -> Seq Scan on foo12_1 foo_1 + Disabled Nodes: 1 + Filter: (a = $1) + -> Function Scan on generate_series +(12 rows) + diff --git a/src/test/modules/delay_execution/meson.build b/src/test/modules/delay_execution/meson.build index 41f3ac0b89..5a70b183d0 100644 --- a/src/test/modules/delay_execution/meson.build +++ b/src/test/modules/delay_execution/meson.build @@ -24,6 +24,7 @@ tests += { 'specs': [ 'partition-addition', 'partition-removal-1', + 'cached-plan-inval', ], }, } diff --git a/src/test/modules/delay_execution/specs/cached-plan-inval.spec b/src/test/modules/delay_execution/specs/cached-plan-inval.spec new file mode 100644 index 0000000000..820a843051 --- /dev/null +++ b/src/test/modules/delay_execution/specs/cached-plan-inval.spec @@ -0,0 +1,75 @@ +# Test to check that invalidation of cached generic plans during ExecutorStart +# correctly triggers replanning and re-execution. + +setup +{ + CREATE TABLE foo (a int, b text) PARTITION BY LIST(a); + CREATE TABLE foo12 PARTITION OF foo FOR VALUES IN (1, 2) PARTITION BY LIST (a); + CREATE TABLE foo12_1 PARTITION OF foo12 FOR VALUES IN (1); + CREATE TABLE foo12_2 PARTITION OF foo12 FOR VALUES IN (2); + CREATE INDEX foo12_1_a ON foo12_1 (a); + CREATE TABLE foo3 PARTITION OF foo FOR VALUES IN (3); + CREATE VIEW foov AS SELECT * FROM foo; + CREATE FUNCTION one () RETURNS int AS $$ BEGIN RETURN 1; END; $$ LANGUAGE PLPGSQL STABLE; + CREATE FUNCTION two () RETURNS int AS $$ BEGIN RETURN 2; END; $$ LANGUAGE PLPGSQL STABLE; + CREATE RULE update_foo AS ON UPDATE TO foo DO ALSO SELECT 1; +} + +teardown +{ + DROP VIEW foov; + DROP RULE update_foo ON foo; + DROP TABLE foo; + DROP FUNCTION one(), two(); +} + +session "s1" +# Append with run-time pruning +step "s1prep" { SET plan_cache_mode = force_generic_plan; + PREPARE q AS SELECT * FROM foov WHERE a = $1 FOR UPDATE; + EXPLAIN (COSTS OFF) EXECUTE q (1); } + +# Another case with Append with run-time pruning +step "s1prep2" { SET plan_cache_mode = force_generic_plan; + PREPARE q2 AS SELECT * FROM foov WHERE a = one() or a = two(); + EXPLAIN (COSTS OFF) EXECUTE q2; } + +# Case with a rule adding another query +step "s1prep3" { SET plan_cache_mode = force_generic_plan; + PREPARE q3 AS UPDATE foov SET a = a WHERE a = one() or a = two(); + EXPLAIN (COSTS OFF) EXECUTE q3; } + +# Another case with Append with run-time pruning in a subquery +step "s1prep4" { SET plan_cache_mode = force_generic_plan; + SET enable_seqscan TO off; + PREPARE q4 AS SELECT * FROM generate_series(1, 1) WHERE EXISTS (SELECT * FROM foov WHERE a = $1 FOR UPDATE); + EXPLAIN (COSTS OFF) EXECUTE q4 (1); } + +# Executes a generic plan +step "s1exec" { LOAD 'delay_execution'; + SET delay_execution.executor_start_lock_id = 12345; + EXPLAIN (COSTS OFF) EXECUTE q (1); } +step "s1exec2" { LOAD 'delay_execution'; + SET delay_execution.executor_start_lock_id = 12345; + EXPLAIN (COSTS OFF) EXECUTE q2; } +step "s1exec3" { LOAD 'delay_execution'; + SET delay_execution.executor_start_lock_id = 12345; + EXPLAIN (COSTS OFF) EXECUTE q3; } +step "s1exec4" { LOAD 'delay_execution'; + SET delay_execution.executor_start_lock_id = 12345; + EXPLAIN (COSTS OFF) EXECUTE q4 (1); } + +session "s2" +step "s2lock" { SELECT pg_advisory_lock(12345); } +step "s2unlock" { SELECT pg_advisory_unlock(12345); } +step "s2dropi" { DROP INDEX foo12_1_a; } + +# While "s1exec", etc. wait to acquire the advisory lock, "s2drop" is able to +# drop the index being used in the cached plan. When "s1exec" is then +# unblocked and initializes the cached plan for execution, it detects the +# concurrent index drop and causes the cached plan to be discarded and +# recreated without the index. +permutation "s1prep" "s2lock" "s1exec" "s2dropi" "s2unlock" +permutation "s1prep2" "s2lock" "s1exec2" "s2dropi" "s2unlock" +permutation "s1prep3" "s2lock" "s1exec3" "s2dropi" "s2unlock" +permutation "s1prep4" "s2lock" "s1exec4" "s2dropi" "s2unlock" -- 2.43.0