clang 22.0.0git
CodeGenOptions.h
Go to the documentation of this file.
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
20#include "llvm/ADT/FloatingPointMode.h"
21#include "llvm/Frontend/Debug/Options.h"
22#include "llvm/Frontend/Driver/CodeGenOptions.h"
23#include "llvm/Support/CodeGen.h"
24#include "llvm/Support/Regex.h"
25#include "llvm/Target/TargetOptions.h"
26#include "llvm/Transforms/Instrumentation/AddressSanitizerOptions.h"
27#include <map>
28#include <memory>
29#include <string>
30#include <vector>
31
32namespace llvm {
33class PassBuilder;
34}
35namespace clang {
36
37/// Bitfields of CodeGenOptions, split out from CodeGenOptions to ensure
38/// that this large collection of bitfields is a trivial class type.
40 friend class CompilerInvocation;
42
43public:
44 /// For ASTs produced with different option value, signifies their level of
45 /// compatibility.
46 enum class CompatibilityKind {
47 /// Does affect the construction of the AST in a way that does prevent
48 /// module interoperability.
50 /// Does affect the construction of the AST in a way that doesn't prevent
51 /// interoperability (that is, the value can be different between an
52 /// explicit module and the user of that module).
54 /// Does not affect the construction of the AST in any way (that is, the
55 /// value can be different between an implicit module and the user of that
56 /// module).
58 };
59
61 using ProfileInstrKind = llvm::driver::ProfileInstrKind;
63 llvm::AsanDetectStackUseAfterReturnMode;
64 using AsanDtorKind = llvm::AsanDtorKind;
65 using VectorLibrary = llvm::driver::VectorLibrary;
66 using ZeroCallUsedRegsKind = llvm::ZeroCallUsedRegs::ZeroCallUsedRegsKind;
67 using WinX64EHUnwindV2Mode = llvm::WinX64EHUnwindV2Mode;
68
69 using DebugCompressionType = llvm::DebugCompressionType;
70 using EmitDwarfUnwindType = llvm::EmitDwarfUnwindType;
71 using DebugTemplateNamesKind = llvm::codegenoptions::DebugTemplateNamesKind;
72 using DebugInfoKind = llvm::codegenoptions::DebugInfoKind;
73 using DebuggerKind = llvm::DebuggerKind;
74
75#define CODEGENOPT(Name, Bits, Default, Compatibility) unsigned Name : Bits;
76#define ENUM_CODEGENOPT(Name, Type, Bits, Default, Compatibility)
77#include "clang/Basic/CodeGenOptions.def"
78
79protected:
80#define CODEGENOPT(Name, Bits, Default, Compatibility)
81#define ENUM_CODEGENOPT(Name, Type, Bits, Default, Compatibility) \
82 unsigned Name : Bits;
83#include "clang/Basic/CodeGenOptions.def"
84};
85
86/// CodeGenOptions - Track various options which control how the code
87/// is optimized and passed to the backend.
89public:
91 NormalInlining, // Use the standard function inlining pass.
92 OnlyHintInlining, // Inline only (implicitly) hinted functions.
93 OnlyAlwaysInlining // Only run the always inlining pass.
94 };
95
101
108
110 SRCK_Default, // No special option was passed.
111 SRCK_OnStack, // Small structs on the stack (-fpcc-struct-return).
112 SRCK_InRegs // Small structs in registers (-freg-struct-return).
113 };
114
116 Embed_Off, // No embedded bitcode.
117 Embed_All, // Embed both bitcode and commandline in the output.
118 Embed_Bitcode, // Embed just the bitcode in the output.
119 Embed_Marker // Embed a marker as a placeholder for bitcode.
120 };
121
127
132
139
140 // This field stores one of the allowed values for the option
141 // -fbasic-block-sections=. The allowed values with this option are:
142 // {"all", "list=<file>", "none"}.
143 //
144 // "all" : Generate basic block sections for all basic blocks.
145 // "list=<file>": Generate basic block sections for a subset of basic blocks.
146 // The functions and the machine basic block ids are specified
147 // in the file.
148 // "none": Disable sections for basic blocks.
149 std::string BBSections;
150
151 // If set, override the default value of MCAsmInfo::BinutilsVersion. If
152 // DisableIntegratedAS is specified, the assembly output will consider GNU as
153 // support. "none" means that all ELF features can be used, regardless of
154 // binutils support.
155 std::string BinutilsVersion;
156
157 enum class FramePointerKind {
158 NonLeafNoReserve, // Keep non-leaf frame pointers, allow the FP to be used
159 // as a GPR in leaf functions.
160 None, // Omit all frame pointers.
161 Reserved, // Maintain valid frame pointer chain.
162 NonLeaf, // Keep non-leaf frame pointers, don't allow the FP to be used as a
163 // GPR in leaf functions.
164 All, // Keep all frame pointers.
165 };
166
168 switch (Kind) {
170 return "none";
172 return "reserved";
174 return "non-leaf-no-reserve";
176 return "non-leaf";
178 return "all";
179 }
180
181 llvm_unreachable("invalid FramePointerKind");
182 }
183
184 /// Possible exception handling behavior.
186
188 Auto, // Choose Swift async extended frame info based on deployment target.
189 Always, // Unconditionally emit Swift async extended frame info.
190 Never, // Don't emit Swift async extended frame info.
192 };
193
195 Language, // Not specified, use language standard.
196 Always, // All loops are assumed to be finite.
197 Never, // No loop is assumed to be finite.
198 };
199
205
207 None, ///< Trap Messages are omitted. This offers the smallest debug info
208 ///< size but at the cost of making traps hard to debug.
209 Basic, ///< Trap Message is fixed per SanitizerKind. Produces smaller debug
210 ///< info than `Detailed` but is not as helpful for debugging.
211 Detailed, ///< Trap Message includes more context (e.g. the expression being
212 ///< overflowed). This is more helpful for debugging but produces
213 ///< larger debug info than `Basic`.
214 };
215
216 /// The code model to use (-mcmodel).
217 std::string CodeModel;
218
219 /// The code model-specific large data threshold to use
220 /// (-mlarge-data-threshold).
222
223 /// The filename with path we use for coverage data files. The runtime
224 /// allows further manipulation with the GCOV_PREFIX and GCOV_PREFIX_STRIP
225 /// environment variables.
226 std::string CoverageDataFile;
227
228 /// The filename with path we use for coverage notes files.
229 std::string CoverageNotesFile;
230
231 /// Regexes separated by a semi-colon to filter the files to instrument.
233
234 /// Regexes separated by a semi-colon to filter the files to not instrument.
236
237 /// The version string to put into coverage files.
238 char CoverageVersion[4] = {'0', '0', '0', '0'};
239
240 /// Enable additional debugging information.
241 std::string DebugPass;
242
243 /// The string to embed in debug information as the current working directory.
245
246 /// The string to embed in coverage mapping as the current working directory.
248
249 /// The string to embed in the debug information for the compile unit, if
250 /// non-empty.
251 std::string DwarfDebugFlags;
252
253 /// The string containing the commandline for the llvm.commandline metadata,
254 /// if non-empty.
255 std::string RecordCommandLine;
256
258
259 /// Prefix replacement map for source-based code coverage to remap source
260 /// file paths in coverage mapping.
262
263 /// The ABI to use for passing floating point arguments.
264 std::string FloatABI;
265
266 /// The file to use for dumping bug report by `Debugify` for original
267 /// debug info.
269
270 /// The floating-point denormal mode to use.
271 llvm::DenormalMode FPDenormalMode = llvm::DenormalMode::getIEEE();
272
273 /// The floating-point denormal mode to use, for float.
274 llvm::DenormalMode FP32DenormalMode = llvm::DenormalMode::getIEEE();
275
276 /// The float precision limit to use, if non-empty.
278
280 /// The filename of the bitcode file to link in.
281 std::string Filename;
282 /// If true, we set attributes functions in the bitcode library according to
283 /// our CodeGenOptions, much as we set attrs on functions that we generate
284 /// ourselves.
285 bool PropagateAttrs = false;
286 /// If true, we use LLVM module internalizer.
287 bool Internalize = false;
288 /// Bitwise combination of llvm::Linker::Flags, passed to the LLVM linker.
289 unsigned LinkFlags = 0;
290 };
291
292 /// The files specified here are linked in to the module before optimizations.
293 std::vector<BitcodeFileToLink> LinkBitcodeFiles;
294
295 /// The user provided name for the "main file", if non-empty. This is useful
296 /// in situations where the input file name does not match the original input
297 /// file, for example with -save-temps.
298 std::string MainFileName;
299
300 /// The name for the split debug info file used for the DW_AT_[GNU_]dwo_name
301 /// attribute in the skeleton CU.
302 std::string SplitDwarfFile;
303
304 /// Output filename for the split debug info, not used in the skeleton CU.
305 std::string SplitDwarfOutput;
306
307 /// Output filename used in the COFF debug information.
309
310 /// The name of the relocation model to use.
311 llvm::Reloc::Model RelocationModel;
312
313 /// If not an empty string, trap intrinsics are lowered to calls to this
314 /// function instead of to trap instructions.
315 std::string TrapFuncName;
316
317 /// A list of dependent libraries.
318 std::vector<std::string> DependentLibraries;
319
320 /// A list of linker options to embed in the object file.
321 std::vector<std::string> LinkerOptions;
322
323 /// Name of the profile file to use as output for -fprofile-instr-generate,
324 /// -fprofile-generate, and -fcs-profile-generate.
326
327 /// Name of the patchable function entry section with
328 /// -fpatchable-function-entry.
330
331 /// Name of the profile file to use with -fprofile-sample-use.
332 std::string SampleProfileFile;
333
334 /// Name of the profile file to use as output for with -fmemory-profile.
336
337 /// Name of the profile file to use as input for -fmemory-profile-use.
339
340 /// Name of the profile file to use as input for -fprofile-instr-use
342
343 /// Name of the profile remapping file to apply to the profile data supplied
344 /// by -fprofile-sample-use or -fprofile-instr-use.
346
347 /// Name of the function summary index file to use for ThinLTO function
348 /// importing.
349 std::string ThinLTOIndexFile;
350
351 /// Name of a file that can optionally be written with minimized bitcode
352 /// to be used as input for the ThinLTO thin link step, which only needs
353 /// the summary and module symbol table (and not, e.g. any debug metadata).
355
356 /// Prefix to use for -save-temps output.
358
359 /// Name of file passed with -fcuda-include-gpubinary option to forward to
360 /// CUDA runtime back-end for incorporating them into host-side object file.
362
363 /// List of filenames passed in using the -fembed-offload-object option. These
364 /// are offloading binaries containing device images and metadata.
365 std::vector<std::string> OffloadObjects;
366
367 /// The name of the file to which the backend should save YAML optimization
368 /// records.
369 std::string OptRecordFile;
370
371 /// The regex that filters the passes that should be saved to the optimization
372 /// records.
373 std::string OptRecordPasses;
374
375 /// The format used for serializing remarks (default: YAML)
376 std::string OptRecordFormat;
377
378 /// The name of the partition that symbols are assigned to, specified with
379 /// -fsymbol-partition (see https://lld.llvm.org/Partitions.html).
380 std::string SymbolPartition;
381
382 /// If non-empty, allow the compiler to assume that the given source file
383 /// identifier is unique at link time.
385
387 RK_Missing, // Remark argument not present on the command line.
388 RK_Enabled, // Remark enabled via '-Rgroup'.
389 RK_EnabledEverything, // Remark enabled via '-Reverything'.
390 RK_Disabled, // Remark disabled via '-Rno-group'.
391 RK_DisabledEverything, // Remark disabled via '-Rno-everything'.
392 RK_WithPattern, // Remark pattern specified via '-Rgroup=regexp'.
393 };
394
395 /// Optimization remark with an optional regular expression pattern.
396 struct OptRemark {
398 std::string Pattern;
399 std::shared_ptr<llvm::Regex> Regex;
400
401 /// By default, optimization remark is missing.
402 OptRemark() = default;
403
404 /// Returns true iff the optimization remark holds a valid regular
405 /// expression.
406 bool hasValidPattern() const { return Regex != nullptr; }
407
408 /// Matches the given string against the regex, if there is some.
409 bool patternMatches(StringRef String) const {
410 return hasValidPattern() && Regex->match(String);
411 }
412 };
413
414 /// Selected optimizations for which we should enable optimization remarks.
415 /// Transformation passes whose name matches the contained (optional) regular
416 /// expression (and support this feature), will emit a diagnostic whenever
417 /// they perform a transformation.
419
420 /// Selected optimizations for which we should enable missed optimization
421 /// remarks. Transformation passes whose name matches the contained (optional)
422 /// regular expression (and support this feature), will emit a diagnostic
423 /// whenever they tried but failed to perform a transformation.
425
426 /// Selected optimizations for which we should enable optimization analyses.
427 /// Transformation passes whose name matches the contained (optional) regular
428 /// expression (and support this feature), will emit a diagnostic whenever
429 /// they want to explain why they decided to apply or not apply a given
430 /// transformation.
432
433 /// Set of sanitizer checks that are non-fatal (i.e. execution should be
434 /// continued when possible).
436
437 /// Set of sanitizer checks that trap rather than diagnose.
439
440 /// Set of sanitizer checks that can merge handlers (smaller code size at
441 /// the expense of debuggability).
443
444 /// Set of thresholds in a range [0.0, 1.0]: the top hottest code responsible
445 /// for the given fraction of PGO counters will be excluded from sanitization
446 /// (0.0 [default] to skip none, 1.0 to skip all).
448
449 /// Set of sanitizer checks, for which the instrumentation will be annotated
450 /// with extra debug info.
452
453 std::optional<double> AllowRuntimeCheckSkipHotCutoff;
454
455 /// List of backend command-line options for -fembed-bitcode.
456 std::vector<uint8_t> CmdArgs;
457
458 /// A list of all -fno-builtin-* function names (e.g., memset).
459 std::vector<std::string> NoBuiltinFuncs;
460
461 std::vector<std::string> Reciprocals;
462
463 /// Configuration for pointer-signing.
465
466 /// The preferred width for auto-vectorization transforms. This is intended to
467 /// override default transforms based on the width of the architected vector
468 /// registers.
469 std::string PreferVectorWidth;
470
471 /// Set of XRay instrumentation kinds to emit.
473
474 std::vector<std::string> DefaultFunctionAttrs;
475
476 /// List of dynamic shared object files to be loaded as pass plugins.
477 std::vector<std::string> PassPlugins;
478
479 /// List of pass builder callbacks.
480 std::vector<std::function<void(llvm::PassBuilder &)>> PassBuilderCallbacks;
481
482 /// List of global variables explicitly specified by the user as toc-data.
483 std::vector<std::string> TocDataVarsUserSpecified;
484
485 /// List of global variables that over-ride the toc-data default.
486 std::vector<std::string> NoTocDataVars;
487
488 /// Path to allowlist file specifying which objects
489 /// (files, functions) should exclusively be instrumented
490 /// by sanitizer coverage pass.
491 std::vector<std::string> SanitizeCoverageAllowlistFiles;
492
493 /// The guard style used for stack protector to get a initial value, this
494 /// value usually be gotten from TLS or get from __stack_chk_guard, or some
495 /// other styles we may implement in the future.
497
498 /// The TLS base register when StackProtectorGuard is "tls", or register used
499 /// to store the stack canary for "sysreg".
500 /// On x86 this can be "fs" or "gs".
501 /// On AArch64 this can only be "sp_el0".
503
504 /// Specify a symbol to be the guard value.
506
507 /// Path to ignorelist file specifying which objects
508 /// (files, functions) listed for instrumentation by sanitizer
509 /// coverage pass should actually not be instrumented.
510 std::vector<std::string> SanitizeCoverageIgnorelistFiles;
511
512 /// Path to ignorelist file specifying which objects
513 /// (files, functions) listed for instrumentation by sanitizer
514 /// binary metadata pass should not be instrumented.
515 std::vector<std::string> SanitizeMetadataIgnorelistFiles;
516
517 /// Name of the stack usage file (i.e., .su file) if user passes
518 /// -fstack-usage. If empty, it can be implied that -fstack-usage is not
519 /// passed on the command line.
520 std::string StackUsageOutput;
521
522 /// Executable and command-line used to create a given CompilerInvocation.
523 /// Most of the time this will be the full -cc1 command.
524 const char *Argv0 = nullptr;
525 std::vector<std::string> CommandLineArgs;
526
527 /// The minimum hotness value a diagnostic needs in order to be included in
528 /// optimization diagnostics.
529 ///
530 /// The threshold is an Optional value, which maps to one of the 3 states:
531 /// 1. 0 => threshold disabled. All remarks will be printed.
532 /// 2. positive int => manual threshold by user. Remarks with hotness exceed
533 /// threshold will be printed.
534 /// 3. None => 'auto' threshold by user. The actual value is not
535 /// available at command line, but will be synced with
536 /// hotness threshold from profile summary during
537 /// compilation.
538 ///
539 /// If threshold option is not specified, it is disabled by default.
540 std::optional<uint64_t> DiagnosticsHotnessThreshold = 0;
541
542 /// The maximum percentage profiling weights can deviate from the expected
543 /// values in order to be included in misexpect diagnostics.
544 std::optional<uint32_t> DiagnosticsMisExpectTolerance = 0;
545
546 /// The name of a file to use with \c .secure_log_unique directives.
547 std::string AsSecureLogFile;
548
549 /// A list of functions that are replacable by the loader.
550 std::vector<std::string> LoaderReplaceableFunctionNames;
551 /// The name of a file that contains functions which will be compiled for
552 /// hotpatching. See -fms-secure-hotpatch-functions-file.
554
555 /// A list of functions which will be compiled for hotpatching.
556 /// See -fms-secure-hotpatch-functions-list.
557 std::vector<std::string> MSSecureHotPatchFunctionsList;
558
559public:
560 // Define accessors/mutators for code generation options of enumeration type.
561#define CODEGENOPT(Name, Bits, Default, Compatibility)
562#define ENUM_CODEGENOPT(Name, Type, Bits, Default, Compatibility) \
563 Type get##Name() const { return static_cast<Type>(Name); } \
564 void set##Name(Type Value) { Name = static_cast<unsigned>(Value); }
565#include "clang/Basic/CodeGenOptions.def"
566
568
569 const std::vector<std::string> &getNoBuiltinFuncs() const {
570 return NoBuiltinFuncs;
571 }
572
573 bool hasSjLjExceptions() const {
574 return getExceptionHandling() == ExceptionHandlingKind::SjLj;
575 }
576
577 bool hasSEHExceptions() const {
578 return getExceptionHandling() == ExceptionHandlingKind::WinEH;
579 }
580
581 bool hasDWARFExceptions() const {
582 return getExceptionHandling() == ExceptionHandlingKind::DwarfCFI;
583 }
584
585 bool hasWasmExceptions() const {
586 return getExceptionHandling() == ExceptionHandlingKind::Wasm;
587 }
588
589 /// Check if Clang profile instrumenation is on.
590 bool hasProfileClangInstr() const {
591 return getProfileInstr() ==
592 llvm::driver::ProfileInstrKind::ProfileClangInstr;
593 }
594
595 /// Check if IR level profile instrumentation is on.
596 bool hasProfileIRInstr() const {
597 return getProfileInstr() == llvm::driver::ProfileInstrKind::ProfileIRInstr;
598 }
599
600 /// Check if CS IR level profile instrumentation is on.
601 bool hasProfileCSIRInstr() const {
602 return getProfileInstr() ==
603 llvm::driver::ProfileInstrKind::ProfileCSIRInstr;
604 }
605
606 /// Check if any form of instrumentation is on.
607 bool hasProfileInstr() const {
608 return getProfileInstr() != llvm::driver::ProfileInstrKind::ProfileNone;
609 }
610
611 /// Check if Clang profile use is on.
612 bool hasProfileClangUse() const {
613 return getProfileUse() == llvm::driver::ProfileInstrKind::ProfileClangInstr;
614 }
615
616 /// Check if IR level profile use is on.
617 bool hasProfileIRUse() const {
618 return getProfileUse() == llvm::driver::ProfileInstrKind::ProfileIRInstr ||
619 getProfileUse() == llvm::driver::ProfileInstrKind::ProfileCSIRInstr;
620 }
621
622 /// Check if CSIR profile use is on.
623 bool hasProfileCSIRUse() const {
624 return getProfileUse() == llvm::driver::ProfileInstrKind::ProfileCSIRInstr;
625 }
626
627 /// Check if type and variable info should be emitted.
628 bool hasReducedDebugInfo() const {
629 return getDebugInfo() >= llvm::codegenoptions::DebugInfoConstructor;
630 }
631
632 /// Check if maybe unused type info should be emitted.
634 return getDebugInfo() >= llvm::codegenoptions::UnusedTypeInfo;
635 }
636
637 // Check if any one of SanitizeCoverage* is enabled.
638 bool hasSanitizeCoverage() const {
639 return SanitizeCoverageType || SanitizeCoverageIndirectCalls ||
640 SanitizeCoverageTraceCmp || SanitizeCoverageTraceLoads ||
641 SanitizeCoverageTraceStores || SanitizeCoverageControlFlow;
642 }
643
644 // Check if any one of SanitizeBinaryMetadata* is enabled.
646 return SanitizeBinaryMetadataCovered || SanitizeBinaryMetadataAtomics ||
647 SanitizeBinaryMetadataUAR;
648 }
649
650 /// Reset all of the options that are not considered when building a
651 /// module.
652 void resetNonModularOptions(StringRef ModuleFormat);
653
654 // Is the given function name one of the functions that can be replaced by the
655 // loader?
656 bool isLoaderReplaceableFunctionName(StringRef FuncName) const {
657 return llvm::is_contained(LoaderReplaceableFunctionNames, FuncName);
658 }
659};
660
661} // end namespace clang
662
663#endif
Defines the clang::SanitizerKind enum.
Defines the clang::XRayInstrKind enum.
Bitfields of CodeGenOptions, split out from CodeGenOptions to ensure that this large collection of bi...
llvm::driver::ProfileInstrKind ProfileInstrKind
llvm::AsanDtorKind AsanDtorKind
llvm::ZeroCallUsedRegs::ZeroCallUsedRegsKind ZeroCallUsedRegsKind
llvm::codegenoptions::DebugInfoKind DebugInfoKind
llvm::DebuggerKind DebuggerKind
llvm::WinX64EHUnwindV2Mode WinX64EHUnwindV2Mode
llvm::EmitDwarfUnwindType EmitDwarfUnwindType
llvm::AsanDetectStackUseAfterReturnMode AsanDetectStackUseAfterReturnMode
CompatibilityKind
For ASTs produced with different option value, signifies their level of compatibility.
@ NotCompatible
Does affect the construction of the AST in a way that does prevent module interoperability.
@ Compatible
Does affect the construction of the AST in a way that doesn't prevent interoperability (that is,...
@ Benign
Does not affect the construction of the AST in any way (that is, the value can be different between a...
friend class CompilerInvocationBase
llvm::DebugCompressionType DebugCompressionType
llvm::driver::VectorLibrary VectorLibrary
llvm::codegenoptions::DebugTemplateNamesKind DebugTemplateNamesKind
clang::CFBranchLabelSchemeKind CFBranchLabelSchemeKind
llvm::SmallVector< std::pair< std::string, std::string >, 0 > CoveragePrefixMap
Prefix replacement map for source-based code coverage to remap source file paths in coverage mapping.
std::string StackProtectorGuardSymbol
Specify a symbol to be the guard value.
SanitizerSet SanitizeMergeHandlers
Set of sanitizer checks that can merge handlers (smaller code size at the expense of debuggability).
std::string UniqueSourceFileIdentifier
If non-empty, allow the compiler to assume that the given source file identifier is unique at link ti...
std::string MSSecureHotPatchFunctionsFile
The name of a file that contains functions which will be compiled for hotpatching.
const std::vector< std::string > & getNoBuiltinFuncs() const
std::vector< std::string > LoaderReplaceableFunctionNames
A list of functions that are replacable by the loader.
llvm::SmallVector< std::pair< std::string, std::string >, 0 > DebugPrefixMap
@ None
Trap Messages are omitted.
@ Detailed
Trap Message includes more context (e.g.
@ Basic
Trap Message is fixed per SanitizerKind.
std::string OptRecordFile
The name of the file to which the backend should save YAML optimization records.
std::string InstrProfileOutput
Name of the profile file to use as output for -fprofile-instr-generate, -fprofile-generate,...
std::string StackProtectorGuard
The guard style used for stack protector to get a initial value, this value usually be gotten from TL...
bool hasDWARFExceptions() const
std::vector< BitcodeFileToLink > LinkBitcodeFiles
The files specified here are linked in to the module before optimizations.
std::string RecordCommandLine
The string containing the commandline for the llvm.commandline metadata, if non-empty.
std::optional< uint64_t > DiagnosticsHotnessThreshold
The minimum hotness value a diagnostic needs in order to be included in optimization diagnostics.
bool hasProfileInstr() const
Check if any form of instrumentation is on.
bool hasProfileIRUse() const
Check if IR level profile use is on.
char CoverageVersion[4]
The version string to put into coverage files.
std::string FloatABI
The ABI to use for passing floating point arguments.
std::string ThinLinkBitcodeFile
Name of a file that can optionally be written with minimized bitcode to be used as input for the Thin...
bool hasProfileCSIRInstr() const
Check if CS IR level profile instrumentation is on.
std::vector< std::string > DependentLibraries
A list of dependent libraries.
std::string DebugPass
Enable additional debugging information.
llvm::Reloc::Model RelocationModel
The name of the relocation model to use.
llvm::DenormalMode FPDenormalMode
The floating-point denormal mode to use.
std::string CoverageNotesFile
The filename with path we use for coverage notes files.
std::string ProfileInstrumentUsePath
Name of the profile file to use as input for -fprofile-instr-use.
std::string SampleProfileFile
Name of the profile file to use with -fprofile-sample-use.
uint64_t LargeDataThreshold
The code model-specific large data threshold to use (-mlarge-data-threshold).
static StringRef getFramePointerKindName(FramePointerKind Kind)
std::string MemoryProfileOutput
Name of the profile file to use as output for with -fmemory-profile.
std::vector< std::function< void(llvm::PassBuilder &)> > PassBuilderCallbacks
List of pass builder callbacks.
std::string LimitFloatPrecision
The float precision limit to use, if non-empty.
std::string CodeModel
The code model to use (-mcmodel).
std::vector< std::string > TocDataVarsUserSpecified
List of global variables explicitly specified by the user as toc-data.
std::string CoverageDataFile
The filename with path we use for coverage data files.
std::vector< std::string > PassPlugins
List of dynamic shared object files to be loaded as pass plugins.
bool hasProfileClangInstr() const
Check if Clang profile instrumenation is on.
std::string DebugCompilationDir
The string to embed in debug information as the current working directory.
std::optional< uint32_t > DiagnosticsMisExpectTolerance
The maximum percentage profiling weights can deviate from the expected values in order to be included...
std::string StackUsageOutput
Name of the stack usage file (i.e., .su file) if user passes -fstack-usage.
std::string OptRecordPasses
The regex that filters the passes that should be saved to the optimization records.
std::vector< std::string > SanitizeCoverageAllowlistFiles
Path to allowlist file specifying which objects (files, functions) should exclusively be instrumented...
std::string SaveTempsFilePrefix
Prefix to use for -save-temps output.
std::string PatchableFunctionEntrySection
Name of the patchable function entry section with -fpatchable-function-entry.
XRayInstrSet XRayInstrumentationBundle
Set of XRay instrumentation kinds to emit.
std::vector< std::string > SanitizeCoverageIgnorelistFiles
Path to ignorelist file specifying which objects (files, functions) listed for instrumentation by san...
bool hasSanitizeCoverage() const
std::vector< std::string > Reciprocals
std::string MainFileName
The user provided name for the "main file", if non-empty.
std::string CudaGpuBinaryFileName
Name of file passed with -fcuda-include-gpubinary option to forward to CUDA runtime back-end for inco...
SanitizerSet SanitizeAnnotateDebugInfo
Set of sanitizer checks, for which the instrumentation will be annotated with extra debug info.
PointerAuthOptions PointerAuth
Configuration for pointer-signing.
llvm::DenormalMode FP32DenormalMode
The floating-point denormal mode to use, for float.
bool hasProfileIRInstr() const
Check if IR level profile instrumentation is on.
bool hasProfileCSIRUse() const
Check if CSIR profile use is on.
std::string CoverageCompilationDir
The string to embed in coverage mapping as the current working directory.
SanitizerSet SanitizeTrap
Set of sanitizer checks that trap rather than diagnose.
std::vector< std::string > SanitizeMetadataIgnorelistFiles
Path to ignorelist file specifying which objects (files, functions) listed for instrumentation by san...
SanitizerSet SanitizeRecover
Set of sanitizer checks that are non-fatal (i.e.
std::string ProfileExcludeFiles
Regexes separated by a semi-colon to filter the files to not instrument.
std::string AsSecureLogFile
The name of a file to use with .secure_log_unique directives.
std::string ProfileRemappingFile
Name of the profile remapping file to apply to the profile data supplied by -fprofile-sample-use or -...
bool hasReducedDebugInfo() const
Check if type and variable info should be emitted.
bool hasSanitizeBinaryMetadata() const
OptRemark OptimizationRemark
Selected optimizations for which we should enable optimization remarks.
std::string ThinLTOIndexFile
Name of the function summary index file to use for ThinLTO function importing.
const char * Argv0
Executable and command-line used to create a given CompilerInvocation.
bool hasWasmExceptions() const
bool hasSjLjExceptions() const
std::string TrapFuncName
If not an empty string, trap intrinsics are lowered to calls to this function instead of to trap inst...
SanitizerMaskCutoffs SanitizeSkipHotCutoffs
Set of thresholds in a range [0.0, 1.0]: the top hottest code responsible for the given fraction of P...
std::string SplitDwarfFile
The name for the split debug info file used for the DW_AT_[GNU_]dwo_name attribute in the skeleton CU...
std::string StackProtectorGuardReg
The TLS base register when StackProtectorGuard is "tls", or register used to store the stack canary f...
std::vector< std::string > DefaultFunctionAttrs
std::vector< std::string > NoBuiltinFuncs
A list of all -fno-builtin-* function names (e.g., memset).
std::vector< uint8_t > CmdArgs
List of backend command-line options for -fembed-bitcode.
OptRemark OptimizationRemarkAnalysis
Selected optimizations for which we should enable optimization analyses.
std::optional< double > AllowRuntimeCheckSkipHotCutoff
std::vector< std::string > CommandLineArgs
std::vector< std::string > LinkerOptions
A list of linker options to embed in the object file.
bool hasSEHExceptions() const
std::string MemoryProfileUsePath
Name of the profile file to use as input for -fmemory-profile-use.
std::vector< std::string > MSSecureHotPatchFunctionsList
A list of functions which will be compiled for hotpatching.
void resetNonModularOptions(StringRef ModuleFormat)
Reset all of the options that are not considered when building a module.
ExceptionHandlingKind
Possible exception handling behavior.
std::string OptRecordFormat
The format used for serializing remarks (default: YAML)
bool hasProfileClangUse() const
Check if Clang profile use is on.
std::vector< std::string > OffloadObjects
List of filenames passed in using the -fembed-offload-object option.
std::string SymbolPartition
The name of the partition that symbols are assigned to, specified with -fsymbol-partition (see https:...
std::vector< std::string > NoTocDataVars
List of global variables that over-ride the toc-data default.
std::string ProfileFilterFiles
Regexes separated by a semi-colon to filter the files to instrument.
bool hasMaybeUnusedDebugInfo() const
Check if maybe unused type info should be emitted.
std::string PreferVectorWidth
The preferred width for auto-vectorization transforms.
std::string ObjectFilenameForDebug
Output filename used in the COFF debug information.
std::string SplitDwarfOutput
Output filename for the split debug info, not used in the skeleton CU.
bool isLoaderReplaceableFunctionName(StringRef FuncName) const
std::string DwarfDebugFlags
The string to embed in the debug information for the compile unit, if non-empty.
std::string DIBugsReportFilePath
The file to use for dumping bug report by Debugify for original debug info.
OptRemark OptimizationRemarkMissed
Selected optimizations for which we should enable missed optimization remarks.
The JSON file list parser is used to communicate input to InstallAPI.
Diagnostic wrappers for TextAPI types for error reporting.
Definition Dominators.h:30
int const char * function
Definition c++config.h:31
Optimization remark with an optional regular expression pattern.
std::shared_ptr< llvm::Regex > Regex
bool patternMatches(StringRef String) const
Matches the given string against the regex, if there is some.
OptRemark()=default
By default, optimization remark is missing.
bool hasValidPattern() const
Returns true iff the optimization remark holds a valid regular expression.