1 /*-------------------------------------------------------------------------
4 * routines to support manipulation of the pg_proc relation
6 * Portions Copyright (c) 1996-2006, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * $PostgreSQL: pgsql/src/backend/catalog/pg_proc.c,v 1.140 2006/07/13 16:49:13 momjian Exp $
13 *-------------------------------------------------------------------------
17 #include "access/heapam.h"
18 #include "access/xact.h"
19 #include "catalog/dependency.h"
20 #include "catalog/indexing.h"
21 #include "catalog/pg_language.h"
22 #include "catalog/pg_namespace.h"
23 #include "catalog/pg_proc.h"
24 #include "catalog/pg_type.h"
25 #include "executor/functions.h"
27 #include "mb/pg_wchar.h"
28 #include "miscadmin.h"
29 #include "parser/parse_type.h"
30 #include "tcop/pquery.h"
31 #include "tcop/tcopprot.h"
32 #include "utils/acl.h"
33 #include "utils/builtins.h"
34 #include "utils/lsyscache.h"
35 #include "utils/syscache.h"
39 bool check_function_bodies = true;
42 Datum fmgr_internal_validator(PG_FUNCTION_ARGS);
43 Datum fmgr_c_validator(PG_FUNCTION_ARGS);
44 Datum fmgr_sql_validator(PG_FUNCTION_ARGS);
46 static void sql_function_parse_error_callback(void *arg);
47 static int match_prosrc_to_query(const char *prosrc, const char *queryText,
49 static bool match_prosrc_to_literal(const char *prosrc, const char *literal,
50 int cursorpos, int *newcursorpos);
53 /* ----------------------------------------------------------------
56 * Note: allParameterTypes, parameterModes, parameterNames are either arrays
57 * of the proper types or NULL. We declare them Datum, not "ArrayType *",
58 * to avoid importing array.h into pg_proc.h.
59 * ----------------------------------------------------------------
62 ProcedureCreate(const char *procedureName,
68 Oid languageValidator,
72 bool security_definer,
75 oidvector *parameterTypes,
76 Datum allParameterTypes,
84 bool genericInParam = false;
85 bool genericOutParam = false;
86 bool internalInParam = false;
87 bool internalOutParam = false;
91 char nulls[Natts_pg_proc];
92 Datum values[Natts_pg_proc];
93 char replaces[Natts_pg_proc];
105 Assert(PointerIsValid(prosrc));
106 Assert(PointerIsValid(probin));
108 parameterCount = parameterTypes->dim1;
109 if (parameterCount < 0 || parameterCount > FUNC_MAX_ARGS)
111 (errcode(ERRCODE_TOO_MANY_ARGUMENTS),
112 errmsg("functions cannot have more than %d arguments",
114 /* note: the above is correct, we do NOT count output arguments */
116 if (allParameterTypes != PointerGetDatum(NULL))
119 * We expect the array to be a 1-D OID array; verify that. We don't
120 * need to use deconstruct_array() since the array data is just going
121 * to look like a C array of OID values.
123 ArrayType *allParamArray = (ArrayType *) DatumGetPointer(allParameterTypes);
125 allParamCount = ARR_DIMS(allParamArray)[0];
126 if (ARR_NDIM(allParamArray) != 1 ||
127 allParamCount <= 0 ||
128 ARR_HASNULL(allParamArray) ||
129 ARR_ELEMTYPE(allParamArray) != OIDOID)
130 elog(ERROR, "allParameterTypes is not a 1-D Oid array");
131 allParams = (Oid *) ARR_DATA_PTR(allParamArray);
132 Assert(allParamCount >= parameterCount);
133 /* we assume caller got the contents right */
137 allParamCount = parameterCount;
138 allParams = parameterTypes->values;
142 * Do not allow return type ANYARRAY or ANYELEMENT unless at least one
143 * input argument is ANYARRAY or ANYELEMENT. Also, do not allow return
144 * type INTERNAL unless at least one input argument is INTERNAL.
146 for (i = 0; i < parameterCount; i++)
148 switch (parameterTypes->values[i])
152 genericInParam = true;
155 internalInParam = true;
160 if (allParameterTypes != PointerGetDatum(NULL))
162 for (i = 0; i < allParamCount; i++)
165 * We don't bother to distinguish input and output params here, so
166 * if there is, say, just an input INTERNAL param then we will
167 * still set internalOutParam. This is OK since we don't really
170 switch (allParams[i])
174 genericOutParam = true;
177 internalOutParam = true;
183 if ((returnType == ANYARRAYOID || returnType == ANYELEMENTOID ||
184 genericOutParam) && !genericInParam)
186 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
187 errmsg("cannot determine result data type"),
188 errdetail("A function returning \"anyarray\" or \"anyelement\" must have at least one argument of either type.")));
190 if ((returnType == INTERNALOID || internalOutParam) && !internalInParam)
192 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
193 errmsg("unsafe use of pseudo-type \"internal\""),
194 errdetail("A function returning \"internal\" must have at least one \"internal\" argument.")));
197 * don't allow functions of complex types that have the same name as
198 * existing attributes of the type
200 if (parameterCount == 1 &&
201 OidIsValid(parameterTypes->values[0]) &&
202 (relid = typeidTypeRelid(parameterTypes->values[0])) != InvalidOid &&
203 get_attnum(relid, procedureName) != InvalidAttrNumber)
205 (errcode(ERRCODE_DUPLICATE_COLUMN),
206 errmsg("\"%s\" is already an attribute of type %s",
208 format_type_be(parameterTypes->values[0]))));
211 * All seems OK; prepare the data to be inserted into pg_proc.
214 for (i = 0; i < Natts_pg_proc; ++i)
217 values[i] = (Datum) 0;
221 namestrcpy(&procname, procedureName);
222 values[Anum_pg_proc_proname - 1] = NameGetDatum(&procname);
223 values[Anum_pg_proc_pronamespace - 1] = ObjectIdGetDatum(procNamespace);
224 values[Anum_pg_proc_proowner - 1] = ObjectIdGetDatum(GetUserId());
225 values[Anum_pg_proc_prolang - 1] = ObjectIdGetDatum(languageObjectId);
226 values[Anum_pg_proc_proisagg - 1] = BoolGetDatum(isAgg);
227 values[Anum_pg_proc_prosecdef - 1] = BoolGetDatum(security_definer);
228 values[Anum_pg_proc_proisstrict - 1] = BoolGetDatum(isStrict);
229 values[Anum_pg_proc_proretset - 1] = BoolGetDatum(returnsSet);
230 values[Anum_pg_proc_provolatile - 1] = CharGetDatum(volatility);
231 values[Anum_pg_proc_pronargs - 1] = UInt16GetDatum(parameterCount);
232 values[Anum_pg_proc_prorettype - 1] = ObjectIdGetDatum(returnType);
233 values[Anum_pg_proc_proargtypes - 1] = PointerGetDatum(parameterTypes);
234 if (allParameterTypes != PointerGetDatum(NULL))
235 values[Anum_pg_proc_proallargtypes - 1] = allParameterTypes;
237 nulls[Anum_pg_proc_proallargtypes - 1] = 'n';
238 if (parameterModes != PointerGetDatum(NULL))
239 values[Anum_pg_proc_proargmodes - 1] = parameterModes;
241 nulls[Anum_pg_proc_proargmodes - 1] = 'n';
242 if (parameterNames != PointerGetDatum(NULL))
243 values[Anum_pg_proc_proargnames - 1] = parameterNames;
245 nulls[Anum_pg_proc_proargnames - 1] = 'n';
246 values[Anum_pg_proc_prosrc - 1] = DirectFunctionCall1(textin,
247 CStringGetDatum(prosrc));
248 values[Anum_pg_proc_probin - 1] = DirectFunctionCall1(textin,
249 CStringGetDatum(probin));
250 /* start out with empty permissions */
251 nulls[Anum_pg_proc_proacl - 1] = 'n';
253 rel = heap_open(ProcedureRelationId, RowExclusiveLock);
254 tupDesc = RelationGetDescr(rel);
256 /* Check for pre-existing definition */
257 oldtup = SearchSysCache(PROCNAMEARGSNSP,
258 PointerGetDatum(procedureName),
259 PointerGetDatum(parameterTypes),
260 ObjectIdGetDatum(procNamespace),
263 if (HeapTupleIsValid(oldtup))
265 /* There is one; okay to replace it? */
266 Form_pg_proc oldproc = (Form_pg_proc) GETSTRUCT(oldtup);
270 (errcode(ERRCODE_DUPLICATE_FUNCTION),
271 errmsg("function \"%s\" already exists with same argument types",
273 if (!pg_proc_ownercheck(HeapTupleGetOid(oldtup), GetUserId()))
274 aclcheck_error(ACLCHECK_NOT_OWNER, ACL_KIND_PROC,
278 * Not okay to change the return type of the existing proc, since
279 * existing rules, views, etc may depend on the return type.
281 if (returnType != oldproc->prorettype ||
282 returnsSet != oldproc->proretset)
284 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
285 errmsg("cannot change return type of existing function"),
286 errhint("Use DROP FUNCTION first.")));
289 * If it returns RECORD, check for possible change of record type
290 * implied by OUT parameters
292 if (returnType == RECORDOID)
297 olddesc = build_function_result_tupdesc_t(oldtup);
298 newdesc = build_function_result_tupdesc_d(allParameterTypes,
301 if (olddesc == NULL && newdesc == NULL)
302 /* ok, both are runtime-defined RECORDs */ ;
303 else if (olddesc == NULL || newdesc == NULL ||
304 !equalTupleDescs(olddesc, newdesc))
306 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
307 errmsg("cannot change return type of existing function"),
308 errdetail("Row type defined by OUT parameters is different."),
309 errhint("Use DROP FUNCTION first.")));
312 /* Can't change aggregate status, either */
313 if (oldproc->proisagg != isAgg)
315 if (oldproc->proisagg)
317 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
318 errmsg("function \"%s\" is an aggregate",
322 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
323 errmsg("function \"%s\" is not an aggregate",
327 /* do not change existing ownership or permissions, either */
328 replaces[Anum_pg_proc_proowner - 1] = ' ';
329 replaces[Anum_pg_proc_proacl - 1] = ' ';
332 tup = heap_modifytuple(oldtup, tupDesc, values, nulls, replaces);
333 simple_heap_update(rel, &tup->t_self, tup);
335 ReleaseSysCache(oldtup);
340 /* Creating a new procedure */
341 tup = heap_formtuple(tupDesc, values, nulls);
342 simple_heap_insert(rel, tup);
346 /* Need to update indexes for either the insert or update case */
347 CatalogUpdateIndexes(rel, tup);
349 retval = HeapTupleGetOid(tup);
352 * Create dependencies for the new function. If we are updating an
353 * existing function, first delete any existing pg_depend entries.
357 deleteDependencyRecordsFor(ProcedureRelationId, retval);
358 deleteSharedDependencyRecordsFor(ProcedureRelationId, retval);
361 myself.classId = ProcedureRelationId;
362 myself.objectId = retval;
363 myself.objectSubId = 0;
365 /* dependency on namespace */
366 referenced.classId = NamespaceRelationId;
367 referenced.objectId = procNamespace;
368 referenced.objectSubId = 0;
369 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
371 /* dependency on implementation language */
372 referenced.classId = LanguageRelationId;
373 referenced.objectId = languageObjectId;
374 referenced.objectSubId = 0;
375 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
377 /* dependency on return type */
378 referenced.classId = TypeRelationId;
379 referenced.objectId = returnType;
380 referenced.objectSubId = 0;
381 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
383 /* dependency on parameter types */
384 for (i = 0; i < allParamCount; i++)
386 referenced.classId = TypeRelationId;
387 referenced.objectId = allParams[i];
388 referenced.objectSubId = 0;
389 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
392 /* dependency on owner */
393 recordDependencyOnOwner(ProcedureRelationId, retval, GetUserId());
397 heap_close(rel, RowExclusiveLock);
399 /* Verify function body */
400 if (OidIsValid(languageValidator))
402 /* Advance command counter so new tuple can be seen by validator */
403 CommandCounterIncrement();
404 OidFunctionCall1(languageValidator, ObjectIdGetDatum(retval));
413 * Validator for internal functions
415 * Check that the given internal function name (the "prosrc" value) is
416 * a known builtin function.
419 fmgr_internal_validator(PG_FUNCTION_ARGS)
421 Oid funcoid = PG_GETARG_OID(0);
429 * We do not honor check_function_bodies since it's unlikely the function
430 * name will be found later if it isn't there now.
433 tuple = SearchSysCache(PROCOID,
434 ObjectIdGetDatum(funcoid),
436 if (!HeapTupleIsValid(tuple))
437 elog(ERROR, "cache lookup failed for function %u", funcoid);
438 proc = (Form_pg_proc) GETSTRUCT(tuple);
440 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
442 elog(ERROR, "null prosrc");
443 prosrc = DatumGetCString(DirectFunctionCall1(textout, tmp));
445 if (fmgr_internal_function(prosrc) == InvalidOid)
447 (errcode(ERRCODE_UNDEFINED_FUNCTION),
448 errmsg("there is no built-in function named \"%s\"",
451 ReleaseSysCache(tuple);
459 * Validator for C language functions
461 * Make sure that the library file exists, is loadable, and contains
462 * the specified link symbol. Also check for a valid function
463 * information record.
466 fmgr_c_validator(PG_FUNCTION_ARGS)
468 Oid funcoid = PG_GETARG_OID(0);
478 * It'd be most consistent to skip the check if !check_function_bodies,
479 * but the purpose of that switch is to be helpful for pg_dump loading,
480 * and for pg_dump loading it's much better if we *do* check.
483 tuple = SearchSysCache(PROCOID,
484 ObjectIdGetDatum(funcoid),
486 if (!HeapTupleIsValid(tuple))
487 elog(ERROR, "cache lookup failed for function %u", funcoid);
488 proc = (Form_pg_proc) GETSTRUCT(tuple);
490 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
492 elog(ERROR, "null prosrc");
493 prosrc = DatumGetCString(DirectFunctionCall1(textout, tmp));
495 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_probin, &isnull);
497 elog(ERROR, "null probin");
498 probin = DatumGetCString(DirectFunctionCall1(textout, tmp));
500 (void) load_external_function(probin, prosrc, true, &libraryhandle);
501 (void) fetch_finfo_record(libraryhandle, prosrc);
503 ReleaseSysCache(tuple);
510 * Validator for SQL language functions
512 * Parse it here in order to be sure that it contains no syntax errors.
515 fmgr_sql_validator(PG_FUNCTION_ARGS)
517 Oid funcoid = PG_GETARG_OID(0);
520 List *querytree_list;
524 ErrorContextCallback sqlerrcontext;
528 tuple = SearchSysCache(PROCOID,
529 ObjectIdGetDatum(funcoid),
531 if (!HeapTupleIsValid(tuple))
532 elog(ERROR, "cache lookup failed for function %u", funcoid);
533 proc = (Form_pg_proc) GETSTRUCT(tuple);
535 /* Disallow pseudotype result */
536 /* except for RECORD, VOID, ANYARRAY, or ANYELEMENT */
537 if (get_typtype(proc->prorettype) == 'p' &&
538 proc->prorettype != RECORDOID &&
539 proc->prorettype != VOIDOID &&
540 proc->prorettype != ANYARRAYOID &&
541 proc->prorettype != ANYELEMENTOID)
543 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
544 errmsg("SQL functions cannot return type %s",
545 format_type_be(proc->prorettype))));
547 /* Disallow pseudotypes in arguments */
548 /* except for ANYARRAY or ANYELEMENT */
550 for (i = 0; i < proc->pronargs; i++)
552 if (get_typtype(proc->proargtypes.values[i]) == 'p')
554 if (proc->proargtypes.values[i] == ANYARRAYOID ||
555 proc->proargtypes.values[i] == ANYELEMENTOID)
559 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
560 errmsg("SQL functions cannot have arguments of type %s",
561 format_type_be(proc->proargtypes.values[i]))));
565 /* Postpone body checks if !check_function_bodies */
566 if (check_function_bodies)
568 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
570 elog(ERROR, "null prosrc");
572 prosrc = DatumGetCString(DirectFunctionCall1(textout, tmp));
575 * Setup error traceback support for ereport().
577 sqlerrcontext.callback = sql_function_parse_error_callback;
578 sqlerrcontext.arg = tuple;
579 sqlerrcontext.previous = error_context_stack;
580 error_context_stack = &sqlerrcontext;
583 * We can't do full prechecking of the function definition if there
584 * are any polymorphic input types, because actual datatypes of
585 * expression results will be unresolvable. The check will be done at
588 * We can run the text through the raw parser though; this will at
589 * least catch silly syntactic errors.
593 querytree_list = pg_parse_and_rewrite(prosrc,
594 proc->proargtypes.values,
596 (void) check_sql_fn_retval(funcoid, proc->prorettype,
597 querytree_list, NULL);
600 querytree_list = pg_parse_query(prosrc);
602 error_context_stack = sqlerrcontext.previous;
605 ReleaseSysCache(tuple);
611 * Error context callback for handling errors in SQL function definitions
614 sql_function_parse_error_callback(void *arg)
616 HeapTuple tuple = (HeapTuple) arg;
617 Form_pg_proc proc = (Form_pg_proc) GETSTRUCT(tuple);
622 /* See if it's a syntax error; if so, transpose to CREATE FUNCTION */
623 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
625 elog(ERROR, "null prosrc");
626 prosrc = DatumGetCString(DirectFunctionCall1(textout, tmp));
628 if (!function_parse_error_transpose(prosrc))
630 /* If it's not a syntax error, push info onto context stack */
631 errcontext("SQL function \"%s\"", NameStr(proc->proname));
638 * Adjust a syntax error occurring inside the function body of a CREATE
639 * FUNCTION command. This can be used by any function validator, not only
640 * for SQL-language functions. It is assumed that the syntax error position
641 * is initially relative to the function body string (as passed in). If
642 * possible, we adjust the position to reference the original CREATE command;
643 * if we can't manage that, we set up an "internal query" syntax error instead.
645 * Returns true if a syntax error was processed, false if not.
648 function_parse_error_transpose(const char *prosrc)
652 const char *queryText;
655 * Nothing to do unless we are dealing with a syntax error that has a
658 * Some PLs may prefer to report the error position as an internal error
659 * to begin with, so check that too.
661 origerrposition = geterrposition();
662 if (origerrposition <= 0)
664 origerrposition = getinternalerrposition();
665 if (origerrposition <= 0)
669 /* We can get the original query text from the active portal (hack...) */
670 Assert(ActivePortal && ActivePortal->status == PORTAL_ACTIVE);
671 queryText = ActivePortal->sourceText;
673 /* Try to locate the prosrc in the original text */
674 newerrposition = match_prosrc_to_query(prosrc, queryText, origerrposition);
676 if (newerrposition > 0)
678 /* Successful, so fix error position to reference original query */
679 errposition(newerrposition);
680 /* Get rid of any report of the error as an "internal query" */
681 internalerrposition(0);
682 internalerrquery(NULL);
687 * If unsuccessful, convert the position to an internal position
688 * marker and give the function text as the internal query.
691 internalerrposition(origerrposition);
692 internalerrquery(prosrc);
699 * Try to locate the string literal containing the function body in the
700 * given text of the CREATE FUNCTION command. If successful, return the
701 * character (not byte) index within the command corresponding to the
702 * given character index within the literal. If not successful, return 0.
705 match_prosrc_to_query(const char *prosrc, const char *queryText,
709 * Rather than fully parsing the CREATE FUNCTION command, we just scan the
710 * command looking for $prosrc$ or 'prosrc'. This could be fooled (though
711 * not in any very probable scenarios), so fail if we find more than one
714 int prosrclen = strlen(prosrc);
715 int querylen = strlen(queryText);
720 for (curpos = 0; curpos < querylen - prosrclen; curpos++)
722 if (queryText[curpos] == '$' &&
723 strncmp(prosrc, &queryText[curpos + 1], prosrclen) == 0 &&
724 queryText[curpos + 1 + prosrclen] == '$')
727 * Found a $foo$ match. Since there are no embedded quoting
728 * characters in a dollar-quoted literal, we don't have to do any
729 * fancy arithmetic; just offset by the starting position.
732 return 0; /* multiple matches, fail */
733 matchpos = pg_mbstrlen_with_len(queryText, curpos + 1)
736 else if (queryText[curpos] == '\'' &&
737 match_prosrc_to_literal(prosrc, &queryText[curpos + 1],
738 cursorpos, &newcursorpos))
741 * Found a 'foo' match. match_prosrc_to_literal() has adjusted
742 * for any quotes or backslashes embedded in the literal.
745 return 0; /* multiple matches, fail */
746 matchpos = pg_mbstrlen_with_len(queryText, curpos + 1)
755 * Try to match the given source text to a single-quoted literal.
756 * If successful, adjust newcursorpos to correspond to the character
757 * (not byte) index corresponding to cursorpos in the source text.
759 * At entry, literal points just past a ' character. We must check for the
763 match_prosrc_to_literal(const char *prosrc, const char *literal,
764 int cursorpos, int *newcursorpos)
766 int newcp = cursorpos;
770 * This implementation handles backslashes and doubled quotes in the
771 * string literal. It does not handle the SQL syntax for literals
772 * continued across line boundaries.
774 * We do the comparison a character at a time, not a byte at a time, so
775 * that we can do the correct cursorpos math.
779 cursorpos--; /* characters left before cursor */
782 * Check for backslashes and doubled quotes in the literal; adjust
783 * newcp when one is found before the cursor.
785 if (*literal == '\\')
791 else if (*literal == '\'')
793 if (literal[1] != '\'')
799 chlen = pg_mblen(prosrc);
800 if (strncmp(prosrc, literal, chlen) != 0)
806 if (*literal == '\'' && literal[1] != '\'')
809 *newcursorpos = newcp;
814 /* Must set *newcursorpos to suppress compiler warning */
815 *newcursorpos = newcp;