lib/Analysis/DbgInfoPrinter.cpp

   1 //===- DbgInfoPrinter.cpp - Print debug info in a human readable form ------==//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements a pass that prints instructions, and associated debug
  11 // info:
  12 //
  13 //   - source/line/col information
  14 //   - original variable name
  15 //   - original type name
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm/Pass.h"
  20 #include "llvm/Function.h"
  21 #include "llvm/IntrinsicInst.h"
  22 #include "llvm/Metadata.h"
  23 #include "llvm/Assembly/Writer.h"
  24 #include "llvm/Analysis/DebugInfo.h"
  25 #include "llvm/Analysis/Passes.h"
  26 #include "llvm/Support/CFG.h"
  27 #include "llvm/Support/CommandLine.h"
  28 #include "llvm/Support/raw_ostream.h"
  29
  30 using namespace llvm;
  31
  32 static cl::opt<bool>
  33 PrintDirectory("print-fullpath",
  34                cl::desc("Print fullpath when printing debug info"),
  35                cl::Hidden);
  36
  37 namespace {
  38   class PrintDbgInfo : public FunctionPass {
  39     raw_ostream &Out;
  40     void printStopPoint(const DbgStopPointInst *DSI);
  41     void printFuncStart(const DbgFuncStartInst *FS);
  42     void printVariableDeclaration(const Value *V);
  43   public:
  44     static char ID; // Pass identification
  45     PrintDbgInfo() : FunctionPass(&ID), Out(outs()) {}
  46
  47     virtual bool runOnFunction(Function &F);
  48     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  49       AU.setPreservesAll();
  50     }
  51   };
  52   char PrintDbgInfo::ID = 0;
  53   static RegisterPass<PrintDbgInfo> X("print-dbginfo",
  54                                      "Print debug info in human readable form");
  55 }
  56
  57 FunctionPass *llvm::createDbgInfoPrinterPass() { return new PrintDbgInfo(); }
  58
  59 void PrintDbgInfo::printVariableDeclaration(const Value *V) {
  60   std::string DisplayName, File, Directory, Type;
  61   unsigned LineNo;
  62
  63   if (!getLocationInfo(V, DisplayName, Type, LineNo, File, Directory))
  64     return;
  65
  66   Out << "; ";
  67   WriteAsOperand(Out, V, false, 0);
  68   Out << " is variable " << DisplayName
  69       << " of type " << Type << " declared at ";
  70
  71   if (PrintDirectory)
  72     Out << Directory << "/";
  73
  74   Out << File << ":" << LineNo << "\n";
  75 }
  76
  77 void PrintDbgInfo::printStopPoint(const DbgStopPointInst *DSI) {
  78   if (PrintDirectory)
  79     if (MDString *Str = dyn_cast<MDString>(DSI->getDirectory()))
  80       Out << Str->getString() << '/';
  81
  82   if (MDString *Str = dyn_cast<MDString>(DSI->getFileName()))
  83     Out << Str->getString();
  84   Out << ':' << DSI->getLine();
  85
  86   if (unsigned Col = DSI->getColumn())
  87     Out << ':' << Col;
  88 }
  89
  90 void PrintDbgInfo::printFuncStart(const DbgFuncStartInst *FS) {
  91   DISubprogram Subprogram(FS->getSubprogram());
  92   Out << "; fully qualified function name: " << Subprogram.getDisplayName()
  93       << " return type: " << Subprogram.getReturnTypeName()
  94       << " at line " << Subprogram.getLineNumber()
  95       << "\n\n";
  96 }
  97
  98 bool PrintDbgInfo::runOnFunction(Function &F) {
  99   if (F.isDeclaration())
 100     return false;
 101
 102   Out << "function " << F.getName() << "\n\n";
 103
 104   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
 105     BasicBlock *BB = I;
 106
 107     if (I != F.begin() && (pred_begin(BB) == pred_end(BB)))
 108       // Skip dead blocks.
 109       continue;
 110
 111     const DbgStopPointInst *DSI = findBBStopPoint(BB);
 112     Out << BB->getName();
 113     Out << ":";
 114
 115     if (DSI) {
 116       Out << "; (";
 117       printStopPoint(DSI);
 118       Out << ")";
 119     }
 120
 121     Out << "\n";
 122
 123     // A dbgstoppoint's information is valid until we encounter a new one.
 124     const DbgStopPointInst *LastDSP = DSI;
 125     bool Printed = DSI != 0;
 126     for (BasicBlock::const_iterator i = BB->begin(), e = BB->end();
 127          i != e; ++i) {
 128       if (isa<DbgInfoIntrinsic>(i)) {
 129         if ((DSI = dyn_cast<DbgStopPointInst>(i))) {
 130           if (DSI->getContext() == LastDSP->getContext() &&
 131               DSI->getLineValue() == LastDSP->getLineValue() &&
 132               DSI->getColumnValue() == LastDSP->getColumnValue())
 133             // Don't print same location twice.
 134             continue;
 135
 136           LastDSP = cast<DbgStopPointInst>(i);
 137
 138           // Don't print consecutive stoppoints, use a flag to know which one we
 139           // printed.
 140           Printed = false;
 141         } else if (const DbgFuncStartInst *FS = dyn_cast<DbgFuncStartInst>(i)) {
 142           printFuncStart(FS);
 143         }
 144       } else {
 145         if (!Printed && LastDSP) {
 146           Out << "; ";
 147           printStopPoint(LastDSP);
 148           Out << "\n";
 149           Printed = true;
 150         }
 151
 152         Out << *i << '\n';
 153         printVariableDeclaration(i);
 154
 155         if (const User *U = dyn_cast<User>(i)) {
 156           for(unsigned i=0;i<U->getNumOperands();i++)
 157             printVariableDeclaration(U->getOperand(i));
 158         }
 159       }
 160     }
 161   }
 162
 163   return false;
 164 }