PostgreSQL Source Code  git master
spi.c File Reference
#include "postgres.h"
#include "access/htup_details.h"
#include "access/printtup.h"
#include "access/sysattr.h"
#include "access/xact.h"
#include "catalog/heap.h"
#include "catalog/pg_type.h"
#include "commands/trigger.h"
#include "executor/executor.h"
#include "executor/spi_priv.h"
#include "tcop/pquery.h"
#include "tcop/utility.h"
#include "utils/builtins.h"
#include "utils/datum.h"
#include "utils/lsyscache.h"
#include "utils/memutils.h"
#include "utils/rel.h"
#include "utils/snapmgr.h"
#include "utils/syscache.h"
#include "utils/typcache.h"
Include dependency graph for spi.c:

Go to the source code of this file.

Data Structures

struct  SPICallbackArg
 

Typedefs

typedef struct SPICallbackArg SPICallbackArg
 

Functions

static Portal SPI_cursor_open_internal (const char *name, SPIPlanPtr plan, ParamListInfo paramLI, bool read_only)
 
static void _SPI_prepare_plan (const char *src, SPIPlanPtr plan)
 
static void _SPI_prepare_oneshot_plan (const char *src, SPIPlanPtr plan)
 
static int _SPI_execute_plan (SPIPlanPtr plan, const SPIExecuteOptions *options, Snapshot snapshot, Snapshot crosscheck_snapshot, bool fire_triggers)
 
static ParamListInfo _SPI_convert_params (int nargs, Oid *argtypes, Datum *Values, const char *Nulls)
 
static int _SPI_pquery (QueryDesc *queryDesc, bool fire_triggers, uint64 tcount)
 
static void _SPI_error_callback (void *arg)
 
static void _SPI_cursor_operation (Portal portal, FetchDirection direction, long count, DestReceiver *dest)
 
static SPIPlanPtr _SPI_make_plan_non_temp (SPIPlanPtr plan)
 
static SPIPlanPtr _SPI_save_plan (SPIPlanPtr plan)
 
static int _SPI_begin_call (bool use_exec)
 
static int _SPI_end_call (bool use_exec)
 
static MemoryContext _SPI_execmem (void)
 
static MemoryContext _SPI_procmem (void)
 
static bool _SPI_checktuples (void)
 
int SPI_connect (void)
 
int SPI_connect_ext (int options)
 
int SPI_finish (void)
 
void SPI_start_transaction (void)
 
static void _SPI_commit (bool chain)
 
void SPI_commit (void)
 
void SPI_commit_and_chain (void)
 
static void _SPI_rollback (bool chain)
 
void SPI_rollback (void)
 
void SPI_rollback_and_chain (void)
 
void AtEOXact_SPI (bool isCommit)
 
void AtEOSubXact_SPI (bool isCommit, SubTransactionId mySubid)
 
bool SPI_inside_nonatomic_context (void)
 
int SPI_execute (const char *src, bool read_only, long tcount)
 
int SPI_exec (const char *src, long tcount)
 
int SPI_execute_extended (const char *src, const SPIExecuteOptions *options)
 
int SPI_execute_plan (SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only, long tcount)
 
int SPI_execp (SPIPlanPtr plan, Datum *Values, const char *Nulls, long tcount)
 
int SPI_execute_plan_extended (SPIPlanPtr plan, const SPIExecuteOptions *options)
 
int SPI_execute_plan_with_paramlist (SPIPlanPtr plan, ParamListInfo params, bool read_only, long tcount)
 
int SPI_execute_snapshot (SPIPlanPtr plan, Datum *Values, const char *Nulls, Snapshot snapshot, Snapshot crosscheck_snapshot, bool read_only, bool fire_triggers, long tcount)
 
int SPI_execute_with_args (const char *src, int nargs, Oid *argtypes, Datum *Values, const char *Nulls, bool read_only, long tcount)
 
SPIPlanPtr SPI_prepare (const char *src, int nargs, Oid *argtypes)
 
SPIPlanPtr SPI_prepare_cursor (const char *src, int nargs, Oid *argtypes, int cursorOptions)
 
SPIPlanPtr SPI_prepare_extended (const char *src, const SPIPrepareOptions *options)
 
SPIPlanPtr SPI_prepare_params (const char *src, ParserSetupHook parserSetup, void *parserSetupArg, int cursorOptions)
 
int SPI_keepplan (SPIPlanPtr plan)
 
SPIPlanPtr SPI_saveplan (SPIPlanPtr plan)
 
int SPI_freeplan (SPIPlanPtr plan)
 
HeapTuple SPI_copytuple (HeapTuple tuple)
 
HeapTupleHeader SPI_returntuple (HeapTuple tuple, TupleDesc tupdesc)
 
HeapTuple SPI_modifytuple (Relation rel, HeapTuple tuple, int natts, int *attnum, Datum *Values, const char *Nulls)
 
int SPI_fnumber (TupleDesc tupdesc, const char *fname)
 
char * SPI_fname (TupleDesc tupdesc, int fnumber)
 
char * SPI_getvalue (HeapTuple tuple, TupleDesc tupdesc, int fnumber)
 
Datum SPI_getbinval (HeapTuple tuple, TupleDesc tupdesc, int fnumber, bool *isnull)
 
char * SPI_gettype (TupleDesc tupdesc, int fnumber)
 
Oid SPI_gettypeid (TupleDesc tupdesc, int fnumber)
 
char * SPI_getrelname (Relation rel)
 
char * SPI_getnspname (Relation rel)
 
void * SPI_palloc (Size size)
 
void * SPI_repalloc (void *pointer, Size size)
 
void SPI_pfree (void *pointer)
 
Datum SPI_datumTransfer (Datum value, bool typByVal, int typLen)
 
void SPI_freetuple (HeapTuple tuple)
 
void SPI_freetuptable (SPITupleTable *tuptable)
 
Portal SPI_cursor_open (const char *name, SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only)
 
Portal SPI_cursor_open_with_args (const char *name, const char *src, int nargs, Oid *argtypes, Datum *Values, const char *Nulls, bool read_only, int cursorOptions)
 
Portal SPI_cursor_open_with_paramlist (const char *name, SPIPlanPtr plan, ParamListInfo params, bool read_only)
 
Portal SPI_cursor_parse_open (const char *name, const char *src, const SPIParseOpenOptions *options)
 
Portal SPI_cursor_find (const char *name)
 
void SPI_cursor_fetch (Portal portal, bool forward, long count)
 
void SPI_cursor_move (Portal portal, bool forward, long count)
 
void SPI_scroll_cursor_fetch (Portal portal, FetchDirection direction, long count)
 
void SPI_scroll_cursor_move (Portal portal, FetchDirection direction, long count)
 
void SPI_cursor_close (Portal portal)
 
Oid SPI_getargtypeid (SPIPlanPtr plan, int argIndex)
 
int SPI_getargcount (SPIPlanPtr plan)
 
bool SPI_is_cursor_plan (SPIPlanPtr plan)
 
bool SPI_plan_is_valid (SPIPlanPtr plan)
 
const char * SPI_result_code_string (int code)
 
ListSPI_plan_get_plan_sources (SPIPlanPtr plan)
 
CachedPlanSPI_plan_get_cached_plan (SPIPlanPtr plan)
 
void spi_dest_startup (DestReceiver *self, int operation, TupleDesc typeinfo)
 
bool spi_printtup (TupleTableSlot *slot, DestReceiver *self)
 
static EphemeralNamedRelation _SPI_find_ENR_by_name (const char *name)
 
int SPI_register_relation (EphemeralNamedRelation enr)
 
int SPI_unregister_relation (const char *name)
 
int SPI_register_trigger_data (TriggerData *tdata)
 

Variables

uint64 SPI_processed = 0
 
SPITupleTableSPI_tuptable = NULL
 
int SPI_result = 0
 
static _SPI_connection_SPI_stack = NULL
 
static _SPI_connection_SPI_current = NULL
 
static int _SPI_stack_depth = 0
 
static int _SPI_connected = -1
 

Typedef Documentation

◆ SPICallbackArg

Function Documentation

◆ _SPI_begin_call()

static int _SPI_begin_call ( bool  use_exec)
static

Definition at line 3069 of file spi.c.

3070 {
3071  if (_SPI_current == NULL)
3072  return SPI_ERROR_UNCONNECTED;
3073 
3074  if (use_exec)
3075  {
3076  /* remember when the Executor operation started */
3078  /* switch to the Executor memory context */
3079  _SPI_execmem();
3080  }
3081 
3082  return 0;
3083 }
static _SPI_connection * _SPI_current
Definition: spi.c:49
static MemoryContext _SPI_execmem(void)
Definition: spi.c:3050
#define SPI_ERROR_UNCONNECTED
Definition: spi.h:71
SubTransactionId execSubid
Definition: spi_priv.h:29
SubTransactionId GetCurrentSubTransactionId(void)
Definition: xact.c:789

References _SPI_current, _SPI_execmem(), _SPI_connection::execSubid, GetCurrentSubTransactionId(), and SPI_ERROR_UNCONNECTED.

Referenced by _SPI_cursor_operation(), SPI_cursor_open_internal(), SPI_cursor_open_with_args(), SPI_cursor_parse_open(), SPI_execute(), SPI_execute_extended(), SPI_execute_plan(), SPI_execute_plan_extended(), SPI_execute_plan_with_paramlist(), SPI_execute_snapshot(), SPI_execute_with_args(), SPI_finish(), SPI_prepare_cursor(), SPI_prepare_extended(), SPI_prepare_params(), SPI_register_relation(), SPI_saveplan(), and SPI_unregister_relation().

◆ _SPI_checktuples()

static bool _SPI_checktuples ( void  )
static

Definition at line 3109 of file spi.c.

3110 {
3111  uint64 processed = _SPI_current->processed;
3112  SPITupleTable *tuptable = _SPI_current->tuptable;
3113  bool failed = false;
3114 
3115  if (tuptable == NULL) /* spi_dest_startup was not called */
3116  failed = true;
3117  else if (processed != tuptable->numvals)
3118  failed = true;
3119 
3120  return failed;
3121 }
uint64 numvals
Definition: spi.h:27
uint64 processed
Definition: spi_priv.h:25
SPITupleTable * tuptable
Definition: spi_priv.h:26

References _SPI_current, SPITupleTable::numvals, _SPI_connection::processed, and _SPI_connection::tuptable.

Referenced by _SPI_cursor_operation(), and _SPI_pquery().

◆ _SPI_commit()

static void _SPI_commit ( bool  chain)
static

Definition at line 227 of file spi.c.

228 {
229  MemoryContext oldcontext = CurrentMemoryContext;
231 
232  /*
233  * Complain if we are in a context that doesn't permit transaction
234  * termination. (Note: here and _SPI_rollback should be the only places
235  * that throw ERRCODE_INVALID_TRANSACTION_TERMINATION, so that callers can
236  * test for that with security that they know what happened.)
237  */
238  if (_SPI_current->atomic)
239  ereport(ERROR,
240  (errcode(ERRCODE_INVALID_TRANSACTION_TERMINATION),
241  errmsg("invalid transaction termination")));
242 
243  /*
244  * This restriction is required by PLs implemented on top of SPI. They
245  * use subtransactions to establish exception blocks that are supposed to
246  * be rolled back together if there is an error. Terminating the
247  * top-level transaction in such a block violates that idea. A future PL
248  * implementation might have different ideas about this, in which case
249  * this restriction would have to be refined or the check possibly be
250  * moved out of SPI into the PLs. Note however that the code below relies
251  * on not being within a subtransaction.
252  */
253  if (IsSubTransaction())
254  ereport(ERROR,
255  (errcode(ERRCODE_INVALID_TRANSACTION_TERMINATION),
256  errmsg("cannot commit while a subtransaction is active")));
257 
258  if (chain)
260 
261  /* Catch any error occurring during the COMMIT */
262  PG_TRY();
263  {
264  /* Protect current SPI stack entry against deletion */
265  _SPI_current->internal_xact = true;
266 
267  /*
268  * Hold any pinned portals that any PLs might be using. We have to do
269  * this before changing transaction state, since this will run
270  * user-defined code that might throw an error.
271  */
273 
274  /* Release snapshots associated with portals */
276 
277  /* Do the deed */
279 
280  /* Immediately start a new transaction */
282  if (chain)
284 
285  MemoryContextSwitchTo(oldcontext);
286 
287  _SPI_current->internal_xact = false;
288  }
289  PG_CATCH();
290  {
291  ErrorData *edata;
292 
293  /* Save error info in caller's context */
294  MemoryContextSwitchTo(oldcontext);
295  edata = CopyErrorData();
296  FlushErrorState();
297 
298  /*
299  * Abort the failed transaction. If this fails too, we'll just
300  * propagate the error out ... there's not that much we can do.
301  */
303 
304  /* ... and start a new one */
306  if (chain)
308 
309  MemoryContextSwitchTo(oldcontext);
310 
311  _SPI_current->internal_xact = false;
312 
313  /* Now that we've cleaned up the transaction, re-throw the error */
314  ReThrowError(edata);
315  }
316  PG_END_TRY();
317 }
void ReThrowError(ErrorData *edata)
Definition: elog.c:1932
void FlushErrorState(void)
Definition: elog.c:1848
int errcode(int sqlerrcode)
Definition: elog.c:855
int errmsg(const char *fmt,...)
Definition: elog.c:1068
ErrorData * CopyErrorData(void)
Definition: elog.c:1727
#define PG_TRY(...)
Definition: elog.h:370
#define PG_END_TRY(...)
Definition: elog.h:395
#define ERROR
Definition: elog.h:39
#define PG_CATCH(...)
Definition: elog.h:380
#define ereport(elevel,...)
Definition: elog.h:149
MemoryContext CurrentMemoryContext
Definition: mcxt.c:143
void HoldPinnedPortals(void)
Definition: portalmem.c:1204
void ForgetPortalSnapshots(void)
Definition: portalmem.c:1253
MemoryContextSwitchTo(old_ctx)
bool internal_xact
Definition: spi_priv.h:42
void SaveTransactionCharacteristics(SavedTransactionCharacteristics *s)
Definition: xact.c:3110
void RestoreTransactionCharacteristics(const SavedTransactionCharacteristics *s)
Definition: xact.c:3118
void StartTransactionCommand(void)
Definition: xact.c:3033
bool IsSubTransaction(void)
Definition: xact.c:5031
void CommitTransactionCommand(void)
Definition: xact.c:3131
void AbortCurrentTransaction(void)
Definition: xact.c:3425

References _SPI_current, AbortCurrentTransaction(), _SPI_connection::atomic, CommitTransactionCommand(), CopyErrorData(), CurrentMemoryContext, ereport, errcode(), errmsg(), ERROR, FlushErrorState(), ForgetPortalSnapshots(), HoldPinnedPortals(), _SPI_connection::internal_xact, IsSubTransaction(), MemoryContextSwitchTo(), PG_CATCH, PG_END_TRY, PG_TRY, RestoreTransactionCharacteristics(), ReThrowError(), SaveTransactionCharacteristics(), and StartTransactionCommand().

Referenced by SPI_commit(), and SPI_commit_and_chain().

◆ _SPI_convert_params()

static ParamListInfo _SPI_convert_params ( int  nargs,
Oid argtypes,
Datum Values,
const char *  Nulls 
)
static

Definition at line 2841 of file spi.c.

2843 {
2844  ParamListInfo paramLI;
2845 
2846  if (nargs > 0)
2847  {
2848  paramLI = makeParamList(nargs);
2849 
2850  for (int i = 0; i < nargs; i++)
2851  {
2852  ParamExternData *prm = &paramLI->params[i];
2853 
2854  prm->value = Values[i];
2855  prm->isnull = (Nulls && Nulls[i] == 'n');
2856  prm->pflags = PARAM_FLAG_CONST;
2857  prm->ptype = argtypes[i];
2858  }
2859  }
2860  else
2861  paramLI = NULL;
2862  return paramLI;
2863 }
static bool Nulls[MAXATTR]
Definition: bootstrap.c:153
int i
Definition: isn.c:73
ParamListInfo makeParamList(int numParams)
Definition: params.c:44
#define PARAM_FLAG_CONST
Definition: params.h:88
bool isnull
Definition: params.h:93
uint16 pflags
Definition: params.h:94
Datum value
Definition: params.h:92
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125

References i, ParamExternData::isnull, makeParamList(), Nulls, PARAM_FLAG_CONST, ParamListInfoData::params, ParamExternData::pflags, ParamExternData::ptype, and ParamExternData::value.

Referenced by SPI_cursor_open(), SPI_cursor_open_with_args(), SPI_execute_plan(), SPI_execute_snapshot(), and SPI_execute_with_args().

◆ _SPI_cursor_operation()

static void _SPI_cursor_operation ( Portal  portal,
FetchDirection  direction,
long  count,
DestReceiver dest 
)
static

Definition at line 2999 of file spi.c.

3001 {
3002  uint64 nfetched;
3003 
3004  /* Check that the portal is valid */
3005  if (!PortalIsValid(portal))
3006  elog(ERROR, "invalid portal in SPI cursor operation");
3007 
3008  /* Push the SPI stack */
3009  if (_SPI_begin_call(true) < 0)
3010  elog(ERROR, "SPI cursor operation called while not connected");
3011 
3012  /* Reset the SPI result (note we deliberately don't touch lastoid) */
3013  SPI_processed = 0;
3014  SPI_tuptable = NULL;
3015  _SPI_current->processed = 0;
3016  _SPI_current->tuptable = NULL;
3017 
3018  /* Run the cursor */
3019  nfetched = PortalRunFetch(portal,
3020  direction,
3021  count,
3022  dest);
3023 
3024  /*
3025  * Think not to combine this store with the preceding function call. If
3026  * the portal contains calls to functions that use SPI, then _SPI_stack is
3027  * likely to move around while the portal runs. When control returns,
3028  * _SPI_current will point to the correct stack entry... but the pointer
3029  * may be different than it was beforehand. So we must be sure to re-fetch
3030  * the pointer after the function call completes.
3031  */
3032  _SPI_current->processed = nfetched;
3033 
3034  if (dest->mydest == DestSPI && _SPI_checktuples())
3035  elog(ERROR, "consistency check on SPI tuple count failed");
3036 
3037  /* Put the result into place for access by caller */
3040 
3041  /* tuptable now is caller's responsibility, not SPI's */
3042  _SPI_current->tuptable = NULL;
3043 
3044  /* Pop the SPI stack */
3045  _SPI_end_call(true);
3046 }
@ DestSPI
Definition: dest.h:92
#define elog(elevel,...)
Definition: elog.h:224
#define PortalIsValid(p)
Definition: portal.h:212
uint64 PortalRunFetch(Portal portal, FetchDirection fdirection, long count, DestReceiver *dest)
Definition: pquery.c:1391
static int _SPI_end_call(bool use_exec)
Definition: spi.c:3093
uint64 SPI_processed
Definition: spi.c:44
SPITupleTable * SPI_tuptable
Definition: spi.c:45
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:3069
static bool _SPI_checktuples(void)
Definition: spi.c:3109

References _SPI_begin_call(), _SPI_checktuples(), _SPI_current, _SPI_end_call(), generate_unaccent_rules::dest, DestSPI, elog, ERROR, PortalIsValid, PortalRunFetch(), _SPI_connection::processed, SPI_processed, SPI_tuptable, and _SPI_connection::tuptable.

Referenced by SPI_cursor_fetch(), SPI_cursor_move(), SPI_scroll_cursor_fetch(), and SPI_scroll_cursor_move().

◆ _SPI_end_call()

static int _SPI_end_call ( bool  use_exec)
static

Definition at line 3093 of file spi.c.

3094 {
3095  if (use_exec)
3096  {
3097  /* switch to the procedure memory context */
3098  _SPI_procmem();
3099  /* mark Executor context no longer in use */
3101  /* and free Executor memory */
3103  }
3104 
3105  return 0;
3106 }
#define InvalidSubTransactionId
Definition: c.h:658
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:383
static MemoryContext _SPI_procmem(void)
Definition: spi.c:3056
MemoryContext execCxt
Definition: spi_priv.h:34

References _SPI_current, _SPI_procmem(), _SPI_connection::execCxt, _SPI_connection::execSubid, InvalidSubTransactionId, and MemoryContextReset().

Referenced by _SPI_cursor_operation(), SPI_cursor_open_internal(), SPI_cursor_open_with_args(), SPI_cursor_parse_open(), SPI_execute(), SPI_execute_extended(), SPI_execute_plan(), SPI_execute_plan_extended(), SPI_execute_plan_with_paramlist(), SPI_execute_snapshot(), SPI_execute_with_args(), SPI_prepare_cursor(), SPI_prepare_extended(), SPI_prepare_params(), SPI_register_relation(), SPI_saveplan(), and SPI_unregister_relation().

◆ _SPI_error_callback()

static void _SPI_error_callback ( void *  arg)
static

Definition at line 2953 of file spi.c.

2954 {
2955  SPICallbackArg *carg = (SPICallbackArg *) arg;
2956  const char *query = carg->query;
2957  int syntaxerrposition;
2958 
2959  if (query == NULL) /* in case arg wasn't set yet */
2960  return;
2961 
2962  /*
2963  * If there is a syntax error position, convert to internal syntax error;
2964  * otherwise treat the query as an item of context stack
2965  */
2966  syntaxerrposition = geterrposition();
2967  if (syntaxerrposition > 0)
2968  {
2969  errposition(0);
2970  internalerrposition(syntaxerrposition);
2971  internalerrquery(query);
2972  }
2973  else
2974  {
2975  /* Use the parse mode to decide how to describe the query */
2976  switch (carg->mode)
2977  {
2979  errcontext("SQL expression \"%s\"", query);
2980  break;
2984  errcontext("PL/pgSQL assignment \"%s\"", query);
2985  break;
2986  default:
2987  errcontext("SQL statement \"%s\"", query);
2988  break;
2989  }
2990  }
2991 }
int internalerrquery(const char *query)
Definition: elog.c:1480
int internalerrposition(int cursorpos)
Definition: elog.c:1460
int geterrposition(void)
Definition: elog.c:1576
int errposition(int cursorpos)
Definition: elog.c:1444
#define errcontext
Definition: elog.h:196
@ RAW_PARSE_PLPGSQL_EXPR
Definition: parser.h:41
@ RAW_PARSE_PLPGSQL_ASSIGN2
Definition: parser.h:43
@ RAW_PARSE_PLPGSQL_ASSIGN1
Definition: parser.h:42
@ RAW_PARSE_PLPGSQL_ASSIGN3
Definition: parser.h:44
void * arg
const char * query
Definition: spi.c:55
RawParseMode mode
Definition: spi.c:56

References arg, errcontext, errposition(), geterrposition(), internalerrposition(), internalerrquery(), SPICallbackArg::mode, SPICallbackArg::query, RAW_PARSE_PLPGSQL_ASSIGN1, RAW_PARSE_PLPGSQL_ASSIGN2, RAW_PARSE_PLPGSQL_ASSIGN3, and RAW_PARSE_PLPGSQL_EXPR.

Referenced by _SPI_execute_plan(), _SPI_prepare_oneshot_plan(), _SPI_prepare_plan(), SPI_cursor_open_internal(), and SPI_plan_get_cached_plan().

◆ _SPI_execmem()

static MemoryContext _SPI_execmem ( void  )
static

Definition at line 3050 of file spi.c.

3051 {
3053 }

References _SPI_current, _SPI_connection::execCxt, and MemoryContextSwitchTo().

Referenced by _SPI_begin_call().

◆ _SPI_execute_plan()

static int _SPI_execute_plan ( SPIPlanPtr  plan,
const SPIExecuteOptions options,
Snapshot  snapshot,
Snapshot  crosscheck_snapshot,
bool  fire_triggers 
)
static

Definition at line 2394 of file spi.c.

2397 {
2398  int my_res = 0;
2399  uint64 my_processed = 0;
2400  SPITupleTable *my_tuptable = NULL;
2401  int res = 0;
2402  bool allow_nonatomic;
2403  bool pushed_active_snap = false;
2404  ResourceOwner plan_owner = options->owner;
2405  SPICallbackArg spicallbackarg;
2406  ErrorContextCallback spierrcontext;
2407  CachedPlan *cplan = NULL;
2408  ListCell *lc1;
2409 
2410  /*
2411  * We allow nonatomic behavior only if options->allow_nonatomic is set
2412  * *and* the SPI_OPT_NONATOMIC flag was given when connecting.
2413  */
2414  allow_nonatomic = options->allow_nonatomic && !_SPI_current->atomic;
2415 
2416  /*
2417  * Setup error traceback support for ereport()
2418  */
2419  spicallbackarg.query = NULL; /* we'll fill this below */
2420  spicallbackarg.mode = plan->parse_mode;
2421  spierrcontext.callback = _SPI_error_callback;
2422  spierrcontext.arg = &spicallbackarg;
2423  spierrcontext.previous = error_context_stack;
2424  error_context_stack = &spierrcontext;
2425 
2426  /*
2427  * We support four distinct snapshot management behaviors:
2428  *
2429  * snapshot != InvalidSnapshot, read_only = true: use exactly the given
2430  * snapshot.
2431  *
2432  * snapshot != InvalidSnapshot, read_only = false: use the given snapshot,
2433  * modified by advancing its command ID before each querytree.
2434  *
2435  * snapshot == InvalidSnapshot, read_only = true: do nothing for queries
2436  * that require no snapshot. For those that do, ensure that a Portal
2437  * snapshot exists; then use that, or use the entry-time ActiveSnapshot if
2438  * that exists and is different.
2439  *
2440  * snapshot == InvalidSnapshot, read_only = false: do nothing for queries
2441  * that require no snapshot. For those that do, ensure that a Portal
2442  * snapshot exists; then, in atomic execution (!allow_nonatomic) take a
2443  * full new snapshot for each user command, and advance its command ID
2444  * before each querytree within the command. In allow_nonatomic mode we
2445  * just use the Portal snapshot unmodified.
2446  *
2447  * In the first two cases, we can just push the snap onto the stack once
2448  * for the whole plan list.
2449  *
2450  * Note that snapshot != InvalidSnapshot implies an atomic execution
2451  * context.
2452  */
2453  if (snapshot != InvalidSnapshot)
2454  {
2455  /* this intentionally tests the options field not the derived value */
2456  Assert(!options->allow_nonatomic);
2457  if (options->read_only)
2458  {
2459  PushActiveSnapshot(snapshot);
2460  pushed_active_snap = true;
2461  }
2462  else
2463  {
2464  /* Make sure we have a private copy of the snapshot to modify */
2465  PushCopiedSnapshot(snapshot);
2466  pushed_active_snap = true;
2467  }
2468  }
2469 
2470  /*
2471  * Ensure that we have a resource owner if plan is saved, and not if it
2472  * isn't.
2473  */
2474  if (!plan->saved)
2475  plan_owner = NULL;
2476  else if (plan_owner == NULL)
2477  plan_owner = CurrentResourceOwner;
2478 
2479  /*
2480  * We interpret must_return_tuples as "there must be at least one query,
2481  * and all of them must return tuples". This is a bit laxer than
2482  * SPI_is_cursor_plan's check, but there seems no reason to enforce that
2483  * there be only one query.
2484  */
2485  if (options->must_return_tuples && plan->plancache_list == NIL)
2486  ereport(ERROR,
2487  (errcode(ERRCODE_SYNTAX_ERROR),
2488  errmsg("empty query does not return tuples")));
2489 
2490  foreach(lc1, plan->plancache_list)
2491  {
2492  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc1);
2493  List *stmt_list;
2494  ListCell *lc2;
2495 
2496  spicallbackarg.query = plansource->query_string;
2497 
2498  /*
2499  * If this is a one-shot plan, we still need to do parse analysis.
2500  */
2501  if (plan->oneshot)
2502  {
2503  RawStmt *parsetree = plansource->raw_parse_tree;
2504  const char *src = plansource->query_string;
2505  List *querytree_list;
2506 
2507  /*
2508  * Parameter datatypes are driven by parserSetup hook if provided,
2509  * otherwise we use the fixed parameter list.
2510  */
2511  if (parsetree == NULL)
2512  querytree_list = NIL;
2513  else if (plan->parserSetup != NULL)
2514  {
2515  Assert(plan->nargs == 0);
2516  querytree_list = pg_analyze_and_rewrite_withcb(parsetree,
2517  src,
2518  plan->parserSetup,
2519  plan->parserSetupArg,
2521  }
2522  else
2523  {
2524  querytree_list = pg_analyze_and_rewrite_fixedparams(parsetree,
2525  src,
2526  plan->argtypes,
2527  plan->nargs,
2529  }
2530 
2531  /* Finish filling in the CachedPlanSource */
2532  CompleteCachedPlan(plansource,
2533  querytree_list,
2534  NULL,
2535  plan->argtypes,
2536  plan->nargs,
2537  plan->parserSetup,
2538  plan->parserSetupArg,
2539  plan->cursor_options,
2540  false); /* not fixed result */
2541  }
2542 
2543  /*
2544  * If asked to, complain when query does not return tuples.
2545  * (Replanning can't change this, so we can check it before that.
2546  * However, we can't check it till after parse analysis, so in the
2547  * case of a one-shot plan this is the earliest we could check.)
2548  */
2549  if (options->must_return_tuples && !plansource->resultDesc)
2550  {
2551  /* try to give a good error message */
2552  const char *cmdtag;
2553 
2554  /* A SELECT without resultDesc must be SELECT INTO */
2555  if (plansource->commandTag == CMDTAG_SELECT)
2556  cmdtag = "SELECT INTO";
2557  else
2558  cmdtag = GetCommandTagName(plansource->commandTag);
2559  ereport(ERROR,
2560  (errcode(ERRCODE_SYNTAX_ERROR),
2561  /* translator: %s is name of a SQL command, eg INSERT */
2562  errmsg("%s query does not return tuples", cmdtag)));
2563  }
2564 
2565  /*
2566  * Replan if needed, and increment plan refcount. If it's a saved
2567  * plan, the refcount must be backed by the plan_owner.
2568  */
2569  cplan = GetCachedPlan(plansource, options->params,
2570  plan_owner, _SPI_current->queryEnv);
2571 
2572  stmt_list = cplan->stmt_list;
2573 
2574  /*
2575  * If we weren't given a specific snapshot to use, and the statement
2576  * list requires a snapshot, set that up.
2577  */
2578  if (snapshot == InvalidSnapshot &&
2579  (list_length(stmt_list) > 1 ||
2580  (list_length(stmt_list) == 1 &&
2582  stmt_list)))))
2583  {
2584  /*
2585  * First, ensure there's a Portal-level snapshot. This back-fills
2586  * the snapshot stack in case the previous operation was a COMMIT
2587  * or ROLLBACK inside a procedure or DO block. (We can't put back
2588  * the Portal snapshot any sooner, or we'd break cases like doing
2589  * SET or LOCK just after COMMIT.) It's enough to check once per
2590  * statement list, since COMMIT/ROLLBACK/CALL/DO can't appear
2591  * within a multi-statement list.
2592  */
2594 
2595  /*
2596  * In the default non-read-only case, get a new per-statement-list
2597  * snapshot, replacing any that we pushed in a previous cycle.
2598  * Skip it when doing non-atomic execution, though (we rely
2599  * entirely on the Portal snapshot in that case).
2600  */
2601  if (!options->read_only && !allow_nonatomic)
2602  {
2603  if (pushed_active_snap)
2606  pushed_active_snap = true;
2607  }
2608  }
2609 
2610  foreach(lc2, stmt_list)
2611  {
2613  bool canSetTag = stmt->canSetTag;
2614  DestReceiver *dest;
2615 
2616  /*
2617  * Reset output state. (Note that if a non-SPI receiver is used,
2618  * _SPI_current->processed will stay zero, and that's what we'll
2619  * report to the caller. It's the receiver's job to count tuples
2620  * in that case.)
2621  */
2622  _SPI_current->processed = 0;
2623  _SPI_current->tuptable = NULL;
2624 
2625  /* Check for unsupported cases. */
2626  if (stmt->utilityStmt)
2627  {
2628  if (IsA(stmt->utilityStmt, CopyStmt))
2629  {
2630  CopyStmt *cstmt = (CopyStmt *) stmt->utilityStmt;
2631 
2632  if (cstmt->filename == NULL)
2633  {
2634  my_res = SPI_ERROR_COPY;
2635  goto fail;
2636  }
2637  }
2638  else if (IsA(stmt->utilityStmt, TransactionStmt))
2639  {
2640  my_res = SPI_ERROR_TRANSACTION;
2641  goto fail;
2642  }
2643  }
2644 
2645  if (options->read_only && !CommandIsReadOnly(stmt))
2646  ereport(ERROR,
2647  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2648  /* translator: %s is a SQL statement name */
2649  errmsg("%s is not allowed in a non-volatile function",
2650  CreateCommandName((Node *) stmt))));
2651 
2652  /*
2653  * If not read-only mode, advance the command counter before each
2654  * command and update the snapshot. (But skip it if the snapshot
2655  * isn't under our control.)
2656  */
2657  if (!options->read_only && pushed_active_snap)
2658  {
2661  }
2662 
2663  /*
2664  * Select appropriate tuple receiver. Output from non-canSetTag
2665  * subqueries always goes to the bit bucket.
2666  */
2667  if (!canSetTag)
2669  else if (options->dest)
2670  dest = options->dest;
2671  else
2673 
2674  if (stmt->utilityStmt == NULL)
2675  {
2676  QueryDesc *qdesc;
2677  Snapshot snap;
2678 
2679  if (ActiveSnapshotSet())
2680  snap = GetActiveSnapshot();
2681  else
2682  snap = InvalidSnapshot;
2683 
2684  qdesc = CreateQueryDesc(stmt,
2685  plansource->query_string,
2686  snap, crosscheck_snapshot,
2687  dest,
2688  options->params,
2690  0);
2691  res = _SPI_pquery(qdesc, fire_triggers,
2692  canSetTag ? options->tcount : 0);
2693  FreeQueryDesc(qdesc);
2694  }
2695  else
2696  {
2698  QueryCompletion qc;
2699 
2700  /*
2701  * If we're not allowing nonatomic operations, tell
2702  * ProcessUtility this is an atomic execution context.
2703  */
2704  if (allow_nonatomic)
2706  else
2708 
2711  plansource->query_string,
2712  true, /* protect plancache's node tree */
2713  context,
2714  options->params,
2716  dest,
2717  &qc);
2718 
2719  /* Update "processed" if stmt returned tuples */
2720  if (_SPI_current->tuptable)
2722 
2723  res = SPI_OK_UTILITY;
2724 
2725  /*
2726  * Some utility statements return a row count, even though the
2727  * tuples are not returned to the caller.
2728  */
2729  if (IsA(stmt->utilityStmt, CreateTableAsStmt))
2730  {
2731  CreateTableAsStmt *ctastmt = (CreateTableAsStmt *) stmt->utilityStmt;
2732 
2733  if (qc.commandTag == CMDTAG_SELECT)
2735  else
2736  {
2737  /*
2738  * Must be an IF NOT EXISTS that did nothing, or a
2739  * CREATE ... WITH NO DATA.
2740  */
2741  Assert(ctastmt->if_not_exists ||
2742  ctastmt->into->skipData);
2743  _SPI_current->processed = 0;
2744  }
2745 
2746  /*
2747  * For historical reasons, if CREATE TABLE AS was spelled
2748  * as SELECT INTO, return a special return code.
2749  */
2750  if (ctastmt->is_select_into)
2751  res = SPI_OK_SELINTO;
2752  }
2753  else if (IsA(stmt->utilityStmt, CopyStmt))
2754  {
2755  Assert(qc.commandTag == CMDTAG_COPY);
2757  }
2758  }
2759 
2760  /*
2761  * The last canSetTag query sets the status values returned to the
2762  * caller. Be careful to free any tuptables not returned, to
2763  * avoid intra-transaction memory leak.
2764  */
2765  if (canSetTag)
2766  {
2767  my_processed = _SPI_current->processed;
2768  SPI_freetuptable(my_tuptable);
2769  my_tuptable = _SPI_current->tuptable;
2770  my_res = res;
2771  }
2772  else
2773  {
2775  _SPI_current->tuptable = NULL;
2776  }
2777 
2778  /*
2779  * We don't issue a destroy call to the receiver. The SPI and
2780  * None receivers would ignore it anyway, while if the caller
2781  * supplied a receiver, it's not our job to destroy it.
2782  */
2783 
2784  if (res < 0)
2785  {
2786  my_res = res;
2787  goto fail;
2788  }
2789  }
2790 
2791  /* Done with this plan, so release refcount */
2792  ReleaseCachedPlan(cplan, plan_owner);
2793  cplan = NULL;
2794 
2795  /*
2796  * If not read-only mode, advance the command counter after the last
2797  * command. This ensures that its effects are visible, in case it was
2798  * DDL that would affect the next CachedPlanSource.
2799  */
2800  if (!options->read_only)
2802  }
2803 
2804 fail:
2805 
2806  /* Pop the snapshot off the stack if we pushed one */
2807  if (pushed_active_snap)
2809 
2810  /* We no longer need the cached plan refcount, if any */
2811  if (cplan)
2812  ReleaseCachedPlan(cplan, plan_owner);
2813 
2814  /*
2815  * Pop the error context stack
2816  */
2817  error_context_stack = spierrcontext.previous;
2818 
2819  /* Save results for caller */
2820  SPI_processed = my_processed;
2821  SPI_tuptable = my_tuptable;
2822 
2823  /* tuptable now is caller's responsibility, not SPI's */
2824  _SPI_current->tuptable = NULL;
2825 
2826  /*
2827  * If none of the queries had canSetTag, return SPI_OK_REWRITTEN. Prior to
2828  * 8.4, we used return the last query's result code, but not its auxiliary
2829  * results, but that's confusing.
2830  */
2831  if (my_res == 0)
2832  my_res = SPI_OK_REWRITTEN;
2833 
2834  return my_res;
2835 }
#define Assert(condition)
Definition: c.h:858
void InitializeQueryCompletion(QueryCompletion *qc)
Definition: cmdtag.c:40
const char * GetCommandTagName(CommandTag commandTag)
Definition: cmdtag.c:47
DestReceiver * CreateDestReceiver(CommandDest dest)
Definition: dest.c:113
@ DestNone
Definition: dest.h:87
ErrorContextCallback * error_context_stack
Definition: elog.c:94
#define stmt
Definition: indent_codes.h:59
if(TABLE==NULL||TABLE_index==NULL)
Definition: isn.c:77
#define IsA(nodeptr, _type_)
Definition: nodes.h:158
#define lfirst(lc)
Definition: pg_list.h:172
#define lfirst_node(type, lc)
Definition: pg_list.h:176
static int list_length(const List *l)
Definition: pg_list.h:152
#define linitial_node(type, l)
Definition: pg_list.h:181
#define NIL
Definition: pg_list.h:68
#define plan(x)
Definition: pg_regress.c:162
void CompleteCachedPlan(CachedPlanSource *plansource, List *querytree_list, MemoryContext querytree_context, Oid *param_types, int num_params, ParserSetupHook parserSetup, void *parserSetupArg, int cursor_options, bool fixed_result)
Definition: plancache.c:366
CachedPlan * GetCachedPlan(CachedPlanSource *plansource, ParamListInfo boundParams, ResourceOwner owner, QueryEnvironment *queryEnv)
Definition: plancache.c:1168
void ReleaseCachedPlan(CachedPlan *plan, ResourceOwner owner)
Definition: plancache.c:1291
List * pg_analyze_and_rewrite_withcb(RawStmt *parsetree, const char *query_string, ParserSetupHook parserSetup, void *parserSetupArg, QueryEnvironment *queryEnv)
Definition: postgres.c:764
List * pg_analyze_and_rewrite_fixedparams(RawStmt *parsetree, const char *query_string, const Oid *paramTypes, int numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:671
void FreeQueryDesc(QueryDesc *qdesc)
Definition: pquery.c:105
bool PlannedStmtRequiresSnapshot(PlannedStmt *pstmt)
Definition: pquery.c:1732
void EnsurePortalSnapshotExists(void)
Definition: pquery.c:1780
QueryDesc * CreateQueryDesc(PlannedStmt *plannedstmt, const char *sourceText, Snapshot snapshot, Snapshot crosscheck_snapshot, DestReceiver *dest, ParamListInfo params, QueryEnvironment *queryEnv, int instrument_options)
Definition: pquery.c:67
tree context
Definition: radixtree.h:1835
ResourceOwner CurrentResourceOwner
Definition: resowner.c:165
Snapshot GetTransactionSnapshot(void)
Definition: snapmgr.c:216
void PushActiveSnapshot(Snapshot snapshot)
Definition: snapmgr.c:648
void UpdateActiveSnapshotCommandId(void)
Definition: snapmgr.c:712
bool ActiveSnapshotSet(void)
Definition: snapmgr.c:782
void PopActiveSnapshot(void)
Definition: snapmgr.c:743
void PushCopiedSnapshot(Snapshot snapshot)
Definition: snapmgr.c:700
Snapshot GetActiveSnapshot(void)
Definition: snapmgr.c:770
#define InvalidSnapshot
Definition: snapshot.h:123
static void _SPI_error_callback(void *arg)
Definition: spi.c:2953
static int _SPI_pquery(QueryDesc *queryDesc, bool fire_triggers, uint64 tcount)
Definition: spi.c:2866
void SPI_freetuptable(SPITupleTable *tuptable)
Definition: spi.c:1383
#define SPI_ERROR_TRANSACTION
Definition: spi.h:75
#define SPI_OK_UTILITY
Definition: spi.h:85
#define SPI_OK_REWRITTEN
Definition: spi.h:95
#define SPI_OK_SELINTO
Definition: spi.h:87
#define SPI_ERROR_COPY
Definition: spi.h:69
CommandTag commandTag
Definition: plancache.h:101
const char * query_string
Definition: plancache.h:100
struct RawStmt * raw_parse_tree
Definition: plancache.h:99
TupleDesc resultDesc
Definition: plancache.h:108
List * stmt_list
Definition: plancache.h:150
char * filename
Definition: parsenodes.h:2601
IntoClause * into
Definition: parsenodes.h:3897
struct ErrorContextCallback * previous
Definition: elog.h:295
void(* callback)(void *arg)
Definition: elog.h:296
bool skipData
Definition: primnodes.h:170
Definition: pg_list.h:54
Definition: nodes.h:129
uint64 nprocessed
Definition: cmdtag.h:32
CommandTag commandTag
Definition: cmdtag.h:31
QueryEnvironment * queryEnv
Definition: spi_priv.h:37
void ProcessUtility(PlannedStmt *pstmt, const char *queryString, bool readOnlyTree, ProcessUtilityContext context, ParamListInfo params, QueryEnvironment *queryEnv, DestReceiver *dest, QueryCompletion *qc)
Definition: utility.c:499
bool CommandIsReadOnly(PlannedStmt *pstmt)
Definition: utility.c:94
static const char * CreateCommandName(Node *parsetree)
Definition: utility.h:103
ProcessUtilityContext
Definition: utility.h:21
@ PROCESS_UTILITY_QUERY_NONATOMIC
Definition: utility.h:24
@ PROCESS_UTILITY_QUERY
Definition: utility.h:23
void CommandCounterIncrement(void)
Definition: xact.c:1098

References _SPI_current, _SPI_error_callback(), _SPI_pquery(), ActiveSnapshotSet(), ErrorContextCallback::arg, Assert, _SPI_connection::atomic, ErrorContextCallback::callback, CommandCounterIncrement(), CommandIsReadOnly(), QueryCompletion::commandTag, CachedPlanSource::commandTag, CompleteCachedPlan(), context, CreateCommandName(), CreateDestReceiver(), CreateQueryDesc(), CurrentResourceOwner, generate_unaccent_rules::dest, DestNone, DestSPI, EnsurePortalSnapshotExists(), ereport, errcode(), errmsg(), ERROR, error_context_stack, CopyStmt::filename, FreeQueryDesc(), GetActiveSnapshot(), GetCachedPlan(), GetCommandTagName(), GetTransactionSnapshot(), if(), CreateTableAsStmt::if_not_exists, InitializeQueryCompletion(), CreateTableAsStmt::into, InvalidSnapshot, CreateTableAsStmt::is_select_into, IsA, lfirst, lfirst_node, linitial_node, list_length(), SPICallbackArg::mode, NIL, QueryCompletion::nprocessed, SPITupleTable::numvals, pg_analyze_and_rewrite_fixedparams(), pg_analyze_and_rewrite_withcb(), plan, PlannedStmtRequiresSnapshot(), PopActiveSnapshot(), ErrorContextCallback::previous, PROCESS_UTILITY_QUERY, PROCESS_UTILITY_QUERY_NONATOMIC, _SPI_connection::processed, ProcessUtility(), PushActiveSnapshot(), PushCopiedSnapshot(), SPICallbackArg::query, CachedPlanSource::query_string, _SPI_connection::queryEnv, CachedPlanSource::raw_parse_tree, ReleaseCachedPlan(), res, CachedPlanSource::resultDesc, IntoClause::skipData, SPI_ERROR_COPY, SPI_ERROR_TRANSACTION, SPI_freetuptable(), SPI_OK_REWRITTEN, SPI_OK_SELINTO, SPI_OK_UTILITY, SPI_processed, SPI_tuptable, stmt, CachedPlan::stmt_list, _SPI_connection::tuptable, and UpdateActiveSnapshotCommandId().

Referenced by SPI_execute(), SPI_execute_extended(), SPI_execute_plan(), SPI_execute_plan_extended(), SPI_execute_plan_with_paramlist(), SPI_execute_snapshot(), and SPI_execute_with_args().

◆ _SPI_find_ENR_by_name()

static EphemeralNamedRelation _SPI_find_ENR_by_name ( const char *  name)
static

Definition at line 3272 of file spi.c.

3273 {
3274  /* internal static function; any error is bug in SPI itself */
3275  Assert(name != NULL);
3276 
3277  /* fast exit if no tuplestores have been added */
3278  if (_SPI_current->queryEnv == NULL)
3279  return NULL;
3280 
3281  return get_ENR(_SPI_current->queryEnv, name);
3282 }
EphemeralNamedRelation get_ENR(QueryEnvironment *queryEnv, const char *name)
const char * name

References _SPI_current, Assert, get_ENR(), name, and _SPI_connection::queryEnv.

Referenced by SPI_register_relation(), and SPI_unregister_relation().

◆ _SPI_make_plan_non_temp()

static SPIPlanPtr _SPI_make_plan_non_temp ( SPIPlanPtr  plan)
static

Definition at line 3133 of file spi.c.

3134 {
3135  SPIPlanPtr newplan;
3136  MemoryContext parentcxt = _SPI_current->procCxt;
3137  MemoryContext plancxt;
3138  MemoryContext oldcxt;
3139  ListCell *lc;
3140 
3141  /* Assert the input is a temporary SPIPlan */
3142  Assert(plan->magic == _SPI_PLAN_MAGIC);
3143  Assert(plan->plancxt == NULL);
3144  /* One-shot plans can't be saved */
3145  Assert(!plan->oneshot);
3146 
3147  /*
3148  * Create a memory context for the plan, underneath the procedure context.
3149  * We don't expect the plan to be very large.
3150  */
3151  plancxt = AllocSetContextCreate(parentcxt,
3152  "SPI Plan",
3154  oldcxt = MemoryContextSwitchTo(plancxt);
3155 
3156  /* Copy the _SPI_plan struct and subsidiary data into the new context */
3157  newplan = (SPIPlanPtr) palloc0(sizeof(_SPI_plan));
3158  newplan->magic = _SPI_PLAN_MAGIC;
3159  newplan->plancxt = plancxt;
3160  newplan->parse_mode = plan->parse_mode;
3161  newplan->cursor_options = plan->cursor_options;
3162  newplan->nargs = plan->nargs;
3163  if (plan->nargs > 0)
3164  {
3165  newplan->argtypes = (Oid *) palloc(plan->nargs * sizeof(Oid));
3166  memcpy(newplan->argtypes, plan->argtypes, plan->nargs * sizeof(Oid));
3167  }
3168  else
3169  newplan->argtypes = NULL;
3170  newplan->parserSetup = plan->parserSetup;
3171  newplan->parserSetupArg = plan->parserSetupArg;
3172 
3173  /*
3174  * Reparent all the CachedPlanSources into the procedure context. In
3175  * theory this could fail partway through due to the pallocs, but we don't
3176  * care too much since both the procedure context and the executor context
3177  * would go away on error.
3178  */
3179  foreach(lc, plan->plancache_list)
3180  {
3181  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
3182 
3183  CachedPlanSetParentContext(plansource, parentcxt);
3184 
3185  /* Build new list, with list cells in plancxt */
3186  newplan->plancache_list = lappend(newplan->plancache_list, plansource);
3187  }
3188 
3189  MemoryContextSwitchTo(oldcxt);
3190 
3191  /* For safety, unlink the CachedPlanSources from the temporary plan */
3192  plan->plancache_list = NIL;
3193 
3194  return newplan;
3195 }
List * lappend(List *list, void *datum)
Definition: list.c:339
void * palloc0(Size size)
Definition: mcxt.c:1347
void * palloc(Size size)
Definition: mcxt.c:1317
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:170
void CachedPlanSetParentContext(CachedPlanSource *plansource, MemoryContext newcontext)
Definition: plancache.c:1498
unsigned int Oid
Definition: postgres_ext.h:31
struct _SPI_plan * SPIPlanPtr
Definition: spi.h:66
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
MemoryContext procCxt
Definition: spi_priv.h:33
ParserSetupHook parserSetup
Definition: spi_priv.h:101
List * plancache_list
Definition: spi_priv.h:95
int magic
Definition: spi_priv.h:92
int cursor_options
Definition: spi_priv.h:98
Oid * argtypes
Definition: spi_priv.h:100
int nargs
Definition: spi_priv.h:99
MemoryContext plancxt
Definition: spi_priv.h:96
RawParseMode parse_mode
Definition: spi_priv.h:97
void * parserSetupArg
Definition: spi_priv.h:102

References _SPI_current, _SPI_PLAN_MAGIC, ALLOCSET_SMALL_SIZES, AllocSetContextCreate, _SPI_plan::argtypes, Assert, CachedPlanSetParentContext(), _SPI_plan::cursor_options, lappend(), lfirst, _SPI_plan::magic, MemoryContextSwitchTo(), _SPI_plan::nargs, NIL, palloc(), palloc0(), _SPI_plan::parse_mode, _SPI_plan::parserSetup, _SPI_plan::parserSetupArg, plan, _SPI_plan::plancache_list, _SPI_plan::plancxt, and _SPI_connection::procCxt.

Referenced by SPI_prepare_cursor(), SPI_prepare_extended(), and SPI_prepare_params().

◆ _SPI_pquery()

static int _SPI_pquery ( QueryDesc queryDesc,
bool  fire_triggers,
uint64  tcount 
)
static

Definition at line 2866 of file spi.c.

2867 {
2868  int operation = queryDesc->operation;
2869  int eflags;
2870  int res;
2871 
2872  switch (operation)
2873  {
2874  case CMD_SELECT:
2875  if (queryDesc->dest->mydest == DestNone)
2876  {
2877  /* Don't return SPI_OK_SELECT if we're discarding result */
2878  res = SPI_OK_UTILITY;
2879  }
2880  else
2881  res = SPI_OK_SELECT;
2882  break;
2883  case CMD_INSERT:
2884  if (queryDesc->plannedstmt->hasReturning)
2886  else
2887  res = SPI_OK_INSERT;
2888  break;
2889  case CMD_DELETE:
2890  if (queryDesc->plannedstmt->hasReturning)
2892  else
2893  res = SPI_OK_DELETE;
2894  break;
2895  case CMD_UPDATE:
2896  if (queryDesc->plannedstmt->hasReturning)
2898  else
2899  res = SPI_OK_UPDATE;
2900  break;
2901  case CMD_MERGE:
2902  if (queryDesc->plannedstmt->hasReturning)
2904  else
2905  res = SPI_OK_MERGE;
2906  break;
2907  default:
2908  return SPI_ERROR_OPUNKNOWN;
2909  }
2910 
2911 #ifdef SPI_EXECUTOR_STATS
2912  if (ShowExecutorStats)
2913  ResetUsage();
2914 #endif
2915 
2916  /* Select execution options */
2917  if (fire_triggers)
2918  eflags = 0; /* default run-to-completion flags */
2919  else
2920  eflags = EXEC_FLAG_SKIP_TRIGGERS;
2921 
2922  ExecutorStart(queryDesc, eflags);
2923 
2924  ExecutorRun(queryDesc, ForwardScanDirection, tcount, true);
2925 
2926  _SPI_current->processed = queryDesc->estate->es_processed;
2927 
2928  if ((res == SPI_OK_SELECT || queryDesc->plannedstmt->hasReturning) &&
2929  queryDesc->dest->mydest == DestSPI)
2930  {
2931  if (_SPI_checktuples())
2932  elog(ERROR, "consistency check on SPI tuple count failed");
2933  }
2934 
2935  ExecutorFinish(queryDesc);
2936  ExecutorEnd(queryDesc);
2937  /* FreeQueryDesc is done by the caller */
2938 
2939 #ifdef SPI_EXECUTOR_STATS
2940  if (ShowExecutorStats)
2941  ShowUsage("SPI EXECUTOR STATS");
2942 #endif
2943 
2944  return res;
2945 }
void ExecutorEnd(QueryDesc *queryDesc)
Definition: execMain.c:467
void ExecutorFinish(QueryDesc *queryDesc)
Definition: execMain.c:407
void ExecutorStart(QueryDesc *queryDesc, int eflags)
Definition: execMain.c:124
void ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count, bool execute_once)
Definition: execMain.c:297
#define EXEC_FLAG_SKIP_TRIGGERS
Definition: executor.h:70
@ CMD_MERGE
Definition: nodes.h:269
@ CMD_INSERT
Definition: nodes.h:267
@ CMD_DELETE
Definition: nodes.h:268
@ CMD_UPDATE
Definition: nodes.h:266
@ CMD_SELECT
Definition: nodes.h:265
void ShowUsage(const char *title)
Definition: postgres.c:5000
void ResetUsage(void)
Definition: postgres.c:4993
@ ForwardScanDirection
Definition: sdir.h:28
#define SPI_OK_INSERT
Definition: spi.h:88
#define SPI_OK_UPDATE
Definition: spi.h:90
#define SPI_OK_MERGE
Definition: spi.h:99
#define SPI_ERROR_OPUNKNOWN
Definition: spi.h:70
#define SPI_OK_UPDATE_RETURNING
Definition: spi.h:94
#define SPI_OK_DELETE
Definition: spi.h:89
#define SPI_OK_INSERT_RETURNING
Definition: spi.h:92
#define SPI_OK_DELETE_RETURNING
Definition: spi.h:93
#define SPI_OK_MERGE_RETURNING
Definition: spi.h:100
#define SPI_OK_SELECT
Definition: spi.h:86
uint64 es_processed
Definition: execnodes.h:671
bool hasReturning
Definition: plannodes.h:56
DestReceiver * dest
Definition: execdesc.h:41
EState * estate
Definition: execdesc.h:48
CmdType operation
Definition: execdesc.h:36
PlannedStmt * plannedstmt
Definition: execdesc.h:37
CommandDest mydest
Definition: dest.h:128

References _SPI_checktuples(), _SPI_current, CMD_DELETE, CMD_INSERT, CMD_MERGE, CMD_SELECT, CMD_UPDATE, QueryDesc::dest, DestNone, DestSPI, elog, ERROR, EState::es_processed, QueryDesc::estate, EXEC_FLAG_SKIP_TRIGGERS, ExecutorEnd(), ExecutorFinish(), ExecutorRun(), ExecutorStart(), ForwardScanDirection, PlannedStmt::hasReturning, _DestReceiver::mydest, QueryDesc::operation, QueryDesc::plannedstmt, _SPI_connection::processed, res, ResetUsage(), ShowUsage(), SPI_ERROR_OPUNKNOWN, SPI_OK_DELETE, SPI_OK_DELETE_RETURNING, SPI_OK_INSERT, SPI_OK_INSERT_RETURNING, SPI_OK_MERGE, SPI_OK_MERGE_RETURNING, SPI_OK_SELECT, SPI_OK_UPDATE, SPI_OK_UPDATE_RETURNING, and SPI_OK_UTILITY.

Referenced by _SPI_execute_plan().

◆ _SPI_prepare_oneshot_plan()

static void _SPI_prepare_oneshot_plan ( const char *  src,
SPIPlanPtr  plan 
)
static

Definition at line 2324 of file spi.c.

2325 {
2326  List *raw_parsetree_list;
2327  List *plancache_list;
2328  ListCell *list_item;
2329  SPICallbackArg spicallbackarg;
2330  ErrorContextCallback spierrcontext;
2331 
2332  /*
2333  * Setup error traceback support for ereport()
2334  */
2335  spicallbackarg.query = src;
2336  spicallbackarg.mode = plan->parse_mode;
2337  spierrcontext.callback = _SPI_error_callback;
2338  spierrcontext.arg = &spicallbackarg;
2339  spierrcontext.previous = error_context_stack;
2340  error_context_stack = &spierrcontext;
2341 
2342  /*
2343  * Parse the request string into a list of raw parse trees.
2344  */
2345  raw_parsetree_list = raw_parser(src, plan->parse_mode);
2346 
2347  /*
2348  * Construct plancache entries, but don't do parse analysis yet.
2349  */
2350  plancache_list = NIL;
2351 
2352  foreach(list_item, raw_parsetree_list)
2353  {
2354  RawStmt *parsetree = lfirst_node(RawStmt, list_item);
2355  CachedPlanSource *plansource;
2356 
2357  plansource = CreateOneShotCachedPlan(parsetree,
2358  src,
2359  CreateCommandTag(parsetree->stmt));
2360 
2361  plancache_list = lappend(plancache_list, plansource);
2362  }
2363 
2364  plan->plancache_list = plancache_list;
2365  plan->oneshot = true;
2366 
2367  /*
2368  * Pop the error context stack
2369  */
2370  error_context_stack = spierrcontext.previous;
2371 }
List * raw_parser(const char *str, RawParseMode mode)
Definition: parser.c:42
CachedPlanSource * CreateOneShotCachedPlan(RawStmt *raw_parse_tree, const char *query_string, CommandTag commandTag)
Definition: plancache.c:276
Node * stmt
Definition: parsenodes.h:2025
CommandTag CreateCommandTag(Node *parsetree)
Definition: utility.c:2359

References _SPI_error_callback(), ErrorContextCallback::arg, ErrorContextCallback::callback, CreateCommandTag(), CreateOneShotCachedPlan(), error_context_stack, lappend(), lfirst_node, SPICallbackArg::mode, NIL, plan, ErrorContextCallback::previous, SPICallbackArg::query, raw_parser(), and RawStmt::stmt.

Referenced by SPI_execute(), SPI_execute_extended(), and SPI_execute_with_args().

◆ _SPI_prepare_plan()

static void _SPI_prepare_plan ( const char *  src,
SPIPlanPtr  plan 
)
static

Definition at line 2216 of file spi.c.

2217 {
2218  List *raw_parsetree_list;
2219  List *plancache_list;
2220  ListCell *list_item;
2221  SPICallbackArg spicallbackarg;
2222  ErrorContextCallback spierrcontext;
2223 
2224  /*
2225  * Setup error traceback support for ereport()
2226  */
2227  spicallbackarg.query = src;
2228  spicallbackarg.mode = plan->parse_mode;
2229  spierrcontext.callback = _SPI_error_callback;
2230  spierrcontext.arg = &spicallbackarg;
2231  spierrcontext.previous = error_context_stack;
2232  error_context_stack = &spierrcontext;
2233 
2234  /*
2235  * Parse the request string into a list of raw parse trees.
2236  */
2237  raw_parsetree_list = raw_parser(src, plan->parse_mode);
2238 
2239  /*
2240  * Do parse analysis and rule rewrite for each raw parsetree, storing the
2241  * results into unsaved plancache entries.
2242  */
2243  plancache_list = NIL;
2244 
2245  foreach(list_item, raw_parsetree_list)
2246  {
2247  RawStmt *parsetree = lfirst_node(RawStmt, list_item);
2248  List *stmt_list;
2249  CachedPlanSource *plansource;
2250 
2251  /*
2252  * Create the CachedPlanSource before we do parse analysis, since it
2253  * needs to see the unmodified raw parse tree.
2254  */
2255  plansource = CreateCachedPlan(parsetree,
2256  src,
2257  CreateCommandTag(parsetree->stmt));
2258 
2259  /*
2260  * Parameter datatypes are driven by parserSetup hook if provided,
2261  * otherwise we use the fixed parameter list.
2262  */
2263  if (plan->parserSetup != NULL)
2264  {
2265  Assert(plan->nargs == 0);
2266  stmt_list = pg_analyze_and_rewrite_withcb(parsetree,
2267  src,
2268  plan->parserSetup,
2269  plan->parserSetupArg,
2271  }
2272  else
2273  {
2274  stmt_list = pg_analyze_and_rewrite_fixedparams(parsetree,
2275  src,
2276  plan->argtypes,
2277  plan->nargs,
2279  }
2280 
2281  /* Finish filling in the CachedPlanSource */
2282  CompleteCachedPlan(plansource,
2283  stmt_list,
2284  NULL,
2285  plan->argtypes,
2286  plan->nargs,
2287  plan->parserSetup,
2288  plan->parserSetupArg,
2289  plan->cursor_options,
2290  false); /* not fixed result */
2291 
2292  plancache_list = lappend(plancache_list, plansource);
2293  }
2294 
2295  plan->plancache_list = plancache_list;
2296  plan->oneshot = false;
2297 
2298  /*
2299  * Pop the error context stack
2300  */
2301  error_context_stack = spierrcontext.previous;
2302 }
CachedPlanSource * CreateCachedPlan(RawStmt *raw_parse_tree, const char *query_string, CommandTag commandTag)
Definition: plancache.c:192

References _SPI_current, _SPI_error_callback(), ErrorContextCallback::arg, Assert, ErrorContextCallback::callback, CompleteCachedPlan(), CreateCachedPlan(), CreateCommandTag(), error_context_stack, lappend(), lfirst_node, SPICallbackArg::mode, NIL, pg_analyze_and_rewrite_fixedparams(), pg_analyze_and_rewrite_withcb(), plan, ErrorContextCallback::previous, SPICallbackArg::query, _SPI_connection::queryEnv, raw_parser(), and RawStmt::stmt.

Referenced by SPI_cursor_open_with_args(), SPI_cursor_parse_open(), SPI_prepare_cursor(), SPI_prepare_extended(), and SPI_prepare_params().

◆ _SPI_procmem()

static MemoryContext _SPI_procmem ( void  )
static

Definition at line 3056 of file spi.c.

3057 {
3059 }

References _SPI_current, MemoryContextSwitchTo(), and _SPI_connection::procCxt.

Referenced by _SPI_end_call(), and spi_dest_startup().

◆ _SPI_rollback()

static void _SPI_rollback ( bool  chain)
static

Definition at line 332 of file spi.c.

333 {
334  MemoryContext oldcontext = CurrentMemoryContext;
336 
337  /* see under SPI_commit() */
338  if (_SPI_current->atomic)
339  ereport(ERROR,
340  (errcode(ERRCODE_INVALID_TRANSACTION_TERMINATION),
341  errmsg("invalid transaction termination")));
342 
343  /* see under SPI_commit() */
344  if (IsSubTransaction())
345  ereport(ERROR,
346  (errcode(ERRCODE_INVALID_TRANSACTION_TERMINATION),
347  errmsg("cannot roll back while a subtransaction is active")));
348 
349  if (chain)
351 
352  /* Catch any error occurring during the ROLLBACK */
353  PG_TRY();
354  {
355  /* Protect current SPI stack entry against deletion */
356  _SPI_current->internal_xact = true;
357 
358  /*
359  * Hold any pinned portals that any PLs might be using. We have to do
360  * this before changing transaction state, since this will run
361  * user-defined code that might throw an error, and in any case
362  * couldn't be run in an already-aborted transaction.
363  */
365 
366  /* Release snapshots associated with portals */
368 
369  /* Do the deed */
371 
372  /* Immediately start a new transaction */
374  if (chain)
376 
377  MemoryContextSwitchTo(oldcontext);
378 
379  _SPI_current->internal_xact = false;
380  }
381  PG_CATCH();
382  {
383  ErrorData *edata;
384 
385  /* Save error info in caller's context */
386  MemoryContextSwitchTo(oldcontext);
387  edata = CopyErrorData();
388  FlushErrorState();
389 
390  /*
391  * Try again to abort the failed transaction. If this fails too,
392  * we'll just propagate the error out ... there's not that much we can
393  * do.
394  */
396 
397  /* ... and start a new one */
399  if (chain)
401 
402  MemoryContextSwitchTo(oldcontext);
403 
404  _SPI_current->internal_xact = false;
405 
406  /* Now that we've cleaned up the transaction, re-throw the error */
407  ReThrowError(edata);
408  }
409  PG_END_TRY();
410 }

References _SPI_current, AbortCurrentTransaction(), _SPI_connection::atomic, CopyErrorData(), CurrentMemoryContext, ereport, errcode(), errmsg(), ERROR, FlushErrorState(), ForgetPortalSnapshots(), HoldPinnedPortals(), _SPI_connection::internal_xact, IsSubTransaction(), MemoryContextSwitchTo(), PG_CATCH, PG_END_TRY, PG_TRY, RestoreTransactionCharacteristics(), ReThrowError(), SaveTransactionCharacteristics(), and StartTransactionCommand().

Referenced by SPI_rollback(), and SPI_rollback_and_chain().

◆ _SPI_save_plan()

static SPIPlanPtr _SPI_save_plan ( SPIPlanPtr  plan)
static

Definition at line 3201 of file spi.c.

3202 {
3203  SPIPlanPtr newplan;
3204  MemoryContext plancxt;
3205  MemoryContext oldcxt;
3206  ListCell *lc;
3207 
3208  /* One-shot plans can't be saved */
3209  Assert(!plan->oneshot);
3210 
3211  /*
3212  * Create a memory context for the plan. We don't expect the plan to be
3213  * very large, so use smaller-than-default alloc parameters. It's a
3214  * transient context until we finish copying everything.
3215  */
3217  "SPI Plan",
3219  oldcxt = MemoryContextSwitchTo(plancxt);
3220 
3221  /* Copy the SPI plan into its own context */
3222  newplan = (SPIPlanPtr) palloc0(sizeof(_SPI_plan));
3223  newplan->magic = _SPI_PLAN_MAGIC;
3224  newplan->plancxt = plancxt;
3225  newplan->parse_mode = plan->parse_mode;
3226  newplan->cursor_options = plan->cursor_options;
3227  newplan->nargs = plan->nargs;
3228  if (plan->nargs > 0)
3229  {
3230  newplan->argtypes = (Oid *) palloc(plan->nargs * sizeof(Oid));
3231  memcpy(newplan->argtypes, plan->argtypes, plan->nargs * sizeof(Oid));
3232  }
3233  else
3234  newplan->argtypes = NULL;
3235  newplan->parserSetup = plan->parserSetup;
3236  newplan->parserSetupArg = plan->parserSetupArg;
3237 
3238  /* Copy all the plancache entries */
3239  foreach(lc, plan->plancache_list)
3240  {
3241  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
3242  CachedPlanSource *newsource;
3243 
3244  newsource = CopyCachedPlan(plansource);
3245  newplan->plancache_list = lappend(newplan->plancache_list, newsource);
3246  }
3247 
3248  MemoryContextSwitchTo(oldcxt);
3249 
3250  /*
3251  * Mark it saved, reparent it under CacheMemoryContext, and mark all the
3252  * component CachedPlanSources as saved. This sequence cannot fail
3253  * partway through, so there's no risk of long-term memory leakage.
3254  */
3255  newplan->saved = true;
3257 
3258  foreach(lc, newplan->plancache_list)
3259  {
3260  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
3261 
3262  SaveCachedPlan(plansource);
3263  }
3264 
3265  return newplan;
3266 }
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:637
MemoryContext CacheMemoryContext
Definition: mcxt.c:152
void SaveCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:482
CachedPlanSource * CopyCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:1536
bool saved
Definition: spi_priv.h:93

References _SPI_PLAN_MAGIC, ALLOCSET_SMALL_SIZES, AllocSetContextCreate, _SPI_plan::argtypes, Assert, CacheMemoryContext, CopyCachedPlan(), CurrentMemoryContext, _SPI_plan::cursor_options, lappend(), lfirst, _SPI_plan::magic, MemoryContextSetParent(), MemoryContextSwitchTo(), _SPI_plan::nargs, palloc(), palloc0(), _SPI_plan::parse_mode, _SPI_plan::parserSetup, _SPI_plan::parserSetupArg, plan, _SPI_plan::plancache_list, _SPI_plan::plancxt, SaveCachedPlan(), and _SPI_plan::saved.

Referenced by SPI_saveplan().

◆ AtEOSubXact_SPI()

void AtEOSubXact_SPI ( bool  isCommit,
SubTransactionId  mySubid 
)

Definition at line 482 of file spi.c.

483 {
484  bool found = false;
485 
486  while (_SPI_connected >= 0)
487  {
489 
490  if (connection->connectSubid != mySubid)
491  break; /* couldn't be any underneath it either */
492 
493  if (connection->internal_xact)
494  break;
495 
496  found = true;
497 
498  /*
499  * Release procedure memory explicitly (see note in SPI_connect)
500  */
501  if (connection->execCxt)
502  {
504  connection->execCxt = NULL;
505  }
506  if (connection->procCxt)
507  {
509  connection->procCxt = NULL;
510  }
511 
512  /*
513  * Restore outer global variables and pop the stack entry. Unlike
514  * SPI_finish(), we don't risk switching to memory contexts that might
515  * be already gone.
516  */
517  SPI_processed = connection->outer_processed;
518  SPI_tuptable = connection->outer_tuptable;
519  SPI_result = connection->outer_result;
520 
521  _SPI_connected--;
522  if (_SPI_connected < 0)
523  _SPI_current = NULL;
524  else
526  }
527 
528  if (found && isCommit)
530  (errcode(ERRCODE_WARNING),
531  errmsg("subtransaction left non-empty SPI stack"),
532  errhint("Check for missing \"SPI_finish\" calls.")));
533 
534  /*
535  * If we are aborting a subtransaction and there is an open SPI context
536  * surrounding the subxact, clean up to prevent memory leakage.
537  */
538  if (_SPI_current && !isCommit)
539  {
540  slist_mutable_iter siter;
541 
542  /*
543  * Throw away executor state if current executor operation was started
544  * within current subxact (essentially, force a _SPI_end_call(true)).
545  */
546  if (_SPI_current->execSubid >= mySubid)
547  {
550  }
551 
552  /* throw away any tuple tables created within current subxact */
554  {
555  SPITupleTable *tuptable;
556 
557  tuptable = slist_container(SPITupleTable, next, siter.cur);
558  if (tuptable->subid >= mySubid)
559  {
560  /*
561  * If we used SPI_freetuptable() here, its internal search of
562  * the tuptables list would make this operation O(N^2).
563  * Instead, just free the tuptable manually. This should
564  * match what SPI_freetuptable() does.
565  */
566  slist_delete_current(&siter);
567  if (tuptable == _SPI_current->tuptable)
568  _SPI_current->tuptable = NULL;
569  if (tuptable == SPI_tuptable)
570  SPI_tuptable = NULL;
571  MemoryContextDelete(tuptable->tuptabcxt);
572  }
573  }
574  }
575 }
static int32 next
Definition: blutils.c:221
int errhint(const char *fmt,...)
Definition: elog.c:1315
#define WARNING
Definition: elog.h:36
static void slist_delete_current(slist_mutable_iter *iter)
Definition: ilist.h:1084
#define slist_foreach_modify(iter, lhead)
Definition: ilist.h:1148
#define slist_container(type, membername, ptr)
Definition: ilist.h:1106
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:454
static int _SPI_connected
Definition: spi.c:51
static _SPI_connection * _SPI_stack
Definition: spi.c:48
int SPI_result
Definition: spi.c:46
MemoryContext tuptabcxt
Definition: spi.h:31
SubTransactionId subid
Definition: spi.h:33
slist_head tuptables
Definition: spi_priv.h:32
slist_node * cur
Definition: ilist.h:274

References _SPI_connected, _SPI_current, _SPI_stack, slist_mutable_iter::cur, ereport, errcode(), errhint(), errmsg(), _SPI_connection::execCxt, _SPI_connection::execSubid, InvalidSubTransactionId, MemoryContextDelete(), MemoryContextReset(), next, slist_container, slist_delete_current(), slist_foreach_modify, SPI_processed, SPI_result, SPI_tuptable, SPITupleTable::subid, SPITupleTable::tuptabcxt, _SPI_connection::tuptable, _SPI_connection::tuptables, and WARNING.

Referenced by AbortSubTransaction(), and CommitSubTransaction().

◆ AtEOXact_SPI()

void AtEOXact_SPI ( bool  isCommit)

Definition at line 428 of file spi.c.

429 {
430  bool found = false;
431 
432  /*
433  * Pop stack entries, stopping if we find one marked internal_xact (that
434  * one belongs to the caller of SPI_commit or SPI_rollback).
435  */
436  while (_SPI_connected >= 0)
437  {
439 
440  if (connection->internal_xact)
441  break;
442 
443  found = true;
444 
445  /*
446  * We need not release the procedure's memory contexts explicitly, as
447  * they'll go away automatically when their parent context does; see
448  * notes in SPI_connect_ext.
449  */
450 
451  /*
452  * Restore outer global variables and pop the stack entry. Unlike
453  * SPI_finish(), we don't risk switching to memory contexts that might
454  * be already gone.
455  */
456  SPI_processed = connection->outer_processed;
457  SPI_tuptable = connection->outer_tuptable;
458  SPI_result = connection->outer_result;
459 
460  _SPI_connected--;
461  if (_SPI_connected < 0)
462  _SPI_current = NULL;
463  else
465  }
466 
467  /* We should only find entries to pop during an ABORT. */
468  if (found && isCommit)
470  (errcode(ERRCODE_WARNING),
471  errmsg("transaction left non-empty SPI stack"),
472  errhint("Check for missing \"SPI_finish\" calls.")));
473 }

References _SPI_connected, _SPI_current, _SPI_stack, ereport, errcode(), errhint(), errmsg(), SPI_processed, SPI_result, SPI_tuptable, and WARNING.

Referenced by AbortTransaction(), CommitTransaction(), and PrepareTransaction().

◆ SPI_commit()

void SPI_commit ( void  )

Definition at line 320 of file spi.c.

321 {
322  _SPI_commit(false);
323 }
static void _SPI_commit(bool chain)
Definition: spi.c:227

References _SPI_commit().

Referenced by exec_stmt_commit(), plperl_spi_commit(), pltcl_commit(), and PLy_commit().

◆ SPI_commit_and_chain()

void SPI_commit_and_chain ( void  )

Definition at line 326 of file spi.c.

327 {
328  _SPI_commit(true);
329 }

References _SPI_commit().

Referenced by exec_stmt_commit().

◆ SPI_connect()

◆ SPI_connect_ext()

int SPI_connect_ext ( int  options)

Definition at line 100 of file spi.c.

101 {
102  int newdepth;
103 
104  /* Enlarge stack if necessary */
105  if (_SPI_stack == NULL)
106  {
107  if (_SPI_connected != -1 || _SPI_stack_depth != 0)
108  elog(ERROR, "SPI stack corrupted");
109  newdepth = 16;
112  newdepth * sizeof(_SPI_connection));
113  _SPI_stack_depth = newdepth;
114  }
115  else
116  {
118  elog(ERROR, "SPI stack corrupted");
119  if (_SPI_stack_depth == _SPI_connected + 1)
120  {
121  newdepth = _SPI_stack_depth * 2;
124  newdepth * sizeof(_SPI_connection));
125  _SPI_stack_depth = newdepth;
126  }
127  }
128 
129  /* Enter new stack level */
130  _SPI_connected++;
132 
134  _SPI_current->processed = 0;
135  _SPI_current->tuptable = NULL;
138  _SPI_current->procCxt = NULL; /* in case we fail to create 'em */
139  _SPI_current->execCxt = NULL;
141  _SPI_current->queryEnv = NULL;
143  _SPI_current->internal_xact = false;
147 
148  /*
149  * Create memory contexts for this procedure
150  *
151  * In atomic contexts (the normal case), we use TopTransactionContext,
152  * otherwise PortalContext, so that it lives across transaction
153  * boundaries.
154  *
155  * XXX It could be better to use PortalContext as the parent context in
156  * all cases, but we may not be inside a portal (consider deferred-trigger
157  * execution). Perhaps CurTransactionContext could be an option? For now
158  * it doesn't matter because we clean up explicitly in AtEOSubXact_SPI();
159  * but see also AtEOXact_SPI().
160  */
162  "SPI Proc",
165  "SPI Exec",
167  /* ... and switch to procedure's context */
169 
170  /*
171  * Reset API global variables so that current caller cannot accidentally
172  * depend on state of an outer caller.
173  */
174  SPI_processed = 0;
175  SPI_tuptable = NULL;
176  SPI_result = 0;
177 
178  return SPI_OK_CONNECT;
179 }
static void slist_init(slist_head *head)
Definition: ilist.h:986
return false
Definition: isn.c:131
MemoryContext TopTransactionContext
Definition: mcxt.c:154
MemoryContext TopMemoryContext
Definition: mcxt.c:149
void * repalloc(void *pointer, Size size)
Definition: mcxt.c:1541
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:1181
MemoryContext PortalContext
Definition: mcxt.c:158
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:160
static int _SPI_stack_depth
Definition: spi.c:50
#define SPI_OPT_NONATOMIC
Definition: spi.h:102
#define SPI_OK_CONNECT
Definition: spi.h:82
SubTransactionId connectSubid
Definition: spi_priv.h:36
SPITupleTable * outer_tuptable
Definition: spi_priv.h:47
int outer_result
Definition: spi_priv.h:48
uint64 outer_processed
Definition: spi_priv.h:46
MemoryContext savedcxt
Definition: spi_priv.h:35

References _SPI_connected, _SPI_current, _SPI_stack, _SPI_stack_depth, ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, _SPI_connection::atomic, _SPI_connection::connectSubid, elog, ERROR, _SPI_connection::execCxt, _SPI_connection::execSubid, false, GetCurrentSubTransactionId(), _SPI_connection::internal_xact, InvalidSubTransactionId, MemoryContextAlloc(), MemoryContextSwitchTo(), _SPI_connection::outer_processed, _SPI_connection::outer_result, _SPI_connection::outer_tuptable, PortalContext, _SPI_connection::procCxt, _SPI_connection::processed, _SPI_connection::queryEnv, repalloc(), _SPI_connection::savedcxt, slist_init(), SPI_OK_CONNECT, SPI_OPT_NONATOMIC, SPI_processed, SPI_result, SPI_tuptable, TopMemoryContext, TopTransactionContext, _SPI_connection::tuptable, and _SPI_connection::tuptables.

Referenced by plperl_func_handler(), plperl_inline_handler(), plpgsql_call_handler(), plpgsql_inline_handler(), plpython3_call_handler(), plpython3_inline_handler(), pltcl_func_handler(), and SPI_connect().

◆ SPI_copytuple()

HeapTuple SPI_copytuple ( HeapTuple  tuple)

Definition at line 1044 of file spi.c.

1045 {
1046  MemoryContext oldcxt;
1047  HeapTuple ctuple;
1048 
1049  if (tuple == NULL)
1050  {
1052  return NULL;
1053  }
1054 
1055  if (_SPI_current == NULL)
1056  {
1058  return NULL;
1059  }
1060 
1062 
1063  ctuple = heap_copytuple(tuple);
1064 
1065  MemoryContextSwitchTo(oldcxt);
1066 
1067  return ctuple;
1068 }
HeapTuple heap_copytuple(HeapTuple tuple)
Definition: heaptuple.c:776
#define SPI_ERROR_ARGUMENT
Definition: spi.h:73

References _SPI_current, heap_copytuple(), MemoryContextSwitchTo(), _SPI_connection::savedcxt, SPI_ERROR_ARGUMENT, SPI_ERROR_UNCONNECTED, and SPI_result.

Referenced by get_tuple_of_interest(), and plpgsql_exec_trigger().

◆ SPI_cursor_close()

void SPI_cursor_close ( Portal  portal)

Definition at line 1859 of file spi.c.

1860 {
1861  if (!PortalIsValid(portal))
1862  elog(ERROR, "invalid portal in SPI cursor operation");
1863 
1864  PortalDrop(portal, false);
1865 }
void PortalDrop(Portal portal, bool isTopCommit)
Definition: portalmem.c:468

References elog, ERROR, PortalDrop(), and PortalIsValid.

Referenced by exec_stmt_close(), exec_stmt_dynfors(), exec_stmt_forc(), exec_stmt_fors(), plperl_spi_cursor_close(), plperl_spi_fetchrow(), PLy_cursor_close(), PLy_cursor_dealloc(), query_to_xml_and_xmlschema(), query_to_xmlschema(), ts_stat_sql(), and tsquery_rewrite_query().

◆ SPI_cursor_fetch()

void SPI_cursor_fetch ( Portal  portal,
bool  forward,
long  count 
)

Definition at line 1803 of file spi.c.

1804 {
1805  _SPI_cursor_operation(portal,
1806  forward ? FETCH_FORWARD : FETCH_BACKWARD, count,
1808  /* we know that the DestSPI receiver doesn't need a destroy call */
1809 }
@ FETCH_FORWARD
Definition: parsenodes.h:3324
@ FETCH_BACKWARD
Definition: parsenodes.h:3325
static void _SPI_cursor_operation(Portal portal, FetchDirection direction, long count, DestReceiver *dest)
Definition: spi.c:2999

References _SPI_cursor_operation(), CreateDestReceiver(), DestSPI, FETCH_BACKWARD, and FETCH_FORWARD.

Referenced by cursor_to_xml(), exec_for_query(), plperl_spi_fetchrow(), PLy_cursor_fetch(), PLy_cursor_iternext(), ts_stat_sql(), and tsquery_rewrite_query().

◆ SPI_cursor_find()

Portal SPI_cursor_find ( const char *  name)

Definition at line 1791 of file spi.c.

1792 {
1793  return GetPortalByName(name);
1794 }
Portal GetPortalByName(const char *name)
Definition: portalmem.c:130

References GetPortalByName(), and name.

Referenced by cursor_to_xml(), cursor_to_xmlschema(), exec_stmt_close(), exec_stmt_fetch(), exec_stmt_forc(), exec_stmt_open(), plperl_spi_cursor_close(), and plperl_spi_fetchrow().

◆ SPI_cursor_move()

void SPI_cursor_move ( Portal  portal,
bool  forward,
long  count 
)

Definition at line 1818 of file spi.c.

1819 {
1820  _SPI_cursor_operation(portal,
1821  forward ? FETCH_FORWARD : FETCH_BACKWARD, count,
1822  None_Receiver);
1823 }
DestReceiver * None_Receiver
Definition: dest.c:96

References _SPI_cursor_operation(), FETCH_BACKWARD, FETCH_FORWARD, and None_Receiver.

◆ SPI_cursor_open()

Portal SPI_cursor_open ( const char *  name,
SPIPlanPtr  plan,
Datum Values,
const char *  Nulls,
bool  read_only 
)

Definition at line 1442 of file spi.c.

1445 {
1446  Portal portal;
1447  ParamListInfo paramLI;
1448 
1449  /* build transient ParamListInfo in caller's context */
1450  paramLI = _SPI_convert_params(plan->nargs, plan->argtypes,
1451  Values, Nulls);
1452 
1453  portal = SPI_cursor_open_internal(name, plan, paramLI, read_only);
1454 
1455  /* done with the transient ParamListInfo */
1456  if (paramLI)
1457  pfree(paramLI);
1458 
1459  return portal;
1460 }
void pfree(void *pointer)
Definition: mcxt.c:1521
static ParamListInfo _SPI_convert_params(int nargs, Oid *argtypes, Datum *Values, const char *Nulls)
Definition: spi.c:2841
static Portal SPI_cursor_open_internal(const char *name, SPIPlanPtr plan, ParamListInfo paramLI, bool read_only)
Definition: spi.c:1574

References _SPI_convert_params(), name, Nulls, pfree(), plan, and SPI_cursor_open_internal().

Referenced by plperl_spi_query(), plperl_spi_query_prepared(), PLy_cursor_plan(), PLy_cursor_query(), query_to_xml_and_xmlschema(), query_to_xmlschema(), ts_stat_sql(), and tsquery_rewrite_query().

◆ SPI_cursor_open_internal()

static Portal SPI_cursor_open_internal ( const char *  name,
SPIPlanPtr  plan,
ParamListInfo  paramLI,
bool  read_only 
)
static

Definition at line 1574 of file spi.c.

1576 {
1577  CachedPlanSource *plansource;
1578  CachedPlan *cplan;
1579  List *stmt_list;
1580  char *query_string;
1581  Snapshot snapshot;
1582  MemoryContext oldcontext;
1583  Portal portal;
1584  SPICallbackArg spicallbackarg;
1585  ErrorContextCallback spierrcontext;
1586 
1587  /*
1588  * Check that the plan is something the Portal code will special-case as
1589  * returning one tupleset.
1590  */
1591  if (!SPI_is_cursor_plan(plan))
1592  {
1593  /* try to give a good error message */
1594  const char *cmdtag;
1595 
1596  if (list_length(plan->plancache_list) != 1)
1597  ereport(ERROR,
1598  (errcode(ERRCODE_INVALID_CURSOR_DEFINITION),
1599  errmsg("cannot open multi-query plan as cursor")));
1600  plansource = (CachedPlanSource *) linitial(plan->plancache_list);
1601  /* A SELECT that fails SPI_is_cursor_plan() must be SELECT INTO */
1602  if (plansource->commandTag == CMDTAG_SELECT)
1603  cmdtag = "SELECT INTO";
1604  else
1605  cmdtag = GetCommandTagName(plansource->commandTag);
1606  ereport(ERROR,
1607  (errcode(ERRCODE_INVALID_CURSOR_DEFINITION),
1608  /* translator: %s is name of a SQL command, eg INSERT */
1609  errmsg("cannot open %s query as cursor", cmdtag)));
1610  }
1611 
1612  Assert(list_length(plan->plancache_list) == 1);
1613  plansource = (CachedPlanSource *) linitial(plan->plancache_list);
1614 
1615  /* Push the SPI stack */
1616  if (_SPI_begin_call(true) < 0)
1617  elog(ERROR, "SPI_cursor_open called while not connected");
1618 
1619  /* Reset SPI result (note we deliberately don't touch lastoid) */
1620  SPI_processed = 0;
1621  SPI_tuptable = NULL;
1622  _SPI_current->processed = 0;
1623  _SPI_current->tuptable = NULL;
1624 
1625  /* Create the portal */
1626  if (name == NULL || name[0] == '\0')
1627  {
1628  /* Use a random nonconflicting name */
1629  portal = CreateNewPortal();
1630  }
1631  else
1632  {
1633  /* In this path, error if portal of same name already exists */
1634  portal = CreatePortal(name, false, false);
1635  }
1636 
1637  /* Copy the plan's query string into the portal */
1638  query_string = MemoryContextStrdup(portal->portalContext,
1639  plansource->query_string);
1640 
1641  /*
1642  * Setup error traceback support for ereport(), in case GetCachedPlan
1643  * throws an error.
1644  */
1645  spicallbackarg.query = plansource->query_string;
1646  spicallbackarg.mode = plan->parse_mode;
1647  spierrcontext.callback = _SPI_error_callback;
1648  spierrcontext.arg = &spicallbackarg;
1649  spierrcontext.previous = error_context_stack;
1650  error_context_stack = &spierrcontext;
1651 
1652  /*
1653  * Note: for a saved plan, we mustn't have any failure occur between
1654  * GetCachedPlan and PortalDefineQuery; that would result in leaking our
1655  * plancache refcount.
1656  */
1657 
1658  /* Replan if needed, and increment plan refcount for portal */
1659  cplan = GetCachedPlan(plansource, paramLI, NULL, _SPI_current->queryEnv);
1660  stmt_list = cplan->stmt_list;
1661 
1662  if (!plan->saved)
1663  {
1664  /*
1665  * We don't want the portal to depend on an unsaved CachedPlanSource,
1666  * so must copy the plan into the portal's context. An error here
1667  * will result in leaking our refcount on the plan, but it doesn't
1668  * matter because the plan is unsaved and hence transient anyway.
1669  */
1670  oldcontext = MemoryContextSwitchTo(portal->portalContext);
1671  stmt_list = copyObject(stmt_list);
1672  MemoryContextSwitchTo(oldcontext);
1673  ReleaseCachedPlan(cplan, NULL);
1674  cplan = NULL; /* portal shouldn't depend on cplan */
1675  }
1676 
1677  /*
1678  * Set up the portal.
1679  */
1680  PortalDefineQuery(portal,
1681  NULL, /* no statement name */
1682  query_string,
1683  plansource->commandTag,
1684  stmt_list,
1685  cplan);
1686 
1687  /*
1688  * Set up options for portal. Default SCROLL type is chosen the same way
1689  * as PerformCursorOpen does it.
1690  */
1691  portal->cursorOptions = plan->cursor_options;
1693  {
1694  if (list_length(stmt_list) == 1 &&
1695  linitial_node(PlannedStmt, stmt_list)->commandType != CMD_UTILITY &&
1696  linitial_node(PlannedStmt, stmt_list)->rowMarks == NIL &&
1697  ExecSupportsBackwardScan(linitial_node(PlannedStmt, stmt_list)->planTree))
1698  portal->cursorOptions |= CURSOR_OPT_SCROLL;
1699  else
1701  }
1702 
1703  /*
1704  * Disallow SCROLL with SELECT FOR UPDATE. This is not redundant with the
1705  * check in transformDeclareCursorStmt because the cursor options might
1706  * not have come through there.
1707  */
1708  if (portal->cursorOptions & CURSOR_OPT_SCROLL)
1709  {
1710  if (list_length(stmt_list) == 1 &&
1711  linitial_node(PlannedStmt, stmt_list)->commandType != CMD_UTILITY &&
1712  linitial_node(PlannedStmt, stmt_list)->rowMarks != NIL)
1713  ereport(ERROR,
1714  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1715  errmsg("DECLARE SCROLL CURSOR ... FOR UPDATE/SHARE is not supported"),
1716  errdetail("Scrollable cursors must be READ ONLY.")));
1717  }
1718 
1719  /* Make current query environment available to portal at execution time. */
1720  portal->queryEnv = _SPI_current->queryEnv;
1721 
1722  /*
1723  * If told to be read-only, we'd better check for read-only queries. This
1724  * can't be done earlier because we need to look at the finished, planned
1725  * queries. (In particular, we don't want to do it between GetCachedPlan
1726  * and PortalDefineQuery, because throwing an error between those steps
1727  * would result in leaking our plancache refcount.)
1728  */
1729  if (read_only)
1730  {
1731  ListCell *lc;
1732 
1733  foreach(lc, stmt_list)
1734  {
1735  PlannedStmt *pstmt = lfirst_node(PlannedStmt, lc);
1736 
1737  if (!CommandIsReadOnly(pstmt))
1738  ereport(ERROR,
1739  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1740  /* translator: %s is a SQL statement name */
1741  errmsg("%s is not allowed in a non-volatile function",
1742  CreateCommandName((Node *) pstmt))));
1743  }
1744  }
1745 
1746  /* Set up the snapshot to use. */
1747  if (read_only)
1748  snapshot = GetActiveSnapshot();
1749  else
1750  {
1752  snapshot = GetTransactionSnapshot();
1753  }
1754 
1755  /*
1756  * If the plan has parameters, copy them into the portal. Note that this
1757  * must be done after revalidating the plan, because in dynamic parameter
1758  * cases the set of parameters could have changed during re-parsing.
1759  */
1760  if (paramLI)
1761  {
1762  oldcontext = MemoryContextSwitchTo(portal->portalContext);
1763  paramLI = copyParamList(paramLI);
1764  MemoryContextSwitchTo(oldcontext);
1765  }
1766 
1767  /*
1768  * Start portal execution.
1769  */
1770  PortalStart(portal, paramLI, 0, snapshot);
1771 
1772  Assert(portal->strategy != PORTAL_MULTI_QUERY);
1773 
1774  /* Pop the error context stack */
1775  error_context_stack = spierrcontext.previous;
1776 
1777  /* Pop the SPI stack */
1778  _SPI_end_call(true);
1779 
1780  /* Return the created portal */
1781  return portal;
1782 }
int errdetail(const char *fmt,...)
Definition: elog.c:1201
bool ExecSupportsBackwardScan(Plan *node)
Definition: execAmi.c:510
char * MemoryContextStrdup(MemoryContext context, const char *string)
Definition: mcxt.c:1683
#define copyObject(obj)
Definition: nodes.h:224
@ CMD_UTILITY
Definition: nodes.h:270
ParamListInfo copyParamList(ParamListInfo from)
Definition: params.c:78
#define CURSOR_OPT_SCROLL
Definition: parsenodes.h:3287
#define CURSOR_OPT_NO_SCROLL
Definition: parsenodes.h:3288
#define linitial(l)
Definition: pg_list.h:178
@ PORTAL_MULTI_QUERY
Definition: portal.h:95
Portal CreateNewPortal(void)
Definition: portalmem.c:235
void PortalDefineQuery(Portal portal, const char *prepStmtName, const char *sourceText, CommandTag commandTag, List *stmts, CachedPlan *cplan)
Definition: portalmem.c:282
Portal CreatePortal(const char *name, bool allowDup, bool dupSilent)
Definition: portalmem.c:175
void PortalStart(Portal portal, ParamListInfo params, int eflags, Snapshot snapshot)
Definition: pquery.c:433
bool SPI_is_cursor_plan(SPIPlanPtr plan)
Definition: spi.c:1907
QueryEnvironment * queryEnv
Definition: portal.h:143
MemoryContext portalContext
Definition: portal.h:120
int cursorOptions
Definition: portal.h:147
PortalStrategy strategy
Definition: portal.h:146

References _SPI_begin_call(), _SPI_current, _SPI_end_call(), _SPI_error_callback(), ErrorContextCallback::arg, Assert, ErrorContextCallback::callback, CMD_UTILITY, CommandCounterIncrement(), CommandIsReadOnly(), CachedPlanSource::commandTag, copyObject, copyParamList(), CreateCommandName(), CreateNewPortal(), CreatePortal(), CURSOR_OPT_NO_SCROLL, CURSOR_OPT_SCROLL, PortalData::cursorOptions, elog, ereport, errcode(), errdetail(), errmsg(), ERROR, error_context_stack, ExecSupportsBackwardScan(), GetActiveSnapshot(), GetCachedPlan(), GetCommandTagName(), GetTransactionSnapshot(), lfirst_node, linitial, linitial_node, list_length(), MemoryContextStrdup(), MemoryContextSwitchTo(), SPICallbackArg::mode, name, NIL, plan, PORTAL_MULTI_QUERY, PortalData::portalContext, PortalDefineQuery(), PortalStart(), ErrorContextCallback::previous, _SPI_connection::processed, SPICallbackArg::query, CachedPlanSource::query_string, _SPI_connection::queryEnv, PortalData::queryEnv, ReleaseCachedPlan(), SPI_is_cursor_plan(), SPI_processed, SPI_tuptable, CachedPlan::stmt_list, PortalData::strategy, and _SPI_connection::tuptable.

Referenced by SPI_cursor_open(), SPI_cursor_open_with_args(), SPI_cursor_open_with_paramlist(), and SPI_cursor_parse_open().

◆ SPI_cursor_open_with_args()

Portal SPI_cursor_open_with_args ( const char *  name,
const char *  src,
int  nargs,
Oid argtypes,
Datum Values,
const char *  Nulls,
bool  read_only,
int  cursorOptions 
)

Definition at line 1469 of file spi.c.

1474 {
1475  Portal result;
1476  _SPI_plan plan;
1477  ParamListInfo paramLI;
1478 
1479  if (src == NULL || nargs < 0)
1480  elog(ERROR, "SPI_cursor_open_with_args called with invalid arguments");
1481 
1482  if (nargs > 0 && (argtypes == NULL || Values == NULL))
1483  elog(ERROR, "SPI_cursor_open_with_args called with missing parameters");
1484 
1485  SPI_result = _SPI_begin_call(true);
1486  if (SPI_result < 0)
1487  elog(ERROR, "SPI_cursor_open_with_args called while not connected");
1488 
1489  memset(&plan, 0, sizeof(_SPI_plan));
1490  plan.magic = _SPI_PLAN_MAGIC;
1491  plan.parse_mode = RAW_PARSE_DEFAULT;
1492  plan.cursor_options = cursorOptions;
1493  plan.nargs = nargs;
1494  plan.argtypes = argtypes;
1495  plan.parserSetup = NULL;
1496  plan.parserSetupArg = NULL;
1497 
1498  /* build transient ParamListInfo in executor context */
1499  paramLI = _SPI_convert_params(nargs, argtypes,
1500  Values, Nulls);
1501 
1502  _SPI_prepare_plan(src, &plan);
1503 
1504  /* We needn't copy the plan; SPI_cursor_open_internal will do so */
1505 
1506  result = SPI_cursor_open_internal(name, &plan, paramLI, read_only);
1507 
1508  /* And clean up */
1509  _SPI_end_call(true);
1510 
1511  return result;
1512 }
@ RAW_PARSE_DEFAULT
Definition: parser.h:39
static void _SPI_prepare_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:2216

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), elog, ERROR, name, Nulls, plan, RAW_PARSE_DEFAULT, SPI_cursor_open_internal(), and SPI_result.

◆ SPI_cursor_open_with_paramlist()

Portal SPI_cursor_open_with_paramlist ( const char *  name,
SPIPlanPtr  plan,
ParamListInfo  params,
bool  read_only 
)

Definition at line 1522 of file spi.c.

1524 {
1525  return SPI_cursor_open_internal(name, plan, params, read_only);
1526 }

References name, plan, and SPI_cursor_open_internal().

Referenced by exec_run_select(), exec_stmt_forc(), and exec_stmt_open().

◆ SPI_cursor_parse_open()

Portal SPI_cursor_parse_open ( const char *  name,
const char *  src,
const SPIParseOpenOptions options 
)

Definition at line 1530 of file spi.c.

1533 {
1534  Portal result;
1535  _SPI_plan plan;
1536 
1537  if (src == NULL || options == NULL)
1538  elog(ERROR, "SPI_cursor_parse_open called with invalid arguments");
1539 
1540  SPI_result = _SPI_begin_call(true);
1541  if (SPI_result < 0)
1542  elog(ERROR, "SPI_cursor_parse_open called while not connected");
1543 
1544  memset(&plan, 0, sizeof(_SPI_plan));
1545  plan.magic = _SPI_PLAN_MAGIC;
1546  plan.parse_mode = RAW_PARSE_DEFAULT;
1547  plan.cursor_options = options->cursorOptions;
1548  if (options->params)
1549  {
1550  plan.parserSetup = options->params->parserSetup;
1551  plan.parserSetupArg = options->params->parserSetupArg;
1552  }
1553 
1554  _SPI_prepare_plan(src, &plan);
1555 
1556  /* We needn't copy the plan; SPI_cursor_open_internal will do so */
1557 
1558  result = SPI_cursor_open_internal(name, &plan,
1559  options->params, options->read_only);
1560 
1561  /* And clean up */
1562  _SPI_end_call(true);
1563 
1564  return result;
1565 }

References _SPI_begin_call(), _SPI_end_call(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), elog, ERROR, name, plan, RAW_PARSE_DEFAULT, SPI_cursor_open_internal(), and SPI_result.

Referenced by exec_dynquery_with_params().

◆ SPI_datumTransfer()

Datum SPI_datumTransfer ( Datum  value,
bool  typByVal,
int  typLen 
)

Definition at line 1358 of file spi.c.

1359 {
1360  MemoryContext oldcxt;
1361  Datum result;
1362 
1363  if (_SPI_current == NULL)
1364  elog(ERROR, "SPI_datumTransfer called while not connected to SPI");
1365 
1367 
1368  result = datumTransfer(value, typByVal, typLen);
1369 
1370  MemoryContextSwitchTo(oldcxt);
1371 
1372  return result;
1373 }
Datum datumTransfer(Datum value, bool typByVal, int typLen)
Definition: datum.c:194
static struct @155 value
uintptr_t Datum
Definition: postgres.h:64

References _SPI_current, datumTransfer(), elog, ERROR, MemoryContextSwitchTo(), _SPI_connection::savedcxt, and value.

Referenced by coerce_function_result_tuple(), and plpgsql_exec_function().

◆ spi_dest_startup()

void spi_dest_startup ( DestReceiver self,
int  operation,
TupleDesc  typeinfo 
)

Definition at line 2118 of file spi.c.

2119 {
2120  SPITupleTable *tuptable;
2121  MemoryContext oldcxt;
2122  MemoryContext tuptabcxt;
2123 
2124  if (_SPI_current == NULL)
2125  elog(ERROR, "spi_dest_startup called while not connected to SPI");
2126 
2127  if (_SPI_current->tuptable != NULL)
2128  elog(ERROR, "improper call to spi_dest_startup");
2129 
2130  /* We create the tuple table context as a child of procCxt */
2131 
2132  oldcxt = _SPI_procmem(); /* switch to procedure memory context */
2133 
2135  "SPI TupTable",
2137  MemoryContextSwitchTo(tuptabcxt);
2138 
2139  _SPI_current->tuptable = tuptable = (SPITupleTable *)
2140  palloc0(sizeof(SPITupleTable));
2141  tuptable->tuptabcxt = tuptabcxt;
2142  tuptable->subid = GetCurrentSubTransactionId();
2143 
2144  /*
2145  * The tuptable is now valid enough to be freed by AtEOSubXact_SPI, so put
2146  * it onto the SPI context's tuptables list. This will ensure it's not
2147  * leaked even in the unlikely event the following few lines fail.
2148  */
2149  slist_push_head(&_SPI_current->tuptables, &tuptable->next);
2150 
2151  /* set up initial allocations */
2152  tuptable->alloced = 128;
2153  tuptable->vals = (HeapTuple *) palloc(tuptable->alloced * sizeof(HeapTuple));
2154  tuptable->numvals = 0;
2155  tuptable->tupdesc = CreateTupleDescCopy(typeinfo);
2156 
2157  MemoryContextSwitchTo(oldcxt);
2158 }
static void slist_push_head(slist_head *head, slist_node *node)
Definition: ilist.h:1006
uint64 alloced
Definition: spi.h:30
TupleDesc tupdesc
Definition: spi.h:25
HeapTuple * vals
Definition: spi.h:26
slist_node next
Definition: spi.h:32
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:133

References _SPI_current, _SPI_procmem(), SPITupleTable::alloced, ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, CreateTupleDescCopy(), CurrentMemoryContext, elog, ERROR, GetCurrentSubTransactionId(), MemoryContextSwitchTo(), SPITupleTable::next, SPITupleTable::numvals, palloc(), palloc0(), slist_push_head(), SPITupleTable::subid, SPITupleTable::tupdesc, SPITupleTable::tuptabcxt, _SPI_connection::tuptable, _SPI_connection::tuptables, and SPITupleTable::vals.

◆ SPI_exec()

int SPI_exec ( const char *  src,
long  tcount 
)

Definition at line 627 of file spi.c.

628 {
629  return SPI_execute(src, false, tcount);
630 }
int SPI_execute(const char *src, bool read_only, long tcount)
Definition: spi.c:593

References SPI_execute().

Referenced by get_tuple_of_interest(), refresh_by_match_merge(), and xpath_table().

◆ SPI_execp()

int SPI_execp ( SPIPlanPtr  plan,
Datum Values,
const char *  Nulls,
long  tcount 
)

Definition at line 701 of file spi.c.

702 {
703  return SPI_execute_plan(plan, Values, Nulls, false, tcount);
704 }
int SPI_execute_plan(SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only, long tcount)
Definition: spi.c:669

References Nulls, plan, and SPI_execute_plan().

Referenced by check_foreign_key(), check_primary_key(), and ttdummy().

◆ SPI_execute()

int SPI_execute ( const char *  src,
bool  read_only,
long  tcount 
)

Definition at line 593 of file spi.c.

594 {
595  _SPI_plan plan;
597  int res;
598 
599  if (src == NULL || tcount < 0)
600  return SPI_ERROR_ARGUMENT;
601 
602  res = _SPI_begin_call(true);
603  if (res < 0)
604  return res;
605 
606  memset(&plan, 0, sizeof(_SPI_plan));
607  plan.magic = _SPI_PLAN_MAGIC;
608  plan.parse_mode = RAW_PARSE_DEFAULT;
609  plan.cursor_options = CURSOR_OPT_PARALLEL_OK;
610 
612 
613  memset(&options, 0, sizeof(options));
614  options.read_only = read_only;
615  options.tcount = tcount;
616 
619  true);
620 
621  _SPI_end_call(true);
622  return res;
623 }
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:3296
static char ** options
static int _SPI_execute_plan(SPIPlanPtr plan, const SPIExecuteOptions *options, Snapshot snapshot, Snapshot crosscheck_snapshot, bool fire_triggers)
Definition: spi.c:2394
static void _SPI_prepare_oneshot_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:2324

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_prepare_oneshot_plan(), CURSOR_OPT_PARALLEL_OK, InvalidSnapshot, options, plan, RAW_PARSE_DEFAULT, res, and SPI_ERROR_ARGUMENT.

Referenced by build_tuplestore_recursively(), crosstab(), get_crosstab_tuplestore(), initialize_worker_spi(), load_categories_hash(), plperl_spi_exec(), pltcl_SPI_execute(), PLy_spi_execute_query(), query_to_oid_list(), query_to_xml_internal(), refresh_by_match_merge(), SPI_exec(), and worker_spi_main().

◆ SPI_execute_extended()

int SPI_execute_extended ( const char *  src,
const SPIExecuteOptions options 
)

Definition at line 634 of file spi.c.

636 {
637  int res;
638  _SPI_plan plan;
639 
640  if (src == NULL || options == NULL)
641  return SPI_ERROR_ARGUMENT;
642 
643  res = _SPI_begin_call(true);
644  if (res < 0)
645  return res;
646 
647  memset(&plan, 0, sizeof(_SPI_plan));
648  plan.magic = _SPI_PLAN_MAGIC;
649  plan.parse_mode = RAW_PARSE_DEFAULT;
650  plan.cursor_options = CURSOR_OPT_PARALLEL_OK;
651  if (options->params)
652  {
653  plan.parserSetup = options->params->parserSetup;
654  plan.parserSetupArg = options->params->parserSetupArg;
655  }
656 
658 
661  true);
662 
663  _SPI_end_call(true);
664  return res;
665 }

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_prepare_oneshot_plan(), CURSOR_OPT_PARALLEL_OK, InvalidSnapshot, plan, RAW_PARSE_DEFAULT, res, and SPI_ERROR_ARGUMENT.

Referenced by exec_stmt_dynexecute(), and exec_stmt_return_query().

◆ SPI_execute_plan()

int SPI_execute_plan ( SPIPlanPtr  plan,
Datum Values,
const char *  Nulls,
bool  read_only,
long  tcount 
)

Definition at line 669 of file spi.c.

671 {
673  int res;
674 
675  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
676  return SPI_ERROR_ARGUMENT;
677 
678  if (plan->nargs > 0 && Values == NULL)
679  return SPI_ERROR_PARAM;
680 
681  res = _SPI_begin_call(true);
682  if (res < 0)
683  return res;
684 
685  memset(&options, 0, sizeof(options));
686  options.params = _SPI_convert_params(plan->nargs, plan->argtypes,
687  Values, Nulls);
688  options.read_only = read_only;
689  options.tcount = tcount;
690 
693  true);
694 
695  _SPI_end_call(true);
696  return res;
697 }
#define SPI_ERROR_PARAM
Definition: spi.h:74

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, InvalidSnapshot, Nulls, options, plan, res, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

Referenced by pg_get_ruledef_worker(), pg_get_viewdef_worker(), plperl_spi_exec_prepared(), pltcl_SPI_execute_plan(), PLy_spi_execute_plan(), SPI_execp(), and test_predtest().

◆ SPI_execute_plan_extended()

int SPI_execute_plan_extended ( SPIPlanPtr  plan,
const SPIExecuteOptions options 
)

Definition at line 708 of file spi.c.

710 {
711  int res;
712 
713  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || options == NULL)
714  return SPI_ERROR_ARGUMENT;
715 
716  res = _SPI_begin_call(true);
717  if (res < 0)
718  return res;
719 
722  true);
723 
724  _SPI_end_call(true);
725  return res;
726 }

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, InvalidSnapshot, plan, res, and SPI_ERROR_ARGUMENT.

Referenced by exec_stmt_call(), and exec_stmt_return_query().

◆ SPI_execute_plan_with_paramlist()

int SPI_execute_plan_with_paramlist ( SPIPlanPtr  plan,
ParamListInfo  params,
bool  read_only,
long  tcount 
)

Definition at line 730 of file spi.c.

732 {
734  int res;
735 
736  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
737  return SPI_ERROR_ARGUMENT;
738 
739  res = _SPI_begin_call(true);
740  if (res < 0)
741  return res;
742 
743  memset(&options, 0, sizeof(options));
744  options.params = params;
745  options.read_only = read_only;
746  options.tcount = tcount;
747 
750  true);
751 
752  _SPI_end_call(true);
753  return res;
754 }

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, InvalidSnapshot, options, plan, res, and SPI_ERROR_ARGUMENT.

Referenced by exec_run_select(), and exec_stmt_execsql().

◆ SPI_execute_snapshot()

int SPI_execute_snapshot ( SPIPlanPtr  plan,
Datum Values,
const char *  Nulls,
Snapshot  snapshot,
Snapshot  crosscheck_snapshot,
bool  read_only,
bool  fire_triggers,
long  tcount 
)

Definition at line 770 of file spi.c.

774 {
776  int res;
777 
778  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
779  return SPI_ERROR_ARGUMENT;
780 
781  if (plan->nargs > 0 && Values == NULL)
782  return SPI_ERROR_PARAM;
783 
784  res = _SPI_begin_call(true);
785  if (res < 0)
786  return res;
787 
788  memset(&options, 0, sizeof(options));
789  options.params = _SPI_convert_params(plan->nargs, plan->argtypes,
790  Values, Nulls);
791  options.read_only = read_only;
792  options.tcount = tcount;
793 
795  snapshot, crosscheck_snapshot,
796  fire_triggers);
797 
798  _SPI_end_call(true);
799  return res;
800 }

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, Nulls, options, plan, res, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

Referenced by RI_Initial_Check(), RI_PartitionRemove_Check(), and ri_PerformCheck().

◆ SPI_execute_with_args()

int SPI_execute_with_args ( const char *  src,
int  nargs,
Oid argtypes,
Datum Values,
const char *  Nulls,
bool  read_only,
long  tcount 
)

Definition at line 809 of file spi.c.

813 {
814  int res;
815  _SPI_plan plan;
816  ParamListInfo paramLI;
818 
819  if (src == NULL || nargs < 0 || tcount < 0)
820  return SPI_ERROR_ARGUMENT;
821 
822  if (nargs > 0 && (argtypes == NULL || Values == NULL))
823  return SPI_ERROR_PARAM;
824 
825  res = _SPI_begin_call(true);
826  if (res < 0)
827  return res;
828 
829  memset(&plan, 0, sizeof(_SPI_plan));
830  plan.magic = _SPI_PLAN_MAGIC;
831  plan.parse_mode = RAW_PARSE_DEFAULT;
832  plan.cursor_options = CURSOR_OPT_PARALLEL_OK;
833  plan.nargs = nargs;
834  plan.argtypes = argtypes;
835  plan.parserSetup = NULL;
836  plan.parserSetupArg = NULL;
837 
838  paramLI = _SPI_convert_params(nargs, argtypes,
839  Values, Nulls);
840 
842 
843  memset(&options, 0, sizeof(options));
844  options.params = paramLI;
845  options.read_only = read_only;
846  options.tcount = tcount;
847 
850  true);
851 
852  _SPI_end_call(true);
853  return res;
854 }

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_prepare_oneshot_plan(), CURSOR_OPT_PARALLEL_OK, InvalidSnapshot, Nulls, options, plan, RAW_PARSE_DEFAULT, res, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

◆ SPI_finish()

int SPI_finish ( void  )

Definition at line 182 of file spi.c.

183 {
184  int res;
185 
186  res = _SPI_begin_call(false); /* just check we're connected */
187  if (res < 0)
188  return res;
189 
190  /* Restore memory context as it was before procedure call */
192 
193  /* Release memory used in procedure call (including tuptables) */
195  _SPI_current->execCxt = NULL;
197  _SPI_current->procCxt = NULL;
198 
199  /*
200  * Restore outer API variables, especially SPI_tuptable which is probably
201  * pointing at a just-deleted tuptable
202  */
206 
207  /* Exit stack level */
208  _SPI_connected--;
209  if (_SPI_connected < 0)
210  _SPI_current = NULL;
211  else
213 
214  return SPI_OK_FINISH;
215 }
#define SPI_OK_FINISH
Definition: spi.h:83

References _SPI_begin_call(), _SPI_connected, _SPI_current, _SPI_stack, _SPI_connection::execCxt, MemoryContextDelete(), MemoryContextSwitchTo(), _SPI_connection::outer_processed, _SPI_connection::outer_result, _SPI_connection::outer_tuptable, _SPI_connection::procCxt, res, _SPI_connection::savedcxt, SPI_OK_FINISH, SPI_processed, SPI_result, and SPI_tuptable.

Referenced by check_foreign_key(), check_primary_key(), connectby(), crosstab(), cursor_to_xml(), cursor_to_xmlschema(), database_to_xml_internal(), database_to_xmlschema_internal(), get_crosstab_tuplestore(), get_tuple_of_interest(), initialize_worker_spi(), load_categories_hash(), pg_get_ruledef_worker(), pg_get_viewdef_worker(), plperl_event_trigger_handler(), plperl_func_handler(), plperl_inline_handler(), plperl_trigger_handler(), plpgsql_call_handler(), plpgsql_inline_handler(), plpgsql_validator(), plsample_trigger_handler(), pltcl_event_trigger_handler(), pltcl_func_handler(), pltcl_trigger_handler(), PLy_exec_function(), PLy_exec_trigger(), query_to_xml_and_xmlschema(), query_to_xml_internal(), query_to_xmlschema(), refresh_by_match_merge(), ri_Check_Pk_Match(), RI_FKey_cascade_del(), RI_FKey_cascade_upd(), RI_FKey_check(), RI_Initial_Check(), RI_PartitionRemove_Check(), ri_restrict(), ri_set(), schema_to_xml_internal(), schema_to_xmlschema_internal(), test_predtest(), ts_stat1(), ts_stat2(), tsquery_rewrite_query(), ttdummy(), worker_spi_main(), and xpath_table().

◆ SPI_fname()

char* SPI_fname ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1195 of file spi.c.

1196 {
1197  const FormData_pg_attribute *att;
1198 
1199  SPI_result = 0;
1200 
1201  if (fnumber > tupdesc->natts || fnumber == 0 ||
1203  {
1205  return NULL;
1206  }
1207 
1208  if (fnumber > 0)
1209  att = TupleDescAttr(tupdesc, fnumber - 1);
1210  else
1211  att = SystemAttributeDefinition(fnumber);
1212 
1213  return pstrdup(NameStr(att->attname));
1214 }
#define NameStr(name)
Definition: c.h:746
const FormData_pg_attribute * SystemAttributeDefinition(AttrNumber attno)
Definition: heap.c:240
char * pstrdup(const char *in)
Definition: mcxt.c:1696
FormData_pg_attribute
Definition: pg_attribute.h:193
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:76
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92

References FirstLowInvalidHeapAttributeNumber, FormData_pg_attribute, NameStr, TupleDescData::natts, pstrdup(), SPI_ERROR_NOATTRIBUTE, SPI_result, SystemAttributeDefinition(), and TupleDescAttr.

Referenced by get_pkey_attnames(), and SPI_sql_row_to_xmlelement().

◆ SPI_fnumber()

int SPI_fnumber ( TupleDesc  tupdesc,
const char *  fname 
)

Definition at line 1172 of file spi.c.

1173 {
1174  int res;
1175  const FormData_pg_attribute *sysatt;
1176 
1177  for (res = 0; res < tupdesc->natts; res++)
1178  {
1179  Form_pg_attribute attr = TupleDescAttr(tupdesc, res);
1180 
1181  if (namestrcmp(&attr->attname, fname) == 0 &&
1182  !attr->attisdropped)
1183  return res + 1;
1184  }
1185 
1186  sysatt = SystemAttributeByName(fname);
1187  if (sysatt != NULL)
1188  return sysatt->attnum;
1189 
1190  /* SPI_ERROR_NOATTRIBUTE is different from all sys column numbers */
1191  return SPI_ERROR_NOATTRIBUTE;
1192 }
const FormData_pg_attribute * SystemAttributeByName(const char *attname)
Definition: heap.c:252
int namestrcmp(Name name, const char *str)
Definition: name.c:247
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:209

References FormData_pg_attribute, namestrcmp(), TupleDescData::natts, res, SPI_ERROR_NOATTRIBUTE, SystemAttributeByName(), and TupleDescAttr.

Referenced by autoinc(), check_foreign_key(), check_primary_key(), insert_username(), lo_manage(), make_ruledef(), make_viewdef(), moddatetime(), plperl_build_tuple_result(), plperl_modify_tuple(), pltcl_build_tuple_result(), PLy_modify_tuple(), tsvector_update_trigger(), and ttdummy().

◆ SPI_freeplan()

int SPI_freeplan ( SPIPlanPtr  plan)

Definition at line 1022 of file spi.c.

1023 {
1024  ListCell *lc;
1025 
1026  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1027  return SPI_ERROR_ARGUMENT;
1028 
1029  /* Release the plancache entries */
1030  foreach(lc, plan->plancache_list)
1031  {
1032  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
1033 
1034  DropCachedPlan(plansource);
1035  }
1036 
1037  /* Now get rid of the _SPI_plan and subsidiary data in its plancxt */
1038  MemoryContextDelete(plan->plancxt);
1039 
1040  return 0;
1041 }
void DropCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:526

References _SPI_PLAN_MAGIC, DropCachedPlan(), lfirst, MemoryContextDelete(), plan, and SPI_ERROR_ARGUMENT.

Referenced by free_expr(), plperl_spi_freeplan(), plperl_spi_prepare(), plperl_spi_query(), PLy_cursor_query(), PLy_plan_dealloc(), ri_FetchPreparedPlan(), ts_stat_sql(), and tsquery_rewrite_query().

◆ SPI_freetuple()

void SPI_freetuple ( HeapTuple  tuple)

Definition at line 1376 of file spi.c.

1377 {
1378  /* No longer need to worry which context tuple was in... */
1379  heap_freetuple(tuple);
1380 }
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1434

References heap_freetuple().

◆ SPI_freetuptable()

void SPI_freetuptable ( SPITupleTable tuptable)

Definition at line 1383 of file spi.c.

1384 {
1385  bool found = false;
1386 
1387  /* ignore call if NULL pointer */
1388  if (tuptable == NULL)
1389  return;
1390 
1391  /*
1392  * Search only the topmost SPI context for a matching tuple table.
1393  */
1394  if (_SPI_current != NULL)
1395  {
1396  slist_mutable_iter siter;
1397 
1398  /* find tuptable in active list, then remove it */
1400  {
1401  SPITupleTable *tt;
1402 
1403  tt = slist_container(SPITupleTable, next, siter.cur);
1404  if (tt == tuptable)
1405  {
1406  slist_delete_current(&siter);
1407  found = true;
1408  break;
1409  }
1410  }
1411  }
1412 
1413  /*
1414  * Refuse the deletion if we didn't find it in the topmost SPI context.
1415  * This is primarily a guard against double deletion, but might prevent
1416  * other errors as well. Since the worst consequence of not deleting a
1417  * tuptable would be a transient memory leak, this is just a WARNING.
1418  */
1419  if (!found)
1420  {
1421  elog(WARNING, "attempt to delete invalid SPITupleTable %p", tuptable);
1422  return;
1423  }
1424 
1425  /* for safety, reset global variables that might point at tuptable */
1426  if (tuptable == _SPI_current->tuptable)
1427  _SPI_current->tuptable = NULL;
1428  if (tuptable == SPI_tuptable)
1429  SPI_tuptable = NULL;
1430 
1431  /* release all memory belonging to tuptable */
1432  MemoryContextDelete(tuptable->tuptabcxt);
1433 }

References _SPI_current, slist_mutable_iter::cur, elog, MemoryContextDelete(), next, slist_container, slist_delete_current(), slist_foreach_modify, SPI_tuptable, SPITupleTable::tuptabcxt, _SPI_connection::tuptable, _SPI_connection::tuptables, and WARNING.

Referenced by _SPI_execute_plan(), exec_eval_cleanup(), exec_for_query(), exec_stmt_call(), exec_stmt_dynexecute(), exec_stmt_execsql(), exec_stmt_fetch(), plperl_spi_execute_fetch_result(), plperl_spi_fetchrow(), pltcl_process_SPI_result(), PLy_cursor_fetch(), PLy_cursor_iternext(), PLy_spi_execute_fetch_result(), ts_stat_sql(), and tsquery_rewrite_query().

◆ SPI_getargcount()

int SPI_getargcount ( SPIPlanPtr  plan)

Definition at line 1887 of file spi.c.

1888 {
1889  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1890  {
1892  return -1;
1893  }
1894  return plan->nargs;
1895 }

References _SPI_PLAN_MAGIC, plan, SPI_ERROR_ARGUMENT, and SPI_result.

◆ SPI_getargtypeid()

Oid SPI_getargtypeid ( SPIPlanPtr  plan,
int  argIndex 
)

Definition at line 1872 of file spi.c.

1873 {
1874  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC ||
1875  argIndex < 0 || argIndex >= plan->nargs)
1876  {
1878  return InvalidOid;
1879  }
1880  return plan->argtypes[argIndex];
1881 }
#define InvalidOid
Definition: postgres_ext.h:36

References _SPI_PLAN_MAGIC, InvalidOid, plan, SPI_ERROR_ARGUMENT, and SPI_result.

◆ SPI_getbinval()

Datum SPI_getbinval ( HeapTuple  tuple,
TupleDesc  tupdesc,
int  fnumber,
bool isnull 
)

Definition at line 1249 of file spi.c.

1250 {
1251  SPI_result = 0;
1252 
1253  if (fnumber > tupdesc->natts || fnumber == 0 ||
1255  {
1257  *isnull = true;
1258  return (Datum) NULL;
1259  }
1260 
1261  return heap_getattr(tuple, fnumber, tupdesc, isnull);
1262 }
static Datum heap_getattr(HeapTuple tup, int attnum, TupleDesc tupleDesc, bool *isnull)
Definition: htup_details.h:792

References FirstLowInvalidHeapAttributeNumber, heap_getattr(), TupleDescData::natts, SPI_ERROR_NOATTRIBUTE, and SPI_result.

Referenced by autoinc(), check_foreign_key(), check_primary_key(), exec_eval_expr(), initialize_worker_spi(), make_ruledef(), make_viewdef(), query_to_oid_list(), SPI_sql_row_to_xmlelement(), test_predtest(), ts_stat_sql(), tsquery_rewrite_query(), tsvector_update_trigger(), ttdummy(), and worker_spi_main().

◆ SPI_getnspname()

char* SPI_getnspname ( Relation  rel)

Definition at line 1329 of file spi.c.

1330 {
1332 }
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3366
#define RelationGetNamespace(relation)
Definition: rel.h:546

References get_namespace_name(), and RelationGetNamespace.

Referenced by plperl_trigger_build_args(), plsample_trigger_handler(), pltcl_trigger_handler(), and PLy_trigger_build_args().

◆ SPI_getrelname()

char* SPI_getrelname ( Relation  rel)

◆ SPI_gettype()

char* SPI_gettype ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1265 of file spi.c.

1266 {
1267  Oid typoid;
1268  HeapTuple typeTuple;
1269  char *result;
1270 
1271  SPI_result = 0;
1272 
1273  if (fnumber > tupdesc->natts || fnumber == 0 ||
1275  {
1277  return NULL;
1278  }
1279 
1280  if (fnumber > 0)
1281  typoid = TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1282  else
1283  typoid = (SystemAttributeDefinition(fnumber))->atttypid;
1284 
1285  typeTuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(typoid));
1286 
1287  if (!HeapTupleIsValid(typeTuple))
1288  {
1290  return NULL;
1291  }
1292 
1293  result = pstrdup(NameStr(((Form_pg_type) GETSTRUCT(typeTuple))->typname));
1294  ReleaseSysCache(typeTuple);
1295  return result;
1296 }
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define GETSTRUCT(TUP)
Definition: htup_details.h:653
FormData_pg_type * Form_pg_type
Definition: pg_type.h:261
NameData typname
Definition: pg_type.h:41
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:252
#define SPI_ERROR_TYPUNKNOWN
Definition: spi.h:78
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:266
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:218

References FirstLowInvalidHeapAttributeNumber, GETSTRUCT, HeapTupleIsValid, NameStr, TupleDescData::natts, ObjectIdGetDatum(), pstrdup(), ReleaseSysCache(), SearchSysCache1(), SPI_ERROR_NOATTRIBUTE, SPI_ERROR_TYPUNKNOWN, SPI_result, SystemAttributeDefinition(), TupleDescAttr, and typname.

Referenced by check_foreign_key().

◆ SPI_gettypeid()

Oid SPI_gettypeid ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1305 of file spi.c.

1306 {
1307  SPI_result = 0;
1308 
1309  if (fnumber > tupdesc->natts || fnumber == 0 ||
1311  {
1313  return InvalidOid;
1314  }
1315 
1316  if (fnumber > 0)
1317  return TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1318  else
1319  return (SystemAttributeDefinition(fnumber))->atttypid;
1320 }

References FirstLowInvalidHeapAttributeNumber, InvalidOid, TupleDescData::natts, SPI_ERROR_NOATTRIBUTE, SPI_result, SystemAttributeDefinition(), and TupleDescAttr.

Referenced by autoinc(), check_foreign_key(), check_primary_key(), insert_username(), moddatetime(), SPI_sql_row_to_xmlelement(), ts_stat_sql(), tsquery_rewrite_query(), tsvector_update_trigger(), and ttdummy().

◆ SPI_getvalue()

char* SPI_getvalue ( HeapTuple  tuple,
TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1217 of file spi.c.

1218 {
1219  Datum val;
1220  bool isnull;
1221  Oid typoid,
1222  foutoid;
1223  bool typisvarlena;
1224 
1225  SPI_result = 0;
1226 
1227  if (fnumber > tupdesc->natts || fnumber == 0 ||
1229  {
1231  return NULL;
1232  }
1233 
1234  val = heap_getattr(tuple, fnumber, tupdesc, &isnull);
1235  if (isnull)
1236  return NULL;
1237 
1238  if (fnumber > 0)
1239  typoid = TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1240  else
1241  typoid = (SystemAttributeDefinition(fnumber))->atttypid;
1242 
1243  getTypeOutputInfo(typoid, &foutoid, &typisvarlena);
1244 
1245  return OidOutputFunctionCall(foutoid, val);
1246 }
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1763
long val
Definition: informix.c:670
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2907

References FirstLowInvalidHeapAttributeNumber, getTypeOutputInfo(), heap_getattr(), TupleDescData::natts, OidOutputFunctionCall(), SPI_ERROR_NOATTRIBUTE, SPI_result, SystemAttributeDefinition(), TupleDescAttr, and val.

Referenced by build_tuplestore_recursively(), check_foreign_key(), crosstab(), get_crosstab_tuplestore(), get_sql_insert(), get_sql_update(), lo_manage(), load_categories_hash(), make_ruledef(), make_viewdef(), refresh_by_match_merge(), triggered_change_notification(), and xpath_table().

◆ SPI_inside_nonatomic_context()

bool SPI_inside_nonatomic_context ( void  )

Definition at line 581 of file spi.c.

582 {
583  if (_SPI_current == NULL)
584  return false; /* not in any SPI context at all */
585  if (_SPI_current->atomic)
586  return false; /* it's atomic (ie function not procedure) */
587  return true;
588 }

References _SPI_current, and _SPI_connection::atomic.

Referenced by StartTransaction().

◆ SPI_is_cursor_plan()

bool SPI_is_cursor_plan ( SPIPlanPtr  plan)

Definition at line 1907 of file spi.c.

1908 {
1909  CachedPlanSource *plansource;
1910 
1911  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1912  {
1914  return false;
1915  }
1916 
1917  if (list_length(plan->plancache_list) != 1)
1918  {
1919  SPI_result = 0;
1920  return false; /* not exactly 1 pre-rewrite command */
1921  }
1922  plansource = (CachedPlanSource *) linitial(plan->plancache_list);
1923 
1924  /*
1925  * We used to force revalidation of the cached plan here, but that seems
1926  * unnecessary: invalidation could mean a change in the rowtype of the
1927  * tuples returned by a plan, but not whether it returns tuples at all.
1928  */
1929  SPI_result = 0;
1930 
1931  /* Does it return tuples? */
1932  if (plansource->resultDesc)
1933  return true;
1934 
1935  return false;
1936 }

References _SPI_PLAN_MAGIC, linitial, list_length(), plan, CachedPlanSource::resultDesc, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by SPI_cursor_open_internal().

◆ SPI_keepplan()

int SPI_keepplan ( SPIPlanPtr  plan)

Definition at line 973 of file spi.c.

974 {
975  ListCell *lc;
976 
977  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC ||
978  plan->saved || plan->oneshot)
979  return SPI_ERROR_ARGUMENT;
980 
981  /*
982  * Mark it saved, reparent it under CacheMemoryContext, and mark all the
983  * component CachedPlanSources as saved. This sequence cannot fail
984  * partway through, so there's no risk of long-term memory leakage.
985  */
986  plan->saved = true;
988 
989  foreach(lc, plan->plancache_list)
990  {
991  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
992 
993  SaveCachedPlan(plansource);
994  }
995 
996  return 0;
997 }

References _SPI_PLAN_MAGIC, CacheMemoryContext, lfirst, MemoryContextSetParent(), plan, SaveCachedPlan(), and SPI_ERROR_ARGUMENT.

Referenced by check_foreign_key(), check_primary_key(), exec_prepare_plan(), pg_get_ruledef_worker(), pg_get_viewdef_worker(), plperl_spi_prepare(), pltcl_SPI_prepare(), PLy_spi_prepare(), ri_PlanCheck(), and ttdummy().

◆ SPI_modifytuple()

HeapTuple SPI_modifytuple ( Relation  rel,
HeapTuple  tuple,
int  natts,
int *  attnum,
Datum Values,
const char *  Nulls 
)

Definition at line 1103 of file spi.c.

1105 {
1106  MemoryContext oldcxt;
1107  HeapTuple mtuple;
1108  int numberOfAttributes;
1109  Datum *v;
1110  bool *n;
1111  int i;
1112 
1113  if (rel == NULL || tuple == NULL || natts < 0 || attnum == NULL || Values == NULL)
1114  {
1116  return NULL;
1117  }
1118 
1119  if (_SPI_current == NULL)
1120  {
1122  return NULL;
1123  }
1124 
1126 
1127  SPI_result = 0;
1128 
1129  numberOfAttributes = rel->rd_att->natts;
1130  v = (Datum *) palloc(numberOfAttributes * sizeof(Datum));
1131  n = (bool *) palloc(numberOfAttributes * sizeof(bool));
1132 
1133  /* fetch old values and nulls */
1134  heap_deform_tuple(tuple, rel->rd_att, v, n);
1135 
1136  /* replace values and nulls */
1137  for (i = 0; i < natts; i++)
1138  {
1139  if (attnum[i] <= 0 || attnum[i] > numberOfAttributes)
1140  break;
1141  v[attnum[i] - 1] = Values[i];
1142  n[attnum[i] - 1] = (Nulls && Nulls[i] == 'n');
1143  }
1144 
1145  if (i == natts) /* no errors in *attnum */
1146  {
1147  mtuple = heap_form_tuple(rel->rd_att, v, n);
1148 
1149  /*
1150  * copy the identification info of the old tuple: t_ctid, t_self, and
1151  * OID (if any)
1152  */
1153  mtuple->t_data->t_ctid = tuple->t_data->t_ctid;
1154  mtuple->t_self = tuple->t_self;
1155  mtuple->t_tableOid = tuple->t_tableOid;
1156  }
1157  else
1158  {
1159  mtuple = NULL;
1161  }
1162 
1163  pfree(v);
1164  pfree(n);
1165 
1166  MemoryContextSwitchTo(oldcxt);
1167 
1168  return mtuple;
1169 }
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1116
void heap_deform_tuple(HeapTuple tuple, TupleDesc tupleDesc, Datum *values, bool *isnull)
Definition: heaptuple.c:1345
int16 attnum
Definition: pg_attribute.h:74
ItemPointerData t_self
Definition: htup.h:65
HeapTupleHeader t_data
Definition: htup.h:68
Oid t_tableOid
Definition: htup.h:66
ItemPointerData t_ctid
Definition: htup_details.h:161
TupleDesc rd_att
Definition: rel.h:112

References _SPI_current, attnum, heap_deform_tuple(), heap_form_tuple(), i, MemoryContextSwitchTo(), TupleDescData::natts, Nulls, palloc(), pfree(), RelationData::rd_att, _SPI_connection::savedcxt, SPI_ERROR_ARGUMENT, SPI_ERROR_NOATTRIBUTE, SPI_ERROR_UNCONNECTED, SPI_result, HeapTupleHeaderData::t_ctid, HeapTupleData::t_data, HeapTupleData::t_self, and HeapTupleData::t_tableOid.

Referenced by ttdummy().

◆ SPI_palloc()

void* SPI_palloc ( Size  size)

Definition at line 1335 of file spi.c.

1336 {
1337  if (_SPI_current == NULL)
1338  elog(ERROR, "SPI_palloc called while not connected to SPI");
1339 
1341 }
static pg_noinline void Size size
Definition: slab.c:607

References _SPI_current, elog, ERROR, MemoryContextAlloc(), _SPI_connection::savedcxt, and size.

Referenced by _SPI_strdup(), and coerce_function_result_tuple().

◆ SPI_pfree()

void SPI_pfree ( void *  pointer)

Definition at line 1351 of file spi.c.

1352 {
1353  /* No longer need to worry which context chunk was in... */
1354  pfree(pointer);
1355 }

References pfree().

◆ SPI_plan_get_cached_plan()

CachedPlan* SPI_plan_get_cached_plan ( SPIPlanPtr  plan)

Definition at line 2071 of file spi.c.

2072 {
2073  CachedPlanSource *plansource;
2074  CachedPlan *cplan;
2075  SPICallbackArg spicallbackarg;
2076  ErrorContextCallback spierrcontext;
2077 
2078  Assert(plan->magic == _SPI_PLAN_MAGIC);
2079 
2080  /* Can't support one-shot plans here */
2081  if (plan->oneshot)
2082  return NULL;
2083 
2084  /* Must have exactly one CachedPlanSource */
2085  if (list_length(plan->plancache_list) != 1)
2086  return NULL;
2087  plansource = (CachedPlanSource *) linitial(plan->plancache_list);
2088 
2089  /* Setup error traceback support for ereport() */
2090  spicallbackarg.query = plansource->query_string;
2091  spicallbackarg.mode = plan->parse_mode;
2092  spierrcontext.callback = _SPI_error_callback;
2093  spierrcontext.arg = &spicallbackarg;
2094  spierrcontext.previous = error_context_stack;
2095  error_context_stack = &spierrcontext;
2096 
2097  /* Get the generic plan for the query */
2098  cplan = GetCachedPlan(plansource, NULL,
2099  plan->saved ? CurrentResourceOwner : NULL,
2101  Assert(cplan == plansource->gplan);
2102 
2103  /* Pop the error context stack */
2104  error_context_stack = spierrcontext.previous;
2105 
2106  return cplan;
2107 }
struct CachedPlan * gplan
Definition: plancache.h:121

References _SPI_current, _SPI_error_callback(), _SPI_PLAN_MAGIC, ErrorContextCallback::arg, Assert, ErrorContextCallback::callback, CurrentResourceOwner, error_context_stack, GetCachedPlan(), CachedPlanSource::gplan, linitial, list_length(), SPICallbackArg::mode, plan, ErrorContextCallback::previous, SPICallbackArg::query, CachedPlanSource::query_string, and _SPI_connection::queryEnv.

Referenced by exec_eval_simple_expr(), exec_simple_check_plan(), and test_predtest().

◆ SPI_plan_get_plan_sources()

List* SPI_plan_get_plan_sources ( SPIPlanPtr  plan)

Definition at line 2052 of file spi.c.

2053 {
2054  Assert(plan->magic == _SPI_PLAN_MAGIC);
2055  return plan->plancache_list;
2056 }

References _SPI_PLAN_MAGIC, Assert, and plan.

Referenced by exec_is_simple_query(), exec_simple_check_plan(), exec_stmt_execsql(), and make_callstmt_target().

◆ SPI_plan_is_valid()

bool SPI_plan_is_valid ( SPIPlanPtr  plan)

Definition at line 1945 of file spi.c.

1946 {
1947  ListCell *lc;
1948 
1949  Assert(plan->magic == _SPI_PLAN_MAGIC);
1950 
1951  foreach(lc, plan->plancache_list)
1952  {
1953  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
1954 
1955  if (!CachedPlanIsValid(plansource))
1956  return false;
1957  }
1958  return true;
1959 }
bool CachedPlanIsValid(CachedPlanSource *plansource)
Definition: plancache.c:1627

References _SPI_PLAN_MAGIC, Assert, CachedPlanIsValid(), lfirst, and plan.

Referenced by ri_FetchPreparedPlan().

◆ SPI_prepare()

SPIPlanPtr SPI_prepare ( const char *  src,
int  nargs,
Oid argtypes 
)

◆ SPI_prepare_cursor()

SPIPlanPtr SPI_prepare_cursor ( const char *  src,
int  nargs,
Oid argtypes,
int  cursorOptions 
)

Definition at line 863 of file spi.c.

865 {
866  _SPI_plan plan;
867  SPIPlanPtr result;
868 
869  if (src == NULL || nargs < 0 || (nargs > 0 && argtypes == NULL))
870  {
872  return NULL;
873  }
874 
875  SPI_result = _SPI_begin_call(true);
876  if (SPI_result < 0)
877  return NULL;
878 
879  memset(&plan, 0, sizeof(_SPI_plan));
880  plan.magic = _SPI_PLAN_MAGIC;
881  plan.parse_mode = RAW_PARSE_DEFAULT;
882  plan.cursor_options = cursorOptions;
883  plan.nargs = nargs;
884  plan.argtypes = argtypes;
885  plan.parserSetup = NULL;
886  plan.parserSetupArg = NULL;
887 
888  _SPI_prepare_plan(src, &plan);
889 
890  /* copy plan to procedure context */
891  result = _SPI_make_plan_non_temp(&plan);
892 
893  _SPI_end_call(true);
894 
895  return result;
896 }
static SPIPlanPtr _SPI_make_plan_non_temp(SPIPlanPtr plan)
Definition: spi.c:3133

References _SPI_begin_call(), _SPI_end_call(), _SPI_make_plan_non_temp(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), plan, RAW_PARSE_DEFAULT, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by SPI_prepare().

◆ SPI_prepare_extended()

SPIPlanPtr SPI_prepare_extended ( const char *  src,
const SPIPrepareOptions options 
)

Definition at line 899 of file spi.c.

901 {
902  _SPI_plan plan;
903  SPIPlanPtr result;
904 
905  if (src == NULL || options == NULL)
906  {
908  return NULL;
909  }
910 
911  SPI_result = _SPI_begin_call(true);
912  if (SPI_result < 0)
913  return NULL;
914 
915  memset(&plan, 0, sizeof(_SPI_plan));
916  plan.magic = _SPI_PLAN_MAGIC;
917  plan.parse_mode = options->parseMode;
918  plan.cursor_options = options->cursorOptions;
919  plan.nargs = 0;
920  plan.argtypes = NULL;
921  plan.parserSetup = options->parserSetup;
922  plan.parserSetupArg = options->parserSetupArg;
923 
924  _SPI_prepare_plan(src, &plan);
925 
926  /* copy plan to procedure context */
927  result = _SPI_make_plan_non_temp(&plan);
928 
929  _SPI_end_call(true);
930 
931  return result;
932 }

References _SPI_begin_call(), _SPI_end_call(), _SPI_make_plan_non_temp(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), plan, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by exec_prepare_plan().

◆ SPI_prepare_params()

SPIPlanPtr SPI_prepare_params ( const char *  src,
ParserSetupHook  parserSetup,
void *  parserSetupArg,
int  cursorOptions 
)

Definition at line 935 of file spi.c.

939 {
940  _SPI_plan plan;
941  SPIPlanPtr result;
942 
943  if (src == NULL)
944  {
946  return NULL;
947  }
948 
949  SPI_result = _SPI_begin_call(true);
950  if (SPI_result < 0)
951  return NULL;
952 
953  memset(&plan, 0, sizeof(_SPI_plan));
954  plan.magic = _SPI_PLAN_MAGIC;
955  plan.parse_mode = RAW_PARSE_DEFAULT;
956  plan.cursor_options = cursorOptions;
957  plan.nargs = 0;
958  plan.argtypes = NULL;
959  plan.parserSetup = parserSetup;
960  plan.parserSetupArg = parserSetupArg;
961 
962  _SPI_prepare_plan(src, &plan);
963 
964  /* copy plan to procedure context */
965  result = _SPI_make_plan_non_temp(&plan);
966 
967  _SPI_end_call(true);
968 
969  return result;
970 }

References _SPI_begin_call(), _SPI_end_call(), _SPI_make_plan_non_temp(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), plan, RAW_PARSE_DEFAULT, SPI_ERROR_ARGUMENT, and SPI_result.

◆ spi_printtup()

bool spi_printtup ( TupleTableSlot slot,
DestReceiver self 
)

Definition at line 2166 of file spi.c.

2167 {
2168  SPITupleTable *tuptable;
2169  MemoryContext oldcxt;
2170 
2171  if (_SPI_current == NULL)
2172  elog(ERROR, "spi_printtup called while not connected to SPI");
2173 
2174  tuptable = _SPI_current->tuptable;
2175  if (tuptable == NULL)
2176  elog(ERROR, "improper call to spi_printtup");
2177 
2178  oldcxt = MemoryContextSwitchTo(tuptable->tuptabcxt);
2179 
2180  if (tuptable->numvals >= tuptable->alloced)
2181  {
2182  /* Double the size of the pointer array */
2183  uint64 newalloced = tuptable->alloced * 2;
2184 
2185  tuptable->vals = (HeapTuple *) repalloc_huge(tuptable->vals,
2186  newalloced * sizeof(HeapTuple));
2187  tuptable->alloced = newalloced;
2188  }
2189 
2190  tuptable->vals[tuptable->numvals] = ExecCopySlotHeapTuple(slot);
2191  (tuptable->numvals)++;
2192 
2193  MemoryContextSwitchTo(oldcxt);
2194 
2195  return true;
2196 }
void * repalloc_huge(void *pointer, Size size)
Definition: mcxt.c:1672
static HeapTuple ExecCopySlotHeapTuple(TupleTableSlot *slot)
Definition: tuptable.h:481

References _SPI_current, SPITupleTable::alloced, elog, ERROR, ExecCopySlotHeapTuple(), MemoryContextSwitchTo(), SPITupleTable::numvals, repalloc_huge(), SPITupleTable::tuptabcxt, _SPI_connection::tuptable, and SPITupleTable::vals.

◆ SPI_register_relation()

int SPI_register_relation ( EphemeralNamedRelation  enr)

Definition at line 3289 of file spi.c.

3290 {
3291  EphemeralNamedRelation match;
3292  int res;
3293 
3294  if (enr == NULL || enr->md.name == NULL)
3295  return SPI_ERROR_ARGUMENT;
3296 
3297  res = _SPI_begin_call(false); /* keep current memory context */
3298  if (res < 0)
3299  return res;
3300 
3301  match = _SPI_find_ENR_by_name(enr->md.name);
3302  if (match)
3304  else
3305  {
3306  if (_SPI_current->queryEnv == NULL)
3308 
3311  }
3312 
3313  _SPI_end_call(false);
3314 
3315  return res;
3316 }
QueryEnvironment * create_queryEnv(void)
void register_ENR(QueryEnvironment *queryEnv, EphemeralNamedRelation enr)
static EphemeralNamedRelation _SPI_find_ENR_by_name(const char *name)
Definition: spi.c:3272
#define SPI_ERROR_REL_DUPLICATE
Definition: spi.h:79
#define SPI_OK_REL_REGISTER
Definition: spi.h:96
EphemeralNamedRelationMetadataData md

References _SPI_begin_call(), _SPI_current, _SPI_end_call(), _SPI_find_ENR_by_name(), create_queryEnv(), EphemeralNamedRelationData::md, EphemeralNamedRelationMetadataData::name, _SPI_connection::queryEnv, register_ENR(), res, SPI_ERROR_ARGUMENT, SPI_ERROR_REL_DUPLICATE, and SPI_OK_REL_REGISTER.

Referenced by SPI_register_trigger_data().

◆ SPI_register_trigger_data()

int SPI_register_trigger_data ( TriggerData tdata)

Definition at line 3356 of file spi.c.

3357 {
3358  if (tdata == NULL)
3359  return SPI_ERROR_ARGUMENT;
3360 
3361  if (tdata->tg_newtable)
3362  {
3365  int rc;
3366 
3367  enr->md.name = tdata->tg_trigger->tgnewtable;
3368  enr->md.reliddesc = tdata->tg_relation->rd_id;
3369  enr->md.tupdesc = NULL;
3372  enr->reldata = tdata->tg_newtable;
3373  rc = SPI_register_relation(enr);
3374  if (rc != SPI_OK_REL_REGISTER)
3375  return rc;
3376  }
3377 
3378  if (tdata->tg_oldtable)
3379  {
3382  int rc;
3383 
3384  enr->md.name = tdata->tg_trigger->tgoldtable;
3385  enr->md.reliddesc = tdata->tg_relation->rd_id;
3386  enr->md.tupdesc = NULL;
3389  enr->reldata = tdata->tg_oldtable;
3390  rc = SPI_register_relation(enr);
3391  if (rc != SPI_OK_REL_REGISTER)
3392  return rc;
3393  }
3394 
3395  return SPI_OK_TD_REGISTER;
3396 }
@ ENR_NAMED_TUPLESTORE
int SPI_register_relation(EphemeralNamedRelation enr)
Definition: spi.c:3289
#define SPI_OK_TD_REGISTER
Definition: spi.h:98
EphemeralNameRelationType enrtype
Oid rd_id
Definition: rel.h:113
Tuplestorestate * tg_oldtable
Definition: trigger.h:41
Relation tg_relation
Definition: trigger.h:35
Tuplestorestate * tg_newtable
Definition: trigger.h:42
Trigger * tg_trigger
Definition: trigger.h:38
char * tgoldtable
Definition: reltrigger.h:43
char * tgnewtable
Definition: reltrigger.h:44
int64 tuplestore_tuple_count(Tuplestorestate *state)
Definition: tuplestore.c:578

References ENR_NAMED_TUPLESTORE, EphemeralNamedRelationMetadataData::enrtuples, EphemeralNamedRelationMetadataData::enrtype, EphemeralNamedRelationData::md, EphemeralNamedRelationMetadataData::name, palloc(), RelationData::rd_id, EphemeralNamedRelationData::reldata, EphemeralNamedRelationMetadataData::reliddesc, SPI_ERROR_ARGUMENT, SPI_OK_REL_REGISTER, SPI_OK_TD_REGISTER, SPI_register_relation(), TriggerData::tg_newtable, TriggerData::tg_oldtable, TriggerData::tg_relation, TriggerData::tg_trigger, Trigger::tgnewtable, Trigger::tgoldtable, EphemeralNamedRelationMetadataData::tupdesc, and tuplestore_tuple_count().

Referenced by plperl_trigger_handler(), plpgsql_exec_trigger(), plsample_trigger_handler(), pltcl_trigger_handler(), and PLy_exec_trigger().

◆ SPI_repalloc()

void* SPI_repalloc ( void *  pointer,
Size  size 
)

Definition at line 1344 of file spi.c.

1345 {
1346  /* No longer need to worry which context chunk was in... */
1347  return repalloc(pointer, size);
1348 }

References repalloc(), and size.

◆ SPI_result_code_string()

const char* SPI_result_code_string ( int  code)

Definition at line 1969 of file spi.c.

1970 {
1971  static char buf[64];
1972 
1973  switch (code)
1974  {
1975  case SPI_ERROR_CONNECT:
1976  return "SPI_ERROR_CONNECT";
1977  case SPI_ERROR_COPY:
1978  return "SPI_ERROR_COPY";
1979  case SPI_ERROR_OPUNKNOWN:
1980  return "SPI_ERROR_OPUNKNOWN";
1981  case SPI_ERROR_UNCONNECTED:
1982  return "SPI_ERROR_UNCONNECTED";
1983  case SPI_ERROR_ARGUMENT:
1984  return "SPI_ERROR_ARGUMENT";
1985  case SPI_ERROR_PARAM:
1986  return "SPI_ERROR_PARAM";
1987  case SPI_ERROR_TRANSACTION:
1988  return "SPI_ERROR_TRANSACTION";
1989  case SPI_ERROR_NOATTRIBUTE:
1990  return "SPI_ERROR_NOATTRIBUTE";
1991  case SPI_ERROR_NOOUTFUNC:
1992  return "SPI_ERROR_NOOUTFUNC";
1993  case SPI_ERROR_TYPUNKNOWN:
1994  return "SPI_ERROR_TYPUNKNOWN";
1996  return "SPI_ERROR_REL_DUPLICATE";
1998  return "SPI_ERROR_REL_NOT_FOUND";
1999  case SPI_OK_CONNECT:
2000  return "SPI_OK_CONNECT";
2001  case SPI_OK_FINISH:
2002  return "SPI_OK_FINISH";
2003  case SPI_OK_FETCH:
2004  return "SPI_OK_FETCH";
2005  case SPI_OK_UTILITY:
2006  return "SPI_OK_UTILITY";
2007  case SPI_OK_SELECT:
2008  return "SPI_OK_SELECT";
2009  case SPI_OK_SELINTO:
2010  return "SPI_OK_SELINTO";
2011  case SPI_OK_INSERT:
2012  return "SPI_OK_INSERT";
2013  case SPI_OK_DELETE:
2014  return "SPI_OK_DELETE";
2015  case SPI_OK_UPDATE:
2016  return "SPI_OK_UPDATE";
2017  case SPI_OK_CURSOR:
2018  return "SPI_OK_CURSOR";
2020  return "SPI_OK_INSERT_RETURNING";
2022  return "SPI_OK_DELETE_RETURNING";
2024  return "SPI_OK_UPDATE_RETURNING";
2025  case SPI_OK_REWRITTEN:
2026  return "SPI_OK_REWRITTEN";
2027  case SPI_OK_REL_REGISTER:
2028  return "SPI_OK_REL_REGISTER";
2029  case SPI_OK_REL_UNREGISTER:
2030  return "SPI_OK_REL_UNREGISTER";
2031  case SPI_OK_TD_REGISTER:
2032  return "SPI_OK_TD_REGISTER";
2033  case SPI_OK_MERGE:
2034  return "SPI_OK_MERGE";
2036  return "SPI_OK_MERGE_RETURNING";
2037  }
2038  /* Unrecognized code ... return something useful ... */
2039  sprintf(buf, "Unrecognized SPI code %d", code);
2040  return buf;
2041 }
static char * buf
Definition: pg_test_fsync.c:73
#define sprintf
Definition: port.h:240
#define SPI_ERROR_REL_NOT_FOUND
Definition: spi.h:80
#define SPI_OK_CURSOR
Definition: spi.h:91
#define SPI_OK_FETCH
Definition: spi.h:84
#define SPI_OK_REL_UNREGISTER
Definition: spi.h:97
#define SPI_ERROR_NOOUTFUNC
Definition: spi.h:77
#define SPI_ERROR_CONNECT
Definition: spi.h:68

References buf, SPI_ERROR_ARGUMENT, SPI_ERROR_CONNECT, SPI_ERROR_COPY, SPI_ERROR_NOATTRIBUTE, SPI_ERROR_NOOUTFUNC, SPI_ERROR_OPUNKNOWN, SPI_ERROR_PARAM, SPI_ERROR_REL_DUPLICATE, SPI_ERROR_REL_NOT_FOUND, SPI_ERROR_TRANSACTION, SPI_ERROR_TYPUNKNOWN, SPI_ERROR_UNCONNECTED, SPI_OK_CONNECT, SPI_OK_CURSOR, SPI_OK_DELETE, SPI_OK_DELETE_RETURNING, SPI_OK_FETCH, SPI_OK_FINISH, SPI_OK_INSERT, SPI_OK_INSERT_RETURNING, SPI_OK_MERGE, SPI_OK_MERGE_RETURNING, SPI_OK_REL_REGISTER, SPI_OK_REL_UNREGISTER, SPI_OK_REWRITTEN, SPI_OK_SELECT, SPI_OK_SELINTO, SPI_OK_TD_REGISTER, SPI_OK_UPDATE, SPI_OK_UPDATE_RETURNING, SPI_OK_UTILITY, and sprintf.

Referenced by check_foreign_key(), check_primary_key(), exec_dynquery_with_params(), exec_prepare_plan(), exec_run_select(), exec_stmt_call(), exec_stmt_dynexecute(), exec_stmt_execsql(), exec_stmt_forc(), exec_stmt_open(), exec_stmt_return_query(), plperl_spi_execute_fetch_result(), plperl_spi_prepare(), plperl_spi_query(), plperl_spi_query_prepared(), plpgsql_call_handler(), plpgsql_inline_handler(), plpgsql_validator(), pltcl_process_SPI_result(), PLy_cursor_plan(), PLy_cursor_query(), PLy_spi_execute_plan(), PLy_spi_execute_query(), PLy_spi_prepare(), query_to_oid_list(), RI_Initial_Check(), RI_PartitionRemove_Check(), ri_PerformCheck(), ri_PlanCheck(), and ttdummy().

◆ SPI_returntuple()

HeapTupleHeader SPI_returntuple ( HeapTuple  tuple,
TupleDesc  tupdesc 
)

Definition at line 1071 of file spi.c.

1072 {
1073  MemoryContext oldcxt;
1074  HeapTupleHeader dtup;
1075 
1076  if (tuple == NULL || tupdesc == NULL)
1077  {
1079  return NULL;
1080  }
1081 
1082  if (_SPI_current == NULL)
1083  {
1085  return NULL;
1086  }
1087 
1088  /* For RECORD results, make sure a typmod has been assigned */
1089  if (tupdesc->tdtypeid == RECORDOID &&
1090  tupdesc->tdtypmod < 0)
1091  assign_record_type_typmod(tupdesc);
1092 
1094 
1095  dtup = DatumGetHeapTupleHeader(heap_copy_tuple_as_datum(tuple, tupdesc));
1096 
1097  MemoryContextSwitchTo(oldcxt);
1098 
1099  return dtup;
1100 }
#define DatumGetHeapTupleHeader(X)
Definition: fmgr.h:295
Datum heap_copy_tuple_as_datum(HeapTuple tuple, TupleDesc tupleDesc)
Definition: heaptuple.c:1080
int32 tdtypmod
Definition: tupdesc.h:83
Oid tdtypeid
Definition: tupdesc.h:82
void assign_record_type_typmod(TupleDesc tupDesc)
Definition: typcache.c:1953

References _SPI_current, assign_record_type_typmod(), DatumGetHeapTupleHeader, heap_copy_tuple_as_datum(), MemoryContextSwitchTo(), _SPI_connection::savedcxt, SPI_ERROR_ARGUMENT, SPI_ERROR_UNCONNECTED, SPI_result, TupleDescData::tdtypeid, and TupleDescData::tdtypmod.

Referenced by coerce_function_result_tuple().

◆ SPI_rollback()

void SPI_rollback ( void  )

Definition at line 413 of file spi.c.

414 {
415  _SPI_rollback(false);
416 }
static void _SPI_rollback(bool chain)
Definition: spi.c:332

References _SPI_rollback().

Referenced by exec_stmt_rollback(), plperl_spi_rollback(), pltcl_rollback(), and PLy_rollback().

◆ SPI_rollback_and_chain()

void SPI_rollback_and_chain ( void  )

Definition at line 419 of file spi.c.

420 {
421  _SPI_rollback(true);
422 }

References _SPI_rollback().

Referenced by exec_stmt_rollback().

◆ SPI_saveplan()

SPIPlanPtr SPI_saveplan ( SPIPlanPtr  plan)

Definition at line 1000 of file spi.c.

1001 {
1002  SPIPlanPtr newplan;
1003 
1004  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1005  {
1007  return NULL;
1008  }
1009 
1010  SPI_result = _SPI_begin_call(false); /* don't change context */
1011  if (SPI_result < 0)
1012  return NULL;
1013 
1014  newplan = _SPI_save_plan(plan);
1015 
1016  SPI_result = _SPI_end_call(false);
1017 
1018  return newplan;
1019 }
static SPIPlanPtr _SPI_save_plan(SPIPlanPtr plan)
Definition: spi.c:3201

References _SPI_begin_call(), _SPI_end_call(), _SPI_PLAN_MAGIC, _SPI_save_plan(), plan, SPI_ERROR_ARGUMENT, and SPI_result.

◆ SPI_scroll_cursor_fetch()

void SPI_scroll_cursor_fetch ( Portal  portal,
FetchDirection  direction,
long  count 
)

Definition at line 1832 of file spi.c.

1833 {
1834  _SPI_cursor_operation(portal,
1835  direction, count,
1837  /* we know that the DestSPI receiver doesn't need a destroy call */
1838 }

References _SPI_cursor_operation(), CreateDestReceiver(), and DestSPI.

Referenced by exec_stmt_fetch().

◆ SPI_scroll_cursor_move()

void SPI_scroll_cursor_move ( Portal  portal,
FetchDirection  direction,
long  count 
)

Definition at line 1847 of file spi.c.

1848 {
1849  _SPI_cursor_operation(portal, direction, count, None_Receiver);
1850 }

References _SPI_cursor_operation(), and None_Receiver.

Referenced by exec_stmt_fetch().

◆ SPI_start_transaction()

void SPI_start_transaction ( void  )

Definition at line 222 of file spi.c.

223 {
224 }

◆ SPI_unregister_relation()

int SPI_unregister_relation ( const char *  name)

Definition at line 3323 of file spi.c.

3324 {
3325  EphemeralNamedRelation match;
3326  int res;
3327 
3328  if (name == NULL)
3329  return SPI_ERROR_ARGUMENT;
3330 
3331  res = _SPI_begin_call(false); /* keep current memory context */
3332  if (res < 0)
3333  return res;
3334 
3335  match = _SPI_find_ENR_by_name(name);
3336  if (match)
3337  {
3340  }
3341  else
3343 
3344  _SPI_end_call(false);
3345 
3346  return res;
3347 }
void unregister_ENR(QueryEnvironment *queryEnv, const char *name)

References _SPI_begin_call(), _SPI_current, _SPI_end_call(), _SPI_find_ENR_by_name(), EphemeralNamedRelationData::md, name, EphemeralNamedRelationMetadataData::name, _SPI_connection::queryEnv, res, SPI_ERROR_ARGUMENT, SPI_ERROR_REL_NOT_FOUND, SPI_OK_REL_UNREGISTER, and unregister_ENR().

Variable Documentation

◆ _SPI_connected

int _SPI_connected = -1
static

Definition at line 51 of file spi.c.

Referenced by AtEOSubXact_SPI(), AtEOXact_SPI(), SPI_connect_ext(), and SPI_finish().

◆ _SPI_current

◆ _SPI_stack

_SPI_connection* _SPI_stack = NULL
static

Definition at line 48 of file spi.c.

Referenced by AtEOSubXact_SPI(), AtEOXact_SPI(), SPI_connect_ext(), and SPI_finish().

◆ _SPI_stack_depth

int _SPI_stack_depth = 0
static

Definition at line 50 of file spi.c.

Referenced by SPI_connect_ext().

◆ SPI_processed

◆ SPI_result

◆ SPI_tuptable