include/llvm/IR/IRPrintingPasses.h

   1 //===- IRPrintingPasses.h - Passes to print out IR constructs ---*- C++ -*-===//
   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 /// \file
  10 ///
  11 /// This file defines passes to print out IR in various granularities. The
  12 /// PrintModulePass pass simply prints out the entire module when it is
  13 /// executed. The PrintFunctionPass class is designed to be pipelined with
  14 /// other FunctionPass's, and prints out the functions of the module as they
  15 /// are processed.
  16 ///
  17 //===----------------------------------------------------------------------===//
  18
  19 #ifndef LLVM_IR_IRPRINTINGPASSES_H
  20 #define LLVM_IR_IRPRINTINGPASSES_H
  21
  22 #include "llvm/ADT/StringRef.h"
  23 #include <string>
  24
  25 namespace llvm {
  26 class BasicBlockPass;
  27 class Function;
  28 class FunctionPass;
  29 class Module;
  30 class ModulePass;
  31 class PreservedAnalyses;
  32 class raw_ostream;
  33
  34 /// \brief Create and return a pass that writes the module to the specified
  35 /// \c raw_ostream.
  36 ModulePass *createPrintModulePass(raw_ostream &OS,
  37                                   const std::string &Banner = "",
  38                                   bool ShouldPreserveUseListOrder = false);
  39
  40 /// \brief Create and return a pass that prints functions to the specified
  41 /// \c raw_ostream as they are processed.
  42 FunctionPass *createPrintFunctionPass(raw_ostream &OS,
  43                                       const std::string &Banner = "");
  44
  45 /// \brief Create and return a pass that writes the BB to the specified
  46 /// \c raw_ostream.
  47 BasicBlockPass *createPrintBasicBlockPass(raw_ostream &OS,
  48                                           const std::string &Banner = "");
  49
  50 /// Print out a name of an LLVM value without any prefixes.
  51 ///
  52 /// The name is surrounded with ""'s and escaped if it has any special or
  53 /// non-printable characters in it.
  54 void printLLVMNameWithoutPrefix(raw_ostream &OS, StringRef Name);
  55
  56 /// \brief Pass for printing a Module as LLVM's text IR assembly.
  57 ///
  58 /// Note: This pass is for use with the new pass manager. Use the create...Pass
  59 /// functions above to create passes for use with the legacy pass manager.
  60 class PrintModulePass {
  61   raw_ostream &OS;
  62   std::string Banner;
  63   bool ShouldPreserveUseListOrder;
  64
  65 public:
  66   PrintModulePass();
  67   PrintModulePass(raw_ostream &OS, const std::string &Banner = "",
  68                   bool ShouldPreserveUseListOrder = false);
  69
  70   PreservedAnalyses run(Module &M);
  71
  72   static StringRef name() { return "PrintModulePass"; }
  73 };
  74
  75 /// \brief Pass for printing a Function as LLVM's text IR assembly.
  76 ///
  77 /// Note: This pass is for use with the new pass manager. Use the create...Pass
  78 /// functions above to create passes for use with the legacy pass manager.
  79 class PrintFunctionPass {
  80   raw_ostream &OS;
  81   std::string Banner;
  82
  83 public:
  84   PrintFunctionPass();
  85   PrintFunctionPass(raw_ostream &OS, const std::string &Banner = "");
  86
  87   PreservedAnalyses run(Function &F);
  88
  89   static StringRef name() { return "PrintFunctionPass"; }
  90 };
  91
  92 } // End llvm namespace
  93
  94 #endif