[docs] Add LICENSE.txt to the root of the mono-repo
[llvm-project.git] / clang / lib / Frontend / CompilerInvocation.cpp
blob574514bdd0b0ac69cbea6328a588629d415be1cb
1 //===- CompilerInvocation.cpp ---------------------------------------------===//
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 //===----------------------------------------------------------------------===//
9 #include "clang/Frontend/CompilerInvocation.h"
10 #include "TestModuleFileExtension.h"
11 #include "clang/Basic/Builtins.h"
12 #include "clang/Basic/CharInfo.h"
13 #include "clang/Basic/CodeGenOptions.h"
14 #include "clang/Basic/CommentOptions.h"
15 #include "clang/Basic/DebugInfoOptions.h"
16 #include "clang/Basic/Diagnostic.h"
17 #include "clang/Basic/DiagnosticDriver.h"
18 #include "clang/Basic/DiagnosticOptions.h"
19 #include "clang/Basic/FileSystemOptions.h"
20 #include "clang/Basic/LLVM.h"
21 #include "clang/Basic/LangOptions.h"
22 #include "clang/Basic/LangStandard.h"
23 #include "clang/Basic/ObjCRuntime.h"
24 #include "clang/Basic/Sanitizers.h"
25 #include "clang/Basic/SourceLocation.h"
26 #include "clang/Basic/TargetOptions.h"
27 #include "clang/Basic/Version.h"
28 #include "clang/Basic/Visibility.h"
29 #include "clang/Basic/XRayInstr.h"
30 #include "clang/Config/config.h"
31 #include "clang/Driver/Driver.h"
32 #include "clang/Driver/DriverDiagnostic.h"
33 #include "clang/Driver/Options.h"
34 #include "clang/Frontend/CommandLineSourceLoc.h"
35 #include "clang/Frontend/DependencyOutputOptions.h"
36 #include "clang/Frontend/FrontendDiagnostic.h"
37 #include "clang/Frontend/FrontendOptions.h"
38 #include "clang/Frontend/FrontendPluginRegistry.h"
39 #include "clang/Frontend/MigratorOptions.h"
40 #include "clang/Frontend/PreprocessorOutputOptions.h"
41 #include "clang/Frontend/TextDiagnosticBuffer.h"
42 #include "clang/Frontend/Utils.h"
43 #include "clang/Lex/HeaderSearchOptions.h"
44 #include "clang/Lex/PreprocessorOptions.h"
45 #include "clang/Sema/CodeCompleteOptions.h"
46 #include "clang/Serialization/ASTBitCodes.h"
47 #include "clang/Serialization/ModuleFileExtension.h"
48 #include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
49 #include "llvm/ADT/APInt.h"
50 #include "llvm/ADT/ArrayRef.h"
51 #include "llvm/ADT/CachedHashString.h"
52 #include "llvm/ADT/DenseSet.h"
53 #include "llvm/ADT/FloatingPointMode.h"
54 #include "llvm/ADT/Hashing.h"
55 #include "llvm/ADT/None.h"
56 #include "llvm/ADT/Optional.h"
57 #include "llvm/ADT/STLExtras.h"
58 #include "llvm/ADT/SmallString.h"
59 #include "llvm/ADT/SmallVector.h"
60 #include "llvm/ADT/StringRef.h"
61 #include "llvm/ADT/StringSwitch.h"
62 #include "llvm/ADT/Triple.h"
63 #include "llvm/ADT/Twine.h"
64 #include "llvm/Config/llvm-config.h"
65 #include "llvm/IR/DebugInfoMetadata.h"
66 #include "llvm/Linker/Linker.h"
67 #include "llvm/MC/MCTargetOptions.h"
68 #include "llvm/Option/Arg.h"
69 #include "llvm/Option/ArgList.h"
70 #include "llvm/Option/OptSpecifier.h"
71 #include "llvm/Option/OptTable.h"
72 #include "llvm/Option/Option.h"
73 #include "llvm/ProfileData/InstrProfReader.h"
74 #include "llvm/Remarks/HotnessThresholdParser.h"
75 #include "llvm/Support/CodeGen.h"
76 #include "llvm/Support/Compiler.h"
77 #include "llvm/Support/Error.h"
78 #include "llvm/Support/ErrorHandling.h"
79 #include "llvm/Support/ErrorOr.h"
80 #include "llvm/Support/FileSystem.h"
81 #include "llvm/Support/HashBuilder.h"
82 #include "llvm/Support/Host.h"
83 #include "llvm/Support/MathExtras.h"
84 #include "llvm/Support/MemoryBuffer.h"
85 #include "llvm/Support/Path.h"
86 #include "llvm/Support/Process.h"
87 #include "llvm/Support/Regex.h"
88 #include "llvm/Support/VersionTuple.h"
89 #include "llvm/Support/VirtualFileSystem.h"
90 #include "llvm/Support/raw_ostream.h"
91 #include "llvm/Target/TargetOptions.h"
92 #include <algorithm>
93 #include <atomic>
94 #include <cassert>
95 #include <cstddef>
96 #include <cstring>
97 #include <fstream>
98 #include <memory>
99 #include <string>
100 #include <tuple>
101 #include <type_traits>
102 #include <utility>
103 #include <vector>
105 using namespace clang;
106 using namespace driver;
107 using namespace options;
108 using namespace llvm::opt;
110 //===----------------------------------------------------------------------===//
111 // Helpers.
112 //===----------------------------------------------------------------------===//
114 // Parse misexpect tolerance argument value.
115 // Valid option values are integers in the range [0, 100)
116 inline Expected<Optional<uint32_t>> parseToleranceOption(StringRef Arg) {
117 uint32_t Val;
118 if (Arg.getAsInteger(10, Val))
119 return llvm::createStringError(llvm::inconvertibleErrorCode(),
120 "Not an integer: %s", Arg.data());
121 return Val;
124 //===----------------------------------------------------------------------===//
125 // Initialization.
126 //===----------------------------------------------------------------------===//
128 CompilerInvocationRefBase::CompilerInvocationRefBase()
129 : LangOpts(new LangOptions()), TargetOpts(new TargetOptions()),
130 DiagnosticOpts(new DiagnosticOptions()),
131 HeaderSearchOpts(new HeaderSearchOptions()),
132 PreprocessorOpts(new PreprocessorOptions()),
133 AnalyzerOpts(new AnalyzerOptions()) {}
135 CompilerInvocationRefBase::CompilerInvocationRefBase(
136 const CompilerInvocationRefBase &X)
137 : LangOpts(new LangOptions(*X.getLangOpts())),
138 TargetOpts(new TargetOptions(X.getTargetOpts())),
139 DiagnosticOpts(new DiagnosticOptions(X.getDiagnosticOpts())),
140 HeaderSearchOpts(new HeaderSearchOptions(X.getHeaderSearchOpts())),
141 PreprocessorOpts(new PreprocessorOptions(X.getPreprocessorOpts())),
142 AnalyzerOpts(new AnalyzerOptions(*X.getAnalyzerOpts())) {}
144 CompilerInvocationRefBase::CompilerInvocationRefBase(
145 CompilerInvocationRefBase &&X) = default;
147 CompilerInvocationRefBase &
148 CompilerInvocationRefBase::operator=(CompilerInvocationRefBase X) {
149 LangOpts.swap(X.LangOpts);
150 TargetOpts.swap(X.TargetOpts);
151 DiagnosticOpts.swap(X.DiagnosticOpts);
152 HeaderSearchOpts.swap(X.HeaderSearchOpts);
153 PreprocessorOpts.swap(X.PreprocessorOpts);
154 AnalyzerOpts.swap(X.AnalyzerOpts);
155 return *this;
158 CompilerInvocationRefBase &
159 CompilerInvocationRefBase::operator=(CompilerInvocationRefBase &&X) = default;
161 CompilerInvocationRefBase::~CompilerInvocationRefBase() = default;
163 //===----------------------------------------------------------------------===//
164 // Normalizers
165 //===----------------------------------------------------------------------===//
167 #define SIMPLE_ENUM_VALUE_TABLE
168 #include "clang/Driver/Options.inc"
169 #undef SIMPLE_ENUM_VALUE_TABLE
171 static llvm::Optional<bool> normalizeSimpleFlag(OptSpecifier Opt,
172 unsigned TableIndex,
173 const ArgList &Args,
174 DiagnosticsEngine &Diags) {
175 if (Args.hasArg(Opt))
176 return true;
177 return None;
180 static Optional<bool> normalizeSimpleNegativeFlag(OptSpecifier Opt, unsigned,
181 const ArgList &Args,
182 DiagnosticsEngine &) {
183 if (Args.hasArg(Opt))
184 return false;
185 return None;
188 /// The tblgen-erated code passes in a fifth parameter of an arbitrary type, but
189 /// denormalizeSimpleFlags never looks at it. Avoid bloating compile-time with
190 /// unnecessary template instantiations and just ignore it with a variadic
191 /// argument.
192 static void denormalizeSimpleFlag(SmallVectorImpl<const char *> &Args,
193 const char *Spelling,
194 CompilerInvocation::StringAllocator,
195 Option::OptionClass, unsigned, /*T*/...) {
196 Args.push_back(Spelling);
199 template <typename T> static constexpr bool is_uint64_t_convertible() {
200 return !std::is_same<T, uint64_t>::value &&
201 llvm::is_integral_or_enum<T>::value;
204 template <typename T,
205 std::enable_if_t<!is_uint64_t_convertible<T>(), bool> = false>
206 static auto makeFlagToValueNormalizer(T Value) {
207 return [Value](OptSpecifier Opt, unsigned, const ArgList &Args,
208 DiagnosticsEngine &) -> Optional<T> {
209 if (Args.hasArg(Opt))
210 return Value;
211 return None;
215 template <typename T,
216 std::enable_if_t<is_uint64_t_convertible<T>(), bool> = false>
217 static auto makeFlagToValueNormalizer(T Value) {
218 return makeFlagToValueNormalizer(uint64_t(Value));
221 static auto makeBooleanOptionNormalizer(bool Value, bool OtherValue,
222 OptSpecifier OtherOpt) {
223 return [Value, OtherValue, OtherOpt](OptSpecifier Opt, unsigned,
224 const ArgList &Args,
225 DiagnosticsEngine &) -> Optional<bool> {
226 if (const Arg *A = Args.getLastArg(Opt, OtherOpt)) {
227 return A->getOption().matches(Opt) ? Value : OtherValue;
229 return None;
233 static auto makeBooleanOptionDenormalizer(bool Value) {
234 return [Value](SmallVectorImpl<const char *> &Args, const char *Spelling,
235 CompilerInvocation::StringAllocator, Option::OptionClass,
236 unsigned, bool KeyPath) {
237 if (KeyPath == Value)
238 Args.push_back(Spelling);
242 static void denormalizeStringImpl(SmallVectorImpl<const char *> &Args,
243 const char *Spelling,
244 CompilerInvocation::StringAllocator SA,
245 Option::OptionClass OptClass, unsigned,
246 const Twine &Value) {
247 switch (OptClass) {
248 case Option::SeparateClass:
249 case Option::JoinedOrSeparateClass:
250 case Option::JoinedAndSeparateClass:
251 Args.push_back(Spelling);
252 Args.push_back(SA(Value));
253 break;
254 case Option::JoinedClass:
255 case Option::CommaJoinedClass:
256 Args.push_back(SA(Twine(Spelling) + Value));
257 break;
258 default:
259 llvm_unreachable("Cannot denormalize an option with option class "
260 "incompatible with string denormalization.");
264 template <typename T>
265 static void
266 denormalizeString(SmallVectorImpl<const char *> &Args, const char *Spelling,
267 CompilerInvocation::StringAllocator SA,
268 Option::OptionClass OptClass, unsigned TableIndex, T Value) {
269 denormalizeStringImpl(Args, Spelling, SA, OptClass, TableIndex, Twine(Value));
272 static Optional<SimpleEnumValue>
273 findValueTableByName(const SimpleEnumValueTable &Table, StringRef Name) {
274 for (int I = 0, E = Table.Size; I != E; ++I)
275 if (Name == Table.Table[I].Name)
276 return Table.Table[I];
278 return None;
281 static Optional<SimpleEnumValue>
282 findValueTableByValue(const SimpleEnumValueTable &Table, unsigned Value) {
283 for (int I = 0, E = Table.Size; I != E; ++I)
284 if (Value == Table.Table[I].Value)
285 return Table.Table[I];
287 return None;
290 static llvm::Optional<unsigned> normalizeSimpleEnum(OptSpecifier Opt,
291 unsigned TableIndex,
292 const ArgList &Args,
293 DiagnosticsEngine &Diags) {
294 assert(TableIndex < SimpleEnumValueTablesSize);
295 const SimpleEnumValueTable &Table = SimpleEnumValueTables[TableIndex];
297 auto *Arg = Args.getLastArg(Opt);
298 if (!Arg)
299 return None;
301 StringRef ArgValue = Arg->getValue();
302 if (auto MaybeEnumVal = findValueTableByName(Table, ArgValue))
303 return MaybeEnumVal->Value;
305 Diags.Report(diag::err_drv_invalid_value)
306 << Arg->getAsString(Args) << ArgValue;
307 return None;
310 static void denormalizeSimpleEnumImpl(SmallVectorImpl<const char *> &Args,
311 const char *Spelling,
312 CompilerInvocation::StringAllocator SA,
313 Option::OptionClass OptClass,
314 unsigned TableIndex, unsigned Value) {
315 assert(TableIndex < SimpleEnumValueTablesSize);
316 const SimpleEnumValueTable &Table = SimpleEnumValueTables[TableIndex];
317 if (auto MaybeEnumVal = findValueTableByValue(Table, Value)) {
318 denormalizeString(Args, Spelling, SA, OptClass, TableIndex,
319 MaybeEnumVal->Name);
320 } else {
321 llvm_unreachable("The simple enum value was not correctly defined in "
322 "the tablegen option description");
326 template <typename T>
327 static void denormalizeSimpleEnum(SmallVectorImpl<const char *> &Args,
328 const char *Spelling,
329 CompilerInvocation::StringAllocator SA,
330 Option::OptionClass OptClass,
331 unsigned TableIndex, T Value) {
332 return denormalizeSimpleEnumImpl(Args, Spelling, SA, OptClass, TableIndex,
333 static_cast<unsigned>(Value));
336 static Optional<std::string> normalizeString(OptSpecifier Opt, int TableIndex,
337 const ArgList &Args,
338 DiagnosticsEngine &Diags) {
339 auto *Arg = Args.getLastArg(Opt);
340 if (!Arg)
341 return None;
342 return std::string(Arg->getValue());
345 template <typename IntTy>
346 static Optional<IntTy> normalizeStringIntegral(OptSpecifier Opt, int,
347 const ArgList &Args,
348 DiagnosticsEngine &Diags) {
349 auto *Arg = Args.getLastArg(Opt);
350 if (!Arg)
351 return None;
352 IntTy Res;
353 if (StringRef(Arg->getValue()).getAsInteger(0, Res)) {
354 Diags.Report(diag::err_drv_invalid_int_value)
355 << Arg->getAsString(Args) << Arg->getValue();
356 return None;
358 return Res;
361 static Optional<std::vector<std::string>>
362 normalizeStringVector(OptSpecifier Opt, int, const ArgList &Args,
363 DiagnosticsEngine &) {
364 return Args.getAllArgValues(Opt);
367 static void denormalizeStringVector(SmallVectorImpl<const char *> &Args,
368 const char *Spelling,
369 CompilerInvocation::StringAllocator SA,
370 Option::OptionClass OptClass,
371 unsigned TableIndex,
372 const std::vector<std::string> &Values) {
373 switch (OptClass) {
374 case Option::CommaJoinedClass: {
375 std::string CommaJoinedValue;
376 if (!Values.empty()) {
377 CommaJoinedValue.append(Values.front());
378 for (const std::string &Value : llvm::drop_begin(Values, 1)) {
379 CommaJoinedValue.append(",");
380 CommaJoinedValue.append(Value);
383 denormalizeString(Args, Spelling, SA, Option::OptionClass::JoinedClass,
384 TableIndex, CommaJoinedValue);
385 break;
387 case Option::JoinedClass:
388 case Option::SeparateClass:
389 case Option::JoinedOrSeparateClass:
390 for (const std::string &Value : Values)
391 denormalizeString(Args, Spelling, SA, OptClass, TableIndex, Value);
392 break;
393 default:
394 llvm_unreachable("Cannot denormalize an option with option class "
395 "incompatible with string vector denormalization.");
399 static Optional<std::string> normalizeTriple(OptSpecifier Opt, int TableIndex,
400 const ArgList &Args,
401 DiagnosticsEngine &Diags) {
402 auto *Arg = Args.getLastArg(Opt);
403 if (!Arg)
404 return None;
405 return llvm::Triple::normalize(Arg->getValue());
408 template <typename T, typename U>
409 static T mergeForwardValue(T KeyPath, U Value) {
410 return static_cast<T>(Value);
413 template <typename T, typename U> static T mergeMaskValue(T KeyPath, U Value) {
414 return KeyPath | Value;
417 template <typename T> static T extractForwardValue(T KeyPath) {
418 return KeyPath;
421 template <typename T, typename U, U Value>
422 static T extractMaskValue(T KeyPath) {
423 return ((KeyPath & Value) == Value) ? static_cast<T>(Value) : T();
426 #define PARSE_OPTION_WITH_MARSHALLING( \
427 ARGS, DIAGS, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
428 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX) \
429 if ((FLAGS)&options::CC1Option) { \
430 KEYPATH = MERGER(KEYPATH, DEFAULT_VALUE); \
431 if (IMPLIED_CHECK) \
432 KEYPATH = MERGER(KEYPATH, IMPLIED_VALUE); \
433 if (SHOULD_PARSE) \
434 if (auto MaybeValue = NORMALIZER(OPT_##ID, TABLE_INDEX, ARGS, DIAGS)) \
435 KEYPATH = \
436 MERGER(KEYPATH, static_cast<decltype(KEYPATH)>(*MaybeValue)); \
439 // Capture the extracted value as a lambda argument to avoid potential issues
440 // with lifetime extension of the reference.
441 #define GENERATE_OPTION_WITH_MARSHALLING( \
442 ARGS, STRING_ALLOCATOR, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, \
443 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, \
444 TABLE_INDEX) \
445 if ((FLAGS)&options::CC1Option) { \
446 [&](const auto &Extracted) { \
447 if (ALWAYS_EMIT || \
448 (Extracted != \
449 static_cast<decltype(KEYPATH)>((IMPLIED_CHECK) ? (IMPLIED_VALUE) \
450 : (DEFAULT_VALUE)))) \
451 DENORMALIZER(ARGS, SPELLING, STRING_ALLOCATOR, Option::KIND##Class, \
452 TABLE_INDEX, Extracted); \
453 }(EXTRACTOR(KEYPATH)); \
456 static StringRef GetInputKindName(InputKind IK);
458 static bool FixupInvocation(CompilerInvocation &Invocation,
459 DiagnosticsEngine &Diags, const ArgList &Args,
460 InputKind IK) {
461 unsigned NumErrorsBefore = Diags.getNumErrors();
463 LangOptions &LangOpts = *Invocation.getLangOpts();
464 CodeGenOptions &CodeGenOpts = Invocation.getCodeGenOpts();
465 TargetOptions &TargetOpts = Invocation.getTargetOpts();
466 FrontendOptions &FrontendOpts = Invocation.getFrontendOpts();
467 CodeGenOpts.XRayInstrumentFunctions = LangOpts.XRayInstrument;
468 CodeGenOpts.XRayAlwaysEmitCustomEvents = LangOpts.XRayAlwaysEmitCustomEvents;
469 CodeGenOpts.XRayAlwaysEmitTypedEvents = LangOpts.XRayAlwaysEmitTypedEvents;
470 CodeGenOpts.DisableFree = FrontendOpts.DisableFree;
471 FrontendOpts.GenerateGlobalModuleIndex = FrontendOpts.UseGlobalModuleIndex;
472 if (FrontendOpts.ShowStats)
473 CodeGenOpts.ClearASTBeforeBackend = false;
474 LangOpts.SanitizeCoverage = CodeGenOpts.hasSanitizeCoverage();
475 LangOpts.ForceEmitVTables = CodeGenOpts.ForceEmitVTables;
476 LangOpts.SpeculativeLoadHardening = CodeGenOpts.SpeculativeLoadHardening;
477 LangOpts.CurrentModule = LangOpts.ModuleName;
479 llvm::Triple T(TargetOpts.Triple);
480 llvm::Triple::ArchType Arch = T.getArch();
482 CodeGenOpts.CodeModel = TargetOpts.CodeModel;
484 if (LangOpts.getExceptionHandling() !=
485 LangOptions::ExceptionHandlingKind::None &&
486 T.isWindowsMSVCEnvironment())
487 Diags.Report(diag::err_fe_invalid_exception_model)
488 << static_cast<unsigned>(LangOpts.getExceptionHandling()) << T.str();
490 if (LangOpts.AppleKext && !LangOpts.CPlusPlus)
491 Diags.Report(diag::warn_c_kext);
493 if (Args.hasArg(OPT_fconcepts_ts))
494 Diags.Report(diag::warn_fe_concepts_ts_flag);
496 if (LangOpts.NewAlignOverride &&
497 !llvm::isPowerOf2_32(LangOpts.NewAlignOverride)) {
498 Arg *A = Args.getLastArg(OPT_fnew_alignment_EQ);
499 Diags.Report(diag::err_fe_invalid_alignment)
500 << A->getAsString(Args) << A->getValue();
501 LangOpts.NewAlignOverride = 0;
504 // Prevent the user from specifying both -fsycl-is-device and -fsycl-is-host.
505 if (LangOpts.SYCLIsDevice && LangOpts.SYCLIsHost)
506 Diags.Report(diag::err_drv_argument_not_allowed_with) << "-fsycl-is-device"
507 << "-fsycl-is-host";
509 if (Args.hasArg(OPT_fgnu89_inline) && LangOpts.CPlusPlus)
510 Diags.Report(diag::err_drv_argument_not_allowed_with)
511 << "-fgnu89-inline" << GetInputKindName(IK);
513 if (Args.hasArg(OPT_hlsl_entrypoint) && !LangOpts.HLSL)
514 Diags.Report(diag::err_drv_argument_not_allowed_with)
515 << "-hlsl-entry" << GetInputKindName(IK);
517 if (Args.hasArg(OPT_fgpu_allow_device_init) && !LangOpts.HIP)
518 Diags.Report(diag::warn_ignored_hip_only_option)
519 << Args.getLastArg(OPT_fgpu_allow_device_init)->getAsString(Args);
521 if (Args.hasArg(OPT_gpu_max_threads_per_block_EQ) && !LangOpts.HIP)
522 Diags.Report(diag::warn_ignored_hip_only_option)
523 << Args.getLastArg(OPT_gpu_max_threads_per_block_EQ)->getAsString(Args);
525 // When these options are used, the compiler is allowed to apply
526 // optimizations that may affect the final result. For example
527 // (x+y)+z is transformed to x+(y+z) but may not give the same
528 // final result; it's not value safe.
529 // Another example can be to simplify x/x to 1.0 but x could be 0.0, INF
530 // or NaN. Final result may then differ. An error is issued when the eval
531 // method is set with one of these options.
532 if (Args.hasArg(OPT_ffp_eval_method_EQ)) {
533 if (LangOpts.ApproxFunc)
534 Diags.Report(diag::err_incompatible_fp_eval_method_options) << 0;
535 if (LangOpts.AllowFPReassoc)
536 Diags.Report(diag::err_incompatible_fp_eval_method_options) << 1;
537 if (LangOpts.AllowRecip)
538 Diags.Report(diag::err_incompatible_fp_eval_method_options) << 2;
541 // -cl-strict-aliasing needs to emit diagnostic in the case where CL > 1.0.
542 // This option should be deprecated for CL > 1.0 because
543 // this option was added for compatibility with OpenCL 1.0.
544 if (Args.getLastArg(OPT_cl_strict_aliasing) &&
545 (LangOpts.getOpenCLCompatibleVersion() > 100))
546 Diags.Report(diag::warn_option_invalid_ocl_version)
547 << LangOpts.getOpenCLVersionString()
548 << Args.getLastArg(OPT_cl_strict_aliasing)->getAsString(Args);
550 if (Arg *A = Args.getLastArg(OPT_fdefault_calling_conv_EQ)) {
551 auto DefaultCC = LangOpts.getDefaultCallingConv();
553 bool emitError = (DefaultCC == LangOptions::DCC_FastCall ||
554 DefaultCC == LangOptions::DCC_StdCall) &&
555 Arch != llvm::Triple::x86;
556 emitError |= (DefaultCC == LangOptions::DCC_VectorCall ||
557 DefaultCC == LangOptions::DCC_RegCall) &&
558 !T.isX86();
559 if (emitError)
560 Diags.Report(diag::err_drv_argument_not_allowed_with)
561 << A->getSpelling() << T.getTriple();
564 return Diags.getNumErrors() == NumErrorsBefore;
567 //===----------------------------------------------------------------------===//
568 // Deserialization (from args)
569 //===----------------------------------------------------------------------===//
571 static unsigned getOptimizationLevel(ArgList &Args, InputKind IK,
572 DiagnosticsEngine &Diags) {
573 unsigned DefaultOpt = llvm::CodeGenOpt::None;
574 if ((IK.getLanguage() == Language::OpenCL ||
575 IK.getLanguage() == Language::OpenCLCXX) &&
576 !Args.hasArg(OPT_cl_opt_disable))
577 DefaultOpt = llvm::CodeGenOpt::Default;
579 if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
580 if (A->getOption().matches(options::OPT_O0))
581 return llvm::CodeGenOpt::None;
583 if (A->getOption().matches(options::OPT_Ofast))
584 return llvm::CodeGenOpt::Aggressive;
586 assert(A->getOption().matches(options::OPT_O));
588 StringRef S(A->getValue());
589 if (S == "s" || S == "z")
590 return llvm::CodeGenOpt::Default;
592 if (S == "g")
593 return llvm::CodeGenOpt::Less;
595 return getLastArgIntValue(Args, OPT_O, DefaultOpt, Diags);
598 return DefaultOpt;
601 static unsigned getOptimizationLevelSize(ArgList &Args) {
602 if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
603 if (A->getOption().matches(options::OPT_O)) {
604 switch (A->getValue()[0]) {
605 default:
606 return 0;
607 case 's':
608 return 1;
609 case 'z':
610 return 2;
614 return 0;
617 static void GenerateArg(SmallVectorImpl<const char *> &Args,
618 llvm::opt::OptSpecifier OptSpecifier,
619 CompilerInvocation::StringAllocator SA) {
620 Option Opt = getDriverOptTable().getOption(OptSpecifier);
621 denormalizeSimpleFlag(Args, SA(Opt.getPrefix() + Opt.getName()), SA,
622 Option::OptionClass::FlagClass, 0);
625 static void GenerateArg(SmallVectorImpl<const char *> &Args,
626 llvm::opt::OptSpecifier OptSpecifier,
627 const Twine &Value,
628 CompilerInvocation::StringAllocator SA) {
629 Option Opt = getDriverOptTable().getOption(OptSpecifier);
630 denormalizeString(Args, SA(Opt.getPrefix() + Opt.getName()), SA,
631 Opt.getKind(), 0, Value);
634 // Parse command line arguments into CompilerInvocation.
635 using ParseFn =
636 llvm::function_ref<bool(CompilerInvocation &, ArrayRef<const char *>,
637 DiagnosticsEngine &, const char *)>;
639 // Generate command line arguments from CompilerInvocation.
640 using GenerateFn = llvm::function_ref<void(
641 CompilerInvocation &, SmallVectorImpl<const char *> &,
642 CompilerInvocation::StringAllocator)>;
644 // May perform round-trip of command line arguments. By default, the round-trip
645 // is enabled in assert builds. This can be overwritten at run-time via the
646 // "-round-trip-args" and "-no-round-trip-args" command line flags.
647 // During round-trip, the command line arguments are parsed into a dummy
648 // instance of CompilerInvocation which is used to generate the command line
649 // arguments again. The real CompilerInvocation instance is then created by
650 // parsing the generated arguments, not the original ones.
651 static bool RoundTrip(ParseFn Parse, GenerateFn Generate,
652 CompilerInvocation &RealInvocation,
653 CompilerInvocation &DummyInvocation,
654 ArrayRef<const char *> CommandLineArgs,
655 DiagnosticsEngine &Diags, const char *Argv0) {
656 #ifndef NDEBUG
657 bool DoRoundTripDefault = true;
658 #else
659 bool DoRoundTripDefault = false;
660 #endif
662 bool DoRoundTrip = DoRoundTripDefault;
663 for (const auto *Arg : CommandLineArgs) {
664 if (Arg == StringRef("-round-trip-args"))
665 DoRoundTrip = true;
666 if (Arg == StringRef("-no-round-trip-args"))
667 DoRoundTrip = false;
670 // If round-trip was not requested, simply run the parser with the real
671 // invocation diagnostics.
672 if (!DoRoundTrip)
673 return Parse(RealInvocation, CommandLineArgs, Diags, Argv0);
675 // Serializes quoted (and potentially escaped) arguments.
676 auto SerializeArgs = [](ArrayRef<const char *> Args) {
677 std::string Buffer;
678 llvm::raw_string_ostream OS(Buffer);
679 for (const char *Arg : Args) {
680 llvm::sys::printArg(OS, Arg, /*Quote=*/true);
681 OS << ' ';
683 OS.flush();
684 return Buffer;
687 // Setup a dummy DiagnosticsEngine.
688 DiagnosticsEngine DummyDiags(new DiagnosticIDs(), new DiagnosticOptions());
689 DummyDiags.setClient(new TextDiagnosticBuffer());
691 // Run the first parse on the original arguments with the dummy invocation and
692 // diagnostics.
693 if (!Parse(DummyInvocation, CommandLineArgs, DummyDiags, Argv0) ||
694 DummyDiags.getNumWarnings() != 0) {
695 // If the first parse did not succeed, it must be user mistake (invalid
696 // command line arguments). We won't be able to generate arguments that
697 // would reproduce the same result. Let's fail again with the real
698 // invocation and diagnostics, so all side-effects of parsing are visible.
699 unsigned NumWarningsBefore = Diags.getNumWarnings();
700 auto Success = Parse(RealInvocation, CommandLineArgs, Diags, Argv0);
701 if (!Success || Diags.getNumWarnings() != NumWarningsBefore)
702 return Success;
704 // Parse with original options and diagnostics succeeded even though it
705 // shouldn't have. Something is off.
706 Diags.Report(diag::err_cc1_round_trip_fail_then_ok);
707 Diags.Report(diag::note_cc1_round_trip_original)
708 << SerializeArgs(CommandLineArgs);
709 return false;
712 // Setup string allocator.
713 llvm::BumpPtrAllocator Alloc;
714 llvm::StringSaver StringPool(Alloc);
715 auto SA = [&StringPool](const Twine &Arg) {
716 return StringPool.save(Arg).data();
719 // Generate arguments from the dummy invocation. If Generate is the
720 // inverse of Parse, the newly generated arguments must have the same
721 // semantics as the original.
722 SmallVector<const char *> GeneratedArgs1;
723 Generate(DummyInvocation, GeneratedArgs1, SA);
725 // Run the second parse, now on the generated arguments, and with the real
726 // invocation and diagnostics. The result is what we will end up using for the
727 // rest of compilation, so if Generate is not inverse of Parse, something down
728 // the line will break.
729 bool Success2 = Parse(RealInvocation, GeneratedArgs1, Diags, Argv0);
731 // The first parse on original arguments succeeded, but second parse of
732 // generated arguments failed. Something must be wrong with the generator.
733 if (!Success2) {
734 Diags.Report(diag::err_cc1_round_trip_ok_then_fail);
735 Diags.Report(diag::note_cc1_round_trip_generated)
736 << 1 << SerializeArgs(GeneratedArgs1);
737 return false;
740 // Generate arguments again, this time from the options we will end up using
741 // for the rest of the compilation.
742 SmallVector<const char *> GeneratedArgs2;
743 Generate(RealInvocation, GeneratedArgs2, SA);
745 // Compares two lists of generated arguments.
746 auto Equal = [](const ArrayRef<const char *> A,
747 const ArrayRef<const char *> B) {
748 return std::equal(A.begin(), A.end(), B.begin(), B.end(),
749 [](const char *AElem, const char *BElem) {
750 return StringRef(AElem) == StringRef(BElem);
754 // If we generated different arguments from what we assume are two
755 // semantically equivalent CompilerInvocations, the Generate function may
756 // be non-deterministic.
757 if (!Equal(GeneratedArgs1, GeneratedArgs2)) {
758 Diags.Report(diag::err_cc1_round_trip_mismatch);
759 Diags.Report(diag::note_cc1_round_trip_generated)
760 << 1 << SerializeArgs(GeneratedArgs1);
761 Diags.Report(diag::note_cc1_round_trip_generated)
762 << 2 << SerializeArgs(GeneratedArgs2);
763 return false;
766 Diags.Report(diag::remark_cc1_round_trip_generated)
767 << 1 << SerializeArgs(GeneratedArgs1);
768 Diags.Report(diag::remark_cc1_round_trip_generated)
769 << 2 << SerializeArgs(GeneratedArgs2);
771 return Success2;
774 static void addDiagnosticArgs(ArgList &Args, OptSpecifier Group,
775 OptSpecifier GroupWithValue,
776 std::vector<std::string> &Diagnostics) {
777 for (auto *A : Args.filtered(Group)) {
778 if (A->getOption().getKind() == Option::FlagClass) {
779 // The argument is a pure flag (such as OPT_Wall or OPT_Wdeprecated). Add
780 // its name (minus the "W" or "R" at the beginning) to the diagnostics.
781 Diagnostics.push_back(
782 std::string(A->getOption().getName().drop_front(1)));
783 } else if (A->getOption().matches(GroupWithValue)) {
784 // This is -Wfoo= or -Rfoo=, where foo is the name of the diagnostic
785 // group. Add only the group name to the diagnostics.
786 Diagnostics.push_back(
787 std::string(A->getOption().getName().drop_front(1).rtrim("=-")));
788 } else {
789 // Otherwise, add its value (for OPT_W_Joined and similar).
790 Diagnostics.push_back(A->getValue());
795 // Parse the Static Analyzer configuration. If \p Diags is set to nullptr,
796 // it won't verify the input.
797 static void parseAnalyzerConfigs(AnalyzerOptions &AnOpts,
798 DiagnosticsEngine *Diags);
800 static void getAllNoBuiltinFuncValues(ArgList &Args,
801 std::vector<std::string> &Funcs) {
802 std::vector<std::string> Values = Args.getAllArgValues(OPT_fno_builtin_);
803 auto BuiltinEnd = llvm::partition(Values, Builtin::Context::isBuiltinFunc);
804 Funcs.insert(Funcs.end(), Values.begin(), BuiltinEnd);
807 static void GenerateAnalyzerArgs(AnalyzerOptions &Opts,
808 SmallVectorImpl<const char *> &Args,
809 CompilerInvocation::StringAllocator SA) {
810 const AnalyzerOptions *AnalyzerOpts = &Opts;
812 #define ANALYZER_OPTION_WITH_MARSHALLING( \
813 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
814 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
815 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
816 MERGER, EXTRACTOR, TABLE_INDEX) \
817 GENERATE_OPTION_WITH_MARSHALLING( \
818 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
819 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
820 #include "clang/Driver/Options.inc"
821 #undef ANALYZER_OPTION_WITH_MARSHALLING
823 if (Opts.AnalysisConstraintsOpt != RangeConstraintsModel) {
824 switch (Opts.AnalysisConstraintsOpt) {
825 #define ANALYSIS_CONSTRAINTS(NAME, CMDFLAG, DESC, CREATFN) \
826 case NAME##Model: \
827 GenerateArg(Args, OPT_analyzer_constraints, CMDFLAG, SA); \
828 break;
829 #include "clang/StaticAnalyzer/Core/Analyses.def"
830 default:
831 llvm_unreachable("Tried to generate unknown analysis constraint.");
835 if (Opts.AnalysisDiagOpt != PD_HTML) {
836 switch (Opts.AnalysisDiagOpt) {
837 #define ANALYSIS_DIAGNOSTICS(NAME, CMDFLAG, DESC, CREATFN) \
838 case PD_##NAME: \
839 GenerateArg(Args, OPT_analyzer_output, CMDFLAG, SA); \
840 break;
841 #include "clang/StaticAnalyzer/Core/Analyses.def"
842 default:
843 llvm_unreachable("Tried to generate unknown analysis diagnostic client.");
847 if (Opts.AnalysisPurgeOpt != PurgeStmt) {
848 switch (Opts.AnalysisPurgeOpt) {
849 #define ANALYSIS_PURGE(NAME, CMDFLAG, DESC) \
850 case NAME: \
851 GenerateArg(Args, OPT_analyzer_purge, CMDFLAG, SA); \
852 break;
853 #include "clang/StaticAnalyzer/Core/Analyses.def"
854 default:
855 llvm_unreachable("Tried to generate unknown analysis purge mode.");
859 if (Opts.InliningMode != NoRedundancy) {
860 switch (Opts.InliningMode) {
861 #define ANALYSIS_INLINING_MODE(NAME, CMDFLAG, DESC) \
862 case NAME: \
863 GenerateArg(Args, OPT_analyzer_inlining_mode, CMDFLAG, SA); \
864 break;
865 #include "clang/StaticAnalyzer/Core/Analyses.def"
866 default:
867 llvm_unreachable("Tried to generate unknown analysis inlining mode.");
871 for (const auto &CP : Opts.CheckersAndPackages) {
872 OptSpecifier Opt =
873 CP.second ? OPT_analyzer_checker : OPT_analyzer_disable_checker;
874 GenerateArg(Args, Opt, CP.first, SA);
877 AnalyzerOptions ConfigOpts;
878 parseAnalyzerConfigs(ConfigOpts, nullptr);
880 for (const auto &C : Opts.Config) {
881 // Don't generate anything that came from parseAnalyzerConfigs. It would be
882 // redundant and may not be valid on the command line.
883 auto Entry = ConfigOpts.Config.find(C.getKey());
884 if (Entry != ConfigOpts.Config.end() && Entry->getValue() == C.getValue())
885 continue;
887 GenerateArg(Args, OPT_analyzer_config, C.getKey() + "=" + C.getValue(), SA);
890 // Nothing to generate for FullCompilerInvocation.
893 static bool ParseAnalyzerArgs(AnalyzerOptions &Opts, ArgList &Args,
894 DiagnosticsEngine &Diags) {
895 unsigned NumErrorsBefore = Diags.getNumErrors();
897 AnalyzerOptions *AnalyzerOpts = &Opts;
899 #define ANALYZER_OPTION_WITH_MARSHALLING( \
900 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
901 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
902 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
903 MERGER, EXTRACTOR, TABLE_INDEX) \
904 PARSE_OPTION_WITH_MARSHALLING( \
905 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
906 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
907 #include "clang/Driver/Options.inc"
908 #undef ANALYZER_OPTION_WITH_MARSHALLING
910 if (Arg *A = Args.getLastArg(OPT_analyzer_constraints)) {
911 StringRef Name = A->getValue();
912 AnalysisConstraints Value = llvm::StringSwitch<AnalysisConstraints>(Name)
913 #define ANALYSIS_CONSTRAINTS(NAME, CMDFLAG, DESC, CREATFN) \
914 .Case(CMDFLAG, NAME##Model)
915 #include "clang/StaticAnalyzer/Core/Analyses.def"
916 .Default(NumConstraints);
917 if (Value == NumConstraints) {
918 Diags.Report(diag::err_drv_invalid_value)
919 << A->getAsString(Args) << Name;
920 } else {
921 #ifndef LLVM_WITH_Z3
922 if (Value == AnalysisConstraints::Z3ConstraintsModel) {
923 Diags.Report(diag::err_analyzer_not_built_with_z3);
925 #endif // LLVM_WITH_Z3
926 Opts.AnalysisConstraintsOpt = Value;
930 if (Arg *A = Args.getLastArg(OPT_analyzer_output)) {
931 StringRef Name = A->getValue();
932 AnalysisDiagClients Value = llvm::StringSwitch<AnalysisDiagClients>(Name)
933 #define ANALYSIS_DIAGNOSTICS(NAME, CMDFLAG, DESC, CREATFN) \
934 .Case(CMDFLAG, PD_##NAME)
935 #include "clang/StaticAnalyzer/Core/Analyses.def"
936 .Default(NUM_ANALYSIS_DIAG_CLIENTS);
937 if (Value == NUM_ANALYSIS_DIAG_CLIENTS) {
938 Diags.Report(diag::err_drv_invalid_value)
939 << A->getAsString(Args) << Name;
940 } else {
941 Opts.AnalysisDiagOpt = Value;
945 if (Arg *A = Args.getLastArg(OPT_analyzer_purge)) {
946 StringRef Name = A->getValue();
947 AnalysisPurgeMode Value = llvm::StringSwitch<AnalysisPurgeMode>(Name)
948 #define ANALYSIS_PURGE(NAME, CMDFLAG, DESC) \
949 .Case(CMDFLAG, NAME)
950 #include "clang/StaticAnalyzer/Core/Analyses.def"
951 .Default(NumPurgeModes);
952 if (Value == NumPurgeModes) {
953 Diags.Report(diag::err_drv_invalid_value)
954 << A->getAsString(Args) << Name;
955 } else {
956 Opts.AnalysisPurgeOpt = Value;
960 if (Arg *A = Args.getLastArg(OPT_analyzer_inlining_mode)) {
961 StringRef Name = A->getValue();
962 AnalysisInliningMode Value = llvm::StringSwitch<AnalysisInliningMode>(Name)
963 #define ANALYSIS_INLINING_MODE(NAME, CMDFLAG, DESC) \
964 .Case(CMDFLAG, NAME)
965 #include "clang/StaticAnalyzer/Core/Analyses.def"
966 .Default(NumInliningModes);
967 if (Value == NumInliningModes) {
968 Diags.Report(diag::err_drv_invalid_value)
969 << A->getAsString(Args) << Name;
970 } else {
971 Opts.InliningMode = Value;
975 Opts.CheckersAndPackages.clear();
976 for (const Arg *A :
977 Args.filtered(OPT_analyzer_checker, OPT_analyzer_disable_checker)) {
978 A->claim();
979 bool IsEnabled = A->getOption().getID() == OPT_analyzer_checker;
980 // We can have a list of comma separated checker names, e.g:
981 // '-analyzer-checker=cocoa,unix'
982 StringRef CheckerAndPackageList = A->getValue();
983 SmallVector<StringRef, 16> CheckersAndPackages;
984 CheckerAndPackageList.split(CheckersAndPackages, ",");
985 for (const StringRef &CheckerOrPackage : CheckersAndPackages)
986 Opts.CheckersAndPackages.emplace_back(std::string(CheckerOrPackage),
987 IsEnabled);
990 // Go through the analyzer configuration options.
991 for (const auto *A : Args.filtered(OPT_analyzer_config)) {
993 // We can have a list of comma separated config names, e.g:
994 // '-analyzer-config key1=val1,key2=val2'
995 StringRef configList = A->getValue();
996 SmallVector<StringRef, 4> configVals;
997 configList.split(configVals, ",");
998 for (const auto &configVal : configVals) {
999 StringRef key, val;
1000 std::tie(key, val) = configVal.split("=");
1001 if (val.empty()) {
1002 Diags.Report(SourceLocation(),
1003 diag::err_analyzer_config_no_value) << configVal;
1004 break;
1006 if (val.contains('=')) {
1007 Diags.Report(SourceLocation(),
1008 diag::err_analyzer_config_multiple_values)
1009 << configVal;
1010 break;
1013 // TODO: Check checker options too, possibly in CheckerRegistry.
1014 // Leave unknown non-checker configs unclaimed.
1015 if (!key.contains(":") && Opts.isUnknownAnalyzerConfig(key)) {
1016 if (Opts.ShouldEmitErrorsOnInvalidConfigValue)
1017 Diags.Report(diag::err_analyzer_config_unknown) << key;
1018 continue;
1021 A->claim();
1022 Opts.Config[key] = std::string(val);
1026 if (Opts.ShouldEmitErrorsOnInvalidConfigValue)
1027 parseAnalyzerConfigs(Opts, &Diags);
1028 else
1029 parseAnalyzerConfigs(Opts, nullptr);
1031 llvm::raw_string_ostream os(Opts.FullCompilerInvocation);
1032 for (unsigned i = 0; i < Args.getNumInputArgStrings(); ++i) {
1033 if (i != 0)
1034 os << " ";
1035 os << Args.getArgString(i);
1037 os.flush();
1039 return Diags.getNumErrors() == NumErrorsBefore;
1042 static StringRef getStringOption(AnalyzerOptions::ConfigTable &Config,
1043 StringRef OptionName, StringRef DefaultVal) {
1044 return Config.insert({OptionName, std::string(DefaultVal)}).first->second;
1047 static void initOption(AnalyzerOptions::ConfigTable &Config,
1048 DiagnosticsEngine *Diags,
1049 StringRef &OptionField, StringRef Name,
1050 StringRef DefaultVal) {
1051 // String options may be known to invalid (e.g. if the expected string is a
1052 // file name, but the file does not exist), those will have to be checked in
1053 // parseConfigs.
1054 OptionField = getStringOption(Config, Name, DefaultVal);
1057 static void initOption(AnalyzerOptions::ConfigTable &Config,
1058 DiagnosticsEngine *Diags,
1059 bool &OptionField, StringRef Name, bool DefaultVal) {
1060 auto PossiblyInvalidVal = llvm::StringSwitch<Optional<bool>>(
1061 getStringOption(Config, Name, (DefaultVal ? "true" : "false")))
1062 .Case("true", true)
1063 .Case("false", false)
1064 .Default(None);
1066 if (!PossiblyInvalidVal) {
1067 if (Diags)
1068 Diags->Report(diag::err_analyzer_config_invalid_input)
1069 << Name << "a boolean";
1070 else
1071 OptionField = DefaultVal;
1072 } else
1073 OptionField = *PossiblyInvalidVal;
1076 static void initOption(AnalyzerOptions::ConfigTable &Config,
1077 DiagnosticsEngine *Diags,
1078 unsigned &OptionField, StringRef Name,
1079 unsigned DefaultVal) {
1081 OptionField = DefaultVal;
1082 bool HasFailed = getStringOption(Config, Name, std::to_string(DefaultVal))
1083 .getAsInteger(0, OptionField);
1084 if (Diags && HasFailed)
1085 Diags->Report(diag::err_analyzer_config_invalid_input)
1086 << Name << "an unsigned";
1089 static void parseAnalyzerConfigs(AnalyzerOptions &AnOpts,
1090 DiagnosticsEngine *Diags) {
1091 // TODO: There's no need to store the entire configtable, it'd be plenty
1092 // enough to store checker options.
1094 #define ANALYZER_OPTION(TYPE, NAME, CMDFLAG, DESC, DEFAULT_VAL) \
1095 initOption(AnOpts.Config, Diags, AnOpts.NAME, CMDFLAG, DEFAULT_VAL);
1096 #define ANALYZER_OPTION_DEPENDS_ON_USER_MODE(...)
1097 #include "clang/StaticAnalyzer/Core/AnalyzerOptions.def"
1099 assert(AnOpts.UserMode == "shallow" || AnOpts.UserMode == "deep");
1100 const bool InShallowMode = AnOpts.UserMode == "shallow";
1102 #define ANALYZER_OPTION(...)
1103 #define ANALYZER_OPTION_DEPENDS_ON_USER_MODE(TYPE, NAME, CMDFLAG, DESC, \
1104 SHALLOW_VAL, DEEP_VAL) \
1105 initOption(AnOpts.Config, Diags, AnOpts.NAME, CMDFLAG, \
1106 InShallowMode ? SHALLOW_VAL : DEEP_VAL);
1107 #include "clang/StaticAnalyzer/Core/AnalyzerOptions.def"
1109 // At this point, AnalyzerOptions is configured. Let's validate some options.
1111 // FIXME: Here we try to validate the silenced checkers or packages are valid.
1112 // The current approach only validates the registered checkers which does not
1113 // contain the runtime enabled checkers and optimally we would validate both.
1114 if (!AnOpts.RawSilencedCheckersAndPackages.empty()) {
1115 std::vector<StringRef> Checkers =
1116 AnOpts.getRegisteredCheckers(/*IncludeExperimental=*/true);
1117 std::vector<StringRef> Packages =
1118 AnOpts.getRegisteredPackages(/*IncludeExperimental=*/true);
1120 SmallVector<StringRef, 16> CheckersAndPackages;
1121 AnOpts.RawSilencedCheckersAndPackages.split(CheckersAndPackages, ";");
1123 for (const StringRef &CheckerOrPackage : CheckersAndPackages) {
1124 if (Diags) {
1125 bool IsChecker = CheckerOrPackage.contains('.');
1126 bool IsValidName = IsChecker
1127 ? llvm::is_contained(Checkers, CheckerOrPackage)
1128 : llvm::is_contained(Packages, CheckerOrPackage);
1130 if (!IsValidName)
1131 Diags->Report(diag::err_unknown_analyzer_checker_or_package)
1132 << CheckerOrPackage;
1135 AnOpts.SilencedCheckersAndPackages.emplace_back(CheckerOrPackage);
1139 if (!Diags)
1140 return;
1142 if (AnOpts.ShouldTrackConditionsDebug && !AnOpts.ShouldTrackConditions)
1143 Diags->Report(diag::err_analyzer_config_invalid_input)
1144 << "track-conditions-debug" << "'track-conditions' to also be enabled";
1146 if (!AnOpts.CTUDir.empty() && !llvm::sys::fs::is_directory(AnOpts.CTUDir))
1147 Diags->Report(diag::err_analyzer_config_invalid_input) << "ctu-dir"
1148 << "a filename";
1150 if (!AnOpts.ModelPath.empty() &&
1151 !llvm::sys::fs::is_directory(AnOpts.ModelPath))
1152 Diags->Report(diag::err_analyzer_config_invalid_input) << "model-path"
1153 << "a filename";
1156 /// Generate a remark argument. This is an inverse of `ParseOptimizationRemark`.
1157 static void
1158 GenerateOptimizationRemark(SmallVectorImpl<const char *> &Args,
1159 CompilerInvocation::StringAllocator SA,
1160 OptSpecifier OptEQ, StringRef Name,
1161 const CodeGenOptions::OptRemark &Remark) {
1162 if (Remark.hasValidPattern()) {
1163 GenerateArg(Args, OptEQ, Remark.Pattern, SA);
1164 } else if (Remark.Kind == CodeGenOptions::RK_Enabled) {
1165 GenerateArg(Args, OPT_R_Joined, Name, SA);
1166 } else if (Remark.Kind == CodeGenOptions::RK_Disabled) {
1167 GenerateArg(Args, OPT_R_Joined, StringRef("no-") + Name, SA);
1171 /// Parse a remark command line argument. It may be missing, disabled/enabled by
1172 /// '-R[no-]group' or specified with a regular expression by '-Rgroup=regexp'.
1173 /// On top of that, it can be disabled/enabled globally by '-R[no-]everything'.
1174 static CodeGenOptions::OptRemark
1175 ParseOptimizationRemark(DiagnosticsEngine &Diags, ArgList &Args,
1176 OptSpecifier OptEQ, StringRef Name) {
1177 CodeGenOptions::OptRemark Result;
1179 auto InitializeResultPattern = [&Diags, &Args, &Result](const Arg *A,
1180 StringRef Pattern) {
1181 Result.Pattern = Pattern.str();
1183 std::string RegexError;
1184 Result.Regex = std::make_shared<llvm::Regex>(Result.Pattern);
1185 if (!Result.Regex->isValid(RegexError)) {
1186 Diags.Report(diag::err_drv_optimization_remark_pattern)
1187 << RegexError << A->getAsString(Args);
1188 return false;
1191 return true;
1194 for (Arg *A : Args) {
1195 if (A->getOption().matches(OPT_R_Joined)) {
1196 StringRef Value = A->getValue();
1198 if (Value == Name)
1199 Result.Kind = CodeGenOptions::RK_Enabled;
1200 else if (Value == "everything")
1201 Result.Kind = CodeGenOptions::RK_EnabledEverything;
1202 else if (Value.split('-') == std::make_pair(StringRef("no"), Name))
1203 Result.Kind = CodeGenOptions::RK_Disabled;
1204 else if (Value == "no-everything")
1205 Result.Kind = CodeGenOptions::RK_DisabledEverything;
1206 else
1207 continue;
1209 if (Result.Kind == CodeGenOptions::RK_Disabled ||
1210 Result.Kind == CodeGenOptions::RK_DisabledEverything) {
1211 Result.Pattern = "";
1212 Result.Regex = nullptr;
1213 } else {
1214 InitializeResultPattern(A, ".*");
1216 } else if (A->getOption().matches(OptEQ)) {
1217 Result.Kind = CodeGenOptions::RK_WithPattern;
1218 if (!InitializeResultPattern(A, A->getValue()))
1219 return CodeGenOptions::OptRemark();
1223 return Result;
1226 static bool parseDiagnosticLevelMask(StringRef FlagName,
1227 const std::vector<std::string> &Levels,
1228 DiagnosticsEngine &Diags,
1229 DiagnosticLevelMask &M) {
1230 bool Success = true;
1231 for (const auto &Level : Levels) {
1232 DiagnosticLevelMask const PM =
1233 llvm::StringSwitch<DiagnosticLevelMask>(Level)
1234 .Case("note", DiagnosticLevelMask::Note)
1235 .Case("remark", DiagnosticLevelMask::Remark)
1236 .Case("warning", DiagnosticLevelMask::Warning)
1237 .Case("error", DiagnosticLevelMask::Error)
1238 .Default(DiagnosticLevelMask::None);
1239 if (PM == DiagnosticLevelMask::None) {
1240 Success = false;
1241 Diags.Report(diag::err_drv_invalid_value) << FlagName << Level;
1243 M = M | PM;
1245 return Success;
1248 static void parseSanitizerKinds(StringRef FlagName,
1249 const std::vector<std::string> &Sanitizers,
1250 DiagnosticsEngine &Diags, SanitizerSet &S) {
1251 for (const auto &Sanitizer : Sanitizers) {
1252 SanitizerMask K = parseSanitizerValue(Sanitizer, /*AllowGroups=*/false);
1253 if (K == SanitizerMask())
1254 Diags.Report(diag::err_drv_invalid_value) << FlagName << Sanitizer;
1255 else
1256 S.set(K, true);
1260 static SmallVector<StringRef, 4> serializeSanitizerKinds(SanitizerSet S) {
1261 SmallVector<StringRef, 4> Values;
1262 serializeSanitizerSet(S, Values);
1263 return Values;
1266 static void parseXRayInstrumentationBundle(StringRef FlagName, StringRef Bundle,
1267 ArgList &Args, DiagnosticsEngine &D,
1268 XRayInstrSet &S) {
1269 llvm::SmallVector<StringRef, 2> BundleParts;
1270 llvm::SplitString(Bundle, BundleParts, ",");
1271 for (const auto &B : BundleParts) {
1272 auto Mask = parseXRayInstrValue(B);
1273 if (Mask == XRayInstrKind::None)
1274 if (B != "none")
1275 D.Report(diag::err_drv_invalid_value) << FlagName << Bundle;
1276 else
1277 S.Mask = Mask;
1278 else if (Mask == XRayInstrKind::All)
1279 S.Mask = Mask;
1280 else
1281 S.set(Mask, true);
1285 static std::string serializeXRayInstrumentationBundle(const XRayInstrSet &S) {
1286 llvm::SmallVector<StringRef, 2> BundleParts;
1287 serializeXRayInstrValue(S, BundleParts);
1288 std::string Buffer;
1289 llvm::raw_string_ostream OS(Buffer);
1290 llvm::interleave(BundleParts, OS, [&OS](StringRef Part) { OS << Part; }, ",");
1291 return Buffer;
1294 // Set the profile kind using fprofile-instrument-use-path.
1295 static void setPGOUseInstrumentor(CodeGenOptions &Opts,
1296 const Twine &ProfileName) {
1297 auto ReaderOrErr = llvm::IndexedInstrProfReader::create(ProfileName);
1298 // In error, return silently and let Clang PGOUse report the error message.
1299 if (auto E = ReaderOrErr.takeError()) {
1300 llvm::consumeError(std::move(E));
1301 Opts.setProfileUse(CodeGenOptions::ProfileClangInstr);
1302 return;
1304 std::unique_ptr<llvm::IndexedInstrProfReader> PGOReader =
1305 std::move(ReaderOrErr.get());
1306 if (PGOReader->isIRLevelProfile()) {
1307 if (PGOReader->hasCSIRLevelProfile())
1308 Opts.setProfileUse(CodeGenOptions::ProfileCSIRInstr);
1309 else
1310 Opts.setProfileUse(CodeGenOptions::ProfileIRInstr);
1311 } else
1312 Opts.setProfileUse(CodeGenOptions::ProfileClangInstr);
1315 void CompilerInvocation::GenerateCodeGenArgs(
1316 const CodeGenOptions &Opts, SmallVectorImpl<const char *> &Args,
1317 StringAllocator SA, const llvm::Triple &T, const std::string &OutputFile,
1318 const LangOptions *LangOpts) {
1319 const CodeGenOptions &CodeGenOpts = Opts;
1321 if (Opts.OptimizationLevel == 0)
1322 GenerateArg(Args, OPT_O0, SA);
1323 else
1324 GenerateArg(Args, OPT_O, Twine(Opts.OptimizationLevel), SA);
1326 #define CODEGEN_OPTION_WITH_MARSHALLING( \
1327 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
1328 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
1329 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
1330 MERGER, EXTRACTOR, TABLE_INDEX) \
1331 GENERATE_OPTION_WITH_MARSHALLING( \
1332 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
1333 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
1334 #include "clang/Driver/Options.inc"
1335 #undef CODEGEN_OPTION_WITH_MARSHALLING
1337 if (Opts.OptimizationLevel > 0) {
1338 if (Opts.Inlining == CodeGenOptions::NormalInlining)
1339 GenerateArg(Args, OPT_finline_functions, SA);
1340 else if (Opts.Inlining == CodeGenOptions::OnlyHintInlining)
1341 GenerateArg(Args, OPT_finline_hint_functions, SA);
1342 else if (Opts.Inlining == CodeGenOptions::OnlyAlwaysInlining)
1343 GenerateArg(Args, OPT_fno_inline, SA);
1346 if (Opts.DirectAccessExternalData && LangOpts->PICLevel != 0)
1347 GenerateArg(Args, OPT_fdirect_access_external_data, SA);
1348 else if (!Opts.DirectAccessExternalData && LangOpts->PICLevel == 0)
1349 GenerateArg(Args, OPT_fno_direct_access_external_data, SA);
1351 Optional<StringRef> DebugInfoVal;
1352 switch (Opts.DebugInfo) {
1353 case codegenoptions::DebugLineTablesOnly:
1354 DebugInfoVal = "line-tables-only";
1355 break;
1356 case codegenoptions::DebugDirectivesOnly:
1357 DebugInfoVal = "line-directives-only";
1358 break;
1359 case codegenoptions::DebugInfoConstructor:
1360 DebugInfoVal = "constructor";
1361 break;
1362 case codegenoptions::LimitedDebugInfo:
1363 DebugInfoVal = "limited";
1364 break;
1365 case codegenoptions::FullDebugInfo:
1366 DebugInfoVal = "standalone";
1367 break;
1368 case codegenoptions::UnusedTypeInfo:
1369 DebugInfoVal = "unused-types";
1370 break;
1371 case codegenoptions::NoDebugInfo: // default value
1372 DebugInfoVal = None;
1373 break;
1374 case codegenoptions::LocTrackingOnly: // implied value
1375 DebugInfoVal = None;
1376 break;
1378 if (DebugInfoVal)
1379 GenerateArg(Args, OPT_debug_info_kind_EQ, *DebugInfoVal, SA);
1381 for (const auto &Prefix : Opts.DebugPrefixMap)
1382 GenerateArg(Args, OPT_fdebug_prefix_map_EQ,
1383 Prefix.first + "=" + Prefix.second, SA);
1385 for (const auto &Prefix : Opts.CoveragePrefixMap)
1386 GenerateArg(Args, OPT_fcoverage_prefix_map_EQ,
1387 Prefix.first + "=" + Prefix.second, SA);
1389 if (Opts.NewStructPathTBAA)
1390 GenerateArg(Args, OPT_new_struct_path_tbaa, SA);
1392 if (Opts.OptimizeSize == 1)
1393 GenerateArg(Args, OPT_O, "s", SA);
1394 else if (Opts.OptimizeSize == 2)
1395 GenerateArg(Args, OPT_O, "z", SA);
1397 // SimplifyLibCalls is set only in the absence of -fno-builtin and
1398 // -ffreestanding. We'll consider that when generating them.
1400 // NoBuiltinFuncs are generated by LangOptions.
1402 if (Opts.UnrollLoops && Opts.OptimizationLevel <= 1)
1403 GenerateArg(Args, OPT_funroll_loops, SA);
1404 else if (!Opts.UnrollLoops && Opts.OptimizationLevel > 1)
1405 GenerateArg(Args, OPT_fno_unroll_loops, SA);
1407 if (!Opts.BinutilsVersion.empty())
1408 GenerateArg(Args, OPT_fbinutils_version_EQ, Opts.BinutilsVersion, SA);
1410 if (Opts.DebugNameTable ==
1411 static_cast<unsigned>(llvm::DICompileUnit::DebugNameTableKind::GNU))
1412 GenerateArg(Args, OPT_ggnu_pubnames, SA);
1413 else if (Opts.DebugNameTable ==
1414 static_cast<unsigned>(
1415 llvm::DICompileUnit::DebugNameTableKind::Default))
1416 GenerateArg(Args, OPT_gpubnames, SA);
1418 auto TNK = Opts.getDebugSimpleTemplateNames();
1419 if (TNK != codegenoptions::DebugTemplateNamesKind::Full) {
1420 if (TNK == codegenoptions::DebugTemplateNamesKind::Simple)
1421 GenerateArg(Args, OPT_gsimple_template_names_EQ, "simple", SA);
1422 else if (TNK == codegenoptions::DebugTemplateNamesKind::Mangled)
1423 GenerateArg(Args, OPT_gsimple_template_names_EQ, "mangled", SA);
1425 // ProfileInstrumentUsePath is marshalled automatically, no need to generate
1426 // it or PGOUseInstrumentor.
1428 if (Opts.TimePasses) {
1429 if (Opts.TimePassesPerRun)
1430 GenerateArg(Args, OPT_ftime_report_EQ, "per-pass-run", SA);
1431 else
1432 GenerateArg(Args, OPT_ftime_report, SA);
1435 if (Opts.PrepareForLTO && !Opts.PrepareForThinLTO)
1436 GenerateArg(Args, OPT_flto_EQ, "full", SA);
1438 if (Opts.PrepareForThinLTO)
1439 GenerateArg(Args, OPT_flto_EQ, "thin", SA);
1441 if (!Opts.ThinLTOIndexFile.empty())
1442 GenerateArg(Args, OPT_fthinlto_index_EQ, Opts.ThinLTOIndexFile, SA);
1444 if (Opts.SaveTempsFilePrefix == OutputFile)
1445 GenerateArg(Args, OPT_save_temps_EQ, "obj", SA);
1447 StringRef MemProfileBasename("memprof.profraw");
1448 if (!Opts.MemoryProfileOutput.empty()) {
1449 if (Opts.MemoryProfileOutput == MemProfileBasename) {
1450 GenerateArg(Args, OPT_fmemory_profile, SA);
1451 } else {
1452 size_t ArgLength =
1453 Opts.MemoryProfileOutput.size() - MemProfileBasename.size();
1454 GenerateArg(Args, OPT_fmemory_profile_EQ,
1455 Opts.MemoryProfileOutput.substr(0, ArgLength), SA);
1459 if (memcmp(Opts.CoverageVersion, "408*", 4) != 0)
1460 GenerateArg(Args, OPT_coverage_version_EQ,
1461 StringRef(Opts.CoverageVersion, 4), SA);
1463 // TODO: Check if we need to generate arguments stored in CmdArgs. (Namely
1464 // '-fembed_bitcode', which does not map to any CompilerInvocation field and
1465 // won't be generated.)
1467 if (Opts.XRayInstrumentationBundle.Mask != XRayInstrKind::All) {
1468 std::string InstrBundle =
1469 serializeXRayInstrumentationBundle(Opts.XRayInstrumentationBundle);
1470 if (!InstrBundle.empty())
1471 GenerateArg(Args, OPT_fxray_instrumentation_bundle, InstrBundle, SA);
1474 if (Opts.CFProtectionReturn && Opts.CFProtectionBranch)
1475 GenerateArg(Args, OPT_fcf_protection_EQ, "full", SA);
1476 else if (Opts.CFProtectionReturn)
1477 GenerateArg(Args, OPT_fcf_protection_EQ, "return", SA);
1478 else if (Opts.CFProtectionBranch)
1479 GenerateArg(Args, OPT_fcf_protection_EQ, "branch", SA);
1481 if (Opts.IBTSeal)
1482 GenerateArg(Args, OPT_mibt_seal, SA);
1484 if (Opts.FunctionReturnThunks)
1485 GenerateArg(Args, OPT_mfunction_return_EQ, "thunk-extern", SA);
1487 for (const auto &F : Opts.LinkBitcodeFiles) {
1488 bool Builtint = F.LinkFlags == llvm::Linker::Flags::LinkOnlyNeeded &&
1489 F.PropagateAttrs && F.Internalize;
1490 GenerateArg(Args,
1491 Builtint ? OPT_mlink_builtin_bitcode : OPT_mlink_bitcode_file,
1492 F.Filename, SA);
1495 // TODO: Consider removing marshalling annotations from f[no_]emulated_tls.
1496 // That would make it easy to generate the option only **once** if it was
1497 // explicitly set to non-default value.
1498 if (Opts.ExplicitEmulatedTLS) {
1499 GenerateArg(
1500 Args, Opts.EmulatedTLS ? OPT_femulated_tls : OPT_fno_emulated_tls, SA);
1503 if (Opts.FPDenormalMode != llvm::DenormalMode::getIEEE())
1504 GenerateArg(Args, OPT_fdenormal_fp_math_EQ, Opts.FPDenormalMode.str(), SA);
1506 if ((Opts.FPDenormalMode != Opts.FP32DenormalMode) ||
1507 (Opts.FP32DenormalMode != llvm::DenormalMode::getIEEE()))
1508 GenerateArg(Args, OPT_fdenormal_fp_math_f32_EQ, Opts.FP32DenormalMode.str(),
1509 SA);
1511 if (Opts.StructReturnConvention == CodeGenOptions::SRCK_OnStack) {
1512 OptSpecifier Opt =
1513 T.isPPC32() ? OPT_maix_struct_return : OPT_fpcc_struct_return;
1514 GenerateArg(Args, Opt, SA);
1515 } else if (Opts.StructReturnConvention == CodeGenOptions::SRCK_InRegs) {
1516 OptSpecifier Opt =
1517 T.isPPC32() ? OPT_msvr4_struct_return : OPT_freg_struct_return;
1518 GenerateArg(Args, Opt, SA);
1521 if (Opts.EnableAIXExtendedAltivecABI)
1522 GenerateArg(Args, OPT_mabi_EQ_vec_extabi, SA);
1524 if (!Opts.OptRecordPasses.empty())
1525 GenerateArg(Args, OPT_opt_record_passes, Opts.OptRecordPasses, SA);
1527 if (!Opts.OptRecordFormat.empty())
1528 GenerateArg(Args, OPT_opt_record_format, Opts.OptRecordFormat, SA);
1530 GenerateOptimizationRemark(Args, SA, OPT_Rpass_EQ, "pass",
1531 Opts.OptimizationRemark);
1533 GenerateOptimizationRemark(Args, SA, OPT_Rpass_missed_EQ, "pass-missed",
1534 Opts.OptimizationRemarkMissed);
1536 GenerateOptimizationRemark(Args, SA, OPT_Rpass_analysis_EQ, "pass-analysis",
1537 Opts.OptimizationRemarkAnalysis);
1539 GenerateArg(Args, OPT_fdiagnostics_hotness_threshold_EQ,
1540 Opts.DiagnosticsHotnessThreshold
1541 ? Twine(*Opts.DiagnosticsHotnessThreshold)
1542 : "auto",
1543 SA);
1545 GenerateArg(Args, OPT_fdiagnostics_misexpect_tolerance_EQ,
1546 Twine(*Opts.DiagnosticsMisExpectTolerance), SA);
1548 for (StringRef Sanitizer : serializeSanitizerKinds(Opts.SanitizeRecover))
1549 GenerateArg(Args, OPT_fsanitize_recover_EQ, Sanitizer, SA);
1551 for (StringRef Sanitizer : serializeSanitizerKinds(Opts.SanitizeTrap))
1552 GenerateArg(Args, OPT_fsanitize_trap_EQ, Sanitizer, SA);
1554 if (!Opts.EmitVersionIdentMetadata)
1555 GenerateArg(Args, OPT_Qn, SA);
1557 switch (Opts.FiniteLoops) {
1558 case CodeGenOptions::FiniteLoopsKind::Language:
1559 break;
1560 case CodeGenOptions::FiniteLoopsKind::Always:
1561 GenerateArg(Args, OPT_ffinite_loops, SA);
1562 break;
1563 case CodeGenOptions::FiniteLoopsKind::Never:
1564 GenerateArg(Args, OPT_fno_finite_loops, SA);
1565 break;
1569 bool CompilerInvocation::ParseCodeGenArgs(CodeGenOptions &Opts, ArgList &Args,
1570 InputKind IK,
1571 DiagnosticsEngine &Diags,
1572 const llvm::Triple &T,
1573 const std::string &OutputFile,
1574 const LangOptions &LangOptsRef) {
1575 unsigned NumErrorsBefore = Diags.getNumErrors();
1577 unsigned OptimizationLevel = getOptimizationLevel(Args, IK, Diags);
1578 // TODO: This could be done in Driver
1579 unsigned MaxOptLevel = 3;
1580 if (OptimizationLevel > MaxOptLevel) {
1581 // If the optimization level is not supported, fall back on the default
1582 // optimization
1583 Diags.Report(diag::warn_drv_optimization_value)
1584 << Args.getLastArg(OPT_O)->getAsString(Args) << "-O" << MaxOptLevel;
1585 OptimizationLevel = MaxOptLevel;
1587 Opts.OptimizationLevel = OptimizationLevel;
1589 // The key paths of codegen options defined in Options.td start with
1590 // "CodeGenOpts.". Let's provide the expected variable name and type.
1591 CodeGenOptions &CodeGenOpts = Opts;
1592 // Some codegen options depend on language options. Let's provide the expected
1593 // variable name and type.
1594 const LangOptions *LangOpts = &LangOptsRef;
1596 #define CODEGEN_OPTION_WITH_MARSHALLING( \
1597 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
1598 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
1599 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
1600 MERGER, EXTRACTOR, TABLE_INDEX) \
1601 PARSE_OPTION_WITH_MARSHALLING( \
1602 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
1603 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
1604 #include "clang/Driver/Options.inc"
1605 #undef CODEGEN_OPTION_WITH_MARSHALLING
1607 // At O0 we want to fully disable inlining outside of cases marked with
1608 // 'alwaysinline' that are required for correctness.
1609 if (Opts.OptimizationLevel == 0) {
1610 Opts.setInlining(CodeGenOptions::OnlyAlwaysInlining);
1611 } else if (const Arg *A = Args.getLastArg(options::OPT_finline_functions,
1612 options::OPT_finline_hint_functions,
1613 options::OPT_fno_inline_functions,
1614 options::OPT_fno_inline)) {
1615 // Explicit inlining flags can disable some or all inlining even at
1616 // optimization levels above zero.
1617 if (A->getOption().matches(options::OPT_finline_functions))
1618 Opts.setInlining(CodeGenOptions::NormalInlining);
1619 else if (A->getOption().matches(options::OPT_finline_hint_functions))
1620 Opts.setInlining(CodeGenOptions::OnlyHintInlining);
1621 else
1622 Opts.setInlining(CodeGenOptions::OnlyAlwaysInlining);
1623 } else {
1624 Opts.setInlining(CodeGenOptions::NormalInlining);
1627 // PIC defaults to -fno-direct-access-external-data while non-PIC defaults to
1628 // -fdirect-access-external-data.
1629 Opts.DirectAccessExternalData =
1630 Args.hasArg(OPT_fdirect_access_external_data) ||
1631 (!Args.hasArg(OPT_fno_direct_access_external_data) &&
1632 LangOpts->PICLevel == 0);
1634 if (Arg *A = Args.getLastArg(OPT_debug_info_kind_EQ)) {
1635 unsigned Val =
1636 llvm::StringSwitch<unsigned>(A->getValue())
1637 .Case("line-tables-only", codegenoptions::DebugLineTablesOnly)
1638 .Case("line-directives-only", codegenoptions::DebugDirectivesOnly)
1639 .Case("constructor", codegenoptions::DebugInfoConstructor)
1640 .Case("limited", codegenoptions::LimitedDebugInfo)
1641 .Case("standalone", codegenoptions::FullDebugInfo)
1642 .Case("unused-types", codegenoptions::UnusedTypeInfo)
1643 .Default(~0U);
1644 if (Val == ~0U)
1645 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
1646 << A->getValue();
1647 else
1648 Opts.setDebugInfo(static_cast<codegenoptions::DebugInfoKind>(Val));
1651 // If -fuse-ctor-homing is set and limited debug info is already on, then use
1652 // constructor homing, and vice versa for -fno-use-ctor-homing.
1653 if (const Arg *A =
1654 Args.getLastArg(OPT_fuse_ctor_homing, OPT_fno_use_ctor_homing)) {
1655 if (A->getOption().matches(OPT_fuse_ctor_homing) &&
1656 Opts.getDebugInfo() == codegenoptions::LimitedDebugInfo)
1657 Opts.setDebugInfo(codegenoptions::DebugInfoConstructor);
1658 if (A->getOption().matches(OPT_fno_use_ctor_homing) &&
1659 Opts.getDebugInfo() == codegenoptions::DebugInfoConstructor)
1660 Opts.setDebugInfo(codegenoptions::LimitedDebugInfo);
1663 for (const auto &Arg : Args.getAllArgValues(OPT_fdebug_prefix_map_EQ)) {
1664 auto Split = StringRef(Arg).split('=');
1665 Opts.DebugPrefixMap.insert(
1666 {std::string(Split.first), std::string(Split.second)});
1669 for (const auto &Arg : Args.getAllArgValues(OPT_fcoverage_prefix_map_EQ)) {
1670 auto Split = StringRef(Arg).split('=');
1671 Opts.CoveragePrefixMap.insert(
1672 {std::string(Split.first), std::string(Split.second)});
1675 const llvm::Triple::ArchType DebugEntryValueArchs[] = {
1676 llvm::Triple::x86, llvm::Triple::x86_64, llvm::Triple::aarch64,
1677 llvm::Triple::arm, llvm::Triple::armeb, llvm::Triple::mips,
1678 llvm::Triple::mipsel, llvm::Triple::mips64, llvm::Triple::mips64el};
1680 if (Opts.OptimizationLevel > 0 && Opts.hasReducedDebugInfo() &&
1681 llvm::is_contained(DebugEntryValueArchs, T.getArch()))
1682 Opts.EmitCallSiteInfo = true;
1684 if (!Opts.EnableDIPreservationVerify && Opts.DIBugsReportFilePath.size()) {
1685 Diags.Report(diag::warn_ignoring_verify_debuginfo_preserve_export)
1686 << Opts.DIBugsReportFilePath;
1687 Opts.DIBugsReportFilePath = "";
1690 Opts.NewStructPathTBAA = !Args.hasArg(OPT_no_struct_path_tbaa) &&
1691 Args.hasArg(OPT_new_struct_path_tbaa);
1692 Opts.OptimizeSize = getOptimizationLevelSize(Args);
1693 Opts.SimplifyLibCalls = !LangOpts->NoBuiltin;
1694 if (Opts.SimplifyLibCalls)
1695 Opts.NoBuiltinFuncs = LangOpts->NoBuiltinFuncs;
1696 Opts.UnrollLoops =
1697 Args.hasFlag(OPT_funroll_loops, OPT_fno_unroll_loops,
1698 (Opts.OptimizationLevel > 1));
1699 Opts.BinutilsVersion =
1700 std::string(Args.getLastArgValue(OPT_fbinutils_version_EQ));
1702 Opts.DebugNameTable = static_cast<unsigned>(
1703 Args.hasArg(OPT_ggnu_pubnames)
1704 ? llvm::DICompileUnit::DebugNameTableKind::GNU
1705 : Args.hasArg(OPT_gpubnames)
1706 ? llvm::DICompileUnit::DebugNameTableKind::Default
1707 : llvm::DICompileUnit::DebugNameTableKind::None);
1708 if (const Arg *A = Args.getLastArg(OPT_gsimple_template_names_EQ)) {
1709 StringRef Value = A->getValue();
1710 if (Value != "simple" && Value != "mangled")
1711 Diags.Report(diag::err_drv_unsupported_option_argument)
1712 << A->getOption().getName() << A->getValue();
1713 Opts.setDebugSimpleTemplateNames(
1714 StringRef(A->getValue()) == "simple"
1715 ? codegenoptions::DebugTemplateNamesKind::Simple
1716 : codegenoptions::DebugTemplateNamesKind::Mangled);
1719 if (!Opts.ProfileInstrumentUsePath.empty())
1720 setPGOUseInstrumentor(Opts, Opts.ProfileInstrumentUsePath);
1722 if (const Arg *A = Args.getLastArg(OPT_ftime_report, OPT_ftime_report_EQ)) {
1723 Opts.TimePasses = true;
1725 // -ftime-report= is only for new pass manager.
1726 if (A->getOption().getID() == OPT_ftime_report_EQ) {
1727 StringRef Val = A->getValue();
1728 if (Val == "per-pass")
1729 Opts.TimePassesPerRun = false;
1730 else if (Val == "per-pass-run")
1731 Opts.TimePassesPerRun = true;
1732 else
1733 Diags.Report(diag::err_drv_invalid_value)
1734 << A->getAsString(Args) << A->getValue();
1738 Opts.PrepareForLTO = false;
1739 Opts.PrepareForThinLTO = false;
1740 if (Arg *A = Args.getLastArg(OPT_flto_EQ)) {
1741 Opts.PrepareForLTO = true;
1742 StringRef S = A->getValue();
1743 if (S == "thin")
1744 Opts.PrepareForThinLTO = true;
1745 else if (S != "full")
1746 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args) << S;
1748 if (Arg *A = Args.getLastArg(OPT_fthinlto_index_EQ)) {
1749 if (IK.getLanguage() != Language::LLVM_IR)
1750 Diags.Report(diag::err_drv_argument_only_allowed_with)
1751 << A->getAsString(Args) << "-x ir";
1752 Opts.ThinLTOIndexFile =
1753 std::string(Args.getLastArgValue(OPT_fthinlto_index_EQ));
1755 if (Arg *A = Args.getLastArg(OPT_save_temps_EQ))
1756 Opts.SaveTempsFilePrefix =
1757 llvm::StringSwitch<std::string>(A->getValue())
1758 .Case("obj", OutputFile)
1759 .Default(llvm::sys::path::filename(OutputFile).str());
1761 // The memory profile runtime appends the pid to make this name more unique.
1762 const char *MemProfileBasename = "memprof.profraw";
1763 if (Args.hasArg(OPT_fmemory_profile_EQ)) {
1764 SmallString<128> Path(
1765 std::string(Args.getLastArgValue(OPT_fmemory_profile_EQ)));
1766 llvm::sys::path::append(Path, MemProfileBasename);
1767 Opts.MemoryProfileOutput = std::string(Path);
1768 } else if (Args.hasArg(OPT_fmemory_profile))
1769 Opts.MemoryProfileOutput = MemProfileBasename;
1771 memcpy(Opts.CoverageVersion, "408*", 4);
1772 if (Opts.EmitGcovArcs || Opts.EmitGcovNotes) {
1773 if (Args.hasArg(OPT_coverage_version_EQ)) {
1774 StringRef CoverageVersion = Args.getLastArgValue(OPT_coverage_version_EQ);
1775 if (CoverageVersion.size() != 4) {
1776 Diags.Report(diag::err_drv_invalid_value)
1777 << Args.getLastArg(OPT_coverage_version_EQ)->getAsString(Args)
1778 << CoverageVersion;
1779 } else {
1780 memcpy(Opts.CoverageVersion, CoverageVersion.data(), 4);
1784 // FIXME: For backend options that are not yet recorded as function
1785 // attributes in the IR, keep track of them so we can embed them in a
1786 // separate data section and use them when building the bitcode.
1787 for (const auto &A : Args) {
1788 // Do not encode output and input.
1789 if (A->getOption().getID() == options::OPT_o ||
1790 A->getOption().getID() == options::OPT_INPUT ||
1791 A->getOption().getID() == options::OPT_x ||
1792 A->getOption().getID() == options::OPT_fembed_bitcode ||
1793 A->getOption().matches(options::OPT_W_Group))
1794 continue;
1795 ArgStringList ASL;
1796 A->render(Args, ASL);
1797 for (const auto &arg : ASL) {
1798 StringRef ArgStr(arg);
1799 Opts.CmdArgs.insert(Opts.CmdArgs.end(), ArgStr.begin(), ArgStr.end());
1800 // using \00 to separate each commandline options.
1801 Opts.CmdArgs.push_back('\0');
1805 auto XRayInstrBundles =
1806 Args.getAllArgValues(OPT_fxray_instrumentation_bundle);
1807 if (XRayInstrBundles.empty())
1808 Opts.XRayInstrumentationBundle.Mask = XRayInstrKind::All;
1809 else
1810 for (const auto &A : XRayInstrBundles)
1811 parseXRayInstrumentationBundle("-fxray-instrumentation-bundle=", A, Args,
1812 Diags, Opts.XRayInstrumentationBundle);
1814 if (const Arg *A = Args.getLastArg(OPT_fcf_protection_EQ)) {
1815 StringRef Name = A->getValue();
1816 if (Name == "full") {
1817 Opts.CFProtectionReturn = 1;
1818 Opts.CFProtectionBranch = 1;
1819 } else if (Name == "return")
1820 Opts.CFProtectionReturn = 1;
1821 else if (Name == "branch")
1822 Opts.CFProtectionBranch = 1;
1823 else if (Name != "none")
1824 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args) << Name;
1827 if (const Arg *A = Args.getLastArg(OPT_mfunction_return_EQ)) {
1828 auto Val = llvm::StringSwitch<llvm::FunctionReturnThunksKind>(A->getValue())
1829 .Case("keep", llvm::FunctionReturnThunksKind::Keep)
1830 .Case("thunk-extern", llvm::FunctionReturnThunksKind::Extern)
1831 .Default(llvm::FunctionReturnThunksKind::Invalid);
1832 // SystemZ might want to add support for "expolines."
1833 if (!T.isX86())
1834 Diags.Report(diag::err_drv_argument_not_allowed_with)
1835 << A->getSpelling() << T.getTriple();
1836 else if (Val == llvm::FunctionReturnThunksKind::Invalid)
1837 Diags.Report(diag::err_drv_invalid_value)
1838 << A->getAsString(Args) << A->getValue();
1839 else if (Val == llvm::FunctionReturnThunksKind::Extern &&
1840 Args.getLastArgValue(OPT_mcmodel_EQ).equals("large"))
1841 Diags.Report(diag::err_drv_argument_not_allowed_with)
1842 << A->getAsString(Args)
1843 << Args.getLastArg(OPT_mcmodel_EQ)->getAsString(Args);
1844 else
1845 Opts.FunctionReturnThunks = static_cast<unsigned>(Val);
1848 if (Opts.PrepareForLTO && Args.hasArg(OPT_mibt_seal))
1849 Opts.IBTSeal = 1;
1851 for (auto *A :
1852 Args.filtered(OPT_mlink_bitcode_file, OPT_mlink_builtin_bitcode)) {
1853 CodeGenOptions::BitcodeFileToLink F;
1854 F.Filename = A->getValue();
1855 if (A->getOption().matches(OPT_mlink_builtin_bitcode)) {
1856 F.LinkFlags = llvm::Linker::Flags::LinkOnlyNeeded;
1857 // When linking CUDA bitcode, propagate function attributes so that
1858 // e.g. libdevice gets fast-math attrs if we're building with fast-math.
1859 F.PropagateAttrs = true;
1860 F.Internalize = true;
1862 Opts.LinkBitcodeFiles.push_back(F);
1865 if (Args.getLastArg(OPT_femulated_tls) ||
1866 Args.getLastArg(OPT_fno_emulated_tls)) {
1867 Opts.ExplicitEmulatedTLS = true;
1870 if (Arg *A = Args.getLastArg(OPT_ftlsmodel_EQ)) {
1871 if (T.isOSAIX()) {
1872 StringRef Name = A->getValue();
1873 if (Name != "global-dynamic")
1874 Diags.Report(diag::err_aix_unsupported_tls_model) << Name;
1878 if (Arg *A = Args.getLastArg(OPT_fdenormal_fp_math_EQ)) {
1879 StringRef Val = A->getValue();
1880 Opts.FPDenormalMode = llvm::parseDenormalFPAttribute(Val);
1881 Opts.FP32DenormalMode = Opts.FPDenormalMode;
1882 if (!Opts.FPDenormalMode.isValid())
1883 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args) << Val;
1886 if (Arg *A = Args.getLastArg(OPT_fdenormal_fp_math_f32_EQ)) {
1887 StringRef Val = A->getValue();
1888 Opts.FP32DenormalMode = llvm::parseDenormalFPAttribute(Val);
1889 if (!Opts.FP32DenormalMode.isValid())
1890 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args) << Val;
1893 // X86_32 has -fppc-struct-return and -freg-struct-return.
1894 // PPC32 has -maix-struct-return and -msvr4-struct-return.
1895 if (Arg *A =
1896 Args.getLastArg(OPT_fpcc_struct_return, OPT_freg_struct_return,
1897 OPT_maix_struct_return, OPT_msvr4_struct_return)) {
1898 // TODO: We might want to consider enabling these options on AIX in the
1899 // future.
1900 if (T.isOSAIX())
1901 Diags.Report(diag::err_drv_unsupported_opt_for_target)
1902 << A->getSpelling() << T.str();
1904 const Option &O = A->getOption();
1905 if (O.matches(OPT_fpcc_struct_return) ||
1906 O.matches(OPT_maix_struct_return)) {
1907 Opts.setStructReturnConvention(CodeGenOptions::SRCK_OnStack);
1908 } else {
1909 assert(O.matches(OPT_freg_struct_return) ||
1910 O.matches(OPT_msvr4_struct_return));
1911 Opts.setStructReturnConvention(CodeGenOptions::SRCK_InRegs);
1915 if (Arg *A =
1916 Args.getLastArg(OPT_mabi_EQ_vec_default, OPT_mabi_EQ_vec_extabi)) {
1917 if (!T.isOSAIX())
1918 Diags.Report(diag::err_drv_unsupported_opt_for_target)
1919 << A->getSpelling() << T.str();
1921 const Option &O = A->getOption();
1922 Opts.EnableAIXExtendedAltivecABI = O.matches(OPT_mabi_EQ_vec_extabi);
1925 if (Arg *A = Args.getLastArg(OPT_mabi_EQ_quadword_atomics)) {
1926 if (!T.isOSAIX() || T.isPPC32())
1927 Diags.Report(diag::err_drv_unsupported_opt_for_target)
1928 << A->getSpelling() << T.str();
1931 bool NeedLocTracking = false;
1933 if (!Opts.OptRecordFile.empty())
1934 NeedLocTracking = true;
1936 if (Arg *A = Args.getLastArg(OPT_opt_record_passes)) {
1937 Opts.OptRecordPasses = A->getValue();
1938 NeedLocTracking = true;
1941 if (Arg *A = Args.getLastArg(OPT_opt_record_format)) {
1942 Opts.OptRecordFormat = A->getValue();
1943 NeedLocTracking = true;
1946 Opts.OptimizationRemark =
1947 ParseOptimizationRemark(Diags, Args, OPT_Rpass_EQ, "pass");
1949 Opts.OptimizationRemarkMissed =
1950 ParseOptimizationRemark(Diags, Args, OPT_Rpass_missed_EQ, "pass-missed");
1952 Opts.OptimizationRemarkAnalysis = ParseOptimizationRemark(
1953 Diags, Args, OPT_Rpass_analysis_EQ, "pass-analysis");
1955 NeedLocTracking |= Opts.OptimizationRemark.hasValidPattern() ||
1956 Opts.OptimizationRemarkMissed.hasValidPattern() ||
1957 Opts.OptimizationRemarkAnalysis.hasValidPattern();
1959 bool UsingSampleProfile = !Opts.SampleProfileFile.empty();
1960 bool UsingProfile = UsingSampleProfile ||
1961 (Opts.getProfileUse() != CodeGenOptions::ProfileNone);
1963 if (Opts.DiagnosticsWithHotness && !UsingProfile &&
1964 // An IR file will contain PGO as metadata
1965 IK.getLanguage() != Language::LLVM_IR)
1966 Diags.Report(diag::warn_drv_diagnostics_hotness_requires_pgo)
1967 << "-fdiagnostics-show-hotness";
1969 // Parse remarks hotness threshold. Valid value is either integer or 'auto'.
1970 if (auto *arg =
1971 Args.getLastArg(options::OPT_fdiagnostics_hotness_threshold_EQ)) {
1972 auto ResultOrErr =
1973 llvm::remarks::parseHotnessThresholdOption(arg->getValue());
1975 if (!ResultOrErr) {
1976 Diags.Report(diag::err_drv_invalid_diagnotics_hotness_threshold)
1977 << "-fdiagnostics-hotness-threshold=";
1978 } else {
1979 Opts.DiagnosticsHotnessThreshold = *ResultOrErr;
1980 if ((!Opts.DiagnosticsHotnessThreshold ||
1981 Opts.DiagnosticsHotnessThreshold.value() > 0) &&
1982 !UsingProfile)
1983 Diags.Report(diag::warn_drv_diagnostics_hotness_requires_pgo)
1984 << "-fdiagnostics-hotness-threshold=";
1988 if (auto *arg =
1989 Args.getLastArg(options::OPT_fdiagnostics_misexpect_tolerance_EQ)) {
1990 auto ResultOrErr = parseToleranceOption(arg->getValue());
1992 if (!ResultOrErr) {
1993 Diags.Report(diag::err_drv_invalid_diagnotics_misexpect_tolerance)
1994 << "-fdiagnostics-misexpect-tolerance=";
1995 } else {
1996 Opts.DiagnosticsMisExpectTolerance = *ResultOrErr;
1997 if ((!Opts.DiagnosticsMisExpectTolerance ||
1998 Opts.DiagnosticsMisExpectTolerance.value() > 0) &&
1999 !UsingProfile)
2000 Diags.Report(diag::warn_drv_diagnostics_misexpect_requires_pgo)
2001 << "-fdiagnostics-misexpect-tolerance=";
2005 // If the user requested to use a sample profile for PGO, then the
2006 // backend will need to track source location information so the profile
2007 // can be incorporated into the IR.
2008 if (UsingSampleProfile)
2009 NeedLocTracking = true;
2011 if (!Opts.StackUsageOutput.empty())
2012 NeedLocTracking = true;
2014 // If the user requested a flag that requires source locations available in
2015 // the backend, make sure that the backend tracks source location information.
2016 if (NeedLocTracking && Opts.getDebugInfo() == codegenoptions::NoDebugInfo)
2017 Opts.setDebugInfo(codegenoptions::LocTrackingOnly);
2019 // Parse -fsanitize-recover= arguments.
2020 // FIXME: Report unrecoverable sanitizers incorrectly specified here.
2021 parseSanitizerKinds("-fsanitize-recover=",
2022 Args.getAllArgValues(OPT_fsanitize_recover_EQ), Diags,
2023 Opts.SanitizeRecover);
2024 parseSanitizerKinds("-fsanitize-trap=",
2025 Args.getAllArgValues(OPT_fsanitize_trap_EQ), Diags,
2026 Opts.SanitizeTrap);
2028 Opts.EmitVersionIdentMetadata = Args.hasFlag(OPT_Qy, OPT_Qn, true);
2030 if (Args.hasArg(options::OPT_ffinite_loops))
2031 Opts.FiniteLoops = CodeGenOptions::FiniteLoopsKind::Always;
2032 else if (Args.hasArg(options::OPT_fno_finite_loops))
2033 Opts.FiniteLoops = CodeGenOptions::FiniteLoopsKind::Never;
2035 Opts.EmitIEEENaNCompliantInsts = Args.hasFlag(
2036 options::OPT_mamdgpu_ieee, options::OPT_mno_amdgpu_ieee, true);
2037 if (!Opts.EmitIEEENaNCompliantInsts && !LangOptsRef.NoHonorNaNs)
2038 Diags.Report(diag::err_drv_amdgpu_ieee_without_no_honor_nans);
2040 return Diags.getNumErrors() == NumErrorsBefore;
2043 static void
2044 GenerateDependencyOutputArgs(const DependencyOutputOptions &Opts,
2045 SmallVectorImpl<const char *> &Args,
2046 CompilerInvocation::StringAllocator SA) {
2047 const DependencyOutputOptions &DependencyOutputOpts = Opts;
2048 #define DEPENDENCY_OUTPUT_OPTION_WITH_MARSHALLING( \
2049 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2050 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2051 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2052 MERGER, EXTRACTOR, TABLE_INDEX) \
2053 GENERATE_OPTION_WITH_MARSHALLING( \
2054 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
2055 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
2056 #include "clang/Driver/Options.inc"
2057 #undef DEPENDENCY_OUTPUT_OPTION_WITH_MARSHALLING
2059 if (Opts.ShowIncludesDest != ShowIncludesDestination::None)
2060 GenerateArg(Args, OPT_show_includes, SA);
2062 for (const auto &Dep : Opts.ExtraDeps) {
2063 switch (Dep.second) {
2064 case EDK_SanitizeIgnorelist:
2065 // Sanitizer ignorelist arguments are generated from LanguageOptions.
2066 continue;
2067 case EDK_ModuleFile:
2068 // Module file arguments are generated from FrontendOptions and
2069 // HeaderSearchOptions.
2070 continue;
2071 case EDK_ProfileList:
2072 // Profile list arguments are generated from LanguageOptions via the
2073 // marshalling infrastructure.
2074 continue;
2075 case EDK_DepFileEntry:
2076 GenerateArg(Args, OPT_fdepfile_entry, Dep.first, SA);
2077 break;
2082 static bool ParseDependencyOutputArgs(DependencyOutputOptions &Opts,
2083 ArgList &Args, DiagnosticsEngine &Diags,
2084 frontend::ActionKind Action,
2085 bool ShowLineMarkers) {
2086 unsigned NumErrorsBefore = Diags.getNumErrors();
2088 DependencyOutputOptions &DependencyOutputOpts = Opts;
2089 #define DEPENDENCY_OUTPUT_OPTION_WITH_MARSHALLING( \
2090 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2091 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2092 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2093 MERGER, EXTRACTOR, TABLE_INDEX) \
2094 PARSE_OPTION_WITH_MARSHALLING( \
2095 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
2096 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
2097 #include "clang/Driver/Options.inc"
2098 #undef DEPENDENCY_OUTPUT_OPTION_WITH_MARSHALLING
2100 if (Args.hasArg(OPT_show_includes)) {
2101 // Writing both /showIncludes and preprocessor output to stdout
2102 // would produce interleaved output, so use stderr for /showIncludes.
2103 // This behaves the same as cl.exe, when /E, /EP or /P are passed.
2104 if (Action == frontend::PrintPreprocessedInput || !ShowLineMarkers)
2105 Opts.ShowIncludesDest = ShowIncludesDestination::Stderr;
2106 else
2107 Opts.ShowIncludesDest = ShowIncludesDestination::Stdout;
2108 } else {
2109 Opts.ShowIncludesDest = ShowIncludesDestination::None;
2112 // Add sanitizer ignorelists as extra dependencies.
2113 // They won't be discovered by the regular preprocessor, so
2114 // we let make / ninja to know about this implicit dependency.
2115 if (!Args.hasArg(OPT_fno_sanitize_ignorelist)) {
2116 for (const auto *A : Args.filtered(OPT_fsanitize_ignorelist_EQ)) {
2117 StringRef Val = A->getValue();
2118 if (!Val.contains('='))
2119 Opts.ExtraDeps.emplace_back(std::string(Val), EDK_SanitizeIgnorelist);
2121 if (Opts.IncludeSystemHeaders) {
2122 for (const auto *A : Args.filtered(OPT_fsanitize_system_ignorelist_EQ)) {
2123 StringRef Val = A->getValue();
2124 if (!Val.contains('='))
2125 Opts.ExtraDeps.emplace_back(std::string(Val), EDK_SanitizeIgnorelist);
2130 // -fprofile-list= dependencies.
2131 for (const auto &Filename : Args.getAllArgValues(OPT_fprofile_list_EQ))
2132 Opts.ExtraDeps.emplace_back(Filename, EDK_ProfileList);
2134 // Propagate the extra dependencies.
2135 for (const auto *A : Args.filtered(OPT_fdepfile_entry))
2136 Opts.ExtraDeps.emplace_back(A->getValue(), EDK_DepFileEntry);
2138 // Only the -fmodule-file=<file> form.
2139 for (const auto *A : Args.filtered(OPT_fmodule_file)) {
2140 StringRef Val = A->getValue();
2141 if (!Val.contains('='))
2142 Opts.ExtraDeps.emplace_back(std::string(Val), EDK_ModuleFile);
2145 return Diags.getNumErrors() == NumErrorsBefore;
2148 static bool parseShowColorsArgs(const ArgList &Args, bool DefaultColor) {
2149 // Color diagnostics default to auto ("on" if terminal supports) in the driver
2150 // but default to off in cc1, needing an explicit OPT_fdiagnostics_color.
2151 // Support both clang's -f[no-]color-diagnostics and gcc's
2152 // -f[no-]diagnostics-colors[=never|always|auto].
2153 enum {
2154 Colors_On,
2155 Colors_Off,
2156 Colors_Auto
2157 } ShowColors = DefaultColor ? Colors_Auto : Colors_Off;
2158 for (auto *A : Args) {
2159 const Option &O = A->getOption();
2160 if (O.matches(options::OPT_fcolor_diagnostics)) {
2161 ShowColors = Colors_On;
2162 } else if (O.matches(options::OPT_fno_color_diagnostics)) {
2163 ShowColors = Colors_Off;
2164 } else if (O.matches(options::OPT_fdiagnostics_color_EQ)) {
2165 StringRef Value(A->getValue());
2166 if (Value == "always")
2167 ShowColors = Colors_On;
2168 else if (Value == "never")
2169 ShowColors = Colors_Off;
2170 else if (Value == "auto")
2171 ShowColors = Colors_Auto;
2174 return ShowColors == Colors_On ||
2175 (ShowColors == Colors_Auto &&
2176 llvm::sys::Process::StandardErrHasColors());
2179 static bool checkVerifyPrefixes(const std::vector<std::string> &VerifyPrefixes,
2180 DiagnosticsEngine &Diags) {
2181 bool Success = true;
2182 for (const auto &Prefix : VerifyPrefixes) {
2183 // Every prefix must start with a letter and contain only alphanumeric
2184 // characters, hyphens, and underscores.
2185 auto BadChar = llvm::find_if(Prefix, [](char C) {
2186 return !isAlphanumeric(C) && C != '-' && C != '_';
2188 if (BadChar != Prefix.end() || !isLetter(Prefix[0])) {
2189 Success = false;
2190 Diags.Report(diag::err_drv_invalid_value) << "-verify=" << Prefix;
2191 Diags.Report(diag::note_drv_verify_prefix_spelling);
2194 return Success;
2197 static void GenerateFileSystemArgs(const FileSystemOptions &Opts,
2198 SmallVectorImpl<const char *> &Args,
2199 CompilerInvocation::StringAllocator SA) {
2200 const FileSystemOptions &FileSystemOpts = Opts;
2202 #define FILE_SYSTEM_OPTION_WITH_MARSHALLING( \
2203 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2204 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2205 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2206 MERGER, EXTRACTOR, TABLE_INDEX) \
2207 GENERATE_OPTION_WITH_MARSHALLING( \
2208 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
2209 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
2210 #include "clang/Driver/Options.inc"
2211 #undef FILE_SYSTEM_OPTION_WITH_MARSHALLING
2214 static bool ParseFileSystemArgs(FileSystemOptions &Opts, const ArgList &Args,
2215 DiagnosticsEngine &Diags) {
2216 unsigned NumErrorsBefore = Diags.getNumErrors();
2218 FileSystemOptions &FileSystemOpts = Opts;
2220 #define FILE_SYSTEM_OPTION_WITH_MARSHALLING( \
2221 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2222 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2223 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2224 MERGER, EXTRACTOR, TABLE_INDEX) \
2225 PARSE_OPTION_WITH_MARSHALLING( \
2226 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
2227 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
2228 #include "clang/Driver/Options.inc"
2229 #undef FILE_SYSTEM_OPTION_WITH_MARSHALLING
2231 return Diags.getNumErrors() == NumErrorsBefore;
2234 static void GenerateMigratorArgs(const MigratorOptions &Opts,
2235 SmallVectorImpl<const char *> &Args,
2236 CompilerInvocation::StringAllocator SA) {
2237 const MigratorOptions &MigratorOpts = Opts;
2238 #define MIGRATOR_OPTION_WITH_MARSHALLING( \
2239 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2240 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2241 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2242 MERGER, EXTRACTOR, TABLE_INDEX) \
2243 GENERATE_OPTION_WITH_MARSHALLING( \
2244 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
2245 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
2246 #include "clang/Driver/Options.inc"
2247 #undef MIGRATOR_OPTION_WITH_MARSHALLING
2250 static bool ParseMigratorArgs(MigratorOptions &Opts, const ArgList &Args,
2251 DiagnosticsEngine &Diags) {
2252 unsigned NumErrorsBefore = Diags.getNumErrors();
2254 MigratorOptions &MigratorOpts = Opts;
2256 #define MIGRATOR_OPTION_WITH_MARSHALLING( \
2257 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2258 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2259 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2260 MERGER, EXTRACTOR, TABLE_INDEX) \
2261 PARSE_OPTION_WITH_MARSHALLING( \
2262 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
2263 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
2264 #include "clang/Driver/Options.inc"
2265 #undef MIGRATOR_OPTION_WITH_MARSHALLING
2267 return Diags.getNumErrors() == NumErrorsBefore;
2270 void CompilerInvocation::GenerateDiagnosticArgs(
2271 const DiagnosticOptions &Opts, SmallVectorImpl<const char *> &Args,
2272 StringAllocator SA, bool DefaultDiagColor) {
2273 const DiagnosticOptions *DiagnosticOpts = &Opts;
2274 #define DIAG_OPTION_WITH_MARSHALLING( \
2275 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2276 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2277 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2278 MERGER, EXTRACTOR, TABLE_INDEX) \
2279 GENERATE_OPTION_WITH_MARSHALLING( \
2280 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
2281 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
2282 #include "clang/Driver/Options.inc"
2283 #undef DIAG_OPTION_WITH_MARSHALLING
2285 if (!Opts.DiagnosticSerializationFile.empty())
2286 GenerateArg(Args, OPT_diagnostic_serialized_file,
2287 Opts.DiagnosticSerializationFile, SA);
2289 if (Opts.ShowColors)
2290 GenerateArg(Args, OPT_fcolor_diagnostics, SA);
2292 if (Opts.VerifyDiagnostics &&
2293 llvm::is_contained(Opts.VerifyPrefixes, "expected"))
2294 GenerateArg(Args, OPT_verify, SA);
2296 for (const auto &Prefix : Opts.VerifyPrefixes)
2297 if (Prefix != "expected")
2298 GenerateArg(Args, OPT_verify_EQ, Prefix, SA);
2300 DiagnosticLevelMask VIU = Opts.getVerifyIgnoreUnexpected();
2301 if (VIU == DiagnosticLevelMask::None) {
2302 // This is the default, don't generate anything.
2303 } else if (VIU == DiagnosticLevelMask::All) {
2304 GenerateArg(Args, OPT_verify_ignore_unexpected, SA);
2305 } else {
2306 if (static_cast<unsigned>(VIU & DiagnosticLevelMask::Note) != 0)
2307 GenerateArg(Args, OPT_verify_ignore_unexpected_EQ, "note", SA);
2308 if (static_cast<unsigned>(VIU & DiagnosticLevelMask::Remark) != 0)
2309 GenerateArg(Args, OPT_verify_ignore_unexpected_EQ, "remark", SA);
2310 if (static_cast<unsigned>(VIU & DiagnosticLevelMask::Warning) != 0)
2311 GenerateArg(Args, OPT_verify_ignore_unexpected_EQ, "warning", SA);
2312 if (static_cast<unsigned>(VIU & DiagnosticLevelMask::Error) != 0)
2313 GenerateArg(Args, OPT_verify_ignore_unexpected_EQ, "error", SA);
2316 for (const auto &Warning : Opts.Warnings) {
2317 // This option is automatically generated from UndefPrefixes.
2318 if (Warning == "undef-prefix")
2319 continue;
2320 Args.push_back(SA(StringRef("-W") + Warning));
2323 for (const auto &Remark : Opts.Remarks) {
2324 // These arguments are generated from OptimizationRemark fields of
2325 // CodeGenOptions.
2326 StringRef IgnoredRemarks[] = {"pass", "no-pass",
2327 "pass-analysis", "no-pass-analysis",
2328 "pass-missed", "no-pass-missed"};
2329 if (llvm::is_contained(IgnoredRemarks, Remark))
2330 continue;
2332 Args.push_back(SA(StringRef("-R") + Remark));
2336 std::unique_ptr<DiagnosticOptions>
2337 clang::CreateAndPopulateDiagOpts(ArrayRef<const char *> Argv) {
2338 auto DiagOpts = std::make_unique<DiagnosticOptions>();
2339 unsigned MissingArgIndex, MissingArgCount;
2340 InputArgList Args = getDriverOptTable().ParseArgs(
2341 Argv.slice(1), MissingArgIndex, MissingArgCount);
2342 // We ignore MissingArgCount and the return value of ParseDiagnosticArgs.
2343 // Any errors that would be diagnosed here will also be diagnosed later,
2344 // when the DiagnosticsEngine actually exists.
2345 (void)ParseDiagnosticArgs(*DiagOpts, Args);
2346 return DiagOpts;
2349 bool clang::ParseDiagnosticArgs(DiagnosticOptions &Opts, ArgList &Args,
2350 DiagnosticsEngine *Diags,
2351 bool DefaultDiagColor) {
2352 Optional<DiagnosticsEngine> IgnoringDiags;
2353 if (!Diags) {
2354 IgnoringDiags.emplace(new DiagnosticIDs(), new DiagnosticOptions(),
2355 new IgnoringDiagConsumer());
2356 Diags = &*IgnoringDiags;
2359 unsigned NumErrorsBefore = Diags->getNumErrors();
2361 // The key paths of diagnostic options defined in Options.td start with
2362 // "DiagnosticOpts->". Let's provide the expected variable name and type.
2363 DiagnosticOptions *DiagnosticOpts = &Opts;
2365 #define DIAG_OPTION_WITH_MARSHALLING( \
2366 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2367 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2368 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2369 MERGER, EXTRACTOR, TABLE_INDEX) \
2370 PARSE_OPTION_WITH_MARSHALLING( \
2371 Args, *Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
2372 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
2373 #include "clang/Driver/Options.inc"
2374 #undef DIAG_OPTION_WITH_MARSHALLING
2376 llvm::sys::Process::UseANSIEscapeCodes(Opts.UseANSIEscapeCodes);
2378 if (Arg *A =
2379 Args.getLastArg(OPT_diagnostic_serialized_file, OPT__serialize_diags))
2380 Opts.DiagnosticSerializationFile = A->getValue();
2381 Opts.ShowColors = parseShowColorsArgs(Args, DefaultDiagColor);
2383 Opts.VerifyDiagnostics = Args.hasArg(OPT_verify) || Args.hasArg(OPT_verify_EQ);
2384 Opts.VerifyPrefixes = Args.getAllArgValues(OPT_verify_EQ);
2385 if (Args.hasArg(OPT_verify))
2386 Opts.VerifyPrefixes.push_back("expected");
2387 // Keep VerifyPrefixes in its original order for the sake of diagnostics, and
2388 // then sort it to prepare for fast lookup using std::binary_search.
2389 if (!checkVerifyPrefixes(Opts.VerifyPrefixes, *Diags))
2390 Opts.VerifyDiagnostics = false;
2391 else
2392 llvm::sort(Opts.VerifyPrefixes);
2393 DiagnosticLevelMask DiagMask = DiagnosticLevelMask::None;
2394 parseDiagnosticLevelMask(
2395 "-verify-ignore-unexpected=",
2396 Args.getAllArgValues(OPT_verify_ignore_unexpected_EQ), *Diags, DiagMask);
2397 if (Args.hasArg(OPT_verify_ignore_unexpected))
2398 DiagMask = DiagnosticLevelMask::All;
2399 Opts.setVerifyIgnoreUnexpected(DiagMask);
2400 if (Opts.TabStop == 0 || Opts.TabStop > DiagnosticOptions::MaxTabStop) {
2401 Opts.TabStop = DiagnosticOptions::DefaultTabStop;
2402 Diags->Report(diag::warn_ignoring_ftabstop_value)
2403 << Opts.TabStop << DiagnosticOptions::DefaultTabStop;
2406 addDiagnosticArgs(Args, OPT_W_Group, OPT_W_value_Group, Opts.Warnings);
2407 addDiagnosticArgs(Args, OPT_R_Group, OPT_R_value_Group, Opts.Remarks);
2409 return Diags->getNumErrors() == NumErrorsBefore;
2412 /// Parse the argument to the -ftest-module-file-extension
2413 /// command-line argument.
2415 /// \returns true on error, false on success.
2416 static bool parseTestModuleFileExtensionArg(StringRef Arg,
2417 std::string &BlockName,
2418 unsigned &MajorVersion,
2419 unsigned &MinorVersion,
2420 bool &Hashed,
2421 std::string &UserInfo) {
2422 SmallVector<StringRef, 5> Args;
2423 Arg.split(Args, ':', 5);
2424 if (Args.size() < 5)
2425 return true;
2427 BlockName = std::string(Args[0]);
2428 if (Args[1].getAsInteger(10, MajorVersion)) return true;
2429 if (Args[2].getAsInteger(10, MinorVersion)) return true;
2430 if (Args[3].getAsInteger(2, Hashed)) return true;
2431 if (Args.size() > 4)
2432 UserInfo = std::string(Args[4]);
2433 return false;
2436 /// Return a table that associates command line option specifiers with the
2437 /// frontend action. Note: The pair {frontend::PluginAction, OPT_plugin} is
2438 /// intentionally missing, as this case is handled separately from other
2439 /// frontend options.
2440 static const auto &getFrontendActionTable() {
2441 static const std::pair<frontend::ActionKind, unsigned> Table[] = {
2442 {frontend::ASTDeclList, OPT_ast_list},
2444 {frontend::ASTDump, OPT_ast_dump_all_EQ},
2445 {frontend::ASTDump, OPT_ast_dump_all},
2446 {frontend::ASTDump, OPT_ast_dump_EQ},
2447 {frontend::ASTDump, OPT_ast_dump},
2448 {frontend::ASTDump, OPT_ast_dump_lookups},
2449 {frontend::ASTDump, OPT_ast_dump_decl_types},
2451 {frontend::ASTPrint, OPT_ast_print},
2452 {frontend::ASTView, OPT_ast_view},
2453 {frontend::DumpCompilerOptions, OPT_compiler_options_dump},
2454 {frontend::DumpRawTokens, OPT_dump_raw_tokens},
2455 {frontend::DumpTokens, OPT_dump_tokens},
2456 {frontend::EmitAssembly, OPT_S},
2457 {frontend::EmitBC, OPT_emit_llvm_bc},
2458 {frontend::EmitHTML, OPT_emit_html},
2459 {frontend::EmitLLVM, OPT_emit_llvm},
2460 {frontend::EmitLLVMOnly, OPT_emit_llvm_only},
2461 {frontend::EmitCodeGenOnly, OPT_emit_codegen_only},
2462 {frontend::EmitObj, OPT_emit_obj},
2463 {frontend::ExtractAPI, OPT_extract_api},
2465 {frontend::FixIt, OPT_fixit_EQ},
2466 {frontend::FixIt, OPT_fixit},
2468 {frontend::GenerateModule, OPT_emit_module},
2469 {frontend::GenerateModuleInterface, OPT_emit_module_interface},
2470 {frontend::GenerateHeaderModule, OPT_emit_header_module},
2471 {frontend::GenerateHeaderUnit, OPT_emit_header_unit},
2472 {frontend::GeneratePCH, OPT_emit_pch},
2473 {frontend::GenerateInterfaceStubs, OPT_emit_interface_stubs},
2474 {frontend::InitOnly, OPT_init_only},
2475 {frontend::ParseSyntaxOnly, OPT_fsyntax_only},
2476 {frontend::ModuleFileInfo, OPT_module_file_info},
2477 {frontend::VerifyPCH, OPT_verify_pch},
2478 {frontend::PrintPreamble, OPT_print_preamble},
2479 {frontend::PrintPreprocessedInput, OPT_E},
2480 {frontend::TemplightDump, OPT_templight_dump},
2481 {frontend::RewriteMacros, OPT_rewrite_macros},
2482 {frontend::RewriteObjC, OPT_rewrite_objc},
2483 {frontend::RewriteTest, OPT_rewrite_test},
2484 {frontend::RunAnalysis, OPT_analyze},
2485 {frontend::MigrateSource, OPT_migrate},
2486 {frontend::RunPreprocessorOnly, OPT_Eonly},
2487 {frontend::PrintDependencyDirectivesSourceMinimizerOutput,
2488 OPT_print_dependency_directives_minimized_source},
2491 return Table;
2494 /// Maps command line option to frontend action.
2495 static Optional<frontend::ActionKind> getFrontendAction(OptSpecifier &Opt) {
2496 for (const auto &ActionOpt : getFrontendActionTable())
2497 if (ActionOpt.second == Opt.getID())
2498 return ActionOpt.first;
2500 return None;
2503 /// Maps frontend action to command line option.
2504 static Optional<OptSpecifier>
2505 getProgramActionOpt(frontend::ActionKind ProgramAction) {
2506 for (const auto &ActionOpt : getFrontendActionTable())
2507 if (ActionOpt.first == ProgramAction)
2508 return OptSpecifier(ActionOpt.second);
2510 return None;
2513 static void GenerateFrontendArgs(const FrontendOptions &Opts,
2514 SmallVectorImpl<const char *> &Args,
2515 CompilerInvocation::StringAllocator SA,
2516 bool IsHeader) {
2517 const FrontendOptions &FrontendOpts = Opts;
2518 #define FRONTEND_OPTION_WITH_MARSHALLING( \
2519 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2520 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2521 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2522 MERGER, EXTRACTOR, TABLE_INDEX) \
2523 GENERATE_OPTION_WITH_MARSHALLING( \
2524 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
2525 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
2526 #include "clang/Driver/Options.inc"
2527 #undef FRONTEND_OPTION_WITH_MARSHALLING
2529 Optional<OptSpecifier> ProgramActionOpt =
2530 getProgramActionOpt(Opts.ProgramAction);
2532 // Generating a simple flag covers most frontend actions.
2533 std::function<void()> GenerateProgramAction = [&]() {
2534 GenerateArg(Args, *ProgramActionOpt, SA);
2537 if (!ProgramActionOpt) {
2538 // PluginAction is the only program action handled separately.
2539 assert(Opts.ProgramAction == frontend::PluginAction &&
2540 "Frontend action without option.");
2541 GenerateProgramAction = [&]() {
2542 GenerateArg(Args, OPT_plugin, Opts.ActionName, SA);
2546 // FIXME: Simplify the complex 'AST dump' command line.
2547 if (Opts.ProgramAction == frontend::ASTDump) {
2548 GenerateProgramAction = [&]() {
2549 // ASTDumpLookups, ASTDumpDeclTypes and ASTDumpFilter are generated via
2550 // marshalling infrastructure.
2552 if (Opts.ASTDumpFormat != ADOF_Default) {
2553 StringRef Format;
2554 switch (Opts.ASTDumpFormat) {
2555 case ADOF_Default:
2556 llvm_unreachable("Default AST dump format.");
2557 case ADOF_JSON:
2558 Format = "json";
2559 break;
2562 if (Opts.ASTDumpAll)
2563 GenerateArg(Args, OPT_ast_dump_all_EQ, Format, SA);
2564 if (Opts.ASTDumpDecls)
2565 GenerateArg(Args, OPT_ast_dump_EQ, Format, SA);
2566 } else {
2567 if (Opts.ASTDumpAll)
2568 GenerateArg(Args, OPT_ast_dump_all, SA);
2569 if (Opts.ASTDumpDecls)
2570 GenerateArg(Args, OPT_ast_dump, SA);
2575 if (Opts.ProgramAction == frontend::FixIt && !Opts.FixItSuffix.empty()) {
2576 GenerateProgramAction = [&]() {
2577 GenerateArg(Args, OPT_fixit_EQ, Opts.FixItSuffix, SA);
2581 GenerateProgramAction();
2583 for (const auto &PluginArgs : Opts.PluginArgs) {
2584 Option Opt = getDriverOptTable().getOption(OPT_plugin_arg);
2585 const char *Spelling =
2586 SA(Opt.getPrefix() + Opt.getName() + PluginArgs.first);
2587 for (const auto &PluginArg : PluginArgs.second)
2588 denormalizeString(Args, Spelling, SA, Opt.getKind(), 0, PluginArg);
2591 for (const auto &Ext : Opts.ModuleFileExtensions)
2592 if (auto *TestExt = dyn_cast_or_null<TestModuleFileExtension>(Ext.get()))
2593 GenerateArg(Args, OPT_ftest_module_file_extension_EQ, TestExt->str(), SA);
2595 if (!Opts.CodeCompletionAt.FileName.empty())
2596 GenerateArg(Args, OPT_code_completion_at, Opts.CodeCompletionAt.ToString(),
2597 SA);
2599 for (const auto &Plugin : Opts.Plugins)
2600 GenerateArg(Args, OPT_load, Plugin, SA);
2602 // ASTDumpDecls and ASTDumpAll already handled with ProgramAction.
2604 for (const auto &ModuleFile : Opts.ModuleFiles)
2605 GenerateArg(Args, OPT_fmodule_file, ModuleFile, SA);
2607 if (Opts.AuxTargetCPU)
2608 GenerateArg(Args, OPT_aux_target_cpu, *Opts.AuxTargetCPU, SA);
2610 if (Opts.AuxTargetFeatures)
2611 for (const auto &Feature : *Opts.AuxTargetFeatures)
2612 GenerateArg(Args, OPT_aux_target_feature, Feature, SA);
2615 StringRef Preprocessed = Opts.DashX.isPreprocessed() ? "-cpp-output" : "";
2616 StringRef ModuleMap =
2617 Opts.DashX.getFormat() == InputKind::ModuleMap ? "-module-map" : "";
2618 StringRef HeaderUnit = "";
2619 switch (Opts.DashX.getHeaderUnitKind()) {
2620 case InputKind::HeaderUnit_None:
2621 break;
2622 case InputKind::HeaderUnit_User:
2623 HeaderUnit = "-user";
2624 break;
2625 case InputKind::HeaderUnit_System:
2626 HeaderUnit = "-system";
2627 break;
2628 case InputKind::HeaderUnit_Abs:
2629 HeaderUnit = "-header-unit";
2630 break;
2632 StringRef Header = IsHeader ? "-header" : "";
2634 StringRef Lang;
2635 switch (Opts.DashX.getLanguage()) {
2636 case Language::C:
2637 Lang = "c";
2638 break;
2639 case Language::OpenCL:
2640 Lang = "cl";
2641 break;
2642 case Language::OpenCLCXX:
2643 Lang = "clcpp";
2644 break;
2645 case Language::CUDA:
2646 Lang = "cuda";
2647 break;
2648 case Language::HIP:
2649 Lang = "hip";
2650 break;
2651 case Language::CXX:
2652 Lang = "c++";
2653 break;
2654 case Language::ObjC:
2655 Lang = "objective-c";
2656 break;
2657 case Language::ObjCXX:
2658 Lang = "objective-c++";
2659 break;
2660 case Language::RenderScript:
2661 Lang = "renderscript";
2662 break;
2663 case Language::Asm:
2664 Lang = "assembler-with-cpp";
2665 break;
2666 case Language::Unknown:
2667 assert(Opts.DashX.getFormat() == InputKind::Precompiled &&
2668 "Generating -x argument for unknown language (not precompiled).");
2669 Lang = "ast";
2670 break;
2671 case Language::LLVM_IR:
2672 Lang = "ir";
2673 break;
2674 case Language::HLSL:
2675 Lang = "hlsl";
2676 break;
2679 GenerateArg(Args, OPT_x,
2680 Lang + HeaderUnit + Header + ModuleMap + Preprocessed, SA);
2683 // OPT_INPUT has a unique class, generate it directly.
2684 for (const auto &Input : Opts.Inputs)
2685 Args.push_back(SA(Input.getFile()));
2688 static bool ParseFrontendArgs(FrontendOptions &Opts, ArgList &Args,
2689 DiagnosticsEngine &Diags, bool &IsHeaderFile) {
2690 unsigned NumErrorsBefore = Diags.getNumErrors();
2692 FrontendOptions &FrontendOpts = Opts;
2694 #define FRONTEND_OPTION_WITH_MARSHALLING( \
2695 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2696 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2697 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2698 MERGER, EXTRACTOR, TABLE_INDEX) \
2699 PARSE_OPTION_WITH_MARSHALLING( \
2700 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
2701 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
2702 #include "clang/Driver/Options.inc"
2703 #undef FRONTEND_OPTION_WITH_MARSHALLING
2705 Opts.ProgramAction = frontend::ParseSyntaxOnly;
2706 if (const Arg *A = Args.getLastArg(OPT_Action_Group)) {
2707 OptSpecifier Opt = OptSpecifier(A->getOption().getID());
2708 Optional<frontend::ActionKind> ProgramAction = getFrontendAction(Opt);
2709 assert(ProgramAction && "Option specifier not in Action_Group.");
2711 if (ProgramAction == frontend::ASTDump &&
2712 (Opt == OPT_ast_dump_all_EQ || Opt == OPT_ast_dump_EQ)) {
2713 unsigned Val = llvm::StringSwitch<unsigned>(A->getValue())
2714 .CaseLower("default", ADOF_Default)
2715 .CaseLower("json", ADOF_JSON)
2716 .Default(std::numeric_limits<unsigned>::max());
2718 if (Val != std::numeric_limits<unsigned>::max())
2719 Opts.ASTDumpFormat = static_cast<ASTDumpOutputFormat>(Val);
2720 else {
2721 Diags.Report(diag::err_drv_invalid_value)
2722 << A->getAsString(Args) << A->getValue();
2723 Opts.ASTDumpFormat = ADOF_Default;
2727 if (ProgramAction == frontend::FixIt && Opt == OPT_fixit_EQ)
2728 Opts.FixItSuffix = A->getValue();
2730 if (ProgramAction == frontend::GenerateInterfaceStubs) {
2731 StringRef ArgStr =
2732 Args.hasArg(OPT_interface_stub_version_EQ)
2733 ? Args.getLastArgValue(OPT_interface_stub_version_EQ)
2734 : "ifs-v1";
2735 if (ArgStr == "experimental-yaml-elf-v1" ||
2736 ArgStr == "experimental-ifs-v1" || ArgStr == "experimental-ifs-v2" ||
2737 ArgStr == "experimental-tapi-elf-v1") {
2738 std::string ErrorMessage =
2739 "Invalid interface stub format: " + ArgStr.str() +
2740 " is deprecated.";
2741 Diags.Report(diag::err_drv_invalid_value)
2742 << "Must specify a valid interface stub format type, ie: "
2743 "-interface-stub-version=ifs-v1"
2744 << ErrorMessage;
2745 ProgramAction = frontend::ParseSyntaxOnly;
2746 } else if (!ArgStr.startswith("ifs-")) {
2747 std::string ErrorMessage =
2748 "Invalid interface stub format: " + ArgStr.str() + ".";
2749 Diags.Report(diag::err_drv_invalid_value)
2750 << "Must specify a valid interface stub format type, ie: "
2751 "-interface-stub-version=ifs-v1"
2752 << ErrorMessage;
2753 ProgramAction = frontend::ParseSyntaxOnly;
2757 Opts.ProgramAction = *ProgramAction;
2760 if (const Arg* A = Args.getLastArg(OPT_plugin)) {
2761 Opts.Plugins.emplace_back(A->getValue(0));
2762 Opts.ProgramAction = frontend::PluginAction;
2763 Opts.ActionName = A->getValue();
2765 for (const auto *AA : Args.filtered(OPT_plugin_arg))
2766 Opts.PluginArgs[AA->getValue(0)].emplace_back(AA->getValue(1));
2768 for (const std::string &Arg :
2769 Args.getAllArgValues(OPT_ftest_module_file_extension_EQ)) {
2770 std::string BlockName;
2771 unsigned MajorVersion;
2772 unsigned MinorVersion;
2773 bool Hashed;
2774 std::string UserInfo;
2775 if (parseTestModuleFileExtensionArg(Arg, BlockName, MajorVersion,
2776 MinorVersion, Hashed, UserInfo)) {
2777 Diags.Report(diag::err_test_module_file_extension_format) << Arg;
2779 continue;
2782 // Add the testing module file extension.
2783 Opts.ModuleFileExtensions.push_back(
2784 std::make_shared<TestModuleFileExtension>(
2785 BlockName, MajorVersion, MinorVersion, Hashed, UserInfo));
2788 if (const Arg *A = Args.getLastArg(OPT_code_completion_at)) {
2789 Opts.CodeCompletionAt =
2790 ParsedSourceLocation::FromString(A->getValue());
2791 if (Opts.CodeCompletionAt.FileName.empty())
2792 Diags.Report(diag::err_drv_invalid_value)
2793 << A->getAsString(Args) << A->getValue();
2796 Opts.Plugins = Args.getAllArgValues(OPT_load);
2797 Opts.ASTDumpDecls = Args.hasArg(OPT_ast_dump, OPT_ast_dump_EQ);
2798 Opts.ASTDumpAll = Args.hasArg(OPT_ast_dump_all, OPT_ast_dump_all_EQ);
2799 // Only the -fmodule-file=<file> form.
2800 for (const auto *A : Args.filtered(OPT_fmodule_file)) {
2801 StringRef Val = A->getValue();
2802 if (!Val.contains('='))
2803 Opts.ModuleFiles.push_back(std::string(Val));
2806 if (Opts.ProgramAction != frontend::GenerateModule && Opts.IsSystemModule)
2807 Diags.Report(diag::err_drv_argument_only_allowed_with) << "-fsystem-module"
2808 << "-emit-module";
2810 if (Args.hasArg(OPT_aux_target_cpu))
2811 Opts.AuxTargetCPU = std::string(Args.getLastArgValue(OPT_aux_target_cpu));
2812 if (Args.hasArg(OPT_aux_target_feature))
2813 Opts.AuxTargetFeatures = Args.getAllArgValues(OPT_aux_target_feature);
2815 if (Opts.ARCMTAction != FrontendOptions::ARCMT_None &&
2816 Opts.ObjCMTAction != FrontendOptions::ObjCMT_None) {
2817 Diags.Report(diag::err_drv_argument_not_allowed_with)
2818 << "ARC migration" << "ObjC migration";
2821 InputKind DashX(Language::Unknown);
2822 if (const Arg *A = Args.getLastArg(OPT_x)) {
2823 StringRef XValue = A->getValue();
2825 // Parse suffixes:
2826 // '<lang>(-[{header-unit,user,system}-]header|[-module-map][-cpp-output])'.
2827 // FIXME: Supporting '<lang>-header-cpp-output' would be useful.
2828 bool Preprocessed = XValue.consume_back("-cpp-output");
2829 bool ModuleMap = XValue.consume_back("-module-map");
2830 // Detect and consume the header indicator.
2831 bool IsHeader =
2832 XValue != "precompiled-header" && XValue.consume_back("-header");
2834 // If we have c++-{user,system}-header, that indicates a header unit input
2835 // likewise, if the user put -fmodule-header together with a header with an
2836 // absolute path (header-unit-header).
2837 InputKind::HeaderUnitKind HUK = InputKind::HeaderUnit_None;
2838 if (IsHeader || Preprocessed) {
2839 if (XValue.consume_back("-header-unit"))
2840 HUK = InputKind::HeaderUnit_Abs;
2841 else if (XValue.consume_back("-system"))
2842 HUK = InputKind::HeaderUnit_System;
2843 else if (XValue.consume_back("-user"))
2844 HUK = InputKind::HeaderUnit_User;
2847 // The value set by this processing is an un-preprocessed source which is
2848 // not intended to be a module map or header unit.
2849 IsHeaderFile = IsHeader && !Preprocessed && !ModuleMap &&
2850 HUK == InputKind::HeaderUnit_None;
2852 // Principal languages.
2853 DashX = llvm::StringSwitch<InputKind>(XValue)
2854 .Case("c", Language::C)
2855 .Case("cl", Language::OpenCL)
2856 .Case("clcpp", Language::OpenCLCXX)
2857 .Case("cuda", Language::CUDA)
2858 .Case("hip", Language::HIP)
2859 .Case("c++", Language::CXX)
2860 .Case("objective-c", Language::ObjC)
2861 .Case("objective-c++", Language::ObjCXX)
2862 .Case("renderscript", Language::RenderScript)
2863 .Case("hlsl", Language::HLSL)
2864 .Default(Language::Unknown);
2866 // "objc[++]-cpp-output" is an acceptable synonym for
2867 // "objective-c[++]-cpp-output".
2868 if (DashX.isUnknown() && Preprocessed && !IsHeaderFile && !ModuleMap &&
2869 HUK == InputKind::HeaderUnit_None)
2870 DashX = llvm::StringSwitch<InputKind>(XValue)
2871 .Case("objc", Language::ObjC)
2872 .Case("objc++", Language::ObjCXX)
2873 .Default(Language::Unknown);
2875 // Some special cases cannot be combined with suffixes.
2876 if (DashX.isUnknown() && !Preprocessed && !IsHeaderFile && !ModuleMap &&
2877 HUK == InputKind::HeaderUnit_None)
2878 DashX = llvm::StringSwitch<InputKind>(XValue)
2879 .Case("cpp-output", InputKind(Language::C).getPreprocessed())
2880 .Case("assembler-with-cpp", Language::Asm)
2881 .Cases("ast", "pcm", "precompiled-header",
2882 InputKind(Language::Unknown, InputKind::Precompiled))
2883 .Case("ir", Language::LLVM_IR)
2884 .Default(Language::Unknown);
2886 if (DashX.isUnknown())
2887 Diags.Report(diag::err_drv_invalid_value)
2888 << A->getAsString(Args) << A->getValue();
2890 if (Preprocessed)
2891 DashX = DashX.getPreprocessed();
2892 // A regular header is considered mutually exclusive with a header unit.
2893 if (HUK != InputKind::HeaderUnit_None) {
2894 DashX = DashX.withHeaderUnit(HUK);
2895 IsHeaderFile = true;
2896 } else if (IsHeaderFile)
2897 DashX = DashX.getHeader();
2898 if (ModuleMap)
2899 DashX = DashX.withFormat(InputKind::ModuleMap);
2902 // '-' is the default input if none is given.
2903 std::vector<std::string> Inputs = Args.getAllArgValues(OPT_INPUT);
2904 Opts.Inputs.clear();
2905 if (Inputs.empty())
2906 Inputs.push_back("-");
2908 if (DashX.getHeaderUnitKind() != InputKind::HeaderUnit_None &&
2909 Inputs.size() > 1)
2910 Diags.Report(diag::err_drv_header_unit_extra_inputs) << Inputs[1];
2912 for (unsigned i = 0, e = Inputs.size(); i != e; ++i) {
2913 InputKind IK = DashX;
2914 if (IK.isUnknown()) {
2915 IK = FrontendOptions::getInputKindForExtension(
2916 StringRef(Inputs[i]).rsplit('.').second);
2917 // FIXME: Warn on this?
2918 if (IK.isUnknown())
2919 IK = Language::C;
2920 // FIXME: Remove this hack.
2921 if (i == 0)
2922 DashX = IK;
2925 bool IsSystem = false;
2927 // The -emit-module action implicitly takes a module map.
2928 if (Opts.ProgramAction == frontend::GenerateModule &&
2929 IK.getFormat() == InputKind::Source) {
2930 IK = IK.withFormat(InputKind::ModuleMap);
2931 IsSystem = Opts.IsSystemModule;
2934 Opts.Inputs.emplace_back(std::move(Inputs[i]), IK, IsSystem);
2937 Opts.DashX = DashX;
2939 return Diags.getNumErrors() == NumErrorsBefore;
2942 std::string CompilerInvocation::GetResourcesPath(const char *Argv0,
2943 void *MainAddr) {
2944 std::string ClangExecutable =
2945 llvm::sys::fs::getMainExecutable(Argv0, MainAddr);
2946 return Driver::GetResourcesPath(ClangExecutable, CLANG_RESOURCE_DIR);
2949 static void GenerateHeaderSearchArgs(HeaderSearchOptions &Opts,
2950 SmallVectorImpl<const char *> &Args,
2951 CompilerInvocation::StringAllocator SA) {
2952 const HeaderSearchOptions *HeaderSearchOpts = &Opts;
2953 #define HEADER_SEARCH_OPTION_WITH_MARSHALLING( \
2954 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
2955 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
2956 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
2957 MERGER, EXTRACTOR, TABLE_INDEX) \
2958 GENERATE_OPTION_WITH_MARSHALLING( \
2959 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
2960 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
2961 #include "clang/Driver/Options.inc"
2962 #undef HEADER_SEARCH_OPTION_WITH_MARSHALLING
2964 if (Opts.UseLibcxx)
2965 GenerateArg(Args, OPT_stdlib_EQ, "libc++", SA);
2967 if (!Opts.ModuleCachePath.empty())
2968 GenerateArg(Args, OPT_fmodules_cache_path, Opts.ModuleCachePath, SA);
2970 for (const auto &File : Opts.PrebuiltModuleFiles)
2971 GenerateArg(Args, OPT_fmodule_file, File.first + "=" + File.second, SA);
2973 for (const auto &Path : Opts.PrebuiltModulePaths)
2974 GenerateArg(Args, OPT_fprebuilt_module_path, Path, SA);
2976 for (const auto &Macro : Opts.ModulesIgnoreMacros)
2977 GenerateArg(Args, OPT_fmodules_ignore_macro, Macro.val(), SA);
2979 auto Matches = [](const HeaderSearchOptions::Entry &Entry,
2980 llvm::ArrayRef<frontend::IncludeDirGroup> Groups,
2981 llvm::Optional<bool> IsFramework,
2982 llvm::Optional<bool> IgnoreSysRoot) {
2983 return llvm::is_contained(Groups, Entry.Group) &&
2984 (!IsFramework || (Entry.IsFramework == *IsFramework)) &&
2985 (!IgnoreSysRoot || (Entry.IgnoreSysRoot == *IgnoreSysRoot));
2988 auto It = Opts.UserEntries.begin();
2989 auto End = Opts.UserEntries.end();
2991 // Add -I..., -F..., and -index-header-map options in order.
2992 for (; It < End &&
2993 Matches(*It, {frontend::IndexHeaderMap, frontend::Angled}, None, true);
2994 ++It) {
2995 OptSpecifier Opt = [It, Matches]() {
2996 if (Matches(*It, frontend::IndexHeaderMap, true, true))
2997 return OPT_F;
2998 if (Matches(*It, frontend::IndexHeaderMap, false, true))
2999 return OPT_I;
3000 if (Matches(*It, frontend::Angled, true, true))
3001 return OPT_F;
3002 if (Matches(*It, frontend::Angled, false, true))
3003 return OPT_I;
3004 llvm_unreachable("Unexpected HeaderSearchOptions::Entry.");
3005 }();
3007 if (It->Group == frontend::IndexHeaderMap)
3008 GenerateArg(Args, OPT_index_header_map, SA);
3009 GenerateArg(Args, Opt, It->Path, SA);
3012 // Note: some paths that came from "[-iprefix=xx] -iwithprefixbefore=yy" may
3013 // have already been generated as "-I[xx]yy". If that's the case, their
3014 // position on command line was such that this has no semantic impact on
3015 // include paths.
3016 for (; It < End &&
3017 Matches(*It, {frontend::After, frontend::Angled}, false, true);
3018 ++It) {
3019 OptSpecifier Opt =
3020 It->Group == frontend::After ? OPT_iwithprefix : OPT_iwithprefixbefore;
3021 GenerateArg(Args, Opt, It->Path, SA);
3024 // Note: Some paths that came from "-idirafter=xxyy" may have already been
3025 // generated as "-iwithprefix=xxyy". If that's the case, their position on
3026 // command line was such that this has no semantic impact on include paths.
3027 for (; It < End && Matches(*It, {frontend::After}, false, true); ++It)
3028 GenerateArg(Args, OPT_idirafter, It->Path, SA);
3029 for (; It < End && Matches(*It, {frontend::Quoted}, false, true); ++It)
3030 GenerateArg(Args, OPT_iquote, It->Path, SA);
3031 for (; It < End && Matches(*It, {frontend::System}, false, None); ++It)
3032 GenerateArg(Args, It->IgnoreSysRoot ? OPT_isystem : OPT_iwithsysroot,
3033 It->Path, SA);
3034 for (; It < End && Matches(*It, {frontend::System}, true, true); ++It)
3035 GenerateArg(Args, OPT_iframework, It->Path, SA);
3036 for (; It < End && Matches(*It, {frontend::System}, true, false); ++It)
3037 GenerateArg(Args, OPT_iframeworkwithsysroot, It->Path, SA);
3039 // Add the paths for the various language specific isystem flags.
3040 for (; It < End && Matches(*It, {frontend::CSystem}, false, true); ++It)
3041 GenerateArg(Args, OPT_c_isystem, It->Path, SA);
3042 for (; It < End && Matches(*It, {frontend::CXXSystem}, false, true); ++It)
3043 GenerateArg(Args, OPT_cxx_isystem, It->Path, SA);
3044 for (; It < End && Matches(*It, {frontend::ObjCSystem}, false, true); ++It)
3045 GenerateArg(Args, OPT_objc_isystem, It->Path, SA);
3046 for (; It < End && Matches(*It, {frontend::ObjCXXSystem}, false, true); ++It)
3047 GenerateArg(Args, OPT_objcxx_isystem, It->Path, SA);
3049 // Add the internal paths from a driver that detects standard include paths.
3050 // Note: Some paths that came from "-internal-isystem" arguments may have
3051 // already been generated as "-isystem". If that's the case, their position on
3052 // command line was such that this has no semantic impact on include paths.
3053 for (; It < End &&
3054 Matches(*It, {frontend::System, frontend::ExternCSystem}, false, true);
3055 ++It) {
3056 OptSpecifier Opt = It->Group == frontend::System
3057 ? OPT_internal_isystem
3058 : OPT_internal_externc_isystem;
3059 GenerateArg(Args, Opt, It->Path, SA);
3062 assert(It == End && "Unhandled HeaderSearchOption::Entry.");
3064 // Add the path prefixes which are implicitly treated as being system headers.
3065 for (const auto &P : Opts.SystemHeaderPrefixes) {
3066 OptSpecifier Opt = P.IsSystemHeader ? OPT_system_header_prefix
3067 : OPT_no_system_header_prefix;
3068 GenerateArg(Args, Opt, P.Prefix, SA);
3071 for (const std::string &F : Opts.VFSOverlayFiles)
3072 GenerateArg(Args, OPT_ivfsoverlay, F, SA);
3075 static bool ParseHeaderSearchArgs(HeaderSearchOptions &Opts, ArgList &Args,
3076 DiagnosticsEngine &Diags,
3077 const std::string &WorkingDir) {
3078 unsigned NumErrorsBefore = Diags.getNumErrors();
3080 HeaderSearchOptions *HeaderSearchOpts = &Opts;
3082 #define HEADER_SEARCH_OPTION_WITH_MARSHALLING( \
3083 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
3084 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
3085 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
3086 MERGER, EXTRACTOR, TABLE_INDEX) \
3087 PARSE_OPTION_WITH_MARSHALLING( \
3088 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
3089 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
3090 #include "clang/Driver/Options.inc"
3091 #undef HEADER_SEARCH_OPTION_WITH_MARSHALLING
3093 if (const Arg *A = Args.getLastArg(OPT_stdlib_EQ))
3094 Opts.UseLibcxx = (strcmp(A->getValue(), "libc++") == 0);
3096 // Canonicalize -fmodules-cache-path before storing it.
3097 SmallString<128> P(Args.getLastArgValue(OPT_fmodules_cache_path));
3098 if (!(P.empty() || llvm::sys::path::is_absolute(P))) {
3099 if (WorkingDir.empty())
3100 llvm::sys::fs::make_absolute(P);
3101 else
3102 llvm::sys::fs::make_absolute(WorkingDir, P);
3104 llvm::sys::path::remove_dots(P);
3105 Opts.ModuleCachePath = std::string(P.str());
3107 // Only the -fmodule-file=<name>=<file> form.
3108 for (const auto *A : Args.filtered(OPT_fmodule_file)) {
3109 StringRef Val = A->getValue();
3110 if (Val.contains('=')) {
3111 auto Split = Val.split('=');
3112 Opts.PrebuiltModuleFiles.insert(
3113 {std::string(Split.first), std::string(Split.second)});
3116 for (const auto *A : Args.filtered(OPT_fprebuilt_module_path))
3117 Opts.AddPrebuiltModulePath(A->getValue());
3119 for (const auto *A : Args.filtered(OPT_fmodules_ignore_macro)) {
3120 StringRef MacroDef = A->getValue();
3121 Opts.ModulesIgnoreMacros.insert(
3122 llvm::CachedHashString(MacroDef.split('=').first));
3125 // Add -I..., -F..., and -index-header-map options in order.
3126 bool IsIndexHeaderMap = false;
3127 bool IsSysrootSpecified =
3128 Args.hasArg(OPT__sysroot_EQ) || Args.hasArg(OPT_isysroot);
3129 for (const auto *A : Args.filtered(OPT_I, OPT_F, OPT_index_header_map)) {
3130 if (A->getOption().matches(OPT_index_header_map)) {
3131 // -index-header-map applies to the next -I or -F.
3132 IsIndexHeaderMap = true;
3133 continue;
3136 frontend::IncludeDirGroup Group =
3137 IsIndexHeaderMap ? frontend::IndexHeaderMap : frontend::Angled;
3139 bool IsFramework = A->getOption().matches(OPT_F);
3140 std::string Path = A->getValue();
3142 if (IsSysrootSpecified && !IsFramework && A->getValue()[0] == '=') {
3143 SmallString<32> Buffer;
3144 llvm::sys::path::append(Buffer, Opts.Sysroot,
3145 llvm::StringRef(A->getValue()).substr(1));
3146 Path = std::string(Buffer.str());
3149 Opts.AddPath(Path, Group, IsFramework,
3150 /*IgnoreSysroot*/ true);
3151 IsIndexHeaderMap = false;
3154 // Add -iprefix/-iwithprefix/-iwithprefixbefore options.
3155 StringRef Prefix = ""; // FIXME: This isn't the correct default prefix.
3156 for (const auto *A :
3157 Args.filtered(OPT_iprefix, OPT_iwithprefix, OPT_iwithprefixbefore)) {
3158 if (A->getOption().matches(OPT_iprefix))
3159 Prefix = A->getValue();
3160 else if (A->getOption().matches(OPT_iwithprefix))
3161 Opts.AddPath(Prefix.str() + A->getValue(), frontend::After, false, true);
3162 else
3163 Opts.AddPath(Prefix.str() + A->getValue(), frontend::Angled, false, true);
3166 for (const auto *A : Args.filtered(OPT_idirafter))
3167 Opts.AddPath(A->getValue(), frontend::After, false, true);
3168 for (const auto *A : Args.filtered(OPT_iquote))
3169 Opts.AddPath(A->getValue(), frontend::Quoted, false, true);
3170 for (const auto *A : Args.filtered(OPT_isystem, OPT_iwithsysroot))
3171 Opts.AddPath(A->getValue(), frontend::System, false,
3172 !A->getOption().matches(OPT_iwithsysroot));
3173 for (const auto *A : Args.filtered(OPT_iframework))
3174 Opts.AddPath(A->getValue(), frontend::System, true, true);
3175 for (const auto *A : Args.filtered(OPT_iframeworkwithsysroot))
3176 Opts.AddPath(A->getValue(), frontend::System, /*IsFramework=*/true,
3177 /*IgnoreSysRoot=*/false);
3179 // Add the paths for the various language specific isystem flags.
3180 for (const auto *A : Args.filtered(OPT_c_isystem))
3181 Opts.AddPath(A->getValue(), frontend::CSystem, false, true);
3182 for (const auto *A : Args.filtered(OPT_cxx_isystem))
3183 Opts.AddPath(A->getValue(), frontend::CXXSystem, false, true);
3184 for (const auto *A : Args.filtered(OPT_objc_isystem))
3185 Opts.AddPath(A->getValue(), frontend::ObjCSystem, false,true);
3186 for (const auto *A : Args.filtered(OPT_objcxx_isystem))
3187 Opts.AddPath(A->getValue(), frontend::ObjCXXSystem, false, true);
3189 // Add the internal paths from a driver that detects standard include paths.
3190 for (const auto *A :
3191 Args.filtered(OPT_internal_isystem, OPT_internal_externc_isystem)) {
3192 frontend::IncludeDirGroup Group = frontend::System;
3193 if (A->getOption().matches(OPT_internal_externc_isystem))
3194 Group = frontend::ExternCSystem;
3195 Opts.AddPath(A->getValue(), Group, false, true);
3198 // Add the path prefixes which are implicitly treated as being system headers.
3199 for (const auto *A :
3200 Args.filtered(OPT_system_header_prefix, OPT_no_system_header_prefix))
3201 Opts.AddSystemHeaderPrefix(
3202 A->getValue(), A->getOption().matches(OPT_system_header_prefix));
3204 for (const auto *A : Args.filtered(OPT_ivfsoverlay))
3205 Opts.AddVFSOverlayFile(A->getValue());
3207 return Diags.getNumErrors() == NumErrorsBefore;
3210 /// Check if input file kind and language standard are compatible.
3211 static bool IsInputCompatibleWithStandard(InputKind IK,
3212 const LangStandard &S) {
3213 switch (IK.getLanguage()) {
3214 case Language::Unknown:
3215 case Language::LLVM_IR:
3216 llvm_unreachable("should not parse language flags for this input");
3218 case Language::C:
3219 case Language::ObjC:
3220 case Language::RenderScript:
3221 return S.getLanguage() == Language::C;
3223 case Language::OpenCL:
3224 return S.getLanguage() == Language::OpenCL ||
3225 S.getLanguage() == Language::OpenCLCXX;
3227 case Language::OpenCLCXX:
3228 return S.getLanguage() == Language::OpenCLCXX;
3230 case Language::CXX:
3231 case Language::ObjCXX:
3232 return S.getLanguage() == Language::CXX;
3234 case Language::CUDA:
3235 // FIXME: What -std= values should be permitted for CUDA compilations?
3236 return S.getLanguage() == Language::CUDA ||
3237 S.getLanguage() == Language::CXX;
3239 case Language::HIP:
3240 return S.getLanguage() == Language::CXX || S.getLanguage() == Language::HIP;
3242 case Language::Asm:
3243 // Accept (and ignore) all -std= values.
3244 // FIXME: The -std= value is not ignored; it affects the tokenization
3245 // and preprocessing rules if we're preprocessing this asm input.
3246 return true;
3248 case Language::HLSL:
3249 return S.getLanguage() == Language::HLSL;
3252 llvm_unreachable("unexpected input language");
3255 /// Get language name for given input kind.
3256 static StringRef GetInputKindName(InputKind IK) {
3257 switch (IK.getLanguage()) {
3258 case Language::C:
3259 return "C";
3260 case Language::ObjC:
3261 return "Objective-C";
3262 case Language::CXX:
3263 return "C++";
3264 case Language::ObjCXX:
3265 return "Objective-C++";
3266 case Language::OpenCL:
3267 return "OpenCL";
3268 case Language::OpenCLCXX:
3269 return "C++ for OpenCL";
3270 case Language::CUDA:
3271 return "CUDA";
3272 case Language::RenderScript:
3273 return "RenderScript";
3274 case Language::HIP:
3275 return "HIP";
3277 case Language::Asm:
3278 return "Asm";
3279 case Language::LLVM_IR:
3280 return "LLVM IR";
3282 case Language::HLSL:
3283 return "HLSL";
3285 case Language::Unknown:
3286 break;
3288 llvm_unreachable("unknown input language");
3291 void CompilerInvocation::GenerateLangArgs(const LangOptions &Opts,
3292 SmallVectorImpl<const char *> &Args,
3293 StringAllocator SA,
3294 const llvm::Triple &T, InputKind IK) {
3295 if (IK.getFormat() == InputKind::Precompiled ||
3296 IK.getLanguage() == Language::LLVM_IR) {
3297 if (Opts.ObjCAutoRefCount)
3298 GenerateArg(Args, OPT_fobjc_arc, SA);
3299 if (Opts.PICLevel != 0)
3300 GenerateArg(Args, OPT_pic_level, Twine(Opts.PICLevel), SA);
3301 if (Opts.PIE)
3302 GenerateArg(Args, OPT_pic_is_pie, SA);
3303 for (StringRef Sanitizer : serializeSanitizerKinds(Opts.Sanitize))
3304 GenerateArg(Args, OPT_fsanitize_EQ, Sanitizer, SA);
3306 return;
3309 OptSpecifier StdOpt;
3310 switch (Opts.LangStd) {
3311 case LangStandard::lang_opencl10:
3312 case LangStandard::lang_opencl11:
3313 case LangStandard::lang_opencl12:
3314 case LangStandard::lang_opencl20:
3315 case LangStandard::lang_opencl30:
3316 case LangStandard::lang_openclcpp10:
3317 case LangStandard::lang_openclcpp2021:
3318 StdOpt = OPT_cl_std_EQ;
3319 break;
3320 default:
3321 StdOpt = OPT_std_EQ;
3322 break;
3325 auto LangStandard = LangStandard::getLangStandardForKind(Opts.LangStd);
3326 GenerateArg(Args, StdOpt, LangStandard.getName(), SA);
3328 if (Opts.IncludeDefaultHeader)
3329 GenerateArg(Args, OPT_finclude_default_header, SA);
3330 if (Opts.DeclareOpenCLBuiltins)
3331 GenerateArg(Args, OPT_fdeclare_opencl_builtins, SA);
3333 const LangOptions *LangOpts = &Opts;
3335 #define LANG_OPTION_WITH_MARSHALLING( \
3336 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
3337 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
3338 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
3339 MERGER, EXTRACTOR, TABLE_INDEX) \
3340 GENERATE_OPTION_WITH_MARSHALLING( \
3341 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
3342 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
3343 #include "clang/Driver/Options.inc"
3344 #undef LANG_OPTION_WITH_MARSHALLING
3346 // The '-fcf-protection=' option is generated by CodeGenOpts generator.
3348 if (Opts.ObjC) {
3349 GenerateArg(Args, OPT_fobjc_runtime_EQ, Opts.ObjCRuntime.getAsString(), SA);
3351 if (Opts.GC == LangOptions::GCOnly)
3352 GenerateArg(Args, OPT_fobjc_gc_only, SA);
3353 else if (Opts.GC == LangOptions::HybridGC)
3354 GenerateArg(Args, OPT_fobjc_gc, SA);
3355 else if (Opts.ObjCAutoRefCount == 1)
3356 GenerateArg(Args, OPT_fobjc_arc, SA);
3358 if (Opts.ObjCWeakRuntime)
3359 GenerateArg(Args, OPT_fobjc_runtime_has_weak, SA);
3361 if (Opts.ObjCWeak)
3362 GenerateArg(Args, OPT_fobjc_weak, SA);
3364 if (Opts.ObjCSubscriptingLegacyRuntime)
3365 GenerateArg(Args, OPT_fobjc_subscripting_legacy_runtime, SA);
3368 if (Opts.GNUCVersion != 0) {
3369 unsigned Major = Opts.GNUCVersion / 100 / 100;
3370 unsigned Minor = (Opts.GNUCVersion / 100) % 100;
3371 unsigned Patch = Opts.GNUCVersion % 100;
3372 GenerateArg(Args, OPT_fgnuc_version_EQ,
3373 Twine(Major) + "." + Twine(Minor) + "." + Twine(Patch), SA);
3376 if (Opts.IgnoreXCOFFVisibility)
3377 GenerateArg(Args, OPT_mignore_xcoff_visibility, SA);
3379 if (Opts.SignedOverflowBehavior == LangOptions::SOB_Trapping) {
3380 GenerateArg(Args, OPT_ftrapv, SA);
3381 GenerateArg(Args, OPT_ftrapv_handler, Opts.OverflowHandler, SA);
3382 } else if (Opts.SignedOverflowBehavior == LangOptions::SOB_Defined) {
3383 GenerateArg(Args, OPT_fwrapv, SA);
3386 if (Opts.MSCompatibilityVersion != 0) {
3387 unsigned Major = Opts.MSCompatibilityVersion / 10000000;
3388 unsigned Minor = (Opts.MSCompatibilityVersion / 100000) % 100;
3389 unsigned Subminor = Opts.MSCompatibilityVersion % 100000;
3390 GenerateArg(Args, OPT_fms_compatibility_version,
3391 Twine(Major) + "." + Twine(Minor) + "." + Twine(Subminor), SA);
3394 if ((!Opts.GNUMode && !Opts.MSVCCompat && !Opts.CPlusPlus17) || T.isOSzOS()) {
3395 if (!Opts.Trigraphs)
3396 GenerateArg(Args, OPT_fno_trigraphs, SA);
3397 } else {
3398 if (Opts.Trigraphs)
3399 GenerateArg(Args, OPT_ftrigraphs, SA);
3402 if (Opts.Blocks && !(Opts.OpenCL && Opts.OpenCLVersion == 200))
3403 GenerateArg(Args, OPT_fblocks, SA);
3405 if (Opts.ConvergentFunctions &&
3406 !(Opts.OpenCL || (Opts.CUDA && Opts.CUDAIsDevice) || Opts.SYCLIsDevice))
3407 GenerateArg(Args, OPT_fconvergent_functions, SA);
3409 if (Opts.NoBuiltin && !Opts.Freestanding)
3410 GenerateArg(Args, OPT_fno_builtin, SA);
3412 if (!Opts.NoBuiltin)
3413 for (const auto &Func : Opts.NoBuiltinFuncs)
3414 GenerateArg(Args, OPT_fno_builtin_, Func, SA);
3416 if (Opts.LongDoubleSize == 128)
3417 GenerateArg(Args, OPT_mlong_double_128, SA);
3418 else if (Opts.LongDoubleSize == 64)
3419 GenerateArg(Args, OPT_mlong_double_64, SA);
3420 else if (Opts.LongDoubleSize == 80)
3421 GenerateArg(Args, OPT_mlong_double_80, SA);
3423 // Not generating '-mrtd', it's just an alias for '-fdefault-calling-conv='.
3425 // OpenMP was requested via '-fopenmp', not implied by '-fopenmp-simd' or
3426 // '-fopenmp-targets='.
3427 if (Opts.OpenMP && !Opts.OpenMPSimd) {
3428 GenerateArg(Args, OPT_fopenmp, SA);
3430 if (Opts.OpenMP != 50)
3431 GenerateArg(Args, OPT_fopenmp_version_EQ, Twine(Opts.OpenMP), SA);
3433 if (!Opts.OpenMPUseTLS)
3434 GenerateArg(Args, OPT_fnoopenmp_use_tls, SA);
3436 if (Opts.OpenMPIsDevice)
3437 GenerateArg(Args, OPT_fopenmp_is_device, SA);
3439 if (Opts.OpenMPIRBuilder)
3440 GenerateArg(Args, OPT_fopenmp_enable_irbuilder, SA);
3443 if (Opts.OpenMPSimd) {
3444 GenerateArg(Args, OPT_fopenmp_simd, SA);
3446 if (Opts.OpenMP != 50)
3447 GenerateArg(Args, OPT_fopenmp_version_EQ, Twine(Opts.OpenMP), SA);
3450 if (Opts.OpenMPThreadSubscription)
3451 GenerateArg(Args, OPT_fopenmp_assume_threads_oversubscription, SA);
3453 if (Opts.OpenMPTeamSubscription)
3454 GenerateArg(Args, OPT_fopenmp_assume_teams_oversubscription, SA);
3456 if (Opts.OpenMPTargetDebug != 0)
3457 GenerateArg(Args, OPT_fopenmp_target_debug_EQ,
3458 Twine(Opts.OpenMPTargetDebug), SA);
3460 if (Opts.OpenMPCUDANumSMs != 0)
3461 GenerateArg(Args, OPT_fopenmp_cuda_number_of_sm_EQ,
3462 Twine(Opts.OpenMPCUDANumSMs), SA);
3464 if (Opts.OpenMPCUDABlocksPerSM != 0)
3465 GenerateArg(Args, OPT_fopenmp_cuda_blocks_per_sm_EQ,
3466 Twine(Opts.OpenMPCUDABlocksPerSM), SA);
3468 if (Opts.OpenMPCUDAReductionBufNum != 1024)
3469 GenerateArg(Args, OPT_fopenmp_cuda_teams_reduction_recs_num_EQ,
3470 Twine(Opts.OpenMPCUDAReductionBufNum), SA);
3472 if (!Opts.OMPTargetTriples.empty()) {
3473 std::string Targets;
3474 llvm::raw_string_ostream OS(Targets);
3475 llvm::interleave(
3476 Opts.OMPTargetTriples, OS,
3477 [&OS](const llvm::Triple &T) { OS << T.str(); }, ",");
3478 GenerateArg(Args, OPT_fopenmp_targets_EQ, OS.str(), SA);
3481 if (!Opts.OMPHostIRFile.empty())
3482 GenerateArg(Args, OPT_fopenmp_host_ir_file_path, Opts.OMPHostIRFile, SA);
3484 if (Opts.OpenMPCUDAMode)
3485 GenerateArg(Args, OPT_fopenmp_cuda_mode, SA);
3487 if (Opts.OpenMPCUDAForceFullRuntime)
3488 GenerateArg(Args, OPT_fopenmp_cuda_force_full_runtime, SA);
3490 // The arguments used to set Optimize, OptimizeSize and NoInlineDefine are
3491 // generated from CodeGenOptions.
3493 if (Opts.DefaultFPContractMode == LangOptions::FPM_Fast)
3494 GenerateArg(Args, OPT_ffp_contract, "fast", SA);
3495 else if (Opts.DefaultFPContractMode == LangOptions::FPM_On)
3496 GenerateArg(Args, OPT_ffp_contract, "on", SA);
3497 else if (Opts.DefaultFPContractMode == LangOptions::FPM_Off)
3498 GenerateArg(Args, OPT_ffp_contract, "off", SA);
3499 else if (Opts.DefaultFPContractMode == LangOptions::FPM_FastHonorPragmas)
3500 GenerateArg(Args, OPT_ffp_contract, "fast-honor-pragmas", SA);
3502 for (StringRef Sanitizer : serializeSanitizerKinds(Opts.Sanitize))
3503 GenerateArg(Args, OPT_fsanitize_EQ, Sanitizer, SA);
3505 // Conflating '-fsanitize-system-ignorelist' and '-fsanitize-ignorelist'.
3506 for (const std::string &F : Opts.NoSanitizeFiles)
3507 GenerateArg(Args, OPT_fsanitize_ignorelist_EQ, F, SA);
3509 if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver3_8)
3510 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "3.8", SA);
3511 else if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver4)
3512 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "4.0", SA);
3513 else if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver6)
3514 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "6.0", SA);
3515 else if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver7)
3516 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "7.0", SA);
3517 else if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver9)
3518 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "9.0", SA);
3519 else if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver11)
3520 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "11.0", SA);
3521 else if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver12)
3522 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "12.0", SA);
3523 else if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver14)
3524 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "14.0", SA);
3525 else if (Opts.getClangABICompat() == LangOptions::ClangABI::Ver15)
3526 GenerateArg(Args, OPT_fclang_abi_compat_EQ, "15.0", SA);
3528 if (Opts.getSignReturnAddressScope() ==
3529 LangOptions::SignReturnAddressScopeKind::All)
3530 GenerateArg(Args, OPT_msign_return_address_EQ, "all", SA);
3531 else if (Opts.getSignReturnAddressScope() ==
3532 LangOptions::SignReturnAddressScopeKind::NonLeaf)
3533 GenerateArg(Args, OPT_msign_return_address_EQ, "non-leaf", SA);
3535 if (Opts.getSignReturnAddressKey() ==
3536 LangOptions::SignReturnAddressKeyKind::BKey)
3537 GenerateArg(Args, OPT_msign_return_address_key_EQ, "b_key", SA);
3539 if (Opts.CXXABI)
3540 GenerateArg(Args, OPT_fcxx_abi_EQ, TargetCXXABI::getSpelling(*Opts.CXXABI),
3541 SA);
3543 if (Opts.RelativeCXXABIVTables)
3544 GenerateArg(Args, OPT_fexperimental_relative_cxx_abi_vtables, SA);
3545 else
3546 GenerateArg(Args, OPT_fno_experimental_relative_cxx_abi_vtables, SA);
3548 if (Opts.UseTargetPathSeparator)
3549 GenerateArg(Args, OPT_ffile_reproducible, SA);
3550 else
3551 GenerateArg(Args, OPT_fno_file_reproducible, SA);
3553 for (const auto &MP : Opts.MacroPrefixMap)
3554 GenerateArg(Args, OPT_fmacro_prefix_map_EQ, MP.first + "=" + MP.second, SA);
3556 if (!Opts.RandstructSeed.empty())
3557 GenerateArg(Args, OPT_frandomize_layout_seed_EQ, Opts.RandstructSeed, SA);
3560 bool CompilerInvocation::ParseLangArgs(LangOptions &Opts, ArgList &Args,
3561 InputKind IK, const llvm::Triple &T,
3562 std::vector<std::string> &Includes,
3563 DiagnosticsEngine &Diags) {
3564 unsigned NumErrorsBefore = Diags.getNumErrors();
3566 if (IK.getFormat() == InputKind::Precompiled ||
3567 IK.getLanguage() == Language::LLVM_IR) {
3568 // ObjCAAutoRefCount and Sanitize LangOpts are used to setup the
3569 // PassManager in BackendUtil.cpp. They need to be initialized no matter
3570 // what the input type is.
3571 if (Args.hasArg(OPT_fobjc_arc))
3572 Opts.ObjCAutoRefCount = 1;
3573 // PICLevel and PIELevel are needed during code generation and this should
3574 // be set regardless of the input type.
3575 Opts.PICLevel = getLastArgIntValue(Args, OPT_pic_level, 0, Diags);
3576 Opts.PIE = Args.hasArg(OPT_pic_is_pie);
3577 parseSanitizerKinds("-fsanitize=", Args.getAllArgValues(OPT_fsanitize_EQ),
3578 Diags, Opts.Sanitize);
3580 return Diags.getNumErrors() == NumErrorsBefore;
3583 // Other LangOpts are only initialized when the input is not AST or LLVM IR.
3584 // FIXME: Should we really be parsing this for an Language::Asm input?
3586 // FIXME: Cleanup per-file based stuff.
3587 LangStandard::Kind LangStd = LangStandard::lang_unspecified;
3588 if (const Arg *A = Args.getLastArg(OPT_std_EQ)) {
3589 LangStd = LangStandard::getLangKind(A->getValue());
3590 if (LangStd == LangStandard::lang_unspecified) {
3591 Diags.Report(diag::err_drv_invalid_value)
3592 << A->getAsString(Args) << A->getValue();
3593 // Report supported standards with short description.
3594 for (unsigned KindValue = 0;
3595 KindValue != LangStandard::lang_unspecified;
3596 ++KindValue) {
3597 const LangStandard &Std = LangStandard::getLangStandardForKind(
3598 static_cast<LangStandard::Kind>(KindValue));
3599 if (IsInputCompatibleWithStandard(IK, Std)) {
3600 auto Diag = Diags.Report(diag::note_drv_use_standard);
3601 Diag << Std.getName() << Std.getDescription();
3602 unsigned NumAliases = 0;
3603 #define LANGSTANDARD(id, name, lang, desc, features)
3604 #define LANGSTANDARD_ALIAS(id, alias) \
3605 if (KindValue == LangStandard::lang_##id) ++NumAliases;
3606 #define LANGSTANDARD_ALIAS_DEPR(id, alias)
3607 #include "clang/Basic/LangStandards.def"
3608 Diag << NumAliases;
3609 #define LANGSTANDARD(id, name, lang, desc, features)
3610 #define LANGSTANDARD_ALIAS(id, alias) \
3611 if (KindValue == LangStandard::lang_##id) Diag << alias;
3612 #define LANGSTANDARD_ALIAS_DEPR(id, alias)
3613 #include "clang/Basic/LangStandards.def"
3616 } else {
3617 // Valid standard, check to make sure language and standard are
3618 // compatible.
3619 const LangStandard &Std = LangStandard::getLangStandardForKind(LangStd);
3620 if (!IsInputCompatibleWithStandard(IK, Std)) {
3621 Diags.Report(diag::err_drv_argument_not_allowed_with)
3622 << A->getAsString(Args) << GetInputKindName(IK);
3627 // -cl-std only applies for OpenCL language standards.
3628 // Override the -std option in this case.
3629 if (const Arg *A = Args.getLastArg(OPT_cl_std_EQ)) {
3630 LangStandard::Kind OpenCLLangStd
3631 = llvm::StringSwitch<LangStandard::Kind>(A->getValue())
3632 .Cases("cl", "CL", LangStandard::lang_opencl10)
3633 .Cases("cl1.0", "CL1.0", LangStandard::lang_opencl10)
3634 .Cases("cl1.1", "CL1.1", LangStandard::lang_opencl11)
3635 .Cases("cl1.2", "CL1.2", LangStandard::lang_opencl12)
3636 .Cases("cl2.0", "CL2.0", LangStandard::lang_opencl20)
3637 .Cases("cl3.0", "CL3.0", LangStandard::lang_opencl30)
3638 .Cases("clc++", "CLC++", LangStandard::lang_openclcpp10)
3639 .Cases("clc++1.0", "CLC++1.0", LangStandard::lang_openclcpp10)
3640 .Cases("clc++2021", "CLC++2021", LangStandard::lang_openclcpp2021)
3641 .Default(LangStandard::lang_unspecified);
3643 if (OpenCLLangStd == LangStandard::lang_unspecified) {
3644 Diags.Report(diag::err_drv_invalid_value)
3645 << A->getAsString(Args) << A->getValue();
3647 else
3648 LangStd = OpenCLLangStd;
3651 // These need to be parsed now. They are used to set OpenCL defaults.
3652 Opts.IncludeDefaultHeader = Args.hasArg(OPT_finclude_default_header);
3653 Opts.DeclareOpenCLBuiltins = Args.hasArg(OPT_fdeclare_opencl_builtins);
3655 LangOptions::setLangDefaults(Opts, IK.getLanguage(), T, Includes, LangStd);
3657 // The key paths of codegen options defined in Options.td start with
3658 // "LangOpts->". Let's provide the expected variable name and type.
3659 LangOptions *LangOpts = &Opts;
3661 #define LANG_OPTION_WITH_MARSHALLING( \
3662 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
3663 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
3664 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
3665 MERGER, EXTRACTOR, TABLE_INDEX) \
3666 PARSE_OPTION_WITH_MARSHALLING( \
3667 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
3668 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
3669 #include "clang/Driver/Options.inc"
3670 #undef LANG_OPTION_WITH_MARSHALLING
3672 if (const Arg *A = Args.getLastArg(OPT_fcf_protection_EQ)) {
3673 StringRef Name = A->getValue();
3674 if (Name == "full" || Name == "branch") {
3675 Opts.CFProtectionBranch = 1;
3679 if ((Args.hasArg(OPT_fsycl_is_device) || Args.hasArg(OPT_fsycl_is_host)) &&
3680 !Args.hasArg(OPT_sycl_std_EQ)) {
3681 // If the user supplied -fsycl-is-device or -fsycl-is-host, but failed to
3682 // provide -sycl-std=, we want to default it to whatever the default SYCL
3683 // version is. I could not find a way to express this with the options
3684 // tablegen because we still want this value to be SYCL_None when the user
3685 // is not in device or host mode.
3686 Opts.setSYCLVersion(LangOptions::SYCL_Default);
3689 if (Opts.ObjC) {
3690 if (Arg *arg = Args.getLastArg(OPT_fobjc_runtime_EQ)) {
3691 StringRef value = arg->getValue();
3692 if (Opts.ObjCRuntime.tryParse(value))
3693 Diags.Report(diag::err_drv_unknown_objc_runtime) << value;
3696 if (Args.hasArg(OPT_fobjc_gc_only))
3697 Opts.setGC(LangOptions::GCOnly);
3698 else if (Args.hasArg(OPT_fobjc_gc))
3699 Opts.setGC(LangOptions::HybridGC);
3700 else if (Args.hasArg(OPT_fobjc_arc)) {
3701 Opts.ObjCAutoRefCount = 1;
3702 if (!Opts.ObjCRuntime.allowsARC())
3703 Diags.Report(diag::err_arc_unsupported_on_runtime);
3706 // ObjCWeakRuntime tracks whether the runtime supports __weak, not
3707 // whether the feature is actually enabled. This is predominantly
3708 // determined by -fobjc-runtime, but we allow it to be overridden
3709 // from the command line for testing purposes.
3710 if (Args.hasArg(OPT_fobjc_runtime_has_weak))
3711 Opts.ObjCWeakRuntime = 1;
3712 else
3713 Opts.ObjCWeakRuntime = Opts.ObjCRuntime.allowsWeak();
3715 // ObjCWeak determines whether __weak is actually enabled.
3716 // Note that we allow -fno-objc-weak to disable this even in ARC mode.
3717 if (auto weakArg = Args.getLastArg(OPT_fobjc_weak, OPT_fno_objc_weak)) {
3718 if (!weakArg->getOption().matches(OPT_fobjc_weak)) {
3719 assert(!Opts.ObjCWeak);
3720 } else if (Opts.getGC() != LangOptions::NonGC) {
3721 Diags.Report(diag::err_objc_weak_with_gc);
3722 } else if (!Opts.ObjCWeakRuntime) {
3723 Diags.Report(diag::err_objc_weak_unsupported);
3724 } else {
3725 Opts.ObjCWeak = 1;
3727 } else if (Opts.ObjCAutoRefCount) {
3728 Opts.ObjCWeak = Opts.ObjCWeakRuntime;
3731 if (Args.hasArg(OPT_fobjc_subscripting_legacy_runtime))
3732 Opts.ObjCSubscriptingLegacyRuntime =
3733 (Opts.ObjCRuntime.getKind() == ObjCRuntime::FragileMacOSX);
3736 if (Arg *A = Args.getLastArg(options::OPT_fgnuc_version_EQ)) {
3737 // Check that the version has 1 to 3 components and the minor and patch
3738 // versions fit in two decimal digits.
3739 VersionTuple GNUCVer;
3740 bool Invalid = GNUCVer.tryParse(A->getValue());
3741 unsigned Major = GNUCVer.getMajor();
3742 unsigned Minor = GNUCVer.getMinor().value_or(0);
3743 unsigned Patch = GNUCVer.getSubminor().value_or(0);
3744 if (Invalid || GNUCVer.getBuild() || Minor >= 100 || Patch >= 100) {
3745 Diags.Report(diag::err_drv_invalid_value)
3746 << A->getAsString(Args) << A->getValue();
3748 Opts.GNUCVersion = Major * 100 * 100 + Minor * 100 + Patch;
3751 if (T.isOSAIX() && (Args.hasArg(OPT_mignore_xcoff_visibility)))
3752 Opts.IgnoreXCOFFVisibility = 1;
3754 if (Args.hasArg(OPT_ftrapv)) {
3755 Opts.setSignedOverflowBehavior(LangOptions::SOB_Trapping);
3756 // Set the handler, if one is specified.
3757 Opts.OverflowHandler =
3758 std::string(Args.getLastArgValue(OPT_ftrapv_handler));
3760 else if (Args.hasArg(OPT_fwrapv))
3761 Opts.setSignedOverflowBehavior(LangOptions::SOB_Defined);
3763 Opts.MSCompatibilityVersion = 0;
3764 if (const Arg *A = Args.getLastArg(OPT_fms_compatibility_version)) {
3765 VersionTuple VT;
3766 if (VT.tryParse(A->getValue()))
3767 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args)
3768 << A->getValue();
3769 Opts.MSCompatibilityVersion = VT.getMajor() * 10000000 +
3770 VT.getMinor().value_or(0) * 100000 +
3771 VT.getSubminor().value_or(0);
3774 // Mimicking gcc's behavior, trigraphs are only enabled if -trigraphs
3775 // is specified, or -std is set to a conforming mode.
3776 // Trigraphs are disabled by default in c++1z onwards.
3777 // For z/OS, trigraphs are enabled by default (without regard to the above).
3778 Opts.Trigraphs =
3779 (!Opts.GNUMode && !Opts.MSVCCompat && !Opts.CPlusPlus17) || T.isOSzOS();
3780 Opts.Trigraphs =
3781 Args.hasFlag(OPT_ftrigraphs, OPT_fno_trigraphs, Opts.Trigraphs);
3783 Opts.Blocks = Args.hasArg(OPT_fblocks) || (Opts.OpenCL
3784 && Opts.OpenCLVersion == 200);
3786 Opts.ConvergentFunctions = Opts.OpenCL || (Opts.CUDA && Opts.CUDAIsDevice) ||
3787 Opts.SYCLIsDevice ||
3788 Args.hasArg(OPT_fconvergent_functions);
3790 Opts.NoBuiltin = Args.hasArg(OPT_fno_builtin) || Opts.Freestanding;
3791 if (!Opts.NoBuiltin)
3792 getAllNoBuiltinFuncValues(Args, Opts.NoBuiltinFuncs);
3793 if (Arg *A = Args.getLastArg(options::OPT_LongDouble_Group)) {
3794 if (A->getOption().matches(options::OPT_mlong_double_64))
3795 Opts.LongDoubleSize = 64;
3796 else if (A->getOption().matches(options::OPT_mlong_double_80))
3797 Opts.LongDoubleSize = 80;
3798 else if (A->getOption().matches(options::OPT_mlong_double_128))
3799 Opts.LongDoubleSize = 128;
3800 else
3801 Opts.LongDoubleSize = 0;
3803 if (Opts.FastRelaxedMath)
3804 Opts.setDefaultFPContractMode(LangOptions::FPM_Fast);
3806 llvm::sort(Opts.ModuleFeatures);
3808 // -mrtd option
3809 if (Arg *A = Args.getLastArg(OPT_mrtd)) {
3810 if (Opts.getDefaultCallingConv() != LangOptions::DCC_None)
3811 Diags.Report(diag::err_drv_argument_not_allowed_with)
3812 << A->getSpelling() << "-fdefault-calling-conv";
3813 else {
3814 if (T.getArch() != llvm::Triple::x86)
3815 Diags.Report(diag::err_drv_argument_not_allowed_with)
3816 << A->getSpelling() << T.getTriple();
3817 else
3818 Opts.setDefaultCallingConv(LangOptions::DCC_StdCall);
3822 // Check if -fopenmp is specified and set default version to 5.0.
3823 Opts.OpenMP = Args.hasArg(OPT_fopenmp) ? 50 : 0;
3824 // Check if -fopenmp-simd is specified.
3825 bool IsSimdSpecified =
3826 Args.hasFlag(options::OPT_fopenmp_simd, options::OPT_fno_openmp_simd,
3827 /*Default=*/false);
3828 Opts.OpenMPSimd = !Opts.OpenMP && IsSimdSpecified;
3829 Opts.OpenMPUseTLS =
3830 Opts.OpenMP && !Args.hasArg(options::OPT_fnoopenmp_use_tls);
3831 Opts.OpenMPIsDevice =
3832 Opts.OpenMP && Args.hasArg(options::OPT_fopenmp_is_device);
3833 Opts.OpenMPIRBuilder =
3834 Opts.OpenMP && Args.hasArg(options::OPT_fopenmp_enable_irbuilder);
3835 bool IsTargetSpecified =
3836 Opts.OpenMPIsDevice || Args.hasArg(options::OPT_fopenmp_targets_EQ);
3838 Opts.ConvergentFunctions = Opts.ConvergentFunctions || Opts.OpenMPIsDevice;
3840 if (Opts.OpenMP || Opts.OpenMPSimd) {
3841 if (int Version = getLastArgIntValue(
3842 Args, OPT_fopenmp_version_EQ,
3843 (IsSimdSpecified || IsTargetSpecified) ? 50 : Opts.OpenMP, Diags))
3844 Opts.OpenMP = Version;
3845 // Provide diagnostic when a given target is not expected to be an OpenMP
3846 // device or host.
3847 if (!Opts.OpenMPIsDevice) {
3848 switch (T.getArch()) {
3849 default:
3850 break;
3851 // Add unsupported host targets here:
3852 case llvm::Triple::nvptx:
3853 case llvm::Triple::nvptx64:
3854 Diags.Report(diag::err_drv_omp_host_target_not_supported) << T.str();
3855 break;
3860 // Set the flag to prevent the implementation from emitting device exception
3861 // handling code for those requiring so.
3862 if ((Opts.OpenMPIsDevice && (T.isNVPTX() || T.isAMDGCN())) ||
3863 Opts.OpenCLCPlusPlus) {
3865 Opts.Exceptions = 0;
3866 Opts.CXXExceptions = 0;
3868 if (Opts.OpenMPIsDevice && T.isNVPTX()) {
3869 Opts.OpenMPCUDANumSMs =
3870 getLastArgIntValue(Args, options::OPT_fopenmp_cuda_number_of_sm_EQ,
3871 Opts.OpenMPCUDANumSMs, Diags);
3872 Opts.OpenMPCUDABlocksPerSM =
3873 getLastArgIntValue(Args, options::OPT_fopenmp_cuda_blocks_per_sm_EQ,
3874 Opts.OpenMPCUDABlocksPerSM, Diags);
3875 Opts.OpenMPCUDAReductionBufNum = getLastArgIntValue(
3876 Args, options::OPT_fopenmp_cuda_teams_reduction_recs_num_EQ,
3877 Opts.OpenMPCUDAReductionBufNum, Diags);
3880 // Set the value of the debugging flag used in the new offloading device RTL.
3881 // Set either by a specific value or to a default if not specified.
3882 if (Opts.OpenMPIsDevice && (Args.hasArg(OPT_fopenmp_target_debug) ||
3883 Args.hasArg(OPT_fopenmp_target_debug_EQ))) {
3884 Opts.OpenMPTargetDebug = getLastArgIntValue(
3885 Args, OPT_fopenmp_target_debug_EQ, Opts.OpenMPTargetDebug, Diags);
3886 if (!Opts.OpenMPTargetDebug && Args.hasArg(OPT_fopenmp_target_debug))
3887 Opts.OpenMPTargetDebug = 1;
3890 if (Opts.OpenMPIsDevice) {
3891 if (Args.hasArg(OPT_fopenmp_assume_teams_oversubscription))
3892 Opts.OpenMPTeamSubscription = true;
3893 if (Args.hasArg(OPT_fopenmp_assume_threads_oversubscription))
3894 Opts.OpenMPThreadSubscription = true;
3897 // Get the OpenMP target triples if any.
3898 if (Arg *A = Args.getLastArg(options::OPT_fopenmp_targets_EQ)) {
3899 enum ArchPtrSize { Arch16Bit, Arch32Bit, Arch64Bit };
3900 auto getArchPtrSize = [](const llvm::Triple &T) {
3901 if (T.isArch16Bit())
3902 return Arch16Bit;
3903 if (T.isArch32Bit())
3904 return Arch32Bit;
3905 assert(T.isArch64Bit() && "Expected 64-bit architecture");
3906 return Arch64Bit;
3909 for (unsigned i = 0; i < A->getNumValues(); ++i) {
3910 llvm::Triple TT(A->getValue(i));
3912 if (TT.getArch() == llvm::Triple::UnknownArch ||
3913 !(TT.getArch() == llvm::Triple::aarch64 || TT.isPPC() ||
3914 TT.getArch() == llvm::Triple::nvptx ||
3915 TT.getArch() == llvm::Triple::nvptx64 ||
3916 TT.getArch() == llvm::Triple::amdgcn ||
3917 TT.getArch() == llvm::Triple::x86 ||
3918 TT.getArch() == llvm::Triple::x86_64))
3919 Diags.Report(diag::err_drv_invalid_omp_target) << A->getValue(i);
3920 else if (getArchPtrSize(T) != getArchPtrSize(TT))
3921 Diags.Report(diag::err_drv_incompatible_omp_arch)
3922 << A->getValue(i) << T.str();
3923 else
3924 Opts.OMPTargetTriples.push_back(TT);
3928 // Get OpenMP host file path if any and report if a non existent file is
3929 // found
3930 if (Arg *A = Args.getLastArg(options::OPT_fopenmp_host_ir_file_path)) {
3931 Opts.OMPHostIRFile = A->getValue();
3932 if (!llvm::sys::fs::exists(Opts.OMPHostIRFile))
3933 Diags.Report(diag::err_drv_omp_host_ir_file_not_found)
3934 << Opts.OMPHostIRFile;
3937 // Set CUDA mode for OpenMP target NVPTX/AMDGCN if specified in options
3938 Opts.OpenMPCUDAMode = Opts.OpenMPIsDevice && (T.isNVPTX() || T.isAMDGCN()) &&
3939 Args.hasArg(options::OPT_fopenmp_cuda_mode);
3941 // Set CUDA mode for OpenMP target NVPTX/AMDGCN if specified in options
3942 Opts.OpenMPCUDAForceFullRuntime =
3943 Opts.OpenMPIsDevice && (T.isNVPTX() || T.isAMDGCN()) &&
3944 Args.hasArg(options::OPT_fopenmp_cuda_force_full_runtime);
3946 // FIXME: Eliminate this dependency.
3947 unsigned Opt = getOptimizationLevel(Args, IK, Diags),
3948 OptSize = getOptimizationLevelSize(Args);
3949 Opts.Optimize = Opt != 0;
3950 Opts.OptimizeSize = OptSize != 0;
3952 // This is the __NO_INLINE__ define, which just depends on things like the
3953 // optimization level and -fno-inline, not actually whether the backend has
3954 // inlining enabled.
3955 Opts.NoInlineDefine = !Opts.Optimize;
3956 if (Arg *InlineArg = Args.getLastArg(
3957 options::OPT_finline_functions, options::OPT_finline_hint_functions,
3958 options::OPT_fno_inline_functions, options::OPT_fno_inline))
3959 if (InlineArg->getOption().matches(options::OPT_fno_inline))
3960 Opts.NoInlineDefine = true;
3962 if (Arg *A = Args.getLastArg(OPT_ffp_contract)) {
3963 StringRef Val = A->getValue();
3964 if (Val == "fast")
3965 Opts.setDefaultFPContractMode(LangOptions::FPM_Fast);
3966 else if (Val == "on")
3967 Opts.setDefaultFPContractMode(LangOptions::FPM_On);
3968 else if (Val == "off")
3969 Opts.setDefaultFPContractMode(LangOptions::FPM_Off);
3970 else if (Val == "fast-honor-pragmas")
3971 Opts.setDefaultFPContractMode(LangOptions::FPM_FastHonorPragmas);
3972 else
3973 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args) << Val;
3976 // Parse -fsanitize= arguments.
3977 parseSanitizerKinds("-fsanitize=", Args.getAllArgValues(OPT_fsanitize_EQ),
3978 Diags, Opts.Sanitize);
3979 Opts.NoSanitizeFiles = Args.getAllArgValues(OPT_fsanitize_ignorelist_EQ);
3980 std::vector<std::string> systemIgnorelists =
3981 Args.getAllArgValues(OPT_fsanitize_system_ignorelist_EQ);
3982 Opts.NoSanitizeFiles.insert(Opts.NoSanitizeFiles.end(),
3983 systemIgnorelists.begin(),
3984 systemIgnorelists.end());
3986 if (Arg *A = Args.getLastArg(OPT_fclang_abi_compat_EQ)) {
3987 Opts.setClangABICompat(LangOptions::ClangABI::Latest);
3989 StringRef Ver = A->getValue();
3990 std::pair<StringRef, StringRef> VerParts = Ver.split('.');
3991 unsigned Major, Minor = 0;
3993 // Check the version number is valid: either 3.x (0 <= x <= 9) or
3994 // y or y.0 (4 <= y <= current version).
3995 if (!VerParts.first.startswith("0") &&
3996 !VerParts.first.getAsInteger(10, Major) &&
3997 3 <= Major && Major <= CLANG_VERSION_MAJOR &&
3998 (Major == 3 ? VerParts.second.size() == 1 &&
3999 !VerParts.second.getAsInteger(10, Minor)
4000 : VerParts.first.size() == Ver.size() ||
4001 VerParts.second == "0")) {
4002 // Got a valid version number.
4003 if (Major == 3 && Minor <= 8)
4004 Opts.setClangABICompat(LangOptions::ClangABI::Ver3_8);
4005 else if (Major <= 4)
4006 Opts.setClangABICompat(LangOptions::ClangABI::Ver4);
4007 else if (Major <= 6)
4008 Opts.setClangABICompat(LangOptions::ClangABI::Ver6);
4009 else if (Major <= 7)
4010 Opts.setClangABICompat(LangOptions::ClangABI::Ver7);
4011 else if (Major <= 9)
4012 Opts.setClangABICompat(LangOptions::ClangABI::Ver9);
4013 else if (Major <= 11)
4014 Opts.setClangABICompat(LangOptions::ClangABI::Ver11);
4015 else if (Major <= 12)
4016 Opts.setClangABICompat(LangOptions::ClangABI::Ver12);
4017 else if (Major <= 14)
4018 Opts.setClangABICompat(LangOptions::ClangABI::Ver14);
4019 else if (Major <= 15)
4020 Opts.setClangABICompat(LangOptions::ClangABI::Ver15);
4021 } else if (Ver != "latest") {
4022 Diags.Report(diag::err_drv_invalid_value)
4023 << A->getAsString(Args) << A->getValue();
4027 if (Arg *A = Args.getLastArg(OPT_msign_return_address_EQ)) {
4028 StringRef SignScope = A->getValue();
4030 if (SignScope.equals_insensitive("none"))
4031 Opts.setSignReturnAddressScope(
4032 LangOptions::SignReturnAddressScopeKind::None);
4033 else if (SignScope.equals_insensitive("all"))
4034 Opts.setSignReturnAddressScope(
4035 LangOptions::SignReturnAddressScopeKind::All);
4036 else if (SignScope.equals_insensitive("non-leaf"))
4037 Opts.setSignReturnAddressScope(
4038 LangOptions::SignReturnAddressScopeKind::NonLeaf);
4039 else
4040 Diags.Report(diag::err_drv_invalid_value)
4041 << A->getAsString(Args) << SignScope;
4043 if (Arg *A = Args.getLastArg(OPT_msign_return_address_key_EQ)) {
4044 StringRef SignKey = A->getValue();
4045 if (!SignScope.empty() && !SignKey.empty()) {
4046 if (SignKey.equals_insensitive("a_key"))
4047 Opts.setSignReturnAddressKey(
4048 LangOptions::SignReturnAddressKeyKind::AKey);
4049 else if (SignKey.equals_insensitive("b_key"))
4050 Opts.setSignReturnAddressKey(
4051 LangOptions::SignReturnAddressKeyKind::BKey);
4052 else
4053 Diags.Report(diag::err_drv_invalid_value)
4054 << A->getAsString(Args) << SignKey;
4059 // The value can be empty, which indicates the system default should be used.
4060 StringRef CXXABI = Args.getLastArgValue(OPT_fcxx_abi_EQ);
4061 if (!CXXABI.empty()) {
4062 if (!TargetCXXABI::isABI(CXXABI)) {
4063 Diags.Report(diag::err_invalid_cxx_abi) << CXXABI;
4064 } else {
4065 auto Kind = TargetCXXABI::getKind(CXXABI);
4066 if (!TargetCXXABI::isSupportedCXXABI(T, Kind))
4067 Diags.Report(diag::err_unsupported_cxx_abi) << CXXABI << T.str();
4068 else
4069 Opts.CXXABI = Kind;
4073 Opts.RelativeCXXABIVTables =
4074 Args.hasFlag(options::OPT_fexperimental_relative_cxx_abi_vtables,
4075 options::OPT_fno_experimental_relative_cxx_abi_vtables,
4076 TargetCXXABI::usesRelativeVTables(T));
4078 for (const auto &A : Args.getAllArgValues(OPT_fmacro_prefix_map_EQ)) {
4079 auto Split = StringRef(A).split('=');
4080 Opts.MacroPrefixMap.insert(
4081 {std::string(Split.first), std::string(Split.second)});
4084 Opts.UseTargetPathSeparator =
4085 !Args.getLastArg(OPT_fno_file_reproducible) &&
4086 (Args.getLastArg(OPT_ffile_compilation_dir_EQ) ||
4087 Args.getLastArg(OPT_fmacro_prefix_map_EQ) ||
4088 Args.getLastArg(OPT_ffile_reproducible));
4090 // Error if -mvscale-min is unbounded.
4091 if (Arg *A = Args.getLastArg(options::OPT_mvscale_min_EQ)) {
4092 unsigned VScaleMin;
4093 if (StringRef(A->getValue()).getAsInteger(10, VScaleMin) || VScaleMin == 0)
4094 Diags.Report(diag::err_cc1_unbounded_vscale_min);
4097 if (const Arg *A = Args.getLastArg(OPT_frandomize_layout_seed_file_EQ)) {
4098 std::ifstream SeedFile(A->getValue(0));
4100 if (!SeedFile.is_open())
4101 Diags.Report(diag::err_drv_cannot_open_randomize_layout_seed_file)
4102 << A->getValue(0);
4104 std::getline(SeedFile, Opts.RandstructSeed);
4107 if (const Arg *A = Args.getLastArg(OPT_frandomize_layout_seed_EQ))
4108 Opts.RandstructSeed = A->getValue(0);
4110 return Diags.getNumErrors() == NumErrorsBefore;
4113 static bool isStrictlyPreprocessorAction(frontend::ActionKind Action) {
4114 switch (Action) {
4115 case frontend::ASTDeclList:
4116 case frontend::ASTDump:
4117 case frontend::ASTPrint:
4118 case frontend::ASTView:
4119 case frontend::EmitAssembly:
4120 case frontend::EmitBC:
4121 case frontend::EmitHTML:
4122 case frontend::EmitLLVM:
4123 case frontend::EmitLLVMOnly:
4124 case frontend::EmitCodeGenOnly:
4125 case frontend::EmitObj:
4126 case frontend::ExtractAPI:
4127 case frontend::FixIt:
4128 case frontend::GenerateModule:
4129 case frontend::GenerateModuleInterface:
4130 case frontend::GenerateHeaderModule:
4131 case frontend::GenerateHeaderUnit:
4132 case frontend::GeneratePCH:
4133 case frontend::GenerateInterfaceStubs:
4134 case frontend::ParseSyntaxOnly:
4135 case frontend::ModuleFileInfo:
4136 case frontend::VerifyPCH:
4137 case frontend::PluginAction:
4138 case frontend::RewriteObjC:
4139 case frontend::RewriteTest:
4140 case frontend::RunAnalysis:
4141 case frontend::TemplightDump:
4142 case frontend::MigrateSource:
4143 return false;
4145 case frontend::DumpCompilerOptions:
4146 case frontend::DumpRawTokens:
4147 case frontend::DumpTokens:
4148 case frontend::InitOnly:
4149 case frontend::PrintPreamble:
4150 case frontend::PrintPreprocessedInput:
4151 case frontend::RewriteMacros:
4152 case frontend::RunPreprocessorOnly:
4153 case frontend::PrintDependencyDirectivesSourceMinimizerOutput:
4154 return true;
4156 llvm_unreachable("invalid frontend action");
4159 static void GeneratePreprocessorArgs(PreprocessorOptions &Opts,
4160 SmallVectorImpl<const char *> &Args,
4161 CompilerInvocation::StringAllocator SA,
4162 const LangOptions &LangOpts,
4163 const FrontendOptions &FrontendOpts,
4164 const CodeGenOptions &CodeGenOpts) {
4165 PreprocessorOptions *PreprocessorOpts = &Opts;
4167 #define PREPROCESSOR_OPTION_WITH_MARSHALLING( \
4168 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
4169 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
4170 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
4171 MERGER, EXTRACTOR, TABLE_INDEX) \
4172 GENERATE_OPTION_WITH_MARSHALLING( \
4173 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
4174 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
4175 #include "clang/Driver/Options.inc"
4176 #undef PREPROCESSOR_OPTION_WITH_MARSHALLING
4178 if (Opts.PCHWithHdrStop && !Opts.PCHWithHdrStopCreate)
4179 GenerateArg(Args, OPT_pch_through_hdrstop_use, SA);
4181 for (const auto &D : Opts.DeserializedPCHDeclsToErrorOn)
4182 GenerateArg(Args, OPT_error_on_deserialized_pch_decl, D, SA);
4184 if (Opts.PrecompiledPreambleBytes != std::make_pair(0u, false))
4185 GenerateArg(Args, OPT_preamble_bytes_EQ,
4186 Twine(Opts.PrecompiledPreambleBytes.first) + "," +
4187 (Opts.PrecompiledPreambleBytes.second ? "1" : "0"),
4188 SA);
4190 for (const auto &M : Opts.Macros) {
4191 // Don't generate __CET__ macro definitions. They are implied by the
4192 // -fcf-protection option that is generated elsewhere.
4193 if (M.first == "__CET__=1" && !M.second &&
4194 !CodeGenOpts.CFProtectionReturn && CodeGenOpts.CFProtectionBranch)
4195 continue;
4196 if (M.first == "__CET__=2" && !M.second && CodeGenOpts.CFProtectionReturn &&
4197 !CodeGenOpts.CFProtectionBranch)
4198 continue;
4199 if (M.first == "__CET__=3" && !M.second && CodeGenOpts.CFProtectionReturn &&
4200 CodeGenOpts.CFProtectionBranch)
4201 continue;
4203 GenerateArg(Args, M.second ? OPT_U : OPT_D, M.first, SA);
4206 for (const auto &I : Opts.Includes) {
4207 // Don't generate OpenCL includes. They are implied by other flags that are
4208 // generated elsewhere.
4209 if (LangOpts.OpenCL && LangOpts.IncludeDefaultHeader &&
4210 ((LangOpts.DeclareOpenCLBuiltins && I == "opencl-c-base.h") ||
4211 I == "opencl-c.h"))
4212 continue;
4213 // Don't generate HLSL includes. They are implied by other flags that are
4214 // generated elsewhere.
4215 if (LangOpts.HLSL && I == "hlsl.h")
4216 continue;
4218 GenerateArg(Args, OPT_include, I, SA);
4221 for (const auto &CI : Opts.ChainedIncludes)
4222 GenerateArg(Args, OPT_chain_include, CI, SA);
4224 for (const auto &RF : Opts.RemappedFiles)
4225 GenerateArg(Args, OPT_remap_file, RF.first + ";" + RF.second, SA);
4227 // Don't handle LexEditorPlaceholders. It is implied by the action that is
4228 // generated elsewhere.
4231 static bool ParsePreprocessorArgs(PreprocessorOptions &Opts, ArgList &Args,
4232 DiagnosticsEngine &Diags,
4233 frontend::ActionKind Action,
4234 const FrontendOptions &FrontendOpts) {
4235 unsigned NumErrorsBefore = Diags.getNumErrors();
4237 PreprocessorOptions *PreprocessorOpts = &Opts;
4239 #define PREPROCESSOR_OPTION_WITH_MARSHALLING( \
4240 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
4241 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
4242 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
4243 MERGER, EXTRACTOR, TABLE_INDEX) \
4244 PARSE_OPTION_WITH_MARSHALLING( \
4245 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
4246 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
4247 #include "clang/Driver/Options.inc"
4248 #undef PREPROCESSOR_OPTION_WITH_MARSHALLING
4250 Opts.PCHWithHdrStop = Args.hasArg(OPT_pch_through_hdrstop_create) ||
4251 Args.hasArg(OPT_pch_through_hdrstop_use);
4253 for (const auto *A : Args.filtered(OPT_error_on_deserialized_pch_decl))
4254 Opts.DeserializedPCHDeclsToErrorOn.insert(A->getValue());
4256 if (const Arg *A = Args.getLastArg(OPT_preamble_bytes_EQ)) {
4257 StringRef Value(A->getValue());
4258 size_t Comma = Value.find(',');
4259 unsigned Bytes = 0;
4260 unsigned EndOfLine = 0;
4262 if (Comma == StringRef::npos ||
4263 Value.substr(0, Comma).getAsInteger(10, Bytes) ||
4264 Value.substr(Comma + 1).getAsInteger(10, EndOfLine))
4265 Diags.Report(diag::err_drv_preamble_format);
4266 else {
4267 Opts.PrecompiledPreambleBytes.first = Bytes;
4268 Opts.PrecompiledPreambleBytes.second = (EndOfLine != 0);
4272 // Add the __CET__ macro if a CFProtection option is set.
4273 if (const Arg *A = Args.getLastArg(OPT_fcf_protection_EQ)) {
4274 StringRef Name = A->getValue();
4275 if (Name == "branch")
4276 Opts.addMacroDef("__CET__=1");
4277 else if (Name == "return")
4278 Opts.addMacroDef("__CET__=2");
4279 else if (Name == "full")
4280 Opts.addMacroDef("__CET__=3");
4283 // Add macros from the command line.
4284 for (const auto *A : Args.filtered(OPT_D, OPT_U)) {
4285 if (A->getOption().matches(OPT_D))
4286 Opts.addMacroDef(A->getValue());
4287 else
4288 Opts.addMacroUndef(A->getValue());
4291 // Add the ordered list of -includes.
4292 for (const auto *A : Args.filtered(OPT_include))
4293 Opts.Includes.emplace_back(A->getValue());
4295 for (const auto *A : Args.filtered(OPT_chain_include))
4296 Opts.ChainedIncludes.emplace_back(A->getValue());
4298 for (const auto *A : Args.filtered(OPT_remap_file)) {
4299 std::pair<StringRef, StringRef> Split = StringRef(A->getValue()).split(';');
4301 if (Split.second.empty()) {
4302 Diags.Report(diag::err_drv_invalid_remap_file) << A->getAsString(Args);
4303 continue;
4306 Opts.addRemappedFile(Split.first, Split.second);
4309 // Always avoid lexing editor placeholders when we're just running the
4310 // preprocessor as we never want to emit the
4311 // "editor placeholder in source file" error in PP only mode.
4312 if (isStrictlyPreprocessorAction(Action))
4313 Opts.LexEditorPlaceholders = false;
4315 return Diags.getNumErrors() == NumErrorsBefore;
4318 static void GeneratePreprocessorOutputArgs(
4319 const PreprocessorOutputOptions &Opts, SmallVectorImpl<const char *> &Args,
4320 CompilerInvocation::StringAllocator SA, frontend::ActionKind Action) {
4321 const PreprocessorOutputOptions &PreprocessorOutputOpts = Opts;
4323 #define PREPROCESSOR_OUTPUT_OPTION_WITH_MARSHALLING( \
4324 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
4325 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
4326 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
4327 MERGER, EXTRACTOR, TABLE_INDEX) \
4328 GENERATE_OPTION_WITH_MARSHALLING( \
4329 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
4330 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
4331 #include "clang/Driver/Options.inc"
4332 #undef PREPROCESSOR_OUTPUT_OPTION_WITH_MARSHALLING
4334 bool Generate_dM = isStrictlyPreprocessorAction(Action) && !Opts.ShowCPP;
4335 if (Generate_dM)
4336 GenerateArg(Args, OPT_dM, SA);
4337 if (!Generate_dM && Opts.ShowMacros)
4338 GenerateArg(Args, OPT_dD, SA);
4339 if (Opts.DirectivesOnly)
4340 GenerateArg(Args, OPT_fdirectives_only, SA);
4343 static bool ParsePreprocessorOutputArgs(PreprocessorOutputOptions &Opts,
4344 ArgList &Args, DiagnosticsEngine &Diags,
4345 frontend::ActionKind Action) {
4346 unsigned NumErrorsBefore = Diags.getNumErrors();
4348 PreprocessorOutputOptions &PreprocessorOutputOpts = Opts;
4350 #define PREPROCESSOR_OUTPUT_OPTION_WITH_MARSHALLING( \
4351 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
4352 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
4353 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
4354 MERGER, EXTRACTOR, TABLE_INDEX) \
4355 PARSE_OPTION_WITH_MARSHALLING( \
4356 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
4357 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
4358 #include "clang/Driver/Options.inc"
4359 #undef PREPROCESSOR_OUTPUT_OPTION_WITH_MARSHALLING
4361 Opts.ShowCPP = isStrictlyPreprocessorAction(Action) && !Args.hasArg(OPT_dM);
4362 Opts.ShowMacros = Args.hasArg(OPT_dM) || Args.hasArg(OPT_dD);
4363 Opts.DirectivesOnly = Args.hasArg(OPT_fdirectives_only);
4365 return Diags.getNumErrors() == NumErrorsBefore;
4368 static void GenerateTargetArgs(const TargetOptions &Opts,
4369 SmallVectorImpl<const char *> &Args,
4370 CompilerInvocation::StringAllocator SA) {
4371 const TargetOptions *TargetOpts = &Opts;
4372 #define TARGET_OPTION_WITH_MARSHALLING( \
4373 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
4374 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
4375 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
4376 MERGER, EXTRACTOR, TABLE_INDEX) \
4377 GENERATE_OPTION_WITH_MARSHALLING( \
4378 Args, SA, KIND, FLAGS, SPELLING, ALWAYS_EMIT, KEYPATH, DEFAULT_VALUE, \
4379 IMPLIED_CHECK, IMPLIED_VALUE, DENORMALIZER, EXTRACTOR, TABLE_INDEX)
4380 #include "clang/Driver/Options.inc"
4381 #undef TARGET_OPTION_WITH_MARSHALLING
4383 if (!Opts.SDKVersion.empty())
4384 GenerateArg(Args, OPT_target_sdk_version_EQ, Opts.SDKVersion.getAsString(),
4385 SA);
4386 if (!Opts.DarwinTargetVariantSDKVersion.empty())
4387 GenerateArg(Args, OPT_darwin_target_variant_sdk_version_EQ,
4388 Opts.DarwinTargetVariantSDKVersion.getAsString(), SA);
4391 static bool ParseTargetArgs(TargetOptions &Opts, ArgList &Args,
4392 DiagnosticsEngine &Diags) {
4393 unsigned NumErrorsBefore = Diags.getNumErrors();
4395 TargetOptions *TargetOpts = &Opts;
4397 #define TARGET_OPTION_WITH_MARSHALLING( \
4398 PREFIX_TYPE, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
4399 HELPTEXT, METAVAR, VALUES, SPELLING, SHOULD_PARSE, ALWAYS_EMIT, KEYPATH, \
4400 DEFAULT_VALUE, IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, DENORMALIZER, \
4401 MERGER, EXTRACTOR, TABLE_INDEX) \
4402 PARSE_OPTION_WITH_MARSHALLING( \
4403 Args, Diags, ID, FLAGS, PARAM, SHOULD_PARSE, KEYPATH, DEFAULT_VALUE, \
4404 IMPLIED_CHECK, IMPLIED_VALUE, NORMALIZER, MERGER, TABLE_INDEX)
4405 #include "clang/Driver/Options.inc"
4406 #undef TARGET_OPTION_WITH_MARSHALLING
4408 if (Arg *A = Args.getLastArg(options::OPT_target_sdk_version_EQ)) {
4409 llvm::VersionTuple Version;
4410 if (Version.tryParse(A->getValue()))
4411 Diags.Report(diag::err_drv_invalid_value)
4412 << A->getAsString(Args) << A->getValue();
4413 else
4414 Opts.SDKVersion = Version;
4416 if (Arg *A =
4417 Args.getLastArg(options::OPT_darwin_target_variant_sdk_version_EQ)) {
4418 llvm::VersionTuple Version;
4419 if (Version.tryParse(A->getValue()))
4420 Diags.Report(diag::err_drv_invalid_value)
4421 << A->getAsString(Args) << A->getValue();
4422 else
4423 Opts.DarwinTargetVariantSDKVersion = Version;
4426 return Diags.getNumErrors() == NumErrorsBefore;
4429 bool CompilerInvocation::CreateFromArgsImpl(
4430 CompilerInvocation &Res, ArrayRef<const char *> CommandLineArgs,
4431 DiagnosticsEngine &Diags, const char *Argv0) {
4432 unsigned NumErrorsBefore = Diags.getNumErrors();
4434 // Parse the arguments.
4435 const OptTable &Opts = getDriverOptTable();
4436 const unsigned IncludedFlagsBitmask = options::CC1Option;
4437 unsigned MissingArgIndex, MissingArgCount;
4438 InputArgList Args = Opts.ParseArgs(CommandLineArgs, MissingArgIndex,
4439 MissingArgCount, IncludedFlagsBitmask);
4440 LangOptions &LangOpts = *Res.getLangOpts();
4442 // Check for missing argument error.
4443 if (MissingArgCount)
4444 Diags.Report(diag::err_drv_missing_argument)
4445 << Args.getArgString(MissingArgIndex) << MissingArgCount;
4447 // Issue errors on unknown arguments.
4448 for (const auto *A : Args.filtered(OPT_UNKNOWN)) {
4449 auto ArgString = A->getAsString(Args);
4450 std::string Nearest;
4451 if (Opts.findNearest(ArgString, Nearest, IncludedFlagsBitmask) > 1)
4452 Diags.Report(diag::err_drv_unknown_argument) << ArgString;
4453 else
4454 Diags.Report(diag::err_drv_unknown_argument_with_suggestion)
4455 << ArgString << Nearest;
4458 ParseFileSystemArgs(Res.getFileSystemOpts(), Args, Diags);
4459 ParseMigratorArgs(Res.getMigratorOpts(), Args, Diags);
4460 ParseAnalyzerArgs(*Res.getAnalyzerOpts(), Args, Diags);
4461 ParseDiagnosticArgs(Res.getDiagnosticOpts(), Args, &Diags,
4462 /*DefaultDiagColor=*/false);
4463 ParseFrontendArgs(Res.getFrontendOpts(), Args, Diags, LangOpts.IsHeaderFile);
4464 // FIXME: We shouldn't have to pass the DashX option around here
4465 InputKind DashX = Res.getFrontendOpts().DashX;
4466 ParseTargetArgs(Res.getTargetOpts(), Args, Diags);
4467 llvm::Triple T(Res.getTargetOpts().Triple);
4468 ParseHeaderSearchArgs(Res.getHeaderSearchOpts(), Args, Diags,
4469 Res.getFileSystemOpts().WorkingDir);
4471 ParseLangArgs(LangOpts, Args, DashX, T, Res.getPreprocessorOpts().Includes,
4472 Diags);
4473 if (Res.getFrontendOpts().ProgramAction == frontend::RewriteObjC)
4474 LangOpts.ObjCExceptions = 1;
4476 for (auto Warning : Res.getDiagnosticOpts().Warnings) {
4477 if (Warning == "misexpect" &&
4478 !Diags.isIgnored(diag::warn_profile_data_misexpect, SourceLocation())) {
4479 Res.getCodeGenOpts().MisExpect = true;
4483 if (LangOpts.CUDA) {
4484 // During CUDA device-side compilation, the aux triple is the
4485 // triple used for host compilation.
4486 if (LangOpts.CUDAIsDevice)
4487 Res.getTargetOpts().HostTriple = Res.getFrontendOpts().AuxTriple;
4490 // Set the triple of the host for OpenMP device compile.
4491 if (LangOpts.OpenMPIsDevice)
4492 Res.getTargetOpts().HostTriple = Res.getFrontendOpts().AuxTriple;
4494 ParseCodeGenArgs(Res.getCodeGenOpts(), Args, DashX, Diags, T,
4495 Res.getFrontendOpts().OutputFile, LangOpts);
4497 // FIXME: Override value name discarding when asan or msan is used because the
4498 // backend passes depend on the name of the alloca in order to print out
4499 // names.
4500 Res.getCodeGenOpts().DiscardValueNames &=
4501 !LangOpts.Sanitize.has(SanitizerKind::Address) &&
4502 !LangOpts.Sanitize.has(SanitizerKind::KernelAddress) &&
4503 !LangOpts.Sanitize.has(SanitizerKind::Memory) &&
4504 !LangOpts.Sanitize.has(SanitizerKind::KernelMemory);
4506 ParsePreprocessorArgs(Res.getPreprocessorOpts(), Args, Diags,
4507 Res.getFrontendOpts().ProgramAction,
4508 Res.getFrontendOpts());
4509 ParsePreprocessorOutputArgs(Res.getPreprocessorOutputOpts(), Args, Diags,
4510 Res.getFrontendOpts().ProgramAction);
4512 ParseDependencyOutputArgs(Res.getDependencyOutputOpts(), Args, Diags,
4513 Res.getFrontendOpts().ProgramAction,
4514 Res.getPreprocessorOutputOpts().ShowLineMarkers);
4515 if (!Res.getDependencyOutputOpts().OutputFile.empty() &&
4516 Res.getDependencyOutputOpts().Targets.empty())
4517 Diags.Report(diag::err_fe_dependency_file_requires_MT);
4519 // If sanitizer is enabled, disable OPT_ffine_grained_bitfield_accesses.
4520 if (Res.getCodeGenOpts().FineGrainedBitfieldAccesses &&
4521 !Res.getLangOpts()->Sanitize.empty()) {
4522 Res.getCodeGenOpts().FineGrainedBitfieldAccesses = false;
4523 Diags.Report(diag::warn_drv_fine_grained_bitfield_accesses_ignored);
4526 // Store the command-line for using in the CodeView backend.
4527 Res.getCodeGenOpts().Argv0 = Argv0;
4528 append_range(Res.getCodeGenOpts().CommandLineArgs, CommandLineArgs);
4530 FixupInvocation(Res, Diags, Args, DashX);
4532 return Diags.getNumErrors() == NumErrorsBefore;
4535 bool CompilerInvocation::CreateFromArgs(CompilerInvocation &Invocation,
4536 ArrayRef<const char *> CommandLineArgs,
4537 DiagnosticsEngine &Diags,
4538 const char *Argv0) {
4539 CompilerInvocation DummyInvocation;
4541 return RoundTrip(
4542 [](CompilerInvocation &Invocation, ArrayRef<const char *> CommandLineArgs,
4543 DiagnosticsEngine &Diags, const char *Argv0) {
4544 return CreateFromArgsImpl(Invocation, CommandLineArgs, Diags, Argv0);
4546 [](CompilerInvocation &Invocation, SmallVectorImpl<const char *> &Args,
4547 StringAllocator SA) {
4548 Args.push_back("-cc1");
4549 Invocation.generateCC1CommandLine(Args, SA);
4551 Invocation, DummyInvocation, CommandLineArgs, Diags, Argv0);
4554 std::string CompilerInvocation::getModuleHash() const {
4555 // FIXME: Consider using SHA1 instead of MD5.
4556 llvm::HashBuilder<llvm::MD5, llvm::support::endianness::native> HBuilder;
4558 // Note: For QoI reasons, the things we use as a hash here should all be
4559 // dumped via the -module-info flag.
4561 // Start the signature with the compiler version.
4562 HBuilder.add(getClangFullRepositoryVersion());
4564 // Also include the serialization version, in case LLVM_APPEND_VC_REV is off
4565 // and getClangFullRepositoryVersion() doesn't include git revision.
4566 HBuilder.add(serialization::VERSION_MAJOR, serialization::VERSION_MINOR);
4568 // Extend the signature with the language options
4569 #define LANGOPT(Name, Bits, Default, Description) HBuilder.add(LangOpts->Name);
4570 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
4571 HBuilder.add(static_cast<unsigned>(LangOpts->get##Name()));
4572 #define BENIGN_LANGOPT(Name, Bits, Default, Description)
4573 #define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
4574 #include "clang/Basic/LangOptions.def"
4576 HBuilder.addRange(LangOpts->ModuleFeatures);
4578 HBuilder.add(LangOpts->ObjCRuntime);
4579 HBuilder.addRange(LangOpts->CommentOpts.BlockCommandNames);
4581 // Extend the signature with the target options.
4582 HBuilder.add(TargetOpts->Triple, TargetOpts->CPU, TargetOpts->TuneCPU,
4583 TargetOpts->ABI);
4584 HBuilder.addRange(TargetOpts->FeaturesAsWritten);
4586 // Extend the signature with preprocessor options.
4587 const PreprocessorOptions &ppOpts = getPreprocessorOpts();
4588 HBuilder.add(ppOpts.UsePredefines, ppOpts.DetailedRecord);
4590 const HeaderSearchOptions &hsOpts = getHeaderSearchOpts();
4591 for (const auto &Macro : getPreprocessorOpts().Macros) {
4592 // If we're supposed to ignore this macro for the purposes of modules,
4593 // don't put it into the hash.
4594 if (!hsOpts.ModulesIgnoreMacros.empty()) {
4595 // Check whether we're ignoring this macro.
4596 StringRef MacroDef = Macro.first;
4597 if (hsOpts.ModulesIgnoreMacros.count(
4598 llvm::CachedHashString(MacroDef.split('=').first)))
4599 continue;
4602 HBuilder.add(Macro);
4605 // Extend the signature with the sysroot and other header search options.
4606 HBuilder.add(hsOpts.Sysroot, hsOpts.ModuleFormat, hsOpts.UseDebugInfo,
4607 hsOpts.UseBuiltinIncludes, hsOpts.UseStandardSystemIncludes,
4608 hsOpts.UseStandardCXXIncludes, hsOpts.UseLibcxx,
4609 hsOpts.ModulesValidateDiagnosticOptions);
4610 HBuilder.add(hsOpts.ResourceDir);
4612 if (hsOpts.ModulesStrictContextHash) {
4613 HBuilder.addRange(hsOpts.SystemHeaderPrefixes);
4614 HBuilder.addRange(hsOpts.UserEntries);
4616 const DiagnosticOptions &diagOpts = getDiagnosticOpts();
4617 #define DIAGOPT(Name, Bits, Default) HBuilder.add(diagOpts.Name);
4618 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \
4619 HBuilder.add(diagOpts.get##Name());
4620 #include "clang/Basic/DiagnosticOptions.def"
4621 #undef DIAGOPT
4622 #undef ENUM_DIAGOPT
4625 // Extend the signature with the user build path.
4626 HBuilder.add(hsOpts.ModuleUserBuildPath);
4628 // Extend the signature with the module file extensions.
4629 for (const auto &ext : getFrontendOpts().ModuleFileExtensions)
4630 ext->hashExtension(HBuilder);
4632 // When compiling with -gmodules, also hash -fdebug-prefix-map as it
4633 // affects the debug info in the PCM.
4634 if (getCodeGenOpts().DebugTypeExtRefs)
4635 HBuilder.addRange(getCodeGenOpts().DebugPrefixMap);
4637 // Extend the signature with the enabled sanitizers, if at least one is
4638 // enabled. Sanitizers which cannot affect AST generation aren't hashed.
4639 SanitizerSet SanHash = LangOpts->Sanitize;
4640 SanHash.clear(getPPTransparentSanitizers());
4641 if (!SanHash.empty())
4642 HBuilder.add(SanHash.Mask);
4644 llvm::MD5::MD5Result Result;
4645 HBuilder.getHasher().final(Result);
4646 uint64_t Hash = Result.high() ^ Result.low();
4647 return toString(llvm::APInt(64, Hash), 36, /*Signed=*/false);
4650 void CompilerInvocation::generateCC1CommandLine(
4651 SmallVectorImpl<const char *> &Args, StringAllocator SA) const {
4652 llvm::Triple T(TargetOpts->Triple);
4654 GenerateFileSystemArgs(FileSystemOpts, Args, SA);
4655 GenerateMigratorArgs(MigratorOpts, Args, SA);
4656 GenerateAnalyzerArgs(*AnalyzerOpts, Args, SA);
4657 GenerateDiagnosticArgs(*DiagnosticOpts, Args, SA, false);
4658 GenerateFrontendArgs(FrontendOpts, Args, SA, LangOpts->IsHeaderFile);
4659 GenerateTargetArgs(*TargetOpts, Args, SA);
4660 GenerateHeaderSearchArgs(*HeaderSearchOpts, Args, SA);
4661 GenerateLangArgs(*LangOpts, Args, SA, T, FrontendOpts.DashX);
4662 GenerateCodeGenArgs(CodeGenOpts, Args, SA, T, FrontendOpts.OutputFile,
4663 &*LangOpts);
4664 GeneratePreprocessorArgs(*PreprocessorOpts, Args, SA, *LangOpts, FrontendOpts,
4665 CodeGenOpts);
4666 GeneratePreprocessorOutputArgs(PreprocessorOutputOpts, Args, SA,
4667 FrontendOpts.ProgramAction);
4668 GenerateDependencyOutputArgs(DependencyOutputOpts, Args, SA);
4671 std::vector<std::string> CompilerInvocation::getCC1CommandLine() const {
4672 // Set up string allocator.
4673 llvm::BumpPtrAllocator Alloc;
4674 llvm::StringSaver Strings(Alloc);
4675 auto SA = [&Strings](const Twine &Arg) { return Strings.save(Arg).data(); };
4677 // Synthesize full command line from the CompilerInvocation, including "-cc1".
4678 SmallVector<const char *, 32> Args{"-cc1"};
4679 generateCC1CommandLine(Args, SA);
4681 // Convert arguments to the return type.
4682 return std::vector<std::string>{Args.begin(), Args.end()};
4685 void CompilerInvocation::resetNonModularOptions() {
4686 getLangOpts()->resetNonModularOptions();
4687 getPreprocessorOpts().resetNonModularOptions();
4690 void CompilerInvocation::clearImplicitModuleBuildOptions() {
4691 getLangOpts()->ImplicitModules = false;
4692 getHeaderSearchOpts().ImplicitModuleMaps = false;
4693 getHeaderSearchOpts().ModuleCachePath.clear();
4694 getHeaderSearchOpts().ModulesValidateOncePerBuildSession = false;
4695 getHeaderSearchOpts().BuildSessionTimestamp = 0;
4696 // The specific values we canonicalize to for pruning don't affect behaviour,
4697 /// so use the default values so they may be dropped from the command-line.
4698 getHeaderSearchOpts().ModuleCachePruneInterval = 7 * 24 * 60 * 60;
4699 getHeaderSearchOpts().ModuleCachePruneAfter = 31 * 24 * 60 * 60;
4702 IntrusiveRefCntPtr<llvm::vfs::FileSystem>
4703 clang::createVFSFromCompilerInvocation(const CompilerInvocation &CI,
4704 DiagnosticsEngine &Diags) {
4705 return createVFSFromCompilerInvocation(CI, Diags,
4706 llvm::vfs::getRealFileSystem());
4709 IntrusiveRefCntPtr<llvm::vfs::FileSystem>
4710 clang::createVFSFromCompilerInvocation(
4711 const CompilerInvocation &CI, DiagnosticsEngine &Diags,
4712 IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS) {
4713 if (CI.getHeaderSearchOpts().VFSOverlayFiles.empty())
4714 return BaseFS;
4716 IntrusiveRefCntPtr<llvm::vfs::FileSystem> Result = BaseFS;
4717 // earlier vfs files are on the bottom
4718 for (const auto &File : CI.getHeaderSearchOpts().VFSOverlayFiles) {
4719 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Buffer =
4720 Result->getBufferForFile(File);
4721 if (!Buffer) {
4722 Diags.Report(diag::err_missing_vfs_overlay_file) << File;
4723 continue;
4726 IntrusiveRefCntPtr<llvm::vfs::FileSystem> FS = llvm::vfs::getVFSFromYAML(
4727 std::move(Buffer.get()), /*DiagHandler*/ nullptr, File,
4728 /*DiagContext*/ nullptr, Result);
4729 if (!FS) {
4730 Diags.Report(diag::err_invalid_vfs_overlay) << File;
4731 continue;
4734 Result = FS;
4736 return Result;