1 //===--- CodeGenOptions.h ---------------------------------------*- 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 CodeGenOptions interface. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #ifndef LLVM_CLANG_BASIC_CODEGENOPTIONS_H 14 #define LLVM_CLANG_BASIC_CODEGENOPTIONS_H 15 16 #include "clang/Basic/DebugInfoOptions.h" 17 #include "clang/Basic/Sanitizers.h" 18 #include "clang/Basic/XRayInstr.h" 19 #include "llvm/ADT/FloatingPointMode.h" 20 #include "llvm/Support/CodeGen.h" 21 #include "llvm/Support/Regex.h" 22 #include "llvm/Target/TargetOptions.h" 23 #include "llvm/Transforms/Instrumentation/AddressSanitizerOptions.h" 24 #include <map> 25 #include <memory> 26 #include <string> 27 #include <vector> 28 29 namespace clang { 30 31 /// Bitfields of CodeGenOptions, split out from CodeGenOptions to ensure 32 /// that this large collection of bitfields is a trivial class type. 33 class CodeGenOptionsBase { 34 friend class CompilerInvocation; 35 36 public: 37 #define CODEGENOPT(Name, Bits, Default) unsigned Name : Bits; 38 #define ENUM_CODEGENOPT(Name, Type, Bits, Default) 39 #include "clang/Basic/CodeGenOptions.def" 40 41 protected: 42 #define CODEGENOPT(Name, Bits, Default) 43 #define ENUM_CODEGENOPT(Name, Type, Bits, Default) unsigned Name : Bits; 44 #include "clang/Basic/CodeGenOptions.def" 45 }; 46 47 /// CodeGenOptions - Track various options which control how the code 48 /// is optimized and passed to the backend. 49 class CodeGenOptions : public CodeGenOptionsBase { 50 public: 51 enum InliningMethod { 52 NormalInlining, // Use the standard function inlining pass. 53 OnlyHintInlining, // Inline only (implicitly) hinted functions. 54 OnlyAlwaysInlining // Only run the always inlining pass. 55 }; 56 57 enum VectorLibrary { 58 NoLibrary, // Don't use any vector library. 59 Accelerate, // Use the Accelerate framework. 60 LIBMVEC, // GLIBC vector math library. 61 MASSV, // IBM MASS vector library. 62 SVML, // Intel short vector math library. 63 Darwin_libsystem_m // Use Darwin's libsytem_m vector functions. 64 }; 65 66 enum ObjCDispatchMethodKind { 67 Legacy = 0, 68 NonLegacy = 1, 69 Mixed = 2 70 }; 71 72 enum TLSModel { 73 GeneralDynamicTLSModel, 74 LocalDynamicTLSModel, 75 InitialExecTLSModel, 76 LocalExecTLSModel 77 }; 78 79 enum StructReturnConventionKind { 80 SRCK_Default, // No special option was passed. 81 SRCK_OnStack, // Small structs on the stack (-fpcc-struct-return). 82 SRCK_InRegs // Small structs in registers (-freg-struct-return). 83 }; 84 85 enum ProfileInstrKind { 86 ProfileNone, // Profile instrumentation is turned off. 87 ProfileClangInstr, // Clang instrumentation to generate execution counts 88 // to use with PGO. 89 ProfileIRInstr, // IR level PGO instrumentation in LLVM. 90 ProfileCSIRInstr, // IR level PGO context sensitive instrumentation in LLVM. 91 }; 92 93 enum EmbedBitcodeKind { 94 Embed_Off, // No embedded bitcode. 95 Embed_All, // Embed both bitcode and commandline in the output. 96 Embed_Bitcode, // Embed just the bitcode in the output. 97 Embed_Marker // Embed a marker as a placeholder for bitcode. 98 }; 99 100 enum InlineAsmDialectKind { 101 IAD_ATT, 102 IAD_Intel, 103 }; 104 105 // This field stores one of the allowed values for the option 106 // -fbasic-block-sections=. The allowed values with this option are: 107 // {"labels", "all", "list=<file>", "none"}. 108 // 109 // "labels": Only generate basic block symbols (labels) for all basic 110 // blocks, do not generate unique sections for basic blocks. 111 // Use the machine basic block id in the symbol name to 112 // associate profile info from virtual address to machine 113 // basic block. 114 // "all" : Generate basic block sections for all basic blocks. 115 // "list=<file>": Generate basic block sections for a subset of basic blocks. 116 // The functions and the machine basic block ids are specified 117 // in the file. 118 // "none": Disable sections/labels for basic blocks. 119 std::string BBSections; 120 121 // If set, override the default value of MCAsmInfo::BinutilsVersion. If 122 // DisableIntegratedAS is specified, the assembly output will consider GNU as 123 // support. "none" means that all ELF features can be used, regardless of 124 // binutils support. 125 std::string BinutilsVersion; 126 127 enum class FramePointerKind { 128 None, // Omit all frame pointers. 129 NonLeaf, // Keep non-leaf frame pointers. 130 All, // Keep all frame pointers. 131 }; 132 133 enum class SwiftAsyncFramePointerKind { 134 Auto, // Choose Swift async extended frame info based on deployment target. 135 Always, // Unconditionally emit Swift async extended frame info. 136 Never, // Don't emit Swift async extended frame info. 137 Default = Always, 138 }; 139 140 enum FiniteLoopsKind { 141 Language, // Not specified, use language standard. 142 Always, // All loops are assumed to be finite. 143 Never, // No loop is assumed to be finite. 144 }; 145 146 /// The code model to use (-mcmodel). 147 std::string CodeModel; 148 149 /// The filename with path we use for coverage data files. The runtime 150 /// allows further manipulation with the GCOV_PREFIX and GCOV_PREFIX_STRIP 151 /// environment variables. 152 std::string CoverageDataFile; 153 154 /// The filename with path we use for coverage notes files. 155 std::string CoverageNotesFile; 156 157 /// Regexes separated by a semi-colon to filter the files to instrument. 158 std::string ProfileFilterFiles; 159 160 /// Regexes separated by a semi-colon to filter the files to not instrument. 161 std::string ProfileExcludeFiles; 162 163 /// The version string to put into coverage files. 164 char CoverageVersion[4]; 165 166 /// Enable additional debugging information. 167 std::string DebugPass; 168 169 /// The string to embed in debug information as the current working directory. 170 std::string DebugCompilationDir; 171 172 /// The string to embed in coverage mapping as the current working directory. 173 std::string CoverageCompilationDir; 174 175 /// The string to embed in the debug information for the compile unit, if 176 /// non-empty. 177 std::string DwarfDebugFlags; 178 179 /// The string containing the commandline for the llvm.commandline metadata, 180 /// if non-empty. 181 std::string RecordCommandLine; 182 183 std::map<std::string, std::string> DebugPrefixMap; 184 std::map<std::string, std::string> CoveragePrefixMap; 185 186 /// The ABI to use for passing floating point arguments. 187 std::string FloatABI; 188 189 /// The file to use for dumping bug report by `Debugify` for original 190 /// debug info. 191 std::string DIBugsReportFilePath; 192 193 /// The floating-point denormal mode to use. 194 llvm::DenormalMode FPDenormalMode = llvm::DenormalMode::getIEEE(); 195 196 /// The floating-point denormal mode to use, for float. 197 llvm::DenormalMode FP32DenormalMode = llvm::DenormalMode::getIEEE(); 198 199 /// The float precision limit to use, if non-empty. 200 std::string LimitFloatPrecision; 201 202 struct BitcodeFileToLink { 203 /// The filename of the bitcode file to link in. 204 std::string Filename; 205 /// If true, we set attributes functions in the bitcode library according to 206 /// our CodeGenOptions, much as we set attrs on functions that we generate 207 /// ourselves. 208 bool PropagateAttrs = false; 209 /// If true, we use LLVM module internalizer. 210 bool Internalize = false; 211 /// Bitwise combination of llvm::Linker::Flags, passed to the LLVM linker. 212 unsigned LinkFlags = 0; 213 }; 214 215 /// The files specified here are linked in to the module before optimizations. 216 std::vector<BitcodeFileToLink> LinkBitcodeFiles; 217 218 /// The user provided name for the "main file", if non-empty. This is useful 219 /// in situations where the input file name does not match the original input 220 /// file, for example with -save-temps. 221 std::string MainFileName; 222 223 /// The name for the split debug info file used for the DW_AT_[GNU_]dwo_name 224 /// attribute in the skeleton CU. 225 std::string SplitDwarfFile; 226 227 /// Output filename for the split debug info, not used in the skeleton CU. 228 std::string SplitDwarfOutput; 229 230 /// Output filename used in the COFF debug information. 231 std::string ObjectFilenameForDebug; 232 233 /// The name of the relocation model to use. 234 llvm::Reloc::Model RelocationModel; 235 236 /// If not an empty string, trap intrinsics are lowered to calls to this 237 /// function instead of to trap instructions. 238 std::string TrapFuncName; 239 240 /// A list of dependent libraries. 241 std::vector<std::string> DependentLibraries; 242 243 /// A list of linker options to embed in the object file. 244 std::vector<std::string> LinkerOptions; 245 246 /// Name of the profile file to use as output for -fprofile-instr-generate, 247 /// -fprofile-generate, and -fcs-profile-generate. 248 std::string InstrProfileOutput; 249 250 /// Name of the profile file to use with -fprofile-sample-use. 251 std::string SampleProfileFile; 252 253 /// Name of the profile file to use as output for with -fmemory-profile. 254 std::string MemoryProfileOutput; 255 256 /// Name of the profile file to use as input for -fprofile-instr-use 257 std::string ProfileInstrumentUsePath; 258 259 /// Name of the profile remapping file to apply to the profile data supplied 260 /// by -fprofile-sample-use or -fprofile-instr-use. 261 std::string ProfileRemappingFile; 262 263 /// Name of the function summary index file to use for ThinLTO function 264 /// importing. 265 std::string ThinLTOIndexFile; 266 267 /// Name of a file that can optionally be written with minimized bitcode 268 /// to be used as input for the ThinLTO thin link step, which only needs 269 /// the summary and module symbol table (and not, e.g. any debug metadata). 270 std::string ThinLinkBitcodeFile; 271 272 /// Prefix to use for -save-temps output. 273 std::string SaveTempsFilePrefix; 274 275 /// Name of file passed with -fcuda-include-gpubinary option to forward to 276 /// CUDA runtime back-end for incorporating them into host-side object file. 277 std::string CudaGpuBinaryFileName; 278 279 /// List of filenames passed in using the -fembed-offload-object option. These 280 /// are offloading binaries containing device images and metadata. 281 std::vector<std::string> OffloadObjects; 282 283 /// The name of the file to which the backend should save YAML optimization 284 /// records. 285 std::string OptRecordFile; 286 287 /// The regex that filters the passes that should be saved to the optimization 288 /// records. 289 std::string OptRecordPasses; 290 291 /// The format used for serializing remarks (default: YAML) 292 std::string OptRecordFormat; 293 294 /// The name of the partition that symbols are assigned to, specified with 295 /// -fsymbol-partition (see https://lld.llvm.org/Partitions.html). 296 std::string SymbolPartition; 297 298 enum RemarkKind { 299 RK_Missing, // Remark argument not present on the command line. 300 RK_Enabled, // Remark enabled via '-Rgroup'. 301 RK_EnabledEverything, // Remark enabled via '-Reverything'. 302 RK_Disabled, // Remark disabled via '-Rno-group'. 303 RK_DisabledEverything, // Remark disabled via '-Rno-everything'. 304 RK_WithPattern, // Remark pattern specified via '-Rgroup=regexp'. 305 }; 306 307 /// Optimization remark with an optional regular expression pattern. 308 struct OptRemark { 309 RemarkKind Kind; 310 std::string Pattern; 311 std::shared_ptr<llvm::Regex> Regex; 312 313 /// By default, optimization remark is missing. 314 OptRemark() : Kind(RK_Missing), Regex(nullptr) {} 315 316 /// Returns true iff the optimization remark holds a valid regular 317 /// expression. 318 bool hasValidPattern() const { return Regex != nullptr; } 319 320 /// Matches the given string against the regex, if there is some. 321 bool patternMatches(StringRef String) const { 322 return hasValidPattern() && Regex->match(String); 323 } 324 }; 325 326 /// Selected optimizations for which we should enable optimization remarks. 327 /// Transformation passes whose name matches the contained (optional) regular 328 /// expression (and support this feature), will emit a diagnostic whenever 329 /// they perform a transformation. 330 OptRemark OptimizationRemark; 331 332 /// Selected optimizations for which we should enable missed optimization 333 /// remarks. Transformation passes whose name matches the contained (optional) 334 /// regular expression (and support this feature), will emit a diagnostic 335 /// whenever they tried but failed to perform a transformation. 336 OptRemark OptimizationRemarkMissed; 337 338 /// Selected optimizations for which we should enable optimization analyses. 339 /// Transformation passes whose name matches the contained (optional) regular 340 /// expression (and support this feature), will emit a diagnostic whenever 341 /// they want to explain why they decided to apply or not apply a given 342 /// transformation. 343 OptRemark OptimizationRemarkAnalysis; 344 345 /// Set of files defining the rules for the symbol rewriting. 346 std::vector<std::string> RewriteMapFiles; 347 348 /// Set of sanitizer checks that are non-fatal (i.e. execution should be 349 /// continued when possible). 350 SanitizerSet SanitizeRecover; 351 352 /// Set of sanitizer checks that trap rather than diagnose. 353 SanitizerSet SanitizeTrap; 354 355 /// List of backend command-line options for -fembed-bitcode. 356 std::vector<uint8_t> CmdArgs; 357 358 /// A list of all -fno-builtin-* function names (e.g., memset). 359 std::vector<std::string> NoBuiltinFuncs; 360 361 std::vector<std::string> Reciprocals; 362 363 /// The preferred width for auto-vectorization transforms. This is intended to 364 /// override default transforms based on the width of the architected vector 365 /// registers. 366 std::string PreferVectorWidth; 367 368 /// Set of XRay instrumentation kinds to emit. 369 XRayInstrSet XRayInstrumentationBundle; 370 371 std::vector<std::string> DefaultFunctionAttrs; 372 373 /// List of dynamic shared object files to be loaded as pass plugins. 374 std::vector<std::string> PassPlugins; 375 376 /// Path to allowlist file specifying which objects 377 /// (files, functions) should exclusively be instrumented 378 /// by sanitizer coverage pass. 379 std::vector<std::string> SanitizeCoverageAllowlistFiles; 380 381 /// The guard style used for stack protector to get a initial value, this 382 /// value usually be gotten from TLS or get from __stack_chk_guard, or some 383 /// other styles we may implement in the future. 384 std::string StackProtectorGuard; 385 386 /// The TLS base register when StackProtectorGuard is "tls", or register used 387 /// to store the stack canary for "sysreg". 388 /// On x86 this can be "fs" or "gs". 389 /// On AArch64 this can only be "sp_el0". 390 std::string StackProtectorGuardReg; 391 392 /// Specify a symbol to be the guard value. 393 std::string StackProtectorGuardSymbol; 394 395 /// Path to ignorelist file specifying which objects 396 /// (files, functions) listed for instrumentation by sanitizer 397 /// coverage pass should actually not be instrumented. 398 std::vector<std::string> SanitizeCoverageIgnorelistFiles; 399 400 /// Name of the stack usage file (i.e., .su file) if user passes 401 /// -fstack-usage. If empty, it can be implied that -fstack-usage is not 402 /// passed on the command line. 403 std::string StackUsageOutput; 404 405 /// Executable and command-line used to create a given CompilerInvocation. 406 /// Most of the time this will be the full -cc1 command. 407 const char *Argv0 = nullptr; 408 std::vector<std::string> CommandLineArgs; 409 410 /// The minimum hotness value a diagnostic needs in order to be included in 411 /// optimization diagnostics. 412 /// 413 /// The threshold is an Optional value, which maps to one of the 3 states: 414 /// 1. 0 => threshold disabled. All remarks will be printed. 415 /// 2. positive int => manual threshold by user. Remarks with hotness exceed 416 /// threshold will be printed. 417 /// 3. None => 'auto' threshold by user. The actual value is not 418 /// available at command line, but will be synced with 419 /// hotness threshold from profile summary during 420 /// compilation. 421 /// 422 /// If threshold option is not specified, it is disabled by default. 423 Optional<uint64_t> DiagnosticsHotnessThreshold = 0; 424 425 /// The maximum percentage profiling weights can deviate from the expected 426 /// values in order to be included in misexpect diagnostics. 427 Optional<uint64_t> DiagnosticsMisExpectTolerance = 0; 428 429 public: 430 // Define accessors/mutators for code generation options of enumeration type. 431 #define CODEGENOPT(Name, Bits, Default) 432 #define ENUM_CODEGENOPT(Name, Type, Bits, Default) \ 433 Type get##Name() const { return static_cast<Type>(Name); } \ 434 void set##Name(Type Value) { Name = static_cast<unsigned>(Value); } 435 #include "clang/Basic/CodeGenOptions.def" 436 437 CodeGenOptions(); 438 439 const std::vector<std::string> &getNoBuiltinFuncs() const { 440 return NoBuiltinFuncs; 441 } 442 443 /// Check if Clang profile instrumenation is on. 444 bool hasProfileClangInstr() const { 445 return getProfileInstr() == ProfileClangInstr; 446 } 447 448 /// Check if IR level profile instrumentation is on. 449 bool hasProfileIRInstr() const { 450 return getProfileInstr() == ProfileIRInstr; 451 } 452 453 /// Check if CS IR level profile instrumentation is on. 454 bool hasProfileCSIRInstr() const { 455 return getProfileInstr() == ProfileCSIRInstr; 456 } 457 458 /// Check if Clang profile use is on. 459 bool hasProfileClangUse() const { 460 return getProfileUse() == ProfileClangInstr; 461 } 462 463 /// Check if IR level profile use is on. 464 bool hasProfileIRUse() const { 465 return getProfileUse() == ProfileIRInstr || 466 getProfileUse() == ProfileCSIRInstr; 467 } 468 469 /// Check if CSIR profile use is on. 470 bool hasProfileCSIRUse() const { return getProfileUse() == ProfileCSIRInstr; } 471 472 /// Check if type and variable info should be emitted. 473 bool hasReducedDebugInfo() const { 474 return getDebugInfo() >= codegenoptions::DebugInfoConstructor; 475 } 476 477 /// Check if maybe unused type info should be emitted. 478 bool hasMaybeUnusedDebugInfo() const { 479 return getDebugInfo() >= codegenoptions::UnusedTypeInfo; 480 } 481 482 // Check if any one of SanitizeCoverage* is enabled. 483 bool hasSanitizeCoverage() const { 484 return SanitizeCoverageType || SanitizeCoverageIndirectCalls || 485 SanitizeCoverageTraceCmp || SanitizeCoverageTraceLoads || 486 SanitizeCoverageTraceStores; 487 } 488 }; 489 490 } // end namespace clang 491 492 #endif 493