PostgreSQL Source Code  git master
params.c File Reference
#include "postgres.h"
#include "access/xact.h"
#include "fmgr.h"
#include "mb/stringinfo_mb.h"
#include "nodes/params.h"
#include "parser/parse_node.h"
#include "storage/shmem.h"
#include "utils/datum.h"
#include "utils/lsyscache.h"
#include "utils/memutils.h"
Include dependency graph for params.c:

Go to the source code of this file.

Functions

static void paramlist_parser_setup (ParseState *pstate, void *arg)
 
static Nodeparamlist_param_ref (ParseState *pstate, ParamRef *pref)
 
ParamListInfo makeParamList (int numParams)
 
ParamListInfo copyParamList (ParamListInfo from)
 
Size EstimateParamListSpace (ParamListInfo paramLI)
 
void SerializeParamList (ParamListInfo paramLI, char **start_address)
 
ParamListInfo RestoreParamList (char **start_address)
 
char * BuildParamLogString (ParamListInfo params, char **knownTextValues, int maxlen)
 
void ParamsErrorCallback (void *arg)
 

Function Documentation

◆ BuildParamLogString()

char* BuildParamLogString ( ParamListInfo  params,
char **  knownTextValues,
int  maxlen 
)

Definition at line 335 of file params.c.

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, appendStringInfo(), appendStringInfoString(), appendStringInfoStringQuoted(), buf, CurrentMemoryContext, StringInfoData::data, getTypeOutputInfo(), initStringInfo(), IsAbortedTransactionBlockState(), ParamExternData::isnull, MemoryContextDelete(), MemoryContextSwitchTo(), ParamListInfoData::numParams, OidIsValid, OidOutputFunctionCall(), ParamListInfoData::paramFetch, ParamListInfoData::params, ParamExternData::ptype, and ParamExternData::value.

Referenced by errdetail_params(), and exec_bind_message().

336 {
337  MemoryContext tmpCxt,
338  oldCxt;
340 
341  /*
342  * NB: think not of returning params->paramValuesStr! It may have been
343  * generated with a different maxlen, and so be unsuitable. Besides that,
344  * this is the function used to create that string.
345  */
346 
347  /*
348  * No work if the param fetch hook is in use. Also, it's not possible to
349  * do this in an aborted transaction. (It might be possible to improve on
350  * this last point when some knownTextValues exist, but it seems tricky.)
351  */
352  if (params->paramFetch != NULL ||
354  return NULL;
355 
356  /* Initialize the output stringinfo, in caller's memory context */
357  initStringInfo(&buf);
358 
359  /* Use a temporary context to call output functions, just in case */
361  "BuildParamLogString",
363  oldCxt = MemoryContextSwitchTo(tmpCxt);
364 
365  for (int paramno = 0; paramno < params->numParams; paramno++)
366  {
367  ParamExternData *param = &params->params[paramno];
368 
369  appendStringInfo(&buf,
370  "%s$%d = ",
371  paramno > 0 ? ", " : "",
372  paramno + 1);
373 
374  if (param->isnull || !OidIsValid(param->ptype))
375  appendStringInfoString(&buf, "NULL");
376  else
377  {
378  if (knownTextValues != NULL && knownTextValues[paramno] != NULL)
379  appendStringInfoStringQuoted(&buf, knownTextValues[paramno],
380  maxlen);
381  else
382  {
383  Oid typoutput;
384  bool typisvarlena;
385  char *pstring;
386 
387  getTypeOutputInfo(param->ptype, &typoutput, &typisvarlena);
388  pstring = OidOutputFunctionCall(typoutput, param->value);
389  appendStringInfoStringQuoted(&buf, pstring, maxlen);
390  }
391  }
392  }
393 
394  MemoryContextSwitchTo(oldCxt);
395  MemoryContextDelete(tmpCxt);
396 
397  return buf.data;
398 }
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125
Datum value
Definition: params.h:92
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:212
#define AllocSetContextCreate
Definition: memutils.h:170
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2784
bool IsAbortedTransactionBlockState(void)
Definition: xact.c:391
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:652
ParamFetchHook paramFetch
Definition: params.h:112
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:91
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:176
static char * buf
Definition: pg_test_fsync.c:68
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1657
bool isnull
Definition: params.h:93
void appendStringInfoStringQuoted(StringInfo str, const char *s, int maxlen)
Definition: stringinfo_mb.c:34

◆ copyParamList()

ParamListInfo copyParamList ( ParamListInfo  from)

Definition at line 78 of file params.c.

References datumCopy(), get_typlenbyval(), i, ParamExternData::isnull, makeParamList(), ParamListInfoData::numParams, OidIsValid, ParamListInfoData::paramFetch, ParamListInfoData::params, ParamExternData::ptype, and ParamExternData::value.

Referenced by PerformCursorOpen(), and SPI_cursor_open_internal().

79 {
80  ParamListInfo retval;
81 
82  if (from == NULL || from->numParams <= 0)
83  return NULL;
84 
85  retval = makeParamList(from->numParams);
86 
87  for (int i = 0; i < from->numParams; i++)
88  {
89  ParamExternData *oprm;
90  ParamExternData *nprm = &retval->params[i];
91  ParamExternData prmdata;
92  int16 typLen;
93  bool typByVal;
94 
95  /* give hook a chance in case parameter is dynamic */
96  if (from->paramFetch != NULL)
97  oprm = from->paramFetch(from, i + 1, false, &prmdata);
98  else
99  oprm = &from->params[i];
100 
101  /* flat-copy the parameter info */
102  *nprm = *oprm;
103 
104  /* need datumCopy in case it's a pass-by-reference datatype */
105  if (nprm->isnull || !OidIsValid(nprm->ptype))
106  continue;
107  get_typlenbyval(nprm->ptype, &typLen, &typByVal);
108  nprm->value = datumCopy(nprm->value, typByVal, typLen);
109  }
110 
111  return retval;
112 }
signed short int16
Definition: c.h:362
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125
Datum value
Definition: params.h:92
ParamListInfo makeParamList(int numParams)
Definition: params.c:44
#define OidIsValid(objectId)
Definition: c.h:652
ParamFetchHook paramFetch
Definition: params.h:112
Datum datumCopy(Datum value, bool typByVal, int typLen)
Definition: datum.c:131
void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval)
Definition: lsyscache.c:2139
int i
bool isnull
Definition: params.h:93

◆ EstimateParamListSpace()

Size EstimateParamListSpace ( ParamListInfo  paramLI)

Definition at line 167 of file params.c.

References add_size(), datumEstimateSpace(), get_typlenbyval(), i, ParamExternData::isnull, ParamListInfoData::numParams, OidIsValid, ParamListInfoData::paramFetch, ParamListInfoData::params, ParamExternData::ptype, and ParamExternData::value.

Referenced by ExecInitParallelPlan().

168 {
169  int i;
170  Size sz = sizeof(int);
171 
172  if (paramLI == NULL || paramLI->numParams <= 0)
173  return sz;
174 
175  for (i = 0; i < paramLI->numParams; i++)
176  {
177  ParamExternData *prm;
178  ParamExternData prmdata;
179  Oid typeOid;
180  int16 typLen;
181  bool typByVal;
182 
183  /* give hook a chance in case parameter is dynamic */
184  if (paramLI->paramFetch != NULL)
185  prm = paramLI->paramFetch(paramLI, i + 1, false, &prmdata);
186  else
187  prm = &paramLI->params[i];
188 
189  typeOid = prm->ptype;
190 
191  sz = add_size(sz, sizeof(Oid)); /* space for type OID */
192  sz = add_size(sz, sizeof(uint16)); /* space for pflags */
193 
194  /* space for datum/isnull */
195  if (OidIsValid(typeOid))
196  get_typlenbyval(typeOid, &typLen, &typByVal);
197  else
198  {
199  /* If no type OID, assume by-value, like copyParamList does. */
200  typLen = sizeof(Datum);
201  typByVal = true;
202  }
203  sz = add_size(sz,
204  datumEstimateSpace(prm->value, prm->isnull, typByVal, typLen));
205  }
206 
207  return sz;
208 }
signed short int16
Definition: c.h:362
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125
Datum value
Definition: params.h:92
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:652
ParamFetchHook paramFetch
Definition: params.h:112
unsigned short uint16
Definition: c.h:374
Size datumEstimateSpace(Datum value, bool isnull, bool typByVal, int typLen)
Definition: datum.c:360
uintptr_t Datum
Definition: postgres.h:367
Size add_size(Size s1, Size s2)
Definition: shmem.c:498
size_t Size
Definition: c.h:474
void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval)
Definition: lsyscache.c:2139
int i
bool isnull
Definition: params.h:93

◆ makeParamList()

ParamListInfo makeParamList ( int  numParams)

Definition at line 44 of file params.c.

References offsetof, palloc(), and paramlist_parser_setup().

Referenced by _SPI_convert_params(), copyParamList(), EvaluateParams(), exec_bind_message(), exec_eval_using_params(), plpgsql_estate_setup(), postquel_sub_params(), and RestoreParamList().

45 {
46  ParamListInfo retval;
47  Size size;
48 
49  size = offsetof(ParamListInfoData, params) +
50  numParams * sizeof(ParamExternData);
51 
52  retval = (ParamListInfo) palloc(size);
53  retval->paramFetch = NULL;
54  retval->paramFetchArg = NULL;
55  retval->paramCompile = NULL;
56  retval->paramCompileArg = NULL;
57  retval->parserSetup = paramlist_parser_setup;
58  retval->parserSetupArg = (void *) retval;
59  retval->paramValuesStr = NULL;
60  retval->numParams = numParams;
61 
62  return retval;
63 }
struct ParamListInfoData * ParamListInfo
Definition: params.h:98
static void paramlist_parser_setup(ParseState *pstate, void *arg)
Definition: params.c:120
struct ParamExternData ParamExternData
size_t Size
Definition: c.h:474
void * palloc(Size size)
Definition: mcxt.c:950
#define offsetof(type, field)
Definition: c.h:669

◆ paramlist_param_ref()

static Node * paramlist_param_ref ( ParseState pstate,
ParamRef pref 
)
static

Definition at line 131 of file params.c.

References get_typcollation(), ParamRef::location, makeNode, ParamRef::number, ParamListInfoData::numParams, OidIsValid, ParseState::p_ref_hook_state, PARAM_EXTERN, ParamListInfoData::paramFetch, and ParamListInfoData::params.

Referenced by paramlist_parser_setup().

132 {
133  ParamListInfo paramLI = (ParamListInfo) pstate->p_ref_hook_state;
134  int paramno = pref->number;
135  ParamExternData *prm;
136  ParamExternData prmdata;
137  Param *param;
138 
139  /* check parameter number is valid */
140  if (paramno <= 0 || paramno > paramLI->numParams)
141  return NULL;
142 
143  /* give hook a chance in case parameter is dynamic */
144  if (paramLI->paramFetch != NULL)
145  prm = paramLI->paramFetch(paramLI, paramno, false, &prmdata);
146  else
147  prm = &paramLI->params[paramno - 1];
148 
149  if (!OidIsValid(prm->ptype))
150  return NULL;
151 
152  param = makeNode(Param);
153  param->paramkind = PARAM_EXTERN;
154  param->paramid = paramno;
155  param->paramtype = prm->ptype;
156  param->paramtypmod = -1;
157  param->paramcollid = get_typcollation(param->paramtype);
158  param->location = pref->location;
159 
160  return (Node *) param;
161 }
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125
Definition: nodes.h:528
struct ParamListInfoData * ParamListInfo
Definition: params.h:98
#define OidIsValid(objectId)
Definition: c.h:652
ParamFetchHook paramFetch
Definition: params.h:112
int number
Definition: parsenodes.h:246
Oid get_typcollation(Oid typid)
Definition: lsyscache.c:2933
int location
Definition: parsenodes.h:247
#define makeNode(_type_)
Definition: nodes.h:576
void * p_ref_hook_state
Definition: parse_node.h:222

◆ paramlist_parser_setup()

static void paramlist_parser_setup ( ParseState pstate,
void *  arg 
)
static

Definition at line 120 of file params.c.

References arg, ParseState::p_paramref_hook, ParseState::p_ref_hook_state, and paramlist_param_ref().

Referenced by makeParamList().

121 {
123  /* no need to use p_coerce_param_hook */
124  pstate->p_ref_hook_state = arg;
125 }
ParseParamRefHook p_paramref_hook
Definition: parse_node.h:220
static Node * paramlist_param_ref(ParseState *pstate, ParamRef *pref)
Definition: params.c:131
void * p_ref_hook_state
Definition: parse_node.h:222
void * arg

◆ ParamsErrorCallback()

void ParamsErrorCallback ( void *  arg)

Definition at line 407 of file params.c.

References errcontext, ParamsErrorCbData::params, ParamListInfoData::paramValuesStr, and ParamsErrorCbData::portalName.

Referenced by exec_bind_message(), and exec_execute_message().

408 {
410 
411  if (data == NULL ||
412  data->params == NULL ||
413  data->params->paramValuesStr == NULL)
414  return;
415 
416  if (data->portalName && data->portalName[0] != '\0')
417  errcontext("portal \"%s\" with parameters: %s",
418  data->portalName, data->params->paramValuesStr);
419  else
420  errcontext("unnamed portal with parameters: %s",
421  data->params->paramValuesStr);
422 }
ParamListInfo params
Definition: params.h:157
char * paramValuesStr
Definition: params.h:118
const char * portalName
Definition: params.h:156
#define errcontext
Definition: elog.h:185
void * arg

◆ RestoreParamList()

ParamListInfo RestoreParamList ( char **  start_address)

Definition at line 292 of file params.c.

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

Referenced by ExecParallelGetQueryDesc().

293 {
294  ParamListInfo paramLI;
295  int nparams;
296 
297  memcpy(&nparams, *start_address, sizeof(int));
298  *start_address += sizeof(int);
299 
300  paramLI = makeParamList(nparams);
301 
302  for (int i = 0; i < nparams; i++)
303  {
304  ParamExternData *prm = &paramLI->params[i];
305 
306  /* Read type OID. */
307  memcpy(&prm->ptype, *start_address, sizeof(Oid));
308  *start_address += sizeof(Oid);
309 
310  /* Read flags. */
311  memcpy(&prm->pflags, *start_address, sizeof(uint16));
312  *start_address += sizeof(uint16);
313 
314  /* Read datum/isnull. */
315  prm->value = datumRestore(start_address, &prm->isnull);
316  }
317 
318  return paramLI;
319 }
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125
Datum value
Definition: params.h:92
unsigned int Oid
Definition: postgres_ext.h:31
ParamListInfo makeParamList(int numParams)
Definition: params.c:44
unsigned short uint16
Definition: c.h:374
Datum datumRestore(char **start_address, bool *isnull)
Definition: datum.c:469
uint16 pflags
Definition: params.h:94
int i
bool isnull
Definition: params.h:93

◆ SerializeParamList()

void SerializeParamList ( ParamListInfo  paramLI,
char **  start_address 
)

Definition at line 229 of file params.c.

References datumSerialize(), get_typlenbyval(), i, ParamExternData::isnull, ParamListInfoData::numParams, OidIsValid, ParamListInfoData::paramFetch, ParamListInfoData::params, ParamExternData::pflags, ParamExternData::ptype, and ParamExternData::value.

Referenced by ExecInitParallelPlan().

230 {
231  int nparams;
232  int i;
233 
234  /* Write number of parameters. */
235  if (paramLI == NULL || paramLI->numParams <= 0)
236  nparams = 0;
237  else
238  nparams = paramLI->numParams;
239  memcpy(*start_address, &nparams, sizeof(int));
240  *start_address += sizeof(int);
241 
242  /* Write each parameter in turn. */
243  for (i = 0; i < nparams; i++)
244  {
245  ParamExternData *prm;
246  ParamExternData prmdata;
247  Oid typeOid;
248  int16 typLen;
249  bool typByVal;
250 
251  /* give hook a chance in case parameter is dynamic */
252  if (paramLI->paramFetch != NULL)
253  prm = paramLI->paramFetch(paramLI, i + 1, false, &prmdata);
254  else
255  prm = &paramLI->params[i];
256 
257  typeOid = prm->ptype;
258 
259  /* Write type OID. */
260  memcpy(*start_address, &typeOid, sizeof(Oid));
261  *start_address += sizeof(Oid);
262 
263  /* Write flags. */
264  memcpy(*start_address, &prm->pflags, sizeof(uint16));
265  *start_address += sizeof(uint16);
266 
267  /* Write datum/isnull. */
268  if (OidIsValid(typeOid))
269  get_typlenbyval(typeOid, &typLen, &typByVal);
270  else
271  {
272  /* If no type OID, assume by-value, like copyParamList does. */
273  typLen = sizeof(Datum);
274  typByVal = true;
275  }
276  datumSerialize(prm->value, prm->isnull, typByVal, typLen,
277  start_address);
278  }
279 }
signed short int16
Definition: c.h:362
ParamExternData params[FLEXIBLE_ARRAY_MEMBER]
Definition: params.h:125
Datum value
Definition: params.h:92
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:652
ParamFetchHook paramFetch
Definition: params.h:112
unsigned short uint16
Definition: c.h:374
uintptr_t Datum
Definition: postgres.h:367
uint16 pflags
Definition: params.h:94
void get_typlenbyval(Oid typid, int16 *typlen, bool *typbyval)
Definition: lsyscache.c:2139
int i
void datumSerialize(Datum value, bool isnull, bool typByVal, int typLen, char **start_address)
Definition: datum.c:407
bool isnull
Definition: params.h:93