1 /*-------------------------------------------------------------------------
4 * routines to support manipulation of the pg_proc relation
6 * Portions Copyright (c) 1996-2011, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * src/backend/catalog/pg_proc.c
13 *-------------------------------------------------------------------------
17 #include "access/heapam.h"
18 #include "access/xact.h"
19 #include "catalog/dependency.h"
20 #include "catalog/indexing.h"
21 #include "catalog/objectaccess.h"
22 #include "catalog/pg_language.h"
23 #include "catalog/pg_namespace.h"
24 #include "catalog/pg_proc.h"
25 #include "catalog/pg_proc_fn.h"
26 #include "catalog/pg_type.h"
27 #include "executor/functions.h"
29 #include "mb/pg_wchar.h"
30 #include "miscadmin.h"
31 #include "nodes/nodeFuncs.h"
32 #include "parser/parse_type.h"
33 #include "tcop/pquery.h"
34 #include "tcop/tcopprot.h"
35 #include "utils/acl.h"
36 #include "utils/builtins.h"
37 #include "utils/lsyscache.h"
38 #include "utils/syscache.h"
41 Datum fmgr_internal_validator(PG_FUNCTION_ARGS);
42 Datum fmgr_c_validator(PG_FUNCTION_ARGS);
43 Datum fmgr_sql_validator(PG_FUNCTION_ARGS);
49 } parse_error_callback_arg;
51 static void sql_function_parse_error_callback(void *arg);
52 static int match_prosrc_to_query(const char *prosrc, const char *queryText,
54 static bool match_prosrc_to_literal(const char *prosrc, const char *literal,
55 int cursorpos, int *newcursorpos);
58 /* ----------------------------------------------------------------
61 * Note: allParameterTypes, parameterModes, parameterNames, and proconfig
62 * are either arrays of the proper types or NULL. We declare them Datum,
63 * not "ArrayType *", to avoid importing array.h into pg_proc_fn.h.
64 * ----------------------------------------------------------------
67 ProcedureCreate(const char *procedureName,
73 Oid languageValidator,
78 bool security_definer,
81 oidvector *parameterTypes,
82 Datum allParameterTypes,
85 List *parameterDefaults,
94 bool genericInParam = false;
95 bool genericOutParam = false;
96 bool internalInParam = false;
97 bool internalOutParam = false;
98 Oid variadicType = InvalidOid;
99 Oid proowner = GetUserId();
104 bool nulls[Natts_pg_proc];
105 Datum values[Natts_pg_proc];
106 bool replaces[Natts_pg_proc];
111 ObjectAddress myself,
118 Assert(PointerIsValid(prosrc));
120 parameterCount = parameterTypes->dim1;
121 if (parameterCount < 0 || parameterCount > FUNC_MAX_ARGS)
123 (errcode(ERRCODE_TOO_MANY_ARGUMENTS),
124 errmsg_plural("functions cannot have more than %d argument",
125 "functions cannot have more than %d arguments",
128 /* note: the above is correct, we do NOT count output arguments */
130 if (allParameterTypes != PointerGetDatum(NULL))
133 * We expect the array to be a 1-D OID array; verify that. We don't
134 * need to use deconstruct_array() since the array data is just going
135 * to look like a C array of OID values.
137 ArrayType *allParamArray = (ArrayType *) DatumGetPointer(allParameterTypes);
139 allParamCount = ARR_DIMS(allParamArray)[0];
140 if (ARR_NDIM(allParamArray) != 1 ||
141 allParamCount <= 0 ||
142 ARR_HASNULL(allParamArray) ||
143 ARR_ELEMTYPE(allParamArray) != OIDOID)
144 elog(ERROR, "allParameterTypes is not a 1-D Oid array");
145 allParams = (Oid *) ARR_DATA_PTR(allParamArray);
146 Assert(allParamCount >= parameterCount);
147 /* we assume caller got the contents right */
151 allParamCount = parameterCount;
152 allParams = parameterTypes->values;
156 * Do not allow polymorphic return type unless at least one input argument
157 * is polymorphic. Also, do not allow return type INTERNAL unless at
158 * least one input argument is INTERNAL.
160 for (i = 0; i < parameterCount; i++)
162 switch (parameterTypes->values[i])
168 genericInParam = true;
171 internalInParam = true;
176 if (allParameterTypes != PointerGetDatum(NULL))
178 for (i = 0; i < allParamCount; i++)
181 * We don't bother to distinguish input and output params here, so
182 * if there is, say, just an input INTERNAL param then we will
183 * still set internalOutParam. This is OK since we don't really
186 switch (allParams[i])
192 genericOutParam = true;
195 internalOutParam = true;
201 if ((IsPolymorphicType(returnType) || genericOutParam)
204 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
205 errmsg("cannot determine result data type"),
206 errdetail("A function returning a polymorphic type must have at least one polymorphic argument.")));
208 if ((returnType == INTERNALOID || internalOutParam) && !internalInParam)
210 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
211 errmsg("unsafe use of pseudo-type \"internal\""),
212 errdetail("A function returning \"internal\" must have at least one \"internal\" argument.")));
215 * don't allow functions of complex types that have the same name as
216 * existing attributes of the type
218 if (parameterCount == 1 &&
219 OidIsValid(parameterTypes->values[0]) &&
220 (relid = typeidTypeRelid(parameterTypes->values[0])) != InvalidOid &&
221 get_attnum(relid, procedureName) != InvalidAttrNumber)
223 (errcode(ERRCODE_DUPLICATE_COLUMN),
224 errmsg("\"%s\" is already an attribute of type %s",
226 format_type_be(parameterTypes->values[0]))));
228 if (parameterModes != PointerGetDatum(NULL))
231 * We expect the array to be a 1-D CHAR array; verify that. We don't
232 * need to use deconstruct_array() since the array data is just going
233 * to look like a C array of char values.
235 ArrayType *modesArray = (ArrayType *) DatumGetPointer(parameterModes);
238 if (ARR_NDIM(modesArray) != 1 ||
239 ARR_DIMS(modesArray)[0] != allParamCount ||
240 ARR_HASNULL(modesArray) ||
241 ARR_ELEMTYPE(modesArray) != CHAROID)
242 elog(ERROR, "parameterModes is not a 1-D char array");
243 modes = (char *) ARR_DATA_PTR(modesArray);
246 * Only the last input parameter can be variadic; if it is, save its
247 * element type. Errors here are just elog since caller should have
248 * checked this already.
250 for (i = 0; i < allParamCount; i++)
255 case PROARGMODE_INOUT:
256 if (OidIsValid(variadicType))
257 elog(ERROR, "variadic parameter must be last");
260 case PROARGMODE_TABLE:
263 case PROARGMODE_VARIADIC:
264 if (OidIsValid(variadicType))
265 elog(ERROR, "variadic parameter must be last");
266 switch (allParams[i])
269 variadicType = ANYOID;
272 variadicType = ANYELEMENTOID;
275 variadicType = get_element_type(allParams[i]);
276 if (!OidIsValid(variadicType))
277 elog(ERROR, "variadic parameter is not an array");
282 elog(ERROR, "invalid parameter mode '%c'", modes[i]);
289 * All seems OK; prepare the data to be inserted into pg_proc.
292 for (i = 0; i < Natts_pg_proc; ++i)
295 values[i] = (Datum) 0;
299 namestrcpy(&procname, procedureName);
300 values[Anum_pg_proc_proname - 1] = NameGetDatum(&procname);
301 values[Anum_pg_proc_pronamespace - 1] = ObjectIdGetDatum(procNamespace);
302 values[Anum_pg_proc_proowner - 1] = ObjectIdGetDatum(proowner);
303 values[Anum_pg_proc_prolang - 1] = ObjectIdGetDatum(languageObjectId);
304 values[Anum_pg_proc_procost - 1] = Float4GetDatum(procost);
305 values[Anum_pg_proc_prorows - 1] = Float4GetDatum(prorows);
306 values[Anum_pg_proc_provariadic - 1] = ObjectIdGetDatum(variadicType);
307 values[Anum_pg_proc_proisagg - 1] = BoolGetDatum(isAgg);
308 values[Anum_pg_proc_proiswindow - 1] = BoolGetDatum(isWindowFunc);
309 values[Anum_pg_proc_prosecdef - 1] = BoolGetDatum(security_definer);
310 values[Anum_pg_proc_proisstrict - 1] = BoolGetDatum(isStrict);
311 values[Anum_pg_proc_proretset - 1] = BoolGetDatum(returnsSet);
312 values[Anum_pg_proc_provolatile - 1] = CharGetDatum(volatility);
313 values[Anum_pg_proc_pronargs - 1] = UInt16GetDatum(parameterCount);
314 values[Anum_pg_proc_pronargdefaults - 1] = UInt16GetDatum(list_length(parameterDefaults));
315 values[Anum_pg_proc_prorettype - 1] = ObjectIdGetDatum(returnType);
316 values[Anum_pg_proc_proargtypes - 1] = PointerGetDatum(parameterTypes);
317 if (allParameterTypes != PointerGetDatum(NULL))
318 values[Anum_pg_proc_proallargtypes - 1] = allParameterTypes;
320 nulls[Anum_pg_proc_proallargtypes - 1] = true;
321 if (parameterModes != PointerGetDatum(NULL))
322 values[Anum_pg_proc_proargmodes - 1] = parameterModes;
324 nulls[Anum_pg_proc_proargmodes - 1] = true;
325 if (parameterNames != PointerGetDatum(NULL))
326 values[Anum_pg_proc_proargnames - 1] = parameterNames;
328 nulls[Anum_pg_proc_proargnames - 1] = true;
329 if (parameterDefaults != NIL)
330 values[Anum_pg_proc_proargdefaults - 1] = CStringGetTextDatum(nodeToString(parameterDefaults));
332 nulls[Anum_pg_proc_proargdefaults - 1] = true;
333 values[Anum_pg_proc_prosrc - 1] = CStringGetTextDatum(prosrc);
335 values[Anum_pg_proc_probin - 1] = CStringGetTextDatum(probin);
337 nulls[Anum_pg_proc_probin - 1] = true;
338 if (proconfig != PointerGetDatum(NULL))
339 values[Anum_pg_proc_proconfig - 1] = proconfig;
341 nulls[Anum_pg_proc_proconfig - 1] = true;
342 /* proacl will be determined later */
344 rel = heap_open(ProcedureRelationId, RowExclusiveLock);
345 tupDesc = RelationGetDescr(rel);
347 /* Check for pre-existing definition */
348 oldtup = SearchSysCache3(PROCNAMEARGSNSP,
349 PointerGetDatum(procedureName),
350 PointerGetDatum(parameterTypes),
351 ObjectIdGetDatum(procNamespace));
353 if (HeapTupleIsValid(oldtup))
355 /* There is one; okay to replace it? */
356 Form_pg_proc oldproc = (Form_pg_proc) GETSTRUCT(oldtup);
362 (errcode(ERRCODE_DUPLICATE_FUNCTION),
363 errmsg("function \"%s\" already exists with same argument types",
365 if (!pg_proc_ownercheck(HeapTupleGetOid(oldtup), proowner))
366 aclcheck_error(ACLCHECK_NOT_OWNER, ACL_KIND_PROC,
370 * Not okay to change the return type of the existing proc, since
371 * existing rules, views, etc may depend on the return type.
373 if (returnType != oldproc->prorettype ||
374 returnsSet != oldproc->proretset)
376 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
377 errmsg("cannot change return type of existing function"),
378 errhint("Use DROP FUNCTION first.")));
381 * If it returns RECORD, check for possible change of record type
382 * implied by OUT parameters
384 if (returnType == RECORDOID)
389 olddesc = build_function_result_tupdesc_t(oldtup);
390 newdesc = build_function_result_tupdesc_d(allParameterTypes,
393 if (olddesc == NULL && newdesc == NULL)
394 /* ok, both are runtime-defined RECORDs */ ;
395 else if (olddesc == NULL || newdesc == NULL ||
396 !equalTupleDescs(olddesc, newdesc))
398 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
399 errmsg("cannot change return type of existing function"),
400 errdetail("Row type defined by OUT parameters is different."),
401 errhint("Use DROP FUNCTION first.")));
405 * If there were any named input parameters, check to make sure the
406 * names have not been changed, as this could break existing calls. We
407 * allow adding names to formerly unnamed parameters, though.
409 proargnames = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
410 Anum_pg_proc_proargnames,
415 char **old_arg_names;
416 char **new_arg_names;
421 proargmodes = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
422 Anum_pg_proc_proargmodes,
425 proargmodes = PointerGetDatum(NULL); /* just to be sure */
427 n_old_arg_names = get_func_input_arg_names(proargnames,
430 n_new_arg_names = get_func_input_arg_names(parameterNames,
433 for (j = 0; j < n_old_arg_names; j++)
435 if (old_arg_names[j] == NULL)
437 if (j >= n_new_arg_names || new_arg_names[j] == NULL ||
438 strcmp(old_arg_names[j], new_arg_names[j]) != 0)
440 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
441 errmsg("cannot change name of input parameter \"%s\"",
443 errhint("Use DROP FUNCTION first.")));
448 * If there are existing defaults, check compatibility: redefinition
449 * must not remove any defaults nor change their types. (Removing a
450 * default might cause a function to fail to satisfy an existing call.
451 * Changing type would only be possible if the associated parameter is
452 * polymorphic, and in such cases a change of default type might alter
453 * the resolved output type of existing calls.)
455 if (oldproc->pronargdefaults != 0)
457 Datum proargdefaults;
462 if (list_length(parameterDefaults) < oldproc->pronargdefaults)
464 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
465 errmsg("cannot remove parameter defaults from existing function"),
466 errhint("Use DROP FUNCTION first.")));
468 proargdefaults = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
469 Anum_pg_proc_proargdefaults,
472 oldDefaults = (List *) stringToNode(TextDatumGetCString(proargdefaults));
473 Assert(IsA(oldDefaults, List));
474 Assert(list_length(oldDefaults) == oldproc->pronargdefaults);
476 /* new list can have more defaults than old, advance over 'em */
477 newlc = list_head(parameterDefaults);
478 for (i = list_length(parameterDefaults) - oldproc->pronargdefaults;
481 newlc = lnext(newlc);
483 foreach(oldlc, oldDefaults)
485 Node *oldDef = (Node *) lfirst(oldlc);
486 Node *newDef = (Node *) lfirst(newlc);
488 if (exprType(oldDef) != exprType(newDef))
490 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
491 errmsg("cannot change data type of existing parameter default value"),
492 errhint("Use DROP FUNCTION first.")));
493 newlc = lnext(newlc);
497 /* Can't change aggregate or window-function status, either */
498 if (oldproc->proisagg != isAgg)
500 if (oldproc->proisagg)
502 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
503 errmsg("function \"%s\" is an aggregate function",
507 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
508 errmsg("function \"%s\" is not an aggregate function",
511 if (oldproc->proiswindow != isWindowFunc)
513 if (oldproc->proiswindow)
515 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
516 errmsg("function \"%s\" is a window function",
520 (errcode(ERRCODE_WRONG_OBJECT_TYPE),
521 errmsg("function \"%s\" is not a window function",
526 * Do not change existing ownership or permissions, either. Note
527 * dependency-update code below has to agree with this decision.
529 replaces[Anum_pg_proc_proowner - 1] = false;
530 replaces[Anum_pg_proc_proacl - 1] = false;
533 tup = heap_modify_tuple(oldtup, tupDesc, values, nulls, replaces);
534 simple_heap_update(rel, &tup->t_self, tup);
536 ReleaseSysCache(oldtup);
541 /* Creating a new procedure */
543 /* First, get default permissions and set up proacl */
544 proacl = get_user_default_acl(ACL_OBJECT_FUNCTION, proowner,
547 values[Anum_pg_proc_proacl - 1] = PointerGetDatum(proacl);
549 nulls[Anum_pg_proc_proacl - 1] = true;
551 tup = heap_form_tuple(tupDesc, values, nulls);
552 simple_heap_insert(rel, tup);
556 /* Need to update indexes for either the insert or update case */
557 CatalogUpdateIndexes(rel, tup);
559 retval = HeapTupleGetOid(tup);
562 * Create dependencies for the new function. If we are updating an
563 * existing function, first delete any existing pg_depend entries.
564 * (However, since we are not changing ownership or permissions, the
565 * shared dependencies do *not* need to change, and we leave them alone.
566 * We also don't change any pre-existing extension-membership dependency.)
569 deleteDependencyRecordsFor(ProcedureRelationId, retval, true);
571 myself.classId = ProcedureRelationId;
572 myself.objectId = retval;
573 myself.objectSubId = 0;
575 /* dependency on namespace */
576 referenced.classId = NamespaceRelationId;
577 referenced.objectId = procNamespace;
578 referenced.objectSubId = 0;
579 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
581 /* dependency on implementation language */
582 referenced.classId = LanguageRelationId;
583 referenced.objectId = languageObjectId;
584 referenced.objectSubId = 0;
585 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
587 /* dependency on return type */
588 referenced.classId = TypeRelationId;
589 referenced.objectId = returnType;
590 referenced.objectSubId = 0;
591 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
593 /* dependency on parameter types */
594 for (i = 0; i < allParamCount; i++)
596 referenced.classId = TypeRelationId;
597 referenced.objectId = allParams[i];
598 referenced.objectSubId = 0;
599 recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
602 /* dependency on owner */
604 recordDependencyOnOwner(ProcedureRelationId, retval, proowner);
606 /* dependency on any roles mentioned in ACL */
607 if (!is_update && proacl != NULL)
612 nnewmembers = aclmembers(proacl, &newmembers);
613 updateAclDependencies(ProcedureRelationId, retval, 0,
616 nnewmembers, newmembers);
619 /* dependency on extension */
621 recordDependencyOnCurrentExtension(&myself);
625 /* Post creation hook for new function */
626 InvokeObjectAccessHook(OAT_POST_CREATE, ProcedureRelationId, retval, 0);
628 heap_close(rel, RowExclusiveLock);
630 /* Verify function body */
631 if (OidIsValid(languageValidator))
633 ArrayType *set_items;
636 /* Advance command counter so new tuple can be seen by validator */
637 CommandCounterIncrement();
639 /* Set per-function configuration parameters */
640 set_items = (ArrayType *) DatumGetPointer(proconfig);
641 if (set_items) /* Need a new GUC nesting level */
643 save_nestlevel = NewGUCNestLevel();
644 ProcessGUCArray(set_items,
645 (superuser() ? PGC_SUSET : PGC_USERSET),
650 save_nestlevel = 0; /* keep compiler quiet */
652 OidFunctionCall1(languageValidator, ObjectIdGetDatum(retval));
655 AtEOXact_GUC(true, save_nestlevel);
664 * Validator for internal functions
666 * Check that the given internal function name (the "prosrc" value) is
667 * a known builtin function.
670 fmgr_internal_validator(PG_FUNCTION_ARGS)
672 Oid funcoid = PG_GETARG_OID(0);
679 * We do not honor check_function_bodies since it's unlikely the function
680 * name will be found later if it isn't there now.
683 tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcoid));
684 if (!HeapTupleIsValid(tuple))
685 elog(ERROR, "cache lookup failed for function %u", funcoid);
687 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
689 elog(ERROR, "null prosrc");
690 prosrc = TextDatumGetCString(tmp);
692 if (fmgr_internal_function(prosrc) == InvalidOid)
694 (errcode(ERRCODE_UNDEFINED_FUNCTION),
695 errmsg("there is no built-in function named \"%s\"",
698 ReleaseSysCache(tuple);
706 * Validator for C language functions
708 * Make sure that the library file exists, is loadable, and contains
709 * the specified link symbol. Also check for a valid function
710 * information record.
713 fmgr_c_validator(PG_FUNCTION_ARGS)
715 Oid funcoid = PG_GETARG_OID(0);
724 * It'd be most consistent to skip the check if !check_function_bodies,
725 * but the purpose of that switch is to be helpful for pg_dump loading,
726 * and for pg_dump loading it's much better if we *do* check.
729 tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcoid));
730 if (!HeapTupleIsValid(tuple))
731 elog(ERROR, "cache lookup failed for function %u", funcoid);
733 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
735 elog(ERROR, "null prosrc for C function %u", funcoid);
736 prosrc = TextDatumGetCString(tmp);
738 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_probin, &isnull);
740 elog(ERROR, "null probin for C function %u", funcoid);
741 probin = TextDatumGetCString(tmp);
743 (void) load_external_function(probin, prosrc, true, &libraryhandle);
744 (void) fetch_finfo_record(libraryhandle, prosrc);
746 ReleaseSysCache(tuple);
753 * Validator for SQL language functions
755 * Parse it here in order to be sure that it contains no syntax errors.
758 fmgr_sql_validator(PG_FUNCTION_ARGS)
760 Oid funcoid = PG_GETARG_OID(0);
763 List *raw_parsetree_list;
764 List *querytree_list;
769 parse_error_callback_arg callback_arg;
770 ErrorContextCallback sqlerrcontext;
774 tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcoid));
775 if (!HeapTupleIsValid(tuple))
776 elog(ERROR, "cache lookup failed for function %u", funcoid);
777 proc = (Form_pg_proc) GETSTRUCT(tuple);
779 /* Disallow pseudotype result */
780 /* except for RECORD, VOID, or polymorphic */
781 if (get_typtype(proc->prorettype) == TYPTYPE_PSEUDO &&
782 proc->prorettype != RECORDOID &&
783 proc->prorettype != VOIDOID &&
784 !IsPolymorphicType(proc->prorettype))
786 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
787 errmsg("SQL functions cannot return type %s",
788 format_type_be(proc->prorettype))));
790 /* Disallow pseudotypes in arguments */
791 /* except for polymorphic */
793 for (i = 0; i < proc->pronargs; i++)
795 if (get_typtype(proc->proargtypes.values[i]) == TYPTYPE_PSEUDO)
797 if (IsPolymorphicType(proc->proargtypes.values[i]))
801 (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
802 errmsg("SQL functions cannot have arguments of type %s",
803 format_type_be(proc->proargtypes.values[i]))));
807 /* Postpone body checks if !check_function_bodies */
808 if (check_function_bodies)
810 tmp = SysCacheGetAttr(PROCOID, tuple, Anum_pg_proc_prosrc, &isnull);
812 elog(ERROR, "null prosrc");
814 prosrc = TextDatumGetCString(tmp);
817 * Setup error traceback support for ereport().
819 callback_arg.proname = NameStr(proc->proname);
820 callback_arg.prosrc = prosrc;
822 sqlerrcontext.callback = sql_function_parse_error_callback;
823 sqlerrcontext.arg = (void *) &callback_arg;
824 sqlerrcontext.previous = error_context_stack;
825 error_context_stack = &sqlerrcontext;
828 * We can't do full prechecking of the function definition if there
829 * are any polymorphic input types, because actual datatypes of
830 * expression results will be unresolvable. The check will be done at
833 * We can run the text through the raw parser though; this will at
834 * least catch silly syntactic errors.
836 raw_parsetree_list = pg_parse_query(prosrc);
841 * OK to do full precheck: analyze and rewrite the queries, then
842 * verify the result type.
844 SQLFunctionParseInfoPtr pinfo;
846 /* But first, set up parameter information */
847 pinfo = prepare_sql_fn_parse_info(tuple, NULL, InvalidOid);
849 querytree_list = NIL;
850 foreach(lc, raw_parsetree_list)
852 Node *parsetree = (Node *) lfirst(lc);
853 List *querytree_sublist;
855 querytree_sublist = pg_analyze_and_rewrite_params(parsetree,
857 (ParserSetupHook) sql_fn_parser_setup,
859 querytree_list = list_concat(querytree_list,
863 (void) check_sql_fn_retval(funcoid, proc->prorettype,
868 error_context_stack = sqlerrcontext.previous;
871 ReleaseSysCache(tuple);
877 * Error context callback for handling errors in SQL function definitions
880 sql_function_parse_error_callback(void *arg)
882 parse_error_callback_arg *callback_arg = (parse_error_callback_arg *) arg;
884 /* See if it's a syntax error; if so, transpose to CREATE FUNCTION */
885 if (!function_parse_error_transpose(callback_arg->prosrc))
887 /* If it's not a syntax error, push info onto context stack */
888 errcontext("SQL function \"%s\"", callback_arg->proname);
893 * Adjust a syntax error occurring inside the function body of a CREATE
894 * FUNCTION or DO command. This can be used by any function validator or
895 * anonymous-block handler, not only for SQL-language functions.
896 * It is assumed that the syntax error position is initially relative to the
897 * function body string (as passed in). If possible, we adjust the position
898 * to reference the original command text; if we can't manage that, we set
899 * up an "internal query" syntax error instead.
901 * Returns true if a syntax error was processed, false if not.
904 function_parse_error_transpose(const char *prosrc)
908 const char *queryText;
911 * Nothing to do unless we are dealing with a syntax error that has a
914 * Some PLs may prefer to report the error position as an internal error
915 * to begin with, so check that too.
917 origerrposition = geterrposition();
918 if (origerrposition <= 0)
920 origerrposition = getinternalerrposition();
921 if (origerrposition <= 0)
925 /* We can get the original query text from the active portal (hack...) */
926 Assert(ActivePortal && ActivePortal->status == PORTAL_ACTIVE);
927 queryText = ActivePortal->sourceText;
929 /* Try to locate the prosrc in the original text */
930 newerrposition = match_prosrc_to_query(prosrc, queryText, origerrposition);
932 if (newerrposition > 0)
934 /* Successful, so fix error position to reference original query */
935 errposition(newerrposition);
936 /* Get rid of any report of the error as an "internal query" */
937 internalerrposition(0);
938 internalerrquery(NULL);
943 * If unsuccessful, convert the position to an internal position
944 * marker and give the function text as the internal query.
947 internalerrposition(origerrposition);
948 internalerrquery(prosrc);
955 * Try to locate the string literal containing the function body in the
956 * given text of the CREATE FUNCTION or DO command. If successful, return
957 * the character (not byte) index within the command corresponding to the
958 * given character index within the literal. If not successful, return 0.
961 match_prosrc_to_query(const char *prosrc, const char *queryText,
965 * Rather than fully parsing the original command, we just scan the
966 * command looking for $prosrc$ or 'prosrc'. This could be fooled (though
967 * not in any very probable scenarios), so fail if we find more than one
970 int prosrclen = strlen(prosrc);
971 int querylen = strlen(queryText);
976 for (curpos = 0; curpos < querylen - prosrclen; curpos++)
978 if (queryText[curpos] == '$' &&
979 strncmp(prosrc, &queryText[curpos + 1], prosrclen) == 0 &&
980 queryText[curpos + 1 + prosrclen] == '$')
983 * Found a $foo$ match. Since there are no embedded quoting
984 * characters in a dollar-quoted literal, we don't have to do any
985 * fancy arithmetic; just offset by the starting position.
988 return 0; /* multiple matches, fail */
989 matchpos = pg_mbstrlen_with_len(queryText, curpos + 1)
992 else if (queryText[curpos] == '\'' &&
993 match_prosrc_to_literal(prosrc, &queryText[curpos + 1],
994 cursorpos, &newcursorpos))
997 * Found a 'foo' match. match_prosrc_to_literal() has adjusted
998 * for any quotes or backslashes embedded in the literal.
1001 return 0; /* multiple matches, fail */
1002 matchpos = pg_mbstrlen_with_len(queryText, curpos + 1)
1011 * Try to match the given source text to a single-quoted literal.
1012 * If successful, adjust newcursorpos to correspond to the character
1013 * (not byte) index corresponding to cursorpos in the source text.
1015 * At entry, literal points just past a ' character. We must check for the
1019 match_prosrc_to_literal(const char *prosrc, const char *literal,
1020 int cursorpos, int *newcursorpos)
1022 int newcp = cursorpos;
1026 * This implementation handles backslashes and doubled quotes in the
1027 * string literal. It does not handle the SQL syntax for literals
1028 * continued across line boundaries.
1030 * We do the comparison a character at a time, not a byte at a time, so
1031 * that we can do the correct cursorpos math.
1035 cursorpos--; /* characters left before cursor */
1038 * Check for backslashes and doubled quotes in the literal; adjust
1039 * newcp when one is found before the cursor.
1041 if (*literal == '\\')
1047 else if (*literal == '\'')
1049 if (literal[1] != '\'')
1055 chlen = pg_mblen(prosrc);
1056 if (strncmp(prosrc, literal, chlen) != 0)
1062 if (*literal == '\'' && literal[1] != '\'')
1065 *newcursorpos = newcp;
1070 /* Must set *newcursorpos to suppress compiler warning */
1071 *newcursorpos = newcp;