1 /*-------------------------------------------------------------------------
4 * top level executor interface routines
11 * The old ExecutorMain() has been replaced by ExecutorStart(),
12 * ExecutorRun() and ExecutorEnd()
14 * These three procedures are the external interfaces to the executor.
15 * In each case, the query descriptor is required as an argument.
17 * ExecutorStart() must be called at the beginning of execution of any
18 * query plan and ExecutorEnd() should always be called at the end of
19 * execution of a plan.
21 * ExecutorRun accepts direction and count arguments that specify whether
22 * the plan is to be executed forwards, backwards, and for how many tuples.
24 * Portions Copyright (c) 1996-2010, PostgreSQL Global Development Group
25 * Portions Copyright (c) 1994, Regents of the University of California
29 * src/backend/executor/execMain.c
31 *-------------------------------------------------------------------------
35 #include "access/reloptions.h"
36 #include "access/sysattr.h"
37 #include "access/transam.h"
38 #include "access/xact.h"
39 #include "catalog/heap.h"
40 #include "catalog/namespace.h"
41 #include "catalog/toasting.h"
42 #include "commands/tablespace.h"
43 #include "commands/trigger.h"
44 #include "executor/execdebug.h"
45 #include "executor/instrument.h"
46 #include "miscadmin.h"
47 #include "optimizer/clauses.h"
48 #include "parser/parse_clause.h"
49 #include "parser/parsetree.h"
50 #include "storage/bufmgr.h"
51 #include "storage/lmgr.h"
52 #include "storage/smgr.h"
53 #include "tcop/utility.h"
54 #include "utils/acl.h"
55 #include "utils/lsyscache.h"
56 #include "utils/memutils.h"
57 #include "utils/snapmgr.h"
58 #include "utils/tqual.h"
61 /* Hooks for plugins to get control in ExecutorStart/Run/End() */
62 ExecutorStart_hook_type ExecutorStart_hook = NULL;
63 ExecutorRun_hook_type ExecutorRun_hook = NULL;
64 ExecutorEnd_hook_type ExecutorEnd_hook = NULL;
66 /* Hook for plugin to get control in ExecCheckRTPerms() */
67 ExecutorCheckPerms_hook_type ExecutorCheckPerms_hook = NULL;
69 /* decls for local routines only used within this module */
70 static void InitPlan(QueryDesc *queryDesc, int eflags);
71 static void ExecEndPlan(PlanState *planstate, EState *estate);
72 static void ExecutePlan(EState *estate, PlanState *planstate,
76 ScanDirection direction,
78 static bool ExecCheckRTEPerms(RangeTblEntry *rte);
79 static void ExecCheckXactReadOnly(PlannedStmt *plannedstmt);
80 static void EvalPlanQualStart(EPQState *epqstate, EState *parentestate,
82 static void OpenIntoRel(QueryDesc *queryDesc);
83 static void CloseIntoRel(QueryDesc *queryDesc);
84 static void intorel_startup(DestReceiver *self, int operation, TupleDesc typeinfo);
85 static void intorel_receive(TupleTableSlot *slot, DestReceiver *self);
86 static void intorel_shutdown(DestReceiver *self);
87 static void intorel_destroy(DestReceiver *self);
89 /* end of local decls */
92 /* ----------------------------------------------------------------
95 * This routine must be called at the beginning of any execution of any
98 * Takes a QueryDesc previously created by CreateQueryDesc (it's not real
99 * clear why we bother to separate the two functions, but...). The tupDesc
100 * field of the QueryDesc is filled in to describe the tuples that will be
101 * returned, and the internal fields (estate and planstate) are set up.
103 * eflags contains flag bits as described in executor.h.
105 * NB: the CurrentMemoryContext when this is called will become the parent
106 * of the per-query context used for this Executor invocation.
108 * We provide a function hook variable that lets loadable plugins
109 * get control when ExecutorStart is called. Such a plugin would
110 * normally call standard_ExecutorStart().
112 * ----------------------------------------------------------------
115 ExecutorStart(QueryDesc *queryDesc, int eflags)
117 if (ExecutorStart_hook)
118 (*ExecutorStart_hook) (queryDesc, eflags);
120 standard_ExecutorStart(queryDesc, eflags);
124 standard_ExecutorStart(QueryDesc *queryDesc, int eflags)
127 MemoryContext oldcontext;
129 /* sanity checks: queryDesc must not be started already */
130 Assert(queryDesc != NULL);
131 Assert(queryDesc->estate == NULL);
134 * If the transaction is read-only, we need to check if any writes are
135 * planned to non-temporary tables. EXPLAIN is considered read-only.
137 if (XactReadOnly && !(eflags & EXEC_FLAG_EXPLAIN_ONLY))
138 ExecCheckXactReadOnly(queryDesc->plannedstmt);
141 * Build EState, switch into per-query memory context for startup.
143 estate = CreateExecutorState();
144 queryDesc->estate = estate;
146 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
149 * Fill in external parameters, if any, from queryDesc; and allocate
150 * workspace for internal parameters
152 estate->es_param_list_info = queryDesc->params;
154 if (queryDesc->plannedstmt->nParamExec > 0)
155 estate->es_param_exec_vals = (ParamExecData *)
156 palloc0(queryDesc->plannedstmt->nParamExec * sizeof(ParamExecData));
159 * If non-read-only query, set the command ID to mark output tuples with
161 switch (queryDesc->operation)
164 /* SELECT INTO and SELECT FOR UPDATE/SHARE need to mark tuples */
165 if (queryDesc->plannedstmt->intoClause != NULL ||
166 queryDesc->plannedstmt->rowMarks != NIL)
167 estate->es_output_cid = GetCurrentCommandId(true);
173 estate->es_output_cid = GetCurrentCommandId(true);
177 elog(ERROR, "unrecognized operation code: %d",
178 (int) queryDesc->operation);
183 * Copy other important information into the EState
185 estate->es_snapshot = RegisterSnapshot(queryDesc->snapshot);
186 estate->es_crosscheck_snapshot = RegisterSnapshot(queryDesc->crosscheck_snapshot);
187 estate->es_instrument = queryDesc->instrument_options;
190 * Initialize the plan state tree
192 InitPlan(queryDesc, eflags);
194 MemoryContextSwitchTo(oldcontext);
197 /* ----------------------------------------------------------------
200 * This is the main routine of the executor module. It accepts
201 * the query descriptor from the traffic cop and executes the
204 * ExecutorStart must have been called already.
206 * If direction is NoMovementScanDirection then nothing is done
207 * except to start up/shut down the destination. Otherwise,
208 * we retrieve up to 'count' tuples in the specified direction.
210 * Note: count = 0 is interpreted as no portal limit, i.e., run to
213 * There is no return value, but output tuples (if any) are sent to
214 * the destination receiver specified in the QueryDesc; and the number
215 * of tuples processed at the top level can be found in
216 * estate->es_processed.
218 * We provide a function hook variable that lets loadable plugins
219 * get control when ExecutorRun is called. Such a plugin would
220 * normally call standard_ExecutorRun().
222 * ----------------------------------------------------------------
225 ExecutorRun(QueryDesc *queryDesc,
226 ScanDirection direction, long count)
228 if (ExecutorRun_hook)
229 (*ExecutorRun_hook) (queryDesc, direction, count);
231 standard_ExecutorRun(queryDesc, direction, count);
235 standard_ExecutorRun(QueryDesc *queryDesc,
236 ScanDirection direction, long count)
242 MemoryContext oldcontext;
245 Assert(queryDesc != NULL);
247 estate = queryDesc->estate;
249 Assert(estate != NULL);
252 * Switch into per-query memory context
254 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
256 /* Allow instrumentation of ExecutorRun overall runtime */
257 if (queryDesc->totaltime)
258 InstrStartNode(queryDesc->totaltime);
261 * extract information from the query descriptor and the query feature.
263 operation = queryDesc->operation;
264 dest = queryDesc->dest;
267 * startup tuple receiver, if we will be emitting tuples
269 estate->es_processed = 0;
270 estate->es_lastoid = InvalidOid;
272 sendTuples = (operation == CMD_SELECT ||
273 queryDesc->plannedstmt->hasReturning);
276 (*dest->rStartup) (dest, operation, queryDesc->tupDesc);
281 if (!ScanDirectionIsNoMovement(direction))
283 queryDesc->planstate,
291 * shutdown tuple receiver, if we started it
294 (*dest->rShutdown) (dest);
296 if (queryDesc->totaltime)
297 InstrStopNode(queryDesc->totaltime, estate->es_processed);
299 MemoryContextSwitchTo(oldcontext);
302 /* ----------------------------------------------------------------
305 * This routine must be called at the end of execution of any
308 * We provide a function hook variable that lets loadable plugins
309 * get control when ExecutorEnd is called. Such a plugin would
310 * normally call standard_ExecutorEnd().
312 * ----------------------------------------------------------------
315 ExecutorEnd(QueryDesc *queryDesc)
317 if (ExecutorEnd_hook)
318 (*ExecutorEnd_hook) (queryDesc);
320 standard_ExecutorEnd(queryDesc);
324 standard_ExecutorEnd(QueryDesc *queryDesc)
327 MemoryContext oldcontext;
330 Assert(queryDesc != NULL);
332 estate = queryDesc->estate;
334 Assert(estate != NULL);
337 * Switch into per-query memory context to run ExecEndPlan
339 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
341 ExecEndPlan(queryDesc->planstate, estate);
344 * Close the SELECT INTO relation if any
346 if (estate->es_select_into)
347 CloseIntoRel(queryDesc);
349 /* do away with our snapshots */
350 UnregisterSnapshot(estate->es_snapshot);
351 UnregisterSnapshot(estate->es_crosscheck_snapshot);
354 * Must switch out of context before destroying it
356 MemoryContextSwitchTo(oldcontext);
359 * Release EState and per-query memory context. This should release
360 * everything the executor has allocated.
362 FreeExecutorState(estate);
364 /* Reset queryDesc fields that no longer point to anything */
365 queryDesc->tupDesc = NULL;
366 queryDesc->estate = NULL;
367 queryDesc->planstate = NULL;
368 queryDesc->totaltime = NULL;
371 /* ----------------------------------------------------------------
374 * This routine may be called on an open queryDesc to rewind it
376 * ----------------------------------------------------------------
379 ExecutorRewind(QueryDesc *queryDesc)
382 MemoryContext oldcontext;
385 Assert(queryDesc != NULL);
387 estate = queryDesc->estate;
389 Assert(estate != NULL);
391 /* It's probably not sensible to rescan updating queries */
392 Assert(queryDesc->operation == CMD_SELECT);
395 * Switch into per-query memory context
397 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
402 ExecReScan(queryDesc->planstate);
404 MemoryContextSwitchTo(oldcontext);
410 * Check access permissions for all relations listed in a range table.
412 * Returns true if permissions are adequate. Otherwise, throws an appropriate
413 * error if ereport_on_violation is true, or simply returns false otherwise.
416 ExecCheckRTPerms(List *rangeTable, bool ereport_on_violation)
421 foreach(l, rangeTable)
423 RangeTblEntry *rte = (RangeTblEntry *) lfirst(l);
425 result = ExecCheckRTEPerms(rte);
428 Assert(rte->rtekind == RTE_RELATION);
429 if (ereport_on_violation)
430 aclcheck_error(ACLCHECK_NO_PRIV, ACL_KIND_CLASS,
431 get_rel_name(rte->relid));
436 if (ExecutorCheckPerms_hook)
437 result = (*ExecutorCheckPerms_hook)(rangeTable,
438 ereport_on_violation);
444 * Check access permissions for a single RTE.
447 ExecCheckRTEPerms(RangeTblEntry *rte)
449 AclMode requiredPerms;
451 AclMode remainingPerms;
458 * Only plain-relation RTEs need to be checked here. Function RTEs are
459 * checked by init_fcache when the function is prepared for execution.
460 * Join, subquery, and special RTEs need no checks.
462 if (rte->rtekind != RTE_RELATION)
466 * No work if requiredPerms is empty.
468 requiredPerms = rte->requiredPerms;
469 if (requiredPerms == 0)
475 * userid to check as: current user unless we have a setuid indication.
477 * Note: GetUserId() is presently fast enough that there's no harm in
478 * calling it separately for each RTE. If that stops being true, we could
479 * call it once in ExecCheckRTPerms and pass the userid down from there.
480 * But for now, no need for the extra clutter.
482 userid = rte->checkAsUser ? rte->checkAsUser : GetUserId();
485 * We must have *all* the requiredPerms bits, but some of the bits can be
486 * satisfied from column-level rather than relation-level permissions.
487 * First, remove any bits that are satisfied by relation permissions.
489 relPerms = pg_class_aclmask(relOid, userid, requiredPerms, ACLMASK_ALL);
490 remainingPerms = requiredPerms & ~relPerms;
491 if (remainingPerms != 0)
494 * If we lack any permissions that exist only as relation permissions,
495 * we can fail straight away.
497 if (remainingPerms & ~(ACL_SELECT | ACL_INSERT | ACL_UPDATE))
501 * Check to see if we have the needed privileges at column level.
503 * Note: failures just report a table-level error; it would be nicer
504 * to report a column-level error if we have some but not all of the
507 if (remainingPerms & ACL_SELECT)
510 * When the query doesn't explicitly reference any columns (for
511 * example, SELECT COUNT(*) FROM table), allow the query if we
512 * have SELECT on any column of the rel, as per SQL spec.
514 if (bms_is_empty(rte->selectedCols))
516 if (pg_attribute_aclcheck_all(relOid, userid, ACL_SELECT,
517 ACLMASK_ANY) != ACLCHECK_OK)
521 tmpset = bms_copy(rte->selectedCols);
522 while ((col = bms_first_member(tmpset)) >= 0)
524 /* remove the column number offset */
525 col += FirstLowInvalidHeapAttributeNumber;
526 if (col == InvalidAttrNumber)
528 /* Whole-row reference, must have priv on all cols */
529 if (pg_attribute_aclcheck_all(relOid, userid, ACL_SELECT,
530 ACLMASK_ALL) != ACLCHECK_OK)
535 if (pg_attribute_aclcheck(relOid, col, userid,
536 ACL_SELECT) != ACLCHECK_OK)
544 * Basically the same for the mod columns, with either INSERT or
545 * UPDATE privilege as specified by remainingPerms.
547 remainingPerms &= ~ACL_SELECT;
548 if (remainingPerms != 0)
551 * When the query doesn't explicitly change any columns, allow the
552 * query if we have permission on any column of the rel. This is
553 * to handle SELECT FOR UPDATE as well as possible corner cases in
556 if (bms_is_empty(rte->modifiedCols))
558 if (pg_attribute_aclcheck_all(relOid, userid, remainingPerms,
559 ACLMASK_ANY) != ACLCHECK_OK)
563 tmpset = bms_copy(rte->modifiedCols);
564 while ((col = bms_first_member(tmpset)) >= 0)
566 /* remove the column number offset */
567 col += FirstLowInvalidHeapAttributeNumber;
568 if (col == InvalidAttrNumber)
570 /* whole-row reference can't happen here */
571 elog(ERROR, "whole-row update is not implemented");
575 if (pg_attribute_aclcheck(relOid, col, userid,
576 remainingPerms) != ACLCHECK_OK)
587 * Check that the query does not imply any writes to non-temp tables.
589 * Note: in a Hot Standby slave this would need to reject writes to temp
590 * tables as well; but an HS slave can't have created any temp tables
591 * in the first place, so no need to check that.
594 ExecCheckXactReadOnly(PlannedStmt *plannedstmt)
599 * CREATE TABLE AS or SELECT INTO?
601 * XXX should we allow this if the destination is temp? Considering that
602 * it would still require catalog changes, probably not.
604 if (plannedstmt->intoClause != NULL)
605 PreventCommandIfReadOnly(CreateCommandTag((Node *) plannedstmt));
607 /* Fail if write permissions are requested on any non-temp table */
608 foreach(l, plannedstmt->rtable)
610 RangeTblEntry *rte = (RangeTblEntry *) lfirst(l);
612 if (rte->rtekind != RTE_RELATION)
615 if ((rte->requiredPerms & (~ACL_SELECT)) == 0)
618 if (isTempNamespace(get_rel_namespace(rte->relid)))
621 PreventCommandIfReadOnly(CreateCommandTag((Node *) plannedstmt));
626 /* ----------------------------------------------------------------
629 * Initializes the query plan: open files, allocate storage
630 * and start up the rule manager
631 * ----------------------------------------------------------------
634 InitPlan(QueryDesc *queryDesc, int eflags)
636 CmdType operation = queryDesc->operation;
637 PlannedStmt *plannedstmt = queryDesc->plannedstmt;
638 Plan *plan = plannedstmt->planTree;
639 List *rangeTable = plannedstmt->rtable;
640 EState *estate = queryDesc->estate;
641 PlanState *planstate;
647 * Do permissions checks
649 ExecCheckRTPerms(rangeTable, true);
652 * initialize the node's execution state
654 estate->es_range_table = rangeTable;
655 estate->es_plannedstmt = plannedstmt;
658 * initialize result relation stuff, and open/lock the result rels.
660 * We must do this before initializing the plan tree, else we might try to
661 * do a lock upgrade if a result rel is also a source rel.
663 if (plannedstmt->resultRelations)
665 List *resultRelations = plannedstmt->resultRelations;
666 int numResultRelations = list_length(resultRelations);
667 ResultRelInfo *resultRelInfos;
668 ResultRelInfo *resultRelInfo;
670 resultRelInfos = (ResultRelInfo *)
671 palloc(numResultRelations * sizeof(ResultRelInfo));
672 resultRelInfo = resultRelInfos;
673 foreach(l, resultRelations)
675 Index resultRelationIndex = lfirst_int(l);
676 Oid resultRelationOid;
677 Relation resultRelation;
679 resultRelationOid = getrelid(resultRelationIndex, rangeTable);
680 resultRelation = heap_open(resultRelationOid, RowExclusiveLock);
681 InitResultRelInfo(resultRelInfo,
685 estate->es_instrument);
688 estate->es_result_relations = resultRelInfos;
689 estate->es_num_result_relations = numResultRelations;
690 /* es_result_relation_info is NULL except when within ModifyTable */
691 estate->es_result_relation_info = NULL;
696 * if no result relation, then set state appropriately
698 estate->es_result_relations = NULL;
699 estate->es_num_result_relations = 0;
700 estate->es_result_relation_info = NULL;
704 * Similarly, we have to lock relations selected FOR UPDATE/FOR SHARE
705 * before we initialize the plan tree, else we'd be risking lock upgrades.
706 * While we are at it, build the ExecRowMark list.
708 estate->es_rowMarks = NIL;
709 foreach(l, plannedstmt->rowMarks)
711 PlanRowMark *rc = (PlanRowMark *) lfirst(l);
716 /* ignore "parent" rowmarks; they are irrelevant at runtime */
720 switch (rc->markType)
722 case ROW_MARK_EXCLUSIVE:
724 relid = getrelid(rc->rti, rangeTable);
725 relation = heap_open(relid, RowShareLock);
727 case ROW_MARK_REFERENCE:
728 relid = getrelid(rc->rti, rangeTable);
729 relation = heap_open(relid, AccessShareLock);
732 /* there's no real table here ... */
736 elog(ERROR, "unrecognized markType: %d", rc->markType);
737 relation = NULL; /* keep compiler quiet */
741 erm = (ExecRowMark *) palloc(sizeof(ExecRowMark));
742 erm->relation = relation;
744 erm->prti = rc->prti;
745 erm->markType = rc->markType;
746 erm->noWait = rc->noWait;
747 erm->ctidAttNo = rc->ctidAttNo;
748 erm->toidAttNo = rc->toidAttNo;
749 erm->wholeAttNo = rc->wholeAttNo;
750 ItemPointerSetInvalid(&(erm->curCtid));
751 estate->es_rowMarks = lappend(estate->es_rowMarks, erm);
755 * Detect whether we're doing SELECT INTO. If so, set the es_into_oids
756 * flag appropriately so that the plan tree will be initialized with the
757 * correct tuple descriptors. (Other SELECT INTO stuff comes later.)
759 estate->es_select_into = false;
760 if (operation == CMD_SELECT && plannedstmt->intoClause != NULL)
762 estate->es_select_into = true;
763 estate->es_into_oids = interpretOidsOption(plannedstmt->intoClause->options);
767 * Initialize the executor's tuple table to empty.
769 estate->es_tupleTable = NIL;
770 estate->es_trig_tuple_slot = NULL;
771 estate->es_trig_oldtup_slot = NULL;
773 /* mark EvalPlanQual not active */
774 estate->es_epqTuple = NULL;
775 estate->es_epqTupleSet = NULL;
776 estate->es_epqScanDone = NULL;
779 * Initialize private state information for each SubPlan. We must do this
780 * before running ExecInitNode on the main query tree, since
781 * ExecInitSubPlan expects to be able to find these entries.
783 Assert(estate->es_subplanstates == NIL);
784 i = 1; /* subplan indices count from 1 */
785 foreach(l, plannedstmt->subplans)
787 Plan *subplan = (Plan *) lfirst(l);
788 PlanState *subplanstate;
792 * A subplan will never need to do BACKWARD scan nor MARK/RESTORE. If
793 * it is a parameterless subplan (not initplan), we suggest that it be
794 * prepared to handle REWIND efficiently; otherwise there is no need.
796 sp_eflags = eflags & EXEC_FLAG_EXPLAIN_ONLY;
797 if (bms_is_member(i, plannedstmt->rewindPlanIDs))
798 sp_eflags |= EXEC_FLAG_REWIND;
800 subplanstate = ExecInitNode(subplan, estate, sp_eflags);
802 estate->es_subplanstates = lappend(estate->es_subplanstates,
809 * Initialize the private state information for all the nodes in the query
810 * tree. This opens files, allocates storage and leaves us ready to start
813 planstate = ExecInitNode(plan, estate, eflags);
816 * Get the tuple descriptor describing the type of tuples to return. (this
817 * is especially important if we are creating a relation with "SELECT
820 tupType = ExecGetResultType(planstate);
823 * Initialize the junk filter if needed. SELECT queries need a filter if
824 * there are any junk attrs in the top-level tlist.
826 if (operation == CMD_SELECT)
828 bool junk_filter_needed = false;
831 foreach(tlist, plan->targetlist)
833 TargetEntry *tle = (TargetEntry *) lfirst(tlist);
837 junk_filter_needed = true;
842 if (junk_filter_needed)
846 j = ExecInitJunkFilter(planstate->plan->targetlist,
848 ExecInitExtraTupleSlot(estate));
849 estate->es_junkFilter = j;
851 /* Want to return the cleaned tuple type */
852 tupType = j->jf_cleanTupType;
856 queryDesc->tupDesc = tupType;
857 queryDesc->planstate = planstate;
860 * If doing SELECT INTO, initialize the "into" relation. We must wait
861 * till now so we have the "clean" result tuple type to create the new
864 * If EXPLAIN, skip creating the "into" relation.
866 if (estate->es_select_into && !(eflags & EXEC_FLAG_EXPLAIN_ONLY))
867 OpenIntoRel(queryDesc);
871 * Initialize ResultRelInfo data for one result relation
874 InitResultRelInfo(ResultRelInfo *resultRelInfo,
875 Relation resultRelationDesc,
876 Index resultRelationIndex,
878 int instrument_options)
880 TriggerDesc *trigDesc = resultRelationDesc->trigdesc;
883 * Check valid relkind ... in most cases parser and/or planner should have
884 * noticed this already, but let's make sure. In the view case we do need
885 * a test here, because if the view wasn't rewritten by a rule, it had
886 * better have an INSTEAD trigger.
888 switch (resultRelationDesc->rd_rel->relkind)
890 case RELKIND_RELATION:
893 case RELKIND_SEQUENCE:
895 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
896 errmsg("cannot change sequence \"%s\"",
897 RelationGetRelationName(resultRelationDesc))));
899 case RELKIND_TOASTVALUE:
901 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
902 errmsg("cannot change TOAST relation \"%s\"",
903 RelationGetRelationName(resultRelationDesc))));
909 if (!trigDesc || !trigDesc->trig_insert_instead_row)
911 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
912 errmsg("cannot insert into view \"%s\"",
913 RelationGetRelationName(resultRelationDesc)),
914 errhint("You need an unconditional ON INSERT DO INSTEAD rule or an INSTEAD OF INSERT trigger.")));
917 if (!trigDesc || !trigDesc->trig_update_instead_row)
919 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
920 errmsg("cannot update view \"%s\"",
921 RelationGetRelationName(resultRelationDesc)),
922 errhint("You need an unconditional ON UPDATE DO INSTEAD rule or an INSTEAD OF UPDATE trigger.")));
925 if (!trigDesc || !trigDesc->trig_delete_instead_row)
927 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
928 errmsg("cannot delete from view \"%s\"",
929 RelationGetRelationName(resultRelationDesc)),
930 errhint("You need an unconditional ON DELETE DO INSTEAD rule or an INSTEAD OF DELETE trigger.")));
933 elog(ERROR, "unrecognized CmdType: %d", (int) operation);
939 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
940 errmsg("cannot change relation \"%s\"",
941 RelationGetRelationName(resultRelationDesc))));
945 /* OK, fill in the node */
946 MemSet(resultRelInfo, 0, sizeof(ResultRelInfo));
947 resultRelInfo->type = T_ResultRelInfo;
948 resultRelInfo->ri_RangeTableIndex = resultRelationIndex;
949 resultRelInfo->ri_RelationDesc = resultRelationDesc;
950 resultRelInfo->ri_NumIndices = 0;
951 resultRelInfo->ri_IndexRelationDescs = NULL;
952 resultRelInfo->ri_IndexRelationInfo = NULL;
953 /* make a copy so as not to depend on relcache info not changing... */
954 resultRelInfo->ri_TrigDesc = CopyTriggerDesc(trigDesc);
955 if (resultRelInfo->ri_TrigDesc)
957 int n = resultRelInfo->ri_TrigDesc->numtriggers;
959 resultRelInfo->ri_TrigFunctions = (FmgrInfo *)
960 palloc0(n * sizeof(FmgrInfo));
961 resultRelInfo->ri_TrigWhenExprs = (List **)
962 palloc0(n * sizeof(List *));
963 if (instrument_options)
964 resultRelInfo->ri_TrigInstrument = InstrAlloc(n, instrument_options);
968 resultRelInfo->ri_TrigFunctions = NULL;
969 resultRelInfo->ri_TrigWhenExprs = NULL;
970 resultRelInfo->ri_TrigInstrument = NULL;
972 resultRelInfo->ri_ConstraintExprs = NULL;
973 resultRelInfo->ri_junkFilter = NULL;
974 resultRelInfo->ri_projectReturning = NULL;
977 * If there are indices on the result relation, open them and save
978 * descriptors in the result relation info, so that we can add new index
979 * entries for the tuples we add/update. We need not do this for a
980 * DELETE, however, since deletion doesn't affect indexes.
982 if (resultRelationDesc->rd_rel->relhasindex &&
983 operation != CMD_DELETE)
984 ExecOpenIndices(resultRelInfo);
988 * ExecGetTriggerResultRel
990 * Get a ResultRelInfo for a trigger target relation. Most of the time,
991 * triggers are fired on one of the result relations of the query, and so
992 * we can just return a member of the es_result_relations array. (Note: in
993 * self-join situations there might be multiple members with the same OID;
994 * if so it doesn't matter which one we pick.) However, it is sometimes
995 * necessary to fire triggers on other relations; this happens mainly when an
996 * RI update trigger queues additional triggers on other relations, which will
997 * be processed in the context of the outer query. For efficiency's sake,
998 * we want to have a ResultRelInfo for those triggers too; that can avoid
999 * repeated re-opening of the relation. (It also provides a way for EXPLAIN
1000 * ANALYZE to report the runtimes of such triggers.) So we make additional
1001 * ResultRelInfo's as needed, and save them in es_trig_target_relations.
1004 ExecGetTriggerResultRel(EState *estate, Oid relid)
1006 ResultRelInfo *rInfo;
1010 MemoryContext oldcontext;
1012 /* First, search through the query result relations */
1013 rInfo = estate->es_result_relations;
1014 nr = estate->es_num_result_relations;
1017 if (RelationGetRelid(rInfo->ri_RelationDesc) == relid)
1022 /* Nope, but maybe we already made an extra ResultRelInfo for it */
1023 foreach(l, estate->es_trig_target_relations)
1025 rInfo = (ResultRelInfo *) lfirst(l);
1026 if (RelationGetRelid(rInfo->ri_RelationDesc) == relid)
1029 /* Nope, so we need a new one */
1032 * Open the target relation's relcache entry. We assume that an
1033 * appropriate lock is still held by the backend from whenever the trigger
1034 * event got queued, so we need take no new lock here.
1036 rel = heap_open(relid, NoLock);
1039 * Make the new entry in the right context. Currently, we don't need any
1040 * index information in ResultRelInfos used only for triggers, so tell
1041 * InitResultRelInfo it's a DELETE.
1043 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
1044 rInfo = makeNode(ResultRelInfo);
1045 InitResultRelInfo(rInfo,
1047 0, /* dummy rangetable index */
1049 estate->es_instrument);
1050 estate->es_trig_target_relations =
1051 lappend(estate->es_trig_target_relations, rInfo);
1052 MemoryContextSwitchTo(oldcontext);
1058 * ExecContextForcesOids
1060 * This is pretty grotty: when doing INSERT, UPDATE, or SELECT INTO,
1061 * we need to ensure that result tuples have space for an OID iff they are
1062 * going to be stored into a relation that has OIDs. In other contexts
1063 * we are free to choose whether to leave space for OIDs in result tuples
1064 * (we generally don't want to, but we do if a physical-tlist optimization
1065 * is possible). This routine checks the plan context and returns TRUE if the
1066 * choice is forced, FALSE if the choice is not forced. In the TRUE case,
1067 * *hasoids is set to the required value.
1069 * One reason this is ugly is that all plan nodes in the plan tree will emit
1070 * tuples with space for an OID, though we really only need the topmost node
1071 * to do so. However, node types like Sort don't project new tuples but just
1072 * return their inputs, and in those cases the requirement propagates down
1073 * to the input node. Eventually we might make this code smart enough to
1074 * recognize how far down the requirement really goes, but for now we just
1075 * make all plan nodes do the same thing if the top level forces the choice.
1077 * We assume that if we are generating tuples for INSERT or UPDATE,
1078 * estate->es_result_relation_info is already set up to describe the target
1079 * relation. Note that in an UPDATE that spans an inheritance tree, some of
1080 * the target relations may have OIDs and some not. We have to make the
1081 * decisions on a per-relation basis as we initialize each of the subplans of
1082 * the ModifyTable node, so ModifyTable has to set es_result_relation_info
1083 * while initializing each subplan.
1085 * SELECT INTO is even uglier, because we don't have the INTO relation's
1086 * descriptor available when this code runs; we have to look aside at a
1087 * flag set by InitPlan().
1090 ExecContextForcesOids(PlanState *planstate, bool *hasoids)
1092 ResultRelInfo *ri = planstate->state->es_result_relation_info;
1096 Relation rel = ri->ri_RelationDesc;
1100 *hasoids = rel->rd_rel->relhasoids;
1105 if (planstate->state->es_select_into)
1107 *hasoids = planstate->state->es_into_oids;
1114 /* ----------------------------------------------------------------
1117 * Cleans up the query plan -- closes files and frees up storage
1119 * NOTE: we are no longer very worried about freeing storage per se
1120 * in this code; FreeExecutorState should be guaranteed to release all
1121 * memory that needs to be released. What we are worried about doing
1122 * is closing relations and dropping buffer pins. Thus, for example,
1123 * tuple tables must be cleared or dropped to ensure pins are released.
1124 * ----------------------------------------------------------------
1127 ExecEndPlan(PlanState *planstate, EState *estate)
1129 ResultRelInfo *resultRelInfo;
1134 * shut down the node-type-specific query processing
1136 ExecEndNode(planstate);
1141 foreach(l, estate->es_subplanstates)
1143 PlanState *subplanstate = (PlanState *) lfirst(l);
1145 ExecEndNode(subplanstate);
1149 * destroy the executor's tuple table. Actually we only care about
1150 * releasing buffer pins and tupdesc refcounts; there's no need to pfree
1151 * the TupleTableSlots, since the containing memory context is about to go
1154 ExecResetTupleTable(estate->es_tupleTable, false);
1157 * close the result relation(s) if any, but hold locks until xact commit.
1159 resultRelInfo = estate->es_result_relations;
1160 for (i = estate->es_num_result_relations; i > 0; i--)
1162 /* Close indices and then the relation itself */
1163 ExecCloseIndices(resultRelInfo);
1164 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
1169 * likewise close any trigger target relations
1171 foreach(l, estate->es_trig_target_relations)
1173 resultRelInfo = (ResultRelInfo *) lfirst(l);
1174 /* Close indices and then the relation itself */
1175 ExecCloseIndices(resultRelInfo);
1176 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
1180 * close any relations selected FOR UPDATE/FOR SHARE, again keeping locks
1182 foreach(l, estate->es_rowMarks)
1184 ExecRowMark *erm = (ExecRowMark *) lfirst(l);
1187 heap_close(erm->relation, NoLock);
1191 /* ----------------------------------------------------------------
1194 * Processes the query plan until we have processed 'numberTuples' tuples,
1195 * moving in the specified direction.
1197 * Runs to completion if numberTuples is 0
1199 * Note: the ctid attribute is a 'junk' attribute that is removed before the
1201 * ----------------------------------------------------------------
1204 ExecutePlan(EState *estate,
1205 PlanState *planstate,
1209 ScanDirection direction,
1212 TupleTableSlot *slot;
1213 long current_tuple_count;
1216 * initialize local variables
1218 current_tuple_count = 0;
1221 * Set the direction.
1223 estate->es_direction = direction;
1226 * Loop until we've processed the proper number of tuples from the plan.
1230 /* Reset the per-output-tuple exprcontext */
1231 ResetPerTupleExprContext(estate);
1234 * Execute the plan and obtain a tuple
1236 slot = ExecProcNode(planstate);
1239 * if the tuple is null, then we assume there is nothing more to
1240 * process so we just end the loop...
1242 if (TupIsNull(slot))
1246 * If we have a junk filter, then project a new tuple with the junk
1249 * Store this new "clean" tuple in the junkfilter's resultSlot.
1250 * (Formerly, we stored it back over the "dirty" tuple, which is WRONG
1251 * because that tuple slot has the wrong descriptor.)
1253 if (estate->es_junkFilter != NULL)
1254 slot = ExecFilterJunk(estate->es_junkFilter, slot);
1257 * If we are supposed to send the tuple somewhere, do so. (In
1258 * practice, this is probably always the case at this point.)
1261 (*dest->receiveSlot) (slot, dest);
1264 * Count tuples processed, if this is a SELECT. (For other operation
1265 * types, the ModifyTable plan node must count the appropriate
1268 if (operation == CMD_SELECT)
1269 (estate->es_processed)++;
1272 * check our tuple count.. if we've processed the proper number then
1273 * quit, else loop again and process more tuples. Zero numberTuples
1276 current_tuple_count++;
1277 if (numberTuples && numberTuples == current_tuple_count)
1284 * ExecRelCheck --- check that tuple meets constraints for result relation
1287 ExecRelCheck(ResultRelInfo *resultRelInfo,
1288 TupleTableSlot *slot, EState *estate)
1290 Relation rel = resultRelInfo->ri_RelationDesc;
1291 int ncheck = rel->rd_att->constr->num_check;
1292 ConstrCheck *check = rel->rd_att->constr->check;
1293 ExprContext *econtext;
1294 MemoryContext oldContext;
1299 * If first time through for this result relation, build expression
1300 * nodetrees for rel's constraint expressions. Keep them in the per-query
1301 * memory context so they'll survive throughout the query.
1303 if (resultRelInfo->ri_ConstraintExprs == NULL)
1305 oldContext = MemoryContextSwitchTo(estate->es_query_cxt);
1306 resultRelInfo->ri_ConstraintExprs =
1307 (List **) palloc(ncheck * sizeof(List *));
1308 for (i = 0; i < ncheck; i++)
1310 /* ExecQual wants implicit-AND form */
1311 qual = make_ands_implicit(stringToNode(check[i].ccbin));
1312 resultRelInfo->ri_ConstraintExprs[i] = (List *)
1313 ExecPrepareExpr((Expr *) qual, estate);
1315 MemoryContextSwitchTo(oldContext);
1319 * We will use the EState's per-tuple context for evaluating constraint
1320 * expressions (creating it if it's not already there).
1322 econtext = GetPerTupleExprContext(estate);
1324 /* Arrange for econtext's scan tuple to be the tuple under test */
1325 econtext->ecxt_scantuple = slot;
1327 /* And evaluate the constraints */
1328 for (i = 0; i < ncheck; i++)
1330 qual = resultRelInfo->ri_ConstraintExprs[i];
1333 * NOTE: SQL92 specifies that a NULL result from a constraint
1334 * expression is not to be treated as a failure. Therefore, tell
1335 * ExecQual to return TRUE for NULL.
1337 if (!ExecQual(qual, econtext, true))
1338 return check[i].ccname;
1341 /* NULL result means no error */
1346 ExecConstraints(ResultRelInfo *resultRelInfo,
1347 TupleTableSlot *slot, EState *estate)
1349 Relation rel = resultRelInfo->ri_RelationDesc;
1350 TupleConstr *constr = rel->rd_att->constr;
1354 if (constr->has_not_null)
1356 int natts = rel->rd_att->natts;
1359 for (attrChk = 1; attrChk <= natts; attrChk++)
1361 if (rel->rd_att->attrs[attrChk - 1]->attnotnull &&
1362 slot_attisnull(slot, attrChk))
1364 (errcode(ERRCODE_NOT_NULL_VIOLATION),
1365 errmsg("null value in column \"%s\" violates not-null constraint",
1366 NameStr(rel->rd_att->attrs[attrChk - 1]->attname))));
1370 if (constr->num_check > 0)
1374 if ((failed = ExecRelCheck(resultRelInfo, slot, estate)) != NULL)
1376 (errcode(ERRCODE_CHECK_VIOLATION),
1377 errmsg("new row for relation \"%s\" violates check constraint \"%s\"",
1378 RelationGetRelationName(rel), failed)));
1384 * EvalPlanQual logic --- recheck modified tuple(s) to see if we want to
1385 * process the updated version under READ COMMITTED rules.
1387 * See backend/executor/README for some info about how this works.
1392 * Check a modified tuple to see if we want to process its updated version
1393 * under READ COMMITTED rules.
1395 * estate - outer executor state data
1396 * epqstate - state for EvalPlanQual rechecking
1397 * relation - table containing tuple
1398 * rti - rangetable index of table containing tuple
1399 * *tid - t_ctid from the outdated tuple (ie, next updated version)
1400 * priorXmax - t_xmax from the outdated tuple
1402 * *tid is also an output parameter: it's modified to hold the TID of the
1403 * latest version of the tuple (note this may be changed even on failure)
1405 * Returns a slot containing the new candidate update/delete tuple, or
1406 * NULL if we determine we shouldn't process the row.
1409 EvalPlanQual(EState *estate, EPQState *epqstate,
1410 Relation relation, Index rti,
1411 ItemPointer tid, TransactionId priorXmax)
1413 TupleTableSlot *slot;
1414 HeapTuple copyTuple;
1419 * Get and lock the updated version of the row; if fail, return NULL.
1421 copyTuple = EvalPlanQualFetch(estate, relation, LockTupleExclusive,
1424 if (copyTuple == NULL)
1428 * For UPDATE/DELETE we have to return tid of actual row we're executing
1431 *tid = copyTuple->t_self;
1434 * Need to run a recheck subquery. Initialize or reinitialize EPQ state.
1436 EvalPlanQualBegin(epqstate, estate);
1439 * Free old test tuple, if any, and store new tuple where relation's scan
1442 EvalPlanQualSetTuple(epqstate, rti, copyTuple);
1445 * Fetch any non-locked source rows
1447 EvalPlanQualFetchRowMarks(epqstate);
1450 * Run the EPQ query. We assume it will return at most one tuple.
1452 slot = EvalPlanQualNext(epqstate);
1455 * If we got a tuple, force the slot to materialize the tuple so that it
1456 * is not dependent on any local state in the EPQ query (in particular,
1457 * it's highly likely that the slot contains references to any pass-by-ref
1458 * datums that may be present in copyTuple). As with the next step, this
1459 * is to guard against early re-use of the EPQ query.
1461 if (!TupIsNull(slot))
1462 (void) ExecMaterializeSlot(slot);
1465 * Clear out the test tuple. This is needed in case the EPQ query is
1466 * re-used to test a tuple for a different relation. (Not clear that can
1467 * really happen, but let's be safe.)
1469 EvalPlanQualSetTuple(epqstate, rti, NULL);
1475 * Fetch a copy of the newest version of an outdated tuple
1477 * estate - executor state data
1478 * relation - table containing tuple
1479 * lockmode - requested tuple lock mode
1480 * *tid - t_ctid from the outdated tuple (ie, next updated version)
1481 * priorXmax - t_xmax from the outdated tuple
1483 * Returns a palloc'd copy of the newest tuple version, or NULL if we find
1484 * that there is no newest version (ie, the row was deleted not updated).
1485 * If successful, we have locked the newest tuple version, so caller does not
1486 * need to worry about it changing anymore.
1488 * Note: properly, lockmode should be declared as enum LockTupleMode,
1489 * but we use "int" to avoid having to include heapam.h in executor.h.
1492 EvalPlanQualFetch(EState *estate, Relation relation, int lockmode,
1493 ItemPointer tid, TransactionId priorXmax)
1495 HeapTuple copyTuple = NULL;
1496 HeapTupleData tuple;
1497 SnapshotData SnapshotDirty;
1500 * fetch target tuple
1502 * Loop here to deal with updated or busy tuples
1504 InitDirtySnapshot(SnapshotDirty);
1505 tuple.t_self = *tid;
1510 if (heap_fetch(relation, &SnapshotDirty, &tuple, &buffer, true, NULL))
1513 ItemPointerData update_ctid;
1514 TransactionId update_xmax;
1517 * If xmin isn't what we're expecting, the slot must have been
1518 * recycled and reused for an unrelated tuple. This implies that
1519 * the latest version of the row was deleted, so we need do
1520 * nothing. (Should be safe to examine xmin without getting
1521 * buffer's content lock, since xmin never changes in an existing
1524 if (!TransactionIdEquals(HeapTupleHeaderGetXmin(tuple.t_data),
1527 ReleaseBuffer(buffer);
1531 /* otherwise xmin should not be dirty... */
1532 if (TransactionIdIsValid(SnapshotDirty.xmin))
1533 elog(ERROR, "t_xmin is uncommitted in tuple to be updated");
1536 * If tuple is being updated by other transaction then we have to
1537 * wait for its commit/abort.
1539 if (TransactionIdIsValid(SnapshotDirty.xmax))
1541 ReleaseBuffer(buffer);
1542 XactLockTableWait(SnapshotDirty.xmax);
1543 continue; /* loop back to repeat heap_fetch */
1547 * If tuple was inserted by our own transaction, we have to check
1548 * cmin against es_output_cid: cmin >= current CID means our
1549 * command cannot see the tuple, so we should ignore it. Without
1550 * this we are open to the "Halloween problem" of indefinitely
1551 * re-updating the same tuple. (We need not check cmax because
1552 * HeapTupleSatisfiesDirty will consider a tuple deleted by our
1553 * transaction dead, regardless of cmax.) We just checked that
1554 * priorXmax == xmin, so we can test that variable instead of
1555 * doing HeapTupleHeaderGetXmin again.
1557 if (TransactionIdIsCurrentTransactionId(priorXmax) &&
1558 HeapTupleHeaderGetCmin(tuple.t_data) >= estate->es_output_cid)
1560 ReleaseBuffer(buffer);
1565 * This is a live tuple, so now try to lock it.
1567 test = heap_lock_tuple(relation, &tuple, &buffer,
1568 &update_ctid, &update_xmax,
1569 estate->es_output_cid,
1571 /* We now have two pins on the buffer, get rid of one */
1572 ReleaseBuffer(buffer);
1576 case HeapTupleSelfUpdated:
1577 /* treat it as deleted; do not process */
1578 ReleaseBuffer(buffer);
1581 case HeapTupleMayBeUpdated:
1582 /* successfully locked */
1585 case HeapTupleUpdated:
1586 ReleaseBuffer(buffer);
1587 if (IsolationUsesXactSnapshot())
1589 (errcode(ERRCODE_T_R_SERIALIZATION_FAILURE),
1590 errmsg("could not serialize access due to concurrent update")));
1591 if (!ItemPointerEquals(&update_ctid, &tuple.t_self))
1593 /* it was updated, so look at the updated version */
1594 tuple.t_self = update_ctid;
1595 /* updated row should have xmin matching this xmax */
1596 priorXmax = update_xmax;
1599 /* tuple was deleted, so give up */
1603 ReleaseBuffer(buffer);
1604 elog(ERROR, "unrecognized heap_lock_tuple status: %u",
1606 return NULL; /* keep compiler quiet */
1610 * We got tuple - now copy it for use by recheck query.
1612 copyTuple = heap_copytuple(&tuple);
1613 ReleaseBuffer(buffer);
1618 * If the referenced slot was actually empty, the latest version of
1619 * the row must have been deleted, so we need do nothing.
1621 if (tuple.t_data == NULL)
1623 ReleaseBuffer(buffer);
1628 * As above, if xmin isn't what we're expecting, do nothing.
1630 if (!TransactionIdEquals(HeapTupleHeaderGetXmin(tuple.t_data),
1633 ReleaseBuffer(buffer);
1638 * If we get here, the tuple was found but failed SnapshotDirty.
1639 * Assuming the xmin is either a committed xact or our own xact (as it
1640 * certainly should be if we're trying to modify the tuple), this must
1641 * mean that the row was updated or deleted by either a committed xact
1642 * or our own xact. If it was deleted, we can ignore it; if it was
1643 * updated then chain up to the next version and repeat the whole
1646 * As above, it should be safe to examine xmax and t_ctid without the
1647 * buffer content lock, because they can't be changing.
1649 if (ItemPointerEquals(&tuple.t_self, &tuple.t_data->t_ctid))
1651 /* deleted, so forget about it */
1652 ReleaseBuffer(buffer);
1656 /* updated, so look at the updated row */
1657 tuple.t_self = tuple.t_data->t_ctid;
1658 /* updated row should have xmin matching this xmax */
1659 priorXmax = HeapTupleHeaderGetXmax(tuple.t_data);
1660 ReleaseBuffer(buffer);
1661 /* loop back to fetch next in chain */
1665 * Return the copied tuple
1671 * EvalPlanQualInit -- initialize during creation of a plan state node
1672 * that might need to invoke EPQ processing.
1673 * Note: subplan can be NULL if it will be set later with EvalPlanQualSetPlan.
1676 EvalPlanQualInit(EPQState *epqstate, EState *estate,
1677 Plan *subplan, int epqParam)
1679 /* Mark the EPQ state inactive */
1680 epqstate->estate = NULL;
1681 epqstate->planstate = NULL;
1682 epqstate->origslot = NULL;
1683 /* ... and remember data that EvalPlanQualBegin will need */
1684 epqstate->plan = subplan;
1685 epqstate->rowMarks = NIL;
1686 epqstate->epqParam = epqParam;
1690 * EvalPlanQualSetPlan -- set or change subplan of an EPQState.
1692 * We need this so that ModifyTuple can deal with multiple subplans.
1695 EvalPlanQualSetPlan(EPQState *epqstate, Plan *subplan)
1697 /* If we have a live EPQ query, shut it down */
1698 EvalPlanQualEnd(epqstate);
1699 /* And set/change the plan pointer */
1700 epqstate->plan = subplan;
1704 * EvalPlanQualAddRowMark -- add an ExecRowMark that EPQ needs to handle.
1706 * Currently, only non-locking RowMarks are supported.
1709 EvalPlanQualAddRowMark(EPQState *epqstate, ExecRowMark *erm)
1711 if (RowMarkRequiresRowShareLock(erm->markType))
1712 elog(ERROR, "EvalPlanQual doesn't support locking rowmarks");
1713 epqstate->rowMarks = lappend(epqstate->rowMarks, erm);
1717 * Install one test tuple into EPQ state, or clear test tuple if tuple == NULL
1719 * NB: passed tuple must be palloc'd; it may get freed later
1722 EvalPlanQualSetTuple(EPQState *epqstate, Index rti, HeapTuple tuple)
1724 EState *estate = epqstate->estate;
1729 * free old test tuple, if any, and store new tuple where relation's scan
1732 if (estate->es_epqTuple[rti - 1] != NULL)
1733 heap_freetuple(estate->es_epqTuple[rti - 1]);
1734 estate->es_epqTuple[rti - 1] = tuple;
1735 estate->es_epqTupleSet[rti - 1] = true;
1739 * Fetch back the current test tuple (if any) for the specified RTI
1742 EvalPlanQualGetTuple(EPQState *epqstate, Index rti)
1744 EState *estate = epqstate->estate;
1748 return estate->es_epqTuple[rti - 1];
1752 * Fetch the current row values for any non-locked relations that need
1753 * to be scanned by an EvalPlanQual operation. origslot must have been set
1754 * to contain the current result row (top-level row) that we need to recheck.
1757 EvalPlanQualFetchRowMarks(EPQState *epqstate)
1761 Assert(epqstate->origslot != NULL);
1763 foreach(l, epqstate->rowMarks)
1765 ExecRowMark *erm = (ExecRowMark *) lfirst(l);
1768 HeapTupleData tuple;
1770 /* clear any leftover test tuple for this rel */
1771 EvalPlanQualSetTuple(epqstate, erm->rti, NULL);
1777 Assert(erm->markType == ROW_MARK_REFERENCE);
1779 /* if child rel, must check whether it produced this row */
1780 if (erm->rti != erm->prti)
1784 datum = ExecGetJunkAttribute(epqstate->origslot,
1787 /* non-locked rels could be on the inside of outer joins */
1790 tableoid = DatumGetObjectId(datum);
1792 if (tableoid != RelationGetRelid(erm->relation))
1794 /* this child is inactive right now */
1799 /* fetch the tuple's ctid */
1800 datum = ExecGetJunkAttribute(epqstate->origslot,
1803 /* non-locked rels could be on the inside of outer joins */
1806 tuple.t_self = *((ItemPointer) DatumGetPointer(datum));
1808 /* okay, fetch the tuple */
1809 if (!heap_fetch(erm->relation, SnapshotAny, &tuple, &buffer,
1811 elog(ERROR, "failed to fetch tuple for EvalPlanQual recheck");
1813 /* successful, copy and store tuple */
1814 EvalPlanQualSetTuple(epqstate, erm->rti,
1815 heap_copytuple(&tuple));
1816 ReleaseBuffer(buffer);
1822 Assert(erm->markType == ROW_MARK_COPY);
1824 /* fetch the whole-row Var for the relation */
1825 datum = ExecGetJunkAttribute(epqstate->origslot,
1828 /* non-locked rels could be on the inside of outer joins */
1831 td = DatumGetHeapTupleHeader(datum);
1833 /* build a temporary HeapTuple control structure */
1834 tuple.t_len = HeapTupleHeaderGetDatumLength(td);
1835 ItemPointerSetInvalid(&(tuple.t_self));
1836 tuple.t_tableOid = InvalidOid;
1839 /* copy and store tuple */
1840 EvalPlanQualSetTuple(epqstate, erm->rti,
1841 heap_copytuple(&tuple));
1847 * Fetch the next row (if any) from EvalPlanQual testing
1849 * (In practice, there should never be more than one row...)
1852 EvalPlanQualNext(EPQState *epqstate)
1854 MemoryContext oldcontext;
1855 TupleTableSlot *slot;
1857 oldcontext = MemoryContextSwitchTo(epqstate->estate->es_query_cxt);
1858 slot = ExecProcNode(epqstate->planstate);
1859 MemoryContextSwitchTo(oldcontext);
1865 * Initialize or reset an EvalPlanQual state tree
1868 EvalPlanQualBegin(EPQState *epqstate, EState *parentestate)
1870 EState *estate = epqstate->estate;
1874 /* First time through, so create a child EState */
1875 EvalPlanQualStart(epqstate, parentestate, epqstate->plan);
1880 * We already have a suitable child EPQ tree, so just reset it.
1882 int rtsize = list_length(parentestate->es_range_table);
1883 PlanState *planstate = epqstate->planstate;
1885 MemSet(estate->es_epqScanDone, 0, rtsize * sizeof(bool));
1887 /* Recopy current values of parent parameters */
1888 if (parentestate->es_plannedstmt->nParamExec > 0)
1890 int i = parentestate->es_plannedstmt->nParamExec;
1894 /* copy value if any, but not execPlan link */
1895 estate->es_param_exec_vals[i].value =
1896 parentestate->es_param_exec_vals[i].value;
1897 estate->es_param_exec_vals[i].isnull =
1898 parentestate->es_param_exec_vals[i].isnull;
1903 * Mark child plan tree as needing rescan at all scan nodes. The
1904 * first ExecProcNode will take care of actually doing the rescan.
1906 planstate->chgParam = bms_add_member(planstate->chgParam,
1907 epqstate->epqParam);
1912 * Start execution of an EvalPlanQual plan tree.
1914 * This is a cut-down version of ExecutorStart(): we copy some state from
1915 * the top-level estate rather than initializing it fresh.
1918 EvalPlanQualStart(EPQState *epqstate, EState *parentestate, Plan *planTree)
1922 MemoryContext oldcontext;
1925 rtsize = list_length(parentestate->es_range_table);
1927 epqstate->estate = estate = CreateExecutorState();
1929 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
1932 * Child EPQ EStates share the parent's copy of unchanging state such as
1933 * the snapshot, rangetable, result-rel info, and external Param info.
1934 * They need their own copies of local state, including a tuple table,
1935 * es_param_exec_vals, etc.
1937 estate->es_direction = ForwardScanDirection;
1938 estate->es_snapshot = parentestate->es_snapshot;
1939 estate->es_crosscheck_snapshot = parentestate->es_crosscheck_snapshot;
1940 estate->es_range_table = parentestate->es_range_table;
1941 estate->es_plannedstmt = parentestate->es_plannedstmt;
1942 estate->es_junkFilter = parentestate->es_junkFilter;
1943 estate->es_output_cid = parentestate->es_output_cid;
1944 estate->es_result_relations = parentestate->es_result_relations;
1945 estate->es_num_result_relations = parentestate->es_num_result_relations;
1946 estate->es_result_relation_info = parentestate->es_result_relation_info;
1947 /* es_trig_target_relations must NOT be copied */
1948 estate->es_rowMarks = parentestate->es_rowMarks;
1949 estate->es_instrument = parentestate->es_instrument;
1950 estate->es_select_into = parentestate->es_select_into;
1951 estate->es_into_oids = parentestate->es_into_oids;
1954 * The external param list is simply shared from parent. The internal
1955 * param workspace has to be local state, but we copy the initial values
1956 * from the parent, so as to have access to any param values that were
1957 * already set from other parts of the parent's plan tree.
1959 estate->es_param_list_info = parentestate->es_param_list_info;
1960 if (parentestate->es_plannedstmt->nParamExec > 0)
1962 int i = parentestate->es_plannedstmt->nParamExec;
1964 estate->es_param_exec_vals = (ParamExecData *)
1965 palloc0(i * sizeof(ParamExecData));
1968 /* copy value if any, but not execPlan link */
1969 estate->es_param_exec_vals[i].value =
1970 parentestate->es_param_exec_vals[i].value;
1971 estate->es_param_exec_vals[i].isnull =
1972 parentestate->es_param_exec_vals[i].isnull;
1977 * Each EState must have its own es_epqScanDone state, but if we have
1978 * nested EPQ checks they should share es_epqTuple arrays. This allows
1979 * sub-rechecks to inherit the values being examined by an outer recheck.
1981 estate->es_epqScanDone = (bool *) palloc0(rtsize * sizeof(bool));
1982 if (parentestate->es_epqTuple != NULL)
1984 estate->es_epqTuple = parentestate->es_epqTuple;
1985 estate->es_epqTupleSet = parentestate->es_epqTupleSet;
1989 estate->es_epqTuple = (HeapTuple *)
1990 palloc0(rtsize * sizeof(HeapTuple));
1991 estate->es_epqTupleSet = (bool *)
1992 palloc0(rtsize * sizeof(bool));
1996 * Each estate also has its own tuple table.
1998 estate->es_tupleTable = NIL;
2001 * Initialize private state information for each SubPlan. We must do this
2002 * before running ExecInitNode on the main query tree, since
2003 * ExecInitSubPlan expects to be able to find these entries. Some of the
2004 * SubPlans might not be used in the part of the plan tree we intend to
2005 * run, but since it's not easy to tell which, we just initialize them
2008 Assert(estate->es_subplanstates == NIL);
2009 foreach(l, parentestate->es_plannedstmt->subplans)
2011 Plan *subplan = (Plan *) lfirst(l);
2012 PlanState *subplanstate;
2014 subplanstate = ExecInitNode(subplan, estate, 0);
2016 estate->es_subplanstates = lappend(estate->es_subplanstates,
2021 * Initialize the private state information for all the nodes in the part
2022 * of the plan tree we need to run. This opens files, allocates storage
2023 * and leaves us ready to start processing tuples.
2025 epqstate->planstate = ExecInitNode(planTree, estate, 0);
2027 MemoryContextSwitchTo(oldcontext);
2031 * EvalPlanQualEnd -- shut down at termination of parent plan state node,
2032 * or if we are done with the current EPQ child.
2034 * This is a cut-down version of ExecutorEnd(); basically we want to do most
2035 * of the normal cleanup, but *not* close result relations (which we are
2036 * just sharing from the outer query). We do, however, have to close any
2037 * trigger target relations that got opened, since those are not shared.
2038 * (There probably shouldn't be any of the latter, but just in case...)
2041 EvalPlanQualEnd(EPQState *epqstate)
2043 EState *estate = epqstate->estate;
2044 MemoryContext oldcontext;
2048 return; /* idle, so nothing to do */
2050 oldcontext = MemoryContextSwitchTo(estate->es_query_cxt);
2052 ExecEndNode(epqstate->planstate);
2054 foreach(l, estate->es_subplanstates)
2056 PlanState *subplanstate = (PlanState *) lfirst(l);
2058 ExecEndNode(subplanstate);
2061 /* throw away the per-estate tuple table */
2062 ExecResetTupleTable(estate->es_tupleTable, false);
2064 /* close any trigger target relations attached to this EState */
2065 foreach(l, estate->es_trig_target_relations)
2067 ResultRelInfo *resultRelInfo = (ResultRelInfo *) lfirst(l);
2069 /* Close indices and then the relation itself */
2070 ExecCloseIndices(resultRelInfo);
2071 heap_close(resultRelInfo->ri_RelationDesc, NoLock);
2074 MemoryContextSwitchTo(oldcontext);
2076 FreeExecutorState(estate);
2078 /* Mark EPQState idle */
2079 epqstate->estate = NULL;
2080 epqstate->planstate = NULL;
2081 epqstate->origslot = NULL;
2086 * Support for SELECT INTO (a/k/a CREATE TABLE AS)
2088 * We implement SELECT INTO by diverting SELECT's normal output with
2089 * a specialized DestReceiver type.
2094 DestReceiver pub; /* publicly-known function pointers */
2095 EState *estate; /* EState we are working with */
2096 Relation rel; /* Relation to write to */
2097 int hi_options; /* heap_insert performance options */
2098 BulkInsertState bistate; /* bulk insert state */
2102 * OpenIntoRel --- actually create the SELECT INTO target relation
2104 * This also replaces QueryDesc->dest with the special DestReceiver for
2105 * SELECT INTO. We assume that the correct result tuple type has already
2106 * been placed in queryDesc->tupDesc.
2109 OpenIntoRel(QueryDesc *queryDesc)
2111 IntoClause *into = queryDesc->plannedstmt->intoClause;
2112 EState *estate = queryDesc->estate;
2113 Relation intoRelationDesc;
2118 AclResult aclresult;
2121 DR_intorel *myState;
2122 static char *validnsps[] = HEAP_RELOPT_NAMESPACES;
2127 * XXX This code needs to be kept in sync with DefineRelation(). Maybe we
2128 * should try to use that function instead.
2132 * Check consistency of arguments
2134 if (into->onCommit != ONCOMMIT_NOOP
2135 && into->rel->relpersistence != RELPERSISTENCE_TEMP)
2137 (errcode(ERRCODE_INVALID_TABLE_DEFINITION),
2138 errmsg("ON COMMIT can only be used on temporary tables")));
2141 * Security check: disallow creating temp tables from security-restricted
2142 * code. This is needed because calling code might not expect untrusted
2143 * tables to appear in pg_temp at the front of its search path.
2145 if (into->rel->relpersistence == RELPERSISTENCE_TEMP
2146 && InSecurityRestrictedOperation())
2148 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
2149 errmsg("cannot create temporary table within security-restricted operation")));
2152 * Find namespace to create in, check its permissions
2154 intoName = into->rel->relname;
2155 namespaceId = RangeVarGetCreationNamespace(into->rel);
2157 aclresult = pg_namespace_aclcheck(namespaceId, GetUserId(),
2159 if (aclresult != ACLCHECK_OK)
2160 aclcheck_error(aclresult, ACL_KIND_NAMESPACE,
2161 get_namespace_name(namespaceId));
2164 * Select tablespace to use. If not specified, use default tablespace
2165 * (which may in turn default to database's default).
2167 if (into->tableSpaceName)
2169 tablespaceId = get_tablespace_oid(into->tableSpaceName, false);
2173 tablespaceId = GetDefaultTablespace(into->rel->relpersistence);
2174 /* note InvalidOid is OK in this case */
2177 /* Check permissions except when using the database's default space */
2178 if (OidIsValid(tablespaceId) && tablespaceId != MyDatabaseTableSpace)
2180 AclResult aclresult;
2182 aclresult = pg_tablespace_aclcheck(tablespaceId, GetUserId(),
2185 if (aclresult != ACLCHECK_OK)
2186 aclcheck_error(aclresult, ACL_KIND_TABLESPACE,
2187 get_tablespace_name(tablespaceId));
2190 /* Parse and validate any reloptions */
2191 reloptions = transformRelOptions((Datum) 0,
2197 (void) heap_reloptions(RELKIND_RELATION, reloptions, true);
2199 /* Copy the tupdesc because heap_create_with_catalog modifies it */
2200 tupdesc = CreateTupleDescCopy(queryDesc->tupDesc);
2202 /* Now we can actually create the new relation */
2203 intoRelationId = heap_create_with_catalog(intoName,
2213 into->rel->relpersistence,
2221 allowSystemTableMods,
2223 Assert(intoRelationId != InvalidOid);
2225 FreeTupleDesc(tupdesc);
2228 * Advance command counter so that the newly-created relation's catalog
2229 * tuples will be visible to heap_open.
2231 CommandCounterIncrement();
2234 * If necessary, create a TOAST table for the INTO relation. Note that
2235 * AlterTableCreateToastTable ends with CommandCounterIncrement(), so that
2236 * the TOAST table will be visible for insertion.
2238 reloptions = transformRelOptions((Datum) 0,
2245 (void) heap_reloptions(RELKIND_TOASTVALUE, reloptions, true);
2247 AlterTableCreateToastTable(intoRelationId, reloptions);
2250 * And open the constructed table for writing.
2252 intoRelationDesc = heap_open(intoRelationId, AccessExclusiveLock);
2255 * Now replace the query's DestReceiver with one for SELECT INTO
2257 queryDesc->dest = CreateDestReceiver(DestIntoRel);
2258 myState = (DR_intorel *) queryDesc->dest;
2259 Assert(myState->pub.mydest == DestIntoRel);
2260 myState->estate = estate;
2261 myState->rel = intoRelationDesc;
2264 * We can skip WAL-logging the insertions, unless PITR or streaming
2265 * replication is in use. We can skip the FSM in any case.
2267 myState->hi_options = HEAP_INSERT_SKIP_FSM |
2268 (XLogIsNeeded() ? 0 : HEAP_INSERT_SKIP_WAL);
2269 myState->bistate = GetBulkInsertState();
2271 /* Not using WAL requires smgr_targblock be initially invalid */
2272 Assert(RelationGetTargetBlock(intoRelationDesc) == InvalidBlockNumber);
2276 * CloseIntoRel --- clean up SELECT INTO at ExecutorEnd time
2279 CloseIntoRel(QueryDesc *queryDesc)
2281 DR_intorel *myState = (DR_intorel *) queryDesc->dest;
2283 /* OpenIntoRel might never have gotten called */
2284 if (myState && myState->pub.mydest == DestIntoRel && myState->rel)
2286 FreeBulkInsertState(myState->bistate);
2288 /* If we skipped using WAL, must heap_sync before commit */
2289 if (myState->hi_options & HEAP_INSERT_SKIP_WAL)
2290 heap_sync(myState->rel);
2292 /* close rel, but keep lock until commit */
2293 heap_close(myState->rel, NoLock);
2295 myState->rel = NULL;
2300 * CreateIntoRelDestReceiver -- create a suitable DestReceiver object
2303 CreateIntoRelDestReceiver(void)
2305 DR_intorel *self = (DR_intorel *) palloc0(sizeof(DR_intorel));
2307 self->pub.receiveSlot = intorel_receive;
2308 self->pub.rStartup = intorel_startup;
2309 self->pub.rShutdown = intorel_shutdown;
2310 self->pub.rDestroy = intorel_destroy;
2311 self->pub.mydest = DestIntoRel;
2313 /* private fields will be set by OpenIntoRel */
2315 return (DestReceiver *) self;
2319 * intorel_startup --- executor startup
2322 intorel_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
2328 * intorel_receive --- receive one tuple
2331 intorel_receive(TupleTableSlot *slot, DestReceiver *self)
2333 DR_intorel *myState = (DR_intorel *) self;
2337 * get the heap tuple out of the tuple table slot, making sure we have a
2340 tuple = ExecMaterializeSlot(slot);
2343 * force assignment of new OID (see comments in ExecInsert)
2345 if (myState->rel->rd_rel->relhasoids)
2346 HeapTupleSetOid(tuple, InvalidOid);
2348 heap_insert(myState->rel,
2350 myState->estate->es_output_cid,
2351 myState->hi_options,
2354 /* We know this is a newly created relation, so there are no indexes */
2358 * intorel_shutdown --- executor end
2361 intorel_shutdown(DestReceiver *self)
2367 * intorel_destroy --- release DestReceiver object
2370 intorel_destroy(DestReceiver *self)