blob: ac7859132ff32b6c4ab9604a7ed0c634af91a6b5 [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
Mike Aizatsky759aca02016-03-18 23:29:29 +000059static const char *const SanCovModuleInitName = "__sanitizer_cov_module_init";
60static const char *const SanCovName = "__sanitizer_cov";
61static const char *const SanCovWithCheckName = "__sanitizer_cov_with_check";
62static const char *const SanCovIndirCallName = "__sanitizer_cov_indir_call16";
63static const char *const SanCovTracePCIndirName =
64 "__sanitizer_cov_trace_pc_indir";
65static const char *const SanCovTraceEnterName =
66 "__sanitizer_cov_trace_func_enter";
67static const char *const SanCovTraceBBName =
68 "__sanitizer_cov_trace_basic_block";
69static const char *const SanCovTracePCName = "__sanitizer_cov_trace_pc";
70static const char *const SanCovTraceCmpName = "__sanitizer_cov_trace_cmp";
71static const char *const SanCovTraceSwitchName = "__sanitizer_cov_trace_switch";
72static const char *const SanCovModuleCtorName = "sancov.module_ctor";
73static const uint64_t SanCtorAndDtorPriority = 2;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000074
Mike Aizatsky759aca02016-03-18 23:29:29 +000075static cl::opt<int> ClCoverageLevel(
76 "sanitizer-coverage-level",
77 cl::desc("Sanitizer Coverage. 0: none, 1: entry block, 2: all blocks, "
78 "3: all blocks and critical edges, "
79 "4: above plus indirect calls"),
80 cl::Hidden, cl::init(0));
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000081
Kostya Serebryany77cc7292015-02-04 01:21:45 +000082static cl::opt<unsigned> ClCoverageBlockThreshold(
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000083 "sanitizer-coverage-block-threshold",
Kostya Serebryany77cc7292015-02-04 01:21:45 +000084 cl::desc("Use a callback with a guard check inside it if there are"
85 " more than this number of blocks."),
Kostya Serebryany8fb05ac2015-03-10 01:11:53 +000086 cl::Hidden, cl::init(500));
Kostya Serebryany29a18dc2014-11-11 22:14:37 +000087
Kostya Serebryanycb45b122014-11-19 00:22:58 +000088static cl::opt<bool>
89 ClExperimentalTracing("sanitizer-coverage-experimental-tracing",
90 cl::desc("Experimental basic-block tracing: insert "
91 "callbacks at every basic block"),
92 cl::Hidden, cl::init(false));
93
Kostya Serebryanyd4590c72016-02-17 21:34:43 +000094static cl::opt<bool> ClExperimentalTracePC("sanitizer-coverage-trace-pc",
95 cl::desc("Experimental pc tracing"),
96 cl::Hidden, cl::init(false));
97
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +000098static cl::opt<bool>
99 ClExperimentalCMPTracing("sanitizer-coverage-experimental-trace-compares",
100 cl::desc("Experimental tracing of CMP and similar "
101 "instructions"),
102 cl::Hidden, cl::init(false));
103
Mike Aizatsky5971f182016-02-26 01:17:22 +0000104static cl::opt<bool> ClPruneBlocks(
105 "sanitizer-coverage-prune-blocks",
106 cl::desc("Reduce the number of instrumented blocks (experimental)"),
107 cl::Hidden, cl::init(false));
108
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000109// Experimental 8-bit counters used as an additional search heuristic during
110// coverage-guided fuzzing.
111// The counters are not thread-friendly:
112// - contention on these counters may cause significant slowdown;
113// - the counter updates are racy and the results may be inaccurate.
114// They are also inaccurate due to 8-bit integer overflow.
115static cl::opt<bool> ClUse8bitCounters("sanitizer-coverage-8bit-counters",
116 cl::desc("Experimental 8-bit counters"),
117 cl::Hidden, cl::init(false));
118
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000119namespace {
120
Alexey Samsonov3514f272015-05-07 01:00:31 +0000121SanitizerCoverageOptions getOptions(int LegacyCoverageLevel) {
122 SanitizerCoverageOptions Res;
123 switch (LegacyCoverageLevel) {
124 case 0:
125 Res.CoverageType = SanitizerCoverageOptions::SCK_None;
126 break;
127 case 1:
128 Res.CoverageType = SanitizerCoverageOptions::SCK_Function;
129 break;
130 case 2:
131 Res.CoverageType = SanitizerCoverageOptions::SCK_BB;
132 break;
133 case 3:
134 Res.CoverageType = SanitizerCoverageOptions::SCK_Edge;
135 break;
136 case 4:
137 Res.CoverageType = SanitizerCoverageOptions::SCK_Edge;
138 Res.IndirectCalls = true;
139 break;
140 }
141 return Res;
142}
143
144SanitizerCoverageOptions OverrideFromCL(SanitizerCoverageOptions Options) {
145 // Sets CoverageType and IndirectCalls.
146 SanitizerCoverageOptions CLOpts = getOptions(ClCoverageLevel);
147 Options.CoverageType = std::max(Options.CoverageType, CLOpts.CoverageType);
148 Options.IndirectCalls |= CLOpts.IndirectCalls;
149 Options.TraceBB |= ClExperimentalTracing;
150 Options.TraceCmp |= ClExperimentalCMPTracing;
151 Options.Use8bitCounters |= ClUse8bitCounters;
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000152 Options.TracePC |= ClExperimentalTracePC;
Alexey Samsonov3514f272015-05-07 01:00:31 +0000153 return Options;
154}
155
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000156class SanitizerCoverageModule : public ModulePass {
Mike Aizatsky759aca02016-03-18 23:29:29 +0000157public:
Alexey Samsonov3514f272015-05-07 01:00:31 +0000158 SanitizerCoverageModule(
159 const SanitizerCoverageOptions &Options = SanitizerCoverageOptions())
Chandler Carruthe2b70212016-03-18 22:35:58 +0000160 : ModulePass(ID), Options(OverrideFromCL(Options)) {
161 initializeSanitizerCoverageModulePass(*PassRegistry::getPassRegistry());
162 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000163 bool runOnModule(Module &M) override;
164 bool runOnFunction(Function &F);
Mike Aizatsky759aca02016-03-18 23:29:29 +0000165 static char ID; // Pass identification, replacement for typeid
166 const char *getPassName() const override { return "SanitizerCoverageModule"; }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000167
Chandler Carruth30061152016-03-18 22:43:42 +0000168 void getAnalysisUsage(AnalysisUsage &AU) const override {
169 AU.addRequired<DominatorTreeWrapperPass>();
170 AU.addRequired<PostDominatorTreeWrapperPass>();
171 }
172
173private:
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000174 void InjectCoverageForIndirectCalls(Function &F,
175 ArrayRef<Instruction *> IndirCalls);
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000176 void InjectTraceForCmp(Function &F, ArrayRef<Instruction *> CmpTraceTargets);
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000177 void InjectTraceForSwitch(Function &F,
178 ArrayRef<Instruction *> SwitchTraceTargets);
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000179 bool InjectCoverage(Function &F, ArrayRef<BasicBlock *> AllBlocks);
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000180 void SetNoSanitizeMetadata(Instruction *I);
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000181 void InjectCoverageAtBlock(Function &F, BasicBlock &BB, bool UseCalls);
Kostya Serebryany48a40232015-03-10 01:58:27 +0000182 unsigned NumberOfInstrumentedBlocks() {
Kostya Serebryanya3c53472015-12-02 02:37:13 +0000183 return SanCovFunction->getNumUses() +
184 SanCovWithCheckFunction->getNumUses() + SanCovTraceBB->getNumUses() +
185 SanCovTraceEnter->getNumUses();
Kostya Serebryany48a40232015-03-10 01:58:27 +0000186 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000187 Function *SanCovFunction;
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000188 Function *SanCovWithCheckFunction;
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000189 Function *SanCovIndirCallFunction, *SanCovTracePCIndir;
190 Function *SanCovTraceEnter, *SanCovTraceBB, *SanCovTracePC;
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000191 Function *SanCovTraceCmpFunction;
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000192 Function *SanCovTraceSwitchFunction;
Kostya Serebryany73762942014-12-16 21:24:15 +0000193 InlineAsm *EmptyAsm;
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000194 Type *IntptrTy, *Int64Ty, *Int64PtrTy;
195 Module *CurModule;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000196 LLVMContext *C;
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000197 const DataLayout *DL;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000198
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000199 GlobalVariable *GuardArray;
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000200 GlobalVariable *EightBitCounterArray;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000201
Alexey Samsonov3514f272015-05-07 01:00:31 +0000202 SanitizerCoverageOptions Options;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000203};
204
Mike Aizatsky759aca02016-03-18 23:29:29 +0000205} // namespace
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000206
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000207bool SanitizerCoverageModule::runOnModule(Module &M) {
Alexey Samsonov3514f272015-05-07 01:00:31 +0000208 if (Options.CoverageType == SanitizerCoverageOptions::SCK_None)
209 return false;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000210 C = &(M.getContext());
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000211 DL = &M.getDataLayout();
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000212 CurModule = &M;
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000213 IntptrTy = Type::getIntNTy(*C, DL->getPointerSizeInBits());
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000214 Type *VoidTy = Type::getVoidTy(*C);
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +0000215 IRBuilder<> IRB(*C);
Kostya Serebryany88599462015-02-20 00:30:44 +0000216 Type *Int8PtrTy = PointerType::getUnqual(IRB.getInt8Ty());
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000217 Type *Int32PtrTy = PointerType::getUnqual(IRB.getInt32Ty());
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000218 Int64PtrTy = PointerType::getUnqual(IRB.getInt64Ty());
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000219 Int64Ty = IRB.getInt64Ty();
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000220
Ismail Pazarbasi198d6d52015-04-06 21:09:08 +0000221 SanCovFunction = checkSanitizerInterfaceFunction(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000222 M.getOrInsertFunction(SanCovName, VoidTy, Int32PtrTy, nullptr));
Ismail Pazarbasi198d6d52015-04-06 21:09:08 +0000223 SanCovWithCheckFunction = checkSanitizerInterfaceFunction(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000224 M.getOrInsertFunction(SanCovWithCheckName, VoidTy, Int32PtrTy, nullptr));
225 SanCovTracePCIndir = checkSanitizerInterfaceFunction(
226 M.getOrInsertFunction(SanCovTracePCIndirName, VoidTy, IntptrTy, nullptr));
Ismail Pazarbasi198d6d52015-04-06 21:09:08 +0000227 SanCovIndirCallFunction =
228 checkSanitizerInterfaceFunction(M.getOrInsertFunction(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000229 SanCovIndirCallName, VoidTy, IntptrTy, IntptrTy, nullptr));
Ismail Pazarbasi198d6d52015-04-06 21:09:08 +0000230 SanCovTraceCmpFunction =
231 checkSanitizerInterfaceFunction(M.getOrInsertFunction(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000232 SanCovTraceCmpName, VoidTy, Int64Ty, Int64Ty, Int64Ty, nullptr));
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000233 SanCovTraceSwitchFunction =
234 checkSanitizerInterfaceFunction(M.getOrInsertFunction(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000235 SanCovTraceSwitchName, VoidTy, Int64Ty, Int64PtrTy, nullptr));
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000236
Kostya Serebryany73762942014-12-16 21:24:15 +0000237 // We insert an empty inline asm after cov callbacks to avoid callback merge.
238 EmptyAsm = InlineAsm::get(FunctionType::get(IRB.getVoidTy(), false),
239 StringRef(""), StringRef(""),
240 /*hasSideEffects=*/true);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000241
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000242 SanCovTracePC = checkSanitizerInterfaceFunction(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000243 M.getOrInsertFunction(SanCovTracePCName, VoidTy, nullptr));
Kostya Serebryanya3c53472015-12-02 02:37:13 +0000244 SanCovTraceEnter = checkSanitizerInterfaceFunction(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000245 M.getOrInsertFunction(SanCovTraceEnterName, VoidTy, Int32PtrTy, nullptr));
Kostya Serebryanya3c53472015-12-02 02:37:13 +0000246 SanCovTraceBB = checkSanitizerInterfaceFunction(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000247 M.getOrInsertFunction(SanCovTraceBBName, VoidTy, Int32PtrTy, nullptr));
Kostya Serebryanycb45b122014-11-19 00:22:58 +0000248
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000249 // At this point we create a dummy array of guards because we don't
250 // know how many elements we will need.
251 Type *Int32Ty = IRB.getInt32Ty();
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000252 Type *Int8Ty = IRB.getInt8Ty();
253
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000254 GuardArray =
255 new GlobalVariable(M, Int32Ty, false, GlobalValue::ExternalLinkage,
256 nullptr, "__sancov_gen_cov_tmp");
Alexey Samsonov3514f272015-05-07 01:00:31 +0000257 if (Options.Use8bitCounters)
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000258 EightBitCounterArray =
259 new GlobalVariable(M, Int8Ty, false, GlobalVariable::ExternalLinkage,
260 nullptr, "__sancov_gen_cov_tmp");
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000261
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000262 for (auto &F : M)
263 runOnFunction(F);
264
Kostya Serebryany48a40232015-03-10 01:58:27 +0000265 auto N = NumberOfInstrumentedBlocks();
266
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000267 // Now we know how many elements we need. Create an array of guards
268 // with one extra element at the beginning for the size.
Kostya Serebryany48a40232015-03-10 01:58:27 +0000269 Type *Int32ArrayNTy = ArrayType::get(Int32Ty, N + 1);
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000270 GlobalVariable *RealGuardArray = new GlobalVariable(
271 M, Int32ArrayNTy, false, GlobalValue::PrivateLinkage,
272 Constant::getNullValue(Int32ArrayNTy), "__sancov_gen_cov");
273
274 // 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.
Mike Aizatsky759aca02016-03-18 23:29:29 +0000282 static const int CounterAlignment = 16;
283 Type *Int8ArrayNTy = ArrayType::get(Int8Ty, alignTo(N, CounterAlignment));
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");
Mike Aizatsky759aca02016-03-18 23:29:29 +0000287 RealEightBitCounterArray->setAlignment(CounterAlignment);
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000288 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(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000303 M, SanCovModuleCtorName, SanCovModuleInitName,
Kostya Serebryany3c767db2016-02-27 05:45:12 +0000304 {Int32PtrTy, IntptrTy, Int8PtrTy, Int8PtrTy},
305 {IRB.CreatePointerCast(RealGuardArray, Int32PtrTy),
Mike Aizatsky759aca02016-03-18 23:29:29 +0000306 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
Mike Aizatsky759aca02016-03-18 23:29:29 +0000312 appendToGlobalCtors(M, CtorFunc, SanCtorAndDtorPriority);
Kostya Serebryany3c767db2016-02-27 05:45:12 +0000313 }
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) {
Mike Aizatsky759aca02016-03-18 23:29:29 +0000335 if (F.empty())
336 return false;
Kostya Serebryanyfea4fb42014-12-17 21:50:04 +0000337 if (F.getName().find(".module_ctor") != std::string::npos)
Mike Aizatsky759aca02016-03-18 23:29:29 +0000338 return false; // Should not instrument sanitizer init functions.
Reid Klecknerdf523372015-09-03 20:18:29 +0000339 // Don't instrument functions using SEH for now. Splitting basic blocks like
340 // we do for coverage breaks WinEHPrepare.
341 // FIXME: Remove this when SEH no longer uses landingpad pattern matching.
342 if (F.hasPersonalityFn() &&
343 isAsynchronousEHPersonality(classifyEHPersonality(F.getPersonalityFn())))
344 return false;
Alexey Samsonov3514f272015-05-07 01:00:31 +0000345 if (Options.CoverageType >= SanitizerCoverageOptions::SCK_Edge)
Chandler Carruth37df2cf2015-01-19 12:09:11 +0000346 SplitAllCriticalEdges(F);
Mike Aizatsky759aca02016-03-18 23:29:29 +0000347 SmallVector<Instruction *, 8> IndirCalls;
Mike Aizatsky5971f182016-02-26 01:17:22 +0000348 SmallVector<BasicBlock *, 16> BlocksToInstrument;
Mike Aizatsky759aca02016-03-18 23:29:29 +0000349 SmallVector<Instruction *, 8> CmpTraceTargets;
350 SmallVector<Instruction *, 8> SwitchTraceTargets;
Mike Aizatsky5971f182016-02-26 01:17:22 +0000351
Renato Golin9a5419e2016-02-27 14:19:19 +0000352 DominatorTree DT;
353 DT.recalculate(F);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000354 for (auto &BB : F) {
Renato Golin9a5419e2016-02-27 14:19:19 +0000355 if (shouldInstrumentBlock(&BB, &DT))
Mike Aizatsky5971f182016-02-26 01:17:22 +0000356 BlocksToInstrument.push_back(&BB);
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000357 for (auto &Inst : BB) {
Alexey Samsonov3514f272015-05-07 01:00:31 +0000358 if (Options.IndirectCalls) {
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000359 CallSite CS(&Inst);
360 if (CS && !CS.getCalledFunction())
361 IndirCalls.push_back(&Inst);
362 }
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000363 if (Options.TraceCmp) {
364 if (isa<ICmpInst>(&Inst))
365 CmpTraceTargets.push_back(&Inst);
366 if (isa<SwitchInst>(&Inst))
367 SwitchTraceTargets.push_back(&Inst);
368 }
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000369 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000370 }
Mike Aizatsky5971f182016-02-26 01:17:22 +0000371
372 InjectCoverage(F, BlocksToInstrument);
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000373 InjectCoverageForIndirectCalls(F, IndirCalls);
374 InjectTraceForCmp(F, CmpTraceTargets);
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000375 InjectTraceForSwitch(F, SwitchTraceTargets);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000376 return true;
377}
378
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000379bool SanitizerCoverageModule::InjectCoverage(Function &F,
380 ArrayRef<BasicBlock *> AllBlocks) {
Alexey Samsonov3514f272015-05-07 01:00:31 +0000381 switch (Options.CoverageType) {
382 case SanitizerCoverageOptions::SCK_None:
383 return false;
384 case SanitizerCoverageOptions::SCK_Function:
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000385 InjectCoverageAtBlock(F, F.getEntryBlock(), false);
Alexey Samsonov3514f272015-05-07 01:00:31 +0000386 return true;
387 default: {
388 bool UseCalls = ClCoverageBlockThreshold < AllBlocks.size();
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000389 for (auto BB : AllBlocks)
Alexey Samsonov3514f272015-05-07 01:00:31 +0000390 InjectCoverageAtBlock(F, *BB, UseCalls);
391 return true;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000392 }
Alexey Samsonov3514f272015-05-07 01:00:31 +0000393 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000394}
395
396// On every indirect call we call a run-time function
397// __sanitizer_cov_indir_call* with two parameters:
398// - callee address,
Mike Aizatsky759aca02016-03-18 23:29:29 +0000399// - global cache array that contains CacheSize pointers (zero-initialized).
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000400// The cache is used to speed up recording the caller-callee pairs.
401// The address of the caller is passed implicitly via caller PC.
Mike Aizatsky759aca02016-03-18 23:29:29 +0000402// CacheSize is encoded in the name of the run-time function.
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000403void SanitizerCoverageModule::InjectCoverageForIndirectCalls(
404 Function &F, ArrayRef<Instruction *> IndirCalls) {
Mike Aizatsky759aca02016-03-18 23:29:29 +0000405 if (IndirCalls.empty())
406 return;
407 const int CacheSize = 16;
408 const int CacheAlignment = 64; // Align for better performance.
409 Type *Ty = ArrayType::get(IntptrTy, CacheSize);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000410 for (auto I : IndirCalls) {
411 IRBuilder<> IRB(I);
412 CallSite CS(I);
413 Value *Callee = CS.getCalledValue();
Mike Aizatsky759aca02016-03-18 23:29:29 +0000414 if (isa<InlineAsm>(Callee))
415 continue;
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000416 GlobalVariable *CalleeCache = new GlobalVariable(
417 *F.getParent(), Ty, false, GlobalValue::PrivateLinkage,
418 Constant::getNullValue(Ty), "__sancov_gen_callee_cache");
Mike Aizatsky759aca02016-03-18 23:29:29 +0000419 CalleeCache->setAlignment(CacheAlignment);
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000420 if (Options.TracePC)
421 IRB.CreateCall(SanCovTracePCIndir,
422 IRB.CreatePointerCast(Callee, IntptrTy));
423 else
424 IRB.CreateCall(SanCovIndirCallFunction,
425 {IRB.CreatePointerCast(Callee, IntptrTy),
Mike Aizatsky759aca02016-03-18 23:29:29 +0000426 IRB.CreatePointerCast(CalleeCache, IntptrTy)});
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000427 }
428}
429
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000430// For every switch statement we insert a call:
431// __sanitizer_cov_trace_switch(CondValue,
432// {NumCases, ValueSizeInBits, Case0Value, Case1Value, Case2Value, ... })
433
434void SanitizerCoverageModule::InjectTraceForSwitch(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000435 Function &, ArrayRef<Instruction *> SwitchTraceTargets) {
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000436 for (auto I : SwitchTraceTargets) {
437 if (SwitchInst *SI = dyn_cast<SwitchInst>(I)) {
438 IRBuilder<> IRB(I);
439 SmallVector<Constant *, 16> Initializers;
440 Value *Cond = SI->getCondition();
Kostya Serebryany25691182015-08-11 00:24:39 +0000441 if (Cond->getType()->getScalarSizeInBits() >
442 Int64Ty->getScalarSizeInBits())
443 continue;
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000444 Initializers.push_back(ConstantInt::get(Int64Ty, SI->getNumCases()));
445 Initializers.push_back(
446 ConstantInt::get(Int64Ty, Cond->getType()->getScalarSizeInBits()));
447 if (Cond->getType()->getScalarSizeInBits() <
448 Int64Ty->getScalarSizeInBits())
449 Cond = IRB.CreateIntCast(Cond, Int64Ty, false);
Mike Aizatsky759aca02016-03-18 23:29:29 +0000450 for (auto It : SI->cases()) {
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000451 Constant *C = It.getCaseValue();
452 if (C->getType()->getScalarSizeInBits() <
453 Int64Ty->getScalarSizeInBits())
454 C = ConstantExpr::getCast(CastInst::ZExt, It.getCaseValue(), Int64Ty);
455 Initializers.push_back(C);
456 }
457 ArrayType *ArrayOfInt64Ty = ArrayType::get(Int64Ty, Initializers.size());
458 GlobalVariable *GV = new GlobalVariable(
459 *CurModule, ArrayOfInt64Ty, false, GlobalVariable::InternalLinkage,
460 ConstantArray::get(ArrayOfInt64Ty, Initializers),
461 "__sancov_gen_cov_switch_values");
462 IRB.CreateCall(SanCovTraceSwitchFunction,
463 {Cond, IRB.CreatePointerCast(GV, Int64PtrTy)});
464 }
465 }
466}
467
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000468void SanitizerCoverageModule::InjectTraceForCmp(
Mike Aizatsky759aca02016-03-18 23:29:29 +0000469 Function &, ArrayRef<Instruction *> CmpTraceTargets) {
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000470 for (auto I : CmpTraceTargets) {
471 if (ICmpInst *ICMP = dyn_cast<ICmpInst>(I)) {
472 IRBuilder<> IRB(ICMP);
473 Value *A0 = ICMP->getOperand(0);
474 Value *A1 = ICMP->getOperand(1);
Mike Aizatsky759aca02016-03-18 23:29:29 +0000475 if (!A0->getType()->isIntegerTy())
476 continue;
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000477 uint64_t TypeSize = DL->getTypeStoreSizeInBits(A0->getType());
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000478 // __sanitizer_cov_trace_cmp((type_size << 32) | predicate, A0, A1);
David Blaikieff6409d2015-05-18 22:13:54 +0000479 IRB.CreateCall(
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000480 SanCovTraceCmpFunction,
David Blaikieff6409d2015-05-18 22:13:54 +0000481 {ConstantInt::get(Int64Ty, (TypeSize << 32) | ICMP->getPredicate()),
482 IRB.CreateIntCast(A0, Int64Ty, true),
483 IRB.CreateIntCast(A1, Int64Ty, true)});
Kostya Serebryanyf4e35cc2015-03-21 01:29:36 +0000484 }
485 }
486}
487
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000488void SanitizerCoverageModule::SetNoSanitizeMetadata(Instruction *I) {
Mike Aizatsky759aca02016-03-18 23:29:29 +0000489 I->setMetadata(I->getModule()->getMDKindID("nosanitize"),
490 MDNode::get(*C, None));
Kostya Serebryany83ce8772015-03-05 01:20:05 +0000491}
492
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000493void SanitizerCoverageModule::InjectCoverageAtBlock(Function &F, BasicBlock &BB,
494 bool UseCalls) {
Alexey Samsonov342b1e82015-06-30 23:11:45 +0000495 // Don't insert coverage for unreachable blocks: we will never call
496 // __sanitizer_cov() for them, so counting them in
497 // NumberOfInstrumentedBlocks() might complicate calculation of code coverage
498 // percentage. Also, unreachable instructions frequently have no debug
499 // locations.
500 if (isa<UnreachableInst>(BB.getTerminator()))
501 return;
Justin Bogner7ae63aa2015-08-14 17:03:45 +0000502 BasicBlock::iterator IP = BB.getFirstInsertionPt();
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000503
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000504 bool IsEntryBB = &BB == &F.getEntryBlock();
Alexey Samsonov201733b2015-06-12 01:48:47 +0000505 DebugLoc EntryLoc;
506 if (IsEntryBB) {
Pete Cooperadebb932016-03-11 02:14:16 +0000507 if (auto SP = F.getSubprogram())
Alexey Samsonov201733b2015-06-12 01:48:47 +0000508 EntryLoc = DebugLoc::get(SP->getScopeLine(), 0, SP);
Reid Klecknera57d0152015-08-14 16:45:42 +0000509 // Keep static allocas and llvm.localescape calls in the entry block. Even
510 // if we aren't splitting the block, it's nice for allocas to be before
511 // calls.
512 IP = PrepareToSplitEntryBlock(BB, IP);
Alexey Samsonov201733b2015-06-12 01:48:47 +0000513 } else {
514 EntryLoc = IP->getDebugLoc();
515 }
516
Duncan P. N. Exon Smithe82c2862015-10-13 17:39:10 +0000517 IRBuilder<> IRB(&*IP);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000518 IRB.SetCurrentDebugLocation(EntryLoc);
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000519 Value *GuardP = IRB.CreateAdd(
520 IRB.CreatePointerCast(GuardArray, IntptrTy),
Kostya Serebryany48a40232015-03-10 01:58:27 +0000521 ConstantInt::get(IntptrTy, (1 + NumberOfInstrumentedBlocks()) * 4));
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000522 Type *Int32PtrTy = PointerType::getUnqual(IRB.getInt32Ty());
523 GuardP = IRB.CreateIntToPtr(GuardP, Int32PtrTy);
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000524 if (Options.TracePC) {
525 IRB.CreateCall(SanCovTracePC);
526 } else if (Options.TraceBB) {
Kostya Serebryanya3c53472015-12-02 02:37:13 +0000527 IRB.CreateCall(IsEntryBB ? SanCovTraceEnter : SanCovTraceBB, GuardP);
528 } else if (UseCalls) {
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000529 IRB.CreateCall(SanCovWithCheckFunction, GuardP);
530 } else {
531 LoadInst *Load = IRB.CreateLoad(GuardP);
532 Load->setAtomic(Monotonic);
533 Load->setAlignment(4);
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000534 SetNoSanitizeMetadata(Load);
Mike Aizatsky759aca02016-03-18 23:29:29 +0000535 Value *Cmp =
536 IRB.CreateICmpSGE(Constant::getNullValue(Load->getType()), Load);
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000537 Instruction *Ins = SplitBlockAndInsertIfThen(
Duncan P. N. Exon Smithe82c2862015-10-13 17:39:10 +0000538 Cmp, &*IP, false, MDBuilder(*C).createBranchWeights(1, 100000));
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000539 IRB.SetInsertPoint(Ins);
540 IRB.SetCurrentDebugLocation(EntryLoc);
541 // __sanitizer_cov gets the PC of the instruction using GET_CALLER_PC.
542 IRB.CreateCall(SanCovFunction, GuardP);
David Blaikieff6409d2015-05-18 22:13:54 +0000543 IRB.CreateCall(EmptyAsm, {}); // Avoids callback merge.
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000544 }
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000545
Alexey Samsonov3514f272015-05-07 01:00:31 +0000546 if (Options.Use8bitCounters) {
Duncan P. N. Exon Smithe82c2862015-10-13 17:39:10 +0000547 IRB.SetInsertPoint(&*IP);
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000548 Value *P = IRB.CreateAdd(
549 IRB.CreatePointerCast(EightBitCounterArray, IntptrTy),
Kostya Serebryany48a40232015-03-10 01:58:27 +0000550 ConstantInt::get(IntptrTy, NumberOfInstrumentedBlocks() - 1));
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000551 P = IRB.CreateIntToPtr(P, IRB.getInt8PtrTy());
Kostya Serebryany83ce8772015-03-05 01:20:05 +0000552 LoadInst *LI = IRB.CreateLoad(P);
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000553 Value *Inc = IRB.CreateAdd(LI, ConstantInt::get(IRB.getInt8Ty(), 1));
Kostya Serebryany83ce8772015-03-05 01:20:05 +0000554 StoreInst *SI = IRB.CreateStore(Inc, P);
Alexey Samsonov0a648a42015-05-06 21:35:25 +0000555 SetNoSanitizeMetadata(LI);
556 SetNoSanitizeMetadata(SI);
Kostya Serebryanybe5e0ed2015-03-03 23:27:02 +0000557 }
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000558}
559
560char SanitizerCoverageModule::ID = 0;
Mike Aizatsky90562842016-02-27 05:50:40 +0000561INITIALIZE_PASS_BEGIN(SanitizerCoverageModule, "sancov",
Mike Aizatsky759aca02016-03-18 23:29:29 +0000562 "SanitizerCoverage: TODO."
563 "ModulePass",
564 false, false)
Mike Aizatsky90562842016-02-27 05:50:40 +0000565INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
566INITIALIZE_PASS_DEPENDENCY(PostDominatorTreeWrapperPass)
567INITIALIZE_PASS_END(SanitizerCoverageModule, "sancov",
Mike Aizatsky759aca02016-03-18 23:29:29 +0000568 "SanitizerCoverage: TODO."
569 "ModulePass",
570 false, false)
Alexey Samsonov3514f272015-05-07 01:00:31 +0000571ModulePass *llvm::createSanitizerCoverageModulePass(
572 const SanitizerCoverageOptions &Options) {
573 return new SanitizerCoverageModule(Options);
Kostya Serebryany29a18dc2014-11-11 22:14:37 +0000574}