1 /*-------------------------------------------------------------------------
4 * routines to support manipulation of the pg_proc relation
6 * Portions Copyright (c) 1996-2008, 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.148 2008/01/01 19:45:48 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"
38 Datum fmgr_internal_validator(PG_FUNCTION_ARGS);
39 Datum fmgr_c_validator(PG_FUNCTION_ARGS);
40 Datum fmgr_sql_validator(PG_FUNCTION_ARGS);
42 static void sql_function_parse_error_callback(void *arg);
43 static int match_prosrc_to_query(const char *prosrc, const char *queryText,
45 static bool match_prosrc_to_literal(const char *prosrc, const char *literal,
46 int cursorpos, int *newcursorpos);
49 /* ----------------------------------------------------------------
52 * Note: allParameterTypes, parameterModes, parameterNames, and proconfig
53 * are either arrays of the proper types or NULL. We declare them Datum,
54 * not "ArrayType *", to avoid importing array.h into pg_proc.h.
55 * ----------------------------------------------------------------
58 ProcedureCreate(const char *procedureName,
64 Oid languageValidator,
68 bool security_definer,
71 oidvector *parameterTypes,
72 Datum allParameterTypes,
83 bool genericInParam = false;
84 bool genericOutParam = false;
85 bool internalInParam = false;
86 bool internalOutParam = false;
90 char nulls[Natts_pg_proc];
91 Datum values[Natts_pg_proc];
92 char replaces[Natts_pg_proc];
104 Assert(PointerIsValid(prosrc));
105 Assert(PointerIsValid(probin));
107 parameterCount = parameterTypes->dim1;
108 if (parameterCount < 0 || parameterCount > FUNC_MAX_ARGS)
110 (errcode(ERRCODE_TOO_MANY_ARGUMENTS),
111 errmsg("functions cannot have more than %d arguments",
113 /* note: the above is correct, we do NOT count output arguments */
115 if (allParameterTypes != PointerGetDatum(NULL))
118 * We expect the array to be a 1-D OID array; verify that. We don't
119 * need to use deconstruct_array() since the array data is just going
120 * to look like a C array of OID values.
122 ArrayType *allParamArray = (ArrayType *) DatumGetPointer(allParameterTypes);
124 allParamCount = ARR_DIMS(allParamArray)[0];
125 if (ARR_NDIM(allParamArray) != 1 ||
126 allParamCount <= 0 ||
127 ARR_HASNULL(allParamArray) ||
128 ARR_ELEMTYPE(allParamArray) != OIDOID)
129 elog(ERROR, "allParameterTypes is not a 1-D Oid array");
130 allParams = (Oid *) ARR_DATA_PTR(allParamArray);
131 Assert(allParamCount >= parameterCount);
132 /* we assume caller got the contents right */
136 allParamCount = parameterCount;
137 allParams = parameterTypes->values;
141 * Do not allow polymorphic return type unless at least one input argument
142 * is polymorphic. Also, do not allow return type INTERNAL unless at
143 * least one input argument is INTERNAL.
145 for (i = 0; i < parameterCount; i++)
147 switch (parameterTypes->values[i])
153 genericInParam = true;
156 internalInParam = true;
161 if (allParameterTypes != PointerGetDatum(NULL))
163 for (i = 0; i < allParamCount; i++)
166 * We don't bother to distinguish input and output params here, so
167 * if there is, say, just an input INTERNAL param then we will
168 * still set internalOutParam. This is OK since we don't really
171 switch (allParams[i])
177 genericOutParam = true;
180 internalOutParam = true;
186 if ((IsPolymorphicType(returnType) || genericOutParam)
189 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
190 errmsg("cannot determine result data type"),
191 errdetail("A function returning a polymorphic type must have at least one polymorphic argument.")));
193 if ((returnType == INTERNALOID || internalOutParam) && !internalInParam)
195 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
196 errmsg("unsafe use of pseudo-type \"internal\""),
197 errdetail("A function returning \"internal\" must have at least one \"internal\" argument.")));
200 * don't allow functions of complex types that have the same name as
201 * existing attributes of the type
203 if (parameterCount == 1 &&
204 OidIsValid(parameterTypes->values[0]) &&
205 (relid = typeidTypeRelid(parameterTypes->values[0])) != InvalidOid &&
206 get_attnum(relid, procedureName) != InvalidAttrNumber)
208 (errcode(ERRCODE_DUPLICATE_COLUMN),
209 errmsg("\"%s\" is already an attribute of type %s",
211 format_type_be(parameterTypes->values[0]))));
214 * All seems OK; prepare the data to be inserted into pg_proc.
217 for (i = 0; i < Natts_pg_proc; ++i)
220 values[i] = (Datum) 0;
224 namestrcpy(&procname, procedureName);
225 values[Anum_pg_proc_proname - 1] = NameGetDatum(&procname);
226 values[Anum_pg_proc_pronamespace - 1] = ObjectIdGetDatum(procNamespace);
227 values[Anum_pg_proc_proowner - 1] = ObjectIdGetDatum(GetUserId());
228 values[Anum_pg_proc_prolang - 1] = ObjectIdGetDatum(languageObjectId);
229 values[Anum_pg_proc_procost - 1] = Float4GetDatum(procost);
230 values[Anum_pg_proc_prorows - 1] = Float4GetDatum(prorows);
231 values[Anum_pg_proc_proisagg - 1] = BoolGetDatum(isAgg);
232 values[Anum_pg_proc_prosecdef - 1] = BoolGetDatum(security_definer);
233 values[Anum_pg_proc_proisstrict - 1] = BoolGetDatum(isStrict);
234 values[Anum_pg_proc_proretset - 1] = BoolGetDatum(returnsSet);
235 values[Anum_pg_proc_provolatile - 1] = CharGetDatum(volatility);
236 values[Anum_pg_proc_pronargs - 1] = UInt16GetDatum(parameterCount);
237 values[Anum_pg_proc_prorettype - 1] = ObjectIdGetDatum(returnType);
238 values[Anum_pg_proc_proargtypes - 1] = PointerGetDatum(parameterTypes);
239 if (allParameterTypes != PointerGetDatum(NULL))
240 values[Anum_pg_proc_proallargtypes - 1] = allParameterTypes;
242 nulls[Anum_pg_proc_proallargtypes - 1] = 'n';
243 if (parameterModes != PointerGetDatum(NULL))
244 values[Anum_pg_proc_proargmodes - 1] = parameterModes;
246 nulls[Anum_pg_proc_proargmodes - 1] = 'n';
247 if (parameterNames != PointerGetDatum(NULL))
248 values[Anum_pg_proc_proargnames - 1] = parameterNames;
250 nulls[Anum_pg_proc_proargnames - 1] = 'n';
251 values[Anum_pg_proc_prosrc - 1] = DirectFunctionCall1(textin,
252 CStringGetDatum(prosrc));
253 values[Anum_pg_proc_probin - 1] = DirectFunctionCall1(textin,
254 CStringGetDatum(probin));
255 if (proconfig != PointerGetDatum(NULL))
256 values[Anum_pg_proc_proconfig - 1] = proconfig;
258 nulls[Anum_pg_proc_proconfig - 1] = 'n';
259 /* start out with empty permissions */
260 nulls[Anum_pg_proc_proacl - 1] = 'n';
262 rel = heap_open(ProcedureRelationId, RowExclusiveLock);
263 tupDesc = RelationGetDescr(rel);
265 /* Check for pre-existing definition */
266 oldtup = SearchSysCache(PROCNAMEARGSNSP,
267 PointerGetDatum(procedureName),
268 PointerGetDatum(parameterTypes),
269 ObjectIdGetDatum(procNamespace),
272 if (HeapTupleIsValid(oldtup))
274 /* There is one; okay to replace it? */
275 Form_pg_proc oldproc = (Form_pg_proc) GETSTRUCT(oldtup);
279 (errcode(ERRCODE_DUPLICATE_FUNCTION),
280 errmsg("function \"%s\" already exists with same argument types",
282 if (!pg_proc_ownercheck(HeapTupleGetOid(oldtup), GetUserId()))
283 aclcheck_error(ACLCHECK_NOT_OWNER, ACL_KIND_PROC,
287 * Not okay to change the return type of the existing proc, since
288 * existing rules, views, etc may depend on the return type.
290 if (returnType != oldproc->prorettype ||
291 returnsSet != oldproc->proretset)
293 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
294 errmsg("cannot change return type of existing function"),
295 errhint("Use DROP FUNCTION first.")));
298 * If it returns RECORD, check for possible change of record type
299 * implied by OUT parameters
301 if (returnType == RECORDOID)
306 olddesc = build_function_result_tupdesc_t(oldtup);
307 newdesc = build_function_result_tupdesc_d(allParameterTypes,
310 if (olddesc == NULL && newdesc == NULL)
311 /* ok, both are runtime-defined RECORDs */ ;
312 else if (olddesc == NULL || newdesc == NULL ||
313 !equalTupleDescs(olddesc, newdesc))
315 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
316 errmsg("cannot change return type of existing function"),
317 errdetail("Row type defined by OUT parameters is different."),
318 errhint("Use DROP FUNCTION first.")));
321 /* Can't change aggregate status, either */
322 if (oldproc->proisagg != isAgg)
324 if (oldproc->proisagg)
326 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
327 errmsg("function \"%s\" is an aggregate",
331 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
332 errmsg("function \"%s\" is not an aggregate",
336 /* do not change existing ownership or permissions, either */
337 replaces[Anum_pg_proc_proowner - 1] = ' ';
338 replaces[Anum_pg_proc_proacl - 1] = ' ';
341 tup = heap_modifytuple(oldtup, tupDesc, values, nulls, replaces);
342 simple_heap_update(rel, &tup->t_self, tup);
344 ReleaseSysCache(oldtup);
349 /* Creating a new procedure */
350 tup = heap_formtuple(tupDesc, values, nulls);
351 simple_heap_insert(rel, tup);
355 /* Need to update indexes for either the insert or update case */
356 CatalogUpdateIndexes(rel, tup);
358 retval = HeapTupleGetOid(tup);
361 * Create dependencies for the new function. If we are updating an
362 * existing function, first delete any existing pg_depend entries.
366 deleteDependencyRecordsFor(ProcedureRelationId, retval);
367 deleteSharedDependencyRecordsFor(ProcedureRelationId, retval);
370 myself.classId = ProcedureRelationId;
371 myself.objectId = retval;
372 myself.objectSubId = 0;
374 /* dependency on namespace */
375 referenced.classId = NamespaceRelationId;
376 referenced.objectId = procNamespace;
377 referenced.objectSubId = 0;
378 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
380 /* dependency on implementation language */
381 referenced.classId = LanguageRelationId;
382 referenced.objectId = languageObjectId;
383 referenced.objectSubId = 0;
384 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
386 /* dependency on return type */
387 referenced.classId = TypeRelationId;
388 referenced.objectId = returnType;
389 referenced.objectSubId = 0;
390 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
392 /* dependency on parameter types */
393 for (i = 0; i < allParamCount; i++)
395 referenced.classId = TypeRelationId;
396 referenced.objectId = allParams[i];
397 referenced.objectSubId = 0;
398 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
401 /* dependency on owner */
402 recordDependencyOnOwner(ProcedureRelationId, retval, GetUserId());
406 heap_close(rel, RowExclusiveLock);
408 /* Verify function body */
409 if (OidIsValid(languageValidator))
411 /* Advance command counter so new tuple can be seen by validator */
412 CommandCounterIncrement();
413 OidFunctionCall1(languageValidator, ObjectIdGetDatum(retval));
422 * Validator for internal functions
424 * Check that the given internal function name (the "prosrc" value) is
425 * a known builtin function.
428 fmgr_internal_validator(PG_FUNCTION_ARGS)
430 Oid funcoid = PG_GETARG_OID(0);
438 * We do not honor check_function_bodies since it's unlikely the function
439 * name will be found later if it isn't there now.
442 tuple = SearchSysCache(PROCOID,
443 ObjectIdGetDatum(funcoid),
445 if (!HeapTupleIsValid(tuple))
446 elog(ERROR, "cache lookup failed for function %u", funcoid);
447 proc = (Form_pg_proc) GETSTRUCT(tuple);
449 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
451 elog(ERROR, "null prosrc");
452 prosrc = DatumGetCString(DirectFunctionCall1(textout, tmp));
454 if (fmgr_internal_function(prosrc) == InvalidOid)
456 (errcode(ERRCODE_UNDEFINED_FUNCTION),
457 errmsg("there is no built-in function named \"%s\"",
460 ReleaseSysCache(tuple);
468 * Validator for C language functions
470 * Make sure that the library file exists, is loadable, and contains
471 * the specified link symbol. Also check for a valid function
472 * information record.
475 fmgr_c_validator(PG_FUNCTION_ARGS)
477 Oid funcoid = PG_GETARG_OID(0);
487 * It'd be most consistent to skip the check if !check_function_bodies,
488 * but the purpose of that switch is to be helpful for pg_dump loading,
489 * and for pg_dump loading it's much better if we *do* check.
492 tuple = SearchSysCache(PROCOID,
493 ObjectIdGetDatum(funcoid),
495 if (!HeapTupleIsValid(tuple))
496 elog(ERROR, "cache lookup failed for function %u", funcoid);
497 proc = (Form_pg_proc) GETSTRUCT(tuple);
499 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
501 elog(ERROR, "null prosrc");
502 prosrc = DatumGetCString(DirectFunctionCall1(textout, tmp));
504 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_probin, &isnull);
506 elog(ERROR, "null probin");
507 probin = DatumGetCString(DirectFunctionCall1(textout, tmp));
509 (void) load_external_function(probin, prosrc, true, &libraryhandle);
510 (void) fetch_finfo_record(libraryhandle, prosrc);
512 ReleaseSysCache(tuple);
519 * Validator for SQL language functions
521 * Parse it here in order to be sure that it contains no syntax errors.
524 fmgr_sql_validator(PG_FUNCTION_ARGS)
526 Oid funcoid = PG_GETARG_OID(0);
529 List *querytree_list;
533 ErrorContextCallback sqlerrcontext;
537 tuple = SearchSysCache(PROCOID,
538 ObjectIdGetDatum(funcoid),
540 if (!HeapTupleIsValid(tuple))
541 elog(ERROR, "cache lookup failed for function %u", funcoid);
542 proc = (Form_pg_proc) GETSTRUCT(tuple);
544 /* Disallow pseudotype result */
545 /* except for RECORD, VOID, or polymorphic */
546 if (get_typtype(proc->prorettype) == TYPTYPE_PSEUDO &&
547 proc->prorettype != RECORDOID &&
548 proc->prorettype != VOIDOID &&
549 !IsPolymorphicType(proc->prorettype))
551 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
552 errmsg("SQL functions cannot return type %s",
553 format_type_be(proc->prorettype))));
555 /* Disallow pseudotypes in arguments */
556 /* except for polymorphic */
558 for (i = 0; i < proc->pronargs; i++)
560 if (get_typtype(proc->proargtypes.values[i]) == TYPTYPE_PSEUDO)
562 if (IsPolymorphicType(proc->proargtypes.values[i]))
566 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
567 errmsg("SQL functions cannot have arguments of type %s",
568 format_type_be(proc->proargtypes.values[i]))));
572 /* Postpone body checks if !check_function_bodies */
573 if (check_function_bodies)
575 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
577 elog(ERROR, "null prosrc");
579 prosrc = DatumGetCString(DirectFunctionCall1(textout, tmp));
582 * Setup error traceback support for ereport().
584 sqlerrcontext.callback = sql_function_parse_error_callback;
585 sqlerrcontext.arg = tuple;
586 sqlerrcontext.previous = error_context_stack;
587 error_context_stack = &sqlerrcontext;
590 * We can't do full prechecking of the function definition if there
591 * are any polymorphic input types, because actual datatypes of
592 * expression results will be unresolvable. The check will be done at
595 * We can run the text through the raw parser though; this will at
596 * least catch silly syntactic errors.
600 querytree_list = pg_parse_and_rewrite(prosrc,
601 proc->proargtypes.values,
603 (void) check_sql_fn_retval(funcoid, proc->prorettype,
604 querytree_list, NULL);
607 querytree_list = pg_parse_query(prosrc);
609 error_context_stack = sqlerrcontext.previous;
612 ReleaseSysCache(tuple);
618 * Error context callback for handling errors in SQL function definitions
621 sql_function_parse_error_callback(void *arg)
623 HeapTuple tuple = (HeapTuple) arg;
624 Form_pg_proc proc = (Form_pg_proc) GETSTRUCT(tuple);
629 /* See if it's a syntax error; if so, transpose to CREATE FUNCTION */
630 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
632 elog(ERROR, "null prosrc");
633 prosrc = DatumGetCString(DirectFunctionCall1(textout, tmp));
635 if (!function_parse_error_transpose(prosrc))
637 /* If it's not a syntax error, push info onto context stack */
638 errcontext("SQL function \"%s\"", NameStr(proc->proname));
645 * Adjust a syntax error occurring inside the function body of a CREATE
646 * FUNCTION command. This can be used by any function validator, not only
647 * for SQL-language functions. It is assumed that the syntax error position
648 * is initially relative to the function body string (as passed in). If
649 * possible, we adjust the position to reference the original CREATE command;
650 * if we can't manage that, we set up an "internal query" syntax error instead.
652 * Returns true if a syntax error was processed, false if not.
655 function_parse_error_transpose(const char *prosrc)
659 const char *queryText;
662 * Nothing to do unless we are dealing with a syntax error that has a
665 * Some PLs may prefer to report the error position as an internal error
666 * to begin with, so check that too.
668 origerrposition = geterrposition();
669 if (origerrposition <= 0)
671 origerrposition = getinternalerrposition();
672 if (origerrposition <= 0)
676 /* We can get the original query text from the active portal (hack...) */
677 Assert(ActivePortal && ActivePortal->status == PORTAL_ACTIVE);
678 queryText = ActivePortal->sourceText;
680 /* Try to locate the prosrc in the original text */
681 newerrposition = match_prosrc_to_query(prosrc, queryText, origerrposition);
683 if (newerrposition > 0)
685 /* Successful, so fix error position to reference original query */
686 errposition(newerrposition);
687 /* Get rid of any report of the error as an "internal query" */
688 internalerrposition(0);
689 internalerrquery(NULL);
694 * If unsuccessful, convert the position to an internal position
695 * marker and give the function text as the internal query.
698 internalerrposition(origerrposition);
699 internalerrquery(prosrc);
706 * Try to locate the string literal containing the function body in the
707 * given text of the CREATE FUNCTION command. If successful, return the
708 * character (not byte) index within the command corresponding to the
709 * given character index within the literal. If not successful, return 0.
712 match_prosrc_to_query(const char *prosrc, const char *queryText,
716 * Rather than fully parsing the CREATE FUNCTION command, we just scan the
717 * command looking for $prosrc$ or 'prosrc'. This could be fooled (though
718 * not in any very probable scenarios), so fail if we find more than one
721 int prosrclen = strlen(prosrc);
722 int querylen = strlen(queryText);
727 for (curpos = 0; curpos < querylen - prosrclen; curpos++)
729 if (queryText[curpos] == '$' &&
730 strncmp(prosrc, &queryText[curpos + 1], prosrclen) == 0 &&
731 queryText[curpos + 1 + prosrclen] == '$')
734 * Found a $foo$ match. Since there are no embedded quoting
735 * characters in a dollar-quoted literal, we don't have to do any
736 * fancy arithmetic; just offset by the starting position.
739 return 0; /* multiple matches, fail */
740 matchpos = pg_mbstrlen_with_len(queryText, curpos + 1)
743 else if (queryText[curpos] == '\'' &&
744 match_prosrc_to_literal(prosrc, &queryText[curpos + 1],
745 cursorpos, &newcursorpos))
748 * Found a 'foo' match. match_prosrc_to_literal() has adjusted
749 * for any quotes or backslashes embedded in the literal.
752 return 0; /* multiple matches, fail */
753 matchpos = pg_mbstrlen_with_len(queryText, curpos + 1)
762 * Try to match the given source text to a single-quoted literal.
763 * If successful, adjust newcursorpos to correspond to the character
764 * (not byte) index corresponding to cursorpos in the source text.
766 * At entry, literal points just past a ' character. We must check for the
770 match_prosrc_to_literal(const char *prosrc, const char *literal,
771 int cursorpos, int *newcursorpos)
773 int newcp = cursorpos;
777 * This implementation handles backslashes and doubled quotes in the
778 * string literal. It does not handle the SQL syntax for literals
779 * continued across line boundaries.
781 * We do the comparison a character at a time, not a byte at a time, so
782 * that we can do the correct cursorpos math.
786 cursorpos--; /* characters left before cursor */
789 * Check for backslashes and doubled quotes in the literal; adjust
790 * newcp when one is found before the cursor.
792 if (*literal == '\\')
798 else if (*literal == '\'')
800 if (literal[1] != '\'')
806 chlen = pg_mblen(prosrc);
807 if (strncmp(prosrc, literal, chlen) != 0)
813 if (*literal == '\'' && literal[1] != '\'')
816 *newcursorpos = newcp;
821 /* Must set *newcursorpos to suppress compiler warning */
822 *newcursorpos = newcp;