PostgreSQL Source Code  git master
funcapi.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * funcapi.c
4  * Utility and convenience functions for fmgr functions that return
5  * sets and/or composite types, or deal with VARIADIC inputs.
6  *
7  * Copyright (c) 2002-2024, PostgreSQL Global Development Group
8  *
9  * IDENTIFICATION
10  * src/backend/utils/fmgr/funcapi.c
11  *
12  *-------------------------------------------------------------------------
13  */
14 #include "postgres.h"
15 
16 #include "access/htup_details.h"
17 #include "access/relation.h"
18 #include "catalog/namespace.h"
19 #include "catalog/pg_proc.h"
20 #include "catalog/pg_type.h"
21 #include "funcapi.h"
22 #include "miscadmin.h"
23 #include "nodes/nodeFuncs.h"
24 #include "utils/array.h"
25 #include "utils/builtins.h"
26 #include "utils/lsyscache.h"
27 #include "utils/memutils.h"
28 #include "utils/regproc.h"
29 #include "utils/rel.h"
30 #include "utils/syscache.h"
31 #include "utils/tuplestore.h"
32 #include "utils/typcache.h"
33 
34 
35 typedef struct polymorphic_actuals
36 {
37  Oid anyelement_type; /* anyelement mapping, if known */
38  Oid anyarray_type; /* anyarray mapping, if known */
39  Oid anyrange_type; /* anyrange mapping, if known */
40  Oid anymultirange_type; /* anymultirange mapping, if known */
42 
43 static void shutdown_MultiFuncCall(Datum arg);
45  Node *call_expr,
46  ReturnSetInfo *rsinfo,
47  Oid *resultTypeId,
48  TupleDesc *resultTupleDesc);
53 static bool resolve_polymorphic_tupdesc(TupleDesc tupdesc,
54  oidvector *declared_args,
55  Node *call_expr);
56 static TypeFuncClass get_type_func_class(Oid typid, Oid *base_typeid);
57 
58 
59 /*
60  * InitMaterializedSRF
61  *
62  * Helper function to build the state of a set-returning function used
63  * in the context of a single call with materialize mode. This code
64  * includes sanity checks on ReturnSetInfo, creates the Tuplestore and
65  * the TupleDesc used with the function and stores them into the
66  * function's ReturnSetInfo.
67  *
68  * "flags" can be set to MAT_SRF_USE_EXPECTED_DESC, to use the tuple
69  * descriptor coming from expectedDesc, which is the tuple descriptor
70  * expected by the caller. MAT_SRF_BLESS can be set to complete the
71  * information associated to the tuple descriptor, which is necessary
72  * in some cases where the tuple descriptor comes from a transient
73  * RECORD datatype.
74  */
75 void
77 {
78  bool random_access;
79  ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
80  Tuplestorestate *tupstore;
81  MemoryContext old_context,
82  per_query_ctx;
83  TupleDesc stored_tupdesc;
84 
85  /* check to see if caller supports returning a tuplestore */
86  if (rsinfo == NULL || !IsA(rsinfo, ReturnSetInfo))
87  ereport(ERROR,
88  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
89  errmsg("set-valued function called in context that cannot accept a set")));
90  if (!(rsinfo->allowedModes & SFRM_Materialize) ||
91  ((flags & MAT_SRF_USE_EXPECTED_DESC) != 0 && rsinfo->expectedDesc == NULL))
92  ereport(ERROR,
93  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
94  errmsg("materialize mode required, but it is not allowed in this context")));
95 
96  /*
97  * Store the tuplestore and the tuple descriptor in ReturnSetInfo. This
98  * must be done in the per-query memory context.
99  */
100  per_query_ctx = rsinfo->econtext->ecxt_per_query_memory;
101  old_context = MemoryContextSwitchTo(per_query_ctx);
102 
103  /* build a tuple descriptor for our result type */
104  if ((flags & MAT_SRF_USE_EXPECTED_DESC) != 0)
105  stored_tupdesc = CreateTupleDescCopy(rsinfo->expectedDesc);
106  else
107  {
108  if (get_call_result_type(fcinfo, NULL, &stored_tupdesc) != TYPEFUNC_COMPOSITE)
109  elog(ERROR, "return type must be a row type");
110  }
111 
112  /* If requested, bless the tuple descriptor */
113  if ((flags & MAT_SRF_BLESS) != 0)
114  BlessTupleDesc(stored_tupdesc);
115 
116  random_access = (rsinfo->allowedModes & SFRM_Materialize_Random) != 0;
117 
118  tupstore = tuplestore_begin_heap(random_access, false, work_mem);
119  rsinfo->returnMode = SFRM_Materialize;
120  rsinfo->setResult = tupstore;
121  rsinfo->setDesc = stored_tupdesc;
122  MemoryContextSwitchTo(old_context);
123 }
124 
125 
126 /*
127  * init_MultiFuncCall
128  * Create an empty FuncCallContext data structure
129  * and do some other basic Multi-function call setup
130  * and error checking
131  */
134 {
135  FuncCallContext *retval;
136 
137  /*
138  * Bail if we're called in the wrong context
139  */
140  if (fcinfo->resultinfo == NULL || !IsA(fcinfo->resultinfo, ReturnSetInfo))
141  ereport(ERROR,
142  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
143  errmsg("set-valued function called in context that cannot accept a set")));
144 
145  if (fcinfo->flinfo->fn_extra == NULL)
146  {
147  /*
148  * First call
149  */
150  ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
151  MemoryContext multi_call_ctx;
152 
153  /*
154  * Create a suitably long-lived context to hold cross-call data
155  */
156  multi_call_ctx = AllocSetContextCreate(fcinfo->flinfo->fn_mcxt,
157  "SRF multi-call context",
159 
160  /*
161  * Allocate suitably long-lived space and zero it
162  */
163  retval = (FuncCallContext *)
164  MemoryContextAllocZero(multi_call_ctx,
165  sizeof(FuncCallContext));
166 
167  /*
168  * initialize the elements
169  */
170  retval->call_cntr = 0;
171  retval->max_calls = 0;
172  retval->user_fctx = NULL;
173  retval->attinmeta = NULL;
174  retval->tuple_desc = NULL;
175  retval->multi_call_memory_ctx = multi_call_ctx;
176 
177  /*
178  * save the pointer for cross-call use
179  */
180  fcinfo->flinfo->fn_extra = retval;
181 
182  /*
183  * Ensure we will get shut down cleanly if the exprcontext is not run
184  * to completion.
185  */
188  PointerGetDatum(fcinfo->flinfo));
189  }
190  else
191  {
192  /* second and subsequent calls */
193  elog(ERROR, "init_MultiFuncCall cannot be called more than once");
194 
195  /* never reached, but keep compiler happy */
196  retval = NULL;
197  }
198 
199  return retval;
200 }
201 
202 /*
203  * per_MultiFuncCall
204  *
205  * Do Multi-function per-call setup
206  */
209 {
210  FuncCallContext *retval = (FuncCallContext *) fcinfo->flinfo->fn_extra;
211 
212  return retval;
213 }
214 
215 /*
216  * end_MultiFuncCall
217  * Clean up after init_MultiFuncCall
218  */
219 void
221 {
222  ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
223 
224  /* Deregister the shutdown callback */
227  PointerGetDatum(fcinfo->flinfo));
228 
229  /* But use it to do the real work */
230  shutdown_MultiFuncCall(PointerGetDatum(fcinfo->flinfo));
231 }
232 
233 /*
234  * shutdown_MultiFuncCall
235  * Shutdown function to clean up after init_MultiFuncCall
236  */
237 static void
239 {
240  FmgrInfo *flinfo = (FmgrInfo *) DatumGetPointer(arg);
241  FuncCallContext *funcctx = (FuncCallContext *) flinfo->fn_extra;
242 
243  /* unbind from flinfo */
244  flinfo->fn_extra = NULL;
245 
246  /*
247  * Delete context that holds all multi-call data, including the
248  * FuncCallContext itself
249  */
251 }
252 
253 
254 /*
255  * get_call_result_type
256  * Given a function's call info record, determine the kind of datatype
257  * it is supposed to return. If resultTypeId isn't NULL, *resultTypeId
258  * receives the actual datatype OID (this is mainly useful for scalar
259  * result types). If resultTupleDesc isn't NULL, *resultTupleDesc
260  * receives a pointer to a TupleDesc when the result is of a composite
261  * type, or NULL when it's a scalar result.
262  *
263  * One hard case that this handles is resolution of actual rowtypes for
264  * functions returning RECORD (from either the function's OUT parameter
265  * list, or a ReturnSetInfo context node). TYPEFUNC_RECORD is returned
266  * only when we couldn't resolve the actual rowtype for lack of information.
267  *
268  * The other hard case that this handles is resolution of polymorphism.
269  * We will never return polymorphic pseudotypes (ANYELEMENT etc), either
270  * as a scalar result type or as a component of a rowtype.
271  *
272  * This function is relatively expensive --- in a function returning set,
273  * try to call it only the first time through.
274  */
277  Oid *resultTypeId,
278  TupleDesc *resultTupleDesc)
279 {
280  return internal_get_result_type(fcinfo->flinfo->fn_oid,
281  fcinfo->flinfo->fn_expr,
282  (ReturnSetInfo *) fcinfo->resultinfo,
283  resultTypeId,
284  resultTupleDesc);
285 }
286 
287 /*
288  * get_expr_result_type
289  * As above, but work from a calling expression node tree
290  */
293  Oid *resultTypeId,
294  TupleDesc *resultTupleDesc)
295 {
296  TypeFuncClass result;
297 
298  if (expr && IsA(expr, FuncExpr))
299  result = internal_get_result_type(((FuncExpr *) expr)->funcid,
300  expr,
301  NULL,
302  resultTypeId,
303  resultTupleDesc);
304  else if (expr && IsA(expr, OpExpr))
305  result = internal_get_result_type(get_opcode(((OpExpr *) expr)->opno),
306  expr,
307  NULL,
308  resultTypeId,
309  resultTupleDesc);
310  else if (expr && IsA(expr, RowExpr) &&
311  ((RowExpr *) expr)->row_typeid == RECORDOID)
312  {
313  /* We can resolve the record type by generating the tupdesc directly */
314  RowExpr *rexpr = (RowExpr *) expr;
315  TupleDesc tupdesc;
316  AttrNumber i = 1;
317  ListCell *lcc,
318  *lcn;
319 
320  tupdesc = CreateTemplateTupleDesc(list_length(rexpr->args));
321  Assert(list_length(rexpr->args) == list_length(rexpr->colnames));
322  forboth(lcc, rexpr->args, lcn, rexpr->colnames)
323  {
324  Node *col = (Node *) lfirst(lcc);
325  char *colname = strVal(lfirst(lcn));
326 
327  TupleDescInitEntry(tupdesc, i,
328  colname,
329  exprType(col),
330  exprTypmod(col),
331  0);
333  exprCollation(col));
334  i++;
335  }
336  if (resultTypeId)
337  *resultTypeId = rexpr->row_typeid;
338  if (resultTupleDesc)
339  *resultTupleDesc = BlessTupleDesc(tupdesc);
340  return TYPEFUNC_COMPOSITE;
341  }
342  else if (expr && IsA(expr, Const) &&
343  ((Const *) expr)->consttype == RECORDOID &&
344  !((Const *) expr)->constisnull)
345  {
346  /*
347  * When EXPLAIN'ing some queries with SEARCH/CYCLE clauses, we may
348  * need to resolve field names of a RECORD-type Const. The datum
349  * should contain a typmod that will tell us that.
350  */
351  HeapTupleHeader rec;
352  Oid tupType;
353  int32 tupTypmod;
354 
355  rec = DatumGetHeapTupleHeader(((Const *) expr)->constvalue);
356  tupType = HeapTupleHeaderGetTypeId(rec);
357  tupTypmod = HeapTupleHeaderGetTypMod(rec);
358  if (resultTypeId)
359  *resultTypeId = tupType;
360  if (tupType != RECORDOID || tupTypmod >= 0)
361  {
362  /* Should be able to look it up */
363  if (resultTupleDesc)
364  *resultTupleDesc = lookup_rowtype_tupdesc_copy(tupType,
365  tupTypmod);
366  return TYPEFUNC_COMPOSITE;
367  }
368  else
369  {
370  /* This shouldn't really happen ... */
371  if (resultTupleDesc)
372  *resultTupleDesc = NULL;
373  return TYPEFUNC_RECORD;
374  }
375  }
376  else
377  {
378  /* handle as a generic expression; no chance to resolve RECORD */
379  Oid typid = exprType(expr);
380  Oid base_typid;
381 
382  if (resultTypeId)
383  *resultTypeId = typid;
384  if (resultTupleDesc)
385  *resultTupleDesc = NULL;
386  result = get_type_func_class(typid, &base_typid);
387  if ((result == TYPEFUNC_COMPOSITE ||
388  result == TYPEFUNC_COMPOSITE_DOMAIN) &&
389  resultTupleDesc)
390  *resultTupleDesc = lookup_rowtype_tupdesc_copy(base_typid, -1);
391  }
392 
393  return result;
394 }
395 
396 /*
397  * get_func_result_type
398  * As above, but work from a function's OID only
399  *
400  * This will not be able to resolve pure-RECORD results nor polymorphism.
401  */
404  Oid *resultTypeId,
405  TupleDesc *resultTupleDesc)
406 {
407  return internal_get_result_type(functionId,
408  NULL,
409  NULL,
410  resultTypeId,
411  resultTupleDesc);
412 }
413 
414 /*
415  * internal_get_result_type -- workhorse code implementing all the above
416  *
417  * funcid must always be supplied. call_expr and rsinfo can be NULL if not
418  * available. We will return TYPEFUNC_RECORD, and store NULL into
419  * *resultTupleDesc, if we cannot deduce the complete result rowtype from
420  * the available information.
421  */
422 static TypeFuncClass
424  Node *call_expr,
425  ReturnSetInfo *rsinfo,
426  Oid *resultTypeId,
427  TupleDesc *resultTupleDesc)
428 {
429  TypeFuncClass result;
430  HeapTuple tp;
431  Form_pg_proc procform;
432  Oid rettype;
433  Oid base_rettype;
434  TupleDesc tupdesc;
435 
436  /* First fetch the function's pg_proc row to inspect its rettype */
437  tp = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcid));
438  if (!HeapTupleIsValid(tp))
439  elog(ERROR, "cache lookup failed for function %u", funcid);
440  procform = (Form_pg_proc) GETSTRUCT(tp);
441 
442  rettype = procform->prorettype;
443 
444  /* Check for OUT parameters defining a RECORD result */
445  tupdesc = build_function_result_tupdesc_t(tp);
446  if (tupdesc)
447  {
448  /*
449  * It has OUT parameters, so it's basically like a regular composite
450  * type, except we have to be able to resolve any polymorphic OUT
451  * parameters.
452  */
453  if (resultTypeId)
454  *resultTypeId = rettype;
455 
456  if (resolve_polymorphic_tupdesc(tupdesc,
457  &procform->proargtypes,
458  call_expr))
459  {
460  if (tupdesc->tdtypeid == RECORDOID &&
461  tupdesc->tdtypmod < 0)
462  assign_record_type_typmod(tupdesc);
463  if (resultTupleDesc)
464  *resultTupleDesc = tupdesc;
465  result = TYPEFUNC_COMPOSITE;
466  }
467  else
468  {
469  if (resultTupleDesc)
470  *resultTupleDesc = NULL;
471  result = TYPEFUNC_RECORD;
472  }
473 
474  ReleaseSysCache(tp);
475 
476  return result;
477  }
478 
479  /*
480  * If scalar polymorphic result, try to resolve it.
481  */
482  if (IsPolymorphicType(rettype))
483  {
484  Oid newrettype = exprType(call_expr);
485 
486  if (newrettype == InvalidOid) /* this probably should not happen */
487  ereport(ERROR,
488  (errcode(ERRCODE_DATATYPE_MISMATCH),
489  errmsg("could not determine actual result type for function \"%s\" declared to return type %s",
490  NameStr(procform->proname),
491  format_type_be(rettype))));
492  rettype = newrettype;
493  }
494 
495  if (resultTypeId)
496  *resultTypeId = rettype;
497  if (resultTupleDesc)
498  *resultTupleDesc = NULL; /* default result */
499 
500  /* Classify the result type */
501  result = get_type_func_class(rettype, &base_rettype);
502  switch (result)
503  {
504  case TYPEFUNC_COMPOSITE:
506  if (resultTupleDesc)
507  *resultTupleDesc = lookup_rowtype_tupdesc_copy(base_rettype, -1);
508  /* Named composite types can't have any polymorphic columns */
509  break;
510  case TYPEFUNC_SCALAR:
511  break;
512  case TYPEFUNC_RECORD:
513  /* We must get the tupledesc from call context */
514  if (rsinfo && IsA(rsinfo, ReturnSetInfo) &&
515  rsinfo->expectedDesc != NULL)
516  {
517  result = TYPEFUNC_COMPOSITE;
518  if (resultTupleDesc)
519  *resultTupleDesc = rsinfo->expectedDesc;
520  /* Assume no polymorphic columns here, either */
521  }
522  break;
523  default:
524  break;
525  }
526 
527  ReleaseSysCache(tp);
528 
529  return result;
530 }
531 
532 /*
533  * get_expr_result_tupdesc
534  * Get a tupdesc describing the result of a composite-valued expression
535  *
536  * If expression is not composite or rowtype can't be determined, returns NULL
537  * if noError is true, else throws error.
538  *
539  * This is a simpler version of get_expr_result_type() for use when the caller
540  * is only interested in determinate rowtype results.
541  */
542 TupleDesc
543 get_expr_result_tupdesc(Node *expr, bool noError)
544 {
545  TupleDesc tupleDesc;
546  TypeFuncClass functypclass;
547 
548  functypclass = get_expr_result_type(expr, NULL, &tupleDesc);
549 
550  if (functypclass == TYPEFUNC_COMPOSITE ||
551  functypclass == TYPEFUNC_COMPOSITE_DOMAIN)
552  return tupleDesc;
553 
554  if (!noError)
555  {
556  Oid exprTypeId = exprType(expr);
557 
558  if (exprTypeId != RECORDOID)
559  ereport(ERROR,
560  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
561  errmsg("type %s is not composite",
562  format_type_be(exprTypeId))));
563  else
564  ereport(ERROR,
565  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
566  errmsg("record type has not been registered")));
567  }
568 
569  return NULL;
570 }
571 
572 /*
573  * Resolve actual type of ANYELEMENT from other polymorphic inputs
574  *
575  * Note: the error cases here and in the sibling functions below are not
576  * really user-facing; they could only occur if the function signature is
577  * incorrect or the parser failed to enforce consistency of the actual
578  * argument types. Hence, we don't sweat too much over the error messages.
579  */
580 static void
582 {
583  if (OidIsValid(actuals->anyarray_type))
584  {
585  /* Use the element type corresponding to actual type */
586  Oid array_base_type = getBaseType(actuals->anyarray_type);
587  Oid array_typelem = get_element_type(array_base_type);
588 
589  if (!OidIsValid(array_typelem))
590  ereport(ERROR,
591  (errcode(ERRCODE_DATATYPE_MISMATCH),
592  errmsg("argument declared %s is not an array but type %s",
593  "anyarray",
594  format_type_be(array_base_type))));
595  actuals->anyelement_type = array_typelem;
596  }
597  else if (OidIsValid(actuals->anyrange_type))
598  {
599  /* Use the element type corresponding to actual type */
600  Oid range_base_type = getBaseType(actuals->anyrange_type);
601  Oid range_typelem = get_range_subtype(range_base_type);
602 
603  if (!OidIsValid(range_typelem))
604  ereport(ERROR,
605  (errcode(ERRCODE_DATATYPE_MISMATCH),
606  errmsg("argument declared %s is not a range type but type %s",
607  "anyrange",
608  format_type_be(range_base_type))));
609  actuals->anyelement_type = range_typelem;
610  }
611  else if (OidIsValid(actuals->anymultirange_type))
612  {
613  /* Use the element type based on the multirange type */
614  Oid multirange_base_type;
615  Oid multirange_typelem;
616  Oid range_base_type;
617  Oid range_typelem;
618 
619  multirange_base_type = getBaseType(actuals->anymultirange_type);
620  multirange_typelem = get_multirange_range(multirange_base_type);
621  if (!OidIsValid(multirange_typelem))
622  ereport(ERROR,
623  (errcode(ERRCODE_DATATYPE_MISMATCH),
624  errmsg("argument declared %s is not a multirange type but type %s",
625  "anymultirange",
626  format_type_be(multirange_base_type))));
627 
628  range_base_type = getBaseType(multirange_typelem);
629  range_typelem = get_range_subtype(range_base_type);
630 
631  if (!OidIsValid(range_typelem))
632  ereport(ERROR,
633  (errcode(ERRCODE_DATATYPE_MISMATCH),
634  errmsg("argument declared %s does not contain a range type but type %s",
635  "anymultirange",
636  format_type_be(range_base_type))));
637  actuals->anyelement_type = range_typelem;
638  }
639  else
640  elog(ERROR, "could not determine polymorphic type");
641 }
642 
643 /*
644  * Resolve actual type of ANYARRAY from other polymorphic inputs
645  */
646 static void
648 {
649  /* If we don't know ANYELEMENT, resolve that first */
650  if (!OidIsValid(actuals->anyelement_type))
652 
653  if (OidIsValid(actuals->anyelement_type))
654  {
655  /* Use the array type corresponding to actual type */
656  Oid array_typeid = get_array_type(actuals->anyelement_type);
657 
658  if (!OidIsValid(array_typeid))
659  ereport(ERROR,
660  (errcode(ERRCODE_UNDEFINED_OBJECT),
661  errmsg("could not find array type for data type %s",
662  format_type_be(actuals->anyelement_type))));
663  actuals->anyarray_type = array_typeid;
664  }
665  else
666  elog(ERROR, "could not determine polymorphic type");
667 }
668 
669 /*
670  * Resolve actual type of ANYRANGE from other polymorphic inputs
671  */
672 static void
674 {
675  /*
676  * We can't deduce a range type from other polymorphic array or base
677  * types, because there may be multiple range types with the same subtype,
678  * but we can deduce it from a polymorphic multirange type.
679  */
680  if (OidIsValid(actuals->anymultirange_type))
681  {
682  /* Use the element type based on the multirange type */
683  Oid multirange_base_type = getBaseType(actuals->anymultirange_type);
684  Oid multirange_typelem = get_multirange_range(multirange_base_type);
685 
686  if (!OidIsValid(multirange_typelem))
687  ereport(ERROR,
688  (errcode(ERRCODE_DATATYPE_MISMATCH),
689  errmsg("argument declared %s is not a multirange type but type %s",
690  "anymultirange",
691  format_type_be(multirange_base_type))));
692  actuals->anyrange_type = multirange_typelem;
693  }
694  else
695  elog(ERROR, "could not determine polymorphic type");
696 }
697 
698 /*
699  * Resolve actual type of ANYMULTIRANGE from other polymorphic inputs
700  */
701 static void
703 {
704  /*
705  * We can't deduce a multirange type from polymorphic array or base types,
706  * because there may be multiple range types with the same subtype, but we
707  * can deduce it from a polymorphic range type.
708  */
709  if (OidIsValid(actuals->anyrange_type))
710  {
711  Oid range_base_type = getBaseType(actuals->anyrange_type);
712  Oid multirange_typeid = get_range_multirange(range_base_type);
713 
714  if (!OidIsValid(multirange_typeid))
715  ereport(ERROR,
716  (errcode(ERRCODE_UNDEFINED_OBJECT),
717  errmsg("could not find multirange type for data type %s",
718  format_type_be(actuals->anyrange_type))));
719  actuals->anymultirange_type = multirange_typeid;
720  }
721  else
722  elog(ERROR, "could not determine polymorphic type");
723 }
724 
725 /*
726  * Given the result tuple descriptor for a function with OUT parameters,
727  * replace any polymorphic column types (ANYELEMENT etc) in the tupdesc
728  * with concrete data types deduced from the input arguments.
729  * declared_args is an oidvector of the function's declared input arg types
730  * (showing which are polymorphic), and call_expr is the call expression.
731  *
732  * Returns true if able to deduce all types, false if necessary information
733  * is not provided (call_expr is NULL or arg types aren't identifiable).
734  */
735 static bool
737  Node *call_expr)
738 {
739  int natts = tupdesc->natts;
740  int nargs = declared_args->dim1;
741  bool have_polymorphic_result = false;
742  bool have_anyelement_result = false;
743  bool have_anyarray_result = false;
744  bool have_anyrange_result = false;
745  bool have_anymultirange_result = false;
746  bool have_anycompatible_result = false;
747  bool have_anycompatible_array_result = false;
748  bool have_anycompatible_range_result = false;
749  bool have_anycompatible_multirange_result = false;
750  polymorphic_actuals poly_actuals;
751  polymorphic_actuals anyc_actuals;
752  Oid anycollation = InvalidOid;
753  Oid anycompatcollation = InvalidOid;
754  int i;
755 
756  /* See if there are any polymorphic outputs; quick out if not */
757  for (i = 0; i < natts; i++)
758  {
759  switch (TupleDescAttr(tupdesc, i)->atttypid)
760  {
761  case ANYELEMENTOID:
762  case ANYNONARRAYOID:
763  case ANYENUMOID:
764  have_polymorphic_result = true;
765  have_anyelement_result = true;
766  break;
767  case ANYARRAYOID:
768  have_polymorphic_result = true;
769  have_anyarray_result = true;
770  break;
771  case ANYRANGEOID:
772  have_polymorphic_result = true;
773  have_anyrange_result = true;
774  break;
775  case ANYMULTIRANGEOID:
776  have_polymorphic_result = true;
777  have_anymultirange_result = true;
778  break;
779  case ANYCOMPATIBLEOID:
780  case ANYCOMPATIBLENONARRAYOID:
781  have_polymorphic_result = true;
782  have_anycompatible_result = true;
783  break;
784  case ANYCOMPATIBLEARRAYOID:
785  have_polymorphic_result = true;
786  have_anycompatible_array_result = true;
787  break;
788  case ANYCOMPATIBLERANGEOID:
789  have_polymorphic_result = true;
790  have_anycompatible_range_result = true;
791  break;
792  case ANYCOMPATIBLEMULTIRANGEOID:
793  have_polymorphic_result = true;
794  have_anycompatible_multirange_result = true;
795  break;
796  default:
797  break;
798  }
799  }
800  if (!have_polymorphic_result)
801  return true;
802 
803  /*
804  * Otherwise, extract actual datatype(s) from input arguments. (We assume
805  * the parser already validated consistency of the arguments. Also, for
806  * the ANYCOMPATIBLE pseudotype family, we expect that all matching
807  * arguments were coerced to the selected common supertype, so that it
808  * doesn't matter which one's exposed type we look at.)
809  */
810  if (!call_expr)
811  return false; /* no hope */
812 
813  memset(&poly_actuals, 0, sizeof(poly_actuals));
814  memset(&anyc_actuals, 0, sizeof(anyc_actuals));
815 
816  for (i = 0; i < nargs; i++)
817  {
818  switch (declared_args->values[i])
819  {
820  case ANYELEMENTOID:
821  case ANYNONARRAYOID:
822  case ANYENUMOID:
823  if (!OidIsValid(poly_actuals.anyelement_type))
824  {
825  poly_actuals.anyelement_type =
826  get_call_expr_argtype(call_expr, i);
827  if (!OidIsValid(poly_actuals.anyelement_type))
828  return false;
829  }
830  break;
831  case ANYARRAYOID:
832  if (!OidIsValid(poly_actuals.anyarray_type))
833  {
834  poly_actuals.anyarray_type =
835  get_call_expr_argtype(call_expr, i);
836  if (!OidIsValid(poly_actuals.anyarray_type))
837  return false;
838  }
839  break;
840  case ANYRANGEOID:
841  if (!OidIsValid(poly_actuals.anyrange_type))
842  {
843  poly_actuals.anyrange_type =
844  get_call_expr_argtype(call_expr, i);
845  if (!OidIsValid(poly_actuals.anyrange_type))
846  return false;
847  }
848  break;
849  case ANYMULTIRANGEOID:
850  if (!OidIsValid(poly_actuals.anymultirange_type))
851  {
852  poly_actuals.anymultirange_type =
853  get_call_expr_argtype(call_expr, i);
854  if (!OidIsValid(poly_actuals.anymultirange_type))
855  return false;
856  }
857  break;
858  case ANYCOMPATIBLEOID:
859  case ANYCOMPATIBLENONARRAYOID:
860  if (!OidIsValid(anyc_actuals.anyelement_type))
861  {
862  anyc_actuals.anyelement_type =
863  get_call_expr_argtype(call_expr, i);
864  if (!OidIsValid(anyc_actuals.anyelement_type))
865  return false;
866  }
867  break;
868  case ANYCOMPATIBLEARRAYOID:
869  if (!OidIsValid(anyc_actuals.anyarray_type))
870  {
871  anyc_actuals.anyarray_type =
872  get_call_expr_argtype(call_expr, i);
873  if (!OidIsValid(anyc_actuals.anyarray_type))
874  return false;
875  }
876  break;
877  case ANYCOMPATIBLERANGEOID:
878  if (!OidIsValid(anyc_actuals.anyrange_type))
879  {
880  anyc_actuals.anyrange_type =
881  get_call_expr_argtype(call_expr, i);
882  if (!OidIsValid(anyc_actuals.anyrange_type))
883  return false;
884  }
885  break;
886  case ANYCOMPATIBLEMULTIRANGEOID:
887  if (!OidIsValid(anyc_actuals.anymultirange_type))
888  {
889  anyc_actuals.anymultirange_type =
890  get_call_expr_argtype(call_expr, i);
891  if (!OidIsValid(anyc_actuals.anymultirange_type))
892  return false;
893  }
894  break;
895  default:
896  break;
897  }
898  }
899 
900  /* If needed, deduce one polymorphic type from others */
901  if (have_anyelement_result && !OidIsValid(poly_actuals.anyelement_type))
902  resolve_anyelement_from_others(&poly_actuals);
903 
904  if (have_anyarray_result && !OidIsValid(poly_actuals.anyarray_type))
905  resolve_anyarray_from_others(&poly_actuals);
906 
907  if (have_anyrange_result && !OidIsValid(poly_actuals.anyrange_type))
908  resolve_anyrange_from_others(&poly_actuals);
909 
910  if (have_anymultirange_result && !OidIsValid(poly_actuals.anymultirange_type))
911  resolve_anymultirange_from_others(&poly_actuals);
912 
913  if (have_anycompatible_result && !OidIsValid(anyc_actuals.anyelement_type))
914  resolve_anyelement_from_others(&anyc_actuals);
915 
916  if (have_anycompatible_array_result && !OidIsValid(anyc_actuals.anyarray_type))
917  resolve_anyarray_from_others(&anyc_actuals);
918 
919  if (have_anycompatible_range_result && !OidIsValid(anyc_actuals.anyrange_type))
920  resolve_anyrange_from_others(&anyc_actuals);
921 
922  if (have_anycompatible_multirange_result && !OidIsValid(anyc_actuals.anymultirange_type))
923  resolve_anymultirange_from_others(&anyc_actuals);
924 
925  /*
926  * Identify the collation to use for polymorphic OUT parameters. (It'll
927  * necessarily be the same for both anyelement and anyarray, likewise for
928  * anycompatible and anycompatiblearray.) Note that range types are not
929  * collatable, so any possible internal collation of a range type is not
930  * considered here.
931  */
932  if (OidIsValid(poly_actuals.anyelement_type))
933  anycollation = get_typcollation(poly_actuals.anyelement_type);
934  else if (OidIsValid(poly_actuals.anyarray_type))
935  anycollation = get_typcollation(poly_actuals.anyarray_type);
936 
937  if (OidIsValid(anyc_actuals.anyelement_type))
938  anycompatcollation = get_typcollation(anyc_actuals.anyelement_type);
939  else if (OidIsValid(anyc_actuals.anyarray_type))
940  anycompatcollation = get_typcollation(anyc_actuals.anyarray_type);
941 
942  if (OidIsValid(anycollation) || OidIsValid(anycompatcollation))
943  {
944  /*
945  * The types are collatable, so consider whether to use a nondefault
946  * collation. We do so if we can identify the input collation used
947  * for the function.
948  */
949  Oid inputcollation = exprInputCollation(call_expr);
950 
951  if (OidIsValid(inputcollation))
952  {
953  if (OidIsValid(anycollation))
954  anycollation = inputcollation;
955  if (OidIsValid(anycompatcollation))
956  anycompatcollation = inputcollation;
957  }
958  }
959 
960  /* And finally replace the tuple column types as needed */
961  for (i = 0; i < natts; i++)
962  {
963  Form_pg_attribute att = TupleDescAttr(tupdesc, i);
964 
965  switch (att->atttypid)
966  {
967  case ANYELEMENTOID:
968  case ANYNONARRAYOID:
969  case ANYENUMOID:
970  TupleDescInitEntry(tupdesc, i + 1,
971  NameStr(att->attname),
972  poly_actuals.anyelement_type,
973  -1,
974  0);
975  TupleDescInitEntryCollation(tupdesc, i + 1, anycollation);
976  break;
977  case ANYARRAYOID:
978  TupleDescInitEntry(tupdesc, i + 1,
979  NameStr(att->attname),
980  poly_actuals.anyarray_type,
981  -1,
982  0);
983  TupleDescInitEntryCollation(tupdesc, i + 1, anycollation);
984  break;
985  case ANYRANGEOID:
986  TupleDescInitEntry(tupdesc, i + 1,
987  NameStr(att->attname),
988  poly_actuals.anyrange_type,
989  -1,
990  0);
991  /* no collation should be attached to a range type */
992  break;
993  case ANYMULTIRANGEOID:
994  TupleDescInitEntry(tupdesc, i + 1,
995  NameStr(att->attname),
996  poly_actuals.anymultirange_type,
997  -1,
998  0);
999  /* no collation should be attached to a multirange type */
1000  break;
1001  case ANYCOMPATIBLEOID:
1002  case ANYCOMPATIBLENONARRAYOID:
1003  TupleDescInitEntry(tupdesc, i + 1,
1004  NameStr(att->attname),
1005  anyc_actuals.anyelement_type,
1006  -1,
1007  0);
1008  TupleDescInitEntryCollation(tupdesc, i + 1, anycompatcollation);
1009  break;
1010  case ANYCOMPATIBLEARRAYOID:
1011  TupleDescInitEntry(tupdesc, i + 1,
1012  NameStr(att->attname),
1013  anyc_actuals.anyarray_type,
1014  -1,
1015  0);
1016  TupleDescInitEntryCollation(tupdesc, i + 1, anycompatcollation);
1017  break;
1018  case ANYCOMPATIBLERANGEOID:
1019  TupleDescInitEntry(tupdesc, i + 1,
1020  NameStr(att->attname),
1021  anyc_actuals.anyrange_type,
1022  -1,
1023  0);
1024  /* no collation should be attached to a range type */
1025  break;
1026  case ANYCOMPATIBLEMULTIRANGEOID:
1027  TupleDescInitEntry(tupdesc, i + 1,
1028  NameStr(att->attname),
1029  anyc_actuals.anymultirange_type,
1030  -1,
1031  0);
1032  /* no collation should be attached to a multirange type */
1033  break;
1034  default:
1035  break;
1036  }
1037  }
1038 
1039  return true;
1040 }
1041 
1042 /*
1043  * Given the declared argument types and modes for a function, replace any
1044  * polymorphic types (ANYELEMENT etc) in argtypes[] with concrete data types
1045  * deduced from the input arguments found in call_expr.
1046  *
1047  * Returns true if able to deduce all types, false if necessary information
1048  * is not provided (call_expr is NULL or arg types aren't identifiable).
1049  *
1050  * This is the same logic as resolve_polymorphic_tupdesc, but with a different
1051  * argument representation, and slightly different output responsibilities.
1052  *
1053  * argmodes may be NULL, in which case all arguments are assumed to be IN mode.
1054  */
1055 bool
1056 resolve_polymorphic_argtypes(int numargs, Oid *argtypes, char *argmodes,
1057  Node *call_expr)
1058 {
1059  bool have_polymorphic_result = false;
1060  bool have_anyelement_result = false;
1061  bool have_anyarray_result = false;
1062  bool have_anyrange_result = false;
1063  bool have_anymultirange_result = false;
1064  bool have_anycompatible_result = false;
1065  bool have_anycompatible_array_result = false;
1066  bool have_anycompatible_range_result = false;
1067  bool have_anycompatible_multirange_result = false;
1068  polymorphic_actuals poly_actuals;
1069  polymorphic_actuals anyc_actuals;
1070  int inargno;
1071  int i;
1072 
1073  /*
1074  * First pass: resolve polymorphic inputs, check for outputs. As in
1075  * resolve_polymorphic_tupdesc, we rely on the parser to have enforced
1076  * type consistency and coerced ANYCOMPATIBLE args to a common supertype.
1077  */
1078  memset(&poly_actuals, 0, sizeof(poly_actuals));
1079  memset(&anyc_actuals, 0, sizeof(anyc_actuals));
1080  inargno = 0;
1081  for (i = 0; i < numargs; i++)
1082  {
1083  char argmode = argmodes ? argmodes[i] : PROARGMODE_IN;
1084 
1085  switch (argtypes[i])
1086  {
1087  case ANYELEMENTOID:
1088  case ANYNONARRAYOID:
1089  case ANYENUMOID:
1090  if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1091  {
1092  have_polymorphic_result = true;
1093  have_anyelement_result = true;
1094  }
1095  else
1096  {
1097  if (!OidIsValid(poly_actuals.anyelement_type))
1098  {
1099  poly_actuals.anyelement_type =
1100  get_call_expr_argtype(call_expr, inargno);
1101  if (!OidIsValid(poly_actuals.anyelement_type))
1102  return false;
1103  }
1104  argtypes[i] = poly_actuals.anyelement_type;
1105  }
1106  break;
1107  case ANYARRAYOID:
1108  if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1109  {
1110  have_polymorphic_result = true;
1111  have_anyarray_result = true;
1112  }
1113  else
1114  {
1115  if (!OidIsValid(poly_actuals.anyarray_type))
1116  {
1117  poly_actuals.anyarray_type =
1118  get_call_expr_argtype(call_expr, inargno);
1119  if (!OidIsValid(poly_actuals.anyarray_type))
1120  return false;
1121  }
1122  argtypes[i] = poly_actuals.anyarray_type;
1123  }
1124  break;
1125  case ANYRANGEOID:
1126  if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1127  {
1128  have_polymorphic_result = true;
1129  have_anyrange_result = true;
1130  }
1131  else
1132  {
1133  if (!OidIsValid(poly_actuals.anyrange_type))
1134  {
1135  poly_actuals.anyrange_type =
1136  get_call_expr_argtype(call_expr, inargno);
1137  if (!OidIsValid(poly_actuals.anyrange_type))
1138  return false;
1139  }
1140  argtypes[i] = poly_actuals.anyrange_type;
1141  }
1142  break;
1143  case ANYMULTIRANGEOID:
1144  if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1145  {
1146  have_polymorphic_result = true;
1147  have_anymultirange_result = true;
1148  }
1149  else
1150  {
1151  if (!OidIsValid(poly_actuals.anymultirange_type))
1152  {
1153  poly_actuals.anymultirange_type =
1154  get_call_expr_argtype(call_expr, inargno);
1155  if (!OidIsValid(poly_actuals.anymultirange_type))
1156  return false;
1157  }
1158  argtypes[i] = poly_actuals.anymultirange_type;
1159  }
1160  break;
1161  case ANYCOMPATIBLEOID:
1162  case ANYCOMPATIBLENONARRAYOID:
1163  if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1164  {
1165  have_polymorphic_result = true;
1166  have_anycompatible_result = true;
1167  }
1168  else
1169  {
1170  if (!OidIsValid(anyc_actuals.anyelement_type))
1171  {
1172  anyc_actuals.anyelement_type =
1173  get_call_expr_argtype(call_expr, inargno);
1174  if (!OidIsValid(anyc_actuals.anyelement_type))
1175  return false;
1176  }
1177  argtypes[i] = anyc_actuals.anyelement_type;
1178  }
1179  break;
1180  case ANYCOMPATIBLEARRAYOID:
1181  if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1182  {
1183  have_polymorphic_result = true;
1184  have_anycompatible_array_result = true;
1185  }
1186  else
1187  {
1188  if (!OidIsValid(anyc_actuals.anyarray_type))
1189  {
1190  anyc_actuals.anyarray_type =
1191  get_call_expr_argtype(call_expr, inargno);
1192  if (!OidIsValid(anyc_actuals.anyarray_type))
1193  return false;
1194  }
1195  argtypes[i] = anyc_actuals.anyarray_type;
1196  }
1197  break;
1198  case ANYCOMPATIBLERANGEOID:
1199  if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1200  {
1201  have_polymorphic_result = true;
1202  have_anycompatible_range_result = true;
1203  }
1204  else
1205  {
1206  if (!OidIsValid(anyc_actuals.anyrange_type))
1207  {
1208  anyc_actuals.anyrange_type =
1209  get_call_expr_argtype(call_expr, inargno);
1210  if (!OidIsValid(anyc_actuals.anyrange_type))
1211  return false;
1212  }
1213  argtypes[i] = anyc_actuals.anyrange_type;
1214  }
1215  break;
1216  case ANYCOMPATIBLEMULTIRANGEOID:
1217  if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1218  {
1219  have_polymorphic_result = true;
1220  have_anycompatible_multirange_result = true;
1221  }
1222  else
1223  {
1224  if (!OidIsValid(anyc_actuals.anymultirange_type))
1225  {
1226  anyc_actuals.anymultirange_type =
1227  get_call_expr_argtype(call_expr, inargno);
1228  if (!OidIsValid(anyc_actuals.anymultirange_type))
1229  return false;
1230  }
1231  argtypes[i] = anyc_actuals.anymultirange_type;
1232  }
1233  break;
1234  default:
1235  break;
1236  }
1237  if (argmode != PROARGMODE_OUT && argmode != PROARGMODE_TABLE)
1238  inargno++;
1239  }
1240 
1241  /* Done? */
1242  if (!have_polymorphic_result)
1243  return true;
1244 
1245  /* If needed, deduce one polymorphic type from others */
1246  if (have_anyelement_result && !OidIsValid(poly_actuals.anyelement_type))
1247  resolve_anyelement_from_others(&poly_actuals);
1248 
1249  if (have_anyarray_result && !OidIsValid(poly_actuals.anyarray_type))
1250  resolve_anyarray_from_others(&poly_actuals);
1251 
1252  if (have_anyrange_result && !OidIsValid(poly_actuals.anyrange_type))
1253  resolve_anyrange_from_others(&poly_actuals);
1254 
1255  if (have_anymultirange_result && !OidIsValid(poly_actuals.anymultirange_type))
1256  resolve_anymultirange_from_others(&poly_actuals);
1257 
1258  if (have_anycompatible_result && !OidIsValid(anyc_actuals.anyelement_type))
1259  resolve_anyelement_from_others(&anyc_actuals);
1260 
1261  if (have_anycompatible_array_result && !OidIsValid(anyc_actuals.anyarray_type))
1262  resolve_anyarray_from_others(&anyc_actuals);
1263 
1264  if (have_anycompatible_range_result && !OidIsValid(anyc_actuals.anyrange_type))
1265  resolve_anyrange_from_others(&anyc_actuals);
1266 
1267  if (have_anycompatible_multirange_result && !OidIsValid(anyc_actuals.anymultirange_type))
1268  resolve_anymultirange_from_others(&anyc_actuals);
1269 
1270  /* And finally replace the output column types as needed */
1271  for (i = 0; i < numargs; i++)
1272  {
1273  switch (argtypes[i])
1274  {
1275  case ANYELEMENTOID:
1276  case ANYNONARRAYOID:
1277  case ANYENUMOID:
1278  argtypes[i] = poly_actuals.anyelement_type;
1279  break;
1280  case ANYARRAYOID:
1281  argtypes[i] = poly_actuals.anyarray_type;
1282  break;
1283  case ANYRANGEOID:
1284  argtypes[i] = poly_actuals.anyrange_type;
1285  break;
1286  case ANYMULTIRANGEOID:
1287  argtypes[i] = poly_actuals.anymultirange_type;
1288  break;
1289  case ANYCOMPATIBLEOID:
1290  case ANYCOMPATIBLENONARRAYOID:
1291  argtypes[i] = anyc_actuals.anyelement_type;
1292  break;
1293  case ANYCOMPATIBLEARRAYOID:
1294  argtypes[i] = anyc_actuals.anyarray_type;
1295  break;
1296  case ANYCOMPATIBLERANGEOID:
1297  argtypes[i] = anyc_actuals.anyrange_type;
1298  break;
1299  case ANYCOMPATIBLEMULTIRANGEOID:
1300  argtypes[i] = anyc_actuals.anymultirange_type;
1301  break;
1302  default:
1303  break;
1304  }
1305  }
1306 
1307  return true;
1308 }
1309 
1310 /*
1311  * get_type_func_class
1312  * Given the type OID, obtain its TYPEFUNC classification.
1313  * Also, if it's a domain, return the base type OID.
1314  *
1315  * This is intended to centralize a bunch of formerly ad-hoc code for
1316  * classifying types. The categories used here are useful for deciding
1317  * how to handle functions returning the datatype.
1318  */
1319 static TypeFuncClass
1320 get_type_func_class(Oid typid, Oid *base_typeid)
1321 {
1322  *base_typeid = typid;
1323 
1324  switch (get_typtype(typid))
1325  {
1326  case TYPTYPE_COMPOSITE:
1327  return TYPEFUNC_COMPOSITE;
1328  case TYPTYPE_BASE:
1329  case TYPTYPE_ENUM:
1330  case TYPTYPE_RANGE:
1331  case TYPTYPE_MULTIRANGE:
1332  return TYPEFUNC_SCALAR;
1333  case TYPTYPE_DOMAIN:
1334  *base_typeid = typid = getBaseType(typid);
1335  if (get_typtype(typid) == TYPTYPE_COMPOSITE)
1337  else /* domain base type can't be a pseudotype */
1338  return TYPEFUNC_SCALAR;
1339  case TYPTYPE_PSEUDO:
1340  if (typid == RECORDOID)
1341  return TYPEFUNC_RECORD;
1342 
1343  /*
1344  * We treat VOID and CSTRING as legitimate scalar datatypes,
1345  * mostly for the convenience of the JDBC driver (which wants to
1346  * be able to do "SELECT * FROM foo()" for all legitimately
1347  * user-callable functions).
1348  */
1349  if (typid == VOIDOID || typid == CSTRINGOID)
1350  return TYPEFUNC_SCALAR;
1351  return TYPEFUNC_OTHER;
1352  }
1353  /* shouldn't get here, probably */
1354  return TYPEFUNC_OTHER;
1355 }
1356 
1357 
1358 /*
1359  * get_func_arg_info
1360  *
1361  * Fetch info about the argument types, names, and IN/OUT modes from the
1362  * pg_proc tuple. Return value is the total number of arguments.
1363  * Other results are palloc'd. *p_argtypes is always filled in, but
1364  * *p_argnames and *p_argmodes will be set NULL in the default cases
1365  * (no names, and all IN arguments, respectively).
1366  *
1367  * Note that this function simply fetches what is in the pg_proc tuple;
1368  * it doesn't do any interpretation of polymorphic types.
1369  */
1370 int
1372  Oid **p_argtypes, char ***p_argnames, char **p_argmodes)
1373 {
1374  Form_pg_proc procStruct = (Form_pg_proc) GETSTRUCT(procTup);
1375  Datum proallargtypes;
1376  Datum proargmodes;
1377  Datum proargnames;
1378  bool isNull;
1379  ArrayType *arr;
1380  int numargs;
1381  Datum *elems;
1382  int nelems;
1383  int i;
1384 
1385  /* First discover the total number of parameters and get their types */
1386  proallargtypes = SysCacheGetAttr(PROCOID, procTup,
1387  Anum_pg_proc_proallargtypes,
1388  &isNull);
1389  if (!isNull)
1390  {
1391  /*
1392  * We expect the arrays to be 1-D arrays of the right types; verify
1393  * that. For the OID and char arrays, we don't need to use
1394  * deconstruct_array() since the array data is just going to look like
1395  * a C array of values.
1396  */
1397  arr = DatumGetArrayTypeP(proallargtypes); /* ensure not toasted */
1398  numargs = ARR_DIMS(arr)[0];
1399  if (ARR_NDIM(arr) != 1 ||
1400  numargs < 0 ||
1401  ARR_HASNULL(arr) ||
1402  ARR_ELEMTYPE(arr) != OIDOID)
1403  elog(ERROR, "proallargtypes is not a 1-D Oid array or it contains nulls");
1404  Assert(numargs >= procStruct->pronargs);
1405  *p_argtypes = (Oid *) palloc(numargs * sizeof(Oid));
1406  memcpy(*p_argtypes, ARR_DATA_PTR(arr),
1407  numargs * sizeof(Oid));
1408  }
1409  else
1410  {
1411  /* If no proallargtypes, use proargtypes */
1412  numargs = procStruct->proargtypes.dim1;
1413  Assert(numargs == procStruct->pronargs);
1414  *p_argtypes = (Oid *) palloc(numargs * sizeof(Oid));
1415  memcpy(*p_argtypes, procStruct->proargtypes.values,
1416  numargs * sizeof(Oid));
1417  }
1418 
1419  /* Get argument names, if available */
1420  proargnames = SysCacheGetAttr(PROCOID, procTup,
1421  Anum_pg_proc_proargnames,
1422  &isNull);
1423  if (isNull)
1424  *p_argnames = NULL;
1425  else
1426  {
1427  deconstruct_array_builtin(DatumGetArrayTypeP(proargnames), TEXTOID,
1428  &elems, NULL, &nelems);
1429  if (nelems != numargs) /* should not happen */
1430  elog(ERROR, "proargnames must have the same number of elements as the function has arguments");
1431  *p_argnames = (char **) palloc(sizeof(char *) * numargs);
1432  for (i = 0; i < numargs; i++)
1433  (*p_argnames)[i] = TextDatumGetCString(elems[i]);
1434  }
1435 
1436  /* Get argument modes, if available */
1437  proargmodes = SysCacheGetAttr(PROCOID, procTup,
1438  Anum_pg_proc_proargmodes,
1439  &isNull);
1440  if (isNull)
1441  *p_argmodes = NULL;
1442  else
1443  {
1444  arr = DatumGetArrayTypeP(proargmodes); /* ensure not toasted */
1445  if (ARR_NDIM(arr) != 1 ||
1446  ARR_DIMS(arr)[0] != numargs ||
1447  ARR_HASNULL(arr) ||
1448  ARR_ELEMTYPE(arr) != CHAROID)
1449  elog(ERROR, "proargmodes is not a 1-D char array of length %d or it contains nulls",
1450  numargs);
1451  *p_argmodes = (char *) palloc(numargs * sizeof(char));
1452  memcpy(*p_argmodes, ARR_DATA_PTR(arr),
1453  numargs * sizeof(char));
1454  }
1455 
1456  return numargs;
1457 }
1458 
1459 /*
1460  * get_func_trftypes
1461  *
1462  * Returns the number of transformed types used by the function.
1463  * If there are any, a palloc'd array of the type OIDs is returned
1464  * into *p_trftypes.
1465  */
1466 int
1468  Oid **p_trftypes)
1469 {
1470  Datum protrftypes;
1471  ArrayType *arr;
1472  int nelems;
1473  bool isNull;
1474 
1475  protrftypes = SysCacheGetAttr(PROCOID, procTup,
1476  Anum_pg_proc_protrftypes,
1477  &isNull);
1478  if (!isNull)
1479  {
1480  /*
1481  * We expect the arrays to be 1-D arrays of the right types; verify
1482  * that. For the OID and char arrays, we don't need to use
1483  * deconstruct_array() since the array data is just going to look like
1484  * a C array of values.
1485  */
1486  arr = DatumGetArrayTypeP(protrftypes); /* ensure not toasted */
1487  nelems = ARR_DIMS(arr)[0];
1488  if (ARR_NDIM(arr) != 1 ||
1489  nelems < 0 ||
1490  ARR_HASNULL(arr) ||
1491  ARR_ELEMTYPE(arr) != OIDOID)
1492  elog(ERROR, "protrftypes is not a 1-D Oid array or it contains nulls");
1493  *p_trftypes = (Oid *) palloc(nelems * sizeof(Oid));
1494  memcpy(*p_trftypes, ARR_DATA_PTR(arr),
1495  nelems * sizeof(Oid));
1496 
1497  return nelems;
1498  }
1499  else
1500  return 0;
1501 }
1502 
1503 /*
1504  * get_func_input_arg_names
1505  *
1506  * Extract the names of input arguments only, given a function's
1507  * proargnames and proargmodes entries in Datum form.
1508  *
1509  * Returns the number of input arguments, which is the length of the
1510  * palloc'd array returned to *arg_names. Entries for unnamed args
1511  * are set to NULL. You don't get anything if proargnames is NULL.
1512  */
1513 int
1514 get_func_input_arg_names(Datum proargnames, Datum proargmodes,
1515  char ***arg_names)
1516 {
1517  ArrayType *arr;
1518  int numargs;
1519  Datum *argnames;
1520  char *argmodes;
1521  char **inargnames;
1522  int numinargs;
1523  int i;
1524 
1525  /* Do nothing if null proargnames */
1526  if (proargnames == PointerGetDatum(NULL))
1527  {
1528  *arg_names = NULL;
1529  return 0;
1530  }
1531 
1532  /*
1533  * We expect the arrays to be 1-D arrays of the right types; verify that.
1534  * For proargmodes, we don't need to use deconstruct_array() since the
1535  * array data is just going to look like a C array of values.
1536  */
1537  arr = DatumGetArrayTypeP(proargnames); /* ensure not toasted */
1538  if (ARR_NDIM(arr) != 1 ||
1539  ARR_HASNULL(arr) ||
1540  ARR_ELEMTYPE(arr) != TEXTOID)
1541  elog(ERROR, "proargnames is not a 1-D text array or it contains nulls");
1542  deconstruct_array_builtin(arr, TEXTOID, &argnames, NULL, &numargs);
1543  if (proargmodes != PointerGetDatum(NULL))
1544  {
1545  arr = DatumGetArrayTypeP(proargmodes); /* ensure not toasted */
1546  if (ARR_NDIM(arr) != 1 ||
1547  ARR_DIMS(arr)[0] != numargs ||
1548  ARR_HASNULL(arr) ||
1549  ARR_ELEMTYPE(arr) != CHAROID)
1550  elog(ERROR, "proargmodes is not a 1-D char array of length %d or it contains nulls",
1551  numargs);
1552  argmodes = (char *) ARR_DATA_PTR(arr);
1553  }
1554  else
1555  argmodes = NULL;
1556 
1557  /* zero elements probably shouldn't happen, but handle it gracefully */
1558  if (numargs <= 0)
1559  {
1560  *arg_names = NULL;
1561  return 0;
1562  }
1563 
1564  /* extract input-argument names */
1565  inargnames = (char **) palloc(numargs * sizeof(char *));
1566  numinargs = 0;
1567  for (i = 0; i < numargs; i++)
1568  {
1569  if (argmodes == NULL ||
1570  argmodes[i] == PROARGMODE_IN ||
1571  argmodes[i] == PROARGMODE_INOUT ||
1572  argmodes[i] == PROARGMODE_VARIADIC)
1573  {
1574  char *pname = TextDatumGetCString(argnames[i]);
1575 
1576  if (pname[0] != '\0')
1577  inargnames[numinargs] = pname;
1578  else
1579  inargnames[numinargs] = NULL;
1580  numinargs++;
1581  }
1582  }
1583 
1584  *arg_names = inargnames;
1585  return numinargs;
1586 }
1587 
1588 
1589 /*
1590  * get_func_result_name
1591  *
1592  * If the function has exactly one output parameter, and that parameter
1593  * is named, return the name (as a palloc'd string). Else return NULL.
1594  *
1595  * This is used to determine the default output column name for functions
1596  * returning scalar types.
1597  */
1598 char *
1600 {
1601  char *result;
1602  HeapTuple procTuple;
1603  Datum proargmodes;
1604  Datum proargnames;
1605  ArrayType *arr;
1606  int numargs;
1607  char *argmodes;
1608  Datum *argnames;
1609  int numoutargs;
1610  int nargnames;
1611  int i;
1612 
1613  /* First fetch the function's pg_proc row */
1614  procTuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(functionId));
1615  if (!HeapTupleIsValid(procTuple))
1616  elog(ERROR, "cache lookup failed for function %u", functionId);
1617 
1618  /* If there are no named OUT parameters, return NULL */
1619  if (heap_attisnull(procTuple, Anum_pg_proc_proargmodes, NULL) ||
1620  heap_attisnull(procTuple, Anum_pg_proc_proargnames, NULL))
1621  result = NULL;
1622  else
1623  {
1624  /* Get the data out of the tuple */
1625  proargmodes = SysCacheGetAttrNotNull(PROCOID, procTuple,
1626  Anum_pg_proc_proargmodes);
1627  proargnames = SysCacheGetAttrNotNull(PROCOID, procTuple,
1628  Anum_pg_proc_proargnames);
1629 
1630  /*
1631  * We expect the arrays to be 1-D arrays of the right types; verify
1632  * that. For the char array, we don't need to use deconstruct_array()
1633  * since the array data is just going to look like a C array of
1634  * values.
1635  */
1636  arr = DatumGetArrayTypeP(proargmodes); /* ensure not toasted */
1637  numargs = ARR_DIMS(arr)[0];
1638  if (ARR_NDIM(arr) != 1 ||
1639  numargs < 0 ||
1640  ARR_HASNULL(arr) ||
1641  ARR_ELEMTYPE(arr) != CHAROID)
1642  elog(ERROR, "proargmodes is not a 1-D char array or it contains nulls");
1643  argmodes = (char *) ARR_DATA_PTR(arr);
1644  arr = DatumGetArrayTypeP(proargnames); /* ensure not toasted */
1645  if (ARR_NDIM(arr) != 1 ||
1646  ARR_DIMS(arr)[0] != numargs ||
1647  ARR_HASNULL(arr) ||
1648  ARR_ELEMTYPE(arr) != TEXTOID)
1649  elog(ERROR, "proargnames is not a 1-D text array of length %d or it contains nulls",
1650  numargs);
1651  deconstruct_array_builtin(arr, TEXTOID, &argnames, NULL, &nargnames);
1652  Assert(nargnames == numargs);
1653 
1654  /* scan for output argument(s) */
1655  result = NULL;
1656  numoutargs = 0;
1657  for (i = 0; i < numargs; i++)
1658  {
1659  if (argmodes[i] == PROARGMODE_IN ||
1660  argmodes[i] == PROARGMODE_VARIADIC)
1661  continue;
1662  Assert(argmodes[i] == PROARGMODE_OUT ||
1663  argmodes[i] == PROARGMODE_INOUT ||
1664  argmodes[i] == PROARGMODE_TABLE);
1665  if (++numoutargs > 1)
1666  {
1667  /* multiple out args, so forget it */
1668  result = NULL;
1669  break;
1670  }
1671  result = TextDatumGetCString(argnames[i]);
1672  if (result == NULL || result[0] == '\0')
1673  {
1674  /* Parameter is not named, so forget it */
1675  result = NULL;
1676  break;
1677  }
1678  }
1679  }
1680 
1681  ReleaseSysCache(procTuple);
1682 
1683  return result;
1684 }
1685 
1686 
1687 /*
1688  * build_function_result_tupdesc_t
1689  *
1690  * Given a pg_proc row for a function, return a tuple descriptor for the
1691  * result rowtype, or NULL if the function does not have OUT parameters.
1692  *
1693  * Note that this does not handle resolution of polymorphic types;
1694  * that is deliberate.
1695  */
1696 TupleDesc
1698 {
1699  Form_pg_proc procform = (Form_pg_proc) GETSTRUCT(procTuple);
1700  Datum proallargtypes;
1701  Datum proargmodes;
1702  Datum proargnames;
1703  bool isnull;
1704 
1705  /* Return NULL if the function isn't declared to return RECORD */
1706  if (procform->prorettype != RECORDOID)
1707  return NULL;
1708 
1709  /* If there are no OUT parameters, return NULL */
1710  if (heap_attisnull(procTuple, Anum_pg_proc_proallargtypes, NULL) ||
1711  heap_attisnull(procTuple, Anum_pg_proc_proargmodes, NULL))
1712  return NULL;
1713 
1714  /* Get the data out of the tuple */
1715  proallargtypes = SysCacheGetAttrNotNull(PROCOID, procTuple,
1716  Anum_pg_proc_proallargtypes);
1717  proargmodes = SysCacheGetAttrNotNull(PROCOID, procTuple,
1718  Anum_pg_proc_proargmodes);
1719  proargnames = SysCacheGetAttr(PROCOID, procTuple,
1720  Anum_pg_proc_proargnames,
1721  &isnull);
1722  if (isnull)
1723  proargnames = PointerGetDatum(NULL); /* just to be sure */
1724 
1725  return build_function_result_tupdesc_d(procform->prokind,
1726  proallargtypes,
1727  proargmodes,
1728  proargnames);
1729 }
1730 
1731 /*
1732  * build_function_result_tupdesc_d
1733  *
1734  * Build a RECORD function's tupledesc from the pg_proc proallargtypes,
1735  * proargmodes, and proargnames arrays. This is split out for the
1736  * convenience of ProcedureCreate, which needs to be able to compute the
1737  * tupledesc before actually creating the function.
1738  *
1739  * For functions (but not for procedures), returns NULL if there are not at
1740  * least two OUT or INOUT arguments.
1741  */
1742 TupleDesc
1744  Datum proallargtypes,
1745  Datum proargmodes,
1746  Datum proargnames)
1747 {
1748  TupleDesc desc;
1749  ArrayType *arr;
1750  int numargs;
1751  Oid *argtypes;
1752  char *argmodes;
1753  Datum *argnames = NULL;
1754  Oid *outargtypes;
1755  char **outargnames;
1756  int numoutargs;
1757  int nargnames;
1758  int i;
1759 
1760  /* Can't have output args if columns are null */
1761  if (proallargtypes == PointerGetDatum(NULL) ||
1762  proargmodes == PointerGetDatum(NULL))
1763  return NULL;
1764 
1765  /*
1766  * We expect the arrays to be 1-D arrays of the right types; verify that.
1767  * For the OID and char arrays, we don't need to use deconstruct_array()
1768  * since the array data is just going to look like a C array of values.
1769  */
1770  arr = DatumGetArrayTypeP(proallargtypes); /* ensure not toasted */
1771  numargs = ARR_DIMS(arr)[0];
1772  if (ARR_NDIM(arr) != 1 ||
1773  numargs < 0 ||
1774  ARR_HASNULL(arr) ||
1775  ARR_ELEMTYPE(arr) != OIDOID)
1776  elog(ERROR, "proallargtypes is not a 1-D Oid array or it contains nulls");
1777  argtypes = (Oid *) ARR_DATA_PTR(arr);
1778  arr = DatumGetArrayTypeP(proargmodes); /* ensure not toasted */
1779  if (ARR_NDIM(arr) != 1 ||
1780  ARR_DIMS(arr)[0] != numargs ||
1781  ARR_HASNULL(arr) ||
1782  ARR_ELEMTYPE(arr) != CHAROID)
1783  elog(ERROR, "proargmodes is not a 1-D char array of length %d or it contains nulls",
1784  numargs);
1785  argmodes = (char *) ARR_DATA_PTR(arr);
1786  if (proargnames != PointerGetDatum(NULL))
1787  {
1788  arr = DatumGetArrayTypeP(proargnames); /* ensure not toasted */
1789  if (ARR_NDIM(arr) != 1 ||
1790  ARR_DIMS(arr)[0] != numargs ||
1791  ARR_HASNULL(arr) ||
1792  ARR_ELEMTYPE(arr) != TEXTOID)
1793  elog(ERROR, "proargnames is not a 1-D text array of length %d or it contains nulls",
1794  numargs);
1795  deconstruct_array_builtin(arr, TEXTOID, &argnames, NULL, &nargnames);
1796  Assert(nargnames == numargs);
1797  }
1798 
1799  /* zero elements probably shouldn't happen, but handle it gracefully */
1800  if (numargs <= 0)
1801  return NULL;
1802 
1803  /* extract output-argument types and names */
1804  outargtypes = (Oid *) palloc(numargs * sizeof(Oid));
1805  outargnames = (char **) palloc(numargs * sizeof(char *));
1806  numoutargs = 0;
1807  for (i = 0; i < numargs; i++)
1808  {
1809  char *pname;
1810 
1811  if (argmodes[i] == PROARGMODE_IN ||
1812  argmodes[i] == PROARGMODE_VARIADIC)
1813  continue;
1814  Assert(argmodes[i] == PROARGMODE_OUT ||
1815  argmodes[i] == PROARGMODE_INOUT ||
1816  argmodes[i] == PROARGMODE_TABLE);
1817  outargtypes[numoutargs] = argtypes[i];
1818  if (argnames)
1819  pname = TextDatumGetCString(argnames[i]);
1820  else
1821  pname = NULL;
1822  if (pname == NULL || pname[0] == '\0')
1823  {
1824  /* Parameter is not named, so gin up a column name */
1825  pname = psprintf("column%d", numoutargs + 1);
1826  }
1827  outargnames[numoutargs] = pname;
1828  numoutargs++;
1829  }
1830 
1831  /*
1832  * If there is no output argument, or only one, the function does not
1833  * return tuples.
1834  */
1835  if (numoutargs < 2 && prokind != PROKIND_PROCEDURE)
1836  return NULL;
1837 
1838  desc = CreateTemplateTupleDesc(numoutargs);
1839  for (i = 0; i < numoutargs; i++)
1840  {
1841  TupleDescInitEntry(desc, i + 1,
1842  outargnames[i],
1843  outargtypes[i],
1844  -1,
1845  0);
1846  }
1847 
1848  return desc;
1849 }
1850 
1851 
1852 /*
1853  * RelationNameGetTupleDesc
1854  *
1855  * Given a (possibly qualified) relation name, build a TupleDesc.
1856  *
1857  * Note: while this works as advertised, it's seldom the best way to
1858  * build a tupdesc for a function's result type. It's kept around
1859  * only for backwards compatibility with existing user-written code.
1860  */
1861 TupleDesc
1863 {
1864  RangeVar *relvar;
1865  Relation rel;
1866  TupleDesc tupdesc;
1867  List *relname_list;
1868 
1869  /* Open relation and copy the tuple description */
1870  relname_list = stringToQualifiedNameList(relname, NULL);
1871  relvar = makeRangeVarFromNameList(relname_list);
1872  rel = relation_openrv(relvar, AccessShareLock);
1873  tupdesc = CreateTupleDescCopy(RelationGetDescr(rel));
1875 
1876  return tupdesc;
1877 }
1878 
1879 /*
1880  * TypeGetTupleDesc
1881  *
1882  * Given a type Oid, build a TupleDesc. (In most cases you should be
1883  * using get_call_result_type or one of its siblings instead of this
1884  * routine, so that you can handle OUT parameters, RECORD result type,
1885  * and polymorphic results.)
1886  *
1887  * If the type is composite, *and* a colaliases List is provided, *and*
1888  * the List is of natts length, use the aliases instead of the relation
1889  * attnames. (NB: this usage is deprecated since it may result in
1890  * creation of unnecessary transient record types.)
1891  *
1892  * If the type is a base type, a single item alias List is required.
1893  */
1894 TupleDesc
1895 TypeGetTupleDesc(Oid typeoid, List *colaliases)
1896 {
1897  Oid base_typeoid;
1898  TypeFuncClass functypclass = get_type_func_class(typeoid, &base_typeoid);
1899  TupleDesc tupdesc = NULL;
1900 
1901  /*
1902  * Build a suitable tupledesc representing the output rows. We
1903  * intentionally do not support TYPEFUNC_COMPOSITE_DOMAIN here, as it's
1904  * unlikely that legacy callers of this obsolete function would be
1905  * prepared to apply domain constraints.
1906  */
1907  if (functypclass == TYPEFUNC_COMPOSITE)
1908  {
1909  /* Composite data type, e.g. a table's row type */
1910  tupdesc = lookup_rowtype_tupdesc_copy(base_typeoid, -1);
1911 
1912  if (colaliases != NIL)
1913  {
1914  int natts = tupdesc->natts;
1915  int varattno;
1916 
1917  /* does the list length match the number of attributes? */
1918  if (list_length(colaliases) != natts)
1919  ereport(ERROR,
1920  (errcode(ERRCODE_DATATYPE_MISMATCH),
1921  errmsg("number of aliases does not match number of columns")));
1922 
1923  /* OK, use the aliases instead */
1924  for (varattno = 0; varattno < natts; varattno++)
1925  {
1926  char *label = strVal(list_nth(colaliases, varattno));
1927  Form_pg_attribute attr = TupleDescAttr(tupdesc, varattno);
1928 
1929  if (label != NULL)
1930  namestrcpy(&(attr->attname), label);
1931  }
1932 
1933  /* The tuple type is now an anonymous record type */
1934  tupdesc->tdtypeid = RECORDOID;
1935  tupdesc->tdtypmod = -1;
1936  }
1937  }
1938  else if (functypclass == TYPEFUNC_SCALAR)
1939  {
1940  /* Base data type, i.e. scalar */
1941  char *attname;
1942 
1943  /* the alias list is required for base types */
1944  if (colaliases == NIL)
1945  ereport(ERROR,
1946  (errcode(ERRCODE_DATATYPE_MISMATCH),
1947  errmsg("no column alias was provided")));
1948 
1949  /* the alias list length must be 1 */
1950  if (list_length(colaliases) != 1)
1951  ereport(ERROR,
1952  (errcode(ERRCODE_DATATYPE_MISMATCH),
1953  errmsg("number of aliases does not match number of columns")));
1954 
1955  /* OK, get the column alias */
1956  attname = strVal(linitial(colaliases));
1957 
1958  tupdesc = CreateTemplateTupleDesc(1);
1959  TupleDescInitEntry(tupdesc,
1960  (AttrNumber) 1,
1961  attname,
1962  typeoid,
1963  -1,
1964  0);
1965  }
1966  else if (functypclass == TYPEFUNC_RECORD)
1967  {
1968  /* XXX can't support this because typmod wasn't passed in ... */
1969  ereport(ERROR,
1970  (errcode(ERRCODE_DATATYPE_MISMATCH),
1971  errmsg("could not determine row description for function returning record")));
1972  }
1973  else
1974  {
1975  /* crummy error message, but parser should have caught this */
1976  elog(ERROR, "function in FROM has unsupported return type");
1977  }
1978 
1979  return tupdesc;
1980 }
1981 
1982 /*
1983  * extract_variadic_args
1984  *
1985  * Extract a set of argument values, types and NULL markers for a given
1986  * input function which makes use of a VARIADIC input whose argument list
1987  * depends on the caller context. When doing a VARIADIC call, the caller
1988  * has provided one argument made of an array of values, so deconstruct the
1989  * array data before using it for the next processing. If no VARIADIC call
1990  * is used, just fill in the status data based on all the arguments given
1991  * by the caller.
1992  *
1993  * This function returns the number of arguments generated, or -1 in the
1994  * case of "VARIADIC NULL".
1995  */
1996 int
1997 extract_variadic_args(FunctionCallInfo fcinfo, int variadic_start,
1998  bool convert_unknown, Datum **args, Oid **types,
1999  bool **nulls)
2000 {
2001  bool variadic = get_fn_expr_variadic(fcinfo->flinfo);
2002  Datum *args_res;
2003  bool *nulls_res;
2004  Oid *types_res;
2005  int nargs,
2006  i;
2007 
2008  *args = NULL;
2009  *types = NULL;
2010  *nulls = NULL;
2011 
2012  if (variadic)
2013  {
2015  Oid element_type;
2016  bool typbyval;
2017  char typalign;
2018  int16 typlen;
2019 
2020  Assert(PG_NARGS() == variadic_start + 1);
2021 
2022  if (PG_ARGISNULL(variadic_start))
2023  return -1;
2024 
2025  array_in = PG_GETARG_ARRAYTYPE_P(variadic_start);
2026  element_type = ARR_ELEMTYPE(array_in);
2027 
2028  get_typlenbyvalalign(element_type,
2029  &typlen, &typbyval, &typalign);
2030  deconstruct_array(array_in, element_type, typlen, typbyval,
2031  typalign, &args_res, &nulls_res,
2032  &nargs);
2033 
2034  /* All the elements of the array have the same type */
2035  types_res = (Oid *) palloc0(nargs * sizeof(Oid));
2036  for (i = 0; i < nargs; i++)
2037  types_res[i] = element_type;
2038  }
2039  else
2040  {
2041  nargs = PG_NARGS() - variadic_start;
2042  Assert(nargs > 0);
2043  nulls_res = (bool *) palloc0(nargs * sizeof(bool));
2044  args_res = (Datum *) palloc0(nargs * sizeof(Datum));
2045  types_res = (Oid *) palloc0(nargs * sizeof(Oid));
2046 
2047  for (i = 0; i < nargs; i++)
2048  {
2049  nulls_res[i] = PG_ARGISNULL(i + variadic_start);
2050  types_res[i] = get_fn_expr_argtype(fcinfo->flinfo,
2051  i + variadic_start);
2052 
2053  /*
2054  * Turn a constant (more or less literal) value that's of unknown
2055  * type into text if required. Unknowns come in as a cstring
2056  * pointer. Note: for functions declared as taking type "any", the
2057  * parser will not do any type conversion on unknown-type literals
2058  * (that is, undecorated strings or NULLs).
2059  */
2060  if (convert_unknown &&
2061  types_res[i] == UNKNOWNOID &&
2062  get_fn_expr_arg_stable(fcinfo->flinfo, i + variadic_start))
2063  {
2064  types_res[i] = TEXTOID;
2065 
2066  if (PG_ARGISNULL(i + variadic_start))
2067  args_res[i] = (Datum) 0;
2068  else
2069  args_res[i] =
2070  CStringGetTextDatum(PG_GETARG_POINTER(i + variadic_start));
2071  }
2072  else
2073  {
2074  /* no conversion needed, just take the datum as given */
2075  args_res[i] = PG_GETARG_DATUM(i + variadic_start);
2076  }
2077 
2078  if (!OidIsValid(types_res[i]) ||
2079  (convert_unknown && types_res[i] == UNKNOWNOID))
2080  ereport(ERROR,
2081  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
2082  errmsg("could not determine data type for argument %d",
2083  i + 1)));
2084  }
2085  }
2086 
2087  /* Fill in results */
2088  *args = args_res;
2089  *nulls = nulls_res;
2090  *types = types_res;
2091 
2092  return nargs;
2093 }
#define ARR_NDIM(a)
Definition: array.h:290
#define PG_GETARG_ARRAYTYPE_P(n)
Definition: array.h:263
#define ARR_DATA_PTR(a)
Definition: array.h:322
#define DatumGetArrayTypeP(X)
Definition: array.h:261
#define ARR_ELEMTYPE(a)
Definition: array.h:292
#define ARR_DIMS(a)
Definition: array.h:294
#define ARR_HASNULL(a)
Definition: array.h:291
void deconstruct_array(ArrayType *array, Oid elmtype, int elmlen, bool elmbyval, char elmalign, Datum **elemsp, bool **nullsp, int *nelemsp)
Definition: arrayfuncs.c:3612
void deconstruct_array_builtin(ArrayType *array, Oid elmtype, Datum **elemsp, bool **nullsp, int *nelemsp)
Definition: arrayfuncs.c:3678
Datum array_in(PG_FUNCTION_ARGS)
Definition: arrayfuncs.c:179
int16 AttrNumber
Definition: attnum.h:21
#define CStringGetTextDatum(s)
Definition: builtins.h:97
#define TextDatumGetCString(d)
Definition: builtins.h:98
#define NameStr(name)
Definition: c.h:733
signed short int16
Definition: c.h:480
signed int int32
Definition: c.h:481
uint32 bits32
Definition: c.h:502
#define OidIsValid(objectId)
Definition: c.h:762
struct typedefs * types
Definition: ecpg.c:29
int errcode(int sqlerrcode)
Definition: elog.c:859
int errmsg(const char *fmt,...)
Definition: elog.c:1072
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:224
#define ereport(elevel,...)
Definition: elog.h:149
TupleDesc BlessTupleDesc(TupleDesc tupdesc)
Definition: execTuples.c:2070
void UnregisterExprContextCallback(ExprContext *econtext, ExprContextCallbackFunction function, Datum arg)
Definition: execUtils.c:923
void RegisterExprContextCallback(ExprContext *econtext, ExprContextCallbackFunction function, Datum arg)
Definition: execUtils.c:897
@ SFRM_Materialize_Random
Definition: execnodes.h:318
@ SFRM_Materialize
Definition: execnodes.h:317
bool get_fn_expr_arg_stable(FmgrInfo *flinfo, int argnum)
Definition: fmgr.c:1975
bool get_fn_expr_variadic(FmgrInfo *flinfo)
Definition: fmgr.c:2044
Oid get_call_expr_argtype(Node *expr, int argnum)
Definition: fmgr.c:1929
Oid get_fn_expr_argtype(FmgrInfo *flinfo, int argnum)
Definition: fmgr.c:1910
#define DatumGetHeapTupleHeader(X)
Definition: fmgr.h:295
#define PG_GETARG_POINTER(n)
Definition: fmgr.h:276
#define PG_ARGISNULL(n)
Definition: fmgr.h:209
#define PG_GETARG_DATUM(n)
Definition: fmgr.h:268
#define PG_NARGS()
Definition: fmgr.h:203
#define PG_FUNCTION_ARGS
Definition: fmgr.h:193
char * format_type_be(Oid type_oid)
Definition: format_type.c:343
static TypeFuncClass get_type_func_class(Oid typid, Oid *base_typeid)
Definition: funcapi.c:1320
struct polymorphic_actuals polymorphic_actuals
void InitMaterializedSRF(FunctionCallInfo fcinfo, bits32 flags)
Definition: funcapi.c:76
static TypeFuncClass internal_get_result_type(Oid funcid, Node *call_expr, ReturnSetInfo *rsinfo, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:423
int get_func_trftypes(HeapTuple procTup, Oid **p_trftypes)
Definition: funcapi.c:1467
TupleDesc build_function_result_tupdesc_t(HeapTuple procTuple)
Definition: funcapi.c:1697
TupleDesc build_function_result_tupdesc_d(char prokind, Datum proallargtypes, Datum proargmodes, Datum proargnames)
Definition: funcapi.c:1743
bool resolve_polymorphic_argtypes(int numargs, Oid *argtypes, char *argmodes, Node *call_expr)
Definition: funcapi.c:1056
char * get_func_result_name(Oid functionId)
Definition: funcapi.c:1599
void end_MultiFuncCall(PG_FUNCTION_ARGS, FuncCallContext *funcctx)
Definition: funcapi.c:220
static void resolve_anyelement_from_others(polymorphic_actuals *actuals)
Definition: funcapi.c:581
int get_func_input_arg_names(Datum proargnames, Datum proargmodes, char ***arg_names)
Definition: funcapi.c:1514
int get_func_arg_info(HeapTuple procTup, Oid **p_argtypes, char ***p_argnames, char **p_argmodes)
Definition: funcapi.c:1371
static bool resolve_polymorphic_tupdesc(TupleDesc tupdesc, oidvector *declared_args, Node *call_expr)
Definition: funcapi.c:736
TupleDesc RelationNameGetTupleDesc(const char *relname)
Definition: funcapi.c:1862
TypeFuncClass get_call_result_type(FunctionCallInfo fcinfo, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:276
int extract_variadic_args(FunctionCallInfo fcinfo, int variadic_start, bool convert_unknown, Datum **args, Oid **types, bool **nulls)
Definition: funcapi.c:1997
FuncCallContext * init_MultiFuncCall(PG_FUNCTION_ARGS)
Definition: funcapi.c:133
static void resolve_anyrange_from_others(polymorphic_actuals *actuals)
Definition: funcapi.c:673
static void shutdown_MultiFuncCall(Datum arg)
Definition: funcapi.c:238
TupleDesc get_expr_result_tupdesc(Node *expr, bool noError)
Definition: funcapi.c:543
static void resolve_anymultirange_from_others(polymorphic_actuals *actuals)
Definition: funcapi.c:702
TupleDesc TypeGetTupleDesc(Oid typeoid, List *colaliases)
Definition: funcapi.c:1895
TypeFuncClass get_func_result_type(Oid functionId, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:403
static void resolve_anyarray_from_others(polymorphic_actuals *actuals)
Definition: funcapi.c:647
TypeFuncClass get_expr_result_type(Node *expr, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:292
FuncCallContext * per_MultiFuncCall(PG_FUNCTION_ARGS)
Definition: funcapi.c:208
TypeFuncClass
Definition: funcapi.h:147
@ TYPEFUNC_SCALAR
Definition: funcapi.h:148
@ TYPEFUNC_COMPOSITE
Definition: funcapi.h:149
@ TYPEFUNC_RECORD
Definition: funcapi.h:151
@ TYPEFUNC_COMPOSITE_DOMAIN
Definition: funcapi.h:150
@ TYPEFUNC_OTHER
Definition: funcapi.h:152
#define MAT_SRF_BLESS
Definition: funcapi.h:297
#define MAT_SRF_USE_EXPECTED_DESC
Definition: funcapi.h:296
int work_mem
Definition: globals.c:128
bool heap_attisnull(HeapTuple tup, int attnum, TupleDesc tupleDesc)
Definition: heaptuple.c:455
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define HeapTupleHeaderGetTypMod(tup)
Definition: htup_details.h:466
#define HeapTupleHeaderGetTypeId(tup)
Definition: htup_details.h:456
#define GETSTRUCT(TUP)
Definition: htup_details.h:653
int i
Definition: isn.c:73
if(TABLE==NULL||TABLE_index==NULL)
Definition: isn.c:77
Assert(fmt[strlen(fmt) - 1] !='\n')
#define AccessShareLock
Definition: lockdefs.h:36
Oid get_range_subtype(Oid rangeOid)
Definition: lsyscache.c:3363
Oid get_element_type(Oid typid)
Definition: lsyscache.c:2715
Oid get_multirange_range(Oid multirangeOid)
Definition: lsyscache.c:3439
void get_typlenbyvalalign(Oid typid, int16 *typlen, bool *typbyval, char *typalign)
Definition: lsyscache.c:2227
RegProcedure get_opcode(Oid opno)
Definition: lsyscache.c:1263
Oid get_typcollation(Oid typid)
Definition: lsyscache.c:3012
Oid get_range_multirange(Oid rangeOid)
Definition: lsyscache.c:3414
char get_typtype(Oid typid)
Definition: lsyscache.c:2585
Oid getBaseType(Oid typid)
Definition: lsyscache.c:2477
Oid get_array_type(Oid typid)
Definition: lsyscache.c:2743
void * palloc0(Size size)
Definition: mcxt.c:1334
void * MemoryContextAllocZero(MemoryContext context, Size size)
Definition: mcxt.c:1202
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:442
void * palloc(Size size)
Definition: mcxt.c:1304
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:163
void namestrcpy(Name name, const char *str)
Definition: name.c:233
RangeVar * makeRangeVarFromNameList(const List *names)
Definition: namespace.c:3539
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:42
Oid exprInputCollation(const Node *expr)
Definition: nodeFuncs.c:1023
int32 exprTypmod(const Node *expr)
Definition: nodeFuncs.c:284
Oid exprCollation(const Node *expr)
Definition: nodeFuncs.c:788
#define IsA(nodeptr, _type_)
Definition: nodes.h:158
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:124
NameData attname
Definition: pg_attribute.h:41
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:209
void * arg
static char * label
NameData relname
Definition: pg_class.h:38
#define lfirst(lc)
Definition: pg_list.h:172
static int list_length(const List *l)
Definition: pg_list.h:152
#define NIL
Definition: pg_list.h:68
#define forboth(cell1, list1, cell2, list2)
Definition: pg_list.h:518
#define linitial(l)
Definition: pg_list.h:178
static void * list_nth(const List *list, int n)
Definition: pg_list.h:299
FormData_pg_proc * Form_pg_proc
Definition: pg_proc.h:136
char typalign
Definition: pg_type.h:176
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
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
List * stringToQualifiedNameList(const char *string, Node *escontext)
Definition: regproc.c:1777
#define RelationGetDescr(relation)
Definition: rel.h:531
void relation_close(Relation relation, LOCKMODE lockmode)
Definition: relation.c:205
Relation relation_openrv(const RangeVar *relation, LOCKMODE lockmode)
Definition: relation.c:137
MemoryContext ecxt_per_query_memory
Definition: execnodes.h:262
Definition: fmgr.h:57
void * fn_extra
Definition: fmgr.h:64
fmNodePtr fn_expr
Definition: fmgr.h:66
Oid fn_oid
Definition: fmgr.h:59
void * user_fctx
Definition: funcapi.h:82
uint64 max_calls
Definition: funcapi.h:74
uint64 call_cntr
Definition: funcapi.h:65
AttInMetadata * attinmeta
Definition: funcapi.h:91
MemoryContext multi_call_memory_ctx
Definition: funcapi.h:101
TupleDesc tuple_desc
Definition: funcapi.h:112
fmNodePtr resultinfo
Definition: fmgr.h:89
FmgrInfo * flinfo
Definition: fmgr.h:87
Definition: pg_list.h:54
Definition: nodes.h:129
SetFunctionReturnMode returnMode
Definition: execnodes.h:336
ExprContext * econtext
Definition: execnodes.h:332
TupleDesc setDesc
Definition: execnodes.h:340
Tuplestorestate * setResult
Definition: execnodes.h:339
TupleDesc expectedDesc
Definition: execnodes.h:333
int allowedModes
Definition: execnodes.h:334
List * args
Definition: primnodes.h:1367
int32 tdtypmod
Definition: tupdesc.h:83
Oid tdtypeid
Definition: tupdesc.h:82
Definition: c.h:713
int dim1
Definition: c.h:718
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:720
Oid anymultirange_type
Definition: funcapi.c:40
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 CreateTemplateTupleDesc(int natts)
Definition: tupdesc.c:67
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:133
void TupleDescInitEntryCollation(TupleDesc desc, AttrNumber attributeNumber, Oid collationid)
Definition: tupdesc.c:833
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition: tupdesc.c:651
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
Tuplestorestate * tuplestore_begin_heap(bool randomAccess, bool interXact, int maxKBytes)
Definition: tuplestore.c:318
void assign_record_type_typmod(TupleDesc tupDesc)
Definition: typcache.c:1953
TupleDesc lookup_rowtype_tupdesc_copy(Oid type_id, int32 typmod)
Definition: typcache.c:1867
#define strVal(v)
Definition: value.h:82