lib/IR/PrintModulePass.cpp

   1 //===--- IR/PrintModulePass.cpp - Module/Function Printer -----------------===//
   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 // PrintModulePass and PrintFunctionPass implementations.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Assembly/PrintModulePass.h"
  15 #include "llvm/IR/Function.h"
  16 #include "llvm/IR/Module.h"
  17 #include "llvm/Pass.h"
  18 #include "llvm/Support/Debug.h"
  19 #include "llvm/Support/raw_ostream.h"
  20 using namespace llvm;
  21
  22 namespace {
  23
  24   class PrintModulePass : public ModulePass {
  25     std::string Banner;
  26     raw_ostream *Out;       // raw_ostream to print on
  27     bool DeleteStream;      // Delete the ostream in our dtor?
  28   public:
  29     static char ID;
  30     PrintModulePass() : ModulePass(ID), Out(&dbgs()),
  31       DeleteStream(false) {}
  32     PrintModulePass(const std::string &B, raw_ostream *o, bool DS)
  33         : ModulePass(ID), Banner(B), Out(o), DeleteStream(DS) {}
  34
  35     ~PrintModulePass() {
  36       if (DeleteStream) delete Out;
  37     }
  38
  39     bool runOnModule(Module &M) {
  40       (*Out) << Banner << M;
  41       return false;
  42     }
  43
  44     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  45       AU.setPreservesAll();
  46     }
  47   };
  48
  49   class PrintFunctionPass : public FunctionPass {
  50     std::string Banner;     // String to print before each function
  51     raw_ostream *Out;       // raw_ostream to print on
  52     bool DeleteStream;      // Delete the ostream in our dtor?
  53   public:
  54     static char ID;
  55     PrintFunctionPass() : FunctionPass(ID), Banner(""), Out(&dbgs()),
  56                           DeleteStream(false) {}
  57     PrintFunctionPass(const std::string &B, raw_ostream *o, bool DS)
  58       : FunctionPass(ID), Banner(B), Out(o), DeleteStream(DS) {}
  59
  60     ~PrintFunctionPass() {
  61       if (DeleteStream) delete Out;
  62     }
  63
  64     // runOnFunction - This pass just prints a banner followed by the
  65     // function as it's processed.
  66     //
  67     bool runOnFunction(Function &F) {
  68       (*Out) << Banner << static_cast<Value&>(F);
  69       return false;
  70     }
  71
  72     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  73       AU.setPreservesAll();
  74     }
  75   };
  76 }
  77
  78 char PrintModulePass::ID = 0;
  79 INITIALIZE_PASS(PrintModulePass, "print-module",
  80                 "Print module to stderr", false, false)
  81 char PrintFunctionPass::ID = 0;
  82 INITIALIZE_PASS(PrintFunctionPass, "print-function",
  83                 "Print function to stderr", false, false)
  84
  85 /// createPrintModulePass - Create and return a pass that writes the
  86 /// module to the specified raw_ostream.
  87 ModulePass *llvm::createPrintModulePass(llvm::raw_ostream *OS,
  88                                         bool DeleteStream,
  89                                         const std::string &Banner) {
  90   return new PrintModulePass(Banner, OS, DeleteStream);
  91 }
  92
  93 /// createPrintFunctionPass - Create and return a pass that prints
  94 /// functions to the specified raw_ostream as they are processed.
  95 FunctionPass *llvm::createPrintFunctionPass(const std::string &Banner,
  96                                             llvm::raw_ostream *OS,
  97                                             bool DeleteStream) {
  98   return new PrintFunctionPass(Banner, OS, DeleteStream);
  99 }
 100