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-2002, 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.185 2002/11/13 00:39:46 momjian 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 ExecSelect(TupleTableSlot *slot,
66 DestReceiver *destfunc,
68 static void ExecInsert(TupleTableSlot *slot, ItemPointer tupleid,
70 static void ExecDelete(TupleTableSlot *slot, ItemPointer tupleid,
72 static void ExecUpdate(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)
109 estate->es_param_exec_vals = (ParamExecData *)
110 palloc0(queryDesc->plantree->nParamExec * sizeof(ParamExecData));
113 * Make our own private copy of the current query snapshot data.
115 * This "freezes" our idea of which tuples are good and which are not for
116 * the life of this query, even if it outlives the current command and
119 estate->es_snapshot = CopyQuerySnapshot();
122 * Initialize the plan
124 result = InitPlan(queryDesc->operation,
125 queryDesc->parsetree,
129 queryDesc->tupDesc = result;
134 /* ----------------------------------------------------------------
137 * This is the main routine of the executor module. It accepts
138 * the query descriptor from the traffic cop and executes the
141 * ExecutorStart must have been called already.
143 * If direction is NoMovementScanDirection then nothing is done
144 * except to start up/shut down the destination. Otherwise,
145 * we retrieve up to 'count' tuples in the specified direction.
147 * Note: count = 0 is interpreted as no portal limit, e.g. run to
150 * ----------------------------------------------------------------
153 ExecutorRun(QueryDesc *queryDesc, EState *estate,
154 ScanDirection direction, long count)
159 DestReceiver *destfunc;
160 TupleTableSlot *result;
165 Assert(queryDesc != NULL);
168 * extract information from the query descriptor and the query
171 operation = queryDesc->operation;
172 plan = queryDesc->plantree;
173 dest = queryDesc->dest;
176 * startup tuple receiver
178 estate->es_processed = 0;
179 estate->es_lastoid = InvalidOid;
181 destfunc = DestToFunction(dest);
182 (*destfunc->setup) (destfunc, (int) operation,
183 queryDesc->portalName, queryDesc->tupDesc);
188 if (direction == NoMovementScanDirection)
191 result = ExecutePlan(estate,
201 (*destfunc->cleanup) (destfunc);
206 /* ----------------------------------------------------------------
209 * This routine must be called at the end of execution of any
211 * ----------------------------------------------------------------
214 ExecutorEnd(QueryDesc *queryDesc, EState *estate)
217 Assert(queryDesc != NULL);
219 EndPlan(queryDesc->plantree, estate);
221 if (estate->es_snapshot != NULL)
223 if (estate->es_snapshot->xcnt > 0)
224 pfree(estate->es_snapshot->xip);
225 pfree(estate->es_snapshot);
226 estate->es_snapshot = NULL;
229 if (estate->es_param_exec_vals != NULL)
231 pfree(estate->es_param_exec_vals);
232 estate->es_param_exec_vals = NULL;
238 * ExecCheckQueryPerms
239 * Check access permissions for all relations referenced in a query.
242 ExecCheckQueryPerms(CmdType operation, Query *parseTree, Plan *plan)
245 * Check RTEs in the query's primary rangetable.
247 ExecCheckRTPerms(parseTree->rtable, operation);
250 * Search for subplans and APPEND nodes to check their rangetables.
252 ExecCheckPlanPerms(plan, parseTree->rtable, operation);
257 * Recursively scan the plan tree to check access permissions in
261 ExecCheckPlanPerms(Plan *plan, List *rangeTable, CmdType operation)
268 /* Check subplans, which we assume are plain SELECT queries */
270 foreach(subp, plan->initPlan)
272 SubPlan *subplan = (SubPlan *) lfirst(subp);
274 ExecCheckRTPerms(subplan->rtable, CMD_SELECT);
275 ExecCheckPlanPerms(subplan->plan, subplan->rtable, CMD_SELECT);
277 foreach(subp, plan->subPlan)
279 SubPlan *subplan = (SubPlan *) lfirst(subp);
281 ExecCheckRTPerms(subplan->rtable, CMD_SELECT);
282 ExecCheckPlanPerms(subplan->plan, subplan->rtable, CMD_SELECT);
285 /* Check lower plan nodes */
287 ExecCheckPlanPerms(plan->lefttree, rangeTable, operation);
288 ExecCheckPlanPerms(plan->righttree, rangeTable, operation);
290 /* Do node-type-specific checks */
292 switch (nodeTag(plan))
296 SubqueryScan *scan = (SubqueryScan *) plan;
299 /* Recursively check the subquery */
300 rte = rt_fetch(scan->scan.scanrelid, rangeTable);
301 Assert(rte->rtekind == RTE_SUBQUERY);
302 ExecCheckQueryPerms(operation, rte->subquery, scan->subplan);
307 Append *app = (Append *) plan;
310 foreach(appendplans, app->appendplans)
312 ExecCheckPlanPerms((Plan *) lfirst(appendplans),
326 * Check access permissions for all relations listed in a range table.
329 ExecCheckRTPerms(List *rangeTable, CmdType operation)
333 foreach(lp, rangeTable)
335 RangeTblEntry *rte = lfirst(lp);
337 ExecCheckRTEPerms(rte, operation);
343 * Check access permissions for a single RTE.
346 ExecCheckRTEPerms(RangeTblEntry *rte, CmdType operation)
350 AclResult aclcheck_result;
353 * Only plain-relation RTEs need to be checked here. Subquery RTEs
354 * will be checked when ExecCheckPlanPerms finds the SubqueryScan
355 * node, and function RTEs are checked by init_fcache when the
356 * function is prepared for execution. Join and special RTEs need no
359 if (rte->rtekind != RTE_RELATION)
365 * userid to check as: current user unless we have a setuid
368 * Note: GetUserId() is presently fast enough that there's no harm in
369 * calling it separately for each RTE. If that stops being true, we
370 * could call it once in ExecCheckQueryPerms and pass the userid down
371 * from there. But for now, no need for the extra clutter.
373 userid = rte->checkAsUser ? rte->checkAsUser : GetUserId();
375 #define CHECK(MODE) pg_class_aclcheck(relOid, userid, MODE)
377 if (rte->checkForRead)
379 aclcheck_result = CHECK(ACL_SELECT);
380 if (aclcheck_result != ACLCHECK_OK)
381 aclcheck_error(aclcheck_result, get_rel_name(relOid));
384 if (rte->checkForWrite)
387 * Note: write access in a SELECT context means SELECT FOR UPDATE.
388 * Right now we don't distinguish that from true update as far as
389 * permissions checks are concerned.
394 aclcheck_result = CHECK(ACL_INSERT);
398 aclcheck_result = CHECK(ACL_UPDATE);
401 aclcheck_result = CHECK(ACL_DELETE);
404 elog(ERROR, "ExecCheckRTEPerms: bogus operation %d",
406 aclcheck_result = ACLCHECK_OK; /* keep compiler quiet */
409 if (aclcheck_result != ACLCHECK_OK)
410 aclcheck_error(aclcheck_result, get_rel_name(relOid));
415 /* ===============================================================
416 * ===============================================================
417 static routines follow
418 * ===============================================================
419 * ===============================================================
422 typedef struct execRowMark
429 typedef struct evalPlanQual
434 struct evalPlanQual *free;
437 /* ----------------------------------------------------------------
440 * Initializes the query plan: open files, allocate storage
441 * and start up the rule manager
442 * ----------------------------------------------------------------
445 InitPlan(CmdType operation, Query *parseTree, Plan *plan, EState *estate)
448 Relation intoRelationDesc;
452 * Do permissions checks.
454 ExecCheckQueryPerms(operation, parseTree, plan);
457 * get information from query descriptor
459 rangeTable = parseTree->rtable;
462 * initialize the node's execution state
464 estate->es_range_table = rangeTable;
467 * if there is a result relation, initialize result relation stuff
469 if (parseTree->resultRelation != 0 && operation != CMD_SELECT)
471 List *resultRelations = parseTree->resultRelations;
472 int numResultRelations;
473 ResultRelInfo *resultRelInfos;
475 if (resultRelations != NIL)
478 * Multiple result relations (due to inheritance)
479 * parseTree->resultRelations identifies them all
481 ResultRelInfo *resultRelInfo;
483 numResultRelations = length(resultRelations);
484 resultRelInfos = (ResultRelInfo *)
485 palloc(numResultRelations * sizeof(ResultRelInfo));
486 resultRelInfo = resultRelInfos;
487 while (resultRelations != NIL)
489 initResultRelInfo(resultRelInfo,
490 lfirsti(resultRelations),
494 resultRelations = lnext(resultRelations);
500 * Single result relation identified by
501 * parseTree->resultRelation
503 numResultRelations = 1;
504 resultRelInfos = (ResultRelInfo *) palloc(sizeof(ResultRelInfo));
505 initResultRelInfo(resultRelInfos,
506 parseTree->resultRelation,
511 estate->es_result_relations = resultRelInfos;
512 estate->es_num_result_relations = numResultRelations;
513 /* Initialize to first or only result rel */
514 estate->es_result_relation_info = resultRelInfos;
519 * if no result relation, then set state appropriately
521 estate->es_result_relations = NULL;
522 estate->es_num_result_relations = 0;
523 estate->es_result_relation_info = NULL;
527 * Have to lock relations selected for update
529 estate->es_rowMark = NIL;
530 if (parseTree->rowMarks != NIL)
534 foreach(l, parseTree->rowMarks)
536 Index rti = lfirsti(l);
537 Oid relid = getrelid(rti, rangeTable);
541 relation = heap_open(relid, RowShareLock);
542 erm = (execRowMark *) palloc(sizeof(execRowMark));
543 erm->relation = relation;
545 snprintf(erm->resname, 32, "ctid%u", rti);
546 estate->es_rowMark = lappend(estate->es_rowMark, erm);
551 * initialize the executor "tuple" table. We need slots for all the
552 * plan nodes, plus possibly output slots for the junkfilter(s). At
553 * this point we aren't sure if we need junkfilters, so just add slots
554 * for them unconditionally.
557 int nSlots = ExecCountSlotsNode(plan);
559 if (parseTree->resultRelations != NIL)
560 nSlots += length(parseTree->resultRelations);
563 estate->es_tupleTable = ExecCreateTupleTable(nSlots);
566 /* mark EvalPlanQual not active */
567 estate->es_origPlan = plan;
568 estate->es_evalPlanQual = NULL;
569 estate->es_evTuple = NULL;
570 estate->es_evTupleNull = NULL;
571 estate->es_useEvalPlan = false;
574 * initialize the private state information for all the nodes in the
575 * query tree. This opens files, allocates storage and leaves us
576 * ready to start processing tuples.
578 ExecInitNode(plan, estate, NULL);
581 * Get the tuple descriptor describing the type of tuples to return.
582 * (this is especially important if we are creating a relation with
585 tupType = ExecGetTupType(plan); /* tuple descriptor */
588 * Initialize the junk filter if needed. SELECT and INSERT queries
589 * need a filter if there are any junk attrs in the tlist. UPDATE and
590 * DELETE always need one, since there's always a junk 'ctid'
591 * attribute present --- no need to look first.
594 bool junk_filter_needed = false;
601 foreach(tlist, plan->targetlist)
603 TargetEntry *tle = (TargetEntry *) lfirst(tlist);
605 if (tle->resdom->resjunk)
607 junk_filter_needed = true;
614 junk_filter_needed = true;
620 if (junk_filter_needed)
623 * If there are multiple result relations, each one needs its
624 * own junk filter. Note this is only possible for
625 * UPDATE/DELETE, so we can't be fooled by some needing a
626 * filter and some not.
628 if (parseTree->resultRelations != NIL)
631 ResultRelInfo *resultRelInfo;
633 /* Top plan had better be an Append here. */
634 Assert(IsA(plan, Append));
635 Assert(((Append *) plan)->isTarget);
636 subplans = ((Append *) plan)->appendplans;
637 Assert(length(subplans) == estate->es_num_result_relations);
638 resultRelInfo = estate->es_result_relations;
639 while (subplans != NIL)
641 Plan *subplan = (Plan *) lfirst(subplans);
644 j = ExecInitJunkFilter(subplan->targetlist,
645 ExecGetTupType(subplan),
646 ExecAllocTableSlot(estate->es_tupleTable));
647 resultRelInfo->ri_junkFilter = j;
649 subplans = lnext(subplans);
653 * Set active junkfilter too; at this point ExecInitAppend
654 * has already selected an active result relation...
656 estate->es_junkFilter =
657 estate->es_result_relation_info->ri_junkFilter;
661 /* Normal case with just one JunkFilter */
664 j = ExecInitJunkFilter(plan->targetlist,
666 ExecAllocTableSlot(estate->es_tupleTable));
667 estate->es_junkFilter = j;
668 if (estate->es_result_relation_info)
669 estate->es_result_relation_info->ri_junkFilter = j;
671 /* For SELECT, want to return the cleaned tuple type */
672 if (operation == CMD_SELECT)
673 tupType = j->jf_cleanTupType;
677 estate->es_junkFilter = NULL;
681 * initialize the "into" relation
683 intoRelationDesc = (Relation) NULL;
685 if (operation == CMD_SELECT)
687 if (!parseTree->isPortal)
690 * a select into table --- need to create the "into" table
692 if (parseTree->into != NULL)
701 * find namespace to create in, check permissions
703 intoName = parseTree->into->relname;
704 namespaceId = RangeVarGetCreationNamespace(parseTree->into);
706 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
708 if (aclresult != ACLCHECK_OK)
709 aclcheck_error(aclresult,
710 get_namespace_name(namespaceId));
713 * have to copy tupType to get rid of constraints
715 tupdesc = CreateTupleDescCopy(tupType);
718 * Formerly we forced the output table to have OIDs, but
719 * as of 7.3 it will not have OIDs, because it's too late
720 * here to change the tupdescs of the already-initialized
721 * plan tree. (Perhaps we could recurse and change them
722 * all, but it's not really worth the trouble IMHO...)
726 heap_create_with_catalog(intoName,
732 allowSystemTableMods);
734 FreeTupleDesc(tupdesc);
737 * Advance command counter so that the newly-created
738 * relation's catalog tuples will be visible to heap_open.
740 CommandCounterIncrement();
743 * If necessary, create a TOAST table for the into
744 * relation. Note that AlterTableCreateToastTable ends
745 * with CommandCounterIncrement(), so that the TOAST table
746 * will be visible for insertion.
748 AlterTableCreateToastTable(intoRelationId, true);
750 intoRelationDesc = heap_open(intoRelationId,
751 AccessExclusiveLock);
756 estate->es_into_relation_descriptor = intoRelationDesc;
762 * Initialize ResultRelInfo data for one result relation
765 initResultRelInfo(ResultRelInfo *resultRelInfo,
766 Index resultRelationIndex,
770 Oid resultRelationOid;
771 Relation resultRelationDesc;
773 resultRelationOid = getrelid(resultRelationIndex, rangeTable);
774 resultRelationDesc = heap_open(resultRelationOid, RowExclusiveLock);
776 switch (resultRelationDesc->rd_rel->relkind)
778 case RELKIND_SEQUENCE:
779 elog(ERROR, "You can't change sequence relation %s",
780 RelationGetRelationName(resultRelationDesc));
782 case RELKIND_TOASTVALUE:
783 elog(ERROR, "You can't change toast relation %s",
784 RelationGetRelationName(resultRelationDesc));
787 elog(ERROR, "You can't change view relation %s",
788 RelationGetRelationName(resultRelationDesc));
792 MemSet(resultRelInfo, 0, sizeof(ResultRelInfo));
793 resultRelInfo->type = T_ResultRelInfo;
794 resultRelInfo->ri_RangeTableIndex = resultRelationIndex;
795 resultRelInfo->ri_RelationDesc = resultRelationDesc;
796 resultRelInfo->ri_NumIndices = 0;
797 resultRelInfo->ri_IndexRelationDescs = NULL;
798 resultRelInfo->ri_IndexRelationInfo = NULL;
799 /* make a copy so as not to depend on relcache info not changing... */
800 resultRelInfo->ri_TrigDesc = CopyTriggerDesc(resultRelationDesc->trigdesc);
801 resultRelInfo->ri_TrigFunctions = NULL;
802 resultRelInfo->ri_ConstraintExprs = NULL;
803 resultRelInfo->ri_junkFilter = NULL;
806 * If there are indices on the result relation, open them and save
807 * descriptors in the result relation info, so that we can add new
808 * index entries for the tuples we add/update. We need not do this
809 * for a DELETE, however, since deletion doesn't affect indexes.
811 if (resultRelationDesc->rd_rel->relhasindex &&
812 operation != CMD_DELETE)
813 ExecOpenIndices(resultRelInfo);
816 /* ----------------------------------------------------------------
819 * Cleans up the query plan -- closes files and free up storages
820 * ----------------------------------------------------------------
823 EndPlan(Plan *plan, EState *estate)
825 ResultRelInfo *resultRelInfo;
830 * shut down any PlanQual processing we were doing
832 if (estate->es_evalPlanQual != NULL)
833 EndEvalPlanQual(estate);
836 * shut down the node-type-specific query processing
838 ExecEndNode(plan, NULL);
841 * destroy the executor "tuple" table.
843 ExecDropTupleTable(estate->es_tupleTable, true);
844 estate->es_tupleTable = NULL;
847 * close the result relation(s) if any, but hold locks until xact
848 * commit. Also clean up junkfilters if present.
850 resultRelInfo = estate->es_result_relations;
851 for (i = estate->es_num_result_relations; i > 0; i--)
853 /* Close indices and then the relation itself */
854 ExecCloseIndices(resultRelInfo);
855 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
856 /* Delete the junkfilter if any */
857 if (resultRelInfo->ri_junkFilter != NULL)
858 ExecFreeJunkFilter(resultRelInfo->ri_junkFilter);
863 * close the "into" relation if necessary, again keeping lock
865 if (estate->es_into_relation_descriptor != NULL)
866 heap_close(estate->es_into_relation_descriptor, NoLock);
869 * There might be a junkfilter without a result relation.
871 if (estate->es_num_result_relations == 0 &&
872 estate->es_junkFilter != NULL)
874 ExecFreeJunkFilter(estate->es_junkFilter);
875 estate->es_junkFilter = NULL;
879 * close any relations selected FOR UPDATE, again keeping locks
881 foreach(l, estate->es_rowMark)
883 execRowMark *erm = lfirst(l);
885 heap_close(erm->relation, NoLock);
889 /* ----------------------------------------------------------------
892 * processes the query plan to retrieve 'numberTuples' tuples in the
893 * direction specified.
894 * Retrieves all tuples if numberTuples is 0
896 * result is either a slot containing the last tuple in the case
897 * of a SELECT or NULL otherwise.
899 * Note: the ctid attribute is a 'junk' attribute that is removed before the
901 * ----------------------------------------------------------------
903 static TupleTableSlot *
904 ExecutePlan(EState *estate,
908 ScanDirection direction,
909 DestReceiver *destfunc)
911 JunkFilter *junkfilter;
912 TupleTableSlot *slot;
913 ItemPointer tupleid = NULL;
914 ItemPointerData tuple_ctid;
915 long current_tuple_count;
916 TupleTableSlot *result;
919 * initialize local variables
922 current_tuple_count = 0;
928 estate->es_direction = direction;
931 * Loop until we've processed the proper number of tuples from the
937 /* Reset the per-output-tuple exprcontext */
938 ResetPerTupleExprContext(estate);
941 * Execute the plan and obtain a tuple
944 if (estate->es_useEvalPlan)
946 slot = EvalPlanQualNext(estate);
948 slot = ExecProcNode(plan, NULL);
951 slot = ExecProcNode(plan, NULL);
954 * if the tuple is null, then we assume there is nothing more to
955 * process so we just return null...
964 * if we have a junk filter, then project a new tuple with the
967 * Store this new "clean" tuple in the junkfilter's resultSlot.
968 * (Formerly, we stored it back over the "dirty" tuple, which is
969 * WRONG because that tuple slot has the wrong descriptor.)
971 * Also, extract all the junk information we need.
973 if ((junkfilter = estate->es_junkFilter) != (JunkFilter *) NULL)
980 * extract the 'ctid' junk attribute.
982 if (operation == CMD_UPDATE || operation == CMD_DELETE)
984 if (!ExecGetJunkAttribute(junkfilter,
989 elog(ERROR, "ExecutePlan: NO (junk) `ctid' was found!");
991 /* shouldn't ever get a null result... */
993 elog(ERROR, "ExecutePlan: (junk) `ctid' is NULL!");
995 tupleid = (ItemPointer) DatumGetPointer(datum);
996 tuple_ctid = *tupleid; /* make sure we don't free the
998 tupleid = &tuple_ctid;
1000 else if (estate->es_rowMark != NIL)
1005 foreach(l, estate->es_rowMark)
1007 execRowMark *erm = lfirst(l);
1009 HeapTupleData tuple;
1010 TupleTableSlot *newSlot;
1013 if (!ExecGetJunkAttribute(junkfilter,
1018 elog(ERROR, "ExecutePlan: NO (junk) `%s' was found!",
1021 /* shouldn't ever get a null result... */
1023 elog(ERROR, "ExecutePlan: (junk) `%s' is NULL!",
1026 tuple.t_self = *((ItemPointer) DatumGetPointer(datum));
1027 test = heap_mark4update(erm->relation, &tuple, &buffer,
1028 estate->es_snapshot->curcid);
1029 ReleaseBuffer(buffer);
1032 case HeapTupleSelfUpdated:
1033 /* treat it as deleted; do not process */
1036 case HeapTupleMayBeUpdated:
1039 case HeapTupleUpdated:
1040 if (XactIsoLevel == XACT_SERIALIZABLE)
1041 elog(ERROR, "Can't serialize access due to concurrent update");
1042 if (!(ItemPointerEquals(&(tuple.t_self),
1043 (ItemPointer) DatumGetPointer(datum))))
1045 newSlot = EvalPlanQual(estate, erm->rti, &(tuple.t_self));
1046 if (!(TupIsNull(newSlot)))
1049 estate->es_useEvalPlan = true;
1055 * if tuple was deleted or PlanQual failed for
1056 * updated tuple - we must not return this
1062 elog(ERROR, "Unknown status %u from heap_mark4update", test);
1069 * Finally create a new "clean" tuple with all junk attributes
1072 newTuple = ExecRemoveJunk(junkfilter, slot);
1074 slot = ExecStoreTuple(newTuple, /* tuple to store */
1075 junkfilter->jf_resultSlot, /* dest slot */
1076 InvalidBuffer, /* this tuple has no
1078 true); /* tuple should be pfreed */
1082 * now that we have a tuple, do the appropriate thing with it..
1083 * either return it to the user, add it to a relation someplace,
1084 * delete it from a relation, or modify some of its attributes.
1089 ExecSelect(slot, /* slot containing tuple */
1090 destfunc, /* destination's tuple-receiver
1097 ExecInsert(slot, tupleid, estate);
1102 ExecDelete(slot, tupleid, estate);
1107 ExecUpdate(slot, tupleid, estate);
1112 elog(LOG, "ExecutePlan: unknown operation in queryDesc");
1118 * check our tuple count.. if we've processed the proper number
1119 * then quit, else loop again and process more tuples..
1121 current_tuple_count++;
1122 if (numberTuples == current_tuple_count)
1127 * here, result is either a slot containing a tuple in the case of a
1128 * SELECT or NULL otherwise.
1133 /* ----------------------------------------------------------------
1136 * SELECTs are easy.. we just pass the tuple to the appropriate
1137 * print function. The only complexity is when we do a
1138 * "SELECT INTO", in which case we insert the tuple into
1139 * the appropriate relation (note: this is a newly created relation
1140 * so we don't need to worry about indices or locks.)
1141 * ----------------------------------------------------------------
1144 ExecSelect(TupleTableSlot *slot,
1145 DestReceiver *destfunc,
1152 * get the heap tuple out of the tuple table slot
1155 attrtype = slot->ttc_tupleDescriptor;
1158 * insert the tuple into the "into relation"
1160 if (estate->es_into_relation_descriptor != NULL)
1162 heap_insert(estate->es_into_relation_descriptor, tuple,
1163 estate->es_snapshot->curcid);
1168 * send the tuple to the front end (or the screen)
1170 (*destfunc->receiveTuple) (tuple, attrtype, destfunc);
1172 (estate->es_processed)++;
1175 /* ----------------------------------------------------------------
1178 * INSERTs are trickier.. we have to insert the tuple into
1179 * the base relation and insert appropriate tuples into the
1181 * ----------------------------------------------------------------
1184 ExecInsert(TupleTableSlot *slot,
1185 ItemPointer tupleid,
1189 ResultRelInfo *resultRelInfo;
1190 Relation resultRelationDesc;
1195 * get the heap tuple out of the tuple table slot
1200 * get information on the (current) result relation
1202 resultRelInfo = estate->es_result_relation_info;
1203 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1205 /* BEFORE ROW INSERT Triggers */
1206 if (resultRelInfo->ri_TrigDesc &&
1207 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_INSERT] > 0)
1211 newtuple = ExecBRInsertTriggers(estate, resultRelInfo, tuple);
1213 if (newtuple == NULL) /* "do nothing" */
1216 if (newtuple != tuple) /* modified by Trigger(s) */
1219 * Insert modified tuple into tuple table slot, replacing the
1220 * original. We assume that it was allocated in per-tuple
1221 * memory context, and therefore will go away by itself. The
1222 * tuple table slot should not try to clear it.
1224 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1230 * Check the constraints of the tuple
1232 if (resultRelationDesc->rd_att->constr)
1233 ExecConstraints("ExecInsert", resultRelInfo, slot, estate);
1238 newId = heap_insert(resultRelationDesc, tuple,
1239 estate->es_snapshot->curcid);
1242 (estate->es_processed)++;
1243 estate->es_lastoid = newId;
1244 setLastTid(&(tuple->t_self));
1249 * Note: heap_insert adds a new tuple to a relation. As a side effect,
1250 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1253 numIndices = resultRelInfo->ri_NumIndices;
1255 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1257 /* AFTER ROW INSERT Triggers */
1258 if (resultRelInfo->ri_TrigDesc)
1259 ExecARInsertTriggers(estate, resultRelInfo, tuple);
1262 /* ----------------------------------------------------------------
1265 * DELETE is like UPDATE, we delete the tuple and its
1267 * ----------------------------------------------------------------
1270 ExecDelete(TupleTableSlot *slot,
1271 ItemPointer tupleid,
1274 ResultRelInfo *resultRelInfo;
1275 Relation resultRelationDesc;
1276 ItemPointerData ctid;
1280 * get information on the (current) result relation
1282 resultRelInfo = estate->es_result_relation_info;
1283 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1285 /* BEFORE ROW DELETE Triggers */
1286 if (resultRelInfo->ri_TrigDesc &&
1287 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_DELETE] > 0)
1291 dodelete = ExecBRDeleteTriggers(estate, resultRelInfo, tupleid);
1293 if (!dodelete) /* "do nothing" */
1301 result = heap_delete(resultRelationDesc, tupleid,
1303 estate->es_snapshot->curcid);
1306 case HeapTupleSelfUpdated:
1307 /* already deleted by self; nothing to do */
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 UPDATE queries with transactions
1356 * off because UPDATEs are actually INSERTs and our
1357 * scan will mistakenly loop forever, updating the tuple
1358 * it just inserted.. 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 ExecUpdate(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, "ExecUpdate: UPDATE 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("ExecUpdate", resultRelInfo, slot, estate);
1434 * replace the heap tuple
1436 result = heap_update(resultRelationDesc, tupleid, tuple,
1438 estate->es_snapshot->curcid);
1441 case HeapTupleSelfUpdated:
1442 /* already deleted by self; nothing to do */
1445 case HeapTupleMayBeUpdated:
1448 case HeapTupleUpdated:
1449 if (XactIsoLevel == XACT_SERIALIZABLE)
1450 elog(ERROR, "Can't serialize access due to concurrent update");
1451 else if (!(ItemPointerEquals(tupleid, &ctid)))
1453 TupleTableSlot *epqslot = EvalPlanQual(estate,
1454 resultRelInfo->ri_RangeTableIndex, &ctid);
1456 if (!TupIsNull(epqslot))
1459 tuple = ExecRemoveJunk(estate->es_junkFilter, epqslot);
1460 slot = ExecStoreTuple(tuple,
1461 estate->es_junkFilter->jf_resultSlot,
1462 InvalidBuffer, true);
1466 /* tuple already deleted; nothing to do */
1470 elog(ERROR, "Unknown status %u from heap_update", result);
1475 (estate->es_processed)++;
1478 * Note: instead of having to update the old index tuples associated
1479 * with the heap tuple, all we do is form and insert new index tuples.
1480 * This is because UPDATEs are actually DELETEs and INSERTs and index
1481 * tuple deletion is done automagically by the vacuum daemon. All we
1482 * do is insert new index tuples. -cim 9/27/89
1488 * heap_update updates a tuple in the base relation by invalidating it
1489 * and then inserting a new tuple to the relation. As a side effect,
1490 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1491 * field. So we now insert index tuples using the new tupleid stored
1495 numIndices = resultRelInfo->ri_NumIndices;
1497 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1499 /* AFTER ROW UPDATE Triggers */
1500 if (resultRelInfo->ri_TrigDesc)
1501 ExecARUpdateTriggers(estate, resultRelInfo, tupleid, tuple);
1505 ExecRelCheck(ResultRelInfo *resultRelInfo,
1506 TupleTableSlot *slot, EState *estate)
1508 Relation rel = resultRelInfo->ri_RelationDesc;
1509 int ncheck = rel->rd_att->constr->num_check;
1510 ConstrCheck *check = rel->rd_att->constr->check;
1511 ExprContext *econtext;
1512 MemoryContext oldContext;
1517 * If first time through for this result relation, build expression
1518 * nodetrees for rel's constraint expressions. Keep them in the
1519 * per-query memory context so they'll survive throughout the query.
1521 if (resultRelInfo->ri_ConstraintExprs == NULL)
1523 oldContext = MemoryContextSwitchTo(estate->es_query_cxt);
1524 resultRelInfo->ri_ConstraintExprs =
1525 (List **) palloc(ncheck * sizeof(List *));
1526 for (i = 0; i < ncheck; i++)
1528 qual = (List *) stringToNode(check[i].ccbin);
1529 resultRelInfo->ri_ConstraintExprs[i] = qual;
1531 MemoryContextSwitchTo(oldContext);
1535 * We will use the EState's per-tuple context for evaluating
1536 * constraint expressions (creating it if it's not already there).
1538 econtext = GetPerTupleExprContext(estate);
1540 /* Arrange for econtext's scan tuple to be the tuple under test */
1541 econtext->ecxt_scantuple = slot;
1543 /* And evaluate the constraints */
1544 for (i = 0; i < ncheck; i++)
1546 qual = resultRelInfo->ri_ConstraintExprs[i];
1549 * NOTE: SQL92 specifies that a NULL result from a constraint
1550 * expression is not to be treated as a failure. Therefore, tell
1551 * ExecQual to return TRUE for NULL.
1553 if (!ExecQual(qual, econtext, true))
1554 return check[i].ccname;
1557 /* NULL result means no error */
1558 return (char *) NULL;
1562 ExecConstraints(const char *caller, ResultRelInfo *resultRelInfo,
1563 TupleTableSlot *slot, EState *estate)
1565 Relation rel = resultRelInfo->ri_RelationDesc;
1566 HeapTuple tuple = slot->val;
1567 TupleConstr *constr = rel->rd_att->constr;
1571 if (constr->has_not_null)
1573 int natts = rel->rd_att->natts;
1576 for (attrChk = 1; attrChk <= natts; attrChk++)
1578 if (rel->rd_att->attrs[attrChk - 1]->attnotnull &&
1579 heap_attisnull(tuple, attrChk))
1580 elog(ERROR, "%s: Fail to add null value in not null attribute %s",
1581 caller, NameStr(rel->rd_att->attrs[attrChk - 1]->attname));
1585 if (constr->num_check > 0)
1589 if ((failed = ExecRelCheck(resultRelInfo, slot, estate)) != NULL)
1590 elog(ERROR, "%s: rejected due to CHECK constraint \"%s\" on \"%s\"",
1591 caller, failed, RelationGetRelationName(rel));
1596 * Check a modified tuple to see if we want to process its updated version
1597 * under READ COMMITTED rules.
1599 * See backend/executor/README for some info about how this works.
1602 EvalPlanQual(EState *estate, Index rti, ItemPointer tid)
1607 HeapTupleData tuple;
1608 HeapTuple copyTuple = NULL;
1615 * find relation containing target tuple
1617 if (estate->es_result_relation_info != NULL &&
1618 estate->es_result_relation_info->ri_RangeTableIndex == rti)
1619 relation = estate->es_result_relation_info->ri_RelationDesc;
1625 foreach(l, estate->es_rowMark)
1627 if (((execRowMark *) lfirst(l))->rti == rti)
1629 relation = ((execRowMark *) lfirst(l))->relation;
1633 if (relation == NULL)
1634 elog(ERROR, "EvalPlanQual: can't find RTE %d", (int) rti);
1640 * Loop here to deal with updated or busy tuples
1642 tuple.t_self = *tid;
1647 if (heap_fetch(relation, SnapshotDirty, &tuple, &buffer, false, NULL))
1649 TransactionId xwait = SnapshotDirty->xmax;
1651 if (TransactionIdIsValid(SnapshotDirty->xmin))
1652 elog(ERROR, "EvalPlanQual: t_xmin is uncommitted ?!");
1655 * If tuple is being updated by other transaction then we have
1656 * to wait for its commit/abort.
1658 if (TransactionIdIsValid(xwait))
1660 ReleaseBuffer(buffer);
1661 XactLockTableWait(xwait);
1666 * We got tuple - now copy it for use by recheck query.
1668 copyTuple = heap_copytuple(&tuple);
1669 ReleaseBuffer(buffer);
1674 * Oops! Invalid tuple. Have to check is it updated or deleted.
1675 * Note that it's possible to get invalid SnapshotDirty->tid if
1676 * tuple updated by this transaction. Have we to check this ?
1678 if (ItemPointerIsValid(&(SnapshotDirty->tid)) &&
1679 !(ItemPointerEquals(&(tuple.t_self), &(SnapshotDirty->tid))))
1681 /* updated, so look at the updated copy */
1682 tuple.t_self = SnapshotDirty->tid;
1687 * Deleted or updated by this transaction; forget it.
1693 * For UPDATE/DELETE we have to return tid of actual row we're
1696 *tid = tuple.t_self;
1699 * Need to run a recheck subquery. Find or create a PQ stack entry.
1701 epq = (evalPlanQual *) estate->es_evalPlanQual;
1702 rtsize = length(estate->es_range_table);
1705 if (epq != NULL && epq->rti == 0)
1707 /* Top PQ stack entry is idle, so re-use it */
1708 Assert(!(estate->es_useEvalPlan) &&
1709 epq->estate.es_evalPlanQual == NULL);
1715 * If this is request for another RTE - Ra, - then we have to check
1716 * wasn't PlanQual requested for Ra already and if so then Ra' row was
1717 * updated again and we have to re-start old execution for Ra and
1718 * forget all what we done after Ra was suspended. Cool? -:))
1720 if (epq != NULL && epq->rti != rti &&
1721 epq->estate.es_evTuple[rti - 1] != NULL)
1725 evalPlanQual *oldepq;
1727 /* pop previous PlanQual from the stack */
1728 epqstate = &(epq->estate);
1729 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1730 Assert(oldepq->rti != 0);
1731 /* stop execution */
1732 ExecEndNode(epq->plan, NULL);
1733 ExecDropTupleTable(epqstate->es_tupleTable, true);
1734 epqstate->es_tupleTable = NULL;
1735 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1736 epqstate->es_evTuple[epq->rti - 1] = NULL;
1737 /* push current PQ to freePQ stack */
1740 estate->es_evalPlanQual = (Pointer) epq;
1741 } while (epq->rti != rti);
1745 * If we are requested for another RTE then we have to suspend
1746 * execution of current PlanQual and start execution for new one.
1748 if (epq == NULL || epq->rti != rti)
1750 /* try to reuse plan used previously */
1751 evalPlanQual *newepq = (epq != NULL) ? epq->free : NULL;
1753 if (newepq == NULL) /* first call or freePQ stack is empty */
1755 newepq = (evalPlanQual *) palloc(sizeof(evalPlanQual));
1756 newepq->free = NULL;
1759 * Each stack level has its own copy of the plan tree. This
1760 * is wasteful, but necessary as long as plan nodes point to
1761 * exec state nodes rather than vice versa. Note that
1762 * copyfuncs.c doesn't attempt to copy the exec state nodes,
1763 * which is a good thing in this situation.
1765 newepq->plan = copyObject(estate->es_origPlan);
1768 * Init stack level's EState. We share top level's copy of
1769 * es_result_relations array and other non-changing status. We
1770 * need our own tupletable, es_param_exec_vals, and other
1773 epqstate = &(newepq->estate);
1774 memcpy(epqstate, estate, sizeof(EState));
1775 epqstate->es_direction = ForwardScanDirection;
1776 if (estate->es_origPlan->nParamExec > 0)
1777 epqstate->es_param_exec_vals = (ParamExecData *)
1778 palloc(estate->es_origPlan->nParamExec *
1779 sizeof(ParamExecData));
1780 epqstate->es_tupleTable = NULL;
1781 epqstate->es_per_tuple_exprcontext = NULL;
1784 * Each epqstate must have its own es_evTupleNull state, but
1785 * all the stack entries share es_evTuple state. This allows
1786 * sub-rechecks to inherit the value being examined by an
1789 epqstate->es_evTupleNull = (bool *) palloc(rtsize * sizeof(bool));
1791 /* first PQ stack entry */
1792 epqstate->es_evTuple = (HeapTuple *)
1793 palloc0(rtsize * sizeof(HeapTuple));
1795 /* later stack entries share the same storage */
1796 epqstate->es_evTuple = epq->estate.es_evTuple;
1800 /* recycle previously used EState */
1801 epqstate = &(newepq->estate);
1803 /* push current PQ to the stack */
1804 epqstate->es_evalPlanQual = (Pointer) epq;
1806 estate->es_evalPlanQual = (Pointer) epq;
1811 Assert(epq->rti == rti);
1812 epqstate = &(epq->estate);
1815 * Ok - we're requested for the same RTE. Unfortunately we still have
1816 * to end and restart execution of the plan, because ExecReScan
1817 * wouldn't ensure that upper plan nodes would reset themselves. We
1818 * could make that work if insertion of the target tuple were
1819 * integrated with the Param mechanism somehow, so that the upper plan
1820 * nodes know that their children's outputs have changed.
1824 /* stop execution */
1825 ExecEndNode(epq->plan, NULL);
1826 ExecDropTupleTable(epqstate->es_tupleTable, true);
1827 epqstate->es_tupleTable = NULL;
1831 * free old RTE' tuple, if any, and store target tuple where
1832 * relation's scan node will see it
1834 if (epqstate->es_evTuple[rti - 1] != NULL)
1835 heap_freetuple(epqstate->es_evTuple[rti - 1]);
1836 epqstate->es_evTuple[rti - 1] = copyTuple;
1839 * Initialize for new recheck query; be careful to copy down state
1840 * that might have changed in top EState.
1842 epqstate->es_result_relation_info = estate->es_result_relation_info;
1843 epqstate->es_junkFilter = estate->es_junkFilter;
1844 if (estate->es_origPlan->nParamExec > 0)
1845 memset(epqstate->es_param_exec_vals, 0,
1846 estate->es_origPlan->nParamExec * sizeof(ParamExecData));
1847 memset(epqstate->es_evTupleNull, false, rtsize * sizeof(bool));
1848 epqstate->es_useEvalPlan = false;
1849 Assert(epqstate->es_tupleTable == NULL);
1850 epqstate->es_tupleTable =
1851 ExecCreateTupleTable(estate->es_tupleTable->size);
1853 ExecInitNode(epq->plan, epqstate, NULL);
1855 return EvalPlanQualNext(estate);
1858 static TupleTableSlot *
1859 EvalPlanQualNext(EState *estate)
1861 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1862 EState *epqstate = &(epq->estate);
1863 evalPlanQual *oldepq;
1864 TupleTableSlot *slot;
1866 Assert(epq->rti != 0);
1869 slot = ExecProcNode(epq->plan, NULL);
1872 * No more tuples for this PQ. Continue previous one.
1874 if (TupIsNull(slot))
1876 /* stop execution */
1877 ExecEndNode(epq->plan, NULL);
1878 ExecDropTupleTable(epqstate->es_tupleTable, true);
1879 epqstate->es_tupleTable = NULL;
1880 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1881 epqstate->es_evTuple[epq->rti - 1] = NULL;
1882 /* pop old PQ from the stack */
1883 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1884 if (oldepq == (evalPlanQual *) NULL)
1886 epq->rti = 0; /* this is the first (oldest) */
1887 estate->es_useEvalPlan = false; /* PQ - mark as free and */
1888 return (NULL); /* continue Query execution */
1890 Assert(oldepq->rti != 0);
1891 /* push current PQ to freePQ stack */
1894 epqstate = &(epq->estate);
1895 estate->es_evalPlanQual = (Pointer) epq;
1903 EndEvalPlanQual(EState *estate)
1905 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1906 EState *epqstate = &(epq->estate);
1907 evalPlanQual *oldepq;
1909 if (epq->rti == 0) /* plans already shutdowned */
1911 Assert(epq->estate.es_evalPlanQual == NULL);
1917 /* stop execution */
1918 ExecEndNode(epq->plan, NULL);
1919 ExecDropTupleTable(epqstate->es_tupleTable, true);
1920 epqstate->es_tupleTable = NULL;
1921 if (epqstate->es_evTuple[epq->rti - 1] != NULL)
1923 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1924 epqstate->es_evTuple[epq->rti - 1] = NULL;
1926 /* pop old PQ from the stack */
1927 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1928 if (oldepq == (evalPlanQual *) NULL)
1930 epq->rti = 0; /* this is the first (oldest) */
1931 estate->es_useEvalPlan = false; /* PQ - mark as free */
1934 Assert(oldepq->rti != 0);
1935 /* push current PQ to freePQ stack */
1938 epqstate = &(epq->estate);
1939 estate->es_evalPlanQual = (Pointer) epq;