1 /*-------------------------------------------------------------------------
4 * support for the POSTGRES executor module
7 * Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group
8 * Portions Copyright (c) 1994, Regents of the University of California
10 * src/include/executor/executor.h
12 *-------------------------------------------------------------------------
17 #include "catalog/partition.h"
18 #include "executor/execdesc.h"
19 #include "nodes/parsenodes.h"
23 * The "eflags" argument to ExecutorStart and the various ExecInitNode
24 * routines is a bitwise OR of the following flag bits, which tell the
25 * called plan node what to expect. Note that the flags will get modified
26 * as they are passed down the plan tree, since an upper node may require
27 * functionality in its subnode not demanded of the plan as a whole
28 * (example: MergeJoin requires mark/restore capability in its inner input),
29 * or an upper node may shield its input from some functionality requirement
30 * (example: Materialize shields its input from needing to do backward scan).
32 * EXPLAIN_ONLY indicates that the plan tree is being initialized just so
33 * EXPLAIN can print it out; it will not be run. Hence, no side-effects
34 * of startup should occur. However, error checks (such as permission checks)
35 * should be performed.
37 * REWIND indicates that the plan node should try to efficiently support
38 * rescans without parameter changes. (Nodes must support ExecReScan calls
39 * in any case, but if this flag was not given, they are at liberty to do it
40 * through complete recalculation. Note that a parameter change forces a
41 * full recalculation in any case.)
43 * BACKWARD indicates that the plan node must respect the es_direction flag.
44 * When this is not passed, the plan node will only be run forwards.
46 * MARK indicates that the plan node must support Mark/Restore calls.
47 * When this is not passed, no Mark/Restore will occur.
49 * SKIP_TRIGGERS tells ExecutorStart/ExecutorFinish to skip calling
50 * AfterTriggerBeginQuery/AfterTriggerEndQuery. This does not necessarily
51 * mean that the plan can't queue any AFTER triggers; just that the caller
52 * is responsible for there being a trigger context for them to be queued in.
54 * WITH/WITHOUT_OIDS tell the executor to emit tuples with or without space
55 * for OIDs, respectively. These are currently used only for CREATE TABLE AS.
56 * If neither is set, the plan may or may not produce tuples including OIDs.
58 #define EXEC_FLAG_EXPLAIN_ONLY 0x0001 /* EXPLAIN, no ANALYZE */
59 #define EXEC_FLAG_REWIND 0x0002 /* need efficient rescan */
60 #define EXEC_FLAG_BACKWARD 0x0004 /* need backward scan */
61 #define EXEC_FLAG_MARK 0x0008 /* need mark/restore */
62 #define EXEC_FLAG_SKIP_TRIGGERS 0x0010 /* skip AfterTrigger calls */
63 #define EXEC_FLAG_WITH_OIDS 0x0020 /* force OIDs in returned tuples */
64 #define EXEC_FLAG_WITHOUT_OIDS 0x0040 /* force no OIDs in returned tuples */
65 #define EXEC_FLAG_WITH_NO_DATA 0x0080 /* rel scannability doesn't matter */
68 /* Hook for plugins to get control in ExecutorStart() */
69 typedef void (*ExecutorStart_hook_type) (QueryDesc *queryDesc, int eflags);
70 extern PGDLLIMPORT ExecutorStart_hook_type ExecutorStart_hook;
72 /* Hook for plugins to get control in ExecutorRun() */
73 typedef void (*ExecutorRun_hook_type) (QueryDesc *queryDesc,
74 ScanDirection direction,
77 extern PGDLLIMPORT ExecutorRun_hook_type ExecutorRun_hook;
79 /* Hook for plugins to get control in ExecutorFinish() */
80 typedef void (*ExecutorFinish_hook_type) (QueryDesc *queryDesc);
81 extern PGDLLIMPORT ExecutorFinish_hook_type ExecutorFinish_hook;
83 /* Hook for plugins to get control in ExecutorEnd() */
84 typedef void (*ExecutorEnd_hook_type) (QueryDesc *queryDesc);
85 extern PGDLLIMPORT ExecutorEnd_hook_type ExecutorEnd_hook;
87 /* Hook for plugins to get control in ExecCheckRTPerms() */
88 typedef bool (*ExecutorCheckPerms_hook_type) (List *, bool);
89 extern PGDLLIMPORT ExecutorCheckPerms_hook_type ExecutorCheckPerms_hook;
93 * prototypes from functions in execAmi.c
95 struct Path; /* avoid including relation.h here */
97 extern void ExecReScan(PlanState *node);
98 extern void ExecMarkPos(PlanState *node);
99 extern void ExecRestrPos(PlanState *node);
100 extern bool ExecSupportsMarkRestore(struct Path *pathnode);
101 extern bool ExecSupportsBackwardScan(Plan *node);
102 extern bool ExecMaterializesOutput(NodeTag plantype);
105 * prototypes from functions in execCurrent.c
107 extern bool execCurrentOf(CurrentOfExpr *cexpr,
108 ExprContext *econtext,
110 ItemPointer current_tid);
113 * prototypes from functions in execGrouping.c
115 extern bool execTuplesMatch(TupleTableSlot *slot1,
116 TupleTableSlot *slot2,
118 AttrNumber *matchColIdx,
119 FmgrInfo *eqfunctions,
120 MemoryContext evalContext);
121 extern bool execTuplesUnequal(TupleTableSlot *slot1,
122 TupleTableSlot *slot2,
124 AttrNumber *matchColIdx,
125 FmgrInfo *eqfunctions,
126 MemoryContext evalContext);
127 extern FmgrInfo *execTuplesMatchPrepare(int numCols,
129 extern void execTuplesHashPrepare(int numCols,
131 FmgrInfo **eqFunctions,
132 FmgrInfo **hashFunctions);
133 extern TupleHashTable BuildTupleHashTable(int numCols, AttrNumber *keyColIdx,
134 FmgrInfo *eqfunctions,
135 FmgrInfo *hashfunctions,
136 long nbuckets, Size additionalsize,
137 MemoryContext tablecxt,
138 MemoryContext tempcxt, bool use_variable_hash_iv);
139 extern TupleHashEntry LookupTupleHashEntry(TupleHashTable hashtable,
140 TupleTableSlot *slot,
142 extern TupleHashEntry FindTupleHashEntry(TupleHashTable hashtable,
143 TupleTableSlot *slot,
144 FmgrInfo *eqfunctions,
145 FmgrInfo *hashfunctions);
148 * prototypes from functions in execJunk.c
150 extern JunkFilter *ExecInitJunkFilter(List *targetList, bool hasoid,
151 TupleTableSlot *slot);
152 extern JunkFilter *ExecInitJunkFilterConversion(List *targetList,
153 TupleDesc cleanTupType,
154 TupleTableSlot *slot);
155 extern AttrNumber ExecFindJunkAttribute(JunkFilter *junkfilter,
156 const char *attrName);
157 extern AttrNumber ExecFindJunkAttributeInTlist(List *targetlist,
158 const char *attrName);
159 extern Datum ExecGetJunkAttribute(TupleTableSlot *slot, AttrNumber attno,
161 extern TupleTableSlot *ExecFilterJunk(JunkFilter *junkfilter,
162 TupleTableSlot *slot);
166 * prototypes from functions in execMain.c
168 extern void ExecutorStart(QueryDesc *queryDesc, int eflags);
169 extern void standard_ExecutorStart(QueryDesc *queryDesc, int eflags);
170 extern void ExecutorRun(QueryDesc *queryDesc,
171 ScanDirection direction, uint64 count, bool execute_once);
172 extern void standard_ExecutorRun(QueryDesc *queryDesc,
173 ScanDirection direction, uint64 count, bool execute_once);
174 extern void ExecutorFinish(QueryDesc *queryDesc);
175 extern void standard_ExecutorFinish(QueryDesc *queryDesc);
176 extern void ExecutorEnd(QueryDesc *queryDesc);
177 extern void standard_ExecutorEnd(QueryDesc *queryDesc);
178 extern void ExecutorRewind(QueryDesc *queryDesc);
179 extern bool ExecCheckRTPerms(List *rangeTable, bool ereport_on_violation);
180 extern void CheckValidResultRel(Relation resultRel, CmdType operation);
181 extern void InitResultRelInfo(ResultRelInfo *resultRelInfo,
182 Relation resultRelationDesc,
183 Index resultRelationIndex,
184 Relation partition_root,
185 int instrument_options);
186 extern ResultRelInfo *ExecGetTriggerResultRel(EState *estate, Oid relid);
187 extern void ExecCleanUpTriggerState(EState *estate);
188 extern bool ExecContextForcesOids(PlanState *planstate, bool *hasoids);
189 extern void ExecConstraints(ResultRelInfo *resultRelInfo,
190 TupleTableSlot *slot, EState *estate);
191 extern void ExecWithCheckOptions(WCOKind kind, ResultRelInfo *resultRelInfo,
192 TupleTableSlot *slot, EState *estate);
193 extern LockTupleMode ExecUpdateLockMode(EState *estate, ResultRelInfo *relinfo);
194 extern ExecRowMark *ExecFindRowMark(EState *estate, Index rti, bool missing_ok);
195 extern ExecAuxRowMark *ExecBuildAuxRowMark(ExecRowMark *erm, List *targetlist);
196 extern TupleTableSlot *EvalPlanQual(EState *estate, EPQState *epqstate,
197 Relation relation, Index rti, int lockmode,
198 ItemPointer tid, TransactionId priorXmax);
199 extern HeapTuple EvalPlanQualFetch(EState *estate, Relation relation,
200 int lockmode, LockWaitPolicy wait_policy, ItemPointer tid,
201 TransactionId priorXmax);
202 extern void EvalPlanQualInit(EPQState *epqstate, EState *estate,
203 Plan *subplan, List *auxrowmarks, int epqParam);
204 extern void EvalPlanQualSetPlan(EPQState *epqstate,
205 Plan *subplan, List *auxrowmarks);
206 extern void EvalPlanQualSetTuple(EPQState *epqstate, Index rti,
208 extern HeapTuple EvalPlanQualGetTuple(EPQState *epqstate, Index rti);
209 extern void ExecSetupPartitionTupleRouting(Relation rel,
210 PartitionDispatch **pd,
211 ResultRelInfo **partitions,
212 TupleConversionMap ***tup_conv_maps,
213 TupleTableSlot **partition_tuple_slot,
214 int *num_parted, int *num_partitions);
215 extern int ExecFindPartition(ResultRelInfo *resultRelInfo,
216 PartitionDispatch *pd,
217 TupleTableSlot *slot,
220 #define EvalPlanQualSetSlot(epqstate, slot) ((epqstate)->origslot = (slot))
221 extern void EvalPlanQualFetchRowMarks(EPQState *epqstate);
222 extern TupleTableSlot *EvalPlanQualNext(EPQState *epqstate);
223 extern void EvalPlanQualBegin(EPQState *epqstate, EState *parentestate);
224 extern void EvalPlanQualEnd(EPQState *epqstate);
227 * prototypes from functions in execProcnode.c
229 extern PlanState *ExecInitNode(Plan *node, EState *estate, int eflags);
230 extern TupleTableSlot *ExecProcNode(PlanState *node);
231 extern Node *MultiExecProcNode(PlanState *node);
232 extern void ExecEndNode(PlanState *node);
233 extern bool ExecShutdownNode(PlanState *node);
236 * prototypes from functions in execExpr.c
238 extern ExprState *ExecInitExpr(Expr *node, PlanState *parent);
239 extern ExprState *ExecInitQual(List *qual, PlanState *parent);
240 extern ExprState *ExecInitCheck(List *qual, PlanState *parent);
241 extern List *ExecInitExprList(List *nodes, PlanState *parent);
242 extern ProjectionInfo *ExecBuildProjectionInfo(List *targetList,
243 ExprContext *econtext,
244 TupleTableSlot *slot,
246 TupleDesc inputDesc);
247 extern ExprState *ExecPrepareExpr(Expr *node, EState *estate);
248 extern ExprState *ExecPrepareQual(List *qual, EState *estate);
249 extern ExprState *ExecPrepareCheck(List *qual, EState *estate);
250 extern List *ExecPrepareExprList(List *nodes, EState *estate);
255 * Evaluate expression identified by "state" in the execution context
256 * given by "econtext". *isNull is set to the is-null flag for the result,
257 * and the Datum value is the function result.
259 * The caller should already have switched into the temporary memory
260 * context econtext->ecxt_per_tuple_memory. The convenience entry point
261 * ExecEvalExprSwitchContext() is provided for callers who don't prefer to
262 * do the switch in an outer loop.
266 ExecEvalExpr(ExprState *state,
267 ExprContext *econtext,
270 return (*state->evalfunc) (state, econtext, isNull);
275 * ExecEvalExprSwitchContext
277 * Same as ExecEvalExpr, but get into the right allocation context explicitly.
281 ExecEvalExprSwitchContext(ExprState *state,
282 ExprContext *econtext,
286 MemoryContext oldContext;
288 oldContext = MemoryContextSwitchTo(econtext->ecxt_per_tuple_memory);
289 retDatum = (*state->evalfunc) (state, econtext, isNull);
290 MemoryContextSwitchTo(oldContext);
298 * Projects a tuple based on projection info and stores it in the slot passed
299 * to ExecBuildProjectInfo().
301 * Note: the result is always a virtual tuple; therefore it may reference
302 * the contents of the exprContext's scan tuples and/or temporary results
303 * constructed in the exprContext. If the caller wishes the result to be
304 * valid longer than that data will be valid, he must call ExecMaterializeSlot
305 * on the result slot.
308 static inline TupleTableSlot *
309 ExecProject(ProjectionInfo *projInfo)
311 ExprContext *econtext = projInfo->pi_exprContext;
312 ExprState *state = &projInfo->pi_state;
313 TupleTableSlot *slot = state->resultslot;
317 * Clear any former contents of the result slot. This makes it safe for
318 * us to use the slot's Datum/isnull arrays as workspace.
320 ExecClearTuple(slot);
322 /* Run the expression, discarding scalar result from the last column. */
323 (void) ExecEvalExprSwitchContext(state, econtext, &isnull);
326 * Successfully formed a result row. Mark the result slot as containing a
327 * valid virtual tuple (inlined version of ExecStoreVirtualTuple()).
329 slot->tts_isempty = false;
330 slot->tts_nvalid = slot->tts_tupleDescriptor->natts;
337 * ExecQual - evaluate a qual prepared with ExecInitQual (possibly via
338 * ExecPrepareQual). Returns true if qual is satisfied, else false.
340 * Note: ExecQual used to have a third argument "resultForNull". The
341 * behavior of this function now corresponds to resultForNull == false.
342 * If you want the resultForNull == true behavior, see ExecCheck.
346 ExecQual(ExprState *state, ExprContext *econtext)
351 /* short-circuit (here and in ExecInitQual) for empty restriction list */
355 /* verify that expression was compiled using ExecInitQual */
356 Assert(state->flags & EEO_FLAG_IS_QUAL);
358 ret = ExecEvalExprSwitchContext(state, econtext, &isnull);
360 /* EEOP_QUAL should never return NULL */
363 return DatumGetBool(ret);
367 extern bool ExecCheck(ExprState *state, ExprContext *context);
370 * prototypes from functions in execSRF.c
372 extern SetExprState *ExecInitTableFunctionResult(Expr *expr,
373 ExprContext *econtext, PlanState *parent);
374 extern Tuplestorestate *ExecMakeTableFunctionResult(SetExprState *setexpr,
375 ExprContext *econtext,
376 MemoryContext argContext,
377 TupleDesc expectedDesc,
379 extern SetExprState *ExecInitFunctionResultSet(Expr *expr,
380 ExprContext *econtext, PlanState *parent);
381 extern Datum ExecMakeFunctionResultSet(SetExprState *fcache,
382 ExprContext *econtext,
384 ExprDoneCond *isDone);
387 * prototypes from functions in execScan.c
389 typedef TupleTableSlot *(*ExecScanAccessMtd) (ScanState *node);
390 typedef bool (*ExecScanRecheckMtd) (ScanState *node, TupleTableSlot *slot);
392 extern TupleTableSlot *ExecScan(ScanState *node, ExecScanAccessMtd accessMtd,
393 ExecScanRecheckMtd recheckMtd);
394 extern void ExecAssignScanProjectionInfo(ScanState *node);
395 extern void ExecAssignScanProjectionInfoWithVarno(ScanState *node, Index varno);
396 extern void ExecScanReScan(ScanState *node);
399 * prototypes from functions in execTuples.c
401 extern void ExecInitResultTupleSlot(EState *estate, PlanState *planstate);
402 extern void ExecInitScanTupleSlot(EState *estate, ScanState *scanstate);
403 extern TupleTableSlot *ExecInitExtraTupleSlot(EState *estate);
404 extern TupleTableSlot *ExecInitNullTupleSlot(EState *estate,
406 extern TupleDesc ExecTypeFromTL(List *targetList, bool hasoid);
407 extern TupleDesc ExecCleanTypeFromTL(List *targetList, bool hasoid);
408 extern TupleDesc ExecTypeFromExprList(List *exprList);
409 extern void ExecTypeSetColNames(TupleDesc typeInfo, List *namesList);
410 extern void UpdateChangedParamSet(PlanState *node, Bitmapset *newchg);
412 typedef struct TupOutputState
414 TupleTableSlot *slot;
418 extern TupOutputState *begin_tup_output_tupdesc(DestReceiver *dest,
420 extern void do_tup_output(TupOutputState *tstate, Datum *values, bool *isnull);
421 extern void do_text_output_multiline(TupOutputState *tstate, const char *txt);
422 extern void end_tup_output(TupOutputState *tstate);
425 * Write a single line of text given as a C string.
427 * Should only be used with a single-TEXT-attribute tupdesc.
429 #define do_text_output_oneline(tstate, str_to_emit) \
433 values_[0] = PointerGetDatum(cstring_to_text(str_to_emit)); \
434 isnull_[0] = false; \
435 do_tup_output(tstate, values_, isnull_); \
436 pfree(DatumGetPointer(values_[0])); \
441 * prototypes from functions in execUtils.c
443 extern EState *CreateExecutorState(void);
444 extern void FreeExecutorState(EState *estate);
445 extern ExprContext *CreateExprContext(EState *estate);
446 extern ExprContext *CreateStandaloneExprContext(void);
447 extern void FreeExprContext(ExprContext *econtext, bool isCommit);
448 extern void ReScanExprContext(ExprContext *econtext);
450 #define ResetExprContext(econtext) \
451 MemoryContextReset((econtext)->ecxt_per_tuple_memory)
453 extern ExprContext *MakePerTupleExprContext(EState *estate);
455 /* Get an EState's per-output-tuple exprcontext, making it if first use */
456 #define GetPerTupleExprContext(estate) \
457 ((estate)->es_per_tuple_exprcontext ? \
458 (estate)->es_per_tuple_exprcontext : \
459 MakePerTupleExprContext(estate))
461 #define GetPerTupleMemoryContext(estate) \
462 (GetPerTupleExprContext(estate)->ecxt_per_tuple_memory)
464 /* Reset an EState's per-output-tuple exprcontext, if one's been created */
465 #define ResetPerTupleExprContext(estate) \
467 if ((estate)->es_per_tuple_exprcontext) \
468 ResetExprContext((estate)->es_per_tuple_exprcontext); \
471 extern void ExecAssignExprContext(EState *estate, PlanState *planstate);
472 extern void ExecAssignResultType(PlanState *planstate, TupleDesc tupDesc);
473 extern void ExecAssignResultTypeFromTL(PlanState *planstate);
474 extern TupleDesc ExecGetResultType(PlanState *planstate);
475 extern void ExecAssignProjectionInfo(PlanState *planstate,
476 TupleDesc inputDesc);
477 extern void ExecFreeExprContext(PlanState *planstate);
478 extern void ExecAssignScanType(ScanState *scanstate, TupleDesc tupDesc);
479 extern void ExecAssignScanTypeFromOuterPlan(ScanState *scanstate);
481 extern bool ExecRelationIsTargetRelation(EState *estate, Index scanrelid);
483 extern Relation ExecOpenScanRelation(EState *estate, Index scanrelid, int eflags);
484 extern void ExecCloseScanRelation(Relation scanrel);
486 extern int executor_errposition(EState *estate, int location);
488 extern void RegisterExprContextCallback(ExprContext *econtext,
489 ExprContextCallbackFunction function,
491 extern void UnregisterExprContextCallback(ExprContext *econtext,
492 ExprContextCallbackFunction function,
495 extern void ExecLockNonLeafAppendTables(List *partitioned_rels, EState *estate);
497 extern Datum GetAttributeByName(HeapTupleHeader tuple, const char *attname,
499 extern Datum GetAttributeByNum(HeapTupleHeader tuple, AttrNumber attrno,
502 extern int ExecTargetListLength(List *targetlist);
503 extern int ExecCleanTargetListLength(List *targetlist);
506 * prototypes from functions in execIndexing.c
508 extern void ExecOpenIndices(ResultRelInfo *resultRelInfo, bool speculative);
509 extern void ExecCloseIndices(ResultRelInfo *resultRelInfo);
510 extern List *ExecInsertIndexTuples(TupleTableSlot *slot, ItemPointer tupleid,
511 EState *estate, bool noDupErr, bool *specConflict,
512 List *arbiterIndexes);
513 extern bool ExecCheckIndexConstraints(TupleTableSlot *slot, EState *estate,
514 ItemPointer conflictTid, List *arbiterIndexes);
515 extern void check_exclusion_constraint(Relation heap, Relation index,
516 IndexInfo *indexInfo,
518 Datum *values, bool *isnull,
519 EState *estate, bool newIndex);
522 * prototypes from functions in execReplication.c
524 extern bool RelationFindReplTupleByIndex(Relation rel, Oid idxoid,
525 LockTupleMode lockmode,
526 TupleTableSlot *searchslot,
527 TupleTableSlot *outslot);
528 extern bool RelationFindReplTupleSeq(Relation rel, LockTupleMode lockmode,
529 TupleTableSlot *searchslot, TupleTableSlot *outslot);
531 extern void ExecSimpleRelationInsert(EState *estate, TupleTableSlot *slot);
532 extern void ExecSimpleRelationUpdate(EState *estate, EPQState *epqstate,
533 TupleTableSlot *searchslot, TupleTableSlot *slot);
534 extern void ExecSimpleRelationDelete(EState *estate, EPQState *epqstate,
535 TupleTableSlot *searchslot);
536 extern void CheckCmdReplicaIdentity(Relation rel, CmdType cmd);
538 extern void CheckSubscriptionRelkind(char relkind, const char *nspname,
539 const char *relname);
541 #endif /* EXECUTOR_H */