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-2023, 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  JoinDomain *jdomain);
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  List *opfamilies,
132  Oid opcintype,
133  Oid collation,
134  Index sortref,
135  Relids rel,
136  bool create_it);
138  Expr *expr,
139  Relids relids);
141  EquivalenceClass *ec,
142  List *exprs,
143  Relids relids,
144  bool require_parallel_safe);
145 extern bool relation_can_be_sorted_early(PlannerInfo *root, RelOptInfo *rel,
146  EquivalenceClass *ec,
147  bool require_parallel_safe);
150  Relids join_relids,
151  Relids outer_relids,
152  RelOptInfo *inner_rel);
154  List *eclasses,
155  Relids join_relids,
156  Relids outer_relids,
157  RelOptInfo *inner_rel);
158 extern bool exprs_known_equal(PlannerInfo *root, Node *item1, Node *item2);
160  ForeignKeyOptInfo *fkinfo,
161  int colno);
163  EquivalenceMember *em);
164 extern void add_child_rel_equivalences(PlannerInfo *root,
165  AppendRelInfo *appinfo,
166  RelOptInfo *parent_rel,
167  RelOptInfo *child_rel);
169  int nappinfos,
170  AppendRelInfo **appinfos,
171  RelOptInfo *parent_joinrel,
172  RelOptInfo *child_joinrel);
174  RelOptInfo *rel,
176  void *callback_arg,
177  Relids prohibited_rels);
179  RelOptInfo *rel1, RelOptInfo *rel2);
181  RelOptInfo *rel1);
182 extern bool eclass_useful_for_merging(PlannerInfo *root,
184  RelOptInfo *rel);
185 extern bool is_redundant_derived_clause(RestrictInfo *rinfo, List *clauselist);
187  List *indexclauses);
188 
189 /*
190  * pathkeys.c
191  * utilities for matching and building path keys
192  */
193 typedef enum
194 {
195  PATHKEYS_EQUAL, /* pathkeys are identical */
196  PATHKEYS_BETTER1, /* pathkey 1 is a superset of pathkey 2 */
197  PATHKEYS_BETTER2, /* vice versa */
198  PATHKEYS_DIFFERENT /* neither pathkey includes the other */
200 
201 extern PathKeysComparison compare_pathkeys(List *keys1, List *keys2);
202 extern bool pathkeys_contained_in(List *keys1, List *keys2);
203 extern bool pathkeys_count_contained_in(List *keys1, List *keys2, int *n_common);
204 extern Path *get_cheapest_path_for_pathkeys(List *paths, List *pathkeys,
205  Relids required_outer,
206  CostSelector cost_criterion,
207  bool require_parallel_safe);
209  List *pathkeys,
210  Relids required_outer,
211  double fraction);
214  ScanDirection scandir);
215 extern List *build_partition_pathkeys(PlannerInfo *root, RelOptInfo *partrel,
216  ScanDirection scandir, bool *partialkeys);
217 extern List *build_expression_pathkey(PlannerInfo *root, Expr *expr,
218  Oid opno,
219  Relids rel, bool create_it);
221  List *subquery_pathkeys,
222  List *subquery_tlist);
223 extern List *build_join_pathkeys(PlannerInfo *root,
224  RelOptInfo *joinrel,
225  JoinType jointype,
226  List *outer_pathkeys);
228  List *sortclauses,
229  List *tlist);
231  List **sortclauses,
232  List *tlist,
233  bool remove_redundant,
234  bool *sortable);
236  RestrictInfo *restrictinfo);
237 extern void update_mergeclause_eclasses(PlannerInfo *root,
238  RestrictInfo *restrictinfo);
240  List *pathkeys,
241  List *restrictinfos);
243  List *mergeclauses,
244  RelOptInfo *joinrel);
246  List *mergeclauses,
247  List *outer_pathkeys);
249  List *mergeclauses,
250  List *pathkeys);
252  RelOptInfo *rel,
253  List *pathkeys);
254 extern bool has_useful_pathkeys(PlannerInfo *root, RelOptInfo *rel);
255 extern List *append_pathkeys(List *target, List *source);
257  EquivalenceClass *eclass, Oid opfamily,
258  int strategy, bool nulls_first);
259 extern void add_paths_to_append_rel(PlannerInfo *root, RelOptInfo *rel,
260  List *live_childrels);
261 
262 #endif /* PATHS_H */
#define PGDLLIMPORT
Definition: c.h:1303
unsigned char bool
Definition: c.h:440
unsigned int Index
Definition: c.h:598
JoinType
Definition: nodes.h:299
CostSelector
Definition: pathnodes.h:37
bool exprs_known_equal(PlannerInfo *root, Node *item1, Node *item2)
Definition: equivclass.c:2401
List * build_join_pathkeys(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, List *outer_pathkeys)
Definition: pathkeys.c:1093
List * build_expression_pathkey(PlannerInfo *root, Expr *expr, Oid opno, Relids rel, bool create_it)
Definition: pathkeys.c:799
EquivalenceMember * find_ec_member_matching_expr(EquivalenceClass *ec, Expr *expr, Relids relids)
Definition: equivclass.c:758
void add_child_rel_equivalences(PlannerInfo *root, AppendRelInfo *appinfo, RelOptInfo *parent_rel, RelOptInfo *child_rel)
Definition: equivclass.c:2583
bool is_redundant_with_indexclauses(RestrictInfo *rinfo, List *indexclauses)
Definition: equivclass.c:3172
void generate_base_implied_equalities(PlannerInfo *root)
Definition: equivclass.c:1031
PGDLLIMPORT int geqo_threshold
Definition: allpaths.c:65
void generate_partitionwise_join_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: allpaths.c:4216
RelOptInfo * standard_join_search(PlannerInfo *root, int levels_needed, List *initial_rels)
Definition: allpaths.c:3352
void join_search_one_level(PlannerInfo *root, int level)
Definition: joinrels.c:71
RestrictInfo * find_derived_clause_for_ec_member(EquivalenceClass *ec, EquivalenceMember *em)
Definition: equivclass.c:2543
List * make_inner_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, List *outer_pathkeys)
Definition: pathkeys.c:1620
PGDLLIMPORT set_rel_pathlist_hook_type set_rel_pathlist_hook
Definition: allpaths.c:70
Path * get_cheapest_path_for_pathkeys(List *paths, List *pathkeys, Relids required_outer, CostSelector cost_criterion, bool require_parallel_safe)
Definition: pathkeys.c:420
bool pathkeys_count_contained_in(List *keys1, List *keys2, int *n_common)
Definition: pathkeys.c:359
Expr * canonicalize_ec_expression(Expr *expr, Oid req_type, Oid req_collation)
Definition: equivclass.c:469
bool relation_can_be_sorted_early(PlannerInfo *root, RelOptInfo *rel, EquivalenceClass *ec, bool require_parallel_safe)
Definition: equivclass.c:920
List * find_mergeclauses_for_outer_pathkeys(PlannerInfo *root, List *pathkeys, List *restrictinfos)
Definition: pathkeys.c:1309
void add_paths_to_joinrel(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, SpecialJoinInfo *sjinfo, List *restrictlist)
Definition: joinpath.c:123
bool has_useful_pathkeys(PlannerInfo *root, RelOptInfo *rel)
Definition: pathkeys.c:1983
List * append_pathkeys(List *target, List *source)
Definition: pathkeys.c:105
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:3302
List * truncate_useless_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *pathkeys)
Definition: pathkeys.c:1943
bool process_equivalence(PlannerInfo *root, RestrictInfo **p_restrictinfo, JoinDomain *jdomain)
Definition: equivclass.c:118
RelOptInfo *(* join_search_hook_type)(PlannerInfo *root, int levels_needed, List *initial_rels)
Definition: paths.h:45
int compute_parallel_worker(RelOptInfo *rel, double heap_pages, double index_pages, int max_workers)
Definition: allpaths.c:4128
void generate_gather_paths(PlannerInfo *root, RelOptInfo *rel, bool override_rows)
Definition: allpaths.c:2993
List * generate_join_implied_equalities_for_ecs(PlannerInfo *root, List *eclasses, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel)
Definition: equivclass.c:1453
List * trim_mergeclauses_for_inner_pathkeys(PlannerInfo *root, List *mergeclauses, List *pathkeys)
Definition: pathkeys.c:1723
void(* set_rel_pathlist_hook_type)(PlannerInfo *root, RelOptInfo *rel, Index rti, RangeTblEntry *rte)
Definition: paths.h:29
List * select_outer_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, RelOptInfo *joinrel)
Definition: pathkeys.c:1424
void update_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition: pathkeys.c:1275
bool relation_has_unique_index_for(PlannerInfo *root, RelOptInfo *rel, List *restrictlist, List *exprlist, List *oprlist)
Definition: indxpath.c:3494
PGDLLIMPORT int min_parallel_table_scan_size
Definition: allpaths.c:66
List * build_index_pathkeys(PlannerInfo *root, IndexOptInfo *index, ScanDirection scandir)
Definition: pathkeys.c:539
EquivalenceClass * get_eclass_for_sort_expr(PlannerInfo *root, Expr *expr, List *opfamilies, Oid opcintype, Oid collation, Index sortref, Relids rel, bool create_it)
Definition: equivclass.c:584
bool have_relevant_eclass_joinclause(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: equivclass.c:2976
void create_index_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: indxpath.c:235
RelOptInfo * make_join_rel(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: joinrels.c:689
List * generate_implied_equalities_for_column(PlannerInfo *root, RelOptInfo *rel, ec_matches_callback_type callback, void *callback_arg, Relids prohibited_rels)
Definition: equivclass.c:2846
List * make_pathkeys_for_sortclauses_extended(PlannerInfo *root, List **sortclauses, List *tlist, bool remove_redundant, bool *sortable)
Definition: pathkeys.c:1166
PathKey * make_canonical_pathkey(PlannerInfo *root, EquivalenceClass *eclass, Oid opfamily, int strategy, bool nulls_first)
Definition: pathkeys.c:54
void generate_useful_gather_paths(PlannerInfo *root, RelOptInfo *rel, bool override_rows)
Definition: allpaths.c:3131
void mark_dummy_rel(RelOptInfo *rel)
Definition: joinrels.c:1271
bool have_dangerous_phv(PlannerInfo *root, Relids outer_relids, Relids inner_params)
Definition: joinrels.c:1194
Path * get_cheapest_parallel_safe_total_inner(List *paths)
Definition: pathkeys.c:498
void reconsider_outer_join_clauses(PlannerInfo *root)
Definition: equivclass.c:1953
bool have_join_order_restriction(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: joinrels.c:961
bool eclass_useful_for_merging(PlannerInfo *root, EquivalenceClass *eclass, RelOptInfo *rel)
Definition: equivclass.c:3087
List * make_pathkeys_for_sortclauses(PlannerInfo *root, List *sortclauses, List *tlist)
Definition: pathkeys.c:1129
List * generate_join_implied_equalities(PlannerInfo *root, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel)
Definition: equivclass.c:1375
PGDLLIMPORT int min_parallel_index_scan_size
Definition: allpaths.c:67
void add_child_join_rel_equivalences(PlannerInfo *root, int nappinfos, AppendRelInfo **appinfos, RelOptInfo *parent_joinrel, RelOptInfo *child_joinrel)
Definition: equivclass.c:2705
List * convert_subquery_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *subquery_pathkeys, List *subquery_tlist)
Definition: pathkeys.c:853
EquivalenceClass * match_eclasses_to_foreign_key_col(PlannerInfo *root, ForeignKeyOptInfo *fkinfo, int colno)
Definition: equivclass.c:2452
void initialize_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition: pathkeys.c:1228
bool match_index_to_operand(Node *operand, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:3716
Path * get_cheapest_fractional_path_for_pathkeys(List *paths, List *pathkeys, Relids required_outer, double fraction)
Definition: pathkeys.c:465
bool is_redundant_derived_clause(RestrictInfo *rinfo, List *clauselist)
Definition: equivclass.c:3145
void create_partial_bitmap_paths(PlannerInfo *root, RelOptInfo *rel, Path *bitmapqual)
Definition: allpaths.c:4092
bool pathkeys_contained_in(List *keys1, List *keys2)
Definition: pathkeys.c:340
void create_tidscan_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: tidpath.c:460
PathKeysComparison compare_pathkeys(List *keys1, List *keys2)
Definition: pathkeys.c:301
PGDLLIMPORT join_search_hook_type join_search_hook
Definition: allpaths.c:73
void add_paths_to_append_rel(PlannerInfo *root, RelOptInfo *rel, List *live_childrels)
Definition: allpaths.c:1267
PathKeysComparison
Definition: paths.h:194
@ PATHKEYS_BETTER2
Definition: paths.h:197
@ PATHKEYS_BETTER1
Definition: paths.h:196
@ PATHKEYS_DIFFERENT
Definition: paths.h:198
@ PATHKEYS_EQUAL
Definition: paths.h:195
bool indexcol_is_bool_constant_for_query(PlannerInfo *root, IndexOptInfo *index, int indexcol)
Definition: indxpath.c:3665
EquivalenceMember * find_computable_ec_member(PlannerInfo *root, EquivalenceClass *ec, List *exprs, Relids relids, bool require_parallel_safe)
Definition: equivclass.c:823
RelOptInfo * make_one_rel(PlannerInfo *root, List *joinlist)
Definition: allpaths.c:156
List * build_partition_pathkeys(PlannerInfo *root, RelOptInfo *partrel, ScanDirection scandir, bool *partialkeys)
Definition: pathkeys.c:718
bool has_relevant_eclass_joinclause(PlannerInfo *root, RelOptInfo *rel1)
Definition: equivclass.c:3043
PGDLLIMPORT bool enable_geqo
Definition: allpaths.c:64
bool(* ec_matches_callback_type)(PlannerInfo *root, RelOptInfo *rel, EquivalenceClass *ec, EquivalenceMember *em, void *arg)
Definition: paths.h:117
PGDLLIMPORT set_join_pathlist_hook_type set_join_pathlist_hook
Definition: joinpath.c:30
void * arg
static rewind_source * source
Definition: pg_rewind.c:81
unsigned int Oid
Definition: postgres_ext.h:31
static struct cvec * eclass(struct vars *v, chr c, int cases)
Definition: regc_locale.c:504
ScanDirection
Definition: sdir.h:23
Definition: pg_list.h:54
Definition: nodes.h:129
Definition: type.h:95
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:46