-
Notifications
You must be signed in to change notification settings - Fork 42
/
plr.h
executable file
·471 lines (420 loc) · 13.5 KB
/
plr.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
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
284
285
286
287
288
289
290
291
292
293
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
/*
* PL/R - PostgreSQL support for R as a
* procedural language (PL)
*
* Copyright (c) 2003-2006 by Joseph E. Conway
* ALL RIGHTS RESERVED
*
* Joe Conway <mail@joeconway.com>
*
* Based on pltcl by Jan Wieck
* and inspired by REmbeddedPostgres by
* Duncan Temple Lang <duncan@research.bell-labs.com>
* http://www.omegahat.org/RSPostgres/
*
* License: GPL version 2 or newer. http://www.gnu.org/copyleft/gpl.html
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* plr.h
*/
#ifndef PLR_H
#define PLR_H
#include <unistd.h>
#include <fcntl.h>
#include <setjmp.h>
#include <sys/stat.h>
#define ELOG_H
#include "postgres.h"
#include "fmgr.h"
#include "funcapi.h"
#include "access/heapam.h"
#include "catalog/catversion.h"
#include "catalog/pg_language.h"
#include "catalog/pg_proc.h"
#include "catalog/pg_type.h"
#include "commands/trigger.h"
#include "executor/spi.h"
#include "lib/stringinfo.h"
#include "nodes/makefuncs.h"
#include "parser/parse_type.h"
#include "tcop/tcopprot.h"
#include "utils/array.h"
#include "utils/builtins.h"
#include "utils/lsyscache.h"
#include "utils/syscache.h"
#include "R.h"
#include "Rinternals.h"
#include "Rdefines.h"
#include "Rdevices.h"
#include "Rversion.h"
#ifdef ERROR
#undef ERROR
#endif
#ifdef WARNING
#undef WARNING
#endif
#undef ELOG_H
#include "utils/elog.h"
/* working with postgres 7.3 compatible sources */
#if (CATALOG_VERSION_NO <= 200510211)
#error "This version of PL/R only builds with PostgreSQL 8.2"
#else
#define PG_VERSION_82_COMPAT
#endif
#ifdef DEBUGPROTECT
#undef PROTECT
#define PROTECT(s) \
do { \
elog(NOTICE, "\tPROTECT\t1\t%s\t%d", __FILE__, __LINE__); \
protect(s); \
} while (0)
#undef UNPROTECT
#define UNPROTECT(n) \
do { \
elog(NOTICE, "\tUNPROTECT\t%d\t%s\t%d", n, __FILE__, __LINE__); \
unprotect(n); \
} while (0)
#endif /* DEBUGPROTECT */
#define xpfree(var_) \
do { \
if (var_ != NULL) \
{ \
pfree(var_); \
var_ = NULL; \
} \
} while (0)
#define freeStringInfo(mystr_) \
do { \
xpfree((mystr_)->data); \
xpfree(mystr_); \
} while (0)
#define resetStringInfo(mystr_) \
do { \
xpfree((mystr_)->data); \
initStringInfo(mystr_); \
} while (0)
#define NEXT_STR_ELEMENT " %s"
/*
* R version is calculated thus:
* Maj * 65536 + Minor * 256 + Build * 1
* So:
* version 1.8.0 results in:
* (1 * 65536) + (8 * 256) + (0 * 1) == 67584
* version 1.9.0 results in:
* (1 * 65536) + (9 * 256) + (0 * 1) == 67840
*/
#if (R_VERSION < 67840) /* R_VERSION < 1.9.0 */
#define SET_COLUMN_NAMES \
do { \
int i; \
char *names_buf; \
names_buf = SPI_fname(tupdesc, j + 1); \
for (i = 0; i < strlen(names_buf); i++) { \
if (names_buf[i] == '_') \
names_buf[i] = '.'; \
} \
SET_STRING_ELT(names, df_colnum, mkChar(names_buf)); \
pfree(names_buf); \
} while (0)
#else /* R_VERSION >= 1.9.0 */
#define SET_COLUMN_NAMES \
do { \
char *names_buf; \
names_buf = SPI_fname(tupdesc, j + 1); \
SET_STRING_ELT(names, df_colnum, mkChar(names_buf)); \
pfree(names_buf); \
} while (0)
#endif
#if (R_VERSION < 67584) /* R_VERSION < 1.8.0 */
/*
* See the non-exported header file ${R_HOME}/src/include/Parse.h
*/
extern SEXP R_ParseVector(SEXP, int, int *);
#define PARSE_NULL 0
#define PARSE_OK 1
#define PARSE_INCOMPLETE 2
#define PARSE_ERROR 3
#define PARSE_EOF 4
#define R_PARSEVECTOR(a_, b_, c_) R_ParseVector(a_, b_, c_)
/*
* See the non-exported header file ${R_HOME}/src/include/Defn.h
*/
extern void R_PreserveObject(SEXP);
extern void R_ReleaseObject(SEXP);
/* in main.c */
extern void R_dot_Last(void);
/* in memory.c */
extern void R_RunExitFinalizers(void);
#else /* R_VERSION >= 1.8.0 */
#include "R_ext/Parse.h"
#define R_PARSEVECTOR(a_, b_, c_) R_ParseVector(a_, b_, (ParseStatus *) c_)
#endif /* R_VERSION */
/* convert C string to text pointer */
#define PG_TEXT_GET_STR(textp_) \
DatumGetCString(DirectFunctionCall1(textout, PointerGetDatum(textp_)))
#define PG_STR_GET_TEXT(str_) \
DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(str_)))
#define PG_REPLACE_STR(str_, substr_, replacestr_) \
PG_TEXT_GET_STR(DirectFunctionCall3(replace_text, \
PG_STR_GET_TEXT(str_), \
PG_STR_GET_TEXT(substr_), \
PG_STR_GET_TEXT(replacestr_)))
/* initial number of hash table entries for compiled functions */
#define FUNCS_PER_USER 64
#define ERRORCONTEXTCALLBACK \
ErrorContextCallback plerrcontext
#define PUSH_PLERRCONTEXT(_error_callback_, _plr_error_funcname_) \
do { \
plerrcontext.callback = _error_callback_; \
plerrcontext.arg = (void *) pstrdup(_plr_error_funcname_); \
plerrcontext.previous = error_context_stack; \
error_context_stack = &plerrcontext; \
} while (0)
#define POP_PLERRCONTEXT \
do { \
error_context_stack = plerrcontext.previous; \
} while (0)
#define SAVE_PLERRCONTEXT \
ErrorContextCallback *ecs_save; \
do { \
ecs_save = error_context_stack; \
error_context_stack = NULL; \
} while (0)
#define RESTORE_PLERRCONTEXT \
do { \
error_context_stack = ecs_save; \
} while (0)
#ifndef TEXTARRAYOID
#define TEXTARRAYOID 1009
#endif
#define TRIGGER_NARGS 9
#define TUPLESTORE_BEGIN_HEAP tuplestore_begin_heap(true, false, work_mem)
#define INIT_AUX_FMGR_ATTS \
do { \
finfo->fn_mcxt = QueryContext; \
finfo->fn_expr = (Node *) NULL; \
} while (0)
#define PROARGTYPES(i) \
procStruct->proargtypes.values[i]
#define FUNCARGTYPES(_tup_) \
((Form_pg_proc) GETSTRUCT(_tup_))->proargtypes.values
#define PLR_CLEANUP \
plr_cleanup(int code, Datum arg)
#define TRIGGERTUPLEVARS \
HeapTuple tup; \
HeapTupleHeader dnewtup; \
HeapTupleHeader dtrigtup
#define SET_INSERT_ARGS_567 \
do { \
arg[5] = DirectFunctionCall1(textin, CStringGetDatum("INSERT")); \
tup = trigdata->tg_trigtuple; \
dtrigtup = (HeapTupleHeader) palloc(tup->t_len); \
memcpy((char *) dtrigtup, (char *) tup->t_data, tup->t_len); \
HeapTupleHeaderSetDatumLength(dtrigtup, tup->t_len); \
HeapTupleHeaderSetTypeId(dtrigtup, tupdesc->tdtypeid); \
HeapTupleHeaderSetTypMod(dtrigtup, tupdesc->tdtypmod); \
arg[6] = PointerGetDatum(dtrigtup); \
argnull[6] = false; \
arg[7] = (Datum) 0; \
argnull[7] = true; \
} while (0)
#define SET_DELETE_ARGS_567 \
do { \
arg[5] = DirectFunctionCall1(textin, CStringGetDatum("DELETE")); \
arg[6] = (Datum) 0; \
argnull[6] = true; \
tup = trigdata->tg_trigtuple; \
dtrigtup = (HeapTupleHeader) palloc(tup->t_len); \
memcpy((char *) dtrigtup, (char *) tup->t_data, tup->t_len); \
HeapTupleHeaderSetDatumLength(dtrigtup, tup->t_len); \
HeapTupleHeaderSetTypeId(dtrigtup, tupdesc->tdtypeid); \
HeapTupleHeaderSetTypMod(dtrigtup, tupdesc->tdtypmod); \
arg[7] = PointerGetDatum(dtrigtup); \
argnull[7] = false; \
} while (0)
#define SET_UPDATE_ARGS_567 \
do { \
arg[5] = DirectFunctionCall1(textin, CStringGetDatum("UPDATE")); \
tup = trigdata->tg_newtuple; \
dnewtup = (HeapTupleHeader) palloc(tup->t_len); \
memcpy((char *) dnewtup, (char *) tup->t_data, tup->t_len); \
HeapTupleHeaderSetDatumLength(dnewtup, tup->t_len); \
HeapTupleHeaderSetTypeId(dnewtup, tupdesc->tdtypeid); \
HeapTupleHeaderSetTypMod(dnewtup, tupdesc->tdtypmod); \
arg[6] = PointerGetDatum(dnewtup); \
argnull[6] = false; \
tup = trigdata->tg_trigtuple; \
dtrigtup = (HeapTupleHeader) palloc(tup->t_len); \
memcpy((char *) dtrigtup, (char *) tup->t_data, tup->t_len); \
HeapTupleHeaderSetDatumLength(dtrigtup, tup->t_len); \
HeapTupleHeaderSetTypeId(dtrigtup, tupdesc->tdtypeid); \
HeapTupleHeaderSetTypMod(dtrigtup, tupdesc->tdtypmod); \
arg[7] = PointerGetDatum(dtrigtup); \
argnull[7] = false; \
} while (0)
#define CONVERT_TUPLE_TO_DATAFRAME \
do { \
Oid tupType; \
int32 tupTypmod; \
TupleDesc tupdesc; \
HeapTuple tuple = palloc(sizeof(HeapTupleData)); \
HeapTupleHeader tuple_hdr = DatumGetHeapTupleHeader(arg[i]); \
tupType = HeapTupleHeaderGetTypeId(tuple_hdr); \
tupTypmod = HeapTupleHeaderGetTypMod(tuple_hdr); \
tupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod); \
tuple->t_len = HeapTupleHeaderGetDatumLength(tuple_hdr); \
ItemPointerSetInvalid(&(tuple->t_self)); \
tuple->t_tableOid = InvalidOid; \
tuple->t_data = tuple_hdr; \
PROTECT(el = pg_tuple_get_r_frame(1, &tuple, tupdesc)); \
ReleaseTupleDesc(tupdesc); \
pfree(tuple); \
} while (0)
#define GET_ARG_NAMES \
char **argnames; \
argnames = fetchArgNames(procTup, procStruct->pronargs)
#define SET_ARG_NAME \
do { \
if (argnames && argnames[i] && argnames[i][0]) \
{ \
appendStringInfo(proc_internal_args, "%s", argnames[i]); \
pfree(argnames[i]); \
} \
else \
appendStringInfo(proc_internal_args, "arg%d", i + 1); \
} while (0)
#define FREE_ARG_NAMES \
do { \
if (argnames) \
pfree(argnames); \
} while (0)
#define PREPARE_PG_TRY \
ERRORCONTEXTCALLBACK
#define PLR_PG_CATCH() \
PG_CATCH(); \
{ \
ErrorData *edata; \
MemoryContextSwitchTo(plr_SPI_context); \
edata = CopyErrorData(); \
error("error in SQL statement : %s", edata->message); \
}
#define PLR_PG_END_TRY() \
PG_END_TRY()
/*
* structs
*/
typedef struct plr_func_hashkey
{ /* Hash lookup key for functions */
Oid funcOid;
/*
* For a trigger function, the OID of the relation triggered on is part
* of the hashkey --- we want to compile the trigger separately for each
* relation it is used with, in case the rowtype is different. Zero if
* not called as a trigger.
*/
Oid trigrelOid;
/*
* We include actual argument types in the hash key to support
* polymorphic PLpgSQL functions. Be careful that extra positions
* are zeroed!
*/
Oid argtypes[FUNC_MAX_ARGS];
} plr_func_hashkey;
/* The information we cache about loaded procedures */
typedef struct plr_function
{
char *proname;
TransactionId fn_xmin;
CommandId fn_cmin;
plr_func_hashkey *fn_hashkey; /* back-link to hashtable key */
bool lanpltrusted;
Oid result_typid;
bool result_istuple;
FmgrInfo result_in_func;
Oid result_elem;
FmgrInfo result_elem_in_func;
int result_elem_typlen;
bool result_elem_typbyval;
char result_elem_typalign;
int result_natts;
Oid *result_fld_elem_typid;
FmgrInfo *result_fld_elem_in_func;
int *result_fld_elem_typlen;
bool *result_fld_elem_typbyval;
char *result_fld_elem_typalign;
int nargs;
Oid arg_typid[FUNC_MAX_ARGS];
FmgrInfo arg_out_func[FUNC_MAX_ARGS];
Oid arg_elem[FUNC_MAX_ARGS];
FmgrInfo arg_elem_out_func[FUNC_MAX_ARGS];
int arg_elem_typlen[FUNC_MAX_ARGS];
bool arg_elem_typbyval[FUNC_MAX_ARGS];
char arg_elem_typalign[FUNC_MAX_ARGS];
int arg_is_rel[FUNC_MAX_ARGS];
SEXP fun; /* compiled R function */
} plr_function;
/* compiled function hash table */
typedef struct plr_hashent
{
plr_func_hashkey key;
plr_function *function;
} plr_HashEnt;
/*
* external declarations
*/
/* libR interpreter initialization */
extern int Rf_initEmbeddedR(int argc, char **argv);
/* PL/R language handler */
extern Datum plr_call_handler(PG_FUNCTION_ARGS);
extern void PLR_CLEANUP;
extern void plr_init(void);
extern void plr_load_modules(MemoryContext plr_SPI_context);
extern void load_r_cmd(const char *cmd);
extern SEXP call_r_func(SEXP fun, SEXP rargs);
/* argument and return value conversion functions */
extern SEXP pg_scalar_get_r(Datum dvalue, Oid arg_typid, FmgrInfo arg_out_func);
extern SEXP pg_array_get_r(Datum dvalue, FmgrInfo out_func, int typlen, bool typbyval, char typalign);
extern SEXP pg_tuple_get_r_frame(int ntuples, HeapTuple *tuples, TupleDesc tupdesc);
extern Datum r_get_pg(SEXP rval, plr_function *function, FunctionCallInfo fcinfo);
extern Datum get_scalar_datum(SEXP rval, FmgrInfo result_in_func, Oid result_elem, bool *isnull);
/* Postgres support functions installed into the R interpreter */
extern void throw_pg_notice(const char **msg);
extern SEXP plr_quote_literal(SEXP rawstr);
extern SEXP plr_quote_ident(SEXP rawstr);
extern SEXP plr_SPI_exec(SEXP rsql);
extern SEXP plr_SPI_prepare(SEXP rsql, SEXP rargtypes);
extern SEXP plr_SPI_execp(SEXP rsaved_plan, SEXP rargvalues);
extern SEXP plr_SPI_lastoid(void);
extern void throw_r_error(const char **msg);
/* Postgres callable functions useful in conjunction with PL/R */
extern Datum reload_plr_modules(PG_FUNCTION_ARGS);
extern Datum install_rcmd(PG_FUNCTION_ARGS);
extern Datum plr_array_push(PG_FUNCTION_ARGS);
extern Datum plr_array(PG_FUNCTION_ARGS);
extern Datum plr_array_accum(PG_FUNCTION_ARGS);
extern Datum plr_environ(PG_FUNCTION_ARGS);
/* Postgres backend support functions */
extern void compute_function_hashkey(FunctionCallInfo fcinfo,
Form_pg_proc procStruct,
plr_func_hashkey *hashkey);
extern void plr_HashTableInit(void);
extern plr_function *plr_HashTableLookup(plr_func_hashkey *func_key);
extern void plr_HashTableInsert(plr_function *function,
plr_func_hashkey *func_key);
extern void plr_HashTableDelete(plr_function *function);
extern char *get_load_self_ref_cmd(Oid funcid);
extern void perm_fmgr_info(Oid functionId, FmgrInfo *finfo);
#endif /* PLR_H */