blob: 4ee4f1f5ac80ed7993798a6d83c69a0e25e3d4a2 [file] [log] [blame]
Chandler Carruth12e9d2b2014-01-09 02:39:45 +00001//===--- IRPrintingPasses.cpp - Module and Function printing passes -------===//
Daniel Dunbar54d5b9e2008-10-21 23:33:38 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// PrintModulePass and PrintFunctionPass implementations.
11//
12//===----------------------------------------------------------------------===//
13
Chandler Carruthb8ddc702014-01-12 11:10:32 +000014#include "llvm/IR/IRPrintingPasses.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000015#include "llvm/IR/Function.h"
16#include "llvm/IR/Module.h"
Chandler Carruth52eef882014-01-12 12:15:39 +000017#include "llvm/IR/PassManager.h"
Daniel Dunbar54d5b9e2008-10-21 23:33:38 +000018#include "llvm/Pass.h"
David Greene5f2433e2010-01-05 01:30:18 +000019#include "llvm/Support/Debug.h"
Daniel Dunbar81b5fa52008-10-22 03:25:22 +000020#include "llvm/Support/raw_ostream.h"
Daniel Dunbar54d5b9e2008-10-21 23:33:38 +000021using namespace llvm;
22
Chandler Carruth52eef882014-01-12 12:15:39 +000023PrintModulePass::PrintModulePass() : OS(dbgs()) {}
Duncan P. N. Exon Smith8a74f682015-04-15 02:38:06 +000024PrintModulePass::PrintModulePass(raw_ostream &OS, const std::string &Banner,
25 bool ShouldPreserveUseListOrder)
26 : OS(OS), Banner(Banner),
27 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {}
Chandler Carruth52eef882014-01-12 12:15:39 +000028
Chandler Carruth164a2aa62016-06-17 00:11:01 +000029PreservedAnalyses PrintModulePass::run(Module &M, AnalysisManager<Module> &) {
Weiming Zhaob243c952016-01-06 18:31:44 +000030 OS << Banner;
Weiming Zhao0f1762c2016-01-06 22:55:03 +000031 if (llvm::isFunctionInPrintList("*"))
32 M.print(OS, nullptr, ShouldPreserveUseListOrder);
33 else {
34 for(const auto &F : M.functions())
35 if (llvm::isFunctionInPrintList(F.getName()))
36 F.print(OS);
37 }
Chandler Carruth52eef882014-01-12 12:15:39 +000038 return PreservedAnalyses::all();
39}
40
41PrintFunctionPass::PrintFunctionPass() : OS(dbgs()) {}
42PrintFunctionPass::PrintFunctionPass(raw_ostream &OS, const std::string &Banner)
43 : OS(OS), Banner(Banner) {}
44
Chandler Carruth164a2aa62016-06-17 00:11:01 +000045PreservedAnalyses PrintFunctionPass::run(Function &F,
Sean Silva36e0d012016-08-09 00:28:15 +000046 FunctionAnalysisManager &) {
Weiming Zhao0f1762c2016-01-06 22:55:03 +000047 if (isFunctionInPrintList(F.getName()))
48 OS << Banner << static_cast<Value &>(F);
Chandler Carruth52eef882014-01-12 12:15:39 +000049 return PreservedAnalyses::all();
50}
51
Daniel Dunbar54d5b9e2008-10-21 23:33:38 +000052namespace {
53
Chandler Carruth52eef882014-01-12 12:15:39 +000054class PrintModulePassWrapper : public ModulePass {
55 PrintModulePass P;
Chandler Carruth3dd261d2014-01-12 11:16:01 +000056
57public:
58 static char ID;
Chandler Carruth52eef882014-01-12 12:15:39 +000059 PrintModulePassWrapper() : ModulePass(ID) {}
Duncan P. N. Exon Smith8a74f682015-04-15 02:38:06 +000060 PrintModulePassWrapper(raw_ostream &OS, const std::string &Banner,
61 bool ShouldPreserveUseListOrder)
62 : ModulePass(ID), P(OS, Banner, ShouldPreserveUseListOrder) {}
Chandler Carruth3dd261d2014-01-12 11:16:01 +000063
Craig Topperf398d7c2014-03-05 06:35:38 +000064 bool runOnModule(Module &M) override {
Chandler Carruth164a2aa62016-06-17 00:11:01 +000065 ModuleAnalysisManager DummyMAM;
66 P.run(M, DummyMAM);
Chandler Carruth3dd261d2014-01-12 11:16:01 +000067 return false;
68 }
69
Craig Topperf398d7c2014-03-05 06:35:38 +000070 void getAnalysisUsage(AnalysisUsage &AU) const override {
Chandler Carruth3dd261d2014-01-12 11:16:01 +000071 AU.setPreservesAll();
72 }
73};
74
Chandler Carruth52eef882014-01-12 12:15:39 +000075class PrintFunctionPassWrapper : public FunctionPass {
76 PrintFunctionPass P;
Chandler Carruth3dd261d2014-01-12 11:16:01 +000077
78public:
79 static char ID;
Chandler Carruth52eef882014-01-12 12:15:39 +000080 PrintFunctionPassWrapper() : FunctionPass(ID) {}
81 PrintFunctionPassWrapper(raw_ostream &OS, const std::string &Banner)
82 : FunctionPass(ID), P(OS, Banner) {}
Chandler Carruth3dd261d2014-01-12 11:16:01 +000083
84 // This pass just prints a banner followed by the function as it's processed.
Craig Topperf398d7c2014-03-05 06:35:38 +000085 bool runOnFunction(Function &F) override {
Chandler Carruth164a2aa62016-06-17 00:11:01 +000086 FunctionAnalysisManager DummyFAM;
87 P.run(F, DummyFAM);
Chandler Carruth3dd261d2014-01-12 11:16:01 +000088 return false;
89 }
90
Craig Topperf398d7c2014-03-05 06:35:38 +000091 void getAnalysisUsage(AnalysisUsage &AU) const override {
Chandler Carruth3dd261d2014-01-12 11:16:01 +000092 AU.setPreservesAll();
93 }
94};
95
96class PrintBasicBlockPass : public BasicBlockPass {
Chandler Carruthe0af6642014-01-12 11:40:03 +000097 raw_ostream &Out;
Chandler Carruth3dd261d2014-01-12 11:16:01 +000098 std::string Banner;
Chandler Carruth3dd261d2014-01-12 11:16:01 +000099
100public:
101 static char ID;
Chandler Carruthe0af6642014-01-12 11:40:03 +0000102 PrintBasicBlockPass() : BasicBlockPass(ID), Out(dbgs()) {}
103 PrintBasicBlockPass(raw_ostream &Out, const std::string &Banner)
104 : BasicBlockPass(ID), Out(Out), Banner(Banner) {}
Chandler Carruth3dd261d2014-01-12 11:16:01 +0000105
Craig Topperf398d7c2014-03-05 06:35:38 +0000106 bool runOnBasicBlock(BasicBlock &BB) override {
Chandler Carruthe0af6642014-01-12 11:40:03 +0000107 Out << Banner << BB;
Chandler Carruth3dd261d2014-01-12 11:16:01 +0000108 return false;
109 }
110
Hans Wennborg12d1e242014-05-24 20:19:40 +0000111 void getAnalysisUsage(AnalysisUsage &AU) const override {
Chandler Carruth3dd261d2014-01-12 11:16:01 +0000112 AU.setPreservesAll();
113 }
114};
Chandler Carruthe0af6642014-01-12 11:40:03 +0000115
Alexander Kornienkof00654e2015-06-23 09:49:53 +0000116}
Daniel Dunbar54d5b9e2008-10-21 23:33:38 +0000117
Chandler Carruth52eef882014-01-12 12:15:39 +0000118char PrintModulePassWrapper::ID = 0;
119INITIALIZE_PASS(PrintModulePassWrapper, "print-module",
120 "Print module to stderr", false, false)
121char PrintFunctionPassWrapper::ID = 0;
122INITIALIZE_PASS(PrintFunctionPassWrapper, "print-function",
123 "Print function to stderr", false, false)
Sergei Larincd1201b2013-02-08 23:37:41 +0000124char PrintBasicBlockPass::ID = 0;
Chandler Carruth3dd261d2014-01-12 11:16:01 +0000125INITIALIZE_PASS(PrintBasicBlockPass, "print-bb", "Print BB to stderr", false,
126 false)
Daniel Dunbar54d5b9e2008-10-21 23:33:38 +0000127
Chandler Carruth9d805132014-01-12 11:30:46 +0000128ModulePass *llvm::createPrintModulePass(llvm::raw_ostream &OS,
Duncan P. N. Exon Smith8a74f682015-04-15 02:38:06 +0000129 const std::string &Banner,
130 bool ShouldPreserveUseListOrder) {
131 return new PrintModulePassWrapper(OS, Banner, ShouldPreserveUseListOrder);
Daniel Dunbar54d5b9e2008-10-21 23:33:38 +0000132}
133
Chandler Carruth9d805132014-01-12 11:30:46 +0000134FunctionPass *llvm::createPrintFunctionPass(llvm::raw_ostream &OS,
135 const std::string &Banner) {
Chandler Carruth52eef882014-01-12 12:15:39 +0000136 return new PrintFunctionPassWrapper(OS, Banner);
Daniel Dunbar54d5b9e2008-10-21 23:33:38 +0000137}
138
Chandler Carruth9d805132014-01-12 11:30:46 +0000139BasicBlockPass *llvm::createPrintBasicBlockPass(llvm::raw_ostream &OS,
Chandler Carruth3dd261d2014-01-12 11:16:01 +0000140 const std::string &Banner) {
Chandler Carruthe0af6642014-01-12 11:40:03 +0000141 return new PrintBasicBlockPass(OS, Banner);
Sergei Larincd1201b2013-02-08 23:37:41 +0000142}