PostgreSQL Source Code  git master
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
17 #include "nodes/pathnodes.h"
20 /*
21  * allpaths.c
22  */
23 extern PGDLLIMPORT bool enable_geqo;
24 extern PGDLLIMPORT int geqo_threshold;
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);
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);
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);
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);
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);
66 /*
67  * indxpath.c
68  * routines to generate index paths
69  */
70 extern void create_index_paths(PlannerInfo *root, RelOptInfo *rel);
72  List *restrictlist,
73  List *exprlist, List *oprlist);
75  List *restrictlist, List *exprlist,
76  List *oprlist, List **extra_clauses);
79  int indexcol);
80 extern bool match_index_to_operand(Node *operand, int indexcol,
82 extern void check_index_predicates(PlannerInfo *root, RelOptInfo *rel);
84 /*
85  * tidpath.h
86  * routines to generate tid paths
87  */
88 extern void create_tidscan_paths(PlannerInfo *root, RelOptInfo *rel);
90 /*
91  * joinpath.c
92  * routines to create join paths
93  */
94 extern void add_paths_to_joinrel(PlannerInfo *root, RelOptInfo *joinrel,
95  RelOptInfo *outerrel, RelOptInfo *innerrel,
96  JoinType jointype, SpecialJoinInfo *sjinfo,
97  List *restrictlist);
99 /*
100  * joinrels.c
101  * routines to determine which relations to join
102  */
103 extern void join_search_one_level(PlannerInfo *root, int level);
104 extern RelOptInfo *make_join_rel(PlannerInfo *root,
105  RelOptInfo *rel1, RelOptInfo *rel2);
106 extern Relids add_outer_joins_to_relids(PlannerInfo *root, Relids input_relids,
107  SpecialJoinInfo *sjinfo,
108  List **pushed_down_joins);
109 extern bool have_join_order_restriction(PlannerInfo *root,
110  RelOptInfo *rel1, RelOptInfo *rel2);
111 extern bool have_dangerous_phv(PlannerInfo *root,
112  Relids outer_relids, Relids inner_params);
113 extern void mark_dummy_rel(RelOptInfo *rel);
115 /*
116  * equivclass.c
117  * routines for managing EquivalenceClasses
118  */
120  RelOptInfo *rel,
121  EquivalenceClass *ec,
122  EquivalenceMember *em,
123  void *arg);
125 extern bool process_equivalence(PlannerInfo *root,
126  RestrictInfo **p_restrictinfo,
127  JoinDomain *jdomain);
128 extern Expr *canonicalize_ec_expression(Expr *expr,
129  Oid req_type, Oid req_collation);
130 extern void reconsider_outer_join_clauses(PlannerInfo *root);
132  Expr *expr,
133  List *opfamilies,
134  Oid opcintype,
135  Oid collation,
136  Index sortref,
137  Relids rel,
138  bool create_it);
140  Expr *expr,
141  Relids relids);
143  EquivalenceClass *ec,
144  List *exprs,
145  Relids relids,
146  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,
155  SpecialJoinInfo *sjinfo);
157  List *eclasses,
158  Relids join_relids,
159  Relids outer_relids,
160  RelOptInfo *inner_rel);
161 extern bool exprs_known_equal(PlannerInfo *root, Node *item1, Node *item2);
163  ForeignKeyOptInfo *fkinfo,
164  int colno);
166  EquivalenceMember *em);
167 extern void add_child_rel_equivalences(PlannerInfo *root,
168  AppendRelInfo *appinfo,
169  RelOptInfo *parent_rel,
170  RelOptInfo *child_rel);
172  int nappinfos,
173  AppendRelInfo **appinfos,
174  RelOptInfo *parent_joinrel,
175  RelOptInfo *child_joinrel);
177  RelOptInfo *rel,
179  void *callback_arg,
180  Relids prohibited_rels);
182  RelOptInfo *rel1, RelOptInfo *rel2);
184  RelOptInfo *rel1);
185 extern bool eclass_useful_for_merging(PlannerInfo *root,
187  RelOptInfo *rel);
188 extern bool is_redundant_derived_clause(RestrictInfo *rinfo, List *clauselist);
190  List *indexclauses);
192 /*
193  * pathkeys.c
194  * utilities for matching and building path keys
195  */
196 typedef enum
197 {
198  PATHKEYS_EQUAL, /* pathkeys are identical */
199  PATHKEYS_BETTER1, /* pathkey 1 is a superset of pathkey 2 */
200  PATHKEYS_BETTER2, /* vice versa */
201  PATHKEYS_DIFFERENT, /* neither pathkey includes the other */
204 extern PathKeysComparison compare_pathkeys(List *keys1, List *keys2);
205 extern bool pathkeys_contained_in(List *keys1, List *keys2);
206 extern bool pathkeys_count_contained_in(List *keys1, List *keys2, int *n_common);
207 extern Path *get_cheapest_path_for_pathkeys(List *paths, List *pathkeys,
208  Relids required_outer,
209  CostSelector cost_criterion,
210  bool require_parallel_safe);
212  List *pathkeys,
213  Relids required_outer,
214  double fraction);
217  ScanDirection scandir);
218 extern List *build_partition_pathkeys(PlannerInfo *root, RelOptInfo *partrel,
219  ScanDirection scandir, bool *partialkeys);
220 extern List *build_expression_pathkey(PlannerInfo *root, Expr *expr,
221  Oid opno,
222  Relids rel, bool create_it);
224  List *subquery_pathkeys,
225  List *subquery_tlist);
226 extern List *build_join_pathkeys(PlannerInfo *root,
227  RelOptInfo *joinrel,
228  JoinType jointype,
229  List *outer_pathkeys);
231  List *sortclauses,
232  List *tlist);
234  List **sortclauses,
235  List *tlist,
236  bool remove_redundant,
237  bool *sortable);
239  RestrictInfo *restrictinfo);
240 extern void update_mergeclause_eclasses(PlannerInfo *root,
241  RestrictInfo *restrictinfo);
243  List *pathkeys,
244  List *restrictinfos);
246  List *mergeclauses,
247  RelOptInfo *joinrel);
249  List *mergeclauses,
250  List *outer_pathkeys);
252  List *mergeclauses,
253  List *pathkeys);
255  RelOptInfo *rel,
256  List *pathkeys);
257 extern bool has_useful_pathkeys(PlannerInfo *root, RelOptInfo *rel);
258 extern List *append_pathkeys(List *target, List *source);
260  EquivalenceClass *eclass, Oid opfamily,
261  int strategy, bool nulls_first);
262 extern void add_paths_to_append_rel(PlannerInfo *root, RelOptInfo *rel,
263  List *live_childrels);
265 #endif /* PATHS_H */
Definition: c.h:1326
unsigned char bool
Definition: c.h:445
unsigned int Index
Definition: c.h:603
Definition: nodes.h:299
Definition: pathnodes.h:37
bool exprs_known_equal(PlannerInfo *root, Node *item1, Node *item2)
Definition: equivclass.c:2439
List * build_join_pathkeys(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, List *outer_pathkeys)
Definition: pathkeys.c:1095
List * build_expression_pathkey(PlannerInfo *root, Expr *expr, Oid opno, Relids rel, bool create_it)
Definition: pathkeys.c:801
EquivalenceMember * find_ec_member_matching_expr(EquivalenceClass *ec, Expr *expr, Relids relids)
Definition: equivclass.c:760
void add_child_rel_equivalences(PlannerInfo *root, AppendRelInfo *appinfo, RelOptInfo *parent_rel, RelOptInfo *child_rel)
Definition: equivclass.c:2621
bool is_redundant_with_indexclauses(RestrictInfo *rinfo, List *indexclauses)
Definition: equivclass.c:3221
void generate_base_implied_equalities(PlannerInfo *root)
Definition: equivclass.c:1033
PGDLLIMPORT int geqo_threshold
Definition: allpaths.c:83
void generate_partitionwise_join_paths(PlannerInfo *root, RelOptInfo *rel)
Definition: allpaths.c:4301
RelOptInfo * standard_join_search(PlannerInfo *root, int levels_needed, List *initial_rels)
Definition: allpaths.c:3421
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:2581
List * make_inner_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, List *outer_pathkeys)
Definition: pathkeys.c:1624
PGDLLIMPORT set_rel_pathlist_hook_type set_rel_pathlist_hook
Definition: allpaths.c:88
Path * get_cheapest_path_for_pathkeys(List *paths, List *pathkeys, Relids required_outer, CostSelector cost_criterion, bool require_parallel_safe)
Definition: pathkeys.c:421
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:472
bool relation_can_be_sorted_early(PlannerInfo *root, RelOptInfo *rel, EquivalenceClass *ec, bool require_parallel_safe)
Definition: equivclass.c:922
List * find_mergeclauses_for_outer_pathkeys(PlannerInfo *root, List *pathkeys, List *restrictinfos)
Definition: pathkeys.c:1313
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:1987
Relids add_outer_joins_to_relids(PlannerInfo *root, Relids input_relids, SpecialJoinInfo *sjinfo, List **pushed_down_joins)
Definition: joinrels.c:783
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:3298
List * truncate_useless_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *pathkeys)
Definition: pathkeys.c:1947
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:4213
void generate_gather_paths(PlannerInfo *root, RelOptInfo *rel, bool override_rows)
Definition: allpaths.c:3062
List * generate_join_implied_equalities_for_ecs(PlannerInfo *root, List *eclasses, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel)
Definition: equivclass.c:1481
List * trim_mergeclauses_for_inner_pathkeys(PlannerInfo *root, List *mergeclauses, List *pathkeys)
Definition: pathkeys.c:1727
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:1428
void update_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition: pathkeys.c:1279
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:84
List * build_index_pathkeys(PlannerInfo *root, IndexOptInfo *index, ScanDirection scandir)
Definition: pathkeys.c:541
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:587
List * generate_join_implied_equalities(PlannerInfo *root, Relids join_relids, Relids outer_relids, RelOptInfo *inner_rel, SpecialJoinInfo *sjinfo)
Definition: equivclass.c:1381
bool have_relevant_eclass_joinclause(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: equivclass.c:3016
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:670
List * generate_implied_equalities_for_column(PlannerInfo *root, RelOptInfo *rel, ec_matches_callback_type callback, void *callback_arg, Relids prohibited_rels)
Definition: equivclass.c:2884
List * make_pathkeys_for_sortclauses_extended(PlannerInfo *root, List **sortclauses, List *tlist, bool remove_redundant, bool *sortable)
Definition: pathkeys.c:1170
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:3200
void mark_dummy_rel(RelOptInfo *rel)
Definition: joinrels.c:1363
bool have_dangerous_phv(PlannerInfo *root, Relids outer_relids, Relids inner_params)
Definition: joinrels.c:1286
Path * get_cheapest_parallel_safe_total_inner(List *paths)
Definition: pathkeys.c:500
void reconsider_outer_join_clauses(PlannerInfo *root)
Definition: equivclass.c:1982
bool have_join_order_restriction(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
Definition: joinrels.c:1053
bool eclass_useful_for_merging(PlannerInfo *root, EquivalenceClass *eclass, RelOptInfo *rel)
Definition: equivclass.c:3136
List * make_pathkeys_for_sortclauses(PlannerInfo *root, List *sortclauses, List *tlist)
Definition: pathkeys.c:1133
PGDLLIMPORT int min_parallel_index_scan_size
Definition: allpaths.c:85
void add_child_join_rel_equivalences(PlannerInfo *root, int nappinfos, AppendRelInfo **appinfos, RelOptInfo *parent_joinrel, RelOptInfo *child_joinrel)
Definition: equivclass.c:2743
List * convert_subquery_pathkeys(PlannerInfo *root, RelOptInfo *rel, List *subquery_pathkeys, List *subquery_tlist)
Definition: pathkeys.c:855
EquivalenceClass * match_eclasses_to_foreign_key_col(PlannerInfo *root, ForeignKeyOptInfo *fkinfo, int colno)
Definition: equivclass.c:2490
void initialize_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition: pathkeys.c:1232
bool match_index_to_operand(Node *operand, int indexcol, IndexOptInfo *index)
Definition: indxpath.c:3758
Path * get_cheapest_fractional_path_for_pathkeys(List *paths, List *pathkeys, Relids required_outer, double fraction)
Definition: pathkeys.c:467
bool is_redundant_derived_clause(RestrictInfo *rinfo, List *clauselist)
Definition: equivclass.c:3194
void create_partial_bitmap_paths(PlannerInfo *root, RelOptInfo *rel, Path *bitmapqual)
Definition: allpaths.c:4177
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:91
void add_paths_to_append_rel(PlannerInfo *root, RelOptInfo *rel, List *live_childrels)
Definition: allpaths.c:1305
Definition: paths.h:197
Definition: paths.h:200
Definition: paths.h:199
Definition: paths.h:201
Definition: paths.h:198
bool indexcol_is_bool_constant_for_query(PlannerInfo *root, IndexOptInfo *index, int indexcol)
Definition: indxpath.c:3707
EquivalenceMember * find_computable_ec_member(PlannerInfo *root, EquivalenceClass *ec, List *exprs, Relids relids, bool require_parallel_safe)
Definition: equivclass.c:825
bool relation_has_unique_index_ext(PlannerInfo *root, RelOptInfo *rel, List *restrictlist, List *exprlist, List *oprlist, List **extra_clauses)
Definition: indxpath.c:3509
RelOptInfo * make_one_rel(PlannerInfo *root, List *joinlist)
Definition: allpaths.c:174
List * build_partition_pathkeys(PlannerInfo *root, RelOptInfo *partrel, ScanDirection scandir, bool *partialkeys)
Definition: pathkeys.c:720
bool has_relevant_eclass_joinclause(PlannerInfo *root, RelOptInfo *rel1)
Definition: equivclass.c:3092
PGDLLIMPORT bool enable_geqo
Definition: allpaths.c:82
bool(* ec_matches_callback_type)(PlannerInfo *root, RelOptInfo *rel, EquivalenceClass *ec, EquivalenceMember *em, void *arg)
Definition: paths.h:119
PGDLLIMPORT set_join_pathlist_hook_type set_join_pathlist_hook
Definition: joinpath.c:30
void * arg
static rewind_source * source
Definition: pg_rewind.c:89
unsigned int Oid
Definition: postgres_ext.h:31
static struct cvec * eclass(struct vars *v, chr c, int cases)
Definition: regc_locale.c:500
Definition: sdir.h:25
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