blob: cd3785cd90b9d6d5d59a29340aacdb5e27ba1a22 [file] [log] [blame]
Alexey Samsonov442c60a2013-08-08 10:11:02 +00001//===--- SanitizerArgs.cpp - Arguments for sanitizer tools ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
Alexey Samsonov1b8f12d2013-08-19 09:14:21 +00009#include "clang/Driver/SanitizerArgs.h"
Alexey Samsonov442c60a2013-08-08 10:11:02 +000010#include "clang/Driver/Driver.h"
11#include "clang/Driver/DriverDiagnostic.h"
12#include "clang/Driver/Options.h"
13#include "clang/Driver/ToolChain.h"
Stephen Hines651f13c2014-04-23 16:59:28 -070014#include "llvm/ADT/StringExtras.h"
Alexey Samsonov442c60a2013-08-08 10:11:02 +000015#include "llvm/ADT/StringSwitch.h"
16#include "llvm/Support/FileSystem.h"
17#include "llvm/Support/Path.h"
Stephen Hinesc568f1e2014-07-21 00:47:37 -070018#include "llvm/Support/SpecialCaseList.h"
Stephen Hines651f13c2014-04-23 16:59:28 -070019#include <memory>
Alexey Samsonov442c60a2013-08-08 10:11:02 +000020
21using namespace clang::driver;
22using namespace llvm::opt;
23
Stephen Hines176edba2014-12-01 14:53:08 -080024namespace {
25/// Assign ordinals to possible values of -fsanitize= flag.
26/// We use the ordinal values as bit positions within \c SanitizeKind.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070027enum SanitizeOrdinal : uint64_t {
Stephen Hines176edba2014-12-01 14:53:08 -080028#define SANITIZER(NAME, ID) SO_##ID,
29#define SANITIZER_GROUP(NAME, ID, ALIAS) SO_##ID##Group,
30#include "clang/Basic/Sanitizers.def"
31 SO_Count
32};
33
34/// Represents a set of sanitizer kinds. It is also used to define:
35/// 1) set of sanitizers each sanitizer group expands into.
36/// 2) set of sanitizers sharing a specific property (e.g.
37/// all sanitizers with zero-base shadow).
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070038enum SanitizeKind : uint64_t {
39#define SANITIZER(NAME, ID) ID = 1ULL << SO_##ID,
Stephen Hines176edba2014-12-01 14:53:08 -080040#define SANITIZER_GROUP(NAME, ID, ALIAS) \
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070041 ID = ALIAS, ID##Group = 1ULL << SO_##ID##Group,
Stephen Hines176edba2014-12-01 14:53:08 -080042#include "clang/Basic/Sanitizers.def"
43 NeedsUbsanRt = Undefined | Integer,
44 NotAllowedWithTrap = Vptr,
Stephen Hines0e2c34f2015-03-23 12:09:02 -070045 RequiresPIE = Memory | DataFlow,
46 NeedsUnwindTables = Address | Thread | Memory | DataFlow,
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070047 SupportsCoverage = Address | Memory | Leak | Undefined | Integer | DataFlow,
Stephen Hines0e2c34f2015-03-23 12:09:02 -070048 RecoverableByDefault = Undefined | Integer,
49 Unrecoverable = Address | Unreachable | Return,
50 LegacyFsanitizeRecoverMask = Undefined | Integer,
Pirama Arumuga Nainar33337ca2015-05-06 11:48:57 -070051 NeedsLTO = CFI,
Stephen Hines176edba2014-12-01 14:53:08 -080052};
53}
54
55/// Returns true if set of \p Sanitizers contain at least one sanitizer from
56/// \p Kinds.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070057static bool hasOneOf(const clang::SanitizerSet &Sanitizers, uint64_t Kinds) {
Stephen Hines176edba2014-12-01 14:53:08 -080058#define SANITIZER(NAME, ID) \
59 if (Sanitizers.has(clang::SanitizerKind::ID) && (Kinds & ID)) \
60 return true;
61#include "clang/Basic/Sanitizers.def"
62 return false;
63}
64
65/// Adds all sanitizers from \p Kinds to \p Sanitizers.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070066static void addAllOf(clang::SanitizerSet &Sanitizers, uint64_t Kinds) {
Stephen Hines176edba2014-12-01 14:53:08 -080067#define SANITIZER(NAME, ID) \
68 if (Kinds & ID) \
69 Sanitizers.set(clang::SanitizerKind::ID, true);
70#include "clang/Basic/Sanitizers.def"
71}
72
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070073static uint64_t toSanitizeKind(clang::SanitizerKind K) {
Stephen Hines176edba2014-12-01 14:53:08 -080074#define SANITIZER(NAME, ID) \
75 if (K == clang::SanitizerKind::ID) \
76 return ID;
77#include "clang/Basic/Sanitizers.def"
78 llvm_unreachable("Invalid SanitizerKind!");
79}
80
81/// Parse a single value from a -fsanitize= or -fno-sanitize= value list.
82/// Returns a member of the \c SanitizeKind enumeration, or \c 0
83/// if \p Value is not known.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070084static uint64_t parseValue(const char *Value);
Stephen Hines176edba2014-12-01 14:53:08 -080085
86/// Parse a -fsanitize= or -fno-sanitize= argument's values, diagnosing any
87/// invalid components. Returns OR of members of \c SanitizeKind enumeration.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070088static uint64_t parseArgValues(const Driver &D, const llvm::opt::Arg *A,
Stephen Hines176edba2014-12-01 14:53:08 -080089 bool DiagnoseErrors);
90
Stephen Hines176edba2014-12-01 14:53:08 -080091/// Produce an argument string from ArgList \p Args, which shows how it
92/// provides some sanitizer kind from \p Mask. For example, the argument list
93/// "-fsanitize=thread,vptr -fsanitize=address" with mask \c NeedsUbsanRt
94/// would produce "-fsanitize=vptr".
95static std::string lastArgumentForMask(const Driver &D,
96 const llvm::opt::ArgList &Args,
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070097 uint64_t Mask);
Stephen Hines176edba2014-12-01 14:53:08 -080098
99static std::string lastArgumentForKind(const Driver &D,
100 const llvm::opt::ArgList &Args,
101 clang::SanitizerKind K) {
102 return lastArgumentForMask(D, Args, toSanitizeKind(K));
103}
104
105/// Produce an argument string from argument \p A, which shows how it provides
106/// a value in \p Mask. For instance, the argument
107/// "-fsanitize=address,alignment" with mask \c NeedsUbsanRt would produce
108/// "-fsanitize=alignment".
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700109static std::string describeSanitizeArg(const llvm::opt::Arg *A, uint64_t Mask);
Stephen Hines176edba2014-12-01 14:53:08 -0800110
111/// Produce a string containing comma-separated names of sanitizers in \p
112/// Sanitizers set.
113static std::string toString(const clang::SanitizerSet &Sanitizers);
114
115/// For each sanitizer group bit set in \p Kinds, set the bits for sanitizers
116/// this group enables.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700117static uint64_t expandGroups(uint64_t Kinds);
Stephen Hines176edba2014-12-01 14:53:08 -0800118
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700119static uint64_t getToolchainUnsupportedKinds(const ToolChain &TC) {
Stephen Hines176edba2014-12-01 14:53:08 -0800120 bool IsFreeBSD = TC.getTriple().getOS() == llvm::Triple::FreeBSD;
121 bool IsLinux = TC.getTriple().getOS() == llvm::Triple::Linux;
122 bool IsX86 = TC.getTriple().getArch() == llvm::Triple::x86;
123 bool IsX86_64 = TC.getTriple().getArch() == llvm::Triple::x86_64;
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700124 bool IsMIPS64 = TC.getTriple().getArch() == llvm::Triple::mips64 ||
125 TC.getTriple().getArch() == llvm::Triple::mips64el;
Stephen Hines176edba2014-12-01 14:53:08 -0800126
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700127 uint64_t Unsupported = 0;
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700128 if (!(IsLinux && (IsX86_64 || IsMIPS64))) {
Stephen Hines176edba2014-12-01 14:53:08 -0800129 Unsupported |= Memory | DataFlow;
130 }
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700131 if (!((IsLinux || IsFreeBSD) && (IsX86_64 || IsMIPS64))) {
Stephen Hines176edba2014-12-01 14:53:08 -0800132 Unsupported |= Thread;
133 }
134 if (!(IsLinux && (IsX86 || IsX86_64))) {
135 Unsupported |= Function;
136 }
137 return Unsupported;
138}
139
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700140static bool getDefaultBlacklist(const Driver &D, uint64_t Kinds,
141 std::string &BLPath) {
142 const char *BlacklistFile = nullptr;
143 if (Kinds & SanitizeKind::Address)
144 BlacklistFile = "asan_blacklist.txt";
145 else if (Kinds & SanitizeKind::Memory)
146 BlacklistFile = "msan_blacklist.txt";
147 else if (Kinds & SanitizeKind::Thread)
148 BlacklistFile = "tsan_blacklist.txt";
149 else if (Kinds & SanitizeKind::DataFlow)
150 BlacklistFile = "dfsan_abilist.txt";
151
152 if (BlacklistFile) {
153 clang::SmallString<64> Path(D.ResourceDir);
154 llvm::sys::path::append(Path, BlacklistFile);
155 BLPath = Path.str();
156 return true;
157 }
158 return false;
159}
160
Stephen Hines176edba2014-12-01 14:53:08 -0800161bool SanitizerArgs::needsUbsanRt() const {
Pirama Arumuga Nainar33337ca2015-05-06 11:48:57 -0700162 return !UbsanTrapOnError && hasOneOf(Sanitizers, NeedsUbsanRt) &&
163 !Sanitizers.has(SanitizerKind::Address);
Stephen Hines176edba2014-12-01 14:53:08 -0800164}
165
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700166bool SanitizerArgs::requiresPIE() const {
167 return AsanZeroBaseShadow || hasOneOf(Sanitizers, RequiresPIE);
Stephen Hines176edba2014-12-01 14:53:08 -0800168}
169
170bool SanitizerArgs::needsUnwindTables() const {
171 return hasOneOf(Sanitizers, NeedsUnwindTables);
172}
173
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700174bool SanitizerArgs::needsLTO() const {
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700175 return hasOneOf(Sanitizers, NeedsLTO);
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700176}
177
Alexey Samsonov1e9fdc12013-08-08 11:32:17 +0000178void SanitizerArgs::clear() {
Stephen Hines176edba2014-12-01 14:53:08 -0800179 Sanitizers.clear();
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700180 RecoverableSanitizers.clear();
181 BlacklistFiles.clear();
Stephen Hines176edba2014-12-01 14:53:08 -0800182 SanitizeCoverage = 0;
Stephen Hines651f13c2014-04-23 16:59:28 -0700183 MsanTrackOrigins = 0;
Stephen Hines176edba2014-12-01 14:53:08 -0800184 AsanFieldPadding = 0;
Peter Collingbournec6911a22013-11-01 18:16:25 +0000185 AsanZeroBaseShadow = false;
Alexey Samsonov1e9fdc12013-08-08 11:32:17 +0000186 UbsanTrapOnError = false;
Stephen Hines651f13c2014-04-23 16:59:28 -0700187 AsanSharedRuntime = false;
Stephen Hines176edba2014-12-01 14:53:08 -0800188 LinkCXXRuntimes = false;
Alexey Samsonov1e9fdc12013-08-08 11:32:17 +0000189}
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000190
Peter Collingbournec6911a22013-11-01 18:16:25 +0000191SanitizerArgs::SanitizerArgs(const ToolChain &TC,
192 const llvm::opt::ArgList &Args) {
Alexey Samsonov1e9fdc12013-08-08 11:32:17 +0000193 clear();
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700194 uint64_t AllRemove = 0; // During the loop below, the accumulated set of
Peter Collingbournec6911a22013-11-01 18:16:25 +0000195 // sanitizers disabled by the current sanitizer
196 // argument or any argument after it.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700197 uint64_t DiagnosedKinds = 0; // All Kinds we have diagnosed up to now.
Peter Collingbournec6911a22013-11-01 18:16:25 +0000198 // Used to deduplicate diagnostics.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700199 uint64_t Kinds = 0;
200 uint64_t NotSupported = getToolchainUnsupportedKinds(TC);
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700201 ToolChain::RTTIMode RTTIMode = TC.getRTTIMode();
202
Peter Collingbournec6911a22013-11-01 18:16:25 +0000203 const Driver &D = TC.getDriver();
204 for (ArgList::const_reverse_iterator I = Args.rbegin(), E = Args.rend();
205 I != E; ++I) {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700206 const auto *Arg = *I;
207 if (Arg->getOption().matches(options::OPT_fsanitize_EQ)) {
208 Arg->claim();
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700209 uint64_t Add = parseArgValues(D, Arg, true);
Peter Collingbournec6911a22013-11-01 18:16:25 +0000210
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700211 // Avoid diagnosing any sanitizer which is disabled later.
212 Add &= ~AllRemove;
213 // At this point we have not expanded groups, so any unsupported
214 // sanitizers in Add are those which have been explicitly enabled.
215 // Diagnose them.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700216 if (uint64_t KindsToDiagnose = Add & NotSupported & ~DiagnosedKinds) {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700217 // Only diagnose the new kinds.
218 std::string Desc = describeSanitizeArg(*I, KindsToDiagnose);
219 D.Diag(diag::err_drv_unsupported_opt_for_target)
220 << Desc << TC.getTriple().str();
221 DiagnosedKinds |= KindsToDiagnose;
222 }
223 Add &= ~NotSupported;
Peter Collingbournec6911a22013-11-01 18:16:25 +0000224
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700225 // Test for -fno-rtti + explicit -fsanitizer=vptr before expanding groups
226 // so we don't error out if -fno-rtti and -fsanitize=undefined were
227 // passed.
228 if (Add & SanitizeKind::Vptr &&
229 (RTTIMode == ToolChain::RM_DisabledImplicitly ||
230 RTTIMode == ToolChain::RM_DisabledExplicitly)) {
231 if (RTTIMode == ToolChain::RM_DisabledImplicitly)
232 // Warn about not having rtti enabled if the vptr sanitizer is
233 // explicitly enabled
234 D.Diag(diag::warn_drv_disabling_vptr_no_rtti_default);
235 else {
236 const llvm::opt::Arg *NoRTTIArg = TC.getRTTIArg();
237 assert(NoRTTIArg &&
238 "RTTI disabled explicitly but we have no argument!");
239 D.Diag(diag::err_drv_argument_not_allowed_with)
240 << "-fsanitize=vptr" << NoRTTIArg->getAsString(Args);
241 }
Stephen Hines176edba2014-12-01 14:53:08 -0800242
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700243 // Take out the Vptr sanitizer from the enabled sanitizers
244 AllRemove |= SanitizeKind::Vptr;
245 }
246
247 Add = expandGroups(Add);
248 // Group expansion may have enabled a sanitizer which is disabled later.
249 Add &= ~AllRemove;
250 // Silently discard any unsupported sanitizers implicitly enabled through
251 // group expansion.
252 Add &= ~NotSupported;
253
254 Kinds |= Add;
255 } else if (Arg->getOption().matches(options::OPT_fno_sanitize_EQ)) {
256 Arg->claim();
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700257 uint64_t Remove = parseArgValues(D, Arg, true);
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700258 AllRemove |= expandGroups(Remove);
Stephen Hines176edba2014-12-01 14:53:08 -0800259 }
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000260 }
Stephen Hines176edba2014-12-01 14:53:08 -0800261
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700262 // We disable the vptr sanitizer if it was enabled by group expansion but RTTI
263 // is disabled.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700264 if ((Kinds & SanitizeKind::Vptr) &&
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700265 (RTTIMode == ToolChain::RM_DisabledImplicitly ||
266 RTTIMode == ToolChain::RM_DisabledExplicitly)) {
267 Kinds &= ~SanitizeKind::Vptr;
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700268 }
269
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700270 // Warn about undefined sanitizer options that require runtime support.
271 UbsanTrapOnError =
272 Args.hasFlag(options::OPT_fsanitize_undefined_trap_on_error,
273 options::OPT_fno_sanitize_undefined_trap_on_error, false);
274 if (UbsanTrapOnError && (Kinds & SanitizeKind::NotAllowedWithTrap)) {
275 D.Diag(clang::diag::err_drv_argument_not_allowed_with)
276 << lastArgumentForMask(D, Args, NotAllowedWithTrap)
277 << "-fsanitize-undefined-trap-on-error";
278 Kinds &= ~SanitizeKind::NotAllowedWithTrap;
279 }
280
281 // Warn about incompatible groups of sanitizers.
282 std::pair<uint64_t, uint64_t> IncompatibleGroups[] = {
283 std::make_pair(SanitizeKind::Address, SanitizeKind::Thread),
284 std::make_pair(SanitizeKind::Address, SanitizeKind::Memory),
285 std::make_pair(SanitizeKind::Thread, SanitizeKind::Memory),
286 std::make_pair(SanitizeKind::Leak, SanitizeKind::Thread),
287 std::make_pair(SanitizeKind::Leak, SanitizeKind::Memory),
288 std::make_pair(SanitizeKind::NeedsUbsanRt, SanitizeKind::Thread),
289 std::make_pair(SanitizeKind::NeedsUbsanRt, SanitizeKind::Memory)};
290 for (auto G : IncompatibleGroups) {
291 uint64_t Group = G.first;
292 if (Kinds & Group) {
293 if (uint64_t Incompatible = Kinds & G.second) {
294 D.Diag(clang::diag::err_drv_argument_not_allowed_with)
295 << lastArgumentForMask(D, Args, Group)
296 << lastArgumentForMask(D, Args, Incompatible);
297 Kinds &= ~Incompatible;
298 }
299 }
300 }
301 // FIXME: Currently -fsanitize=leak is silently ignored in the presence of
302 // -fsanitize=address. Perhaps it should print an error, or perhaps
303 // -f(-no)sanitize=leak should change whether leak detection is enabled by
304 // default in ASan?
305
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700306 // Parse -f(no-)?sanitize-recover flags.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700307 uint64_t RecoverableKinds = RecoverableByDefault;
308 uint64_t DiagnosedUnrecoverableKinds = 0;
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700309 for (const auto *Arg : Args) {
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700310 const char *DeprecatedReplacement = nullptr;
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700311 if (Arg->getOption().matches(options::OPT_fsanitize_recover)) {
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700312 DeprecatedReplacement = "-fsanitize-recover=undefined,integer";
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700313 RecoverableKinds |= expandGroups(LegacyFsanitizeRecoverMask);
314 Arg->claim();
315 } else if (Arg->getOption().matches(options::OPT_fno_sanitize_recover)) {
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700316 DeprecatedReplacement = "-fno-sanitize-recover=undefined,integer";
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700317 RecoverableKinds &= ~expandGroups(LegacyFsanitizeRecoverMask);
318 Arg->claim();
319 } else if (Arg->getOption().matches(options::OPT_fsanitize_recover_EQ)) {
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700320 uint64_t Add = parseArgValues(D, Arg, true);
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700321 // Report error if user explicitly tries to recover from unrecoverable
322 // sanitizer.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700323 if (uint64_t KindsToDiagnose =
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700324 Add & Unrecoverable & ~DiagnosedUnrecoverableKinds) {
325 SanitizerSet SetToDiagnose;
326 addAllOf(SetToDiagnose, KindsToDiagnose);
327 D.Diag(diag::err_drv_unsupported_option_argument)
328 << Arg->getOption().getName() << toString(SetToDiagnose);
329 DiagnosedUnrecoverableKinds |= KindsToDiagnose;
330 }
331 RecoverableKinds |= expandGroups(Add);
332 Arg->claim();
333 } else if (Arg->getOption().matches(options::OPT_fno_sanitize_recover_EQ)) {
334 RecoverableKinds &= ~expandGroups(parseArgValues(D, Arg, true));
335 Arg->claim();
336 }
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700337 if (DeprecatedReplacement) {
338 D.Diag(diag::warn_drv_deprecated_arg) << Arg->getAsString(Args)
339 << DeprecatedReplacement;
340 }
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700341 }
342 RecoverableKinds &= Kinds;
343 RecoverableKinds &= ~Unrecoverable;
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000344
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700345 // Setup blacklist files.
346 // Add default blacklist from resource directory.
347 {
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000348 std::string BLPath;
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700349 if (getDefaultBlacklist(D, Kinds, BLPath) && llvm::sys::fs::exists(BLPath))
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700350 BlacklistFiles.push_back(BLPath);
351 }
352 // Parse -f(no-)sanitize-blacklist options.
353 for (const auto *Arg : Args) {
354 if (Arg->getOption().matches(options::OPT_fsanitize_blacklist)) {
355 Arg->claim();
356 std::string BLPath = Arg->getValue();
357 if (llvm::sys::fs::exists(BLPath))
358 BlacklistFiles.push_back(BLPath);
359 else
360 D.Diag(clang::diag::err_drv_no_such_file) << BLPath;
361 } else if (Arg->getOption().matches(options::OPT_fno_sanitize_blacklist)) {
362 Arg->claim();
363 BlacklistFiles.clear();
364 }
365 }
366 // Validate blacklists format.
367 {
368 std::string BLError;
369 std::unique_ptr<llvm::SpecialCaseList> SCL(
370 llvm::SpecialCaseList::create(BlacklistFiles, BLError));
371 if (!SCL.get())
372 D.Diag(clang::diag::err_drv_malformed_sanitizer_blacklist) << BLError;
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000373 }
374
Stephen Hines651f13c2014-04-23 16:59:28 -0700375 // Parse -f[no-]sanitize-memory-track-origins[=level] options.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700376 if (Kinds & SanitizeKind::Memory) {
Stephen Hines651f13c2014-04-23 16:59:28 -0700377 if (Arg *A =
378 Args.getLastArg(options::OPT_fsanitize_memory_track_origins_EQ,
379 options::OPT_fsanitize_memory_track_origins,
380 options::OPT_fno_sanitize_memory_track_origins)) {
381 if (A->getOption().matches(options::OPT_fsanitize_memory_track_origins)) {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700382 MsanTrackOrigins = 2;
Stephen Hines651f13c2014-04-23 16:59:28 -0700383 } else if (A->getOption().matches(
384 options::OPT_fno_sanitize_memory_track_origins)) {
385 MsanTrackOrigins = 0;
386 } else {
387 StringRef S = A->getValue();
388 if (S.getAsInteger(0, MsanTrackOrigins) || MsanTrackOrigins < 0 ||
389 MsanTrackOrigins > 2) {
Stephen Hines176edba2014-12-01 14:53:08 -0800390 D.Diag(clang::diag::err_drv_invalid_value) << A->getAsString(Args) << S;
Stephen Hines651f13c2014-04-23 16:59:28 -0700391 }
392 }
Peter Collingbournec6911a22013-11-01 18:16:25 +0000393 }
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000394 }
Stephen Hines651f13c2014-04-23 16:59:28 -0700395
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700396 // Parse -fsanitize-coverage=N. Currently one of asan/msan/lsan is required.
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700397 if (Kinds & SanitizeKind::SupportsCoverage) {
Stephen Hines176edba2014-12-01 14:53:08 -0800398 if (Arg *A = Args.getLastArg(options::OPT_fsanitize_coverage)) {
399 StringRef S = A->getValue();
400 // Legal values are 0..4.
401 if (S.getAsInteger(0, SanitizeCoverage) || SanitizeCoverage < 0 ||
402 SanitizeCoverage > 4)
403 D.Diag(clang::diag::err_drv_invalid_value) << A->getAsString(Args) << S;
404 }
405 }
406
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700407 if (Kinds & SanitizeKind::Address) {
Stephen Hines651f13c2014-04-23 16:59:28 -0700408 AsanSharedRuntime =
Stephen Hinesc568f1e2014-07-21 00:47:37 -0700409 Args.hasArg(options::OPT_shared_libasan) ||
410 (TC.getTriple().getEnvironment() == llvm::Triple::Android);
Stephen Hines651f13c2014-04-23 16:59:28 -0700411 AsanZeroBaseShadow =
412 (TC.getTriple().getEnvironment() == llvm::Triple::Android);
Stephen Hines176edba2014-12-01 14:53:08 -0800413 if (Arg *A =
414 Args.getLastArg(options::OPT_fsanitize_address_field_padding)) {
415 StringRef S = A->getValue();
416 // Legal values are 0 and 1, 2, but in future we may add more levels.
417 if (S.getAsInteger(0, AsanFieldPadding) || AsanFieldPadding < 0 ||
418 AsanFieldPadding > 2) {
419 D.Diag(clang::diag::err_drv_invalid_value) << A->getAsString(Args) << S;
420 }
421 }
422
423 if (Arg *WindowsDebugRTArg =
424 Args.getLastArg(options::OPT__SLASH_MTd, options::OPT__SLASH_MT,
425 options::OPT__SLASH_MDd, options::OPT__SLASH_MD,
426 options::OPT__SLASH_LDd, options::OPT__SLASH_LD)) {
427 switch (WindowsDebugRTArg->getOption().getID()) {
428 case options::OPT__SLASH_MTd:
429 case options::OPT__SLASH_MDd:
430 case options::OPT__SLASH_LDd:
431 D.Diag(clang::diag::err_drv_argument_not_allowed_with)
432 << WindowsDebugRTArg->getAsString(Args)
433 << lastArgumentForKind(D, Args, SanitizerKind::Address);
434 D.Diag(clang::diag::note_drv_address_sanitizer_debug_runtime);
435 }
436 }
Stephen Hines651f13c2014-04-23 16:59:28 -0700437 }
Stephen Hines176edba2014-12-01 14:53:08 -0800438
439 // Parse -link-cxx-sanitizer flag.
440 LinkCXXRuntimes =
441 Args.hasArg(options::OPT_fsanitize_link_cxx_runtime) || D.CCCIsCXX();
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700442
443 // Finally, initialize the set of available and recoverable sanitizers.
444 addAllOf(Sanitizers, Kinds);
445 addAllOf(RecoverableSanitizers, RecoverableKinds);
Stephen Hines176edba2014-12-01 14:53:08 -0800446}
447
448static std::string toString(const clang::SanitizerSet &Sanitizers) {
449 std::string Res;
450#define SANITIZER(NAME, ID) \
451 if (Sanitizers.has(clang::SanitizerKind::ID)) { \
452 if (!Res.empty()) \
453 Res += ","; \
454 Res += NAME; \
455 }
456#include "clang/Basic/Sanitizers.def"
457 return Res;
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000458}
459
Peter Collingbournec6911a22013-11-01 18:16:25 +0000460void SanitizerArgs::addArgs(const llvm::opt::ArgList &Args,
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000461 llvm::opt::ArgStringList &CmdArgs) const {
Stephen Hines176edba2014-12-01 14:53:08 -0800462 if (Sanitizers.empty())
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000463 return;
Stephen Hines176edba2014-12-01 14:53:08 -0800464 CmdArgs.push_back(Args.MakeArgString("-fsanitize=" + toString(Sanitizers)));
465
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700466 if (!RecoverableSanitizers.empty())
467 CmdArgs.push_back(Args.MakeArgString("-fsanitize-recover=" +
468 toString(RecoverableSanitizers)));
Stephen Hines176edba2014-12-01 14:53:08 -0800469
470 if (UbsanTrapOnError)
471 CmdArgs.push_back("-fsanitize-undefined-trap-on-error");
472
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700473 for (const auto &BLPath : BlacklistFiles) {
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000474 SmallString<64> BlacklistOpt("-fsanitize-blacklist=");
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700475 BlacklistOpt += BLPath;
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000476 CmdArgs.push_back(Args.MakeArgString(BlacklistOpt));
477 }
478
479 if (MsanTrackOrigins)
Stephen Hines651f13c2014-04-23 16:59:28 -0700480 CmdArgs.push_back(Args.MakeArgString("-fsanitize-memory-track-origins=" +
481 llvm::utostr(MsanTrackOrigins)));
Stephen Hines176edba2014-12-01 14:53:08 -0800482 if (AsanFieldPadding)
483 CmdArgs.push_back(Args.MakeArgString("-fsanitize-address-field-padding=" +
484 llvm::utostr(AsanFieldPadding)));
485 if (SanitizeCoverage)
486 CmdArgs.push_back(Args.MakeArgString("-fsanitize-coverage=" +
487 llvm::utostr(SanitizeCoverage)));
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700488 // MSan: Workaround for PR16386.
489 // ASan: This is mainly to help LSan with cases such as
490 // https://code.google.com/p/address-sanitizer/issues/detail?id=373
491 // We can't make this conditional on -fsanitize=leak, as that flag shouldn't
492 // affect compilation.
493 if (Sanitizers.has(SanitizerKind::Memory) ||
494 Sanitizers.has(SanitizerKind::Address))
Alexey Samsonov442c60a2013-08-08 10:11:02 +0000495 CmdArgs.push_back(Args.MakeArgString("-fno-assume-sane-operator-new"));
496}
497
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700498uint64_t parseValue(const char *Value) {
499 uint64_t ParsedKind = llvm::StringSwitch<SanitizeKind>(Value)
Stephen Hines176edba2014-12-01 14:53:08 -0800500#define SANITIZER(NAME, ID) .Case(NAME, ID)
501#define SANITIZER_GROUP(NAME, ID, ALIAS) .Case(NAME, ID##Group)
502#include "clang/Basic/Sanitizers.def"
503 .Default(SanitizeKind());
504 return ParsedKind;
505}
506
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700507uint64_t expandGroups(uint64_t Kinds) {
Stephen Hines176edba2014-12-01 14:53:08 -0800508#define SANITIZER(NAME, ID)
509#define SANITIZER_GROUP(NAME, ID, ALIAS) if (Kinds & ID##Group) Kinds |= ID;
510#include "clang/Basic/Sanitizers.def"
511 return Kinds;
512}
513
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700514uint64_t parseArgValues(const Driver &D, const llvm::opt::Arg *A,
Stephen Hines176edba2014-12-01 14:53:08 -0800515 bool DiagnoseErrors) {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700516 assert((A->getOption().matches(options::OPT_fsanitize_EQ) ||
517 A->getOption().matches(options::OPT_fno_sanitize_EQ) ||
518 A->getOption().matches(options::OPT_fsanitize_recover_EQ) ||
519 A->getOption().matches(options::OPT_fno_sanitize_recover_EQ)) &&
520 "Invalid argument in parseArgValues!");
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700521 uint64_t Kinds = 0;
522 for (int i = 0, n = A->getNumValues(); i != n; ++i) {
523 const char *Value = A->getValue(i);
524 uint64_t Kind;
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700525 // Special case: don't accept -fsanitize=all.
526 if (A->getOption().matches(options::OPT_fsanitize_EQ) &&
527 0 == strcmp("all", Value))
528 Kind = 0;
529 else
530 Kind = parseValue(Value);
531
532 if (Kind)
533 Kinds |= Kind;
Stephen Hines176edba2014-12-01 14:53:08 -0800534 else if (DiagnoseErrors)
535 D.Diag(clang::diag::err_drv_unsupported_option_argument)
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700536 << A->getOption().getName() << Value;
Stephen Hines176edba2014-12-01 14:53:08 -0800537 }
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700538 return Kinds;
Stephen Hines176edba2014-12-01 14:53:08 -0800539}
540
541std::string lastArgumentForMask(const Driver &D, const llvm::opt::ArgList &Args,
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700542 uint64_t Mask) {
Stephen Hines176edba2014-12-01 14:53:08 -0800543 for (llvm::opt::ArgList::const_reverse_iterator I = Args.rbegin(),
544 E = Args.rend();
545 I != E; ++I) {
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700546 const auto *Arg = *I;
547 if (Arg->getOption().matches(options::OPT_fsanitize_EQ)) {
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700548 uint64_t AddKinds = expandGroups(parseArgValues(D, Arg, false));
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700549 if (AddKinds & Mask)
550 return describeSanitizeArg(Arg, Mask);
551 } else if (Arg->getOption().matches(options::OPT_fno_sanitize_EQ)) {
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700552 uint64_t RemoveKinds = expandGroups(parseArgValues(D, Arg, false));
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700553 Mask &= ~RemoveKinds;
554 }
Stephen Hines176edba2014-12-01 14:53:08 -0800555 }
556 llvm_unreachable("arg list didn't provide expected value");
557}
558
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700559std::string describeSanitizeArg(const llvm::opt::Arg *A, uint64_t Mask) {
Stephen Hines176edba2014-12-01 14:53:08 -0800560 assert(A->getOption().matches(options::OPT_fsanitize_EQ)
561 && "Invalid argument in describeSanitizerArg!");
562
563 std::string Sanitizers;
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700564 for (int i = 0, n = A->getNumValues(); i != n; ++i) {
565 if (expandGroups(parseValue(A->getValue(i))) & Mask) {
Stephen Hines176edba2014-12-01 14:53:08 -0800566 if (!Sanitizers.empty())
567 Sanitizers += ",";
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -0700568 Sanitizers += A->getValue(i);
Stephen Hines176edba2014-12-01 14:53:08 -0800569 }
570 }
571
572 assert(!Sanitizers.empty() && "arg didn't provide expected value");
573 return "-fsanitize=" + Sanitizers;
574}