1/* params.h - Run-time parameters.
2   Copyright (C) 2001, 2003, 2004, 2005, 2007, 2008, 2009, 2010, 2011
3   Free Software Foundation, Inc.
4   Written by Mark Mitchell <mark@codesourcery.com>.
5
6This file is part of GCC.
7
8GCC is free software; you can redistribute it and/or modify it under
9the terms of the GNU General Public License as published by the Free
10Software Foundation; either version 3, or (at your option) any later
11version.
12
13GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14WARRANTY; without even the implied warranty of MERCHANTABILITY or
15FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16for more details.
17
18You should have received a copy of the GNU General Public License
19along with GCC; see the file COPYING3.  If not see
20<http://www.gnu.org/licenses/>.  */
21
22/* This module provides a means for setting integral parameters
23   dynamically.  Instead of encoding magic numbers in various places,
24   use this module to organize all the magic numbers in a single
25   place.  The values of the parameters can be set on the
26   command-line, thereby providing a way to control the amount of
27   effort spent on particular optimization passes, or otherwise tune
28   the behavior of the compiler.
29
30   Since their values can be set on the command-line, these parameters
31   should not be used for non-dynamic memory allocation.  */
32
33#ifndef GCC_PARAMS_H
34#define GCC_PARAMS_H
35
36/* No parameter shall have this value.  */
37
38#define INVALID_PARAM_VAL (-1)
39
40/* The information associated with each parameter.  */
41
42typedef struct param_info
43{
44  /* The name used with the `--param <name>=<value>' switch to set this
45     value.  */
46  const char *const option;
47
48  /* The default value.  */
49  int default_value;
50
51  /* Minimum acceptable value.  */
52  int min_value;
53
54  /* Maximum acceptable value, if greater than minimum  */
55  int max_value;
56
57  /* A short description of the option.  */
58  const char *const help;
59} param_info;
60
61/* An array containing the compiler parameters and their current
62   values.  */
63
64extern param_info *compiler_params;
65
66/* Returns the number of entries in the table, for the use by plugins.  */
67extern size_t get_num_compiler_params (void);
68
69/* Add the N PARAMS to the current list of compiler parameters.  */
70
71extern void add_params (const param_info params[], size_t n);
72
73/* Set the VALUE associated with the parameter given by NAME in the
74   table PARAMS using PARAMS_SET to indicate which have been
75   explicitly set.  */
76
77extern void set_param_value (const char *name, int value,
78			     int *params, int *params_set);
79
80
81/* The parameters in use by language-independent code.  */
82
83typedef enum compiler_param
84{
85#define DEFPARAM(enumerator, option, msgid, default, min, max) \
86  enumerator,
87#include "params.def"
88#undef DEFPARAM
89  LAST_PARAM
90} compiler_param;
91
92/* The value of the parameter given by ENUM.  Not an lvalue.  */
93#define PARAM_VALUE(ENUM) \
94  ((int) global_options.x_param_values[(int) ENUM])
95
96/* Set the value of the parameter given by NUM to VALUE, implicitly,
97   if it has not been set explicitly by the user, in the table PARAMS
98   using PARAMS_SET to indicate which have been explicitly set.  */
99
100extern void maybe_set_param_value (compiler_param num, int value,
101				   int *params, int *params_set);
102
103/* Set the default value of a parameter given by NUM to VALUE, before
104   option processing.  */
105
106extern void set_default_param_value (compiler_param num, int value);
107
108/* Note that all parameters have been added and all default values
109   set.  */
110extern void finish_params (void);
111
112/* Return the default value of parameter NUM.  */
113
114extern int default_param_value (compiler_param num);
115
116/* Initialize an array PARAMS with default values of the
117   parameters.  */
118extern void init_param_values (int *params);
119
120/* Macros for the various parameters.  */
121#define STRUCT_REORG_COLD_STRUCT_RATIO \
122  PARAM_VALUE (PARAM_STRUCT_REORG_COLD_STRUCT_RATIO)
123#define MAX_INLINE_INSNS_SINGLE \
124  PARAM_VALUE (PARAM_MAX_INLINE_INSNS_SINGLE)
125#define MAX_INLINE_INSNS \
126  PARAM_VALUE (PARAM_MAX_INLINE_INSNS)
127#define MAX_INLINE_SLOPE \
128  PARAM_VALUE (PARAM_MAX_INLINE_SLOPE)
129#define MIN_INLINE_INSNS \
130  PARAM_VALUE (PARAM_MIN_INLINE_INSNS)
131#define MAX_INLINE_INSNS_AUTO \
132  PARAM_VALUE (PARAM_MAX_INLINE_INSNS_AUTO)
133#define MAX_VARIABLE_EXPANSIONS \
134  PARAM_VALUE (PARAM_MAX_VARIABLE_EXPANSIONS)
135#define MIN_VECT_LOOP_BOUND \
136  PARAM_VALUE (PARAM_MIN_VECT_LOOP_BOUND)
137#define MAX_DELAY_SLOT_INSN_SEARCH \
138  PARAM_VALUE (PARAM_MAX_DELAY_SLOT_INSN_SEARCH)
139#define MAX_DELAY_SLOT_LIVE_SEARCH \
140  PARAM_VALUE (PARAM_MAX_DELAY_SLOT_LIVE_SEARCH)
141#define MAX_PENDING_LIST_LENGTH \
142  PARAM_VALUE (PARAM_MAX_PENDING_LIST_LENGTH)
143#define MAX_GCSE_MEMORY \
144  ((size_t) PARAM_VALUE (PARAM_MAX_GCSE_MEMORY))
145#define MAX_GCSE_INSERTION_RATIO \
146  ((size_t) PARAM_VALUE (PARAM_MAX_GCSE_INSERTION_RATIO))
147#define GCSE_AFTER_RELOAD_PARTIAL_FRACTION \
148  PARAM_VALUE (PARAM_GCSE_AFTER_RELOAD_PARTIAL_FRACTION)
149#define GCSE_AFTER_RELOAD_CRITICAL_FRACTION \
150  PARAM_VALUE (PARAM_GCSE_AFTER_RELOAD_CRITICAL_FRACTION)
151#define GCSE_COST_DISTANCE_RATIO \
152  PARAM_VALUE (PARAM_GCSE_COST_DISTANCE_RATIO)
153#define GCSE_UNRESTRICTED_COST \
154  PARAM_VALUE (PARAM_GCSE_UNRESTRICTED_COST)
155#define MAX_HOIST_DEPTH \
156  PARAM_VALUE (PARAM_MAX_HOIST_DEPTH)
157#define MAX_UNROLLED_INSNS \
158  PARAM_VALUE (PARAM_MAX_UNROLLED_INSNS)
159#define MAX_SMS_LOOP_NUMBER \
160  PARAM_VALUE (PARAM_MAX_SMS_LOOP_NUMBER)
161#define SMS_MAX_II_FACTOR \
162  PARAM_VALUE (PARAM_SMS_MAX_II_FACTOR)
163#define SMS_DFA_HISTORY \
164  PARAM_VALUE (PARAM_SMS_DFA_HISTORY)
165#define SMS_LOOP_AVERAGE_COUNT_THRESHOLD \
166  PARAM_VALUE (PARAM_SMS_LOOP_AVERAGE_COUNT_THRESHOLD)
167#define INTEGER_SHARE_LIMIT \
168  PARAM_VALUE (PARAM_INTEGER_SHARE_LIMIT)
169#define MAX_LAST_VALUE_RTL \
170  PARAM_VALUE (PARAM_MAX_LAST_VALUE_RTL)
171#define MIN_VIRTUAL_MAPPINGS \
172  PARAM_VALUE (PARAM_MIN_VIRTUAL_MAPPINGS)
173#define VIRTUAL_MAPPINGS_TO_SYMS_RATIO \
174  PARAM_VALUE (PARAM_VIRTUAL_MAPPINGS_TO_SYMS_RATIO)
175#define MAX_FIELDS_FOR_FIELD_SENSITIVE \
176  ((size_t) PARAM_VALUE (PARAM_MAX_FIELDS_FOR_FIELD_SENSITIVE))
177#define MAX_SCHED_READY_INSNS \
178  PARAM_VALUE (PARAM_MAX_SCHED_READY_INSNS)
179#define PREFETCH_LATENCY \
180  PARAM_VALUE (PARAM_PREFETCH_LATENCY)
181#define SIMULTANEOUS_PREFETCHES \
182  PARAM_VALUE (PARAM_SIMULTANEOUS_PREFETCHES)
183#define L1_CACHE_SIZE \
184  PARAM_VALUE (PARAM_L1_CACHE_SIZE)
185#define L1_CACHE_LINE_SIZE \
186  PARAM_VALUE (PARAM_L1_CACHE_LINE_SIZE)
187#define L2_CACHE_SIZE \
188  PARAM_VALUE (PARAM_L2_CACHE_SIZE)
189#define USE_CANONICAL_TYPES \
190  PARAM_VALUE (PARAM_USE_CANONICAL_TYPES)
191#define IRA_MAX_LOOPS_NUM \
192  PARAM_VALUE (PARAM_IRA_MAX_LOOPS_NUM)
193#define IRA_MAX_CONFLICT_TABLE_SIZE \
194  PARAM_VALUE (PARAM_IRA_MAX_CONFLICT_TABLE_SIZE)
195#define IRA_LOOP_RESERVED_REGS \
196  PARAM_VALUE (PARAM_IRA_LOOP_RESERVED_REGS)
197#define SWITCH_CONVERSION_BRANCH_RATIO \
198  PARAM_VALUE (PARAM_SWITCH_CONVERSION_BRANCH_RATIO)
199#define LOOP_INVARIANT_MAX_BBS_IN_LOOP \
200  PARAM_VALUE (PARAM_LOOP_INVARIANT_MAX_BBS_IN_LOOP)
201#define SLP_MAX_INSNS_IN_BB \
202  PARAM_VALUE (PARAM_SLP_MAX_INSNS_IN_BB)
203#define MIN_INSN_TO_PREFETCH_RATIO \
204  PARAM_VALUE (PARAM_MIN_INSN_TO_PREFETCH_RATIO)
205#define PREFETCH_MIN_INSN_TO_MEM_RATIO \
206  PARAM_VALUE (PARAM_PREFETCH_MIN_INSN_TO_MEM_RATIO)
207#define MIN_NONDEBUG_INSN_UID \
208  PARAM_VALUE (PARAM_MIN_NONDEBUG_INSN_UID)
209#endif /* ! GCC_PARAMS_H */
210