TLA 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-2023, 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 ECB : *
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 GIC 12102 : InitMaterializedSRF(FunctionCallInfo fcinfo, bits32 flags)
77 ECB : {
78 EUB : bool random_access;
79 GIC 12102 : ReturnSetInfo *rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
80 : Tuplestorestate *tupstore;
81 ECB : MemoryContext old_context,
82 : per_query_ctx;
83 EUB : TupleDesc stored_tupdesc;
84 :
85 : /* check to see if caller supports returning a tuplestore */
86 GIC 12102 : if (rsinfo == NULL || !IsA(rsinfo, ReturnSetInfo))
87 UIC 0 : ereport(ERROR,
88 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
89 : errmsg("set-valued function called in context that cannot accept a set")));
90 GIC 12102 : if (!(rsinfo->allowedModes & SFRM_Materialize) ||
91 CBC 12102 : ((flags & MAT_SRF_USE_EXPECTED_DESC) != 0 && rsinfo->expectedDesc == NULL))
92 LBC 0 : ereport(ERROR,
93 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
94 : errmsg("materialize mode required, but it is not allowed in this context")));
95 ECB :
96 : /*
97 : * Store the tuplestore and the tuple descriptor in ReturnSetInfo. This
98 : * must be done in the per-query memory context.
99 : */
100 GBC 12102 : per_query_ctx = rsinfo->econtext->ecxt_per_query_memory;
101 GIC 12102 : old_context = MemoryContextSwitchTo(per_query_ctx);
102 :
103 : /* build a tuple descriptor for our result type */
104 CBC 12102 : if ((flags & MAT_SRF_USE_EXPECTED_DESC) != 0)
105 963 : stored_tupdesc = CreateTupleDescCopy(rsinfo->expectedDesc);
106 : else
107 ECB : {
108 GIC 11139 : if (get_call_result_type(fcinfo, NULL, &stored_tupdesc) != TYPEFUNC_COMPOSITE)
109 LBC 0 : elog(ERROR, "return type must be a row type");
110 ECB : }
111 :
112 : /* If requested, bless the tuple descriptor */
113 CBC 12102 : if ((flags & MAT_SRF_BLESS) != 0)
114 6333 : BlessTupleDesc(stored_tupdesc);
115 :
116 GIC 12102 : random_access = (rsinfo->allowedModes & SFRM_Materialize_Random) != 0;
117 :
118 12102 : tupstore = tuplestore_begin_heap(random_access, false, work_mem);
119 12102 : rsinfo->returnMode = SFRM_Materialize;
120 12102 : rsinfo->setResult = tupstore;
121 12102 : rsinfo->setDesc = stored_tupdesc;
122 12102 : MemoryContextSwitchTo(old_context);
123 12102 : }
124 ECB :
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 EUB : FuncCallContext *
133 GIC 81138 : init_MultiFuncCall(PG_FUNCTION_ARGS)
134 : {
135 : FuncCallContext *retval;
136 ECB :
137 : /*
138 : * Bail if we're called in the wrong context
139 : */
140 GIC 81138 : if (fcinfo->resultinfo == NULL || !IsA(fcinfo->resultinfo, ReturnSetInfo))
141 LBC 0 : ereport(ERROR,
142 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
143 : errmsg("set-valued function called in context that cannot accept a set")));
144 :
145 GIC 81138 : if (fcinfo->flinfo->fn_extra == NULL)
146 : {
147 ECB : /*
148 : * First call
149 : */
150 GIC 81138 : 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 ECB : */
156 GIC 81138 : multi_call_ctx = AllocSetContextCreate(fcinfo->flinfo->fn_mcxt,
157 : "SRF multi-call context",
158 : ALLOCSET_SMALL_SIZES);
159 :
160 : /*
161 ECB : * Allocate suitably long-lived space and zero it
162 : */
163 : retval = (FuncCallContext *)
164 CBC 81138 : MemoryContextAllocZero(multi_call_ctx,
165 ECB : sizeof(FuncCallContext));
166 :
167 : /*
168 : * initialize the elements
169 : */
170 GIC 81138 : retval->call_cntr = 0;
171 CBC 81138 : retval->max_calls = 0;
172 GIC 81138 : retval->user_fctx = NULL;
173 81138 : retval->attinmeta = NULL;
174 81138 : retval->tuple_desc = NULL;
175 81138 : retval->multi_call_memory_ctx = multi_call_ctx;
176 :
177 ECB : /*
178 : * save the pointer for cross-call use
179 : */
180 GIC 81138 : fcinfo->flinfo->fn_extra = retval;
181 :
182 : /*
183 : * Ensure we will get shut down cleanly if the exprcontext is not run
184 EUB : * to completion.
185 : */
186 GIC 81138 : RegisterExprContextCallback(rsi->econtext,
187 : shutdown_MultiFuncCall,
188 81138 : PointerGetDatum(fcinfo->flinfo));
189 : }
190 ECB : else
191 : {
192 : /* second and subsequent calls */
193 UIC 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 CBC 81138 : return retval;
200 : }
201 ECB :
202 : /*
203 : * per_MultiFuncCall
204 : *
205 : * Do Multi-function per-call setup
206 : */
207 : FuncCallContext *
208 GIC 8401397 : per_MultiFuncCall(PG_FUNCTION_ARGS)
209 : {
210 8401397 : FuncCallContext *retval = (FuncCallContext *) fcinfo->flinfo->fn_extra;
211 ECB :
212 GIC 8401397 : return retval;
213 ECB : }
214 :
215 : /*
216 : * end_MultiFuncCall
217 : * Clean up after init_MultiFuncCall
218 : */
219 : void
220 GIC 80702 : end_MultiFuncCall(PG_FUNCTION_ARGS, FuncCallContext *funcctx)
221 ECB : {
222 CBC 80702 : ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
223 :
224 : /* Deregister the shutdown callback */
225 GIC 80702 : UnregisterExprContextCallback(rsi->econtext,
226 : shutdown_MultiFuncCall,
227 80702 : PointerGetDatum(fcinfo->flinfo));
228 :
229 ECB : /* But use it to do the real work */
230 GIC 80702 : shutdown_MultiFuncCall(PointerGetDatum(fcinfo->flinfo));
231 CBC 80702 : }
232 ECB :
233 : /*
234 : * shutdown_MultiFuncCall
235 : * Shutdown function to clean up after init_MultiFuncCall
236 : */
237 : static void
238 GIC 80735 : shutdown_MultiFuncCall(Datum arg)
239 : {
240 80735 : FmgrInfo *flinfo = (FmgrInfo *) DatumGetPointer(arg);
241 CBC 80735 : FuncCallContext *funcctx = (FuncCallContext *) flinfo->fn_extra;
242 ECB :
243 : /* unbind from flinfo */
244 GIC 80735 : flinfo->fn_extra = NULL;
245 :
246 : /*
247 : * Delete context that holds all multi-call data, including the
248 : * FuncCallContext itself
249 : */
250 80735 : MemoryContextDelete(funcctx->multi_call_memory_ctx);
251 80735 : }
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 ECB : *
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 GIC 33230 : get_call_result_type(FunctionCallInfo fcinfo,
277 : Oid *resultTypeId,
278 : TupleDesc *resultTupleDesc)
279 : {
280 66460 : return internal_get_result_type(fcinfo->flinfo->fn_oid,
281 33230 : fcinfo->flinfo->fn_expr,
282 33230 : (ReturnSetInfo *) fcinfo->resultinfo,
283 ECB : resultTypeId,
284 : resultTupleDesc);
285 : }
286 :
287 : /*
288 : * get_expr_result_type
289 : * As above, but work from a calling expression node tree
290 : */
291 : TypeFuncClass
292 GIC 279708 : get_expr_result_type(Node *expr,
293 : Oid *resultTypeId,
294 : TupleDesc *resultTupleDesc)
295 ECB : {
296 : TypeFuncClass result;
297 :
298 GIC 279708 : if (expr && IsA(expr, FuncExpr))
299 254703 : result = internal_get_result_type(((FuncExpr *) expr)->funcid,
300 : expr,
301 ECB : NULL,
302 : resultTypeId,
303 : resultTupleDesc);
304 GIC 25005 : else if (expr && IsA(expr, OpExpr))
305 CBC 12 : result = internal_get_result_type(get_opcode(((OpExpr *) expr)->opno),
306 : expr,
307 ECB : NULL,
308 : resultTypeId,
309 : resultTupleDesc);
310 GIC 24993 : else if (expr && IsA(expr, RowExpr) &&
311 CBC 30 : ((RowExpr *) expr)->row_typeid == RECORDOID)
312 ECB : {
313 : /* We can resolve the record type by generating the tupdesc directly */
314 GIC 30 : RowExpr *rexpr = (RowExpr *) expr;
315 ECB : TupleDesc tupdesc;
316 CBC 30 : AttrNumber i = 1;
317 : ListCell *lcc,
318 ECB : *lcn;
319 :
320 GIC 30 : tupdesc = CreateTemplateTupleDesc(list_length(rexpr->args));
321 30 : Assert(list_length(rexpr->args) == list_length(rexpr->colnames));
322 87 : forboth(lcc, rexpr->args, lcn, rexpr->colnames)
323 ECB : {
324 GIC 57 : Node *col = (Node *) lfirst(lcc);
325 CBC 57 : char *colname = strVal(lfirst(lcn));
326 :
327 57 : TupleDescInitEntry(tupdesc, i,
328 EUB : colname,
329 ECB : exprType(col),
330 : exprTypmod(col),
331 : 0);
332 GIC 57 : TupleDescInitEntryCollation(tupdesc, i,
333 ECB : exprCollation(col));
334 CBC 57 : i++;
335 ECB : }
336 GIC 30 : if (resultTypeId)
337 UIC 0 : *resultTypeId = rexpr->row_typeid;
338 GIC 30 : if (resultTupleDesc)
339 30 : *resultTupleDesc = BlessTupleDesc(tupdesc);
340 30 : return TYPEFUNC_COMPOSITE;
341 : }
342 24963 : else if (expr && IsA(expr, Const) &&
343 216 : ((Const *) expr)->consttype == RECORDOID &&
344 3 : !((Const *) expr)->constisnull)
345 : {
346 ECB : /*
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 EUB : */
351 ECB : HeapTupleHeader rec;
352 : Oid tupType;
353 : int32 tupTypmod;
354 :
355 CBC 3 : rec = DatumGetHeapTupleHeader(((Const *) expr)->constvalue);
356 GIC 3 : tupType = HeapTupleHeaderGetTypeId(rec);
357 CBC 3 : tupTypmod = HeapTupleHeaderGetTypMod(rec);
358 GIC 3 : if (resultTypeId)
359 UIC 0 : *resultTypeId = tupType;
360 GIC 3 : if (tupType != RECORDOID || tupTypmod >= 0)
361 : {
362 EUB : /* Should be able to look it up */
363 GBC 3 : if (resultTupleDesc)
364 3 : *resultTupleDesc = lookup_rowtype_tupdesc_copy(tupType,
365 : tupTypmod);
366 GIC 3 : return TYPEFUNC_COMPOSITE;
367 : }
368 : else
369 : {
370 ECB : /* This shouldn't really happen ... */
371 UIC 0 : if (resultTupleDesc)
372 0 : *resultTupleDesc = NULL;
373 LBC 0 : return TYPEFUNC_RECORD;
374 ECB : }
375 : }
376 : else
377 : {
378 : /* handle as a generic expression; no chance to resolve RECORD */
379 CBC 24960 : Oid typid = exprType(expr);
380 : Oid base_typid;
381 ECB :
382 GIC 24960 : if (resultTypeId)
383 228 : *resultTypeId = typid;
384 CBC 24960 : if (resultTupleDesc)
385 GIC 24960 : *resultTupleDesc = NULL;
386 24960 : result = get_type_func_class(typid, &base_typid);
387 24960 : if ((result == TYPEFUNC_COMPOSITE ||
388 24758 : result == TYPEFUNC_COMPOSITE_DOMAIN) &&
389 : resultTupleDesc)
390 24758 : *resultTupleDesc = lookup_rowtype_tupdesc_copy(base_typid, -1);
391 : }
392 :
393 279675 : return result;
394 ECB : }
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 : */
402 : TypeFuncClass
403 GIC 17793 : get_func_result_type(Oid functionId,
404 : Oid *resultTypeId,
405 : TupleDesc *resultTupleDesc)
406 : {
407 17793 : return internal_get_result_type(functionId,
408 : NULL,
409 : NULL,
410 : resultTypeId,
411 : resultTupleDesc);
412 : }
413 :
414 ECB : /*
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
423 GIC 305738 : internal_get_result_type(Oid funcid,
424 : Node *call_expr,
425 : ReturnSetInfo *rsinfo,
426 : Oid *resultTypeId,
427 : TupleDesc *resultTupleDesc)
428 ECB : {
429 : TypeFuncClass result;
430 EUB : HeapTuple tp;
431 ECB : 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 CBC 305738 : tp = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcid));
438 GIC 305738 : if (!HeapTupleIsValid(tp))
439 UIC 0 : elog(ERROR, "cache lookup failed for function %u", funcid);
440 GIC 305738 : procform = (Form_pg_proc) GETSTRUCT(tp);
441 :
442 305738 : rettype = procform->prorettype;
443 :
444 ECB : /* Check for OUT parameters defining a RECORD result */
445 CBC 305738 : tupdesc = build_function_result_tupdesc_t(tp);
446 GIC 305738 : if (tupdesc)
447 ECB : {
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 CBC 244028 : if (resultTypeId)
454 43363 : *resultTypeId = rettype;
455 ECB :
456 CBC 244028 : if (resolve_polymorphic_tupdesc(tupdesc,
457 : &procform->proargtypes,
458 : call_expr))
459 : {
460 GBC 244028 : if (tupdesc->tdtypeid == RECORDOID &&
461 244028 : tupdesc->tdtypmod < 0)
462 244028 : assign_record_type_typmod(tupdesc);
463 GIC 244028 : if (resultTupleDesc)
464 244028 : *resultTupleDesc = tupdesc;
465 CBC 244028 : result = TYPEFUNC_COMPOSITE;
466 : }
467 ECB : else
468 : {
469 UIC 0 : if (resultTupleDesc)
470 0 : *resultTupleDesc = NULL;
471 0 : result = TYPEFUNC_RECORD;
472 : }
473 ECB :
474 GIC 244028 : ReleaseSysCache(tp);
475 ECB :
476 GIC 244028 : return result;
477 ECB : }
478 EUB :
479 : /*
480 : * If scalar polymorphic result, try to resolve it.
481 : */
482 GIC 61710 : if (IsPolymorphicType(rettype))
483 ECB : {
484 GIC 7978 : Oid newrettype = exprType(call_expr);
485 :
486 CBC 7978 : if (newrettype == InvalidOid) /* this probably should not happen */
487 LBC 0 : ereport(ERROR,
488 ECB : (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 CBC 7978 : rettype = newrettype;
493 ECB : }
494 :
495 CBC 61710 : if (resultTypeId)
496 GIC 54635 : *resultTypeId = rettype;
497 CBC 61710 : if (resultTupleDesc)
498 61710 : *resultTupleDesc = NULL; /* default result */
499 :
500 ECB : /* Classify the result type */
501 CBC 61710 : result = get_type_func_class(rettype, &base_rettype);
502 61710 : switch (result)
503 ECB : {
504 GIC 2842 : case TYPEFUNC_COMPOSITE:
505 ECB : case TYPEFUNC_COMPOSITE_DOMAIN:
506 CBC 2842 : if (resultTupleDesc)
507 GIC 2842 : *resultTupleDesc = lookup_rowtype_tupdesc_copy(base_rettype, -1);
508 ECB : /* Named composite types can't have any polymorphic columns */
509 CBC 2842 : break;
510 57675 : case TYPEFUNC_SCALAR:
511 GIC 57675 : break;
512 1187 : case TYPEFUNC_RECORD:
513 ECB : /* We must get the tupledesc from call context */
514 CBC 1187 : if (rsinfo && IsA(rsinfo, ReturnSetInfo) &&
515 290 : rsinfo->expectedDesc != NULL)
516 : {
517 GIC 267 : result = TYPEFUNC_COMPOSITE;
518 CBC 267 : if (resultTupleDesc)
519 GIC 267 : *resultTupleDesc = rsinfo->expectedDesc;
520 ECB : /* Assume no polymorphic columns here, either */
521 : }
522 GIC 1187 : break;
523 6 : default:
524 6 : break;
525 : }
526 :
527 61710 : ReleaseSysCache(tp);
528 :
529 61710 : return result;
530 : }
531 :
532 : /*
533 : * get_expr_result_tupdesc
534 ECB : * 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 CBC 205843 : get_expr_result_tupdesc(Node *expr, bool noError)
544 : {
545 ECB : TupleDesc tupleDesc;
546 : TypeFuncClass functypclass;
547 EUB :
548 GIC 205843 : functypclass = get_expr_result_type(expr, NULL, &tupleDesc);
549 EUB :
550 GBC 205843 : if (functypclass == TYPEFUNC_COMPOSITE ||
551 : functypclass == TYPEFUNC_COMPOSITE_DOMAIN)
552 GIC 204959 : return tupleDesc;
553 :
554 884 : if (!noError)
555 EUB : {
556 UIC 0 : Oid exprTypeId = exprType(expr);
557 :
558 0 : if (exprTypeId != RECORDOID)
559 0 : ereport(ERROR,
560 ECB : (errcode(ERRCODE_WRONG_OBJECT_TYPE),
561 : errmsg("type %s is not composite",
562 : format_type_be(exprTypeId))));
563 : else
564 UIC 0 : ereport(ERROR,
565 : (errcode(ERRCODE_WRONG_OBJECT_TYPE),
566 : errmsg("record type has not been registered")));
567 : }
568 :
569 GIC 884 : return NULL;
570 : }
571 :
572 ECB : /*
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
581 GBC 5847 : resolve_anyelement_from_others(polymorphic_actuals *actuals)
582 : {
583 GIC 5847 : if (OidIsValid(actuals->anyarray_type))
584 : {
585 : /* Use the element type corresponding to actual type */
586 CBC 5763 : Oid array_base_type = getBaseType(actuals->anyarray_type);
587 GIC 5763 : Oid array_typelem = get_element_type(array_base_type);
588 ECB :
589 GIC 5763 : if (!OidIsValid(array_typelem))
590 UIC 0 : ereport(ERROR,
591 ECB : (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 GBC 5763 : actuals->anyelement_type = array_typelem;
596 : }
597 GIC 84 : else if (OidIsValid(actuals->anyrange_type))
598 : {
599 : /* Use the element type corresponding to actual type */
600 CBC 66 : Oid range_base_type = getBaseType(actuals->anyrange_type);
601 GIC 66 : Oid range_typelem = get_range_subtype(range_base_type);
602 ECB :
603 GIC 66 : if (!OidIsValid(range_typelem))
604 UIC 0 : 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 GIC 66 : actuals->anyelement_type = range_typelem;
610 ECB : }
611 CBC 18 : else if (OidIsValid(actuals->anymultirange_type))
612 ECB : {
613 EUB : /* 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 CBC 18 : multirange_base_type = getBaseType(actuals->anymultirange_type);
620 18 : multirange_typelem = get_multirange_range(multirange_base_type);
621 GIC 18 : if (!OidIsValid(multirange_typelem))
622 LBC 0 : ereport(ERROR,
623 EUB : (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 CBC 18 : range_base_type = getBaseType(multirange_typelem);
629 GIC 18 : range_typelem = get_range_subtype(range_base_type);
630 :
631 GBC 18 : if (!OidIsValid(range_typelem))
632 LBC 0 : 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 GIC 18 : actuals->anyelement_type = range_typelem;
638 ECB : }
639 : else
640 UIC 0 : elog(ERROR, "could not determine polymorphic type");
641 CBC 5847 : }
642 ECB :
643 : /*
644 : * Resolve actual type of ANYARRAY from other polymorphic inputs
645 : */
646 : static void
647 CBC 156 : resolve_anyarray_from_others(polymorphic_actuals *actuals)
648 : {
649 ECB : /* If we don't know ANYELEMENT, resolve that first */
650 GBC 156 : if (!OidIsValid(actuals->anyelement_type))
651 GIC 27 : resolve_anyelement_from_others(actuals);
652 :
653 156 : if (OidIsValid(actuals->anyelement_type))
654 ECB : {
655 : /* Use the array type corresponding to actual type */
656 GIC 156 : Oid array_typeid = get_array_type(actuals->anyelement_type);
657 EUB :
658 CBC 156 : if (!OidIsValid(array_typeid))
659 UIC 0 : 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 GIC 156 : actuals->anyarray_type = array_typeid;
664 ECB : }
665 : else
666 UIC 0 : elog(ERROR, "could not determine polymorphic type");
667 GIC 156 : }
668 :
669 : /*
670 : * Resolve actual type of ANYRANGE from other polymorphic inputs
671 ECB : */
672 : static void
673 GIC 9 : resolve_anyrange_from_others(polymorphic_actuals *actuals)
674 ECB : {
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 EUB : * but we can deduce it from a polymorphic multirange type.
679 : */
680 GIC 9 : if (OidIsValid(actuals->anymultirange_type))
681 : {
682 : /* Use the element type based on the multirange type */
683 CBC 9 : Oid multirange_base_type = getBaseType(actuals->anymultirange_type);
684 GIC 9 : Oid multirange_typelem = get_multirange_range(multirange_base_type);
685 :
686 GBC 9 : if (!OidIsValid(multirange_typelem))
687 LBC 0 : 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 GIC 9 : actuals->anyrange_type = multirange_typelem;
693 ECB : }
694 : else
695 UIC 0 : elog(ERROR, "could not determine polymorphic type");
696 GIC 9 : }
697 :
698 : /*
699 : * Resolve actual type of ANYMULTIRANGE from other polymorphic inputs
700 ECB : */
701 : static void
702 CBC 9 : resolve_anymultirange_from_others(polymorphic_actuals *actuals)
703 ECB : {
704 : /*
705 : * We can't deduce a multirange type from polymorphic array or base types,
706 EUB : * because there may be multiple range types with the same subtype, but we
707 : * can deduce it from a polymorphic range type.
708 : */
709 GIC 9 : if (OidIsValid(actuals->anyrange_type))
710 ECB : {
711 GIC 9 : Oid range_base_type = getBaseType(actuals->anyrange_type);
712 9 : Oid multirange_typeid = get_range_multirange(range_base_type);
713 EUB :
714 CBC 9 : if (!OidIsValid(multirange_typeid))
715 UIC 0 : 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 GIC 9 : actuals->anymultirange_type = multirange_typeid;
720 : }
721 : else
722 UIC 0 : elog(ERROR, "could not determine polymorphic type");
723 GIC 9 : }
724 :
725 : /*
726 : * Given the result tuple descriptor for a function with OUT parameters,
727 ECB : * 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
736 CBC 244028 : resolve_polymorphic_tupdesc(TupleDesc tupdesc, oidvector *declared_args,
737 ECB : Node *call_expr)
738 : {
739 CBC 244028 : int natts = tupdesc->natts;
740 244028 : int nargs = declared_args->dim1;
741 GIC 244028 : bool have_polymorphic_result = false;
742 244028 : bool have_anyelement_result = false;
743 CBC 244028 : bool have_anyarray_result = false;
744 244028 : bool have_anyrange_result = false;
745 GIC 244028 : bool have_anymultirange_result = false;
746 244028 : bool have_anycompatible_result = false;
747 244028 : bool have_anycompatible_array_result = false;
748 CBC 244028 : bool have_anycompatible_range_result = false;
749 GIC 244028 : bool have_anycompatible_multirange_result = false;
750 ECB : polymorphic_actuals poly_actuals;
751 : polymorphic_actuals anyc_actuals;
752 CBC 244028 : Oid anycollation = InvalidOid;
753 GIC 244028 : Oid anycompatcollation = InvalidOid;
754 : int i;
755 ECB :
756 : /* See if there are any polymorphic outputs; quick out if not */
757 CBC 3673144 : for (i = 0; i < natts; i++)
758 ECB : {
759 CBC 3429116 : switch (TupleDescAttr(tupdesc, i)->atttypid)
760 ECB : {
761 CBC 5844 : case ANYELEMENTOID:
762 ECB : case ANYNONARRAYOID:
763 : case ANYENUMOID:
764 CBC 5844 : have_polymorphic_result = true;
765 5844 : have_anyelement_result = true;
766 5844 : break;
767 126 : case ANYARRAYOID:
768 126 : have_polymorphic_result = true;
769 126 : have_anyarray_result = true;
770 126 : break;
771 GIC 27 : case ANYRANGEOID:
772 CBC 27 : have_polymorphic_result = true;
773 27 : have_anyrange_result = true;
774 27 : break;
775 36 : case ANYMULTIRANGEOID:
776 36 : have_polymorphic_result = true;
777 36 : have_anymultirange_result = true;
778 36 : break;
779 45 : case ANYCOMPATIBLEOID:
780 ECB : case ANYCOMPATIBLENONARRAYOID:
781 CBC 45 : have_polymorphic_result = true;
782 45 : have_anycompatible_result = true;
783 GBC 45 : break;
784 99 : case ANYCOMPATIBLEARRAYOID:
785 99 : have_polymorphic_result = true;
786 99 : have_anycompatible_array_result = true;
787 CBC 99 : break;
788 9 : case ANYCOMPATIBLERANGEOID:
789 GIC 9 : have_polymorphic_result = true;
790 9 : have_anycompatible_range_result = true;
791 CBC 9 : break;
792 LBC 0 : case ANYCOMPATIBLEMULTIRANGEOID:
793 UIC 0 : have_polymorphic_result = true;
794 0 : have_anycompatible_multirange_result = true;
795 0 : break;
796 GIC 3422930 : default:
797 3422930 : break;
798 : }
799 : }
800 244028 : if (!have_polymorphic_result)
801 CBC 238031 : return true;
802 EUB :
803 : /*
804 ECB : * 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 GIC 5997 : if (!call_expr)
811 LBC 0 : return false; /* no hope */
812 :
813 GIC 5997 : memset(&poly_actuals, 0, sizeof(poly_actuals));
814 CBC 5997 : memset(&anyc_actuals, 0, sizeof(anyc_actuals));
815 :
816 12183 : for (i = 0; i < nargs; i++)
817 ECB : {
818 CBC 6186 : switch (declared_args->values[i])
819 EUB : {
820 GIC 99 : case ANYELEMENTOID:
821 ECB : case ANYNONARRAYOID:
822 : case ANYENUMOID:
823 CBC 99 : if (!OidIsValid(poly_actuals.anyelement_type))
824 : {
825 99 : poly_actuals.anyelement_type =
826 99 : get_call_expr_argtype(call_expr, i);
827 99 : if (!OidIsValid(poly_actuals.anyelement_type))
828 UBC 0 : return false;
829 : }
830 CBC 99 : break;
831 5817 : case ANYARRAYOID:
832 5817 : if (!OidIsValid(poly_actuals.anyarray_type))
833 : {
834 5817 : poly_actuals.anyarray_type =
835 5817 : get_call_expr_argtype(call_expr, i);
836 5817 : if (!OidIsValid(poly_actuals.anyarray_type))
837 UBC 0 : return false;
838 : }
839 CBC 5817 : break;
840 54 : case ANYRANGEOID:
841 54 : if (!OidIsValid(poly_actuals.anyrange_type))
842 : {
843 54 : poly_actuals.anyrange_type =
844 54 : get_call_expr_argtype(call_expr, i);
845 54 : if (!OidIsValid(poly_actuals.anyrange_type))
846 UBC 0 : return false;
847 : }
848 CBC 54 : break;
849 45 : case ANYMULTIRANGEOID:
850 GIC 45 : if (!OidIsValid(poly_actuals.anymultirange_type))
851 ECB : {
852 GIC 45 : poly_actuals.anymultirange_type =
853 CBC 45 : get_call_expr_argtype(call_expr, i);
854 45 : if (!OidIsValid(poly_actuals.anymultirange_type))
855 LBC 0 : return false;
856 EUB : }
857 GIC 45 : break;
858 CBC 126 : case ANYCOMPATIBLEOID:
859 ECB : case ANYCOMPATIBLENONARRAYOID:
860 CBC 126 : if (!OidIsValid(anyc_actuals.anyelement_type))
861 : {
862 72 : anyc_actuals.anyelement_type =
863 72 : get_call_expr_argtype(call_expr, i);
864 72 : if (!OidIsValid(anyc_actuals.anyelement_type))
865 UBC 0 : return false;
866 : }
867 CBC 126 : break;
868 18 : case ANYCOMPATIBLEARRAYOID:
869 18 : if (!OidIsValid(anyc_actuals.anyarray_type))
870 : {
871 18 : anyc_actuals.anyarray_type =
872 18 : get_call_expr_argtype(call_expr, i);
873 18 : if (!OidIsValid(anyc_actuals.anyarray_type))
874 UBC 0 : return false;
875 : }
876 CBC 18 : break;
877 GBC 27 : case ANYCOMPATIBLERANGEOID:
878 27 : if (!OidIsValid(anyc_actuals.anyrange_type))
879 : {
880 27 : anyc_actuals.anyrange_type =
881 27 : get_call_expr_argtype(call_expr, i);
882 27 : if (!OidIsValid(anyc_actuals.anyrange_type))
883 UBC 0 : return false;
884 : }
885 GBC 27 : break;
886 UBC 0 : case ANYCOMPATIBLEMULTIRANGEOID:
887 0 : if (!OidIsValid(anyc_actuals.anymultirange_type))
888 : {
889 UIC 0 : anyc_actuals.anymultirange_type =
890 0 : get_call_expr_argtype(call_expr, i);
891 0 : if (!OidIsValid(anyc_actuals.anymultirange_type))
892 LBC 0 : return false;
893 ECB : }
894 UIC 0 : break;
895 LBC 0 : default:
896 0 : break;
897 : }
898 ECB : }
899 :
900 : /* If needed, deduce one polymorphic type from others */
901 CBC 5997 : if (have_anyelement_result && !OidIsValid(poly_actuals.anyelement_type))
902 5790 : resolve_anyelement_from_others(&poly_actuals);
903 :
904 5997 : if (have_anyarray_result && !OidIsValid(poly_actuals.anyarray_type))
905 63 : resolve_anyarray_from_others(&poly_actuals);
906 :
907 5997 : if (have_anyrange_result && !OidIsValid(poly_actuals.anyrange_type))
908 9 : resolve_anyrange_from_others(&poly_actuals);
909 :
910 5997 : if (have_anymultirange_result && !OidIsValid(poly_actuals.anymultirange_type))
911 GBC 9 : resolve_anymultirange_from_others(&poly_actuals);
912 :
913 CBC 5997 : if (have_anycompatible_result && !OidIsValid(anyc_actuals.anyelement_type))
914 GBC 27 : resolve_anyelement_from_others(&anyc_actuals);
915 :
916 GIC 5997 : if (have_anycompatible_array_result && !OidIsValid(anyc_actuals.anyarray_type))
917 81 : resolve_anyarray_from_others(&anyc_actuals);
918 :
919 5997 : if (have_anycompatible_range_result && !OidIsValid(anyc_actuals.anyrange_type))
920 UIC 0 : resolve_anyrange_from_others(&anyc_actuals);
921 :
922 GIC 5997 : if (have_anycompatible_multirange_result && !OidIsValid(anyc_actuals.anymultirange_type))
923 LBC 0 : resolve_anymultirange_from_others(&anyc_actuals);
924 ECB :
925 : /*
926 EUB : * Identify the collation to use for polymorphic OUT parameters. (It'll
927 : * necessarily be the same for both anyelement and anyarray, likewise for
928 ECB : * 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 EUB : */
932 GIC 5997 : if (OidIsValid(poly_actuals.anyelement_type))
933 CBC 5916 : anycollation = get_typcollation(poly_actuals.anyelement_type);
934 GIC 81 : else if (OidIsValid(poly_actuals.anyarray_type))
935 UIC 0 : anycollation = get_typcollation(poly_actuals.anyarray_type);
936 :
937 GIC 5997 : if (OidIsValid(anyc_actuals.anyelement_type))
938 99 : anycompatcollation = get_typcollation(anyc_actuals.anyelement_type);
939 5898 : else if (OidIsValid(anyc_actuals.anyarray_type))
940 LBC 0 : anycompatcollation = get_typcollation(anyc_actuals.anyarray_type);
941 :
942 CBC 5997 : if (OidIsValid(anycollation) || OidIsValid(anycompatcollation))
943 : {
944 ECB : /*
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 EUB : * for the function.
948 : */
949 GIC 33 : Oid inputcollation = exprInputCollation(call_expr);
950 :
951 33 : if (OidIsValid(inputcollation))
952 ECB : {
953 GIC 21 : if (OidIsValid(anycollation))
954 CBC 21 : anycollation = inputcollation;
955 GIC 21 : if (OidIsValid(anycompatcollation))
956 LBC 0 : anycompatcollation = inputcollation;
957 : }
958 ECB : }
959 :
960 : /* And finally replace the tuple column types as needed */
961 CBC 18000 : for (i = 0; i < natts; i++)
962 ECB : {
963 GIC 12003 : Form_pg_attribute att = TupleDescAttr(tupdesc, i);
964 :
965 12003 : switch (att->atttypid)
966 ECB : {
967 CBC 5844 : case ANYELEMENTOID:
968 ECB : case ANYNONARRAYOID:
969 : case ANYENUMOID:
970 CBC 5844 : TupleDescInitEntry(tupdesc, i + 1,
971 GIC 5844 : NameStr(att->attname),
972 : poly_actuals.anyelement_type,
973 : -1,
974 ECB : 0);
975 CBC 5844 : TupleDescInitEntryCollation(tupdesc, i + 1, anycollation);
976 5844 : break;
977 126 : case ANYARRAYOID:
978 126 : TupleDescInitEntry(tupdesc, i + 1,
979 GIC 126 : NameStr(att->attname),
980 : poly_actuals.anyarray_type,
981 : -1,
982 : 0);
983 CBC 126 : TupleDescInitEntryCollation(tupdesc, i + 1, anycollation);
984 126 : break;
985 27 : case ANYRANGEOID:
986 27 : TupleDescInitEntry(tupdesc, i + 1,
987 GIC 27 : NameStr(att->attname),
988 : poly_actuals.anyrange_type,
989 : -1,
990 : 0);
991 ECB : /* no collation should be attached to a range type */
992 CBC 27 : break;
993 GIC 36 : case ANYMULTIRANGEOID:
994 CBC 36 : TupleDescInitEntry(tupdesc, i + 1,
995 36 : NameStr(att->attname),
996 : poly_actuals.anymultirange_type,
997 : -1,
998 : 0);
999 ECB : /* no collation should be attached to a multirange type */
1000 CBC 36 : break;
1001 45 : case ANYCOMPATIBLEOID:
1002 ECB : case ANYCOMPATIBLENONARRAYOID:
1003 CBC 45 : TupleDescInitEntry(tupdesc, i + 1,
1004 GIC 45 : NameStr(att->attname),
1005 : anyc_actuals.anyelement_type,
1006 : -1,
1007 ECB : 0);
1008 CBC 45 : TupleDescInitEntryCollation(tupdesc, i + 1, anycompatcollation);
1009 45 : break;
1010 99 : case ANYCOMPATIBLEARRAYOID:
1011 99 : TupleDescInitEntry(tupdesc, i + 1,
1012 GIC 99 : NameStr(att->attname),
1013 : anyc_actuals.anyarray_type,
1014 : -1,
1015 : 0);
1016 CBC 99 : TupleDescInitEntryCollation(tupdesc, i + 1, anycompatcollation);
1017 GBC 99 : break;
1018 9 : case ANYCOMPATIBLERANGEOID:
1019 9 : TupleDescInitEntry(tupdesc, i + 1,
1020 GIC 9 : NameStr(att->attname),
1021 : anyc_actuals.anyrange_type,
1022 : -1,
1023 : 0);
1024 EUB : /* no collation should be attached to a range type */
1025 CBC 9 : break;
1026 LBC 0 : case ANYCOMPATIBLEMULTIRANGEOID:
1027 UIC 0 : TupleDescInitEntry(tupdesc, i + 1,
1028 0 : NameStr(att->attname),
1029 : anyc_actuals.anymultirange_type,
1030 ECB : -1,
1031 : 0);
1032 : /* no collation should be attached to a multirange type */
1033 UIC 0 : break;
1034 GIC 5817 : default:
1035 5817 : break;
1036 : }
1037 : }
1038 :
1039 5997 : 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 ECB : * 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 CBC 6113 : resolve_polymorphic_argtypes(int numargs, Oid *argtypes, char *argmodes,
1057 ECB : Node *call_expr)
1058 : {
1059 GIC 6113 : bool have_polymorphic_result = false;
1060 6113 : bool have_anyelement_result = false;
1061 6113 : bool have_anyarray_result = false;
1062 6113 : bool have_anyrange_result = false;
1063 6113 : bool have_anymultirange_result = false;
1064 6113 : bool have_anycompatible_result = false;
1065 6113 : bool have_anycompatible_array_result = false;
1066 6113 : bool have_anycompatible_range_result = false;
1067 6113 : bool have_anycompatible_multirange_result = false;
1068 : polymorphic_actuals poly_actuals;
1069 ECB : 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 CBC 6113 : memset(&poly_actuals, 0, sizeof(poly_actuals));
1079 GIC 6113 : memset(&anyc_actuals, 0, sizeof(anyc_actuals));
1080 6113 : inargno = 0;
1081 CBC 14782 : for (i = 0; i < numargs; i++)
1082 : {
1083 8669 : char argmode = argmodes ? argmodes[i] : PROARGMODE_IN;
1084 ECB :
1085 GIC 8669 : switch (argtypes[i])
1086 : {
1087 721 : case ANYELEMENTOID:
1088 ECB : case ANYNONARRAYOID:
1089 : case ANYENUMOID:
1090 CBC 721 : if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1091 ECB : {
1092 CBC 3 : have_polymorphic_result = true;
1093 GBC 3 : have_anyelement_result = true;
1094 : }
1095 ECB : else
1096 : {
1097 CBC 718 : if (!OidIsValid(poly_actuals.anyelement_type))
1098 ECB : {
1099 CBC 434 : poly_actuals.anyelement_type =
1100 GIC 434 : get_call_expr_argtype(call_expr, inargno);
1101 CBC 434 : if (!OidIsValid(poly_actuals.anyelement_type))
1102 LBC 0 : return false;
1103 : }
1104 GIC 718 : argtypes[i] = poly_actuals.anyelement_type;
1105 : }
1106 CBC 721 : break;
1107 GIC 108 : case ANYARRAYOID:
1108 CBC 108 : if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1109 ECB : {
1110 CBC 9 : have_polymorphic_result = true;
1111 GBC 9 : have_anyarray_result = true;
1112 : }
1113 ECB : else
1114 : {
1115 CBC 99 : if (!OidIsValid(poly_actuals.anyarray_type))
1116 ECB : {
1117 CBC 99 : poly_actuals.anyarray_type =
1118 GIC 99 : get_call_expr_argtype(call_expr, inargno);
1119 GBC 99 : if (!OidIsValid(poly_actuals.anyarray_type))
1120 UBC 0 : return false;
1121 : }
1122 GIC 99 : argtypes[i] = poly_actuals.anyarray_type;
1123 : }
1124 CBC 108 : break;
1125 GIC 12 : case ANYRANGEOID:
1126 CBC 12 : if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1127 ECB : {
1128 LBC 0 : have_polymorphic_result = true;
1129 UBC 0 : have_anyrange_result = true;
1130 : }
1131 ECB : else
1132 : {
1133 CBC 12 : if (!OidIsValid(poly_actuals.anyrange_type))
1134 EUB : {
1135 GBC 12 : poly_actuals.anyrange_type =
1136 GIC 12 : get_call_expr_argtype(call_expr, inargno);
1137 GBC 12 : if (!OidIsValid(poly_actuals.anyrange_type))
1138 UBC 0 : return false;
1139 : }
1140 GIC 12 : argtypes[i] = poly_actuals.anyrange_type;
1141 : }
1142 GBC 12 : break;
1143 UIC 0 : case ANYMULTIRANGEOID:
1144 UBC 0 : if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1145 EUB : {
1146 UBC 0 : have_polymorphic_result = true;
1147 0 : have_anymultirange_result = true;
1148 : }
1149 EUB : else
1150 : {
1151 UBC 0 : if (!OidIsValid(poly_actuals.anymultirange_type))
1152 ECB : {
1153 UIC 0 : poly_actuals.anymultirange_type =
1154 LBC 0 : get_call_expr_argtype(call_expr, inargno);
1155 UIC 0 : if (!OidIsValid(poly_actuals.anymultirange_type))
1156 LBC 0 : return false;
1157 ECB : }
1158 UIC 0 : argtypes[i] = poly_actuals.anymultirange_type;
1159 : }
1160 0 : break;
1161 CBC 69 : case ANYCOMPATIBLEOID:
1162 : case ANYCOMPATIBLENONARRAYOID:
1163 69 : if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1164 ECB : {
1165 CBC 3 : have_polymorphic_result = true;
1166 GBC 3 : have_anycompatible_result = true;
1167 : }
1168 ECB : else
1169 : {
1170 CBC 66 : if (!OidIsValid(anyc_actuals.anyelement_type))
1171 ECB : {
1172 CBC 33 : anyc_actuals.anyelement_type =
1173 GIC 33 : get_call_expr_argtype(call_expr, inargno);
1174 CBC 33 : if (!OidIsValid(anyc_actuals.anyelement_type))
1175 LBC 0 : return false;
1176 : }
1177 GIC 66 : argtypes[i] = anyc_actuals.anyelement_type;
1178 : }
1179 CBC 69 : break;
1180 GIC 18 : case ANYCOMPATIBLEARRAYOID:
1181 CBC 18 : if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1182 ECB : {
1183 CBC 9 : have_polymorphic_result = true;
1184 GBC 9 : have_anycompatible_array_result = true;
1185 : }
1186 ECB : else
1187 : {
1188 CBC 9 : if (!OidIsValid(anyc_actuals.anyarray_type))
1189 ECB : {
1190 CBC 9 : anyc_actuals.anyarray_type =
1191 GIC 9 : get_call_expr_argtype(call_expr, inargno);
1192 GBC 9 : if (!OidIsValid(anyc_actuals.anyarray_type))
1193 UBC 0 : return false;
1194 : }
1195 GIC 9 : argtypes[i] = anyc_actuals.anyarray_type;
1196 : }
1197 CBC 18 : break;
1198 GIC 27 : case ANYCOMPATIBLERANGEOID:
1199 CBC 27 : if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1200 ECB : {
1201 LBC 0 : have_polymorphic_result = true;
1202 UBC 0 : have_anycompatible_range_result = true;
1203 : }
1204 ECB : else
1205 : {
1206 CBC 27 : if (!OidIsValid(anyc_actuals.anyrange_type))
1207 EUB : {
1208 GBC 27 : anyc_actuals.anyrange_type =
1209 GIC 27 : get_call_expr_argtype(call_expr, inargno);
1210 GBC 27 : if (!OidIsValid(anyc_actuals.anyrange_type))
1211 UBC 0 : return false;
1212 : }
1213 GIC 27 : argtypes[i] = anyc_actuals.anyrange_type;
1214 : }
1215 GBC 27 : break;
1216 UIC 0 : case ANYCOMPATIBLEMULTIRANGEOID:
1217 UBC 0 : if (argmode == PROARGMODE_OUT || argmode == PROARGMODE_TABLE)
1218 EUB : {
1219 UBC 0 : have_polymorphic_result = true;
1220 0 : have_anycompatible_multirange_result = true;
1221 : }
1222 EUB : else
1223 : {
1224 UBC 0 : if (!OidIsValid(anyc_actuals.anymultirange_type))
1225 ECB : {
1226 LBC 0 : anyc_actuals.anymultirange_type =
1227 UIC 0 : get_call_expr_argtype(call_expr, inargno);
1228 LBC 0 : if (!OidIsValid(anyc_actuals.anymultirange_type))
1229 0 : return false;
1230 : }
1231 UIC 0 : argtypes[i] = anyc_actuals.anymultirange_type;
1232 : }
1233 LBC 0 : break;
1234 CBC 7714 : default:
1235 GIC 7714 : break;
1236 : }
1237 CBC 8669 : if (argmode != PROARGMODE_OUT && argmode != PROARGMODE_TABLE)
1238 GBC 8609 : inargno++;
1239 : }
1240 ECB :
1241 : /* Done? */
1242 GIC 6113 : if (!have_polymorphic_result)
1243 CBC 6101 : return true;
1244 EUB :
1245 : /* If needed, deduce one polymorphic type from others */
1246 CBC 12 : if (have_anyelement_result && !OidIsValid(poly_actuals.anyelement_type))
1247 UBC 0 : resolve_anyelement_from_others(&poly_actuals);
1248 :
1249 CBC 12 : if (have_anyarray_result && !OidIsValid(poly_actuals.anyarray_type))
1250 3 : resolve_anyarray_from_others(&poly_actuals);
1251 :
1252 12 : if (have_anyrange_result && !OidIsValid(poly_actuals.anyrange_type))
1253 LBC 0 : resolve_anyrange_from_others(&poly_actuals);
1254 :
1255 CBC 12 : if (have_anymultirange_result && !OidIsValid(poly_actuals.anymultirange_type))
1256 UBC 0 : resolve_anymultirange_from_others(&poly_actuals);
1257 :
1258 CBC 12 : if (have_anycompatible_result && !OidIsValid(anyc_actuals.anyelement_type))
1259 GBC 3 : resolve_anyelement_from_others(&anyc_actuals);
1260 :
1261 GIC 12 : if (have_anycompatible_array_result && !OidIsValid(anyc_actuals.anyarray_type))
1262 CBC 9 : resolve_anyarray_from_others(&anyc_actuals);
1263 :
1264 12 : if (have_anycompatible_range_result && !OidIsValid(anyc_actuals.anyrange_type))
1265 UIC 0 : resolve_anyrange_from_others(&anyc_actuals);
1266 ECB :
1267 GIC 12 : if (have_anycompatible_multirange_result && !OidIsValid(anyc_actuals.anymultirange_type))
1268 UIC 0 : resolve_anymultirange_from_others(&anyc_actuals);
1269 ECB :
1270 : /* And finally replace the output column types as needed */
1271 CBC 66 : for (i = 0; i < numargs; i++)
1272 ECB : {
1273 CBC 54 : switch (argtypes[i])
1274 EUB : {
1275 GBC 3 : case ANYELEMENTOID:
1276 EUB : case ANYNONARRAYOID:
1277 : case ANYENUMOID:
1278 GBC 3 : argtypes[i] = poly_actuals.anyelement_type;
1279 3 : break;
1280 CBC 9 : case ANYARRAYOID:
1281 GIC 9 : argtypes[i] = poly_actuals.anyarray_type;
1282 CBC 9 : break;
1283 LBC 0 : case ANYRANGEOID:
1284 0 : argtypes[i] = poly_actuals.anyrange_type;
1285 0 : break;
1286 0 : case ANYMULTIRANGEOID:
1287 UBC 0 : argtypes[i] = poly_actuals.anymultirange_type;
1288 0 : break;
1289 GBC 3 : case ANYCOMPATIBLEOID:
1290 EUB : case ANYCOMPATIBLENONARRAYOID:
1291 GBC 3 : argtypes[i] = anyc_actuals.anyelement_type;
1292 3 : break;
1293 CBC 9 : case ANYCOMPATIBLEARRAYOID:
1294 9 : argtypes[i] = anyc_actuals.anyarray_type;
1295 GIC 9 : break;
1296 UIC 0 : case ANYCOMPATIBLERANGEOID:
1297 0 : argtypes[i] = anyc_actuals.anyrange_type;
1298 LBC 0 : break;
1299 UIC 0 : case ANYCOMPATIBLEMULTIRANGEOID:
1300 0 : argtypes[i] = anyc_actuals.anymultirange_type;
1301 0 : break;
1302 GIC 30 : default:
1303 30 : break;
1304 : }
1305 : }
1306 :
1307 12 : return true;
1308 : }
1309 :
1310 : /*
1311 ECB : * 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 GIC 86670 : get_type_func_class(Oid typid, Oid *base_typeid)
1321 : {
1322 86670 : *base_typeid = typid;
1323 ECB :
1324 CBC 86670 : switch (get_typtype(typid))
1325 ECB : {
1326 CBC 27458 : case TYPTYPE_COMPOSITE:
1327 27458 : return TYPEFUNC_COMPOSITE;
1328 GIC 56587 : case TYPTYPE_BASE:
1329 ECB : case TYPTYPE_ENUM:
1330 : case TYPTYPE_RANGE:
1331 : case TYPTYPE_MULTIRANGE:
1332 CBC 56587 : return TYPEFUNC_SCALAR;
1333 GIC 426 : case TYPTYPE_DOMAIN:
1334 426 : *base_typeid = typid = getBaseType(typid);
1335 426 : if (get_typtype(typid) == TYPTYPE_COMPOSITE)
1336 142 : return TYPEFUNC_COMPOSITE_DOMAIN;
1337 : else /* domain base type can't be a pseudotype */
1338 284 : return TYPEFUNC_SCALAR;
1339 2199 : case TYPTYPE_PSEUDO:
1340 CBC 2199 : if (typid == RECORDOID)
1341 1188 : return TYPEFUNC_RECORD;
1342 ECB :
1343 : /*
1344 : * We treat VOID and CSTRING as legitimate scalar datatypes,
1345 EUB : * 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 GIC 1011 : if (typid == VOIDOID || typid == CSTRINGOID)
1350 1005 : return TYPEFUNC_SCALAR;
1351 6 : return TYPEFUNC_OTHER;
1352 : }
1353 : /* shouldn't get here, probably */
1354 UIC 0 : 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 ECB : * 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
1371 GIC 14948 : get_func_arg_info(HeapTuple procTup,
1372 : Oid **p_argtypes, char ***p_argnames, char **p_argmodes)
1373 : {
1374 14948 : Form_pg_proc procStruct = (Form_pg_proc) GETSTRUCT(procTup);
1375 : Datum proallargtypes;
1376 : Datum proargmodes;
1377 ECB : 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 GIC 14948 : proallargtypes = SysCacheGetAttr(PROCOID, procTup,
1387 : Anum_pg_proc_proallargtypes,
1388 ECB : &isNull);
1389 CBC 14948 : if (!isNull)
1390 ECB : {
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 EUB : * deconstruct_array() since the array data is just going to look like
1395 ECB : * a C array of values.
1396 : */
1397 CBC 3599 : arr = DatumGetArrayTypeP(proallargtypes); /* ensure not toasted */
1398 GIC 3599 : numargs = ARR_DIMS(arr)[0];
1399 3599 : if (ARR_NDIM(arr) != 1 ||
1400 3599 : numargs < 0 ||
1401 3599 : ARR_HASNULL(arr) ||
1402 3599 : ARR_ELEMTYPE(arr) != OIDOID)
1403 LBC 0 : elog(ERROR, "proallargtypes is not a 1-D Oid array or it contains nulls");
1404 CBC 3599 : Assert(numargs >= procStruct->pronargs);
1405 3599 : *p_argtypes = (Oid *) palloc(numargs * sizeof(Oid));
1406 3599 : memcpy(*p_argtypes, ARR_DATA_PTR(arr),
1407 : numargs * sizeof(Oid));
1408 : }
1409 : else
1410 : {
1411 ECB : /* If no proallargtypes, use proargtypes */
1412 GIC 11349 : numargs = procStruct->proargtypes.dim1;
1413 11349 : Assert(numargs == procStruct->pronargs);
1414 CBC 11349 : *p_argtypes = (Oid *) palloc(numargs * sizeof(Oid));
1415 11349 : memcpy(*p_argtypes, procStruct->proargtypes.values,
1416 : numargs * sizeof(Oid));
1417 : }
1418 ECB :
1419 : /* Get argument names, if available */
1420 CBC 14948 : proargnames = SysCacheGetAttr(PROCOID, procTup,
1421 EUB : Anum_pg_proc_proargnames,
1422 ECB : &isNull);
1423 CBC 14948 : if (isNull)
1424 6474 : *p_argnames = NULL;
1425 : else
1426 : {
1427 GNC 8474 : deconstruct_array_builtin(DatumGetArrayTypeP(proargnames), TEXTOID,
1428 : &elems, NULL, &nelems);
1429 GIC 8474 : if (nelems != numargs) /* should not happen */
1430 LBC 0 : elog(ERROR, "proargnames must have the same number of elements as the function has arguments");
1431 CBC 8474 : *p_argnames = (char **) palloc(sizeof(char *) * numargs);
1432 GIC 49260 : for (i = 0; i < numargs; i++)
1433 40786 : (*p_argnames)[i] = TextDatumGetCString(elems[i]);
1434 ECB : }
1435 :
1436 : /* Get argument modes, if available */
1437 CBC 14948 : proargmodes = SysCacheGetAttr(PROCOID, procTup,
1438 ECB : Anum_pg_proc_proargmodes,
1439 EUB : &isNull);
1440 GIC 14948 : if (isNull)
1441 CBC 11349 : *p_argmodes = NULL;
1442 ECB : else
1443 : {
1444 GIC 3599 : arr = DatumGetArrayTypeP(proargmodes); /* ensure not toasted */
1445 3599 : if (ARR_NDIM(arr) != 1 ||
1446 CBC 3599 : ARR_DIMS(arr)[0] != numargs ||
1447 GIC 3599 : ARR_HASNULL(arr) ||
1448 3599 : ARR_ELEMTYPE(arr) != CHAROID)
1449 UIC 0 : elog(ERROR, "proargmodes is not a 1-D char array of length %d or it contains nulls",
1450 : numargs);
1451 GIC 3599 : *p_argmodes = (char *) palloc(numargs * sizeof(char));
1452 3599 : memcpy(*p_argmodes, ARR_DATA_PTR(arr),
1453 : numargs * sizeof(char));
1454 : }
1455 :
1456 14948 : return numargs;
1457 ECB : }
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
1467 GIC 70 : get_func_trftypes(HeapTuple procTup,
1468 ECB : Oid **p_trftypes)
1469 : {
1470 : Datum protrftypes;
1471 : ArrayType *arr;
1472 : int nelems;
1473 : bool isNull;
1474 :
1475 GIC 70 : protrftypes = SysCacheGetAttr(PROCOID, procTup,
1476 ECB : Anum_pg_proc_protrftypes,
1477 : &isNull);
1478 CBC 70 : if (!isNull)
1479 ECB : {
1480 : /*
1481 : * We expect the arrays to be 1-D arrays of the right types; verify
1482 EUB : * that. For the OID and char arrays, we don't need to use
1483 ECB : * deconstruct_array() since the array data is just going to look like
1484 : * a C array of values.
1485 : */
1486 GIC 3 : arr = DatumGetArrayTypeP(protrftypes); /* ensure not toasted */
1487 CBC 3 : nelems = ARR_DIMS(arr)[0];
1488 GIC 3 : if (ARR_NDIM(arr) != 1 ||
1489 3 : nelems < 0 ||
1490 CBC 3 : ARR_HASNULL(arr) ||
1491 GIC 3 : ARR_ELEMTYPE(arr) != OIDOID)
1492 UIC 0 : elog(ERROR, "protrftypes is not a 1-D Oid array or it contains nulls");
1493 GIC 3 : *p_trftypes = (Oid *) palloc(nelems * sizeof(Oid));
1494 3 : memcpy(*p_trftypes, ARR_DATA_PTR(arr),
1495 : nelems * sizeof(Oid));
1496 :
1497 3 : return nelems;
1498 : }
1499 : else
1500 67 : return 0;
1501 : }
1502 :
1503 : /*
1504 ECB : * 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 GIC 13431 : get_func_input_arg_names(Datum proargnames, Datum proargmodes,
1515 : char ***arg_names)
1516 ECB : {
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 GIC 13431 : if (proargnames == PointerGetDatum(NULL))
1527 ECB : {
1528 CBC 3347 : *arg_names = NULL;
1529 3347 : return 0;
1530 ECB : }
1531 EUB :
1532 ECB : /*
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 CBC 10084 : arr = DatumGetArrayTypeP(proargnames); /* ensure not toasted */
1538 10084 : if (ARR_NDIM(arr) != 1 ||
1539 10084 : ARR_HASNULL(arr) ||
1540 GBC 10084 : ARR_ELEMTYPE(arr) != TEXTOID)
1541 UIC 0 : elog(ERROR, "proargnames is not a 1-D text array or it contains nulls");
1542 GNC 10084 : deconstruct_array_builtin(arr, TEXTOID, &argnames, NULL, &numargs);
1543 GIC 10084 : if (proargmodes != PointerGetDatum(NULL))
1544 ECB : {
1545 GIC 5865 : arr = DatumGetArrayTypeP(proargmodes); /* ensure not toasted */
1546 5865 : if (ARR_NDIM(arr) != 1 ||
1547 CBC 5865 : ARR_DIMS(arr)[0] != numargs ||
1548 GIC 5865 : ARR_HASNULL(arr) ||
1549 GBC 5865 : ARR_ELEMTYPE(arr) != CHAROID)
1550 UBC 0 : elog(ERROR, "proargmodes is not a 1-D char array of length %d or it contains nulls",
1551 : numargs);
1552 GIC 5865 : argmodes = (char *) ARR_DATA_PTR(arr);
1553 : }
1554 ECB : else
1555 CBC 4219 : argmodes = NULL;
1556 ECB :
1557 : /* zero elements probably shouldn't happen, but handle it gracefully */
1558 CBC 10084 : if (numargs <= 0)
1559 ECB : {
1560 LBC 0 : *arg_names = NULL;
1561 0 : return 0;
1562 : }
1563 ECB :
1564 : /* extract input-argument names */
1565 CBC 10084 : inargnames = (char **) palloc(numargs * sizeof(char *));
1566 10084 : numinargs = 0;
1567 GIC 58001 : for (i = 0; i < numargs; i++)
1568 ECB : {
1569 CBC 47917 : if (argmodes == NULL ||
1570 GIC 36669 : argmodes[i] == PROARGMODE_IN ||
1571 22143 : argmodes[i] == PROARGMODE_INOUT ||
1572 22098 : argmodes[i] == PROARGMODE_VARIADIC)
1573 ECB : {
1574 CBC 28282 : char *pname = TextDatumGetCString(argnames[i]);
1575 :
1576 GIC 28282 : if (pname[0] != '\0')
1577 28243 : inargnames[numinargs] = pname;
1578 : else
1579 39 : inargnames[numinargs] = NULL;
1580 28282 : numinargs++;
1581 : }
1582 : }
1583 :
1584 10084 : *arg_names = inargnames;
1585 10084 : return numinargs;
1586 : }
1587 :
1588 ECB :
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 *
1599 GIC 8671 : get_func_result_name(Oid functionId)
1600 : {
1601 : char *result;
1602 : HeapTuple procTuple;
1603 ECB : 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 GIC 8671 : procTuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(functionId));
1615 CBC 8671 : if (!HeapTupleIsValid(procTuple))
1616 UIC 0 : elog(ERROR, "cache lookup failed for function %u", functionId);
1617 :
1618 : /* If there are no named OUT parameters, return NULL */
1619 GIC 9044 : if (heap_attisnull(procTuple, Anum_pg_proc_proargmodes, NULL) ||
1620 373 : heap_attisnull(procTuple, Anum_pg_proc_proargnames, NULL))
1621 8313 : result = NULL;
1622 : else
1623 : {
1624 ECB : /* Get the data out of the tuple */
1625 GNC 358 : proargmodes = SysCacheGetAttrNotNull(PROCOID, procTuple,
1626 : Anum_pg_proc_proargmodes);
1627 358 : proargnames = SysCacheGetAttrNotNull(PROCOID, procTuple,
1628 : Anum_pg_proc_proargnames);
1629 ECB :
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 EUB : * since the array data is just going to look like a C array of
1634 : * values.
1635 ECB : */
1636 CBC 358 : arr = DatumGetArrayTypeP(proargmodes); /* ensure not toasted */
1637 GIC 358 : numargs = ARR_DIMS(arr)[0];
1638 358 : if (ARR_NDIM(arr) != 1 ||
1639 CBC 358 : numargs < 0 ||
1640 358 : ARR_HASNULL(arr) ||
1641 358 : ARR_ELEMTYPE(arr) != CHAROID)
1642 UIC 0 : elog(ERROR, "proargmodes is not a 1-D char array or it contains nulls");
1643 CBC 358 : argmodes = (char *) ARR_DATA_PTR(arr);
1644 358 : arr = DatumGetArrayTypeP(proargnames); /* ensure not toasted */
1645 358 : if (ARR_NDIM(arr) != 1 ||
1646 358 : ARR_DIMS(arr)[0] != numargs ||
1647 GIC 358 : ARR_HASNULL(arr) ||
1648 358 : ARR_ELEMTYPE(arr) != TEXTOID)
1649 LBC 0 : elog(ERROR, "proargnames is not a 1-D text array of length %d or it contains nulls",
1650 : numargs);
1651 GNC 358 : deconstruct_array_builtin(arr, TEXTOID, &argnames, NULL, &nargnames);
1652 GBC 358 : Assert(nargnames == numargs);
1653 :
1654 ECB : /* scan for output argument(s) */
1655 CBC 358 : result = NULL;
1656 GIC 358 : numoutargs = 0;
1657 1064 : for (i = 0; i < numargs; i++)
1658 EUB : {
1659 GBC 706 : if (argmodes[i] == PROARGMODE_IN ||
1660 GIC 358 : argmodes[i] == PROARGMODE_VARIADIC)
1661 348 : continue;
1662 358 : Assert(argmodes[i] == PROARGMODE_OUT ||
1663 : argmodes[i] == PROARGMODE_INOUT ||
1664 ECB : argmodes[i] == PROARGMODE_TABLE);
1665 GIC 358 : if (++numoutargs > 1)
1666 ECB : {
1667 : /* multiple out args, so forget it */
1668 UIC 0 : result = NULL;
1669 0 : break;
1670 : }
1671 GIC 358 : result = TextDatumGetCString(argnames[i]);
1672 358 : if (result == NULL || result[0] == '\0')
1673 : {
1674 : /* Parameter is not named, so forget it */
1675 UIC 0 : result = NULL;
1676 0 : break;
1677 : }
1678 : }
1679 : }
1680 ECB :
1681 GIC 8671 : ReleaseSysCache(procTuple);
1682 ECB :
1683 GIC 8671 : return result;
1684 : }
1685 :
1686 :
1687 : /*
1688 : * build_function_result_tupdesc_t
1689 ECB : *
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
1697 GIC 308575 : build_function_result_tupdesc_t(HeapTuple procTuple)
1698 ECB : {
1699 GIC 308575 : Form_pg_proc procform = (Form_pg_proc) GETSTRUCT(procTuple);
1700 ECB : 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 CBC 308575 : if (procform->prorettype != RECORDOID)
1707 GIC 60679 : return NULL;
1708 ECB :
1709 : /* If there are no OUT parameters, return NULL */
1710 GIC 494748 : if (heap_attisnull(procTuple, Anum_pg_proc_proallargtypes, NULL) ||
1711 246852 : heap_attisnull(procTuple, Anum_pg_proc_proargmodes, NULL))
1712 1044 : return NULL;
1713 :
1714 : /* Get the data out of the tuple */
1715 GNC 246852 : proallargtypes = SysCacheGetAttrNotNull(PROCOID, procTuple,
1716 : Anum_pg_proc_proallargtypes);
1717 246852 : proargmodes = SysCacheGetAttrNotNull(PROCOID, procTuple,
1718 : Anum_pg_proc_proargmodes);
1719 GIC 246852 : proargnames = SysCacheGetAttr(PROCOID, procTuple,
1720 : Anum_pg_proc_proargnames,
1721 : &isnull);
1722 CBC 246852 : if (isnull)
1723 GIC 51 : proargnames = PointerGetDatum(NULL); /* just to be sure */
1724 :
1725 246852 : return build_function_result_tupdesc_d(procform->prokind,
1726 : proallargtypes,
1727 : proargmodes,
1728 : proargnames);
1729 : }
1730 :
1731 : /*
1732 ECB : * 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
1743 GIC 249616 : build_function_result_tupdesc_d(char prokind,
1744 : Datum proallargtypes,
1745 : Datum proargmodes,
1746 : Datum proargnames)
1747 : {
1748 : TupleDesc desc;
1749 ECB : ArrayType *arr;
1750 : int numargs;
1751 : Oid *argtypes;
1752 : char *argmodes;
1753 CBC 249616 : Datum *argnames = NULL;
1754 ECB : Oid *outargtypes;
1755 EUB : char **outargnames;
1756 ECB : int numoutargs;
1757 : int nargnames;
1758 : int i;
1759 :
1760 : /* Can't have output args if columns are null */
1761 CBC 499219 : if (proallargtypes == PointerGetDatum(NULL) ||
1762 GBC 249603 : proargmodes == PointerGetDatum(NULL))
1763 GIC 13 : return NULL;
1764 ECB :
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 CBC 249603 : arr = DatumGetArrayTypeP(proallargtypes); /* ensure not toasted */
1771 249603 : numargs = ARR_DIMS(arr)[0];
1772 GBC 249603 : if (ARR_NDIM(arr) != 1 ||
1773 GIC 249603 : numargs < 0 ||
1774 CBC 249603 : ARR_HASNULL(arr) ||
1775 249603 : ARR_ELEMTYPE(arr) != OIDOID)
1776 UIC 0 : elog(ERROR, "proallargtypes is not a 1-D Oid array or it contains nulls");
1777 GIC 249603 : argtypes = (Oid *) ARR_DATA_PTR(arr);
1778 249603 : arr = DatumGetArrayTypeP(proargmodes); /* ensure not toasted */
1779 CBC 249603 : if (ARR_NDIM(arr) != 1 ||
1780 GBC 249603 : ARR_DIMS(arr)[0] != numargs ||
1781 GIC 249603 : ARR_HASNULL(arr) ||
1782 249603 : ARR_ELEMTYPE(arr) != CHAROID)
1783 LBC 0 : elog(ERROR, "proargmodes is not a 1-D char array of length %d or it contains nulls",
1784 ECB : numargs);
1785 CBC 249603 : argmodes = (char *) ARR_DATA_PTR(arr);
1786 249603 : if (proargnames != PointerGetDatum(NULL))
1787 : {
1788 GIC 249546 : arr = DatumGetArrayTypeP(proargnames); /* ensure not toasted */
1789 249546 : if (ARR_NDIM(arr) != 1 ||
1790 CBC 249546 : ARR_DIMS(arr)[0] != numargs ||
1791 249546 : ARR_HASNULL(arr) ||
1792 249546 : ARR_ELEMTYPE(arr) != TEXTOID)
1793 LBC 0 : elog(ERROR, "proargnames is not a 1-D text array of length %d or it contains nulls",
1794 : numargs);
1795 GNC 249546 : deconstruct_array_builtin(arr, TEXTOID, &argnames, NULL, &nargnames);
1796 CBC 249546 : Assert(nargnames == numargs);
1797 ECB : }
1798 :
1799 : /* zero elements probably shouldn't happen, but handle it gracefully */
1800 CBC 249603 : if (numargs <= 0)
1801 UIC 0 : return NULL;
1802 :
1803 ECB : /* extract output-argument types and names */
1804 GIC 249603 : outargtypes = (Oid *) palloc(numargs * sizeof(Oid));
1805 CBC 249603 : outargnames = (char **) palloc(numargs * sizeof(char *));
1806 249603 : numoutargs = 0;
1807 GIC 3968484 : for (i = 0; i < numargs; i++)
1808 : {
1809 : char *pname;
1810 :
1811 3718881 : if (argmodes[i] == PROARGMODE_IN ||
1812 3454226 : argmodes[i] == PROARGMODE_VARIADIC)
1813 CBC 270698 : continue;
1814 GBC 3448183 : Assert(argmodes[i] == PROARGMODE_OUT ||
1815 : argmodes[i] == PROARGMODE_INOUT ||
1816 ECB : argmodes[i] == PROARGMODE_TABLE);
1817 CBC 3448183 : outargtypes[numoutargs] = argtypes[i];
1818 GIC 3448183 : if (argnames)
1819 CBC 3448069 : pname = TextDatumGetCString(argnames[i]);
1820 ECB : else
1821 CBC 114 : pname = NULL;
1822 GIC 3448183 : if (pname == NULL || pname[0] == '\0')
1823 : {
1824 : /* Parameter is not named, so gin up a column name */
1825 226 : pname = psprintf("column%d", numoutargs + 1);
1826 ECB : }
1827 GIC 3448183 : outargnames[numoutargs] = pname;
1828 3448183 : numoutargs++;
1829 : }
1830 :
1831 : /*
1832 : * If there is no output argument, or only one, the function does not
1833 : * return tuples.
1834 : */
1835 249603 : if (numoutargs < 2 && prokind != PROKIND_PROCEDURE)
1836 UIC 0 : return NULL;
1837 :
1838 GIC 249603 : desc = CreateTemplateTupleDesc(numoutargs);
1839 3697786 : for (i = 0; i < numoutargs; i++)
1840 EUB : {
1841 GIC 3448183 : TupleDescInitEntry(desc, i + 1,
1842 3448183 : outargnames[i],
1843 3448183 : outargtypes[i],
1844 : -1,
1845 : 0);
1846 : }
1847 :
1848 GBC 249603 : return desc;
1849 EUB : }
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
1862 UIC 0 : RelationNameGetTupleDesc(const char *relname)
1863 : {
1864 : RangeVar *relvar;
1865 : Relation rel;
1866 : TupleDesc tupdesc;
1867 : List *relname_list;
1868 :
1869 : /* Open relation and copy the tuple description */
1870 UNC 0 : relname_list = stringToQualifiedNameList(relname, NULL);
1871 UIC 0 : relvar = makeRangeVarFromNameList(relname_list);
1872 0 : rel = relation_openrv(relvar, AccessShareLock);
1873 UBC 0 : tupdesc = CreateTupleDescCopy(RelationGetDescr(rel));
1874 UIC 0 : relation_close(rel, AccessShareLock);
1875 :
1876 UBC 0 : return tupdesc;
1877 EUB : }
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 UIC 0 : TypeGetTupleDesc(Oid typeoid, List *colaliases)
1896 EUB : {
1897 : Oid base_typeoid;
1898 UIC 0 : TypeFuncClass functypclass = get_type_func_class(typeoid, &base_typeoid);
1899 0 : TupleDesc tupdesc = NULL;
1900 :
1901 : /*
1902 EUB : * 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 UBC 0 : if (functypclass == TYPEFUNC_COMPOSITE)
1908 EUB : {
1909 : /* Composite data type, e.g. a table's row type */
1910 UIC 0 : tupdesc = lookup_rowtype_tupdesc_copy(base_typeoid, -1);
1911 :
1912 UBC 0 : if (colaliases != NIL)
1913 EUB : {
1914 UIC 0 : int natts = tupdesc->natts;
1915 : int varattno;
1916 EUB :
1917 : /* does the list length match the number of attributes? */
1918 UIC 0 : if (list_length(colaliases) != natts)
1919 0 : ereport(ERROR,
1920 : (errcode(ERRCODE_DATATYPE_MISMATCH),
1921 : errmsg("number of aliases does not match number of columns")));
1922 EUB :
1923 : /* OK, use the aliases instead */
1924 UIC 0 : for (varattno = 0; varattno < natts; varattno++)
1925 : {
1926 0 : char *label = strVal(list_nth(colaliases, varattno));
1927 0 : Form_pg_attribute attr = TupleDescAttr(tupdesc, varattno);
1928 EUB :
1929 UBC 0 : if (label != NULL)
1930 UIC 0 : namestrcpy(&(attr->attname), label);
1931 : }
1932 :
1933 : /* The tuple type is now an anonymous record type */
1934 UBC 0 : tupdesc->tdtypeid = RECORDOID;
1935 UIC 0 : tupdesc->tdtypmod = -1;
1936 EUB : }
1937 : }
1938 UIC 0 : 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 UBC 0 : if (colaliases == NIL)
1945 UIC 0 : ereport(ERROR,
1946 : (errcode(ERRCODE_DATATYPE_MISMATCH),
1947 EUB : errmsg("no column alias was provided")));
1948 :
1949 : /* the alias list length must be 1 */
1950 UIC 0 : if (list_length(colaliases) != 1)
1951 0 : ereport(ERROR,
1952 : (errcode(ERRCODE_DATATYPE_MISMATCH),
1953 : errmsg("number of aliases does not match number of columns")));
1954 EUB :
1955 : /* OK, get the column alias */
1956 UIC 0 : attname = strVal(linitial(colaliases));
1957 EUB :
1958 UIC 0 : tupdesc = CreateTemplateTupleDesc(1);
1959 0 : TupleDescInitEntry(tupdesc,
1960 : (AttrNumber) 1,
1961 : attname,
1962 : typeoid,
1963 : -1,
1964 : 0);
1965 : }
1966 0 : else if (functypclass == TYPEFUNC_RECORD)
1967 : {
1968 : /* XXX can't support this because typmod wasn't passed in ... */
1969 0 : ereport(ERROR,
1970 : (errcode(ERRCODE_DATATYPE_MISMATCH),
1971 : errmsg("could not determine row description for function returning record")));
1972 : }
1973 : else
1974 : {
1975 ECB : /* crummy error message, but parser should have caught this */
1976 UIC 0 : elog(ERROR, "function in FROM has unsupported return type");
1977 : }
1978 :
1979 LBC 0 : 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 ECB : * 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 GIC 348 : extract_variadic_args(FunctionCallInfo fcinfo, int variadic_start,
1998 ECB : bool convert_unknown, Datum **args, Oid **types,
1999 : bool **nulls)
2000 : {
2001 CBC 348 : bool variadic = get_fn_expr_variadic(fcinfo->flinfo);
2002 : Datum *args_res;
2003 ECB : bool *nulls_res;
2004 : Oid *types_res;
2005 : int nargs,
2006 : i;
2007 :
2008 CBC 348 : *args = NULL;
2009 GIC 348 : *types = NULL;
2010 348 : *nulls = NULL;
2011 :
2012 348 : if (variadic)
2013 ECB : {
2014 : ArrayType *array_in;
2015 : Oid element_type;
2016 : bool typbyval;
2017 : char typalign;
2018 : int16 typlen;
2019 :
2020 CBC 90 : Assert(PG_NARGS() == variadic_start + 1);
2021 ECB :
2022 CBC 90 : if (PG_ARGISNULL(variadic_start))
2023 12 : return -1;
2024 :
2025 78 : array_in = PG_GETARG_ARRAYTYPE_P(variadic_start);
2026 GIC 78 : element_type = ARR_ELEMTYPE(array_in);
2027 ECB :
2028 CBC 78 : get_typlenbyvalalign(element_type,
2029 : &typlen, &typbyval, &typalign);
2030 GIC 78 : 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 78 : types_res = (Oid *) palloc0(nargs * sizeof(Oid));
2036 318 : for (i = 0; i < nargs; i++)
2037 240 : types_res[i] = element_type;
2038 ECB : }
2039 : else
2040 : {
2041 GIC 258 : nargs = PG_NARGS() - variadic_start;
2042 CBC 258 : Assert(nargs > 0);
2043 GIC 258 : nulls_res = (bool *) palloc0(nargs * sizeof(bool));
2044 CBC 258 : args_res = (Datum *) palloc0(nargs * sizeof(Datum));
2045 258 : types_res = (Oid *) palloc0(nargs * sizeof(Oid));
2046 :
2047 1002 : for (i = 0; i < nargs; i++)
2048 ECB : {
2049 GIC 744 : nulls_res[i] = PG_ARGISNULL(i + variadic_start);
2050 744 : types_res[i] = get_fn_expr_argtype(fcinfo->flinfo,
2051 : i + variadic_start);
2052 :
2053 ECB : /*
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 EUB : * (that is, undecorated strings or NULLs).
2059 : */
2060 GIC 744 : if (convert_unknown &&
2061 1098 : types_res[i] == UNKNOWNOID &&
2062 354 : get_fn_expr_arg_stable(fcinfo->flinfo, i + variadic_start))
2063 : {
2064 354 : types_res[i] = TEXTOID;
2065 :
2066 CBC 354 : if (PG_ARGISNULL(i + variadic_start))
2067 36 : args_res[i] = (Datum) 0;
2068 ECB : else
2069 GIC 318 : args_res[i] =
2070 CBC 318 : CStringGetTextDatum(PG_GETARG_POINTER(i + variadic_start));
2071 : }
2072 : else
2073 : {
2074 : /* no conversion needed, just take the datum as given */
2075 GIC 390 : args_res[i] = PG_GETARG_DATUM(i + variadic_start);
2076 : }
2077 :
2078 744 : if (!OidIsValid(types_res[i]) ||
2079 744 : (convert_unknown && types_res[i] == UNKNOWNOID))
2080 UIC 0 : 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 GIC 336 : *args = args_res;
2089 336 : *nulls = nulls_res;
2090 336 : *types = types_res;
2091 :
2092 336 : return nargs;
2093 : }
|
