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