1 //===--- IRPrintingPasses.cpp - Module and Function printing passes -------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // PrintModulePass and PrintFunctionPass implementations.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/IR/IRPrintingPasses.h"
15 #include "llvm/IR/Function.h"
16 #include "llvm/IR/Module.h"
17 #include "llvm/IR/PassManager.h"
18 #include "llvm/Pass.h"
19 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/raw_ostream.h"
23 PrintModulePass::PrintModulePass() : OS(dbgs()) {}
24 PrintModulePass::PrintModulePass(raw_ostream &OS, const std::string &Banner,
25 bool ShouldPreserveUseListOrder)
26 : OS(OS), Banner(Banner),
27 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {}
29 PreservedAnalyses PrintModulePass::run(Module &M, AnalysisManager<Module> &) {
31 if (llvm::isFunctionInPrintList("*"))
32 M.print(OS, nullptr, ShouldPreserveUseListOrder);
34 for(const auto &F : M.functions())
35 if (llvm::isFunctionInPrintList(F.getName()))
38 return PreservedAnalyses::all();
41 PrintFunctionPass::PrintFunctionPass() : OS(dbgs()) {}
42 PrintFunctionPass::PrintFunctionPass(raw_ostream &OS, const std::string &Banner)
43 : OS(OS), Banner(Banner) {}
45 PreservedAnalyses PrintFunctionPass::run(Function &F,
46 AnalysisManager<Function> &) {
47 if (isFunctionInPrintList(F.getName()))
48 OS << Banner << static_cast<Value &>(F);
49 return PreservedAnalyses::all();
54 class PrintModulePassWrapper : public ModulePass {
59 PrintModulePassWrapper() : ModulePass(ID) {}
60 PrintModulePassWrapper(raw_ostream &OS, const std::string &Banner,
61 bool ShouldPreserveUseListOrder)
62 : ModulePass(ID), P(OS, Banner, ShouldPreserveUseListOrder) {}
64 bool runOnModule(Module &M) override {
65 ModuleAnalysisManager DummyMAM;
70 void getAnalysisUsage(AnalysisUsage &AU) const override {
75 class PrintFunctionPassWrapper : public FunctionPass {
80 PrintFunctionPassWrapper() : FunctionPass(ID) {}
81 PrintFunctionPassWrapper(raw_ostream &OS, const std::string &Banner)
82 : FunctionPass(ID), P(OS, Banner) {}
84 // This pass just prints a banner followed by the function as it's processed.
85 bool runOnFunction(Function &F) override {
86 FunctionAnalysisManager DummyFAM;
91 void getAnalysisUsage(AnalysisUsage &AU) const override {
96 class PrintBasicBlockPass : public BasicBlockPass {
102 PrintBasicBlockPass() : BasicBlockPass(ID), Out(dbgs()) {}
103 PrintBasicBlockPass(raw_ostream &Out, const std::string &Banner)
104 : BasicBlockPass(ID), Out(Out), Banner(Banner) {}
106 bool runOnBasicBlock(BasicBlock &BB) override {
111 void getAnalysisUsage(AnalysisUsage &AU) const override {
112 AU.setPreservesAll();
118 char PrintModulePassWrapper::ID = 0;
119 INITIALIZE_PASS(PrintModulePassWrapper, "print-module",
120 "Print module to stderr", false, false)
121 char PrintFunctionPassWrapper::ID = 0;
122 INITIALIZE_PASS(PrintFunctionPassWrapper, "print-function",
123 "Print function to stderr", false, false)
124 char PrintBasicBlockPass::ID = 0;
125 INITIALIZE_PASS(PrintBasicBlockPass, "print-bb", "Print BB to stderr", false,
128 ModulePass *llvm::createPrintModulePass(llvm::raw_ostream &OS,
129 const std::string &Banner,
130 bool ShouldPreserveUseListOrder) {
131 return new PrintModulePassWrapper(OS, Banner, ShouldPreserveUseListOrder);
134 FunctionPass *llvm::createPrintFunctionPass(llvm::raw_ostream &OS,
135 const std::string &Banner) {
136 return new PrintFunctionPassWrapper(OS, Banner);
139 BasicBlockPass *llvm::createPrintBasicBlockPass(llvm::raw_ostream &OS,
140 const std::string &Banner) {
141 return new PrintBasicBlockPass(OS, Banner);