1/* params.h - Run-time parameters.
2   Copyright (C) 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
3   Written by Mark Mitchell <mark@codesourcery.com>.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 2, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING.  If not, write to the Free
19Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
2002110-1301, USA.
21
22*/
23
24/* This module provides a means for setting integral parameters
25   dynamically.  Instead of encoding magic numbers in various places,
26   use this module to organize all the magic numbers in a single
27   place.  The values of the parameters can be set on the
28   command-line, thereby providing a way to control the amount of
29   effort spent on particular optimization passes, or otherwise tune
30   the behavior of the compiler.
31
32   Since their values can be set on the command-line, these parameters
33   should not be used for non-dynamic memory allocation.  */
34
35#ifndef GCC_PARAMS_H
36#define GCC_PARAMS_H
37
38/* No parameter shall have this value.  */
39
40#define INVALID_PARAM_VAL (-1)
41
42/* The information associated with each parameter.  */
43
44typedef struct param_info
45{
46  /* The name used with the `--param <name>=<value>' switch to set this
47     value.  */
48  const char *const option;
49  /* The associated value.  */
50  int value;
51
52  /* Minimum acceptable value.  */
53  int min_value;
54
55  /* Maximum acceptable value, if greater than minimum  */
56  int max_value;
57
58  /* A short description of the option.  */
59  const char *const help;
60} param_info;
61
62/* An array containing the compiler parameters and their current
63   values.  */
64
65extern param_info *compiler_params;
66
67/* Add the N PARAMS to the current list of compiler parameters.  */
68
69extern void add_params (const param_info params[], size_t n);
70
71/* Set the VALUE associated with the parameter given by NAME.  */
72
73extern void set_param_value (const char *name, int value);
74
75
76/* The parameters in use by language-independent code.  */
77
78typedef enum compiler_param
79{
80#define DEFPARAM(enumerator, option, msgid, default, min, max) \
81  enumerator,
82#include "params.def"
83#undef DEFPARAM
84  LAST_PARAM
85} compiler_param;
86
87/* The value of the parameter given by ENUM.  */
88#define PARAM_VALUE(ENUM) \
89  (compiler_params[(int) ENUM].value)
90
91/* Macros for the various parameters.  */
92#define SALIAS_MAX_IMPLICIT_FIELDS \
93  PARAM_VALUE (PARAM_SALIAS_MAX_IMPLICIT_FIELDS)
94#define SALIAS_MAX_ARRAY_ELEMENTS \
95  PARAM_VALUE (PARAM_SALIAS_MAX_ARRAY_ELEMENTS)
96#define SRA_MAX_STRUCTURE_SIZE \
97  PARAM_VALUE (PARAM_SRA_MAX_STRUCTURE_SIZE)
98#define SRA_MAX_STRUCTURE_COUNT \
99  PARAM_VALUE (PARAM_SRA_MAX_STRUCTURE_COUNT)
100#define SRA_FIELD_STRUCTURE_RATIO \
101  PARAM_VALUE (PARAM_SRA_FIELD_STRUCTURE_RATIO)
102#define MAX_INLINE_INSNS_SINGLE \
103  PARAM_VALUE (PARAM_MAX_INLINE_INSNS_SINGLE)
104#define MAX_INLINE_INSNS \
105  PARAM_VALUE (PARAM_MAX_INLINE_INSNS)
106#define MAX_INLINE_SLOPE \
107  PARAM_VALUE (PARAM_MAX_INLINE_SLOPE)
108#define MIN_INLINE_INSNS \
109  PARAM_VALUE (PARAM_MIN_INLINE_INSNS)
110#define MAX_INLINE_INSNS_AUTO \
111  PARAM_VALUE (PARAM_MAX_INLINE_INSNS_AUTO)
112#define MAX_VARIABLE_EXPANSIONS \
113  PARAM_VALUE (PARAM_MAX_VARIABLE_EXPANSIONS)
114#define MAX_DELAY_SLOT_INSN_SEARCH \
115  PARAM_VALUE (PARAM_MAX_DELAY_SLOT_INSN_SEARCH)
116#define MAX_DELAY_SLOT_LIVE_SEARCH \
117  PARAM_VALUE (PARAM_MAX_DELAY_SLOT_LIVE_SEARCH)
118#define MAX_PENDING_LIST_LENGTH \
119  PARAM_VALUE (PARAM_MAX_PENDING_LIST_LENGTH)
120#define MAX_GCSE_MEMORY \
121  ((size_t) PARAM_VALUE (PARAM_MAX_GCSE_MEMORY))
122#define MAX_GCSE_PASSES \
123  PARAM_VALUE (PARAM_MAX_GCSE_PASSES)
124#define GCSE_AFTER_RELOAD_PARTIAL_FRACTION \
125  PARAM_VALUE (PARAM_GCSE_AFTER_RELOAD_PARTIAL_FRACTION)
126#define GCSE_AFTER_RELOAD_CRITICAL_FRACTION \
127  PARAM_VALUE (PARAM_GCSE_AFTER_RELOAD_CRITICAL_FRACTION)
128#define MAX_UNROLLED_INSNS \
129  PARAM_VALUE (PARAM_MAX_UNROLLED_INSNS)
130#define MAX_SMS_LOOP_NUMBER \
131  PARAM_VALUE (PARAM_MAX_SMS_LOOP_NUMBER)
132#define SMS_MAX_II_FACTOR \
133  PARAM_VALUE (PARAM_SMS_MAX_II_FACTOR)
134#define SMS_DFA_HISTORY \
135  PARAM_VALUE (PARAM_SMS_DFA_HISTORY)
136#define SMS_LOOP_AVERAGE_COUNT_THRESHOLD \
137  PARAM_VALUE (PARAM_SMS_LOOP_AVERAGE_COUNT_THRESHOLD)
138#define GLOBAL_VAR_THRESHOLD \
139  PARAM_VALUE (PARAM_GLOBAL_VAR_THRESHOLD)
140#define MAX_ALIASED_VOPS \
141  PARAM_VALUE (PARAM_MAX_ALIASED_VOPS)
142#define INTEGER_SHARE_LIMIT \
143  PARAM_VALUE (PARAM_INTEGER_SHARE_LIMIT)
144#define MAX_LAST_VALUE_RTL \
145  PARAM_VALUE (PARAM_MAX_LAST_VALUE_RTL)
146#define MIN_VIRTUAL_MAPPINGS \
147  PARAM_VALUE (PARAM_MIN_VIRTUAL_MAPPINGS)
148#define VIRTUAL_MAPPINGS_TO_SYMS_RATIO \
149  PARAM_VALUE (PARAM_VIRTUAL_MAPPINGS_TO_SYMS_RATIO)
150#define MAX_FIELDS_FOR_FIELD_SENSITIVE \
151  ((size_t) PARAM_VALUE (PARAM_MAX_FIELDS_FOR_FIELD_SENSITIVE))
152#define MAX_SCHED_READY_INSNS \
153  PARAM_VALUE (PARAM_MAX_SCHED_READY_INSNS)
154#endif /* ! GCC_PARAMS_H */
155