blob: efee5288d802c4a4bd56a4f2ca21869cc4d0419b [file] [log] [blame]
Kostya Serebryany29a18dc2014-11-11 22:14:37 +00001//===-- SanitizerCoverage.cpp - coverage instrumentation for sanitizers ---===//
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//===----------------------------------------------------------------------===//
9//
10// Coverage instrumentation that works with AddressSanitizer
11// and potentially with other Sanitizers.
12//
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000013// We create a Guard variable with the same linkage
Alexey Samsonov3514f272015-05-07 01:00:31 +000014// as the function and inject this code into the entry block (SCK_Function)
15// or all blocks (SCK_BB):
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000016// if (Guard < 0) {
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +000017// __sanitizer_cov(&Guard);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000018// }
19// The accesses to Guard are atomic. The rest of the logic is
20// in __sanitizer_cov (it's fine to call it more than once).
21//
Alexey Samsonov3514f272015-05-07 01:00:31 +000022// With SCK_Edge we also split critical edges this effectively
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000023// instrumenting all edges.
24//
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000025// This coverage implementation provides very limited data:
26// it only tells if a given function (block) was ever executed. No counters.
27// But for many use cases this is what we need and the added slowdown small.
28//
29//===----------------------------------------------------------------------===//
30
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000031#include "llvm/ADT/ArrayRef.h"
32#include "llvm/ADT/SmallVector.h"
David Majnemer70497c62015-12-02 23:06:39 +000033#include "llvm/Analysis/EHPersonalities.h"
Chandler Carruth30061152016-03-18 22:43:42 +000034#include "llvm/Analysis/PostDominators.h"
Mike Aizatsky5971f182016-02-26 01:17:22 +000035#include "llvm/IR/CFG.h"
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000036#include "llvm/IR/CallSite.h"
37#include "llvm/IR/DataLayout.h"
Alexey Samsonov201733b2015-06-12 01:48:47 +000038#include "llvm/IR/DebugInfo.h"
Mike Aizatsky5971f182016-02-26 01:17:22 +000039#include "llvm/IR/Dominators.h"
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000040#include "llvm/IR/Function.h"
41#include "llvm/IR/IRBuilder.h"
Kostya Serebryany73762942014-12-16 21:24:15 +000042#include "llvm/IR/InlineAsm.h"
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000043#include "llvm/IR/LLVMContext.h"
44#include "llvm/IR/MDBuilder.h"
45#include "llvm/IR/Module.h"
46#include "llvm/IR/Type.h"
47#include "llvm/Support/CommandLine.h"
48#include "llvm/Support/Debug.h"
49#include "llvm/Support/raw_ostream.h"
Mike Aizatsky5971f182016-02-26 01:17:22 +000050#include "llvm/Transforms/Instrumentation.h"
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000051#include "llvm/Transforms/Scalar.h"
52#include "llvm/Transforms/Utils/BasicBlockUtils.h"
53#include "llvm/Transforms/Utils/ModuleUtils.h"
54
55using namespace llvm;
56
57#define DEBUG_TYPE "sancov"
58
59static const char *const kSanCovModuleInitName = "__sanitizer_cov_module_init";
60static const char *const kSanCovName = "__sanitizer_cov";
Kostya Serebryany77cc7292015-02-04 01:21:45 +000061static const char *const kSanCovWithCheckName = "__sanitizer_cov_with_check";
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000062static const char *const kSanCovIndirCallName = "__sanitizer_cov_indir_call16";
Kostya Serebryanyd4590c72016-02-17 21:34:43 +000063static const char *const kSanCovTracePCIndir = "__sanitizer_cov_trace_pc_indir";
Kostya Serebryanycb45b122014-11-19 00:22:58 +000064static const char *const kSanCovTraceEnter = "__sanitizer_cov_trace_func_enter";
65static const char *const kSanCovTraceBB = "__sanitizer_cov_trace_basic_block";
Kostya Serebryanyd4590c72016-02-17 21:34:43 +000066static const char *const kSanCovTracePC = "__sanitizer_cov_trace_pc";
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +000067static const char *const kSanCovTraceCmp = "__sanitizer_cov_trace_cmp";
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +000068static const char *const kSanCovTraceSwitch = "__sanitizer_cov_trace_switch";
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000069static const char *const kSanCovModuleCtorName = "sancov.module_ctor";
Evgeniy Stepanov3fdfc7b2015-01-27 15:01:22 +000070static const uint64_t kSanCtorAndDtorPriority = 2;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000071
72static cl::opt<int> ClCoverageLevel("sanitizer-coverage-level",
73 cl::desc("Sanitizer Coverage. 0: none, 1: entry block, 2: all blocks, "
74 "3: all blocks and critical edges, "
75 "4: above plus indirect calls"),
76 cl::Hidden, cl::init(0));
77
Kostya Serebryany77cc7292015-02-04 01:21:45 +000078static cl::opt<unsigned> ClCoverageBlockThreshold(
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000079 "sanitizer-coverage-block-threshold",
Kostya Serebryany77cc7292015-02-04 01:21:45 +000080 cl::desc("Use a callback with a guard check inside it if there are"
81 " more than this number of blocks."),
Kostya Serebryany8fb05ac2015-03-10 01:11:53 +000082 cl::Hidden, cl::init(500));
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000083
Kostya Serebryanycb45b122014-11-19 00:22:58 +000084static cl::opt<bool>
85 ClExperimentalTracing("sanitizer-coverage-experimental-tracing",
86 cl::desc("Experimental basic-block tracing: insert "
87 "callbacks at every basic block"),
88 cl::Hidden, cl::init(false));
89
Kostya Serebryanyd4590c72016-02-17 21:34:43 +000090static cl::opt<bool> ClExperimentalTracePC("sanitizer-coverage-trace-pc",
91 cl::desc("Experimental pc tracing"),
92 cl::Hidden, cl::init(false));
93
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +000094static cl::opt<bool>
95 ClExperimentalCMPTracing("sanitizer-coverage-experimental-trace-compares",
96 cl::desc("Experimental tracing of CMP and similar "
97 "instructions"),
98 cl::Hidden, cl::init(false));
99
Mike Aizatsky5971f182016-02-26 01:17:22 +0000100static cl::opt<bool> ClPruneBlocks(
101 "sanitizer-coverage-prune-blocks",
102 cl::desc("Reduce the number of instrumented blocks (experimental)"),
103 cl::Hidden, cl::init(false));
104
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000105// Experimental 8-bit counters used as an additional search heuristic during
106// coverage-guided fuzzing.
107// The counters are not thread-friendly:
108// - contention on these counters may cause significant slowdown;
109// - the counter updates are racy and the results may be inaccurate.
110// They are also inaccurate due to 8-bit integer overflow.
111static cl::opt<bool> ClUse8bitCounters("sanitizer-coverage-8bit-counters",
112 cl::desc("Experimental 8-bit counters"),
113 cl::Hidden, cl::init(false));
114
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000115namespace {
116
Alexey Samsonov3514f272015-05-07 01:00:31 +0000117SanitizerCoverageOptions getOptions(int LegacyCoverageLevel) {
118 SanitizerCoverageOptions Res;
119 switch (LegacyCoverageLevel) {
120 case 0:
121 Res.CoverageType = SanitizerCoverageOptions::SCK_None;
122 break;
123 case 1:
124 Res.CoverageType = SanitizerCoverageOptions::SCK_Function;
125 break;
126 case 2:
127 Res.CoverageType = SanitizerCoverageOptions::SCK_BB;
128 break;
129 case 3:
130 Res.CoverageType = SanitizerCoverageOptions::SCK_Edge;
131 break;
132 case 4:
133 Res.CoverageType = SanitizerCoverageOptions::SCK_Edge;
134 Res.IndirectCalls = true;
135 break;
136 }
137 return Res;
138}
139
140SanitizerCoverageOptions OverrideFromCL(SanitizerCoverageOptions Options) {
141 // Sets CoverageType and IndirectCalls.
142 SanitizerCoverageOptions CLOpts = getOptions(ClCoverageLevel);
143 Options.CoverageType = std::max(Options.CoverageType, CLOpts.CoverageType);
144 Options.IndirectCalls |= CLOpts.IndirectCalls;
145 Options.TraceBB |= ClExperimentalTracing;
146 Options.TraceCmp |= ClExperimentalCMPTracing;
147 Options.Use8bitCounters |= ClUse8bitCounters;
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000148 Options.TracePC |= ClExperimentalTracePC;
Alexey Samsonov3514f272015-05-07 01:00:31 +0000149 return Options;
150}
151
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000152class SanitizerCoverageModule : public ModulePass {
153 public:
Alexey Samsonov3514f272015-05-07 01:00:31 +0000154 SanitizerCoverageModule(
155 const SanitizerCoverageOptions &Options = SanitizerCoverageOptions())
Chandler Carruthe2b70212016-03-18 22:35:58 +0000156 : ModulePass(ID), Options(OverrideFromCL(Options)) {
157 initializeSanitizerCoverageModulePass(*PassRegistry::getPassRegistry());
158 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000159 bool runOnModule(Module &M) override;
160 bool runOnFunction(Function &F);
161 static char ID; // Pass identification, replacement for typeid
162 const char *getPassName() const override {
163 return "SanitizerCoverageModule";
164 }
165
Chandler Carruth30061152016-03-18 22:43:42 +0000166 void getAnalysisUsage(AnalysisUsage &AU) const override {
167 AU.addRequired<DominatorTreeWrapperPass>();
168 AU.addRequired<PostDominatorTreeWrapperPass>();
169 }
170
171private:
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000172 void InjectCoverageForIndirectCalls(Function &F,
173 ArrayRef<Instruction *> IndirCalls);
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000174 void InjectTraceForCmp(Function &F, ArrayRef<Instruction *> CmpTraceTargets);
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000175 void InjectTraceForSwitch(Function &F,
176 ArrayRef<Instruction *> SwitchTraceTargets);
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000177 bool InjectCoverage(Function &F, ArrayRef<BasicBlock *> AllBlocks);
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000178 void SetNoSanitizeMetadata(Instruction *I);
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000179 void InjectCoverageAtBlock(Function &F, BasicBlock &BB, bool UseCalls);
Kostya Serebryany48a40232015-03-10 01:58:27 +0000180 unsigned NumberOfInstrumentedBlocks() {
Kostya Serebryanya3c53472015-12-02 02:37:13 +0000181 return SanCovFunction->getNumUses() +
182 SanCovWithCheckFunction->getNumUses() + SanCovTraceBB->getNumUses() +
183 SanCovTraceEnter->getNumUses();
Kostya Serebryany48a40232015-03-10 01:58:27 +0000184 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000185 Function *SanCovFunction;
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000186 Function *SanCovWithCheckFunction;
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000187 Function *SanCovIndirCallFunction, *SanCovTracePCIndir;
188 Function *SanCovTraceEnter, *SanCovTraceBB, *SanCovTracePC;
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000189 Function *SanCovTraceCmpFunction;
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000190 Function *SanCovTraceSwitchFunction;
Kostya Serebryany73762942014-12-16 21:24:15 +0000191 InlineAsm *EmptyAsm;
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000192 Type *IntptrTy, *Int64Ty, *Int64PtrTy;
193 Module *CurModule;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000194 LLVMContext *C;
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000195 const DataLayout *DL;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000196
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000197 GlobalVariable *GuardArray;
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000198 GlobalVariable *EightBitCounterArray;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000199
Alexey Samsonov3514f272015-05-07 01:00:31 +0000200 SanitizerCoverageOptions Options;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000201};
202
203} // namespace
204
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000205bool SanitizerCoverageModule::runOnModule(Module &M) {
Alexey Samsonov3514f272015-05-07 01:00:31 +0000206 if (Options.CoverageType == SanitizerCoverageOptions::SCK_None)
207 return false;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000208 C = &(M.getContext());
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000209 DL = &M.getDataLayout();
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000210 CurModule = &M;
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000211 IntptrTy = Type::getIntNTy(*C, DL->getPointerSizeInBits());
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000212 Type *VoidTy = Type::getVoidTy(*C);
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +0000213 IRBuilder<> IRB(*C);
Kostya Serebryany88599462015-02-20 00:30:44 +0000214 Type *Int8PtrTy = PointerType::getUnqual(IRB.getInt8Ty());
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000215 Type *Int32PtrTy = PointerType::getUnqual(IRB.getInt32Ty());
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000216 Int64PtrTy = PointerType::getUnqual(IRB.getInt64Ty());
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000217 Int64Ty = IRB.getInt64Ty();
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000218
Ismail Pazarbasi198d6d52015-04-06 21:09:08 +0000219 SanCovFunction = checkSanitizerInterfaceFunction(
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000220 M.getOrInsertFunction(kSanCovName, VoidTy, Int32PtrTy, nullptr));
Ismail Pazarbasi198d6d52015-04-06 21:09:08 +0000221 SanCovWithCheckFunction = checkSanitizerInterfaceFunction(
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000222 M.getOrInsertFunction(kSanCovWithCheckName, VoidTy, Int32PtrTy, nullptr));
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000223 SanCovTracePCIndir =
224 checkSanitizerInterfaceFunction(M.getOrInsertFunction(
225 kSanCovTracePCIndir, VoidTy, IntptrTy, nullptr));
Ismail Pazarbasi198d6d52015-04-06 21:09:08 +0000226 SanCovIndirCallFunction =
227 checkSanitizerInterfaceFunction(M.getOrInsertFunction(
228 kSanCovIndirCallName, VoidTy, IntptrTy, IntptrTy, nullptr));
229 SanCovTraceCmpFunction =
230 checkSanitizerInterfaceFunction(M.getOrInsertFunction(
231 kSanCovTraceCmp, VoidTy, Int64Ty, Int64Ty, Int64Ty, nullptr));
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000232 SanCovTraceSwitchFunction =
233 checkSanitizerInterfaceFunction(M.getOrInsertFunction(
234 kSanCovTraceSwitch, VoidTy, Int64Ty, Int64PtrTy, nullptr));
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000235
Kostya Serebryany73762942014-12-16 21:24:15 +0000236 // We insert an empty inline asm after cov callbacks to avoid callback merge.
237 EmptyAsm = InlineAsm::get(FunctionType::get(IRB.getVoidTy(), false),
238 StringRef(""), StringRef(""),
239 /*hasSideEffects=*/true);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000240
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000241 SanCovTracePC = checkSanitizerInterfaceFunction(
242 M.getOrInsertFunction(kSanCovTracePC, VoidTy, nullptr));
Kostya Serebryanya3c53472015-12-02 02:37:13 +0000243 SanCovTraceEnter = checkSanitizerInterfaceFunction(
244 M.getOrInsertFunction(kSanCovTraceEnter, VoidTy, Int32PtrTy, nullptr));
245 SanCovTraceBB = checkSanitizerInterfaceFunction(
246 M.getOrInsertFunction(kSanCovTraceBB, VoidTy, Int32PtrTy, nullptr));
Kostya Serebryanycb45b122014-11-19 00:22:58 +0000247
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000248 // At this point we create a dummy array of guards because we don't
249 // know how many elements we will need.
250 Type *Int32Ty = IRB.getInt32Ty();
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000251 Type *Int8Ty = IRB.getInt8Ty();
252
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000253 GuardArray =
254 new GlobalVariable(M, Int32Ty, false, GlobalValue::ExternalLinkage,
255 nullptr, "__sancov_gen_cov_tmp");
Alexey Samsonov3514f272015-05-07 01:00:31 +0000256 if (Options.Use8bitCounters)
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000257 EightBitCounterArray =
258 new GlobalVariable(M, Int8Ty, false, GlobalVariable::ExternalLinkage,
259 nullptr, "__sancov_gen_cov_tmp");
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000260
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000261 for (auto &F : M)
262 runOnFunction(F);
263
Kostya Serebryany48a40232015-03-10 01:58:27 +0000264 auto N = NumberOfInstrumentedBlocks();
265
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000266 // Now we know how many elements we need. Create an array of guards
267 // with one extra element at the beginning for the size.
Kostya Serebryany48a40232015-03-10 01:58:27 +0000268 Type *Int32ArrayNTy = ArrayType::get(Int32Ty, N + 1);
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000269 GlobalVariable *RealGuardArray = new GlobalVariable(
270 M, Int32ArrayNTy, false, GlobalValue::PrivateLinkage,
271 Constant::getNullValue(Int32ArrayNTy), "__sancov_gen_cov");
272
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000273
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000274 // Replace the dummy array with the real one.
275 GuardArray->replaceAllUsesWith(
276 IRB.CreatePointerCast(RealGuardArray, Int32PtrTy));
277 GuardArray->eraseFromParent();
278
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000279 GlobalVariable *RealEightBitCounterArray;
Alexey Samsonov3514f272015-05-07 01:00:31 +0000280 if (Options.Use8bitCounters) {
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000281 // Make sure the array is 16-aligned.
282 static const int kCounterAlignment = 16;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000283 Type *Int8ArrayNTy = ArrayType::get(Int8Ty, alignTo(N, kCounterAlignment));
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000284 RealEightBitCounterArray = new GlobalVariable(
285 M, Int8ArrayNTy, false, GlobalValue::PrivateLinkage,
286 Constant::getNullValue(Int8ArrayNTy), "__sancov_gen_cov_counter");
287 RealEightBitCounterArray->setAlignment(kCounterAlignment);
288 EightBitCounterArray->replaceAllUsesWith(
289 IRB.CreatePointerCast(RealEightBitCounterArray, Int8PtrTy));
290 EightBitCounterArray->eraseFromParent();
291 }
292
Kostya Serebryany88599462015-02-20 00:30:44 +0000293 // Create variable for module (compilation unit) name
294 Constant *ModNameStrConst =
295 ConstantDataArray::getString(M.getContext(), M.getName(), true);
296 GlobalVariable *ModuleName =
297 new GlobalVariable(M, ModNameStrConst->getType(), true,
298 GlobalValue::PrivateLinkage, ModNameStrConst);
299
Kostya Serebryany3c767db2016-02-27 05:45:12 +0000300 if (!Options.TracePC) {
301 Function *CtorFunc;
302 std::tie(CtorFunc, std::ignore) = createSanitizerCtorAndInitFunctions(
303 M, kSanCovModuleCtorName, kSanCovModuleInitName,
304 {Int32PtrTy, IntptrTy, Int8PtrTy, Int8PtrTy},
305 {IRB.CreatePointerCast(RealGuardArray, Int32PtrTy),
306 ConstantInt::get(IntptrTy, N),
307 Options.Use8bitCounters
308 ? IRB.CreatePointerCast(RealEightBitCounterArray, Int8PtrTy)
309 : Constant::getNullValue(Int8PtrTy),
310 IRB.CreatePointerCast(ModuleName, Int8PtrTy)});
Ismail Pazarbasid02ce132015-05-10 13:45:05 +0000311
Kostya Serebryany3c767db2016-02-27 05:45:12 +0000312 appendToGlobalCtors(M, CtorFunc, kSanCtorAndDtorPriority);
313 }
Ismail Pazarbasid02ce132015-05-10 13:45:05 +0000314
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000315 return true;
316}
317
Renato Golin9a5419e2016-02-27 14:19:19 +0000318static bool shouldInstrumentBlock(const BasicBlock *BB,
319 const DominatorTree *DT) {
Mike Aizatsky5971f182016-02-26 01:17:22 +0000320 if (!ClPruneBlocks)
321 return true;
Renato Golin9a5419e2016-02-27 14:19:19 +0000322 if (succ_begin(BB) == succ_end(BB))
323 return true;
Mike Aizatsky5971f182016-02-26 01:17:22 +0000324
325 // Check if BB dominates all its successors.
326 for (const BasicBlock *SUCC : make_range(succ_begin(BB), succ_end(BB))) {
Renato Golin9a5419e2016-02-27 14:19:19 +0000327 if (!DT->dominates(BB, SUCC))
328 return true;
Mike Aizatsky5971f182016-02-26 01:17:22 +0000329 }
330
Renato Golin9a5419e2016-02-27 14:19:19 +0000331 return false;
Mike Aizatsky5971f182016-02-26 01:17:22 +0000332}
333
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000334bool SanitizerCoverageModule::runOnFunction(Function &F) {
335 if (F.empty()) return false;
Kostya Serebryanyfea4fb42014-12-17 21:50:04 +0000336 if (F.getName().find(".module_ctor") != std::string::npos)
337 return false; // Should not instrument sanitizer init functions.
Reid Klecknerdf523372015-09-03 20:18:29 +0000338 // Don't instrument functions using SEH for now. Splitting basic blocks like
339 // we do for coverage breaks WinEHPrepare.
340 // FIXME: Remove this when SEH no longer uses landingpad pattern matching.
341 if (F.hasPersonalityFn() &&
342 isAsynchronousEHPersonality(classifyEHPersonality(F.getPersonalityFn())))
343 return false;
Alexey Samsonov3514f272015-05-07 01:00:31 +0000344 if (Options.CoverageType >= SanitizerCoverageOptions::SCK_Edge)
Chandler Carruth37df2cf2015-01-19 12:09:11 +0000345 SplitAllCriticalEdges(F);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000346 SmallVector<Instruction*, 8> IndirCalls;
Mike Aizatsky5971f182016-02-26 01:17:22 +0000347 SmallVector<BasicBlock *, 16> BlocksToInstrument;
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000348 SmallVector<Instruction*, 8> CmpTraceTargets;
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000349 SmallVector<Instruction*, 8> SwitchTraceTargets;
Mike Aizatsky5971f182016-02-26 01:17:22 +0000350
Renato Golin9a5419e2016-02-27 14:19:19 +0000351 DominatorTree DT;
352 DT.recalculate(F);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000353 for (auto &BB : F) {
Renato Golin9a5419e2016-02-27 14:19:19 +0000354 if (shouldInstrumentBlock(&BB, &DT))
Mike Aizatsky5971f182016-02-26 01:17:22 +0000355 BlocksToInstrument.push_back(&BB);
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000356 for (auto &Inst : BB) {
Alexey Samsonov3514f272015-05-07 01:00:31 +0000357 if (Options.IndirectCalls) {
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000358 CallSite CS(&Inst);
359 if (CS && !CS.getCalledFunction())
360 IndirCalls.push_back(&Inst);
361 }
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000362 if (Options.TraceCmp) {
363 if (isa<ICmpInst>(&Inst))
364 CmpTraceTargets.push_back(&Inst);
365 if (isa<SwitchInst>(&Inst))
366 SwitchTraceTargets.push_back(&Inst);
367 }
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000368 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000369 }
Mike Aizatsky5971f182016-02-26 01:17:22 +0000370
371 InjectCoverage(F, BlocksToInstrument);
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000372 InjectCoverageForIndirectCalls(F, IndirCalls);
373 InjectTraceForCmp(F, CmpTraceTargets);
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000374 InjectTraceForSwitch(F, SwitchTraceTargets);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000375 return true;
376}
377
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000378bool SanitizerCoverageModule::InjectCoverage(Function &F,
379 ArrayRef<BasicBlock *> AllBlocks) {
Alexey Samsonov3514f272015-05-07 01:00:31 +0000380 switch (Options.CoverageType) {
381 case SanitizerCoverageOptions::SCK_None:
382 return false;
383 case SanitizerCoverageOptions::SCK_Function:
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000384 InjectCoverageAtBlock(F, F.getEntryBlock(), false);
Alexey Samsonov3514f272015-05-07 01:00:31 +0000385 return true;
386 default: {
387 bool UseCalls = ClCoverageBlockThreshold < AllBlocks.size();
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000388 for (auto BB : AllBlocks)
Alexey Samsonov3514f272015-05-07 01:00:31 +0000389 InjectCoverageAtBlock(F, *BB, UseCalls);
390 return true;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000391 }
Alexey Samsonov3514f272015-05-07 01:00:31 +0000392 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000393}
394
395// On every indirect call we call a run-time function
396// __sanitizer_cov_indir_call* with two parameters:
397// - callee address,
398// - global cache array that contains kCacheSize pointers (zero-initialized).
399// The cache is used to speed up recording the caller-callee pairs.
400// The address of the caller is passed implicitly via caller PC.
401// kCacheSize is encoded in the name of the run-time function.
402void SanitizerCoverageModule::InjectCoverageForIndirectCalls(
403 Function &F, ArrayRef<Instruction *> IndirCalls) {
404 if (IndirCalls.empty()) return;
405 const int kCacheSize = 16;
406 const int kCacheAlignment = 64; // Align for better performance.
407 Type *Ty = ArrayType::get(IntptrTy, kCacheSize);
408 for (auto I : IndirCalls) {
409 IRBuilder<> IRB(I);
410 CallSite CS(I);
411 Value *Callee = CS.getCalledValue();
Benjamin Kramer619c4e52015-04-10 11:24:51 +0000412 if (isa<InlineAsm>(Callee)) continue;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000413 GlobalVariable *CalleeCache = new GlobalVariable(
414 *F.getParent(), Ty, false, GlobalValue::PrivateLinkage,
415 Constant::getNullValue(Ty), "__sancov_gen_callee_cache");
416 CalleeCache->setAlignment(kCacheAlignment);
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000417 if (Options.TracePC)
418 IRB.CreateCall(SanCovTracePCIndir,
419 IRB.CreatePointerCast(Callee, IntptrTy));
420 else
421 IRB.CreateCall(SanCovIndirCallFunction,
422 {IRB.CreatePointerCast(Callee, IntptrTy),
423 IRB.CreatePointerCast(CalleeCache, IntptrTy)});
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000424 }
425}
426
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000427// For every switch statement we insert a call:
428// __sanitizer_cov_trace_switch(CondValue,
429// {NumCases, ValueSizeInBits, Case0Value, Case1Value, Case2Value, ... })
430
431void SanitizerCoverageModule::InjectTraceForSwitch(
432 Function &F, ArrayRef<Instruction *> SwitchTraceTargets) {
433 for (auto I : SwitchTraceTargets) {
434 if (SwitchInst *SI = dyn_cast<SwitchInst>(I)) {
435 IRBuilder<> IRB(I);
436 SmallVector<Constant *, 16> Initializers;
437 Value *Cond = SI->getCondition();
Kostya Serebryany25691182015-08-11 00:24:39 +0000438 if (Cond->getType()->getScalarSizeInBits() >
439 Int64Ty->getScalarSizeInBits())
440 continue;
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000441 Initializers.push_back(ConstantInt::get(Int64Ty, SI->getNumCases()));
442 Initializers.push_back(
443 ConstantInt::get(Int64Ty, Cond->getType()->getScalarSizeInBits()));
444 if (Cond->getType()->getScalarSizeInBits() <
445 Int64Ty->getScalarSizeInBits())
446 Cond = IRB.CreateIntCast(Cond, Int64Ty, false);
447 for (auto It: SI->cases()) {
448 Constant *C = It.getCaseValue();
449 if (C->getType()->getScalarSizeInBits() <
450 Int64Ty->getScalarSizeInBits())
451 C = ConstantExpr::getCast(CastInst::ZExt, It.getCaseValue(), Int64Ty);
452 Initializers.push_back(C);
453 }
454 ArrayType *ArrayOfInt64Ty = ArrayType::get(Int64Ty, Initializers.size());
455 GlobalVariable *GV = new GlobalVariable(
456 *CurModule, ArrayOfInt64Ty, false, GlobalVariable::InternalLinkage,
457 ConstantArray::get(ArrayOfInt64Ty, Initializers),
458 "__sancov_gen_cov_switch_values");
459 IRB.CreateCall(SanCovTraceSwitchFunction,
460 {Cond, IRB.CreatePointerCast(GV, Int64PtrTy)});
461 }
462 }
463}
464
465
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000466void SanitizerCoverageModule::InjectTraceForCmp(
467 Function &F, ArrayRef<Instruction *> CmpTraceTargets) {
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000468 for (auto I : CmpTraceTargets) {
469 if (ICmpInst *ICMP = dyn_cast<ICmpInst>(I)) {
470 IRBuilder<> IRB(ICMP);
471 Value *A0 = ICMP->getOperand(0);
472 Value *A1 = ICMP->getOperand(1);
473 if (!A0->getType()->isIntegerTy()) continue;
474 uint64_t TypeSize = DL->getTypeStoreSizeInBits(A0->getType());
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000475 // __sanitizer_cov_trace_cmp((type_size << 32) | predicate, A0, A1);
David Blaikieff6409d2015-05-18 22:13:54 +0000476 IRB.CreateCall(
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000477 SanCovTraceCmpFunction,
David Blaikieff6409d2015-05-18 22:13:54 +0000478 {ConstantInt::get(Int64Ty, (TypeSize << 32) | ICMP->getPredicate()),
479 IRB.CreateIntCast(A0, Int64Ty, true),
480 IRB.CreateIntCast(A1, Int64Ty, true)});
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000481 }
482 }
483}
484
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000485void SanitizerCoverageModule::SetNoSanitizeMetadata(Instruction *I) {
Kostya Serebryany83ce8772015-03-05 01:20:05 +0000486 I->setMetadata(
Sanjay Patelaf674fb2015-12-14 17:24:23 +0000487 I->getModule()->getMDKindID("nosanitize"), MDNode::get(*C, None));
Kostya Serebryany83ce8772015-03-05 01:20:05 +0000488}
489
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000490void SanitizerCoverageModule::InjectCoverageAtBlock(Function &F, BasicBlock &BB,
491 bool UseCalls) {
Alexey Samsonov342b1e82015-06-30 23:11:45 +0000492 // Don't insert coverage for unreachable blocks: we will never call
493 // __sanitizer_cov() for them, so counting them in
494 // NumberOfInstrumentedBlocks() might complicate calculation of code coverage
495 // percentage. Also, unreachable instructions frequently have no debug
496 // locations.
497 if (isa<UnreachableInst>(BB.getTerminator()))
498 return;
Justin Bogner7ae63aa2015-08-14 17:03:45 +0000499 BasicBlock::iterator IP = BB.getFirstInsertionPt();
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000500
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000501 bool IsEntryBB = &BB == &F.getEntryBlock();
Alexey Samsonov201733b2015-06-12 01:48:47 +0000502 DebugLoc EntryLoc;
503 if (IsEntryBB) {
Pete Cooperadebb932016-03-11 02:14:16 +0000504 if (auto SP = F.getSubprogram())
Alexey Samsonov201733b2015-06-12 01:48:47 +0000505 EntryLoc = DebugLoc::get(SP->getScopeLine(), 0, SP);
Reid Klecknera57d0152015-08-14 16:45:42 +0000506 // Keep static allocas and llvm.localescape calls in the entry block. Even
507 // if we aren't splitting the block, it's nice for allocas to be before
508 // calls.
509 IP = PrepareToSplitEntryBlock(BB, IP);
Alexey Samsonov201733b2015-06-12 01:48:47 +0000510 } else {
511 EntryLoc = IP->getDebugLoc();
512 }
513
Duncan P. N. Exon Smithe82c2862015-10-13 17:39:10 +0000514 IRBuilder<> IRB(&*IP);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000515 IRB.SetCurrentDebugLocation(EntryLoc);
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000516 Value *GuardP = IRB.CreateAdd(
517 IRB.CreatePointerCast(GuardArray, IntptrTy),
Kostya Serebryany48a40232015-03-10 01:58:27 +0000518 ConstantInt::get(IntptrTy, (1 + NumberOfInstrumentedBlocks()) * 4));
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000519 Type *Int32PtrTy = PointerType::getUnqual(IRB.getInt32Ty());
520 GuardP = IRB.CreateIntToPtr(GuardP, Int32PtrTy);
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000521 if (Options.TracePC) {
522 IRB.CreateCall(SanCovTracePC);
523 } else if (Options.TraceBB) {
Kostya Serebryanya3c53472015-12-02 02:37:13 +0000524 IRB.CreateCall(IsEntryBB ? SanCovTraceEnter : SanCovTraceBB, GuardP);
525 } else if (UseCalls) {
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000526 IRB.CreateCall(SanCovWithCheckFunction, GuardP);
527 } else {
528 LoadInst *Load = IRB.CreateLoad(GuardP);
529 Load->setAtomic(Monotonic);
530 Load->setAlignment(4);
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000531 SetNoSanitizeMetadata(Load);
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000532 Value *Cmp = IRB.CreateICmpSGE(Constant::getNullValue(Load->getType()), Load);
533 Instruction *Ins = SplitBlockAndInsertIfThen(
Duncan P. N. Exon Smithe82c2862015-10-13 17:39:10 +0000534 Cmp, &*IP, false, MDBuilder(*C).createBranchWeights(1, 100000));
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000535 IRB.SetInsertPoint(Ins);
536 IRB.SetCurrentDebugLocation(EntryLoc);
537 // __sanitizer_cov gets the PC of the instruction using GET_CALLER_PC.
538 IRB.CreateCall(SanCovFunction, GuardP);
David Blaikieff6409d2015-05-18 22:13:54 +0000539 IRB.CreateCall(EmptyAsm, {}); // Avoids callback merge.
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000540 }
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000541
Alexey Samsonov3514f272015-05-07 01:00:31 +0000542 if (Options.Use8bitCounters) {
Duncan P. N. Exon Smithe82c2862015-10-13 17:39:10 +0000543 IRB.SetInsertPoint(&*IP);
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000544 Value *P = IRB.CreateAdd(
545 IRB.CreatePointerCast(EightBitCounterArray, IntptrTy),
Kostya Serebryany48a40232015-03-10 01:58:27 +0000546 ConstantInt::get(IntptrTy, NumberOfInstrumentedBlocks() - 1));
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000547 P = IRB.CreateIntToPtr(P, IRB.getInt8PtrTy());
Kostya Serebryany83ce8772015-03-05 01:20:05 +0000548 LoadInst *LI = IRB.CreateLoad(P);
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000549 Value *Inc = IRB.CreateAdd(LI, ConstantInt::get(IRB.getInt8Ty(), 1));
Kostya Serebryany83ce8772015-03-05 01:20:05 +0000550 StoreInst *SI = IRB.CreateStore(Inc, P);
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000551 SetNoSanitizeMetadata(LI);
552 SetNoSanitizeMetadata(SI);
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000553 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000554}
555
556char SanitizerCoverageModule::ID = 0;
Mike Aizatsky90562842016-02-27 05:50:40 +0000557INITIALIZE_PASS_BEGIN(SanitizerCoverageModule, "sancov",
558 "SanitizerCoverage: TODO."
559 "ModulePass", false, false)
560INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
561INITIALIZE_PASS_DEPENDENCY(PostDominatorTreeWrapperPass)
562INITIALIZE_PASS_END(SanitizerCoverageModule, "sancov",
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000563 "SanitizerCoverage: TODO."
564 "ModulePass", false, false)
Alexey Samsonov3514f272015-05-07 01:00:31 +0000565ModulePass *llvm::createSanitizerCoverageModulePass(
566 const SanitizerCoverageOptions &Options) {
567 return new SanitizerCoverageModule(Options);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000568}