PostgreSQL Source Code git master
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Functions | Variables
pltcl.c File Reference
#include "postgres.h"
#include <tcl.h>
#include <unistd.h>
#include <fcntl.h>
#include "access/htup_details.h"
#include "access/xact.h"
#include "catalog/objectaccess.h"
#include "catalog/pg_proc.h"
#include "catalog/pg_type.h"
#include "commands/event_trigger.h"
#include "commands/trigger.h"
#include "executor/spi.h"
#include "fmgr.h"
#include "funcapi.h"
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "parser/parse_func.h"
#include "parser/parse_type.h"
#include "pgstat.h"
#include "utils/acl.h"
#include "utils/builtins.h"
#include "utils/guc.h"
#include "utils/lsyscache.h"
#include "utils/memutils.h"
#include "utils/regproc.h"
#include "utils/rel.h"
#include "utils/syscache.h"
#include "utils/tuplestore.h"
#include "utils/typcache.h"
#include "pltclerrcodes.h"
Include dependency graph for pltcl.c:

Go to the source code of this file.

Data Structures

struct  pltcl_interp_desc
 
struct  pltcl_proc_desc
 
struct  pltcl_query_desc
 
struct  pltcl_proc_key
 
struct  pltcl_proc_ptr
 
struct  pltcl_call_state
 
struct  TclExceptionNameMap
 

Macros

#define HAVE_TCL_VERSION(maj, min)
 
#define CONST86
 
#define TEXTDOMAIN   PG_TEXTDOMAIN("pltcl")
 
#define UTF_BEGIN
 
#define UTF_END
 
#define UTF_U2E(x)    (_pltcl_utf_dst = utf_u2e(_pltcl_utf_src = (x)))
 
#define UTF_E2U(x)    (_pltcl_utf_dst = utf_e2u(_pltcl_utf_src = (x)))
 

Typedefs

typedef int Tcl_Size
 
typedef struct pltcl_interp_desc pltcl_interp_desc
 
typedef struct pltcl_proc_desc pltcl_proc_desc
 
typedef struct pltcl_query_desc pltcl_query_desc
 
typedef struct pltcl_proc_key pltcl_proc_key
 
typedef struct pltcl_proc_ptr pltcl_proc_ptr
 
typedef struct pltcl_call_state pltcl_call_state
 

Functions

 PG_MODULE_MAGIC_EXT (.name="pltcl",.version=PG_VERSION)
 
static char * utf_u2e (const char *src)
 
static char * utf_e2u (const char *src)
 
static void pltcl_init_interp (pltcl_interp_desc *interp_desc, Oid prolang, bool pltrusted)
 
static pltcl_interp_desc * pltcl_fetch_interp (Oid prolang, bool pltrusted)
 
static void call_pltcl_start_proc (Oid prolang, bool pltrusted)
 
static void start_proc_error_callback (void *arg)
 
static Datum pltcl_handler (PG_FUNCTION_ARGS, bool pltrusted)
 
static Datum pltcl_func_handler (PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
 
static HeapTuple pltcl_trigger_handler (PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
 
static void pltcl_event_trigger_handler (PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
 
static void throw_tcl_error (Tcl_Interp *interp, const char *proname)
 
static pltcl_proc_desc * compile_pltcl_function (Oid fn_oid, Oid tgreloid, bool is_event_trigger, bool pltrusted)
 
static int pltcl_elog (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static void pltcl_construct_errorCode (Tcl_Interp *interp, ErrorData *edata)
 
static const char * pltcl_get_condition_name (int sqlstate)
 
static int pltcl_quote (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_argisnull (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_returnnull (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_returnnext (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_SPI_execute (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_process_SPI_result (Tcl_Interp *interp, const char *arrayname, Tcl_Obj *loop_body, int spi_rc, SPITupleTable *tuptable, uint64 ntuples)
 
static int pltcl_SPI_prepare (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_SPI_execute_plan (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_subtransaction (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_commit (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static int pltcl_rollback (ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
 
static void pltcl_subtrans_begin (MemoryContext oldcontext, ResourceOwner oldowner)
 
static void pltcl_subtrans_commit (MemoryContext oldcontext, ResourceOwner oldowner)
 
static void pltcl_subtrans_abort (Tcl_Interp *interp, MemoryContext oldcontext, ResourceOwner oldowner)
 
static void pltcl_set_tuple_values (Tcl_Interp *interp, const char *arrayname, uint64 tupno, HeapTuple tuple, TupleDesc tupdesc)
 
static Tcl_Obj * pltcl_build_tuple_argument (HeapTuple tuple, TupleDesc tupdesc, bool include_generated)
 
static HeapTuple pltcl_build_tuple_result (Tcl_Interp *interp, Tcl_Obj **kvObjv, int kvObjc, pltcl_call_state *call_state)
 
static void pltcl_init_tuple_store (pltcl_call_state *call_state)
 
static ClientData pltcl_InitNotifier (void)
 
static void pltcl_FinalizeNotifier (ClientData clientData)
 
static void pltcl_SetTimer (CONST86 Tcl_Time *timePtr)
 
static void pltcl_AlertNotifier (ClientData clientData)
 
static void pltcl_CreateFileHandler (int fd, int mask, Tcl_FileProc *proc, ClientData clientData)
 
static void pltcl_DeleteFileHandler (int fd)
 
static void pltcl_ServiceModeHook (int mode)
 
static int pltcl_WaitForEvent (CONST86 Tcl_Time *timePtr)
 
void _PG_init (void)
 
 PG_FUNCTION_INFO_V1 (pltcl_call_handler)
 
Datum pltcl_call_handler (PG_FUNCTION_ARGS)
 
 PG_FUNCTION_INFO_V1 (pltclu_call_handler)
 
Datum pltclu_call_handler (PG_FUNCTION_ARGS)
 

Variables

static char * pltcl_start_proc = NULL
 
static char * pltclu_start_proc = NULL
 
static bool pltcl_pm_init_done = false
 
static Tcl_Interp * pltcl_hold_interp = NULL
 
static HTAB * pltcl_interp_htab = NULL
 
static HTAB * pltcl_proc_htab = NULL
 
static pltcl_call_state * pltcl_current_call_state = NULL
 
static const TclExceptionNameMap exception_name_map []
 

Macro Definition Documentation

◆ CONST86

#define CONST86

Definition at line 59 of file pltcl.c.

◆ HAVE_TCL_VERSION

#define HAVE_TCL_VERSION (   maj,
  min 
)
Value:
((TCL_MAJOR_VERSION > maj) || \
(TCL_MAJOR_VERSION == maj && TCL_MINOR_VERSION >= min))
fb
static int fb(int x)
Definition preproc-init.c:92

Definition at line 48 of file pltcl.c.

82{
83 return pg_any_to_server(src, strlen(src), PG_UTF8);
84}
85
86static inline char *
87utf_e2u(const char *src)
88{
89 return pg_server_to_any(src, strlen(src), PG_UTF8);
90}
91
92#define UTF_BEGIN \
93 do { \
94 const char *_pltcl_utf_src = NULL; \
95 char *_pltcl_utf_dst = NULL
96
97#define UTF_END \
98 if (_pltcl_utf_src != (const char *) _pltcl_utf_dst) \
99 pfree(_pltcl_utf_dst); \
100 } while (0)
101
102#define UTF_U2E(x) \
103 (_pltcl_utf_dst = utf_u2e(_pltcl_utf_src = (x)))
104
105#define UTF_E2U(x) \
106 (_pltcl_utf_dst = utf_e2u(_pltcl_utf_src = (x)))
107
108
109/**********************************************************************
110 * Information associated with a Tcl interpreter. We have one interpreter
111 * that is used for all pltclu (untrusted) functions. For pltcl (trusted)
112 * functions, there is a separate interpreter for each effective SQL userid.
113 * (This is needed to ensure that an unprivileged user can't inject Tcl code
114 * that'll be executed with the privileges of some other SQL user.)
115 *
116 * The pltcl_interp_desc structs are kept in a Postgres hash table indexed
117 * by userid OID, with OID 0 used for the single untrusted interpreter.
118 **********************************************************************/
119typedef struct pltcl_interp_desc
120{
121 Oid user_id; /* Hash key (must be first!) */
122 Tcl_Interp *interp; /* The interpreter */
123 Tcl_HashTable query_hash; /* pltcl_query_desc structs */
124} pltcl_interp_desc;
125
126
127/**********************************************************************
128 * The information we cache about loaded procedures
129 *
130 * The pltcl_proc_desc struct itself, as well as all subsidiary data,
131 * is stored in the memory context identified by the fn_cxt field.
132 * We can reclaim all the data by deleting that context, and should do so
133 * when the fn_refcount goes to zero. That will happen if we build a new
134 * pltcl_proc_desc following an update of the pg_proc row. If that happens
135 * while the old proc is being executed, we mustn't remove the struct until
136 * execution finishes. When building a new pltcl_proc_desc, we unlink
137 * Tcl's copy of the old procedure definition, similarly relying on Tcl's
138 * internal reference counting to prevent that structure from disappearing
139 * while it's in use.
140 *
141 * Note that the data in this struct is shared across all active calls;
142 * nothing except the fn_refcount should be changed by a call instance.
143 **********************************************************************/
144typedef struct pltcl_proc_desc
145{
146 char *user_proname; /* user's name (from format_procedure) */
147 char *internal_proname; /* Tcl proc name (NULL if deleted) */
148 MemoryContext fn_cxt; /* memory context for this procedure */
149 unsigned long fn_refcount; /* number of active references */
150 TransactionId fn_xmin; /* xmin of pg_proc row */
151 ItemPointerData fn_tid; /* TID of pg_proc row */
152 bool fn_readonly; /* is function readonly? */
153 bool lanpltrusted; /* is it pltcl (vs. pltclu)? */
154 pltcl_interp_desc *interp_desc; /* interpreter to use */
155 Oid result_typid; /* OID of fn's result type */
156 FmgrInfo result_in_func; /* input function for fn's result type */
157 Oid result_typioparam; /* param to pass to same */
158 bool fn_retisset; /* true if function returns a set */
159 bool fn_retistuple; /* true if function returns composite */
160 bool fn_retisdomain; /* true if function returns domain */
161 void *domain_info; /* opaque cache for domain checks */
162 int nargs; /* number of arguments */
163 /* these arrays have nargs entries: */
164 FmgrInfo *arg_out_func; /* output fns for arg types */
165 bool *arg_is_rowtype; /* is each arg composite? */
166} pltcl_proc_desc;
167
168
169/**********************************************************************
170 * The information we cache about prepared and saved plans
171 **********************************************************************/
172typedef struct pltcl_query_desc
173{
174 char qname[20];
175 SPIPlanPtr plan;
176 int nargs;
177 Oid *argtypes;
178 FmgrInfo *arginfuncs;
179 Oid *argtypioparams;
180} pltcl_query_desc;
181
182
183/**********************************************************************
184 * For speedy lookup, we maintain a hash table mapping from
185 * function OID + trigger flag + user OID to pltcl_proc_desc pointers.
186 * The reason the pltcl_proc_desc struct isn't directly part of the hash
187 * entry is to simplify recovery from errors during compile_pltcl_function.
188 *
189 * Note: if the same function is called by multiple userIDs within a session,
190 * there will be a separate pltcl_proc_desc entry for each userID in the case
191 * of pltcl functions, but only one entry for pltclu functions, because we
192 * set user_id = 0 for that case.
193 **********************************************************************/
194typedef struct pltcl_proc_key
195{
196 Oid proc_id; /* Function OID */
197
198 /*
199 * is_trigger is really a bool, but declare as Oid to ensure this struct
200 * contains no padding
201 */
202 Oid is_trigger; /* is it a trigger function? */
203 Oid user_id; /* User calling the function, or 0 */
204} pltcl_proc_key;
205
206typedef struct pltcl_proc_ptr
207{
208 pltcl_proc_key proc_key; /* Hash key (must be first!) */
209 pltcl_proc_desc *proc_ptr;
210} pltcl_proc_ptr;
211
212
213/**********************************************************************
214 * Per-call state
215 **********************************************************************/
216typedef struct pltcl_call_state
217{
218 /* Call info struct, or NULL in a trigger */
219 FunctionCallInfo fcinfo;
220
221 /* Trigger data, if we're in a normal (not event) trigger; else NULL */
222 TriggerData *trigdata;
223
224 /* Function we're executing (NULL if not yet identified) */
225 pltcl_proc_desc *prodesc;
226
227 /*
228 * Information for SRFs and functions returning composite types.
229 * ret_tupdesc and attinmeta are set up if either fn_retistuple or
230 * fn_retisset, since even a scalar-returning SRF needs a tuplestore.
231 */
232 TupleDesc ret_tupdesc; /* return rowtype, if retistuple or retisset */
233 AttInMetadata *attinmeta; /* metadata for building tuples of that type */
234
235 ReturnSetInfo *rsi; /* passed-in ReturnSetInfo, if any */
236 Tuplestorestate *tuple_store; /* SRFs accumulate result here */
237 MemoryContext tuple_store_cxt; /* context and resowner for tuplestore */
238 ResourceOwner tuple_store_owner;
239} pltcl_call_state;
240
241
242/**********************************************************************
243 * Global data
244 **********************************************************************/
245static char *pltcl_start_proc = NULL;
246static char *pltclu_start_proc = NULL;
247static bool pltcl_pm_init_done = false;
248static Tcl_Interp *pltcl_hold_interp = NULL;
249static HTAB *pltcl_interp_htab = NULL;
250static HTAB *pltcl_proc_htab = NULL;
251
252/* this is saved and restored by pltcl_handler */
253static pltcl_call_state *pltcl_current_call_state = NULL;
254
255/**********************************************************************
256 * Lookup table for SQLSTATE condition names
257 **********************************************************************/
258typedef struct
259{
260 const char *label;
261 int sqlerrstate;
262} TclExceptionNameMap;
263
264static const TclExceptionNameMap exception_name_map[] = {
265#include "pltclerrcodes.h"
266 {NULL, 0}
267};
268
269/**********************************************************************
270 * Forward declarations
271 **********************************************************************/
272
273static void pltcl_init_interp(pltcl_interp_desc *interp_desc,
274 Oid prolang, bool pltrusted);
275static pltcl_interp_desc *pltcl_fetch_interp(Oid prolang, bool pltrusted);
276static void call_pltcl_start_proc(Oid prolang, bool pltrusted);
277static void start_proc_error_callback(void *arg);
278
279static Datum pltcl_handler(PG_FUNCTION_ARGS, bool pltrusted);
280
281static Datum pltcl_func_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state,
282 bool pltrusted);
283static HeapTuple pltcl_trigger_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state,
284 bool pltrusted);
285static void pltcl_event_trigger_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state,
286 bool pltrusted);
287
288static void throw_tcl_error(Tcl_Interp *interp, const char *proname);
289
290static pltcl_proc_desc *compile_pltcl_function(Oid fn_oid, Oid tgreloid,
291 bool is_event_trigger,
292 bool pltrusted);
293
294static int pltcl_elog(ClientData cdata, Tcl_Interp *interp,
295 int objc, Tcl_Obj *const objv[]);
296static void pltcl_construct_errorCode(Tcl_Interp *interp, ErrorData *edata);
297static const char *pltcl_get_condition_name(int sqlstate);
298static int pltcl_quote(ClientData cdata, Tcl_Interp *interp,
299 int objc, Tcl_Obj *const objv[]);
300static int pltcl_argisnull(ClientData cdata, Tcl_Interp *interp,
301 int objc, Tcl_Obj *const objv[]);
302static int pltcl_returnnull(ClientData cdata, Tcl_Interp *interp,
303 int objc, Tcl_Obj *const objv[]);
304static int pltcl_returnnext(ClientData cdata, Tcl_Interp *interp,
305 int objc, Tcl_Obj *const objv[]);
306static int pltcl_SPI_execute(ClientData cdata, Tcl_Interp *interp,
307 int objc, Tcl_Obj *const objv[]);
308static int pltcl_process_SPI_result(Tcl_Interp *interp,
309 const char *arrayname,
310 Tcl_Obj *loop_body,
311 int spi_rc,
312 SPITupleTable *tuptable,
313 uint64 ntuples);
314static int pltcl_SPI_prepare(ClientData cdata, Tcl_Interp *interp,
315 int objc, Tcl_Obj *const objv[]);
316static int pltcl_SPI_execute_plan(ClientData cdata, Tcl_Interp *interp,
317 int objc, Tcl_Obj *const objv[]);
318static int pltcl_subtransaction(ClientData cdata, Tcl_Interp *interp,
319 int objc, Tcl_Obj *const objv[]);
320static int pltcl_commit(ClientData cdata, Tcl_Interp *interp,
321 int objc, Tcl_Obj *const objv[]);
322static int pltcl_rollback(ClientData cdata, Tcl_Interp *interp,
323 int objc, Tcl_Obj *const objv[]);
324
325static void pltcl_subtrans_begin(MemoryContext oldcontext,
326 ResourceOwner oldowner);
327static void pltcl_subtrans_commit(MemoryContext oldcontext,
328 ResourceOwner oldowner);
329static void pltcl_subtrans_abort(Tcl_Interp *interp,
330 MemoryContext oldcontext,
331 ResourceOwner oldowner);
332
333static void pltcl_set_tuple_values(Tcl_Interp *interp, const char *arrayname,
334 uint64 tupno, HeapTuple tuple, TupleDesc tupdesc);
335static Tcl_Obj *pltcl_build_tuple_argument(HeapTuple tuple, TupleDesc tupdesc, bool include_generated);
336static HeapTuple pltcl_build_tuple_result(Tcl_Interp *interp,
337 Tcl_Obj **kvObjv, int kvObjc,
338 pltcl_call_state *call_state);
339static void pltcl_init_tuple_store(pltcl_call_state *call_state);
340
341
342/*
343 * Hack to override Tcl's builtin Notifier subsystem. This prevents the
344 * backend from becoming multithreaded, which breaks all sorts of things.
345 * That happens in the default version of Tcl_InitNotifier if the Tcl library
346 * has been compiled with multithreading support (i.e. when TCL_THREADS is
347 * defined under Unix, and in all cases under Windows).
348 * It's okay to disable the notifier because we never enter the Tcl event loop
349 * from Postgres, so the notifier capabilities are initialized, but never
350 * used. Only InitNotifier and DeleteFileHandler ever seem to get called
351 * within Postgres, but we implement all the functions for completeness.
352 */
353static ClientData
354pltcl_InitNotifier(void)
355{
356 static int fakeThreadKey; /* To give valid address for ClientData */
357
358 return (ClientData) &(fakeThreadKey);
359}
360
361static void
362pltcl_FinalizeNotifier(ClientData clientData)
363{
364}
365
366static void
367pltcl_SetTimer(CONST86 Tcl_Time *timePtr)
368{
369}
370
371static void
372pltcl_AlertNotifier(ClientData clientData)
373{
374}
375
376static void
377pltcl_CreateFileHandler(int fd, int mask,
378 Tcl_FileProc *proc, ClientData clientData)
379{
380}
381
382static void
383pltcl_DeleteFileHandler(int fd)
384{
385}
386
387static void
388pltcl_ServiceModeHook(int mode)
389{
390}
391
392static int
393pltcl_WaitForEvent(CONST86 Tcl_Time *timePtr)
394{
395 return 0;
396}
397
398
399/*
400 * _PG_init() - library load-time initialization
401 *
402 * DO NOT make this static nor change its name!
403 *
404 * The work done here must be safe to do in the postmaster process,
405 * in case the pltcl library is preloaded in the postmaster.
406 */
407void
408_PG_init(void)
409{
410 Tcl_NotifierProcs notifier;
411 HASHCTL hash_ctl;
412
413 /* Be sure we do initialization only once (should be redundant now) */
414 if (pltcl_pm_init_done)
415 return;
416
417 pg_bindtextdomain(TEXTDOMAIN);
418
419#ifdef WIN32
420 /* Required on win32 to prevent error loading init.tcl */
421 Tcl_FindExecutable("");
422#endif
423
424 /*
425 * Override the functions in the Notifier subsystem. See comments above.
426 */
427 notifier.setTimerProc = pltcl_SetTimer;
428 notifier.waitForEventProc = pltcl_WaitForEvent;
429 notifier.createFileHandlerProc = pltcl_CreateFileHandler;
430 notifier.deleteFileHandlerProc = pltcl_DeleteFileHandler;
431 notifier.initNotifierProc = pltcl_InitNotifier;
432 notifier.finalizeNotifierProc = pltcl_FinalizeNotifier;
433 notifier.alertNotifierProc = pltcl_AlertNotifier;
434 notifier.serviceModeHookProc = pltcl_ServiceModeHook;
435 Tcl_SetNotifier(&notifier);
436
437 /************************************************************
438 * Create the dummy hold interpreter to prevent close of
439 * stdout and stderr on DeleteInterp
440 ************************************************************/
441 if ((pltcl_hold_interp = Tcl_CreateInterp()) == NULL)
442 elog(ERROR, "could not create dummy Tcl interpreter");
443 if (Tcl_Init(pltcl_hold_interp) == TCL_ERROR)
444 elog(ERROR, "could not initialize dummy Tcl interpreter");
445
446 /************************************************************
447 * Create the hash table for working interpreters
448 ************************************************************/
449 hash_ctl.keysize = sizeof(Oid);
450 hash_ctl.entrysize = sizeof(pltcl_interp_desc);
451 pltcl_interp_htab = hash_create("PL/Tcl interpreters",
452 8,
453 &hash_ctl,
454 HASH_ELEM | HASH_BLOBS);
455
456 /************************************************************
457 * Create the hash table for function lookup
458 ************************************************************/
459 hash_ctl.keysize = sizeof(pltcl_proc_key);
460 hash_ctl.entrysize = sizeof(pltcl_proc_ptr);
461 pltcl_proc_htab = hash_create("PL/Tcl functions",
462 100,
463 &hash_ctl,
464 HASH_ELEM | HASH_BLOBS);
465
466 /************************************************************
467 * Define PL/Tcl's custom GUCs
468 ************************************************************/
469 DefineCustomStringVariable("pltcl.start_proc",
470 gettext_noop("PL/Tcl function to call once when pltcl is first used."),
471 NULL,
472 &pltcl_start_proc,
473 NULL,
474 PGC_SUSET, 0,
475 NULL, NULL, NULL);
476 DefineCustomStringVariable("pltclu.start_proc",
477 gettext_noop("PL/TclU function to call once when pltclu is first used."),
478 NULL,
479 &pltclu_start_proc,
480 NULL,
481 PGC_SUSET, 0,
482 NULL, NULL, NULL);
483
484 MarkGUCPrefixReserved("pltcl");
485 MarkGUCPrefixReserved("pltclu");
486
487 pltcl_pm_init_done = true;
488}
489
490/**********************************************************************
491 * pltcl_init_interp() - initialize a new Tcl interpreter
492 **********************************************************************/
493static void
494pltcl_init_interp(pltcl_interp_desc *interp_desc, Oid prolang, bool pltrusted)
495{
496 Tcl_Interp *interp;
497 char interpname[32];
498
499 /************************************************************
500 * Create the Tcl interpreter subsidiary to pltcl_hold_interp.
501 * Note: Tcl automatically does Tcl_Init in the untrusted case,
502 * and it's not wanted in the trusted case.
503 ************************************************************/
504 snprintf(interpname, sizeof(interpname), "subsidiary_%u", interp_desc->user_id);
505 if ((interp = Tcl_CreateSlave(pltcl_hold_interp, interpname,
506 pltrusted ? 1 : 0)) == NULL)
507 elog(ERROR, "could not create subsidiary Tcl interpreter");
508
509 /************************************************************
510 * Initialize the query hash table associated with interpreter
511 ************************************************************/
512 Tcl_InitHashTable(&interp_desc->query_hash, TCL_STRING_KEYS);
513
514 /************************************************************
515 * Install the commands for SPI support in the interpreter
516 ************************************************************/
517 Tcl_CreateObjCommand(interp, "elog",
518 pltcl_elog, NULL, NULL);
519 Tcl_CreateObjCommand(interp, "quote",
520 pltcl_quote, NULL, NULL);
521 Tcl_CreateObjCommand(interp, "argisnull",
522 pltcl_argisnull, NULL, NULL);
523 Tcl_CreateObjCommand(interp, "return_null",
524 pltcl_returnnull, NULL, NULL);
525 Tcl_CreateObjCommand(interp, "return_next",
526 pltcl_returnnext, NULL, NULL);
527 Tcl_CreateObjCommand(interp, "spi_exec",
528 pltcl_SPI_execute, NULL, NULL);
529 Tcl_CreateObjCommand(interp, "spi_prepare",
530 pltcl_SPI_prepare, NULL, NULL);
531 Tcl_CreateObjCommand(interp, "spi_execp",
532 pltcl_SPI_execute_plan, NULL, NULL);
533 Tcl_CreateObjCommand(interp, "subtransaction",
534 pltcl_subtransaction, NULL, NULL);
535 Tcl_CreateObjCommand(interp, "commit",
536 pltcl_commit, NULL, NULL);
537 Tcl_CreateObjCommand(interp, "rollback",
538 pltcl_rollback, NULL, NULL);
539
540 /************************************************************
541 * Call the appropriate start_proc, if there is one.
542 *
543 * We must set interp_desc->interp before the call, else the start_proc
544 * won't find the interpreter it's supposed to use. But, if the
545 * start_proc fails, we want to abandon use of the interpreter.
546 ************************************************************/
547 PG_TRY();
548 {
549 interp_desc->interp = interp;
550 call_pltcl_start_proc(prolang, pltrusted);
551 }
552 PG_CATCH();
553 {
554 interp_desc->interp = NULL;
555 Tcl_DeleteInterp(interp);
556 PG_RE_THROW();
557 }
558 PG_END_TRY();
559}
560
561/**********************************************************************
562 * pltcl_fetch_interp() - fetch the Tcl interpreter to use for a function
563 *
564 * This also takes care of any on-first-use initialization required.
565 **********************************************************************/
566static pltcl_interp_desc *
567pltcl_fetch_interp(Oid prolang, bool pltrusted)
568{
569 Oid user_id;
570 pltcl_interp_desc *interp_desc;
571 bool found;
572
573 /* Find or create the interpreter hashtable entry for this userid */
574 if (pltrusted)
575 user_id = GetUserId();
576 else
577 user_id = InvalidOid;
578
579 interp_desc = hash_search(pltcl_interp_htab, &user_id,
580 HASH_ENTER,
581 &found);
582 if (!found)
583 interp_desc->interp = NULL;
584
585 /* If we haven't yet successfully made an interpreter, try to do that */
586 if (!interp_desc->interp)
587 pltcl_init_interp(interp_desc, prolang, pltrusted);
588
589 return interp_desc;
590}
591
592
593/**********************************************************************
594 * call_pltcl_start_proc() - Call user-defined initialization proc, if any
595 **********************************************************************/
596static void
597call_pltcl_start_proc(Oid prolang, bool pltrusted)
598{
599 LOCAL_FCINFO(fcinfo, 0);
600 char *start_proc;
601 const char *gucname;
602 ErrorContextCallback errcallback;
603 List *namelist;
604 Oid procOid;
605 HeapTuple procTup;
606 Form_pg_proc procStruct;
607 AclResult aclresult;
608 FmgrInfo finfo;
609 PgStat_FunctionCallUsage fcusage;
610
611 /* select appropriate GUC */
612 start_proc = pltrusted ? pltcl_start_proc : pltclu_start_proc;
613 gucname = pltrusted ? "pltcl.start_proc" : "pltclu.start_proc";
614
615 /* Nothing to do if it's empty or unset */
616 if (start_proc == NULL || start_proc[0] == '\0')
617 return;
618
619 /* Set up errcontext callback to make errors more helpful */
620 errcallback.callback = start_proc_error_callback;
621 errcallback.arg = unconstify(char *, gucname);
622 errcallback.previous = error_context_stack;
623 error_context_stack = &errcallback;
624
625 /* Parse possibly-qualified identifier and look up the function */
626 namelist = stringToQualifiedNameList(start_proc, NULL);
627 procOid = LookupFuncName(namelist, 0, NULL, false);
628
629 /* Current user must have permission to call function */
630 aclresult = object_aclcheck(ProcedureRelationId, procOid, GetUserId(), ACL_EXECUTE);
631 if (aclresult != ACLCHECK_OK)
632 aclcheck_error(aclresult, OBJECT_FUNCTION, start_proc);
633
634 /* Get the function's pg_proc entry */
635 procTup = SearchSysCache1(PROCOID, ObjectIdGetDatum(procOid));
636 if (!HeapTupleIsValid(procTup))
637 elog(ERROR, "cache lookup failed for function %u", procOid);
638 procStruct = (Form_pg_proc) GETSTRUCT(procTup);
639
640 /* It must be same language as the function we're currently calling */
641 if (procStruct->prolang != prolang)
642 ereport(ERROR,
643 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
644 errmsg("function \"%s\" is in the wrong language",
645 start_proc)));
646
647 /*
648 * It must not be SECURITY DEFINER, either. This together with the
649 * language match check ensures that the function will execute in the same
650 * Tcl interpreter we just finished initializing.
651 */
652 if (procStruct->prosecdef)
653 ereport(ERROR,
654 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
655 errmsg("function \"%s\" must not be SECURITY DEFINER",
656 start_proc)));
657
658 /* A-OK */
659 ReleaseSysCache(procTup);
660
661 /*
662 * Call the function using the normal SQL function call mechanism. We
663 * could perhaps cheat and jump directly to pltcl_handler(), but it seems
664 * better to do it this way so that the call is exposed to, eg, call
665 * statistics collection.
666 */
667 InvokeFunctionExecuteHook(procOid);
668 fmgr_info(procOid, &finfo);
669 InitFunctionCallInfoData(*fcinfo, &finfo,
670 0,
671 InvalidOid, NULL, NULL);
672 pgstat_init_function_usage(fcinfo, &fcusage);
673 (void) FunctionCallInvoke(fcinfo);
674 pgstat_end_function_usage(&fcusage, true);
675
676 /* Pop the error context stack */
677 error_context_stack = errcallback.previous;
678}
679
680/*
681 * Error context callback for errors occurring during start_proc processing.
682 */
683static void
684start_proc_error_callback(void *arg)
685{
686 const char *gucname = (const char *) arg;
687
688 /* translator: %s is "pltcl.start_proc" or "pltclu.start_proc" */
689 errcontext("processing %s parameter", gucname);
690}
691
692
693/**********************************************************************
694 * pltcl_call_handler - This is the only visible function
695 * of the PL interpreter. The PostgreSQL
696 * function manager and trigger manager
697 * call this function for execution of
698 * PL/Tcl procedures.
699 **********************************************************************/
700PG_FUNCTION_INFO_V1(pltcl_call_handler);
701
702/* keep non-static */
703Datum
704pltcl_call_handler(PG_FUNCTION_ARGS)
705{
706 return pltcl_handler(fcinfo, true);
707}
708
709/*
710 * Alternative handler for unsafe functions
711 */
712PG_FUNCTION_INFO_V1(pltclu_call_handler);
713
714/* keep non-static */
715Datum
716pltclu_call_handler(PG_FUNCTION_ARGS)
717{
718 return pltcl_handler(fcinfo, false);
719}
720
721
722/**********************************************************************
723 * pltcl_handler() - Handler for function and trigger calls, for
724 * both trusted and untrusted interpreters.
725 **********************************************************************/
726static Datum
727pltcl_handler(PG_FUNCTION_ARGS, bool pltrusted)
728{
729 Datum retval = (Datum) 0;
730 pltcl_call_state current_call_state;
731 pltcl_call_state *save_call_state;
732
733 /*
734 * Initialize current_call_state to nulls/zeroes; in particular, set its
735 * prodesc pointer to null. Anything that sets it non-null should
736 * increase the prodesc's fn_refcount at the same time. We'll decrease
737 * the refcount, and then delete the prodesc if it's no longer referenced,
738 * on the way out of this function. This ensures that prodescs live as
739 * long as needed even if somebody replaces the originating pg_proc row
740 * while they're executing.
741 */
742 memset(&current_call_state, 0, sizeof(current_call_state));
743
744 /*
745 * Ensure that static pointer is saved/restored properly
746 */
747 save_call_state = pltcl_current_call_state;
748 pltcl_current_call_state = &current_call_state;
749
750 PG_TRY();
751 {
752 /*
753 * Determine if called as function or trigger and call appropriate
754 * subhandler
755 */
756 if (CALLED_AS_TRIGGER(fcinfo))
757 {
758 /* invoke the trigger handler */
759 retval = PointerGetDatum(pltcl_trigger_handler(fcinfo,
760 &current_call_state,
761 pltrusted));
762 }
763 else if (CALLED_AS_EVENT_TRIGGER(fcinfo))
764 {
765 /* invoke the event trigger handler */
766 pltcl_event_trigger_handler(fcinfo, &current_call_state, pltrusted);
767 retval = (Datum) 0;
768 }
769 else
770 {
771 /* invoke the regular function handler */
772 current_call_state.fcinfo = fcinfo;
773 retval = pltcl_func_handler(fcinfo, &current_call_state, pltrusted);
774 }
775 }
776 PG_FINALLY();
777 {
778 /* Restore static pointer, then clean up the prodesc refcount if any */
779 /*
780 * (We're being paranoid in case an error is thrown in context
781 * deletion)
782 */
783 pltcl_current_call_state = save_call_state;
784 if (current_call_state.prodesc != NULL)
785 {
786 Assert(current_call_state.prodesc->fn_refcount > 0);
787 if (--current_call_state.prodesc->fn_refcount == 0)
788 MemoryContextDelete(current_call_state.prodesc->fn_cxt);
789 }
790 }
791 PG_END_TRY();
792
793 return retval;
794}
795
796
797/**********************************************************************
798 * pltcl_func_handler() - Handler for regular function calls
799 **********************************************************************/
800static Datum
801pltcl_func_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state,
802 bool pltrusted)
803{
804 bool nonatomic;
805 pltcl_proc_desc *prodesc;
806 Tcl_Interp *volatile interp;
807 Tcl_Obj *tcl_cmd;
808 int i;
809 int tcl_rc;
810 Datum retval;
811
812 nonatomic = fcinfo->context &&
813 IsA(fcinfo->context, CallContext) &&
814 !castNode(CallContext, fcinfo->context)->atomic;
815
816 /* Connect to SPI manager */
817 SPI_connect_ext(nonatomic ? SPI_OPT_NONATOMIC : 0);
818
819 /* Find or compile the function */
820 prodesc = compile_pltcl_function(fcinfo->flinfo->fn_oid, InvalidOid,
821 false, pltrusted);
822
823 call_state->prodesc = prodesc;
824 prodesc->fn_refcount++;
825
826 interp = prodesc->interp_desc->interp;
827
828 /*
829 * If we're a SRF, check caller can handle materialize mode, and save
830 * relevant info into call_state. We must ensure that the returned
831 * tuplestore is owned by the caller's context, even if we first create it
832 * inside a subtransaction.
833 */
834 if (prodesc->fn_retisset)
835 {
836 ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
837
838 if (!rsi || !IsA(rsi, ReturnSetInfo))
839 ereport(ERROR,
840 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
841 errmsg("set-valued function called in context that cannot accept a set")));
842
843 if (!(rsi->allowedModes & SFRM_Materialize))
844 ereport(ERROR,
845 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
846 errmsg("materialize mode required, but it is not allowed in this context")));
847
848 call_state->rsi = rsi;
849 call_state->tuple_store_cxt = rsi->econtext->ecxt_per_query_memory;
850 call_state->tuple_store_owner = CurrentResourceOwner;
851 }
852
853 /************************************************************
854 * Create the tcl command to call the internal
855 * proc in the Tcl interpreter
856 ************************************************************/
857 tcl_cmd = Tcl_NewObj();
858 Tcl_ListObjAppendElement(NULL, tcl_cmd,
859 Tcl_NewStringObj(prodesc->internal_proname, -1));
860
861 /* We hold a refcount on tcl_cmd just to be sure it stays around */
862 Tcl_IncrRefCount(tcl_cmd);
863
864 /************************************************************
865 * Add all call arguments to the command
866 ************************************************************/
867 PG_TRY();
868 {
869 for (i = 0; i < prodesc->nargs; i++)
870 {
871 if (prodesc->arg_is_rowtype[i])
872 {
873 /**************************************************
874 * For tuple values, add a list for 'array set ...'
875 **************************************************/
876 if (fcinfo->args[i].isnull)
877 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
878 else
879 {
880 HeapTupleHeader td;
881 Oid tupType;
882 int32 tupTypmod;
883 TupleDesc tupdesc;
884 HeapTupleData tmptup;
885 Tcl_Obj *list_tmp;
886
887 td = DatumGetHeapTupleHeader(fcinfo->args[i].value);
888 /* Extract rowtype info and find a tupdesc */
889 tupType = HeapTupleHeaderGetTypeId(td);
890 tupTypmod = HeapTupleHeaderGetTypMod(td);
891 tupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod);
892 /* Build a temporary HeapTuple control structure */
893 tmptup.t_len = HeapTupleHeaderGetDatumLength(td);
894 tmptup.t_data = td;
895
896 list_tmp = pltcl_build_tuple_argument(&tmptup, tupdesc, true);
897 Tcl_ListObjAppendElement(NULL, tcl_cmd, list_tmp);
898
899 ReleaseTupleDesc(tupdesc);
900 }
901 }
902 else
903 {
904 /**************************************************
905 * Single values are added as string element
906 * of their external representation
907 **************************************************/
908 if (fcinfo->args[i].isnull)
909 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
910 else
911 {
912 char *tmp;
913
914 tmp = OutputFunctionCall(&prodesc->arg_out_func[i],
915 fcinfo->args[i].value);
916 UTF_BEGIN;
917 Tcl_ListObjAppendElement(NULL, tcl_cmd,
918 Tcl_NewStringObj(UTF_E2U(tmp), -1));
919 UTF_END;
920 pfree(tmp);
921 }
922 }
923 }
924 }
925 PG_CATCH();
926 {
927 /* Release refcount to free tcl_cmd */
928 Tcl_DecrRefCount(tcl_cmd);
929 PG_RE_THROW();
930 }
931 PG_END_TRY();
932
933 /************************************************************
934 * Call the Tcl function
935 *
936 * We assume no PG error can be thrown directly from this call.
937 ************************************************************/
938 tcl_rc = Tcl_EvalObjEx(interp, tcl_cmd, (TCL_EVAL_DIRECT | TCL_EVAL_GLOBAL));
939
940 /* Release refcount to free tcl_cmd (and all subsidiary objects) */
941 Tcl_DecrRefCount(tcl_cmd);
942
943 /************************************************************
944 * Check for errors reported by Tcl.
945 ************************************************************/
946 if (tcl_rc != TCL_OK)
947 throw_tcl_error(interp, prodesc->user_proname);
948
949 /************************************************************
950 * Disconnect from SPI manager and then create the return
951 * value datum (if the input function does a palloc for it
952 * this must not be allocated in the SPI memory context
953 * because SPI_finish would free it). But don't try to call
954 * the result_in_func if we've been told to return a NULL;
955 * the Tcl result may not be a valid value of the result type
956 * in that case.
957 ************************************************************/
958 if (SPI_finish() != SPI_OK_FINISH)
959 elog(ERROR, "SPI_finish() failed");
960
961 if (prodesc->fn_retisset)
962 {
963 ReturnSetInfo *rsi = call_state->rsi;
964
965 /* We already checked this is OK */
966 rsi->returnMode = SFRM_Materialize;
967
968 /* If we produced any tuples, send back the result */
969 if (call_state->tuple_store)
970 {
971 rsi->setResult = call_state->tuple_store;
972 if (call_state->ret_tupdesc)
973 {
974 MemoryContext oldcxt;
975
976 oldcxt = MemoryContextSwitchTo(call_state->tuple_store_cxt);
977 rsi->setDesc = CreateTupleDescCopy(call_state->ret_tupdesc);
978 MemoryContextSwitchTo(oldcxt);
979 }
980 }
981 retval = (Datum) 0;
982 fcinfo->isnull = true;
983 }
984 else if (fcinfo->isnull)
985 {
986 retval = InputFunctionCall(&prodesc->result_in_func,
987 NULL,
988 prodesc->result_typioparam,
989 -1);
990 }
991 else if (prodesc->fn_retistuple)
992 {
993 TupleDesc td;
994 HeapTuple tup;
995 Tcl_Obj *resultObj;
996 Tcl_Obj **resultObjv;
997 Tcl_Size resultObjc;
998
999 /*
1000 * Set up data about result type. XXX it's tempting to consider
1001 * caching this in the prodesc, in the common case where the rowtype
1002 * is determined by the function not the calling query. But we'd have
1003 * to be able to deal with ADD/DROP/ALTER COLUMN events when the
1004 * result type is a named composite type, so it's not exactly trivial.
1005 * Maybe worth improving someday.
1006 */
1007 switch (get_call_result_type(fcinfo, NULL, &td))
1008 {
1009 case TYPEFUNC_COMPOSITE:
1010 /* success */
1011 break;
1012 case TYPEFUNC_COMPOSITE_DOMAIN:
1013 Assert(prodesc->fn_retisdomain);
1014 break;
1015 case TYPEFUNC_RECORD:
1016 /* failed to determine actual type of RECORD */
1017 ereport(ERROR,
1018 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1019 errmsg("function returning record called in context "
1020 "that cannot accept type record")));
1021 break;
1022 default:
1023 /* result type isn't composite? */
1024 elog(ERROR, "return type must be a row type");
1025 break;
1026 }
1027
1028 Assert(!call_state->ret_tupdesc);
1029 Assert(!call_state->attinmeta);
1030 call_state->ret_tupdesc = td;
1031 call_state->attinmeta = TupleDescGetAttInMetadata(td);
1032
1033 /* Convert function result to tuple */
1034 resultObj = Tcl_GetObjResult(interp);
1035 if (Tcl_ListObjGetElements(interp, resultObj, &resultObjc, &resultObjv) == TCL_ERROR)
1036 ereport(ERROR,
1037 (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1038 errmsg("could not parse function return value: %s",
1039 utf_u2e(Tcl_GetStringResult(interp)))));
1040
1041 tup = pltcl_build_tuple_result(interp, resultObjv, resultObjc,
1042 call_state);
1043 retval = HeapTupleGetDatum(tup);
1044 }
1045 else
1046 retval = InputFunctionCall(&prodesc->result_in_func,
1047 utf_u2e(Tcl_GetStringResult(interp)),
1048 prodesc->result_typioparam,
1049 -1);
1050
1051 return retval;
1052}
1053
1054
1055/**********************************************************************
1056 * pltcl_trigger_handler() - Handler for trigger calls
1057 **********************************************************************/
1058static HeapTuple
1059pltcl_trigger_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state,
1060 bool pltrusted)
1061{
1062 pltcl_proc_desc *prodesc;
1063 Tcl_Interp *volatile interp;
1064 TriggerData *trigdata = (TriggerData *) fcinfo->context;
1065 char *stroid;
1066 TupleDesc tupdesc;
1067 volatile HeapTuple rettup;
1068 Tcl_Obj *tcl_cmd;
1069 Tcl_Obj *tcl_trigtup;
1070 int tcl_rc;
1071 int i;
1072 const char *result;
1073 Tcl_Size result_Objc;
1074 Tcl_Obj **result_Objv;
1075 int rc PG_USED_FOR_ASSERTS_ONLY;
1076
1077 call_state->trigdata = trigdata;
1078
1079 /* Connect to SPI manager */
1080 SPI_connect();
1081
1082 /* Make transition tables visible to this SPI connection */
1083 rc = SPI_register_trigger_data(trigdata);
1084 Assert(rc >= 0);
1085
1086 /* Find or compile the function */
1087 prodesc = compile_pltcl_function(fcinfo->flinfo->fn_oid,
1088 RelationGetRelid(trigdata->tg_relation),
1089 false, /* not an event trigger */
1090 pltrusted);
1091
1092 call_state->prodesc = prodesc;
1093 prodesc->fn_refcount++;
1094
1095 interp = prodesc->interp_desc->interp;
1096
1097 tupdesc = RelationGetDescr(trigdata->tg_relation);
1098
1099 /************************************************************
1100 * Create the tcl command to call the internal
1101 * proc in the interpreter
1102 ************************************************************/
1103 tcl_cmd = Tcl_NewObj();
1104 Tcl_IncrRefCount(tcl_cmd);
1105
1106 PG_TRY();
1107 {
1108 /* The procedure name (note this is all ASCII, so no utf_e2u) */
1109 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1110 Tcl_NewStringObj(prodesc->internal_proname, -1));
1111
1112 /* The trigger name for argument TG_name */
1113 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1114 Tcl_NewStringObj(utf_e2u(trigdata->tg_trigger->tgname), -1));
1115
1116 /* The oid of the trigger relation for argument TG_relid */
1117 /* Consider not converting to a string for more performance? */
1118 stroid = DatumGetCString(DirectFunctionCall1(oidout,
1119 ObjectIdGetDatum(trigdata->tg_relation->rd_id)));
1120 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1121 Tcl_NewStringObj(stroid, -1));
1122 pfree(stroid);
1123
1124 /* The name of the table the trigger is acting on: TG_table_name */
1125 stroid = SPI_getrelname(trigdata->tg_relation);
1126 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1127 Tcl_NewStringObj(utf_e2u(stroid), -1));
1128 pfree(stroid);
1129
1130 /* The schema of the table the trigger is acting on: TG_table_schema */
1131 stroid = SPI_getnspname(trigdata->tg_relation);
1132 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1133 Tcl_NewStringObj(utf_e2u(stroid), -1));
1134 pfree(stroid);
1135
1136 /* A list of attribute names for argument TG_relatts */
1137 tcl_trigtup = Tcl_NewObj();
1138 Tcl_ListObjAppendElement(NULL, tcl_trigtup, Tcl_NewObj());
1139 for (i = 0; i < tupdesc->natts; i++)
1140 {
1141 Form_pg_attribute att = TupleDescAttr(tupdesc, i);
1142
1143 if (att->attisdropped)
1144 Tcl_ListObjAppendElement(NULL, tcl_trigtup, Tcl_NewObj());
1145 else
1146 Tcl_ListObjAppendElement(NULL, tcl_trigtup,
1147 Tcl_NewStringObj(utf_e2u(NameStr(att->attname)), -1));
1148 }
1149 Tcl_ListObjAppendElement(NULL, tcl_cmd, tcl_trigtup);
1150
1151 /* The when part of the event for TG_when */
1152 if (TRIGGER_FIRED_BEFORE(trigdata->tg_event))
1153 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1154 Tcl_NewStringObj("BEFORE", -1));
1155 else if (TRIGGER_FIRED_AFTER(trigdata->tg_event))
1156 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1157 Tcl_NewStringObj("AFTER", -1));
1158 else if (TRIGGER_FIRED_INSTEAD(trigdata->tg_event))
1159 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1160 Tcl_NewStringObj("INSTEAD OF", -1));
1161 else
1162 elog(ERROR, "unrecognized WHEN tg_event: %u", trigdata->tg_event);
1163
1164 /* The level part of the event for TG_level */
1165 if (TRIGGER_FIRED_FOR_ROW(trigdata->tg_event))
1166 {
1167 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1168 Tcl_NewStringObj("ROW", -1));
1169
1170 /*
1171 * Now the command part of the event for TG_op and data for NEW
1172 * and OLD
1173 *
1174 * Note: In BEFORE trigger, stored generated columns are not
1175 * computed yet, so don't make them accessible in NEW row.
1176 */
1177 if (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event))
1178 {
1179 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1180 Tcl_NewStringObj("INSERT", -1));
1181
1182 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1183 pltcl_build_tuple_argument(trigdata->tg_trigtuple,
1184 tupdesc,
1185 !TRIGGER_FIRED_BEFORE(trigdata->tg_event)));
1186 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
1187
1188 rettup = trigdata->tg_trigtuple;
1189 }
1190 else if (TRIGGER_FIRED_BY_DELETE(trigdata->tg_event))
1191 {
1192 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1193 Tcl_NewStringObj("DELETE", -1));
1194
1195 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
1196 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1197 pltcl_build_tuple_argument(trigdata->tg_trigtuple,
1198 tupdesc,
1199 true));
1200
1201 rettup = trigdata->tg_trigtuple;
1202 }
1203 else if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))
1204 {
1205 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1206 Tcl_NewStringObj("UPDATE", -1));
1207
1208 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1209 pltcl_build_tuple_argument(trigdata->tg_newtuple,
1210 tupdesc,
1211 !TRIGGER_FIRED_BEFORE(trigdata->tg_event)));
1212 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1213 pltcl_build_tuple_argument(trigdata->tg_trigtuple,
1214 tupdesc,
1215 true));
1216
1217 rettup = trigdata->tg_newtuple;
1218 }
1219 else
1220 elog(ERROR, "unrecognized OP tg_event: %u", trigdata->tg_event);
1221 }
1222 else if (TRIGGER_FIRED_FOR_STATEMENT(trigdata->tg_event))
1223 {
1224 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1225 Tcl_NewStringObj("STATEMENT", -1));
1226
1227 if (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event))
1228 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1229 Tcl_NewStringObj("INSERT", -1));
1230 else if (TRIGGER_FIRED_BY_DELETE(trigdata->tg_event))
1231 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1232 Tcl_NewStringObj("DELETE", -1));
1233 else if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))
1234 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1235 Tcl_NewStringObj("UPDATE", -1));
1236 else if (TRIGGER_FIRED_BY_TRUNCATE(trigdata->tg_event))
1237 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1238 Tcl_NewStringObj("TRUNCATE", -1));
1239 else
1240 elog(ERROR, "unrecognized OP tg_event: %u", trigdata->tg_event);
1241
1242 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
1243 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
1244
1245 rettup = (HeapTuple) NULL;
1246 }
1247 else
1248 elog(ERROR, "unrecognized LEVEL tg_event: %u", trigdata->tg_event);
1249
1250 /* Finally append the arguments from CREATE TRIGGER */
1251 for (i = 0; i < trigdata->tg_trigger->tgnargs; i++)
1252 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1253 Tcl_NewStringObj(utf_e2u(trigdata->tg_trigger->tgargs[i]), -1));
1254 }
1255 PG_CATCH();
1256 {
1257 Tcl_DecrRefCount(tcl_cmd);
1258 PG_RE_THROW();
1259 }
1260 PG_END_TRY();
1261
1262 /************************************************************
1263 * Call the Tcl function
1264 *
1265 * We assume no PG error can be thrown directly from this call.
1266 ************************************************************/
1267 tcl_rc = Tcl_EvalObjEx(interp, tcl_cmd, (TCL_EVAL_DIRECT | TCL_EVAL_GLOBAL));
1268
1269 /* Release refcount to free tcl_cmd (and all subsidiary objects) */
1270 Tcl_DecrRefCount(tcl_cmd);
1271
1272 /************************************************************
1273 * Check for errors reported by Tcl.
1274 ************************************************************/
1275 if (tcl_rc != TCL_OK)
1276 throw_tcl_error(interp, prodesc->user_proname);
1277
1278 /************************************************************
1279 * Exit SPI environment.
1280 ************************************************************/
1281 if (SPI_finish() != SPI_OK_FINISH)
1282 elog(ERROR, "SPI_finish() failed");
1283
1284 /************************************************************
1285 * The return value from the procedure might be one of
1286 * the magic strings OK or SKIP, or a list from array get.
1287 * We can check for OK or SKIP without worrying about encoding.
1288 ************************************************************/
1289 result = Tcl_GetStringResult(interp);
1290
1291 if (strcmp(result, "OK") == 0)
1292 return rettup;
1293 if (strcmp(result, "SKIP") == 0)
1294 return (HeapTuple) NULL;
1295
1296 /************************************************************
1297 * Otherwise, the return value should be a column name/value list
1298 * specifying the modified tuple to return.
1299 ************************************************************/
1300 if (Tcl_ListObjGetElements(interp, Tcl_GetObjResult(interp),
1301 &result_Objc, &result_Objv) != TCL_OK)
1302 ereport(ERROR,
1303 (errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
1304 errmsg("could not parse trigger return value: %s",
1305 utf_u2e(Tcl_GetStringResult(interp)))));
1306
1307 /* Convert function result to tuple */
1308 rettup = pltcl_build_tuple_result(interp, result_Objv, result_Objc,
1309 call_state);
1310
1311 return rettup;
1312}
1313
1314/**********************************************************************
1315 * pltcl_event_trigger_handler() - Handler for event trigger calls
1316 **********************************************************************/
1317static void
1318pltcl_event_trigger_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state,
1319 bool pltrusted)
1320{
1321 pltcl_proc_desc *prodesc;
1322 Tcl_Interp *volatile interp;
1323 EventTriggerData *tdata = (EventTriggerData *) fcinfo->context;
1324 Tcl_Obj *tcl_cmd;
1325 int tcl_rc;
1326
1327 /* Connect to SPI manager */
1328 SPI_connect();
1329
1330 /* Find or compile the function */
1331 prodesc = compile_pltcl_function(fcinfo->flinfo->fn_oid,
1332 InvalidOid, true, pltrusted);
1333
1334 call_state->prodesc = prodesc;
1335 prodesc->fn_refcount++;
1336
1337 interp = prodesc->interp_desc->interp;
1338
1339 /* Create the tcl command and call the internal proc */
1340 tcl_cmd = Tcl_NewObj();
1341 Tcl_IncrRefCount(tcl_cmd);
1342 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1343 Tcl_NewStringObj(prodesc->internal_proname, -1));
1344 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1345 Tcl_NewStringObj(utf_e2u(tdata->event), -1));
1346 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1347 Tcl_NewStringObj(utf_e2u(GetCommandTagName(tdata->tag)),
1348 -1));
1349
1350 tcl_rc = Tcl_EvalObjEx(interp, tcl_cmd, (TCL_EVAL_DIRECT | TCL_EVAL_GLOBAL));
1351
1352 /* Release refcount to free tcl_cmd (and all subsidiary objects) */
1353 Tcl_DecrRefCount(tcl_cmd);
1354
1355 /* Check for errors reported by Tcl. */
1356 if (tcl_rc != TCL_OK)
1357 throw_tcl_error(interp, prodesc->user_proname);
1358
1359 if (SPI_finish() != SPI_OK_FINISH)
1360 elog(ERROR, "SPI_finish() failed");
1361}
1362
1363
1364/**********************************************************************
1365 * throw_tcl_error - ereport an error returned from the Tcl interpreter
1366 *
1367 * Caution: use this only to report errors returned by Tcl_EvalObjEx() or
1368 * other variants of Tcl_Eval(). Other functions may not fill "errorInfo",
1369 * so it could be unset or even contain details from some previous error.
1370 **********************************************************************/
1371static void
1372throw_tcl_error(Tcl_Interp *interp, const char *proname)
1373{
1374 /*
1375 * Caution is needed here because Tcl_GetVar could overwrite the
1376 * interpreter result (even though it's not really supposed to), and we
1377 * can't control the order of evaluation of ereport arguments. Hence, make
1378 * real sure we have our own copy of the result string before invoking
1379 * Tcl_GetVar.
1380 */
1381 char *emsg;
1382 char *econtext;
1383 int emsglen;
1384
1385 emsg = pstrdup(utf_u2e(Tcl_GetStringResult(interp)));
1386 econtext = utf_u2e(Tcl_GetVar(interp, "errorInfo", TCL_GLOBAL_ONLY));
1387
1388 /*
1389 * Typically, the first line of errorInfo matches the primary error
1390 * message (the interpreter result); don't print that twice if so.
1391 */
1392 emsglen = strlen(emsg);
1393 if (strncmp(emsg, econtext, emsglen) == 0 &&
1394 econtext[emsglen] == '\n')
1395 econtext += emsglen + 1;
1396
1397 /* Tcl likes to prefix the next line with some spaces, too */
1398 while (*econtext == ' ')
1399 econtext++;
1400
1401 /* Note: proname will already contain quoting if any is needed */
1402 ereport(ERROR,
1403 (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1404 errmsg("%s", emsg),
1405 errcontext("%s\nin PL/Tcl function %s",
1406 econtext, proname)));
1407}
1408
1409
1410/**********************************************************************
1411 * compile_pltcl_function - compile (or hopefully just look up) function
1412 *
1413 * tgreloid is the OID of the relation when compiling a trigger, or zero
1414 * (InvalidOid) when compiling a plain function.
1415 **********************************************************************/
1416static pltcl_proc_desc *
1417compile_pltcl_function(Oid fn_oid, Oid tgreloid,
1418 bool is_event_trigger, bool pltrusted)
1419{
1420 HeapTuple procTup;
1421 Form_pg_proc procStruct;
1422 pltcl_proc_key proc_key;
1423 pltcl_proc_ptr *proc_ptr;
1424 bool found;
1425 pltcl_proc_desc *prodesc;
1426 pltcl_proc_desc *old_prodesc;
1427 volatile MemoryContext proc_cxt = NULL;
1428 Tcl_DString proc_internal_def;
1429 Tcl_DString proc_internal_name;
1430 Tcl_DString proc_internal_body;
1431
1432 /* We'll need the pg_proc tuple in any case... */
1433 procTup = SearchSysCache1(PROCOID, ObjectIdGetDatum(fn_oid));
1434 if (!HeapTupleIsValid(procTup))
1435 elog(ERROR, "cache lookup failed for function %u", fn_oid);
1436 procStruct = (Form_pg_proc) GETSTRUCT(procTup);
1437
1438 /*
1439 * Look up function in pltcl_proc_htab; if it's not there, create an entry
1440 * and set the entry's proc_ptr to NULL.
1441 */
1442 proc_key.proc_id = fn_oid;
1443 proc_key.is_trigger = OidIsValid(tgreloid);
1444 proc_key.user_id = pltrusted ? GetUserId() : InvalidOid;
1445
1446 proc_ptr = hash_search(pltcl_proc_htab, &proc_key,
1447 HASH_ENTER,
1448 &found);
1449 if (!found)
1450 proc_ptr->proc_ptr = NULL;
1451
1452 prodesc = proc_ptr->proc_ptr;
1453
1454 /************************************************************
1455 * If it's present, must check whether it's still up to date.
1456 * This is needed because CREATE OR REPLACE FUNCTION can modify the
1457 * function's pg_proc entry without changing its OID.
1458 ************************************************************/
1459 if (prodesc != NULL &&
1460 prodesc->internal_proname != NULL &&
1461 prodesc->fn_xmin == HeapTupleHeaderGetRawXmin(procTup->t_data) &&
1462 ItemPointerEquals(&prodesc->fn_tid, &procTup->t_self))
1463 {
1464 /* It's still up-to-date, so we can use it */
1465 ReleaseSysCache(procTup);
1466 return prodesc;
1467 }
1468
1469 /************************************************************
1470 * If we haven't found it in the hashtable, we analyze
1471 * the functions arguments and returntype and store
1472 * the in-/out-functions in the prodesc block and create
1473 * a new hashtable entry for it.
1474 *
1475 * Then we load the procedure into the Tcl interpreter.
1476 ************************************************************/
1477 Tcl_DStringInit(&proc_internal_def);
1478 Tcl_DStringInit(&proc_internal_name);
1479 Tcl_DStringInit(&proc_internal_body);
1480 PG_TRY();
1481 {
1482 bool is_trigger = OidIsValid(tgreloid);
1483 Tcl_CmdInfo cmdinfo;
1484 const char *user_proname;
1485 const char *internal_proname;
1486 bool need_underscore;
1487 HeapTuple typeTup;
1488 Form_pg_type typeStruct;
1489 char proc_internal_args[33 * FUNC_MAX_ARGS];
1490 Datum prosrcdatum;
1491 char *proc_source;
1492 char buf[48];
1493 pltcl_interp_desc *interp_desc;
1494 Tcl_Interp *interp;
1495 int i;
1496 int tcl_rc;
1497 MemoryContext oldcontext;
1498
1499 /************************************************************
1500 * Identify the interpreter to use for the function
1501 ************************************************************/
1502 interp_desc = pltcl_fetch_interp(procStruct->prolang, pltrusted);
1503 interp = interp_desc->interp;
1504
1505 /************************************************************
1506 * If redefining the function, try to remove the old internal
1507 * procedure from Tcl's namespace. The point of this is partly to
1508 * allow re-use of the same internal proc name, and partly to avoid
1509 * leaking the Tcl procedure object if we end up not choosing the same
1510 * name. We assume that Tcl is smart enough to not physically delete
1511 * the procedure object if it's currently being executed.
1512 ************************************************************/
1513 if (prodesc != NULL &&
1514 prodesc->internal_proname != NULL)
1515 {
1516 /* We simply ignore any error */
1517 (void) Tcl_DeleteCommand(interp, prodesc->internal_proname);
1518 /* Don't do this more than once */
1519 prodesc->internal_proname = NULL;
1520 }
1521
1522 /************************************************************
1523 * Build the proc name we'll use in error messages.
1524 ************************************************************/
1525 user_proname = format_procedure(fn_oid);
1526
1527 /************************************************************
1528 * Build the internal proc name from the user_proname and/or OID.
1529 * The internal name must be all-ASCII since we don't want to deal
1530 * with encoding conversions. We don't want to worry about Tcl
1531 * quoting rules either, so use only the characters of the function
1532 * name that are ASCII alphanumerics, plus underscores to separate
1533 * function name and arguments. If what we end up with isn't
1534 * unique (that is, it matches some existing Tcl command name),
1535 * append the function OID (perhaps repeatedly) so that it is unique.
1536 ************************************************************/
1537
1538 /* For historical reasons, use a function-type-specific prefix */
1539 if (is_event_trigger)
1540 Tcl_DStringAppend(&proc_internal_name,
1541 "__PLTcl_evttrigger_", -1);
1542 else if (is_trigger)
1543 Tcl_DStringAppend(&proc_internal_name,
1544 "__PLTcl_trigger_", -1);
1545 else
1546 Tcl_DStringAppend(&proc_internal_name,
1547 "__PLTcl_proc_", -1);
1548 /* Now add what we can from the user_proname */
1549 need_underscore = false;
1550 for (const char *ptr = user_proname; *ptr; ptr++)
1551 {
1552 if (strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1553 "abcdefghijklmnopqrstuvwxyz"
1554 "0123456789_", *ptr) != NULL)
1555 {
1556 /* Done this way to avoid adding a trailing underscore */
1557 if (need_underscore)
1558 {
1559 Tcl_DStringAppend(&proc_internal_name, "_", 1);
1560 need_underscore = false;
1561 }
1562 Tcl_DStringAppend(&proc_internal_name, ptr, 1);
1563 }
1564 else if (strchr("(, ", *ptr) != NULL)
1565 need_underscore = true;
1566 }
1567 /* If this name already exists, append fn_oid; repeat as needed */
1568 while (Tcl_GetCommandInfo(interp,
1569 Tcl_DStringValue(&proc_internal_name),
1570 &cmdinfo))
1571 {
1572 snprintf(buf, sizeof(buf), "_%u", fn_oid);
1573 Tcl_DStringAppend(&proc_internal_name, buf, -1);
1574 }
1575 internal_proname = Tcl_DStringValue(&proc_internal_name);
1576
1577 /************************************************************
1578 * Allocate a context that will hold all PG data for the procedure.
1579 ************************************************************/
1580 proc_cxt = AllocSetContextCreate(TopMemoryContext,
1581 "PL/Tcl function",
1582 ALLOCSET_SMALL_SIZES);
1583
1584 /************************************************************
1585 * Allocate and fill a new procedure description block.
1586 * struct prodesc and subsidiary data must all live in proc_cxt.
1587 ************************************************************/
1588 oldcontext = MemoryContextSwitchTo(proc_cxt);
1589 prodesc = palloc0_object(pltcl_proc_desc);
1590 prodesc->user_proname = pstrdup(user_proname);
1591 MemoryContextSetIdentifier(proc_cxt, prodesc->user_proname);
1592 prodesc->internal_proname = pstrdup(internal_proname);
1593 prodesc->fn_cxt = proc_cxt;
1594 prodesc->fn_refcount = 0;
1595 prodesc->fn_xmin = HeapTupleHeaderGetRawXmin(procTup->t_data);
1596 prodesc->fn_tid = procTup->t_self;
1597 prodesc->nargs = procStruct->pronargs;
1598 prodesc->arg_out_func = (FmgrInfo *) palloc0(prodesc->nargs * sizeof(FmgrInfo));
1599 prodesc->arg_is_rowtype = (bool *) palloc0(prodesc->nargs * sizeof(bool));
1600 MemoryContextSwitchTo(oldcontext);
1601
1602 /* Remember if function is STABLE/IMMUTABLE */
1603 prodesc->fn_readonly =
1604 (procStruct->provolatile != PROVOLATILE_VOLATILE);
1605 /* And whether it is trusted */
1606 prodesc->lanpltrusted = pltrusted;
1607 /* Save the associated interpreter, too */
1608 prodesc->interp_desc = interp_desc;
1609
1610 /************************************************************
1611 * Get the required information for input conversion of the
1612 * return value.
1613 ************************************************************/
1614 if (!is_trigger && !is_event_trigger)
1615 {
1616 Oid rettype = procStruct->prorettype;
1617
1618 typeTup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(rettype));
1619 if (!HeapTupleIsValid(typeTup))
1620 elog(ERROR, "cache lookup failed for type %u", rettype);
1621 typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
1622
1623 /* Disallow pseudotype result, except VOID and RECORD */
1624 if (typeStruct->typtype == TYPTYPE_PSEUDO)
1625 {
1626 if (rettype == VOIDOID ||
1627 rettype == RECORDOID)
1628 /* okay */ ;
1629 else if (rettype == TRIGGEROID ||
1630 rettype == EVENT_TRIGGEROID)
1631 ereport(ERROR,
1632 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1633 errmsg("trigger functions can only be called as triggers")));
1634 else
1635 ereport(ERROR,
1636 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1637 errmsg("PL/Tcl functions cannot return type %s",
1638 format_type_be(rettype))));
1639 }
1640
1641 prodesc->result_typid = rettype;
1642 fmgr_info_cxt(typeStruct->typinput,
1643 &(prodesc->result_in_func),
1644 proc_cxt);
1645 prodesc->result_typioparam = getTypeIOParam(typeTup);
1646
1647 prodesc->fn_retisset = procStruct->proretset;
1648 prodesc->fn_retistuple = type_is_rowtype(rettype);
1649 prodesc->fn_retisdomain = (typeStruct->typtype == TYPTYPE_DOMAIN);
1650 prodesc->domain_info = NULL;
1651
1652 ReleaseSysCache(typeTup);
1653 }
1654
1655 /************************************************************
1656 * Get the required information for output conversion
1657 * of all procedure arguments, and set up argument naming info.
1658 ************************************************************/
1659 if (!is_trigger && !is_event_trigger)
1660 {
1661 proc_internal_args[0] = '\0';
1662 for (i = 0; i < prodesc->nargs; i++)
1663 {
1664 Oid argtype = procStruct->proargtypes.values[i];
1665
1666 typeTup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(argtype));
1667 if (!HeapTupleIsValid(typeTup))
1668 elog(ERROR, "cache lookup failed for type %u", argtype);
1669 typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
1670
1671 /* Disallow pseudotype argument, except RECORD */
1672 if (typeStruct->typtype == TYPTYPE_PSEUDO &&
1673 argtype != RECORDOID)
1674 ereport(ERROR,
1675 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1676 errmsg("PL/Tcl functions cannot accept type %s",
1677 format_type_be(argtype))));
1678
1679 if (type_is_rowtype(argtype))
1680 {
1681 prodesc->arg_is_rowtype[i] = true;
1682 snprintf(buf, sizeof(buf), "__PLTcl_Tup_%d", i + 1);
1683 }
1684 else
1685 {
1686 prodesc->arg_is_rowtype[i] = false;
1687 fmgr_info_cxt(typeStruct->typoutput,
1688 &(prodesc->arg_out_func[i]),
1689 proc_cxt);
1690 snprintf(buf, sizeof(buf), "%d", i + 1);
1691 }
1692
1693 if (i > 0)
1694 strcat(proc_internal_args, " ");
1695 strcat(proc_internal_args, buf);
1696
1697 ReleaseSysCache(typeTup);
1698 }
1699 }
1700 else if (is_trigger)
1701 {
1702 /* trigger procedure has fixed args */
1703 strcpy(proc_internal_args,
1704 "TG_name TG_relid TG_table_name TG_table_schema TG_relatts TG_when TG_level TG_op __PLTcl_Tup_NEW __PLTcl_Tup_OLD args");
1705 }
1706 else if (is_event_trigger)
1707 {
1708 /* event trigger procedure has fixed args */
1709 strcpy(proc_internal_args, "TG_event TG_tag");
1710 }
1711
1712 /************************************************************
1713 * Create the tcl command to define the internal
1714 * procedure
1715 *
1716 * Leave this code as DString - performance is not critical here,
1717 * and we don't want to duplicate the knowledge of the Tcl quoting
1718 * rules that's embedded in Tcl_DStringAppendElement.
1719 ************************************************************/
1720 Tcl_DStringAppendElement(&proc_internal_def, "proc");
1721 Tcl_DStringAppendElement(&proc_internal_def, internal_proname);
1722 Tcl_DStringAppendElement(&proc_internal_def, proc_internal_args);
1723
1724 /************************************************************
1725 * prefix procedure body with
1726 * upvar #0 <internal_proname> GD
1727 * and with appropriate setting of arguments
1728 ************************************************************/
1729 Tcl_DStringAppend(&proc_internal_body, "upvar #0 ", -1);
1730 Tcl_DStringAppend(&proc_internal_body, internal_proname, -1);
1731 Tcl_DStringAppend(&proc_internal_body, " GD\n", -1);
1732 if (is_trigger)
1733 {
1734 Tcl_DStringAppend(&proc_internal_body,
1735 "array set NEW $__PLTcl_Tup_NEW\n", -1);
1736 Tcl_DStringAppend(&proc_internal_body,
1737 "array set OLD $__PLTcl_Tup_OLD\n", -1);
1738 Tcl_DStringAppend(&proc_internal_body,
1739 "set i 0\n"
1740 "set v 0\n"
1741 "foreach v $args {\n"
1742 " incr i\n"
1743 " set $i $v\n"
1744 "}\n"
1745 "unset i v\n\n", -1);
1746 }
1747 else if (is_event_trigger)
1748 {
1749 /* no argument support for event triggers */
1750 }
1751 else
1752 {
1753 for (i = 0; i < prodesc->nargs; i++)
1754 {
1755 if (prodesc->arg_is_rowtype[i])
1756 {
1757 snprintf(buf, sizeof(buf),
1758 "array set %d $__PLTcl_Tup_%d\n",
1759 i + 1, i + 1);
1760 Tcl_DStringAppend(&proc_internal_body, buf, -1);
1761 }
1762 }
1763 }
1764
1765 /************************************************************
1766 * Add user's function definition to proc body
1767 ************************************************************/
1768 prosrcdatum = SysCacheGetAttrNotNull(PROCOID, procTup,
1769 Anum_pg_proc_prosrc);
1770 proc_source = TextDatumGetCString(prosrcdatum);
1771 UTF_BEGIN;
1772 Tcl_DStringAppend(&proc_internal_body, UTF_E2U(proc_source), -1);
1773 UTF_END;
1774 pfree(proc_source);
1775 Tcl_DStringAppendElement(&proc_internal_def,
1776 Tcl_DStringValue(&proc_internal_body));
1777
1778 /************************************************************
1779 * Create the procedure in the interpreter
1780 ************************************************************/
1781 tcl_rc = Tcl_EvalEx(interp,
1782 Tcl_DStringValue(&proc_internal_def),
1783 Tcl_DStringLength(&proc_internal_def),
1784 TCL_EVAL_GLOBAL);
1785 if (tcl_rc != TCL_OK)
1786 ereport(ERROR,
1787 (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1788 errmsg("could not create internal procedure \"%s\": %s",
1789 internal_proname,
1790 utf_u2e(Tcl_GetStringResult(interp)))));
1791 }
1792 PG_CATCH();
1793 {
1794 /*
1795 * If we failed anywhere above, clean up whatever got allocated. It
1796 * should all be in the proc_cxt, except for the DStrings.
1797 */
1798 if (proc_cxt)
1799 MemoryContextDelete(proc_cxt);
1800 Tcl_DStringFree(&proc_internal_def);
1801 Tcl_DStringFree(&proc_internal_name);
1802 Tcl_DStringFree(&proc_internal_body);
1803 PG_RE_THROW();
1804 }
1805 PG_END_TRY();
1806
1807 /*
1808 * Install the new proc description block in the hashtable, incrementing
1809 * its refcount (the hashtable link counts as a reference). Then, if
1810 * there was a previous definition of the function, decrement that one's
1811 * refcount, and delete it if no longer referenced. The order of
1812 * operations here is important: if something goes wrong during the
1813 * MemoryContextDelete, leaking some memory for the old definition is OK,
1814 * but we don't want to corrupt the live hashtable entry. (Likewise,
1815 * freeing the DStrings is pretty low priority if that happens.)
1816 */
1817 old_prodesc = proc_ptr->proc_ptr;
1818
1819 proc_ptr->proc_ptr = prodesc;
1820 prodesc->fn_refcount++;
1821
1822 if (old_prodesc != NULL)
1823 {
1824 Assert(old_prodesc->fn_refcount > 0);
1825 if (--old_prodesc->fn_refcount == 0)
1826 MemoryContextDelete(old_prodesc->fn_cxt);
1827 }
1828
1829 Tcl_DStringFree(&proc_internal_def);
1830 Tcl_DStringFree(&proc_internal_name);
1831 Tcl_DStringFree(&proc_internal_body);
1832
1833 ReleaseSysCache(procTup);
1834
1835 return prodesc;
1836}
1837
1838
1839/**********************************************************************
1840 * pltcl_elog() - elog() support for PLTcl
1841 **********************************************************************/
1842static int
1843pltcl_elog(ClientData cdata, Tcl_Interp *interp,
1844 int objc, Tcl_Obj *const objv[])
1845{
1846 volatile int level;
1847 MemoryContext oldcontext;
1848 int priIndex;
1849
1850 static const char *logpriorities[] = {
1851 "DEBUG", "LOG", "INFO", "NOTICE",
1852 "WARNING", "ERROR", "FATAL", (const char *) NULL
1853 };
1854
1855 static const int loglevels[] = {
1856 DEBUG2, LOG, INFO, NOTICE,
1857 WARNING, ERROR, FATAL
1858 };
1859
1860 if (objc != 3)
1861 {
1862 Tcl_WrongNumArgs(interp, 1, objv, "level msg");
1863 return TCL_ERROR;
1864 }
1865
1866 if (Tcl_GetIndexFromObj(interp, objv[1], logpriorities, "priority",
1867 TCL_EXACT, &priIndex) != TCL_OK)
1868 return TCL_ERROR;
1869
1870 level = loglevels[priIndex];
1871
1872 if (level == ERROR)
1873 {
1874 /*
1875 * We just pass the error back to Tcl. If it's not caught, it'll
1876 * eventually get converted to a PG error when we reach the call
1877 * handler.
1878 */
1879 Tcl_SetObjResult(interp, objv[2]);
1880 return TCL_ERROR;
1881 }
1882
1883 /*
1884 * For non-error messages, just pass 'em to ereport(). We do not expect
1885 * that this will fail, but just on the off chance it does, report the
1886 * error back to Tcl. Note we are assuming that ereport() can't have any
1887 * internal failures that are so bad as to require a transaction abort.
1888 *
1889 * This path is also used for FATAL errors, which aren't going to come
1890 * back to us at all.
1891 */
1892 oldcontext = CurrentMemoryContext;
1893 PG_TRY();
1894 {
1895 UTF_BEGIN;
1896 ereport(level,
1897 (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1898 errmsg("%s", UTF_U2E(Tcl_GetString(objv[2])))));
1899 UTF_END;
1900 }
1901 PG_CATCH();
1902 {
1903 ErrorData *edata;
1904
1905 /* Must reset elog.c's state */
1906 MemoryContextSwitchTo(oldcontext);
1907 edata = CopyErrorData();
1908 FlushErrorState();
1909
1910 /* Pass the error data to Tcl */
1911 pltcl_construct_errorCode(interp, edata);
1912 UTF_BEGIN;
1913 Tcl_SetObjResult(interp, Tcl_NewStringObj(UTF_E2U(edata->message), -1));
1914 UTF_END;
1915 FreeErrorData(edata);
1916
1917 return TCL_ERROR;
1918 }
1919 PG_END_TRY();
1920
1921 return TCL_OK;
1922}
1923
1924
1925/**********************************************************************
1926 * pltcl_construct_errorCode() - construct a Tcl errorCode
1927 * list with detailed information from the PostgreSQL server
1928 **********************************************************************/
1929static void
1930pltcl_construct_errorCode(Tcl_Interp *interp, ErrorData *edata)
1931{
1932 Tcl_Obj *obj = Tcl_NewObj();
1933
1934 Tcl_ListObjAppendElement(interp, obj,
1935 Tcl_NewStringObj("POSTGRES", -1));
1936 Tcl_ListObjAppendElement(interp, obj,
1937 Tcl_NewStringObj(PG_VERSION, -1));
1938 Tcl_ListObjAppendElement(interp, obj,
1939 Tcl_NewStringObj("SQLSTATE", -1));
1940 Tcl_ListObjAppendElement(interp, obj,
1941 Tcl_NewStringObj(unpack_sql_state(edata->sqlerrcode), -1));
1942 Tcl_ListObjAppendElement(interp, obj,
1943 Tcl_NewStringObj("condition", -1));
1944 Tcl_ListObjAppendElement(interp, obj,
1945 Tcl_NewStringObj(pltcl_get_condition_name(edata->sqlerrcode), -1));
1946 Tcl_ListObjAppendElement(interp, obj,
1947 Tcl_NewStringObj("message", -1));
1948 UTF_BEGIN;
1949 Tcl_ListObjAppendElement(interp, obj,
1950 Tcl_NewStringObj(UTF_E2U(edata->message), -1));
1951 UTF_END;
1952 if (edata->detail)
1953 {
1954 Tcl_ListObjAppendElement(interp, obj,
1955 Tcl_NewStringObj("detail", -1));
1956 UTF_BEGIN;
1957 Tcl_ListObjAppendElement(interp, obj,
1958 Tcl_NewStringObj(UTF_E2U(edata->detail), -1));
1959 UTF_END;
1960 }
1961 if (edata->hint)
1962 {
1963 Tcl_ListObjAppendElement(interp, obj,
1964 Tcl_NewStringObj("hint", -1));
1965 UTF_BEGIN;
1966 Tcl_ListObjAppendElement(interp, obj,
1967 Tcl_NewStringObj(UTF_E2U(edata->hint), -1));
1968 UTF_END;
1969 }
1970 if (edata->context)
1971 {
1972 Tcl_ListObjAppendElement(interp, obj,
1973 Tcl_NewStringObj("context", -1));
1974 UTF_BEGIN;
1975 Tcl_ListObjAppendElement(interp, obj,
1976 Tcl_NewStringObj(UTF_E2U(edata->context), -1));
1977 UTF_END;
1978 }
1979 if (edata->schema_name)
1980 {
1981 Tcl_ListObjAppendElement(interp, obj,
1982 Tcl_NewStringObj("schema", -1));
1983 UTF_BEGIN;
1984 Tcl_ListObjAppendElement(interp, obj,
1985 Tcl_NewStringObj(UTF_E2U(edata->schema_name), -1));
1986 UTF_END;
1987 }
1988 if (edata->table_name)
1989 {
1990 Tcl_ListObjAppendElement(interp, obj,
1991 Tcl_NewStringObj("table", -1));
1992 UTF_BEGIN;
1993 Tcl_ListObjAppendElement(interp, obj,
1994 Tcl_NewStringObj(UTF_E2U(edata->table_name), -1));
1995 UTF_END;
1996 }
1997 if (edata->column_name)
1998 {
1999 Tcl_ListObjAppendElement(interp, obj,
2000 Tcl_NewStringObj("column", -1));
2001 UTF_BEGIN;
2002 Tcl_ListObjAppendElement(interp, obj,
2003 Tcl_NewStringObj(UTF_E2U(edata->column_name), -1));
2004 UTF_END;
2005 }
2006 if (edata->datatype_name)
2007 {
2008 Tcl_ListObjAppendElement(interp, obj,
2009 Tcl_NewStringObj("datatype", -1));
2010 UTF_BEGIN;
2011 Tcl_ListObjAppendElement(interp, obj,
2012 Tcl_NewStringObj(UTF_E2U(edata->datatype_name), -1));
2013 UTF_END;
2014 }
2015 if (edata->constraint_name)
2016 {
2017 Tcl_ListObjAppendElement(interp, obj,
2018 Tcl_NewStringObj("constraint", -1));
2019 UTF_BEGIN;
2020 Tcl_ListObjAppendElement(interp, obj,
2021 Tcl_NewStringObj(UTF_E2U(edata->constraint_name), -1));
2022 UTF_END;
2023 }
2024 /* cursorpos is never interesting here; report internal query/pos */
2025 if (edata->internalquery)
2026 {
2027 Tcl_ListObjAppendElement(interp, obj,
2028 Tcl_NewStringObj("statement", -1));
2029 UTF_BEGIN;
2030 Tcl_ListObjAppendElement(interp, obj,
2031 Tcl_NewStringObj(UTF_E2U(edata->internalquery), -1));
2032 UTF_END;
2033 }
2034 if (edata->internalpos > 0)
2035 {
2036 Tcl_ListObjAppendElement(interp, obj,
2037 Tcl_NewStringObj("cursor_position", -1));
2038 Tcl_ListObjAppendElement(interp, obj,
2039 Tcl_NewIntObj(edata->internalpos));
2040 }
2041 if (edata->filename)
2042 {
2043 Tcl_ListObjAppendElement(interp, obj,
2044 Tcl_NewStringObj("filename", -1));
2045 UTF_BEGIN;
2046 Tcl_ListObjAppendElement(interp, obj,
2047 Tcl_NewStringObj(UTF_E2U(edata->filename), -1));
2048 UTF_END;
2049 }
2050 if (edata->lineno > 0)
2051 {
2052 Tcl_ListObjAppendElement(interp, obj,
2053 Tcl_NewStringObj("lineno", -1));
2054 Tcl_ListObjAppendElement(interp, obj,
2055 Tcl_NewIntObj(edata->lineno));
2056 }
2057 if (edata->funcname)
2058 {
2059 Tcl_ListObjAppendElement(interp, obj,
2060 Tcl_NewStringObj("funcname", -1));
2061 UTF_BEGIN;
2062 Tcl_ListObjAppendElement(interp, obj,
2063 Tcl_NewStringObj(UTF_E2U(edata->funcname), -1));
2064 UTF_END;
2065 }
2066
2067 Tcl_SetObjErrorCode(interp, obj);
2068}
2069
2070
2071/**********************************************************************
2072 * pltcl_get_condition_name() - find name for SQLSTATE
2073 **********************************************************************/
2074static const char *
2075pltcl_get_condition_name(int sqlstate)
2076{
2077 int i;
2078
2079 for (i = 0; exception_name_map[i].label != NULL; i++)
2080 {
2081 if (exception_name_map[i].sqlerrstate == sqlstate)
2082 return exception_name_map[i].label;
2083 }
2084 return "unrecognized_sqlstate";
2085}
2086
2087
2088/**********************************************************************
2089 * pltcl_quote() - quote literal strings that are to
2090 * be used in SPI_execute query strings
2091 **********************************************************************/
2092static int
2093pltcl_quote(ClientData cdata, Tcl_Interp *interp,
2094 int objc, Tcl_Obj *const objv[])
2095{
2096 char *tmp;
2097 const char *cp1;
2098 char *cp2;
2099 Tcl_Size length;
2100
2101 /************************************************************
2102 * Check call syntax
2103 ************************************************************/
2104 if (objc != 2)
2105 {
2106 Tcl_WrongNumArgs(interp, 1, objv, "string");
2107 return TCL_ERROR;
2108 }
2109
2110 /************************************************************
2111 * Allocate space for the maximum the string can
2112 * grow to and initialize pointers
2113 ************************************************************/
2114 cp1 = Tcl_GetStringFromObj(objv[1], &length);
2115 tmp = palloc(length * 2 + 1);
2116 cp2 = tmp;
2117
2118 /************************************************************
2119 * Walk through string and double every quote and backslash
2120 ************************************************************/
2121 while (*cp1)
2122 {
2123 if (*cp1 == '\'')
2124 *cp2++ = '\'';
2125 else
2126 {
2127 if (*cp1 == '\\')
2128 *cp2++ = '\\';
2129 }
2130 *cp2++ = *cp1++;
2131 }
2132
2133 /************************************************************
2134 * Terminate the string and set it as result
2135 ************************************************************/
2136 *cp2 = '\0';
2137 Tcl_SetObjResult(interp, Tcl_NewStringObj(tmp, -1));
2138 pfree(tmp);
2139 return TCL_OK;
2140}
2141
2142
2143/**********************************************************************
2144 * pltcl_argisnull() - determine if a specific argument is NULL
2145 **********************************************************************/
2146static int
2147pltcl_argisnull(ClientData cdata, Tcl_Interp *interp,
2148 int objc, Tcl_Obj *const objv[])
2149{
2150 int argno;
2151 FunctionCallInfo fcinfo = pltcl_current_call_state->fcinfo;
2152
2153 /************************************************************
2154 * Check call syntax
2155 ************************************************************/
2156 if (objc != 2)
2157 {
2158 Tcl_WrongNumArgs(interp, 1, objv, "argno");
2159 return TCL_ERROR;
2160 }
2161
2162 /************************************************************
2163 * Check that we're called as a normal function
2164 ************************************************************/
2165 if (fcinfo == NULL)
2166 {
2167 Tcl_SetObjResult(interp,
2168 Tcl_NewStringObj("argisnull cannot be used in triggers", -1));
2169 return TCL_ERROR;
2170 }
2171
2172 /************************************************************
2173 * Get the argument number
2174 ************************************************************/
2175 if (Tcl_GetIntFromObj(interp, objv[1], &argno) != TCL_OK)
2176 return TCL_ERROR;
2177
2178 /************************************************************
2179 * Check that the argno is valid
2180 ************************************************************/
2181 argno--;
2182 if (argno < 0 || argno >= fcinfo->nargs)
2183 {
2184 Tcl_SetObjResult(interp,
2185 Tcl_NewStringObj("argno out of range", -1));
2186 return TCL_ERROR;
2187 }
2188
2189 /************************************************************
2190 * Get the requested NULL state
2191 ************************************************************/
2192 Tcl_SetObjResult(interp, Tcl_NewBooleanObj(PG_ARGISNULL(argno)));
2193 return TCL_OK;
2194}
2195
2196
2197/**********************************************************************
2198 * pltcl_returnnull() - Cause a NULL return from the current function
2199 **********************************************************************/
2200static int
2201pltcl_returnnull(ClientData cdata, Tcl_Interp *interp,
2202 int objc, Tcl_Obj *const objv[])
2203{
2204 FunctionCallInfo fcinfo = pltcl_current_call_state->fcinfo;
2205
2206 /************************************************************
2207 * Check call syntax
2208 ************************************************************/
2209 if (objc != 1)
2210 {
2211 Tcl_WrongNumArgs(interp, 1, objv, "");
2212 return TCL_ERROR;
2213 }
2214
2215 /************************************************************
2216 * Check that we're called as a normal function
2217 ************************************************************/
2218 if (fcinfo == NULL)
2219 {
2220 Tcl_SetObjResult(interp,
2221 Tcl_NewStringObj("return_null cannot be used in triggers", -1));
2222 return TCL_ERROR;
2223 }
2224
2225 /************************************************************
2226 * Set the NULL return flag and cause Tcl to return from the
2227 * procedure.
2228 ************************************************************/
2229 fcinfo->isnull = true;
2230
2231 return TCL_RETURN;
2232}
2233
2234
2235/**********************************************************************
2236 * pltcl_returnnext() - Add a row to the result tuplestore in a SRF.
2237 **********************************************************************/
2238static int
2239pltcl_returnnext(ClientData cdata, Tcl_Interp *interp,
2240 int objc, Tcl_Obj *const objv[])
2241{
2242 pltcl_call_state *call_state = pltcl_current_call_state;
2243 FunctionCallInfo fcinfo = call_state->fcinfo;
2244 pltcl_proc_desc *prodesc = call_state->prodesc;
2245 MemoryContext oldcontext = CurrentMemoryContext;
2246 ResourceOwner oldowner = CurrentResourceOwner;
2247 volatile int result = TCL_OK;
2248
2249 /*
2250 * Check that we're called as a set-returning function
2251 */
2252 if (fcinfo == NULL)
2253 {
2254 Tcl_SetObjResult(interp,
2255 Tcl_NewStringObj("return_next cannot be used in triggers", -1));
2256 return TCL_ERROR;
2257 }
2258
2259 if (!prodesc->fn_retisset)
2260 {
2261 Tcl_SetObjResult(interp,
2262 Tcl_NewStringObj("return_next cannot be used in non-set-returning functions", -1));
2263 return TCL_ERROR;
2264 }
2265
2266 /*
2267 * Check call syntax
2268 */
2269 if (objc != 2)
2270 {
2271 Tcl_WrongNumArgs(interp, 1, objv, "result");
2272 return TCL_ERROR;
2273 }
2274
2275 /*
2276 * The rest might throw elog(ERROR), so must run in a subtransaction.
2277 *
2278 * A small advantage of using a subtransaction is that it provides a
2279 * short-lived memory context for free, so we needn't worry about leaking
2280 * memory here. To use that context, call BeginInternalSubTransaction
2281 * directly instead of going through pltcl_subtrans_begin.
2282 */
2283 BeginInternalSubTransaction(NULL);
2284 PG_TRY();
2285 {
2286 /* Set up tuple store if first output row */
2287 if (call_state->tuple_store == NULL)
2288 pltcl_init_tuple_store(call_state);
2289
2290 if (prodesc->fn_retistuple)
2291 {
2292 Tcl_Obj **rowObjv;
2293 Tcl_Size rowObjc;
2294
2295 /* result should be a list, so break it down */
2296 if (Tcl_ListObjGetElements(interp, objv[1], &rowObjc, &rowObjv) == TCL_ERROR)
2297 result = TCL_ERROR;
2298 else
2299 {
2300 HeapTuple tuple;
2301
2302 tuple = pltcl_build_tuple_result(interp, rowObjv, rowObjc,
2303 call_state);
2304 tuplestore_puttuple(call_state->tuple_store, tuple);
2305 }
2306 }
2307 else
2308 {
2309 Datum retval;
2310 bool isNull = false;
2311
2312 /* for paranoia's sake, check that tupdesc has exactly one column */
2313 if (call_state->ret_tupdesc->natts != 1)
2314 elog(ERROR, "wrong result type supplied in return_next");
2315
2316 retval = InputFunctionCall(&prodesc->result_in_func,
2317 utf_u2e((char *) Tcl_GetString(objv[1])),
2318 prodesc->result_typioparam,
2319 -1);
2320 tuplestore_putvalues(call_state->tuple_store, call_state->ret_tupdesc,
2321 &retval, &isNull);
2322 }
2323
2324 pltcl_subtrans_commit(oldcontext, oldowner);
2325 }
2326 PG_CATCH();
2327 {
2328 pltcl_subtrans_abort(interp, oldcontext, oldowner);
2329 return TCL_ERROR;
2330 }
2331 PG_END_TRY();
2332
2333 return result;
2334}
2335
2336
2337/*----------
2338 * Support for running SPI operations inside subtransactions
2339 *
2340 * Intended usage pattern is:
2341 *
2342 * MemoryContext oldcontext = CurrentMemoryContext;
2343 * ResourceOwner oldowner = CurrentResourceOwner;
2344 *
2345 * ...
2346 * pltcl_subtrans_begin(oldcontext, oldowner);
2347 * PG_TRY();
2348 * {
2349 * do something risky;
2350 * pltcl_subtrans_commit(oldcontext, oldowner);
2351 * }
2352 * PG_CATCH();
2353 * {
2354 * pltcl_subtrans_abort(interp, oldcontext, oldowner);
2355 * return TCL_ERROR;
2356 * }
2357 * PG_END_TRY();
2358 * return TCL_OK;
2359 *----------
2360 */
2361static void
2362pltcl_subtrans_begin(MemoryContext oldcontext, ResourceOwner oldowner)
2363{
2364 BeginInternalSubTransaction(NULL);
2365
2366 /* Want to run inside function's memory context */
2367 MemoryContextSwitchTo(oldcontext);
2368}
2369
2370static void
2371pltcl_subtrans_commit(MemoryContext oldcontext, ResourceOwner oldowner)
2372{
2373 /* Commit the inner transaction, return to outer xact context */
2374 ReleaseCurrentSubTransaction();
2375 MemoryContextSwitchTo(oldcontext);
2376 CurrentResourceOwner = oldowner;
2377}
2378
2379static void
2380pltcl_subtrans_abort(Tcl_Interp *interp,
2381 MemoryContext oldcontext, ResourceOwner oldowner)
2382{
2383 ErrorData *edata;
2384
2385 /* Save error info */
2386 MemoryContextSwitchTo(oldcontext);
2387 edata = CopyErrorData();
2388 FlushErrorState();
2389
2390 /* Abort the inner transaction */
2391 RollbackAndReleaseCurrentSubTransaction();
2392 MemoryContextSwitchTo(oldcontext);
2393 CurrentResourceOwner = oldowner;
2394
2395 /* Pass the error data to Tcl */
2396 pltcl_construct_errorCode(interp, edata);
2397 UTF_BEGIN;
2398 Tcl_SetObjResult(interp, Tcl_NewStringObj(UTF_E2U(edata->message), -1));
2399 UTF_END;
2400 FreeErrorData(edata);
2401}
2402
2403
2404/**********************************************************************
2405 * pltcl_SPI_execute() - The builtin SPI_execute command
2406 * for the Tcl interpreter
2407 **********************************************************************/
2408static int
2409pltcl_SPI_execute(ClientData cdata, Tcl_Interp *interp,
2410 int objc, Tcl_Obj *const objv[])
2411{
2412 int my_rc;
2413 int spi_rc;
2414 int query_idx;
2415 int i;
2416 int optIndex;
2417 int count = 0;
2418 const char *volatile arrayname = NULL;
2419 Tcl_Obj *volatile loop_body = NULL;
2420 MemoryContext oldcontext = CurrentMemoryContext;
2421 ResourceOwner oldowner = CurrentResourceOwner;
2422
2423 enum options
2424 {
2425 OPT_ARRAY, OPT_COUNT
2426 };
2427
2428 static const char *options[] = {
2429 "-array", "-count", (const char *) NULL
2430 };
2431
2432 /************************************************************
2433 * Check the call syntax and get the options
2434 ************************************************************/
2435 if (objc < 2)
2436 {
2437 Tcl_WrongNumArgs(interp, 1, objv,
2438 "?-count n? ?-array name? query ?loop body?");
2439 return TCL_ERROR;
2440 }
2441
2442 i = 1;
2443 while (i < objc)
2444 {
2445 if (Tcl_GetIndexFromObj(NULL, objv[i], options, NULL,
2446 TCL_EXACT, &optIndex) != TCL_OK)
2447 break;
2448
2449 if (++i >= objc)
2450 {
2451 Tcl_SetObjResult(interp,
2452 Tcl_NewStringObj("missing argument to -count or -array", -1));
2453 return TCL_ERROR;
2454 }
2455
2456 switch ((enum options) optIndex)
2457 {
2458 case OPT_ARRAY:
2459 arrayname = Tcl_GetString(objv[i++]);
2460 break;
2461
2462 case OPT_COUNT:
2463 if (Tcl_GetIntFromObj(interp, objv[i++], &count) != TCL_OK)
2464 return TCL_ERROR;
2465 break;
2466 }
2467 }
2468
2469 query_idx = i;
2470 if (query_idx >= objc || query_idx + 2 < objc)
2471 {
2472 Tcl_WrongNumArgs(interp, query_idx - 1, objv, "query ?loop body?");
2473 return TCL_ERROR;
2474 }
2475
2476 if (query_idx + 1 < objc)
2477 loop_body = objv[query_idx + 1];
2478
2479 /************************************************************
2480 * Execute the query inside a sub-transaction, so we can cope with
2481 * errors sanely
2482 ************************************************************/
2483
2484 pltcl_subtrans_begin(oldcontext, oldowner);
2485
2486 PG_TRY();
2487 {
2488 UTF_BEGIN;
2489 spi_rc = SPI_execute(UTF_U2E(Tcl_GetString(objv[query_idx])),
2490 pltcl_current_call_state->prodesc->fn_readonly, count);
2491 UTF_END;
2492
2493 my_rc = pltcl_process_SPI_result(interp,
2494 arrayname,
2495 loop_body,
2496 spi_rc,
2497 SPI_tuptable,
2498 SPI_processed);
2499
2500 pltcl_subtrans_commit(oldcontext, oldowner);
2501 }
2502 PG_CATCH();
2503 {
2504 pltcl_subtrans_abort(interp, oldcontext, oldowner);
2505 return TCL_ERROR;
2506 }
2507 PG_END_TRY();
2508
2509 return my_rc;
2510}
2511
2512/*
2513 * Process the result from SPI_execute or SPI_execute_plan
2514 *
2515 * Shared code between pltcl_SPI_execute and pltcl_SPI_execute_plan
2516 */
2517static int
2518pltcl_process_SPI_result(Tcl_Interp *interp,
2519 const char *arrayname,
2520 Tcl_Obj *loop_body,
2521 int spi_rc,
2522 SPITupleTable *tuptable,
2523 uint64 ntuples)
2524{
2525 int my_rc = TCL_OK;
2526 int loop_rc;
2527 HeapTuple *tuples;
2528 TupleDesc tupdesc;
2529
2530 switch (spi_rc)
2531 {
2532 case SPI_OK_SELINTO:
2533 case SPI_OK_INSERT:
2534 case SPI_OK_DELETE:
2535 case SPI_OK_UPDATE:
2536 case SPI_OK_MERGE:
2537 Tcl_SetObjResult(interp, Tcl_NewWideIntObj(ntuples));
2538 break;
2539
2540 case SPI_OK_UTILITY:
2541 case SPI_OK_REWRITTEN:
2542 if (tuptable == NULL)
2543 {
2544 Tcl_SetObjResult(interp, Tcl_NewIntObj(0));
2545 break;
2546 }
2547 /* fall through for utility returning tuples */
2548 pg_fallthrough;
2549
2550 case SPI_OK_SELECT:
2551 case SPI_OK_INSERT_RETURNING:
2552 case SPI_OK_DELETE_RETURNING:
2553 case SPI_OK_UPDATE_RETURNING:
2554 case SPI_OK_MERGE_RETURNING:
2555
2556 /*
2557 * Process the tuples we got
2558 */
2559 tuples = tuptable->vals;
2560 tupdesc = tuptable->tupdesc;
2561
2562 if (loop_body == NULL)
2563 {
2564 /*
2565 * If there is no loop body given, just set the variables from
2566 * the first tuple (if any)
2567 */
2568 if (ntuples > 0)
2569 pltcl_set_tuple_values(interp, arrayname, 0,
2570 tuples[0], tupdesc);
2571 }
2572 else
2573 {
2574 /*
2575 * There is a loop body - process all tuples and evaluate the
2576 * body on each
2577 */
2578 uint64 i;
2579
2580 for (i = 0; i < ntuples; i++)
2581 {
2582 pltcl_set_tuple_values(interp, arrayname, i,
2583 tuples[i], tupdesc);
2584
2585 loop_rc = Tcl_EvalObjEx(interp, loop_body, 0);
2586
2587 if (loop_rc == TCL_OK)
2588 continue;
2589 if (loop_rc == TCL_CONTINUE)
2590 continue;
2591 if (loop_rc == TCL_RETURN)
2592 {
2593 my_rc = TCL_RETURN;
2594 break;
2595 }
2596 if (loop_rc == TCL_BREAK)
2597 break;
2598 my_rc = TCL_ERROR;
2599 break;
2600 }
2601 }
2602
2603 if (my_rc == TCL_OK)
2604 {
2605 Tcl_SetObjResult(interp, Tcl_NewWideIntObj(ntuples));
2606 }
2607 break;
2608
2609 default:
2610 Tcl_AppendResult(interp, "pltcl: SPI_execute failed: ",
2611 SPI_result_code_string(spi_rc), NULL);
2612 my_rc = TCL_ERROR;
2613 break;
2614 }
2615
2616 SPI_freetuptable(tuptable);
2617
2618 return my_rc;
2619}
2620
2621
2622/**********************************************************************
2623 * pltcl_SPI_prepare() - Builtin support for prepared plans
2624 * The Tcl command SPI_prepare
2625 * always saves the plan using
2626 * SPI_keepplan and returns a key for
2627 * access. There is no chance to prepare
2628 * and not save the plan currently.
2629 **********************************************************************/
2630static int
2631pltcl_SPI_prepare(ClientData cdata, Tcl_Interp *interp,
2632 int objc, Tcl_Obj *const objv[])
2633{
2634 volatile MemoryContext plan_cxt = NULL;
2635 Tcl_Size nargs;
2636 Tcl_Obj **argsObj;
2637 pltcl_query_desc *qdesc;
2638 int i;
2639 Tcl_HashEntry *hashent;
2640 int hashnew;
2641 Tcl_HashTable *query_hash;
2642 MemoryContext oldcontext = CurrentMemoryContext;
2643 ResourceOwner oldowner = CurrentResourceOwner;
2644
2645 /************************************************************
2646 * Check the call syntax
2647 ************************************************************/
2648 if (objc != 3)
2649 {
2650 Tcl_WrongNumArgs(interp, 1, objv, "query argtypes");
2651 return TCL_ERROR;
2652 }
2653
2654 /************************************************************
2655 * Split the argument type list
2656 ************************************************************/
2657 if (Tcl_ListObjGetElements(interp, objv[2], &nargs, &argsObj) != TCL_OK)
2658 return TCL_ERROR;
2659
2660 /************************************************************
2661 * Allocate the new querydesc structure
2662 *
2663 * struct qdesc and subsidiary data all live in plan_cxt. Note that if the
2664 * function is recompiled for whatever reason, permanent memory leaks
2665 * occur. FIXME someday.
2666 ************************************************************/
2667 plan_cxt = AllocSetContextCreate(TopMemoryContext,
2668 "PL/Tcl spi_prepare query",
2669 ALLOCSET_SMALL_SIZES);
2670 MemoryContextSwitchTo(plan_cxt);
2671 qdesc = palloc0_object(pltcl_query_desc);
2672 snprintf(qdesc->qname, sizeof(qdesc->qname), "%p", qdesc);
2673 qdesc->nargs = nargs;
2674 qdesc->argtypes = (Oid *) palloc(nargs * sizeof(Oid));
2675 qdesc->arginfuncs = (FmgrInfo *) palloc(nargs * sizeof(FmgrInfo));
2676 qdesc->argtypioparams = (Oid *) palloc(nargs * sizeof(Oid));
2677 MemoryContextSwitchTo(oldcontext);
2678
2679 /************************************************************
2680 * Execute the prepare inside a sub-transaction, so we can cope with
2681 * errors sanely
2682 ************************************************************/
2683
2684 pltcl_subtrans_begin(oldcontext, oldowner);
2685
2686 PG_TRY();
2687 {
2688 /************************************************************
2689 * Resolve argument type names and then look them up by oid
2690 * in the system cache, and remember the required information
2691 * for input conversion.
2692 ************************************************************/
2693 for (i = 0; i < nargs; i++)
2694 {
2695 Oid typId,
2696 typInput,
2697 typIOParam;
2698 int32 typmod;
2699
2700 (void) parseTypeString(Tcl_GetString(argsObj[i]),
2701 &typId, &typmod, NULL);
2702
2703 getTypeInputInfo(typId, &typInput, &typIOParam);
2704
2705 qdesc->argtypes[i] = typId;
2706 fmgr_info_cxt(typInput, &(qdesc->arginfuncs[i]), plan_cxt);
2707 qdesc->argtypioparams[i] = typIOParam;
2708 }
2709
2710 /************************************************************
2711 * Prepare the plan and check for errors
2712 ************************************************************/
2713 UTF_BEGIN;
2714 qdesc->plan = SPI_prepare(UTF_U2E(Tcl_GetString(objv[1])),
2715 nargs, qdesc->argtypes);
2716 UTF_END;
2717
2718 if (qdesc->plan == NULL)
2719 elog(ERROR, "SPI_prepare() failed");
2720
2721 /************************************************************
2722 * Save the plan into permanent memory (right now it's in the
2723 * SPI procCxt, which will go away at function end).
2724 ************************************************************/
2725 if (SPI_keepplan(qdesc->plan))
2726 elog(ERROR, "SPI_keepplan() failed");
2727
2728 pltcl_subtrans_commit(oldcontext, oldowner);
2729 }
2730 PG_CATCH();
2731 {
2732 pltcl_subtrans_abort(interp, oldcontext, oldowner);
2733
2734 MemoryContextDelete(plan_cxt);
2735
2736 return TCL_ERROR;
2737 }
2738 PG_END_TRY();
2739
2740 /************************************************************
2741 * Insert a hashtable entry for the plan and return
2742 * the key to the caller
2743 ************************************************************/
2744 query_hash = &pltcl_current_call_state->prodesc->interp_desc->query_hash;
2745
2746 hashent = Tcl_CreateHashEntry(query_hash, qdesc->qname, &hashnew);
2747 Tcl_SetHashValue(hashent, (ClientData) qdesc);
2748
2749 /* qname is ASCII, so no need for encoding conversion */
2750 Tcl_SetObjResult(interp, Tcl_NewStringObj(qdesc->qname, -1));
2751 return TCL_OK;
2752}
2753
2754
2755/**********************************************************************
2756 * pltcl_SPI_execute_plan() - Execute a prepared plan
2757 **********************************************************************/
2758static int
2759pltcl_SPI_execute_plan(ClientData cdata, Tcl_Interp *interp,
2760 int objc, Tcl_Obj *const objv[])
2761{
2762 int my_rc;
2763 int spi_rc;
2764 int i;
2765 int j;
2766 int optIndex;
2767 Tcl_HashEntry *hashent;
2768 pltcl_query_desc *qdesc;
2769 const char *nulls = NULL;
2770 const char *arrayname = NULL;
2771 Tcl_Obj *loop_body = NULL;
2772 int count = 0;
2773 Tcl_Size callObjc;
2774 Tcl_Obj **callObjv = NULL;
2775 Datum *argvalues;
2776 MemoryContext oldcontext = CurrentMemoryContext;
2777 ResourceOwner oldowner = CurrentResourceOwner;
2778 Tcl_HashTable *query_hash;
2779
2780 enum options
2781 {
2782 OPT_ARRAY, OPT_COUNT, OPT_NULLS
2783 };
2784
2785 static const char *options[] = {
2786 "-array", "-count", "-nulls", (const char *) NULL
2787 };
2788
2789 /************************************************************
2790 * Get the options and check syntax
2791 ************************************************************/
2792 i = 1;
2793 while (i < objc)
2794 {
2795 if (Tcl_GetIndexFromObj(NULL, objv[i], options, NULL,
2796 TCL_EXACT, &optIndex) != TCL_OK)
2797 break;
2798
2799 if (++i >= objc)
2800 {
2801 Tcl_SetObjResult(interp,
2802 Tcl_NewStringObj("missing argument to -array, -count or -nulls", -1));
2803 return TCL_ERROR;
2804 }
2805
2806 switch ((enum options) optIndex)
2807 {
2808 case OPT_ARRAY:
2809 arrayname = Tcl_GetString(objv[i++]);
2810 break;
2811
2812 case OPT_COUNT:
2813 if (Tcl_GetIntFromObj(interp, objv[i++], &count) != TCL_OK)
2814 return TCL_ERROR;
2815 break;
2816
2817 case OPT_NULLS:
2818 nulls = Tcl_GetString(objv[i++]);
2819 break;
2820 }
2821 }
2822
2823 /************************************************************
2824 * Get the prepared plan descriptor by its key
2825 ************************************************************/
2826 if (i >= objc)
2827 {
2828 Tcl_SetObjResult(interp,
2829 Tcl_NewStringObj("missing argument to -count or -array", -1));
2830 return TCL_ERROR;
2831 }
2832
2833 query_hash = &pltcl_current_call_state->prodesc->interp_desc->query_hash;
2834
2835 hashent = Tcl_FindHashEntry(query_hash, Tcl_GetString(objv[i]));
2836 if (hashent == NULL)
2837 {
2838 Tcl_AppendResult(interp, "invalid queryid '", Tcl_GetString(objv[i]), "'", NULL);
2839 return TCL_ERROR;
2840 }
2841 qdesc = (pltcl_query_desc *) Tcl_GetHashValue(hashent);
2842 i++;
2843
2844 /************************************************************
2845 * If a nulls string is given, check for correct length
2846 ************************************************************/
2847 if (nulls != NULL)
2848 {
2849 if (strlen(nulls) != qdesc->nargs)
2850 {
2851 Tcl_SetObjResult(interp,
2852 Tcl_NewStringObj("length of nulls string doesn't match number of arguments",
2853 -1));
2854 return TCL_ERROR;
2855 }
2856 }
2857
2858 /************************************************************
2859 * If there was an argtype list on preparation, we need
2860 * an argument value list now
2861 ************************************************************/
2862 if (qdesc->nargs > 0)
2863 {
2864 if (i >= objc)
2865 {
2866 Tcl_SetObjResult(interp,
2867 Tcl_NewStringObj("argument list length doesn't match number of arguments for query",
2868 -1));
2869 return TCL_ERROR;
2870 }
2871
2872 /************************************************************
2873 * Split the argument values
2874 ************************************************************/
2875 if (Tcl_ListObjGetElements(interp, objv[i++], &callObjc, &callObjv) != TCL_OK)
2876 return TCL_ERROR;
2877
2878 /************************************************************
2879 * Check that the number of arguments matches
2880 ************************************************************/
2881 if (callObjc != qdesc->nargs)
2882 {
2883 Tcl_SetObjResult(interp,
2884 Tcl_NewStringObj("argument list length doesn't match number of arguments for query",
2885 -1));
2886 return TCL_ERROR;
2887 }
2888 }
2889 else
2890 callObjc = 0;
2891
2892 /************************************************************
2893 * Get loop body if present
2894 ************************************************************/
2895 if (i < objc)
2896 loop_body = objv[i++];
2897
2898 if (i != objc)
2899 {
2900 Tcl_WrongNumArgs(interp, 1, objv,
2901 "?-count n? ?-array name? ?-nulls string? "
2902 "query ?args? ?loop body?");
2903 return TCL_ERROR;
2904 }
2905
2906 /************************************************************
2907 * Execute the plan inside a sub-transaction, so we can cope with
2908 * errors sanely
2909 ************************************************************/
2910
2911 pltcl_subtrans_begin(oldcontext, oldowner);
2912
2913 PG_TRY();
2914 {
2915 /************************************************************
2916 * Setup the value array for SPI_execute_plan() using
2917 * the type specific input functions
2918 ************************************************************/
2919 argvalues = (Datum *) palloc(callObjc * sizeof(Datum));
2920
2921 for (j = 0; j < callObjc; j++)
2922 {
2923 if (nulls && nulls[j] == 'n')
2924 {
2925 argvalues[j] = InputFunctionCall(&qdesc->arginfuncs[j],
2926 NULL,
2927 qdesc->argtypioparams[j],
2928 -1);
2929 }
2930 else
2931 {
2932 UTF_BEGIN;
2933 argvalues[j] = InputFunctionCall(&qdesc->arginfuncs[j],
2934 UTF_U2E(Tcl_GetString(callObjv[j])),
2935 qdesc->argtypioparams[j],
2936 -1);
2937 UTF_END;
2938 }
2939 }
2940
2941 /************************************************************
2942 * Execute the plan
2943 ************************************************************/
2944 spi_rc = SPI_execute_plan(qdesc->plan, argvalues, nulls,
2945 pltcl_current_call_state->prodesc->fn_readonly,
2946 count);
2947
2948 my_rc = pltcl_process_SPI_result(interp,
2949 arrayname,
2950 loop_body,
2951 spi_rc,
2952 SPI_tuptable,
2953 SPI_processed);
2954
2955 pltcl_subtrans_commit(oldcontext, oldowner);
2956 }
2957 PG_CATCH();
2958 {
2959 pltcl_subtrans_abort(interp, oldcontext, oldowner);
2960 return TCL_ERROR;
2961 }
2962 PG_END_TRY();
2963
2964 return my_rc;
2965}
2966
2967
2968/**********************************************************************
2969 * pltcl_subtransaction() - Execute some Tcl code in a subtransaction
2970 *
2971 * The subtransaction is aborted if the Tcl code fragment returns TCL_ERROR,
2972 * otherwise it's subcommitted.
2973 **********************************************************************/
2974static int
2975pltcl_subtransaction(ClientData cdata, Tcl_Interp *interp,
2976 int objc, Tcl_Obj *const objv[])
2977{
2978 MemoryContext oldcontext = CurrentMemoryContext;
2979 ResourceOwner oldowner = CurrentResourceOwner;
2980 int retcode;
2981
2982 if (objc != 2)
2983 {
2984 Tcl_WrongNumArgs(interp, 1, objv, "command");
2985 return TCL_ERROR;
2986 }
2987
2988 /*
2989 * Note: we don't use pltcl_subtrans_begin and friends here because we
2990 * don't want the error handling in pltcl_subtrans_abort. But otherwise
2991 * the processing should be about the same as in those functions.
2992 */
2993 BeginInternalSubTransaction(NULL);
2994 MemoryContextSwitchTo(oldcontext);
2995
2996 retcode = Tcl_EvalObjEx(interp, objv[1], 0);
2997
2998 if (retcode == TCL_ERROR)
2999 {
3000 /* Rollback the subtransaction */
3001 RollbackAndReleaseCurrentSubTransaction();
3002 }
3003 else
3004 {
3005 /* Commit the subtransaction */
3006 ReleaseCurrentSubTransaction();
3007 }
3008
3009 /* In either case, restore previous memory context and resource owner */
3010 MemoryContextSwitchTo(oldcontext);
3011 CurrentResourceOwner = oldowner;
3012
3013 return retcode;
3014}
3015
3016
3017/**********************************************************************
3018 * pltcl_commit()
3019 *
3020 * Commit the transaction and start a new one.
3021 **********************************************************************/
3022static int
3023pltcl_commit(ClientData cdata, Tcl_Interp *interp,
3024 int objc, Tcl_Obj *const objv[])
3025{
3026 MemoryContext oldcontext = CurrentMemoryContext;
3027
3028 PG_TRY();
3029 {
3030 SPI_commit();
3031 }
3032 PG_CATCH();
3033 {
3034 ErrorData *edata;
3035
3036 /* Save error info */
3037 MemoryContextSwitchTo(oldcontext);
3038 edata = CopyErrorData();
3039 FlushErrorState();
3040
3041 /* Pass the error data to Tcl */
3042 pltcl_construct_errorCode(interp, edata);
3043 UTF_BEGIN;
3044 Tcl_SetObjResult(interp, Tcl_NewStringObj(UTF_E2U(edata->message), -1));
3045 UTF_END;
3046 FreeErrorData(edata);
3047
3048 return TCL_ERROR;
3049 }
3050 PG_END_TRY();
3051
3052 return TCL_OK;
3053}
3054
3055
3056/**********************************************************************
3057 * pltcl_rollback()
3058 *
3059 * Abort the transaction and start a new one.
3060 **********************************************************************/
3061static int
3062pltcl_rollback(ClientData cdata, Tcl_Interp *interp,
3063 int objc, Tcl_Obj *const objv[])
3064{
3065 MemoryContext oldcontext = CurrentMemoryContext;
3066
3067 PG_TRY();
3068 {
3069 SPI_rollback();
3070 }
3071 PG_CATCH();
3072 {
3073 ErrorData *edata;
3074
3075 /* Save error info */
3076 MemoryContextSwitchTo(oldcontext);
3077 edata = CopyErrorData();
3078 FlushErrorState();
3079
3080 /* Pass the error data to Tcl */
3081 pltcl_construct_errorCode(interp, edata);
3082 UTF_BEGIN;
3083 Tcl_SetObjResult(interp, Tcl_NewStringObj(UTF_E2U(edata->message), -1));
3084 UTF_END;
3085 FreeErrorData(edata);
3086
3087 return TCL_ERROR;
3088 }
3089 PG_END_TRY();
3090
3091 return TCL_OK;
3092}
3093
3094
3095/**********************************************************************
3096 * pltcl_set_tuple_values() - Set variables for all attributes
3097 * of a given tuple
3098 *
3099 * Note: arrayname is presumed to be UTF8; it usually came from Tcl
3100 **********************************************************************/
3101static void
3102pltcl_set_tuple_values(Tcl_Interp *interp, const char *arrayname,
3103 uint64 tupno, HeapTuple tuple, TupleDesc tupdesc)
3104{
3105 int i;
3106 char *outputstr;
3107 Datum attr;
3108 bool isnull;
3109 const char *attname;
3110 Oid typoutput;
3111 bool typisvarlena;
3112 const char **arrptr;
3113 const char **nameptr;
3114 const char *nullname = NULL;
3115
3116 /************************************************************
3117 * Prepare pointers for Tcl_SetVar2Ex() below
3118 ************************************************************/
3119 if (arrayname == NULL)
3120 {
3121 arrptr = &attname;
3122 nameptr = &nullname;
3123 }
3124 else
3125 {
3126 arrptr = &arrayname;
3127 nameptr = &attname;
3128
3129 /*
3130 * When outputting to an array, fill the ".tupno" element with the
3131 * current tuple number. This will be overridden below if ".tupno" is
3132 * in use as an actual field name in the rowtype.
3133 */
3134 Tcl_SetVar2Ex(interp, arrayname, ".tupno", Tcl_NewWideIntObj(tupno), 0);
3135 }
3136
3137 for (i = 0; i < tupdesc->natts; i++)
3138 {
3139 Form_pg_attribute att = TupleDescAttr(tupdesc, i);
3140
3141 /* ignore dropped attributes */
3142 if (att->attisdropped)
3143 continue;
3144
3145 /************************************************************
3146 * Get the attribute name
3147 ************************************************************/
3148 UTF_BEGIN;
3149 attname = pstrdup(UTF_E2U(NameStr(att->attname)));
3150 UTF_END;
3151
3152 /************************************************************
3153 * Get the attributes value
3154 ************************************************************/
3155 attr = heap_getattr(tuple, i + 1, tupdesc, &isnull);
3156
3157 /************************************************************
3158 * If there is a value, set the variable
3159 * If not, unset it
3160 *
3161 * Hmmm - Null attributes will cause functions to
3162 * crash if they don't expect them - need something
3163 * smarter here.
3164 ************************************************************/
3165 if (!isnull)
3166 {
3167 getTypeOutputInfo(att->atttypid, &typoutput, &typisvarlena);
3168 outputstr = OidOutputFunctionCall(typoutput, attr);
3169 UTF_BEGIN;
3170 Tcl_SetVar2Ex(interp, *arrptr, *nameptr,
3171 Tcl_NewStringObj(UTF_E2U(outputstr), -1), 0);
3172 UTF_END;
3173 pfree(outputstr);
3174 }
3175 else
3176 Tcl_UnsetVar2(interp, *arrptr, *nameptr, 0);
3177
3178 pfree(unconstify(char *, attname));
3179 }
3180}
3181
3182
3183/**********************************************************************
3184 * pltcl_build_tuple_argument() - Build a list object usable for 'array set'
3185 * from all attributes of a given tuple
3186 **********************************************************************/
3187static Tcl_Obj *
3188pltcl_build_tuple_argument(HeapTuple tuple, TupleDesc tupdesc, bool include_generated)
3189{
3190 Tcl_Obj *retobj = Tcl_NewObj();
3191 int i;
3192 char *outputstr;
3193 Datum attr;
3194 bool isnull;
3195 char *attname;
3196 Oid typoutput;
3197 bool typisvarlena;
3198
3199 for (i = 0; i < tupdesc->natts; i++)
3200 {
3201 Form_pg_attribute att = TupleDescAttr(tupdesc, i);
3202
3203 /* ignore dropped attributes */
3204 if (att->attisdropped)
3205 continue;
3206
3207 if (att->attgenerated)
3208 {
3209 /* don't include unless requested */
3210 if (!include_generated)
3211 continue;
3212 /* never include virtual columns */
3213 if (att->attgenerated == ATTRIBUTE_GENERATED_VIRTUAL)
3214 continue;
3215 }
3216
3217 /************************************************************
3218 * Get the attribute name
3219 ************************************************************/
3220 attname = NameStr(att->attname);
3221
3222 /************************************************************
3223 * Get the attributes value
3224 ************************************************************/
3225 attr = heap_getattr(tuple, i + 1, tupdesc, &isnull);
3226
3227 /************************************************************
3228 * If there is a value, append the attribute name and the
3229 * value to the list
3230 *
3231 * Hmmm - Null attributes will cause functions to
3232 * crash if they don't expect them - need something
3233 * smarter here.
3234 ************************************************************/
3235 if (!isnull)
3236 {
3237 getTypeOutputInfo(att->atttypid,
3238 &typoutput, &typisvarlena);
3239 outputstr = OidOutputFunctionCall(typoutput, attr);
3240 UTF_BEGIN;
3241 Tcl_ListObjAppendElement(NULL, retobj,
3242 Tcl_NewStringObj(UTF_E2U(attname), -1));
3243 UTF_END;
3244 UTF_BEGIN;
3245 Tcl_ListObjAppendElement(NULL, retobj,
3246 Tcl_NewStringObj(UTF_E2U(outputstr), -1));
3247 UTF_END;
3248 pfree(outputstr);
3249 }
3250 }
3251
3252 return retobj;
3253}
3254
3255/**********************************************************************
3256 * pltcl_build_tuple_result() - Build a tuple of function's result rowtype
3257 * from a Tcl list of column names and values
3258 *
3259 * In a trigger function, we build a tuple of the trigger table's rowtype.
3260 *
3261 * Note: this function leaks memory. Even if we made it clean up its own
3262 * mess, there's no way to prevent the datatype input functions it calls
3263 * from leaking. Run it in a short-lived context, unless we're about to
3264 * exit the procedure anyway.
3265 **********************************************************************/
3266static HeapTuple
3267pltcl_build_tuple_result(Tcl_Interp *interp, Tcl_Obj **kvObjv, int kvObjc,
3268 pltcl_call_state *call_state)
3269{
3270 HeapTuple tuple;
3271 TupleDesc tupdesc;
3272 AttInMetadata *attinmeta;
3273 char **values;
3274 int i;
3275
3276 if (call_state->ret_tupdesc)
3277 {
3278 tupdesc = call_state->ret_tupdesc;
3279 attinmeta = call_state->attinmeta;
3280 }
3281 else if (call_state->trigdata)
3282 {
3283 tupdesc = RelationGetDescr(call_state->trigdata->tg_relation);
3284 attinmeta = TupleDescGetAttInMetadata(tupdesc);
3285 }
3286 else
3287 {
3288 elog(ERROR, "PL/Tcl function does not return a tuple");
3289 tupdesc = NULL; /* keep compiler quiet */
3290 attinmeta = NULL;
3291 }
3292
3293 values = (char **) palloc0(tupdesc->natts * sizeof(char *));
3294
3295 if (kvObjc % 2 != 0)
3296 ereport(ERROR,
3297 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3298 errmsg("column name/value list must have even number of elements")));
3299
3300 for (i = 0; i < kvObjc; i += 2)
3301 {
3302 char *fieldName = utf_u2e(Tcl_GetString(kvObjv[i]));
3303 int attn = SPI_fnumber(tupdesc, fieldName);
3304
3305 /*
3306 * We silently ignore ".tupno", if it's present but doesn't match any
3307 * actual output column. This allows direct use of a row returned by
3308 * pltcl_set_tuple_values().
3309 */
3310 if (attn == SPI_ERROR_NOATTRIBUTE)
3311 {
3312 if (strcmp(fieldName, ".tupno") == 0)
3313 continue;
3314 ereport(ERROR,
3315 (errcode(ERRCODE_UNDEFINED_COLUMN),
3316 errmsg("column name/value list contains nonexistent column name \"%s\"",
3317 fieldName)));
3318 }
3319
3320 if (attn <= 0)
3321 ereport(ERROR,
3322 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3323 errmsg("cannot set system attribute \"%s\"",
3324 fieldName)));
3325
3326 if (TupleDescAttr(tupdesc, attn - 1)->attgenerated)
3327 ereport(ERROR,
3328 (errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
3329 errmsg("cannot set generated column \"%s\"",
3330 fieldName)));
3331
3332 values[attn - 1] = utf_u2e(Tcl_GetString(kvObjv[i + 1]));
3333 }
3334
3335 tuple = BuildTupleFromCStrings(attinmeta, values);
3336
3337 /* if result type is domain-over-composite, check domain constraints */
3338 if (call_state->prodesc->fn_retisdomain)
3339 domain_check(HeapTupleGetDatum(tuple), false,
3340 call_state->prodesc->result_typid,
3341 &call_state->prodesc->domain_info,
3342 call_state->prodesc->fn_cxt);
3343
3344 return tuple;
3345}
3346
3347/**********************************************************************
3348 * pltcl_init_tuple_store() - Initialize the result tuplestore for a SRF
3349 **********************************************************************/
3350static void
3351pltcl_init_tuple_store(pltcl_call_state *call_state)
3352{
3353 ReturnSetInfo *rsi = call_state->rsi;
3354 MemoryContext oldcxt;
3355 ResourceOwner oldowner;
3356
3357 /* Should be in a SRF */
3358 Assert(rsi);
3359 /* Should be first time through */
3360 Assert(!call_state->tuple_store);
3361 Assert(!call_state->attinmeta);
3362
3363 /* We expect caller to provide an appropriate result tupdesc */
3364 Assert(rsi->expectedDesc);
3365 call_state->ret_tupdesc = rsi->expectedDesc;
3366
3367 /*
3368 * Switch to the right memory context and resource owner for storing the
3369 * tuplestore. If we're within a subtransaction opened for an exception
3370 * block, for example, we must still create the tuplestore in the resource
3371 * owner that was active when this function was entered, and not in the
3372 * subtransaction's resource owner.
3373 */
3374 oldcxt = MemoryContextSwitchTo(call_state->tuple_store_cxt);
3375 oldowner = CurrentResourceOwner;
3376 CurrentResourceOwner = call_state->tuple_store_owner;
3377
3378 call_state->tuple_store =
3379 tuplestore_begin_heap(rsi->allowedModes & SFRM_Materialize_Random,
3380 false, work_mem);
3381
3382 /* Build attinmeta in this context, too */
3383 call_state->attinmeta = TupleDescGetAttInMetadata(call_state->ret_tupdesc);
3384
3385 CurrentResourceOwner = oldowner;
3386 MemoryContextSwitchTo(oldcxt);
3387}
AclResult
AclResult
Definition acl.h:183
ACLCHECK_OK
@ ACLCHECK_OK
Definition acl.h:184
aclcheck_error
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition aclchk.c:2672
object_aclcheck
AclResult object_aclcheck(Oid classid, Oid objectid, Oid roleid, AclMode mode)
Definition aclchk.c:3879
values
static Datum values[MAXATTR]
Definition bootstrap.c:188
TextDatumGetCString
#define TextDatumGetCString(d)
Definition builtins.h:99
NameStr
#define NameStr(name)
Definition c.h:837
unconstify
#define unconstify(underlying_type, expr)
Definition c.h:1327
gettext_noop
#define gettext_noop(x)
Definition c.h:1287
PG_USED_FOR_ASSERTS_ONLY
#define PG_USED_FOR_ASSERTS_ONLY
Definition c.h:243
Assert
#define Assert(condition)
Definition c.h:945
int32
int32_t int32
Definition c.h:614
uint64
uint64_t uint64
Definition c.h:619
pg_fallthrough
#define pg_fallthrough
Definition c.h:152
TransactionId
uint32 TransactionId
Definition c.h:738
OidIsValid
#define OidIsValid(objectId)
Definition c.h:860
GetCommandTagName
const char * GetCommandTagName(CommandTag commandTag)
Definition cmdtag.c:47
domain_check
void domain_check(Datum value, bool isnull, Oid domainType, void **extra, MemoryContext mcxt)
Definition domains.c:346
hash_search
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition dynahash.c:952
hash_create
HTAB * hash_create(const char *tabname, int64 nelem, const HASHCTL *info, int flags)
Definition dynahash.c:358
arg
Datum arg
Definition elog.c:1322
FreeErrorData
void FreeErrorData(ErrorData *edata)
Definition elog.c:2013
error_context_stack
ErrorContextCallback * error_context_stack
Definition elog.c:99
CopyErrorData
ErrorData * CopyErrorData(void)
Definition elog.c:1941
FlushErrorState
void FlushErrorState(void)
Definition elog.c:2062
errcode
int errcode(int sqlerrcode)
Definition elog.c:874
unpack_sql_state
char * unpack_sql_state(int sql_state)
Definition elog.c:3653
LOG
#define LOG
Definition elog.h:31
PG_RE_THROW
#define PG_RE_THROW()
Definition elog.h:405
errcontext
#define errcontext
Definition elog.h:198
FATAL
#define FATAL
Definition elog.h:41
PG_TRY
#define PG_TRY(...)
Definition elog.h:372
WARNING
#define WARNING
Definition elog.h:36
DEBUG2
#define DEBUG2
Definition elog.h:29
PG_END_TRY
#define PG_END_TRY(...)
Definition elog.h:397
ERROR
#define ERROR
Definition elog.h:39
PG_CATCH
#define PG_CATCH(...)
Definition elog.h:382
elog
#define elog(elevel,...)
Definition elog.h:226
NOTICE
#define NOTICE
Definition elog.h:35
PG_FINALLY
#define PG_FINALLY(...)
Definition elog.h:389
INFO
#define INFO
Definition elog.h:34
ereport
#define ereport(elevel,...)
Definition elog.h:150
CALLED_AS_EVENT_TRIGGER
#define CALLED_AS_EVENT_TRIGGER(fcinfo)
Definition event_trigger.h:49
BuildTupleFromCStrings
HeapTuple BuildTupleFromCStrings(AttInMetadata *attinmeta, char **values)
Definition execTuples.c:2405
TupleDescGetAttInMetadata
AttInMetadata * TupleDescGetAttInMetadata(TupleDesc tupdesc)
Definition execTuples.c:2356
SFRM_Materialize_Random
@ SFRM_Materialize_Random
Definition execnodes.h:353
SFRM_Materialize
@ SFRM_Materialize
Definition execnodes.h:352
palloc0_object
#define palloc0_object(type)
Definition fe_memutils.h:75
InputFunctionCall
Datum InputFunctionCall(FmgrInfo *flinfo, char *str, Oid typioparam, int32 typmod)
Definition fmgr.c:1532
fmgr_info
void fmgr_info(Oid functionId, FmgrInfo *finfo)
Definition fmgr.c:129
OidOutputFunctionCall
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition fmgr.c:1764
fmgr_info_cxt
void fmgr_info_cxt(Oid functionId, FmgrInfo *finfo, MemoryContext mcxt)
Definition fmgr.c:139
OutputFunctionCall
char * OutputFunctionCall(FmgrInfo *flinfo, Datum val)
Definition fmgr.c:1684
DatumGetHeapTupleHeader
#define DatumGetHeapTupleHeader(X)
Definition fmgr.h:296
InitFunctionCallInfoData
#define InitFunctionCallInfoData(Fcinfo, Flinfo, Nargs, Collation, Context, Resultinfo)
Definition fmgr.h:150
PG_ARGISNULL
#define PG_ARGISNULL(n)
Definition fmgr.h:209
DirectFunctionCall1
#define DirectFunctionCall1(func, arg1)
Definition fmgr.h:684
LOCAL_FCINFO
#define LOCAL_FCINFO(name, nargs)
Definition fmgr.h:110
PG_FUNCTION_INFO_V1
#define PG_FUNCTION_INFO_V1(funcname)
Definition fmgr.h:417
FunctionCallInvoke
#define FunctionCallInvoke(fcinfo)
Definition fmgr.h:172
PG_FUNCTION_ARGS
#define PG_FUNCTION_ARGS
Definition fmgr.h:193
format_type_be
char * format_type_be(Oid type_oid)
Definition format_type.c:343
get_call_result_type
TypeFuncClass get_call_result_type(FunctionCallInfo fcinfo, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition funcapi.c:276
TYPEFUNC_COMPOSITE
@ TYPEFUNC_COMPOSITE
Definition funcapi.h:149
TYPEFUNC_RECORD
@ TYPEFUNC_RECORD
Definition funcapi.h:151
TYPEFUNC_COMPOSITE_DOMAIN
@ TYPEFUNC_COMPOSITE_DOMAIN
Definition funcapi.h:150
HeapTupleGetDatum
static Datum HeapTupleGetDatum(const HeapTupleData *tuple)
Definition funcapi.h:230
work_mem
int work_mem
Definition globals.c:131
DefineCustomStringVariable
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:5123
MarkGUCPrefixReserved
void MarkGUCPrefixReserved(const char *className)
Definition guc.c:5180
PGC_SUSET
@ PGC_SUSET
Definition guc.h:78
HASH_ENTER
@ HASH_ENTER
Definition hsearch.h:114
HASH_ELEM
#define HASH_ELEM
Definition hsearch.h:95
HASH_BLOBS
#define HASH_BLOBS
Definition hsearch.h:97
HeapTuple
HeapTupleData * HeapTuple
Definition htup.h:71
HeapTupleIsValid
#define HeapTupleIsValid(tuple)
Definition htup.h:78
heap_getattr
static Datum heap_getattr(HeapTuple tup, int attnum, TupleDesc tupleDesc, bool *isnull)
Definition htup_details.h:890
HeapTupleHeaderGetTypMod
static int32 HeapTupleHeaderGetTypMod(const HeapTupleHeaderData *tup)
Definition htup_details.h:502
HeapTupleHeaderGetRawXmin
static TransactionId HeapTupleHeaderGetRawXmin(const HeapTupleHeaderData *tup)
Definition htup_details.h:318
HeapTupleHeaderGetDatumLength
static uint32 HeapTupleHeaderGetDatumLength(const HeapTupleHeaderData *tup)
Definition htup_details.h:478
GETSTRUCT
static void * GETSTRUCT(const HeapTupleData *tuple)
Definition htup_details.h:714
HeapTupleHeaderGetTypeId
static Oid HeapTupleHeaderGetTypeId(const HeapTupleHeaderData *tup)
Definition htup_details.h:490
j
int j
Definition isn.c:78
i
int i
Definition isn.c:77
ItemPointerEquals
bool ItemPointerEquals(const ItemPointerData *pointer1, const ItemPointerData *pointer2)
Definition itemptr.c:35
type_is_rowtype
bool type_is_rowtype(Oid typid)
Definition lsyscache.c:2877
getTypeOutputInfo
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition lsyscache.c:3129
getTypeInputInfo
void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam)
Definition lsyscache.c:3096
getTypeIOParam
Oid getTypeIOParam(HeapTuple typeTuple)
Definition lsyscache.c:2523
PG_UTF8
#define PG_UTF8
Definition mbprint.c:43
pg_any_to_server
char * pg_any_to_server(const char *s, int len, int encoding)
Definition mbutils.c:687
pg_server_to_any
char * pg_server_to_any(const char *s, int len, int encoding)
Definition mbutils.c:760
pstrdup
char * pstrdup(const char *in)
Definition mcxt.c:1781
pfree
void pfree(void *pointer)
Definition mcxt.c:1616
palloc0
void * palloc0(Size size)
Definition mcxt.c:1417
TopMemoryContext
MemoryContext TopMemoryContext
Definition mcxt.c:166
palloc
void * palloc(Size size)
Definition mcxt.c:1387
CurrentMemoryContext
MemoryContext CurrentMemoryContext
Definition mcxt.c:160
MemoryContextDelete
void MemoryContextDelete(MemoryContext context)
Definition mcxt.c:472
MemoryContextSetIdentifier
void MemoryContextSetIdentifier(MemoryContext context, const char *id)
Definition mcxt.c:661
AllocSetContextCreate
#define AllocSetContextCreate
Definition memutils.h:129
ALLOCSET_SMALL_SIZES
#define ALLOCSET_SMALL_SIZES
Definition memutils.h:170
GetUserId
Oid GetUserId(void)
Definition miscinit.c:470
pg_bindtextdomain
void pg_bindtextdomain(const char *domain)
Definition miscinit.c:1889
IsA
#define IsA(nodeptr, _type_)
Definition nodes.h:164
castNode
#define castNode(_type_, nodeptr)
Definition nodes.h:182
errmsg
static char * errmsg
Definition oauth_hook_client.c:61
InvokeFunctionExecuteHook
#define InvokeFunctionExecuteHook(objectId)
Definition objectaccess.h:213
oidout
Datum oidout(PG_FUNCTION_ARGS)
Definition oid.c:47
MemoryContextSwitchTo
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition palloc.h:124
LookupFuncName
Oid LookupFuncName(List *funcname, int nargs, const Oid *argtypes, bool missing_ok)
Definition parse_func.c:2269
parseTypeString
bool parseTypeString(const char *str, Oid *typeid_p, int32 *typmod_p, Node *escontext)
Definition parse_type.c:785
OBJECT_FUNCTION
@ OBJECT_FUNCTION
Definition parsenodes.h:2429
ACL_EXECUTE
#define ACL_EXECUTE
Definition parsenodes.h:83
attname
NameData attname
Definition pg_attribute.h:43
Form_pg_attribute
FormData_pg_attribute * Form_pg_attribute
Definition pg_attribute.h:206
label
static char * label
Definition pg_basebackup.c:135
mode
static PgChecksumMode mode
Definition pg_checksums.c:56
FUNC_MAX_ARGS
#define FUNC_MAX_ARGS
Definition pg_config_manual.h:53
Form_pg_proc
END_CATALOG_STRUCT typedef FormData_pg_proc * Form_pg_proc
Definition pg_proc.h:140
proname
NameData proname
Definition pg_proc.h:37
buf
static char buf[DEFAULT_XLOG_SEG_SIZE]
Definition pg_test_fsync.c:71
Form_pg_type
END_CATALOG_STRUCT typedef FormData_pg_type * Form_pg_type
Definition pg_type.h:265
pgstat_init_function_usage
void pgstat_init_function_usage(FunctionCallInfo fcinfo, PgStat_FunctionCallUsage *fcu)
Definition pgstat_function.c:72
pgstat_end_function_usage
void pgstat_end_function_usage(PgStat_FunctionCallUsage *fcu, bool finalize)
Definition pgstat_function.c:146
pltcl_trigger_handler
static HeapTuple pltcl_trigger_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
Definition pltcl.c:1060
pltcl_ServiceModeHook
static void pltcl_ServiceModeHook(int mode)
Definition pltcl.c:389
pltcl_get_condition_name
static const char * pltcl_get_condition_name(int sqlstate)
Definition pltcl.c:2076
pltcl_proc_htab
static HTAB * pltcl_proc_htab
Definition pltcl.c:251
pltcl_AlertNotifier
static void pltcl_AlertNotifier(ClientData clientData)
Definition pltcl.c:373
_PG_init
void _PG_init(void)
Definition pltcl.c:409
utf_e2u
static char * utf_e2u(const char *src)
Definition pltcl.c:88
UTF_E2U
#define UTF_E2U(x)
Definition pltcl.c:106
pltcl_WaitForEvent
static int pltcl_WaitForEvent(CONST86 Tcl_Time *timePtr)
Definition pltcl.c:394
pltcl_init_tuple_store
static void pltcl_init_tuple_store(pltcl_call_state *call_state)
Definition pltcl.c:3352
pltcl_build_tuple_argument
static Tcl_Obj * pltcl_build_tuple_argument(HeapTuple tuple, TupleDesc tupdesc, bool include_generated)
Definition pltcl.c:3189
compile_pltcl_function
static pltcl_proc_desc * compile_pltcl_function(Oid fn_oid, Oid tgreloid, bool is_event_trigger, bool pltrusted)
Definition pltcl.c:1418
call_pltcl_start_proc
static void call_pltcl_start_proc(Oid prolang, bool pltrusted)
Definition pltcl.c:598
Tcl_Size
int Tcl_Size
Definition pltcl.c:63
pltcl_returnnext
static int pltcl_returnnext(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:2240
pltcl_SetTimer
static void pltcl_SetTimer(CONST86 Tcl_Time *timePtr)
Definition pltcl.c:368
pltcl_SPI_execute
static int pltcl_SPI_execute(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:2410
CONST86
#define CONST86
Definition pltcl.c:59
pltcl_process_SPI_result
static int pltcl_process_SPI_result(Tcl_Interp *interp, const char *arrayname, Tcl_Obj *loop_body, int spi_rc, SPITupleTable *tuptable, uint64 ntuples)
Definition pltcl.c:2519
pltcl_elog
static int pltcl_elog(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:1844
pltcl_subtrans_abort
static void pltcl_subtrans_abort(Tcl_Interp *interp, MemoryContext oldcontext, ResourceOwner oldowner)
Definition pltcl.c:2381
pltcl_DeleteFileHandler
static void pltcl_DeleteFileHandler(int fd)
Definition pltcl.c:384
pltcl_quote
static int pltcl_quote(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:2094
pltcl_FinalizeNotifier
static void pltcl_FinalizeNotifier(ClientData clientData)
Definition pltcl.c:363
UTF_END
#define UTF_END
Definition pltcl.c:98
throw_tcl_error
static void throw_tcl_error(Tcl_Interp *interp, const char *proname)
Definition pltcl.c:1373
pltcl_CreateFileHandler
static void pltcl_CreateFileHandler(int fd, int mask, Tcl_FileProc *proc, ClientData clientData)
Definition pltcl.c:378
pltcl_SPI_prepare
static int pltcl_SPI_prepare(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:2632
UTF_BEGIN
#define UTF_BEGIN
Definition pltcl.c:93
pltcl_start_proc
static char * pltcl_start_proc
Definition pltcl.c:246
pltcl_handler
static Datum pltcl_handler(PG_FUNCTION_ARGS, bool pltrusted)
Definition pltcl.c:728
pltcl_interp_htab
static HTAB * pltcl_interp_htab
Definition pltcl.c:250
TEXTDOMAIN
#define TEXTDOMAIN
Definition pltcl.c:68
pltcl_fetch_interp
static pltcl_interp_desc * pltcl_fetch_interp(Oid prolang, bool pltrusted)
Definition pltcl.c:568
pltcl_current_call_state
static pltcl_call_state * pltcl_current_call_state
Definition pltcl.c:254
pltcl_init_interp
static void pltcl_init_interp(pltcl_interp_desc *interp_desc, Oid prolang, bool pltrusted)
Definition pltcl.c:495
pltcl_construct_errorCode
static void pltcl_construct_errorCode(Tcl_Interp *interp, ErrorData *edata)
Definition pltcl.c:1931
pltclu_start_proc
static char * pltclu_start_proc
Definition pltcl.c:247
pltcl_event_trigger_handler
static void pltcl_event_trigger_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
Definition pltcl.c:1319
pltcl_InitNotifier
static ClientData pltcl_InitNotifier(void)
Definition pltcl.c:355
utf_u2e
static char * utf_u2e(const char *src)
Definition pltcl.c:82
exception_name_map
static const TclExceptionNameMap exception_name_map[]
Definition pltcl.c:265
UTF_U2E
#define UTF_U2E(x)
Definition pltcl.c:103
pltcl_rollback
static int pltcl_rollback(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:3063
pltcl_set_tuple_values
static void pltcl_set_tuple_values(Tcl_Interp *interp, const char *arrayname, uint64 tupno, HeapTuple tuple, TupleDesc tupdesc)
Definition pltcl.c:3103
pltclu_call_handler
Datum pltclu_call_handler(PG_FUNCTION_ARGS)
Definition pltcl.c:717
start_proc_error_callback
static void start_proc_error_callback(void *arg)
Definition pltcl.c:685
pltcl_argisnull
static int pltcl_argisnull(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:2148
pltcl_returnnull
static int pltcl_returnnull(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:2202
pltcl_subtrans_begin
static void pltcl_subtrans_begin(MemoryContext oldcontext, ResourceOwner oldowner)
Definition pltcl.c:2363
pltcl_func_handler
static Datum pltcl_func_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
Definition pltcl.c:802
pltcl_hold_interp
static Tcl_Interp * pltcl_hold_interp
Definition pltcl.c:249
pltcl_SPI_execute_plan
static int pltcl_SPI_execute_plan(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:2760
pltcl_subtrans_commit
static void pltcl_subtrans_commit(MemoryContext oldcontext, ResourceOwner oldowner)
Definition pltcl.c:2372
pltcl_build_tuple_result
static HeapTuple pltcl_build_tuple_result(Tcl_Interp *interp, Tcl_Obj **kvObjv, int kvObjc, pltcl_call_state *call_state)
Definition pltcl.c:3268
pltcl_call_handler
Datum pltcl_call_handler(PG_FUNCTION_ARGS)
Definition pltcl.c:705
pltcl_pm_init_done
static bool pltcl_pm_init_done
Definition pltcl.c:248
pltcl_subtransaction
static int pltcl_subtransaction(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:2976
pltcl_commit
static int pltcl_commit(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition pltcl.c:3024
snprintf
#define snprintf
Definition port.h:260
PointerGetDatum
static Datum PointerGetDatum(const void *X)
Definition postgres.h:342
ObjectIdGetDatum
static Datum ObjectIdGetDatum(Oid X)
Definition postgres.h:252
DatumGetCString
static char * DatumGetCString(Datum X)
Definition postgres.h:355
Datum
uint64_t Datum
Definition postgres.h:70
InvalidOid
#define InvalidOid
Definition postgres_ext.h:37
Oid
unsigned int Oid
Definition postgres_ext.h:32
fd
static int fd(const char *x, int i)
Definition preproc-init.c:105
format_procedure
char * format_procedure(Oid procedure_oid)
Definition regproc.c:305
stringToQualifiedNameList
List * stringToQualifiedNameList(const char *string, Node *escontext)
Definition regproc.c:1922
RelationGetRelid
#define RelationGetRelid(relation)
Definition rel.h:514
RelationGetDescr
#define RelationGetDescr(relation)
Definition rel.h:540
CurrentResourceOwner
ResourceOwner CurrentResourceOwner
Definition resowner.c:173
SPI_commit
void SPI_commit(void)
Definition spi.c:321
SPI_fnumber
int SPI_fnumber(TupleDesc tupdesc, const char *fname)
Definition spi.c:1176
SPI_processed
uint64 SPI_processed
Definition spi.c:45
SPI_result_code_string
const char * SPI_result_code_string(int code)
Definition spi.c:1973
SPI_tuptable
SPITupleTable * SPI_tuptable
Definition spi.c:46
SPI_execute_plan
int SPI_execute_plan(SPIPlanPtr plan, const Datum *Values, const char *Nulls, bool read_only, long tcount)
Definition spi.c:673
SPI_connect
int SPI_connect(void)
Definition spi.c:95
SPI_finish
int SPI_finish(void)
Definition spi.c:183
SPI_register_trigger_data
int SPI_register_trigger_data(TriggerData *tdata)
Definition spi.c:3364
SPI_freetuptable
void SPI_freetuptable(SPITupleTable *tuptable)
Definition spi.c:1387
SPI_prepare
SPIPlanPtr SPI_prepare(const char *src, int nargs, Oid *argtypes)
Definition spi.c:861
SPI_keepplan
int SPI_keepplan(SPIPlanPtr plan)
Definition spi.c:977
SPI_connect_ext
int SPI_connect_ext(int options)
Definition spi.c:101
SPI_getnspname
char * SPI_getnspname(Relation rel)
Definition spi.c:1333
SPI_rollback
void SPI_rollback(void)
Definition spi.c:414
SPI_execute
int SPI_execute(const char *src, bool read_only, long tcount)
Definition spi.c:597
SPI_getrelname
char * SPI_getrelname(Relation rel)
Definition spi.c:1327
SPI_OPT_NONATOMIC
#define SPI_OPT_NONATOMIC
Definition spi.h:102
SPI_OK_UTILITY
#define SPI_OK_UTILITY
Definition spi.h:85
SPI_OK_REWRITTEN
#define SPI_OK_REWRITTEN
Definition spi.h:95
SPI_OK_INSERT
#define SPI_OK_INSERT
Definition spi.h:88
SPI_OK_UPDATE
#define SPI_OK_UPDATE
Definition spi.h:90
SPI_OK_MERGE
#define SPI_OK_MERGE
Definition spi.h:99
SPI_OK_SELINTO
#define SPI_OK_SELINTO
Definition spi.h:87
SPI_OK_UPDATE_RETURNING
#define SPI_OK_UPDATE_RETURNING
Definition spi.h:94
SPI_OK_DELETE
#define SPI_OK_DELETE
Definition spi.h:89
SPI_ERROR_NOATTRIBUTE
#define SPI_ERROR_NOATTRIBUTE
Definition spi.h:76
SPI_OK_INSERT_RETURNING
#define SPI_OK_INSERT_RETURNING
Definition spi.h:92
SPI_OK_DELETE_RETURNING
#define SPI_OK_DELETE_RETURNING
Definition spi.h:93
SPI_OK_FINISH
#define SPI_OK_FINISH
Definition spi.h:83
SPI_OK_MERGE_RETURNING
#define SPI_OK_MERGE_RETURNING
Definition spi.h:100
SPI_OK_SELECT
#define SPI_OK_SELECT
Definition spi.h:86
ErrorContextCallback::previous
struct ErrorContextCallback * previous
Definition elog.h:297
ErrorContextCallback::callback
void(* callback)(void *arg)
Definition elog.h:298
List
Definition pg_list.h:54
PgStat_FunctionCallUsage
Definition pgstat.h:96
ReturnSetInfo::returnMode
SetFunctionReturnMode returnMode
Definition execnodes.h:371
ReturnSetInfo::setDesc
TupleDesc setDesc
Definition execnodes.h:375
ReturnSetInfo::setResult
Tuplestorestate * setResult
Definition execnodes.h:374
ReturnSetInfo::expectedDesc
TupleDesc expectedDesc
Definition execnodes.h:368
SPITupleTable::tupdesc
TupleDesc tupdesc
Definition spi.h:25
SPITupleTable::vals
HeapTuple * vals
Definition spi.h:26
TclExceptionNameMap::label
const char * label
Definition pltcl.c:261
_SPI_plan
Definition spi_priv.h:91
pltcl_call_state
Definition pltcl.c:218
pltcl_call_state::rsi
ReturnSetInfo * rsi
Definition pltcl.c:236
pltcl_call_state::prodesc
pltcl_proc_desc * prodesc
Definition pltcl.c:226
pltcl_call_state::tuple_store_cxt
MemoryContext tuple_store_cxt
Definition pltcl.c:238
pltcl_call_state::tuple_store
Tuplestorestate * tuple_store
Definition pltcl.c:237
pltcl_call_state::trigdata
TriggerData * trigdata
Definition pltcl.c:223
pltcl_call_state::tuple_store_owner
ResourceOwner tuple_store_owner
Definition pltcl.c:239
pltcl_call_state::attinmeta
AttInMetadata * attinmeta
Definition pltcl.c:234
pltcl_call_state::fcinfo
FunctionCallInfo fcinfo
Definition pltcl.c:220
pltcl_call_state::ret_tupdesc
TupleDesc ret_tupdesc
Definition pltcl.c:233
pltcl_interp_desc
Definition pltcl.c:121
pltcl_interp_desc::query_hash
Tcl_HashTable query_hash
Definition pltcl.c:124
pltcl_interp_desc::user_id
Oid user_id
Definition pltcl.c:122
pltcl_interp_desc::interp
Tcl_Interp * interp
Definition pltcl.c:123
pltcl_proc_desc
Definition pltcl.c:146
pltcl_proc_desc::result_in_func
FmgrInfo result_in_func
Definition pltcl.c:157
pltcl_proc_desc::result_typid
Oid result_typid
Definition pltcl.c:156
pltcl_proc_desc::arg_out_func
FmgrInfo * arg_out_func
Definition pltcl.c:165
pltcl_proc_desc::fn_retisdomain
bool fn_retisdomain
Definition pltcl.c:161
pltcl_proc_desc::user_proname
char * user_proname
Definition pltcl.c:147
pltcl_proc_desc::nargs
int nargs
Definition pltcl.c:163
pltcl_proc_desc::fn_tid
ItemPointerData fn_tid
Definition pltcl.c:152
pltcl_proc_desc::internal_proname
char * internal_proname
Definition pltcl.c:148
pltcl_proc_desc::interp_desc
pltcl_interp_desc * interp_desc
Definition pltcl.c:155
pltcl_proc_desc::fn_retisset
bool fn_retisset
Definition pltcl.c:159
pltcl_proc_desc::fn_refcount
unsigned long fn_refcount
Definition pltcl.c:150
pltcl_proc_desc::domain_info
void * domain_info
Definition pltcl.c:162
pltcl_proc_desc::fn_cxt
MemoryContext fn_cxt
Definition pltcl.c:149
pltcl_proc_desc::fn_readonly
bool fn_readonly
Definition pltcl.c:153
pltcl_proc_desc::fn_retistuple
bool fn_retistuple
Definition pltcl.c:160
pltcl_proc_desc::result_typioparam
Oid result_typioparam
Definition pltcl.c:158
pltcl_proc_desc::lanpltrusted
bool lanpltrusted
Definition pltcl.c:154
pltcl_proc_desc::arg_is_rowtype
bool * arg_is_rowtype
Definition pltcl.c:166
pltcl_proc_desc::fn_xmin
TransactionId fn_xmin
Definition pltcl.c:151
pltcl_proc_key
Definition pltcl.c:196
pltcl_proc_key::is_trigger
Oid is_trigger
Definition pltcl.c:203
pltcl_proc_key::user_id
Oid user_id
Definition pltcl.c:204
pltcl_proc_key::proc_id
Oid proc_id
Definition pltcl.c:197
pltcl_proc_ptr
Definition pltcl.c:208
pltcl_proc_ptr::proc_ptr
pltcl_proc_desc * proc_ptr
Definition pltcl.c:210
pltcl_proc_ptr::proc_key
pltcl_proc_key proc_key
Definition pltcl.c:209
pltcl_query_desc
Definition pltcl.c:174
pltcl_query_desc::qname
char qname[20]
Definition pltcl.c:175
pltcl_query_desc::argtypioparams
Oid * argtypioparams
Definition pltcl.c:180
pltcl_query_desc::plan
SPIPlanPtr plan
Definition pltcl.c:176
pltcl_query_desc::arginfuncs
FmgrInfo * arginfuncs
Definition pltcl.c:179
pltcl_query_desc::argtypes
Oid * argtypes
Definition pltcl.c:178
pltcl_query_desc::nargs
int nargs
Definition pltcl.c:177
ReleaseSysCache
void ReleaseSysCache(HeapTuple tuple)
Definition syscache.c:264
SysCacheGetAttrNotNull
Datum SysCacheGetAttrNotNull(SysCacheIdentifier cacheId, HeapTuple tup, AttrNumber attributeNumber)
Definition syscache.c:625
SearchSysCache1
HeapTuple SearchSysCache1(SysCacheIdentifier cacheId, Datum key1)
Definition syscache.c:220
TRIGGER_FIRED_FOR_STATEMENT
#define TRIGGER_FIRED_FOR_STATEMENT(event)
Definition trigger.h:127
TRIGGER_FIRED_BY_DELETE
#define TRIGGER_FIRED_BY_DELETE(event)
Definition trigger.h:115
TRIGGER_FIRED_BEFORE
#define TRIGGER_FIRED_BEFORE(event)
Definition trigger.h:130
CALLED_AS_TRIGGER
#define CALLED_AS_TRIGGER(fcinfo)
Definition trigger.h:26
TRIGGER_FIRED_FOR_ROW
#define TRIGGER_FIRED_FOR_ROW(event)
Definition trigger.h:124
TRIGGER_FIRED_AFTER
#define TRIGGER_FIRED_AFTER(event)
Definition trigger.h:133
TRIGGER_FIRED_BY_TRUNCATE
#define TRIGGER_FIRED_BY_TRUNCATE(event)
Definition trigger.h:121
TRIGGER_FIRED_BY_INSERT
#define TRIGGER_FIRED_BY_INSERT(event)
Definition trigger.h:112
TRIGGER_FIRED_BY_UPDATE
#define TRIGGER_FIRED_BY_UPDATE(event)
Definition trigger.h:118
TRIGGER_FIRED_INSTEAD
#define TRIGGER_FIRED_INSTEAD(event)
Definition trigger.h:136
CreateTupleDescCopy
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition tupdesc.c:242
ReleaseTupleDesc
#define ReleaseTupleDesc(tupdesc)
Definition tupdesc.h:238
TupleDescAttr
static FormData_pg_attribute * TupleDescAttr(TupleDesc tupdesc, int i)
Definition tupdesc.h:178
tuplestore_begin_heap
Tuplestorestate * tuplestore_begin_heap(bool randomAccess, bool interXact, int maxKBytes)
Definition tuplestore.c:331
tuplestore_putvalues
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, const Datum *values, const bool *isnull)
Definition tuplestore.c:785
tuplestore_puttuple
void tuplestore_puttuple(Tuplestorestate *state, HeapTuple tuple)
Definition tuplestore.c:765
lookup_rowtype_tupdesc
TupleDesc lookup_rowtype_tupdesc(Oid type_id, int32 typmod)
Definition typcache.c:1947
BeginInternalSubTransaction
void BeginInternalSubTransaction(const char *name)
Definition xact.c:4717
RollbackAndReleaseCurrentSubTransaction
void RollbackAndReleaseCurrentSubTransaction(void)
Definition xact.c:4819
ReleaseCurrentSubTransaction
void ReleaseCurrentSubTransaction(void)
Definition xact.c:4791

◆ TEXTDOMAIN

#define TEXTDOMAIN   PG_TEXTDOMAIN("pltcl")

Definition at line 68 of file pltcl.c.

◆ UTF_BEGIN

#define UTF_BEGIN
Value:
do { \
const char *_pltcl_utf_src = NULL; \
char *_pltcl_utf_dst = NULL

Definition at line 93 of file pltcl.c.

94 { \
95 const char *_pltcl_utf_src = NULL; \
96 char *_pltcl_utf_dst = NULL

◆ UTF_E2U

#define UTF_E2U (   x)     (_pltcl_utf_dst = utf_e2u(_pltcl_utf_src = (x)))

Definition at line 106 of file pltcl.c.

◆ UTF_END

#define UTF_END
Value:
if (_pltcl_utf_src != (const char *) _pltcl_utf_dst) \
pfree(_pltcl_utf_dst); \
} while (0)

Definition at line 98 of file pltcl.c.

◆ UTF_U2E

#define UTF_U2E (   x)     (_pltcl_utf_dst = utf_u2e(_pltcl_utf_src = (x)))

Definition at line 103 of file pltcl.c.

Typedef Documentation

◆ pltcl_call_state

typedef struct pltcl_call_state pltcl_call_state

◆ pltcl_interp_desc

typedef struct pltcl_interp_desc pltcl_interp_desc

◆ pltcl_proc_desc

typedef struct pltcl_proc_desc pltcl_proc_desc

◆ pltcl_proc_key

typedef struct pltcl_proc_key pltcl_proc_key

◆ pltcl_proc_ptr

typedef struct pltcl_proc_ptr pltcl_proc_ptr

◆ pltcl_query_desc

typedef struct pltcl_query_desc pltcl_query_desc

◆ Tcl_Size

typedef int Tcl_Size

Definition at line 63 of file pltcl.c.

Function Documentation

◆ _PG_init()

void _PG_init ( void  )

Definition at line 409 of file pltcl.c.

410{
411 Tcl_NotifierProcs notifier;
412 HASHCTL hash_ctl;
413
414 /* Be sure we do initialization only once (should be redundant now) */
415 if (pltcl_pm_init_done)
416 return;
417
418 pg_bindtextdomain(TEXTDOMAIN);
419
420#ifdef WIN32
421 /* Required on win32 to prevent error loading init.tcl */
422 Tcl_FindExecutable("");
423#endif
424
425 /*
426 * Override the functions in the Notifier subsystem. See comments above.
427 */
428 notifier.setTimerProc = pltcl_SetTimer;
429 notifier.waitForEventProc = pltcl_WaitForEvent;
430 notifier.createFileHandlerProc = pltcl_CreateFileHandler;
431 notifier.deleteFileHandlerProc = pltcl_DeleteFileHandler;
432 notifier.initNotifierProc = pltcl_InitNotifier;
433 notifier.finalizeNotifierProc = pltcl_FinalizeNotifier;
434 notifier.alertNotifierProc = pltcl_AlertNotifier;
435 notifier.serviceModeHookProc = pltcl_ServiceModeHook;
436 Tcl_SetNotifier(&notifier);
437
438 /************************************************************
439 * Create the dummy hold interpreter to prevent close of
440 * stdout and stderr on DeleteInterp
441 ************************************************************/
442 if ((pltcl_hold_interp = Tcl_CreateInterp()) == NULL)
443 elog(ERROR, "could not create dummy Tcl interpreter");
444 if (Tcl_Init(pltcl_hold_interp) == TCL_ERROR)
445 elog(ERROR, "could not initialize dummy Tcl interpreter");
446
447 /************************************************************
448 * Create the hash table for working interpreters
449 ************************************************************/
450 hash_ctl.keysize = sizeof(Oid);
451 hash_ctl.entrysize = sizeof(pltcl_interp_desc);
452 pltcl_interp_htab = hash_create("PL/Tcl interpreters",
453 8,
454 &hash_ctl,
455 HASH_ELEM | HASH_BLOBS);
456
457 /************************************************************
458 * Create the hash table for function lookup
459 ************************************************************/
460 hash_ctl.keysize = sizeof(pltcl_proc_key);
461 hash_ctl.entrysize = sizeof(pltcl_proc_ptr);
462 pltcl_proc_htab = hash_create("PL/Tcl functions",
463 100,
464 &hash_ctl,
465 HASH_ELEM | HASH_BLOBS);
466
467 /************************************************************
468 * Define PL/Tcl's custom GUCs
469 ************************************************************/
470 DefineCustomStringVariable("pltcl.start_proc",
471 gettext_noop("PL/Tcl function to call once when pltcl is first used."),
472 NULL,
473 &pltcl_start_proc,
474 NULL,
475 PGC_SUSET, 0,
476 NULL, NULL, NULL);
477 DefineCustomStringVariable("pltclu.start_proc",
478 gettext_noop("PL/TclU function to call once when pltclu is first used."),
479 NULL,
480 &pltclu_start_proc,
481 NULL,
482 PGC_SUSET, 0,
483 NULL, NULL, NULL);
484
485 MarkGUCPrefixReserved("pltcl");
486 MarkGUCPrefixReserved("pltclu");
487
488 pltcl_pm_init_done = true;
489}

References DefineCustomStringVariable(), elog, ERROR, fb(), gettext_noop, HASH_BLOBS, hash_create(), HASH_ELEM, MarkGUCPrefixReserved(), pg_bindtextdomain(), PGC_SUSET, pltcl_AlertNotifier(), pltcl_CreateFileHandler(), pltcl_DeleteFileHandler(), pltcl_FinalizeNotifier(), pltcl_hold_interp, pltcl_InitNotifier(), pltcl_interp_htab, pltcl_pm_init_done, pltcl_proc_htab, pltcl_ServiceModeHook(), pltcl_SetTimer(), pltcl_start_proc, pltcl_WaitForEvent(), pltclu_start_proc, and TEXTDOMAIN.

◆ call_pltcl_start_proc()

static void call_pltcl_start_proc ( Oid  prolang,
bool  pltrusted 
)
static

Definition at line 598 of file pltcl.c.

599{
600 LOCAL_FCINFO(fcinfo, 0);
601 char *start_proc;
602 const char *gucname;
603 ErrorContextCallback errcallback;
604 List *namelist;
605 Oid procOid;
606 HeapTuple procTup;
607 Form_pg_proc procStruct;
608 AclResult aclresult;
609 FmgrInfo finfo;
610 PgStat_FunctionCallUsage fcusage;
611
612 /* select appropriate GUC */
613 start_proc = pltrusted ? pltcl_start_proc : pltclu_start_proc;
614 gucname = pltrusted ? "pltcl.start_proc" : "pltclu.start_proc";
615
616 /* Nothing to do if it's empty or unset */
617 if (start_proc == NULL || start_proc[0] == '\0')
618 return;
619
620 /* Set up errcontext callback to make errors more helpful */
621 errcallback.callback = start_proc_error_callback;
622 errcallback.arg = unconstify(char *, gucname);
623 errcallback.previous = error_context_stack;
624 error_context_stack = &errcallback;
625
626 /* Parse possibly-qualified identifier and look up the function */
627 namelist = stringToQualifiedNameList(start_proc, NULL);
628 procOid = LookupFuncName(namelist, 0, NULL, false);
629
630 /* Current user must have permission to call function */
631 aclresult = object_aclcheck(ProcedureRelationId, procOid, GetUserId(), ACL_EXECUTE);
632 if (aclresult != ACLCHECK_OK)
633 aclcheck_error(aclresult, OBJECT_FUNCTION, start_proc);
634
635 /* Get the function's pg_proc entry */
636 procTup = SearchSysCache1(PROCOID, ObjectIdGetDatum(procOid));
637 if (!HeapTupleIsValid(procTup))
638 elog(ERROR, "cache lookup failed for function %u", procOid);
639 procStruct = (Form_pg_proc) GETSTRUCT(procTup);
640
641 /* It must be same language as the function we're currently calling */
642 if (procStruct->prolang != prolang)
643 ereport(ERROR,
644 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
645 errmsg("function \"%s\" is in the wrong language",
646 start_proc)));
647
648 /*
649 * It must not be SECURITY DEFINER, either. This together with the
650 * language match check ensures that the function will execute in the same
651 * Tcl interpreter we just finished initializing.
652 */
653 if (procStruct->prosecdef)
654 ereport(ERROR,
655 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
656 errmsg("function \"%s\" must not be SECURITY DEFINER",
657 start_proc)));
658
659 /* A-OK */
660 ReleaseSysCache(procTup);
661
662 /*
663 * Call the function using the normal SQL function call mechanism. We
664 * could perhaps cheat and jump directly to pltcl_handler(), but it seems
665 * better to do it this way so that the call is exposed to, eg, call
666 * statistics collection.
667 */
668 InvokeFunctionExecuteHook(procOid);
669 fmgr_info(procOid, &finfo);
670 InitFunctionCallInfoData(*fcinfo, &finfo,
671 0,
672 InvalidOid, NULL, NULL);
673 pgstat_init_function_usage(fcinfo, &fcusage);
674 (void) FunctionCallInvoke(fcinfo);
675 pgstat_end_function_usage(&fcusage, true);
676
677 /* Pop the error context stack */
678 error_context_stack = errcallback.previous;
679}

References ACL_EXECUTE, aclcheck_error(), ACLCHECK_OK, ErrorContextCallback::arg, ErrorContextCallback::callback, elog, ereport, errcode(), errmsg, ERROR, error_context_stack, fb(), fmgr_info(), Form_pg_proc, FunctionCallInvoke, GETSTRUCT(), GetUserId(), HeapTupleIsValid, InitFunctionCallInfoData, InvalidOid, InvokeFunctionExecuteHook, LOCAL_FCINFO, LookupFuncName(), object_aclcheck(), OBJECT_FUNCTION, ObjectIdGetDatum(), pgstat_end_function_usage(), pgstat_init_function_usage(), pltcl_start_proc, pltclu_start_proc, ErrorContextCallback::previous, ReleaseSysCache(), SearchSysCache1(), start_proc_error_callback(), stringToQualifiedNameList(), and unconstify.

Referenced by pltcl_init_interp().

◆ compile_pltcl_function()

static pltcl_proc_desc * compile_pltcl_function ( Oid  fn_oid,
Oid  tgreloid,
bool  is_event_trigger,
bool  pltrusted 
)
static

Definition at line 1418 of file pltcl.c.

1420{
1421 HeapTuple procTup;
1422 Form_pg_proc procStruct;
1423 pltcl_proc_key proc_key;
1424 pltcl_proc_ptr *proc_ptr;
1425 bool found;
1426 pltcl_proc_desc *prodesc;
1427 pltcl_proc_desc *old_prodesc;
1428 volatile MemoryContext proc_cxt = NULL;
1429 Tcl_DString proc_internal_def;
1430 Tcl_DString proc_internal_name;
1431 Tcl_DString proc_internal_body;
1432
1433 /* We'll need the pg_proc tuple in any case... */
1434 procTup = SearchSysCache1(PROCOID, ObjectIdGetDatum(fn_oid));
1435 if (!HeapTupleIsValid(procTup))
1436 elog(ERROR, "cache lookup failed for function %u", fn_oid);
1437 procStruct = (Form_pg_proc) GETSTRUCT(procTup);
1438
1439 /*
1440 * Look up function in pltcl_proc_htab; if it's not there, create an entry
1441 * and set the entry's proc_ptr to NULL.
1442 */
1443 proc_key.proc_id = fn_oid;
1444 proc_key.is_trigger = OidIsValid(tgreloid);
1445 proc_key.user_id = pltrusted ? GetUserId() : InvalidOid;
1446
1447 proc_ptr = hash_search(pltcl_proc_htab, &proc_key,
1448 HASH_ENTER,
1449 &found);
1450 if (!found)
1451 proc_ptr->proc_ptr = NULL;
1452
1453 prodesc = proc_ptr->proc_ptr;
1454
1455 /************************************************************
1456 * If it's present, must check whether it's still up to date.
1457 * This is needed because CREATE OR REPLACE FUNCTION can modify the
1458 * function's pg_proc entry without changing its OID.
1459 ************************************************************/
1460 if (prodesc != NULL &&
1461 prodesc->internal_proname != NULL &&
1462 prodesc->fn_xmin == HeapTupleHeaderGetRawXmin(procTup->t_data) &&
1463 ItemPointerEquals(&prodesc->fn_tid, &procTup->t_self))
1464 {
1465 /* It's still up-to-date, so we can use it */
1466 ReleaseSysCache(procTup);
1467 return prodesc;
1468 }
1469
1470 /************************************************************
1471 * If we haven't found it in the hashtable, we analyze
1472 * the functions arguments and returntype and store
1473 * the in-/out-functions in the prodesc block and create
1474 * a new hashtable entry for it.
1475 *
1476 * Then we load the procedure into the Tcl interpreter.
1477 ************************************************************/
1478 Tcl_DStringInit(&proc_internal_def);
1479 Tcl_DStringInit(&proc_internal_name);
1480 Tcl_DStringInit(&proc_internal_body);
1481 PG_TRY();
1482 {
1483 bool is_trigger = OidIsValid(tgreloid);
1484 Tcl_CmdInfo cmdinfo;
1485 const char *user_proname;
1486 const char *internal_proname;
1487 bool need_underscore;
1488 HeapTuple typeTup;
1489 Form_pg_type typeStruct;
1490 char proc_internal_args[33 * FUNC_MAX_ARGS];
1491 Datum prosrcdatum;
1492 char *proc_source;
1493 char buf[48];
1494 pltcl_interp_desc *interp_desc;
1495 Tcl_Interp *interp;
1496 int i;
1497 int tcl_rc;
1498 MemoryContext oldcontext;
1499
1500 /************************************************************
1501 * Identify the interpreter to use for the function
1502 ************************************************************/
1503 interp_desc = pltcl_fetch_interp(procStruct->prolang, pltrusted);
1504 interp = interp_desc->interp;
1505
1506 /************************************************************
1507 * If redefining the function, try to remove the old internal
1508 * procedure from Tcl's namespace. The point of this is partly to
1509 * allow re-use of the same internal proc name, and partly to avoid
1510 * leaking the Tcl procedure object if we end up not choosing the same
1511 * name. We assume that Tcl is smart enough to not physically delete
1512 * the procedure object if it's currently being executed.
1513 ************************************************************/
1514 if (prodesc != NULL &&
1515 prodesc->internal_proname != NULL)
1516 {
1517 /* We simply ignore any error */
1518 (void) Tcl_DeleteCommand(interp, prodesc->internal_proname);
1519 /* Don't do this more than once */
1520 prodesc->internal_proname = NULL;
1521 }
1522
1523 /************************************************************
1524 * Build the proc name we'll use in error messages.
1525 ************************************************************/
1526 user_proname = format_procedure(fn_oid);
1527
1528 /************************************************************
1529 * Build the internal proc name from the user_proname and/or OID.
1530 * The internal name must be all-ASCII since we don't want to deal
1531 * with encoding conversions. We don't want to worry about Tcl
1532 * quoting rules either, so use only the characters of the function
1533 * name that are ASCII alphanumerics, plus underscores to separate
1534 * function name and arguments. If what we end up with isn't
1535 * unique (that is, it matches some existing Tcl command name),
1536 * append the function OID (perhaps repeatedly) so that it is unique.
1537 ************************************************************/
1538
1539 /* For historical reasons, use a function-type-specific prefix */
1540 if (is_event_trigger)
1541 Tcl_DStringAppend(&proc_internal_name,
1542 "__PLTcl_evttrigger_", -1);
1543 else if (is_trigger)
1544 Tcl_DStringAppend(&proc_internal_name,
1545 "__PLTcl_trigger_", -1);
1546 else
1547 Tcl_DStringAppend(&proc_internal_name,
1548 "__PLTcl_proc_", -1);
1549 /* Now add what we can from the user_proname */
1550 need_underscore = false;
1551 for (const char *ptr = user_proname; *ptr; ptr++)
1552 {
1553 if (strchr("ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1554 "abcdefghijklmnopqrstuvwxyz"
1555 "0123456789_", *ptr) != NULL)
1556 {
1557 /* Done this way to avoid adding a trailing underscore */
1558 if (need_underscore)
1559 {
1560 Tcl_DStringAppend(&proc_internal_name, "_", 1);
1561 need_underscore = false;
1562 }
1563 Tcl_DStringAppend(&proc_internal_name, ptr, 1);
1564 }
1565 else if (strchr("(, ", *ptr) != NULL)
1566 need_underscore = true;
1567 }
1568 /* If this name already exists, append fn_oid; repeat as needed */
1569 while (Tcl_GetCommandInfo(interp,
1570 Tcl_DStringValue(&proc_internal_name),
1571 &cmdinfo))
1572 {
1573 snprintf(buf, sizeof(buf), "_%u", fn_oid);
1574 Tcl_DStringAppend(&proc_internal_name, buf, -1);
1575 }
1576 internal_proname = Tcl_DStringValue(&proc_internal_name);
1577
1578 /************************************************************
1579 * Allocate a context that will hold all PG data for the procedure.
1580 ************************************************************/
1581 proc_cxt = AllocSetContextCreate(TopMemoryContext,
1582 "PL/Tcl function",
1583 ALLOCSET_SMALL_SIZES);
1584
1585 /************************************************************
1586 * Allocate and fill a new procedure description block.
1587 * struct prodesc and subsidiary data must all live in proc_cxt.
1588 ************************************************************/
1589 oldcontext = MemoryContextSwitchTo(proc_cxt);
1590 prodesc = palloc0_object(pltcl_proc_desc);
1591 prodesc->user_proname = pstrdup(user_proname);
1592 MemoryContextSetIdentifier(proc_cxt, prodesc->user_proname);
1593 prodesc->internal_proname = pstrdup(internal_proname);
1594 prodesc->fn_cxt = proc_cxt;
1595 prodesc->fn_refcount = 0;
1596 prodesc->fn_xmin = HeapTupleHeaderGetRawXmin(procTup->t_data);
1597 prodesc->fn_tid = procTup->t_self;
1598 prodesc->nargs = procStruct->pronargs;
1599 prodesc->arg_out_func = (FmgrInfo *) palloc0(prodesc->nargs * sizeof(FmgrInfo));
1600 prodesc->arg_is_rowtype = (bool *) palloc0(prodesc->nargs * sizeof(bool));
1601 MemoryContextSwitchTo(oldcontext);
1602
1603 /* Remember if function is STABLE/IMMUTABLE */
1604 prodesc->fn_readonly =
1605 (procStruct->provolatile != PROVOLATILE_VOLATILE);
1606 /* And whether it is trusted */
1607 prodesc->lanpltrusted = pltrusted;
1608 /* Save the associated interpreter, too */
1609 prodesc->interp_desc = interp_desc;
1610
1611 /************************************************************
1612 * Get the required information for input conversion of the
1613 * return value.
1614 ************************************************************/
1615 if (!is_trigger && !is_event_trigger)
1616 {
1617 Oid rettype = procStruct->prorettype;
1618
1619 typeTup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(rettype));
1620 if (!HeapTupleIsValid(typeTup))
1621 elog(ERROR, "cache lookup failed for type %u", rettype);
1622 typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
1623
1624 /* Disallow pseudotype result, except VOID and RECORD */
1625 if (typeStruct->typtype == TYPTYPE_PSEUDO)
1626 {
1627 if (rettype == VOIDOID ||
1628 rettype == RECORDOID)
1629 /* okay */ ;
1630 else if (rettype == TRIGGEROID ||
1631 rettype == EVENT_TRIGGEROID)
1632 ereport(ERROR,
1633 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1634 errmsg("trigger functions can only be called as triggers")));
1635 else
1636 ereport(ERROR,
1637 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1638 errmsg("PL/Tcl functions cannot return type %s",
1639 format_type_be(rettype))));
1640 }
1641
1642 prodesc->result_typid = rettype;
1643 fmgr_info_cxt(typeStruct->typinput,
1644 &(prodesc->result_in_func),
1645 proc_cxt);
1646 prodesc->result_typioparam = getTypeIOParam(typeTup);
1647
1648 prodesc->fn_retisset = procStruct->proretset;
1649 prodesc->fn_retistuple = type_is_rowtype(rettype);
1650 prodesc->fn_retisdomain = (typeStruct->typtype == TYPTYPE_DOMAIN);
1651 prodesc->domain_info = NULL;
1652
1653 ReleaseSysCache(typeTup);
1654 }
1655
1656 /************************************************************
1657 * Get the required information for output conversion
1658 * of all procedure arguments, and set up argument naming info.
1659 ************************************************************/
1660 if (!is_trigger && !is_event_trigger)
1661 {
1662 proc_internal_args[0] = '\0';
1663 for (i = 0; i < prodesc->nargs; i++)
1664 {
1665 Oid argtype = procStruct->proargtypes.values[i];
1666
1667 typeTup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(argtype));
1668 if (!HeapTupleIsValid(typeTup))
1669 elog(ERROR, "cache lookup failed for type %u", argtype);
1670 typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
1671
1672 /* Disallow pseudotype argument, except RECORD */
1673 if (typeStruct->typtype == TYPTYPE_PSEUDO &&
1674 argtype != RECORDOID)
1675 ereport(ERROR,
1676 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1677 errmsg("PL/Tcl functions cannot accept type %s",
1678 format_type_be(argtype))));
1679
1680 if (type_is_rowtype(argtype))
1681 {
1682 prodesc->arg_is_rowtype[i] = true;
1683 snprintf(buf, sizeof(buf), "__PLTcl_Tup_%d", i + 1);
1684 }
1685 else
1686 {
1687 prodesc->arg_is_rowtype[i] = false;
1688 fmgr_info_cxt(typeStruct->typoutput,
1689 &(prodesc->arg_out_func[i]),
1690 proc_cxt);
1691 snprintf(buf, sizeof(buf), "%d", i + 1);
1692 }
1693
1694 if (i > 0)
1695 strcat(proc_internal_args, " ");
1696 strcat(proc_internal_args, buf);
1697
1698 ReleaseSysCache(typeTup);
1699 }
1700 }
1701 else if (is_trigger)
1702 {
1703 /* trigger procedure has fixed args */
1704 strcpy(proc_internal_args,
1705 "TG_name TG_relid TG_table_name TG_table_schema TG_relatts TG_when TG_level TG_op __PLTcl_Tup_NEW __PLTcl_Tup_OLD args");
1706 }
1707 else if (is_event_trigger)
1708 {
1709 /* event trigger procedure has fixed args */
1710 strcpy(proc_internal_args, "TG_event TG_tag");
1711 }
1712
1713 /************************************************************
1714 * Create the tcl command to define the internal
1715 * procedure
1716 *
1717 * Leave this code as DString - performance is not critical here,
1718 * and we don't want to duplicate the knowledge of the Tcl quoting
1719 * rules that's embedded in Tcl_DStringAppendElement.
1720 ************************************************************/
1721 Tcl_DStringAppendElement(&proc_internal_def, "proc");
1722 Tcl_DStringAppendElement(&proc_internal_def, internal_proname);
1723 Tcl_DStringAppendElement(&proc_internal_def, proc_internal_args);
1724
1725 /************************************************************
1726 * prefix procedure body with
1727 * upvar #0 <internal_proname> GD
1728 * and with appropriate setting of arguments
1729 ************************************************************/
1730 Tcl_DStringAppend(&proc_internal_body, "upvar #0 ", -1);
1731 Tcl_DStringAppend(&proc_internal_body, internal_proname, -1);
1732 Tcl_DStringAppend(&proc_internal_body, " GD\n", -1);
1733 if (is_trigger)
1734 {
1735 Tcl_DStringAppend(&proc_internal_body,
1736 "array set NEW $__PLTcl_Tup_NEW\n", -1);
1737 Tcl_DStringAppend(&proc_internal_body,
1738 "array set OLD $__PLTcl_Tup_OLD\n", -1);
1739 Tcl_DStringAppend(&proc_internal_body,
1740 "set i 0\n"
1741 "set v 0\n"
1742 "foreach v $args {\n"
1743 " incr i\n"
1744 " set $i $v\n"
1745 "}\n"
1746 "unset i v\n\n", -1);
1747 }
1748 else if (is_event_trigger)
1749 {
1750 /* no argument support for event triggers */
1751 }
1752 else
1753 {
1754 for (i = 0; i < prodesc->nargs; i++)
1755 {
1756 if (prodesc->arg_is_rowtype[i])
1757 {
1758 snprintf(buf, sizeof(buf),
1759 "array set %d $__PLTcl_Tup_%d\n",
1760 i + 1, i + 1);
1761 Tcl_DStringAppend(&proc_internal_body, buf, -1);
1762 }
1763 }
1764 }
1765
1766 /************************************************************
1767 * Add user's function definition to proc body
1768 ************************************************************/
1769 prosrcdatum = SysCacheGetAttrNotNull(PROCOID, procTup,
1770 Anum_pg_proc_prosrc);
1771 proc_source = TextDatumGetCString(prosrcdatum);
1772 UTF_BEGIN;
1773 Tcl_DStringAppend(&proc_internal_body, UTF_E2U(proc_source), -1);
1774 UTF_END;
1775 pfree(proc_source);
1776 Tcl_DStringAppendElement(&proc_internal_def,
1777 Tcl_DStringValue(&proc_internal_body));
1778
1779 /************************************************************
1780 * Create the procedure in the interpreter
1781 ************************************************************/
1782 tcl_rc = Tcl_EvalEx(interp,
1783 Tcl_DStringValue(&proc_internal_def),
1784 Tcl_DStringLength(&proc_internal_def),
1785 TCL_EVAL_GLOBAL);
1786 if (tcl_rc != TCL_OK)
1787 ereport(ERROR,
1788 (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1789 errmsg("could not create internal procedure \"%s\": %s",
1790 internal_proname,
1791 utf_u2e(Tcl_GetStringResult(interp)))));
1792 }
1793 PG_CATCH();
1794 {
1795 /*
1796 * If we failed anywhere above, clean up whatever got allocated. It
1797 * should all be in the proc_cxt, except for the DStrings.
1798 */
1799 if (proc_cxt)
1800 MemoryContextDelete(proc_cxt);
1801 Tcl_DStringFree(&proc_internal_def);
1802 Tcl_DStringFree(&proc_internal_name);
1803 Tcl_DStringFree(&proc_internal_body);
1804 PG_RE_THROW();
1805 }
1806 PG_END_TRY();
1807
1808 /*
1809 * Install the new proc description block in the hashtable, incrementing
1810 * its refcount (the hashtable link counts as a reference). Then, if
1811 * there was a previous definition of the function, decrement that one's
1812 * refcount, and delete it if no longer referenced. The order of
1813 * operations here is important: if something goes wrong during the
1814 * MemoryContextDelete, leaking some memory for the old definition is OK,
1815 * but we don't want to corrupt the live hashtable entry. (Likewise,
1816 * freeing the DStrings is pretty low priority if that happens.)
1817 */
1818 old_prodesc = proc_ptr->proc_ptr;
1819
1820 proc_ptr->proc_ptr = prodesc;
1821 prodesc->fn_refcount++;
1822
1823 if (old_prodesc != NULL)
1824 {
1825 Assert(old_prodesc->fn_refcount > 0);
1826 if (--old_prodesc->fn_refcount == 0)
1827 MemoryContextDelete(old_prodesc->fn_cxt);
1828 }
1829
1830 Tcl_DStringFree(&proc_internal_def);
1831 Tcl_DStringFree(&proc_internal_name);
1832 Tcl_DStringFree(&proc_internal_body);
1833
1834 ReleaseSysCache(procTup);
1835
1836 return prodesc;
1837}

References ALLOCSET_SMALL_SIZES, AllocSetContextCreate, pltcl_proc_desc::arg_is_rowtype, pltcl_proc_desc::arg_out_func, Assert, buf, pltcl_proc_desc::domain_info, elog, ereport, errcode(), errmsg, ERROR, fb(), fmgr_info_cxt(), pltcl_proc_desc::fn_cxt, pltcl_proc_desc::fn_readonly, pltcl_proc_desc::fn_refcount, pltcl_proc_desc::fn_retisdomain, pltcl_proc_desc::fn_retisset, pltcl_proc_desc::fn_retistuple, pltcl_proc_desc::fn_tid, pltcl_proc_desc::fn_xmin, Form_pg_proc, Form_pg_type, format_procedure(), format_type_be(), FUNC_MAX_ARGS, GETSTRUCT(), getTypeIOParam(), GetUserId(), HASH_ENTER, hash_search(), HeapTupleHeaderGetRawXmin(), HeapTupleIsValid, i, pltcl_proc_desc::internal_proname, pltcl_interp_desc::interp, pltcl_proc_desc::interp_desc, InvalidOid, pltcl_proc_key::is_trigger, ItemPointerEquals(), pltcl_proc_desc::lanpltrusted, MemoryContextDelete(), MemoryContextSetIdentifier(), MemoryContextSwitchTo(), pltcl_proc_desc::nargs, ObjectIdGetDatum(), OidIsValid, palloc0(), palloc0_object, pfree(), PG_CATCH, PG_END_TRY, PG_RE_THROW, PG_TRY, pltcl_fetch_interp(), pltcl_proc_htab, pltcl_proc_key::proc_id, pltcl_proc_ptr::proc_ptr, pstrdup(), ReleaseSysCache(), pltcl_proc_desc::result_in_func, pltcl_proc_desc::result_typid, pltcl_proc_desc::result_typioparam, SearchSysCache1(), snprintf, SysCacheGetAttrNotNull(), TextDatumGetCString, TopMemoryContext, type_is_rowtype(), pltcl_proc_key::user_id, pltcl_proc_desc::user_proname, UTF_BEGIN, UTF_E2U, UTF_END, and utf_u2e().

Referenced by pltcl_event_trigger_handler(), pltcl_func_handler(), and pltcl_trigger_handler().

◆ PG_FUNCTION_INFO_V1() [1/2]

PG_FUNCTION_INFO_V1 ( pltcl_call_handler  )

◆ PG_FUNCTION_INFO_V1() [2/2]

PG_FUNCTION_INFO_V1 ( pltclu_call_handler  )

◆ PG_MODULE_MAGIC_EXT()

PG_MODULE_MAGIC_EXT ( .  name = "pltcl",
.  version = PG_VERSION 
)

◆ pltcl_AlertNotifier()

static void pltcl_AlertNotifier ( ClientData  clientData)
static

Definition at line 373 of file pltcl.c.

374{
375}

Referenced by _PG_init().

◆ pltcl_argisnull()

static int pltcl_argisnull ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 2148 of file pltcl.c.

2150{
2151 int argno;
2152 FunctionCallInfo fcinfo = pltcl_current_call_state->fcinfo;
2153
2154 /************************************************************
2155 * Check call syntax
2156 ************************************************************/
2157 if (objc != 2)
2158 {
2159 Tcl_WrongNumArgs(interp, 1, objv, "argno");
2160 return TCL_ERROR;
2161 }
2162
2163 /************************************************************
2164 * Check that we're called as a normal function
2165 ************************************************************/
2166 if (fcinfo == NULL)
2167 {
2168 Tcl_SetObjResult(interp,
2169 Tcl_NewStringObj("argisnull cannot be used in triggers", -1));
2170 return TCL_ERROR;
2171 }
2172
2173 /************************************************************
2174 * Get the argument number
2175 ************************************************************/
2176 if (Tcl_GetIntFromObj(interp, objv[1], &argno) != TCL_OK)
2177 return TCL_ERROR;
2178
2179 /************************************************************
2180 * Check that the argno is valid
2181 ************************************************************/
2182 argno--;
2183 if (argno < 0 || argno >= fcinfo->nargs)
2184 {
2185 Tcl_SetObjResult(interp,
2186 Tcl_NewStringObj("argno out of range", -1));
2187 return TCL_ERROR;
2188 }
2189
2190 /************************************************************
2191 * Get the requested NULL state
2192 ************************************************************/
2193 Tcl_SetObjResult(interp, Tcl_NewBooleanObj(PG_ARGISNULL(argno)));
2194 return TCL_OK;
2195}

References fb(), pltcl_call_state::fcinfo, FunctionCallInfoBaseData::nargs, PG_ARGISNULL, and pltcl_current_call_state.

Referenced by pltcl_init_interp().

◆ pltcl_build_tuple_argument()

static Tcl_Obj * pltcl_build_tuple_argument ( HeapTuple  tuple,
TupleDesc  tupdesc,
bool  include_generated 
)
static

Definition at line 3189 of file pltcl.c.

3190{
3191 Tcl_Obj *retobj = Tcl_NewObj();
3192 int i;
3193 char *outputstr;
3194 Datum attr;
3195 bool isnull;
3196 char *attname;
3197 Oid typoutput;
3198 bool typisvarlena;
3199
3200 for (i = 0; i < tupdesc->natts; i++)
3201 {
3202 Form_pg_attribute att = TupleDescAttr(tupdesc, i);
3203
3204 /* ignore dropped attributes */
3205 if (att->attisdropped)
3206 continue;
3207
3208 if (att->attgenerated)
3209 {
3210 /* don't include unless requested */
3211 if (!include_generated)
3212 continue;
3213 /* never include virtual columns */
3214 if (att->attgenerated == ATTRIBUTE_GENERATED_VIRTUAL)
3215 continue;
3216 }
3217
3218 /************************************************************
3219 * Get the attribute name
3220 ************************************************************/
3221 attname = NameStr(att->attname);
3222
3223 /************************************************************
3224 * Get the attributes value
3225 ************************************************************/
3226 attr = heap_getattr(tuple, i + 1, tupdesc, &isnull);
3227
3228 /************************************************************
3229 * If there is a value, append the attribute name and the
3230 * value to the list
3231 *
3232 * Hmmm - Null attributes will cause functions to
3233 * crash if they don't expect them - need something
3234 * smarter here.
3235 ************************************************************/
3236 if (!isnull)
3237 {
3238 getTypeOutputInfo(att->atttypid,
3239 &typoutput, &typisvarlena);
3240 outputstr = OidOutputFunctionCall(typoutput, attr);
3241 UTF_BEGIN;
3242 Tcl_ListObjAppendElement(NULL, retobj,
3243 Tcl_NewStringObj(UTF_E2U(attname), -1));
3244 UTF_END;
3245 UTF_BEGIN;
3246 Tcl_ListObjAppendElement(NULL, retobj,
3247 Tcl_NewStringObj(UTF_E2U(outputstr), -1));
3248 UTF_END;
3249 pfree(outputstr);
3250 }
3251 }
3252
3253 return retobj;
3254}

References attname, fb(), getTypeOutputInfo(), heap_getattr(), i, NameStr, TupleDescData::natts, OidOutputFunctionCall(), pfree(), TupleDescAttr(), UTF_BEGIN, UTF_E2U, and UTF_END.

Referenced by pltcl_func_handler(), and pltcl_trigger_handler().

◆ pltcl_build_tuple_result()

static HeapTuple pltcl_build_tuple_result ( Tcl_Interp *  interp,
Tcl_Obj **  kvObjv,
int  kvObjc,
pltcl_call_state *  call_state 
)
static

Definition at line 3268 of file pltcl.c.

3270{
3271 HeapTuple tuple;
3272 TupleDesc tupdesc;
3273 AttInMetadata *attinmeta;
3274 char **values;
3275 int i;
3276
3277 if (call_state->ret_tupdesc)
3278 {
3279 tupdesc = call_state->ret_tupdesc;
3280 attinmeta = call_state->attinmeta;
3281 }
3282 else if (call_state->trigdata)
3283 {
3284 tupdesc = RelationGetDescr(call_state->trigdata->tg_relation);
3285 attinmeta = TupleDescGetAttInMetadata(tupdesc);
3286 }
3287 else
3288 {
3289 elog(ERROR, "PL/Tcl function does not return a tuple");
3290 tupdesc = NULL; /* keep compiler quiet */
3291 attinmeta = NULL;
3292 }
3293
3294 values = (char **) palloc0(tupdesc->natts * sizeof(char *));
3295
3296 if (kvObjc % 2 != 0)
3297 ereport(ERROR,
3298 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3299 errmsg("column name/value list must have even number of elements")));
3300
3301 for (i = 0; i < kvObjc; i += 2)
3302 {
3303 char *fieldName = utf_u2e(Tcl_GetString(kvObjv[i]));
3304 int attn = SPI_fnumber(tupdesc, fieldName);
3305
3306 /*
3307 * We silently ignore ".tupno", if it's present but doesn't match any
3308 * actual output column. This allows direct use of a row returned by
3309 * pltcl_set_tuple_values().
3310 */
3311 if (attn == SPI_ERROR_NOATTRIBUTE)
3312 {
3313 if (strcmp(fieldName, ".tupno") == 0)
3314 continue;
3315 ereport(ERROR,
3316 (errcode(ERRCODE_UNDEFINED_COLUMN),
3317 errmsg("column name/value list contains nonexistent column name \"%s\"",
3318 fieldName)));
3319 }
3320
3321 if (attn <= 0)
3322 ereport(ERROR,
3323 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3324 errmsg("cannot set system attribute \"%s\"",
3325 fieldName)));
3326
3327 if (TupleDescAttr(tupdesc, attn - 1)->attgenerated)
3328 ereport(ERROR,
3329 (errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
3330 errmsg("cannot set generated column \"%s\"",
3331 fieldName)));
3332
3333 values[attn - 1] = utf_u2e(Tcl_GetString(kvObjv[i + 1]));
3334 }
3335
3336 tuple = BuildTupleFromCStrings(attinmeta, values);
3337
3338 /* if result type is domain-over-composite, check domain constraints */
3339 if (call_state->prodesc->fn_retisdomain)
3340 domain_check(HeapTupleGetDatum(tuple), false,
3341 call_state->prodesc->result_typid,
3342 &call_state->prodesc->domain_info,
3343 call_state->prodesc->fn_cxt);
3344
3345 return tuple;
3346}

References BuildTupleFromCStrings(), domain_check(), elog, ereport, errcode(), errmsg, ERROR, fb(), HeapTupleGetDatum(), i, TupleDescData::natts, palloc0(), RelationGetDescr, SPI_ERROR_NOATTRIBUTE, SPI_fnumber(), TupleDescAttr(), TupleDescGetAttInMetadata(), utf_u2e(), and values.

Referenced by pltcl_func_handler(), pltcl_returnnext(), and pltcl_trigger_handler().

◆ pltcl_call_handler()

Datum pltcl_call_handler ( PG_FUNCTION_ARGS  )

Definition at line 705 of file pltcl.c.

706{
707 return pltcl_handler(fcinfo, true);
708}

References pltcl_handler().

◆ pltcl_commit()

static int pltcl_commit ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 3024 of file pltcl.c.

3026{
3027 MemoryContext oldcontext = CurrentMemoryContext;
3028
3029 PG_TRY();
3030 {
3031 SPI_commit();
3032 }
3033 PG_CATCH();
3034 {
3035 ErrorData *edata;
3036
3037 /* Save error info */
3038 MemoryContextSwitchTo(oldcontext);
3039 edata = CopyErrorData();
3040 FlushErrorState();
3041
3042 /* Pass the error data to Tcl */
3043 pltcl_construct_errorCode(interp, edata);
3044 UTF_BEGIN;
3045 Tcl_SetObjResult(interp, Tcl_NewStringObj(UTF_E2U(edata->message), -1));
3046 UTF_END;
3047 FreeErrorData(edata);
3048
3049 return TCL_ERROR;
3050 }
3051 PG_END_TRY();
3052
3053 return TCL_OK;
3054}

References CopyErrorData(), CurrentMemoryContext, fb(), FlushErrorState(), FreeErrorData(), MemoryContextSwitchTo(), PG_CATCH, PG_END_TRY, PG_TRY, pltcl_construct_errorCode(), SPI_commit(), UTF_BEGIN, UTF_E2U, and UTF_END.

Referenced by pltcl_init_interp().

◆ pltcl_construct_errorCode()

static void pltcl_construct_errorCode ( Tcl_Interp *  interp,
ErrorData *  edata 
)
static

Definition at line 1931 of file pltcl.c.

1932{
1933 Tcl_Obj *obj = Tcl_NewObj();
1934
1935 Tcl_ListObjAppendElement(interp, obj,
1936 Tcl_NewStringObj("POSTGRES", -1));
1937 Tcl_ListObjAppendElement(interp, obj,
1938 Tcl_NewStringObj(PG_VERSION, -1));
1939 Tcl_ListObjAppendElement(interp, obj,
1940 Tcl_NewStringObj("SQLSTATE", -1));
1941 Tcl_ListObjAppendElement(interp, obj,
1942 Tcl_NewStringObj(unpack_sql_state(edata->sqlerrcode), -1));
1943 Tcl_ListObjAppendElement(interp, obj,
1944 Tcl_NewStringObj("condition", -1));
1945 Tcl_ListObjAppendElement(interp, obj,
1946 Tcl_NewStringObj(pltcl_get_condition_name(edata->sqlerrcode), -1));
1947 Tcl_ListObjAppendElement(interp, obj,
1948 Tcl_NewStringObj("message", -1));
1949 UTF_BEGIN;
1950 Tcl_ListObjAppendElement(interp, obj,
1951 Tcl_NewStringObj(UTF_E2U(edata->message), -1));
1952 UTF_END;
1953 if (edata->detail)
1954 {
1955 Tcl_ListObjAppendElement(interp, obj,
1956 Tcl_NewStringObj("detail", -1));
1957 UTF_BEGIN;
1958 Tcl_ListObjAppendElement(interp, obj,
1959 Tcl_NewStringObj(UTF_E2U(edata->detail), -1));
1960 UTF_END;
1961 }
1962 if (edata->hint)
1963 {
1964 Tcl_ListObjAppendElement(interp, obj,
1965 Tcl_NewStringObj("hint", -1));
1966 UTF_BEGIN;
1967 Tcl_ListObjAppendElement(interp, obj,
1968 Tcl_NewStringObj(UTF_E2U(edata->hint), -1));
1969 UTF_END;
1970 }
1971 if (edata->context)
1972 {
1973 Tcl_ListObjAppendElement(interp, obj,
1974 Tcl_NewStringObj("context", -1));
1975 UTF_BEGIN;
1976 Tcl_ListObjAppendElement(interp, obj,
1977 Tcl_NewStringObj(UTF_E2U(edata->context), -1));
1978 UTF_END;
1979 }
1980 if (edata->schema_name)
1981 {
1982 Tcl_ListObjAppendElement(interp, obj,
1983 Tcl_NewStringObj("schema", -1));
1984 UTF_BEGIN;
1985 Tcl_ListObjAppendElement(interp, obj,
1986 Tcl_NewStringObj(UTF_E2U(edata->schema_name), -1));
1987 UTF_END;
1988 }
1989 if (edata->table_name)
1990 {
1991 Tcl_ListObjAppendElement(interp, obj,
1992 Tcl_NewStringObj("table", -1));
1993 UTF_BEGIN;
1994 Tcl_ListObjAppendElement(interp, obj,
1995 Tcl_NewStringObj(UTF_E2U(edata->table_name), -1));
1996 UTF_END;
1997 }
1998 if (edata->column_name)
1999 {
2000 Tcl_ListObjAppendElement(interp, obj,
2001 Tcl_NewStringObj("column", -1));
2002 UTF_BEGIN;
2003 Tcl_ListObjAppendElement(interp, obj,
2004 Tcl_NewStringObj(UTF_E2U(edata->column_name), -1));
2005 UTF_END;
2006 }
2007 if (edata->datatype_name)
2008 {
2009 Tcl_ListObjAppendElement(interp, obj,
2010 Tcl_NewStringObj("datatype", -1));
2011 UTF_BEGIN;
2012 Tcl_ListObjAppendElement(interp, obj,
2013 Tcl_NewStringObj(UTF_E2U(edata->datatype_name), -1));
2014 UTF_END;
2015 }
2016 if (edata->constraint_name)
2017 {
2018 Tcl_ListObjAppendElement(interp, obj,
2019 Tcl_NewStringObj("constraint", -1));
2020 UTF_BEGIN;
2021 Tcl_ListObjAppendElement(interp, obj,
2022 Tcl_NewStringObj(UTF_E2U(edata->constraint_name), -1));
2023 UTF_END;
2024 }
2025 /* cursorpos is never interesting here; report internal query/pos */
2026 if (edata->internalquery)
2027 {
2028 Tcl_ListObjAppendElement(interp, obj,
2029 Tcl_NewStringObj("statement", -1));
2030 UTF_BEGIN;
2031 Tcl_ListObjAppendElement(interp, obj,
2032 Tcl_NewStringObj(UTF_E2U(edata->internalquery), -1));
2033 UTF_END;
2034 }
2035 if (edata->internalpos > 0)
2036 {
2037 Tcl_ListObjAppendElement(interp, obj,
2038 Tcl_NewStringObj("cursor_position", -1));
2039 Tcl_ListObjAppendElement(interp, obj,
2040 Tcl_NewIntObj(edata->internalpos));
2041 }
2042 if (edata->filename)
2043 {
2044 Tcl_ListObjAppendElement(interp, obj,
2045 Tcl_NewStringObj("filename", -1));
2046 UTF_BEGIN;
2047 Tcl_ListObjAppendElement(interp, obj,
2048 Tcl_NewStringObj(UTF_E2U(edata->filename), -1));
2049 UTF_END;
2050 }
2051 if (edata->lineno > 0)
2052 {
2053 Tcl_ListObjAppendElement(interp, obj,
2054 Tcl_NewStringObj("lineno", -1));
2055 Tcl_ListObjAppendElement(interp, obj,
2056 Tcl_NewIntObj(edata->lineno));
2057 }
2058 if (edata->funcname)
2059 {
2060 Tcl_ListObjAppendElement(interp, obj,
2061 Tcl_NewStringObj("funcname", -1));
2062 UTF_BEGIN;
2063 Tcl_ListObjAppendElement(interp, obj,
2064 Tcl_NewStringObj(UTF_E2U(edata->funcname), -1));
2065 UTF_END;
2066 }
2067
2068 Tcl_SetObjErrorCode(interp, obj);
2069}

References fb(), pltcl_get_condition_name(), unpack_sql_state(), UTF_BEGIN, UTF_E2U, and UTF_END.

Referenced by pltcl_commit(), pltcl_elog(), pltcl_rollback(), and pltcl_subtrans_abort().

◆ pltcl_CreateFileHandler()

static void pltcl_CreateFileHandler ( int  fd,
int  mask,
Tcl_FileProc *  proc,
ClientData  clientData 
)
static

Definition at line 378 of file pltcl.c.

380{
381}

Referenced by _PG_init().

◆ pltcl_DeleteFileHandler()

static void pltcl_DeleteFileHandler ( int  fd)
static

Definition at line 384 of file pltcl.c.

385{
386}

Referenced by _PG_init().

◆ pltcl_elog()

static int pltcl_elog ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 1844 of file pltcl.c.

1846{
1847 volatile int level;
1848 MemoryContext oldcontext;
1849 int priIndex;
1850
1851 static const char *logpriorities[] = {
1852 "DEBUG", "LOG", "INFO", "NOTICE",
1853 "WARNING", "ERROR", "FATAL", (const char *) NULL
1854 };
1855
1856 static const int loglevels[] = {
1857 DEBUG2, LOG, INFO, NOTICE,
1858 WARNING, ERROR, FATAL
1859 };
1860
1861 if (objc != 3)
1862 {
1863 Tcl_WrongNumArgs(interp, 1, objv, "level msg");
1864 return TCL_ERROR;
1865 }
1866
1867 if (Tcl_GetIndexFromObj(interp, objv[1], logpriorities, "priority",
1868 TCL_EXACT, &priIndex) != TCL_OK)
1869 return TCL_ERROR;
1870
1871 level = loglevels[priIndex];
1872
1873 if (level == ERROR)
1874 {
1875 /*
1876 * We just pass the error back to Tcl. If it's not caught, it'll
1877 * eventually get converted to a PG error when we reach the call
1878 * handler.
1879 */
1880 Tcl_SetObjResult(interp, objv[2]);
1881 return TCL_ERROR;
1882 }
1883
1884 /*
1885 * For non-error messages, just pass 'em to ereport(). We do not expect
1886 * that this will fail, but just on the off chance it does, report the
1887 * error back to Tcl. Note we are assuming that ereport() can't have any
1888 * internal failures that are so bad as to require a transaction abort.
1889 *
1890 * This path is also used for FATAL errors, which aren't going to come
1891 * back to us at all.
1892 */
1893 oldcontext = CurrentMemoryContext;
1894 PG_TRY();
1895 {
1896 UTF_BEGIN;
1897 ereport(level,
1898 (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1899 errmsg("%s", UTF_U2E(Tcl_GetString(objv[2])))));
1900 UTF_END;
1901 }
1902 PG_CATCH();
1903 {
1904 ErrorData *edata;
1905
1906 /* Must reset elog.c's state */
1907 MemoryContextSwitchTo(oldcontext);
1908 edata = CopyErrorData();
1909 FlushErrorState();
1910
1911 /* Pass the error data to Tcl */
1912 pltcl_construct_errorCode(interp, edata);
1913 UTF_BEGIN;
1914 Tcl_SetObjResult(interp, Tcl_NewStringObj(UTF_E2U(edata->message), -1));
1915 UTF_END;
1916 FreeErrorData(edata);
1917
1918 return TCL_ERROR;
1919 }
1920 PG_END_TRY();
1921
1922 return TCL_OK;
1923}

References CopyErrorData(), CurrentMemoryContext, DEBUG2, ereport, errcode(), errmsg, ERROR, FATAL, fb(), FlushErrorState(), FreeErrorData(), INFO, LOG, MemoryContextSwitchTo(), NOTICE, PG_CATCH, PG_END_TRY, PG_TRY, pltcl_construct_errorCode(), UTF_BEGIN, UTF_E2U, UTF_END, UTF_U2E, and WARNING.

Referenced by pltcl_init_interp().

◆ pltcl_event_trigger_handler()

static void pltcl_event_trigger_handler ( PG_FUNCTION_ARGS  ,
pltcl_call_state *  call_state,
bool  pltrusted 
)
static

Definition at line 1319 of file pltcl.c.

1321{
1322 pltcl_proc_desc *prodesc;
1323 Tcl_Interp *volatile interp;
1324 EventTriggerData *tdata = (EventTriggerData *) fcinfo->context;
1325 Tcl_Obj *tcl_cmd;
1326 int tcl_rc;
1327
1328 /* Connect to SPI manager */
1329 SPI_connect();
1330
1331 /* Find or compile the function */
1332 prodesc = compile_pltcl_function(fcinfo->flinfo->fn_oid,
1333 InvalidOid, true, pltrusted);
1334
1335 call_state->prodesc = prodesc;
1336 prodesc->fn_refcount++;
1337
1338 interp = prodesc->interp_desc->interp;
1339
1340 /* Create the tcl command and call the internal proc */
1341 tcl_cmd = Tcl_NewObj();
1342 Tcl_IncrRefCount(tcl_cmd);
1343 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1344 Tcl_NewStringObj(prodesc->internal_proname, -1));
1345 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1346 Tcl_NewStringObj(utf_e2u(tdata->event), -1));
1347 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1348 Tcl_NewStringObj(utf_e2u(GetCommandTagName(tdata->tag)),
1349 -1));
1350
1351 tcl_rc = Tcl_EvalObjEx(interp, tcl_cmd, (TCL_EVAL_DIRECT | TCL_EVAL_GLOBAL));
1352
1353 /* Release refcount to free tcl_cmd (and all subsidiary objects) */
1354 Tcl_DecrRefCount(tcl_cmd);
1355
1356 /* Check for errors reported by Tcl. */
1357 if (tcl_rc != TCL_OK)
1358 throw_tcl_error(interp, prodesc->user_proname);
1359
1360 if (SPI_finish() != SPI_OK_FINISH)
1361 elog(ERROR, "SPI_finish() failed");
1362}

References compile_pltcl_function(), elog, ERROR, fb(), pltcl_proc_desc::fn_refcount, GetCommandTagName(), pltcl_proc_desc::internal_proname, pltcl_interp_desc::interp, pltcl_proc_desc::interp_desc, InvalidOid, SPI_connect(), SPI_finish(), SPI_OK_FINISH, throw_tcl_error(), pltcl_proc_desc::user_proname, and utf_e2u().

Referenced by pltcl_handler().

◆ pltcl_fetch_interp()

static pltcl_interp_desc * pltcl_fetch_interp ( Oid  prolang,
bool  pltrusted 
)
static

Definition at line 568 of file pltcl.c.

569{
570 Oid user_id;
571 pltcl_interp_desc *interp_desc;
572 bool found;
573
574 /* Find or create the interpreter hashtable entry for this userid */
575 if (pltrusted)
576 user_id = GetUserId();
577 else
578 user_id = InvalidOid;
579
580 interp_desc = hash_search(pltcl_interp_htab, &user_id,
581 HASH_ENTER,
582 &found);
583 if (!found)
584 interp_desc->interp = NULL;
585
586 /* If we haven't yet successfully made an interpreter, try to do that */
587 if (!interp_desc->interp)
588 pltcl_init_interp(interp_desc, prolang, pltrusted);
589
590 return interp_desc;
591}

References fb(), GetUserId(), HASH_ENTER, hash_search(), pltcl_interp_desc::interp, InvalidOid, pltcl_init_interp(), and pltcl_interp_htab.

Referenced by compile_pltcl_function().

◆ pltcl_FinalizeNotifier()

static void pltcl_FinalizeNotifier ( ClientData  clientData)
static

Definition at line 363 of file pltcl.c.

364{
365}

Referenced by _PG_init().

◆ pltcl_func_handler()

static Datum pltcl_func_handler ( PG_FUNCTION_ARGS  ,
pltcl_call_state *  call_state,
bool  pltrusted 
)
static

Definition at line 802 of file pltcl.c.

804{
805 bool nonatomic;
806 pltcl_proc_desc *prodesc;
807 Tcl_Interp *volatile interp;
808 Tcl_Obj *tcl_cmd;
809 int i;
810 int tcl_rc;
811 Datum retval;
812
813 nonatomic = fcinfo->context &&
814 IsA(fcinfo->context, CallContext) &&
815 !castNode(CallContext, fcinfo->context)->atomic;
816
817 /* Connect to SPI manager */
818 SPI_connect_ext(nonatomic ? SPI_OPT_NONATOMIC : 0);
819
820 /* Find or compile the function */
821 prodesc = compile_pltcl_function(fcinfo->flinfo->fn_oid, InvalidOid,
822 false, pltrusted);
823
824 call_state->prodesc = prodesc;
825 prodesc->fn_refcount++;
826
827 interp = prodesc->interp_desc->interp;
828
829 /*
830 * If we're a SRF, check caller can handle materialize mode, and save
831 * relevant info into call_state. We must ensure that the returned
832 * tuplestore is owned by the caller's context, even if we first create it
833 * inside a subtransaction.
834 */
835 if (prodesc->fn_retisset)
836 {
837 ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
838
839 if (!rsi || !IsA(rsi, ReturnSetInfo))
840 ereport(ERROR,
841 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
842 errmsg("set-valued function called in context that cannot accept a set")));
843
844 if (!(rsi->allowedModes & SFRM_Materialize))
845 ereport(ERROR,
846 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
847 errmsg("materialize mode required, but it is not allowed in this context")));
848
849 call_state->rsi = rsi;
850 call_state->tuple_store_cxt = rsi->econtext->ecxt_per_query_memory;
851 call_state->tuple_store_owner = CurrentResourceOwner;
852 }
853
854 /************************************************************
855 * Create the tcl command to call the internal
856 * proc in the Tcl interpreter
857 ************************************************************/
858 tcl_cmd = Tcl_NewObj();
859 Tcl_ListObjAppendElement(NULL, tcl_cmd,
860 Tcl_NewStringObj(prodesc->internal_proname, -1));
861
862 /* We hold a refcount on tcl_cmd just to be sure it stays around */
863 Tcl_IncrRefCount(tcl_cmd);
864
865 /************************************************************
866 * Add all call arguments to the command
867 ************************************************************/
868 PG_TRY();
869 {
870 for (i = 0; i < prodesc->nargs; i++)
871 {
872 if (prodesc->arg_is_rowtype[i])
873 {
874 /**************************************************
875 * For tuple values, add a list for 'array set ...'
876 **************************************************/
877 if (fcinfo->args[i].isnull)
878 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
879 else
880 {
881 HeapTupleHeader td;
882 Oid tupType;
883 int32 tupTypmod;
884 TupleDesc tupdesc;
885 HeapTupleData tmptup;
886 Tcl_Obj *list_tmp;
887
888 td = DatumGetHeapTupleHeader(fcinfo->args[i].value);
889 /* Extract rowtype info and find a tupdesc */
890 tupType = HeapTupleHeaderGetTypeId(td);
891 tupTypmod = HeapTupleHeaderGetTypMod(td);
892 tupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod);
893 /* Build a temporary HeapTuple control structure */
894 tmptup.t_len = HeapTupleHeaderGetDatumLength(td);
895 tmptup.t_data = td;
896
897 list_tmp = pltcl_build_tuple_argument(&tmptup, tupdesc, true);
898 Tcl_ListObjAppendElement(NULL, tcl_cmd, list_tmp);
899
900 ReleaseTupleDesc(tupdesc);
901 }
902 }
903 else
904 {
905 /**************************************************
906 * Single values are added as string element
907 * of their external representation
908 **************************************************/
909 if (fcinfo->args[i].isnull)
910 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
911 else
912 {
913 char *tmp;
914
915 tmp = OutputFunctionCall(&prodesc->arg_out_func[i],
916 fcinfo->args[i].value);
917 UTF_BEGIN;
918 Tcl_ListObjAppendElement(NULL, tcl_cmd,
919 Tcl_NewStringObj(UTF_E2U(tmp), -1));
920 UTF_END;
921 pfree(tmp);
922 }
923 }
924 }
925 }
926 PG_CATCH();
927 {
928 /* Release refcount to free tcl_cmd */
929 Tcl_DecrRefCount(tcl_cmd);
930 PG_RE_THROW();
931 }
932 PG_END_TRY();
933
934 /************************************************************
935 * Call the Tcl function
936 *
937 * We assume no PG error can be thrown directly from this call.
938 ************************************************************/
939 tcl_rc = Tcl_EvalObjEx(interp, tcl_cmd, (TCL_EVAL_DIRECT | TCL_EVAL_GLOBAL));
940
941 /* Release refcount to free tcl_cmd (and all subsidiary objects) */
942 Tcl_DecrRefCount(tcl_cmd);
943
944 /************************************************************
945 * Check for errors reported by Tcl.
946 ************************************************************/
947 if (tcl_rc != TCL_OK)
948 throw_tcl_error(interp, prodesc->user_proname);
949
950 /************************************************************
951 * Disconnect from SPI manager and then create the return
952 * value datum (if the input function does a palloc for it
953 * this must not be allocated in the SPI memory context
954 * because SPI_finish would free it). But don't try to call
955 * the result_in_func if we've been told to return a NULL;
956 * the Tcl result may not be a valid value of the result type
957 * in that case.
958 ************************************************************/
959 if (SPI_finish() != SPI_OK_FINISH)
960 elog(ERROR, "SPI_finish() failed");
961
962 if (prodesc->fn_retisset)
963 {
964 ReturnSetInfo *rsi = call_state->rsi;
965
966 /* We already checked this is OK */
967 rsi->returnMode = SFRM_Materialize;
968
969 /* If we produced any tuples, send back the result */
970 if (call_state->tuple_store)
971 {
972 rsi->setResult = call_state->tuple_store;
973 if (call_state->ret_tupdesc)
974 {
975 MemoryContext oldcxt;
976
977 oldcxt = MemoryContextSwitchTo(call_state->tuple_store_cxt);
978 rsi->setDesc = CreateTupleDescCopy(call_state->ret_tupdesc);
979 MemoryContextSwitchTo(oldcxt);
980 }
981 }
982 retval = (Datum) 0;
983 fcinfo->isnull = true;
984 }
985 else if (fcinfo->isnull)
986 {
987 retval = InputFunctionCall(&prodesc->result_in_func,
988 NULL,
989 prodesc->result_typioparam,
990 -1);
991 }
992 else if (prodesc->fn_retistuple)
993 {
994 TupleDesc td;
995 HeapTuple tup;
996 Tcl_Obj *resultObj;
997 Tcl_Obj **resultObjv;
998 Tcl_Size resultObjc;
999
1000 /*
1001 * Set up data about result type. XXX it's tempting to consider
1002 * caching this in the prodesc, in the common case where the rowtype
1003 * is determined by the function not the calling query. But we'd have
1004 * to be able to deal with ADD/DROP/ALTER COLUMN events when the
1005 * result type is a named composite type, so it's not exactly trivial.
1006 * Maybe worth improving someday.
1007 */
1008 switch (get_call_result_type(fcinfo, NULL, &td))
1009 {
1010 case TYPEFUNC_COMPOSITE:
1011 /* success */
1012 break;
1013 case TYPEFUNC_COMPOSITE_DOMAIN:
1014 Assert(prodesc->fn_retisdomain);
1015 break;
1016 case TYPEFUNC_RECORD:
1017 /* failed to determine actual type of RECORD */
1018 ereport(ERROR,
1019 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1020 errmsg("function returning record called in context "
1021 "that cannot accept type record")));
1022 break;
1023 default:
1024 /* result type isn't composite? */
1025 elog(ERROR, "return type must be a row type");
1026 break;
1027 }
1028
1029 Assert(!call_state->ret_tupdesc);
1030 Assert(!call_state->attinmeta);
1031 call_state->ret_tupdesc = td;
1032 call_state->attinmeta = TupleDescGetAttInMetadata(td);
1033
1034 /* Convert function result to tuple */
1035 resultObj = Tcl_GetObjResult(interp);
1036 if (Tcl_ListObjGetElements(interp, resultObj, &resultObjc, &resultObjv) == TCL_ERROR)
1037 ereport(ERROR,
1038 (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1039 errmsg("could not parse function return value: %s",
1040 utf_u2e(Tcl_GetStringResult(interp)))));
1041
1042 tup = pltcl_build_tuple_result(interp, resultObjv, resultObjc,
1043 call_state);
1044 retval = HeapTupleGetDatum(tup);
1045 }
1046 else
1047 retval = InputFunctionCall(&prodesc->result_in_func,
1048 utf_u2e(Tcl_GetStringResult(interp)),
1049 prodesc->result_typioparam,
1050 -1);
1051
1052 return retval;
1053}

References ReturnSetInfo::allowedModes, pltcl_proc_desc::arg_is_rowtype, pltcl_proc_desc::arg_out_func, Assert, castNode, compile_pltcl_function(), CreateTupleDescCopy(), CurrentResourceOwner, DatumGetHeapTupleHeader, ReturnSetInfo::econtext, ExprContext::ecxt_per_query_memory, elog, ereport, errcode(), errmsg, ERROR, fb(), pltcl_proc_desc::fn_refcount, pltcl_proc_desc::fn_retisdomain, pltcl_proc_desc::fn_retisset, pltcl_proc_desc::fn_retistuple, get_call_result_type(), HeapTupleGetDatum(), HeapTupleHeaderGetDatumLength(), HeapTupleHeaderGetTypeId(), HeapTupleHeaderGetTypMod(), i, InputFunctionCall(), pltcl_proc_desc::internal_proname, pltcl_interp_desc::interp, pltcl_proc_desc::interp_desc, InvalidOid, IsA, lookup_rowtype_tupdesc(), MemoryContextSwitchTo(), pltcl_proc_desc::nargs, OutputFunctionCall(), pfree(), PG_CATCH, PG_END_TRY, PG_RE_THROW, PG_TRY, pltcl_build_tuple_argument(), pltcl_build_tuple_result(), ReleaseTupleDesc, pltcl_proc_desc::result_in_func, pltcl_proc_desc::result_typioparam, ReturnSetInfo::returnMode, ReturnSetInfo::setDesc, ReturnSetInfo::setResult, SFRM_Materialize, SPI_connect_ext(), SPI_finish(), SPI_OK_FINISH, SPI_OPT_NONATOMIC, throw_tcl_error(), TupleDescGetAttInMetadata(), TYPEFUNC_COMPOSITE, TYPEFUNC_COMPOSITE_DOMAIN, TYPEFUNC_RECORD, pltcl_proc_desc::user_proname, UTF_BEGIN, UTF_E2U, UTF_END, and utf_u2e().

Referenced by pltcl_handler().

◆ pltcl_get_condition_name()

static const char * pltcl_get_condition_name ( int  sqlstate)
static

Definition at line 2076 of file pltcl.c.

2077{
2078 int i;
2079
2080 for (i = 0; exception_name_map[i].label != NULL; i++)
2081 {
2082 if (exception_name_map[i].sqlerrstate == sqlstate)
2083 return exception_name_map[i].label;
2084 }
2085 return "unrecognized_sqlstate";
2086}

References exception_name_map, fb(), i, and TclExceptionNameMap::label.

Referenced by pltcl_construct_errorCode().

◆ pltcl_handler()

static Datum pltcl_handler ( PG_FUNCTION_ARGS  ,
bool  pltrusted 
)
static

Definition at line 728 of file pltcl.c.

729{
730 Datum retval = (Datum) 0;
731 pltcl_call_state current_call_state;
732 pltcl_call_state *save_call_state;
733
734 /*
735 * Initialize current_call_state to nulls/zeroes; in particular, set its
736 * prodesc pointer to null. Anything that sets it non-null should
737 * increase the prodesc's fn_refcount at the same time. We'll decrease
738 * the refcount, and then delete the prodesc if it's no longer referenced,
739 * on the way out of this function. This ensures that prodescs live as
740 * long as needed even if somebody replaces the originating pg_proc row
741 * while they're executing.
742 */
743 memset(&current_call_state, 0, sizeof(current_call_state));
744
745 /*
746 * Ensure that static pointer is saved/restored properly
747 */
748 save_call_state = pltcl_current_call_state;
749 pltcl_current_call_state = &current_call_state;
750
751 PG_TRY();
752 {
753 /*
754 * Determine if called as function or trigger and call appropriate
755 * subhandler
756 */
757 if (CALLED_AS_TRIGGER(fcinfo))
758 {
759 /* invoke the trigger handler */
760 retval = PointerGetDatum(pltcl_trigger_handler(fcinfo,
761 &current_call_state,
762 pltrusted));
763 }
764 else if (CALLED_AS_EVENT_TRIGGER(fcinfo))
765 {
766 /* invoke the event trigger handler */
767 pltcl_event_trigger_handler(fcinfo, &current_call_state, pltrusted);
768 retval = (Datum) 0;
769 }
770 else
771 {
772 /* invoke the regular function handler */
773 current_call_state.fcinfo = fcinfo;
774 retval = pltcl_func_handler(fcinfo, &current_call_state, pltrusted);
775 }
776 }
777 PG_FINALLY();
778 {
779 /* Restore static pointer, then clean up the prodesc refcount if any */
780 /*
781 * (We're being paranoid in case an error is thrown in context
782 * deletion)
783 */
784 pltcl_current_call_state = save_call_state;
785 if (current_call_state.prodesc != NULL)
786 {
787 Assert(current_call_state.prodesc->fn_refcount > 0);
788 if (--current_call_state.prodesc->fn_refcount == 0)
789 MemoryContextDelete(current_call_state.prodesc->fn_cxt);
790 }
791 }
792 PG_END_TRY();
793
794 return retval;
795}

References Assert, CALLED_AS_EVENT_TRIGGER, CALLED_AS_TRIGGER, fb(), MemoryContextDelete(), PG_END_TRY, PG_FINALLY, PG_TRY, pltcl_current_call_state, pltcl_event_trigger_handler(), pltcl_func_handler(), pltcl_trigger_handler(), and PointerGetDatum().

Referenced by pltcl_call_handler(), and pltclu_call_handler().

◆ pltcl_init_interp()

static void pltcl_init_interp ( pltcl_interp_desc *  interp_desc,
Oid  prolang,
bool  pltrusted 
)
static

Definition at line 495 of file pltcl.c.

496{
497 Tcl_Interp *interp;
498 char interpname[32];
499
500 /************************************************************
501 * Create the Tcl interpreter subsidiary to pltcl_hold_interp.
502 * Note: Tcl automatically does Tcl_Init in the untrusted case,
503 * and it's not wanted in the trusted case.
504 ************************************************************/
505 snprintf(interpname, sizeof(interpname), "subsidiary_%u", interp_desc->user_id);
506 if ((interp = Tcl_CreateSlave(pltcl_hold_interp, interpname,
507 pltrusted ? 1 : 0)) == NULL)
508 elog(ERROR, "could not create subsidiary Tcl interpreter");
509
510 /************************************************************
511 * Initialize the query hash table associated with interpreter
512 ************************************************************/
513 Tcl_InitHashTable(&interp_desc->query_hash, TCL_STRING_KEYS);
514
515 /************************************************************
516 * Install the commands for SPI support in the interpreter
517 ************************************************************/
518 Tcl_CreateObjCommand(interp, "elog",
519 pltcl_elog, NULL, NULL);
520 Tcl_CreateObjCommand(interp, "quote",
521 pltcl_quote, NULL, NULL);
522 Tcl_CreateObjCommand(interp, "argisnull",
523 pltcl_argisnull, NULL, NULL);
524 Tcl_CreateObjCommand(interp, "return_null",
525 pltcl_returnnull, NULL, NULL);
526 Tcl_CreateObjCommand(interp, "return_next",
527 pltcl_returnnext, NULL, NULL);
528 Tcl_CreateObjCommand(interp, "spi_exec",
529 pltcl_SPI_execute, NULL, NULL);
530 Tcl_CreateObjCommand(interp, "spi_prepare",
531 pltcl_SPI_prepare, NULL, NULL);
532 Tcl_CreateObjCommand(interp, "spi_execp",
533 pltcl_SPI_execute_plan, NULL, NULL);
534 Tcl_CreateObjCommand(interp, "subtransaction",
535 pltcl_subtransaction, NULL, NULL);
536 Tcl_CreateObjCommand(interp, "commit",
537 pltcl_commit, NULL, NULL);
538 Tcl_CreateObjCommand(interp, "rollback",
539 pltcl_rollback, NULL, NULL);
540
541 /************************************************************
542 * Call the appropriate start_proc, if there is one.
543 *
544 * We must set interp_desc->interp before the call, else the start_proc
545 * won't find the interpreter it's supposed to use. But, if the
546 * start_proc fails, we want to abandon use of the interpreter.
547 ************************************************************/
548 PG_TRY();
549 {
550 interp_desc->interp = interp;
551 call_pltcl_start_proc(prolang, pltrusted);
552 }
553 PG_CATCH();
554 {
555 interp_desc->interp = NULL;
556 Tcl_DeleteInterp(interp);
557 PG_RE_THROW();
558 }
559 PG_END_TRY();
560}

References call_pltcl_start_proc(), elog, ERROR, fb(), pltcl_interp_desc::interp, PG_CATCH, PG_END_TRY, PG_RE_THROW, PG_TRY, pltcl_argisnull(), pltcl_commit(), pltcl_elog(), pltcl_hold_interp, pltcl_quote(), pltcl_returnnext(), pltcl_returnnull(), pltcl_rollback(), pltcl_SPI_execute(), pltcl_SPI_execute_plan(), pltcl_SPI_prepare(), pltcl_subtransaction(), pltcl_interp_desc::query_hash, snprintf, and pltcl_interp_desc::user_id.

Referenced by pltcl_fetch_interp().

◆ pltcl_init_tuple_store()

static void pltcl_init_tuple_store ( pltcl_call_state *  call_state)
static

Definition at line 3352 of file pltcl.c.

3353{
3354 ReturnSetInfo *rsi = call_state->rsi;
3355 MemoryContext oldcxt;
3356 ResourceOwner oldowner;
3357
3358 /* Should be in a SRF */
3359 Assert(rsi);
3360 /* Should be first time through */
3361 Assert(!call_state->tuple_store);
3362 Assert(!call_state->attinmeta);
3363
3364 /* We expect caller to provide an appropriate result tupdesc */
3365 Assert(rsi->expectedDesc);
3366 call_state->ret_tupdesc = rsi->expectedDesc;
3367
3368 /*
3369 * Switch to the right memory context and resource owner for storing the
3370 * tuplestore. If we're within a subtransaction opened for an exception
3371 * block, for example, we must still create the tuplestore in the resource
3372 * owner that was active when this function was entered, and not in the
3373 * subtransaction's resource owner.
3374 */
3375 oldcxt = MemoryContextSwitchTo(call_state->tuple_store_cxt);
3376 oldowner = CurrentResourceOwner;
3377 CurrentResourceOwner = call_state->tuple_store_owner;
3378
3379 call_state->tuple_store =
3380 tuplestore_begin_heap(rsi->allowedModes & SFRM_Materialize_Random,
3381 false, work_mem);
3382
3383 /* Build attinmeta in this context, too */
3384 call_state->attinmeta = TupleDescGetAttInMetadata(call_state->ret_tupdesc);
3385
3386 CurrentResourceOwner = oldowner;
3387 MemoryContextSwitchTo(oldcxt);
3388}

References ReturnSetInfo::allowedModes, Assert, CurrentResourceOwner, ReturnSetInfo::expectedDesc, fb(), MemoryContextSwitchTo(), SFRM_Materialize_Random, TupleDescGetAttInMetadata(), tuplestore_begin_heap(), and work_mem.

Referenced by pltcl_returnnext().

◆ pltcl_InitNotifier()

static ClientData pltcl_InitNotifier ( void  )
static

Definition at line 355 of file pltcl.c.

356{
357 static int fakeThreadKey; /* To give valid address for ClientData */
358
359 return (ClientData) &(fakeThreadKey);
360}

References fb().

Referenced by _PG_init().

◆ pltcl_process_SPI_result()

static int pltcl_process_SPI_result ( Tcl_Interp *  interp,
const char *  arrayname,
Tcl_Obj *  loop_body,
int  spi_rc,
SPITupleTable *  tuptable,
uint64  ntuples 
)
static

Definition at line 2519 of file pltcl.c.

2525{
2526 int my_rc = TCL_OK;
2527 int loop_rc;
2528 HeapTuple *tuples;
2529 TupleDesc tupdesc;
2530
2531 switch (spi_rc)
2532 {
2533 case SPI_OK_SELINTO:
2534 case SPI_OK_INSERT:
2535 case SPI_OK_DELETE:
2536 case SPI_OK_UPDATE:
2537 case SPI_OK_MERGE:
2538 Tcl_SetObjResult(interp, Tcl_NewWideIntObj(ntuples));
2539 break;
2540
2541 case SPI_OK_UTILITY:
2542 case SPI_OK_REWRITTEN:
2543 if (tuptable == NULL)
2544 {
2545 Tcl_SetObjResult(interp, Tcl_NewIntObj(0));
2546 break;
2547 }
2548 /* fall through for utility returning tuples */
2549 pg_fallthrough;
2550
2551 case SPI_OK_SELECT:
2552 case SPI_OK_INSERT_RETURNING:
2553 case SPI_OK_DELETE_RETURNING:
2554 case SPI_OK_UPDATE_RETURNING:
2555 case SPI_OK_MERGE_RETURNING:
2556
2557 /*
2558 * Process the tuples we got
2559 */
2560 tuples = tuptable->vals;
2561 tupdesc = tuptable->tupdesc;
2562
2563 if (loop_body == NULL)
2564 {
2565 /*
2566 * If there is no loop body given, just set the variables from
2567 * the first tuple (if any)
2568 */
2569 if (ntuples > 0)
2570 pltcl_set_tuple_values(interp, arrayname, 0,
2571 tuples[0], tupdesc);
2572 }
2573 else
2574 {
2575 /*
2576 * There is a loop body - process all tuples and evaluate the
2577 * body on each
2578 */
2579 uint64 i;
2580
2581 for (i = 0; i < ntuples; i++)
2582 {
2583 pltcl_set_tuple_values(interp, arrayname, i,
2584 tuples[i], tupdesc);
2585
2586 loop_rc = Tcl_EvalObjEx(interp, loop_body, 0);
2587
2588 if (loop_rc == TCL_OK)
2589 continue;
2590 if (loop_rc == TCL_CONTINUE)
2591 continue;
2592 if (loop_rc == TCL_RETURN)
2593 {
2594 my_rc = TCL_RETURN;
2595 break;
2596 }
2597 if (loop_rc == TCL_BREAK)
2598 break;
2599 my_rc = TCL_ERROR;
2600 break;
2601 }
2602 }
2603
2604 if (my_rc == TCL_OK)
2605 {
2606 Tcl_SetObjResult(interp, Tcl_NewWideIntObj(ntuples));
2607 }
2608 break;
2609
2610 default:
2611 Tcl_AppendResult(interp, "pltcl: SPI_execute failed: ",
2612 SPI_result_code_string(spi_rc), NULL);
2613 my_rc = TCL_ERROR;
2614 break;
2615 }
2616
2617 SPI_freetuptable(tuptable);
2618
2619 return my_rc;
2620}

References fb(), i, pg_fallthrough, pltcl_set_tuple_values(), SPI_freetuptable(), SPI_OK_DELETE, SPI_OK_DELETE_RETURNING, SPI_OK_INSERT, SPI_OK_INSERT_RETURNING, SPI_OK_MERGE, SPI_OK_MERGE_RETURNING, SPI_OK_REWRITTEN, SPI_OK_SELECT, SPI_OK_SELINTO, SPI_OK_UPDATE, SPI_OK_UPDATE_RETURNING, SPI_OK_UTILITY, SPI_result_code_string(), SPITupleTable::tupdesc, and SPITupleTable::vals.

Referenced by pltcl_SPI_execute(), and pltcl_SPI_execute_plan().

◆ pltcl_quote()

static int pltcl_quote ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 2094 of file pltcl.c.

2096{
2097 char *tmp;
2098 const char *cp1;
2099 char *cp2;
2100 Tcl_Size length;
2101
2102 /************************************************************
2103 * Check call syntax
2104 ************************************************************/
2105 if (objc != 2)
2106 {
2107 Tcl_WrongNumArgs(interp, 1, objv, "string");
2108 return TCL_ERROR;
2109 }
2110
2111 /************************************************************
2112 * Allocate space for the maximum the string can
2113 * grow to and initialize pointers
2114 ************************************************************/
2115 cp1 = Tcl_GetStringFromObj(objv[1], &length);
2116 tmp = palloc(length * 2 + 1);
2117 cp2 = tmp;
2118
2119 /************************************************************
2120 * Walk through string and double every quote and backslash
2121 ************************************************************/
2122 while (*cp1)
2123 {
2124 if (*cp1 == '\'')
2125 *cp2++ = '\'';
2126 else
2127 {
2128 if (*cp1 == '\\')
2129 *cp2++ = '\\';
2130 }
2131 *cp2++ = *cp1++;
2132 }
2133
2134 /************************************************************
2135 * Terminate the string and set it as result
2136 ************************************************************/
2137 *cp2 = '\0';
2138 Tcl_SetObjResult(interp, Tcl_NewStringObj(tmp, -1));
2139 pfree(tmp);
2140 return TCL_OK;
2141}

References fb(), palloc(), and pfree().

Referenced by pltcl_init_interp().

◆ pltcl_returnnext()

static int pltcl_returnnext ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 2240 of file pltcl.c.

2242{
2243 pltcl_call_state *call_state = pltcl_current_call_state;
2244 FunctionCallInfo fcinfo = call_state->fcinfo;
2245 pltcl_proc_desc *prodesc = call_state->prodesc;
2246 MemoryContext oldcontext = CurrentMemoryContext;
2247 ResourceOwner oldowner = CurrentResourceOwner;
2248 volatile int result = TCL_OK;
2249
2250 /*
2251 * Check that we're called as a set-returning function
2252 */
2253 if (fcinfo == NULL)
2254 {
2255 Tcl_SetObjResult(interp,
2256 Tcl_NewStringObj("return_next cannot be used in triggers", -1));
2257 return TCL_ERROR;
2258 }
2259
2260 if (!prodesc->fn_retisset)
2261 {
2262 Tcl_SetObjResult(interp,
2263 Tcl_NewStringObj("return_next cannot be used in non-set-returning functions", -1));
2264 return TCL_ERROR;
2265 }
2266
2267 /*
2268 * Check call syntax
2269 */
2270 if (objc != 2)
2271 {
2272 Tcl_WrongNumArgs(interp, 1, objv, "result");
2273 return TCL_ERROR;
2274 }
2275
2276 /*
2277 * The rest might throw elog(ERROR), so must run in a subtransaction.
2278 *
2279 * A small advantage of using a subtransaction is that it provides a
2280 * short-lived memory context for free, so we needn't worry about leaking
2281 * memory here. To use that context, call BeginInternalSubTransaction
2282 * directly instead of going through pltcl_subtrans_begin.
2283 */
2284 BeginInternalSubTransaction(NULL);
2285 PG_TRY();
2286 {
2287 /* Set up tuple store if first output row */
2288 if (call_state->tuple_store == NULL)
2289 pltcl_init_tuple_store(call_state);
2290
2291 if (prodesc->fn_retistuple)
2292 {
2293 Tcl_Obj **rowObjv;
2294 Tcl_Size rowObjc;
2295
2296 /* result should be a list, so break it down */
2297 if (Tcl_ListObjGetElements(interp, objv[1], &rowObjc, &rowObjv) == TCL_ERROR)
2298 result = TCL_ERROR;
2299 else
2300 {
2301 HeapTuple tuple;
2302
2303 tuple = pltcl_build_tuple_result(interp, rowObjv, rowObjc,
2304 call_state);
2305 tuplestore_puttuple(call_state->tuple_store, tuple);
2306 }
2307 }
2308 else
2309 {
2310 Datum retval;
2311 bool isNull = false;
2312
2313 /* for paranoia's sake, check that tupdesc has exactly one column */
2314 if (call_state->ret_tupdesc->natts != 1)
2315 elog(ERROR, "wrong result type supplied in return_next");
2316
2317 retval = InputFunctionCall(&prodesc->result_in_func,
2318 utf_u2e((char *) Tcl_GetString(objv[1])),
2319 prodesc->result_typioparam,
2320 -1);
2321 tuplestore_putvalues(call_state->tuple_store, call_state->ret_tupdesc,
2322 &retval, &isNull);
2323 }
2324
2325 pltcl_subtrans_commit(oldcontext, oldowner);
2326 }
2327 PG_CATCH();
2328 {
2329 pltcl_subtrans_abort(interp, oldcontext, oldowner);
2330 return TCL_ERROR;
2331 }
2332 PG_END_TRY();
2333
2334 return result;
2335}

References BeginInternalSubTransaction(), CurrentMemoryContext, CurrentResourceOwner, elog, ERROR, fb(), pltcl_proc_desc::fn_retisset, pltcl_proc_desc::fn_retistuple, InputFunctionCall(), PG_CATCH, PG_END_TRY, PG_TRY, pltcl_build_tuple_result(), pltcl_current_call_state, pltcl_init_tuple_store(), pltcl_subtrans_abort(), pltcl_subtrans_commit(), pltcl_proc_desc::result_in_func, pltcl_proc_desc::result_typioparam, tuplestore_puttuple(), tuplestore_putvalues(), and utf_u2e().

Referenced by pltcl_init_interp().

◆ pltcl_returnnull()

static int pltcl_returnnull ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 2202 of file pltcl.c.

2204{
2205 FunctionCallInfo fcinfo = pltcl_current_call_state->fcinfo;
2206
2207 /************************************************************
2208 * Check call syntax
2209 ************************************************************/
2210 if (objc != 1)
2211 {
2212 Tcl_WrongNumArgs(interp, 1, objv, "");
2213 return TCL_ERROR;
2214 }
2215
2216 /************************************************************
2217 * Check that we're called as a normal function
2218 ************************************************************/
2219 if (fcinfo == NULL)
2220 {
2221 Tcl_SetObjResult(interp,
2222 Tcl_NewStringObj("return_null cannot be used in triggers", -1));
2223 return TCL_ERROR;
2224 }
2225
2226 /************************************************************
2227 * Set the NULL return flag and cause Tcl to return from the
2228 * procedure.
2229 ************************************************************/
2230 fcinfo->isnull = true;
2231
2232 return TCL_RETURN;
2233}

References fb(), pltcl_call_state::fcinfo, FunctionCallInfoBaseData::isnull, and pltcl_current_call_state.

Referenced by pltcl_init_interp().

◆ pltcl_rollback()

static int pltcl_rollback ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 3063 of file pltcl.c.

3065{
3066 MemoryContext oldcontext = CurrentMemoryContext;
3067
3068 PG_TRY();
3069 {
3070 SPI_rollback();
3071 }
3072 PG_CATCH();
3073 {
3074 ErrorData *edata;
3075
3076 /* Save error info */
3077 MemoryContextSwitchTo(oldcontext);
3078 edata = CopyErrorData();
3079 FlushErrorState();
3080
3081 /* Pass the error data to Tcl */
3082 pltcl_construct_errorCode(interp, edata);
3083 UTF_BEGIN;
3084 Tcl_SetObjResult(interp, Tcl_NewStringObj(UTF_E2U(edata->message), -1));
3085 UTF_END;
3086 FreeErrorData(edata);
3087
3088 return TCL_ERROR;
3089 }
3090 PG_END_TRY();
3091
3092 return TCL_OK;
3093}

References CopyErrorData(), CurrentMemoryContext, fb(), FlushErrorState(), FreeErrorData(), MemoryContextSwitchTo(), PG_CATCH, PG_END_TRY, PG_TRY, pltcl_construct_errorCode(), SPI_rollback(), UTF_BEGIN, UTF_E2U, and UTF_END.

Referenced by pltcl_init_interp().

◆ pltcl_ServiceModeHook()

static void pltcl_ServiceModeHook ( int  mode)
static

Definition at line 389 of file pltcl.c.

390{
391}

Referenced by _PG_init().

◆ pltcl_set_tuple_values()

static void pltcl_set_tuple_values ( Tcl_Interp *  interp,
const char *  arrayname,
uint64  tupno,
HeapTuple  tuple,
TupleDesc  tupdesc 
)
static

Definition at line 3103 of file pltcl.c.

3105{
3106 int i;
3107 char *outputstr;
3108 Datum attr;
3109 bool isnull;
3110 const char *attname;
3111 Oid typoutput;
3112 bool typisvarlena;
3113 const char **arrptr;
3114 const char **nameptr;
3115 const char *nullname = NULL;
3116
3117 /************************************************************
3118 * Prepare pointers for Tcl_SetVar2Ex() below
3119 ************************************************************/
3120 if (arrayname == NULL)
3121 {
3122 arrptr = &attname;
3123 nameptr = &nullname;
3124 }
3125 else
3126 {
3127 arrptr = &arrayname;
3128 nameptr = &attname;
3129
3130 /*
3131 * When outputting to an array, fill the ".tupno" element with the
3132 * current tuple number. This will be overridden below if ".tupno" is
3133 * in use as an actual field name in the rowtype.
3134 */
3135 Tcl_SetVar2Ex(interp, arrayname, ".tupno", Tcl_NewWideIntObj(tupno), 0);
3136 }
3137
3138 for (i = 0; i < tupdesc->natts; i++)
3139 {
3140 Form_pg_attribute att = TupleDescAttr(tupdesc, i);
3141
3142 /* ignore dropped attributes */
3143 if (att->attisdropped)
3144 continue;
3145
3146 /************************************************************
3147 * Get the attribute name
3148 ************************************************************/
3149 UTF_BEGIN;
3150 attname = pstrdup(UTF_E2U(NameStr(att->attname)));
3151 UTF_END;
3152
3153 /************************************************************
3154 * Get the attributes value
3155 ************************************************************/
3156 attr = heap_getattr(tuple, i + 1, tupdesc, &isnull);
3157
3158 /************************************************************
3159 * If there is a value, set the variable
3160 * If not, unset it
3161 *
3162 * Hmmm - Null attributes will cause functions to
3163 * crash if they don't expect them - need something
3164 * smarter here.
3165 ************************************************************/
3166 if (!isnull)
3167 {
3168 getTypeOutputInfo(att->atttypid, &typoutput, &typisvarlena);
3169 outputstr = OidOutputFunctionCall(typoutput, attr);
3170 UTF_BEGIN;
3171 Tcl_SetVar2Ex(interp, *arrptr, *nameptr,
3172 Tcl_NewStringObj(UTF_E2U(outputstr), -1), 0);
3173 UTF_END;
3174 pfree(outputstr);
3175 }
3176 else
3177 Tcl_UnsetVar2(interp, *arrptr, *nameptr, 0);
3178
3179 pfree(unconstify(char *, attname));
3180 }
3181}

References attname, fb(), getTypeOutputInfo(), heap_getattr(), i, NameStr, TupleDescData::natts, OidOutputFunctionCall(), pfree(), pstrdup(), TupleDescAttr(), unconstify, UTF_BEGIN, UTF_E2U, and UTF_END.

Referenced by pltcl_process_SPI_result().

◆ pltcl_SetTimer()

static void pltcl_SetTimer ( CONST86 Tcl_Time *  timePtr)
static

Definition at line 368 of file pltcl.c.

369{
370}

Referenced by _PG_init().

◆ pltcl_SPI_execute()

static int pltcl_SPI_execute ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 2410 of file pltcl.c.

2412{
2413 int my_rc;
2414 int spi_rc;
2415 int query_idx;
2416 int i;
2417 int optIndex;
2418 int count = 0;
2419 const char *volatile arrayname = NULL;
2420 Tcl_Obj *volatile loop_body = NULL;
2421 MemoryContext oldcontext = CurrentMemoryContext;
2422 ResourceOwner oldowner = CurrentResourceOwner;
2423
2424 enum options
2425 {
2426 OPT_ARRAY, OPT_COUNT
2427 };
2428
2429 static const char *options[] = {
2430 "-array", "-count", (const char *) NULL
2431 };
2432
2433 /************************************************************
2434 * Check the call syntax and get the options
2435 ************************************************************/
2436 if (objc < 2)
2437 {
2438 Tcl_WrongNumArgs(interp, 1, objv,
2439 "?-count n? ?-array name? query ?loop body?");
2440 return TCL_ERROR;
2441 }
2442
2443 i = 1;
2444 while (i < objc)
2445 {
2446 if (Tcl_GetIndexFromObj(NULL, objv[i], options, NULL,
2447 TCL_EXACT, &optIndex) != TCL_OK)
2448 break;
2449
2450 if (++i >= objc)
2451 {
2452 Tcl_SetObjResult(interp,
2453 Tcl_NewStringObj("missing argument to -count or -array", -1));
2454 return TCL_ERROR;
2455 }
2456
2457 switch ((enum options) optIndex)
2458 {
2459 case OPT_ARRAY:
2460 arrayname = Tcl_GetString(objv[i++]);
2461 break;
2462
2463 case OPT_COUNT:
2464 if (Tcl_GetIntFromObj(interp, objv[i++], &count) != TCL_OK)
2465 return TCL_ERROR;
2466 break;
2467 }
2468 }
2469
2470 query_idx = i;
2471 if (query_idx >= objc || query_idx + 2 < objc)
2472 {
2473 Tcl_WrongNumArgs(interp, query_idx - 1, objv, "query ?loop body?");
2474 return TCL_ERROR;
2475 }
2476
2477 if (query_idx + 1 < objc)
2478 loop_body = objv[query_idx + 1];
2479
2480 /************************************************************
2481 * Execute the query inside a sub-transaction, so we can cope with
2482 * errors sanely
2483 ************************************************************/
2484
2485 pltcl_subtrans_begin(oldcontext, oldowner);
2486
2487 PG_TRY();
2488 {
2489 UTF_BEGIN;
2490 spi_rc = SPI_execute(UTF_U2E(Tcl_GetString(objv[query_idx])),
2491 pltcl_current_call_state->prodesc->fn_readonly, count);
2492 UTF_END;
2493
2494 my_rc = pltcl_process_SPI_result(interp,
2495 arrayname,
2496 loop_body,
2497 spi_rc,
2498 SPI_tuptable,
2499 SPI_processed);
2500
2501 pltcl_subtrans_commit(oldcontext, oldowner);
2502 }
2503 PG_CATCH();
2504 {
2505 pltcl_subtrans_abort(interp, oldcontext, oldowner);
2506 return TCL_ERROR;
2507 }
2508 PG_END_TRY();
2509
2510 return my_rc;
2511}

References CurrentMemoryContext, CurrentResourceOwner, fb(), pltcl_proc_desc::fn_readonly, i, PG_CATCH, PG_END_TRY, PG_TRY, pltcl_current_call_state, pltcl_process_SPI_result(), pltcl_subtrans_abort(), pltcl_subtrans_begin(), pltcl_subtrans_commit(), pltcl_call_state::prodesc, SPI_execute(), SPI_processed, SPI_tuptable, UTF_BEGIN, UTF_END, and UTF_U2E.

Referenced by pltcl_init_interp().

◆ pltcl_SPI_execute_plan()

static int pltcl_SPI_execute_plan ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 2760 of file pltcl.c.

2762{
2763 int my_rc;
2764 int spi_rc;
2765 int i;
2766 int j;
2767 int optIndex;
2768 Tcl_HashEntry *hashent;
2769 pltcl_query_desc *qdesc;
2770 const char *nulls = NULL;
2771 const char *arrayname = NULL;
2772 Tcl_Obj *loop_body = NULL;
2773 int count = 0;
2774 Tcl_Size callObjc;
2775 Tcl_Obj **callObjv = NULL;
2776 Datum *argvalues;
2777 MemoryContext oldcontext = CurrentMemoryContext;
2778 ResourceOwner oldowner = CurrentResourceOwner;
2779 Tcl_HashTable *query_hash;
2780
2781 enum options
2782 {
2783 OPT_ARRAY, OPT_COUNT, OPT_NULLS
2784 };
2785
2786 static const char *options[] = {
2787 "-array", "-count", "-nulls", (const char *) NULL
2788 };
2789
2790 /************************************************************
2791 * Get the options and check syntax
2792 ************************************************************/
2793 i = 1;
2794 while (i < objc)
2795 {
2796 if (Tcl_GetIndexFromObj(NULL, objv[i], options, NULL,
2797 TCL_EXACT, &optIndex) != TCL_OK)
2798 break;
2799
2800 if (++i >= objc)
2801 {
2802 Tcl_SetObjResult(interp,
2803 Tcl_NewStringObj("missing argument to -array, -count or -nulls", -1));
2804 return TCL_ERROR;
2805 }
2806
2807 switch ((enum options) optIndex)
2808 {
2809 case OPT_ARRAY:
2810 arrayname = Tcl_GetString(objv[i++]);
2811 break;
2812
2813 case OPT_COUNT:
2814 if (Tcl_GetIntFromObj(interp, objv[i++], &count) != TCL_OK)
2815 return TCL_ERROR;
2816 break;
2817
2818 case OPT_NULLS:
2819 nulls = Tcl_GetString(objv[i++]);
2820 break;
2821 }
2822 }
2823
2824 /************************************************************
2825 * Get the prepared plan descriptor by its key
2826 ************************************************************/
2827 if (i >= objc)
2828 {
2829 Tcl_SetObjResult(interp,
2830 Tcl_NewStringObj("missing argument to -count or -array", -1));
2831 return TCL_ERROR;
2832 }
2833
2834 query_hash = &pltcl_current_call_state->prodesc->interp_desc->query_hash;
2835
2836 hashent = Tcl_FindHashEntry(query_hash, Tcl_GetString(objv[i]));
2837 if (hashent == NULL)
2838 {
2839 Tcl_AppendResult(interp, "invalid queryid '", Tcl_GetString(objv[i]), "'", NULL);
2840 return TCL_ERROR;
2841 }
2842 qdesc = (pltcl_query_desc *) Tcl_GetHashValue(hashent);
2843 i++;
2844
2845 /************************************************************
2846 * If a nulls string is given, check for correct length
2847 ************************************************************/
2848 if (nulls != NULL)
2849 {
2850 if (strlen(nulls) != qdesc->nargs)
2851 {
2852 Tcl_SetObjResult(interp,
2853 Tcl_NewStringObj("length of nulls string doesn't match number of arguments",
2854 -1));
2855 return TCL_ERROR;
2856 }
2857 }
2858
2859 /************************************************************
2860 * If there was an argtype list on preparation, we need
2861 * an argument value list now
2862 ************************************************************/
2863 if (qdesc->nargs > 0)
2864 {
2865 if (i >= objc)
2866 {
2867 Tcl_SetObjResult(interp,
2868 Tcl_NewStringObj("argument list length doesn't match number of arguments for query",
2869 -1));
2870 return TCL_ERROR;
2871 }
2872
2873 /************************************************************
2874 * Split the argument values
2875 ************************************************************/
2876 if (Tcl_ListObjGetElements(interp, objv[i++], &callObjc, &callObjv) != TCL_OK)
2877 return TCL_ERROR;
2878
2879 /************************************************************
2880 * Check that the number of arguments matches
2881 ************************************************************/
2882 if (callObjc != qdesc->nargs)
2883 {
2884 Tcl_SetObjResult(interp,
2885 Tcl_NewStringObj("argument list length doesn't match number of arguments for query",
2886 -1));
2887 return TCL_ERROR;
2888 }
2889 }
2890 else
2891 callObjc = 0;
2892
2893 /************************************************************
2894 * Get loop body if present
2895 ************************************************************/
2896 if (i < objc)
2897 loop_body = objv[i++];
2898
2899 if (i != objc)
2900 {
2901 Tcl_WrongNumArgs(interp, 1, objv,
2902 "?-count n? ?-array name? ?-nulls string? "
2903 "query ?args? ?loop body?");
2904 return TCL_ERROR;
2905 }
2906
2907 /************************************************************
2908 * Execute the plan inside a sub-transaction, so we can cope with
2909 * errors sanely
2910 ************************************************************/
2911
2912 pltcl_subtrans_begin(oldcontext, oldowner);
2913
2914 PG_TRY();
2915 {
2916 /************************************************************
2917 * Setup the value array for SPI_execute_plan() using
2918 * the type specific input functions
2919 ************************************************************/
2920 argvalues = (Datum *) palloc(callObjc * sizeof(Datum));
2921
2922 for (j = 0; j < callObjc; j++)
2923 {
2924 if (nulls && nulls[j] == 'n')
2925 {
2926 argvalues[j] = InputFunctionCall(&qdesc->arginfuncs[j],
2927 NULL,
2928 qdesc->argtypioparams[j],
2929 -1);
2930 }
2931 else
2932 {
2933 UTF_BEGIN;
2934 argvalues[j] = InputFunctionCall(&qdesc->arginfuncs[j],
2935 UTF_U2E(Tcl_GetString(callObjv[j])),
2936 qdesc->argtypioparams[j],
2937 -1);
2938 UTF_END;
2939 }
2940 }
2941
2942 /************************************************************
2943 * Execute the plan
2944 ************************************************************/
2945 spi_rc = SPI_execute_plan(qdesc->plan, argvalues, nulls,
2946 pltcl_current_call_state->prodesc->fn_readonly,
2947 count);
2948
2949 my_rc = pltcl_process_SPI_result(interp,
2950 arrayname,
2951 loop_body,
2952 spi_rc,
2953 SPI_tuptable,
2954 SPI_processed);
2955
2956 pltcl_subtrans_commit(oldcontext, oldowner);
2957 }
2958 PG_CATCH();
2959 {
2960 pltcl_subtrans_abort(interp, oldcontext, oldowner);
2961 return TCL_ERROR;
2962 }
2963 PG_END_TRY();
2964
2965 return my_rc;
2966}

References CurrentMemoryContext, CurrentResourceOwner, fb(), pltcl_proc_desc::fn_readonly, i, InputFunctionCall(), pltcl_proc_desc::interp_desc, j, palloc(), PG_CATCH, PG_END_TRY, PG_TRY, pltcl_current_call_state, pltcl_process_SPI_result(), pltcl_subtrans_abort(), pltcl_subtrans_begin(), pltcl_subtrans_commit(), pltcl_call_state::prodesc, pltcl_interp_desc::query_hash, SPI_execute_plan(), SPI_processed, SPI_tuptable, UTF_BEGIN, UTF_END, and UTF_U2E.

Referenced by pltcl_init_interp().

◆ pltcl_SPI_prepare()

static int pltcl_SPI_prepare ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 2632 of file pltcl.c.

2634{
2635 volatile MemoryContext plan_cxt = NULL;
2636 Tcl_Size nargs;
2637 Tcl_Obj **argsObj;
2638 pltcl_query_desc *qdesc;
2639 int i;
2640 Tcl_HashEntry *hashent;
2641 int hashnew;
2642 Tcl_HashTable *query_hash;
2643 MemoryContext oldcontext = CurrentMemoryContext;
2644 ResourceOwner oldowner = CurrentResourceOwner;
2645
2646 /************************************************************
2647 * Check the call syntax
2648 ************************************************************/
2649 if (objc != 3)
2650 {
2651 Tcl_WrongNumArgs(interp, 1, objv, "query argtypes");
2652 return TCL_ERROR;
2653 }
2654
2655 /************************************************************
2656 * Split the argument type list
2657 ************************************************************/
2658 if (Tcl_ListObjGetElements(interp, objv[2], &nargs, &argsObj) != TCL_OK)
2659 return TCL_ERROR;
2660
2661 /************************************************************
2662 * Allocate the new querydesc structure
2663 *
2664 * struct qdesc and subsidiary data all live in plan_cxt. Note that if the
2665 * function is recompiled for whatever reason, permanent memory leaks
2666 * occur. FIXME someday.
2667 ************************************************************/
2668 plan_cxt = AllocSetContextCreate(TopMemoryContext,
2669 "PL/Tcl spi_prepare query",
2670 ALLOCSET_SMALL_SIZES);
2671 MemoryContextSwitchTo(plan_cxt);
2672 qdesc = palloc0_object(pltcl_query_desc);
2673 snprintf(qdesc->qname, sizeof(qdesc->qname), "%p", qdesc);
2674 qdesc->nargs = nargs;
2675 qdesc->argtypes = (Oid *) palloc(nargs * sizeof(Oid));
2676 qdesc->arginfuncs = (FmgrInfo *) palloc(nargs * sizeof(FmgrInfo));
2677 qdesc->argtypioparams = (Oid *) palloc(nargs * sizeof(Oid));
2678 MemoryContextSwitchTo(oldcontext);
2679
2680 /************************************************************
2681 * Execute the prepare inside a sub-transaction, so we can cope with
2682 * errors sanely
2683 ************************************************************/
2684
2685 pltcl_subtrans_begin(oldcontext, oldowner);
2686
2687 PG_TRY();
2688 {
2689 /************************************************************
2690 * Resolve argument type names and then look them up by oid
2691 * in the system cache, and remember the required information
2692 * for input conversion.
2693 ************************************************************/
2694 for (i = 0; i < nargs; i++)
2695 {
2696 Oid typId,
2697 typInput,
2698 typIOParam;
2699 int32 typmod;
2700
2701 (void) parseTypeString(Tcl_GetString(argsObj[i]),
2702 &typId, &typmod, NULL);
2703
2704 getTypeInputInfo(typId, &typInput, &typIOParam);
2705
2706 qdesc->argtypes[i] = typId;
2707 fmgr_info_cxt(typInput, &(qdesc->arginfuncs[i]), plan_cxt);
2708 qdesc->argtypioparams[i] = typIOParam;
2709 }
2710
2711 /************************************************************
2712 * Prepare the plan and check for errors
2713 ************************************************************/
2714 UTF_BEGIN;
2715 qdesc->plan = SPI_prepare(UTF_U2E(Tcl_GetString(objv[1])),
2716 nargs, qdesc->argtypes);
2717 UTF_END;
2718
2719 if (qdesc->plan == NULL)
2720 elog(ERROR, "SPI_prepare() failed");
2721
2722 /************************************************************
2723 * Save the plan into permanent memory (right now it's in the
2724 * SPI procCxt, which will go away at function end).
2725 ************************************************************/
2726 if (SPI_keepplan(qdesc->plan))
2727 elog(ERROR, "SPI_keepplan() failed");
2728
2729 pltcl_subtrans_commit(oldcontext, oldowner);
2730 }
2731 PG_CATCH();
2732 {
2733 pltcl_subtrans_abort(interp, oldcontext, oldowner);
2734
2735 MemoryContextDelete(plan_cxt);
2736
2737 return TCL_ERROR;
2738 }
2739 PG_END_TRY();
2740
2741 /************************************************************
2742 * Insert a hashtable entry for the plan and return
2743 * the key to the caller
2744 ************************************************************/
2745 query_hash = &pltcl_current_call_state->prodesc->interp_desc->query_hash;
2746
2747 hashent = Tcl_CreateHashEntry(query_hash, qdesc->qname, &hashnew);
2748 Tcl_SetHashValue(hashent, (ClientData) qdesc);
2749
2750 /* qname is ASCII, so no need for encoding conversion */
2751 Tcl_SetObjResult(interp, Tcl_NewStringObj(qdesc->qname, -1));
2752 return TCL_OK;
2753}

References ALLOCSET_SMALL_SIZES, AllocSetContextCreate, CurrentMemoryContext, CurrentResourceOwner, elog, ERROR, fb(), fmgr_info_cxt(), getTypeInputInfo(), i, pltcl_proc_desc::interp_desc, MemoryContextDelete(), MemoryContextSwitchTo(), palloc(), palloc0_object, parseTypeString(), PG_CATCH, PG_END_TRY, PG_TRY, pltcl_current_call_state, pltcl_subtrans_abort(), pltcl_subtrans_begin(), pltcl_subtrans_commit(), pltcl_call_state::prodesc, pltcl_interp_desc::query_hash, snprintf, SPI_keepplan(), SPI_prepare(), TopMemoryContext, UTF_BEGIN, UTF_END, and UTF_U2E.

Referenced by pltcl_init_interp().

◆ pltcl_subtrans_abort()

static void pltcl_subtrans_abort ( Tcl_Interp *  interp,
MemoryContext  oldcontext,
ResourceOwner  oldowner 
)
static

Definition at line 2381 of file pltcl.c.

2383{
2384 ErrorData *edata;
2385
2386 /* Save error info */
2387 MemoryContextSwitchTo(oldcontext);
2388 edata = CopyErrorData();
2389 FlushErrorState();
2390
2391 /* Abort the inner transaction */
2392 RollbackAndReleaseCurrentSubTransaction();
2393 MemoryContextSwitchTo(oldcontext);
2394 CurrentResourceOwner = oldowner;
2395
2396 /* Pass the error data to Tcl */
2397 pltcl_construct_errorCode(interp, edata);
2398 UTF_BEGIN;
2399 Tcl_SetObjResult(interp, Tcl_NewStringObj(UTF_E2U(edata->message), -1));
2400 UTF_END;
2401 FreeErrorData(edata);
2402}

References CopyErrorData(), CurrentResourceOwner, fb(), FlushErrorState(), FreeErrorData(), MemoryContextSwitchTo(), pltcl_construct_errorCode(), RollbackAndReleaseCurrentSubTransaction(), UTF_BEGIN, UTF_E2U, and UTF_END.

Referenced by pltcl_returnnext(), pltcl_SPI_execute(), pltcl_SPI_execute_plan(), and pltcl_SPI_prepare().

◆ pltcl_subtrans_begin()

static void pltcl_subtrans_begin ( MemoryContext  oldcontext,
ResourceOwner  oldowner 
)
static

Definition at line 2363 of file pltcl.c.

2364{
2365 BeginInternalSubTransaction(NULL);
2366
2367 /* Want to run inside function's memory context */
2368 MemoryContextSwitchTo(oldcontext);
2369}

References BeginInternalSubTransaction(), fb(), and MemoryContextSwitchTo().

Referenced by pltcl_SPI_execute(), pltcl_SPI_execute_plan(), and pltcl_SPI_prepare().

◆ pltcl_subtrans_commit()

static void pltcl_subtrans_commit ( MemoryContext  oldcontext,
ResourceOwner  oldowner 
)
static

Definition at line 2372 of file pltcl.c.

2373{
2374 /* Commit the inner transaction, return to outer xact context */
2375 ReleaseCurrentSubTransaction();
2376 MemoryContextSwitchTo(oldcontext);
2377 CurrentResourceOwner = oldowner;
2378}

References CurrentResourceOwner, MemoryContextSwitchTo(), and ReleaseCurrentSubTransaction().

Referenced by pltcl_returnnext(), pltcl_SPI_execute(), pltcl_SPI_execute_plan(), and pltcl_SPI_prepare().

◆ pltcl_subtransaction()

static int pltcl_subtransaction ( ClientData  cdata,
Tcl_Interp *  interp,
int  objc,
Tcl_Obj *const  objv[] 
)
static

Definition at line 2976 of file pltcl.c.

2978{
2979 MemoryContext oldcontext = CurrentMemoryContext;
2980 ResourceOwner oldowner = CurrentResourceOwner;
2981 int retcode;
2982
2983 if (objc != 2)
2984 {
2985 Tcl_WrongNumArgs(interp, 1, objv, "command");
2986 return TCL_ERROR;
2987 }
2988
2989 /*
2990 * Note: we don't use pltcl_subtrans_begin and friends here because we
2991 * don't want the error handling in pltcl_subtrans_abort. But otherwise
2992 * the processing should be about the same as in those functions.
2993 */
2994 BeginInternalSubTransaction(NULL);
2995 MemoryContextSwitchTo(oldcontext);
2996
2997 retcode = Tcl_EvalObjEx(interp, objv[1], 0);
2998
2999 if (retcode == TCL_ERROR)
3000 {
3001 /* Rollback the subtransaction */
3002 RollbackAndReleaseCurrentSubTransaction();
3003 }
3004 else
3005 {
3006 /* Commit the subtransaction */
3007 ReleaseCurrentSubTransaction();
3008 }
3009
3010 /* In either case, restore previous memory context and resource owner */
3011 MemoryContextSwitchTo(oldcontext);
3012 CurrentResourceOwner = oldowner;
3013
3014 return retcode;
3015}

References BeginInternalSubTransaction(), CurrentMemoryContext, CurrentResourceOwner, fb(), MemoryContextSwitchTo(), ReleaseCurrentSubTransaction(), and RollbackAndReleaseCurrentSubTransaction().

Referenced by pltcl_init_interp().

◆ pltcl_trigger_handler()

static HeapTuple pltcl_trigger_handler ( PG_FUNCTION_ARGS  ,
pltcl_call_state *  call_state,
bool  pltrusted 
)
static

Definition at line 1060 of file pltcl.c.

1062{
1063 pltcl_proc_desc *prodesc;
1064 Tcl_Interp *volatile interp;
1065 TriggerData *trigdata = (TriggerData *) fcinfo->context;
1066 char *stroid;
1067 TupleDesc tupdesc;
1068 volatile HeapTuple rettup;
1069 Tcl_Obj *tcl_cmd;
1070 Tcl_Obj *tcl_trigtup;
1071 int tcl_rc;
1072 int i;
1073 const char *result;
1074 Tcl_Size result_Objc;
1075 Tcl_Obj **result_Objv;
1076 int rc PG_USED_FOR_ASSERTS_ONLY;
1077
1078 call_state->trigdata = trigdata;
1079
1080 /* Connect to SPI manager */
1081 SPI_connect();
1082
1083 /* Make transition tables visible to this SPI connection */
1084 rc = SPI_register_trigger_data(trigdata);
1085 Assert(rc >= 0);
1086
1087 /* Find or compile the function */
1088 prodesc = compile_pltcl_function(fcinfo->flinfo->fn_oid,
1089 RelationGetRelid(trigdata->tg_relation),
1090 false, /* not an event trigger */
1091 pltrusted);
1092
1093 call_state->prodesc = prodesc;
1094 prodesc->fn_refcount++;
1095
1096 interp = prodesc->interp_desc->interp;
1097
1098 tupdesc = RelationGetDescr(trigdata->tg_relation);
1099
1100 /************************************************************
1101 * Create the tcl command to call the internal
1102 * proc in the interpreter
1103 ************************************************************/
1104 tcl_cmd = Tcl_NewObj();
1105 Tcl_IncrRefCount(tcl_cmd);
1106
1107 PG_TRY();
1108 {
1109 /* The procedure name (note this is all ASCII, so no utf_e2u) */
1110 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1111 Tcl_NewStringObj(prodesc->internal_proname, -1));
1112
1113 /* The trigger name for argument TG_name */
1114 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1115 Tcl_NewStringObj(utf_e2u(trigdata->tg_trigger->tgname), -1));
1116
1117 /* The oid of the trigger relation for argument TG_relid */
1118 /* Consider not converting to a string for more performance? */
1119 stroid = DatumGetCString(DirectFunctionCall1(oidout,
1120 ObjectIdGetDatum(trigdata->tg_relation->rd_id)));
1121 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1122 Tcl_NewStringObj(stroid, -1));
1123 pfree(stroid);
1124
1125 /* The name of the table the trigger is acting on: TG_table_name */
1126 stroid = SPI_getrelname(trigdata->tg_relation);
1127 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1128 Tcl_NewStringObj(utf_e2u(stroid), -1));
1129 pfree(stroid);
1130
1131 /* The schema of the table the trigger is acting on: TG_table_schema */
1132 stroid = SPI_getnspname(trigdata->tg_relation);
1133 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1134 Tcl_NewStringObj(utf_e2u(stroid), -1));
1135 pfree(stroid);
1136
1137 /* A list of attribute names for argument TG_relatts */
1138 tcl_trigtup = Tcl_NewObj();
1139 Tcl_ListObjAppendElement(NULL, tcl_trigtup, Tcl_NewObj());
1140 for (i = 0; i < tupdesc->natts; i++)
1141 {
1142 Form_pg_attribute att = TupleDescAttr(tupdesc, i);
1143
1144 if (att->attisdropped)
1145 Tcl_ListObjAppendElement(NULL, tcl_trigtup, Tcl_NewObj());
1146 else
1147 Tcl_ListObjAppendElement(NULL, tcl_trigtup,
1148 Tcl_NewStringObj(utf_e2u(NameStr(att->attname)), -1));
1149 }
1150 Tcl_ListObjAppendElement(NULL, tcl_cmd, tcl_trigtup);
1151
1152 /* The when part of the event for TG_when */
1153 if (TRIGGER_FIRED_BEFORE(trigdata->tg_event))
1154 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1155 Tcl_NewStringObj("BEFORE", -1));
1156 else if (TRIGGER_FIRED_AFTER(trigdata->tg_event))
1157 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1158 Tcl_NewStringObj("AFTER", -1));
1159 else if (TRIGGER_FIRED_INSTEAD(trigdata->tg_event))
1160 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1161 Tcl_NewStringObj("INSTEAD OF", -1));
1162 else
1163 elog(ERROR, "unrecognized WHEN tg_event: %u", trigdata->tg_event);
1164
1165 /* The level part of the event for TG_level */
1166 if (TRIGGER_FIRED_FOR_ROW(trigdata->tg_event))
1167 {
1168 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1169 Tcl_NewStringObj("ROW", -1));
1170
1171 /*
1172 * Now the command part of the event for TG_op and data for NEW
1173 * and OLD
1174 *
1175 * Note: In BEFORE trigger, stored generated columns are not
1176 * computed yet, so don't make them accessible in NEW row.
1177 */
1178 if (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event))
1179 {
1180 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1181 Tcl_NewStringObj("INSERT", -1));
1182
1183 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1184 pltcl_build_tuple_argument(trigdata->tg_trigtuple,
1185 tupdesc,
1186 !TRIGGER_FIRED_BEFORE(trigdata->tg_event)));
1187 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
1188
1189 rettup = trigdata->tg_trigtuple;
1190 }
1191 else if (TRIGGER_FIRED_BY_DELETE(trigdata->tg_event))
1192 {
1193 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1194 Tcl_NewStringObj("DELETE", -1));
1195
1196 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
1197 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1198 pltcl_build_tuple_argument(trigdata->tg_trigtuple,
1199 tupdesc,
1200 true));
1201
1202 rettup = trigdata->tg_trigtuple;
1203 }
1204 else if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))
1205 {
1206 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1207 Tcl_NewStringObj("UPDATE", -1));
1208
1209 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1210 pltcl_build_tuple_argument(trigdata->tg_newtuple,
1211 tupdesc,
1212 !TRIGGER_FIRED_BEFORE(trigdata->tg_event)));
1213 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1214 pltcl_build_tuple_argument(trigdata->tg_trigtuple,
1215 tupdesc,
1216 true));
1217
1218 rettup = trigdata->tg_newtuple;
1219 }
1220 else
1221 elog(ERROR, "unrecognized OP tg_event: %u", trigdata->tg_event);
1222 }
1223 else if (TRIGGER_FIRED_FOR_STATEMENT(trigdata->tg_event))
1224 {
1225 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1226 Tcl_NewStringObj("STATEMENT", -1));
1227
1228 if (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event))
1229 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1230 Tcl_NewStringObj("INSERT", -1));
1231 else if (TRIGGER_FIRED_BY_DELETE(trigdata->tg_event))
1232 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1233 Tcl_NewStringObj("DELETE", -1));
1234 else if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))
1235 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1236 Tcl_NewStringObj("UPDATE", -1));
1237 else if (TRIGGER_FIRED_BY_TRUNCATE(trigdata->tg_event))
1238 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1239 Tcl_NewStringObj("TRUNCATE", -1));
1240 else
1241 elog(ERROR, "unrecognized OP tg_event: %u", trigdata->tg_event);
1242
1243 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
1244 Tcl_ListObjAppendElement(NULL, tcl_cmd, Tcl_NewObj());
1245
1246 rettup = (HeapTuple) NULL;
1247 }
1248 else
1249 elog(ERROR, "unrecognized LEVEL tg_event: %u", trigdata->tg_event);
1250
1251 /* Finally append the arguments from CREATE TRIGGER */
1252 for (i = 0; i < trigdata->tg_trigger->tgnargs; i++)
1253 Tcl_ListObjAppendElement(NULL, tcl_cmd,
1254 Tcl_NewStringObj(utf_e2u(trigdata->tg_trigger->tgargs[i]), -1));
1255 }
1256 PG_CATCH();
1257 {
1258 Tcl_DecrRefCount(tcl_cmd);
1259 PG_RE_THROW();
1260 }
1261 PG_END_TRY();
1262
1263 /************************************************************
1264 * Call the Tcl function
1265 *
1266 * We assume no PG error can be thrown directly from this call.
1267 ************************************************************/
1268 tcl_rc = Tcl_EvalObjEx(interp, tcl_cmd, (TCL_EVAL_DIRECT | TCL_EVAL_GLOBAL));
1269
1270 /* Release refcount to free tcl_cmd (and all subsidiary objects) */
1271 Tcl_DecrRefCount(tcl_cmd);
1272
1273 /************************************************************
1274 * Check for errors reported by Tcl.
1275 ************************************************************/
1276 if (tcl_rc != TCL_OK)
1277 throw_tcl_error(interp, prodesc->user_proname);
1278
1279 /************************************************************
1280 * Exit SPI environment.
1281 ************************************************************/
1282 if (SPI_finish() != SPI_OK_FINISH)
1283 elog(ERROR, "SPI_finish() failed");
1284
1285 /************************************************************
1286 * The return value from the procedure might be one of
1287 * the magic strings OK or SKIP, or a list from array get.
1288 * We can check for OK or SKIP without worrying about encoding.
1289 ************************************************************/
1290 result = Tcl_GetStringResult(interp);
1291
1292 if (strcmp(result, "OK") == 0)
1293 return rettup;
1294 if (strcmp(result, "SKIP") == 0)
1295 return (HeapTuple) NULL;
1296
1297 /************************************************************
1298 * Otherwise, the return value should be a column name/value list
1299 * specifying the modified tuple to return.
1300 ************************************************************/
1301 if (Tcl_ListObjGetElements(interp, Tcl_GetObjResult(interp),
1302 &result_Objc, &result_Objv) != TCL_OK)
1303 ereport(ERROR,
1304 (errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
1305 errmsg("could not parse trigger return value: %s",
1306 utf_u2e(Tcl_GetStringResult(interp)))));
1307
1308 /* Convert function result to tuple */
1309 rettup = pltcl_build_tuple_result(interp, result_Objv, result_Objc,
1310 call_state);
1311
1312 return rettup;
1313}

References Assert, compile_pltcl_function(), DatumGetCString(), DirectFunctionCall1, elog, ereport, errcode(), errmsg, ERROR, fb(), pltcl_proc_desc::fn_refcount, i, pltcl_proc_desc::internal_proname, pltcl_interp_desc::interp, pltcl_proc_desc::interp_desc, NameStr, TupleDescData::natts, ObjectIdGetDatum(), oidout(), pfree(), PG_CATCH, PG_END_TRY, PG_RE_THROW, PG_TRY, PG_USED_FOR_ASSERTS_ONLY, pltcl_build_tuple_argument(), pltcl_build_tuple_result(), RelationData::rd_id, RelationGetDescr, RelationGetRelid, SPI_connect(), SPI_finish(), SPI_getnspname(), SPI_getrelname(), SPI_OK_FINISH, SPI_register_trigger_data(), TriggerData::tg_event, TriggerData::tg_newtuple, TriggerData::tg_relation, TriggerData::tg_trigger, TriggerData::tg_trigtuple, Trigger::tgargs, Trigger::tgname, Trigger::tgnargs, throw_tcl_error(), TRIGGER_FIRED_AFTER, TRIGGER_FIRED_BEFORE, TRIGGER_FIRED_BY_DELETE, TRIGGER_FIRED_BY_INSERT, TRIGGER_FIRED_BY_TRUNCATE, TRIGGER_FIRED_BY_UPDATE, TRIGGER_FIRED_FOR_ROW, TRIGGER_FIRED_FOR_STATEMENT, TRIGGER_FIRED_INSTEAD, TupleDescAttr(), pltcl_proc_desc::user_proname, utf_e2u(), and utf_u2e().

Referenced by pltcl_handler().

◆ pltcl_WaitForEvent()

static int pltcl_WaitForEvent ( CONST86 Tcl_Time *  timePtr)
static

Definition at line 394 of file pltcl.c.

395{
396 return 0;
397}

Referenced by _PG_init().

◆ pltclu_call_handler()

Datum pltclu_call_handler ( PG_FUNCTION_ARGS  )

Definition at line 717 of file pltcl.c.

718{
719 return pltcl_handler(fcinfo, false);
720}

References pltcl_handler().

◆ start_proc_error_callback()

static void start_proc_error_callback ( void *  arg)
static

Definition at line 685 of file pltcl.c.

686{
687 const char *gucname = (const char *) arg;
688
689 /* translator: %s is "pltcl.start_proc" or "pltclu.start_proc" */
690 errcontext("processing %s parameter", gucname);
691}

References arg, and errcontext.

Referenced by call_pltcl_start_proc().

◆ throw_tcl_error()

static void throw_tcl_error ( Tcl_Interp *  interp,
const char *  proname 
)
static

Definition at line 1373 of file pltcl.c.

1374{
1375 /*
1376 * Caution is needed here because Tcl_GetVar could overwrite the
1377 * interpreter result (even though it's not really supposed to), and we
1378 * can't control the order of evaluation of ereport arguments. Hence, make
1379 * real sure we have our own copy of the result string before invoking
1380 * Tcl_GetVar.
1381 */
1382 char *emsg;
1383 char *econtext;
1384 int emsglen;
1385
1386 emsg = pstrdup(utf_u2e(Tcl_GetStringResult(interp)));
1387 econtext = utf_u2e(Tcl_GetVar(interp, "errorInfo", TCL_GLOBAL_ONLY));
1388
1389 /*
1390 * Typically, the first line of errorInfo matches the primary error
1391 * message (the interpreter result); don't print that twice if so.
1392 */
1393 emsglen = strlen(emsg);
1394 if (strncmp(emsg, econtext, emsglen) == 0 &&
1395 econtext[emsglen] == '\n')
1396 econtext += emsglen + 1;
1397
1398 /* Tcl likes to prefix the next line with some spaces, too */
1399 while (*econtext == ' ')
1400 econtext++;
1401
1402 /* Note: proname will already contain quoting if any is needed */
1403 ereport(ERROR,
1404 (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1405 errmsg("%s", emsg),
1406 errcontext("%s\nin PL/Tcl function %s",
1407 econtext, proname)));
1408}

References ereport, errcode(), errcontext, errmsg, ERROR, fb(), proname, pstrdup(), and utf_u2e().

Referenced by pltcl_event_trigger_handler(), pltcl_func_handler(), and pltcl_trigger_handler().

◆ utf_e2u()

static char * utf_e2u ( const char *  src)
inlinestatic

Definition at line 88 of file pltcl.c.

89{
90 return pg_server_to_any(src, strlen(src), PG_UTF8);
91}

References fb(), pg_server_to_any(), and PG_UTF8.

Referenced by pltcl_event_trigger_handler(), and pltcl_trigger_handler().

◆ utf_u2e()

static char * utf_u2e ( const char *  src)
inlinestatic

Definition at line 82 of file pltcl.c.

83{
84 return pg_any_to_server(src, strlen(src), PG_UTF8);
85}

References fb(), pg_any_to_server(), and PG_UTF8.

Referenced by compile_pltcl_function(), pltcl_build_tuple_result(), pltcl_func_handler(), pltcl_returnnext(), pltcl_trigger_handler(), and throw_tcl_error().

Variable Documentation

◆ exception_name_map

const TclExceptionNameMap exception_name_map[]
static
Initial value:
= {
{NULL, 0}
}

Definition at line 265 of file pltcl.c.

265 {
266#include "pltclerrcodes.h"
267 {NULL, 0}
268};

Referenced by pltcl_get_condition_name().

◆ pltcl_current_call_state

pltcl_call_state* pltcl_current_call_state = NULL
static

Definition at line 254 of file pltcl.c.

Referenced by pltcl_argisnull(), pltcl_handler(), pltcl_returnnext(), pltcl_returnnull(), pltcl_SPI_execute(), pltcl_SPI_execute_plan(), and pltcl_SPI_prepare().

◆ pltcl_hold_interp

Tcl_Interp* pltcl_hold_interp = NULL
static

Definition at line 249 of file pltcl.c.

Referenced by _PG_init(), and pltcl_init_interp().

◆ pltcl_interp_htab

HTAB* pltcl_interp_htab = NULL
static

Definition at line 250 of file pltcl.c.

Referenced by _PG_init(), and pltcl_fetch_interp().

◆ pltcl_pm_init_done

bool pltcl_pm_init_done = false
static

Definition at line 248 of file pltcl.c.

Referenced by _PG_init().

◆ pltcl_proc_htab

HTAB* pltcl_proc_htab = NULL
static

Definition at line 251 of file pltcl.c.

Referenced by _PG_init(), and compile_pltcl_function().

◆ pltcl_start_proc

char* pltcl_start_proc = NULL
static

Definition at line 246 of file pltcl.c.

Referenced by _PG_init(), and call_pltcl_start_proc().

◆ pltclu_start_proc

char* pltclu_start_proc = NULL
static

Definition at line 247 of file pltcl.c.

Referenced by _PG_init(), and call_pltcl_start_proc().