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