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.160 2002/04/27 21:24:34 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->subquery != NULL);
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 * If it's a subquery RTE, ignore it --- it will be checked when
367 * ExecCheckPlanPerms finds the SubqueryScan node for it.
369 if (rte->rtekind != RTE_RELATION)
375 * userid to check as: current user unless we have a setuid
378 * Note: GetUserId() is presently fast enough that there's no harm in
379 * calling it separately for each RTE. If that stops being true, we
380 * could call it once in ExecCheckQueryPerms and pass the userid down
381 * from there. But for now, no need for the extra clutter.
383 userid = rte->checkAsUser ? rte->checkAsUser : GetUserId();
385 #define CHECK(MODE) pg_class_aclcheck(relOid, userid, MODE)
387 if (rte->checkForRead)
389 aclcheck_result = CHECK(ACL_SELECT);
390 if (aclcheck_result != ACLCHECK_OK)
391 aclcheck_error(aclcheck_result, get_rel_name(relOid));
394 if (rte->checkForWrite)
397 * Note: write access in a SELECT context means SELECT FOR UPDATE.
398 * Right now we don't distinguish that from true update as far as
399 * permissions checks are concerned.
404 aclcheck_result = CHECK(ACL_INSERT);
408 aclcheck_result = CHECK(ACL_UPDATE);
411 aclcheck_result = CHECK(ACL_DELETE);
414 elog(ERROR, "ExecCheckRTEPerms: bogus operation %d",
416 aclcheck_result = ACLCHECK_OK; /* keep compiler quiet */
419 if (aclcheck_result != ACLCHECK_OK)
420 aclcheck_error(aclcheck_result, get_rel_name(relOid));
425 /* ===============================================================
426 * ===============================================================
427 static routines follow
428 * ===============================================================
429 * ===============================================================
432 typedef struct execRowMark
439 typedef struct evalPlanQual
444 struct evalPlanQual *free;
447 /* ----------------------------------------------------------------
450 * Initializes the query plan: open files, allocate storage
451 * and start up the rule manager
452 * ----------------------------------------------------------------
455 InitPlan(CmdType operation, Query *parseTree, Plan *plan, EState *estate)
458 Relation intoRelationDesc;
462 * Do permissions checks.
464 ExecCheckQueryPerms(operation, parseTree, plan);
467 * get information from query descriptor
469 rangeTable = parseTree->rtable;
472 * initialize the node's execution state
474 estate->es_range_table = rangeTable;
477 * if there is a result relation, initialize result relation stuff
479 if (parseTree->resultRelation != 0 && operation != CMD_SELECT)
481 List *resultRelations = parseTree->resultRelations;
482 int numResultRelations;
483 ResultRelInfo *resultRelInfos;
485 if (resultRelations != NIL)
488 * Multiple result relations (due to inheritance)
489 * parseTree->resultRelations identifies them all
491 ResultRelInfo *resultRelInfo;
493 numResultRelations = length(resultRelations);
494 resultRelInfos = (ResultRelInfo *)
495 palloc(numResultRelations * sizeof(ResultRelInfo));
496 resultRelInfo = resultRelInfos;
497 while (resultRelations != NIL)
499 initResultRelInfo(resultRelInfo,
500 lfirsti(resultRelations),
504 resultRelations = lnext(resultRelations);
510 * Single result relation identified by
511 * parseTree->resultRelation
513 numResultRelations = 1;
514 resultRelInfos = (ResultRelInfo *) palloc(sizeof(ResultRelInfo));
515 initResultRelInfo(resultRelInfos,
516 parseTree->resultRelation,
521 estate->es_result_relations = resultRelInfos;
522 estate->es_num_result_relations = numResultRelations;
523 /* Initialize to first or only result rel */
524 estate->es_result_relation_info = resultRelInfos;
529 * if no result relation, then set state appropriately
531 estate->es_result_relations = NULL;
532 estate->es_num_result_relations = 0;
533 estate->es_result_relation_info = NULL;
537 * Have to lock relations selected for update
539 estate->es_rowMark = NIL;
540 if (parseTree->rowMarks != NIL)
544 foreach(l, parseTree->rowMarks)
546 Index rti = lfirsti(l);
547 Oid relid = getrelid(rti, rangeTable);
551 relation = heap_open(relid, RowShareLock);
552 erm = (execRowMark *) palloc(sizeof(execRowMark));
553 erm->relation = relation;
555 sprintf(erm->resname, "ctid%u", rti);
556 estate->es_rowMark = lappend(estate->es_rowMark, erm);
561 * initialize the executor "tuple" table. We need slots for all the
562 * plan nodes, plus possibly output slots for the junkfilter(s). At
563 * this point we aren't sure if we need junkfilters, so just add slots
564 * for them unconditionally.
567 int nSlots = ExecCountSlotsNode(plan);
569 if (parseTree->resultRelations != NIL)
570 nSlots += length(parseTree->resultRelations);
573 estate->es_tupleTable = ExecCreateTupleTable(nSlots);
576 /* mark EvalPlanQual not active */
577 estate->es_origPlan = plan;
578 estate->es_evalPlanQual = NULL;
579 estate->es_evTuple = NULL;
580 estate->es_evTupleNull = NULL;
581 estate->es_useEvalPlan = false;
584 * initialize the private state information for all the nodes in the
585 * query tree. This opens files, allocates storage and leaves us
586 * ready to start processing tuples.
588 ExecInitNode(plan, estate, NULL);
591 * Get the tuple descriptor describing the type of tuples to return.
592 * (this is especially important if we are creating a relation with
595 tupType = ExecGetTupType(plan); /* tuple descriptor */
598 * Initialize the junk filter if needed. SELECT and INSERT queries
599 * need a filter if there are any junk attrs in the tlist. UPDATE and
600 * DELETE always need one, since there's always a junk 'ctid'
601 * attribute present --- no need to look first.
604 bool junk_filter_needed = false;
611 foreach(tlist, plan->targetlist)
613 TargetEntry *tle = (TargetEntry *) lfirst(tlist);
615 if (tle->resdom->resjunk)
617 junk_filter_needed = true;
624 junk_filter_needed = true;
630 if (junk_filter_needed)
633 * If there are multiple result relations, each one needs its
634 * own junk filter. Note this is only possible for
635 * UPDATE/DELETE, so we can't be fooled by some needing a
636 * filter and some not.
638 if (parseTree->resultRelations != NIL)
641 ResultRelInfo *resultRelInfo;
643 /* Top plan had better be an Append here. */
644 Assert(IsA(plan, Append));
645 Assert(((Append *) plan)->isTarget);
646 subplans = ((Append *) plan)->appendplans;
647 Assert(length(subplans) == estate->es_num_result_relations);
648 resultRelInfo = estate->es_result_relations;
649 while (subplans != NIL)
651 Plan *subplan = (Plan *) lfirst(subplans);
654 j = ExecInitJunkFilter(subplan->targetlist,
655 ExecGetTupType(subplan),
656 ExecAllocTableSlot(estate->es_tupleTable));
657 resultRelInfo->ri_junkFilter = j;
659 subplans = lnext(subplans);
663 * Set active junkfilter too; at this point ExecInitAppend
664 * has already selected an active result relation...
666 estate->es_junkFilter =
667 estate->es_result_relation_info->ri_junkFilter;
671 /* Normal case with just one JunkFilter */
674 j = ExecInitJunkFilter(plan->targetlist,
676 ExecAllocTableSlot(estate->es_tupleTable));
677 estate->es_junkFilter = j;
678 if (estate->es_result_relation_info)
679 estate->es_result_relation_info->ri_junkFilter = j;
681 /* For SELECT, want to return the cleaned tuple type */
682 if (operation == CMD_SELECT)
683 tupType = j->jf_cleanTupType;
687 estate->es_junkFilter = NULL;
691 * initialize the "into" relation
693 intoRelationDesc = (Relation) NULL;
695 if (operation == CMD_SELECT)
697 if (!parseTree->isPortal)
700 * a select into table --- need to create the "into" table
702 if (parseTree->into != NULL)
710 * find namespace to create in, check permissions
712 intoName = parseTree->into->relname;
713 namespaceId = RangeVarGetCreationNamespace(parseTree->into);
715 if (!isTempNamespace(namespaceId))
719 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
721 if (aclresult != ACLCHECK_OK)
722 aclcheck_error(aclresult,
723 get_namespace_name(namespaceId));
727 * have to copy tupType to get rid of constraints
729 tupdesc = CreateTupleDescCopy(tupType);
732 heap_create_with_catalog(intoName,
738 allowSystemTableMods);
740 FreeTupleDesc(tupdesc);
743 * Advance command counter so that the newly-created
744 * relation's catalog tuples will be visible to heap_open.
746 CommandCounterIncrement();
749 * If necessary, create a TOAST table for the into
750 * relation. Note that AlterTableCreateToastTable ends
751 * with CommandCounterIncrement(), so that the TOAST table
752 * will be visible for insertion.
754 AlterTableCreateToastTable(intoRelationId, true);
756 intoRelationDesc = heap_open(intoRelationId,
757 AccessExclusiveLock);
762 estate->es_into_relation_descriptor = intoRelationDesc;
768 * Initialize ResultRelInfo data for one result relation
771 initResultRelInfo(ResultRelInfo *resultRelInfo,
772 Index resultRelationIndex,
776 Oid resultRelationOid;
777 Relation resultRelationDesc;
779 resultRelationOid = getrelid(resultRelationIndex, rangeTable);
780 resultRelationDesc = heap_open(resultRelationOid, RowExclusiveLock);
782 switch (resultRelationDesc->rd_rel->relkind)
784 case RELKIND_SEQUENCE:
785 elog(ERROR, "You can't change sequence relation %s",
786 RelationGetRelationName(resultRelationDesc));
788 case RELKIND_TOASTVALUE:
789 elog(ERROR, "You can't change toast relation %s",
790 RelationGetRelationName(resultRelationDesc));
793 elog(ERROR, "You can't change view relation %s",
794 RelationGetRelationName(resultRelationDesc));
798 MemSet(resultRelInfo, 0, sizeof(ResultRelInfo));
799 resultRelInfo->type = T_ResultRelInfo;
800 resultRelInfo->ri_RangeTableIndex = resultRelationIndex;
801 resultRelInfo->ri_RelationDesc = resultRelationDesc;
802 resultRelInfo->ri_NumIndices = 0;
803 resultRelInfo->ri_IndexRelationDescs = NULL;
804 resultRelInfo->ri_IndexRelationInfo = NULL;
805 resultRelInfo->ri_TrigDesc = resultRelationDesc->trigdesc;
806 resultRelInfo->ri_TrigFunctions = NULL;
807 resultRelInfo->ri_ConstraintExprs = NULL;
808 resultRelInfo->ri_junkFilter = NULL;
811 * If there are indices on the result relation, open them and save
812 * descriptors in the result relation info, so that we can add new
813 * index entries for the tuples we add/update. We need not do this
814 * for a DELETE, however, since deletion doesn't affect indexes.
816 if (resultRelationDesc->rd_rel->relhasindex &&
817 operation != CMD_DELETE)
818 ExecOpenIndices(resultRelInfo);
821 /* ----------------------------------------------------------------
824 * Cleans up the query plan -- closes files and free up storages
825 * ----------------------------------------------------------------
828 EndPlan(Plan *plan, EState *estate)
830 ResultRelInfo *resultRelInfo;
835 * shut down any PlanQual processing we were doing
837 if (estate->es_evalPlanQual != NULL)
838 EndEvalPlanQual(estate);
841 * shut down the node-type-specific query processing
843 ExecEndNode(plan, NULL);
846 * destroy the executor "tuple" table.
848 ExecDropTupleTable(estate->es_tupleTable, true);
849 estate->es_tupleTable = NULL;
852 * close the result relation(s) if any, but hold locks until xact
853 * commit. Also clean up junkfilters if present.
855 resultRelInfo = estate->es_result_relations;
856 for (i = estate->es_num_result_relations; i > 0; i--)
858 /* Close indices and then the relation itself */
859 ExecCloseIndices(resultRelInfo);
860 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
861 /* Delete the junkfilter if any */
862 if (resultRelInfo->ri_junkFilter != NULL)
863 ExecFreeJunkFilter(resultRelInfo->ri_junkFilter);
868 * close the "into" relation if necessary, again keeping lock
870 if (estate->es_into_relation_descriptor != NULL)
871 heap_close(estate->es_into_relation_descriptor, NoLock);
874 * There might be a junkfilter without a result relation.
876 if (estate->es_num_result_relations == 0 &&
877 estate->es_junkFilter != NULL)
879 ExecFreeJunkFilter(estate->es_junkFilter);
880 estate->es_junkFilter = NULL;
884 * close any relations selected FOR UPDATE, again keeping locks
886 foreach(l, estate->es_rowMark)
888 execRowMark *erm = lfirst(l);
890 heap_close(erm->relation, NoLock);
894 /* ----------------------------------------------------------------
897 * processes the query plan to retrieve 'numberTuples' tuples in the
898 * direction specified.
899 * Retrieves all tuples if numberTuples is 0
901 * result is either a slot containing the last tuple in the case
902 * of a RETRIEVE or NULL otherwise.
904 * Note: the ctid attribute is a 'junk' attribute that is removed before the
906 * ----------------------------------------------------------------
908 static TupleTableSlot *
909 ExecutePlan(EState *estate,
913 ScanDirection direction,
914 DestReceiver *destfunc)
916 JunkFilter *junkfilter;
917 TupleTableSlot *slot;
918 ItemPointer tupleid = NULL;
919 ItemPointerData tuple_ctid;
920 long current_tuple_count;
921 TupleTableSlot *result;
924 * initialize local variables
927 current_tuple_count = 0;
933 estate->es_direction = direction;
936 * Loop until we've processed the proper number of tuples from the
942 /* Reset the per-output-tuple exprcontext */
943 ResetPerTupleExprContext(estate);
946 * Execute the plan and obtain a tuple
949 if (estate->es_useEvalPlan)
951 slot = EvalPlanQualNext(estate);
953 slot = ExecProcNode(plan, NULL);
956 slot = ExecProcNode(plan, NULL);
959 * if the tuple is null, then we assume there is nothing more to
960 * process so we just return null...
969 * if we have a junk filter, then project a new tuple with the
972 * Store this new "clean" tuple in the junkfilter's resultSlot.
973 * (Formerly, we stored it back over the "dirty" tuple, which is
974 * WRONG because that tuple slot has the wrong descriptor.)
976 * Also, extract all the junk information we need.
978 if ((junkfilter = estate->es_junkFilter) != (JunkFilter *) NULL)
985 * extract the 'ctid' junk attribute.
987 if (operation == CMD_UPDATE || operation == CMD_DELETE)
989 if (!ExecGetJunkAttribute(junkfilter,
994 elog(ERROR, "ExecutePlan: NO (junk) `ctid' was found!");
996 /* shouldn't ever get a null result... */
998 elog(ERROR, "ExecutePlan: (junk) `ctid' is NULL!");
1000 tupleid = (ItemPointer) DatumGetPointer(datum);
1001 tuple_ctid = *tupleid; /* make sure we don't free the
1003 tupleid = &tuple_ctid;
1005 else if (estate->es_rowMark != NIL)
1010 foreach(l, estate->es_rowMark)
1012 execRowMark *erm = lfirst(l);
1014 HeapTupleData tuple;
1015 TupleTableSlot *newSlot;
1018 if (!ExecGetJunkAttribute(junkfilter,
1023 elog(ERROR, "ExecutePlan: NO (junk) `%s' was found!",
1026 /* shouldn't ever get a null result... */
1028 elog(ERROR, "ExecutePlan: (junk) `%s' is NULL!",
1031 tuple.t_self = *((ItemPointer) DatumGetPointer(datum));
1032 test = heap_mark4update(erm->relation, &tuple, &buffer);
1033 ReleaseBuffer(buffer);
1036 case HeapTupleSelfUpdated:
1037 case HeapTupleMayBeUpdated:
1040 case HeapTupleUpdated:
1041 if (XactIsoLevel == XACT_SERIALIZABLE)
1042 elog(ERROR, "Can't serialize access due to concurrent update");
1043 if (!(ItemPointerEquals(&(tuple.t_self),
1044 (ItemPointer) DatumGetPointer(datum))))
1046 newSlot = EvalPlanQual(estate, erm->rti, &(tuple.t_self));
1047 if (!(TupIsNull(newSlot)))
1050 estate->es_useEvalPlan = true;
1056 * if tuple was deleted or PlanQual failed for
1057 * updated tuple - we must not return this
1063 elog(ERROR, "Unknown status %u from heap_mark4update", test);
1070 * Finally create a new "clean" tuple with all junk attributes
1073 newTuple = ExecRemoveJunk(junkfilter, slot);
1075 slot = ExecStoreTuple(newTuple, /* tuple to store */
1076 junkfilter->jf_resultSlot, /* dest slot */
1077 InvalidBuffer, /* this tuple has no
1079 true); /* tuple should be pfreed */
1080 } /* if (junkfilter... */
1083 * now that we have a tuple, do the appropriate thing with it..
1084 * either return it to the user, add it to a relation someplace,
1085 * delete it from a relation, or modify some of its attributes.
1091 ExecRetrieve(slot, /* slot containing tuple */
1092 destfunc, /* destination's tuple-receiver
1099 ExecAppend(slot, tupleid, estate);
1104 ExecDelete(slot, tupleid, estate);
1109 ExecReplace(slot, tupleid, estate);
1114 elog(LOG, "ExecutePlan: unknown operation in queryDesc");
1120 * check our tuple count.. if we've processed the proper number
1121 * then quit, else loop again and process more tuples..
1123 current_tuple_count++;
1124 if (numberTuples == current_tuple_count)
1129 * here, result is either a slot containing a tuple in the case of a
1130 * RETRIEVE or NULL otherwise.
1135 /* ----------------------------------------------------------------
1138 * RETRIEVEs are easy.. we just pass the tuple to the appropriate
1139 * print function. The only complexity is when we do a
1140 * "retrieve into", in which case we insert the tuple into
1141 * the appropriate relation (note: this is a newly created relation
1142 * so we don't need to worry about indices or locks.)
1143 * ----------------------------------------------------------------
1146 ExecRetrieve(TupleTableSlot *slot,
1147 DestReceiver *destfunc,
1154 * get the heap tuple out of the tuple table slot
1157 attrtype = slot->ttc_tupleDescriptor;
1160 * insert the tuple into the "into relation"
1162 if (estate->es_into_relation_descriptor != NULL)
1164 heap_insert(estate->es_into_relation_descriptor, tuple);
1169 * send the tuple to the front end (or the screen)
1171 (*destfunc->receiveTuple) (tuple, attrtype, destfunc);
1173 (estate->es_processed)++;
1176 /* ----------------------------------------------------------------
1179 * APPENDs are trickier.. we have to insert the tuple into
1180 * the base relation and insert appropriate tuples into the
1182 * ----------------------------------------------------------------
1186 ExecAppend(TupleTableSlot *slot,
1187 ItemPointer tupleid,
1191 ResultRelInfo *resultRelInfo;
1192 Relation resultRelationDesc;
1197 * get the heap tuple out of the tuple table slot
1202 * get information on the (current) result relation
1204 resultRelInfo = estate->es_result_relation_info;
1205 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1207 /* BEFORE ROW INSERT Triggers */
1208 if (resultRelInfo->ri_TrigDesc &&
1209 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_INSERT] > 0)
1213 newtuple = ExecBRInsertTriggers(estate, resultRelInfo, tuple);
1215 if (newtuple == NULL) /* "do nothing" */
1218 if (newtuple != tuple) /* modified by Trigger(s) */
1221 * Insert modified tuple into tuple table slot, replacing the
1222 * original. We assume that it was allocated in per-tuple
1223 * memory context, and therefore will go away by itself. The
1224 * tuple table slot should not try to clear it.
1226 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1232 * Check the constraints of the tuple
1234 if (resultRelationDesc->rd_att->constr)
1235 ExecConstraints("ExecAppend", resultRelInfo, slot, estate);
1240 newId = heap_insert(resultRelationDesc, tuple);
1243 (estate->es_processed)++;
1244 estate->es_lastoid = newId;
1245 setLastTid(&(tuple->t_self));
1250 * Note: heap_insert adds a new tuple to a relation. As a side effect,
1251 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1254 numIndices = resultRelInfo->ri_NumIndices;
1256 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1258 /* AFTER ROW INSERT Triggers */
1259 if (resultRelInfo->ri_TrigDesc)
1260 ExecARInsertTriggers(estate, resultRelInfo, tuple);
1263 /* ----------------------------------------------------------------
1266 * DELETE is like append, we delete the tuple and its
1268 * ----------------------------------------------------------------
1271 ExecDelete(TupleTableSlot *slot,
1272 ItemPointer tupleid,
1275 ResultRelInfo *resultRelInfo;
1276 Relation resultRelationDesc;
1277 ItemPointerData ctid;
1281 * get information on the (current) result relation
1283 resultRelInfo = estate->es_result_relation_info;
1284 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1286 /* BEFORE ROW DELETE Triggers */
1287 if (resultRelInfo->ri_TrigDesc &&
1288 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_DELETE] > 0)
1292 dodelete = ExecBRDeleteTriggers(estate, resultRelInfo, tupleid);
1294 if (!dodelete) /* "do nothing" */
1302 result = heap_delete(resultRelationDesc, tupleid, &ctid);
1305 case HeapTupleSelfUpdated:
1308 case HeapTupleMayBeUpdated:
1311 case HeapTupleUpdated:
1312 if (XactIsoLevel == XACT_SERIALIZABLE)
1313 elog(ERROR, "Can't serialize access due to concurrent update");
1314 else if (!(ItemPointerEquals(tupleid, &ctid)))
1316 TupleTableSlot *epqslot = EvalPlanQual(estate,
1317 resultRelInfo->ri_RangeTableIndex, &ctid);
1319 if (!TupIsNull(epqslot))
1325 /* tuple already deleted; nothing to do */
1329 elog(ERROR, "Unknown status %u from heap_delete", result);
1334 (estate->es_processed)++;
1337 * Note: Normally one would think that we have to delete index tuples
1338 * associated with the heap tuple now..
1340 * ... but in POSTGRES, we have no need to do this because the vacuum
1341 * daemon automatically opens an index scan and deletes index tuples
1342 * when it finds deleted heap tuples. -cim 9/27/89
1345 /* AFTER ROW DELETE Triggers */
1346 if (resultRelInfo->ri_TrigDesc)
1347 ExecARDeleteTriggers(estate, resultRelInfo, tupleid);
1350 /* ----------------------------------------------------------------
1353 * note: we can't run replace queries with transactions
1354 * off because replaces are actually appends and our
1355 * scan will mistakenly loop forever, replacing the tuple
1356 * it just appended.. This should be fixed but until it
1357 * is, we don't want to get stuck in an infinite loop
1358 * which corrupts your database..
1359 * ----------------------------------------------------------------
1362 ExecReplace(TupleTableSlot *slot,
1363 ItemPointer tupleid,
1367 ResultRelInfo *resultRelInfo;
1368 Relation resultRelationDesc;
1369 ItemPointerData ctid;
1374 * abort the operation if not running transactions
1376 if (IsBootstrapProcessingMode())
1378 elog(WARNING, "ExecReplace: replace can't run without transactions");
1383 * get the heap tuple out of the tuple table slot
1388 * get information on the (current) result relation
1390 resultRelInfo = estate->es_result_relation_info;
1391 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1393 /* BEFORE ROW UPDATE Triggers */
1394 if (resultRelInfo->ri_TrigDesc &&
1395 resultRelInfo->ri_TrigDesc->n_before_row[TRIGGER_EVENT_UPDATE] > 0)
1399 newtuple = ExecBRUpdateTriggers(estate, resultRelInfo,
1402 if (newtuple == NULL) /* "do nothing" */
1405 if (newtuple != tuple) /* modified by Trigger(s) */
1408 * Insert modified tuple into tuple table slot, replacing the
1409 * original. We assume that it was allocated in per-tuple
1410 * memory context, and therefore will go away by itself. The
1411 * tuple table slot should not try to clear it.
1413 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1419 * Check the constraints of the tuple
1421 * If we generate a new candidate tuple after EvalPlanQual testing, we
1422 * must loop back here and recheck constraints. (We don't need to
1423 * redo triggers, however. If there are any BEFORE triggers then
1424 * trigger.c will have done mark4update to lock the correct tuple, so
1425 * there's no need to do them again.)
1428 if (resultRelationDesc->rd_att->constr)
1429 ExecConstraints("ExecReplace", resultRelInfo, slot, estate);
1432 * replace the heap tuple
1434 result = heap_update(resultRelationDesc, tupleid, tuple, &ctid);
1437 case HeapTupleSelfUpdated:
1440 case HeapTupleMayBeUpdated:
1443 case HeapTupleUpdated:
1444 if (XactIsoLevel == XACT_SERIALIZABLE)
1445 elog(ERROR, "Can't serialize access due to concurrent update");
1446 else if (!(ItemPointerEquals(tupleid, &ctid)))
1448 TupleTableSlot *epqslot = EvalPlanQual(estate,
1449 resultRelInfo->ri_RangeTableIndex, &ctid);
1451 if (!TupIsNull(epqslot))
1454 tuple = ExecRemoveJunk(estate->es_junkFilter, epqslot);
1455 slot = ExecStoreTuple(tuple,
1456 estate->es_junkFilter->jf_resultSlot,
1457 InvalidBuffer, true);
1461 /* tuple already deleted; nothing to do */
1465 elog(ERROR, "Unknown status %u from heap_update", result);
1470 (estate->es_processed)++;
1473 * Note: instead of having to update the old index tuples associated
1474 * with the heap tuple, all we do is form and insert new index tuples.
1475 * This is because replaces are actually deletes and inserts and index
1476 * tuple deletion is done automagically by the vacuum daemon. All we
1477 * do is insert new index tuples. -cim 9/27/89
1483 * heap_update updates a tuple in the base relation by invalidating it
1484 * and then appending a new tuple to the relation. As a side effect,
1485 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1486 * field. So we now insert index tuples using the new tupleid stored
1490 numIndices = resultRelInfo->ri_NumIndices;
1492 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, true);
1494 /* AFTER ROW UPDATE Triggers */
1495 if (resultRelInfo->ri_TrigDesc)
1496 ExecARUpdateTriggers(estate, resultRelInfo, tupleid, tuple);
1500 ExecRelCheck(ResultRelInfo *resultRelInfo,
1501 TupleTableSlot *slot, EState *estate)
1503 Relation rel = resultRelInfo->ri_RelationDesc;
1504 int ncheck = rel->rd_att->constr->num_check;
1505 ConstrCheck *check = rel->rd_att->constr->check;
1506 ExprContext *econtext;
1507 MemoryContext oldContext;
1512 * If first time through for this result relation, build expression
1513 * nodetrees for rel's constraint expressions. Keep them in the
1514 * per-query memory context so they'll survive throughout the query.
1516 if (resultRelInfo->ri_ConstraintExprs == NULL)
1518 oldContext = MemoryContextSwitchTo(estate->es_query_cxt);
1519 resultRelInfo->ri_ConstraintExprs =
1520 (List **) palloc(ncheck * sizeof(List *));
1521 for (i = 0; i < ncheck; i++)
1523 qual = (List *) stringToNode(check[i].ccbin);
1524 resultRelInfo->ri_ConstraintExprs[i] = qual;
1526 MemoryContextSwitchTo(oldContext);
1530 * We will use the EState's per-tuple context for evaluating
1531 * constraint expressions (creating it if it's not already there).
1533 econtext = GetPerTupleExprContext(estate);
1535 /* Arrange for econtext's scan tuple to be the tuple under test */
1536 econtext->ecxt_scantuple = slot;
1538 /* And evaluate the constraints */
1539 for (i = 0; i < ncheck; i++)
1541 qual = resultRelInfo->ri_ConstraintExprs[i];
1544 * NOTE: SQL92 specifies that a NULL result from a constraint
1545 * expression is not to be treated as a failure. Therefore, tell
1546 * ExecQual to return TRUE for NULL.
1548 if (!ExecQual(qual, econtext, true))
1549 return check[i].ccname;
1552 /* NULL result means no error */
1553 return (char *) NULL;
1557 ExecConstraints(char *caller, ResultRelInfo *resultRelInfo,
1558 TupleTableSlot *slot, EState *estate)
1560 Relation rel = resultRelInfo->ri_RelationDesc;
1561 HeapTuple tuple = slot->val;
1562 TupleConstr *constr = rel->rd_att->constr;
1566 if (constr->has_not_null)
1568 int natts = rel->rd_att->natts;
1571 for (attrChk = 1; attrChk <= natts; attrChk++)
1573 if (rel->rd_att->attrs[attrChk - 1]->attnotnull &&
1574 heap_attisnull(tuple, attrChk))
1575 elog(ERROR, "%s: Fail to add null value in not null attribute %s",
1576 caller, NameStr(rel->rd_att->attrs[attrChk - 1]->attname));
1580 if (constr->num_check > 0)
1584 if ((failed = ExecRelCheck(resultRelInfo, slot, estate)) != NULL)
1585 elog(ERROR, "%s: rejected due to CHECK constraint %s",
1591 * Check a modified tuple to see if we want to process its updated version
1592 * under READ COMMITTED rules.
1594 * See backend/executor/README for some info about how this works.
1597 EvalPlanQual(EState *estate, Index rti, ItemPointer tid)
1602 HeapTupleData tuple;
1603 HeapTuple copyTuple = NULL;
1610 * find relation containing target tuple
1612 if (estate->es_result_relation_info != NULL &&
1613 estate->es_result_relation_info->ri_RangeTableIndex == rti)
1614 relation = estate->es_result_relation_info->ri_RelationDesc;
1620 foreach(l, estate->es_rowMark)
1622 if (((execRowMark *) lfirst(l))->rti == rti)
1624 relation = ((execRowMark *) lfirst(l))->relation;
1628 if (relation == NULL)
1629 elog(ERROR, "EvalPlanQual: can't find RTE %d", (int) rti);
1635 * Loop here to deal with updated or busy tuples
1637 tuple.t_self = *tid;
1642 heap_fetch(relation, SnapshotDirty, &tuple, &buffer, NULL);
1643 if (tuple.t_data != NULL)
1645 TransactionId xwait = SnapshotDirty->xmax;
1647 if (TransactionIdIsValid(SnapshotDirty->xmin))
1648 elog(ERROR, "EvalPlanQual: t_xmin is uncommitted ?!");
1651 * If tuple is being updated by other transaction then we have
1652 * to wait for its commit/abort.
1654 if (TransactionIdIsValid(xwait))
1656 ReleaseBuffer(buffer);
1657 XactLockTableWait(xwait);
1662 * We got tuple - now copy it for use by recheck query.
1664 copyTuple = heap_copytuple(&tuple);
1665 ReleaseBuffer(buffer);
1670 * Oops! Invalid tuple. Have to check is it updated or deleted.
1671 * Note that it's possible to get invalid SnapshotDirty->tid if
1672 * tuple updated by this transaction. Have we to check this ?
1674 if (ItemPointerIsValid(&(SnapshotDirty->tid)) &&
1675 !(ItemPointerEquals(&(tuple.t_self), &(SnapshotDirty->tid))))
1677 /* updated, so look at the updated copy */
1678 tuple.t_self = SnapshotDirty->tid;
1683 * Deleted or updated by this transaction; forget it.
1689 * For UPDATE/DELETE we have to return tid of actual row we're
1692 *tid = tuple.t_self;
1695 * Need to run a recheck subquery. Find or create a PQ stack entry.
1697 epq = (evalPlanQual *) estate->es_evalPlanQual;
1698 rtsize = length(estate->es_range_table);
1701 if (epq != NULL && epq->rti == 0)
1703 /* Top PQ stack entry is idle, so re-use it */
1704 Assert(!(estate->es_useEvalPlan) &&
1705 epq->estate.es_evalPlanQual == NULL);
1711 * If this is request for another RTE - Ra, - then we have to check
1712 * wasn't PlanQual requested for Ra already and if so then Ra' row was
1713 * updated again and we have to re-start old execution for Ra and
1714 * forget all what we done after Ra was suspended. Cool? -:))
1716 if (epq != NULL && epq->rti != rti &&
1717 epq->estate.es_evTuple[rti - 1] != NULL)
1721 evalPlanQual *oldepq;
1723 /* pop previous PlanQual from the stack */
1724 epqstate = &(epq->estate);
1725 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1726 Assert(oldepq->rti != 0);
1727 /* stop execution */
1728 ExecEndNode(epq->plan, NULL);
1729 ExecDropTupleTable(epqstate->es_tupleTable, true);
1730 epqstate->es_tupleTable = NULL;
1731 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1732 epqstate->es_evTuple[epq->rti - 1] = NULL;
1733 /* push current PQ to freePQ stack */
1736 estate->es_evalPlanQual = (Pointer) epq;
1737 } while (epq->rti != rti);
1741 * If we are requested for another RTE then we have to suspend
1742 * execution of current PlanQual and start execution for new one.
1744 if (epq == NULL || epq->rti != rti)
1746 /* try to reuse plan used previously */
1747 evalPlanQual *newepq = (epq != NULL) ? epq->free : NULL;
1749 if (newepq == NULL) /* first call or freePQ stack is empty */
1751 newepq = (evalPlanQual *) palloc(sizeof(evalPlanQual));
1752 newepq->free = NULL;
1755 * Each stack level has its own copy of the plan tree. This
1756 * is wasteful, but necessary as long as plan nodes point to
1757 * exec state nodes rather than vice versa. Note that
1758 * copyfuncs.c doesn't attempt to copy the exec state nodes,
1759 * which is a good thing in this situation.
1761 newepq->plan = copyObject(estate->es_origPlan);
1764 * Init stack level's EState. We share top level's copy of
1765 * es_result_relations array and other non-changing status. We
1766 * need our own tupletable, es_param_exec_vals, and other
1769 epqstate = &(newepq->estate);
1770 memcpy(epqstate, estate, sizeof(EState));
1771 epqstate->es_direction = ForwardScanDirection;
1772 if (estate->es_origPlan->nParamExec > 0)
1773 epqstate->es_param_exec_vals = (ParamExecData *)
1774 palloc(estate->es_origPlan->nParamExec *
1775 sizeof(ParamExecData));
1776 epqstate->es_tupleTable = NULL;
1777 epqstate->es_per_tuple_exprcontext = NULL;
1780 * Each epqstate must have its own es_evTupleNull state, but
1781 * all the stack entries share es_evTuple state. This allows
1782 * sub-rechecks to inherit the value being examined by an
1785 epqstate->es_evTupleNull = (bool *) palloc(rtsize * sizeof(bool));
1788 /* first PQ stack entry */
1789 epqstate->es_evTuple = (HeapTuple *)
1790 palloc(rtsize * sizeof(HeapTuple));
1791 memset(epqstate->es_evTuple, 0, rtsize * sizeof(HeapTuple));
1795 /* later stack entries share the same storage */
1796 epqstate->es_evTuple = epq->estate.es_evTuple;
1801 /* recycle previously used EState */
1802 epqstate = &(newepq->estate);
1804 /* push current PQ to the stack */
1805 epqstate->es_evalPlanQual = (Pointer) epq;
1807 estate->es_evalPlanQual = (Pointer) epq;
1812 Assert(epq->rti == rti);
1813 epqstate = &(epq->estate);
1816 * Ok - we're requested for the same RTE. Unfortunately we still have
1817 * to end and restart execution of the plan, because ExecReScan
1818 * wouldn't ensure that upper plan nodes would reset themselves. We
1819 * could make that work if insertion of the target tuple were
1820 * integrated with the Param mechanism somehow, so that the upper plan
1821 * nodes know that their children's outputs have changed.
1825 /* stop execution */
1826 ExecEndNode(epq->plan, NULL);
1827 ExecDropTupleTable(epqstate->es_tupleTable, true);
1828 epqstate->es_tupleTable = NULL;
1832 * free old RTE' tuple, if any, and store target tuple where
1833 * relation's scan node will see it
1835 if (epqstate->es_evTuple[rti - 1] != NULL)
1836 heap_freetuple(epqstate->es_evTuple[rti - 1]);
1837 epqstate->es_evTuple[rti - 1] = copyTuple;
1840 * Initialize for new recheck query; be careful to copy down state
1841 * that might have changed in top EState.
1843 epqstate->es_result_relation_info = estate->es_result_relation_info;
1844 epqstate->es_junkFilter = estate->es_junkFilter;
1845 if (estate->es_origPlan->nParamExec > 0)
1846 memset(epqstate->es_param_exec_vals, 0,
1847 estate->es_origPlan->nParamExec * sizeof(ParamExecData));
1848 memset(epqstate->es_evTupleNull, false, rtsize * sizeof(bool));
1849 epqstate->es_useEvalPlan = false;
1850 Assert(epqstate->es_tupleTable == NULL);
1851 epqstate->es_tupleTable =
1852 ExecCreateTupleTable(estate->es_tupleTable->size);
1854 ExecInitNode(epq->plan, epqstate, NULL);
1856 return EvalPlanQualNext(estate);
1859 static TupleTableSlot *
1860 EvalPlanQualNext(EState *estate)
1862 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1863 EState *epqstate = &(epq->estate);
1864 evalPlanQual *oldepq;
1865 TupleTableSlot *slot;
1867 Assert(epq->rti != 0);
1870 slot = ExecProcNode(epq->plan, NULL);
1873 * No more tuples for this PQ. Continue previous one.
1875 if (TupIsNull(slot))
1877 /* stop execution */
1878 ExecEndNode(epq->plan, NULL);
1879 ExecDropTupleTable(epqstate->es_tupleTable, true);
1880 epqstate->es_tupleTable = NULL;
1881 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1882 epqstate->es_evTuple[epq->rti - 1] = NULL;
1883 /* pop old PQ from the stack */
1884 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1885 if (oldepq == (evalPlanQual *) NULL)
1887 epq->rti = 0; /* this is the first (oldest) */
1888 estate->es_useEvalPlan = false; /* PQ - mark as free and */
1889 return (NULL); /* continue Query execution */
1891 Assert(oldepq->rti != 0);
1892 /* push current PQ to freePQ stack */
1895 epqstate = &(epq->estate);
1896 estate->es_evalPlanQual = (Pointer) epq;
1904 EndEvalPlanQual(EState *estate)
1906 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1907 EState *epqstate = &(epq->estate);
1908 evalPlanQual *oldepq;
1910 if (epq->rti == 0) /* plans already shutdowned */
1912 Assert(epq->estate.es_evalPlanQual == NULL);
1918 /* stop execution */
1919 ExecEndNode(epq->plan, NULL);
1920 ExecDropTupleTable(epqstate->es_tupleTable, true);
1921 epqstate->es_tupleTable = NULL;
1922 if (epqstate->es_evTuple[epq->rti - 1] != NULL)
1924 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1925 epqstate->es_evTuple[epq->rti - 1] = NULL;
1927 /* pop old PQ from the stack */
1928 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1929 if (oldepq == (evalPlanQual *) NULL)
1931 epq->rti = 0; /* this is the first (oldest) */
1932 estate->es_useEvalPlan = false; /* PQ - mark as free */
1935 Assert(oldepq->rti != 0);
1936 /* push current PQ to freePQ stack */
1939 epqstate = &(epq->estate);
1940 estate->es_evalPlanQual = (Pointer) epq;