blob: c47e904692dcf1fb602f53eb282b30f328d57b74 [file] [log] [blame]
Justin Bogner0638b7ba2015-09-25 21:03:46 +00001//===- ADCE.cpp - Code to perform dead code elimination -------------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerb28986f2001-06-30 06:39:11 +00009//
Owen Anderson7686b552008-05-29 08:45:13 +000010// This file implements the Aggressive Dead Code Elimination pass. This pass
11// optimistically assumes that all instructions are dead until proven otherwise,
Nadav Rotem465834c2012-07-24 10:51:42 +000012// allowing it to eliminate dead computations that other DCE passes do not
Owen Anderson7686b552008-05-29 08:45:13 +000013// catch, particularly involving loop computations.
Chris Lattnerb28986f2001-06-30 06:39:11 +000014//
15//===----------------------------------------------------------------------===//
16
Justin Bogner19b67992015-10-30 23:13:18 +000017#include "llvm/Transforms/Scalar/ADCE.h"
David Callahancc5cd4d2016-08-03 04:28:39 +000018
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "llvm/ADT/DepthFirstIterator.h"
David Callahanebcf9162016-12-13 16:42:18 +000020#include "llvm/ADT/PostOrderIterator.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/ADT/SmallPtrSet.h"
22#include "llvm/ADT/SmallVector.h"
23#include "llvm/ADT/Statistic.h"
James Molloyefbba722015-09-10 10:22:12 +000024#include "llvm/Analysis/GlobalsModRef.h"
David Callahan012d1c02016-08-24 00:10:06 +000025#include "llvm/Analysis/IteratedDominanceFrontier.h"
26#include "llvm/Analysis/PostDominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000027#include "llvm/IR/BasicBlock.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000028#include "llvm/IR/CFG.h"
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +000029#include "llvm/IR/DebugInfoMetadata.h"
Jakub Kuderski2724d452017-08-22 16:30:21 +000030#include "llvm/IR/Dominators.h"
David Callahanebcf9162016-12-13 16:42:18 +000031#include "llvm/IR/IRBuilder.h"
Chandler Carruth83948572014-03-04 10:30:26 +000032#include "llvm/IR/InstIterator.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000033#include "llvm/IR/Instructions.h"
34#include "llvm/IR/IntrinsicInst.h"
Owen Anderson7686b552008-05-29 08:45:13 +000035#include "llvm/Pass.h"
Betul Buyukkurtbf8554c2016-04-13 18:52:19 +000036#include "llvm/ProfileData/InstrProf.h"
Justin Bogner19b67992015-10-30 23:13:18 +000037#include "llvm/Transforms/Scalar.h"
Chris Lattnerfc7bdac2003-12-19 09:08:34 +000038using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000039
Chandler Carruth964daaa2014-04-22 02:55:47 +000040#define DEBUG_TYPE "adce"
41
Owen Anderson7686b552008-05-29 08:45:13 +000042STATISTIC(NumRemoved, "Number of instructions removed");
David Callahanebcf9162016-12-13 16:42:18 +000043STATISTIC(NumBranchesRemoved, "Number of branch instructions removed");
Chris Lattner019f3642002-05-06 17:27:57 +000044
Tobias Grosser335b6bf2017-03-14 10:18:11 +000045// This is a temporary option until we change the interface to this pass based
46// on optimization level.
David Callahan947be0f2016-08-16 14:31:51 +000047static cl::opt<bool> RemoveControlFlowFlag("adce-remove-control-flow",
David Callahanebcf9162016-12-13 16:42:18 +000048 cl::init(true), cl::Hidden);
49
50// This option enables removing of may-be-infinite loops which have no other
51// effect.
52static cl::opt<bool> RemoveLoops("adce-remove-loops", cl::init(false),
53 cl::Hidden);
David Callahan947be0f2016-08-16 14:31:51 +000054
David Callahancc5cd4d2016-08-03 04:28:39 +000055namespace {
David Callahan947be0f2016-08-16 14:31:51 +000056/// Information about Instructions
57struct InstInfoType {
58 /// True if the associated instruction is live.
59 bool Live = false;
60 /// Quick access to information for block containing associated Instruction.
61 struct BlockInfoType *Block = nullptr;
62};
63
64/// Information about basic blocks relevant to dead code elimination.
65struct BlockInfoType {
66 /// True when this block contains a live instructions.
67 bool Live = false;
68 /// True when this block ends in an unconditional branch.
69 bool UnconditionalBranch = false;
David Callahanc165a4e2016-09-19 23:17:58 +000070 /// True when this block is known to have live PHI nodes.
71 bool HasLivePhiNodes = false;
72 /// Control dependence sources need to be live for this block.
73 bool CFLive = false;
David Callahan947be0f2016-08-16 14:31:51 +000074
75 /// Quick access to the LiveInfo for the terminator,
76 /// holds the value &InstInfo[Terminator]
77 InstInfoType *TerminatorLiveInfo = nullptr;
78
79 bool terminatorIsLive() const { return TerminatorLiveInfo->Live; }
80
81 /// Corresponding BasicBlock.
82 BasicBlock *BB = nullptr;
83
David Callahanebcf9162016-12-13 16:42:18 +000084 /// Cache of BB->getTerminator().
David Callahan947be0f2016-08-16 14:31:51 +000085 TerminatorInst *Terminator = nullptr;
David Callahanebcf9162016-12-13 16:42:18 +000086
87 /// Post-order numbering of reverse control flow graph.
88 unsigned PostOrder;
David Callahan947be0f2016-08-16 14:31:51 +000089};
90
David Callahan45e442e2016-08-05 19:38:11 +000091class AggressiveDeadCodeElimination {
David Callahancc5cd4d2016-08-03 04:28:39 +000092 Function &F;
Jakub Kuderski2724d452017-08-22 16:30:21 +000093
94 // ADCE does not use DominatorTree per se, but it updates it to preserve the
95 // analysis.
96 DominatorTree &DT;
David Callahan012d1c02016-08-24 00:10:06 +000097 PostDominatorTree &PDT;
David Callahan947be0f2016-08-16 14:31:51 +000098
99 /// Mapping of blocks to associated information, an element in BlockInfoVec.
100 DenseMap<BasicBlock *, BlockInfoType> BlockInfo;
101 bool isLive(BasicBlock *BB) { return BlockInfo[BB].Live; }
102
103 /// Mapping of instructions to associated information.
104 DenseMap<Instruction *, InstInfoType> InstInfo;
105 bool isLive(Instruction *I) { return InstInfo[I].Live; }
106
David Callahan45e442e2016-08-05 19:38:11 +0000107 /// Instructions known to be live where we need to mark
108 /// reaching definitions as live.
David Callahancc5cd4d2016-08-03 04:28:39 +0000109 SmallVector<Instruction *, 128> Worklist;
David Callahan45e442e2016-08-05 19:38:11 +0000110 /// Debug info scopes around a live instruction.
David Callahancc5cd4d2016-08-03 04:28:39 +0000111 SmallPtrSet<const Metadata *, 32> AliveScopes;
David Callahan45e442e2016-08-05 19:38:11 +0000112
David Callahan947be0f2016-08-16 14:31:51 +0000113 /// Set of blocks with not known to have live terminators.
114 SmallPtrSet<BasicBlock *, 16> BlocksWithDeadTerminators;
115
David Callahanebcf9162016-12-13 16:42:18 +0000116 /// The set of blocks which we have determined whose control
117 /// dependence sources must be live and which have not had
Tobias Grosser335b6bf2017-03-14 10:18:11 +0000118 /// those dependences analyzed.
David Callahan947be0f2016-08-16 14:31:51 +0000119 SmallPtrSet<BasicBlock *, 16> NewLiveBlocks;
120
121 /// Set up auxiliary data structures for Instructions and BasicBlocks and
122 /// initialize the Worklist to the set of must-be-live Instruscions.
David Callahan45e442e2016-08-05 19:38:11 +0000123 void initialize();
David Callahan947be0f2016-08-16 14:31:51 +0000124 /// Return true for operations which are always treated as live.
David Callahan45e442e2016-08-05 19:38:11 +0000125 bool isAlwaysLive(Instruction &I);
David Callahan947be0f2016-08-16 14:31:51 +0000126 /// Return true for instrumentation instructions for value profiling.
David Callahan45e442e2016-08-05 19:38:11 +0000127 bool isInstrumentsConstant(Instruction &I);
David Callahan45e442e2016-08-05 19:38:11 +0000128
129 /// Propagate liveness to reaching definitions.
130 void markLiveInstructions();
131 /// Mark an instruction as live.
David Callahan947be0f2016-08-16 14:31:51 +0000132 void markLive(Instruction *I);
David Callahanebcf9162016-12-13 16:42:18 +0000133 /// Mark a block as live.
134 void markLive(BlockInfoType &BB);
135 void markLive(BasicBlock *BB) { markLive(BlockInfo[BB]); }
136
David Callahanc165a4e2016-09-19 23:17:58 +0000137 /// Mark terminators of control predecessors of a PHI node live.
138 void markPhiLive(PHINode *PN);
David Callahan947be0f2016-08-16 14:31:51 +0000139
140 /// Record the Debug Scopes which surround live debug information.
David Callahancc5cd4d2016-08-03 04:28:39 +0000141 void collectLiveScopes(const DILocalScope &LS);
142 void collectLiveScopes(const DILocation &DL);
David Callahan947be0f2016-08-16 14:31:51 +0000143
144 /// Analyze dead branches to find those whose branches are the sources
145 /// of control dependences impacting a live block. Those branches are
146 /// marked live.
147 void markLiveBranchesFromControlDependences();
David Callahan45e442e2016-08-05 19:38:11 +0000148
149 /// Remove instructions not marked live, return if any any instruction
150 /// was removed.
151 bool removeDeadInstructions();
152
Tobias Grosser335b6bf2017-03-14 10:18:11 +0000153 /// Identify connected sections of the control flow graph which have
David Callahanebcf9162016-12-13 16:42:18 +0000154 /// dead terminators and rewrite the control flow graph to remove them.
155 void updateDeadRegions();
156
157 /// Set the BlockInfo::PostOrder field based on a post-order
158 /// numbering of the reverse control flow graph.
159 void computeReversePostOrder();
160
161 /// Make the terminator of this block an unconditional branch to \p Target.
162 void makeUnconditional(BasicBlock *BB, BasicBlock *Target);
163
David Callahancc5cd4d2016-08-03 04:28:39 +0000164public:
Jakub Kuderski2724d452017-08-22 16:30:21 +0000165 AggressiveDeadCodeElimination(Function &F, DominatorTree &DT,
166 PostDominatorTree &PDT)
167 : F(F), DT(DT), PDT(PDT) {}
168 bool performDeadCodeElimination();
David Callahancc5cd4d2016-08-03 04:28:39 +0000169};
170}
171
David Callahan45e442e2016-08-05 19:38:11 +0000172bool AggressiveDeadCodeElimination::performDeadCodeElimination() {
173 initialize();
174 markLiveInstructions();
175 return removeDeadInstructions();
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000176}
177
David Callahan947be0f2016-08-16 14:31:51 +0000178static bool isUnconditionalBranch(TerminatorInst *Term) {
David Callahanebcf9162016-12-13 16:42:18 +0000179 auto *BR = dyn_cast<BranchInst>(Term);
David Callahan947be0f2016-08-16 14:31:51 +0000180 return BR && BR->isUnconditional();
181}
182
David Callahan45e442e2016-08-05 19:38:11 +0000183void AggressiveDeadCodeElimination::initialize() {
David Callahan947be0f2016-08-16 14:31:51 +0000184
185 auto NumBlocks = F.size();
186
187 // We will have an entry in the map for each block so we grow the
188 // structure to twice that size to keep the load factor low in the hash table.
189 BlockInfo.reserve(NumBlocks);
190 size_t NumInsts = 0;
David Callahan012d1c02016-08-24 00:10:06 +0000191
David Callahan947be0f2016-08-16 14:31:51 +0000192 // Iterate over blocks and initialize BlockInfoVec entries, count
193 // instructions to size the InstInfo hash table.
194 for (auto &BB : F) {
195 NumInsts += BB.size();
196 auto &Info = BlockInfo[&BB];
197 Info.BB = &BB;
198 Info.Terminator = BB.getTerminator();
199 Info.UnconditionalBranch = isUnconditionalBranch(Info.Terminator);
200 }
201
202 // Initialize instruction map and set pointers to block info.
203 InstInfo.reserve(NumInsts);
204 for (auto &BBInfo : BlockInfo)
205 for (Instruction &I : *BBInfo.second.BB)
206 InstInfo[&I].Block = &BBInfo.second;
207
208 // Since BlockInfoVec holds pointers into InstInfo and vice-versa, we may not
209 // add any more elements to either after this point.
210 for (auto &BBInfo : BlockInfo)
211 BBInfo.second.TerminatorLiveInfo = &InstInfo[BBInfo.second.Terminator];
212
David Callahan45e442e2016-08-05 19:38:11 +0000213 // Collect the set of "root" instructions that are known live.
214 for (Instruction &I : instructions(F))
215 if (isAlwaysLive(I))
David Callahan947be0f2016-08-16 14:31:51 +0000216 markLive(&I);
217
218 if (!RemoveControlFlowFlag)
219 return;
220
David Callahanebcf9162016-12-13 16:42:18 +0000221 if (!RemoveLoops) {
222 // This stores state for the depth-first iterator. In addition
223 // to recording which nodes have been visited we also record whether
224 // a node is currently on the "stack" of active ancestors of the current
225 // node.
226 typedef DenseMap<BasicBlock *, bool> StatusMap ;
227 class DFState : public StatusMap {
228 public:
229 std::pair<StatusMap::iterator, bool> insert(BasicBlock *BB) {
230 return StatusMap::insert(std::make_pair(BB, true));
231 }
David Callahan947be0f2016-08-16 14:31:51 +0000232
David Callahanebcf9162016-12-13 16:42:18 +0000233 // Invoked after we have visited all children of a node.
234 void completed(BasicBlock *BB) { (*this)[BB] = false; }
235
236 // Return true if \p BB is currently on the active stack
237 // of ancestors.
238 bool onStack(BasicBlock *BB) {
239 auto Iter = find(BB);
240 return Iter != end() && Iter->second;
241 }
242 } State;
Taewook Ohd3f1ec92017-01-26 04:32:40 +0000243
David Callahanebcf9162016-12-13 16:42:18 +0000244 State.reserve(F.size());
245 // Iterate over blocks in depth-first pre-order and
246 // treat all edges to a block already seen as loop back edges
247 // and mark the branch live it if there is a back edge.
248 for (auto *BB: depth_first_ext(&F.getEntryBlock(), State)) {
249 TerminatorInst *Term = BB->getTerminator();
250 if (isLive(Term))
251 continue;
252
253 for (auto *Succ : successors(BB))
254 if (State.onStack(Succ)) {
255 // back edge....
256 markLive(Term);
257 break;
258 }
259 }
260 }
261
Jakub Kuderski638c0852017-08-15 18:14:57 +0000262 // Mark blocks live if there is no path from the block to a
263 // return of the function.
264 // We do this by seeing which of the postdomtree root children exit the
265 // program, and for all others, mark the subtree live.
266 for (auto &PDTChild : children<DomTreeNode *>(PDT.getRootNode())) {
267 auto *BB = PDTChild->getBlock();
268 auto &Info = BlockInfo[BB];
269 // Real function return
270 if (isa<ReturnInst>(Info.Terminator)) {
271 DEBUG(dbgs() << "post-dom root child is a return: " << BB->getName()
Tobias Grosserf818c332017-03-02 21:08:37 +0000272 << '\n';);
Tobias Grosserf818c332017-03-02 21:08:37 +0000273 continue;
274 }
Jakub Kuderski638c0852017-08-15 18:14:57 +0000275
276 // This child is something else, like an infinite loop.
277 for (auto DFNode : depth_first(PDTChild))
278 markLive(BlockInfo[DFNode->getBlock()].Terminator);
David Callahan012d1c02016-08-24 00:10:06 +0000279 }
David Callahan947be0f2016-08-16 14:31:51 +0000280
281 // Treat the entry block as always live
282 auto *BB = &F.getEntryBlock();
283 auto &EntryInfo = BlockInfo[BB];
284 EntryInfo.Live = true;
285 if (EntryInfo.UnconditionalBranch)
286 markLive(EntryInfo.Terminator);
287
288 // Build initial collection of blocks with dead terminators
289 for (auto &BBInfo : BlockInfo)
290 if (!BBInfo.second.terminatorIsLive())
291 BlocksWithDeadTerminators.insert(BBInfo.second.BB);
David Callahan45e442e2016-08-05 19:38:11 +0000292}
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000293
David Callahan45e442e2016-08-05 19:38:11 +0000294bool AggressiveDeadCodeElimination::isAlwaysLive(Instruction &I) {
David Callahan45e442e2016-08-05 19:38:11 +0000295 // TODO -- use llvm::isInstructionTriviallyDead
David Callahan947be0f2016-08-16 14:31:51 +0000296 if (I.isEHPad() || I.mayHaveSideEffects()) {
David Callahan45e442e2016-08-05 19:38:11 +0000297 // Skip any value profile instrumentation calls if they are
298 // instrumenting constants.
David Callahan947be0f2016-08-16 14:31:51 +0000299 if (isInstrumentsConstant(I))
300 return false;
301 return true;
David Callahan45e442e2016-08-05 19:38:11 +0000302 }
David Callahan947be0f2016-08-16 14:31:51 +0000303 if (!isa<TerminatorInst>(I))
304 return false;
305 if (RemoveControlFlowFlag && (isa<BranchInst>(I) || isa<SwitchInst>(I)))
306 return false;
307 return true;
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000308}
309
Betul Buyukkurtbf8554c2016-04-13 18:52:19 +0000310// Check if this instruction is a runtime call for value profiling and
311// if it's instrumenting a constant.
David Callahan45e442e2016-08-05 19:38:11 +0000312bool AggressiveDeadCodeElimination::isInstrumentsConstant(Instruction &I) {
313 // TODO -- move this test into llvm::isInstructionTriviallyDead
Betul Buyukkurtbf8554c2016-04-13 18:52:19 +0000314 if (CallInst *CI = dyn_cast<CallInst>(&I))
315 if (Function *Callee = CI->getCalledFunction())
316 if (Callee->getName().equals(getInstrProfValueProfFuncName()))
317 if (isa<Constant>(CI->getArgOperand(0)))
318 return true;
319 return false;
320}
321
David Callahan45e442e2016-08-05 19:38:11 +0000322void AggressiveDeadCodeElimination::markLiveInstructions() {
Nadav Rotem465834c2012-07-24 10:51:42 +0000323
David Callahan947be0f2016-08-16 14:31:51 +0000324 // Propagate liveness backwards to operands.
325 do {
326 // Worklist holds newly discovered live instructions
327 // where we need to mark the inputs as live.
328 while (!Worklist.empty()) {
329 Instruction *LiveInst = Worklist.pop_back_val();
David Callahanc165a4e2016-09-19 23:17:58 +0000330 DEBUG(dbgs() << "work live: "; LiveInst->dump(););
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000331
David Callahan947be0f2016-08-16 14:31:51 +0000332 for (Use &OI : LiveInst->operands())
333 if (Instruction *Inst = dyn_cast<Instruction>(OI))
334 markLive(Inst);
David Callahanebcf9162016-12-13 16:42:18 +0000335
David Callahanc165a4e2016-09-19 23:17:58 +0000336 if (auto *PN = dyn_cast<PHINode>(LiveInst))
337 markPhiLive(PN);
Hal Finkel8626ed22015-02-15 15:51:25 +0000338 }
David Callahanebcf9162016-12-13 16:42:18 +0000339
340 // After data flow liveness has been identified, examine which branch
341 // decisions are required to determine live instructions are executed.
David Callahan947be0f2016-08-16 14:31:51 +0000342 markLiveBranchesFromControlDependences();
David Callahan012d1c02016-08-24 00:10:06 +0000343
David Callahan947be0f2016-08-16 14:31:51 +0000344 } while (!Worklist.empty());
David Callahan947be0f2016-08-16 14:31:51 +0000345}
346
347void AggressiveDeadCodeElimination::markLive(Instruction *I) {
348
349 auto &Info = InstInfo[I];
350 if (Info.Live)
351 return;
352
353 DEBUG(dbgs() << "mark live: "; I->dump());
354 Info.Live = true;
355 Worklist.push_back(I);
356
David Callahanebcf9162016-12-13 16:42:18 +0000357 // Collect the live debug info scopes attached to this instruction.
358 if (const DILocation *DL = I->getDebugLoc())
359 collectLiveScopes(*DL);
360
David Callahan947be0f2016-08-16 14:31:51 +0000361 // Mark the containing block live
362 auto &BBInfo = *Info.Block;
David Callahanebcf9162016-12-13 16:42:18 +0000363 if (BBInfo.Terminator == I) {
David Callahan947be0f2016-08-16 14:31:51 +0000364 BlocksWithDeadTerminators.erase(BBInfo.BB);
David Callahanebcf9162016-12-13 16:42:18 +0000365 // For live terminators, mark destination blocks
366 // live to preserve this control flow edges.
367 if (!BBInfo.UnconditionalBranch)
368 for (auto *BB : successors(I->getParent()))
369 markLive(BB);
370 }
371 markLive(BBInfo);
372}
373
374void AggressiveDeadCodeElimination::markLive(BlockInfoType &BBInfo) {
David Callahan947be0f2016-08-16 14:31:51 +0000375 if (BBInfo.Live)
376 return;
David Callahan947be0f2016-08-16 14:31:51 +0000377 DEBUG(dbgs() << "mark block live: " << BBInfo.BB->getName() << '\n');
378 BBInfo.Live = true;
David Callahanc165a4e2016-09-19 23:17:58 +0000379 if (!BBInfo.CFLive) {
380 BBInfo.CFLive = true;
381 NewLiveBlocks.insert(BBInfo.BB);
382 }
David Callahan947be0f2016-08-16 14:31:51 +0000383
384 // Mark unconditional branches at the end of live
385 // blocks as live since there is no work to do for them later
David Callahanebcf9162016-12-13 16:42:18 +0000386 if (BBInfo.UnconditionalBranch)
David Callahan012d1c02016-08-24 00:10:06 +0000387 markLive(BBInfo.Terminator);
David Callahan45e442e2016-08-05 19:38:11 +0000388}
389
390void AggressiveDeadCodeElimination::collectLiveScopes(const DILocalScope &LS) {
391 if (!AliveScopes.insert(&LS).second)
392 return;
David Callahan947be0f2016-08-16 14:31:51 +0000393
David Callahan45e442e2016-08-05 19:38:11 +0000394 if (isa<DISubprogram>(LS))
395 return;
David Callahan947be0f2016-08-16 14:31:51 +0000396
David Callahan45e442e2016-08-05 19:38:11 +0000397 // Tail-recurse through the scope chain.
398 collectLiveScopes(cast<DILocalScope>(*LS.getScope()));
399}
400
401void AggressiveDeadCodeElimination::collectLiveScopes(const DILocation &DL) {
402 // Even though DILocations are not scopes, shove them into AliveScopes so we
403 // don't revisit them.
404 if (!AliveScopes.insert(&DL).second)
405 return;
David Callahan947be0f2016-08-16 14:31:51 +0000406
David Callahan45e442e2016-08-05 19:38:11 +0000407 // Collect live scopes from the scope chain.
408 collectLiveScopes(*DL.getScope());
David Callahan947be0f2016-08-16 14:31:51 +0000409
David Callahan45e442e2016-08-05 19:38:11 +0000410 // Tail-recurse through the inlined-at chain.
411 if (const DILocation *IA = DL.getInlinedAt())
412 collectLiveScopes(*IA);
413}
414
David Callahanc165a4e2016-09-19 23:17:58 +0000415void AggressiveDeadCodeElimination::markPhiLive(PHINode *PN) {
416 auto &Info = BlockInfo[PN->getParent()];
417 // Only need to check this once per block.
418 if (Info.HasLivePhiNodes)
419 return;
420 Info.HasLivePhiNodes = true;
421
422 // If a predecessor block is not live, mark it as control-flow live
423 // which will trigger marking live branches upon which
424 // that block is control dependent.
425 for (auto *PredBB : predecessors(Info.BB)) {
426 auto &Info = BlockInfo[PredBB];
427 if (!Info.CFLive) {
428 Info.CFLive = true;
429 NewLiveBlocks.insert(PredBB);
430 }
431 }
432}
433
David Callahan947be0f2016-08-16 14:31:51 +0000434void AggressiveDeadCodeElimination::markLiveBranchesFromControlDependences() {
435
David Callahan012d1c02016-08-24 00:10:06 +0000436 if (BlocksWithDeadTerminators.empty())
437 return;
438
439 DEBUG({
440 dbgs() << "new live blocks:\n";
441 for (auto *BB : NewLiveBlocks)
442 dbgs() << "\t" << BB->getName() << '\n';
443 dbgs() << "dead terminator blocks:\n";
444 for (auto *BB : BlocksWithDeadTerminators)
445 dbgs() << "\t" << BB->getName() << '\n';
446 });
447
448 // The dominance frontier of a live block X in the reverse
449 // control graph is the set of blocks upon which X is control
450 // dependent. The following sequence computes the set of blocks
451 // which currently have dead terminators that are control
452 // dependence sources of a block which is in NewLiveBlocks.
453
454 SmallVector<BasicBlock *, 32> IDFBlocks;
455 ReverseIDFCalculator IDFs(PDT);
456 IDFs.setDefiningBlocks(NewLiveBlocks);
457 IDFs.setLiveInBlocks(BlocksWithDeadTerminators);
458 IDFs.calculate(IDFBlocks);
David Callahan947be0f2016-08-16 14:31:51 +0000459 NewLiveBlocks.clear();
David Callahan012d1c02016-08-24 00:10:06 +0000460
461 // Dead terminators which control live blocks are now marked live.
David Callahanebcf9162016-12-13 16:42:18 +0000462 for (auto *BB : IDFBlocks) {
David Callahan012d1c02016-08-24 00:10:06 +0000463 DEBUG(dbgs() << "live control in: " << BB->getName() << '\n');
464 markLive(BB->getTerminator());
465 }
David Callahan45e442e2016-08-05 19:38:11 +0000466}
467
David Callahanc165a4e2016-09-19 23:17:58 +0000468//===----------------------------------------------------------------------===//
469//
470// Routines to update the CFG and SSA information before removing dead code.
471//
472//===----------------------------------------------------------------------===//
David Callahan45e442e2016-08-05 19:38:11 +0000473bool AggressiveDeadCodeElimination::removeDeadInstructions() {
Nadav Rotem465834c2012-07-24 10:51:42 +0000474
David Callahanebcf9162016-12-13 16:42:18 +0000475 // Updates control and dataflow around dead blocks
476 updateDeadRegions();
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000477
David Callahanebcf9162016-12-13 16:42:18 +0000478 DEBUG({
479 for (Instruction &I : instructions(F)) {
480 // Check if the instruction is alive.
481 if (isLive(&I))
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000482 continue;
483
David Callahanebcf9162016-12-13 16:42:18 +0000484 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I)) {
485 // Check if the scope of this variable location is alive.
486 if (AliveScopes.count(DII->getDebugLoc()->getScope()))
487 continue;
488
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000489 // If intrinsic is pointing at a live SSA value, there may be an
490 // earlier optimization bug: if we know the location of the variable,
491 // why isn't the scope of the location alive?
492 if (Value *V = DII->getVariableLocation())
493 if (Instruction *II = dyn_cast<Instruction>(V))
David Callahan947be0f2016-08-16 14:31:51 +0000494 if (isLive(II))
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000495 dbgs() << "Dropping debug info for " << *DII << "\n";
David Callahanebcf9162016-12-13 16:42:18 +0000496 }
497 }
498 });
499
500 // The inverse of the live set is the dead set. These are those instructions
501 // that have no side effects and do not influence the control flow or return
502 // value of the function, and may therefore be deleted safely.
503 // NOTE: We reuse the Worklist vector here for memory efficiency.
504 for (Instruction &I : instructions(F)) {
505 // Check if the instruction is alive.
506 if (isLive(&I))
507 continue;
508
509 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I)) {
510 // Check if the scope of this variable location is alive.
511 if (AliveScopes.count(DII->getDebugLoc()->getScope()))
512 continue;
513
514 // Fallthrough and drop the intrinsic.
Chris Lattneracfd27d2001-09-09 22:26:47 +0000515 }
Duncan P. N. Exon Smithe8eb94a2016-03-29 22:57:12 +0000516
517 // Prepare to delete.
518 Worklist.push_back(&I);
519 I.dropAllReferences();
Hal Finkel92fb2d32015-02-15 15:51:23 +0000520 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000521
Hal Finkel92fb2d32015-02-15 15:51:23 +0000522 for (Instruction *&I : Worklist) {
Dan Gohmand2d1ae12010-06-22 15:08:57 +0000523 ++NumRemoved;
Hal Finkel92fb2d32015-02-15 15:51:23 +0000524 I->eraseFromParent();
Chris Lattneracfd27d2001-09-09 22:26:47 +0000525 }
Devang Patel53b39b52008-11-11 00:54:10 +0000526
Hal Finkel75901292015-02-15 15:45:28 +0000527 return !Worklist.empty();
Chris Lattnerb28986f2001-06-30 06:39:11 +0000528}
Owen Anderson7686b552008-05-29 08:45:13 +0000529
David Callahanebcf9162016-12-13 16:42:18 +0000530// A dead region is the set of dead blocks with a common live post-dominator.
531void AggressiveDeadCodeElimination::updateDeadRegions() {
532
533 DEBUG({
534 dbgs() << "final dead terminator blocks: " << '\n';
535 for (auto *BB : BlocksWithDeadTerminators)
536 dbgs() << '\t' << BB->getName()
537 << (BlockInfo[BB].Live ? " LIVE\n" : "\n");
538 });
539
540 // Don't compute the post ordering unless we needed it.
541 bool HavePostOrder = false;
542
543 for (auto *BB : BlocksWithDeadTerminators) {
544 auto &Info = BlockInfo[BB];
545 if (Info.UnconditionalBranch) {
546 InstInfo[Info.Terminator].Live = true;
547 continue;
548 }
549
550 if (!HavePostOrder) {
551 computeReversePostOrder();
552 HavePostOrder = true;
553 }
554
555 // Add an unconditional branch to the successor closest to the
556 // end of the function which insures a path to the exit for each
557 // live edge.
558 BlockInfoType *PreferredSucc = nullptr;
559 for (auto *Succ : successors(BB)) {
560 auto *Info = &BlockInfo[Succ];
561 if (!PreferredSucc || PreferredSucc->PostOrder < Info->PostOrder)
562 PreferredSucc = Info;
563 }
564 assert((PreferredSucc && PreferredSucc->PostOrder > 0) &&
Tobias Grosser335b6bf2017-03-14 10:18:11 +0000565 "Failed to find safe successor for dead branch");
Jakub Kuderski2724d452017-08-22 16:30:21 +0000566
567 // Collect removed successors to update the (Post)DominatorTrees.
568 SmallPtrSet<BasicBlock *, 4> RemovedSuccessors;
David Callahanebcf9162016-12-13 16:42:18 +0000569 bool First = true;
570 for (auto *Succ : successors(BB)) {
Jakub Kuderski2724d452017-08-22 16:30:21 +0000571 if (!First || Succ != PreferredSucc->BB) {
David Callahanebcf9162016-12-13 16:42:18 +0000572 Succ->removePredecessor(BB);
Jakub Kuderski2724d452017-08-22 16:30:21 +0000573 RemovedSuccessors.insert(Succ);
574 } else
David Callahanebcf9162016-12-13 16:42:18 +0000575 First = false;
576 }
577 makeUnconditional(BB, PreferredSucc->BB);
Jakub Kuderski2724d452017-08-22 16:30:21 +0000578
579 // Inform the dominators about the deleted CFG edges.
580 SmallVector<DominatorTree::UpdateType, 4> DeletedEdges;
581 for (auto *Succ : RemovedSuccessors) {
582 // It might have happened that the same successor appeared multiple times
583 // and the CFG edge wasn't really removed.
584 if (Succ != PreferredSucc->BB) {
585 DEBUG(dbgs() << "ADCE: (Post)DomTree edge enqueued for deletion"
586 << BB->getName() << " -> " << Succ->getName() << "\n");
587 DeletedEdges.push_back({DominatorTree::Delete, BB, Succ});
588 }
589 }
590
591 DT.applyUpdates(DeletedEdges);
592 PDT.applyUpdates(DeletedEdges);
593
David Callahanebcf9162016-12-13 16:42:18 +0000594 NumBranchesRemoved += 1;
595 }
596}
597
598// reverse top-sort order
599void AggressiveDeadCodeElimination::computeReversePostOrder() {
Taewook Ohd3f1ec92017-01-26 04:32:40 +0000600
Tobias Grosser335b6bf2017-03-14 10:18:11 +0000601 // This provides a post-order numbering of the reverse control flow graph
David Callahanebcf9162016-12-13 16:42:18 +0000602 // Note that it is incomplete in the presence of infinite loops but we don't
603 // need numbers blocks which don't reach the end of the functions since
604 // all branches in those blocks are forced live.
Taewook Ohd3f1ec92017-01-26 04:32:40 +0000605
Tobias Grosser335b6bf2017-03-14 10:18:11 +0000606 // For each block without successors, extend the DFS from the block
David Callahanebcf9162016-12-13 16:42:18 +0000607 // backward through the graph
608 SmallPtrSet<BasicBlock*, 16> Visited;
609 unsigned PostOrder = 0;
610 for (auto &BB : F) {
611 if (succ_begin(&BB) != succ_end(&BB))
612 continue;
613 for (BasicBlock *Block : inverse_post_order_ext(&BB,Visited))
614 BlockInfo[Block].PostOrder = PostOrder++;
615 }
616}
617
618void AggressiveDeadCodeElimination::makeUnconditional(BasicBlock *BB,
619 BasicBlock *Target) {
620 TerminatorInst *PredTerm = BB->getTerminator();
621 // Collect the live debug info scopes attached to this instruction.
622 if (const DILocation *DL = PredTerm->getDebugLoc())
623 collectLiveScopes(*DL);
624
625 // Just mark live an existing unconditional branch
626 if (isUnconditionalBranch(PredTerm)) {
627 PredTerm->setSuccessor(0, Target);
628 InstInfo[PredTerm].Live = true;
629 return;
630 }
631 DEBUG(dbgs() << "making unconditional " << BB->getName() << '\n');
632 NumBranchesRemoved += 1;
633 IRBuilder<> Builder(PredTerm);
634 auto *NewTerm = Builder.CreateBr(Target);
635 InstInfo[NewTerm].Live = true;
636 if (const DILocation *DL = PredTerm->getDebugLoc())
637 NewTerm->setDebugLoc(DL);
Jakub Kuderski2724d452017-08-22 16:30:21 +0000638
639 InstInfo.erase(PredTerm);
640 PredTerm->eraseFromParent();
David Callahanebcf9162016-12-13 16:42:18 +0000641}
642
David Callahan012d1c02016-08-24 00:10:06 +0000643//===----------------------------------------------------------------------===//
644//
645// Pass Manager integration code
646//
647//===----------------------------------------------------------------------===//
648PreservedAnalyses ADCEPass::run(Function &F, FunctionAnalysisManager &FAM) {
Jakub Kuderski2724d452017-08-22 16:30:21 +0000649 auto &DT = FAM.getResult<DominatorTreeAnalysis>(F);
David Callahan012d1c02016-08-24 00:10:06 +0000650 auto &PDT = FAM.getResult<PostDominatorTreeAnalysis>(F);
Jakub Kuderski2724d452017-08-22 16:30:21 +0000651 if (!AggressiveDeadCodeElimination(F, DT, PDT).performDeadCodeElimination())
Davide Italiano688616f2016-05-31 17:39:39 +0000652 return PreservedAnalyses::all();
653
Chandler Carruthca68a3e2017-01-15 06:32:49 +0000654 PreservedAnalyses PA;
655 PA.preserveSet<CFGAnalyses>();
Davide Italiano688616f2016-05-31 17:39:39 +0000656 PA.preserve<GlobalsAA>();
Jakub Kuderski2724d452017-08-22 16:30:21 +0000657 PA.preserve<DominatorTreeAnalysis>();
658 PA.preserve<PostDominatorTreeAnalysis>();
Davide Italiano688616f2016-05-31 17:39:39 +0000659 return PA;
Duncan Sands9e064a22008-05-29 14:38:23 +0000660}
Justin Bogner19b67992015-10-30 23:13:18 +0000661
662namespace {
663struct ADCELegacyPass : public FunctionPass {
664 static char ID; // Pass identification, replacement for typeid
665 ADCELegacyPass() : FunctionPass(ID) {
666 initializeADCELegacyPassPass(*PassRegistry::getPassRegistry());
667 }
668
David Callahancc5cd4d2016-08-03 04:28:39 +0000669 bool runOnFunction(Function &F) override {
Andrew Kayloraa641a52016-04-22 22:06:11 +0000670 if (skipFunction(F))
Justin Bogner19b67992015-10-30 23:13:18 +0000671 return false;
Jakub Kuderski2724d452017-08-22 16:30:21 +0000672
673 auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
David Callahan012d1c02016-08-24 00:10:06 +0000674 auto &PDT = getAnalysis<PostDominatorTreeWrapperPass>().getPostDomTree();
Jakub Kuderski2724d452017-08-22 16:30:21 +0000675 return AggressiveDeadCodeElimination(F, DT, PDT)
676 .performDeadCodeElimination();
Justin Bogner19b67992015-10-30 23:13:18 +0000677 }
678
David Callahancc5cd4d2016-08-03 04:28:39 +0000679 void getAnalysisUsage(AnalysisUsage &AU) const override {
Jakub Kuderski2724d452017-08-22 16:30:21 +0000680 // We require DominatorTree here only to update and thus preserve it.
681 AU.addRequired<DominatorTreeWrapperPass>();
David Callahan012d1c02016-08-24 00:10:06 +0000682 AU.addRequired<PostDominatorTreeWrapperPass>();
David Callahanebcf9162016-12-13 16:42:18 +0000683 if (!RemoveControlFlowFlag)
684 AU.setPreservesCFG();
Jakub Kuderski2724d452017-08-22 16:30:21 +0000685 else {
686 AU.addPreserved<DominatorTreeWrapperPass>();
687 AU.addPreserved<PostDominatorTreeWrapperPass>();
688 }
Justin Bogner19b67992015-10-30 23:13:18 +0000689 AU.addPreserved<GlobalsAAWrapperPass>();
690 }
691};
692}
693
694char ADCELegacyPass::ID = 0;
David Callahan012d1c02016-08-24 00:10:06 +0000695INITIALIZE_PASS_BEGIN(ADCELegacyPass, "adce",
696 "Aggressive Dead Code Elimination", false, false)
Jakub Kuderski2724d452017-08-22 16:30:21 +0000697INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
David Callahan012d1c02016-08-24 00:10:06 +0000698INITIALIZE_PASS_DEPENDENCY(PostDominatorTreeWrapperPass)
699INITIALIZE_PASS_END(ADCELegacyPass, "adce", "Aggressive Dead Code Elimination",
700 false, false)
Justin Bogner19b67992015-10-30 23:13:18 +0000701
702FunctionPass *llvm::createAggressiveDCEPass() { return new ADCELegacyPass(); }