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