1208599Srdivacky//===-- ModuleDebugInfoPrinter.cpp - Prints module debug info metadata ----===//
2208599Srdivacky//
3208599Srdivacky//                     The LLVM Compiler Infrastructure
4208599Srdivacky//
5208599Srdivacky// This file is distributed under the University of Illinois Open Source
6208599Srdivacky// License. See LICENSE.TXT for details.
7208599Srdivacky//
8208599Srdivacky//===----------------------------------------------------------------------===//
9208599Srdivacky//
10208599Srdivacky// This pass decodes the debug info metadata in a module and prints in a
11208599Srdivacky// (sufficiently-prepared-) human-readable form.
12208599Srdivacky//
13208599Srdivacky// For example, run this pass from opt along with the -analyze option, and
14208599Srdivacky// it'll print to standard output.
15208599Srdivacky//
16208599Srdivacky//===----------------------------------------------------------------------===//
17208599Srdivacky
18208599Srdivacky#include "llvm/Analysis/Passes.h"
19249423Sdim#include "llvm/ADT/Statistic.h"
20208599Srdivacky#include "llvm/Assembly/Writer.h"
21239462Sdim#include "llvm/DebugInfo.h"
22249423Sdim#include "llvm/IR/Function.h"
23208599Srdivacky#include "llvm/Pass.h"
24208599Srdivacky#include "llvm/Support/ErrorHandling.h"
25208599Srdivacky#include "llvm/Support/raw_ostream.h"
26208599Srdivackyusing namespace llvm;
27208599Srdivacky
28208599Srdivackynamespace {
29208599Srdivacky  class ModuleDebugInfoPrinter : public ModulePass {
30208599Srdivacky    DebugInfoFinder Finder;
31208599Srdivacky  public:
32208599Srdivacky    static char ID; // Pass identification, replacement for typeid
33218893Sdim    ModuleDebugInfoPrinter() : ModulePass(ID) {
34218893Sdim      initializeModuleDebugInfoPrinterPass(*PassRegistry::getPassRegistry());
35218893Sdim    }
36208599Srdivacky
37208599Srdivacky    virtual bool runOnModule(Module &M);
38208599Srdivacky
39208599Srdivacky    virtual void getAnalysisUsage(AnalysisUsage &AU) const {
40208599Srdivacky      AU.setPreservesAll();
41208599Srdivacky    }
42208599Srdivacky    virtual void print(raw_ostream &O, const Module *M) const;
43208599Srdivacky  };
44208599Srdivacky}
45208599Srdivacky
46208599Srdivackychar ModuleDebugInfoPrinter::ID = 0;
47212904SdimINITIALIZE_PASS(ModuleDebugInfoPrinter, "module-debuginfo",
48218893Sdim                "Decodes module-level debug info", false, true)
49208599Srdivacky
50208599SrdivackyModulePass *llvm::createModuleDebugInfoPrinterPass() {
51208599Srdivacky  return new ModuleDebugInfoPrinter();
52208599Srdivacky}
53208599Srdivacky
54208599Srdivackybool ModuleDebugInfoPrinter::runOnModule(Module &M) {
55208599Srdivacky  Finder.processModule(M);
56208599Srdivacky  return false;
57208599Srdivacky}
58208599Srdivacky
59208599Srdivackyvoid ModuleDebugInfoPrinter::print(raw_ostream &O, const Module *M) const {
60208599Srdivacky  for (DebugInfoFinder::iterator I = Finder.compile_unit_begin(),
61208599Srdivacky       E = Finder.compile_unit_end(); I != E; ++I) {
62208599Srdivacky    O << "Compile Unit: ";
63208599Srdivacky    DICompileUnit(*I).print(O);
64208599Srdivacky    O << '\n';
65208599Srdivacky  }
66208599Srdivacky
67208599Srdivacky  for (DebugInfoFinder::iterator I = Finder.subprogram_begin(),
68208599Srdivacky       E = Finder.subprogram_end(); I != E; ++I) {
69208599Srdivacky    O << "Subprogram: ";
70208599Srdivacky    DISubprogram(*I).print(O);
71208599Srdivacky    O << '\n';
72208599Srdivacky  }
73208599Srdivacky
74208599Srdivacky  for (DebugInfoFinder::iterator I = Finder.global_variable_begin(),
75208599Srdivacky       E = Finder.global_variable_end(); I != E; ++I) {
76208599Srdivacky    O << "GlobalVariable: ";
77208599Srdivacky    DIGlobalVariable(*I).print(O);
78208599Srdivacky    O << '\n';
79208599Srdivacky  }
80208599Srdivacky
81208599Srdivacky  for (DebugInfoFinder::iterator I = Finder.type_begin(),
82208599Srdivacky       E = Finder.type_end(); I != E; ++I) {
83208599Srdivacky    O << "Type: ";
84208599Srdivacky    DIType(*I).print(O);
85208599Srdivacky    O << '\n';
86208599Srdivacky  }
87208599Srdivacky}
88