PostgreSQL Source Code  git master
plancache.h File Reference
#include "access/tupdesc.h"
#include "lib/ilist.h"
#include "nodes/params.h"
#include "tcop/cmdtag.h"
#include "utils/queryenvironment.h"
#include "utils/resowner.h"
Include dependency graph for plancache.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  CachedPlanSource
 
struct  CachedPlan
 
struct  CachedExpression
 

Macros

#define CACHEDPLANSOURCE_MAGIC   195726186
 
#define CACHEDPLAN_MAGIC   953717834
 
#define CACHEDEXPR_MAGIC   838275847
 

Typedefs

typedef struct CachedPlanSource CachedPlanSource
 
typedef struct CachedPlan CachedPlan
 
typedef struct CachedExpression CachedExpression
 

Enumerations

enum  PlanCacheMode { PLAN_CACHE_MODE_AUTO, PLAN_CACHE_MODE_FORCE_GENERIC_PLAN, PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN }
 

Functions

void InitPlanCache (void)
 
void ResetPlanCache (void)
 
CachedPlanSourceCreateCachedPlan (struct RawStmt *raw_parse_tree, const char *query_string, CommandTag commandTag)
 
CachedPlanSourceCreateOneShotCachedPlan (struct RawStmt *raw_parse_tree, const char *query_string, CommandTag commandTag)
 
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)
 
void SaveCachedPlan (CachedPlanSource *plansource)
 
void DropCachedPlan (CachedPlanSource *plansource)
 
void CachedPlanSetParentContext (CachedPlanSource *plansource, MemoryContext newcontext)
 
CachedPlanSourceCopyCachedPlan (CachedPlanSource *plansource)
 
bool CachedPlanIsValid (CachedPlanSource *plansource)
 
ListCachedPlanGetTargetList (CachedPlanSource *plansource, QueryEnvironment *queryEnv)
 
CachedPlanGetCachedPlan (CachedPlanSource *plansource, ParamListInfo boundParams, bool useResOwner, QueryEnvironment *queryEnv)
 
void ReleaseCachedPlan (CachedPlan *plan, bool useResOwner)
 
bool CachedPlanAllowsSimpleValidityCheck (CachedPlanSource *plansource, CachedPlan *plan, ResourceOwner owner)
 
bool CachedPlanIsSimplyValid (CachedPlanSource *plansource, CachedPlan *plan, ResourceOwner owner)
 
CachedExpressionGetCachedExpression (Node *expr)
 
void FreeCachedExpression (CachedExpression *cexpr)
 

Variables

int plan_cache_mode
 

Macro Definition Documentation

◆ CACHEDEXPR_MAGIC

#define CACHEDEXPR_MAGIC   838275847

◆ CACHEDPLAN_MAGIC

◆ CACHEDPLANSOURCE_MAGIC

Typedef Documentation

◆ CachedExpression

◆ CachedPlan

typedef struct CachedPlan CachedPlan

◆ CachedPlanSource

Enumeration Type Documentation

◆ PlanCacheMode

Enumerator
PLAN_CACHE_MODE_AUTO 
PLAN_CACHE_MODE_FORCE_GENERIC_PLAN 
PLAN_CACHE_MODE_FORCE_CUSTOM_PLAN 

Definition at line 30 of file plancache.h.

Function Documentation

◆ CachedPlanAllowsSimpleValidityCheck()

bool CachedPlanAllowsSimpleValidityCheck ( CachedPlanSource plansource,
CachedPlan plan,
ResourceOwner  owner 
)

Definition at line 1305 of file plancache.c.

References Assert, CACHEDPLAN_MAGIC, CACHEDPLANSOURCE_MAGIC, CMD_UTILITY, PlannedStmt::commandType, Query::commandType, Query::cteList, CachedPlanSource::dependsOnRLS, CachedPlan::dependsOnRole, CachedPlanSource::gplan, Query::hasSubLinks, CachedPlanSource::is_oneshot, CachedPlan::is_oneshot, CachedPlan::is_valid, lfirst, lfirst_node, CachedPlanSource::magic, CachedPlan::magic, OverrideSearchPathMatchesCurrent(), CachedPlanSource::query_list, CachedPlan::refcount, ResourceOwnerEnlargePlanCacheRefs(), ResourceOwnerRememberPlanCacheRef(), PlannedStmt::rtable, Query::rtable, RTE_RELATION, RangeTblEntry::rtekind, CachedPlan::saved_xmin, CachedPlanSource::search_path, CachedPlan::stmt_list, and TransactionIdIsValid.

Referenced by exec_eval_simple_expr(), and exec_simple_check_plan().

1307 {
1308  ListCell *lc;
1309 
1310  /*
1311  * Sanity-check that the caller gave us a validated generic plan. Notice
1312  * that we *don't* assert plansource->is_valid as you might expect; that's
1313  * because it's possible that that's already false when GetCachedPlan
1314  * returns, e.g. because ResetPlanCache happened partway through. We
1315  * should accept the plan as long as plan->is_valid is true, and expect to
1316  * replan after the next CachedPlanIsSimplyValid call.
1317  */
1318  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
1319  Assert(plan->magic == CACHEDPLAN_MAGIC);
1320  Assert(plan->is_valid);
1321  Assert(plan == plansource->gplan);
1322  Assert(plansource->search_path != NULL);
1324 
1325  /* We don't support oneshot plans here. */
1326  if (plansource->is_oneshot)
1327  return false;
1328  Assert(!plan->is_oneshot);
1329 
1330  /*
1331  * If the plan is dependent on RLS considerations, or it's transient,
1332  * reject. These things probably can't ever happen for table-free
1333  * queries, but for safety's sake let's check.
1334  */
1335  if (plansource->dependsOnRLS)
1336  return false;
1337  if (plan->dependsOnRole)
1338  return false;
1339  if (TransactionIdIsValid(plan->saved_xmin))
1340  return false;
1341 
1342  /*
1343  * Reject if AcquirePlannerLocks would have anything to do. This is
1344  * simplistic, but there's no need to inquire any more carefully; indeed,
1345  * for current callers it shouldn't even be possible to hit any of these
1346  * checks.
1347  */
1348  foreach(lc, plansource->query_list)
1349  {
1350  Query *query = lfirst_node(Query, lc);
1351 
1352  if (query->commandType == CMD_UTILITY)
1353  return false;
1354  if (query->rtable || query->cteList || query->hasSubLinks)
1355  return false;
1356  }
1357 
1358  /*
1359  * Reject if AcquireExecutorLocks would have anything to do. This is
1360  * probably unnecessary given the previous check, but let's be safe.
1361  */
1362  foreach(lc, plan->stmt_list)
1363  {
1364  PlannedStmt *plannedstmt = lfirst_node(PlannedStmt, lc);
1365  ListCell *lc2;
1366 
1367  if (plannedstmt->commandType == CMD_UTILITY)
1368  return false;
1369 
1370  /*
1371  * We have to grovel through the rtable because it's likely to contain
1372  * an RTE_RESULT relation, rather than being totally empty.
1373  */
1374  foreach(lc2, plannedstmt->rtable)
1375  {
1376  RangeTblEntry *rte = (RangeTblEntry *) lfirst(lc2);
1377 
1378  if (rte->rtekind == RTE_RELATION)
1379  return false;
1380  }
1381  }
1382 
1383  /*
1384  * Okay, it's simple. Note that what we've primarily established here is
1385  * that no locks need be taken before checking the plan's is_valid flag.
1386  */
1387 
1388  /* Bump refcount if requested. */
1389  if (owner)
1390  {
1392  plan->refcount++;
1393  ResourceOwnerRememberPlanCacheRef(owner, plan);
1394  }
1395 
1396  return true;
1397 }
#define CACHEDPLAN_MAGIC
Definition: plancache.h:41
bool is_valid
Definition: plancache.h:152
int refcount
Definition: plancache.h:158
void ResourceOwnerRememberPlanCacheRef(ResourceOwner owner, CachedPlan *plan)
Definition: resowner.c:1132
bool dependsOnRole
Definition: plancache.h:154
void ResourceOwnerEnlargePlanCacheRefs(ResourceOwner owner)
Definition: resowner.c:1121
struct CachedPlan * gplan
Definition: plancache.h:121
List * rtable
Definition: parsenodes.h:137
#define lfirst_node(type, lc)
Definition: pg_list.h:193
CmdType commandType
Definition: plannodes.h:46
CmdType commandType
Definition: parsenodes.h:112
bool OverrideSearchPathMatchesCurrent(OverrideSearchPath *path)
Definition: namespace.c:3419
#define Assert(condition)
Definition: c.h:738
#define lfirst(lc)
Definition: pg_list.h:190
List * rtable
Definition: plannodes.h:66
bool is_oneshot
Definition: plancache.h:150
RTEKind rtekind
Definition: parsenodes.h:976
List * cteList
Definition: parsenodes.h:135
bool hasSubLinks
Definition: parsenodes.h:128
List * query_list
Definition: plancache.h:111
List * stmt_list
Definition: plancache.h:149
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40
#define TransactionIdIsValid(xid)
Definition: transam.h:41
TransactionId saved_xmin
Definition: plancache.h:155
struct OverrideSearchPath * search_path
Definition: plancache.h:114

◆ CachedPlanGetTargetList()

List* CachedPlanGetTargetList ( CachedPlanSource plansource,
QueryEnvironment queryEnv 
)

Definition at line 1606 of file plancache.c.

References Assert, CACHEDPLANSOURCE_MAGIC, FetchStatementTargetList(), CachedPlanSource::is_complete, CachedPlanSource::magic, NIL, CachedPlanSource::query_list, QueryListGetPrimaryStmt(), CachedPlanSource::resultDesc, and RevalidateCachedQuery().

Referenced by exec_describe_statement_message(), and FetchPreparedStatementTargetList().

1608 {
1609  Query *pstmt;
1610 
1611  /* Assert caller is doing things in a sane order */
1612  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
1613  Assert(plansource->is_complete);
1614 
1615  /*
1616  * No work needed if statement doesn't return tuples (we assume this
1617  * feature cannot be changed by an invalidation)
1618  */
1619  if (plansource->resultDesc == NULL)
1620  return NIL;
1621 
1622  /* Make sure the querytree list is valid and we have parse-time locks */
1623  RevalidateCachedQuery(plansource, queryEnv);
1624 
1625  /* Get the primary statement and find out what it returns */
1626  pstmt = QueryListGetPrimaryStmt(plansource->query_list);
1627 
1628  return FetchStatementTargetList((Node *) pstmt);
1629 }
#define NIL
Definition: pg_list.h:65
Definition: nodes.h:529
TupleDesc resultDesc
Definition: plancache.h:108
List * FetchStatementTargetList(Node *stmt)
Definition: pquery.c:345
static Query * QueryListGetPrimaryStmt(List *stmts)
Definition: plancache.c:1719
static List * RevalidateCachedQuery(CachedPlanSource *plansource, QueryEnvironment *queryEnv)
Definition: plancache.c:553
#define Assert(condition)
Definition: c.h:738
List * query_list
Definition: plancache.h:111
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40

◆ CachedPlanIsSimplyValid()

bool CachedPlanIsSimplyValid ( CachedPlanSource plansource,
CachedPlan plan,
ResourceOwner  owner 
)

Definition at line 1420 of file plancache.c.

References Assert, CACHEDPLAN_MAGIC, CACHEDPLANSOURCE_MAGIC, CachedPlanSource::gplan, CachedPlanSource::is_valid, CachedPlan::is_valid, CachedPlanSource::magic, CachedPlan::magic, OverrideSearchPathMatchesCurrent(), CachedPlan::refcount, ResourceOwnerEnlargePlanCacheRefs(), ResourceOwnerRememberPlanCacheRef(), and CachedPlanSource::search_path.

Referenced by exec_eval_simple_expr().

1422 {
1423  /*
1424  * Careful here: since the caller doesn't necessarily hold a refcount on
1425  * the plan to start with, it's possible that "plan" is a dangling
1426  * pointer. Don't dereference it until we've verified that it still
1427  * matches the plansource's gplan (which is either valid or NULL).
1428  */
1429  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
1430 
1431  /*
1432  * Has cache invalidation fired on this plan? We can check this right
1433  * away since there are no locks that we'd need to acquire first. Note
1434  * that here we *do* check plansource->is_valid, so as to force plan
1435  * rebuild if that's become false.
1436  */
1437  if (!plansource->is_valid || plan != plansource->gplan || !plan->is_valid)
1438  return false;
1439 
1440  Assert(plan->magic == CACHEDPLAN_MAGIC);
1441 
1442  /* Is the search_path still the same as when we made it? */
1443  Assert(plansource->search_path != NULL);
1445  return false;
1446 
1447  /* It's still good. Bump refcount if requested. */
1448  if (owner)
1449  {
1451  plan->refcount++;
1452  ResourceOwnerRememberPlanCacheRef(owner, plan);
1453  }
1454 
1455  return true;
1456 }
#define CACHEDPLAN_MAGIC
Definition: plancache.h:41
bool is_valid
Definition: plancache.h:152
int refcount
Definition: plancache.h:158
void ResourceOwnerRememberPlanCacheRef(ResourceOwner owner, CachedPlan *plan)
Definition: resowner.c:1132
void ResourceOwnerEnlargePlanCacheRefs(ResourceOwner owner)
Definition: resowner.c:1121
struct CachedPlan * gplan
Definition: plancache.h:121
bool OverrideSearchPathMatchesCurrent(OverrideSearchPath *path)
Definition: namespace.c:3419
#define Assert(condition)
Definition: c.h:738
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40
struct OverrideSearchPath * search_path
Definition: plancache.h:114

◆ CachedPlanIsValid()

bool CachedPlanIsValid ( CachedPlanSource plansource)

Definition at line 1593 of file plancache.c.

References Assert, CACHEDPLANSOURCE_MAGIC, CachedPlanSource::is_valid, and CachedPlanSource::magic.

Referenced by SPI_plan_is_valid().

1594 {
1595  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
1596  return plansource->is_valid;
1597 }
#define Assert(condition)
Definition: c.h:738
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40

◆ CachedPlanSetParentContext()

void CachedPlanSetParentContext ( CachedPlanSource plansource,
MemoryContext  newcontext 
)

Definition at line 1465 of file plancache.c.

References Assert, CACHEDPLAN_MAGIC, CACHEDPLANSOURCE_MAGIC, CachedPlanSource::context, CachedPlan::context, elog, ERROR, CachedPlanSource::gplan, CachedPlanSource::is_complete, CachedPlanSource::is_oneshot, CachedPlanSource::is_saved, CachedPlanSource::magic, CachedPlan::magic, and MemoryContextSetParent().

Referenced by _SPI_make_plan_non_temp().

1467 {
1468  /* Assert caller is doing things in a sane order */
1469  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
1470  Assert(plansource->is_complete);
1471 
1472  /* These seem worth real tests, though */
1473  if (plansource->is_saved)
1474  elog(ERROR, "cannot move a saved cached plan to another context");
1475  if (plansource->is_oneshot)
1476  elog(ERROR, "cannot move a one-shot cached plan to another context");
1477 
1478  /* OK, let the caller keep the plan where he wishes */
1479  MemoryContextSetParent(plansource->context, newcontext);
1480 
1481  /*
1482  * The query_context needs no special handling, since it's a child of
1483  * plansource->context. But if there's a generic plan, it should be
1484  * maintained as a sibling of plansource->context.
1485  */
1486  if (plansource->gplan)
1487  {
1488  Assert(plansource->gplan->magic == CACHEDPLAN_MAGIC);
1489  MemoryContextSetParent(plansource->gplan->context, newcontext);
1490  }
1491 }
#define CACHEDPLAN_MAGIC
Definition: plancache.h:41
MemoryContext context
Definition: plancache.h:109
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:354
MemoryContext context
Definition: plancache.h:159
struct CachedPlan * gplan
Definition: plancache.h:121
#define ERROR
Definition: elog.h:43
#define Assert(condition)
Definition: c.h:738
#define elog(elevel,...)
Definition: elog.h:214
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40

◆ CompleteCachedPlan()

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 at line 336 of file plancache.c.

References ALLOCSET_START_SMALL_SIZES, AllocSetContextCreate, Assert, CACHEDPLANSOURCE_MAGIC, CachedPlanSource::context, copyObject, CurrentMemoryContext, CachedPlanSource::cursor_options, CachedPlanSource::dependsOnRLS, extract_query_dependencies(), CachedPlanSource::fixed_result, GetOverrideSearchPath(), GetUserId(), CachedPlanSource::invalItems, CachedPlanSource::is_complete, CachedPlanSource::is_oneshot, CachedPlanSource::is_valid, IsTransactionStmtPlan, CachedPlanSource::magic, MemoryContextSetParent(), MemoryContextSwitchTo(), CachedPlanSource::num_params, palloc(), CachedPlanSource::param_types, CachedPlanSource::parserSetup, CachedPlanSource::parserSetupArg, PlanCacheComputeResultDesc(), CachedPlanSource::query_context, CachedPlanSource::query_list, CachedPlanSource::relationOids, CachedPlanSource::resultDesc, CachedPlanSource::rewriteRoleId, CachedPlanSource::rewriteRowSecurity, row_security, and CachedPlanSource::search_path.

Referenced by _SPI_execute_plan(), _SPI_prepare_plan(), exec_parse_message(), and PrepareQuery().

345 {
346  MemoryContext source_context = plansource->context;
348 
349  /* Assert caller is doing things in a sane order */
350  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
351  Assert(!plansource->is_complete);
352 
353  /*
354  * If caller supplied a querytree_context, reparent it underneath the
355  * CachedPlanSource's context; otherwise, create a suitable context and
356  * copy the querytree_list into it. But no data copying should be done
357  * for one-shot plans; for those, assume the passed querytree_list is
358  * sufficiently long-lived.
359  */
360  if (plansource->is_oneshot)
361  {
362  querytree_context = CurrentMemoryContext;
363  }
364  else if (querytree_context != NULL)
365  {
366  MemoryContextSetParent(querytree_context, source_context);
367  MemoryContextSwitchTo(querytree_context);
368  }
369  else
370  {
371  /* Again, it's a good bet the querytree_context can be small */
372  querytree_context = AllocSetContextCreate(source_context,
373  "CachedPlanQuery",
375  MemoryContextSwitchTo(querytree_context);
376  querytree_list = copyObject(querytree_list);
377  }
378 
379  plansource->query_context = querytree_context;
380  plansource->query_list = querytree_list;
381 
382  if (!plansource->is_oneshot && !IsTransactionStmtPlan(plansource))
383  {
384  /*
385  * Use the planner machinery to extract dependencies. Data is saved
386  * in query_context. (We assume that not a lot of extra cruft is
387  * created by this call.) We can skip this for one-shot plans, and
388  * transaction control commands have no such dependencies anyway.
389  */
390  extract_query_dependencies((Node *) querytree_list,
391  &plansource->relationOids,
392  &plansource->invalItems,
393  &plansource->dependsOnRLS);
394 
395  /* Update RLS info as well. */
396  plansource->rewriteRoleId = GetUserId();
397  plansource->rewriteRowSecurity = row_security;
398 
399  /*
400  * Also save the current search_path in the query_context. (This
401  * should not generate much extra cruft either, since almost certainly
402  * the path is already valid.) Again, we don't really need this for
403  * one-shot plans; and we *must* skip this for transaction control
404  * commands, because this could result in catalog accesses.
405  */
406  plansource->search_path = GetOverrideSearchPath(querytree_context);
407  }
408 
409  /*
410  * Save the final parameter types (or other parameter specification data)
411  * into the source_context, as well as our other parameters. Also save
412  * the result tuple descriptor.
413  */
414  MemoryContextSwitchTo(source_context);
415 
416  if (num_params > 0)
417  {
418  plansource->param_types = (Oid *) palloc(num_params * sizeof(Oid));
419  memcpy(plansource->param_types, param_types, num_params * sizeof(Oid));
420  }
421  else
422  plansource->param_types = NULL;
423  plansource->num_params = num_params;
424  plansource->parserSetup = parserSetup;
425  plansource->parserSetupArg = parserSetupArg;
426  plansource->cursor_options = cursor_options;
427  plansource->fixed_result = fixed_result;
428  plansource->resultDesc = PlanCacheComputeResultDesc(querytree_list);
429 
430  MemoryContextSwitchTo(oldcxt);
431 
432  plansource->is_complete = true;
433  plansource->is_valid = true;
434 }
MemoryContext context
Definition: plancache.h:109
bool rewriteRowSecurity
Definition: plancache.h:118
#define AllocSetContextCreate
Definition: memutils.h:170
Oid GetUserId(void)
Definition: miscinit.c:448
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:354
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
Definition: nodes.h:529
unsigned int Oid
Definition: postgres_ext.h:31
TupleDesc resultDesc
Definition: plancache.h:108
List * invalItems
Definition: plancache.h:113
OverrideSearchPath * GetOverrideSearchPath(MemoryContext context)
Definition: namespace.c:3360
List * relationOids
Definition: plancache.h:112
void * parserSetupArg
Definition: plancache.h:105
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
ParserSetupHook parserSetup
Definition: plancache.h:104
bool row_security
Definition: guc.c:532
#define Assert(condition)
Definition: c.h:738
void extract_query_dependencies(Node *query, List **relationOids, List **invalItems, bool *hasRowSecurity)
Definition: setrefs.c:2791
void * palloc(Size size)
Definition: mcxt.c:949
MemoryContext query_context
Definition: plancache.h:116
#define ALLOCSET_START_SMALL_SIZES
Definition: memutils.h:209
List * query_list
Definition: plancache.h:111
#define IsTransactionStmtPlan(plansource)
Definition: plancache.c:82
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40
#define copyObject(obj)
Definition: nodes.h:645
static TupleDesc PlanCacheComputeResultDesc(List *stmt_list)
Definition: plancache.c:1906
struct OverrideSearchPath * search_path
Definition: plancache.h:114

◆ CopyCachedPlan()

CachedPlanSource* CopyCachedPlan ( CachedPlanSource plansource)

Definition at line 1503 of file plancache.c.

References ALLOCSET_START_SMALL_SIZES, AllocSetContextCreate, Assert, CACHEDPLANSOURCE_MAGIC, CachedPlanSource::commandTag, CachedPlanSource::context, copyObject, CopyOverrideSearchPath(), CreateTupleDescCopy(), CurrentMemoryContext, CachedPlanSource::cursor_options, CachedPlanSource::dependsOnRLS, elog, ERROR, CachedPlanSource::fixed_result, CachedPlanSource::generation, CachedPlanSource::generic_cost, CachedPlanSource::gplan, CachedPlanSource::invalItems, CachedPlanSource::is_complete, CachedPlanSource::is_oneshot, CachedPlanSource::is_saved, CachedPlanSource::is_valid, CachedPlanSource::magic, MemoryContextSetIdentifier(), MemoryContextSwitchTo(), CachedPlanSource::num_custom_plans, CachedPlanSource::num_params, palloc(), palloc0(), CachedPlanSource::param_types, CachedPlanSource::parserSetup, CachedPlanSource::parserSetupArg, pstrdup(), CachedPlanSource::query_context, CachedPlanSource::query_list, CachedPlanSource::query_string, CachedPlanSource::raw_parse_tree, CachedPlanSource::relationOids, CachedPlanSource::resultDesc, CachedPlanSource::rewriteRoleId, CachedPlanSource::rewriteRowSecurity, CachedPlanSource::search_path, and CachedPlanSource::total_custom_cost.

Referenced by _SPI_save_plan().

1504 {
1505  CachedPlanSource *newsource;
1506  MemoryContext source_context;
1507  MemoryContext querytree_context;
1508  MemoryContext oldcxt;
1509 
1510  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
1511  Assert(plansource->is_complete);
1512 
1513  /*
1514  * One-shot plans can't be copied, because we haven't taken care that
1515  * parsing/planning didn't scribble on the raw parse tree or querytrees.
1516  */
1517  if (plansource->is_oneshot)
1518  elog(ERROR, "cannot copy a one-shot cached plan");
1519 
1521  "CachedPlanSource",
1523 
1524  oldcxt = MemoryContextSwitchTo(source_context);
1525 
1526  newsource = (CachedPlanSource *) palloc0(sizeof(CachedPlanSource));
1527  newsource->magic = CACHEDPLANSOURCE_MAGIC;
1528  newsource->raw_parse_tree = copyObject(plansource->raw_parse_tree);
1529  newsource->query_string = pstrdup(plansource->query_string);
1530  MemoryContextSetIdentifier(source_context, newsource->query_string);
1531  newsource->commandTag = plansource->commandTag;
1532  if (plansource->num_params > 0)
1533  {
1534  newsource->param_types = (Oid *)
1535  palloc(plansource->num_params * sizeof(Oid));
1536  memcpy(newsource->param_types, plansource->param_types,
1537  plansource->num_params * sizeof(Oid));
1538  }
1539  else
1540  newsource->param_types = NULL;
1541  newsource->num_params = plansource->num_params;
1542  newsource->parserSetup = plansource->parserSetup;
1543  newsource->parserSetupArg = plansource->parserSetupArg;
1544  newsource->cursor_options = plansource->cursor_options;
1545  newsource->fixed_result = plansource->fixed_result;
1546  if (plansource->resultDesc)
1547  newsource->resultDesc = CreateTupleDescCopy(plansource->resultDesc);
1548  else
1549  newsource->resultDesc = NULL;
1550  newsource->context = source_context;
1551 
1552  querytree_context = AllocSetContextCreate(source_context,
1553  "CachedPlanQuery",
1555  MemoryContextSwitchTo(querytree_context);
1556  newsource->query_list = copyObject(plansource->query_list);
1557  newsource->relationOids = copyObject(plansource->relationOids);
1558  newsource->invalItems = copyObject(plansource->invalItems);
1559  if (plansource->search_path)
1560  newsource->search_path = CopyOverrideSearchPath(plansource->search_path);
1561  newsource->query_context = querytree_context;
1562  newsource->rewriteRoleId = plansource->rewriteRoleId;
1563  newsource->rewriteRowSecurity = plansource->rewriteRowSecurity;
1564  newsource->dependsOnRLS = plansource->dependsOnRLS;
1565 
1566  newsource->gplan = NULL;
1567 
1568  newsource->is_oneshot = false;
1569  newsource->is_complete = true;
1570  newsource->is_saved = false;
1571  newsource->is_valid = plansource->is_valid;
1572  newsource->generation = plansource->generation;
1573 
1574  /* We may as well copy any acquired cost knowledge */
1575  newsource->generic_cost = plansource->generic_cost;
1576  newsource->total_custom_cost = plansource->total_custom_cost;
1577  newsource->num_custom_plans = plansource->num_custom_plans;
1578 
1579  MemoryContextSwitchTo(oldcxt);
1580 
1581  return newsource;
1582 }
MemoryContext context
Definition: plancache.h:109
bool rewriteRowSecurity
Definition: plancache.h:118
TupleDesc CreateTupleDescCopy(TupleDesc tupdesc)
Definition: tupdesc.c:110
#define AllocSetContextCreate
Definition: memutils.h:170
char * pstrdup(const char *in)
Definition: mcxt.c:1186
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
unsigned int Oid
Definition: postgres_ext.h:31
double total_custom_cost
Definition: plancache.h:132
struct CachedPlan * gplan
Definition: plancache.h:121
TupleDesc resultDesc
Definition: plancache.h:108
#define ERROR
Definition: elog.h:43
OverrideSearchPath * CopyOverrideSearchPath(OverrideSearchPath *path)
Definition: namespace.c:3397
List * invalItems
Definition: plancache.h:113
List * relationOids
Definition: plancache.h:112
void * parserSetupArg
Definition: plancache.h:105
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
ParserSetupHook parserSetup
Definition: plancache.h:104
void * palloc0(Size size)
Definition: mcxt.c:980
double generic_cost
Definition: plancache.h:131
#define Assert(condition)
Definition: c.h:738
const char * query_string
Definition: plancache.h:100
CommandTag commandTag
Definition: plancache.h:101
void MemoryContextSetIdentifier(MemoryContext context, const char *id)
Definition: mcxt.c:329
struct RawStmt * raw_parse_tree
Definition: plancache.h:99
void * palloc(Size size)
Definition: mcxt.c:949
#define elog(elevel,...)
Definition: elog.h:214
MemoryContext query_context
Definition: plancache.h:116
#define ALLOCSET_START_SMALL_SIZES
Definition: memutils.h:209
List * query_list
Definition: plancache.h:111
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40
#define copyObject(obj)
Definition: nodes.h:645
struct OverrideSearchPath * search_path
Definition: plancache.h:114

◆ CreateCachedPlan()

CachedPlanSource* CreateCachedPlan ( struct RawStmt raw_parse_tree,
const char *  query_string,
CommandTag  commandTag 
)

Definition at line 164 of file plancache.c.

References ALLOCSET_START_SMALL_SIZES, AllocSetContextCreate, Assert, CACHEDPLANSOURCE_MAGIC, CachedPlanSource::commandTag, CachedPlanSource::context, copyObject, CurrentMemoryContext, CachedPlanSource::cursor_options, CachedPlanSource::dependsOnRLS, CachedPlanSource::fixed_result, CachedPlanSource::generation, CachedPlanSource::generic_cost, CachedPlanSource::gplan, InvalidOid, CachedPlanSource::invalItems, CachedPlanSource::is_complete, CachedPlanSource::is_oneshot, CachedPlanSource::is_saved, CachedPlanSource::is_valid, CachedPlanSource::magic, MemoryContextSetIdentifier(), MemoryContextSwitchTo(), NIL, CachedPlanSource::num_custom_plans, CachedPlanSource::num_params, palloc0(), CachedPlanSource::param_types, CachedPlanSource::parserSetup, CachedPlanSource::parserSetupArg, pstrdup(), CachedPlanSource::query_context, CachedPlanSource::query_list, CachedPlanSource::query_string, CachedPlanSource::raw_parse_tree, CachedPlanSource::relationOids, CachedPlanSource::resultDesc, CachedPlanSource::rewriteRoleId, CachedPlanSource::rewriteRowSecurity, CachedPlanSource::search_path, and CachedPlanSource::total_custom_cost.

Referenced by _SPI_prepare_plan(), exec_parse_message(), and PrepareQuery().

167 {
168  CachedPlanSource *plansource;
169  MemoryContext source_context;
170  MemoryContext oldcxt;
171 
172  Assert(query_string != NULL); /* required as of 8.4 */
173 
174  /*
175  * Make a dedicated memory context for the CachedPlanSource and its
176  * permanent subsidiary data. It's probably not going to be large, but
177  * just in case, allow it to grow large. Initially it's a child of the
178  * caller's context (which we assume to be transient), so that it will be
179  * cleaned up on error.
180  */
182  "CachedPlanSource",
184 
185  /*
186  * Create and fill the CachedPlanSource struct within the new context.
187  * Most fields are just left empty for the moment.
188  */
189  oldcxt = MemoryContextSwitchTo(source_context);
190 
191  plansource = (CachedPlanSource *) palloc0(sizeof(CachedPlanSource));
192  plansource->magic = CACHEDPLANSOURCE_MAGIC;
193  plansource->raw_parse_tree = copyObject(raw_parse_tree);
194  plansource->query_string = pstrdup(query_string);
195  MemoryContextSetIdentifier(source_context, plansource->query_string);
196  plansource->commandTag = commandTag;
197  plansource->param_types = NULL;
198  plansource->num_params = 0;
199  plansource->parserSetup = NULL;
200  plansource->parserSetupArg = NULL;
201  plansource->cursor_options = 0;
202  plansource->fixed_result = false;
203  plansource->resultDesc = NULL;
204  plansource->context = source_context;
205  plansource->query_list = NIL;
206  plansource->relationOids = NIL;
207  plansource->invalItems = NIL;
208  plansource->search_path = NULL;
209  plansource->query_context = NULL;
210  plansource->rewriteRoleId = InvalidOid;
211  plansource->rewriteRowSecurity = false;
212  plansource->dependsOnRLS = false;
213  plansource->gplan = NULL;
214  plansource->is_oneshot = false;
215  plansource->is_complete = false;
216  plansource->is_saved = false;
217  plansource->is_valid = false;
218  plansource->generation = 0;
219  plansource->generic_cost = -1;
220  plansource->total_custom_cost = 0;
221  plansource->num_custom_plans = 0;
222 
223  MemoryContextSwitchTo(oldcxt);
224 
225  return plansource;
226 }
MemoryContext context
Definition: plancache.h:109
#define NIL
Definition: pg_list.h:65
bool rewriteRowSecurity
Definition: plancache.h:118
#define AllocSetContextCreate
Definition: memutils.h:170
char * pstrdup(const char *in)
Definition: mcxt.c:1186
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
double total_custom_cost
Definition: plancache.h:132
struct CachedPlan * gplan
Definition: plancache.h:121
TupleDesc resultDesc
Definition: plancache.h:108
List * invalItems
Definition: plancache.h:113
List * relationOids
Definition: plancache.h:112
void * parserSetupArg
Definition: plancache.h:105
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
ParserSetupHook parserSetup
Definition: plancache.h:104
void * palloc0(Size size)
Definition: mcxt.c:980
#define InvalidOid
Definition: postgres_ext.h:36
double generic_cost
Definition: plancache.h:131
#define Assert(condition)
Definition: c.h:738
const char * query_string
Definition: plancache.h:100
CommandTag commandTag
Definition: plancache.h:101
void MemoryContextSetIdentifier(MemoryContext context, const char *id)
Definition: mcxt.c:329
struct RawStmt * raw_parse_tree
Definition: plancache.h:99
MemoryContext query_context
Definition: plancache.h:116
#define ALLOCSET_START_SMALL_SIZES
Definition: memutils.h:209
List * query_list
Definition: plancache.h:111
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40
#define copyObject(obj)
Definition: nodes.h:645
struct OverrideSearchPath * search_path
Definition: plancache.h:114

◆ CreateOneShotCachedPlan()

CachedPlanSource* CreateOneShotCachedPlan ( struct RawStmt raw_parse_tree,
const char *  query_string,
CommandTag  commandTag 
)

Definition at line 247 of file plancache.c.

References Assert, CACHEDPLANSOURCE_MAGIC, CachedPlanSource::commandTag, CachedPlanSource::context, CurrentMemoryContext, CachedPlanSource::cursor_options, CachedPlanSource::dependsOnRLS, CachedPlanSource::fixed_result, CachedPlanSource::generation, CachedPlanSource::generic_cost, CachedPlanSource::gplan, InvalidOid, CachedPlanSource::invalItems, CachedPlanSource::is_complete, CachedPlanSource::is_oneshot, CachedPlanSource::is_saved, CachedPlanSource::is_valid, CachedPlanSource::magic, NIL, CachedPlanSource::num_custom_plans, CachedPlanSource::num_params, palloc0(), CachedPlanSource::param_types, CachedPlanSource::parserSetup, CachedPlanSource::parserSetupArg, CachedPlanSource::query_context, CachedPlanSource::query_list, CachedPlanSource::query_string, CachedPlanSource::raw_parse_tree, CachedPlanSource::relationOids, CachedPlanSource::resultDesc, CachedPlanSource::rewriteRoleId, CachedPlanSource::rewriteRowSecurity, CachedPlanSource::search_path, and CachedPlanSource::total_custom_cost.

Referenced by _SPI_prepare_oneshot_plan().

250 {
251  CachedPlanSource *plansource;
252 
253  Assert(query_string != NULL); /* required as of 8.4 */
254 
255  /*
256  * Create and fill the CachedPlanSource struct within the caller's memory
257  * context. Most fields are just left empty for the moment.
258  */
259  plansource = (CachedPlanSource *) palloc0(sizeof(CachedPlanSource));
260  plansource->magic = CACHEDPLANSOURCE_MAGIC;
261  plansource->raw_parse_tree = raw_parse_tree;
262  plansource->query_string = query_string;
263  plansource->commandTag = commandTag;
264  plansource->param_types = NULL;
265  plansource->num_params = 0;
266  plansource->parserSetup = NULL;
267  plansource->parserSetupArg = NULL;
268  plansource->cursor_options = 0;
269  plansource->fixed_result = false;
270  plansource->resultDesc = NULL;
271  plansource->context = CurrentMemoryContext;
272  plansource->query_list = NIL;
273  plansource->relationOids = NIL;
274  plansource->invalItems = NIL;
275  plansource->search_path = NULL;
276  plansource->query_context = NULL;
277  plansource->rewriteRoleId = InvalidOid;
278  plansource->rewriteRowSecurity = false;
279  plansource->dependsOnRLS = false;
280  plansource->gplan = NULL;
281  plansource->is_oneshot = true;
282  plansource->is_complete = false;
283  plansource->is_saved = false;
284  plansource->is_valid = false;
285  plansource->generation = 0;
286  plansource->generic_cost = -1;
287  plansource->total_custom_cost = 0;
288  plansource->num_custom_plans = 0;
289 
290  return plansource;
291 }
MemoryContext context
Definition: plancache.h:109
#define NIL
Definition: pg_list.h:65
bool rewriteRowSecurity
Definition: plancache.h:118
double total_custom_cost
Definition: plancache.h:132
struct CachedPlan * gplan
Definition: plancache.h:121
TupleDesc resultDesc
Definition: plancache.h:108
List * invalItems
Definition: plancache.h:113
List * relationOids
Definition: plancache.h:112
void * parserSetupArg
Definition: plancache.h:105
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
ParserSetupHook parserSetup
Definition: plancache.h:104
void * palloc0(Size size)
Definition: mcxt.c:980
#define InvalidOid
Definition: postgres_ext.h:36
double generic_cost
Definition: plancache.h:131
#define Assert(condition)
Definition: c.h:738
const char * query_string
Definition: plancache.h:100
CommandTag commandTag
Definition: plancache.h:101
struct RawStmt * raw_parse_tree
Definition: plancache.h:99
MemoryContext query_context
Definition: plancache.h:116
List * query_list
Definition: plancache.h:111
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40
struct OverrideSearchPath * search_path
Definition: plancache.h:114

◆ DropCachedPlan()

void DropCachedPlan ( CachedPlanSource plansource)

Definition at line 496 of file plancache.c.

References Assert, CACHEDPLANSOURCE_MAGIC, CachedPlanSource::context, dlist_delete(), CachedPlanSource::is_oneshot, CachedPlanSource::is_saved, CachedPlanSource::magic, MemoryContextDelete(), CachedPlanSource::node, and ReleaseGenericPlan().

Referenced by drop_unnamed_stmt(), DropAllPreparedStatements(), DropPreparedStatement(), and SPI_freeplan().

497 {
498  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
499 
500  /* If it's been saved, remove it from the list */
501  if (plansource->is_saved)
502  {
503  dlist_delete(&plansource->node);
504  plansource->is_saved = false;
505  }
506 
507  /* Decrement generic CachedPlan's refcount and drop if no longer needed */
508  ReleaseGenericPlan(plansource);
509 
510  /* Mark it no longer valid */
511  plansource->magic = 0;
512 
513  /*
514  * Remove the CachedPlanSource and all subsidiary data (including the
515  * query_context if any). But if it's a one-shot we can't free anything.
516  */
517  if (!plansource->is_oneshot)
518  MemoryContextDelete(plansource->context);
519 }
MemoryContext context
Definition: plancache.h:109
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
static void ReleaseGenericPlan(CachedPlanSource *plansource)
Definition: plancache.c:525
static void dlist_delete(dlist_node *node)
Definition: ilist.h:358
#define Assert(condition)
Definition: c.h:738
dlist_node node
Definition: plancache.h:129
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40

◆ FreeCachedExpression()

void FreeCachedExpression ( CachedExpression cexpr)

Definition at line 1700 of file plancache.c.

References Assert, CACHEDEXPR_MAGIC, CachedExpression::context, dlist_delete(), CachedExpression::magic, MemoryContextDelete(), and CachedExpression::node.

Referenced by get_cast_hashentry().

1701 {
1702  /* Sanity check */
1703  Assert(cexpr->magic == CACHEDEXPR_MAGIC);
1704  /* Unlink from global list */
1705  dlist_delete(&cexpr->node);
1706  /* Free all storage associated with CachedExpression */
1707  MemoryContextDelete(cexpr->context);
1708 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
MemoryContext context
Definition: plancache.h:182
#define CACHEDEXPR_MAGIC
Definition: plancache.h:42
static void dlist_delete(dlist_node *node)
Definition: ilist.h:358
#define Assert(condition)
Definition: c.h:738
dlist_node node
Definition: plancache.h:183

◆ GetCachedExpression()

CachedExpression* GetCachedExpression ( Node expr)

Definition at line 1643 of file plancache.c.

References ALLOCSET_SMALL_SIZES, AllocSetContextCreate, CACHEDEXPR_MAGIC, CacheMemoryContext, CachedExpression::context, copyObject, CurrentMemoryContext, dlist_push_tail(), CachedExpression::expr, expression_planner_with_deps(), CachedExpression::invalItems, CachedExpression::is_valid, CachedExpression::magic, MemoryContextSetParent(), MemoryContextSwitchTo(), CachedExpression::node, palloc(), and CachedExpression::relationOids.

Referenced by get_cast_hashentry().

1644 {
1645  CachedExpression *cexpr;
1646  List *relationOids;
1647  List *invalItems;
1648  MemoryContext cexpr_context;
1649  MemoryContext oldcxt;
1650 
1651  /*
1652  * Pass the expression through the planner, and collect dependencies.
1653  * Everything built here is leaked in the caller's context; that's
1654  * intentional to minimize the size of the permanent data structure.
1655  */
1656  expr = (Node *) expression_planner_with_deps((Expr *) expr,
1657  &relationOids,
1658  &invalItems);
1659 
1660  /*
1661  * Make a private memory context, and copy what we need into that. To
1662  * avoid leaking a long-lived context if we fail while copying data, we
1663  * initially make the context under the caller's context.
1664  */
1666  "CachedExpression",
1668 
1669  oldcxt = MemoryContextSwitchTo(cexpr_context);
1670 
1671  cexpr = (CachedExpression *) palloc(sizeof(CachedExpression));
1672  cexpr->magic = CACHEDEXPR_MAGIC;
1673  cexpr->expr = copyObject(expr);
1674  cexpr->is_valid = true;
1675  cexpr->relationOids = copyObject(relationOids);
1676  cexpr->invalItems = copyObject(invalItems);
1677  cexpr->context = cexpr_context;
1678 
1679  MemoryContextSwitchTo(oldcxt);
1680 
1681  /*
1682  * Reparent the expr's memory context under CacheMemoryContext so that it
1683  * will live indefinitely.
1684  */
1686 
1687  /*
1688  * Add the entry to the global list of cached expressions.
1689  */
1691 
1692  return cexpr;
1693 }
#define AllocSetContextCreate
Definition: memutils.h:170
MemoryContext context
Definition: plancache.h:182
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:354
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:202
static void dlist_push_tail(dlist_head *head, dlist_node *node)
Definition: ilist.h:317
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
Definition: nodes.h:529
static dlist_head cached_expression_list
Definition: plancache.c:97
List * relationOids
Definition: plancache.h:180
List * invalItems
Definition: plancache.h:181
#define CACHEDEXPR_MAGIC
Definition: plancache.h:42
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
dlist_node node
Definition: plancache.h:183
Expr * expression_planner_with_deps(Expr *expr, List **relationOids, List **invalItems)
Definition: planner.c:6184
void * palloc(Size size)
Definition: mcxt.c:949
#define copyObject(obj)
Definition: nodes.h:645
Definition: pg_list.h:50
MemoryContext CacheMemoryContext
Definition: mcxt.c:47

◆ GetCachedPlan()

CachedPlan* GetCachedPlan ( CachedPlanSource plansource,
ParamListInfo  boundParams,
bool  useResOwner,
QueryEnvironment queryEnv 
)

Definition at line 1139 of file plancache.c.

References Assert, BuildCachedPlan(), cached_plan_cost(), CACHEDPLAN_MAGIC, CACHEDPLANSOURCE_MAGIC, CacheMemoryContext, CheckCachedPlan(), choose_custom_plan(), CachedPlanSource::context, CachedPlan::context, CurrentResourceOwner, elog, ERROR, CachedPlanSource::generic_cost, CachedPlanSource::gplan, CachedPlanSource::is_complete, CachedPlanSource::is_saved, CachedPlan::is_saved, CachedPlanSource::magic, CachedPlan::magic, MemoryContextGetParent(), MemoryContextSetParent(), NIL, CachedPlanSource::num_custom_plans, CachedPlan::refcount, ReleaseGenericPlan(), ResourceOwnerEnlargePlanCacheRefs(), ResourceOwnerRememberPlanCacheRef(), RevalidateCachedQuery(), and CachedPlanSource::total_custom_cost.

Referenced by _SPI_execute_plan(), exec_bind_message(), ExecuteQuery(), ExplainExecuteQuery(), SPI_cursor_open_internal(), and SPI_plan_get_cached_plan().

1141 {
1142  CachedPlan *plan = NULL;
1143  List *qlist;
1144  bool customplan;
1145 
1146  /* Assert caller is doing things in a sane order */
1147  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
1148  Assert(plansource->is_complete);
1149  /* This seems worth a real test, though */
1150  if (useResOwner && !plansource->is_saved)
1151  elog(ERROR, "cannot apply ResourceOwner to non-saved cached plan");
1152 
1153  /* Make sure the querytree list is valid and we have parse-time locks */
1154  qlist = RevalidateCachedQuery(plansource, queryEnv);
1155 
1156  /* Decide whether to use a custom plan */
1157  customplan = choose_custom_plan(plansource, boundParams);
1158 
1159  if (!customplan)
1160  {
1161  if (CheckCachedPlan(plansource))
1162  {
1163  /* We want a generic plan, and we already have a valid one */
1164  plan = plansource->gplan;
1165  Assert(plan->magic == CACHEDPLAN_MAGIC);
1166  }
1167  else
1168  {
1169  /* Build a new generic plan */
1170  plan = BuildCachedPlan(plansource, qlist, NULL, queryEnv);
1171  /* Just make real sure plansource->gplan is clear */
1172  ReleaseGenericPlan(plansource);
1173  /* Link the new generic plan into the plansource */
1174  plansource->gplan = plan;
1175  plan->refcount++;
1176  /* Immediately reparent into appropriate context */
1177  if (plansource->is_saved)
1178  {
1179  /* saved plans all live under CacheMemoryContext */
1181  plan->is_saved = true;
1182  }
1183  else
1184  {
1185  /* otherwise, it should be a sibling of the plansource */
1187  MemoryContextGetParent(plansource->context));
1188  }
1189  /* Update generic_cost whenever we make a new generic plan */
1190  plansource->generic_cost = cached_plan_cost(plan, false);
1191 
1192  /*
1193  * If, based on the now-known value of generic_cost, we'd not have
1194  * chosen to use a generic plan, then forget it and make a custom
1195  * plan. This is a bit of a wart but is necessary to avoid a
1196  * glitch in behavior when the custom plans are consistently big
1197  * winners; at some point we'll experiment with a generic plan and
1198  * find it's a loser, but we don't want to actually execute that
1199  * plan.
1200  */
1201  customplan = choose_custom_plan(plansource, boundParams);
1202 
1203  /*
1204  * If we choose to plan again, we need to re-copy the query_list,
1205  * since the planner probably scribbled on it. We can force
1206  * BuildCachedPlan to do that by passing NIL.
1207  */
1208  qlist = NIL;
1209  }
1210  }
1211 
1212  if (customplan)
1213  {
1214  /* Build a custom plan */
1215  plan = BuildCachedPlan(plansource, qlist, boundParams, queryEnv);
1216  /* Accumulate total costs of custom plans, but 'ware overflow */
1217  if (plansource->num_custom_plans < INT_MAX)
1218  {
1219  plansource->total_custom_cost += cached_plan_cost(plan, true);
1220  plansource->num_custom_plans++;
1221  }
1222  }
1223 
1224  Assert(plan != NULL);
1225 
1226  /* Flag the plan as in use by caller */
1227  if (useResOwner)
1229  plan->refcount++;
1230  if (useResOwner)
1232 
1233  /*
1234  * Saved plans should be under CacheMemoryContext so they will not go away
1235  * until their reference count goes to zero. In the generic-plan cases we
1236  * already took care of that, but for a custom plan, do it as soon as we
1237  * have created a reference-counted link.
1238  */
1239  if (customplan && plansource->is_saved)
1240  {
1242  plan->is_saved = true;
1243  }
1244 
1245  return plan;
1246 }
#define CACHEDPLAN_MAGIC
Definition: plancache.h:41
MemoryContext context
Definition: plancache.h:109
static CachedPlan * BuildCachedPlan(CachedPlanSource *plansource, List *qlist, ParamListInfo boundParams, QueryEnvironment *queryEnv)
Definition: plancache.c:877
#define NIL
Definition: pg_list.h:65
static void ReleaseGenericPlan(CachedPlanSource *plansource)
Definition: plancache.c:525
MemoryContext MemoryContextGetParent(MemoryContext context)
Definition: mcxt.c:439
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:354
ResourceOwner CurrentResourceOwner
Definition: resowner.c:142
int refcount
Definition: plancache.h:158
void ResourceOwnerRememberPlanCacheRef(ResourceOwner owner, CachedPlan *plan)
Definition: resowner.c:1132
void ResourceOwnerEnlargePlanCacheRefs(ResourceOwner owner)
Definition: resowner.c:1121
MemoryContext context
Definition: plancache.h:159
double total_custom_cost
Definition: plancache.h:132
struct CachedPlan * gplan
Definition: plancache.h:121
#define ERROR
Definition: elog.h:43
static List * RevalidateCachedQuery(CachedPlanSource *plansource, QueryEnvironment *queryEnv)
Definition: plancache.c:553
bool is_saved
Definition: plancache.h:151
double generic_cost
Definition: plancache.h:131
#define Assert(condition)
Definition: c.h:738
static bool CheckCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:793
#define elog(elevel,...)
Definition: elog.h:214
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40
Definition: pg_list.h:50
static bool choose_custom_plan(CachedPlanSource *plansource, ParamListInfo boundParams)
Definition: plancache.c:1017
MemoryContext CacheMemoryContext
Definition: mcxt.c:47
static double cached_plan_cost(CachedPlan *plan, bool include_planner)
Definition: plancache.c:1074

◆ InitPlanCache()

void InitPlanCache ( void  )

Definition at line 127 of file plancache.c.

References AMOPOPID, CacheRegisterRelcacheCallback(), CacheRegisterSyscacheCallback(), FOREIGNDATAWRAPPEROID, FOREIGNSERVEROID, NAMESPACEOID, OPEROID, PlanCacheObjectCallback(), PlanCacheRelCallback(), PlanCacheSysCallback(), PROCOID, and TYPEOID.

Referenced by InitPostgres().

128 {
137 }
static void PlanCacheObjectCallback(Datum arg, int cacheid, uint32 hashvalue)
Definition: plancache.c:2026
void CacheRegisterRelcacheCallback(RelcacheCallbackFunction func, Datum arg)
Definition: inval.c:1468
static void PlanCacheRelCallback(Datum arg, Oid relid)
Definition: plancache.c:1942
void CacheRegisterSyscacheCallback(int cacheid, SyscacheCallbackFunction func, Datum arg)
Definition: inval.c:1426
uintptr_t Datum
Definition: postgres.h:367
static void PlanCacheSysCallback(Datum arg, int cacheid, uint32 hashvalue)
Definition: plancache.c:2135

◆ ReleaseCachedPlan()

void ReleaseCachedPlan ( CachedPlan plan,
bool  useResOwner 
)

Definition at line 1260 of file plancache.c.

References Assert, CACHEDPLAN_MAGIC, CachedPlan::context, CurrentResourceOwner, CachedPlan::is_oneshot, CachedPlan::is_saved, CachedPlan::magic, MemoryContextDelete(), CachedPlan::refcount, and ResourceOwnerForgetPlanCacheRef().

Referenced by _SPI_execute_plan(), exec_eval_simple_expr(), exec_simple_check_plan(), ExplainExecuteQuery(), PortalReleaseCachedPlan(), ReleaseGenericPlan(), ResourceOwnerReleaseAllPlanCacheRefs(), ResourceOwnerReleaseInternal(), and SPI_cursor_open_internal().

1261 {
1262  Assert(plan->magic == CACHEDPLAN_MAGIC);
1263  if (useResOwner)
1264  {
1265  Assert(plan->is_saved);
1267  }
1268  Assert(plan->refcount > 0);
1269  plan->refcount--;
1270  if (plan->refcount == 0)
1271  {
1272  /* Mark it no longer valid */
1273  plan->magic = 0;
1274 
1275  /* One-shot plans do not own their context, so we can't free them */
1276  if (!plan->is_oneshot)
1278  }
1279 }
#define CACHEDPLAN_MAGIC
Definition: plancache.h:41
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
ResourceOwner CurrentResourceOwner
Definition: resowner.c:142
int refcount
Definition: plancache.h:158
MemoryContext context
Definition: plancache.h:159
void ResourceOwnerForgetPlanCacheRef(ResourceOwner owner, CachedPlan *plan)
Definition: resowner.c:1141
bool is_saved
Definition: plancache.h:151
#define Assert(condition)
Definition: c.h:738
bool is_oneshot
Definition: plancache.h:150

◆ ResetPlanCache()

void ResetPlanCache ( void  )

Definition at line 2144 of file plancache.c.

References Assert, CACHEDEXPR_MAGIC, CACHEDPLANSOURCE_MAGIC, CMD_UTILITY, Query::commandType, dlist_iter::cur, dlist_container, dlist_foreach, CachedPlanSource::gplan, CachedPlanSource::is_valid, CachedPlan::is_valid, CachedExpression::is_valid, IsTransactionStmtPlan, lfirst_node, CachedPlanSource::magic, CachedExpression::magic, CachedPlanSource::query_list, UtilityContainsQuery(), and Query::utilityStmt.

Referenced by assign_session_replication_role(), DiscardAll(), DiscardCommand(), and PlanCacheSysCallback().

2145 {
2146  dlist_iter iter;
2147 
2149  {
2151  node, iter.cur);
2152  ListCell *lc;
2153 
2154  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
2155 
2156  /* No work if it's already invalidated */
2157  if (!plansource->is_valid)
2158  continue;
2159 
2160  /*
2161  * We *must not* mark transaction control statements as invalid,
2162  * particularly not ROLLBACK, because they may need to be executed in
2163  * aborted transactions when we can't revalidate them (cf bug #5269).
2164  */
2165  if (IsTransactionStmtPlan(plansource))
2166  continue;
2167 
2168  /*
2169  * In general there is no point in invalidating utility statements
2170  * since they have no plans anyway. So invalidate it only if it
2171  * contains at least one non-utility statement, or contains a utility
2172  * statement that contains a pre-analyzed query (which could have
2173  * dependencies.)
2174  */
2175  foreach(lc, plansource->query_list)
2176  {
2177  Query *query = lfirst_node(Query, lc);
2178 
2179  if (query->commandType != CMD_UTILITY ||
2181  {
2182  /* non-utility statement, so invalidate */
2183  plansource->is_valid = false;
2184  if (plansource->gplan)
2185  plansource->gplan->is_valid = false;
2186  /* no need to look further */
2187  break;
2188  }
2189  }
2190  }
2191 
2192  /* Likewise invalidate cached expressions */
2194  {
2196  node, iter.cur);
2197 
2198  Assert(cexpr->magic == CACHEDEXPR_MAGIC);
2199 
2200  cexpr->is_valid = false;
2201  }
2202 }
bool is_valid
Definition: plancache.h:152
#define dlist_foreach(iter, lhead)
Definition: ilist.h:507
Node * utilityStmt
Definition: parsenodes.h:120
static dlist_head cached_expression_list
Definition: plancache.c:97
struct CachedPlan * gplan
Definition: plancache.h:121
Query * UtilityContainsQuery(Node *parsetree)
Definition: utility.c:2063
#define dlist_container(type, membername, ptr)
Definition: ilist.h:477
#define lfirst_node(type, lc)
Definition: pg_list.h:193
#define CACHEDEXPR_MAGIC
Definition: plancache.h:42
static dlist_head saved_plan_list
Definition: plancache.c:92
dlist_node * cur
Definition: ilist.h:161
CmdType commandType
Definition: parsenodes.h:112
#define Assert(condition)
Definition: c.h:738
List * query_list
Definition: plancache.h:111
#define IsTransactionStmtPlan(plansource)
Definition: plancache.c:82
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40

◆ SaveCachedPlan()

void SaveCachedPlan ( CachedPlanSource plansource)

Definition at line 452 of file plancache.c.

References Assert, CACHEDPLANSOURCE_MAGIC, CacheMemoryContext, CachedPlanSource::context, dlist_push_tail(), elog, ERROR, CachedPlanSource::is_complete, CachedPlanSource::is_oneshot, CachedPlanSource::is_saved, CachedPlanSource::magic, MemoryContextSetParent(), CachedPlanSource::node, and ReleaseGenericPlan().

Referenced by _SPI_save_plan(), exec_parse_message(), SPI_keepplan(), and StorePreparedStatement().

453 {
454  /* Assert caller is doing things in a sane order */
455  Assert(plansource->magic == CACHEDPLANSOURCE_MAGIC);
456  Assert(plansource->is_complete);
457  Assert(!plansource->is_saved);
458 
459  /* This seems worth a real test, though */
460  if (plansource->is_oneshot)
461  elog(ERROR, "cannot save one-shot cached plan");
462 
463  /*
464  * In typical use, this function would be called before generating any
465  * plans from the CachedPlanSource. If there is a generic plan, moving it
466  * into CacheMemoryContext would be pretty risky since it's unclear
467  * whether the caller has taken suitable care with making references
468  * long-lived. Best thing to do seems to be to discard the plan.
469  */
470  ReleaseGenericPlan(plansource);
471 
472  /*
473  * Reparent the source memory context under CacheMemoryContext so that it
474  * will live indefinitely. The query_context follows along since it's
475  * already a child of the other one.
476  */
478 
479  /*
480  * Add the entry to the global list of cached plans.
481  */
482  dlist_push_tail(&saved_plan_list, &plansource->node);
483 
484  plansource->is_saved = true;
485 }
MemoryContext context
Definition: plancache.h:109
static void ReleaseGenericPlan(CachedPlanSource *plansource)
Definition: plancache.c:525
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:354
static void dlist_push_tail(dlist_head *head, dlist_node *node)
Definition: ilist.h:317
#define ERROR
Definition: elog.h:43
static dlist_head saved_plan_list
Definition: plancache.c:92
#define Assert(condition)
Definition: c.h:738
dlist_node node
Definition: plancache.h:129
#define elog(elevel,...)
Definition: elog.h:214
#define CACHEDPLANSOURCE_MAGIC
Definition: plancache.h:40
MemoryContext CacheMemoryContext
Definition: mcxt.c:47

Variable Documentation

◆ plan_cache_mode

int plan_cache_mode

Definition at line 119 of file plancache.c.

Referenced by choose_custom_plan().