gcc/flag-types.h

   1 /* Compilation switch flag type definitions for GCC.
   2    Copyright (C) 1987-2021 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_FLAG_TYPES_H
  21 #define GCC_FLAG_TYPES_H
  22
  23 #if !defined(IN_LIBGCC2) && !defined(IN_TARGET_LIBS) && !defined(IN_RTS)
  24
  25 enum debug_info_type
  26 {
  27   DINFO_TYPE_NONE = 0,            /* No debug info.  */
  28   DINFO_TYPE_DBX = 1,             /* BSD .stabs for DBX.  */
  29   DINFO_TYPE_DWARF2 = 2,          /* Dwarf v2 debug info.  */
  30   DINFO_TYPE_XCOFF = 3,           /* IBM/Xcoff debug info.  */
  31   DINFO_TYPE_VMS = 4,             /* VMS debug info.  */
  32   DINFO_TYPE_CTF = 5,             /* CTF debug info.  */
  33   DINFO_TYPE_BTF = 6,             /* BTF debug info.  */
  34   DINFO_TYPE_BTF_WITH_CORE = 7,   /* BTF debug info with CO-RE relocations.  */
  35   DINFO_TYPE_MAX = DINFO_TYPE_BTF_WITH_CORE /* Marker only.  */
  36 };
  37
  38 #define NO_DEBUG      (0U)
  39 /* Write DBX debug info (using dbxout.c).  */
  40 #define DBX_DEBUG     (1U << DINFO_TYPE_DBX)
  41 /* Write DWARF2 debug info (using dwarf2out.c).  */
  42 #define DWARF2_DEBUG  (1U << DINFO_TYPE_DWARF2)
  43 /* Write IBM/XCOFF debug info (using dbxout.c).  */
  44 #define XCOFF_DEBUG   (1U << DINFO_TYPE_XCOFF)
  45 /* Write VMS debug info (using vmsdbgout.c).  */
  46 #define VMS_DEBUG     (1U << DINFO_TYPE_VMS)
  47 /* Write CTF debug info (using ctfout.c).  */
  48 #define CTF_DEBUG     (1U << DINFO_TYPE_CTF)
  49 /* Write BTF debug info (using btfout.c).  */
  50 #define BTF_DEBUG     (1U << DINFO_TYPE_BTF)
  51 /* Write BTF debug info for BPF CO-RE usecase (using btfout.c).  */
  52 #define BTF_WITH_CORE_DEBUG     (1U << DINFO_TYPE_BTF_WITH_CORE)
  53
  54 /* Note: Adding new definitions to handle -combination- of debug formats,
  55    like VMS_AND_DWARF2_DEBUG is not recommended.  This definition remains
  56    here for historical reasons.  */
  57 /* Write VMS debug info (using vmsdbgout.c) and DWARF v2 debug info (using
  58    dwarf2out.c).  */
  59 #define VMS_AND_DWARF2_DEBUG  ((VMS_DEBUG | DWARF2_DEBUG))
  60
  61 enum debug_info_levels
  62 {
  63   DINFO_LEVEL_NONE,     /* Write no debugging info.  */
  64   DINFO_LEVEL_TERSE,    /* Write minimal info to support tracebacks only.  */
  65   DINFO_LEVEL_NORMAL,   /* Write info for all declarations (and line table).  */
  66   DINFO_LEVEL_VERBOSE   /* Write normal info plus #define/#undef info.  */
  67 };
  68
  69 /* CTF debug info levels.
  70    CTF debug info levels are untied with DWARF debug info levels because CTF
  71    may co-exist with DWARF.  */
  72 enum ctf_debug_info_levels
  73 {
  74   CTFINFO_LEVEL_NONE = 0,     /* Write no CTF debug info.  */
  75   CTFINFO_LEVEL_TERSE = 1,    /* Write CTF information to support tracebacks
  76                                  only.  Not Implemented.  */
  77   CTFINFO_LEVEL_NORMAL = 2    /* Write CTF type information for all entities
  78                                  (functions, data objects, variables etc.)
  79                                  at file-scope or global-scope only.  */
  80 };
  81
  82 /* A major contribution to object and executable size is debug
  83    information size.  A major contribution to debug information
  84    size is struct descriptions replicated in several object files.
  85    The following function determines whether or not debug information
  86    should be generated for a given struct.  The indirect parameter
  87    indicates that the struct is being handled indirectly, via
  88    a pointer.  See opts.c for the implementation. */
  89
  90 enum debug_info_usage
  91 {
  92   DINFO_USAGE_DFN,      /* A struct definition. */
  93   DINFO_USAGE_DIR_USE,  /* A direct use, such as the type of a variable. */
  94   DINFO_USAGE_IND_USE,  /* An indirect use, such as through a pointer. */
  95   DINFO_USAGE_NUM_ENUMS /* The number of enumerators. */
  96 };
  97
  98 /* A major contribution to object and executable size is debug
  99    information size.  A major contribution to debug information size
 100    is struct descriptions replicated in several object files. The
 101    following flags attempt to reduce this information.  The basic
 102    idea is to not emit struct debugging information in the current
 103    compilation unit when that information will be generated by
 104    another compilation unit.
 105
 106    Debug information for a struct defined in the current source
 107    file should be generated in the object file.  Likewise the
 108    debug information for a struct defined in a header should be
 109    generated in the object file of the corresponding source file.
 110    Both of these case are handled when the base name of the file of
 111    the struct definition matches the base name of the source file
 112    of the current compilation unit.  This matching emits minimal
 113    struct debugging information.
 114
 115    The base file name matching rule above will fail to emit debug
 116    information for structs defined in system headers.  So a second
 117    category of files includes system headers in addition to files
 118    with matching bases.
 119
 120    The remaining types of files are library headers and application
 121    headers.  We cannot currently distinguish these two types.  */
 122
 123 enum debug_struct_file
 124 {
 125   DINFO_STRUCT_FILE_NONE,   /* Debug no structs. */
 126   DINFO_STRUCT_FILE_BASE,   /* Debug structs defined in files with the
 127                                same base name as the compilation unit. */
 128   DINFO_STRUCT_FILE_SYS,    /* Also debug structs defined in system
 129                                header files.  */
 130   DINFO_STRUCT_FILE_ANY     /* Debug structs defined in all files. */
 131 };
 132
 133 /* Balance between GNAT encodings and standard DWARF to emit.  */
 134
 135 enum dwarf_gnat_encodings
 136 {
 137   DWARF_GNAT_ENCODINGS_ALL = 0,     /* Emit all GNAT encodings, then emit as
 138                                        much standard DWARF as possible so it
 139                                        does not conflict with GNAT
 140                                        encodings.  */
 141   DWARF_GNAT_ENCODINGS_GDB = 1,     /* Emit as much standard DWARF as possible
 142                                        as long as GDB handles them.  Emit GNAT
 143                                        encodings for the rest.  */
 144   DWARF_GNAT_ENCODINGS_MINIMAL = 2  /* Emit all the standard DWARF we can.
 145                                        Emit GNAT encodings for the rest.  */
 146 };
 147
 148 /* Enumerate Objective-c instance variable visibility settings. */
 149
 150 enum ivar_visibility
 151 {
 152   IVAR_VISIBILITY_PRIVATE,
 153   IVAR_VISIBILITY_PROTECTED,
 154   IVAR_VISIBILITY_PUBLIC,
 155   IVAR_VISIBILITY_PACKAGE
 156 };
 157
 158 /* The stack reuse level.  */
 159 enum stack_reuse_level
 160 {
 161   SR_NONE,
 162   SR_NAMED_VARS,
 163   SR_ALL
 164 };
 165
 166 /* The live patching level.  */
 167 enum live_patching_level
 168 {
 169   LIVE_PATCHING_NONE = 0,
 170   LIVE_PATCHING_INLINE_ONLY_STATIC,
 171   LIVE_PATCHING_INLINE_CLONE
 172 };
 173
 174 /* The algorithm used for basic block reordering.  */
 175 enum reorder_blocks_algorithm
 176 {
 177   REORDER_BLOCKS_ALGORITHM_SIMPLE,
 178   REORDER_BLOCKS_ALGORITHM_STC
 179 };
 180
 181 /* The algorithm used for the integrated register allocator (IRA).  */
 182 enum ira_algorithm
 183 {
 184   IRA_ALGORITHM_CB,
 185   IRA_ALGORITHM_PRIORITY
 186 };
 187
 188 /* The regions used for the integrated register allocator (IRA).  */
 189 enum ira_region
 190 {
 191   IRA_REGION_ONE,
 192   IRA_REGION_ALL,
 193   IRA_REGION_MIXED,
 194   /* This value means that there were no options -fira-region on the
 195      command line and that we should choose a value depending on the
 196      used -O option.  */
 197   IRA_REGION_AUTODETECT
 198 };
 199
 200 /* The options for excess precision.  */
 201 enum excess_precision
 202 {
 203   EXCESS_PRECISION_DEFAULT,
 204   EXCESS_PRECISION_FAST,
 205   EXCESS_PRECISION_STANDARD,
 206   EXCESS_PRECISION_FLOAT16
 207 };
 208
 209 /* The options for which values of FLT_EVAL_METHOD are permissible.  */
 210 enum permitted_flt_eval_methods
 211 {
 212   PERMITTED_FLT_EVAL_METHODS_DEFAULT,
 213   PERMITTED_FLT_EVAL_METHODS_TS_18661,
 214   PERMITTED_FLT_EVAL_METHODS_C11
 215 };
 216
 217 /* Type of stack check.
 218
 219    Stack checking is designed to detect infinite recursion and stack
 220    overflows for Ada programs.  Furthermore stack checking tries to ensure
 221    in that scenario that enough stack space is left to run a signal handler.
 222
 223    -fstack-check= does not prevent stack-clash style attacks.  For that
 224    you want -fstack-clash-protection.  */
 225 enum stack_check_type
 226 {
 227   /* Do not check the stack.  */
 228   NO_STACK_CHECK = 0,
 229
 230   /* Check the stack generically, i.e. assume no specific support
 231      from the target configuration files.  */
 232   GENERIC_STACK_CHECK,
 233
 234   /* Check the stack and rely on the target configuration files to
 235      check the static frame of functions, i.e. use the generic
 236      mechanism only for dynamic stack allocations.  */
 237   STATIC_BUILTIN_STACK_CHECK,
 238
 239   /* Check the stack and entirely rely on the target configuration
 240      files, i.e. do not use the generic mechanism at all.  */
 241   FULL_BUILTIN_STACK_CHECK
 242 };
 243
 244 /* Type of callgraph information.  */
 245 enum callgraph_info_type
 246 {
 247   /* No information.  */
 248   NO_CALLGRAPH_INFO = 0,
 249
 250   /* Naked callgraph.  */
 251   CALLGRAPH_INFO_NAKED = 1,
 252
 253   /* Callgraph decorated with stack usage information.  */
 254   CALLGRAPH_INFO_STACK_USAGE = 2,
 255
 256   /* Callgraph decoration with dynamic allocation information.  */
 257   CALLGRAPH_INFO_DYNAMIC_ALLOC = 4
 258 };
 259
 260 /* Floating-point contraction mode.  */
 261 enum fp_contract_mode {
 262   FP_CONTRACT_OFF = 0,
 263   FP_CONTRACT_ON = 1,
 264   FP_CONTRACT_FAST = 2
 265 };
 266
 267 /* Scalar storage order kind.  */
 268 enum scalar_storage_order_kind {
 269   SSO_NATIVE = 0,
 270   SSO_BIG_ENDIAN,
 271   SSO_LITTLE_ENDIAN
 272 };
 273
 274 /* Vectorizer cost-model.  Except for DEFAULT, the values are ordered from
 275    the most conservative to the least conservative.  */
 276 enum vect_cost_model {
 277   VECT_COST_MODEL_VERY_CHEAP = -3,
 278   VECT_COST_MODEL_CHEAP = -2,
 279   VECT_COST_MODEL_DYNAMIC = -1,
 280   VECT_COST_MODEL_UNLIMITED = 0,
 281   VECT_COST_MODEL_DEFAULT = 1
 282 };
 283
 284 /* Automatic variable initialization type.  */
 285 enum auto_init_type {
 286   AUTO_INIT_UNINITIALIZED = 0,
 287   AUTO_INIT_PATTERN = 1,
 288   AUTO_INIT_ZERO = 2
 289 };
 290
 291 /* Different instrumentation modes.  */
 292 enum sanitize_code {
 293   /* AddressSanitizer.  */
 294   SANITIZE_ADDRESS = 1UL << 0,
 295   SANITIZE_USER_ADDRESS = 1UL << 1,
 296   SANITIZE_KERNEL_ADDRESS = 1UL << 2,
 297   /* ThreadSanitizer.  */
 298   SANITIZE_THREAD = 1UL << 3,
 299   /* LeakSanitizer.  */
 300   SANITIZE_LEAK = 1UL << 4,
 301   /* UndefinedBehaviorSanitizer.  */
 302   SANITIZE_SHIFT_BASE = 1UL << 5,
 303   SANITIZE_SHIFT_EXPONENT = 1UL << 6,
 304   SANITIZE_DIVIDE = 1UL << 7,
 305   SANITIZE_UNREACHABLE = 1UL << 8,
 306   SANITIZE_VLA = 1UL << 9,
 307   SANITIZE_NULL = 1UL << 10,
 308   SANITIZE_RETURN = 1UL << 11,
 309   SANITIZE_SI_OVERFLOW = 1UL << 12,
 310   SANITIZE_BOOL = 1UL << 13,
 311   SANITIZE_ENUM = 1UL << 14,
 312   SANITIZE_FLOAT_DIVIDE = 1UL << 15,
 313   SANITIZE_FLOAT_CAST = 1UL << 16,
 314   SANITIZE_BOUNDS = 1UL << 17,
 315   SANITIZE_ALIGNMENT = 1UL << 18,
 316   SANITIZE_NONNULL_ATTRIBUTE = 1UL << 19,
 317   SANITIZE_RETURNS_NONNULL_ATTRIBUTE = 1UL << 20,
 318   SANITIZE_OBJECT_SIZE = 1UL << 21,
 319   SANITIZE_VPTR = 1UL << 22,
 320   SANITIZE_BOUNDS_STRICT = 1UL << 23,
 321   SANITIZE_POINTER_OVERFLOW = 1UL << 24,
 322   SANITIZE_BUILTIN = 1UL << 25,
 323   SANITIZE_POINTER_COMPARE = 1UL << 26,
 324   SANITIZE_POINTER_SUBTRACT = 1UL << 27,
 325   SANITIZE_HWADDRESS = 1UL << 28,
 326   SANITIZE_USER_HWADDRESS = 1UL << 29,
 327   SANITIZE_KERNEL_HWADDRESS = 1UL << 30,
 328   SANITIZE_SHIFT = SANITIZE_SHIFT_BASE | SANITIZE_SHIFT_EXPONENT,
 329   SANITIZE_UNDEFINED = SANITIZE_SHIFT | SANITIZE_DIVIDE | SANITIZE_UNREACHABLE
 330                        | SANITIZE_VLA | SANITIZE_NULL | SANITIZE_RETURN
 331                        | SANITIZE_SI_OVERFLOW | SANITIZE_BOOL | SANITIZE_ENUM
 332                        | SANITIZE_BOUNDS | SANITIZE_ALIGNMENT
 333                        | SANITIZE_NONNULL_ATTRIBUTE
 334                        | SANITIZE_RETURNS_NONNULL_ATTRIBUTE
 335                        | SANITIZE_OBJECT_SIZE | SANITIZE_VPTR
 336                        | SANITIZE_POINTER_OVERFLOW | SANITIZE_BUILTIN,
 337   SANITIZE_UNDEFINED_NONDEFAULT = SANITIZE_FLOAT_DIVIDE | SANITIZE_FLOAT_CAST
 338                                   | SANITIZE_BOUNDS_STRICT
 339 };
 340
 341 /* Different settings for zeroing subset of registers.  */
 342 namespace zero_regs_flags {
 343   const unsigned int UNSET = 0;
 344   const unsigned int SKIP = 1UL << 0;
 345   const unsigned int ONLY_USED = 1UL << 1;
 346   const unsigned int ONLY_GPR = 1UL << 2;
 347   const unsigned int ONLY_ARG = 1UL << 3;
 348   const unsigned int ENABLED = 1UL << 4;
 349   const unsigned int USED_GPR_ARG = ENABLED | ONLY_USED | ONLY_GPR | ONLY_ARG;
 350   const unsigned int USED_GPR = ENABLED | ONLY_USED | ONLY_GPR;
 351   const unsigned int USED_ARG = ENABLED | ONLY_USED | ONLY_ARG;
 352   const unsigned int USED = ENABLED | ONLY_USED;
 353   const unsigned int ALL_GPR_ARG = ENABLED | ONLY_GPR | ONLY_ARG;
 354   const unsigned int ALL_GPR = ENABLED | ONLY_GPR;
 355   const unsigned int ALL_ARG = ENABLED | ONLY_ARG;
 356   const unsigned int ALL = ENABLED;
 357 }
 358
 359 /* Settings of flag_incremental_link.  */
 360 enum incremental_link {
 361   INCREMENTAL_LINK_NONE,
 362   /* Do incremental linking and produce binary.  */
 363   INCREMENTAL_LINK_NOLTO,
 364   /* Do incremental linking and produce IL.  */
 365   INCREMENTAL_LINK_LTO
 366 };
 367
 368 /* Different trace modes.  */
 369 enum sanitize_coverage_code {
 370   /* Trace PC.  */
 371   SANITIZE_COV_TRACE_PC = 1 << 0,
 372   /* Trace Comparison.  */
 373   SANITIZE_COV_TRACE_CMP = 1 << 1
 374 };
 375
 376 /* flag_vtable_verify initialization levels. */
 377 enum vtv_priority {
 378   VTV_NO_PRIORITY       = 0,  /* i.E. Do NOT do vtable verification. */
 379   VTV_STANDARD_PRIORITY = 1,
 380   VTV_PREINIT_PRIORITY  = 2
 381 };
 382
 383 /* flag_lto_partition initialization values.  */
 384 enum lto_partition_model {
 385   LTO_PARTITION_NONE = 0,
 386   LTO_PARTITION_ONE = 1,
 387   LTO_PARTITION_BALANCED = 2,
 388   LTO_PARTITION_1TO1 = 3,
 389   LTO_PARTITION_MAX = 4
 390 };
 391
 392 /* flag_lto_linker_output initialization values.  */
 393 enum lto_linker_output {
 394   LTO_LINKER_OUTPUT_UNKNOWN,
 395   LTO_LINKER_OUTPUT_REL,
 396   LTO_LINKER_OUTPUT_NOLTOREL,
 397   LTO_LINKER_OUTPUT_DYN,
 398   LTO_LINKER_OUTPUT_PIE,
 399   LTO_LINKER_OUTPUT_EXEC
 400 };
 401
 402 /* gfortran -finit-real= values.  */
 403
 404 enum gfc_init_local_real
 405 {
 406   GFC_INIT_REAL_OFF = 0,
 407   GFC_INIT_REAL_ZERO,
 408   GFC_INIT_REAL_NAN,
 409   GFC_INIT_REAL_SNAN,
 410   GFC_INIT_REAL_INF,
 411   GFC_INIT_REAL_NEG_INF
 412 };
 413
 414 /* gfortran -fcoarray= values.  */
 415
 416 enum gfc_fcoarray
 417 {
 418   GFC_FCOARRAY_NONE = 0,
 419   GFC_FCOARRAY_SINGLE,
 420   GFC_FCOARRAY_LIB
 421 };
 422
 423
 424 /* gfortran -fconvert= values; used for unformatted I/O.
 425    Keep in sync with GFC_CONVERT_* in gcc/fortran/libgfortran.h.   */
 426 enum gfc_convert
 427 {
 428   GFC_FLAG_CONVERT_NATIVE = 0,
 429   GFC_FLAG_CONVERT_SWAP,
 430   GFC_FLAG_CONVERT_BIG,
 431   GFC_FLAG_CONVERT_LITTLE
 432 };
 433
 434
 435 /* Control-Flow Protection values.  */
 436 enum cf_protection_level
 437 {
 438   CF_NONE = 0,
 439   CF_BRANCH = 1 << 0,
 440   CF_RETURN = 1 << 1,
 441   CF_FULL = CF_BRANCH | CF_RETURN,
 442   CF_SET = 1 << 2,
 443   CF_CHECK = 1 << 3
 444 };
 445
 446 /* Parloops schedule type.  */
 447 enum parloops_schedule_type
 448 {
 449   PARLOOPS_SCHEDULE_STATIC = 0,
 450   PARLOOPS_SCHEDULE_DYNAMIC,
 451   PARLOOPS_SCHEDULE_GUIDED,
 452   PARLOOPS_SCHEDULE_AUTO,
 453   PARLOOPS_SCHEDULE_RUNTIME
 454 };
 455
 456 /* EVRP mode.  */
 457 enum evrp_mode
 458 {
 459   EVRP_MODE_RVRP_ONLY = 0,
 460   EVRP_MODE_EVRP_ONLY = 1,
 461   EVRP_MODE_EVRP_FIRST = 2,
 462   EVRP_MODE_RVRP_FIRST = 3,
 463   EVRP_MODE_TRACE = 4,
 464   EVRP_MODE_CACHE = (8 | EVRP_MODE_TRACE),
 465   EVRP_MODE_GORI = 16,
 466   EVRP_MODE_TRACE_GORI = (EVRP_MODE_TRACE | EVRP_MODE_GORI),
 467   EVRP_MODE_DEBUG = (EVRP_MODE_GORI | EVRP_MODE_CACHE)
 468 };
 469
 470 /* Modes of OpenACC 'kernels' constructs handling.  */
 471 enum openacc_kernels
 472 {
 473   OPENACC_KERNELS_DECOMPOSE,
 474   OPENACC_KERNELS_PARLOOPS
 475 };
 476
 477 /* Modes of OpenACC privatization diagnostics.  */
 478 enum openacc_privatization
 479 {
 480   OPENACC_PRIVATIZATION_QUIET,
 481   OPENACC_PRIVATIZATION_NOISY
 482 };
 483
 484 #endif
 485
 486 #endif /* ! GCC_FLAG_TYPES_H */