PostgreSQL Source Code  git master
functions.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * functions.c
4  * Execution of SQL-language functions
5  *
6  * Portions Copyright (c) 1996-2019, PostgreSQL Global Development Group
7  * Portions Copyright (c) 1994, Regents of the University of California
8  *
9  *
10  * IDENTIFICATION
11  * src/backend/executor/functions.c
12  *
13  *-------------------------------------------------------------------------
14  */
15 #include "postgres.h"
16 
17 #include "access/htup_details.h"
18 #include "access/xact.h"
19 #include "catalog/pg_proc.h"
20 #include "catalog/pg_type.h"
21 #include "executor/functions.h"
22 #include "funcapi.h"
23 #include "miscadmin.h"
24 #include "nodes/makefuncs.h"
25 #include "nodes/nodeFuncs.h"
26 #include "parser/parse_coerce.h"
27 #include "parser/parse_func.h"
28 #include "storage/proc.h"
29 #include "tcop/utility.h"
30 #include "utils/builtins.h"
31 #include "utils/datum.h"
32 #include "utils/lsyscache.h"
33 #include "utils/memutils.h"
34 #include "utils/snapmgr.h"
35 #include "utils/syscache.h"
36 
37 
38 /*
39  * Specialized DestReceiver for collecting query output in a SQL function
40  */
41 typedef struct
42 {
43  DestReceiver pub; /* publicly-known function pointers */
44  Tuplestorestate *tstore; /* where to put result tuples */
45  MemoryContext cxt; /* context containing tstore */
46  JunkFilter *filter; /* filter to convert tuple type */
48 
49 /*
50  * We have an execution_state record for each query in a function. Each
51  * record contains a plantree for its query. If the query is currently in
52  * F_EXEC_RUN state then there's a QueryDesc too.
53  *
54  * The "next" fields chain together all the execution_state records generated
55  * from a single original parsetree. (There will only be more than one in
56  * case of rule expansion of the original parsetree.)
57  */
58 typedef enum
59 {
61 } ExecStatus;
62 
63 typedef struct execution_state
64 {
67  bool setsResult; /* true if this query produces func's result */
68  bool lazyEval; /* true if should fetch one row at a time */
69  PlannedStmt *stmt; /* plan for this query */
70  QueryDesc *qd; /* null unless status == RUN */
72 
73 
74 /*
75  * An SQLFunctionCache record is built during the first call,
76  * and linked to from the fn_extra field of the FmgrInfo struct.
77  *
78  * Note that currently this has only the lifespan of the calling query.
79  * Someday we should rewrite this code to use plancache.c to save parse/plan
80  * results for longer than that.
81  *
82  * Physically, though, the data has the lifespan of the FmgrInfo that's used
83  * to call the function, and there are cases (particularly with indexes)
84  * where the FmgrInfo might survive across transactions. We cannot assume
85  * that the parse/plan trees are good for longer than the (sub)transaction in
86  * which parsing was done, so we must mark the record with the LXID/subxid of
87  * its creation time, and regenerate everything if that's obsolete. To avoid
88  * memory leakage when we do have to regenerate things, all the data is kept
89  * in a sub-context of the FmgrInfo's fn_mcxt.
90  */
91 typedef struct
92 {
93  char *fname; /* function name (for error msgs) */
94  char *src; /* function body text (for error msgs) */
95 
96  SQLFunctionParseInfoPtr pinfo; /* data for parser callback hooks */
97 
98  Oid rettype; /* actual return type */
99  int16 typlen; /* length of the return type */
100  bool typbyval; /* true if return type is pass by value */
101  bool returnsSet; /* true if returning multiple rows */
102  bool returnsTuple; /* true if returning whole tuple result */
103  bool shutdown_reg; /* true if registered shutdown callback */
104  bool readonly_func; /* true to run in "read only" mode */
105  bool lazyEval; /* true if using lazyEval for result query */
106 
107  ParamListInfo paramLI; /* Param list representing current args */
108 
109  Tuplestorestate *tstore; /* where we accumulate result tuples */
110 
111  JunkFilter *junkFilter; /* will be NULL if function returns VOID */
112 
113  /*
114  * func_state is a List of execution_state records, each of which is the
115  * first for its original parsetree, with any additional records chained
116  * to it via the "next" fields. This sublist structure is needed to keep
117  * track of where the original query boundaries are.
118  */
120 
121  MemoryContext fcontext; /* memory context holding this struct and all
122  * subsidiary data */
123 
124  LocalTransactionId lxid; /* lxid in which cache was made */
125  SubTransactionId subxid; /* subxid in which cache was made */
127 
129 
130 /*
131  * Data structure needed by the parser callback hooks to resolve parameter
132  * references during parsing of a SQL function's body. This is separate from
133  * SQLFunctionCache since we sometimes do parsing separately from execution.
134  */
135 typedef struct SQLFunctionParseInfo
136 {
137  char *fname; /* function's name */
138  int nargs; /* number of input arguments */
139  Oid *argtypes; /* resolved types of input arguments */
140  char **argnames; /* names of input arguments; NULL if none */
141  /* Note that argnames[i] can be NULL, if some args are unnamed */
142  Oid collation; /* function's input collation, if known */
144 
145 
146 /* non-export function prototypes */
147 static Node *sql_fn_param_ref(ParseState *pstate, ParamRef *pref);
148 static Node *sql_fn_post_column_ref(ParseState *pstate,
149  ColumnRef *cref, Node *var);
151  int paramno, int location);
153  const char *paramname, int location);
154 static List *init_execution_state(List *queryTree_list,
155  SQLFunctionCachePtr fcache,
156  bool lazyEvalOK);
157 static void init_sql_fcache(FmgrInfo *finfo, Oid collation, bool lazyEvalOK);
158 static void postquel_start(execution_state *es, SQLFunctionCachePtr fcache);
159 static bool postquel_getnext(execution_state *es, SQLFunctionCachePtr fcache);
160 static void postquel_end(execution_state *es);
161 static void postquel_sub_params(SQLFunctionCachePtr fcache,
162  FunctionCallInfo fcinfo);
164  FunctionCallInfo fcinfo,
165  SQLFunctionCachePtr fcache,
166  MemoryContext resultcontext);
167 static void sql_exec_error_callback(void *arg);
168 static void ShutdownSQLFunction(Datum arg);
169 static void sqlfunction_startup(DestReceiver *self, int operation, TupleDesc typeinfo);
170 static bool sqlfunction_receive(TupleTableSlot *slot, DestReceiver *self);
171 static void sqlfunction_shutdown(DestReceiver *self);
172 static void sqlfunction_destroy(DestReceiver *self);
173 
174 
175 /*
176  * Prepare the SQLFunctionParseInfo struct for parsing a SQL function body
177  *
178  * This includes resolving actual types of polymorphic arguments.
179  *
180  * call_expr can be passed as NULL, but then we will fail if there are any
181  * polymorphic arguments.
182  */
185  Node *call_expr,
186  Oid inputCollation)
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,
245  Anum_pg_proc_proargnames,
246  &isNull);
247  if (isNull)
248  proargnames = PointerGetDatum(NULL); /* just to be sure */
249 
250  proargmodes = SysCacheGetAttr(PROCNAMEARGSNSP, procedureTuple,
251  Anum_pg_proc_proargmodes,
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 }
268 
269 /*
270  * Parser setup hook for parsing a SQL function body.
271  */
272 void
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 }
281 
282 /*
283  * sql_fn_post_column_ref parser callback for ColumnRefs
284  */
285 static Node *
287 {
289  int nnames;
290  Node *field1;
291  Node *subfield = NULL;
292  const char *name1;
293  const char *name2 = NULL;
294  Node *param;
295 
296  /*
297  * Never override a table-column reference. This corresponds to
298  * considering the parameter names to appear in a scope outside the
299  * individual SQL commands, which is what we want.
300  */
301  if (var != NULL)
302  return NULL;
303 
304  /*----------
305  * The allowed syntaxes are:
306  *
307  * A A = parameter name
308  * A.B A = function name, B = parameter name
309  * OR: A = record-typed parameter name, B = field name
310  * (the first possibility takes precedence)
311  * A.B.C A = function name, B = record-typed parameter name,
312  * C = field name
313  * A.* Whole-row reference to composite parameter A.
314  * A.B.* Same, with A = function name, B = parameter name
315  *
316  * Here, it's sufficient to ignore the "*" in the last two cases --- the
317  * main parser will take care of expanding the whole-row reference.
318  *----------
319  */
320  nnames = list_length(cref->fields);
321 
322  if (nnames > 3)
323  return NULL;
324 
325  if (IsA(llast(cref->fields), A_Star))
326  nnames--;
327 
328  field1 = (Node *) linitial(cref->fields);
329  Assert(IsA(field1, String));
330  name1 = strVal(field1);
331  if (nnames > 1)
332  {
333  subfield = (Node *) lsecond(cref->fields);
334  Assert(IsA(subfield, String));
335  name2 = strVal(subfield);
336  }
337 
338  if (nnames == 3)
339  {
340  /*
341  * Three-part name: if the first part doesn't match the function name,
342  * we can fail immediately. Otherwise, look up the second part, and
343  * take the third part to be a field reference.
344  */
345  if (strcmp(name1, pinfo->fname) != 0)
346  return NULL;
347 
348  param = sql_fn_resolve_param_name(pinfo, name2, cref->location);
349 
350  subfield = (Node *) lthird(cref->fields);
351  Assert(IsA(subfield, String));
352  }
353  else if (nnames == 2 && strcmp(name1, pinfo->fname) == 0)
354  {
355  /*
356  * Two-part name with first part matching function name: first see if
357  * second part matches any parameter name.
358  */
359  param = sql_fn_resolve_param_name(pinfo, name2, cref->location);
360 
361  if (param)
362  {
363  /* Yes, so this is a parameter reference, no subfield */
364  subfield = NULL;
365  }
366  else
367  {
368  /* No, so try to match as parameter name and subfield */
369  param = sql_fn_resolve_param_name(pinfo, name1, cref->location);
370  }
371  }
372  else
373  {
374  /* Single name, or parameter name followed by subfield */
375  param = sql_fn_resolve_param_name(pinfo, name1, cref->location);
376  }
377 
378  if (!param)
379  return NULL; /* No match */
380 
381  if (subfield)
382  {
383  /*
384  * Must be a reference to a field of a composite parameter; otherwise
385  * ParseFuncOrColumn will return NULL, and we'll fail back at the
386  * caller.
387  */
388  param = ParseFuncOrColumn(pstate,
389  list_make1(subfield),
390  list_make1(param),
391  pstate->p_last_srf,
392  NULL,
393  false,
394  cref->location);
395  }
396 
397  return param;
398 }
399 
400 /*
401  * sql_fn_param_ref parser callback for ParamRefs ($n symbols)
402  */
403 static Node *
405 {
407  int paramno = pref->number;
408 
409  /* Check parameter number is valid */
410  if (paramno <= 0 || paramno > pinfo->nargs)
411  return NULL; /* unknown parameter number */
412 
413  return sql_fn_make_param(pinfo, paramno, pref->location);
414 }
415 
416 /*
417  * sql_fn_make_param construct a Param node for the given paramno
418  */
419 static Node *
421  int paramno, int location)
422 {
423  Param *param;
424 
425  param = makeNode(Param);
426  param->paramkind = PARAM_EXTERN;
427  param->paramid = paramno;
428  param->paramtype = pinfo->argtypes[paramno - 1];
429  param->paramtypmod = -1;
430  param->paramcollid = get_typcollation(param->paramtype);
431  param->location = location;
432 
433  /*
434  * If we have a function input collation, allow it to override the
435  * type-derived collation for parameter symbols. (XXX perhaps this should
436  * not happen if the type collation is not default?)
437  */
438  if (OidIsValid(pinfo->collation) && OidIsValid(param->paramcollid))
439  param->paramcollid = pinfo->collation;
440 
441  return (Node *) param;
442 }
443 
444 /*
445  * Search for a function parameter of the given name; if there is one,
446  * construct and return a Param node for it. If not, return NULL.
447  * Helper function for sql_fn_post_column_ref.
448  */
449 static Node *
451  const char *paramname, int location)
452 {
453  int i;
454 
455  if (pinfo->argnames == NULL)
456  return NULL;
457 
458  for (i = 0; i < pinfo->nargs; i++)
459  {
460  if (pinfo->argnames[i] && strcmp(pinfo->argnames[i], paramname) == 0)
461  return sql_fn_make_param(pinfo, i + 1, location);
462  }
463 
464  return NULL;
465 }
466 
467 /*
468  * Set up the per-query execution_state records for a SQL function.
469  *
470  * The input is a List of Lists of parsed and rewritten, but not planned,
471  * querytrees. The sublist structure denotes the original query boundaries.
472  */
473 static List *
474 init_execution_state(List *queryTree_list,
475  SQLFunctionCachePtr fcache,
476  bool lazyEvalOK)
477 {
478  List *eslist = NIL;
479  execution_state *lasttages = NULL;
480  ListCell *lc1;
481 
482  foreach(lc1, queryTree_list)
483  {
484  List *qtlist = lfirst_node(List, lc1);
485  execution_state *firstes = NULL;
486  execution_state *preves = NULL;
487  ListCell *lc2;
488 
489  foreach(lc2, qtlist)
490  {
491  Query *queryTree = lfirst_node(Query, lc2);
492  PlannedStmt *stmt;
493  execution_state *newes;
494 
495  /* Plan the query if needed */
496  if (queryTree->commandType == CMD_UTILITY)
497  {
498  /* Utility commands require no planning. */
499  stmt = makeNode(PlannedStmt);
500  stmt->commandType = CMD_UTILITY;
501  stmt->canSetTag = queryTree->canSetTag;
502  stmt->utilityStmt = queryTree->utilityStmt;
503  stmt->stmt_location = queryTree->stmt_location;
504  stmt->stmt_len = queryTree->stmt_len;
505  }
506  else
507  stmt = pg_plan_query(queryTree,
509  NULL);
510 
511  /*
512  * Precheck all commands for validity in a function. This should
513  * generally match the restrictions spi.c applies.
514  */
515  if (stmt->commandType == CMD_UTILITY)
516  {
517  if (IsA(stmt->utilityStmt, CopyStmt) &&
518  ((CopyStmt *) stmt->utilityStmt)->filename == NULL)
519  ereport(ERROR,
520  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
521  errmsg("cannot COPY to/from client in a SQL function")));
522 
523  if (IsA(stmt->utilityStmt, TransactionStmt))
524  ereport(ERROR,
525  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
526  /* translator: %s is a SQL statement name */
527  errmsg("%s is not allowed in a SQL function",
528  CreateCommandTag(stmt->utilityStmt))));
529  }
530 
531  if (fcache->readonly_func && !CommandIsReadOnly(stmt))
532  ereport(ERROR,
533  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
534  /* translator: %s is a SQL statement name */
535  errmsg("%s is not allowed in a non-volatile function",
536  CreateCommandTag((Node *) stmt))));
537 
538  if (IsInParallelMode() && !CommandIsReadOnly(stmt))
540 
541  /* OK, build the execution_state for this query */
542  newes = (execution_state *) palloc(sizeof(execution_state));
543  if (preves)
544  preves->next = newes;
545  else
546  firstes = newes;
547 
548  newes->next = NULL;
549  newes->status = F_EXEC_START;
550  newes->setsResult = false; /* might change below */
551  newes->lazyEval = false; /* might change below */
552  newes->stmt = stmt;
553  newes->qd = NULL;
554 
555  if (queryTree->canSetTag)
556  lasttages = newes;
557 
558  preves = newes;
559  }
560 
561  eslist = lappend(eslist, firstes);
562  }
563 
564  /*
565  * Mark the last canSetTag query as delivering the function result; then,
566  * if it is a plain SELECT, mark it for lazy evaluation. If it's not a
567  * SELECT we must always run it to completion.
568  *
569  * Note: at some point we might add additional criteria for whether to use
570  * lazy eval. However, we should prefer to use it whenever the function
571  * doesn't return set, since fetching more than one row is useless in that
572  * case.
573  *
574  * Note: don't set setsResult if the function returns VOID, as evidenced
575  * by not having made a junkfilter. This ensures we'll throw away any
576  * output from the last statement in such a function.
577  */
578  if (lasttages && fcache->junkFilter)
579  {
580  lasttages->setsResult = true;
581  if (lazyEvalOK &&
582  lasttages->stmt->commandType == CMD_SELECT &&
583  !lasttages->stmt->hasModifyingCTE)
584  fcache->lazyEval = lasttages->lazyEval = true;
585  }
586 
587  return eslist;
588 }
589 
590 /*
591  * Initialize the SQLFunctionCache for a SQL function
592  */
593 static void
594 init_sql_fcache(FmgrInfo *finfo, Oid collation, bool lazyEvalOK)
595 {
596  Oid foid = finfo->fn_oid;
597  MemoryContext fcontext;
598  MemoryContext oldcontext;
599  Oid rettype;
600  HeapTuple procedureTuple;
601  Form_pg_proc procedureStruct;
602  SQLFunctionCachePtr fcache;
603  List *raw_parsetree_list;
604  List *queryTree_list;
605  List *flat_query_list;
606  ListCell *lc;
607  Datum tmp;
608  bool isNull;
609 
610  /*
611  * Create memory context that holds all the SQLFunctionCache data. It
612  * must be a child of whatever context holds the FmgrInfo.
613  */
614  fcontext = AllocSetContextCreate(finfo->fn_mcxt,
615  "SQL function",
617 
618  oldcontext = MemoryContextSwitchTo(fcontext);
619 
620  /*
621  * Create the struct proper, link it to fcontext and fn_extra. Once this
622  * is done, we'll be able to recover the memory after failure, even if the
623  * FmgrInfo is long-lived.
624  */
625  fcache = (SQLFunctionCachePtr) palloc0(sizeof(SQLFunctionCache));
626  fcache->fcontext = fcontext;
627  finfo->fn_extra = (void *) fcache;
628 
629  /*
630  * get the procedure tuple corresponding to the given function Oid
631  */
632  procedureTuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(foid));
633  if (!HeapTupleIsValid(procedureTuple))
634  elog(ERROR, "cache lookup failed for function %u", foid);
635  procedureStruct = (Form_pg_proc) GETSTRUCT(procedureTuple);
636 
637  /*
638  * copy function name immediately for use by error reporting callback, and
639  * for use as memory context identifier
640  */
641  fcache->fname = pstrdup(NameStr(procedureStruct->proname));
642  MemoryContextSetIdentifier(fcontext, fcache->fname);
643 
644  /*
645  * get the result type from the procedure tuple, and check for polymorphic
646  * result type; if so, find out the actual result type.
647  */
648  rettype = procedureStruct->prorettype;
649 
650  if (IsPolymorphicType(rettype))
651  {
652  rettype = get_fn_expr_rettype(finfo);
653  if (rettype == InvalidOid) /* this probably should not happen */
654  ereport(ERROR,
655  (errcode(ERRCODE_DATATYPE_MISMATCH),
656  errmsg("could not determine actual result type for function declared to return type %s",
657  format_type_be(procedureStruct->prorettype))));
658  }
659 
660  fcache->rettype = rettype;
661 
662  /* Fetch the typlen and byval info for the result type */
663  get_typlenbyval(rettype, &fcache->typlen, &fcache->typbyval);
664 
665  /* Remember whether we're returning setof something */
666  fcache->returnsSet = procedureStruct->proretset;
667 
668  /* Remember if function is STABLE/IMMUTABLE */
669  fcache->readonly_func =
670  (procedureStruct->provolatile != PROVOLATILE_VOLATILE);
671 
672  /*
673  * We need the actual argument types to pass to the parser. Also make
674  * sure that parameter symbols are considered to have the function's
675  * resolved input collation.
676  */
677  fcache->pinfo = prepare_sql_fn_parse_info(procedureTuple,
678  finfo->fn_expr,
679  collation);
680 
681  /*
682  * And of course we need the function body text.
683  */
684  tmp = SysCacheGetAttr(PROCOID,
685  procedureTuple,
686  Anum_pg_proc_prosrc,
687  &isNull);
688  if (isNull)
689  elog(ERROR, "null prosrc for function %u", foid);
690  fcache->src = TextDatumGetCString(tmp);
691 
692  /*
693  * Parse and rewrite the queries in the function text. Use sublists to
694  * keep track of the original query boundaries. But we also build a
695  * "flat" list of the rewritten queries to pass to check_sql_fn_retval.
696  * This is because the last canSetTag query determines the result type
697  * independently of query boundaries --- and it might not be in the last
698  * sublist, for example if the last query rewrites to DO INSTEAD NOTHING.
699  * (It might not be unreasonable to throw an error in such a case, but
700  * this is the historical behavior and it doesn't seem worth changing.)
701  *
702  * Note: since parsing and planning is done in fcontext, we will generate
703  * a lot of cruft that lives as long as the fcache does. This is annoying
704  * but we'll not worry about it until the module is rewritten to use
705  * plancache.c.
706  */
707  raw_parsetree_list = pg_parse_query(fcache->src);
708 
709  queryTree_list = NIL;
710  flat_query_list = NIL;
711  foreach(lc, raw_parsetree_list)
712  {
713  RawStmt *parsetree = lfirst_node(RawStmt, lc);
714  List *queryTree_sublist;
715 
716  queryTree_sublist = pg_analyze_and_rewrite_params(parsetree,
717  fcache->src,
719  fcache->pinfo,
720  NULL);
721  queryTree_list = lappend(queryTree_list, queryTree_sublist);
722  flat_query_list = list_concat(flat_query_list, queryTree_sublist);
723  }
724 
725  check_sql_fn_statements(flat_query_list);
726 
727  /*
728  * Check that the function returns the type it claims to. Although in
729  * simple cases this was already done when the function was defined, we
730  * have to recheck because database objects used in the function's queries
731  * might have changed type. We'd have to do it anyway if the function had
732  * any polymorphic arguments.
733  *
734  * Note: we set fcache->returnsTuple according to whether we are returning
735  * the whole tuple result or just a single column. In the latter case we
736  * clear returnsTuple because we need not act different from the scalar
737  * result case, even if it's a rowtype column. (However, we have to force
738  * lazy eval mode in that case; otherwise we'd need extra code to expand
739  * the rowtype column into multiple columns, since we have no way to
740  * notify the caller that it should do that.)
741  *
742  * check_sql_fn_retval will also construct a JunkFilter we can use to
743  * coerce the returned rowtype to the desired form (unless the result type
744  * is VOID, in which case there's nothing to coerce to).
745  */
746  fcache->returnsTuple = check_sql_fn_retval(foid,
747  rettype,
748  flat_query_list,
749  NULL,
750  &fcache->junkFilter);
751 
752  if (fcache->returnsTuple)
753  {
754  /* Make sure output rowtype is properly blessed */
756  }
757  else if (fcache->returnsSet && type_is_rowtype(fcache->rettype))
758  {
759  /*
760  * Returning rowtype as if it were scalar --- materialize won't work.
761  * Right now it's sufficient to override any caller preference for
762  * materialize mode, but to add more smarts in init_execution_state
763  * about this, we'd probably need a three-way flag instead of bool.
764  */
765  lazyEvalOK = true;
766  }
767 
768  /* Finally, plan the queries */
769  fcache->func_state = init_execution_state(queryTree_list,
770  fcache,
771  lazyEvalOK);
772 
773  /* Mark fcache with time of creation to show it's valid */
774  fcache->lxid = MyProc->lxid;
776 
777  ReleaseSysCache(procedureTuple);
778 
779  MemoryContextSwitchTo(oldcontext);
780 }
781 
782 /* Start up execution of one execution_state node */
783 static void
785 {
787 
788  Assert(es->qd == NULL);
789 
790  /* Caller should have ensured a suitable snapshot is active */
792 
793  /*
794  * If this query produces the function result, send its output to the
795  * tuplestore; else discard any output.
796  */
797  if (es->setsResult)
798  {
799  DR_sqlfunction *myState;
800 
802  /* pass down the needed info to the dest receiver routines */
803  myState = (DR_sqlfunction *) dest;
804  Assert(myState->pub.mydest == DestSQLFunction);
805  myState->tstore = fcache->tstore;
806  myState->cxt = CurrentMemoryContext;
807  myState->filter = fcache->junkFilter;
808  }
809  else
810  dest = None_Receiver;
811 
812  es->qd = CreateQueryDesc(es->stmt,
813  fcache->src,
816  dest,
817  fcache->paramLI,
818  es->qd ? es->qd->queryEnv : NULL,
819  0);
820 
821  /* Utility commands don't need Executor. */
822  if (es->qd->operation != CMD_UTILITY)
823  {
824  /*
825  * In lazyEval mode, do not let the executor set up an AfterTrigger
826  * context. This is necessary not just an optimization, because we
827  * mustn't exit from the function execution with a stacked
828  * AfterTrigger level still active. We are careful not to select
829  * lazyEval mode for any statement that could possibly queue triggers.
830  */
831  int eflags;
832 
833  if (es->lazyEval)
834  eflags = EXEC_FLAG_SKIP_TRIGGERS;
835  else
836  eflags = 0; /* default run-to-completion flags */
837  ExecutorStart(es->qd, eflags);
838  }
839 
840  es->status = F_EXEC_RUN;
841 }
842 
843 /* Run one execution_state; either to completion or to first result row */
844 /* Returns true if we ran to completion */
845 static bool
847 {
848  bool result;
849 
850  if (es->qd->operation == CMD_UTILITY)
851  {
853  fcache->src,
855  es->qd->params,
856  es->qd->queryEnv,
857  es->qd->dest,
858  NULL);
859  result = true; /* never stops early */
860  }
861  else
862  {
863  /* Run regular commands to completion unless lazyEval */
864  uint64 count = (es->lazyEval) ? 1 : 0;
865 
866  ExecutorRun(es->qd, ForwardScanDirection, count, !fcache->returnsSet || !es->lazyEval);
867 
868  /*
869  * If we requested run to completion OR there was no tuple returned,
870  * command must be complete.
871  */
872  result = (count == 0 || es->qd->estate->es_processed == 0);
873  }
874 
875  return result;
876 }
877 
878 /* Shut down execution of one execution_state node */
879 static void
881 {
882  /* mark status done to ensure we don't do ExecutorEnd twice */
883  es->status = F_EXEC_DONE;
884 
885  /* Utility commands don't need Executor. */
886  if (es->qd->operation != CMD_UTILITY)
887  {
888  ExecutorFinish(es->qd);
889  ExecutorEnd(es->qd);
890  }
891 
892  es->qd->dest->rDestroy(es->qd->dest);
893 
894  FreeQueryDesc(es->qd);
895  es->qd = NULL;
896 }
897 
898 /* Build ParamListInfo array representing current arguments */
899 static void
901  FunctionCallInfo fcinfo)
902 {
903  int nargs = fcinfo->nargs;
904 
905  if (nargs > 0)
906  {
907  ParamListInfo paramLI;
908 
909  if (fcache->paramLI == NULL)
910  {
911  paramLI = makeParamList(nargs);
912  fcache->paramLI = paramLI;
913  }
914  else
915  {
916  paramLI = fcache->paramLI;
917  Assert(paramLI->numParams == nargs);
918  }
919 
920  for (int i = 0; i < nargs; i++)
921  {
922  ParamExternData *prm = &paramLI->params[i];
923 
924  prm->value = fcinfo->args[i].value;
925  prm->isnull = fcinfo->args[i].isnull;
926  prm->pflags = 0;
927  prm->ptype = fcache->pinfo->argtypes[i];
928  }
929  }
930  else
931  fcache->paramLI = NULL;
932 }
933 
934 /*
935  * Extract the SQL function's value from a single result row. This is used
936  * both for scalar (non-set) functions and for each row of a lazy-eval set
937  * result.
938  */
939 static Datum
941  FunctionCallInfo fcinfo,
942  SQLFunctionCachePtr fcache,
943  MemoryContext resultcontext)
944 {
945  Datum value;
946  MemoryContext oldcontext;
947 
948  /*
949  * Set up to return the function value. For pass-by-reference datatypes,
950  * be sure to allocate the result in resultcontext, not the current memory
951  * context (which has query lifespan). We can't leave the data in the
952  * TupleTableSlot because we intend to clear the slot before returning.
953  */
954  oldcontext = MemoryContextSwitchTo(resultcontext);
955 
956  if (fcache->returnsTuple)
957  {
958  /* We must return the whole tuple as a Datum. */
959  fcinfo->isnull = false;
960  value = ExecFetchSlotHeapTupleDatum(slot);
961  }
962  else
963  {
964  /*
965  * Returning a scalar, which we have to extract from the first column
966  * of the SELECT result, and then copy into result context if needed.
967  */
968  value = slot_getattr(slot, 1, &(fcinfo->isnull));
969 
970  if (!fcinfo->isnull)
971  value = datumCopy(value, fcache->typbyval, fcache->typlen);
972  }
973 
974  MemoryContextSwitchTo(oldcontext);
975 
976  return value;
977 }
978 
979 /*
980  * fmgr_sql: function call manager for SQL functions
981  */
982 Datum
984 {
985  SQLFunctionCachePtr fcache;
986  ErrorContextCallback sqlerrcontext;
987  MemoryContext oldcontext;
988  bool randomAccess;
989  bool lazyEvalOK;
990  bool is_first;
991  bool pushed_snapshot;
992  execution_state *es;
993  TupleTableSlot *slot;
994  Datum result;
995  List *eslist;
996  ListCell *eslc;
997 
998  /*
999  * Setup error traceback support for ereport()
1000  */
1001  sqlerrcontext.callback = sql_exec_error_callback;
1002  sqlerrcontext.arg = fcinfo->flinfo;
1003  sqlerrcontext.previous = error_context_stack;
1004  error_context_stack = &sqlerrcontext;
1005 
1006  /* Check call context */
1007  if (fcinfo->flinfo->fn_retset)
1008  {
1009  ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
1010 
1011  /*
1012  * For simplicity, we require callers to support both set eval modes.
1013  * There are cases where we must use one or must use the other, and
1014  * it's not really worthwhile to postpone the check till we know. But
1015  * note we do not require caller to provide an expectedDesc.
1016  */
1017  if (!rsi || !IsA(rsi, ReturnSetInfo) ||
1018  (rsi->allowedModes & SFRM_ValuePerCall) == 0 ||
1019  (rsi->allowedModes & SFRM_Materialize) == 0)
1020  ereport(ERROR,
1021  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1022  errmsg("set-valued function called in context that cannot accept a set")));
1023  randomAccess = rsi->allowedModes & SFRM_Materialize_Random;
1024  lazyEvalOK = !(rsi->allowedModes & SFRM_Materialize_Preferred);
1025  }
1026  else
1027  {
1028  randomAccess = false;
1029  lazyEvalOK = true;
1030  }
1031 
1032  /*
1033  * Initialize fcache (build plans) if first time through; or re-initialize
1034  * if the cache is stale.
1035  */
1036  fcache = (SQLFunctionCachePtr) fcinfo->flinfo->fn_extra;
1037 
1038  if (fcache != NULL)
1039  {
1040  if (fcache->lxid != MyProc->lxid ||
1041  !SubTransactionIsActive(fcache->subxid))
1042  {
1043  /* It's stale; unlink and delete */
1044  fcinfo->flinfo->fn_extra = NULL;
1045  MemoryContextDelete(fcache->fcontext);
1046  fcache = NULL;
1047  }
1048  }
1049 
1050  if (fcache == NULL)
1051  {
1052  init_sql_fcache(fcinfo->flinfo, PG_GET_COLLATION(), lazyEvalOK);
1053  fcache = (SQLFunctionCachePtr) fcinfo->flinfo->fn_extra;
1054  }
1055 
1056  /*
1057  * Switch to context in which the fcache lives. This ensures that our
1058  * tuplestore etc will have sufficient lifetime. The sub-executor is
1059  * responsible for deleting per-tuple information. (XXX in the case of a
1060  * long-lived FmgrInfo, this policy represents more memory leakage, but
1061  * it's not entirely clear where to keep stuff instead.)
1062  */
1063  oldcontext = MemoryContextSwitchTo(fcache->fcontext);
1064 
1065  /*
1066  * Find first unfinished query in function, and note whether it's the
1067  * first query.
1068  */
1069  eslist = fcache->func_state;
1070  es = NULL;
1071  is_first = true;
1072  foreach(eslc, eslist)
1073  {
1074  es = (execution_state *) lfirst(eslc);
1075 
1076  while (es && es->status == F_EXEC_DONE)
1077  {
1078  is_first = false;
1079  es = es->next;
1080  }
1081 
1082  if (es)
1083  break;
1084  }
1085 
1086  /*
1087  * Convert params to appropriate format if starting a fresh execution. (If
1088  * continuing execution, we can re-use prior params.)
1089  */
1090  if (is_first && es && es->status == F_EXEC_START)
1091  postquel_sub_params(fcache, fcinfo);
1092 
1093  /*
1094  * Build tuplestore to hold results, if we don't have one already. Note
1095  * it's in the query-lifespan context.
1096  */
1097  if (!fcache->tstore)
1098  fcache->tstore = tuplestore_begin_heap(randomAccess, false, work_mem);
1099 
1100  /*
1101  * Execute each command in the function one after another until we either
1102  * run out of commands or get a result row from a lazily-evaluated SELECT.
1103  *
1104  * Notes about snapshot management:
1105  *
1106  * In a read-only function, we just use the surrounding query's snapshot.
1107  *
1108  * In a non-read-only function, we rely on the fact that we'll never
1109  * suspend execution between queries of the function: the only reason to
1110  * suspend execution before completion is if we are returning a row from a
1111  * lazily-evaluated SELECT. So, when first entering this loop, we'll
1112  * either start a new query (and push a fresh snapshot) or re-establish
1113  * the active snapshot from the existing query descriptor. If we need to
1114  * start a new query in a subsequent execution of the loop, either we need
1115  * a fresh snapshot (and pushed_snapshot is false) or the existing
1116  * snapshot is on the active stack and we can just bump its command ID.
1117  */
1118  pushed_snapshot = false;
1119  while (es)
1120  {
1121  bool completed;
1122 
1123  if (es->status == F_EXEC_START)
1124  {
1125  /*
1126  * If not read-only, be sure to advance the command counter for
1127  * each command, so that all work to date in this transaction is
1128  * visible. Take a new snapshot if we don't have one yet,
1129  * otherwise just bump the command ID in the existing snapshot.
1130  */
1131  if (!fcache->readonly_func)
1132  {
1134  if (!pushed_snapshot)
1135  {
1137  pushed_snapshot = true;
1138  }
1139  else
1141  }
1142 
1143  postquel_start(es, fcache);
1144  }
1145  else if (!fcache->readonly_func && !pushed_snapshot)
1146  {
1147  /* Re-establish active snapshot when re-entering function */
1149  pushed_snapshot = true;
1150  }
1151 
1152  completed = postquel_getnext(es, fcache);
1153 
1154  /*
1155  * If we ran the command to completion, we can shut it down now. Any
1156  * row(s) we need to return are safely stashed in the tuplestore, and
1157  * we want to be sure that, for example, AFTER triggers get fired
1158  * before we return anything. Also, if the function doesn't return
1159  * set, we can shut it down anyway because it must be a SELECT and we
1160  * don't care about fetching any more result rows.
1161  */
1162  if (completed || !fcache->returnsSet)
1163  postquel_end(es);
1164 
1165  /*
1166  * Break from loop if we didn't shut down (implying we got a
1167  * lazily-evaluated row). Otherwise we'll press on till the whole
1168  * function is done, relying on the tuplestore to keep hold of the
1169  * data to eventually be returned. This is necessary since an
1170  * INSERT/UPDATE/DELETE RETURNING that sets the result might be
1171  * followed by additional rule-inserted commands, and we want to
1172  * finish doing all those commands before we return anything.
1173  */
1174  if (es->status != F_EXEC_DONE)
1175  break;
1176 
1177  /*
1178  * Advance to next execution_state, which might be in the next list.
1179  */
1180  es = es->next;
1181  while (!es)
1182  {
1183  eslc = lnext(eslist, eslc);
1184  if (!eslc)
1185  break; /* end of function */
1186 
1187  es = (execution_state *) lfirst(eslc);
1188 
1189  /*
1190  * Flush the current snapshot so that we will take a new one for
1191  * the new query list. This ensures that new snaps are taken at
1192  * original-query boundaries, matching the behavior of interactive
1193  * execution.
1194  */
1195  if (pushed_snapshot)
1196  {
1198  pushed_snapshot = false;
1199  }
1200  }
1201  }
1202 
1203  /*
1204  * The tuplestore now contains whatever row(s) we are supposed to return.
1205  */
1206  if (fcache->returnsSet)
1207  {
1208  ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
1209 
1210  if (es)
1211  {
1212  /*
1213  * If we stopped short of being done, we must have a lazy-eval
1214  * row.
1215  */
1216  Assert(es->lazyEval);
1217  /* Re-use the junkfilter's output slot to fetch back the tuple */
1218  Assert(fcache->junkFilter);
1219  slot = fcache->junkFilter->jf_resultSlot;
1220  if (!tuplestore_gettupleslot(fcache->tstore, true, false, slot))
1221  elog(ERROR, "failed to fetch lazy-eval tuple");
1222  /* Extract the result as a datum, and copy out from the slot */
1223  result = postquel_get_single_result(slot, fcinfo,
1224  fcache, oldcontext);
1225  /* Clear the tuplestore, but keep it for next time */
1226  /* NB: this might delete the slot's content, but we don't care */
1227  tuplestore_clear(fcache->tstore);
1228 
1229  /*
1230  * Let caller know we're not finished.
1231  */
1232  rsi->isDone = ExprMultipleResult;
1233 
1234  /*
1235  * Ensure we will get shut down cleanly if the exprcontext is not
1236  * run to completion.
1237  */
1238  if (!fcache->shutdown_reg)
1239  {
1242  PointerGetDatum(fcache));
1243  fcache->shutdown_reg = true;
1244  }
1245  }
1246  else if (fcache->lazyEval)
1247  {
1248  /*
1249  * We are done with a lazy evaluation. Clean up.
1250  */
1251  tuplestore_clear(fcache->tstore);
1252 
1253  /*
1254  * Let caller know we're finished.
1255  */
1256  rsi->isDone = ExprEndResult;
1257 
1258  fcinfo->isnull = true;
1259  result = (Datum) 0;
1260 
1261  /* Deregister shutdown callback, if we made one */
1262  if (fcache->shutdown_reg)
1263  {
1266  PointerGetDatum(fcache));
1267  fcache->shutdown_reg = false;
1268  }
1269  }
1270  else
1271  {
1272  /*
1273  * We are done with a non-lazy evaluation. Return whatever is in
1274  * the tuplestore. (It is now caller's responsibility to free the
1275  * tuplestore when done.)
1276  */
1278  rsi->setResult = fcache->tstore;
1279  fcache->tstore = NULL;
1280  /* must copy desc because execSRF.c will free it */
1281  if (fcache->junkFilter)
1283 
1284  fcinfo->isnull = true;
1285  result = (Datum) 0;
1286 
1287  /* Deregister shutdown callback, if we made one */
1288  if (fcache->shutdown_reg)
1289  {
1292  PointerGetDatum(fcache));
1293  fcache->shutdown_reg = false;
1294  }
1295  }
1296  }
1297  else
1298  {
1299  /*
1300  * Non-set function. If we got a row, return it; else return NULL.
1301  */
1302  if (fcache->junkFilter)
1303  {
1304  /* Re-use the junkfilter's output slot to fetch back the tuple */
1305  slot = fcache->junkFilter->jf_resultSlot;
1306  if (tuplestore_gettupleslot(fcache->tstore, true, false, slot))
1307  result = postquel_get_single_result(slot, fcinfo,
1308  fcache, oldcontext);
1309  else
1310  {
1311  fcinfo->isnull = true;
1312  result = (Datum) 0;
1313  }
1314  }
1315  else
1316  {
1317  /* Should only get here for VOID functions and procedures */
1318  Assert(fcache->rettype == VOIDOID);
1319  fcinfo->isnull = true;
1320  result = (Datum) 0;
1321  }
1322 
1323  /* Clear the tuplestore, but keep it for next time */
1324  tuplestore_clear(fcache->tstore);
1325  }
1326 
1327  /* Pop snapshot if we have pushed one */
1328  if (pushed_snapshot)
1330 
1331  /*
1332  * If we've gone through every command in the function, we are done. Reset
1333  * the execution states to start over again on next call.
1334  */
1335  if (es == NULL)
1336  {
1337  foreach(eslc, fcache->func_state)
1338  {
1339  es = (execution_state *) lfirst(eslc);
1340  while (es)
1341  {
1342  es->status = F_EXEC_START;
1343  es = es->next;
1344  }
1345  }
1346  }
1347 
1348  error_context_stack = sqlerrcontext.previous;
1349 
1350  MemoryContextSwitchTo(oldcontext);
1351 
1352  return result;
1353 }
1354 
1355 
1356 /*
1357  * error context callback to let us supply a call-stack traceback
1358  */
1359 static void
1361 {
1362  FmgrInfo *flinfo = (FmgrInfo *) arg;
1364  int syntaxerrposition;
1365 
1366  /*
1367  * We can do nothing useful if init_sql_fcache() didn't get as far as
1368  * saving the function name
1369  */
1370  if (fcache == NULL || fcache->fname == NULL)
1371  return;
1372 
1373  /*
1374  * If there is a syntax error position, convert to internal syntax error
1375  */
1376  syntaxerrposition = geterrposition();
1377  if (syntaxerrposition > 0 && fcache->src != NULL)
1378  {
1379  errposition(0);
1380  internalerrposition(syntaxerrposition);
1381  internalerrquery(fcache->src);
1382  }
1383 
1384  /*
1385  * Try to determine where in the function we failed. If there is a query
1386  * with non-null QueryDesc, finger it. (We check this rather than looking
1387  * for F_EXEC_RUN state, so that errors during ExecutorStart or
1388  * ExecutorEnd are blamed on the appropriate query; see postquel_start and
1389  * postquel_end.)
1390  */
1391  if (fcache->func_state)
1392  {
1393  execution_state *es;
1394  int query_num;
1395  ListCell *lc;
1396 
1397  es = NULL;
1398  query_num = 1;
1399  foreach(lc, fcache->func_state)
1400  {
1401  es = (execution_state *) lfirst(lc);
1402  while (es)
1403  {
1404  if (es->qd)
1405  {
1406  errcontext("SQL function \"%s\" statement %d",
1407  fcache->fname, query_num);
1408  break;
1409  }
1410  es = es->next;
1411  }
1412  if (es)
1413  break;
1414  query_num++;
1415  }
1416  if (es == NULL)
1417  {
1418  /*
1419  * couldn't identify a running query; might be function entry,
1420  * function exit, or between queries.
1421  */
1422  errcontext("SQL function \"%s\"", fcache->fname);
1423  }
1424  }
1425  else
1426  {
1427  /*
1428  * Assume we failed during init_sql_fcache(). (It's possible that the
1429  * function actually has an empty body, but in that case we may as
1430  * well report all errors as being "during startup".)
1431  */
1432  errcontext("SQL function \"%s\" during startup", fcache->fname);
1433  }
1434 }
1435 
1436 
1437 /*
1438  * callback function in case a function-returning-set needs to be shut down
1439  * before it has been run to completion
1440  */
1441 static void
1443 {
1445  execution_state *es;
1446  ListCell *lc;
1447 
1448  foreach(lc, fcache->func_state)
1449  {
1450  es = (execution_state *) lfirst(lc);
1451  while (es)
1452  {
1453  /* Shut down anything still running */
1454  if (es->status == F_EXEC_RUN)
1455  {
1456  /* Re-establish active snapshot for any called functions */
1457  if (!fcache->readonly_func)
1459 
1460  postquel_end(es);
1461 
1462  if (!fcache->readonly_func)
1464  }
1465 
1466  /* Reset states to START in case we're called again */
1467  es->status = F_EXEC_START;
1468  es = es->next;
1469  }
1470  }
1471 
1472  /* Release tuplestore if we have one */
1473  if (fcache->tstore)
1474  tuplestore_end(fcache->tstore);
1475  fcache->tstore = NULL;
1476 
1477  /* execUtils will deregister the callback... */
1478  fcache->shutdown_reg = false;
1479 }
1480 
1481 /*
1482  * check_sql_fn_statements
1483  *
1484  * Check statements in an SQL function. Error out if there is anything that
1485  * is not acceptable.
1486  */
1487 void
1489 {
1490  ListCell *lc;
1491 
1492  foreach(lc, queryTreeList)
1493  {
1494  Query *query = lfirst_node(Query, lc);
1495 
1496  /*
1497  * Disallow procedures with output arguments. The current
1498  * implementation would just throw the output values away, unless the
1499  * statement is the last one. Per SQL standard, we should assign the
1500  * output values by name. By disallowing this here, we preserve an
1501  * opportunity for future improvement.
1502  */
1503  if (query->commandType == CMD_UTILITY &&
1504  IsA(query->utilityStmt, CallStmt))
1505  {
1507  HeapTuple tuple;
1508  int numargs;
1509  Oid *argtypes;
1510  char **argnames;
1511  char *argmodes;
1512  int i;
1513 
1515  if (!HeapTupleIsValid(tuple))
1516  elog(ERROR, "cache lookup failed for function %u", stmt->funcexpr->funcid);
1517  numargs = get_func_arg_info(tuple, &argtypes, &argnames, &argmodes);
1518  ReleaseSysCache(tuple);
1519 
1520  for (i = 0; i < numargs; i++)
1521  {
1522  if (argmodes && (argmodes[i] == PROARGMODE_INOUT || argmodes[i] == PROARGMODE_OUT))
1523  ereport(ERROR,
1524  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1525  errmsg("calling procedures with output arguments is not supported in SQL functions")));
1526  }
1527  }
1528  }
1529 }
1530 
1531 /*
1532  * check_sql_fn_retval() -- check return value of a list of sql parse trees.
1533  *
1534  * The return value of a sql function is the value returned by the last
1535  * canSetTag query in the function. We do some ad-hoc type checking here
1536  * to be sure that the user is returning the type he claims. There are
1537  * also a couple of strange-looking features to assist callers in dealing
1538  * with allowed special cases, such as binary-compatible result types.
1539  *
1540  * For a polymorphic function the passed rettype must be the actual resolved
1541  * output type of the function; we should never see a polymorphic pseudotype
1542  * such as ANYELEMENT as rettype. (This means we can't check the type during
1543  * function definition of a polymorphic function.)
1544  *
1545  * This function returns true if the sql function returns the entire tuple
1546  * result of its final statement, or false if it returns just the first column
1547  * result of that statement. It throws an error if the final statement doesn't
1548  * return the right type at all.
1549  *
1550  * Note that because we allow "SELECT rowtype_expression", the result can be
1551  * false even when the declared function return type is a rowtype.
1552  *
1553  * If modifyTargetList isn't NULL, the function will modify the final
1554  * statement's targetlist in two cases:
1555  * (1) if the tlist returns values that are binary-coercible to the expected
1556  * type rather than being exactly the expected type. RelabelType nodes will
1557  * be inserted to make the result types match exactly.
1558  * (2) if there are dropped columns in the declared result rowtype. NULL
1559  * output columns will be inserted in the tlist to match them.
1560  * (Obviously the caller must pass a parsetree that is okay to modify when
1561  * using this flag.) Note that this flag does not affect whether the tlist is
1562  * considered to be a legal match to the result type, only how we react to
1563  * allowed not-exact-match cases. *modifyTargetList will be set true iff
1564  * we had to make any "dangerous" changes that could modify the semantics of
1565  * the statement. If it is set true, the caller should not use the modified
1566  * statement, but for simplicity we apply the changes anyway.
1567  *
1568  * If junkFilter isn't NULL, then *junkFilter is set to a JunkFilter defined
1569  * to convert the function's tuple result to the correct output tuple type.
1570  * Exception: if the function is defined to return VOID then *junkFilter is
1571  * set to NULL.
1572  */
1573 bool
1574 check_sql_fn_retval(Oid func_id, Oid rettype, List *queryTreeList,
1575  bool *modifyTargetList,
1576  JunkFilter **junkFilter)
1577 {
1578  Query *parse;
1579  List **tlist_ptr;
1580  List *tlist;
1581  int tlistlen;
1582  char fn_typtype;
1583  Oid restype;
1584  ListCell *lc;
1585 
1586  AssertArg(!IsPolymorphicType(rettype));
1587 
1588  if (modifyTargetList)
1589  *modifyTargetList = false; /* initialize for no change */
1590  if (junkFilter)
1591  *junkFilter = NULL; /* initialize in case of VOID result */
1592 
1593  /*
1594  * If it's declared to return VOID, we don't care what's in the function.
1595  * (This takes care of the procedure case, as well.)
1596  */
1597  if (rettype == VOIDOID)
1598  return false;
1599 
1600  /*
1601  * Find the last canSetTag query in the list. This isn't necessarily the
1602  * last parsetree, because rule rewriting can insert queries after what
1603  * the user wrote.
1604  */
1605  parse = NULL;
1606  foreach(lc, queryTreeList)
1607  {
1608  Query *q = lfirst_node(Query, lc);
1609 
1610  if (q->canSetTag)
1611  parse = q;
1612  }
1613 
1614  /*
1615  * If it's a plain SELECT, it returns whatever the targetlist says.
1616  * Otherwise, if it's INSERT/UPDATE/DELETE with RETURNING, it returns
1617  * that. Otherwise, the function return type must be VOID.
1618  *
1619  * Note: eventually replace this test with QueryReturnsTuples? We'd need
1620  * a more general method of determining the output type, though. Also, it
1621  * seems too dangerous to consider FETCH or EXECUTE as returning a
1622  * determinable rowtype, since they depend on relatively short-lived
1623  * entities.
1624  */
1625  if (parse &&
1626  parse->commandType == CMD_SELECT)
1627  {
1628  tlist_ptr = &parse->targetList;
1629  tlist = parse->targetList;
1630  }
1631  else if (parse &&
1632  (parse->commandType == CMD_INSERT ||
1633  parse->commandType == CMD_UPDATE ||
1634  parse->commandType == CMD_DELETE) &&
1635  parse->returningList)
1636  {
1637  tlist_ptr = &parse->returningList;
1638  tlist = parse->returningList;
1639  }
1640  else
1641  {
1642  /* Empty function body, or last statement is a utility command */
1643  ereport(ERROR,
1644  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1645  errmsg("return type mismatch in function declared to return %s",
1646  format_type_be(rettype)),
1647  errdetail("Function's final statement must be SELECT or INSERT/UPDATE/DELETE RETURNING.")));
1648  return false; /* keep compiler quiet */
1649  }
1650 
1651  /*
1652  * OK, check that the targetlist returns something matching the declared
1653  * type.
1654  */
1655 
1656  /*
1657  * Count the non-junk entries in the result targetlist.
1658  */
1659  tlistlen = ExecCleanTargetListLength(tlist);
1660 
1661  fn_typtype = get_typtype(rettype);
1662 
1663  if (fn_typtype == TYPTYPE_BASE ||
1664  fn_typtype == TYPTYPE_DOMAIN ||
1665  fn_typtype == TYPTYPE_ENUM ||
1666  fn_typtype == TYPTYPE_RANGE)
1667  {
1668  /*
1669  * For scalar-type returns, the target list must have exactly one
1670  * non-junk entry, and its type must agree with what the user
1671  * declared; except we allow binary-compatible types too.
1672  */
1673  TargetEntry *tle;
1674 
1675  if (tlistlen != 1)
1676  ereport(ERROR,
1677  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1678  errmsg("return type mismatch in function declared to return %s",
1679  format_type_be(rettype)),
1680  errdetail("Final statement must return exactly one column.")));
1681 
1682  /* We assume here that non-junk TLEs must come first in tlists */
1683  tle = (TargetEntry *) linitial(tlist);
1684  Assert(!tle->resjunk);
1685 
1686  restype = exprType((Node *) tle->expr);
1687  if (!IsBinaryCoercible(restype, rettype))
1688  ereport(ERROR,
1689  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1690  errmsg("return type mismatch in function declared to return %s",
1691  format_type_be(rettype)),
1692  errdetail("Actual return type is %s.",
1693  format_type_be(restype))));
1694  if (modifyTargetList && restype != rettype)
1695  {
1696  tle->expr = (Expr *) makeRelabelType(tle->expr,
1697  rettype,
1698  -1,
1699  get_typcollation(rettype),
1701  /* Relabel is dangerous if TLE is a sort/group or setop column */
1702  if (tle->ressortgroupref != 0 || parse->setOperations)
1703  *modifyTargetList = true;
1704  }
1705 
1706  /* Set up junk filter if needed */
1707  if (junkFilter)
1708  *junkFilter = ExecInitJunkFilter(tlist,
1710  }
1711  else if (fn_typtype == TYPTYPE_COMPOSITE || rettype == RECORDOID)
1712  {
1713  /*
1714  * Returns a rowtype.
1715  *
1716  * Note that we will not consider a domain over composite to be a
1717  * "rowtype" return type; it goes through the scalar case above. This
1718  * is because SQL functions don't provide any implicit casting to the
1719  * result type, so there is no way to produce a domain-over-composite
1720  * result except by computing it as an explicit single-column result.
1721  */
1722  TupleDesc tupdesc;
1723  int tupnatts; /* physical number of columns in tuple */
1724  int tuplogcols; /* # of nondeleted columns in tuple */
1725  int colindex; /* physical column index */
1726  List *newtlist; /* new non-junk tlist entries */
1727  List *junkattrs; /* new junk tlist entries */
1728 
1729  /*
1730  * If the target list is of length 1, and the type of the varnode in
1731  * the target list matches the declared return type, this is okay.
1732  * This can happen, for example, where the body of the function is
1733  * 'SELECT func2()', where func2 has the same composite return type as
1734  * the function that's calling it.
1735  *
1736  * XXX Note that if rettype is RECORD, the IsBinaryCoercible check
1737  * will succeed for any composite restype. For the moment we rely on
1738  * runtime type checking to catch any discrepancy, but it'd be nice to
1739  * do better at parse time.
1740  */
1741  if (tlistlen == 1)
1742  {
1743  TargetEntry *tle = (TargetEntry *) linitial(tlist);
1744 
1745  Assert(!tle->resjunk);
1746  restype = exprType((Node *) tle->expr);
1747  if (IsBinaryCoercible(restype, rettype))
1748  {
1749  if (modifyTargetList && restype != rettype)
1750  {
1751  tle->expr = (Expr *) makeRelabelType(tle->expr,
1752  rettype,
1753  -1,
1754  get_typcollation(rettype),
1756  /* Relabel is dangerous if sort/group or setop column */
1757  if (tle->ressortgroupref != 0 || parse->setOperations)
1758  *modifyTargetList = true;
1759  }
1760  /* Set up junk filter if needed */
1761  if (junkFilter)
1762  {
1763  TupleTableSlot *slot =
1765 
1766  *junkFilter = ExecInitJunkFilter(tlist, slot);
1767  }
1768  return false; /* NOT returning whole tuple */
1769  }
1770  }
1771 
1772  /*
1773  * Is the rowtype fixed, or determined only at runtime? (Note we
1774  * cannot see TYPEFUNC_COMPOSITE_DOMAIN here.)
1775  */
1776  if (get_func_result_type(func_id, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
1777  {
1778  /*
1779  * Assume we are returning the whole tuple. Crosschecking against
1780  * what the caller expects will happen at runtime.
1781  */
1782  if (junkFilter)
1783  {
1784  TupleTableSlot *slot;
1785 
1787  *junkFilter = ExecInitJunkFilter(tlist, slot);
1788  }
1789  return true;
1790  }
1791  Assert(tupdesc);
1792 
1793  /*
1794  * Verify that the targetlist matches the return tuple type. We scan
1795  * the non-deleted attributes to ensure that they match the datatypes
1796  * of the non-resjunk columns. For deleted attributes, insert NULL
1797  * result columns if the caller asked for that.
1798  */
1799  tupnatts = tupdesc->natts;
1800  tuplogcols = 0; /* we'll count nondeleted cols as we go */
1801  colindex = 0;
1802  newtlist = NIL; /* these are only used if modifyTargetList */
1803  junkattrs = NIL;
1804 
1805  foreach(lc, tlist)
1806  {
1807  TargetEntry *tle = (TargetEntry *) lfirst(lc);
1808  Form_pg_attribute attr;
1809  Oid tletype;
1810  Oid atttype;
1811 
1812  if (tle->resjunk)
1813  {
1814  if (modifyTargetList)
1815  junkattrs = lappend(junkattrs, tle);
1816  continue;
1817  }
1818 
1819  do
1820  {
1821  colindex++;
1822  if (colindex > tupnatts)
1823  ereport(ERROR,
1824  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1825  errmsg("return type mismatch in function declared to return %s",
1826  format_type_be(rettype)),
1827  errdetail("Final statement returns too many columns.")));
1828  attr = TupleDescAttr(tupdesc, colindex - 1);
1829  if (attr->attisdropped && modifyTargetList)
1830  {
1831  Expr *null_expr;
1832 
1833  /* The type of the null we insert isn't important */
1834  null_expr = (Expr *) makeConst(INT4OID,
1835  -1,
1836  InvalidOid,
1837  sizeof(int32),
1838  (Datum) 0,
1839  true, /* isnull */
1840  true /* byval */ );
1841  newtlist = lappend(newtlist,
1842  makeTargetEntry(null_expr,
1843  colindex,
1844  NULL,
1845  false));
1846  /* NULL insertion is dangerous in a setop */
1847  if (parse->setOperations)
1848  *modifyTargetList = true;
1849  }
1850  } while (attr->attisdropped);
1851  tuplogcols++;
1852 
1853  tletype = exprType((Node *) tle->expr);
1854  atttype = attr->atttypid;
1855  if (!IsBinaryCoercible(tletype, atttype))
1856  ereport(ERROR,
1857  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1858  errmsg("return type mismatch in function declared to return %s",
1859  format_type_be(rettype)),
1860  errdetail("Final statement returns %s instead of %s at column %d.",
1861  format_type_be(tletype),
1862  format_type_be(atttype),
1863  tuplogcols)));
1864  if (modifyTargetList)
1865  {
1866  if (tletype != atttype)
1867  {
1868  tle->expr = (Expr *) makeRelabelType(tle->expr,
1869  atttype,
1870  -1,
1871  get_typcollation(atttype),
1873  /* Relabel is dangerous if sort/group or setop column */
1874  if (tle->ressortgroupref != 0 || parse->setOperations)
1875  *modifyTargetList = true;
1876  }
1877  tle->resno = colindex;
1878  newtlist = lappend(newtlist, tle);
1879  }
1880  }
1881 
1882  /* remaining columns in tupdesc had better all be dropped */
1883  for (colindex++; colindex <= tupnatts; colindex++)
1884  {
1885  if (!TupleDescAttr(tupdesc, colindex - 1)->attisdropped)
1886  ereport(ERROR,
1887  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1888  errmsg("return type mismatch in function declared to return %s",
1889  format_type_be(rettype)),
1890  errdetail("Final statement returns too few columns.")));
1891  if (modifyTargetList)
1892  {
1893  Expr *null_expr;
1894 
1895  /* The type of the null we insert isn't important */
1896  null_expr = (Expr *) makeConst(INT4OID,
1897  -1,
1898  InvalidOid,
1899  sizeof(int32),
1900  (Datum) 0,
1901  true, /* isnull */
1902  true /* byval */ );
1903  newtlist = lappend(newtlist,
1904  makeTargetEntry(null_expr,
1905  colindex,
1906  NULL,
1907  false));
1908  /* NULL insertion is dangerous in a setop */
1909  if (parse->setOperations)
1910  *modifyTargetList = true;
1911  }
1912  }
1913 
1914  if (modifyTargetList)
1915  {
1916  /* ensure resjunk columns are numbered correctly */
1917  foreach(lc, junkattrs)
1918  {
1919  TargetEntry *tle = (TargetEntry *) lfirst(lc);
1920 
1921  tle->resno = colindex++;
1922  }
1923  /* replace the tlist with the modified one */
1924  *tlist_ptr = list_concat(newtlist, junkattrs);
1925  }
1926 
1927  /* Set up junk filter if needed */
1928  if (junkFilter)
1929  {
1930  TupleTableSlot *slot =
1932 
1933  *junkFilter = ExecInitJunkFilterConversion(tlist,
1934  CreateTupleDescCopy(tupdesc),
1935  slot);
1936  }
1937 
1938  /* Report that we are returning entire tuple result */
1939  return true;
1940  }
1941  else
1942  ereport(ERROR,
1943  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1944  errmsg("return type %s is not supported for SQL functions",
1945  format_type_be(rettype))));
1946 
1947  return false;
1948 }
1949 
1950 
1951 /*
1952  * CreateSQLFunctionDestReceiver -- create a suitable DestReceiver object
1953  */
1954 DestReceiver *
1956 {
1957  DR_sqlfunction *self = (DR_sqlfunction *) palloc0(sizeof(DR_sqlfunction));
1958 
1959  self->pub.receiveSlot = sqlfunction_receive;
1960  self->pub.rStartup = sqlfunction_startup;
1961  self->pub.rShutdown = sqlfunction_shutdown;
1962  self->pub.rDestroy = sqlfunction_destroy;
1963  self->pub.mydest = DestSQLFunction;
1964 
1965  /* private fields will be set by postquel_start */
1966 
1967  return (DestReceiver *) self;
1968 }
1969 
1970 /*
1971  * sqlfunction_startup --- executor startup
1972  */
1973 static void
1974 sqlfunction_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
1975 {
1976  /* no-op */
1977 }
1978 
1979 /*
1980  * sqlfunction_receive --- receive one tuple
1981  */
1982 static bool
1984 {
1985  DR_sqlfunction *myState = (DR_sqlfunction *) self;
1986 
1987  /* Filter tuple as needed */
1988  slot = ExecFilterJunk(myState->filter, slot);
1989 
1990  /* Store the filtered tuple into the tuplestore */
1991  tuplestore_puttupleslot(myState->tstore, slot);
1992 
1993  return true;
1994 }
1995 
1996 /*
1997  * sqlfunction_shutdown --- executor end
1998  */
1999 static void
2001 {
2002  /* no-op */
2003 }
2004 
2005 /*
2006  * sqlfunction_destroy --- release DestReceiver object
2007  */
2008 static void
2010 {
2011  pfree(self);
2012 }
bool SubTransactionIsActive(SubTransactionId subxid)
Definition: xact.c:721
signed short int16
Definition: c.h:346
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:124
void tuplestore_puttupleslot(Tuplestorestate *state, TupleTableSlot *slot)
Definition: tuplestore.c:708
#define NIL
Definition: pg_list.h:65
Datum value
Definition: params.h:92
bool CommandIsReadOnly(PlannedStmt *pstmt)
Definition: utility.c:99
Definition: fmgr.h:56
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:110
void UpdateActiveSnapshotCommandId(void)
Definition: snapmgr.c:783
#define IsA(nodeptr, _type_)
Definition: nodes.h:576
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
#define AllocSetContextCreate
Definition: memutils.h:170
int stmt_location
Definition: parsenodes.h:180
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
EState * estate
Definition: execdesc.h:48
MemoryContext fn_mcxt
Definition: fmgr.h:65
void PreventCommandIfParallelMode(const char *cmdname)
Definition: utility.c:256
FuncExpr * funcexpr
Definition: parsenodes.h:2875
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:321
TupleTableSlot * MakeSingleTupleTableSlot(TupleDesc tupdesc, const TupleTableSlotOps *tts_ops)
Definition: execTuples.c:1208
static void sqlfunction_destroy(DestReceiver *self)
Definition: functions.c:2009
MemoryContext fcontext
Definition: functions.c:121
#define castNode(_type_, nodeptr)
Definition: nodes.h:594
void FreeQueryDesc(QueryDesc *qdesc)
Definition: pquery.c:105
DestReceiver pub
Definition: functions.c:43
PGPROC * MyProc
Definition: proc.c:67
void UnregisterExprContextCallback(ExprContext *econtext, ExprContextCallbackFunction function, Datum arg)
Definition: execUtils.c:889
#define PointerGetDatum(X)
Definition: postgres.h:556
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
CommandDest mydest
Definition: dest.h:128
void check_sql_fn_statements(List *queryTreeList)
Definition: functions.c:1488
char * pstrdup(const char *in)
Definition: mcxt.c:1186
JunkFilter * ExecInitJunkFilterConversion(List *targetList, TupleDesc cleanTupType, TupleTableSlot *slot)
Definition: execJunk.c:135
void sql_fn_parser_setup(struct ParseState *pstate, SQLFunctionParseInfoPtr pinfo)
Definition: functions.c:273
struct SQLFunctionParseInfo * SQLFunctionParseInfoPtr
Definition: functions.h:21
void ExecutorStart(QueryDesc *queryDesc, int eflags)
Definition: execMain.c:143
#define llast(l)
Definition: pg_list.h:215
int get_func_arg_info(HeapTuple procTup, Oid **p_argtypes, char ***p_argnames, char **p_argmodes)
Definition: funcapi.c:863
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
Snapshot GetActiveSnapshot(void)
Definition: snapmgr.c:841
struct execution_state execution_state
static struct @145 value
ParamKind paramkind
Definition: primnodes.h:248
Definition: nodes.h:525
#define strVal(v)
Definition: value.h:54
ExecStatus status
Definition: functions.c:66
void ProcessUtility(PlannedStmt *pstmt, const char *queryString, ProcessUtilityContext context, ParamListInfo params, QueryEnvironment *queryEnv, DestReceiver *dest, char *completionTag)
Definition: utility.c:337
List * list_concat(List *list1, const List *list2)
Definition: list.c:516
int errcode(int sqlerrcode)
Definition: elog.c:608
TupleTableSlot * jf_resultSlot
Definition: execnodes.h:369
bool check_sql_fn_retval(Oid func_id, Oid rettype, List *queryTreeList, bool *modifyTargetList, JunkFilter **junkFilter)
Definition: functions.c:1574
char get_typtype(Oid typid)
Definition: lsyscache.c:2407
static void sqlfunction_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
Definition: functions.c:1974
JunkFilter * junkFilter
Definition: functions.c:111
Oid get_call_expr_argtype(Node *expr, int argnum)
Definition: fmgr.c:1821
char * format_type_be(Oid type_oid)
Definition: format_type.c:326
static void postquel_start(execution_state *es, SQLFunctionCachePtr fcache)
Definition: functions.c:784
static Node * sql_fn_resolve_param_name(SQLFunctionParseInfoPtr pinfo, const char *paramname, int location)
Definition: functions.c:450
void PopActiveSnapshot(void)
Definition: snapmgr.c:814
uint32 SubTransactionId
Definition: c.h:518
Tuplestorestate * tstore
Definition: functions.c:109
unsigned int Oid
Definition: postgres_ext.h:31
Node * utilityStmt
Definition: parsenodes.h:120
Const * makeConst(Oid consttype, int32 consttypmod, Oid constcollid, int constlen, Datum constvalue, bool constisnull, bool constbyval)
Definition: makefuncs.c:297
DestReceiver * None_Receiver
Definition: dest.c:96
ParamListInfo makeParamList(int numParams)
Definition: params.c:32
void(* callback)(void *arg)
Definition: elog.h:256
struct ErrorContextCallback * previous
Definition: elog.h:255
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:306
#define OidIsValid(objectId)
Definition: c.h:645
int stmt_len
Definition: plannodes.h:94
#define PG_GET_COLLATION()
Definition: fmgr.h:193
#define lsecond(l)
Definition: pg_list.h:200
PostParseColumnRefHook p_post_columnref_hook
Definition: parse_node.h:216
signed int int32
Definition: c.h:347
List * targetList
Definition: parsenodes.h:140
Snapshot snapshot
Definition: execdesc.h:39
int location
Definition: parsenodes.h:236
ErrorContextCallback * error_context_stack
Definition: elog.c:91
static bool sqlfunction_receive(TupleTableSlot *slot, DestReceiver *self)
Definition: functions.c:1983
#define list_make1(x1)
Definition: pg_list.h:227
void ExecutorEnd(QueryDesc *queryDesc)
Definition: execMain.c:462
QueryEnvironment * queryEnv
Definition: execdesc.h:43
void pfree(void *pointer)
Definition: mcxt.c:1056
bool IsInParallelMode(void)
Definition: xact.c:996
bool resjunk
Definition: primnodes.h:1400
#define linitial(l)
Definition: pg_list.h:195
Oid funcid
Definition: primnodes.h:455
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
static void sql_exec_error_callback(void *arg)
Definition: functions.c:1360
Oid paramcollid
Definition: primnodes.h:252
void ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count, bool execute_once)
Definition: execMain.c:301
Node * ParseFuncOrColumn(ParseState *pstate, List *funcname, List *fargs, Node *last_srf, FuncCall *fn, bool proc_call, int location)
Definition: parse_func.c:88
int location
Definition: primnodes.h:253
NullableDatum args[FLEXIBLE_ARRAY_MEMBER]
Definition: fmgr.h:95
List * pg_parse_query(const char *query_string)
Definition: postgres.c:627
QueryDesc * CreateQueryDesc(PlannedStmt *plannedstmt, const char *sourceText, Snapshot snapshot, Snapshot crosscheck_snapshot, DestReceiver *dest, ParamListInfo params, QueryEnvironment *queryEnv, int instrument_options)
Definition: pquery.c:67
void tuplestore_clear(Tuplestorestate *state)
Definition: tuplestore.c:418
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
#define lfirst_node(type, lc)
Definition: pg_list.h:193
TupleDesc BlessTupleDesc(TupleDesc tupdesc)
Definition: execTuples.c:2052
void(* ParserSetupHook)(struct ParseState *pstate, void *arg)
Definition: params.h:108
static void postquel_end(execution_state *es)
Definition: functions.c:880
int stmt_location
Definition: plannodes.h:93
ParseParamRefHook p_paramref_hook
Definition: parse_node.h:217
void PushActiveSnapshot(Snapshot snap)
Definition: snapmgr.c:735
List * func_state
Definition: functions.c:119
RelabelType * makeRelabelType(Expr *arg, Oid rtype, int32 rtypmod, Oid rcollid, CoercionForm rformat)
Definition: makefuncs.c:400
LocalTransactionId lxid
Definition: functions.c:124
TupleDesc jf_cleanTupType
Definition: execnodes.h:367
DestReceiver * CreateDestReceiver(CommandDest dest)
Definition: dest.c:113
int errdetail(const char *fmt,...)
Definition: elog.c:955
AttrNumber resno
Definition: primnodes.h:1394
ParamListInfo params
Definition: execdesc.h:42
Node * utilityStmt
Definition: plannodes.h:90
int geterrposition(void)
Definition: elog.c:1339
static Node * sql_fn_post_column_ref(ParseState *pstate, ColumnRef *cref, Node *var)
Definition: functions.c:286
static void ShutdownSQLFunction(Datum arg)
Definition: functions.c:1442
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:200
bool ActiveSnapshotSet(void)
Definition: snapmgr.c:853
static List * init_execution_state(List *queryTree_list, SQLFunctionCachePtr fcache, bool lazyEvalOK)
Definition: functions.c:474
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
uint32 LocalTransactionId
Definition: c.h:516
Datum fmgr_sql(PG_FUNCTION_ARGS)
Definition: functions.c:983
bool type_is_rowtype(Oid typid)
Definition: lsyscache.c:2433
List * returningList
Definition: parsenodes.h:146
#define ereport(elevel, rest)
Definition: elog.h:141
TargetEntry * makeTargetEntry(Expr *expr, AttrNumber resno, char *resname, bool resjunk)
Definition: makefuncs.c:236
Datum value
Definition: postgres.h:378
#define AssertArg(condition)
Definition: c.h:741
Datum datumCopy(Datum value, bool typByVal, int typLen)
Definition: datum.c:130
const char * CreateCommandTag(Node *parsetree)
Definition: utility.c:2093
void ExecutorFinish(QueryDesc *queryDesc)
Definition: execMain.c:402
SQLFunctionParseInfoPtr pinfo
Definition: functions.c:96
bool IsBinaryCoercible(Oid srctype, Oid targettype)
List * lappend(List *list, void *datum)
Definition: list.c:322
int ExecCleanTargetListLength(List *targetlist)
Definition: execUtils.c:1085
TypeFuncClass get_func_result_type(Oid functionId, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:289
DestReceiver * CreateSQLFunctionDestReceiver(void)
Definition: functions.c:1955
CmdType operation
Definition: execdesc.h:36
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1116
#define InvalidSnapshot
Definition: snapshot.h:123
TupleDesc tts_tupleDescriptor
Definition: tuptable.h:124
Tuplestorestate * tuplestore_begin_heap(bool randomAccess, bool interXact, int maxKBytes)
Definition: tuplestore.c:318
int get_func_input_arg_names(Datum proargnames, Datum proargmodes, char ***arg_names)
Definition: funcapi.c:1005
#define TextDatumGetCString(d)
Definition: builtins.h:84
bool canSetTag
Definition: plannodes.h:54
void * palloc0(Size size)
Definition: mcxt.c:980
ExecStatus
Definition: functions.c:58
Node * p_last_srf
Definition: parse_node.h:209
uintptr_t Datum
Definition: postgres.h:367
TupleTableSlot * ExecFilterJunk(JunkFilter *junkfilter, TupleTableSlot *slot)
Definition: execJunk.c:261
void CommandCounterIncrement(void)
Definition: xact.c:1005
CmdType commandType
Definition: plannodes.h:46
Oid get_fn_expr_rettype(FmgrInfo *flinfo)
Definition: fmgr.c:1780
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1164
static void sqlfunction_shutdown(DestReceiver *self)
Definition: functions.c:2000
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1377
int number
Definition: parsenodes.h:245
int work_mem
Definition: globals.c:121
FormData_pg_proc * Form_pg_proc
Definition: pg_proc.h:133
QueryDesc * qd
Definition: functions.c:70
#define InvalidOid
Definition: postgres_ext.h:36
static Datum slot_getattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: tuptable.h:381
Oid fn_oid
Definition: fmgr.h:59
Oid get_typcollation(Oid typid)
Definition: lsyscache.c:2823
int allowedModes
Definition: execnodes.h:302
int internalerrquery(const char *query)
Definition: elog.c:1243
CmdType commandType
Definition: parsenodes.h:112
void(* rDestroy)(DestReceiver *self)
Definition: dest.h:126
int32 paramtypmod
Definition: primnodes.h:251
int location
Definition: parsenodes.h:246
SetFunctionReturnMode returnMode
Definition: execnodes.h:304
static Datum postquel_get_single_result(TupleTableSlot *slot, FunctionCallInfo fcinfo, SQLFunctionCachePtr fcache, MemoryContext resultcontext)
Definition: functions.c:940
#define makeNode(_type_)
Definition: nodes.h:573
bool tuplestore_gettupleslot(Tuplestorestate *state, bool forward, bool copy, TupleTableSlot *slot)
Definition: tuplestore.c:1078
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:739
#define lfirst(lc)
Definition: pg_list.h:190
void RegisterExprContextCallback(ExprContext *econtext, ExprContextCallbackFunction function, Datum arg)
Definition: execUtils.c:863
void * p_ref_hook_state
Definition: parse_node.h:219
SubTransactionId GetCurrentSubTransactionId(void)
Definition: xact.c:707
fmNodePtr fn_expr
Definition: fmgr.h:66
bool hasModifyingCTE
Definition: plannodes.h:52
ParamListInfo paramLI
Definition: functions.c:107
Expr * expr
Definition: primnodes.h:1393
int paramid
Definition: primnodes.h:249
uint64 es_processed
Definition: execnodes.h:553
bool canSetTag
Definition: parsenodes.h:118
uint16 pflags
Definition: params.h:94
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:41
static int list_length(const List *l)
Definition: pg_list.h:169
void tuplestore_end(Tuplestorestate *state)
Definition: tuplestore.c:453
void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval)
Definition: lsyscache.c:2029
void MemoryContextSetIdentifier(MemoryContext context, const char *id)
Definition: mcxt.c:329
static Node * sql_fn_param_ref(ParseState *pstate, ParamRef *pref)
Definition: functions.c:404
MemoryContext cxt
Definition: functions.c:45
void * fn_extra
Definition: fmgr.h:64
List * pg_analyze_and_rewrite_params(RawStmt *parsetree, const char *query_string, ParserSetupHook parserSetup, void *parserSetupArg, QueryEnvironment *queryEnv)
Definition: postgres.c:712
#define EXEC_FLAG_SKIP_TRIGGERS
Definition: executor.h:60
Tuplestorestate * setResult
Definition: execnodes.h:307
#define DatumGetPointer(X)
Definition: postgres.h:549
DestReceiver * dest
Definition: execdesc.h:41
ExprContext * econtext
Definition: execnodes.h:300
Node * setOperations
Definition: parsenodes.h:165
JunkFilter * filter
Definition: functions.c:46
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:2692
SQLFunctionCache * SQLFunctionCachePtr
Definition: functions.c:128
TupleDesc setDesc
Definition: execnodes.h:308
void * palloc(Size size)
Definition: mcxt.c:949
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define elog(elevel,...)
Definition: elog.h:228
int i
#define errcontext
Definition: elog.h:183
#define NameStr(name)
Definition: c.h:616
Index ressortgroupref
Definition: primnodes.h:1396
void * arg
#define lthird(l)
Definition: pg_list.h:205
static Node * sql_fn_make_param(SQLFunctionParseInfoPtr pinfo, int paramno, int location)
Definition: functions.c:420
#define PG_FUNCTION_ARGS
Definition: fmgr.h:188
PreParseColumnRefHook p_pre_columnref_hook
Definition: parse_node.h:215
ExprDoneCond isDone
Definition: execnodes.h:305
SQLFunctionParseInfoPtr prepare_sql_fn_parse_info(HeapTuple procedureTuple, Node *call_expr, Oid inputCollation)
Definition: functions.c:184
SubTransactionId subxid
Definition: functions.c:125
PlannedStmt * plannedstmt
Definition: execdesc.h:37
struct execution_state * next
Definition: functions.c:65
PlannedStmt * stmt
Definition: functions.c:69
static bool postquel_getnext(execution_state *es, SQLFunctionCachePtr fcache)
Definition: functions.c:846
struct SQLFunctionParseInfo SQLFunctionParseInfo
Definition: pg_list.h:50
bool isnull
Definition: params.h:93
Datum ExecFetchSlotHeapTupleDatum(TupleTableSlot *slot)
Definition: execTuples.c:1693
int stmt_len
Definition: parsenodes.h:181
static void postquel_sub_params(SQLFunctionCachePtr fcache, FunctionCallInfo fcinfo)
Definition: functions.c:900
JunkFilter * ExecInitJunkFilter(List *targetList, TupleTableSlot *slot)
Definition: execJunk.c:60
Oid paramtype
Definition: primnodes.h:250
const TupleTableSlotOps TTSOpsMinimalTuple
Definition: execTuples.c:85
int errposition(int cursorpos)
Definition: elog.c:1207
List * fields
Definition: parsenodes.h:235
static void init_sql_fcache(FmgrInfo *finfo, Oid collation, bool lazyEvalOK)
Definition: functions.c:594
static struct subre * parse(struct vars *, int, int, struct state *, struct state *)
Definition: regcomp.c:648
LocalTransactionId lxid
Definition: proc.h:106
int internalerrposition(int cursorpos)
Definition: elog.c:1223
Tuplestorestate * tstore
Definition: functions.c:44
PlannedStmt * pg_plan_query(Query *querytree, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:856