1 //===- TraceValues.cpp - Value Tracing for debugging ----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Support for inserting LLVM code to print values at basic block and function
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Transforms/Instrumentation.h"
16 #include "llvm/Constants.h"
17 #include "llvm/DerivedTypes.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/Module.h"
20 #include "llvm/Pass.h"
21 #include "llvm/Assembly/Writer.h"
22 #include "llvm/Support/CommandLine.h"
23 #include "llvm/ADT/StringExtras.h"
29 DisablePtrHashing("tracedisablehashdisable", cl::Hidden,
30 cl::desc("Disable pointer hashing in the -trace or -tracem "
33 static cl::list<std::string>
34 TraceFuncNames("tracefunc", cl::desc("Only trace specific functions in the "
35 "-trace or -tracem passes"),
36 cl::value_desc("function"), cl::Hidden);
38 static void TraceValuesAtBBExit(BasicBlock *BB,
39 Function *Printf, Function* HashPtrToSeqNum,
40 std::vector<Instruction*> *valuesStoredInFunction);
42 // We trace a particular function if no functions to trace were specified
43 // or if the function is in the specified list.
46 TraceThisFunction(Function &F)
48 if (TraceFuncNames.empty()) return true;
50 return std::find(TraceFuncNames.begin(), TraceFuncNames.end(), F.getName())
51 != TraceFuncNames.end();
56 struct ExternalFuncs {
57 Function *PrintfFunc, *HashPtrFunc, *ReleasePtrFunc;
58 Function *RecordPtrFunc, *PushOnEntryFunc, *ReleaseOnReturnFunc;
59 void doInitialization(Module &M); // Add prototypes for external functions
62 class InsertTraceCode : public FunctionPass {
64 ExternalFuncs externalFuncs;
67 // Add a prototype for runtime functions not already in the program.
69 bool doInitialization(Module &M);
71 //--------------------------------------------------------------------------
72 // Function InsertCodeToTraceValues
74 // Inserts tracing code for all live values at basic block and/or function
75 // exits as specified by `traceBasicBlockExits' and `traceFunctionExits'.
77 bool doit(Function *M);
79 virtual void handleBasicBlock(BasicBlock *BB,
80 std::vector<Instruction*> &VI) = 0;
82 // runOnFunction - This method does the work.
84 bool runOnFunction(Function &F);
86 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
91 struct FunctionTracer : public InsertTraceCode {
92 // Ignore basic blocks here...
93 virtual void handleBasicBlock(BasicBlock *BB,
94 std::vector<Instruction*> &VI) {}
97 struct BasicBlockTracer : public InsertTraceCode {
98 // Trace basic blocks here...
99 virtual void handleBasicBlock(BasicBlock *BB,
100 std::vector<Instruction*> &VI) {
101 TraceValuesAtBBExit(BB, externalFuncs.PrintfFunc,
102 externalFuncs.HashPtrFunc, &VI);
106 // Register the passes...
107 RegisterPass<FunctionTracer> X("tracem","Insert Function trace code only");
108 RegisterPass<BasicBlockTracer> Y("trace","Insert BB and Function trace code");
109 } // end anonymous namespace
111 /// Just trace functions
112 FunctionPass *llvm::createTraceValuesPassForFunction() {
113 return new FunctionTracer();
116 /// Trace BB's and functions
117 FunctionPass *llvm::createTraceValuesPassForBasicBlocks() {
118 return new BasicBlockTracer();
121 // Add a prototype for external functions used by the tracing code and require
122 // the trace library for this module.
124 void ExternalFuncs::doInitialization(Module &M) {
125 M.addLibrary("trace");
126 const Type *SBP = PointerType::get(Type::SByteTy);
127 const FunctionType *MTy =
128 FunctionType::get(Type::IntTy, std::vector<const Type*>(1, SBP), true);
129 PrintfFunc = M.getOrInsertFunction("printf", MTy);
132 HashPtrFunc = M.getOrInsertFunction("HashPointerToSeqNum", Type::UIntTy, SBP,
136 ReleasePtrFunc = M.getOrInsertFunction("ReleasePointerSeqNum",
137 Type::VoidTy, SBP, (Type *)0);
138 RecordPtrFunc = M.getOrInsertFunction("RecordPointer",
139 Type::VoidTy, SBP, (Type *)0);
141 PushOnEntryFunc = M.getOrInsertFunction("PushPointerSet", Type::VoidTy,
143 ReleaseOnReturnFunc = M.getOrInsertFunction("ReleasePointersPopSet",
144 Type::VoidTy, (Type *)0);
148 // Add a prototype for external functions used by the tracing code.
150 bool InsertTraceCode::doInitialization(Module &M) {
151 externalFuncs.doInitialization(M);
156 static inline GlobalVariable *getStringRef(Module *M, const std::string &str) {
157 // Create a constant internal string reference...
158 Constant *Init = ConstantArray::get(str);
160 // Create the global variable and record it in the module
161 // The GV will be renamed to a unique name if needed.
162 GlobalVariable *GV = new GlobalVariable(Init->getType(), true,
163 GlobalValue::InternalLinkage, Init,
165 M->getGlobalList().push_back(GV);
171 // Check if this instruction has any uses outside its basic block,
172 // or if it used by either a Call or Return instruction (ditto).
173 // (Values stored to memory within this BB are live at end of BB but are
174 // traced at the store instruction, not where they are computed.)
176 static inline bool LiveAtBBExit(const Instruction* I) {
177 const BasicBlock *BB = I->getParent();
178 for (Value::use_const_iterator U = I->use_begin(); U != I->use_end(); ++U)
179 if (const Instruction *UI = dyn_cast<Instruction>(*U))
180 if (UI->getParent() != BB || isa<ReturnInst>(UI))
187 static inline bool TraceThisOpCode(unsigned opCode) {
188 // Explicitly test for opCodes *not* to trace so that any new opcodes will
189 // be traced by default (VoidTy's are already excluded)
191 return (opCode < Instruction::OtherOpsBegin &&
192 opCode != Instruction::Alloca &&
193 opCode != Instruction::PHI && ! Instruction::isCast(opCode));
197 // Trace a value computed by an instruction if it is non-void, it is computed
198 // by a real computation, not just a copy (see TraceThisOpCode), and
199 // -- it is a load instruction: we want to check values read from memory
200 // -- or it is live at exit from the basic block (i.e., ignore local temps)
202 static bool ShouldTraceValue(const Instruction *I) {
204 I->getType() != Type::VoidTy &&
205 TraceThisOpCode(I->getOpcode()) &&
206 (isa<LoadInst>(I) || LiveAtBBExit(I));
209 static std::string getPrintfCodeFor(const Value *V) {
210 if (V == 0) return "";
211 if (V->getType()->isFloatingPoint())
213 else if (V->getType() == Type::LabelTy)
215 else if (isa<PointerType>(V->getType()))
216 return DisablePtrHashing ? "0x%p" : "%d";
217 else if (V->getType()->isIntegral())
220 assert(0 && "Illegal value to print out...");
225 static void InsertPrintInst(Value *V, BasicBlock *BB, Instruction *InsertBefore,
227 Function *Printf, Function* HashPtrToSeqNum) {
228 // Escape Message by replacing all % characters with %% chars.
230 std::swap(Tmp, Message);
231 std::string::iterator I = std::find(Tmp.begin(), Tmp.end(), '%');
232 while (I != Tmp.end()) {
233 Message.append(Tmp.begin(), I);
235 ++I; // Make sure to erase the % as well...
236 Tmp.erase(Tmp.begin(), I);
237 I = std::find(Tmp.begin(), Tmp.end(), '%');
240 Module *Mod = BB->getParent()->getParent();
242 // Turn the marker string into a global variable...
243 GlobalVariable *fmtVal = getStringRef(Mod, Message+getPrintfCodeFor(V)+"\n");
245 // Turn the format string into an sbyte *
246 Constant *GEP=ConstantExpr::getGetElementPtr(fmtVal,
247 std::vector<Constant*>(2,Constant::getNullValue(Type::LongTy)));
249 // Insert a call to the hash function if this is a pointer value
250 if (V && isa<PointerType>(V->getType()) && !DisablePtrHashing) {
251 const Type *SBP = PointerType::get(Type::SByteTy);
252 if (V->getType() != SBP) // Cast pointer to be sbyte*
253 V = new BitCastInst(V, SBP, "Hash_cast", InsertBefore);
255 std::vector<Value*> HashArgs(1, V);
256 V = new CallInst(HashPtrToSeqNum, HashArgs, "ptrSeqNum", InsertBefore);
259 // Insert the first print instruction to print the string flag:
260 std::vector<Value*> PrintArgs;
261 PrintArgs.push_back(GEP);
262 if (V) PrintArgs.push_back(V);
263 new CallInst(Printf, PrintArgs, "trace", InsertBefore);
267 static void InsertVerbosePrintInst(Value *V, BasicBlock *BB,
268 Instruction *InsertBefore,
269 const std::string &Message, Function *Printf,
270 Function* HashPtrToSeqNum) {
271 std::ostringstream OutStr;
272 if (V) WriteAsOperand(OutStr, V);
273 InsertPrintInst(V, BB, InsertBefore, Message+OutStr.str()+" = ",
274 Printf, HashPtrToSeqNum);
278 InsertReleaseInst(Value *V, BasicBlock *BB,
279 Instruction *InsertBefore,
280 Function* ReleasePtrFunc) {
282 const Type *SBP = PointerType::get(Type::SByteTy);
283 if (V->getType() != SBP) // Cast pointer to be sbyte*
284 V = new BitCastInst(V, SBP, "RPSN_cast", InsertBefore);
286 std::vector<Value*> releaseArgs(1, V);
287 new CallInst(ReleasePtrFunc, releaseArgs, "", InsertBefore);
291 InsertRecordInst(Value *V, BasicBlock *BB,
292 Instruction *InsertBefore,
293 Function* RecordPtrFunc) {
294 const Type *SBP = PointerType::get(Type::SByteTy);
295 if (V->getType() != SBP) // Cast pointer to be sbyte*
296 V = new BitCastInst(V, SBP, "RP_cast", InsertBefore);
298 std::vector<Value*> releaseArgs(1, V);
299 new CallInst(RecordPtrFunc, releaseArgs, "", InsertBefore);
302 // Look for alloca and free instructions. These are the ptrs to release.
303 // Release the free'd pointers immediately. Record the alloca'd pointers
304 // to be released on return from the current function.
307 ReleasePtrSeqNumbers(BasicBlock *BB,
308 ExternalFuncs& externalFuncs) {
310 for (BasicBlock::iterator II=BB->begin(), IE = BB->end(); II != IE; ++II)
311 if (FreeInst *FI = dyn_cast<FreeInst>(II))
312 InsertReleaseInst(FI->getOperand(0), BB, FI,externalFuncs.ReleasePtrFunc);
313 else if (AllocaInst *AI = dyn_cast<AllocaInst>(II))
314 InsertRecordInst(AI, BB, AI->getNext(), externalFuncs.RecordPtrFunc);
318 // Insert print instructions at the end of basic block BB for each value
319 // computed in BB that is live at the end of BB,
320 // or that is stored to memory in BB.
321 // If the value is stored to memory, we load it back before printing it
322 // We also return all such loaded values in the vector valuesStoredInFunction
323 // for printing at the exit from the function. (Note that in each invocation
324 // of the function, this will only get the last value stored for each static
325 // store instruction).
327 static void TraceValuesAtBBExit(BasicBlock *BB,
328 Function *Printf, Function* HashPtrToSeqNum,
329 std::vector<Instruction*> *valuesStoredInFunction) {
330 // Get an iterator to point to the insertion location, which is
331 // just before the terminator instruction.
333 TerminatorInst *InsertPos = BB->getTerminator();
335 std::ostringstream OutStr;
336 WriteAsOperand(OutStr, BB, false);
337 InsertPrintInst(0, BB, InsertPos, "LEAVING BB:" + OutStr.str(),
338 Printf, HashPtrToSeqNum);
340 // Insert a print instruction for each instruction preceding InsertPos.
341 // The print instructions must go before InsertPos, so we use the
342 // instruction *preceding* InsertPos to check when to terminate the loop.
344 for (BasicBlock::iterator II = BB->begin(); &*II != InsertPos; ++II) {
345 if (StoreInst *SI = dyn_cast<StoreInst>(II)) {
346 // Trace the stored value and address
347 InsertVerbosePrintInst(SI->getOperand(0), BB, InsertPos,
348 " (store value) ", Printf, HashPtrToSeqNum);
349 InsertVerbosePrintInst(SI->getOperand(1), BB, InsertPos,
350 " (store addr ) ", Printf, HashPtrToSeqNum);
352 else if (ShouldTraceValue(II))
353 InsertVerbosePrintInst(II, BB, InsertPos, " ", Printf, HashPtrToSeqNum);
357 static inline void InsertCodeToShowFunctionEntry(Function &F, Function *Printf,
358 Function* HashPtrToSeqNum){
359 // Get an iterator to point to the insertion location
360 BasicBlock &BB = F.getEntryBlock();
361 Instruction *InsertPos = BB.begin();
363 std::ostringstream OutStr;
364 WriteAsOperand(OutStr, &F);
365 InsertPrintInst(0, &BB, InsertPos, "ENTERING FUNCTION: " + OutStr.str(),
366 Printf, HashPtrToSeqNum);
368 // Now print all the incoming arguments
370 for (Function::arg_iterator I = F.arg_begin(), E = F.arg_end(); I != E; ++I, ++ArgNo){
371 InsertVerbosePrintInst(I, &BB, InsertPos,
372 " Arg #" + utostr(ArgNo) + ": ", Printf,
378 static inline void InsertCodeToShowFunctionExit(BasicBlock *BB,
380 Function* HashPtrToSeqNum) {
381 // Get an iterator to point to the insertion location
382 ReturnInst *Ret = cast<ReturnInst>(BB->getTerminator());
384 std::ostringstream OutStr;
385 WriteAsOperand(OutStr, BB->getParent(), true);
386 InsertPrintInst(0, BB, Ret, "LEAVING FUNCTION: " + OutStr.str(),
387 Printf, HashPtrToSeqNum);
389 // print the return value, if any
390 if (BB->getParent()->getReturnType() != Type::VoidTy)
391 InsertPrintInst(Ret->getReturnValue(), BB, Ret, " Returning: ",
392 Printf, HashPtrToSeqNum);
396 bool InsertTraceCode::runOnFunction(Function &F) {
397 if (!TraceThisFunction(F))
400 std::vector<Instruction*> valuesStoredInFunction;
401 std::vector<BasicBlock*> exitBlocks;
403 // Insert code to trace values at function entry
404 InsertCodeToShowFunctionEntry(F, externalFuncs.PrintfFunc,
405 externalFuncs.HashPtrFunc);
407 // Push a pointer set for recording alloca'd pointers at entry.
408 if (!DisablePtrHashing)
409 new CallInst(externalFuncs.PushOnEntryFunc, std::vector<Value*>(), "",
410 F.getEntryBlock().begin());
412 for (Function::iterator BB = F.begin(); BB != F.end(); ++BB) {
413 if (isa<ReturnInst>(BB->getTerminator()))
414 exitBlocks.push_back(BB); // record this as an exit block
416 // Insert trace code if this basic block is interesting...
417 handleBasicBlock(BB, valuesStoredInFunction);
419 if (!DisablePtrHashing) // release seq. numbers on free/ret
420 ReleasePtrSeqNumbers(BB, externalFuncs);
423 for (unsigned i=0; i != exitBlocks.size(); ++i)
425 // Insert code to trace values at function exit
426 InsertCodeToShowFunctionExit(exitBlocks[i], externalFuncs.PrintfFunc,
427 externalFuncs.HashPtrFunc);
429 // Release all recorded pointers before RETURN. Do this LAST!
430 if (!DisablePtrHashing)
431 new CallInst(externalFuncs.ReleaseOnReturnFunc, std::vector<Value*>(),
432 "", exitBlocks[i]->getTerminator());