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