-// $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
-//**************************************************************************/
-
-
-#include "llvm/Transforms/Instrumentation/TraceValues.h"
-#include "llvm/GlobalVariable.h"
-#include "llvm/ConstantVals.h"
-#include "llvm/Type.h"
+//===- 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/Instruction.h"
-#include "llvm/iMemory.h"
-#include "llvm/iTerminators.h"
-#include "llvm/iOther.h"
-#include "llvm/BasicBlock.h"
-#include "llvm/Method.h"
+#include "llvm/Instructions.h"
#include "llvm/Module.h"
-#include "llvm/SymbolTable.h"
+#include "llvm/Pass.h"
#include "llvm/Assembly/Writer.h"
-#include "Support/StringExtras.h"
-#include "Support/HashExtras.h"
-#include <hash_set>
+#include "llvm/Support/CommandLine.h"
+#include "llvm/ADT/StringExtras.h"
+#include <algorithm>
#include <sstream>
+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<std::string>
+TraceFuncNames("tracefunc", cl::desc("Only trace specific functions in the "
+ "-trace or -tracem passes"),
+ cl::value_desc("function"), cl::Hidden);
+
+static void TraceValuesAtBBExit(BasicBlock *BB,
+ Function *Printf, Function* HashPtrToSeqNum,
+ 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)
+{
+ if (TraceFuncNames.empty()) return true;
+ return std::find(TraceFuncNames.begin(), TraceFuncNames.end(), F.getName())
+ != TraceFuncNames.end();
+}
-static const char*
-PrintMethodNameForType(const Type* type)
-{
- if (PointerType* pty = dyn_cast<PointerType>(type))
- {
- const Type* elemTy;
- if (ArrayType* aty = dyn_cast<ArrayType>(pty->getValueType()))
- elemTy = aty->getElementType();
- else
- elemTy = pty->getValueType();
- if (elemTy == Type::SByteTy || elemTy == Type::UByteTy)
- return "printString";
- }
- switch (type->getPrimitiveID())
- {
- case Type::BoolTyID: return "printBool";
- case Type::UByteTyID: return "printUByte";
- case Type::SByteTyID: return "printSByte";
- case Type::UShortTyID: return "printUShort";
- case Type::ShortTyID: return "printShort";
- case Type::UIntTyID: return "printUInt";
- case Type::IntTyID: return "printInt";
- case Type::ULongTyID: return "printULong";
- case Type::LongTyID: return "printLong";
- case Type::FloatTyID: return "printFloat";
- case Type::DoubleTyID: return "printDouble";
- case Type::PointerTyID: return "printPointer";
- default:
- assert(0 && "Unsupported type for printing");
- return NULL;
+namespace {
+ struct ExternalFuncs {
+ Function *PrintfFunc, *HashPtrFunc, *ReleasePtrFunc;
+ 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,
+ std::vector<Instruction*> &VI) = 0;
+
+ // runOnFunction - This method does the work.
+ //
+ bool runOnFunction(Function &F);
+
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesCFG();
+ }
+ };
+
+ struct FunctionTracer : public InsertTraceCode {
+ // Ignore basic blocks here...
+ virtual void handleBasicBlock(BasicBlock *BB,
+ std::vector<Instruction*> &VI) {}
+ };
+
+ struct BasicBlockTracer : public InsertTraceCode {
+ // Trace basic blocks here...
+ virtual void handleBasicBlock(BasicBlock *BB,
+ std::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
+
+/// Just trace functions
+FunctionPass *llvm::createTraceValuesPassForFunction() {
+ return new FunctionTracer();
+}
+
+/// Trace BB's and functions
+FunctionPass *llvm::createTraceValuesPassForBasicBlocks() {
+ return new BasicBlockTracer();
+}
+
+// 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, std::vector<const Type*>(1, SBP), true);
+ PrintfFunc = M.getOrInsertFunction("printf", MTy);
+
+ // uint (sbyte*)
+ HashPtrFunc = M.getOrInsertFunction("HashPointerToSeqNum", Type::UIntTy, SBP,
+ 0);
+
+ // void (sbyte*)
+ 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",
+ Type::VoidTy, 0);
+}
+
+
+// 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) {
- ConstantArray *Init = ConstantArray::get(str);
- GlobalVariable *GV = new GlobalVariable(Init->getType(), /*Const*/true,
- /*intern*/true, Init);
+
+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,
+ GlobalValue::InternalLinkage, Init,
+ "trstr");
M->getGlobalList().push_back(GV);
return GV;
}
-static inline bool
-TraceThisOpCode(unsigned opCode)
-{
+//
+// Check if this instruction has any uses outside its basic block,
+// 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)
+ 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)
- //
- return (opCode < Instruction::FirstOtherOp &&
+ //
+ return (opCode < Instruction::OtherOpsBegin &&
opCode != Instruction::Alloca &&
- opCode != Instruction::PHINode &&
+ opCode != Instruction::PHI &&
opCode != Instruction::Cast);
}
-//
-// 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(Instruction* I)
-{
- 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
- || userI->getOpcode() == Instruction::Call
- || userI->getOpcode() == Instruction::Ret)
- isLive = true;
- }
- return isLive;
-}
-
-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);
- }
+// 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 &&
+ TraceThisOpCode(I->getOpcode()) &&
+ (isa<LoadInst>(I) || LiveAtBBExit(I));
}
-//
-// 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);
-
- return printMethod;
+static std::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 "";
}
-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 = cast<Method>(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());
-
- 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\n";
- break;
-
- case Type::FloatTyID: case Type::DoubleTyID:
- fmtString << " %g\n";
- break;
-
- case Type::PointerTyID:
- fmtString << " %p\n";
- break;
-
- default:
- assert(0 && "Should not get here. Check the IF expression above");
- return NULL;
- }
-
- fmtString << ends;
- GlobalVariable* fmtVal = GetStringRef(module, fmtString.str());
-
- paramList.push_back(fmtVal);
- paramList.push_back(scopeNameVal);
- paramList.push_back(valNameVal);
- paramList.push_back(typeNameVal);
- paramList.push_back(val);
-
- return new CallInst(printMethod, paramList);
-}
+static void InsertPrintInst(Value *V, BasicBlock *BB, Instruction *InsertBefore,
+ std::string Message,
+ Function *Printf, Function* HashPtrToSeqNum) {
+ // Escape Message by replacing all % characters with %% chars.
+ std::string Tmp;
+ std::swap(Tmp, Message);
+ std::string::iterator I = std::find(Tmp.begin(), Tmp.end(), '%');
+ while (I != Tmp.end()) {
+ Message.append(Tmp.begin(), I);
+ Message += "%%";
+ ++I; // Make sure to erase the % as well...
+ Tmp.erase(Tmp.begin(), I);
+ I = std::find(Tmp.begin(), Tmp.end(), '%');
+ }
+ Message += Tmp;
+ 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 *
+ Constant *GEP=ConstantExpr::getGetElementPtr(fmtVal,
+ std::vector<Constant*>(2,Constant::getNullValue(Type::LongTy)));
-// The invocation should be:
-// call "printString"([ubyte*] or [sbyte*] or ubyte* or sbyte*).
-// call "printLong"(long)
-// call "printInt"(int) ...
-//
-static Value *GetPrintMethodForType(Module *Mod, const Type *VTy) {
- MethodType *MTy = MethodType::get(Type::VoidTy, vector<const Type*>(1, VTy),
- /*isVarArg*/ false);
-
- const char* printMethodName = PrintMethodNameForType(VTy);
- SymbolTable *ST = Mod->getSymbolTableSure();
- if (Value *V = ST->lookup(PointerType::get(MTy), printMethodName))
- return V;
-
- // Create a new method and add it to the module
- Method *M = new Method(MTy, printMethodName);
- Mod->getMethodList().push_back(M);
- return M;
+ // 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);
+
+ std::vector<Value*> HashArgs(1, V);
+ V = new CallInst(HashPtrToSeqNum, HashArgs, "ptrSeqNum", InsertBefore);
+ }
+
+ // Insert the first print instruction to print the string flag:
+ 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 std::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
-InsertPrintInsts(Value *Val,
- BasicBlock* BB,
- BasicBlock::iterator &BBI,
- Module *Mod,
- unsigned int indent,
- bool isMethodExit,
- bool isMethodEntry = false)
-{
- const Type* ValTy = Val->getType();
-
- assert((ValTy->isPrimitiveType() || isa<PointerType>(ValTy)) &&
- ValTy != Type::VoidTy && ValTy != Type::TypeTy &&
- ValTy != Type::LabelTy && "Unsupported type for printing");
-
- const Value* scopeToUse =
- (isMethodExit || isMethodEntry)? (const Value*)BB->getParent() : (const Value*)BB;
-
- // Create the marker string...
- ostringstream scopeNameString;
- if (isMethodExit || isMethodEntry)
- scopeNameString << " METHOD ";
- else
- scopeNameString << " BASIC BLOCK ";
-
- scopeNameString << ((scopeToUse->hasName())
- ? scopeToUse->getName().c_str()
- : itostr((int) scopeToUse).c_str())
- << " : ";
-
- WriteAsOperand(scopeNameString, Val) << " = ";
-
- string fmtString(indent, ' ');
- if (isMethodEntry)
- fmtString += string(" AT ENTRY OF") + scopeNameString.str();
- else
- fmtString += string(" AT EXIT OF") + scopeNameString.str();
-
- // Turn the marker string into a global variable...
- GlobalVariable *fmtVal = GetStringRef(Mod, fmtString);
-
- // 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;
+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);
+
+ std::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);
+
+ std::vector<Value*> releaseArgs(1, V);
+ new CallInst(RecordPtrFunc, releaseArgs, "", InsertBefore);
+}
-static LoadInst*
-InsertLoadInst(StoreInst *SI,
- BasicBlock *bb,
- BasicBlock::iterator &BBI)
-{
- LoadInst* loadInst = new LoadInst(SI->getPointerOperand(), SI->copyIndices());
- BBI = bb->getInstList().insert(BBI, loadInst) + 1;
- return loadInst;
+// 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 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
+// 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)
-{
+//
+static void TraceValuesAtBBExit(BasicBlock *BB,
+ Function *Printf, Function* HashPtrToSeqNum,
+ std::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());
-
- // 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.
- //
- hash_set<Instruction*> laterInstrSet;
- if (BranchInst* brInst = dyn_cast<BranchInst>(*here))
- if (! brInst->isUnconditional())
- if (Instruction* setCC = dyn_cast<Instruction>(brInst->getCondition()))
- if (setCC->getParent() == bb)
- {
- while ((*here) != setCC && here != instList.begin())
- {
- --here;
- laterInstrSet.insert(*here);
- }
- assert((*here) == setCC && "Missed the setCC instruction?");
- laterInstrSet.insert(*here);
- }
-
- // Insert a print instruction for each value.
- //
- 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);
- }
- if (laterInstrSet.find(I) == laterInstrSet.end())
- InsertPrintInsts(I, bb, here, module, indent, isMethodExit);
+ //
+ TerminatorInst *InsertPos = BB->getTerminator();
+
+ 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 (BasicBlock::iterator II = BB->begin(); &*II != InsertPos; ++II) {
+ if (StoreInst *SI = dyn_cast<StoreInst>(II)) {
+ // 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);
}
+ 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.getEntryBlock();
+ Instruction *InsertPos = BB.begin();
+ std::ostringstream OutStr;
+ WriteAsOperand(OutStr, &F);
+ InsertPrintInst(0, &BB, InsertPos, "ENTERING FUNCTION: " + OutStr.str(),
+ Printf, HashPtrToSeqNum);
-static Instruction*
-CreateMethodTraceInst(Method* method,
- unsigned int indent,
- const string& msg)
-{
- string fmtString(indent, ' ');
- // ostringstream methodNameString;
- // WriteAsOperand(methodNameString, method);
- // fmtString += msg + methodNameString.str() + '\n';
- if (method->hasName())
- fmtString += msg + method->getName().c_str() + '\n';
- else
- fmtString += msg + itostr((int) method) + '\n';
-
- GlobalVariable *fmtVal = GetStringRef(method->getParent(), fmtString);
- Instruction *printInst =
- new CallInst(GetPrintMethodForType(method->getParent(), fmtVal->getType()),
- vector<Value*>(1, fmtVal));
-
- return printInst;
+ // Now print all the incoming arguments
+ unsigned ArgNo = 0;
+ 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);
+ }
}
-static inline void
-InsertCodeToShowMethodEntry(Method* method,
- BasicBlock* entryBB,
- 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 = entryBB->getInstList();
- BasicBlock::iterator here = instList.begin();
-
- Instruction *printInst = CreateMethodTraceInst(method, indent,
- "ENTERING METHOD ");
- here = entryBB->getInstList().insert(here, printInst) + 1;
-
- // Now print all the incoming arguments
- const Method::ArgumentListType& argList = method->getArgumentList();
- for (Method::ArgumentListType::const_iterator
- I=argList.begin(), E=argList.end(); I != E; ++I)
- {
- InsertPrintInsts((*I), entryBB, here, method->getParent(),
- indent, /*isMethodExit*/false, /*isMethodEntry*/true);
- }
-}
+ ReturnInst *Ret = cast<ReturnInst>(BB->getTerminator());
+ std::ostringstream OutStr;
+ WriteAsOperand(OutStr, BB->getParent(), true);
+ InsertPrintInst(0, BB, Ret, "LEAVING FUNCTION: " + OutStr.str(),
+ Printf, HashPtrToSeqNum);
-static inline void
-InsertCodeToShowMethodExit(Method* method,
- BasicBlock* exitBB,
- unsigned int indent)
-{
- // Get an iterator to point to the insertion location
- BasicBlock::InstListType& instList = exitBB->getInstList();
- BasicBlock::iterator here = instList.end()-1;
- assert((*here)->isTerminator());
- assert(isa<ReturnInst>(*here));
-
- Instruction *printInst = CreateMethodTraceInst(method, indent,
- "LEAVING METHOD ");
- here = exitBB->getInstList().insert(here, printInst) + 1;
-
// print the return value, if any
- if (method->getReturnType() != Type::VoidTy)
- InsertPrintInsts(cast<ReturnInst>(exitBB->getTerminator())->getReturnValue(),
- exitBB, here, method->getParent(),
- indent, /*isMethodExit*/true, /*isMethodEntry*/false);
+ 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;
+ std::vector<Instruction*> valuesStoredInFunction;
+ std::vector<BasicBlock*> exitBlocks;
-bool
-InsertTraceCode::doInsertTraceCode(Method *M,
- bool traceBasicBlockExits,
- bool traceMethodExits)
-{
- vector<Instruction*> valuesStoredInMethod;
- Module* module = M->getParent();
- vector<BasicBlock*> exitBlocks;
+ // Insert code to trace values at function entry
+ InsertCodeToShowFunctionEntry(F, externalFuncs.PrintfFunc,
+ externalFuncs.HashPtrFunc);
- if (M->isExternal() ||
- (! traceBasicBlockExits && ! traceMethodExits))
- return false;
-
- if (traceMethodExits)
- InsertCodeToShowMethodEntry(M, M->getEntryNode(), /*indent*/ 0);
-
- for (Method::iterator BI = M->begin(); BI != M->end(); ++BI)
+ // Push a pointer set for recording alloca'd pointers at entry.
+ if (!DisablePtrHashing)
+ 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()))
+ exitBlocks.push_back(BB); // record this as an exit block
+
+ // 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)
{
- 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;
- }
-
- if (traceBasicBlockExits)
- TraceValuesAtBBExit(valuesToTraceInBB, bb, module,
- /*indent*/ 4, /*isMethodExit*/ false,
- &valuesStoredInMethod);
+ // 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, std::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;
}