2008-11-04 02:10:20 +00:00
|
|
|
//===-- StackProtector.cpp - Stack Protector Insertion --------------------===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2008-11-04 21:53:09 +00:00
|
|
|
// This pass inserts stack protectors into functions which need them. A variable
|
|
|
|
// with a random value in it is stored onto the stack before the local variables
|
|
|
|
// are allocated. Upon exiting the block, the stored value is checked. If it's
|
2008-11-04 02:10:20 +00:00
|
|
|
// changed, then there was some sort of violation and the program aborts.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#define DEBUG_TYPE "stack-protector"
|
|
|
|
#include "llvm/CodeGen/Passes.h"
|
|
|
|
#include "llvm/Constants.h"
|
|
|
|
#include "llvm/DerivedTypes.h"
|
|
|
|
#include "llvm/Function.h"
|
|
|
|
#include "llvm/Instructions.h"
|
2008-11-06 02:29:10 +00:00
|
|
|
#include "llvm/Intrinsics.h"
|
2008-11-04 02:10:20 +00:00
|
|
|
#include "llvm/Module.h"
|
|
|
|
#include "llvm/Pass.h"
|
|
|
|
#include "llvm/ADT/APInt.h"
|
|
|
|
#include "llvm/Support/CommandLine.h"
|
2008-11-04 21:53:09 +00:00
|
|
|
#include "llvm/Target/TargetData.h"
|
|
|
|
#include "llvm/Target/TargetLowering.h"
|
2008-11-04 02:10:20 +00:00
|
|
|
using namespace llvm;
|
|
|
|
|
2008-11-05 00:46:15 +00:00
|
|
|
// SSPBufferSize - The lower bound for a buffer to be considered for stack
|
|
|
|
// smashing protection.
|
2008-11-04 02:10:20 +00:00
|
|
|
static cl::opt<unsigned>
|
2008-11-04 21:53:09 +00:00
|
|
|
SSPBufferSize("stack-protector-buffer-size", cl::init(8),
|
2008-11-04 02:10:20 +00:00
|
|
|
cl::desc("The lower bound for a buffer to be considered for "
|
|
|
|
"stack smashing protection."));
|
|
|
|
|
|
|
|
namespace {
|
|
|
|
class VISIBILITY_HIDDEN StackProtector : public FunctionPass {
|
2008-11-04 21:53:09 +00:00
|
|
|
/// Level - The level of stack protection.
|
|
|
|
SSP::StackProtectorLevel Level;
|
|
|
|
|
|
|
|
/// TLI - Keep a pointer of a TargetLowering to consult for determining
|
|
|
|
/// target type sizes.
|
|
|
|
const TargetLowering *TLI;
|
2008-11-04 02:10:20 +00:00
|
|
|
|
|
|
|
Function *F;
|
|
|
|
Module *M;
|
|
|
|
|
2008-11-05 00:00:21 +00:00
|
|
|
/// InsertStackProtectors - Insert code into the prologue and epilogue of
|
|
|
|
/// the function.
|
|
|
|
///
|
|
|
|
/// - The prologue code loads and stores the stack guard onto the stack.
|
|
|
|
/// - The epilogue checks the value stored in the prologue against the
|
|
|
|
/// original value. It calls __stack_chk_fail if they differ.
|
|
|
|
bool InsertStackProtectors();
|
2008-11-04 02:10:20 +00:00
|
|
|
|
|
|
|
/// CreateFailBB - Create a basic block to jump to when the stack protector
|
|
|
|
/// check fails.
|
2008-11-05 00:00:21 +00:00
|
|
|
BasicBlock *CreateFailBB();
|
2008-11-04 02:10:20 +00:00
|
|
|
|
|
|
|
/// RequiresStackProtector - Check whether or not this function needs a
|
|
|
|
/// stack protector based upon the stack protector level.
|
2008-11-04 21:53:09 +00:00
|
|
|
bool RequiresStackProtector() const;
|
2008-11-04 02:10:20 +00:00
|
|
|
public:
|
|
|
|
static char ID; // Pass identification, replacement for typeid.
|
2008-11-05 00:00:21 +00:00
|
|
|
StackProtector() : FunctionPass(&ID), Level(SSP::OFF), TLI(0) {}
|
2008-11-04 21:53:09 +00:00
|
|
|
StackProtector(SSP::StackProtectorLevel lvl, const TargetLowering *tli)
|
2008-11-05 00:00:21 +00:00
|
|
|
: FunctionPass(&ID), Level(lvl), TLI(tli) {}
|
2008-11-04 02:10:20 +00:00
|
|
|
|
|
|
|
virtual bool runOnFunction(Function &Fn);
|
|
|
|
};
|
|
|
|
} // end anonymous namespace
|
|
|
|
|
|
|
|
char StackProtector::ID = 0;
|
|
|
|
static RegisterPass<StackProtector>
|
|
|
|
X("stack-protector", "Insert stack protectors");
|
|
|
|
|
2008-11-04 21:53:09 +00:00
|
|
|
FunctionPass *llvm::createStackProtectorPass(SSP::StackProtectorLevel lvl,
|
|
|
|
const TargetLowering *tli) {
|
|
|
|
return new StackProtector(lvl, tli);
|
2008-11-04 02:10:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool StackProtector::runOnFunction(Function &Fn) {
|
|
|
|
F = &Fn;
|
|
|
|
M = F->getParent();
|
|
|
|
|
|
|
|
if (!RequiresStackProtector()) return false;
|
|
|
|
|
2008-11-05 00:00:21 +00:00
|
|
|
return InsertStackProtectors();
|
2008-11-04 02:10:20 +00:00
|
|
|
}
|
|
|
|
|
2008-11-05 00:00:21 +00:00
|
|
|
/// InsertStackProtectors - Insert code into the prologue and epilogue of the
|
|
|
|
/// function.
|
|
|
|
///
|
|
|
|
/// - The prologue code loads and stores the stack guard onto the stack.
|
|
|
|
/// - The epilogue checks the value stored in the prologue against the original
|
|
|
|
/// value. It calls __stack_chk_fail if they differ.
|
|
|
|
bool StackProtector::InsertStackProtectors() {
|
2008-11-04 02:10:20 +00:00
|
|
|
std::vector<BasicBlock*> ReturnBBs;
|
|
|
|
|
2008-11-05 00:00:21 +00:00
|
|
|
for (Function::iterator I = F->begin(); I != F->end(); ++I)
|
2008-11-04 21:53:09 +00:00
|
|
|
if (isa<ReturnInst>(I->getTerminator()))
|
2008-11-04 02:10:20 +00:00
|
|
|
ReturnBBs.push_back(I);
|
|
|
|
|
2008-11-05 00:00:21 +00:00
|
|
|
// If this function doesn't return, don't bother with stack protectors.
|
|
|
|
if (ReturnBBs.empty()) return false;
|
|
|
|
|
|
|
|
// Insert code into the entry block that stores the __stack_chk_guard variable
|
|
|
|
// onto the stack.
|
|
|
|
BasicBlock &Entry = F->getEntryBlock();
|
|
|
|
Instruction *InsertPt = &Entry.front();
|
2008-11-06 02:29:10 +00:00
|
|
|
|
2008-11-05 00:00:21 +00:00
|
|
|
const PointerType *GuardTy = PointerType::getUnqual(Type::Int8Ty);
|
|
|
|
|
|
|
|
// The global variable for the stack guard.
|
|
|
|
Constant *StackGuardVar = M->getOrInsertGlobal("__stack_chk_guard", GuardTy);
|
|
|
|
LoadInst *LI = new LoadInst(StackGuardVar, "StackGuard", false, InsertPt);
|
2008-11-06 02:29:10 +00:00
|
|
|
CallInst::
|
2008-11-06 07:23:03 +00:00
|
|
|
Create(Intrinsic::getDeclaration(M, Intrinsic::stackprotector_create),
|
2008-11-06 02:29:10 +00:00
|
|
|
LI, "", InsertPt);
|
2008-11-05 00:00:21 +00:00
|
|
|
|
|
|
|
// Create the basic block to jump to when the guard check fails.
|
|
|
|
BasicBlock *FailBB = CreateFailBB();
|
2008-11-04 02:10:20 +00:00
|
|
|
|
|
|
|
// Loop through the basic blocks that have return instructions. Convert this:
|
|
|
|
//
|
|
|
|
// return:
|
|
|
|
// ...
|
|
|
|
// ret ...
|
|
|
|
//
|
|
|
|
// into this:
|
|
|
|
//
|
|
|
|
// return:
|
|
|
|
// ...
|
|
|
|
// %1 = load __stack_chk_guard
|
|
|
|
// %2 = load <stored stack guard>
|
|
|
|
// %3 = cmp i1 %1, %2
|
2008-11-06 02:29:10 +00:00
|
|
|
// br i1 %3, label %SP_return, label %CallStackCheckFailBlk
|
2008-11-04 02:10:20 +00:00
|
|
|
//
|
2008-11-04 22:51:24 +00:00
|
|
|
// SP_return:
|
2008-11-04 02:10:20 +00:00
|
|
|
// ret ...
|
|
|
|
//
|
|
|
|
// CallStackCheckFailBlk:
|
|
|
|
// call void @__stack_chk_fail()
|
|
|
|
// unreachable
|
|
|
|
//
|
|
|
|
for (std::vector<BasicBlock*>::iterator
|
2008-11-05 00:00:21 +00:00
|
|
|
I = ReturnBBs.begin(), E = ReturnBBs.end(); I != E; ++I) {
|
|
|
|
BasicBlock *BB = *I;
|
2008-11-04 02:10:20 +00:00
|
|
|
ReturnInst *RI = cast<ReturnInst>(BB->getTerminator());
|
|
|
|
Function::iterator InsPt = BB; ++InsPt; // Insertion point for new BB.
|
|
|
|
|
2008-11-04 22:51:24 +00:00
|
|
|
// Split the basic block before the return instruction.
|
|
|
|
BasicBlock *NewBB = BB->splitBasicBlock(RI, "SP_return");
|
2008-11-04 02:10:20 +00:00
|
|
|
|
2008-11-04 22:51:24 +00:00
|
|
|
// Move the newly created basic block to the point right after the old basic
|
2008-11-05 00:00:21 +00:00
|
|
|
// block so that it's in the "fall through" position.
|
2008-11-04 22:51:24 +00:00
|
|
|
NewBB->removeFromParent();
|
|
|
|
F->getBasicBlockList().insert(InsPt, NewBB);
|
2008-11-04 02:10:20 +00:00
|
|
|
|
2008-11-04 22:51:24 +00:00
|
|
|
// Generate the stack protector instructions in the old basic block.
|
2008-11-06 02:29:10 +00:00
|
|
|
LoadInst *LI1 = new LoadInst(StackGuardVar, "", false, BB);
|
|
|
|
CallInst *CI = CallInst::
|
2008-11-06 07:23:03 +00:00
|
|
|
Create(Intrinsic::getDeclaration(M, Intrinsic::stackprotector_check),
|
2008-11-06 02:29:10 +00:00
|
|
|
"", BB);
|
|
|
|
ICmpInst *Cmp = new ICmpInst(CmpInst::ICMP_EQ, CI, LI1, "", BB);
|
2008-11-04 02:10:20 +00:00
|
|
|
BranchInst::Create(NewBB, FailBB, Cmp, BB);
|
|
|
|
}
|
2008-11-05 00:00:21 +00:00
|
|
|
|
|
|
|
return true;
|
2008-11-04 02:10:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// CreateFailBB - Create a basic block to jump to when the stack protector
|
|
|
|
/// check fails.
|
2008-11-05 00:00:21 +00:00
|
|
|
BasicBlock *StackProtector::CreateFailBB() {
|
|
|
|
BasicBlock *FailBB = BasicBlock::Create("CallStackCheckFailBlk", F);
|
2008-11-04 02:10:20 +00:00
|
|
|
Constant *StackChkFail =
|
2008-11-04 21:53:09 +00:00
|
|
|
M->getOrInsertFunction("__stack_chk_fail", Type::VoidTy, NULL);
|
2008-11-04 02:10:20 +00:00
|
|
|
CallInst::Create(StackChkFail, "", FailBB);
|
|
|
|
new UnreachableInst(FailBB);
|
2008-11-05 00:00:21 +00:00
|
|
|
return FailBB;
|
2008-11-04 02:10:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// RequiresStackProtector - Check whether or not this function needs a stack
|
2008-11-06 02:38:58 +00:00
|
|
|
/// protector based upon the stack protector level. The heuristic we use is to
|
|
|
|
/// add a guard variable to functions that call alloca, and functions with
|
|
|
|
/// buffers larger than 8 bytes.
|
2008-11-04 21:53:09 +00:00
|
|
|
bool StackProtector::RequiresStackProtector() const {
|
2008-11-04 02:10:20 +00:00
|
|
|
switch (Level) {
|
|
|
|
default: return false;
|
2008-11-04 21:53:09 +00:00
|
|
|
case SSP::ALL: return true;
|
|
|
|
case SSP::SOME: {
|
|
|
|
const TargetData *TD = TLI->getTargetData();
|
2008-11-04 02:10:20 +00:00
|
|
|
|
|
|
|
for (Function::iterator I = F->begin(), E = F->end(); I != E; ++I) {
|
|
|
|
BasicBlock *BB = I;
|
|
|
|
|
|
|
|
for (BasicBlock::iterator
|
|
|
|
II = BB->begin(), IE = BB->end(); II != IE; ++II)
|
2008-11-04 21:53:09 +00:00
|
|
|
if (AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
|
2008-11-06 02:38:58 +00:00
|
|
|
if (!AI->isArrayAllocation()) continue; // Only care about arrays.
|
|
|
|
|
2008-11-04 02:10:20 +00:00
|
|
|
if (ConstantInt *CI = dyn_cast<ConstantInt>(AI->getArraySize())) {
|
2008-11-05 00:54:27 +00:00
|
|
|
const Type *Ty = AI->getAllocatedType();
|
|
|
|
uint64_t TySize = TD->getABITypeSize(Ty);
|
2008-11-04 21:53:09 +00:00
|
|
|
|
2008-11-06 22:18:44 +00:00
|
|
|
// If an array has more than 8 bytes of allocated space, then we
|
|
|
|
// emit stack protectors.
|
|
|
|
if (SSPBufferSize <= TySize * CI->getZExtValue())
|
2008-11-04 21:53:09 +00:00
|
|
|
return true;
|
2008-11-06 02:38:58 +00:00
|
|
|
} else {
|
|
|
|
// This is a call to alloca with a variable size. Default to adding
|
|
|
|
// stack protectors.
|
|
|
|
return true;
|
2008-11-04 02:10:20 +00:00
|
|
|
}
|
2008-11-04 21:53:09 +00:00
|
|
|
}
|
2008-11-04 02:10:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|