clang  14.0.0git
SanitizerArgs.h
Go to the documentation of this file.
1 //===--- SanitizerArgs.h - Arguments for sanitizer tools -------*- C++ -*-===//
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 #ifndef LLVM_CLANG_DRIVER_SANITIZERARGS_H
9 #define LLVM_CLANG_DRIVER_SANITIZERARGS_H
10 
11 #include "clang/Basic/Sanitizers.h"
12 #include "clang/Driver/Types.h"
13 #include "llvm/Option/Arg.h"
14 #include "llvm/Option/ArgList.h"
15 #include "llvm/Transforms/Instrumentation/AddressSanitizerOptions.h"
16 #include <string>
17 #include <vector>
18 
19 namespace clang {
20 namespace driver {
21 
22 class ToolChain;
23 
25  SanitizerSet Sanitizers;
26  SanitizerSet RecoverableSanitizers;
27  SanitizerSet TrapSanitizers;
28 
29  std::vector<std::string> UserIgnorelistFiles;
30  std::vector<std::string> SystemIgnorelistFiles;
31  std::vector<std::string> CoverageAllowlistFiles;
32  std::vector<std::string> CoverageIgnorelistFiles;
33  int CoverageFeatures = 0;
34  int MsanTrackOrigins = 0;
35  bool MsanUseAfterDtor = true;
36  bool CfiCrossDso = false;
37  bool CfiICallGeneralizePointers = false;
38  bool CfiCanonicalJumpTables = false;
39  int AsanFieldPadding = 0;
40  bool SharedRuntime = false;
41  bool AsanUseAfterScope = true;
42  bool AsanPoisonCustomArrayCookie = false;
43  bool AsanGlobalsDeadStripping = false;
44  bool AsanUseOdrIndicator = false;
45  bool AsanInvalidPointerCmp = false;
46  bool AsanInvalidPointerSub = false;
47  bool AsanOutlineInstrumentation = false;
48  llvm::AsanDtorKind AsanDtorKind = llvm::AsanDtorKind::Invalid;
49  std::string HwasanAbi;
50  bool LinkRuntimes = true;
51  bool LinkCXXRuntimes = false;
52  bool NeedPIE = false;
53  bool SafeStackRuntime = false;
54  bool Stats = false;
55  bool TsanMemoryAccess = true;
56  bool TsanFuncEntryExit = true;
57  bool TsanAtomics = true;
58  bool MinimalRuntime = false;
59  // True if cross-dso CFI support if provided by the system (i.e. Android).
60  bool ImplicitCfiRuntime = false;
61  bool NeedsMemProfRt = false;
62  bool HwasanUseAliases = false;
63  llvm::AsanDetectStackUseAfterReturnMode AsanUseAfterReturn =
64  llvm::AsanDetectStackUseAfterReturnMode::Invalid;
65 
66 public:
67  /// Parses the sanitizer arguments from an argument list.
68  SanitizerArgs(const ToolChain &TC, const llvm::opt::ArgList &Args);
69 
70  bool needsSharedRt() const { return SharedRuntime; }
71 
72  bool needsMemProfRt() const { return NeedsMemProfRt; }
73  bool needsAsanRt() const { return Sanitizers.has(SanitizerKind::Address); }
74  bool needsHwasanRt() const {
75  return Sanitizers.has(SanitizerKind::HWAddress);
76  }
77  bool needsHwasanAliasesRt() const {
78  return needsHwasanRt() && HwasanUseAliases;
79  }
80  bool needsTsanRt() const { return Sanitizers.has(SanitizerKind::Thread); }
81  bool needsMsanRt() const { return Sanitizers.has(SanitizerKind::Memory); }
82  bool needsFuzzer() const { return Sanitizers.has(SanitizerKind::Fuzzer); }
83  bool needsLsanRt() const {
84  return Sanitizers.has(SanitizerKind::Leak) &&
85  !Sanitizers.has(SanitizerKind::Address) &&
86  !Sanitizers.has(SanitizerKind::HWAddress);
87  }
88  bool needsFuzzerInterceptors() const;
89  bool needsUbsanRt() const;
90  bool requiresMinimalRuntime() const { return MinimalRuntime; }
91  bool needsDfsanRt() const { return Sanitizers.has(SanitizerKind::DataFlow); }
92  bool needsSafeStackRt() const { return SafeStackRuntime; }
93  bool needsCfiRt() const;
94  bool needsCfiDiagRt() const;
95  bool needsStatsRt() const { return Stats; }
96  bool needsScudoRt() const { return Sanitizers.has(SanitizerKind::Scudo); }
97 
98  bool requiresPIE() const;
99  bool needsUnwindTables() const;
100  bool needsLTO() const;
101  bool linkRuntimes() const { return LinkRuntimes; }
102  bool linkCXXRuntimes() const { return LinkCXXRuntimes; }
103  bool hasCrossDsoCfi() const { return CfiCrossDso; }
104  bool hasAnySanitizer() const { return !Sanitizers.empty(); }
105  void addArgs(const ToolChain &TC, const llvm::opt::ArgList &Args,
106  llvm::opt::ArgStringList &CmdArgs, types::ID InputType) const;
107 };
108 
109 } // namespace driver
110 } // namespace clang
111 
112 #endif
clang::driver::SanitizerArgs::needsUnwindTables
bool needsUnwindTables() const
Definition: SanitizerArgs.cpp:272
clang::driver::SanitizerArgs::hasCrossDsoCfi
bool hasCrossDsoCfi() const
Definition: SanitizerArgs.h:103
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::driver::SanitizerArgs::needsSafeStackRt
bool needsSafeStackRt() const
Definition: SanitizerArgs.h:92
clang::SanitizerSet::has
bool has(SanitizerMask K) const
Check if a certain (single) sanitizer is enabled.
Definition: Sanitizers.h:155
clang::driver::SanitizerArgs::needsTsanRt
bool needsTsanRt() const
Definition: SanitizerArgs.h:80
clang::driver::SanitizerArgs::needsHwasanRt
bool needsHwasanRt() const
Definition: SanitizerArgs.h:74
clang::driver::SanitizerArgs::requiresMinimalRuntime
bool requiresMinimalRuntime() const
Definition: SanitizerArgs.h:90
clang::driver::SanitizerArgs::requiresPIE
bool requiresPIE() const
Definition: SanitizerArgs.cpp:268
clang::driver::SanitizerArgs::linkRuntimes
bool linkRuntimes() const
Definition: SanitizerArgs.h:101
clang::SanitizerSet
Definition: Sanitizers.h:153
clang::driver::SanitizerArgs::addArgs
void addArgs(const ToolChain &TC, const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs, types::ID InputType) const
Definition: SanitizerArgs.cpp:970
clang::driver::SanitizerArgs::needsFuzzer
bool needsFuzzer() const
Definition: SanitizerArgs.h:82
clang::driver::SanitizerArgs::hasAnySanitizer
bool hasAnySanitizer() const
Definition: SanitizerArgs.h:104
clang::driver::SanitizerArgs::needsAsanRt
bool needsAsanRt() const
Definition: SanitizerArgs.h:73
clang::driver::SanitizerArgs::needsScudoRt
bool needsScudoRt() const
Definition: SanitizerArgs.h:96
clang::driver::SanitizerArgs::needsFuzzerInterceptors
bool needsFuzzerInterceptors() const
Definition: SanitizerArgs.cpp:243
clang::driver::SanitizerArgs
Definition: SanitizerArgs.h:24
clang::driver::SanitizerArgs::needsLTO
bool needsLTO() const
Definition: SanitizerArgs.cpp:276
clang::driver::SanitizerArgs::needsLsanRt
bool needsLsanRt() const
Definition: SanitizerArgs.h:83
clang::driver::SanitizerArgs::needsHwasanAliasesRt
bool needsHwasanAliasesRt() const
Definition: SanitizerArgs.h:77
clang::driver::ToolChain
ToolChain - Access to tools for a single platform.
Definition: ToolChain.h:91
clang::driver::SanitizerArgs::needsCfiRt
bool needsCfiRt() const
Definition: SanitizerArgs.cpp:258
clang::driver::SanitizerArgs::needsMemProfRt
bool needsMemProfRt() const
Definition: SanitizerArgs.h:72
clang::driver::SanitizerArgs::needsCfiDiagRt
bool needsCfiDiagRt() const
Definition: SanitizerArgs.cpp:263
clang::driver::types::ID
ID
Definition: Types.h:23
clang::SanitizerSet::empty
bool empty() const
Returns true if no sanitizers are enabled.
Definition: Sanitizers.h:173
Sanitizers.h
clang
Definition: CalledOnceCheck.h:17
clang::driver::SanitizerArgs::linkCXXRuntimes
bool linkCXXRuntimes() const
Definition: SanitizerArgs.h:102
clang::driver::SanitizerArgs::needsUbsanRt
bool needsUbsanRt() const
Definition: SanitizerArgs.cpp:247
Types.h
clang::driver::SanitizerArgs::needsDfsanRt
bool needsDfsanRt() const
Definition: SanitizerArgs.h:91
clang::driver::SanitizerArgs::needsSharedRt
bool needsSharedRt() const
Definition: SanitizerArgs.h:70
clang::driver::SanitizerArgs::needsStatsRt
bool needsStatsRt() const
Definition: SanitizerArgs.h:95
clang::driver::SanitizerArgs::SanitizerArgs
SanitizerArgs(const ToolChain &TC, const llvm::opt::ArgList &Args)
Parses the sanitizer arguments from an argument list.
Definition: SanitizerArgs.cpp:280
clang::driver::SanitizerArgs::needsMsanRt
bool needsMsanRt() const
Definition: SanitizerArgs.h:81