codekingpro/portable-devtools

1/*-------------------------------------------------------------------------2 *3 * cost.h4 *	  prototypes for costsize.c and clausesel.c.5 *6 *7 * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group8 * Portions Copyright (c) 1994, Regents of the University of California9 *10 * src/include/optimizer/cost.h11 *12 *-------------------------------------------------------------------------13 */14#ifndef COST_H15#define COST_H16 17#include "nodes/pathnodes.h"18#include "nodes/plannodes.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.conf.sample */24#define DEFAULT_SEQ_PAGE_COST  1.025#define DEFAULT_RANDOM_PAGE_COST  4.026#define DEFAULT_CPU_TUPLE_COST	0.0127#define DEFAULT_CPU_INDEX_TUPLE_COST 0.00528#define DEFAULT_CPU_OPERATOR_COST  0.002529#define DEFAULT_PARALLEL_TUPLE_COST 0.130#define DEFAULT_PARALLEL_SETUP_COST  1000.031 32/* defaults for non-Cost parameters */33#define DEFAULT_RECURSIVE_WORKTABLE_FACTOR  10.034#define DEFAULT_EFFECTIVE_CACHE_SIZE  524288	/* measured in pages */35 36typedef enum37{38	CONSTRAINT_EXCLUSION_OFF,	/* do not use c_e */39	CONSTRAINT_EXCLUSION_ON,	/* apply c_e to all rels */40	CONSTRAINT_EXCLUSION_PARTITION	/* apply c_e to otherrels only */41}			ConstraintExclusionType;42 43 44/*45 * prototypes for costsize.c46 *	  routines to compute costs and sizes47 */48 49/* parameter variables and flags (see also optimizer.h) */50extern PGDLLIMPORT Cost disable_cost;51extern PGDLLIMPORT int max_parallel_workers_per_gather;52extern PGDLLIMPORT bool enable_seqscan;53extern PGDLLIMPORT bool enable_indexscan;54extern PGDLLIMPORT bool enable_indexonlyscan;55extern PGDLLIMPORT bool enable_bitmapscan;56extern PGDLLIMPORT bool enable_tidscan;57extern PGDLLIMPORT bool enable_sort;58extern PGDLLIMPORT bool enable_incremental_sort;59extern PGDLLIMPORT bool enable_hashagg;60extern PGDLLIMPORT bool enable_nestloop;61extern PGDLLIMPORT bool enable_material;62extern PGDLLIMPORT bool enable_memoize;63extern PGDLLIMPORT bool enable_mergejoin;64extern PGDLLIMPORT bool enable_hashjoin;65extern PGDLLIMPORT bool enable_gathermerge;66extern PGDLLIMPORT bool enable_partitionwise_join;67extern PGDLLIMPORT bool enable_partitionwise_aggregate;68extern PGDLLIMPORT bool enable_parallel_append;69extern PGDLLIMPORT bool enable_parallel_hash;70extern PGDLLIMPORT bool enable_partition_pruning;71extern PGDLLIMPORT bool enable_presorted_aggregate;72extern PGDLLIMPORT bool enable_async_append;73extern PGDLLIMPORT int constraint_exclusion;74 75extern double index_pages_fetched(double tuples_fetched, BlockNumber pages,76								  double index_pages, PlannerInfo *root);77extern void cost_seqscan(Path *path, PlannerInfo *root, RelOptInfo *baserel,78						 ParamPathInfo *param_info);79extern void cost_samplescan(Path *path, PlannerInfo *root, RelOptInfo *baserel,80							ParamPathInfo *param_info);81extern void cost_index(IndexPath *path, PlannerInfo *root,82					   double loop_count, bool partial_path);83extern void cost_bitmap_heap_scan(Path *path, PlannerInfo *root, RelOptInfo *baserel,84								  ParamPathInfo *param_info,85								  Path *bitmapqual, double loop_count);86extern void cost_bitmap_and_node(BitmapAndPath *path, PlannerInfo *root);87extern void cost_bitmap_or_node(BitmapOrPath *path, PlannerInfo *root);88extern void cost_bitmap_tree_node(Path *path, Cost *cost, Selectivity *selec);89extern void cost_tidscan(Path *path, PlannerInfo *root,90						 RelOptInfo *baserel, List *tidquals, ParamPathInfo *param_info);91extern void cost_tidrangescan(Path *path, PlannerInfo *root,92							  RelOptInfo *baserel, List *tidrangequals,93							  ParamPathInfo *param_info);94extern void cost_subqueryscan(SubqueryScanPath *path, PlannerInfo *root,95							  RelOptInfo *baserel, ParamPathInfo *param_info,96							  bool trivial_pathtarget);97extern void cost_functionscan(Path *path, PlannerInfo *root,98							  RelOptInfo *baserel, ParamPathInfo *param_info);99extern void cost_valuesscan(Path *path, PlannerInfo *root,100							RelOptInfo *baserel, ParamPathInfo *param_info);101extern void cost_tablefuncscan(Path *path, PlannerInfo *root,102							   RelOptInfo *baserel, ParamPathInfo *param_info);103extern void cost_ctescan(Path *path, PlannerInfo *root,104						 RelOptInfo *baserel, ParamPathInfo *param_info);105extern void cost_namedtuplestorescan(Path *path, PlannerInfo *root,106									 RelOptInfo *baserel, ParamPathInfo *param_info);107extern void cost_resultscan(Path *path, PlannerInfo *root,108							RelOptInfo *baserel, ParamPathInfo *param_info);109extern void cost_recursive_union(Path *runion, Path *nrterm, Path *rterm);110extern void cost_sort(Path *path, PlannerInfo *root,111					  List *pathkeys, Cost input_cost, double tuples, int width,112					  Cost comparison_cost, int sort_mem,113					  double limit_tuples);114extern void cost_incremental_sort(Path *path,115								  PlannerInfo *root, List *pathkeys, int presorted_keys,116								  Cost input_startup_cost, Cost input_total_cost,117								  double input_tuples, int width, Cost comparison_cost, int sort_mem,118								  double limit_tuples);119extern void cost_append(AppendPath *apath);120extern void cost_merge_append(Path *path, PlannerInfo *root,121							  List *pathkeys, int n_streams,122							  Cost input_startup_cost, Cost input_total_cost,123							  double tuples);124extern void cost_material(Path *path,125						  Cost input_startup_cost, Cost input_total_cost,126						  double tuples, int width);127extern void cost_agg(Path *path, PlannerInfo *root,128					 AggStrategy aggstrategy, const AggClauseCosts *aggcosts,129					 int numGroupCols, double numGroups,130					 List *quals,131					 Cost input_startup_cost, Cost input_total_cost,132					 double input_tuples, double input_width);133extern void cost_windowagg(Path *path, PlannerInfo *root,134						   List *windowFuncs, int numPartCols, int numOrderCols,135						   Cost input_startup_cost, Cost input_total_cost,136						   double input_tuples);137extern void cost_group(Path *path, PlannerInfo *root,138					   int numGroupCols, double numGroups,139					   List *quals,140					   Cost input_startup_cost, Cost input_total_cost,141					   double input_tuples);142extern void initial_cost_nestloop(PlannerInfo *root,143								  JoinCostWorkspace *workspace,144								  JoinType jointype,145								  Path *outer_path, Path *inner_path,146								  JoinPathExtraData *extra);147extern void final_cost_nestloop(PlannerInfo *root, NestPath *path,148								JoinCostWorkspace *workspace,149								JoinPathExtraData *extra);150extern void initial_cost_mergejoin(PlannerInfo *root,151								   JoinCostWorkspace *workspace,152								   JoinType jointype,153								   List *mergeclauses,154								   Path *outer_path, Path *inner_path,155								   List *outersortkeys, List *innersortkeys,156								   JoinPathExtraData *extra);157extern void final_cost_mergejoin(PlannerInfo *root, MergePath *path,158								 JoinCostWorkspace *workspace,159								 JoinPathExtraData *extra);160extern void initial_cost_hashjoin(PlannerInfo *root,161								  JoinCostWorkspace *workspace,162								  JoinType jointype,163								  List *hashclauses,164								  Path *outer_path, Path *inner_path,165								  JoinPathExtraData *extra,166								  bool parallel_hash);167extern void final_cost_hashjoin(PlannerInfo *root, HashPath *path,168								JoinCostWorkspace *workspace,169								JoinPathExtraData *extra);170extern void cost_gather(GatherPath *path, PlannerInfo *root,171						RelOptInfo *rel, ParamPathInfo *param_info, double *rows);172extern void cost_gather_merge(GatherMergePath *path, PlannerInfo *root,173							  RelOptInfo *rel, ParamPathInfo *param_info,174							  Cost input_startup_cost, Cost input_total_cost,175							  double *rows);176extern void cost_subplan(PlannerInfo *root, SubPlan *subplan, Plan *plan);177extern void cost_qual_eval(QualCost *cost, List *quals, PlannerInfo *root);178extern void cost_qual_eval_node(QualCost *cost, Node *qual, PlannerInfo *root);179extern void compute_semi_anti_join_factors(PlannerInfo *root,180										   RelOptInfo *joinrel,181										   RelOptInfo *outerrel,182										   RelOptInfo *innerrel,183										   JoinType jointype,184										   SpecialJoinInfo *sjinfo,185										   List *restrictlist,186										   SemiAntiJoinFactors *semifactors);187extern void set_baserel_size_estimates(PlannerInfo *root, RelOptInfo *rel);188extern double get_parameterized_baserel_size(PlannerInfo *root,189											 RelOptInfo *rel,190											 List *param_clauses);191extern double get_parameterized_joinrel_size(PlannerInfo *root,192											 RelOptInfo *rel,193											 Path *outer_path,194											 Path *inner_path,195											 SpecialJoinInfo *sjinfo,196											 List *restrict_clauses);197extern void set_joinrel_size_estimates(PlannerInfo *root, RelOptInfo *rel,198									   RelOptInfo *outer_rel,199									   RelOptInfo *inner_rel,200									   SpecialJoinInfo *sjinfo,201									   List *restrictlist);202extern void set_subquery_size_estimates(PlannerInfo *root, RelOptInfo *rel);203extern void set_function_size_estimates(PlannerInfo *root, RelOptInfo *rel);204extern void set_values_size_estimates(PlannerInfo *root, RelOptInfo *rel);205extern void set_cte_size_estimates(PlannerInfo *root, RelOptInfo *rel,206								   double cte_rows);207extern void set_tablefunc_size_estimates(PlannerInfo *root, RelOptInfo *rel);208extern void set_namedtuplestore_size_estimates(PlannerInfo *root, RelOptInfo *rel);209extern void set_result_size_estimates(PlannerInfo *root, RelOptInfo *rel);210extern void set_foreign_size_estimates(PlannerInfo *root, RelOptInfo *rel);211extern PathTarget *set_pathtarget_cost_width(PlannerInfo *root, PathTarget *target);212extern double compute_bitmap_pages(PlannerInfo *root, RelOptInfo *baserel,213								   Path *bitmapqual, int loop_count, Cost *cost, double *tuple);214 215#endif							/* COST_H */216