1/* Compilation switch flag type definitions for GCC.
2 Copyright (C) 1987-2023 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along 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
25enum debug_info_type
26{
27 DINFO_TYPE_NONE, /* No debug info. */
28 DINFO_TYPE_DWARF2, /* Dwarf v2 debug info. */
29 DINFO_TYPE_VMS, /* VMS debug info. */
30 DINFO_TYPE_CTF, /* CTF debug info. */
31 DINFO_TYPE_BTF, /* BTF debug info. */
32 DINFO_TYPE_BTF_WITH_CORE, /* BTF debug info with CO-RE relocations. */
33 DINFO_TYPE_MAX = DINFO_TYPE_BTF_WITH_CORE /* Marker only. */
34};
35
36#define NO_DEBUG (0U)
37/* Write DWARF2 debug info (using dwarf2out.cc). */
38#define DWARF2_DEBUG (1U << DINFO_TYPE_DWARF2)
39/* Write VMS debug info (using vmsdbgout.cc). */
40#define VMS_DEBUG (1U << DINFO_TYPE_VMS)
41/* Write CTF debug info (using ctfout.cc). */
42#define CTF_DEBUG (1U << DINFO_TYPE_CTF)
43/* Write BTF debug info (using btfout.cc). */
44#define BTF_DEBUG (1U << DINFO_TYPE_BTF)
45/* Write BTF debug info for BPF CO-RE usecase (using btfout.cc). */
46#define BTF_WITH_CORE_DEBUG (1U << DINFO_TYPE_BTF_WITH_CORE)
47
48/* Note: Adding new definitions to handle -combination- of debug formats,
49 like VMS_AND_DWARF2_DEBUG is not recommended. This definition remains
50 here for historical reasons. */
51/* Write VMS debug info (using vmsdbgout.cc) and DWARF v2 debug info (using
52 dwarf2out.cc). */
53#define VMS_AND_DWARF2_DEBUG ((VMS_DEBUG | DWARF2_DEBUG))
54
55enum debug_info_levels
56{
57 DINFO_LEVEL_NONE, /* Write no debugging info. */
58 DINFO_LEVEL_TERSE, /* Write minimal info to support tracebacks only. */
59 DINFO_LEVEL_NORMAL, /* Write info for all declarations (and line table). */
60 DINFO_LEVEL_VERBOSE /* Write normal info plus #define/#undef info. */
61};
62
63/* CTF debug info levels.
64 CTF debug info levels are untied with DWARF debug info levels because CTF
65 may co-exist with DWARF. */
66enum ctf_debug_info_levels
67{
68 CTFINFO_LEVEL_NONE = 0, /* Write no CTF debug info. */
69 CTFINFO_LEVEL_TERSE = 1, /* Write CTF information to support tracebacks
70 only. Not Implemented. */
71 CTFINFO_LEVEL_NORMAL = 2 /* Write CTF type information for all entities
72 (functions, data objects, variables etc.)
73 at file-scope or global-scope only. */
74};
75
76/* A major contribution to object and executable size is debug
77 information size. A major contribution to debug information
78 size is struct descriptions replicated in several object files.
79 The following function determines whether or not debug information
80 should be generated for a given struct. The indirect parameter
81 indicates that the struct is being handled indirectly, via
82 a pointer. See opts.cc for the implementation. */
83
84enum debug_info_usage
85{
86 DINFO_USAGE_DFN, /* A struct definition. */
87 DINFO_USAGE_DIR_USE, /* A direct use, such as the type of a variable. */
88 DINFO_USAGE_IND_USE, /* An indirect use, such as through a pointer. */
89 DINFO_USAGE_NUM_ENUMS /* The number of enumerators. */
90};
91
92/* A major contribution to object and executable size is debug
93 information size. A major contribution to debug information size
94 is struct descriptions replicated in several object files. The
95 following flags attempt to reduce this information. The basic
96 idea is to not emit struct debugging information in the current
97 compilation unit when that information will be generated by
98 another compilation unit.
99
100 Debug information for a struct defined in the current source
101 file should be generated in the object file. Likewise the
102 debug information for a struct defined in a header should be
103 generated in the object file of the corresponding source file.
104 Both of these case are handled when the base name of the file of
105 the struct definition matches the base name of the source file
106 of the current compilation unit. This matching emits minimal
107 struct debugging information.
108
109 The base file name matching rule above will fail to emit debug
110 information for structs defined in system headers. So a second
111 category of files includes system headers in addition to files
112 with matching bases.
113
114 The remaining types of files are library headers and application
115 headers. We cannot currently distinguish these two types. */
116
117enum debug_struct_file
118{
119 DINFO_STRUCT_FILE_NONE, /* Debug no structs. */
120 DINFO_STRUCT_FILE_BASE, /* Debug structs defined in files with the
121 same base name as the compilation unit. */
122 DINFO_STRUCT_FILE_SYS, /* Also debug structs defined in system
123 header files. */
124 DINFO_STRUCT_FILE_ANY /* Debug structs defined in all files. */
125};
126
127/* Balance between GNAT encodings and standard DWARF to emit. */
128
129enum dwarf_gnat_encodings
130{
131 DWARF_GNAT_ENCODINGS_ALL = 0, /* Emit all GNAT encodings, then emit as
132 much standard DWARF as possible so it
133 does not conflict with GNAT
134 encodings. */
135 DWARF_GNAT_ENCODINGS_GDB = 1, /* Emit as much standard DWARF as possible
136 as long as GDB handles them. Emit GNAT
137 encodings for the rest. */
138 DWARF_GNAT_ENCODINGS_MINIMAL = 2 /* Emit all the standard DWARF we can.
139 Emit GNAT encodings for the rest. */
140};
141
142/* Enumerate Objective-c instance variable visibility settings. */
143
144enum ivar_visibility
145{
146 IVAR_VISIBILITY_PRIVATE,
147 IVAR_VISIBILITY_PROTECTED,
148 IVAR_VISIBILITY_PUBLIC,
149 IVAR_VISIBILITY_PACKAGE
150};
151
152/* The stack reuse level. */
153enum stack_reuse_level
154{
155 SR_NONE,
156 SR_NAMED_VARS,
157 SR_ALL
158};
159
160/* Control Flow Redundancy hardening options for noreturn calls. */
161enum hardcfr_noret
162{
163 HCFRNR_NEVER,
164 HCFRNR_NOTHROW,
165 HCFRNR_NO_XTHROW,
166 HCFRNR_UNSPECIFIED,
167 HCFRNR_ALWAYS,
168};
169
170/* The live patching level. */
171enum live_patching_level
172{
173 LIVE_PATCHING_NONE = 0,
174 LIVE_PATCHING_INLINE_ONLY_STATIC,
175 LIVE_PATCHING_INLINE_CLONE
176};
177
178/* The algorithm used for basic block reordering. */
179enum reorder_blocks_algorithm
180{
181 REORDER_BLOCKS_ALGORITHM_SIMPLE,
182 REORDER_BLOCKS_ALGORITHM_STC
183};
184
185/* The algorithm used for the integrated register allocator (IRA). */
186enum ira_algorithm
187{
188 IRA_ALGORITHM_CB,
189 IRA_ALGORITHM_PRIORITY
190};
191
192/* The regions used for the integrated register allocator (IRA). */
193enum ira_region
194{
195 IRA_REGION_ONE,
196 IRA_REGION_ALL,
197 IRA_REGION_MIXED,
198};
199
200/* The options for excess precision. */
201enum 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. */
210enum 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. */
225enum 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. */
245enum 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. */
261enum 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. */
268enum 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. */
276enum 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. */
285enum auto_init_type {
286 AUTO_INIT_UNINITIALIZED = 0,
287 AUTO_INIT_PATTERN = 1,
288 AUTO_INIT_ZERO = 2
289};
290
291/* Different instrumentation modes. */
292enum 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 /* Shadow Call Stack. */
329 SANITIZE_SHADOW_CALL_STACK = 1UL << 31,
330 SANITIZE_SHIFT = SANITIZE_SHIFT_BASE | SANITIZE_SHIFT_EXPONENT,
331 SANITIZE_UNDEFINED = SANITIZE_SHIFT | SANITIZE_DIVIDE | SANITIZE_UNREACHABLE
332 | SANITIZE_VLA | SANITIZE_NULL | SANITIZE_RETURN
333 | SANITIZE_SI_OVERFLOW | SANITIZE_BOOL | SANITIZE_ENUM
334 | SANITIZE_BOUNDS | SANITIZE_ALIGNMENT
335 | SANITIZE_NONNULL_ATTRIBUTE
336 | SANITIZE_RETURNS_NONNULL_ATTRIBUTE
337 | SANITIZE_OBJECT_SIZE | SANITIZE_VPTR
338 | SANITIZE_POINTER_OVERFLOW | SANITIZE_BUILTIN,
339 SANITIZE_UNDEFINED_NONDEFAULT = SANITIZE_FLOAT_DIVIDE | SANITIZE_FLOAT_CAST
340 | SANITIZE_BOUNDS_STRICT
341};
342
343/* Different settings for zeroing subset of registers. */
344namespace zero_regs_flags {
345 const unsigned int UNSET = 0;
346 const unsigned int SKIP = 1UL << 0;
347 const unsigned int ONLY_USED = 1UL << 1;
348 const unsigned int ONLY_GPR = 1UL << 2;
349 const unsigned int ONLY_ARG = 1UL << 3;
350 const unsigned int ENABLED = 1UL << 4;
351 const unsigned int LEAFY_MODE = 1UL << 5;
352 const unsigned int USED_GPR_ARG = ENABLED | ONLY_USED | ONLY_GPR | ONLY_ARG;
353 const unsigned int USED_GPR = ENABLED | ONLY_USED | ONLY_GPR;
354 const unsigned int USED_ARG = ENABLED | ONLY_USED | ONLY_ARG;
355 const unsigned int USED = ENABLED | ONLY_USED;
356 const unsigned int ALL_GPR_ARG = ENABLED | ONLY_GPR | ONLY_ARG;
357 const unsigned int ALL_GPR = ENABLED | ONLY_GPR;
358 const unsigned int ALL_ARG = ENABLED | ONLY_ARG;
359 const unsigned int ALL = ENABLED;
360 const unsigned int LEAFY_GPR_ARG = ENABLED | LEAFY_MODE | ONLY_GPR | ONLY_ARG;
361 const unsigned int LEAFY_GPR = ENABLED | LEAFY_MODE | ONLY_GPR;
362 const unsigned int LEAFY_ARG = ENABLED | LEAFY_MODE | ONLY_ARG;
363 const unsigned int LEAFY = ENABLED | LEAFY_MODE;
364}
365
366/* Settings of flag_incremental_link. */
367enum incremental_link {
368 INCREMENTAL_LINK_NONE,
369 /* Do incremental linking and produce binary. */
370 INCREMENTAL_LINK_NOLTO,
371 /* Do incremental linking and produce IL. */
372 INCREMENTAL_LINK_LTO
373};
374
375/* Different trace modes. */
376enum sanitize_coverage_code {
377 /* Trace PC. */
378 SANITIZE_COV_TRACE_PC = 1 << 0,
379 /* Trace Comparison. */
380 SANITIZE_COV_TRACE_CMP = 1 << 1
381};
382
383/* flag_vtable_verify initialization levels. */
384enum vtv_priority {
385 VTV_NO_PRIORITY = 0, /* i.E. Do NOT do vtable verification. */
386 VTV_STANDARD_PRIORITY = 1,
387 VTV_PREINIT_PRIORITY = 2
388};
389
390/* flag_lto_partition initialization values. */
391enum lto_partition_model {
392 LTO_PARTITION_NONE = 0,
393 LTO_PARTITION_ONE = 1,
394 LTO_PARTITION_BALANCED = 2,
395 LTO_PARTITION_1TO1 = 3,
396 LTO_PARTITION_MAX = 4
397};
398
399/* flag_lto_linker_output initialization values. */
400enum lto_linker_output {
401 LTO_LINKER_OUTPUT_UNKNOWN,
402 LTO_LINKER_OUTPUT_REL,
403 LTO_LINKER_OUTPUT_NOLTOREL,
404 LTO_LINKER_OUTPUT_DYN,
405 LTO_LINKER_OUTPUT_PIE,
406 LTO_LINKER_OUTPUT_EXEC
407};
408
409/* gfortran -finit-real= values. */
410
411enum gfc_init_local_real
412{
413 GFC_INIT_REAL_OFF = 0,
414 GFC_INIT_REAL_ZERO,
415 GFC_INIT_REAL_NAN,
416 GFC_INIT_REAL_SNAN,
417 GFC_INIT_REAL_INF,
418 GFC_INIT_REAL_NEG_INF
419};
420
421/* gfortran -fcoarray= values. */
422
423enum gfc_fcoarray
424{
425 GFC_FCOARRAY_NONE = 0,
426 GFC_FCOARRAY_SINGLE,
427 GFC_FCOARRAY_LIB
428};
429
430
431/* gfortran -fconvert= values; used for unformatted I/O.
432 Keep in sync with GFC_CONVERT_* in gcc/fortran/libgfortran.h. */
433enum gfc_convert
434{
435 GFC_FLAG_CONVERT_NATIVE = 0,
436 GFC_FLAG_CONVERT_SWAP,
437 GFC_FLAG_CONVERT_BIG,
438 GFC_FLAG_CONVERT_LITTLE,
439 GFC_FLAG_CONVERT_R16_IEEE = 4,
440 GFC_FLAG_CONVERT_R16_IEEE_SWAP,
441 GFC_FLAG_CONVERT_R16_IEEE_BIG,
442 GFC_FLAG_CONVERT_R16_IEEE_LITTLE,
443 GFC_FLAG_CONVERT_R16_IBM = 8,
444 GFC_FLAG_CONVERT_R16_IBM_SWAP,
445 GFC_FLAG_CONVERT_R16_IBM_BIG,
446 GFC_FLAG_CONVERT_R16_IBM_LITTLE,
447};
448
449
450/* Control-Flow Protection values. */
451enum cf_protection_level
452{
453 CF_NONE = 0,
454 CF_BRANCH = 1 << 0,
455 CF_RETURN = 1 << 1,
456 CF_FULL = CF_BRANCH | CF_RETURN,
457 CF_SET = 1 << 2,
458 CF_CHECK = 1 << 3
459};
460
461/* Parloops schedule type. */
462enum parloops_schedule_type
463{
464 PARLOOPS_SCHEDULE_STATIC = 0,
465 PARLOOPS_SCHEDULE_DYNAMIC,
466 PARLOOPS_SCHEDULE_GUIDED,
467 PARLOOPS_SCHEDULE_AUTO,
468 PARLOOPS_SCHEDULE_RUNTIME
469};
470
471/* Ranger debug mode. */
472enum ranger_debug
473{
474 RANGER_DEBUG_NONE = 0,
475 RANGER_DEBUG_TRACE = 1,
476 RANGER_DEBUG_CACHE = 2,
477 RANGER_DEBUG_GORI = 4,
478 RANGER_DEBUG_TRACE_GORI = (RANGER_DEBUG_TRACE | RANGER_DEBUG_GORI),
479 RANGER_DEBUG_TRACE_CACHE = (RANGER_DEBUG_TRACE | RANGER_DEBUG_CACHE),
480 RANGER_DEBUG_ALL = (RANGER_DEBUG_GORI | RANGER_DEBUG_CACHE
481 | RANGER_DEBUG_TRACE)
482};
483
484/* Jump threader verbose dumps. */
485enum threader_debug
486{
487 THREADER_DEBUG_NONE = 0,
488 THREADER_DEBUG_ALL = 1
489};
490
491/* Modes of OpenACC 'kernels' constructs handling. */
492enum openacc_kernels
493{
494 OPENACC_KERNELS_DECOMPOSE,
495 OPENACC_KERNELS_PARLOOPS
496};
497
498/* Modes of OpenACC privatization diagnostics. */
499enum openacc_privatization
500{
501 OPENACC_PRIVATIZATION_QUIET,
502 OPENACC_PRIVATIZATION_NOISY
503};
504
505/* Targets for -fopenmp-target-simd-clone. */
506enum omp_target_simd_clone_device_kind
507{
508 OMP_TARGET_SIMD_CLONE_NONE = 0,
509 OMP_TARGET_SIMD_CLONE_HOST = 1,
510 OMP_TARGET_SIMD_CLONE_NOHOST = 2,
511 OMP_TARGET_SIMD_CLONE_ANY = 3
512};
513
514#endif
515
516#endif /* ! GCC_FLAG_TYPES_H */
517

source code of gcc/flag-types.h