1 //===--- CodeGenOptions.h ---------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the CodeGenOptions interface.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_FRONTEND_CODEGENOPTIONS_H
15 #define LLVM_CLANG_FRONTEND_CODEGENOPTIONS_H
17 #include "clang/Basic/DebugInfoOptions.h"
18 #include "clang/Basic/Sanitizers.h"
19 #include "llvm/Support/Regex.h"
20 #include "llvm/Target/TargetOptions.h"
28 /// \brief Bitfields of CodeGenOptions, split out from CodeGenOptions to ensure
29 /// that this large collection of bitfields is a trivial class type.
30 class CodeGenOptionsBase {
32 #define CODEGENOPT(Name, Bits, Default) unsigned Name : Bits;
33 #define ENUM_CODEGENOPT(Name, Type, Bits, Default)
34 #include "clang/Frontend/CodeGenOptions.def"
37 #define CODEGENOPT(Name, Bits, Default)
38 #define ENUM_CODEGENOPT(Name, Type, Bits, Default) unsigned Name : Bits;
39 #include "clang/Frontend/CodeGenOptions.def"
42 /// CodeGenOptions - Track various options which control how the code
43 /// is optimized and passed to the backend.
44 class CodeGenOptions : public CodeGenOptionsBase {
47 NormalInlining, // Use the standard function inlining pass.
48 OnlyHintInlining, // Inline only (implicitly) hinted functions.
49 OnlyAlwaysInlining // Only run the always inlining pass.
53 NoLibrary, // Don't use any vector library.
54 Accelerate, // Use the Accelerate framework.
55 SVML // Intel short vector math library.
59 enum ObjCDispatchMethodKind {
66 GeneralDynamicTLSModel,
72 /// Clang versions with different platform ABI conformance.
74 /// Attempt to be ABI-compatible with code generated by Clang 3.8.x
75 /// (SVN r257626). This causes <1 x long long> to be passed in an
76 /// integer register instead of an SSE register on x64_64.
79 /// Attempt to be ABI-compatible with code generated by Clang 4.0.x
80 /// (SVN r291814). This causes move operations to be ignored when
81 /// determining whether a class type can be passed or returned directly.
84 /// Conform to the underlying platform's C and C++ ABIs as closely
89 enum StructReturnConventionKind {
90 SRCK_Default, // No special option was passed.
91 SRCK_OnStack, // Small structs on the stack (-fpcc-struct-return).
92 SRCK_InRegs // Small structs in registers (-freg-struct-return).
95 enum ProfileInstrKind {
96 ProfileNone, // Profile instrumentation is turned off.
97 ProfileClangInstr, // Clang instrumentation to generate execution counts
99 ProfileIRInstr, // IR level PGO instrumentation in LLVM.
102 enum EmbedBitcodeKind {
103 Embed_Off, // No embedded bitcode.
104 Embed_All, // Embed both bitcode and commandline in the output.
105 Embed_Bitcode, // Embed just the bitcode in the output.
106 Embed_Marker // Embed a marker as a placeholder for bitcode.
109 /// The code model to use (-mcmodel).
110 std::string CodeModel;
112 /// The filename with path we use for coverage data files. The runtime
113 /// allows further manipulation with the GCOV_PREFIX and GCOV_PREFIX_STRIP
114 /// environment variables.
115 std::string CoverageDataFile;
117 /// The filename with path we use for coverage notes files.
118 std::string CoverageNotesFile;
120 /// The version string to put into coverage files.
121 char CoverageVersion[4];
123 /// Enable additional debugging information.
124 std::string DebugPass;
126 /// The string to embed in debug information as the current working directory.
127 std::string DebugCompilationDir;
129 /// The string to embed in the debug information for the compile unit, if
131 std::string DwarfDebugFlags;
133 std::map<std::string, std::string> DebugPrefixMap;
135 /// The ABI to use for passing floating point arguments.
136 std::string FloatABI;
138 /// The floating-point denormal mode to use.
139 std::string FPDenormalMode;
141 /// The float precision limit to use, if non-empty.
142 std::string LimitFloatPrecision;
144 struct BitcodeFileToLink {
145 /// The filename of the bitcode file to link in.
146 std::string Filename;
147 /// If true, we set attributes functions in the bitcode library according to
148 /// our CodeGenOptions, much as we set attrs on functions that we generate
150 bool PropagateAttrs = false;
151 /// If true, we use LLVM module internalizer.
152 bool Internalize = false;
153 /// Bitwise combination of llvm::Linker::Flags, passed to the LLVM linker.
154 unsigned LinkFlags = 0;
157 /// The files specified here are linked in to the module before optimizations.
158 std::vector<BitcodeFileToLink> LinkBitcodeFiles;
160 /// The user provided name for the "main file", if non-empty. This is useful
161 /// in situations where the input file name does not match the original input
162 /// file, for example with -save-temps.
163 std::string MainFileName;
165 /// The name for the split debug info file that we'll break out. This is used
166 /// in the backend for setting the name in the skeleton cu.
167 std::string SplitDwarfFile;
169 /// The name of the relocation model to use.
170 std::string RelocationModel;
172 /// The thread model to use
173 std::string ThreadModel;
175 /// If not an empty string, trap intrinsics are lowered to calls to this
176 /// function instead of to trap instructions.
177 std::string TrapFuncName;
179 /// A list of command-line options to forward to the LLVM backend.
180 std::vector<std::string> BackendOptions;
182 /// A list of dependent libraries.
183 std::vector<std::string> DependentLibraries;
185 /// A list of linker options to embed in the object file.
186 std::vector<std::string> LinkerOptions;
188 /// Name of the profile file to use as output for -fprofile-instr-generate
189 /// and -fprofile-generate.
190 std::string InstrProfileOutput;
192 /// Name of the profile file to use with -fprofile-sample-use.
193 std::string SampleProfileFile;
195 /// Name of the profile file to use as input for -fprofile-instr-use
196 std::string ProfileInstrumentUsePath;
198 /// Name of the function summary index file to use for ThinLTO function
200 std::string ThinLTOIndexFile;
202 /// Name of a file that can optionally be written with minimized bitcode
203 /// to be used as input for the ThinLTO thin link step, which only needs
204 /// the summary and module symbol table (and not, e.g. any debug metadata).
205 std::string ThinLinkBitcodeFile;
207 /// A list of file names passed with -fcuda-include-gpubinary options to
208 /// forward to CUDA runtime back-end for incorporating them into host-side
210 std::vector<std::string> CudaGpuBinaryFileNames;
212 /// The name of the file to which the backend should save YAML optimization
214 std::string OptRecordFile;
216 /// Regular expression to select optimizations for which we should enable
217 /// optimization remarks. Transformation passes whose name matches this
218 /// expression (and support this feature), will emit a diagnostic
219 /// whenever they perform a transformation. This is enabled by the
220 /// -Rpass=regexp flag.
221 std::shared_ptr<llvm::Regex> OptimizationRemarkPattern;
223 /// Regular expression to select optimizations for which we should enable
224 /// missed optimization remarks. Transformation passes whose name matches this
225 /// expression (and support this feature), will emit a diagnostic
226 /// whenever they tried but failed to perform a transformation. This is
227 /// enabled by the -Rpass-missed=regexp flag.
228 std::shared_ptr<llvm::Regex> OptimizationRemarkMissedPattern;
230 /// Regular expression to select optimizations for which we should enable
231 /// optimization analyses. Transformation passes whose name matches this
232 /// expression (and support this feature), will emit a diagnostic
233 /// whenever they want to explain why they decided to apply or not apply
234 /// a given transformation. This is enabled by the -Rpass-analysis=regexp
236 std::shared_ptr<llvm::Regex> OptimizationRemarkAnalysisPattern;
238 /// Set of files defining the rules for the symbol rewriting.
239 std::vector<std::string> RewriteMapFiles;
241 /// Set of sanitizer checks that are non-fatal (i.e. execution should be
242 /// continued when possible).
243 SanitizerSet SanitizeRecover;
245 /// Set of sanitizer checks that trap rather than diagnose.
246 SanitizerSet SanitizeTrap;
248 /// List of backend command-line options for -fembed-bitcode.
249 std::vector<uint8_t> CmdArgs;
251 /// \brief A list of all -fno-builtin-* function names (e.g., memset).
252 std::vector<std::string> NoBuiltinFuncs;
254 std::vector<std::string> Reciprocals;
256 /// The preferred width for auto-vectorization transforms. This is intended to
257 /// override default transforms based on the width of the architected vector
259 std::string PreferVectorWidth;
262 // Define accessors/mutators for code generation options of enumeration type.
263 #define CODEGENOPT(Name, Bits, Default)
264 #define ENUM_CODEGENOPT(Name, Type, Bits, Default) \
265 Type get##Name() const { return static_cast<Type>(Name); } \
266 void set##Name(Type Value) { Name = static_cast<unsigned>(Value); }
267 #include "clang/Frontend/CodeGenOptions.def"
271 /// \brief Is this a libc/libm function that is no longer recognized as a
272 /// builtin because a -fno-builtin-* option has been specified?
273 bool isNoBuiltinFunc(const char *Name) const;
275 const std::vector<std::string> &getNoBuiltinFuncs() const {
276 return NoBuiltinFuncs;
279 /// \brief Check if Clang profile instrumenation is on.
280 bool hasProfileClangInstr() const {
281 return getProfileInstr() == ProfileClangInstr;
284 /// \brief Check if IR level profile instrumentation is on.
285 bool hasProfileIRInstr() const {
286 return getProfileInstr() == ProfileIRInstr;
289 /// \brief Check if Clang profile use is on.
290 bool hasProfileClangUse() const {
291 return getProfileUse() == ProfileClangInstr;
294 /// \brief Check if IR level profile use is on.
295 bool hasProfileIRUse() const {
296 return getProfileUse() == ProfileIRInstr;
301 } // end namespace clang