Home | History | Annotate | Download | only in Frontend
      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(DisableRedZone    , 1, 0) ///< Set when -mno-red-zone is enabled.
     61 CODEGENOPT(DisableTailCalls  , 1, 0) ///< Do not emit tail calls.
     62 CODEGENOPT(EmitDeclMetadata  , 1, 0) ///< Emit special metadata indicating what
     63                                      ///< Decl* various IR entities came from.
     64                                      ///< Only useful when running CodeGen as a
     65                                      ///< subroutine.
     66 CODEGENOPT(EmitGcovArcs      , 1, 0) ///< Emit coverage data files, aka. GCDA.
     67 CODEGENOPT(EmitGcovNotes     , 1, 0) ///< Emit coverage "notes" files, aka GCNO.
     68 CODEGENOPT(EmitOpenCLArgMetadata , 1, 0) ///< Emit OpenCL kernel arg metadata.
     69 CODEGENOPT(EmulatedTLS       , 1, 0) ///< Set when -femulated-tls is enabled.
     70 /// \brief Embed Bitcode mode (off/all/bitcode/marker).
     71 ENUM_CODEGENOPT(EmbedBitcode, EmbedBitcodeKind, 2, Embed_Off)
     72 CODEGENOPT(ForbidGuardVariables , 1, 0) ///< Issue errors if C++ guard variables
     73                                         ///< are required.
     74 CODEGENOPT(FunctionSections  , 1, 0) ///< Set when -ffunction-sections is enabled.
     75 CODEGENOPT(InstrumentFunctions , 1, 0) ///< Set when -finstrument-functions is
     76                                        ///< enabled.
     77 
     78 CODEGENOPT(XRayInstrumentFunctions , 1, 0) ///< Set when -fxray-instrument is
     79                                            ///< enabled.
     80 
     81 ///< Set the minimum number of instructions in a function to determine selective
     82 ///< XRay instrumentation.
     83 VALUE_CODEGENOPT(XRayInstructionThreshold , 32, 200)
     84 
     85 CODEGENOPT(InstrumentForProfiling , 1, 0) ///< Set when -pg is enabled.
     86 CODEGENOPT(CallFEntry , 1, 0) ///< Set when -mfentry is enabled.
     87 CODEGENOPT(LessPreciseFPMAD  , 1, 0) ///< Enable less precise MAD instructions to
     88                                      ///< be generated.
     89 CODEGENOPT(PrepareForLTO     , 1, 0) ///< Set when -flto is enabled on the
     90                                      ///< compile step.
     91 CODEGENOPT(EmitSummaryIndex, 1, 0)   ///< Set when -flto=thin is enabled on the
     92                                      ///< compile step.
     93 CODEGENOPT(LTOUnit, 1, 0) ///< Emit IR to support LTO unit features (CFI, whole
     94                           ///< program vtable opt).
     95 CODEGENOPT(IncrementalLinkerCompatible, 1, 0) ///< Emit an object file which can
     96                                               ///< be used with an incremental
     97                                               ///< linker.
     98 CODEGENOPT(MergeAllConstants , 1, 1) ///< Merge identical constants.
     99 CODEGENOPT(MergeFunctions    , 1, 0) ///< Set when -fmerge-functions is enabled.
    100 CODEGENOPT(MSVolatile        , 1, 0) ///< Set when /volatile:ms is enabled.
    101 CODEGENOPT(NoCommon          , 1, 0) ///< Set when -fno-common or C++ is enabled.
    102 CODEGENOPT(NoDwarfDirectoryAsm , 1, 0) ///< Set when -fno-dwarf-directory-asm is
    103                                        ///< enabled.
    104 CODEGENOPT(NoExecStack       , 1, 0) ///< Set when -Wa,--noexecstack is enabled.
    105 CODEGENOPT(FatalWarnings     , 1, 0) ///< Set when -Wa,--fatal-warnings is
    106                                      ///< enabled.
    107 CODEGENOPT(EnableSegmentedStacks , 1, 0) ///< Set when -fsplit-stack is enabled.
    108 CODEGENOPT(NoImplicitFloat   , 1, 0) ///< Set when -mno-implicit-float is enabled.
    109 CODEGENOPT(NoInfsFPMath      , 1, 0) ///< Assume FP arguments, results not +-Inf.
    110 CODEGENOPT(NoSignedZeros     , 1, 0) ///< Allow ignoring the signedness of FP zero
    111 CODEGENOPT(ReciprocalMath    , 1, 0) ///< Allow FP divisions to be reassociated.
    112 CODEGENOPT(NoTrappingMath    , 1, 0) ///< Set when -fno-trapping-math is enabled.
    113 CODEGENOPT(NoNaNsFPMath      , 1, 0) ///< Assume FP arguments, results not NaN.
    114 CODEGENOPT(FlushDenorm       , 1, 0) ///< Allow FP denorm numbers to be flushed to zero
    115 CODEGENOPT(CorrectlyRoundedDivSqrt, 1, 0) ///< -cl-fp32-correctly-rounded-divide-sqrt
    116 CODEGENOPT(NoZeroInitializedInBSS , 1, 0) ///< -fno-zero-initialized-in-bss.
    117 /// \brief Method of Objective-C dispatch to use.
    118 ENUM_CODEGENOPT(ObjCDispatchMethod, ObjCDispatchMethodKind, 2, Legacy)
    119 CODEGENOPT(OmitLeafFramePointer , 1, 0) ///< Set when -momit-leaf-frame-pointer is
    120                                         ///< enabled.
    121 VALUE_CODEGENOPT(OptimizationLevel, 2, 0) ///< The -O[0-3] option specified.
    122 VALUE_CODEGENOPT(OptimizeSize, 2, 0) ///< If -Os (==1) or -Oz (==2) is specified.
    123 
    124 /// \brief Choose profile instrumenation kind or no instrumentation.
    125 ENUM_CODEGENOPT(ProfileInstr, ProfileInstrKind, 2, ProfileNone)
    126 /// \brief Choose profile kind for PGO use compilation.
    127 ENUM_CODEGENOPT(ProfileUse, ProfileInstrKind, 2, ProfileNone)
    128 CODEGENOPT(CoverageMapping , 1, 0) ///< Generate coverage mapping regions to
    129                                    ///< enable code coverage analysis.
    130 CODEGENOPT(DumpCoverageMapping , 1, 0) ///< Dump the generated coverage mapping
    131                                        ///< regions.
    132 
    133   /// If -fpcc-struct-return or -freg-struct-return is specified.
    134 ENUM_CODEGENOPT(StructReturnConvention, StructReturnConventionKind, 2, SRCK_Default)
    135 
    136 CODEGENOPT(RelaxAll          , 1, 0) ///< Relax all machine code instructions.
    137 CODEGENOPT(RelaxedAliasing   , 1, 0) ///< Set when -fno-strict-aliasing is enabled.
    138 CODEGENOPT(StructPathTBAA    , 1, 0) ///< Whether or not to use struct-path TBAA.
    139 CODEGENOPT(SaveTempLabels    , 1, 0) ///< Save temporary labels.
    140 CODEGENOPT(SanitizeAddressUseAfterScope , 1, 0) ///< Enable use-after-scope detection
    141                                                 ///< in AddressSanitizer
    142 CODEGENOPT(SanitizeAddressGlobalsDeadStripping, 1, 0) ///< Enable linker dead stripping
    143                                                       ///< of globals in AddressSanitizer
    144 CODEGENOPT(SanitizeMemoryTrackOrigins, 2, 0) ///< Enable tracking origins in
    145                                              ///< MemorySanitizer
    146 CODEGENOPT(SanitizeMemoryUseAfterDtor, 1, 0) ///< Enable use-after-delete detection
    147                                              ///< in MemorySanitizer
    148 CODEGENOPT(SanitizeCfiCrossDso, 1, 0) ///< Enable cross-dso support in CFI.
    149 CODEGENOPT(SanitizeCoverageType, 2, 0) ///< Type of sanitizer coverage
    150                                        ///< instrumentation.
    151 CODEGENOPT(SanitizeCoverageIndirectCalls, 1, 0) ///< Enable sanitizer coverage
    152                                                 ///< for indirect calls.
    153 CODEGENOPT(SanitizeCoverageTraceBB, 1, 0) ///< Enable basic block tracing in
    154                                           ///< in sanitizer coverage.
    155 CODEGENOPT(SanitizeCoverageTraceCmp, 1, 0) ///< Enable cmp instruction tracing
    156                                            ///< in sanitizer coverage.
    157 CODEGENOPT(SanitizeCoverageTraceDiv, 1, 0) ///< Enable div instruction tracing
    158                                            ///< in sanitizer coverage.
    159 CODEGENOPT(SanitizeCoverageTraceGep, 1, 0) ///< Enable GEP instruction tracing
    160                                            ///< in sanitizer coverage.
    161 CODEGENOPT(SanitizeCoverage8bitCounters, 1, 0) ///< Use 8-bit frequency counters
    162                                                ///< in sanitizer coverage.
    163 CODEGENOPT(SanitizeCoverageTracePC, 1, 0) ///< Enable PC tracing
    164                                           ///< in sanitizer coverage.
    165 CODEGENOPT(SanitizeCoverageTracePCGuard, 1, 0) ///< Enable PC tracing with guard
    166                                                ///< in sanitizer coverage.
    167 CODEGENOPT(SanitizeCoverageInline8bitCounters, 1, 0) ///< Use inline 8bit counters.
    168 CODEGENOPT(SanitizeCoverageNoPrune, 1, 0) ///< Disable coverage pruning.
    169 CODEGENOPT(SanitizeStats     , 1, 0) ///< Collect statistics for sanitizers.
    170 CODEGENOPT(SimplifyLibCalls  , 1, 1) ///< Set when -fbuiltin is enabled.
    171 CODEGENOPT(SoftFloat         , 1, 0) ///< -soft-float.
    172 CODEGENOPT(StrictEnums       , 1, 0) ///< Optimize based on strict enum definition.
    173 CODEGENOPT(StrictVTablePointers, 1, 0) ///< Optimize based on the strict vtable pointers
    174 CODEGENOPT(TimePasses        , 1, 0) ///< Set when -ftime-report is enabled.
    175 CODEGENOPT(UnrollLoops       , 1, 0) ///< Control whether loops are unrolled.
    176 CODEGENOPT(RerollLoops       , 1, 0) ///< Control whether loops are rerolled.
    177 CODEGENOPT(NoUseJumpTables   , 1, 0) ///< Set when -fno-jump-tables is enabled.
    178 CODEGENOPT(UnsafeFPMath      , 1, 0) ///< Allow unsafe floating point optzns.
    179 CODEGENOPT(UnwindTables      , 1, 0) ///< Emit unwind tables.
    180 CODEGENOPT(VectorizeBB       , 1, 0) ///< Run basic block vectorizer.
    181 CODEGENOPT(VectorizeLoop     , 1, 0) ///< Run loop vectorizer.
    182 CODEGENOPT(VectorizeSLP      , 1, 0) ///< Run SLP vectorizer.
    183 
    184   /// Attempt to use register sized accesses to bit-fields in structures, when
    185   /// possible.
    186 CODEGENOPT(UseRegisterSizedBitfieldAccess , 1, 0)
    187 
    188 CODEGENOPT(VerifyModule      , 1, 1) ///< Control whether the module should be run
    189                                      ///< through the LLVM Verifier.
    190 
    191 CODEGENOPT(StackRealignment  , 1, 0) ///< Control whether to force stack
    192                                      ///< realignment.
    193 CODEGENOPT(UseInitArray      , 1, 0) ///< Control whether to use .init_array or
    194                                      ///< .ctors.
    195 VALUE_CODEGENOPT(StackAlignment    , 32, 0) ///< Overrides default stack
    196                                             ///< alignment, if not 0.
    197 VALUE_CODEGENOPT(StackProbeSize    , 32, 4096) ///< Overrides default stack
    198                                                ///< probe size, even if 0.
    199 CODEGENOPT(DebugColumnInfo, 1, 0) ///< Whether or not to use column information
    200                                   ///< in debug info.
    201 
    202 CODEGENOPT(DebugTypeExtRefs, 1, 0) ///< Whether or not debug info should contain
    203                                    ///< external references to a PCH or module.
    204 
    205 CODEGENOPT(DebugExplicitImport, 1, 0)  ///< Whether or not debug info should
    206                                        ///< contain explicit imports for
    207                                        ///< anonymous namespaces
    208 CODEGENOPT(EnableSplitDwarf, 1, 0) ///< Whether to enable split DWARF
    209 CODEGENOPT(SplitDwarfInlining, 1, 1) ///< Whether to include inlining info in the
    210                                      ///< skeleton CU to allow for symbolication
    211 				     ///< of inline stack frames without .dwo files.
    212 
    213 CODEGENOPT(EmitLLVMUseLists, 1, 0) ///< Control whether to serialize use-lists.
    214 
    215 CODEGENOPT(WholeProgramVTables, 1, 0) ///< Whether to apply whole-program
    216                                       ///  vtable optimization.
    217 
    218 /// Whether to use public LTO visibility for entities in std and stdext
    219 /// namespaces. This is enabled by clang-cl's /MT and /MTd flags.
    220 CODEGENOPT(LTOVisibilityPublicStd, 1, 0)
    221 
    222 /// The user specified number of registers to be used for integral arguments,
    223 /// or 0 if unspecified.
    224 VALUE_CODEGENOPT(NumRegisterParameters, 32, 0)
    225 
    226 /// The lower bound for a buffer to be considered for stack protection.
    227 VALUE_CODEGENOPT(SSPBufferSize, 32, 0)
    228 
    229 /// The kind of generated debug info.
    230 ENUM_CODEGENOPT(DebugInfo, codegenoptions::DebugInfoKind, 3, codegenoptions::NoDebugInfo)
    231 
    232 /// Whether to generate macro debug info.
    233 CODEGENOPT(MacroDebugInfo, 1, 0)
    234 
    235 /// Tune the debug info for this debugger.
    236 ENUM_CODEGENOPT(DebuggerTuning, llvm::DebuggerKind, 2,
    237                 llvm::DebuggerKind::Default)
    238 
    239 /// Dwarf version. Version zero indicates to LLVM that no DWARF should be
    240 /// emitted.
    241 VALUE_CODEGENOPT(DwarfVersion, 3, 0)
    242 
    243 /// Whether we should emit CodeView debug information. It's possible to emit
    244 /// CodeView and DWARF into the same object.
    245 CODEGENOPT(EmitCodeView, 1, 0)
    246 
    247 /// The kind of inlining to perform.
    248 ENUM_CODEGENOPT(Inlining, InliningMethod, 2, NormalInlining)
    249 
    250 // Vector functions library to use.
    251 ENUM_CODEGENOPT(VecLib, VectorLibrary, 2, NoLibrary)
    252 
    253 /// The default TLS model to use.
    254 ENUM_CODEGENOPT(DefaultTLSModel, TLSModel, 2, GeneralDynamicTLSModel)
    255 
    256 /// Number of path components to strip when emitting checks. (0 == full
    257 /// filename)
    258 VALUE_CODEGENOPT(EmitCheckPathComponentsToStrip, 32, 0)
    259 
    260 /// Whether to report the hotness of the code region for optimization remarks.
    261 CODEGENOPT(DiagnosticsWithHotness, 1, 0)
    262 
    263 /// Whether copy relocations support is available when building as PIE.
    264 CODEGENOPT(PIECopyRelocations, 1, 0)
    265 
    266 /// Whether we should use the undefined behaviour optimization for control flow
    267 /// paths that reach the end of a function without executing a required return.
    268 CODEGENOPT(StrictReturn, 1, 1)
    269 
    270 /// Whether emit extra debug info for sample pgo profile collection.
    271 CODEGENOPT(DebugInfoForProfiling, 1, 0)
    272 
    273 /// Whether 3-component vector type is preserved.
    274 CODEGENOPT(PreserveVec3Type, 1, 0)
    275 
    276 #undef CODEGENOPT
    277 #undef ENUM_CODEGENOPT
    278 #undef VALUE_CODEGENOPT
    279 
    280