Line data Source code
1 : /**********************************************************************
2 : * plperl.c - perl as a procedural language for PostgreSQL
3 : *
4 : * src/pl/plperl/plperl.c
5 : *
6 : **********************************************************************/
7 :
8 : #include "postgres.h"
9 :
10 : /* system stuff */
11 : #include <ctype.h>
12 : #include <fcntl.h>
13 : #include <limits.h>
14 : #include <unistd.h>
15 :
16 : /* postgreSQL stuff */
17 : #include "access/htup_details.h"
18 : #include "access/xact.h"
19 : #include "catalog/pg_language.h"
20 : #include "catalog/pg_proc.h"
21 : #include "catalog/pg_type.h"
22 : #include "commands/event_trigger.h"
23 : #include "commands/trigger.h"
24 : #include "executor/spi.h"
25 : #include "funcapi.h"
26 : #include "miscadmin.h"
27 : #include "parser/parse_type.h"
28 : #include "storage/ipc.h"
29 : #include "tcop/tcopprot.h"
30 : #include "utils/builtins.h"
31 : #include "utils/fmgroids.h"
32 : #include "utils/guc.h"
33 : #include "utils/hsearch.h"
34 : #include "utils/lsyscache.h"
35 : #include "utils/memutils.h"
36 : #include "utils/rel.h"
37 : #include "utils/syscache.h"
38 : #include "utils/tuplestore.h"
39 : #include "utils/typcache.h"
40 :
41 : /* define our text domain for translations */
42 : #undef TEXTDOMAIN
43 : #define TEXTDOMAIN PG_TEXTDOMAIN("plperl")
44 :
45 : /* perl stuff */
46 : /* string literal macros defining chunks of perl code */
47 : #include "perlchunks.h"
48 : #include "plperl.h"
49 : /* defines PLPERL_SET_OPMASK */
50 : #include "plperl_opmask.h"
51 :
52 : EXTERN_C void boot_DynaLoader(pTHX_ CV *cv);
53 : EXTERN_C void boot_PostgreSQL__InServer__Util(pTHX_ CV *cv);
54 : EXTERN_C void boot_PostgreSQL__InServer__SPI(pTHX_ CV *cv);
55 :
56 24 : PG_MODULE_MAGIC_EXT(
57 : .name = "plperl",
58 : .version = PG_VERSION
59 : );
60 :
61 : /**********************************************************************
62 : * Information associated with a Perl interpreter. We have one interpreter
63 : * that is used for all plperlu (untrusted) functions. For plperl (trusted)
64 : * functions, there is a separate interpreter for each effective SQL userid.
65 : * (This is needed to ensure that an unprivileged user can't inject Perl code
66 : * that'll be executed with the privileges of some other SQL user.)
67 : *
68 : * The plperl_interp_desc structs are kept in a Postgres hash table indexed
69 : * by userid OID, with OID 0 used for the single untrusted interpreter.
70 : * Once created, an interpreter is kept for the life of the process.
71 : *
72 : * We start out by creating a "held" interpreter, which we initialize
73 : * only as far as we can do without deciding if it will be trusted or
74 : * untrusted. Later, when we first need to run a plperl or plperlu
75 : * function, we complete the initialization appropriately and move the
76 : * PerlInterpreter pointer into the plperl_interp_hash hashtable. If after
77 : * that we need more interpreters, we create them as needed if we can, or
78 : * fail if the Perl build doesn't support multiple interpreters.
79 : *
80 : * The reason for all the dancing about with a held interpreter is to make
81 : * it possible for people to preload a lot of Perl code at postmaster startup
82 : * (using plperl.on_init) and then use that code in backends. Of course this
83 : * will only work for the first interpreter created in any backend, but it's
84 : * still useful with that restriction.
85 : **********************************************************************/
86 : typedef struct plperl_interp_desc
87 : {
88 : Oid user_id; /* Hash key (must be first!) */
89 : PerlInterpreter *interp; /* The interpreter */
90 : HTAB *query_hash; /* plperl_query_entry structs */
91 : } plperl_interp_desc;
92 :
93 :
94 : /**********************************************************************
95 : * The information we cache about loaded procedures
96 : *
97 : * The fn_refcount field counts the struct's reference from the hash table
98 : * shown below, plus one reference for each function call level that is using
99 : * the struct. We can release the struct, and the associated Perl sub, when
100 : * the fn_refcount goes to zero. Releasing the struct itself is done by
101 : * deleting the fn_cxt, which also gets rid of all subsidiary data.
102 : **********************************************************************/
103 : typedef struct plperl_proc_desc
104 : {
105 : char *proname; /* user name of procedure */
106 : MemoryContext fn_cxt; /* memory context for this procedure */
107 : unsigned long fn_refcount; /* number of active references */
108 : TransactionId fn_xmin; /* xmin/TID of procedure's pg_proc tuple */
109 : ItemPointerData fn_tid;
110 : SV *reference; /* CODE reference for Perl sub */
111 : plperl_interp_desc *interp; /* interpreter it's created in */
112 : bool fn_readonly; /* is function readonly (not volatile)? */
113 : Oid lang_oid;
114 : List *trftypes;
115 : bool lanpltrusted; /* is it plperl, rather than plperlu? */
116 : bool fn_retistuple; /* true, if function returns tuple */
117 : bool fn_retisset; /* true, if function returns set */
118 : bool fn_retisarray; /* true if function returns array */
119 : /* Conversion info for function's result type: */
120 : Oid result_oid; /* Oid of result type */
121 : FmgrInfo result_in_func; /* I/O function and arg for result type */
122 : Oid result_typioparam;
123 : /* Per-argument info for function's argument types: */
124 : int nargs;
125 : FmgrInfo *arg_out_func; /* output fns for arg types */
126 : bool *arg_is_rowtype; /* is each arg composite? */
127 : Oid *arg_arraytype; /* InvalidOid if not an array */
128 : } plperl_proc_desc;
129 :
130 : #define increment_prodesc_refcount(prodesc) \
131 : ((prodesc)->fn_refcount++)
132 : #define decrement_prodesc_refcount(prodesc) \
133 : do { \
134 : Assert((prodesc)->fn_refcount > 0); \
135 : if (--((prodesc)->fn_refcount) == 0) \
136 : free_plperl_function(prodesc); \
137 : } while(0)
138 :
139 : /**********************************************************************
140 : * For speedy lookup, we maintain a hash table mapping from
141 : * function OID + trigger flag + user OID to plperl_proc_desc pointers.
142 : * The reason the plperl_proc_desc struct isn't directly part of the hash
143 : * entry is to simplify recovery from errors during compile_plperl_function.
144 : *
145 : * Note: if the same function is called by multiple userIDs within a session,
146 : * there will be a separate plperl_proc_desc entry for each userID in the case
147 : * of plperl functions, but only one entry for plperlu functions, because we
148 : * set user_id = 0 for that case. If the user redeclares the same function
149 : * from plperl to plperlu or vice versa, there might be multiple
150 : * plperl_proc_ptr entries in the hashtable, but only one is valid.
151 : **********************************************************************/
152 : typedef struct plperl_proc_key
153 : {
154 : Oid proc_id; /* Function OID */
155 :
156 : /*
157 : * is_trigger is really a bool, but declare as Oid to ensure this struct
158 : * contains no padding
159 : */
160 : Oid is_trigger; /* is it a trigger function? */
161 : Oid user_id; /* User calling the function, or 0 */
162 : } plperl_proc_key;
163 :
164 : typedef struct plperl_proc_ptr
165 : {
166 : plperl_proc_key proc_key; /* Hash key (must be first!) */
167 : plperl_proc_desc *proc_ptr;
168 : } plperl_proc_ptr;
169 :
170 : /*
171 : * The information we cache for the duration of a single call to a
172 : * function.
173 : */
174 : typedef struct plperl_call_data
175 : {
176 : plperl_proc_desc *prodesc;
177 : FunctionCallInfo fcinfo;
178 : /* remaining fields are used only in a function returning set: */
179 : Tuplestorestate *tuple_store;
180 : TupleDesc ret_tdesc;
181 : Oid cdomain_oid; /* 0 unless returning domain-over-composite */
182 : void *cdomain_info;
183 : MemoryContext tmp_cxt;
184 : } plperl_call_data;
185 :
186 : /**********************************************************************
187 : * The information we cache about prepared and saved plans
188 : **********************************************************************/
189 : typedef struct plperl_query_desc
190 : {
191 : char qname[24];
192 : MemoryContext plan_cxt; /* context holding this struct */
193 : SPIPlanPtr plan;
194 : int nargs;
195 : Oid *argtypes;
196 : FmgrInfo *arginfuncs;
197 : Oid *argtypioparams;
198 : } plperl_query_desc;
199 :
200 : /* hash table entry for query desc */
201 :
202 : typedef struct plperl_query_entry
203 : {
204 : char query_name[NAMEDATALEN];
205 : plperl_query_desc *query_data;
206 : } plperl_query_entry;
207 :
208 : /**********************************************************************
209 : * Information for PostgreSQL - Perl array conversion.
210 : **********************************************************************/
211 : typedef struct plperl_array_info
212 : {
213 : int ndims;
214 : bool elem_is_rowtype; /* 't' if element type is a rowtype */
215 : Datum *elements;
216 : bool *nulls;
217 : int *nelems;
218 : FmgrInfo proc;
219 : FmgrInfo transform_proc;
220 : } plperl_array_info;
221 :
222 : /**********************************************************************
223 : * Global data
224 : **********************************************************************/
225 :
226 : static HTAB *plperl_interp_hash = NULL;
227 : static HTAB *plperl_proc_hash = NULL;
228 : static plperl_interp_desc *plperl_active_interp = NULL;
229 :
230 : /* If we have an unassigned "held" interpreter, it's stored here */
231 : static PerlInterpreter *plperl_held_interp = NULL;
232 :
233 : /* GUC variables */
234 : static bool plperl_use_strict = false;
235 : static char *plperl_on_init = NULL;
236 : static char *plperl_on_plperl_init = NULL;
237 : static char *plperl_on_plperlu_init = NULL;
238 :
239 : static bool plperl_ending = false;
240 : static OP *(*pp_require_orig) (pTHX) = NULL;
241 : static char plperl_opmask[MAXO];
242 :
243 : /* this is saved and restored by plperl_call_handler */
244 : static plperl_call_data *current_call_data = NULL;
245 :
246 : /**********************************************************************
247 : * Forward declarations
248 : **********************************************************************/
249 :
250 : static PerlInterpreter *plperl_init_interp(void);
251 : static void plperl_destroy_interp(PerlInterpreter **);
252 : static void plperl_fini(int code, Datum arg);
253 : static void set_interp_require(bool trusted);
254 :
255 : static Datum plperl_func_handler(PG_FUNCTION_ARGS);
256 : static Datum plperl_trigger_handler(PG_FUNCTION_ARGS);
257 : static void plperl_event_trigger_handler(PG_FUNCTION_ARGS);
258 :
259 : static void free_plperl_function(plperl_proc_desc *prodesc);
260 :
261 : static plperl_proc_desc *compile_plperl_function(Oid fn_oid,
262 : bool is_trigger,
263 : bool is_event_trigger);
264 :
265 : static SV *plperl_hash_from_tuple(HeapTuple tuple, TupleDesc tupdesc, bool include_generated);
266 : static SV *plperl_hash_from_datum(Datum attr);
267 : static void check_spi_usage_allowed(void);
268 : static SV *plperl_ref_from_pg_array(Datum arg, Oid typid);
269 : static SV *split_array(plperl_array_info *info, int first, int last, int nest);
270 : static SV *make_array_ref(plperl_array_info *info, int first, int last);
271 : static SV *get_perl_array_ref(SV *sv);
272 : static Datum plperl_sv_to_datum(SV *sv, Oid typid, int32 typmod,
273 : FunctionCallInfo fcinfo,
274 : FmgrInfo *finfo, Oid typioparam,
275 : bool *isnull);
276 : static void _sv_to_datum_finfo(Oid typid, FmgrInfo *finfo, Oid *typioparam);
277 : static Datum plperl_array_to_datum(SV *src, Oid typid, int32 typmod);
278 : static void array_to_datum_internal(AV *av, ArrayBuildState **astatep,
279 : int *ndims, int *dims, int cur_depth,
280 : Oid elemtypid, int32 typmod,
281 : FmgrInfo *finfo, Oid typioparam);
282 : static Datum plperl_hash_to_datum(SV *src, TupleDesc td);
283 :
284 : static void plperl_init_shared_libs(pTHX);
285 : static void plperl_trusted_init(void);
286 : static void plperl_untrusted_init(void);
287 : static HV *plperl_spi_execute_fetch_result(SPITupleTable *, uint64, int);
288 : static void plperl_return_next_internal(SV *sv);
289 : static char *hek2cstr(HE *he);
290 : static SV **hv_store_string(HV *hv, const char *key, SV *val);
291 : static SV **hv_fetch_string(HV *hv, const char *key);
292 : static void plperl_create_sub(plperl_proc_desc *desc, const char *s, Oid fn_oid);
293 : static SV *plperl_call_perl_func(plperl_proc_desc *desc,
294 : FunctionCallInfo fcinfo);
295 : static void plperl_compile_callback(void *arg);
296 : static void plperl_exec_callback(void *arg);
297 : static void plperl_inline_callback(void *arg);
298 : static char *strip_trailing_ws(const char *msg);
299 : static OP *pp_require_safe(pTHX);
300 : static void activate_interpreter(plperl_interp_desc *interp_desc);
301 :
302 : #if defined(WIN32) && PERL_VERSION_LT(5, 28, 0)
303 : static char *setlocale_perl(int category, char *locale);
304 : #else
305 : #define setlocale_perl(a,b) Perl_setlocale(a,b)
306 : #endif /* defined(WIN32) && PERL_VERSION_LT(5, 28, 0) */
307 :
308 : /*
309 : * Decrement the refcount of the given SV within the active Perl interpreter
310 : *
311 : * This is handy because it reloads the active-interpreter pointer, saving
312 : * some notation in callers that switch the active interpreter.
313 : */
314 : static inline void
315 316 : SvREFCNT_dec_current(SV *sv)
316 : {
317 316 : dTHX;
318 :
319 316 : SvREFCNT_dec(sv);
320 316 : }
321 :
322 : /*
323 : * convert a HE (hash entry) key to a cstr in the current database encoding
324 : */
325 : static char *
326 205 : hek2cstr(HE *he)
327 : {
328 205 : dTHX;
329 : char *ret;
330 : SV *sv;
331 :
332 : /*
333 : * HeSVKEY_force will return a temporary mortal SV*, so we need to make
334 : * sure to free it with ENTER/SAVE/FREE/LEAVE
335 : */
336 205 : ENTER;
337 205 : SAVETMPS;
338 :
339 : /*-------------------------
340 : * Unfortunately, while HeUTF8 is true for most things > 256, for values
341 : * 128..255 it's not, but perl will treat them as unicode code points if
342 : * the utf8 flag is not set ( see The "Unicode Bug" in perldoc perlunicode
343 : * for more)
344 : *
345 : * So if we did the expected:
346 : * if (HeUTF8(he))
347 : * utf_u2e(key...);
348 : * else // must be ascii
349 : * return HePV(he);
350 : * we won't match columns with codepoints from 128..255
351 : *
352 : * For a more concrete example given a column with the name of the unicode
353 : * codepoint U+00ae (registered sign) and a UTF8 database and the perl
354 : * return_next { "\N{U+00ae}=>'text } would always fail as heUTF8 returns
355 : * 0 and HePV() would give us a char * with 1 byte contains the decimal
356 : * value 174
357 : *
358 : * Perl has the brains to know when it should utf8 encode 174 properly, so
359 : * here we force it into an SV so that perl will figure it out and do the
360 : * right thing
361 : *-------------------------
362 : */
363 :
364 205 : sv = HeSVKEY_force(he);
365 205 : if (HeUTF8(he))
366 0 : SvUTF8_on(sv);
367 205 : ret = sv2cstr(sv);
368 :
369 : /* free sv */
370 205 : FREETMPS;
371 205 : LEAVE;
372 :
373 205 : return ret;
374 : }
375 :
376 :
377 : /*
378 : * _PG_init() - library load-time initialization
379 : *
380 : * DO NOT make this static nor change its name!
381 : */
382 : void
383 24 : _PG_init(void)
384 : {
385 : /*
386 : * Be sure we do initialization only once.
387 : *
388 : * If initialization fails due to, e.g., plperl_init_interp() throwing an
389 : * exception, then we'll return here on the next usage and the user will
390 : * get a rather cryptic: ERROR: attempt to redefine parameter
391 : * "plperl.use_strict"
392 : */
393 : static bool inited = false;
394 : HASHCTL hash_ctl;
395 :
396 24 : if (inited)
397 0 : return;
398 :
399 : /*
400 : * Support localized messages.
401 : */
402 24 : pg_bindtextdomain(TEXTDOMAIN);
403 :
404 : /*
405 : * Initialize plperl's GUCs.
406 : */
407 24 : DefineCustomBoolVariable("plperl.use_strict",
408 : gettext_noop("If true, trusted and untrusted Perl code will be compiled in strict mode."),
409 : NULL,
410 : &plperl_use_strict,
411 : false,
412 : PGC_USERSET, 0,
413 : NULL, NULL, NULL);
414 :
415 : /*
416 : * plperl.on_init is marked PGC_SIGHUP to support the idea that it might
417 : * be executed in the postmaster (if plperl is loaded into the postmaster
418 : * via shared_preload_libraries). This isn't really right either way,
419 : * though.
420 : */
421 24 : DefineCustomStringVariable("plperl.on_init",
422 : gettext_noop("Perl initialization code to execute when a Perl interpreter is initialized."),
423 : NULL,
424 : &plperl_on_init,
425 : NULL,
426 : PGC_SIGHUP, 0,
427 : NULL, NULL, NULL);
428 :
429 : /*
430 : * plperl.on_plperl_init is marked PGC_SUSET to avoid issues whereby a
431 : * user who might not even have USAGE privilege on the plperl language
432 : * could nonetheless use SET plperl.on_plperl_init='...' to influence the
433 : * behaviour of any existing plperl function that they can execute (which
434 : * might be SECURITY DEFINER, leading to a privilege escalation). See
435 : * http://archives.postgresql.org/pgsql-hackers/2010-02/msg00281.php and
436 : * the overall thread.
437 : *
438 : * Note that because plperl.use_strict is USERSET, a nefarious user could
439 : * set it to be applied against other people's functions. This is judged
440 : * OK since the worst result would be an error. Your code oughta pass
441 : * use_strict anyway ;-)
442 : */
443 24 : DefineCustomStringVariable("plperl.on_plperl_init",
444 : gettext_noop("Perl initialization code to execute once when plperl is first used."),
445 : NULL,
446 : &plperl_on_plperl_init,
447 : NULL,
448 : PGC_SUSET, 0,
449 : NULL, NULL, NULL);
450 :
451 24 : DefineCustomStringVariable("plperl.on_plperlu_init",
452 : gettext_noop("Perl initialization code to execute once when plperlu is first used."),
453 : NULL,
454 : &plperl_on_plperlu_init,
455 : NULL,
456 : PGC_SUSET, 0,
457 : NULL, NULL, NULL);
458 :
459 24 : MarkGUCPrefixReserved("plperl");
460 :
461 : /*
462 : * Create hash tables.
463 : */
464 24 : hash_ctl.keysize = sizeof(Oid);
465 24 : hash_ctl.entrysize = sizeof(plperl_interp_desc);
466 24 : plperl_interp_hash = hash_create("PL/Perl interpreters",
467 : 8,
468 : &hash_ctl,
469 : HASH_ELEM | HASH_BLOBS);
470 :
471 24 : hash_ctl.keysize = sizeof(plperl_proc_key);
472 24 : hash_ctl.entrysize = sizeof(plperl_proc_ptr);
473 24 : plperl_proc_hash = hash_create("PL/Perl procedures",
474 : 32,
475 : &hash_ctl,
476 : HASH_ELEM | HASH_BLOBS);
477 :
478 : /*
479 : * Save the default opmask.
480 : */
481 24 : PLPERL_SET_OPMASK(plperl_opmask);
482 :
483 : /*
484 : * Create the first Perl interpreter, but only partially initialize it.
485 : */
486 24 : plperl_held_interp = plperl_init_interp();
487 :
488 24 : inited = true;
489 : }
490 :
491 :
492 : static void
493 49 : set_interp_require(bool trusted)
494 : {
495 49 : if (trusted)
496 : {
497 31 : PL_ppaddr[OP_REQUIRE] = pp_require_safe;
498 31 : PL_ppaddr[OP_DOFILE] = pp_require_safe;
499 : }
500 : else
501 : {
502 18 : PL_ppaddr[OP_REQUIRE] = pp_require_orig;
503 18 : PL_ppaddr[OP_DOFILE] = pp_require_orig;
504 : }
505 49 : }
506 :
507 : /*
508 : * Cleanup perl interpreters, including running END blocks.
509 : * Does not fully undo the actions of _PG_init() nor make it callable again.
510 : */
511 : static void
512 22 : plperl_fini(int code, Datum arg)
513 : {
514 : HASH_SEQ_STATUS hash_seq;
515 : plperl_interp_desc *interp_desc;
516 :
517 22 : elog(DEBUG3, "plperl_fini");
518 :
519 : /*
520 : * Indicate that perl is terminating. Disables use of spi_* functions when
521 : * running END/DESTROY code. See check_spi_usage_allowed(). Could be
522 : * enabled in future, with care, using a transaction
523 : * http://archives.postgresql.org/pgsql-hackers/2010-01/msg02743.php
524 : */
525 22 : plperl_ending = true;
526 :
527 : /* Only perform perl cleanup if we're exiting cleanly */
528 22 : if (code)
529 : {
530 0 : elog(DEBUG3, "plperl_fini: skipped");
531 0 : return;
532 : }
533 :
534 : /* Zap the "held" interpreter, if we still have it */
535 22 : plperl_destroy_interp(&plperl_held_interp);
536 :
537 : /* Zap any fully-initialized interpreters */
538 22 : hash_seq_init(&hash_seq, plperl_interp_hash);
539 67 : while ((interp_desc = hash_seq_search(&hash_seq)) != NULL)
540 : {
541 23 : if (interp_desc->interp)
542 : {
543 23 : activate_interpreter(interp_desc);
544 23 : plperl_destroy_interp(&interp_desc->interp);
545 : }
546 : }
547 :
548 22 : elog(DEBUG3, "plperl_fini: done");
549 : }
550 :
551 :
552 : /*
553 : * Select and activate an appropriate Perl interpreter.
554 : */
555 : static void
556 174 : select_perl_context(bool trusted)
557 : {
558 : Oid user_id;
559 : plperl_interp_desc *interp_desc;
560 : bool found;
561 174 : PerlInterpreter *interp = NULL;
562 :
563 : /* Find or create the interpreter hashtable entry for this userid */
564 174 : if (trusted)
565 149 : user_id = GetUserId();
566 : else
567 25 : user_id = InvalidOid;
568 :
569 174 : interp_desc = hash_search(plperl_interp_hash, &user_id,
570 : HASH_ENTER,
571 : &found);
572 174 : if (!found)
573 : {
574 : /* Initialize newly-created hashtable entry */
575 24 : interp_desc->interp = NULL;
576 24 : interp_desc->query_hash = NULL;
577 : }
578 :
579 : /* Make sure we have a query_hash for this interpreter */
580 174 : if (interp_desc->query_hash == NULL)
581 : {
582 : HASHCTL hash_ctl;
583 :
584 24 : hash_ctl.keysize = NAMEDATALEN;
585 24 : hash_ctl.entrysize = sizeof(plperl_query_entry);
586 24 : interp_desc->query_hash = hash_create("PL/Perl queries",
587 : 32,
588 : &hash_ctl,
589 : HASH_ELEM | HASH_STRINGS);
590 : }
591 :
592 : /*
593 : * Quick exit if already have an interpreter
594 : */
595 174 : if (interp_desc->interp)
596 : {
597 150 : activate_interpreter(interp_desc);
598 150 : return;
599 : }
600 :
601 : /*
602 : * adopt held interp if free, else create new one if possible
603 : */
604 24 : if (plperl_held_interp != NULL)
605 : {
606 : /* first actual use of a perl interpreter */
607 23 : interp = plperl_held_interp;
608 :
609 : /*
610 : * Reset the plperl_held_interp pointer first; if we fail during init
611 : * we don't want to try again with the partially-initialized interp.
612 : */
613 23 : plperl_held_interp = NULL;
614 :
615 23 : if (trusted)
616 19 : plperl_trusted_init();
617 : else
618 4 : plperl_untrusted_init();
619 :
620 : /* successfully initialized, so arrange for cleanup */
621 22 : on_proc_exit(plperl_fini, 0);
622 : }
623 : else
624 : {
625 : #ifdef MULTIPLICITY
626 :
627 : /*
628 : * plperl_init_interp will change Perl's idea of the active
629 : * interpreter. Reset plperl_active_interp temporarily, so that if we
630 : * hit an error partway through here, we'll make sure to switch back
631 : * to a non-broken interpreter before running any other Perl
632 : * functions.
633 : */
634 1 : plperl_active_interp = NULL;
635 :
636 : /* Now build the new interpreter */
637 1 : interp = plperl_init_interp();
638 :
639 1 : if (trusted)
640 0 : plperl_trusted_init();
641 : else
642 1 : plperl_untrusted_init();
643 : #else
644 : ereport(ERROR,
645 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
646 : errmsg("cannot allocate multiple Perl interpreters on this platform")));
647 : #endif
648 : }
649 :
650 23 : set_interp_require(trusted);
651 :
652 : /*
653 : * Since the timing of first use of PL/Perl can't be predicted, any
654 : * database interaction during initialization is problematic. Including,
655 : * but not limited to, security definer issues. So we only enable access
656 : * to the database AFTER on_*_init code has run. See
657 : * http://archives.postgresql.org/pgsql-hackers/2010-01/msg02669.php
658 : */
659 : {
660 23 : dTHX;
661 :
662 23 : newXS("PostgreSQL::InServer::SPI::bootstrap",
663 : boot_PostgreSQL__InServer__SPI, __FILE__);
664 :
665 23 : eval_pv("PostgreSQL::InServer::SPI::bootstrap()", FALSE);
666 23 : if (SvTRUE(ERRSV))
667 0 : ereport(ERROR,
668 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
669 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV))),
670 : errcontext("while executing PostgreSQL::InServer::SPI::bootstrap")));
671 : }
672 :
673 : /* Fully initialized, so mark the hashtable entry valid */
674 23 : interp_desc->interp = interp;
675 :
676 : /* And mark this as the active interpreter */
677 23 : plperl_active_interp = interp_desc;
678 : }
679 :
680 : /*
681 : * Make the specified interpreter the active one
682 : *
683 : * A call with NULL does nothing. This is so that "restoring" to a previously
684 : * null state of plperl_active_interp doesn't result in useless thrashing.
685 : */
686 : static void
687 951 : activate_interpreter(plperl_interp_desc *interp_desc)
688 : {
689 951 : if (interp_desc && plperl_active_interp != interp_desc)
690 : {
691 : Assert(interp_desc->interp);
692 26 : PERL_SET_CONTEXT(interp_desc->interp);
693 : /* trusted iff user_id isn't InvalidOid */
694 26 : set_interp_require(OidIsValid(interp_desc->user_id));
695 26 : plperl_active_interp = interp_desc;
696 : }
697 951 : }
698 :
699 : /*
700 : * Create a new Perl interpreter.
701 : *
702 : * We initialize the interpreter as far as we can without knowing whether
703 : * it will become a trusted or untrusted interpreter; in particular, the
704 : * plperl.on_init code will get executed. Later, either plperl_trusted_init
705 : * or plperl_untrusted_init must be called to complete the initialization.
706 : */
707 : static PerlInterpreter *
708 25 : plperl_init_interp(void)
709 : {
710 : PerlInterpreter *plperl;
711 :
712 : static char *embedding[3 + 2] = {
713 : "", "-e", PLC_PERLBOOT
714 : };
715 25 : int nargs = 3;
716 :
717 : #ifdef WIN32
718 :
719 : /*
720 : * The perl library on startup does horrible things like call
721 : * setlocale(LC_ALL,""). We have protected against that on most platforms
722 : * by setting the environment appropriately. However, on Windows,
723 : * setlocale() does not consult the environment, so we need to save the
724 : * existing locale settings before perl has a chance to mangle them and
725 : * restore them after its dirty deeds are done.
726 : *
727 : * MSDN ref:
728 : * http://msdn.microsoft.com/library/en-us/vclib/html/_crt_locale.asp
729 : *
730 : * It appears that we only need to do this on interpreter startup, and
731 : * subsequent calls to the interpreter don't mess with the locale
732 : * settings.
733 : *
734 : * We restore them using setlocale_perl(), defined below, so that Perl
735 : * doesn't have a different idea of the locale from Postgres.
736 : *
737 : */
738 :
739 : char *loc;
740 : char *save_collate,
741 : *save_ctype,
742 : *save_monetary,
743 : *save_numeric,
744 : *save_time;
745 :
746 : loc = setlocale(LC_COLLATE, NULL);
747 : save_collate = loc ? pstrdup(loc) : NULL;
748 : loc = setlocale(LC_CTYPE, NULL);
749 : save_ctype = loc ? pstrdup(loc) : NULL;
750 : loc = setlocale(LC_MONETARY, NULL);
751 : save_monetary = loc ? pstrdup(loc) : NULL;
752 : loc = setlocale(LC_NUMERIC, NULL);
753 : save_numeric = loc ? pstrdup(loc) : NULL;
754 : loc = setlocale(LC_TIME, NULL);
755 : save_time = loc ? pstrdup(loc) : NULL;
756 :
757 : #define PLPERL_RESTORE_LOCALE(name, saved) \
758 : STMT_START { \
759 : if (saved != NULL) { setlocale_perl(name, saved); pfree(saved); } \
760 : } STMT_END
761 : #endif /* WIN32 */
762 :
763 25 : if (plperl_on_init && *plperl_on_init)
764 : {
765 0 : embedding[nargs++] = "-e";
766 0 : embedding[nargs++] = plperl_on_init;
767 : }
768 :
769 : /*
770 : * The perl API docs state that PERL_SYS_INIT3 should be called before
771 : * allocating interpreters. Unfortunately, on some platforms this fails in
772 : * the Perl_do_taint() routine, which is called when the platform is using
773 : * the system's malloc() instead of perl's own. Other platforms, notably
774 : * Windows, fail if PERL_SYS_INIT3 is not called. So we call it if it's
775 : * available, unless perl is using the system malloc(), which is true when
776 : * MYMALLOC is set.
777 : */
778 : #if defined(PERL_SYS_INIT3) && !defined(MYMALLOC)
779 : {
780 : static int perl_sys_init_done;
781 :
782 : /* only call this the first time through, as per perlembed man page */
783 25 : if (!perl_sys_init_done)
784 : {
785 24 : char *dummy_env[1] = {NULL};
786 :
787 24 : PERL_SYS_INIT3(&nargs, (char ***) &embedding, (char ***) &dummy_env);
788 :
789 : /*
790 : * For unclear reasons, PERL_SYS_INIT3 sets the SIGFPE handler to
791 : * SIG_IGN. Aside from being extremely unfriendly behavior for a
792 : * library, this is dumb on the grounds that the results of a
793 : * SIGFPE in this state are undefined according to POSIX, and in
794 : * fact you get a forced process kill at least on Linux. Hence,
795 : * restore the SIGFPE handler to the backend's standard setting.
796 : * (See Perl bug 114574 for more information.)
797 : */
798 24 : pqsignal(SIGFPE, FloatExceptionHandler);
799 :
800 24 : perl_sys_init_done = 1;
801 : /* quiet warning if PERL_SYS_INIT3 doesn't use the third argument */
802 24 : dummy_env[0] = NULL;
803 : }
804 : }
805 : #endif
806 :
807 25 : plperl = perl_alloc();
808 25 : if (!plperl)
809 0 : elog(ERROR, "could not allocate Perl interpreter");
810 :
811 25 : PERL_SET_CONTEXT(plperl);
812 25 : perl_construct(plperl);
813 :
814 : /*
815 : * Run END blocks in perl_destruct instead of perl_run. Note that dTHX
816 : * loads up a pointer to the current interpreter, so we have to postpone
817 : * it to here rather than put it at the function head.
818 : */
819 : {
820 25 : dTHX;
821 :
822 25 : PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
823 :
824 : /*
825 : * Record the original function for the 'require' and 'dofile'
826 : * opcodes. (They share the same implementation.) Ensure it's used
827 : * for new interpreters.
828 : */
829 25 : if (!pp_require_orig)
830 24 : pp_require_orig = PL_ppaddr[OP_REQUIRE];
831 : else
832 : {
833 1 : PL_ppaddr[OP_REQUIRE] = pp_require_orig;
834 1 : PL_ppaddr[OP_DOFILE] = pp_require_orig;
835 : }
836 :
837 : #ifdef PLPERL_ENABLE_OPMASK_EARLY
838 :
839 : /*
840 : * For regression testing to prove that the PLC_PERLBOOT and
841 : * PLC_TRUSTED code doesn't even compile any unsafe ops. In future
842 : * there may be a valid need for them to do so, in which case this
843 : * could be softened (perhaps moved to plperl_trusted_init()) or
844 : * removed.
845 : */
846 : PL_op_mask = plperl_opmask;
847 : #endif
848 :
849 25 : if (perl_parse(plperl, plperl_init_shared_libs,
850 : nargs, embedding, NULL) != 0)
851 0 : ereport(ERROR,
852 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
853 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV))),
854 : errcontext("while parsing Perl initialization")));
855 :
856 25 : if (perl_run(plperl) != 0)
857 0 : ereport(ERROR,
858 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
859 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV))),
860 : errcontext("while running Perl initialization")));
861 :
862 : #ifdef PLPERL_RESTORE_LOCALE
863 : PLPERL_RESTORE_LOCALE(LC_COLLATE, save_collate);
864 : PLPERL_RESTORE_LOCALE(LC_CTYPE, save_ctype);
865 : PLPERL_RESTORE_LOCALE(LC_MONETARY, save_monetary);
866 : PLPERL_RESTORE_LOCALE(LC_NUMERIC, save_numeric);
867 : PLPERL_RESTORE_LOCALE(LC_TIME, save_time);
868 : #endif
869 : }
870 :
871 25 : return plperl;
872 : }
873 :
874 :
875 : /*
876 : * Our safe implementation of the require opcode.
877 : * This is safe because it's completely unable to load any code.
878 : * If the requested file/module has already been loaded it'll return true.
879 : * If not, it'll die.
880 : * So now "use Foo;" will work iff Foo has already been loaded.
881 : */
882 : static OP *
883 8 : pp_require_safe(pTHX)
884 : {
885 : dVAR;
886 8 : dSP;
887 : SV *sv,
888 : **svp;
889 : char *name;
890 : STRLEN len;
891 :
892 8 : sv = POPs;
893 8 : name = SvPV(sv, len);
894 8 : if (!(name && len > 0 && *name))
895 0 : RETPUSHNO;
896 :
897 8 : svp = hv_fetch(GvHVn(PL_incgv), name, len, 0);
898 8 : if (svp && *svp != &PL_sv_undef)
899 4 : RETPUSHYES;
900 :
901 4 : DIE(aTHX_ "Unable to load %s into plperl", name);
902 :
903 : /*
904 : * In most Perl versions, DIE() expands to a return statement, so the next
905 : * line is not necessary. But in versions between but not including
906 : * 5.11.1 and 5.13.3 it does not, so the next line is necessary to avoid a
907 : * "control reaches end of non-void function" warning from gcc. Other
908 : * compilers such as Solaris Studio will, however, issue a "statement not
909 : * reached" warning instead.
910 : */
911 : return NULL;
912 : }
913 :
914 :
915 : /*
916 : * Destroy one Perl interpreter ... actually we just run END blocks.
917 : *
918 : * Caller must have ensured this interpreter is the active one.
919 : */
920 : static void
921 45 : plperl_destroy_interp(PerlInterpreter **interp)
922 : {
923 45 : if (interp && *interp)
924 : {
925 : /*
926 : * Only a very minimal destruction is performed: - just call END
927 : * blocks.
928 : *
929 : * We could call perl_destruct() but we'd need to audit its actions
930 : * very carefully and work-around any that impact us. (Calling
931 : * sv_clean_objs() isn't an option because it's not part of perl's
932 : * public API so isn't portably available.) Meanwhile END blocks can
933 : * be used to perform manual cleanup.
934 : */
935 23 : dTHX;
936 :
937 : /* Run END blocks - based on perl's perl_destruct() */
938 23 : if (PL_exit_flags & PERL_EXIT_DESTRUCT_END)
939 : {
940 : dJMPENV;
941 23 : int x = 0;
942 :
943 23 : JMPENV_PUSH(x);
944 : PERL_UNUSED_VAR(x);
945 23 : if (PL_endav && !PL_minus_c)
946 0 : call_list(PL_scopestack_ix, PL_endav);
947 23 : JMPENV_POP;
948 : }
949 23 : LEAVE;
950 23 : FREETMPS;
951 :
952 23 : *interp = NULL;
953 : }
954 45 : }
955 :
956 : /*
957 : * Initialize the current Perl interpreter as a trusted interp
958 : */
959 : static void
960 19 : plperl_trusted_init(void)
961 : {
962 19 : dTHX;
963 : HV *stash;
964 : SV *sv;
965 : char *key;
966 : I32 klen;
967 :
968 : /* use original require while we set up */
969 19 : PL_ppaddr[OP_REQUIRE] = pp_require_orig;
970 19 : PL_ppaddr[OP_DOFILE] = pp_require_orig;
971 :
972 19 : eval_pv(PLC_TRUSTED, FALSE);
973 19 : if (SvTRUE(ERRSV))
974 0 : ereport(ERROR,
975 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
976 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV))),
977 : errcontext("while executing PLC_TRUSTED")));
978 :
979 : /*
980 : * Force loading of utf8 module now to prevent errors that can arise from
981 : * the regex code later trying to load utf8 modules. See
982 : * http://rt.perl.org/rt3/Ticket/Display.html?id=47576
983 : */
984 19 : eval_pv("my $a=chr(0x100); return $a =~ /\\xa9/i", FALSE);
985 19 : if (SvTRUE(ERRSV))
986 0 : ereport(ERROR,
987 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
988 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV))),
989 : errcontext("while executing utf8fix")));
990 :
991 : /*
992 : * Lock down the interpreter
993 : */
994 :
995 : /* switch to the safe require/dofile opcode for future code */
996 19 : PL_ppaddr[OP_REQUIRE] = pp_require_safe;
997 19 : PL_ppaddr[OP_DOFILE] = pp_require_safe;
998 :
999 : /*
1000 : * prevent (any more) unsafe opcodes being compiled PL_op_mask is per
1001 : * interpreter, so this only needs to be set once
1002 : */
1003 19 : PL_op_mask = plperl_opmask;
1004 :
1005 : /* delete the DynaLoader:: namespace so extensions can't be loaded */
1006 19 : stash = gv_stashpv("DynaLoader", GV_ADDWARN);
1007 19 : hv_iterinit(stash);
1008 38 : while ((sv = hv_iternextsv(stash, &key, &klen)))
1009 : {
1010 19 : if (!isGV_with_GP(sv) || !GvCV(sv))
1011 0 : continue;
1012 19 : SvREFCNT_dec(GvCV(sv)); /* free the CV */
1013 19 : GvCV_set(sv, NULL); /* prevent call via GV */
1014 : }
1015 19 : hv_clear(stash);
1016 :
1017 : /* invalidate assorted caches */
1018 19 : ++PL_sub_generation;
1019 19 : hv_clear(PL_stashcache);
1020 :
1021 : /*
1022 : * Execute plperl.on_plperl_init in the locked-down interpreter
1023 : */
1024 19 : if (plperl_on_plperl_init && *plperl_on_plperl_init)
1025 : {
1026 2 : eval_pv(plperl_on_plperl_init, FALSE);
1027 : /* XXX need to find a way to determine a better errcode here */
1028 2 : if (SvTRUE(ERRSV))
1029 1 : ereport(ERROR,
1030 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1031 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV))),
1032 : errcontext("while executing plperl.on_plperl_init")));
1033 : }
1034 18 : }
1035 :
1036 :
1037 : /*
1038 : * Initialize the current Perl interpreter as an untrusted interp
1039 : */
1040 : static void
1041 5 : plperl_untrusted_init(void)
1042 : {
1043 5 : dTHX;
1044 :
1045 : /*
1046 : * Nothing to do except execute plperl.on_plperlu_init
1047 : */
1048 5 : if (plperl_on_plperlu_init && *plperl_on_plperlu_init)
1049 : {
1050 1 : eval_pv(plperl_on_plperlu_init, FALSE);
1051 1 : if (SvTRUE(ERRSV))
1052 0 : ereport(ERROR,
1053 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
1054 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV))),
1055 : errcontext("while executing plperl.on_plperlu_init")));
1056 : }
1057 5 : }
1058 :
1059 :
1060 : /*
1061 : * Perl likes to put a newline after its error messages; clean up such
1062 : */
1063 : static char *
1064 27 : strip_trailing_ws(const char *msg)
1065 : {
1066 27 : char *res = pstrdup(msg);
1067 27 : int len = strlen(res);
1068 :
1069 54 : while (len > 0 && isspace((unsigned char) res[len - 1]))
1070 27 : res[--len] = '\0';
1071 27 : return res;
1072 : }
1073 :
1074 :
1075 : /* Build a tuple from a hash. */
1076 :
1077 : static HeapTuple
1078 80 : plperl_build_tuple_result(HV *perlhash, TupleDesc td)
1079 : {
1080 80 : dTHX;
1081 : Datum *values;
1082 : bool *nulls;
1083 : HE *he;
1084 : HeapTuple tup;
1085 :
1086 80 : values = palloc0_array(Datum, td->natts);
1087 80 : nulls = palloc_array(bool, td->natts);
1088 80 : memset(nulls, true, sizeof(bool) * td->natts);
1089 :
1090 80 : hv_iterinit(perlhash);
1091 267 : while ((he = hv_iternext(perlhash)))
1092 : {
1093 189 : SV *val = HeVAL(he);
1094 189 : char *key = hek2cstr(he);
1095 189 : int attn = SPI_fnumber(td, key);
1096 : Form_pg_attribute attr;
1097 :
1098 189 : if (attn == SPI_ERROR_NOATTRIBUTE)
1099 2 : ereport(ERROR,
1100 : (errcode(ERRCODE_UNDEFINED_COLUMN),
1101 : errmsg("Perl hash contains nonexistent column \"%s\"",
1102 : key)));
1103 187 : if (attn <= 0)
1104 0 : ereport(ERROR,
1105 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1106 : errmsg("cannot set system attribute \"%s\"",
1107 : key)));
1108 :
1109 187 : attr = TupleDescAttr(td, attn - 1);
1110 374 : values[attn - 1] = plperl_sv_to_datum(val,
1111 : attr->atttypid,
1112 : attr->atttypmod,
1113 : NULL,
1114 : NULL,
1115 : InvalidOid,
1116 187 : &nulls[attn - 1]);
1117 :
1118 187 : pfree(key);
1119 : }
1120 78 : hv_iterinit(perlhash);
1121 :
1122 78 : tup = heap_form_tuple(td, values, nulls);
1123 78 : pfree(values);
1124 78 : pfree(nulls);
1125 78 : return tup;
1126 : }
1127 :
1128 : /* convert a hash reference to a datum */
1129 : static Datum
1130 41 : plperl_hash_to_datum(SV *src, TupleDesc td)
1131 : {
1132 41 : HeapTuple tup = plperl_build_tuple_result((HV *) SvRV(src), td);
1133 :
1134 40 : return HeapTupleGetDatum(tup);
1135 : }
1136 :
1137 : /*
1138 : * if we are an array ref return the reference. this is special in that if we
1139 : * are a PostgreSQL::InServer::ARRAY object we will return the 'magic' array.
1140 : */
1141 : static SV *
1142 374 : get_perl_array_ref(SV *sv)
1143 : {
1144 374 : dTHX;
1145 :
1146 374 : if (SvOK(sv) && SvROK(sv))
1147 : {
1148 205 : if (SvTYPE(SvRV(sv)) == SVt_PVAV)
1149 152 : return sv;
1150 53 : else if (sv_isa(sv, "PostgreSQL::InServer::ARRAY"))
1151 : {
1152 1 : HV *hv = (HV *) SvRV(sv);
1153 1 : SV **sav = hv_fetch_string(hv, "array");
1154 :
1155 1 : if (*sav && SvOK(*sav) && SvROK(*sav) &&
1156 1 : SvTYPE(SvRV(*sav)) == SVt_PVAV)
1157 1 : return *sav;
1158 :
1159 0 : elog(ERROR, "could not get array reference from PostgreSQL::InServer::ARRAY object");
1160 : }
1161 : }
1162 221 : return NULL;
1163 : }
1164 :
1165 : /*
1166 : * helper function for plperl_array_to_datum, recurses for multi-D arrays
1167 : *
1168 : * The ArrayBuildState is created only when we first find a scalar element;
1169 : * if we didn't do it like that, we'd need some other convention for knowing
1170 : * whether we'd already found any scalars (and thus the number of dimensions
1171 : * is frozen).
1172 : */
1173 : static void
1174 130 : array_to_datum_internal(AV *av, ArrayBuildState **astatep,
1175 : int *ndims, int *dims, int cur_depth,
1176 : Oid elemtypid, int32 typmod,
1177 : FmgrInfo *finfo, Oid typioparam)
1178 : {
1179 130 : dTHX;
1180 : int i;
1181 130 : int len = av_len(av) + 1;
1182 :
1183 375 : for (i = 0; i < len; i++)
1184 : {
1185 : /* fetch the array element */
1186 250 : SV **svp = av_fetch(av, i, FALSE);
1187 :
1188 : /* see if this element is an array, if so get that */
1189 250 : SV *sav = svp ? get_perl_array_ref(*svp) : NULL;
1190 :
1191 : /* multi-dimensional array? */
1192 250 : if (sav)
1193 : {
1194 98 : AV *nav = (AV *) SvRV(sav);
1195 :
1196 : /* set size when at first element in this level, else compare */
1197 98 : if (i == 0 && *ndims == cur_depth)
1198 : {
1199 : /* array after some scalars at same level? */
1200 22 : if (*astatep != NULL)
1201 1 : ereport(ERROR,
1202 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
1203 : errmsg("multidimensional arrays must have array expressions with matching dimensions")));
1204 : /* too many dimensions? */
1205 21 : if (cur_depth + 1 > MAXDIM)
1206 0 : ereport(ERROR,
1207 : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
1208 : errmsg("number of array dimensions exceeds the maximum allowed (%d)",
1209 : MAXDIM)));
1210 : /* OK, add a dimension */
1211 21 : dims[*ndims] = av_len(nav) + 1;
1212 21 : (*ndims)++;
1213 : }
1214 76 : else if (cur_depth >= *ndims ||
1215 75 : av_len(nav) + 1 != dims[cur_depth])
1216 2 : ereport(ERROR,
1217 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
1218 : errmsg("multidimensional arrays must have array expressions with matching dimensions")));
1219 :
1220 : /* recurse to fetch elements of this sub-array */
1221 95 : array_to_datum_internal(nav, astatep,
1222 : ndims, dims, cur_depth + 1,
1223 : elemtypid, typmod,
1224 : finfo, typioparam);
1225 : }
1226 : else
1227 : {
1228 : Datum dat;
1229 : bool isnull;
1230 :
1231 : /* scalar after some sub-arrays at same level? */
1232 152 : if (*ndims != cur_depth)
1233 1 : ereport(ERROR,
1234 : (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
1235 : errmsg("multidimensional arrays must have array expressions with matching dimensions")));
1236 :
1237 151 : dat = plperl_sv_to_datum(svp ? *svp : NULL,
1238 : elemtypid,
1239 : typmod,
1240 : NULL,
1241 : finfo,
1242 : typioparam,
1243 : &isnull);
1244 :
1245 : /* Create ArrayBuildState if we didn't already */
1246 151 : if (*astatep == NULL)
1247 31 : *astatep = initArrayResult(elemtypid,
1248 : CurrentMemoryContext, true);
1249 :
1250 : /* ... and save the element value in it */
1251 151 : (void) accumArrayResult(*astatep, dat, isnull,
1252 : elemtypid, CurrentMemoryContext);
1253 : }
1254 : }
1255 125 : }
1256 :
1257 : /*
1258 : * convert perl array ref to a datum
1259 : */
1260 : static Datum
1261 37 : plperl_array_to_datum(SV *src, Oid typid, int32 typmod)
1262 : {
1263 37 : dTHX;
1264 37 : AV *nav = (AV *) SvRV(src);
1265 37 : ArrayBuildState *astate = NULL;
1266 : Oid elemtypid;
1267 : FmgrInfo finfo;
1268 : Oid typioparam;
1269 : int dims[MAXDIM];
1270 : int lbs[MAXDIM];
1271 37 : int ndims = 1;
1272 : int i;
1273 :
1274 37 : elemtypid = get_element_type(typid);
1275 37 : if (!elemtypid)
1276 2 : ereport(ERROR,
1277 : (errcode(ERRCODE_DATATYPE_MISMATCH),
1278 : errmsg("cannot convert Perl array to non-array type %s",
1279 : format_type_be(typid))));
1280 :
1281 35 : _sv_to_datum_finfo(elemtypid, &finfo, &typioparam);
1282 :
1283 35 : memset(dims, 0, sizeof(dims));
1284 35 : dims[0] = av_len(nav) + 1;
1285 :
1286 35 : array_to_datum_internal(nav, &astate,
1287 : &ndims, dims, 1,
1288 : elemtypid, typmod,
1289 : &finfo, typioparam);
1290 :
1291 : /* ensure we get zero-D array for no inputs, as per PG convention */
1292 31 : if (astate == NULL)
1293 2 : return PointerGetDatum(construct_empty_array(elemtypid));
1294 :
1295 75 : for (i = 0; i < ndims; i++)
1296 46 : lbs[i] = 1;
1297 :
1298 29 : return makeMdArrayResult(astate, ndims, dims, lbs,
1299 : CurrentMemoryContext, true);
1300 : }
1301 :
1302 : /* Get the information needed to convert data to the specified PG type */
1303 : static void
1304 207 : _sv_to_datum_finfo(Oid typid, FmgrInfo *finfo, Oid *typioparam)
1305 : {
1306 : Oid typinput;
1307 :
1308 : /* XXX would be better to cache these lookups */
1309 207 : getTypeInputInfo(typid,
1310 : &typinput, typioparam);
1311 207 : fmgr_info(typinput, finfo);
1312 207 : }
1313 :
1314 : /*
1315 : * convert Perl SV to PG datum of type typid, typmod typmod
1316 : *
1317 : * Pass the PL/Perl function's fcinfo when attempting to convert to the
1318 : * function's result type; otherwise pass NULL. This is used when we need to
1319 : * resolve the actual result type of a function returning RECORD.
1320 : *
1321 : * finfo and typioparam should be the results of _sv_to_datum_finfo for the
1322 : * given typid, or NULL/InvalidOid to let this function do the lookups.
1323 : *
1324 : * *isnull is an output parameter.
1325 : */
1326 : static Datum
1327 650 : plperl_sv_to_datum(SV *sv, Oid typid, int32 typmod,
1328 : FunctionCallInfo fcinfo,
1329 : FmgrInfo *finfo, Oid typioparam,
1330 : bool *isnull)
1331 : {
1332 : FmgrInfo tmp;
1333 : Oid funcid;
1334 :
1335 : /* we might recurse */
1336 650 : check_stack_depth();
1337 :
1338 650 : *isnull = false;
1339 :
1340 : /*
1341 : * Return NULL if result is undef, or if we're in a function returning
1342 : * VOID. In the latter case, we should pay no attention to the last Perl
1343 : * statement's result, and this is a convenient means to ensure that.
1344 : */
1345 650 : if (!sv || !SvOK(sv) || typid == VOIDOID)
1346 : {
1347 : /* look up type info if they did not pass it */
1348 39 : if (!finfo)
1349 : {
1350 5 : _sv_to_datum_finfo(typid, &tmp, &typioparam);
1351 5 : finfo = &tmp;
1352 : }
1353 39 : *isnull = true;
1354 : /* must call typinput in case it wants to reject NULL */
1355 39 : return InputFunctionCall(finfo, NULL, typioparam, typmod);
1356 : }
1357 611 : else if ((funcid = get_transform_tosql(typid, current_call_data->prodesc->lang_oid, current_call_data->prodesc->trftypes)))
1358 78 : return OidFunctionCall1(funcid, PointerGetDatum(sv));
1359 533 : else if (SvROK(sv))
1360 : {
1361 : /* handle references */
1362 82 : SV *sav = get_perl_array_ref(sv);
1363 :
1364 82 : if (sav)
1365 : {
1366 : /* handle an arrayref */
1367 37 : return plperl_array_to_datum(sav, typid, typmod);
1368 : }
1369 45 : else if (SvTYPE(SvRV(sv)) == SVt_PVHV)
1370 : {
1371 : /* handle a hashref */
1372 : Datum ret;
1373 : TupleDesc td;
1374 : bool isdomain;
1375 :
1376 44 : if (!type_is_rowtype(typid))
1377 2 : ereport(ERROR,
1378 : (errcode(ERRCODE_DATATYPE_MISMATCH),
1379 : errmsg("cannot convert Perl hash to non-composite type %s",
1380 : format_type_be(typid))));
1381 :
1382 42 : td = lookup_rowtype_tupdesc_domain(typid, typmod, true);
1383 42 : if (td != NULL)
1384 : {
1385 : /* Did we look through a domain? */
1386 34 : isdomain = (typid != td->tdtypeid);
1387 : }
1388 : else
1389 : {
1390 : /* Must be RECORD, try to resolve based on call info */
1391 : TypeFuncClass funcclass;
1392 :
1393 8 : if (fcinfo)
1394 8 : funcclass = get_call_result_type(fcinfo, &typid, &td);
1395 : else
1396 0 : funcclass = TYPEFUNC_OTHER;
1397 8 : if (funcclass != TYPEFUNC_COMPOSITE &&
1398 : funcclass != TYPEFUNC_COMPOSITE_DOMAIN)
1399 1 : ereport(ERROR,
1400 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1401 : errmsg("function returning record called in context "
1402 : "that cannot accept type record")));
1403 : Assert(td);
1404 7 : isdomain = (funcclass == TYPEFUNC_COMPOSITE_DOMAIN);
1405 : }
1406 :
1407 41 : ret = plperl_hash_to_datum(sv, td);
1408 :
1409 40 : if (isdomain)
1410 4 : domain_check(ret, false, typid, NULL, NULL);
1411 :
1412 : /* Release on the result of get_call_result_type is harmless */
1413 38 : ReleaseTupleDesc(td);
1414 :
1415 38 : return ret;
1416 : }
1417 :
1418 : /*
1419 : * If it's a reference to something else, such as a scalar, just
1420 : * recursively look through the reference.
1421 : */
1422 1 : return plperl_sv_to_datum(SvRV(sv), typid, typmod,
1423 : fcinfo, finfo, typioparam,
1424 : isnull);
1425 : }
1426 : else
1427 : {
1428 : /* handle a string/number */
1429 : Datum ret;
1430 451 : char *str = sv2cstr(sv);
1431 :
1432 : /* did not pass in any typeinfo? look it up */
1433 450 : if (!finfo)
1434 : {
1435 167 : _sv_to_datum_finfo(typid, &tmp, &typioparam);
1436 167 : finfo = &tmp;
1437 : }
1438 :
1439 450 : ret = InputFunctionCall(finfo, str, typioparam, typmod);
1440 449 : pfree(str);
1441 :
1442 449 : return ret;
1443 : }
1444 : }
1445 :
1446 : /* Convert the perl SV to a string returned by the type output function */
1447 : char *
1448 16 : plperl_sv_to_literal(SV *sv, char *fqtypename)
1449 : {
1450 : Oid typid;
1451 : Oid typoutput;
1452 : Datum datum;
1453 : bool typisvarlena,
1454 : isnull;
1455 :
1456 16 : check_spi_usage_allowed();
1457 :
1458 16 : typid = DatumGetObjectId(DirectFunctionCall1(regtypein, CStringGetDatum(fqtypename)));
1459 16 : if (!OidIsValid(typid))
1460 0 : ereport(ERROR,
1461 : (errcode(ERRCODE_UNDEFINED_OBJECT),
1462 : errmsg("lookup failed for type %s", fqtypename)));
1463 :
1464 16 : datum = plperl_sv_to_datum(sv,
1465 : typid, -1,
1466 : NULL, NULL, InvalidOid,
1467 : &isnull);
1468 :
1469 15 : if (isnull)
1470 1 : return NULL;
1471 :
1472 14 : getTypeOutputInfo(typid,
1473 : &typoutput, &typisvarlena);
1474 :
1475 14 : return OidOutputFunctionCall(typoutput, datum);
1476 : }
1477 :
1478 : /*
1479 : * Convert PostgreSQL array datum to a perl array reference.
1480 : *
1481 : * typid is arg's OID, which must be an array type.
1482 : */
1483 : static SV *
1484 17 : plperl_ref_from_pg_array(Datum arg, Oid typid)
1485 : {
1486 17 : dTHX;
1487 17 : ArrayType *ar = DatumGetArrayTypeP(arg);
1488 17 : Oid elementtype = ARR_ELEMTYPE(ar);
1489 : int16 typlen;
1490 : bool typbyval;
1491 : char typalign,
1492 : typdelim;
1493 : Oid typioparam;
1494 : Oid typoutputfunc;
1495 : Oid transform_funcid;
1496 : int i,
1497 : nitems,
1498 : *dims;
1499 : plperl_array_info *info;
1500 : SV *av;
1501 : HV *hv;
1502 :
1503 : /*
1504 : * Currently we make no effort to cache any of the stuff we look up here,
1505 : * which is bad.
1506 : */
1507 17 : info = palloc0_object(plperl_array_info);
1508 :
1509 : /* get element type information, including output conversion function */
1510 17 : get_type_io_data(elementtype, IOFunc_output,
1511 : &typlen, &typbyval, &typalign,
1512 : &typdelim, &typioparam, &typoutputfunc);
1513 :
1514 : /* Check for a transform function */
1515 17 : transform_funcid = get_transform_fromsql(elementtype,
1516 17 : current_call_data->prodesc->lang_oid,
1517 17 : current_call_data->prodesc->trftypes);
1518 :
1519 : /* Look up transform or output function as appropriate */
1520 17 : if (OidIsValid(transform_funcid))
1521 1 : fmgr_info(transform_funcid, &info->transform_proc);
1522 : else
1523 16 : fmgr_info(typoutputfunc, &info->proc);
1524 :
1525 17 : info->elem_is_rowtype = type_is_rowtype(elementtype);
1526 :
1527 : /* Get the number and bounds of array dimensions */
1528 17 : info->ndims = ARR_NDIM(ar);
1529 17 : dims = ARR_DIMS(ar);
1530 :
1531 : /* No dimensions? Return an empty array */
1532 17 : if (info->ndims == 0)
1533 : {
1534 1 : av = newRV_noinc((SV *) newAV());
1535 : }
1536 : else
1537 : {
1538 16 : deconstruct_array(ar, elementtype, typlen, typbyval,
1539 : typalign, &info->elements, &info->nulls,
1540 : &nitems);
1541 :
1542 : /* Get total number of elements in each dimension */
1543 16 : info->nelems = palloc_array(int, info->ndims);
1544 16 : info->nelems[0] = nitems;
1545 28 : for (i = 1; i < info->ndims; i++)
1546 12 : info->nelems[i] = info->nelems[i - 1] / dims[i - 1];
1547 :
1548 16 : av = split_array(info, 0, nitems, 0);
1549 : }
1550 :
1551 17 : hv = newHV();
1552 17 : (void) hv_store(hv, "array", 5, av, 0);
1553 17 : (void) hv_store(hv, "typeoid", 7, newSVuv(typid), 0);
1554 :
1555 17 : return sv_bless(newRV_noinc((SV *) hv),
1556 : gv_stashpv("PostgreSQL::InServer::ARRAY", 0));
1557 : }
1558 :
1559 : /*
1560 : * Recursively form array references from splices of the initial array
1561 : */
1562 : static SV *
1563 96 : split_array(plperl_array_info *info, int first, int last, int nest)
1564 : {
1565 96 : dTHX;
1566 : int i;
1567 : AV *result;
1568 :
1569 : /* we should only be called when we have something to split */
1570 : Assert(info->ndims > 0);
1571 :
1572 : /* since this function recurses, it could be driven to stack overflow */
1573 96 : check_stack_depth();
1574 :
1575 : /*
1576 : * Base case, return a reference to a single-dimensional array
1577 : */
1578 96 : if (nest >= info->ndims - 1)
1579 57 : return make_array_ref(info, first, last);
1580 :
1581 39 : result = newAV();
1582 119 : for (i = first; i < last; i += info->nelems[nest + 1])
1583 : {
1584 : /* Recursively form references to arrays of lower dimensions */
1585 80 : SV *ref = split_array(info, i, i + info->nelems[nest + 1], nest + 1);
1586 :
1587 80 : av_push(result, ref);
1588 : }
1589 39 : return newRV_noinc((SV *) result);
1590 : }
1591 :
1592 : /*
1593 : * Create a Perl reference from a one-dimensional C array, converting
1594 : * composite type elements to hash references.
1595 : */
1596 : static SV *
1597 57 : make_array_ref(plperl_array_info *info, int first, int last)
1598 : {
1599 57 : dTHX;
1600 : int i;
1601 57 : AV *result = newAV();
1602 :
1603 193 : for (i = first; i < last; i++)
1604 : {
1605 136 : if (info->nulls[i])
1606 : {
1607 : /*
1608 : * We can't use &PL_sv_undef here. See "AVs, HVs and undefined
1609 : * values" in perlguts.
1610 : */
1611 4 : av_push(result, newSV(0));
1612 : }
1613 : else
1614 : {
1615 132 : Datum itemvalue = info->elements[i];
1616 :
1617 132 : if (info->transform_proc.fn_oid)
1618 2 : av_push(result, (SV *) DatumGetPointer(FunctionCall1(&info->transform_proc, itemvalue)));
1619 130 : else if (info->elem_is_rowtype)
1620 : /* Handle composite type elements */
1621 4 : av_push(result, plperl_hash_from_datum(itemvalue));
1622 : else
1623 : {
1624 126 : char *val = OutputFunctionCall(&info->proc, itemvalue);
1625 :
1626 126 : av_push(result, cstr2sv(val));
1627 : }
1628 : }
1629 : }
1630 57 : return newRV_noinc((SV *) result);
1631 : }
1632 :
1633 : /* Set up the arguments for a trigger call. */
1634 : static SV *
1635 30 : plperl_trigger_build_args(FunctionCallInfo fcinfo)
1636 : {
1637 30 : dTHX;
1638 : TriggerData *tdata;
1639 : TupleDesc tupdesc;
1640 : int i;
1641 : char *level;
1642 : char *event;
1643 : char *relid;
1644 : char *when;
1645 : HV *hv;
1646 :
1647 30 : hv = newHV();
1648 30 : hv_ksplit(hv, 12); /* pre-grow the hash */
1649 :
1650 30 : tdata = (TriggerData *) fcinfo->context;
1651 30 : tupdesc = tdata->tg_relation->rd_att;
1652 :
1653 30 : relid = DatumGetCString(DirectFunctionCall1(oidout,
1654 : ObjectIdGetDatum(tdata->tg_relation->rd_id)));
1655 :
1656 30 : hv_store_string(hv, "name", cstr2sv(tdata->tg_trigger->tgname));
1657 30 : hv_store_string(hv, "relid", cstr2sv(relid));
1658 :
1659 : /*
1660 : * Note: In BEFORE trigger, stored generated columns are not computed yet,
1661 : * so don't make them accessible in NEW row.
1662 : */
1663 :
1664 30 : if (TRIGGER_FIRED_BY_INSERT(tdata->tg_event))
1665 : {
1666 12 : event = "INSERT";
1667 12 : if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
1668 12 : hv_store_string(hv, "new",
1669 : plperl_hash_from_tuple(tdata->tg_trigtuple,
1670 : tupdesc,
1671 12 : !TRIGGER_FIRED_BEFORE(tdata->tg_event)));
1672 : }
1673 18 : else if (TRIGGER_FIRED_BY_DELETE(tdata->tg_event))
1674 : {
1675 10 : event = "DELETE";
1676 10 : if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
1677 10 : hv_store_string(hv, "old",
1678 : plperl_hash_from_tuple(tdata->tg_trigtuple,
1679 : tupdesc,
1680 : true));
1681 : }
1682 8 : else if (TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))
1683 : {
1684 8 : event = "UPDATE";
1685 8 : if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
1686 : {
1687 7 : hv_store_string(hv, "old",
1688 : plperl_hash_from_tuple(tdata->tg_trigtuple,
1689 : tupdesc,
1690 : true));
1691 7 : hv_store_string(hv, "new",
1692 : plperl_hash_from_tuple(tdata->tg_newtuple,
1693 : tupdesc,
1694 7 : !TRIGGER_FIRED_BEFORE(tdata->tg_event)));
1695 : }
1696 : }
1697 0 : else if (TRIGGER_FIRED_BY_TRUNCATE(tdata->tg_event))
1698 0 : event = "TRUNCATE";
1699 : else
1700 0 : event = "UNKNOWN";
1701 :
1702 30 : hv_store_string(hv, "event", cstr2sv(event));
1703 30 : hv_store_string(hv, "argc", newSViv(tdata->tg_trigger->tgnargs));
1704 :
1705 30 : if (tdata->tg_trigger->tgnargs > 0)
1706 : {
1707 12 : AV *av = newAV();
1708 :
1709 12 : av_extend(av, tdata->tg_trigger->tgnargs);
1710 30 : for (i = 0; i < tdata->tg_trigger->tgnargs; i++)
1711 18 : av_push(av, cstr2sv(tdata->tg_trigger->tgargs[i]));
1712 12 : hv_store_string(hv, "args", newRV_noinc((SV *) av));
1713 : }
1714 :
1715 30 : hv_store_string(hv, "relname",
1716 30 : cstr2sv(SPI_getrelname(tdata->tg_relation)));
1717 :
1718 30 : hv_store_string(hv, "table_name",
1719 30 : cstr2sv(SPI_getrelname(tdata->tg_relation)));
1720 :
1721 30 : hv_store_string(hv, "table_schema",
1722 30 : cstr2sv(SPI_getnspname(tdata->tg_relation)));
1723 :
1724 30 : if (TRIGGER_FIRED_BEFORE(tdata->tg_event))
1725 23 : when = "BEFORE";
1726 7 : else if (TRIGGER_FIRED_AFTER(tdata->tg_event))
1727 4 : when = "AFTER";
1728 3 : else if (TRIGGER_FIRED_INSTEAD(tdata->tg_event))
1729 3 : when = "INSTEAD OF";
1730 : else
1731 0 : when = "UNKNOWN";
1732 30 : hv_store_string(hv, "when", cstr2sv(when));
1733 :
1734 30 : if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
1735 29 : level = "ROW";
1736 1 : else if (TRIGGER_FIRED_FOR_STATEMENT(tdata->tg_event))
1737 1 : level = "STATEMENT";
1738 : else
1739 0 : level = "UNKNOWN";
1740 30 : hv_store_string(hv, "level", cstr2sv(level));
1741 :
1742 30 : return newRV_noinc((SV *) hv);
1743 : }
1744 :
1745 :
1746 : /* Set up the arguments for an event trigger call. */
1747 : static SV *
1748 10 : plperl_event_trigger_build_args(FunctionCallInfo fcinfo)
1749 : {
1750 10 : dTHX;
1751 : EventTriggerData *tdata;
1752 : HV *hv;
1753 :
1754 10 : hv = newHV();
1755 :
1756 10 : tdata = (EventTriggerData *) fcinfo->context;
1757 :
1758 10 : hv_store_string(hv, "event", cstr2sv(tdata->event));
1759 10 : hv_store_string(hv, "tag", cstr2sv(GetCommandTagName(tdata->tag)));
1760 :
1761 10 : return newRV_noinc((SV *) hv);
1762 : }
1763 :
1764 : /* Construct the modified new tuple to be returned from a trigger. */
1765 : static HeapTuple
1766 6 : plperl_modify_tuple(HV *hvTD, TriggerData *tdata, HeapTuple otup)
1767 : {
1768 6 : dTHX;
1769 : SV **svp;
1770 : HV *hvNew;
1771 : HE *he;
1772 : HeapTuple rtup;
1773 : TupleDesc tupdesc;
1774 : int natts;
1775 : Datum *modvalues;
1776 : bool *modnulls;
1777 : bool *modrepls;
1778 :
1779 6 : svp = hv_fetch_string(hvTD, "new");
1780 6 : if (!svp)
1781 0 : ereport(ERROR,
1782 : (errcode(ERRCODE_UNDEFINED_COLUMN),
1783 : errmsg("$_TD->{new} does not exist")));
1784 6 : if (!SvOK(*svp) || !SvROK(*svp) || SvTYPE(SvRV(*svp)) != SVt_PVHV)
1785 0 : ereport(ERROR,
1786 : (errcode(ERRCODE_DATATYPE_MISMATCH),
1787 : errmsg("$_TD->{new} is not a hash reference")));
1788 6 : hvNew = (HV *) SvRV(*svp);
1789 :
1790 6 : tupdesc = tdata->tg_relation->rd_att;
1791 6 : natts = tupdesc->natts;
1792 :
1793 6 : modvalues = (Datum *) palloc0(natts * sizeof(Datum));
1794 6 : modnulls = (bool *) palloc0(natts * sizeof(bool));
1795 6 : modrepls = (bool *) palloc0(natts * sizeof(bool));
1796 :
1797 6 : hv_iterinit(hvNew);
1798 21 : while ((he = hv_iternext(hvNew)))
1799 : {
1800 16 : char *key = hek2cstr(he);
1801 16 : SV *val = HeVAL(he);
1802 16 : int attn = SPI_fnumber(tupdesc, key);
1803 : Form_pg_attribute attr;
1804 :
1805 16 : if (attn == SPI_ERROR_NOATTRIBUTE)
1806 0 : ereport(ERROR,
1807 : (errcode(ERRCODE_UNDEFINED_COLUMN),
1808 : errmsg("Perl hash contains nonexistent column \"%s\"",
1809 : key)));
1810 16 : if (attn <= 0)
1811 0 : ereport(ERROR,
1812 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1813 : errmsg("cannot set system attribute \"%s\"",
1814 : key)));
1815 :
1816 16 : attr = TupleDescAttr(tupdesc, attn - 1);
1817 16 : if (attr->attgenerated)
1818 1 : ereport(ERROR,
1819 : (errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
1820 : errmsg("cannot set generated column \"%s\"",
1821 : key)));
1822 :
1823 30 : modvalues[attn - 1] = plperl_sv_to_datum(val,
1824 : attr->atttypid,
1825 : attr->atttypmod,
1826 : NULL,
1827 : NULL,
1828 : InvalidOid,
1829 15 : &modnulls[attn - 1]);
1830 15 : modrepls[attn - 1] = true;
1831 :
1832 15 : pfree(key);
1833 : }
1834 5 : hv_iterinit(hvNew);
1835 :
1836 5 : rtup = heap_modify_tuple(otup, tupdesc, modvalues, modnulls, modrepls);
1837 :
1838 5 : pfree(modvalues);
1839 5 : pfree(modnulls);
1840 5 : pfree(modrepls);
1841 :
1842 5 : return rtup;
1843 : }
1844 :
1845 :
1846 : /*
1847 : * There are three externally visible pieces to plperl: plperl_call_handler,
1848 : * plperl_inline_handler, and plperl_validator.
1849 : */
1850 :
1851 : /*
1852 : * The call handler is called to run normal functions (including trigger
1853 : * functions) that are defined in pg_proc.
1854 : */
1855 22 : PG_FUNCTION_INFO_V1(plperl_call_handler);
1856 :
1857 : Datum
1858 274 : plperl_call_handler(PG_FUNCTION_ARGS)
1859 : {
1860 274 : Datum retval = (Datum) 0;
1861 274 : plperl_call_data *volatile save_call_data = current_call_data;
1862 274 : plperl_interp_desc *volatile oldinterp = plperl_active_interp;
1863 : plperl_call_data this_call_data;
1864 :
1865 : /* Initialize current-call status record */
1866 2192 : MemSet(&this_call_data, 0, sizeof(this_call_data));
1867 274 : this_call_data.fcinfo = fcinfo;
1868 :
1869 274 : PG_TRY();
1870 : {
1871 274 : current_call_data = &this_call_data;
1872 274 : if (CALLED_AS_TRIGGER(fcinfo))
1873 30 : retval = plperl_trigger_handler(fcinfo);
1874 244 : else if (CALLED_AS_EVENT_TRIGGER(fcinfo))
1875 : {
1876 10 : plperl_event_trigger_handler(fcinfo);
1877 10 : retval = (Datum) 0;
1878 : }
1879 : else
1880 234 : retval = plperl_func_handler(fcinfo);
1881 : }
1882 42 : PG_FINALLY();
1883 : {
1884 274 : current_call_data = save_call_data;
1885 274 : activate_interpreter(oldinterp);
1886 274 : if (this_call_data.prodesc)
1887 273 : decrement_prodesc_refcount(this_call_data.prodesc);
1888 : }
1889 274 : PG_END_TRY();
1890 :
1891 232 : return retval;
1892 : }
1893 :
1894 : /*
1895 : * The inline handler runs anonymous code blocks (DO blocks).
1896 : */
1897 12 : PG_FUNCTION_INFO_V1(plperl_inline_handler);
1898 :
1899 : Datum
1900 22 : plperl_inline_handler(PG_FUNCTION_ARGS)
1901 : {
1902 22 : LOCAL_FCINFO(fake_fcinfo, 0);
1903 22 : InlineCodeBlock *codeblock = (InlineCodeBlock *) PG_GETARG_POINTER(0);
1904 : FmgrInfo flinfo;
1905 : plperl_proc_desc desc;
1906 22 : plperl_call_data *volatile save_call_data = current_call_data;
1907 22 : plperl_interp_desc *volatile oldinterp = plperl_active_interp;
1908 : plperl_call_data this_call_data;
1909 : ErrorContextCallback pl_error_context;
1910 :
1911 : /* Initialize current-call status record */
1912 176 : MemSet(&this_call_data, 0, sizeof(this_call_data));
1913 :
1914 : /* Set up a callback for error reporting */
1915 22 : pl_error_context.callback = plperl_inline_callback;
1916 22 : pl_error_context.previous = error_context_stack;
1917 22 : pl_error_context.arg = NULL;
1918 22 : error_context_stack = &pl_error_context;
1919 :
1920 : /*
1921 : * Set up a fake fcinfo and descriptor with just enough info to satisfy
1922 : * plperl_call_perl_func(). In particular note that this sets things up
1923 : * with no arguments passed, and a result type of VOID.
1924 : */
1925 110 : MemSet(fake_fcinfo, 0, SizeForFunctionCallInfo(0));
1926 154 : MemSet(&flinfo, 0, sizeof(flinfo));
1927 462 : MemSet(&desc, 0, sizeof(desc));
1928 22 : fake_fcinfo->flinfo = &flinfo;
1929 22 : flinfo.fn_oid = InvalidOid;
1930 22 : flinfo.fn_mcxt = CurrentMemoryContext;
1931 :
1932 22 : desc.proname = "inline_code_block";
1933 22 : desc.fn_readonly = false;
1934 :
1935 22 : desc.lang_oid = codeblock->langOid;
1936 22 : desc.trftypes = NIL;
1937 22 : desc.lanpltrusted = codeblock->langIsTrusted;
1938 :
1939 22 : desc.fn_retistuple = false;
1940 22 : desc.fn_retisset = false;
1941 22 : desc.fn_retisarray = false;
1942 22 : desc.result_oid = InvalidOid;
1943 22 : desc.nargs = 0;
1944 22 : desc.reference = NULL;
1945 :
1946 22 : this_call_data.fcinfo = fake_fcinfo;
1947 22 : this_call_data.prodesc = &desc;
1948 : /* we do not bother with refcounting the fake prodesc */
1949 :
1950 22 : PG_TRY();
1951 : {
1952 : SV *perlret;
1953 :
1954 22 : current_call_data = &this_call_data;
1955 :
1956 22 : SPI_connect_ext(codeblock->atomic ? 0 : SPI_OPT_NONATOMIC);
1957 :
1958 22 : select_perl_context(desc.lanpltrusted);
1959 :
1960 21 : plperl_create_sub(&desc, codeblock->source_text, 0);
1961 :
1962 16 : if (!desc.reference) /* can this happen? */
1963 0 : elog(ERROR, "could not create internal procedure for anonymous code block");
1964 :
1965 16 : perlret = plperl_call_perl_func(&desc, fake_fcinfo);
1966 :
1967 11 : SvREFCNT_dec_current(perlret);
1968 :
1969 11 : if (SPI_finish() != SPI_OK_FINISH)
1970 0 : elog(ERROR, "SPI_finish() failed");
1971 : }
1972 11 : PG_FINALLY();
1973 : {
1974 22 : if (desc.reference)
1975 16 : SvREFCNT_dec_current(desc.reference);
1976 22 : current_call_data = save_call_data;
1977 22 : activate_interpreter(oldinterp);
1978 : }
1979 22 : PG_END_TRY();
1980 :
1981 11 : error_context_stack = pl_error_context.previous;
1982 :
1983 11 : PG_RETURN_VOID();
1984 : }
1985 :
1986 : /*
1987 : * The validator is called during CREATE FUNCTION to validate the function
1988 : * being created/replaced. The precise behavior of the validator may be
1989 : * modified by the check_function_bodies GUC.
1990 : */
1991 22 : PG_FUNCTION_INFO_V1(plperl_validator);
1992 :
1993 : Datum
1994 152 : plperl_validator(PG_FUNCTION_ARGS)
1995 : {
1996 152 : Oid funcoid = PG_GETARG_OID(0);
1997 : HeapTuple tuple;
1998 : Form_pg_proc proc;
1999 : char functyptype;
2000 : int numargs;
2001 : Oid *argtypes;
2002 : char **argnames;
2003 : char *argmodes;
2004 152 : bool is_trigger = false;
2005 152 : bool is_event_trigger = false;
2006 : int i;
2007 :
2008 152 : if (!CheckFunctionValidatorAccess(fcinfo->flinfo->fn_oid, funcoid))
2009 0 : PG_RETURN_VOID();
2010 :
2011 : /* Get the new function's pg_proc entry */
2012 152 : tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(funcoid));
2013 152 : if (!HeapTupleIsValid(tuple))
2014 0 : elog(ERROR, "cache lookup failed for function %u", funcoid);
2015 152 : proc = (Form_pg_proc) GETSTRUCT(tuple);
2016 :
2017 152 : functyptype = get_typtype(proc->prorettype);
2018 :
2019 : /* Disallow pseudotype result */
2020 : /* except for TRIGGER, EVTTRIGGER, RECORD, or VOID */
2021 152 : if (functyptype == TYPTYPE_PSEUDO)
2022 : {
2023 38 : if (proc->prorettype == TRIGGEROID)
2024 8 : is_trigger = true;
2025 30 : else if (proc->prorettype == EVENT_TRIGGEROID)
2026 1 : is_event_trigger = true;
2027 29 : else if (proc->prorettype != RECORDOID &&
2028 18 : proc->prorettype != VOIDOID)
2029 0 : ereport(ERROR,
2030 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2031 : errmsg("PL/Perl functions cannot return type %s",
2032 : format_type_be(proc->prorettype))));
2033 : }
2034 :
2035 : /* Disallow pseudotypes in arguments (either IN or OUT) */
2036 152 : numargs = get_func_arg_info(tuple,
2037 : &argtypes, &argnames, &argmodes);
2038 225 : for (i = 0; i < numargs; i++)
2039 : {
2040 73 : if (get_typtype(argtypes[i]) == TYPTYPE_PSEUDO &&
2041 1 : argtypes[i] != RECORDOID)
2042 0 : ereport(ERROR,
2043 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2044 : errmsg("PL/Perl functions cannot accept type %s",
2045 : format_type_be(argtypes[i]))));
2046 : }
2047 :
2048 152 : ReleaseSysCache(tuple);
2049 :
2050 : /* Postpone body checks if !check_function_bodies */
2051 152 : if (check_function_bodies)
2052 : {
2053 152 : (void) compile_plperl_function(funcoid, is_trigger, is_event_trigger);
2054 : }
2055 :
2056 : /* the result of a validator is ignored */
2057 149 : PG_RETURN_VOID();
2058 : }
2059 :
2060 :
2061 : /*
2062 : * plperlu likewise requires three externally visible functions:
2063 : * plperlu_call_handler, plperlu_inline_handler, and plperlu_validator.
2064 : * These are currently just aliases that send control to the plperl
2065 : * handler functions, and we decide whether a particular function is
2066 : * trusted or not by inspecting the actual pg_language tuple.
2067 : */
2068 :
2069 8 : PG_FUNCTION_INFO_V1(plperlu_call_handler);
2070 :
2071 : Datum
2072 50 : plperlu_call_handler(PG_FUNCTION_ARGS)
2073 : {
2074 50 : return plperl_call_handler(fcinfo);
2075 : }
2076 :
2077 5 : PG_FUNCTION_INFO_V1(plperlu_inline_handler);
2078 :
2079 : Datum
2080 1 : plperlu_inline_handler(PG_FUNCTION_ARGS)
2081 : {
2082 1 : return plperl_inline_handler(fcinfo);
2083 : }
2084 :
2085 9 : PG_FUNCTION_INFO_V1(plperlu_validator);
2086 :
2087 : Datum
2088 24 : plperlu_validator(PG_FUNCTION_ARGS)
2089 : {
2090 : /* call plperl validator with our fcinfo so it gets our oid */
2091 24 : return plperl_validator(fcinfo);
2092 : }
2093 :
2094 :
2095 : /*
2096 : * Uses mkfunc to create a subroutine whose text is
2097 : * supplied in s, and returns a reference to it
2098 : */
2099 : static void
2100 173 : plperl_create_sub(plperl_proc_desc *prodesc, const char *s, Oid fn_oid)
2101 : {
2102 173 : dTHX;
2103 173 : dSP;
2104 : char subname[NAMEDATALEN + 40];
2105 173 : HV *pragma_hv = newHV();
2106 173 : SV *subref = NULL;
2107 : int count;
2108 :
2109 173 : sprintf(subname, "%s__%u", prodesc->proname, fn_oid);
2110 :
2111 173 : if (plperl_use_strict)
2112 1 : hv_store_string(pragma_hv, "strict", (SV *) newAV());
2113 :
2114 173 : ENTER;
2115 173 : SAVETMPS;
2116 173 : PUSHMARK(SP);
2117 173 : EXTEND(SP, 4);
2118 173 : PUSHs(sv_2mortal(cstr2sv(subname)));
2119 173 : PUSHs(sv_2mortal(newRV_noinc((SV *) pragma_hv)));
2120 :
2121 : /*
2122 : * Use 'false' for $prolog in mkfunc, which is kept for compatibility in
2123 : * case a module such as PostgreSQL::PLPerl::NYTprof replaces the function
2124 : * compiler.
2125 : */
2126 173 : PUSHs(&PL_sv_no);
2127 173 : PUSHs(sv_2mortal(cstr2sv(s)));
2128 173 : PUTBACK;
2129 :
2130 : /*
2131 : * G_KEEPERR seems to be needed here, else we don't recognize compile
2132 : * errors properly. Perhaps it's because there's another level of eval
2133 : * inside mkfunc?
2134 : */
2135 173 : count = call_pv("PostgreSQL::InServer::mkfunc",
2136 : G_SCALAR | G_EVAL | G_KEEPERR);
2137 173 : SPAGAIN;
2138 :
2139 173 : if (count == 1)
2140 : {
2141 173 : SV *sub_rv = (SV *) POPs;
2142 :
2143 173 : if (sub_rv && SvROK(sub_rv) && SvTYPE(SvRV(sub_rv)) == SVt_PVCV)
2144 : {
2145 165 : subref = newRV_inc(SvRV(sub_rv));
2146 : }
2147 : }
2148 :
2149 173 : PUTBACK;
2150 173 : FREETMPS;
2151 173 : LEAVE;
2152 :
2153 173 : if (SvTRUE(ERRSV))
2154 8 : ereport(ERROR,
2155 : (errcode(ERRCODE_SYNTAX_ERROR),
2156 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV)))));
2157 :
2158 165 : if (!subref)
2159 0 : ereport(ERROR,
2160 : (errcode(ERRCODE_SYNTAX_ERROR),
2161 : errmsg("didn't get a CODE reference from compiling function \"%s\"",
2162 : prodesc->proname)));
2163 :
2164 165 : prodesc->reference = subref;
2165 165 : }
2166 :
2167 :
2168 : /**********************************************************************
2169 : * plperl_init_shared_libs() -
2170 : **********************************************************************/
2171 :
2172 : static void
2173 25 : plperl_init_shared_libs(pTHX)
2174 : {
2175 25 : char *file = __FILE__;
2176 :
2177 25 : newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
2178 25 : newXS("PostgreSQL::InServer::Util::bootstrap",
2179 : boot_PostgreSQL__InServer__Util, file);
2180 : /* newXS for...::SPI::bootstrap is in select_perl_context() */
2181 25 : }
2182 :
2183 :
2184 : static SV *
2185 249 : plperl_call_perl_func(plperl_proc_desc *desc, FunctionCallInfo fcinfo)
2186 : {
2187 249 : dTHX;
2188 249 : dSP;
2189 : SV *retval;
2190 : int i;
2191 : int count;
2192 249 : Oid *argtypes = NULL;
2193 249 : int nargs = 0;
2194 :
2195 249 : ENTER;
2196 249 : SAVETMPS;
2197 :
2198 249 : PUSHMARK(SP);
2199 249 : EXTEND(sp, desc->nargs);
2200 :
2201 : /* Get signature for true functions; inline blocks have no args. */
2202 249 : if (fcinfo->flinfo->fn_oid)
2203 233 : get_func_signature(fcinfo->flinfo->fn_oid, &argtypes, &nargs);
2204 : Assert(nargs == desc->nargs);
2205 :
2206 441 : for (i = 0; i < desc->nargs; i++)
2207 : {
2208 192 : if (fcinfo->args[i].isnull)
2209 4 : PUSHs(&PL_sv_undef);
2210 188 : else if (desc->arg_is_rowtype[i])
2211 : {
2212 11 : SV *sv = plperl_hash_from_datum(fcinfo->args[i].value);
2213 :
2214 11 : PUSHs(sv_2mortal(sv));
2215 : }
2216 : else
2217 : {
2218 : SV *sv;
2219 : Oid funcid;
2220 :
2221 177 : if (OidIsValid(desc->arg_arraytype[i]))
2222 13 : sv = plperl_ref_from_pg_array(fcinfo->args[i].value, desc->arg_arraytype[i]);
2223 164 : else if ((funcid = get_transform_fromsql(argtypes[i], current_call_data->prodesc->lang_oid, current_call_data->prodesc->trftypes)))
2224 57 : sv = (SV *) DatumGetPointer(OidFunctionCall1(funcid, fcinfo->args[i].value));
2225 : else
2226 : {
2227 : char *tmp;
2228 :
2229 107 : tmp = OutputFunctionCall(&(desc->arg_out_func[i]),
2230 : fcinfo->args[i].value);
2231 107 : sv = cstr2sv(tmp);
2232 107 : pfree(tmp);
2233 : }
2234 :
2235 177 : PUSHs(sv_2mortal(sv));
2236 : }
2237 : }
2238 249 : PUTBACK;
2239 :
2240 : /* Do NOT use G_KEEPERR here */
2241 249 : count = call_sv(desc->reference, G_SCALAR | G_EVAL);
2242 :
2243 248 : SPAGAIN;
2244 :
2245 248 : if (count != 1)
2246 : {
2247 0 : PUTBACK;
2248 0 : FREETMPS;
2249 0 : LEAVE;
2250 0 : ereport(ERROR,
2251 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
2252 : errmsg("didn't get a return item from function")));
2253 : }
2254 :
2255 248 : if (SvTRUE(ERRSV))
2256 : {
2257 18 : (void) POPs;
2258 18 : PUTBACK;
2259 18 : FREETMPS;
2260 18 : LEAVE;
2261 : /* XXX need to find a way to determine a better errcode here */
2262 18 : ereport(ERROR,
2263 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
2264 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV)))));
2265 : }
2266 :
2267 230 : retval = newSVsv(POPs);
2268 :
2269 230 : PUTBACK;
2270 230 : FREETMPS;
2271 230 : LEAVE;
2272 :
2273 230 : return retval;
2274 : }
2275 :
2276 :
2277 : static SV *
2278 30 : plperl_call_perl_trigger_func(plperl_proc_desc *desc, FunctionCallInfo fcinfo,
2279 : SV *td)
2280 : {
2281 30 : dTHX;
2282 30 : dSP;
2283 : SV *retval,
2284 : *TDsv;
2285 : int i,
2286 : count;
2287 30 : Trigger *tg_trigger = ((TriggerData *) fcinfo->context)->tg_trigger;
2288 :
2289 30 : ENTER;
2290 30 : SAVETMPS;
2291 :
2292 30 : TDsv = get_sv("main::_TD", 0);
2293 30 : if (!TDsv)
2294 0 : ereport(ERROR,
2295 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
2296 : errmsg("couldn't fetch $_TD")));
2297 :
2298 30 : save_item(TDsv); /* local $_TD */
2299 30 : sv_setsv(TDsv, td);
2300 :
2301 30 : PUSHMARK(sp);
2302 30 : EXTEND(sp, tg_trigger->tgnargs);
2303 :
2304 48 : for (i = 0; i < tg_trigger->tgnargs; i++)
2305 18 : PUSHs(sv_2mortal(cstr2sv(tg_trigger->tgargs[i])));
2306 30 : PUTBACK;
2307 :
2308 : /* Do NOT use G_KEEPERR here */
2309 30 : count = call_sv(desc->reference, G_SCALAR | G_EVAL);
2310 :
2311 30 : SPAGAIN;
2312 :
2313 30 : if (count != 1)
2314 : {
2315 0 : PUTBACK;
2316 0 : FREETMPS;
2317 0 : LEAVE;
2318 0 : ereport(ERROR,
2319 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
2320 : errmsg("didn't get a return item from trigger function")));
2321 : }
2322 :
2323 30 : if (SvTRUE(ERRSV))
2324 : {
2325 0 : (void) POPs;
2326 0 : PUTBACK;
2327 0 : FREETMPS;
2328 0 : LEAVE;
2329 : /* XXX need to find a way to determine a better errcode here */
2330 0 : ereport(ERROR,
2331 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
2332 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV)))));
2333 : }
2334 :
2335 30 : retval = newSVsv(POPs);
2336 :
2337 30 : PUTBACK;
2338 30 : FREETMPS;
2339 30 : LEAVE;
2340 :
2341 30 : return retval;
2342 : }
2343 :
2344 :
2345 : static void
2346 10 : plperl_call_perl_event_trigger_func(plperl_proc_desc *desc,
2347 : FunctionCallInfo fcinfo,
2348 : SV *td)
2349 : {
2350 10 : dTHX;
2351 10 : dSP;
2352 : SV *retval,
2353 : *TDsv;
2354 : int count;
2355 :
2356 10 : ENTER;
2357 10 : SAVETMPS;
2358 :
2359 10 : TDsv = get_sv("main::_TD", 0);
2360 10 : if (!TDsv)
2361 0 : ereport(ERROR,
2362 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
2363 : errmsg("couldn't fetch $_TD")));
2364 :
2365 10 : save_item(TDsv); /* local $_TD */
2366 10 : sv_setsv(TDsv, td);
2367 :
2368 10 : PUSHMARK(sp);
2369 10 : PUTBACK;
2370 :
2371 : /* Do NOT use G_KEEPERR here */
2372 10 : count = call_sv(desc->reference, G_SCALAR | G_EVAL);
2373 :
2374 10 : SPAGAIN;
2375 :
2376 10 : if (count != 1)
2377 : {
2378 0 : PUTBACK;
2379 0 : FREETMPS;
2380 0 : LEAVE;
2381 0 : ereport(ERROR,
2382 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
2383 : errmsg("didn't get a return item from trigger function")));
2384 : }
2385 :
2386 10 : if (SvTRUE(ERRSV))
2387 : {
2388 0 : (void) POPs;
2389 0 : PUTBACK;
2390 0 : FREETMPS;
2391 0 : LEAVE;
2392 : /* XXX need to find a way to determine a better errcode here */
2393 0 : ereport(ERROR,
2394 : (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
2395 : errmsg("%s", strip_trailing_ws(sv2cstr(ERRSV)))));
2396 : }
2397 :
2398 10 : retval = newSVsv(POPs);
2399 : (void) retval; /* silence compiler warning */
2400 :
2401 10 : PUTBACK;
2402 10 : FREETMPS;
2403 10 : LEAVE;
2404 10 : }
2405 :
2406 : static Datum
2407 234 : plperl_func_handler(PG_FUNCTION_ARGS)
2408 : {
2409 : bool nonatomic;
2410 : plperl_proc_desc *prodesc;
2411 : SV *perlret;
2412 234 : Datum retval = 0;
2413 : ReturnSetInfo *rsi;
2414 : ErrorContextCallback pl_error_context;
2415 :
2416 476 : nonatomic = fcinfo->context &&
2417 242 : IsA(fcinfo->context, CallContext) &&
2418 8 : !castNode(CallContext, fcinfo->context)->atomic;
2419 :
2420 234 : SPI_connect_ext(nonatomic ? SPI_OPT_NONATOMIC : 0);
2421 :
2422 234 : prodesc = compile_plperl_function(fcinfo->flinfo->fn_oid, false, false);
2423 233 : current_call_data->prodesc = prodesc;
2424 233 : increment_prodesc_refcount(prodesc);
2425 :
2426 : /* Set a callback for error reporting */
2427 233 : pl_error_context.callback = plperl_exec_callback;
2428 233 : pl_error_context.previous = error_context_stack;
2429 233 : pl_error_context.arg = prodesc->proname;
2430 233 : error_context_stack = &pl_error_context;
2431 :
2432 233 : rsi = (ReturnSetInfo *) fcinfo->resultinfo;
2433 :
2434 233 : if (prodesc->fn_retisset)
2435 : {
2436 : /* Check context before allowing the call to go through */
2437 43 : if (!rsi || !IsA(rsi, ReturnSetInfo))
2438 0 : ereport(ERROR,
2439 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2440 : errmsg("set-valued function called in context that cannot accept a set")));
2441 :
2442 43 : if (!(rsi->allowedModes & SFRM_Materialize))
2443 0 : ereport(ERROR,
2444 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2445 : errmsg("materialize mode required, but it is not allowed in this context")));
2446 : }
2447 :
2448 233 : activate_interpreter(prodesc->interp);
2449 :
2450 233 : perlret = plperl_call_perl_func(prodesc, fcinfo);
2451 :
2452 : /************************************************************
2453 : * Disconnect from SPI manager and then create the return
2454 : * values datum (if the input function does a palloc for it
2455 : * this must not be allocated in the SPI memory context
2456 : * because SPI_finish would free it).
2457 : ************************************************************/
2458 219 : if (SPI_finish() != SPI_OK_FINISH)
2459 0 : elog(ERROR, "SPI_finish() failed");
2460 :
2461 219 : if (prodesc->fn_retisset)
2462 : {
2463 : SV *sav;
2464 :
2465 : /*
2466 : * If the Perl function returned an arrayref, we pretend that it
2467 : * called return_next() for each element of the array, to handle old
2468 : * SRFs that didn't know about return_next(). Any other sort of return
2469 : * value is an error, except undef which means return an empty set.
2470 : */
2471 42 : sav = get_perl_array_ref(perlret);
2472 42 : if (sav)
2473 : {
2474 18 : dTHX;
2475 18 : int i = 0;
2476 18 : SV **svp = 0;
2477 18 : AV *rav = (AV *) SvRV(sav);
2478 :
2479 64 : while ((svp = av_fetch(rav, i, FALSE)) != NULL)
2480 : {
2481 54 : plperl_return_next_internal(*svp);
2482 46 : i++;
2483 : }
2484 : }
2485 24 : else if (SvOK(perlret))
2486 : {
2487 2 : ereport(ERROR,
2488 : (errcode(ERRCODE_DATATYPE_MISMATCH),
2489 : errmsg("set-returning PL/Perl function must return "
2490 : "reference to array or use return_next")));
2491 : }
2492 :
2493 32 : rsi->returnMode = SFRM_Materialize;
2494 32 : if (current_call_data->tuple_store)
2495 : {
2496 26 : rsi->setResult = current_call_data->tuple_store;
2497 26 : rsi->setDesc = current_call_data->ret_tdesc;
2498 : }
2499 32 : retval = (Datum) 0;
2500 : }
2501 177 : else if (prodesc->result_oid)
2502 : {
2503 177 : retval = plperl_sv_to_datum(perlret,
2504 : prodesc->result_oid,
2505 : -1,
2506 : fcinfo,
2507 : &prodesc->result_in_func,
2508 : prodesc->result_typioparam,
2509 : &fcinfo->isnull);
2510 :
2511 161 : if (fcinfo->isnull && rsi && IsA(rsi, ReturnSetInfo))
2512 3 : rsi->isDone = ExprEndResult;
2513 : }
2514 :
2515 : /* Restore the previous error callback */
2516 193 : error_context_stack = pl_error_context.previous;
2517 :
2518 193 : SvREFCNT_dec_current(perlret);
2519 :
2520 193 : return retval;
2521 : }
2522 :
2523 :
2524 : static Datum
2525 30 : plperl_trigger_handler(PG_FUNCTION_ARGS)
2526 : {
2527 : plperl_proc_desc *prodesc;
2528 : SV *perlret;
2529 : Datum retval;
2530 : SV *svTD;
2531 : HV *hvTD;
2532 : ErrorContextCallback pl_error_context;
2533 : TriggerData *tdata;
2534 : int rc PG_USED_FOR_ASSERTS_ONLY;
2535 :
2536 : /* Connect to SPI manager */
2537 30 : SPI_connect();
2538 :
2539 : /* Make transition tables visible to this SPI connection */
2540 30 : tdata = (TriggerData *) fcinfo->context;
2541 30 : rc = SPI_register_trigger_data(tdata);
2542 : Assert(rc >= 0);
2543 :
2544 : /* Find or compile the function */
2545 30 : prodesc = compile_plperl_function(fcinfo->flinfo->fn_oid, true, false);
2546 30 : current_call_data->prodesc = prodesc;
2547 30 : increment_prodesc_refcount(prodesc);
2548 :
2549 : /* Set a callback for error reporting */
2550 30 : pl_error_context.callback = plperl_exec_callback;
2551 30 : pl_error_context.previous = error_context_stack;
2552 30 : pl_error_context.arg = prodesc->proname;
2553 30 : error_context_stack = &pl_error_context;
2554 :
2555 30 : activate_interpreter(prodesc->interp);
2556 :
2557 30 : svTD = plperl_trigger_build_args(fcinfo);
2558 30 : perlret = plperl_call_perl_trigger_func(prodesc, fcinfo, svTD);
2559 30 : hvTD = (HV *) SvRV(svTD);
2560 :
2561 : /************************************************************
2562 : * Disconnect from SPI manager and then create the return
2563 : * values datum (if the input function does a palloc for it
2564 : * this must not be allocated in the SPI memory context
2565 : * because SPI_finish would free it).
2566 : ************************************************************/
2567 30 : if (SPI_finish() != SPI_OK_FINISH)
2568 0 : elog(ERROR, "SPI_finish() failed");
2569 :
2570 30 : if (perlret == NULL || !SvOK(perlret))
2571 21 : {
2572 : /* undef result means go ahead with original tuple */
2573 21 : TriggerData *trigdata = ((TriggerData *) fcinfo->context);
2574 :
2575 21 : if (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event))
2576 7 : retval = PointerGetDatum(trigdata->tg_trigtuple);
2577 14 : else if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))
2578 5 : retval = PointerGetDatum(trigdata->tg_newtuple);
2579 9 : else if (TRIGGER_FIRED_BY_DELETE(trigdata->tg_event))
2580 9 : retval = PointerGetDatum(trigdata->tg_trigtuple);
2581 0 : else if (TRIGGER_FIRED_BY_TRUNCATE(trigdata->tg_event))
2582 0 : retval = PointerGetDatum(trigdata->tg_trigtuple);
2583 : else
2584 0 : retval = (Datum) 0; /* can this happen? */
2585 : }
2586 : else
2587 : {
2588 : HeapTuple trv;
2589 : char *tmp;
2590 :
2591 9 : tmp = sv2cstr(perlret);
2592 :
2593 9 : if (pg_strcasecmp(tmp, "SKIP") == 0)
2594 3 : trv = NULL;
2595 6 : else if (pg_strcasecmp(tmp, "MODIFY") == 0)
2596 : {
2597 6 : TriggerData *trigdata = (TriggerData *) fcinfo->context;
2598 :
2599 6 : if (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event))
2600 4 : trv = plperl_modify_tuple(hvTD, trigdata,
2601 : trigdata->tg_trigtuple);
2602 2 : else if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))
2603 2 : trv = plperl_modify_tuple(hvTD, trigdata,
2604 : trigdata->tg_newtuple);
2605 : else
2606 : {
2607 0 : ereport(WARNING,
2608 : (errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
2609 : errmsg("ignoring modified row in DELETE trigger")));
2610 0 : trv = NULL;
2611 : }
2612 : }
2613 : else
2614 : {
2615 0 : ereport(ERROR,
2616 : (errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
2617 : errmsg("result of PL/Perl trigger function must be undef, "
2618 : "\"SKIP\", or \"MODIFY\"")));
2619 : trv = NULL;
2620 : }
2621 8 : retval = PointerGetDatum(trv);
2622 8 : pfree(tmp);
2623 : }
2624 :
2625 : /* Restore the previous error callback */
2626 29 : error_context_stack = pl_error_context.previous;
2627 :
2628 29 : SvREFCNT_dec_current(svTD);
2629 29 : if (perlret)
2630 29 : SvREFCNT_dec_current(perlret);
2631 :
2632 29 : return retval;
2633 : }
2634 :
2635 :
2636 : static void
2637 10 : plperl_event_trigger_handler(PG_FUNCTION_ARGS)
2638 : {
2639 : plperl_proc_desc *prodesc;
2640 : SV *svTD;
2641 : ErrorContextCallback pl_error_context;
2642 :
2643 : /* Connect to SPI manager */
2644 10 : SPI_connect();
2645 :
2646 : /* Find or compile the function */
2647 10 : prodesc = compile_plperl_function(fcinfo->flinfo->fn_oid, false, true);
2648 10 : current_call_data->prodesc = prodesc;
2649 10 : increment_prodesc_refcount(prodesc);
2650 :
2651 : /* Set a callback for error reporting */
2652 10 : pl_error_context.callback = plperl_exec_callback;
2653 10 : pl_error_context.previous = error_context_stack;
2654 10 : pl_error_context.arg = prodesc->proname;
2655 10 : error_context_stack = &pl_error_context;
2656 :
2657 10 : activate_interpreter(prodesc->interp);
2658 :
2659 10 : svTD = plperl_event_trigger_build_args(fcinfo);
2660 10 : plperl_call_perl_event_trigger_func(prodesc, fcinfo, svTD);
2661 :
2662 10 : if (SPI_finish() != SPI_OK_FINISH)
2663 0 : elog(ERROR, "SPI_finish() failed");
2664 :
2665 : /* Restore the previous error callback */
2666 10 : error_context_stack = pl_error_context.previous;
2667 :
2668 10 : SvREFCNT_dec_current(svTD);
2669 10 : }
2670 :
2671 :
2672 : static bool
2673 629 : validate_plperl_function(plperl_proc_ptr *proc_ptr, HeapTuple procTup)
2674 : {
2675 629 : if (proc_ptr && proc_ptr->proc_ptr)
2676 : {
2677 301 : plperl_proc_desc *prodesc = proc_ptr->proc_ptr;
2678 : bool uptodate;
2679 :
2680 : /************************************************************
2681 : * If it's present, must check whether it's still up to date.
2682 : * This is needed because CREATE OR REPLACE FUNCTION can modify the
2683 : * function's pg_proc entry without changing its OID.
2684 : ************************************************************/
2685 574 : uptodate = (prodesc->fn_xmin == HeapTupleHeaderGetRawXmin(procTup->t_data) &&
2686 273 : ItemPointerEquals(&prodesc->fn_tid, &procTup->t_self));
2687 :
2688 301 : if (uptodate)
2689 273 : return true;
2690 :
2691 : /* Otherwise, unlink the obsoleted entry from the hashtable ... */
2692 28 : proc_ptr->proc_ptr = NULL;
2693 : /* ... and release the corresponding refcount, probably deleting it */
2694 28 : decrement_prodesc_refcount(prodesc);
2695 : }
2696 :
2697 356 : return false;
2698 : }
2699 :
2700 :
2701 : static void
2702 28 : free_plperl_function(plperl_proc_desc *prodesc)
2703 : {
2704 : Assert(prodesc->fn_refcount == 0);
2705 : /* Release CODE reference, if we have one, from the appropriate interp */
2706 28 : if (prodesc->reference)
2707 : {
2708 28 : plperl_interp_desc *oldinterp = plperl_active_interp;
2709 :
2710 28 : activate_interpreter(prodesc->interp);
2711 28 : SvREFCNT_dec_current(prodesc->reference);
2712 28 : activate_interpreter(oldinterp);
2713 : }
2714 : /* Release all PG-owned data for this proc */
2715 28 : MemoryContextDelete(prodesc->fn_cxt);
2716 28 : }
2717 :
2718 :
2719 : static plperl_proc_desc *
2720 426 : compile_plperl_function(Oid fn_oid, bool is_trigger, bool is_event_trigger)
2721 : {
2722 : HeapTuple procTup;
2723 : Form_pg_proc procStruct;
2724 : plperl_proc_key proc_key;
2725 : plperl_proc_ptr *proc_ptr;
2726 426 : plperl_proc_desc *volatile prodesc = NULL;
2727 426 : volatile MemoryContext proc_cxt = NULL;
2728 426 : plperl_interp_desc *oldinterp = plperl_active_interp;
2729 : ErrorContextCallback plperl_error_context;
2730 :
2731 : /* We'll need the pg_proc tuple in any case... */
2732 426 : procTup = SearchSysCache1(PROCOID, ObjectIdGetDatum(fn_oid));
2733 426 : if (!HeapTupleIsValid(procTup))
2734 0 : elog(ERROR, "cache lookup failed for function %u", fn_oid);
2735 426 : procStruct = (Form_pg_proc) GETSTRUCT(procTup);
2736 :
2737 : /*
2738 : * Try to find function in plperl_proc_hash. The reason for this
2739 : * overcomplicated-seeming lookup procedure is that we don't know whether
2740 : * it's plperl or plperlu, and don't want to spend a lookup in pg_language
2741 : * to find out.
2742 : */
2743 426 : proc_key.proc_id = fn_oid;
2744 426 : proc_key.is_trigger = is_trigger;
2745 426 : proc_key.user_id = GetUserId();
2746 426 : proc_ptr = hash_search(plperl_proc_hash, &proc_key,
2747 : HASH_FIND, NULL);
2748 426 : if (validate_plperl_function(proc_ptr, procTup))
2749 : {
2750 : /* Found valid plperl entry */
2751 223 : ReleaseSysCache(procTup);
2752 223 : return proc_ptr->proc_ptr;
2753 : }
2754 :
2755 : /* If not found or obsolete, maybe it's plperlu */
2756 203 : proc_key.user_id = InvalidOid;
2757 203 : proc_ptr = hash_search(plperl_proc_hash, &proc_key,
2758 : HASH_FIND, NULL);
2759 203 : if (validate_plperl_function(proc_ptr, procTup))
2760 : {
2761 : /* Found valid plperlu entry */
2762 50 : ReleaseSysCache(procTup);
2763 50 : return proc_ptr->proc_ptr;
2764 : }
2765 :
2766 : /************************************************************
2767 : * If we haven't found it in the hashtable, we analyze
2768 : * the function's arguments and return type and store
2769 : * the in-/out-functions in the prodesc block,
2770 : * then we load the procedure into the Perl interpreter,
2771 : * and last we create a new hashtable entry for it.
2772 : ************************************************************/
2773 :
2774 : /* Set a callback for reporting compilation errors */
2775 153 : plperl_error_context.callback = plperl_compile_callback;
2776 153 : plperl_error_context.previous = error_context_stack;
2777 153 : plperl_error_context.arg = NameStr(procStruct->proname);
2778 153 : error_context_stack = &plperl_error_context;
2779 :
2780 153 : PG_TRY();
2781 : {
2782 : HeapTuple langTup;
2783 : HeapTuple typeTup;
2784 : Form_pg_language langStruct;
2785 : Form_pg_type typeStruct;
2786 : Datum protrftypes_datum;
2787 : Datum prosrcdatum;
2788 : bool isnull;
2789 : char *proc_source;
2790 : MemoryContext oldcontext;
2791 :
2792 : /************************************************************
2793 : * Allocate a context that will hold all PG data for the procedure.
2794 : ************************************************************/
2795 153 : proc_cxt = AllocSetContextCreate(TopMemoryContext,
2796 : "PL/Perl function",
2797 : ALLOCSET_SMALL_SIZES);
2798 :
2799 : /************************************************************
2800 : * Allocate and fill a new procedure description block.
2801 : * struct prodesc and subsidiary data must all live in proc_cxt.
2802 : ************************************************************/
2803 153 : oldcontext = MemoryContextSwitchTo(proc_cxt);
2804 153 : prodesc = palloc0_object(plperl_proc_desc);
2805 153 : prodesc->proname = pstrdup(NameStr(procStruct->proname));
2806 153 : MemoryContextSetIdentifier(proc_cxt, prodesc->proname);
2807 153 : prodesc->fn_cxt = proc_cxt;
2808 153 : prodesc->fn_refcount = 0;
2809 153 : prodesc->fn_xmin = HeapTupleHeaderGetRawXmin(procTup->t_data);
2810 153 : prodesc->fn_tid = procTup->t_self;
2811 153 : prodesc->nargs = procStruct->pronargs;
2812 153 : prodesc->arg_out_func = (FmgrInfo *) palloc0(prodesc->nargs * sizeof(FmgrInfo));
2813 153 : prodesc->arg_is_rowtype = (bool *) palloc0(prodesc->nargs * sizeof(bool));
2814 153 : prodesc->arg_arraytype = (Oid *) palloc0(prodesc->nargs * sizeof(Oid));
2815 153 : MemoryContextSwitchTo(oldcontext);
2816 :
2817 : /* Remember if function is STABLE/IMMUTABLE */
2818 153 : prodesc->fn_readonly =
2819 153 : (procStruct->provolatile != PROVOLATILE_VOLATILE);
2820 :
2821 : /* Fetch protrftypes */
2822 153 : protrftypes_datum = SysCacheGetAttr(PROCOID, procTup,
2823 : Anum_pg_proc_protrftypes, &isnull);
2824 153 : MemoryContextSwitchTo(proc_cxt);
2825 153 : prodesc->trftypes = isnull ? NIL : oid_array_to_list(protrftypes_datum);
2826 153 : MemoryContextSwitchTo(oldcontext);
2827 :
2828 : /************************************************************
2829 : * Lookup the pg_language tuple by Oid
2830 : ************************************************************/
2831 153 : langTup = SearchSysCache1(LANGOID,
2832 : ObjectIdGetDatum(procStruct->prolang));
2833 153 : if (!HeapTupleIsValid(langTup))
2834 0 : elog(ERROR, "cache lookup failed for language %u",
2835 : procStruct->prolang);
2836 153 : langStruct = (Form_pg_language) GETSTRUCT(langTup);
2837 153 : prodesc->lang_oid = langStruct->oid;
2838 153 : prodesc->lanpltrusted = langStruct->lanpltrusted;
2839 153 : ReleaseSysCache(langTup);
2840 :
2841 : /************************************************************
2842 : * Get the required information for input conversion of the
2843 : * return value.
2844 : ************************************************************/
2845 153 : if (!is_trigger && !is_event_trigger)
2846 : {
2847 144 : Oid rettype = procStruct->prorettype;
2848 :
2849 144 : typeTup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(rettype));
2850 144 : if (!HeapTupleIsValid(typeTup))
2851 0 : elog(ERROR, "cache lookup failed for type %u", rettype);
2852 144 : typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
2853 :
2854 : /* Disallow pseudotype result, except VOID or RECORD */
2855 144 : if (typeStruct->typtype == TYPTYPE_PSEUDO)
2856 : {
2857 30 : if (rettype == VOIDOID ||
2858 : rettype == RECORDOID)
2859 : /* okay */ ;
2860 1 : else if (rettype == TRIGGEROID ||
2861 : rettype == EVENT_TRIGGEROID)
2862 1 : ereport(ERROR,
2863 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2864 : errmsg("trigger functions can only be called "
2865 : "as triggers")));
2866 : else
2867 0 : ereport(ERROR,
2868 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2869 : errmsg("PL/Perl functions cannot return type %s",
2870 : format_type_be(rettype))));
2871 : }
2872 :
2873 143 : prodesc->result_oid = rettype;
2874 143 : prodesc->fn_retisset = procStruct->proretset;
2875 143 : prodesc->fn_retistuple = type_is_rowtype(rettype);
2876 143 : prodesc->fn_retisarray = IsTrueArrayType(typeStruct);
2877 :
2878 143 : fmgr_info_cxt(typeStruct->typinput,
2879 143 : &(prodesc->result_in_func),
2880 : proc_cxt);
2881 143 : prodesc->result_typioparam = getTypeIOParam(typeTup);
2882 :
2883 143 : ReleaseSysCache(typeTup);
2884 : }
2885 :
2886 : /************************************************************
2887 : * Get the required information for output conversion
2888 : * of all procedure arguments
2889 : ************************************************************/
2890 152 : if (!is_trigger && !is_event_trigger)
2891 : {
2892 : int i;
2893 :
2894 208 : for (i = 0; i < prodesc->nargs; i++)
2895 : {
2896 65 : Oid argtype = procStruct->proargtypes.values[i];
2897 :
2898 65 : typeTup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(argtype));
2899 65 : if (!HeapTupleIsValid(typeTup))
2900 0 : elog(ERROR, "cache lookup failed for type %u", argtype);
2901 65 : typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
2902 :
2903 : /* Disallow pseudotype argument, except RECORD */
2904 65 : if (typeStruct->typtype == TYPTYPE_PSEUDO &&
2905 : argtype != RECORDOID)
2906 0 : ereport(ERROR,
2907 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2908 : errmsg("PL/Perl functions cannot accept type %s",
2909 : format_type_be(argtype))));
2910 :
2911 65 : if (type_is_rowtype(argtype))
2912 6 : prodesc->arg_is_rowtype[i] = true;
2913 : else
2914 : {
2915 59 : prodesc->arg_is_rowtype[i] = false;
2916 59 : fmgr_info_cxt(typeStruct->typoutput,
2917 59 : &(prodesc->arg_out_func[i]),
2918 : proc_cxt);
2919 : }
2920 :
2921 : /* Identify array-type arguments */
2922 65 : if (IsTrueArrayType(typeStruct))
2923 7 : prodesc->arg_arraytype[i] = argtype;
2924 : else
2925 58 : prodesc->arg_arraytype[i] = InvalidOid;
2926 :
2927 65 : ReleaseSysCache(typeTup);
2928 : }
2929 : }
2930 :
2931 : /************************************************************
2932 : * create the text of the anonymous subroutine.
2933 : * we do not use a named subroutine so that we can call directly
2934 : * through the reference.
2935 : ************************************************************/
2936 152 : prosrcdatum = SysCacheGetAttrNotNull(PROCOID, procTup,
2937 : Anum_pg_proc_prosrc);
2938 152 : proc_source = TextDatumGetCString(prosrcdatum);
2939 :
2940 : /************************************************************
2941 : * Create the procedure in the appropriate interpreter
2942 : ************************************************************/
2943 :
2944 152 : select_perl_context(prodesc->lanpltrusted);
2945 :
2946 152 : prodesc->interp = plperl_active_interp;
2947 :
2948 152 : plperl_create_sub(prodesc, proc_source, fn_oid);
2949 :
2950 149 : activate_interpreter(oldinterp);
2951 :
2952 149 : pfree(proc_source);
2953 :
2954 149 : if (!prodesc->reference) /* can this happen? */
2955 0 : elog(ERROR, "could not create PL/Perl internal procedure");
2956 :
2957 : /************************************************************
2958 : * OK, link the procedure into the correct hashtable entry.
2959 : * Note we assume that the hashtable entry either doesn't exist yet,
2960 : * or we already cleared its proc_ptr during the validation attempts
2961 : * above. So no need to decrement an old refcount here.
2962 : ************************************************************/
2963 149 : proc_key.user_id = prodesc->lanpltrusted ? GetUserId() : InvalidOid;
2964 :
2965 149 : proc_ptr = hash_search(plperl_proc_hash, &proc_key,
2966 : HASH_ENTER, NULL);
2967 : /* We assume these two steps can't throw an error: */
2968 149 : proc_ptr->proc_ptr = prodesc;
2969 149 : increment_prodesc_refcount(prodesc);
2970 : }
2971 4 : PG_CATCH();
2972 : {
2973 : /*
2974 : * If we got as far as creating a reference, we should be able to use
2975 : * free_plperl_function() to clean up. If not, then at most we have
2976 : * some PG memory resources in proc_cxt, which we can just delete.
2977 : */
2978 4 : if (prodesc && prodesc->reference)
2979 0 : free_plperl_function(prodesc);
2980 4 : else if (proc_cxt)
2981 4 : MemoryContextDelete(proc_cxt);
2982 :
2983 : /* Be sure to restore the previous interpreter, too, for luck */
2984 4 : activate_interpreter(oldinterp);
2985 :
2986 4 : PG_RE_THROW();
2987 : }
2988 149 : PG_END_TRY();
2989 :
2990 : /* restore previous error callback */
2991 149 : error_context_stack = plperl_error_context.previous;
2992 :
2993 149 : ReleaseSysCache(procTup);
2994 :
2995 149 : return prodesc;
2996 : }
2997 :
2998 : /* Build a hash from a given composite/row datum */
2999 : static SV *
3000 57 : plperl_hash_from_datum(Datum attr)
3001 : {
3002 : HeapTupleHeader td;
3003 : Oid tupType;
3004 : int32 tupTypmod;
3005 : TupleDesc tupdesc;
3006 : HeapTupleData tmptup;
3007 : SV *sv;
3008 :
3009 57 : td = DatumGetHeapTupleHeader(attr);
3010 :
3011 : /* Extract rowtype info and find a tupdesc */
3012 57 : tupType = HeapTupleHeaderGetTypeId(td);
3013 57 : tupTypmod = HeapTupleHeaderGetTypMod(td);
3014 57 : tupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod);
3015 :
3016 : /* Build a temporary HeapTuple control structure */
3017 57 : tmptup.t_len = HeapTupleHeaderGetDatumLength(td);
3018 57 : tmptup.t_data = td;
3019 :
3020 57 : sv = plperl_hash_from_tuple(&tmptup, tupdesc, true);
3021 57 : ReleaseTupleDesc(tupdesc);
3022 :
3023 57 : return sv;
3024 : }
3025 :
3026 : /* Build a hash from all attributes of a given tuple. */
3027 : static SV *
3028 192 : plperl_hash_from_tuple(HeapTuple tuple, TupleDesc tupdesc, bool include_generated)
3029 : {
3030 192 : dTHX;
3031 : HV *hv;
3032 : int i;
3033 :
3034 : /* since this function recurses, it could be driven to stack overflow */
3035 192 : check_stack_depth();
3036 :
3037 192 : hv = newHV();
3038 192 : hv_ksplit(hv, tupdesc->natts); /* pre-grow the hash */
3039 :
3040 476 : for (i = 0; i < tupdesc->natts; i++)
3041 : {
3042 : Datum attr;
3043 : bool isnull,
3044 : typisvarlena;
3045 : char *attname;
3046 : Oid typoutput;
3047 284 : Form_pg_attribute att = TupleDescAttr(tupdesc, i);
3048 :
3049 284 : if (att->attisdropped)
3050 19 : continue;
3051 :
3052 284 : if (att->attgenerated)
3053 : {
3054 : /* don't include unless requested */
3055 18 : if (!include_generated)
3056 6 : continue;
3057 : /* never include virtual columns */
3058 12 : if (att->attgenerated == ATTRIBUTE_GENERATED_VIRTUAL)
3059 6 : continue;
3060 : }
3061 :
3062 272 : attname = NameStr(att->attname);
3063 272 : attr = heap_getattr(tuple, i + 1, tupdesc, &isnull);
3064 :
3065 272 : if (isnull)
3066 : {
3067 : /*
3068 : * Store (attname => undef) and move on. Note we can't use
3069 : * &PL_sv_undef here; see "AVs, HVs and undefined values" in
3070 : * perlguts for an explanation.
3071 : */
3072 7 : hv_store_string(hv, attname, newSV(0));
3073 7 : continue;
3074 : }
3075 :
3076 265 : if (type_is_rowtype(att->atttypid))
3077 : {
3078 42 : SV *sv = plperl_hash_from_datum(attr);
3079 :
3080 42 : hv_store_string(hv, attname, sv);
3081 : }
3082 : else
3083 : {
3084 : SV *sv;
3085 : Oid funcid;
3086 :
3087 223 : if (OidIsValid(get_base_element_type(att->atttypid)))
3088 4 : sv = plperl_ref_from_pg_array(attr, att->atttypid);
3089 219 : else if ((funcid = get_transform_fromsql(att->atttypid, current_call_data->prodesc->lang_oid, current_call_data->prodesc->trftypes)))
3090 7 : sv = (SV *) DatumGetPointer(OidFunctionCall1(funcid, attr));
3091 : else
3092 : {
3093 : char *outputstr;
3094 :
3095 : /* XXX should have a way to cache these lookups */
3096 212 : getTypeOutputInfo(att->atttypid, &typoutput, &typisvarlena);
3097 :
3098 212 : outputstr = OidOutputFunctionCall(typoutput, attr);
3099 212 : sv = cstr2sv(outputstr);
3100 212 : pfree(outputstr);
3101 : }
3102 :
3103 223 : hv_store_string(hv, attname, sv);
3104 : }
3105 : }
3106 192 : return newRV_noinc((SV *) hv);
3107 : }
3108 :
3109 :
3110 : static void
3111 326 : check_spi_usage_allowed(void)
3112 : {
3113 : /* see comment in plperl_fini() */
3114 326 : if (plperl_ending)
3115 : {
3116 : /* simple croak as we don't want to involve PostgreSQL code */
3117 0 : croak("SPI functions can not be used in END blocks");
3118 : }
3119 :
3120 : /*
3121 : * Disallow SPI usage if we're not executing a fully-compiled plperl
3122 : * function. It might seem impossible to get here in that case, but there
3123 : * are cases where Perl will try to execute code during compilation. If
3124 : * we proceed we are likely to crash trying to dereference the prodesc
3125 : * pointer. Working around that might be possible, but it seems unwise
3126 : * because it'd allow code execution to happen while validating a
3127 : * function, which is undesirable.
3128 : */
3129 326 : if (current_call_data == NULL || current_call_data->prodesc == NULL)
3130 : {
3131 : /* simple croak as we don't want to involve PostgreSQL code */
3132 0 : croak("SPI functions can not be used during function compilation");
3133 : }
3134 326 : }
3135 :
3136 :
3137 : HV *
3138 57 : plperl_spi_exec(char *query, int limit)
3139 : {
3140 : HV *ret_hv;
3141 :
3142 : /*
3143 : * Execute the query inside a sub-transaction, so we can cope with errors
3144 : * sanely
3145 : */
3146 57 : MemoryContext oldcontext = CurrentMemoryContext;
3147 57 : ResourceOwner oldowner = CurrentResourceOwner;
3148 :
3149 57 : check_spi_usage_allowed();
3150 :
3151 57 : BeginInternalSubTransaction(NULL);
3152 : /* Want to run inside function's memory context */
3153 57 : MemoryContextSwitchTo(oldcontext);
3154 :
3155 57 : PG_TRY();
3156 : {
3157 : int spi_rv;
3158 :
3159 57 : pg_verifymbstr(query, strlen(query), false);
3160 :
3161 57 : spi_rv = SPI_execute(query, current_call_data->prodesc->fn_readonly,
3162 : limit);
3163 51 : ret_hv = plperl_spi_execute_fetch_result(SPI_tuptable, SPI_processed,
3164 : spi_rv);
3165 :
3166 : /* Commit the inner transaction, return to outer xact context */
3167 51 : ReleaseCurrentSubTransaction();
3168 51 : MemoryContextSwitchTo(oldcontext);
3169 51 : CurrentResourceOwner = oldowner;
3170 : }
3171 6 : PG_CATCH();
3172 : {
3173 : ErrorData *edata;
3174 :
3175 : /* Save error info */
3176 6 : MemoryContextSwitchTo(oldcontext);
3177 6 : edata = CopyErrorData();
3178 6 : FlushErrorState();
3179 :
3180 : /* Abort the inner transaction */
3181 6 : RollbackAndReleaseCurrentSubTransaction();
3182 6 : MemoryContextSwitchTo(oldcontext);
3183 6 : CurrentResourceOwner = oldowner;
3184 :
3185 : /* Punt the error to Perl */
3186 6 : croak_cstr(edata->message);
3187 :
3188 : /* Can't get here, but keep compiler quiet */
3189 0 : return NULL;
3190 : }
3191 51 : PG_END_TRY();
3192 :
3193 51 : return ret_hv;
3194 : }
3195 :
3196 :
3197 : static HV *
3198 57 : plperl_spi_execute_fetch_result(SPITupleTable *tuptable, uint64 processed,
3199 : int status)
3200 : {
3201 57 : dTHX;
3202 : HV *result;
3203 :
3204 57 : check_spi_usage_allowed();
3205 :
3206 57 : result = newHV();
3207 :
3208 57 : hv_store_string(result, "status",
3209 : cstr2sv(SPI_result_code_string(status)));
3210 57 : hv_store_string(result, "processed",
3211 : (processed > (uint64) UV_MAX) ?
3212 : newSVnv((NV) processed) :
3213 : newSVuv((UV) processed));
3214 :
3215 57 : if (status > 0 && tuptable)
3216 : {
3217 : AV *rows;
3218 : SV *row;
3219 : uint64 i;
3220 :
3221 : /* Prevent overflow in call to av_extend() */
3222 11 : if (processed > (uint64) AV_SIZE_MAX)
3223 0 : ereport(ERROR,
3224 : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
3225 : errmsg("query result has too many rows to fit in a Perl array")));
3226 :
3227 11 : rows = newAV();
3228 11 : av_extend(rows, processed);
3229 83 : for (i = 0; i < processed; i++)
3230 : {
3231 72 : row = plperl_hash_from_tuple(tuptable->vals[i], tuptable->tupdesc, true);
3232 72 : av_push(rows, row);
3233 : }
3234 11 : hv_store_string(result, "rows",
3235 : newRV_noinc((SV *) rows));
3236 : }
3237 :
3238 57 : SPI_freetuptable(tuptable);
3239 :
3240 57 : return result;
3241 : }
3242 :
3243 :
3244 : /*
3245 : * plperl_return_next catches any error and converts it to a Perl error.
3246 : * We assume (perhaps without adequate justification) that we need not abort
3247 : * the current transaction if the Perl code traps the error.
3248 : */
3249 : void
3250 87 : plperl_return_next(SV *sv)
3251 : {
3252 87 : MemoryContext oldcontext = CurrentMemoryContext;
3253 :
3254 87 : check_spi_usage_allowed();
3255 :
3256 87 : PG_TRY();
3257 : {
3258 87 : plperl_return_next_internal(sv);
3259 : }
3260 0 : PG_CATCH();
3261 : {
3262 : ErrorData *edata;
3263 :
3264 : /* Must reset elog.c's state */
3265 0 : MemoryContextSwitchTo(oldcontext);
3266 0 : edata = CopyErrorData();
3267 0 : FlushErrorState();
3268 :
3269 : /* Punt the error to Perl */
3270 0 : croak_cstr(edata->message);
3271 : }
3272 87 : PG_END_TRY();
3273 87 : }
3274 :
3275 : /*
3276 : * plperl_return_next_internal reports any errors in Postgres fashion
3277 : * (via ereport).
3278 : */
3279 : static void
3280 141 : plperl_return_next_internal(SV *sv)
3281 : {
3282 : plperl_proc_desc *prodesc;
3283 : FunctionCallInfo fcinfo;
3284 : ReturnSetInfo *rsi;
3285 : MemoryContext old_cxt;
3286 :
3287 141 : if (!sv)
3288 0 : return;
3289 :
3290 141 : prodesc = current_call_data->prodesc;
3291 141 : fcinfo = current_call_data->fcinfo;
3292 141 : rsi = (ReturnSetInfo *) fcinfo->resultinfo;
3293 :
3294 141 : if (!prodesc->fn_retisset)
3295 0 : ereport(ERROR,
3296 : (errcode(ERRCODE_SYNTAX_ERROR),
3297 : errmsg("cannot use return_next in a non-SETOF function")));
3298 :
3299 141 : if (!current_call_data->ret_tdesc)
3300 : {
3301 : TupleDesc tupdesc;
3302 :
3303 : Assert(!current_call_data->tuple_store);
3304 :
3305 : /*
3306 : * This is the first call to return_next in the current PL/Perl
3307 : * function call, so identify the output tuple type and create a
3308 : * tuplestore to hold the result rows.
3309 : */
3310 34 : if (prodesc->fn_retistuple)
3311 : {
3312 : TypeFuncClass funcclass;
3313 : Oid typid;
3314 :
3315 17 : funcclass = get_call_result_type(fcinfo, &typid, &tupdesc);
3316 17 : if (funcclass != TYPEFUNC_COMPOSITE &&
3317 : funcclass != TYPEFUNC_COMPOSITE_DOMAIN)
3318 2 : ereport(ERROR,
3319 : (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
3320 : errmsg("function returning record called in context "
3321 : "that cannot accept type record")));
3322 : /* if domain-over-composite, remember the domain's type OID */
3323 15 : if (funcclass == TYPEFUNC_COMPOSITE_DOMAIN)
3324 2 : current_call_data->cdomain_oid = typid;
3325 : }
3326 : else
3327 : {
3328 17 : tupdesc = rsi->expectedDesc;
3329 : /* Protect assumption below that we return exactly one column */
3330 17 : if (tupdesc == NULL || tupdesc->natts != 1)
3331 0 : elog(ERROR, "expected single-column result descriptor for non-composite SETOF result");
3332 : }
3333 :
3334 : /*
3335 : * Make sure the tuple_store and ret_tdesc are sufficiently
3336 : * long-lived.
3337 : */
3338 32 : old_cxt = MemoryContextSwitchTo(rsi->econtext->ecxt_per_query_memory);
3339 :
3340 32 : current_call_data->ret_tdesc = CreateTupleDescCopy(tupdesc);
3341 64 : current_call_data->tuple_store =
3342 32 : tuplestore_begin_heap(rsi->allowedModes & SFRM_Materialize_Random,
3343 : false, work_mem);
3344 :
3345 32 : MemoryContextSwitchTo(old_cxt);
3346 : }
3347 :
3348 : /*
3349 : * Producing the tuple we want to return requires making plenty of
3350 : * palloc() allocations that are not cleaned up. Since this function can
3351 : * be called many times before the current memory context is reset, we
3352 : * need to do those allocations in a temporary context.
3353 : */
3354 139 : if (!current_call_data->tmp_cxt)
3355 : {
3356 32 : current_call_data->tmp_cxt =
3357 32 : AllocSetContextCreate(CurrentMemoryContext,
3358 : "PL/Perl return_next temporary cxt",
3359 : ALLOCSET_DEFAULT_SIZES);
3360 : }
3361 :
3362 139 : old_cxt = MemoryContextSwitchTo(current_call_data->tmp_cxt);
3363 :
3364 139 : if (prodesc->fn_retistuple)
3365 : {
3366 : HeapTuple tuple;
3367 :
3368 43 : if (!(SvOK(sv) && SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVHV))
3369 4 : ereport(ERROR,
3370 : (errcode(ERRCODE_DATATYPE_MISMATCH),
3371 : errmsg("SETOF-composite-returning PL/Perl function "
3372 : "must call return_next with reference to hash")));
3373 :
3374 39 : tuple = plperl_build_tuple_result((HV *) SvRV(sv),
3375 39 : current_call_data->ret_tdesc);
3376 :
3377 38 : if (OidIsValid(current_call_data->cdomain_oid))
3378 4 : domain_check(HeapTupleGetDatum(tuple), false,
3379 4 : current_call_data->cdomain_oid,
3380 4 : ¤t_call_data->cdomain_info,
3381 4 : rsi->econtext->ecxt_per_query_memory);
3382 :
3383 37 : tuplestore_puttuple(current_call_data->tuple_store, tuple);
3384 : }
3385 96 : else if (prodesc->result_oid)
3386 : {
3387 : Datum ret[1];
3388 : bool isNull[1];
3389 :
3390 96 : ret[0] = plperl_sv_to_datum(sv,
3391 : prodesc->result_oid,
3392 : -1,
3393 : fcinfo,
3394 : &prodesc->result_in_func,
3395 : prodesc->result_typioparam,
3396 : &isNull[0]);
3397 :
3398 96 : tuplestore_putvalues(current_call_data->tuple_store,
3399 96 : current_call_data->ret_tdesc,
3400 : ret, isNull);
3401 : }
3402 :
3403 133 : MemoryContextSwitchTo(old_cxt);
3404 133 : MemoryContextReset(current_call_data->tmp_cxt);
3405 : }
3406 :
3407 :
3408 : SV *
3409 9 : plperl_spi_query(char *query)
3410 : {
3411 : SV *cursor;
3412 :
3413 : /*
3414 : * Execute the query inside a sub-transaction, so we can cope with errors
3415 : * sanely
3416 : */
3417 9 : MemoryContext oldcontext = CurrentMemoryContext;
3418 9 : ResourceOwner oldowner = CurrentResourceOwner;
3419 :
3420 9 : check_spi_usage_allowed();
3421 :
3422 9 : BeginInternalSubTransaction(NULL);
3423 : /* Want to run inside function's memory context */
3424 9 : MemoryContextSwitchTo(oldcontext);
3425 :
3426 9 : PG_TRY();
3427 : {
3428 : SPIPlanPtr plan;
3429 : Portal portal;
3430 :
3431 : /* Make sure the query is validly encoded */
3432 9 : pg_verifymbstr(query, strlen(query), false);
3433 :
3434 : /* Create a cursor for the query */
3435 9 : plan = SPI_prepare(query, 0, NULL);
3436 9 : if (plan == NULL)
3437 0 : elog(ERROR, "SPI_prepare() failed:%s",
3438 : SPI_result_code_string(SPI_result));
3439 :
3440 9 : portal = SPI_cursor_open(NULL, plan, NULL, NULL, false);
3441 9 : SPI_freeplan(plan);
3442 9 : if (portal == NULL)
3443 0 : elog(ERROR, "SPI_cursor_open() failed:%s",
3444 : SPI_result_code_string(SPI_result));
3445 9 : cursor = cstr2sv(portal->name);
3446 :
3447 9 : PinPortal(portal);
3448 :
3449 : /* Commit the inner transaction, return to outer xact context */
3450 9 : ReleaseCurrentSubTransaction();
3451 9 : MemoryContextSwitchTo(oldcontext);
3452 9 : CurrentResourceOwner = oldowner;
3453 : }
3454 0 : PG_CATCH();
3455 : {
3456 : ErrorData *edata;
3457 :
3458 : /* Save error info */
3459 0 : MemoryContextSwitchTo(oldcontext);
3460 0 : edata = CopyErrorData();
3461 0 : FlushErrorState();
3462 :
3463 : /* Abort the inner transaction */
3464 0 : RollbackAndReleaseCurrentSubTransaction();
3465 0 : MemoryContextSwitchTo(oldcontext);
3466 0 : CurrentResourceOwner = oldowner;
3467 :
3468 : /* Punt the error to Perl */
3469 0 : croak_cstr(edata->message);
3470 :
3471 : /* Can't get here, but keep compiler quiet */
3472 0 : return NULL;
3473 : }
3474 9 : PG_END_TRY();
3475 :
3476 9 : return cursor;
3477 : }
3478 :
3479 :
3480 : SV *
3481 36 : plperl_spi_fetchrow(char *cursor)
3482 : {
3483 : SV *row;
3484 :
3485 : /*
3486 : * Execute the FETCH inside a sub-transaction, so we can cope with errors
3487 : * sanely
3488 : */
3489 36 : MemoryContext oldcontext = CurrentMemoryContext;
3490 36 : ResourceOwner oldowner = CurrentResourceOwner;
3491 :
3492 36 : check_spi_usage_allowed();
3493 :
3494 36 : BeginInternalSubTransaction(NULL);
3495 : /* Want to run inside function's memory context */
3496 36 : MemoryContextSwitchTo(oldcontext);
3497 :
3498 36 : PG_TRY();
3499 : {
3500 36 : dTHX;
3501 36 : Portal p = SPI_cursor_find(cursor);
3502 :
3503 36 : if (!p)
3504 : {
3505 0 : row = &PL_sv_undef;
3506 : }
3507 : else
3508 : {
3509 36 : SPI_cursor_fetch(p, true, 1);
3510 36 : if (SPI_processed == 0)
3511 : {
3512 9 : UnpinPortal(p);
3513 9 : SPI_cursor_close(p);
3514 9 : row = &PL_sv_undef;
3515 : }
3516 : else
3517 : {
3518 27 : row = plperl_hash_from_tuple(SPI_tuptable->vals[0],
3519 27 : SPI_tuptable->tupdesc,
3520 : true);
3521 : }
3522 36 : SPI_freetuptable(SPI_tuptable);
3523 : }
3524 :
3525 : /* Commit the inner transaction, return to outer xact context */
3526 36 : ReleaseCurrentSubTransaction();
3527 36 : MemoryContextSwitchTo(oldcontext);
3528 36 : CurrentResourceOwner = oldowner;
3529 : }
3530 0 : PG_CATCH();
3531 : {
3532 : ErrorData *edata;
3533 :
3534 : /* Save error info */
3535 0 : MemoryContextSwitchTo(oldcontext);
3536 0 : edata = CopyErrorData();
3537 0 : FlushErrorState();
3538 :
3539 : /* Abort the inner transaction */
3540 0 : RollbackAndReleaseCurrentSubTransaction();
3541 0 : MemoryContextSwitchTo(oldcontext);
3542 0 : CurrentResourceOwner = oldowner;
3543 :
3544 : /* Punt the error to Perl */
3545 0 : croak_cstr(edata->message);
3546 :
3547 : /* Can't get here, but keep compiler quiet */
3548 0 : return NULL;
3549 : }
3550 36 : PG_END_TRY();
3551 :
3552 36 : return row;
3553 : }
3554 :
3555 : void
3556 1 : plperl_spi_cursor_close(char *cursor)
3557 : {
3558 : Portal p;
3559 :
3560 1 : check_spi_usage_allowed();
3561 :
3562 1 : p = SPI_cursor_find(cursor);
3563 :
3564 1 : if (p)
3565 : {
3566 1 : UnpinPortal(p);
3567 1 : SPI_cursor_close(p);
3568 : }
3569 1 : }
3570 :
3571 : SV *
3572 8 : plperl_spi_prepare(char *query, int argc, SV **argv)
3573 : {
3574 8 : volatile SPIPlanPtr plan = NULL;
3575 8 : volatile MemoryContext plan_cxt = NULL;
3576 8 : plperl_query_desc *volatile qdesc = NULL;
3577 8 : plperl_query_entry *volatile hash_entry = NULL;
3578 8 : MemoryContext oldcontext = CurrentMemoryContext;
3579 8 : ResourceOwner oldowner = CurrentResourceOwner;
3580 : MemoryContext work_cxt;
3581 : bool found;
3582 : int i;
3583 :
3584 8 : check_spi_usage_allowed();
3585 :
3586 8 : BeginInternalSubTransaction(NULL);
3587 8 : MemoryContextSwitchTo(oldcontext);
3588 :
3589 8 : PG_TRY();
3590 : {
3591 8 : CHECK_FOR_INTERRUPTS();
3592 :
3593 : /************************************************************
3594 : * Allocate the new querydesc structure
3595 : *
3596 : * The qdesc struct, as well as all its subsidiary data, lives in its
3597 : * plan_cxt. But note that the SPIPlan does not.
3598 : ************************************************************/
3599 8 : plan_cxt = AllocSetContextCreate(TopMemoryContext,
3600 : "PL/Perl spi_prepare query",
3601 : ALLOCSET_SMALL_SIZES);
3602 8 : MemoryContextSwitchTo(plan_cxt);
3603 8 : qdesc = palloc0_object(plperl_query_desc);
3604 8 : snprintf(qdesc->qname, sizeof(qdesc->qname), "%p", qdesc);
3605 8 : qdesc->plan_cxt = plan_cxt;
3606 8 : qdesc->nargs = argc;
3607 8 : qdesc->argtypes = (Oid *) palloc(argc * sizeof(Oid));
3608 8 : qdesc->arginfuncs = (FmgrInfo *) palloc(argc * sizeof(FmgrInfo));
3609 8 : qdesc->argtypioparams = (Oid *) palloc(argc * sizeof(Oid));
3610 8 : MemoryContextSwitchTo(oldcontext);
3611 :
3612 : /************************************************************
3613 : * Do the following work in a short-lived context so that we don't
3614 : * leak a lot of memory in the PL/Perl function's SPI Proc context.
3615 : ************************************************************/
3616 8 : work_cxt = AllocSetContextCreate(CurrentMemoryContext,
3617 : "PL/Perl spi_prepare workspace",
3618 : ALLOCSET_DEFAULT_SIZES);
3619 8 : MemoryContextSwitchTo(work_cxt);
3620 :
3621 : /************************************************************
3622 : * Resolve argument type names and then look them up by oid
3623 : * in the system cache, and remember the required information
3624 : * for input conversion.
3625 : ************************************************************/
3626 15 : for (i = 0; i < argc; i++)
3627 : {
3628 : Oid typId,
3629 : typInput,
3630 : typIOParam;
3631 : int32 typmod;
3632 : char *typstr;
3633 :
3634 8 : typstr = sv2cstr(argv[i]);
3635 8 : (void) parseTypeString(typstr, &typId, &typmod, NULL);
3636 7 : pfree(typstr);
3637 :
3638 7 : getTypeInputInfo(typId, &typInput, &typIOParam);
3639 :
3640 7 : qdesc->argtypes[i] = typId;
3641 7 : fmgr_info_cxt(typInput, &(qdesc->arginfuncs[i]), plan_cxt);
3642 7 : qdesc->argtypioparams[i] = typIOParam;
3643 : }
3644 :
3645 : /* Make sure the query is validly encoded */
3646 7 : pg_verifymbstr(query, strlen(query), false);
3647 :
3648 : /************************************************************
3649 : * Prepare the plan and check for errors
3650 : ************************************************************/
3651 7 : plan = SPI_prepare(query, argc, qdesc->argtypes);
3652 :
3653 7 : if (plan == NULL)
3654 0 : elog(ERROR, "SPI_prepare() failed:%s",
3655 : SPI_result_code_string(SPI_result));
3656 :
3657 : /************************************************************
3658 : * Save the plan into permanent memory (right now it's in the
3659 : * SPI procCxt, which will go away at function end).
3660 : ************************************************************/
3661 7 : if (SPI_keepplan(plan))
3662 0 : elog(ERROR, "SPI_keepplan() failed");
3663 7 : qdesc->plan = plan;
3664 :
3665 : /************************************************************
3666 : * Insert a hashtable entry for the plan.
3667 : ************************************************************/
3668 14 : hash_entry = hash_search(plperl_active_interp->query_hash,
3669 7 : qdesc->qname,
3670 : HASH_ENTER, &found);
3671 7 : hash_entry->query_data = qdesc;
3672 :
3673 : /* Get rid of workspace */
3674 7 : MemoryContextDelete(work_cxt);
3675 :
3676 : /* Commit the inner transaction, return to outer xact context */
3677 7 : ReleaseCurrentSubTransaction();
3678 7 : MemoryContextSwitchTo(oldcontext);
3679 7 : CurrentResourceOwner = oldowner;
3680 : }
3681 1 : PG_CATCH();
3682 : {
3683 : ErrorData *edata;
3684 :
3685 : /* Save error info */
3686 1 : MemoryContextSwitchTo(oldcontext);
3687 1 : edata = CopyErrorData();
3688 1 : FlushErrorState();
3689 :
3690 : /* Drop anything we managed to allocate */
3691 1 : if (hash_entry)
3692 0 : hash_search(plperl_active_interp->query_hash,
3693 0 : qdesc->qname,
3694 : HASH_REMOVE, NULL);
3695 1 : if (plan_cxt)
3696 1 : MemoryContextDelete(plan_cxt);
3697 1 : if (plan)
3698 0 : SPI_freeplan(plan);
3699 :
3700 : /* Abort the inner transaction */
3701 1 : RollbackAndReleaseCurrentSubTransaction();
3702 1 : MemoryContextSwitchTo(oldcontext);
3703 1 : CurrentResourceOwner = oldowner;
3704 :
3705 : /* Punt the error to Perl */
3706 1 : croak_cstr(edata->message);
3707 :
3708 : /* Can't get here, but keep compiler quiet */
3709 0 : return NULL;
3710 : }
3711 7 : PG_END_TRY();
3712 :
3713 : /************************************************************
3714 : * Return the query's hash key to the caller.
3715 : ************************************************************/
3716 7 : return cstr2sv(qdesc->qname);
3717 : }
3718 :
3719 : HV *
3720 6 : plperl_spi_exec_prepared(char *query, HV *attr, int argc, SV **argv)
3721 : {
3722 : HV *ret_hv;
3723 : SV **sv;
3724 : int i,
3725 : limit,
3726 : spi_rv;
3727 : char *nulls;
3728 : Datum *argvalues;
3729 : plperl_query_desc *qdesc;
3730 : plperl_query_entry *hash_entry;
3731 :
3732 : /*
3733 : * Execute the query inside a sub-transaction, so we can cope with errors
3734 : * sanely
3735 : */
3736 6 : MemoryContext oldcontext = CurrentMemoryContext;
3737 6 : ResourceOwner oldowner = CurrentResourceOwner;
3738 :
3739 6 : check_spi_usage_allowed();
3740 :
3741 6 : BeginInternalSubTransaction(NULL);
3742 : /* Want to run inside function's memory context */
3743 6 : MemoryContextSwitchTo(oldcontext);
3744 :
3745 6 : PG_TRY();
3746 : {
3747 6 : dTHX;
3748 :
3749 : /************************************************************
3750 : * Fetch the saved plan descriptor, see if it's o.k.
3751 : ************************************************************/
3752 6 : hash_entry = hash_search(plperl_active_interp->query_hash, query,
3753 : HASH_FIND, NULL);
3754 6 : if (hash_entry == NULL)
3755 0 : elog(ERROR, "spi_exec_prepared: Invalid prepared query passed");
3756 :
3757 6 : qdesc = hash_entry->query_data;
3758 6 : if (qdesc == NULL)
3759 0 : elog(ERROR, "spi_exec_prepared: plperl query_hash value vanished");
3760 :
3761 6 : if (qdesc->nargs != argc)
3762 0 : elog(ERROR, "spi_exec_prepared: expected %d argument(s), %d passed",
3763 : qdesc->nargs, argc);
3764 :
3765 : /************************************************************
3766 : * Parse eventual attributes
3767 : ************************************************************/
3768 6 : limit = 0;
3769 6 : if (attr != NULL)
3770 : {
3771 2 : sv = hv_fetch_string(attr, "limit");
3772 2 : if (sv && *sv && SvIOK(*sv))
3773 0 : limit = SvIV(*sv);
3774 : }
3775 : /************************************************************
3776 : * Set up arguments
3777 : ************************************************************/
3778 6 : if (argc > 0)
3779 : {
3780 4 : nulls = (char *) palloc(argc);
3781 4 : argvalues = (Datum *) palloc(argc * sizeof(Datum));
3782 : }
3783 : else
3784 : {
3785 2 : nulls = NULL;
3786 2 : argvalues = NULL;
3787 : }
3788 :
3789 10 : for (i = 0; i < argc; i++)
3790 : {
3791 : bool isnull;
3792 :
3793 8 : argvalues[i] = plperl_sv_to_datum(argv[i],
3794 4 : qdesc->argtypes[i],
3795 : -1,
3796 : NULL,
3797 4 : &qdesc->arginfuncs[i],
3798 4 : qdesc->argtypioparams[i],
3799 : &isnull);
3800 4 : nulls[i] = isnull ? 'n' : ' ';
3801 : }
3802 :
3803 : /************************************************************
3804 : * go
3805 : ************************************************************/
3806 12 : spi_rv = SPI_execute_plan(qdesc->plan, argvalues, nulls,
3807 6 : current_call_data->prodesc->fn_readonly, limit);
3808 6 : ret_hv = plperl_spi_execute_fetch_result(SPI_tuptable, SPI_processed,
3809 : spi_rv);
3810 6 : if (argc > 0)
3811 : {
3812 4 : pfree(argvalues);
3813 4 : pfree(nulls);
3814 : }
3815 :
3816 : /* Commit the inner transaction, return to outer xact context */
3817 6 : ReleaseCurrentSubTransaction();
3818 6 : MemoryContextSwitchTo(oldcontext);
3819 6 : CurrentResourceOwner = oldowner;
3820 : }
3821 0 : PG_CATCH();
3822 : {
3823 : ErrorData *edata;
3824 :
3825 : /* Save error info */
3826 0 : MemoryContextSwitchTo(oldcontext);
3827 0 : edata = CopyErrorData();
3828 0 : FlushErrorState();
3829 :
3830 : /* Abort the inner transaction */
3831 0 : RollbackAndReleaseCurrentSubTransaction();
3832 0 : MemoryContextSwitchTo(oldcontext);
3833 0 : CurrentResourceOwner = oldowner;
3834 :
3835 : /* Punt the error to Perl */
3836 0 : croak_cstr(edata->message);
3837 :
3838 : /* Can't get here, but keep compiler quiet */
3839 0 : return NULL;
3840 : }
3841 6 : PG_END_TRY();
3842 :
3843 6 : return ret_hv;
3844 : }
3845 :
3846 : SV *
3847 2 : plperl_spi_query_prepared(char *query, int argc, SV **argv)
3848 : {
3849 : int i;
3850 : char *nulls;
3851 : Datum *argvalues;
3852 : plperl_query_desc *qdesc;
3853 : plperl_query_entry *hash_entry;
3854 : SV *cursor;
3855 2 : Portal portal = NULL;
3856 :
3857 : /*
3858 : * Execute the query inside a sub-transaction, so we can cope with errors
3859 : * sanely
3860 : */
3861 2 : MemoryContext oldcontext = CurrentMemoryContext;
3862 2 : ResourceOwner oldowner = CurrentResourceOwner;
3863 :
3864 2 : check_spi_usage_allowed();
3865 :
3866 2 : BeginInternalSubTransaction(NULL);
3867 : /* Want to run inside function's memory context */
3868 2 : MemoryContextSwitchTo(oldcontext);
3869 :
3870 2 : PG_TRY();
3871 : {
3872 : /************************************************************
3873 : * Fetch the saved plan descriptor, see if it's o.k.
3874 : ************************************************************/
3875 2 : hash_entry = hash_search(plperl_active_interp->query_hash, query,
3876 : HASH_FIND, NULL);
3877 2 : if (hash_entry == NULL)
3878 0 : elog(ERROR, "spi_query_prepared: Invalid prepared query passed");
3879 :
3880 2 : qdesc = hash_entry->query_data;
3881 2 : if (qdesc == NULL)
3882 0 : elog(ERROR, "spi_query_prepared: plperl query_hash value vanished");
3883 :
3884 2 : if (qdesc->nargs != argc)
3885 0 : elog(ERROR, "spi_query_prepared: expected %d argument(s), %d passed",
3886 : qdesc->nargs, argc);
3887 :
3888 : /************************************************************
3889 : * Set up arguments
3890 : ************************************************************/
3891 2 : if (argc > 0)
3892 : {
3893 2 : nulls = (char *) palloc(argc);
3894 2 : argvalues = (Datum *) palloc(argc * sizeof(Datum));
3895 : }
3896 : else
3897 : {
3898 0 : nulls = NULL;
3899 0 : argvalues = NULL;
3900 : }
3901 :
3902 5 : for (i = 0; i < argc; i++)
3903 : {
3904 : bool isnull;
3905 :
3906 6 : argvalues[i] = plperl_sv_to_datum(argv[i],
3907 3 : qdesc->argtypes[i],
3908 : -1,
3909 : NULL,
3910 3 : &qdesc->arginfuncs[i],
3911 3 : qdesc->argtypioparams[i],
3912 : &isnull);
3913 3 : nulls[i] = isnull ? 'n' : ' ';
3914 : }
3915 :
3916 : /************************************************************
3917 : * go
3918 : ************************************************************/
3919 4 : portal = SPI_cursor_open(NULL, qdesc->plan, argvalues, nulls,
3920 2 : current_call_data->prodesc->fn_readonly);
3921 2 : if (argc > 0)
3922 : {
3923 2 : pfree(argvalues);
3924 2 : pfree(nulls);
3925 : }
3926 2 : if (portal == NULL)
3927 0 : elog(ERROR, "SPI_cursor_open() failed:%s",
3928 : SPI_result_code_string(SPI_result));
3929 :
3930 2 : cursor = cstr2sv(portal->name);
3931 :
3932 2 : PinPortal(portal);
3933 :
3934 : /* Commit the inner transaction, return to outer xact context */
3935 2 : ReleaseCurrentSubTransaction();
3936 2 : MemoryContextSwitchTo(oldcontext);
3937 2 : CurrentResourceOwner = oldowner;
3938 : }
3939 0 : PG_CATCH();
3940 : {
3941 : ErrorData *edata;
3942 :
3943 : /* Save error info */
3944 0 : MemoryContextSwitchTo(oldcontext);
3945 0 : edata = CopyErrorData();
3946 0 : FlushErrorState();
3947 :
3948 : /* Abort the inner transaction */
3949 0 : RollbackAndReleaseCurrentSubTransaction();
3950 0 : MemoryContextSwitchTo(oldcontext);
3951 0 : CurrentResourceOwner = oldowner;
3952 :
3953 : /* Punt the error to Perl */
3954 0 : croak_cstr(edata->message);
3955 :
3956 : /* Can't get here, but keep compiler quiet */
3957 0 : return NULL;
3958 : }
3959 2 : PG_END_TRY();
3960 :
3961 2 : return cursor;
3962 : }
3963 :
3964 : void
3965 5 : plperl_spi_freeplan(char *query)
3966 : {
3967 : SPIPlanPtr plan;
3968 : plperl_query_desc *qdesc;
3969 : plperl_query_entry *hash_entry;
3970 :
3971 5 : check_spi_usage_allowed();
3972 :
3973 5 : hash_entry = hash_search(plperl_active_interp->query_hash, query,
3974 : HASH_FIND, NULL);
3975 5 : if (hash_entry == NULL)
3976 0 : elog(ERROR, "spi_freeplan: Invalid prepared query passed");
3977 :
3978 5 : qdesc = hash_entry->query_data;
3979 5 : if (qdesc == NULL)
3980 0 : elog(ERROR, "spi_freeplan: plperl query_hash value vanished");
3981 5 : plan = qdesc->plan;
3982 :
3983 : /*
3984 : * free all memory before SPI_freeplan, so if it dies, nothing will be
3985 : * left over
3986 : */
3987 5 : hash_search(plperl_active_interp->query_hash, query,
3988 : HASH_REMOVE, NULL);
3989 :
3990 5 : MemoryContextDelete(qdesc->plan_cxt);
3991 :
3992 5 : SPI_freeplan(plan);
3993 5 : }
3994 :
3995 : void
3996 25 : plperl_spi_commit(void)
3997 : {
3998 25 : MemoryContext oldcontext = CurrentMemoryContext;
3999 :
4000 25 : check_spi_usage_allowed();
4001 :
4002 25 : PG_TRY();
4003 : {
4004 25 : SPI_commit();
4005 : }
4006 5 : PG_CATCH();
4007 : {
4008 : ErrorData *edata;
4009 :
4010 : /* Save error info */
4011 5 : MemoryContextSwitchTo(oldcontext);
4012 5 : edata = CopyErrorData();
4013 5 : FlushErrorState();
4014 :
4015 : /* Punt the error to Perl */
4016 5 : croak_cstr(edata->message);
4017 : }
4018 20 : PG_END_TRY();
4019 20 : }
4020 :
4021 : void
4022 17 : plperl_spi_rollback(void)
4023 : {
4024 17 : MemoryContext oldcontext = CurrentMemoryContext;
4025 :
4026 17 : check_spi_usage_allowed();
4027 :
4028 17 : PG_TRY();
4029 : {
4030 17 : SPI_rollback();
4031 : }
4032 0 : PG_CATCH();
4033 : {
4034 : ErrorData *edata;
4035 :
4036 : /* Save error info */
4037 0 : MemoryContextSwitchTo(oldcontext);
4038 0 : edata = CopyErrorData();
4039 0 : FlushErrorState();
4040 :
4041 : /* Punt the error to Perl */
4042 0 : croak_cstr(edata->message);
4043 : }
4044 17 : PG_END_TRY();
4045 17 : }
4046 :
4047 : /*
4048 : * Implementation of plperl's elog() function
4049 : *
4050 : * If the error level is less than ERROR, we'll just emit the message and
4051 : * return. When it is ERROR, elog() will longjmp, which we catch and
4052 : * turn into a Perl croak(). Note we are assuming that elog() can't have
4053 : * any internal failures that are so bad as to require a transaction abort.
4054 : *
4055 : * The main reason this is out-of-line is to avoid conflicts between XSUB.h
4056 : * and the PG_TRY macros.
4057 : */
4058 : void
4059 186 : plperl_util_elog(int level, SV *msg)
4060 : {
4061 186 : MemoryContext oldcontext = CurrentMemoryContext;
4062 186 : char *volatile cmsg = NULL;
4063 :
4064 : /*
4065 : * We intentionally omit check_spi_usage_allowed() here, as this seems
4066 : * safe to allow even in the contexts that that function rejects.
4067 : */
4068 :
4069 186 : PG_TRY();
4070 : {
4071 186 : cmsg = sv2cstr(msg);
4072 186 : elog(level, "%s", cmsg);
4073 185 : pfree(cmsg);
4074 : }
4075 1 : PG_CATCH();
4076 : {
4077 : ErrorData *edata;
4078 :
4079 : /* Must reset elog.c's state */
4080 1 : MemoryContextSwitchTo(oldcontext);
4081 1 : edata = CopyErrorData();
4082 1 : FlushErrorState();
4083 :
4084 1 : if (cmsg)
4085 1 : pfree(cmsg);
4086 :
4087 : /* Punt the error to Perl */
4088 1 : croak_cstr(edata->message);
4089 : }
4090 185 : PG_END_TRY();
4091 185 : }
4092 :
4093 : /*
4094 : * Store an SV into a hash table under a key that is a string assumed to be
4095 : * in the current database's encoding.
4096 : */
4097 : static SV **
4098 736 : hv_store_string(HV *hv, const char *key, SV *val)
4099 : {
4100 736 : dTHX;
4101 : int32 hlen;
4102 : char *hkey;
4103 : SV **ret;
4104 :
4105 736 : hkey = pg_server_to_any(key, strlen(key), PG_UTF8);
4106 :
4107 : /*
4108 : * hv_store() recognizes a negative klen parameter as meaning a UTF-8
4109 : * encoded key.
4110 : */
4111 736 : hlen = -(int) strlen(hkey);
4112 736 : ret = hv_store(hv, hkey, hlen, val, 0);
4113 :
4114 736 : if (hkey != key)
4115 0 : pfree(hkey);
4116 :
4117 736 : return ret;
4118 : }
4119 :
4120 : /*
4121 : * Fetch an SV from a hash table under a key that is a string assumed to be
4122 : * in the current database's encoding.
4123 : */
4124 : static SV **
4125 9 : hv_fetch_string(HV *hv, const char *key)
4126 : {
4127 9 : dTHX;
4128 : int32 hlen;
4129 : char *hkey;
4130 : SV **ret;
4131 :
4132 9 : hkey = pg_server_to_any(key, strlen(key), PG_UTF8);
4133 :
4134 : /* See notes in hv_store_string */
4135 9 : hlen = -(int) strlen(hkey);
4136 9 : ret = hv_fetch(hv, hkey, hlen, 0);
4137 :
4138 9 : if (hkey != key)
4139 0 : pfree(hkey);
4140 :
4141 9 : return ret;
4142 : }
4143 :
4144 : /*
4145 : * Provide function name for PL/Perl execution errors
4146 : */
4147 : static void
4148 234 : plperl_exec_callback(void *arg)
4149 : {
4150 234 : char *procname = (char *) arg;
4151 :
4152 234 : if (procname)
4153 234 : errcontext("PL/Perl function \"%s\"", procname);
4154 234 : }
4155 :
4156 : /*
4157 : * Provide function name for PL/Perl compilation errors
4158 : */
4159 : static void
4160 4 : plperl_compile_callback(void *arg)
4161 : {
4162 4 : char *procname = (char *) arg;
4163 :
4164 4 : if (procname)
4165 4 : errcontext("compilation of PL/Perl function \"%s\"", procname);
4166 4 : }
4167 :
4168 : /*
4169 : * Provide error context for the inline handler
4170 : */
4171 : static void
4172 23 : plperl_inline_callback(void *arg)
4173 : {
4174 23 : errcontext("PL/Perl anonymous code block");
4175 23 : }
4176 :
4177 :
4178 : /*
4179 : * Perl's own setlocale(), copied from POSIX.xs
4180 : * (needed because of the calls to new_*())
4181 : *
4182 : * Starting in 5.28, perl exposes Perl_setlocale to do so.
4183 : */
4184 : #if defined(WIN32) && PERL_VERSION_LT(5, 28, 0)
4185 : static char *
4186 : setlocale_perl(int category, char *locale)
4187 : {
4188 : dTHX;
4189 : char *RETVAL = setlocale(category, locale);
4190 :
4191 : if (RETVAL)
4192 : {
4193 : #ifdef USE_LOCALE_CTYPE
4194 : if (category == LC_CTYPE
4195 : #ifdef LC_ALL
4196 : || category == LC_ALL
4197 : #endif
4198 : )
4199 : {
4200 : char *newctype;
4201 :
4202 : #ifdef LC_ALL
4203 : if (category == LC_ALL)
4204 : newctype = setlocale(LC_CTYPE, NULL);
4205 : else
4206 : #endif
4207 : newctype = RETVAL;
4208 : new_ctype(newctype);
4209 : }
4210 : #endif /* USE_LOCALE_CTYPE */
4211 : #ifdef USE_LOCALE_COLLATE
4212 : if (category == LC_COLLATE
4213 : #ifdef LC_ALL
4214 : || category == LC_ALL
4215 : #endif
4216 : )
4217 : {
4218 : char *newcoll;
4219 :
4220 : #ifdef LC_ALL
4221 : if (category == LC_ALL)
4222 : newcoll = setlocale(LC_COLLATE, NULL);
4223 : else
4224 : #endif
4225 : newcoll = RETVAL;
4226 : new_collate(newcoll);
4227 : }
4228 : #endif /* USE_LOCALE_COLLATE */
4229 :
4230 : #ifdef USE_LOCALE_NUMERIC
4231 : if (category == LC_NUMERIC
4232 : #ifdef LC_ALL
4233 : || category == LC_ALL
4234 : #endif
4235 : )
4236 : {
4237 : char *newnum;
4238 :
4239 : #ifdef LC_ALL
4240 : if (category == LC_ALL)
4241 : newnum = setlocale(LC_NUMERIC, NULL);
4242 : else
4243 : #endif
4244 : newnum = RETVAL;
4245 : new_numeric(newnum);
4246 : }
4247 : #endif /* USE_LOCALE_NUMERIC */
4248 : }
4249 :
4250 : return RETVAL;
4251 : }
4252 : #endif /* defined(WIN32) && PERL_VERSION_LT(5, 28, 0) */
|
