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 'feature' 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.139 2001/03/22 03:59:26 momjian Exp $
32 *-------------------------------------------------------------------------
36 #include "access/heapam.h"
37 #include "catalog/heap.h"
38 #include "commands/command.h"
39 #include "commands/trigger.h"
40 #include "executor/execdebug.h"
41 #include "executor/execdefs.h"
42 #include "miscadmin.h"
43 #include "optimizer/var.h"
44 #include "parser/parsetree.h"
45 #include "utils/acl.h"
48 /* decls for local routines only used within this module */
49 static TupleDesc InitPlan(CmdType operation,
53 static void initResultRelInfo(ResultRelInfo *resultRelInfo,
54 Index resultRelationIndex,
57 static void EndPlan(Plan *plan, EState *estate);
58 static TupleTableSlot *ExecutePlan(EState *estate, Plan *plan,
61 ScanDirection direction,
62 DestReceiver *destfunc);
63 static void ExecRetrieve(TupleTableSlot *slot,
64 DestReceiver *destfunc,
66 static void ExecAppend(TupleTableSlot *slot, ItemPointer tupleid,
68 static void ExecDelete(TupleTableSlot *slot, ItemPointer tupleid,
70 static void ExecReplace(TupleTableSlot *slot, ItemPointer tupleid,
72 static TupleTableSlot *EvalPlanQualNext(EState *estate);
73 static void EndEvalPlanQual(EState *estate);
74 static void ExecCheckQueryPerms(CmdType operation, Query *parseTree,
76 static void ExecCheckPlanPerms(Plan *plan, List *rangeTable,
78 static void ExecCheckRTPerms(List *rangeTable, CmdType operation);
79 static void ExecCheckRTEPerms(RangeTblEntry *rte, CmdType operation);
81 /* end of local decls */
84 /* ----------------------------------------------------------------
87 * This routine must be called at the beginning of any execution of any
90 * returns a TupleDesc which describes the attributes of the tuples to
91 * be returned by the query.
93 * NB: the CurrentMemoryContext when this is called must be the context
94 * to be used as the per-query context for the query plan. ExecutorRun()
95 * and ExecutorEnd() must be called in this same memory context.
96 * ----------------------------------------------------------------
99 ExecutorStart(QueryDesc *queryDesc, EState *estate)
104 Assert(queryDesc != NULL);
106 if (queryDesc->plantree->nParamExec > 0)
108 estate->es_param_exec_vals = (ParamExecData *)
109 palloc(queryDesc->plantree->nParamExec * sizeof(ParamExecData));
110 MemSet(estate->es_param_exec_vals, 0,
111 queryDesc->plantree->nParamExec * sizeof(ParamExecData));
115 * Make our own private copy of the current queries snapshot data
117 if (QuerySnapshot == NULL)
118 estate->es_snapshot = NULL;
121 estate->es_snapshot = (Snapshot) palloc(sizeof(SnapshotData));
122 memcpy(estate->es_snapshot, QuerySnapshot, sizeof(SnapshotData));
123 if (estate->es_snapshot->xcnt > 0)
125 estate->es_snapshot->xip = (TransactionId *)
126 palloc(estate->es_snapshot->xcnt * sizeof(TransactionId));
127 memcpy(estate->es_snapshot->xip, QuerySnapshot->xip,
128 estate->es_snapshot->xcnt * sizeof(TransactionId));
133 * Initialize the plan
135 result = InitPlan(queryDesc->operation,
136 queryDesc->parsetree,
143 /* ----------------------------------------------------------------
146 * This is the main routine of the executor module. It accepts
147 * the query descriptor from the traffic cop and executes the
150 * ExecutorStart must have been called already.
152 * the different features supported are:
153 * EXEC_RUN: retrieve all tuples in the forward direction
154 * EXEC_FOR: retrieve 'count' number of tuples in the forward dir
155 * EXEC_BACK: retrieve 'count' number of tuples in the backward dir
156 * EXEC_RETONE: return one tuple but don't 'retrieve' it
157 * used in postquel function processing
159 * Note: count = 0 is interpreted as "no limit".
161 * ----------------------------------------------------------------
164 ExecutorRun(QueryDesc *queryDesc, EState *estate, int feature, long count)
168 TupleTableSlot *result;
170 DestReceiver *destfunc;
175 Assert(queryDesc != NULL);
178 * extract information from the query descriptor and the query
181 operation = queryDesc->operation;
182 plan = queryDesc->plantree;
183 dest = queryDesc->dest;
184 destfunc = DestToFunction(dest);
185 estate->es_processed = 0;
186 estate->es_lastoid = InvalidOid;
189 * FIXME: the dest setup function ought to be handed the tuple desc
190 * for the tuples to be output, but I'm not quite sure how to get that
191 * info at this point. For now, passing NULL is OK because no
192 * existing dest setup function actually uses the pointer.
194 (*destfunc->setup) (destfunc, (TupleDesc) NULL);
199 result = ExecutePlan(estate,
203 ForwardScanDirection,
208 result = ExecutePlan(estate,
212 ForwardScanDirection,
217 * retrieve next n "backward" tuples
220 result = ExecutePlan(estate,
224 BackwardScanDirection,
229 * return one tuple but don't "retrieve" it. (this is used by
230 * the rule manager..) -cim 9/14/89
233 result = ExecutePlan(estate,
237 ForwardScanDirection,
242 elog(DEBUG, "ExecutorRun: Unknown feature %d", feature);
247 (*destfunc->cleanup) (destfunc);
252 /* ----------------------------------------------------------------
255 * This routine must be called at the end of execution of any
257 * ----------------------------------------------------------------
260 ExecutorEnd(QueryDesc *queryDesc, EState *estate)
263 Assert(queryDesc != NULL);
265 EndPlan(queryDesc->plantree, estate);
267 if (estate->es_snapshot != NULL)
269 if (estate->es_snapshot->xcnt > 0)
270 pfree(estate->es_snapshot->xip);
271 pfree(estate->es_snapshot);
272 estate->es_snapshot = NULL;
275 if (estate->es_param_exec_vals != NULL)
277 pfree(estate->es_param_exec_vals);
278 estate->es_param_exec_vals = NULL;
284 * ExecCheckQueryPerms
285 * Check access permissions for all relations referenced in a query.
288 ExecCheckQueryPerms(CmdType operation, Query *parseTree, Plan *plan)
292 * Check RTEs in the query's primary rangetable.
294 ExecCheckRTPerms(parseTree->rtable, operation);
297 * Search for subplans and APPEND nodes to check their rangetables.
299 ExecCheckPlanPerms(plan, parseTree->rtable, operation);
304 * Recursively scan the plan tree to check access permissions in
308 ExecCheckPlanPerms(Plan *plan, List *rangeTable, CmdType operation)
315 /* Check subplans, which we assume are plain SELECT queries */
317 foreach(subp, plan->initPlan)
319 SubPlan *subplan = (SubPlan *) lfirst(subp);
321 ExecCheckRTPerms(subplan->rtable, CMD_SELECT);
322 ExecCheckPlanPerms(subplan->plan, subplan->rtable, CMD_SELECT);
324 foreach(subp, plan->subPlan)
326 SubPlan *subplan = (SubPlan *) lfirst(subp);
328 ExecCheckRTPerms(subplan->rtable, CMD_SELECT);
329 ExecCheckPlanPerms(subplan->plan, subplan->rtable, CMD_SELECT);
332 /* Check lower plan nodes */
334 ExecCheckPlanPerms(plan->lefttree, rangeTable, operation);
335 ExecCheckPlanPerms(plan->righttree, rangeTable, operation);
337 /* Do node-type-specific checks */
339 switch (nodeTag(plan))
343 SubqueryScan *scan = (SubqueryScan *) plan;
346 /* Recursively check the subquery */
347 rte = rt_fetch(scan->scan.scanrelid, rangeTable);
348 Assert(rte->subquery != NULL);
349 ExecCheckQueryPerms(operation, rte->subquery, scan->subplan);
354 Append *app = (Append *) plan;
357 foreach(appendplans, app->appendplans)
359 ExecCheckPlanPerms((Plan *) lfirst(appendplans),
373 * Check access permissions for all relations listed in a range table.
376 ExecCheckRTPerms(List *rangeTable, CmdType operation)
380 foreach(lp, rangeTable)
382 RangeTblEntry *rte = lfirst(lp);
384 ExecCheckRTEPerms(rte, operation);
390 * Check access permissions for a single RTE.
393 ExecCheckRTEPerms(RangeTblEntry *rte, CmdType operation)
397 int32 aclcheck_result;
400 * If it's a subquery RTE, ignore it --- it will be checked when
401 * ExecCheckPlanPerms finds the SubqueryScan node for it.
406 relName = rte->relname;
409 * userid to check as: current user unless we have a setuid
412 * Note: GetUserId() is presently fast enough that there's no harm in
413 * calling it separately for each RTE. If that stops being true, we
414 * could call it once in ExecCheckQueryPerms and pass the userid down
415 * from there. But for now, no need for the extra clutter.
417 userid = rte->checkAsUser ? rte->checkAsUser : GetUserId();
419 #define CHECK(MODE) pg_aclcheck(relName, userid, MODE)
421 if (rte->checkForRead)
423 aclcheck_result = CHECK(ACL_RD);
424 if (aclcheck_result != ACLCHECK_OK)
425 elog(ERROR, "%s: %s",
426 relName, aclcheck_error_strings[aclcheck_result]);
429 if (rte->checkForWrite)
433 * Note: write access in a SELECT context means SELECT FOR UPDATE.
434 * Right now we don't distinguish that from true update as far as
435 * permissions checks are concerned.
440 /* Accept either APPEND or WRITE access for this */
441 aclcheck_result = CHECK(ACL_AP);
442 if (aclcheck_result != ACLCHECK_OK)
443 aclcheck_result = CHECK(ACL_WR);
448 aclcheck_result = CHECK(ACL_WR);
451 elog(ERROR, "ExecCheckRTEPerms: bogus operation %d",
453 aclcheck_result = ACLCHECK_OK; /* keep compiler quiet */
456 if (aclcheck_result != ACLCHECK_OK)
457 elog(ERROR, "%s: %s",
458 relName, aclcheck_error_strings[aclcheck_result]);
463 /* ===============================================================
464 * ===============================================================
465 static routines follow
466 * ===============================================================
467 * ===============================================================
470 typedef struct execRowMark
477 typedef struct evalPlanQual
482 struct evalPlanQual *free;
485 /* ----------------------------------------------------------------
488 * Initializes the query plan: open files, allocate storage
489 * and start up the rule manager
490 * ----------------------------------------------------------------
493 InitPlan(CmdType operation, Query *parseTree, Plan *plan, EState *estate)
496 Relation intoRelationDesc;
500 * Do permissions checks.
502 ExecCheckQueryPerms(operation, parseTree, plan);
505 * get information from query descriptor
507 rangeTable = parseTree->rtable;
510 * initialize the node's execution state
512 estate->es_range_table = rangeTable;
515 * if there is a result relation, initialize result relation stuff
517 if (parseTree->resultRelation != 0 && operation != CMD_SELECT)
519 List *resultRelations = parseTree->resultRelations;
520 int numResultRelations;
521 ResultRelInfo *resultRelInfos;
523 if (resultRelations != NIL)
527 * Multiple result relations (due to inheritance)
528 * parseTree->resultRelations identifies them all
530 ResultRelInfo *resultRelInfo;
532 numResultRelations = length(resultRelations);
533 resultRelInfos = (ResultRelInfo *)
534 palloc(numResultRelations * sizeof(ResultRelInfo));
535 resultRelInfo = resultRelInfos;
536 while (resultRelations != NIL)
538 initResultRelInfo(resultRelInfo,
539 lfirsti(resultRelations),
543 resultRelations = lnext(resultRelations);
550 * Single result relation identified by
551 * parseTree->resultRelation
553 numResultRelations = 1;
554 resultRelInfos = (ResultRelInfo *) palloc(sizeof(ResultRelInfo));
555 initResultRelInfo(resultRelInfos,
556 parseTree->resultRelation,
561 estate->es_result_relations = resultRelInfos;
562 estate->es_num_result_relations = numResultRelations;
563 /* Initialize to first or only result rel */
564 estate->es_result_relation_info = resultRelInfos;
570 * if no result relation, then set state appropriately
572 estate->es_result_relations = NULL;
573 estate->es_num_result_relations = 0;
574 estate->es_result_relation_info = NULL;
578 * Have to lock relations selected for update
580 estate->es_rowMark = NIL;
581 if (parseTree->rowMarks != NIL)
585 foreach(l, parseTree->rowMarks)
587 Index rti = lfirsti(l);
588 Oid relid = getrelid(rti, rangeTable);
592 relation = heap_open(relid, RowShareLock);
593 erm = (execRowMark *) palloc(sizeof(execRowMark));
594 erm->relation = relation;
596 sprintf(erm->resname, "ctid%u", rti);
597 estate->es_rowMark = lappend(estate->es_rowMark, erm);
602 * initialize the executor "tuple" table.
605 int nSlots = ExecCountSlotsNode(plan);
606 TupleTable tupleTable = ExecCreateTupleTable(nSlots + 10); /* why add ten? - jolly */
608 estate->es_tupleTable = tupleTable;
612 * initialize the private state information for all the nodes in the
613 * query tree. This opens files, allocates storage and leaves us
614 * ready to start processing tuples.
616 ExecInitNode(plan, estate, NULL);
619 * Get the tuple descriptor describing the type of tuples to return.
620 * (this is especially important if we are creating a relation with
623 tupType = ExecGetTupType(plan); /* tuple descriptor */
626 * Initialize the junk filter if needed. SELECT and INSERT queries
627 * need a filter if there are any junk attrs in the tlist. UPDATE and
628 * DELETE always need one, since there's always a junk 'ctid'
629 * attribute present --- no need to look first.
632 bool junk_filter_needed = false;
639 foreach(tlist, plan->targetlist)
641 TargetEntry *tle = (TargetEntry *) lfirst(tlist);
643 if (tle->resdom->resjunk)
645 junk_filter_needed = true;
652 junk_filter_needed = true;
658 if (junk_filter_needed)
662 * If there are multiple result relations, each one needs its
663 * own junk filter. Note this is only possible for
664 * UPDATE/DELETE, so we can't be fooled by some needing a
665 * filter and some not.
667 if (parseTree->resultRelations != NIL)
670 ResultRelInfo *resultRelInfo;
672 /* Top plan had better be an Append here. */
673 Assert(IsA(plan, Append));
674 Assert(((Append *) plan)->isTarget);
675 subplans = ((Append *) plan)->appendplans;
676 Assert(length(subplans) == estate->es_num_result_relations);
677 resultRelInfo = estate->es_result_relations;
678 while (subplans != NIL)
680 Plan *subplan = (Plan *) lfirst(subplans);
683 j = ExecInitJunkFilter(subplan->targetlist,
684 ExecGetTupType(subplan));
685 resultRelInfo->ri_junkFilter = j;
687 subplans = lnext(subplans);
691 * Set active junkfilter too; at this point ExecInitAppend
692 * has already selected an active result relation...
694 estate->es_junkFilter =
695 estate->es_result_relation_info->ri_junkFilter;
699 /* Normal case with just one JunkFilter */
700 JunkFilter *j = ExecInitJunkFilter(plan->targetlist,
703 estate->es_junkFilter = j;
704 if (estate->es_result_relation_info)
705 estate->es_result_relation_info->ri_junkFilter = j;
707 /* For SELECT, want to return the cleaned tuple type */
708 if (operation == CMD_SELECT)
709 tupType = j->jf_cleanTupType;
713 estate->es_junkFilter = NULL;
717 * initialize the "into" relation
719 intoRelationDesc = (Relation) NULL;
721 if (operation == CMD_SELECT)
727 if (!parseTree->isPortal)
731 * a select into table
733 if (parseTree->into != NULL)
737 * create the "into" relation
739 intoName = parseTree->into;
742 * have to copy tupType to get rid of constraints
744 tupdesc = CreateTupleDescCopy(tupType);
747 heap_create_with_catalog(intoName,
751 allowSystemTableMods);
753 FreeTupleDesc(tupdesc);
756 * Advance command counter so that the newly-created
757 * relation's catalog tuples will be visible to heap_open.
759 CommandCounterIncrement();
762 * If necessary, create a TOAST table for the into
763 * relation. Note that AlterTableCreateToastTable ends
764 * with CommandCounterIncrement(), so that the TOAST table
765 * will be visible for insertion.
767 AlterTableCreateToastTable(intoName, true);
769 intoRelationDesc = heap_open(intoRelationId,
770 AccessExclusiveLock);
775 estate->es_into_relation_descriptor = intoRelationDesc;
777 estate->es_origPlan = plan;
778 estate->es_evalPlanQual = NULL;
779 estate->es_evTuple = NULL;
780 estate->es_useEvalPlan = false;
786 * Initialize ResultRelInfo data for one result relation
789 initResultRelInfo(ResultRelInfo *resultRelInfo,
790 Index resultRelationIndex,
794 Oid resultRelationOid;
795 Relation resultRelationDesc;
797 resultRelationOid = getrelid(resultRelationIndex, rangeTable);
798 resultRelationDesc = heap_open(resultRelationOid, RowExclusiveLock);
800 switch (resultRelationDesc->rd_rel->relkind)
802 case RELKIND_SEQUENCE:
803 elog(ERROR, "You can't change sequence relation %s",
804 RelationGetRelationName(resultRelationDesc));
806 case RELKIND_TOASTVALUE:
807 elog(ERROR, "You can't change toast relation %s",
808 RelationGetRelationName(resultRelationDesc));
811 elog(ERROR, "You can't change view relation %s",
812 RelationGetRelationName(resultRelationDesc));
816 MemSet(resultRelInfo, 0, sizeof(ResultRelInfo));
817 resultRelInfo->type = T_ResultRelInfo;
818 resultRelInfo->ri_RangeTableIndex = resultRelationIndex;
819 resultRelInfo->ri_RelationDesc = resultRelationDesc;
820 resultRelInfo->ri_NumIndices = 0;
821 resultRelInfo->ri_IndexRelationDescs = NULL;
822 resultRelInfo->ri_IndexRelationInfo = NULL;
823 resultRelInfo->ri_ConstraintExprs = NULL;
824 resultRelInfo->ri_junkFilter = NULL;
827 * If there are indices on the result relation, open them and save
828 * descriptors in the result relation info, so that we can add new
829 * index entries for the tuples we add/update. We need not do this
830 * for a DELETE, however, since deletion doesn't affect indexes.
832 if (resultRelationDesc->rd_rel->relhasindex &&
833 operation != CMD_DELETE)
834 ExecOpenIndices(resultRelInfo);
837 /* ----------------------------------------------------------------
840 * Cleans up the query plan -- closes files and free up storages
841 * ----------------------------------------------------------------
844 EndPlan(Plan *plan, EState *estate)
846 ResultRelInfo *resultRelInfo;
851 * shut down any PlanQual processing we were doing
853 if (estate->es_evalPlanQual != NULL)
854 EndEvalPlanQual(estate);
857 * shut down the node-type-specific query processing
859 ExecEndNode(plan, plan);
862 * destroy the executor "tuple" table.
864 ExecDropTupleTable(estate->es_tupleTable, true);
865 estate->es_tupleTable = NULL;
868 * close the result relation(s) if any, but hold locks until xact
869 * commit. Also clean up junkfilters if present.
871 resultRelInfo = estate->es_result_relations;
872 for (i = estate->es_num_result_relations; i > 0; i--)
874 /* Close indices and then the relation itself */
875 ExecCloseIndices(resultRelInfo);
876 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
877 /* Delete the junkfilter if any */
878 if (resultRelInfo->ri_junkFilter != NULL)
879 ExecFreeJunkFilter(resultRelInfo->ri_junkFilter);
884 * close the "into" relation if necessary, again keeping lock
886 if (estate->es_into_relation_descriptor != NULL)
887 heap_close(estate->es_into_relation_descriptor, NoLock);
890 * There might be a junkfilter without a result relation.
892 if (estate->es_num_result_relations == 0 &&
893 estate->es_junkFilter != NULL)
895 ExecFreeJunkFilter(estate->es_junkFilter);
896 estate->es_junkFilter = NULL;
900 * close any relations selected FOR UPDATE, again keeping locks
902 foreach(l, estate->es_rowMark)
904 execRowMark *erm = lfirst(l);
906 heap_close(erm->relation, NoLock);
910 /* ----------------------------------------------------------------
913 * processes the query plan to retrieve 'numberTuples' tuples in the
914 * direction specified.
915 * Retrieves all tuples if tupleCount is 0
917 * result is either a slot containing the last tuple in the case
918 * of a RETRIEVE or NULL otherwise.
920 * Note: the ctid attribute is a 'junk' attribute that is removed before the
922 * ----------------------------------------------------------------
924 static TupleTableSlot *
925 ExecutePlan(EState *estate,
929 ScanDirection direction,
930 DestReceiver *destfunc)
932 JunkFilter *junkfilter;
933 TupleTableSlot *slot;
934 ItemPointer tupleid = NULL;
935 ItemPointerData tuple_ctid;
936 long current_tuple_count;
937 TupleTableSlot *result;
940 * initialize local variables
943 current_tuple_count = 0;
949 estate->es_direction = direction;
952 * Loop until we've processed the proper number of tuples from the
958 /* Reset the per-output-tuple exprcontext */
959 ResetPerTupleExprContext(estate);
962 * Execute the plan and obtain a tuple
964 /* at the top level, the parent of a plan (2nd arg) is itself */
966 if (estate->es_useEvalPlan)
968 slot = EvalPlanQualNext(estate);
970 slot = ExecProcNode(plan, plan);
973 slot = ExecProcNode(plan, plan);
976 * if the tuple is null, then we assume there is nothing more to
977 * process so we just return null...
986 * if we have a junk filter, then project a new tuple with the
989 * Store this new "clean" tuple in the place of the original tuple.
991 * Also, extract all the junk information we need.
993 if ((junkfilter = estate->es_junkFilter) != (JunkFilter *) NULL)
1000 * extract the 'ctid' junk attribute.
1002 if (operation == CMD_UPDATE || operation == CMD_DELETE)
1004 if (!ExecGetJunkAttribute(junkfilter,
1009 elog(ERROR, "ExecutePlan: NO (junk) `ctid' was found!");
1011 /* shouldn't ever get a null result... */
1013 elog(ERROR, "ExecutePlan: (junk) `ctid' is NULL!");
1015 tupleid = (ItemPointer) DatumGetPointer(datum);
1016 tuple_ctid = *tupleid; /* make sure we don't free the
1018 tupleid = &tuple_ctid;
1020 else if (estate->es_rowMark != NIL)
1025 foreach(l, estate->es_rowMark)
1027 execRowMark *erm = lfirst(l);
1029 HeapTupleData tuple;
1030 TupleTableSlot *newSlot;
1033 if (!ExecGetJunkAttribute(junkfilter,
1038 elog(ERROR, "ExecutePlan: NO (junk) `%s' was found!",
1042 * Unlike the UPDATE/DELETE case, a null result is
1043 * possible here, when the referenced table is on the
1044 * nullable side of an outer join. Ignore nulls.
1049 tuple.t_self = *((ItemPointer) DatumGetPointer(datum));
1050 test = heap_mark4update(erm->relation, &tuple, &buffer);
1051 ReleaseBuffer(buffer);
1054 case HeapTupleSelfUpdated:
1055 case HeapTupleMayBeUpdated:
1058 case HeapTupleUpdated:
1059 if (XactIsoLevel == XACT_SERIALIZABLE)
1060 elog(ERROR, "Can't serialize access due to concurrent update");
1061 if (!(ItemPointerEquals(&(tuple.t_self),
1062 (ItemPointer) DatumGetPointer(datum))))
1064 newSlot = EvalPlanQual(estate, erm->rti, &(tuple.t_self));
1065 if (!(TupIsNull(newSlot)))
1068 estate->es_useEvalPlan = true;
1074 * if tuple was deleted or PlanQual failed for
1075 * updated tuple - we have not return this
1081 elog(ERROR, "Unknown status %u from heap_mark4update", test);
1088 * Finally create a new "clean" tuple with all junk attributes
1091 newTuple = ExecRemoveJunk(junkfilter, slot);
1093 slot = ExecStoreTuple(newTuple, /* tuple to store */
1094 slot, /* destination slot */
1095 InvalidBuffer, /* this tuple has no
1097 true); /* tuple should be pfreed */
1098 } /* if (junkfilter... */
1101 * now that we have a tuple, do the appropriate thing with it..
1102 * either return it to the user, add it to a relation someplace,
1103 * delete it from a relation, or modify some of its attributes.
1109 ExecRetrieve(slot, /* slot containing tuple */
1110 destfunc, /* destination's tuple-receiver
1117 ExecAppend(slot, tupleid, estate);
1122 ExecDelete(slot, tupleid, estate);
1127 ExecReplace(slot, tupleid, estate);
1132 elog(DEBUG, "ExecutePlan: unknown operation in queryDesc");
1138 * check our tuple count.. if we've processed the proper number
1139 * then quit, else loop again and process more tuples..
1141 current_tuple_count++;
1142 if (numberTuples == current_tuple_count)
1147 * here, result is either a slot containing a tuple in the case of a
1148 * RETRIEVE or NULL otherwise.
1153 /* ----------------------------------------------------------------
1156 * RETRIEVEs are easy.. we just pass the tuple to the appropriate
1157 * print function. The only complexity is when we do a
1158 * "retrieve into", in which case we insert the tuple into
1159 * the appropriate relation (note: this is a newly created relation
1160 * so we don't need to worry about indices or locks.)
1161 * ----------------------------------------------------------------
1164 ExecRetrieve(TupleTableSlot *slot,
1165 DestReceiver *destfunc,
1172 * get the heap tuple out of the tuple table slot
1175 attrtype = slot->ttc_tupleDescriptor;
1178 * insert the tuple into the "into relation"
1180 if (estate->es_into_relation_descriptor != NULL)
1182 heap_insert(estate->es_into_relation_descriptor, tuple);
1187 * send the tuple to the front end (or the screen)
1189 (*destfunc->receiveTuple) (tuple, attrtype, destfunc);
1191 (estate->es_processed)++;
1194 /* ----------------------------------------------------------------
1197 * APPENDs are trickier.. we have to insert the tuple into
1198 * the base relation and insert appropriate tuples into the
1200 * ----------------------------------------------------------------
1204 ExecAppend(TupleTableSlot *slot,
1205 ItemPointer tupleid,
1209 ResultRelInfo *resultRelInfo;
1210 Relation resultRelationDesc;
1215 * get the heap tuple out of the tuple table slot
1220 * get information on the (current) result relation
1222 resultRelInfo = estate->es_result_relation_info;
1223 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1225 /* BEFORE ROW INSERT Triggers */
1226 if (resultRelationDesc->trigdesc &&
1227 resultRelationDesc->trigdesc->n_before_row[TRIGGER_EVENT_INSERT] > 0)
1231 newtuple = ExecBRInsertTriggers(estate, resultRelationDesc, tuple);
1233 if (newtuple == NULL) /* "do nothing" */
1236 if (newtuple != tuple) /* modified by Trigger(s) */
1240 * Insert modified tuple into tuple table slot, replacing the
1241 * original. We assume that it was allocated in per-tuple
1242 * memory context, and therefore will go away by itself. The
1243 * tuple table slot should not try to clear it.
1245 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1251 * Check the constraints of the tuple
1253 if (resultRelationDesc->rd_att->constr)
1254 ExecConstraints("ExecAppend", resultRelInfo, slot, estate);
1259 newId = heap_insert(resultRelationDesc, tuple);
1262 (estate->es_processed)++;
1263 estate->es_lastoid = newId;
1268 * Note: heap_insert adds a new tuple to a relation. As a side effect,
1269 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1272 numIndices = resultRelInfo->ri_NumIndices;
1274 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, false);
1276 /* AFTER ROW INSERT Triggers */
1277 if (resultRelationDesc->trigdesc)
1278 ExecARInsertTriggers(estate, resultRelationDesc, tuple);
1281 /* ----------------------------------------------------------------
1284 * DELETE is like append, we delete the tuple and its
1286 * ----------------------------------------------------------------
1289 ExecDelete(TupleTableSlot *slot,
1290 ItemPointer tupleid,
1293 ResultRelInfo *resultRelInfo;
1294 Relation resultRelationDesc;
1295 ItemPointerData ctid;
1299 * get information on the (current) result relation
1301 resultRelInfo = estate->es_result_relation_info;
1302 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1304 /* BEFORE ROW DELETE Triggers */
1305 if (resultRelationDesc->trigdesc &&
1306 resultRelationDesc->trigdesc->n_before_row[TRIGGER_EVENT_DELETE] > 0)
1310 dodelete = ExecBRDeleteTriggers(estate, tupleid);
1312 if (!dodelete) /* "do nothing" */
1320 result = heap_delete(resultRelationDesc, tupleid, &ctid);
1323 case HeapTupleSelfUpdated:
1326 case HeapTupleMayBeUpdated:
1329 case HeapTupleUpdated:
1330 if (XactIsoLevel == XACT_SERIALIZABLE)
1331 elog(ERROR, "Can't serialize access due to concurrent update");
1332 else if (!(ItemPointerEquals(tupleid, &ctid)))
1334 TupleTableSlot *epqslot = EvalPlanQual(estate,
1335 resultRelInfo->ri_RangeTableIndex, &ctid);
1337 if (!TupIsNull(epqslot))
1346 elog(ERROR, "Unknown status %u from heap_delete", result);
1351 (estate->es_processed)++;
1354 * Note: Normally one would think that we have to delete index tuples
1355 * associated with the heap tuple now..
1357 * ... but in POSTGRES, we have no need to do this because the vacuum
1358 * daemon automatically opens an index scan and deletes index tuples
1359 * when it finds deleted heap tuples. -cim 9/27/89
1362 /* AFTER ROW DELETE Triggers */
1363 if (resultRelationDesc->trigdesc)
1364 ExecARDeleteTriggers(estate, tupleid);
1367 /* ----------------------------------------------------------------
1370 * note: we can't run replace queries with transactions
1371 * off because replaces are actually appends and our
1372 * scan will mistakenly loop forever, replacing the tuple
1373 * it just appended.. This should be fixed but until it
1374 * is, we don't want to get stuck in an infinite loop
1375 * which corrupts your database..
1376 * ----------------------------------------------------------------
1379 ExecReplace(TupleTableSlot *slot,
1380 ItemPointer tupleid,
1384 ResultRelInfo *resultRelInfo;
1385 Relation resultRelationDesc;
1386 ItemPointerData ctid;
1391 * abort the operation if not running transactions
1393 if (IsBootstrapProcessingMode())
1395 elog(NOTICE, "ExecReplace: replace can't run without transactions");
1400 * get the heap tuple out of the tuple table slot
1405 * get information on the (current) result relation
1407 resultRelInfo = estate->es_result_relation_info;
1408 resultRelationDesc = resultRelInfo->ri_RelationDesc;
1410 /* BEFORE ROW UPDATE Triggers */
1411 if (resultRelationDesc->trigdesc &&
1412 resultRelationDesc->trigdesc->n_before_row[TRIGGER_EVENT_UPDATE] > 0)
1416 newtuple = ExecBRUpdateTriggers(estate, tupleid, tuple);
1418 if (newtuple == NULL) /* "do nothing" */
1421 if (newtuple != tuple) /* modified by Trigger(s) */
1425 * Insert modified tuple into tuple table slot, replacing the
1426 * original. We assume that it was allocated in per-tuple
1427 * memory context, and therefore will go away by itself. The
1428 * tuple table slot should not try to clear it.
1430 ExecStoreTuple(newtuple, slot, InvalidBuffer, false);
1436 * Check the constraints of the tuple
1438 if (resultRelationDesc->rd_att->constr)
1439 ExecConstraints("ExecReplace", resultRelInfo, slot, estate);
1442 * replace the heap tuple
1445 result = heap_update(resultRelationDesc, tupleid, tuple, &ctid);
1448 case HeapTupleSelfUpdated:
1451 case HeapTupleMayBeUpdated:
1454 case HeapTupleUpdated:
1455 if (XactIsoLevel == XACT_SERIALIZABLE)
1456 elog(ERROR, "Can't serialize access due to concurrent update");
1457 else if (!(ItemPointerEquals(tupleid, &ctid)))
1459 TupleTableSlot *epqslot = EvalPlanQual(estate,
1460 resultRelInfo->ri_RangeTableIndex, &ctid);
1462 if (!TupIsNull(epqslot))
1465 tuple = ExecRemoveJunk(estate->es_junkFilter, epqslot);
1466 slot = ExecStoreTuple(tuple, slot, InvalidBuffer, true);
1473 elog(ERROR, "Unknown status %u from heap_update", result);
1478 (estate->es_processed)++;
1481 * Note: instead of having to update the old index tuples associated
1482 * with the heap tuple, all we do is form and insert new index tuples.
1483 * This is because replaces are actually deletes and inserts and index
1484 * tuple deletion is done automagically by the vacuum daemon. All we
1485 * do is insert new index tuples. -cim 9/27/89
1491 * heap_update updates a tuple in the base relation by invalidating it
1492 * and then appending a new tuple to the relation. As a side effect,
1493 * the tupleid of the new tuple is placed in the new tuple's t_ctid
1494 * field. So we now insert index tuples using the new tupleid stored
1498 numIndices = resultRelInfo->ri_NumIndices;
1500 ExecInsertIndexTuples(slot, &(tuple->t_self), estate, true);
1502 /* AFTER ROW UPDATE Triggers */
1503 if (resultRelationDesc->trigdesc)
1504 ExecARUpdateTriggers(estate, tupleid, tuple);
1508 ExecRelCheck(ResultRelInfo *resultRelInfo,
1509 TupleTableSlot *slot, EState *estate)
1511 Relation rel = resultRelInfo->ri_RelationDesc;
1512 int ncheck = rel->rd_att->constr->num_check;
1513 ConstrCheck *check = rel->rd_att->constr->check;
1514 ExprContext *econtext;
1515 MemoryContext oldContext;
1520 * If first time through for this result relation, build expression
1521 * nodetrees for rel's constraint expressions. Keep them in the
1522 * per-query memory context so they'll survive throughout the query.
1524 if (resultRelInfo->ri_ConstraintExprs == NULL)
1526 oldContext = MemoryContextSwitchTo(estate->es_query_cxt);
1527 resultRelInfo->ri_ConstraintExprs =
1528 (List **) palloc(ncheck * sizeof(List *));
1529 for (i = 0; i < ncheck; i++)
1531 qual = (List *) stringToNode(check[i].ccbin);
1532 resultRelInfo->ri_ConstraintExprs[i] = qual;
1534 MemoryContextSwitchTo(oldContext);
1538 * We will use the EState's per-tuple context for evaluating
1539 * constraint expressions (creating it if it's not already there).
1541 econtext = GetPerTupleExprContext(estate);
1543 /* Arrange for econtext's scan tuple to be the tuple under test */
1544 econtext->ecxt_scantuple = slot;
1546 /* And evaluate the constraints */
1547 for (i = 0; i < ncheck; i++)
1549 qual = resultRelInfo->ri_ConstraintExprs[i];
1552 * NOTE: SQL92 specifies that a NULL result from a constraint
1553 * expression is not to be treated as a failure. Therefore, tell
1554 * ExecQual to return TRUE for NULL.
1556 if (!ExecQual(qual, econtext, true))
1557 return check[i].ccname;
1560 /* NULL result means no error */
1561 return (char *) NULL;
1565 ExecConstraints(char *caller, ResultRelInfo *resultRelInfo,
1566 TupleTableSlot *slot, EState *estate)
1568 Relation rel = resultRelInfo->ri_RelationDesc;
1569 HeapTuple tuple = slot->val;
1570 TupleConstr *constr = rel->rd_att->constr;
1574 if (constr->has_not_null)
1576 int natts = rel->rd_att->natts;
1579 for (attrChk = 1; attrChk <= natts; attrChk++)
1581 if (rel->rd_att->attrs[attrChk - 1]->attnotnull &&
1582 heap_attisnull(tuple, attrChk))
1583 elog(ERROR, "%s: Fail to add null value in not null attribute %s",
1584 caller, NameStr(rel->rd_att->attrs[attrChk - 1]->attname));
1588 if (constr->num_check > 0)
1592 if ((failed = ExecRelCheck(resultRelInfo, slot, estate)) != NULL)
1593 elog(ERROR, "%s: rejected due to CHECK constraint %s",
1599 EvalPlanQual(EState *estate, Index rti, ItemPointer tid)
1601 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1602 evalPlanQual *oldepq;
1603 EState *epqstate = NULL;
1606 HeapTupleData tuple;
1607 bool endNode = true;
1611 if (epq != NULL && epq->rti == 0)
1613 Assert(!(estate->es_useEvalPlan) &&
1614 epq->estate.es_evalPlanQual == NULL);
1620 * If this is request for another RTE - Ra, - then we have to check
1621 * wasn't PlanQual requested for Ra already and if so then Ra' row was
1622 * updated again and we have to re-start old execution for Ra and
1623 * forget all what we done after Ra was suspended. Cool? -:))
1625 if (epq != NULL && epq->rti != rti &&
1626 epq->estate.es_evTuple[rti - 1] != NULL)
1630 /* pop previous PlanQual from the stack */
1631 epqstate = &(epq->estate);
1632 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1633 Assert(oldepq->rti != 0);
1634 /* stop execution */
1635 ExecEndNode(epq->plan, epq->plan);
1636 epqstate->es_tupleTable->next = 0;
1637 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1638 epqstate->es_evTuple[epq->rti - 1] = NULL;
1639 /* push current PQ to freePQ stack */
1642 } while (epq->rti != rti);
1643 estate->es_evalPlanQual = (Pointer) epq;
1647 * If we are requested for another RTE then we have to suspend
1648 * execution of current PlanQual and start execution for new one.
1650 if (epq == NULL || epq->rti != rti)
1652 /* try to reuse plan used previously */
1653 evalPlanQual *newepq = (epq != NULL) ? epq->free : NULL;
1655 if (newepq == NULL) /* first call or freePQ stack is empty */
1657 newepq = (evalPlanQual *) palloc(sizeof(evalPlanQual));
1659 epqstate = &(newepq->estate);
1660 memset(epqstate, 0, sizeof(EState));
1661 epqstate->type = T_EState;
1662 epqstate->es_direction = ForwardScanDirection;
1663 epqstate->es_snapshot = estate->es_snapshot;
1664 epqstate->es_range_table = estate->es_range_table;
1665 epqstate->es_param_list_info = estate->es_param_list_info;
1666 if (estate->es_origPlan->nParamExec > 0)
1667 epqstate->es_param_exec_vals = (ParamExecData *)
1668 palloc(estate->es_origPlan->nParamExec *
1669 sizeof(ParamExecData));
1670 epqstate->es_tupleTable =
1671 ExecCreateTupleTable(estate->es_tupleTable->size);
1673 newepq->plan = copyObject(estate->es_origPlan);
1674 newepq->free = NULL;
1675 epqstate->es_evTupleNull = (bool *)
1676 palloc(length(estate->es_range_table) * sizeof(bool));
1677 if (epq == NULL) /* first call */
1679 epqstate->es_evTuple = (HeapTuple *)
1680 palloc(length(estate->es_range_table) * sizeof(HeapTuple));
1681 memset(epqstate->es_evTuple, 0,
1682 length(estate->es_range_table) * sizeof(HeapTuple));
1685 epqstate->es_evTuple = epq->estate.es_evTuple;
1688 epqstate = &(newepq->estate);
1689 /* push current PQ to the stack */
1690 epqstate->es_evalPlanQual = (Pointer) epq;
1692 estate->es_evalPlanQual = (Pointer) epq;
1697 epqstate = &(epq->estate);
1700 * Ok - we're requested for the same RTE (-:)). I'm not sure about
1701 * ability to use ExecReScan instead of ExecInitNode, so...
1705 ExecEndNode(epq->plan, epq->plan);
1706 epqstate->es_tupleTable->next = 0;
1709 /* free old RTE' tuple */
1710 if (epqstate->es_evTuple[epq->rti - 1] != NULL)
1712 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1713 epqstate->es_evTuple[epq->rti - 1] = NULL;
1716 /* ** fetch tid tuple ** */
1717 if (estate->es_result_relation_info != NULL &&
1718 estate->es_result_relation_info->ri_RangeTableIndex == rti)
1719 relation = estate->es_result_relation_info->ri_RelationDesc;
1724 foreach(l, estate->es_rowMark)
1726 if (((execRowMark *) lfirst(l))->rti == rti)
1729 relation = ((execRowMark *) lfirst(l))->relation;
1731 tuple.t_self = *tid;
1734 heap_fetch(relation, SnapshotDirty, &tuple, &buffer);
1735 if (tuple.t_data != NULL)
1737 TransactionId xwait = SnapshotDirty->xmax;
1739 if (TransactionIdIsValid(SnapshotDirty->xmin))
1741 elog(NOTICE, "EvalPlanQual: t_xmin is uncommitted ?!");
1742 Assert(!TransactionIdIsValid(SnapshotDirty->xmin));
1743 elog(ERROR, "Aborting this transaction");
1747 * If tuple is being updated by other transaction then we have
1748 * to wait for its commit/abort.
1750 if (TransactionIdIsValid(xwait))
1752 ReleaseBuffer(buffer);
1753 XactLockTableWait(xwait);
1758 * Nice! We got tuple - now copy it.
1760 if (epqstate->es_evTuple[epq->rti - 1] != NULL)
1761 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1762 epqstate->es_evTuple[epq->rti - 1] = heap_copytuple(&tuple);
1763 ReleaseBuffer(buffer);
1768 * Ops! Invalid tuple. Have to check is it updated or deleted.
1769 * Note that it's possible to get invalid SnapshotDirty->tid if
1770 * tuple updated by this transaction. Have we to check this ?
1772 if (ItemPointerIsValid(&(SnapshotDirty->tid)) &&
1773 !(ItemPointerEquals(&(tuple.t_self), &(SnapshotDirty->tid))))
1775 tuple.t_self = SnapshotDirty->tid; /* updated ... */
1780 * Deleted or updated by this transaction. Do not (re-)start
1781 * execution of this PQ. Continue previous PQ.
1783 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1786 Assert(oldepq->rti != 0);
1787 /* push current PQ to freePQ stack */
1790 epqstate = &(epq->estate);
1791 estate->es_evalPlanQual = (Pointer) epq;
1795 epq->rti = 0; /* this is the first (oldest) */
1796 estate->es_useEvalPlan = false; /* PQ - mark as free and */
1797 return (NULL); /* continue Query execution */
1801 if (estate->es_origPlan->nParamExec > 0)
1802 memset(epqstate->es_param_exec_vals, 0,
1803 estate->es_origPlan->nParamExec * sizeof(ParamExecData));
1804 memset(epqstate->es_evTupleNull, false,
1805 length(estate->es_range_table) * sizeof(bool));
1806 Assert(epqstate->es_tupleTable->next == 0);
1807 ExecInitNode(epq->plan, epqstate, NULL);
1810 * For UPDATE/DELETE we have to return tid of actual row we're
1813 *tid = tuple.t_self;
1815 return EvalPlanQualNext(estate);
1818 static TupleTableSlot *
1819 EvalPlanQualNext(EState *estate)
1821 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1822 EState *epqstate = &(epq->estate);
1823 evalPlanQual *oldepq;
1824 TupleTableSlot *slot;
1826 Assert(epq->rti != 0);
1829 slot = ExecProcNode(epq->plan, epq->plan);
1832 * No more tuples for this PQ. Continue previous one.
1834 if (TupIsNull(slot))
1836 ExecEndNode(epq->plan, epq->plan);
1837 epqstate->es_tupleTable->next = 0;
1838 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1839 epqstate->es_evTuple[epq->rti - 1] = NULL;
1840 /* pop old PQ from the stack */
1841 oldepq = (evalPlanQual *) epqstate->es_evalPlanQual;
1842 if (oldepq == (evalPlanQual *) NULL)
1844 epq->rti = 0; /* this is the first (oldest) */
1845 estate->es_useEvalPlan = false; /* PQ - mark as free and */
1846 return (NULL); /* continue Query execution */
1848 Assert(oldepq->rti != 0);
1849 /* push current PQ to freePQ stack */
1852 epqstate = &(epq->estate);
1853 estate->es_evalPlanQual = (Pointer) epq;
1861 EndEvalPlanQual(EState *estate)
1863 evalPlanQual *epq = (evalPlanQual *) estate->es_evalPlanQual;
1864 EState *epqstate = &(epq->estate);
1865 evalPlanQual *oldepq;
1867 if (epq->rti == 0) /* plans already shutdowned */
1869 Assert(epq->estate.es_evalPlanQual == NULL);
1875 ExecEndNode(epq->plan, epq->plan);
1876 epqstate->es_tupleTable->next = 0;
1877 if (epqstate->es_evTuple[epq->rti - 1] != NULL)
1879 heap_freetuple(epqstate->es_evTuple[epq->rti - 1]);
1880 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 */
1890 Assert(oldepq->rti != 0);
1891 /* push current PQ to freePQ stack */
1894 epqstate = &(epq->estate);
1895 estate->es_evalPlanQual = (Pointer) epq;