//===----------------------------------------------------------------------===//
#include "llvm/Transforms/Instrumentation/TraceValues.h"
-#include "llvm/GlobalVariable.h"
#include "llvm/Constants.h"
#include "llvm/DerivedTypes.h"
#include "llvm/iMemory.h"
#include "llvm/iTerminators.h"
#include "llvm/iOther.h"
-#include "llvm/BasicBlock.h"
-#include "llvm/Function.h"
#include "llvm/Module.h"
#include "llvm/Pass.h"
#include "llvm/Assembly/Writer.h"
using std::vector;
using std::string;
-static cl::Flag DisablePtrHashing("tracedisablehashdisable",
- "Disable pointer hashing", cl::NoFlags);
+static cl::opt<bool>
+DisablePtrHashing("tracedisablehashdisable", cl::Hidden,
+ cl::desc("Disable pointer hashing"));
-static cl::StringList TraceFuncName ("tracefunc", "trace only specific funct"
- "ions", cl::NoFlags);
+static cl::list<string>
+TraceFuncName("tracefunc", cl::desc("trace only specific functions"),
+ cl::value_desc("function"), cl::Hidden);
+static void TraceValuesAtBBExit(BasicBlock *BB,
+ Function *Printf, Function* HashPtrToSeqNum,
+ vector<Instruction*> *valuesStoredInFunction);
// We trace a particular function if no functions to trace were specified
// or if the function is in the specified list.
//
-inline bool
-TraceThisFunction(Function* func)
+inline static bool
+TraceThisFunction(Function &func)
{
- if (TraceFuncName.getNumOccurances() == 0)
+ if (TraceFuncName.size() == 0)
return true;
- return std::find(TraceFuncName.begin(), TraceFuncName.end(), func->getName())
+ return std::find(TraceFuncName.begin(), TraceFuncName.end(), func.getName())
!= TraceFuncName.end();
}
};
class InsertTraceCode : public FunctionPass {
- bool TraceBasicBlockExits, TraceFunctionExits;
+ protected:
ExternalFuncs externalFuncs;
public:
- InsertTraceCode(bool traceBasicBlockExits, bool traceFunctionExits)
- : TraceBasicBlockExits(traceBasicBlockExits),
- TraceFunctionExits(traceFunctionExits) {}
-
- const char *getPassName() const { return "Trace Code Insertion"; }
// Add a prototype for runtime functions not already in the program.
//
// Inserts tracing code for all live values at basic block and/or function
// exits as specified by `traceBasicBlockExits' and `traceFunctionExits'.
//
- static bool doit(Function *M, bool traceBasicBlockExits,
- bool traceFunctionExits, ExternalFuncs& externalFuncs);
+ bool doit(Function *M);
+
+ virtual void handleBasicBlock(BasicBlock *BB, vector<Instruction*> &VI) = 0;
// runOnFunction - This method does the work.
//
- bool runOnFunction(Function &F) {
- return doit(&F, TraceBasicBlockExits, TraceFunctionExits, externalFuncs);
- }
+ bool runOnFunction(Function &F);
virtual void getAnalysisUsage(AnalysisUsage &AU) const {
AU.preservesCFG();
}
};
+
+ struct FunctionTracer : public InsertTraceCode {
+ // Ignore basic blocks here...
+ virtual void handleBasicBlock(BasicBlock *BB, vector<Instruction*> &VI) {}
+ };
+
+ struct BasicBlockTracer : public InsertTraceCode {
+ // Trace basic blocks here...
+ virtual void handleBasicBlock(BasicBlock *BB, vector<Instruction*> &VI) {
+ TraceValuesAtBBExit(BB, externalFuncs.PrintfFunc,
+ externalFuncs.HashPtrFunc, &VI);
+ }
+ };
+
+ // Register the passes...
+ RegisterOpt<FunctionTracer> X("tracem","Insert Function trace code only");
+ RegisterOpt<BasicBlockTracer> Y("trace","Insert BB and Function trace code");
} // end anonymous namespace
Pass *createTraceValuesPassForFunction() { // Just trace functions
- return new InsertTraceCode(false, true);
+ return new FunctionTracer();
}
Pass *createTraceValuesPassForBasicBlocks() { // Trace BB's and functions
- return new InsertTraceCode(true, true);
+ return new BasicBlockTracer();
}
+
// Add a prototype for external functions used by the tracing code.
//
void ExternalFuncs::doInitialization(Module &M) {
return "0x%p";
else if (isa<PointerType>(V->getType()))
return DisablePtrHashing ? "0x%p" : "%d";
- else if (V->getType()->isIntegral() || V->getType() == Type::BoolTy)
+ else if (V->getType()->isIntegral())
return "%d";
assert(0 && "Illegal value to print out...");
}
-static void InsertPrintInst(Value *V,BasicBlock *BB, BasicBlock::iterator &BBI,
+static void InsertPrintInst(Value *V, BasicBlock *BB, Instruction *InsertBefore,
string Message,
Function *Printf, Function* HashPtrToSeqNum) {
// Escape Message by replacing all % characters with %% chars.
// Turn the format string into an sbyte *
Instruction *GEP =
new GetElementPtrInst(fmtVal,
- vector<Value*>(2,ConstantUInt::get(Type::UIntTy, 0)),
- "trstr");
- BBI = ++BB->getInstList().insert(BBI, GEP);
+ vector<Value*>(2,ConstantSInt::get(Type::LongTy, 0)),
+ "trstr", InsertBefore);
// Insert a call to the hash function if this is a pointer value
if (V && isa<PointerType>(V->getType()) && !DisablePtrHashing) {
const Type *SBP = PointerType::get(Type::SByteTy);
- if (V->getType() != SBP) { // Cast pointer to be sbyte*
- Instruction *I = new CastInst(V, SBP, "Hash_cast");
- BBI = ++BB->getInstList().insert(BBI, I);
- V = I;
- }
+ if (V->getType() != SBP) // Cast pointer to be sbyte*
+ V = new CastInst(V, SBP, "Hash_cast", InsertBefore);
vector<Value*> HashArgs(1, V);
- V = new CallInst(HashPtrToSeqNum, HashArgs, "ptrSeqNum");
- BBI = ++BB->getInstList().insert(BBI, cast<Instruction>(V));
+ V = new CallInst(HashPtrToSeqNum, HashArgs, "ptrSeqNum", InsertBefore);
}
// Insert the first print instruction to print the string flag:
vector<Value*> PrintArgs;
PrintArgs.push_back(GEP);
if (V) PrintArgs.push_back(V);
- Instruction *I = new CallInst(Printf, PrintArgs, "trace");
- BBI = ++BB->getInstList().insert(BBI, I);
+ new CallInst(Printf, PrintArgs, "trace", InsertBefore);
}
static void InsertVerbosePrintInst(Value *V, BasicBlock *BB,
- BasicBlock::iterator &BBI,
+ Instruction *InsertBefore,
const string &Message, Function *Printf,
Function* HashPtrToSeqNum) {
std::ostringstream OutStr;
if (V) WriteAsOperand(OutStr, V);
- InsertPrintInst(V, BB, BBI, Message+OutStr.str()+" = ",
+ InsertPrintInst(V, BB, InsertBefore, Message+OutStr.str()+" = ",
Printf, HashPtrToSeqNum);
}
static void
InsertReleaseInst(Value *V, BasicBlock *BB,
- BasicBlock::iterator &BBI,
+ Instruction *InsertBefore,
Function* ReleasePtrFunc) {
const Type *SBP = PointerType::get(Type::SByteTy);
- if (V->getType() != SBP) { // Cast pointer to be sbyte*
- Instruction *I = new CastInst(V, SBP, "RPSN_cast");
- BBI = ++BB->getInstList().insert(BBI, I);
- V = I;
- }
+ if (V->getType() != SBP) // Cast pointer to be sbyte*
+ V = new CastInst(V, SBP, "RPSN_cast", InsertBefore);
+
vector<Value*> releaseArgs(1, V);
- Instruction *I = new CallInst(ReleasePtrFunc, releaseArgs);
- BBI = ++BB->getInstList().insert(BBI, I);
+ new CallInst(ReleasePtrFunc, releaseArgs, "", InsertBefore);
}
static void
InsertRecordInst(Value *V, BasicBlock *BB,
- BasicBlock::iterator &BBI,
+ Instruction *InsertBefore,
Function* RecordPtrFunc) {
const Type *SBP = PointerType::get(Type::SByteTy);
- if (V->getType() != SBP) { // Cast pointer to be sbyte*
- Instruction *I = new CastInst(V, SBP, "RP_cast");
- BBI = ++BB->getInstList().insert(BBI, I);
- V = I;
- }
- vector<Value*> releaseArgs(1, V);
- Instruction *I = new CallInst(RecordPtrFunc, releaseArgs);
- BBI = ++BB->getInstList().insert(BBI, I);
-}
-
-static void
-InsertPushOnEntryFunc(Function *M,
- Function* PushOnEntryFunc) {
- // Get an iterator to point to the insertion location
- BasicBlock &BB = M->getEntryNode();
- BB.getInstList().insert(BB.begin(), new CallInst(PushOnEntryFunc,
- vector<Value*>()));
-}
+ if (V->getType() != SBP) // Cast pointer to be sbyte*
+ V = new CastInst(V, SBP, "RP_cast", InsertBefore);
-static void
-InsertReleaseRecordedInst(BasicBlock *BB,
- Function* ReleaseOnReturnFunc) {
- BasicBlock::iterator BBI = --BB->end();
- BBI = ++BB->getInstList().insert(BBI, new CallInst(ReleaseOnReturnFunc,
- vector<Value*>()));
+ vector<Value*> releaseArgs(1, V);
+ new CallInst(RecordPtrFunc, releaseArgs, "", InsertBefore);
}
// Look for alloca and free instructions. These are the ptrs to release.
ReleasePtrSeqNumbers(BasicBlock *BB,
ExternalFuncs& externalFuncs) {
- for (BasicBlock::iterator II=BB->begin(); II != BB->end(); ++II) {
+ for (BasicBlock::iterator II=BB->begin(), IE = BB->end(); II != IE; ++II)
if (FreeInst *FI = dyn_cast<FreeInst>(&*II))
- InsertReleaseInst(FI->getOperand(0), BB,II,externalFuncs.ReleasePtrFunc);
+ InsertReleaseInst(FI->getOperand(0), BB, FI,externalFuncs.ReleasePtrFunc);
else if (AllocaInst *AI = dyn_cast<AllocaInst>(&*II))
- {
- BasicBlock::iterator nextI = ++II;
- InsertRecordInst(AI, BB, nextI, externalFuncs.RecordPtrFunc);
- II = --nextI;
- }
- }
+ InsertRecordInst(AI, BB, AI->getNext(), externalFuncs.RecordPtrFunc);
}
// Get an iterator to point to the insertion location, which is
// just before the terminator instruction.
//
- BasicBlock::iterator InsertPos = --BB->end();
- assert(InsertPos->isTerminator());
+ TerminatorInst *InsertPos = BB->getTerminator();
-#undef CANNOT_SAVE_CCR_ACROSS_CALLS
-#ifdef CANNOT_SAVE_CCR_ACROSS_CALLS
- //
- // *** DISABLING THIS BECAUSE SAVING %CCR ACROSS CALLS WORKS NOW.
- // *** DELETE THIS CODE AFTER SOME TESTING.
- // *** NOTE: THIS CODE IS BROKEN ANYWAY WHEN THE SETCC IS NOT JUST
- // *** BEFORE THE BRANCH.
- // -- Vikram Adve, 7/7/02.
- //
- // If the terminator is a conditional branch, insert the trace code just
- // before the instruction that computes the branch condition (just to
- // avoid putting a call between the CC-setting instruction and the branch).
- // Use laterInstrSet to mark instructions that come after the setCC instr
- // because those cannot be traced at the location we choose.
- //
- Instruction *SetCC = 0;
- if (BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator()))
- if (!Branch->isUnconditional())
- if (Instruction *I = dyn_cast<Instruction>(Branch->getCondition()))
- if (I->getParent() == BB) {
- InsertPos = SetCC = I; // Back up until we can insert before the setcc
- }
-#endif CANNOT_SAVE_CCR_ACROSS_CALLS
-
std::ostringstream OutStr;
WriteAsOperand(OutStr, BB, false);
InsertPrintInst(0, BB, InsertPos, "LEAVING BB:" + OutStr.str(),
// The print instructions must go before InsertPos, so we use the
// instruction *preceding* InsertPos to check when to terminate the loop.
//
- if (InsertPos != BB->begin()) { // there's at least one instr before InsertPos
- BasicBlock::iterator II = BB->begin(), IEincl = InsertPos;
- --IEincl;
- do { // do from II up to IEincl, inclusive
- if (StoreInst *SI = dyn_cast<StoreInst>(&*II)) {
- assert(valuesStoredInFunction &&
- "Should not be printing a store instruction at function exit");
- LoadInst *LI = new LoadInst(SI->getPointerOperand(), SI->copyIndices(),
- "reload."+SI->getPointerOperand()->getName());
- InsertPos = ++BB->getInstList().insert(InsertPos, LI);
- valuesStoredInFunction->push_back(LI);
- }
- if (ShouldTraceValue(II))
- InsertVerbosePrintInst(II, BB, InsertPos, " ", Printf,HashPtrToSeqNum);
- } while (II++ != IEincl);
+ for (BasicBlock::iterator II = BB->begin(); &*II != InsertPos; ++II) {
+ if (StoreInst *SI = dyn_cast<StoreInst>(&*II)) {
+ assert(valuesStoredInFunction &&
+ "Should not be printing a store instruction at function exit");
+ LoadInst *LI = new LoadInst(SI->getPointerOperand(), "reload." +
+ SI->getPointerOperand()->getName(),
+ InsertPos);
+ valuesStoredInFunction->push_back(LI);
+ }
+ if (ShouldTraceValue(II))
+ InsertVerbosePrintInst(II, BB, InsertPos, " ", Printf, HashPtrToSeqNum);
}
}
-static inline void InsertCodeToShowFunctionEntry(Function *M, Function *Printf,
+static inline void InsertCodeToShowFunctionEntry(Function &F, Function *Printf,
Function* HashPtrToSeqNum){
// Get an iterator to point to the insertion location
- BasicBlock &BB = M->getEntryNode();
- BasicBlock::iterator BBI = BB.begin();
+ BasicBlock &BB = F.getEntryNode();
+ Instruction *InsertPos = BB.begin();
std::ostringstream OutStr;
- WriteAsOperand(OutStr, M, true);
- InsertPrintInst(0, &BB, BBI, "ENTERING FUNCTION: " + OutStr.str(),
+ WriteAsOperand(OutStr, &F, true);
+ InsertPrintInst(0, &BB, InsertPos, "ENTERING FUNCTION: " + OutStr.str(),
Printf, HashPtrToSeqNum);
// Now print all the incoming arguments
unsigned ArgNo = 0;
- for (Function::aiterator I = M->abegin(), E = M->aend(); I != E; ++I,++ArgNo){
- InsertVerbosePrintInst(I, &BB, BBI,
+ for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++ArgNo){
+ InsertVerbosePrintInst(I, &BB, InsertPos,
" Arg #" + utostr(ArgNo) + ": ", Printf,
HashPtrToSeqNum);
}
Function *Printf,
Function* HashPtrToSeqNum) {
// Get an iterator to point to the insertion location
- BasicBlock::iterator BBI = --BB->end();
- ReturnInst &Ret = cast<ReturnInst>(BB->back());
+ ReturnInst *Ret = cast<ReturnInst>(BB->getTerminator());
std::ostringstream OutStr;
WriteAsOperand(OutStr, BB->getParent(), true);
- InsertPrintInst(0, BB, BBI, "LEAVING FUNCTION: " + OutStr.str(),
+ InsertPrintInst(0, BB, Ret, "LEAVING FUNCTION: " + OutStr.str(),
Printf, HashPtrToSeqNum);
// print the return value, if any
if (BB->getParent()->getReturnType() != Type::VoidTy)
- InsertPrintInst(Ret.getReturnValue(), BB, BBI, " Returning: ",
+ InsertPrintInst(Ret->getReturnValue(), BB, Ret, " Returning: ",
Printf, HashPtrToSeqNum);
}
-bool InsertTraceCode::doit(Function *M, bool traceBasicBlockExits,
- bool traceFunctionEvents,
- ExternalFuncs& externalFuncs) {
- if (!traceBasicBlockExits && !traceFunctionEvents)
- return false;
-
- if (!TraceThisFunction(M))
+bool InsertTraceCode::runOnFunction(Function &F) {
+ if (!TraceThisFunction(F))
return false;
vector<Instruction*> valuesStoredInFunction;
vector<BasicBlock*> exitBlocks;
// Insert code to trace values at function entry
- if (traceFunctionEvents)
- InsertCodeToShowFunctionEntry(M, externalFuncs.PrintfFunc,
- externalFuncs.HashPtrFunc);
+ InsertCodeToShowFunctionEntry(F, externalFuncs.PrintfFunc,
+ externalFuncs.HashPtrFunc);
// Push a pointer set for recording alloca'd pointers at entry.
if (!DisablePtrHashing)
- InsertPushOnEntryFunc(M, externalFuncs.PushOnEntryFunc);
-
- for (Function::iterator BB = M->begin(); BB != M->end(); ++BB) {
+ new CallInst(externalFuncs.PushOnEntryFunc, vector<Value*>(), "",
+ F.getEntryNode().begin());
+
+ for (Function::iterator BB = F.begin(); BB != F.end(); ++BB) {
if (isa<ReturnInst>(BB->getTerminator()))
exitBlocks.push_back(BB); // record this as an exit block
-
- if (traceBasicBlockExits)
- TraceValuesAtBBExit(BB, externalFuncs.PrintfFunc,
- externalFuncs.HashPtrFunc, &valuesStoredInFunction);
-
+
+ // Insert trace code if this basic block is interesting...
+ handleBasicBlock(BB, valuesStoredInFunction);
+
if (!DisablePtrHashing) // release seq. numbers on free/ret
ReleasePtrSeqNumbers(BB, externalFuncs);
}
- for (unsigned i=0; i < exitBlocks.size(); ++i)
+ for (unsigned i=0; i != exitBlocks.size(); ++i)
{
// Insert code to trace values at function exit
- if (traceFunctionEvents)
- InsertCodeToShowFunctionExit(exitBlocks[i], externalFuncs.PrintfFunc,
- externalFuncs.HashPtrFunc);
+ InsertCodeToShowFunctionExit(exitBlocks[i], externalFuncs.PrintfFunc,
+ externalFuncs.HashPtrFunc);
// Release all recorded pointers before RETURN. Do this LAST!
if (!DisablePtrHashing)
- InsertReleaseRecordedInst(exitBlocks[i],
- externalFuncs.ReleaseOnReturnFunc);
+ new CallInst(externalFuncs.ReleaseOnReturnFunc, vector<Value*>(), "",
+ exitBlocks[i]->getTerminator());
}
return true;
projects / oota-llvm.git / blobdiff