xref: /openbsd/gnu/usr.bin/gcc/gcc/params.h (revision c87b03e5)
1 /* params.h - Run-time parameters.
2    Copyright (C) 2001 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 2, 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 COPYING.  If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, 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 
44 typedef 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   /* A short description of the option.  */
52   const char *const help;
53 } param_info;
54 
55 /* An array containing the compiler parameters and their current
56    values.  */
57 
58 extern param_info *compiler_params;
59 
60 /* Add the N PARAMS to the current list of compiler parameters.  */
61 
62 extern void add_params
63   PARAMS ((const param_info params[], size_t n));
64 
65 /* Set the VALUE associated with the parameter given by NAME.  */
66 
67 extern void set_param_value
68   PARAMS ((const char *name, int value));
69 
70 
71 /* The parameters in use by language-independent code.  */
72 
73 typedef enum compiler_param
74 {
75 #define DEFPARAM(enumerator, option, msgid, default) \
76   enumerator,
77 #include "params.def"
78 #undef DEFPARAM
79   LAST_PARAM
80 } compiler_param;
81 
82 /* The value of the parameter given by ENUM.  */
83 #define PARAM_VALUE(ENUM) \
84   (compiler_params[(int) ENUM].value)
85 
86 /* Macros for the various parameters.  */
87 #define MAX_INLINE_INSNS_SINGLE \
88   PARAM_VALUE (PARAM_MAX_INLINE_INSNS_SINGLE)
89 #define MAX_INLINE_INSNS \
90   PARAM_VALUE (PARAM_MAX_INLINE_INSNS)
91 #define MAX_INLINE_SLOPE \
92   PARAM_VALUE (PARAM_MAX_INLINE_SLOPE)
93 #define MIN_INLINE_INSNS \
94   PARAM_VALUE (PARAM_MIN_INLINE_INSNS)
95 #define MAX_INLINE_INSNS_AUTO \
96   PARAM_VALUE (PARAM_MAX_INLINE_INSNS_AUTO)
97 #define MAX_INLINE_INSNS_RTL \
98   PARAM_VALUE (PARAM_MAX_INLINE_INSNS_RTL)
99 #define MAX_DELAY_SLOT_INSN_SEARCH \
100   PARAM_VALUE (PARAM_MAX_DELAY_SLOT_INSN_SEARCH)
101 #define MAX_DELAY_SLOT_LIVE_SEARCH \
102   PARAM_VALUE (PARAM_MAX_DELAY_SLOT_LIVE_SEARCH)
103 #define MAX_PENDING_LIST_LENGTH \
104   PARAM_VALUE (PARAM_MAX_PENDING_LIST_LENGTH)
105 #define MAX_GCSE_MEMORY \
106   ((size_t) PARAM_VALUE (PARAM_MAX_GCSE_MEMORY))
107 #define MAX_GCSE_PASSES \
108   PARAM_VALUE (PARAM_MAX_GCSE_PASSES)
109 #define MAX_UNROLLED_INSNS \
110   PARAM_VALUE (PARAM_MAX_UNROLLED_INSNS)
111 #endif /* ! GCC_PARAMS_H */
112