-// $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/Module.h"
-#include "llvm/SymbolTable.h"
+#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 inline GlobalVariable *GetStringRef(Module *M, const string &str) {
- ConstPoolArray *Init = ConstPoolArray::get(str);
- GlobalVariable *GV = new GlobalVariable(Init->getType(), /*Const*/true, Init);
- M->getGlobalList().push_back(GV);
- return GV;
-}
+static cl::opt<bool>
+DisablePtrHashing("tracedisablehashdisable", cl::Hidden,
+ cl::desc("Disable pointer hashing"));
+static cl::list<string>
+TraceFuncName("tracefunc", cl::desc("trace only specific functions"),
+ cl::value_desc("function"), cl::Hidden);
-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::FirstOtherOp &&
- opCode != Instruction::Alloca &&
- opCode != Instruction::PHINode &&
- opCode != Instruction::Cast);
-}
+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.
//
-// Check if this instruction has any uses outside its basic block
-//
-static inline bool
-LiveAtBBExit(Instruction* I)
+inline static bool
+TraceThisFunction(Function &func)
{
- BasicBlock* bb = I->getParent();
- bool isLive = false;
- for (Value::use_const_iterator U = I->use_begin(); U != I->use_end(); ++U)
- {
- const Instruction* userI = dyn_cast<Instruction>(*U);
- if (userI == NULL || userI->getParent() != bb)
- isLive = true;
- }
-
- return isLive;
-}
-
+ if (TraceFuncName.size() == 0)
+ return true;
-static void
-FindValuesToTraceInBB(BasicBlock* bb, vector<Instruction*>& valuesToTraceInBB)
-{
- for (BasicBlock::iterator II = bb->begin(); II != bb->end(); ++II)
- if ((*II)->getOpcode() == Instruction::Store
- || (LiveAtBBExit(*II) &&
- (*II)->getType()->isPrimitiveType() &&
- (*II)->getType() != Type::VoidTy &&
- TraceThisOpCode((*II)->getOpcode())))
- {
- valuesToTraceInBB.push_back(*II);
- }
+ return std::find(TraceFuncName.begin(), TraceFuncName.end(), func.getName())
+ != TraceFuncName.end();
}
-#if 0 // Code is disabled for now
-//
-// Let's save this code for future use; it has been tested and works:
-//
-// The signatures of the printf methods supported are:
-// int printf(ubyte*, ubyte*, ubyte*, ubyte*, int intValue)
-// int printf(ubyte*, ubyte*, ubyte*, ubyte*, unsigned uintValue)
-// int printf(ubyte*, ubyte*, ubyte*, ubyte*, float floatValue)
-// int printf(ubyte*, ubyte*, ubyte*, ubyte*, double doubleValue)
-// int printf(ubyte*, ubyte*, ubyte*, ubyte*, char* stringValue)
-// int printf(ubyte*, ubyte*, ubyte*, ubyte*, void* ptrValue)
-//
-// The invocation should be:
-// call "printf"(fmt, bbName, valueName, valueTypeName, value).
-//
-Value *GetPrintfMethodForType(Module* module, const Type* valueType)
-{
- PointerType *ubytePtrTy = PointerType::get(ArrayType::get(Type::UByteTy));
- vector<const Type*> argTypesVec(4, ubytePtrTy);
- argTypesVec.push_back(valueType);
-
- MethodType *printMethodTy = MethodType::get(Type::IntTy, argTypesVec,
- /*isVarArg*/ false);
-
- SymbolTable *ST = module->getSymbolTable();
- if (Value *Meth = ST->lookup(PointerType::get(printMethodTy), "printf"))
- return Meth;
- // Create a new method and add it to the module
- Method *printMethod = new Method(printMethodTy, "printf");
- module->getMethodList().push_back(printMethod);
+namespace {
+ struct ExternalFuncs {
+ Function *PrintfFunc, *HashPtrFunc, *ReleasePtrFunc;
+ Function *RecordPtrFunc, *PushOnEntryFunc, *ReleaseOnReturnFunc;
+ void doInitialization(Module &M); // Add prototypes for external functions
+ };
- return printMethod;
+ 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;
+
+ // runOnFunction - This method does the work.
+ //
+ 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 FunctionTracer();
}
+Pass *createTraceValuesPassForBasicBlocks() { // Trace BB's and functions
+ return new BasicBlockTracer();
+}
-Instruction*
-CreatePrintfInstr(Value* val,
- const BasicBlock* bb,
- Module* module,
- unsigned int indent,
- bool isMethodExit)
-{
- ostringstream fmtString, scopeNameString, valNameString;
- vector<Value*> paramList;
- const Type* valueType = val->getType();
- Method* printMethod = GetPrintfMethodForType(module, valueType);
-
- if (! valueType->isPrimitiveType() ||
- valueType->getPrimitiveID() == Type::VoidTyID ||
- valueType->getPrimitiveID() == Type::TypeTyID ||
- valueType->getPrimitiveID() == Type::LabelTyID)
- {
- assert(0 && "Unsupported type for printing");
- return NULL;
- }
-
- const Value* scopeToUse = (isMethodExit)? (const Value*) bb->getParent()
- : (const Value*) bb;
- if (scopeToUse->hasName())
- scopeNameString << scopeToUse->getName() << ends;
- else
- scopeNameString << scopeToUse << ends;
-
- if (val->hasName())
- valNameString << val->getName() << ends;
- else
- valNameString << val << ends;
-
- for (unsigned i=0; i < indent; i++)
- fmtString << " ";
-
- fmtString << " At exit of "
- << ((isMethodExit)? "Method " : "BB ")
- << "%s : val %s = %s ";
-
- GlobalVariable* scopeNameVal = GetStringRef(module, scopeNameString.str());
- GlobalVariable* valNameVal = GetStringRef(module,valNameString.str());
- GlobalVariable* typeNameVal = GetStringRef(module,
- val->getType()->getDescription().c_str());
+
+// 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);
- 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;
- }
+ // void (sbyte*)
+ const FunctionType *voidSBPFuncTy =
+ FunctionType::get(Type::VoidTy, vector<const Type*>(1, SBP), false);
- fmtString << ends;
- GlobalVariable* fmtVal = GetStringRef(module, fmtString.str());
+ ReleasePtrFunc = M.getOrInsertFunction("ReleasePointerSeqNum", voidSBPFuncTy);
+ RecordPtrFunc = M.getOrInsertFunction("RecordPointer", voidSBPFuncTy);
- paramList.push_back(fmtVal);
- paramList.push_back(scopeNameVal);
- paramList.push_back(valNameVal);
- paramList.push_back(typeNameVal);
- paramList.push_back(val);
+ const FunctionType *voidvoidFuncTy =
+ FunctionType::get(Type::VoidTy, vector<const Type*>(), false);
- return new CallInst(printMethod, paramList);
+ 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;
}
-#endif
-// The invocation should be:
-// call "printVal"(value).
//
-static Value *GetPrintMethodForType(Module *Mod, const Type *VTy) {
- MethodType *MTy = MethodType::get(Type::VoidTy, vector<const Type*>(1, VTy),
- /*isVarArg*/ false);
-
- SymbolTable *ST = Mod->getSymbolTableSure();
- if (Value *V = ST->lookup(PointerType::get(MTy), "printVal"))
- return V;
-
- // Create a new method and add it to the module
- Method *M = new Method(MTy, "printVal");
- Mod->getMethodList().push_back(M);
- return M;
+// 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 void
-InsertPrintInsts(Value *Val,
- BasicBlock* BB,
- BasicBlock::iterator &BBI,
- Module *Mod,
- unsigned int indent,
- bool isMethodExit)
-{
- const Type* ValTy = Val->getType();
-
- assert(ValTy->isPrimitiveType() &&
- ValTy->getPrimitiveID() != Type::VoidTyID &&
- ValTy->getPrimitiveID() != Type::TypeTyID &&
- ValTy->getPrimitiveID() != Type::LabelTyID &&
- "Unsupported type for printing");
-
- const Value* scopeToUse =
- isMethodExit ? (const Value*)BB->getParent() : (const Value*)BB;
-
- // Create the marker string...
- ostringstream scopeNameString;
- WriteAsOperand(scopeNameString, scopeToUse) << " : ";
- WriteAsOperand(scopeNameString, Val) << " = " << ends;
- string fmtString(indent, ' ');
-
- fmtString += string(" At exit of") + scopeNameString.str();
+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::FirstOtherOp &&
+ opCode != Instruction::Alloca &&
+ opCode != Instruction::PHINode &&
+ opCode != Instruction::Cast);
+}
+
+
+static bool ShouldTraceValue(const Instruction *I) {
+ return
+ I->getType() != Type::VoidTy && LiveAtBBExit(I) &&
+ TraceThisOpCode(I->getOpcode());
+}
+
+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())
+ return "%d";
+ assert(0 && "Illegal value to print out...");
+ return "";
+}
+
+
+static void InsertPrintInst(Value *V, BasicBlock *BB, Instruction *InsertBefore,
+ 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, fmtString);
+ 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)),
+ "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*
+ V = new CastInst(V, SBP, "Hash_cast", InsertBefore);
+
+ vector<Value*> HashArgs(1, V);
+ V = new CallInst(HashPtrToSeqNum, HashArgs, "ptrSeqNum", InsertBefore);
+ }
// Insert the first print instruction to print the string flag:
- Instruction *I = new CallInst(GetPrintMethodForType(Mod, fmtVal->getType()),
- vector<Value*>(1, fmtVal));
- BBI = BB->getInstList().insert(BBI, I)+1;
-
- // Insert the next print instruction to print the value:
- I = new CallInst(GetPrintMethodForType(Mod, ValTy),
- vector<Value*>(1, Val));
- BBI = BB->getInstList().insert(BBI, I)+1;
-
- // Print out a newline
- fmtVal = GetStringRef(Mod, "\n");
- I = new CallInst(GetPrintMethodForType(Mod, fmtVal->getType()),
- vector<Value*>(1, fmtVal));
- BBI = BB->getInstList().insert(BBI, I)+1;
+ 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,
+ Function* HashPtrToSeqNum) {
+ std::ostringstream OutStr;
+ if (V) WriteAsOperand(OutStr, V);
+ InsertPrintInst(V, BB, InsertBefore, Message+OutStr.str()+" = ",
+ Printf, HashPtrToSeqNum);
}
+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);
-static LoadInst*
-InsertLoadInst(StoreInst* storeInst,
- BasicBlock *bb,
- BasicBlock::iterator &BBI)
-{
- LoadInst* loadInst = new LoadInst(storeInst->getPtrOperand(),
- storeInst->getIndexVec());
- BBI = bb->getInstList().insert(BBI, loadInst) + 1;
- return loadInst;
+ vector<Value*> releaseArgs(1, V);
+ new CallInst(ReleasePtrFunc, releaseArgs, "", InsertBefore);
}
+static void
+InsertRecordInst(Value *V, BasicBlock *BB,
+ Instruction *InsertBefore,
+ Function* RecordPtrFunc) {
+ const Type *SBP = PointerType::get(Type::SByteTy);
+ if (V->getType() != SBP) // Cast pointer to be sbyte*
+ V = new CastInst(V, SBP, "RP_cast", InsertBefore);
+
+ 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.
//
-// Insert print instructions at the end of the basic block *bb
-// 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 valuesStoredInMethod
-// for printing at the exit from the method. (Note that in each invocation
-// of the method, this will only get the last value stored for each static
+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
+// computed in BB that is live at the end of BB,
+// or that is stored to memory in BB.
+// If the value is stored to memory, we load it back before printing it
+// 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<Instruction*>& valueVec,
- BasicBlock* bb,
- Module* module,
- unsigned int indent,
- bool isMethodExit,
- vector<Instruction*>* valuesStoredInMethod)
-{
- // 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();
- BasicBlock::iterator here = instList.end()-1;
- assert((*here)->isTerminator());
+ TerminatorInst *InsertPos = BB->getTerminator();
- // Insert a print instruction for each value.
+ std::ostringstream OutStr;
+ WriteAsOperand(OutStr, BB, false);
+ InsertPrintInst(0, BB, InsertPos, "LEAVING BB:" + OutStr.str(),
+ Printf, HashPtrToSeqNum);
+
+ // 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 (unsigned i=0, N=valueVec.size(); i < N; i++)
- {
- Instruction* I = valueVec[i];
- if (I->getOpcode() == Instruction::Store)
- {
- assert(valuesStoredInMethod != NULL &&
- "Should not be printing a store instruction at method exit");
- I = InsertLoadInst((StoreInst*) I, bb, here);
- valuesStoredInMethod->push_back(I);
- }
- InsertPrintInsts(I, bb, here, module, indent, isMethodExit);
+ 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 Instruction*
-CreateMethodTraceInst(Method* method,
- unsigned int indent,
- const string& msg)
-{
- string fmtString(indent, ' ');
- ostringstream methodNameString;
- WriteAsOperand(methodNameString, method) << ends;
- fmtString += msg + methodNameString.str();
-
- GlobalVariable *fmtVal = GetStringRef(method->getParent(), fmtString);
- Instruction *printInst =
- new CallInst(GetPrintMethodForType(method->getParent(), fmtVal->getType()),
- vector<Value*>(1, fmtVal));
-
- return printInst;
-}
-
-
-static inline void
-InsertCodeToShowMethodEntry(Method* method,
- BasicBlock* entryBB,
- unsigned int indent)
-{
+static inline void InsertCodeToShowFunctionEntry(Function &F, Function *Printf,
+ Function* HashPtrToSeqNum){
// Get an iterator to point to the insertion location
- BasicBlock::InstListType& instList = entryBB->getInstList();
- BasicBlock::iterator here = instList.begin();
-
- Instruction *printInst = CreateMethodTraceInst(method, indent,
- "Entering Method");
-
- here = entryBB->getInstList().insert(here, printInst) + 1;
+ BasicBlock &BB = F.getEntryNode();
+ Instruction *InsertPos = BB.begin();
+
+ std::ostringstream OutStr;
+ 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 = F.abegin(), E = F.aend(); I != E; ++I, ++ArgNo){
+ InsertVerbosePrintInst(I, &BB, InsertPos,
+ " Arg #" + utostr(ArgNo) + ": ", Printf,
+ HashPtrToSeqNum);
+ }
}
-static inline void
-InsertCodeToShowMethodExit(Method* method,
- BasicBlock* exitBB,
- unsigned int indent)
-{
+static inline void InsertCodeToShowFunctionExit(BasicBlock *BB,
+ Function *Printf,
+ Function* HashPtrToSeqNum) {
// Get an iterator to point to the insertion location
- BasicBlock::InstListType& instList = exitBB->getInstList();
- BasicBlock::iterator here = instList.end()-1;
- assert((*here)->isTerminator());
+ ReturnInst *Ret = cast<ReturnInst>(BB->getTerminator());
- Instruction *printInst = CreateMethodTraceInst(method, indent,
- "Leaving Method");
+ std::ostringstream OutStr;
+ WriteAsOperand(OutStr, BB->getParent(), true);
+ InsertPrintInst(0, BB, Ret, "LEAVING FUNCTION: " + OutStr.str(),
+ Printf, HashPtrToSeqNum);
- exitBB->getInstList().insert(here, printInst) + 1;
+ // print the return value, if any
+ if (BB->getParent()->getReturnType() != Type::VoidTy)
+ InsertPrintInst(Ret->getReturnValue(), BB, Ret, " Returning: ",
+ Printf, HashPtrToSeqNum);
}
-//************************** External Functions ****************************/
+bool InsertTraceCode::runOnFunction(Function &F) {
+ if (!TraceThisFunction(F))
+ return false;
+
+ vector<Instruction*> valuesStoredInFunction;
+ 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());
-bool
-InsertTraceCode::doInsertTraceCode(Method *M,
- bool traceBasicBlockExits,
- bool traceMethodExits)
-{
- vector<Instruction*> valuesStoredInMethod;
- Module* module = M->getParent();
- vector<BasicBlock*> exitBlocks;
+ 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 (M->isExternal() ||
- (! traceBasicBlockExits && ! traceMethodExits))
- return false;
+ // Insert trace code if this basic block is interesting...
+ handleBasicBlock(BB, valuesStoredInFunction);
- if (traceMethodExits)
- InsertCodeToShowMethodEntry(M, M->getEntryNode(), /*indent*/ 0);
+ if (!DisablePtrHashing) // release seq. numbers on free/ret
+ ReleasePtrSeqNumbers(BB, externalFuncs);
+ }
- for (Method::iterator BI = M->begin(); BI != M->end(); ++BI)
+ for (unsigned i=0; i != exitBlocks.size(); ++i)
{
- BasicBlock* bb = *BI;
- bool isExitBlock = false;
- vector<Instruction*> valuesToTraceInBB;
-
- FindValuesToTraceInBB(bb, valuesToTraceInBB);
-
- if (bb->succ_begin() == bb->succ_end())
- { // record this as an exit block
- exitBlocks.push_back(bb);
- isExitBlock = true;
- }
+ // Insert code to trace values at function exit
+ InsertCodeToShowFunctionExit(exitBlocks[i], externalFuncs.PrintfFunc,
+ externalFuncs.HashPtrFunc);
- if (traceBasicBlockExits)
- TraceValuesAtBBExit(valuesToTraceInBB, bb, module,
- /*indent*/ 4, /*isMethodExit*/ false,
- &valuesStoredInMethod);
+ // Release all recorded pointers before RETURN. Do this LAST!
+ if (!DisablePtrHashing)
+ new CallInst(externalFuncs.ReleaseOnReturnFunc, vector<Value*>(), "",
+ exitBlocks[i]->getTerminator());
}
-
- if (traceMethodExits)
- for (unsigned i=0; i < exitBlocks.size(); ++i)
- {
- TraceValuesAtBBExit(valuesStoredInMethod, exitBlocks[i], module,
- /*indent*/ 0, /*isMethodExit*/ true,
- /*valuesStoredInMethod*/ NULL);
- InsertCodeToShowMethodExit(M, exitBlocks[i], /*indent*/ 0);
- }
-
+
return true;
}
projects / oota-llvm.git / blobdiff