PostgreSQL Source Code  git master
paths.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * paths.h
4  * prototypes for various files in optimizer/path
5  *
6  *
7  * Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/optimizer/paths.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef PATHS_H
15 #define PATHS_H
16 
17 #include "nodes/relation.h"
18 
19 
20 /*
21  * allpaths.c
22  */
23 extern bool enable_geqo;
24 extern int geqo_threshold;
27 
28 /* Hook for plugins to get control in set_rel_pathlist() */
29 typedef void (*set_rel_pathlist_hook_type) (PlannerInfo *root,
30  RelOptInfo *rel,
31  Index rti,
32  RangeTblEntry *rte);
34 
35 /* Hook for plugins to get control in add_paths_to_joinrel() */
37  RelOptInfo *joinrel,
38  RelOptInfo *outerrel,
39  RelOptInfo *innerrel,
40  JoinType jointype,
41  JoinPathExtraData *extra);
43 
44 /* Hook for plugins to replace standard_join_search() */
45 typedef RelOptInfo *(*join_search_hook_type) (PlannerInfo *root,
46  int levels_needed,
47  List *initial_rels);
49 
50 
51 extern RelOptInfo *make_one_rel(PlannerInfo *root, List *joinlist);
52 extern void set_dummy_rel_pathlist(RelOptInfo *rel);
53 extern RelOptInfo *standard_join_search(PlannerInfo *root, int levels_needed,
54  List *initial_rels);
55 
56 extern void generate_gather_paths(PlannerInfo *root, RelOptInfo *rel);
57 extern int compute_parallel_worker(RelOptInfo *rel, double heap_pages,
58  double index_pages);
59 extern void create_partial_bitmap_paths(PlannerInfo *root, RelOptInfo *rel,
60  Path *bitmapqual);
62  RelOptInfo *rel);
63 
64 #ifdef OPTIMIZER_DEBUG
65 extern void debug_print_rel(PlannerInfo *root, RelOptInfo *rel);
66 #endif
67 
68 /*
69  * indxpath.c
70  * routines to generate index paths
71  */
72 extern void create_index_paths(PlannerInfo *root, RelOptInfo *rel);
74  List *restrictlist,
75  List *exprlist, List *oprlist);
77  int indexcol);
78 extern bool match_index_to_operand(Node *operand, int indexcol,
81  List *indexclauses, List *indexclausecols,
82  List **indexquals_p, List **indexqualcols_p);
83 extern void check_index_predicates(PlannerInfo *root, RelOptInfo *rel);
86  int indexcol,
87  List **indexcolnos,
88  bool *var_on_left_p);
89 
90 /*
91  * tidpath.h
92  * routines to generate tid paths
93  */
94 extern void create_tidscan_paths(PlannerInfo *root, RelOptInfo *rel);
95 
96 /*
97  * joinpath.c
98  * routines to create join paths
99  */
100 extern void add_paths_to_joinrel(PlannerInfo *root, RelOptInfo *joinrel,
101  RelOptInfo *outerrel, RelOptInfo *innerrel,
102  JoinType jointype, SpecialJoinInfo *sjinfo,
103  List *restrictlist);
104 
105 /*
106  * joinrels.c
107  * routines to determine which relations to join
108  */
109 extern void join_search_one_level(PlannerInfo *root, int level);
110 extern RelOptInfo *make_join_rel(PlannerInfo *root,
111  RelOptInfo *rel1, RelOptInfo *rel2);
112 extern bool have_join_order_restriction(PlannerInfo *root,
113  RelOptInfo *rel1, RelOptInfo *rel2);
114 extern bool have_dangerous_phv(PlannerInfo *root,
115  Relids outer_relids, Relids inner_params);
116 extern void mark_dummy_rel(RelOptInfo *rel);
117 extern bool have_partkey_equi_join(RelOptInfo *rel1, RelOptInfo *rel2,
118  JoinType jointype, List *restrictlist);
119 
120 /*
121  * equivclass.c
122  * routines for managing EquivalenceClasses
123  */
125  RelOptInfo *rel,
126  EquivalenceClass *ec,
127  EquivalenceMember *em,
128  void *arg);
129 
130 extern bool process_equivalence(PlannerInfo *root,
131  RestrictInfo **p_restrictinfo,
132  bool below_outer_join);
133 extern Expr *canonicalize_ec_expression(Expr *expr,
134  Oid req_type, Oid req_collation);
135 extern void reconsider_outer_join_clauses(PlannerInfo *root);
137  Expr *expr,
138  Relids nullable_relids,
139  List *opfamilies,
140  Oid opcintype,
141  Oid collation,
142  Index sortref,
143  Relids rel,
144  bool create_it);
147  Relids join_relids,
148  Relids outer_relids,
149  RelOptInfo *inner_rel);
151  List *eclasses,
152  Relids join_relids,
153  Relids outer_relids,
154  RelOptInfo *inner_rel);
155 extern bool exprs_known_equal(PlannerInfo *root, Node *item1, Node *item2);
157  ForeignKeyOptInfo *fkinfo,
158  int colno);
159 extern void add_child_rel_equivalences(PlannerInfo *root,
160  AppendRelInfo *appinfo,
161  RelOptInfo *parent_rel,
162  RelOptInfo *child_rel);
164  RelOptInfo *rel,
166  void *callback_arg,
167  Relids prohibited_rels);
169  RelOptInfo *rel1, RelOptInfo *rel2);
171  RelOptInfo *rel1);
172 extern bool eclass_useful_for_merging(PlannerInfo *root,
174  RelOptInfo *rel);
175 extern bool is_redundant_derived_clause(RestrictInfo *rinfo, List *clauselist);
176 
177 /*
178  * pathkeys.c
179  * utilities for matching and building path keys
180  */
181 typedef enum
182 {
183  PATHKEYS_EQUAL, /* pathkeys are identical */
184  PATHKEYS_BETTER1, /* pathkey 1 is a superset of pathkey 2 */
185  PATHKEYS_BETTER2, /* vice versa */
186  PATHKEYS_DIFFERENT /* neither pathkey includes the other */
188 
189 extern PathKeysComparison compare_pathkeys(List *keys1, List *keys2);
190 extern bool pathkeys_contained_in(List *keys1, List *keys2);
191 extern Path *get_cheapest_path_for_pathkeys(List *paths, List *pathkeys,
192  Relids required_outer,
193  CostSelector cost_criterion,
194  bool require_parallel_safe);
196  List *pathkeys,
197  Relids required_outer,
198  double fraction);
201  ScanDirection scandir);
202 extern List *build_expression_pathkey(PlannerInfo *root, Expr *expr,
203  Relids nullable_relids, Oid opno,
204  Relids rel, bool create_it);
206  List *subquery_pathkeys,
207  List *subquery_tlist);
208 extern List *build_join_pathkeys(PlannerInfo *root,
209  RelOptInfo *joinrel,
210  JoinType jointype,
211  List *outer_pathkeys);
213  List *sortclauses,
214  List *tlist);
216  RestrictInfo *restrictinfo);
217 extern void update_mergeclause_eclasses(PlannerInfo *root,
218  RestrictInfo *restrictinfo);
220  List *pathkeys,
221  bool outer_keys,
222  List *restrictinfos);
224  List *mergeclauses,
225  RelOptInfo *joinrel);
227  List *mergeclauses,
228  List *outer_pathkeys);
230  RelOptInfo *rel,
231  List *pathkeys);
232 extern bool has_useful_pathkeys(PlannerInfo *root, RelOptInfo *rel);
234  EquivalenceClass *eclass, Oid opfamily,
235  int strategy, bool nulls_first);
236 
237 #endif /* PATHS_H */
bool is_redundant_derived_clause(RestrictInfo *rinfo, List *clauselist)
Definition: equivclass.c:2494
bool eclass_useful_for_merging(PlannerInfo *root, EquivalenceClass *eclass, RelOptInfo *rel)
Definition: equivclass.c:2436
void generate_gather_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: allpaths.c:2295
int compute_parallel_worker(RelOptInfo *rel, double heap_pages, double index_pages)
Definition: allpaths.c:3169
void create_tidscan_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: tidpath.c:253
bool process_equivalence(PlannerInfo *root, RestrictInfo **p_restrictinfo, bool below_outer_join)
Definition: equivclass.c:114
RelOptInfo *(* join_search_hook_type)(PlannerInfo *root, int levels_needed, List *initial_rels)
Definition: paths.h:45
RelOptInfo * make_join_rel(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: joinrels.c:669
void generate_partition_wise_join_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: allpaths.c:3258
List * truncate_useless_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *pathkeys)
Definition: pathkeys.c:1518
List * generate_join_implied_equalities_for_ecs(PlannerInfo *root, List *eclasses, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel)
Definition: equivclass.c:1088
void set_dummy_rel_pathlist(RelOptInfo *rel)
Definition: allpaths.c:1802
bool enable_geqo
Definition: allpaths.c:59
Path * get_cheapest_path_for_pathkeys(List *paths, List *pathkeys, Relids required_outer, CostSelector cost_criterion, bool require_parallel_safe)
Definition: pathkeys.c:343
List * build_join_pathkeys(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, List *outer_pathkeys)
Definition: pathkeys.c:822
bool have_join_order_restriction(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: joinrels.c:934
Definition: nodes.h:511
PathKeysComparison compare_pathkeys(List *keys1, List *keys2)
Definition: pathkeys.c:278
bool relation_has_unique_index_for(PlannerInfo *root, RelOptInfo *rel, List *restrictlist, List *exprlist, List *oprlist)
Definition: indxpath.c:2960
unsigned int Oid
Definition: postgres_ext.h:31
RelOptInfo * make_one_rel(PlannerInfo *root, List *joinlist)
Definition: allpaths.c:146
bool pathkeys_contained_in(List *keys1, List *keys2)
Definition: pathkeys.c:317
int min_parallel_index_scan_size
Definition: allpaths.c:62
Expr * canonicalize_ec_expression(Expr *expr, Oid req_type, Oid req_collation)
Definition: equivclass.c:494
Expr * adjust_rowcompare_for_index(RowCompareExpr *clause, IndexOptInfo *index, int indexcol, List **indexcolnos, bool *var_on_left_p)
Definition: indxpath.c:3824
void create_index_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: indxpath.c:232
#define PGDLLIMPORT
Definition: c.h:1050
char bool
Definition: c.h:247
static struct cvec * eclass(struct vars *v, chr c, int cases)
Definition: regc_locale.c:508
JoinType
Definition: nodes.h:675
Definition: type.h:89
void add_child_rel_equivalences(PlannerInfo *root, AppendRelInfo *appinfo, RelOptInfo *parent_rel, RelOptInfo *child_rel)
Definition: equivclass.c:2108
bool exprs_known_equal(PlannerInfo *root, Node *item1, Node *item2)
Definition: equivclass.c:1983
void initialize_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition: pathkeys.c:919
List * generate_implied_equalities_for_column(PlannerInfo *root, RelOptInfo *rel, ec_matches_callback_type callback, void *callback_arg, Relids prohibited_rels)
Definition: equivclass.c:2212
List * build_index_pathkeys(PlannerInfo *root, IndexOptInfo *index, ScanDirection scandir)
Definition: pathkeys.c:460
void generate_base_implied_equalities(PlannerInfo *root)
Definition: equivclass.c:800
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:48
Path * get_cheapest_fractional_path_for_pathkeys(List *paths, List *pathkeys, Relids required_outer, double fraction)
Definition: pathkeys.c:388
PGDLLIMPORT join_search_hook_type join_search_hook
Definition: allpaths.c:68
EquivalenceClass * get_eclass_for_sort_expr(PlannerInfo *root, Expr *expr, Relids nullable_relids, List *opfamilies, Oid opcintype, Oid collation, Index sortref, Relids rel, bool create_it)
Definition: equivclass.c:619
bool match_index_to_operand(Node *operand, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:3180
ScanDirection
Definition: sdir.h:22
PGDLLIMPORT set_join_pathlist_hook_type set_join_pathlist_hook
Definition: joinpath.c:27
bool have_partkey_equi_join(RelOptInfo *rel1, RelOptInfo *rel2, JoinType jointype, List *restrictlist)
Definition: joinrels.c:1431
void reconsider_outer_join_clauses(PlannerInfo *root)
Definition: equivclass.c:1572
List * build_expression_pathkey(PlannerInfo *root, Expr *expr, Relids nullable_relids, Oid opno, Relids rel, bool create_it)
Definition: pathkeys.c:553
bool has_useful_pathkeys(PlannerInfo *root, RelOptInfo *rel)
Definition: pathkeys.c:1558
bool have_dangerous_phv(PlannerInfo *root, Relids outer_relids, Relids inner_params)
Definition: joinrels.c:1167
unsigned int Index
Definition: c.h:413
List * find_mergeclauses_for_pathkeys(PlannerInfo *root, List *pathkeys, bool outer_keys, List *restrictinfos)
Definition: pathkeys.c:1003
void create_partial_bitmap_paths(PlannerInfo *root, RelOptInfo *rel, Path *bitmapqual)
Definition: allpaths.c:3137
RelOptInfo * standard_join_search(PlannerInfo *root, int levels_needed, List *initial_rels)
Definition: allpaths.c:2447
bool(* ec_matches_callback_type)(PlannerInfo *root, RelOptInfo *rel, EquivalenceClass *ec, EquivalenceMember *em, void *arg)
Definition: paths.h:124
void(* set_rel_pathlist_hook_type)(PlannerInfo *root, RelOptInfo *rel, Index rti, RangeTblEntry *rte)
Definition: paths.h:29
List * make_inner_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, List *outer_pathkeys)
Definition: pathkeys.c:1292
void add_paths_to_joinrel(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, SpecialJoinInfo *sjinfo, List *restrictlist)
Definition: joinpath.c:117
CostSelector
Definition: relation.h:34
bool have_relevant_eclass_joinclause(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: equivclass.c:2343
Path * get_cheapest_parallel_safe_total_inner(List *paths)
Definition: pathkeys.c:421
void(* set_join_pathlist_hook_type)(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition: paths.h:36
void check_index_predicates(PlannerInfo *root, RelOptInfo *rel)
Definition: indxpath.c:2774
List * convert_subquery_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *subquery_pathkeys, List *subquery_tlist)
Definition: pathkeys.c:607
void join_search_one_level(PlannerInfo *root, int level)
Definition: joinrels.c:66
int geqo_threshold
Definition: allpaths.c:60
PathKeysComparison
Definition: paths.h:181
bool has_relevant_eclass_joinclause(PlannerInfo *root, RelOptInfo *rel1)
Definition: equivclass.c:2397
EquivalenceClass * match_eclasses_to_foreign_key_col(PlannerInfo *root, ForeignKeyOptInfo *fkinfo, int colno)
Definition: equivclass.c:2030
bool indexcol_is_bool_constant_for_query(IndexOptInfo *index, int indexcol)
Definition: indxpath.c:3131
void * arg
void mark_dummy_rel(RelOptInfo *rel)
Definition: joinrels.c:1216
List * select_outer_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, RelOptInfo *joinrel)
Definition: pathkeys.c:1120
PGDLLIMPORT set_rel_pathlist_hook_type set_rel_pathlist_hook
Definition: allpaths.c:65
void expand_indexqual_conditions(IndexOptInfo *index, List *indexclauses, List *indexclausecols, List **indexquals_p, List **indexqualcols_p)
Definition: indxpath.c:3526
void update_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition: pathkeys.c:968
Definition: pg_list.h:45
int min_parallel_table_scan_size
Definition: allpaths.c:61
List * make_pathkeys_for_sortclauses(PlannerInfo *root, List *sortclauses, List *tlist)
Definition: pathkeys.c:865
List * generate_join_implied_equalities(PlannerInfo *root, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel)
Definition: equivclass.c:1071
PathKey * make_canonical_pathkey(PlannerInfo *root, EquivalenceClass *eclass, Oid opfamily, int strategy, bool nulls_first)
Definition: pathkeys.c:51