util/X86MAC64/include/postgresql/server/optimizer/cost.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * cost.h
   4  *        prototypes for costsize.c and clausesel.c.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2014, 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
  30 #define DEFAULT_EFFECTIVE_CACHE_SIZE  524288    /* measured in pages */
  31
  32 typedef enum
  33 {
  34         CONSTRAINT_EXCLUSION_OFF,       /* do not use c_e */
  35         CONSTRAINT_EXCLUSION_ON,        /* apply c_e to all rels */
  36         CONSTRAINT_EXCLUSION_PARTITION          /* apply c_e to otherrels only */
  37 }       ConstraintExclusionType;
  38
  39
  40 /*
  41  * prototypes for costsize.c
  42  *        routines to compute costs and sizes
  43  */
  44
  45 /* parameter variables and flags */
  46 extern PGDLLIMPORT double seq_page_cost;
  47 extern PGDLLIMPORT double random_page_cost;
  48 extern PGDLLIMPORT double cpu_tuple_cost;
  49 extern PGDLLIMPORT double cpu_index_tuple_cost;
  50 extern PGDLLIMPORT double cpu_operator_cost;
  51 extern PGDLLIMPORT int effective_cache_size;
  52 extern Cost disable_cost;
  53 extern bool enable_seqscan;
  54 extern bool enable_indexscan;
  55 extern bool enable_indexonlyscan;
  56 extern bool enable_bitmapscan;
  57 extern bool enable_tidscan;
  58 extern bool enable_sort;
  59 extern bool enable_hashagg;
  60 extern bool enable_nestloop;
  61 extern bool enable_material;
  62 extern bool enable_mergejoin;
  63 extern bool enable_hashjoin;
  64 extern int      constraint_exclusion;
  65
  66 extern double clamp_row_est(double nrows);
  67 extern double index_pages_fetched(double tuples_fetched, BlockNumber pages,
  68                                         double index_pages, PlannerInfo *root);
  69 extern void cost_seqscan(Path *path, PlannerInfo *root, RelOptInfo *baserel,
  70                          ParamPathInfo *param_info);
  71 extern void cost_index(IndexPath *path, PlannerInfo *root,
  72                    double loop_count);
  73 extern void cost_bitmap_heap_scan(Path *path, PlannerInfo *root, RelOptInfo *baserel,
  74                                           ParamPathInfo *param_info,
  75                                           Path *bitmapqual, double loop_count);
  76 extern void cost_bitmap_and_node(BitmapAndPath *path, PlannerInfo *root);
  77 extern void cost_bitmap_or_node(BitmapOrPath *path, PlannerInfo *root);
  78 extern void cost_bitmap_tree_node(Path *path, Cost *cost, Selectivity *selec);
  79 extern void cost_tidscan(Path *path, PlannerInfo *root,
  80                          RelOptInfo *baserel, List *tidquals, ParamPathInfo *param_info);
  81 extern void cost_subqueryscan(Path *path, PlannerInfo *root,
  82                                   RelOptInfo *baserel, ParamPathInfo *param_info);
  83 extern void cost_functionscan(Path *path, PlannerInfo *root,
  84                                   RelOptInfo *baserel, ParamPathInfo *param_info);
  85 extern void cost_valuesscan(Path *path, PlannerInfo *root,
  86                                 RelOptInfo *baserel, ParamPathInfo *param_info);
  87 extern void cost_ctescan(Path *path, PlannerInfo *root,
  88                          RelOptInfo *baserel, ParamPathInfo *param_info);
  89 extern void cost_recursive_union(Plan *runion, Plan *nrterm, Plan *rterm);
  90 extern void cost_sort(Path *path, PlannerInfo *root,
  91                   List *pathkeys, Cost input_cost, double tuples, int width,
  92                   Cost comparison_cost, int sort_mem,
  93                   double limit_tuples);
  94 extern void cost_merge_append(Path *path, PlannerInfo *root,
  95                                   List *pathkeys, int n_streams,
  96                                   Cost input_startup_cost, Cost input_total_cost,
  97                                   double tuples);
  98 extern void cost_material(Path *path,
  99                           Cost input_startup_cost, Cost input_total_cost,
 100                           double tuples, int width);
 101 extern void cost_agg(Path *path, PlannerInfo *root,
 102                  AggStrategy aggstrategy, const AggClauseCosts *aggcosts,
 103                  int numGroupCols, double numGroups,
 104                  Cost input_startup_cost, Cost input_total_cost,
 105                  double input_tuples);
 106 extern void cost_windowagg(Path *path, PlannerInfo *root,
 107                            List *windowFuncs, int numPartCols, int numOrderCols,
 108                            Cost input_startup_cost, Cost input_total_cost,
 109                            double input_tuples);
 110 extern void cost_group(Path *path, PlannerInfo *root,
 111                    int numGroupCols, double numGroups,
 112                    Cost input_startup_cost, Cost input_total_cost,
 113                    double input_tuples);
 114 extern void initial_cost_nestloop(PlannerInfo *root,
 115                                           JoinCostWorkspace *workspace,
 116                                           JoinType jointype,
 117                                           Path *outer_path, Path *inner_path,
 118                                           SpecialJoinInfo *sjinfo,
 119                                           SemiAntiJoinFactors *semifactors);
 120 extern void final_cost_nestloop(PlannerInfo *root, NestPath *path,
 121                                         JoinCostWorkspace *workspace,
 122                                         SpecialJoinInfo *sjinfo,
 123                                         SemiAntiJoinFactors *semifactors);
 124 extern void initial_cost_mergejoin(PlannerInfo *root,
 125                                            JoinCostWorkspace *workspace,
 126                                            JoinType jointype,
 127                                            List *mergeclauses,
 128                                            Path *outer_path, Path *inner_path,
 129                                            List *outersortkeys, List *innersortkeys,
 130                                            SpecialJoinInfo *sjinfo);
 131 extern void final_cost_mergejoin(PlannerInfo *root, MergePath *path,
 132                                          JoinCostWorkspace *workspace,
 133                                          SpecialJoinInfo *sjinfo);
 134 extern void initial_cost_hashjoin(PlannerInfo *root,
 135                                           JoinCostWorkspace *workspace,
 136                                           JoinType jointype,
 137                                           List *hashclauses,
 138                                           Path *outer_path, Path *inner_path,
 139                                           SpecialJoinInfo *sjinfo,
 140                                           SemiAntiJoinFactors *semifactors);
 141 extern void final_cost_hashjoin(PlannerInfo *root, HashPath *path,
 142                                         JoinCostWorkspace *workspace,
 143                                         SpecialJoinInfo *sjinfo,
 144                                         SemiAntiJoinFactors *semifactors);
 145 extern void cost_subplan(PlannerInfo *root, SubPlan *subplan, Plan *plan);
 146 extern void cost_qual_eval(QualCost *cost, List *quals, PlannerInfo *root);
 147 extern void cost_qual_eval_node(QualCost *cost, Node *qual, PlannerInfo *root);
 148 extern void compute_semi_anti_join_factors(PlannerInfo *root,
 149                                                            RelOptInfo *outerrel,
 150                                                            RelOptInfo *innerrel,
 151                                                            JoinType jointype,
 152                                                            SpecialJoinInfo *sjinfo,
 153                                                            List *restrictlist,
 154                                                            SemiAntiJoinFactors *semifactors);
 155 extern void set_baserel_size_estimates(PlannerInfo *root, RelOptInfo *rel);
 156 extern double get_parameterized_baserel_size(PlannerInfo *root,
 157                                                            RelOptInfo *rel,
 158                                                            List *param_clauses);
 159 extern double get_parameterized_joinrel_size(PlannerInfo *root,
 160                                                            RelOptInfo *rel,
 161                                                            double outer_rows,
 162                                                            double inner_rows,
 163                                                            SpecialJoinInfo *sjinfo,
 164                                                            List *restrict_clauses);
 165 extern void set_joinrel_size_estimates(PlannerInfo *root, RelOptInfo *rel,
 166                                                    RelOptInfo *outer_rel,
 167                                                    RelOptInfo *inner_rel,
 168                                                    SpecialJoinInfo *sjinfo,
 169                                                    List *restrictlist);
 170 extern void set_subquery_size_estimates(PlannerInfo *root, RelOptInfo *rel);
 171 extern void set_function_size_estimates(PlannerInfo *root, RelOptInfo *rel);
 172 extern void set_values_size_estimates(PlannerInfo *root, RelOptInfo *rel);
 173 extern void set_cte_size_estimates(PlannerInfo *root, RelOptInfo *rel,
 174                                            Plan *cteplan);
 175 extern void set_foreign_size_estimates(PlannerInfo *root, RelOptInfo *rel);
 176
 177 /*
 178  * prototypes for clausesel.c
 179  *        routines to compute clause selectivities
 180  */
 181 extern Selectivity clauselist_selectivity(PlannerInfo *root,
 182                                            List *clauses,
 183                                            int varRelid,
 184                                            JoinType jointype,
 185                                            SpecialJoinInfo *sjinfo);
 186 extern Selectivity clause_selectivity(PlannerInfo *root,
 187                                    Node *clause,
 188                                    int varRelid,
 189                                    JoinType jointype,
 190                                    SpecialJoinInfo *sjinfo);
 191
 192 #endif   /* COST_H */