1*38fd1498Szrj /* params.c - Run-time parameters.
2*38fd1498Szrj Copyright (C) 2001-2018 Free Software Foundation, Inc.
3*38fd1498Szrj Written by Mark Mitchell <mark@codesourcery.com>.
4*38fd1498Szrj
5*38fd1498Szrj This file is part of GCC.
6*38fd1498Szrj
7*38fd1498Szrj GCC is free software; you can redistribute it and/or modify it under
8*38fd1498Szrj the terms of the GNU General Public License as published by the Free
9*38fd1498Szrj Software Foundation; either version 3, or (at your option) any later
10*38fd1498Szrj version.
11*38fd1498Szrj
12*38fd1498Szrj GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13*38fd1498Szrj WARRANTY; without even the implied warranty of MERCHANTABILITY or
14*38fd1498Szrj FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15*38fd1498Szrj for more details.
16*38fd1498Szrj
17*38fd1498Szrj You should have received a copy of the GNU General Public License
18*38fd1498Szrj along with GCC; see the file COPYING3. If not see
19*38fd1498Szrj <http://www.gnu.org/licenses/>. */
20*38fd1498Szrj
21*38fd1498Szrj #include "config.h"
22*38fd1498Szrj #include "system.h"
23*38fd1498Szrj #include "coretypes.h"
24*38fd1498Szrj #include "common/common-target.h"
25*38fd1498Szrj #include "params.h"
26*38fd1498Szrj #include "params-enum.h"
27*38fd1498Szrj #include "diagnostic-core.h"
28*38fd1498Szrj #include "spellcheck.h"
29*38fd1498Szrj
30*38fd1498Szrj /* An array containing the compiler parameters and their current
31*38fd1498Szrj values. */
32*38fd1498Szrj
33*38fd1498Szrj param_info *compiler_params;
34*38fd1498Szrj
35*38fd1498Szrj /* The number of entries in the table. */
36*38fd1498Szrj static size_t num_compiler_params;
37*38fd1498Szrj
38*38fd1498Szrj /* Whether the parameters have all been initialized and had their
39*38fd1498Szrj default values determined. */
40*38fd1498Szrj static bool params_finished;
41*38fd1498Szrj
42*38fd1498Szrj #define DEFPARAM(ENUM, OPTION, HELP, DEFAULT, MIN, MAX)
43*38fd1498Szrj #define DEFPARAMENUM5(ENUM, OPTION, HELP, DEFAULT, V0, V1, V2, V3, V4) \
44*38fd1498Szrj static const char *values_ ## ENUM [] = { #V0, #V1, #V2, #V3, #V4, NULL };
45*38fd1498Szrj #include "params.def"
46*38fd1498Szrj #undef DEFPARAMENUM5
47*38fd1498Szrj #undef DEFPARAM
48*38fd1498Szrj
49*38fd1498Szrj static const param_info lang_independent_params[] = {
50*38fd1498Szrj #define DEFPARAM(ENUM, OPTION, HELP, DEFAULT, MIN, MAX) \
51*38fd1498Szrj { OPTION, DEFAULT, MIN, MAX, HELP, NULL },
52*38fd1498Szrj #define DEFPARAMENUM5(ENUM, OPTION, HELP, DEFAULT, \
53*38fd1498Szrj V0, V1, V2, V3, V4) \
54*38fd1498Szrj { OPTION, (int)ENUM ## _KIND_ ## DEFAULT, 0, 4, HELP, values_ ## ENUM },
55*38fd1498Szrj #include "params.def"
56*38fd1498Szrj #undef DEFPARAM
57*38fd1498Szrj #undef DEFPARAMENUM5
58*38fd1498Szrj { NULL, 0, 0, 0, NULL, NULL }
59*38fd1498Szrj };
60*38fd1498Szrj
61*38fd1498Szrj /* Add the N PARAMS to the current list of compiler parameters. */
62*38fd1498Szrj
63*38fd1498Szrj void
add_params(const param_info params[],size_t n)64*38fd1498Szrj add_params (const param_info params[], size_t n)
65*38fd1498Szrj {
66*38fd1498Szrj gcc_assert (!params_finished);
67*38fd1498Szrj
68*38fd1498Szrj /* Allocate enough space for the new parameters. */
69*38fd1498Szrj compiler_params = XRESIZEVEC (param_info, compiler_params,
70*38fd1498Szrj num_compiler_params + n);
71*38fd1498Szrj /* Copy them into the table. */
72*38fd1498Szrj memcpy (compiler_params + num_compiler_params,
73*38fd1498Szrj params,
74*38fd1498Szrj n * sizeof (param_info));
75*38fd1498Szrj /* Keep track of how many parameters we have. */
76*38fd1498Szrj num_compiler_params += n;
77*38fd1498Szrj }
78*38fd1498Szrj
79*38fd1498Szrj /* Add all parameters and default values that can be set in both the
80*38fd1498Szrj driver and the compiler proper. */
81*38fd1498Szrj
82*38fd1498Szrj void
global_init_params(void)83*38fd1498Szrj global_init_params (void)
84*38fd1498Szrj {
85*38fd1498Szrj gcc_assert (!params_finished);
86*38fd1498Szrj
87*38fd1498Szrj add_params (lang_independent_params, LAST_PARAM);
88*38fd1498Szrj targetm_common.option_default_params ();
89*38fd1498Szrj }
90*38fd1498Szrj
91*38fd1498Szrj /* Note that all parameters have been added and all default values
92*38fd1498Szrj set. */
93*38fd1498Szrj
94*38fd1498Szrj void
finish_params(void)95*38fd1498Szrj finish_params (void)
96*38fd1498Szrj {
97*38fd1498Szrj params_finished = true;
98*38fd1498Szrj }
99*38fd1498Szrj
100*38fd1498Szrj /* Reset all state within params.c so that we can rerun the compiler
101*38fd1498Szrj within the same process. For use by toplev::finalize. */
102*38fd1498Szrj
103*38fd1498Szrj void
params_c_finalize(void)104*38fd1498Szrj params_c_finalize (void)
105*38fd1498Szrj {
106*38fd1498Szrj XDELETEVEC (compiler_params);
107*38fd1498Szrj compiler_params = NULL;
108*38fd1498Szrj num_compiler_params = 0;
109*38fd1498Szrj params_finished = false;
110*38fd1498Szrj }
111*38fd1498Szrj
112*38fd1498Szrj /* Set the value of the parameter given by NUM to VALUE in PARAMS and
113*38fd1498Szrj PARAMS_SET. If EXPLICIT_P, this is being set by the user;
114*38fd1498Szrj otherwise it is being set implicitly by the compiler. */
115*38fd1498Szrj
116*38fd1498Szrj static void
set_param_value_internal(compiler_param num,int value,int * params,int * params_set,bool explicit_p)117*38fd1498Szrj set_param_value_internal (compiler_param num, int value,
118*38fd1498Szrj int *params, int *params_set,
119*38fd1498Szrj bool explicit_p)
120*38fd1498Szrj {
121*38fd1498Szrj size_t i = (size_t) num;
122*38fd1498Szrj
123*38fd1498Szrj gcc_assert (params_finished);
124*38fd1498Szrj
125*38fd1498Szrj params[i] = value;
126*38fd1498Szrj if (explicit_p)
127*38fd1498Szrj params_set[i] = true;
128*38fd1498Szrj }
129*38fd1498Szrj
130*38fd1498Szrj /* Return true if it can find the matching entry for NAME in the parameter
131*38fd1498Szrj table, and assign the entry index to INDEX. Return false otherwise. */
132*38fd1498Szrj
133*38fd1498Szrj bool
find_param(const char * name,enum compiler_param * index)134*38fd1498Szrj find_param (const char *name, enum compiler_param *index)
135*38fd1498Szrj {
136*38fd1498Szrj for (size_t i = 0; i < num_compiler_params; ++i)
137*38fd1498Szrj if (strcmp (compiler_params[i].option, name) == 0)
138*38fd1498Szrj {
139*38fd1498Szrj *index = (enum compiler_param) i;
140*38fd1498Szrj return true;
141*38fd1498Szrj }
142*38fd1498Szrj
143*38fd1498Szrj return false;
144*38fd1498Szrj }
145*38fd1498Szrj
146*38fd1498Szrj /* Look for the closest match for NAME in the parameter table, returning it
147*38fd1498Szrj if it is a reasonable suggestion for a misspelling. Return NULL
148*38fd1498Szrj otherwise. */
149*38fd1498Szrj
150*38fd1498Szrj const char *
find_param_fuzzy(const char * name)151*38fd1498Szrj find_param_fuzzy (const char *name)
152*38fd1498Szrj {
153*38fd1498Szrj best_match <const char *, const char *> bm (name);
154*38fd1498Szrj for (size_t i = 0; i < num_compiler_params; ++i)
155*38fd1498Szrj bm.consider (compiler_params[i].option);
156*38fd1498Szrj return bm.get_best_meaningful_candidate ();
157*38fd1498Szrj }
158*38fd1498Szrj
159*38fd1498Szrj /* Return true if param with entry index INDEX should be defined using strings.
160*38fd1498Szrj If so, return the value corresponding to VALUE_NAME in *VALUE_P. */
161*38fd1498Szrj
162*38fd1498Szrj bool
param_string_value_p(enum compiler_param index,const char * value_name,int * value_p)163*38fd1498Szrj param_string_value_p (enum compiler_param index, const char *value_name,
164*38fd1498Szrj int *value_p)
165*38fd1498Szrj {
166*38fd1498Szrj param_info *entry = &compiler_params[(int) index];
167*38fd1498Szrj if (entry->value_names == NULL)
168*38fd1498Szrj return false;
169*38fd1498Szrj
170*38fd1498Szrj *value_p = -1;
171*38fd1498Szrj
172*38fd1498Szrj for (int i = 0; entry->value_names[i] != NULL; ++i)
173*38fd1498Szrj if (strcmp (entry->value_names[i], value_name) == 0)
174*38fd1498Szrj {
175*38fd1498Szrj *value_p = i;
176*38fd1498Szrj return true;
177*38fd1498Szrj }
178*38fd1498Szrj
179*38fd1498Szrj return true;
180*38fd1498Szrj }
181*38fd1498Szrj
182*38fd1498Szrj /* Set the VALUE associated with the parameter given by NAME in PARAMS
183*38fd1498Szrj and PARAMS_SET. */
184*38fd1498Szrj
185*38fd1498Szrj void
set_param_value(const char * name,int value,int * params,int * params_set)186*38fd1498Szrj set_param_value (const char *name, int value,
187*38fd1498Szrj int *params, int *params_set)
188*38fd1498Szrj {
189*38fd1498Szrj size_t i;
190*38fd1498Szrj
191*38fd1498Szrj /* Make sure nobody tries to set a parameter to an invalid value. */
192*38fd1498Szrj gcc_assert (value != INVALID_PARAM_VAL);
193*38fd1498Szrj
194*38fd1498Szrj enum compiler_param index;
195*38fd1498Szrj if (!find_param (name, &index))
196*38fd1498Szrj {
197*38fd1498Szrj /* If we didn't find this parameter, issue an error message. */
198*38fd1498Szrj error ("invalid parameter %qs", name);
199*38fd1498Szrj return;
200*38fd1498Szrj }
201*38fd1498Szrj i = (size_t)index;
202*38fd1498Szrj
203*38fd1498Szrj if (value < compiler_params[i].min_value)
204*38fd1498Szrj error ("minimum value of parameter %qs is %u",
205*38fd1498Szrj compiler_params[i].option,
206*38fd1498Szrj compiler_params[i].min_value);
207*38fd1498Szrj else if (compiler_params[i].max_value > compiler_params[i].min_value
208*38fd1498Szrj && value > compiler_params[i].max_value)
209*38fd1498Szrj error ("maximum value of parameter %qs is %u",
210*38fd1498Szrj compiler_params[i].option,
211*38fd1498Szrj compiler_params[i].max_value);
212*38fd1498Szrj else
213*38fd1498Szrj set_param_value_internal ((compiler_param) i, value,
214*38fd1498Szrj params, params_set, true);
215*38fd1498Szrj }
216*38fd1498Szrj
217*38fd1498Szrj /* Set the value of the parameter given by NUM to VALUE in PARAMS and
218*38fd1498Szrj PARAMS_SET, implicitly, if it has not been set explicitly by the
219*38fd1498Szrj user. */
220*38fd1498Szrj
221*38fd1498Szrj void
maybe_set_param_value(compiler_param num,int value,int * params,int * params_set)222*38fd1498Szrj maybe_set_param_value (compiler_param num, int value,
223*38fd1498Szrj int *params, int *params_set)
224*38fd1498Szrj {
225*38fd1498Szrj if (!params_set[(int) num])
226*38fd1498Szrj set_param_value_internal (num, value, params, params_set, false);
227*38fd1498Szrj }
228*38fd1498Szrj
229*38fd1498Szrj /* Set the default value of a parameter given by NUM to VALUE, before
230*38fd1498Szrj option processing. */
231*38fd1498Szrj
232*38fd1498Szrj void
set_default_param_value(compiler_param num,int value)233*38fd1498Szrj set_default_param_value (compiler_param num, int value)
234*38fd1498Szrj {
235*38fd1498Szrj gcc_assert (!params_finished);
236*38fd1498Szrj
237*38fd1498Szrj compiler_params[(int) num].default_value = value;
238*38fd1498Szrj }
239*38fd1498Szrj
240*38fd1498Szrj /* Return the default value of parameter NUM. */
241*38fd1498Szrj
242*38fd1498Szrj int
default_param_value(compiler_param num)243*38fd1498Szrj default_param_value (compiler_param num)
244*38fd1498Szrj {
245*38fd1498Szrj return compiler_params[(int) num].default_value;
246*38fd1498Szrj }
247*38fd1498Szrj
248*38fd1498Szrj /* Initialize an array PARAMS with default values of the
249*38fd1498Szrj parameters. */
250*38fd1498Szrj
251*38fd1498Szrj void
init_param_values(int * params)252*38fd1498Szrj init_param_values (int *params)
253*38fd1498Szrj {
254*38fd1498Szrj size_t i;
255*38fd1498Szrj
256*38fd1498Szrj gcc_assert (params_finished);
257*38fd1498Szrj
258*38fd1498Szrj for (i = 0; i < num_compiler_params; i++)
259*38fd1498Szrj params[i] = compiler_params[i].default_value;
260*38fd1498Szrj }
261*38fd1498Szrj
262*38fd1498Szrj /* Return the current value of num_compiler_params, for the benefit of
263*38fd1498Szrj plugins that use parameters as features. */
264*38fd1498Szrj
265*38fd1498Szrj size_t
get_num_compiler_params(void)266*38fd1498Szrj get_num_compiler_params (void)
267*38fd1498Szrj {
268*38fd1498Szrj return num_compiler_params;
269*38fd1498Szrj }
270