PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
nodeForeignscan.h File Reference
#include "access/parallel.h"
#include "nodes/execnodes.h"
Include dependency graph for nodeForeignscan.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

ForeignScanStateExecInitForeignScan (ForeignScan *node, EState *estate, int eflags)
 
TupleTableSlotExecForeignScan (ForeignScanState *node)
 
void ExecEndForeignScan (ForeignScanState *node)
 
void ExecReScanForeignScan (ForeignScanState *node)
 
void ExecForeignScanEstimate (ForeignScanState *node, ParallelContext *pcxt)
 
void ExecForeignScanInitializeDSM (ForeignScanState *node, ParallelContext *pcxt)
 
void ExecForeignScanInitializeWorker (ForeignScanState *node, shm_toc *toc)
 
void ExecShutdownForeignScan (ForeignScanState *node)
 

Function Documentation

void ExecEndForeignScan ( ForeignScanState node)

Definition at line 240 of file nodeForeignscan.c.

References CMD_SELECT, FdwRoutine::EndDirectModify, FdwRoutine::EndForeignScan, ExecClearTuple(), ExecCloseScanRelation(), ExecEndNode(), ExecFreeExprContext(), ForeignScanState::fdwroutine, ForeignScan::operation, outerPlanState, PlanState::plan, ScanState::ps, PlanState::ps_ResultTupleSlot, ForeignScanState::ss, ScanState::ss_currentRelation, and ScanState::ss_ScanTupleSlot.

Referenced by ExecEndNode().

241 {
242  ForeignScan *plan = (ForeignScan *) node->ss.ps.plan;
243 
244  /* Let the FDW shut down */
245  if (plan->operation != CMD_SELECT)
246  node->fdwroutine->EndDirectModify(node);
247  else
248  node->fdwroutine->EndForeignScan(node);
249 
250  /* Shut down any outer plan. */
251  if (outerPlanState(node))
253 
254  /* Free the exprcontext */
255  ExecFreeExprContext(&node->ss.ps);
256 
257  /* clean out the tuple table */
260 
261  /* close the relation. */
262  if (node->ss.ss_currentRelation)
264 }
EndDirectModify_function EndDirectModify
Definition: fdwapi.h:205
ScanState ss
Definition: execnodes.h:1522
void ExecEndNode(PlanState *node)
Definition: execProcnode.c:654
TupleTableSlot * ExecClearTuple(TupleTableSlot *slot)
Definition: execTuples.c:439
TupleTableSlot * ss_ScanTupleSlot
Definition: execnodes.h:1082
Relation ss_currentRelation
Definition: execnodes.h:1080
void ExecFreeExprContext(PlanState *planstate)
Definition: execUtils.c:516
CmdType operation
Definition: plannodes.h:598
PlanState ps
Definition: execnodes.h:1079
TupleTableSlot * ps_ResultTupleSlot
Definition: execnodes.h:861
#define outerPlanState(node)
Definition: execnodes.h:874
EndForeignScan_function EndForeignScan
Definition: fdwapi.h:180
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1526
Plan * plan
Definition: execnodes.h:832
void ExecCloseScanRelation(Relation scanrel)
Definition: execUtils.c:661
TupleTableSlot* ExecForeignScan ( ForeignScanState node)

Definition at line 117 of file nodeForeignscan.c.

References ExecScan(), ForeignNext(), and ForeignRecheck().

Referenced by ExecProcNode().

118 {
119  return ExecScan((ScanState *) node,
122 }
TupleTableSlot * ExecScan(ScanState *node, ExecScanAccessMtd accessMtd, ExecScanRecheckMtd recheckMtd)
Definition: execScan.c:121
static bool ForeignRecheck(ForeignScanState *node, TupleTableSlot *slot)
TupleTableSlot *(* ExecScanAccessMtd)(ScanState *node)
Definition: executor.h:390
bool(* ExecScanRecheckMtd)(ScanState *node, TupleTableSlot *slot)
Definition: executor.h:391
static TupleTableSlot * ForeignNext(ForeignScanState *node)
void ExecForeignScanEstimate ( ForeignScanState node,
ParallelContext pcxt 
)

Definition at line 297 of file nodeForeignscan.c.

References FdwRoutine::EstimateDSMForeignScan, ParallelContext::estimator, ForeignScanState::fdwroutine, ForeignScanState::pscan_len, shm_toc_estimate_chunk, and shm_toc_estimate_keys.

Referenced by ExecParallelEstimate().

298 {
299  FdwRoutine *fdwroutine = node->fdwroutine;
300 
301  if (fdwroutine->EstimateDSMForeignScan)
302  {
303  node->pscan_len = fdwroutine->EstimateDSMForeignScan(node, pcxt);
305  shm_toc_estimate_keys(&pcxt->estimator, 1);
306  }
307 }
EstimateDSMForeignScan_function EstimateDSMForeignScan
Definition: fdwapi.h:225
shm_toc_estimator estimator
Definition: parallel.h:41
#define shm_toc_estimate_chunk(e, sz)
Definition: shm_toc.h:51
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1526
#define shm_toc_estimate_keys(e, cnt)
Definition: shm_toc.h:53
void ExecForeignScanInitializeDSM ( ForeignScanState node,
ParallelContext pcxt 
)

Definition at line 316 of file nodeForeignscan.c.

References ForeignScanState::fdwroutine, FdwRoutine::InitializeDSMForeignScan, PlanState::plan, Plan::plan_node_id, ScanState::ps, ForeignScanState::pscan_len, shm_toc_allocate(), shm_toc_insert(), ForeignScanState::ss, and ParallelContext::toc.

Referenced by ExecParallelInitializeDSM().

317 {
318  FdwRoutine *fdwroutine = node->fdwroutine;
319 
320  if (fdwroutine->InitializeDSMForeignScan)
321  {
322  int plan_node_id = node->ss.ps.plan->plan_node_id;
323  void *coordinate;
324 
325  coordinate = shm_toc_allocate(pcxt->toc, node->pscan_len);
326  fdwroutine->InitializeDSMForeignScan(node, pcxt, coordinate);
327  shm_toc_insert(pcxt->toc, plan_node_id, coordinate);
328  }
329 }
ScanState ss
Definition: execnodes.h:1522
int plan_node_id
Definition: plannodes.h:143
PlanState ps
Definition: execnodes.h:1079
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1526
InitializeDSMForeignScan_function InitializeDSMForeignScan
Definition: fdwapi.h:226
Plan * plan
Definition: execnodes.h:832
void * shm_toc_allocate(shm_toc *toc, Size nbytes)
Definition: shm_toc.c:83
void shm_toc_insert(shm_toc *toc, uint64 key, void *address)
Definition: shm_toc.c:161
shm_toc * toc
Definition: parallel.h:44
void ExecForeignScanInitializeWorker ( ForeignScanState node,
shm_toc toc 
)

Definition at line 338 of file nodeForeignscan.c.

References ForeignScanState::fdwroutine, FdwRoutine::InitializeWorkerForeignScan, PlanState::plan, Plan::plan_node_id, ScanState::ps, shm_toc_lookup(), and ForeignScanState::ss.

Referenced by ExecParallelInitializeWorker().

339 {
340  FdwRoutine *fdwroutine = node->fdwroutine;
341 
342  if (fdwroutine->InitializeWorkerForeignScan)
343  {
344  int plan_node_id = node->ss.ps.plan->plan_node_id;
345  void *coordinate;
346 
347  coordinate = shm_toc_lookup(toc, plan_node_id, false);
348  fdwroutine->InitializeWorkerForeignScan(node, toc, coordinate);
349  }
350 }
ScanState ss
Definition: execnodes.h:1522
InitializeWorkerForeignScan_function InitializeWorkerForeignScan
Definition: fdwapi.h:227
int plan_node_id
Definition: plannodes.h:143
PlanState ps
Definition: execnodes.h:1079
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1526
Plan * plan
Definition: execnodes.h:832
void * shm_toc_lookup(shm_toc *toc, uint64 key, bool noError)
Definition: shm_toc.c:222
ForeignScanState* ExecInitForeignScan ( ForeignScan node,
EState estate,
int  eflags 
)

Definition at line 130 of file nodeForeignscan.c.

References Assert, FdwRoutine::BeginDirectModify, FdwRoutine::BeginForeignScan, CMD_SELECT, EXEC_FLAG_BACKWARD, EXEC_FLAG_MARK, ExecAssignExprContext(), ExecAssignResultTypeFromTL(), ExecAssignScanProjectionInfoWithVarno(), ExecAssignScanType(), ExecInitNode(), ExecInitQual(), ExecInitResultTupleSlot(), ExecInitScanTupleSlot(), ExecOpenScanRelation(), ExecTypeFromTL(), ForeignScan::fdw_recheck_quals, ForeignScanState::fdw_recheck_quals, ForeignScan::fdw_scan_tlist, ForeignScanState::fdw_state, ForeignScanState::fdwroutine, ForeignScan::fs_server, GetFdwRoutineByServerId(), GetFdwRoutineForRelation(), INDEX_VAR, makeNode, NIL, NULL, ForeignScan::operation, outerPlan, outerPlanState, Scan::plan, PlanState::plan, ScanState::ps, Plan::qual, PlanState::qual, RelationGetDescr, ForeignScan::scan, Scan::scanrelid, ForeignScanState::ss, ScanState::ss_currentRelation, and PlanState::state.

Referenced by ExecInitNode().

131 {
132  ForeignScanState *scanstate;
133  Relation currentRelation = NULL;
134  Index scanrelid = node->scan.scanrelid;
135  Index tlistvarno;
136  FdwRoutine *fdwroutine;
137 
138  /* check for unsupported flags */
139  Assert(!(eflags & (EXEC_FLAG_BACKWARD | EXEC_FLAG_MARK)));
140 
141  /*
142  * create state structure
143  */
144  scanstate = makeNode(ForeignScanState);
145  scanstate->ss.ps.plan = (Plan *) node;
146  scanstate->ss.ps.state = estate;
147 
148  /*
149  * Miscellaneous initialization
150  *
151  * create expression context for node
152  */
153  ExecAssignExprContext(estate, &scanstate->ss.ps);
154 
155  /*
156  * initialize child expressions
157  */
158  scanstate->ss.ps.qual =
159  ExecInitQual(node->scan.plan.qual, (PlanState *) scanstate);
160  scanstate->fdw_recheck_quals =
161  ExecInitQual(node->fdw_recheck_quals, (PlanState *) scanstate);
162 
163  /*
164  * tuple table initialization
165  */
166  ExecInitResultTupleSlot(estate, &scanstate->ss.ps);
167  ExecInitScanTupleSlot(estate, &scanstate->ss);
168 
169  /*
170  * open the base relation, if any, and acquire an appropriate lock on it;
171  * also acquire function pointers from the FDW's handler
172  */
173  if (scanrelid > 0)
174  {
175  currentRelation = ExecOpenScanRelation(estate, scanrelid, eflags);
176  scanstate->ss.ss_currentRelation = currentRelation;
177  fdwroutine = GetFdwRoutineForRelation(currentRelation, true);
178  }
179  else
180  {
181  /* We can't use the relcache, so get fdwroutine the hard way */
182  fdwroutine = GetFdwRoutineByServerId(node->fs_server);
183  }
184 
185  /*
186  * Determine the scan tuple type. If the FDW provided a targetlist
187  * describing the scan tuples, use that; else use base relation's rowtype.
188  */
189  if (node->fdw_scan_tlist != NIL || currentRelation == NULL)
190  {
191  TupleDesc scan_tupdesc;
192 
193  scan_tupdesc = ExecTypeFromTL(node->fdw_scan_tlist, false);
194  ExecAssignScanType(&scanstate->ss, scan_tupdesc);
195  /* Node's targetlist will contain Vars with varno = INDEX_VAR */
196  tlistvarno = INDEX_VAR;
197  }
198  else
199  {
200  ExecAssignScanType(&scanstate->ss, RelationGetDescr(currentRelation));
201  /* Node's targetlist will contain Vars with varno = scanrelid */
202  tlistvarno = scanrelid;
203  }
204 
205  /*
206  * Initialize result tuple type and projection info.
207  */
208  ExecAssignResultTypeFromTL(&scanstate->ss.ps);
209  ExecAssignScanProjectionInfoWithVarno(&scanstate->ss, tlistvarno);
210 
211  /*
212  * Initialize FDW-related state.
213  */
214  scanstate->fdwroutine = fdwroutine;
215  scanstate->fdw_state = NULL;
216 
217  /* Initialize any outer plan. */
218  if (outerPlan(node))
219  outerPlanState(scanstate) =
220  ExecInitNode(outerPlan(node), estate, eflags);
221 
222  /*
223  * Tell the FDW to initialize the scan.
224  */
225  if (node->operation != CMD_SELECT)
226  fdwroutine->BeginDirectModify(scanstate, eflags);
227  else
228  fdwroutine->BeginForeignScan(scanstate, eflags);
229 
230  return scanstate;
231 }
BeginForeignScan_function BeginForeignScan
Definition: fdwapi.h:177
#define NIL
Definition: pg_list.h:69
ScanState ss
Definition: execnodes.h:1522
List * qual
Definition: plannodes.h:145
Plan plan
Definition: plannodes.h:328
void ExecInitScanTupleSlot(EState *estate, ScanState *scanstate)
Definition: execTuples.c:842
Index scanrelid
Definition: plannodes.h:329
Oid fs_server
Definition: plannodes.h:599
#define RelationGetDescr(relation)
Definition: rel.h:428
FdwRoutine * GetFdwRoutineByServerId(Oid serverid)
Definition: foreign.c:330
List * fdw_scan_tlist
Definition: plannodes.h:602
Relation ss_currentRelation
Definition: execnodes.h:1080
EState * state
Definition: execnodes.h:834
ExprState * fdw_recheck_quals
Definition: execnodes.h:1523
CmdType operation
Definition: plannodes.h:598
ExprState * ExecInitQual(List *qual, PlanState *parent)
Definition: execExpr.c:160
void ExecAssignResultTypeFromTL(PlanState *planstate)
Definition: execUtils.c:440
void ExecAssignScanProjectionInfoWithVarno(ScanState *node, Index varno)
Definition: execScan.c:247
PlanState ps
Definition: execnodes.h:1079
void ExecInitResultTupleSlot(EState *estate, PlanState *planstate)
Definition: execTuples.c:832
Relation ExecOpenScanRelation(EState *estate, Index scanrelid, int eflags)
Definition: execUtils.c:603
#define EXEC_FLAG_BACKWARD
Definition: executor.h:60
#define outerPlanState(node)
Definition: execnodes.h:874
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1526
List * fdw_recheck_quals
Definition: plannodes.h:603
TupleDesc ExecTypeFromTL(List *targetList, bool hasoid)
Definition: execTuples.c:888
#define outerPlan(node)
Definition: plannodes.h:174
BeginDirectModify_function BeginDirectModify
Definition: fdwapi.h:203
unsigned int Index
Definition: c.h:365
Plan * plan
Definition: execnodes.h:832
#define makeNode(_type_)
Definition: nodes.h:557
#define NULL
Definition: c.h:229
#define Assert(condition)
Definition: c.h:675
#define EXEC_FLAG_MARK
Definition: executor.h:61
void ExecAssignExprContext(EState *estate, PlanState *planstate)
Definition: execUtils.c:418
ExprState * qual
Definition: execnodes.h:846
FdwRoutine * GetFdwRoutineForRelation(Relation relation, bool makecopy)
Definition: foreign.c:395
void ExecAssignScanType(ScanState *scanstate, TupleDesc tupDesc)
Definition: execUtils.c:540
#define INDEX_VAR
Definition: primnodes.h:155
PlanState * ExecInitNode(Plan *node, EState *estate, int eflags)
Definition: execProcnode.c:140
void ExecReScanForeignScan ( ForeignScanState node)

Definition at line 273 of file nodeForeignscan.c.

References PlanState::chgParam, ExecReScan(), ExecScanReScan(), ForeignScanState::fdwroutine, NULL, outerPlan, outerPlanState, FdwRoutine::ReScanForeignScan, and ForeignScanState::ss.

Referenced by ExecReScan().

274 {
276 
277  node->fdwroutine->ReScanForeignScan(node);
278 
279  /*
280  * If chgParam of subnode is not null then plan will be re-scanned by
281  * first ExecProcNode. outerPlan may also be NULL, in which case there is
282  * nothing to rescan at all.
283  */
284  if (outerPlan != NULL && outerPlan->chgParam == NULL)
285  ExecReScan(outerPlan);
286 
287  ExecScanReScan(&node->ss);
288 }
ScanState ss
Definition: execnodes.h:1522
void ExecReScan(PlanState *node)
Definition: execAmi.c:75
#define outerPlanState(node)
Definition: execnodes.h:874
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1526
Bitmapset * chgParam
Definition: execnodes.h:856
#define outerPlan(node)
Definition: plannodes.h:174
#define NULL
Definition: c.h:229
ReScanForeignScan_function ReScanForeignScan
Definition: fdwapi.h:179
void ExecScanReScan(ScanState *node)
Definition: execScan.c:327
void ExecShutdownForeignScan ( ForeignScanState node)

Definition at line 360 of file nodeForeignscan.c.

References ForeignScanState::fdwroutine, and FdwRoutine::ShutdownForeignScan.

Referenced by ExecShutdownNode().

361 {
362  FdwRoutine *fdwroutine = node->fdwroutine;
363 
364  if (fdwroutine->ShutdownForeignScan)
365  fdwroutine->ShutdownForeignScan(node);
366 }
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1526
ShutdownForeignScan_function ShutdownForeignScan
Definition: fdwapi.h:228