Clang Project

clang_source_code/include/clang/Basic/CodeGenOptions.def
1//===--- CodeGenOptions.def - Code generation option database ----- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the code generation options. Users of this file
10// must define the CODEGENOPT macro to make use of this information.
11// Optionally, the user may also define ENUM_CODEGENOPT (for options
12// that have enumeration type and VALUE_CODEGENOPT is a code
13// generation option that describes a value rather than a flag.
14//
15//===----------------------------------------------------------------------===//
16#ifndef CODEGENOPT
17#  error Define the CODEGENOPT macro to handle language options
18#endif
19
20#ifndef VALUE_CODEGENOPT
21#  define VALUE_CODEGENOPT(Name, Bits, Default) \
22CODEGENOPT(Name, Bits, Default)
23#endif
24
25#ifndef ENUM_CODEGENOPT
26#  define ENUM_CODEGENOPT(Name, Type, Bits, Default) \
27CODEGENOPT(Name, Bits, Default)
28#endif
29
30CODEGENOPT(DisableIntegratedAS, 1, 0) ///< -no-integrated-as
31ENUM_CODEGENOPT(CompressDebugSections, llvm::DebugCompressionType, 2,
32                llvm::DebugCompressionType::None)
33CODEGENOPT(RelaxELFRelocations, 1, 0) ///< -Wa,--mrelax-relocations
34CODEGENOPT(AsmVerbose        , 1, 0) ///< -dA, -fverbose-asm.
35CODEGENOPT(PreserveAsmComments, 1, 1) ///< -dA, -fno-preserve-as-comments.
36CODEGENOPT(AssumeSaneOperatorNew , 1, 1) ///< implicit __attribute__((malloc)) operator new
37CODEGENOPT(Autolink          , 1, 1) ///< -fno-autolink
38CODEGENOPT(ObjCAutoRefCountExceptions , 1, 0) ///< Whether ARC should be EH-safe.
39CODEGENOPT(Backchain         , 1, 0) ///< -mbackchain
40CODEGENOPT(ControlFlowGuard  , 1, 0) ///< -cfguard
41CODEGENOPT(CoverageExtraChecksum, 1, 0) ///< Whether we need a second checksum for functions in GCNO files.
42CODEGENOPT(CoverageNoFunctionNamesInData, 1, 0) ///< Do not include function names in GCDA files.
43CODEGENOPT(CoverageExitBlockBeforeBody, 1, 0) ///< Whether to emit the exit block before the body blocks in GCNO files.
44CODEGENOPT(CXAAtExit         , 1, 1) ///< Use __cxa_atexit for calling destructors.
45CODEGENOPT(RegisterGlobalDtorsWithAtExit, 1, 1) ///< Use atexit or __cxa_atexit to register global destructors.
46CODEGENOPT(CXXCtorDtorAliases, 1, 0) ///< Emit complete ctors/dtors as linker
47                                     ///< aliases to base ctors when possible.
48CODEGENOPT(DataSections      , 1, 0) ///< Set when -fdata-sections is enabled.
49CODEGENOPT(UniqueSectionNames, 1, 1) ///< Set for -funique-section-names.
50CODEGENOPT(DisableFPElim     , 1, 0) ///< Set when -fomit-frame-pointer is enabled.
51CODEGENOPT(DisableFree       , 1, 0) ///< Don't free memory.
52CODEGENOPT(DiscardValueNames , 1, 0) ///< Discard Value Names from the IR (LLVMContext flag)
53CODEGENOPT(DisableGCov       , 1, 0) ///< Don't run the GCov pass, for testing.
54CODEGENOPT(DisableLLVMPasses , 1, 0) ///< Don't run any LLVM IR passes to get
55                                     ///< the pristine IR generated by the
56                                     ///< frontend.
57CODEGENOPT(DisableLifetimeMarkers, 1, 0) ///< Don't emit any lifetime markers
58CODEGENOPT(DisableO0ImplyOptNone , 1, 0) ///< Don't annonate function with optnone at O0
59CODEGENOPT(ExperimentalNewPassManager, 1, 0) ///< Enables the new, experimental
60                                             ///< pass manager.
61CODEGENOPT(DebugPassManager, 1, 0) ///< Prints debug information for the new
62                                   ///< pass manager.
63CODEGENOPT(DisableRedZone    , 1, 0) ///< Set when -mno-red-zone is enabled.
64CODEGENOPT(IndirectTlsSegRefs, 1, 0) ///< Set when -mno-tls-direct-seg-refs
65                                     ///< is specified.
66CODEGENOPT(DisableTailCalls  , 1, 0) ///< Do not emit tail calls.
67CODEGENOPT(NoEscapingBlockTailCalls, 1, 0) ///< Do not emit tail calls from
68                                           ///< escaping blocks.
69CODEGENOPT(EmitDeclMetadata  , 1, 0) ///< Emit special metadata indicating what
70                                     ///< Decl* various IR entities came from.
71                                     ///< Only useful when running CodeGen as a
72                                     ///< subroutine.
73CODEGENOPT(EmitVersionIdentMetadata , 1, 1) ///< Emit compiler version metadata.
74CODEGENOPT(EmitGcovArcs      , 1, 0) ///< Emit coverage data files, aka. GCDA.
75CODEGENOPT(EmitGcovNotes     , 1, 0) ///< Emit coverage "notes" files, aka GCNO.
76CODEGENOPT(EmitOpenCLArgMetadata , 1, 0) ///< Emit OpenCL kernel arg metadata.
77CODEGENOPT(EmulatedTLS       , 1, 0) ///< Set by default or -f[no-]emulated-tls.
78CODEGENOPT(ExplicitEmulatedTLS , 1, 0) ///< Set if -f[no-]emulated-tls is used.
79/// Embed Bitcode mode (off/all/bitcode/marker).
80ENUM_CODEGENOPT(EmbedBitcode, EmbedBitcodeKind, 2, Embed_Off)
81CODEGENOPT(ForbidGuardVariables , 1, 0) ///< Issue errors if C++ guard variables
82                                        ///< are required.
83CODEGENOPT(FunctionSections  , 1, 0) ///< Set when -ffunction-sections is enabled.
84CODEGENOPT(InstrumentFunctions , 1, 0) ///< Set when -finstrument-functions is
85                                       ///< enabled.
86CODEGENOPT(InstrumentFunctionsAfterInlining , 1, 0) ///< Set when
87                          ///< -finstrument-functions-after-inlining is enabled.
88CODEGENOPT(InstrumentFunctionEntryBare , 1, 0) ///< Set when
89                               ///< -finstrument-function-entry-bare is enabled.
90CODEGENOPT(CFProtectionReturn , 1, 0) ///< if -fcf-protection is
91                                      ///< set to full or return.
92CODEGENOPT(CFProtectionBranch , 1, 0) ///< if -fcf-protection is
93                                      ///< set to full or branch.
94CODEGENOPT(XRayInstrumentFunctions , 1, 0) ///< Set when -fxray-instrument is
95                                           ///< enabled.
96CODEGENOPT(StackSizeSection  , 1, 0) ///< Set when -fstack-size-section is enabled.
97
98///< Set when -fxray-always-emit-customevents is enabled.
99CODEGENOPT(XRayAlwaysEmitCustomEvents , 1, 0)
100
101///< Set when -fxray-always-emit-typedevents is enabled.
102CODEGENOPT(XRayAlwaysEmitTypedEvents , 1, 0)
103
104///< Set the minimum number of instructions in a function to determine selective
105///< XRay instrumentation.
106VALUE_CODEGENOPT(XRayInstructionThreshold , 32, 200)
107
108CODEGENOPT(InstrumentForProfiling , 1, 0) ///< Set when -pg is enabled.
109CODEGENOPT(CallFEntry , 1, 0) ///< Set when -mfentry is enabled.
110CODEGENOPT(LessPreciseFPMAD  , 1, 0) ///< Enable less precise MAD instructions to
111                                     ///< be generated.
112CODEGENOPT(PrepareForLTO     , 1, 0) ///< Set when -flto is enabled on the
113                                     ///< compile step.
114CODEGENOPT(PrepareForThinLTO , 1, 0) ///< Set when -flto=thin is enabled on the
115                                     ///< compile step.
116CODEGENOPT(LTOUnit, 1, 0) ///< Emit IR to support LTO unit features (CFI, whole
117                          ///< program vtable opt).
118CODEGENOPT(EnableSplitLTOUnit, 1, 0) ///< Enable LTO unit splitting to support
119      /// CFI and traditional whole program
120      /// devirtualization that require whole
121      /// program IR support.
122CODEGENOPT(IncrementalLinkerCompatible, 1, 0) ///< Emit an object file which can
123                                              ///< be used with an incremental
124                                              ///< linker.
125CODEGENOPT(MergeAllConstants , 1, 1) ///< Merge identical constants.
126CODEGENOPT(MergeFunctions    , 1, 0) ///< Set when -fmerge-functions is enabled.
127CODEGENOPT(MSVolatile        , 1, 0) ///< Set when /volatile:ms is enabled.
128CODEGENOPT(NoCommon          , 1, 0) ///< Set when -fno-common or C++ is enabled.
129CODEGENOPT(NoDwarfDirectoryAsm , 1, 0) ///< Set when -fno-dwarf-directory-asm is
130                                       ///< enabled.
131CODEGENOPT(NoExecStack       , 1, 0) ///< Set when -Wa,--noexecstack is enabled.
132CODEGENOPT(FatalWarnings     , 1, 0) ///< Set when -Wa,--fatal-warnings is
133                                     ///< enabled.
134CODEGENOPT(EnableSegmentedStacks , 1, 0) ///< Set when -fsplit-stack is enabled.
135CODEGENOPT(NoImplicitFloat   , 1, 0) ///< Set when -mno-implicit-float is enabled.
136CODEGENOPT(NoInfsFPMath      , 1, 0) ///< Assume FP arguments, results not +-Inf.
137CODEGENOPT(NoSignedZeros     , 1, 0) ///< Allow ignoring the signedness of FP zero
138CODEGENOPT(NullPointerIsValid , 1, 0) ///< Assume Null pointer deference is defined.
139CODEGENOPT(Reassociate       , 1, 0) ///< Allow reassociation of FP math ops
140CODEGENOPT(ReciprocalMath    , 1, 0) ///< Allow FP divisions to be reassociated.
141CODEGENOPT(NoTrappingMath    , 1, 0) ///< Set when -fno-trapping-math is enabled.
142CODEGENOPT(NoNaNsFPMath      , 1, 0) ///< Assume FP arguments, results not NaN.
143CODEGENOPT(FlushDenorm       , 1, 0) ///< Allow FP denorm numbers to be flushed to zero
144CODEGENOPT(CorrectlyRoundedDivSqrt, 1, 0) ///< -cl-fp32-correctly-rounded-divide-sqrt
145
146/// When false, this attempts to generate code as if the result of an
147/// overflowing conversion matches the overflowing behavior of a target's native
148/// float-to-int conversion instructions.
149CODEGENOPT(StrictFloatCastOverflow, 1, 1)
150
151CODEGENOPT(UniformWGSize     , 1, 0) ///< -cl-uniform-work-group-size
152CODEGENOPT(NoZeroInitializedInBSS , 1, 0) ///< -fno-zero-initialized-in-bss.
153/// Method of Objective-C dispatch to use.
154ENUM_CODEGENOPT(ObjCDispatchMethod, ObjCDispatchMethodKind, 2, Legacy)
155/// Replace certain message sends with calls to ObjC runtime entrypoints
156CODEGENOPT(ObjCConvertMessagesToRuntimeCalls , 1, 1)
157CODEGENOPT(OmitLeafFramePointer , 1, 0) ///< Set when -momit-leaf-frame-pointer is
158                                        ///< enabled.
159
160VALUE_CODEGENOPT(OptimizationLevel, 2, 0) ///< The -O[0-3] option specified.
161VALUE_CODEGENOPT(OptimizeSize, 2, 0) ///< If -Os (==1) or -Oz (==2) is specified.
162
163/// Choose profile instrumenation kind or no instrumentation.
164ENUM_CODEGENOPT(ProfileInstr, ProfileInstrKind, 2, ProfileNone)
165/// Choose profile kind for PGO use compilation.
166ENUM_CODEGENOPT(ProfileUse, ProfileInstrKind, 2, ProfileNone)
167CODEGENOPT(CoverageMapping , 1, 0) ///< Generate coverage mapping regions to
168                                   ///< enable code coverage analysis.
169CODEGENOPT(DumpCoverageMapping , 1, 0) ///< Dump the generated coverage mapping
170                                       ///< regions.
171
172  /// If -fpcc-struct-return or -freg-struct-return is specified.
173ENUM_CODEGENOPT(StructReturnConvention, StructReturnConventionKind, 2, SRCK_Default)
174
175CODEGENOPT(RelaxAll          , 1, 0) ///< Relax all machine code instructions.
176CODEGENOPT(RelaxedAliasing   , 1, 0) ///< Set when -fno-strict-aliasing is enabled.
177CODEGENOPT(StructPathTBAA    , 1, 0) ///< Whether or not to use struct-path TBAA.
178CODEGENOPT(NewStructPathTBAA , 1, 0) ///< Whether or not to use enhanced struct-path TBAA.
179CODEGENOPT(SaveTempLabels    , 1, 0) ///< Save temporary labels.
180CODEGENOPT(SanitizeAddressUseAfterScope , 1, 0) ///< Enable use-after-scope detection
181                                                ///< in AddressSanitizer
182CODEGENOPT(SanitizeAddressPoisonCustomArrayCookie, 1,
183           0) ///< Enable poisoning operator new[] which is not a replaceable
184              ///< global allocation function in AddressSanitizer
185CODEGENOPT(SanitizeAddressGlobalsDeadStripping, 1, 0) ///< Enable linker dead stripping
186                                                      ///< of globals in AddressSanitizer
187CODEGENOPT(SanitizeAddressUseOdrIndicator, 1, 0) ///< Enable ODR indicator globals
188CODEGENOPT(SanitizeMemoryTrackOrigins, 2, 0) ///< Enable tracking origins in
189                                             ///< MemorySanitizer
190CODEGENOPT(SanitizeMemoryUseAfterDtor, 1, 0) ///< Enable use-after-delete detection
191                                             ///< in MemorySanitizer
192CODEGENOPT(SanitizeCfiCrossDso, 1, 0) ///< Enable cross-dso support in CFI.
193CODEGENOPT(SanitizeMinimalRuntime, 1, 0) ///< Use "_minimal" sanitizer runtime for
194                                         ///< diagnostics.
195CODEGENOPT(SanitizeCfiICallGeneralizePointers, 1, 0) ///< Generalize pointer types in
196                                                     ///< CFI icall function signatures
197CODEGENOPT(SanitizeCoverageType, 2, 0) ///< Type of sanitizer coverage
198                                       ///< instrumentation.
199CODEGENOPT(SanitizeCoverageIndirectCalls, 1, 0) ///< Enable sanitizer coverage
200                                                ///< for indirect calls.
201CODEGENOPT(SanitizeCoverageTraceBB, 1, 0) ///< Enable basic block tracing in
202                                          ///< in sanitizer coverage.
203CODEGENOPT(SanitizeCoverageTraceCmp, 1, 0) ///< Enable cmp instruction tracing
204                                           ///< in sanitizer coverage.
205CODEGENOPT(SanitizeCoverageTraceDiv, 1, 0) ///< Enable div instruction tracing
206                                           ///< in sanitizer coverage.
207CODEGENOPT(SanitizeCoverageTraceGep, 1, 0) ///< Enable GEP instruction tracing
208                                           ///< in sanitizer coverage.
209CODEGENOPT(SanitizeCoverage8bitCounters, 1, 0) ///< Use 8-bit frequency counters
210                                               ///< in sanitizer coverage.
211CODEGENOPT(SanitizeCoverageTracePC, 1, 0) ///< Enable PC tracing
212                                          ///< in sanitizer coverage.
213CODEGENOPT(SanitizeCoverageTracePCGuard, 1, 0) ///< Enable PC tracing with guard
214                                               ///< in sanitizer coverage.
215CODEGENOPT(SanitizeCoverageInline8bitCounters, 1, 0) ///< Use inline 8bit counters.
216CODEGENOPT(SanitizeCoveragePCTable, 1, 0) ///< Create a PC Table.
217CODEGENOPT(SanitizeCoverageNoPrune, 1, 0) ///< Disable coverage pruning.
218CODEGENOPT(SanitizeCoverageStackDepth, 1, 0) ///< Enable max stack depth tracing
219CODEGENOPT(SanitizeStats     , 1, 0) ///< Collect statistics for sanitizers.
220CODEGENOPT(SimplifyLibCalls  , 1, 1) ///< Set when -fbuiltin is enabled.
221CODEGENOPT(SoftFloat         , 1, 0) ///< -soft-float.
222CODEGENOPT(SpeculativeLoadHardening, 1, 0) ///< Enable speculative load hardening.
223CODEGENOPT(FineGrainedBitfieldAccesses, 1, 0) ///< Enable fine-grained bitfield accesses.
224CODEGENOPT(StrictEnums       , 1, 0) ///< Optimize based on strict enum definition.
225CODEGENOPT(StrictVTablePointers, 1, 0) ///< Optimize based on the strict vtable pointers
226CODEGENOPT(TimePasses        , 1, 0) ///< Set when -ftime-report is enabled.
227CODEGENOPT(UnrollLoops       , 1, 0) ///< Control whether loops are unrolled.
228CODEGENOPT(RerollLoops       , 1, 0) ///< Control whether loops are rerolled.
229CODEGENOPT(NoUseJumpTables   , 1, 0) ///< Set when -fno-jump-tables is enabled.
230CODEGENOPT(UnsafeFPMath      , 1, 0) ///< Allow unsafe floating point optzns.
231CODEGENOPT(UnwindTables      , 1, 0) ///< Emit unwind tables.
232CODEGENOPT(VectorizeLoop     , 1, 0) ///< Run loop vectorizer.
233CODEGENOPT(VectorizeSLP      , 1, 0) ///< Run SLP vectorizer.
234CODEGENOPT(ProfileSampleAccurate, 1, 0) ///< Sample profile is accurate.
235
236  /// Attempt to use register sized accesses to bit-fields in structures, when
237  /// possible.
238CODEGENOPT(UseRegisterSizedBitfieldAccess , 1, 0)
239
240CODEGENOPT(VerifyModule      , 1, 1) ///< Control whether the module should be run
241                                     ///< through the LLVM Verifier.
242
243CODEGENOPT(StackRealignment  , 1, 0) ///< Control whether to force stack
244                                     ///< realignment.
245CODEGENOPT(UseInitArray      , 1, 0) ///< Control whether to use .init_array or
246                                     ///< .ctors.
247VALUE_CODEGENOPT(StackAlignment    , 32, 0) ///< Overrides default stack
248                                            ///< alignment, if not 0.
249VALUE_CODEGENOPT(StackProbeSize    , 32, 4096) ///< Overrides default stack
250                                               ///< probe size, even if 0.
251CODEGENOPT(NoStackArgProbe, 1, 0) ///< Set when -mno-stack-arg-probe is used
252CODEGENOPT(DebugColumnInfo, 1, 0) ///< Whether or not to use column information
253                                  ///< in debug info.
254
255CODEGENOPT(DebugTypeExtRefs, 1, 0) ///< Whether or not debug info should contain
256                                   ///< external references to a PCH or module.
257
258CODEGENOPT(DebugExplicitImport, 1, 0)  ///< Whether or not debug info should
259                                       ///< contain explicit imports for
260                                       ///< anonymous namespaces
261
262ENUM_CODEGENOPT(SplitDwarfMode, DwarfFissionKind, 2, NoFission) ///< DWARF fission mode to use.
263
264CODEGENOPT(SplitDwarfInlining, 1, 1) ///< Whether to include inlining info in the
265                                     ///< skeleton CU to allow for symbolication
266                                     ///< of inline stack frames without .dwo files.
267CODEGENOPT(DebugFwdTemplateParams, 1, 0) ///< Whether to emit complete
268                                         ///< template parameter descriptions in
269                                         ///< forward declarations (versus just
270                                         ///< including them in the name).
271
272CODEGENOPT(EmitLLVMUseLists, 1, 0) ///< Control whether to serialize use-lists.
273
274CODEGENOPT(WholeProgramVTables, 1, 0) ///< Whether to apply whole-program
275                                      ///  vtable optimization.
276
277/// Whether to use public LTO visibility for entities in std and stdext
278/// namespaces. This is enabled by clang-cl's /MT and /MTd flags.
279CODEGENOPT(LTOVisibilityPublicStd, 1, 0)
280
281/// The user specified number of registers to be used for integral arguments,
282/// or 0 if unspecified.
283VALUE_CODEGENOPT(NumRegisterParameters, 32, 0)
284
285/// The lower bound for a buffer to be considered for stack protection.
286VALUE_CODEGENOPT(SSPBufferSize, 32, 0)
287
288/// The kind of generated debug info.
289ENUM_CODEGENOPT(DebugInfo, codegenoptions::DebugInfoKind, 3, codegenoptions::NoDebugInfo)
290
291/// Whether to generate macro debug info.
292CODEGENOPT(MacroDebugInfo, 1, 0)
293
294/// Tune the debug info for this debugger.
295ENUM_CODEGENOPT(DebuggerTuning, llvm::DebuggerKind, 2,
296                llvm::DebuggerKind::Default)
297
298/// Dwarf version. Version zero indicates to LLVM that no DWARF should be
299/// emitted.
300VALUE_CODEGENOPT(DwarfVersion, 3, 0)
301
302/// Whether we should emit CodeView debug information. It's possible to emit
303/// CodeView and DWARF into the same object.
304CODEGENOPT(EmitCodeView, 1, 0)
305
306/// Whether to emit the .debug$H section containing hashes of CodeView types.
307CODEGENOPT(CodeViewGHash, 1, 0)
308
309/// The kind of inlining to perform.
310ENUM_CODEGENOPT(Inlining, InliningMethod, 2, NormalInlining)
311
312// Vector functions library to use.
313ENUM_CODEGENOPT(VecLib, VectorLibrary, 2, NoLibrary)
314
315/// The default TLS model to use.
316ENUM_CODEGENOPT(DefaultTLSModel, TLSModel, 2, GeneralDynamicTLSModel)
317
318/// Number of path components to strip when emitting checks. (0 == full
319/// filename)
320VALUE_CODEGENOPT(EmitCheckPathComponentsToStrip, 32, 0)
321
322/// Whether to report the hotness of the code region for optimization remarks.
323CODEGENOPT(DiagnosticsWithHotness, 1, 0)
324
325/// The minimum hotness value a diagnostic needs in order to be included in
326/// optimization diagnostics.
327VALUE_CODEGENOPT(DiagnosticsHotnessThreshold, 32, 0)
328
329/// Whether copy relocations support is available when building as PIE.
330CODEGENOPT(PIECopyRelocations, 1, 0)
331
332/// Whether we should use the undefined behaviour optimization for control flow
333/// paths that reach the end of a function without executing a required return.
334CODEGENOPT(StrictReturn, 1, 1)
335
336/// Whether emit extra debug info for sample pgo profile collection.
337CODEGENOPT(DebugInfoForProfiling, 1, 0)
338
339/// Whether 3-component vector type is preserved.
340CODEGENOPT(PreserveVec3Type, 1, 0)
341
342/// Whether to emit .debug_gnu_pubnames section instead of .debug_pubnames.
343CODEGENOPT(DebugNameTable, 2, 0)
344
345/// Whether to use DWARF base address specifiers in .debug_ranges.
346CODEGENOPT(DebugRangesBaseAddress, 1, 0)
347
348CODEGENOPT(NoPLT, 1, 0)
349
350/// Whether to embed source in DWARF debug line section.
351CODEGENOPT(EmbedSource, 1, 0)
352
353/// Whether to emit all vtables
354CODEGENOPT(ForceEmitVTables, 1, 0)
355
356/// Whether to emit an address-significance table into the object file.
357CODEGENOPT(Addrsig, 1, 0)
358
359ENUM_CODEGENOPT(SignReturnAddress, SignReturnAddressScope, 2, None)
360ENUM_CODEGENOPT(SignReturnAddressKey, SignReturnAddressKeyValue, 1, AKey)
361CODEGENOPT(BranchTargetEnforcement, 1, 0)
362
363/// Whether to emit unused static constants.
364CODEGENOPT(KeepStaticConsts, 1, 0)
365
366#undef CODEGENOPT
367#undef ENUM_CODEGENOPT
368#undef VALUE_CODEGENOPT
369
370
CodeThinker, Enjoy your reading code