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-2018, 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,
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 }
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 a utility statement that check_sql_fn_retval deemed to not
577  * have output.
578  */
579  if (lasttages && fcache->junkFilter)
580  {
581  lasttages->setsResult = true;
582  if (lazyEvalOK &&
583  lasttages->stmt->commandType == CMD_SELECT &&
584  !lasttages->stmt->hasModifyingCTE)
585  fcache->lazyEval = lasttages->lazyEval = true;
586  }
587 
588  return eslist;
589 }
590 
591 /*
592  * Initialize the SQLFunctionCache for a SQL function
593  */
594 static void
595 init_sql_fcache(FmgrInfo *finfo, Oid collation, bool lazyEvalOK)
596 {
597  Oid foid = finfo->fn_oid;
598  MemoryContext fcontext;
599  MemoryContext oldcontext;
600  Oid rettype;
601  HeapTuple procedureTuple;
602  Form_pg_proc procedureStruct;
603  SQLFunctionCachePtr fcache;
604  List *raw_parsetree_list;
605  List *queryTree_list;
606  List *flat_query_list;
607  ListCell *lc;
608  Datum tmp;
609  bool isNull;
610 
611  /*
612  * Create memory context that holds all the SQLFunctionCache data. It
613  * must be a child of whatever context holds the FmgrInfo.
614  */
615  fcontext = AllocSetContextCreate(finfo->fn_mcxt,
616  "SQL function data",
618 
619  oldcontext = MemoryContextSwitchTo(fcontext);
620 
621  /*
622  * Create the struct proper, link it to fcontext and fn_extra. Once this
623  * is done, we'll be able to recover the memory after failure, even if the
624  * FmgrInfo is long-lived.
625  */
626  fcache = (SQLFunctionCachePtr) palloc0(sizeof(SQLFunctionCache));
627  fcache->fcontext = fcontext;
628  finfo->fn_extra = (void *) fcache;
629 
630  /*
631  * get the procedure tuple corresponding to the given function Oid
632  */
633  procedureTuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(foid));
634  if (!HeapTupleIsValid(procedureTuple))
635  elog(ERROR, "cache lookup failed for function %u", foid);
636  procedureStruct = (Form_pg_proc) GETSTRUCT(procedureTuple);
637 
638  /*
639  * copy function name immediately for use by error reporting callback
640  */
641  fcache->fname = pstrdup(NameStr(procedureStruct->proname));
642 
643  /*
644  * get the result type from the procedure tuple, and check for polymorphic
645  * result type; if so, find out the actual result type.
646  */
647  rettype = procedureStruct->prorettype;
648 
649  if (IsPolymorphicType(rettype))
650  {
651  rettype = get_fn_expr_rettype(finfo);
652  if (rettype == InvalidOid) /* this probably should not happen */
653  ereport(ERROR,
654  (errcode(ERRCODE_DATATYPE_MISMATCH),
655  errmsg("could not determine actual result type for function declared to return type %s",
656  format_type_be(procedureStruct->prorettype))));
657  }
658 
659  fcache->rettype = rettype;
660 
661  /* Fetch the typlen and byval info for the result type */
662  if (rettype)
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,
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,
723  list_copy(queryTree_sublist));
724  }
725 
726  /*
727  * Check that the function returns the type it claims to. Although in
728  * simple cases this was already done when the function was defined, we
729  * have to recheck because database objects used in the function's queries
730  * might have changed type. We'd have to do it anyway if the function had
731  * any polymorphic arguments.
732  *
733  * Note: we set fcache->returnsTuple according to whether we are returning
734  * the whole tuple result or just a single column. In the latter case we
735  * clear returnsTuple because we need not act different from the scalar
736  * result case, even if it's a rowtype column. (However, we have to force
737  * lazy eval mode in that case; otherwise we'd need extra code to expand
738  * the rowtype column into multiple columns, since we have no way to
739  * notify the caller that it should do that.)
740  *
741  * check_sql_fn_retval will also construct a JunkFilter we can use to
742  * coerce the returned rowtype to the desired form (unless the result type
743  * is VOID, in which case there's nothing to coerce to).
744  */
745  fcache->returnsTuple = check_sql_fn_retval(foid,
746  rettype,
747  flat_query_list,
748  NULL,
749  &fcache->junkFilter);
750 
751  if (fcache->returnsTuple)
752  {
753  /* Make sure output rowtype is properly blessed */
755  }
756  else if (fcache->returnsSet && type_is_rowtype(fcache->rettype))
757  {
758  /*
759  * Returning rowtype as if it were scalar --- materialize won't work.
760  * Right now it's sufficient to override any caller preference for
761  * materialize mode, but to add more smarts in init_execution_state
762  * about this, we'd probably need a three-way flag instead of bool.
763  */
764  lazyEvalOK = true;
765  }
766 
767  /* Finally, plan the queries */
768  fcache->func_state = init_execution_state(queryTree_list,
769  fcache,
770  lazyEvalOK);
771 
772  /* Mark fcache with time of creation to show it's valid */
773  fcache->lxid = MyProc->lxid;
775 
776  ReleaseSysCache(procedureTuple);
777 
778  MemoryContextSwitchTo(oldcontext);
779 }
780 
781 /* Start up execution of one execution_state node */
782 static void
784 {
786 
787  Assert(es->qd == NULL);
788 
789  /* Caller should have ensured a suitable snapshot is active */
791 
792  /*
793  * If this query produces the function result, send its output to the
794  * tuplestore; else discard any output.
795  */
796  if (es->setsResult)
797  {
798  DR_sqlfunction *myState;
799 
801  /* pass down the needed info to the dest receiver routines */
802  myState = (DR_sqlfunction *) dest;
803  Assert(myState->pub.mydest == DestSQLFunction);
804  myState->tstore = fcache->tstore;
805  myState->cxt = CurrentMemoryContext;
806  myState->filter = fcache->junkFilter;
807  }
808  else
809  dest = None_Receiver;
810 
811  es->qd = CreateQueryDesc(es->stmt,
812  fcache->src,
815  dest,
816  fcache->paramLI,
817  es->qd ? es->qd->queryEnv : NULL,
818  0);
819 
820  /* Utility commands don't need Executor. */
821  if (es->qd->operation != CMD_UTILITY)
822  {
823  /*
824  * In lazyEval mode, do not let the executor set up an AfterTrigger
825  * context. This is necessary not just an optimization, because we
826  * mustn't exit from the function execution with a stacked
827  * AfterTrigger level still active. We are careful not to select
828  * lazyEval mode for any statement that could possibly queue triggers.
829  */
830  int eflags;
831 
832  if (es->lazyEval)
833  eflags = EXEC_FLAG_SKIP_TRIGGERS;
834  else
835  eflags = 0; /* default run-to-completion flags */
836  ExecutorStart(es->qd, eflags);
837  }
838 
839  es->status = F_EXEC_RUN;
840 }
841 
842 /* Run one execution_state; either to completion or to first result row */
843 /* Returns true if we ran to completion */
844 static bool
846 {
847  bool result;
848 
849  if (es->qd->operation == CMD_UTILITY)
850  {
852  fcache->src,
854  es->qd->params,
855  es->qd->queryEnv,
856  es->qd->dest,
857  NULL);
858  result = true; /* never stops early */
859  }
860  else
861  {
862  /* Run regular commands to completion unless lazyEval */
863  uint64 count = (es->lazyEval) ? 1 : 0;
864 
865  ExecutorRun(es->qd, ForwardScanDirection, count, !fcache->returnsSet || !es->lazyEval);
866 
867  /*
868  * If we requested run to completion OR there was no tuple returned,
869  * command must be complete.
870  */
871  result = (count == 0 || es->qd->estate->es_processed == 0);
872  }
873 
874  return result;
875 }
876 
877 /* Shut down execution of one execution_state node */
878 static void
880 {
881  /* mark status done to ensure we don't do ExecutorEnd twice */
882  es->status = F_EXEC_DONE;
883 
884  /* Utility commands don't need Executor. */
885  if (es->qd->operation != CMD_UTILITY)
886  {
887  ExecutorFinish(es->qd);
888  ExecutorEnd(es->qd);
889  }
890 
891  es->qd->dest->rDestroy(es->qd->dest);
892 
893  FreeQueryDesc(es->qd);
894  es->qd = NULL;
895 }
896 
897 /* Build ParamListInfo array representing current arguments */
898 static void
900  FunctionCallInfo fcinfo)
901 {
902  int nargs = fcinfo->nargs;
903 
904  if (nargs > 0)
905  {
906  ParamListInfo paramLI;
907  int i;
908 
909  if (fcache->paramLI == NULL)
910  {
911  paramLI = (ParamListInfo)
913  nargs * sizeof(ParamExternData));
914  /* we have static list of params, so no hooks needed */
915  paramLI->paramFetch = NULL;
916  paramLI->paramFetchArg = NULL;
917  paramLI->paramCompile = NULL;
918  paramLI->paramCompileArg = NULL;
919  paramLI->parserSetup = NULL;
920  paramLI->parserSetupArg = NULL;
921  paramLI->numParams = nargs;
922  fcache->paramLI = paramLI;
923  }
924  else
925  {
926  paramLI = fcache->paramLI;
927  Assert(paramLI->numParams == nargs);
928  }
929 
930  for (i = 0; i < nargs; i++)
931  {
932  ParamExternData *prm = &paramLI->params[i];
933 
934  prm->value = fcinfo->arg[i];
935  prm->isnull = fcinfo->argnull[i];
936  prm->pflags = 0;
937  prm->ptype = fcache->pinfo->argtypes[i];
938  }
939  }
940  else
941  fcache->paramLI = NULL;
942 }
943 
944 /*
945  * Extract the SQL function's value from a single result row. This is used
946  * both for scalar (non-set) functions and for each row of a lazy-eval set
947  * result.
948  */
949 static Datum
951  FunctionCallInfo fcinfo,
952  SQLFunctionCachePtr fcache,
953  MemoryContext resultcontext)
954 {
955  Datum value;
956  MemoryContext oldcontext;
957 
958  /*
959  * Set up to return the function value. For pass-by-reference datatypes,
960  * be sure to allocate the result in resultcontext, not the current memory
961  * context (which has query lifespan). We can't leave the data in the
962  * TupleTableSlot because we intend to clear the slot before returning.
963  */
964  oldcontext = MemoryContextSwitchTo(resultcontext);
965 
966  if (fcache->returnsTuple)
967  {
968  /* We must return the whole tuple as a Datum. */
969  fcinfo->isnull = false;
970  value = ExecFetchSlotTupleDatum(slot);
971  }
972  else
973  {
974  /*
975  * Returning a scalar, which we have to extract from the first column
976  * of the SELECT result, and then copy into result context if needed.
977  */
978  value = slot_getattr(slot, 1, &(fcinfo->isnull));
979 
980  if (!fcinfo->isnull)
981  value = datumCopy(value, fcache->typbyval, fcache->typlen);
982  }
983 
984  MemoryContextSwitchTo(oldcontext);
985 
986  return value;
987 }
988 
989 /*
990  * fmgr_sql: function call manager for SQL functions
991  */
992 Datum
994 {
995  SQLFunctionCachePtr fcache;
996  ErrorContextCallback sqlerrcontext;
997  MemoryContext oldcontext;
998  bool randomAccess;
999  bool lazyEvalOK;
1000  bool is_first;
1001  bool pushed_snapshot;
1002  execution_state *es;
1003  TupleTableSlot *slot;
1004  Datum result;
1005  List *eslist;
1006  ListCell *eslc;
1007 
1008  /*
1009  * Setup error traceback support for ereport()
1010  */
1011  sqlerrcontext.callback = sql_exec_error_callback;
1012  sqlerrcontext.arg = fcinfo->flinfo;
1013  sqlerrcontext.previous = error_context_stack;
1014  error_context_stack = &sqlerrcontext;
1015 
1016  /* Check call context */
1017  if (fcinfo->flinfo->fn_retset)
1018  {
1019  ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
1020 
1021  /*
1022  * For simplicity, we require callers to support both set eval modes.
1023  * There are cases where we must use one or must use the other, and
1024  * it's not really worthwhile to postpone the check till we know. But
1025  * note we do not require caller to provide an expectedDesc.
1026  */
1027  if (!rsi || !IsA(rsi, ReturnSetInfo) ||
1028  (rsi->allowedModes & SFRM_ValuePerCall) == 0 ||
1029  (rsi->allowedModes & SFRM_Materialize) == 0)
1030  ereport(ERROR,
1031  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1032  errmsg("set-valued function called in context that cannot accept a set")));
1033  randomAccess = rsi->allowedModes & SFRM_Materialize_Random;
1034  lazyEvalOK = !(rsi->allowedModes & SFRM_Materialize_Preferred);
1035  }
1036  else
1037  {
1038  randomAccess = false;
1039  lazyEvalOK = true;
1040  }
1041 
1042  /*
1043  * Initialize fcache (build plans) if first time through; or re-initialize
1044  * if the cache is stale.
1045  */
1046  fcache = (SQLFunctionCachePtr) fcinfo->flinfo->fn_extra;
1047 
1048  if (fcache != NULL)
1049  {
1050  if (fcache->lxid != MyProc->lxid ||
1051  !SubTransactionIsActive(fcache->subxid))
1052  {
1053  /* It's stale; unlink and delete */
1054  fcinfo->flinfo->fn_extra = NULL;
1055  MemoryContextDelete(fcache->fcontext);
1056  fcache = NULL;
1057  }
1058  }
1059 
1060  if (fcache == NULL)
1061  {
1062  init_sql_fcache(fcinfo->flinfo, PG_GET_COLLATION(), lazyEvalOK);
1063  fcache = (SQLFunctionCachePtr) fcinfo->flinfo->fn_extra;
1064  }
1065 
1066  /*
1067  * Switch to context in which the fcache lives. This ensures that our
1068  * tuplestore etc will have sufficient lifetime. The sub-executor is
1069  * responsible for deleting per-tuple information. (XXX in the case of a
1070  * long-lived FmgrInfo, this policy represents more memory leakage, but
1071  * it's not entirely clear where to keep stuff instead.)
1072  */
1073  oldcontext = MemoryContextSwitchTo(fcache->fcontext);
1074 
1075  /*
1076  * Find first unfinished query in function, and note whether it's the
1077  * first query.
1078  */
1079  eslist = fcache->func_state;
1080  es = NULL;
1081  is_first = true;
1082  foreach(eslc, eslist)
1083  {
1084  es = (execution_state *) lfirst(eslc);
1085 
1086  while (es && es->status == F_EXEC_DONE)
1087  {
1088  is_first = false;
1089  es = es->next;
1090  }
1091 
1092  if (es)
1093  break;
1094  }
1095 
1096  /*
1097  * Convert params to appropriate format if starting a fresh execution. (If
1098  * continuing execution, we can re-use prior params.)
1099  */
1100  if (is_first && es && es->status == F_EXEC_START)
1101  postquel_sub_params(fcache, fcinfo);
1102 
1103  /*
1104  * Build tuplestore to hold results, if we don't have one already. Note
1105  * it's in the query-lifespan context.
1106  */
1107  if (!fcache->tstore)
1108  fcache->tstore = tuplestore_begin_heap(randomAccess, false, work_mem);
1109 
1110  /*
1111  * Execute each command in the function one after another until we either
1112  * run out of commands or get a result row from a lazily-evaluated SELECT.
1113  *
1114  * Notes about snapshot management:
1115  *
1116  * In a read-only function, we just use the surrounding query's snapshot.
1117  *
1118  * In a non-read-only function, we rely on the fact that we'll never
1119  * suspend execution between queries of the function: the only reason to
1120  * suspend execution before completion is if we are returning a row from a
1121  * lazily-evaluated SELECT. So, when first entering this loop, we'll
1122  * either start a new query (and push a fresh snapshot) or re-establish
1123  * the active snapshot from the existing query descriptor. If we need to
1124  * start a new query in a subsequent execution of the loop, either we need
1125  * a fresh snapshot (and pushed_snapshot is false) or the existing
1126  * snapshot is on the active stack and we can just bump its command ID.
1127  */
1128  pushed_snapshot = false;
1129  while (es)
1130  {
1131  bool completed;
1132 
1133  if (es->status == F_EXEC_START)
1134  {
1135  /*
1136  * If not read-only, be sure to advance the command counter for
1137  * each command, so that all work to date in this transaction is
1138  * visible. Take a new snapshot if we don't have one yet,
1139  * otherwise just bump the command ID in the existing snapshot.
1140  */
1141  if (!fcache->readonly_func)
1142  {
1144  if (!pushed_snapshot)
1145  {
1147  pushed_snapshot = true;
1148  }
1149  else
1151  }
1152 
1153  postquel_start(es, fcache);
1154  }
1155  else if (!fcache->readonly_func && !pushed_snapshot)
1156  {
1157  /* Re-establish active snapshot when re-entering function */
1159  pushed_snapshot = true;
1160  }
1161 
1162  completed = postquel_getnext(es, fcache);
1163 
1164  /*
1165  * If we ran the command to completion, we can shut it down now. Any
1166  * row(s) we need to return are safely stashed in the tuplestore, and
1167  * we want to be sure that, for example, AFTER triggers get fired
1168  * before we return anything. Also, if the function doesn't return
1169  * set, we can shut it down anyway because it must be a SELECT and we
1170  * don't care about fetching any more result rows.
1171  */
1172  if (completed || !fcache->returnsSet)
1173  postquel_end(es);
1174 
1175  /*
1176  * Break from loop if we didn't shut down (implying we got a
1177  * lazily-evaluated row). Otherwise we'll press on till the whole
1178  * function is done, relying on the tuplestore to keep hold of the
1179  * data to eventually be returned. This is necessary since an
1180  * INSERT/UPDATE/DELETE RETURNING that sets the result might be
1181  * followed by additional rule-inserted commands, and we want to
1182  * finish doing all those commands before we return anything.
1183  */
1184  if (es->status != F_EXEC_DONE)
1185  break;
1186 
1187  /*
1188  * Advance to next execution_state, which might be in the next list.
1189  */
1190  es = es->next;
1191  while (!es)
1192  {
1193  eslc = lnext(eslc);
1194  if (!eslc)
1195  break; /* end of function */
1196 
1197  es = (execution_state *) lfirst(eslc);
1198 
1199  /*
1200  * Flush the current snapshot so that we will take a new one for
1201  * the new query list. This ensures that new snaps are taken at
1202  * original-query boundaries, matching the behavior of interactive
1203  * execution.
1204  */
1205  if (pushed_snapshot)
1206  {
1208  pushed_snapshot = false;
1209  }
1210  }
1211  }
1212 
1213  /*
1214  * The tuplestore now contains whatever row(s) we are supposed to return.
1215  */
1216  if (fcache->returnsSet)
1217  {
1218  ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
1219 
1220  if (es)
1221  {
1222  /*
1223  * If we stopped short of being done, we must have a lazy-eval
1224  * row.
1225  */
1226  Assert(es->lazyEval);
1227  /* Re-use the junkfilter's output slot to fetch back the tuple */
1228  Assert(fcache->junkFilter);
1229  slot = fcache->junkFilter->jf_resultSlot;
1230  if (!tuplestore_gettupleslot(fcache->tstore, true, false, slot))
1231  elog(ERROR, "failed to fetch lazy-eval tuple");
1232  /* Extract the result as a datum, and copy out from the slot */
1233  result = postquel_get_single_result(slot, fcinfo,
1234  fcache, oldcontext);
1235  /* Clear the tuplestore, but keep it for next time */
1236  /* NB: this might delete the slot's content, but we don't care */
1237  tuplestore_clear(fcache->tstore);
1238 
1239  /*
1240  * Let caller know we're not finished.
1241  */
1242  rsi->isDone = ExprMultipleResult;
1243 
1244  /*
1245  * Ensure we will get shut down cleanly if the exprcontext is not
1246  * run to completion.
1247  */
1248  if (!fcache->shutdown_reg)
1249  {
1252  PointerGetDatum(fcache));
1253  fcache->shutdown_reg = true;
1254  }
1255  }
1256  else if (fcache->lazyEval)
1257  {
1258  /*
1259  * We are done with a lazy evaluation. Clean up.
1260  */
1261  tuplestore_clear(fcache->tstore);
1262 
1263  /*
1264  * Let caller know we're finished.
1265  */
1266  rsi->isDone = ExprEndResult;
1267 
1268  fcinfo->isnull = true;
1269  result = (Datum) 0;
1270 
1271  /* Deregister shutdown callback, if we made one */
1272  if (fcache->shutdown_reg)
1273  {
1276  PointerGetDatum(fcache));
1277  fcache->shutdown_reg = false;
1278  }
1279  }
1280  else
1281  {
1282  /*
1283  * We are done with a non-lazy evaluation. Return whatever is in
1284  * the tuplestore. (It is now caller's responsibility to free the
1285  * tuplestore when done.)
1286  */
1288  rsi->setResult = fcache->tstore;
1289  fcache->tstore = NULL;
1290  /* must copy desc because execSRF.c will free it */
1291  if (fcache->junkFilter)
1293 
1294  fcinfo->isnull = true;
1295  result = (Datum) 0;
1296 
1297  /* Deregister shutdown callback, if we made one */
1298  if (fcache->shutdown_reg)
1299  {
1302  PointerGetDatum(fcache));
1303  fcache->shutdown_reg = false;
1304  }
1305  }
1306  }
1307  else
1308  {
1309  /*
1310  * Non-set function. If we got a row, return it; else return NULL.
1311  */
1312  if (fcache->junkFilter)
1313  {
1314  /* Re-use the junkfilter's output slot to fetch back the tuple */
1315  slot = fcache->junkFilter->jf_resultSlot;
1316  if (tuplestore_gettupleslot(fcache->tstore, true, false, slot))
1317  result = postquel_get_single_result(slot, fcinfo,
1318  fcache, oldcontext);
1319  else
1320  {
1321  fcinfo->isnull = true;
1322  result = (Datum) 0;
1323  }
1324  }
1325  else
1326  {
1327  /* Should only get here for procedures and VOID functions */
1328  Assert(fcache->rettype == InvalidOid || fcache->rettype == VOIDOID);
1329  fcinfo->isnull = true;
1330  result = (Datum) 0;
1331  }
1332 
1333  /* Clear the tuplestore, but keep it for next time */
1334  tuplestore_clear(fcache->tstore);
1335  }
1336 
1337  /* Pop snapshot if we have pushed one */
1338  if (pushed_snapshot)
1340 
1341  /*
1342  * If we've gone through every command in the function, we are done. Reset
1343  * the execution states to start over again on next call.
1344  */
1345  if (es == NULL)
1346  {
1347  foreach(eslc, fcache->func_state)
1348  {
1349  es = (execution_state *) lfirst(eslc);
1350  while (es)
1351  {
1352  es->status = F_EXEC_START;
1353  es = es->next;
1354  }
1355  }
1356  }
1357 
1358  error_context_stack = sqlerrcontext.previous;
1359 
1360  MemoryContextSwitchTo(oldcontext);
1361 
1362  return result;
1363 }
1364 
1365 
1366 /*
1367  * error context callback to let us supply a call-stack traceback
1368  */
1369 static void
1371 {
1372  FmgrInfo *flinfo = (FmgrInfo *) arg;
1374  int syntaxerrposition;
1375 
1376  /*
1377  * We can do nothing useful if init_sql_fcache() didn't get as far as
1378  * saving the function name
1379  */
1380  if (fcache == NULL || fcache->fname == NULL)
1381  return;
1382 
1383  /*
1384  * If there is a syntax error position, convert to internal syntax error
1385  */
1386  syntaxerrposition = geterrposition();
1387  if (syntaxerrposition > 0 && fcache->src != NULL)
1388  {
1389  errposition(0);
1390  internalerrposition(syntaxerrposition);
1391  internalerrquery(fcache->src);
1392  }
1393 
1394  /*
1395  * Try to determine where in the function we failed. If there is a query
1396  * with non-null QueryDesc, finger it. (We check this rather than looking
1397  * for F_EXEC_RUN state, so that errors during ExecutorStart or
1398  * ExecutorEnd are blamed on the appropriate query; see postquel_start and
1399  * postquel_end.)
1400  */
1401  if (fcache->func_state)
1402  {
1403  execution_state *es;
1404  int query_num;
1405  ListCell *lc;
1406 
1407  es = NULL;
1408  query_num = 1;
1409  foreach(lc, fcache->func_state)
1410  {
1411  es = (execution_state *) lfirst(lc);
1412  while (es)
1413  {
1414  if (es->qd)
1415  {
1416  errcontext("SQL function \"%s\" statement %d",
1417  fcache->fname, query_num);
1418  break;
1419  }
1420  es = es->next;
1421  }
1422  if (es)
1423  break;
1424  query_num++;
1425  }
1426  if (es == NULL)
1427  {
1428  /*
1429  * couldn't identify a running query; might be function entry,
1430  * function exit, or between queries.
1431  */
1432  errcontext("SQL function \"%s\"", fcache->fname);
1433  }
1434  }
1435  else
1436  {
1437  /*
1438  * Assume we failed during init_sql_fcache(). (It's possible that the
1439  * function actually has an empty body, but in that case we may as
1440  * well report all errors as being "during startup".)
1441  */
1442  errcontext("SQL function \"%s\" during startup", fcache->fname);
1443  }
1444 }
1445 
1446 
1447 /*
1448  * callback function in case a function-returning-set needs to be shut down
1449  * before it has been run to completion
1450  */
1451 static void
1453 {
1455  execution_state *es;
1456  ListCell *lc;
1457 
1458  foreach(lc, fcache->func_state)
1459  {
1460  es = (execution_state *) lfirst(lc);
1461  while (es)
1462  {
1463  /* Shut down anything still running */
1464  if (es->status == F_EXEC_RUN)
1465  {
1466  /* Re-establish active snapshot for any called functions */
1467  if (!fcache->readonly_func)
1469 
1470  postquel_end(es);
1471 
1472  if (!fcache->readonly_func)
1474  }
1475 
1476  /* Reset states to START in case we're called again */
1477  es->status = F_EXEC_START;
1478  es = es->next;
1479  }
1480  }
1481 
1482  /* Release tuplestore if we have one */
1483  if (fcache->tstore)
1484  tuplestore_end(fcache->tstore);
1485  fcache->tstore = NULL;
1486 
1487  /* execUtils will deregister the callback... */
1488  fcache->shutdown_reg = false;
1489 }
1490 
1491 
1492 /*
1493  * check_sql_fn_retval() -- check return value of a list of sql parse trees.
1494  *
1495  * The return value of a sql function is the value returned by the last
1496  * canSetTag query in the function. We do some ad-hoc type checking here
1497  * to be sure that the user is returning the type he claims. There are
1498  * also a couple of strange-looking features to assist callers in dealing
1499  * with allowed special cases, such as binary-compatible result types.
1500  *
1501  * For a polymorphic function the passed rettype must be the actual resolved
1502  * output type of the function; we should never see a polymorphic pseudotype
1503  * such as ANYELEMENT as rettype. (This means we can't check the type during
1504  * function definition of a polymorphic function.)
1505  *
1506  * This function returns true if the sql function returns the entire tuple
1507  * result of its final statement, or false if it returns just the first column
1508  * result of that statement. It throws an error if the final statement doesn't
1509  * return the right type at all.
1510  *
1511  * Note that because we allow "SELECT rowtype_expression", the result can be
1512  * false even when the declared function return type is a rowtype.
1513  *
1514  * If modifyTargetList isn't NULL, the function will modify the final
1515  * statement's targetlist in two cases:
1516  * (1) if the tlist returns values that are binary-coercible to the expected
1517  * type rather than being exactly the expected type. RelabelType nodes will
1518  * be inserted to make the result types match exactly.
1519  * (2) if there are dropped columns in the declared result rowtype. NULL
1520  * output columns will be inserted in the tlist to match them.
1521  * (Obviously the caller must pass a parsetree that is okay to modify when
1522  * using this flag.) Note that this flag does not affect whether the tlist is
1523  * considered to be a legal match to the result type, only how we react to
1524  * allowed not-exact-match cases. *modifyTargetList will be set true iff
1525  * we had to make any "dangerous" changes that could modify the semantics of
1526  * the statement. If it is set true, the caller should not use the modified
1527  * statement, but for simplicity we apply the changes anyway.
1528  *
1529  * If junkFilter isn't NULL, then *junkFilter is set to a JunkFilter defined
1530  * to convert the function's tuple result to the correct output tuple type.
1531  * Exception: if the function is defined to return VOID then *junkFilter is
1532  * set to NULL.
1533  */
1534 bool
1535 check_sql_fn_retval(Oid func_id, Oid rettype, List *queryTreeList,
1536  bool *modifyTargetList,
1537  JunkFilter **junkFilter)
1538 {
1539  Query *parse;
1540  List **tlist_ptr;
1541  List *tlist;
1542  int tlistlen;
1543  char fn_typtype;
1544  Oid restype;
1545  ListCell *lc;
1546 
1547  AssertArg(!IsPolymorphicType(rettype));
1548 
1549  if (modifyTargetList)
1550  *modifyTargetList = false; /* initialize for no change */
1551  if (junkFilter)
1552  *junkFilter = NULL; /* initialize in case of procedure/VOID result */
1553 
1554  if (!rettype)
1555  return false;
1556 
1557  /*
1558  * Find the last canSetTag query in the list. This isn't necessarily the
1559  * last parsetree, because rule rewriting can insert queries after what
1560  * the user wrote.
1561  */
1562  parse = NULL;
1563  foreach(lc, queryTreeList)
1564  {
1565  Query *q = lfirst_node(Query, lc);
1566 
1567  if (q->canSetTag)
1568  parse = q;
1569  }
1570 
1571  /*
1572  * If it's a plain SELECT, it returns whatever the targetlist says.
1573  * Otherwise, if it's INSERT/UPDATE/DELETE with RETURNING, it returns
1574  * that. Otherwise, the function return type must be VOID.
1575  *
1576  * Note: eventually replace this test with QueryReturnsTuples? We'd need
1577  * a more general method of determining the output type, though. Also, it
1578  * seems too dangerous to consider FETCH or EXECUTE as returning a
1579  * determinable rowtype, since they depend on relatively short-lived
1580  * entities.
1581  */
1582  if (parse &&
1583  parse->commandType == CMD_SELECT)
1584  {
1585  tlist_ptr = &parse->targetList;
1586  tlist = parse->targetList;
1587  }
1588  else if (parse &&
1589  (parse->commandType == CMD_INSERT ||
1590  parse->commandType == CMD_UPDATE ||
1591  parse->commandType == CMD_DELETE) &&
1592  parse->returningList)
1593  {
1594  tlist_ptr = &parse->returningList;
1595  tlist = parse->returningList;
1596  }
1597  else
1598  {
1599  /* Empty function body, or last statement is a utility command */
1600  if (rettype && rettype != VOIDOID)
1601  ereport(ERROR,
1602  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1603  errmsg("return type mismatch in function declared to return %s",
1604  format_type_be(rettype)),
1605  errdetail("Function's final statement must be SELECT or INSERT/UPDATE/DELETE RETURNING.")));
1606  return false;
1607  }
1608 
1609  /*
1610  * OK, check that the targetlist returns something matching the declared
1611  * type. (We used to insist that the declared type not be VOID in this
1612  * case, but that makes it hard to write a void function that exits after
1613  * calling another void function. Instead, we insist that the tlist
1614  * return void ... so void is treated as if it were a scalar type below.)
1615  */
1616 
1617  /*
1618  * Count the non-junk entries in the result targetlist.
1619  */
1620  tlistlen = ExecCleanTargetListLength(tlist);
1621 
1622  fn_typtype = get_typtype(rettype);
1623 
1624  if (fn_typtype == TYPTYPE_BASE ||
1625  fn_typtype == TYPTYPE_DOMAIN ||
1626  fn_typtype == TYPTYPE_ENUM ||
1627  fn_typtype == TYPTYPE_RANGE ||
1628  rettype == VOIDOID)
1629  {
1630  /*
1631  * For scalar-type returns, the target list must have exactly one
1632  * non-junk entry, and its type must agree with what the user
1633  * declared; except we allow binary-compatible types too.
1634  */
1635  TargetEntry *tle;
1636 
1637  if (tlistlen != 1)
1638  ereport(ERROR,
1639  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1640  errmsg("return type mismatch in function declared to return %s",
1641  format_type_be(rettype)),
1642  errdetail("Final statement must return exactly one column.")));
1643 
1644  /* We assume here that non-junk TLEs must come first in tlists */
1645  tle = (TargetEntry *) linitial(tlist);
1646  Assert(!tle->resjunk);
1647 
1648  restype = exprType((Node *) tle->expr);
1649  if (!IsBinaryCoercible(restype, rettype))
1650  ereport(ERROR,
1651  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1652  errmsg("return type mismatch in function declared to return %s",
1653  format_type_be(rettype)),
1654  errdetail("Actual return type is %s.",
1655  format_type_be(restype))));
1656  if (modifyTargetList && restype != rettype)
1657  {
1658  tle->expr = (Expr *) makeRelabelType(tle->expr,
1659  rettype,
1660  -1,
1661  get_typcollation(rettype),
1663  /* Relabel is dangerous if TLE is a sort/group or setop column */
1664  if (tle->ressortgroupref != 0 || parse->setOperations)
1665  *modifyTargetList = true;
1666  }
1667 
1668  /* Set up junk filter if needed */
1669  if (junkFilter)
1670  *junkFilter = ExecInitJunkFilter(tlist, false, NULL);
1671  }
1672  else if (fn_typtype == TYPTYPE_COMPOSITE || rettype == RECORDOID)
1673  {
1674  /*
1675  * Returns a rowtype.
1676  *
1677  * Note that we will not consider a domain over composite to be a
1678  * "rowtype" return type; it goes through the scalar case above. This
1679  * is because SQL functions don't provide any implicit casting to the
1680  * result type, so there is no way to produce a domain-over-composite
1681  * result except by computing it as an explicit single-column result.
1682  */
1683  TupleDesc tupdesc;
1684  int tupnatts; /* physical number of columns in tuple */
1685  int tuplogcols; /* # of nondeleted columns in tuple */
1686  int colindex; /* physical column index */
1687  List *newtlist; /* new non-junk tlist entries */
1688  List *junkattrs; /* new junk tlist entries */
1689 
1690  /*
1691  * If the target list is of length 1, and the type of the varnode in
1692  * the target list matches the declared return type, this is okay.
1693  * This can happen, for example, where the body of the function is
1694  * 'SELECT func2()', where func2 has the same composite return type as
1695  * the function that's calling it.
1696  *
1697  * XXX Note that if rettype is RECORD, the IsBinaryCoercible check
1698  * will succeed for any composite restype. For the moment we rely on
1699  * runtime type checking to catch any discrepancy, but it'd be nice to
1700  * do better at parse time.
1701  */
1702  if (tlistlen == 1)
1703  {
1704  TargetEntry *tle = (TargetEntry *) linitial(tlist);
1705 
1706  Assert(!tle->resjunk);
1707  restype = exprType((Node *) tle->expr);
1708  if (IsBinaryCoercible(restype, rettype))
1709  {
1710  if (modifyTargetList && restype != rettype)
1711  {
1712  tle->expr = (Expr *) makeRelabelType(tle->expr,
1713  rettype,
1714  -1,
1715  get_typcollation(rettype),
1717  /* Relabel is dangerous if sort/group or setop column */
1718  if (tle->ressortgroupref != 0 || parse->setOperations)
1719  *modifyTargetList = true;
1720  }
1721  /* Set up junk filter if needed */
1722  if (junkFilter)
1723  *junkFilter = ExecInitJunkFilter(tlist, false, NULL);
1724  return false; /* NOT returning whole tuple */
1725  }
1726  }
1727 
1728  /*
1729  * Is the rowtype fixed, or determined only at runtime? (Note we
1730  * cannot see TYPEFUNC_COMPOSITE_DOMAIN here.)
1731  */
1732  if (get_func_result_type(func_id, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
1733  {
1734  /*
1735  * Assume we are returning the whole tuple. Crosschecking against
1736  * what the caller expects will happen at runtime.
1737  */
1738  if (junkFilter)
1739  *junkFilter = ExecInitJunkFilter(tlist, false, NULL);
1740  return true;
1741  }
1742  Assert(tupdesc);
1743 
1744  /*
1745  * Verify that the targetlist matches the return tuple type. We scan
1746  * the non-deleted attributes to ensure that they match the datatypes
1747  * of the non-resjunk columns. For deleted attributes, insert NULL
1748  * result columns if the caller asked for that.
1749  */
1750  tupnatts = tupdesc->natts;
1751  tuplogcols = 0; /* we'll count nondeleted cols as we go */
1752  colindex = 0;
1753  newtlist = NIL; /* these are only used if modifyTargetList */
1754  junkattrs = NIL;
1755 
1756  foreach(lc, tlist)
1757  {
1758  TargetEntry *tle = (TargetEntry *) lfirst(lc);
1759  Form_pg_attribute attr;
1760  Oid tletype;
1761  Oid atttype;
1762 
1763  if (tle->resjunk)
1764  {
1765  if (modifyTargetList)
1766  junkattrs = lappend(junkattrs, tle);
1767  continue;
1768  }
1769 
1770  do
1771  {
1772  colindex++;
1773  if (colindex > tupnatts)
1774  ereport(ERROR,
1775  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1776  errmsg("return type mismatch in function declared to return %s",
1777  format_type_be(rettype)),
1778  errdetail("Final statement returns too many columns.")));
1779  attr = TupleDescAttr(tupdesc, colindex - 1);
1780  if (attr->attisdropped && modifyTargetList)
1781  {
1782  Expr *null_expr;
1783 
1784  /* The type of the null we insert isn't important */
1785  null_expr = (Expr *) makeConst(INT4OID,
1786  -1,
1787  InvalidOid,
1788  sizeof(int32),
1789  (Datum) 0,
1790  true, /* isnull */
1791  true /* byval */ );
1792  newtlist = lappend(newtlist,
1793  makeTargetEntry(null_expr,
1794  colindex,
1795  NULL,
1796  false));
1797  /* NULL insertion is dangerous in a setop */
1798  if (parse->setOperations)
1799  *modifyTargetList = true;
1800  }
1801  } while (attr->attisdropped);
1802  tuplogcols++;
1803 
1804  tletype = exprType((Node *) tle->expr);
1805  atttype = attr->atttypid;
1806  if (!IsBinaryCoercible(tletype, atttype))
1807  ereport(ERROR,
1808  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1809  errmsg("return type mismatch in function declared to return %s",
1810  format_type_be(rettype)),
1811  errdetail("Final statement returns %s instead of %s at column %d.",
1812  format_type_be(tletype),
1813  format_type_be(atttype),
1814  tuplogcols)));
1815  if (modifyTargetList)
1816  {
1817  if (tletype != atttype)
1818  {
1819  tle->expr = (Expr *) makeRelabelType(tle->expr,
1820  atttype,
1821  -1,
1822  get_typcollation(atttype),
1824  /* Relabel is dangerous if sort/group or setop column */
1825  if (tle->ressortgroupref != 0 || parse->setOperations)
1826  *modifyTargetList = true;
1827  }
1828  tle->resno = colindex;
1829  newtlist = lappend(newtlist, tle);
1830  }
1831  }
1832 
1833  /* remaining columns in tupdesc had better all be dropped */
1834  for (colindex++; colindex <= tupnatts; colindex++)
1835  {
1836  if (!TupleDescAttr(tupdesc, colindex - 1)->attisdropped)
1837  ereport(ERROR,
1838  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1839  errmsg("return type mismatch in function declared to return %s",
1840  format_type_be(rettype)),
1841  errdetail("Final statement returns too few columns.")));
1842  if (modifyTargetList)
1843  {
1844  Expr *null_expr;
1845 
1846  /* The type of the null we insert isn't important */
1847  null_expr = (Expr *) makeConst(INT4OID,
1848  -1,
1849  InvalidOid,
1850  sizeof(int32),
1851  (Datum) 0,
1852  true, /* isnull */
1853  true /* byval */ );
1854  newtlist = lappend(newtlist,
1855  makeTargetEntry(null_expr,
1856  colindex,
1857  NULL,
1858  false));
1859  /* NULL insertion is dangerous in a setop */
1860  if (parse->setOperations)
1861  *modifyTargetList = true;
1862  }
1863  }
1864 
1865  if (modifyTargetList)
1866  {
1867  /* ensure resjunk columns are numbered correctly */
1868  foreach(lc, junkattrs)
1869  {
1870  TargetEntry *tle = (TargetEntry *) lfirst(lc);
1871 
1872  tle->resno = colindex++;
1873  }
1874  /* replace the tlist with the modified one */
1875  *tlist_ptr = list_concat(newtlist, junkattrs);
1876  }
1877 
1878  /* Set up junk filter if needed */
1879  if (junkFilter)
1880  *junkFilter = ExecInitJunkFilterConversion(tlist,
1881  CreateTupleDescCopy(tupdesc),
1882  NULL);
1883 
1884  /* Report that we are returning entire tuple result */
1885  return true;
1886  }
1887  else
1888  ereport(ERROR,
1889  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
1890  errmsg("return type %s is not supported for SQL functions",
1891  format_type_be(rettype))));
1892 
1893  return false;
1894 }
1895 
1896 
1897 /*
1898  * CreateSQLFunctionDestReceiver -- create a suitable DestReceiver object
1899  */
1900 DestReceiver *
1902 {
1903  DR_sqlfunction *self = (DR_sqlfunction *) palloc0(sizeof(DR_sqlfunction));
1904 
1905  self->pub.receiveSlot = sqlfunction_receive;
1906  self->pub.rStartup = sqlfunction_startup;
1907  self->pub.rShutdown = sqlfunction_shutdown;
1908  self->pub.rDestroy = sqlfunction_destroy;
1909  self->pub.mydest = DestSQLFunction;
1910 
1911  /* private fields will be set by postquel_start */
1912 
1913  return (DestReceiver *) self;
1914 }
1915 
1916 /*
1917  * sqlfunction_startup --- executor startup
1918  */
1919 static void
1920 sqlfunction_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
1921 {
1922  /* no-op */
1923 }
1924 
1925 /*
1926  * sqlfunction_receive --- receive one tuple
1927  */
1928 static bool
1930 {
1931  DR_sqlfunction *myState = (DR_sqlfunction *) self;
1932 
1933  /* Filter tuple as needed */
1934  slot = ExecFilterJunk(myState->filter, slot);
1935 
1936  /* Store the filtered tuple into the tuplestore */
1937  tuplestore_puttupleslot(myState->tstore, slot);
1938 
1939  return true;
1940 }
1941 
1942 /*
1943  * sqlfunction_shutdown --- executor end
1944  */
1945 static void
1947 {
1948  /* no-op */
1949 }
1950 
1951 /*
1952  * sqlfunction_destroy --- release DestReceiver object
1953  */
1954 static void
1956 {
1957  pfree(self);
1958 }
bool SubTransactionIsActive(SubTransactionId subxid)
Definition: xact.c:656
signed short int16
Definition: c.h:301
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:69
Datum value
Definition: params.h:92
bool CommandIsReadOnly(PlannedStmt *pstmt)
Definition: utility.c:98
#define TYPTYPE_DOMAIN
Definition: pg_type.h:722
Definition: fmgr.h:56
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:110
void UpdateActiveSnapshotCommandId(void)
Definition: snapmgr.c:781
#define IsA(nodeptr, _type_)
Definition: nodes.h:564
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:198
int stmt_location
Definition: parsenodes.h:179
#define GETSTRUCT(TUP)
Definition: htup_details.h:661
void * parserSetupArg
Definition: params.h:117
static struct @130 value
EState * estate
Definition: execdesc.h:48
MemoryContext fn_mcxt
Definition: fmgr.h:65
void PreventCommandIfParallelMode(const char *cmdname)
Definition: utility.c:255
#define TYPTYPE_BASE
Definition: pg_type.h:720
static void sqlfunction_destroy(DestReceiver *self)
Definition: functions.c:1955
MemoryContext fcontext
Definition: functions.c:121
void FreeQueryDesc(QueryDesc *qdesc)
Definition: pquery.c:105
DestReceiver pub
Definition: functions.c:43
#define TYPTYPE_COMPOSITE
Definition: pg_type.h:721
PGPROC * MyProc
Definition: proc.c:67
void UnregisterExprContextCallback(ExprContext *econtext, ExprContextCallbackFunction function, Datum arg)
Definition: execUtils.c:793
#define PointerGetDatum(X)
Definition: postgres.h:539
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:90
CommandDest mydest
Definition: dest.h:128
char * pstrdup(const char *in)
Definition: mcxt.c:1063
JunkFilter * ExecInitJunkFilterConversion(List *targetList, TupleDesc cleanTupType, TupleTableSlot *slot)
Definition: execJunk.c:136
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:140
#define llast(l)
Definition: pg_list.h:131
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define Anum_pg_proc_prosrc
Definition: pg_proc.h:115
Snapshot GetActiveSnapshot(void)
Definition: snapmgr.c:839
#define INT4OID
Definition: pg_type.h:316
struct execution_state execution_state
ParamKind paramkind
Definition: primnodes.h:244
List * list_copy(const List *oldlist)
Definition: list.c:1160
Definition: nodes.h:513
#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:336
int errcode(int sqlerrcode)
Definition: elog.c:575
TupleTableSlot * jf_resultSlot
Definition: execnodes.h:349
bool check_sql_fn_retval(Oid func_id, Oid rettype, List *queryTreeList, bool *modifyTargetList, JunkFilter **junkFilter)
Definition: functions.c:1535
char get_typtype(Oid typid)
Definition: lsyscache.c:2383
static void sqlfunction_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
Definition: functions.c:1920
JunkFilter * junkFilter
Definition: functions.c:111
Oid get_call_expr_argtype(Node *expr, int argnum)
Definition: fmgr.c:1923
char * format_type_be(Oid type_oid)
Definition: format_type.c:320
static void postquel_start(execution_state *es, SQLFunctionCachePtr fcache)
Definition: functions.c:783
List * list_concat(List *list1, List *list2)
Definition: list.c:321
static Node * sql_fn_resolve_param_name(SQLFunctionParseInfoPtr pinfo, const char *paramname, int location)
Definition: functions.c:450
void PopActiveSnapshot(void)
Definition: snapmgr.c:812
uint32 SubTransactionId
Definition: c.h:467
ParserSetupHook parserSetup
Definition: params.h:116
Tuplestorestate * tstore
Definition: functions.c:109
struct ParamListInfoData * ParamListInfo
Definition: params.h:98
unsigned int Oid
Definition: postgres_ext.h:31
Node * utilityStmt
Definition: parsenodes.h:118
Const * makeConst(Oid consttype, int32 consttypmod, Oid constcollid, int constlen, Datum constvalue, bool constisnull, bool constbyval)
Definition: makefuncs.c:298
DestReceiver * None_Receiver
Definition: dest.c:91
void(* callback)(void *arg)
Definition: elog.h:239
struct ErrorContextCallback * previous
Definition: elog.h:238
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:304
#define OidIsValid(objectId)
Definition: c.h:594
int natts
Definition: tupdesc.h:79
int stmt_len
Definition: plannodes.h:98
#define PG_GET_COLLATION()
Definition: fmgr.h:163
#define lsecond(l)
Definition: pg_list.h:116
PostParseColumnRefHook p_post_columnref_hook
Definition: parse_node.h:213
signed int int32
Definition: c.h:302
List * targetList
Definition: parsenodes.h:138
Snapshot snapshot
Definition: execdesc.h:39
int location
Definition: parsenodes.h:235
ErrorContextCallback * error_context_stack
Definition: elog.c:88
static bool sqlfunction_receive(TupleTableSlot *slot, DestReceiver *self)
Definition: functions.c:1929
#define list_make1(x1)
Definition: pg_list.h:139
void ExecutorEnd(QueryDesc *queryDesc)
Definition: execMain.c:459
void * paramFetchArg
Definition: params.h:113
ParamCompileHook paramCompile
Definition: params.h:114
QueryEnvironment * queryEnv
Definition: execdesc.h:43
ParamFetchHook paramFetch
Definition: params.h:112
void pfree(void *pointer)
Definition: mcxt.c:936
bool IsInParallelMode(void)
Definition: xact.c:906
bool resjunk
Definition: primnodes.h:1382
#define linitial(l)
Definition: pg_list.h:111
#define VOIDOID
Definition: pg_type.h:690
#define ObjectIdGetDatum(X)
Definition: postgres.h:490
#define ERROR
Definition: elog.h:43
#define IsPolymorphicType(typid)
Definition: pg_type.h:745
static void sql_exec_error_callback(void *arg)
Definition: functions.c:1370
Oid paramcollid
Definition: primnodes.h:248
void ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count, bool execute_once)
Definition: execMain.c:297
Node * ParseFuncOrColumn(ParseState *pstate, List *funcname, List *fargs, Node *last_srf, FuncCall *fn, bool proc_call, int location)
Definition: parse_func.c:73
int location
Definition: primnodes.h:249
List * pg_parse_query(const char *query_string)
Definition: postgres.c:607
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:197
#define lfirst_node(type, lc)
Definition: pg_list.h:109
TupleDesc BlessTupleDesc(TupleDesc tupdesc)
Definition: execTuples.c:1088
void(* ParserSetupHook)(struct ParseState *pstate, void *arg)
Definition: params.h:108
static void postquel_end(execution_state *es)
Definition: functions.c:879
int stmt_location
Definition: plannodes.h:97
ParseParamRefHook p_paramref_hook
Definition: parse_node.h:214
void PushActiveSnapshot(Snapshot snap)
Definition: snapmgr.c:733
List * func_state
Definition: functions.c:119
RelabelType * makeRelabelType(Expr *arg, Oid rtype, int32 rtypmod, Oid rcollid, CoercionForm rformat)
Definition: makefuncs.c:401
LocalTransactionId lxid
Definition: functions.c:124
TupleDesc jf_cleanTupType
Definition: execnodes.h:347
DestReceiver * CreateDestReceiver(CommandDest dest)
Definition: dest.c:109
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
ParamListInfo params
Definition: execdesc.h:42
Node * utilityStmt
Definition: plannodes.h:94
int geterrposition(void)
Definition: elog.c:1257
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:1452
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:187
bool ActiveSnapshotSet(void)
Definition: snapmgr.c:851
static List * init_execution_state(List *queryTree_list, SQLFunctionCachePtr fcache, bool lazyEvalOK)
Definition: functions.c:474
#define Anum_pg_proc_proargmodes
Definition: pg_proc.h:111
#define RECORDOID
Definition: pg_type.h:680
bool argnull[FUNC_MAX_ARGS]
Definition: fmgr.h:86
MemoryContext CurrentMemoryContext
Definition: mcxt.c:37
uint32 LocalTransactionId
Definition: c.h:465
Datum fmgr_sql(PG_FUNCTION_ARGS)
Definition: functions.c:993
bool type_is_rowtype(Oid typid)
Definition: lsyscache.c:2409
List * returningList
Definition: parsenodes.h:144
#define lnext(lc)
Definition: pg_list.h:105
#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:690
Datum datumCopy(Datum value, bool typByVal, int typLen)
Definition: datum.c:128
const char * CreateCommandTag(Node *parsetree)
Definition: utility.c:2071
void ExecutorFinish(QueryDesc *queryDesc)
Definition: execMain.c:399
SQLFunctionParseInfoPtr pinfo
Definition: functions.c:96
bool IsBinaryCoercible(Oid srctype, Oid targettype)
struct ParamExternData ParamExternData
#define PROVOLATILE_VOLATILE
Definition: pg_proc.h:5582
List * lappend(List *list, void *datum)
Definition: list.c:128
int ExecCleanTargetListLength(List *targetlist)
Definition: execUtils.c:1044
TypeFuncClass get_func_result_type(Oid functionId, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:272
#define Anum_pg_proc_proargnames
Definition: pg_proc.h:112
#define TYPTYPE_RANGE
Definition: pg_type.h:725
#define AllocSetContextCreate(parent, name, allocparams)
Definition: memutils.h:165
DestReceiver * CreateSQLFunctionDestReceiver(void)
Definition: functions.c:1901
CmdType operation
Definition: execdesc.h:36
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1112
#define InvalidSnapshot
Definition: snapshot.h:25
TupleDesc tts_tupleDescriptor
Definition: tuptable.h:121
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:988
#define TextDatumGetCString(d)
Definition: builtins.h:92
bool canSetTag
Definition: plannodes.h:53
void * palloc0(Size size)
Definition: mcxt.c:864
ExecStatus
Definition: functions.c:58
Node * p_last_srf
Definition: parse_node.h:206
uintptr_t Datum
Definition: postgres.h:365
TupleTableSlot * ExecFilterJunk(JunkFilter *junkfilter, TupleTableSlot *slot)
Definition: execJunk.c:262
void CommandCounterIncrement(void)
Definition: xact.c:915
CmdType commandType
Definition: plannodes.h:45
Oid get_fn_expr_rettype(FmgrInfo *flinfo)
Definition: fmgr.c:1882
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1160
static void sqlfunction_shutdown(DestReceiver *self)
Definition: functions.c:1946
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1368
int number
Definition: parsenodes.h:244
int work_mem
Definition: globals.c:113
FormData_pg_proc * Form_pg_proc
Definition: pg_proc.h:83
QueryDesc * qd
Definition: functions.c:70
#define InvalidOid
Definition: postgres_ext.h:36
Oid fn_oid
Definition: fmgr.h:59
Oid get_typcollation(Oid typid)
Definition: lsyscache.c:2799
int allowedModes
Definition: execnodes.h:282
int internalerrquery(const char *query)
Definition: elog.c:1161
Datum arg[FUNC_MAX_ARGS]
Definition: fmgr.h:85
CmdType commandType
Definition: parsenodes.h:110
void(* rDestroy)(DestReceiver *self)
Definition: dest.h:126
int32 paramtypmod
Definition: primnodes.h:247
int location
Definition: parsenodes.h:245
SetFunctionReturnMode returnMode
Definition: execnodes.h:284
static Datum postquel_get_single_result(TupleTableSlot *slot, FunctionCallInfo fcinfo, SQLFunctionCachePtr fcache, MemoryContext resultcontext)
Definition: functions.c:950
#define makeNode(_type_)
Definition: nodes.h:561
bool tuplestore_gettupleslot(Tuplestorestate *state, bool forward, bool copy, TupleTableSlot *slot)
Definition: tuplestore.c:1078
#define HeapTupleIsValid(tuple)
Definition: htup.h:77
#define Assert(condition)
Definition: c.h:688
#define lfirst(lc)
Definition: pg_list.h:106
void RegisterExprContextCallback(ExprContext *econtext, ExprContextCallbackFunction function, Datum arg)
Definition: execUtils.c:767
void * p_ref_hook_state
Definition: parse_node.h:216
SubTransactionId GetCurrentSubTransactionId(void)
Definition: xact.c:642
fmNodePtr fn_expr
Definition: fmgr.h:66
bool hasModifyingCTE
Definition: plannodes.h:51
ParamListInfo paramLI
Definition: functions.c:107
Expr * expr
Definition: primnodes.h:1375
int paramid
Definition: primnodes.h:245
uint64 es_processed
Definition: execnodes.h:494
bool canSetTag
Definition: parsenodes.h:116
uint16 pflags
Definition: params.h:94
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:42
static int list_length(const List *l)
Definition: pg_list.h:89
void tuplestore_end(Tuplestorestate *state)
Definition: tuplestore.c:453
void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval)
Definition: lsyscache.c:2005
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:686
#define EXEC_FLAG_SKIP_TRIGGERS
Definition: executor.h:63
Tuplestorestate * setResult
Definition: execnodes.h:287
#define DatumGetPointer(X)
Definition: postgres.h:532
void * paramCompileArg
Definition: params.h:115
DestReceiver * dest
Definition: execdesc.h:41
ExprContext * econtext
Definition: execnodes.h:280
Node * setOperations
Definition: parsenodes.h:163
JunkFilter * filter
Definition: functions.c:46
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:2647
SQLFunctionCache * SQLFunctionCachePtr
Definition: functions.c:128
TupleDesc setDesc
Definition: execnodes.h:288
void * palloc(Size size)
Definition: mcxt.c:835
int errmsg(const char *fmt,...)
Definition: elog.c:797
int i
Datum slot_getattr(TupleTableSlot *slot, int attnum, bool *isnull)
Definition: heaptuple.c:1142
#define errcontext
Definition: elog.h:164
#define NameStr(name)
Definition: c.h:565
#define TYPTYPE_ENUM
Definition: pg_type.h:723
Index ressortgroupref
Definition: primnodes.h:1378
void * arg
#define lthird(l)
Definition: pg_list.h:121
static Node * sql_fn_make_param(SQLFunctionParseInfoPtr pinfo, int paramno, int location)
Definition: functions.c:420
#define PG_FUNCTION_ARGS
Definition: fmgr.h:158
#define elog
Definition: elog.h:219
PreParseColumnRefHook p_pre_columnref_hook
Definition: parse_node.h:212
ExprDoneCond isDone
Definition: execnodes.h:285
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
Datum ExecFetchSlotTupleDatum(TupleTableSlot *slot)
Definition: execTuples.c:734
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:845
struct SQLFunctionParseInfo SQLFunctionParseInfo
Definition: pg_list.h:45
bool isnull
Definition: params.h:93
int stmt_len
Definition: parsenodes.h:180
static void postquel_sub_params(SQLFunctionCachePtr fcache, FunctionCallInfo fcinfo)
Definition: functions.c:899
Oid paramtype
Definition: primnodes.h:246
#define offsetof(type, field)
Definition: c.h:611
int errposition(int cursorpos)
Definition: elog.c:1125
List * fields
Definition: parsenodes.h:234
static void init_sql_fcache(FmgrInfo *finfo, Oid collation, bool lazyEvalOK)
Definition: functions.c:595
static struct subre * parse(struct vars *, int, int, struct state *, struct state *)
Definition: regcomp.c:649
LocalTransactionId lxid
Definition: proc.h:106
int internalerrposition(int cursorpos)
Definition: elog.c:1141
Tuplestorestate * tstore
Definition: functions.c:44
PlannedStmt * pg_plan_query(Query *querytree, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:790