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