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 and the execution state is required
18 * ExecutorStart() must be called at the beginning of any execution of any
19 * query plan and ExecutorEnd() should always be called at the end of
20 * execution of a plan.
22 * ExecutorRun accepts direction and count arguments that specify whether
23 * the plan is to be executed forwards, backwards, and for how many tuples.
25 * Portions Copyright (c) 1996-2001, PostgreSQL Global Development Group
26 * Portions Copyright (c) 1994, Regents of the University of California
30 * $Header: /cvsroot/pgsql/src/backend/executor/execMain.c,v 1.161 2002/05/12 20:10:02 tgl Exp $
32 *-------------------------------------------------------------------------
36 #include "access/heapam.h"
37 #include "catalog/heap.h"
38 #include "catalog/namespace.h"
39 #include "commands/tablecmds.h"
40 #include "commands/trigger.h"
41 #include "executor/execdebug.h"
42 #include "executor/execdefs.h"
43 #include "miscadmin.h"
44 #include "optimizer/var.h"
45 #include "parser/parsetree.h"
46 #include "utils/acl.h"
47 #include "utils/lsyscache.h"
50 /* decls for local routines only used within this module */
51 static TupleDesc InitPlan(CmdType operation,
55 static void initResultRelInfo(ResultRelInfo *resultRelInfo,
56 Index resultRelationIndex,
59 static void EndPlan(Plan *plan, EState *estate);
60 static TupleTableSlot *ExecutePlan(EState *estate, Plan *plan,
63 ScanDirection direction,
64 DestReceiver *destfunc);
65 static void ExecRetrieve(TupleTableSlot *slot,
66 DestReceiver *destfunc,
68 static void ExecAppend(TupleTableSlot *slot, ItemPointer tupleid,
70 static void ExecDelete(TupleTableSlot *slot, ItemPointer tupleid,
72 static void ExecReplace(TupleTableSlot *slot, ItemPointer tupleid,
74 static TupleTableSlot *EvalPlanQualNext(EState *estate);
75 static void EndEvalPlanQual(EState *estate);
76 static void ExecCheckQueryPerms(CmdType operation, Query *parseTree,
78 static void ExecCheckPlanPerms(Plan *plan, List *rangeTable,
80 static void ExecCheckRTPerms(List *rangeTable, CmdType operation);
81 static void ExecCheckRTEPerms(RangeTblEntry *rte, CmdType operation);
83 /* end of local decls */
86 /* ----------------------------------------------------------------
89 * This routine must be called at the beginning of any execution of any
92 * returns a TupleDesc which describes the attributes of the tuples to
93 * be returned by the query. (Same value is saved in queryDesc)
95 * NB: the CurrentMemoryContext when this is called must be the context
96 * to be used as the per-query context for the query plan. ExecutorRun()
97 * and ExecutorEnd() must be called in this same memory context.
98 * ----------------------------------------------------------------
101 ExecutorStart(QueryDesc *queryDesc, EState *estate)
106 Assert(queryDesc != NULL);
108 if (queryDesc->plantree->nParamExec > 0)
110 estate->es_param_exec_vals = (ParamExecData *)
111 palloc(queryDesc->plantree->nParamExec * sizeof(ParamExecData));
112 MemSet(estate->es_param_exec_vals, 0,
113 queryDesc->plantree->nParamExec * sizeof(ParamExecData));
117 * Make our own private copy of the current queries snapshot data
119 if (QuerySnapshot == NULL)
120 estate->es_snapshot = NULL;
123 estate->es_snapshot = (Snapshot) palloc(sizeof(SnapshotData));
124 memcpy(estate->es_snapshot, QuerySnapshot, sizeof(SnapshotData));
125 if (estate->es_snapshot->xcnt > 0)
127 estate->es_snapshot->xip = (TransactionId *)
128 palloc(estate->es_snapshot->xcnt * sizeof(TransactionId));
129 memcpy(estate->es_snapshot->xip, QuerySnapshot->xip,
130 estate->es_snapshot->xcnt * sizeof(TransactionId));
135 * Initialize the plan
137 result = InitPlan(queryDesc->operation,
138 queryDesc->parsetree,
142 queryDesc->tupDesc = result;
147 /* ----------------------------------------------------------------
150 * This is the main routine of the executor module. It accepts
151 * the query descriptor from the traffic cop and executes the
154 * ExecutorStart must have been called already.
156 * If direction is NoMovementScanDirection then nothing is done
157 * except to start up/shut down the destination. Otherwise,
158 * we retrieve up to 'count' tuples in the specified direction.
160 * Note: count = 0 is interpreted as no portal limit, e.g. run to
163 * ----------------------------------------------------------------
166 ExecutorRun(QueryDesc *queryDesc, EState *estate,
167 ScanDirection direction, long count)
172 DestReceiver *destfunc;
173 TupleTableSlot *result;
178 Assert(queryDesc != NULL);
181 * extract information from the query descriptor and the query
184 operation = queryDesc->operation;
185 plan = queryDesc->plantree;
186 dest = queryDesc->dest;
189 * startup tuple receiver
191 estate->es_processed = 0;
192 estate->es_lastoid = InvalidOid;
194 destfunc = DestToFunction(dest);
195 (*destfunc->setup) (destfunc, (int) operation,
196 queryDesc->portalName, queryDesc->tupDesc);
201 if (direction == NoMovementScanDirection)
204 result = ExecutePlan(estate,
214 (*destfunc->cleanup) (destfunc);
219 /* ----------------------------------------------------------------
222 * This routine must be called at the end of execution of any
224 * ----------------------------------------------------------------
227 ExecutorEnd(QueryDesc *queryDesc, EState *estate)
230 Assert(queryDesc != NULL);
232 EndPlan(queryDesc->plantree, estate);
234 if (estate->es_snapshot != NULL)
236 if (estate->es_snapshot->xcnt > 0)
237 pfree(estate->es_snapshot->xip);
238 pfree(estate->es_snapshot);
239 estate->es_snapshot = NULL;
242 if (estate->es_param_exec_vals != NULL)
244 pfree(estate->es_param_exec_vals);
245 estate->es_param_exec_vals = NULL;
251 * ExecCheckQueryPerms
252 * Check access permissions for all relations referenced in a query.
255 ExecCheckQueryPerms(CmdType operation, Query *parseTree, Plan *plan)
258 * Check RTEs in the query's primary rangetable.
260 ExecCheckRTPerms(parseTree->rtable, operation);
263 * Search for subplans and APPEND nodes to check their rangetables.
265 ExecCheckPlanPerms(plan, parseTree->rtable, operation);
270 * Recursively scan the plan tree to check access permissions in
274 ExecCheckPlanPerms(Plan *plan, List *rangeTable, CmdType operation)
281 /* Check subplans, which we assume are plain SELECT queries */
283 foreach(subp, plan->initPlan)
285 SubPlan *subplan = (SubPlan *) lfirst(subp);
287 ExecCheckRTPerms(subplan->rtable, CMD_SELECT);
288 ExecCheckPlanPerms(subplan->plan, subplan->rtable, CMD_SELECT);
290 foreach(subp, plan->subPlan)
292 SubPlan *subplan = (SubPlan *) lfirst(subp);
294 ExecCheckRTPerms(subplan->rtable, CMD_SELECT);
295 ExecCheckPlanPerms(subplan->plan, subplan->rtable, CMD_SELECT);
298 /* Check lower plan nodes */
300 ExecCheckPlanPerms(plan->lefttree, rangeTable, operation);
301 ExecCheckPlanPerms(plan->righttree, rangeTable, operation);
303 /* Do node-type-specific checks */
305 switch (nodeTag(plan))
309 SubqueryScan *scan = (SubqueryScan *) plan;
312 /* Recursively check the subquery */
313 rte = rt_fetch(scan->scan.scanrelid, rangeTable);
314 Assert(rte->rtekind == RTE_SUBQUERY);
315 ExecCheckQueryPerms(operation, rte->subquery, scan->subplan);
320 Append *app = (Append *) plan;
323 foreach(appendplans, app->appendplans)
325 ExecCheckPlanPerms((Plan *) lfirst(appendplans),
339 * Check access permissions for all relations listed in a range table.
342 ExecCheckRTPerms(List *rangeTable, CmdType operation)
346 foreach(lp, rangeTable)
348 RangeTblEntry *rte = lfirst(lp);
350 ExecCheckRTEPerms(rte, operation);
356 * Check access permissions for a single RTE.
359 ExecCheckRTEPerms(RangeTblEntry *rte, CmdType operation)
363 AclResult aclcheck_result;
366 * Only plain-relation RTEs need to be checked here. Subquery RTEs
367 * will be checked when ExecCheckPlanPerms finds the SubqueryScan node,
368 * and function RTEs are checked by init_fcache when the function is
369 * prepared for execution. Join and special RTEs need no checks.
371 if (rte->rtekind != RTE_RELATION)
377 * userid to check as: current user unless we have a setuid
380 * Note: GetUserId() is presently fast enough that there's no harm in
381 * calling it separately for each RTE. If that stops being true, we
382 * could call it once in ExecCheckQueryPerms and pass the userid down
383 * from there. But for now, no need for the extra clutter.
385 userid = rte->checkAsUser ? rte->checkAsUser : GetUserId();
387 #define CHECK(MODE) pg_class_aclcheck(relOid, userid, MODE)
389 if (rte->checkForRead)
391 aclcheck_result = CHECK(ACL_SELECT);
392 if (aclcheck_result != ACLCHECK_OK)
393 aclcheck_error(aclcheck_result, get_rel_name(relOid));
396 if (rte->checkForWrite)
399 * Note: write access in a SELECT context means SELECT FOR UPDATE.
400 * Right now we don't distinguish that from true update as far as
401 * permissions checks are concerned.
406 aclcheck_result = CHECK(ACL_INSERT);
410 aclcheck_result = CHECK(ACL_UPDATE);
413 aclcheck_result = CHECK(ACL_DELETE);
416 elog(ERROR, "ExecCheckRTEPerms: bogus operation %d",
418 aclcheck_result = ACLCHECK_OK; /* keep compiler quiet */
421 if (aclcheck_result != ACLCHECK_OK)
422 aclcheck_error(aclcheck_result, get_rel_name(relOid));
427 /* ===============================================================
428 * ===============================================================
429 static routines follow
430 * ===============================================================
431 * ===============================================================
434 typedef struct execRowMark
441 typedef struct evalPlanQual
446 struct evalPlanQual *free;
449 /* ----------------------------------------------------------------
452 * Initializes the query plan: open files, allocate storage
453 * and start up the rule manager
454 * ----------------------------------------------------------------
457 InitPlan(CmdType operation, Query *parseTree, Plan *plan, EState *estate)
460 Relation intoRelationDesc;
464 * Do permissions checks.
466 ExecCheckQueryPerms(operation, parseTree, plan);
469 * get information from query descriptor
471 rangeTable = parseTree->rtable;
474 * initialize the node's execution state
476 estate->es_range_table = rangeTable;
479 * if there is a result relation, initialize result relation stuff
481 if (parseTree->resultRelation != 0 && operation != CMD_SELECT)
483 List *resultRelations = parseTree->resultRelations;
484 int numResultRelations;
485 ResultRelInfo *resultRelInfos;
487 if (resultRelations != NIL)
490 * Multiple result relations (due to inheritance)
491 * parseTree->resultRelations identifies them all
493 ResultRelInfo *resultRelInfo;
495 numResultRelations = length(resultRelations);
496 resultRelInfos = (ResultRelInfo *)
497 palloc(numResultRelations * sizeof(ResultRelInfo));
498 resultRelInfo = resultRelInfos;
499 while (resultRelations != NIL)
501 initResultRelInfo(resultRelInfo,
502 lfirsti(resultRelations),
506 resultRelations = lnext(resultRelations);
512 * Single result relation identified by
513 * parseTree->resultRelation
515 numResultRelations = 1;
516 resultRelInfos = (ResultRelInfo *) palloc(sizeof(ResultRelInfo));
517 initResultRelInfo(resultRelInfos,
518 parseTree->resultRelation,
523 estate->es_result_relations = resultRelInfos;
524 estate->es_num_result_relations = numResultRelations;
525 /* Initialize to first or only result rel */
526 estate->es_result_relation_info = resultRelInfos;
531 * if no result relation, then set state appropriately
533 estate->es_result_relations = NULL;
534 estate->es_num_result_relations = 0;
535 estate->es_result_relation_info = NULL;
539 * Have to lock relations selected for update
541 estate->es_rowMark = NIL;
542 if (parseTree->rowMarks != NIL)
546 foreach(l, parseTree->rowMarks)
548 Index rti = lfirsti(l);
549 Oid relid = getrelid(rti, rangeTable);
553 relation = heap_open(relid, RowShareLock);
554 erm = (execRowMark *) palloc(sizeof(execRowMark));
555 erm->relation = relation;
557 sprintf(erm->resname, "ctid%u", rti);
558 estate->es_rowMark = lappend(estate->es_rowMark, erm);
563 * initialize the executor "tuple" table. We need slots for all the
564 * plan nodes, plus possibly output slots for the junkfilter(s). At
565 * this point we aren't sure if we need junkfilters, so just add slots
566 * for them unconditionally.
569 int nSlots = ExecCountSlotsNode(plan);
571 if (parseTree->resultRelations != NIL)
572 nSlots += length(parseTree->resultRelations);
575 estate->es_tupleTable = ExecCreateTupleTable(nSlots);
578 /* mark EvalPlanQual not active */
579 estate->es_origPlan = plan;
580 estate->es_evalPlanQual = NULL;
581 estate->es_evTuple = NULL;
582 estate->es_evTupleNull = NULL;
583 estate->es_useEvalPlan = false;
586 * initialize the private state information for all the nodes in the
587 * query tree. This opens files, allocates storage and leaves us
588 * ready to start processing tuples.
590 ExecInitNode(plan, estate, NULL);
593 * Get the tuple descriptor describing the type of tuples to return.
594 * (this is especially important if we are creating a relation with
597 tupType = ExecGetTupType(plan); /* tuple descriptor */
600 * Initialize the junk filter if needed. SELECT and INSERT queries
601 * need a filter if there are any junk attrs in the tlist. UPDATE and
602 * DELETE always need one, since there's always a junk 'ctid'
603 * attribute present --- no need to look first.
606 bool junk_filter_needed = false;
613 foreach(tlist, plan->targetlist)
615 TargetEntry *tle = (TargetEntry *) lfirst(tlist);
617 if (tle->resdom->resjunk)
619 junk_filter_needed = true;
626 junk_filter_needed = true;
632 if (junk_filter_needed)
635 * If there are multiple result relations, each one needs its
636 * own junk filter. Note this is only possible for
637 * UPDATE/DELETE, so we can't be fooled by some needing a
638 * filter and some not.
640 if (parseTree->resultRelations != NIL)
643 ResultRelInfo *resultRelInfo;
645 /* Top plan had better be an Append here. */
646 Assert(IsA(plan, Append));
647 Assert(((Append *) plan)->isTarget);
648 subplans = ((Append *) plan)->appendplans;
649 Assert(length(subplans) == estate->es_num_result_relations);
650 resultRelInfo = estate->es_result_relations;
651 while (subplans != NIL)
653 Plan *subplan = (Plan *) lfirst(subplans);
656 j = ExecInitJunkFilter(subplan->targetlist,
657 ExecGetTupType(subplan),
658 ExecAllocTableSlot(estate->es_tupleTable));
659 resultRelInfo->ri_junkFilter = j;
661 subplans = lnext(subplans);
665 * Set active junkfilter too; at this point ExecInitAppend
666 * has already selected an active result relation...
668 estate->es_junkFilter =
669 estate->es_result_relation_info->ri_junkFilter;
673 /* Normal case with just one JunkFilter */
676 j = ExecInitJunkFilter(plan->targetlist,
678 ExecAllocTableSlot(estate->es_tupleTable));
679 estate->es_junkFilter = j;
680 if (estate->es_result_relation_info)
681 estate->es_result_relation_info->ri_junkFilter = j;
683 /* For SELECT, want to return the cleaned tuple type */
684 if (operation == CMD_SELECT)
685 tupType = j->jf_cleanTupType;
689 estate->es_junkFilter = NULL;
693 * initialize the "into" relation
695 intoRelationDesc = (Relation) NULL;
697 if (operation == CMD_SELECT)
699 if (!parseTree->isPortal)
702 * a select into table --- need to create the "into" table
704 if (parseTree->into != NULL)
712 * find namespace to create in, check permissions
714 intoName = parseTree->into->relname;
715 namespaceId = RangeVarGetCreationNamespace(parseTree->into);
717 if (!isTempNamespace(namespaceId))
721 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
723 if (aclresult != ACLCHECK_OK)
724 aclcheck_error(aclresult,
725 get_namespace_name(namespaceId));
729 * have to copy tupType to get rid of constraints
731 tupdesc = CreateTupleDescCopy(tupType);
734 heap_create_with_catalog(intoName,
740 allowSystemTableMods);
742 FreeTupleDesc(tupdesc);
745 * Advance command counter so that the newly-created
746 * relation's catalog tuples will be visible to heap_open.
748 CommandCounterIncrement();
751 * If necessary, create a TOAST table for the into
752 * relation. Note that AlterTableCreateToastTable ends
753 * with CommandCounterIncrement(), so that the TOAST table
754 * will be visible for insertion.
756 AlterTableCreateToastTable(intoRelationId, true);
758 intoRelationDesc = heap_open(intoRelationId,
759 AccessExclusiveLock);
764 estate->es_into_relation_descriptor = intoRelationDesc;
770 * Initialize ResultRelInfo data for one result relation
773 initResultRelInfo(ResultRelInfo *resultRelInfo,
774 Index resultRelationIndex,
778 Oid resultRelationOid;
779 Relation resultRelationDesc;
781 resultRelationOid = getrelid(resultRelationIndex, rangeTable);
782 resultRelationDesc = heap_open(resultRelationOid, RowExclusiveLock);
784 switch (resultRelationDesc->rd_rel->relkind)
786 case RELKIND_SEQUENCE:
787 elog(ERROR, "You can't change sequence relation %s",
788 RelationGetRelationName(resultRelationDesc));
790 case RELKIND_TOASTVALUE:
791 elog(ERROR, "You can't change toast relation %s",
792 RelationGetRelationName(resultRelationDesc));
795 elog(ERROR, "You can't change view relation %s",
796 RelationGetRelationName(resultRelationDesc));
800 MemSet(resultRelInfo, 0, sizeof(ResultRelInfo));
801 resultRelInfo->type = T_ResultRelInfo;
802 resultRelInfo->ri_RangeTableIndex = resultRelationIndex;
803 resultRelInfo->ri_RelationDesc = resultRelationDesc;
804 resultRelInfo->ri_NumIndices = 0;
805 resultRelInfo->ri_IndexRelationDescs = NULL;
806 resultRelInfo->ri_IndexRelationInfo = NULL;
807 resultRelInfo->ri_TrigDesc = resultRelationDesc->trigdesc;
808 resultRelInfo->ri_TrigFunctions = NULL;
809 resultRelInfo->ri_ConstraintExprs = NULL;
810 resultRelInfo->ri_junkFilter = NULL;
813 * If there are indices on the result relation, open them and save
814 * descriptors in the result relation info, so that we can add new
815 * index entries for the tuples we add/update. We need not do this
816 * for a DELETE, however, since deletion doesn't affect indexes.
818 if (resultRelationDesc->rd_rel->relhasindex &&
819 operation != CMD_DELETE)
820 ExecOpenIndices(resultRelInfo);
823 /* ----------------------------------------------------------------
826 * Cleans up the query plan -- closes files and free up storages
827 * ----------------------------------------------------------------
830 EndPlan(Plan *plan, EState *estate)
832 ResultRelInfo *resultRelInfo;
837 * shut down any PlanQual processing we were doing
839 if (estate->es_evalPlanQual != NULL)
840 EndEvalPlanQual(estate);
843 * shut down the node-type-specific query processing
845 ExecEndNode(plan, NULL);
848 * destroy the executor "tuple" table.
850 ExecDropTupleTable(estate->es_tupleTable, true);
851 estate->es_tupleTable = NULL;
854 * close the result relation(s) if any, but hold locks until xact
855 * commit. Also clean up junkfilters if present.
857 resultRelInfo = estate->es_result_relations;
858 for (i = estate->es_num_result_relations; i > 0; i--)
860 /* Close indices and then the relation itself */
861 ExecCloseIndices(resultRelInfo);
862 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
863 /* Delete the junkfilter if any */
864 if (resultRelInfo->ri_junkFilter != NULL)
865 ExecFreeJunkFilter(resultRelInfo->ri_junkFilter);
870 * close the "into" relation if necessary, again keeping lock
872 if (estate->es_into_relation_descriptor != NULL)
873 heap_close(estate->es_into_relation_descriptor, NoLock);
876 * There might be a junkfilter without a result relation.
878 if (estate->es_num_result_relations == 0 &&
879 estate->es_junkFilter != NULL)
881 ExecFreeJunkFilter(estate->es_junkFilter);
882 estate->es_junkFilter = NULL;
886 * close any relations selected FOR UPDATE, again keeping locks
888 foreach(l, estate->es_rowMark)
890 execRowMark *erm = lfirst(l);
892 heap_close(erm->relation, NoLock);
896 /* ----------------------------------------------------------------
899 * processes the query plan to retrieve 'numberTuples' tuples in the
900 * direction specified.
901 * Retrieves all tuples if numberTuples is 0
903 * result is either a slot containing the last tuple in the case
904 * of a RETRIEVE or NULL otherwise.
906 * Note: the ctid attribute is a 'junk' attribute that is removed before the
908 * ----------------------------------------------------------------
910 static TupleTableSlot *
911 ExecutePlan(EState *estate,
915 ScanDirection direction,
916 DestReceiver *destfunc)
918 JunkFilter *junkfilter;
919 TupleTableSlot *slot;
920 ItemPointer tupleid = NULL;
921 ItemPointerData tuple_ctid;
922 long current_tuple_count;
923 TupleTableSlot *result;
926 * initialize local variables
929 current_tuple_count = 0;
935 estate->es_direction = direction;
938 * Loop until we've processed the proper number of tuples from the
944 /* Reset the per-output-tuple exprcontext */
945 ResetPerTupleExprContext(estate);
948 * Execute the plan and obtain a tuple
951 if (estate->es_useEvalPlan)
953 slot = EvalPlanQualNext(estate);
955 slot = ExecProcNode(plan, NULL);
958 slot = ExecProcNode(plan, NULL);
961 * if the tuple is null, then we assume there is nothing more to
962 * process so we just return null...
971 * if we have a junk filter, then project a new tuple with the
974 * Store this new "clean" tuple in the junkfilter's resultSlot.
975 * (Formerly, we stored it back over the "dirty" tuple, which is
976 * WRONG because that tuple slot has the wrong descriptor.)
978 * Also, extract all the junk information we need.
980 if ((junkfilter = estate->es_junkFilter) != (JunkFilter *) NULL)
987 * extract the 'ctid' junk attribute.
989 if (operation == CMD_UPDATE || operation == CMD_DELETE)
991 if (!ExecGetJunkAttribute(junkfilter,
996 elog(ERROR, "ExecutePlan: NO (junk) `ctid' was found!");
998 /* shouldn't ever get a null result... */
1000 elog(ERROR, "ExecutePlan: (junk) `ctid' is NULL!");
1002 tupleid = (ItemPointer) DatumGetPointer(datum);
1003 tuple_ctid = *tupleid; /* make sure we don't free the
1005 tupleid = &tuple_ctid;
1007 else if (estate->es_rowMark != NIL)
1012 foreach(l, estate->es_rowMark)
1014 execRowMark *erm = lfirst(l);
1016 HeapTupleData tuple;
1017 TupleTableSlot *newSlot;
1020 if (!ExecGetJunkAttribute(junkfilter,
1025 elog(ERROR, "ExecutePlan: NO (junk) `%s' was found!",
1028 /* shouldn't ever get a null result... */
1030 elog(ERROR, "ExecutePlan: (junk) `%s' is NULL!",
1033 tuple.t_self = *((ItemPointer) DatumGetPointer(datum));
1034 test = heap_mark4update(erm->relation, &tuple, &buffer);
1035 ReleaseBuffer(buffer);
1038 case HeapTupleSelfUpdated:
1039 case HeapTupleMayBeUpdated:
1042 case HeapTupleUpdated:
1043 if (XactIsoLevel == XACT_SERIALIZABLE)
1044 elog(ERROR, "Can't serialize access due to concurrent update");
1045 if (!(ItemPointerEquals(&(tuple.t_self),
1046 (ItemPointer) DatumGetPointer(datum))))
1048 newSlot = EvalPlanQual(estate, erm->rti, &(tuple.t_self));
1049 if (!(TupIsNull(newSlot)))
1052 estate->es_useEvalPlan = true;
1058 * if tuple was deleted or PlanQual failed for
1059 * updated tuple - we must not return this
1065 elog(ERROR, "Unknown status %u from heap_mark4update", test);
1072 * Finally create a new "clean" tuple with all junk attributes
1075 newTuple = ExecRemoveJunk(junkfilter, slot);
1077 slot = ExecStoreTuple(newTuple, /* tuple to store */
1078 junkfilter->jf_resultSlot, /* dest slot */
1079 InvalidBuffer, /* this tuple has no
1081 true); /* tuple should be pfreed */
1082 } /* if (junkfilter... */
1085 * now that we have a tuple, do the appropriate thing with it..
1086 * either return it to the user, add it to a relation someplace,
1087 * delete it from a relation, or modify some of its attributes.
1093 ExecRetrieve(slot, /* slot containing tuple */
1094 destfunc, /* destination's tuple-receiver
1101 ExecAppend(slot, tupleid, estate);
1106 ExecDelete(slot, tupleid, estate);
1111 ExecReplace(slot, tupleid, estate);
1116 elog(LOG, "ExecutePlan: unknown operation in queryDesc");
1122 * check our tuple count.. if we've processed the proper number
1123 * then quit, else loop again and process more tuples..
1125 current_tuple_count++;
1126 if (numberTuples == current_tuple_count)
1131 * here, result is either a slot containing a tuple in the case of a
1132 * RETRIEVE or NULL otherwise.
1137 /* ----------------------------------------------------------------
1140 * RETRIEVEs are easy.. we just pass the tuple to the appropriate
1141 * print function. The only complexity is when we do a
1142 * "retrieve into", in which case we insert the tuple into
1143 * the appropriate relation (note: this is a newly created relation
1144 * so we don't need to worry about indices or locks.)
1145 * ----------------------------------------------------------------
1148 ExecRetrieve(TupleTableSlot *slot,
1149 DestReceiver *destfunc,
1156 * get the heap tuple out of the tuple table slot
1159 attrtype = slot->ttc_tupleDescriptor;
1162 * insert the tuple into the "into relation"
1164 if (estate->es_into_relation_descriptor != NULL)
1166 heap_insert(estate->es_into_relation_descriptor, tuple);
1171 * send the tuple to the front end (or the screen)
1173 (*destfunc->receiveTuple) (tuple, attrtype, destfunc);
1175 (estate->es_processed)++;
1178 /* ----------------------------------------------------------------
1181 * APPENDs are trickier.. we have to insert the tuple into
1182 * the base relation and insert appropriate tuples into the
1184 * ----------------------------------------------------------------
1188 ExecAppend(TupleTableSlot *slot,
1189 ItemPointer tupleid,
1193 ResultRelInfo *resultRelInfo;
1194 Relation resultRelationDesc;
1199 * get the heap tuple out of the tuple table slot
1204 * get information on the (current) result relation
1206 resultRelInfo = estate->es_result_relation_info;
1207 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1209 /* BEFORE ROW INSERT Triggers */
1210 if (resultRelInfo->ri_TrigDesc &&
1211 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_INSERT] > 0)
1215 newtuple = ExecBRInsertTriggers(estate, resultRelInfo, tuple);
1217 if (newtuple == NULL) /* "do nothing" */
1220 if (newtuple != tuple) /* modified by Trigger(s) */
1223 * Insert modified tuple into tuple table slot, replacing the
1224 * original. We assume that it was allocated in per-tuple
1225 * memory context, and therefore will go away by itself. The
1226 * tuple table slot should not try to clear it.
1228 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1234 * Check the constraints of the tuple
1236 if (resultRelationDesc->rd_att->constr)
1237 ExecConstraints("ExecAppend", resultRelInfo, slot, estate);
1242 newId = heap_insert(resultRelationDesc, tuple);
1245 (estate->es_processed)++;
1246 estate->es_lastoid = newId;
1247 setLastTid(&(tuple->t_self));
1252 * Note: heap_insert adds a new tuple to a relation. As a side effect,
1253 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1256 numIndices = resultRelInfo->ri_NumIndices;
1258 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1260 /* AFTER ROW INSERT Triggers */
1261 if (resultRelInfo->ri_TrigDesc)
1262 ExecARInsertTriggers(estate, resultRelInfo, tuple);
1265 /* ----------------------------------------------------------------
1268 * DELETE is like append, we delete the tuple and its
1270 * ----------------------------------------------------------------
1273 ExecDelete(TupleTableSlot *slot,
1274 ItemPointer tupleid,
1277 ResultRelInfo *resultRelInfo;
1278 Relation resultRelationDesc;
1279 ItemPointerData ctid;
1283 * get information on the (current) result relation
1285 resultRelInfo = estate->es_result_relation_info;
1286 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1288 /* BEFORE ROW DELETE Triggers */
1289 if (resultRelInfo->ri_TrigDesc &&
1290 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_DELETE] > 0)
1294 dodelete = ExecBRDeleteTriggers(estate, resultRelInfo, tupleid);
1296 if (!dodelete) /* "do nothing" */
1304 result = heap_delete(resultRelationDesc, tupleid, &ctid);
1307 case HeapTupleSelfUpdated:
1310 case HeapTupleMayBeUpdated:
1313 case HeapTupleUpdated:
1314 if (XactIsoLevel == XACT_SERIALIZABLE)
1315 elog(ERROR, "Can't serialize access due to concurrent update");
1316 else if (!(ItemPointerEquals(tupleid, &ctid)))
1318 TupleTableSlot *epqslot = EvalPlanQual(estate,
1319 resultRelInfo->ri_RangeTableIndex, &ctid);
1321 if (!TupIsNull(epqslot))
1327 /* tuple already deleted; nothing to do */
1331 elog(ERROR, "Unknown status %u from heap_delete", result);
1336 (estate->es_processed)++;
1339 * Note: Normally one would think that we have to delete index tuples
1340 * associated with the heap tuple now..
1342 * ... but in POSTGRES, we have no need to do this because the vacuum
1343 * daemon automatically opens an index scan and deletes index tuples
1344 * when it finds deleted heap tuples. -cim 9/27/89
1347 /* AFTER ROW DELETE Triggers */
1348 if (resultRelInfo->ri_TrigDesc)
1349 ExecARDeleteTriggers(estate, resultRelInfo, tupleid);
1352 /* ----------------------------------------------------------------
1355 * note: we can't run replace queries with transactions
1356 * off because replaces are actually appends and our
1357 * scan will mistakenly loop forever, replacing the tuple
1358 * it just appended.. This should be fixed but until it
1359 * is, we don't want to get stuck in an infinite loop
1360 * which corrupts your database..
1361 * ----------------------------------------------------------------
1364 ExecReplace(TupleTableSlot *slot,
1365 ItemPointer tupleid,
1369 ResultRelInfo *resultRelInfo;
1370 Relation resultRelationDesc;
1371 ItemPointerData ctid;
1376 * abort the operation if not running transactions
1378 if (IsBootstrapProcessingMode())
1380 elog(WARNING, "ExecReplace: replace can't run without transactions");
1385 * get the heap tuple out of the tuple table slot
1390 * get information on the (current) result relation
1392 resultRelInfo = estate->es_result_relation_info;
1393 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1395 /* BEFORE ROW UPDATE Triggers */
1396 if (resultRelInfo->ri_TrigDesc &&
1397 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_UPDATE] > 0)
1401 newtuple = ExecBRUpdateTriggers(estate, resultRelInfo,
1404 if (newtuple == NULL) /* "do nothing" */
1407 if (newtuple != tuple) /* modified by Trigger(s) */
1410 * Insert modified tuple into tuple table slot, replacing the
1411 * original. We assume that it was allocated in per-tuple
1412 * memory context, and therefore will go away by itself. The
1413 * tuple table slot should not try to clear it.
1415 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1421 * Check the constraints of the tuple
1423 * If we generate a new candidate tuple after EvalPlanQual testing, we
1424 * must loop back here and recheck constraints. (We don't need to
1425 * redo triggers, however. If there are any BEFORE triggers then
1426 * trigger.c will have done mark4update to lock the correct tuple, so
1427 * there's no need to do them again.)
1430 if (resultRelationDesc->rd_att->constr)
1431 ExecConstraints("ExecReplace", resultRelInfo, slot, estate);
1434 * replace the heap tuple
1436 result = heap_update(resultRelationDesc, tupleid, tuple, &ctid);
1439 case HeapTupleSelfUpdated:
1442 case HeapTupleMayBeUpdated:
1445 case HeapTupleUpdated:
1446 if (XactIsoLevel == XACT_SERIALIZABLE)
1447 elog(ERROR, "Can't serialize access due to concurrent update");
1448 else if (!(ItemPointerEquals(tupleid, &ctid)))
1450 TupleTableSlot *epqslot = EvalPlanQual(estate,
1451 resultRelInfo->ri_RangeTableIndex, &ctid);
1453 if (!TupIsNull(epqslot))
1456 tuple = ExecRemoveJunk(estate->es_junkFilter, epqslot);
1457 slot = ExecStoreTuple(tuple,
1458 estate->es_junkFilter->jf_resultSlot,
1459 InvalidBuffer, true);
1463 /* tuple already deleted; nothing to do */
1467 elog(ERROR, "Unknown status %u from heap_update", result);
1472 (estate->es_processed)++;
1475 * Note: instead of having to update the old index tuples associated
1476 * with the heap tuple, all we do is form and insert new index tuples.
1477 * This is because replaces are actually deletes and inserts and index
1478 * tuple deletion is done automagically by the vacuum daemon. All we
1479 * do is insert new index tuples. -cim 9/27/89
1485 * heap_update updates a tuple in the base relation by invalidating it
1486 * and then appending a new tuple to the relation. As a side effect,
1487 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1488 * field. So we now insert index tuples using the new tupleid stored
1492 numIndices = resultRelInfo->ri_NumIndices;
1494 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, true);
1496 /* AFTER ROW UPDATE Triggers */
1497 if (resultRelInfo->ri_TrigDesc)
1498 ExecARUpdateTriggers(estate, resultRelInfo, tupleid, tuple);
1502 ExecRelCheck(ResultRelInfo *resultRelInfo,
1503 TupleTableSlot *slot, EState *estate)
1505 Relation rel = resultRelInfo->ri_RelationDesc;
1506 int ncheck = rel->rd_att->constr->num_check;
1507 ConstrCheck *check = rel->rd_att->constr->check;
1508 ExprContext *econtext;
1509 MemoryContext oldContext;
1514 * If first time through for this result relation, build expression
1515 * nodetrees for rel's constraint expressions. Keep them in the
1516 * per-query memory context so they'll survive throughout the query.
1518 if (resultRelInfo->ri_ConstraintExprs == NULL)
1520 oldContext = MemoryContextSwitchTo(estate->es_query_cxt);
1521 resultRelInfo->ri_ConstraintExprs =
1522 (List **) palloc(ncheck * sizeof(List *));
1523 for (i = 0; i < ncheck; i++)
1525 qual = (List *) stringToNode(check[i].ccbin);
1526 resultRelInfo->ri_ConstraintExprs[i] = qual;
1528 MemoryContextSwitchTo(oldContext);
1532 * We will use the EState's per-tuple context for evaluating
1533 * constraint expressions (creating it if it's not already there).
1535 econtext = GetPerTupleExprContext(estate);
1537 /* Arrange for econtext's scan tuple to be the tuple under test */
1538 econtext->ecxt_scantuple = slot;
1540 /* And evaluate the constraints */
1541 for (i = 0; i < ncheck; i++)
1543 qual = resultRelInfo->ri_ConstraintExprs[i];
1546 * NOTE: SQL92 specifies that a NULL result from a constraint
1547 * expression is not to be treated as a failure. Therefore, tell
1548 * ExecQual to return TRUE for NULL.
1550 if (!ExecQual(qual, econtext, true))
1551 return check[i].ccname;
1554 /* NULL result means no error */
1555 return (char *) NULL;
1559 ExecConstraints(char *caller, ResultRelInfo *resultRelInfo,
1560 TupleTableSlot *slot, EState *estate)
1562 Relation rel = resultRelInfo->ri_RelationDesc;
1563 HeapTuple tuple = slot->val;
1564 TupleConstr *constr = rel->rd_att->constr;
1568 if (constr->has_not_null)
1570 int natts = rel->rd_att->natts;
1573 for (attrChk = 1; attrChk <= natts; attrChk++)
1575 if (rel->rd_att->attrs[attrChk - 1]->attnotnull &&
1576 heap_attisnull(tuple, attrChk))
1577 elog(ERROR, "%s: Fail to add null value in not null attribute %s",
1578 caller, NameStr(rel->rd_att->attrs[attrChk - 1]->attname));
1582 if (constr->num_check > 0)
1586 if ((failed = ExecRelCheck(resultRelInfo, slot, estate)) != NULL)
1587 elog(ERROR, "%s: rejected due to CHECK constraint %s",
1593 * Check a modified tuple to see if we want to process its updated version
1594 * under READ COMMITTED rules.
1596 * See backend/executor/README for some info about how this works.
1599 EvalPlanQual(EState *estate, Index rti, ItemPointer tid)
1604 HeapTupleData tuple;
1605 HeapTuple copyTuple = NULL;
1612 * find relation containing target tuple
1614 if (estate->es_result_relation_info != NULL &&
1615 estate->es_result_relation_info->ri_RangeTableIndex == rti)
1616 relation = estate->es_result_relation_info->ri_RelationDesc;
1622 foreach(l, estate->es_rowMark)
1624 if (((execRowMark *) lfirst(l))->rti == rti)
1626 relation = ((execRowMark *) lfirst(l))->relation;
1630 if (relation == NULL)
1631 elog(ERROR, "EvalPlanQual: can't find RTE %d", (int) rti);
1637 * Loop here to deal with updated or busy tuples
1639 tuple.t_self = *tid;
1644 heap_fetch(relation, SnapshotDirty, &tuple, &buffer, NULL);
1645 if (tuple.t_data != NULL)
1647 TransactionId xwait = SnapshotDirty->xmax;
1649 if (TransactionIdIsValid(SnapshotDirty->xmin))
1650 elog(ERROR, "EvalPlanQual: t_xmin is uncommitted ?!");
1653 * If tuple is being updated by other transaction then we have
1654 * to wait for its commit/abort.
1656 if (TransactionIdIsValid(xwait))
1658 ReleaseBuffer(buffer);
1659 XactLockTableWait(xwait);
1664 * We got tuple - now copy it for use by recheck query.
1666 copyTuple = heap_copytuple(&tuple);
1667 ReleaseBuffer(buffer);
1672 * Oops! Invalid tuple. Have to check is it updated or deleted.
1673 * Note that it's possible to get invalid SnapshotDirty->tid if
1674 * tuple updated by this transaction. Have we to check this ?
1676 if (ItemPointerIsValid(&(SnapshotDirty->tid)) &&
1677 !(ItemPointerEquals(&(tuple.t_self), &(SnapshotDirty->tid))))
1679 /* updated, so look at the updated copy */
1680 tuple.t_self = SnapshotDirty->tid;
1685 * Deleted or updated by this transaction; forget it.
1691 * For UPDATE/DELETE we have to return tid of actual row we're
1694 *tid = tuple.t_self;
1697 * Need to run a recheck subquery. Find or create a PQ stack entry.
1699 epq = (evalPlanQual *) estate->es_evalPlanQual;
1700 rtsize = length(estate->es_range_table);
1703 if (epq != NULL && epq->rti == 0)
1705 /* Top PQ stack entry is idle, so re-use it */
1706 Assert(!(estate->es_useEvalPlan) &&
1707 epq->estate.es_evalPlanQual == NULL);
1713 * If this is request for another RTE - Ra, - then we have to check
1714 * wasn't PlanQual requested for Ra already and if so then Ra' row was
1715 * updated again and we have to re-start old execution for Ra and
1716 * forget all what we done after Ra was suspended. Cool? -:))
1718 if (epq != NULL && epq->rti != rti &&
1719 epq->estate.es_evTuple[rti - 1] != NULL)
1723 evalPlanQual *oldepq;
1725 /* pop previous PlanQual from the stack */
1726 epqstate = &(epq->estate);
1727 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1728 Assert(oldepq->rti != 0);
1729 /* stop execution */
1730 ExecEndNode(epq->plan, NULL);
1731 ExecDropTupleTable(epqstate->es_tupleTable, true);
1732 epqstate->es_tupleTable = NULL;
1733 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1734 epqstate->es_evTuple[epq->rti - 1] = NULL;
1735 /* push current PQ to freePQ stack */
1738 estate->es_evalPlanQual = (Pointer) epq;
1739 } while (epq->rti != rti);
1743 * If we are requested for another RTE then we have to suspend
1744 * execution of current PlanQual and start execution for new one.
1746 if (epq == NULL || epq->rti != rti)
1748 /* try to reuse plan used previously */
1749 evalPlanQual *newepq = (epq != NULL) ? epq->free : NULL;
1751 if (newepq == NULL) /* first call or freePQ stack is empty */
1753 newepq = (evalPlanQual *) palloc(sizeof(evalPlanQual));
1754 newepq->free = NULL;
1757 * Each stack level has its own copy of the plan tree. This
1758 * is wasteful, but necessary as long as plan nodes point to
1759 * exec state nodes rather than vice versa. Note that
1760 * copyfuncs.c doesn't attempt to copy the exec state nodes,
1761 * which is a good thing in this situation.
1763 newepq->plan = copyObject(estate->es_origPlan);
1766 * Init stack level's EState. We share top level's copy of
1767 * es_result_relations array and other non-changing status. We
1768 * need our own tupletable, es_param_exec_vals, and other
1771 epqstate = &(newepq->estate);
1772 memcpy(epqstate, estate, sizeof(EState));
1773 epqstate->es_direction = ForwardScanDirection;
1774 if (estate->es_origPlan->nParamExec > 0)
1775 epqstate->es_param_exec_vals = (ParamExecData *)
1776 palloc(estate->es_origPlan->nParamExec *
1777 sizeof(ParamExecData));
1778 epqstate->es_tupleTable = NULL;
1779 epqstate->es_per_tuple_exprcontext = NULL;
1782 * Each epqstate must have its own es_evTupleNull state, but
1783 * all the stack entries share es_evTuple state. This allows
1784 * sub-rechecks to inherit the value being examined by an
1787 epqstate->es_evTupleNull = (bool *) palloc(rtsize * sizeof(bool));
1790 /* first PQ stack entry */
1791 epqstate->es_evTuple = (HeapTuple *)
1792 palloc(rtsize * sizeof(HeapTuple));
1793 memset(epqstate->es_evTuple, 0, rtsize * sizeof(HeapTuple));
1797 /* later stack entries share the same storage */
1798 epqstate->es_evTuple = epq->estate.es_evTuple;
1803 /* recycle previously used EState */
1804 epqstate = &(newepq->estate);
1806 /* push current PQ to the stack */
1807 epqstate->es_evalPlanQual = (Pointer) epq;
1809 estate->es_evalPlanQual = (Pointer) epq;
1814 Assert(epq->rti == rti);
1815 epqstate = &(epq->estate);
1818 * Ok - we're requested for the same RTE. Unfortunately we still have
1819 * to end and restart execution of the plan, because ExecReScan
1820 * wouldn't ensure that upper plan nodes would reset themselves. We
1821 * could make that work if insertion of the target tuple were
1822 * integrated with the Param mechanism somehow, so that the upper plan
1823 * nodes know that their children's outputs have changed.
1827 /* stop execution */
1828 ExecEndNode(epq->plan, NULL);
1829 ExecDropTupleTable(epqstate->es_tupleTable, true);
1830 epqstate->es_tupleTable = NULL;
1834 * free old RTE' tuple, if any, and store target tuple where
1835 * relation's scan node will see it
1837 if (epqstate->es_evTuple[rti - 1] != NULL)
1838 heap_freetuple(epqstate->es_evTuple[rti - 1]);
1839 epqstate->es_evTuple[rti - 1] = copyTuple;
1842 * Initialize for new recheck query; be careful to copy down state
1843 * that might have changed in top EState.
1845 epqstate->es_result_relation_info = estate->es_result_relation_info;
1846 epqstate->es_junkFilter = estate->es_junkFilter;
1847 if (estate->es_origPlan->nParamExec > 0)
1848 memset(epqstate->es_param_exec_vals, 0,
1849 estate->es_origPlan->nParamExec * sizeof(ParamExecData));
1850 memset(epqstate->es_evTupleNull, false, rtsize * sizeof(bool));
1851 epqstate->es_useEvalPlan = false;
1852 Assert(epqstate->es_tupleTable == NULL);
1853 epqstate->es_tupleTable =
1854 ExecCreateTupleTable(estate->es_tupleTable->size);
1856 ExecInitNode(epq->plan, epqstate, NULL);
1858 return EvalPlanQualNext(estate);
1861 static TupleTableSlot *
1862 EvalPlanQualNext(EState *estate)
1864 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1865 EState *epqstate = &(epq->estate);
1866 evalPlanQual *oldepq;
1867 TupleTableSlot *slot;
1869 Assert(epq->rti != 0);
1872 slot = ExecProcNode(epq->plan, NULL);
1875 * No more tuples for this PQ. Continue previous one.
1877 if (TupIsNull(slot))
1879 /* stop execution */
1880 ExecEndNode(epq->plan, NULL);
1881 ExecDropTupleTable(epqstate->es_tupleTable, true);
1882 epqstate->es_tupleTable = NULL;
1883 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1884 epqstate->es_evTuple[epq->rti - 1] = NULL;
1885 /* pop old PQ from the stack */
1886 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1887 if (oldepq == (evalPlanQual *) NULL)
1889 epq->rti = 0; /* this is the first (oldest) */
1890 estate->es_useEvalPlan = false; /* PQ - mark as free and */
1891 return (NULL); /* continue Query execution */
1893 Assert(oldepq->rti != 0);
1894 /* push current PQ to freePQ stack */
1897 epqstate = &(epq->estate);
1898 estate->es_evalPlanQual = (Pointer) epq;
1906 EndEvalPlanQual(EState *estate)
1908 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1909 EState *epqstate = &(epq->estate);
1910 evalPlanQual *oldepq;
1912 if (epq->rti == 0) /* plans already shutdowned */
1914 Assert(epq->estate.es_evalPlanQual == NULL);
1920 /* stop execution */
1921 ExecEndNode(epq->plan, NULL);
1922 ExecDropTupleTable(epqstate->es_tupleTable, true);
1923 epqstate->es_tupleTable = NULL;
1924 if (epqstate->es_evTuple[epq->rti - 1] != NULL)
1926 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1927 epqstate->es_evTuple[epq->rti - 1] = NULL;
1929 /* pop old PQ from the stack */
1930 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1931 if (oldepq == (evalPlanQual *) NULL)
1933 epq->rti = 0; /* this is the first (oldest) */
1934 estate->es_useEvalPlan = false; /* PQ - mark as free */
1937 Assert(oldepq->rti != 0);
1938 /* push current PQ to freePQ stack */
1941 epqstate = &(epq->estate);
1942 estate->es_evalPlanQual = (Pointer) epq;