-//===- TraceValues.cpp - Value Tracing for debugging -------------*- C++ -*--=//
+//===- TraceValues.cpp - Value Tracing for debugging ----------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// Support for inserting LLVM code to print values at basic block and function
// exits.
#include "llvm/Transforms/Instrumentation.h"
#include "llvm/Constants.h"
#include "llvm/DerivedTypes.h"
-#include "llvm/iMemory.h"
-#include "llvm/iTerminators.h"
-#include "llvm/iOther.h"
+#include "llvm/Instructions.h"
#include "llvm/Module.h"
#include "llvm/Pass.h"
#include "llvm/Assembly/Writer.h"
-#include "Support/CommandLine.h"
-#include "Support/StringExtras.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/ADT/StringExtras.h"
#include <algorithm>
#include <sstream>
-using std::vector;
-using std::string;
+using namespace llvm;
static cl::opt<bool>
DisablePtrHashing("tracedisablehashdisable", cl::Hidden,
cl::desc("Disable pointer hashing in the -trace or -tracem "
"passes"));
-static cl::list<string>
+static cl::list<std::string>
TraceFuncNames("tracefunc", cl::desc("Only trace specific functions in the "
"-trace or -tracem passes"),
- cl::value_desc("function"), cl::Hidden);
+ cl::value_desc("function"), cl::Hidden);
static void TraceValuesAtBBExit(BasicBlock *BB,
Function *Printf, Function* HashPtrToSeqNum,
- vector<Instruction*> *valuesStoredInFunction);
+ std::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 static bool
TraceThisFunction(Function &F)
{
Function *RecordPtrFunc, *PushOnEntryFunc, *ReleaseOnReturnFunc;
void doInitialization(Module &M); // Add prototypes for external functions
};
-
+
class InsertTraceCode : public FunctionPass {
protected:
ExternalFuncs externalFuncs;
public:
-
+
// Add a prototype for runtime functions not already in the program.
//
bool doInitialization(Module &M);
-
+
//--------------------------------------------------------------------------
// Function InsertCodeToTraceValues
- //
+ //
// Inserts tracing code for all live values at basic block and/or function
// exits as specified by `traceBasicBlockExits' and `traceFunctionExits'.
//
bool doit(Function *M);
- virtual void handleBasicBlock(BasicBlock *BB, vector<Instruction*> &VI) = 0;
+ virtual void handleBasicBlock(BasicBlock *BB,
+ std::vector<Instruction*> &VI) = 0;
// runOnFunction - This method does the work.
//
struct FunctionTracer : public InsertTraceCode {
// Ignore basic blocks here...
- virtual void handleBasicBlock(BasicBlock *BB, vector<Instruction*> &VI) {}
+ virtual void handleBasicBlock(BasicBlock *BB,
+ std::vector<Instruction*> &VI) {}
};
struct BasicBlockTracer : public InsertTraceCode {
// Trace basic blocks here...
- virtual void handleBasicBlock(BasicBlock *BB, vector<Instruction*> &VI) {
+ virtual void handleBasicBlock(BasicBlock *BB,
+ std::vector<Instruction*> &VI) {
TraceValuesAtBBExit(BB, externalFuncs.PrintfFunc,
externalFuncs.HashPtrFunc, &VI);
}
RegisterOpt<BasicBlockTracer> Y("trace","Insert BB and Function trace code");
} // end anonymous namespace
-
-Pass *createTraceValuesPassForFunction() { // Just trace functions
+/// Just trace functions
+FunctionPass *llvm::createTraceValuesPassForFunction() {
return new FunctionTracer();
}
-Pass *createTraceValuesPassForBasicBlocks() { // Trace BB's and functions
+/// Trace BB's and functions
+FunctionPass *llvm::createTraceValuesPassForBasicBlocks() {
return new BasicBlockTracer();
}
-
-// Add a prototype for external functions used by the tracing code.
+// Add a prototype for external functions used by the tracing code and require
+// the trace library for this module.
//
void ExternalFuncs::doInitialization(Module &M) {
+ M.addLibrary("trace");
const Type *SBP = PointerType::get(Type::SByteTy);
const FunctionType *MTy =
- FunctionType::get(Type::IntTy, vector<const Type*>(1, SBP), true);
+ FunctionType::get(Type::IntTy, std::vector<const Type*>(1, SBP), true);
PrintfFunc = M.getOrInsertFunction("printf", MTy);
// uint (sbyte*)
- const FunctionType *hashFuncTy =
- FunctionType::get(Type::UIntTy, vector<const Type*>(1, SBP), false);
- HashPtrFunc = M.getOrInsertFunction("HashPointerToSeqNum", hashFuncTy);
-
+ HashPtrFunc = M.getOrInsertFunction("HashPointerToSeqNum", Type::UIntTy, SBP,
+ 0);
+
// void (sbyte*)
- const FunctionType *voidSBPFuncTy =
- FunctionType::get(Type::VoidTy, vector<const Type*>(1, SBP), false);
-
- ReleasePtrFunc = M.getOrInsertFunction("ReleasePointerSeqNum", voidSBPFuncTy);
- RecordPtrFunc = M.getOrInsertFunction("RecordPointer", voidSBPFuncTy);
-
- const FunctionType *voidvoidFuncTy =
- FunctionType::get(Type::VoidTy, vector<const Type*>(), false);
-
- PushOnEntryFunc = M.getOrInsertFunction("PushPointerSet", voidvoidFuncTy);
+ ReleasePtrFunc = M.getOrInsertFunction("ReleasePointerSeqNum",
+ Type::VoidTy, SBP, 0);
+ RecordPtrFunc = M.getOrInsertFunction("RecordPointer",
+ Type::VoidTy, SBP, 0);
+
+ PushOnEntryFunc = M.getOrInsertFunction("PushPointerSet", Type::VoidTy, 0);
ReleaseOnReturnFunc = M.getOrInsertFunction("ReleasePointersPopSet",
- voidvoidFuncTy);
+ Type::VoidTy, 0);
}
}
-static inline GlobalVariable *getStringRef(Module *M, const string &str) {
+static inline GlobalVariable *getStringRef(Module *M, const std::string &str) {
// Create a constant internal string reference...
Constant *Init = ConstantArray::get(str);
// Create the global variable and record it in the module
// The GV will be renamed to a unique name if needed.
- GlobalVariable *GV = new GlobalVariable(Init->getType(), true,
+ GlobalVariable *GV = new GlobalVariable(Init->getType(), true,
GlobalValue::InternalLinkage, Init,
"trstr");
M->getGlobalList().push_back(GV);
}
-//
+//
// Check if this instruction has any uses outside its basic block,
-// or if it used by either a Call or Return instruction.
-//
+// or if it used by either a Call or Return instruction (ditto).
+// (Values stored to memory within this BB are live at end of BB but are
+// traced at the store instruction, not where they are computed.)
+//
static inline bool LiveAtBBExit(const Instruction* I) {
const BasicBlock *BB = I->getParent();
for (Value::use_const_iterator U = I->use_begin(); U != I->use_end(); ++U)
static inline bool TraceThisOpCode(unsigned opCode) {
// Explicitly test for opCodes *not* to trace so that any new opcodes will
// be traced by default (VoidTy's are already excluded)
- //
+ //
return (opCode < Instruction::OtherOpsBegin &&
opCode != Instruction::Alloca &&
- opCode != Instruction::PHINode &&
+ opCode != Instruction::PHI &&
opCode != Instruction::Cast);
}
+// Trace a value computed by an instruction if it is non-void, it is computed
+// by a real computation, not just a copy (see TraceThisOpCode), and
+// -- it is a load instruction: we want to check values read from memory
+// -- or it is live at exit from the basic block (i.e., ignore local temps)
+//
static bool ShouldTraceValue(const Instruction *I) {
return
- I->getType() != Type::VoidTy && LiveAtBBExit(I) &&
- TraceThisOpCode(I->getOpcode());
+ I->getType() != Type::VoidTy &&
+ TraceThisOpCode(I->getOpcode()) &&
+ (isa<LoadInst>(I) || LiveAtBBExit(I));
}
-static string getPrintfCodeFor(const Value *V) {
+static std::string getPrintfCodeFor(const Value *V) {
if (V == 0) return "";
if (V->getType()->isFloatingPoint())
return "%g";
return DisablePtrHashing ? "0x%p" : "%d";
else if (V->getType()->isIntegral())
return "%d";
-
+
assert(0 && "Illegal value to print out...");
return "";
}
static void InsertPrintInst(Value *V, BasicBlock *BB, Instruction *InsertBefore,
- string Message,
+ std::string Message,
Function *Printf, Function* HashPtrToSeqNum) {
// Escape Message by replacing all % characters with %% chars.
- string Tmp;
+ std::string Tmp;
std::swap(Tmp, Message);
- string::iterator I = std::find(Tmp.begin(), Tmp.end(), '%');
+ std::string::iterator I = std::find(Tmp.begin(), Tmp.end(), '%');
while (I != Tmp.end()) {
Message.append(Tmp.begin(), I);
Message += "%%";
GlobalVariable *fmtVal = getStringRef(Mod, Message+getPrintfCodeFor(V)+"\n");
// Turn the format string into an sbyte *
- Instruction *GEP =
- new GetElementPtrInst(fmtVal,
- vector<Value*>(2,ConstantSInt::get(Type::LongTy, 0)),
- "trstrp", InsertBefore);
-
+ Constant *GEP=ConstantExpr::getGetElementPtr(fmtVal,
+ std::vector<Constant*>(2,Constant::getNullValue(Type::LongTy)));
+
// 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*
V = new CastInst(V, SBP, "Hash_cast", InsertBefore);
- vector<Value*> HashArgs(1, V);
+ std::vector<Value*> HashArgs(1, V);
V = new CallInst(HashPtrToSeqNum, HashArgs, "ptrSeqNum", InsertBefore);
}
-
+
// Insert the first print instruction to print the string flag:
- vector<Value*> PrintArgs;
+ std::vector<Value*> PrintArgs;
PrintArgs.push_back(GEP);
if (V) PrintArgs.push_back(V);
new CallInst(Printf, PrintArgs, "trace", InsertBefore);
}
-
+
static void InsertVerbosePrintInst(Value *V, BasicBlock *BB,
Instruction *InsertBefore,
- const string &Message, Function *Printf,
+ const std::string &Message, Function *Printf,
Function* HashPtrToSeqNum) {
std::ostringstream OutStr;
if (V) WriteAsOperand(OutStr, V);
Printf, HashPtrToSeqNum);
}
-static void
+static void
InsertReleaseInst(Value *V, BasicBlock *BB,
Instruction *InsertBefore,
Function* ReleasePtrFunc) {
-
+
const Type *SBP = PointerType::get(Type::SByteTy);
if (V->getType() != SBP) // Cast pointer to be sbyte*
V = new CastInst(V, SBP, "RPSN_cast", InsertBefore);
- vector<Value*> releaseArgs(1, V);
+ std::vector<Value*> releaseArgs(1, V);
new CallInst(ReleasePtrFunc, releaseArgs, "", InsertBefore);
}
-static void
+static void
InsertRecordInst(Value *V, BasicBlock *BB,
Instruction *InsertBefore,
Function* RecordPtrFunc) {
if (V->getType() != SBP) // Cast pointer to be sbyte*
V = new CastInst(V, SBP, "RP_cast", InsertBefore);
- vector<Value*> releaseArgs(1, V);
+ std::vector<Value*> releaseArgs(1, V);
new CallInst(RecordPtrFunc, releaseArgs, "", InsertBefore);
}
// Look for alloca and free instructions. These are the ptrs to release.
// Release the free'd pointers immediately. Record the alloca'd pointers
// to be released on return from the current function.
-//
+//
static void
ReleasePtrSeqNumbers(BasicBlock *BB,
ExternalFuncs& externalFuncs) {
-
+
for (BasicBlock::iterator II=BB->begin(), IE = BB->end(); II != IE; ++II)
if (FreeInst *FI = dyn_cast<FreeInst>(II))
InsertReleaseInst(FI->getOperand(0), BB, FI,externalFuncs.ReleasePtrFunc);
else if (AllocaInst *AI = dyn_cast<AllocaInst>(II))
InsertRecordInst(AI, BB, AI->getNext(), externalFuncs.RecordPtrFunc);
-}
+}
// Insert print instructions at the end of basic block BB for each value
// for printing at the exit from the function. (Note that in each invocation
// of the function, this will only get the last value stored for each static
// store instruction).
-//
+//
static void TraceValuesAtBBExit(BasicBlock *BB,
Function *Printf, Function* HashPtrToSeqNum,
- vector<Instruction*> *valuesStoredInFunction) {
+ std::vector<Instruction*> *valuesStoredInFunction) {
// Get an iterator to point to the insertion location, which is
// just before the terminator instruction.
- //
+ //
TerminatorInst *InsertPos = BB->getTerminator();
-
+
std::ostringstream OutStr;
WriteAsOperand(OutStr, BB, false);
InsertPrintInst(0, BB, InsertPos, "LEAVING BB:" + OutStr.str(),
// Insert a print instruction for each instruction preceding InsertPos.
// The print instructions must go before InsertPos, so we use the
// instruction *preceding* InsertPos to check when to terminate the loop.
- //
+ //
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);
+ // Trace the stored value and address
+ InsertVerbosePrintInst(SI->getOperand(0), BB, InsertPos,
+ " (store value) ", Printf, HashPtrToSeqNum);
+ InsertVerbosePrintInst(SI->getOperand(1), BB, InsertPos,
+ " (store addr ) ", Printf, HashPtrToSeqNum);
}
- if (ShouldTraceValue(II))
+ else if (ShouldTraceValue(II))
InsertVerbosePrintInst(II, BB, InsertPos, " ", Printf, HashPtrToSeqNum);
}
}
static inline void InsertCodeToShowFunctionEntry(Function &F, Function *Printf,
Function* HashPtrToSeqNum){
// Get an iterator to point to the insertion location
- BasicBlock &BB = F.getEntryNode();
+ BasicBlock &BB = F.getEntryBlock();
Instruction *InsertPos = BB.begin();
std::ostringstream OutStr;
// Now print all the incoming arguments
unsigned ArgNo = 0;
- for (Function::aiterator I = F.abegin(), E = F.aend(); I != E; ++I, ++ArgNo){
+ for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I, ++ArgNo){
InsertVerbosePrintInst(I, &BB, InsertPos,
" Arg #" + utostr(ArgNo) + ": ", Printf,
HashPtrToSeqNum);
Function* HashPtrToSeqNum) {
// Get an iterator to point to the insertion location
ReturnInst *Ret = cast<ReturnInst>(BB->getTerminator());
-
+
std::ostringstream OutStr;
WriteAsOperand(OutStr, BB->getParent(), true);
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, Ret, " Returning: ",
bool InsertTraceCode::runOnFunction(Function &F) {
if (!TraceThisFunction(F))
return false;
-
- vector<Instruction*> valuesStoredInFunction;
- vector<BasicBlock*> exitBlocks;
+
+ std::vector<Instruction*> valuesStoredInFunction;
+ std::vector<BasicBlock*> exitBlocks;
// Insert code to trace values at function entry
InsertCodeToShowFunctionEntry(F, externalFuncs.PrintfFunc,
externalFuncs.HashPtrFunc);
-
+
// Push a pointer set for recording alloca'd pointers at entry.
if (!DisablePtrHashing)
- new CallInst(externalFuncs.PushOnEntryFunc, vector<Value*>(), "",
- F.getEntryNode().begin());
+ new CallInst(externalFuncs.PushOnEntryFunc, std::vector<Value*>(), "",
+ F.getEntryBlock().begin());
for (Function::iterator BB = F.begin(); BB != F.end(); ++BB) {
if (isa<ReturnInst>(BB->getTerminator()))
if (!DisablePtrHashing) // release seq. numbers on free/ret
ReleasePtrSeqNumbers(BB, externalFuncs);
}
-
+
for (unsigned i=0; i != exitBlocks.size(); ++i)
{
// Insert code to trace values at function exit
InsertCodeToShowFunctionExit(exitBlocks[i], externalFuncs.PrintfFunc,
externalFuncs.HashPtrFunc);
-
+
// Release all recorded pointers before RETURN. Do this LAST!
if (!DisablePtrHashing)
- new CallInst(externalFuncs.ReleaseOnReturnFunc, vector<Value*>(), "",
- exitBlocks[i]->getTerminator());
+ new CallInst(externalFuncs.ReleaseOnReturnFunc, std::vector<Value*>(),
+ "", exitBlocks[i]->getTerminator());
}
-
+
return true;
}
projects / oota-llvm.git / blobdiff