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 524 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().

525 {
526  int i;
527 
528  /*
529  * Free the exprcontext
530  */
531  ExecFreeExprContext(&node->ss.ps);
532 
533  /*
534  * clean out the tuple table
535  */
538 
539  /*
540  * Release slots and tuplestore resources
541  */
542  for (i = 0; i < node->nfuncs; i++)
543  {
544  FunctionScanPerFuncState *fs = &node->funcstates[i];
545 
546  if (fs->func_slot)
548 
549  if (fs->tstore != NULL)
550  {
551  tuplestore_end(node->funcstates[i].tstore);
552  fs->tstore = NULL;
553  }
554  }
555 }
TupleTableSlot * ExecClearTuple(TupleTableSlot *slot)
Definition: execTuples.c:439
TupleTableSlot * ss_ScanTupleSlot
Definition: execnodes.h:1117
void ExecFreeExprContext(PlanState *planstate)
Definition: execUtils.c:603
PlanState ps
Definition: execnodes.h:1114
TupleTableSlot * ps_ResultTupleSlot
Definition: execnodes.h:891
Tuplestorestate * tstore
struct FunctionScanPerFuncState * funcstates
Definition: execnodes.h:1447
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(), ExecAssignResultTypeFromTL(), ExecAssignScanProjectionInfo(), ExecAssignScanType(), ExecFunctionScan(), ExecInitExtraTupleSlot(), ExecInitQual(), ExecInitResultTupleSlot(), ExecInitScanTupleSlot(), ExecInitTableFunctionResult(), PlanState::ExecProcNode, ExecSetSlotDescriptor(), exprCollation(), FunctionScanPerFuncState::func_slot, RangeTblFunction::funccolcollations, RangeTblFunction::funccolcount, RangeTblFunction::funccolnames, RangeTblFunction::funccoltypes, RangeTblFunction::funccoltypmods, RangeTblFunction::funcexpr, FunctionScan::funcordinality, FunctionScan::functions, get_expr_result_type(), i, innerPlan, INT8OID, 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, RECORDOID, 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  /*
338  * tuple table initialization
339  */
340  ExecInitResultTupleSlot(estate, &scanstate->ss.ps);
341  ExecInitScanTupleSlot(estate, &scanstate->ss);
342 
343  /*
344  * initialize child expressions
345  */
346  scanstate->ss.ps.qual =
347  ExecInitQual(node->scan.plan.qual, (PlanState *) scanstate);
348 
349  scanstate->funcstates = palloc(nfuncs * sizeof(FunctionScanPerFuncState));
350 
351  natts = 0;
352  i = 0;
353  foreach(lc, node->functions)
354  {
355  RangeTblFunction *rtfunc = (RangeTblFunction *) lfirst(lc);
356  Node *funcexpr = rtfunc->funcexpr;
357  int colcount = rtfunc->funccolcount;
358  FunctionScanPerFuncState *fs = &scanstate->funcstates[i];
359  TypeFuncClass functypclass;
360  Oid funcrettype;
361  TupleDesc tupdesc;
362 
363  fs->setexpr =
364  ExecInitTableFunctionResult((Expr *) funcexpr,
365  scanstate->ss.ps.ps_ExprContext,
366  &scanstate->ss.ps);
367 
368  /*
369  * Don't allocate the tuplestores; the actual calls to the functions
370  * do that. NULL means that we have not called the function yet (or
371  * need to call it again after a rescan).
372  */
373  fs->tstore = NULL;
374  fs->rowcount = -1;
375 
376  /*
377  * Now determine if the function returns a simple or composite type,
378  * and build an appropriate tupdesc. Note that in the composite case,
379  * the function may now return more columns than it did when the plan
380  * was made; we have to ignore any columns beyond "colcount".
381  */
382  functypclass = get_expr_result_type(funcexpr,
383  &funcrettype,
384  &tupdesc);
385 
386  if (functypclass == TYPEFUNC_COMPOSITE ||
387  functypclass == TYPEFUNC_COMPOSITE_DOMAIN)
388  {
389  /* Composite data type, e.g. a table's row type */
390  Assert(tupdesc);
391  Assert(tupdesc->natts >= colcount);
392  /* Must copy it out of typcache for safety */
393  tupdesc = CreateTupleDescCopy(tupdesc);
394  }
395  else if (functypclass == TYPEFUNC_SCALAR)
396  {
397  /* Base data type, i.e. scalar */
398  tupdesc = CreateTemplateTupleDesc(1, false);
399  TupleDescInitEntry(tupdesc,
400  (AttrNumber) 1,
401  NULL, /* don't care about the name here */
402  funcrettype,
403  -1,
404  0);
406  (AttrNumber) 1,
407  exprCollation(funcexpr));
408  }
409  else if (functypclass == TYPEFUNC_RECORD)
410  {
411  tupdesc = BuildDescFromLists(rtfunc->funccolnames,
412  rtfunc->funccoltypes,
413  rtfunc->funccoltypmods,
414  rtfunc->funccolcollations);
415 
416  /*
417  * For RECORD results, make sure a typmod has been assigned. (The
418  * function should do this for itself, but let's cover things in
419  * case it doesn't.)
420  */
421  BlessTupleDesc(tupdesc);
422  }
423  else
424  {
425  /* crummy error message, but parser should have caught this */
426  elog(ERROR, "function in FROM has unsupported return type");
427  }
428 
429  fs->tupdesc = tupdesc;
430  fs->colcount = colcount;
431 
432  /*
433  * We only need separate slots for the function results if we are
434  * doing ordinality or multiple functions; otherwise, we'll fetch
435  * function results directly into the scan slot.
436  */
437  if (!scanstate->simple)
438  {
439  fs->func_slot = ExecInitExtraTupleSlot(estate);
441  }
442  else
443  fs->func_slot = NULL;
444 
445  natts += colcount;
446  i++;
447  }
448 
449  /*
450  * Create the combined TupleDesc
451  *
452  * If there is just one function without ordinality, the scan result
453  * tupdesc is the same as the function result tupdesc --- except that we
454  * may stuff new names into it below, so drop any rowtype label.
455  */
456  if (scanstate->simple)
457  {
458  scan_tupdesc = CreateTupleDescCopy(scanstate->funcstates[0].tupdesc);
459  scan_tupdesc->tdtypeid = RECORDOID;
460  scan_tupdesc->tdtypmod = -1;
461  }
462  else
463  {
464  AttrNumber attno = 0;
465 
466  if (node->funcordinality)
467  natts++;
468 
469  scan_tupdesc = CreateTemplateTupleDesc(natts, false);
470 
471  for (i = 0; i < nfuncs; i++)
472  {
473  TupleDesc tupdesc = scanstate->funcstates[i].tupdesc;
474  int colcount = scanstate->funcstates[i].colcount;
475  int j;
476 
477  for (j = 1; j <= colcount; j++)
478  TupleDescCopyEntry(scan_tupdesc, ++attno, tupdesc, j);
479  }
480 
481  /* If doing ordinality, add a column of type "bigint" at the end */
482  if (node->funcordinality)
483  {
484  TupleDescInitEntry(scan_tupdesc,
485  ++attno,
486  NULL, /* don't care about the name here */
487  INT8OID,
488  -1,
489  0);
490  }
491 
492  Assert(attno == natts);
493  }
494 
495  ExecAssignScanType(&scanstate->ss, scan_tupdesc);
496 
497  /*
498  * Initialize result tuple type and projection info.
499  */
500  ExecAssignResultTypeFromTL(&scanstate->ss.ps);
501  ExecAssignScanProjectionInfo(&scanstate->ss);
502 
503  /*
504  * Create a memory context that ExecMakeTableFunctionResult can use to
505  * evaluate function arguments in. We can't use the per-tuple context for
506  * this because it gets reset too often; but we don't want to leak
507  * evaluation results into the query-lifespan context either. We just
508  * need one context, because we evaluate each function separately.
509  */
511  "Table function arguments",
513 
514  return scanstate;
515 }
List * qual
Definition: plannodes.h:145
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:110
Plan plan
Definition: plannodes.h:329
static TupleTableSlot * ExecFunctionScan(PlanState *pstate)
TupleTableSlot * ExecInitExtraTupleSlot(EState *estate)
Definition: execTuples.c:852
Oid tdtypeid
Definition: tupdesc.h:80
void ExecInitScanTupleSlot(EState *estate, ScanState *scanstate)
Definition: execTuples.c:842
TupleDesc BuildDescFromLists(List *names, List *types, List *typmods, List *collations)
Definition: tupdesc.c:825
List * functions
Definition: plannodes.h:509
ExprContext * ps_ExprContext
Definition: execnodes.h:892
Definition: nodes.h:512
MemoryContext argcontext
Definition: execnodes.h:1448
EState * state
Definition: execnodes.h:860
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:79
ExprState * ExecInitQual(List *qual, PlanState *parent)
Definition: execExpr.c:204
void ExecAssignResultTypeFromTL(PlanState *planstate)
Definition: execUtils.c:448
int32 tdtypmod
Definition: tupdesc.h:81
SetExprState * ExecInitTableFunctionResult(Expr *expr, ExprContext *econtext, PlanState *parent)
Definition: execSRF.c:56
PlanState ps
Definition: execnodes.h:1114
#define ERROR
Definition: elog.h:43
void ExecAssignScanProjectionInfo(ScanState *node)
Definition: execScan.c:235
void ExecInitResultTupleSlot(EState *estate, PlanState *planstate)
Definition: execTuples.c:832
void TupleDescCopyEntry(TupleDesc dst, AttrNumber dstAttno, TupleDesc src, AttrNumber srcAttno)
Definition: tupdesc.c:249
void TupleDescInitEntryCollation(TupleDesc desc, AttrNumber attributeNumber, Oid collationid)
Definition: tupdesc.c:702
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:197
#define innerPlan(node)
Definition: plannodes.h:173
TupleDesc BlessTupleDesc(TupleDesc tupdesc)
Definition: execTuples.c:1032
Tuplestorestate * tstore
#define RECORDOID
Definition: pg_type.h:680
MemoryContext CurrentMemoryContext
Definition: mcxt.c:37
TypeFuncClass
Definition: funcapi.h:155
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition: tupdesc.c:543
#define outerPlan(node)
Definition: plannodes.h:174
#define AllocSetContextCreate(parent, name, allocparams)
Definition: memutils.h:165
struct FunctionScanPerFuncState * funcstates
Definition: execnodes.h:1447
ExecProcNodeMtd ExecProcNode
Definition: execnodes.h:864
void ExecSetSlotDescriptor(TupleTableSlot *slot, TupleDesc tupdesc)
Definition: execTuples.c:247
TupleTableSlot * func_slot
Plan * plan
Definition: execnodes.h:858
List * funccoltypmods
Definition: parsenodes.h:1092
#define INT8OID
Definition: pg_type.h:304
List * funccolcollations
Definition: parsenodes.h:1093
#define makeNode(_type_)
Definition: nodes.h:560
bool funcordinality
Definition: plannodes.h:510
#define Assert(condition)
Definition: c.h:680
#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:426
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:43
ExprState * qual
Definition: execnodes.h:876
void * palloc(Size size)
Definition: mcxt.c:835
int i
void ExecAssignScanType(ScanState *scanstate, TupleDesc tupDesc)
Definition: execUtils.c:627
#define elog
Definition: elog.h:219
int16 AttrNumber
Definition: attnum.h:21

◆ ExecReScanFunctionScan()

void ExecReScanFunctionScan ( FunctionScanState node)

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

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