LLVM 18.0.0git
IRPrintingPasses.cpp
Go to the documentation of this file.
1//===--- IRPrintingPasses.cpp - Module and Function printing passes -------===//
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// PrintModulePass and PrintFunctionPass implementations for the legacy pass
10// manager.
11//
12//===----------------------------------------------------------------------===//
13
15#include "llvm/ADT/StringRef.h"
16#include "llvm/IR/Function.h"
17#include "llvm/IR/Module.h"
18#include "llvm/IR/PrintPasses.h"
20#include "llvm/Pass.h"
21#include "llvm/Support/Debug.h"
23
24using namespace llvm;
25
26namespace {
27
28class PrintModulePassWrapper : public ModulePass {
30 std::string Banner;
31 bool ShouldPreserveUseListOrder;
32
33public:
34 static char ID;
35 PrintModulePassWrapper() : ModulePass(ID), OS(dbgs()) {}
36 PrintModulePassWrapper(raw_ostream &OS, const std::string &Banner,
37 bool ShouldPreserveUseListOrder)
38 : ModulePass(ID), OS(OS), Banner(Banner),
39 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {}
40
41 bool runOnModule(Module &M) override {
43 if (!Banner.empty())
44 OS << Banner << "\n";
45 M.print(OS, nullptr, ShouldPreserveUseListOrder);
46 } else {
47 bool BannerPrinted = false;
48 for (const auto &F : M.functions()) {
49 if (llvm::isFunctionInPrintList(F.getName())) {
50 if (!BannerPrinted && !Banner.empty()) {
51 OS << Banner << "\n";
52 BannerPrinted = true;
53 }
54 F.print(OS);
55 }
56 }
57 }
58 return false;
59 }
60
61 void getAnalysisUsage(AnalysisUsage &AU) const override {
62 AU.setPreservesAll();
63 }
64
65 StringRef getPassName() const override { return "Print Module IR"; }
66};
67
68class PrintFunctionPassWrapper : public FunctionPass {
70 std::string Banner;
71
72public:
73 static char ID;
74 PrintFunctionPassWrapper() : FunctionPass(ID), OS(dbgs()) {}
75 PrintFunctionPassWrapper(raw_ostream &OS, const std::string &Banner)
76 : FunctionPass(ID), OS(OS), Banner(Banner) {}
77
78 // This pass just prints a banner followed by the function as it's processed.
79 bool runOnFunction(Function &F) override {
80 if (isFunctionInPrintList(F.getName())) {
82 OS << Banner << " (function: " << F.getName() << ")\n"
83 << *F.getParent();
84 else
85 OS << Banner << '\n' << static_cast<Value &>(F);
86 }
87 return false;
88 }
89
90 void getAnalysisUsage(AnalysisUsage &AU) const override {
91 AU.setPreservesAll();
92 }
93
94 StringRef getPassName() const override { return "Print Function IR"; }
95};
96
97} // namespace
98
99char PrintModulePassWrapper::ID = 0;
100INITIALIZE_PASS(PrintModulePassWrapper, "print-module",
101 "Print module to stderr", false, true)
102char PrintFunctionPassWrapper::ID = 0;
103INITIALIZE_PASS(PrintFunctionPassWrapper, "print-function",
104 "Print function to stderr", false, true)
105
107 const std::string &Banner,
108 bool ShouldPreserveUseListOrder) {
109 return new PrintModulePassWrapper(OS, Banner, ShouldPreserveUseListOrder);
110}
111
113 const std::string &Banner) {
114 return new PrintFunctionPassWrapper(OS, Banner);
115}
116
118 const char *PID = (const char *)P->getPassID();
119
120 return (PID == &PrintModulePassWrapper::ID) ||
121 (PID == &PrintFunctionPassWrapper::ID);
122}
aarch64 promote const
static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val)
basic Basic Alias true
Performs the initial survey of the specified function
This file contains an interface for creating legacy passes to print out IR in various granularities.
#define F(x, y, z)
Definition: MD5.cpp:55
Module.h This file contains the declarations for the Module class.
#define P(N)
#define INITIALIZE_PASS(passName, arg, name, cfg, analysis)
Definition: PassSupport.h:38
raw_pwrite_stream & OS
Represent the analysis usage information of a pass.
void setPreservesAll()
Set by analyses that do not transform their input at all.
FunctionPass class - This class is used to implement most global optimizations.
Definition: Pass.h:311
virtual bool runOnFunction(Function &F)=0
runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass.
ModulePass class - This class is used to implement unstructured interprocedural optimizations and ana...
Definition: Pass.h:251
virtual bool runOnModule(Module &M)=0
runOnModule - Virtual method overriden by subclasses to process the module being operated on.
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
Pass interface - Implemented by all 'passes'.
Definition: Pass.h:94
virtual void getAnalysisUsage(AnalysisUsage &) const
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
Definition: Pass.cpp:98
virtual StringRef getPassName() const
getPassName - Return a nice clean name for a pass.
Definition: Pass.cpp:81
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
TargetPassConfig.
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
bool forcePrintModuleIR()
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:163
bool isFunctionInPrintList(StringRef FunctionName)
bool isIRPrintingPass(Pass *P)
Return true if a pass is for IR printing.
ModulePass * createPrintModulePass(raw_ostream &OS, const std::string &Banner="", bool ShouldPreserveUseListOrder=false)
Create and return a pass that writes the module to the specified raw_ostream.
FunctionPass * createPrintFunctionPass(raw_ostream &OS, const std::string &Banner="")
Create and return a pass that prints functions to the specified raw_ostream as they are processed.
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858