1 //===- DbgInfoPrinter.cpp - Print debug info in a human readable form ------==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a pass that prints instructions, and associated debug
13 // - source/line/col information
14 // - original variable name
15 // - original type name
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Pass.h"
20 #include "llvm/Function.h"
21 #include "llvm/IntrinsicInst.h"
22 #include "llvm/Assembly/Writer.h"
23 #include "llvm/Analysis/DebugInfo.h"
24 #include "llvm/Analysis/Passes.h"
25 #include "llvm/Support/CFG.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/raw_ostream.h"
32 PrintDirectory("print-fullpath",
33 cl::desc("Print fullpath when printing debug info"),
37 class PrintDbgInfo : public FunctionPass {
39 void printStopPoint(const DbgStopPointInst *DSI);
40 void printFuncStart(const DbgFuncStartInst *FS);
41 void printVariableDeclaration(const Value *V);
43 static char ID; // Pass identification
44 PrintDbgInfo() : FunctionPass(&ID), Out(outs()) {}
46 virtual bool runOnFunction(Function &F);
47 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
51 char PrintDbgInfo::ID = 0;
52 static RegisterPass<PrintDbgInfo> X("print-dbginfo",
53 "Print debug info in human readable form");
56 FunctionPass *llvm::createDbgInfoPrinterPass() { return new PrintDbgInfo(); }
58 void PrintDbgInfo::printVariableDeclaration(const Value *V) {
59 std::string DisplayName, File, Directory, Type;
62 if (!getLocationInfo(V, DisplayName, Type, LineNo, File, Directory))
66 WriteAsOperand(Out, V, false, 0);
67 Out << " is variable " << DisplayName
68 << " of type " << Type << " declared at ";
71 Out << Directory << "/";
73 Out << File << ":" << LineNo << "\n";
76 void PrintDbgInfo::printStopPoint(const DbgStopPointInst *DSI) {
78 if (MDString *Str = dyn_cast<MDString>(DSI->getDirectory()))
79 Out << Str->getString() << '/';
81 if (MDString *Str = dyn_cast<MDString>(DSI->getFileName()))
82 Out << Str->getString();
83 Out << ':' << DSI->getLine();
85 if (unsigned Col = DSI->getColumn())
89 void PrintDbgInfo::printFuncStart(const DbgFuncStartInst *FS) {
90 DISubprogram Subprogram(FS->getSubprogram());
91 Out << "; fully qualified function name: " << Subprogram.getDisplayName()
92 << " return type: " << Subprogram.getReturnTypeName()
93 << " at line " << Subprogram.getLineNumber()
97 bool PrintDbgInfo::runOnFunction(Function &F) {
98 if (F.isDeclaration())
101 Out << "function " << F.getName() << "\n\n";
103 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
106 if (I != F.begin() && (pred_begin(BB) == pred_end(BB)))
110 const DbgStopPointInst *DSI = findBBStopPoint(BB);
111 Out << BB->getName();
122 // A dbgstoppoint's information is valid until we encounter a new one.
123 const DbgStopPointInst *LastDSP = DSI;
124 bool Printed = DSI != 0;
125 for (BasicBlock::const_iterator i = BB->begin(), e = BB->end();
127 if (isa<DbgInfoIntrinsic>(i)) {
128 if ((DSI = dyn_cast<DbgStopPointInst>(i))) {
129 if (DSI->getContext() == LastDSP->getContext() &&
130 DSI->getLineValue() == LastDSP->getLineValue() &&
131 DSI->getColumnValue() == LastDSP->getColumnValue())
132 // Don't print same location twice.
135 LastDSP = cast<DbgStopPointInst>(i);
137 // Don't print consecutive stoppoints, use a flag to know which one we
140 } else if (const DbgFuncStartInst *FS = dyn_cast<DbgFuncStartInst>(i)) {
144 if (!Printed && LastDSP) {
146 printStopPoint(LastDSP);
152 printVariableDeclaration(i);
154 if (const User *U = dyn_cast<User>(i)) {
155 for(unsigned i=0;i<U->getNumOperands();i++)
156 printVariableDeclaration(U->getOperand(i));