mirror of
https://git.postgresql.org/git/postgresql.git
synced 2024-09-30 22:31:37 +02:00
2ff501590b
Also performed an initial run through of upgrading our Copyright date to extend to 2005 ... first run here was very simple ... change everything where: grep 1996-2004 && the word 'Copyright' ... scanned through the generated list with 'less' first, and after, to make sure that I only picked up the right entries ...
268 lines
9.6 KiB
C
268 lines
9.6 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* executor.h
|
|
* support for the POSTGRES executor module
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2005, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* $PostgreSQL: pgsql/src/include/executor/executor.h,v 1.115 2004/12/31 22:03:29 pgsql Exp $
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef EXECUTOR_H
|
|
#define EXECUTOR_H
|
|
|
|
#include "executor/execdesc.h"
|
|
|
|
|
|
/*
|
|
* TupIsNull
|
|
*
|
|
* This is used mainly to detect when there are no more
|
|
* tuples to process.
|
|
*/
|
|
/* return: true if tuple in slot is NULL, slot is slot to test */
|
|
#define TupIsNull(slot) \
|
|
((slot) == NULL || (slot)->val == NULL)
|
|
|
|
|
|
/*
|
|
* ExecEvalExpr was formerly a function containing a switch statement;
|
|
* now it's just a macro invoking the function pointed to by an ExprState
|
|
* node. Beware of double evaluation of the ExprState argument!
|
|
*/
|
|
#define ExecEvalExpr(expr, econtext, isNull, isDone) \
|
|
((*(expr)->evalfunc) (expr, econtext, isNull, isDone))
|
|
|
|
|
|
/*
|
|
* prototypes from functions in execAmi.c
|
|
*/
|
|
extern void ExecReScan(PlanState *node, ExprContext *exprCtxt);
|
|
extern void ExecMarkPos(PlanState *node);
|
|
extern void ExecRestrPos(PlanState *node);
|
|
extern bool ExecSupportsMarkRestore(NodeTag plantype);
|
|
extern bool ExecSupportsBackwardScan(Plan *node);
|
|
extern bool ExecMayReturnRawTuples(PlanState *node);
|
|
|
|
/*
|
|
* prototypes from functions in execGrouping.c
|
|
*/
|
|
extern bool execTuplesMatch(HeapTuple tuple1,
|
|
HeapTuple tuple2,
|
|
TupleDesc tupdesc,
|
|
int numCols,
|
|
AttrNumber *matchColIdx,
|
|
FmgrInfo *eqfunctions,
|
|
MemoryContext evalContext);
|
|
extern bool execTuplesUnequal(HeapTuple tuple1,
|
|
HeapTuple tuple2,
|
|
TupleDesc tupdesc,
|
|
int numCols,
|
|
AttrNumber *matchColIdx,
|
|
FmgrInfo *eqfunctions,
|
|
MemoryContext evalContext);
|
|
extern FmgrInfo *execTuplesMatchPrepare(TupleDesc tupdesc,
|
|
int numCols,
|
|
AttrNumber *matchColIdx);
|
|
extern void execTuplesHashPrepare(TupleDesc tupdesc,
|
|
int numCols,
|
|
AttrNumber *matchColIdx,
|
|
FmgrInfo **eqfunctions,
|
|
FmgrInfo **hashfunctions);
|
|
extern TupleHashTable BuildTupleHashTable(int numCols, AttrNumber *keyColIdx,
|
|
FmgrInfo *eqfunctions,
|
|
FmgrInfo *hashfunctions,
|
|
int nbuckets, Size entrysize,
|
|
MemoryContext tablecxt,
|
|
MemoryContext tempcxt);
|
|
extern TupleHashEntry LookupTupleHashEntry(TupleHashTable hashtable,
|
|
TupleTableSlot *slot,
|
|
bool *isnew);
|
|
|
|
/*
|
|
* prototypes from functions in execJunk.c
|
|
*/
|
|
extern JunkFilter *ExecInitJunkFilter(List *targetList, bool hasoid,
|
|
TupleTableSlot *slot);
|
|
extern JunkFilter *ExecInitJunkFilterConversion(List *targetList,
|
|
TupleDesc cleanTupType,
|
|
TupleTableSlot *slot);
|
|
extern bool ExecGetJunkAttribute(JunkFilter *junkfilter, TupleTableSlot *slot,
|
|
char *attrName, Datum *value, bool *isNull);
|
|
extern HeapTuple ExecRemoveJunk(JunkFilter *junkfilter, TupleTableSlot *slot);
|
|
|
|
|
|
/*
|
|
* prototypes from functions in execMain.c
|
|
*/
|
|
extern void ExecutorStart(QueryDesc *queryDesc, bool explainOnly);
|
|
extern TupleTableSlot *ExecutorRun(QueryDesc *queryDesc,
|
|
ScanDirection direction, long count);
|
|
extern void ExecutorEnd(QueryDesc *queryDesc);
|
|
extern void ExecutorRewind(QueryDesc *queryDesc);
|
|
extern void ExecCheckRTPerms(List *rangeTable);
|
|
extern void ExecEndPlan(PlanState *planstate, EState *estate);
|
|
extern bool ExecContextForcesOids(PlanState *planstate, bool *hasoids);
|
|
extern void ExecConstraints(ResultRelInfo *resultRelInfo,
|
|
TupleTableSlot *slot, EState *estate);
|
|
extern TupleTableSlot *EvalPlanQual(EState *estate, Index rti,
|
|
ItemPointer tid);
|
|
|
|
/*
|
|
* prototypes from functions in execProcnode.c
|
|
*/
|
|
extern PlanState *ExecInitNode(Plan *node, EState *estate);
|
|
extern TupleTableSlot *ExecProcNode(PlanState *node);
|
|
extern int ExecCountSlotsNode(Plan *node);
|
|
extern void ExecEndNode(PlanState *node);
|
|
|
|
/*
|
|
* prototypes from functions in execQual.c
|
|
*/
|
|
extern Datum GetAttributeByNum(HeapTupleHeader tuple, AttrNumber attrno,
|
|
bool *isNull);
|
|
extern Datum GetAttributeByName(HeapTupleHeader tuple, const char *attname,
|
|
bool *isNull);
|
|
extern void init_fcache(Oid foid, FuncExprState *fcache,
|
|
MemoryContext fcacheCxt);
|
|
extern Datum ExecMakeFunctionResult(FuncExprState *fcache,
|
|
ExprContext *econtext,
|
|
bool *isNull,
|
|
ExprDoneCond *isDone);
|
|
extern Tuplestorestate *ExecMakeTableFunctionResult(ExprState *funcexpr,
|
|
ExprContext *econtext,
|
|
TupleDesc expectedDesc,
|
|
TupleDesc *returnDesc);
|
|
extern Datum ExecEvalExprSwitchContext(ExprState *expression, ExprContext *econtext,
|
|
bool *isNull, ExprDoneCond *isDone);
|
|
extern ExprState *ExecInitExpr(Expr *node, PlanState *parent);
|
|
extern SubPlanState *ExecInitExprInitPlan(SubPlan *node, PlanState *parent);
|
|
extern ExprState *ExecPrepareExpr(Expr *node, EState *estate);
|
|
extern bool ExecQual(List *qual, ExprContext *econtext, bool resultForNull);
|
|
extern int ExecTargetListLength(List *targetlist);
|
|
extern int ExecCleanTargetListLength(List *targetlist);
|
|
extern TupleTableSlot *ExecProject(ProjectionInfo *projInfo,
|
|
ExprDoneCond *isDone);
|
|
|
|
/*
|
|
* prototypes from functions in execScan.c
|
|
*/
|
|
typedef TupleTableSlot *(*ExecScanAccessMtd) (ScanState *node);
|
|
|
|
extern TupleTableSlot *ExecScan(ScanState *node, ExecScanAccessMtd accessMtd);
|
|
extern void ExecAssignScanProjectionInfo(ScanState *node);
|
|
|
|
/*
|
|
* prototypes from functions in execTuples.c
|
|
*/
|
|
extern TupleTable ExecCreateTupleTable(int initialSize);
|
|
extern void ExecDropTupleTable(TupleTable table, bool shouldFree);
|
|
extern TupleTableSlot *ExecAllocTableSlot(TupleTable table);
|
|
extern TupleTableSlot *MakeTupleTableSlot(void);
|
|
extern TupleTableSlot *ExecStoreTuple(HeapTuple tuple,
|
|
TupleTableSlot *slot,
|
|
Buffer buffer,
|
|
bool shouldFree);
|
|
extern TupleTableSlot *ExecClearTuple(TupleTableSlot *slot);
|
|
extern void ExecSetSlotDescriptor(TupleTableSlot *slot,
|
|
TupleDesc tupdesc, bool shouldFree);
|
|
extern void ExecSetSlotDescriptorIsNew(TupleTableSlot *slot, bool isNew);
|
|
extern void ExecInitResultTupleSlot(EState *estate, PlanState *planstate);
|
|
extern void ExecInitScanTupleSlot(EState *estate, ScanState *scanstate);
|
|
extern TupleTableSlot *ExecInitExtraTupleSlot(EState *estate);
|
|
extern TupleTableSlot *ExecInitNullTupleSlot(EState *estate,
|
|
TupleDesc tupType);
|
|
extern TupleDesc ExecTypeFromTL(List *targetList, bool hasoid);
|
|
extern TupleDesc ExecCleanTypeFromTL(List *targetList, bool hasoid);
|
|
extern TupleDesc ExecTypeFromExprList(List *exprList);
|
|
extern void UpdateChangedParamSet(PlanState *node, Bitmapset *newchg);
|
|
|
|
typedef struct TupOutputState
|
|
{
|
|
/* use "struct" here to allow forward reference */
|
|
struct AttInMetadata *metadata;
|
|
DestReceiver *dest;
|
|
} TupOutputState;
|
|
|
|
extern TupOutputState *begin_tup_output_tupdesc(DestReceiver *dest,
|
|
TupleDesc tupdesc);
|
|
extern void do_tup_output(TupOutputState *tstate, char **values);
|
|
extern void do_text_output_multiline(TupOutputState *tstate, char *text);
|
|
extern void end_tup_output(TupOutputState *tstate);
|
|
|
|
/*
|
|
* Write a single line of text given as a C string.
|
|
*
|
|
* Should only be used with a single-TEXT-attribute tupdesc.
|
|
*/
|
|
#define do_text_output_oneline(tstate, text_to_emit) \
|
|
do { \
|
|
char *values_[1]; \
|
|
values_[0] = (text_to_emit); \
|
|
do_tup_output(tstate, values_); \
|
|
} while (0)
|
|
|
|
|
|
/*
|
|
* prototypes from functions in execUtils.c
|
|
*/
|
|
extern EState *CreateExecutorState(void);
|
|
extern void FreeExecutorState(EState *estate);
|
|
extern ExprContext *CreateExprContext(EState *estate);
|
|
extern void FreeExprContext(ExprContext *econtext);
|
|
extern void ReScanExprContext(ExprContext *econtext);
|
|
|
|
#define ResetExprContext(econtext) \
|
|
MemoryContextReset((econtext)->ecxt_per_tuple_memory)
|
|
|
|
extern ExprContext *MakePerTupleExprContext(EState *estate);
|
|
|
|
/* Get an EState's per-output-tuple exprcontext, making it if first use */
|
|
#define GetPerTupleExprContext(estate) \
|
|
((estate)->es_per_tuple_exprcontext ? \
|
|
(estate)->es_per_tuple_exprcontext : \
|
|
MakePerTupleExprContext(estate))
|
|
|
|
#define GetPerTupleMemoryContext(estate) \
|
|
(GetPerTupleExprContext(estate)->ecxt_per_tuple_memory)
|
|
|
|
/* Reset an EState's per-output-tuple exprcontext, if one's been created */
|
|
#define ResetPerTupleExprContext(estate) \
|
|
do { \
|
|
if ((estate)->es_per_tuple_exprcontext) \
|
|
ResetExprContext((estate)->es_per_tuple_exprcontext); \
|
|
} while (0)
|
|
|
|
extern void ExecAssignExprContext(EState *estate, PlanState *planstate);
|
|
extern void ExecAssignResultType(PlanState *planstate,
|
|
TupleDesc tupDesc, bool shouldFree);
|
|
extern void ExecAssignResultTypeFromOuterPlan(PlanState *planstate);
|
|
extern void ExecAssignResultTypeFromTL(PlanState *planstate);
|
|
extern TupleDesc ExecGetResultType(PlanState *planstate);
|
|
extern ProjectionInfo *ExecBuildProjectionInfo(List *targetList,
|
|
ExprContext *econtext,
|
|
TupleTableSlot *slot);
|
|
extern void ExecAssignProjectionInfo(PlanState *planstate);
|
|
extern void ExecFreeExprContext(PlanState *planstate);
|
|
extern TupleDesc ExecGetScanType(ScanState *scanstate);
|
|
extern void ExecAssignScanType(ScanState *scanstate,
|
|
TupleDesc tupDesc, bool shouldFree);
|
|
extern void ExecAssignScanTypeFromOuterPlan(ScanState *scanstate);
|
|
|
|
extern void ExecOpenIndices(ResultRelInfo *resultRelInfo);
|
|
extern void ExecCloseIndices(ResultRelInfo *resultRelInfo);
|
|
extern void ExecInsertIndexTuples(TupleTableSlot *slot, ItemPointer tupleid,
|
|
EState *estate, bool is_vacuum);
|
|
|
|
extern void RegisterExprContextCallback(ExprContext *econtext,
|
|
ExprContextCallbackFunction function,
|
|
Datum arg);
|
|
extern void UnregisterExprContextCallback(ExprContext *econtext,
|
|
ExprContextCallbackFunction function,
|
|
Datum arg);
|
|
|
|
#endif /* EXECUTOR_H */
|