1 /*-------------------------------------------------------------------------
4 * top level executor interface routines
11 * The old ExecutorMain() has been replaced by ExecutorStart(),
12 * ExecutorRun() and ExecutorEnd()
14 * These three procedures are the external interfaces to the executor.
15 * In each case, the query descriptor is required as an argument.
17 * ExecutorStart() must be called at the beginning of execution of any
18 * query plan and ExecutorEnd() should always be called at the end of
19 * execution of a plan.
21 * ExecutorRun accepts direction and count arguments that specify whether
22 * the plan is to be executed forwards, backwards, and for how many tuples.
24 * Portions Copyright (c) 1996-2003, PostgreSQL Global Development Group
25 * Portions Copyright (c) 1994, Regents of the University of California
29 * $PostgreSQL: pgsql/src/backend/executor/execMain.c,v 1.228 2004/01/22 02:23:21 tgl Exp $
31 *-------------------------------------------------------------------------
35 #include "access/heapam.h"
36 #include "catalog/heap.h"
37 #include "catalog/namespace.h"
38 #include "commands/tablecmds.h"
39 #include "commands/trigger.h"
40 #include "executor/execdebug.h"
41 #include "executor/execdefs.h"
42 #include "miscadmin.h"
43 #include "optimizer/clauses.h"
44 #include "optimizer/var.h"
45 #include "parser/parsetree.h"
46 #include "utils/acl.h"
47 #include "utils/guc.h"
48 #include "utils/lsyscache.h"
51 typedef struct execRowMark
58 typedef struct evalPlanQual
63 struct evalPlanQual *next; /* stack of active PlanQual plans */
64 struct evalPlanQual *free; /* list of free PlanQual plans */
67 /* decls for local routines only used within this module */
68 static void InitPlan(QueryDesc *queryDesc, bool explainOnly);
69 static void initResultRelInfo(ResultRelInfo *resultRelInfo,
70 Index resultRelationIndex,
73 static TupleTableSlot *ExecutePlan(EState *estate, PlanState *planstate,
76 ScanDirection direction,
78 static void ExecSelect(TupleTableSlot *slot,
81 static void ExecInsert(TupleTableSlot *slot, ItemPointer tupleid,
83 static void ExecDelete(TupleTableSlot *slot, ItemPointer tupleid,
85 static void ExecUpdate(TupleTableSlot *slot, ItemPointer tupleid,
87 static TupleTableSlot *EvalPlanQualNext(EState *estate);
88 static void EndEvalPlanQual(EState *estate);
89 static void ExecCheckRTEPerms(RangeTblEntry *rte);
90 static void ExecCheckXactReadOnly(Query *parsetree);
91 static void EvalPlanQualStart(evalPlanQual *epq, EState *estate,
92 evalPlanQual *priorepq);
93 static void EvalPlanQualStop(evalPlanQual *epq);
95 /* end of local decls */
98 /* ----------------------------------------------------------------
101 * This routine must be called at the beginning of any execution of any
104 * Takes a QueryDesc previously created by CreateQueryDesc (it's not real
105 * clear why we bother to separate the two functions, but...). The tupDesc
106 * field of the QueryDesc is filled in to describe the tuples that will be
107 * returned, and the internal fields (estate and planstate) are set up.
109 * If useCurrentSnapshot is true, run the query with the latest available
110 * snapshot, instead of the normal QuerySnapshot. Also, if it's an update
111 * or delete query, check that the rows to be updated or deleted would be
112 * visible to the normal QuerySnapshot. (This is a special-case behavior
113 * needed for referential integrity updates in serializable transactions.
114 * We must check all currently-committed rows, but we want to throw a
115 * can't-serialize error if any rows that would need updates would not be
116 * visible under the normal serializable snapshot.)
118 * If explainOnly is true, we are not actually intending to run the plan,
119 * only to set up for EXPLAIN; so skip unwanted side-effects.
121 * NB: the CurrentMemoryContext when this is called will become the parent
122 * of the per-query context used for this Executor invocation.
123 * ----------------------------------------------------------------
126 ExecutorStart(QueryDesc *queryDesc, bool useCurrentSnapshot, bool explainOnly)
129 MemoryContext oldcontext;
131 /* sanity checks: queryDesc must not be started already */
132 Assert(queryDesc != NULL);
133 Assert(queryDesc->estate == NULL);
136 * If the transaction is read-only, we need to check if any writes are
137 * planned to non-temporary tables.
139 if (XactReadOnly && !explainOnly)
140 ExecCheckXactReadOnly(queryDesc->parsetree);
143 * Build EState, switch into per-query memory context for startup.
145 estate = CreateExecutorState();
146 queryDesc->estate = estate;
148 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
151 * Fill in parameters, if any, from queryDesc
153 estate->es_param_list_info = queryDesc->params;
155 if (queryDesc->plantree->nParamExec > 0)
156 estate->es_param_exec_vals = (ParamExecData *)
157 palloc0(queryDesc->plantree->nParamExec * sizeof(ParamExecData));
159 estate->es_instrument = queryDesc->doInstrument;
162 * Make our own private copy of the current query snapshot data.
164 * This "freezes" our idea of which tuples are good and which are not for
165 * the life of this query, even if it outlives the current command and
168 if (useCurrentSnapshot)
170 /* RI update/delete query --- must use an up-to-date snapshot */
171 estate->es_snapshot = CopyCurrentSnapshot();
172 /* crosscheck updates/deletes against transaction snapshot */
173 estate->es_crosscheck_snapshot = CopyQuerySnapshot();
177 /* normal query --- use query snapshot, no crosscheck */
178 estate->es_snapshot = CopyQuerySnapshot();
179 estate->es_crosscheck_snapshot = SnapshotAny;
183 * Initialize the plan state tree
185 InitPlan(queryDesc, explainOnly);
187 MemoryContextSwitchTo(oldcontext);
190 /* ----------------------------------------------------------------
193 * This is the main routine of the executor module. It accepts
194 * the query descriptor from the traffic cop and executes the
197 * ExecutorStart must have been called already.
199 * If direction is NoMovementScanDirection then nothing is done
200 * except to start up/shut down the destination. Otherwise,
201 * we retrieve up to 'count' tuples in the specified direction.
203 * Note: count = 0 is interpreted as no portal limit, i.e., run to
206 * ----------------------------------------------------------------
209 ExecutorRun(QueryDesc *queryDesc,
210 ScanDirection direction, long count)
215 TupleTableSlot *result;
216 MemoryContext oldcontext;
219 Assert(queryDesc != NULL);
221 estate = queryDesc->estate;
223 Assert(estate != NULL);
226 * Switch into per-query memory context
228 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
231 * extract information from the query descriptor and the query
234 operation = queryDesc->operation;
235 dest = queryDesc->dest;
238 * startup tuple receiver
240 estate->es_processed = 0;
241 estate->es_lastoid = InvalidOid;
243 (*dest->rStartup) (dest, operation, queryDesc->tupDesc);
248 if (direction == NoMovementScanDirection)
251 result = ExecutePlan(estate,
252 queryDesc->planstate,
261 (*dest->rShutdown) (dest);
263 MemoryContextSwitchTo(oldcontext);
268 /* ----------------------------------------------------------------
271 * This routine must be called at the end of execution of any
273 * ----------------------------------------------------------------
276 ExecutorEnd(QueryDesc *queryDesc)
279 MemoryContext oldcontext;
282 Assert(queryDesc != NULL);
284 estate = queryDesc->estate;
286 Assert(estate != NULL);
289 * Switch into per-query memory context to run ExecEndPlan
291 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
293 ExecEndPlan(queryDesc->planstate, estate);
296 * Must switch out of context before destroying it
298 MemoryContextSwitchTo(oldcontext);
301 * Release EState and per-query memory context. This should release
302 * everything the executor has allocated.
304 FreeExecutorState(estate);
306 /* Reset queryDesc fields that no longer point to anything */
307 queryDesc->tupDesc = NULL;
308 queryDesc->estate = NULL;
309 queryDesc->planstate = NULL;
312 /* ----------------------------------------------------------------
315 * This routine may be called on an open queryDesc to rewind it
317 * ----------------------------------------------------------------
320 ExecutorRewind(QueryDesc *queryDesc)
323 MemoryContext oldcontext;
326 Assert(queryDesc != NULL);
328 estate = queryDesc->estate;
330 Assert(estate != NULL);
332 /* It's probably not sensible to rescan updating queries */
333 Assert(queryDesc->operation == CMD_SELECT);
336 * Switch into per-query memory context
338 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
343 ExecReScan(queryDesc->planstate, NULL);
345 MemoryContextSwitchTo(oldcontext);
351 * Check access permissions for all relations listed in a range table.
354 ExecCheckRTPerms(List *rangeTable)
358 foreach(lp, rangeTable)
360 RangeTblEntry *rte = lfirst(lp);
362 ExecCheckRTEPerms(rte);
368 * Check access permissions for a single RTE.
371 ExecCheckRTEPerms(RangeTblEntry *rte)
373 AclMode requiredPerms;
378 * If it's a subquery, recursively examine its rangetable.
380 if (rte->rtekind == RTE_SUBQUERY)
382 ExecCheckRTPerms(rte->subquery->rtable);
387 * Otherwise, only plain-relation RTEs need to be checked here.
388 * Function RTEs are checked by init_fcache when the function is
389 * prepared for execution. Join and special RTEs need no checks.
391 if (rte->rtekind != RTE_RELATION)
395 * No work if requiredPerms is empty.
397 requiredPerms = rte->requiredPerms;
398 if (requiredPerms == 0)
404 * userid to check as: current user unless we have a setuid
407 * Note: GetUserId() is presently fast enough that there's no harm in
408 * calling it separately for each RTE. If that stops being true, we
409 * could call it once in ExecCheckRTPerms and pass the userid down
410 * from there. But for now, no need for the extra clutter.
412 userid = rte->checkAsUser ? rte->checkAsUser : GetUserId();
415 * For each bit in requiredPerms, apply the required check. (We can't
416 * do this in one aclcheck call because aclcheck treats multiple bits
417 * as OR semantics, when we want AND.)
419 * We use a well-known cute trick for isolating the rightmost one-bit
420 * in a nonzero word. See nodes/bitmapset.c for commentary.
422 #define RIGHTMOST_ONE(x) ((int32) (x) & -((int32) (x)))
424 while (requiredPerms != 0)
427 AclResult aclcheck_result;
429 thisPerm = RIGHTMOST_ONE(requiredPerms);
430 requiredPerms &= ~thisPerm;
432 aclcheck_result = pg_class_aclcheck(relOid, userid, thisPerm);
433 if (aclcheck_result != ACLCHECK_OK)
434 aclcheck_error(aclcheck_result, ACL_KIND_CLASS,
435 get_rel_name(relOid));
440 * Check that the query does not imply any writes to non-temp tables.
443 ExecCheckXactReadOnly(Query *parsetree)
448 * CREATE TABLE AS or SELECT INTO?
450 * XXX should we allow this if the destination is temp?
452 if (parsetree->into != NULL)
455 /* Fail if write permissions are requested on any non-temp table */
456 foreach(lp, parsetree->rtable)
458 RangeTblEntry *rte = lfirst(lp);
460 if (rte->rtekind == RTE_SUBQUERY)
462 ExecCheckXactReadOnly(rte->subquery);
466 if (rte->rtekind != RTE_RELATION)
469 if ((rte->requiredPerms & (~ACL_SELECT)) == 0)
472 if (isTempNamespace(get_rel_namespace(rte->relid)))
482 (errcode(ERRCODE_READ_ONLY_SQL_TRANSACTION),
483 errmsg("transaction is read-only")));
487 /* ----------------------------------------------------------------
490 * Initializes the query plan: open files, allocate storage
491 * and start up the rule manager
492 * ----------------------------------------------------------------
495 InitPlan(QueryDesc *queryDesc, bool explainOnly)
497 CmdType operation = queryDesc->operation;
498 Query *parseTree = queryDesc->parsetree;
499 Plan *plan = queryDesc->plantree;
500 EState *estate = queryDesc->estate;
501 PlanState *planstate;
503 Relation intoRelationDesc;
508 * Do permissions checks. It's sufficient to examine the query's top
509 * rangetable here --- subplan RTEs will be checked during
512 ExecCheckRTPerms(parseTree->rtable);
515 * get information from query descriptor
517 rangeTable = parseTree->rtable;
520 * initialize the node's execution state
522 estate->es_range_table = rangeTable;
525 * if there is a result relation, initialize result relation stuff
527 if (parseTree->resultRelation != 0 && operation != CMD_SELECT)
529 List *resultRelations = parseTree->resultRelations;
530 int numResultRelations;
531 ResultRelInfo *resultRelInfos;
533 if (resultRelations != NIL)
536 * Multiple result relations (due to inheritance)
537 * parseTree->resultRelations identifies them all
539 ResultRelInfo *resultRelInfo;
541 numResultRelations = length(resultRelations);
542 resultRelInfos = (ResultRelInfo *)
543 palloc(numResultRelations * sizeof(ResultRelInfo));
544 resultRelInfo = resultRelInfos;
545 while (resultRelations != NIL)
547 initResultRelInfo(resultRelInfo,
548 lfirsti(resultRelations),
552 resultRelations = lnext(resultRelations);
558 * Single result relation identified by
559 * parseTree->resultRelation
561 numResultRelations = 1;
562 resultRelInfos = (ResultRelInfo *) palloc(sizeof(ResultRelInfo));
563 initResultRelInfo(resultRelInfos,
564 parseTree->resultRelation,
569 estate->es_result_relations = resultRelInfos;
570 estate->es_num_result_relations = numResultRelations;
571 /* Initialize to first or only result rel */
572 estate->es_result_relation_info = resultRelInfos;
577 * if no result relation, then set state appropriately
579 estate->es_result_relations = NULL;
580 estate->es_num_result_relations = 0;
581 estate->es_result_relation_info = NULL;
585 * Detect whether we're doing SELECT INTO. If so, set the force_oids
586 * flag appropriately so that the plan tree will be initialized with
587 * the correct tuple descriptors.
589 do_select_into = false;
591 if (operation == CMD_SELECT && parseTree->into != NULL)
593 do_select_into = true;
594 estate->es_select_into = true;
595 estate->es_into_oids = parseTree->intoHasOids;
599 * Have to lock relations selected for update
601 estate->es_rowMark = NIL;
602 if (parseTree->rowMarks != NIL)
606 foreach(l, parseTree->rowMarks)
608 Index rti = lfirsti(l);
609 Oid relid = getrelid(rti, rangeTable);
613 relation = heap_open(relid, RowShareLock);
614 erm = (execRowMark *) palloc(sizeof(execRowMark));
615 erm->relation = relation;
617 snprintf(erm->resname, sizeof(erm->resname), "ctid%u", rti);
618 estate->es_rowMark = lappend(estate->es_rowMark, erm);
623 * initialize the executor "tuple" table. We need slots for all the
624 * plan nodes, plus possibly output slots for the junkfilter(s). At
625 * this point we aren't sure if we need junkfilters, so just add slots
626 * for them unconditionally.
629 int nSlots = ExecCountSlotsNode(plan);
631 if (parseTree->resultRelations != NIL)
632 nSlots += length(parseTree->resultRelations);
635 estate->es_tupleTable = ExecCreateTupleTable(nSlots);
638 /* mark EvalPlanQual not active */
639 estate->es_topPlan = plan;
640 estate->es_evalPlanQual = NULL;
641 estate->es_evTupleNull = NULL;
642 estate->es_evTuple = NULL;
643 estate->es_useEvalPlan = false;
646 * initialize the private state information for all the nodes in the
647 * query tree. This opens files, allocates storage and leaves us
648 * ready to start processing tuples.
650 planstate = ExecInitNode(plan, estate);
653 * Get the tuple descriptor describing the type of tuples to return.
654 * (this is especially important if we are creating a relation with
657 tupType = ExecGetResultType(planstate);
660 * Initialize the junk filter if needed. SELECT and INSERT queries
661 * need a filter if there are any junk attrs in the tlist. INSERT and
662 * SELECT INTO also need a filter if the top plan node is a scan node
663 * that's not doing projection (else we'll be scribbling on the scan
664 * tuple!) UPDATE and DELETE always need a filter, since there's
665 * always a junk 'ctid' attribute present --- no need to look first.
668 bool junk_filter_needed = false;
675 foreach(tlist, plan->targetlist)
677 TargetEntry *tle = (TargetEntry *) lfirst(tlist);
679 if (tle->resdom->resjunk)
681 junk_filter_needed = true;
685 if (!junk_filter_needed &&
686 (operation == CMD_INSERT || do_select_into))
688 if (IsA(planstate, SeqScanState) ||
689 IsA(planstate, IndexScanState) ||
690 IsA(planstate, TidScanState) ||
691 IsA(planstate, SubqueryScanState) ||
692 IsA(planstate, FunctionScanState))
694 if (planstate->ps_ProjInfo == NULL)
695 junk_filter_needed = true;
701 junk_filter_needed = true;
707 if (junk_filter_needed)
710 * If there are multiple result relations, each one needs its
711 * own junk filter. Note this is only possible for
712 * UPDATE/DELETE, so we can't be fooled by some needing a
713 * filter and some not.
715 if (parseTree->resultRelations != NIL)
717 PlanState **appendplans;
719 ResultRelInfo *resultRelInfo;
722 /* Top plan had better be an Append here. */
723 Assert(IsA(plan, Append));
724 Assert(((Append *) plan)->isTarget);
725 Assert(IsA(planstate, AppendState));
726 appendplans = ((AppendState *) planstate)->appendplans;
727 as_nplans = ((AppendState *) planstate)->as_nplans;
728 Assert(as_nplans == estate->es_num_result_relations);
729 resultRelInfo = estate->es_result_relations;
730 for (i = 0; i < as_nplans; i++)
732 PlanState *subplan = appendplans[i];
735 j = ExecInitJunkFilter(subplan->plan->targetlist,
736 ExecGetResultType(subplan),
737 ExecAllocTableSlot(estate->es_tupleTable));
738 resultRelInfo->ri_junkFilter = j;
743 * Set active junkfilter too; at this point ExecInitAppend
744 * has already selected an active result relation...
746 estate->es_junkFilter =
747 estate->es_result_relation_info->ri_junkFilter;
751 /* Normal case with just one JunkFilter */
754 j = ExecInitJunkFilter(planstate->plan->targetlist,
756 ExecAllocTableSlot(estate->es_tupleTable));
757 estate->es_junkFilter = j;
758 if (estate->es_result_relation_info)
759 estate->es_result_relation_info->ri_junkFilter = j;
761 /* For SELECT, want to return the cleaned tuple type */
762 if (operation == CMD_SELECT)
763 tupType = j->jf_cleanTupType;
767 estate->es_junkFilter = NULL;
771 * If doing SELECT INTO, initialize the "into" relation. We must wait
772 * till now so we have the "clean" result tuple type to create the new
775 * If EXPLAIN, skip creating the "into" relation.
777 intoRelationDesc = NULL;
779 if (do_select_into && !explainOnly)
788 * find namespace to create in, check permissions
790 intoName = parseTree->into->relname;
791 namespaceId = RangeVarGetCreationNamespace(parseTree->into);
793 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
795 if (aclresult != ACLCHECK_OK)
796 aclcheck_error(aclresult, ACL_KIND_NAMESPACE,
797 get_namespace_name(namespaceId));
800 * have to copy tupType to get rid of constraints
802 tupdesc = CreateTupleDescCopy(tupType);
804 intoRelationId = heap_create_with_catalog(intoName,
810 allowSystemTableMods);
812 FreeTupleDesc(tupdesc);
815 * Advance command counter so that the newly-created relation's
816 * catalog tuples will be visible to heap_open.
818 CommandCounterIncrement();
821 * If necessary, create a TOAST table for the into relation. Note
822 * that AlterTableCreateToastTable ends with
823 * CommandCounterIncrement(), so that the TOAST table will be
824 * visible for insertion.
826 AlterTableCreateToastTable(intoRelationId, true);
829 * And open the constructed table for writing.
831 intoRelationDesc = heap_open(intoRelationId, AccessExclusiveLock);
834 estate->es_into_relation_descriptor = intoRelationDesc;
836 queryDesc->tupDesc = tupType;
837 queryDesc->planstate = planstate;
841 * Initialize ResultRelInfo data for one result relation
844 initResultRelInfo(ResultRelInfo *resultRelInfo,
845 Index resultRelationIndex,
849 Oid resultRelationOid;
850 Relation resultRelationDesc;
852 resultRelationOid = getrelid(resultRelationIndex, rangeTable);
853 resultRelationDesc = heap_open(resultRelationOid, RowExclusiveLock);
855 switch (resultRelationDesc->rd_rel->relkind)
857 case RELKIND_SEQUENCE:
859 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
860 errmsg("cannot change sequence \"%s\"",
861 RelationGetRelationName(resultRelationDesc))));
863 case RELKIND_TOASTVALUE:
865 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
866 errmsg("cannot change TOAST relation \"%s\"",
867 RelationGetRelationName(resultRelationDesc))));
871 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
872 errmsg("cannot change view \"%s\"",
873 RelationGetRelationName(resultRelationDesc))));
877 MemSet(resultRelInfo, 0, sizeof(ResultRelInfo));
878 resultRelInfo->type = T_ResultRelInfo;
879 resultRelInfo->ri_RangeTableIndex = resultRelationIndex;
880 resultRelInfo->ri_RelationDesc = resultRelationDesc;
881 resultRelInfo->ri_NumIndices = 0;
882 resultRelInfo->ri_IndexRelationDescs = NULL;
883 resultRelInfo->ri_IndexRelationInfo = NULL;
884 /* make a copy so as not to depend on relcache info not changing... */
885 resultRelInfo->ri_TrigDesc = CopyTriggerDesc(resultRelationDesc->trigdesc);
886 resultRelInfo->ri_TrigFunctions = NULL;
887 resultRelInfo->ri_ConstraintExprs = NULL;
888 resultRelInfo->ri_junkFilter = NULL;
891 * If there are indices on the result relation, open them and save
892 * descriptors in the result relation info, so that we can add new
893 * index entries for the tuples we add/update. We need not do this
894 * for a DELETE, however, since deletion doesn't affect indexes.
896 if (resultRelationDesc->rd_rel->relhasindex &&
897 operation != CMD_DELETE)
898 ExecOpenIndices(resultRelInfo);
902 * ExecContextForcesOids
904 * This is pretty grotty: when doing INSERT, UPDATE, or SELECT INTO,
905 * we need to ensure that result tuples have space for an OID iff they are
906 * going to be stored into a relation that has OIDs. In other contexts
907 * we are free to choose whether to leave space for OIDs in result tuples
908 * (we generally don't want to, but we do if a physical-tlist optimization
909 * is possible). This routine checks the plan context and returns TRUE if the
910 * choice is forced, FALSE if the choice is not forced. In the TRUE case,
911 * *hasoids is set to the required value.
913 * One reason this is ugly is that all plan nodes in the plan tree will emit
914 * tuples with space for an OID, though we really only need the topmost node
915 * to do so. However, node types like Sort don't project new tuples but just
916 * return their inputs, and in those cases the requirement propagates down
917 * to the input node. Eventually we might make this code smart enough to
918 * recognize how far down the requirement really goes, but for now we just
919 * make all plan nodes do the same thing if the top level forces the choice.
921 * We assume that estate->es_result_relation_info is already set up to
922 * describe the target relation. Note that in an UPDATE that spans an
923 * inheritance tree, some of the target relations may have OIDs and some not.
924 * We have to make the decisions on a per-relation basis as we initialize
925 * each of the child plans of the topmost Append plan.
927 * SELECT INTO is even uglier, because we don't have the INTO relation's
928 * descriptor available when this code runs; we have to look aside at a
929 * flag set by InitPlan().
932 ExecContextForcesOids(PlanState *planstate, bool *hasoids)
934 if (planstate->state->es_select_into)
936 *hasoids = planstate->state->es_into_oids;
941 ResultRelInfo *ri = planstate->state->es_result_relation_info;
945 Relation rel = ri->ri_RelationDesc;
949 *hasoids = rel->rd_rel->relhasoids;
958 /* ----------------------------------------------------------------
961 * Cleans up the query plan -- closes files and frees up storage
963 * NOTE: we are no longer very worried about freeing storage per se
964 * in this code; FreeExecutorState should be guaranteed to release all
965 * memory that needs to be released. What we are worried about doing
966 * is closing relations and dropping buffer pins. Thus, for example,
967 * tuple tables must be cleared or dropped to ensure pins are released.
968 * ----------------------------------------------------------------
971 ExecEndPlan(PlanState *planstate, EState *estate)
973 ResultRelInfo *resultRelInfo;
978 * shut down any PlanQual processing we were doing
980 if (estate->es_evalPlanQual != NULL)
981 EndEvalPlanQual(estate);
984 * shut down the node-type-specific query processing
986 ExecEndNode(planstate);
989 * destroy the executor "tuple" table.
991 ExecDropTupleTable(estate->es_tupleTable, true);
992 estate->es_tupleTable = NULL;
995 * close the result relation(s) if any, but hold locks until xact
998 resultRelInfo = estate->es_result_relations;
999 for (i = estate->es_num_result_relations; i > 0; i--)
1001 /* Close indices and then the relation itself */
1002 ExecCloseIndices(resultRelInfo);
1003 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
1008 * close the "into" relation if necessary, again keeping lock
1010 if (estate->es_into_relation_descriptor != NULL)
1011 heap_close(estate->es_into_relation_descriptor, NoLock);
1014 * close any relations selected FOR UPDATE, again keeping locks
1016 foreach(l, estate->es_rowMark)
1018 execRowMark *erm = lfirst(l);
1020 heap_close(erm->relation, NoLock);
1024 /* ----------------------------------------------------------------
1027 * processes the query plan to retrieve 'numberTuples' tuples in the
1028 * direction specified.
1030 * Retrieves all tuples if numberTuples is 0
1032 * result is either a slot containing the last tuple in the case
1033 * of a SELECT or NULL otherwise.
1035 * Note: the ctid attribute is a 'junk' attribute that is removed before the
1037 * ----------------------------------------------------------------
1039 static TupleTableSlot *
1040 ExecutePlan(EState *estate,
1041 PlanState *planstate,
1044 ScanDirection direction,
1047 JunkFilter *junkfilter;
1048 TupleTableSlot *slot;
1049 ItemPointer tupleid = NULL;
1050 ItemPointerData tuple_ctid;
1051 long current_tuple_count;
1052 TupleTableSlot *result;
1055 * initialize local variables
1058 current_tuple_count = 0;
1062 * Set the direction.
1064 estate->es_direction = direction;
1067 * Process BEFORE EACH STATEMENT triggers
1072 ExecBSUpdateTriggers(estate, estate->es_result_relation_info);
1075 ExecBSDeleteTriggers(estate, estate->es_result_relation_info);
1078 ExecBSInsertTriggers(estate, estate->es_result_relation_info);
1086 * Loop until we've processed the proper number of tuples from the
1092 /* Reset the per-output-tuple exprcontext */
1093 ResetPerTupleExprContext(estate);
1096 * Execute the plan and obtain a tuple
1099 if (estate->es_useEvalPlan)
1101 slot = EvalPlanQualNext(estate);
1102 if (TupIsNull(slot))
1103 slot = ExecProcNode(planstate);
1106 slot = ExecProcNode(planstate);
1109 * if the tuple is null, then we assume there is nothing more to
1110 * process so we just return null...
1112 if (TupIsNull(slot))
1119 * if we have a junk filter, then project a new tuple with the
1122 * Store this new "clean" tuple in the junkfilter's resultSlot.
1123 * (Formerly, we stored it back over the "dirty" tuple, which is
1124 * WRONG because that tuple slot has the wrong descriptor.)
1126 * Also, extract all the junk information we need.
1128 if ((junkfilter = estate->es_junkFilter) != NULL)
1135 * extract the 'ctid' junk attribute.
1137 if (operation == CMD_UPDATE || operation == CMD_DELETE)
1139 if (!ExecGetJunkAttribute(junkfilter,
1144 elog(ERROR, "could not find junk ctid column");
1146 /* shouldn't ever get a null result... */
1148 elog(ERROR, "ctid is NULL");
1150 tupleid = (ItemPointer) DatumGetPointer(datum);
1151 tuple_ctid = *tupleid; /* make sure we don't free the
1153 tupleid = &tuple_ctid;
1155 else if (estate->es_rowMark != NIL)
1160 foreach(l, estate->es_rowMark)
1162 execRowMark *erm = lfirst(l);
1164 HeapTupleData tuple;
1165 TupleTableSlot *newSlot;
1168 if (!ExecGetJunkAttribute(junkfilter,
1173 elog(ERROR, "could not find junk \"%s\" column",
1176 /* shouldn't ever get a null result... */
1178 elog(ERROR, "\"%s\" is NULL", erm->resname);
1180 tuple.t_self = *((ItemPointer) DatumGetPointer(datum));
1181 test = heap_mark4update(erm->relation, &tuple, &buffer,
1182 estate->es_snapshot->curcid);
1183 ReleaseBuffer(buffer);
1186 case HeapTupleSelfUpdated:
1187 /* treat it as deleted; do not process */
1190 case HeapTupleMayBeUpdated:
1193 case HeapTupleUpdated:
1194 if (IsXactIsoLevelSerializable)
1196 (errcode(ERRCODE_T_R_SERIALIZATION_FAILURE),
1197 errmsg("could not serialize access due to concurrent update")));
1198 if (!(ItemPointerEquals(&(tuple.t_self),
1199 (ItemPointer) DatumGetPointer(datum))))
1201 newSlot = EvalPlanQual(estate, erm->rti, &(tuple.t_self));
1202 if (!(TupIsNull(newSlot)))
1205 estate->es_useEvalPlan = true;
1211 * if tuple was deleted or PlanQual failed for
1212 * updated tuple - we must not return this
1218 elog(ERROR, "unrecognized heap_mark4update status: %u",
1226 * Finally create a new "clean" tuple with all junk attributes
1229 newTuple = ExecRemoveJunk(junkfilter, slot);
1231 slot = ExecStoreTuple(newTuple, /* tuple to store */
1232 junkfilter->jf_resultSlot, /* dest slot */
1233 InvalidBuffer, /* this tuple has no
1235 true); /* tuple should be pfreed */
1239 * now that we have a tuple, do the appropriate thing with it..
1240 * either return it to the user, add it to a relation someplace,
1241 * delete it from a relation, or modify some of its attributes.
1246 ExecSelect(slot, /* slot containing tuple */
1247 dest, /* destination's tuple-receiver obj */
1253 ExecInsert(slot, tupleid, estate);
1258 ExecDelete(slot, tupleid, estate);
1263 ExecUpdate(slot, tupleid, estate);
1268 elog(ERROR, "unrecognized operation code: %d",
1275 * check our tuple count.. if we've processed the proper number
1276 * then quit, else loop again and process more tuples. Zero
1277 * numberTuples means no limit.
1279 current_tuple_count++;
1280 if (numberTuples && numberTuples == current_tuple_count)
1285 * Process AFTER EACH STATEMENT triggers
1290 ExecASUpdateTriggers(estate, estate->es_result_relation_info);
1293 ExecASDeleteTriggers(estate, estate->es_result_relation_info);
1296 ExecASInsertTriggers(estate, estate->es_result_relation_info);
1304 * here, result is either a slot containing a tuple in the case of a
1305 * SELECT or NULL otherwise.
1310 /* ----------------------------------------------------------------
1313 * SELECTs are easy.. we just pass the tuple to the appropriate
1314 * print function. The only complexity is when we do a
1315 * "SELECT INTO", in which case we insert the tuple into
1316 * the appropriate relation (note: this is a newly created relation
1317 * so we don't need to worry about indices or locks.)
1318 * ----------------------------------------------------------------
1321 ExecSelect(TupleTableSlot *slot,
1329 * get the heap tuple out of the tuple table slot
1332 attrtype = slot->ttc_tupleDescriptor;
1335 * insert the tuple into the "into relation"
1337 * XXX this probably ought to be replaced by a separate destination
1339 if (estate->es_into_relation_descriptor != NULL)
1341 heap_insert(estate->es_into_relation_descriptor, tuple,
1342 estate->es_snapshot->curcid);
1347 * send the tuple to the destination
1349 (*dest->receiveTuple) (tuple, attrtype, dest);
1351 (estate->es_processed)++;
1354 /* ----------------------------------------------------------------
1357 * INSERTs are trickier.. we have to insert the tuple into
1358 * the base relation and insert appropriate tuples into the
1360 * ----------------------------------------------------------------
1363 ExecInsert(TupleTableSlot *slot,
1364 ItemPointer tupleid,
1368 ResultRelInfo *resultRelInfo;
1369 Relation resultRelationDesc;
1374 * get the heap tuple out of the tuple table slot
1379 * get information on the (current) result relation
1381 resultRelInfo = estate->es_result_relation_info;
1382 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1384 /* BEFORE ROW INSERT Triggers */
1385 if (resultRelInfo->ri_TrigDesc &&
1386 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_INSERT] > 0)
1390 newtuple = ExecBRInsertTriggers(estate, resultRelInfo, tuple);
1392 if (newtuple == NULL) /* "do nothing" */
1395 if (newtuple != tuple) /* modified by Trigger(s) */
1398 * Insert modified tuple into tuple table slot, replacing the
1399 * original. We assume that it was allocated in per-tuple
1400 * memory context, and therefore will go away by itself. The
1401 * tuple table slot should not try to clear it.
1403 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1409 * Check the constraints of the tuple
1411 if (resultRelationDesc->rd_att->constr)
1412 ExecConstraints(resultRelInfo, slot, estate);
1417 newId = heap_insert(resultRelationDesc, tuple,
1418 estate->es_snapshot->curcid);
1421 (estate->es_processed)++;
1422 estate->es_lastoid = newId;
1423 setLastTid(&(tuple->t_self));
1428 * Note: heap_insert adds a new tuple to a relation. As a side effect,
1429 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1432 numIndices = resultRelInfo->ri_NumIndices;
1434 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1436 /* AFTER ROW INSERT Triggers */
1437 ExecARInsertTriggers(estate, resultRelInfo, tuple);
1440 /* ----------------------------------------------------------------
1443 * DELETE is like UPDATE, we delete the tuple and its
1445 * ----------------------------------------------------------------
1448 ExecDelete(TupleTableSlot *slot,
1449 ItemPointer tupleid,
1452 ResultRelInfo *resultRelInfo;
1453 Relation resultRelationDesc;
1454 ItemPointerData ctid;
1458 * get information on the (current) result relation
1460 resultRelInfo = estate->es_result_relation_info;
1461 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1463 /* BEFORE ROW DELETE Triggers */
1464 if (resultRelInfo->ri_TrigDesc &&
1465 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_DELETE] > 0)
1469 dodelete = ExecBRDeleteTriggers(estate, resultRelInfo, tupleid,
1470 estate->es_snapshot->curcid);
1472 if (!dodelete) /* "do nothing" */
1480 result = heap_delete(resultRelationDesc, tupleid,
1482 estate->es_snapshot->curcid,
1483 estate->es_crosscheck_snapshot,
1484 true /* wait for commit */);
1487 case HeapTupleSelfUpdated:
1488 /* already deleted by self; nothing to do */
1491 case HeapTupleMayBeUpdated:
1494 case HeapTupleUpdated:
1495 if (IsXactIsoLevelSerializable)
1497 (errcode(ERRCODE_T_R_SERIALIZATION_FAILURE),
1498 errmsg("could not serialize access due to concurrent update")));
1499 else if (!(ItemPointerEquals(tupleid, &ctid)))
1501 TupleTableSlot *epqslot = EvalPlanQual(estate,
1502 resultRelInfo->ri_RangeTableIndex, &ctid);
1504 if (!TupIsNull(epqslot))
1510 /* tuple already deleted; nothing to do */
1514 elog(ERROR, "unrecognized heap_delete status: %u", result);
1519 (estate->es_processed)++;
1522 * Note: Normally one would think that we have to delete index tuples
1523 * associated with the heap tuple now..
1525 * ... but in POSTGRES, we have no need to do this because the vacuum
1526 * daemon automatically opens an index scan and deletes index tuples
1527 * when it finds deleted heap tuples. -cim 9/27/89
1530 /* AFTER ROW DELETE Triggers */
1531 ExecARDeleteTriggers(estate, resultRelInfo, tupleid);
1534 /* ----------------------------------------------------------------
1537 * note: we can't run UPDATE queries with transactions
1538 * off because UPDATEs are actually INSERTs and our
1539 * scan will mistakenly loop forever, updating the tuple
1540 * it just inserted.. This should be fixed but until it
1541 * is, we don't want to get stuck in an infinite loop
1542 * which corrupts your database..
1543 * ----------------------------------------------------------------
1546 ExecUpdate(TupleTableSlot *slot,
1547 ItemPointer tupleid,
1551 ResultRelInfo *resultRelInfo;
1552 Relation resultRelationDesc;
1553 ItemPointerData ctid;
1558 * abort the operation if not running transactions
1560 if (IsBootstrapProcessingMode())
1561 elog(ERROR, "cannot UPDATE during bootstrap");
1564 * get the heap tuple out of the tuple table slot
1569 * get information on the (current) result relation
1571 resultRelInfo = estate->es_result_relation_info;
1572 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1574 /* BEFORE ROW UPDATE Triggers */
1575 if (resultRelInfo->ri_TrigDesc &&
1576 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_UPDATE] > 0)
1580 newtuple = ExecBRUpdateTriggers(estate, resultRelInfo,
1582 estate->es_snapshot->curcid);
1584 if (newtuple == NULL) /* "do nothing" */
1587 if (newtuple != tuple) /* modified by Trigger(s) */
1590 * Insert modified tuple into tuple table slot, replacing the
1591 * original. We assume that it was allocated in per-tuple
1592 * memory context, and therefore will go away by itself. The
1593 * tuple table slot should not try to clear it.
1595 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1601 * Check the constraints of the tuple
1603 * If we generate a new candidate tuple after EvalPlanQual testing, we
1604 * must loop back here and recheck constraints. (We don't need to
1605 * redo triggers, however. If there are any BEFORE triggers then
1606 * trigger.c will have done mark4update to lock the correct tuple, so
1607 * there's no need to do them again.)
1610 if (resultRelationDesc->rd_att->constr)
1611 ExecConstraints(resultRelInfo, slot, estate);
1614 * replace the heap tuple
1616 result = heap_update(resultRelationDesc, tupleid, tuple,
1618 estate->es_snapshot->curcid,
1619 estate->es_crosscheck_snapshot,
1620 true /* wait for commit */);
1623 case HeapTupleSelfUpdated:
1624 /* already deleted by self; nothing to do */
1627 case HeapTupleMayBeUpdated:
1630 case HeapTupleUpdated:
1631 if (IsXactIsoLevelSerializable)
1633 (errcode(ERRCODE_T_R_SERIALIZATION_FAILURE),
1634 errmsg("could not serialize access due to concurrent update")));
1635 else if (!(ItemPointerEquals(tupleid, &ctid)))
1637 TupleTableSlot *epqslot = EvalPlanQual(estate,
1638 resultRelInfo->ri_RangeTableIndex, &ctid);
1640 if (!TupIsNull(epqslot))
1643 tuple = ExecRemoveJunk(estate->es_junkFilter, epqslot);
1644 slot = ExecStoreTuple(tuple,
1645 estate->es_junkFilter->jf_resultSlot,
1646 InvalidBuffer, true);
1650 /* tuple already deleted; nothing to do */
1654 elog(ERROR, "unrecognized heap_update status: %u", result);
1659 (estate->es_processed)++;
1662 * Note: instead of having to update the old index tuples associated
1663 * with the heap tuple, all we do is form and insert new index tuples.
1664 * This is because UPDATEs are actually DELETEs and INSERTs and index
1665 * tuple deletion is done automagically by the vacuum daemon. All we
1666 * do is insert new index tuples. -cim 9/27/89
1672 * heap_update updates a tuple in the base relation by invalidating it
1673 * and then inserting a new tuple to the relation. As a side effect,
1674 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1675 * field. So we now insert index tuples using the new tupleid stored
1679 numIndices = resultRelInfo->ri_NumIndices;
1681 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1683 /* AFTER ROW UPDATE Triggers */
1684 ExecARUpdateTriggers(estate, resultRelInfo, tupleid, tuple);
1688 ExecRelCheck(ResultRelInfo *resultRelInfo,
1689 TupleTableSlot *slot, EState *estate)
1691 Relation rel = resultRelInfo->ri_RelationDesc;
1692 int ncheck = rel->rd_att->constr->num_check;
1693 ConstrCheck *check = rel->rd_att->constr->check;
1694 ExprContext *econtext;
1695 MemoryContext oldContext;
1700 * If first time through for this result relation, build expression
1701 * nodetrees for rel's constraint expressions. Keep them in the
1702 * per-query memory context so they'll survive throughout the query.
1704 if (resultRelInfo->ri_ConstraintExprs == NULL)
1706 oldContext = MemoryContextSwitchTo(estate->es_query_cxt);
1707 resultRelInfo->ri_ConstraintExprs =
1708 (List **) palloc(ncheck * sizeof(List *));
1709 for (i = 0; i < ncheck; i++)
1711 /* ExecQual wants implicit-AND form */
1712 qual = make_ands_implicit(stringToNode(check[i].ccbin));
1713 resultRelInfo->ri_ConstraintExprs[i] = (List *)
1714 ExecPrepareExpr((Expr *) qual, estate);
1716 MemoryContextSwitchTo(oldContext);
1720 * We will use the EState's per-tuple context for evaluating
1721 * constraint expressions (creating it if it's not already there).
1723 econtext = GetPerTupleExprContext(estate);
1725 /* Arrange for econtext's scan tuple to be the tuple under test */
1726 econtext->ecxt_scantuple = slot;
1728 /* And evaluate the constraints */
1729 for (i = 0; i < ncheck; i++)
1731 qual = resultRelInfo->ri_ConstraintExprs[i];
1734 * NOTE: SQL92 specifies that a NULL result from a constraint
1735 * expression is not to be treated as a failure. Therefore, tell
1736 * ExecQual to return TRUE for NULL.
1738 if (!ExecQual(qual, econtext, true))
1739 return check[i].ccname;
1742 /* NULL result means no error */
1747 ExecConstraints(ResultRelInfo *resultRelInfo,
1748 TupleTableSlot *slot, EState *estate)
1750 Relation rel = resultRelInfo->ri_RelationDesc;
1751 HeapTuple tuple = slot->val;
1752 TupleConstr *constr = rel->rd_att->constr;
1756 if (constr->has_not_null)
1758 int natts = rel->rd_att->natts;
1761 for (attrChk = 1; attrChk <= natts; attrChk++)
1763 if (rel->rd_att->attrs[attrChk - 1]->attnotnull &&
1764 heap_attisnull(tuple, attrChk))
1766 (errcode(ERRCODE_NOT_NULL_VIOLATION),
1767 errmsg("null value in column \"%s\" violates not-null constraint",
1768 NameStr(rel->rd_att->attrs[attrChk - 1]->attname))));
1772 if (constr->num_check > 0)
1776 if ((failed = ExecRelCheck(resultRelInfo, slot, estate)) != NULL)
1778 (errcode(ERRCODE_CHECK_VIOLATION),
1779 errmsg("new row for relation \"%s\" violates check constraint \"%s\"",
1780 RelationGetRelationName(rel), failed)));
1785 * Check a modified tuple to see if we want to process its updated version
1786 * under READ COMMITTED rules.
1788 * See backend/executor/README for some info about how this works.
1791 EvalPlanQual(EState *estate, Index rti, ItemPointer tid)
1796 HeapTupleData tuple;
1797 HeapTuple copyTuple = NULL;
1803 * find relation containing target tuple
1805 if (estate->es_result_relation_info != NULL &&
1806 estate->es_result_relation_info->ri_RangeTableIndex == rti)
1807 relation = estate->es_result_relation_info->ri_RelationDesc;
1813 foreach(l, estate->es_rowMark)
1815 if (((execRowMark *) lfirst(l))->rti == rti)
1817 relation = ((execRowMark *) lfirst(l))->relation;
1821 if (relation == NULL)
1822 elog(ERROR, "could not find RowMark for RT index %u", rti);
1828 * Loop here to deal with updated or busy tuples
1830 tuple.t_self = *tid;
1835 if (heap_fetch(relation, SnapshotDirty, &tuple, &buffer, false, NULL))
1837 TransactionId xwait = SnapshotDirty->xmax;
1839 /* xmin should not be dirty... */
1840 if (TransactionIdIsValid(SnapshotDirty->xmin))
1841 elog(ERROR, "t_xmin is uncommitted in tuple to be updated");
1844 * If tuple is being updated by other transaction then we have
1845 * to wait for its commit/abort.
1847 if (TransactionIdIsValid(xwait))
1849 ReleaseBuffer(buffer);
1850 XactLockTableWait(xwait);
1855 * We got tuple - now copy it for use by recheck query.
1857 copyTuple = heap_copytuple(&tuple);
1858 ReleaseBuffer(buffer);
1863 * Oops! Invalid tuple. Have to check is it updated or deleted.
1864 * Note that it's possible to get invalid SnapshotDirty->tid if
1865 * tuple updated by this transaction. Have we to check this ?
1867 if (ItemPointerIsValid(&(SnapshotDirty->tid)) &&
1868 !(ItemPointerEquals(&(tuple.t_self), &(SnapshotDirty->tid))))
1870 /* updated, so look at the updated copy */
1871 tuple.t_self = SnapshotDirty->tid;
1876 * Deleted or updated by this transaction; forget it.
1882 * For UPDATE/DELETE we have to return tid of actual row we're
1885 *tid = tuple.t_self;
1888 * Need to run a recheck subquery. Find or create a PQ stack entry.
1890 epq = estate->es_evalPlanQual;
1893 if (epq != NULL && epq->rti == 0)
1895 /* Top PQ stack entry is idle, so re-use it */
1896 Assert(!(estate->es_useEvalPlan) && epq->next == NULL);
1902 * If this is request for another RTE - Ra, - then we have to check
1903 * wasn't PlanQual requested for Ra already and if so then Ra' row was
1904 * updated again and we have to re-start old execution for Ra and
1905 * forget all what we done after Ra was suspended. Cool? -:))
1907 if (epq != NULL && epq->rti != rti &&
1908 epq->estate->es_evTuple[rti - 1] != NULL)
1912 evalPlanQual *oldepq;
1914 /* stop execution */
1915 EvalPlanQualStop(epq);
1916 /* pop previous PlanQual from the stack */
1918 Assert(oldepq && oldepq->rti != 0);
1919 /* push current PQ to freePQ stack */
1922 estate->es_evalPlanQual = epq;
1923 } while (epq->rti != rti);
1927 * If we are requested for another RTE then we have to suspend
1928 * execution of current PlanQual and start execution for new one.
1930 if (epq == NULL || epq->rti != rti)
1932 /* try to reuse plan used previously */
1933 evalPlanQual *newepq = (epq != NULL) ? epq->free : NULL;
1935 if (newepq == NULL) /* first call or freePQ stack is empty */
1937 newepq = (evalPlanQual *) palloc0(sizeof(evalPlanQual));
1938 newepq->free = NULL;
1939 newepq->estate = NULL;
1940 newepq->planstate = NULL;
1944 /* recycle previously used PlanQual */
1945 Assert(newepq->estate == NULL);
1948 /* push current PQ to the stack */
1951 estate->es_evalPlanQual = epq;
1956 Assert(epq->rti == rti);
1959 * Ok - we're requested for the same RTE. Unfortunately we still have
1960 * to end and restart execution of the plan, because ExecReScan
1961 * wouldn't ensure that upper plan nodes would reset themselves. We
1962 * could make that work if insertion of the target tuple were
1963 * integrated with the Param mechanism somehow, so that the upper plan
1964 * nodes know that their children's outputs have changed.
1966 * Note that the stack of free evalPlanQual nodes is quite useless at the
1967 * moment, since it only saves us from pallocing/releasing the
1968 * evalPlanQual nodes themselves. But it will be useful once we
1969 * implement ReScan instead of end/restart for re-using PlanQual
1974 /* stop execution */
1975 EvalPlanQualStop(epq);
1979 * Initialize new recheck query.
1981 * Note: if we were re-using PlanQual plans via ExecReScan, we'd need to
1982 * instead copy down changeable state from the top plan (including
1983 * es_result_relation_info, es_junkFilter) and reset locally
1984 * changeable state in the epq (including es_param_exec_vals,
1987 EvalPlanQualStart(epq, estate, epq->next);
1990 * free old RTE' tuple, if any, and store target tuple where
1991 * relation's scan node will see it
1993 epqstate = epq->estate;
1994 if (epqstate->es_evTuple[rti - 1] != NULL)
1995 heap_freetuple(epqstate->es_evTuple[rti - 1]);
1996 epqstate->es_evTuple[rti - 1] = copyTuple;
1998 return EvalPlanQualNext(estate);
2001 static TupleTableSlot *
2002 EvalPlanQualNext(EState *estate)
2004 evalPlanQual *epq = estate->es_evalPlanQual;
2005 MemoryContext oldcontext;
2006 TupleTableSlot *slot;
2008 Assert(epq->rti != 0);
2011 oldcontext = MemoryContextSwitchTo(epq->estate->es_query_cxt);
2012 slot = ExecProcNode(epq->planstate);
2013 MemoryContextSwitchTo(oldcontext);
2016 * No more tuples for this PQ. Continue previous one.
2018 if (TupIsNull(slot))
2020 evalPlanQual *oldepq;
2022 /* stop execution */
2023 EvalPlanQualStop(epq);
2024 /* pop old PQ from the stack */
2028 /* this is the first (oldest) PQ - mark as free */
2030 estate->es_useEvalPlan = false;
2031 /* and continue Query execution */
2034 Assert(oldepq->rti != 0);
2035 /* push current PQ to freePQ stack */
2038 estate->es_evalPlanQual = epq;
2046 EndEvalPlanQual(EState *estate)
2048 evalPlanQual *epq = estate->es_evalPlanQual;
2050 if (epq->rti == 0) /* plans already shutdowned */
2052 Assert(epq->next == NULL);
2058 evalPlanQual *oldepq;
2060 /* stop execution */
2061 EvalPlanQualStop(epq);
2062 /* pop old PQ from the stack */
2066 /* this is the first (oldest) PQ - mark as free */
2068 estate->es_useEvalPlan = false;
2071 Assert(oldepq->rti != 0);
2072 /* push current PQ to freePQ stack */
2075 estate->es_evalPlanQual = epq;
2080 * Start execution of one level of PlanQual.
2082 * This is a cut-down version of ExecutorStart(): we copy some state from
2083 * the top-level estate rather than initializing it fresh.
2086 EvalPlanQualStart(evalPlanQual *epq, EState *estate, evalPlanQual *priorepq)
2090 MemoryContext oldcontext;
2092 rtsize = length(estate->es_range_table);
2094 epq->estate = epqstate = CreateExecutorState();
2096 oldcontext = MemoryContextSwitchTo(epqstate->es_query_cxt);
2099 * The epqstates share the top query's copy of unchanging state such
2100 * as the snapshot, rangetable, result-rel info, and external Param
2101 * info. They need their own copies of local state, including a tuple
2102 * table, es_param_exec_vals, etc.
2104 epqstate->es_direction = ForwardScanDirection;
2105 epqstate->es_snapshot = estate->es_snapshot;
2106 epqstate->es_crosscheck_snapshot = estate->es_crosscheck_snapshot;
2107 epqstate->es_range_table = estate->es_range_table;
2108 epqstate->es_result_relations = estate->es_result_relations;
2109 epqstate->es_num_result_relations = estate->es_num_result_relations;
2110 epqstate->es_result_relation_info = estate->es_result_relation_info;
2111 epqstate->es_junkFilter = estate->es_junkFilter;
2112 epqstate->es_into_relation_descriptor = estate->es_into_relation_descriptor;
2113 epqstate->es_param_list_info = estate->es_param_list_info;
2114 if (estate->es_topPlan->nParamExec > 0)
2115 epqstate->es_param_exec_vals = (ParamExecData *)
2116 palloc0(estate->es_topPlan->nParamExec * sizeof(ParamExecData));
2117 epqstate->es_rowMark = estate->es_rowMark;
2118 epqstate->es_instrument = estate->es_instrument;
2119 epqstate->es_select_into = estate->es_select_into;
2120 epqstate->es_into_oids = estate->es_into_oids;
2121 epqstate->es_topPlan = estate->es_topPlan;
2124 * Each epqstate must have its own es_evTupleNull state, but all the
2125 * stack entries share es_evTuple state. This allows sub-rechecks to
2126 * inherit the value being examined by an outer recheck.
2128 epqstate->es_evTupleNull = (bool *) palloc0(rtsize * sizeof(bool));
2129 if (priorepq == NULL)
2130 /* first PQ stack entry */
2131 epqstate->es_evTuple = (HeapTuple *)
2132 palloc0(rtsize * sizeof(HeapTuple));
2134 /* later stack entries share the same storage */
2135 epqstate->es_evTuple = priorepq->estate->es_evTuple;
2137 epqstate->es_tupleTable =
2138 ExecCreateTupleTable(estate->es_tupleTable->size);
2140 epq->planstate = ExecInitNode(estate->es_topPlan, epqstate);
2142 MemoryContextSwitchTo(oldcontext);
2146 * End execution of one level of PlanQual.
2148 * This is a cut-down version of ExecutorEnd(); basically we want to do most
2149 * of the normal cleanup, but *not* close result relations (which we are
2150 * just sharing from the outer query).
2153 EvalPlanQualStop(evalPlanQual *epq)
2155 EState *epqstate = epq->estate;
2156 MemoryContext oldcontext;
2158 oldcontext = MemoryContextSwitchTo(epqstate->es_query_cxt);
2160 ExecEndNode(epq->planstate);
2162 ExecDropTupleTable(epqstate->es_tupleTable, true);
2163 epqstate->es_tupleTable = NULL;
2165 if (epqstate->es_evTuple[epq->rti - 1] != NULL)
2167 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
2168 epqstate->es_evTuple[epq->rti - 1] = NULL;
2171 MemoryContextSwitchTo(oldcontext);
2173 FreeExecutorState(epqstate);
2176 epq->planstate = NULL;