lib/CodeGen/MachineFunctionPrinterPass.cpp

   1 //===-- MachineFunctionPrinterPass.cpp ------------------------------------===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // MachineFunctionPrinterPass implementation.
  10 //
  11 //===----------------------------------------------------------------------===//
  12
  13 #include "llvm/CodeGen/MachineFunction.h"
  14 #include "llvm/CodeGen/MachineFunctionPass.h"
  15 #include "llvm/CodeGen/Passes.h"
  16 #include "llvm/CodeGen/SlotIndexes.h"
  17 #include "llvm/IR/IRPrintingPasses.h"
  18 #include "llvm/Support/Debug.h"
  19 #include "llvm/Support/raw_ostream.h"
  20
  21 using namespace llvm;
  22
  23 namespace {
  24 /// MachineFunctionPrinterPass - This is a pass to dump the IR of a
  25 /// MachineFunction.
  26 ///
  27 struct MachineFunctionPrinterPass : public MachineFunctionPass {
  28   static char ID;
  29
  30   raw_ostream &OS;
  31   const std::string Banner;
  32
  33   MachineFunctionPrinterPass() : MachineFunctionPass(ID), OS(dbgs()) { }
  34   MachineFunctionPrinterPass(raw_ostream &os, const std::string &banner)
  35       : MachineFunctionPass(ID), OS(os), Banner(banner) {}
  36
  37   StringRef getPassName() const override { return "MachineFunction Printer"; }
  38
  39   void getAnalysisUsage(AnalysisUsage &AU) const override {
  40     AU.setPreservesAll();
  41     AU.addUsedIfAvailable<SlotIndexes>();
  42     MachineFunctionPass::getAnalysisUsage(AU);
  43   }
  44
  45   bool runOnMachineFunction(MachineFunction &MF) override {
  46     if (!llvm::isFunctionInPrintList(MF.getName()))
  47       return false;
  48     OS << "# " << Banner << ":\n";
  49     MF.print(OS, getAnalysisIfAvailable<SlotIndexes>());
  50     return false;
  51   }
  52 };
  53
  54 char MachineFunctionPrinterPass::ID = 0;
  55 }
  56
  57 char &llvm::MachineFunctionPrinterPassID = MachineFunctionPrinterPass::ID;
  58 INITIALIZE_PASS(MachineFunctionPrinterPass, "machineinstr-printer",
  59                 "Machine Function Printer", false, false)
  60
  61 namespace llvm {
  62 /// Returns a newly-created MachineFunction Printer pass. The
  63 /// default banner is empty.
  64 ///
  65 MachineFunctionPass *createMachineFunctionPrinterPass(raw_ostream &OS,
  66                                                       const std::string &Banner){
  67   return new MachineFunctionPrinterPass(OS, Banner);
  68 }
  69
  70 }