-// $Id$
-//***************************************************************************
-// File:
-// TraceValues.cpp
-//
-// Purpose:
-// Support for inserting LLVM code to print values at basic block
-// and method exits. Also exports functions to create a call
-// "printf" instruction with one of the signatures listed below.
-//
-// History:
-// 10/11/01 - Vikram Adve - Created
-//**************************************************************************/
-
+//===- TraceValues.cpp - Value Tracing for debugging -------------*- C++ -*--=//
+//
+// Support for inserting LLVM code to print values at basic block and function
+// exits.
+//
+//===----------------------------------------------------------------------===//
#include "llvm/Transforms/Instrumentation/TraceValues.h"
#include "llvm/GlobalVariable.h"
-#include "llvm/ConstPoolVals.h"
-#include "llvm/Type.h"
+#include "llvm/Constants.h"
#include "llvm/DerivedTypes.h"
-#include "llvm/Instruction.h"
+#include "llvm/iMemory.h"
#include "llvm/iTerminators.h"
#include "llvm/iOther.h"
#include "llvm/BasicBlock.h"
-#include "llvm/Method.h"
+#include "llvm/Function.h"
#include "llvm/Module.h"
-#include "llvm/SymbolTable.h"
-#include <strstream>
+#include "llvm/Pass.h"
#include "llvm/Assembly/Writer.h"
+#include "Support/CommandLine.h"
+#include "Support/StringExtras.h"
+#include <algorithm>
+#include <sstream>
+using std::vector;
+using std::string;
+
+static cl::Flag DisablePtrHashing("tracedisablehashdisable",
+ "Disable pointer hashing", cl::NoFlags);
+static cl::StringList TraceFuncName ("tracefunc", "trace only specific funct"
+ "ions", cl::NoFlags);
-const char* const PRINTF = "printVal";
-static inline GlobalVariable *
-GetStringRef(Module *M, const string &str)
+// 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)
{
- ConstPoolArray *Init = ConstPoolArray::get(str);
- GlobalVariable *V = new GlobalVariable(Init->getType(), /*Const*/true, Init);
- M->getGlobalList().push_back(V);
+ if (TraceFuncName.getNumOccurances() == 0)
+ return true;
- return V;
+ return std::find(TraceFuncName.begin(), TraceFuncName.end(), func->getName())
+ != TraceFuncName.end();
}
-static inline bool
-TraceThisOpCode(unsigned opCode)
-{
+
+namespace {
+ struct ExternalFuncs {
+ Function *PrintfFunc, *HashPtrFunc, *ReleasePtrFunc;
+ Function *RecordPtrFunc, *PushOnEntryFunc, *ReleaseOnReturnFunc;
+ void doInitialization(Module &M); // Add prototypes for external functions
+ };
+
+ class InsertTraceCode : public FunctionPass {
+ bool TraceBasicBlockExits, TraceFunctionExits;
+ 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.
+ //
+ 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'.
+ //
+ static bool doit(Function *M, bool traceBasicBlockExits,
+ bool traceFunctionExits, ExternalFuncs& externalFuncs);
+
+ // runOnFunction - This method does the work.
+ //
+ bool runOnFunction(Function &F) {
+ return doit(&F, TraceBasicBlockExits, TraceFunctionExits, externalFuncs);
+ }
+
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.preservesCFG();
+ }
+ };
+} // end anonymous namespace
+
+
+Pass *createTraceValuesPassForFunction() { // Just trace functions
+ return new InsertTraceCode(false, true);
+}
+
+Pass *createTraceValuesPassForBasicBlocks() { // Trace BB's and functions
+ return new InsertTraceCode(true, true);
+}
+
+// Add a prototype for external functions used by the tracing code.
+//
+void ExternalFuncs::doInitialization(Module &M) {
+ const Type *SBP = PointerType::get(Type::SByteTy);
+ const FunctionType *MTy =
+ FunctionType::get(Type::IntTy, 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);
+
+ // 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);
+ ReleaseOnReturnFunc = M.getOrInsertFunction("ReleasePointersPopSet",
+ voidvoidFuncTy);
+}
+
+
+// Add a prototype for external functions used by the tracing code.
+//
+bool InsertTraceCode::doInitialization(Module &M) {
+ externalFuncs.doInitialization(M);
+ return false;
+}
+
+
+static inline GlobalVariable *getStringRef(Module *M, const 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, true, Init,
+ "trstr");
+ M->getGlobalList().push_back(GV);
+ return GV;
+}
+
+
+//
+// Check if this instruction has any uses outside its basic block,
+// or if it used by either a Call or Return instruction.
+//
+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)
+ if (const Instruction *UI = dyn_cast<Instruction>(*U))
+ if (UI->getParent() != BB || isa<ReturnInst>(UI))
+ return true;
+
+ return false;
+}
+
+
+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)
//
}
-static void
-FindValuesToTraceInBB(BasicBlock* bb, vector<Value*>& valuesToTraceInBB)
-{
- for (BasicBlock::iterator II = bb->begin(); II != bb->end(); ++II)
- if ((*II)->getType()->isPrimitiveType() &&
- (*II)->getType() != Type::VoidTy &&
- TraceThisOpCode((*II)->getOpcode()))
- {
- valuesToTraceInBB.push_back(*II);
- }
+static bool ShouldTraceValue(const Instruction *I) {
+ return
+ I->getType() != Type::VoidTy && LiveAtBBExit(I) &&
+ TraceThisOpCode(I->getOpcode());
}
-// The invocation should be:
-// call "printf"(fmt, value).
-//
-static Value *GetPrintMethodForType(Module *Mod, const Type *valueType) {
- vector<const Type*> ArgTys;
- ArgTys.reserve(2);
- ArgTys.push_back(PointerType::get(ArrayType::get(Type::UByteTy)));
- ArgTys.push_back(valueType);
-
- MethodType *printMethodTy = MethodType::get(Type::VoidTy, ArgTys,
- /*isVarArg*/ false);
+static string getPrintfCodeFor(const Value *V) {
+ if (V == 0) return "";
+ if (V->getType()->isFloatingPoint())
+ return "%g";
+ else if (V->getType() == Type::LabelTy)
+ return "0x%p";
+ else if (isa<PointerType>(V->getType()))
+ return DisablePtrHashing ? "0x%p" : "%d";
+ else if (V->getType()->isIntegral() || V->getType() == Type::BoolTy)
+ return "%d";
- SymbolTable *ST = Mod->getSymbolTableSure();
- if (Value *V = ST->lookup(PointerType::get(printMethodTy), PRINTF))
- return V;
-
- // Create a new method and add it to the module
- Method *M = new Method(printMethodTy, PRINTF);
- Mod->getMethodList().push_back(M);
- return M;
+ assert(0 && "Illegal value to print out...");
+ return "";
}
-static Instruction*
-CreatePrintInstr(Value* val,
- const BasicBlock* bb,
- Module* module,
- unsigned int indent,
- bool isMethodExit)
-{
- strstream scopeNameString;
- const Type* valueType = val->getType();
-
- assert(valueType->isPrimitiveType() &&
- valueType->getPrimitiveID() != Type::VoidTyID &&
- valueType->getPrimitiveID() != Type::TypeTyID &&
- valueType->getPrimitiveID() != Type::LabelTyID &&
- "Unsupported type for printing");
-
- const Value* scopeToUse = (isMethodExit)? (const Value*) bb->getParent()
- : (const Value*) bb;
- WriteAsOperand(scopeNameString, scopeToUse) << " : ";
- WriteAsOperand(scopeNameString, val) << " = "
- << val->getType()->getDescription()
- << ends;
- string fmtString(indent, ' ');
-
- fmtString += " At exit of " + string(isMethodExit ? "Method " : "BB ") +
- scopeNameString.str();
-
- switch(valueType->getPrimitiveID()) {
- case Type::BoolTyID:
- case Type::UByteTyID: case Type::UShortTyID:
- case Type::UIntTyID: case Type::ULongTyID:
- case Type::SByteTyID: case Type::ShortTyID:
- case Type::IntTyID: case Type::LongTyID:
- fmtString += " %d\0A";
- break;
-
- case Type::FloatTyID: case Type::DoubleTyID:
- fmtString += " %g\0A";
- break;
-
- case Type::PointerTyID:
- fmtString += " %p\0A";
- break;
-
- default:
- assert(0 && "Should not get here. Check the IF expression above");
- return NULL;
+static void InsertPrintInst(Value *V,BasicBlock *BB, BasicBlock::iterator &BBI,
+ string Message,
+ Function *Printf, Function* HashPtrToSeqNum) {
+ // Escape Message by replacing all % characters with %% chars.
+ unsigned Offset = 0;
+ while ((Offset = Message.find('%', Offset)) != string::npos) {
+ Message.replace(Offset, 1, "%%");
+ Offset += 2; // Skip over the new %'s
}
+
+ Module *Mod = BB->getParent()->getParent();
+
+ // Turn the marker string into a global variable...
+ GlobalVariable *fmtVal = getStringRef(Mod, Message+getPrintfCodeFor(V)+"\n");
+
+ // 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);
- GlobalVariable *fmtVal = GetStringRef(module, fmtString);
+ // 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;
+ }
+
+ vector<Value*> HashArgs(1, V);
+ V = new CallInst(HashPtrToSeqNum, HashArgs, "ptrSeqNum");
+ BBI = ++BB->getInstList().insert(BBI, cast<Instruction>(V));
+ }
- vector<Value*> paramList;
- paramList.push_back(fmtVal);
- paramList.push_back(val);
+ // 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);
+}
+
- return new CallInst(GetPrintMethodForType(module, valueType), paramList);
+static void InsertVerbosePrintInst(Value *V, BasicBlock *BB,
+ BasicBlock::iterator &BBI,
+ const string &Message, Function *Printf,
+ Function* HashPtrToSeqNum) {
+ std::ostringstream OutStr;
+ if (V) WriteAsOperand(OutStr, V);
+ InsertPrintInst(V, BB, BBI, Message+OutStr.str()+" = ",
+ Printf, HashPtrToSeqNum);
}
+static void
+InsertReleaseInst(Value *V, BasicBlock *BB,
+ BasicBlock::iterator &BBI,
+ 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;
+ }
+ vector<Value*> releaseArgs(1, V);
+ Instruction *I = new CallInst(ReleasePtrFunc, releaseArgs);
+ BBI = ++BB->getInstList().insert(BBI, I);
+}
+static void
+InsertRecordInst(Value *V, BasicBlock *BB,
+ BasicBlock::iterator &BBI,
+ 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*>()));
+}
+
+static void
+InsertReleaseRecordedInst(BasicBlock *BB,
+ Function* ReleaseOnReturnFunc) {
+ BasicBlock::iterator BBI = BB->end()--;
+ BBI = ++BB->getInstList().insert(BBI, new CallInst(ReleaseOnReturnFunc,
+ vector<Value*>()));
+}
+
+// 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(); II != BB->end(); ++II) {
+ if (FreeInst *FI = dyn_cast<FreeInst>(&*II))
+ InsertReleaseInst(FI->getOperand(0), BB,II,externalFuncs.ReleasePtrFunc);
+ else if (AllocaInst *AI = dyn_cast<AllocaInst>(&*II))
+ {
+ BasicBlock::iterator nextI = ++II;
+ InsertRecordInst(AI, BB, nextI, externalFuncs.RecordPtrFunc);
+ II = --nextI;
+ }
+ }
+}
+
+
// Insert print instructions at the end of the basic block *bb
-// for each value in valueVec[]. *bb must postdominate the block
-// in which the value is computed; this is not checked here.
+// for each value in valueVec[] that is live at the end of that basic block,
+// or that is stored to memory in this basic block.
+// If the value is stored to memory, we load it back before printing
+// We also return all such loaded values in the vector valuesStoredInFunction
+// 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).
+// *bb must be the block in which the value is computed;
+// this is not checked here.
//
-static void
-TraceValuesAtBBExit(const vector<Value*>& valueVec,
- BasicBlock* bb,
- Module* module,
- unsigned int indent,
- bool isMethodExit)
-{
- // Get an iterator to point to the insertion location
+static void TraceValuesAtBBExit(BasicBlock *BB,
+ Function *Printf, Function* HashPtrToSeqNum,
+ vector<Instruction*> *valuesStoredInFunction) {
+ // Get an iterator to point to the insertion location, which is
+ // just before the terminator instruction.
//
- BasicBlock::InstListType& instList = bb->getInstList();
- TerminatorInst* termInst = bb->getTerminator();
- BasicBlock::InstListType::iterator here = instList.end()-1;
- assert((*here)->isTerminator());
+ BasicBlock::iterator InsertPos = BB->end()--;
+ assert(BB->back().isTerminator());
+ // 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
+ }
+
+ std::ostringstream OutStr;
+ WriteAsOperand(OutStr, BB, false);
+ InsertPrintInst(0, BB, InsertPos, "LEAVING BB:" + OutStr.str(),
+ Printf, HashPtrToSeqNum);
+
// Insert a print instruction for each value.
//
- for (unsigned i=0, N=valueVec.size(); i < N; i++)
- {
- Instruction* traceInstr =
- CreatePrintInstr(valueVec[i], bb, module, indent, isMethodExit);
- here = instList.insert(here, traceInstr);
+ for (BasicBlock::iterator II = BB->begin(), IE = InsertPos++; II != IE; ++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(), 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);
+ }
}
-static void
-InsertCodeToShowMethodEntry(BasicBlock* entryBB)
-{
-}
+static inline void InsertCodeToShowFunctionEntry(Function *M, Function *Printf,
+ Function* HashPtrToSeqNum){
+ // Get an iterator to point to the insertion location
+ BasicBlock &BB = M->getEntryNode();
+ BasicBlock::iterator BBI = BB.begin();
-static void
-InsertCodeToShowMethodExit(BasicBlock* exitBB)
-{
+ std::ostringstream OutStr;
+ WriteAsOperand(OutStr, M, true);
+ InsertPrintInst(0, &BB, BBI, "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,
+ " Arg #" + utostr(ArgNo) + ": ", Printf,
+ HashPtrToSeqNum);
+ }
}
-bool InsertTraceCode::doInsertTraceCode(Method *M, bool traceBasicBlockExits,
- bool traceMethodExits) {
- vector<Value*> valuesToTraceInMethod;
- Module* module = M->getParent();
- BasicBlock* exitBB = NULL;
+static inline void InsertCodeToShowFunctionExit(BasicBlock *BB,
+ Function *Printf,
+ Function* HashPtrToSeqNum) {
+ // Get an iterator to point to the insertion location
+ BasicBlock::iterator BBI = BB->end()--;
+ ReturnInst &Ret = cast<ReturnInst>(BB->back());
- if (M->isExternal() ||
- (! traceBasicBlockExits && ! traceMethodExits))
- return false;
-
- if (traceMethodExits) {
- InsertCodeToShowMethodEntry(M->getEntryNode());
- exitBB = M->getBasicBlocks().front(); //getExitNode();
- }
+ std::ostringstream OutStr;
+ WriteAsOperand(OutStr, BB->getParent(), true);
+ InsertPrintInst(0, BB, BBI, "LEAVING FUNCTION: " + OutStr.str(),
+ Printf, HashPtrToSeqNum);
+
+ // print the return value, if any
+ if (BB->getParent()->getReturnType() != Type::VoidTy)
+ InsertPrintInst(Ret.getReturnValue(), BB, BBI, " Returning: ",
+ Printf, HashPtrToSeqNum);
+}
- for (Method::iterator BI = M->begin(); BI != M->end(); ++BI) {
- BasicBlock* bb = *BI;
- vector<Value*> valuesToTraceInBB;
- FindValuesToTraceInBB(bb, valuesToTraceInBB);
+bool InsertTraceCode::doit(Function *M, bool traceBasicBlockExits,
+ bool traceFunctionEvents,
+ ExternalFuncs& externalFuncs) {
+ if (!traceBasicBlockExits && !traceFunctionEvents)
+ return false;
- if (traceBasicBlockExits && bb != exitBB)
- TraceValuesAtBBExit(valuesToTraceInBB, bb, module,
- /*indent*/ 4, /*isMethodExit*/ false);
+ if (!TraceThisFunction(M))
+ return false;
+
+ vector<Instruction*> valuesStoredInFunction;
+ vector<BasicBlock*> exitBlocks;
- if (traceMethodExits) {
- valuesToTraceInMethod.insert(valuesToTraceInMethod.end(),
- valuesToTraceInBB.begin(),
- valuesToTraceInBB.end());
- }
- }
+ // Insert code to trace values at function entry
+ if (traceFunctionEvents)
+ InsertCodeToShowFunctionEntry(M, externalFuncs.PrintfFunc,
+ externalFuncs.HashPtrFunc);
- if (traceMethodExits) {
- TraceValuesAtBBExit(valuesToTraceInMethod, exitBB, module,
- /*indent*/ 0, /*isMethodExit*/ true);
- InsertCodeToShowMethodExit(exitBB);
+ // 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) {
+ if (isa<ReturnInst>(BB->getTerminator()))
+ exitBlocks.push_back(BB); // record this as an exit block
+
+ if (traceBasicBlockExits)
+ TraceValuesAtBBExit(BB, externalFuncs.PrintfFunc,
+ externalFuncs.HashPtrFunc, &valuesStoredInFunction);
+
+ 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
+ if (traceFunctionEvents)
+ InsertCodeToShowFunctionExit(exitBlocks[i], externalFuncs.PrintfFunc,
+ externalFuncs.HashPtrFunc);
+
+ // Release all recorded pointers before RETURN. Do this LAST!
+ if (!DisablePtrHashing)
+ InsertReleaseRecordedInst(exitBlocks[i],
+ externalFuncs.ReleaseOnReturnFunc);
+ }
+
return true;
}
projects / oota-llvm.git / blobdiff