PostgreSQL Source Code  git master
placeholder.c File Reference
#include "postgres.h"
#include "nodes/nodeFuncs.h"
#include "optimizer/cost.h"
#include "optimizer/optimizer.h"
#include "optimizer/pathnode.h"
#include "optimizer/placeholder.h"
#include "optimizer/planmain.h"
#include "utils/lsyscache.h"
Include dependency graph for placeholder.c:

Go to the source code of this file.

Data Structures

struct  contain_placeholder_references_context
 

Typedefs

typedef struct contain_placeholder_references_context contain_placeholder_references_context
 

Functions

static void find_placeholders_recurse (PlannerInfo *root, Node *jtnode)
 
static void find_placeholders_in_expr (PlannerInfo *root, Node *expr)
 
static bool contain_placeholder_references_walker (Node *node, contain_placeholder_references_context *context)
 
PlaceHolderVarmake_placeholder_expr (PlannerInfo *root, Expr *expr, Relids phrels)
 
PlaceHolderInfofind_placeholder_info (PlannerInfo *root, PlaceHolderVar *phv)
 
void find_placeholders_in_jointree (PlannerInfo *root)
 
void fix_placeholder_input_needed_levels (PlannerInfo *root)
 
void add_placeholders_to_base_rels (PlannerInfo *root)
 
void add_placeholders_to_joinrel (PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outer_rel, RelOptInfo *inner_rel, SpecialJoinInfo *sjinfo)
 
bool contain_placeholder_references_to (PlannerInfo *root, Node *clause, int relid)
 

Typedef Documentation

◆ contain_placeholder_references_context

Function Documentation

◆ add_placeholders_to_base_rels()

void add_placeholders_to_base_rels ( PlannerInfo root)

Definition at line 329 of file placeholder.c.

330 {
331  ListCell *lc;
332 
333  foreach(lc, root->placeholder_list)
334  {
335  PlaceHolderInfo *phinfo = (PlaceHolderInfo *) lfirst(lc);
336  Relids eval_at = phinfo->ph_eval_at;
337  int varno;
338 
339  if (bms_get_singleton_member(eval_at, &varno) &&
340  bms_nonempty_difference(phinfo->ph_needed, eval_at))
341  {
342  RelOptInfo *rel = find_base_rel(root, varno);
343 
344  /*
345  * As in add_vars_to_targetlist(), a value computed at scan level
346  * has not yet been nulled by any outer join, so its phnullingrels
347  * should be empty.
348  */
349  Assert(phinfo->ph_var->phnullingrels == NULL);
350 
351  /* Copying the PHV might be unnecessary here, but be safe */
352  rel->reltarget->exprs = lappend(rel->reltarget->exprs,
353  copyObject(phinfo->ph_var));
354  /* reltarget's cost and width fields will be updated later */
355  }
356  }
357 }
bool bms_get_singleton_member(const Bitmapset *a, int *member)
Definition: bitmapset.c:715
bool bms_nonempty_difference(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:641
#define Assert(condition)
Definition: c.h:858
List * lappend(List *list, void *datum)
Definition: list.c:339
#define copyObject(obj)
Definition: nodes.h:224
#define lfirst(lc)
Definition: pg_list.h:172
tree ctl root
Definition: radixtree.h:1880
RelOptInfo * find_base_rel(PlannerInfo *root, int relid)
Definition: relnode.c:414
List * exprs
Definition: pathnodes.h:1522
Relids ph_needed
Definition: pathnodes.h:3082
Relids ph_eval_at
Definition: pathnodes.h:3076
PlaceHolderVar * ph_var
Definition: pathnodes.h:3073
Relids phnullingrels
Definition: pathnodes.h:2779
struct PathTarget * reltarget
Definition: pathnodes.h:883

References Assert, bms_get_singleton_member(), bms_nonempty_difference(), copyObject, PathTarget::exprs, find_base_rel(), lappend(), lfirst, PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_needed, PlaceHolderInfo::ph_var, PlaceHolderVar::phnullingrels, RelOptInfo::reltarget, and root.

Referenced by query_planner().

◆ add_placeholders_to_joinrel()

void add_placeholders_to_joinrel ( PlannerInfo root,
RelOptInfo joinrel,
RelOptInfo outer_rel,
RelOptInfo inner_rel,
SpecialJoinInfo sjinfo 
)

Definition at line 373 of file placeholder.c.

376 {
377  Relids relids = joinrel->relids;
378  int64 tuple_width = joinrel->reltarget->width;
379  ListCell *lc;
380 
381  foreach(lc, root->placeholder_list)
382  {
383  PlaceHolderInfo *phinfo = (PlaceHolderInfo *) lfirst(lc);
384 
385  /* Is it computable here? */
386  if (bms_is_subset(phinfo->ph_eval_at, relids))
387  {
388  /* Is it still needed above this joinrel? */
389  if (bms_nonempty_difference(phinfo->ph_needed, relids))
390  {
391  /*
392  * Yes, but only add to tlist if it wasn't computed in either
393  * input; otherwise it should be there already. Also, we
394  * charge the cost of evaluating the contained expression if
395  * the PHV can be computed here but not in either input. This
396  * is a bit bogus because we make the decision based on the
397  * first pair of possible input relations considered for the
398  * joinrel. With other pairs, it might be possible to compute
399  * the PHV in one input or the other, and then we'd be double
400  * charging the PHV's cost for some join paths. For now, live
401  * with that; but we might want to improve it later by
402  * refiguring the reltarget costs for each pair of inputs.
403  */
404  if (!bms_is_subset(phinfo->ph_eval_at, outer_rel->relids) &&
405  !bms_is_subset(phinfo->ph_eval_at, inner_rel->relids))
406  {
407  /* Copying might be unnecessary here, but be safe */
408  PlaceHolderVar *phv = copyObject(phinfo->ph_var);
409  QualCost cost;
410 
411  /*
412  * It'll start out not nulled by anything. Joins above
413  * this one might add to its phnullingrels later, in much
414  * the same way as for Vars.
415  */
416  Assert(phv->phnullingrels == NULL);
417 
418  joinrel->reltarget->exprs = lappend(joinrel->reltarget->exprs,
419  phv);
420  cost_qual_eval_node(&cost, (Node *) phv->phexpr, root);
421  joinrel->reltarget->cost.startup += cost.startup;
422  joinrel->reltarget->cost.per_tuple += cost.per_tuple;
423  tuple_width += phinfo->ph_width;
424  }
425  }
426 
427  /*
428  * Also adjust joinrel's direct_lateral_relids to include the
429  * PHV's source rel(s). We must do this even if we're not
430  * actually going to emit the PHV, otherwise join_is_legal() will
431  * reject valid join orderings. (In principle maybe we could
432  * instead remove the joinrel's lateral_relids dependency; but
433  * that's complicated to get right, and cases where we're not
434  * going to emit the PHV are too rare to justify the work.)
435  *
436  * In principle we should only do this if the join doesn't yet
437  * include the PHV's source rel(s). But our caller
438  * build_join_rel() will clean things up by removing the join's
439  * own relids from its direct_lateral_relids, so we needn't
440  * account for that here.
441  */
442  joinrel->direct_lateral_relids =
444  phinfo->ph_lateral);
445  }
446  }
447 
448  joinrel->reltarget->width = clamp_width_est(tuple_width);
449 }
bool bms_is_subset(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:412
Bitmapset * bms_add_members(Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:917
void cost_qual_eval_node(QualCost *cost, Node *qual, PlannerInfo *root)
Definition: costsize.c:4666
int32 clamp_width_est(int64 tuple_width)
Definition: costsize.c:231
Definition: nodes.h:129
QualCost cost
Definition: pathnodes.h:1528
Relids ph_lateral
Definition: pathnodes.h:3079
Cost per_tuple
Definition: pathnodes.h:48
Cost startup
Definition: pathnodes.h:47
Relids relids
Definition: pathnodes.h:861
Relids direct_lateral_relids
Definition: pathnodes.h:901

References Assert, bms_add_members(), bms_is_subset(), bms_nonempty_difference(), clamp_width_est(), copyObject, PathTarget::cost, cost_qual_eval_node(), RelOptInfo::direct_lateral_relids, PathTarget::exprs, lappend(), lfirst, QualCost::per_tuple, PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_lateral, PlaceHolderInfo::ph_needed, PlaceHolderInfo::ph_var, PlaceHolderInfo::ph_width, PlaceHolderVar::phnullingrels, RelOptInfo::relids, RelOptInfo::reltarget, root, QualCost::startup, and PathTarget::width.

Referenced by build_join_rel().

◆ contain_placeholder_references_to()

bool contain_placeholder_references_to ( PlannerInfo root,
Node clause,
int  relid 
)

Definition at line 464 of file placeholder.c.

466 {
468 
469  /* We can answer quickly in the common case that there's no PHVs at all */
470  if (root->glob->lastPHId == 0)
471  return false;
472  /* Else run the recursive search */
473  context.relid = relid;
474  context.sublevels_up = 0;
476 }
static bool contain_placeholder_references_walker(Node *node, contain_placeholder_references_context *context)
Definition: placeholder.c:479
tree context
Definition: radixtree.h:1829

References contain_placeholder_references_walker(), context, and root.

Referenced by make_outerjoininfo().

◆ contain_placeholder_references_walker()

static bool contain_placeholder_references_walker ( Node node,
contain_placeholder_references_context context 
)
static

Definition at line 479 of file placeholder.c.

481 {
482  if (node == NULL)
483  return false;
484  if (IsA(node, PlaceHolderVar))
485  {
486  PlaceHolderVar *phv = (PlaceHolderVar *) node;
487 
488  /* We should just look through PHVs of other query levels */
489  if (phv->phlevelsup == context->sublevels_up)
490  {
491  /* If phrels matches, we found what we came for */
492  if (bms_is_member(context->relid, phv->phrels))
493  return true;
494 
495  /*
496  * We should not examine phnullingrels: what we are looking for is
497  * references in the contained expression, not OJs that might null
498  * the result afterwards. Also, we don't need to recurse into the
499  * contained expression, because phrels should adequately
500  * summarize what's in there. So we're done here.
501  */
502  return false;
503  }
504  }
505  else if (IsA(node, Query))
506  {
507  /* Recurse into RTE subquery or not-yet-planned sublink subquery */
508  bool result;
509 
510  context->sublevels_up++;
511  result = query_tree_walker((Query *) node,
513  context,
514  0);
515  context->sublevels_up--;
516  return result;
517  }
519  context);
520 }
bool bms_is_member(int x, const Bitmapset *a)
Definition: bitmapset.c:510
#define query_tree_walker(q, w, c, f)
Definition: nodeFuncs.h:156
#define expression_tree_walker(n, w, c)
Definition: nodeFuncs.h:151
#define IsA(nodeptr, _type_)
Definition: nodes.h:158
Index phlevelsup
Definition: pathnodes.h:2785

References bms_is_member(), context, expression_tree_walker, IsA, PlaceHolderVar::phlevelsup, and query_tree_walker.

Referenced by contain_placeholder_references_to().

◆ find_placeholder_info()

PlaceHolderInfo* find_placeholder_info ( PlannerInfo root,
PlaceHolderVar phv 
)

Definition at line 83 of file placeholder.c.

84 {
85  PlaceHolderInfo *phinfo;
86  Relids rels_used;
87 
88  /* if this ever isn't true, we'd need to be able to look in parent lists */
89  Assert(phv->phlevelsup == 0);
90 
91  /* Use placeholder_array to look up existing PlaceHolderInfo quickly */
92  if (phv->phid < root->placeholder_array_size)
93  phinfo = root->placeholder_array[phv->phid];
94  else
95  phinfo = NULL;
96  if (phinfo != NULL)
97  {
98  Assert(phinfo->phid == phv->phid);
99  return phinfo;
100  }
101 
102  /* Not found, so create it */
103  if (root->placeholdersFrozen)
104  elog(ERROR, "too late to create a new PlaceHolderInfo");
105 
106  phinfo = makeNode(PlaceHolderInfo);
107 
108  phinfo->phid = phv->phid;
109  phinfo->ph_var = copyObject(phv);
110 
111  /*
112  * By convention, phinfo->ph_var->phnullingrels is always empty, since the
113  * PlaceHolderInfo represents the initially-calculated state of the
114  * PlaceHolderVar. PlaceHolderVars appearing in the query tree might have
115  * varying values of phnullingrels, reflecting outer joins applied above
116  * the calculation level.
117  */
118  phinfo->ph_var->phnullingrels = NULL;
119 
120  /*
121  * Any referenced rels that are outside the PHV's syntactic scope are
122  * LATERAL references, which should be included in ph_lateral but not in
123  * ph_eval_at. If no referenced rels are within the syntactic scope,
124  * force evaluation at the syntactic location.
125  */
126  rels_used = pull_varnos(root, (Node *) phv->phexpr);
127  phinfo->ph_lateral = bms_difference(rels_used, phv->phrels);
128  phinfo->ph_eval_at = bms_int_members(rels_used, phv->phrels);
129  /* If no contained vars, force evaluation at syntactic location */
130  if (bms_is_empty(phinfo->ph_eval_at))
131  {
132  phinfo->ph_eval_at = bms_copy(phv->phrels);
133  Assert(!bms_is_empty(phinfo->ph_eval_at));
134  }
135  phinfo->ph_needed = NULL; /* initially it's unused */
136  /* for the moment, estimate width using just the datatype info */
137  phinfo->ph_width = get_typavgwidth(exprType((Node *) phv->phexpr),
138  exprTypmod((Node *) phv->phexpr));
139 
140  /*
141  * Add to both placeholder_list and placeholder_array. Note: because we
142  * store pointers to the PlaceHolderInfos in two data structures, it'd be
143  * unsafe to pass the whole placeholder_list structure through
144  * expression_tree_mutator or the like --- or at least, you'd have to
145  * rebuild the placeholder_array afterwards.
146  */
147  root->placeholder_list = lappend(root->placeholder_list, phinfo);
148 
149  if (phinfo->phid >= root->placeholder_array_size)
150  {
151  /* Must allocate or enlarge placeholder_array */
152  int new_size;
153 
154  new_size = root->placeholder_array_size ? root->placeholder_array_size * 2 : 8;
155  while (phinfo->phid >= new_size)
156  new_size *= 2;
157  if (root->placeholder_array)
158  root->placeholder_array =
159  repalloc0_array(root->placeholder_array, PlaceHolderInfo *, root->placeholder_array_size, new_size);
160  else
161  root->placeholder_array =
162  palloc0_array(PlaceHolderInfo *, new_size);
163  root->placeholder_array_size = new_size;
164  }
165  root->placeholder_array[phinfo->phid] = phinfo;
166 
167  /*
168  * The PHV's contained expression may contain other, lower-level PHVs. We
169  * now know we need to get those into the PlaceHolderInfo list, too, so we
170  * may as well do that immediately.
171  */
172  find_placeholders_in_expr(root, (Node *) phinfo->ph_var->phexpr);
173 
174  return phinfo;
175 }
Bitmapset * bms_difference(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:346
Bitmapset * bms_int_members(Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:1109
Bitmapset * bms_copy(const Bitmapset *a)
Definition: bitmapset.c:122
#define bms_is_empty(a)
Definition: bitmapset.h:118
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:224
#define palloc0_array(type, count)
Definition: fe_memutils.h:65
int32 get_typavgwidth(Oid typid, int32 typmod)
Definition: lsyscache.c:2578
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:42
int32 exprTypmod(const Node *expr)
Definition: nodeFuncs.c:298
#define makeNode(_type_)
Definition: nodes.h:155
#define repalloc0_array(pointer, type, oldcount, count)
Definition: palloc.h:109
static void find_placeholders_in_expr(PlannerInfo *root, Node *expr)
Definition: placeholder.c:257
Relids pull_varnos(PlannerInfo *root, Node *node)
Definition: var.c:108

References Assert, bms_copy(), bms_difference(), bms_int_members(), bms_is_empty, copyObject, elog, ERROR, exprType(), exprTypmod(), find_placeholders_in_expr(), get_typavgwidth(), lappend(), makeNode, palloc0_array, PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_lateral, PlaceHolderInfo::ph_needed, PlaceHolderInfo::ph_var, PlaceHolderInfo::ph_width, PlaceHolderVar::phid, PlaceHolderInfo::phid, PlaceHolderVar::phlevelsup, PlaceHolderVar::phnullingrels, pull_varnos(), repalloc0_array, and root.

Referenced by add_vars_to_targetlist(), build_joinrel_tlist(), create_lateral_join_info(), find_placeholders_in_expr(), identify_current_nestloop_params(), process_subquery_nestloop_params(), replace_nestloop_params_mutator(), and set_rel_width().

◆ find_placeholders_in_expr()

static void find_placeholders_in_expr ( PlannerInfo root,
Node expr 
)
static

Definition at line 257 of file placeholder.c.

258 {
259  List *vars;
260  ListCell *vl;
261 
262  /*
263  * pull_var_clause does more than we need here, but it'll do and it's
264  * convenient to use.
265  */
266  vars = pull_var_clause(expr,
270  foreach(vl, vars)
271  {
272  PlaceHolderVar *phv = (PlaceHolderVar *) lfirst(vl);
273 
274  /* Ignore any plain Vars */
275  if (!IsA(phv, PlaceHolderVar))
276  continue;
277 
278  /* Create a PlaceHolderInfo entry if there's not one already */
279  (void) find_placeholder_info(root, phv);
280  }
281  list_free(vars);
282 }
void list_free(List *list)
Definition: list.c:1546
#define PVC_RECURSE_AGGREGATES
Definition: optimizer.h:187
#define PVC_RECURSE_WINDOWFUNCS
Definition: optimizer.h:189
#define PVC_INCLUDE_PLACEHOLDERS
Definition: optimizer.h:190
PlaceHolderInfo * find_placeholder_info(PlannerInfo *root, PlaceHolderVar *phv)
Definition: placeholder.c:83
Definition: pg_list.h:54
Definition: regcomp.c:281
List * pull_var_clause(Node *node, int flags)
Definition: var.c:607

References find_placeholder_info(), IsA, lfirst, list_free(), pull_var_clause(), PVC_INCLUDE_PLACEHOLDERS, PVC_RECURSE_AGGREGATES, PVC_RECURSE_WINDOWFUNCS, and root.

Referenced by find_placeholder_info(), and find_placeholders_recurse().

◆ find_placeholders_in_jointree()

void find_placeholders_in_jointree ( PlannerInfo root)

Definition at line 185 of file placeholder.c.

186 {
187  /* This must be done before freezing the set of PHIs */
188  Assert(!root->placeholdersFrozen);
189 
190  /* We need do nothing if the query contains no PlaceHolderVars */
191  if (root->glob->lastPHId != 0)
192  {
193  /* Start recursion at top of jointree */
194  Assert(root->parse->jointree != NULL &&
195  IsA(root->parse->jointree, FromExpr));
196  find_placeholders_recurse(root, (Node *) root->parse->jointree);
197  }
198 }
static void find_placeholders_recurse(PlannerInfo *root, Node *jtnode)
Definition: placeholder.c:207

References Assert, find_placeholders_recurse(), IsA, and root.

Referenced by query_planner().

◆ find_placeholders_recurse()

static void find_placeholders_recurse ( PlannerInfo root,
Node jtnode 
)
static

Definition at line 207 of file placeholder.c.

208 {
209  if (jtnode == NULL)
210  return;
211  if (IsA(jtnode, RangeTblRef))
212  {
213  /* No quals to deal with here */
214  }
215  else if (IsA(jtnode, FromExpr))
216  {
217  FromExpr *f = (FromExpr *) jtnode;
218  ListCell *l;
219 
220  /*
221  * First, recurse to handle child joins.
222  */
223  foreach(l, f->fromlist)
224  {
226  }
227 
228  /*
229  * Now process the top-level quals.
230  */
232  }
233  else if (IsA(jtnode, JoinExpr))
234  {
235  JoinExpr *j = (JoinExpr *) jtnode;
236 
237  /*
238  * First, recurse to handle child joins.
239  */
242 
243  /* Process the qual clauses */
245  }
246  else
247  elog(ERROR, "unrecognized node type: %d",
248  (int) nodeTag(jtnode));
249 }
int j
Definition: isn.c:74
#define nodeTag(nodeptr)
Definition: nodes.h:133
Node * quals
Definition: primnodes.h:2276
List * fromlist
Definition: primnodes.h:2275

References elog, ERROR, find_placeholders_in_expr(), FromExpr::fromlist, IsA, j, lfirst, nodeTag, FromExpr::quals, and root.

Referenced by find_placeholders_in_jointree().

◆ fix_placeholder_input_needed_levels()

void fix_placeholder_input_needed_levels ( PlannerInfo root)

Definition at line 300 of file placeholder.c.

301 {
302  ListCell *lc;
303 
304  foreach(lc, root->placeholder_list)
305  {
306  PlaceHolderInfo *phinfo = (PlaceHolderInfo *) lfirst(lc);
307  List *vars = pull_var_clause((Node *) phinfo->ph_var->phexpr,
311 
313  list_free(vars);
314  }
315 }
void add_vars_to_targetlist(PlannerInfo *root, List *vars, Relids where_needed)
Definition: initsplan.c:279

References add_vars_to_targetlist(), lfirst, list_free(), PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_var, pull_var_clause(), PVC_INCLUDE_PLACEHOLDERS, PVC_RECURSE_AGGREGATES, PVC_RECURSE_WINDOWFUNCS, and root.

Referenced by query_planner().

◆ make_placeholder_expr()

PlaceHolderVar* make_placeholder_expr ( PlannerInfo root,
Expr expr,
Relids  phrels 
)

Definition at line 54 of file placeholder.c.

55 {
57 
58  phv->phexpr = expr;
59  phv->phrels = phrels;
60  phv->phnullingrels = NULL; /* caller may change this later */
61  phv->phid = ++(root->glob->lastPHId);
62  phv->phlevelsup = 0; /* caller may change this later */
63 
64  return phv;
65 }

References makeNode, PlaceHolderVar::phid, PlaceHolderVar::phlevelsup, PlaceHolderVar::phnullingrels, and root.

Referenced by add_nullingrels_if_needed(), and pullup_replace_vars_callback().