PostgreSQL Source Code  git master
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)
 
void ExecEndForeignScan (ForeignScanState *node)
 
void ExecReScanForeignScan (ForeignScanState *node)
 
void ExecForeignScanEstimate (ForeignScanState *node, ParallelContext *pcxt)
 
void ExecForeignScanInitializeDSM (ForeignScanState *node, ParallelContext *pcxt)
 
void ExecForeignScanReInitializeDSM (ForeignScanState *node, ParallelContext *pcxt)
 
void ExecForeignScanInitializeWorker (ForeignScanState *node, ParallelWorkerContext *pwcxt)
 
void ExecShutdownForeignScan (ForeignScanState *node)
 

Function Documentation

◆ ExecEndForeignScan()

void ExecEndForeignScan ( ForeignScanState node)

Definition at line 248 of file nodeForeignscan.c.

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

Referenced by ExecEndNode().

249 {
250  ForeignScan *plan = (ForeignScan *) node->ss.ps.plan;
251 
252  /* Let the FDW shut down */
253  if (plan->operation != CMD_SELECT)
254  node->fdwroutine->EndDirectModify(node);
255  else
256  node->fdwroutine->EndForeignScan(node);
257 
258  /* Shut down any outer plan. */
259  if (outerPlanState(node))
261 
262  /* Free the exprcontext */
263  ExecFreeExprContext(&node->ss.ps);
264 
265  /* clean out the tuple table */
266  if (node->ss.ps.ps_ResultTupleSlot)
269 }
EndDirectModify_function EndDirectModify
Definition: fdwapi.h:221
ScanState ss
Definition: execnodes.h:1790
static TupleTableSlot * ExecClearTuple(TupleTableSlot *slot)
Definition: tuptable.h:425
void ExecEndNode(PlanState *node)
Definition: execProcnode.c:543
TupleTableSlot * ss_ScanTupleSlot
Definition: execnodes.h:1331
void ExecFreeExprContext(PlanState *planstate)
Definition: execUtils.c:649
CmdType operation
Definition: plannodes.h:614
PlanState ps
Definition: execnodes.h:1328
TupleTableSlot * ps_ResultTupleSlot
Definition: execnodes.h:977
#define outerPlanState(node)
Definition: execnodes.h:1033
EndForeignScan_function EndForeignScan
Definition: fdwapi.h:194
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1795
Plan * plan
Definition: execnodes.h:939

◆ ExecForeignScanEstimate()

void ExecForeignScanEstimate ( ForeignScanState node,
ParallelContext pcxt 
)

Definition at line 302 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().

303 {
304  FdwRoutine *fdwroutine = node->fdwroutine;
305 
306  if (fdwroutine->EstimateDSMForeignScan)
307  {
308  node->pscan_len = fdwroutine->EstimateDSMForeignScan(node, pcxt);
310  shm_toc_estimate_keys(&pcxt->estimator, 1);
311  }
312 }
EstimateDSMForeignScan_function EstimateDSMForeignScan
Definition: fdwapi.h:241
shm_toc_estimator estimator
Definition: parallel.h:42
#define shm_toc_estimate_chunk(e, sz)
Definition: shm_toc.h:51
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1795
#define shm_toc_estimate_keys(e, cnt)
Definition: shm_toc.h:53

◆ ExecForeignScanInitializeDSM()

void ExecForeignScanInitializeDSM ( ForeignScanState node,
ParallelContext pcxt 
)

Definition at line 321 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().

322 {
323  FdwRoutine *fdwroutine = node->fdwroutine;
324 
325  if (fdwroutine->InitializeDSMForeignScan)
326  {
327  int plan_node_id = node->ss.ps.plan->plan_node_id;
328  void *coordinate;
329 
330  coordinate = shm_toc_allocate(pcxt->toc, node->pscan_len);
331  fdwroutine->InitializeDSMForeignScan(node, pcxt, coordinate);
332  shm_toc_insert(pcxt->toc, plan_node_id, coordinate);
333  }
334 }
ScanState ss
Definition: execnodes.h:1790
int plan_node_id
Definition: plannodes.h:135
PlanState ps
Definition: execnodes.h:1328
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1795
InitializeDSMForeignScan_function InitializeDSMForeignScan
Definition: fdwapi.h:242
Plan * plan
Definition: execnodes.h:939
void * shm_toc_allocate(shm_toc *toc, Size nbytes)
Definition: shm_toc.c:88
void shm_toc_insert(shm_toc *toc, uint64 key, void *address)
Definition: shm_toc.c:171
shm_toc * toc
Definition: parallel.h:45

◆ ExecForeignScanInitializeWorker()

void ExecForeignScanInitializeWorker ( ForeignScanState node,
ParallelWorkerContext pwcxt 
)

Definition at line 364 of file nodeForeignscan.c.

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

Referenced by ExecParallelInitializeWorker().

366 {
367  FdwRoutine *fdwroutine = node->fdwroutine;
368 
369  if (fdwroutine->InitializeWorkerForeignScan)
370  {
371  int plan_node_id = node->ss.ps.plan->plan_node_id;
372  void *coordinate;
373 
374  coordinate = shm_toc_lookup(pwcxt->toc, plan_node_id, false);
375  fdwroutine->InitializeWorkerForeignScan(node, pwcxt->toc, coordinate);
376  }
377 }
ScanState ss
Definition: execnodes.h:1790
InitializeWorkerForeignScan_function InitializeWorkerForeignScan
Definition: fdwapi.h:244
int plan_node_id
Definition: plannodes.h:135
PlanState ps
Definition: execnodes.h:1328
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1795
Plan * plan
Definition: execnodes.h:939
void * shm_toc_lookup(shm_toc *toc, uint64 key, bool noError)
Definition: shm_toc.c:232

◆ ExecForeignScanReInitializeDSM()

void ExecForeignScanReInitializeDSM ( ForeignScanState node,
ParallelContext pcxt 
)

Definition at line 343 of file nodeForeignscan.c.

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

Referenced by ExecParallelReInitializeDSM().

344 {
345  FdwRoutine *fdwroutine = node->fdwroutine;
346 
347  if (fdwroutine->ReInitializeDSMForeignScan)
348  {
349  int plan_node_id = node->ss.ps.plan->plan_node_id;
350  void *coordinate;
351 
352  coordinate = shm_toc_lookup(pcxt->toc, plan_node_id, false);
353  fdwroutine->ReInitializeDSMForeignScan(node, pcxt, coordinate);
354  }
355 }
ScanState ss
Definition: execnodes.h:1790
int plan_node_id
Definition: plannodes.h:135
PlanState ps
Definition: execnodes.h:1328
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1795
Plan * plan
Definition: execnodes.h:939
ReInitializeDSMForeignScan_function ReInitializeDSMForeignScan
Definition: fdwapi.h:243
void * shm_toc_lookup(shm_toc *toc, uint64 key, bool noError)
Definition: shm_toc.c:232
shm_toc * toc
Definition: parallel.h:45

◆ ExecInitForeignScan()

ForeignScanState* ExecInitForeignScan ( ForeignScan node,
EState estate,
int  eflags 
)

Definition at line 126 of file nodeForeignscan.c.

References Assert, FdwRoutine::BeginDirectModify, FdwRoutine::BeginForeignScan, CMD_SELECT, CreateTupleDescCopy(), EState::es_result_relations, EXEC_FLAG_BACKWARD, EXEC_FLAG_MARK, ExecAssignExprContext(), ExecAssignScanProjectionInfoWithVarno(), ExecForeignScan(), ExecInitNode(), ExecInitQual(), ExecInitResultTypeTL(), ExecInitScanTupleSlot(), ExecOpenScanRelation(), PlanState::ExecProcNode, ExecTypeFromTL(), ForeignScan::fdw_recheck_quals, ForeignScan::fdw_scan_tlist, ForeignScan::fs_server, GetFdwRoutineByServerId(), GetFdwRoutineForRelation(), INDEX_VAR, makeNode, NIL, ForeignScan::operation, outerPlan, outerPlanState, Scan::plan, PlanState::plan, ScanState::ps, Plan::qual, PlanState::qual, RelationGetDescr, ForeignScan::resultRelation, ForeignScan::scan, PlanState::scanopsfixed, PlanState::scanopsset, Scan::scanrelid, ForeignScanState::ss, ScanState::ss_currentRelation, PlanState::state, and TTSOpsHeapTuple.

Referenced by ExecInitNode().

127 {
128  ForeignScanState *scanstate;
129  Relation currentRelation = NULL;
130  Index scanrelid = node->scan.scanrelid;
131  Index tlistvarno;
132  FdwRoutine *fdwroutine;
133 
134  /* check for unsupported flags */
135  Assert(!(eflags & (EXEC_FLAG_BACKWARD | EXEC_FLAG_MARK)));
136 
137  /*
138  * create state structure
139  */
140  scanstate = makeNode(ForeignScanState);
141  scanstate->ss.ps.plan = (Plan *) node;
142  scanstate->ss.ps.state = estate;
143  scanstate->ss.ps.ExecProcNode = ExecForeignScan;
144 
145  /*
146  * Miscellaneous initialization
147  *
148  * create expression context for node
149  */
150  ExecAssignExprContext(estate, &scanstate->ss.ps);
151 
152  /*
153  * open the scan relation, if any; also acquire function pointers from the
154  * FDW's handler
155  */
156  if (scanrelid > 0)
157  {
158  currentRelation = ExecOpenScanRelation(estate, scanrelid, eflags);
159  scanstate->ss.ss_currentRelation = currentRelation;
160  fdwroutine = GetFdwRoutineForRelation(currentRelation, true);
161  }
162  else
163  {
164  /* We can't use the relcache, so get fdwroutine the hard way */
165  fdwroutine = GetFdwRoutineByServerId(node->fs_server);
166  }
167 
168  /*
169  * Determine the scan tuple type. If the FDW provided a targetlist
170  * describing the scan tuples, use that; else use base relation's rowtype.
171  */
172  if (node->fdw_scan_tlist != NIL || currentRelation == NULL)
173  {
174  TupleDesc scan_tupdesc;
175 
176  scan_tupdesc = ExecTypeFromTL(node->fdw_scan_tlist);
177  ExecInitScanTupleSlot(estate, &scanstate->ss, scan_tupdesc,
178  &TTSOpsHeapTuple);
179  /* Node's targetlist will contain Vars with varno = INDEX_VAR */
180  tlistvarno = INDEX_VAR;
181  }
182  else
183  {
184  TupleDesc scan_tupdesc;
185 
186  /* don't trust FDWs to return tuples fulfilling NOT NULL constraints */
187  scan_tupdesc = CreateTupleDescCopy(RelationGetDescr(currentRelation));
188  ExecInitScanTupleSlot(estate, &scanstate->ss, scan_tupdesc,
189  &TTSOpsHeapTuple);
190  /* Node's targetlist will contain Vars with varno = scanrelid */
191  tlistvarno = scanrelid;
192  }
193 
194  /* Don't know what an FDW might return */
195  scanstate->ss.ps.scanopsfixed = false;
196  scanstate->ss.ps.scanopsset = true;
197 
198  /*
199  * Initialize result slot, type and projection.
200  */
201  ExecInitResultTypeTL(&scanstate->ss.ps);
202  ExecAssignScanProjectionInfoWithVarno(&scanstate->ss, tlistvarno);
203 
204  /*
205  * initialize child expressions
206  */
207  scanstate->ss.ps.qual =
208  ExecInitQual(node->scan.plan.qual, (PlanState *) scanstate);
209  scanstate->fdw_recheck_quals =
210  ExecInitQual(node->fdw_recheck_quals, (PlanState *) scanstate);
211 
212  /*
213  * Initialize FDW-related state.
214  */
215  scanstate->fdwroutine = fdwroutine;
216  scanstate->fdw_state = NULL;
217 
218  /*
219  * For the FDW's convenience, look up the modification target relation's.
220  * ResultRelInfo.
221  */
222  if (node->resultRelation > 0)
223  scanstate->resultRelInfo = estate->es_result_relations[node->resultRelation - 1];
224 
225  /* Initialize any outer plan. */
226  if (outerPlan(node))
227  outerPlanState(scanstate) =
228  ExecInitNode(outerPlan(node), estate, eflags);
229 
230  /*
231  * Tell the FDW to initialize the scan.
232  */
233  if (node->operation != CMD_SELECT)
234  fdwroutine->BeginDirectModify(scanstate, eflags);
235  else
236  fdwroutine->BeginForeignScan(scanstate, eflags);
237 
238  return scanstate;
239 }
BeginForeignScan_function BeginForeignScan
Definition: fdwapi.h:191
#define NIL
Definition: pg_list.h:65
ScanState ss
Definition: execnodes.h:1790
List * qual
Definition: plannodes.h:137
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:110
Plan plan
Definition: plannodes.h:336
Index scanrelid
Definition: plannodes.h:337
Oid fs_server
Definition: plannodes.h:616
#define RelationGetDescr(relation)
Definition: rel.h:482
FdwRoutine * GetFdwRoutineByServerId(Oid serverid)
Definition: foreign.c:362
static TupleTableSlot * ExecForeignScan(PlanState *pstate)
List * fdw_scan_tlist
Definition: plannodes.h:619
Relation ss_currentRelation
Definition: execnodes.h:1329
EState * state
Definition: execnodes.h:941
ExprState * fdw_recheck_quals
Definition: execnodes.h:1791
CmdType operation
Definition: plannodes.h:614
ExprState * ExecInitQual(List *qual, PlanState *parent)
Definition: execExpr.c:209
void ExecAssignScanProjectionInfoWithVarno(ScanState *node, Index varno)
Definition: execScan.c:285
PlanState ps
Definition: execnodes.h:1328
ResultRelInfo * resultRelInfo
Definition: execnodes.h:1793
Relation ExecOpenScanRelation(EState *estate, Index scanrelid, int eflags)
Definition: execUtils.c:719
#define EXEC_FLAG_BACKWARD
Definition: executor.h:58
#define outerPlanState(node)
Definition: execnodes.h:1033
void ExecInitScanTupleSlot(EState *estate, ScanState *scanstate, TupleDesc tupledesc, const TupleTableSlotOps *tts_ops)
Definition: execTuples.c:1781
void ExecInitResultTypeTL(PlanState *planstate)
Definition: execTuples.c:1725
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1795
List * fdw_recheck_quals
Definition: plannodes.h:620
ResultRelInfo ** es_result_relations
Definition: execnodes.h:534
#define outerPlan(node)
Definition: plannodes.h:166
Index resultRelation
Definition: plannodes.h:615
BeginDirectModify_function BeginDirectModify
Definition: fdwapi.h:219
ExecProcNodeMtd ExecProcNode
Definition: execnodes.h:945
unsigned int Index
Definition: c.h:483
Plan * plan
Definition: execnodes.h:939
bool scanopsfixed
Definition: execnodes.h:1015
#define makeNode(_type_)
Definition: nodes.h:576
#define Assert(condition)
Definition: c.h:746
#define EXEC_FLAG_MARK
Definition: executor.h:59
void ExecAssignExprContext(EState *estate, PlanState *planstate)
Definition: execUtils.c:479
TupleDesc ExecTypeFromTL(List *targetList)
Definition: execTuples.c:1908
bool scanopsset
Definition: execnodes.h:1019
ExprState * qual
Definition: execnodes.h:960
FdwRoutine * GetFdwRoutineForRelation(Relation relation, bool makecopy)
Definition: foreign.c:427
const TupleTableSlotOps TTSOpsHeapTuple
Definition: execTuples.c:84
#define INDEX_VAR
Definition: primnodes.h:173
PlanState * ExecInitNode(Plan *node, EState *estate, int eflags)
Definition: execProcnode.c:139

◆ ExecReScanForeignScan()

void ExecReScanForeignScan ( ForeignScanState node)

Definition at line 278 of file nodeForeignscan.c.

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

Referenced by ExecReScan().

279 {
281 
282  node->fdwroutine->ReScanForeignScan(node);
283 
284  /*
285  * If chgParam of subnode is not null then plan will be re-scanned by
286  * first ExecProcNode. outerPlan may also be NULL, in which case there is
287  * nothing to rescan at all.
288  */
289  if (outerPlan != NULL && outerPlan->chgParam == NULL)
290  ExecReScan(outerPlan);
291 
292  ExecScanReScan(&node->ss);
293 }
ScanState ss
Definition: execnodes.h:1790
void ExecReScan(PlanState *node)
Definition: execAmi.c:76
#define outerPlanState(node)
Definition: execnodes.h:1033
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1795
Bitmapset * chgParam
Definition: execnodes.h:971
#define outerPlan(node)
Definition: plannodes.h:166
ReScanForeignScan_function ReScanForeignScan
Definition: fdwapi.h:193
void ExecScanReScan(ScanState *node)
Definition: execScan.c:299

◆ ExecShutdownForeignScan()

void ExecShutdownForeignScan ( ForeignScanState node)

Definition at line 387 of file nodeForeignscan.c.

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

Referenced by ExecShutdownNode().

388 {
389  FdwRoutine *fdwroutine = node->fdwroutine;
390 
391  if (fdwroutine->ShutdownForeignScan)
392  fdwroutine->ShutdownForeignScan(node);
393 }
struct FdwRoutine * fdwroutine
Definition: execnodes.h:1795
ShutdownForeignScan_function ShutdownForeignScan
Definition: fdwapi.h:245