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) {
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 if (isFunctionInPrintList(F.getName()))
47 OS << Banner << static_cast<Value &>(F);
48 return PreservedAnalyses::all();
53 class PrintModulePassWrapper : public ModulePass {
58 PrintModulePassWrapper() : ModulePass(ID) {}
59 PrintModulePassWrapper(raw_ostream &OS, const std::string &Banner,
60 bool ShouldPreserveUseListOrder)
61 : ModulePass(ID), P(OS, Banner, ShouldPreserveUseListOrder) {}
63 bool runOnModule(Module &M) override {
68 void getAnalysisUsage(AnalysisUsage &AU) const override {
73 class PrintFunctionPassWrapper : public FunctionPass {
78 PrintFunctionPassWrapper() : FunctionPass(ID) {}
79 PrintFunctionPassWrapper(raw_ostream &OS, const std::string &Banner)
80 : FunctionPass(ID), P(OS, Banner) {}
82 // This pass just prints a banner followed by the function as it's processed.
83 bool runOnFunction(Function &F) override {
88 void getAnalysisUsage(AnalysisUsage &AU) const override {
93 class PrintBasicBlockPass : public BasicBlockPass {
99 PrintBasicBlockPass() : BasicBlockPass(ID), Out(dbgs()) {}
100 PrintBasicBlockPass(raw_ostream &Out, const std::string &Banner)
101 : BasicBlockPass(ID), Out(Out), Banner(Banner) {}
103 bool runOnBasicBlock(BasicBlock &BB) override {
108 void getAnalysisUsage(AnalysisUsage &AU) const override {
109 AU.setPreservesAll();
115 char PrintModulePassWrapper::ID = 0;
116 INITIALIZE_PASS(PrintModulePassWrapper, "print-module",
117 "Print module to stderr", false, false)
118 char PrintFunctionPassWrapper::ID = 0;
119 INITIALIZE_PASS(PrintFunctionPassWrapper, "print-function",
120 "Print function to stderr", false, false)
121 char PrintBasicBlockPass::ID = 0;
122 INITIALIZE_PASS(PrintBasicBlockPass, "print-bb", "Print BB to stderr", false,
125 ModulePass *llvm::createPrintModulePass(llvm::raw_ostream &OS,
126 const std::string &Banner,
127 bool ShouldPreserveUseListOrder) {
128 return new PrintModulePassWrapper(OS, Banner, ShouldPreserveUseListOrder);
131 FunctionPass *llvm::createPrintFunctionPass(llvm::raw_ostream &OS,
132 const std::string &Banner) {
133 return new PrintFunctionPassWrapper(OS, Banner);
136 BasicBlockPass *llvm::createPrintBasicBlockPass(llvm::raw_ostream &OS,
137 const std::string &Banner) {
138 return new PrintBasicBlockPass(OS, Banner);