1 //===-- CrossDSOCFI.cpp - Externalize this module's CFI checks ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This pass exports all llvm.bitset's found in the module in the form of a
11 // __cfi_check function, which can be used to verify cross-DSO call targets.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Transforms/IPO.h"
16 #include "llvm/ADT/DenseSet.h"
17 #include "llvm/ADT/EquivalenceClasses.h"
18 #include "llvm/ADT/Statistic.h"
19 #include "llvm/IR/Constant.h"
20 #include "llvm/IR/Constants.h"
21 #include "llvm/IR/Function.h"
22 #include "llvm/IR/GlobalObject.h"
23 #include "llvm/IR/GlobalVariable.h"
24 #include "llvm/IR/IRBuilder.h"
25 #include "llvm/IR/Instructions.h"
26 #include "llvm/IR/Intrinsics.h"
27 #include "llvm/IR/MDBuilder.h"
28 #include "llvm/IR/Module.h"
29 #include "llvm/IR/Operator.h"
30 #include "llvm/Pass.h"
31 #include "llvm/Support/Debug.h"
32 #include "llvm/Support/raw_ostream.h"
33 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
37 #define DEBUG_TYPE "cross-dso-cfi"
39 STATISTIC(TypeIds, "Number of unique type identifiers");
43 struct CrossDSOCFI : public ModulePass {
45 CrossDSOCFI() : ModulePass(ID) {
46 initializeCrossDSOCFIPass(*PassRegistry::getPassRegistry());
50 MDNode *VeryLikelyWeights;
52 ConstantInt *extractBitSetTypeId(MDNode *MD);
55 bool doInitialization(Module &M) override;
56 bool runOnModule(Module &M) override;
59 } // anonymous namespace
61 INITIALIZE_PASS_BEGIN(CrossDSOCFI, "cross-dso-cfi", "Cross-DSO CFI", false,
63 INITIALIZE_PASS_END(CrossDSOCFI, "cross-dso-cfi", "Cross-DSO CFI", false, false)
64 char CrossDSOCFI::ID = 0;
66 ModulePass *llvm::createCrossDSOCFIPass() { return new CrossDSOCFI; }
68 bool CrossDSOCFI::doInitialization(Module &Mod) {
71 MDBuilder(M->getContext()).createBranchWeights((1U << 20) - 1, 1);
76 /// extractBitSetTypeId - Extracts TypeId from a hash-based bitset MDNode.
77 ConstantInt *CrossDSOCFI::extractBitSetTypeId(MDNode *MD) {
78 // This check excludes vtables for classes inside anonymous namespaces.
79 auto TM = dyn_cast<ValueAsMetadata>(MD->getOperand(0));
82 auto C = dyn_cast_or_null<ConstantInt>(TM->getValue());
83 if (!C) return nullptr;
84 // We are looking for i64 constants.
85 if (C->getBitWidth() != 64) return nullptr;
88 auto FM = dyn_cast_or_null<ValueAsMetadata>(MD->getOperand(1));
89 // Can be null if a function was removed by an optimization.
91 auto F = dyn_cast<Function>(FM->getValue());
92 // But can never be a function declaration.
93 assert(!F || !F->isDeclaration());
98 /// buildCFICheck - emits __cfi_check for the current module.
99 void CrossDSOCFI::buildCFICheck() {
100 // FIXME: verify that __cfi_check ends up near the end of the code section,
101 // but before the jump slots created in LowerBitSets.
102 llvm::DenseSet<uint64_t> BitSetIds;
103 NamedMDNode *BitSetNM = M->getNamedMetadata("llvm.bitsets");
106 for (unsigned I = 0, E = BitSetNM->getNumOperands(); I != E; ++I)
107 if (ConstantInt *TypeId = extractBitSetTypeId(BitSetNM->getOperand(I)))
108 BitSetIds.insert(TypeId->getZExtValue());
110 LLVMContext &Ctx = M->getContext();
111 Constant *C = M->getOrInsertFunction(
114 Type::getVoidTy(Ctx),
115 {Type::getInt64Ty(Ctx), PointerType::getUnqual(Type::getInt8Ty(Ctx))},
117 Function *F = dyn_cast<Function>(C);
118 F->setAlignment(4096);
119 auto args = F->arg_begin();
120 Argument &CallSiteTypeId = *(args++);
121 CallSiteTypeId.setName("CallSiteTypeId");
122 Argument &Addr = *(args++);
123 Addr.setName("Addr");
124 assert(args == F->arg_end());
126 BasicBlock *BB = BasicBlock::Create(Ctx, "entry", F);
128 BasicBlock *TrapBB = BasicBlock::Create(Ctx, "trap", F);
129 IRBuilder<> IRBTrap(TrapBB);
130 Function *TrapFn = Intrinsic::getDeclaration(M, Intrinsic::trap);
131 llvm::CallInst *TrapCall = IRBTrap.CreateCall(TrapFn);
132 TrapCall->setDoesNotReturn();
133 TrapCall->setDoesNotThrow();
134 IRBTrap.CreateUnreachable();
136 BasicBlock *ExitBB = BasicBlock::Create(Ctx, "exit", F);
137 IRBuilder<> IRBExit(ExitBB);
138 IRBExit.CreateRetVoid();
141 SwitchInst *SI = IRB.CreateSwitch(&CallSiteTypeId, TrapBB, BitSetIds.size());
142 for (uint64_t TypeId : BitSetIds) {
143 ConstantInt *CaseTypeId = ConstantInt::get(Type::getInt64Ty(Ctx), TypeId);
144 BasicBlock *TestBB = BasicBlock::Create(Ctx, "test", F);
145 IRBuilder<> IRBTest(TestBB);
146 Function *BitsetTestFn =
147 Intrinsic::getDeclaration(M, Intrinsic::bitset_test);
149 Value *Test = IRBTest.CreateCall(
150 BitsetTestFn, {&Addr, MetadataAsValue::get(
151 Ctx, ConstantAsMetadata::get(CaseTypeId))});
152 BranchInst *BI = IRBTest.CreateCondBr(Test, ExitBB, TrapBB);
153 BI->setMetadata(LLVMContext::MD_prof, VeryLikelyWeights);
155 SI->addCase(CaseTypeId, TestBB);
160 bool CrossDSOCFI::runOnModule(Module &M) {
161 if (M.getModuleFlag("Cross-DSO CFI") == nullptr)