1 /*------------------------------------------------------------------------- 2 * 3 * cost.h 4 * prototypes for costsize.c and clausesel.c. 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/cost.h 11 * 12 *------------------------------------------------------------------------- 13 */ 14 #ifndef COST_H 15 #define COST_H 16 17 #include "nodes/plannodes.h" 18 #include "nodes/relation.h" 19 20 21 /* defaults for costsize.c's Cost parameters */ 22 /* NB: cost-estimation code should use the variables, not these constants! */ 23 /* If you change these, update backend/utils/misc/postgresql.sample.conf */ 24 #define DEFAULT_SEQ_PAGE_COST 1.0 25 #define DEFAULT_RANDOM_PAGE_COST 4.0 26 #define DEFAULT_CPU_TUPLE_COST 0.01 27 #define DEFAULT_CPU_INDEX_TUPLE_COST 0.005 28 #define DEFAULT_CPU_OPERATOR_COST 0.0025 29 #define DEFAULT_PARALLEL_TUPLE_COST 0.1 30 #define DEFAULT_PARALLEL_SETUP_COST 1000.0 31 32 #define DEFAULT_EFFECTIVE_CACHE_SIZE 524288 /* measured in pages */ 33 34 typedef enum 35 { 36 CONSTRAINT_EXCLUSION_OFF, /* do not use c_e */ 37 CONSTRAINT_EXCLUSION_ON, /* apply c_e to all rels */ 38 CONSTRAINT_EXCLUSION_PARTITION /* apply c_e to otherrels only */ 39 } ConstraintExclusionType; 40 41 42 /* 43 * prototypes for costsize.c 44 * routines to compute costs and sizes 45 */ 46 47 /* parameter variables and flags */ 48 extern PGDLLIMPORT double seq_page_cost; 49 extern PGDLLIMPORT double random_page_cost; 50 extern PGDLLIMPORT double cpu_tuple_cost; 51 extern PGDLLIMPORT double cpu_index_tuple_cost; 52 extern PGDLLIMPORT double cpu_operator_cost; 53 extern PGDLLIMPORT double parallel_tuple_cost; 54 extern PGDLLIMPORT double parallel_setup_cost; 55 extern PGDLLIMPORT int effective_cache_size; 56 extern PGDLLIMPORT Cost disable_cost; 57 extern PGDLLIMPORT int max_parallel_workers_per_gather; 58 extern PGDLLIMPORT bool enable_seqscan; 59 extern PGDLLIMPORT bool enable_indexscan; 60 extern PGDLLIMPORT bool enable_indexonlyscan; 61 extern PGDLLIMPORT bool enable_bitmapscan; 62 extern PGDLLIMPORT bool enable_tidscan; 63 extern PGDLLIMPORT bool enable_sort; 64 extern PGDLLIMPORT bool enable_hashagg; 65 extern PGDLLIMPORT bool enable_nestloop; 66 extern PGDLLIMPORT bool enable_material; 67 extern PGDLLIMPORT bool enable_mergejoin; 68 extern PGDLLIMPORT bool enable_hashjoin; 69 extern PGDLLIMPORT bool enable_gathermerge; 70 extern PGDLLIMPORT int constraint_exclusion; 71 72 extern double clamp_row_est(double nrows); 73 extern double index_pages_fetched(double tuples_fetched, BlockNumber pages, 74 double index_pages, PlannerInfo *root); 75 extern void cost_seqscan(Path *path, PlannerInfo *root, RelOptInfo *baserel, 76 ParamPathInfo *param_info); 77 extern void cost_samplescan(Path *path, PlannerInfo *root, RelOptInfo *baserel, 78 ParamPathInfo *param_info); 79 extern void cost_index(IndexPath *path, PlannerInfo *root, 80 double loop_count, bool partial_path); 81 extern void cost_bitmap_heap_scan(Path *path, PlannerInfo *root, RelOptInfo *baserel, 82 ParamPathInfo *param_info, 83 Path *bitmapqual, double loop_count); 84 extern void cost_bitmap_and_node(BitmapAndPath *path, PlannerInfo *root); 85 extern void cost_bitmap_or_node(BitmapOrPath *path, PlannerInfo *root); 86 extern void cost_bitmap_tree_node(Path *path, Cost *cost, Selectivity *selec); 87 extern void cost_tidscan(Path *path, PlannerInfo *root, 88 RelOptInfo *baserel, List *tidquals, ParamPathInfo *param_info); 89 extern void cost_subqueryscan(SubqueryScanPath *path, PlannerInfo *root, 90 RelOptInfo *baserel, ParamPathInfo *param_info); 91 extern void cost_functionscan(Path *path, PlannerInfo *root, 92 RelOptInfo *baserel, ParamPathInfo *param_info); 93 extern void cost_tableexprscan(Path *path, PlannerInfo *root, 94 RelOptInfo *baserel, ParamPathInfo *param_info); 95 extern void cost_valuesscan(Path *path, PlannerInfo *root, 96 RelOptInfo *baserel, ParamPathInfo *param_info); 97 extern void cost_tablefuncscan(Path *path, PlannerInfo *root, 98 RelOptInfo *baserel, ParamPathInfo *param_info); 99 extern void cost_ctescan(Path *path, PlannerInfo *root, 100 RelOptInfo *baserel, ParamPathInfo *param_info); 101 extern void cost_namedtuplestorescan(Path *path, PlannerInfo *root, 102 RelOptInfo *baserel, ParamPathInfo *param_info); 103 extern void cost_recursive_union(Path *runion, Path *nrterm, Path *rterm); 104 extern void cost_sort(Path *path, PlannerInfo *root, 105 List *pathkeys, Cost input_cost, double tuples, int width, 106 Cost comparison_cost, int sort_mem, 107 double limit_tuples); 108 extern void cost_merge_append(Path *path, PlannerInfo *root, 109 List *pathkeys, int n_streams, 110 Cost input_startup_cost, Cost input_total_cost, 111 double tuples); 112 extern void cost_material(Path *path, 113 Cost input_startup_cost, Cost input_total_cost, 114 double tuples, int width); 115 extern void cost_agg(Path *path, PlannerInfo *root, 116 AggStrategy aggstrategy, const AggClauseCosts *aggcosts, 117 int numGroupCols, double numGroups, 118 Cost input_startup_cost, Cost input_total_cost, 119 double input_tuples); 120 extern void cost_windowagg(Path *path, PlannerInfo *root, 121 List *windowFuncs, int numPartCols, int numOrderCols, 122 Cost input_startup_cost, Cost input_total_cost, 123 double input_tuples); 124 extern void cost_group(Path *path, PlannerInfo *root, 125 int numGroupCols, double numGroups, 126 Cost input_startup_cost, Cost input_total_cost, 127 double input_tuples); 128 extern void initial_cost_nestloop(PlannerInfo *root, 129 JoinCostWorkspace *workspace, 130 JoinType jointype, 131 Path *outer_path, Path *inner_path, 132 JoinPathExtraData *extra); 133 extern void final_cost_nestloop(PlannerInfo *root, NestPath *path, 134 JoinCostWorkspace *workspace, 135 JoinPathExtraData *extra); 136 extern void initial_cost_mergejoin(PlannerInfo *root, 137 JoinCostWorkspace *workspace, 138 JoinType jointype, 139 List *mergeclauses, 140 Path *outer_path, Path *inner_path, 141 List *outersortkeys, List *innersortkeys, 142 JoinPathExtraData *extra); 143 extern void final_cost_mergejoin(PlannerInfo *root, MergePath *path, 144 JoinCostWorkspace *workspace, 145 JoinPathExtraData *extra); 146 extern void initial_cost_hashjoin(PlannerInfo *root, 147 JoinCostWorkspace *workspace, 148 JoinType jointype, 149 List *hashclauses, 150 Path *outer_path, Path *inner_path, 151 JoinPathExtraData *extra); 152 extern void final_cost_hashjoin(PlannerInfo *root, HashPath *path, 153 JoinCostWorkspace *workspace, 154 JoinPathExtraData *extra); 155 extern void cost_gather(GatherPath *path, PlannerInfo *root, 156 RelOptInfo *baserel, ParamPathInfo *param_info, double *rows); 157 extern void cost_subplan(PlannerInfo *root, SubPlan *subplan, Plan *plan); 158 extern void cost_qual_eval(QualCost *cost, List *quals, PlannerInfo *root); 159 extern void cost_qual_eval_node(QualCost *cost, Node *qual, PlannerInfo *root); 160 extern void compute_semi_anti_join_factors(PlannerInfo *root, 161 RelOptInfo *outerrel, 162 RelOptInfo *innerrel, 163 JoinType jointype, 164 SpecialJoinInfo *sjinfo, 165 List *restrictlist, 166 SemiAntiJoinFactors *semifactors); 167 extern void set_baserel_size_estimates(PlannerInfo *root, RelOptInfo *rel); 168 extern double get_parameterized_baserel_size(PlannerInfo *root, 169 RelOptInfo *rel, 170 List *param_clauses); 171 extern double get_parameterized_joinrel_size(PlannerInfo *root, 172 RelOptInfo *rel, 173 Path *outer_path, 174 Path *inner_path, 175 SpecialJoinInfo *sjinfo, 176 List *restrict_clauses); 177 extern void set_joinrel_size_estimates(PlannerInfo *root, RelOptInfo *rel, 178 RelOptInfo *outer_rel, 179 RelOptInfo *inner_rel, 180 SpecialJoinInfo *sjinfo, 181 List *restrictlist); 182 extern void set_subquery_size_estimates(PlannerInfo *root, RelOptInfo *rel); 183 extern void set_function_size_estimates(PlannerInfo *root, RelOptInfo *rel); 184 extern void set_values_size_estimates(PlannerInfo *root, RelOptInfo *rel); 185 extern void set_cte_size_estimates(PlannerInfo *root, RelOptInfo *rel, 186 double cte_rows); 187 extern void set_tablefunc_size_estimates(PlannerInfo *root, RelOptInfo *rel); 188 extern void set_namedtuplestore_size_estimates(PlannerInfo *root, RelOptInfo *rel); 189 extern void set_foreign_size_estimates(PlannerInfo *root, RelOptInfo *rel); 190 extern PathTarget *set_pathtarget_cost_width(PlannerInfo *root, PathTarget *target); 191 extern double compute_bitmap_pages(PlannerInfo *root, RelOptInfo *baserel, 192 Path *bitmapqual, int loop_count, Cost *cost, double *tuple); 193 194 /* 195 * prototypes for clausesel.c 196 * routines to compute clause selectivities 197 */ 198 extern Selectivity clauselist_selectivity(PlannerInfo *root, 199 List *clauses, 200 int varRelid, 201 JoinType jointype, 202 SpecialJoinInfo *sjinfo); 203 extern Selectivity clause_selectivity(PlannerInfo *root, 204 Node *clause, 205 int varRelid, 206 JoinType jointype, 207 SpecialJoinInfo *sjinfo); 208 extern void cost_gather_merge(GatherMergePath *path, PlannerInfo *root, 209 RelOptInfo *rel, ParamPathInfo *param_info, 210 Cost input_startup_cost, Cost input_total_cost, 211 double *rows); 212 213 #endif /* COST_H */ 214