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-2021, 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/pathnodes.h"
18 
19 
20 /*
21  * allpaths.c
22  */
23 extern PGDLLIMPORT bool enable_geqo;
24 extern PGDLLIMPORT 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 RelOptInfo *standard_join_search(PlannerInfo *root, int levels_needed,
53  List *initial_rels);
54 
55 extern void generate_gather_paths(PlannerInfo *root, RelOptInfo *rel,
56  bool override_rows);
58  bool override_rows);
59 extern int compute_parallel_worker(RelOptInfo *rel, double heap_pages,
60  double index_pages, int max_workers);
61 extern void create_partial_bitmap_paths(PlannerInfo *root, RelOptInfo *rel,
62  Path *bitmapqual);
64  RelOptInfo *rel);
65 
66 #ifdef OPTIMIZER_DEBUG
67 extern void debug_print_rel(PlannerInfo *root, RelOptInfo *rel);
68 #endif
69 
70 /*
71  * indxpath.c
72  * routines to generate index paths
73  */
74 extern void create_index_paths(PlannerInfo *root, RelOptInfo *rel);
76  List *restrictlist,
77  List *exprlist, List *oprlist);
80  int indexcol);
81 extern bool match_index_to_operand(Node *operand, int indexcol,
83 extern void check_index_predicates(PlannerInfo *root, RelOptInfo *rel);
84 
85 /*
86  * tidpath.h
87  * routines to generate tid paths
88  */
89 extern void create_tidscan_paths(PlannerInfo *root, RelOptInfo *rel);
90 
91 /*
92  * joinpath.c
93  * routines to create join paths
94  */
95 extern void add_paths_to_joinrel(PlannerInfo *root, RelOptInfo *joinrel,
96  RelOptInfo *outerrel, RelOptInfo *innerrel,
97  JoinType jointype, SpecialJoinInfo *sjinfo,
98  List *restrictlist);
99 
100 /*
101  * joinrels.c
102  * routines to determine which relations to join
103  */
104 extern void join_search_one_level(PlannerInfo *root, int level);
105 extern RelOptInfo *make_join_rel(PlannerInfo *root,
106  RelOptInfo *rel1, RelOptInfo *rel2);
107 extern bool have_join_order_restriction(PlannerInfo *root,
108  RelOptInfo *rel1, RelOptInfo *rel2);
109 extern bool have_dangerous_phv(PlannerInfo *root,
110  Relids outer_relids, Relids inner_params);
111 extern void mark_dummy_rel(RelOptInfo *rel);
112 
113 /*
114  * equivclass.c
115  * routines for managing EquivalenceClasses
116  */
118  RelOptInfo *rel,
119  EquivalenceClass *ec,
120  EquivalenceMember *em,
121  void *arg);
122 
123 extern bool process_equivalence(PlannerInfo *root,
124  RestrictInfo **p_restrictinfo,
125  bool below_outer_join);
126 extern Expr *canonicalize_ec_expression(Expr *expr,
127  Oid req_type, Oid req_collation);
128 extern void reconsider_outer_join_clauses(PlannerInfo *root);
130  Expr *expr,
131  Relids nullable_relids,
132  List *opfamilies,
133  Oid opcintype,
134  Oid collation,
135  Index sortref,
136  Relids rel,
137  bool create_it);
139  Expr *expr,
140  Relids relids);
142  EquivalenceClass *ec,
143  List *exprs,
144  Relids relids,
145  bool require_parallel_safe);
147 extern bool relation_can_be_sorted_early(PlannerInfo *root, RelOptInfo *rel,
148  EquivalenceClass *ec,
149  bool require_parallel_safe);
152  Relids join_relids,
153  Relids outer_relids,
154  RelOptInfo *inner_rel);
156  List *eclasses,
157  Relids join_relids,
158  Relids outer_relids,
159  RelOptInfo *inner_rel);
160 extern bool exprs_known_equal(PlannerInfo *root, Node *item1, Node *item2);
162  ForeignKeyOptInfo *fkinfo,
163  int colno);
165  EquivalenceMember *em);
166 extern void add_child_rel_equivalences(PlannerInfo *root,
167  AppendRelInfo *appinfo,
168  RelOptInfo *parent_rel,
169  RelOptInfo *child_rel);
171  int nappinfos,
172  AppendRelInfo **appinfos,
173  RelOptInfo *parent_rel,
174  RelOptInfo *child_rel);
176  RelOptInfo *rel,
178  void *callback_arg,
179  Relids prohibited_rels);
181  RelOptInfo *rel1, RelOptInfo *rel2);
183  RelOptInfo *rel1);
184 extern bool eclass_useful_for_merging(PlannerInfo *root,
186  RelOptInfo *rel);
187 extern bool is_redundant_derived_clause(RestrictInfo *rinfo, List *clauselist);
189  List *indexclauses);
190 
191 /*
192  * pathkeys.c
193  * utilities for matching and building path keys
194  */
195 typedef enum
196 {
197  PATHKEYS_EQUAL, /* pathkeys are identical */
198  PATHKEYS_BETTER1, /* pathkey 1 is a superset of pathkey 2 */
199  PATHKEYS_BETTER2, /* vice versa */
200  PATHKEYS_DIFFERENT /* neither pathkey includes the other */
202 
203 extern PathKeysComparison compare_pathkeys(List *keys1, List *keys2);
204 extern bool pathkeys_contained_in(List *keys1, List *keys2);
205 extern bool pathkeys_count_contained_in(List *keys1, List *keys2, int *n_common);
206 extern Path *get_cheapest_path_for_pathkeys(List *paths, List *pathkeys,
207  Relids required_outer,
208  CostSelector cost_criterion,
209  bool require_parallel_safe);
211  List *pathkeys,
212  Relids required_outer,
213  double fraction);
216  ScanDirection scandir);
217 extern List *build_partition_pathkeys(PlannerInfo *root, RelOptInfo *partrel,
218  ScanDirection scandir, bool *partialkeys);
219 extern List *build_expression_pathkey(PlannerInfo *root, Expr *expr,
220  Relids nullable_relids, Oid opno,
221  Relids rel, bool create_it);
223  List *subquery_pathkeys,
224  List *subquery_tlist);
225 extern List *build_join_pathkeys(PlannerInfo *root,
226  RelOptInfo *joinrel,
227  JoinType jointype,
228  List *outer_pathkeys);
230  List *sortclauses,
231  List *tlist);
233  RestrictInfo *restrictinfo);
234 extern void update_mergeclause_eclasses(PlannerInfo *root,
235  RestrictInfo *restrictinfo);
237  List *pathkeys,
238  List *restrictinfos);
240  List *mergeclauses,
241  RelOptInfo *joinrel);
243  List *mergeclauses,
244  List *outer_pathkeys);
246  List *mergeclauses,
247  List *pathkeys);
249  RelOptInfo *rel,
250  List *pathkeys);
251 extern bool has_useful_pathkeys(PlannerInfo *root, RelOptInfo *rel);
253  EquivalenceClass *eclass, Oid opfamily,
254  int strategy, bool nulls_first);
255 extern void add_paths_to_append_rel(PlannerInfo *root, RelOptInfo *rel,
256  List *live_childrels);
257 
258 #endif /* PATHS_H */
bool is_redundant_derived_clause(RestrictInfo *rinfo, List *clauselist)
Definition: equivclass.c:3149
bool eclass_useful_for_merging(PlannerInfo *root, EquivalenceClass *eclass, RelOptInfo *rel)
Definition: equivclass.c:3091
List * build_partition_pathkeys(PlannerInfo *root, RelOptInfo *partrel, ScanDirection scandir, bool *partialkeys)
Definition: pathkeys.c:699
PGDLLIMPORT int geqo_threshold
Definition: allpaths.c:63
RestrictInfo * find_derived_clause_for_ec_member(EquivalenceClass *ec, EquivalenceMember *em)
Definition: equivclass.c:2528
bool is_redundant_with_indexclauses(RestrictInfo *rinfo, List *indexclauses)
Definition: equivclass.c:3176
void create_tidscan_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: tidpath.c:459
bool process_equivalence(PlannerInfo *root, RestrictInfo **p_restrictinfo, bool below_outer_join)
Definition: equivclass.c:119
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:686
List * truncate_useless_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *pathkeys)
Definition: pathkeys.c:1870
List * generate_join_implied_equalities_for_ecs(PlannerInfo *root, List *eclasses, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel)
Definition: equivclass.c:1499
Path * get_cheapest_path_for_pathkeys(List *paths, List *pathkeys, Relids required_outer, CostSelector cost_criterion, bool require_parallel_safe)
Definition: pathkeys.c:404
List * build_join_pathkeys(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, List *outer_pathkeys)
Definition: pathkeys.c:1082
bool have_join_order_restriction(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: joinrels.c:951
Definition: nodes.h:539
List * trim_mergeclauses_for_inner_pathkeys(PlannerInfo *root, List *mergeclauses, List *pathkeys)
Definition: pathkeys.c:1650
PathKeysComparison compare_pathkeys(List *keys1, List *keys2)
Definition: pathkeys.c:285
bool relation_has_unique_index_for(PlannerInfo *root, RelOptInfo *rel, List *restrictlist, List *exprlist, List *oprlist)
Definition: indxpath.c:3511
unsigned int Oid
Definition: postgres_ext.h:31
RelOptInfo * make_one_rel(PlannerInfo *root, List *joinlist)
Definition: allpaths.c:153
bool pathkeys_contained_in(List *keys1, List *keys2)
Definition: pathkeys.c:324
Expr * canonicalize_ec_expression(Expr *expr, Oid req_type, Oid req_collation)
Definition: equivclass.c:500
int compute_parallel_worker(RelOptInfo *rel, double heap_pages, double index_pages, int max_workers)
Definition: allpaths.c:3749
void create_index_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: indxpath.c:235
#define PGDLLIMPORT
Definition: c.h:1317
static struct cvec * eclass(struct vars *v, chr c, int cases)
Definition: regc_locale.c:504
JoinType
Definition: nodes.h:706
Definition: type.h:89
void add_child_rel_equivalences(PlannerInfo *root, AppendRelInfo *appinfo, RelOptInfo *parent_rel, RelOptInfo *child_rel)
Definition: equivclass.c:2568
bool exprs_known_equal(PlannerInfo *root, Node *item1, Node *item2)
Definition: equivclass.c:2386
void initialize_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition: pathkeys.c:1179
List * generate_implied_equalities_for_column(PlannerInfo *root, RelOptInfo *rel, ec_matches_callback_type callback, void *callback_arg, Relids prohibited_rels)
Definition: equivclass.c:2850
List * build_index_pathkeys(PlannerInfo *root, IndexOptInfo *index, ScanDirection scandir)
Definition: pathkeys.c:523
void generate_base_implied_equalities(PlannerInfo *root)
Definition: equivclass.c:1088
void generate_partitionwise_join_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: allpaths.c:3837
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:449
PGDLLIMPORT join_search_hook_type join_search_hook
Definition: allpaths.c:71
List * find_mergeclauses_for_outer_pathkeys(PlannerInfo *root, List *pathkeys, List *restrictinfos)
Definition: pathkeys.c:1262
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:621
bool match_index_to_operand(Node *operand, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:3733
ScanDirection
Definition: sdir.h:22
PGDLLIMPORT int min_parallel_table_scan_size
Definition: allpaths.c:64
bool indexcol_is_bool_constant_for_query(PlannerInfo *root, IndexOptInfo *index, int indexcol)
Definition: indxpath.c:3682
PGDLLIMPORT set_join_pathlist_hook_type set_join_pathlist_hook
Definition: joinpath.c:30
PGDLLIMPORT int min_parallel_index_scan_size
Definition: allpaths.c:65
void reconsider_outer_join_clauses(PlannerInfo *root)
Definition: equivclass.c:1984
void add_paths_to_append_rel(PlannerInfo *root, RelOptInfo *rel, List *live_childrels)
Definition: allpaths.c:1285
List * build_expression_pathkey(PlannerInfo *root, Expr *expr, Relids nullable_relids, Oid opno, Relids rel, bool create_it)
Definition: pathkeys.c:782
bool has_useful_pathkeys(PlannerInfo *root, RelOptInfo *rel)
Definition: pathkeys.c:1910
bool have_dangerous_phv(PlannerInfo *root, Relids outer_relids, Relids inner_params)
Definition: joinrels.c:1184
PGDLLIMPORT bool enable_geqo
Definition: allpaths.c:62
unsigned int Index
Definition: c.h:549
Expr * find_em_expr_for_rel(EquivalenceClass *ec, RelOptInfo *rel)
Definition: equivclass.c:939
void generate_gather_paths(PlannerInfo *root, RelOptInfo *rel, bool override_rows)
Definition: allpaths.c:2608
void create_partial_bitmap_paths(PlannerInfo *root, RelOptInfo *rel, Path *bitmapqual)
Definition: allpaths.c:3713
EquivalenceMember * find_ec_member_matching_expr(EquivalenceClass *ec, Expr *expr, Relids relids)
Definition: equivclass.c:786
CostSelector
Definition: pathnodes.h:34
RelOptInfo * standard_join_search(PlannerInfo *root, int levels_needed, List *initial_rels)
Definition: allpaths.c:2985
bool(* ec_matches_callback_type)(PlannerInfo *root, RelOptInfo *rel, EquivalenceClass *ec, EquivalenceMember *em, void *arg)
Definition: paths.h:117
void(* set_rel_pathlist_hook_type)(PlannerInfo *root, RelOptInfo *rel, Index rti, RangeTblEntry *rte)
Definition: paths.h:29
bool pathkeys_count_contained_in(List *keys1, List *keys2, int *n_common)
Definition: pathkeys.c:343
List * make_inner_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, List *outer_pathkeys)
Definition: pathkeys.c:1547
void add_paths_to_joinrel(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, SpecialJoinInfo *sjinfo, List *restrictlist)
Definition: joinpath.c:123
bool have_relevant_eclass_joinclause(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: equivclass.c:2980
Path * get_cheapest_parallel_safe_total_inner(List *paths)
Definition: pathkeys.c:482
void(* set_join_pathlist_hook_type)(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition: paths.h:36
EquivalenceMember * find_computable_ec_member(PlannerInfo *root, EquivalenceClass *ec, List *exprs, Relids relids, bool require_parallel_safe)
Definition: equivclass.c:851
void check_index_predicates(PlannerInfo *root, RelOptInfo *rel)
Definition: indxpath.c:3320
List * convert_subquery_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *subquery_pathkeys, List *subquery_tlist)
Definition: pathkeys.c:838
void join_search_one_level(PlannerInfo *root, int level)
Definition: joinrels.c:71
PathKeysComparison
Definition: paths.h:195
bool has_relevant_eclass_joinclause(PlannerInfo *root, RelOptInfo *rel1)
Definition: equivclass.c:3047
EquivalenceClass * match_eclasses_to_foreign_key_col(PlannerInfo *root, ForeignKeyOptInfo *fkinfo, int colno)
Definition: equivclass.c:2437
bool relation_can_be_sorted_early(PlannerInfo *root, RelOptInfo *rel, EquivalenceClass *ec, bool require_parallel_safe)
Definition: equivclass.c:977
void * arg
void add_child_join_rel_equivalences(PlannerInfo *root, int nappinfos, AppendRelInfo **appinfos, RelOptInfo *parent_rel, RelOptInfo *child_rel)
Definition: equivclass.c:2696
void mark_dummy_rel(RelOptInfo *rel)
Definition: joinrels.c:1261
List * select_outer_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, RelOptInfo *joinrel)
Definition: pathkeys.c:1375
void generate_useful_gather_paths(PlannerInfo *root, RelOptInfo *rel, bool override_rows)
Definition: allpaths.c:2746
PGDLLIMPORT set_rel_pathlist_hook_type set_rel_pathlist_hook
Definition: allpaths.c:68
void update_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition: pathkeys.c:1228
Definition: pg_list.h:50
List * make_pathkeys_for_sortclauses(PlannerInfo *root, List *sortclauses, List *tlist)
Definition: pathkeys.c:1125
unsigned char bool
Definition: c.h:391
List * generate_join_implied_equalities(PlannerInfo *root, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel)
Definition: equivclass.c:1421
PathKey * make_canonical_pathkey(PlannerInfo *root, EquivalenceClass *eclass, Oid opfamily, int strategy, bool nulls_first)
Definition: pathkeys.c:54