Branch data Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * pg_proc.c
4 : : * routines to support manipulation of the pg_proc relation
5 : : *
6 : : * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
7 : : * Portions Copyright (c) 1994, Regents of the University of California
8 : : *
9 : : *
10 : : * IDENTIFICATION
11 : : * src/backend/catalog/pg_proc.c
12 : : *
13 : : *-------------------------------------------------------------------------
14 : : */
15 : : #include "postgres.h"
16 : :
17 : : #include "access/htup_details.h"
18 : : #include "access/table.h"
19 : : #include "access/xact.h"
20 : : #include "catalog/catalog.h"
21 : : #include "catalog/dependency.h"
22 : : #include "catalog/indexing.h"
23 : : #include "catalog/namespace.h"
24 : : #include "catalog/objectaccess.h"
25 : : #include "catalog/pg_language.h"
26 : : #include "catalog/pg_namespace.h"
27 : : #include "catalog/pg_proc.h"
28 : : #include "catalog/pg_transform.h"
29 : : #include "catalog/pg_type.h"
30 : : #include "executor/functions.h"
31 : : #include "funcapi.h"
32 : : #include "mb/pg_wchar.h"
33 : : #include "miscadmin.h"
34 : : #include "nodes/nodeFuncs.h"
35 : : #include "parser/parse_coerce.h"
36 : : #include "pgstat.h"
37 : : #include "rewrite/rewriteHandler.h"
38 : : #include "tcop/pquery.h"
39 : : #include "tcop/tcopprot.h"
40 : : #include "utils/acl.h"
41 : : #include "utils/builtins.h"
42 : : #include "utils/lsyscache.h"
43 : : #include "utils/regproc.h"
44 : : #include "utils/rel.h"
45 : : #include "utils/syscache.h"
46 : :
47 : :
48 : : typedef struct
49 : : {
50 : : char *proname;
51 : : char *prosrc;
52 : : } parse_error_callback_arg;
53 : :
54 : : static void sql_function_parse_error_callback(void *arg);
55 : : static int match_prosrc_to_query(const char *prosrc, const char *queryText,
56 : : int cursorpos);
57 : : static bool match_prosrc_to_literal(const char *prosrc, const char *literal,
58 : : int cursorpos, int *newcursorpos);
59 : :
60 : :
61 : : /* ----------------------------------------------------------------
62 : : * ProcedureCreate
63 : : *
64 : : * procedureName: string name of routine (proname)
65 : : * procNamespace: OID of namespace (pronamespace)
66 : : * replace: true to allow replacement of an existing pg_proc entry
67 : : * returnsSet: returns set? (proretset)
68 : : * returnType: OID of result type (prorettype)
69 : : * proowner: OID of owner role (proowner)
70 : : * languageObjectId: OID of function language (prolang)
71 : : * languageValidator: OID of validator function to apply, if any
72 : : * prosrc: string form of function definition (prosrc)
73 : : * probin: string form of binary reference, or NULL (probin)
74 : : * prosqlbody: Node tree of pre-parsed SQL body, or NULL (prosqlbody)
75 : : * prokind: function/aggregate/procedure/etc code (prokind)
76 : : * security_definer: security definer? (prosecdef)
77 : : * isLeakProof: leak proof? (proleakproof)
78 : : * isStrict: strict? (proisstrict)
79 : : * volatility: volatility code (provolatile)
80 : : * parallel: parallel safety code (proparallel)
81 : : * parameterTypes: input parameter types, as an oidvector (proargtypes)
82 : : * allParameterTypes: all parameter types, as an OID array (proallargtypes)
83 : : * parameterModes: parameter modes, as a "char" array (proargmodes)
84 : : * parameterNames: parameter names, as a text array (proargnames)
85 : : * parameterDefaults: defaults, as a List of Node trees (proargdefaults)
86 : : * trftypes: transformable type OIDs, as an OID array (protrftypes)
87 : : * trfoids: List of transform OIDs that routine should depend on
88 : : * proconfig: GUC set clauses, as a text array (proconfig)
89 : : * prosupport: OID of support function, if any (prosupport)
90 : : * procost: cost factor (procost)
91 : : * prorows: estimated output rows for a SRF (prorows)
92 : : *
93 : : * Note: allParameterTypes, parameterModes, parameterNames, trftypes, and proconfig
94 : : * are either arrays of the proper types or NULL. We declare them Datum,
95 : : * not "ArrayType *", to avoid importing array.h into pg_proc.h.
96 : : * ----------------------------------------------------------------
97 : : */
98 : : ObjectAddress
99 : 13930 : ProcedureCreate(const char *procedureName,
100 : : Oid procNamespace,
101 : : bool replace,
102 : : bool returnsSet,
103 : : Oid returnType,
104 : : Oid proowner,
105 : : Oid languageObjectId,
106 : : Oid languageValidator,
107 : : const char *prosrc,
108 : : const char *probin,
109 : : Node *prosqlbody,
110 : : char prokind,
111 : : bool security_definer,
112 : : bool isLeakProof,
113 : : bool isStrict,
114 : : char volatility,
115 : : char parallel,
116 : : oidvector *parameterTypes,
117 : : Datum allParameterTypes,
118 : : Datum parameterModes,
119 : : Datum parameterNames,
120 : : List *parameterDefaults,
121 : : Datum trftypes,
122 : : List *trfoids,
123 : : Datum proconfig,
124 : : Oid prosupport,
125 : : float4 procost,
126 : : float4 prorows)
127 : : {
128 : : Oid retval;
129 : : int parameterCount;
130 : : int allParamCount;
131 : : Oid *allParams;
132 : 13930 : char *paramModes = NULL;
133 : 13930 : Oid variadicType = InvalidOid;
134 : 13930 : Acl *proacl = NULL;
135 : : Relation rel;
136 : : HeapTuple tup;
137 : : HeapTuple oldtup;
138 : : bool nulls[Natts_pg_proc];
139 : : Datum values[Natts_pg_proc];
140 : : bool replaces[Natts_pg_proc];
141 : : NameData procname;
142 : : TupleDesc tupDesc;
143 : : bool is_update;
144 : : ObjectAddress myself,
145 : : referenced,
146 : : temp_object;
147 : : char *detailmsg;
148 : : int i;
149 : : ObjectAddresses *addrs;
150 : :
151 : : /*
152 : : * sanity checks
153 : : */
154 : : Assert(prosrc);
155 : :
156 : 13930 : parameterCount = parameterTypes->dim1;
157 [ + - - + ]: 13930 : if (parameterCount < 0 || parameterCount > FUNC_MAX_ARGS)
158 [ # # ]: 0 : ereport(ERROR,
159 : : (errcode(ERRCODE_TOO_MANY_ARGUMENTS),
160 : : errmsg_plural("functions cannot have more than %d argument",
161 : : "functions cannot have more than %d arguments",
162 : : FUNC_MAX_ARGS,
163 : : FUNC_MAX_ARGS)));
164 : : /* note: the above is correct, we do NOT count output arguments */
165 : :
166 : : /* Deconstruct array inputs */
167 [ + + ]: 13930 : if (allParameterTypes != PointerGetDatum(NULL))
168 : : {
169 : : /*
170 : : * We expect the array to be a 1-D OID array; verify that. We don't
171 : : * need to use deconstruct_array() since the array data is just going
172 : : * to look like a C array of OID values.
173 : : */
174 : 1324 : ArrayType *allParamArray = (ArrayType *) DatumGetPointer(allParameterTypes);
175 : :
176 : 1324 : allParamCount = ARR_DIMS(allParamArray)[0];
177 [ + - + - ]: 1324 : if (ARR_NDIM(allParamArray) != 1 ||
178 : 1324 : allParamCount <= 0 ||
179 [ + - ]: 1324 : ARR_HASNULL(allParamArray) ||
180 [ - + ]: 1324 : ARR_ELEMTYPE(allParamArray) != OIDOID)
181 [ # # ]: 0 : elog(ERROR, "allParameterTypes is not a 1-D Oid array");
182 [ - + ]: 1324 : allParams = (Oid *) ARR_DATA_PTR(allParamArray);
183 : : Assert(allParamCount >= parameterCount);
184 : : /* we assume caller got the contents right */
185 : : }
186 : : else
187 : : {
188 : 12606 : allParamCount = parameterCount;
189 : 12606 : allParams = parameterTypes->values;
190 : : }
191 : :
192 [ + + ]: 13930 : if (parameterModes != PointerGetDatum(NULL))
193 : : {
194 : : /*
195 : : * We expect the array to be a 1-D CHAR array; verify that. We don't
196 : : * need to use deconstruct_array() since the array data is just going
197 : : * to look like a C array of char values.
198 : : */
199 : 1324 : ArrayType *modesArray = (ArrayType *) DatumGetPointer(parameterModes);
200 : :
201 [ + - ]: 1324 : if (ARR_NDIM(modesArray) != 1 ||
202 [ + - ]: 1324 : ARR_DIMS(modesArray)[0] != allParamCount ||
203 [ + - ]: 1324 : ARR_HASNULL(modesArray) ||
204 [ - + ]: 1324 : ARR_ELEMTYPE(modesArray) != CHAROID)
205 [ # # ]: 0 : elog(ERROR, "parameterModes is not a 1-D char array");
206 [ - + ]: 1324 : paramModes = (char *) ARR_DATA_PTR(modesArray);
207 : : }
208 : :
209 : : /*
210 : : * Do not allow polymorphic return type unless there is a polymorphic
211 : : * input argument that we can use to deduce the actual return type.
212 : : */
213 : 13930 : detailmsg = check_valid_polymorphic_signature(returnType,
214 : 13930 : parameterTypes->values,
215 : : parameterCount);
216 [ + + ]: 13930 : if (detailmsg)
217 [ + - ]: 52 : ereport(ERROR,
218 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
219 : : errmsg("cannot determine result data type"),
220 : : errdetail_internal("%s", detailmsg)));
221 : :
222 : : /*
223 : : * Also, do not allow return type INTERNAL unless at least one input
224 : : * argument is INTERNAL.
225 : : */
226 : 13878 : detailmsg = check_valid_internal_signature(returnType,
227 : 13878 : parameterTypes->values,
228 : : parameterCount);
229 [ - + ]: 13878 : if (detailmsg)
230 [ # # ]: 0 : ereport(ERROR,
231 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
232 : : errmsg("unsafe use of pseudo-type \"internal\""),
233 : : errdetail_internal("%s", detailmsg)));
234 : :
235 : : /*
236 : : * Apply the same tests to any OUT arguments.
237 : : */
238 [ + + ]: 13878 : if (allParameterTypes != PointerGetDatum(NULL))
239 : : {
240 [ + + ]: 9241 : for (i = 0; i < allParamCount; i++)
241 : : {
242 [ + - ]: 7949 : if (paramModes == NULL ||
243 [ + + ]: 7949 : paramModes[i] == PROARGMODE_IN ||
244 [ + + ]: 6538 : paramModes[i] == PROARGMODE_VARIADIC)
245 : 1615 : continue; /* ignore input-only params */
246 : :
247 : 6334 : detailmsg = check_valid_polymorphic_signature(allParams[i],
248 : 6334 : parameterTypes->values,
249 : : parameterCount);
250 [ + + ]: 6334 : if (detailmsg)
251 [ + - ]: 32 : ereport(ERROR,
252 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
253 : : errmsg("cannot determine result data type"),
254 : : errdetail_internal("%s", detailmsg)));
255 : 6302 : detailmsg = check_valid_internal_signature(allParams[i],
256 : 6302 : parameterTypes->values,
257 : : parameterCount);
258 [ - + ]: 6302 : if (detailmsg)
259 [ # # ]: 0 : ereport(ERROR,
260 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
261 : : errmsg("unsafe use of pseudo-type \"internal\""),
262 : : errdetail_internal("%s", detailmsg)));
263 : : }
264 : : }
265 : :
266 : : /* Identify variadic argument type, if any */
267 [ + + ]: 13846 : if (paramModes != NULL)
268 : : {
269 : : /*
270 : : * Only the last input parameter can be variadic; if it is, save its
271 : : * element type. Errors here are just elog since caller should have
272 : : * checked this already.
273 : : */
274 [ + + ]: 9169 : for (i = 0; i < allParamCount; i++)
275 : : {
276 [ + + + + : 7877 : switch (paramModes[i])
- ]
277 : : {
278 : 1484 : case PROARGMODE_IN:
279 : : case PROARGMODE_INOUT:
280 [ - + ]: 1484 : if (OidIsValid(variadicType))
281 [ # # ]: 0 : elog(ERROR, "variadic parameter must be last");
282 : 1484 : break;
283 : 5862 : case PROARGMODE_OUT:
284 [ - + - - ]: 5862 : if (OidIsValid(variadicType) && prokind == PROKIND_PROCEDURE)
285 [ # # ]: 0 : elog(ERROR, "variadic parameter must be last");
286 : 5862 : break;
287 : 327 : case PROARGMODE_TABLE:
288 : : /* okay */
289 : 327 : break;
290 : 204 : case PROARGMODE_VARIADIC:
291 [ - + ]: 204 : if (OidIsValid(variadicType))
292 [ # # ]: 0 : elog(ERROR, "variadic parameter must be last");
293 [ + + + + ]: 204 : switch (allParams[i])
294 : : {
295 : 5 : case ANYOID:
296 : 5 : variadicType = ANYOID;
297 : 5 : break;
298 : 25 : case ANYARRAYOID:
299 : 25 : variadicType = ANYELEMENTOID;
300 : 25 : break;
301 : 14 : case ANYCOMPATIBLEARRAYOID:
302 : 14 : variadicType = ANYCOMPATIBLEOID;
303 : 14 : break;
304 : 160 : default:
305 : 160 : variadicType = get_element_type(allParams[i]);
306 [ - + ]: 160 : if (!OidIsValid(variadicType))
307 [ # # ]: 0 : elog(ERROR, "variadic parameter is not an array");
308 : 160 : break;
309 : : }
310 : 204 : break;
311 : 0 : default:
312 [ # # ]: 0 : elog(ERROR, "invalid parameter mode '%c'", paramModes[i]);
313 : : break;
314 : : }
315 : : }
316 : : }
317 : :
318 : : /*
319 : : * All seems OK; prepare the data to be inserted into pg_proc.
320 : : */
321 : :
322 [ + + ]: 429226 : for (i = 0; i < Natts_pg_proc; ++i)
323 : : {
324 : 415380 : nulls[i] = false;
325 : 415380 : values[i] = (Datum) 0;
326 : 415380 : replaces[i] = true;
327 : : }
328 : :
329 : 13846 : namestrcpy(&procname, procedureName);
330 : 13846 : values[Anum_pg_proc_proname - 1] = NameGetDatum(&procname);
331 : 13846 : values[Anum_pg_proc_pronamespace - 1] = ObjectIdGetDatum(procNamespace);
332 : 13846 : values[Anum_pg_proc_proowner - 1] = ObjectIdGetDatum(proowner);
333 : 13846 : values[Anum_pg_proc_prolang - 1] = ObjectIdGetDatum(languageObjectId);
334 : 13846 : values[Anum_pg_proc_procost - 1] = Float4GetDatum(procost);
335 : 13846 : values[Anum_pg_proc_prorows - 1] = Float4GetDatum(prorows);
336 : 13846 : values[Anum_pg_proc_provariadic - 1] = ObjectIdGetDatum(variadicType);
337 : 13846 : values[Anum_pg_proc_prosupport - 1] = ObjectIdGetDatum(prosupport);
338 : 13846 : values[Anum_pg_proc_prokind - 1] = CharGetDatum(prokind);
339 : 13846 : values[Anum_pg_proc_prosecdef - 1] = BoolGetDatum(security_definer);
340 : 13846 : values[Anum_pg_proc_proleakproof - 1] = BoolGetDatum(isLeakProof);
341 : 13846 : values[Anum_pg_proc_proisstrict - 1] = BoolGetDatum(isStrict);
342 : 13846 : values[Anum_pg_proc_proretset - 1] = BoolGetDatum(returnsSet);
343 : 13846 : values[Anum_pg_proc_provolatile - 1] = CharGetDatum(volatility);
344 : 13846 : values[Anum_pg_proc_proparallel - 1] = CharGetDatum(parallel);
345 : 13846 : values[Anum_pg_proc_pronargs - 1] = Int16GetDatum(parameterCount);
346 : 13846 : values[Anum_pg_proc_pronargdefaults - 1] = Int16GetDatum(list_length(parameterDefaults));
347 : 13846 : values[Anum_pg_proc_prorettype - 1] = ObjectIdGetDatum(returnType);
348 : 13846 : values[Anum_pg_proc_proargtypes - 1] = PointerGetDatum(parameterTypes);
349 [ + + ]: 13846 : if (allParameterTypes != PointerGetDatum(NULL))
350 : 1292 : values[Anum_pg_proc_proallargtypes - 1] = allParameterTypes;
351 : : else
352 : 12554 : nulls[Anum_pg_proc_proallargtypes - 1] = true;
353 [ + + ]: 13846 : if (parameterModes != PointerGetDatum(NULL))
354 : 1292 : values[Anum_pg_proc_proargmodes - 1] = parameterModes;
355 : : else
356 : 12554 : nulls[Anum_pg_proc_proargmodes - 1] = true;
357 [ + + ]: 13846 : if (parameterNames != PointerGetDatum(NULL))
358 : 3177 : values[Anum_pg_proc_proargnames - 1] = parameterNames;
359 : : else
360 : 10669 : nulls[Anum_pg_proc_proargnames - 1] = true;
361 [ + + ]: 13846 : if (parameterDefaults != NIL)
362 : 294 : values[Anum_pg_proc_proargdefaults - 1] = CStringGetTextDatum(nodeToString(parameterDefaults));
363 : : else
364 : 13552 : nulls[Anum_pg_proc_proargdefaults - 1] = true;
365 [ + + ]: 13846 : if (trftypes != PointerGetDatum(NULL))
366 : 68 : values[Anum_pg_proc_protrftypes - 1] = trftypes;
367 : : else
368 : 13778 : nulls[Anum_pg_proc_protrftypes - 1] = true;
369 : 13846 : values[Anum_pg_proc_prosrc - 1] = CStringGetTextDatum(prosrc);
370 [ + + ]: 13846 : if (probin)
371 : 3845 : values[Anum_pg_proc_probin - 1] = CStringGetTextDatum(probin);
372 : : else
373 : 10001 : nulls[Anum_pg_proc_probin - 1] = true;
374 [ + + ]: 13846 : if (prosqlbody)
375 : 3286 : values[Anum_pg_proc_prosqlbody - 1] = CStringGetTextDatum(nodeToString(prosqlbody));
376 : : else
377 : 10560 : nulls[Anum_pg_proc_prosqlbody - 1] = true;
378 [ + + ]: 13846 : if (proconfig != PointerGetDatum(NULL))
379 : 59 : values[Anum_pg_proc_proconfig - 1] = proconfig;
380 : : else
381 : 13787 : nulls[Anum_pg_proc_proconfig - 1] = true;
382 : : /* proacl will be determined later */
383 : :
384 : 13846 : rel = table_open(ProcedureRelationId, RowExclusiveLock);
385 : 13846 : tupDesc = RelationGetDescr(rel);
386 : :
387 : : /* Check for pre-existing definition */
388 : 13846 : oldtup = SearchSysCache3(PROCNAMEARGSNSP,
389 : : PointerGetDatum(procedureName),
390 : : PointerGetDatum(parameterTypes),
391 : : ObjectIdGetDatum(procNamespace));
392 : :
393 [ + + ]: 13846 : if (HeapTupleIsValid(oldtup))
394 : : {
395 : : /* There is one; okay to replace it? */
396 : 3124 : Form_pg_proc oldproc = (Form_pg_proc) GETSTRUCT(oldtup);
397 : : Datum proargnames;
398 : : bool isnull;
399 : : const char *dropcmd;
400 : :
401 [ - + ]: 3124 : if (!replace)
402 [ # # ]: 0 : ereport(ERROR,
403 : : (errcode(ERRCODE_DUPLICATE_FUNCTION),
404 : : errmsg("function \"%s\" already exists with same argument types",
405 : : procedureName)));
406 [ - + ]: 3124 : if (!object_ownercheck(ProcedureRelationId, oldproc->oid, proowner))
407 : 0 : aclcheck_error(ACLCHECK_NOT_OWNER, OBJECT_FUNCTION,
408 : : procedureName);
409 : :
410 : : /* Not okay to change routine kind */
411 [ + + ]: 3124 : if (oldproc->prokind != prokind)
412 [ + - - + : 12 : ereport(ERROR,
+ - - - -
- ]
413 : : (errcode(ERRCODE_WRONG_OBJECT_TYPE),
414 : : errmsg("cannot change routine kind"),
415 : : (oldproc->prokind == PROKIND_AGGREGATE ?
416 : : errdetail("\"%s\" is an aggregate function.", procedureName) :
417 : : oldproc->prokind == PROKIND_FUNCTION ?
418 : : errdetail("\"%s\" is a function.", procedureName) :
419 : : oldproc->prokind == PROKIND_PROCEDURE ?
420 : : errdetail("\"%s\" is a procedure.", procedureName) :
421 : : oldproc->prokind == PROKIND_WINDOW ?
422 : : errdetail("\"%s\" is a window function.", procedureName) :
423 : : 0)));
424 : :
425 [ + + + + ]: 3112 : dropcmd = (prokind == PROKIND_PROCEDURE ? "DROP PROCEDURE" :
426 : : prokind == PROKIND_AGGREGATE ? "DROP AGGREGATE" :
427 : : "DROP FUNCTION");
428 : :
429 : : /*
430 : : * Not okay to change the return type of the existing proc, since
431 : : * existing rules, views, etc may depend on the return type.
432 : : *
433 : : * In case of a procedure, a changing return type means that whether
434 : : * the procedure has output parameters was changed. Since there is no
435 : : * user visible return type, we produce a more specific error message.
436 : : */
437 [ + + ]: 3112 : if (returnType != oldproc->prorettype ||
438 [ - + ]: 3104 : returnsSet != oldproc->proretset)
439 [ + - - + ]: 8 : ereport(ERROR,
440 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
441 : : prokind == PROKIND_PROCEDURE
442 : : ? errmsg("cannot change whether a procedure has output parameters")
443 : : : errmsg("cannot change return type of existing function"),
444 : :
445 : : /*
446 : : * translator: first %s is DROP FUNCTION, DROP PROCEDURE, or DROP
447 : : * AGGREGATE
448 : : */
449 : : errhint("Use %s %s first.",
450 : : dropcmd,
451 : : format_procedure(oldproc->oid))));
452 : :
453 : : /*
454 : : * If it returns RECORD, check for possible change of record type
455 : : * implied by OUT parameters
456 : : */
457 [ + + ]: 3104 : if (returnType == RECORDOID)
458 : : {
459 : : TupleDesc olddesc;
460 : : TupleDesc newdesc;
461 : :
462 : 167 : olddesc = build_function_result_tupdesc_t(oldtup);
463 : 167 : newdesc = build_function_result_tupdesc_d(prokind,
464 : : allParameterTypes,
465 : : parameterModes,
466 : : parameterNames);
467 [ + + + - ]: 167 : if (olddesc == NULL && newdesc == NULL)
468 : : /* ok, both are runtime-defined RECORDs */ ;
469 [ + - + - ]: 153 : else if (olddesc == NULL || newdesc == NULL ||
470 [ - + ]: 153 : !equalRowTypes(olddesc, newdesc))
471 [ # # ]: 0 : ereport(ERROR,
472 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
473 : : errmsg("cannot change return type of existing function"),
474 : : errdetail("Row type defined by OUT parameters is different."),
475 : : /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
476 : : errhint("Use %s %s first.",
477 : : dropcmd,
478 : : format_procedure(oldproc->oid))));
479 : : }
480 : :
481 : : /*
482 : : * If there were any named input parameters, check to make sure the
483 : : * names have not been changed, as this could break existing calls. We
484 : : * allow adding names to formerly unnamed parameters, though.
485 : : */
486 : 3104 : proargnames = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
487 : : Anum_pg_proc_proargnames,
488 : : &isnull);
489 [ + + ]: 3104 : if (!isnull)
490 : : {
491 : : Datum proargmodes;
492 : : char **old_arg_names;
493 : : char **new_arg_names;
494 : : int n_old_arg_names;
495 : : int n_new_arg_names;
496 : : int j;
497 : :
498 : 205 : proargmodes = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
499 : : Anum_pg_proc_proargmodes,
500 : : &isnull);
501 [ + + ]: 205 : if (isnull)
502 : 40 : proargmodes = PointerGetDatum(NULL); /* just to be sure */
503 : :
504 : 205 : n_old_arg_names = get_func_input_arg_names(proargnames,
505 : : proargmodes,
506 : : &old_arg_names);
507 : 205 : n_new_arg_names = get_func_input_arg_names(parameterNames,
508 : : parameterModes,
509 : : &new_arg_names);
510 [ + + ]: 517 : for (j = 0; j < n_old_arg_names; j++)
511 : : {
512 [ + + ]: 324 : if (old_arg_names[j] == NULL)
513 : 4 : continue;
514 [ + - + + ]: 320 : if (j >= n_new_arg_names || new_arg_names[j] == NULL ||
515 [ + + ]: 316 : strcmp(old_arg_names[j], new_arg_names[j]) != 0)
516 [ + - ]: 12 : ereport(ERROR,
517 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
518 : : errmsg("cannot change name of input parameter \"%s\"",
519 : : old_arg_names[j]),
520 : : /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
521 : : errhint("Use %s %s first.",
522 : : dropcmd,
523 : : format_procedure(oldproc->oid))));
524 : : }
525 : : }
526 : :
527 : : /*
528 : : * If there are existing defaults, check compatibility: redefinition
529 : : * must not remove any defaults nor change their types. (Removing a
530 : : * default might cause a function to fail to satisfy an existing call.
531 : : * Changing type would only be possible if the associated parameter is
532 : : * polymorphic, and in such cases a change of default type might alter
533 : : * the resolved output type of existing calls.)
534 : : */
535 [ + + ]: 3092 : if (oldproc->pronargdefaults != 0)
536 : : {
537 : : Datum proargdefaults;
538 : : List *oldDefaults;
539 : : ListCell *oldlc;
540 : : ListCell *newlc;
541 : :
542 [ + - ]: 4 : if (list_length(parameterDefaults) < oldproc->pronargdefaults)
543 [ + - ]: 4 : ereport(ERROR,
544 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
545 : : errmsg("cannot remove parameter defaults from existing function"),
546 : : /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
547 : : errhint("Use %s %s first.",
548 : : dropcmd,
549 : : format_procedure(oldproc->oid))));
550 : :
551 : 0 : proargdefaults = SysCacheGetAttrNotNull(PROCNAMEARGSNSP, oldtup,
552 : : Anum_pg_proc_proargdefaults);
553 : 0 : oldDefaults = castNode(List, stringToNode(TextDatumGetCString(proargdefaults)));
554 : : Assert(list_length(oldDefaults) == oldproc->pronargdefaults);
555 : :
556 : : /* new list can have more defaults than old, advance over 'em */
557 : 0 : newlc = list_nth_cell(parameterDefaults,
558 : 0 : list_length(parameterDefaults) -
559 : 0 : oldproc->pronargdefaults);
560 : :
561 [ # # # # : 0 : foreach(oldlc, oldDefaults)
# # ]
562 : : {
563 : 0 : Node *oldDef = (Node *) lfirst(oldlc);
564 : 0 : Node *newDef = (Node *) lfirst(newlc);
565 : :
566 [ # # ]: 0 : if (exprType(oldDef) != exprType(newDef))
567 [ # # ]: 0 : ereport(ERROR,
568 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
569 : : errmsg("cannot change data type of existing parameter default value"),
570 : : /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
571 : : errhint("Use %s %s first.",
572 : : dropcmd,
573 : : format_procedure(oldproc->oid))));
574 : 0 : newlc = lnext(parameterDefaults, newlc);
575 : : }
576 : : }
577 : :
578 : : /*
579 : : * Do not change existing oid, ownership or permissions, either. Note
580 : : * dependency-update code below has to agree with this decision.
581 : : */
582 : 3088 : replaces[Anum_pg_proc_oid - 1] = false;
583 : 3088 : replaces[Anum_pg_proc_proowner - 1] = false;
584 : 3088 : replaces[Anum_pg_proc_proacl - 1] = false;
585 : :
586 : : /* Okay, do it... */
587 : 3088 : tup = heap_modify_tuple(oldtup, tupDesc, values, nulls, replaces);
588 : 3088 : CatalogTupleUpdate(rel, &tup->t_self, tup);
589 : :
590 : 3088 : ReleaseSysCache(oldtup);
591 : 3088 : is_update = true;
592 : : }
593 : : else
594 : : {
595 : : /* Creating a new procedure */
596 : : Oid newOid;
597 : :
598 : : /* First, get default permissions and set up proacl */
599 : 10722 : proacl = get_user_default_acl(OBJECT_FUNCTION, proowner,
600 : : procNamespace);
601 [ + + ]: 10722 : if (proacl != NULL)
602 : 12 : values[Anum_pg_proc_proacl - 1] = PointerGetDatum(proacl);
603 : : else
604 : 10710 : nulls[Anum_pg_proc_proacl - 1] = true;
605 : :
606 : 10722 : newOid = GetNewOidWithIndex(rel, ProcedureOidIndexId,
607 : : Anum_pg_proc_oid);
608 : 10722 : values[Anum_pg_proc_oid - 1] = ObjectIdGetDatum(newOid);
609 : 10722 : tup = heap_form_tuple(tupDesc, values, nulls);
610 : 10722 : CatalogTupleInsert(rel, tup);
611 : 10722 : is_update = false;
612 : : }
613 : :
614 : :
615 : 13810 : retval = ((Form_pg_proc) GETSTRUCT(tup))->oid;
616 : :
617 : : /*
618 : : * Create dependencies for the new function. If we are updating an
619 : : * existing function, first delete any existing pg_depend entries.
620 : : * (However, since we are not changing ownership or permissions, the
621 : : * shared dependencies do *not* need to change, and we leave them alone.)
622 : : */
623 [ + + ]: 13810 : if (is_update)
624 : 3088 : deleteDependencyRecordsFor(ProcedureRelationId, retval, true);
625 : :
626 : 13810 : addrs = new_object_addresses();
627 : :
628 : 13810 : ObjectAddressSet(myself, ProcedureRelationId, retval);
629 : :
630 : : /* dependency on namespace */
631 : 13810 : ObjectAddressSet(referenced, NamespaceRelationId, procNamespace);
632 : 13810 : add_exact_object_address(&referenced, addrs);
633 : :
634 : : /* dependency on implementation language */
635 : 13810 : ObjectAddressSet(referenced, LanguageRelationId, languageObjectId);
636 : 13810 : add_exact_object_address(&referenced, addrs);
637 : :
638 : : /* dependency on return type */
639 : 13810 : ObjectAddressSet(referenced, TypeRelationId, returnType);
640 : 13810 : add_exact_object_address(&referenced, addrs);
641 : :
642 : : /* dependency on parameter types */
643 [ + + ]: 39892 : for (i = 0; i < allParamCount; i++)
644 : : {
645 : 26082 : ObjectAddressSet(referenced, TypeRelationId, allParams[i]);
646 : 26082 : add_exact_object_address(&referenced, addrs);
647 : : }
648 : :
649 : : /* dependency on transforms, if any */
650 [ + + + + : 27690 : foreach_oid(transformid, trfoids)
+ + ]
651 : : {
652 : 70 : ObjectAddressSet(referenced, TransformRelationId, transformid);
653 : 70 : add_exact_object_address(&referenced, addrs);
654 : : }
655 : :
656 : : /* dependency on support function, if any */
657 [ + + ]: 13810 : if (OidIsValid(prosupport))
658 : : {
659 : 62 : ObjectAddressSet(referenced, ProcedureRelationId, prosupport);
660 : 62 : add_exact_object_address(&referenced, addrs);
661 : : }
662 : :
663 : : /* dependencies appearing in new-style SQL routine body */
664 [ + + + + ]: 13810 : if (languageObjectId == SQLlanguageId && prosqlbody)
665 : 3286 : collectDependenciesOfExpr(addrs, prosqlbody, NIL);
666 : :
667 : : /* dependency on parameter default expressions */
668 [ + + ]: 13810 : if (parameterDefaults)
669 : 286 : collectDependenciesOfExpr(addrs, (Node *) parameterDefaults, NIL);
670 : :
671 : : /*
672 : : * Now that we have all the normal dependencies, thumb through them and
673 : : * warn if any are to temporary objects. This informs the user if their
674 : : * supposedly non-temp function will silently go away at session exit, due
675 : : * to a dependency on a temp object. However, do not complain when a
676 : : * function created in our own pg_temp namespace refers to other objects
677 : : * in that namespace, since then they'll have similar lifespans anyway.
678 : : */
679 [ + + ]: 13810 : if (find_temp_object(addrs, isTempNamespace(procNamespace), &temp_object))
680 [ + - ]: 43 : ereport(NOTICE,
681 : : (errmsg("function \"%s\" will be effectively temporary",
682 : : procedureName),
683 : : errdetail("It depends on temporary %s.",
684 : : getObjectDescription(&temp_object, false))));
685 : :
686 : : /*
687 : : * Now record all normal dependencies at once. This will also remove any
688 : : * duplicates in the list. (Role and extension dependencies are handled
689 : : * separately below. Role dependencies would have to be separate anyway
690 : : * since they are shared dependencies. An extension dependency could be
691 : : * folded into the addrs list, but pg_depend.c doesn't make that easy, and
692 : : * it won't duplicate anything we've collected so far anyway.)
693 : : */
694 : 13810 : record_object_address_dependencies(&myself, addrs, DEPENDENCY_NORMAL);
695 : :
696 : 13806 : free_object_addresses(addrs);
697 : :
698 : : /* dependency on owner */
699 [ + + ]: 13806 : if (!is_update)
700 : 10718 : recordDependencyOnOwner(ProcedureRelationId, retval, proowner);
701 : :
702 : : /* dependency on any roles mentioned in ACL */
703 [ + + ]: 13806 : if (!is_update)
704 : 10718 : recordDependencyOnNewAcl(ProcedureRelationId, retval, 0,
705 : : proowner, proacl);
706 : :
707 : : /* dependency on extension */
708 : 13806 : recordDependencyOnCurrentExtension(&myself, is_update);
709 : :
710 : 13805 : heap_freetuple(tup);
711 : :
712 : : /* Post creation hook for new function */
713 [ + + ]: 13805 : InvokeObjectPostCreateHook(ProcedureRelationId, retval, 0);
714 : :
715 : 13805 : table_close(rel, RowExclusiveLock);
716 : :
717 : : /* Verify function body */
718 [ + + ]: 13805 : if (OidIsValid(languageValidator))
719 : : {
720 : 13367 : ArrayType *set_items = NULL;
721 : 13367 : int save_nestlevel = 0;
722 : :
723 : : /* Advance command counter so new tuple can be seen by validator */
724 : 13367 : CommandCounterIncrement();
725 : :
726 : : /*
727 : : * Set per-function configuration parameters so that the validation is
728 : : * done with the environment the function expects. However, if
729 : : * check_function_bodies is off, we don't do this, because that would
730 : : * create dump ordering hazards that pg_dump doesn't know how to deal
731 : : * with. (For example, a SET clause might refer to a not-yet-created
732 : : * text search configuration.) This means that the validator
733 : : * shouldn't complain about anything that might depend on a GUC
734 : : * parameter when check_function_bodies is off.
735 : : */
736 [ + + ]: 13367 : if (check_function_bodies)
737 : : {
738 : 9062 : set_items = (ArrayType *) DatumGetPointer(proconfig);
739 [ + + ]: 9062 : if (set_items) /* Need a new GUC nesting level */
740 : : {
741 : 52 : save_nestlevel = NewGUCNestLevel();
742 [ + - ]: 52 : ProcessGUCArray(set_items,
743 : 52 : (superuser() ? PGC_SUSET : PGC_USERSET),
744 : : PGC_S_SESSION,
745 : : GUC_ACTION_SAVE);
746 : : }
747 : : }
748 : :
749 : 13359 : OidFunctionCall1(languageValidator, ObjectIdGetDatum(retval));
750 : :
751 [ + + ]: 13241 : if (set_items)
752 : 44 : AtEOXact_GUC(true, save_nestlevel);
753 : : }
754 : :
755 : : /* ensure that stats are dropped if transaction aborts */
756 [ + + ]: 13679 : if (!is_update)
757 : 10592 : pgstat_create_function(retval);
758 : :
759 : 13679 : return myself;
760 : : }
761 : :
762 : :
763 : :
764 : : /*
765 : : * Validator for internal functions
766 : : *
767 : : * Check that the given internal function name (the "prosrc" value) is
768 : : * a known builtin function.
769 : : */
770 : : Datum
771 : 1095 : fmgr_internal_validator(PG_FUNCTION_ARGS)
772 : : {
773 : 1095 : Oid funcoid = PG_GETARG_OID(0);
774 : : HeapTuple tuple;
775 : : Datum tmp;
776 : : char *prosrc;
777 : :
778 [ - + ]: 1095 : if (!CheckFunctionValidatorAccess(fcinfo->flinfo->fn_oid, funcoid))
779 : 0 : PG_RETURN_VOID();
780 : :
781 : : /*
782 : : * We do not honor check_function_bodies since it's unlikely the function
783 : : * name will be found later if it isn't there now.
784 : : */
785 : :
786 : 1095 : tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcoid));
787 [ - + ]: 1095 : if (!HeapTupleIsValid(tuple))
788 [ # # ]: 0 : elog(ERROR, "cache lookup failed for function %u", funcoid);
789 : :
790 : 1095 : tmp = SysCacheGetAttrNotNull(PROCOID, tuple, Anum_pg_proc_prosrc);
791 : 1095 : prosrc = TextDatumGetCString(tmp);
792 : :
793 [ + + ]: 1095 : if (fmgr_internal_function(prosrc) == InvalidOid)
794 [ + - ]: 4 : ereport(ERROR,
795 : : (errcode(ERRCODE_UNDEFINED_FUNCTION),
796 : : errmsg("there is no built-in function named \"%s\"",
797 : : prosrc)));
798 : :
799 : 1091 : ReleaseSysCache(tuple);
800 : :
801 : 1091 : PG_RETURN_VOID();
802 : : }
803 : :
804 : :
805 : :
806 : : /*
807 : : * Validator for C language functions
808 : : *
809 : : * Make sure that the library file exists, is loadable, and contains
810 : : * the specified link symbol. Also check for a valid function
811 : : * information record.
812 : : */
813 : : Datum
814 : 3845 : fmgr_c_validator(PG_FUNCTION_ARGS)
815 : : {
816 : 3845 : Oid funcoid = PG_GETARG_OID(0);
817 : : void *libraryhandle;
818 : : HeapTuple tuple;
819 : : Datum tmp;
820 : : char *prosrc;
821 : : char *probin;
822 : :
823 [ - + ]: 3845 : if (!CheckFunctionValidatorAccess(fcinfo->flinfo->fn_oid, funcoid))
824 : 0 : PG_RETURN_VOID();
825 : :
826 : : /*
827 : : * It'd be most consistent to skip the check if !check_function_bodies,
828 : : * but the purpose of that switch is to be helpful for pg_dump loading,
829 : : * and for pg_dump loading it's much better if we *do* check.
830 : : */
831 : :
832 : 3845 : tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcoid));
833 [ - + ]: 3845 : if (!HeapTupleIsValid(tuple))
834 [ # # ]: 0 : elog(ERROR, "cache lookup failed for function %u", funcoid);
835 : :
836 : 3845 : tmp = SysCacheGetAttrNotNull(PROCOID, tuple, Anum_pg_proc_prosrc);
837 : 3845 : prosrc = TextDatumGetCString(tmp);
838 : :
839 : 3845 : tmp = SysCacheGetAttrNotNull(PROCOID, tuple, Anum_pg_proc_probin);
840 : 3845 : probin = TextDatumGetCString(tmp);
841 : :
842 : 3845 : (void) load_external_function(probin, prosrc, true, &libraryhandle);
843 : 3837 : (void) fetch_finfo_record(libraryhandle, prosrc);
844 : :
845 : 3837 : ReleaseSysCache(tuple);
846 : :
847 : 3837 : PG_RETURN_VOID();
848 : : }
849 : :
850 : :
851 : : /*
852 : : * Validator for SQL language functions
853 : : *
854 : : * Parse it here in order to be sure that it contains no syntax errors.
855 : : */
856 : : Datum
857 : 5069 : fmgr_sql_validator(PG_FUNCTION_ARGS)
858 : : {
859 : 5069 : Oid funcoid = PG_GETARG_OID(0);
860 : : HeapTuple tuple;
861 : : Form_pg_proc proc;
862 : : List *raw_parsetree_list;
863 : : List *querytree_list;
864 : : ListCell *lc;
865 : : bool isnull;
866 : : Datum tmp;
867 : : char *prosrc;
868 : : parse_error_callback_arg callback_arg;
869 : : ErrorContextCallback sqlerrcontext;
870 : : bool haspolyarg;
871 : : int i;
872 : :
873 [ - + ]: 5069 : if (!CheckFunctionValidatorAccess(fcinfo->flinfo->fn_oid, funcoid))
874 : 0 : PG_RETURN_VOID();
875 : :
876 : 5069 : tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcoid));
877 [ - + ]: 5069 : if (!HeapTupleIsValid(tuple))
878 [ # # ]: 0 : elog(ERROR, "cache lookup failed for function %u", funcoid);
879 : 5069 : proc = (Form_pg_proc) GETSTRUCT(tuple);
880 : :
881 : : /* Disallow pseudotype result */
882 : : /* except for RECORD, VOID, or polymorphic */
883 [ + + ]: 5069 : if (get_typtype(proc->prorettype) == TYPTYPE_PSEUDO &&
884 [ + + ]: 968 : proc->prorettype != RECORDOID &&
885 [ + + ]: 537 : proc->prorettype != VOIDOID &&
886 [ + + + + : 251 : !IsPolymorphicType(proc->prorettype))
+ - + - +
+ + + + +
+ + + - +
+ + + ]
887 [ + - ]: 4 : ereport(ERROR,
888 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
889 : : errmsg("SQL functions cannot return type %s",
890 : : format_type_be(proc->prorettype))));
891 : :
892 : : /* Disallow pseudotypes in arguments */
893 : : /* except for polymorphic */
894 : 5065 : haspolyarg = false;
895 [ + + ]: 13826 : for (i = 0; i < proc->pronargs; i++)
896 : : {
897 [ + + ]: 8761 : if (get_typtype(proc->proargtypes.values[i]) == TYPTYPE_PSEUDO)
898 : : {
899 [ + + + + : 637 : if (IsPolymorphicType(proc->proargtypes.values[i]))
+ - + - +
+ + + + +
+ + + + +
+ + - ]
900 : 637 : haspolyarg = true;
901 : : else
902 [ # # ]: 0 : ereport(ERROR,
903 : : (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
904 : : errmsg("SQL functions cannot have arguments of type %s",
905 : : format_type_be(proc->proargtypes.values[i]))));
906 : : }
907 : : }
908 : :
909 : : /* Postpone body checks if !check_function_bodies */
910 [ + + ]: 5065 : if (check_function_bodies)
911 : : {
912 : 4803 : tmp = SysCacheGetAttrNotNull(PROCOID, tuple, Anum_pg_proc_prosrc);
913 : 4803 : prosrc = TextDatumGetCString(tmp);
914 : :
915 : : /*
916 : : * Setup error traceback support for ereport().
917 : : */
918 : 4803 : callback_arg.proname = NameStr(proc->proname);
919 : 4803 : callback_arg.prosrc = prosrc;
920 : :
921 : 4803 : sqlerrcontext.callback = sql_function_parse_error_callback;
922 : 4803 : sqlerrcontext.arg = &callback_arg;
923 : 4803 : sqlerrcontext.previous = error_context_stack;
924 : 4803 : error_context_stack = &sqlerrcontext;
925 : :
926 : : /* If we have prosqlbody, pay attention to that not prosrc */
927 : 4803 : tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosqlbody, &isnull);
928 [ + + ]: 4803 : if (!isnull)
929 : : {
930 : : Node *n;
931 : : List *stored_query_list;
932 : :
933 : 3226 : n = stringToNode(TextDatumGetCString(tmp));
934 [ + + ]: 3226 : if (IsA(n, List))
935 : 502 : stored_query_list = linitial(castNode(List, n));
936 : : else
937 : 2724 : stored_query_list = list_make1(n);
938 : :
939 : 3226 : querytree_list = NIL;
940 [ + + + + : 6452 : foreach(lc, stored_query_list)
+ + ]
941 : : {
942 : 3226 : Query *parsetree = lfirst_node(Query, lc);
943 : : List *querytree_sublist;
944 : :
945 : : /*
946 : : * Typically, we'd have acquired locks already while parsing
947 : : * the body of the CREATE FUNCTION command. However, a
948 : : * validator function cannot assume that it's only called in
949 : : * that context.
950 : : */
951 : 3226 : AcquireRewriteLocks(parsetree, true, false);
952 : 3226 : querytree_sublist = pg_rewrite_query(parsetree);
953 : 3226 : querytree_list = lappend(querytree_list, querytree_sublist);
954 : : }
955 : : }
956 : : else
957 : : {
958 : : /*
959 : : * We can't do full prechecking of the function definition if
960 : : * there are any polymorphic input types, because actual datatypes
961 : : * of expression results will be unresolvable. The check will be
962 : : * done at runtime instead.
963 : : *
964 : : * We can run the text through the raw parser though; this will at
965 : : * least catch silly syntactic errors.
966 : : */
967 : 1577 : raw_parsetree_list = pg_parse_query(prosrc);
968 : 1572 : querytree_list = NIL;
969 : :
970 [ + + ]: 1572 : if (!haspolyarg)
971 : : {
972 : : /*
973 : : * OK to do full precheck: analyze and rewrite the queries,
974 : : * then verify the result type.
975 : : */
976 : : SQLFunctionParseInfoPtr pinfo;
977 : :
978 : : /* But first, set up parameter information */
979 : 1163 : pinfo = prepare_sql_fn_parse_info(tuple, NULL, InvalidOid);
980 : :
981 [ + + + + : 2385 : foreach(lc, raw_parsetree_list)
+ + ]
982 : : {
983 : 1230 : RawStmt *parsetree = lfirst_node(RawStmt, lc);
984 : : List *querytree_sublist;
985 : :
986 : 1230 : querytree_sublist = pg_analyze_and_rewrite_withcb(parsetree,
987 : : prosrc,
988 : : (ParserSetupHook) sql_fn_parser_setup,
989 : : pinfo,
990 : : NULL);
991 : 1222 : querytree_list = lappend(querytree_list,
992 : : querytree_sublist);
993 : : }
994 : : }
995 : : }
996 : :
997 [ + + ]: 4790 : if (!haspolyarg)
998 : : {
999 : : Oid rettype;
1000 : : TupleDesc rettupdesc;
1001 : :
1002 : 4381 : check_sql_fn_statements(querytree_list);
1003 : :
1004 : 4377 : (void) get_func_result_type(funcoid, &rettype, &rettupdesc);
1005 : :
1006 : 4377 : (void) check_sql_fn_retval(querytree_list,
1007 : : rettype, rettupdesc,
1008 : 4377 : proc->prokind,
1009 : : false);
1010 : : }
1011 : :
1012 : 4774 : error_context_stack = sqlerrcontext.previous;
1013 : : }
1014 : :
1015 : 5036 : ReleaseSysCache(tuple);
1016 : :
1017 : 5036 : PG_RETURN_VOID();
1018 : : }
1019 : :
1020 : : /*
1021 : : * Error context callback for handling errors in SQL function definitions
1022 : : */
1023 : : static void
1024 : 29 : sql_function_parse_error_callback(void *arg)
1025 : : {
1026 : 29 : parse_error_callback_arg *callback_arg = (parse_error_callback_arg *) arg;
1027 : :
1028 : : /* See if it's a syntax error; if so, transpose to CREATE FUNCTION */
1029 [ + + ]: 29 : if (!function_parse_error_transpose(callback_arg->prosrc))
1030 : : {
1031 : : /* If it's not a syntax error, push info onto context stack */
1032 : 16 : errcontext("SQL function \"%s\"", callback_arg->proname);
1033 : : }
1034 : 29 : }
1035 : :
1036 : : /*
1037 : : * Adjust a syntax error occurring inside the function body of a CREATE
1038 : : * FUNCTION or DO command. This can be used by any function validator or
1039 : : * anonymous-block handler, not only for SQL-language functions.
1040 : : * It is assumed that the syntax error position is initially relative to the
1041 : : * function body string (as passed in). If possible, we adjust the position
1042 : : * to reference the original command text; if we can't manage that, we set
1043 : : * up an "internal query" syntax error instead.
1044 : : *
1045 : : * Returns true if a syntax error was processed, false if not.
1046 : : */
1047 : : bool
1048 : 159 : function_parse_error_transpose(const char *prosrc)
1049 : : {
1050 : : int origerrposition;
1051 : : int newerrposition;
1052 : :
1053 : : /*
1054 : : * Nothing to do unless we are dealing with a syntax error that has a
1055 : : * cursor position.
1056 : : *
1057 : : * Some PLs may prefer to report the error position as an internal error
1058 : : * to begin with, so check that too.
1059 : : */
1060 : 159 : origerrposition = geterrposition();
1061 [ + + ]: 159 : if (origerrposition <= 0)
1062 : : {
1063 : 146 : origerrposition = getinternalerrposition();
1064 [ + + ]: 146 : if (origerrposition <= 0)
1065 : 42 : return false;
1066 : : }
1067 : :
1068 : : /* We can get the original query text from the active portal (hack...) */
1069 [ + - + - ]: 117 : if (ActivePortal && ActivePortal->status == PORTAL_ACTIVE)
1070 : 117 : {
1071 : 117 : const char *queryText = ActivePortal->sourceText;
1072 : :
1073 : : /* Try to locate the prosrc in the original text */
1074 : 117 : newerrposition = match_prosrc_to_query(prosrc, queryText,
1075 : : origerrposition);
1076 : : }
1077 : : else
1078 : : {
1079 : : /*
1080 : : * Quietly give up if no ActivePortal. This is an unusual situation
1081 : : * but it can happen in, e.g., logical replication workers.
1082 : : */
1083 : 0 : newerrposition = -1;
1084 : : }
1085 : :
1086 [ + + ]: 117 : if (newerrposition > 0)
1087 : : {
1088 : : /* Successful, so fix error position to reference original query */
1089 : 116 : errposition(newerrposition);
1090 : : /* Get rid of any report of the error as an "internal query" */
1091 : 116 : internalerrposition(0);
1092 : 116 : internalerrquery(NULL);
1093 : : }
1094 : : else
1095 : : {
1096 : : /*
1097 : : * If unsuccessful, convert the position to an internal position
1098 : : * marker and give the function text as the internal query.
1099 : : */
1100 : 1 : errposition(0);
1101 : 1 : internalerrposition(origerrposition);
1102 : 1 : internalerrquery(prosrc);
1103 : : }
1104 : :
1105 : 117 : return true;
1106 : : }
1107 : :
1108 : : /*
1109 : : * Try to locate the string literal containing the function body in the
1110 : : * given text of the CREATE FUNCTION or DO command. If successful, return
1111 : : * the character (not byte) index within the command corresponding to the
1112 : : * given character index within the literal. If not successful, return 0.
1113 : : */
1114 : : static int
1115 : 117 : match_prosrc_to_query(const char *prosrc, const char *queryText,
1116 : : int cursorpos)
1117 : : {
1118 : : /*
1119 : : * Rather than fully parsing the original command, we just scan the
1120 : : * command looking for $prosrc$ or 'prosrc'. This could be fooled (though
1121 : : * not in any very probable scenarios), so fail if we find more than one
1122 : : * match.
1123 : : */
1124 : 117 : int prosrclen = strlen(prosrc);
1125 : 117 : int querylen = strlen(queryText);
1126 : 117 : int matchpos = 0;
1127 : : int curpos;
1128 : : int newcursorpos;
1129 : :
1130 [ + + ]: 8189 : for (curpos = 0; curpos < querylen - prosrclen; curpos++)
1131 : : {
1132 [ + + ]: 8072 : if (queryText[curpos] == '$' &&
1133 [ + + ]: 216 : strncmp(prosrc, &queryText[curpos + 1], prosrclen) == 0 &&
1134 [ + - ]: 108 : queryText[curpos + 1 + prosrclen] == '$')
1135 : : {
1136 : : /*
1137 : : * Found a $foo$ match. Since there are no embedded quoting
1138 : : * characters in a dollar-quoted literal, we don't have to do any
1139 : : * fancy arithmetic; just offset by the starting position.
1140 : : */
1141 [ - + ]: 108 : if (matchpos)
1142 : 0 : return 0; /* multiple matches, fail */
1143 : 108 : matchpos = pg_mbstrlen_with_len(queryText, curpos + 1)
1144 : : + cursorpos;
1145 : : }
1146 [ + + + - ]: 7972 : else if (queryText[curpos] == '\'' &&
1147 : 8 : match_prosrc_to_literal(prosrc, &queryText[curpos + 1],
1148 : : cursorpos, &newcursorpos))
1149 : : {
1150 : : /*
1151 : : * Found a 'foo' match. match_prosrc_to_literal() has adjusted
1152 : : * for any quotes or backslashes embedded in the literal.
1153 : : */
1154 [ - + ]: 8 : if (matchpos)
1155 : 0 : return 0; /* multiple matches, fail */
1156 : 8 : matchpos = pg_mbstrlen_with_len(queryText, curpos + 1)
1157 : 8 : + newcursorpos;
1158 : : }
1159 : : }
1160 : :
1161 : 117 : return matchpos;
1162 : : }
1163 : :
1164 : : /*
1165 : : * Try to match the given source text to a single-quoted literal.
1166 : : * If successful, adjust newcursorpos to correspond to the character
1167 : : * (not byte) index corresponding to cursorpos in the source text.
1168 : : *
1169 : : * At entry, literal points just past a ' character. We must check for the
1170 : : * trailing quote.
1171 : : */
1172 : : static bool
1173 : 8 : match_prosrc_to_literal(const char *prosrc, const char *literal,
1174 : : int cursorpos, int *newcursorpos)
1175 : : {
1176 : 8 : int newcp = cursorpos;
1177 : : int chlen;
1178 : :
1179 : : /*
1180 : : * This implementation handles backslashes and doubled quotes in the
1181 : : * string literal. It does not handle the SQL syntax for literals
1182 : : * continued across line boundaries.
1183 : : *
1184 : : * We do the comparison a character at a time, not a byte at a time, so
1185 : : * that we can do the correct cursorpos math.
1186 : : */
1187 [ + + ]: 96 : while (*prosrc)
1188 : : {
1189 : 88 : cursorpos--; /* characters left before cursor */
1190 : :
1191 : : /*
1192 : : * Check for backslashes and doubled quotes in the literal; adjust
1193 : : * newcp when one is found before the cursor.
1194 : : */
1195 [ - + ]: 88 : if (*literal == '\\')
1196 : : {
1197 : 0 : literal++;
1198 [ # # ]: 0 : if (cursorpos > 0)
1199 : 0 : newcp++;
1200 : : }
1201 [ - + ]: 88 : else if (*literal == '\'')
1202 : : {
1203 [ # # ]: 0 : if (literal[1] != '\'')
1204 : 0 : goto fail;
1205 : 0 : literal++;
1206 [ # # ]: 0 : if (cursorpos > 0)
1207 : 0 : newcp++;
1208 : : }
1209 : 88 : chlen = pg_mblen_cstr(prosrc);
1210 [ - + ]: 88 : if (strncmp(prosrc, literal, chlen) != 0)
1211 : 0 : goto fail;
1212 : 88 : prosrc += chlen;
1213 : 88 : literal += chlen;
1214 : : }
1215 : :
1216 [ + - - + ]: 8 : if (*literal == '\'' && literal[1] != '\'')
1217 : : {
1218 : : /* success */
1219 : 8 : *newcursorpos = newcp;
1220 : 8 : return true;
1221 : : }
1222 : :
1223 : 0 : fail:
1224 : : /* Must set *newcursorpos to suppress compiler warning */
1225 : 0 : *newcursorpos = newcp;
1226 : 0 : return false;
1227 : : }
1228 : :
1229 : : List *
1230 : 71 : oid_array_to_list(Datum datum)
1231 : : {
1232 : 71 : ArrayType *array = DatumGetArrayTypeP(datum);
1233 : : Datum *values;
1234 : : int nelems;
1235 : : int i;
1236 : 71 : List *result = NIL;
1237 : :
1238 : 71 : deconstruct_array_builtin(array, OIDOID, &values, NULL, &nelems);
1239 [ + + ]: 144 : for (i = 0; i < nelems; i++)
1240 : 73 : result = lappend_oid(result, DatumGetObjectId(values[i]));
1241 : 71 : return result;
1242 : : }
|
