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.230 2004/03/23 19:35:16 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 plan may return raw disk tuples
663 * (else heap_insert will be scribbling on the source relation!).
664 * UPDATE and DELETE always need a filter, since there's always a junk
665 * '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) &&
687 ExecMayReturnRawTuples(planstate))
688 junk_filter_needed = true;
692 junk_filter_needed = true;
698 if (junk_filter_needed)
701 * If there are multiple result relations, each one needs its
702 * own junk filter. Note this is only possible for
703 * UPDATE/DELETE, so we can't be fooled by some needing a
704 * filter and some not.
706 if (parseTree->resultRelations != NIL)
708 PlanState **appendplans;
710 ResultRelInfo *resultRelInfo;
713 /* Top plan had better be an Append here. */
714 Assert(IsA(plan, Append));
715 Assert(((Append *) plan)->isTarget);
716 Assert(IsA(planstate, AppendState));
717 appendplans = ((AppendState *) planstate)->appendplans;
718 as_nplans = ((AppendState *) planstate)->as_nplans;
719 Assert(as_nplans == estate->es_num_result_relations);
720 resultRelInfo = estate->es_result_relations;
721 for (i = 0; i < as_nplans; i++)
723 PlanState *subplan = appendplans[i];
726 j = ExecInitJunkFilter(subplan->plan->targetlist,
727 ExecGetResultType(subplan),
728 ExecAllocTableSlot(estate->es_tupleTable));
729 resultRelInfo->ri_junkFilter = j;
734 * Set active junkfilter too; at this point ExecInitAppend
735 * has already selected an active result relation...
737 estate->es_junkFilter =
738 estate->es_result_relation_info->ri_junkFilter;
742 /* Normal case with just one JunkFilter */
745 j = ExecInitJunkFilter(planstate->plan->targetlist,
747 ExecAllocTableSlot(estate->es_tupleTable));
748 estate->es_junkFilter = j;
749 if (estate->es_result_relation_info)
750 estate->es_result_relation_info->ri_junkFilter = j;
752 /* For SELECT, want to return the cleaned tuple type */
753 if (operation == CMD_SELECT)
754 tupType = j->jf_cleanTupType;
758 estate->es_junkFilter = NULL;
762 * If doing SELECT INTO, initialize the "into" relation. We must wait
763 * till now so we have the "clean" result tuple type to create the new
766 * If EXPLAIN, skip creating the "into" relation.
768 intoRelationDesc = NULL;
770 if (do_select_into && !explainOnly)
779 * find namespace to create in, check permissions
781 intoName = parseTree->into->relname;
782 namespaceId = RangeVarGetCreationNamespace(parseTree->into);
784 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
786 if (aclresult != ACLCHECK_OK)
787 aclcheck_error(aclresult, ACL_KIND_NAMESPACE,
788 get_namespace_name(namespaceId));
791 * have to copy tupType to get rid of constraints
793 tupdesc = CreateTupleDescCopy(tupType);
795 intoRelationId = heap_create_with_catalog(intoName,
803 allowSystemTableMods);
805 FreeTupleDesc(tupdesc);
808 * Advance command counter so that the newly-created relation's
809 * catalog tuples will be visible to heap_open.
811 CommandCounterIncrement();
814 * If necessary, create a TOAST table for the into relation. Note
815 * that AlterTableCreateToastTable ends with
816 * CommandCounterIncrement(), so that the TOAST table will be
817 * visible for insertion.
819 AlterTableCreateToastTable(intoRelationId, true);
822 * And open the constructed table for writing.
824 intoRelationDesc = heap_open(intoRelationId, AccessExclusiveLock);
827 estate->es_into_relation_descriptor = intoRelationDesc;
829 queryDesc->tupDesc = tupType;
830 queryDesc->planstate = planstate;
834 * Initialize ResultRelInfo data for one result relation
837 initResultRelInfo(ResultRelInfo *resultRelInfo,
838 Index resultRelationIndex,
842 Oid resultRelationOid;
843 Relation resultRelationDesc;
845 resultRelationOid = getrelid(resultRelationIndex, rangeTable);
846 resultRelationDesc = heap_open(resultRelationOid, RowExclusiveLock);
848 switch (resultRelationDesc->rd_rel->relkind)
850 case RELKIND_SEQUENCE:
852 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
853 errmsg("cannot change sequence \"%s\"",
854 RelationGetRelationName(resultRelationDesc))));
856 case RELKIND_TOASTVALUE:
858 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
859 errmsg("cannot change TOAST relation \"%s\"",
860 RelationGetRelationName(resultRelationDesc))));
864 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
865 errmsg("cannot change view \"%s\"",
866 RelationGetRelationName(resultRelationDesc))));
870 MemSet(resultRelInfo, 0, sizeof(ResultRelInfo));
871 resultRelInfo->type = T_ResultRelInfo;
872 resultRelInfo->ri_RangeTableIndex = resultRelationIndex;
873 resultRelInfo->ri_RelationDesc = resultRelationDesc;
874 resultRelInfo->ri_NumIndices = 0;
875 resultRelInfo->ri_IndexRelationDescs = NULL;
876 resultRelInfo->ri_IndexRelationInfo = NULL;
877 /* make a copy so as not to depend on relcache info not changing... */
878 resultRelInfo->ri_TrigDesc = CopyTriggerDesc(resultRelationDesc->trigdesc);
879 resultRelInfo->ri_TrigFunctions = NULL;
880 resultRelInfo->ri_ConstraintExprs = NULL;
881 resultRelInfo->ri_junkFilter = NULL;
884 * If there are indices on the result relation, open them and save
885 * descriptors in the result relation info, so that we can add new
886 * index entries for the tuples we add/update. We need not do this
887 * for a DELETE, however, since deletion doesn't affect indexes.
889 if (resultRelationDesc->rd_rel->relhasindex &&
890 operation != CMD_DELETE)
891 ExecOpenIndices(resultRelInfo);
895 * ExecContextForcesOids
897 * This is pretty grotty: when doing INSERT, UPDATE, or SELECT INTO,
898 * we need to ensure that result tuples have space for an OID iff they are
899 * going to be stored into a relation that has OIDs. In other contexts
900 * we are free to choose whether to leave space for OIDs in result tuples
901 * (we generally don't want to, but we do if a physical-tlist optimization
902 * is possible). This routine checks the plan context and returns TRUE if the
903 * choice is forced, FALSE if the choice is not forced. In the TRUE case,
904 * *hasoids is set to the required value.
906 * One reason this is ugly is that all plan nodes in the plan tree will emit
907 * tuples with space for an OID, though we really only need the topmost node
908 * to do so. However, node types like Sort don't project new tuples but just
909 * return their inputs, and in those cases the requirement propagates down
910 * to the input node. Eventually we might make this code smart enough to
911 * recognize how far down the requirement really goes, but for now we just
912 * make all plan nodes do the same thing if the top level forces the choice.
914 * We assume that estate->es_result_relation_info is already set up to
915 * describe the target relation. Note that in an UPDATE that spans an
916 * inheritance tree, some of the target relations may have OIDs and some not.
917 * We have to make the decisions on a per-relation basis as we initialize
918 * each of the child plans of the topmost Append plan.
920 * SELECT INTO is even uglier, because we don't have the INTO relation's
921 * descriptor available when this code runs; we have to look aside at a
922 * flag set by InitPlan().
925 ExecContextForcesOids(PlanState *planstate, bool *hasoids)
927 if (planstate->state->es_select_into)
929 *hasoids = planstate->state->es_into_oids;
934 ResultRelInfo *ri = planstate->state->es_result_relation_info;
938 Relation rel = ri->ri_RelationDesc;
942 *hasoids = rel->rd_rel->relhasoids;
951 /* ----------------------------------------------------------------
954 * Cleans up the query plan -- closes files and frees up storage
956 * NOTE: we are no longer very worried about freeing storage per se
957 * in this code; FreeExecutorState should be guaranteed to release all
958 * memory that needs to be released. What we are worried about doing
959 * is closing relations and dropping buffer pins. Thus, for example,
960 * tuple tables must be cleared or dropped to ensure pins are released.
961 * ----------------------------------------------------------------
964 ExecEndPlan(PlanState *planstate, EState *estate)
966 ResultRelInfo *resultRelInfo;
971 * shut down any PlanQual processing we were doing
973 if (estate->es_evalPlanQual != NULL)
974 EndEvalPlanQual(estate);
977 * shut down the node-type-specific query processing
979 ExecEndNode(planstate);
982 * destroy the executor "tuple" table.
984 ExecDropTupleTable(estate->es_tupleTable, true);
985 estate->es_tupleTable = NULL;
988 * close the result relation(s) if any, but hold locks until xact
991 resultRelInfo = estate->es_result_relations;
992 for (i = estate->es_num_result_relations; i > 0; i--)
994 /* Close indices and then the relation itself */
995 ExecCloseIndices(resultRelInfo);
996 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
1001 * close the "into" relation if necessary, again keeping lock
1003 if (estate->es_into_relation_descriptor != NULL)
1004 heap_close(estate->es_into_relation_descriptor, NoLock);
1007 * close any relations selected FOR UPDATE, again keeping locks
1009 foreach(l, estate->es_rowMark)
1011 execRowMark *erm = lfirst(l);
1013 heap_close(erm->relation, NoLock);
1017 /* ----------------------------------------------------------------
1020 * processes the query plan to retrieve 'numberTuples' tuples in the
1021 * direction specified.
1023 * Retrieves all tuples if numberTuples is 0
1025 * result is either a slot containing the last tuple in the case
1026 * of a SELECT or NULL otherwise.
1028 * Note: the ctid attribute is a 'junk' attribute that is removed before the
1030 * ----------------------------------------------------------------
1032 static TupleTableSlot *
1033 ExecutePlan(EState *estate,
1034 PlanState *planstate,
1037 ScanDirection direction,
1040 JunkFilter *junkfilter;
1041 TupleTableSlot *slot;
1042 ItemPointer tupleid = NULL;
1043 ItemPointerData tuple_ctid;
1044 long current_tuple_count;
1045 TupleTableSlot *result;
1048 * initialize local variables
1051 current_tuple_count = 0;
1055 * Set the direction.
1057 estate->es_direction = direction;
1060 * Process BEFORE EACH STATEMENT triggers
1065 ExecBSUpdateTriggers(estate, estate->es_result_relation_info);
1068 ExecBSDeleteTriggers(estate, estate->es_result_relation_info);
1071 ExecBSInsertTriggers(estate, estate->es_result_relation_info);
1079 * Loop until we've processed the proper number of tuples from the
1085 /* Reset the per-output-tuple exprcontext */
1086 ResetPerTupleExprContext(estate);
1089 * Execute the plan and obtain a tuple
1092 if (estate->es_useEvalPlan)
1094 slot = EvalPlanQualNext(estate);
1095 if (TupIsNull(slot))
1096 slot = ExecProcNode(planstate);
1099 slot = ExecProcNode(planstate);
1102 * if the tuple is null, then we assume there is nothing more to
1103 * process so we just return null...
1105 if (TupIsNull(slot))
1112 * if we have a junk filter, then project a new tuple with the
1115 * Store this new "clean" tuple in the junkfilter's resultSlot.
1116 * (Formerly, we stored it back over the "dirty" tuple, which is
1117 * WRONG because that tuple slot has the wrong descriptor.)
1119 * Also, extract all the junk information we need.
1121 if ((junkfilter = estate->es_junkFilter) != NULL)
1128 * extract the 'ctid' junk attribute.
1130 if (operation == CMD_UPDATE || operation == CMD_DELETE)
1132 if (!ExecGetJunkAttribute(junkfilter,
1137 elog(ERROR, "could not find junk ctid column");
1139 /* shouldn't ever get a null result... */
1141 elog(ERROR, "ctid is NULL");
1143 tupleid = (ItemPointer) DatumGetPointer(datum);
1144 tuple_ctid = *tupleid; /* make sure we don't free the
1146 tupleid = &tuple_ctid;
1148 else if (estate->es_rowMark != NIL)
1153 foreach(l, estate->es_rowMark)
1155 execRowMark *erm = lfirst(l);
1157 HeapTupleData tuple;
1158 TupleTableSlot *newSlot;
1161 if (!ExecGetJunkAttribute(junkfilter,
1166 elog(ERROR, "could not find junk \"%s\" column",
1169 /* shouldn't ever get a null result... */
1171 elog(ERROR, "\"%s\" is NULL", erm->resname);
1173 tuple.t_self = *((ItemPointer) DatumGetPointer(datum));
1174 test = heap_mark4update(erm->relation, &tuple, &buffer,
1175 estate->es_snapshot->curcid);
1176 ReleaseBuffer(buffer);
1179 case HeapTupleSelfUpdated:
1180 /* treat it as deleted; do not process */
1183 case HeapTupleMayBeUpdated:
1186 case HeapTupleUpdated:
1187 if (IsXactIsoLevelSerializable)
1189 (errcode(ERRCODE_T_R_SERIALIZATION_FAILURE),
1190 errmsg("could not serialize access due to concurrent update")));
1191 if (!(ItemPointerEquals(&(tuple.t_self),
1192 (ItemPointer) DatumGetPointer(datum))))
1194 newSlot = EvalPlanQual(estate, erm->rti, &(tuple.t_self));
1195 if (!(TupIsNull(newSlot)))
1198 estate->es_useEvalPlan = true;
1204 * if tuple was deleted or PlanQual failed for
1205 * updated tuple - we must not return this
1211 elog(ERROR, "unrecognized heap_mark4update status: %u",
1219 * Finally create a new "clean" tuple with all junk attributes
1222 newTuple = ExecRemoveJunk(junkfilter, slot);
1224 slot = ExecStoreTuple(newTuple, /* tuple to store */
1225 junkfilter->jf_resultSlot, /* dest slot */
1226 InvalidBuffer, /* this tuple has no
1228 true); /* tuple should be pfreed */
1232 * now that we have a tuple, do the appropriate thing with it..
1233 * either return it to the user, add it to a relation someplace,
1234 * delete it from a relation, or modify some of its attributes.
1239 ExecSelect(slot, /* slot containing tuple */
1240 dest, /* destination's tuple-receiver obj */
1246 ExecInsert(slot, tupleid, estate);
1251 ExecDelete(slot, tupleid, estate);
1256 ExecUpdate(slot, tupleid, estate);
1261 elog(ERROR, "unrecognized operation code: %d",
1268 * check our tuple count.. if we've processed the proper number
1269 * then quit, else loop again and process more tuples. Zero
1270 * numberTuples means no limit.
1272 current_tuple_count++;
1273 if (numberTuples && numberTuples == current_tuple_count)
1278 * Process AFTER EACH STATEMENT triggers
1283 ExecASUpdateTriggers(estate, estate->es_result_relation_info);
1286 ExecASDeleteTriggers(estate, estate->es_result_relation_info);
1289 ExecASInsertTriggers(estate, estate->es_result_relation_info);
1297 * here, result is either a slot containing a tuple in the case of a
1298 * SELECT or NULL otherwise.
1303 /* ----------------------------------------------------------------
1306 * SELECTs are easy.. we just pass the tuple to the appropriate
1307 * print function. The only complexity is when we do a
1308 * "SELECT INTO", in which case we insert the tuple into
1309 * the appropriate relation (note: this is a newly created relation
1310 * so we don't need to worry about indices or locks.)
1311 * ----------------------------------------------------------------
1314 ExecSelect(TupleTableSlot *slot,
1322 * get the heap tuple out of the tuple table slot
1325 attrtype = slot->ttc_tupleDescriptor;
1328 * insert the tuple into the "into relation"
1330 * XXX this probably ought to be replaced by a separate destination
1332 if (estate->es_into_relation_descriptor != NULL)
1334 heap_insert(estate->es_into_relation_descriptor, tuple,
1335 estate->es_snapshot->curcid);
1340 * send the tuple to the destination
1342 (*dest->receiveTuple) (tuple, attrtype, dest);
1344 (estate->es_processed)++;
1347 /* ----------------------------------------------------------------
1350 * INSERTs are trickier.. we have to insert the tuple into
1351 * the base relation and insert appropriate tuples into the
1353 * ----------------------------------------------------------------
1356 ExecInsert(TupleTableSlot *slot,
1357 ItemPointer tupleid,
1361 ResultRelInfo *resultRelInfo;
1362 Relation resultRelationDesc;
1367 * get the heap tuple out of the tuple table slot
1372 * get information on the (current) result relation
1374 resultRelInfo = estate->es_result_relation_info;
1375 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1377 /* BEFORE ROW INSERT Triggers */
1378 if (resultRelInfo->ri_TrigDesc &&
1379 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_INSERT] > 0)
1383 newtuple = ExecBRInsertTriggers(estate, resultRelInfo, tuple);
1385 if (newtuple == NULL) /* "do nothing" */
1388 if (newtuple != tuple) /* modified by Trigger(s) */
1391 * Insert modified tuple into tuple table slot, replacing the
1392 * original. We assume that it was allocated in per-tuple
1393 * memory context, and therefore will go away by itself. The
1394 * tuple table slot should not try to clear it.
1396 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1402 * Check the constraints of the tuple
1404 if (resultRelationDesc->rd_att->constr)
1405 ExecConstraints(resultRelInfo, slot, estate);
1410 newId = heap_insert(resultRelationDesc, tuple,
1411 estate->es_snapshot->curcid);
1414 (estate->es_processed)++;
1415 estate->es_lastoid = newId;
1416 setLastTid(&(tuple->t_self));
1421 * Note: heap_insert adds a new tuple to a relation. As a side effect,
1422 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1425 numIndices = resultRelInfo->ri_NumIndices;
1427 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1429 /* AFTER ROW INSERT Triggers */
1430 ExecARInsertTriggers(estate, resultRelInfo, tuple);
1433 /* ----------------------------------------------------------------
1436 * DELETE is like UPDATE, we delete the tuple and its
1438 * ----------------------------------------------------------------
1441 ExecDelete(TupleTableSlot *slot,
1442 ItemPointer tupleid,
1445 ResultRelInfo *resultRelInfo;
1446 Relation resultRelationDesc;
1447 ItemPointerData ctid;
1451 * get information on the (current) result relation
1453 resultRelInfo = estate->es_result_relation_info;
1454 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1456 /* BEFORE ROW DELETE Triggers */
1457 if (resultRelInfo->ri_TrigDesc &&
1458 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_DELETE] > 0)
1462 dodelete = ExecBRDeleteTriggers(estate, resultRelInfo, tupleid,
1463 estate->es_snapshot->curcid);
1465 if (!dodelete) /* "do nothing" */
1473 result = heap_delete(resultRelationDesc, tupleid,
1475 estate->es_snapshot->curcid,
1476 estate->es_crosscheck_snapshot,
1477 true /* wait for commit */);
1480 case HeapTupleSelfUpdated:
1481 /* already deleted by self; nothing to do */
1484 case HeapTupleMayBeUpdated:
1487 case HeapTupleUpdated:
1488 if (IsXactIsoLevelSerializable)
1490 (errcode(ERRCODE_T_R_SERIALIZATION_FAILURE),
1491 errmsg("could not serialize access due to concurrent update")));
1492 else if (!(ItemPointerEquals(tupleid, &ctid)))
1494 TupleTableSlot *epqslot = EvalPlanQual(estate,
1495 resultRelInfo->ri_RangeTableIndex, &ctid);
1497 if (!TupIsNull(epqslot))
1503 /* tuple already deleted; nothing to do */
1507 elog(ERROR, "unrecognized heap_delete status: %u", result);
1512 (estate->es_processed)++;
1515 * Note: Normally one would think that we have to delete index tuples
1516 * associated with the heap tuple now..
1518 * ... but in POSTGRES, we have no need to do this because the vacuum
1519 * daemon automatically opens an index scan and deletes index tuples
1520 * when it finds deleted heap tuples. -cim 9/27/89
1523 /* AFTER ROW DELETE Triggers */
1524 ExecARDeleteTriggers(estate, resultRelInfo, tupleid);
1527 /* ----------------------------------------------------------------
1530 * note: we can't run UPDATE queries with transactions
1531 * off because UPDATEs are actually INSERTs and our
1532 * scan will mistakenly loop forever, updating the tuple
1533 * it just inserted.. This should be fixed but until it
1534 * is, we don't want to get stuck in an infinite loop
1535 * which corrupts your database..
1536 * ----------------------------------------------------------------
1539 ExecUpdate(TupleTableSlot *slot,
1540 ItemPointer tupleid,
1544 ResultRelInfo *resultRelInfo;
1545 Relation resultRelationDesc;
1546 ItemPointerData ctid;
1551 * abort the operation if not running transactions
1553 if (IsBootstrapProcessingMode())
1554 elog(ERROR, "cannot UPDATE during bootstrap");
1557 * get the heap tuple out of the tuple table slot
1562 * get information on the (current) result relation
1564 resultRelInfo = estate->es_result_relation_info;
1565 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1567 /* BEFORE ROW UPDATE Triggers */
1568 if (resultRelInfo->ri_TrigDesc &&
1569 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_UPDATE] > 0)
1573 newtuple = ExecBRUpdateTriggers(estate, resultRelInfo,
1575 estate->es_snapshot->curcid);
1577 if (newtuple == NULL) /* "do nothing" */
1580 if (newtuple != tuple) /* modified by Trigger(s) */
1583 * Insert modified tuple into tuple table slot, replacing the
1584 * original. We assume that it was allocated in per-tuple
1585 * memory context, and therefore will go away by itself. The
1586 * tuple table slot should not try to clear it.
1588 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1594 * Check the constraints of the tuple
1596 * If we generate a new candidate tuple after EvalPlanQual testing, we
1597 * must loop back here and recheck constraints. (We don't need to
1598 * redo triggers, however. If there are any BEFORE triggers then
1599 * trigger.c will have done mark4update to lock the correct tuple, so
1600 * there's no need to do them again.)
1603 if (resultRelationDesc->rd_att->constr)
1604 ExecConstraints(resultRelInfo, slot, estate);
1607 * replace the heap tuple
1609 result = heap_update(resultRelationDesc, tupleid, tuple,
1611 estate->es_snapshot->curcid,
1612 estate->es_crosscheck_snapshot,
1613 true /* wait for commit */);
1616 case HeapTupleSelfUpdated:
1617 /* already deleted by self; nothing to do */
1620 case HeapTupleMayBeUpdated:
1623 case HeapTupleUpdated:
1624 if (IsXactIsoLevelSerializable)
1626 (errcode(ERRCODE_T_R_SERIALIZATION_FAILURE),
1627 errmsg("could not serialize access due to concurrent update")));
1628 else if (!(ItemPointerEquals(tupleid, &ctid)))
1630 TupleTableSlot *epqslot = EvalPlanQual(estate,
1631 resultRelInfo->ri_RangeTableIndex, &ctid);
1633 if (!TupIsNull(epqslot))
1636 tuple = ExecRemoveJunk(estate->es_junkFilter, epqslot);
1637 slot = ExecStoreTuple(tuple,
1638 estate->es_junkFilter->jf_resultSlot,
1639 InvalidBuffer, true);
1643 /* tuple already deleted; nothing to do */
1647 elog(ERROR, "unrecognized heap_update status: %u", result);
1652 (estate->es_processed)++;
1655 * Note: instead of having to update the old index tuples associated
1656 * with the heap tuple, all we do is form and insert new index tuples.
1657 * This is because UPDATEs are actually DELETEs and INSERTs and index
1658 * tuple deletion is done automagically by the vacuum daemon. All we
1659 * do is insert new index tuples. -cim 9/27/89
1665 * heap_update updates a tuple in the base relation by invalidating it
1666 * and then inserting a new tuple to the relation. As a side effect,
1667 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1668 * field. So we now insert index tuples using the new tupleid stored
1672 numIndices = resultRelInfo->ri_NumIndices;
1674 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1676 /* AFTER ROW UPDATE Triggers */
1677 ExecARUpdateTriggers(estate, resultRelInfo, tupleid, tuple);
1681 ExecRelCheck(ResultRelInfo *resultRelInfo,
1682 TupleTableSlot *slot, EState *estate)
1684 Relation rel = resultRelInfo->ri_RelationDesc;
1685 int ncheck = rel->rd_att->constr->num_check;
1686 ConstrCheck *check = rel->rd_att->constr->check;
1687 ExprContext *econtext;
1688 MemoryContext oldContext;
1693 * If first time through for this result relation, build expression
1694 * nodetrees for rel's constraint expressions. Keep them in the
1695 * per-query memory context so they'll survive throughout the query.
1697 if (resultRelInfo->ri_ConstraintExprs == NULL)
1699 oldContext = MemoryContextSwitchTo(estate->es_query_cxt);
1700 resultRelInfo->ri_ConstraintExprs =
1701 (List **) palloc(ncheck * sizeof(List *));
1702 for (i = 0; i < ncheck; i++)
1704 /* ExecQual wants implicit-AND form */
1705 qual = make_ands_implicit(stringToNode(check[i].ccbin));
1706 resultRelInfo->ri_ConstraintExprs[i] = (List *)
1707 ExecPrepareExpr((Expr *) qual, estate);
1709 MemoryContextSwitchTo(oldContext);
1713 * We will use the EState's per-tuple context for evaluating
1714 * constraint expressions (creating it if it's not already there).
1716 econtext = GetPerTupleExprContext(estate);
1718 /* Arrange for econtext's scan tuple to be the tuple under test */
1719 econtext->ecxt_scantuple = slot;
1721 /* And evaluate the constraints */
1722 for (i = 0; i < ncheck; i++)
1724 qual = resultRelInfo->ri_ConstraintExprs[i];
1727 * NOTE: SQL92 specifies that a NULL result from a constraint
1728 * expression is not to be treated as a failure. Therefore, tell
1729 * ExecQual to return TRUE for NULL.
1731 if (!ExecQual(qual, econtext, true))
1732 return check[i].ccname;
1735 /* NULL result means no error */
1740 ExecConstraints(ResultRelInfo *resultRelInfo,
1741 TupleTableSlot *slot, EState *estate)
1743 Relation rel = resultRelInfo->ri_RelationDesc;
1744 HeapTuple tuple = slot->val;
1745 TupleConstr *constr = rel->rd_att->constr;
1749 if (constr->has_not_null)
1751 int natts = rel->rd_att->natts;
1754 for (attrChk = 1; attrChk <= natts; attrChk++)
1756 if (rel->rd_att->attrs[attrChk - 1]->attnotnull &&
1757 heap_attisnull(tuple, attrChk))
1759 (errcode(ERRCODE_NOT_NULL_VIOLATION),
1760 errmsg("null value in column \"%s\" violates not-null constraint",
1761 NameStr(rel->rd_att->attrs[attrChk - 1]->attname))));
1765 if (constr->num_check > 0)
1769 if ((failed = ExecRelCheck(resultRelInfo, slot, estate)) != NULL)
1771 (errcode(ERRCODE_CHECK_VIOLATION),
1772 errmsg("new row for relation \"%s\" violates check constraint \"%s\"",
1773 RelationGetRelationName(rel), failed)));
1778 * Check a modified tuple to see if we want to process its updated version
1779 * under READ COMMITTED rules.
1781 * See backend/executor/README for some info about how this works.
1784 EvalPlanQual(EState *estate, Index rti, ItemPointer tid)
1789 HeapTupleData tuple;
1790 HeapTuple copyTuple = NULL;
1796 * find relation containing target tuple
1798 if (estate->es_result_relation_info != NULL &&
1799 estate->es_result_relation_info->ri_RangeTableIndex == rti)
1800 relation = estate->es_result_relation_info->ri_RelationDesc;
1806 foreach(l, estate->es_rowMark)
1808 if (((execRowMark *) lfirst(l))->rti == rti)
1810 relation = ((execRowMark *) lfirst(l))->relation;
1814 if (relation == NULL)
1815 elog(ERROR, "could not find RowMark for RT index %u", rti);
1821 * Loop here to deal with updated or busy tuples
1823 tuple.t_self = *tid;
1828 if (heap_fetch(relation, SnapshotDirty, &tuple, &buffer, false, NULL))
1830 TransactionId xwait = SnapshotDirty->xmax;
1832 /* xmin should not be dirty... */
1833 if (TransactionIdIsValid(SnapshotDirty->xmin))
1834 elog(ERROR, "t_xmin is uncommitted in tuple to be updated");
1837 * If tuple is being updated by other transaction then we have
1838 * to wait for its commit/abort.
1840 if (TransactionIdIsValid(xwait))
1842 ReleaseBuffer(buffer);
1843 XactLockTableWait(xwait);
1848 * We got tuple - now copy it for use by recheck query.
1850 copyTuple = heap_copytuple(&tuple);
1851 ReleaseBuffer(buffer);
1856 * Oops! Invalid tuple. Have to check is it updated or deleted.
1857 * Note that it's possible to get invalid SnapshotDirty->tid if
1858 * tuple updated by this transaction. Have we to check this ?
1860 if (ItemPointerIsValid(&(SnapshotDirty->tid)) &&
1861 !(ItemPointerEquals(&(tuple.t_self), &(SnapshotDirty->tid))))
1863 /* updated, so look at the updated copy */
1864 tuple.t_self = SnapshotDirty->tid;
1869 * Deleted or updated by this transaction; forget it.
1875 * For UPDATE/DELETE we have to return tid of actual row we're
1878 *tid = tuple.t_self;
1881 * Need to run a recheck subquery. Find or create a PQ stack entry.
1883 epq = estate->es_evalPlanQual;
1886 if (epq != NULL && epq->rti == 0)
1888 /* Top PQ stack entry is idle, so re-use it */
1889 Assert(!(estate->es_useEvalPlan) && epq->next == NULL);
1895 * If this is request for another RTE - Ra, - then we have to check
1896 * wasn't PlanQual requested for Ra already and if so then Ra' row was
1897 * updated again and we have to re-start old execution for Ra and
1898 * forget all what we done after Ra was suspended. Cool? -:))
1900 if (epq != NULL && epq->rti != rti &&
1901 epq->estate->es_evTuple[rti - 1] != NULL)
1905 evalPlanQual *oldepq;
1907 /* stop execution */
1908 EvalPlanQualStop(epq);
1909 /* pop previous PlanQual from the stack */
1911 Assert(oldepq && oldepq->rti != 0);
1912 /* push current PQ to freePQ stack */
1915 estate->es_evalPlanQual = epq;
1916 } while (epq->rti != rti);
1920 * If we are requested for another RTE then we have to suspend
1921 * execution of current PlanQual and start execution for new one.
1923 if (epq == NULL || epq->rti != rti)
1925 /* try to reuse plan used previously */
1926 evalPlanQual *newepq = (epq != NULL) ? epq->free : NULL;
1928 if (newepq == NULL) /* first call or freePQ stack is empty */
1930 newepq = (evalPlanQual *) palloc0(sizeof(evalPlanQual));
1931 newepq->free = NULL;
1932 newepq->estate = NULL;
1933 newepq->planstate = NULL;
1937 /* recycle previously used PlanQual */
1938 Assert(newepq->estate == NULL);
1941 /* push current PQ to the stack */
1944 estate->es_evalPlanQual = epq;
1949 Assert(epq->rti == rti);
1952 * Ok - we're requested for the same RTE. Unfortunately we still have
1953 * to end and restart execution of the plan, because ExecReScan
1954 * wouldn't ensure that upper plan nodes would reset themselves. We
1955 * could make that work if insertion of the target tuple were
1956 * integrated with the Param mechanism somehow, so that the upper plan
1957 * nodes know that their children's outputs have changed.
1959 * Note that the stack of free evalPlanQual nodes is quite useless at the
1960 * moment, since it only saves us from pallocing/releasing the
1961 * evalPlanQual nodes themselves. But it will be useful once we
1962 * implement ReScan instead of end/restart for re-using PlanQual
1967 /* stop execution */
1968 EvalPlanQualStop(epq);
1972 * Initialize new recheck query.
1974 * Note: if we were re-using PlanQual plans via ExecReScan, we'd need to
1975 * instead copy down changeable state from the top plan (including
1976 * es_result_relation_info, es_junkFilter) and reset locally
1977 * changeable state in the epq (including es_param_exec_vals,
1980 EvalPlanQualStart(epq, estate, epq->next);
1983 * free old RTE' tuple, if any, and store target tuple where
1984 * relation's scan node will see it
1986 epqstate = epq->estate;
1987 if (epqstate->es_evTuple[rti - 1] != NULL)
1988 heap_freetuple(epqstate->es_evTuple[rti - 1]);
1989 epqstate->es_evTuple[rti - 1] = copyTuple;
1991 return EvalPlanQualNext(estate);
1994 static TupleTableSlot *
1995 EvalPlanQualNext(EState *estate)
1997 evalPlanQual *epq = estate->es_evalPlanQual;
1998 MemoryContext oldcontext;
1999 TupleTableSlot *slot;
2001 Assert(epq->rti != 0);
2004 oldcontext = MemoryContextSwitchTo(epq->estate->es_query_cxt);
2005 slot = ExecProcNode(epq->planstate);
2006 MemoryContextSwitchTo(oldcontext);
2009 * No more tuples for this PQ. Continue previous one.
2011 if (TupIsNull(slot))
2013 evalPlanQual *oldepq;
2015 /* stop execution */
2016 EvalPlanQualStop(epq);
2017 /* pop old PQ from the stack */
2021 /* this is the first (oldest) PQ - mark as free */
2023 estate->es_useEvalPlan = false;
2024 /* and continue Query execution */
2027 Assert(oldepq->rti != 0);
2028 /* push current PQ to freePQ stack */
2031 estate->es_evalPlanQual = epq;
2039 EndEvalPlanQual(EState *estate)
2041 evalPlanQual *epq = estate->es_evalPlanQual;
2043 if (epq->rti == 0) /* plans already shutdowned */
2045 Assert(epq->next == NULL);
2051 evalPlanQual *oldepq;
2053 /* stop execution */
2054 EvalPlanQualStop(epq);
2055 /* pop old PQ from the stack */
2059 /* this is the first (oldest) PQ - mark as free */
2061 estate->es_useEvalPlan = false;
2064 Assert(oldepq->rti != 0);
2065 /* push current PQ to freePQ stack */
2068 estate->es_evalPlanQual = epq;
2073 * Start execution of one level of PlanQual.
2075 * This is a cut-down version of ExecutorStart(): we copy some state from
2076 * the top-level estate rather than initializing it fresh.
2079 EvalPlanQualStart(evalPlanQual *epq, EState *estate, evalPlanQual *priorepq)
2083 MemoryContext oldcontext;
2085 rtsize = length(estate->es_range_table);
2087 epq->estate = epqstate = CreateExecutorState();
2089 oldcontext = MemoryContextSwitchTo(epqstate->es_query_cxt);
2092 * The epqstates share the top query's copy of unchanging state such
2093 * as the snapshot, rangetable, result-rel info, and external Param
2094 * info. They need their own copies of local state, including a tuple
2095 * table, es_param_exec_vals, etc.
2097 epqstate->es_direction = ForwardScanDirection;
2098 epqstate->es_snapshot = estate->es_snapshot;
2099 epqstate->es_crosscheck_snapshot = estate->es_crosscheck_snapshot;
2100 epqstate->es_range_table = estate->es_range_table;
2101 epqstate->es_result_relations = estate->es_result_relations;
2102 epqstate->es_num_result_relations = estate->es_num_result_relations;
2103 epqstate->es_result_relation_info = estate->es_result_relation_info;
2104 epqstate->es_junkFilter = estate->es_junkFilter;
2105 epqstate->es_into_relation_descriptor = estate->es_into_relation_descriptor;
2106 epqstate->es_param_list_info = estate->es_param_list_info;
2107 if (estate->es_topPlan->nParamExec > 0)
2108 epqstate->es_param_exec_vals = (ParamExecData *)
2109 palloc0(estate->es_topPlan->nParamExec * sizeof(ParamExecData));
2110 epqstate->es_rowMark = estate->es_rowMark;
2111 epqstate->es_instrument = estate->es_instrument;
2112 epqstate->es_select_into = estate->es_select_into;
2113 epqstate->es_into_oids = estate->es_into_oids;
2114 epqstate->es_topPlan = estate->es_topPlan;
2117 * Each epqstate must have its own es_evTupleNull state, but all the
2118 * stack entries share es_evTuple state. This allows sub-rechecks to
2119 * inherit the value being examined by an outer recheck.
2121 epqstate->es_evTupleNull = (bool *) palloc0(rtsize * sizeof(bool));
2122 if (priorepq == NULL)
2123 /* first PQ stack entry */
2124 epqstate->es_evTuple = (HeapTuple *)
2125 palloc0(rtsize * sizeof(HeapTuple));
2127 /* later stack entries share the same storage */
2128 epqstate->es_evTuple = priorepq->estate->es_evTuple;
2130 epqstate->es_tupleTable =
2131 ExecCreateTupleTable(estate->es_tupleTable->size);
2133 epq->planstate = ExecInitNode(estate->es_topPlan, epqstate);
2135 MemoryContextSwitchTo(oldcontext);
2139 * End execution of one level of PlanQual.
2141 * This is a cut-down version of ExecutorEnd(); basically we want to do most
2142 * of the normal cleanup, but *not* close result relations (which we are
2143 * just sharing from the outer query).
2146 EvalPlanQualStop(evalPlanQual *epq)
2148 EState *epqstate = epq->estate;
2149 MemoryContext oldcontext;
2151 oldcontext = MemoryContextSwitchTo(epqstate->es_query_cxt);
2153 ExecEndNode(epq->planstate);
2155 ExecDropTupleTable(epqstate->es_tupleTable, true);
2156 epqstate->es_tupleTable = NULL;
2158 if (epqstate->es_evTuple[epq->rti - 1] != NULL)
2160 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
2161 epqstate->es_evTuple[epq->rti - 1] = NULL;
2164 MemoryContextSwitchTo(oldcontext);
2166 FreeExecutorState(epqstate);
2169 epq->planstate = NULL;