PostgreSQL Source Code  git master
nodeFunctionscan.h File Reference
#include "nodes/execnodes.h"
Include dependency graph for nodeFunctionscan.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

FunctionScanStateExecInitFunctionScan (FunctionScan *node, EState *estate, int eflags)
 
void ExecEndFunctionScan (FunctionScanState *node)
 
void ExecReScanFunctionScan (FunctionScanState *node)
 

Function Documentation

◆ ExecEndFunctionScan()

void ExecEndFunctionScan ( FunctionScanState node)

Definition at line 520 of file nodeFunctionscan.c.

References ExecClearTuple(), ExecFreeExprContext(), FunctionScanPerFuncState::func_slot, FunctionScanState::funcstates, i, FunctionScanState::nfuncs, ScanState::ps, PlanState::ps_ResultTupleSlot, FunctionScanState::ss, ScanState::ss_ScanTupleSlot, FunctionScanPerFuncState::tstore, and tuplestore_end().

Referenced by ExecEndNode().

521 {
522  int i;
523 
524  /*
525  * Free the exprcontext
526  */
527  ExecFreeExprContext(&node->ss.ps);
528 
529  /*
530  * clean out the tuple table
531  */
534 
535  /*
536  * Release slots and tuplestore resources
537  */
538  for (i = 0; i < node->nfuncs; i++)
539  {
540  FunctionScanPerFuncState *fs = &node->funcstates[i];
541 
542  if (fs->func_slot)
544 
545  if (fs->tstore != NULL)
546  {
547  tuplestore_end(node->funcstates[i].tstore);
548  fs->tstore = NULL;
549  }
550  }
551 }
TupleTableSlot * ExecClearTuple(TupleTableSlot *slot)
Definition: execTuples.c:475
TupleTableSlot * ss_ScanTupleSlot
Definition: execnodes.h:1195
void ExecFreeExprContext(PlanState *planstate)
Definition: execUtils.c:566
PlanState ps
Definition: execnodes.h:1192
TupleTableSlot * ps_ResultTupleSlot
Definition: execnodes.h:946
Tuplestorestate * tstore
struct FunctionScanPerFuncState * funcstates
Definition: execnodes.h:1523
TupleTableSlot * func_slot
void tuplestore_end(Tuplestorestate *state)
Definition: tuplestore.c:453
int i

◆ ExecInitFunctionScan()

FunctionScanState* ExecInitFunctionScan ( FunctionScan node,
EState estate,
int  eflags 
)

Definition at line 280 of file nodeFunctionscan.c.

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, BlessTupleDesc(), BuildDescFromLists(), FunctionScanPerFuncState::colcount, CreateTemplateTupleDesc(), CreateTupleDescCopy(), CurrentMemoryContext, FunctionScanState::eflags, elog, ERROR, EXEC_FLAG_MARK, ExecAssignExprContext(), ExecAssignScanProjectionInfo(), ExecFunctionScan(), ExecInitExtraTupleSlot(), ExecInitQual(), ExecInitResultTupleSlotTL(), ExecInitScanTupleSlot(), ExecInitTableFunctionResult(), PlanState::ExecProcNode, exprCollation(), FunctionScanPerFuncState::func_slot, RangeTblFunction::funccolcollations, RangeTblFunction::funccolcount, RangeTblFunction::funccolnames, RangeTblFunction::funccoltypes, RangeTblFunction::funccoltypmods, RangeTblFunction::funcexpr, FunctionScan::funcordinality, FunctionScanState::funcstates, FunctionScan::functions, get_expr_result_type(), i, innerPlan, lfirst, list_length(), makeNode, tupleDesc::natts, FunctionScanState::nfuncs, FunctionScanState::ordinal, FunctionScanState::ordinality, outerPlan, palloc(), Scan::plan, PlanState::plan, ScanState::ps, PlanState::ps_ExprContext, Plan::qual, PlanState::qual, FunctionScanPerFuncState::rowcount, FunctionScan::scan, FunctionScanPerFuncState::setexpr, FunctionScanState::simple, FunctionScanState::ss, PlanState::state, tupleDesc::tdtypeid, tupleDesc::tdtypmod, FunctionScanPerFuncState::tstore, FunctionScanPerFuncState::tupdesc, TupleDescCopyEntry(), TupleDescInitEntry(), TupleDescInitEntryCollation(), TYPEFUNC_COMPOSITE, TYPEFUNC_COMPOSITE_DOMAIN, TYPEFUNC_RECORD, and TYPEFUNC_SCALAR.

Referenced by ExecInitNode().

281 {
282  FunctionScanState *scanstate;
283  int nfuncs = list_length(node->functions);
284  TupleDesc scan_tupdesc;
285  int i,
286  natts;
287  ListCell *lc;
288 
289  /* check for unsupported flags */
290  Assert(!(eflags & EXEC_FLAG_MARK));
291 
292  /*
293  * FunctionScan should not have any children.
294  */
295  Assert(outerPlan(node) == NULL);
296  Assert(innerPlan(node) == NULL);
297 
298  /*
299  * create new ScanState for node
300  */
301  scanstate = makeNode(FunctionScanState);
302  scanstate->ss.ps.plan = (Plan *) node;
303  scanstate->ss.ps.state = estate;
304  scanstate->ss.ps.ExecProcNode = ExecFunctionScan;
305  scanstate->eflags = eflags;
306 
307  /*
308  * are we adding an ordinality column?
309  */
310  scanstate->ordinality = node->funcordinality;
311 
312  scanstate->nfuncs = nfuncs;
313  if (nfuncs == 1 && !node->funcordinality)
314  scanstate->simple = true;
315  else
316  scanstate->simple = false;
317 
318  /*
319  * Ordinal 0 represents the "before the first row" position.
320  *
321  * We need to track ordinal position even when not adding an ordinality
322  * column to the result, in order to handle backwards scanning properly
323  * with multiple functions with different result sizes. (We can't position
324  * any individual function's tuplestore any more than 1 place beyond its
325  * end, so when scanning backwards, we need to know when to start
326  * including the function in the scan again.)
327  */
328  scanstate->ordinal = 0;
329 
330  /*
331  * Miscellaneous initialization
332  *
333  * create expression context for node
334  */
335  ExecAssignExprContext(estate, &scanstate->ss.ps);
336 
337  scanstate->funcstates = palloc(nfuncs * sizeof(FunctionScanPerFuncState));
338 
339  natts = 0;
340  i = 0;
341  foreach(lc, node->functions)
342  {
343  RangeTblFunction *rtfunc = (RangeTblFunction *) lfirst(lc);
344  Node *funcexpr = rtfunc->funcexpr;
345  int colcount = rtfunc->funccolcount;
346  FunctionScanPerFuncState *fs = &scanstate->funcstates[i];
347  TypeFuncClass functypclass;
348  Oid funcrettype;
349  TupleDesc tupdesc;
350 
351  fs->setexpr =
352  ExecInitTableFunctionResult((Expr *) funcexpr,
353  scanstate->ss.ps.ps_ExprContext,
354  &scanstate->ss.ps);
355 
356  /*
357  * Don't allocate the tuplestores; the actual calls to the functions
358  * do that. NULL means that we have not called the function yet (or
359  * need to call it again after a rescan).
360  */
361  fs->tstore = NULL;
362  fs->rowcount = -1;
363 
364  /*
365  * Now determine if the function returns a simple or composite type,
366  * and build an appropriate tupdesc. Note that in the composite case,
367  * the function may now return more columns than it did when the plan
368  * was made; we have to ignore any columns beyond "colcount".
369  */
370  functypclass = get_expr_result_type(funcexpr,
371  &funcrettype,
372  &tupdesc);
373 
374  if (functypclass == TYPEFUNC_COMPOSITE ||
375  functypclass == TYPEFUNC_COMPOSITE_DOMAIN)
376  {
377  /* Composite data type, e.g. a table's row type */
378  Assert(tupdesc);
379  Assert(tupdesc->natts >= colcount);
380  /* Must copy it out of typcache for safety */
381  tupdesc = CreateTupleDescCopy(tupdesc);
382  }
383  else if (functypclass == TYPEFUNC_SCALAR)
384  {
385  /* Base data type, i.e. scalar */
386  tupdesc = CreateTemplateTupleDesc(1, false);
387  TupleDescInitEntry(tupdesc,
388  (AttrNumber) 1,
389  NULL, /* don't care about the name here */
390  funcrettype,
391  -1,
392  0);
394  (AttrNumber) 1,
395  exprCollation(funcexpr));
396  }
397  else if (functypclass == TYPEFUNC_RECORD)
398  {
399  tupdesc = BuildDescFromLists(rtfunc->funccolnames,
400  rtfunc->funccoltypes,
401  rtfunc->funccoltypmods,
402  rtfunc->funccolcollations);
403 
404  /*
405  * For RECORD results, make sure a typmod has been assigned. (The
406  * function should do this for itself, but let's cover things in
407  * case it doesn't.)
408  */
409  BlessTupleDesc(tupdesc);
410  }
411  else
412  {
413  /* crummy error message, but parser should have caught this */
414  elog(ERROR, "function in FROM has unsupported return type");
415  }
416 
417  fs->tupdesc = tupdesc;
418  fs->colcount = colcount;
419 
420  /*
421  * We only need separate slots for the function results if we are
422  * doing ordinality or multiple functions; otherwise, we'll fetch
423  * function results directly into the scan slot.
424  */
425  if (!scanstate->simple)
426  {
427  fs->func_slot = ExecInitExtraTupleSlot(estate, fs->tupdesc);
428  }
429  else
430  fs->func_slot = NULL;
431 
432  natts += colcount;
433  i++;
434  }
435 
436  /*
437  * Create the combined TupleDesc
438  *
439  * If there is just one function without ordinality, the scan result
440  * tupdesc is the same as the function result tupdesc --- except that we
441  * may stuff new names into it below, so drop any rowtype label.
442  */
443  if (scanstate->simple)
444  {
445  scan_tupdesc = CreateTupleDescCopy(scanstate->funcstates[0].tupdesc);
446  scan_tupdesc->tdtypeid = RECORDOID;
447  scan_tupdesc->tdtypmod = -1;
448  }
449  else
450  {
451  AttrNumber attno = 0;
452 
453  if (node->funcordinality)
454  natts++;
455 
456  scan_tupdesc = CreateTemplateTupleDesc(natts, false);
457 
458  for (i = 0; i < nfuncs; i++)
459  {
460  TupleDesc tupdesc = scanstate->funcstates[i].tupdesc;
461  int colcount = scanstate->funcstates[i].colcount;
462  int j;
463 
464  for (j = 1; j <= colcount; j++)
465  TupleDescCopyEntry(scan_tupdesc, ++attno, tupdesc, j);
466  }
467 
468  /* If doing ordinality, add a column of type "bigint" at the end */
469  if (node->funcordinality)
470  {
471  TupleDescInitEntry(scan_tupdesc,
472  ++attno,
473  NULL, /* don't care about the name here */
474  INT8OID,
475  -1,
476  0);
477  }
478 
479  Assert(attno == natts);
480  }
481 
482  /*
483  * Initialize scan slot and type.
484  */
485  ExecInitScanTupleSlot(estate, &scanstate->ss, scan_tupdesc);
486 
487  /*
488  * Initialize result slot, type and projection.
489  */
490  ExecInitResultTupleSlotTL(estate, &scanstate->ss.ps);
491  ExecAssignScanProjectionInfo(&scanstate->ss);
492 
493  /*
494  * initialize child expressions
495  */
496  scanstate->ss.ps.qual =
497  ExecInitQual(node->scan.plan.qual, (PlanState *) scanstate);
498 
499  /*
500  * Create a memory context that ExecMakeTableFunctionResult can use to
501  * evaluate function arguments in. We can't use the per-tuple context for
502  * this because it gets reset too often; but we don't want to leak
503  * evaluation results into the query-lifespan context either. We just
504  * need one context, because we evaluate each function separately.
505  */
507  "Table function arguments",
509 
510  return scanstate;
511 }
List * qual
Definition: plannodes.h:147
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:112
Plan plan
Definition: plannodes.h:342
static TupleTableSlot * ExecFunctionScan(PlanState *pstate)
Oid tdtypeid
Definition: tupdesc.h:83
TupleDesc BuildDescFromLists(List *names, List *types, List *typmods, List *collations)
Definition: tupdesc.c:885
List * functions
Definition: plannodes.h:522
ExprContext * ps_ExprContext
Definition: execnodes.h:947
Definition: nodes.h:517
MemoryContext argcontext
Definition: execnodes.h:1524
EState * state
Definition: execnodes.h:914
unsigned int Oid
Definition: postgres_ext.h:31
TypeFuncClass get_expr_result_type(Node *expr, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:227
int natts
Definition: tupdesc.h:82
TupleTableSlot * ExecInitExtraTupleSlot(EState *estate, TupleDesc tupledesc)
Definition: execTuples.c:931
ExprState * ExecInitQual(List *qual, PlanState *parent)
Definition: execExpr.c:205
int32 tdtypmod
Definition: tupdesc.h:84
SetExprState * ExecInitTableFunctionResult(Expr *expr, ExprContext *econtext, PlanState *parent)
Definition: execSRF.c:56
PlanState ps
Definition: execnodes.h:1192
#define ERROR
Definition: elog.h:43
void ExecAssignScanProjectionInfo(ScanState *node)
Definition: execScan.c:235
void TupleDescCopyEntry(TupleDesc dst, AttrNumber dstAttno, TupleDesc src, AttrNumber srcAttno)
Definition: tupdesc.c:270
void TupleDescInitEntryCollation(TupleDesc desc, AttrNumber attributeNumber, Oid collationid)
Definition: tupdesc.c:761
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
#define innerPlan(node)
Definition: plannodes.h:175
TupleDesc BlessTupleDesc(TupleDesc tupdesc)
Definition: execTuples.c:1109
Tuplestorestate * tstore
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
TypeFuncClass
Definition: funcapi.h:155
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition: tupdesc.c:600
#define outerPlan(node)
Definition: plannodes.h:176
#define AllocSetContextCreate(parent, name, allocparams)
Definition: memutils.h:170
struct FunctionScanPerFuncState * funcstates
Definition: execnodes.h:1523
ExecProcNodeMtd ExecProcNode
Definition: execnodes.h:918
void ExecInitResultTupleSlotTL(EState *estate, PlanState *planstate)
Definition: execTuples.c:890
TupleTableSlot * func_slot
Plan * plan
Definition: execnodes.h:912
List * funccoltypmods
Definition: parsenodes.h:1103
List * funccolcollations
Definition: parsenodes.h:1104
#define makeNode(_type_)
Definition: nodes.h:565
bool funcordinality
Definition: plannodes.h:523
#define Assert(condition)
Definition: c.h:699
#define lfirst(lc)
Definition: pg_list.h:106
#define EXEC_FLAG_MARK
Definition: executor.h:61
void ExecAssignExprContext(EState *estate, PlanState *planstate)
Definition: execUtils.c:428
static int list_length(const List *l)
Definition: pg_list.h:89
Oid exprCollation(const Node *expr)
Definition: nodeFuncs.c:720
TupleDesc CreateTemplateTupleDesc(int natts, bool hasoid)
Definition: tupdesc.c:45
ExprState * qual
Definition: execnodes.h:930
void * palloc(Size size)
Definition: mcxt.c:924
int i
void ExecInitScanTupleSlot(EState *estate, ScanState *scanstate, TupleDesc tupledesc)
Definition: execTuples.c:915
#define elog
Definition: elog.h:219
int16 AttrNumber
Definition: attnum.h:21

◆ ExecReScanFunctionScan()

void ExecReScanFunctionScan ( FunctionScanState node)

Definition at line 560 of file nodeFunctionscan.c.

References bms_overlap(), PlanState::chgParam, ExecClearTuple(), ExecScanReScan(), FunctionScanPerFuncState::func_slot, RangeTblFunction::funcparams, FunctionScanState::funcstates, FunctionScan::functions, i, lfirst, FunctionScanState::nfuncs, FunctionScanState::ordinal, PlanState::plan, ScanState::ps, PlanState::ps_ResultTupleSlot, FunctionScanPerFuncState::rowcount, FunctionScanState::ss, FunctionScanPerFuncState::tstore, tuplestore_end(), and tuplestore_rescan().

Referenced by ExecReScan().

561 {
562  FunctionScan *scan = (FunctionScan *) node->ss.ps.plan;
563  int i;
564  Bitmapset *chgparam = node->ss.ps.chgParam;
565 
567  for (i = 0; i < node->nfuncs; i++)
568  {
569  FunctionScanPerFuncState *fs = &node->funcstates[i];
570 
571  if (fs->func_slot)
573  }
574 
575  ExecScanReScan(&node->ss);
576 
577  /*
578  * Here we have a choice whether to drop the tuplestores (and recompute
579  * the function outputs) or just rescan them. We must recompute if an
580  * expression contains changed parameters, else we rescan.
581  *
582  * XXX maybe we should recompute if the function is volatile? But in
583  * general the executor doesn't conditionalize its actions on that.
584  */
585  if (chgparam)
586  {
587  ListCell *lc;
588 
589  i = 0;
590  foreach(lc, scan->functions)
591  {
592  RangeTblFunction *rtfunc = (RangeTblFunction *) lfirst(lc);
593 
594  if (bms_overlap(chgparam, rtfunc->funcparams))
595  {
596  if (node->funcstates[i].tstore != NULL)
597  {
599  node->funcstates[i].tstore = NULL;
600  }
601  node->funcstates[i].rowcount = -1;
602  }
603  i++;
604  }
605  }
606 
607  /* Reset ordinality counter */
608  node->ordinal = 0;
609 
610  /* Make sure we rewind any remaining tuplestores */
611  for (i = 0; i < node->nfuncs; i++)
612  {
613  if (node->funcstates[i].tstore != NULL)
615  }
616 }
void tuplestore_rescan(Tuplestorestate *state)
Definition: tuplestore.c:1233
List * functions
Definition: plannodes.h:522
TupleTableSlot * ExecClearTuple(TupleTableSlot *slot)
Definition: execTuples.c:475
PlanState ps
Definition: execnodes.h:1192
TupleTableSlot * ps_ResultTupleSlot
Definition: execnodes.h:946
Tuplestorestate * tstore
Bitmapset * chgParam
Definition: execnodes.h:941
struct FunctionScanPerFuncState * funcstates
Definition: execnodes.h:1523
TupleTableSlot * func_slot
Plan * plan
Definition: execnodes.h:912
#define lfirst(lc)
Definition: pg_list.h:106
void tuplestore_end(Tuplestorestate *state)
Definition: tuplestore.c:453
Bitmapset * funcparams
Definition: parsenodes.h:1106
bool bms_overlap(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:509
int i
void ExecScanReScan(ScanState *node)
Definition: execScan.c:262