blob: d4e45f1b346fb68712a8b8ff190f7801ba1a9e51 [file] [log] [blame]
Alexey Samsonovcf055962013-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 Samsonov609213f92013-08-19 09:14:21 +00009#include "clang/Driver/SanitizerArgs.h"
Alexey Samsonovcf055962013-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"
Evgeniy Stepanov2bfcaab2014-03-20 14:58:36 +000014#include "llvm/ADT/StringExtras.h"
Alexey Samsonovcf055962013-08-08 10:11:02 +000015#include "llvm/ADT/StringSwitch.h"
16#include "llvm/Support/FileSystem.h"
17#include "llvm/Support/Path.h"
Alexey Samsonovb7dd3292014-07-09 19:40:08 +000018#include "llvm/Support/SpecialCaseList.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000019#include <memory>
Alexey Samsonovcf055962013-08-08 10:11:02 +000020
21using namespace clang::driver;
22using namespace llvm::opt;
23
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000024namespace {
25/// Assign ordinals to possible values of -fsanitize= flag.
26/// We use the ordinal values as bit positions within \c SanitizeKind.
Alexey Samsonov83791e22015-03-03 22:15:32 +000027enum SanitizeOrdinal : uint64_t {
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000028#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).
Alexey Samsonov83791e22015-03-03 22:15:32 +000038enum SanitizeKind : uint64_t {
39#define SANITIZER(NAME, ID) ID = 1ULL << SO_##ID,
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000040#define SANITIZER_GROUP(NAME, ID, ALIAS) \
Alexey Samsonov83791e22015-03-03 22:15:32 +000041 ID = ALIAS, ID##Group = 1ULL << SO_##ID##Group,
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000042#include "clang/Basic/Sanitizers.def"
43 NeedsUbsanRt = Undefined | Integer,
44 NotAllowedWithTrap = Vptr,
Dmitry Vyukov43419a72014-11-21 12:19:01 +000045 RequiresPIE = Memory | DataFlow,
Kostya Serebryany2d88f3d2015-01-06 01:02:48 +000046 NeedsUnwindTables = Address | Thread | Memory | DataFlow,
Kostya Serebryany6fe5fcb2015-03-20 00:06:52 +000047 SupportsCoverage = Address | Memory | Leak | Undefined | Integer | DataFlow,
Alexey Samsonov88459522015-01-12 22:39:12 +000048 RecoverableByDefault = Undefined | Integer,
49 Unrecoverable = Address | Unreachable | Return,
Peter Collingbournea4ccff32015-02-20 20:30:56 +000050 LegacyFsanitizeRecoverMask = Undefined | Integer,
Peter Collingbourne1a7488a2015-04-02 00:23:30 +000051 NeedsLTO = CFI,
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000052};
53}
54
55/// Returns true if set of \p Sanitizers contain at least one sanitizer from
56/// \p Kinds.
Alexey Samsonov83791e22015-03-03 22:15:32 +000057static bool hasOneOf(const clang::SanitizerSet &Sanitizers, uint64_t Kinds) {
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000058#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.
Alexey Samsonov83791e22015-03-03 22:15:32 +000066static void addAllOf(clang::SanitizerSet &Sanitizers, uint64_t Kinds) {
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000067#define SANITIZER(NAME, ID) \
68 if (Kinds & ID) \
69 Sanitizers.set(clang::SanitizerKind::ID, true);
70#include "clang/Basic/Sanitizers.def"
71}
72
Alexey Samsonov83791e22015-03-03 22:15:32 +000073static uint64_t toSanitizeKind(clang::SanitizerKind K) {
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000074#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.
Alexey Samsonov83791e22015-03-03 22:15:32 +000084static uint64_t parseValue(const char *Value);
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000085
86/// Parse a -fsanitize= or -fno-sanitize= argument's values, diagnosing any
87/// invalid components. Returns OR of members of \c SanitizeKind enumeration.
Alexey Samsonov83791e22015-03-03 22:15:32 +000088static uint64_t parseArgValues(const Driver &D, const llvm::opt::Arg *A,
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000089 bool DiagnoseErrors);
90
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000091/// 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,
Alexey Samsonov83791e22015-03-03 22:15:32 +000097 uint64_t Mask);
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +000098
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".
Alexey Samsonov83791e22015-03-03 22:15:32 +0000109static std::string describeSanitizeArg(const llvm::opt::Arg *A, uint64_t Mask);
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000110
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000111/// Produce a string containing comma-separated names of sanitizers in \p
112/// Sanitizers set.
113static std::string toString(const clang::SanitizerSet &Sanitizers);
114
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000115/// For each sanitizer group bit set in \p Kinds, set the bits for sanitizers
116/// this group enables.
Alexey Samsonov83791e22015-03-03 22:15:32 +0000117static uint64_t expandGroups(uint64_t Kinds);
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000118
Alexey Samsonov83791e22015-03-03 22:15:32 +0000119static uint64_t getToolchainUnsupportedKinds(const ToolChain &TC) {
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000120 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;
Mohit K. Bhakkadf4c47f62015-01-22 07:21:22 +0000124 bool IsMIPS64 = TC.getTriple().getArch() == llvm::Triple::mips64 ||
125 TC.getTriple().getArch() == llvm::Triple::mips64el;
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000126
Alexey Samsonov83791e22015-03-03 22:15:32 +0000127 uint64_t Unsupported = 0;
Mohit K. Bhakkadf4c47f62015-01-22 07:21:22 +0000128 if (!(IsLinux && (IsX86_64 || IsMIPS64))) {
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000129 Unsupported |= Memory | DataFlow;
130 }
Mohit K. Bhakkad69963e72015-02-23 09:32:35 +0000131 if (!((IsLinux || IsFreeBSD) && (IsX86_64 || IsMIPS64))) {
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000132 Unsupported |= Thread;
133 }
134 if (!(IsLinux && (IsX86 || IsX86_64))) {
135 Unsupported |= Function;
136 }
137 return Unsupported;
138}
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000139
Alexey Samsonovecf380e2015-03-20 18:45:06 +0000140static 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
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000161bool SanitizerArgs::needsUbsanRt() const {
Alexey Samsonov31095462015-04-01 22:42:25 +0000162 return !UbsanTrapOnError && hasOneOf(Sanitizers, NeedsUbsanRt) &&
163 !Sanitizers.has(SanitizerKind::Address);
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000164}
165
Dmitry Vyukov43419a72014-11-21 12:19:01 +0000166bool SanitizerArgs::requiresPIE() const {
167 return AsanZeroBaseShadow || hasOneOf(Sanitizers, RequiresPIE);
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000168}
169
170bool SanitizerArgs::needsUnwindTables() const {
171 return hasOneOf(Sanitizers, NeedsUnwindTables);
172}
173
Peter Collingbournea4ccff32015-02-20 20:30:56 +0000174bool SanitizerArgs::needsLTO() const {
Peter Collingbourned2926c92015-03-14 02:42:25 +0000175 return hasOneOf(Sanitizers, NeedsLTO);
Peter Collingbournea4ccff32015-02-20 20:30:56 +0000176}
177
Alexey Samsonovbb14f342013-08-08 11:32:17 +0000178void SanitizerArgs::clear() {
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000179 Sanitizers.clear();
Alexey Samsonov88459522015-01-12 22:39:12 +0000180 RecoverableSanitizers.clear();
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000181 BlacklistFiles.clear();
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000182 SanitizeCoverage = 0;
Evgeniy Stepanov2bfcaab2014-03-20 14:58:36 +0000183 MsanTrackOrigins = 0;
Kostya Serebryanyaed71a82014-10-09 17:53:04 +0000184 AsanFieldPadding = 0;
Peter Collingbourne32701642013-11-01 18:16:25 +0000185 AsanZeroBaseShadow = false;
Alexey Samsonovbb14f342013-08-08 11:32:17 +0000186 UbsanTrapOnError = false;
Alexey Samsonovbdfa6c22014-04-01 13:31:10 +0000187 AsanSharedRuntime = false;
Alexey Samsonov90490af2014-08-08 22:47:17 +0000188 LinkCXXRuntimes = false;
Alexey Samsonovbb14f342013-08-08 11:32:17 +0000189}
Alexey Samsonovcf055962013-08-08 10:11:02 +0000190
Peter Collingbourne32701642013-11-01 18:16:25 +0000191SanitizerArgs::SanitizerArgs(const ToolChain &TC,
192 const llvm::opt::ArgList &Args) {
Alexey Samsonovbb14f342013-08-08 11:32:17 +0000193 clear();
Alexey Samsonov83791e22015-03-03 22:15:32 +0000194 uint64_t AllRemove = 0; // During the loop below, the accumulated set of
Peter Collingbourne32701642013-11-01 18:16:25 +0000195 // sanitizers disabled by the current sanitizer
196 // argument or any argument after it.
Alexey Samsonov83791e22015-03-03 22:15:32 +0000197 uint64_t DiagnosedKinds = 0; // All Kinds we have diagnosed up to now.
Peter Collingbourne32701642013-11-01 18:16:25 +0000198 // Used to deduplicate diagnostics.
Alexey Samsonov83791e22015-03-03 22:15:32 +0000199 uint64_t Kinds = 0;
200 uint64_t NotSupported = getToolchainUnsupportedKinds(TC);
Filipe Cabecinhasec5d0e62015-02-19 01:04:49 +0000201 ToolChain::RTTIMode RTTIMode = TC.getRTTIMode();
202
Peter Collingbourne32701642013-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) {
Alexey Samsonov799f7932014-12-19 02:35:16 +0000206 const auto *Arg = *I;
207 if (Arg->getOption().matches(options::OPT_fsanitize_EQ)) {
208 Arg->claim();
Alexey Samsonov83791e22015-03-03 22:15:32 +0000209 uint64_t Add = parseArgValues(D, Arg, true);
Peter Collingbourne32701642013-11-01 18:16:25 +0000210
Alexey Samsonov799f7932014-12-19 02:35:16 +0000211 // 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.
Alexey Samsonov83791e22015-03-03 22:15:32 +0000216 if (uint64_t KindsToDiagnose = Add & NotSupported & ~DiagnosedKinds) {
Alexey Samsonov799f7932014-12-19 02:35:16 +0000217 // 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 Collingbourne32701642013-11-01 18:16:25 +0000224
Filipe Cabecinhasec5d0e62015-02-19 01:04:49 +0000225 // 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 }
242
243 // Take out the Vptr sanitizer from the enabled sanitizers
244 AllRemove |= SanitizeKind::Vptr;
245 }
246
Alexey Samsonov799f7932014-12-19 02:35:16 +0000247 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;
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000253
Alexey Samsonov799f7932014-12-19 02:35:16 +0000254 Kinds |= Add;
255 } else if (Arg->getOption().matches(options::OPT_fno_sanitize_EQ)) {
256 Arg->claim();
Alexey Samsonov83791e22015-03-03 22:15:32 +0000257 uint64_t Remove = parseArgValues(D, Arg, true);
Alexey Samsonov799f7932014-12-19 02:35:16 +0000258 AllRemove |= expandGroups(Remove);
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000259 }
Alexey Samsonovcf055962013-08-08 10:11:02 +0000260 }
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000261
Filipe Cabecinhasec5d0e62015-02-19 01:04:49 +0000262 // We disable the vptr sanitizer if it was enabled by group expansion but RTTI
263 // is disabled.
Alexey Samsonovecf380e2015-03-20 18:45:06 +0000264 if ((Kinds & SanitizeKind::Vptr) &&
Filipe Cabecinhasec5d0e62015-02-19 01:04:49 +0000265 (RTTIMode == ToolChain::RM_DisabledImplicitly ||
266 RTTIMode == ToolChain::RM_DisabledExplicitly)) {
267 Kinds &= ~SanitizeKind::Vptr;
Filipe Cabecinhasec5d0e62015-02-19 01:04:49 +0000268 }
269
Alexey Samsonovecf380e2015-03-20 18:45:06 +0000270 // 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
Alexey Samsonov88459522015-01-12 22:39:12 +0000306 // Parse -f(no-)?sanitize-recover flags.
Alexey Samsonov83791e22015-03-03 22:15:32 +0000307 uint64_t RecoverableKinds = RecoverableByDefault;
308 uint64_t DiagnosedUnrecoverableKinds = 0;
Alexey Samsonov88459522015-01-12 22:39:12 +0000309 for (const auto *Arg : Args) {
Alexey Samsonovce2e77c2015-03-11 23:34:25 +0000310 const char *DeprecatedReplacement = nullptr;
Alexey Samsonov88459522015-01-12 22:39:12 +0000311 if (Arg->getOption().matches(options::OPT_fsanitize_recover)) {
Alexey Samsonovce2e77c2015-03-11 23:34:25 +0000312 DeprecatedReplacement = "-fsanitize-recover=undefined,integer";
Alexey Samsonov88459522015-01-12 22:39:12 +0000313 RecoverableKinds |= expandGroups(LegacyFsanitizeRecoverMask);
314 Arg->claim();
315 } else if (Arg->getOption().matches(options::OPT_fno_sanitize_recover)) {
Alexey Samsonovce2e77c2015-03-11 23:34:25 +0000316 DeprecatedReplacement = "-fno-sanitize-recover=undefined,integer";
Alexey Samsonov88459522015-01-12 22:39:12 +0000317 RecoverableKinds &= ~expandGroups(LegacyFsanitizeRecoverMask);
318 Arg->claim();
319 } else if (Arg->getOption().matches(options::OPT_fsanitize_recover_EQ)) {
Alexey Samsonov83791e22015-03-03 22:15:32 +0000320 uint64_t Add = parseArgValues(D, Arg, true);
Alexey Samsonov88459522015-01-12 22:39:12 +0000321 // Report error if user explicitly tries to recover from unrecoverable
322 // sanitizer.
Alexey Samsonov83791e22015-03-03 22:15:32 +0000323 if (uint64_t KindsToDiagnose =
Alexey Samsonov88459522015-01-12 22:39:12 +0000324 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 }
Alexey Samsonovce2e77c2015-03-11 23:34:25 +0000337 if (DeprecatedReplacement) {
338 D.Diag(diag::warn_drv_deprecated_arg) << Arg->getAsString(Args)
339 << DeprecatedReplacement;
340 }
Alexey Samsonov88459522015-01-12 22:39:12 +0000341 }
342 RecoverableKinds &= Kinds;
343 RecoverableKinds &= ~Unrecoverable;
Alexey Samsonovcf055962013-08-08 10:11:02 +0000344
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000345 // Setup blacklist files.
346 // Add default blacklist from resource directory.
347 {
Alexey Samsonovcf055962013-08-08 10:11:02 +0000348 std::string BLPath;
Alexey Samsonovecf380e2015-03-20 18:45:06 +0000349 if (getDefaultBlacklist(D, Kinds, BLPath) && llvm::sys::fs::exists(BLPath))
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000350 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 Samsonovcf055962013-08-08 10:11:02 +0000373 }
374
Evgeniy Stepanov2bfcaab2014-03-20 14:58:36 +0000375 // Parse -f[no-]sanitize-memory-track-origins[=level] options.
Alexey Samsonovecf380e2015-03-20 18:45:06 +0000376 if (Kinds & SanitizeKind::Memory) {
Evgeniy Stepanov2bfcaab2014-03-20 14:58:36 +0000377 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)) {
Evgeniy Stepanov6e09bca2015-02-26 15:59:30 +0000382 MsanTrackOrigins = 2;
Evgeniy Stepanov2bfcaab2014-03-20 14:58:36 +0000383 } 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) {
Nico Weberb31abb02015-04-13 20:01:20 +0000390 D.Diag(clang::diag::err_drv_invalid_value) << A->getAsString(Args)
391 << S;
Evgeniy Stepanov2bfcaab2014-03-20 14:58:36 +0000392 }
393 }
394 }
395 }
396
Kostya Serebryany78df9d02014-12-17 21:46:33 +0000397 // Parse -fsanitize-coverage=N. Currently one of asan/msan/lsan is required.
Alexey Samsonovecf380e2015-03-20 18:45:06 +0000398 if (Kinds & SanitizeKind::SupportsCoverage) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000399 if (Arg *A = Args.getLastArg(options::OPT_fsanitize_coverage)) {
400 StringRef S = A->getValue();
401 // Legal values are 0..4.
402 if (S.getAsInteger(0, SanitizeCoverage) || SanitizeCoverage < 0 ||
403 SanitizeCoverage > 4)
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000404 D.Diag(clang::diag::err_drv_invalid_value) << A->getAsString(Args) << S;
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000405 }
406 }
407
Alexey Samsonovecf380e2015-03-20 18:45:06 +0000408 if (Kinds & SanitizeKind::Address) {
Alexey Samsonovbdfa6c22014-04-01 13:31:10 +0000409 AsanSharedRuntime =
Evgeniy Stepanov6f0ae182014-06-05 11:14:00 +0000410 Args.hasArg(options::OPT_shared_libasan) ||
411 (TC.getTriple().getEnvironment() == llvm::Triple::Android);
Peter Collingbourne32701642013-11-01 18:16:25 +0000412 AsanZeroBaseShadow =
Evgeniy Stepanovd04b8612014-01-16 10:19:31 +0000413 (TC.getTriple().getEnvironment() == llvm::Triple::Android);
Kostya Serebryanyaed71a82014-10-09 17:53:04 +0000414 if (Arg *A =
415 Args.getLastArg(options::OPT_fsanitize_address_field_padding)) {
416 StringRef S = A->getValue();
417 // Legal values are 0 and 1, 2, but in future we may add more levels.
418 if (S.getAsInteger(0, AsanFieldPadding) || AsanFieldPadding < 0 ||
419 AsanFieldPadding > 2) {
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000420 D.Diag(clang::diag::err_drv_invalid_value) << A->getAsString(Args) << S;
Kostya Serebryanyaed71a82014-10-09 17:53:04 +0000421 }
422 }
Ehsan Akhgarie0db1962014-10-14 23:15:44 +0000423
424 if (Arg *WindowsDebugRTArg =
425 Args.getLastArg(options::OPT__SLASH_MTd, options::OPT__SLASH_MT,
426 options::OPT__SLASH_MDd, options::OPT__SLASH_MD,
427 options::OPT__SLASH_LDd, options::OPT__SLASH_LD)) {
428 switch (WindowsDebugRTArg->getOption().getID()) {
429 case options::OPT__SLASH_MTd:
430 case options::OPT__SLASH_MDd:
431 case options::OPT__SLASH_LDd:
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000432 D.Diag(clang::diag::err_drv_argument_not_allowed_with)
Ehsan Akhgarie0db1962014-10-14 23:15:44 +0000433 << WindowsDebugRTArg->getAsString(Args)
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000434 << lastArgumentForKind(D, Args, SanitizerKind::Address);
435 D.Diag(clang::diag::note_drv_address_sanitizer_debug_runtime);
Ehsan Akhgarie0db1962014-10-14 23:15:44 +0000436 }
437 }
Alexey Samsonovbdfa6c22014-04-01 13:31:10 +0000438 }
Alexey Samsonov90490af2014-08-08 22:47:17 +0000439
440 // Parse -link-cxx-sanitizer flag.
441 LinkCXXRuntimes =
442 Args.hasArg(options::OPT_fsanitize_link_cxx_runtime) || D.CCCIsCXX();
Alexey Samsonovecf380e2015-03-20 18:45:06 +0000443
444 // Finally, initialize the set of available and recoverable sanitizers.
445 addAllOf(Sanitizers, Kinds);
446 addAllOf(RecoverableSanitizers, RecoverableKinds);
Alexey Samsonovcf055962013-08-08 10:11:02 +0000447}
448
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000449static std::string toString(const clang::SanitizerSet &Sanitizers) {
450 std::string Res;
451#define SANITIZER(NAME, ID) \
452 if (Sanitizers.has(clang::SanitizerKind::ID)) { \
453 if (!Res.empty()) \
454 Res += ","; \
455 Res += NAME; \
456 }
457#include "clang/Basic/Sanitizers.def"
458 return Res;
459}
460
Peter Collingbourne32701642013-11-01 18:16:25 +0000461void SanitizerArgs::addArgs(const llvm::opt::ArgList &Args,
Alexey Samsonovcf055962013-08-08 10:11:02 +0000462 llvm::opt::ArgStringList &CmdArgs) const {
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000463 if (Sanitizers.empty())
Alexey Samsonovcf055962013-08-08 10:11:02 +0000464 return;
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000465 CmdArgs.push_back(Args.MakeArgString("-fsanitize=" + toString(Sanitizers)));
466
Alexey Samsonov88459522015-01-12 22:39:12 +0000467 if (!RecoverableSanitizers.empty())
468 CmdArgs.push_back(Args.MakeArgString("-fsanitize-recover=" +
469 toString(RecoverableSanitizers)));
Alexey Samsonov1e715a62014-11-16 20:53:53 +0000470
471 if (UbsanTrapOnError)
472 CmdArgs.push_back("-fsanitize-undefined-trap-on-error");
473
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000474 for (const auto &BLPath : BlacklistFiles) {
Alexey Samsonovcf055962013-08-08 10:11:02 +0000475 SmallString<64> BlacklistOpt("-fsanitize-blacklist=");
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000476 BlacklistOpt += BLPath;
Alexey Samsonovcf055962013-08-08 10:11:02 +0000477 CmdArgs.push_back(Args.MakeArgString(BlacklistOpt));
478 }
479
480 if (MsanTrackOrigins)
Evgeniy Stepanov2bfcaab2014-03-20 14:58:36 +0000481 CmdArgs.push_back(Args.MakeArgString("-fsanitize-memory-track-origins=" +
482 llvm::utostr(MsanTrackOrigins)));
Kostya Serebryanyaed71a82014-10-09 17:53:04 +0000483 if (AsanFieldPadding)
484 CmdArgs.push_back(Args.MakeArgString("-fsanitize-address-field-padding=" +
485 llvm::utostr(AsanFieldPadding)));
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000486 if (SanitizeCoverage)
487 CmdArgs.push_back(Args.MakeArgString("-fsanitize-coverage=" +
488 llvm::utostr(SanitizeCoverage)));
Sergey Matveev2ba87782015-02-17 15:09:33 +0000489 // MSan: Workaround for PR16386.
490 // ASan: This is mainly to help LSan with cases such as
491 // https://code.google.com/p/address-sanitizer/issues/detail?id=373
492 // We can't make this conditional on -fsanitize=leak, as that flag shouldn't
493 // affect compilation.
494 if (Sanitizers.has(SanitizerKind::Memory) ||
495 Sanitizers.has(SanitizerKind::Address))
Alexey Samsonovcf055962013-08-08 10:11:02 +0000496 CmdArgs.push_back(Args.MakeArgString("-fno-assume-sane-operator-new"));
497}
498
Alexey Samsonov83791e22015-03-03 22:15:32 +0000499uint64_t parseValue(const char *Value) {
500 uint64_t ParsedKind = llvm::StringSwitch<SanitizeKind>(Value)
Alexey Samsonovcf055962013-08-08 10:11:02 +0000501#define SANITIZER(NAME, ID) .Case(NAME, ID)
Peter Collingbourne32701642013-11-01 18:16:25 +0000502#define SANITIZER_GROUP(NAME, ID, ALIAS) .Case(NAME, ID##Group)
Alexey Samsonovcf055962013-08-08 10:11:02 +0000503#include "clang/Basic/Sanitizers.def"
504 .Default(SanitizeKind());
Alexey Samsonovcf055962013-08-08 10:11:02 +0000505 return ParsedKind;
506}
507
Alexey Samsonov83791e22015-03-03 22:15:32 +0000508uint64_t expandGroups(uint64_t Kinds) {
Peter Collingbourne32701642013-11-01 18:16:25 +0000509#define SANITIZER(NAME, ID)
510#define SANITIZER_GROUP(NAME, ID, ALIAS) if (Kinds & ID##Group) Kinds |= ID;
511#include "clang/Basic/Sanitizers.def"
512 return Kinds;
513}
514
Alexey Samsonov83791e22015-03-03 22:15:32 +0000515uint64_t parseArgValues(const Driver &D, const llvm::opt::Arg *A,
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000516 bool DiagnoseErrors) {
Alexey Samsonov799f7932014-12-19 02:35:16 +0000517 assert((A->getOption().matches(options::OPT_fsanitize_EQ) ||
Alexey Samsonov88459522015-01-12 22:39:12 +0000518 A->getOption().matches(options::OPT_fno_sanitize_EQ) ||
519 A->getOption().matches(options::OPT_fsanitize_recover_EQ) ||
520 A->getOption().matches(options::OPT_fno_sanitize_recover_EQ)) &&
Alexey Samsonov799f7932014-12-19 02:35:16 +0000521 "Invalid argument in parseArgValues!");
Alexey Samsonov83791e22015-03-03 22:15:32 +0000522 uint64_t Kinds = 0;
523 for (int i = 0, n = A->getNumValues(); i != n; ++i) {
524 const char *Value = A->getValue(i);
525 uint64_t Kind;
Alexey Samsonovabd5bea2014-12-19 18:41:43 +0000526 // Special case: don't accept -fsanitize=all.
527 if (A->getOption().matches(options::OPT_fsanitize_EQ) &&
528 0 == strcmp("all", Value))
529 Kind = 0;
530 else
531 Kind = parseValue(Value);
532
533 if (Kind)
534 Kinds |= Kind;
Alexey Samsonovcf055962013-08-08 10:11:02 +0000535 else if (DiagnoseErrors)
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000536 D.Diag(clang::diag::err_drv_unsupported_option_argument)
Alexey Samsonovabd5bea2014-12-19 18:41:43 +0000537 << A->getOption().getName() << Value;
Alexey Samsonovcf055962013-08-08 10:11:02 +0000538 }
Alexey Samsonovabd5bea2014-12-19 18:41:43 +0000539 return Kinds;
Alexey Samsonovcf055962013-08-08 10:11:02 +0000540}
541
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000542std::string lastArgumentForMask(const Driver &D, const llvm::opt::ArgList &Args,
Alexey Samsonov83791e22015-03-03 22:15:32 +0000543 uint64_t Mask) {
Alexey Samsonovcf055962013-08-08 10:11:02 +0000544 for (llvm::opt::ArgList::const_reverse_iterator I = Args.rbegin(),
545 E = Args.rend();
546 I != E; ++I) {
Alexey Samsonov799f7932014-12-19 02:35:16 +0000547 const auto *Arg = *I;
548 if (Arg->getOption().matches(options::OPT_fsanitize_EQ)) {
Alexey Samsonov83791e22015-03-03 22:15:32 +0000549 uint64_t AddKinds = expandGroups(parseArgValues(D, Arg, false));
Alexey Samsonov799f7932014-12-19 02:35:16 +0000550 if (AddKinds & Mask)
551 return describeSanitizeArg(Arg, Mask);
552 } else if (Arg->getOption().matches(options::OPT_fno_sanitize_EQ)) {
Alexey Samsonov83791e22015-03-03 22:15:32 +0000553 uint64_t RemoveKinds = expandGroups(parseArgValues(D, Arg, false));
Alexey Samsonov799f7932014-12-19 02:35:16 +0000554 Mask &= ~RemoveKinds;
555 }
Alexey Samsonovcf055962013-08-08 10:11:02 +0000556 }
557 llvm_unreachable("arg list didn't provide expected value");
558}
559
Alexey Samsonov83791e22015-03-03 22:15:32 +0000560std::string describeSanitizeArg(const llvm::opt::Arg *A, uint64_t Mask) {
Alexey Samsonov4c12c6c2014-11-14 02:59:20 +0000561 assert(A->getOption().matches(options::OPT_fsanitize_EQ)
562 && "Invalid argument in describeSanitizerArg!");
Alexey Samsonovcf055962013-08-08 10:11:02 +0000563
Peter Collingbourne32701642013-11-01 18:16:25 +0000564 std::string Sanitizers;
Alexey Samsonov83791e22015-03-03 22:15:32 +0000565 for (int i = 0, n = A->getNumValues(); i != n; ++i) {
566 if (expandGroups(parseValue(A->getValue(i))) & Mask) {
Peter Collingbourne32701642013-11-01 18:16:25 +0000567 if (!Sanitizers.empty())
568 Sanitizers += ",";
Alexey Samsonov83791e22015-03-03 22:15:32 +0000569 Sanitizers += A->getValue(i);
Peter Collingbourne32701642013-11-01 18:16:25 +0000570 }
571 }
Alexey Samsonovcf055962013-08-08 10:11:02 +0000572
Peter Collingbourne32701642013-11-01 18:16:25 +0000573 assert(!Sanitizers.empty() && "arg didn't provide expected value");
574 return "-fsanitize=" + Sanitizers;
Alexey Samsonovcf055962013-08-08 10:11:02 +0000575}