1*0a6a1f1dSLionel Sambuc //===--- SanitizerMetadata.cpp - Blacklist for sanitizers -----------------===//
2*0a6a1f1dSLionel Sambuc //
3*0a6a1f1dSLionel Sambuc // The LLVM Compiler Infrastructure
4*0a6a1f1dSLionel Sambuc //
5*0a6a1f1dSLionel Sambuc // This file is distributed under the University of Illinois Open Source
6*0a6a1f1dSLionel Sambuc // License. See LICENSE.TXT for details.
7*0a6a1f1dSLionel Sambuc //
8*0a6a1f1dSLionel Sambuc //===----------------------------------------------------------------------===//
9*0a6a1f1dSLionel Sambuc //
10*0a6a1f1dSLionel Sambuc // Class which emits metadata consumed by sanitizer instrumentation passes.
11*0a6a1f1dSLionel Sambuc //
12*0a6a1f1dSLionel Sambuc //===----------------------------------------------------------------------===//
13*0a6a1f1dSLionel Sambuc #include "SanitizerMetadata.h"
14*0a6a1f1dSLionel Sambuc #include "CodeGenModule.h"
15*0a6a1f1dSLionel Sambuc #include "clang/AST/Type.h"
16*0a6a1f1dSLionel Sambuc #include "llvm/ADT/StringRef.h"
17*0a6a1f1dSLionel Sambuc #include "llvm/IR/Constants.h"
18*0a6a1f1dSLionel Sambuc
19*0a6a1f1dSLionel Sambuc using namespace clang;
20*0a6a1f1dSLionel Sambuc using namespace CodeGen;
21*0a6a1f1dSLionel Sambuc
SanitizerMetadata(CodeGenModule & CGM)22*0a6a1f1dSLionel Sambuc SanitizerMetadata::SanitizerMetadata(CodeGenModule &CGM) : CGM(CGM) {}
23*0a6a1f1dSLionel Sambuc
reportGlobalToASan(llvm::GlobalVariable * GV,SourceLocation Loc,StringRef Name,QualType Ty,bool IsDynInit,bool IsBlacklisted)24*0a6a1f1dSLionel Sambuc void SanitizerMetadata::reportGlobalToASan(llvm::GlobalVariable *GV,
25*0a6a1f1dSLionel Sambuc SourceLocation Loc, StringRef Name,
26*0a6a1f1dSLionel Sambuc QualType Ty, bool IsDynInit,
27*0a6a1f1dSLionel Sambuc bool IsBlacklisted) {
28*0a6a1f1dSLionel Sambuc if (!CGM.getLangOpts().Sanitize.has(SanitizerKind::Address))
29*0a6a1f1dSLionel Sambuc return;
30*0a6a1f1dSLionel Sambuc IsDynInit &= !CGM.isInSanitizerBlacklist(GV, Loc, Ty, "init");
31*0a6a1f1dSLionel Sambuc IsBlacklisted |= CGM.isInSanitizerBlacklist(GV, Loc, Ty);
32*0a6a1f1dSLionel Sambuc
33*0a6a1f1dSLionel Sambuc llvm::Metadata *LocDescr = nullptr;
34*0a6a1f1dSLionel Sambuc llvm::Metadata *GlobalName = nullptr;
35*0a6a1f1dSLionel Sambuc llvm::LLVMContext &VMContext = CGM.getLLVMContext();
36*0a6a1f1dSLionel Sambuc if (!IsBlacklisted) {
37*0a6a1f1dSLionel Sambuc // Don't generate source location and global name if it is blacklisted -
38*0a6a1f1dSLionel Sambuc // it won't be instrumented anyway.
39*0a6a1f1dSLionel Sambuc LocDescr = getLocationMetadata(Loc);
40*0a6a1f1dSLionel Sambuc if (!Name.empty())
41*0a6a1f1dSLionel Sambuc GlobalName = llvm::MDString::get(VMContext, Name);
42*0a6a1f1dSLionel Sambuc }
43*0a6a1f1dSLionel Sambuc
44*0a6a1f1dSLionel Sambuc llvm::Metadata *GlobalMetadata[] = {
45*0a6a1f1dSLionel Sambuc llvm::ConstantAsMetadata::get(GV), LocDescr, GlobalName,
46*0a6a1f1dSLionel Sambuc llvm::ConstantAsMetadata::get(
47*0a6a1f1dSLionel Sambuc llvm::ConstantInt::get(llvm::Type::getInt1Ty(VMContext), IsDynInit)),
48*0a6a1f1dSLionel Sambuc llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
49*0a6a1f1dSLionel Sambuc llvm::Type::getInt1Ty(VMContext), IsBlacklisted))};
50*0a6a1f1dSLionel Sambuc
51*0a6a1f1dSLionel Sambuc llvm::MDNode *ThisGlobal = llvm::MDNode::get(VMContext, GlobalMetadata);
52*0a6a1f1dSLionel Sambuc llvm::NamedMDNode *AsanGlobals =
53*0a6a1f1dSLionel Sambuc CGM.getModule().getOrInsertNamedMetadata("llvm.asan.globals");
54*0a6a1f1dSLionel Sambuc AsanGlobals->addOperand(ThisGlobal);
55*0a6a1f1dSLionel Sambuc }
56*0a6a1f1dSLionel Sambuc
reportGlobalToASan(llvm::GlobalVariable * GV,const VarDecl & D,bool IsDynInit)57*0a6a1f1dSLionel Sambuc void SanitizerMetadata::reportGlobalToASan(llvm::GlobalVariable *GV,
58*0a6a1f1dSLionel Sambuc const VarDecl &D, bool IsDynInit) {
59*0a6a1f1dSLionel Sambuc if (!CGM.getLangOpts().Sanitize.has(SanitizerKind::Address))
60*0a6a1f1dSLionel Sambuc return;
61*0a6a1f1dSLionel Sambuc std::string QualName;
62*0a6a1f1dSLionel Sambuc llvm::raw_string_ostream OS(QualName);
63*0a6a1f1dSLionel Sambuc D.printQualifiedName(OS);
64*0a6a1f1dSLionel Sambuc reportGlobalToASan(GV, D.getLocation(), OS.str(), D.getType(), IsDynInit);
65*0a6a1f1dSLionel Sambuc }
66*0a6a1f1dSLionel Sambuc
disableSanitizerForGlobal(llvm::GlobalVariable * GV)67*0a6a1f1dSLionel Sambuc void SanitizerMetadata::disableSanitizerForGlobal(llvm::GlobalVariable *GV) {
68*0a6a1f1dSLionel Sambuc // For now, just make sure the global is not modified by the ASan
69*0a6a1f1dSLionel Sambuc // instrumentation.
70*0a6a1f1dSLionel Sambuc if (CGM.getLangOpts().Sanitize.has(SanitizerKind::Address))
71*0a6a1f1dSLionel Sambuc reportGlobalToASan(GV, SourceLocation(), "", QualType(), false, true);
72*0a6a1f1dSLionel Sambuc }
73*0a6a1f1dSLionel Sambuc
disableSanitizerForInstruction(llvm::Instruction * I)74*0a6a1f1dSLionel Sambuc void SanitizerMetadata::disableSanitizerForInstruction(llvm::Instruction *I) {
75*0a6a1f1dSLionel Sambuc I->setMetadata(CGM.getModule().getMDKindID("nosanitize"),
76*0a6a1f1dSLionel Sambuc llvm::MDNode::get(CGM.getLLVMContext(), None));
77*0a6a1f1dSLionel Sambuc }
78*0a6a1f1dSLionel Sambuc
getLocationMetadata(SourceLocation Loc)79*0a6a1f1dSLionel Sambuc llvm::MDNode *SanitizerMetadata::getLocationMetadata(SourceLocation Loc) {
80*0a6a1f1dSLionel Sambuc PresumedLoc PLoc = CGM.getContext().getSourceManager().getPresumedLoc(Loc);
81*0a6a1f1dSLionel Sambuc if (!PLoc.isValid())
82*0a6a1f1dSLionel Sambuc return nullptr;
83*0a6a1f1dSLionel Sambuc llvm::LLVMContext &VMContext = CGM.getLLVMContext();
84*0a6a1f1dSLionel Sambuc llvm::Metadata *LocMetadata[] = {
85*0a6a1f1dSLionel Sambuc llvm::MDString::get(VMContext, PLoc.getFilename()),
86*0a6a1f1dSLionel Sambuc llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
87*0a6a1f1dSLionel Sambuc llvm::Type::getInt32Ty(VMContext), PLoc.getLine())),
88*0a6a1f1dSLionel Sambuc llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
89*0a6a1f1dSLionel Sambuc llvm::Type::getInt32Ty(VMContext), PLoc.getColumn())),
90*0a6a1f1dSLionel Sambuc };
91*0a6a1f1dSLionel Sambuc return llvm::MDNode::get(VMContext, LocMetadata);
92*0a6a1f1dSLionel Sambuc }
93