PostgreSQL Source Code  git master
indxpath.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * indxpath.c
4  * Routines to determine which indexes are usable for scanning a
5  * given relation, and create Paths accordingly.
6  *
7  * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  *
11  * IDENTIFICATION
12  * src/backend/optimizer/path/indxpath.c
13  *
14  *-------------------------------------------------------------------------
15  */
16 #include "postgres.h"
17 
18 #include <math.h>
19 
20 #include "access/stratnum.h"
21 #include "access/sysattr.h"
22 #include "catalog/pg_am.h"
23 #include "catalog/pg_operator.h"
24 #include "catalog/pg_opfamily.h"
25 #include "catalog/pg_type.h"
26 #include "nodes/makefuncs.h"
27 #include "nodes/nodeFuncs.h"
28 #include "nodes/supportnodes.h"
29 #include "optimizer/cost.h"
30 #include "optimizer/optimizer.h"
31 #include "optimizer/pathnode.h"
32 #include "optimizer/paths.h"
33 #include "optimizer/prep.h"
34 #include "optimizer/restrictinfo.h"
35 #include "utils/lsyscache.h"
36 #include "utils/selfuncs.h"
37 
38 
39 /* XXX see PartCollMatchesExprColl */
40 #define IndexCollMatchesExprColl(idxcollation, exprcollation) \
41  ((idxcollation) == InvalidOid || (idxcollation) == (exprcollation))
42 
43 /* Whether we are looking for plain indexscan, bitmap scan, or either */
44 typedef enum
45 {
46  ST_INDEXSCAN, /* must support amgettuple */
47  ST_BITMAPSCAN, /* must support amgetbitmap */
48  ST_ANYSCAN /* either is okay */
49 } ScanTypeControl;
50 
51 /* Data structure for collecting qual clauses that match an index */
52 typedef struct
53 {
54  bool nonempty; /* True if lists are not all empty */
55  /* Lists of IndexClause nodes, one list per index column */
56  List *indexclauses[INDEX_MAX_KEYS];
57 } IndexClauseSet;
58 
59 /* Per-path data used within choose_bitmap_and() */
60 typedef struct
61 {
62  Path *path; /* IndexPath, BitmapAndPath, or BitmapOrPath */
63  List *quals; /* the WHERE clauses it uses */
64  List *preds; /* predicates of its partial index(es) */
65  Bitmapset *clauseids; /* quals+preds represented as a bitmapset */
66  bool unclassifiable; /* has too many quals+preds to process? */
67 } PathClauseUsage;
68 
69 /* Callback argument for ec_member_matches_indexcol */
70 typedef struct
71 {
72  IndexOptInfo *index; /* index we're considering */
73  int indexcol; /* index column we want to match to */
74 } ec_member_matches_arg;
75 
76 
77 static void consider_index_join_clauses(PlannerInfo *root, RelOptInfo *rel,
78  IndexOptInfo *index,
79  IndexClauseSet *rclauseset,
80  IndexClauseSet *jclauseset,
81  IndexClauseSet *eclauseset,
82  List **bitindexpaths);
83 static void consider_index_join_outer_rels(PlannerInfo *root, RelOptInfo *rel,
84  IndexOptInfo *index,
85  IndexClauseSet *rclauseset,
86  IndexClauseSet *jclauseset,
87  IndexClauseSet *eclauseset,
88  List **bitindexpaths,
89  List *indexjoinclauses,
90  int considered_clauses,
91  List **considered_relids);
92 static void get_join_index_paths(PlannerInfo *root, RelOptInfo *rel,
93  IndexOptInfo *index,
94  IndexClauseSet *rclauseset,
95  IndexClauseSet *jclauseset,
96  IndexClauseSet *eclauseset,
97  List **bitindexpaths,
98  Relids relids,
99  List **considered_relids);
100 static bool eclass_already_used(EquivalenceClass *parent_ec, Relids oldrelids,
101  List *indexjoinclauses);
102 static void get_index_paths(PlannerInfo *root, RelOptInfo *rel,
103  IndexOptInfo *index, IndexClauseSet *clauses,
104  List **bitindexpaths);
105 static List *build_index_paths(PlannerInfo *root, RelOptInfo *rel,
106  IndexOptInfo *index, IndexClauseSet *clauses,
107  bool useful_predicate,
108  ScanTypeControl scantype,
109  bool *skip_nonnative_saop,
110  bool *skip_lower_saop);
111 static List *build_paths_for_OR(PlannerInfo *root, RelOptInfo *rel,
112  List *clauses, List *other_clauses);
113 static List *generate_bitmap_or_paths(PlannerInfo *root, RelOptInfo *rel,
114  List *clauses, List *other_clauses);
115 static Path *choose_bitmap_and(PlannerInfo *root, RelOptInfo *rel,
116  List *paths);
117 static int path_usage_comparator(const void *a, const void *b);
118 static Cost bitmap_scan_cost_est(PlannerInfo *root, RelOptInfo *rel,
119  Path *ipath);
120 static Cost bitmap_and_cost_est(PlannerInfo *root, RelOptInfo *rel,
121  List *paths);
122 static PathClauseUsage *classify_index_clause_usage(Path *path,
123  List **clauselist);
124 static void find_indexpath_quals(Path *bitmapqual, List **quals, List **preds);
125 static int find_list_position(Node *node, List **nodelist);
126 static bool check_index_only(RelOptInfo *rel, IndexOptInfo *index);
127 static double get_loop_count(PlannerInfo *root, Index cur_relid, Relids outer_relids);
128 static double adjust_rowcount_for_semijoins(PlannerInfo *root,
129  Index cur_relid,
130  Index outer_relid,
131  double rowcount);
132 static double approximate_joinrel_size(PlannerInfo *root, Relids relids);
133 static void match_restriction_clauses_to_index(PlannerInfo *root,
134  IndexOptInfo *index,
135  IndexClauseSet *clauseset);
136 static void match_join_clauses_to_index(PlannerInfo *root,
137  RelOptInfo *rel, IndexOptInfo *index,
138  IndexClauseSet *clauseset,
139  List **joinorclauses);
140 static void match_eclass_clauses_to_index(PlannerInfo *root,
141  IndexOptInfo *index,
142  IndexClauseSet *clauseset);
143 static void match_clauses_to_index(PlannerInfo *root,
144  List *clauses,
145  IndexOptInfo *index,
146  IndexClauseSet *clauseset);
147 static void match_clause_to_index(PlannerInfo *root,
148  RestrictInfo *rinfo,
149  IndexOptInfo *index,
150  IndexClauseSet *clauseset);
151 static IndexClause *match_clause_to_indexcol(PlannerInfo *root,
152  RestrictInfo *rinfo,
153  int indexcol,
154  IndexOptInfo *index);
155 static bool IsBooleanOpfamily(Oid opfamily);
156 static IndexClause *match_boolean_index_clause(PlannerInfo *root,
157  RestrictInfo *rinfo,
158  int indexcol, IndexOptInfo *index);
159 static IndexClause *match_opclause_to_indexcol(PlannerInfo *root,
160  RestrictInfo *rinfo,
161  int indexcol,
162  IndexOptInfo *index);
163 static IndexClause *match_funcclause_to_indexcol(PlannerInfo *root,
164  RestrictInfo *rinfo,
165  int indexcol,
166  IndexOptInfo *index);
167 static IndexClause *get_index_clause_from_support(PlannerInfo *root,
168  RestrictInfo *rinfo,
169  Oid funcid,
170  int indexarg,
171  int indexcol,
172  IndexOptInfo *index);
173 static IndexClause *match_saopclause_to_indexcol(PlannerInfo *root,
174  RestrictInfo *rinfo,
175  int indexcol,
176  IndexOptInfo *index);
177 static IndexClause *match_rowcompare_to_indexcol(PlannerInfo *root,
178  RestrictInfo *rinfo,
179  int indexcol,
180  IndexOptInfo *index);
181 static IndexClause *expand_indexqual_rowcompare(PlannerInfo *root,
182  RestrictInfo *rinfo,
183  int indexcol,
184  IndexOptInfo *index,
185  Oid expr_op,
186  bool var_on_left);
187 static void match_pathkeys_to_index(IndexOptInfo *index, List *pathkeys,
188  List **orderby_clauses_p,
189  List **clause_columns_p);
190 static Expr *match_clause_to_ordering_op(IndexOptInfo *index,
191  int indexcol, Expr *clause, Oid pk_opfamily);
192 static bool ec_member_matches_indexcol(PlannerInfo *root, RelOptInfo *rel,
193  EquivalenceClass *ec, EquivalenceMember *em,
194  void *arg);
195 
196 
197 /*
198  * create_index_paths()
199  * Generate all interesting index paths for the given relation.
200  * Candidate paths are added to the rel's pathlist (using add_path).
201  *
202  * To be considered for an index scan, an index must match one or more
203  * restriction clauses or join clauses from the query's qual condition,
204  * or match the query's ORDER BY condition, or have a predicate that
205  * matches the query's qual condition.
206  *
207  * There are two basic kinds of index scans. A "plain" index scan uses
208  * only restriction clauses (possibly none at all) in its indexqual,
209  * so it can be applied in any context. A "parameterized" index scan uses
210  * join clauses (plus restriction clauses, if available) in its indexqual.
211  * When joining such a scan to one of the relations supplying the other
212  * variables used in its indexqual, the parameterized scan must appear as
213  * the inner relation of a nestloop join; it can't be used on the outer side,
214  * nor in a merge or hash join. In that context, values for the other rels'
215  * attributes are available and fixed during any one scan of the indexpath.
216  *
217  * An IndexPath is generated and submitted to add_path() for each plain or
218  * parameterized index scan this routine deems potentially interesting for
219  * the current query.
220  *
221  * 'rel' is the relation for which we want to generate index paths
222  *
223  * Note: check_index_predicates() must have been run previously for this rel.
224  *
225  * Note: in cases involving LATERAL references in the relation's tlist, it's
226  * possible that rel->lateral_relids is nonempty. Currently, we include
227  * lateral_relids into the parameterization reported for each path, but don't
228  * take it into account otherwise. The fact that any such rels *must* be
229  * available as parameter sources perhaps should influence our choices of
230  * index quals ... but for now, it doesn't seem worth troubling over.
231  * In particular, comments below about "unparameterized" paths should be read
232  * as meaning "unparameterized so far as the indexquals are concerned".
233  */
234 void
235 create_index_paths(PlannerInfo *root, RelOptInfo *rel)
236 {
237  List *indexpaths;
238  List *bitindexpaths;
239  List *bitjoinpaths;
240  List *joinorclauses;
241  IndexClauseSet rclauseset;
242  IndexClauseSet jclauseset;
243  IndexClauseSet eclauseset;
244  ListCell *lc;
245 
246  /* Skip the whole mess if no indexes */
247  if (rel->indexlist == NIL)
248  return;
249 
250  /* Bitmap paths are collected and then dealt with at the end */
251  bitindexpaths = bitjoinpaths = joinorclauses = NIL;
252 
253  /* Examine each index in turn */
254  foreach(lc, rel->indexlist)
255  {
256  IndexOptInfo *index = (IndexOptInfo *) lfirst(lc);
257 
258  /* Protect limited-size array in IndexClauseSets */
259  Assert(index->nkeycolumns <= INDEX_MAX_KEYS);
260 
261  /*
262  * Ignore partial indexes that do not match the query.
263  * (generate_bitmap_or_paths() might be able to do something with
264  * them, but that's of no concern here.)
265  */
266  if (index->indpred != NIL && !index->predOK)
267  continue;
268 
269  /*
270  * Identify the restriction clauses that can match the index.
271  */
272  MemSet(&rclauseset, 0, sizeof(rclauseset));
273  match_restriction_clauses_to_index(root, index, &rclauseset);
274 
275  /*
276  * Build index paths from the restriction clauses. These will be
277  * non-parameterized paths. Plain paths go directly to add_path(),
278  * bitmap paths are added to bitindexpaths to be handled below.
279  */
280  get_index_paths(root, rel, index, &rclauseset,
281  &bitindexpaths);
282 
283  /*
284  * Identify the join clauses that can match the index. For the moment
285  * we keep them separate from the restriction clauses. Note that this
286  * step finds only "loose" join clauses that have not been merged into
287  * EquivalenceClasses. Also, collect join OR clauses for later.
288  */
289  MemSet(&jclauseset, 0, sizeof(jclauseset));
290  match_join_clauses_to_index(root, rel, index,
291  &jclauseset, &joinorclauses);
292 
293  /*
294  * Look for EquivalenceClasses that can generate joinclauses matching
295  * the index.
296  */
297  MemSet(&eclauseset, 0, sizeof(eclauseset));
298  match_eclass_clauses_to_index(root, index,
299  &eclauseset);
300 
301  /*
302  * If we found any plain or eclass join clauses, build parameterized
303  * index paths using them.
304  */
305  if (jclauseset.nonempty || eclauseset.nonempty)
306  consider_index_join_clauses(root, rel, index,
307  &rclauseset,
308  &jclauseset,
309  &eclauseset,
310  &bitjoinpaths);
311  }
312 
313  /*
314  * Generate BitmapOrPaths for any suitable OR-clauses present in the
315  * restriction list. Add these to bitindexpaths.
316  */
317  indexpaths = generate_bitmap_or_paths(root, rel,
318  rel->baserestrictinfo, NIL);
319  bitindexpaths = list_concat(bitindexpaths, indexpaths);
320 
321  /*
322  * Likewise, generate BitmapOrPaths for any suitable OR-clauses present in
323  * the joinclause list. Add these to bitjoinpaths.
324  */
325  indexpaths = generate_bitmap_or_paths(root, rel,
326  joinorclauses, rel->baserestrictinfo);
327  bitjoinpaths = list_concat(bitjoinpaths, indexpaths);
328 
329  /*
330  * If we found anything usable, generate a BitmapHeapPath for the most
331  * promising combination of restriction bitmap index paths. Note there
332  * will be only one such path no matter how many indexes exist. This
333  * should be sufficient since there's basically only one figure of merit
334  * (total cost) for such a path.
335  */
336  if (bitindexpaths != NIL)
337  {
338  Path *bitmapqual;
339  BitmapHeapPath *bpath;
340 
341  bitmapqual = choose_bitmap_and(root, rel, bitindexpaths);
342  bpath = create_bitmap_heap_path(root, rel, bitmapqual,
343  rel->lateral_relids, 1.0, 0);
344  add_path(rel, (Path *) bpath);
345 
346  /* create a partial bitmap heap path */
347  if (rel->consider_parallel && rel->lateral_relids == NULL)
348  create_partial_bitmap_paths(root, rel, bitmapqual);
349  }
350 
351  /*
352  * Likewise, if we found anything usable, generate BitmapHeapPaths for the
353  * most promising combinations of join bitmap index paths. Our strategy
354  * is to generate one such path for each distinct parameterization seen
355  * among the available bitmap index paths. This may look pretty
356  * expensive, but usually there won't be very many distinct
357  * parameterizations. (This logic is quite similar to that in
358  * consider_index_join_clauses, but we're working with whole paths not
359  * individual clauses.)
360  */
361  if (bitjoinpaths != NIL)
362  {
363  List *all_path_outers;
364 
365  /* Identify each distinct parameterization seen in bitjoinpaths */
366  all_path_outers = NIL;
367  foreach(lc, bitjoinpaths)
368  {
369  Path *path = (Path *) lfirst(lc);
370  Relids required_outer = PATH_REQ_OUTER(path);
371 
372  all_path_outers = list_append_unique(all_path_outers,
373  required_outer);
374  }
375 
376  /* Now, for each distinct parameterization set ... */
377  foreach(lc, all_path_outers)
378  {
379  Relids max_outers = (Relids) lfirst(lc);
380  List *this_path_set;
381  Path *bitmapqual;
382  Relids required_outer;
383  double loop_count;
384  BitmapHeapPath *bpath;
385  ListCell *lcp;
386 
387  /* Identify all the bitmap join paths needing no more than that */
388  this_path_set = NIL;
389  foreach(lcp, bitjoinpaths)
390  {
391  Path *path = (Path *) lfirst(lcp);
392 
393  if (bms_is_subset(PATH_REQ_OUTER(path), max_outers))
394  this_path_set = lappend(this_path_set, path);
395  }
396 
397  /*
398  * Add in restriction bitmap paths, since they can be used
399  * together with any join paths.
400  */
401  this_path_set = list_concat(this_path_set, bitindexpaths);
402 
403  /* Select best AND combination for this parameterization */
404  bitmapqual = choose_bitmap_and(root, rel, this_path_set);
405 
406  /* And push that path into the mix */
407  required_outer = PATH_REQ_OUTER(bitmapqual);
408  loop_count = get_loop_count(root, rel->relid, required_outer);
409  bpath = create_bitmap_heap_path(root, rel, bitmapqual,
410  required_outer, loop_count, 0);
411  add_path(rel, (Path *) bpath);
412  }
413  }
414 }
415 
416 /*
417  * consider_index_join_clauses
418  * Given sets of join clauses for an index, decide which parameterized
419  * index paths to build.
420  *
421  * Plain indexpaths are sent directly to add_path, while potential
422  * bitmap indexpaths are added to *bitindexpaths for later processing.
423  *
424  * 'rel' is the index's heap relation
425  * 'index' is the index for which we want to generate paths
426  * 'rclauseset' is the collection of indexable restriction clauses
427  * 'jclauseset' is the collection of indexable simple join clauses
428  * 'eclauseset' is the collection of indexable clauses from EquivalenceClasses
429  * '*bitindexpaths' is the list to add bitmap paths to
430  */
431 static void
432 consider_index_join_clauses(PlannerInfo *root, RelOptInfo *rel,
433  IndexOptInfo *index,
434  IndexClauseSet *rclauseset,
435  IndexClauseSet *jclauseset,
436  IndexClauseSet *eclauseset,
437  List **bitindexpaths)
438 {
439  int considered_clauses = 0;
440  List *considered_relids = NIL;
441  int indexcol;
442 
443  /*
444  * The strategy here is to identify every potentially useful set of outer
445  * rels that can provide indexable join clauses. For each such set,
446  * select all the join clauses available from those outer rels, add on all
447  * the indexable restriction clauses, and generate plain and/or bitmap
448  * index paths for that set of clauses. This is based on the assumption
449  * that it's always better to apply a clause as an indexqual than as a
450  * filter (qpqual); which is where an available clause would end up being
451  * applied if we omit it from the indexquals.
452  *
453  * This looks expensive, but in most practical cases there won't be very
454  * many distinct sets of outer rels to consider. As a safety valve when
455  * that's not true, we use a heuristic: limit the number of outer rel sets
456  * considered to a multiple of the number of clauses considered. (We'll
457  * always consider using each individual join clause, though.)
458  *
459  * For simplicity in selecting relevant clauses, we represent each set of
460  * outer rels as a maximum set of clause_relids --- that is, the indexed
461  * relation itself is also included in the relids set. considered_relids
462  * lists all relids sets we've already tried.
463  */
464  for (indexcol = 0; indexcol < index->nkeycolumns; indexcol++)
465  {
466  /* Consider each applicable simple join clause */
467  considered_clauses += list_length(jclauseset->indexclauses[indexcol]);
468  consider_index_join_outer_rels(root, rel, index,
469  rclauseset, jclauseset, eclauseset,
470  bitindexpaths,
471  jclauseset->indexclauses[indexcol],
472  considered_clauses,
473  &considered_relids);
474  /* Consider each applicable eclass join clause */
475  considered_clauses += list_length(eclauseset->indexclauses[indexcol]);
476  consider_index_join_outer_rels(root, rel, index,
477  rclauseset, jclauseset, eclauseset,
478  bitindexpaths,
479  eclauseset->indexclauses[indexcol],
480  considered_clauses,
481  &considered_relids);
482  }
483 }
484 
485 /*
486  * consider_index_join_outer_rels
487  * Generate parameterized paths based on clause relids in the clause list.
488  *
489  * Workhorse for consider_index_join_clauses; see notes therein for rationale.
490  *
491  * 'rel', 'index', 'rclauseset', 'jclauseset', 'eclauseset', and
492  * 'bitindexpaths' as above
493  * 'indexjoinclauses' is a list of IndexClauses for join clauses
494  * 'considered_clauses' is the total number of clauses considered (so far)
495  * '*considered_relids' is a list of all relids sets already considered
496  */
497 static void
498 consider_index_join_outer_rels(PlannerInfo *root, RelOptInfo *rel,
499  IndexOptInfo *index,
500  IndexClauseSet *rclauseset,
501  IndexClauseSet *jclauseset,
502  IndexClauseSet *eclauseset,
503  List **bitindexpaths,
504  List *indexjoinclauses,
505  int considered_clauses,
506  List **considered_relids)
507 {
508  ListCell *lc;
509 
510  /* Examine relids of each joinclause in the given list */
511  foreach(lc, indexjoinclauses)
512  {
513  IndexClause *iclause = (IndexClause *) lfirst(lc);
514  Relids clause_relids = iclause->rinfo->clause_relids;
515  EquivalenceClass *parent_ec = iclause->rinfo->parent_ec;
516  int num_considered_relids;
517 
518  /* If we already tried its relids set, no need to do so again */
519  if (list_member(*considered_relids, clause_relids))
520  continue;
521 
522  /*
523  * Generate the union of this clause's relids set with each
524  * previously-tried set. This ensures we try this clause along with
525  * every interesting subset of previous clauses. However, to avoid
526  * exponential growth of planning time when there are many clauses,
527  * limit the number of relid sets accepted to 10 * considered_clauses.
528  *
529  * Note: get_join_index_paths appends entries to *considered_relids,
530  * but we do not need to visit such newly-added entries within this
531  * loop, so we don't use foreach() here. No real harm would be done
532  * if we did visit them, since the subset check would reject them; but
533  * it would waste some cycles.
534  */
535  num_considered_relids = list_length(*considered_relids);
536  for (int pos = 0; pos < num_considered_relids; pos++)
537  {
538  Relids oldrelids = (Relids) list_nth(*considered_relids, pos);
539 
540  /*
541  * If either is a subset of the other, no new set is possible.
542  * This isn't a complete test for redundancy, but it's easy and
543  * cheap. get_join_index_paths will check more carefully if we
544  * already generated the same relids set.
545  */
546  if (bms_subset_compare(clause_relids, oldrelids) != BMS_DIFFERENT)
547  continue;
548 
549  /*
550  * If this clause was derived from an equivalence class, the
551  * clause list may contain other clauses derived from the same
552  * eclass. We should not consider that combining this clause with
553  * one of those clauses generates a usefully different
554  * parameterization; so skip if any clause derived from the same
555  * eclass would already have been included when using oldrelids.
556  */
557  if (parent_ec &&
558  eclass_already_used(parent_ec, oldrelids,
559  indexjoinclauses))
560  continue;
561 
562  /*
563  * If the number of relid sets considered exceeds our heuristic
564  * limit, stop considering combinations of clauses. We'll still
565  * consider the current clause alone, though (below this loop).
566  */
567  if (list_length(*considered_relids) >= 10 * considered_clauses)
568  break;
569 
570  /* OK, try the union set */
571  get_join_index_paths(root, rel, index,
572  rclauseset, jclauseset, eclauseset,
573  bitindexpaths,
574  bms_union(clause_relids, oldrelids),
575  considered_relids);
576  }
577 
578  /* Also try this set of relids by itself */
579  get_join_index_paths(root, rel, index,
580  rclauseset, jclauseset, eclauseset,
581  bitindexpaths,
582  clause_relids,
583  considered_relids);
584  }
585 }
586 
587 /*
588  * get_join_index_paths
589  * Generate index paths using clauses from the specified outer relations.
590  * In addition to generating paths, relids is added to *considered_relids
591  * if not already present.
592  *
593  * Workhorse for consider_index_join_clauses; see notes therein for rationale.
594  *
595  * 'rel', 'index', 'rclauseset', 'jclauseset', 'eclauseset',
596  * 'bitindexpaths', 'considered_relids' as above
597  * 'relids' is the current set of relids to consider (the target rel plus
598  * one or more outer rels)
599  */
600 static void
601 get_join_index_paths(PlannerInfo *root, RelOptInfo *rel,
602  IndexOptInfo *index,
603  IndexClauseSet *rclauseset,
604  IndexClauseSet *jclauseset,
605  IndexClauseSet *eclauseset,
606  List **bitindexpaths,
607  Relids relids,
608  List **considered_relids)
609 {
610  IndexClauseSet clauseset;
611  int indexcol;
612 
613  /* If we already considered this relids set, don't repeat the work */
614  if (list_member(*considered_relids, relids))
615  return;
616 
617  /* Identify indexclauses usable with this relids set */
618  MemSet(&clauseset, 0, sizeof(clauseset));
619 
620  for (indexcol = 0; indexcol < index->nkeycolumns; indexcol++)
621  {
622  ListCell *lc;
623 
624  /* First find applicable simple join clauses */
625  foreach(lc, jclauseset->indexclauses[indexcol])
626  {
627  IndexClause *iclause = (IndexClause *) lfirst(lc);
628 
629  if (bms_is_subset(iclause->rinfo->clause_relids, relids))
630  clauseset.indexclauses[indexcol] =
631  lappend(clauseset.indexclauses[indexcol], iclause);
632  }
633 
634  /*
635  * Add applicable eclass join clauses. The clauses generated for each
636  * column are redundant (cf generate_implied_equalities_for_column),
637  * so we need at most one. This is the only exception to the general
638  * rule of using all available index clauses.
639  */
640  foreach(lc, eclauseset->indexclauses[indexcol])
641  {
642  IndexClause *iclause = (IndexClause *) lfirst(lc);
643 
644  if (bms_is_subset(iclause->rinfo->clause_relids, relids))
645  {
646  clauseset.indexclauses[indexcol] =
647  lappend(clauseset.indexclauses[indexcol], iclause);
648  break;
649  }
650  }
651 
652  /* Add restriction clauses */
653  clauseset.indexclauses[indexcol] =
654  list_concat(clauseset.indexclauses[indexcol],
655  rclauseset->indexclauses[indexcol]);
656 
657  if (clauseset.indexclauses[indexcol] != NIL)
658  clauseset.nonempty = true;
659  }
660 
661  /* We should have found something, else caller passed silly relids */
662  Assert(clauseset.nonempty);
663 
664  /* Build index path(s) using the collected set of clauses */
665  get_index_paths(root, rel, index, &clauseset, bitindexpaths);
666 
667  /*
668  * Remember we considered paths for this set of relids.
669  */
670  *considered_relids = lappend(*considered_relids, relids);
671 }
672 
673 /*
674  * eclass_already_used
675  * True if any join clause usable with oldrelids was generated from
676  * the specified equivalence class.
677  */
678 static bool
679 eclass_already_used(EquivalenceClass *parent_ec, Relids oldrelids,
680  List *indexjoinclauses)
681 {
682  ListCell *lc;
683 
684  foreach(lc, indexjoinclauses)
685  {
686  IndexClause *iclause = (IndexClause *) lfirst(lc);
687  RestrictInfo *rinfo = iclause->rinfo;
688 
689  if (rinfo->parent_ec == parent_ec &&
690  bms_is_subset(rinfo->clause_relids, oldrelids))
691  return true;
692  }
693  return false;
694 }
695 
696 
697 /*
698  * get_index_paths
699  * Given an index and a set of index clauses for it, construct IndexPaths.
700  *
701  * Plain indexpaths are sent directly to add_path, while potential
702  * bitmap indexpaths are added to *bitindexpaths for later processing.
703  *
704  * This is a fairly simple frontend to build_index_paths(). Its reason for
705  * existence is mainly to handle ScalarArrayOpExpr quals properly. If the
706  * index AM supports them natively, we should just include them in simple
707  * index paths. If not, we should exclude them while building simple index
708  * paths, and then make a separate attempt to include them in bitmap paths.
709  * Furthermore, we should consider excluding lower-order ScalarArrayOpExpr
710  * quals so as to create ordered paths.
711  */
712 static void
713 get_index_paths(PlannerInfo *root, RelOptInfo *rel,
714  IndexOptInfo *index, IndexClauseSet *clauses,
715  List **bitindexpaths)
716 {
717  List *indexpaths;
718  bool skip_nonnative_saop = false;
719  bool skip_lower_saop = false;
720  ListCell *lc;
721 
722  /*
723  * Build simple index paths using the clauses. Allow ScalarArrayOpExpr
724  * clauses only if the index AM supports them natively, and skip any such
725  * clauses for index columns after the first (so that we produce ordered
726  * paths if possible).
727  */
728  indexpaths = build_index_paths(root, rel,
729  index, clauses,
730  index->predOK,
731  ST_ANYSCAN,
732  &skip_nonnative_saop,
733  &skip_lower_saop);
734 
735  /*
736  * If we skipped any lower-order ScalarArrayOpExprs on an index with an AM
737  * that supports them, then try again including those clauses. This will
738  * produce paths with more selectivity but no ordering.
739  */
740  if (skip_lower_saop)
741  {
742  indexpaths = list_concat(indexpaths,
743  build_index_paths(root, rel,
744  index, clauses,
745  index->predOK,
746  ST_ANYSCAN,
747  &skip_nonnative_saop,
748  NULL));
749  }
750 
751  /*
752  * Submit all the ones that can form plain IndexScan plans to add_path. (A
753  * plain IndexPath can represent either a plain IndexScan or an
754  * IndexOnlyScan, but for our purposes here that distinction does not
755  * matter. However, some of the indexes might support only bitmap scans,
756  * and those we mustn't submit to add_path here.)
757  *
758  * Also, pick out the ones that are usable as bitmap scans. For that, we
759  * must discard indexes that don't support bitmap scans, and we also are
760  * only interested in paths that have some selectivity; we should discard
761  * anything that was generated solely for ordering purposes.
762  */
763  foreach(lc, indexpaths)
764  {
765  IndexPath *ipath = (IndexPath *) lfirst(lc);
766 
767  if (index->amhasgettuple)
768  add_path(rel, (Path *) ipath);
769 
770  if (index->amhasgetbitmap &&
771  (ipath->path.pathkeys == NIL ||
772  ipath->indexselectivity < 1.0))
773  *bitindexpaths = lappend(*bitindexpaths, ipath);
774  }
775 
776  /*
777  * If there were ScalarArrayOpExpr clauses that the index can't handle
778  * natively, generate bitmap scan paths relying on executor-managed
779  * ScalarArrayOpExpr.
780  */
781  if (skip_nonnative_saop)
782  {
783  indexpaths = build_index_paths(root, rel,
784  index, clauses,
785  false,
786  ST_BITMAPSCAN,
787  NULL,
788  NULL);
789  *bitindexpaths = list_concat(*bitindexpaths, indexpaths);
790  }
791 }
792 
793 /*
794  * build_index_paths
795  * Given an index and a set of index clauses for it, construct zero
796  * or more IndexPaths. It also constructs zero or more partial IndexPaths.
797  *
798  * We return a list of paths because (1) this routine checks some cases
799  * that should cause us to not generate any IndexPath, and (2) in some
800  * cases we want to consider both a forward and a backward scan, so as
801  * to obtain both sort orders. Note that the paths are just returned
802  * to the caller and not immediately fed to add_path().
803  *
804  * At top level, useful_predicate should be exactly the index's predOK flag
805  * (ie, true if it has a predicate that was proven from the restriction
806  * clauses). When working on an arm of an OR clause, useful_predicate
807  * should be true if the predicate required the current OR list to be proven.
808  * Note that this routine should never be called at all if the index has an
809  * unprovable predicate.
810  *
811  * scantype indicates whether we want to create plain indexscans, bitmap
812  * indexscans, or both. When it's ST_BITMAPSCAN, we will not consider
813  * index ordering while deciding if a Path is worth generating.
814  *
815  * If skip_nonnative_saop is non-NULL, we ignore ScalarArrayOpExpr clauses
816  * unless the index AM supports them directly, and we set *skip_nonnative_saop
817  * to true if we found any such clauses (caller must initialize the variable
818  * to false). If it's NULL, we do not ignore ScalarArrayOpExpr clauses.
819  *
820  * If skip_lower_saop is non-NULL, we ignore ScalarArrayOpExpr clauses for
821  * non-first index columns, and we set *skip_lower_saop to true if we found
822  * any such clauses (caller must initialize the variable to false). If it's
823  * NULL, we do not ignore non-first ScalarArrayOpExpr clauses, but they will
824  * result in considering the scan's output to be unordered.
825  *
826  * 'rel' is the index's heap relation
827  * 'index' is the index for which we want to generate paths
828  * 'clauses' is the collection of indexable clauses (IndexClause nodes)
829  * 'useful_predicate' indicates whether the index has a useful predicate
830  * 'scantype' indicates whether we need plain or bitmap scan support
831  * 'skip_nonnative_saop' indicates whether to accept SAOP if index AM doesn't
832  * 'skip_lower_saop' indicates whether to accept non-first-column SAOP
833  */
834 static List *
835 build_index_paths(PlannerInfo *root, RelOptInfo *rel,
836  IndexOptInfo *index, IndexClauseSet *clauses,
837  bool useful_predicate,
838  ScanTypeControl scantype,
839  bool *skip_nonnative_saop,
840  bool *skip_lower_saop)
841 {
842  List *result = NIL;
843  IndexPath *ipath;
844  List *index_clauses;
845  Relids outer_relids;
846  double loop_count;
847  List *orderbyclauses;
848  List *orderbyclausecols;
849  List *index_pathkeys;
850  List *useful_pathkeys;
851  bool found_lower_saop_clause;
852  bool pathkeys_possibly_useful;
853  bool index_is_ordered;
854  bool index_only_scan;
855  int indexcol;
856 
857  /*
858  * Check that index supports the desired scan type(s)
859  */
860  switch (scantype)
861  {
862  case ST_INDEXSCAN:
863  if (!index->amhasgettuple)
864  return NIL;
865  break;
866  case ST_BITMAPSCAN:
867  if (!index->amhasgetbitmap)
868  return NIL;
869  break;
870  case ST_ANYSCAN:
871  /* either or both are OK */
872  break;
873  }
874 
875  /*
876  * 1. Combine the per-column IndexClause lists into an overall list.
877  *
878  * In the resulting list, clauses are ordered by index key, so that the
879  * column numbers form a nondecreasing sequence. (This order is depended
880  * on by btree and possibly other places.) The list can be empty, if the
881  * index AM allows that.
882  *
883  * found_lower_saop_clause is set true if we accept a ScalarArrayOpExpr
884  * index clause for a non-first index column. This prevents us from
885  * assuming that the scan result is ordered. (Actually, the result is
886  * still ordered if there are equality constraints for all earlier
887  * columns, but it seems too expensive and non-modular for this code to be
888  * aware of that refinement.)
889  *
890  * We also build a Relids set showing which outer rels are required by the
891  * selected clauses. Any lateral_relids are included in that, but not
892  * otherwise accounted for.
893  */
894  index_clauses = NIL;
895  found_lower_saop_clause = false;
896  outer_relids = bms_copy(rel->lateral_relids);
897  for (indexcol = 0; indexcol < index->nkeycolumns; indexcol++)
898  {
899  ListCell *lc;
900 
901  foreach(lc, clauses->indexclauses[indexcol])
902  {
903  IndexClause *iclause = (IndexClause *) lfirst(lc);
904  RestrictInfo *rinfo = iclause->rinfo;
905 
906  /* We might need to omit ScalarArrayOpExpr clauses */
907  if (IsA(rinfo->clause, ScalarArrayOpExpr))
908  {
909  if (!index->amsearcharray)
910  {
911  if (skip_nonnative_saop)
912  {
913  /* Ignore because not supported by index */
914  *skip_nonnative_saop = true;
915  continue;
916  }
917  /* Caller had better intend this only for bitmap scan */
918  Assert(scantype == ST_BITMAPSCAN);
919  }
920  if (indexcol > 0)
921  {
922  if (skip_lower_saop)
923  {
924  /* Caller doesn't want to lose index ordering */
925  *skip_lower_saop = true;
926  continue;
927  }
928  found_lower_saop_clause = true;
929  }
930  }
931 
932  /* OK to include this clause */
933  index_clauses = lappend(index_clauses, iclause);
934  outer_relids = bms_add_members(outer_relids,
935  rinfo->clause_relids);
936  }
937 
938  /*
939  * If no clauses match the first index column, check for amoptionalkey
940  * restriction. We can't generate a scan over an index with
941  * amoptionalkey = false unless there's at least one index clause.
942  * (When working on columns after the first, this test cannot fail. It
943  * is always okay for columns after the first to not have any
944  * clauses.)
945  */
946  if (index_clauses == NIL && !index->amoptionalkey)
947  return NIL;
948  }
949 
950  /* We do not want the index's rel itself listed in outer_relids */
951  outer_relids = bms_del_member(outer_relids, rel->relid);
952  /* Enforce convention that outer_relids is exactly NULL if empty */
953  if (bms_is_empty(outer_relids))
954  outer_relids = NULL;
955 
956  /* Compute loop_count for cost estimation purposes */
957  loop_count = get_loop_count(root, rel->relid, outer_relids);
958 
959  /*
960  * 2. Compute pathkeys describing index's ordering, if any, then see how
961  * many of them are actually useful for this query. This is not relevant
962  * if we are only trying to build bitmap indexscans, nor if we have to
963  * assume the scan is unordered.
964  */
965  pathkeys_possibly_useful = (scantype != ST_BITMAPSCAN &&
966  !found_lower_saop_clause &&
967  has_useful_pathkeys(root, rel));
968  index_is_ordered = (index->sortopfamily != NULL);
969  if (index_is_ordered && pathkeys_possibly_useful)
970  {
971  index_pathkeys = build_index_pathkeys(root, index,
972  ForwardScanDirection);
973  useful_pathkeys = truncate_useless_pathkeys(root, rel,
974  index_pathkeys);
975  orderbyclauses = NIL;
976  orderbyclausecols = NIL;
977  }
978  else if (index->amcanorderbyop && pathkeys_possibly_useful)
979  {
980  /* see if we can generate ordering operators for query_pathkeys */
981  match_pathkeys_to_index(index, root->query_pathkeys,
982  &orderbyclauses,
983  &orderbyclausecols);
984  if (orderbyclauses)
985  useful_pathkeys = root->query_pathkeys;
986  else
987  useful_pathkeys = NIL;
988  }
989  else
990  {
991  useful_pathkeys = NIL;
992  orderbyclauses = NIL;
993  orderbyclausecols = NIL;
994  }
995 
996  /*
997  * 3. Check if an index-only scan is possible. If we're not building
998  * plain indexscans, this isn't relevant since bitmap scans don't support
999  * index data retrieval anyway.
1000  */
1001  index_only_scan = (scantype != ST_BITMAPSCAN &&
1002  check_index_only(rel, index));
1003 
1004  /*
1005  * 4. Generate an indexscan path if there are relevant restriction clauses
1006  * in the current clauses, OR the index ordering is potentially useful for
1007  * later merging or final output ordering, OR the index has a useful
1008  * predicate, OR an index-only scan is possible.
1009  */
1010  if (index_clauses != NIL || useful_pathkeys != NIL || useful_predicate ||
1011  index_only_scan)
1012  {
1013  ipath = create_index_path(root, index,
1014  index_clauses,
1015  orderbyclauses,
1016  orderbyclausecols,
1017  useful_pathkeys,
1018  index_is_ordered ?
1019  ForwardScanDirection :
1020  NoMovementScanDirection,
1021  index_only_scan,
1022  outer_relids,
1023  loop_count,
1024  false);
1025  result = lappend(result, ipath);
1026 
1027  /*
1028  * If appropriate, consider parallel index scan. We don't allow
1029  * parallel index scan for bitmap index scans.
1030  */
1031  if (index->amcanparallel &&
1032  rel->consider_parallel && outer_relids == NULL &&
1033  scantype != ST_BITMAPSCAN)
1034  {
1035  ipath = create_index_path(root, index,
1036  index_clauses,
1037  orderbyclauses,
1038  orderbyclausecols,
1039  useful_pathkeys,
1040  index_is_ordered ?
1041  ForwardScanDirection :
1042  NoMovementScanDirection,
1043  index_only_scan,
1044  outer_relids,
1045  loop_count,
1046  true);
1047 
1048  /*
1049  * if, after costing the path, we find that it's not worth using
1050  * parallel workers, just free it.
1051  */
1052  if (ipath->path.parallel_workers > 0)
1053  add_partial_path(rel, (Path *) ipath);
1054  else
1055  pfree(ipath);
1056  }
1057  }
1058 
1059  /*
1060  * 5. If the index is ordered, a backwards scan might be interesting.
1061  */
1062  if (index_is_ordered && pathkeys_possibly_useful)
1063  {
1064  index_pathkeys = build_index_pathkeys(root, index,
1065  BackwardScanDirection);
1066  useful_pathkeys = truncate_useless_pathkeys(root, rel,
1067  index_pathkeys);
1068  if (useful_pathkeys != NIL)
1069  {
1070  ipath = create_index_path(root, index,
1071  index_clauses,
1072  NIL,
1073  NIL,
1074  useful_pathkeys,
1075  BackwardScanDirection,
1076  index_only_scan,
1077  outer_relids,
1078  loop_count,
1079  false);
1080  result = lappend(result, ipath);
1081 
1082  /* If appropriate, consider parallel index scan */
1083  if (index->amcanparallel &&
1084  rel->consider_parallel && outer_relids == NULL &&
1085  scantype != ST_BITMAPSCAN)
1086  {
1087  ipath = create_index_path(root, index,
1088  index_clauses,
1089  NIL,
1090  NIL,
1091  useful_pathkeys,
1092  BackwardScanDirection,
1093  index_only_scan,
1094  outer_relids,
1095  loop_count,
1096  true);
1097 
1098  /*
1099  * if, after costing the path, we find that it's not worth
1100  * using parallel workers, just free it.
1101  */
1102  if (ipath->path.parallel_workers > 0)
1103  add_partial_path(rel, (Path *) ipath);
1104  else
1105  pfree(ipath);
1106  }
1107  }
1108  }
1109 
1110  return result;
1111 }
1112 
1113 /*
1114  * build_paths_for_OR
1115  * Given a list of restriction clauses from one arm of an OR clause,
1116  * construct all matching IndexPaths for the relation.
1117  *
1118  * Here we must scan all indexes of the relation, since a bitmap OR tree
1119  * can use multiple indexes.
1120  *
1121  * The caller actually supplies two lists of restriction clauses: some
1122  * "current" ones and some "other" ones. Both lists can be used freely
1123  * to match keys of the index, but an index must use at least one of the
1124  * "current" clauses to be considered usable. The motivation for this is
1125  * examples like
1126  * WHERE (x = 42) AND (... OR (y = 52 AND z = 77) OR ....)
1127  * While we are considering the y/z subclause of the OR, we can use "x = 42"
1128  * as one of the available index conditions; but we shouldn't match the
1129  * subclause to any index on x alone, because such a Path would already have
1130  * been generated at the upper level. So we could use an index on x,y,z
1131  * or an index on x,y for the OR subclause, but not an index on just x.
1132  * When dealing with a partial index, a match of the index predicate to
1133  * one of the "current" clauses also makes the index usable.
1134  *
1135  * 'rel' is the relation for which we want to generate index paths
1136  * 'clauses' is the current list of clauses (RestrictInfo nodes)
1137  * 'other_clauses' is the list of additional upper-level clauses
1138  */
1139 static List *
1140 build_paths_for_OR(PlannerInfo *root, RelOptInfo *rel,
1141  List *clauses, List *other_clauses)
1142 {
1143  List *result = NIL;
1144  List *all_clauses = NIL; /* not computed till needed */
1145  ListCell *lc;
1146 
1147  foreach(lc, rel->indexlist)
1148  {
1149  IndexOptInfo *index = (IndexOptInfo *) lfirst(lc);
1150  IndexClauseSet clauseset;
1151  List *indexpaths;
1152  bool useful_predicate;
1153 
1154  /* Ignore index if it doesn't support bitmap scans */
1155  if (!index->amhasgetbitmap)
1156  continue;
1157 
1158  /*
1159  * Ignore partial indexes that do not match the query. If a partial
1160  * index is marked predOK then we know it's OK. Otherwise, we have to
1161  * test whether the added clauses are sufficient to imply the
1162  * predicate. If so, we can use the index in the current context.
1163  *
1164  * We set useful_predicate to true iff the predicate was proven using
1165  * the current set of clauses. This is needed to prevent matching a
1166  * predOK index to an arm of an OR, which would be a legal but
1167  * pointlessly inefficient plan. (A better plan will be generated by
1168  * just scanning the predOK index alone, no OR.)
1169  */
1170  useful_predicate = false;
1171  if (index->indpred != NIL)
1172  {
1173  if (index->predOK)
1174  {
1175  /* Usable, but don't set useful_predicate */
1176  }
1177  else
1178  {
1179  /* Form all_clauses if not done already */
1180  if (all_clauses == NIL)
1181  all_clauses = list_concat_copy(clauses, other_clauses);
1182 
1183  if (!predicate_implied_by(index->indpred, all_clauses, false))
1184  continue; /* can't use it at all */
1185 
1186  if (!predicate_implied_by(index->indpred, other_clauses, false))
1187  useful_predicate = true;
1188  }
1189  }
1190 
1191  /*
1192  * Identify the restriction clauses that can match the index.
1193  */
1194  MemSet(&clauseset, 0, sizeof(clauseset));
1195  match_clauses_to_index(root, clauses, index, &clauseset);
1196 
1197  /*
1198  * If no matches so far, and the index predicate isn't useful, we
1199  * don't want it.
1200  */
1201  if (!clauseset.nonempty && !useful_predicate)
1202  continue;
1203 
1204  /*
1205  * Add "other" restriction clauses to the clauseset.
1206  */
1207  match_clauses_to_index(root, other_clauses, index, &clauseset);
1208 
1209  /*
1210  * Construct paths if possible.
1211  */
1212  indexpaths = build_index_paths(root, rel,
1213  index, &clauseset,
1214  useful_predicate,
1215  ST_BITMAPSCAN,
1216  NULL,
1217  NULL);
1218  result = list_concat(result, indexpaths);
1219  }
1220 
1221  return result;
1222 }
1223 
1224 /*
1225  * generate_bitmap_or_paths
1226  * Look through the list of clauses to find OR clauses, and generate
1227  * a BitmapOrPath for each one we can handle that way. Return a list
1228  * of the generated BitmapOrPaths.
1229  *
1230  * other_clauses is a list of additional clauses that can be assumed true
1231  * for the purpose of generating indexquals, but are not to be searched for
1232  * ORs. (See build_paths_for_OR() for motivation.)
1233  */
1234 static List *
1235 generate_bitmap_or_paths(PlannerInfo *root, RelOptInfo *rel,
1236  List *clauses, List *other_clauses)
1237 {
1238  List *result = NIL;
1239  List *all_clauses;
1240  ListCell *lc;
1241 
1242  /*
1243  * We can use both the current and other clauses as context for
1244  * build_paths_for_OR; no need to remove ORs from the lists.
1245  */
1246  all_clauses = list_concat_copy(clauses, other_clauses);
1247 
1248  foreach(lc, clauses)
1249  {
1250  RestrictInfo *rinfo = lfirst_node(RestrictInfo, lc);
1251  List *pathlist;
1252  Path *bitmapqual;
1253  ListCell *j;
1254 
1255  /* Ignore RestrictInfos that aren't ORs */
1256  if (!restriction_is_or_clause(rinfo))
1257  continue;
1258 
1259  /*
1260  * We must be able to match at least one index to each of the arms of
1261  * the OR, else we can't use it.
1262  */
1263  pathlist = NIL;
1264  foreach(j, ((BoolExpr *) rinfo->orclause)->args)
1265  {
1266  Node *orarg = (Node *) lfirst(j);
1267  List *indlist;
1268 
1269  /* OR arguments should be ANDs or sub-RestrictInfos */
1270  if (is_andclause(orarg))
1271  {
1272  List *andargs = ((BoolExpr *) orarg)->args;
1273 
1274  indlist = build_paths_for_OR(root, rel,
1275  andargs,
1276  all_clauses);
1277 
1278  /* Recurse in case there are sub-ORs */
1279  indlist = list_concat(indlist,
1280  generate_bitmap_or_paths(root, rel,
1281  andargs,
1282  all_clauses));
1283  }
1284  else
1285  {
1286  RestrictInfo *ri = castNode(RestrictInfo, orarg);
1287  List *orargs;
1288 
1289  Assert(!restriction_is_or_clause(ri));
1290  orargs = list_make1(ri);
1291 
1292  indlist = build_paths_for_OR(root, rel,
1293  orargs,
1294  all_clauses);
1295  }
1296 
1297  /*
1298  * If nothing matched this arm, we can't do anything with this OR
1299  * clause.
1300  */
1301  if (indlist == NIL)
1302  {
1303  pathlist = NIL;
1304  break;
1305  }
1306 
1307  /*
1308  * OK, pick the most promising AND combination, and add it to
1309  * pathlist.
1310  */
1311  bitmapqual = choose_bitmap_and(root, rel, indlist);
1312  pathlist = lappend(pathlist, bitmapqual);
1313  }
1314 
1315  /*
1316  * If we have a match for every arm, then turn them into a
1317  * BitmapOrPath, and add to result list.
1318  */
1319  if (pathlist != NIL)
1320  {
1321  bitmapqual = (Path *) create_bitmap_or_path(root, rel, pathlist);
1322  result = lappend(result, bitmapqual);
1323  }
1324  }
1325 
1326  return result;
1327 }
1328 
1329 
1330 /*
1331  * choose_bitmap_and
1332  * Given a nonempty list of bitmap paths, AND them into one path.
1333  *
1334  * This is a nontrivial decision since we can legally use any subset of the
1335  * given path set. We want to choose a good tradeoff between selectivity
1336  * and cost of computing the bitmap.
1337  *
1338  * The result is either a single one of the inputs, or a BitmapAndPath
1339  * combining multiple inputs.
1340  */
1341 static Path *
1342 choose_bitmap_and(PlannerInfo *root, RelOptInfo *rel, List *paths)
1343 {
1344  int npaths = list_length(paths);
1345  PathClauseUsage **pathinfoarray;
1346  PathClauseUsage *pathinfo;
1347  List *clauselist;
1348  List *bestpaths = NIL;
1349  Cost bestcost = 0;
1350  int i,
1351  j;
1352  ListCell *l;
1353 
1354  Assert(npaths > 0); /* else caller error */
1355  if (npaths == 1)
1356  return (Path *) linitial(paths); /* easy case */
1357 
1358  /*
1359  * In theory we should consider every nonempty subset of the given paths.
1360  * In practice that seems like overkill, given the crude nature of the
1361  * estimates, not to mention the possible effects of higher-level AND and
1362  * OR clauses. Moreover, it's completely impractical if there are a large
1363  * number of paths, since the work would grow as O(2^N).
1364  *
1365  * As a heuristic, we first check for paths using exactly the same sets of
1366  * WHERE clauses + index predicate conditions, and reject all but the
1367  * cheapest-to-scan in any such group. This primarily gets rid of indexes
1368  * that include the interesting columns but also irrelevant columns. (In
1369  * situations where the DBA has gone overboard on creating variant
1370  * indexes, this can make for a very large reduction in the number of
1371  * paths considered further.)
1372  *
1373  * We then sort the surviving paths with the cheapest-to-scan first, and
1374  * for each path, consider using that path alone as the basis for a bitmap
1375  * scan. Then we consider bitmap AND scans formed from that path plus
1376  * each subsequent (higher-cost) path, adding on a subsequent path if it
1377  * results in a reduction in the estimated total scan cost. This means we
1378  * consider about O(N^2) rather than O(2^N) path combinations, which is
1379  * quite tolerable, especially given than N is usually reasonably small
1380  * because of the prefiltering step. The cheapest of these is returned.
1381  *
1382  * We will only consider AND combinations in which no two indexes use the
1383  * same WHERE clause. This is a bit of a kluge: it's needed because
1384  * costsize.c and clausesel.c aren't very smart about redundant clauses.
1385  * They will usually double-count the redundant clauses, producing a
1386  * too-small selectivity that makes a redundant AND step look like it
1387  * reduces the total cost. Perhaps someday that code will be smarter and
1388  * we can remove this limitation. (But note that this also defends
1389  * against flat-out duplicate input paths, which can happen because
1390  * match_join_clauses_to_index will find the same OR join clauses that
1391  * extract_restriction_or_clauses has pulled OR restriction clauses out
1392  * of.)
1393  *
1394  * For the same reason, we reject AND combinations in which an index
1395  * predicate clause duplicates another clause. Here we find it necessary
1396  * to be even stricter: we'll reject a partial index if any of its
1397  * predicate clauses are implied by the set of WHERE clauses and predicate
1398  * clauses used so far. This covers cases such as a condition "x = 42"
1399  * used with a plain index, followed by a clauseless scan of a partial
1400  * index "WHERE x >= 40 AND x < 50". The partial index has been accepted
1401  * only because "x = 42" was present, and so allowing it would partially
1402  * double-count selectivity. (We could use predicate_implied_by on
1403  * regular qual clauses too, to have a more intelligent, but much more
1404  * expensive, check for redundancy --- but in most cases simple equality
1405  * seems to suffice.)
1406  */
1407 
1408  /*
1409  * Extract clause usage info and detect any paths that use exactly the
1410  * same set of clauses; keep only the cheapest-to-scan of any such groups.
1411  * The surviving paths are put into an array for qsort'ing.
1412  */
1413  pathinfoarray = (PathClauseUsage **)
1414  palloc(npaths * sizeof(PathClauseUsage *));
1415  clauselist = NIL;
1416  npaths = 0;
1417  foreach(l, paths)
1418  {
1419  Path *ipath = (Path *) lfirst(l);
1420 
1421  pathinfo = classify_index_clause_usage(ipath, &clauselist);
1422 
1423  /* If it's unclassifiable, treat it as distinct from all others */
1424  if (pathinfo->unclassifiable)
1425  {
1426  pathinfoarray[npaths++] = pathinfo;
1427  continue;
1428  }
1429 
1430  for (i = 0; i < npaths; i++)
1431  {
1432  if (!pathinfoarray[i]->unclassifiable &&
1433  bms_equal(pathinfo->clauseids, pathinfoarray[i]->clauseids))
1434  break;
1435  }
1436  if (i < npaths)
1437  {
1438  /* duplicate clauseids, keep the cheaper one */
1439  Cost ncost;
1440  Cost ocost;
1441  Selectivity nselec;
1442  Selectivity oselec;
1443 
1444  cost_bitmap_tree_node(pathinfo->path, &ncost, &nselec);
1445  cost_bitmap_tree_node(pathinfoarray[i]->path, &ocost, &oselec);
1446  if (ncost < ocost)
1447  pathinfoarray[i] = pathinfo;
1448  }
1449  else
1450  {
1451  /* not duplicate clauseids, add to array */
1452  pathinfoarray[npaths++] = pathinfo;
1453  }
1454  }
1455 
1456  /* If only one surviving path, we're done */
1457  if (npaths == 1)
1458  return pathinfoarray[0]->path;
1459 
1460  /* Sort the surviving paths by index access cost */
1461  qsort(pathinfoarray, npaths, sizeof(PathClauseUsage *),
1462  path_usage_comparator);
1463 
1464  /*
1465  * For each surviving index, consider it as an "AND group leader", and see
1466  * whether adding on any of the later indexes results in an AND path with
1467  * cheaper total cost than before. Then take the cheapest AND group.
1468  *
1469  * Note: paths that are either clauseless or unclassifiable will have
1470  * empty clauseids, so that they will not be rejected by the clauseids
1471  * filter here, nor will they cause later paths to be rejected by it.
1472  */
1473  for (i = 0; i < npaths; i++)
1474  {
1475  Cost costsofar;
1476  List *qualsofar;
1477  Bitmapset *clauseidsofar;
1478 
1479  pathinfo = pathinfoarray[i];
1480  paths = list_make1(pathinfo->path);
1481  costsofar = bitmap_scan_cost_est(root, rel, pathinfo->path);
1482  qualsofar = list_concat_copy(pathinfo->quals, pathinfo->preds);
1483  clauseidsofar = bms_copy(pathinfo->clauseids);
1484 
1485  for (j = i + 1; j < npaths; j++)
1486  {
1487  Cost newcost;
1488 
1489  pathinfo = pathinfoarray[j];
1490  /* Check for redundancy */
1491  if (bms_overlap(pathinfo->clauseids, clauseidsofar))
1492  continue; /* consider it redundant */
1493  if (pathinfo->preds)
1494  {
1495  bool redundant = false;
1496 
1497  /* we check each predicate clause separately */
1498  foreach(l, pathinfo->preds)
1499  {
1500  Node *np = (Node *) lfirst(l);
1501 
1502  if (predicate_implied_by(list_make1(np), qualsofar, false))
1503  {
1504  redundant = true;
1505  break; /* out of inner foreach loop */
1506  }
1507  }
1508  if (redundant)
1509  continue;
1510  }
1511  /* tentatively add new path to paths, so we can estimate cost */
1512  paths = lappend(paths, pathinfo->path);
1513  newcost = bitmap_and_cost_est(root, rel, paths);
1514  if (newcost < costsofar)
1515  {
1516  /* keep new path in paths, update subsidiary variables */
1517  costsofar = newcost;
1518  qualsofar = list_concat(qualsofar, pathinfo->quals);
1519  qualsofar = list_concat(qualsofar, pathinfo->preds);
1520  clauseidsofar = bms_add_members(clauseidsofar,
1521  pathinfo->clauseids);
1522  }
1523  else
1524  {
1525  /* reject new path, remove it from paths list */
1526  paths = list_truncate(paths, list_length(paths) - 1);
1527  }
1528  }
1529 
1530  /* Keep the cheapest AND-group (or singleton) */
1531  if (i == 0 || costsofar < bestcost)
1532  {
1533  bestpaths = paths;
1534  bestcost = costsofar;
1535  }
1536 
1537  /* some easy cleanup (we don't try real hard though) */
1538  list_free(qualsofar);
1539  }
1540 
1541  if (list_length(bestpaths) == 1)
1542  return (Path *) linitial(bestpaths); /* no need for AND */
1543  return (Path *) create_bitmap_and_path(root, rel, bestpaths);
1544 }
1545 
1546 /* qsort comparator to sort in increasing index access cost order */
1547 static int
1548 path_usage_comparator(const void *a, const void *b)
1549 {
1550  PathClauseUsage *pa = *(PathClauseUsage *const *) a;
1551  PathClauseUsage *pb = *(PathClauseUsage *const *) b;
1552  Cost acost;
1553  Cost bcost;
1554  Selectivity aselec;
1555  Selectivity bselec;
1556 
1557  cost_bitmap_tree_node(pa->path, &acost, &aselec);
1558  cost_bitmap_tree_node(pb->path, &bcost, &bselec);
1559 
1560  /*
1561  * If costs are the same, sort by selectivity.
1562  */
1563  if (acost < bcost)
1564  return -1;
1565  if (acost > bcost)
1566  return 1;
1567 
1568  if (aselec < bselec)
1569  return -1;
1570  if (aselec > bselec)
1571  return 1;
1572 
1573  return 0;
1574 }
1575 
1576 /*
1577  * Estimate the cost of actually executing a bitmap scan with a single
1578  * index path (which could be a BitmapAnd or BitmapOr node).
1579  */
1580 static Cost
1581 bitmap_scan_cost_est(PlannerInfo *root, RelOptInfo *rel, Path *ipath)
1582 {
1583  BitmapHeapPath bpath;
1584 
1585  /* Set up a dummy BitmapHeapPath */
1586  bpath.path.type = T_BitmapHeapPath;
1587  bpath.path.pathtype = T_BitmapHeapScan;
1588  bpath.path.parent = rel;
1589  bpath.path.pathtarget = rel->reltarget;
1590  bpath.path.param_info = ipath->param_info;
1591  bpath.path.pathkeys = NIL;
1592  bpath.bitmapqual = ipath;
1593 
1594  /*
1595  * Check the cost of temporary path without considering parallelism.
1596  * Parallel bitmap heap path will be considered at later stage.
1597  */
1598  bpath.path.parallel_workers = 0;
1599 
1600  /* Now we can do cost_bitmap_heap_scan */
1601  cost_bitmap_heap_scan(&bpath.path, root, rel,
1602  bpath.path.param_info,
1603  ipath,
1604  get_loop_count(root, rel->relid,
1605  PATH_REQ_OUTER(ipath)));
1606 
1607  return bpath.path.total_cost;
1608 }
1609 
1610 /*
1611  * Estimate the cost of actually executing a BitmapAnd scan with the given
1612  * inputs.
1613  */
1614 static Cost
1615 bitmap_and_cost_est(PlannerInfo *root, RelOptInfo *rel, List *paths)
1616 {
1617  BitmapAndPath *apath;
1618 
1619  /*
1620  * Might as well build a real BitmapAndPath here, as the work is slightly
1621  * too complicated to be worth repeating just to save one palloc.
1622  */
1623  apath = create_bitmap_and_path(root, rel, paths);
1624 
1625  return bitmap_scan_cost_est(root, rel, (Path *) apath);
1626 }
1627 
1628 
1629 /*
1630  * classify_index_clause_usage
1631  * Construct a PathClauseUsage struct describing the WHERE clauses and
1632  * index predicate clauses used by the given indexscan path.
1633  * We consider two clauses the same if they are equal().
1634  *
1635  * At some point we might want to migrate this info into the Path data
1636  * structure proper, but for the moment it's only needed within
1637  * choose_bitmap_and().
1638  *
1639  * *clauselist is used and expanded as needed to identify all the distinct
1640  * clauses seen across successive calls. Caller must initialize it to NIL
1641  * before first call of a set.
1642  */
1643 static PathClauseUsage *
1644 classify_index_clause_usage(Path *path, List **clauselist)
1645 {
1646  PathClauseUsage *result;
1647  Bitmapset *clauseids;
1648  ListCell *lc;
1649 
1650  result = (PathClauseUsage *) palloc(sizeof(PathClauseUsage));
1651  result->path = path;
1652 
1653  /* Recursively find the quals and preds used by the path */
1654  result->quals = NIL;
1655  result->preds = NIL;
1656  find_indexpath_quals(path, &result->quals, &result->preds);
1657 
1658  /*
1659  * Some machine-generated queries have outlandish numbers of qual clauses.
1660  * To avoid getting into O(N^2) behavior even in this preliminary
1661  * classification step, we want to limit the number of entries we can
1662  * accumulate in *clauselist. Treat any path with more than 100 quals +
1663  * preds as unclassifiable, which will cause calling code to consider it
1664  * distinct from all other paths.
1665  */
1666  if (list_length(result->quals) + list_length(result->preds) > 100)
1667  {
1668  result->clauseids = NULL;
1669  result->unclassifiable = true;
1670  return result;
1671  }
1672 
1673  /* Build up a bitmapset representing the quals and preds */
1674  clauseids = NULL;
1675  foreach(lc, result->quals)
1676  {
1677  Node *node = (Node *) lfirst(lc);
1678 
1679  clauseids = bms_add_member(clauseids,
1680  find_list_position(node, clauselist));
1681  }
1682  foreach(lc, result->preds)
1683  {
1684  Node *node = (Node *) lfirst(lc);
1685 
1686  clauseids = bms_add_member(clauseids,
1687  find_list_position(node, clauselist));
1688  }
1689  result->clauseids = clauseids;
1690  result->unclassifiable = false;
1691 
1692  return result;
1693 }
1694 
1695 
1696 /*
1697  * find_indexpath_quals
1698  *
1699  * Given the Path structure for a plain or bitmap indexscan, extract lists
1700  * of all the index clauses and index predicate conditions used in the Path.
1701  * These are appended to the initial contents of *quals and *preds (hence
1702  * caller should initialize those to NIL).
1703  *
1704  * Note we are not trying to produce an accurate representation of the AND/OR
1705  * semantics of the Path, but just find out all the base conditions used.
1706  *
1707  * The result lists contain pointers to the expressions used in the Path,
1708  * but all the list cells are freshly built, so it's safe to destructively
1709  * modify the lists (eg, by concat'ing with other lists).
1710  */
1711 static void
1712 find_indexpath_quals(Path *bitmapqual, List **quals, List **preds)
1713 {
1714  if (IsA(bitmapqual, BitmapAndPath))
1715  {
1716  BitmapAndPath *apath = (BitmapAndPath *) bitmapqual;
1717  ListCell *l;
1718 
1719  foreach(l, apath->bitmapquals)
1720  {
1721  find_indexpath_quals((Path *) lfirst(l), quals, preds);
1722  }
1723  }
1724  else if (IsA(bitmapqual, BitmapOrPath))
1725  {
1726  BitmapOrPath *opath = (BitmapOrPath *) bitmapqual;
1727  ListCell *l;
1728 
1729  foreach(l, opath->bitmapquals)
1730  {
1731  find_indexpath_quals((Path *) lfirst(l), quals, preds);
1732  }
1733  }
1734  else if (IsA(bitmapqual, IndexPath))
1735  {
1736  IndexPath *ipath = (IndexPath *) bitmapqual;
1737  ListCell *l;
1738 
1739  foreach(l, ipath->indexclauses)
1740  {
1741  IndexClause *iclause = (IndexClause *) lfirst(l);
1742 
1743  *quals = lappend(*quals, iclause->rinfo->clause);
1744  }
1745  *preds = list_concat(*preds, ipath->indexinfo->indpred);
1746  }
1747  else
1748  elog(ERROR, "unrecognized node type: %d", nodeTag(bitmapqual));
1749 }
1750 
1751 
1752 /*
1753  * find_list_position
1754  * Return the given node's position (counting from 0) in the given
1755  * list of nodes. If it's not equal() to any existing list member,
1756  * add it at the end, and return that position.
1757  */
1758 static int
1759 find_list_position(Node *node, List **nodelist)
1760 {
1761  int i;
1762  ListCell *lc;
1763 
1764  i = 0;
1765  foreach(lc, *nodelist)
1766  {
1767  Node *oldnode = (Node *) lfirst(lc);
1768 
1769  if (equal(node, oldnode))
1770  return i;
1771  i++;
1772  }
1773 
1774  *nodelist = lappend(*nodelist, node);
1775 
1776  return i;
1777 }
1778 
1779 
1780 /*
1781  * check_index_only
1782  * Determine whether an index-only scan is possible for this index.
1783  */
1784 static bool
1785 check_index_only(RelOptInfo *rel, IndexOptInfo *index)
1786 {
1787  bool result;
1788  Bitmapset *attrs_used = NULL;
1789  Bitmapset *index_canreturn_attrs = NULL;
1790  ListCell *lc;
1791  int i;
1792 
1793  /* Index-only scans must be enabled */
1794  if (!enable_indexonlyscan)
1795  return false;
1796 
1797  /*
1798  * Check that all needed attributes of the relation are available from the
1799  * index.
1800  */
1801 
1802  /*
1803  * First, identify all the attributes needed for joins or final output.
1804  * Note: we must look at rel's targetlist, not the attr_needed data,
1805  * because attr_needed isn't computed for inheritance child rels.
1806  */
1807  pull_varattnos((Node *) rel->reltarget->exprs, rel->relid, &attrs_used);
1808 
1809  /*
1810  * Add all the attributes used by restriction clauses; but consider only
1811  * those clauses not implied by the index predicate, since ones that are
1812  * so implied don't need to be checked explicitly in the plan.
1813  *
1814  * Note: attributes used only in index quals would not be needed at
1815  * runtime either, if we are certain that the index is not lossy. However
1816  * it'd be complicated to account for that accurately, and it doesn't
1817  * matter in most cases, since we'd conclude that such attributes are
1818  * available from the index anyway.
1819  */
1820  foreach(lc, index->indrestrictinfo)
1821  {
1822  RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
1823 
1824  pull_varattnos((Node *) rinfo->clause, rel->relid, &attrs_used);
1825  }
1826 
1827  /*
1828  * Construct a bitmapset of columns that the index can return back in an
1829  * index-only scan.
1830  */
1831  for (i = 0; i < index->ncolumns; i++)
1832  {
1833  int attno = index->indexkeys[i];
1834 
1835  /*
1836  * For the moment, we just ignore index expressions. It might be nice
1837  * to do something with them, later.
1838  */
1839  if (attno == 0)
1840  continue;
1841 
1842  if (index->canreturn[i])
1843  index_canreturn_attrs =
1844  bms_add_member(index_canreturn_attrs,
1845  attno - FirstLowInvalidHeapAttributeNumber);
1846  }
1847 
1848  /* Do we have all the necessary attributes? */
1849  result = bms_is_subset(attrs_used, index_canreturn_attrs);
1850 
1851  bms_free(attrs_used);
1852  bms_free(index_canreturn_attrs);
1853 
1854  return result;
1855 }
1856 
1857 /*
1858  * get_loop_count
1859  * Choose the loop count estimate to use for costing a parameterized path
1860  * with the given set of outer relids.
1861  *
1862  * Since we produce parameterized paths before we've begun to generate join
1863  * relations, it's impossible to predict exactly how many times a parameterized
1864  * path will be iterated; we don't know the size of the relation that will be
1865  * on the outside of the nestloop. However, we should try to account for
1866  * multiple iterations somehow in costing the path. The heuristic embodied
1867  * here is to use the rowcount of the smallest other base relation needed in
1868  * the join clauses used by the path. (We could alternatively consider the
1869  * largest one, but that seems too optimistic.) This is of course the right
1870  * answer for single-other-relation cases, and it seems like a reasonable
1871  * zero-order approximation for multiway-join cases.
1872  *
1873  * In addition, we check to see if the other side of each join clause is on
1874  * the inside of some semijoin that the current relation is on the outside of.
1875  * If so, the only way that a parameterized path could be used is if the
1876  * semijoin RHS has been unique-ified, so we should use the number of unique
1877  * RHS rows rather than using the relation's raw rowcount.
1878  *
1879  * Note: for this to work, allpaths.c must establish all baserel size
1880  * estimates before it begins to compute paths, or at least before it
1881  * calls create_index_paths().
1882  */
1883 static double
1884 get_loop_count(PlannerInfo *root, Index cur_relid, Relids outer_relids)
1885 {
1886  double result;
1887  int outer_relid;
1888 
1889  /* For a non-parameterized path, just return 1.0 quickly */
1890  if (outer_relids == NULL)
1891  return 1.0;
1892 
1893  result = 0.0;
1894  outer_relid = -1;
1895  while ((outer_relid = bms_next_member(outer_relids, outer_relid)) >= 0)
1896  {
1897  RelOptInfo *outer_rel;
1898  double rowcount;
1899 
1900  /* Paranoia: ignore bogus relid indexes */
1901  if (outer_relid >= root->simple_rel_array_size)
1902  continue;
1903  outer_rel = root->simple_rel_array[outer_relid];
1904  if (outer_rel == NULL)
1905  continue;
1906  Assert(outer_rel->relid == outer_relid); /* sanity check on array */
1907 
1908  /* Other relation could be proven empty, if so ignore */
1909  if (IS_DUMMY_REL(outer_rel))
1910  continue;
1911 
1912  /* Otherwise, rel's rows estimate should be valid by now */
1913  Assert(outer_rel->rows > 0);
1914 
1915  /* Check to see if rel is on the inside of any semijoins */
1916  rowcount = adjust_rowcount_for_semijoins(root,
1917  cur_relid,
1918  outer_relid,
1919  outer_rel->rows);
1920 
1921  /* Remember smallest row count estimate among the outer rels */
1922  if (result == 0.0 || result > rowcount)
1923  result = rowcount;
1924  }
1925  /* Return 1.0 if we found no valid relations (shouldn't happen) */
1926  return (result > 0.0) ? result : 1.0;
1927 }
1928 
1929 /*
1930  * Check to see if outer_relid is on the inside of any semijoin that cur_relid
1931  * is on the outside of. If so, replace rowcount with the estimated number of
1932  * unique rows from the semijoin RHS (assuming that's smaller, which it might
1933  * not be). The estimate is crude but it's the best we can do at this stage
1934  * of the proceedings.
1935  */
1936 static double
1937 adjust_rowcount_for_semijoins(PlannerInfo *root,
1938  Index cur_relid,
1939  Index outer_relid,
1940  double rowcount)
1941 {
1942  ListCell *lc;
1943 
1944  foreach(lc, root->join_info_list)
1945  {
1946  SpecialJoinInfo *sjinfo = (SpecialJoinInfo *) lfirst(lc);
1947 
1948  if (sjinfo->jointype == JOIN_SEMI &&
1949  bms_is_member(cur_relid, sjinfo->syn_lefthand) &&
1950  bms_is_member(outer_relid, sjinfo->syn_righthand))
1951  {
1952  /* Estimate number of unique-ified rows */
1953  double nraw;
1954  double nunique;
1955 
1956  nraw = approximate_joinrel_size(root, sjinfo->syn_righthand);
1957  nunique = estimate_num_groups(root,
1958  sjinfo->semi_rhs_exprs,
1959  nraw,
1960  NULL,
1961  NULL);
1962  if (rowcount > nunique)
1963  rowcount = nunique;
1964  }
1965  }
1966  return rowcount;
1967 }
1968 
1969 /*
1970  * Make an approximate estimate of the size of a joinrel.
1971  *
1972  * We don't have enough info at this point to get a good estimate, so we
1973  * just multiply the base relation sizes together. Fortunately, this is
1974  * the right answer anyway for the most common case with a single relation
1975  * on the RHS of a semijoin. Also, estimate_num_groups() has only a weak
1976  * dependency on its input_rows argument (it basically uses it as a clamp).
1977  * So we might be able to get a fairly decent end result even with a severe
1978  * overestimate of the RHS's raw size.
1979  */
1980 static double
1981 approximate_joinrel_size(PlannerInfo *root, Relids relids)
1982 {
1983  double rowcount = 1.0;
1984  int relid;
1985 
1986  relid = -1;
1987  while ((relid = bms_next_member(relids, relid)) >= 0)
1988  {
1989  RelOptInfo *rel;
1990 
1991  /* Paranoia: ignore bogus relid indexes */
1992  if (relid >= root->simple_rel_array_size)
1993  continue;
1994  rel = root->simple_rel_array[relid];
1995  if (rel == NULL)
1996  continue;
1997  Assert(rel->relid == relid); /* sanity check on array */
1998 
1999  /* Relation could be proven empty, if so ignore */
2000  if (IS_DUMMY_REL(rel))
2001  continue;
2002 
2003  /* Otherwise, rel's rows estimate should be valid by now */
2004  Assert(rel->rows > 0);
2005 
2006  /* Accumulate product */
2007  rowcount *= rel->rows;
2008  }
2009  return rowcount;
2010 }
2011 
2012 
2013 /****************************************************************************
2014  * ---- ROUTINES TO CHECK QUERY CLAUSES ----
2015  ****************************************************************************/
2016 
2017 /*
2018  * match_restriction_clauses_to_index
2019  * Identify restriction clauses for the rel that match the index.
2020  * Matching clauses are added to *clauseset.
2021  */
2022 static void
2023 match_restriction_clauses_to_index(PlannerInfo *root,
2024  IndexOptInfo *index,
2025  IndexClauseSet *clauseset)
2026 {
2027  /* We can ignore clauses that are implied by the index predicate */
2028  match_clauses_to_index(root, index->indrestrictinfo, index, clauseset);
2029 }
2030 
2031 /*
2032  * match_join_clauses_to_index
2033  * Identify join clauses for the rel that match the index.
2034  * Matching clauses are added to *clauseset.
2035  * Also, add any potentially usable join OR clauses to *joinorclauses.
2036  */
2037 static void
2038 match_join_clauses_to_index(PlannerInfo *root,
2039  RelOptInfo *rel, IndexOptInfo *index,
2040  IndexClauseSet *clauseset,
2041  List **joinorclauses)
2042 {
2043  ListCell *lc;
2044 
2045  /* Scan the rel's join clauses */
2046  foreach(lc, rel->joininfo)
2047  {
2048  RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
2049 
2050  /* Check if clause can be moved to this rel */
2051  if (!join_clause_is_movable_to(rinfo, rel))
2052  continue;
2053 
2054  /* Potentially usable, so see if it matches the index or is an OR */
2055  if (restriction_is_or_clause(rinfo))
2056  *joinorclauses = lappend(*joinorclauses, rinfo);
2057  else
2058  match_clause_to_index(root, rinfo, index, clauseset);
2059  }
2060 }
2061 
2062 /*
2063  * match_eclass_clauses_to_index
2064  * Identify EquivalenceClass join clauses for the rel that match the index.
2065  * Matching clauses are added to *clauseset.
2066  */
2067 static void
2068 match_eclass_clauses_to_index(PlannerInfo *root, IndexOptInfo *index,
2069  IndexClauseSet *clauseset)
2070 {
2071  int indexcol;
2072 
2073  /* No work if rel is not in any such ECs */
2074  if (!index->rel->has_eclass_joins)
2075  return;
2076 
2077  for (indexcol = 0; indexcol < index->nkeycolumns; indexcol++)
2078  {
2079  ec_member_matches_arg arg;
2080  List *clauses;
2081 
2082  /* Generate clauses, skipping any that join to lateral_referencers */
2083  arg.index = index;
2084  arg.indexcol = indexcol;
2085  clauses = generate_implied_equalities_for_column(root,
2086  index->rel,
2087  ec_member_matches_indexcol,
2088  (void *) &arg,
2089  index->rel->lateral_referencers);
2090 
2091  /*
2092  * We have to check whether the results actually do match the index,
2093  * since for non-btree indexes the EC's equality operators might not
2094  * be in the index opclass (cf ec_member_matches_indexcol).
2095  */
2096  match_clauses_to_index(root, clauses, index, clauseset);
2097  }
2098 }
2099 
2100 /*
2101  * match_clauses_to_index
2102  * Perform match_clause_to_index() for each clause in a list.
2103  * Matching clauses are added to *clauseset.
2104  */
2105 static void
2106 match_clauses_to_index(PlannerInfo *root,
2107  List *clauses,
2108  IndexOptInfo *index,
2109  IndexClauseSet *clauseset)
2110 {
2111  ListCell *lc;
2112 
2113  foreach(lc, clauses)
2114  {
2115  RestrictInfo *rinfo = lfirst_node(RestrictInfo, lc);
2116 
2117  match_clause_to_index(root, rinfo, index, clauseset);
2118  }
2119 }
2120 
2121 /*
2122  * match_clause_to_index
2123  * Test whether a qual clause can be used with an index.
2124  *
2125  * If the clause is usable, add an IndexClause entry for it to the appropriate
2126  * list in *clauseset. (*clauseset must be initialized to zeroes before first
2127  * call.)
2128  *
2129  * Note: in some circumstances we may find the same RestrictInfos coming from
2130  * multiple places. Defend against redundant outputs by refusing to add a
2131  * clause twice (pointer equality should be a good enough check for this).
2132  *
2133  * Note: it's possible that a badly-defined index could have multiple matching
2134  * columns. We always select the first match if so; this avoids scenarios
2135  * wherein we get an inflated idea of the index's selectivity by using the
2136  * same clause multiple times with different index columns.
2137  */
2138 static void
2139 match_clause_to_index(PlannerInfo *root,
2140  RestrictInfo *rinfo,
2141  IndexOptInfo *index,
2142  IndexClauseSet *clauseset)
2143 {
2144  int indexcol;
2145 
2146  /*
2147  * Never match pseudoconstants to indexes. (Normally a match could not
2148  * happen anyway, since a pseudoconstant clause couldn't contain a Var,
2149  * but what if someone builds an expression index on a constant? It's not
2150  * totally unreasonable to do so with a partial index, either.)
2151  */
2152  if (rinfo->pseudoconstant)
2153  return;
2154 
2155  /*
2156  * If clause can't be used as an indexqual because it must wait till after
2157  * some lower-security-level restriction clause, reject it.
2158  */
2159  if (!restriction_is_securely_promotable(rinfo, index->rel))
2160  return;
2161 
2162  /* OK, check each index key column for a match */
2163  for (indexcol = 0; indexcol < index->nkeycolumns; indexcol++)
2164  {
2165  IndexClause *iclause;
2166  ListCell *lc;
2167 
2168  /* Ignore duplicates */
2169  foreach(lc, clauseset->indexclauses[indexcol])
2170  {
2171  iclause = (IndexClause *) lfirst(lc);
2172 
2173  if (iclause->rinfo == rinfo)
2174  return;
2175  }
2176 
2177  /* OK, try to match the clause to the index column */
2178  iclause = match_clause_to_indexcol(root,
2179  rinfo,
2180  indexcol,
2181  index);
2182  if (iclause)
2183  {
2184  /* Success, so record it */
2185  clauseset->indexclauses[indexcol] =
2186  lappend(clauseset->indexclauses[indexcol], iclause);
2187  clauseset->nonempty = true;
2188  return;
2189  }
2190  }
2191 }
2192 
2193 /*
2194  * match_clause_to_indexcol()
2195  * Determine whether a restriction clause matches a column of an index,
2196  * and if so, build an IndexClause node describing the details.
2197  *
2198  * To match an index normally, an operator clause:
2199  *
2200  * (1) must be in the form (indexkey op const) or (const op indexkey);
2201  * and
2202  * (2) must contain an operator which is in the index's operator family
2203  * for this column; and
2204  * (3) must match the collation of the index, if collation is relevant.
2205  *
2206  * Our definition of "const" is exceedingly liberal: we allow anything that
2207  * doesn't involve a volatile function or a Var of the index's relation.
2208  * In particular, Vars belonging to other relations of the query are
2209  * accepted here, since a clause of that form can be used in a
2210  * parameterized indexscan. It's the responsibility of higher code levels
2211  * to manage restriction and join clauses appropriately.
2212  *
2213  * Note: we do need to check for Vars of the index's relation on the
2214  * "const" side of the clause, since clauses like (a.f1 OP (b.f2 OP a.f3))
2215  * are not processable by a parameterized indexscan on a.f1, whereas
2216  * something like (a.f1 OP (b.f2 OP c.f3)) is.
2217  *
2218  * Presently, the executor can only deal with indexquals that have the
2219  * indexkey on the left, so we can only use clauses that have the indexkey
2220  * on the right if we can commute the clause to put the key on the left.
2221  * We handle that by generating an IndexClause with the correctly-commuted
2222  * opclause as a derived indexqual.
2223  *
2224  * If the index has a collation, the clause must have the same collation.
2225  * For collation-less indexes, we assume it doesn't matter; this is
2226  * necessary for cases like "hstore ? text", wherein hstore's operators
2227  * don't care about collation but the clause will get marked with a
2228  * collation anyway because of the text argument. (This logic is
2229  * embodied in the macro IndexCollMatchesExprColl.)
2230  *
2231  * It is also possible to match RowCompareExpr clauses to indexes (but
2232  * currently, only btree indexes handle this).
2233  *
2234  * It is also possible to match ScalarArrayOpExpr clauses to indexes, when
2235  * the clause is of the form "indexkey op ANY (arrayconst)".
2236  *
2237  * For boolean indexes, it is also possible to match the clause directly
2238  * to the indexkey; or perhaps the clause is (NOT indexkey).
2239  *
2240  * And, last but not least, some operators and functions can be processed
2241  * to derive (typically lossy) indexquals from a clause that isn't in
2242  * itself indexable. If we see that any operand of an OpExpr or FuncExpr
2243  * matches the index key, and the function has a planner support function
2244  * attached to it, we'll invoke the support function to see if such an
2245  * indexqual can be built.
2246  *
2247  * 'rinfo' is the clause to be tested (as a RestrictInfo node).
2248  * 'indexcol' is a column number of 'index' (counting from 0).
2249  * 'index' is the index of interest.
2250  *
2251  * Returns an IndexClause if the clause can be used with this index key,
2252  * or NULL if not.
2253  *
2254  * NOTE: returns NULL if clause is an OR or AND clause; it is the
2255  * responsibility of higher-level routines to cope with those.
2256  */
2257 static IndexClause *
2258 match_clause_to_indexcol(PlannerInfo *root,
2259  RestrictInfo *rinfo,
2260  int indexcol,
2261  IndexOptInfo *index)
2262 {
2263  IndexClause *iclause;
2264  Expr *clause = rinfo->clause;
2265  Oid opfamily;
2266 
2267  Assert(indexcol < index->nkeycolumns);
2268 
2269  /*
2270  * Historically this code has coped with NULL clauses. That's probably
2271  * not possible anymore, but we might as well continue to cope.
2272  */
2273  if (clause == NULL)
2274  return NULL;
2275 
2276  /* First check for boolean-index cases. */
2277  opfamily = index->opfamily[indexcol];
2278  if (IsBooleanOpfamily(opfamily))
2279  {
2280  iclause = match_boolean_index_clause(root, rinfo, indexcol, index);
2281  if (iclause)
2282  return iclause;
2283  }
2284 
2285  /*
2286  * Clause must be an opclause, funcclause, ScalarArrayOpExpr, or
2287  * RowCompareExpr. Or, if the index supports it, we can handle IS
2288  * NULL/NOT NULL clauses.
2289  */
2290  if (IsA(clause, OpExpr))
2291  {
2292  return match_opclause_to_indexcol(root, rinfo, indexcol, index);
2293  }
2294  else if (IsA(clause, FuncExpr))
2295  {
2296  return match_funcclause_to_indexcol(root, rinfo, indexcol, index);
2297  }
2298  else if (IsA(clause, ScalarArrayOpExpr))
2299  {
2300  return match_saopclause_to_indexcol(root, rinfo, indexcol, index);
2301  }
2302  else if (IsA(clause, RowCompareExpr))
2303  {
2304  return match_rowcompare_to_indexcol(root, rinfo, indexcol, index);
2305  }
2306  else if (index->amsearchnulls && IsA(clause, NullTest))
2307  {
2308  NullTest *nt = (NullTest *) clause;
2309 
2310  if (!nt->argisrow &&
2311  match_index_to_operand((Node *) nt->arg, indexcol, index))
2312  {
2313  iclause = makeNode(IndexClause);
2314  iclause->rinfo = rinfo;
2315  iclause->indexquals = list_make1(rinfo);
2316  iclause->lossy = false;
2317  iclause->indexcol = indexcol;
2318  iclause->indexcols = NIL;
2319  return iclause;
2320  }
2321  }
2322 
2323  return NULL;
2324 }
2325 
2326 /*
2327  * IsBooleanOpfamily
2328  * Detect whether an opfamily supports boolean equality as an operator.
2329  *
2330  * If the opfamily OID is in the range of built-in objects, we can rely
2331  * on hard-wired knowledge of which built-in opfamilies support this.
2332  * For extension opfamilies, there's no choice but to do a catcache lookup.
2333  */
2334 static bool
2335 IsBooleanOpfamily(Oid opfamily)
2336 {
2337  if (opfamily < FirstNormalObjectId)
2338  return IsBuiltinBooleanOpfamily(opfamily);
2339  else
2340  return op_in_opfamily(BooleanEqualOperator, opfamily);
2341 }
2342 
2343 /*
2344  * match_boolean_index_clause
2345  * Recognize restriction clauses that can be matched to a boolean index.
2346  *
2347  * The idea here is that, for an index on a boolean column that supports the
2348  * BooleanEqualOperator, we can transform a plain reference to the indexkey
2349  * into "indexkey = true", or "NOT indexkey" into "indexkey = false", etc,
2350  * so as to make the expression indexable using the index's "=" operator.
2351  * Since Postgres 8.1, we must do this because constant simplification does
2352  * the reverse transformation; without this code there'd be no way to use
2353  * such an index at all.
2354  *
2355  * This should be called only when IsBooleanOpfamily() recognizes the
2356  * index's operator family. We check to see if the clause matches the
2357  * index's key, and if so, build a suitable IndexClause.
2358  */
2359 static IndexClause *
2360 match_boolean_index_clause(PlannerInfo *root,
2361  RestrictInfo *rinfo,
2362  int indexcol,
2363  IndexOptInfo *index)
2364 {
2365  Node *clause = (Node *) rinfo->clause;
2366  Expr *op = NULL;
2367 
2368  /* Direct match? */
2369  if (match_index_to_operand(clause, indexcol, index))
2370  {
2371  /* convert to indexkey = TRUE */
2372  op = make_opclause(BooleanEqualOperator, BOOLOID, false,
2373  (Expr *) clause,
2374  (Expr *) makeBoolConst(true, false),
2375  InvalidOid, InvalidOid);
2376  }
2377  /* NOT clause? */
2378  else if (is_notclause(clause))
2379  {
2380  Node *arg = (Node *) get_notclausearg((Expr *) clause);
2381 
2382  if (match_index_to_operand(arg, indexcol, index))
2383  {
2384  /* convert to indexkey = FALSE */
2385  op = make_opclause(BooleanEqualOperator, BOOLOID, false,
2386  (Expr *) arg,
2387  (Expr *) makeBoolConst(false, false),
2388  InvalidOid, InvalidOid);
2389  }
2390  }
2391 
2392  /*
2393  * Since we only consider clauses at top level of WHERE, we can convert
2394  * indexkey IS TRUE and indexkey IS FALSE to index searches as well. The
2395  * different meaning for NULL isn't important.
2396  */
2397  else if (clause && IsA(clause, BooleanTest))
2398  {
2399  BooleanTest *btest = (BooleanTest *) clause;
2400  Node *arg = (Node *) btest->arg;
2401 
2402  if (btest->booltesttype == IS_TRUE &&
2403  match_index_to_operand(arg, indexcol, index))
2404  {
2405  /* convert to indexkey = TRUE */
2406  op = make_opclause(BooleanEqualOperator, BOOLOID, false,
2407  (Expr *) arg,
2408  (Expr *) makeBoolConst(true, false),
2409  InvalidOid, InvalidOid);
2410  }
2411  else if (btest->booltesttype == IS_FALSE &&
2412  match_index_to_operand(arg, indexcol, index))
2413  {
2414  /* convert to indexkey = FALSE */
2415  op = make_opclause(BooleanEqualOperator, BOOLOID, false,
2416  (Expr *) arg,
2417  (Expr *) makeBoolConst(false, false),
2418  InvalidOid, InvalidOid);
2419  }
2420  }
2421 
2422  /*
2423  * If we successfully made an operator clause from the given qual, we must
2424  * wrap it in an IndexClause. It's not lossy.
2425  */
2426  if (op)
2427  {
2428  IndexClause *iclause = makeNode(IndexClause);
2429 
2430  iclause->rinfo = rinfo;
2431  iclause->indexquals = list_make1(make_simple_restrictinfo(root, op));
2432  iclause->lossy = false;
2433  iclause->indexcol = indexcol;
2434  iclause->indexcols = NIL;
2435  return iclause;
2436  }
2437 
2438  return NULL;
2439 }
2440 
2441 /*
2442  * match_opclause_to_indexcol()
2443  * Handles the OpExpr case for match_clause_to_indexcol(),
2444  * which see for comments.
2445  */
2446 static IndexClause *
2447 match_opclause_to_indexcol(PlannerInfo *root,
2448  RestrictInfo *rinfo,
2449  int indexcol,
2450  IndexOptInfo *index)
2451 {
2452  IndexClause *iclause;
2453  OpExpr *clause = (OpExpr *) rinfo->clause;
2454  Node *leftop,
2455  *rightop;
2456  Oid expr_op;
2457  Oid expr_coll;
2458  Index index_relid;
2459  Oid opfamily;
2460  Oid idxcollation;
2461 
2462  /*
2463  * Only binary operators need apply. (In theory, a planner support
2464  * function could do something with a unary operator, but it seems
2465  * unlikely to be worth the cycles to check.)
2466  */
2467  if (list_length(clause->args) != 2)
2468  return NULL;
2469 
2470  leftop = (Node *) linitial(clause->args);
2471  rightop = (Node *) lsecond(clause->args);
2472  expr_op = clause->opno;
2473  expr_coll = clause->inputcollid;
2474 
2475  index_relid = index->rel->relid;
2476  opfamily = index->opfamily[indexcol];
2477  idxcollation = index->indexcollations[indexcol];
2478 
2479  /*
2480  * Check for clauses of the form: (indexkey operator constant) or
2481  * (constant operator indexkey). See match_clause_to_indexcol's notes
2482  * about const-ness.
2483  *
2484  * Note that we don't ask the support function about clauses that don't
2485  * have one of these forms. Again, in principle it might be possible to
2486  * do something, but it seems unlikely to be worth the cycles to check.
2487  */
2488  if (match_index_to_operand(leftop, indexcol, index) &&
2489  !bms_is_member(index_relid, rinfo->right_relids) &&
2490  !contain_volatile_functions(rightop))
2491  {
2492  if (IndexCollMatchesExprColl(idxcollation, expr_coll) &&
2493  op_in_opfamily(expr_op, opfamily))
2494  {
2495  iclause = makeNode(IndexClause);
2496  iclause->rinfo = rinfo;
2497  iclause->indexquals = list_make1(rinfo);
2498  iclause->lossy = false;
2499  iclause->indexcol = indexcol;
2500  iclause->indexcols = NIL;
2501  return iclause;
2502  }
2503 
2504  /*
2505  * If we didn't find a member of the index's opfamily, try the support
2506  * function for the operator's underlying function.
2507  */
2508  set_opfuncid(clause); /* make sure we have opfuncid */
2509  return get_index_clause_from_support(root,
2510  rinfo,
2511  clause->opfuncid,
2512  0, /* indexarg on left */
2513  indexcol,
2514  index);
2515  }
2516 
2517  if (match_index_to_operand(rightop, indexcol, index) &&
2518  !bms_is_member(index_relid, rinfo->left_relids) &&
2519  !contain_volatile_functions(leftop))
2520  {
2521  if (IndexCollMatchesExprColl(idxcollation, expr_coll))
2522  {
2523  Oid comm_op = get_commutator(expr_op);
2524 
2525  if (OidIsValid(comm_op) &&
2526  op_in_opfamily(comm_op, opfamily))
2527  {
2528  RestrictInfo *commrinfo;
2529 
2530  /* Build a commuted OpExpr and RestrictInfo */
2531  commrinfo = commute_restrictinfo(rinfo, comm_op);
2532 
2533  /* Make an IndexClause showing that as a derived qual */
2534  iclause = makeNode(IndexClause);
2535  iclause->rinfo = rinfo;
2536  iclause->indexquals = list_make1(commrinfo);
2537  iclause->lossy = false;
2538  iclause->indexcol = indexcol;
2539  iclause->indexcols = NIL;
2540  return iclause;
2541  }
2542  }
2543 
2544  /*
2545  * If we didn't find a member of the index's opfamily, try the support
2546  * function for the operator's underlying function.
2547  */
2548  set_opfuncid(clause); /* make sure we have opfuncid */
2549  return get_index_clause_from_support(root,
2550  rinfo,
2551  clause->opfuncid,
2552  1, /* indexarg on right */
2553  indexcol,
2554  index);
2555  }
2556 
2557  return NULL;
2558 }
2559 
2560 /*
2561  * match_funcclause_to_indexcol()
2562  * Handles the FuncExpr case for match_clause_to_indexcol(),
2563  * which see for comments.
2564  */
2565 static IndexClause *
2566 match_funcclause_to_indexcol(PlannerInfo *root,
2567  RestrictInfo *rinfo,
2568  int indexcol,
2569  IndexOptInfo *index)
2570 {
2571  FuncExpr *clause = (FuncExpr *) rinfo->clause;
2572  int indexarg;
2573  ListCell *lc;
2574 
2575  /*
2576  * We have no built-in intelligence about function clauses, but if there's
2577  * a planner support function, it might be able to do something. But, to
2578  * cut down on wasted planning cycles, only call the support function if
2579  * at least one argument matches the target index column.
2580  *
2581  * Note that we don't insist on the other arguments being pseudoconstants;
2582  * the support function has to check that. This is to allow cases where
2583  * only some of the other arguments need to be included in the indexqual.
2584  */
2585  indexarg = 0;
2586  foreach(lc, clause->args)
2587  {
2588  Node *op = (Node *) lfirst(lc);
2589 
2590  if (match_index_to_operand(op, indexcol, index))
2591  {
2592  return get_index_clause_from_support(root,
2593  rinfo,
2594  clause->funcid,
2595  indexarg,
2596  indexcol,
2597  index);
2598  }
2599 
2600  indexarg++;
2601  }
2602 
2603  return NULL;
2604 }
2605 
2606 /*
2607  * get_index_clause_from_support()
2608  * If the function has a planner support function, try to construct
2609  * an IndexClause using indexquals created by the support function.
2610  */
2611 static IndexClause *
2612 get_index_clause_from_support(PlannerInfo *root,
2613  RestrictInfo *rinfo,
2614  Oid funcid,
2615  int indexarg,
2616  int indexcol,
2617  IndexOptInfo *index)
2618 {
2619  Oid prosupport = get_func_support(funcid);
2620  SupportRequestIndexCondition req;
2621  List *sresult;
2622 
2623  if (!OidIsValid(prosupport))
2624  return NULL;
2625 
2626  req.type = T_SupportRequestIndexCondition;
2627  req.root = root;
2628  req.funcid = funcid;
2629  req.node = (Node *) rinfo->clause;
2630  req.indexarg = indexarg;
2631  req.index = index;
2632  req.indexcol = indexcol;
2633  req.opfamily = index->opfamily[indexcol];
2634  req.indexcollation = index->indexcollations[indexcol];
2635 
2636  req.lossy = true; /* default assumption */
2637 
2638  sresult = (List *)
2639  DatumGetPointer(OidFunctionCall1(prosupport,
2640  PointerGetDatum(&req)));
2641 
2642  if (sresult != NIL)
2643  {
2644  IndexClause *iclause = makeNode(IndexClause);
2645  List *indexquals = NIL;
2646  ListCell *lc;
2647 
2648  /*
2649  * The support function API says it should just give back bare
2650  * clauses, so here we must wrap each one in a RestrictInfo.
2651  */
2652  foreach(lc, sresult)
2653  {
2654  Expr *clause = (Expr *) lfirst(lc);
2655 
2656  indexquals = lappend(indexquals,
2657  make_simple_restrictinfo(root, clause));
2658  }
2659 
2660  iclause->rinfo = rinfo;
2661  iclause->indexquals = indexquals;
2662  iclause->lossy = req.lossy;
2663  iclause->indexcol = indexcol;
2664  iclause->indexcols = NIL;
2665 
2666  return iclause;
2667  }
2668 
2669  return NULL;
2670 }
2671 
2672 /*
2673  * match_saopclause_to_indexcol()
2674  * Handles the ScalarArrayOpExpr case for match_clause_to_indexcol(),
2675  * which see for comments.
2676  */
2677 static IndexClause *
2678 match_saopclause_to_indexcol(PlannerInfo *root,
2679  RestrictInfo *rinfo,
2680  int indexcol,
2681  IndexOptInfo *index)
2682 {
2683  ScalarArrayOpExpr *saop = (ScalarArrayOpExpr *) rinfo->clause;
2684  Node *leftop,
2685  *rightop;
2686  Relids right_relids;
2687  Oid expr_op;
2688  Oid expr_coll;
2689  Index index_relid;
2690  Oid opfamily;
2691  Oid idxcollation;
2692 
2693  /* We only accept ANY clauses, not ALL */
2694  if (!saop->useOr)
2695  return NULL;
2696  leftop = (Node *) linitial(saop->args);
2697  rightop = (Node *) lsecond(saop->args);
2698  right_relids = pull_varnos(root, rightop);
2699  expr_op = saop->opno;
2700  expr_coll = saop->inputcollid;
2701 
2702  index_relid = index->rel->relid;
2703  opfamily = index->opfamily[indexcol];
2704  idxcollation = index->indexcollations[indexcol];
2705 
2706  /*
2707  * We must have indexkey on the left and a pseudo-constant array argument.
2708  */
2709  if (match_index_to_operand(leftop, indexcol, index) &&
2710  !bms_is_member(index_relid, right_relids) &&
2711  !contain_volatile_functions(rightop))
2712  {
2713  if (IndexCollMatchesExprColl(idxcollation, expr_coll) &&
2714  op_in_opfamily(expr_op, opfamily))
2715  {
2716  IndexClause *iclause = makeNode(IndexClause);
2717 
2718  iclause->rinfo = rinfo;
2719  iclause->indexquals = list_make1(rinfo);
2720  iclause->lossy = false;
2721  iclause->indexcol = indexcol;
2722  iclause->indexcols = NIL;
2723  return iclause;
2724  }
2725 
2726  /*
2727  * We do not currently ask support functions about ScalarArrayOpExprs,
2728  * though in principle we could.
2729  */
2730  }
2731 
2732  return NULL;
2733 }
2734 
2735 /*
2736  * match_rowcompare_to_indexcol()
2737  * Handles the RowCompareExpr case for match_clause_to_indexcol(),
2738  * which see for comments.
2739  *
2740  * In this routine we check whether the first column of the row comparison
2741  * matches the target index column. This is sufficient to guarantee that some
2742  * index condition can be constructed from the RowCompareExpr --- the rest
2743  * is handled by expand_indexqual_rowcompare().
2744  */
2745 static IndexClause *
2746 match_rowcompare_to_indexcol(PlannerInfo *root,
2747  RestrictInfo *rinfo,
2748  int indexcol,
2749  IndexOptInfo *index)
2750 {
2751  RowCompareExpr *clause = (RowCompareExpr *) rinfo->clause;
2752  Index index_relid;
2753  Oid opfamily;
2754  Oid idxcollation;
2755  Node *leftop,
2756  *rightop;
2757  bool var_on_left;
2758  Oid expr_op;
2759  Oid expr_coll;
2760 
2761  /* Forget it if we're not dealing with a btree index */
2762  if (index->relam != BTREE_AM_OID)
2763  return NULL;
2764 
2765  index_relid = index->rel->relid;
2766  opfamily = index->opfamily[indexcol];
2767  idxcollation = index->indexcollations[indexcol];
2768 
2769  /*
2770  * We could do the matching on the basis of insisting that the opfamily
2771  * shown in the RowCompareExpr be the same as the index column's opfamily,
2772  * but that could fail in the presence of reverse-sort opfamilies: it'd be
2773  * a matter of chance whether RowCompareExpr had picked the forward or
2774  * reverse-sort family. So look only at the operator, and match if it is
2775  * a member of the index's opfamily (after commutation, if the indexkey is
2776  * on the right). We'll worry later about whether any additional
2777  * operators are matchable to the index.
2778  */
2779  leftop = (Node *) linitial(clause->largs);
2780  rightop = (Node *) linitial(clause->rargs);
2781  expr_op = linitial_oid(clause->opnos);
2782  expr_coll = linitial_oid(clause->inputcollids);
2783 
2784  /* Collations must match, if relevant */
2785  if (!IndexCollMatchesExprColl(idxcollation, expr_coll))
2786  return NULL;
2787 
2788  /*
2789  * These syntactic tests are the same as in match_opclause_to_indexcol()
2790  */
2791  if (match_index_to_operand(leftop, indexcol, index) &&
2792  !bms_is_member(index_relid, pull_varnos(root, rightop)) &&
2793  !contain_volatile_functions(rightop))
2794  {
2795  /* OK, indexkey is on left */
2796  var_on_left = true;
2797  }
2798  else if (match_index_to_operand(rightop, indexcol, index) &&
2799  !bms_is_member(index_relid, pull_varnos(root, leftop)) &&
2800  !contain_volatile_functions(leftop))
2801  {
2802  /* indexkey is on right, so commute the operator */
2803  expr_op = get_commutator(expr_op);
2804  if (expr_op == InvalidOid)
2805  return NULL;
2806  var_on_left = false;
2807  }
2808  else
2809  return NULL;
2810 
2811  /* We're good if the operator is the right type of opfamily member */
2812  switch (get_op_opfamily_strategy(expr_op, opfamily))
2813  {
2814  case BTLessStrategyNumber:
2815  case BTLessEqualStrategyNumber:
2816  case BTGreaterEqualStrategyNumber:
2817  case BTGreaterStrategyNumber:
2818  return expand_indexqual_rowcompare(root,
2819  rinfo,
2820  indexcol,
2821  index,
2822  expr_op,
2823  var_on_left);
2824  }
2825 
2826  return NULL;
2827 }
2828 
2829 /*
2830  * expand_indexqual_rowcompare --- expand a single indexqual condition
2831  * that is a RowCompareExpr
2832  *
2833  * It's already known that the first column of the row comparison matches
2834  * the specified column of the index. We can use additional columns of the
2835  * row comparison as index qualifications, so long as they match the index
2836  * in the "same direction", ie, the indexkeys are all on the same side of the
2837  * clause and the operators are all the same-type members of the opfamilies.
2838  *
2839  * If all the columns of the RowCompareExpr match in this way, we just use it
2840  * as-is, except for possibly commuting it to put the indexkeys on the left.
2841  *
2842  * Otherwise, we build a shortened RowCompareExpr (if more than one
2843  * column matches) or a simple OpExpr (if the first-column match is all
2844  * there is). In these cases the modified clause is always "<=" or ">="
2845  * even when the original was "<" or ">" --- this is necessary to match all
2846  * the rows that could match the original. (We are building a lossy version
2847  * of the row comparison when we do this, so we set lossy = true.)
2848  *
2849  * Note: this is really just the last half of match_rowcompare_to_indexcol,
2850  * but we split it out for comprehensibility.
2851  */
2852 static IndexClause *
2853 expand_indexqual_rowcompare(PlannerInfo *root,
2854  RestrictInfo *rinfo,
2855  int indexcol,
2856  IndexOptInfo *index,
2857  Oid expr_op,
2858  bool var_on_left)
2859 {
2860  IndexClause *iclause = makeNode(IndexClause);
2861  RowCompareExpr *clause = (RowCompareExpr *) rinfo->clause;
2862  int op_strategy;
2863  Oid op_lefttype;
2864  Oid op_righttype;
2865  int matching_cols;
2866  List *expr_ops;
2867  List *opfamilies;
2868  List *lefttypes;
2869  List *righttypes;
2870  List *new_ops;
2871  List *var_args;
2872  List *non_var_args;
2873 
2874  iclause->rinfo = rinfo;
2875  iclause->indexcol = indexcol;
2876 
2877  if (var_on_left)
2878  {
2879  var_args = clause->largs;
2880  non_var_args = clause->rargs;
2881  }
2882  else
2883  {
2884  var_args = clause->rargs;
2885  non_var_args = clause->largs;
2886  }
2887 
2888  get_op_opfamily_properties(expr_op, index->opfamily[indexcol], false,
2889  &op_strategy,
2890  &op_lefttype,
2891  &op_righttype);
2892 
2893  /* Initialize returned list of which index columns are used */
2894  iclause->indexcols = list_make1_int(indexcol);
2895 
2896  /* Build lists of ops, opfamilies and operator datatypes in case needed */
2897  expr_ops = list_make1_oid(expr_op);
2898  opfamilies = list_make1_oid(index->opfamily[indexcol]);
2899  lefttypes = list_make1_oid(op_lefttype);
2900  righttypes = list_make1_oid(op_righttype);
2901 
2902  /*
2903  * See how many of the remaining columns match some index column in the
2904  * same way. As in match_clause_to_indexcol(), the "other" side of any
2905  * potential index condition is OK as long as it doesn't use Vars from the
2906  * indexed relation.
2907  */
2908  matching_cols = 1;
2909 
2910  while (matching_cols < list_length(var_args))
2911  {
2912  Node *varop = (Node *) list_nth(var_args, matching_cols);
2913  Node *constop = (Node *) list_nth(non_var_args, matching_cols);
2914  int i;
2915 
2916  expr_op = list_nth_oid(clause->opnos, matching_cols);
2917  if (!var_on_left)
2918  {
2919  /* indexkey is on right, so commute the operator */
2920  expr_op = get_commutator(expr_op);
2921  if (expr_op == InvalidOid)
2922  break; /* operator is not usable */
2923  }
2924  if (bms_is_member(index->rel->relid, pull_varnos(root, constop)))
2925  break; /* no good, Var on wrong side */
2926  if (contain_volatile_functions(constop))
2927  break; /* no good, volatile comparison value */
2928 
2929  /*
2930  * The Var side can match any key column of the index.
2931  */
2932  for (i = 0; i < index->nkeycolumns; i++)
2933  {
2934  if (match_index_to_operand(varop, i, index) &&
2935  get_op_opfamily_strategy(expr_op,
2936  index->opfamily[i]) == op_strategy &&
2937  IndexCollMatchesExprColl(index->indexcollations[i],
2938  list_nth_oid(clause->inputcollids,
2939  matching_cols)))
2940  break;
2941  }
2942  if (i >= index->nkeycolumns)
2943  break; /* no match found */
2944 
2945  /* Add column number to returned list */
2946  iclause->indexcols = lappend_int(iclause->indexcols, i);
2947 
2948  /* Add operator info to lists */
2949  get_op_opfamily_properties(expr_op, index->opfamily[i], false,
2950  &op_strategy,
2951  &op_lefttype,
2952  &op_righttype);
2953  expr_ops = lappend_oid(expr_ops, expr_op);
2954  opfamilies = lappend_oid(opfamilies, index->opfamily[i]);
2955  lefttypes = lappend_oid(lefttypes, op_lefttype);
2956  righttypes = lappend_oid(righttypes, op_righttype);
2957 
2958  /* This column matches, keep scanning */
2959  matching_cols++;
2960  }
2961 
2962  /* Result is non-lossy if all columns are usable as index quals */
2963  iclause->lossy = (matching_cols != list_length(clause->opnos));
2964 
2965  /*
2966  * We can use rinfo->clause as-is if we have var on left and it's all
2967  * usable as index quals.
2968  */
2969  if (var_on_left && !iclause->lossy)
2970  iclause->indexquals = list_make1(rinfo);
2971  else
2972  {
2973  /*
2974  * We have to generate a modified rowcompare (possibly just one
2975  * OpExpr). The painful part of this is changing < to <= or > to >=,
2976  * so deal with that first.
2977  */
2978  if (!iclause->lossy)
2979  {
2980  /* very easy, just use the commuted operators */
2981  new_ops = expr_ops;
2982  }
2983  else if (op_strategy == BTLessEqualStrategyNumber ||
2984  op_strategy == BTGreaterEqualStrategyNumber)
2985  {
2986  /* easy, just use the same (possibly commuted) operators */
2987  new_ops = list_truncate(expr_ops, matching_cols);
2988  }
2989  else
2990  {
2991  ListCell *opfamilies_cell;
2992  ListCell *lefttypes_cell;
2993  ListCell *righttypes_cell;
2994 
2995  if (op_strategy == BTLessStrategyNumber)
2996  op_strategy = BTLessEqualStrategyNumber;
2997  else if (op_strategy == BTGreaterStrategyNumber)
2998  op_strategy = BTGreaterEqualStrategyNumber;
2999  else
3000  elog(ERROR, "unexpected strategy number %d", op_strategy);
3001  new_ops = NIL;
3002  forthree(opfamilies_cell, opfamilies,
3003  lefttypes_cell, lefttypes,
3004  righttypes_cell, righttypes)
3005  {
3006  Oid opfam = lfirst_oid(opfamilies_cell);
3007  Oid lefttype = lfirst_oid(lefttypes_cell);
3008  Oid righttype = lfirst_oid(righttypes_cell);
3009 
3010  expr_op = get_opfamily_member(opfam, lefttype, righttype,
3011  op_strategy);
3012  if (!OidIsValid(expr_op)) /* should not happen */
3013  elog(ERROR, "missing operator %d(%u,%u) in opfamily %u",
3014  op_strategy, lefttype, righttype, opfam);
3015  new_ops = lappend_oid(new_ops, expr_op);
3016  }
3017  }
3018 
3019  /* If we have more than one matching col, create a subset rowcompare */
3020  if (matching_cols > 1)
3021  {
3022  RowCompareExpr *rc = makeNode(RowCompareExpr);
3023 
3024  rc->rctype = (RowCompareType) op_strategy;
3025  rc->opnos = new_ops;
3026  rc->opfamilies = list_copy_head(clause->opfamilies,
3027  matching_cols);
3028  rc->inputcollids = list_copy_head(clause->inputcollids,
3029  matching_cols);
3030  rc->largs = list_copy_head(var_args, matching_cols);
3031  rc->rargs = list_copy_head(non_var_args, matching_cols);
3032  iclause->indexquals = list_make1(make_simple_restrictinfo(root,
3033  (Expr *) rc));
3034  }
3035  else
3036  {
3037  Expr *op;
3038 
3039  /* We don't report an index column list in this case */
3040  iclause->indexcols = NIL;
3041 
3042  op = make_opclause(linitial_oid(new_ops), BOOLOID, false,
3043  copyObject(linitial(var_args)),
3044  copyObject(linitial(non_var_args)),
3045  InvalidOid,
3046  linitial_oid(clause->inputcollids));
3047  iclause->indexquals = list_make1(make_simple_restrictinfo(root, op));
3048  }
3049  }
3050 
3051  return iclause;
3052 }
3053 
3054 
3055 /****************************************************************************
3056  * ---- ROUTINES TO CHECK ORDERING OPERATORS ----
3057  ****************************************************************************/
3058 
3059 /*
3060  * match_pathkeys_to_index
3061  * Test whether an index can produce output ordered according to the
3062  * given pathkeys using "ordering operators".
3063  *
3064  * If it can, return a list of suitable ORDER BY expressions, each of the form
3065  * "indexedcol operator pseudoconstant", along with an integer list of the
3066  * index column numbers (zero based) that each clause would be used with.
3067  * NIL lists are returned if the ordering is not achievable this way.
3068  *
3069  * On success, the result list is ordered by pathkeys, and in fact is
3070  * one-to-one with the requested pathkeys.
3071  */
3072 static void
3073 match_pathkeys_to_index(IndexOptInfo *index, List *pathkeys,
3074  List **orderby_clauses_p,
3075  List **clause_columns_p)
3076 {
3077  List *orderby_clauses = NIL;
3078  List *clause_columns = NIL;
3079  ListCell *lc1;
3080 
3081  *orderby_clauses_p = NIL; /* set default results */
3082  *clause_columns_p = NIL;
3083 
3084  /* Only indexes with the amcanorderbyop property are interesting here */
3085  if (!index->amcanorderbyop)
3086  return;
3087 
3088  foreach(lc1, pathkeys)
3089  {
3090  PathKey *pathkey = (PathKey *) lfirst(lc1);
3091  bool found = false;
3092  ListCell *lc2;
3093 
3094  /*
3095  * Note: for any failure to match, we just return NIL immediately.
3096  * There is no value in matching just some of the pathkeys.
3097  */
3098 
3099  /* Pathkey must request default sort order for the target opfamily */
3100  if (pathkey->pk_strategy != BTLessStrategyNumber ||
3101  pathkey->pk_nulls_first)
3102  return;
3103 
3104  /* If eclass is volatile, no hope of using an indexscan */
3105  if (pathkey->pk_eclass->ec_has_volatile)
3106  return;
3107 
3108  /*
3109  * Try to match eclass member expression(s) to index. Note that child
3110  * EC members are considered, but only when they belong to the target
3111  * relation. (Unlike regular members, the same expression could be a
3112  * child member of more than one EC. Therefore, the same index could
3113  * be considered to match more than one pathkey list, which is OK
3114  * here. See also get_eclass_for_sort_expr.)
3115  */
3116  foreach(lc2, pathkey->pk_eclass->ec_members)
3117  {
3118  EquivalenceMember *member = (EquivalenceMember *) lfirst(lc2);
3119  int indexcol;
3120 
3121  /* No possibility of match if it references other relations */
3122  if (!bms_equal(member->em_relids, index->rel->relids))
3123  continue;
3124 
3125  /*
3126  * We allow any column of the index to match each pathkey; they
3127  * don't have to match left-to-right as you might expect. This is
3128  * correct for GiST, and it doesn't matter for SP-GiST because
3129  * that doesn't handle multiple columns anyway, and no other
3130  * existing AMs support amcanorderbyop. We might need different
3131  * logic in future for other implementations.
3132  */
3133  for (indexcol = 0; indexcol < index->nkeycolumns; indexcol++)
3134  {
3135  Expr *expr;
3136 
3137  expr = match_clause_to_ordering_op(index,
3138  indexcol,
3139  member->em_expr,
3140  pathkey->pk_opfamily);
3141  if (expr)
3142  {
3143  orderby_clauses = lappend(orderby_clauses, expr);
3144  clause_columns = lappend_int(clause_columns, indexcol);
3145  found = true;
3146  break;
3147  }
3148  }
3149 
3150  if (found) /* don't want to look at remaining members */
3151  break;
3152  }
3153 
3154  if (!found) /* fail if no match for this pathkey */
3155  return;
3156  }
3157 
3158  *orderby_clauses_p = orderby_clauses; /* success! */
3159  *clause_columns_p = clause_columns;
3160 }
3161 
3162 /*
3163  * match_clause_to_ordering_op
3164  * Determines whether an ordering operator expression matches an
3165  * index column.
3166  *
3167  * This is similar to, but simpler than, match_clause_to_indexcol.
3168  * We only care about simple OpExpr cases. The input is a bare
3169  * expression that is being ordered by, which must be of the form
3170  * (indexkey op const) or (const op indexkey) where op is an ordering
3171  * operator for the column's opfamily.
3172  *
3173  * 'index' is the index of interest.
3174  * 'indexcol' is a column number of 'index' (counting from 0).
3175  * 'clause' is the ordering expression to be tested.
3176  * 'pk_opfamily' is the btree opfamily describing the required sort order.
3177  *
3178  * Note that we currently do not consider the collation of the ordering
3179  * operator's result. In practical cases the result type will be numeric
3180  * and thus have no collation, and it's not very clear what to match to
3181  * if it did have a collation. The index's collation should match the
3182  * ordering operator's input collation, not its result.
3183  *
3184  * If successful, return 'clause' as-is if the indexkey is on the left,
3185  * otherwise a commuted copy of 'clause'. If no match, return NULL.
3186  */
3187 static Expr *
3188 match_clause_to_ordering_op(IndexOptInfo *index,
3189  int indexcol,
3190  Expr *clause,
3191  Oid pk_opfamily)
3192 {
3193  Oid opfamily;
3194  Oid idxcollation;
3195  Node *leftop,
3196  *rightop;
3197  Oid expr_op;
3198  Oid expr_coll;
3199  Oid sortfamily;
3200  bool commuted;
3201 
3202  Assert(indexcol < index->nkeycolumns);
3203 
3204  opfamily = index->opfamily[indexcol];
3205  idxcollation = index->indexcollations[indexcol];
3206 
3207  /*
3208  * Clause must be a binary opclause.
3209  */
3210  if (!is_opclause(clause))
3211  return NULL;
3212  leftop = get_leftop(clause);
3213  rightop = get_rightop(clause);
3214  if (!leftop || !rightop)
3215  return NULL;
3216  expr_op = ((OpExpr *) clause)->opno;
3217  expr_coll = ((OpExpr *) clause)->inputcollid;
3218 
3219  /*
3220  * We can forget the whole thing right away if wrong collation.
3221  */
3222  if (!IndexCollMatchesExprColl(idxcollation, expr_coll))
3223  return NULL;
3224 
3225  /*
3226  * Check for clauses of the form: (indexkey operator constant) or
3227  * (constant operator indexkey).
3228  */
3229  if (match_index_to_operand(leftop, indexcol, index) &&
3230  !contain_var_clause(rightop) &&
3231  !contain_volatile_functions(rightop))
3232  {
3233  commuted = false;
3234  }
3235  else if (match_index_to_operand(rightop, indexcol, index) &&
3236  !contain_var_clause(leftop) &&
3237  !contain_volatile_functions(leftop))
3238  {
3239  /* Might match, but we need a commuted operator */
3240  expr_op = get_commutator(expr_op);
3241  if (expr_op == InvalidOid)
3242  return NULL;
3243  commuted = true;
3244  }
3245  else
3246  return NULL;
3247 
3248  /*
3249  * Is the (commuted) operator an ordering operator for the opfamily? And
3250  * if so, does it yield the right sorting semantics?
3251  */
3252  sortfamily = get_op_opfamily_sortfamily(expr_op, opfamily);
3253  if (sortfamily != pk_opfamily)
3254  return NULL;
3255 
3256  /* We have a match. Return clause or a commuted version thereof. */
3257  if (commuted)
3258  {
3259  OpExpr *newclause = makeNode(OpExpr);
3260 
3261  /* flat-copy all the fields of clause */
3262  memcpy(newclause, clause, sizeof(OpExpr));
3263 
3264  /* commute it */
3265  newclause->opno = expr_op;
3266  newclause->opfuncid = InvalidOid;
3267  newclause->args = list_make2(rightop, leftop);
3268 
3269  clause = (Expr *) newclause;
3270  }
3271 
3272  return clause;
3273 }
3274 
3275 
3276 /****************************************************************************
3277  * ---- ROUTINES TO DO PARTIAL INDEX PREDICATE TESTS ----
3278  ****************************************************************************/
3279 
3280 /*
3281  * check_index_predicates
3282  * Set the predicate-derived IndexOptInfo fields for each index
3283  * of the specified relation.
3284  *
3285  * predOK is set true if the index is partial and its predicate is satisfied
3286  * for this query, ie the query's WHERE clauses imply the predicate.
3287  *
3288  * indrestrictinfo is set to the relation's baserestrictinfo list less any
3289  * conditions that are implied by the index's predicate. (Obviously, for a
3290  * non-partial index, this is the same as baserestrictinfo.) Such conditions
3291  * can be dropped from the plan when using the index, in certain cases.
3292  *
3293  * At one time it was possible for this to get re-run after adding more
3294  * restrictions to the rel, thus possibly letting us prove more indexes OK.
3295  * That doesn't happen any more (at least not in the core code's usage),
3296  * but this code still supports it in case extensions want to mess with the
3297  * baserestrictinfo list. We assume that adding more restrictions can't make
3298  * an index not predOK. We must recompute indrestrictinfo each time, though,
3299  * to make sure any newly-added restrictions get into it if needed.
3300  */
3301 void
3302 check_index_predicates(PlannerInfo *root, RelOptInfo *rel)
3303 {
3304  List *clauselist;
3305  bool have_partial;
3306  bool is_target_rel;
3307  Relids otherrels;
3308  ListCell *lc;
3309 
3310  /* Indexes are available only on base or "other" member relations. */
3311  Assert(IS_SIMPLE_REL(rel));
3312 
3313  /*
3314  * Initialize the indrestrictinfo lists to be identical to
3315  * baserestrictinfo, and check whether there are any partial indexes. If
3316  * not, this is all we need to do.
3317  */
3318  have_partial = false;
3319  foreach(lc, rel->indexlist)
3320  {
3321  IndexOptInfo *index = (IndexOptInfo *) lfirst(lc);
3322 
3323  index->indrestrictinfo = rel->baserestrictinfo;
3324  if (index->indpred)
3325  have_partial = true;
3326  }
3327  if (!have_partial)
3328  return;
3329 
3330  /*
3331  * Construct a list of clauses that we can assume true for the purpose of
3332  * proving the index(es) usable. Restriction clauses for the rel are
3333  * always usable, and so are any join clauses that are "movable to" this
3334  * rel. Also, we can consider any EC-derivable join clauses (which must
3335  * be "movable to" this rel, by definition).
3336  */
3337  clauselist = list_copy(rel->baserestrictinfo);
3338 
3339  /* Scan the rel's join clauses */
3340  foreach(lc, rel->joininfo)
3341  {
3342  RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
3343 
3344  /* Check if clause can be moved to this rel */
3345  if (!join_clause_is_movable_to(rinfo, rel))
3346  continue;
3347 
3348  clauselist = lappend(clauselist, rinfo);
3349  }
3350 
3351  /*
3352  * Add on any equivalence-derivable join clauses. Computing the correct
3353  * relid sets for generate_join_implied_equalities is slightly tricky
3354  * because the rel could be a child rel rather than a true baserel, and in
3355  * that case we must remove its parents' relid(s) from all_baserels.
3356  */
3357  if (rel->reloptkind == RELOPT_OTHER_MEMBER_REL)
3358  otherrels = bms_difference(root->all_baserels,
3359  find_childrel_parents(root, rel));
3360  else
3361  otherrels = bms_difference(root->all_baserels, rel->relids);
3362 
3363  if (!bms_is_empty(otherrels))
3364  clauselist =
3365  list_concat(clauselist,
3366  generate_join_implied_equalities(root,
3367  bms_union(rel->relids,
3368  otherrels),
3369  otherrels,
3370  rel));
3371 
3372  /*
3373  * Normally we remove quals that are implied by a partial index's
3374  * predicate from indrestrictinfo, indicating that they need not be
3375  * checked explicitly by an indexscan plan using this index. However, if
3376  * the rel is a target relation of UPDATE/DELETE/MERGE/SELECT FOR UPDATE,
3377  * we cannot remove such quals from the plan, because they need to be in
3378  * the plan so that they will be properly rechecked by EvalPlanQual
3379  * testing. Some day we might want to remove such quals from the main
3380  * plan anyway and pass them through to EvalPlanQual via a side channel;
3381  * but for now, we just don't remove implied quals at all for target
3382  * relations.
3383  */
3384  is_target_rel = (bms_is_member(rel->relid, root->all_result_relids) ||
3385  get_plan_rowmark(root->rowMarks, rel->relid) != NULL);
3386 
3387  /*
3388  * Now try to prove each index predicate true, and compute the
3389  * indrestrictinfo lists for partial indexes. Note that we compute the
3390  * indrestrictinfo list even for non-predOK indexes; this might seem
3391  * wasteful, but we may be able to use such indexes in OR clauses, cf
3392  * generate_bitmap_or_paths().
3393  */
3394  foreach(lc, rel->indexlist)
3395  {
3396  IndexOptInfo *index = (IndexOptInfo *) lfirst(lc);
3397  ListCell *lcr;
3398 
3399  if (index->indpred == NIL)
3400  continue; /* ignore non-partial indexes here */
3401 
3402  if (!index->predOK) /* don't repeat work if already proven OK */
3403  index->predOK = predicate_implied_by(index->indpred, clauselist,
3404  false);
3405 
3406  /* If rel is an update target, leave indrestrictinfo as set above */
3407  if (is_target_rel)
3408  continue;
3409 
3410  /* Else compute indrestrictinfo as the non-implied quals */
3411  index->indrestrictinfo = NIL;
3412  foreach(lcr, rel->baserestrictinfo)
3413  {
3414  RestrictInfo *rinfo = (RestrictInfo *) lfirst(lcr);
3415 
3416  /* predicate_implied_by() assumes first arg is immutable */
3417  if (contain_mutable_functions((Node *) rinfo->clause) ||
3418  !predicate_implied_by(list_make1(rinfo->clause),
3419  index->indpred, false))
3420  index->indrestrictinfo = lappend(index->indrestrictinfo, rinfo);
3421  }
3422  }
3423 }
3424 
3425 /****************************************************************************
3426  * ---- ROUTINES TO CHECK EXTERNALLY-VISIBLE CONDITIONS ----
3427  ****************************************************************************/
3428 
3429 /*
3430  * ec_member_matches_indexcol
3431  * Test whether an EquivalenceClass member matches an index column.
3432  *
3433  * This is a callback for use by generate_implied_equalities_for_column.
3434  */
3435 static bool
3436 ec_member_matches_indexcol(PlannerInfo *root, RelOptInfo *rel,
3437  EquivalenceClass *ec, EquivalenceMember *em,
3438  void *arg)
3439 {
3440  IndexOptInfo *index = ((ec_member_matches_arg *) arg)->index;
3441  int indexcol = ((ec_member_matches_arg *) arg)->indexcol;
3442  Oid curFamily;
3443  Oid curCollation;
3444 
3445  Assert(indexcol < index->nkeycolumns);
3446 
3447  curFamily = index->opfamily[indexcol];
3448  curCollation = index->indexcollations[indexcol];
3449 
3450  /*
3451  * If it's a btree index, we can reject it if its opfamily isn't
3452  * compatible with the EC, since no clause generated from the EC could be
3453  * used with the index. For non-btree indexes, we can't easily tell
3454  * whether clauses generated from the EC could be used with the index, so
3455  * don't check the opfamily. This might mean we return "true" for a
3456  * useless EC, so we have to recheck the results of
3457  * generate_implied_equalities_for_column; see
3458  * match_eclass_clauses_to_index.
3459  */
3460  if (index->relam == BTREE_AM_OID &&
3461  !list_member_oid(ec->ec_opfamilies, curFamily))
3462  return false;
3463 
3464  /* We insist on collation match for all index types, though */
3465  if (!IndexCollMatchesExprColl(curCollation, ec->ec_collation))
3466  return false;
3467 
3468  return match_index_to_operand((Node *) em->em_expr, indexcol, index);
3469 }
3470 
3471 /*
3472  * relation_has_unique_index_for
3473  * Determine whether the relation provably has at most one row satisfying
3474  * a set of equality conditions, because the conditions constrain all
3475  * columns of some unique index.
3476  *
3477  * The conditions can be represented in either or both of two ways:
3478  * 1. A list of RestrictInfo nodes, where the caller has already determined
3479  * that each condition is a mergejoinable equality with an expression in
3480  * this relation on one side, and an expression not involving this relation
3481  * on the other. The transient outer_is_left flag is used to identify which
3482  * side we should look at: left side if outer_is_left is false, right side
3483  * if it is true.
3484  * 2. A list of expressions in this relation, and a corresponding list of
3485  * equality operators. The caller must have already checked that the operators
3486  * represent equality. (Note: the operators could be cross-type; the
3487  * expressions should correspond to their RHS inputs.)
3488  *
3489  * The caller need only supply equality conditions arising from joins;
3490  * this routine automatically adds in any usable baserestrictinfo clauses.
3491  * (Note that the passed-in restrictlist will be destructively modified!)
3492  */
3493 bool
3494 relation_has_unique_index_for(PlannerInfo *root, RelOptInfo *rel,
3495  List *restrictlist,
3496  List *exprlist, List *oprlist)
3497 {
3498  ListCell *ic;
3499 
3500  Assert(list_length(exprlist) == list_length(oprlist));
3501 
3502  /* Short-circuit if no indexes... */
3503  if (rel->indexlist == NIL)
3504  return false;
3505 
3506  /*
3507  * Examine the rel's restriction clauses for usable var = const clauses
3508  * that we can add to the restrictlist.
3509  */
3510  foreach(ic, rel->baserestrictinfo)
3511  {
3512  RestrictInfo *restrictinfo = (RestrictInfo *) lfirst(ic);
3513 
3514  /*
3515  * Note: can_join won't be set for a restriction clause, but
3516  * mergeopfamilies will be if it has a mergejoinable operator and
3517  * doesn't contain volatile functions.
3518  */
3519  if (restrictinfo->mergeopfamilies == NIL)
3520  continue; /* not mergejoinable */
3521 
3522  /*
3523  * The clause certainly doesn't refer to anything but the given rel.
3524  * If either side is pseudoconstant then we can use it.
3525  */
3526  if (bms_is_empty(restrictinfo->left_relids))
3527  {
3528  /* righthand side is inner */
3529  restrictinfo->outer_is_left = true;
3530  }
3531  else if (bms_is_empty(restrictinfo->right_relids))
3532  {
3533  /* lefthand side is inner */
3534  restrictinfo->outer_is_left = false;
3535  }
3536  else
3537  continue;
3538 
3539  /* OK, add to list */
3540  restrictlist = lappend(restrictlist, restrictinfo);
3541  }
3542 
3543  /* Short-circuit the easy case */
3544  if (restrictlist == NIL && exprlist == NIL)
3545  return false;
3546 
3547  /* Examine each index of the relation ... */
3548  foreach(ic, rel->indexlist)
3549  {
3550  IndexOptInfo *ind = (IndexOptInfo *) lfirst(ic);
3551  int c;
3552 
3553  /*
3554  * If the index is not unique, or not immediately enforced, or if it's
3555  * a partial index that doesn't match the query, it's useless here.
3556  */
3557  if (!ind->unique || !ind->immediate ||
3558  (ind->indpred != NIL && !ind->predOK))
3559  continue;
3560 
3561  /*
3562  * Try to find each index column in the lists of conditions. This is
3563  * O(N^2) or worse, but we expect all the lists to be short.
3564  */
3565  for (c = 0; c < ind->nkeycolumns; c++)
3566  {
3567  bool matched = false;
3568  ListCell *lc;
3569  ListCell *lc2;
3570 
3571  foreach(lc, restrictlist)
3572  {
3573  RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
3574  Node *rexpr;
3575 
3576  /*
3577  * The condition's equality operator must be a member of the
3578  * index opfamily, else it is not asserting the right kind of
3579  * equality behavior for this index. We check this first
3580  * since it's probably cheaper than match_index_to_operand().
3581  */
3582  if (!list_member_oid(rinfo->mergeopfamilies, ind->opfamily[c]))
3583  continue;
3584 
3585  /*
3586  * XXX at some point we may need to check collations here too.
3587  * For the moment we assume all collations reduce to the same
3588  * notion of equality.
3589  */
3590 
3591  /* OK, see if the condition operand matches the index key */
3592  if (rinfo->outer_is_left)
3593  rexpr = get_rightop(rinfo->clause);
3594  else
3595  rexpr = get_leftop(rinfo->clause);
3596 
3597  if (match_index_to_operand(rexpr, c, ind))
3598  {
3599  matched = true; /* column is unique */
3600  break;
3601  }
3602  }
3603 
3604  if (matched)
3605  continue;
3606 
3607  forboth(lc, exprlist, lc2, oprlist)
3608  {
3609  Node *expr = (Node *) lfirst(lc);
3610  Oid opr = lfirst_oid(lc2);
3611 
3612  /* See if the expression matches the index key */
3613  if (!match_index_to_operand(expr, c, ind))
3614  continue;
3615 
3616  /*
3617  * The equality operator must be a member of the index
3618  * opfamily, else it is not asserting the right kind of
3619  * equality behavior for this index. We assume the caller
3620  * determined it is an equality operator, so we don't need to
3621  * check any more tightly than this.
3622  */
3623  if (!op_in_opfamily(opr, ind->opfamily[c]))
3624  continue;
3625 
3626  /*
3627  * XXX at some point we may need to check collations here too.
3628  * For the moment we assume all collations reduce to the same
3629  * notion of equality.
3630  */
3631 
3632  matched = true; /* column is unique */
3633  break;
3634  }
3635 
3636  if (!matched)
3637  break; /* no match; this index doesn't help us */
3638  }
3639 
3640  /* Matched all key columns of this index? */
3641  if (c == ind->nkeycolumns)
3642  return true;
3643  }
3644 
3645  return false;
3646 }
3647 
3648 /*
3649  * indexcol_is_bool_constant_for_query
3650  *
3651  * If an index column is constrained to have a constant value by the query's
3652  * WHERE conditions, then it's irrelevant for sort-order considerations.
3653  * Usually that means we have a restriction clause WHERE indexcol = constant,
3654  * which gets turned into an EquivalenceClass containing a constant, which
3655  * is recognized as redundant by build_index_pathkeys(). But if the index
3656  * column is a boolean variable (or expression), then we are not going to
3657  * see WHERE indexcol = constant, because expression preprocessing will have
3658  * simplified that to "WHERE indexcol" or "WHERE NOT indexcol". So we are not
3659  * going to have a matching EquivalenceClass (unless the query also contains
3660  * "ORDER BY indexcol"). To allow such cases to work the same as they would
3661  * for non-boolean values, this function is provided to detect whether the
3662  * specified index column matches a boolean restriction clause.
3663  */
3664 bool
3665 indexcol_is_bool_constant_for_query(PlannerInfo *root,
3666  IndexOptInfo *index,
3667  int indexcol)
3668 {
3669  ListCell *lc;
3670 
3671  /* If the index isn't boolean, we can't possibly get a match */
3672  if (!IsBooleanOpfamily(index->opfamily[indexcol]))
3673  return false;
3674 
3675  /* Check each restriction clause for the index's rel */
3676  foreach(lc, index->rel->baserestrictinfo)
3677  {
3678  RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
3679 
3680  /*
3681  * As in match_clause_to_indexcol, never match pseudoconstants to
3682  * indexes. (It might be semantically okay to do so here, but the
3683  * odds of getting a match are negligible, so don't waste the cycles.)
3684  */
3685  if (rinfo->pseudoconstant)
3686  continue;
3687 
3688  /* See if we can match the clause's expression to the index column */
3689  if (match_boolean_index_clause(root, rinfo, indexcol, index))
3690  return true;
3691  }
3692 
3693  return false;
3694 }
3695 
3696 
3697 /****************************************************************************
3698  * ---- ROUTINES TO CHECK OPERANDS ----
3699  ****************************************************************************/
3700 
3701 /*
3702  * match_index_to_operand()
3703  * Generalized test for a match between an index's key
3704  * and the operand on one side of a restriction or join clause.
3705  *
3706  * operand: the nodetree to be compared to the index
3707  * indexcol: the column number of the index (counting from 0)
3708  * index: the index of interest
3709  *
3710  * Note that we aren't interested in collations here; the caller must check
3711  * for a collation match, if it's dealing with an operator where that matters.
3712  *
3713  * This is exported for use in selfuncs.c.
3714  */
3715 bool
3716 match_index_to_operand(Node *operand,
3717  int indexcol,
3718  IndexOptInfo *index)
3719 {
3720  int indkey;
3721 
3722  /*
3723  * Ignore any RelabelType node above the operand. This is needed to be
3724  * able to apply indexscanning in binary-compatible-operator cases. Note:
3725  * we can assume there is at most one RelabelType node;
3726  * eval_const_expressions() will have simplified if more than one.
3727  */
3728  if (operand && IsA(operand, RelabelType))
3729  operand = (Node *) ((RelabelType *) operand)->arg;
3730 
3731  indkey = index->indexkeys[indexcol];
3732  if (indkey != 0)
3733  {
3734  /*
3735  * Simple index column; operand must be a matching Var.
3736  */
3737  if (operand && IsA(operand, Var) &&
3738  index->rel->relid == ((Var *) operand)->varno &&
3739  indkey == ((Var *) operand)->varattno)
3740  return true;
3741  }
3742  else
3743  {
3744  /*
3745  * Index expression; find the correct expression. (This search could
3746  * be avoided, at the cost of complicating all the callers of this
3747  * routine; doesn't seem worth it.)
3748  */
3749  ListCell *indexpr_item;
3750  int i;
3751  Node *indexkey;
3752 
3753  indexpr_item = list_head(index->indexprs);
3754  for (i = 0; i < indexcol; i++)
3755  {
3756  if (index->indexkeys[i] == 0)
3757  {
3758  if (indexpr_item == NULL)
3759  elog(ERROR, "wrong number of index expressions");
3760  indexpr_item = lnext(index->indexprs, indexpr_item);
3761  }
3762  }
3763  if (indexpr_item == NULL)
3764  elog(ERROR, "wrong number of index expressions");
3765  indexkey = (Node *) lfirst(indexpr_item);
3766 
3767  /*
3768  * Does it match the operand? Again, strip any relabeling.
3769  */
3770  if (indexkey && IsA(indexkey, RelabelType))
3771  indexkey = (Node *) ((RelabelType *) indexkey)->arg;
3772 
3773  if (equal(indexkey, operand))
3774  return true;
3775  }
3776 
3777  return false;
3778 }
3779 
3780 /*
3781  * is_pseudo_constant_for_index()
3782  * Test whether the given expression can be used as an indexscan
3783  * comparison value.
3784  *
3785  * An indexscan comparison value must not contain any volatile functions,
3786  * and it can't contain any Vars of the index's own table. Vars of
3787  * other tables are okay, though; in that case we'd be producing an
3788  * indexqual usable in a parameterized indexscan. This is, therefore,
3789  * a weaker condition than is_pseudo_constant_clause().
3790  *
3791  * This function is exported for use by planner support functions,
3792  * which will have available the IndexOptInfo, but not any RestrictInfo
3793  * infrastructure. It is making the same test made by functions above
3794  * such as match_opclause_to_indexcol(), but those rely where possible
3795  * on RestrictInfo information about variable membership.
3796  *
3797  * expr: the nodetree to be checked
3798  * index: the index of interest
3799  */
3800 bool
3801 is_pseudo_constant_for_index(PlannerInfo *root, Node *expr, IndexOptInfo *index)
3802 {
3803  /* pull_varnos is cheaper than volatility check, so do that first */
3804  if (bms_is_member(index->rel->relid, pull_varnos(root, expr)))
3805  return false; /* no good, contains Var of table */
3806  if (contain_volatile_functions(expr))
3807  return false; /* no good, volatile comparison value */
3808  return true;
3809 }
create_partial_bitmap_paths
void create_partial_bitmap_paths(PlannerInfo *root, RelOptInfo *rel, Path *bitmapqual)
Definition: allpaths.c:4131
bms_equal
bool bms_equal(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:94
bms_subset_compare
BMS_Comparison bms_subset_compare(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:353
bms_next_member
int bms_next_member(const Bitmapset *a, int prevbit)
Definition: bitmapset.c:1047
bms_is_subset
bool bms_is_subset(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:316
bms_free
void bms_free(Bitmapset *a)
Definition: bitmapset.c:209
bms_is_member
bool bms_is_member(int x, const Bitmapset *a)
Definition: bitmapset.c:428
bms_add_member
Bitmapset * bms_add_member(Bitmapset *a, int x)
Definition: bitmapset.c:739
bms_union
Bitmapset * bms_union(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:226
bms_difference
Bitmapset * bms_difference(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:292
bms_add_members
Bitmapset * bms_add_members(Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:796
bms_del_member
Bitmapset * bms_del_member(Bitmapset *a, int x)
Definition: bitmapset.c:776
bms_is_empty
bool bms_is_empty(const Bitmapset *a)
Definition: bitmapset.c:704
bms_overlap
bool bms_overlap(const Bitmapset *a, const Bitmapset *b)
Definition: bitmapset.c:495
bms_copy
Bitmapset * bms_copy(const Bitmapset *a)
Definition: bitmapset.c:74
BMS_DIFFERENT
@ BMS_DIFFERENT
Definition: bitmapset.h:67
Index
unsigned int Index
Definition: c.h:550
MemSet
#define MemSet(start, val, len)
Definition: c.h:953
OidIsValid
#define OidIsValid(objectId)
Definition: c.h:711
contain_mutable_functions
bool contain_mutable_functions(Node *clause)
Definition: clauses.c:365
contain_volatile_functions
bool contain_volatile_functions(Node *clause)
Definition: clauses.c:448
cost_bitmap_tree_node
void cost_bitmap_tree_node(Path *path, Cost *cost, Selectivity *selec)
Definition: costsize.c:1084
cost_bitmap_heap_scan
void cost_bitmap_heap_scan(Path *path, PlannerInfo *root, RelOptInfo *baserel, ParamPathInfo *param_info, Path *bitmapqual, double loop_count)
Definition: costsize.c:983
enable_indexonlyscan
bool enable_indexonlyscan
Definition: costsize.c:137
ERROR
#define ERROR
Definition: elog.h:39
equal
bool equal(const void *a, const void *b)
Definition: equalfuncs.c:225
generate_implied_equalities_for_column
List * generate_implied_equalities_for_column(PlannerInfo *root, RelOptInfo *rel, ec_matches_callback_type callback, void *callback_arg, Relids prohibited_rels)
Definition: equivclass.c:2833
generate_join_implied_equalities
List * generate_join_implied_equalities(PlannerInfo *root, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel)
Definition: equivclass.c:1394
OidFunctionCall1
#define OidFunctionCall1(functionId, arg1)
Definition: fmgr.h:680
IsBooleanOpfamily
static bool IsBooleanOpfamily(Oid opfamily)
Definition: indxpath.c:2335
choose_bitmap_and
static Path * choose_bitmap_and(PlannerInfo *root, RelOptInfo *rel, List *paths)
Definition: indxpath.c:1342
bitmap_and_cost_est
static Cost bitmap_and_cost_est(PlannerInfo *root, RelOptInfo *rel, List *paths)
Definition: indxpath.c:1615
find_indexpath_quals
static void find_indexpath_quals(Path *bitmapqual, List **quals, List **preds)
Definition: indxpath.c:1712
get_join_index_paths
static void get_join_index_paths(PlannerInfo *root, RelOptInfo *rel, IndexOptInfo *index, IndexClauseSet *rclauseset, IndexClauseSet *jclauseset, IndexClauseSet *eclauseset, List **bitindexpaths, Relids relids, List **considered_relids)
Definition: indxpath.c:601
build_index_paths
static List * build_index_paths(PlannerInfo *root, RelOptInfo *rel, IndexOptInfo *index, IndexClauseSet *clauses, bool useful_predicate, ScanTypeControl scantype, bool *skip_nonnative_saop, bool *skip_lower_saop)
Definition: indxpath.c:835
match_clause_to_index
static void match_clause_to_index(PlannerInfo *root, RestrictInfo *rinfo, IndexOptInfo *index, IndexClauseSet *clauseset)
Definition: indxpath.c:2139
is_pseudo_constant_for_index
bool is_pseudo_constant_for_index(PlannerInfo *root, Node *expr, IndexOptInfo *index)
Definition: indxpath.c:3801
eclass_already_used
static bool eclass_already_used(EquivalenceClass *parent_ec, Relids oldrelids, List *indexjoinclauses)
Definition: indxpath.c:679
match_join_clauses_to_index
static void match_join_clauses_to_index(PlannerInfo *root, RelOptInfo *rel, IndexOptInfo *index, IndexClauseSet *clauseset, List **joinorclauses)
Definition: indxpath.c:2038
match_saopclause_to_indexcol
static IndexClause * match_saopclause_to_indexcol(PlannerInfo *root, RestrictInfo *rinfo, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:2678
check_index_only
static bool check_index_only(RelOptInfo *rel, IndexOptInfo *index)
Definition: indxpath.c:1785
match_eclass_clauses_to_index
static void match_eclass_clauses_to_index(PlannerInfo *root, IndexOptInfo *index, IndexClauseSet *clauseset)
Definition: indxpath.c:2068
ScanTypeControl
ScanTypeControl
Definition: indxpath.c:45
ST_ANYSCAN
@ ST_ANYSCAN
Definition: indxpath.c:48
ST_BITMAPSCAN
@ ST_BITMAPSCAN
Definition: indxpath.c:47
ST_INDEXSCAN
@ ST_INDEXSCAN
Definition: indxpath.c:46
classify_index_clause_usage
static PathClauseUsage * classify_index_clause_usage(Path *path, List **clauselist)
Definition: indxpath.c:1644
get_index_paths
static void get_index_paths(PlannerInfo *root, RelOptInfo *rel, IndexOptInfo *index, IndexClauseSet *clauses, List **bitindexpaths)
Definition: indxpath.c:713
check_index_predicates
void check_index_predicates(PlannerInfo *root, RelOptInfo *rel)
Definition: indxpath.c:3302
match_pathkeys_to_index
static void match_pathkeys_to_index(IndexOptInfo *index, List *pathkeys, List **orderby_clauses_p, List **clause_columns_p)
Definition: indxpath.c:3073
find_list_position
static int find_list_position(Node *node, List **nodelist)
Definition: indxpath.c:1759
match_clauses_to_index
static void match_clauses_to_index(PlannerInfo *root, List *clauses, IndexOptInfo *index, IndexClauseSet *clauseset)
Definition: indxpath.c:2106
get_loop_count
static double get_loop_count(PlannerInfo *root, Index cur_relid, Relids outer_relids)
Definition: indxpath.c:1884
relation_has_unique_index_for
bool relation_has_unique_index_for(PlannerInfo *root, RelOptInfo *rel, List *restrictlist, List *exprlist, List *oprlist)
Definition: indxpath.c:3494
consider_index_join_outer_rels
static void consider_index_join_outer_rels(PlannerInfo *root, RelOptInfo *rel, IndexOptInfo *index, IndexClauseSet *rclauseset, IndexClauseSet *jclauseset, IndexClauseSet *eclauseset, List **bitindexpaths, List *indexjoinclauses, int considered_clauses, List **considered_relids)
Definition: indxpath.c:498
create_index_paths
void create_index_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: indxpath.c:235
adjust_rowcount_for_semijoins
static double adjust_rowcount_for_semijoins(PlannerInfo *root, Index cur_relid, Index outer_relid, double rowcount)
Definition: indxpath.c:1937
match_clause_to_indexcol
static IndexClause * match_clause_to_indexcol(PlannerInfo *root, RestrictInfo *rinfo, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:2258
ec_member_matches_indexcol
static bool ec_member_matches_indexcol(PlannerInfo *root, RelOptInfo *rel, EquivalenceClass *ec, EquivalenceMember *em, void *arg)
Definition: indxpath.c:3436
get_index_clause_from_support
static IndexClause * get_index_clause_from_support(PlannerInfo *root, RestrictInfo *rinfo, Oid funcid, int indexarg, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:2612
IndexCollMatchesExprColl
#define IndexCollMatchesExprColl(idxcollation, exprcollation)
Definition: indxpath.c:40
match_opclause_to_indexcol
static IndexClause * match_opclause_to_indexcol(PlannerInfo *root, RestrictInfo *rinfo, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:2447
bitmap_scan_cost_est
static Cost bitmap_scan_cost_est(PlannerInfo *root, RelOptInfo *rel, Path *ipath)
Definition: indxpath.c:1581
match_index_to_operand
bool match_index_to_operand(Node *operand, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:3716
match_boolean_index_clause
static IndexClause * match_boolean_index_clause(PlannerInfo *root, RestrictInfo *rinfo, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:2360
consider_index_join_clauses
static void consider_index_join_clauses(PlannerInfo *root, RelOptInfo *rel, IndexOptInfo *index, IndexClauseSet *rclauseset, IndexClauseSet *jclauseset, IndexClauseSet *eclauseset, List **bitindexpaths)
Definition: indxpath.c:432
expand_indexqual_rowcompare
static IndexClause * expand_indexqual_rowcompare(PlannerInfo *root, RestrictInfo *rinfo, int indexcol, IndexOptInfo *index, Oid expr_op, bool var_on_left)
Definition: indxpath.c:2853
match_restriction_clauses_to_index
static void match_restriction_clauses_to_index(PlannerInfo *root, IndexOptInfo *index, IndexClauseSet *clauseset)
Definition: indxpath.c:2023
match_rowcompare_to_indexcol
static IndexClause * match_rowcompare_to_indexcol(PlannerInfo *root, RestrictInfo *rinfo, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:2746
build_paths_for_OR
static List * build_paths_for_OR(PlannerInfo *root, RelOptInfo *rel, List *clauses, List *other_clauses)
Definition: indxpath.c:1140
indexcol_is_bool_constant_for_query
bool indexcol_is_bool_constant_for_query(PlannerInfo *root, IndexOptInfo *index, int indexcol)
Definition: indxpath.c:3665
match_funcclause_to_indexcol
static IndexClause * match_funcclause_to_indexcol(PlannerInfo *root, RestrictInfo *rinfo, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:2566
path_usage_comparator
static int path_usage_comparator(const void *a, const void *b)
Definition: indxpath.c:1548
approximate_joinrel_size
static double approximate_joinrel_size(PlannerInfo *root, Relids relids)
Definition: indxpath.c:1981
match_clause_to_ordering_op
static Expr * match_clause_to_ordering_op(IndexOptInfo *index, int indexcol, Expr *clause, Oid pk_opfamily)
Definition: indxpath.c:3188
generate_bitmap_or_paths
static List * generate_bitmap_or_paths(PlannerInfo *root, RelOptInfo *rel, List *clauses, List *other_clauses)
Definition: indxpath.c:1235
b
int b
Definition: isn.c:70
a
int a
Definition: isn.c:69
j
int j
Definition: isn.c:74
i
int i
Definition: isn.c:73
if
if(TABLE==NULL||TABLE_index==NULL)
Definition: isn.c:77
Assert
Assert(fmt[strlen(fmt) - 1] !='\n')
list_truncate
List * list_truncate(List *list, int new_size)
Definition: list.c:630
lappend
List * lappend(List *list, void *datum)
Definition: list.c:338
list_copy_head
List * list_copy_head(const List *oldlist, int len)
Definition: list.c:1592
lappend_int
List * lappend_int(List *list, int datum)
Definition: list.c:356
lappend_oid
List * lappend_oid(List *list, Oid datum)
Definition: list.c:374
list_copy
List * list_copy(const List *oldlist)
Definition: list.c:1572
list_append_unique
List * list_append_unique(List *list, void *datum)
Definition: list.c:1342
list_free
void list_free(List *list)
Definition: list.c:1545
list_member_oid
bool list_member_oid(const List *list, Oid datum)
Definition: list.c:721
list_concat
List * list_concat(List *list1, const List *list2)
Definition: list.c:560
list_member
bool list_member(const List *list, const void *datum)
Definition: list.c:660
list_concat_copy
List * list_concat_copy(const List *list1, const List *list2)
Definition: list.c:597
get_op_opfamily_properties
void get_op_opfamily_properties(Oid opno, Oid opfamily, bool ordering_op, int *strategy, Oid *lefttype, Oid *righttype)
Definition: lsyscache.c:135
get_op_opfamily_sortfamily
Oid get_op_opfamily_sortfamily(Oid opno, Oid opfamily)
Definition: lsyscache.c:107
get_func_support
RegProcedure get_func_support(Oid funcid)
Definition: lsyscache.c:1840
get_op_opfamily_strategy
int get_op_opfamily_strategy(Oid opno, Oid opfamily)
Definition: lsyscache.c:82
get_opfamily_member
Oid get_opfamily_member(Oid opfamily, Oid lefttype, Oid righttype, int16 strategy)
Definition: lsyscache.c:165
op_in_opfamily
bool op_in_opfamily(Oid opno, Oid opfamily)
Definition: lsyscache.c:65
get_commutator
Oid get_commutator(Oid opno)
Definition: lsyscache.c:1491
make_opclause
Expr * make_opclause(Oid opno, Oid opresulttype, bool opretset, Expr *leftop, Expr *rightop, Oid opcollid, Oid inputcollid)
Definition: makefuncs.c:610
makeBoolConst
Node * makeBoolConst(bool value, bool isnull)
Definition: makefuncs.c:357
pfree
void pfree(void *pointer)
Definition: mcxt.c:1306
palloc
void * palloc(Size size)
Definition: mcxt.c:1199
set_opfuncid
void set_opfuncid(OpExpr *opexpr)
Definition: nodeFuncs.c:1672
is_andclause
static bool is_andclause(const void *clause)
Definition: nodeFuncs.h:105
get_notclausearg
static Expr * get_notclausearg(const void *notclause)
Definition: nodeFuncs.h:132
is_opclause
static bool is_opclause(const void *clause)
Definition: nodeFuncs.h:74
get_rightop
static Node * get_rightop(const void *clause)
Definition: nodeFuncs.h:93
is_notclause
static bool is_notclause(const void *clause)
Definition: nodeFuncs.h:123
get_leftop
static Node * get_leftop(const void *clause)
Definition: nodeFuncs.h:81
IsA
#define IsA(nodeptr, _type_)
Definition: nodes.h:168
copyObject
#define copyObject(obj)
Definition: nodes.h:233
Cost
double Cost
Definition: nodes.h:251
nodeTag
#define nodeTag(nodeptr)
Definition: nodes.h:122
Selectivity
double Selectivity
Definition: nodes.h:250
makeNode
#define makeNode(_type_)
Definition: nodes.h:165
castNode
#define castNode(_type_, nodeptr)
Definition: nodes.h:186
JOIN_SEMI
@ JOIN_SEMI
Definition: nodes.h:307
has_useful_pathkeys
bool has_useful_pathkeys(PlannerInfo *root, RelOptInfo *rel)
Definition: pathkeys.c:1963
truncate_useless_pathkeys
List * truncate_useless_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *pathkeys)
Definition: pathkeys.c:1923
build_index_pathkeys
List * build_index_pathkeys(PlannerInfo *root, IndexOptInfo *index, ScanDirection scandir)
Definition: pathkeys.c:545
create_index_path
IndexPath * create_index_path(PlannerInfo *root, IndexOptInfo *index, List *indexclauses, List *indexorderbys, List *indexorderbycols, List *pathkeys, ScanDirection indexscandir, bool indexonly, Relids required_outer, double loop_count, bool partial_path)
Definition: pathnode.c:997
add_partial_path
void add_partial_path(RelOptInfo *parent_rel, Path *new_path)
Definition: pathnode.c:749
create_bitmap_or_path
BitmapOrPath * create_bitmap_or_path(PlannerInfo *root, RelOptInfo *rel, List *bitmapquals)
Definition: pathnode.c:1131
add_path
void add_path(RelOptInfo *parent_rel, Path *new_path)
Definition: pathnode.c:422
create_bitmap_and_path
BitmapAndPath * create_bitmap_and_path(PlannerInfo *root, RelOptInfo *rel, List *bitmapquals)
Definition: pathnode.c:1079
create_bitmap_heap_path
BitmapHeapPath * create_bitmap_heap_path(PlannerInfo *root, RelOptInfo *rel, Path *bitmapqual, Relids required_outer, double loop_count, int parallel_degree)
Definition: pathnode.c:1046
IS_SIMPLE_REL
#define IS_SIMPLE_REL(rel)
Definition: pathnodes.h:792
IS_DUMMY_REL
#define IS_DUMMY_REL(r)
Definition: pathnodes.h:1823
PATH_REQ_OUTER
#define PATH_REQ_OUTER(path)
Definition: pathnodes.h:1556
Relids
Bitmapset * Relids
Definition: pathnodes.h:30
RELOPT_OTHER_MEMBER_REL
@ RELOPT_OTHER_MEMBER_REL
Definition: pathnodes.h:781
pg_am.h
arg
void * arg
Definition: pg_backup_utils.c:27
INDEX_MAX_KEYS
#define INDEX_MAX_KEYS
Definition: pg_config_manual.h:69
lfirst
#define lfirst(lc)
Definition: pg_list.h:170
lfirst_node
#define lfirst_node(type, lc)
Definition: pg_list.h:174
list_length
static int list_length(const List *l)
Definition: pg_list.h:150
NIL
#define NIL
Definition: pg_list.h:66
forboth
#define forboth(cell1, list1, cell2, list2)
Definition: pg_list.h:465
list_nth_oid
static Oid list_nth_oid(const List *list, int n)
Definition: pg_list.h:319
list_make1_oid
#define list_make1_oid(x1)
Definition: pg_list.h:240
list_make1
#define list_make1(x1)
Definition: pg_list.h:210
forthree
#define forthree(cell1, list1, cell2, list2, cell3, list3)
Definition: pg_list.h:510
list_head
static ListCell * list_head(const List *l)
Definition: pg_list.h:126
linitial
#define linitial(l)
Definition: pg_list.h:176
lsecond
#define lsecond(l)
Definition: pg_list.h:181
list_nth
static void * list_nth(const List *list, int n)
Definition: pg_list.h:297
lnext
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:341
list_make1_int
#define list_make1_int(x1)
Definition: pg_list.h:225
linitial_oid
#define linitial_oid(l)
Definition: pg_list.h:178
lfirst_oid
#define lfirst_oid(lc)
Definition: pg_list.h:172
list_make2
#define list_make2(x1, x2)
Definition: pg_list.h:212
pg_operator.h
pg_opfamily.h
pg_type.h
qsort
#define qsort(a, b, c, d)
Definition: port.h:445
PointerGetDatum
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:670
DatumGetPointer
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:660
InvalidOid
#define InvalidOid
Definition: postgres_ext.h:36
Oid
unsigned int Oid
Definition: postgres_ext.h:31
predicate_implied_by
bool predicate_implied_by(List *predicate_list, List *clause_list, bool weak)
Definition: predtest.c:152
c
char * c
Definition: preproc-cursor.c:31
get_plan_rowmark
PlanRowMark * get_plan_rowmark(List *rowmarks, Index rtindex)
Definition: preptlist.c:487
IS_TRUE
@ IS_TRUE
Definition: primnodes.h:1382
IS_FALSE
@ IS_FALSE
Definition: primnodes.h:1382
RowCompareType
RowCompareType
Definition: primnodes.h:1242
find_childrel_parents
Relids find_childrel_parents(PlannerInfo *root, RelOptInfo *rel)
Definition: relnode.c:1281
restriction_is_or_clause
bool restriction_is_or_clause(RestrictInfo *restrictinfo)
Definition: restrictinfo.c:384
commute_restrictinfo
RestrictInfo * commute_restrictinfo(RestrictInfo *rinfo, Oid comm_op)
Definition: restrictinfo.c:327
restriction_is_securely_promotable
bool restriction_is_securely_promotable(RestrictInfo *restrictinfo, RelOptInfo *rel)
Definition: restrictinfo.c:399
join_clause_is_movable_to
bool join_clause_is_movable_to(RestrictInfo *rinfo, RelOptInfo *baserel)
Definition: restrictinfo.c:527
make_simple_restrictinfo
#define make_simple_restrictinfo(root, clause)
Definition: restrictinfo.h:21
NoMovementScanDirection
@ NoMovementScanDirection
Definition: sdir.h:25
BackwardScanDirection
@ BackwardScanDirection
Definition: sdir.h:24
ForwardScanDirection
@ ForwardScanDirection
Definition: sdir.h:26
estimate_num_groups
double estimate_num_groups(PlannerInfo *root, List *groupExprs, double input_rows, List **pgset, EstimationInfo *estinfo)
Definition: selfuncs.c:3385
BTGreaterStrategyNumber
#define BTGreaterStrategyNumber
Definition: stratnum.h:33
BTLessStrategyNumber
#define BTLessStrategyNumber
Definition: stratnum.h:29
BTLessEqualStrategyNumber
#define BTLessEqualStrategyNumber
Definition: stratnum.h:30
BTGreaterEqualStrategyNumber
#define BTGreaterEqualStrategyNumber
Definition: stratnum.h:32
BitmapAndPath::bitmapquals
List * bitmapquals
Definition: pathnodes.h:1687
BitmapHeapPath::bitmapqual
Path * bitmapqual
Definition: pathnodes.h:1675
BitmapOrPath::bitmapquals
List * bitmapquals
Definition: pathnodes.h:1700
BooleanTest::booltesttype
BoolTestType booltesttype
Definition: primnodes.h:1389
BooleanTest::arg
Expr * arg
Definition: primnodes.h:1388
EquivalenceClass::ec_opfamilies
List * ec_opfamilies
Definition: pathnodes.h:1295
FuncExpr::funcid
Oid funcid
Definition: primnodes.h:598
FuncExpr::args
List * args
Definition: primnodes.h:606
IndexClauseSet::nonempty
bool nonempty
Definition: indxpath.c:54
IndexClauseSet::indexclauses
List * indexclauses[INDEX_MAX_KEYS]
Definition: indxpath.c:56
IndexClause::indexcol
AttrNumber indexcol
Definition: pathnodes.h:1651
IndexClause::indexcols
List * indexcols
Definition: pathnodes.h:1652
IndexClause::indexquals
List * indexquals
Definition: pathnodes.h:1649
IndexClause::rinfo
struct RestrictInfo * rinfo
Definition: pathnodes.h:1648
IndexOptInfo::indpred
List * indpred
Definition: pathnodes.h:1119
IndexPath::indexclauses
List * indexclauses
Definition: pathnodes.h:1601
IndexPath::path
Path path
Definition: pathnodes.h:1599
IndexPath::indexselectivity
Selectivity indexselectivity
Definition: pathnodes.h:1606
IndexPath::indexinfo
IndexOptInfo * indexinfo
Definition: pathnodes.h:1600
List
Definition: pg_list.h:52
Node
Definition: nodes.h:118
NullTest::argisrow
bool argisrow
Definition: primnodes.h:1367
NullTest::arg
Expr * arg
Definition: primnodes.h:1365
OpExpr::opno
Oid opno
Definition: primnodes.h:648
OpExpr::args
List * args
Definition: primnodes.h:666
OpExpr::inputcollid
Oid inputcollid
Definition: primnodes.h:663
PathClauseUsage::quals
List * quals
Definition: indxpath.c:63
PathClauseUsage::preds
List * preds
Definition: indxpath.c:64
PathClauseUsage::clauseids
Bitmapset * clauseids
Definition: indxpath.c:65
PathClauseUsage::unclassifiable
bool unclassifiable
Definition: indxpath.c:66
PathClauseUsage::path
Path * path
Definition: indxpath.c:62
PathKey::pk_nulls_first
bool pk_nulls_first
Definition: pathnodes.h:1382
PathKey::pk_strategy
int pk_strategy
Definition: pathnodes.h:1381
PathKey::pk_opfamily
Oid pk_opfamily
Definition: pathnodes.h:1380
PathTarget::exprs
List * exprs
Definition: pathnodes.h:1427
Path::pathkeys
List * pathkeys
Definition: pathnodes.h:1552
Path::pathtype
NodeTag pathtype
Definition: pathnodes.h:1513
Path::parallel_workers
int parallel_workers
Definition: pathnodes.h:1544
Path::total_cost
Cost total_cost
Definition: pathnodes.h:1549
PlannerInfo::simple_rel_array_size
int simple_rel_array_size
Definition: pathnodes.h:232
PlannerInfo::rowMarks
List * rowMarks
Definition: pathnodes.h:361
PlannerInfo::query_pathkeys
List * query_pathkeys
Definition: pathnodes.h:375
PlannerInfo::join_info_list
List * join_info_list
Definition: pathnodes.h:333
PlannerInfo::all_baserels
Relids all_baserels
Definition: pathnodes.h:257
PlannerInfo::all_result_relids
Relids all_result_relids
Definition: pathnodes.h:344
RelOptInfo::baserestrictinfo
List * baserestrictinfo
Definition: pathnodes.h:933
RelOptInfo::joininfo
List * joininfo
Definition: pathnodes.h:939
RelOptInfo::relids
Relids relids
Definition: pathnodes.h:824
RelOptInfo::reltarget
struct PathTarget * reltarget
Definition: pathnodes.h:846
RelOptInfo::relid
Index relid
Definition: pathnodes.h:871
RelOptInfo::consider_parallel
bool consider_parallel
Definition: pathnodes.h:840
RelOptInfo::lateral_relids
Relids lateral_relids
Definition: pathnodes.h:866
RelOptInfo::reloptkind
RelOptKind reloptkind
Definition: pathnodes.h:818
RelOptInfo::indexlist
List * indexlist
Definition: pathnodes.h:889
RelOptInfo::rows
Cardinality rows
Definition: pathnodes.h:830
RestrictInfo::clause
Expr * clause
Definition: pathnodes.h:2435
RowCompareExpr::rctype
RowCompareType rctype
Definition: primnodes.h:1255
RowCompareExpr::opfamilies
List * opfamilies
Definition: primnodes.h:1257
RowCompareExpr::inputcollids
List * inputcollids
Definition: primnodes.h:1258
SpecialJoinInfo::syn_lefthand
Relids syn_lefthand
Definition: pathnodes.h:2705
SpecialJoinInfo::semi_rhs_exprs
List * semi_rhs_exprs
Definition: pathnodes.h:2714
SpecialJoinInfo::jointype
JoinType jointype
Definition: pathnodes.h:2707
SpecialJoinInfo::syn_righthand
Relids syn_righthand
Definition: pathnodes.h:2706
SupportRequestIndexCondition::index
struct IndexOptInfo * index
Definition: supportnodes.h:232
SupportRequestIndexCondition::root
struct PlannerInfo * root
Definition: supportnodes.h:228
Var
Definition: primnodes.h:205
ec_member_matches_arg
Definition: indxpath.c:71
ec_member_matches_arg::index
IndexOptInfo * index
Definition: indxpath.c:72
ec_member_matches_arg::indexcol
int indexcol
Definition: indxpath.c:73
index
Definition: type.h:95
FirstLowInvalidHeapAttributeNumber
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
FirstNormalObjectId
#define FirstNormalObjectId
Definition: transam.h:197
contain_var_clause
bool contain_var_clause(Node *node)
Definition: var.c:393
pull_varnos
Relids pull_varnos(PlannerInfo *root, Node *node)
Definition: var.c:100
pull_varattnos
void pull_varattnos(Node *node, Index varno, Bitmapset **varattnos)
Definition: var.c:281