PostgreSQL Source Code  git master
pl_handler.c File Reference
#include "postgres.h"
#include "access/htup_details.h"
#include "catalog/pg_proc.h"
#include "catalog/pg_type.h"
#include "funcapi.h"
#include "miscadmin.h"
#include "plpgsql.h"
#include "utils/builtins.h"
#include "utils/guc.h"
#include "utils/lsyscache.h"
#include "utils/syscache.h"
#include "utils/varlena.h"
Include dependency graph for pl_handler.c:

Go to the source code of this file.

Functions

static bool plpgsql_extra_checks_check_hook (char **newvalue, void **extra, GucSource source)
 
static void plpgsql_extra_warnings_assign_hook (const char *newvalue, void *extra)
 
static void plpgsql_extra_errors_assign_hook (const char *newvalue, void *extra)
 
void _PG_init (void)
 
 PG_FUNCTION_INFO_V1 (plpgsql_call_handler)
 
Datum plpgsql_call_handler (PG_FUNCTION_ARGS)
 
 PG_FUNCTION_INFO_V1 (plpgsql_inline_handler)
 
Datum plpgsql_inline_handler (PG_FUNCTION_ARGS)
 
 PG_FUNCTION_INFO_V1 (plpgsql_validator)
 
Datum plpgsql_validator (PG_FUNCTION_ARGS)
 

Variables

 PG_MODULE_MAGIC
 
static const struct config_enum_entry variable_conflict_options []
 
int plpgsql_variable_conflict = PLPGSQL_RESOLVE_ERROR
 
bool plpgsql_print_strict_params = false
 
bool plpgsql_check_asserts = true
 
char * plpgsql_extra_warnings_string = NULL
 
char * plpgsql_extra_errors_string = NULL
 
int plpgsql_extra_warnings
 
int plpgsql_extra_errors
 
PLpgSQL_plugin ** plpgsql_plugin_ptr = NULL
 

Function Documentation

◆ _PG_init()

void _PG_init ( void  )

Definition at line 145 of file pl_handler.c.

References DefineCustomBoolVariable(), DefineCustomEnumVariable(), DefineCustomStringVariable(), EmitWarningsOnPlaceholders(), find_rendezvous_variable(), gettext_noop, GUC_LIST_INPUT, pg_bindtextdomain(), PG_FUNCTION_INFO_V1(), PGC_SUSET, PGC_USERSET, plpgsql_call_handler(), plpgsql_check_asserts, plpgsql_extra_checks_check_hook(), plpgsql_extra_errors_assign_hook(), plpgsql_extra_errors_string, plpgsql_extra_warnings_assign_hook(), plpgsql_extra_warnings_string, plpgsql_HashTableInit(), plpgsql_print_strict_params, PLPGSQL_RESOLVE_ERROR, plpgsql_subxact_cb(), plpgsql_variable_conflict, plpgsql_xact_cb(), RegisterSubXactCallback(), RegisterXactCallback(), and TEXTDOMAIN.

146 {
147  /* Be sure we do initialization only once (should be redundant now) */
148  static bool inited = false;
149 
150  if (inited)
151  return;
152 
154 
155  DefineCustomEnumVariable("plpgsql.variable_conflict",
156  gettext_noop("Sets handling of conflicts between PL/pgSQL variable names and table column names."),
157  NULL,
161  PGC_SUSET, 0,
162  NULL, NULL, NULL);
163 
164  DefineCustomBoolVariable("plpgsql.print_strict_params",
165  gettext_noop("Print information about parameters in the DETAIL part of the error messages generated on INTO ... STRICT failures."),
166  NULL,
168  false,
169  PGC_USERSET, 0,
170  NULL, NULL, NULL);
171 
172  DefineCustomBoolVariable("plpgsql.check_asserts",
173  gettext_noop("Perform checks given in ASSERT statements."),
174  NULL,
176  true,
177  PGC_USERSET, 0,
178  NULL, NULL, NULL);
179 
180  DefineCustomStringVariable("plpgsql.extra_warnings",
181  gettext_noop("List of programming constructs that should produce a warning."),
182  NULL,
184  "none",
188  NULL);
189 
190  DefineCustomStringVariable("plpgsql.extra_errors",
191  gettext_noop("List of programming constructs that should produce an error."),
192  NULL,
194  "none",
198  NULL);
199 
200  EmitWarningsOnPlaceholders("plpgsql");
201 
205 
206  /* Set up a rendezvous point with optional instrumentation plugin */
208 
209  inited = true;
210 }
#define TEXTDOMAIN
Definition: elog.h:160
char * plpgsql_extra_warnings_string
Definition: pl_handler.c:50
void plpgsql_HashTableInit(void)
Definition: pl_comp.c:2587
#define gettext_noop(x)
Definition: c.h:1197
void ** find_rendezvous_variable(const char *varName)
Definition: dfmgr.c:671
void DefineCustomEnumVariable(const char *name, const char *short_desc, const char *long_desc, int *valueAddr, int bootValue, const struct config_enum_entry *options, GucContext context, int flags, GucEnumCheckHook check_hook, GucEnumAssignHook assign_hook, GucShowHook show_hook)
Definition: guc.c:9245
char * plpgsql_extra_errors_string
Definition: pl_handler.c:51
Definition: guc.h:75
void EmitWarningsOnPlaceholders(const char *className)
Definition: guc.c:9273
static const struct config_enum_entry variable_conflict_options[]
Definition: pl_handler.c:37
PLpgSQL_plugin ** plpgsql_plugin_ptr
Definition: pl_handler.c:56
static void plpgsql_extra_warnings_assign_hook(const char *newvalue, void *extra)
Definition: pl_handler.c:127
void DefineCustomStringVariable(const char *name, const char *short_desc, const char *long_desc, char **valueAddr, const char *bootValue, GucContext context, int flags, GucStringCheckHook check_hook, GucStringAssignHook assign_hook, GucShowHook show_hook)
Definition: guc.c:9220
void RegisterSubXactCallback(SubXactCallback callback, void *arg)
Definition: xact.c:3582
bool plpgsql_print_strict_params
Definition: pl_handler.c:46
int plpgsql_variable_conflict
Definition: pl_handler.c:44
void RegisterXactCallback(XactCallback callback, void *arg)
Definition: xact.c:3527
static void plpgsql_extra_errors_assign_hook(const char *newvalue, void *extra)
Definition: pl_handler.c:133
void pg_bindtextdomain(const char *domain)
Definition: miscinit.c:1683
void plpgsql_subxact_cb(SubXactEvent event, SubTransactionId mySubid, SubTransactionId parentSubid, void *arg)
Definition: pl_exec.c:8326
static bool plpgsql_extra_checks_check_hook(char **newvalue, void **extra, GucSource source)
Definition: pl_handler.c:60
bool plpgsql_check_asserts
Definition: pl_handler.c:48
void DefineCustomBoolVariable(const char *name, const char *short_desc, const char *long_desc, bool *valueAddr, bool bootValue, GucContext context, int flags, GucBoolCheckHook check_hook, GucBoolAssignHook assign_hook, GucShowHook show_hook)
Definition: guc.c:9134
#define GUC_LIST_INPUT
Definition: guc.h:204
void plpgsql_xact_cb(XactEvent event, void *arg)
Definition: pl_exec.c:8284

◆ PG_FUNCTION_INFO_V1() [1/3]

PG_FUNCTION_INFO_V1 ( plpgsql_call_handler  )

◆ PG_FUNCTION_INFO_V1() [2/3]

PG_FUNCTION_INFO_V1 ( plpgsql_inline_handler  )

◆ PG_FUNCTION_INFO_V1() [3/3]

PG_FUNCTION_INFO_V1 ( plpgsql_validator  )

◆ plpgsql_call_handler()

Datum plpgsql_call_handler ( PG_FUNCTION_ARGS  )

Definition at line 222 of file pl_handler.c.

References CALLED_AS_EVENT_TRIGGER, CALLED_AS_TRIGGER, castNode, PLpgSQL_function::cur_estate, elog, ERROR, IsA, PG_END_TRY, PG_FINALLY, PG_FUNCTION_INFO_V1(), PG_TRY, plpgsql_compile(), plpgsql_exec_event_trigger(), plpgsql_exec_function(), plpgsql_exec_trigger(), plpgsql_inline_handler(), PointerGetDatum, PLpgSQL_function::requires_procedure_resowner, ResourceOwnerCreate(), ResourceOwnerDelete(), ResourceOwnerReleaseAllPlanCacheRefs(), SPI_connect_ext(), SPI_finish(), SPI_OK_CONNECT, SPI_OK_FINISH, SPI_OPT_NONATOMIC, SPI_result_code_string(), and PLpgSQL_function::use_count.

Referenced by _PG_init().

223 {
224  bool nonatomic;
225  PLpgSQL_function *func;
226  PLpgSQL_execstate *save_cur_estate;
227  ResourceOwner procedure_resowner;
228  volatile Datum retval = (Datum) 0;
229  int rc;
230 
231  nonatomic = fcinfo->context &&
232  IsA(fcinfo->context, CallContext) &&
233  !castNode(CallContext, fcinfo->context)->atomic;
234 
235  /*
236  * Connect to SPI manager
237  */
238  if ((rc = SPI_connect_ext(nonatomic ? SPI_OPT_NONATOMIC : 0)) != SPI_OK_CONNECT)
239  elog(ERROR, "SPI_connect failed: %s", SPI_result_code_string(rc));
240 
241  /* Find or compile the function */
242  func = plpgsql_compile(fcinfo, false);
243 
244  /* Must save and restore prior value of cur_estate */
245  save_cur_estate = func->cur_estate;
246 
247  /* Mark the function as busy, so it can't be deleted from under us */
248  func->use_count++;
249 
250  /*
251  * If we'll need a procedure-lifespan resowner to execute any CALL or DO
252  * statements, create it now. Since this resowner is not tied to any
253  * parent, failing to free it would result in process-lifespan leaks.
254  * Therefore, be very wary of adding any code between here and the PG_TRY
255  * block.
256  */
257  procedure_resowner =
258  (nonatomic && func->requires_procedure_resowner) ?
259  ResourceOwnerCreate(NULL, "PL/pgSQL procedure resources") : NULL;
260 
261  PG_TRY();
262  {
263  /*
264  * Determine if called as function or trigger and call appropriate
265  * subhandler
266  */
267  if (CALLED_AS_TRIGGER(fcinfo))
269  (TriggerData *) fcinfo->context));
270  else if (CALLED_AS_EVENT_TRIGGER(fcinfo))
271  {
273  (EventTriggerData *) fcinfo->context);
274  /* there's no return value in this case */
275  }
276  else
277  retval = plpgsql_exec_function(func, fcinfo,
278  NULL, NULL,
279  procedure_resowner,
280  !nonatomic);
281  }
282  PG_FINALLY();
283  {
284  /* Decrement use-count, restore cur_estate */
285  func->use_count--;
286  func->cur_estate = save_cur_estate;
287 
288  /* Be sure to release the procedure resowner if any */
289  if (procedure_resowner)
290  {
291  ResourceOwnerReleaseAllPlanCacheRefs(procedure_resowner);
292  ResourceOwnerDelete(procedure_resowner);
293  }
294  }
295  PG_END_TRY();
296 
297  /*
298  * Disconnect from SPI manager
299  */
300  if ((rc = SPI_finish()) != SPI_OK_FINISH)
301  elog(ERROR, "SPI_finish failed: %s", SPI_result_code_string(rc));
302 
303  return retval;
304 }
#define SPI_OK_CONNECT
Definition: spi.h:81
#define CALLED_AS_EVENT_TRIGGER(fcinfo)
Definition: event_trigger.h:40
#define IsA(nodeptr, _type_)
Definition: nodes.h:590
void plpgsql_exec_event_trigger(PLpgSQL_function *func, EventTriggerData *trigdata)
Definition: pl_exec.c:1145
int SPI_connect_ext(int options)
Definition: spi.c:104
#define castNode(_type_, nodeptr)
Definition: nodes.h:608
#define PointerGetDatum(X)
Definition: postgres.h:600
int SPI_finish(void)
Definition: spi.c:185
void ResourceOwnerDelete(ResourceOwner owner)
Definition: resowner.c:737
void ResourceOwnerReleaseAllPlanCacheRefs(ResourceOwner owner)
Definition: resowner.c:718
bool requires_procedure_resowner
Definition: plpgsql.h:1010
PLpgSQL_function * plpgsql_compile(FunctionCallInfo fcinfo, bool forValidator)
Definition: pl_comp.c:136
#define ERROR
Definition: elog.h:46
struct PLpgSQL_execstate * cur_estate
Definition: plpgsql.h:1013
#define SPI_OPT_NONATOMIC
Definition: spi.h:99
unsigned long use_count
Definition: plpgsql.h:1014
const char * SPI_result_code_string(int code)
Definition: spi.c:1861
#define PG_FINALLY()
Definition: elog.h:330
uintptr_t Datum
Definition: postgres.h:411
Datum plpgsql_exec_function(PLpgSQL_function *func, FunctionCallInfo fcinfo, EState *simple_eval_estate, ResourceOwner simple_eval_resowner, ResourceOwner procedure_resowner, bool atomic)
Definition: pl_exec.c:469
#define CALLED_AS_TRIGGER(fcinfo)
Definition: trigger.h:25
#define SPI_OK_FINISH
Definition: spi.h:82
#define elog(elevel,...)
Definition: elog.h:232
HeapTuple plpgsql_exec_trigger(PLpgSQL_function *func, TriggerData *trigdata)
Definition: pl_exec.c:905
#define PG_TRY()
Definition: elog.h:313
#define PG_END_TRY()
Definition: elog.h:338
ResourceOwner ResourceOwnerCreate(ResourceOwner parent, const char *name)
Definition: resowner.c:428

◆ plpgsql_extra_checks_check_hook()

static bool plpgsql_extra_checks_check_hook ( char **  newvalue,
void **  extra,
GucSource  source 
)
static

Definition at line 60 of file pl_handler.c.

References GUC_check_errdetail, lfirst, list_free(), malloc, pfree(), pg_strcasecmp(), PLPGSQL_XCHECK_ALL, PLPGSQL_XCHECK_NONE, PLPGSQL_XCHECK_SHADOWVAR, PLPGSQL_XCHECK_STRICTMULTIASSIGNMENT, PLPGSQL_XCHECK_TOOMANYROWS, pstrdup(), and SplitIdentifierString().

Referenced by _PG_init().

61 {
62  char *rawstring;
63  List *elemlist;
64  ListCell *l;
65  int extrachecks = 0;
66  int *myextra;
67 
68  if (pg_strcasecmp(*newvalue, "all") == 0)
69  extrachecks = PLPGSQL_XCHECK_ALL;
70  else if (pg_strcasecmp(*newvalue, "none") == 0)
71  extrachecks = PLPGSQL_XCHECK_NONE;
72  else
73  {
74  /* Need a modifiable copy of string */
75  rawstring = pstrdup(*newvalue);
76 
77  /* Parse string into list of identifiers */
78  if (!SplitIdentifierString(rawstring, ',', &elemlist))
79  {
80  /* syntax error in list */
81  GUC_check_errdetail("List syntax is invalid.");
82  pfree(rawstring);
83  list_free(elemlist);
84  return false;
85  }
86 
87  foreach(l, elemlist)
88  {
89  char *tok = (char *) lfirst(l);
90 
91  if (pg_strcasecmp(tok, "shadowed_variables") == 0)
92  extrachecks |= PLPGSQL_XCHECK_SHADOWVAR;
93  else if (pg_strcasecmp(tok, "too_many_rows") == 0)
94  extrachecks |= PLPGSQL_XCHECK_TOOMANYROWS;
95  else if (pg_strcasecmp(tok, "strict_multi_assignment") == 0)
97  else if (pg_strcasecmp(tok, "all") == 0 || pg_strcasecmp(tok, "none") == 0)
98  {
99  GUC_check_errdetail("Key word \"%s\" cannot be combined with other key words.", tok);
100  pfree(rawstring);
101  list_free(elemlist);
102  return false;
103  }
104  else
105  {
106  GUC_check_errdetail("Unrecognized key word: \"%s\".", tok);
107  pfree(rawstring);
108  list_free(elemlist);
109  return false;
110  }
111  }
112 
113  pfree(rawstring);
114  list_free(elemlist);
115  }
116 
117  myextra = (int *) malloc(sizeof(int));
118  if (!myextra)
119  return false;
120  *myextra = extrachecks;
121  *extra = (void *) myextra;
122 
123  return true;
124 }
#define GUC_check_errdetail
Definition: guc.h:416
#define PLPGSQL_XCHECK_STRICTMULTIASSIGNMENT
Definition: plpgsql.h:1187
char * pstrdup(const char *in)
Definition: mcxt.c:1299
#define PLPGSQL_XCHECK_NONE
Definition: plpgsql.h:1184
#define PLPGSQL_XCHECK_SHADOWVAR
Definition: plpgsql.h:1185
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
#define malloc(a)
Definition: header.h:50
void pfree(void *pointer)
Definition: mcxt.c:1169
bool SplitIdentifierString(char *rawstring, char separator, List **namelist)
Definition: varlena.c:3753
#define PLPGSQL_XCHECK_TOOMANYROWS
Definition: plpgsql.h:1186
#define lfirst(lc)
Definition: pg_list.h:169
void list_free(List *list)
Definition: list.c:1391
Definition: pg_list.h:50
#define PLPGSQL_XCHECK_ALL
Definition: plpgsql.h:1188

◆ plpgsql_extra_errors_assign_hook()

static void plpgsql_extra_errors_assign_hook ( const char *  newvalue,
void *  extra 
)
static

Definition at line 133 of file pl_handler.c.

References plpgsql_extra_errors.

Referenced by _PG_init().

134 {
135  plpgsql_extra_errors = *((int *) extra);
136 }
int plpgsql_extra_errors
Definition: pl_handler.c:53

◆ plpgsql_extra_warnings_assign_hook()

static void plpgsql_extra_warnings_assign_hook ( const char *  newvalue,
void *  extra 
)
static

Definition at line 127 of file pl_handler.c.

References plpgsql_extra_warnings.

Referenced by _PG_init().

128 {
129  plpgsql_extra_warnings = *((int *) extra);
130 }
int plpgsql_extra_warnings
Definition: pl_handler.c:52

◆ plpgsql_inline_handler()

Datum plpgsql_inline_handler ( PG_FUNCTION_ARGS  )

Definition at line 315 of file pl_handler.c.

References Assert, InlineCodeBlock::atomic, castNode, CreateExecutorState(), CurrentMemoryContext, DatumGetPointer, elog, ERROR, FmgrInfo::fn_mcxt, FmgrInfo::fn_oid, FreeExecutorState(), GetCurrentSubTransactionId(), InvalidOid, LOCAL_FCINFO, MemSet, PG_CATCH, PG_END_TRY, PG_FUNCTION_INFO_V1(), PG_GETARG_DATUM, PG_RE_THROW, PG_TRY, plpgsql_compile_inline(), plpgsql_exec_function(), plpgsql_free_function_memory(), plpgsql_subxact_cb(), plpgsql_validator(), ResourceOwnerCreate(), ResourceOwnerDelete(), ResourceOwnerReleaseAllPlanCacheRefs(), SizeForFunctionCallInfo, InlineCodeBlock::source_text, SPI_connect_ext(), SPI_finish(), SPI_OK_CONNECT, SPI_OK_FINISH, SPI_OPT_NONATOMIC, SPI_result_code_string(), SUBXACT_EVENT_ABORT_SUB, and PLpgSQL_function::use_count.

Referenced by plpgsql_call_handler().

316 {
317  LOCAL_FCINFO(fake_fcinfo, 0);
319  PLpgSQL_function *func;
320  FmgrInfo flinfo;
321  EState *simple_eval_estate;
322  ResourceOwner simple_eval_resowner;
323  Datum retval;
324  int rc;
325 
326  /*
327  * Connect to SPI manager
328  */
329  if ((rc = SPI_connect_ext(codeblock->atomic ? 0 : SPI_OPT_NONATOMIC)) != SPI_OK_CONNECT)
330  elog(ERROR, "SPI_connect failed: %s", SPI_result_code_string(rc));
331 
332  /* Compile the anonymous code block */
333  func = plpgsql_compile_inline(codeblock->source_text);
334 
335  /* Mark the function as busy, just pro forma */
336  func->use_count++;
337 
338  /*
339  * Set up a fake fcinfo with just enough info to satisfy
340  * plpgsql_exec_function(). In particular note that this sets things up
341  * with no arguments passed.
342  */
343  MemSet(fake_fcinfo, 0, SizeForFunctionCallInfo(0));
344  MemSet(&flinfo, 0, sizeof(flinfo));
345  fake_fcinfo->flinfo = &flinfo;
346  flinfo.fn_oid = InvalidOid;
347  flinfo.fn_mcxt = CurrentMemoryContext;
348 
349  /*
350  * Create a private EState and resowner for simple-expression execution.
351  * Notice that these are NOT tied to transaction-level resources; they
352  * must survive any COMMIT/ROLLBACK the DO block executes, since we will
353  * unconditionally try to clean them up below. (Hence, be wary of adding
354  * anything that could fail between here and the PG_TRY block.) See the
355  * comments for shared_simple_eval_estate.
356  *
357  * Because this resowner isn't tied to the calling transaction, we can
358  * also use it as the "procedure" resowner for any CALL statements. That
359  * helps reduce the opportunities for failure here.
360  */
361  simple_eval_estate = CreateExecutorState();
362  simple_eval_resowner =
363  ResourceOwnerCreate(NULL, "PL/pgSQL DO block simple expressions");
364 
365  /* And run the function */
366  PG_TRY();
367  {
368  retval = plpgsql_exec_function(func, fake_fcinfo,
369  simple_eval_estate,
370  simple_eval_resowner,
371  simple_eval_resowner, /* see above */
372  codeblock->atomic);
373  }
374  PG_CATCH();
375  {
376  /*
377  * We need to clean up what would otherwise be long-lived resources
378  * accumulated by the failed DO block, principally cached plans for
379  * statements (which can be flushed by plpgsql_free_function_memory),
380  * execution trees for simple expressions, which are in the private
381  * EState, and cached-plan refcounts held by the private resowner.
382  *
383  * Before releasing the private EState, we must clean up any
384  * simple_econtext_stack entries pointing into it, which we can do by
385  * invoking the subxact callback. (It will be called again later if
386  * some outer control level does a subtransaction abort, but no harm
387  * is done.) We cheat a bit knowing that plpgsql_subxact_cb does not
388  * pay attention to its parentSubid argument.
389  */
392  0, NULL);
393 
394  /* Clean up the private EState and resowner */
395  FreeExecutorState(simple_eval_estate);
396  ResourceOwnerReleaseAllPlanCacheRefs(simple_eval_resowner);
397  ResourceOwnerDelete(simple_eval_resowner);
398 
399  /* Function should now have no remaining use-counts ... */
400  func->use_count--;
401  Assert(func->use_count == 0);
402 
403  /* ... so we can free subsidiary storage */
405 
406  /* And propagate the error */
407  PG_RE_THROW();
408  }
409  PG_END_TRY();
410 
411  /* Clean up the private EState and resowner */
412  FreeExecutorState(simple_eval_estate);
413  ResourceOwnerReleaseAllPlanCacheRefs(simple_eval_resowner);
414  ResourceOwnerDelete(simple_eval_resowner);
415 
416  /* Function should now have no remaining use-counts ... */
417  func->use_count--;
418  Assert(func->use_count == 0);
419 
420  /* ... so we can free subsidiary storage */
422 
423  /*
424  * Disconnect from SPI manager
425  */
426  if ((rc = SPI_finish()) != SPI_OK_FINISH)
427  elog(ERROR, "SPI_finish failed: %s", SPI_result_code_string(rc));
428 
429  return retval;
430 }
PLpgSQL_function * plpgsql_compile_inline(char *proc_source)
Definition: pl_comp.c:847
#define SPI_OK_CONNECT
Definition: spi.h:81
void plpgsql_free_function_memory(PLpgSQL_function *func)
Definition: pl_funcs.c:725
Definition: fmgr.h:56
MemoryContext fn_mcxt
Definition: fmgr.h:65
int SPI_connect_ext(int options)
Definition: spi.c:104
#define castNode(_type_, nodeptr)
Definition: nodes.h:608
#define PG_GETARG_DATUM(n)
Definition: fmgr.h:268
#define SizeForFunctionCallInfo(nargs)
Definition: fmgr.h:102
int SPI_finish(void)
Definition: spi.c:185
void ResourceOwnerDelete(ResourceOwner owner)
Definition: resowner.c:737
#define MemSet(start, val, len)
Definition: c.h:1008
void ResourceOwnerReleaseAllPlanCacheRefs(ResourceOwner owner)
Definition: resowner.c:718
void FreeExecutorState(EState *estate)
Definition: execUtils.c:186
#define ERROR
Definition: elog.h:46
#define SPI_OPT_NONATOMIC
Definition: spi.h:99
unsigned long use_count
Definition: plpgsql.h:1014
const char * SPI_result_code_string(int code)
Definition: spi.c:1861
MemoryContext CurrentMemoryContext
Definition: mcxt.c:42
EState * CreateExecutorState(void)
Definition: execUtils.c:90
uintptr_t Datum
Definition: postgres.h:411
Datum plpgsql_exec_function(PLpgSQL_function *func, FunctionCallInfo fcinfo, EState *simple_eval_estate, ResourceOwner simple_eval_resowner, ResourceOwner procedure_resowner, bool atomic)
Definition: pl_exec.c:469
#define InvalidOid
Definition: postgres_ext.h:36
Oid fn_oid
Definition: fmgr.h:59
#define LOCAL_FCINFO(name, nargs)
Definition: fmgr.h:110
#define PG_CATCH()
Definition: elog.h:323
#define Assert(condition)
Definition: c.h:804
SubTransactionId GetCurrentSubTransactionId(void)
Definition: xact.c:723
#define SPI_OK_FINISH
Definition: spi.h:82
#define PG_RE_THROW()
Definition: elog.h:354
#define DatumGetPointer(X)
Definition: postgres.h:593
#define elog(elevel,...)
Definition: elog.h:232
void plpgsql_subxact_cb(SubXactEvent event, SubTransactionId mySubid, SubTransactionId parentSubid, void *arg)
Definition: pl_exec.c:8326
char * source_text
Definition: parsenodes.h:3006
#define PG_TRY()
Definition: elog.h:313
#define PG_END_TRY()
Definition: elog.h:338
ResourceOwner ResourceOwnerCreate(ResourceOwner parent, const char *name)
Definition: resowner.c:428

◆ plpgsql_validator()

Datum plpgsql_validator ( PG_FUNCTION_ARGS  )

Definition at line 442 of file pl_handler.c.

References check_function_bodies, CheckFunctionValidatorAccess(), CurrentMemoryContext, elog, ereport, errcode(), errmsg(), ERROR, FmgrInfo::fn_mcxt, FmgrInfo::fn_oid, format_type_be(), get_func_arg_info(), get_typtype(), GETSTRUCT, HeapTupleIsValid, i, LOCAL_FCINFO, MemSet, ObjectIdGetDatum, PG_GETARG_OID, PG_RETURN_VOID, plpgsql_compile(), PROCOID, ReleaseSysCache(), SearchSysCache1(), SizeForFunctionCallInfo, SPI_connect(), SPI_finish(), SPI_OK_CONNECT, SPI_OK_FINISH, SPI_result_code_string(), T_EventTriggerData, T_TriggerData, EventTriggerData::type, and TriggerData::type.

Referenced by plpgsql_inline_handler().

443 {
444  Oid funcoid = PG_GETARG_OID(0);
445  HeapTuple tuple;
446  Form_pg_proc proc;
447  char functyptype;
448  int numargs;
449  Oid *argtypes;
450  char **argnames;
451  char *argmodes;
452  bool is_dml_trigger = false;
453  bool is_event_trigger = false;
454  int i;
455 
456  if (!CheckFunctionValidatorAccess(fcinfo->flinfo->fn_oid, funcoid))
457  PG_RETURN_VOID();
458 
459  /* Get the new function's pg_proc entry */
460  tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcoid));
461  if (!HeapTupleIsValid(tuple))
462  elog(ERROR, "cache lookup failed for function %u", funcoid);
463  proc = (Form_pg_proc) GETSTRUCT(tuple);
464 
465  functyptype = get_typtype(proc->prorettype);
466 
467  /* Disallow pseudotype result */
468  /* except for TRIGGER, EVTTRIGGER, RECORD, VOID, or polymorphic */
469  if (functyptype == TYPTYPE_PSEUDO)
470  {
471  if (proc->prorettype == TRIGGEROID)
472  is_dml_trigger = true;
473  else if (proc->prorettype == EVENT_TRIGGEROID)
474  is_event_trigger = true;
475  else if (proc->prorettype != RECORDOID &&
476  proc->prorettype != VOIDOID &&
477  !IsPolymorphicType(proc->prorettype))
478  ereport(ERROR,
479  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
480  errmsg("PL/pgSQL functions cannot return type %s",
481  format_type_be(proc->prorettype))));
482  }
483 
484  /* Disallow pseudotypes in arguments (either IN or OUT) */
485  /* except for RECORD and polymorphic */
486  numargs = get_func_arg_info(tuple,
487  &argtypes, &argnames, &argmodes);
488  for (i = 0; i < numargs; i++)
489  {
490  if (get_typtype(argtypes[i]) == TYPTYPE_PSEUDO)
491  {
492  if (argtypes[i] != RECORDOID &&
493  !IsPolymorphicType(argtypes[i]))
494  ereport(ERROR,
495  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
496  errmsg("PL/pgSQL functions cannot accept type %s",
497  format_type_be(argtypes[i]))));
498  }
499  }
500 
501  /* Postpone body checks if !check_function_bodies */
503  {
504  LOCAL_FCINFO(fake_fcinfo, 0);
505  FmgrInfo flinfo;
506  int rc;
507  TriggerData trigdata;
508  EventTriggerData etrigdata;
509 
510  /*
511  * Connect to SPI manager (is this needed for compilation?)
512  */
513  if ((rc = SPI_connect()) != SPI_OK_CONNECT)
514  elog(ERROR, "SPI_connect failed: %s", SPI_result_code_string(rc));
515 
516  /*
517  * Set up a fake fcinfo with just enough info to satisfy
518  * plpgsql_compile().
519  */
520  MemSet(fake_fcinfo, 0, SizeForFunctionCallInfo(0));
521  MemSet(&flinfo, 0, sizeof(flinfo));
522  fake_fcinfo->flinfo = &flinfo;
523  flinfo.fn_oid = funcoid;
524  flinfo.fn_mcxt = CurrentMemoryContext;
525  if (is_dml_trigger)
526  {
527  MemSet(&trigdata, 0, sizeof(trigdata));
528  trigdata.type = T_TriggerData;
529  fake_fcinfo->context = (Node *) &trigdata;
530  }
531  else if (is_event_trigger)
532  {
533  MemSet(&etrigdata, 0, sizeof(etrigdata));
534  etrigdata.type = T_EventTriggerData;
535  fake_fcinfo->context = (Node *) &etrigdata;
536  }
537 
538  /* Test-compile the function */
539  plpgsql_compile(fake_fcinfo, true);
540 
541  /*
542  * Disconnect from SPI manager
543  */
544  if ((rc = SPI_finish()) != SPI_OK_FINISH)
545  elog(ERROR, "SPI_finish failed: %s", SPI_result_code_string(rc));
546  }
547 
548  ReleaseSysCache(tuple);
549 
550  PG_RETURN_VOID();
551 }
#define SPI_OK_CONNECT
Definition: spi.h:81
Definition: fmgr.h:56
#define GETSTRUCT(TUP)
Definition: htup_details.h:654
MemoryContext fn_mcxt
Definition: fmgr.h:65
int SPI_connect(void)
Definition: spi.c:98
#define SizeForFunctionCallInfo(nargs)
Definition: fmgr.h:102
int SPI_finish(void)
Definition: spi.c:185
int get_func_arg_info(HeapTuple procTup, Oid **p_argtypes, char ***p_argnames, char **p_argmodes)
Definition: funcapi.c:1268
Definition: nodes.h:539
int errcode(int sqlerrcode)
Definition: elog.c:698
char get_typtype(Oid typid)
Definition: lsyscache.c:2576
#define MemSet(start, val, len)
Definition: c.h:1008
char * format_type_be(Oid type_oid)
Definition: format_type.c:339
bool check_function_bodies
Definition: guc.c:570
unsigned int Oid
Definition: postgres_ext.h:31
PLpgSQL_function * plpgsql_compile(FunctionCallInfo fcinfo, bool forValidator)
Definition: pl_comp.c:136
#define ObjectIdGetDatum(X)
Definition: postgres.h:551
#define ERROR
Definition: elog.h:46
bool CheckFunctionValidatorAccess(Oid validatorOid, Oid functionOid)
Definition: fmgr.c:2035
const char * SPI_result_code_string(int code)
Definition: spi.c:1861
#define PG_GETARG_OID(n)
Definition: fmgr.h:275
MemoryContext CurrentMemoryContext
Definition: mcxt.c:42
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1127
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1175
FormData_pg_proc * Form_pg_proc
Definition: pg_proc.h:136
Oid fn_oid
Definition: fmgr.h:59
#define ereport(elevel,...)
Definition: elog.h:157
#define PG_RETURN_VOID()
Definition: fmgr.h:349
#define LOCAL_FCINFO(name, nargs)
Definition: fmgr.h:110
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define SPI_OK_FINISH
Definition: spi.h:82
int errmsg(const char *fmt,...)
Definition: elog.c:909
NodeTag type
Definition: trigger.h:32
#define elog(elevel,...)
Definition: elog.h:232
int i

Variable Documentation

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 34 of file pl_handler.c.

◆ plpgsql_check_asserts

bool plpgsql_check_asserts = true

Definition at line 48 of file pl_handler.c.

Referenced by _PG_init(), and exec_stmt_assert().

◆ plpgsql_extra_errors

int plpgsql_extra_errors

◆ plpgsql_extra_errors_string

char* plpgsql_extra_errors_string = NULL

Definition at line 51 of file pl_handler.c.

Referenced by _PG_init().

◆ plpgsql_extra_warnings

int plpgsql_extra_warnings

◆ plpgsql_extra_warnings_string

char* plpgsql_extra_warnings_string = NULL

Definition at line 50 of file pl_handler.c.

Referenced by _PG_init().

◆ plpgsql_plugin_ptr

◆ plpgsql_print_strict_params

bool plpgsql_print_strict_params = false

Definition at line 46 of file pl_handler.c.

Referenced by _PG_init(), do_compile(), and plpgsql_compile_inline().

◆ plpgsql_variable_conflict

int plpgsql_variable_conflict = PLPGSQL_RESOLVE_ERROR

Definition at line 44 of file pl_handler.c.

Referenced by _PG_init(), do_compile(), and plpgsql_compile_inline().

◆ variable_conflict_options

const struct config_enum_entry variable_conflict_options[]
static
Initial value:
= {
{"error", PLPGSQL_RESOLVE_ERROR, false},
{"use_variable", PLPGSQL_RESOLVE_VARIABLE, false},
{"use_column", PLPGSQL_RESOLVE_COLUMN, false},
{NULL, 0, false}
}

Definition at line 37 of file pl_handler.c.