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

Go to the source code of this file.

Typedefs

typedef struct SQLFunctionParseInfoSQLFunctionParseInfoPtr
 

Functions

Datum fmgr_sql (PG_FUNCTION_ARGS)
 
SQLFunctionParseInfoPtr prepare_sql_fn_parse_info (HeapTuple procedureTuple, Node *call_expr, Oid inputCollation)
 
void sql_fn_parser_setup (struct ParseState *pstate, SQLFunctionParseInfoPtr pinfo)
 
bool check_sql_fn_retval (Oid func_id, Oid rettype, List *queryTreeList, bool *modifyTargetList, JunkFilter **junkFilter)
 
DestReceiverCreateSQLFunctionDestReceiver (void)
 

Typedef Documentation

◆ SQLFunctionParseInfoPtr

Definition at line 21 of file functions.h.

Function Documentation

◆ check_sql_fn_retval()

bool check_sql_fn_retval ( Oid  func_id,
Oid  rettype,
List queryTreeList,
bool modifyTargetList,
JunkFilter **  junkFilter 
)

Definition at line 1534 of file functions.c.

References Assert, AssertArg, Query::canSetTag, CMD_DELETE, CMD_INSERT, CMD_SELECT, CMD_UPDATE, COERCE_IMPLICIT_CAST, Query::commandType, CreateTupleDescCopy(), ereport, errcode(), errdetail(), errmsg(), ERROR, ExecCleanTargetListLength(), ExecInitJunkFilter(), ExecInitJunkFilterConversion(), TargetEntry::expr, exprType(), format_type_be(), get_func_result_type(), get_typcollation(), get_typtype(), INT4OID, InvalidOid, IsBinaryCoercible(), IsPolymorphicType, lappend(), lfirst, lfirst_node, linitial, list_concat(), makeConst(), makeRelabelType(), makeTargetEntry(), tupleDesc::natts, NIL, parse(), RECORDOID, TargetEntry::resjunk, TargetEntry::resno, TargetEntry::ressortgroupref, Query::returningList, Query::setOperations, Query::targetList, TupleDescAttr, TYPEFUNC_COMPOSITE, TYPTYPE_BASE, TYPTYPE_COMPOSITE, TYPTYPE_DOMAIN, TYPTYPE_ENUM, TYPTYPE_RANGE, and VOIDOID.

Referenced by fmgr_sql_validator(), init_sql_fcache(), inline_function(), and inline_set_returning_function().

1537 {
1538  Query *parse;
1539  List **tlist_ptr;
1540  List *tlist;
1541  int tlistlen;
1542  char fn_typtype;
1543  Oid restype;
1544  ListCell *lc;
1545 
1546  AssertArg(!IsPolymorphicType(rettype));
1547 
1548  if (modifyTargetList)
1549  *modifyTargetList = false; /* initialize for no change */
1550  if (junkFilter)
1551  *junkFilter = NULL; /* initialize in case of procedure/VOID result */
1552 
1553  if (!rettype)
1554  return false;
1555 
1556  /*
1557  * Find the last canSetTag query in the list. This isn't necessarily the
1558  * last parsetree, because rule rewriting can insert queries after what
1559  * the user wrote.
1560  */
1561  parse = NULL;
1562  foreach(lc, queryTreeList)
1563  {
1564  Query *q = lfirst_node(Query, lc);
1565 
1566  if (q->canSetTag)
1567  parse = q;
1568  }
1569 
1570  /*
1571  * If it's a plain SELECT, it returns whatever the targetlist says.
1572  * Otherwise, if it's INSERT/UPDATE/DELETE with RETURNING, it returns
1573  * that. Otherwise, the function return type must be VOID.
1574  *
1575  * Note: eventually replace this test with QueryReturnsTuples? We'd need
1576  * a more general method of determining the output type, though. Also, it
1577  * seems too dangerous to consider FETCH or EXECUTE as returning a
1578  * determinable rowtype, since they depend on relatively short-lived
1579  * entities.
1580  */
1581  if (parse &&
1582  parse->commandType == CMD_SELECT)
1583  {
1584  tlist_ptr = &parse->targetList;
1585  tlist = parse->targetList;
1586  }
1587  else if (parse &&
1588  (parse->commandType == CMD_INSERT ||
1589  parse->commandType == CMD_UPDATE ||
1590  parse->commandType == CMD_DELETE) &&
1591  parse->returningList)
1592  {
1593  tlist_ptr = &parse->returningList;
1594  tlist = parse->returningList;
1595  }
1596  else
1597  {
1598  /* Empty function body, or last statement is a utility command */
1599  if (rettype && rettype != VOIDOID)
1600  ereport(ERROR,
1601  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1602  errmsg("return type mismatch in function declared to return %s",
1603  format_type_be(rettype)),
1604  errdetail("Function's final statement must be SELECT or INSERT/UPDATE/DELETE RETURNING.")));
1605  return false;
1606  }
1607 
1608  /*
1609  * OK, check that the targetlist returns something matching the declared
1610  * type. (We used to insist that the declared type not be VOID in this
1611  * case, but that makes it hard to write a void function that exits after
1612  * calling another void function. Instead, we insist that the tlist
1613  * return void ... so void is treated as if it were a scalar type below.)
1614  */
1615 
1616  /*
1617  * Count the non-junk entries in the result targetlist.
1618  */
1619  tlistlen = ExecCleanTargetListLength(tlist);
1620 
1621  fn_typtype = get_typtype(rettype);
1622 
1623  if (fn_typtype == TYPTYPE_BASE ||
1624  fn_typtype == TYPTYPE_DOMAIN ||
1625  fn_typtype == TYPTYPE_ENUM ||
1626  fn_typtype == TYPTYPE_RANGE ||
1627  rettype == VOIDOID)
1628  {
1629  /*
1630  * For scalar-type returns, the target list must have exactly one
1631  * non-junk entry, and its type must agree with what the user
1632  * declared; except we allow binary-compatible types too.
1633  */
1634  TargetEntry *tle;
1635 
1636  if (tlistlen != 1)
1637  ereport(ERROR,
1638  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1639  errmsg("return type mismatch in function declared to return %s",
1640  format_type_be(rettype)),
1641  errdetail("Final statement must return exactly one column.")));
1642 
1643  /* We assume here that non-junk TLEs must come first in tlists */
1644  tle = (TargetEntry *) linitial(tlist);
1645  Assert(!tle->resjunk);
1646 
1647  restype = exprType((Node *) tle->expr);
1648  if (!IsBinaryCoercible(restype, rettype))
1649  ereport(ERROR,
1650  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1651  errmsg("return type mismatch in function declared to return %s",
1652  format_type_be(rettype)),
1653  errdetail("Actual return type is %s.",
1654  format_type_be(restype))));
1655  if (modifyTargetList && restype != rettype)
1656  {
1657  tle->expr = (Expr *) makeRelabelType(tle->expr,
1658  rettype,
1659  -1,
1660  get_typcollation(rettype),
1662  /* Relabel is dangerous if TLE is a sort/group or setop column */
1663  if (tle->ressortgroupref != 0 || parse->setOperations)
1664  *modifyTargetList = true;
1665  }
1666 
1667  /* Set up junk filter if needed */
1668  if (junkFilter)
1669  *junkFilter = ExecInitJunkFilter(tlist, false, NULL);
1670  }
1671  else if (fn_typtype == TYPTYPE_COMPOSITE || rettype == RECORDOID)
1672  {
1673  /*
1674  * Returns a rowtype.
1675  *
1676  * Note that we will not consider a domain over composite to be a
1677  * "rowtype" return type; it goes through the scalar case above. This
1678  * is because SQL functions don't provide any implicit casting to the
1679  * result type, so there is no way to produce a domain-over-composite
1680  * result except by computing it as an explicit single-column result.
1681  */
1682  TupleDesc tupdesc;
1683  int tupnatts; /* physical number of columns in tuple */
1684  int tuplogcols; /* # of nondeleted columns in tuple */
1685  int colindex; /* physical column index */
1686  List *newtlist; /* new non-junk tlist entries */
1687  List *junkattrs; /* new junk tlist entries */
1688 
1689  /*
1690  * If the target list is of length 1, and the type of the varnode in
1691  * the target list matches the declared return type, this is okay.
1692  * This can happen, for example, where the body of the function is
1693  * 'SELECT func2()', where func2 has the same composite return type as
1694  * the function that's calling it.
1695  *
1696  * XXX Note that if rettype is RECORD, the IsBinaryCoercible check
1697  * will succeed for any composite restype. For the moment we rely on
1698  * runtime type checking to catch any discrepancy, but it'd be nice to
1699  * do better at parse time.
1700  */
1701  if (tlistlen == 1)
1702  {
1703  TargetEntry *tle = (TargetEntry *) linitial(tlist);
1704 
1705  Assert(!tle->resjunk);
1706  restype = exprType((Node *) tle->expr);
1707  if (IsBinaryCoercible(restype, rettype))
1708  {
1709  if (modifyTargetList && restype != rettype)
1710  {
1711  tle->expr = (Expr *) makeRelabelType(tle->expr,
1712  rettype,
1713  -1,
1714  get_typcollation(rettype),
1716  /* Relabel is dangerous if sort/group or setop column */
1717  if (tle->ressortgroupref != 0 || parse->setOperations)
1718  *modifyTargetList = true;
1719  }
1720  /* Set up junk filter if needed */
1721  if (junkFilter)
1722  *junkFilter = ExecInitJunkFilter(tlist, false, NULL);
1723  return false; /* NOT returning whole tuple */
1724  }
1725  }
1726 
1727  /*
1728  * Is the rowtype fixed, or determined only at runtime? (Note we
1729  * cannot see TYPEFUNC_COMPOSITE_DOMAIN here.)
1730  */
1731  if (get_func_result_type(func_id, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
1732  {
1733  /*
1734  * Assume we are returning the whole tuple. Crosschecking against
1735  * what the caller expects will happen at runtime.
1736  */
1737  if (junkFilter)
1738  *junkFilter = ExecInitJunkFilter(tlist, false, NULL);
1739  return true;
1740  }
1741  Assert(tupdesc);
1742 
1743  /*
1744  * Verify that the targetlist matches the return tuple type. We scan
1745  * the non-deleted attributes to ensure that they match the datatypes
1746  * of the non-resjunk columns. For deleted attributes, insert NULL
1747  * result columns if the caller asked for that.
1748  */
1749  tupnatts = tupdesc->natts;
1750  tuplogcols = 0; /* we'll count nondeleted cols as we go */
1751  colindex = 0;
1752  newtlist = NIL; /* these are only used if modifyTargetList */
1753  junkattrs = NIL;
1754 
1755  foreach(lc, tlist)
1756  {
1757  TargetEntry *tle = (TargetEntry *) lfirst(lc);
1758  Form_pg_attribute attr;
1759  Oid tletype;
1760  Oid atttype;
1761 
1762  if (tle->resjunk)
1763  {
1764  if (modifyTargetList)
1765  junkattrs = lappend(junkattrs, tle);
1766  continue;
1767  }
1768 
1769  do
1770  {
1771  colindex++;
1772  if (colindex > tupnatts)
1773  ereport(ERROR,
1774  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1775  errmsg("return type mismatch in function declared to return %s",
1776  format_type_be(rettype)),
1777  errdetail("Final statement returns too many columns.")));
1778  attr = TupleDescAttr(tupdesc, colindex - 1);
1779  if (attr->attisdropped && modifyTargetList)
1780  {
1781  Expr *null_expr;
1782 
1783  /* The type of the null we insert isn't important */
1784  null_expr = (Expr *) makeConst(INT4OID,
1785  -1,
1786  InvalidOid,
1787  sizeof(int32),
1788  (Datum) 0,
1789  true, /* isnull */
1790  true /* byval */ );
1791  newtlist = lappend(newtlist,
1792  makeTargetEntry(null_expr,
1793  colindex,
1794  NULL,
1795  false));
1796  /* NULL insertion is dangerous in a setop */
1797  if (parse->setOperations)
1798  *modifyTargetList = true;
1799  }
1800  } while (attr->attisdropped);
1801  tuplogcols++;
1802 
1803  tletype = exprType((Node *) tle->expr);
1804  atttype = attr->atttypid;
1805  if (!IsBinaryCoercible(tletype, atttype))
1806  ereport(ERROR,
1807  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1808  errmsg("return type mismatch in function declared to return %s",
1809  format_type_be(rettype)),
1810  errdetail("Final statement returns %s instead of %s at column %d.",
1811  format_type_be(tletype),
1812  format_type_be(atttype),
1813  tuplogcols)));
1814  if (modifyTargetList)
1815  {
1816  if (tletype != atttype)
1817  {
1818  tle->expr = (Expr *) makeRelabelType(tle->expr,
1819  atttype,
1820  -1,
1821  get_typcollation(atttype),
1823  /* Relabel is dangerous if sort/group or setop column */
1824  if (tle->ressortgroupref != 0 || parse->setOperations)
1825  *modifyTargetList = true;
1826  }
1827  tle->resno = colindex;
1828  newtlist = lappend(newtlist, tle);
1829  }
1830  }
1831 
1832  /* remaining columns in tupdesc had better all be dropped */
1833  for (colindex++; colindex <= tupnatts; colindex++)
1834  {
1835  if (!TupleDescAttr(tupdesc, colindex - 1)->attisdropped)
1836  ereport(ERROR,
1837  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1838  errmsg("return type mismatch in function declared to return %s",
1839  format_type_be(rettype)),
1840  errdetail("Final statement returns too few columns.")));
1841  if (modifyTargetList)
1842  {
1843  Expr *null_expr;
1844 
1845  /* The type of the null we insert isn't important */
1846  null_expr = (Expr *) makeConst(INT4OID,
1847  -1,
1848  InvalidOid,
1849  sizeof(int32),
1850  (Datum) 0,
1851  true, /* isnull */
1852  true /* byval */ );
1853  newtlist = lappend(newtlist,
1854  makeTargetEntry(null_expr,
1855  colindex,
1856  NULL,
1857  false));
1858  /* NULL insertion is dangerous in a setop */
1859  if (parse->setOperations)
1860  *modifyTargetList = true;
1861  }
1862  }
1863 
1864  if (modifyTargetList)
1865  {
1866  /* ensure resjunk columns are numbered correctly */
1867  foreach(lc, junkattrs)
1868  {
1869  TargetEntry *tle = (TargetEntry *) lfirst(lc);
1870 
1871  tle->resno = colindex++;
1872  }
1873  /* replace the tlist with the modified one */
1874  *tlist_ptr = list_concat(newtlist, junkattrs);
1875  }
1876 
1877  /* Set up junk filter if needed */
1878  if (junkFilter)
1879  *junkFilter = ExecInitJunkFilterConversion(tlist,
1880  CreateTupleDescCopy(tupdesc),
1881  NULL);
1882 
1883  /* Report that we are returning entire tuple result */
1884  return true;
1885  }
1886  else
1887  ereport(ERROR,
1888  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1889  errmsg("return type %s is not supported for SQL functions",
1890  format_type_be(rettype))));
1891 
1892  return false;
1893 }
#define NIL
Definition: pg_list.h:69
#define TYPTYPE_DOMAIN
Definition: pg_type.h:722
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:102
#define TYPTYPE_BASE
Definition: pg_type.h:720
#define TYPTYPE_COMPOSITE
Definition: pg_type.h:721
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:90
JunkFilter * ExecInitJunkFilterConversion(List *targetList, TupleDesc cleanTupType, TupleTableSlot *slot)
Definition: execJunk.c:136
#define INT4OID
Definition: pg_type.h:316
Definition: nodes.h:512
int errcode(int sqlerrcode)
Definition: elog.c:575
char get_typtype(Oid typid)
Definition: lsyscache.c:2398
char * format_type_be(Oid type_oid)
Definition: format_type.c:94
List * list_concat(List *list1, List *list2)
Definition: list.c:321
unsigned int Oid
Definition: postgres_ext.h:31
Const * makeConst(Oid consttype, int32 consttypmod, Oid constcollid, int constlen, Datum constvalue, bool constisnull, bool constbyval)
Definition: makefuncs.c:298
int natts
Definition: tupdesc.h:79
signed int int32
Definition: c.h:284
List * targetList
Definition: parsenodes.h:138
bool resjunk
Definition: primnodes.h:1382
#define linitial(l)
Definition: pg_list.h:111
#define VOIDOID
Definition: pg_type.h:690
#define ERROR
Definition: elog.h:43
#define IsPolymorphicType(typid)
Definition: pg_type.h:745
#define lfirst_node(type, lc)
Definition: pg_list.h:109
RelabelType * makeRelabelType(Expr *arg, Oid rtype, int32 rtypmod, Oid rcollid, CoercionForm rformat)
Definition: makefuncs.c:401
JunkFilter * ExecInitJunkFilter(List *targetList, bool hasoid, TupleTableSlot *slot)
Definition: execJunk.c:61
int errdetail(const char *fmt,...)
Definition: elog.c:873
AttrNumber resno
Definition: primnodes.h:1376
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:187
#define RECORDOID
Definition: pg_type.h:680
List * returningList
Definition: parsenodes.h:144
#define ereport(elevel, rest)
Definition: elog.h:122
TargetEntry * makeTargetEntry(Expr *expr, AttrNumber resno, char *resname, bool resjunk)
Definition: makefuncs.c:237
#define AssertArg(condition)
Definition: c.h:672
bool IsBinaryCoercible(Oid srctype, Oid targettype)
List * lappend(List *list, void *datum)
Definition: list.c:128
int ExecCleanTargetListLength(List *targetlist)
Definition: execUtils.c:1096
TypeFuncClass get_func_result_type(Oid functionId, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:272
#define TYPTYPE_RANGE
Definition: pg_type.h:725
uintptr_t Datum
Definition: postgres.h:372
#define InvalidOid
Definition: postgres_ext.h:36
Oid get_typcollation(Oid typid)
Definition: lsyscache.c:2814
CmdType commandType
Definition: parsenodes.h:110
#define Assert(condition)
Definition: c.h:670
#define lfirst(lc)
Definition: pg_list.h:106
Expr * expr
Definition: primnodes.h:1375
bool canSetTag
Definition: parsenodes.h:116
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:42
Node * setOperations
Definition: parsenodes.h:163
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define TYPTYPE_ENUM
Definition: pg_type.h:723
Index ressortgroupref
Definition: primnodes.h:1378
Definition: pg_list.h:45
static struct subre * parse(struct vars *, int, int, struct state *, struct state *)
Definition: regcomp.c:649

◆ CreateSQLFunctionDestReceiver()

DestReceiver* CreateSQLFunctionDestReceiver ( void  )

Definition at line 1900 of file functions.c.

References DestSQLFunction, palloc0(), sqlfunction_destroy(), sqlfunction_receive(), sqlfunction_shutdown(), and sqlfunction_startup().

Referenced by CreateDestReceiver().

1901 {
1902  DR_sqlfunction *self = (DR_sqlfunction *) palloc0(sizeof(DR_sqlfunction));
1903 
1904  self->pub.receiveSlot = sqlfunction_receive;
1905  self->pub.rStartup = sqlfunction_startup;
1906  self->pub.rShutdown = sqlfunction_shutdown;
1907  self->pub.rDestroy = sqlfunction_destroy;
1908  self->pub.mydest = DestSQLFunction;
1909 
1910  /* private fields will be set by postquel_start */
1911 
1912  return (DestReceiver *) self;
1913 }
static void sqlfunction_destroy(DestReceiver *self)
Definition: functions.c:1954
static void sqlfunction_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
Definition: functions.c:1919
static bool sqlfunction_receive(TupleTableSlot *slot, DestReceiver *self)
Definition: functions.c:1928
void * palloc0(Size size)
Definition: mcxt.c:877
static void sqlfunction_shutdown(DestReceiver *self)
Definition: functions.c:1945

◆ fmgr_sql()

Datum fmgr_sql ( PG_FUNCTION_ARGS  )

Definition at line 992 of file functions.c.

References ReturnSetInfo::allowedModes, ErrorContextCallback::arg, Assert, ErrorContextCallback::callback, CommandCounterIncrement(), CreateTupleDescCopy(), ReturnSetInfo::econtext, elog, ereport, errcode(), errmsg(), ERROR, error_context_stack, ExprEndResult, ExprMultipleResult, F_EXEC_DONE, F_EXEC_START, SQLFunctionCache::fcontext, SQLFunctionCache::func_state, GetTransactionSnapshot(), init_sql_fcache(), InvalidOid, IsA, ReturnSetInfo::isDone, JunkFilter::jf_cleanTupType, JunkFilter::jf_resultSlot, SQLFunctionCache::junkFilter, execution_state::lazyEval, SQLFunctionCache::lazyEval, lfirst, lnext, PGPROC::lxid, SQLFunctionCache::lxid, MemoryContextDelete(), MemoryContextSwitchTo(), MyProc, execution_state::next, PG_GET_COLLATION, PointerGetDatum, PopActiveSnapshot(), postquel_end(), postquel_get_single_result(), postquel_getnext(), postquel_start(), postquel_sub_params(), ErrorContextCallback::previous, PushActiveSnapshot(), execution_state::qd, SQLFunctionCache::readonly_func, RegisterExprContextCallback(), SQLFunctionCache::rettype, ReturnSetInfo::returnMode, SQLFunctionCache::returnsSet, ReturnSetInfo::setDesc, ReturnSetInfo::setResult, SFRM_Materialize, SFRM_Materialize_Preferred, SFRM_Materialize_Random, SFRM_ValuePerCall, SQLFunctionCache::shutdown_reg, ShutdownSQLFunction(), QueryDesc::snapshot, sql_exec_error_callback(), execution_state::status, SubTransactionIsActive(), SQLFunctionCache::subxid, SQLFunctionCache::tstore, tuplestore_begin_heap(), tuplestore_clear(), tuplestore_gettupleslot(), UnregisterExprContextCallback(), UpdateActiveSnapshotCommandId(), VOIDOID, and work_mem.

Referenced by fmgr_info_cxt_security().

993 {
994  SQLFunctionCachePtr fcache;
995  ErrorContextCallback sqlerrcontext;
996  MemoryContext oldcontext;
997  bool randomAccess;
998  bool lazyEvalOK;
999  bool is_first;
1000  bool pushed_snapshot;
1001  execution_state *es;
1002  TupleTableSlot *slot;
1003  Datum result;
1004  List *eslist;
1005  ListCell *eslc;
1006 
1007  /*
1008  * Setup error traceback support for ereport()
1009  */
1010  sqlerrcontext.callback = sql_exec_error_callback;
1011  sqlerrcontext.arg = fcinfo->flinfo;
1012  sqlerrcontext.previous = error_context_stack;
1013  error_context_stack = &sqlerrcontext;
1014 
1015  /* Check call context */
1016  if (fcinfo->flinfo->fn_retset)
1017  {
1018  ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
1019 
1020  /*
1021  * For simplicity, we require callers to support both set eval modes.
1022  * There are cases where we must use one or must use the other, and
1023  * it's not really worthwhile to postpone the check till we know. But
1024  * note we do not require caller to provide an expectedDesc.
1025  */
1026  if (!rsi || !IsA(rsi, ReturnSetInfo) ||
1027  (rsi->allowedModes & SFRM_ValuePerCall) == 0 ||
1028  (rsi->allowedModes & SFRM_Materialize) == 0)
1029  ereport(ERROR,
1030  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1031  errmsg("set-valued function called in context that cannot accept a set")));
1032  randomAccess = rsi->allowedModes & SFRM_Materialize_Random;
1033  lazyEvalOK = !(rsi->allowedModes & SFRM_Materialize_Preferred);
1034  }
1035  else
1036  {
1037  randomAccess = false;
1038  lazyEvalOK = true;
1039  }
1040 
1041  /*
1042  * Initialize fcache (build plans) if first time through; or re-initialize
1043  * if the cache is stale.
1044  */
1045  fcache = (SQLFunctionCachePtr) fcinfo->flinfo->fn_extra;
1046 
1047  if (fcache != NULL)
1048  {
1049  if (fcache->lxid != MyProc->lxid ||
1050  !SubTransactionIsActive(fcache->subxid))
1051  {
1052  /* It's stale; unlink and delete */
1053  fcinfo->flinfo->fn_extra = NULL;
1054  MemoryContextDelete(fcache->fcontext);
1055  fcache = NULL;
1056  }
1057  }
1058 
1059  if (fcache == NULL)
1060  {
1061  init_sql_fcache(fcinfo->flinfo, PG_GET_COLLATION(), lazyEvalOK);
1062  fcache = (SQLFunctionCachePtr) fcinfo->flinfo->fn_extra;
1063  }
1064 
1065  /*
1066  * Switch to context in which the fcache lives. This ensures that our
1067  * tuplestore etc will have sufficient lifetime. The sub-executor is
1068  * responsible for deleting per-tuple information. (XXX in the case of a
1069  * long-lived FmgrInfo, this policy represents more memory leakage, but
1070  * it's not entirely clear where to keep stuff instead.)
1071  */
1072  oldcontext = MemoryContextSwitchTo(fcache->fcontext);
1073 
1074  /*
1075  * Find first unfinished query in function, and note whether it's the
1076  * first query.
1077  */
1078  eslist = fcache->func_state;
1079  es = NULL;
1080  is_first = true;
1081  foreach(eslc, eslist)
1082  {
1083  es = (execution_state *) lfirst(eslc);
1084 
1085  while (es && es->status == F_EXEC_DONE)
1086  {
1087  is_first = false;
1088  es = es->next;
1089  }
1090 
1091  if (es)
1092  break;
1093  }
1094 
1095  /*
1096  * Convert params to appropriate format if starting a fresh execution. (If
1097  * continuing execution, we can re-use prior params.)
1098  */
1099  if (is_first && es && es->status == F_EXEC_START)
1100  postquel_sub_params(fcache, fcinfo);
1101 
1102  /*
1103  * Build tuplestore to hold results, if we don't have one already. Note
1104  * it's in the query-lifespan context.
1105  */
1106  if (!fcache->tstore)
1107  fcache->tstore = tuplestore_begin_heap(randomAccess, false, work_mem);
1108 
1109  /*
1110  * Execute each command in the function one after another until we either
1111  * run out of commands or get a result row from a lazily-evaluated SELECT.
1112  *
1113  * Notes about snapshot management:
1114  *
1115  * In a read-only function, we just use the surrounding query's snapshot.
1116  *
1117  * In a non-read-only function, we rely on the fact that we'll never
1118  * suspend execution between queries of the function: the only reason to
1119  * suspend execution before completion is if we are returning a row from a
1120  * lazily-evaluated SELECT. So, when first entering this loop, we'll
1121  * either start a new query (and push a fresh snapshot) or re-establish
1122  * the active snapshot from the existing query descriptor. If we need to
1123  * start a new query in a subsequent execution of the loop, either we need
1124  * a fresh snapshot (and pushed_snapshot is false) or the existing
1125  * snapshot is on the active stack and we can just bump its command ID.
1126  */
1127  pushed_snapshot = false;
1128  while (es)
1129  {
1130  bool completed;
1131 
1132  if (es->status == F_EXEC_START)
1133  {
1134  /*
1135  * If not read-only, be sure to advance the command counter for
1136  * each command, so that all work to date in this transaction is
1137  * visible. Take a new snapshot if we don't have one yet,
1138  * otherwise just bump the command ID in the existing snapshot.
1139  */
1140  if (!fcache->readonly_func)
1141  {
1143  if (!pushed_snapshot)
1144  {
1146  pushed_snapshot = true;
1147  }
1148  else
1150  }
1151 
1152  postquel_start(es, fcache);
1153  }
1154  else if (!fcache->readonly_func && !pushed_snapshot)
1155  {
1156  /* Re-establish active snapshot when re-entering function */
1158  pushed_snapshot = true;
1159  }
1160 
1161  completed = postquel_getnext(es, fcache);
1162 
1163  /*
1164  * If we ran the command to completion, we can shut it down now. Any
1165  * row(s) we need to return are safely stashed in the tuplestore, and
1166  * we want to be sure that, for example, AFTER triggers get fired
1167  * before we return anything. Also, if the function doesn't return
1168  * set, we can shut it down anyway because it must be a SELECT and we
1169  * don't care about fetching any more result rows.
1170  */
1171  if (completed || !fcache->returnsSet)
1172  postquel_end(es);
1173 
1174  /*
1175  * Break from loop if we didn't shut down (implying we got a
1176  * lazily-evaluated row). Otherwise we'll press on till the whole
1177  * function is done, relying on the tuplestore to keep hold of the
1178  * data to eventually be returned. This is necessary since an
1179  * INSERT/UPDATE/DELETE RETURNING that sets the result might be
1180  * followed by additional rule-inserted commands, and we want to
1181  * finish doing all those commands before we return anything.
1182  */
1183  if (es->status != F_EXEC_DONE)
1184  break;
1185 
1186  /*
1187  * Advance to next execution_state, which might be in the next list.
1188  */
1189  es = es->next;
1190  while (!es)
1191  {
1192  eslc = lnext(eslc);
1193  if (!eslc)
1194  break; /* end of function */
1195 
1196  es = (execution_state *) lfirst(eslc);
1197 
1198  /*
1199  * Flush the current snapshot so that we will take a new one for
1200  * the new query list. This ensures that new snaps are taken at
1201  * original-query boundaries, matching the behavior of interactive
1202  * execution.
1203  */
1204  if (pushed_snapshot)
1205  {
1207  pushed_snapshot = false;
1208  }
1209  }
1210  }
1211 
1212  /*
1213  * The tuplestore now contains whatever row(s) we are supposed to return.
1214  */
1215  if (fcache->returnsSet)
1216  {
1217  ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
1218 
1219  if (es)
1220  {
1221  /*
1222  * If we stopped short of being done, we must have a lazy-eval
1223  * row.
1224  */
1225  Assert(es->lazyEval);
1226  /* Re-use the junkfilter's output slot to fetch back the tuple */
1227  Assert(fcache->junkFilter);
1228  slot = fcache->junkFilter->jf_resultSlot;
1229  if (!tuplestore_gettupleslot(fcache->tstore, true, false, slot))
1230  elog(ERROR, "failed to fetch lazy-eval tuple");
1231  /* Extract the result as a datum, and copy out from the slot */
1232  result = postquel_get_single_result(slot, fcinfo,
1233  fcache, oldcontext);
1234  /* Clear the tuplestore, but keep it for next time */
1235  /* NB: this might delete the slot's content, but we don't care */
1236  tuplestore_clear(fcache->tstore);
1237 
1238  /*
1239  * Let caller know we're not finished.
1240  */
1241  rsi->isDone = ExprMultipleResult;
1242 
1243  /*
1244  * Ensure we will get shut down cleanly if the exprcontext is not
1245  * run to completion.
1246  */
1247  if (!fcache->shutdown_reg)
1248  {
1251  PointerGetDatum(fcache));
1252  fcache->shutdown_reg = true;
1253  }
1254  }
1255  else if (fcache->lazyEval)
1256  {
1257  /*
1258  * We are done with a lazy evaluation. Clean up.
1259  */
1260  tuplestore_clear(fcache->tstore);
1261 
1262  /*
1263  * Let caller know we're finished.
1264  */
1265  rsi->isDone = ExprEndResult;
1266 
1267  fcinfo->isnull = true;
1268  result = (Datum) 0;
1269 
1270  /* Deregister shutdown callback, if we made one */
1271  if (fcache->shutdown_reg)
1272  {
1275  PointerGetDatum(fcache));
1276  fcache->shutdown_reg = false;
1277  }
1278  }
1279  else
1280  {
1281  /*
1282  * We are done with a non-lazy evaluation. Return whatever is in
1283  * the tuplestore. (It is now caller's responsibility to free the
1284  * tuplestore when done.)
1285  */
1287  rsi->setResult = fcache->tstore;
1288  fcache->tstore = NULL;
1289  /* must copy desc because execSRF.c will free it */
1290  if (fcache->junkFilter)
1292 
1293  fcinfo->isnull = true;
1294  result = (Datum) 0;
1295 
1296  /* Deregister shutdown callback, if we made one */
1297  if (fcache->shutdown_reg)
1298  {
1301  PointerGetDatum(fcache));
1302  fcache->shutdown_reg = false;
1303  }
1304  }
1305  }
1306  else
1307  {
1308  /*
1309  * Non-set function. If we got a row, return it; else return NULL.
1310  */
1311  if (fcache->junkFilter)
1312  {
1313  /* Re-use the junkfilter's output slot to fetch back the tuple */
1314  slot = fcache->junkFilter->jf_resultSlot;
1315  if (tuplestore_gettupleslot(fcache->tstore, true, false, slot))
1316  result = postquel_get_single_result(slot, fcinfo,
1317  fcache, oldcontext);
1318  else
1319  {
1320  fcinfo->isnull = true;
1321  result = (Datum) 0;
1322  }
1323  }
1324  else
1325  {
1326  /* Should only get here for procedures and VOID functions */
1327  Assert(fcache->rettype == InvalidOid || fcache->rettype == VOIDOID);
1328  fcinfo->isnull = true;
1329  result = (Datum) 0;
1330  }
1331 
1332  /* Clear the tuplestore, but keep it for next time */
1333  tuplestore_clear(fcache->tstore);
1334  }
1335 
1336  /* Pop snapshot if we have pushed one */
1337  if (pushed_snapshot)
1339 
1340  /*
1341  * If we've gone through every command in the function, we are done. Reset
1342  * the execution states to start over again on next call.
1343  */
1344  if (es == NULL)
1345  {
1346  foreach(eslc, fcache->func_state)
1347  {
1348  es = (execution_state *) lfirst(eslc);
1349  while (es)
1350  {
1351  es->status = F_EXEC_START;
1352  es = es->next;
1353  }
1354  }
1355  }
1356 
1357  error_context_stack = sqlerrcontext.previous;
1358 
1359  MemoryContextSwitchTo(oldcontext);
1360 
1361  return result;
1362 }
bool SubTransactionIsActive(SubTransactionId subxid)
Definition: xact.c:656
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:102
void UpdateActiveSnapshotCommandId(void)
Definition: snapmgr.c:781
#define IsA(nodeptr, _type_)
Definition: nodes.h:563
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:200
MemoryContext fcontext
Definition: functions.c:121
PGPROC * MyProc
Definition: proc.c:67
void UnregisterExprContextCallback(ExprContext *econtext, ExprContextCallbackFunction function, Datum arg)
Definition: execUtils.c:845
#define PointerGetDatum(X)
Definition: postgres.h:562
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
ExecStatus status
Definition: functions.c:66
int errcode(int sqlerrcode)
Definition: elog.c:575
TupleTableSlot * jf_resultSlot
Definition: execnodes.h:336
JunkFilter * junkFilter
Definition: functions.c:111
static void postquel_start(execution_state *es, SQLFunctionCachePtr fcache)
Definition: functions.c:783
void PopActiveSnapshot(void)
Definition: snapmgr.c:812
Tuplestorestate * tstore
Definition: functions.c:109
void(* callback)(void *arg)
Definition: elog.h:239
struct ErrorContextCallback * previous
Definition: elog.h:238
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:304
#define PG_GET_COLLATION()
Definition: fmgr.h:163
Snapshot snapshot
Definition: execdesc.h:39
ErrorContextCallback * error_context_stack
Definition: elog.c:88
#define VOIDOID
Definition: pg_type.h:690
#define ERROR
Definition: elog.h:43
static void sql_exec_error_callback(void *arg)
Definition: functions.c:1369
void tuplestore_clear(Tuplestorestate *state)
Definition: tuplestore.c:418
static void postquel_end(execution_state *es)
Definition: functions.c:879
void PushActiveSnapshot(Snapshot snap)
Definition: snapmgr.c:733
List * func_state
Definition: functions.c:119
LocalTransactionId lxid
Definition: functions.c:124
TupleDesc jf_cleanTupType
Definition: execnodes.h:334
static void ShutdownSQLFunction(Datum arg)
Definition: functions.c:1451
#define lnext(lc)
Definition: pg_list.h:105
#define ereport(elevel, rest)
Definition: elog.h:122
Tuplestorestate * tuplestore_begin_heap(bool randomAccess, bool interXact, int maxKBytes)
Definition: tuplestore.c:318
uintptr_t Datum
Definition: postgres.h:372
void CommandCounterIncrement(void)
Definition: xact.c:915
int work_mem
Definition: globals.c:113
QueryDesc * qd
Definition: functions.c:70
#define InvalidOid
Definition: postgres_ext.h:36
int allowedModes
Definition: execnodes.h:269
SetFunctionReturnMode returnMode
Definition: execnodes.h:271
static Datum postquel_get_single_result(TupleTableSlot *slot, FunctionCallInfo fcinfo, SQLFunctionCachePtr fcache, MemoryContext resultcontext)
Definition: functions.c:949
bool tuplestore_gettupleslot(Tuplestorestate *state, bool forward, bool copy, TupleTableSlot *slot)
Definition: tuplestore.c:1078
#define Assert(condition)
Definition: c.h:670
#define lfirst(lc)
Definition: pg_list.h:106
void RegisterExprContextCallback(ExprContext *econtext, ExprContextCallbackFunction function, Datum arg)
Definition: execUtils.c:819
Tuplestorestate * setResult
Definition: execnodes.h:274
ExprContext * econtext
Definition: execnodes.h:267
SQLFunctionCache * SQLFunctionCachePtr
Definition: functions.c:128
TupleDesc setDesc
Definition: execnodes.h:275
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define elog
Definition: elog.h:219
ExprDoneCond isDone
Definition: execnodes.h:272
SubTransactionId subxid
Definition: functions.c:125
struct execution_state * next
Definition: functions.c:65
static bool postquel_getnext(execution_state *es, SQLFunctionCachePtr fcache)
Definition: functions.c:845
Definition: pg_list.h:45
static void postquel_sub_params(SQLFunctionCachePtr fcache, FunctionCallInfo fcinfo)
Definition: functions.c:899
static void init_sql_fcache(FmgrInfo *finfo, Oid collation, bool lazyEvalOK)
Definition: functions.c:595
LocalTransactionId lxid
Definition: proc.h:106

◆ prepare_sql_fn_parse_info()

SQLFunctionParseInfoPtr prepare_sql_fn_parse_info ( HeapTuple  procedureTuple,
Node call_expr,
Oid  inputCollation 
)

Definition at line 184 of file functions.c.

References Anum_pg_proc_proargmodes, Anum_pg_proc_proargnames, SQLFunctionParseInfo::argnames, SQLFunctionParseInfo::argtypes, SQLFunctionParseInfo::collation, ereport, errcode(), errmsg(), ERROR, SQLFunctionParseInfo::fname, format_type_be(), get_call_expr_argtype(), get_func_input_arg_names(), GETSTRUCT, InvalidOid, IsPolymorphicType, NameStr, SQLFunctionParseInfo::nargs, palloc(), palloc0(), PointerGetDatum, PROCNAMEARGSNSP, pstrdup(), and SysCacheGetAttr().

Referenced by fmgr_sql_validator(), init_sql_fcache(), inline_function(), and inline_set_returning_function().

187 {
189  Form_pg_proc procedureStruct = (Form_pg_proc) GETSTRUCT(procedureTuple);
190  int nargs;
191 
193 
194  /* Function's name (only) can be used to qualify argument names */
195  pinfo->fname = pstrdup(NameStr(procedureStruct->proname));
196 
197  /* Save the function's input collation */
198  pinfo->collation = inputCollation;
199 
200  /*
201  * Copy input argument types from the pg_proc entry, then resolve any
202  * polymorphic types.
203  */
204  pinfo->nargs = nargs = procedureStruct->pronargs;
205  if (nargs > 0)
206  {
207  Oid *argOidVect;
208  int argnum;
209 
210  argOidVect = (Oid *) palloc(nargs * sizeof(Oid));
211  memcpy(argOidVect,
212  procedureStruct->proargtypes.values,
213  nargs * sizeof(Oid));
214 
215  for (argnum = 0; argnum < nargs; argnum++)
216  {
217  Oid argtype = argOidVect[argnum];
218 
219  if (IsPolymorphicType(argtype))
220  {
221  argtype = get_call_expr_argtype(call_expr, argnum);
222  if (argtype == InvalidOid)
223  ereport(ERROR,
224  (errcode(ERRCODE_DATATYPE_MISMATCH),
225  errmsg("could not determine actual type of argument declared %s",
226  format_type_be(argOidVect[argnum]))));
227  argOidVect[argnum] = argtype;
228  }
229  }
230 
231  pinfo->argtypes = argOidVect;
232  }
233 
234  /*
235  * Collect names of arguments, too, if any
236  */
237  if (nargs > 0)
238  {
239  Datum proargnames;
240  Datum proargmodes;
241  int n_arg_names;
242  bool isNull;
243 
244  proargnames = SysCacheGetAttr(PROCNAMEARGSNSP, procedureTuple,
246  &isNull);
247  if (isNull)
248  proargnames = PointerGetDatum(NULL); /* just to be sure */
249 
250  proargmodes = SysCacheGetAttr(PROCNAMEARGSNSP, procedureTuple,
252  &isNull);
253  if (isNull)
254  proargmodes = PointerGetDatum(NULL); /* just to be sure */
255 
256  n_arg_names = get_func_input_arg_names(proargnames, proargmodes,
257  &pinfo->argnames);
258 
259  /* Paranoia: ignore the result if too few array entries */
260  if (n_arg_names < nargs)
261  pinfo->argnames = NULL;
262  }
263  else
264  pinfo->argnames = NULL;
265 
266  return pinfo;
267 }
#define GETSTRUCT(TUP)
Definition: htup_details.h:661
#define PointerGetDatum(X)
Definition: postgres.h:562
char * pstrdup(const char *in)
Definition: mcxt.c:1076
struct SQLFunctionParseInfo * SQLFunctionParseInfoPtr
Definition: functions.h:21
int errcode(int sqlerrcode)
Definition: elog.c:575
Oid get_call_expr_argtype(Node *expr, int argnum)
Definition: fmgr.c:1923
char * format_type_be(Oid type_oid)
Definition: format_type.c:94
unsigned int Oid
Definition: postgres_ext.h:31
#define ERROR
Definition: elog.h:43
#define IsPolymorphicType(typid)
Definition: pg_type.h:745
#define Anum_pg_proc_proargmodes
Definition: pg_proc.h:111
#define ereport(elevel, rest)
Definition: elog.h:122
#define Anum_pg_proc_proargnames
Definition: pg_proc.h:112
int get_func_input_arg_names(Datum proargnames, Datum proargmodes, char ***arg_names)
Definition: funcapi.c:988
void * palloc0(Size size)
Definition: mcxt.c:877
uintptr_t Datum
Definition: postgres.h:372
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1368
FormData_pg_proc * Form_pg_proc
Definition: pg_proc.h:83
#define InvalidOid
Definition: postgres_ext.h:36
void * palloc(Size size)
Definition: mcxt.c:848
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define NameStr(name)
Definition: c.h:547

◆ sql_fn_parser_setup()

void sql_fn_parser_setup ( struct ParseState pstate,
SQLFunctionParseInfoPtr  pinfo 
)

Definition at line 273 of file functions.c.

References ParseState::p_paramref_hook, ParseState::p_post_columnref_hook, ParseState::p_pre_columnref_hook, ParseState::p_ref_hook_state, sql_fn_param_ref(), and sql_fn_post_column_ref().

Referenced by fmgr_sql_validator(), init_sql_fcache(), inline_function(), and inline_set_returning_function().

274 {
275  pstate->p_pre_columnref_hook = NULL;
278  /* no need to use p_coerce_param_hook */
279  pstate->p_ref_hook_state = (void *) pinfo;
280 }
PostParseColumnRefHook p_post_columnref_hook
Definition: parse_node.h:212
ParseParamRefHook p_paramref_hook
Definition: parse_node.h:213
static Node * sql_fn_post_column_ref(ParseState *pstate, ColumnRef *cref, Node *var)
Definition: functions.c:286
void * p_ref_hook_state
Definition: parse_node.h:215
static Node * sql_fn_param_ref(ParseState *pstate, ParamRef *pref)
Definition: functions.c:404
PreParseColumnRefHook p_pre_columnref_hook
Definition: parse_node.h:211