contrib/llvm/tools/clang/include/clang/Frontend/CodeGenOptions.def

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