LLVM 17.0.0git
MachineFunctionPrinterPass.cpp
Go to the documentation of this file.
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
15#include "llvm/CodeGen/Passes.h"
17#include "llvm/IR/PrintPasses.h"
19#include "llvm/Support/Debug.h"
21
22using namespace llvm;
23
24namespace {
25/// MachineFunctionPrinterPass - This is a pass to dump the IR of a
26/// MachineFunction.
27///
28struct MachineFunctionPrinterPass : public MachineFunctionPass {
29 static char ID;
30
31 raw_ostream &OS;
32 const std::string Banner;
33
34 MachineFunctionPrinterPass() : MachineFunctionPass(ID), OS(dbgs()) { }
35 MachineFunctionPrinterPass(raw_ostream &os, const std::string &banner)
36 : MachineFunctionPass(ID), OS(os), Banner(banner) {}
37
38 StringRef getPassName() const override { return "MachineFunction Printer"; }
39
40 void getAnalysisUsage(AnalysisUsage &AU) const override {
41 AU.setPreservesAll();
44 }
45
46 bool runOnMachineFunction(MachineFunction &MF) override {
48 return false;
49 OS << "# " << Banner << ":\n";
50 MF.print(OS, getAnalysisIfAvailable<SlotIndexes>());
51 return false;
52 }
53};
54
55char MachineFunctionPrinterPass::ID = 0;
56}
57
58char &llvm::MachineFunctionPrinterPassID = MachineFunctionPrinterPass::ID;
59INITIALIZE_PASS(MachineFunctionPrinterPass, "machineinstr-printer",
60 "Machine Function Printer", false, false)
61
62namespace llvm {
63/// Returns a newly-created MachineFunction Printer pass. The
64/// default banner is empty.
65///
67 const std::string &Banner){
68 return new MachineFunctionPrinterPass(OS, Banner);
69}
70
71}
#define INITIALIZE_PASS(passName, arg, name, cfg, analysis)
Definition: PassSupport.h:38
Represent the analysis usage information of a pass.
AnalysisUsage & addUsedIfAvailable()
Add the specified Pass class to the set of analyses used by this pass.
void setPreservesAll()
Set by analyses that do not transform their input at all.
MachineFunctionPass - This class adapts the FunctionPass interface to allow convenient creation of pa...
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.
virtual bool runOnMachineFunction(MachineFunction &MF)=0
runOnMachineFunction - This method must be overloaded to perform the desired machine code transformat...
StringRef getName() const
getName - Return the name of the corresponding LLVM function.
void print(raw_ostream &OS, const SlotIndexes *=nullptr) const
print - Print out the MachineFunction in a format suitable for debugging to the specified stream.
virtual StringRef getPassName() const
getPassName - Return a nice clean name for a pass.
Definition: Pass.cpp:81
SlotIndexes pass.
Definition: SlotIndexes.h:319
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:163
bool isFunctionInPrintList(StringRef FunctionName)
MachineFunctionPass * createMachineFunctionPrinterPass(raw_ostream &OS, const std::string &Banner="")
MachineFunctionPrinter pass - This pass prints out the machine function to the given stream as a debu...
char & MachineFunctionPrinterPassID
MachineFunctionPrinterPass - This pass prints out MachineInstr's.