PostgreSQL Source Code git master
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/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 58 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))

Definition at line 47 of file pltcl.c.

◆ TEXTDOMAIN

#define TEXTDOMAIN   PG_TEXTDOMAIN("pltcl")

Definition at line 67 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 92 of file pltcl.c.

◆ UTF_E2U

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

Definition at line 105 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 97 of file pltcl.c.

◆ UTF_U2E

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

Definition at line 102 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 62 of file pltcl.c.

Function Documentation

◆ _PG_init()

void _PG_init ( void  )

Definition at line 408 of file pltcl.c.

409{
410 Tcl_NotifierProcs notifier;
411 HASHCTL hash_ctl;
412
413 /* Be sure we do initialization only once (should be redundant now) */
415 return;
416
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,
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,
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,
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,
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}
#define gettext_noop(x)
Definition: c.h:1195
HTAB * hash_create(const char *tabname, int64 nelem, const HASHCTL *info, int flags)
Definition: dynahash.c:358
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:226
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:5241
void MarkGUCPrefixReserved(const char *className)
Definition: guc.c:5302
@ PGC_SUSET
Definition: guc.h:78
#define HASH_ELEM
Definition: hsearch.h:95
#define HASH_BLOBS
Definition: hsearch.h:97
void pg_bindtextdomain(const char *domain)
Definition: miscinit.c:1888
static void pltcl_ServiceModeHook(int mode)
Definition: pltcl.c:388
static HTAB * pltcl_proc_htab
Definition: pltcl.c:250
static void pltcl_AlertNotifier(ClientData clientData)
Definition: pltcl.c:372
static int pltcl_WaitForEvent(CONST86 Tcl_Time *timePtr)
Definition: pltcl.c:393
static void pltcl_SetTimer(CONST86 Tcl_Time *timePtr)
Definition: pltcl.c:367
static void pltcl_DeleteFileHandler(int fd)
Definition: pltcl.c:383
static void pltcl_FinalizeNotifier(ClientData clientData)
Definition: pltcl.c:362
static void pltcl_CreateFileHandler(int fd, int mask, Tcl_FileProc *proc, ClientData clientData)
Definition: pltcl.c:377
static char * pltcl_start_proc
Definition: pltcl.c:245
static HTAB * pltcl_interp_htab
Definition: pltcl.c:249
struct pltcl_proc_key pltcl_proc_key
#define TEXTDOMAIN
Definition: pltcl.c:67
struct pltcl_interp_desc pltcl_interp_desc
static char * pltclu_start_proc
Definition: pltcl.c:246
static ClientData pltcl_InitNotifier(void)
Definition: pltcl.c:354
static Tcl_Interp * pltcl_hold_interp
Definition: pltcl.c:248
static bool pltcl_pm_init_done
Definition: pltcl.c:247
struct pltcl_proc_ptr pltcl_proc_ptr
unsigned int Oid
Definition: postgres_ext.h:32
Definition: hsearch.h:66
Size keysize
Definition: hsearch.h:75
Size entrysize
Definition: hsearch.h:76

References DefineCustomStringVariable(), elog, HASHCTL::entrysize, ERROR, gettext_noop, HASH_BLOBS, hash_create(), HASH_ELEM, HASHCTL::keysize, 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 597 of file pltcl.c.

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;
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 */
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)
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)
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 */
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}
AclResult
Definition: acl.h:182
@ ACLCHECK_OK
Definition: acl.h:183
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition: aclchk.c:2652
AclResult object_aclcheck(Oid classid, Oid objectid, Oid roleid, AclMode mode)
Definition: aclchk.c:3834
#define unconstify(underlying_type, expr)
Definition: c.h:1244
ErrorContextCallback * error_context_stack
Definition: elog.c:95
int errcode(int sqlerrcode)
Definition: elog.c:854
int errmsg(const char *fmt,...)
Definition: elog.c:1071
#define ereport(elevel,...)
Definition: elog.h:150
void fmgr_info(Oid functionId, FmgrInfo *finfo)
Definition: fmgr.c:128
#define InitFunctionCallInfoData(Fcinfo, Flinfo, Nargs, Collation, Context, Resultinfo)
Definition: fmgr.h:150
#define LOCAL_FCINFO(name, nargs)
Definition: fmgr.h:110
#define FunctionCallInvoke(fcinfo)
Definition: fmgr.h:172
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
static void * GETSTRUCT(const HeapTupleData *tuple)
Definition: htup_details.h:728
Oid GetUserId(void)
Definition: miscinit.c:469
#define InvokeFunctionExecuteHook(objectId)
Definition: objectaccess.h:213
Oid LookupFuncName(List *funcname, int nargs, const Oid *argtypes, bool missing_ok)
Definition: parse_func.c:2269
@ OBJECT_FUNCTION
Definition: parsenodes.h:2344
#define ACL_EXECUTE
Definition: parsenodes.h:83
FormData_pg_proc * Form_pg_proc
Definition: pg_proc.h:136
void pgstat_init_function_usage(FunctionCallInfo fcinfo, PgStat_FunctionCallUsage *fcu)
void pgstat_end_function_usage(PgStat_FunctionCallUsage *fcu, bool finalize)
static void start_proc_error_callback(void *arg)
Definition: pltcl.c:684
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:262
#define InvalidOid
Definition: postgres_ext.h:37
List * stringToQualifiedNameList(const char *string, Node *escontext)
Definition: regproc.c:1922
struct ErrorContextCallback * previous
Definition: elog.h:297
void * arg
Definition: elog.h:299
void(* callback)(void *arg)
Definition: elog.h:298
Definition: fmgr.h:57
Definition: pg_list.h:54
Definition: pgstat.h:92
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:264
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:220

References ACL_EXECUTE, aclcheck_error(), ACLCHECK_OK, ErrorContextCallback::arg, ErrorContextCallback::callback, elog, ereport, errcode(), errmsg(), ERROR, error_context_stack, fmgr_info(), 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 1417 of file pltcl.c.

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 ************************************************************/
1581 "PL/Tcl function",
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 = (pltcl_proc_desc *) palloc0(sizeof(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}
#define TextDatumGetCString(d)
Definition: builtins.h:98
#define OidIsValid(objectId)
Definition: c.h:774
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:952
#define PG_RE_THROW()
Definition: elog.h:405
#define PG_TRY(...)
Definition: elog.h:372
#define PG_END_TRY(...)
Definition: elog.h:397
#define PG_CATCH(...)
Definition: elog.h:382
void fmgr_info_cxt(Oid functionId, FmgrInfo *finfo, MemoryContext mcxt)
Definition: fmgr.c:138
char * format_type_be(Oid type_oid)
Definition: format_type.c:343
Assert(PointerIsAligned(start, uint64))
@ HASH_ENTER
Definition: hsearch.h:114
static TransactionId HeapTupleHeaderGetRawXmin(const HeapTupleHeaderData *tup)
Definition: htup_details.h:318
i
int i
Definition: isn.c:77
bool ItemPointerEquals(ItemPointer pointer1, ItemPointer pointer2)
Definition: itemptr.c:35
bool type_is_rowtype(Oid typid)
Definition: lsyscache.c:2822
Oid getTypeIOParam(HeapTuple typeTuple)
Definition: lsyscache.c:2470
char * pstrdup(const char *in)
Definition: mcxt.c:1759
void pfree(void *pointer)
Definition: mcxt.c:1594
void * palloc0(Size size)
Definition: mcxt.c:1395
MemoryContext TopMemoryContext
Definition: mcxt.c:166
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:469
void MemoryContextSetIdentifier(MemoryContext context, const char *id)
Definition: mcxt.c:658
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:170
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:124
#define FUNC_MAX_ARGS
static char * buf
Definition: pg_test_fsync.c:72
FormData_pg_type * Form_pg_type
Definition: pg_type.h:261
#define UTF_E2U(x)
Definition: pltcl.c:105
#define UTF_END
Definition: pltcl.c:97
#define UTF_BEGIN
Definition: pltcl.c:92
static pltcl_interp_desc * pltcl_fetch_interp(Oid prolang, bool pltrusted)
Definition: pltcl.c:567
static char * utf_u2e(const char *src)
Definition: pltcl.c:81
#define snprintf
Definition: port.h:239
uint64_t Datum
Definition: postgres.h:70
char * format_procedure(Oid procedure_oid)
Definition: regproc.c:305
ItemPointerData t_self
Definition: htup.h:65
HeapTupleHeader t_data
Definition: htup.h:68
Definition: pltcl.c:120
Tcl_Interp * interp
Definition: pltcl.c:122
Definition: pltcl.c:145
FmgrInfo result_in_func
Definition: pltcl.c:156
Oid result_typid
Definition: pltcl.c:155
FmgrInfo * arg_out_func
Definition: pltcl.c:164
bool fn_retisdomain
Definition: pltcl.c:160
char * user_proname
Definition: pltcl.c:146
int nargs
Definition: pltcl.c:162
ItemPointerData fn_tid
Definition: pltcl.c:151
char * internal_proname
Definition: pltcl.c:147
pltcl_interp_desc * interp_desc
Definition: pltcl.c:154
bool fn_retisset
Definition: pltcl.c:158
unsigned long fn_refcount
Definition: pltcl.c:149
void * domain_info
Definition: pltcl.c:161
MemoryContext fn_cxt
Definition: pltcl.c:148
bool fn_readonly
Definition: pltcl.c:152
bool fn_retistuple
Definition: pltcl.c:159
Oid result_typioparam
Definition: pltcl.c:157
bool lanpltrusted
Definition: pltcl.c:153
bool * arg_is_rowtype
Definition: pltcl.c:165
TransactionId fn_xmin
Definition: pltcl.c:150
Definition: pltcl.c:195
Oid is_trigger
Definition: pltcl.c:202
Oid user_id
Definition: pltcl.c:203
Oid proc_id
Definition: pltcl.c:196
Definition: pltcl.c:207
pltcl_proc_desc * proc_ptr
Definition: pltcl.c:209
Datum SysCacheGetAttrNotNull(int cacheId, HeapTuple tup, AttrNumber attributeNumber)
Definition: syscache.c:625

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, 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, 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(), 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(), HeapTupleData::t_data, HeapTupleData::t_self, 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 372 of file pltcl.c.

373{
374}

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 2147 of file pltcl.c.

2149{
2150 int argno;
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}
#define PG_ARGISNULL(n)
Definition: fmgr.h:209
static pltcl_call_state * pltcl_current_call_state
Definition: pltcl.c:253
FunctionCallInfo fcinfo
Definition: pltcl.c:219

References 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 3188 of file pltcl.c.

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}
#define NameStr(name)
Definition: c.h:751
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1763
static Datum heap_getattr(HeapTuple tup, int attnum, TupleDesc tupleDesc, bool *isnull)
Definition: htup_details.h:904
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:3074
NameData attname
Definition: pg_attribute.h:41
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:202
int natts
Definition: tupdesc.h:137
static FormData_pg_attribute * TupleDescAttr(TupleDesc tupdesc, int i)
Definition: tupdesc.h:160

References attname, 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 3267 of file pltcl.c.

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}
static Datum values[MAXATTR]
Definition: bootstrap.c:153
void domain_check(Datum value, bool isnull, Oid domainType, void **extra, MemoryContext mcxt)
Definition: domains.c:346
HeapTuple BuildTupleFromCStrings(AttInMetadata *attinmeta, char **values)
Definition: execTuples.c:2324
AttInMetadata * TupleDescGetAttInMetadata(TupleDesc tupdesc)
Definition: execTuples.c:2275
static Datum HeapTupleGetDatum(const HeapTupleData *tuple)
Definition: funcapi.h:230
#define RelationGetDescr(relation)
Definition: rel.h:540
int SPI_fnumber(TupleDesc tupdesc, const char *fname)
Definition: spi.c:1175
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:76
Relation tg_relation
Definition: trigger.h:35
pltcl_proc_desc * prodesc
Definition: pltcl.c:225
TriggerData * trigdata
Definition: pltcl.c:222
AttInMetadata * attinmeta
Definition: pltcl.c:233
TupleDesc ret_tupdesc
Definition: pltcl.c:232

References pltcl_call_state::attinmeta, BuildTupleFromCStrings(), domain_check(), pltcl_proc_desc::domain_info, elog, ereport, errcode(), errmsg(), ERROR, pltcl_proc_desc::fn_cxt, pltcl_proc_desc::fn_retisdomain, HeapTupleGetDatum(), i, TupleDescData::natts, palloc0(), pltcl_call_state::prodesc, RelationGetDescr, pltcl_proc_desc::result_typid, pltcl_call_state::ret_tupdesc, SPI_ERROR_NOATTRIBUTE, SPI_fnumber(), TriggerData::tg_relation, pltcl_call_state::trigdata, 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 704 of file pltcl.c.

705{
706 return pltcl_handler(fcinfo, true);
707}
static Datum pltcl_handler(PG_FUNCTION_ARGS, bool pltrusted)
Definition: pltcl.c:727

References pltcl_handler().

◆ pltcl_commit()

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

Definition at line 3023 of file pltcl.c.

3025{
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();
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}
void FreeErrorData(ErrorData *edata)
Definition: elog.c:1826
ErrorData * CopyErrorData(void)
Definition: elog.c:1754
void FlushErrorState(void)
Definition: elog.c:1875
MemoryContext CurrentMemoryContext
Definition: mcxt.c:160
static void pltcl_construct_errorCode(Tcl_Interp *interp, ErrorData *edata)
Definition: pltcl.c:1930
void SPI_commit(void)
Definition: spi.c:320
Definition: elog.h:420
char * message
Definition: elog.h:432

References CopyErrorData(), CurrentMemoryContext, FlushErrorState(), FreeErrorData(), MemoryContextSwitchTo(), ErrorData::message, 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 1930 of file pltcl.c.

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}
char * unpack_sql_state(int sql_state)
Definition: elog.c:3213
static const char * pltcl_get_condition_name(int sqlstate)
Definition: pltcl.c:2075
int internalpos
Definition: elog.h:445
char * schema_name
Definition: elog.h:439
char * context
Definition: elog.h:436
char * internalquery
Definition: elog.h:446
int sqlerrcode
Definition: elog.h:431
const char * filename
Definition: elog.h:426
char * datatype_name
Definition: elog.h:442
char * detail
Definition: elog.h:433
const char * funcname
Definition: elog.h:428
char * table_name
Definition: elog.h:440
int lineno
Definition: elog.h:427
char * hint
Definition: elog.h:435
char * constraint_name
Definition: elog.h:443
char * column_name
Definition: elog.h:441

References ErrorData::column_name, ErrorData::constraint_name, ErrorData::context, ErrorData::datatype_name, ErrorData::detail, ErrorData::filename, ErrorData::funcname, ErrorData::hint, ErrorData::internalpos, ErrorData::internalquery, ErrorData::lineno, ErrorData::message, pltcl_get_condition_name(), ErrorData::schema_name, ErrorData::sqlerrcode, ErrorData::table_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 377 of file pltcl.c.

379{
380}

Referenced by _PG_init().

◆ pltcl_DeleteFileHandler()

static void pltcl_DeleteFileHandler ( int  fd )
static

Definition at line 383 of file pltcl.c.

384{
385}

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 1843 of file pltcl.c.

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,
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();
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}
#define LOG
Definition: elog.h:31
#define FATAL
Definition: elog.h:41
#define WARNING
Definition: elog.h:36
#define DEBUG2
Definition: elog.h:29
#define NOTICE
Definition: elog.h:35
#define INFO
Definition: elog.h:34
#define UTF_U2E(x)
Definition: pltcl.c:102

References CopyErrorData(), CurrentMemoryContext, DEBUG2, ereport, errcode(), errmsg(), ERROR, FATAL, FlushErrorState(), FreeErrorData(), INFO, LOG, MemoryContextSwitchTo(), ErrorData::message, 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 1318 of file pltcl.c.

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}
const char * GetCommandTagName(CommandTag commandTag)
Definition: cmdtag.c:47
static char * utf_e2u(const char *src)
Definition: pltcl.c:87
static pltcl_proc_desc * compile_pltcl_function(Oid fn_oid, Oid tgreloid, bool is_event_trigger, bool pltrusted)
Definition: pltcl.c:1417
static void throw_tcl_error(Tcl_Interp *interp, const char *proname)
Definition: pltcl.c:1372
int SPI_connect(void)
Definition: spi.c:94
int SPI_finish(void)
Definition: spi.c:182
#define SPI_OK_FINISH
Definition: spi.h:83
CommandTag tag
Definition: event_trigger.h:29
const char * event
Definition: event_trigger.h:27

References compile_pltcl_function(), elog, ERROR, EventTriggerData::event, pltcl_proc_desc::fn_refcount, GetCommandTagName(), pltcl_proc_desc::internal_proname, pltcl_interp_desc::interp, pltcl_proc_desc::interp_desc, InvalidOid, pltcl_call_state::prodesc, SPI_connect(), SPI_finish(), SPI_OK_FINISH, EventTriggerData::tag, 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 567 of file pltcl.c.

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,
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}
static void pltcl_init_interp(pltcl_interp_desc *interp_desc, Oid prolang, bool pltrusted)
Definition: pltcl.c:494

References 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 362 of file pltcl.c.

363{
364}

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 801 of file pltcl.c.

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))
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))
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;
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 {
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 */
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 */
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;
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}
int32_t int32
Definition: c.h:534
@ SFRM_Materialize
Definition: execnodes.h:341
Datum InputFunctionCall(FmgrInfo *flinfo, char *str, Oid typioparam, int32 typmod)
Definition: fmgr.c:1531
char * OutputFunctionCall(FmgrInfo *flinfo, Datum val)
Definition: fmgr.c:1683
#define DatumGetHeapTupleHeader(X)
Definition: fmgr.h:295
TypeFuncClass get_call_result_type(FunctionCallInfo fcinfo, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:276
@ TYPEFUNC_COMPOSITE
Definition: funcapi.h:149
@ TYPEFUNC_RECORD
Definition: funcapi.h:151
@ TYPEFUNC_COMPOSITE_DOMAIN
Definition: funcapi.h:150
static int32 HeapTupleHeaderGetTypMod(const HeapTupleHeaderData *tup)
Definition: htup_details.h:516
static uint32 HeapTupleHeaderGetDatumLength(const HeapTupleHeaderData *tup)
Definition: htup_details.h:492
static Oid HeapTupleHeaderGetTypeId(const HeapTupleHeaderData *tup)
Definition: htup_details.h:504
if(TABLE==NULL||TABLE_index==NULL)
Definition: isn.c:81
#define IsA(nodeptr, _type_)
Definition: nodes.h:164
#define castNode(_type_, nodeptr)
Definition: nodes.h:182
static Tcl_Obj * pltcl_build_tuple_argument(HeapTuple tuple, TupleDesc tupdesc, bool include_generated)
Definition: pltcl.c:3188
int Tcl_Size
Definition: pltcl.c:62
static HeapTuple pltcl_build_tuple_result(Tcl_Interp *interp, Tcl_Obj **kvObjv, int kvObjc, pltcl_call_state *call_state)
Definition: pltcl.c:3267
ResourceOwner CurrentResourceOwner
Definition: resowner.c:173
int SPI_connect_ext(int options)
Definition: spi.c:100
#define SPI_OPT_NONATOMIC
Definition: spi.h:102
MemoryContext ecxt_per_query_memory
Definition: execnodes.h:280
uint32 t_len
Definition: htup.h:64
SetFunctionReturnMode returnMode
Definition: execnodes.h:360
ExprContext * econtext
Definition: execnodes.h:356
TupleDesc setDesc
Definition: execnodes.h:364
Tuplestorestate * setResult
Definition: execnodes.h:363
int allowedModes
Definition: execnodes.h:358
ReturnSetInfo * rsi
Definition: pltcl.c:235
MemoryContext tuple_store_cxt
Definition: pltcl.c:237
Tuplestorestate * tuple_store
Definition: pltcl.c:236
ResourceOwner tuple_store_owner
Definition: pltcl.c:238
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:252
#define ReleaseTupleDesc(tupdesc)
Definition: tupdesc.h:219
TupleDesc lookup_rowtype_tupdesc(Oid type_id, int32 typmod)
Definition: typcache.c:1921

References ReturnSetInfo::allowedModes, pltcl_proc_desc::arg_is_rowtype, pltcl_proc_desc::arg_out_func, Assert(), pltcl_call_state::attinmeta, castNode, compile_pltcl_function(), CreateTupleDescCopy(), CurrentResourceOwner, DatumGetHeapTupleHeader, ReturnSetInfo::econtext, ExprContext::ecxt_per_query_memory, elog, ereport, errcode(), errmsg(), ERROR, 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, if(), 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(), pltcl_call_state::prodesc, ReleaseTupleDesc, pltcl_proc_desc::result_in_func, pltcl_proc_desc::result_typioparam, pltcl_call_state::ret_tupdesc, ReturnSetInfo::returnMode, pltcl_call_state::rsi, ReturnSetInfo::setDesc, ReturnSetInfo::setResult, SFRM_Materialize, SPI_connect_ext(), SPI_finish(), SPI_OK_FINISH, SPI_OPT_NONATOMIC, HeapTupleData::t_data, HeapTupleData::t_len, throw_tcl_error(), pltcl_call_state::tuple_store, pltcl_call_state::tuple_store_cxt, pltcl_call_state::tuple_store_owner, 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 2075 of file pltcl.c.

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}
static const TclExceptionNameMap exception_name_map[]
Definition: pltcl.c:264
const char * label
Definition: pltcl.c:260

References exception_name_map, i, and TclExceptionNameMap::label.

Referenced by pltcl_construct_errorCode().

◆ pltcl_handler()

static Datum pltcl_handler ( PG_FUNCTION_ARGS  ,
bool  pltrusted 
)
static

Definition at line 727 of file pltcl.c.

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 */
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}
#define PG_FINALLY(...)
Definition: elog.h:389
#define CALLED_AS_EVENT_TRIGGER(fcinfo)
Definition: event_trigger.h:49
static HeapTuple pltcl_trigger_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
Definition: pltcl.c:1059
static void pltcl_event_trigger_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
Definition: pltcl.c:1318
static Datum pltcl_func_handler(PG_FUNCTION_ARGS, pltcl_call_state *call_state, bool pltrusted)
Definition: pltcl.c:801
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:332
Definition: pltcl.c:217
#define CALLED_AS_TRIGGER(fcinfo)
Definition: trigger.h:26

References Assert(), CALLED_AS_EVENT_TRIGGER, CALLED_AS_TRIGGER, pltcl_call_state::fcinfo, pltcl_proc_desc::fn_cxt, pltcl_proc_desc::fn_refcount, MemoryContextDelete(), PG_END_TRY, PG_FINALLY, PG_TRY, pltcl_current_call_state, pltcl_event_trigger_handler(), pltcl_func_handler(), pltcl_trigger_handler(), PointerGetDatum(), and pltcl_call_state::prodesc.

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 494 of file pltcl.c.

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}
static void call_pltcl_start_proc(Oid prolang, bool pltrusted)
Definition: pltcl.c:597
static int pltcl_returnnext(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:2239
static int pltcl_SPI_execute(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:2409
static int pltcl_elog(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:1843
static int pltcl_quote(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:2093
static int pltcl_SPI_prepare(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:2631
static int pltcl_rollback(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:3062
static int pltcl_argisnull(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:2147
static int pltcl_returnnull(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:2201
static int pltcl_SPI_execute_plan(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:2759
static int pltcl_subtransaction(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:2975
static int pltcl_commit(ClientData cdata, Tcl_Interp *interp, int objc, Tcl_Obj *const objv[])
Definition: pltcl.c:3023
Tcl_HashTable query_hash
Definition: pltcl.c:123
Oid user_id
Definition: pltcl.c:121

References call_pltcl_start_proc(), elog, ERROR, 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 3351 of file pltcl.c.

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;
3377
3378 call_state->tuple_store =
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}
@ SFRM_Materialize_Random
Definition: execnodes.h:342
int work_mem
Definition: globals.c:131
TupleDesc expectedDesc
Definition: execnodes.h:357
Tuplestorestate * tuplestore_begin_heap(bool randomAccess, bool interXact, int maxKBytes)
Definition: tuplestore.c:330

References ReturnSetInfo::allowedModes, Assert(), pltcl_call_state::attinmeta, CurrentResourceOwner, ReturnSetInfo::expectedDesc, MemoryContextSwitchTo(), pltcl_call_state::ret_tupdesc, pltcl_call_state::rsi, SFRM_Materialize_Random, pltcl_call_state::tuple_store, pltcl_call_state::tuple_store_cxt, pltcl_call_state::tuple_store_owner, TupleDescGetAttInMetadata(), tuplestore_begin_heap(), and work_mem.

Referenced by pltcl_returnnext().

◆ pltcl_InitNotifier()

static ClientData pltcl_InitNotifier ( void  )
static

Definition at line 354 of file pltcl.c.

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

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 2518 of file pltcl.c.

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 /* FALLTHROUGH */
2549
2550 case SPI_OK_SELECT:
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}
uint64_t uint64
Definition: c.h:539
static void pltcl_set_tuple_values(Tcl_Interp *interp, const char *arrayname, uint64 tupno, HeapTuple tuple, TupleDesc tupdesc)
Definition: pltcl.c:3102
const char * SPI_result_code_string(int code)
Definition: spi.c:1972
void SPI_freetuptable(SPITupleTable *tuptable)
Definition: spi.c:1386
#define SPI_OK_UTILITY
Definition: spi.h:85
#define SPI_OK_REWRITTEN
Definition: spi.h:95
#define SPI_OK_INSERT
Definition: spi.h:88
#define SPI_OK_UPDATE
Definition: spi.h:90
#define SPI_OK_MERGE
Definition: spi.h:99
#define SPI_OK_SELINTO
Definition: spi.h:87
#define SPI_OK_UPDATE_RETURNING
Definition: spi.h:94
#define SPI_OK_DELETE
Definition: spi.h:89
#define SPI_OK_INSERT_RETURNING
Definition: spi.h:92
#define SPI_OK_DELETE_RETURNING
Definition: spi.h:93
#define SPI_OK_MERGE_RETURNING
Definition: spi.h:100
#define SPI_OK_SELECT
Definition: spi.h:86
TupleDesc tupdesc
Definition: spi.h:25
HeapTuple * vals
Definition: spi.h:26

References i, 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 2093 of file pltcl.c.

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}
void * palloc(Size size)
Definition: mcxt.c:1365

References 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 2239 of file pltcl.c.

2241{
2243 FunctionCallInfo fcinfo = call_state->fcinfo;
2244 pltcl_proc_desc *prodesc = call_state->prodesc;
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 */
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}
static void pltcl_init_tuple_store(pltcl_call_state *call_state)
Definition: pltcl.c:3351
static void pltcl_subtrans_abort(Tcl_Interp *interp, MemoryContext oldcontext, ResourceOwner oldowner)
Definition: pltcl.c:2380
static void pltcl_subtrans_commit(MemoryContext oldcontext, ResourceOwner oldowner)
Definition: pltcl.c:2371
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, const Datum *values, const bool *isnull)
Definition: tuplestore.c:784
void tuplestore_puttuple(Tuplestorestate *state, HeapTuple tuple)
Definition: tuplestore.c:764
void BeginInternalSubTransaction(const char *name)
Definition: xact.c:4706

References BeginInternalSubTransaction(), CurrentMemoryContext, CurrentResourceOwner, elog, ERROR, pltcl_call_state::fcinfo, pltcl_proc_desc::fn_retisset, pltcl_proc_desc::fn_retistuple, InputFunctionCall(), TupleDescData::natts, 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_call_state::prodesc, pltcl_proc_desc::result_in_func, pltcl_proc_desc::result_typioparam, pltcl_call_state::ret_tupdesc, pltcl_call_state::tuple_store, 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 2201 of file pltcl.c.

2203{
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}

References 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 3062 of file pltcl.c.

3064{
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();
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}
void SPI_rollback(void)
Definition: spi.c:413

References CopyErrorData(), CurrentMemoryContext, FlushErrorState(), FreeErrorData(), MemoryContextSwitchTo(), ErrorData::message, 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 388 of file pltcl.c.

389{
390}

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 3102 of file pltcl.c.

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}

References attname, 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 367 of file pltcl.c.

368{
369}

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 2409 of file pltcl.c.

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;
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])),
2491 UTF_END;
2492
2493 my_rc = pltcl_process_SPI_result(interp,
2494 arrayname,
2495 loop_body,
2496 spi_rc,
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}
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:2518
static void pltcl_subtrans_begin(MemoryContext oldcontext, ResourceOwner oldowner)
Definition: pltcl.c:2362
uint64 SPI_processed
Definition: spi.c:44
SPITupleTable * SPI_tuptable
Definition: spi.c:45
int SPI_execute(const char *src, bool read_only, long tcount)
Definition: spi.c:596
Definition: oid2name.c:30

References CurrentMemoryContext, CurrentResourceOwner, 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 2759 of file pltcl.c.

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;
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
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,
2946 count);
2947
2948 my_rc = pltcl_process_SPI_result(interp,
2949 arrayname,
2950 loop_body,
2951 spi_rc,
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}
j
int j
Definition: isn.c:78
int SPI_execute_plan(SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only, long tcount)
Definition: spi.c:672
Definition: pltcl.c:173
Oid * argtypioparams
Definition: pltcl.c:179
SPIPlanPtr plan
Definition: pltcl.c:175
FmgrInfo * arginfuncs
Definition: pltcl.c:178
int nargs
Definition: pltcl.c:176

References pltcl_query_desc::arginfuncs, pltcl_query_desc::argtypioparams, CurrentMemoryContext, CurrentResourceOwner, pltcl_proc_desc::fn_readonly, i, InputFunctionCall(), pltcl_proc_desc::interp_desc, j, pltcl_query_desc::nargs, palloc(), PG_CATCH, PG_END_TRY, PG_TRY, pltcl_query_desc::plan, 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 2631 of file pltcl.c.

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;
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 ************************************************************/
2668 "PL/Tcl spi_prepare query",
2670 MemoryContextSwitchTo(plan_cxt);
2671 qdesc = (pltcl_query_desc *) palloc0(sizeof(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 ************************************************************/
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}
void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam)
Definition: lsyscache.c:3041
bool parseTypeString(const char *str, Oid *typeid_p, int32 *typmod_p, Node *escontext)
Definition: parse_type.c:785
SPIPlanPtr SPI_prepare(const char *src, int nargs, Oid *argtypes)
Definition: spi.c:860
int SPI_keepplan(SPIPlanPtr plan)
Definition: spi.c:976
char qname[20]
Definition: pltcl.c:174
Oid * argtypes
Definition: pltcl.c:177

References ALLOCSET_SMALL_SIZES, AllocSetContextCreate, pltcl_query_desc::arginfuncs, pltcl_query_desc::argtypes, pltcl_query_desc::argtypioparams, CurrentMemoryContext, CurrentResourceOwner, elog, ERROR, fmgr_info_cxt(), getTypeInputInfo(), i, pltcl_proc_desc::interp_desc, MemoryContextDelete(), MemoryContextSwitchTo(), pltcl_query_desc::nargs, palloc(), palloc0(), parseTypeString(), PG_CATCH, PG_END_TRY, PG_TRY, pltcl_query_desc::plan, pltcl_current_call_state, pltcl_subtrans_abort(), pltcl_subtrans_begin(), pltcl_subtrans_commit(), pltcl_call_state::prodesc, pltcl_query_desc::qname, 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 2380 of file pltcl.c.

2382{
2383 ErrorData *edata;
2384
2385 /* Save error info */
2386 MemoryContextSwitchTo(oldcontext);
2387 edata = CopyErrorData();
2389
2390 /* Abort the inner transaction */
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}
void RollbackAndReleaseCurrentSubTransaction(void)
Definition: xact.c:4808

References CopyErrorData(), CurrentResourceOwner, FlushErrorState(), FreeErrorData(), MemoryContextSwitchTo(), ErrorData::message, 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 2362 of file pltcl.c.

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

References BeginInternalSubTransaction(), 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 2371 of file pltcl.c.

2372{
2373 /* Commit the inner transaction, return to outer xact context */
2375 MemoryContextSwitchTo(oldcontext);
2376 CurrentResourceOwner = oldowner;
2377}
void ReleaseCurrentSubTransaction(void)
Definition: xact.c:4780

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 2975 of file pltcl.c.

2977{
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 */
2994 MemoryContextSwitchTo(oldcontext);
2995
2996 retcode = Tcl_EvalObjEx(interp, objv[1], 0);
2997
2998 if (retcode == TCL_ERROR)
2999 {
3000 /* Rollback the subtransaction */
3002 }
3003 else
3004 {
3005 /* Commit the subtransaction */
3007 }
3008
3009 /* In either case, restore previous memory context and resource owner */
3010 MemoryContextSwitchTo(oldcontext);
3011 CurrentResourceOwner = oldowner;
3012
3013 return retcode;
3014}

References BeginInternalSubTransaction(), CurrentMemoryContext, CurrentResourceOwner, 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 1059 of file pltcl.c.

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;
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? */
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,
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,
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,
1210 tupdesc,
1211 !TRIGGER_FIRED_BEFORE(trigdata->tg_event)));
1212 Tcl_ListObjAppendElement(NULL, tcl_cmd,
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}
#define PG_USED_FOR_ASSERTS_ONLY
Definition: c.h:223
#define DirectFunctionCall1(func, arg1)
Definition: fmgr.h:682
HeapTupleData * HeapTuple
Definition: htup.h:71
Datum oidout(PG_FUNCTION_ARGS)
Definition: oid.c:47
static char * DatumGetCString(Datum X)
Definition: postgres.h:345
#define RelationGetRelid(relation)
Definition: rel.h:514
int SPI_register_trigger_data(TriggerData *tdata)
Definition: spi.c:3364
char * SPI_getnspname(Relation rel)
Definition: spi.c:1332
char * SPI_getrelname(Relation rel)
Definition: spi.c:1326
Oid rd_id
Definition: rel.h:113
TriggerEvent tg_event
Definition: trigger.h:34
HeapTuple tg_newtuple
Definition: trigger.h:37
Trigger * tg_trigger
Definition: trigger.h:38
HeapTuple tg_trigtuple
Definition: trigger.h:36
char * tgname
Definition: reltrigger.h:27
int16 tgnargs
Definition: reltrigger.h:38
char ** tgargs
Definition: reltrigger.h:41
#define TRIGGER_FIRED_FOR_STATEMENT(event)
Definition: trigger.h:125
#define TRIGGER_FIRED_BY_DELETE(event)
Definition: trigger.h:113
#define TRIGGER_FIRED_BEFORE(event)
Definition: trigger.h:128
#define TRIGGER_FIRED_FOR_ROW(event)
Definition: trigger.h:122
#define TRIGGER_FIRED_AFTER(event)
Definition: trigger.h:131
#define TRIGGER_FIRED_BY_TRUNCATE(event)
Definition: trigger.h:119
#define TRIGGER_FIRED_BY_INSERT(event)
Definition: trigger.h:110
#define TRIGGER_FIRED_BY_UPDATE(event)
Definition: trigger.h:116
#define TRIGGER_FIRED_INSTEAD(event)
Definition: trigger.h:134

References Assert(), compile_pltcl_function(), DatumGetCString(), DirectFunctionCall1, elog, ereport, errcode(), errmsg(), ERROR, pltcl_proc_desc::fn_refcount, i, pltcl_proc_desc::internal_proname, pltcl_interp_desc::interp, pltcl_proc_desc::interp_desc, NameStr, 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(), pltcl_call_state::prodesc, 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(), pltcl_call_state::trigdata, 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 393 of file pltcl.c.

394{
395 return 0;
396}

Referenced by _PG_init().

◆ pltclu_call_handler()

Datum pltclu_call_handler ( PG_FUNCTION_ARGS  )

Definition at line 716 of file pltcl.c.

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

References pltcl_handler().

◆ start_proc_error_callback()

static void start_proc_error_callback ( void *  arg )
static

Definition at line 684 of file pltcl.c.

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}
#define errcontext
Definition: elog.h:198
void * arg

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 1372 of file pltcl.c.

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}
NameData proname
Definition: pg_proc.h:35

References ereport, errcode(), errcontext, errmsg(), ERROR, 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 87 of file pltcl.c.

88{
89 return pg_server_to_any(src, strlen(src), PG_UTF8);
90}
char * pg_server_to_any(const char *s, int len, int encoding)
Definition: mbutils.c:750
@ PG_UTF8
Definition: pg_wchar.h:232

References 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 81 of file pltcl.c.

82{
83 return pg_any_to_server(src, strlen(src), PG_UTF8);
84}
char * pg_any_to_server(const char *s, int len, int encoding)
Definition: mbutils.c:677

References 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 264 of file pltcl.c.

Referenced by pltcl_get_condition_name().

◆ pltcl_current_call_state

pltcl_call_state* pltcl_current_call_state = NULL
static

Definition at line 253 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 248 of file pltcl.c.

Referenced by _PG_init(), and pltcl_init_interp().

◆ pltcl_interp_htab

HTAB* pltcl_interp_htab = NULL
static

Definition at line 249 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 247 of file pltcl.c.

Referenced by _PG_init().

◆ pltcl_proc_htab

HTAB* pltcl_proc_htab = NULL
static

Definition at line 250 of file pltcl.c.

Referenced by _PG_init(), and compile_pltcl_function().

◆ pltcl_start_proc

char* pltcl_start_proc = NULL
static

Definition at line 245 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 246 of file pltcl.c.

Referenced by _PG_init(), and call_pltcl_start_proc().

AltStyle によって変換されたページ (->オリジナル) /