blob: 9d0be8be9c4ea2282ec57ec8910ba4e42dc0709f [file] [log] [blame]
Chris Lattner4d1e46e2002-05-07 18:07:59 +00001//===-- Local.cpp - Functions to perform local transformations ------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-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 Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner4d1e46e2002-05-07 18:07:59 +00009//
10// This family of functions perform various local transformations to the
11// program.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/Transforms/Utils/Local.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000016#include "llvm/ADT/DenseMap.h"
Evgeniy Stepanov3333e662012-12-21 11:18:49 +000017#include "llvm/ADT/STLExtras.h"
Chandler Carruth58a2cbe2013-01-02 10:22:59 +000018#include "llvm/ADT/SmallPtrSet.h"
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +000019#include "llvm/ADT/Statistic.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000020#include "llvm/Analysis/InstructionSimplify.h"
21#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000022#include "llvm/Analysis/ValueTracking.h"
Stephen Hines36b56882014-04-23 16:57:46 -070023#include "llvm/IR/CFG.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000024#include "llvm/IR/Constants.h"
Stephen Hines36b56882014-04-23 16:57:46 -070025#include "llvm/IR/DIBuilder.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000026#include "llvm/IR/DataLayout.h"
Stephen Hines36b56882014-04-23 16:57:46 -070027#include "llvm/IR/DebugInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000028#include "llvm/IR/DerivedTypes.h"
Stephen Hines36b56882014-04-23 16:57:46 -070029#include "llvm/IR/Dominators.h"
30#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000031#include "llvm/IR/GlobalAlias.h"
32#include "llvm/IR/GlobalVariable.h"
33#include "llvm/IR/IRBuilder.h"
34#include "llvm/IR/Instructions.h"
35#include "llvm/IR/IntrinsicInst.h"
36#include "llvm/IR/Intrinsics.h"
37#include "llvm/IR/MDBuilder.h"
38#include "llvm/IR/Metadata.h"
39#include "llvm/IR/Operator.h"
Stephen Hines36b56882014-04-23 16:57:46 -070040#include "llvm/IR/ValueHandle.h"
Chris Lattnerdce94d92009-11-10 05:59:26 +000041#include "llvm/Support/Debug.h"
Chris Lattnerc5f52e62005-09-26 05:27:10 +000042#include "llvm/Support/MathExtras.h"
Chris Lattnerdce94d92009-11-10 05:59:26 +000043#include "llvm/Support/raw_ostream.h"
Chris Lattnerabbc2dd2003-12-19 05:56:28 +000044using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000045
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +000046STATISTIC(NumRemoved, "Number of unreachable basic blocks removed");
47
Chris Lattner4d1e46e2002-05-07 18:07:59 +000048//===----------------------------------------------------------------------===//
Chris Lattner3481f242008-11-27 22:57:53 +000049// Local constant propagation.
Chris Lattner4d1e46e2002-05-07 18:07:59 +000050//
51
Frits van Bommel5649ba72011-05-22 16:24:18 +000052/// ConstantFoldTerminator - If a terminator instruction is predicated on a
53/// constant value, convert it into an unconditional branch to the constant
54/// destination. This is a nontrivial operation because the successors of this
55/// basic block must have their PHI nodes updated.
56/// Also calls RecursivelyDeleteTriviallyDeadInstructions() on any branch/switch
57/// conditions and indirectbr addresses this might make dead if
58/// DeleteDeadConditions is true.
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +000059bool llvm::ConstantFoldTerminator(BasicBlock *BB, bool DeleteDeadConditions,
60 const TargetLibraryInfo *TLI) {
Chris Lattner76ae3442002-05-21 20:04:50 +000061 TerminatorInst *T = BB->getTerminator();
Devang Patel62fb3552011-05-18 17:26:46 +000062 IRBuilder<> Builder(T);
Misha Brukmanfd939082005-04-21 23:48:37 +000063
Chris Lattner4d1e46e2002-05-07 18:07:59 +000064 // Branch - See if we are conditional jumping on constant
65 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
66 if (BI->isUnconditional()) return false; // Can't optimize uncond branch
Gabor Greifc1bb13f2009-01-30 18:21:13 +000067 BasicBlock *Dest1 = BI->getSuccessor(0);
68 BasicBlock *Dest2 = BI->getSuccessor(1);
Chris Lattner4d1e46e2002-05-07 18:07:59 +000069
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +000070 if (ConstantInt *Cond = dyn_cast<ConstantInt>(BI->getCondition())) {
Chris Lattner4d1e46e2002-05-07 18:07:59 +000071 // Are we branching on constant?
72 // YES. Change to unconditional branch...
Reid Spencer579dca12007-01-12 04:24:46 +000073 BasicBlock *Destination = Cond->getZExtValue() ? Dest1 : Dest2;
74 BasicBlock *OldDest = Cond->getZExtValue() ? Dest2 : Dest1;
Chris Lattner4d1e46e2002-05-07 18:07:59 +000075
Misha Brukmanfd939082005-04-21 23:48:37 +000076 //cerr << "Function: " << T->getParent()->getParent()
77 // << "\nRemoving branch from " << T->getParent()
Chris Lattner4d1e46e2002-05-07 18:07:59 +000078 // << "\n\nTo: " << OldDest << endl;
79
80 // Let the basic block know that we are letting go of it. Based on this,
81 // it will adjust it's PHI nodes.
Jay Foad1a039022011-04-19 15:23:29 +000082 OldDest->removePredecessor(BB);
Chris Lattner4d1e46e2002-05-07 18:07:59 +000083
Jay Foad8f9ffbd2011-01-07 20:25:56 +000084 // Replace the conditional branch with an unconditional one.
Devang Patel62fb3552011-05-18 17:26:46 +000085 Builder.CreateBr(Destination);
Jay Foad8f9ffbd2011-01-07 20:25:56 +000086 BI->eraseFromParent();
Chris Lattner4d1e46e2002-05-07 18:07:59 +000087 return true;
Chris Lattner0a4c6782009-11-01 03:40:38 +000088 }
Jakub Staszaka18c5742013-07-22 23:16:36 +000089
Chris Lattner0a4c6782009-11-01 03:40:38 +000090 if (Dest2 == Dest1) { // Conditional branch to same location?
Misha Brukmanfd939082005-04-21 23:48:37 +000091 // This branch matches something like this:
Chris Lattner4d1e46e2002-05-07 18:07:59 +000092 // br bool %cond, label %Dest, label %Dest
93 // and changes it into: br label %Dest
94
95 // Let the basic block know that we are letting go of one copy of it.
96 assert(BI->getParent() && "Terminator not inserted in block!");
97 Dest1->removePredecessor(BI->getParent());
98
Jay Foad8f9ffbd2011-01-07 20:25:56 +000099 // Replace the conditional branch with an unconditional one.
Devang Patel62fb3552011-05-18 17:26:46 +0000100 Builder.CreateBr(Dest1);
Frits van Bommel5649ba72011-05-22 16:24:18 +0000101 Value *Cond = BI->getCondition();
Jay Foad8f9ffbd2011-01-07 20:25:56 +0000102 BI->eraseFromParent();
Frits van Bommel5649ba72011-05-22 16:24:18 +0000103 if (DeleteDeadConditions)
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000104 RecursivelyDeleteTriviallyDeadInstructions(Cond, TLI);
Chris Lattner4d1e46e2002-05-07 18:07:59 +0000105 return true;
106 }
Chris Lattner0a4c6782009-11-01 03:40:38 +0000107 return false;
108 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000109
Chris Lattner0a4c6782009-11-01 03:40:38 +0000110 if (SwitchInst *SI = dyn_cast<SwitchInst>(T)) {
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000111 // If we are switching on a constant, we can convert the switch into a
112 // single branch instruction!
113 ConstantInt *CI = dyn_cast<ConstantInt>(SI->getCondition());
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +0000114 BasicBlock *TheOnlyDest = SI->getDefaultDest();
Chris Lattner7d6c24c2003-08-23 23:18:19 +0000115 BasicBlock *DefaultDest = TheOnlyDest;
Chris Lattner694e37f2003-08-17 19:41:53 +0000116
Chris Lattner0a4c6782009-11-01 03:40:38 +0000117 // Figure out which case it goes to.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +0000118 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +0000119 i != e; ++i) {
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000120 // Found case matching a constant operand?
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +0000121 if (i.getCaseValue() == CI) {
122 TheOnlyDest = i.getCaseSuccessor();
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000123 break;
124 }
Chris Lattner694e37f2003-08-17 19:41:53 +0000125
Chris Lattner7d6c24c2003-08-23 23:18:19 +0000126 // Check to see if this branch is going to the same place as the default
127 // dest. If so, eliminate it as an explicit compare.
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +0000128 if (i.getCaseSuccessor() == DefaultDest) {
Manman Renee99c7f2012-09-12 17:04:11 +0000129 MDNode* MD = SI->getMetadata(LLVMContext::MD_prof);
Stephen Hines36b56882014-04-23 16:57:46 -0700130 unsigned NCases = SI->getNumCases();
131 // Fold the case metadata into the default if there will be any branches
132 // left, unless the metadata doesn't match the switch.
133 if (NCases > 1 && MD && MD->getNumOperands() == 2 + NCases) {
Manman Renee99c7f2012-09-12 17:04:11 +0000134 // Collect branch weights into a vector.
135 SmallVector<uint32_t, 8> Weights;
136 for (unsigned MD_i = 1, MD_e = MD->getNumOperands(); MD_i < MD_e;
137 ++MD_i) {
138 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(MD_i));
139 assert(CI);
140 Weights.push_back(CI->getValue().getZExtValue());
141 }
142 // Merge weight of this case to the default weight.
143 unsigned idx = i.getCaseIndex();
144 Weights[0] += Weights[idx+1];
145 // Remove weight for this case.
146 std::swap(Weights[idx+1], Weights.back());
147 Weights.pop_back();
148 SI->setMetadata(LLVMContext::MD_prof,
149 MDBuilder(BB->getContext()).
150 createBranchWeights(Weights));
151 }
Chris Lattner0a4c6782009-11-01 03:40:38 +0000152 // Remove this entry.
Chris Lattner7d6c24c2003-08-23 23:18:19 +0000153 DefaultDest->removePredecessor(SI->getParent());
154 SI->removeCase(i);
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +0000155 --i; --e;
Chris Lattner7d6c24c2003-08-23 23:18:19 +0000156 continue;
157 }
158
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000159 // Otherwise, check to see if the switch only branches to one destination.
160 // We do this by reseting "TheOnlyDest" to null when we find two non-equal
161 // destinations.
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +0000162 if (i.getCaseSuccessor() != TheOnlyDest) TheOnlyDest = 0;
Chris Lattner694e37f2003-08-17 19:41:53 +0000163 }
164
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000165 if (CI && !TheOnlyDest) {
166 // Branching on a constant, but not any of the cases, go to the default
167 // successor.
168 TheOnlyDest = SI->getDefaultDest();
169 }
170
171 // If we found a single destination that we can fold the switch into, do so
172 // now.
173 if (TheOnlyDest) {
Chris Lattner0a4c6782009-11-01 03:40:38 +0000174 // Insert the new branch.
Devang Patel62fb3552011-05-18 17:26:46 +0000175 Builder.CreateBr(TheOnlyDest);
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000176 BasicBlock *BB = SI->getParent();
177
178 // Remove entries from PHI nodes which we no longer branch to...
179 for (unsigned i = 0, e = SI->getNumSuccessors(); i != e; ++i) {
180 // Found case matching a constant operand?
181 BasicBlock *Succ = SI->getSuccessor(i);
182 if (Succ == TheOnlyDest)
183 TheOnlyDest = 0; // Don't modify the first branch to TheOnlyDest
184 else
185 Succ->removePredecessor(BB);
186 }
187
Chris Lattner0a4c6782009-11-01 03:40:38 +0000188 // Delete the old switch.
Frits van Bommel5649ba72011-05-22 16:24:18 +0000189 Value *Cond = SI->getCondition();
190 SI->eraseFromParent();
191 if (DeleteDeadConditions)
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000192 RecursivelyDeleteTriviallyDeadInstructions(Cond, TLI);
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000193 return true;
Chris Lattner0a4c6782009-11-01 03:40:38 +0000194 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000195
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +0000196 if (SI->getNumCases() == 1) {
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000197 // Otherwise, we can fold this switch into a conditional branch
198 // instruction if it has only one non-default destination.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +0000199 SwitchInst::CaseIt FirstCase = SI->case_begin();
Bob Wilsondb3a9e62013-09-09 19:14:35 +0000200 Value *Cond = Builder.CreateICmpEQ(SI->getCondition(),
201 FirstCase.getCaseValue(), "cond");
Devang Patel62fb3552011-05-18 17:26:46 +0000202
Bob Wilsondb3a9e62013-09-09 19:14:35 +0000203 // Insert the new branch.
204 BranchInst *NewBr = Builder.CreateCondBr(Cond,
205 FirstCase.getCaseSuccessor(),
206 SI->getDefaultDest());
207 MDNode* MD = SI->getMetadata(LLVMContext::MD_prof);
208 if (MD && MD->getNumOperands() == 3) {
209 ConstantInt *SICase = dyn_cast<ConstantInt>(MD->getOperand(2));
210 ConstantInt *SIDef = dyn_cast<ConstantInt>(MD->getOperand(1));
211 assert(SICase && SIDef);
212 // The TrueWeight should be the weight for the single case of SI.
213 NewBr->setMetadata(LLVMContext::MD_prof,
214 MDBuilder(BB->getContext()).
215 createBranchWeights(SICase->getValue().getZExtValue(),
216 SIDef->getValue().getZExtValue()));
Stepan Dyatkovskiya2067fb2012-05-23 08:18:26 +0000217 }
Bob Wilsondb3a9e62013-09-09 19:14:35 +0000218
219 // Delete the old switch.
220 SI->eraseFromParent();
221 return true;
Chris Lattner10b1f5a2003-08-17 20:21:14 +0000222 }
Chris Lattner0a4c6782009-11-01 03:40:38 +0000223 return false;
Chris Lattner4d1e46e2002-05-07 18:07:59 +0000224 }
Chris Lattner0a4c6782009-11-01 03:40:38 +0000225
226 if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(T)) {
227 // indirectbr blockaddress(@F, @BB) -> br label @BB
228 if (BlockAddress *BA =
229 dyn_cast<BlockAddress>(IBI->getAddress()->stripPointerCasts())) {
230 BasicBlock *TheOnlyDest = BA->getBasicBlock();
231 // Insert the new branch.
Devang Patel62fb3552011-05-18 17:26:46 +0000232 Builder.CreateBr(TheOnlyDest);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000233
Chris Lattner0a4c6782009-11-01 03:40:38 +0000234 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
235 if (IBI->getDestination(i) == TheOnlyDest)
236 TheOnlyDest = 0;
237 else
238 IBI->getDestination(i)->removePredecessor(IBI->getParent());
239 }
Frits van Bommel5649ba72011-05-22 16:24:18 +0000240 Value *Address = IBI->getAddress();
Chris Lattner0a4c6782009-11-01 03:40:38 +0000241 IBI->eraseFromParent();
Frits van Bommel5649ba72011-05-22 16:24:18 +0000242 if (DeleteDeadConditions)
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000243 RecursivelyDeleteTriviallyDeadInstructions(Address, TLI);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000244
Chris Lattner0a4c6782009-11-01 03:40:38 +0000245 // If we didn't find our destination in the IBI successor list, then we
246 // have undefined behavior. Replace the unconditional branch with an
247 // 'unreachable' instruction.
248 if (TheOnlyDest) {
249 BB->getTerminator()->eraseFromParent();
250 new UnreachableInst(BB->getContext(), BB);
251 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000252
Chris Lattner0a4c6782009-11-01 03:40:38 +0000253 return true;
254 }
255 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000256
Chris Lattner4d1e46e2002-05-07 18:07:59 +0000257 return false;
258}
259
Chris Lattner4d1e46e2002-05-07 18:07:59 +0000260
261//===----------------------------------------------------------------------===//
Chris Lattner40d8c282009-11-10 22:26:15 +0000262// Local dead code elimination.
Chris Lattner4d1e46e2002-05-07 18:07:59 +0000263//
264
Chris Lattner3481f242008-11-27 22:57:53 +0000265/// isInstructionTriviallyDead - Return true if the result produced by the
266/// instruction is not used, and the instruction has no side effects.
267///
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000268bool llvm::isInstructionTriviallyDead(Instruction *I,
269 const TargetLibraryInfo *TLI) {
Chris Lattnerec710c52005-05-06 05:27:34 +0000270 if (!I->use_empty() || isa<TerminatorInst>(I)) return false;
Jeff Cohen00b168892005-07-27 06:12:32 +0000271
Bill Wendling187b1922011-08-15 20:10:51 +0000272 // We don't want the landingpad instruction removed by anything this general.
273 if (isa<LandingPadInst>(I))
274 return false;
275
Devang Patel9c5822a2011-03-18 23:28:02 +0000276 // We don't want debug info removed by anything this general, unless
277 // debug info is empty.
278 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(I)) {
Nick Lewycky3e69c132011-08-02 21:19:27 +0000279 if (DDI->getAddress())
Devang Patel9c5822a2011-03-18 23:28:02 +0000280 return false;
Devang Patelb9946212011-03-21 22:04:45 +0000281 return true;
Nick Lewycky3e69c132011-08-02 21:19:27 +0000282 }
Devang Patelb9946212011-03-21 22:04:45 +0000283 if (DbgValueInst *DVI = dyn_cast<DbgValueInst>(I)) {
Devang Patel9c5822a2011-03-18 23:28:02 +0000284 if (DVI->getValue())
285 return false;
Devang Patelb9946212011-03-21 22:04:45 +0000286 return true;
Devang Patel9c5822a2011-03-18 23:28:02 +0000287 }
288
Duncan Sands7af1c782009-05-06 06:49:50 +0000289 if (!I->mayHaveSideEffects()) return true;
290
291 // Special case intrinsics that "may have side effects" but can be deleted
292 // when dead.
Nick Lewycky3e69c132011-08-02 21:19:27 +0000293 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
Chris Lattner741c0ae2007-12-29 00:59:12 +0000294 // Safe to delete llvm.stacksave if dead.
295 if (II->getIntrinsicID() == Intrinsic::stacksave)
296 return true;
Nick Lewycky3e69c132011-08-02 21:19:27 +0000297
298 // Lifetime intrinsics are dead when their right-hand is undef.
299 if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
300 II->getIntrinsicID() == Intrinsic::lifetime_end)
301 return isa<UndefValue>(II->getArgOperand(1));
302 }
Nick Lewycky4a3935c2011-10-24 04:35:36 +0000303
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000304 if (isAllocLikeFn(I, TLI)) return true;
Nick Lewycky4a3935c2011-10-24 04:35:36 +0000305
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000306 if (CallInst *CI = isFreeCall(I, TLI))
Nick Lewycky4a3935c2011-10-24 04:35:36 +0000307 if (Constant *C = dyn_cast<Constant>(CI->getArgOperand(0)))
308 return C->isNullValue() || isa<UndefValue>(C);
309
Chris Lattnerec710c52005-05-06 05:27:34 +0000310 return false;
Chris Lattner4d1e46e2002-05-07 18:07:59 +0000311}
312
Chris Lattner3481f242008-11-27 22:57:53 +0000313/// RecursivelyDeleteTriviallyDeadInstructions - If the specified value is a
314/// trivially dead instruction, delete it. If that makes any of its operands
Dan Gohman90fe0bd2010-01-05 15:45:31 +0000315/// trivially dead, delete them too, recursively. Return true if any
316/// instructions were deleted.
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000317bool
318llvm::RecursivelyDeleteTriviallyDeadInstructions(Value *V,
319 const TargetLibraryInfo *TLI) {
Chris Lattner3481f242008-11-27 22:57:53 +0000320 Instruction *I = dyn_cast<Instruction>(V);
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000321 if (!I || !I->use_empty() || !isInstructionTriviallyDead(I, TLI))
Dan Gohman90fe0bd2010-01-05 15:45:31 +0000322 return false;
Jakub Staszaka18c5742013-07-22 23:16:36 +0000323
Chris Lattner76057302008-11-28 01:20:46 +0000324 SmallVector<Instruction*, 16> DeadInsts;
325 DeadInsts.push_back(I);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000326
Dan Gohman321a8132010-01-05 16:27:25 +0000327 do {
Dan Gohmane9d87f42009-05-06 17:22:41 +0000328 I = DeadInsts.pop_back_val();
Chris Lattner28721772008-11-28 00:58:15 +0000329
Chris Lattner76057302008-11-28 01:20:46 +0000330 // Null out all of the instruction's operands to see if any operand becomes
331 // dead as we go.
332 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
333 Value *OpV = I->getOperand(i);
334 I->setOperand(i, 0);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000335
Chris Lattner76057302008-11-28 01:20:46 +0000336 if (!OpV->use_empty()) continue;
Jakub Staszaka18c5742013-07-22 23:16:36 +0000337
Chris Lattner76057302008-11-28 01:20:46 +0000338 // If the operand is an instruction that became dead as we nulled out the
339 // operand, and if it is 'trivially' dead, delete it in a future loop
340 // iteration.
341 if (Instruction *OpI = dyn_cast<Instruction>(OpV))
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000342 if (isInstructionTriviallyDead(OpI, TLI))
Chris Lattner76057302008-11-28 01:20:46 +0000343 DeadInsts.push_back(OpI);
344 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000345
Chris Lattner76057302008-11-28 01:20:46 +0000346 I->eraseFromParent();
Dan Gohman321a8132010-01-05 16:27:25 +0000347 } while (!DeadInsts.empty());
Dan Gohman90fe0bd2010-01-05 15:45:31 +0000348
349 return true;
Chris Lattner4d1e46e2002-05-07 18:07:59 +0000350}
Chris Lattnerb29714a2008-11-27 07:43:12 +0000351
Nick Lewycky1a4021a2011-02-20 08:38:20 +0000352/// areAllUsesEqual - Check whether the uses of a value are all the same.
353/// This is similar to Instruction::hasOneUse() except this will also return
Duncan Sandsb4098ba2011-02-21 16:27:36 +0000354/// true when there are no uses or multiple uses that all refer to the same
355/// value.
Nick Lewycky1a4021a2011-02-20 08:38:20 +0000356static bool areAllUsesEqual(Instruction *I) {
Stephen Hines36b56882014-04-23 16:57:46 -0700357 Value::user_iterator UI = I->user_begin();
358 Value::user_iterator UE = I->user_end();
Nick Lewycky1a4021a2011-02-20 08:38:20 +0000359 if (UI == UE)
Duncan Sandsb4098ba2011-02-21 16:27:36 +0000360 return true;
Nick Lewycky1a4021a2011-02-20 08:38:20 +0000361
362 User *TheUse = *UI;
363 for (++UI; UI != UE; ++UI) {
364 if (*UI != TheUse)
365 return false;
366 }
367 return true;
368}
369
Dan Gohmanafc36a92009-05-02 18:29:22 +0000370/// RecursivelyDeleteDeadPHINode - If the specified value is an effectively
371/// dead PHI node, due to being a def-use chain of single-use nodes that
372/// either forms a cycle or is terminated by a trivially dead instruction,
373/// delete it. If that makes any of its operands trivially dead, delete them
Duncan Sands2cfbf012011-02-21 17:32:05 +0000374/// too, recursively. Return true if a change was made.
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000375bool llvm::RecursivelyDeleteDeadPHINode(PHINode *PN,
376 const TargetLibraryInfo *TLI) {
Duncan Sandsb4098ba2011-02-21 16:27:36 +0000377 SmallPtrSet<Instruction*, 4> Visited;
378 for (Instruction *I = PN; areAllUsesEqual(I) && !I->mayHaveSideEffects();
Stephen Hines36b56882014-04-23 16:57:46 -0700379 I = cast<Instruction>(*I->user_begin())) {
Duncan Sandsb4098ba2011-02-21 16:27:36 +0000380 if (I->use_empty())
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000381 return RecursivelyDeleteTriviallyDeadInstructions(I, TLI);
Nick Lewyckyeff5e692011-02-20 18:05:56 +0000382
Duncan Sandsb4098ba2011-02-21 16:27:36 +0000383 // If we find an instruction more than once, we're on a cycle that
Dan Gohmanafc36a92009-05-02 18:29:22 +0000384 // won't prove fruitful.
Duncan Sandsb4098ba2011-02-21 16:27:36 +0000385 if (!Visited.insert(I)) {
386 // Break the cycle and delete the instruction and its operands.
387 I->replaceAllUsesWith(UndefValue::get(I->getType()));
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000388 (void)RecursivelyDeleteTriviallyDeadInstructions(I, TLI);
Duncan Sands2cfbf012011-02-21 17:32:05 +0000389 return true;
Duncan Sandsb4098ba2011-02-21 16:27:36 +0000390 }
391 }
392 return false;
Dan Gohmanafc36a92009-05-02 18:29:22 +0000393}
Chris Lattner3481f242008-11-27 22:57:53 +0000394
Chris Lattnere234a302010-01-12 19:40:54 +0000395/// SimplifyInstructionsInBlock - Scan the specified basic block and try to
396/// simplify any instructions in it and recursively delete dead instructions.
397///
398/// This returns true if it changed the code, note that it can delete
399/// instructions in other blocks as well in this block.
Micah Villmow3574eca2012-10-08 16:38:25 +0000400bool llvm::SimplifyInstructionsInBlock(BasicBlock *BB, const DataLayout *TD,
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000401 const TargetLibraryInfo *TLI) {
Chris Lattnere234a302010-01-12 19:40:54 +0000402 bool MadeChange = false;
Chandler Carruthacdae3e2012-03-25 03:29:25 +0000403
404#ifndef NDEBUG
405 // In debug builds, ensure that the terminator of the block is never replaced
406 // or deleted by these simplifications. The idea of simplification is that it
407 // cannot introduce new instructions, and there is no way to replace the
408 // terminator of a block without introducing a new instruction.
409 AssertingVH<Instruction> TerminatorVH(--BB->end());
410#endif
411
Chandler Carruth858cd1c2012-03-24 23:03:27 +0000412 for (BasicBlock::iterator BI = BB->begin(), E = --BB->end(); BI != E; ) {
413 assert(!BI->isTerminator());
Chris Lattnere234a302010-01-12 19:40:54 +0000414 Instruction *Inst = BI++;
Chandler Carruth6b980542012-03-24 21:11:24 +0000415
416 WeakVH BIHandle(BI);
Benjamin Kramerd7215202013-09-24 16:37:40 +0000417 if (recursivelySimplifyInstruction(Inst, TD, TLI)) {
Chris Lattnere234a302010-01-12 19:40:54 +0000418 MadeChange = true;
Chris Lattner35a939b2010-07-15 06:06:04 +0000419 if (BIHandle != BI)
Chris Lattnere234a302010-01-12 19:40:54 +0000420 BI = BB->begin();
421 continue;
422 }
Eli Friedman71ad2c92011-04-02 22:45:17 +0000423
Benjamin Kramer8e0d1c02012-08-29 15:32:21 +0000424 MadeChange |= RecursivelyDeleteTriviallyDeadInstructions(Inst, TLI);
Eli Friedman71ad2c92011-04-02 22:45:17 +0000425 if (BIHandle != BI)
426 BI = BB->begin();
Chris Lattnere234a302010-01-12 19:40:54 +0000427 }
428 return MadeChange;
429}
430
Chris Lattnerb29714a2008-11-27 07:43:12 +0000431//===----------------------------------------------------------------------===//
Chris Lattner40d8c282009-11-10 22:26:15 +0000432// Control Flow Graph Restructuring.
Chris Lattnerb29714a2008-11-27 07:43:12 +0000433//
434
Chris Lattner40d8c282009-11-10 22:26:15 +0000435
436/// RemovePredecessorAndSimplify - Like BasicBlock::removePredecessor, this
437/// method is called when we're about to delete Pred as a predecessor of BB. If
438/// BB contains any PHI nodes, this drops the entries in the PHI nodes for Pred.
439///
440/// Unlike the removePredecessor method, this attempts to simplify uses of PHI
441/// nodes that collapse into identity values. For example, if we have:
442/// x = phi(1, 0, 0, 0)
443/// y = and x, z
444///
445/// .. and delete the predecessor corresponding to the '1', this will attempt to
446/// recursively fold the and to 0.
447void llvm::RemovePredecessorAndSimplify(BasicBlock *BB, BasicBlock *Pred,
Micah Villmow3574eca2012-10-08 16:38:25 +0000448 DataLayout *TD) {
Chris Lattner40d8c282009-11-10 22:26:15 +0000449 // This only adjusts blocks with PHI nodes.
450 if (!isa<PHINode>(BB->begin()))
451 return;
Jakub Staszaka18c5742013-07-22 23:16:36 +0000452
Chris Lattner40d8c282009-11-10 22:26:15 +0000453 // Remove the entries for Pred from the PHI nodes in BB, but do not simplify
454 // them down. This will leave us with single entry phi nodes and other phis
455 // that can be removed.
456 BB->removePredecessor(Pred, true);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000457
Chris Lattner40d8c282009-11-10 22:26:15 +0000458 WeakVH PhiIt = &BB->front();
459 while (PHINode *PN = dyn_cast<PHINode>(PhiIt)) {
460 PhiIt = &*++BasicBlock::iterator(cast<Instruction>(PhiIt));
Chris Lattner35a939b2010-07-15 06:06:04 +0000461 Value *OldPhiIt = PhiIt;
Chandler Carruth6b980542012-03-24 21:11:24 +0000462
463 if (!recursivelySimplifyInstruction(PN, TD))
464 continue;
465
Chris Lattner40d8c282009-11-10 22:26:15 +0000466 // If recursive simplification ended up deleting the next PHI node we would
467 // iterate to, then our iterator is invalid, restart scanning from the top
468 // of the block.
Chris Lattner35a939b2010-07-15 06:06:04 +0000469 if (PhiIt != OldPhiIt) PhiIt = &BB->front();
Chris Lattner40d8c282009-11-10 22:26:15 +0000470 }
471}
472
473
Chris Lattnerb29714a2008-11-27 07:43:12 +0000474/// MergeBasicBlockIntoOnlyPred - DestBB is a block with one predecessor and its
475/// predecessor is known to have one successor (DestBB!). Eliminate the edge
476/// between them, moving the instructions in the predecessor into DestBB and
477/// deleting the predecessor block.
478///
Andreas Neustifterad809812009-09-16 09:26:52 +0000479void llvm::MergeBasicBlockIntoOnlyPred(BasicBlock *DestBB, Pass *P) {
Chris Lattnerb29714a2008-11-27 07:43:12 +0000480 // If BB has single-entry PHI nodes, fold them.
481 while (PHINode *PN = dyn_cast<PHINode>(DestBB->begin())) {
482 Value *NewVal = PN->getIncomingValue(0);
483 // Replace self referencing PHI with undef, it must be dead.
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000484 if (NewVal == PN) NewVal = UndefValue::get(PN->getType());
Chris Lattnerb29714a2008-11-27 07:43:12 +0000485 PN->replaceAllUsesWith(NewVal);
486 PN->eraseFromParent();
487 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000488
Chris Lattnerb29714a2008-11-27 07:43:12 +0000489 BasicBlock *PredBB = DestBB->getSinglePredecessor();
490 assert(PredBB && "Block doesn't have a single predecessor!");
Jakub Staszaka18c5742013-07-22 23:16:36 +0000491
Chris Lattner37914c82010-02-15 20:47:49 +0000492 // Zap anything that took the address of DestBB. Not doing this will give the
493 // address an invalid value.
494 if (DestBB->hasAddressTaken()) {
495 BlockAddress *BA = BlockAddress::get(DestBB);
496 Constant *Replacement =
497 ConstantInt::get(llvm::Type::getInt32Ty(BA->getContext()), 1);
498 BA->replaceAllUsesWith(ConstantExpr::getIntToPtr(Replacement,
499 BA->getType()));
500 BA->destroyConstant();
501 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000502
Chris Lattnerb29714a2008-11-27 07:43:12 +0000503 // Anything that branched to PredBB now branches to DestBB.
504 PredBB->replaceAllUsesWith(DestBB);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000505
Jay Foad95c3e482011-06-23 09:09:15 +0000506 // Splice all the instructions from PredBB to DestBB.
507 PredBB->getTerminator()->eraseFromParent();
Bill Wendling3e033f22013-10-21 04:09:17 +0000508 DestBB->getInstList().splice(DestBB->begin(), PredBB->getInstList());
Jay Foad95c3e482011-06-23 09:09:15 +0000509
Andreas Neustifterad809812009-09-16 09:26:52 +0000510 if (P) {
Stephen Hines36b56882014-04-23 16:57:46 -0700511 if (DominatorTreeWrapperPass *DTWP =
512 P->getAnalysisIfAvailable<DominatorTreeWrapperPass>()) {
513 DominatorTree &DT = DTWP->getDomTree();
514 BasicBlock *PredBBIDom = DT.getNode(PredBB)->getIDom()->getBlock();
515 DT.changeImmediateDominator(DestBB, PredBBIDom);
516 DT.eraseNode(PredBB);
Cameron Zwarich80f6a502011-01-08 17:01:52 +0000517 }
Andreas Neustifterad809812009-09-16 09:26:52 +0000518 }
Chris Lattnerb29714a2008-11-27 07:43:12 +0000519 // Nuke BB.
520 PredBB->eraseFromParent();
521}
Devang Patel4afc90d2009-02-10 07:00:59 +0000522
Duncan Sandsc48b55a2013-07-11 08:28:20 +0000523/// CanMergeValues - Return true if we can choose one of these values to use
524/// in place of the other. Note that we will always choose the non-undef
525/// value to keep.
526static bool CanMergeValues(Value *First, Value *Second) {
527 return First == Second || isa<UndefValue>(First) || isa<UndefValue>(Second);
528}
529
Chris Lattnerdce94d92009-11-10 05:59:26 +0000530/// CanPropagatePredecessorsForPHIs - Return true if we can fold BB, an
Mark Lacey1b6e10f2013-08-14 22:11:42 +0000531/// almost-empty BB ending in an unconditional branch to Succ, into Succ.
Chris Lattnerdce94d92009-11-10 05:59:26 +0000532///
533/// Assumption: Succ is the single successor for BB.
534///
535static bool CanPropagatePredecessorsForPHIs(BasicBlock *BB, BasicBlock *Succ) {
536 assert(*succ_begin(BB) == Succ && "Succ is not successor of BB!");
537
Jakub Staszaka18c5742013-07-22 23:16:36 +0000538 DEBUG(dbgs() << "Looking to fold " << BB->getName() << " into "
Chris Lattnerdce94d92009-11-10 05:59:26 +0000539 << Succ->getName() << "\n");
540 // Shortcut, if there is only a single predecessor it must be BB and merging
541 // is always safe
542 if (Succ->getSinglePredecessor()) return true;
543
544 // Make a list of the predecessors of BB
Benjamin Kramer88c09142011-12-06 16:14:29 +0000545 SmallPtrSet<BasicBlock*, 16> BBPreds(pred_begin(BB), pred_end(BB));
Chris Lattnerdce94d92009-11-10 05:59:26 +0000546
Chris Lattnerdce94d92009-11-10 05:59:26 +0000547 // Look at all the phi nodes in Succ, to see if they present a conflict when
548 // merging these blocks
549 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
550 PHINode *PN = cast<PHINode>(I);
551
552 // If the incoming value from BB is again a PHINode in
553 // BB which has the same incoming value for *PI as PN does, we can
554 // merge the phi nodes and then the blocks can still be merged
555 PHINode *BBPN = dyn_cast<PHINode>(PN->getIncomingValueForBlock(BB));
556 if (BBPN && BBPN->getParent() == BB) {
Benjamin Kramer88c09142011-12-06 16:14:29 +0000557 for (unsigned PI = 0, PE = PN->getNumIncomingValues(); PI != PE; ++PI) {
558 BasicBlock *IBB = PN->getIncomingBlock(PI);
559 if (BBPreds.count(IBB) &&
Duncan Sandsc48b55a2013-07-11 08:28:20 +0000560 !CanMergeValues(BBPN->getIncomingValueForBlock(IBB),
561 PN->getIncomingValue(PI))) {
Jakub Staszaka18c5742013-07-22 23:16:36 +0000562 DEBUG(dbgs() << "Can't fold, phi node " << PN->getName() << " in "
563 << Succ->getName() << " is conflicting with "
Chris Lattnerdce94d92009-11-10 05:59:26 +0000564 << BBPN->getName() << " with regard to common predecessor "
Benjamin Kramer88c09142011-12-06 16:14:29 +0000565 << IBB->getName() << "\n");
Chris Lattnerdce94d92009-11-10 05:59:26 +0000566 return false;
567 }
568 }
569 } else {
570 Value* Val = PN->getIncomingValueForBlock(BB);
Benjamin Kramer88c09142011-12-06 16:14:29 +0000571 for (unsigned PI = 0, PE = PN->getNumIncomingValues(); PI != PE; ++PI) {
Chris Lattnerdce94d92009-11-10 05:59:26 +0000572 // See if the incoming value for the common predecessor is equal to the
573 // one for BB, in which case this phi node will not prevent the merging
574 // of the block.
Benjamin Kramer88c09142011-12-06 16:14:29 +0000575 BasicBlock *IBB = PN->getIncomingBlock(PI);
Duncan Sandsc48b55a2013-07-11 08:28:20 +0000576 if (BBPreds.count(IBB) &&
577 !CanMergeValues(Val, PN->getIncomingValue(PI))) {
Jakub Staszaka18c5742013-07-22 23:16:36 +0000578 DEBUG(dbgs() << "Can't fold, phi node " << PN->getName() << " in "
Chris Lattnerdce94d92009-11-10 05:59:26 +0000579 << Succ->getName() << " is conflicting with regard to common "
Benjamin Kramer88c09142011-12-06 16:14:29 +0000580 << "predecessor " << IBB->getName() << "\n");
Chris Lattnerdce94d92009-11-10 05:59:26 +0000581 return false;
582 }
583 }
584 }
585 }
586
587 return true;
588}
589
Duncan Sandsc48b55a2013-07-11 08:28:20 +0000590typedef SmallVector<BasicBlock *, 16> PredBlockVector;
591typedef DenseMap<BasicBlock *, Value *> IncomingValueMap;
592
593/// \brief Determines the value to use as the phi node input for a block.
594///
595/// Select between \p OldVal any value that we know flows from \p BB
596/// to a particular phi on the basis of which one (if either) is not
597/// undef. Update IncomingValues based on the selected value.
598///
599/// \param OldVal The value we are considering selecting.
600/// \param BB The block that the value flows in from.
601/// \param IncomingValues A map from block-to-value for other phi inputs
602/// that we have examined.
603///
604/// \returns the selected value.
605static Value *selectIncomingValueForBlock(Value *OldVal, BasicBlock *BB,
606 IncomingValueMap &IncomingValues) {
607 if (!isa<UndefValue>(OldVal)) {
608 assert((!IncomingValues.count(BB) ||
609 IncomingValues.find(BB)->second == OldVal) &&
610 "Expected OldVal to match incoming value from BB!");
611
612 IncomingValues.insert(std::make_pair(BB, OldVal));
613 return OldVal;
614 }
615
616 IncomingValueMap::const_iterator It = IncomingValues.find(BB);
617 if (It != IncomingValues.end()) return It->second;
618
619 return OldVal;
620}
621
622/// \brief Create a map from block to value for the operands of a
623/// given phi.
624///
625/// Create a map from block to value for each non-undef value flowing
626/// into \p PN.
627///
628/// \param PN The phi we are collecting the map for.
629/// \param IncomingValues [out] The map from block to value for this phi.
630static void gatherIncomingValuesToPhi(PHINode *PN,
631 IncomingValueMap &IncomingValues) {
632 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
633 BasicBlock *BB = PN->getIncomingBlock(i);
634 Value *V = PN->getIncomingValue(i);
635
636 if (!isa<UndefValue>(V))
637 IncomingValues.insert(std::make_pair(BB, V));
638 }
639}
640
641/// \brief Replace the incoming undef values to a phi with the values
642/// from a block-to-value map.
643///
644/// \param PN The phi we are replacing the undefs in.
645/// \param IncomingValues A map from block to value.
646static void replaceUndefValuesInPhi(PHINode *PN,
647 const IncomingValueMap &IncomingValues) {
648 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
649 Value *V = PN->getIncomingValue(i);
650
651 if (!isa<UndefValue>(V)) continue;
652
653 BasicBlock *BB = PN->getIncomingBlock(i);
654 IncomingValueMap::const_iterator It = IncomingValues.find(BB);
655 if (It == IncomingValues.end()) continue;
656
657 PN->setIncomingValue(i, It->second);
658 }
659}
660
661/// \brief Replace a value flowing from a block to a phi with
662/// potentially multiple instances of that value flowing from the
663/// block's predecessors to the phi.
664///
665/// \param BB The block with the value flowing into the phi.
666/// \param BBPreds The predecessors of BB.
667/// \param PN The phi that we are updating.
668static void redirectValuesFromPredecessorsToPhi(BasicBlock *BB,
669 const PredBlockVector &BBPreds,
670 PHINode *PN) {
671 Value *OldVal = PN->removeIncomingValue(BB, false);
672 assert(OldVal && "No entry in PHI for Pred BB!");
673
674 IncomingValueMap IncomingValues;
675
676 // We are merging two blocks - BB, and the block containing PN - and
677 // as a result we need to redirect edges from the predecessors of BB
678 // to go to the block containing PN, and update PN
679 // accordingly. Since we allow merging blocks in the case where the
680 // predecessor and successor blocks both share some predecessors,
681 // and where some of those common predecessors might have undef
682 // values flowing into PN, we want to rewrite those values to be
683 // consistent with the non-undef values.
684
685 gatherIncomingValuesToPhi(PN, IncomingValues);
686
687 // If this incoming value is one of the PHI nodes in BB, the new entries
688 // in the PHI node are the entries from the old PHI.
689 if (isa<PHINode>(OldVal) && cast<PHINode>(OldVal)->getParent() == BB) {
690 PHINode *OldValPN = cast<PHINode>(OldVal);
691 for (unsigned i = 0, e = OldValPN->getNumIncomingValues(); i != e; ++i) {
692 // Note that, since we are merging phi nodes and BB and Succ might
693 // have common predecessors, we could end up with a phi node with
694 // identical incoming branches. This will be cleaned up later (and
695 // will trigger asserts if we try to clean it up now, without also
696 // simplifying the corresponding conditional branch).
697 BasicBlock *PredBB = OldValPN->getIncomingBlock(i);
698 Value *PredVal = OldValPN->getIncomingValue(i);
699 Value *Selected = selectIncomingValueForBlock(PredVal, PredBB,
700 IncomingValues);
701
702 // And add a new incoming value for this predecessor for the
703 // newly retargeted branch.
704 PN->addIncoming(Selected, PredBB);
705 }
706 } else {
707 for (unsigned i = 0, e = BBPreds.size(); i != e; ++i) {
708 // Update existing incoming values in PN for this
709 // predecessor of BB.
710 BasicBlock *PredBB = BBPreds[i];
711 Value *Selected = selectIncomingValueForBlock(OldVal, PredBB,
712 IncomingValues);
713
714 // And add a new incoming value for this predecessor for the
715 // newly retargeted branch.
716 PN->addIncoming(Selected, PredBB);
717 }
718 }
719
720 replaceUndefValuesInPhi(PN, IncomingValues);
721}
722
Chris Lattnerdce94d92009-11-10 05:59:26 +0000723/// TryToSimplifyUncondBranchFromEmptyBlock - BB is known to contain an
724/// unconditional branch, and contains no instructions other than PHI nodes,
Rafael Espindola77a2c372011-06-30 20:14:24 +0000725/// potential side-effect free intrinsics and the branch. If possible,
726/// eliminate BB by rewriting all the predecessors to branch to the successor
727/// block and return true. If we can't transform, return false.
Chris Lattnerdce94d92009-11-10 05:59:26 +0000728bool llvm::TryToSimplifyUncondBranchFromEmptyBlock(BasicBlock *BB) {
Dan Gohmane2c6d132010-08-14 00:29:42 +0000729 assert(BB != &BB->getParent()->getEntryBlock() &&
730 "TryToSimplifyUncondBranchFromEmptyBlock called on entry block!");
731
Chris Lattnerdce94d92009-11-10 05:59:26 +0000732 // We can't eliminate infinite loops.
733 BasicBlock *Succ = cast<BranchInst>(BB->getTerminator())->getSuccessor(0);
734 if (BB == Succ) return false;
Jakub Staszaka18c5742013-07-22 23:16:36 +0000735
Chris Lattnerdce94d92009-11-10 05:59:26 +0000736 // Check to see if merging these blocks would cause conflicts for any of the
737 // phi nodes in BB or Succ. If not, we can safely merge.
738 if (!CanPropagatePredecessorsForPHIs(BB, Succ)) return false;
739
740 // Check for cases where Succ has multiple predecessors and a PHI node in BB
741 // has uses which will not disappear when the PHI nodes are merged. It is
742 // possible to handle such cases, but difficult: it requires checking whether
743 // BB dominates Succ, which is non-trivial to calculate in the case where
744 // Succ has multiple predecessors. Also, it requires checking whether
Alexey Samsonov3a199992012-12-24 08:52:53 +0000745 // constructing the necessary self-referential PHI node doesn't introduce any
Chris Lattnerdce94d92009-11-10 05:59:26 +0000746 // conflicts; this isn't too difficult, but the previous code for doing this
747 // was incorrect.
748 //
749 // Note that if this check finds a live use, BB dominates Succ, so BB is
750 // something like a loop pre-header (or rarely, a part of an irreducible CFG);
751 // folding the branch isn't profitable in that case anyway.
752 if (!Succ->getSinglePredecessor()) {
753 BasicBlock::iterator BBI = BB->begin();
754 while (isa<PHINode>(*BBI)) {
Stephen Hines36b56882014-04-23 16:57:46 -0700755 for (Use &U : BBI->uses()) {
756 if (PHINode* PN = dyn_cast<PHINode>(U.getUser())) {
757 if (PN->getIncomingBlock(U) != BB)
Chris Lattnerdce94d92009-11-10 05:59:26 +0000758 return false;
759 } else {
760 return false;
761 }
762 }
763 ++BBI;
764 }
765 }
766
David Greenefae77062010-01-05 01:26:57 +0000767 DEBUG(dbgs() << "Killing Trivial BB: \n" << *BB);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000768
Chris Lattnerdce94d92009-11-10 05:59:26 +0000769 if (isa<PHINode>(Succ->begin())) {
770 // If there is more than one pred of succ, and there are PHI nodes in
771 // the successor, then we need to add incoming edges for the PHI nodes
772 //
Duncan Sandsc48b55a2013-07-11 08:28:20 +0000773 const PredBlockVector BBPreds(pred_begin(BB), pred_end(BB));
Jakub Staszaka18c5742013-07-22 23:16:36 +0000774
Chris Lattnerdce94d92009-11-10 05:59:26 +0000775 // Loop over all of the PHI nodes in the successor of BB.
776 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
777 PHINode *PN = cast<PHINode>(I);
Duncan Sandsc48b55a2013-07-11 08:28:20 +0000778
779 redirectValuesFromPredecessorsToPhi(BB, BBPreds, PN);
Chris Lattnerdce94d92009-11-10 05:59:26 +0000780 }
781 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000782
Rafael Espindola77a2c372011-06-30 20:14:24 +0000783 if (Succ->getSinglePredecessor()) {
784 // BB is the only predecessor of Succ, so Succ will end up with exactly
785 // the same predecessors BB had.
786
787 // Copy over any phi, debug or lifetime instruction.
788 BB->getTerminator()->eraseFromParent();
789 Succ->getInstList().splice(Succ->getFirstNonPHI(), BB->getInstList());
790 } else {
791 while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) {
Chris Lattnerdce94d92009-11-10 05:59:26 +0000792 // We explicitly check for such uses in CanPropagatePredecessorsForPHIs.
793 assert(PN->use_empty() && "There shouldn't be any uses here!");
794 PN->eraseFromParent();
795 }
796 }
Jakub Staszaka18c5742013-07-22 23:16:36 +0000797
Chris Lattnerdce94d92009-11-10 05:59:26 +0000798 // Everything that jumped to BB now goes to Succ.
799 BB->replaceAllUsesWith(Succ);
800 if (!Succ->hasName()) Succ->takeName(BB);
801 BB->eraseFromParent(); // Delete the old basic block.
802 return true;
803}
804
Jim Grosbach43a82412009-12-02 17:06:45 +0000805/// EliminateDuplicatePHINodes - Check for and eliminate duplicate PHI
806/// nodes in this block. This doesn't try to be clever about PHI nodes
807/// which differ only in the order of the incoming values, but instcombine
808/// orders them so it usually won't matter.
809///
810bool llvm::EliminateDuplicatePHINodes(BasicBlock *BB) {
811 bool Changed = false;
812
813 // This implementation doesn't currently consider undef operands
Nick Lewycky89991d42011-06-28 03:57:31 +0000814 // specially. Theoretically, two phis which are identical except for
Jim Grosbach43a82412009-12-02 17:06:45 +0000815 // one having an undef where the other doesn't could be collapsed.
816
817 // Map from PHI hash values to PHI nodes. If multiple PHIs have
818 // the same hash value, the element is the first PHI in the
819 // linked list in CollisionMap.
820 DenseMap<uintptr_t, PHINode *> HashMap;
821
822 // Maintain linked lists of PHI nodes with common hash values.
823 DenseMap<PHINode *, PHINode *> CollisionMap;
824
825 // Examine each PHI.
826 for (BasicBlock::iterator I = BB->begin();
827 PHINode *PN = dyn_cast<PHINode>(I++); ) {
828 // Compute a hash value on the operands. Instcombine will likely have sorted
829 // them, which helps expose duplicates, but we have to check all the
830 // operands to be safe in case instcombine hasn't run.
831 uintptr_t Hash = 0;
Jay Foad95c3e482011-06-23 09:09:15 +0000832 // This hash algorithm is quite weak as hash functions go, but it seems
833 // to do a good enough job for this particular purpose, and is very quick.
Jim Grosbach43a82412009-12-02 17:06:45 +0000834 for (User::op_iterator I = PN->op_begin(), E = PN->op_end(); I != E; ++I) {
Jim Grosbach43a82412009-12-02 17:06:45 +0000835 Hash ^= reinterpret_cast<uintptr_t>(static_cast<Value *>(*I));
836 Hash = (Hash << 7) | (Hash >> (sizeof(uintptr_t) * CHAR_BIT - 7));
837 }
Jay Foad95c3e482011-06-23 09:09:15 +0000838 for (PHINode::block_iterator I = PN->block_begin(), E = PN->block_end();
839 I != E; ++I) {
840 Hash ^= reinterpret_cast<uintptr_t>(static_cast<BasicBlock *>(*I));
841 Hash = (Hash << 7) | (Hash >> (sizeof(uintptr_t) * CHAR_BIT - 7));
842 }
Jakob Stoklund Olesen2bc2a082011-03-04 02:48:56 +0000843 // Avoid colliding with the DenseMap sentinels ~0 and ~0-1.
844 Hash >>= 1;
Jim Grosbach43a82412009-12-02 17:06:45 +0000845 // If we've never seen this hash value before, it's a unique PHI.
846 std::pair<DenseMap<uintptr_t, PHINode *>::iterator, bool> Pair =
847 HashMap.insert(std::make_pair(Hash, PN));
848 if (Pair.second) continue;
849 // Otherwise it's either a duplicate or a hash collision.
850 for (PHINode *OtherPN = Pair.first->second; ; ) {
851 if (OtherPN->isIdenticalTo(PN)) {
852 // A duplicate. Replace this PHI with its duplicate.
853 PN->replaceAllUsesWith(OtherPN);
854 PN->eraseFromParent();
855 Changed = true;
856 break;
857 }
858 // A non-duplicate hash collision.
859 DenseMap<PHINode *, PHINode *>::iterator I = CollisionMap.find(OtherPN);
860 if (I == CollisionMap.end()) {
861 // Set this PHI to be the head of the linked list of colliding PHIs.
862 PHINode *Old = Pair.first->second;
863 Pair.first->second = PN;
864 CollisionMap[PN] = Old;
865 break;
866 }
Benjamin Kramerd9b0b022012-06-02 10:20:22 +0000867 // Proceed to the next PHI in the list.
Jim Grosbach43a82412009-12-02 17:06:45 +0000868 OtherPN = I->second;
869 }
870 }
871
872 return Changed;
873}
Chris Lattner687140c2010-12-25 20:37:57 +0000874
875/// enforceKnownAlignment - If the specified pointer points to an object that
876/// we control, modify the object's alignment to PrefAlign. This isn't
877/// often possible though. If alignment is important, a more reliable approach
878/// is to simply align all global variables and allocation instructions to
879/// their preferred alignment from the beginning.
880///
Benjamin Kramer19282362010-12-30 22:34:44 +0000881static unsigned enforceKnownAlignment(Value *V, unsigned Align,
Micah Villmow3574eca2012-10-08 16:38:25 +0000882 unsigned PrefAlign, const DataLayout *TD) {
Eli Friedmanb53c7932011-06-15 21:08:25 +0000883 V = V->stripPointerCasts();
Chris Lattner687140c2010-12-25 20:37:57 +0000884
Eli Friedmanb53c7932011-06-15 21:08:25 +0000885 if (AllocaInst *AI = dyn_cast<AllocaInst>(V)) {
Lang Hamesbb5b3f32011-10-10 23:42:08 +0000886 // If the preferred alignment is greater than the natural stack alignment
887 // then don't round up. This avoids dynamic stack realignment.
888 if (TD && TD->exceedsNaturalStackAlignment(PrefAlign))
889 return Align;
Chris Lattner687140c2010-12-25 20:37:57 +0000890 // If there is a requested alignment and if this is an alloca, round up.
891 if (AI->getAlignment() >= PrefAlign)
892 return AI->getAlignment();
893 AI->setAlignment(PrefAlign);
894 return PrefAlign;
895 }
Chris Lattner687140c2010-12-25 20:37:57 +0000896
897 if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
898 // If there is a large requested alignment and we can, bump up the alignment
899 // of the global.
900 if (GV->isDeclaration()) return Align;
Duncan Sandsd3a38cc2011-11-29 18:26:38 +0000901 // If the memory we set aside for the global may not be the memory used by
902 // the final program then it is impossible for us to reliably enforce the
903 // preferred alignment.
904 if (GV->isWeakForLinker()) return Align;
Jakub Staszaka18c5742013-07-22 23:16:36 +0000905
Chris Lattner687140c2010-12-25 20:37:57 +0000906 if (GV->getAlignment() >= PrefAlign)
907 return GV->getAlignment();
908 // We can only increase the alignment of the global if it has no alignment
909 // specified or if it is not assigned a section. If it is assigned a
910 // section, the global could be densely packed with other objects in the
911 // section, increasing the alignment could cause padding issues.
912 if (!GV->hasSection() || GV->getAlignment() == 0)
913 GV->setAlignment(PrefAlign);
914 return GV->getAlignment();
915 }
916
917 return Align;
918}
919
920/// getOrEnforceKnownAlignment - If the specified pointer has an alignment that
921/// we can determine, return it, otherwise return 0. If PrefAlign is specified,
922/// and it is more than the alignment of the ultimate object, see if we can
923/// increase the alignment of the ultimate object, making this check succeed.
924unsigned llvm::getOrEnforceKnownAlignment(Value *V, unsigned PrefAlign,
Matt Arsenault186f8f92013-08-01 22:42:18 +0000925 const DataLayout *DL) {
Chris Lattner687140c2010-12-25 20:37:57 +0000926 assert(V->getType()->isPointerTy() &&
927 "getOrEnforceKnownAlignment expects a pointer!");
Matt Arsenault186f8f92013-08-01 22:42:18 +0000928 unsigned BitWidth = DL ? DL->getPointerTypeSizeInBits(V->getType()) : 64;
929
Chris Lattner687140c2010-12-25 20:37:57 +0000930 APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
Matt Arsenault186f8f92013-08-01 22:42:18 +0000931 ComputeMaskedBits(V, KnownZero, KnownOne, DL);
Chris Lattner687140c2010-12-25 20:37:57 +0000932 unsigned TrailZ = KnownZero.countTrailingOnes();
Jakub Staszaka18c5742013-07-22 23:16:36 +0000933
Matt Arsenault59a38782013-07-23 22:20:57 +0000934 // Avoid trouble with ridiculously large TrailZ values, such as
Chris Lattner687140c2010-12-25 20:37:57 +0000935 // those computed from a null pointer.
936 TrailZ = std::min(TrailZ, unsigned(sizeof(unsigned) * CHAR_BIT - 1));
Jakub Staszaka18c5742013-07-22 23:16:36 +0000937
Chris Lattner687140c2010-12-25 20:37:57 +0000938 unsigned Align = 1u << std::min(BitWidth - 1, TrailZ);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000939
Chris Lattner687140c2010-12-25 20:37:57 +0000940 // LLVM doesn't support alignments larger than this currently.
941 Align = std::min(Align, +Value::MaximumAlignment);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000942
Chris Lattner687140c2010-12-25 20:37:57 +0000943 if (PrefAlign > Align)
Matt Arsenault186f8f92013-08-01 22:42:18 +0000944 Align = enforceKnownAlignment(V, Align, PrefAlign, DL);
Jakub Staszaka18c5742013-07-22 23:16:36 +0000945
Chris Lattner687140c2010-12-25 20:37:57 +0000946 // We don't need to make any adjustment.
947 return Align;
948}
949
Devang Patel5ee20682011-03-17 21:58:19 +0000950///===---------------------------------------------------------------------===//
951/// Dbg Intrinsic utilities
952///
953
Adrian Prantl163da932013-04-26 17:48:33 +0000954/// See if there is a dbg.value intrinsic for DIVar before I.
955static bool LdStHasDebugValue(DIVariable &DIVar, Instruction *I) {
956 // Since we can't guarantee that the original dbg.declare instrinsic
957 // is removed by LowerDbgDeclare(), we need to make sure that we are
958 // not inserting the same dbg.value intrinsic over and over.
959 llvm::BasicBlock::InstListType::iterator PrevI(I);
960 if (PrevI != I->getParent()->getInstList().begin()) {
961 --PrevI;
962 if (DbgValueInst *DVI = dyn_cast<DbgValueInst>(PrevI))
963 if (DVI->getValue() == I->getOperand(0) &&
964 DVI->getOffset() == 0 &&
965 DVI->getVariable() == DIVar)
966 return true;
967 }
968 return false;
969}
970
Adrian Prantl9d5d58a2013-04-26 18:10:50 +0000971/// Inserts a llvm.dbg.value intrinsic before a store to an alloca'd value
Devang Patel5ee20682011-03-17 21:58:19 +0000972/// that has an associated llvm.dbg.decl intrinsic.
973bool llvm::ConvertDebugDeclareToDebugValue(DbgDeclareInst *DDI,
974 StoreInst *SI, DIBuilder &Builder) {
975 DIVariable DIVar(DDI->getVariable());
Manman Rencbafae62013-06-28 05:43:10 +0000976 assert((!DIVar || DIVar.isVariable()) &&
977 "Variable in DbgDeclareInst should be either null or a DIVariable.");
978 if (!DIVar)
Devang Patel5ee20682011-03-17 21:58:19 +0000979 return false;
980
Adrian Prantl163da932013-04-26 17:48:33 +0000981 if (LdStHasDebugValue(DIVar, SI))
982 return true;
983
Devang Patel227dfdb2011-05-16 21:24:05 +0000984 Instruction *DbgVal = NULL;
985 // If an argument is zero extended then use argument directly. The ZExt
986 // may be zapped by an optimization pass in future.
987 Argument *ExtendedArg = NULL;
988 if (ZExtInst *ZExt = dyn_cast<ZExtInst>(SI->getOperand(0)))
989 ExtendedArg = dyn_cast<Argument>(ZExt->getOperand(0));
990 if (SExtInst *SExt = dyn_cast<SExtInst>(SI->getOperand(0)))
991 ExtendedArg = dyn_cast<Argument>(SExt->getOperand(0));
992 if (ExtendedArg)
993 DbgVal = Builder.insertDbgValueIntrinsic(ExtendedArg, 0, DIVar, SI);
994 else
995 DbgVal = Builder.insertDbgValueIntrinsic(SI->getOperand(0), 0, DIVar, SI);
996
Devang Patel5ee20682011-03-17 21:58:19 +0000997 // Propagate any debug metadata from the store onto the dbg.value.
998 DebugLoc SIDL = SI->getDebugLoc();
999 if (!SIDL.isUnknown())
1000 DbgVal->setDebugLoc(SIDL);
1001 // Otherwise propagate debug metadata from dbg.declare.
1002 else
1003 DbgVal->setDebugLoc(DDI->getDebugLoc());
1004 return true;
1005}
1006
Adrian Prantl9d5d58a2013-04-26 18:10:50 +00001007/// Inserts a llvm.dbg.value intrinsic before a load of an alloca'd value
Devang Patel36fae672011-03-18 23:45:43 +00001008/// that has an associated llvm.dbg.decl intrinsic.
1009bool llvm::ConvertDebugDeclareToDebugValue(DbgDeclareInst *DDI,
1010 LoadInst *LI, DIBuilder &Builder) {
1011 DIVariable DIVar(DDI->getVariable());
Jakub Staszaka18c5742013-07-22 23:16:36 +00001012 assert((!DIVar || DIVar.isVariable()) &&
Manman Rencbafae62013-06-28 05:43:10 +00001013 "Variable in DbgDeclareInst should be either null or a DIVariable.");
1014 if (!DIVar)
Devang Patel36fae672011-03-18 23:45:43 +00001015 return false;
1016
Adrian Prantl163da932013-04-26 17:48:33 +00001017 if (LdStHasDebugValue(DIVar, LI))
1018 return true;
1019
Jakub Staszaka18c5742013-07-22 23:16:36 +00001020 Instruction *DbgVal =
Devang Patel36fae672011-03-18 23:45:43 +00001021 Builder.insertDbgValueIntrinsic(LI->getOperand(0), 0,
1022 DIVar, LI);
Jakub Staszaka18c5742013-07-22 23:16:36 +00001023
Devang Patel36fae672011-03-18 23:45:43 +00001024 // Propagate any debug metadata from the store onto the dbg.value.
1025 DebugLoc LIDL = LI->getDebugLoc();
1026 if (!LIDL.isUnknown())
1027 DbgVal->setDebugLoc(LIDL);
1028 // Otherwise propagate debug metadata from dbg.declare.
1029 else
1030 DbgVal->setDebugLoc(DDI->getDebugLoc());
1031 return true;
1032}
1033
Devang Patel813c9a02011-03-17 22:18:16 +00001034/// LowerDbgDeclare - Lowers llvm.dbg.declare intrinsics into appropriate set
1035/// of llvm.dbg.value intrinsics.
1036bool llvm::LowerDbgDeclare(Function &F) {
1037 DIBuilder DIB(*F.getParent());
1038 SmallVector<DbgDeclareInst *, 4> Dbgs;
Stephen Hines36b56882014-04-23 16:57:46 -07001039 for (auto &FI : F)
1040 for (BasicBlock::iterator BI : FI)
1041 if (auto DDI = dyn_cast<DbgDeclareInst>(BI))
Devang Patel813c9a02011-03-17 22:18:16 +00001042 Dbgs.push_back(DDI);
Stephen Hines36b56882014-04-23 16:57:46 -07001043
Devang Patel813c9a02011-03-17 22:18:16 +00001044 if (Dbgs.empty())
1045 return false;
1046
Stephen Hines36b56882014-04-23 16:57:46 -07001047 for (auto &I : Dbgs) {
1048 DbgDeclareInst *DDI = I;
Adrian Prantl940267e2013-11-18 23:04:38 +00001049 AllocaInst *AI = dyn_cast_or_null<AllocaInst>(DDI->getAddress());
1050 // If this is an alloca for a scalar variable, insert a dbg.value
1051 // at each load and store to the alloca and erase the dbg.declare.
1052 if (AI && !AI->isArrayAllocation()) {
1053
Adrian Prantl163da932013-04-26 17:48:33 +00001054 // We only remove the dbg.declare intrinsic if all uses are
1055 // converted to dbg.value intrinsics.
Devang Patel81ad03c2011-04-28 20:32:02 +00001056 bool RemoveDDI = true;
Stephen Hines36b56882014-04-23 16:57:46 -07001057 for (User *U : AI->users())
1058 if (StoreInst *SI = dyn_cast<StoreInst>(U))
Devang Patel813c9a02011-03-17 22:18:16 +00001059 ConvertDebugDeclareToDebugValue(DDI, SI, DIB);
Stephen Hines36b56882014-04-23 16:57:46 -07001060 else if (LoadInst *LI = dyn_cast<LoadInst>(U))
Devang Patel36fae672011-03-18 23:45:43 +00001061 ConvertDebugDeclareToDebugValue(DDI, LI, DIB);
Devang Patel81ad03c2011-04-28 20:32:02 +00001062 else
1063 RemoveDDI = false;
1064 if (RemoveDDI)
1065 DDI->eraseFromParent();
Devang Patel813c9a02011-03-17 22:18:16 +00001066 }
Devang Patel813c9a02011-03-17 22:18:16 +00001067 }
1068 return true;
1069}
Cameron Zwarichc8279392011-05-24 03:10:43 +00001070
1071/// FindAllocaDbgDeclare - Finds the llvm.dbg.declare intrinsic describing the
1072/// alloca 'V', if any.
1073DbgDeclareInst *llvm::FindAllocaDbgDeclare(Value *V) {
1074 if (MDNode *DebugNode = MDNode::getIfExists(V->getContext(), V))
Stephen Hines36b56882014-04-23 16:57:46 -07001075 for (User *U : DebugNode->users())
1076 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(U))
Cameron Zwarichc8279392011-05-24 03:10:43 +00001077 return DDI;
1078
1079 return 0;
1080}
Alexey Samsonov1afbb512012-12-12 14:31:53 +00001081
1082bool llvm::replaceDbgDeclareForAlloca(AllocaInst *AI, Value *NewAllocaAddress,
1083 DIBuilder &Builder) {
1084 DbgDeclareInst *DDI = FindAllocaDbgDeclare(AI);
1085 if (!DDI)
1086 return false;
1087 DIVariable DIVar(DDI->getVariable());
Jakub Staszaka18c5742013-07-22 23:16:36 +00001088 assert((!DIVar || DIVar.isVariable()) &&
Manman Rencbafae62013-06-28 05:43:10 +00001089 "Variable in DbgDeclareInst should be either null or a DIVariable.");
1090 if (!DIVar)
Alexey Samsonov1afbb512012-12-12 14:31:53 +00001091 return false;
1092
1093 // Create a copy of the original DIDescriptor for user variable, appending
1094 // "deref" operation to a list of address elements, as new llvm.dbg.declare
1095 // will take a value storing address of the memory for variable, not
1096 // alloca itself.
1097 Type *Int64Ty = Type::getInt64Ty(AI->getContext());
1098 SmallVector<Value*, 4> NewDIVarAddress;
1099 if (DIVar.hasComplexAddress()) {
1100 for (unsigned i = 0, n = DIVar.getNumAddrElements(); i < n; ++i) {
1101 NewDIVarAddress.push_back(
1102 ConstantInt::get(Int64Ty, DIVar.getAddrElement(i)));
1103 }
1104 }
1105 NewDIVarAddress.push_back(ConstantInt::get(Int64Ty, DIBuilder::OpDeref));
1106 DIVariable NewDIVar = Builder.createComplexVariable(
1107 DIVar.getTag(), DIVar.getContext(), DIVar.getName(),
1108 DIVar.getFile(), DIVar.getLineNumber(), DIVar.getType(),
1109 NewDIVarAddress, DIVar.getArgNumber());
1110
1111 // Insert llvm.dbg.declare in the same basic block as the original alloca,
1112 // and remove old llvm.dbg.declare.
1113 BasicBlock *BB = AI->getParent();
1114 Builder.insertDeclare(NewAllocaAddress, NewDIVar, BB);
1115 DDI->eraseFromParent();
1116 return true;
1117}
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001118
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001119/// changeToUnreachable - Insert an unreachable instruction before the specified
1120/// instruction, making it and the rest of the code in the block dead.
1121static void changeToUnreachable(Instruction *I, bool UseLLVMTrap) {
1122 BasicBlock *BB = I->getParent();
1123 // Loop over all of the successors, removing BB's entry from any PHI
1124 // nodes.
1125 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
1126 (*SI)->removePredecessor(BB);
1127
1128 // Insert a call to llvm.trap right before this. This turns the undefined
1129 // behavior into a hard fail instead of falling through into random code.
1130 if (UseLLVMTrap) {
1131 Function *TrapFn =
1132 Intrinsic::getDeclaration(BB->getParent()->getParent(), Intrinsic::trap);
1133 CallInst *CallTrap = CallInst::Create(TrapFn, "", I);
1134 CallTrap->setDebugLoc(I->getDebugLoc());
1135 }
1136 new UnreachableInst(I->getContext(), I);
1137
1138 // All instructions after this are dead.
1139 BasicBlock::iterator BBI = I, BBE = BB->end();
1140 while (BBI != BBE) {
1141 if (!BBI->use_empty())
1142 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
1143 BB->getInstList().erase(BBI++);
1144 }
1145}
1146
1147/// changeToCall - Convert the specified invoke into a normal call.
1148static void changeToCall(InvokeInst *II) {
1149 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
1150 CallInst *NewCall = CallInst::Create(II->getCalledValue(), Args, "", II);
1151 NewCall->takeName(II);
1152 NewCall->setCallingConv(II->getCallingConv());
1153 NewCall->setAttributes(II->getAttributes());
1154 NewCall->setDebugLoc(II->getDebugLoc());
1155 II->replaceAllUsesWith(NewCall);
1156
1157 // Follow the call by a branch to the normal destination.
1158 BranchInst::Create(II->getNormalDest(), II);
1159
1160 // Update PHI nodes in the unwind destination
1161 II->getUnwindDest()->removePredecessor(II->getParent());
1162 II->eraseFromParent();
1163}
1164
1165static bool markAliveBlocks(BasicBlock *BB,
1166 SmallPtrSet<BasicBlock*, 128> &Reachable) {
1167
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001168 SmallVector<BasicBlock*, 128> Worklist;
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001169 Worklist.push_back(BB);
1170 Reachable.insert(BB);
1171 bool Changed = false;
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001172 do {
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001173 BB = Worklist.pop_back_val();
1174
1175 // Do a quick scan of the basic block, turning any obviously unreachable
1176 // instructions into LLVM unreachable insts. The instruction combining pass
1177 // canonicalizes unreachable insts into stores to null or undef.
1178 for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E;++BBI){
1179 if (CallInst *CI = dyn_cast<CallInst>(BBI)) {
1180 if (CI->doesNotReturn()) {
1181 // If we found a call to a no-return function, insert an unreachable
1182 // instruction after it. Make sure there isn't *already* one there
1183 // though.
1184 ++BBI;
1185 if (!isa<UnreachableInst>(BBI)) {
1186 // Don't insert a call to llvm.trap right before the unreachable.
1187 changeToUnreachable(BBI, false);
1188 Changed = true;
1189 }
1190 break;
1191 }
1192 }
1193
1194 // Store to undef and store to null are undefined and used to signal that
1195 // they should be changed to unreachable by passes that can't modify the
1196 // CFG.
1197 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
1198 // Don't touch volatile stores.
1199 if (SI->isVolatile()) continue;
1200
1201 Value *Ptr = SI->getOperand(1);
1202
1203 if (isa<UndefValue>(Ptr) ||
1204 (isa<ConstantPointerNull>(Ptr) &&
1205 SI->getPointerAddressSpace() == 0)) {
1206 changeToUnreachable(SI, true);
1207 Changed = true;
1208 break;
1209 }
1210 }
1211 }
1212
1213 // Turn invokes that call 'nounwind' functions into ordinary calls.
1214 if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
1215 Value *Callee = II->getCalledValue();
1216 if (isa<ConstantPointerNull>(Callee) || isa<UndefValue>(Callee)) {
1217 changeToUnreachable(II, true);
1218 Changed = true;
1219 } else if (II->doesNotThrow()) {
1220 if (II->use_empty() && II->onlyReadsMemory()) {
1221 // jump to the normal destination branch.
1222 BranchInst::Create(II->getNormalDest(), II);
1223 II->getUnwindDest()->removePredecessor(II->getParent());
1224 II->eraseFromParent();
1225 } else
1226 changeToCall(II);
1227 Changed = true;
1228 }
1229 }
1230
1231 Changed |= ConstantFoldTerminator(BB, true);
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001232 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
1233 if (Reachable.insert(*SI))
1234 Worklist.push_back(*SI);
1235 } while (!Worklist.empty());
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001236 return Changed;
1237}
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001238
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001239/// removeUnreachableBlocksFromFn - Remove blocks that are not reachable, even
1240/// if they are in a dead cycle. Return true if a change was made, false
1241/// otherwise.
1242bool llvm::removeUnreachableBlocks(Function &F) {
1243 SmallPtrSet<BasicBlock*, 128> Reachable;
1244 bool Changed = markAliveBlocks(F.begin(), Reachable);
1245
1246 // If there are unreachable blocks in the CFG...
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001247 if (Reachable.size() == F.size())
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001248 return Changed;
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001249
1250 assert(Reachable.size() < F.size());
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001251 NumRemoved += F.size()-Reachable.size();
1252
1253 // Loop over all of the basic blocks that are not reachable, dropping all of
1254 // their internal references...
1255 for (Function::iterator BB = ++F.begin(), E = F.end(); BB != E; ++BB) {
1256 if (Reachable.count(BB))
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001257 continue;
1258
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001259 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001260 if (Reachable.count(*SI))
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001261 (*SI)->removePredecessor(BB);
1262 BB->dropAllReferences();
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001263 }
Evgeniy Stepanov7541cd32013-03-22 08:43:04 +00001264
Peter Collingbourne4f96b7e2013-08-12 22:38:43 +00001265 for (Function::iterator I = ++F.begin(); I != F.end();)
Evgeniy Stepanov7541cd32013-03-22 08:43:04 +00001266 if (!Reachable.count(I))
1267 I = F.getBasicBlockList().erase(I);
1268 else
1269 ++I;
1270
Evgeniy Stepanov3333e662012-12-21 11:18:49 +00001271 return true;
1272}