1 //===--- SanitizerArgs.cpp - Arguments for sanitizer tools  ---------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 #include "clang/Driver/SanitizerArgs.h"
9 #include "ToolChains/CommonArgs.h"
10 #include "clang/Basic/Sanitizers.h"
11 #include "clang/Driver/Driver.h"
12 #include "clang/Driver/DriverDiagnostic.h"
13 #include "clang/Driver/Options.h"
14 #include "clang/Driver/ToolChain.h"
15 #include "llvm/ADT/StringExtras.h"
16 #include "llvm/ADT/StringSwitch.h"
17 #include "llvm/Support/FileSystem.h"
18 #include "llvm/Support/Path.h"
19 #include "llvm/Support/SpecialCaseList.h"
20 #include "llvm/Support/TargetParser.h"
21 #include <memory>
22 
23 using namespace clang;
24 using namespace clang::driver;
25 using namespace llvm::opt;
26 
27 static const SanitizerMask NeedsUbsanRt =
28     SanitizerKind::Undefined | SanitizerKind::Integer |
29     SanitizerKind::ImplicitConversion | SanitizerKind::Nullability |
30     SanitizerKind::CFI | SanitizerKind::FloatDivideByZero;
31 static const SanitizerMask NeedsUbsanCxxRt =
32     SanitizerKind::Vptr | SanitizerKind::CFI;
33 static const SanitizerMask NotAllowedWithTrap = SanitizerKind::Vptr;
34 static const SanitizerMask NotAllowedWithMinimalRuntime =
35     SanitizerKind::Function | SanitizerKind::Vptr;
36 static const SanitizerMask RequiresPIE =
37     SanitizerKind::DataFlow | SanitizerKind::HWAddress | SanitizerKind::Scudo;
38 static const SanitizerMask NeedsUnwindTables =
39     SanitizerKind::Address | SanitizerKind::HWAddress | SanitizerKind::Thread |
40     SanitizerKind::Memory | SanitizerKind::DataFlow;
41 static const SanitizerMask SupportsCoverage =
42     SanitizerKind::Address | SanitizerKind::HWAddress |
43     SanitizerKind::KernelAddress | SanitizerKind::KernelHWAddress |
44     SanitizerKind::MemTag | SanitizerKind::Memory |
45     SanitizerKind::KernelMemory | SanitizerKind::Leak |
46     SanitizerKind::Undefined | SanitizerKind::Integer |
47     SanitizerKind::ImplicitConversion | SanitizerKind::Nullability |
48     SanitizerKind::DataFlow | SanitizerKind::Fuzzer |
49     SanitizerKind::FuzzerNoLink | SanitizerKind::FloatDivideByZero |
50     SanitizerKind::SafeStack | SanitizerKind::ShadowCallStack;
51 static const SanitizerMask RecoverableByDefault =
52     SanitizerKind::Undefined | SanitizerKind::Integer |
53     SanitizerKind::ImplicitConversion | SanitizerKind::Nullability |
54     SanitizerKind::FloatDivideByZero;
55 static const SanitizerMask Unrecoverable =
56     SanitizerKind::Unreachable | SanitizerKind::Return;
57 static const SanitizerMask AlwaysRecoverable =
58     SanitizerKind::KernelAddress | SanitizerKind::KernelHWAddress;
59 static const SanitizerMask NeedsLTO = SanitizerKind::CFI;
60 static const SanitizerMask TrappingSupported =
61     (SanitizerKind::Undefined & ~SanitizerKind::Vptr) |
62     SanitizerKind::UnsignedIntegerOverflow | SanitizerKind::ImplicitConversion |
63     SanitizerKind::Nullability | SanitizerKind::LocalBounds |
64     SanitizerKind::CFI | SanitizerKind::FloatDivideByZero;
65 static const SanitizerMask TrappingDefault = SanitizerKind::CFI;
66 static const SanitizerMask CFIClasses =
67     SanitizerKind::CFIVCall | SanitizerKind::CFINVCall |
68     SanitizerKind::CFIMFCall | SanitizerKind::CFIDerivedCast |
69     SanitizerKind::CFIUnrelatedCast;
70 static const SanitizerMask CompatibleWithMinimalRuntime =
71     TrappingSupported | SanitizerKind::Scudo | SanitizerKind::ShadowCallStack;
72 
73 enum CoverageFeature {
74   CoverageFunc = 1 << 0,
75   CoverageBB = 1 << 1,
76   CoverageEdge = 1 << 2,
77   CoverageIndirCall = 1 << 3,
78   CoverageTraceBB = 1 << 4, // Deprecated.
79   CoverageTraceCmp = 1 << 5,
80   CoverageTraceDiv = 1 << 6,
81   CoverageTraceGep = 1 << 7,
82   Coverage8bitCounters = 1 << 8, // Deprecated.
83   CoverageTracePC = 1 << 9,
84   CoverageTracePCGuard = 1 << 10,
85   CoverageNoPrune = 1 << 11,
86   CoverageInline8bitCounters = 1 << 12,
87   CoveragePCTable = 1 << 13,
88   CoverageStackDepth = 1 << 14,
89   CoverageInlineBoolFlag = 1 << 15,
90 };
91 
92 /// Parse a -fsanitize= or -fno-sanitize= argument's values, diagnosing any
93 /// invalid components. Returns a SanitizerMask.
94 static SanitizerMask parseArgValues(const Driver &D, const llvm::opt::Arg *A,
95                                     bool DiagnoseErrors);
96 
97 /// Parse -f(no-)?sanitize-coverage= flag values, diagnosing any invalid
98 /// components. Returns OR of members of \c CoverageFeature enumeration.
99 static int parseCoverageFeatures(const Driver &D, const llvm::opt::Arg *A);
100 
101 /// Produce an argument string from ArgList \p Args, which shows how it
102 /// provides some sanitizer kind from \p Mask. For example, the argument list
103 /// "-fsanitize=thread,vptr -fsanitize=address" with mask \c NeedsUbsanRt
104 /// would produce "-fsanitize=vptr".
105 static std::string lastArgumentForMask(const Driver &D,
106                                        const llvm::opt::ArgList &Args,
107                                        SanitizerMask Mask);
108 
109 /// Produce an argument string from argument \p A, which shows how it provides
110 /// a value in \p Mask. For instance, the argument
111 /// "-fsanitize=address,alignment" with mask \c NeedsUbsanRt would produce
112 /// "-fsanitize=alignment".
113 static std::string describeSanitizeArg(const llvm::opt::Arg *A,
114                                        SanitizerMask Mask);
115 
116 /// Produce a string containing comma-separated names of sanitizers in \p
117 /// Sanitizers set.
118 static std::string toString(const clang::SanitizerSet &Sanitizers);
119 
120 static void addDefaultBlacklists(const Driver &D, SanitizerMask Kinds,
121                                  std::vector<std::string> &BlacklistFiles) {
122   struct Blacklist {
123     const char *File;
124     SanitizerMask Mask;
125   } Blacklists[] = {{"asan_blacklist.txt", SanitizerKind::Address},
126                     {"hwasan_blacklist.txt", SanitizerKind::HWAddress},
127                     {"memtag_blacklist.txt", SanitizerKind::MemTag},
128                     {"msan_blacklist.txt", SanitizerKind::Memory},
129                     {"tsan_blacklist.txt", SanitizerKind::Thread},
130                     {"dfsan_abilist.txt", SanitizerKind::DataFlow},
131                     {"cfi_blacklist.txt", SanitizerKind::CFI},
132                     {"ubsan_blacklist.txt",
133                      SanitizerKind::Undefined | SanitizerKind::Integer |
134                          SanitizerKind::Nullability |
135                          SanitizerKind::FloatDivideByZero}};
136 
137   for (auto BL : Blacklists) {
138     if (!(Kinds & BL.Mask))
139       continue;
140 
141     clang::SmallString<64> Path(D.ResourceDir);
142     llvm::sys::path::append(Path, "share", BL.File);
143     if (D.getVFS().exists(Path))
144       BlacklistFiles.push_back(std::string(Path.str()));
145     else if (BL.Mask == SanitizerKind::CFI)
146       // If cfi_blacklist.txt cannot be found in the resource dir, driver
147       // should fail.
148       D.Diag(clang::diag::err_drv_no_such_file) << Path;
149   }
150 }
151 
152 /// Parse -f(no-)?sanitize-(coverage-)?(white|black)list argument's values,
153 /// diagnosing any invalid file paths and validating special case list format.
154 static void parseSpecialCaseListArg(const Driver &D,
155                                     const llvm::opt::ArgList &Args,
156                                     std::vector<std::string> &SCLFiles,
157                                     llvm::opt::OptSpecifier SCLOptionID,
158                                     llvm::opt::OptSpecifier NoSCLOptionID,
159                                     unsigned MalformedSCLErrorDiagID) {
160   for (const auto *Arg : Args) {
161     // Match -fsanitize-(coverage-)?(white|black)list.
162     if (Arg->getOption().matches(SCLOptionID)) {
163       Arg->claim();
164       std::string SCLPath = Arg->getValue();
165       if (D.getVFS().exists(SCLPath)) {
166         SCLFiles.push_back(SCLPath);
167       } else {
168         D.Diag(clang::diag::err_drv_no_such_file) << SCLPath;
169       }
170       // Match -fno-sanitize-blacklist.
171     } else if (Arg->getOption().matches(NoSCLOptionID)) {
172       Arg->claim();
173       SCLFiles.clear();
174     }
175   }
176   // Validate special case list format.
177   {
178     std::string BLError;
179     std::unique_ptr<llvm::SpecialCaseList> SCL(
180         llvm::SpecialCaseList::create(SCLFiles, D.getVFS(), BLError));
181     if (!SCL.get())
182       D.Diag(MalformedSCLErrorDiagID) << BLError;
183   }
184 }
185 
186 /// Sets group bits for every group that has at least one representative already
187 /// enabled in \p Kinds.
188 static SanitizerMask setGroupBits(SanitizerMask Kinds) {
189 #define SANITIZER(NAME, ID)
190 #define SANITIZER_GROUP(NAME, ID, ALIAS)                                       \
191   if (Kinds & SanitizerKind::ID)                                               \
192     Kinds |= SanitizerKind::ID##Group;
193 #include "clang/Basic/Sanitizers.def"
194   return Kinds;
195 }
196 
197 static SanitizerMask parseSanitizeTrapArgs(const Driver &D,
198                                            const llvm::opt::ArgList &Args) {
199   SanitizerMask TrapRemove;     // During the loop below, the accumulated set of
200                                 // sanitizers disabled by the current sanitizer
201                                 // argument or any argument after it.
202   SanitizerMask TrappingKinds;
203   SanitizerMask TrappingSupportedWithGroups = setGroupBits(TrappingSupported);
204 
205   for (ArgList::const_reverse_iterator I = Args.rbegin(), E = Args.rend();
206        I != E; ++I) {
207     const auto *Arg = *I;
208     if (Arg->getOption().matches(options::OPT_fsanitize_trap_EQ)) {
209       Arg->claim();
210       SanitizerMask Add = parseArgValues(D, Arg, true);
211       Add &= ~TrapRemove;
212       if (SanitizerMask InvalidValues = Add & ~TrappingSupportedWithGroups) {
213         SanitizerSet S;
214         S.Mask = InvalidValues;
215         D.Diag(diag::err_drv_unsupported_option_argument) << "-fsanitize-trap"
216                                                           << toString(S);
217       }
218       TrappingKinds |= expandSanitizerGroups(Add) & ~TrapRemove;
219     } else if (Arg->getOption().matches(options::OPT_fno_sanitize_trap_EQ)) {
220       Arg->claim();
221       TrapRemove |= expandSanitizerGroups(parseArgValues(D, Arg, true));
222     }
223   }
224 
225   // Apply default trapping behavior.
226   TrappingKinds |= TrappingDefault & ~TrapRemove;
227 
228   return TrappingKinds;
229 }
230 
231 bool SanitizerArgs::needsUbsanRt() const {
232   // All of these include ubsan.
233   if (needsAsanRt() || needsMsanRt() || needsHwasanRt() || needsTsanRt() ||
234       needsDfsanRt() || needsLsanRt() || needsCfiDiagRt() ||
235       (needsScudoRt() && !requiresMinimalRuntime()))
236     return false;
237 
238   return (Sanitizers.Mask & NeedsUbsanRt & ~TrapSanitizers.Mask) ||
239          CoverageFeatures;
240 }
241 
242 bool SanitizerArgs::needsCfiRt() const {
243   return !(Sanitizers.Mask & SanitizerKind::CFI & ~TrapSanitizers.Mask) &&
244          CfiCrossDso && !ImplicitCfiRuntime;
245 }
246 
247 bool SanitizerArgs::needsCfiDiagRt() const {
248   return (Sanitizers.Mask & SanitizerKind::CFI & ~TrapSanitizers.Mask) &&
249          CfiCrossDso && !ImplicitCfiRuntime;
250 }
251 
252 bool SanitizerArgs::requiresPIE() const {
253   return NeedPIE || (Sanitizers.Mask & RequiresPIE);
254 }
255 
256 bool SanitizerArgs::needsUnwindTables() const {
257   return static_cast<bool>(Sanitizers.Mask & NeedsUnwindTables);
258 }
259 
260 bool SanitizerArgs::needsLTO() const {
261   return static_cast<bool>(Sanitizers.Mask & NeedsLTO);
262 }
263 
264 SanitizerArgs::SanitizerArgs(const ToolChain &TC,
265                              const llvm::opt::ArgList &Args) {
266   SanitizerMask AllRemove;      // During the loop below, the accumulated set of
267                                 // sanitizers disabled by the current sanitizer
268                                 // argument or any argument after it.
269   SanitizerMask AllAddedKinds;      // Mask of all sanitizers ever enabled by
270                                     // -fsanitize= flags (directly or via group
271                                     // expansion), some of which may be disabled
272                                     // later. Used to carefully prune
273                                     // unused-argument diagnostics.
274   SanitizerMask DiagnosedKinds;      // All Kinds we have diagnosed up to now.
275                                      // Used to deduplicate diagnostics.
276   SanitizerMask Kinds;
277   const SanitizerMask Supported = setGroupBits(TC.getSupportedSanitizers());
278 
279   CfiCrossDso = Args.hasFlag(options::OPT_fsanitize_cfi_cross_dso,
280                              options::OPT_fno_sanitize_cfi_cross_dso, false);
281 
282   ToolChain::RTTIMode RTTIMode = TC.getRTTIMode();
283 
284   const Driver &D = TC.getDriver();
285   SanitizerMask TrappingKinds = parseSanitizeTrapArgs(D, Args);
286   SanitizerMask InvalidTrappingKinds = TrappingKinds & NotAllowedWithTrap;
287 
288   MinimalRuntime =
289       Args.hasFlag(options::OPT_fsanitize_minimal_runtime,
290                    options::OPT_fno_sanitize_minimal_runtime, MinimalRuntime);
291 
292   // The object size sanitizer should not be enabled at -O0.
293   Arg *OptLevel = Args.getLastArg(options::OPT_O_Group);
294   bool RemoveObjectSizeAtO0 =
295       !OptLevel || OptLevel->getOption().matches(options::OPT_O0);
296 
297   for (ArgList::const_reverse_iterator I = Args.rbegin(), E = Args.rend();
298        I != E; ++I) {
299     const auto *Arg = *I;
300     if (Arg->getOption().matches(options::OPT_fsanitize_EQ)) {
301       Arg->claim();
302       SanitizerMask Add = parseArgValues(D, Arg, /*AllowGroups=*/true);
303 
304       if (RemoveObjectSizeAtO0) {
305         AllRemove |= SanitizerKind::ObjectSize;
306 
307         // The user explicitly enabled the object size sanitizer. Warn
308         // that this does nothing at -O0.
309         if (Add & SanitizerKind::ObjectSize)
310           D.Diag(diag::warn_drv_object_size_disabled_O0)
311               << Arg->getAsString(Args);
312       }
313 
314       AllAddedKinds |= expandSanitizerGroups(Add);
315 
316       // Avoid diagnosing any sanitizer which is disabled later.
317       Add &= ~AllRemove;
318       // At this point we have not expanded groups, so any unsupported
319       // sanitizers in Add are those which have been explicitly enabled.
320       // Diagnose them.
321       if (SanitizerMask KindsToDiagnose =
322               Add & InvalidTrappingKinds & ~DiagnosedKinds) {
323         std::string Desc = describeSanitizeArg(*I, KindsToDiagnose);
324         D.Diag(diag::err_drv_argument_not_allowed_with)
325             << Desc << "-fsanitize-trap=undefined";
326         DiagnosedKinds |= KindsToDiagnose;
327       }
328       Add &= ~InvalidTrappingKinds;
329 
330       if (MinimalRuntime) {
331         if (SanitizerMask KindsToDiagnose =
332                 Add & NotAllowedWithMinimalRuntime & ~DiagnosedKinds) {
333           std::string Desc = describeSanitizeArg(*I, KindsToDiagnose);
334           D.Diag(diag::err_drv_argument_not_allowed_with)
335               << Desc << "-fsanitize-minimal-runtime";
336           DiagnosedKinds |= KindsToDiagnose;
337         }
338         Add &= ~NotAllowedWithMinimalRuntime;
339       }
340 
341       // FIXME: Make CFI on member function calls compatible with cross-DSO CFI.
342       // There are currently two problems:
343       // - Virtual function call checks need to pass a pointer to the function
344       //   address to llvm.type.test and a pointer to the address point to the
345       //   diagnostic function. Currently we pass the same pointer to both
346       //   places.
347       // - Non-virtual function call checks may need to check multiple type
348       //   identifiers.
349       // Fixing both of those may require changes to the cross-DSO CFI
350       // interface.
351       if (CfiCrossDso && (Add & SanitizerKind::CFIMFCall & ~DiagnosedKinds)) {
352         D.Diag(diag::err_drv_argument_not_allowed_with)
353             << "-fsanitize=cfi-mfcall"
354             << "-fsanitize-cfi-cross-dso";
355         Add &= ~SanitizerKind::CFIMFCall;
356         DiagnosedKinds |= SanitizerKind::CFIMFCall;
357       }
358 
359       if (SanitizerMask KindsToDiagnose = Add & ~Supported & ~DiagnosedKinds) {
360         std::string Desc = describeSanitizeArg(*I, KindsToDiagnose);
361         D.Diag(diag::err_drv_unsupported_opt_for_target)
362             << Desc << TC.getTriple().str();
363         DiagnosedKinds |= KindsToDiagnose;
364       }
365       Add &= Supported;
366 
367       // Test for -fno-rtti + explicit -fsanitizer=vptr before expanding groups
368       // so we don't error out if -fno-rtti and -fsanitize=undefined were
369       // passed.
370       if ((Add & SanitizerKind::Vptr) && (RTTIMode == ToolChain::RM_Disabled)) {
371         if (const llvm::opt::Arg *NoRTTIArg = TC.getRTTIArg()) {
372           assert(NoRTTIArg->getOption().matches(options::OPT_fno_rtti) &&
373                   "RTTI disabled without -fno-rtti option?");
374           // The user explicitly passed -fno-rtti with -fsanitize=vptr, but
375           // the vptr sanitizer requires RTTI, so this is a user error.
376           D.Diag(diag::err_drv_argument_not_allowed_with)
377               << "-fsanitize=vptr" << NoRTTIArg->getAsString(Args);
378         } else {
379           // The vptr sanitizer requires RTTI, but RTTI is disabled (by
380           // default). Warn that the vptr sanitizer is being disabled.
381           D.Diag(diag::warn_drv_disabling_vptr_no_rtti_default);
382         }
383 
384         // Take out the Vptr sanitizer from the enabled sanitizers
385         AllRemove |= SanitizerKind::Vptr;
386       }
387 
388       Add = expandSanitizerGroups(Add);
389       // Group expansion may have enabled a sanitizer which is disabled later.
390       Add &= ~AllRemove;
391       // Silently discard any unsupported sanitizers implicitly enabled through
392       // group expansion.
393       Add &= ~InvalidTrappingKinds;
394       if (MinimalRuntime) {
395         Add &= ~NotAllowedWithMinimalRuntime;
396       }
397       if (CfiCrossDso)
398         Add &= ~SanitizerKind::CFIMFCall;
399       Add &= Supported;
400 
401       if (Add & SanitizerKind::Fuzzer)
402         Add |= SanitizerKind::FuzzerNoLink;
403 
404       // Enable coverage if the fuzzing flag is set.
405       if (Add & SanitizerKind::FuzzerNoLink) {
406         CoverageFeatures |= CoverageInline8bitCounters | CoverageIndirCall |
407                             CoverageTraceCmp | CoveragePCTable;
408         // Due to TLS differences, stack depth tracking is only enabled on Linux
409         if (TC.getTriple().isOSLinux())
410           CoverageFeatures |= CoverageStackDepth;
411       }
412 
413       Kinds |= Add;
414     } else if (Arg->getOption().matches(options::OPT_fno_sanitize_EQ)) {
415       Arg->claim();
416       SanitizerMask Remove = parseArgValues(D, Arg, true);
417       AllRemove |= expandSanitizerGroups(Remove);
418     }
419   }
420 
421   std::pair<SanitizerMask, SanitizerMask> IncompatibleGroups[] = {
422       std::make_pair(SanitizerKind::Address,
423                      SanitizerKind::Thread | SanitizerKind::Memory),
424       std::make_pair(SanitizerKind::Thread, SanitizerKind::Memory),
425       std::make_pair(SanitizerKind::Leak,
426                      SanitizerKind::Thread | SanitizerKind::Memory),
427       std::make_pair(SanitizerKind::KernelAddress,
428                      SanitizerKind::Address | SanitizerKind::Leak |
429                          SanitizerKind::Thread | SanitizerKind::Memory),
430       std::make_pair(SanitizerKind::HWAddress,
431                      SanitizerKind::Address | SanitizerKind::Thread |
432                          SanitizerKind::Memory | SanitizerKind::KernelAddress),
433       std::make_pair(SanitizerKind::Scudo,
434                      SanitizerKind::Address | SanitizerKind::HWAddress |
435                          SanitizerKind::Leak | SanitizerKind::Thread |
436                          SanitizerKind::Memory | SanitizerKind::KernelAddress),
437       std::make_pair(SanitizerKind::SafeStack,
438                      (TC.getTriple().isOSFuchsia() ? SanitizerMask()
439                                                    : SanitizerKind::Leak) |
440                          SanitizerKind::Address | SanitizerKind::HWAddress |
441                          SanitizerKind::Thread | SanitizerKind::Memory |
442                          SanitizerKind::KernelAddress),
443       std::make_pair(SanitizerKind::KernelHWAddress,
444                      SanitizerKind::Address | SanitizerKind::HWAddress |
445                          SanitizerKind::Leak | SanitizerKind::Thread |
446                          SanitizerKind::Memory | SanitizerKind::KernelAddress |
447                          SanitizerKind::SafeStack),
448       std::make_pair(SanitizerKind::KernelMemory,
449                      SanitizerKind::Address | SanitizerKind::HWAddress |
450                          SanitizerKind::Leak | SanitizerKind::Thread |
451                          SanitizerKind::Memory | SanitizerKind::KernelAddress |
452                          SanitizerKind::Scudo | SanitizerKind::SafeStack),
453       std::make_pair(SanitizerKind::MemTag,
454                      SanitizerKind::Address | SanitizerKind::KernelAddress |
455                          SanitizerKind::HWAddress |
456                          SanitizerKind::KernelHWAddress)};
457   // Enable toolchain specific default sanitizers if not explicitly disabled.
458   SanitizerMask Default = TC.getDefaultSanitizers() & ~AllRemove;
459 
460   // Disable default sanitizers that are incompatible with explicitly requested
461   // ones.
462   for (auto G : IncompatibleGroups) {
463     SanitizerMask Group = G.first;
464     if ((Default & Group) && (Kinds & G.second))
465       Default &= ~Group;
466   }
467 
468   Kinds |= Default;
469 
470   // We disable the vptr sanitizer if it was enabled by group expansion but RTTI
471   // is disabled.
472   if ((Kinds & SanitizerKind::Vptr) && (RTTIMode == ToolChain::RM_Disabled)) {
473     Kinds &= ~SanitizerKind::Vptr;
474   }
475 
476   // Check that LTO is enabled if we need it.
477   if ((Kinds & NeedsLTO) && !D.isUsingLTO()) {
478     D.Diag(diag::err_drv_argument_only_allowed_with)
479         << lastArgumentForMask(D, Args, Kinds & NeedsLTO) << "-flto";
480   }
481 
482   if ((Kinds & SanitizerKind::ShadowCallStack) &&
483       TC.getTriple().getArch() == llvm::Triple::aarch64 &&
484       !llvm::AArch64::isX18ReservedByDefault(TC.getTriple()) &&
485       !Args.hasArg(options::OPT_ffixed_x18)) {
486     D.Diag(diag::err_drv_argument_only_allowed_with)
487         << lastArgumentForMask(D, Args, Kinds & SanitizerKind::ShadowCallStack)
488         << "-ffixed-x18";
489   }
490 
491   // Report error if there are non-trapping sanitizers that require
492   // c++abi-specific  parts of UBSan runtime, and they are not provided by the
493   // toolchain. We don't have a good way to check the latter, so we just
494   // check if the toolchan supports vptr.
495   if (~Supported & SanitizerKind::Vptr) {
496     SanitizerMask KindsToDiagnose = Kinds & ~TrappingKinds & NeedsUbsanCxxRt;
497     // The runtime library supports the Microsoft C++ ABI, but only well enough
498     // for CFI. FIXME: Remove this once we support vptr on Windows.
499     if (TC.getTriple().isOSWindows())
500       KindsToDiagnose &= ~SanitizerKind::CFI;
501     if (KindsToDiagnose) {
502       SanitizerSet S;
503       S.Mask = KindsToDiagnose;
504       D.Diag(diag::err_drv_unsupported_opt_for_target)
505           << ("-fno-sanitize-trap=" + toString(S)) << TC.getTriple().str();
506       Kinds &= ~KindsToDiagnose;
507     }
508   }
509 
510   // Warn about incompatible groups of sanitizers.
511   for (auto G : IncompatibleGroups) {
512     SanitizerMask Group = G.first;
513     if (Kinds & Group) {
514       if (SanitizerMask Incompatible = Kinds & G.second) {
515         D.Diag(clang::diag::err_drv_argument_not_allowed_with)
516             << lastArgumentForMask(D, Args, Group)
517             << lastArgumentForMask(D, Args, Incompatible);
518         Kinds &= ~Incompatible;
519       }
520     }
521   }
522   // FIXME: Currently -fsanitize=leak is silently ignored in the presence of
523   // -fsanitize=address. Perhaps it should print an error, or perhaps
524   // -f(-no)sanitize=leak should change whether leak detection is enabled by
525   // default in ASan?
526 
527   // Parse -f(no-)?sanitize-recover flags.
528   SanitizerMask RecoverableKinds = RecoverableByDefault | AlwaysRecoverable;
529   SanitizerMask DiagnosedUnrecoverableKinds;
530   SanitizerMask DiagnosedAlwaysRecoverableKinds;
531   for (const auto *Arg : Args) {
532     if (Arg->getOption().matches(options::OPT_fsanitize_recover_EQ)) {
533       SanitizerMask Add = parseArgValues(D, Arg, true);
534       // Report error if user explicitly tries to recover from unrecoverable
535       // sanitizer.
536       if (SanitizerMask KindsToDiagnose =
537               Add & Unrecoverable & ~DiagnosedUnrecoverableKinds) {
538         SanitizerSet SetToDiagnose;
539         SetToDiagnose.Mask |= KindsToDiagnose;
540         D.Diag(diag::err_drv_unsupported_option_argument)
541             << Arg->getOption().getName() << toString(SetToDiagnose);
542         DiagnosedUnrecoverableKinds |= KindsToDiagnose;
543       }
544       RecoverableKinds |= expandSanitizerGroups(Add);
545       Arg->claim();
546     } else if (Arg->getOption().matches(options::OPT_fno_sanitize_recover_EQ)) {
547       SanitizerMask Remove = parseArgValues(D, Arg, true);
548       // Report error if user explicitly tries to disable recovery from
549       // always recoverable sanitizer.
550       if (SanitizerMask KindsToDiagnose =
551               Remove & AlwaysRecoverable & ~DiagnosedAlwaysRecoverableKinds) {
552         SanitizerSet SetToDiagnose;
553         SetToDiagnose.Mask |= KindsToDiagnose;
554         D.Diag(diag::err_drv_unsupported_option_argument)
555             << Arg->getOption().getName() << toString(SetToDiagnose);
556         DiagnosedAlwaysRecoverableKinds |= KindsToDiagnose;
557       }
558       RecoverableKinds &= ~expandSanitizerGroups(Remove);
559       Arg->claim();
560     }
561   }
562   RecoverableKinds &= Kinds;
563   RecoverableKinds &= ~Unrecoverable;
564 
565   TrappingKinds &= Kinds;
566   RecoverableKinds &= ~TrappingKinds;
567 
568   // Setup blacklist files.
569   // Add default blacklist from resource directory.
570   addDefaultBlacklists(D, Kinds, SystemBlacklistFiles);
571 
572   // Parse -f(no-)?sanitize-blacklist options.
573   // This also validates special case lists format.
574   // Here, OptSpecifier() acts as a never-matching command-line argument.
575   // So, there is no way to append to system blacklist but it can be cleared.
576   parseSpecialCaseListArg(D, Args, SystemBlacklistFiles, OptSpecifier(),
577                           options::OPT_fno_sanitize_blacklist,
578                           clang::diag::err_drv_malformed_sanitizer_blacklist);
579   parseSpecialCaseListArg(D, Args, UserBlacklistFiles,
580                           options::OPT_fsanitize_blacklist,
581                           options::OPT_fno_sanitize_blacklist,
582                           clang::diag::err_drv_malformed_sanitizer_blacklist);
583 
584   // Parse -f[no-]sanitize-memory-track-origins[=level] options.
585   if (AllAddedKinds & SanitizerKind::Memory) {
586     if (Arg *A =
587             Args.getLastArg(options::OPT_fsanitize_memory_track_origins_EQ,
588                             options::OPT_fsanitize_memory_track_origins,
589                             options::OPT_fno_sanitize_memory_track_origins)) {
590       if (A->getOption().matches(options::OPT_fsanitize_memory_track_origins)) {
591         MsanTrackOrigins = 2;
592       } else if (A->getOption().matches(
593                      options::OPT_fno_sanitize_memory_track_origins)) {
594         MsanTrackOrigins = 0;
595       } else {
596         StringRef S = A->getValue();
597         if (S.getAsInteger(0, MsanTrackOrigins) || MsanTrackOrigins < 0 ||
598             MsanTrackOrigins > 2) {
599           D.Diag(clang::diag::err_drv_invalid_value) << A->getAsString(Args) << S;
600         }
601       }
602     }
603     MsanUseAfterDtor =
604         Args.hasFlag(options::OPT_fsanitize_memory_use_after_dtor,
605                      options::OPT_fno_sanitize_memory_use_after_dtor,
606                      MsanUseAfterDtor);
607     NeedPIE |= !(TC.getTriple().isOSLinux() &&
608                  TC.getTriple().getArch() == llvm::Triple::x86_64);
609   } else {
610     MsanUseAfterDtor = false;
611   }
612 
613   if (AllAddedKinds & SanitizerKind::Thread) {
614     TsanMemoryAccess = Args.hasFlag(
615         options::OPT_fsanitize_thread_memory_access,
616         options::OPT_fno_sanitize_thread_memory_access, TsanMemoryAccess);
617     TsanFuncEntryExit = Args.hasFlag(
618         options::OPT_fsanitize_thread_func_entry_exit,
619         options::OPT_fno_sanitize_thread_func_entry_exit, TsanFuncEntryExit);
620     TsanAtomics =
621         Args.hasFlag(options::OPT_fsanitize_thread_atomics,
622                      options::OPT_fno_sanitize_thread_atomics, TsanAtomics);
623   }
624 
625   if (AllAddedKinds & SanitizerKind::CFI) {
626     // Without PIE, external function address may resolve to a PLT record, which
627     // can not be verified by the target module.
628     NeedPIE |= CfiCrossDso;
629     CfiICallGeneralizePointers =
630         Args.hasArg(options::OPT_fsanitize_cfi_icall_generalize_pointers);
631 
632     if (CfiCrossDso && CfiICallGeneralizePointers)
633       D.Diag(diag::err_drv_argument_not_allowed_with)
634           << "-fsanitize-cfi-cross-dso"
635           << "-fsanitize-cfi-icall-generalize-pointers";
636 
637     CfiCanonicalJumpTables =
638         Args.hasFlag(options::OPT_fsanitize_cfi_canonical_jump_tables,
639                      options::OPT_fno_sanitize_cfi_canonical_jump_tables, true);
640   }
641 
642   Stats = Args.hasFlag(options::OPT_fsanitize_stats,
643                        options::OPT_fno_sanitize_stats, false);
644 
645   if (MinimalRuntime) {
646     SanitizerMask IncompatibleMask =
647         Kinds & ~setGroupBits(CompatibleWithMinimalRuntime);
648     if (IncompatibleMask)
649       D.Diag(clang::diag::err_drv_argument_not_allowed_with)
650           << "-fsanitize-minimal-runtime"
651           << lastArgumentForMask(D, Args, IncompatibleMask);
652 
653     SanitizerMask NonTrappingCfi = Kinds & SanitizerKind::CFI & ~TrappingKinds;
654     if (NonTrappingCfi)
655       D.Diag(clang::diag::err_drv_argument_only_allowed_with)
656           << "fsanitize-minimal-runtime"
657           << "fsanitize-trap=cfi";
658   }
659 
660   // Parse -f(no-)?sanitize-coverage flags if coverage is supported by the
661   // enabled sanitizers.
662   for (const auto *Arg : Args) {
663     if (Arg->getOption().matches(options::OPT_fsanitize_coverage)) {
664       int LegacySanitizeCoverage;
665       if (Arg->getNumValues() == 1 &&
666           !StringRef(Arg->getValue(0))
667                .getAsInteger(0, LegacySanitizeCoverage)) {
668         CoverageFeatures = 0;
669         Arg->claim();
670         if (LegacySanitizeCoverage != 0) {
671           D.Diag(diag::warn_drv_deprecated_arg)
672               << Arg->getAsString(Args) << "-fsanitize-coverage=trace-pc-guard";
673         }
674         continue;
675       }
676       CoverageFeatures |= parseCoverageFeatures(D, Arg);
677 
678       // Disable coverage and not claim the flags if there is at least one
679       // non-supporting sanitizer.
680       if (!(AllAddedKinds & ~AllRemove & ~setGroupBits(SupportsCoverage))) {
681         Arg->claim();
682       } else {
683         CoverageFeatures = 0;
684       }
685     } else if (Arg->getOption().matches(options::OPT_fno_sanitize_coverage)) {
686       Arg->claim();
687       CoverageFeatures &= ~parseCoverageFeatures(D, Arg);
688     }
689   }
690   // Choose at most one coverage type: function, bb, or edge.
691   if ((CoverageFeatures & CoverageFunc) && (CoverageFeatures & CoverageBB))
692     D.Diag(clang::diag::err_drv_argument_not_allowed_with)
693         << "-fsanitize-coverage=func"
694         << "-fsanitize-coverage=bb";
695   if ((CoverageFeatures & CoverageFunc) && (CoverageFeatures & CoverageEdge))
696     D.Diag(clang::diag::err_drv_argument_not_allowed_with)
697         << "-fsanitize-coverage=func"
698         << "-fsanitize-coverage=edge";
699   if ((CoverageFeatures & CoverageBB) && (CoverageFeatures & CoverageEdge))
700     D.Diag(clang::diag::err_drv_argument_not_allowed_with)
701         << "-fsanitize-coverage=bb"
702         << "-fsanitize-coverage=edge";
703   // Basic block tracing and 8-bit counters require some type of coverage
704   // enabled.
705   if (CoverageFeatures & CoverageTraceBB)
706     D.Diag(clang::diag::warn_drv_deprecated_arg)
707         << "-fsanitize-coverage=trace-bb"
708         << "-fsanitize-coverage=trace-pc-guard";
709   if (CoverageFeatures & Coverage8bitCounters)
710     D.Diag(clang::diag::warn_drv_deprecated_arg)
711         << "-fsanitize-coverage=8bit-counters"
712         << "-fsanitize-coverage=trace-pc-guard";
713 
714   int InsertionPointTypes = CoverageFunc | CoverageBB | CoverageEdge;
715   int InstrumentationTypes = CoverageTracePC | CoverageTracePCGuard |
716                              CoverageInline8bitCounters |
717                              CoverageInlineBoolFlag;
718   if ((CoverageFeatures & InsertionPointTypes) &&
719       !(CoverageFeatures & InstrumentationTypes)) {
720     D.Diag(clang::diag::warn_drv_deprecated_arg)
721         << "-fsanitize-coverage=[func|bb|edge]"
722         << "-fsanitize-coverage=[func|bb|edge],[trace-pc-guard|trace-pc]";
723   }
724 
725   // trace-pc w/o func/bb/edge implies edge.
726   if (!(CoverageFeatures & InsertionPointTypes)) {
727     if (CoverageFeatures &
728         (CoverageTracePC | CoverageTracePCGuard | CoverageInline8bitCounters |
729          CoverageInlineBoolFlag))
730       CoverageFeatures |= CoverageEdge;
731 
732     if (CoverageFeatures & CoverageStackDepth)
733       CoverageFeatures |= CoverageFunc;
734   }
735 
736   // Parse -fsanitize-coverage-(black|white)list options if coverage enabled.
737   // This also validates special case lists format.
738   // Here, OptSpecifier() acts as a never-matching command-line argument.
739   // So, there is no way to clear coverage lists but you can append to them.
740   if (CoverageFeatures) {
741     parseSpecialCaseListArg(
742         D, Args, CoverageWhitelistFiles,
743         options::OPT_fsanitize_coverage_whitelist, OptSpecifier(),
744         clang::diag::err_drv_malformed_sanitizer_coverage_whitelist);
745     parseSpecialCaseListArg(
746         D, Args, CoverageBlacklistFiles,
747         options::OPT_fsanitize_coverage_blacklist, OptSpecifier(),
748         clang::diag::err_drv_malformed_sanitizer_coverage_blacklist);
749   }
750 
751   SharedRuntime =
752       Args.hasFlag(options::OPT_shared_libsan, options::OPT_static_libsan,
753                    TC.getTriple().isAndroid() || TC.getTriple().isOSFuchsia() ||
754                        TC.getTriple().isOSDarwin());
755 
756   ImplicitCfiRuntime = TC.getTriple().isAndroid();
757 
758   if (AllAddedKinds & SanitizerKind::Address) {
759     NeedPIE |= TC.getTriple().isOSFuchsia();
760     if (Arg *A =
761             Args.getLastArg(options::OPT_fsanitize_address_field_padding)) {
762         StringRef S = A->getValue();
763         // Legal values are 0 and 1, 2, but in future we may add more levels.
764         if (S.getAsInteger(0, AsanFieldPadding) || AsanFieldPadding < 0 ||
765             AsanFieldPadding > 2) {
766           D.Diag(clang::diag::err_drv_invalid_value) << A->getAsString(Args) << S;
767         }
768     }
769 
770     if (Arg *WindowsDebugRTArg =
771             Args.getLastArg(options::OPT__SLASH_MTd, options::OPT__SLASH_MT,
772                             options::OPT__SLASH_MDd, options::OPT__SLASH_MD,
773                             options::OPT__SLASH_LDd, options::OPT__SLASH_LD)) {
774       switch (WindowsDebugRTArg->getOption().getID()) {
775       case options::OPT__SLASH_MTd:
776       case options::OPT__SLASH_MDd:
777       case options::OPT__SLASH_LDd:
778         D.Diag(clang::diag::err_drv_argument_not_allowed_with)
779             << WindowsDebugRTArg->getAsString(Args)
780             << lastArgumentForMask(D, Args, SanitizerKind::Address);
781         D.Diag(clang::diag::note_drv_address_sanitizer_debug_runtime);
782       }
783     }
784 
785     AsanUseAfterScope = Args.hasFlag(
786         options::OPT_fsanitize_address_use_after_scope,
787         options::OPT_fno_sanitize_address_use_after_scope, AsanUseAfterScope);
788 
789     AsanPoisonCustomArrayCookie = Args.hasFlag(
790         options::OPT_fsanitize_address_poison_custom_array_cookie,
791         options::OPT_fno_sanitize_address_poison_custom_array_cookie,
792         AsanPoisonCustomArrayCookie);
793 
794     // As a workaround for a bug in gold 2.26 and earlier, dead stripping of
795     // globals in ASan is disabled by default on ELF targets.
796     // See https://sourceware.org/bugzilla/show_bug.cgi?id=19002
797     AsanGlobalsDeadStripping =
798         !TC.getTriple().isOSBinFormatELF() || TC.getTriple().isOSFuchsia() ||
799         TC.getTriple().isPS4() ||
800         Args.hasArg(options::OPT_fsanitize_address_globals_dead_stripping);
801 
802     AsanUseOdrIndicator =
803         Args.hasFlag(options::OPT_fsanitize_address_use_odr_indicator,
804                      options::OPT_fno_sanitize_address_use_odr_indicator,
805                      AsanUseOdrIndicator);
806 
807     if (AllAddedKinds & SanitizerKind::PointerCompare & ~AllRemove) {
808       AsanInvalidPointerCmp = true;
809     }
810 
811     if (AllAddedKinds & SanitizerKind::PointerSubtract & ~AllRemove) {
812       AsanInvalidPointerSub = true;
813     }
814 
815   } else {
816     AsanUseAfterScope = false;
817     // -fsanitize=pointer-compare/pointer-subtract requires -fsanitize=address.
818     SanitizerMask DetectInvalidPointerPairs =
819         SanitizerKind::PointerCompare | SanitizerKind::PointerSubtract;
820     if (AllAddedKinds & DetectInvalidPointerPairs & ~AllRemove) {
821       TC.getDriver().Diag(clang::diag::err_drv_argument_only_allowed_with)
822           << lastArgumentForMask(D, Args,
823                                  SanitizerKind::PointerCompare |
824                                      SanitizerKind::PointerSubtract)
825           << "-fsanitize=address";
826     }
827   }
828 
829   if (AllAddedKinds & SanitizerKind::HWAddress) {
830     if (Arg *HwasanAbiArg =
831             Args.getLastArg(options::OPT_fsanitize_hwaddress_abi_EQ)) {
832       HwasanAbi = HwasanAbiArg->getValue();
833       if (HwasanAbi != "platform" && HwasanAbi != "interceptor")
834         D.Diag(clang::diag::err_drv_invalid_value)
835             << HwasanAbiArg->getAsString(Args) << HwasanAbi;
836     } else {
837       HwasanAbi = "interceptor";
838     }
839   }
840 
841   if (AllAddedKinds & SanitizerKind::SafeStack) {
842     // SafeStack runtime is built into the system on Android and Fuchsia.
843     SafeStackRuntime =
844         !TC.getTriple().isAndroid() && !TC.getTriple().isOSFuchsia();
845   }
846 
847   LinkRuntimes =
848       Args.hasFlag(options::OPT_fsanitize_link_runtime,
849                    options::OPT_fno_sanitize_link_runtime, LinkRuntimes);
850 
851   // Parse -link-cxx-sanitizer flag.
852   LinkCXXRuntimes = Args.hasArg(options::OPT_fsanitize_link_cxx_runtime,
853                                 options::OPT_fno_sanitize_link_cxx_runtime,
854                                 LinkCXXRuntimes) ||
855                     D.CCCIsCXX();
856 
857   // Finally, initialize the set of available and recoverable sanitizers.
858   Sanitizers.Mask |= Kinds;
859   RecoverableSanitizers.Mask |= RecoverableKinds;
860   TrapSanitizers.Mask |= TrappingKinds;
861   assert(!(RecoverableKinds & TrappingKinds) &&
862          "Overlap between recoverable and trapping sanitizers");
863 }
864 
865 static std::string toString(const clang::SanitizerSet &Sanitizers) {
866   std::string Res;
867 #define SANITIZER(NAME, ID)                                                    \
868   if (Sanitizers.has(SanitizerKind::ID)) {                                     \
869     if (!Res.empty())                                                          \
870       Res += ",";                                                              \
871     Res += NAME;                                                               \
872   }
873 #include "clang/Basic/Sanitizers.def"
874   return Res;
875 }
876 
877 static void addSpecialCaseListOpt(const llvm::opt::ArgList &Args,
878                                   llvm::opt::ArgStringList &CmdArgs,
879                                   const char *SCLOptFlag,
880                                   const std::vector<std::string> &SCLFiles) {
881   for (const auto &SCLPath : SCLFiles) {
882     SmallString<64> SCLOpt(SCLOptFlag);
883     SCLOpt += SCLPath;
884     CmdArgs.push_back(Args.MakeArgString(SCLOpt));
885   }
886 }
887 
888 static void addIncludeLinkerOption(const ToolChain &TC,
889                                    const llvm::opt::ArgList &Args,
890                                    llvm::opt::ArgStringList &CmdArgs,
891                                    StringRef SymbolName) {
892   SmallString<64> LinkerOptionFlag;
893   LinkerOptionFlag = "--linker-option=/include:";
894   if (TC.getTriple().getArch() == llvm::Triple::x86) {
895     // Win32 mangles C function names with a '_' prefix.
896     LinkerOptionFlag += '_';
897   }
898   LinkerOptionFlag += SymbolName;
899   CmdArgs.push_back(Args.MakeArgString(LinkerOptionFlag));
900 }
901 
902 static bool hasTargetFeatureMTE(const llvm::opt::ArgStringList &CmdArgs) {
903   for (auto Start = CmdArgs.begin(), End = CmdArgs.end(); Start != End; ++Start) {
904     auto It = std::find(Start, End, StringRef("+mte"));
905     if (It == End)
906       break;
907     if (It > Start && *std::prev(It) == StringRef("-target-feature"))
908       return true;
909     Start = It;
910   }
911   return false;
912 }
913 
914 void SanitizerArgs::addArgs(const ToolChain &TC, const llvm::opt::ArgList &Args,
915                             llvm::opt::ArgStringList &CmdArgs,
916                             types::ID InputType) const {
917   // NVPTX doesn't currently support sanitizers.  Bailing out here means that
918   // e.g. -fsanitize=address applies only to host code, which is what we want
919   // for now.
920   if (TC.getTriple().isNVPTX())
921     return;
922 
923   // Translate available CoverageFeatures to corresponding clang-cc1 flags.
924   // Do it even if Sanitizers.empty() since some forms of coverage don't require
925   // sanitizers.
926   std::pair<int, const char *> CoverageFlags[] = {
927       std::make_pair(CoverageFunc, "-fsanitize-coverage-type=1"),
928       std::make_pair(CoverageBB, "-fsanitize-coverage-type=2"),
929       std::make_pair(CoverageEdge, "-fsanitize-coverage-type=3"),
930       std::make_pair(CoverageIndirCall, "-fsanitize-coverage-indirect-calls"),
931       std::make_pair(CoverageTraceBB, "-fsanitize-coverage-trace-bb"),
932       std::make_pair(CoverageTraceCmp, "-fsanitize-coverage-trace-cmp"),
933       std::make_pair(CoverageTraceDiv, "-fsanitize-coverage-trace-div"),
934       std::make_pair(CoverageTraceGep, "-fsanitize-coverage-trace-gep"),
935       std::make_pair(Coverage8bitCounters, "-fsanitize-coverage-8bit-counters"),
936       std::make_pair(CoverageTracePC, "-fsanitize-coverage-trace-pc"),
937       std::make_pair(CoverageTracePCGuard,
938                      "-fsanitize-coverage-trace-pc-guard"),
939       std::make_pair(CoverageInline8bitCounters,
940                      "-fsanitize-coverage-inline-8bit-counters"),
941       std::make_pair(CoverageInlineBoolFlag,
942                      "-fsanitize-coverage-inline-bool-flag"),
943       std::make_pair(CoveragePCTable, "-fsanitize-coverage-pc-table"),
944       std::make_pair(CoverageNoPrune, "-fsanitize-coverage-no-prune"),
945       std::make_pair(CoverageStackDepth, "-fsanitize-coverage-stack-depth")};
946   for (auto F : CoverageFlags) {
947     if (CoverageFeatures & F.first)
948       CmdArgs.push_back(F.second);
949   }
950   addSpecialCaseListOpt(
951       Args, CmdArgs, "-fsanitize-coverage-whitelist=", CoverageWhitelistFiles);
952   addSpecialCaseListOpt(
953       Args, CmdArgs, "-fsanitize-coverage-blacklist=", CoverageBlacklistFiles);
954 
955   if (TC.getTriple().isOSWindows() && needsUbsanRt()) {
956     // Instruct the code generator to embed linker directives in the object file
957     // that cause the required runtime libraries to be linked.
958     CmdArgs.push_back(Args.MakeArgString(
959         "--dependent-lib=" + TC.getCompilerRT(Args, "ubsan_standalone")));
960     if (types::isCXX(InputType))
961       CmdArgs.push_back(Args.MakeArgString(
962           "--dependent-lib=" + TC.getCompilerRT(Args, "ubsan_standalone_cxx")));
963   }
964   if (TC.getTriple().isOSWindows() && needsStatsRt()) {
965     CmdArgs.push_back(Args.MakeArgString("--dependent-lib=" +
966                                          TC.getCompilerRT(Args, "stats_client")));
967 
968     // The main executable must export the stats runtime.
969     // FIXME: Only exporting from the main executable (e.g. based on whether the
970     // translation unit defines main()) would save a little space, but having
971     // multiple copies of the runtime shouldn't hurt.
972     CmdArgs.push_back(Args.MakeArgString("--dependent-lib=" +
973                                          TC.getCompilerRT(Args, "stats")));
974     addIncludeLinkerOption(TC, Args, CmdArgs, "__sanitizer_stats_register");
975   }
976 
977   if (Sanitizers.empty())
978     return;
979   CmdArgs.push_back(Args.MakeArgString("-fsanitize=" + toString(Sanitizers)));
980 
981   if (!RecoverableSanitizers.empty())
982     CmdArgs.push_back(Args.MakeArgString("-fsanitize-recover=" +
983                                          toString(RecoverableSanitizers)));
984 
985   if (!TrapSanitizers.empty())
986     CmdArgs.push_back(
987         Args.MakeArgString("-fsanitize-trap=" + toString(TrapSanitizers)));
988 
989   addSpecialCaseListOpt(Args, CmdArgs,
990                         "-fsanitize-blacklist=", UserBlacklistFiles);
991   addSpecialCaseListOpt(Args, CmdArgs,
992                         "-fsanitize-system-blacklist=", SystemBlacklistFiles);
993 
994   if (MsanTrackOrigins)
995     CmdArgs.push_back(Args.MakeArgString("-fsanitize-memory-track-origins=" +
996                                          Twine(MsanTrackOrigins)));
997 
998   if (MsanUseAfterDtor)
999     CmdArgs.push_back("-fsanitize-memory-use-after-dtor");
1000 
1001   // FIXME: Pass these parameters as function attributes, not as -llvm flags.
1002   if (!TsanMemoryAccess) {
1003     CmdArgs.push_back("-mllvm");
1004     CmdArgs.push_back("-tsan-instrument-memory-accesses=0");
1005     CmdArgs.push_back("-mllvm");
1006     CmdArgs.push_back("-tsan-instrument-memintrinsics=0");
1007   }
1008   if (!TsanFuncEntryExit) {
1009     CmdArgs.push_back("-mllvm");
1010     CmdArgs.push_back("-tsan-instrument-func-entry-exit=0");
1011   }
1012   if (!TsanAtomics) {
1013     CmdArgs.push_back("-mllvm");
1014     CmdArgs.push_back("-tsan-instrument-atomics=0");
1015   }
1016 
1017   if (CfiCrossDso)
1018     CmdArgs.push_back("-fsanitize-cfi-cross-dso");
1019 
1020   if (CfiICallGeneralizePointers)
1021     CmdArgs.push_back("-fsanitize-cfi-icall-generalize-pointers");
1022 
1023   if (CfiCanonicalJumpTables)
1024     CmdArgs.push_back("-fsanitize-cfi-canonical-jump-tables");
1025 
1026   if (Stats)
1027     CmdArgs.push_back("-fsanitize-stats");
1028 
1029   if (MinimalRuntime)
1030     CmdArgs.push_back("-fsanitize-minimal-runtime");
1031 
1032   if (AsanFieldPadding)
1033     CmdArgs.push_back(Args.MakeArgString("-fsanitize-address-field-padding=" +
1034                                          Twine(AsanFieldPadding)));
1035 
1036   if (AsanUseAfterScope)
1037     CmdArgs.push_back("-fsanitize-address-use-after-scope");
1038 
1039   if (AsanPoisonCustomArrayCookie)
1040     CmdArgs.push_back("-fsanitize-address-poison-custom-array-cookie");
1041 
1042   if (AsanGlobalsDeadStripping)
1043     CmdArgs.push_back("-fsanitize-address-globals-dead-stripping");
1044 
1045   if (AsanUseOdrIndicator)
1046     CmdArgs.push_back("-fsanitize-address-use-odr-indicator");
1047 
1048   if (AsanInvalidPointerCmp) {
1049     CmdArgs.push_back("-mllvm");
1050     CmdArgs.push_back("-asan-detect-invalid-pointer-cmp");
1051   }
1052 
1053   if (AsanInvalidPointerSub) {
1054     CmdArgs.push_back("-mllvm");
1055     CmdArgs.push_back("-asan-detect-invalid-pointer-sub");
1056   }
1057 
1058   if (!HwasanAbi.empty()) {
1059     CmdArgs.push_back("-default-function-attr");
1060     CmdArgs.push_back(Args.MakeArgString("hwasan-abi=" + HwasanAbi));
1061   }
1062 
1063   if (Sanitizers.has(SanitizerKind::HWAddress)) {
1064     CmdArgs.push_back("-target-feature");
1065     CmdArgs.push_back("+tagged-globals");
1066   }
1067 
1068   // MSan: Workaround for PR16386.
1069   // ASan: This is mainly to help LSan with cases such as
1070   // https://github.com/google/sanitizers/issues/373
1071   // We can't make this conditional on -fsanitize=leak, as that flag shouldn't
1072   // affect compilation.
1073   if (Sanitizers.has(SanitizerKind::Memory) ||
1074       Sanitizers.has(SanitizerKind::Address))
1075     CmdArgs.push_back("-fno-assume-sane-operator-new");
1076 
1077   // Require -fvisibility= flag on non-Windows when compiling if vptr CFI is
1078   // enabled.
1079   if (Sanitizers.hasOneOf(CFIClasses) && !TC.getTriple().isOSWindows() &&
1080       !Args.hasArg(options::OPT_fvisibility_EQ)) {
1081     TC.getDriver().Diag(clang::diag::err_drv_argument_only_allowed_with)
1082         << lastArgumentForMask(TC.getDriver(), Args,
1083                                Sanitizers.Mask & CFIClasses)
1084         << "-fvisibility=";
1085   }
1086 
1087   if (Sanitizers.has(SanitizerKind::MemTag) && !hasTargetFeatureMTE(CmdArgs))
1088     TC.getDriver().Diag(diag::err_stack_tagging_requires_hardware_feature);
1089 }
1090 
1091 SanitizerMask parseArgValues(const Driver &D, const llvm::opt::Arg *A,
1092                              bool DiagnoseErrors) {
1093   assert((A->getOption().matches(options::OPT_fsanitize_EQ) ||
1094           A->getOption().matches(options::OPT_fno_sanitize_EQ) ||
1095           A->getOption().matches(options::OPT_fsanitize_recover_EQ) ||
1096           A->getOption().matches(options::OPT_fno_sanitize_recover_EQ) ||
1097           A->getOption().matches(options::OPT_fsanitize_trap_EQ) ||
1098           A->getOption().matches(options::OPT_fno_sanitize_trap_EQ)) &&
1099          "Invalid argument in parseArgValues!");
1100   SanitizerMask Kinds;
1101   for (int i = 0, n = A->getNumValues(); i != n; ++i) {
1102     const char *Value = A->getValue(i);
1103     SanitizerMask Kind;
1104     // Special case: don't accept -fsanitize=all.
1105     if (A->getOption().matches(options::OPT_fsanitize_EQ) &&
1106         0 == strcmp("all", Value))
1107       Kind = SanitizerMask();
1108     else
1109       Kind = parseSanitizerValue(Value, /*AllowGroups=*/true);
1110 
1111     if (Kind)
1112       Kinds |= Kind;
1113     else if (DiagnoseErrors)
1114       D.Diag(clang::diag::err_drv_unsupported_option_argument)
1115           << A->getOption().getName() << Value;
1116   }
1117   return Kinds;
1118 }
1119 
1120 int parseCoverageFeatures(const Driver &D, const llvm::opt::Arg *A) {
1121   assert(A->getOption().matches(options::OPT_fsanitize_coverage) ||
1122          A->getOption().matches(options::OPT_fno_sanitize_coverage));
1123   int Features = 0;
1124   for (int i = 0, n = A->getNumValues(); i != n; ++i) {
1125     const char *Value = A->getValue(i);
1126     int F = llvm::StringSwitch<int>(Value)
1127                 .Case("func", CoverageFunc)
1128                 .Case("bb", CoverageBB)
1129                 .Case("edge", CoverageEdge)
1130                 .Case("indirect-calls", CoverageIndirCall)
1131                 .Case("trace-bb", CoverageTraceBB)
1132                 .Case("trace-cmp", CoverageTraceCmp)
1133                 .Case("trace-div", CoverageTraceDiv)
1134                 .Case("trace-gep", CoverageTraceGep)
1135                 .Case("8bit-counters", Coverage8bitCounters)
1136                 .Case("trace-pc", CoverageTracePC)
1137                 .Case("trace-pc-guard", CoverageTracePCGuard)
1138                 .Case("no-prune", CoverageNoPrune)
1139                 .Case("inline-8bit-counters", CoverageInline8bitCounters)
1140                 .Case("inline-bool-flag", CoverageInlineBoolFlag)
1141                 .Case("pc-table", CoveragePCTable)
1142                 .Case("stack-depth", CoverageStackDepth)
1143                 .Default(0);
1144     if (F == 0)
1145       D.Diag(clang::diag::err_drv_unsupported_option_argument)
1146           << A->getOption().getName() << Value;
1147     Features |= F;
1148   }
1149   return Features;
1150 }
1151 
1152 std::string lastArgumentForMask(const Driver &D, const llvm::opt::ArgList &Args,
1153                                 SanitizerMask Mask) {
1154   for (llvm::opt::ArgList::const_reverse_iterator I = Args.rbegin(),
1155                                                   E = Args.rend();
1156        I != E; ++I) {
1157     const auto *Arg = *I;
1158     if (Arg->getOption().matches(options::OPT_fsanitize_EQ)) {
1159       SanitizerMask AddKinds =
1160           expandSanitizerGroups(parseArgValues(D, Arg, false));
1161       if (AddKinds & Mask)
1162         return describeSanitizeArg(Arg, Mask);
1163     } else if (Arg->getOption().matches(options::OPT_fno_sanitize_EQ)) {
1164       SanitizerMask RemoveKinds =
1165           expandSanitizerGroups(parseArgValues(D, Arg, false));
1166       Mask &= ~RemoveKinds;
1167     }
1168   }
1169   llvm_unreachable("arg list didn't provide expected value");
1170 }
1171 
1172 std::string describeSanitizeArg(const llvm::opt::Arg *A, SanitizerMask Mask) {
1173   assert(A->getOption().matches(options::OPT_fsanitize_EQ)
1174          && "Invalid argument in describeSanitizerArg!");
1175 
1176   std::string Sanitizers;
1177   for (int i = 0, n = A->getNumValues(); i != n; ++i) {
1178     if (expandSanitizerGroups(
1179             parseSanitizerValue(A->getValue(i), /*AllowGroups=*/true)) &
1180         Mask) {
1181       if (!Sanitizers.empty())
1182         Sanitizers += ",";
1183       Sanitizers += A->getValue(i);
1184     }
1185   }
1186 
1187   assert(!Sanitizers.empty() && "arg didn't provide expected value");
1188   return "-fsanitize=" + Sanitizers;
1189 }
1190