Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 1 | //===-- 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 Serebryany | 9fdeb37 | 2014-12-23 22:32:17 +0000 | [diff] [blame] | 13 | // We create a Guard variable with the same linkage |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 14 | // as the function and inject this code into the entry block (SCK_Function) |
| 15 | // or all blocks (SCK_BB): |
Kostya Serebryany | 9fdeb37 | 2014-12-23 22:32:17 +0000 | [diff] [blame] | 16 | // if (Guard < 0) { |
Kostya Serebryany | 4cadd4a | 2014-11-24 18:49:53 +0000 | [diff] [blame] | 17 | // __sanitizer_cov(&Guard); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 18 | // } |
| 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 Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 22 | // With SCK_Edge we also split critical edges this effectively |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 23 | // instrumenting all edges. |
| 24 | // |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 25 | // 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 Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 31 | #include "llvm/ADT/ArrayRef.h" |
| 32 | #include "llvm/ADT/SmallVector.h" |
David Majnemer | 70497c6 | 2015-12-02 23:06:39 +0000 | [diff] [blame] | 33 | #include "llvm/Analysis/EHPersonalities.h" |
Chandler Carruth | 3006115 | 2016-03-18 22:43:42 +0000 | [diff] [blame] | 34 | #include "llvm/Analysis/PostDominators.h" |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 35 | #include "llvm/IR/CFG.h" |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 36 | #include "llvm/IR/CallSite.h" |
| 37 | #include "llvm/IR/DataLayout.h" |
Alexey Samsonov | 201733b | 2015-06-12 01:48:47 +0000 | [diff] [blame] | 38 | #include "llvm/IR/DebugInfo.h" |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 39 | #include "llvm/IR/Dominators.h" |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 40 | #include "llvm/IR/Function.h" |
| 41 | #include "llvm/IR/IRBuilder.h" |
Kostya Serebryany | 7376294 | 2014-12-16 21:24:15 +0000 | [diff] [blame] | 42 | #include "llvm/IR/InlineAsm.h" |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 43 | #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 Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 50 | #include "llvm/Transforms/Instrumentation.h" |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 51 | #include "llvm/Transforms/Scalar.h" |
| 52 | #include "llvm/Transforms/Utils/BasicBlockUtils.h" |
| 53 | #include "llvm/Transforms/Utils/ModuleUtils.h" |
| 54 | |
| 55 | using namespace llvm; |
| 56 | |
| 57 | #define DEBUG_TYPE "sancov" |
| 58 | |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 59 | static const char *const SanCovModuleInitName = "__sanitizer_cov_module_init"; |
| 60 | static const char *const SanCovName = "__sanitizer_cov"; |
| 61 | static const char *const SanCovWithCheckName = "__sanitizer_cov_with_check"; |
| 62 | static const char *const SanCovIndirCallName = "__sanitizer_cov_indir_call16"; |
| 63 | static const char *const SanCovTracePCIndirName = |
| 64 | "__sanitizer_cov_trace_pc_indir"; |
| 65 | static const char *const SanCovTraceEnterName = |
| 66 | "__sanitizer_cov_trace_func_enter"; |
| 67 | static const char *const SanCovTraceBBName = |
| 68 | "__sanitizer_cov_trace_basic_block"; |
| 69 | static const char *const SanCovTracePCName = "__sanitizer_cov_trace_pc"; |
| 70 | static const char *const SanCovTraceCmpName = "__sanitizer_cov_trace_cmp"; |
| 71 | static const char *const SanCovTraceSwitchName = "__sanitizer_cov_trace_switch"; |
| 72 | static const char *const SanCovModuleCtorName = "sancov.module_ctor"; |
| 73 | static const uint64_t SanCtorAndDtorPriority = 2; |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 74 | |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 75 | static 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 Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 81 | |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 82 | static cl::opt<unsigned> ClCoverageBlockThreshold( |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 83 | "sanitizer-coverage-block-threshold", |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 84 | cl::desc("Use a callback with a guard check inside it if there are" |
| 85 | " more than this number of blocks."), |
Kostya Serebryany | 8fb05ac | 2015-03-10 01:11:53 +0000 | [diff] [blame] | 86 | cl::Hidden, cl::init(500)); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 87 | |
Kostya Serebryany | cb45b12 | 2014-11-19 00:22:58 +0000 | [diff] [blame] | 88 | static 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 Serebryany | d4590c7 | 2016-02-17 21:34:43 +0000 | [diff] [blame] | 94 | static cl::opt<bool> ClExperimentalTracePC("sanitizer-coverage-trace-pc", |
| 95 | cl::desc("Experimental pc tracing"), |
| 96 | cl::Hidden, cl::init(false)); |
| 97 | |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 98 | static 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 Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 104 | static 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 Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 109 | // 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. |
| 115 | static cl::opt<bool> ClUse8bitCounters("sanitizer-coverage-8bit-counters", |
| 116 | cl::desc("Experimental 8-bit counters"), |
| 117 | cl::Hidden, cl::init(false)); |
| 118 | |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 119 | namespace { |
| 120 | |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 121 | SanitizerCoverageOptions 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 | |
| 144 | SanitizerCoverageOptions 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 Serebryany | d4590c7 | 2016-02-17 21:34:43 +0000 | [diff] [blame] | 152 | Options.TracePC |= ClExperimentalTracePC; |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 153 | return Options; |
| 154 | } |
| 155 | |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 156 | class SanitizerCoverageModule : public ModulePass { |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 157 | public: |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 158 | SanitizerCoverageModule( |
| 159 | const SanitizerCoverageOptions &Options = SanitizerCoverageOptions()) |
Chandler Carruth | e2b7021 | 2016-03-18 22:35:58 +0000 | [diff] [blame] | 160 | : ModulePass(ID), Options(OverrideFromCL(Options)) { |
| 161 | initializeSanitizerCoverageModulePass(*PassRegistry::getPassRegistry()); |
| 162 | } |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 163 | bool runOnModule(Module &M) override; |
| 164 | bool runOnFunction(Function &F); |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 165 | static char ID; // Pass identification, replacement for typeid |
| 166 | const char *getPassName() const override { return "SanitizerCoverageModule"; } |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 167 | |
Chandler Carruth | 3006115 | 2016-03-18 22:43:42 +0000 | [diff] [blame] | 168 | void getAnalysisUsage(AnalysisUsage &AU) const override { |
| 169 | AU.addRequired<DominatorTreeWrapperPass>(); |
| 170 | AU.addRequired<PostDominatorTreeWrapperPass>(); |
| 171 | } |
| 172 | |
| 173 | private: |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 174 | void InjectCoverageForIndirectCalls(Function &F, |
| 175 | ArrayRef<Instruction *> IndirCalls); |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 176 | void InjectTraceForCmp(Function &F, ArrayRef<Instruction *> CmpTraceTargets); |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 177 | void InjectTraceForSwitch(Function &F, |
| 178 | ArrayRef<Instruction *> SwitchTraceTargets); |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 179 | bool InjectCoverage(Function &F, ArrayRef<BasicBlock *> AllBlocks); |
Alexey Samsonov | 0a648a4 | 2015-05-06 21:35:25 +0000 | [diff] [blame] | 180 | void SetNoSanitizeMetadata(Instruction *I); |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 181 | void InjectCoverageAtBlock(Function &F, BasicBlock &BB, bool UseCalls); |
Kostya Serebryany | 48a4023 | 2015-03-10 01:58:27 +0000 | [diff] [blame] | 182 | unsigned NumberOfInstrumentedBlocks() { |
Kostya Serebryany | a3c5347 | 2015-12-02 02:37:13 +0000 | [diff] [blame] | 183 | return SanCovFunction->getNumUses() + |
| 184 | SanCovWithCheckFunction->getNumUses() + SanCovTraceBB->getNumUses() + |
| 185 | SanCovTraceEnter->getNumUses(); |
Kostya Serebryany | 48a4023 | 2015-03-10 01:58:27 +0000 | [diff] [blame] | 186 | } |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 187 | Function *SanCovFunction; |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 188 | Function *SanCovWithCheckFunction; |
Kostya Serebryany | d4590c7 | 2016-02-17 21:34:43 +0000 | [diff] [blame] | 189 | Function *SanCovIndirCallFunction, *SanCovTracePCIndir; |
| 190 | Function *SanCovTraceEnter, *SanCovTraceBB, *SanCovTracePC; |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 191 | Function *SanCovTraceCmpFunction; |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 192 | Function *SanCovTraceSwitchFunction; |
Kostya Serebryany | 7376294 | 2014-12-16 21:24:15 +0000 | [diff] [blame] | 193 | InlineAsm *EmptyAsm; |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 194 | Type *IntptrTy, *Int64Ty, *Int64PtrTy; |
| 195 | Module *CurModule; |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 196 | LLVMContext *C; |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 197 | const DataLayout *DL; |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 198 | |
Kostya Serebryany | aa185bf | 2014-12-30 19:29:28 +0000 | [diff] [blame] | 199 | GlobalVariable *GuardArray; |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 200 | GlobalVariable *EightBitCounterArray; |
Kostya Serebryany | 9fdeb37 | 2014-12-23 22:32:17 +0000 | [diff] [blame] | 201 | |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 202 | SanitizerCoverageOptions Options; |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 203 | }; |
| 204 | |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 205 | } // namespace |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 206 | |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 207 | bool SanitizerCoverageModule::runOnModule(Module &M) { |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 208 | if (Options.CoverageType == SanitizerCoverageOptions::SCK_None) |
| 209 | return false; |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 210 | C = &(M.getContext()); |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 211 | DL = &M.getDataLayout(); |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 212 | CurModule = &M; |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 213 | IntptrTy = Type::getIntNTy(*C, DL->getPointerSizeInBits()); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 214 | Type *VoidTy = Type::getVoidTy(*C); |
Kostya Serebryany | 4cadd4a | 2014-11-24 18:49:53 +0000 | [diff] [blame] | 215 | IRBuilder<> IRB(*C); |
Kostya Serebryany | 8859946 | 2015-02-20 00:30:44 +0000 | [diff] [blame] | 216 | Type *Int8PtrTy = PointerType::getUnqual(IRB.getInt8Ty()); |
Kostya Serebryany | 9fdeb37 | 2014-12-23 22:32:17 +0000 | [diff] [blame] | 217 | Type *Int32PtrTy = PointerType::getUnqual(IRB.getInt32Ty()); |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 218 | Int64PtrTy = PointerType::getUnqual(IRB.getInt64Ty()); |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 219 | Int64Ty = IRB.getInt64Ty(); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 220 | |
Ismail Pazarbasi | 198d6d5 | 2015-04-06 21:09:08 +0000 | [diff] [blame] | 221 | SanCovFunction = checkSanitizerInterfaceFunction( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 222 | M.getOrInsertFunction(SanCovName, VoidTy, Int32PtrTy, nullptr)); |
Ismail Pazarbasi | 198d6d5 | 2015-04-06 21:09:08 +0000 | [diff] [blame] | 223 | SanCovWithCheckFunction = checkSanitizerInterfaceFunction( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 224 | M.getOrInsertFunction(SanCovWithCheckName, VoidTy, Int32PtrTy, nullptr)); |
| 225 | SanCovTracePCIndir = checkSanitizerInterfaceFunction( |
| 226 | M.getOrInsertFunction(SanCovTracePCIndirName, VoidTy, IntptrTy, nullptr)); |
Ismail Pazarbasi | 198d6d5 | 2015-04-06 21:09:08 +0000 | [diff] [blame] | 227 | SanCovIndirCallFunction = |
| 228 | checkSanitizerInterfaceFunction(M.getOrInsertFunction( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 229 | SanCovIndirCallName, VoidTy, IntptrTy, IntptrTy, nullptr)); |
Ismail Pazarbasi | 198d6d5 | 2015-04-06 21:09:08 +0000 | [diff] [blame] | 230 | SanCovTraceCmpFunction = |
| 231 | checkSanitizerInterfaceFunction(M.getOrInsertFunction( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 232 | SanCovTraceCmpName, VoidTy, Int64Ty, Int64Ty, Int64Ty, nullptr)); |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 233 | SanCovTraceSwitchFunction = |
| 234 | checkSanitizerInterfaceFunction(M.getOrInsertFunction( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 235 | SanCovTraceSwitchName, VoidTy, Int64Ty, Int64PtrTy, nullptr)); |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 236 | |
Kostya Serebryany | 7376294 | 2014-12-16 21:24:15 +0000 | [diff] [blame] | 237 | // 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 Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 241 | |
Kostya Serebryany | d4590c7 | 2016-02-17 21:34:43 +0000 | [diff] [blame] | 242 | SanCovTracePC = checkSanitizerInterfaceFunction( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 243 | M.getOrInsertFunction(SanCovTracePCName, VoidTy, nullptr)); |
Kostya Serebryany | a3c5347 | 2015-12-02 02:37:13 +0000 | [diff] [blame] | 244 | SanCovTraceEnter = checkSanitizerInterfaceFunction( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 245 | M.getOrInsertFunction(SanCovTraceEnterName, VoidTy, Int32PtrTy, nullptr)); |
Kostya Serebryany | a3c5347 | 2015-12-02 02:37:13 +0000 | [diff] [blame] | 246 | SanCovTraceBB = checkSanitizerInterfaceFunction( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 247 | M.getOrInsertFunction(SanCovTraceBBName, VoidTy, Int32PtrTy, nullptr)); |
Kostya Serebryany | cb45b12 | 2014-11-19 00:22:58 +0000 | [diff] [blame] | 248 | |
Kostya Serebryany | aa185bf | 2014-12-30 19:29:28 +0000 | [diff] [blame] | 249 | // 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 Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 252 | Type *Int8Ty = IRB.getInt8Ty(); |
| 253 | |
Kostya Serebryany | aa185bf | 2014-12-30 19:29:28 +0000 | [diff] [blame] | 254 | GuardArray = |
| 255 | new GlobalVariable(M, Int32Ty, false, GlobalValue::ExternalLinkage, |
| 256 | nullptr, "__sancov_gen_cov_tmp"); |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 257 | if (Options.Use8bitCounters) |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 258 | EightBitCounterArray = |
| 259 | new GlobalVariable(M, Int8Ty, false, GlobalVariable::ExternalLinkage, |
| 260 | nullptr, "__sancov_gen_cov_tmp"); |
Kostya Serebryany | aa185bf | 2014-12-30 19:29:28 +0000 | [diff] [blame] | 261 | |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 262 | for (auto &F : M) |
| 263 | runOnFunction(F); |
| 264 | |
Kostya Serebryany | 48a4023 | 2015-03-10 01:58:27 +0000 | [diff] [blame] | 265 | auto N = NumberOfInstrumentedBlocks(); |
| 266 | |
Kostya Serebryany | aa185bf | 2014-12-30 19:29:28 +0000 | [diff] [blame] | 267 | // 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 Serebryany | 48a4023 | 2015-03-10 01:58:27 +0000 | [diff] [blame] | 269 | Type *Int32ArrayNTy = ArrayType::get(Int32Ty, N + 1); |
Kostya Serebryany | aa185bf | 2014-12-30 19:29:28 +0000 | [diff] [blame] | 270 | 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 Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 279 | GlobalVariable *RealEightBitCounterArray; |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 280 | if (Options.Use8bitCounters) { |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 281 | // Make sure the array is 16-aligned. |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 282 | static const int CounterAlignment = 16; |
| 283 | Type *Int8ArrayNTy = ArrayType::get(Int8Ty, alignTo(N, CounterAlignment)); |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 284 | RealEightBitCounterArray = new GlobalVariable( |
| 285 | M, Int8ArrayNTy, false, GlobalValue::PrivateLinkage, |
| 286 | Constant::getNullValue(Int8ArrayNTy), "__sancov_gen_cov_counter"); |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 287 | RealEightBitCounterArray->setAlignment(CounterAlignment); |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 288 | EightBitCounterArray->replaceAllUsesWith( |
| 289 | IRB.CreatePointerCast(RealEightBitCounterArray, Int8PtrTy)); |
| 290 | EightBitCounterArray->eraseFromParent(); |
| 291 | } |
| 292 | |
Kostya Serebryany | 8859946 | 2015-02-20 00:30:44 +0000 | [diff] [blame] | 293 | // 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 Serebryany | 3c767db | 2016-02-27 05:45:12 +0000 | [diff] [blame] | 300 | if (!Options.TracePC) { |
| 301 | Function *CtorFunc; |
| 302 | std::tie(CtorFunc, std::ignore) = createSanitizerCtorAndInitFunctions( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 303 | M, SanCovModuleCtorName, SanCovModuleInitName, |
Kostya Serebryany | 3c767db | 2016-02-27 05:45:12 +0000 | [diff] [blame] | 304 | {Int32PtrTy, IntptrTy, Int8PtrTy, Int8PtrTy}, |
| 305 | {IRB.CreatePointerCast(RealGuardArray, Int32PtrTy), |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 306 | ConstantInt::get(IntptrTy, N), |
| 307 | Options.Use8bitCounters |
| 308 | ? IRB.CreatePointerCast(RealEightBitCounterArray, Int8PtrTy) |
| 309 | : Constant::getNullValue(Int8PtrTy), |
| 310 | IRB.CreatePointerCast(ModuleName, Int8PtrTy)}); |
Ismail Pazarbasi | d02ce13 | 2015-05-10 13:45:05 +0000 | [diff] [blame] | 311 | |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 312 | appendToGlobalCtors(M, CtorFunc, SanCtorAndDtorPriority); |
Kostya Serebryany | 3c767db | 2016-02-27 05:45:12 +0000 | [diff] [blame] | 313 | } |
Ismail Pazarbasi | d02ce13 | 2015-05-10 13:45:05 +0000 | [diff] [blame] | 314 | |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 315 | return true; |
| 316 | } |
| 317 | |
Renato Golin | 9a5419e | 2016-02-27 14:19:19 +0000 | [diff] [blame] | 318 | static bool shouldInstrumentBlock(const BasicBlock *BB, |
| 319 | const DominatorTree *DT) { |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 320 | if (!ClPruneBlocks) |
| 321 | return true; |
Renato Golin | 9a5419e | 2016-02-27 14:19:19 +0000 | [diff] [blame] | 322 | if (succ_begin(BB) == succ_end(BB)) |
| 323 | return true; |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 324 | |
| 325 | // Check if BB dominates all its successors. |
| 326 | for (const BasicBlock *SUCC : make_range(succ_begin(BB), succ_end(BB))) { |
Renato Golin | 9a5419e | 2016-02-27 14:19:19 +0000 | [diff] [blame] | 327 | if (!DT->dominates(BB, SUCC)) |
| 328 | return true; |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 329 | } |
| 330 | |
Renato Golin | 9a5419e | 2016-02-27 14:19:19 +0000 | [diff] [blame] | 331 | return false; |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 332 | } |
| 333 | |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 334 | bool SanitizerCoverageModule::runOnFunction(Function &F) { |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 335 | if (F.empty()) |
| 336 | return false; |
Kostya Serebryany | fea4fb4 | 2014-12-17 21:50:04 +0000 | [diff] [blame] | 337 | if (F.getName().find(".module_ctor") != std::string::npos) |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 338 | return false; // Should not instrument sanitizer init functions. |
Reid Kleckner | df52337 | 2015-09-03 20:18:29 +0000 | [diff] [blame] | 339 | // 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 Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 345 | if (Options.CoverageType >= SanitizerCoverageOptions::SCK_Edge) |
Chandler Carruth | 37df2cf | 2015-01-19 12:09:11 +0000 | [diff] [blame] | 346 | SplitAllCriticalEdges(F); |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 347 | SmallVector<Instruction *, 8> IndirCalls; |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 348 | SmallVector<BasicBlock *, 16> BlocksToInstrument; |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 349 | SmallVector<Instruction *, 8> CmpTraceTargets; |
| 350 | SmallVector<Instruction *, 8> SwitchTraceTargets; |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 351 | |
Renato Golin | 9a5419e | 2016-02-27 14:19:19 +0000 | [diff] [blame] | 352 | DominatorTree DT; |
| 353 | DT.recalculate(F); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 354 | for (auto &BB : F) { |
Renato Golin | 9a5419e | 2016-02-27 14:19:19 +0000 | [diff] [blame] | 355 | if (shouldInstrumentBlock(&BB, &DT)) |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 356 | BlocksToInstrument.push_back(&BB); |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 357 | for (auto &Inst : BB) { |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 358 | if (Options.IndirectCalls) { |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 359 | CallSite CS(&Inst); |
| 360 | if (CS && !CS.getCalledFunction()) |
| 361 | IndirCalls.push_back(&Inst); |
| 362 | } |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 363 | 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 Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 369 | } |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 370 | } |
Mike Aizatsky | 5971f18 | 2016-02-26 01:17:22 +0000 | [diff] [blame] | 371 | |
| 372 | InjectCoverage(F, BlocksToInstrument); |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 373 | InjectCoverageForIndirectCalls(F, IndirCalls); |
| 374 | InjectTraceForCmp(F, CmpTraceTargets); |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 375 | InjectTraceForSwitch(F, SwitchTraceTargets); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 376 | return true; |
| 377 | } |
| 378 | |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 379 | bool SanitizerCoverageModule::InjectCoverage(Function &F, |
| 380 | ArrayRef<BasicBlock *> AllBlocks) { |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 381 | switch (Options.CoverageType) { |
| 382 | case SanitizerCoverageOptions::SCK_None: |
| 383 | return false; |
| 384 | case SanitizerCoverageOptions::SCK_Function: |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 385 | InjectCoverageAtBlock(F, F.getEntryBlock(), false); |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 386 | return true; |
| 387 | default: { |
| 388 | bool UseCalls = ClCoverageBlockThreshold < AllBlocks.size(); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 389 | for (auto BB : AllBlocks) |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 390 | InjectCoverageAtBlock(F, *BB, UseCalls); |
| 391 | return true; |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 392 | } |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 393 | } |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 394 | } |
| 395 | |
| 396 | // On every indirect call we call a run-time function |
| 397 | // __sanitizer_cov_indir_call* with two parameters: |
| 398 | // - callee address, |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 399 | // - global cache array that contains CacheSize pointers (zero-initialized). |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 400 | // 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 Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 402 | // CacheSize is encoded in the name of the run-time function. |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 403 | void SanitizerCoverageModule::InjectCoverageForIndirectCalls( |
| 404 | Function &F, ArrayRef<Instruction *> IndirCalls) { |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 405 | 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 Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 410 | for (auto I : IndirCalls) { |
| 411 | IRBuilder<> IRB(I); |
| 412 | CallSite CS(I); |
| 413 | Value *Callee = CS.getCalledValue(); |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 414 | if (isa<InlineAsm>(Callee)) |
| 415 | continue; |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 416 | GlobalVariable *CalleeCache = new GlobalVariable( |
| 417 | *F.getParent(), Ty, false, GlobalValue::PrivateLinkage, |
| 418 | Constant::getNullValue(Ty), "__sancov_gen_callee_cache"); |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 419 | CalleeCache->setAlignment(CacheAlignment); |
Kostya Serebryany | d4590c7 | 2016-02-17 21:34:43 +0000 | [diff] [blame] | 420 | if (Options.TracePC) |
| 421 | IRB.CreateCall(SanCovTracePCIndir, |
| 422 | IRB.CreatePointerCast(Callee, IntptrTy)); |
| 423 | else |
| 424 | IRB.CreateCall(SanCovIndirCallFunction, |
| 425 | {IRB.CreatePointerCast(Callee, IntptrTy), |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 426 | IRB.CreatePointerCast(CalleeCache, IntptrTy)}); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 427 | } |
| 428 | } |
| 429 | |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 430 | // For every switch statement we insert a call: |
| 431 | // __sanitizer_cov_trace_switch(CondValue, |
| 432 | // {NumCases, ValueSizeInBits, Case0Value, Case1Value, Case2Value, ... }) |
| 433 | |
| 434 | void SanitizerCoverageModule::InjectTraceForSwitch( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 435 | Function &, ArrayRef<Instruction *> SwitchTraceTargets) { |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 436 | 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 Serebryany | 2569118 | 2015-08-11 00:24:39 +0000 | [diff] [blame] | 441 | if (Cond->getType()->getScalarSizeInBits() > |
| 442 | Int64Ty->getScalarSizeInBits()) |
| 443 | continue; |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 444 | 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 Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 450 | for (auto It : SI->cases()) { |
Kostya Serebryany | fb7d8d9 | 2015-07-31 01:33:06 +0000 | [diff] [blame] | 451 | 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 Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 468 | void SanitizerCoverageModule::InjectTraceForCmp( |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 469 | Function &, ArrayRef<Instruction *> CmpTraceTargets) { |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 470 | 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 Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 475 | if (!A0->getType()->isIntegerTy()) |
| 476 | continue; |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 477 | uint64_t TypeSize = DL->getTypeStoreSizeInBits(A0->getType()); |
Alexey Samsonov | 0a648a4 | 2015-05-06 21:35:25 +0000 | [diff] [blame] | 478 | // __sanitizer_cov_trace_cmp((type_size << 32) | predicate, A0, A1); |
David Blaikie | ff6409d | 2015-05-18 22:13:54 +0000 | [diff] [blame] | 479 | IRB.CreateCall( |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 480 | SanCovTraceCmpFunction, |
David Blaikie | ff6409d | 2015-05-18 22:13:54 +0000 | [diff] [blame] | 481 | {ConstantInt::get(Int64Ty, (TypeSize << 32) | ICMP->getPredicate()), |
| 482 | IRB.CreateIntCast(A0, Int64Ty, true), |
| 483 | IRB.CreateIntCast(A1, Int64Ty, true)}); |
Kostya Serebryany | f4e35cc | 2015-03-21 01:29:36 +0000 | [diff] [blame] | 484 | } |
| 485 | } |
| 486 | } |
| 487 | |
Alexey Samsonov | 0a648a4 | 2015-05-06 21:35:25 +0000 | [diff] [blame] | 488 | void SanitizerCoverageModule::SetNoSanitizeMetadata(Instruction *I) { |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 489 | I->setMetadata(I->getModule()->getMDKindID("nosanitize"), |
| 490 | MDNode::get(*C, None)); |
Kostya Serebryany | 83ce877 | 2015-03-05 01:20:05 +0000 | [diff] [blame] | 491 | } |
| 492 | |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 493 | void SanitizerCoverageModule::InjectCoverageAtBlock(Function &F, BasicBlock &BB, |
| 494 | bool UseCalls) { |
Alexey Samsonov | 342b1e8 | 2015-06-30 23:11:45 +0000 | [diff] [blame] | 495 | // 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 Bogner | 7ae63aa | 2015-08-14 17:03:45 +0000 | [diff] [blame] | 502 | BasicBlock::iterator IP = BB.getFirstInsertionPt(); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 503 | |
Kostya Serebryany | d421db0 | 2015-01-03 00:54:43 +0000 | [diff] [blame] | 504 | bool IsEntryBB = &BB == &F.getEntryBlock(); |
Alexey Samsonov | 201733b | 2015-06-12 01:48:47 +0000 | [diff] [blame] | 505 | DebugLoc EntryLoc; |
| 506 | if (IsEntryBB) { |
Pete Cooper | adebb93 | 2016-03-11 02:14:16 +0000 | [diff] [blame] | 507 | if (auto SP = F.getSubprogram()) |
Alexey Samsonov | 201733b | 2015-06-12 01:48:47 +0000 | [diff] [blame] | 508 | EntryLoc = DebugLoc::get(SP->getScopeLine(), 0, SP); |
Reid Kleckner | a57d015 | 2015-08-14 16:45:42 +0000 | [diff] [blame] | 509 | // 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 Samsonov | 201733b | 2015-06-12 01:48:47 +0000 | [diff] [blame] | 513 | } else { |
| 514 | EntryLoc = IP->getDebugLoc(); |
| 515 | } |
| 516 | |
Duncan P. N. Exon Smith | e82c286 | 2015-10-13 17:39:10 +0000 | [diff] [blame] | 517 | IRBuilder<> IRB(&*IP); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 518 | IRB.SetCurrentDebugLocation(EntryLoc); |
Kostya Serebryany | aa185bf | 2014-12-30 19:29:28 +0000 | [diff] [blame] | 519 | Value *GuardP = IRB.CreateAdd( |
| 520 | IRB.CreatePointerCast(GuardArray, IntptrTy), |
Kostya Serebryany | 48a4023 | 2015-03-10 01:58:27 +0000 | [diff] [blame] | 521 | ConstantInt::get(IntptrTy, (1 + NumberOfInstrumentedBlocks()) * 4)); |
Kostya Serebryany | aa185bf | 2014-12-30 19:29:28 +0000 | [diff] [blame] | 522 | Type *Int32PtrTy = PointerType::getUnqual(IRB.getInt32Ty()); |
| 523 | GuardP = IRB.CreateIntToPtr(GuardP, Int32PtrTy); |
Kostya Serebryany | d4590c7 | 2016-02-17 21:34:43 +0000 | [diff] [blame] | 524 | if (Options.TracePC) { |
| 525 | IRB.CreateCall(SanCovTracePC); |
| 526 | } else if (Options.TraceBB) { |
Kostya Serebryany | a3c5347 | 2015-12-02 02:37:13 +0000 | [diff] [blame] | 527 | IRB.CreateCall(IsEntryBB ? SanCovTraceEnter : SanCovTraceBB, GuardP); |
| 528 | } else if (UseCalls) { |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 529 | IRB.CreateCall(SanCovWithCheckFunction, GuardP); |
| 530 | } else { |
| 531 | LoadInst *Load = IRB.CreateLoad(GuardP); |
| 532 | Load->setAtomic(Monotonic); |
| 533 | Load->setAlignment(4); |
Alexey Samsonov | 0a648a4 | 2015-05-06 21:35:25 +0000 | [diff] [blame] | 534 | SetNoSanitizeMetadata(Load); |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 535 | Value *Cmp = |
| 536 | IRB.CreateICmpSGE(Constant::getNullValue(Load->getType()), Load); |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 537 | Instruction *Ins = SplitBlockAndInsertIfThen( |
Duncan P. N. Exon Smith | e82c286 | 2015-10-13 17:39:10 +0000 | [diff] [blame] | 538 | Cmp, &*IP, false, MDBuilder(*C).createBranchWeights(1, 100000)); |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 539 | 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 Blaikie | ff6409d | 2015-05-18 22:13:54 +0000 | [diff] [blame] | 543 | IRB.CreateCall(EmptyAsm, {}); // Avoids callback merge. |
Kostya Serebryany | 77cc729 | 2015-02-04 01:21:45 +0000 | [diff] [blame] | 544 | } |
Kostya Serebryany | d421db0 | 2015-01-03 00:54:43 +0000 | [diff] [blame] | 545 | |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 546 | if (Options.Use8bitCounters) { |
Duncan P. N. Exon Smith | e82c286 | 2015-10-13 17:39:10 +0000 | [diff] [blame] | 547 | IRB.SetInsertPoint(&*IP); |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 548 | Value *P = IRB.CreateAdd( |
| 549 | IRB.CreatePointerCast(EightBitCounterArray, IntptrTy), |
Kostya Serebryany | 48a4023 | 2015-03-10 01:58:27 +0000 | [diff] [blame] | 550 | ConstantInt::get(IntptrTy, NumberOfInstrumentedBlocks() - 1)); |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 551 | P = IRB.CreateIntToPtr(P, IRB.getInt8PtrTy()); |
Kostya Serebryany | 83ce877 | 2015-03-05 01:20:05 +0000 | [diff] [blame] | 552 | LoadInst *LI = IRB.CreateLoad(P); |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 553 | Value *Inc = IRB.CreateAdd(LI, ConstantInt::get(IRB.getInt8Ty(), 1)); |
Kostya Serebryany | 83ce877 | 2015-03-05 01:20:05 +0000 | [diff] [blame] | 554 | StoreInst *SI = IRB.CreateStore(Inc, P); |
Alexey Samsonov | 0a648a4 | 2015-05-06 21:35:25 +0000 | [diff] [blame] | 555 | SetNoSanitizeMetadata(LI); |
| 556 | SetNoSanitizeMetadata(SI); |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 557 | } |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 558 | } |
| 559 | |
| 560 | char SanitizerCoverageModule::ID = 0; |
Mike Aizatsky | 9056284 | 2016-02-27 05:50:40 +0000 | [diff] [blame] | 561 | INITIALIZE_PASS_BEGIN(SanitizerCoverageModule, "sancov", |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 562 | "SanitizerCoverage: TODO." |
| 563 | "ModulePass", |
| 564 | false, false) |
Mike Aizatsky | 9056284 | 2016-02-27 05:50:40 +0000 | [diff] [blame] | 565 | INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) |
| 566 | INITIALIZE_PASS_DEPENDENCY(PostDominatorTreeWrapperPass) |
| 567 | INITIALIZE_PASS_END(SanitizerCoverageModule, "sancov", |
Mike Aizatsky | 759aca0 | 2016-03-18 23:29:29 +0000 | [diff] [blame^] | 568 | "SanitizerCoverage: TODO." |
| 569 | "ModulePass", |
| 570 | false, false) |
Alexey Samsonov | 3514f27 | 2015-05-07 01:00:31 +0000 | [diff] [blame] | 571 | ModulePass *llvm::createSanitizerCoverageModulePass( |
| 572 | const SanitizerCoverageOptions &Options) { |
| 573 | return new SanitizerCoverageModule(Options); |
Kostya Serebryany | 29a18dc | 2014-11-11 22:14:37 +0000 | [diff] [blame] | 574 | } |