1 //===-- SanitizerCoverage.cpp - coverage instrumentation for sanitizers ---===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // Coverage instrumentation done on LLVM IR level, works with Sanitizers. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #include "llvm/Transforms/Instrumentation/SanitizerCoverage.h" 14 #include "llvm/ADT/ArrayRef.h" 15 #include "llvm/ADT/SmallVector.h" 16 #include "llvm/Analysis/GlobalsModRef.h" 17 #include "llvm/Analysis/PostDominators.h" 18 #include "llvm/IR/Constant.h" 19 #include "llvm/IR/DataLayout.h" 20 #include "llvm/IR/Dominators.h" 21 #include "llvm/IR/EHPersonalities.h" 22 #include "llvm/IR/Function.h" 23 #include "llvm/IR/GlobalVariable.h" 24 #include "llvm/IR/IRBuilder.h" 25 #include "llvm/IR/IntrinsicInst.h" 26 #include "llvm/IR/Intrinsics.h" 27 #include "llvm/IR/LLVMContext.h" 28 #include "llvm/IR/Module.h" 29 #include "llvm/IR/Type.h" 30 #include "llvm/Support/CommandLine.h" 31 #include "llvm/Support/SpecialCaseList.h" 32 #include "llvm/Support/VirtualFileSystem.h" 33 #include "llvm/TargetParser/Triple.h" 34 #include "llvm/Transforms/Utils/BasicBlockUtils.h" 35 #include "llvm/Transforms/Utils/ModuleUtils.h" 36 37 using namespace llvm; 38 39 #define DEBUG_TYPE "sancov" 40 41 const char SanCovTracePCIndirName[] = "__sanitizer_cov_trace_pc_indir"; 42 const char SanCovTracePCName[] = "__sanitizer_cov_trace_pc"; 43 const char SanCovTraceCmp1[] = "__sanitizer_cov_trace_cmp1"; 44 const char SanCovTraceCmp2[] = "__sanitizer_cov_trace_cmp2"; 45 const char SanCovTraceCmp4[] = "__sanitizer_cov_trace_cmp4"; 46 const char SanCovTraceCmp8[] = "__sanitizer_cov_trace_cmp8"; 47 const char SanCovTraceConstCmp1[] = "__sanitizer_cov_trace_const_cmp1"; 48 const char SanCovTraceConstCmp2[] = "__sanitizer_cov_trace_const_cmp2"; 49 const char SanCovTraceConstCmp4[] = "__sanitizer_cov_trace_const_cmp4"; 50 const char SanCovTraceConstCmp8[] = "__sanitizer_cov_trace_const_cmp8"; 51 const char SanCovLoad1[] = "__sanitizer_cov_load1"; 52 const char SanCovLoad2[] = "__sanitizer_cov_load2"; 53 const char SanCovLoad4[] = "__sanitizer_cov_load4"; 54 const char SanCovLoad8[] = "__sanitizer_cov_load8"; 55 const char SanCovLoad16[] = "__sanitizer_cov_load16"; 56 const char SanCovStore1[] = "__sanitizer_cov_store1"; 57 const char SanCovStore2[] = "__sanitizer_cov_store2"; 58 const char SanCovStore4[] = "__sanitizer_cov_store4"; 59 const char SanCovStore8[] = "__sanitizer_cov_store8"; 60 const char SanCovStore16[] = "__sanitizer_cov_store16"; 61 const char SanCovTraceDiv4[] = "__sanitizer_cov_trace_div4"; 62 const char SanCovTraceDiv8[] = "__sanitizer_cov_trace_div8"; 63 const char SanCovTraceGep[] = "__sanitizer_cov_trace_gep"; 64 const char SanCovTraceSwitchName[] = "__sanitizer_cov_trace_switch"; 65 const char SanCovModuleCtorTracePcGuardName[] = 66 "sancov.module_ctor_trace_pc_guard"; 67 const char SanCovModuleCtor8bitCountersName[] = 68 "sancov.module_ctor_8bit_counters"; 69 const char SanCovModuleCtorBoolFlagName[] = "sancov.module_ctor_bool_flag"; 70 static const uint64_t SanCtorAndDtorPriority = 2; 71 72 const char SanCovTracePCGuardName[] = "__sanitizer_cov_trace_pc_guard"; 73 const char SanCovTracePCGuardInitName[] = "__sanitizer_cov_trace_pc_guard_init"; 74 const char SanCov8bitCountersInitName[] = "__sanitizer_cov_8bit_counters_init"; 75 const char SanCovBoolFlagInitName[] = "__sanitizer_cov_bool_flag_init"; 76 const char SanCovPCsInitName[] = "__sanitizer_cov_pcs_init"; 77 const char SanCovCFsInitName[] = "__sanitizer_cov_cfs_init"; 78 79 const char SanCovGuardsSectionName[] = "sancov_guards"; 80 const char SanCovCountersSectionName[] = "sancov_cntrs"; 81 const char SanCovBoolFlagSectionName[] = "sancov_bools"; 82 const char SanCovPCsSectionName[] = "sancov_pcs"; 83 const char SanCovCFsSectionName[] = "sancov_cfs"; 84 85 const char SanCovLowestStackName[] = "__sancov_lowest_stack"; 86 87 static cl::opt<int> ClCoverageLevel( 88 "sanitizer-coverage-level", 89 cl::desc("Sanitizer Coverage. 0: none, 1: entry block, 2: all blocks, " 90 "3: all blocks and critical edges"), 91 cl::Hidden, cl::init(0)); 92 93 static cl::opt<bool> ClTracePC("sanitizer-coverage-trace-pc", 94 cl::desc("Experimental pc tracing"), cl::Hidden, 95 cl::init(false)); 96 97 static cl::opt<bool> ClTracePCGuard("sanitizer-coverage-trace-pc-guard", 98 cl::desc("pc tracing with a guard"), 99 cl::Hidden, cl::init(false)); 100 101 // If true, we create a global variable that contains PCs of all instrumented 102 // BBs, put this global into a named section, and pass this section's bounds 103 // to __sanitizer_cov_pcs_init. 104 // This way the coverage instrumentation does not need to acquire the PCs 105 // at run-time. Works with trace-pc-guard, inline-8bit-counters, and 106 // inline-bool-flag. 107 static cl::opt<bool> ClCreatePCTable("sanitizer-coverage-pc-table", 108 cl::desc("create a static PC table"), 109 cl::Hidden, cl::init(false)); 110 111 static cl::opt<bool> 112 ClInline8bitCounters("sanitizer-coverage-inline-8bit-counters", 113 cl::desc("increments 8-bit counter for every edge"), 114 cl::Hidden, cl::init(false)); 115 116 static cl::opt<bool> 117 ClInlineBoolFlag("sanitizer-coverage-inline-bool-flag", 118 cl::desc("sets a boolean flag for every edge"), cl::Hidden, 119 cl::init(false)); 120 121 static cl::opt<bool> 122 ClCMPTracing("sanitizer-coverage-trace-compares", 123 cl::desc("Tracing of CMP and similar instructions"), 124 cl::Hidden, cl::init(false)); 125 126 static cl::opt<bool> ClDIVTracing("sanitizer-coverage-trace-divs", 127 cl::desc("Tracing of DIV instructions"), 128 cl::Hidden, cl::init(false)); 129 130 static cl::opt<bool> ClLoadTracing("sanitizer-coverage-trace-loads", 131 cl::desc("Tracing of load instructions"), 132 cl::Hidden, cl::init(false)); 133 134 static cl::opt<bool> ClStoreTracing("sanitizer-coverage-trace-stores", 135 cl::desc("Tracing of store instructions"), 136 cl::Hidden, cl::init(false)); 137 138 static cl::opt<bool> ClGEPTracing("sanitizer-coverage-trace-geps", 139 cl::desc("Tracing of GEP instructions"), 140 cl::Hidden, cl::init(false)); 141 142 static cl::opt<bool> 143 ClPruneBlocks("sanitizer-coverage-prune-blocks", 144 cl::desc("Reduce the number of instrumented blocks"), 145 cl::Hidden, cl::init(true)); 146 147 static cl::opt<bool> ClStackDepth("sanitizer-coverage-stack-depth", 148 cl::desc("max stack depth tracing"), 149 cl::Hidden, cl::init(false)); 150 151 static cl::opt<bool> 152 ClCollectCF("sanitizer-coverage-control-flow", 153 cl::desc("collect control flow for each function"), cl::Hidden, 154 cl::init(false)); 155 156 namespace { 157 158 SanitizerCoverageOptions getOptions(int LegacyCoverageLevel) { 159 SanitizerCoverageOptions Res; 160 switch (LegacyCoverageLevel) { 161 case 0: 162 Res.CoverageType = SanitizerCoverageOptions::SCK_None; 163 break; 164 case 1: 165 Res.CoverageType = SanitizerCoverageOptions::SCK_Function; 166 break; 167 case 2: 168 Res.CoverageType = SanitizerCoverageOptions::SCK_BB; 169 break; 170 case 3: 171 Res.CoverageType = SanitizerCoverageOptions::SCK_Edge; 172 break; 173 case 4: 174 Res.CoverageType = SanitizerCoverageOptions::SCK_Edge; 175 Res.IndirectCalls = true; 176 break; 177 } 178 return Res; 179 } 180 181 SanitizerCoverageOptions OverrideFromCL(SanitizerCoverageOptions Options) { 182 // Sets CoverageType and IndirectCalls. 183 SanitizerCoverageOptions CLOpts = getOptions(ClCoverageLevel); 184 Options.CoverageType = std::max(Options.CoverageType, CLOpts.CoverageType); 185 Options.IndirectCalls |= CLOpts.IndirectCalls; 186 Options.TraceCmp |= ClCMPTracing; 187 Options.TraceDiv |= ClDIVTracing; 188 Options.TraceGep |= ClGEPTracing; 189 Options.TracePC |= ClTracePC; 190 Options.TracePCGuard |= ClTracePCGuard; 191 Options.Inline8bitCounters |= ClInline8bitCounters; 192 Options.InlineBoolFlag |= ClInlineBoolFlag; 193 Options.PCTable |= ClCreatePCTable; 194 Options.NoPrune |= !ClPruneBlocks; 195 Options.StackDepth |= ClStackDepth; 196 Options.TraceLoads |= ClLoadTracing; 197 Options.TraceStores |= ClStoreTracing; 198 if (!Options.TracePCGuard && !Options.TracePC && 199 !Options.Inline8bitCounters && !Options.StackDepth && 200 !Options.InlineBoolFlag && !Options.TraceLoads && !Options.TraceStores) 201 Options.TracePCGuard = true; // TracePCGuard is default. 202 Options.CollectControlFlow |= ClCollectCF; 203 return Options; 204 } 205 206 using DomTreeCallback = function_ref<const DominatorTree *(Function &F)>; 207 using PostDomTreeCallback = 208 function_ref<const PostDominatorTree *(Function &F)>; 209 210 class ModuleSanitizerCoverage { 211 public: 212 ModuleSanitizerCoverage( 213 const SanitizerCoverageOptions &Options = SanitizerCoverageOptions(), 214 const SpecialCaseList *Allowlist = nullptr, 215 const SpecialCaseList *Blocklist = nullptr) 216 : Options(OverrideFromCL(Options)), Allowlist(Allowlist), 217 Blocklist(Blocklist) {} 218 bool instrumentModule(Module &M, DomTreeCallback DTCallback, 219 PostDomTreeCallback PDTCallback); 220 221 private: 222 void createFunctionControlFlow(Function &F); 223 void instrumentFunction(Function &F, DomTreeCallback DTCallback, 224 PostDomTreeCallback PDTCallback); 225 void InjectCoverageForIndirectCalls(Function &F, 226 ArrayRef<Instruction *> IndirCalls); 227 void InjectTraceForCmp(Function &F, ArrayRef<Instruction *> CmpTraceTargets); 228 void InjectTraceForDiv(Function &F, 229 ArrayRef<BinaryOperator *> DivTraceTargets); 230 void InjectTraceForGep(Function &F, 231 ArrayRef<GetElementPtrInst *> GepTraceTargets); 232 void InjectTraceForLoadsAndStores(Function &F, ArrayRef<LoadInst *> Loads, 233 ArrayRef<StoreInst *> Stores); 234 void InjectTraceForSwitch(Function &F, 235 ArrayRef<Instruction *> SwitchTraceTargets); 236 bool InjectCoverage(Function &F, ArrayRef<BasicBlock *> AllBlocks, 237 bool IsLeafFunc = true); 238 GlobalVariable *CreateFunctionLocalArrayInSection(size_t NumElements, 239 Function &F, Type *Ty, 240 const char *Section); 241 GlobalVariable *CreatePCArray(Function &F, ArrayRef<BasicBlock *> AllBlocks); 242 void CreateFunctionLocalArrays(Function &F, ArrayRef<BasicBlock *> AllBlocks); 243 void InjectCoverageAtBlock(Function &F, BasicBlock &BB, size_t Idx, 244 bool IsLeafFunc = true); 245 Function *CreateInitCallsForSections(Module &M, const char *CtorName, 246 const char *InitFunctionName, Type *Ty, 247 const char *Section); 248 std::pair<Value *, Value *> CreateSecStartEnd(Module &M, const char *Section, 249 Type *Ty); 250 251 std::string getSectionName(const std::string &Section) const; 252 std::string getSectionStart(const std::string &Section) const; 253 std::string getSectionEnd(const std::string &Section) const; 254 FunctionCallee SanCovTracePCIndir; 255 FunctionCallee SanCovTracePC, SanCovTracePCGuard; 256 std::array<FunctionCallee, 4> SanCovTraceCmpFunction; 257 std::array<FunctionCallee, 4> SanCovTraceConstCmpFunction; 258 std::array<FunctionCallee, 5> SanCovLoadFunction; 259 std::array<FunctionCallee, 5> SanCovStoreFunction; 260 std::array<FunctionCallee, 2> SanCovTraceDivFunction; 261 FunctionCallee SanCovTraceGepFunction; 262 FunctionCallee SanCovTraceSwitchFunction; 263 GlobalVariable *SanCovLowestStack; 264 Type *PtrTy, *IntptrTy, *Int64Ty, *Int32Ty, *Int16Ty, *Int8Ty, *Int1Ty; 265 Module *CurModule; 266 std::string CurModuleUniqueId; 267 Triple TargetTriple; 268 LLVMContext *C; 269 const DataLayout *DL; 270 271 GlobalVariable *FunctionGuardArray; // for trace-pc-guard. 272 GlobalVariable *Function8bitCounterArray; // for inline-8bit-counters. 273 GlobalVariable *FunctionBoolArray; // for inline-bool-flag. 274 GlobalVariable *FunctionPCsArray; // for pc-table. 275 GlobalVariable *FunctionCFsArray; // for control flow table 276 SmallVector<GlobalValue *, 20> GlobalsToAppendToUsed; 277 SmallVector<GlobalValue *, 20> GlobalsToAppendToCompilerUsed; 278 279 SanitizerCoverageOptions Options; 280 281 const SpecialCaseList *Allowlist; 282 const SpecialCaseList *Blocklist; 283 }; 284 } // namespace 285 286 PreservedAnalyses SanitizerCoveragePass::run(Module &M, 287 ModuleAnalysisManager &MAM) { 288 ModuleSanitizerCoverage ModuleSancov(Options, Allowlist.get(), 289 Blocklist.get()); 290 auto &FAM = MAM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager(); 291 auto DTCallback = [&FAM](Function &F) -> const DominatorTree * { 292 return &FAM.getResult<DominatorTreeAnalysis>(F); 293 }; 294 auto PDTCallback = [&FAM](Function &F) -> const PostDominatorTree * { 295 return &FAM.getResult<PostDominatorTreeAnalysis>(F); 296 }; 297 if (!ModuleSancov.instrumentModule(M, DTCallback, PDTCallback)) 298 return PreservedAnalyses::all(); 299 300 PreservedAnalyses PA = PreservedAnalyses::none(); 301 // GlobalsAA is considered stateless and does not get invalidated unless 302 // explicitly invalidated; PreservedAnalyses::none() is not enough. Sanitizers 303 // make changes that require GlobalsAA to be invalidated. 304 PA.abandon<GlobalsAA>(); 305 return PA; 306 } 307 308 std::pair<Value *, Value *> 309 ModuleSanitizerCoverage::CreateSecStartEnd(Module &M, const char *Section, 310 Type *Ty) { 311 // Use ExternalWeak so that if all sections are discarded due to section 312 // garbage collection, the linker will not report undefined symbol errors. 313 // Windows defines the start/stop symbols in compiler-rt so no need for 314 // ExternalWeak. 315 GlobalValue::LinkageTypes Linkage = TargetTriple.isOSBinFormatCOFF() 316 ? GlobalVariable::ExternalLinkage 317 : GlobalVariable::ExternalWeakLinkage; 318 GlobalVariable *SecStart = 319 new GlobalVariable(M, Ty, false, Linkage, nullptr, 320 getSectionStart(Section)); 321 SecStart->setVisibility(GlobalValue::HiddenVisibility); 322 GlobalVariable *SecEnd = 323 new GlobalVariable(M, Ty, false, Linkage, nullptr, 324 getSectionEnd(Section)); 325 SecEnd->setVisibility(GlobalValue::HiddenVisibility); 326 IRBuilder<> IRB(M.getContext()); 327 if (!TargetTriple.isOSBinFormatCOFF()) 328 return std::make_pair(SecStart, SecEnd); 329 330 // Account for the fact that on windows-msvc __start_* symbols actually 331 // point to a uint64_t before the start of the array. 332 auto SecStartI8Ptr = IRB.CreatePointerCast(SecStart, PtrTy); 333 auto GEP = IRB.CreateGEP(Int8Ty, SecStartI8Ptr, 334 ConstantInt::get(IntptrTy, sizeof(uint64_t))); 335 return std::make_pair(GEP, SecEnd); 336 } 337 338 Function *ModuleSanitizerCoverage::CreateInitCallsForSections( 339 Module &M, const char *CtorName, const char *InitFunctionName, Type *Ty, 340 const char *Section) { 341 auto SecStartEnd = CreateSecStartEnd(M, Section, Ty); 342 auto SecStart = SecStartEnd.first; 343 auto SecEnd = SecStartEnd.second; 344 Function *CtorFunc; 345 std::tie(CtorFunc, std::ignore) = createSanitizerCtorAndInitFunctions( 346 M, CtorName, InitFunctionName, {PtrTy, PtrTy}, {SecStart, SecEnd}); 347 assert(CtorFunc->getName() == CtorName); 348 349 if (TargetTriple.supportsCOMDAT()) { 350 // Use comdat to dedup CtorFunc. 351 CtorFunc->setComdat(M.getOrInsertComdat(CtorName)); 352 appendToGlobalCtors(M, CtorFunc, SanCtorAndDtorPriority, CtorFunc); 353 } else { 354 appendToGlobalCtors(M, CtorFunc, SanCtorAndDtorPriority); 355 } 356 357 if (TargetTriple.isOSBinFormatCOFF()) { 358 // In COFF files, if the contructors are set as COMDAT (they are because 359 // COFF supports COMDAT) and the linker flag /OPT:REF (strip unreferenced 360 // functions and data) is used, the constructors get stripped. To prevent 361 // this, give the constructors weak ODR linkage and ensure the linker knows 362 // to include the sancov constructor. This way the linker can deduplicate 363 // the constructors but always leave one copy. 364 CtorFunc->setLinkage(GlobalValue::WeakODRLinkage); 365 } 366 return CtorFunc; 367 } 368 369 bool ModuleSanitizerCoverage::instrumentModule( 370 Module &M, DomTreeCallback DTCallback, PostDomTreeCallback PDTCallback) { 371 if (Options.CoverageType == SanitizerCoverageOptions::SCK_None) 372 return false; 373 if (Allowlist && 374 !Allowlist->inSection("coverage", "src", M.getSourceFileName())) 375 return false; 376 if (Blocklist && 377 Blocklist->inSection("coverage", "src", M.getSourceFileName())) 378 return false; 379 C = &(M.getContext()); 380 DL = &M.getDataLayout(); 381 CurModule = &M; 382 CurModuleUniqueId = getUniqueModuleId(CurModule); 383 TargetTriple = Triple(M.getTargetTriple()); 384 FunctionGuardArray = nullptr; 385 Function8bitCounterArray = nullptr; 386 FunctionBoolArray = nullptr; 387 FunctionPCsArray = nullptr; 388 FunctionCFsArray = nullptr; 389 IntptrTy = Type::getIntNTy(*C, DL->getPointerSizeInBits()); 390 PtrTy = PointerType::getUnqual(*C); 391 Type *VoidTy = Type::getVoidTy(*C); 392 IRBuilder<> IRB(*C); 393 Int64Ty = IRB.getInt64Ty(); 394 Int32Ty = IRB.getInt32Ty(); 395 Int16Ty = IRB.getInt16Ty(); 396 Int8Ty = IRB.getInt8Ty(); 397 Int1Ty = IRB.getInt1Ty(); 398 399 SanCovTracePCIndir = 400 M.getOrInsertFunction(SanCovTracePCIndirName, VoidTy, IntptrTy); 401 // Make sure smaller parameters are zero-extended to i64 if required by the 402 // target ABI. 403 AttributeList SanCovTraceCmpZeroExtAL; 404 SanCovTraceCmpZeroExtAL = 405 SanCovTraceCmpZeroExtAL.addParamAttribute(*C, 0, Attribute::ZExt); 406 SanCovTraceCmpZeroExtAL = 407 SanCovTraceCmpZeroExtAL.addParamAttribute(*C, 1, Attribute::ZExt); 408 409 SanCovTraceCmpFunction[0] = 410 M.getOrInsertFunction(SanCovTraceCmp1, SanCovTraceCmpZeroExtAL, VoidTy, 411 IRB.getInt8Ty(), IRB.getInt8Ty()); 412 SanCovTraceCmpFunction[1] = 413 M.getOrInsertFunction(SanCovTraceCmp2, SanCovTraceCmpZeroExtAL, VoidTy, 414 IRB.getInt16Ty(), IRB.getInt16Ty()); 415 SanCovTraceCmpFunction[2] = 416 M.getOrInsertFunction(SanCovTraceCmp4, SanCovTraceCmpZeroExtAL, VoidTy, 417 IRB.getInt32Ty(), IRB.getInt32Ty()); 418 SanCovTraceCmpFunction[3] = 419 M.getOrInsertFunction(SanCovTraceCmp8, VoidTy, Int64Ty, Int64Ty); 420 421 SanCovTraceConstCmpFunction[0] = M.getOrInsertFunction( 422 SanCovTraceConstCmp1, SanCovTraceCmpZeroExtAL, VoidTy, Int8Ty, Int8Ty); 423 SanCovTraceConstCmpFunction[1] = M.getOrInsertFunction( 424 SanCovTraceConstCmp2, SanCovTraceCmpZeroExtAL, VoidTy, Int16Ty, Int16Ty); 425 SanCovTraceConstCmpFunction[2] = M.getOrInsertFunction( 426 SanCovTraceConstCmp4, SanCovTraceCmpZeroExtAL, VoidTy, Int32Ty, Int32Ty); 427 SanCovTraceConstCmpFunction[3] = 428 M.getOrInsertFunction(SanCovTraceConstCmp8, VoidTy, Int64Ty, Int64Ty); 429 430 // Loads. 431 SanCovLoadFunction[0] = M.getOrInsertFunction(SanCovLoad1, VoidTy, PtrTy); 432 SanCovLoadFunction[1] = 433 M.getOrInsertFunction(SanCovLoad2, VoidTy, PtrTy); 434 SanCovLoadFunction[2] = 435 M.getOrInsertFunction(SanCovLoad4, VoidTy, PtrTy); 436 SanCovLoadFunction[3] = 437 M.getOrInsertFunction(SanCovLoad8, VoidTy, PtrTy); 438 SanCovLoadFunction[4] = 439 M.getOrInsertFunction(SanCovLoad16, VoidTy, PtrTy); 440 // Stores. 441 SanCovStoreFunction[0] = 442 M.getOrInsertFunction(SanCovStore1, VoidTy, PtrTy); 443 SanCovStoreFunction[1] = 444 M.getOrInsertFunction(SanCovStore2, VoidTy, PtrTy); 445 SanCovStoreFunction[2] = 446 M.getOrInsertFunction(SanCovStore4, VoidTy, PtrTy); 447 SanCovStoreFunction[3] = 448 M.getOrInsertFunction(SanCovStore8, VoidTy, PtrTy); 449 SanCovStoreFunction[4] = 450 M.getOrInsertFunction(SanCovStore16, VoidTy, PtrTy); 451 452 { 453 AttributeList AL; 454 AL = AL.addParamAttribute(*C, 0, Attribute::ZExt); 455 SanCovTraceDivFunction[0] = 456 M.getOrInsertFunction(SanCovTraceDiv4, AL, VoidTy, IRB.getInt32Ty()); 457 } 458 SanCovTraceDivFunction[1] = 459 M.getOrInsertFunction(SanCovTraceDiv8, VoidTy, Int64Ty); 460 SanCovTraceGepFunction = 461 M.getOrInsertFunction(SanCovTraceGep, VoidTy, IntptrTy); 462 SanCovTraceSwitchFunction = 463 M.getOrInsertFunction(SanCovTraceSwitchName, VoidTy, Int64Ty, PtrTy); 464 465 Constant *SanCovLowestStackConstant = 466 M.getOrInsertGlobal(SanCovLowestStackName, IntptrTy); 467 SanCovLowestStack = dyn_cast<GlobalVariable>(SanCovLowestStackConstant); 468 if (!SanCovLowestStack || SanCovLowestStack->getValueType() != IntptrTy) { 469 C->emitError(StringRef("'") + SanCovLowestStackName + 470 "' should not be declared by the user"); 471 return true; 472 } 473 SanCovLowestStack->setThreadLocalMode( 474 GlobalValue::ThreadLocalMode::InitialExecTLSModel); 475 if (Options.StackDepth && !SanCovLowestStack->isDeclaration()) 476 SanCovLowestStack->setInitializer(Constant::getAllOnesValue(IntptrTy)); 477 478 SanCovTracePC = M.getOrInsertFunction(SanCovTracePCName, VoidTy); 479 SanCovTracePCGuard = 480 M.getOrInsertFunction(SanCovTracePCGuardName, VoidTy, PtrTy); 481 482 for (auto &F : M) 483 instrumentFunction(F, DTCallback, PDTCallback); 484 485 Function *Ctor = nullptr; 486 487 if (FunctionGuardArray) 488 Ctor = CreateInitCallsForSections(M, SanCovModuleCtorTracePcGuardName, 489 SanCovTracePCGuardInitName, Int32Ty, 490 SanCovGuardsSectionName); 491 if (Function8bitCounterArray) 492 Ctor = CreateInitCallsForSections(M, SanCovModuleCtor8bitCountersName, 493 SanCov8bitCountersInitName, Int8Ty, 494 SanCovCountersSectionName); 495 if (FunctionBoolArray) { 496 Ctor = CreateInitCallsForSections(M, SanCovModuleCtorBoolFlagName, 497 SanCovBoolFlagInitName, Int1Ty, 498 SanCovBoolFlagSectionName); 499 } 500 if (Ctor && Options.PCTable) { 501 auto SecStartEnd = CreateSecStartEnd(M, SanCovPCsSectionName, IntptrTy); 502 FunctionCallee InitFunction = declareSanitizerInitFunction( 503 M, SanCovPCsInitName, {PtrTy, PtrTy}); 504 IRBuilder<> IRBCtor(Ctor->getEntryBlock().getTerminator()); 505 IRBCtor.CreateCall(InitFunction, {SecStartEnd.first, SecStartEnd.second}); 506 } 507 508 if (Ctor && Options.CollectControlFlow) { 509 auto SecStartEnd = CreateSecStartEnd(M, SanCovCFsSectionName, IntptrTy); 510 FunctionCallee InitFunction = declareSanitizerInitFunction( 511 M, SanCovCFsInitName, {PtrTy, PtrTy}); 512 IRBuilder<> IRBCtor(Ctor->getEntryBlock().getTerminator()); 513 IRBCtor.CreateCall(InitFunction, {SecStartEnd.first, SecStartEnd.second}); 514 } 515 516 appendToUsed(M, GlobalsToAppendToUsed); 517 appendToCompilerUsed(M, GlobalsToAppendToCompilerUsed); 518 return true; 519 } 520 521 // True if block has successors and it dominates all of them. 522 static bool isFullDominator(const BasicBlock *BB, const DominatorTree *DT) { 523 if (succ_empty(BB)) 524 return false; 525 526 return llvm::all_of(successors(BB), [&](const BasicBlock *SUCC) { 527 return DT->dominates(BB, SUCC); 528 }); 529 } 530 531 // True if block has predecessors and it postdominates all of them. 532 static bool isFullPostDominator(const BasicBlock *BB, 533 const PostDominatorTree *PDT) { 534 if (pred_empty(BB)) 535 return false; 536 537 return llvm::all_of(predecessors(BB), [&](const BasicBlock *PRED) { 538 return PDT->dominates(BB, PRED); 539 }); 540 } 541 542 static bool shouldInstrumentBlock(const Function &F, const BasicBlock *BB, 543 const DominatorTree *DT, 544 const PostDominatorTree *PDT, 545 const SanitizerCoverageOptions &Options) { 546 // Don't insert coverage for blocks containing nothing but unreachable: we 547 // will never call __sanitizer_cov() for them, so counting them in 548 // NumberOfInstrumentedBlocks() might complicate calculation of code coverage 549 // percentage. Also, unreachable instructions frequently have no debug 550 // locations. 551 if (isa<UnreachableInst>(BB->getFirstNonPHIOrDbgOrLifetime())) 552 return false; 553 554 // Don't insert coverage into blocks without a valid insertion point 555 // (catchswitch blocks). 556 if (BB->getFirstInsertionPt() == BB->end()) 557 return false; 558 559 if (Options.NoPrune || &F.getEntryBlock() == BB) 560 return true; 561 562 if (Options.CoverageType == SanitizerCoverageOptions::SCK_Function && 563 &F.getEntryBlock() != BB) 564 return false; 565 566 // Do not instrument full dominators, or full post-dominators with multiple 567 // predecessors. 568 return !isFullDominator(BB, DT) 569 && !(isFullPostDominator(BB, PDT) && !BB->getSinglePredecessor()); 570 } 571 572 573 // Returns true iff From->To is a backedge. 574 // A twist here is that we treat From->To as a backedge if 575 // * To dominates From or 576 // * To->UniqueSuccessor dominates From 577 static bool IsBackEdge(BasicBlock *From, BasicBlock *To, 578 const DominatorTree *DT) { 579 if (DT->dominates(To, From)) 580 return true; 581 if (auto Next = To->getUniqueSuccessor()) 582 if (DT->dominates(Next, From)) 583 return true; 584 return false; 585 } 586 587 // Prunes uninteresting Cmp instrumentation: 588 // * CMP instructions that feed into loop backedge branch. 589 // 590 // Note that Cmp pruning is controlled by the same flag as the 591 // BB pruning. 592 static bool IsInterestingCmp(ICmpInst *CMP, const DominatorTree *DT, 593 const SanitizerCoverageOptions &Options) { 594 if (!Options.NoPrune) 595 if (CMP->hasOneUse()) 596 if (auto BR = dyn_cast<BranchInst>(CMP->user_back())) 597 for (BasicBlock *B : BR->successors()) 598 if (IsBackEdge(BR->getParent(), B, DT)) 599 return false; 600 return true; 601 } 602 603 void ModuleSanitizerCoverage::instrumentFunction( 604 Function &F, DomTreeCallback DTCallback, PostDomTreeCallback PDTCallback) { 605 if (F.empty()) 606 return; 607 if (F.getName().find(".module_ctor") != std::string::npos) 608 return; // Should not instrument sanitizer init functions. 609 if (F.getName().starts_with("__sanitizer_")) 610 return; // Don't instrument __sanitizer_* callbacks. 611 // Don't touch available_externally functions, their actual body is elewhere. 612 if (F.getLinkage() == GlobalValue::AvailableExternallyLinkage) 613 return; 614 // Don't instrument MSVC CRT configuration helpers. They may run before normal 615 // initialization. 616 if (F.getName() == "__local_stdio_printf_options" || 617 F.getName() == "__local_stdio_scanf_options") 618 return; 619 if (isa<UnreachableInst>(F.getEntryBlock().getTerminator())) 620 return; 621 // Don't instrument functions using SEH for now. Splitting basic blocks like 622 // we do for coverage breaks WinEHPrepare. 623 // FIXME: Remove this when SEH no longer uses landingpad pattern matching. 624 if (F.hasPersonalityFn() && 625 isAsynchronousEHPersonality(classifyEHPersonality(F.getPersonalityFn()))) 626 return; 627 if (Allowlist && !Allowlist->inSection("coverage", "fun", F.getName())) 628 return; 629 if (Blocklist && Blocklist->inSection("coverage", "fun", F.getName())) 630 return; 631 if (F.hasFnAttribute(Attribute::NoSanitizeCoverage)) 632 return; 633 if (Options.CoverageType >= SanitizerCoverageOptions::SCK_Edge) 634 SplitAllCriticalEdges(F, CriticalEdgeSplittingOptions().setIgnoreUnreachableDests()); 635 SmallVector<Instruction *, 8> IndirCalls; 636 SmallVector<BasicBlock *, 16> BlocksToInstrument; 637 SmallVector<Instruction *, 8> CmpTraceTargets; 638 SmallVector<Instruction *, 8> SwitchTraceTargets; 639 SmallVector<BinaryOperator *, 8> DivTraceTargets; 640 SmallVector<GetElementPtrInst *, 8> GepTraceTargets; 641 SmallVector<LoadInst *, 8> Loads; 642 SmallVector<StoreInst *, 8> Stores; 643 644 const DominatorTree *DT = DTCallback(F); 645 const PostDominatorTree *PDT = PDTCallback(F); 646 bool IsLeafFunc = true; 647 648 for (auto &BB : F) { 649 if (shouldInstrumentBlock(F, &BB, DT, PDT, Options)) 650 BlocksToInstrument.push_back(&BB); 651 for (auto &Inst : BB) { 652 if (Options.IndirectCalls) { 653 CallBase *CB = dyn_cast<CallBase>(&Inst); 654 if (CB && CB->isIndirectCall()) 655 IndirCalls.push_back(&Inst); 656 } 657 if (Options.TraceCmp) { 658 if (ICmpInst *CMP = dyn_cast<ICmpInst>(&Inst)) 659 if (IsInterestingCmp(CMP, DT, Options)) 660 CmpTraceTargets.push_back(&Inst); 661 if (isa<SwitchInst>(&Inst)) 662 SwitchTraceTargets.push_back(&Inst); 663 } 664 if (Options.TraceDiv) 665 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(&Inst)) 666 if (BO->getOpcode() == Instruction::SDiv || 667 BO->getOpcode() == Instruction::UDiv) 668 DivTraceTargets.push_back(BO); 669 if (Options.TraceGep) 670 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(&Inst)) 671 GepTraceTargets.push_back(GEP); 672 if (Options.TraceLoads) 673 if (LoadInst *LI = dyn_cast<LoadInst>(&Inst)) 674 Loads.push_back(LI); 675 if (Options.TraceStores) 676 if (StoreInst *SI = dyn_cast<StoreInst>(&Inst)) 677 Stores.push_back(SI); 678 if (Options.StackDepth) 679 if (isa<InvokeInst>(Inst) || 680 (isa<CallInst>(Inst) && !isa<IntrinsicInst>(Inst))) 681 IsLeafFunc = false; 682 } 683 } 684 685 if (Options.CollectControlFlow) 686 createFunctionControlFlow(F); 687 688 InjectCoverage(F, BlocksToInstrument, IsLeafFunc); 689 InjectCoverageForIndirectCalls(F, IndirCalls); 690 InjectTraceForCmp(F, CmpTraceTargets); 691 InjectTraceForSwitch(F, SwitchTraceTargets); 692 InjectTraceForDiv(F, DivTraceTargets); 693 InjectTraceForGep(F, GepTraceTargets); 694 InjectTraceForLoadsAndStores(F, Loads, Stores); 695 } 696 697 GlobalVariable *ModuleSanitizerCoverage::CreateFunctionLocalArrayInSection( 698 size_t NumElements, Function &F, Type *Ty, const char *Section) { 699 ArrayType *ArrayTy = ArrayType::get(Ty, NumElements); 700 auto Array = new GlobalVariable( 701 *CurModule, ArrayTy, false, GlobalVariable::PrivateLinkage, 702 Constant::getNullValue(ArrayTy), "__sancov_gen_"); 703 704 if (TargetTriple.supportsCOMDAT() && 705 (TargetTriple.isOSBinFormatELF() || !F.isInterposable())) 706 if (auto Comdat = getOrCreateFunctionComdat(F, TargetTriple)) 707 Array->setComdat(Comdat); 708 Array->setSection(getSectionName(Section)); 709 Array->setAlignment(Align(DL->getTypeStoreSize(Ty).getFixedValue())); 710 711 // sancov_pcs parallels the other metadata section(s). Optimizers (e.g. 712 // GlobalOpt/ConstantMerge) may not discard sancov_pcs and the other 713 // section(s) as a unit, so we conservatively retain all unconditionally in 714 // the compiler. 715 // 716 // With comdat (COFF/ELF), the linker can guarantee the associated sections 717 // will be retained or discarded as a unit, so llvm.compiler.used is 718 // sufficient. Otherwise, conservatively make all of them retained by the 719 // linker. 720 if (Array->hasComdat()) 721 GlobalsToAppendToCompilerUsed.push_back(Array); 722 else 723 GlobalsToAppendToUsed.push_back(Array); 724 725 return Array; 726 } 727 728 GlobalVariable * 729 ModuleSanitizerCoverage::CreatePCArray(Function &F, 730 ArrayRef<BasicBlock *> AllBlocks) { 731 size_t N = AllBlocks.size(); 732 assert(N); 733 SmallVector<Constant *, 32> PCs; 734 IRBuilder<> IRB(&*F.getEntryBlock().getFirstInsertionPt()); 735 for (size_t i = 0; i < N; i++) { 736 if (&F.getEntryBlock() == AllBlocks[i]) { 737 PCs.push_back((Constant *)IRB.CreatePointerCast(&F, PtrTy)); 738 PCs.push_back((Constant *)IRB.CreateIntToPtr( 739 ConstantInt::get(IntptrTy, 1), PtrTy)); 740 } else { 741 PCs.push_back((Constant *)IRB.CreatePointerCast( 742 BlockAddress::get(AllBlocks[i]), PtrTy)); 743 PCs.push_back(Constant::getNullValue(PtrTy)); 744 } 745 } 746 auto *PCArray = CreateFunctionLocalArrayInSection(N * 2, F, PtrTy, 747 SanCovPCsSectionName); 748 PCArray->setInitializer( 749 ConstantArray::get(ArrayType::get(PtrTy, N * 2), PCs)); 750 PCArray->setConstant(true); 751 752 return PCArray; 753 } 754 755 void ModuleSanitizerCoverage::CreateFunctionLocalArrays( 756 Function &F, ArrayRef<BasicBlock *> AllBlocks) { 757 if (Options.TracePCGuard) 758 FunctionGuardArray = CreateFunctionLocalArrayInSection( 759 AllBlocks.size(), F, Int32Ty, SanCovGuardsSectionName); 760 761 if (Options.Inline8bitCounters) 762 Function8bitCounterArray = CreateFunctionLocalArrayInSection( 763 AllBlocks.size(), F, Int8Ty, SanCovCountersSectionName); 764 if (Options.InlineBoolFlag) 765 FunctionBoolArray = CreateFunctionLocalArrayInSection( 766 AllBlocks.size(), F, Int1Ty, SanCovBoolFlagSectionName); 767 768 if (Options.PCTable) 769 FunctionPCsArray = CreatePCArray(F, AllBlocks); 770 } 771 772 bool ModuleSanitizerCoverage::InjectCoverage(Function &F, 773 ArrayRef<BasicBlock *> AllBlocks, 774 bool IsLeafFunc) { 775 if (AllBlocks.empty()) return false; 776 CreateFunctionLocalArrays(F, AllBlocks); 777 for (size_t i = 0, N = AllBlocks.size(); i < N; i++) 778 InjectCoverageAtBlock(F, *AllBlocks[i], i, IsLeafFunc); 779 return true; 780 } 781 782 // On every indirect call we call a run-time function 783 // __sanitizer_cov_indir_call* with two parameters: 784 // - callee address, 785 // - global cache array that contains CacheSize pointers (zero-initialized). 786 // The cache is used to speed up recording the caller-callee pairs. 787 // The address of the caller is passed implicitly via caller PC. 788 // CacheSize is encoded in the name of the run-time function. 789 void ModuleSanitizerCoverage::InjectCoverageForIndirectCalls( 790 Function &F, ArrayRef<Instruction *> IndirCalls) { 791 if (IndirCalls.empty()) 792 return; 793 assert(Options.TracePC || Options.TracePCGuard || 794 Options.Inline8bitCounters || Options.InlineBoolFlag); 795 for (auto *I : IndirCalls) { 796 InstrumentationIRBuilder IRB(I); 797 CallBase &CB = cast<CallBase>(*I); 798 Value *Callee = CB.getCalledOperand(); 799 if (isa<InlineAsm>(Callee)) 800 continue; 801 IRB.CreateCall(SanCovTracePCIndir, IRB.CreatePointerCast(Callee, IntptrTy)); 802 } 803 } 804 805 // For every switch statement we insert a call: 806 // __sanitizer_cov_trace_switch(CondValue, 807 // {NumCases, ValueSizeInBits, Case0Value, Case1Value, Case2Value, ... }) 808 809 void ModuleSanitizerCoverage::InjectTraceForSwitch( 810 Function &, ArrayRef<Instruction *> SwitchTraceTargets) { 811 for (auto *I : SwitchTraceTargets) { 812 if (SwitchInst *SI = dyn_cast<SwitchInst>(I)) { 813 InstrumentationIRBuilder IRB(I); 814 SmallVector<Constant *, 16> Initializers; 815 Value *Cond = SI->getCondition(); 816 if (Cond->getType()->getScalarSizeInBits() > 817 Int64Ty->getScalarSizeInBits()) 818 continue; 819 Initializers.push_back(ConstantInt::get(Int64Ty, SI->getNumCases())); 820 Initializers.push_back( 821 ConstantInt::get(Int64Ty, Cond->getType()->getScalarSizeInBits())); 822 if (Cond->getType()->getScalarSizeInBits() < 823 Int64Ty->getScalarSizeInBits()) 824 Cond = IRB.CreateIntCast(Cond, Int64Ty, false); 825 for (auto It : SI->cases()) { 826 ConstantInt *C = It.getCaseValue(); 827 if (C->getType()->getScalarSizeInBits() < 64) 828 C = ConstantInt::get(C->getContext(), C->getValue().zext(64)); 829 Initializers.push_back(C); 830 } 831 llvm::sort(drop_begin(Initializers, 2), 832 [](const Constant *A, const Constant *B) { 833 return cast<ConstantInt>(A)->getLimitedValue() < 834 cast<ConstantInt>(B)->getLimitedValue(); 835 }); 836 ArrayType *ArrayOfInt64Ty = ArrayType::get(Int64Ty, Initializers.size()); 837 GlobalVariable *GV = new GlobalVariable( 838 *CurModule, ArrayOfInt64Ty, false, GlobalVariable::InternalLinkage, 839 ConstantArray::get(ArrayOfInt64Ty, Initializers), 840 "__sancov_gen_cov_switch_values"); 841 IRB.CreateCall(SanCovTraceSwitchFunction, 842 {Cond, IRB.CreatePointerCast(GV, PtrTy)}); 843 } 844 } 845 } 846 847 void ModuleSanitizerCoverage::InjectTraceForDiv( 848 Function &, ArrayRef<BinaryOperator *> DivTraceTargets) { 849 for (auto *BO : DivTraceTargets) { 850 InstrumentationIRBuilder IRB(BO); 851 Value *A1 = BO->getOperand(1); 852 if (isa<ConstantInt>(A1)) continue; 853 if (!A1->getType()->isIntegerTy()) 854 continue; 855 uint64_t TypeSize = DL->getTypeStoreSizeInBits(A1->getType()); 856 int CallbackIdx = TypeSize == 32 ? 0 : 857 TypeSize == 64 ? 1 : -1; 858 if (CallbackIdx < 0) continue; 859 auto Ty = Type::getIntNTy(*C, TypeSize); 860 IRB.CreateCall(SanCovTraceDivFunction[CallbackIdx], 861 {IRB.CreateIntCast(A1, Ty, true)}); 862 } 863 } 864 865 void ModuleSanitizerCoverage::InjectTraceForGep( 866 Function &, ArrayRef<GetElementPtrInst *> GepTraceTargets) { 867 for (auto *GEP : GepTraceTargets) { 868 InstrumentationIRBuilder IRB(GEP); 869 for (Use &Idx : GEP->indices()) 870 if (!isa<ConstantInt>(Idx) && Idx->getType()->isIntegerTy()) 871 IRB.CreateCall(SanCovTraceGepFunction, 872 {IRB.CreateIntCast(Idx, IntptrTy, true)}); 873 } 874 } 875 876 void ModuleSanitizerCoverage::InjectTraceForLoadsAndStores( 877 Function &, ArrayRef<LoadInst *> Loads, ArrayRef<StoreInst *> Stores) { 878 auto CallbackIdx = [&](Type *ElementTy) -> int { 879 uint64_t TypeSize = DL->getTypeStoreSizeInBits(ElementTy); 880 return TypeSize == 8 ? 0 881 : TypeSize == 16 ? 1 882 : TypeSize == 32 ? 2 883 : TypeSize == 64 ? 3 884 : TypeSize == 128 ? 4 885 : -1; 886 }; 887 for (auto *LI : Loads) { 888 InstrumentationIRBuilder IRB(LI); 889 auto Ptr = LI->getPointerOperand(); 890 int Idx = CallbackIdx(LI->getType()); 891 if (Idx < 0) 892 continue; 893 IRB.CreateCall(SanCovLoadFunction[Idx], Ptr); 894 } 895 for (auto *SI : Stores) { 896 InstrumentationIRBuilder IRB(SI); 897 auto Ptr = SI->getPointerOperand(); 898 int Idx = CallbackIdx(SI->getValueOperand()->getType()); 899 if (Idx < 0) 900 continue; 901 IRB.CreateCall(SanCovStoreFunction[Idx], Ptr); 902 } 903 } 904 905 void ModuleSanitizerCoverage::InjectTraceForCmp( 906 Function &, ArrayRef<Instruction *> CmpTraceTargets) { 907 for (auto *I : CmpTraceTargets) { 908 if (ICmpInst *ICMP = dyn_cast<ICmpInst>(I)) { 909 InstrumentationIRBuilder IRB(ICMP); 910 Value *A0 = ICMP->getOperand(0); 911 Value *A1 = ICMP->getOperand(1); 912 if (!A0->getType()->isIntegerTy()) 913 continue; 914 uint64_t TypeSize = DL->getTypeStoreSizeInBits(A0->getType()); 915 int CallbackIdx = TypeSize == 8 ? 0 : 916 TypeSize == 16 ? 1 : 917 TypeSize == 32 ? 2 : 918 TypeSize == 64 ? 3 : -1; 919 if (CallbackIdx < 0) continue; 920 // __sanitizer_cov_trace_cmp((type_size << 32) | predicate, A0, A1); 921 auto CallbackFunc = SanCovTraceCmpFunction[CallbackIdx]; 922 bool FirstIsConst = isa<ConstantInt>(A0); 923 bool SecondIsConst = isa<ConstantInt>(A1); 924 // If both are const, then we don't need such a comparison. 925 if (FirstIsConst && SecondIsConst) continue; 926 // If only one is const, then make it the first callback argument. 927 if (FirstIsConst || SecondIsConst) { 928 CallbackFunc = SanCovTraceConstCmpFunction[CallbackIdx]; 929 if (SecondIsConst) 930 std::swap(A0, A1); 931 } 932 933 auto Ty = Type::getIntNTy(*C, TypeSize); 934 IRB.CreateCall(CallbackFunc, {IRB.CreateIntCast(A0, Ty, true), 935 IRB.CreateIntCast(A1, Ty, true)}); 936 } 937 } 938 } 939 940 void ModuleSanitizerCoverage::InjectCoverageAtBlock(Function &F, BasicBlock &BB, 941 size_t Idx, 942 bool IsLeafFunc) { 943 BasicBlock::iterator IP = BB.getFirstInsertionPt(); 944 bool IsEntryBB = &BB == &F.getEntryBlock(); 945 DebugLoc EntryLoc; 946 if (IsEntryBB) { 947 if (auto SP = F.getSubprogram()) 948 EntryLoc = DILocation::get(SP->getContext(), SP->getScopeLine(), 0, SP); 949 // Keep static allocas and llvm.localescape calls in the entry block. Even 950 // if we aren't splitting the block, it's nice for allocas to be before 951 // calls. 952 IP = PrepareToSplitEntryBlock(BB, IP); 953 } 954 955 InstrumentationIRBuilder IRB(&*IP); 956 if (EntryLoc) 957 IRB.SetCurrentDebugLocation(EntryLoc); 958 if (Options.TracePC) { 959 IRB.CreateCall(SanCovTracePC) 960 ->setCannotMerge(); // gets the PC using GET_CALLER_PC. 961 } 962 if (Options.TracePCGuard) { 963 auto GuardPtr = IRB.CreateIntToPtr( 964 IRB.CreateAdd(IRB.CreatePointerCast(FunctionGuardArray, IntptrTy), 965 ConstantInt::get(IntptrTy, Idx * 4)), 966 PtrTy); 967 IRB.CreateCall(SanCovTracePCGuard, GuardPtr)->setCannotMerge(); 968 } 969 if (Options.Inline8bitCounters) { 970 auto CounterPtr = IRB.CreateGEP( 971 Function8bitCounterArray->getValueType(), Function8bitCounterArray, 972 {ConstantInt::get(IntptrTy, 0), ConstantInt::get(IntptrTy, Idx)}); 973 auto Load = IRB.CreateLoad(Int8Ty, CounterPtr); 974 auto Inc = IRB.CreateAdd(Load, ConstantInt::get(Int8Ty, 1)); 975 auto Store = IRB.CreateStore(Inc, CounterPtr); 976 Load->setNoSanitizeMetadata(); 977 Store->setNoSanitizeMetadata(); 978 } 979 if (Options.InlineBoolFlag) { 980 auto FlagPtr = IRB.CreateGEP( 981 FunctionBoolArray->getValueType(), FunctionBoolArray, 982 {ConstantInt::get(IntptrTy, 0), ConstantInt::get(IntptrTy, Idx)}); 983 auto Load = IRB.CreateLoad(Int1Ty, FlagPtr); 984 auto ThenTerm = 985 SplitBlockAndInsertIfThen(IRB.CreateIsNull(Load), &*IP, false); 986 IRBuilder<> ThenIRB(ThenTerm); 987 auto Store = ThenIRB.CreateStore(ConstantInt::getTrue(Int1Ty), FlagPtr); 988 Load->setNoSanitizeMetadata(); 989 Store->setNoSanitizeMetadata(); 990 } 991 if (Options.StackDepth && IsEntryBB && !IsLeafFunc) { 992 // Check stack depth. If it's the deepest so far, record it. 993 Module *M = F.getParent(); 994 Function *GetFrameAddr = Intrinsic::getDeclaration( 995 M, Intrinsic::frameaddress, 996 IRB.getPtrTy(M->getDataLayout().getAllocaAddrSpace())); 997 auto FrameAddrPtr = 998 IRB.CreateCall(GetFrameAddr, {Constant::getNullValue(Int32Ty)}); 999 auto FrameAddrInt = IRB.CreatePtrToInt(FrameAddrPtr, IntptrTy); 1000 auto LowestStack = IRB.CreateLoad(IntptrTy, SanCovLowestStack); 1001 auto IsStackLower = IRB.CreateICmpULT(FrameAddrInt, LowestStack); 1002 auto ThenTerm = SplitBlockAndInsertIfThen(IsStackLower, &*IP, false); 1003 IRBuilder<> ThenIRB(ThenTerm); 1004 auto Store = ThenIRB.CreateStore(FrameAddrInt, SanCovLowestStack); 1005 LowestStack->setNoSanitizeMetadata(); 1006 Store->setNoSanitizeMetadata(); 1007 } 1008 } 1009 1010 std::string 1011 ModuleSanitizerCoverage::getSectionName(const std::string &Section) const { 1012 if (TargetTriple.isOSBinFormatCOFF()) { 1013 if (Section == SanCovCountersSectionName) 1014 return ".SCOV$CM"; 1015 if (Section == SanCovBoolFlagSectionName) 1016 return ".SCOV$BM"; 1017 if (Section == SanCovPCsSectionName) 1018 return ".SCOVP$M"; 1019 return ".SCOV$GM"; // For SanCovGuardsSectionName. 1020 } 1021 if (TargetTriple.isOSBinFormatMachO()) 1022 return "__DATA,__" + Section; 1023 return "__" + Section; 1024 } 1025 1026 std::string 1027 ModuleSanitizerCoverage::getSectionStart(const std::string &Section) const { 1028 if (TargetTriple.isOSBinFormatMachO()) 1029 return "\1section$start$__DATA$__" + Section; 1030 return "__start___" + Section; 1031 } 1032 1033 std::string 1034 ModuleSanitizerCoverage::getSectionEnd(const std::string &Section) const { 1035 if (TargetTriple.isOSBinFormatMachO()) 1036 return "\1section$end$__DATA$__" + Section; 1037 return "__stop___" + Section; 1038 } 1039 1040 void ModuleSanitizerCoverage::createFunctionControlFlow(Function &F) { 1041 SmallVector<Constant *, 32> CFs; 1042 IRBuilder<> IRB(&*F.getEntryBlock().getFirstInsertionPt()); 1043 1044 for (auto &BB : F) { 1045 // blockaddress can not be used on function's entry block. 1046 if (&BB == &F.getEntryBlock()) 1047 CFs.push_back((Constant *)IRB.CreatePointerCast(&F, PtrTy)); 1048 else 1049 CFs.push_back((Constant *)IRB.CreatePointerCast(BlockAddress::get(&BB), 1050 PtrTy)); 1051 1052 for (auto SuccBB : successors(&BB)) { 1053 assert(SuccBB != &F.getEntryBlock()); 1054 CFs.push_back((Constant *)IRB.CreatePointerCast(BlockAddress::get(SuccBB), 1055 PtrTy)); 1056 } 1057 1058 CFs.push_back((Constant *)Constant::getNullValue(PtrTy)); 1059 1060 for (auto &Inst : BB) { 1061 if (CallBase *CB = dyn_cast<CallBase>(&Inst)) { 1062 if (CB->isIndirectCall()) { 1063 // TODO(navidem): handle indirect calls, for now mark its existence. 1064 CFs.push_back((Constant *)IRB.CreateIntToPtr( 1065 ConstantInt::get(IntptrTy, -1), PtrTy)); 1066 } else { 1067 auto CalledF = CB->getCalledFunction(); 1068 if (CalledF && !CalledF->isIntrinsic()) 1069 CFs.push_back( 1070 (Constant *)IRB.CreatePointerCast(CalledF, PtrTy)); 1071 } 1072 } 1073 } 1074 1075 CFs.push_back((Constant *)Constant::getNullValue(PtrTy)); 1076 } 1077 1078 FunctionCFsArray = CreateFunctionLocalArrayInSection( 1079 CFs.size(), F, PtrTy, SanCovCFsSectionName); 1080 FunctionCFsArray->setInitializer( 1081 ConstantArray::get(ArrayType::get(PtrTy, CFs.size()), CFs)); 1082 FunctionCFsArray->setConstant(true); 1083 } 1084