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