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