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
14#include "llvm/IR/IRPrintingPasses.h"
15#include "llvm/ADT/StringRef.h"
16#include "llvm/IR/Function.h"
17#include "llvm/IR/Module.h"
18#include "llvm/IR/PrintPasses.h"
19#include "llvm/InitializePasses.h"
20#include "llvm/Pass.h"
21#include "llvm/Support/Compiler.h"
22#include "llvm/Support/Debug.h"
23#include "llvm/Support/raw_ostream.h"
24
25using namespace llvm;
26
27namespace {
28
29static void printModule(raw_ostream &OS, StringRef Banner,
30 bool ShouldPreserveUseListOrder, Module &M) {
31 if (shouldPrintAllFunctions()) {
32 if (!Banner.empty())
33 OS << Banner << "\n";
34 M.print(OS, AAW: nullptr, ShouldPreserveUseListOrder);
35 return;
36 }
37
38 bool BannerPrinted = false;
39 for (const auto &F : M.functions()) {
40 if (!shouldPrintFunction(F))
41 continue;
42 if (!BannerPrinted && !Banner.empty()) {
43 OS << Banner << "\n";
44 BannerPrinted = true;
45 }
46 F.print(OS);
47 }
48}
49
50class PrintModulePassWrapper : public ModulePass {
51 raw_ostream &OS;
52 std::string Banner;
53 bool ShouldPreserveUseListOrder;
54 bool ShouldRenumberMetadata;
55
56public:
57 static char ID;
58 PrintModulePassWrapper()
59 : ModulePass(ID), OS(dbgs()), ShouldPreserveUseListOrder(false),
60 ShouldRenumberMetadata(false) {}
61 PrintModulePassWrapper(raw_ostream &OS, const std::string &Banner,
62 bool ShouldPreserveUseListOrder,
63 bool ShouldRenumberMetadata)
64 : ModulePass(ID), OS(OS), Banner(Banner),
65 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder),
66 ShouldRenumberMetadata(ShouldRenumberMetadata) {}
67
68 bool runOnModule(Module &M) override {
69 if (ShouldRenumberMetadata)
70 M.renumberMetadataForAssembly();
71 printModule(OS, Banner, ShouldPreserveUseListOrder, M);
72 return false;
73 }
74
75 void getAnalysisUsage(AnalysisUsage &AU) const override {
76 AU.setPreservesAll();
77 }
78
79 StringRef getPassName() const override { return "Print Module IR"; }
80};
81
82class PrintFunctionPassWrapper : public FunctionPass {
83 raw_ostream &OS;
84 std::string Banner;
85
86public:
87 static char ID;
88 PrintFunctionPassWrapper() : FunctionPass(ID), OS(dbgs()) {}
89 PrintFunctionPassWrapper(raw_ostream &OS, const std::string &Banner)
90 : FunctionPass(ID), OS(OS), Banner(Banner) {}
91
92 // This pass just prints a banner followed by the function as it's processed.
93 bool runOnFunction(Function &F) override {
94 if (shouldPrintFunction(F)) {
95 if (forcePrintModuleIR()) {
96 OS << Banner << " (function: " << F.getName() << ")\n";
97 F.getParent()->print(OS, AAW: nullptr);
98 } else
99 OS << Banner << '\n' << static_cast<Value &>(F);
100 }
101
102 return false;
103 }
104
105 void getAnalysisUsage(AnalysisUsage &AU) const override {
106 AU.setPreservesAll();
107 }
108
109 StringRef getPassName() const override { return "Print Function IR"; }
110};
111
112} // namespace
113
114char PrintModulePassWrapper::ID = 0;
115INITIALIZE_PASS(PrintModulePassWrapper, "print-module",
116 "Print module to stderr", false, true)
117char PrintFunctionPassWrapper::ID = 0;
118INITIALIZE_PASS(PrintFunctionPassWrapper, "print-function",
119 "Print function to stderr", false, true)
120
121ModulePass *llvm::createPrintModulePass(llvm::raw_ostream &OS,
122 const std::string &Banner,
123 bool ShouldPreserveUseListOrder) {
124 return createPrintModulePass(OS, Banner, ShouldPreserveUseListOrder,
125 /*ShouldRenumberMetadata=*/false);
126}
127
128ModulePass *llvm::createPrintModulePass(llvm::raw_ostream &OS,
129 const std::string &Banner,
130 bool ShouldPreserveUseListOrder,
131 bool ShouldRenumberMetadata) {
132 return new PrintModulePassWrapper(OS, Banner, ShouldPreserveUseListOrder,
133 ShouldRenumberMetadata);
134}
135
136FunctionPass *llvm::createPrintFunctionPass(llvm::raw_ostream &OS,
137 const std::string &Banner) {
138 return new PrintFunctionPassWrapper(OS, Banner);
139}
140
141bool llvm::isIRPrintingPass(Pass *P) {
142 const char *PID = (const char *)P->getPassID();
143
144 return (PID == &PrintModulePassWrapper::ID) ||
145 (PID == &PrintFunctionPassWrapper::ID);
146}
147