plperl.c 60.5 KB
Newer Older
1 2 3
/**********************************************************************
 * plperl.c - perl as a procedural language for PostgreSQL
 *
4
 *	  $PostgreSQL: pgsql/src/pl/plperl/plperl.c,v 1.117 2006/08/13 17:31:10 momjian Exp $
5
 *
6 7
 **********************************************************************/

8
#include "postgres.h"
9
/* Defined by Perl */
10
#undef _
11 12

/* system stuff */
13
#include <ctype.h>
14
#include <fcntl.h>
15
#include <unistd.h>
A
 
Andrew Dunstan 已提交
16
#include <locale.h>
17 18

/* postgreSQL stuff */
19 20
#include "commands/trigger.h"
#include "executor/spi.h"
21
#include "funcapi.h"
22 23 24 25
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "nodes/makefuncs.h"
#include "parser/parse_type.h"
26
#include "utils/lsyscache.h"
27
#include "utils/memutils.h"
28
#include "utils/typcache.h"
29

A
 
Andrew Dunstan 已提交
30 31 32
/* define this before the perl headers get a chance to mangle DLLIMPORT */
extern DLLIMPORT bool check_function_bodies;

33
/* perl stuff */
A
 
Andrew Dunstan 已提交
34
#include "plperl.h"
35

36 37
PG_MODULE_MAGIC;

38 39 40 41 42 43
/**********************************************************************
 * The information we cache about loaded procedures
 **********************************************************************/
typedef struct plperl_proc_desc
{
	char	   *proname;
44 45
	TransactionId fn_xmin;
	CommandId	fn_cmin;
46
	bool		fn_readonly;
47
	bool		lanpltrusted;
48
	bool		fn_retistuple;	/* true, if function returns tuple */
B
Bruce Momjian 已提交
49
	bool		fn_retisset;	/* true, if function returns set */
B
Bruce Momjian 已提交
50
	bool		fn_retisarray;	/* true if function returns array */
51
	Oid			result_oid;		/* Oid of result type */
B
Bruce Momjian 已提交
52
	FmgrInfo	result_in_func; /* I/O function and arg for result type */
53
	Oid			result_typioparam;
54 55
	int			nargs;
	FmgrInfo	arg_out_func[FUNC_MAX_ARGS];
56
	bool		arg_is_rowtype[FUNC_MAX_ARGS];
57
	SV		   *reference;
58
} plperl_proc_desc;
59

60 61 62 63 64 65 66 67 68 69 70 71 72 73
/*
 * The information we cache for the duration of a single call to a
 * function.
 */
typedef struct plperl_call_data
{
	plperl_proc_desc *prodesc;
	FunctionCallInfo  fcinfo;
	Tuplestorestate  *tuple_store;
	TupleDesc		  ret_tdesc;
	AttInMetadata	 *attinmeta;
	MemoryContext	  tmp_cxt;
} plperl_call_data;

A
 
Andrew Dunstan 已提交
74 75 76 77 78 79 80 81 82 83 84 85
/**********************************************************************
 * The information we cache about prepared and saved plans
 **********************************************************************/
typedef struct plperl_query_desc
{
	char		qname[sizeof(long) * 2 + 1];
	void	   *plan;
	int			nargs;
	Oid		   *argtypes;
	FmgrInfo   *arginfuncs;
	Oid		   *argtypioparams;
} plperl_query_desc;
86 87 88 89

/**********************************************************************
 * Global data
 **********************************************************************/
90
static bool plperl_safe_init_done = false;
91
static PerlInterpreter *plperl_interp = NULL;
92
static HV  *plperl_proc_hash = NULL;
A
 
Andrew Dunstan 已提交
93
static HV  *plperl_query_hash = NULL;
94

95 96
static bool plperl_use_strict = false;

97 98
/* this is saved and restored by plperl_call_handler */
static plperl_call_data *current_call_data = NULL;
99

100 101 102
/**********************************************************************
 * Forward declarations
 **********************************************************************/
B
Bruce Momjian 已提交
103
Datum		plperl_call_handler(PG_FUNCTION_ARGS);
104
Datum		plperl_validator(PG_FUNCTION_ARGS);
105 106 107
void		_PG_init(void);

static void plperl_init_interp(void);
108

109
static Datum plperl_func_handler(PG_FUNCTION_ARGS);
110

111
static Datum plperl_trigger_handler(PG_FUNCTION_ARGS);
112 113
static plperl_proc_desc *compile_plperl_function(Oid fn_oid, bool is_trigger);

114
static SV  *plperl_hash_from_tuple(HeapTuple tuple, TupleDesc tupdesc);
115
static void plperl_init_shared_libs(pTHX);
116
static HV  *plperl_spi_execute_fetch_result(SPITupleTable *, int, int);
117

118 119 120 121 122 123 124
/*
 * This routine is a crock, and so is everyplace that calls it.  The problem
 * is that the cached form of plperl functions/queries is allocated permanently
 * (mostly via malloc()) and never released until backend exit.  Subsidiary
 * data structures such as fmgr info records therefore must live forever
 * as well.  A better implementation would store all this stuff in a per-
 * function memory context that could be reclaimed at need.  In the meantime,
125 126 127
 * fmgr_info_cxt must be called specifying TopMemoryContext so that whatever
 * it might allocate, and whatever the eventual function might allocate using
 * fn_mcxt, will live forever too.
128 129 130 131
 */
static void
perm_fmgr_info(Oid functionId, FmgrInfo *finfo)
{
132
	fmgr_info_cxt(functionId, finfo, TopMemoryContext);
133 134
}

135

136 137 138 139 140
/*
 * _PG_init()			- library load-time initialization
 *
 * DO NOT make this static nor change its name!
 */
141
void
142
_PG_init(void)
143
{
144 145 146 147
	/* Be sure we do initialization only once (should be redundant now) */
	static bool inited = false;

	if (inited)
148 149
		return;

150
	DefineCustomBoolVariable("plperl.use_strict",
B
Bruce Momjian 已提交
151 152 153 154 155
	  "If true, will compile trusted and untrusted perl code in strict mode",
							 NULL,
							 &plperl_use_strict,
							 PGC_USERSET,
							 NULL, NULL);
156 157

	EmitWarningsOnPlaceholders("plperl");
158

159 160
	plperl_init_interp();

161
	inited = true;
162 163
}

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/* Each of these macros must represent a single string literal */

#define PERLBOOT \
	"SPI::bootstrap(); use vars qw(%_SHARED);" \
	"sub ::plperl_warn { my $msg = shift; " \
	"       $msg =~ s/\\(eval \\d+\\) //g; &elog(&NOTICE, $msg); } " \
	"$SIG{__WARN__} = \\&::plperl_warn; " \
	"sub ::plperl_die { my $msg = shift; " \
	"       $msg =~ s/\\(eval \\d+\\) //g; die $msg; } " \
	"$SIG{__DIE__} = \\&::plperl_die; " \
	"sub ::mkunsafefunc {" \
	"      my $ret = eval(qq[ sub { $_[0] $_[1] } ]); " \
	"      $@ =~ s/\\(eval \\d+\\) //g if $@; return $ret; }" \
	"use strict; " \
	"sub ::mk_strict_unsafefunc {" \
	"      my $ret = eval(qq[ sub { use strict; $_[0] $_[1] } ]); " \
	"      $@ =~ s/\\(eval \\d+\\) //g if $@; return $ret; } " \
	"sub ::_plperl_to_pg_array {" \
	"  my $arg = shift; ref $arg eq 'ARRAY' || return $arg; " \
	"  my $res = ''; my $first = 1; " \
	"  foreach my $elem (@$arg) " \
	"  { " \
	"    $res .= ', ' unless $first; $first = undef; " \
	"    if (ref $elem) " \
	"    { " \
	"      $res .= _plperl_to_pg_array($elem); " \
	"    } " \
A
 
Andrew Dunstan 已提交
191
	"    elsif (defined($elem)) " \
192 193 194 195 196
	"    { " \
	"      my $str = qq($elem); " \
	"      $str =~ s/([\"\\\\])/\\\\$1/g; " \
	"      $res .= qq(\"$str\"); " \
	"    } " \
A
 
Andrew Dunstan 已提交
197 198 199 200
	"    else " \
	"    { "\
	"      $res .= 'NULL' ; " \
	"    } "\
201 202 203 204 205 206 207 208 209 210 211 212
	"  } " \
	"  return qq({$res}); " \
	"} "

#define SAFE_MODULE \
	"require Safe; $Safe::VERSION"

#define SAFE_OK \
	"use vars qw($PLContainer); $PLContainer = new Safe('PLPerl');" \
	"$PLContainer->permit_only(':default');" \
	"$PLContainer->permit(qw[:base_math !:base_io sort time]);" \
	"$PLContainer->share(qw[&elog &spi_exec_query &return_next " \
A
 
Andrew Dunstan 已提交
213 214
	"&spi_query &spi_fetchrow &spi_cursor_close " \
	"&spi_prepare &spi_exec_prepared &spi_query_prepared &spi_freeplan " \
215 216 217 218 219 220 221 222 223
	"&_plperl_to_pg_array " \
	"&DEBUG &LOG &INFO &NOTICE &WARNING &ERROR %_SHARED ]);" \
	"sub ::mksafefunc {" \
	"      my $ret = $PLContainer->reval(qq[sub { $_[0] $_[1] }]); " \
	"      $@ =~ s/\\(eval \\d+\\) //g if $@; return $ret; }" \
	"$PLContainer->permit('require'); $PLContainer->reval('use strict;');" \
	"$PLContainer->deny('require');" \
	"sub ::mk_strict_safefunc {" \
	"      my $ret = $PLContainer->reval(qq[sub { BEGIN { strict->import(); } $_[0] $_[1] }]); " \
B
Bruce Momjian 已提交
224
	"      $@ =~ s/\\(eval \\d+\\) //g if $@; return $ret; }"
225 226 227 228 229 230 231 232 233 234 235 236

#define SAFE_BAD \
	"use vars qw($PLContainer); $PLContainer = new Safe('PLPerl');" \
	"$PLContainer->permit_only(':default');" \
	"$PLContainer->share(qw[&elog &ERROR ]);" \
	"sub ::mksafefunc { return $PLContainer->reval(qq[sub { " \
	"      elog(ERROR,'trusted Perl functions disabled - " \
	"      please upgrade Perl Safe module to version 2.09 or later');}]); }" \
	"sub ::mk_strict_safefunc { return $PLContainer->reval(qq[sub { " \
	"      elog(ERROR,'trusted Perl functions disabled - " \
	"      please upgrade Perl Safe module to version 2.09 or later');}]); }"

237 238

static void
239
plperl_init_interp(void)
240
{
B
Bruce Momjian 已提交
241
	static char *embedding[3] = {
242
		"", "-e", PERLBOOT
243 244
	};

A
 
Andrew Dunstan 已提交
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
#ifdef WIN32

	/* 
	 * The perl library on startup does horrible things like call
	 * setlocale(LC_ALL,""). We have protected against that on most
	 * platforms by setting the environment appropriately. However, on
	 * Windows, setlocale() does not consult the environment, so we need
	 * to save the existing locale settings before perl has a chance to 
	 * mangle them and restore them after its dirty deeds are done.
	 *
	 * MSDN ref:
	 * http://msdn.microsoft.com/library/en-us/vclib/html/_crt_locale.asp
	 *
	 * It appears that we only need to do this on interpreter startup, and
	 * subsequent calls to the interpreter don't mess with the locale
	 * settings.
	 *
	 * We restore them using Perl's POSIX::setlocale() function so that
	 * Perl doesn't have a different idea of the locale from Postgres.
	 *
	 */

	char *loc;
	char *save_collate, *save_ctype, *save_monetary, *save_numeric, *save_time;
	char buf[1024];

	loc = setlocale(LC_COLLATE,NULL);
	save_collate = loc ? pstrdup(loc) : NULL;
	loc = setlocale(LC_CTYPE,NULL);
	save_ctype = loc ? pstrdup(loc) : NULL;
	loc = setlocale(LC_MONETARY,NULL);
	save_monetary = loc ? pstrdup(loc) : NULL;
	loc = setlocale(LC_NUMERIC,NULL);
	save_numeric = loc ? pstrdup(loc) : NULL;
	loc = setlocale(LC_TIME,NULL);
	save_time = loc ? pstrdup(loc) : NULL;

#endif

284 285
	plperl_interp = perl_alloc();
	if (!plperl_interp)
286
		elog(ERROR, "could not allocate Perl interpreter");
287

288
	perl_construct(plperl_interp);
289
	perl_parse(plperl_interp, plperl_init_shared_libs, 3, embedding, NULL);
290
	perl_run(plperl_interp);
291

292
	plperl_proc_hash = newHV();
A
 
Andrew Dunstan 已提交
293
	plperl_query_hash = newHV();
A
 
Andrew Dunstan 已提交
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336

#ifdef WIN32

	eval_pv("use POSIX qw(locale_h);", TRUE); /* croak on failure */

	if (save_collate != NULL)
	{
		snprintf(buf, sizeof(buf),"setlocale(%s,'%s');",
				 "LC_COLLATE",save_collate);
		eval_pv(buf,TRUE);
		pfree(save_collate);
	}
	if (save_ctype != NULL)
	{
		snprintf(buf, sizeof(buf),"setlocale(%s,'%s');",
				 "LC_CTYPE",save_ctype);
		eval_pv(buf,TRUE);
		pfree(save_ctype);
	}
	if (save_monetary != NULL)
	{
		snprintf(buf, sizeof(buf),"setlocale(%s,'%s');",
				 "LC_MONETARY",save_monetary);
		eval_pv(buf,TRUE);
		pfree(save_monetary);
	}
	if (save_numeric != NULL)
	{
		snprintf(buf, sizeof(buf),"setlocale(%s,'%s');",
				 "LC_NUMERIC",save_numeric);
		eval_pv(buf,TRUE);
		pfree(save_numeric);
	}
	if (save_time != NULL)
	{
		snprintf(buf, sizeof(buf),"setlocale(%s,'%s');",
				 "LC_TIME",save_time);
		eval_pv(buf,TRUE);
		pfree(save_time);
	}

#endif

337 338
}

339 340 341 342

static void
plperl_safe_init(void)
{
B
Bruce Momjian 已提交
343
	SV		   *res;
344
	double		safe_version;
345

346
	res = eval_pv(SAFE_MODULE, FALSE);	/* TRUE = croak if failure */
347 348 349

	safe_version = SvNV(res);

350 351 352 353 354
	/*
	 * We actually want to reject safe_version < 2.09, but it's risky to
	 * assume that floating-point comparisons are exact, so use a slightly
	 * smaller comparison value.
	 */
B
Bruce Momjian 已提交
355
	if (safe_version < 2.0899)
356 357
	{
		/* not safe, so disallow all trusted funcs */
358
		eval_pv(SAFE_BAD, FALSE);
359 360 361
	}
	else
	{
362
		eval_pv(SAFE_OK, FALSE);
363
	}
364 365 366 367

	plperl_safe_init_done = true;
}

368 369 370 371 372 373
/*
 * Perl likes to put a newline after its error messages; clean up such
 */
static char *
strip_trailing_ws(const char *msg)
{
B
Bruce Momjian 已提交
374 375
	char	   *res = pstrdup(msg);
	int			len = strlen(res);
376

B
Bruce Momjian 已提交
377
	while (len > 0 && isspace((unsigned char) res[len - 1]))
378 379 380 381 382
		res[--len] = '\0';
	return res;
}


383 384
/* Build a tuple from a hash. */

385
static HeapTuple
386
plperl_build_tuple_result(HV *perlhash, AttInMetadata *attinmeta)
387
{
388 389 390 391 392 393
	TupleDesc	td = attinmeta->tupdesc;
	char	  **values;
	SV		   *val;
	char	   *key;
	I32			klen;
	HeapTuple	tup;
394

395
	values = (char **) palloc0(td->natts * sizeof(char *));
396

397 398 399
	hv_iterinit(perlhash);
	while ((val = hv_iternextsv(perlhash, &key, &klen)))
	{
B
Bruce Momjian 已提交
400
		int			attn = SPI_fnumber(td, key);
401

402
		if (attn <= 0 || td->attrs[attn - 1]->attisdropped)
403 404 405 406
			ereport(ERROR,
					(errcode(ERRCODE_UNDEFINED_COLUMN),
					 errmsg("Perl hash contains nonexistent column \"%s\"",
							key)));
407
		if (SvOK(val) && SvTYPE(val) != SVt_NULL)
408
			values[attn - 1] = SvPV(val, PL_na);
409
	}
410 411 412 413 414
	hv_iterinit(perlhash);

	tup = BuildTupleFromCStrings(attinmeta, values);
	pfree(values);
	return tup;
415 416
}

417 418 419
/*
 * convert perl array to postgres string representation
 */
B
Bruce Momjian 已提交
420
static SV  *
421
plperl_convert_to_pg_array(SV *src)
422
{
B
Bruce Momjian 已提交
423 424 425 426
	SV		   *rv;
	int			count;

	dSP;
427

B
Bruce Momjian 已提交
428
	PUSHMARK(SP);
429
	XPUSHs(src);
B
Bruce Momjian 已提交
430
	PUTBACK;
431

432
	count = call_pv("::_plperl_to_pg_array", G_SCALAR);
433

B
Bruce Momjian 已提交
434
	SPAGAIN;
435 436

	if (count != 1)
437
		elog(ERROR, "unexpected _plperl_to_pg_array failure");
438 439 440

	rv = POPs;

B
Bruce Momjian 已提交
441 442 443
	PUTBACK;

	return rv;
444 445
}

446

447 448
/* Set up the arguments for a trigger call. */

449 450 451 452 453
static SV  *
plperl_trigger_build_args(FunctionCallInfo fcinfo)
{
	TriggerData *tdata;
	TupleDesc	tupdesc;
454
	int			i;
455 456 457 458 459
	char	   *level;
	char	   *event;
	char	   *relid;
	char	   *when;
	HV		   *hv;
460

461
	hv = newHV();
462 463 464 465

	tdata = (TriggerData *) fcinfo->context;
	tupdesc = tdata->tg_relation->rd_att;

466
	relid = DatumGetCString(
B
Bruce Momjian 已提交
467 468 469 470
							DirectFunctionCall1(oidout,
								  ObjectIdGetDatum(tdata->tg_relation->rd_id)
												)
		);
471 472 473

	hv_store(hv, "name", 4, newSVpv(tdata->tg_trigger->tgname, 0), 0);
	hv_store(hv, "relid", 5, newSVpv(relid, 0), 0);
474 475 476

	if (TRIGGER_FIRED_BY_INSERT(tdata->tg_event))
	{
477
		event = "INSERT";
478 479 480 481
		if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
			hv_store(hv, "new", 3,
					 plperl_hash_from_tuple(tdata->tg_trigtuple, tupdesc),
					 0);
482 483 484
	}
	else if (TRIGGER_FIRED_BY_DELETE(tdata->tg_event))
	{
485
		event = "DELETE";
486 487 488 489
		if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
			hv_store(hv, "old", 3,
					 plperl_hash_from_tuple(tdata->tg_trigtuple, tupdesc),
					 0);
490 491 492
	}
	else if (TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))
	{
493
		event = "UPDATE";
494 495 496 497 498 499 500 501 502
		if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
		{
			hv_store(hv, "old", 3,
					 plperl_hash_from_tuple(tdata->tg_trigtuple, tupdesc),
					 0);
			hv_store(hv, "new", 3,
					 plperl_hash_from_tuple(tdata->tg_newtuple, tupdesc),
					 0);
		}
503
	}
504
	else
505
		event = "UNKNOWN";
506

507 508
	hv_store(hv, "event", 5, newSVpv(event, 0), 0);
	hv_store(hv, "argc", 4, newSViv(tdata->tg_trigger->tgnargs), 0);
509

510
	if (tdata->tg_trigger->tgnargs > 0)
511
	{
B
Bruce Momjian 已提交
512 513 514
		AV		   *av = newAV();

		for (i = 0; i < tdata->tg_trigger->tgnargs; i++)
515
			av_push(av, newSVpv(tdata->tg_trigger->tgargs[i], 0));
B
Bruce Momjian 已提交
516
		hv_store(hv, "args", 4, newRV_noinc((SV *) av), 0);
517
	}
518 519 520

	hv_store(hv, "relname", 7,
			 newSVpv(SPI_getrelname(tdata->tg_relation), 0), 0);
521

A
 
Andrew Dunstan 已提交
522 523 524 525 526 527
	hv_store(hv, "table_name", 10,
			 newSVpv(SPI_getrelname(tdata->tg_relation), 0), 0);

	hv_store(hv, "table_schema", 12,
			 newSVpv(SPI_getnspname(tdata->tg_relation), 0), 0);

528
	if (TRIGGER_FIRED_BEFORE(tdata->tg_event))
529
		when = "BEFORE";
530
	else if (TRIGGER_FIRED_AFTER(tdata->tg_event))
531
		when = "AFTER";
532
	else
533 534
		when = "UNKNOWN";
	hv_store(hv, "when", 4, newSVpv(when, 0), 0);
535 536

	if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
537
		level = "ROW";
538
	else if (TRIGGER_FIRED_FOR_STATEMENT(tdata->tg_event))
539
		level = "STATEMENT";
540
	else
541 542
		level = "UNKNOWN";
	hv_store(hv, "level", 5, newSVpv(level, 0), 0);
543

B
Bruce Momjian 已提交
544
	return newRV_noinc((SV *) hv);
545 546 547
}


548
/* Set up the new tuple returned from a trigger. */
549

550
static HeapTuple
551
plperl_modify_tuple(HV *hvTD, TriggerData *tdata, HeapTuple otup)
552 553 554 555
{
	SV		  **svp;
	HV		   *hvNew;
	HeapTuple	rtup;
556 557 558 559 560 561 562 563
	SV		   *val;
	char	   *key;
	I32			klen;
	int			slotsused;
	int		   *modattrs;
	Datum	   *modvalues;
	char	   *modnulls;

564 565 566 567 568
	TupleDesc	tupdesc;

	tupdesc = tdata->tg_relation->rd_att;

	svp = hv_fetch(hvTD, "new", 3, FALSE);
569
	if (!svp)
570 571 572
		ereport(ERROR,
				(errcode(ERRCODE_UNDEFINED_COLUMN),
				 errmsg("$_TD->{new} does not exist")));
573
	if (!SvOK(*svp) || SvTYPE(*svp) != SVt_RV || SvTYPE(SvRV(*svp)) != SVt_PVHV)
574 575 576
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("$_TD->{new} is not a hash reference")));
577 578
	hvNew = (HV *) SvRV(*svp);

579 580 581 582
	modattrs = palloc(tupdesc->natts * sizeof(int));
	modvalues = palloc(tupdesc->natts * sizeof(Datum));
	modnulls = palloc(tupdesc->natts * sizeof(char));
	slotsused = 0;
583

584 585
	hv_iterinit(hvNew);
	while ((val = hv_iternextsv(hvNew, &key, &klen)))
586
	{
587
		int			attn = SPI_fnumber(tupdesc, key);
588 589 590 591
		Oid			typinput;
		Oid			typioparam;
		int32		atttypmod;
		FmgrInfo	finfo;
592

593
		if (attn <= 0 || tupdesc->attrs[attn - 1]->attisdropped)
594 595 596 597
			ereport(ERROR,
					(errcode(ERRCODE_UNDEFINED_COLUMN),
					 errmsg("Perl hash contains nonexistent column \"%s\"",
							key)));
598 599 600 601 602
		/* XXX would be better to cache these lookups */
		getTypeInputInfo(tupdesc->attrs[attn - 1]->atttypid,
						 &typinput, &typioparam);
		fmgr_info(typinput, &finfo);
		atttypmod = tupdesc->attrs[attn - 1]->atttypmod;
603
		if (SvOK(val) && SvTYPE(val) != SVt_NULL)
604
		{
605 606 607 608
			modvalues[slotsused] = InputFunctionCall(&finfo,
													 SvPV(val, PL_na),
													 typioparam,
													 atttypmod);
609
			modnulls[slotsused] = ' ';
610 611 612
		}
		else
		{
613 614 615 616
			modvalues[slotsused] = InputFunctionCall(&finfo,
													 NULL,
													 typioparam,
													 atttypmod);
617
			modnulls[slotsused] = 'n';
618
		}
619 620
		modattrs[slotsused] = attn;
		slotsused++;
621
	}
622 623 624 625
	hv_iterinit(hvNew);

	rtup = SPI_modifytuple(tdata->tg_relation, otup, slotsused,
						   modattrs, modvalues, modnulls);
626 627 628 629

	pfree(modattrs);
	pfree(modvalues);
	pfree(modnulls);
630

631
	if (rtup == NULL)
632
		elog(ERROR, "SPI_modifytuple failed: %s",
633
			 SPI_result_code_string(SPI_result));
634 635 636

	return rtup;
}
637

638

639 640
/*
 * This is the only externally-visible part of the plperl call interface.
641
 * The Postgres function and trigger managers call it to execute a
642 643
 * perl function.
 */
644
PG_FUNCTION_INFO_V1(plperl_call_handler);
645 646

Datum
647
plperl_call_handler(PG_FUNCTION_ARGS)
648
{
B
Bruce Momjian 已提交
649
	Datum		retval;
650
	plperl_call_data *save_call_data;
651

652
	save_call_data = current_call_data;
653 654 655 656 657 658 659 660 661
	PG_TRY();
	{
		if (CALLED_AS_TRIGGER(fcinfo))
			retval = PointerGetDatum(plperl_trigger_handler(fcinfo));
		else
			retval = plperl_func_handler(fcinfo);
	}
	PG_CATCH();
	{
662
		current_call_data = save_call_data;
663 664 665 666
		PG_RE_THROW();
	}
	PG_END_TRY();

667
	current_call_data = save_call_data;
668 669 670
	return retval;
}

671 672 673 674 675 676 677 678 679 680 681 682
/*
 * This is the other externally visible function - it is called when CREATE
 * FUNCTION is issued to validate the function being created/replaced.
 */
PG_FUNCTION_INFO_V1(plperl_validator);

Datum
plperl_validator(PG_FUNCTION_ARGS)
{
	Oid			funcoid = PG_GETARG_OID(0);
	HeapTuple	tuple;
	Form_pg_proc proc;
683
	char		functyptype;
684 685 686 687
	int			numargs;
	Oid		   *argtypes;
	char	  **argnames;
	char	   *argmodes;
688
	bool		istrigger = false;
689
	int			i;
690 691 692 693 694 695 696 697 698

	/* Get the new function's pg_proc entry */
	tuple = SearchSysCache(PROCOID,
						   ObjectIdGetDatum(funcoid),
						   0, 0, 0);
	if (!HeapTupleIsValid(tuple))
		elog(ERROR, "cache lookup failed for function %u", funcoid);
	proc = (Form_pg_proc) GETSTRUCT(tuple);

699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
	functyptype = get_typtype(proc->prorettype);

	/* Disallow pseudotype result */
	/* except for TRIGGER, RECORD, or VOID */
	if (functyptype == 'p')
	{
		/* we assume OPAQUE with no arguments means a trigger */
		if (proc->prorettype == TRIGGEROID ||
			(proc->prorettype == OPAQUEOID && proc->pronargs == 0))
			istrigger = true;
		else if (proc->prorettype != RECORDOID &&
				 proc->prorettype != VOIDOID)
			ereport(ERROR,
					(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
					 errmsg("plperl functions cannot return type %s",
							format_type_be(proc->prorettype))));
	}

717 718 719 720 721 722 723 724 725 726 727 728
	/* Disallow pseudotypes in arguments (either IN or OUT) */
	numargs = get_func_arg_info(tuple,
								&argtypes, &argnames, &argmodes);
	for (i = 0; i < numargs; i++)
	{
		if (get_typtype(argtypes[i]) == 'p')
			ereport(ERROR,
					(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
					 errmsg("plperl functions cannot take type %s",
							format_type_be(argtypes[i]))));
	}

729 730
	ReleaseSysCache(tuple);

731 732 733
	/* Postpone body checks if !check_function_bodies */
	if (check_function_bodies)
	{
734
		(void) compile_plperl_function(funcoid, istrigger);
735
	}
736 737 738 739 740

	/* the result of a validator is ignored */
	PG_RETURN_VOID();
}

741

742 743 744
/* Uses mksafefunc/mkunsafefunc to create an anonymous sub whose text is
 * supplied in s, and returns a reference to the closure. */

B
Bruce Momjian 已提交
745
static SV  *
746
plperl_create_sub(char *s, bool trusted)
747
{
748
	dSP;
749
	SV		   *subref;
B
Bruce Momjian 已提交
750
	int			count;
B
Bruce Momjian 已提交
751
	char	   *compile_sub;
752

B
Bruce Momjian 已提交
753
	if (trusted && !plperl_safe_init_done)
754
	{
755
		plperl_safe_init();
756 757
		SPAGAIN;
	}
758

759 760 761
	ENTER;
	SAVETMPS;
	PUSHMARK(SP);
A
 
Andrew Dunstan 已提交
762
	XPUSHs(sv_2mortal(newSVpv("our $_TD; local $_TD=$_[0]; shift;", 0)));
B
Bruce Momjian 已提交
763
	XPUSHs(sv_2mortal(newSVpv(s, 0)));
B
Bruce Momjian 已提交
764
	PUTBACK;
B
Bruce Momjian 已提交
765

766 767
	/*
	 * G_KEEPERR seems to be needed here, else we don't recognize compile
B
Bruce Momjian 已提交
768 769
	 * errors properly.  Perhaps it's because there's another level of eval
	 * inside mksafefunc?
770
	 */
771 772 773 774 775 776 777 778 779 780 781

	if (trusted && plperl_use_strict)
		compile_sub = "::mk_strict_safefunc";
	else if (plperl_use_strict)
		compile_sub = "::mk_strict_unsafefunc";
	else if (trusted)
		compile_sub = "::mksafefunc";
	else
		compile_sub = "::mkunsafefunc";

	count = perl_call_pv(compile_sub, G_SCALAR | G_EVAL | G_KEEPERR);
782 783
	SPAGAIN;

784 785 786 787 788
	if (count != 1)
	{
		PUTBACK;
		FREETMPS;
		LEAVE;
789
		elog(ERROR, "didn't get a return item from mksafefunc");
790 791
	}

792
	if (SvTRUE(ERRSV))
793
	{
794
		(void) POPs;
795 796 797
		PUTBACK;
		FREETMPS;
		LEAVE;
798 799 800 801
		ereport(ERROR,
				(errcode(ERRCODE_SYNTAX_ERROR),
				 errmsg("creation of Perl function failed: %s",
						strip_trailing_ws(SvPV(ERRSV, PL_na)))));
802 803 804
	}

	/*
805 806
	 * need to make a deep copy of the return. it comes off the stack as a
	 * temporary.
807 808 809
	 */
	subref = newSVsv(POPs);

810
	if (!SvROK(subref) || SvTYPE(SvRV(subref)) != SVt_PVCV)
811
	{
812 813 814
		PUTBACK;
		FREETMPS;
		LEAVE;
815

816 817 818 819
		/*
		 * subref is our responsibility because it is not mortal
		 */
		SvREFCNT_dec(subref);
820
		elog(ERROR, "didn't get a code ref");
821 822 823 824 825
	}

	PUTBACK;
	FREETMPS;
	LEAVE;
826

827 828 829
	return subref;
}

830

831
/**********************************************************************
832
 * plperl_init_shared_libs()		-
833 834 835 836
 *
 * We cannot use the DynaLoader directly to get at the Opcode
 * module (used by Safe.pm). So, we link Opcode into ourselves
 * and do the initialization behind perl's back.
837
 *
838 839
 **********************************************************************/

840 841
EXTERN_C void boot_DynaLoader(pTHX_ CV *cv);
EXTERN_C void boot_SPI(pTHX_ CV *cv);
842

843
static void
844
plperl_init_shared_libs(pTHX)
845
{
846 847
	char	   *file = __FILE__;

848
	newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
849
	newXS("SPI::bootstrap", boot_SPI, file);
850 851
}

852

B
Bruce Momjian 已提交
853
static SV  *
854
plperl_call_perl_func(plperl_proc_desc *desc, FunctionCallInfo fcinfo)
855 856
{
	dSP;
857 858 859
	SV		   *retval;
	int			i;
	int			count;
B
Bruce Momjian 已提交
860
	SV		   *sv;
861 862 863 864

	ENTER;
	SAVETMPS;

865
	PUSHMARK(SP);
866

B
Bruce Momjian 已提交
867
	XPUSHs(&PL_sv_undef);		/* no trigger data */
868

869 870
	for (i = 0; i < desc->nargs; i++)
	{
871 872 873
		if (fcinfo->argnull[i])
			XPUSHs(&PL_sv_undef);
		else if (desc->arg_is_rowtype[i])
874
		{
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
			HeapTupleHeader td;
			Oid			tupType;
			int32		tupTypmod;
			TupleDesc	tupdesc;
			HeapTupleData tmptup;
			SV		   *hashref;

			td = DatumGetHeapTupleHeader(fcinfo->arg[i]);
			/* Extract rowtype info and find a tupdesc */
			tupType = HeapTupleHeaderGetTypeId(td);
			tupTypmod = HeapTupleHeaderGetTypMod(td);
			tupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod);
			/* Build a temporary HeapTuple control structure */
			tmptup.t_len = HeapTupleHeaderGetDatumLength(td);
			tmptup.t_data = td;

891 892
			hashref = plperl_hash_from_tuple(&tmptup, tupdesc);
			XPUSHs(sv_2mortal(hashref));
893
			ReleaseTupleDesc(tupdesc);
894 895 896
		}
		else
		{
897 898
			char	   *tmp;

899 900
			tmp = OutputFunctionCall(&(desc->arg_out_func[i]),
									 fcinfo->arg[i]);
901 902
			sv = newSVpv(tmp, 0);
#if PERL_BCDVERSION >= 0x5006000L
B
Bruce Momjian 已提交
903 904
			if (GetDatabaseEncoding() == PG_UTF8)
				SvUTF8_on(sv);
905 906
#endif
			XPUSHs(sv_2mortal(sv));
907
			pfree(tmp);
908 909 910
		}
	}
	PUTBACK;
911 912 913

	/* Do NOT use G_KEEPERR here */
	count = perl_call_sv(desc->reference, G_SCALAR | G_EVAL);
914 915 916

	SPAGAIN;

917 918 919 920
	if (count != 1)
	{
		PUTBACK;
		FREETMPS;
921
		LEAVE;
922
		elog(ERROR, "didn't get a return item from function");
923 924
	}

925
	if (SvTRUE(ERRSV))
926
	{
927
		(void) POPs;
928 929
		PUTBACK;
		FREETMPS;
930
		LEAVE;
931 932 933 934
		/* XXX need to find a way to assign an errcode here */
		ereport(ERROR,
				(errmsg("error from Perl function: %s",
						strip_trailing_ws(SvPV(ERRSV, PL_na)))));
935 936 937 938
	}

	retval = newSVsv(POPs);

939 940 941
	PUTBACK;
	FREETMPS;
	LEAVE;
942 943 944 945

	return retval;
}

946

947
static SV  *
948 949
plperl_call_perl_trigger_func(plperl_proc_desc *desc, FunctionCallInfo fcinfo,
							  SV *td)
950 951 952
{
	dSP;
	SV		   *retval;
953
	Trigger    *tg_trigger;
954 955 956 957 958 959 960
	int			i;
	int			count;

	ENTER;
	SAVETMPS;

	PUSHMARK(sp);
961

962
	XPUSHs(td);
963

964 965 966
	tg_trigger = ((TriggerData *) fcinfo->context)->tg_trigger;
	for (i = 0; i < tg_trigger->tgnargs; i++)
		XPUSHs(sv_2mortal(newSVpv(tg_trigger->tgargs[i], 0)));
967 968
	PUTBACK;

969 970
	/* Do NOT use G_KEEPERR here */
	count = perl_call_sv(desc->reference, G_SCALAR | G_EVAL);
971 972 973 974 975 976 977 978

	SPAGAIN;

	if (count != 1)
	{
		PUTBACK;
		FREETMPS;
		LEAVE;
979
		elog(ERROR, "didn't get a return item from trigger function");
980 981 982 983
	}

	if (SvTRUE(ERRSV))
	{
984
		(void) POPs;
985 986 987
		PUTBACK;
		FREETMPS;
		LEAVE;
988 989 990 991
		/* XXX need to find a way to assign an errcode here */
		ereport(ERROR,
				(errmsg("error from Perl trigger function: %s",
						strip_trailing_ws(SvPV(ERRSV, PL_na)))));
992 993 994 995 996 997 998 999 1000 1001
	}

	retval = newSVsv(POPs);

	PUTBACK;
	FREETMPS;
	LEAVE;

	return retval;
}
1002

1003

1004
static Datum
1005
plperl_func_handler(PG_FUNCTION_ARGS)
1006 1007
{
	plperl_proc_desc *prodesc;
1008 1009
	SV		   *perlret;
	Datum		retval;
1010
	ReturnSetInfo *rsi;
B
Bruce Momjian 已提交
1011
	SV		   *array_ret = NULL;
1012

1013 1014 1015 1016 1017 1018 1019
	/*
	 * Create the call_data beforing connecting to SPI, so that it is
	 * not allocated in the SPI memory context
	 */
	current_call_data = (plperl_call_data *) palloc0(sizeof(plperl_call_data));
	current_call_data->fcinfo = fcinfo;

1020 1021 1022
	if (SPI_connect() != SPI_OK_CONNECT)
		elog(ERROR, "could not connect to SPI manager");

1023
	prodesc = compile_plperl_function(fcinfo->flinfo->fn_oid, false);
1024
	current_call_data->prodesc = prodesc;
1025

B
Bruce Momjian 已提交
1026
	rsi = (ReturnSetInfo *) fcinfo->resultinfo;
B
Bruce Momjian 已提交
1027

T
Tom Lane 已提交
1028
	if (prodesc->fn_retisset)
1029
	{
T
Tom Lane 已提交
1030 1031 1032 1033 1034 1035 1036 1037
		/* Check context before allowing the call to go through */
		if (!rsi || !IsA(rsi, ReturnSetInfo) ||
			(rsi->allowedModes & SFRM_Materialize) == 0 ||
			rsi->expectedDesc == NULL)
			ereport(ERROR,
					(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
					 errmsg("set-valued function called in context that "
							"cannot accept a set")));
1038 1039
	}

1040
	perlret = plperl_call_perl_func(prodesc, fcinfo);
1041 1042 1043 1044 1045 1046 1047 1048

	/************************************************************
	 * Disconnect from SPI manager and then create the return
	 * values datum (if the input function does a palloc for it
	 * this must not be allocated in the SPI memory context
	 * because SPI_finish would free it).
	 ************************************************************/
	if (SPI_finish() != SPI_OK_FINISH)
1049
		elog(ERROR, "SPI_finish() failed");
1050

T
Tom Lane 已提交
1051
	if (prodesc->fn_retisset)
1052
	{
T
Tom Lane 已提交
1053 1054
		/*
		 * If the Perl function returned an arrayref, we pretend that it
B
Bruce Momjian 已提交
1055 1056 1057
		 * called return_next() for each element of the array, to handle old
		 * SRFs that didn't know about return_next(). Any other sort of return
		 * value is an error.
T
Tom Lane 已提交
1058
		 */
1059 1060
		if (SvTYPE(perlret) == SVt_RV &&
			SvTYPE(SvRV(perlret)) == SVt_PVAV)
1061
		{
B
Bruce Momjian 已提交
1062 1063 1064 1065 1066
			int			i = 0;
			SV		  **svp = 0;
			AV		   *rav = (AV *) SvRV(perlret);

			while ((svp = av_fetch(rav, i, FALSE)) != NULL)
1067
			{
1068 1069 1070
				plperl_return_next(*svp);
				i++;
			}
1071
		}
1072
		else if (SvTYPE(perlret) != SVt_NULL)
1073
		{
1074 1075
			ereport(ERROR,
					(errcode(ERRCODE_DATATYPE_MISMATCH),
1076 1077
					 errmsg("set-returning Perl function must return "
							"reference to array or use return_next")));
1078
		}
B
Bruce Momjian 已提交
1079

1080
		rsi->returnMode = SFRM_Materialize;
1081
		if (current_call_data->tuple_store)
1082
		{
1083 1084
			rsi->setResult = current_call_data->tuple_store;
			rsi->setDesc = current_call_data->ret_tdesc;
1085
		}
B
Bruce Momjian 已提交
1086
		retval = (Datum) 0;
1087 1088 1089 1090 1091 1092
	}
	else if (SvTYPE(perlret) == SVt_NULL)
	{
		/* Return NULL if Perl code returned undef */
		if (rsi && IsA(rsi, ReturnSetInfo))
			rsi->isDone = ExprEndResult;
1093 1094
		retval = InputFunctionCall(&prodesc->result_in_func, NULL,
								   prodesc->result_typioparam, -1);
1095
		fcinfo->isnull = true;
B
Bruce Momjian 已提交
1096
	}
1097
	else if (prodesc->fn_retistuple)
1098
	{
1099
		/* Return a perl hash converted to a Datum */
B
Bruce Momjian 已提交
1100
		TupleDesc	td;
1101
		AttInMetadata *attinmeta;
B
Bruce Momjian 已提交
1102
		HeapTuple	tup;
1103

1104 1105 1106
		if (!SvOK(perlret) || SvTYPE(perlret) != SVt_RV ||
			SvTYPE(SvRV(perlret)) != SVt_PVHV)
		{
1107 1108
			ereport(ERROR,
					(errcode(ERRCODE_DATATYPE_MISMATCH),
1109 1110 1111
					 errmsg("composite-returning Perl function "
							"must return reference to hash")));
		}
1112

1113 1114 1115 1116 1117 1118 1119 1120
		/* XXX should cache the attinmeta data instead of recomputing */
		if (get_call_result_type(fcinfo, NULL, &td) != TYPEFUNC_COMPOSITE)
		{
			ereport(ERROR,
					(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
					 errmsg("function returning record called in context "
							"that cannot accept type record")));
		}
1121

1122
		attinmeta = TupleDescGetAttInMetadata(td);
B
Bruce Momjian 已提交
1123
		tup = plperl_build_tuple_result((HV *) SvRV(perlret), attinmeta);
1124 1125 1126 1127
		retval = HeapTupleGetDatum(tup);
	}
	else
	{
B
Bruce Momjian 已提交
1128 1129 1130 1131
		/* Return a perl string converted to a Datum */
		char	   *val;

		if (prodesc->fn_retisarray && SvROK(perlret) &&
1132
			SvTYPE(SvRV(perlret)) == SVt_PVAV)
B
Bruce Momjian 已提交
1133 1134 1135 1136 1137
		{
			array_ret = plperl_convert_to_pg_array(perlret);
			SvREFCNT_dec(perlret);
			perlret = array_ret;
		}
1138 1139 1140

		val = SvPV(perlret, PL_na);

1141 1142
		retval = InputFunctionCall(&prodesc->result_in_func, val,
								   prodesc->result_typioparam, -1);
1143
	}
1144

1145
	if (array_ret == NULL)
B
Bruce Momjian 已提交
1146
		SvREFCNT_dec(perlret);
1147

1148
	current_call_data = NULL;
1149 1150 1151
	return retval;
}

1152

1153 1154 1155 1156 1157 1158 1159 1160 1161
static Datum
plperl_trigger_handler(PG_FUNCTION_ARGS)
{
	plperl_proc_desc *prodesc;
	SV		   *perlret;
	Datum		retval;
	SV		   *svTD;
	HV		   *hvTD;

1162 1163 1164 1165 1166 1167 1168
	/*
	 * Create the call_data beforing connecting to SPI, so that it is
	 * not allocated in the SPI memory context
	 */
	current_call_data = (plperl_call_data *) palloc0(sizeof(plperl_call_data));
	current_call_data->fcinfo = fcinfo;

1169 1170 1171 1172
	/* Connect to SPI manager */
	if (SPI_connect() != SPI_OK_CONNECT)
		elog(ERROR, "could not connect to SPI manager");

1173 1174
	/* Find or compile the function */
	prodesc = compile_plperl_function(fcinfo->flinfo->fn_oid, true);
1175
	current_call_data->prodesc = prodesc;
1176

1177 1178
	svTD = plperl_trigger_build_args(fcinfo);
	perlret = plperl_call_perl_trigger_func(prodesc, fcinfo, svTD);
1179
	hvTD = (HV *) SvRV(svTD);
1180 1181 1182 1183 1184 1185 1186 1187

	/************************************************************
	* Disconnect from SPI manager and then create the return
	* values datum (if the input function does a palloc for it
	* this must not be allocated in the SPI memory context
	* because SPI_finish would free it).
	************************************************************/
	if (SPI_finish() != SPI_OK_FINISH)
1188
		elog(ERROR, "SPI_finish() failed");
1189

1190
	if (!(perlret && SvOK(perlret) && SvTYPE(perlret) != SVt_NULL))
1191
	{
1192
		/* undef result means go ahead with original tuple */
1193 1194 1195 1196 1197 1198 1199 1200
		TriggerData *trigdata = ((TriggerData *) fcinfo->context);

		if (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event))
			retval = (Datum) trigdata->tg_trigtuple;
		else if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))
			retval = (Datum) trigdata->tg_newtuple;
		else if (TRIGGER_FIRED_BY_DELETE(trigdata->tg_event))
			retval = (Datum) trigdata->tg_trigtuple;
1201
		else
B
Bruce Momjian 已提交
1202
			retval = (Datum) 0; /* can this happen? */
1203 1204 1205
	}
	else
	{
1206 1207
		HeapTuple	trv;
		char	   *tmp;
1208

1209
		tmp = SvPV(perlret, PL_na);
1210

1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
		if (pg_strcasecmp(tmp, "SKIP") == 0)
			trv = NULL;
		else if (pg_strcasecmp(tmp, "MODIFY") == 0)
		{
			TriggerData *trigdata = (TriggerData *) fcinfo->context;

			if (TRIGGER_FIRED_BY_INSERT(trigdata->tg_event))
				trv = plperl_modify_tuple(hvTD, trigdata,
										  trigdata->tg_trigtuple);
			else if (TRIGGER_FIRED_BY_UPDATE(trigdata->tg_event))
				trv = plperl_modify_tuple(hvTD, trigdata,
										  trigdata->tg_newtuple);
1223 1224
			else
			{
1225 1226
				ereport(WARNING,
						(errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
B
Bruce Momjian 已提交
1227
					   errmsg("ignoring modified tuple in DELETE trigger")));
1228 1229 1230
				trv = NULL;
			}
		}
1231
		else
1232
		{
1233 1234
			ereport(ERROR,
					(errcode(ERRCODE_E_R_I_E_TRIGGER_PROTOCOL_VIOLATED),
1235 1236
					 errmsg("result of Perl trigger function must be undef, "
							"\"SKIP\" or \"MODIFY\"")));
1237 1238 1239
			trv = NULL;
		}
		retval = PointerGetDatum(trv);
1240 1241
	}

1242 1243 1244
	SvREFCNT_dec(svTD);
	if (perlret)
		SvREFCNT_dec(perlret);
1245

1246
	current_call_data = NULL;
1247 1248
	return retval;
}
1249

1250

1251 1252
static plperl_proc_desc *
compile_plperl_function(Oid fn_oid, bool is_trigger)
1253
{
1254 1255 1256 1257 1258
	HeapTuple	procTup;
	Form_pg_proc procStruct;
	char		internal_proname[64];
	int			proname_len;
	plperl_proc_desc *prodesc = NULL;
1259
	int			i;
B
Bruce Momjian 已提交
1260
	SV		  **svp;
1261

1262 1263 1264 1265 1266
	/* We'll need the pg_proc tuple in any case... */
	procTup = SearchSysCache(PROCOID,
							 ObjectIdGetDatum(fn_oid),
							 0, 0, 0);
	if (!HeapTupleIsValid(procTup))
1267
		elog(ERROR, "cache lookup failed for function %u", fn_oid);
1268
	procStruct = (Form_pg_proc) GETSTRUCT(procTup);
1269 1270

	/************************************************************
1271
	 * Build our internal proc name from the function's Oid
1272
	 ************************************************************/
1273 1274 1275 1276
	if (!is_trigger)
		sprintf(internal_proname, "__PLPerl_proc_%u", fn_oid);
	else
		sprintf(internal_proname, "__PLPerl_proc_%u_trigger", fn_oid);
1277

1278
	proname_len = strlen(internal_proname);
1279 1280 1281 1282

	/************************************************************
	 * Lookup the internal proc name in the hashtable
	 ************************************************************/
1283 1284
	svp = hv_fetch(plperl_proc_hash, internal_proname, proname_len, FALSE);
	if (svp)
1285
	{
1286 1287
		bool		uptodate;

A
 
Andrew Dunstan 已提交
1288
		prodesc = INT2PTR( plperl_proc_desc *, SvUV(*svp));
1289

1290
		/************************************************************
1291 1292 1293
		 * If it's present, must check whether it's still up to date.
		 * This is needed because CREATE OR REPLACE FUNCTION can modify the
		 * function's pg_proc entry without changing its OID.
1294
		 ************************************************************/
1295
		uptodate = (prodesc->fn_xmin == HeapTupleHeaderGetXmin(procTup->t_data) &&
B
Bruce Momjian 已提交
1296
				prodesc->fn_cmin == HeapTupleHeaderGetCmin(procTup->t_data));
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306

		if (!uptodate)
		{
			/* need we delete old entry? */
			prodesc = NULL;
		}
	}

	/************************************************************
	 * If we haven't found it in the hashtable, we analyze
1307
	 * the function's arguments and return type and store
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
	 * the in-/out-functions in the prodesc block and create
	 * a new hashtable entry for it.
	 *
	 * Then we load the procedure into the Perl interpreter.
	 ************************************************************/
	if (prodesc == NULL)
	{
		HeapTuple	langTup;
		HeapTuple	typeTup;
		Form_pg_language langStruct;
		Form_pg_type typeStruct;
1319 1320
		Datum		prosrcdatum;
		bool		isnull;
1321 1322 1323 1324 1325 1326
		char	   *proc_source;

		/************************************************************
		 * Allocate a new procedure description block
		 ************************************************************/
		prodesc = (plperl_proc_desc *) malloc(sizeof(plperl_proc_desc));
1327
		if (prodesc == NULL)
1328 1329 1330
			ereport(ERROR,
					(errcode(ERRCODE_OUT_OF_MEMORY),
					 errmsg("out of memory")));
1331 1332
		MemSet(prodesc, 0, sizeof(plperl_proc_desc));
		prodesc->proname = strdup(internal_proname);
1333 1334
		prodesc->fn_xmin = HeapTupleHeaderGetXmin(procTup->t_data);
		prodesc->fn_cmin = HeapTupleHeaderGetCmin(procTup->t_data);
1335

1336 1337 1338 1339
		/* Remember if function is STABLE/IMMUTABLE */
		prodesc->fn_readonly =
			(procStruct->provolatile != PROVOLATILE_VOLATILE);

1340
		/************************************************************
1341
		 * Lookup the pg_language tuple by Oid
1342
		 ************************************************************/
1343 1344
		langTup = SearchSysCache(LANGOID,
								 ObjectIdGetDatum(procStruct->prolang),
1345
								 0, 0, 0);
1346
		if (!HeapTupleIsValid(langTup))
1347 1348 1349
		{
			free(prodesc->proname);
			free(prodesc);
1350
			elog(ERROR, "cache lookup failed for language %u",
1351
				 procStruct->prolang);
1352
		}
1353 1354 1355
		langStruct = (Form_pg_language) GETSTRUCT(langTup);
		prodesc->lanpltrusted = langStruct->lanpltrusted;
		ReleaseSysCache(langTup);
1356 1357

		/************************************************************
1358 1359
		 * Get the required information for input conversion of the
		 * return value.
1360
		 ************************************************************/
1361 1362 1363
		if (!is_trigger)
		{
			typeTup = SearchSysCache(TYPEOID,
B
Bruce Momjian 已提交
1364
									 ObjectIdGetDatum(procStruct->prorettype),
1365 1366 1367 1368 1369
									 0, 0, 0);
			if (!HeapTupleIsValid(typeTup))
			{
				free(prodesc->proname);
				free(prodesc);
1370
				elog(ERROR, "cache lookup failed for type %u",
1371
					 procStruct->prorettype);
1372 1373 1374
			}
			typeStruct = (Form_pg_type) GETSTRUCT(typeTup);

1375
			/* Disallow pseudotype result, except VOID or RECORD */
1376 1377
			if (typeStruct->typtype == 'p')
			{
1378 1379
				if (procStruct->prorettype == VOIDOID ||
					procStruct->prorettype == RECORDOID)
B
Bruce Momjian 已提交
1380
					 /* okay */ ;
1381
				else if (procStruct->prorettype == TRIGGEROID)
1382 1383 1384
				{
					free(prodesc->proname);
					free(prodesc);
1385 1386
					ereport(ERROR,
							(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1387 1388
							 errmsg("trigger functions may only be called "
									"as triggers")));
1389 1390 1391 1392 1393
				}
				else
				{
					free(prodesc->proname);
					free(prodesc);
1394 1395
					ereport(ERROR,
							(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
B
Bruce Momjian 已提交
1396 1397
							 errmsg("plperl functions cannot return type %s",
									format_type_be(procStruct->prorettype))));
1398 1399 1400
				}
			}

1401 1402 1403 1404
			prodesc->result_oid = procStruct->prorettype;
			prodesc->fn_retisset = procStruct->proretset;
			prodesc->fn_retistuple = (typeStruct->typtype == 'c' ||
									  procStruct->prorettype == RECORDOID);
1405

B
Bruce Momjian 已提交
1406 1407
			prodesc->fn_retisarray =
				(typeStruct->typlen == -1 && typeStruct->typelem);
1408

1409
			perm_fmgr_info(typeStruct->typinput, &(prodesc->result_in_func));
1410
			prodesc->result_typioparam = getTypeIOParam(typeTup);
1411 1412 1413

			ReleaseSysCache(typeTup);
		}
1414 1415

		/************************************************************
1416 1417
		 * Get the required information for output conversion
		 * of all procedure arguments
1418
		 ************************************************************/
1419 1420 1421 1422 1423 1424
		if (!is_trigger)
		{
			prodesc->nargs = procStruct->pronargs;
			for (i = 0; i < prodesc->nargs; i++)
			{
				typeTup = SearchSysCache(TYPEOID,
B
Bruce Momjian 已提交
1425
						 ObjectIdGetDatum(procStruct->proargtypes.values[i]),
1426 1427 1428 1429 1430
										 0, 0, 0);
				if (!HeapTupleIsValid(typeTup))
				{
					free(prodesc->proname);
					free(prodesc);
1431
					elog(ERROR, "cache lookup failed for type %u",
1432
						 procStruct->proargtypes.values[i]);
1433 1434 1435
				}
				typeStruct = (Form_pg_type) GETSTRUCT(typeTup);

1436 1437 1438 1439 1440
				/* Disallow pseudotype argument */
				if (typeStruct->typtype == 'p')
				{
					free(prodesc->proname);
					free(prodesc);
1441 1442
					ereport(ERROR,
							(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
B
Bruce Momjian 已提交
1443 1444
							 errmsg("plperl functions cannot take type %s",
						format_type_be(procStruct->proargtypes.values[i]))));
1445 1446
				}

1447 1448
				if (typeStruct->typtype == 'c')
					prodesc->arg_is_rowtype[i] = true;
1449
				else
1450 1451 1452 1453 1454
				{
					prodesc->arg_is_rowtype[i] = false;
					perm_fmgr_info(typeStruct->typoutput,
								   &(prodesc->arg_out_func[i]));
				}
1455 1456 1457 1458

				ReleaseSysCache(typeTup);
			}
		}
1459

1460 1461 1462 1463 1464
		/************************************************************
		 * create the text of the anonymous subroutine.
		 * we do not use a named subroutine so that we can call directly
		 * through the reference.
		 ************************************************************/
1465 1466 1467 1468
		prosrcdatum = SysCacheGetAttr(PROCOID, procTup,
									  Anum_pg_proc_prosrc, &isnull);
		if (isnull)
			elog(ERROR, "null prosrc");
1469
		proc_source = DatumGetCString(DirectFunctionCall1(textout,
1470
														  prosrcdatum));
1471 1472

		/************************************************************
1473
		 * Create the procedure in the interpreter
1474
		 ************************************************************/
1475 1476
		prodesc->reference = plperl_create_sub(proc_source, prodesc->lanpltrusted);
		pfree(proc_source);
B
Bruce Momjian 已提交
1477
		if (!prodesc->reference)	/* can this happen? */
1478 1479 1480
		{
			free(prodesc->proname);
			free(prodesc);
1481
			elog(ERROR, "could not create internal procedure \"%s\"",
1482
				 internal_proname);
1483 1484
		}

1485
		hv_store(plperl_proc_hash, internal_proname, proname_len,
A
 
Andrew Dunstan 已提交
1486
				 newSVuv( PTR2UV( prodesc)), 0);
1487 1488
	}

1489
	ReleaseSysCache(procTup);
1490

1491 1492
	return prodesc;
}
1493 1494


1495 1496
/* Build a hash from all attributes of a given tuple. */

B
Bruce Momjian 已提交
1497
static SV  *
1498
plperl_hash_from_tuple(HeapTuple tuple, TupleDesc tupdesc)
1499
{
1500
	HV		   *hv;
1501
	int			i;
1502

1503
	hv = newHV();
1504 1505 1506

	for (i = 0; i < tupdesc->natts; i++)
	{
1507 1508 1509 1510 1511 1512 1513
		Datum		attr;
		bool		isnull;
		char	   *attname;
		char	   *outputstr;
		Oid			typoutput;
		bool		typisvarlena;
		int			namelen;
B
Bruce Momjian 已提交
1514
		SV		   *sv;
1515

1516 1517 1518
		if (tupdesc->attrs[i]->attisdropped)
			continue;

1519
		attname = NameStr(tupdesc->attrs[i]->attname);
1520
		namelen = strlen(attname);
1521 1522
		attr = heap_getattr(tuple, i + 1, tupdesc, &isnull);

B
Bruce Momjian 已提交
1523 1524
		if (isnull)
		{
1525 1526
			/* Store (attname => undef) and move on. */
			hv_store(hv, attname, namelen, newSV(0), 0);
1527 1528 1529
			continue;
		}

1530
		/* XXX should have a way to cache these lookups */
1531

1532
		getTypeOutputInfo(tupdesc->attrs[i]->atttypid,
1533
						  &typoutput, &typisvarlena);
1534

1535
		outputstr = OidOutputFunctionCall(typoutput, attr);
1536

1537 1538
		sv = newSVpv(outputstr, 0);
#if PERL_BCDVERSION >= 0x5006000L
1539 1540
		if (GetDatabaseEncoding() == PG_UTF8)
			SvUTF8_on(sv);
1541 1542
#endif
		hv_store(hv, attname, namelen, sv, 0);
1543 1544

		pfree(outputstr);
1545
	}
1546

1547
	return newRV_noinc((SV *) hv);
1548
}
1549 1550 1551 1552 1553 1554 1555


HV *
plperl_spi_exec(char *query, int limit)
{
	HV		   *ret_hv;

1556
	/*
B
Bruce Momjian 已提交
1557 1558
	 * Execute the query inside a sub-transaction, so we can cope with errors
	 * sanely
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
	 */
	MemoryContext oldcontext = CurrentMemoryContext;
	ResourceOwner oldowner = CurrentResourceOwner;

	BeginInternalSubTransaction(NULL);
	/* Want to run inside function's memory context */
	MemoryContextSwitchTo(oldcontext);

	PG_TRY();
	{
		int			spi_rv;

1571
		spi_rv = SPI_execute(query, current_call_data->prodesc->fn_readonly,
1572 1573 1574 1575 1576 1577 1578 1579
							 limit);
		ret_hv = plperl_spi_execute_fetch_result(SPI_tuptable, SPI_processed,
												 spi_rv);

		/* Commit the inner transaction, return to outer xact context */
		ReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;
B
Bruce Momjian 已提交
1580

1581
		/*
B
Bruce Momjian 已提交
1582 1583
		 * AtEOSubXact_SPI() should not have popped any SPI context, but just
		 * in case it did, make sure we remain connected.
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
		 */
		SPI_restore_connection();
	}
	PG_CATCH();
	{
		ErrorData  *edata;

		/* Save error info */
		MemoryContextSwitchTo(oldcontext);
		edata = CopyErrorData();
		FlushErrorState();

		/* Abort the inner transaction */
		RollbackAndReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;

		/*
B
Bruce Momjian 已提交
1602 1603 1604
		 * If AtEOSubXact_SPI() popped any SPI context of the subxact, it will
		 * have left us in a disconnected state.  We need this hack to return
		 * to connected state.
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
		 */
		SPI_restore_connection();

		/* Punt the error to Perl */
		croak("%s", edata->message);

		/* Can't get here, but keep compiler quiet */
		return NULL;
	}
	PG_END_TRY();
1615 1616 1617 1618

	return ret_hv;
}

1619

1620
static HV  *
1621 1622
plperl_spi_execute_fetch_result(SPITupleTable *tuptable, int processed,
								int status)
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
{
	HV		   *result;

	result = newHV();

	hv_store(result, "status", strlen("status"),
			 newSVpv((char *) SPI_result_code_string(status), 0), 0);
	hv_store(result, "processed", strlen("processed"),
			 newSViv(processed), 0);

	if (status == SPI_OK_SELECT)
	{
1635
		AV		   *rows;
1636
		SV		   *row;
1637
		int			i;
1638

1639 1640 1641 1642
		rows = newAV();
		for (i = 0; i < processed; i++)
		{
			row = plperl_hash_from_tuple(tuptable->vals[i], tuptable->tupdesc);
1643
			av_push(rows, row);
1644
		}
1645 1646
		hv_store(result, "rows", strlen("rows"),
				 newRV_noinc((SV *) rows), 0);
1647 1648 1649 1650 1651 1652
	}

	SPI_freetuptable(tuptable);

	return result;
}
1653 1654


1655 1656
/*
 * Note: plperl_return_next is called both in Postgres and Perl contexts.
1657
 * We report any errors in Postgres fashion (via ereport).	If called in
1658 1659 1660 1661 1662
 * Perl context, it is SPI.xs's responsibility to catch the error and
 * convert to a Perl error.  We assume (perhaps without adequate justification)
 * that we need not abort the current transaction if the Perl code traps the
 * error.
 */
1663
void
1664
plperl_return_next(SV *sv)
1665
{
1666 1667 1668 1669
	plperl_proc_desc *prodesc;
	FunctionCallInfo fcinfo;
	ReturnSetInfo *rsi;
	MemoryContext old_cxt;
B
Bruce Momjian 已提交
1670
	HeapTuple	tuple;
1671 1672 1673 1674

	if (!sv)
		return;

1675 1676 1677 1678
	prodesc = current_call_data->prodesc;
	fcinfo = current_call_data->fcinfo;
	rsi = (ReturnSetInfo *) fcinfo->resultinfo;

1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
	if (!prodesc->fn_retisset)
		ereport(ERROR,
				(errcode(ERRCODE_SYNTAX_ERROR),
				 errmsg("cannot use return_next in a non-SETOF function")));

	if (prodesc->fn_retistuple &&
		!(SvOK(sv) && SvTYPE(sv) == SVt_RV && SvTYPE(SvRV(sv)) == SVt_PVHV))
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("setof-composite-returning Perl function "
						"must call return_next with reference to hash")));

1691 1692 1693 1694 1695 1696
	if (!current_call_data->ret_tdesc)
	{
		TupleDesc tupdesc;

		Assert(!current_call_data->tuple_store);
		Assert(!current_call_data->attinmeta);
1697

1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
		/*
		 * This is the first call to return_next in the current
		 * PL/Perl function call, so memoize some lookups
		 */
		if (prodesc->fn_retistuple)
			(void) get_call_result_type(fcinfo, NULL, &tupdesc);
		else
			tupdesc = rsi->expectedDesc;

		/*
		 * Make sure the tuple_store and ret_tdesc are sufficiently
		 * long-lived.
		 */
		old_cxt = MemoryContextSwitchTo(rsi->econtext->ecxt_per_query_memory);

		current_call_data->ret_tdesc = CreateTupleDescCopy(tupdesc);
		current_call_data->tuple_store =
1715
			tuplestore_begin_heap(true, false, work_mem);
1716 1717 1718 1719 1720
		if (prodesc->fn_retistuple)
		{
			current_call_data->attinmeta =
				TupleDescGetAttInMetadata(current_call_data->ret_tdesc);
		}
1721

1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
		MemoryContextSwitchTo(old_cxt);
	}		

	/*
	 * Producing the tuple we want to return requires making plenty of
	 * palloc() allocations that are not cleaned up. Since this
	 * function can be called many times before the current memory
	 * context is reset, we need to do those allocations in a
	 * temporary context.
	 */
	if (!current_call_data->tmp_cxt)
1733
	{
1734 1735 1736 1737 1738 1739 1740 1741 1742
		current_call_data->tmp_cxt =
			AllocSetContextCreate(rsi->econtext->ecxt_per_tuple_memory,
								  "PL/Perl return_next temporary cxt",
								  ALLOCSET_DEFAULT_MINSIZE,
								  ALLOCSET_DEFAULT_INITSIZE,
								  ALLOCSET_DEFAULT_MAXSIZE);
	}

	old_cxt = MemoryContextSwitchTo(current_call_data->tmp_cxt);
1743

1744 1745 1746 1747
	if (prodesc->fn_retistuple)
	{
		tuple = plperl_build_tuple_result((HV *) SvRV(sv),
										  current_call_data->attinmeta);
1748 1749 1750
	}
	else
	{
1751 1752
		Datum		ret;
		bool		isNull;
1753 1754 1755

		if (SvOK(sv) && SvTYPE(sv) != SVt_NULL)
		{
1756
			char	   *val = SvPV(sv, PL_na);
B
Bruce Momjian 已提交
1757

1758 1759
			ret = InputFunctionCall(&prodesc->result_in_func, val,
									prodesc->result_typioparam, -1);
1760 1761
			isNull = false;
		}
1762 1763 1764 1765 1766 1767
		else
		{
			ret = InputFunctionCall(&prodesc->result_in_func, NULL,
									prodesc->result_typioparam, -1);
			isNull = true;
		}
1768

1769
		tuple = heap_form_tuple(current_call_data->ret_tdesc, &ret, &isNull);
1770 1771
	}

1772 1773 1774 1775
	/* Make sure to store the tuple in a long-lived memory context */
	MemoryContextSwitchTo(rsi->econtext->ecxt_per_query_memory);
	tuplestore_puttuple(current_call_data->tuple_store, tuple);
	MemoryContextSwitchTo(old_cxt);
1776

1777
	MemoryContextReset(current_call_data->tmp_cxt);
1778
}
1779 1780 1781 1782 1783


SV *
plperl_spi_query(char *query)
{
B
Bruce Momjian 已提交
1784
	SV		   *cursor;
1785

1786 1787 1788 1789
	/*
	 * Execute the query inside a sub-transaction, so we can cope with errors
	 * sanely
	 */
1790 1791 1792 1793
	MemoryContext oldcontext = CurrentMemoryContext;
	ResourceOwner oldowner = CurrentResourceOwner;

	BeginInternalSubTransaction(NULL);
1794
	/* Want to run inside function's memory context */
1795 1796 1797 1798
	MemoryContextSwitchTo(oldcontext);

	PG_TRY();
	{
B
Bruce Momjian 已提交
1799
		void	   *plan;
A
 
Andrew Dunstan 已提交
1800
		Portal		portal;
1801

1802
		/* Create a cursor for the query */
1803
		plan = SPI_prepare(query, 0, NULL);
A
 
Andrew Dunstan 已提交
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
		if ( plan == NULL)
			elog(ERROR, "SPI_prepare() failed:%s",
				SPI_result_code_string(SPI_result));

		portal = SPI_cursor_open(NULL, plan, NULL, NULL, false);
		SPI_freeplan( plan);
		if ( portal == NULL) 
			elog(ERROR, "SPI_cursor_open() failed:%s",
				SPI_result_code_string(SPI_result));
		cursor = newSVpv(portal->name, 0);
1814

1815
		/* Commit the inner transaction, return to outer xact context */
1816 1817 1818
		ReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;
1819 1820 1821 1822 1823

		/*
		 * AtEOSubXact_SPI() should not have popped any SPI context, but just
		 * in case it did, make sure we remain connected.
		 */
1824 1825 1826 1827 1828 1829
		SPI_restore_connection();
	}
	PG_CATCH();
	{
		ErrorData  *edata;

1830
		/* Save error info */
1831 1832 1833 1834
		MemoryContextSwitchTo(oldcontext);
		edata = CopyErrorData();
		FlushErrorState();

1835
		/* Abort the inner transaction */
1836 1837 1838 1839
		RollbackAndReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;

1840 1841 1842 1843 1844
		/*
		 * If AtEOSubXact_SPI() popped any SPI context of the subxact, it will
		 * have left us in a disconnected state.  We need this hack to return
		 * to connected state.
		 */
1845
		SPI_restore_connection();
1846 1847

		/* Punt the error to Perl */
1848
		croak("%s", edata->message);
1849 1850

		/* Can't get here, but keep compiler quiet */
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
		return NULL;
	}
	PG_END_TRY();

	return cursor;
}


SV *
plperl_spi_fetchrow(char *cursor)
{
1862 1863 1864 1865 1866 1867 1868 1869
	SV		   *row;

	/*
	 * Execute the FETCH inside a sub-transaction, so we can cope with errors
	 * sanely
	 */
	MemoryContext oldcontext = CurrentMemoryContext;
	ResourceOwner oldowner = CurrentResourceOwner;
1870

1871 1872 1873
	BeginInternalSubTransaction(NULL);
	/* Want to run inside function's memory context */
	MemoryContextSwitchTo(oldcontext);
1874

1875
	PG_TRY();
B
Bruce Momjian 已提交
1876
	{
1877 1878 1879
		Portal		p = SPI_cursor_find(cursor);

		if (!p)
A
 
Andrew Dunstan 已提交
1880 1881 1882
		{
			row = &PL_sv_undef;
		}
1883 1884 1885 1886 1887 1888
		else
		{
			SPI_cursor_fetch(p, true, 1);
			if (SPI_processed == 0)
			{
				SPI_cursor_close(p);
A
 
Andrew Dunstan 已提交
1889
				row = &PL_sv_undef;
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
			}
			else
			{
				row = plperl_hash_from_tuple(SPI_tuptable->vals[0],
											 SPI_tuptable->tupdesc);
			}
			SPI_freetuptable(SPI_tuptable);
		}

		/* Commit the inner transaction, return to outer xact context */
		ReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;

		/*
		 * AtEOSubXact_SPI() should not have popped any SPI context, but just
		 * in case it did, make sure we remain connected.
		 */
		SPI_restore_connection();
1909
	}
1910 1911 1912
	PG_CATCH();
	{
		ErrorData  *edata;
1913

1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937
		/* Save error info */
		MemoryContextSwitchTo(oldcontext);
		edata = CopyErrorData();
		FlushErrorState();

		/* Abort the inner transaction */
		RollbackAndReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;

		/*
		 * If AtEOSubXact_SPI() popped any SPI context of the subxact, it will
		 * have left us in a disconnected state.  We need this hack to return
		 * to connected state.
		 */
		SPI_restore_connection();

		/* Punt the error to Perl */
		croak("%s", edata->message);

		/* Can't get here, but keep compiler quiet */
		return NULL;
	}
	PG_END_TRY();
1938 1939 1940

	return row;
}
A
 
Andrew Dunstan 已提交
1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981

void
plperl_spi_cursor_close(char *cursor)
{
	Portal p = SPI_cursor_find(cursor);
	if (p)
		SPI_cursor_close(p);
}

SV *
plperl_spi_prepare(char* query, int argc, SV ** argv)
{
	plperl_query_desc *qdesc;
	void	   *plan;
	int			i;

	MemoryContext oldcontext = CurrentMemoryContext;
	ResourceOwner oldowner = CurrentResourceOwner;

	BeginInternalSubTransaction(NULL);
	MemoryContextSwitchTo(oldcontext);

	/************************************************************
	 * Allocate the new querydesc structure
	 ************************************************************/
	qdesc = (plperl_query_desc *) malloc(sizeof(plperl_query_desc));
	MemSet(qdesc, 0, sizeof(plperl_query_desc));
	snprintf(qdesc-> qname, sizeof(qdesc-> qname), "%lx", (long) qdesc);
	qdesc-> nargs = argc;
	qdesc-> argtypes = (Oid *) malloc(argc * sizeof(Oid));
	qdesc-> arginfuncs = (FmgrInfo *) malloc(argc * sizeof(FmgrInfo));
	qdesc-> argtypioparams = (Oid *) malloc(argc * sizeof(Oid));

	PG_TRY();
	{
		/************************************************************
		 * Lookup the argument types by name in the system cache
		 * and remember the required information for input conversion
		 ************************************************************/
		for (i = 0; i < argc; i++)
		{
1982 1983 1984 1985 1986 1987 1988
			List	   *names;
			HeapTuple	typeTup;

			/* Parse possibly-qualified type name and look it up in pg_type */
			names = stringToQualifiedNameList(SvPV(argv[i], PL_na),
											  "plperl_spi_prepare");
			typeTup = typenameType(NULL, makeTypeNameFromNameList(names));
A
 
Andrew Dunstan 已提交
1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122
			qdesc->argtypes[i] = HeapTupleGetOid(typeTup);
			perm_fmgr_info(((Form_pg_type) GETSTRUCT(typeTup))->typinput,
						   &(qdesc->arginfuncs[i]));
			qdesc->argtypioparams[i] = getTypeIOParam(typeTup);
			ReleaseSysCache(typeTup);
		}

		/************************************************************
		 * Prepare the plan and check for errors
		 ************************************************************/
		plan = SPI_prepare(query, argc, qdesc->argtypes);

		if (plan == NULL)
			elog(ERROR, "SPI_prepare() failed:%s",
				SPI_result_code_string(SPI_result));

		/************************************************************
		 * Save the plan into permanent memory (right now it's in the
		 * SPI procCxt, which will go away at function end).
		 ************************************************************/
		qdesc->plan = SPI_saveplan(plan);
		if (qdesc->plan == NULL)
			elog(ERROR, "SPI_saveplan() failed: %s", 
				SPI_result_code_string(SPI_result));

		/* Release the procCxt copy to avoid within-function memory leak */
		SPI_freeplan(plan);

		/* Commit the inner transaction, return to outer xact context */
		ReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;
		/*
		 * AtEOSubXact_SPI() should not have popped any SPI context,
		 * but just in case it did, make sure we remain connected.
		 */
		SPI_restore_connection();
	}
	PG_CATCH();
	{
		ErrorData  *edata;
		
		free(qdesc-> argtypes);
		free(qdesc-> arginfuncs);
		free(qdesc-> argtypioparams);
		free(qdesc);

		/* Save error info */
		MemoryContextSwitchTo(oldcontext);
		edata = CopyErrorData();
		FlushErrorState();

		/* Abort the inner transaction */
		RollbackAndReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;

		/*
		 * If AtEOSubXact_SPI() popped any SPI context of the subxact,
		 * it will have left us in a disconnected state.  We need this
		 * hack to return to connected state.
		 */
		SPI_restore_connection();

		/* Punt the error to Perl */
		croak("%s", edata->message);

		/* Can't get here, but keep compiler quiet */
		return NULL;
	}
	PG_END_TRY();

	/************************************************************
	 * Insert a hashtable entry for the plan and return
	 * the key to the caller.
	 ************************************************************/
	hv_store( plperl_query_hash, qdesc->qname, strlen(qdesc->qname), newSVuv( PTR2UV( qdesc)), 0);

	return newSVpv( qdesc->qname, strlen(qdesc->qname));
}	

HV *
plperl_spi_exec_prepared(char* query, HV * attr, int argc, SV ** argv)
{
	HV		   *ret_hv;
	SV **sv;
	int i, limit, spi_rv;
	char * nulls;
	Datum	   *argvalues;
	plperl_query_desc *qdesc;

	/*
	 * Execute the query inside a sub-transaction, so we can cope with
	 * errors sanely
	 */
	MemoryContext oldcontext = CurrentMemoryContext;
	ResourceOwner oldowner = CurrentResourceOwner;

	BeginInternalSubTransaction(NULL);
	/* Want to run inside function's memory context */
	MemoryContextSwitchTo(oldcontext);

	PG_TRY();
	{
		/************************************************************
		 * Fetch the saved plan descriptor, see if it's o.k.
		 ************************************************************/
		sv = hv_fetch(plperl_query_hash, query, strlen(query), 0);
		if ( sv == NULL) 
			elog(ERROR, "spi_exec_prepared: Invalid prepared query passed");
		if ( *sv == NULL || !SvOK( *sv))
			elog(ERROR, "spi_exec_prepared: panic - plperl_query_hash value corrupted");

		qdesc = INT2PTR( plperl_query_desc *, SvUV(*sv));
		if ( qdesc == NULL)
			elog(ERROR, "spi_exec_prepared: panic - plperl_query_hash value vanished");

		if ( qdesc-> nargs != argc) 
			elog(ERROR, "spi_exec_prepared: expected %d argument(s), %d passed", 
				qdesc-> nargs, argc);
		
		/************************************************************
		 * Parse eventual attributes
		 ************************************************************/
		limit = 0;
		if ( attr != NULL) 
		{
			sv = hv_fetch( attr, "limit", 5, 0);
			if ( *sv && SvIOK( *sv))
				limit = SvIV( *sv);
		}
		/************************************************************
		 * Set up arguments
		 ************************************************************/
2123
		if (argc > 0) 
A
 
Andrew Dunstan 已提交
2124
		{
2125
			nulls = (char *) palloc(argc);
A
 
Andrew Dunstan 已提交
2126 2127 2128 2129 2130 2131 2132 2133
			argvalues = (Datum *) palloc(argc * sizeof(Datum));
		} 
		else 
		{
			nulls = NULL;
			argvalues = NULL;
		}

2134
		for (i = 0; i < argc; i++) 
A
 
Andrew Dunstan 已提交
2135
		{
2136
			if (SvTYPE(argv[i]) != SVt_NULL) 
A
 
Andrew Dunstan 已提交
2137
			{
2138 2139 2140 2141
				argvalues[i] = InputFunctionCall(&qdesc->arginfuncs[i],
												 SvPV(argv[i], PL_na),
												 qdesc->argtypioparams[i],
												 -1);
A
 
Andrew Dunstan 已提交
2142 2143 2144 2145
				nulls[i] = ' ';
			} 
			else 
			{
2146 2147 2148 2149
				argvalues[i] = InputFunctionCall(&qdesc->arginfuncs[i],
												 NULL,
												 qdesc->argtypioparams[i],
												 -1);
A
 
Andrew Dunstan 已提交
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252
				nulls[i] = 'n';
			}
		}

		/************************************************************
		 * go
		 ************************************************************/
		spi_rv = SPI_execute_plan(qdesc-> plan, argvalues, nulls, 
							 current_call_data->prodesc->fn_readonly, limit);
		ret_hv = plperl_spi_execute_fetch_result(SPI_tuptable, SPI_processed,
												 spi_rv);
		if ( argc > 0) 
		{
			pfree( argvalues);
			pfree( nulls);
		}

		/* Commit the inner transaction, return to outer xact context */
		ReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;
		/*
		 * AtEOSubXact_SPI() should not have popped any SPI context,
		 * but just in case it did, make sure we remain connected.
		 */
		SPI_restore_connection();
	}
	PG_CATCH();
	{
		ErrorData  *edata;

		/* Save error info */
		MemoryContextSwitchTo(oldcontext);
		edata = CopyErrorData();
		FlushErrorState();

		/* Abort the inner transaction */
		RollbackAndReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;

		/*
		 * If AtEOSubXact_SPI() popped any SPI context of the subxact,
		 * it will have left us in a disconnected state.  We need this
		 * hack to return to connected state.
		 */
		SPI_restore_connection();

		/* Punt the error to Perl */
		croak("%s", edata->message);

		/* Can't get here, but keep compiler quiet */
		return NULL;
	}
	PG_END_TRY();

	return ret_hv;
}

SV *
plperl_spi_query_prepared(char* query, int argc, SV ** argv)
{
	SV **sv;
	int i;
	char * nulls;
	Datum	   *argvalues;
	plperl_query_desc *qdesc;
	SV *cursor;
	Portal portal = NULL;

	/*
	 * Execute the query inside a sub-transaction, so we can cope with
	 * errors sanely
	 */
	MemoryContext oldcontext = CurrentMemoryContext;
	ResourceOwner oldowner = CurrentResourceOwner;

	BeginInternalSubTransaction(NULL);
	/* Want to run inside function's memory context */
	MemoryContextSwitchTo(oldcontext);

	PG_TRY();
	{
		/************************************************************
		 * Fetch the saved plan descriptor, see if it's o.k.
		 ************************************************************/
		sv = hv_fetch(plperl_query_hash, query, strlen(query), 0);
		if ( sv == NULL) 
			elog(ERROR, "spi_query_prepared: Invalid prepared query passed");
		if ( *sv == NULL || !SvOK( *sv))
			elog(ERROR, "spi_query_prepared: panic - plperl_query_hash value corrupted");

		qdesc = INT2PTR( plperl_query_desc *, SvUV(*sv));
		if ( qdesc == NULL)
			elog(ERROR, "spi_query_prepared: panic - plperl_query_hash value vanished");

		if ( qdesc-> nargs != argc) 
			elog(ERROR, "spi_query_prepared: expected %d argument(s), %d passed", 
				qdesc-> nargs, argc);
		
		/************************************************************
		 * Set up arguments
		 ************************************************************/
2253
		if (argc > 0) 
A
 
Andrew Dunstan 已提交
2254
		{
2255
			nulls = (char *) palloc(argc);
A
 
Andrew Dunstan 已提交
2256 2257 2258 2259 2260 2261 2262 2263
			argvalues = (Datum *) palloc(argc * sizeof(Datum));
		} 
		else 
		{
			nulls = NULL;
			argvalues = NULL;
		}

2264
		for (i = 0; i < argc; i++) 
A
 
Andrew Dunstan 已提交
2265
		{
2266
			if (SvTYPE(argv[i]) != SVt_NULL) 
A
 
Andrew Dunstan 已提交
2267
			{
2268 2269 2270 2271
				argvalues[i] = InputFunctionCall(&qdesc->arginfuncs[i],
												 SvPV(argv[i], PL_na),
												 qdesc->argtypioparams[i],
												 -1);
A
 
Andrew Dunstan 已提交
2272 2273 2274 2275
				nulls[i] = ' ';
			} 
			else 
			{
2276 2277 2278 2279
				argvalues[i] = InputFunctionCall(&qdesc->arginfuncs[i],
												 NULL,
												 qdesc->argtypioparams[i],
												 -1);
A
 
Andrew Dunstan 已提交
2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370
				nulls[i] = 'n';
			}
		}

		/************************************************************
		 * go
		 ************************************************************/
		portal = SPI_cursor_open(NULL, qdesc-> plan, argvalues, nulls, 
							current_call_data->prodesc->fn_readonly);
		if ( argc > 0) 
		{
			pfree( argvalues);
			pfree( nulls);
		}
		if ( portal == NULL) 
			elog(ERROR, "SPI_cursor_open() failed:%s",
				SPI_result_code_string(SPI_result));

		cursor = newSVpv(portal->name, 0);

		/* Commit the inner transaction, return to outer xact context */
		ReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;
		/*
		 * AtEOSubXact_SPI() should not have popped any SPI context,
		 * but just in case it did, make sure we remain connected.
		 */
		SPI_restore_connection();
	}
	PG_CATCH();
	{
		ErrorData  *edata;

		/* Save error info */
		MemoryContextSwitchTo(oldcontext);
		edata = CopyErrorData();
		FlushErrorState();

		/* Abort the inner transaction */
		RollbackAndReleaseCurrentSubTransaction();
		MemoryContextSwitchTo(oldcontext);
		CurrentResourceOwner = oldowner;

		/*
		 * If AtEOSubXact_SPI() popped any SPI context of the subxact,
		 * it will have left us in a disconnected state.  We need this
		 * hack to return to connected state.
		 */
		SPI_restore_connection();

		/* Punt the error to Perl */
		croak("%s", edata->message);

		/* Can't get here, but keep compiler quiet */
		return NULL;
	}
	PG_END_TRY();

	return cursor;
}

void
plperl_spi_freeplan(char *query)
{
	SV ** sv;
	void * plan;
	plperl_query_desc *qdesc;

	sv = hv_fetch(plperl_query_hash, query, strlen(query), 0);
	if ( sv == NULL) 
		elog(ERROR, "spi_exec_freeplan: Invalid prepared query passed");
	if ( *sv == NULL || !SvOK( *sv))
		elog(ERROR, "spi_exec_freeplan: panic - plperl_query_hash value corrupted");

	qdesc = INT2PTR( plperl_query_desc *, SvUV(*sv));
	if ( qdesc == NULL)
		elog(ERROR, "spi_exec_freeplan: panic - plperl_query_hash value vanished");

	/*
	*	free all memory before SPI_freeplan, so if it dies, nothing will be left over
	*/
	hv_delete(plperl_query_hash, query, strlen(query), G_DISCARD);
	plan = qdesc-> plan;
	free(qdesc-> argtypes);
	free(qdesc-> arginfuncs);
	free(qdesc-> argtypioparams);
	free(qdesc);

	SPI_freeplan( plan);
}