1 //===-- UnreachableBlockElim.cpp - Remove unreachable blocks for codegen --===//
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 // This pass is an extremely simple version of the SimplifyCFG pass. Its sole
10 // job is to delete LLVM basic blocks that are not reachable from the entry
11 // node. To do this, it performs a simple depth first traversal of the CFG,
12 // then deletes any unvisited nodes.
13 //
14 // Note that this pass is really a hack. In particular, the instruction
15 // selectors for various targets should just not generate code for unreachable
16 // blocks. Until LLVM has a more systematic way of defining instruction
17 // selectors, however, we cannot really expect them to handle additional
18 // complexity.
19 //
20 //===----------------------------------------------------------------------===//
21
22 #include "llvm/CodeGen/UnreachableBlockElim.h"
23 #include "llvm/ADT/DepthFirstIterator.h"
24 #include "llvm/ADT/SmallPtrSet.h"
25 #include "llvm/CodeGen/MachineDominators.h"
26 #include "llvm/CodeGen/MachineFunctionPass.h"
27 #include "llvm/CodeGen/MachineInstrBuilder.h"
28 #include "llvm/CodeGen/MachineLoopInfo.h"
29 #include "llvm/CodeGen/MachineModuleInfo.h"
30 #include "llvm/CodeGen/MachineRegisterInfo.h"
31 #include "llvm/CodeGen/Passes.h"
32 #include "llvm/CodeGen/TargetInstrInfo.h"
33 #include "llvm/IR/CFG.h"
34 #include "llvm/IR/Constant.h"
35 #include "llvm/IR/Dominators.h"
36 #include "llvm/IR/Function.h"
37 #include "llvm/IR/Instructions.h"
38 #include "llvm/IR/Type.h"
39 #include "llvm/InitializePasses.h"
40 #include "llvm/Pass.h"
41 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
42 using namespace llvm;
43
44 namespace {
45 class UnreachableBlockElimLegacyPass : public FunctionPass {
runOnFunction(Function & F)46 bool runOnFunction(Function &F) override {
47 return llvm::EliminateUnreachableBlocks(F);
48 }
49
50 public:
51 static char ID; // Pass identification, replacement for typeid
UnreachableBlockElimLegacyPass()52 UnreachableBlockElimLegacyPass() : FunctionPass(ID) {
53 initializeUnreachableBlockElimLegacyPassPass(
54 *PassRegistry::getPassRegistry());
55 }
56
getAnalysisUsage(AnalysisUsage & AU) const57 void getAnalysisUsage(AnalysisUsage &AU) const override {
58 AU.addPreserved<DominatorTreeWrapperPass>();
59 }
60 };
61 }
62 char UnreachableBlockElimLegacyPass::ID = 0;
63 INITIALIZE_PASS(UnreachableBlockElimLegacyPass, "unreachableblockelim",
64 "Remove unreachable blocks from the CFG", false, false)
65
createUnreachableBlockEliminationPass()66 FunctionPass *llvm::createUnreachableBlockEliminationPass() {
67 return new UnreachableBlockElimLegacyPass();
68 }
69
run(Function & F,FunctionAnalysisManager & AM)70 PreservedAnalyses UnreachableBlockElimPass::run(Function &F,
71 FunctionAnalysisManager &AM) {
72 bool Changed = llvm::EliminateUnreachableBlocks(F);
73 if (!Changed)
74 return PreservedAnalyses::all();
75 PreservedAnalyses PA;
76 PA.preserve<DominatorTreeAnalysis>();
77 return PA;
78 }
79
80 namespace {
81 class UnreachableMachineBlockElim : public MachineFunctionPass {
82 bool runOnMachineFunction(MachineFunction &F) override;
83 void getAnalysisUsage(AnalysisUsage &AU) const override;
84 MachineModuleInfo *MMI;
85 public:
86 static char ID; // Pass identification, replacement for typeid
UnreachableMachineBlockElim()87 UnreachableMachineBlockElim() : MachineFunctionPass(ID) {}
88 };
89 }
90 char UnreachableMachineBlockElim::ID = 0;
91
92 INITIALIZE_PASS(UnreachableMachineBlockElim, "unreachable-mbb-elimination",
93 "Remove unreachable machine basic blocks", false, false)
94
95 char &llvm::UnreachableMachineBlockElimID = UnreachableMachineBlockElim::ID;
96
getAnalysisUsage(AnalysisUsage & AU) const97 void UnreachableMachineBlockElim::getAnalysisUsage(AnalysisUsage &AU) const {
98 AU.addPreserved<MachineLoopInfo>();
99 AU.addPreserved<MachineDominatorTree>();
100 MachineFunctionPass::getAnalysisUsage(AU);
101 }
102
runOnMachineFunction(MachineFunction & F)103 bool UnreachableMachineBlockElim::runOnMachineFunction(MachineFunction &F) {
104 df_iterator_default_set<MachineBasicBlock*> Reachable;
105 bool ModifiedPHI = false;
106
107 auto *MMIWP = getAnalysisIfAvailable<MachineModuleInfoWrapperPass>();
108 MMI = MMIWP ? &MMIWP->getMMI() : nullptr;
109 MachineDominatorTree *MDT = getAnalysisIfAvailable<MachineDominatorTree>();
110 MachineLoopInfo *MLI = getAnalysisIfAvailable<MachineLoopInfo>();
111
112 // Mark all reachable blocks.
113 for (MachineBasicBlock *BB : depth_first_ext(&F, Reachable))
114 (void)BB/* Mark all reachable blocks */;
115
116 // Loop over all dead blocks, remembering them and deleting all instructions
117 // in them.
118 std::vector<MachineBasicBlock*> DeadBlocks;
119 for (MachineFunction::iterator I = F.begin(), E = F.end(); I != E; ++I) {
120 MachineBasicBlock *BB = &*I;
121
122 // Test for deadness.
123 if (!Reachable.count(BB)) {
124 DeadBlocks.push_back(BB);
125
126 // Update dominator and loop info.
127 if (MLI) MLI->removeBlock(BB);
128 if (MDT && MDT->getNode(BB)) MDT->eraseNode(BB);
129
130 while (BB->succ_begin() != BB->succ_end()) {
131 MachineBasicBlock* succ = *BB->succ_begin();
132
133 MachineBasicBlock::iterator start = succ->begin();
134 while (start != succ->end() && start->isPHI()) {
135 for (unsigned i = start->getNumOperands() - 1; i >= 2; i-=2)
136 if (start->getOperand(i).isMBB() &&
137 start->getOperand(i).getMBB() == BB) {
138 start->RemoveOperand(i);
139 start->RemoveOperand(i-1);
140 }
141
142 start++;
143 }
144
145 BB->removeSuccessor(BB->succ_begin());
146 }
147 }
148 }
149
150 // Actually remove the blocks now.
151 for (unsigned i = 0, e = DeadBlocks.size(); i != e; ++i) {
152 // Remove any call site information for calls in the block.
153 for (auto &I : DeadBlocks[i]->instrs())
154 if (I.isCall(MachineInstr::IgnoreBundle))
155 DeadBlocks[i]->getParent()->eraseCallSiteInfo(&I);
156
157 DeadBlocks[i]->eraseFromParent();
158 }
159
160 // Cleanup PHI nodes.
161 for (MachineFunction::iterator I = F.begin(), E = F.end(); I != E; ++I) {
162 MachineBasicBlock *BB = &*I;
163 // Prune unneeded PHI entries.
164 SmallPtrSet<MachineBasicBlock*, 8> preds(BB->pred_begin(),
165 BB->pred_end());
166 MachineBasicBlock::iterator phi = BB->begin();
167 while (phi != BB->end() && phi->isPHI()) {
168 for (unsigned i = phi->getNumOperands() - 1; i >= 2; i-=2)
169 if (!preds.count(phi->getOperand(i).getMBB())) {
170 phi->RemoveOperand(i);
171 phi->RemoveOperand(i-1);
172 ModifiedPHI = true;
173 }
174
175 if (phi->getNumOperands() == 3) {
176 const MachineOperand &Input = phi->getOperand(1);
177 const MachineOperand &Output = phi->getOperand(0);
178 Register InputReg = Input.getReg();
179 Register OutputReg = Output.getReg();
180 assert(Output.getSubReg() == 0 && "Cannot have output subregister");
181 ModifiedPHI = true;
182
183 if (InputReg != OutputReg) {
184 MachineRegisterInfo &MRI = F.getRegInfo();
185 unsigned InputSub = Input.getSubReg();
186 if (InputSub == 0 &&
187 MRI.constrainRegClass(InputReg, MRI.getRegClass(OutputReg)) &&
188 !Input.isUndef()) {
189 MRI.replaceRegWith(OutputReg, InputReg);
190 } else {
191 // The input register to the PHI has a subregister or it can't be
192 // constrained to the proper register class or it is undef:
193 // insert a COPY instead of simply replacing the output
194 // with the input.
195 const TargetInstrInfo *TII = F.getSubtarget().getInstrInfo();
196 BuildMI(*BB, BB->getFirstNonPHI(), phi->getDebugLoc(),
197 TII->get(TargetOpcode::COPY), OutputReg)
198 .addReg(InputReg, getRegState(Input), InputSub);
199 }
200 phi++->eraseFromParent();
201 }
202 continue;
203 }
204
205 ++phi;
206 }
207 }
208
209 F.RenumberBlocks();
210
211 return (!DeadBlocks.empty() || ModifiedPHI);
212 }
213