gcc/params.h

   1 /* params.h - Run-time parameters.
   2    Copyright (C) 2001-2015 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 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;
  58 };
  59
  60 /* An array containing the compiler parameters and their current
  61    values.  */
  62
  63 extern param_info *compiler_params;
  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 \f
  80 /* The parameters in use by language-independent code.  */
  81
  82 enum compiler_param
  83 {
  84 #include "params.list"
  85   LAST_PARAM
  86 };
  87
  88 /* The value of the parameter given by ENUM.  Not an lvalue.  */
  89 #define PARAM_VALUE(ENUM) \
  90   ((int) global_options.x_param_values[(int) ENUM])
  91
  92 /* Set the value of the parameter given by NUM to VALUE, implicitly,
  93    if it has not been set explicitly by the user, in the table PARAMS
  94    using PARAMS_SET to indicate which have been explicitly set.  */
  95
  96 extern void maybe_set_param_value (compiler_param num, int value,
  97                                    int *params, int *params_set);
  98
  99 /* Set the default value of a parameter given by NUM to VALUE, before
 100    option processing.  */
 101
 102 extern void set_default_param_value (compiler_param num, int value);
 103
 104 /* Add all parameters and default values that can be set in both the
 105    driver and the compiler proper.  */
 106
 107 extern void global_init_params (void);
 108
 109 /* Note that all parameters have been added and all default values
 110    set.  */
 111 extern void finish_params (void);
 112
 113 /* Reset all state in params.c  */
 114
 115 extern void params_c_finalize (void);
 116
 117 /* Return the default value of parameter NUM.  */
 118
 119 extern int default_param_value (compiler_param num);
 120
 121 /* Initialize an array PARAMS with default values of the
 122    parameters.  */
 123 extern void init_param_values (int *params);
 124
 125 /* Macros for the various parameters.  */
 126 #define MAX_INLINE_INSNS_SINGLE \
 127   PARAM_VALUE (PARAM_MAX_INLINE_INSNS_SINGLE)
 128 #define MAX_INLINE_INSNS \
 129   PARAM_VALUE (PARAM_MAX_INLINE_INSNS)
 130 #define MAX_INLINE_SLOPE \
 131   PARAM_VALUE (PARAM_MAX_INLINE_SLOPE)
 132 #define MIN_INLINE_INSNS \
 133   PARAM_VALUE (PARAM_MIN_INLINE_INSNS)
 134 #define MAX_INLINE_INSNS_AUTO \
 135   PARAM_VALUE (PARAM_MAX_INLINE_INSNS_AUTO)
 136 #define MAX_VARIABLE_EXPANSIONS \
 137   PARAM_VALUE (PARAM_MAX_VARIABLE_EXPANSIONS)
 138 #define MIN_VECT_LOOP_BOUND \
 139   PARAM_VALUE (PARAM_MIN_VECT_LOOP_BOUND)
 140 #define MAX_DELAY_SLOT_INSN_SEARCH \
 141   PARAM_VALUE (PARAM_MAX_DELAY_SLOT_INSN_SEARCH)
 142 #define MAX_DELAY_SLOT_LIVE_SEARCH \
 143   PARAM_VALUE (PARAM_MAX_DELAY_SLOT_LIVE_SEARCH)
 144 #define MAX_PENDING_LIST_LENGTH \
 145   PARAM_VALUE (PARAM_MAX_PENDING_LIST_LENGTH)
 146 #define MAX_GCSE_MEMORY \
 147   ((size_t) PARAM_VALUE (PARAM_MAX_GCSE_MEMORY))
 148 #define MAX_GCSE_INSERTION_RATIO \
 149   ((size_t) PARAM_VALUE (PARAM_MAX_GCSE_INSERTION_RATIO))
 150 #define GCSE_AFTER_RELOAD_PARTIAL_FRACTION \
 151   PARAM_VALUE (PARAM_GCSE_AFTER_RELOAD_PARTIAL_FRACTION)
 152 #define GCSE_AFTER_RELOAD_CRITICAL_FRACTION \
 153   PARAM_VALUE (PARAM_GCSE_AFTER_RELOAD_CRITICAL_FRACTION)
 154 #define GCSE_COST_DISTANCE_RATIO \
 155   PARAM_VALUE (PARAM_GCSE_COST_DISTANCE_RATIO)
 156 #define GCSE_UNRESTRICTED_COST \
 157   PARAM_VALUE (PARAM_GCSE_UNRESTRICTED_COST)
 158 #define MAX_HOIST_DEPTH \
 159   PARAM_VALUE (PARAM_MAX_HOIST_DEPTH)
 160 #define MAX_UNROLLED_INSNS \
 161   PARAM_VALUE (PARAM_MAX_UNROLLED_INSNS)
 162 #define MAX_SMS_LOOP_NUMBER \
 163   PARAM_VALUE (PARAM_MAX_SMS_LOOP_NUMBER)
 164 #define SMS_MAX_II_FACTOR \
 165   PARAM_VALUE (PARAM_SMS_MAX_II_FACTOR)
 166 #define SMS_DFA_HISTORY \
 167   PARAM_VALUE (PARAM_SMS_DFA_HISTORY)
 168 #define SMS_LOOP_AVERAGE_COUNT_THRESHOLD \
 169   PARAM_VALUE (PARAM_SMS_LOOP_AVERAGE_COUNT_THRESHOLD)
 170 #define INTEGER_SHARE_LIMIT \
 171   PARAM_VALUE (PARAM_INTEGER_SHARE_LIMIT)
 172 #define MAX_LAST_VALUE_RTL \
 173   PARAM_VALUE (PARAM_MAX_LAST_VALUE_RTL)
 174 #define MIN_VIRTUAL_MAPPINGS \
 175   PARAM_VALUE (PARAM_MIN_VIRTUAL_MAPPINGS)
 176 #define VIRTUAL_MAPPINGS_TO_SYMS_RATIO \
 177   PARAM_VALUE (PARAM_VIRTUAL_MAPPINGS_TO_SYMS_RATIO)
 178 #define MAX_FIELDS_FOR_FIELD_SENSITIVE \
 179   ((size_t) PARAM_VALUE (PARAM_MAX_FIELDS_FOR_FIELD_SENSITIVE))
 180 #define MAX_SCHED_READY_INSNS \
 181   PARAM_VALUE (PARAM_MAX_SCHED_READY_INSNS)
 182 #define PREFETCH_LATENCY \
 183   PARAM_VALUE (PARAM_PREFETCH_LATENCY)
 184 #define SIMULTANEOUS_PREFETCHES \
 185   PARAM_VALUE (PARAM_SIMULTANEOUS_PREFETCHES)
 186 #define L1_CACHE_SIZE \
 187   PARAM_VALUE (PARAM_L1_CACHE_SIZE)
 188 #define L1_CACHE_LINE_SIZE \
 189   PARAM_VALUE (PARAM_L1_CACHE_LINE_SIZE)
 190 #define L2_CACHE_SIZE \
 191   PARAM_VALUE (PARAM_L2_CACHE_SIZE)
 192 #define USE_CANONICAL_TYPES \
 193   PARAM_VALUE (PARAM_USE_CANONICAL_TYPES)
 194 #define IRA_MAX_LOOPS_NUM \
 195   PARAM_VALUE (PARAM_IRA_MAX_LOOPS_NUM)
 196 #define IRA_MAX_CONFLICT_TABLE_SIZE \
 197   PARAM_VALUE (PARAM_IRA_MAX_CONFLICT_TABLE_SIZE)
 198 #define IRA_LOOP_RESERVED_REGS \
 199   PARAM_VALUE (PARAM_IRA_LOOP_RESERVED_REGS)
 200 #define LRA_MAX_CONSIDERED_RELOAD_PSEUDOS \
 201   PARAM_VALUE (PARAM_LRA_MAX_CONSIDERED_RELOAD_PSEUDOS)
 202 #define LRA_INHERITANCE_EBB_PROBABILITY_CUTOFF \
 203   PARAM_VALUE (PARAM_LRA_INHERITANCE_EBB_PROBABILITY_CUTOFF)
 204 #define SWITCH_CONVERSION_BRANCH_RATIO \
 205   PARAM_VALUE (PARAM_SWITCH_CONVERSION_BRANCH_RATIO)
 206 #define LOOP_INVARIANT_MAX_BBS_IN_LOOP \
 207   PARAM_VALUE (PARAM_LOOP_INVARIANT_MAX_BBS_IN_LOOP)
 208 #define SLP_MAX_INSNS_IN_BB \
 209   PARAM_VALUE (PARAM_SLP_MAX_INSNS_IN_BB)
 210 #define MIN_INSN_TO_PREFETCH_RATIO \
 211   PARAM_VALUE (PARAM_MIN_INSN_TO_PREFETCH_RATIO)
 212 #define PREFETCH_MIN_INSN_TO_MEM_RATIO \
 213   PARAM_VALUE (PARAM_PREFETCH_MIN_INSN_TO_MEM_RATIO)
 214 #define MIN_NONDEBUG_INSN_UID \
 215   PARAM_VALUE (PARAM_MIN_NONDEBUG_INSN_UID)
 216 #define MAX_STORES_TO_SINK \
 217   PARAM_VALUE (PARAM_MAX_STORES_TO_SINK)
 218 #define ALLOW_LOAD_DATA_RACES \
 219   PARAM_VALUE (PARAM_ALLOW_LOAD_DATA_RACES)
 220 #define ALLOW_STORE_DATA_RACES \
 221   PARAM_VALUE (PARAM_ALLOW_STORE_DATA_RACES)
 222 #define ALLOW_PACKED_LOAD_DATA_RACES \
 223   PARAM_VALUE (PARAM_ALLOW_PACKED_LOAD_DATA_RACES)
 224 #define ALLOW_PACKED_STORE_DATA_RACES \
 225   PARAM_VALUE (PARAM_ALLOW_PACKED_STORE_DATA_RACES)
 226 #define ASAN_STACK \
 227   PARAM_VALUE (PARAM_ASAN_STACK)
 228 #define ASAN_GLOBALS \
 229   PARAM_VALUE (PARAM_ASAN_GLOBALS)
 230 #define ASAN_INSTRUMENT_READS \
 231   PARAM_VALUE (PARAM_ASAN_INSTRUMENT_READS)
 232 #define ASAN_INSTRUMENT_WRITES \
 233   PARAM_VALUE (PARAM_ASAN_INSTRUMENT_WRITES)
 234 #define ASAN_MEMINTRIN \
 235   PARAM_VALUE (PARAM_ASAN_MEMINTRIN)
 236 #define ASAN_USE_AFTER_RETURN \
 237   PARAM_VALUE (PARAM_ASAN_USE_AFTER_RETURN)
 238 #define ASAN_INSTRUMENTATION_WITH_CALL_THRESHOLD \
 239   PARAM_VALUE (PARAM_ASAN_INSTRUMENTATION_WITH_CALL_THRESHOLD)
 240
 241 #endif /* ! GCC_PARAMS_H */