Line data Source code
1 : /*-------------------------------------------------------------------------
2 : *
3 : * executor.h
4 : * support for the POSTGRES executor module
5 : *
6 : *
7 : * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
8 : * Portions Copyright (c) 1994, Regents of the University of California
9 : *
10 : * src/include/executor/executor.h
11 : *
12 : *-------------------------------------------------------------------------
13 : */
14 : #ifndef EXECUTOR_H
15 : #define EXECUTOR_H
16 :
17 : #include "datatype/timestamp.h"
18 : #include "executor/execdesc.h"
19 : #include "fmgr.h"
20 : #include "nodes/lockoptions.h"
21 : #include "nodes/parsenodes.h"
22 : #include "utils/memutils.h"
23 :
24 :
25 : /*
26 : * The "eflags" argument to ExecutorStart and the various ExecInitNode
27 : * routines is a bitwise OR of the following flag bits, which tell the
28 : * called plan node what to expect. Note that the flags will get modified
29 : * as they are passed down the plan tree, since an upper node may require
30 : * functionality in its subnode not demanded of the plan as a whole
31 : * (example: MergeJoin requires mark/restore capability in its inner input),
32 : * or an upper node may shield its input from some functionality requirement
33 : * (example: Materialize shields its input from needing to do backward scan).
34 : *
35 : * EXPLAIN_ONLY indicates that the plan tree is being initialized just so
36 : * EXPLAIN can print it out; it will not be run. Hence, no side-effects
37 : * of startup should occur. However, error checks (such as permission checks)
38 : * should be performed.
39 : *
40 : * EXPLAIN_GENERIC can only be used together with EXPLAIN_ONLY. It indicates
41 : * that a generic plan is being shown using EXPLAIN (GENERIC_PLAN), which
42 : * means that missing parameter values must be tolerated. Currently, the only
43 : * effect is to suppress execution-time partition pruning.
44 : *
45 : * REWIND indicates that the plan node should try to efficiently support
46 : * rescans without parameter changes. (Nodes must support ExecReScan calls
47 : * in any case, but if this flag was not given, they are at liberty to do it
48 : * through complete recalculation. Note that a parameter change forces a
49 : * full recalculation in any case.)
50 : *
51 : * BACKWARD indicates that the plan node must respect the es_direction flag.
52 : * When this is not passed, the plan node will only be run forwards.
53 : *
54 : * MARK indicates that the plan node must support Mark/Restore calls.
55 : * When this is not passed, no Mark/Restore will occur.
56 : *
57 : * SKIP_TRIGGERS tells ExecutorStart/ExecutorFinish to skip calling
58 : * AfterTriggerBeginQuery/AfterTriggerEndQuery. This does not necessarily
59 : * mean that the plan can't queue any AFTER triggers; just that the caller
60 : * is responsible for there being a trigger context for them to be queued in.
61 : *
62 : * WITH_NO_DATA indicates that we are performing REFRESH MATERIALIZED VIEW
63 : * ... WITH NO DATA. Currently, the only effect is to suppress errors about
64 : * scanning unpopulated materialized views.
65 : */
66 : #define EXEC_FLAG_EXPLAIN_ONLY 0x0001 /* EXPLAIN, no ANALYZE */
67 : #define EXEC_FLAG_EXPLAIN_GENERIC 0x0002 /* EXPLAIN (GENERIC_PLAN) */
68 : #define EXEC_FLAG_REWIND 0x0004 /* need efficient rescan */
69 : #define EXEC_FLAG_BACKWARD 0x0008 /* need backward scan */
70 : #define EXEC_FLAG_MARK 0x0010 /* need mark/restore */
71 : #define EXEC_FLAG_SKIP_TRIGGERS 0x0020 /* skip AfterTrigger setup */
72 : #define EXEC_FLAG_WITH_NO_DATA 0x0040 /* REFRESH ... WITH NO DATA */
73 :
74 :
75 : /* Hook for plugins to get control in ExecutorStart() */
76 : typedef void (*ExecutorStart_hook_type) (QueryDesc *queryDesc, int eflags);
77 : extern PGDLLIMPORT ExecutorStart_hook_type ExecutorStart_hook;
78 :
79 : /* Hook for plugins to get control in ExecutorRun() */
80 : typedef void (*ExecutorRun_hook_type) (QueryDesc *queryDesc,
81 : ScanDirection direction,
82 : uint64 count);
83 : extern PGDLLIMPORT ExecutorRun_hook_type ExecutorRun_hook;
84 :
85 : /* Hook for plugins to get control in ExecutorFinish() */
86 : typedef void (*ExecutorFinish_hook_type) (QueryDesc *queryDesc);
87 : extern PGDLLIMPORT ExecutorFinish_hook_type ExecutorFinish_hook;
88 :
89 : /* Hook for plugins to get control in ExecutorEnd() */
90 : typedef void (*ExecutorEnd_hook_type) (QueryDesc *queryDesc);
91 : extern PGDLLIMPORT ExecutorEnd_hook_type ExecutorEnd_hook;
92 :
93 : /* Hook for plugins to get control in ExecCheckPermissions() */
94 : typedef bool (*ExecutorCheckPerms_hook_type) (List *rangeTable,
95 : List *rtePermInfos,
96 : bool ereport_on_violation);
97 : extern PGDLLIMPORT ExecutorCheckPerms_hook_type ExecutorCheckPerms_hook;
98 :
99 :
100 : /*
101 : * prototypes from functions in execAmi.c
102 : */
103 : typedef struct Path Path; /* avoid including pathnodes.h here */
104 :
105 : extern void ExecReScan(PlanState *node);
106 : extern void ExecMarkPos(PlanState *node);
107 : extern void ExecRestrPos(PlanState *node);
108 : extern bool ExecSupportsMarkRestore(Path *pathnode);
109 : extern bool ExecSupportsBackwardScan(Plan *node);
110 : extern bool ExecMaterializesOutput(NodeTag plantype);
111 :
112 : /*
113 : * prototypes from functions in execCurrent.c
114 : */
115 : extern bool execCurrentOf(CurrentOfExpr *cexpr,
116 : ExprContext *econtext,
117 : Oid table_oid,
118 : ItemPointer current_tid);
119 :
120 : /*
121 : * prototypes from functions in execGrouping.c
122 : */
123 : extern ExprState *execTuplesMatchPrepare(TupleDesc desc,
124 : int numCols,
125 : const AttrNumber *keyColIdx,
126 : const Oid *eqOperators,
127 : const Oid *collations,
128 : PlanState *parent);
129 : extern void execTuplesHashPrepare(int numCols,
130 : const Oid *eqOperators,
131 : Oid **eqFuncOids,
132 : FmgrInfo **hashFunctions);
133 : extern TupleHashTable BuildTupleHashTable(PlanState *parent,
134 : TupleDesc inputDesc,
135 : const TupleTableSlotOps *inputOps,
136 : int numCols,
137 : AttrNumber *keyColIdx,
138 : const Oid *eqfuncoids,
139 : FmgrInfo *hashfunctions,
140 : Oid *collations,
141 : long nbuckets,
142 : Size additionalsize,
143 : MemoryContext metacxt,
144 : MemoryContext tablecxt,
145 : MemoryContext tempcxt,
146 : bool use_variable_hash_iv);
147 : extern TupleHashEntry LookupTupleHashEntry(TupleHashTable hashtable,
148 : TupleTableSlot *slot,
149 : bool *isnew, uint32 *hash);
150 : extern uint32 TupleHashTableHash(TupleHashTable hashtable,
151 : TupleTableSlot *slot);
152 : extern TupleHashEntry LookupTupleHashEntryHash(TupleHashTable hashtable,
153 : TupleTableSlot *slot,
154 : bool *isnew, uint32 hash);
155 : extern TupleHashEntry FindTupleHashEntry(TupleHashTable hashtable,
156 : TupleTableSlot *slot,
157 : ExprState *eqcomp,
158 : ExprState *hashexpr);
159 : extern void ResetTupleHashTable(TupleHashTable hashtable);
160 :
161 : #ifndef FRONTEND
162 : /*
163 : * Return size of the hash bucket. Useful for estimating memory usage.
164 : */
165 : static inline size_t
166 85154 : TupleHashEntrySize(void)
167 : {
168 85154 : return sizeof(TupleHashEntryData);
169 : }
170 :
171 : /*
172 : * Return tuple from hash entry.
173 : */
174 : static inline MinimalTuple
175 560118 : TupleHashEntryGetTuple(TupleHashEntry entry)
176 : {
177 560118 : return entry->firstTuple;
178 : }
179 :
180 : /*
181 : * Get a pointer into the additional space allocated for this entry. The
182 : * memory will be maxaligned and zeroed.
183 : *
184 : * The amount of space available is the additionalsize requested in the call
185 : * to BuildTupleHashTable(). If additionalsize was specified as zero, return
186 : * NULL.
187 : */
188 : static inline void *
189 8979980 : TupleHashEntryGetAdditional(TupleHashTable hashtable, TupleHashEntry entry)
190 : {
191 8979980 : if (hashtable->additionalsize > 0)
192 7146758 : return (char *) entry->firstTuple - hashtable->additionalsize;
193 : else
194 1833222 : return NULL;
195 : }
196 : #endif
197 :
198 : /*
199 : * prototypes from functions in execJunk.c
200 : */
201 : extern JunkFilter *ExecInitJunkFilter(List *targetList,
202 : TupleTableSlot *slot);
203 : extern JunkFilter *ExecInitJunkFilterConversion(List *targetList,
204 : TupleDesc cleanTupType,
205 : TupleTableSlot *slot);
206 : extern AttrNumber ExecFindJunkAttribute(JunkFilter *junkfilter,
207 : const char *attrName);
208 : extern AttrNumber ExecFindJunkAttributeInTlist(List *targetlist,
209 : const char *attrName);
210 : extern TupleTableSlot *ExecFilterJunk(JunkFilter *junkfilter,
211 : TupleTableSlot *slot);
212 :
213 : /*
214 : * ExecGetJunkAttribute
215 : *
216 : * Given a junk filter's input tuple (slot) and a junk attribute's number
217 : * previously found by ExecFindJunkAttribute, extract & return the value and
218 : * isNull flag of the attribute.
219 : */
220 : #ifndef FRONTEND
221 : static inline Datum
222 2006186 : ExecGetJunkAttribute(TupleTableSlot *slot, AttrNumber attno, bool *isNull)
223 : {
224 : Assert(attno > 0);
225 2006186 : return slot_getattr(slot, attno, isNull);
226 : }
227 : #endif
228 :
229 : /*
230 : * prototypes from functions in execMain.c
231 : */
232 : extern void ExecutorStart(QueryDesc *queryDesc, int eflags);
233 : extern void standard_ExecutorStart(QueryDesc *queryDesc, int eflags);
234 : extern void ExecutorRun(QueryDesc *queryDesc,
235 : ScanDirection direction, uint64 count);
236 : extern void standard_ExecutorRun(QueryDesc *queryDesc,
237 : ScanDirection direction, uint64 count);
238 : extern void ExecutorFinish(QueryDesc *queryDesc);
239 : extern void standard_ExecutorFinish(QueryDesc *queryDesc);
240 : extern void ExecutorEnd(QueryDesc *queryDesc);
241 : extern void standard_ExecutorEnd(QueryDesc *queryDesc);
242 : extern void ExecutorRewind(QueryDesc *queryDesc);
243 : extern bool ExecCheckPermissions(List *rangeTable,
244 : List *rteperminfos, bool ereport_on_violation);
245 : extern bool ExecCheckOneRelPerms(RTEPermissionInfo *perminfo);
246 : extern void CheckValidResultRel(ResultRelInfo *resultRelInfo, CmdType operation,
247 : OnConflictAction onConflictAction,
248 : List *mergeActions);
249 : extern void InitResultRelInfo(ResultRelInfo *resultRelInfo,
250 : Relation resultRelationDesc,
251 : Index resultRelationIndex,
252 : ResultRelInfo *partition_root_rri,
253 : int instrument_options);
254 : extern ResultRelInfo *ExecGetTriggerResultRel(EState *estate, Oid relid,
255 : ResultRelInfo *rootRelInfo);
256 : extern List *ExecGetAncestorResultRels(EState *estate, ResultRelInfo *resultRelInfo);
257 : extern void ExecConstraints(ResultRelInfo *resultRelInfo,
258 : TupleTableSlot *slot, EState *estate);
259 : extern AttrNumber ExecRelGenVirtualNotNull(ResultRelInfo *resultRelInfo,
260 : TupleTableSlot *slot,
261 : EState *estate,
262 : List *notnull_virtual_attrs);
263 : extern bool ExecPartitionCheck(ResultRelInfo *resultRelInfo,
264 : TupleTableSlot *slot, EState *estate, bool emitError);
265 : extern void ExecPartitionCheckEmitError(ResultRelInfo *resultRelInfo,
266 : TupleTableSlot *slot, EState *estate);
267 : extern void ExecWithCheckOptions(WCOKind kind, ResultRelInfo *resultRelInfo,
268 : TupleTableSlot *slot, EState *estate);
269 : extern char *ExecBuildSlotValueDescription(Oid reloid, TupleTableSlot *slot,
270 : TupleDesc tupdesc,
271 : Bitmapset *modifiedCols,
272 : int maxfieldlen);
273 : extern LockTupleMode ExecUpdateLockMode(EState *estate, ResultRelInfo *relinfo);
274 : extern ExecRowMark *ExecFindRowMark(EState *estate, Index rti, bool missing_ok);
275 : extern ExecAuxRowMark *ExecBuildAuxRowMark(ExecRowMark *erm, List *targetlist);
276 : extern TupleTableSlot *EvalPlanQual(EPQState *epqstate, Relation relation,
277 : Index rti, TupleTableSlot *inputslot);
278 : extern void EvalPlanQualInit(EPQState *epqstate, EState *parentestate,
279 : Plan *subplan, List *auxrowmarks,
280 : int epqParam, List *resultRelations);
281 : extern void EvalPlanQualSetPlan(EPQState *epqstate,
282 : Plan *subplan, List *auxrowmarks);
283 : extern TupleTableSlot *EvalPlanQualSlot(EPQState *epqstate,
284 : Relation relation, Index rti);
285 :
286 : #define EvalPlanQualSetSlot(epqstate, slot) ((epqstate)->origslot = (slot))
287 : extern bool EvalPlanQualFetchRowMark(EPQState *epqstate, Index rti, TupleTableSlot *slot);
288 : extern TupleTableSlot *EvalPlanQualNext(EPQState *epqstate);
289 : extern void EvalPlanQualBegin(EPQState *epqstate);
290 : extern void EvalPlanQualEnd(EPQState *epqstate);
291 :
292 : /*
293 : * functions in execProcnode.c
294 : */
295 : extern PlanState *ExecInitNode(Plan *node, EState *estate, int eflags);
296 : extern void ExecSetExecProcNode(PlanState *node, ExecProcNodeMtd function);
297 : extern Node *MultiExecProcNode(PlanState *node);
298 : extern void ExecEndNode(PlanState *node);
299 : extern void ExecShutdownNode(PlanState *node);
300 : extern void ExecSetTupleBound(int64 tuples_needed, PlanState *child_node);
301 :
302 :
303 : /* ----------------------------------------------------------------
304 : * ExecProcNode
305 : *
306 : * Execute the given node to return a(nother) tuple.
307 : * ----------------------------------------------------------------
308 : */
309 : #ifndef FRONTEND
310 : static inline TupleTableSlot *
311 129359870 : ExecProcNode(PlanState *node)
312 : {
313 129359870 : if (node->chgParam != NULL) /* something changed? */
314 306324 : ExecReScan(node); /* let ReScan handle this */
315 :
316 129359870 : return node->ExecProcNode(node);
317 : }
318 : #endif
319 :
320 : /*
321 : * prototypes from functions in execExpr.c
322 : */
323 : extern ExprState *ExecInitExpr(Expr *node, PlanState *parent);
324 : extern ExprState *ExecInitExprWithParams(Expr *node, ParamListInfo ext_params);
325 : extern ExprState *ExecInitQual(List *qual, PlanState *parent);
326 : extern ExprState *ExecInitCheck(List *qual, PlanState *parent);
327 : extern List *ExecInitExprList(List *nodes, PlanState *parent);
328 : extern ExprState *ExecBuildAggTrans(AggState *aggstate, struct AggStatePerPhaseData *phase,
329 : bool doSort, bool doHash, bool nullcheck);
330 : extern ExprState *ExecBuildHash32FromAttrs(TupleDesc desc,
331 : const TupleTableSlotOps *ops,
332 : FmgrInfo *hashfunctions,
333 : Oid *collations,
334 : int numCols,
335 : AttrNumber *keyColIdx,
336 : PlanState *parent,
337 : uint32 init_value);
338 : extern ExprState *ExecBuildHash32Expr(TupleDesc desc,
339 : const TupleTableSlotOps *ops,
340 : const Oid *hashfunc_oids,
341 : const List *collations,
342 : const List *hash_exprs,
343 : const bool *opstrict, PlanState *parent,
344 : uint32 init_value, bool keep_nulls);
345 : extern ExprState *ExecBuildGroupingEqual(TupleDesc ldesc, TupleDesc rdesc,
346 : const TupleTableSlotOps *lops, const TupleTableSlotOps *rops,
347 : int numCols,
348 : const AttrNumber *keyColIdx,
349 : const Oid *eqfunctions,
350 : const Oid *collations,
351 : PlanState *parent);
352 : extern ExprState *ExecBuildParamSetEqual(TupleDesc desc,
353 : const TupleTableSlotOps *lops,
354 : const TupleTableSlotOps *rops,
355 : const Oid *eqfunctions,
356 : const Oid *collations,
357 : const List *param_exprs,
358 : PlanState *parent);
359 : extern ProjectionInfo *ExecBuildProjectionInfo(List *targetList,
360 : ExprContext *econtext,
361 : TupleTableSlot *slot,
362 : PlanState *parent,
363 : TupleDesc inputDesc);
364 : extern ProjectionInfo *ExecBuildUpdateProjection(List *targetList,
365 : bool evalTargetList,
366 : List *targetColnos,
367 : TupleDesc relDesc,
368 : ExprContext *econtext,
369 : TupleTableSlot *slot,
370 : PlanState *parent);
371 : extern ExprState *ExecPrepareExpr(Expr *node, EState *estate);
372 : extern ExprState *ExecPrepareQual(List *qual, EState *estate);
373 : extern ExprState *ExecPrepareCheck(List *qual, EState *estate);
374 : extern List *ExecPrepareExprList(List *nodes, EState *estate);
375 :
376 : /*
377 : * ExecEvalExpr
378 : *
379 : * Evaluate expression identified by "state" in the execution context
380 : * given by "econtext". *isNull is set to the is-null flag for the result,
381 : * and the Datum value is the function result.
382 : *
383 : * The caller should already have switched into the temporary memory
384 : * context econtext->ecxt_per_tuple_memory. The convenience entry point
385 : * ExecEvalExprSwitchContext() is provided for callers who don't prefer to
386 : * do the switch in an outer loop.
387 : */
388 : #ifndef FRONTEND
389 : static inline Datum
390 23841314 : ExecEvalExpr(ExprState *state,
391 : ExprContext *econtext,
392 : bool *isNull)
393 : {
394 23841314 : return state->evalfunc(state, econtext, isNull);
395 : }
396 : #endif
397 :
398 : /*
399 : * ExecEvalExprNoReturn
400 : *
401 : * Like ExecEvalExpr(), but for cases where no return value is expected,
402 : * because the side-effects of expression evaluation are what's desired. This
403 : * is e.g. used for projection and aggregate transition computation.
404 :
405 : * Evaluate expression identified by "state" in the execution context
406 : * given by "econtext".
407 : *
408 : * The caller should already have switched into the temporary memory context
409 : * econtext->ecxt_per_tuple_memory. The convenience entry point
410 : * ExecEvalExprNoReturnSwitchContext() is provided for callers who don't
411 : * prefer to do the switch in an outer loop.
412 : */
413 : #ifndef FRONTEND
414 : static inline void
415 99375816 : ExecEvalExprNoReturn(ExprState *state,
416 : ExprContext *econtext)
417 : {
418 : PG_USED_FOR_ASSERTS_ONLY Datum retDatum;
419 :
420 99375816 : retDatum = state->evalfunc(state, econtext, NULL);
421 :
422 : Assert(retDatum == (Datum) 0);
423 99362272 : }
424 : #endif
425 :
426 : /*
427 : * ExecEvalExprSwitchContext
428 : *
429 : * Same as ExecEvalExpr, but get into the right allocation context explicitly.
430 : */
431 : #ifndef FRONTEND
432 : static inline Datum
433 118289658 : ExecEvalExprSwitchContext(ExprState *state,
434 : ExprContext *econtext,
435 : bool *isNull)
436 : {
437 : Datum retDatum;
438 : MemoryContext oldContext;
439 :
440 118289658 : oldContext = MemoryContextSwitchTo(econtext->ecxt_per_tuple_memory);
441 118289658 : retDatum = state->evalfunc(state, econtext, isNull);
442 118285650 : MemoryContextSwitchTo(oldContext);
443 118285650 : return retDatum;
444 : }
445 : #endif
446 :
447 : /*
448 : * ExecEvalExprNoReturnSwitchContext
449 : *
450 : * Same as ExecEvalExprNoReturn, but get into the right allocation context
451 : * explicitly.
452 : */
453 : #ifndef FRONTEND
454 : static inline void
455 99375816 : ExecEvalExprNoReturnSwitchContext(ExprState *state,
456 : ExprContext *econtext)
457 : {
458 : MemoryContext oldContext;
459 :
460 99375816 : oldContext = MemoryContextSwitchTo(econtext->ecxt_per_tuple_memory);
461 99375816 : ExecEvalExprNoReturn(state, econtext);
462 99362272 : MemoryContextSwitchTo(oldContext);
463 99362272 : }
464 : #endif
465 :
466 : /*
467 : * ExecProject
468 : *
469 : * Projects a tuple based on projection info and stores it in the slot passed
470 : * to ExecBuildProjectionInfo().
471 : *
472 : * Note: the result is always a virtual tuple; therefore it may reference
473 : * the contents of the exprContext's scan tuples and/or temporary results
474 : * constructed in the exprContext. If the caller wishes the result to be
475 : * valid longer than that data will be valid, he must call ExecMaterializeSlot
476 : * on the result slot.
477 : */
478 : #ifndef FRONTEND
479 : static inline TupleTableSlot *
480 69953926 : ExecProject(ProjectionInfo *projInfo)
481 : {
482 69953926 : ExprContext *econtext = projInfo->pi_exprContext;
483 69953926 : ExprState *state = &projInfo->pi_state;
484 69953926 : TupleTableSlot *slot = state->resultslot;
485 :
486 : /*
487 : * Clear any former contents of the result slot. This makes it safe for
488 : * us to use the slot's Datum/isnull arrays as workspace.
489 : */
490 69953926 : ExecClearTuple(slot);
491 :
492 : /* Run the expression */
493 69953926 : ExecEvalExprNoReturnSwitchContext(state, econtext);
494 :
495 : /*
496 : * Successfully formed a result row. Mark the result slot as containing a
497 : * valid virtual tuple (inlined version of ExecStoreVirtualTuple()).
498 : */
499 69940460 : slot->tts_flags &= ~TTS_FLAG_EMPTY;
500 69940460 : slot->tts_nvalid = slot->tts_tupleDescriptor->natts;
501 :
502 69940460 : return slot;
503 : }
504 : #endif
505 :
506 : /*
507 : * ExecQual - evaluate a qual prepared with ExecInitQual (possibly via
508 : * ExecPrepareQual). Returns true if qual is satisfied, else false.
509 : *
510 : * Note: ExecQual used to have a third argument "resultForNull". The
511 : * behavior of this function now corresponds to resultForNull == false.
512 : * If you want the resultForNull == true behavior, see ExecCheck.
513 : */
514 : #ifndef FRONTEND
515 : static inline bool
516 91652820 : ExecQual(ExprState *state, ExprContext *econtext)
517 : {
518 : Datum ret;
519 : bool isnull;
520 :
521 : /* short-circuit (here and in ExecInitQual) for empty restriction list */
522 91652820 : if (state == NULL)
523 5721466 : return true;
524 :
525 : /* verify that expression was compiled using ExecInitQual */
526 : Assert(state->flags & EEO_FLAG_IS_QUAL);
527 :
528 85931354 : ret = ExecEvalExprSwitchContext(state, econtext, &isnull);
529 :
530 : /* EEOP_QUAL should never return NULL */
531 : Assert(!isnull);
532 :
533 85931320 : return DatumGetBool(ret);
534 : }
535 : #endif
536 :
537 : /*
538 : * ExecQualAndReset() - evaluate qual with ExecQual() and reset expression
539 : * context.
540 : */
541 : #ifndef FRONTEND
542 : static inline bool
543 24893284 : ExecQualAndReset(ExprState *state, ExprContext *econtext)
544 : {
545 24893284 : bool ret = ExecQual(state, econtext);
546 :
547 : /* inline ResetExprContext, to avoid ordering issue in this file */
548 24893284 : MemoryContextReset(econtext->ecxt_per_tuple_memory);
549 24893284 : return ret;
550 : }
551 : #endif
552 :
553 : extern bool ExecCheck(ExprState *state, ExprContext *econtext);
554 :
555 : /*
556 : * prototypes from functions in execSRF.c
557 : */
558 : extern SetExprState *ExecInitTableFunctionResult(Expr *expr,
559 : ExprContext *econtext, PlanState *parent);
560 : extern Tuplestorestate *ExecMakeTableFunctionResult(SetExprState *setexpr,
561 : ExprContext *econtext,
562 : MemoryContext argContext,
563 : TupleDesc expectedDesc,
564 : bool randomAccess);
565 : extern SetExprState *ExecInitFunctionResultSet(Expr *expr,
566 : ExprContext *econtext, PlanState *parent);
567 : extern Datum ExecMakeFunctionResultSet(SetExprState *fcache,
568 : ExprContext *econtext,
569 : MemoryContext argContext,
570 : bool *isNull,
571 : ExprDoneCond *isDone);
572 :
573 : /*
574 : * prototypes from functions in execScan.c
575 : */
576 : typedef TupleTableSlot *(*ExecScanAccessMtd) (ScanState *node);
577 : typedef bool (*ExecScanRecheckMtd) (ScanState *node, TupleTableSlot *slot);
578 :
579 : extern TupleTableSlot *ExecScan(ScanState *node, ExecScanAccessMtd accessMtd,
580 : ExecScanRecheckMtd recheckMtd);
581 : extern void ExecAssignScanProjectionInfo(ScanState *node);
582 : extern void ExecAssignScanProjectionInfoWithVarno(ScanState *node, int varno);
583 : extern void ExecScanReScan(ScanState *node);
584 :
585 : /*
586 : * prototypes from functions in execTuples.c
587 : */
588 : extern void ExecInitResultTypeTL(PlanState *planstate);
589 : extern void ExecInitResultSlot(PlanState *planstate,
590 : const TupleTableSlotOps *tts_ops);
591 : extern void ExecInitResultTupleSlotTL(PlanState *planstate,
592 : const TupleTableSlotOps *tts_ops);
593 : extern void ExecInitScanTupleSlot(EState *estate, ScanState *scanstate,
594 : TupleDesc tupledesc,
595 : const TupleTableSlotOps *tts_ops);
596 : extern TupleTableSlot *ExecInitExtraTupleSlot(EState *estate,
597 : TupleDesc tupledesc,
598 : const TupleTableSlotOps *tts_ops);
599 : extern TupleTableSlot *ExecInitNullTupleSlot(EState *estate, TupleDesc tupType,
600 : const TupleTableSlotOps *tts_ops);
601 : extern TupleDesc ExecTypeFromTL(List *targetList);
602 : extern TupleDesc ExecCleanTypeFromTL(List *targetList);
603 : extern TupleDesc ExecTypeFromExprList(List *exprList);
604 : extern void ExecTypeSetColNames(TupleDesc typeInfo, List *namesList);
605 : extern void UpdateChangedParamSet(PlanState *node, Bitmapset *newchg);
606 :
607 : typedef struct TupOutputState
608 : {
609 : TupleTableSlot *slot;
610 : DestReceiver *dest;
611 : } TupOutputState;
612 :
613 : extern TupOutputState *begin_tup_output_tupdesc(DestReceiver *dest,
614 : TupleDesc tupdesc,
615 : const TupleTableSlotOps *tts_ops);
616 : extern void do_tup_output(TupOutputState *tstate, const Datum *values, const bool *isnull);
617 : extern void do_text_output_multiline(TupOutputState *tstate, const char *txt);
618 : extern void end_tup_output(TupOutputState *tstate);
619 :
620 : /*
621 : * Write a single line of text given as a C string.
622 : *
623 : * Should only be used with a single-TEXT-attribute tupdesc.
624 : */
625 : #define do_text_output_oneline(tstate, str_to_emit) \
626 : do { \
627 : Datum values_[1]; \
628 : bool isnull_[1]; \
629 : values_[0] = PointerGetDatum(cstring_to_text(str_to_emit)); \
630 : isnull_[0] = false; \
631 : do_tup_output(tstate, values_, isnull_); \
632 : pfree(DatumGetPointer(values_[0])); \
633 : } while (0)
634 :
635 :
636 : /*
637 : * prototypes from functions in execUtils.c
638 : */
639 : extern EState *CreateExecutorState(void);
640 : extern void FreeExecutorState(EState *estate);
641 : extern ExprContext *CreateExprContext(EState *estate);
642 : extern ExprContext *CreateWorkExprContext(EState *estate);
643 : extern ExprContext *CreateStandaloneExprContext(void);
644 : extern void FreeExprContext(ExprContext *econtext, bool isCommit);
645 : extern void ReScanExprContext(ExprContext *econtext);
646 :
647 : #define ResetExprContext(econtext) \
648 : MemoryContextReset((econtext)->ecxt_per_tuple_memory)
649 :
650 : extern ExprContext *MakePerTupleExprContext(EState *estate);
651 :
652 : /* Get an EState's per-output-tuple exprcontext, making it if first use */
653 : #define GetPerTupleExprContext(estate) \
654 : ((estate)->es_per_tuple_exprcontext ? \
655 : (estate)->es_per_tuple_exprcontext : \
656 : MakePerTupleExprContext(estate))
657 :
658 : #define GetPerTupleMemoryContext(estate) \
659 : (GetPerTupleExprContext(estate)->ecxt_per_tuple_memory)
660 :
661 : /* Reset an EState's per-output-tuple exprcontext, if one's been created */
662 : #define ResetPerTupleExprContext(estate) \
663 : do { \
664 : if ((estate)->es_per_tuple_exprcontext) \
665 : ResetExprContext((estate)->es_per_tuple_exprcontext); \
666 : } while (0)
667 :
668 : extern void ExecAssignExprContext(EState *estate, PlanState *planstate);
669 : extern TupleDesc ExecGetResultType(PlanState *planstate);
670 : extern const TupleTableSlotOps *ExecGetResultSlotOps(PlanState *planstate,
671 : bool *isfixed);
672 : extern const TupleTableSlotOps *ExecGetCommonSlotOps(PlanState **planstates,
673 : int nplans);
674 : extern const TupleTableSlotOps *ExecGetCommonChildSlotOps(PlanState *ps);
675 : extern void ExecAssignProjectionInfo(PlanState *planstate,
676 : TupleDesc inputDesc);
677 : extern void ExecConditionalAssignProjectionInfo(PlanState *planstate,
678 : TupleDesc inputDesc, int varno);
679 : extern void ExecAssignScanType(ScanState *scanstate, TupleDesc tupDesc);
680 : extern void ExecCreateScanSlotFromOuterPlan(EState *estate,
681 : ScanState *scanstate,
682 : const TupleTableSlotOps *tts_ops);
683 :
684 : extern bool ExecRelationIsTargetRelation(EState *estate, Index scanrelid);
685 :
686 : extern Relation ExecOpenScanRelation(EState *estate, Index scanrelid, int eflags);
687 :
688 : extern void ExecInitRangeTable(EState *estate, List *rangeTable, List *permInfos,
689 : Bitmapset *unpruned_relids);
690 : extern void ExecCloseRangeTableRelations(EState *estate);
691 : extern void ExecCloseResultRelations(EState *estate);
692 :
693 : static inline RangeTblEntry *
694 811918 : exec_rt_fetch(Index rti, EState *estate)
695 : {
696 811918 : return (RangeTblEntry *) list_nth(estate->es_range_table, rti - 1);
697 : }
698 :
699 : extern Relation ExecGetRangeTableRelation(EState *estate, Index rti,
700 : bool isResultRel);
701 : extern void ExecInitResultRelation(EState *estate, ResultRelInfo *resultRelInfo,
702 : Index rti);
703 :
704 : extern int executor_errposition(EState *estate, int location);
705 :
706 : extern void RegisterExprContextCallback(ExprContext *econtext,
707 : ExprContextCallbackFunction function,
708 : Datum arg);
709 : extern void UnregisterExprContextCallback(ExprContext *econtext,
710 : ExprContextCallbackFunction function,
711 : Datum arg);
712 :
713 : extern Datum GetAttributeByName(HeapTupleHeader tuple, const char *attname,
714 : bool *isNull);
715 : extern Datum GetAttributeByNum(HeapTupleHeader tuple, AttrNumber attrno,
716 : bool *isNull);
717 :
718 : extern int ExecTargetListLength(List *targetlist);
719 : extern int ExecCleanTargetListLength(List *targetlist);
720 :
721 : extern TupleTableSlot *ExecGetTriggerOldSlot(EState *estate, ResultRelInfo *relInfo);
722 : extern TupleTableSlot *ExecGetTriggerNewSlot(EState *estate, ResultRelInfo *relInfo);
723 : extern TupleTableSlot *ExecGetReturningSlot(EState *estate, ResultRelInfo *relInfo);
724 : extern TupleTableSlot *ExecGetAllNullSlot(EState *estate, ResultRelInfo *relInfo);
725 : extern TupleConversionMap *ExecGetChildToRootMap(ResultRelInfo *resultRelInfo);
726 : extern TupleConversionMap *ExecGetRootToChildMap(ResultRelInfo *resultRelInfo, EState *estate);
727 :
728 : extern Oid ExecGetResultRelCheckAsUser(ResultRelInfo *relInfo, EState *estate);
729 : extern Bitmapset *ExecGetInsertedCols(ResultRelInfo *relinfo, EState *estate);
730 : extern Bitmapset *ExecGetUpdatedCols(ResultRelInfo *relinfo, EState *estate);
731 : extern Bitmapset *ExecGetExtraUpdatedCols(ResultRelInfo *relinfo, EState *estate);
732 : extern Bitmapset *ExecGetAllUpdatedCols(ResultRelInfo *relinfo, EState *estate);
733 :
734 : /*
735 : * prototypes from functions in execIndexing.c
736 : */
737 : extern void ExecOpenIndices(ResultRelInfo *resultRelInfo, bool speculative);
738 : extern void ExecCloseIndices(ResultRelInfo *resultRelInfo);
739 : extern List *ExecInsertIndexTuples(ResultRelInfo *resultRelInfo,
740 : TupleTableSlot *slot, EState *estate,
741 : bool update,
742 : bool noDupErr,
743 : bool *specConflict, List *arbiterIndexes,
744 : bool onlySummarizing);
745 : extern bool ExecCheckIndexConstraints(ResultRelInfo *resultRelInfo,
746 : TupleTableSlot *slot,
747 : EState *estate, ItemPointer conflictTid,
748 : ItemPointer tupleid,
749 : List *arbiterIndexes);
750 : extern void check_exclusion_constraint(Relation heap, Relation index,
751 : IndexInfo *indexInfo,
752 : ItemPointer tupleid,
753 : const Datum *values, const bool *isnull,
754 : EState *estate, bool newIndex);
755 :
756 : /*
757 : * prototypes from functions in execReplication.c
758 : */
759 : extern bool RelationFindReplTupleByIndex(Relation rel, Oid idxoid,
760 : LockTupleMode lockmode,
761 : TupleTableSlot *searchslot,
762 : TupleTableSlot *outslot);
763 : extern bool RelationFindReplTupleSeq(Relation rel, LockTupleMode lockmode,
764 : TupleTableSlot *searchslot, TupleTableSlot *outslot);
765 : extern bool RelationFindDeletedTupleInfoSeq(Relation rel,
766 : TupleTableSlot *searchslot,
767 : TransactionId oldestxmin,
768 : TransactionId *delete_xid,
769 : RepOriginId *delete_origin,
770 : TimestampTz *delete_time);
771 : extern bool RelationFindDeletedTupleInfoByIndex(Relation rel, Oid idxoid,
772 : TupleTableSlot *searchslot,
773 : TransactionId oldestxmin,
774 : TransactionId *delete_xid,
775 : RepOriginId *delete_origin,
776 : TimestampTz *delete_time);
777 : extern void ExecSimpleRelationInsert(ResultRelInfo *resultRelInfo,
778 : EState *estate, TupleTableSlot *slot);
779 : extern void ExecSimpleRelationUpdate(ResultRelInfo *resultRelInfo,
780 : EState *estate, EPQState *epqstate,
781 : TupleTableSlot *searchslot, TupleTableSlot *slot);
782 : extern void ExecSimpleRelationDelete(ResultRelInfo *resultRelInfo,
783 : EState *estate, EPQState *epqstate,
784 : TupleTableSlot *searchslot);
785 : extern void CheckCmdReplicaIdentity(Relation rel, CmdType cmd);
786 :
787 : extern void CheckSubscriptionRelkind(char localrelkind, char remoterelkind,
788 : const char *nspname, const char *relname);
789 :
790 : /*
791 : * prototypes from functions in nodeModifyTable.c
792 : */
793 : extern TupleTableSlot *ExecGetUpdateNewTuple(ResultRelInfo *relinfo,
794 : TupleTableSlot *planSlot,
795 : TupleTableSlot *oldSlot);
796 : extern ResultRelInfo *ExecLookupResultRelByOid(ModifyTableState *node,
797 : Oid resultoid,
798 : bool missing_ok,
799 : bool update_cache);
800 :
801 : #endif /* EXECUTOR_H */
|
