blob: a5e443fcf46b165b04c1f3d4ead8acdfc0dee345 [file] [log] [blame]
Chris Lattner28537df2002-05-07 18:07:59 +00001//===-- Local.cpp - Functions to perform local transformations ------------===//
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 Lattner28537df2002-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 Carruthed0881b2012-12-03 16:50:05 +000016#include "llvm/ADT/DenseMap.h"
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +000017#include "llvm/ADT/STLExtras.h"
Chandler Carruthbe810232013-01-02 10:22:59 +000018#include "llvm/ADT/SmallPtrSet.h"
Peter Collingbourne8d642de2013-08-12 22:38:43 +000019#include "llvm/ADT/Statistic.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000020#include "llvm/Analysis/InstructionSimplify.h"
21#include "llvm/Analysis/MemoryBuiltins.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000022#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000023#include "llvm/IR/CFG.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000024#include "llvm/IR/Constants.h"
Chandler Carruth12664a02014-03-06 00:22:06 +000025#include "llvm/IR/DIBuilder.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000027#include "llvm/IR/DebugInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000028#include "llvm/IR/DerivedTypes.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000029#include "llvm/IR/Dominators.h"
Chandler Carruth03eb0de2014-03-04 10:40:04 +000030#include "llvm/IR/GetElementPtrTypeIterator.h"
Chandler Carruth9fb823b2013-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"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000040#include "llvm/IR/ValueHandle.h"
Chris Lattnercbd18fc2009-11-10 05:59:26 +000041#include "llvm/Support/Debug.h"
Chris Lattnerc13c7b92005-09-26 05:27:10 +000042#include "llvm/Support/MathExtras.h"
Chris Lattnercbd18fc2009-11-10 05:59:26 +000043#include "llvm/Support/raw_ostream.h"
Chris Lattner04efa4b2003-12-19 05:56:28 +000044using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000045
Chandler Carruthe96dd892014-04-21 22:55:11 +000046#define DEBUG_TYPE "local"
47
Peter Collingbourne8d642de2013-08-12 22:38:43 +000048STATISTIC(NumRemoved, "Number of unreachable basic blocks removed");
49
Chris Lattner28537df2002-05-07 18:07:59 +000050//===----------------------------------------------------------------------===//
Chris Lattnerc6c481c2008-11-27 22:57:53 +000051// Local constant propagation.
Chris Lattner28537df2002-05-07 18:07:59 +000052//
53
Frits van Bommelad964552011-05-22 16:24:18 +000054/// ConstantFoldTerminator - If a terminator instruction is predicated on a
55/// constant value, convert it into an unconditional branch to the constant
56/// destination. This is a nontrivial operation because the successors of this
57/// basic block must have their PHI nodes updated.
58/// Also calls RecursivelyDeleteTriviallyDeadInstructions() on any branch/switch
59/// conditions and indirectbr addresses this might make dead if
60/// DeleteDeadConditions is true.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +000061bool llvm::ConstantFoldTerminator(BasicBlock *BB, bool DeleteDeadConditions,
62 const TargetLibraryInfo *TLI) {
Chris Lattner4b009ad2002-05-21 20:04:50 +000063 TerminatorInst *T = BB->getTerminator();
Devang Patel1fabbe92011-05-18 17:26:46 +000064 IRBuilder<> Builder(T);
Misha Brukmanb1c93172005-04-21 23:48:37 +000065
Chris Lattner28537df2002-05-07 18:07:59 +000066 // Branch - See if we are conditional jumping on constant
67 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
68 if (BI->isUnconditional()) return false; // Can't optimize uncond branch
Gabor Greif97f17202009-01-30 18:21:13 +000069 BasicBlock *Dest1 = BI->getSuccessor(0);
70 BasicBlock *Dest2 = BI->getSuccessor(1);
Chris Lattner28537df2002-05-07 18:07:59 +000071
Zhou Sheng75b871f2007-01-11 12:24:14 +000072 if (ConstantInt *Cond = dyn_cast<ConstantInt>(BI->getCondition())) {
Chris Lattner28537df2002-05-07 18:07:59 +000073 // Are we branching on constant?
74 // YES. Change to unconditional branch...
Reid Spencercddc9df2007-01-12 04:24:46 +000075 BasicBlock *Destination = Cond->getZExtValue() ? Dest1 : Dest2;
76 BasicBlock *OldDest = Cond->getZExtValue() ? Dest2 : Dest1;
Chris Lattner28537df2002-05-07 18:07:59 +000077
Misha Brukmanb1c93172005-04-21 23:48:37 +000078 //cerr << "Function: " << T->getParent()->getParent()
79 // << "\nRemoving branch from " << T->getParent()
Chris Lattner28537df2002-05-07 18:07:59 +000080 // << "\n\nTo: " << OldDest << endl;
81
82 // Let the basic block know that we are letting go of it. Based on this,
83 // it will adjust it's PHI nodes.
Jay Foad6a85be22011-04-19 15:23:29 +000084 OldDest->removePredecessor(BB);
Chris Lattner28537df2002-05-07 18:07:59 +000085
Jay Foad89afb432011-01-07 20:25:56 +000086 // Replace the conditional branch with an unconditional one.
Devang Patel1fabbe92011-05-18 17:26:46 +000087 Builder.CreateBr(Destination);
Jay Foad89afb432011-01-07 20:25:56 +000088 BI->eraseFromParent();
Chris Lattner28537df2002-05-07 18:07:59 +000089 return true;
Chris Lattner54a4b842009-11-01 03:40:38 +000090 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +000091
Chris Lattner54a4b842009-11-01 03:40:38 +000092 if (Dest2 == Dest1) { // Conditional branch to same location?
Misha Brukmanb1c93172005-04-21 23:48:37 +000093 // This branch matches something like this:
Chris Lattner28537df2002-05-07 18:07:59 +000094 // br bool %cond, label %Dest, label %Dest
95 // and changes it into: br label %Dest
96
97 // Let the basic block know that we are letting go of one copy of it.
98 assert(BI->getParent() && "Terminator not inserted in block!");
99 Dest1->removePredecessor(BI->getParent());
100
Jay Foad89afb432011-01-07 20:25:56 +0000101 // Replace the conditional branch with an unconditional one.
Devang Patel1fabbe92011-05-18 17:26:46 +0000102 Builder.CreateBr(Dest1);
Frits van Bommelad964552011-05-22 16:24:18 +0000103 Value *Cond = BI->getCondition();
Jay Foad89afb432011-01-07 20:25:56 +0000104 BI->eraseFromParent();
Frits van Bommelad964552011-05-22 16:24:18 +0000105 if (DeleteDeadConditions)
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000106 RecursivelyDeleteTriviallyDeadInstructions(Cond, TLI);
Chris Lattner28537df2002-05-07 18:07:59 +0000107 return true;
108 }
Chris Lattner54a4b842009-11-01 03:40:38 +0000109 return false;
110 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000111
Chris Lattner54a4b842009-11-01 03:40:38 +0000112 if (SwitchInst *SI = dyn_cast<SwitchInst>(T)) {
Chris Lattner821deee2003-08-17 20:21:14 +0000113 // If we are switching on a constant, we can convert the switch into a
114 // single branch instruction!
115 ConstantInt *CI = dyn_cast<ConstantInt>(SI->getCondition());
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +0000116 BasicBlock *TheOnlyDest = SI->getDefaultDest();
Chris Lattnerc54d6082003-08-23 23:18:19 +0000117 BasicBlock *DefaultDest = TheOnlyDest;
Chris Lattner031340a2003-08-17 19:41:53 +0000118
Chris Lattner54a4b842009-11-01 03:40:38 +0000119 // Figure out which case it goes to.
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +0000120 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +0000121 i != e; ++i) {
Chris Lattner821deee2003-08-17 20:21:14 +0000122 // Found case matching a constant operand?
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +0000123 if (i.getCaseValue() == CI) {
124 TheOnlyDest = i.getCaseSuccessor();
Chris Lattner821deee2003-08-17 20:21:14 +0000125 break;
126 }
Chris Lattner031340a2003-08-17 19:41:53 +0000127
Chris Lattnerc54d6082003-08-23 23:18:19 +0000128 // Check to see if this branch is going to the same place as the default
129 // dest. If so, eliminate it as an explicit compare.
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +0000130 if (i.getCaseSuccessor() == DefaultDest) {
Manman Ren49dbe252012-09-12 17:04:11 +0000131 MDNode* MD = SI->getMetadata(LLVMContext::MD_prof);
Justin Bognera41a7b32013-12-10 00:13:41 +0000132 unsigned NCases = SI->getNumCases();
133 // Fold the case metadata into the default if there will be any branches
134 // left, unless the metadata doesn't match the switch.
135 if (NCases > 1 && MD && MD->getNumOperands() == 2 + NCases) {
Manman Ren49dbe252012-09-12 17:04:11 +0000136 // Collect branch weights into a vector.
137 SmallVector<uint32_t, 8> Weights;
138 for (unsigned MD_i = 1, MD_e = MD->getNumOperands(); MD_i < MD_e;
139 ++MD_i) {
140 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(MD_i));
141 assert(CI);
142 Weights.push_back(CI->getValue().getZExtValue());
143 }
144 // Merge weight of this case to the default weight.
145 unsigned idx = i.getCaseIndex();
146 Weights[0] += Weights[idx+1];
147 // Remove weight for this case.
148 std::swap(Weights[idx+1], Weights.back());
149 Weights.pop_back();
150 SI->setMetadata(LLVMContext::MD_prof,
151 MDBuilder(BB->getContext()).
152 createBranchWeights(Weights));
153 }
Chris Lattner54a4b842009-11-01 03:40:38 +0000154 // Remove this entry.
Chris Lattnerc54d6082003-08-23 23:18:19 +0000155 DefaultDest->removePredecessor(SI->getParent());
156 SI->removeCase(i);
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +0000157 --i; --e;
Chris Lattnerc54d6082003-08-23 23:18:19 +0000158 continue;
159 }
160
Chris Lattner821deee2003-08-17 20:21:14 +0000161 // Otherwise, check to see if the switch only branches to one destination.
162 // We do this by reseting "TheOnlyDest" to null when we find two non-equal
163 // destinations.
Craig Topperf40110f2014-04-25 05:29:35 +0000164 if (i.getCaseSuccessor() != TheOnlyDest) TheOnlyDest = nullptr;
Chris Lattner031340a2003-08-17 19:41:53 +0000165 }
166
Chris Lattner821deee2003-08-17 20:21:14 +0000167 if (CI && !TheOnlyDest) {
168 // Branching on a constant, but not any of the cases, go to the default
169 // successor.
170 TheOnlyDest = SI->getDefaultDest();
171 }
172
173 // If we found a single destination that we can fold the switch into, do so
174 // now.
175 if (TheOnlyDest) {
Chris Lattner54a4b842009-11-01 03:40:38 +0000176 // Insert the new branch.
Devang Patel1fabbe92011-05-18 17:26:46 +0000177 Builder.CreateBr(TheOnlyDest);
Chris Lattner821deee2003-08-17 20:21:14 +0000178 BasicBlock *BB = SI->getParent();
179
180 // Remove entries from PHI nodes which we no longer branch to...
181 for (unsigned i = 0, e = SI->getNumSuccessors(); i != e; ++i) {
182 // Found case matching a constant operand?
183 BasicBlock *Succ = SI->getSuccessor(i);
184 if (Succ == TheOnlyDest)
Craig Topperf40110f2014-04-25 05:29:35 +0000185 TheOnlyDest = nullptr; // Don't modify the first branch to TheOnlyDest
Chris Lattner821deee2003-08-17 20:21:14 +0000186 else
187 Succ->removePredecessor(BB);
188 }
189
Chris Lattner54a4b842009-11-01 03:40:38 +0000190 // Delete the old switch.
Frits van Bommelad964552011-05-22 16:24:18 +0000191 Value *Cond = SI->getCondition();
192 SI->eraseFromParent();
193 if (DeleteDeadConditions)
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000194 RecursivelyDeleteTriviallyDeadInstructions(Cond, TLI);
Chris Lattner821deee2003-08-17 20:21:14 +0000195 return true;
Chris Lattner54a4b842009-11-01 03:40:38 +0000196 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000197
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +0000198 if (SI->getNumCases() == 1) {
Chris Lattner821deee2003-08-17 20:21:14 +0000199 // Otherwise, we can fold this switch into a conditional branch
200 // instruction if it has only one non-default destination.
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +0000201 SwitchInst::CaseIt FirstCase = SI->case_begin();
Bob Wilsone4077362013-09-09 19:14:35 +0000202 Value *Cond = Builder.CreateICmpEQ(SI->getCondition(),
203 FirstCase.getCaseValue(), "cond");
Devang Patel1fabbe92011-05-18 17:26:46 +0000204
Bob Wilsone4077362013-09-09 19:14:35 +0000205 // Insert the new branch.
206 BranchInst *NewBr = Builder.CreateCondBr(Cond,
207 FirstCase.getCaseSuccessor(),
208 SI->getDefaultDest());
209 MDNode* MD = SI->getMetadata(LLVMContext::MD_prof);
210 if (MD && MD->getNumOperands() == 3) {
211 ConstantInt *SICase = dyn_cast<ConstantInt>(MD->getOperand(2));
212 ConstantInt *SIDef = dyn_cast<ConstantInt>(MD->getOperand(1));
213 assert(SICase && SIDef);
214 // The TrueWeight should be the weight for the single case of SI.
215 NewBr->setMetadata(LLVMContext::MD_prof,
216 MDBuilder(BB->getContext()).
217 createBranchWeights(SICase->getValue().getZExtValue(),
218 SIDef->getValue().getZExtValue()));
Stepan Dyatkovskiy7a501552012-05-23 08:18:26 +0000219 }
Bob Wilsone4077362013-09-09 19:14:35 +0000220
221 // Delete the old switch.
222 SI->eraseFromParent();
223 return true;
Chris Lattner821deee2003-08-17 20:21:14 +0000224 }
Chris Lattner54a4b842009-11-01 03:40:38 +0000225 return false;
Chris Lattner28537df2002-05-07 18:07:59 +0000226 }
Chris Lattner54a4b842009-11-01 03:40:38 +0000227
228 if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(T)) {
229 // indirectbr blockaddress(@F, @BB) -> br label @BB
230 if (BlockAddress *BA =
231 dyn_cast<BlockAddress>(IBI->getAddress()->stripPointerCasts())) {
232 BasicBlock *TheOnlyDest = BA->getBasicBlock();
233 // Insert the new branch.
Devang Patel1fabbe92011-05-18 17:26:46 +0000234 Builder.CreateBr(TheOnlyDest);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000235
Chris Lattner54a4b842009-11-01 03:40:38 +0000236 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
237 if (IBI->getDestination(i) == TheOnlyDest)
Craig Topperf40110f2014-04-25 05:29:35 +0000238 TheOnlyDest = nullptr;
Chris Lattner54a4b842009-11-01 03:40:38 +0000239 else
240 IBI->getDestination(i)->removePredecessor(IBI->getParent());
241 }
Frits van Bommelad964552011-05-22 16:24:18 +0000242 Value *Address = IBI->getAddress();
Chris Lattner54a4b842009-11-01 03:40:38 +0000243 IBI->eraseFromParent();
Frits van Bommelad964552011-05-22 16:24:18 +0000244 if (DeleteDeadConditions)
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000245 RecursivelyDeleteTriviallyDeadInstructions(Address, TLI);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000246
Chris Lattner54a4b842009-11-01 03:40:38 +0000247 // If we didn't find our destination in the IBI successor list, then we
248 // have undefined behavior. Replace the unconditional branch with an
249 // 'unreachable' instruction.
250 if (TheOnlyDest) {
251 BB->getTerminator()->eraseFromParent();
252 new UnreachableInst(BB->getContext(), BB);
253 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000254
Chris Lattner54a4b842009-11-01 03:40:38 +0000255 return true;
256 }
257 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000258
Chris Lattner28537df2002-05-07 18:07:59 +0000259 return false;
260}
261
Chris Lattner28537df2002-05-07 18:07:59 +0000262
263//===----------------------------------------------------------------------===//
Chris Lattner852d6d62009-11-10 22:26:15 +0000264// Local dead code elimination.
Chris Lattner28537df2002-05-07 18:07:59 +0000265//
266
Chris Lattnerc6c481c2008-11-27 22:57:53 +0000267/// isInstructionTriviallyDead - Return true if the result produced by the
268/// instruction is not used, and the instruction has no side effects.
269///
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000270bool llvm::isInstructionTriviallyDead(Instruction *I,
271 const TargetLibraryInfo *TLI) {
Chris Lattnera36d5252005-05-06 05:27:34 +0000272 if (!I->use_empty() || isa<TerminatorInst>(I)) return false;
Jeff Cohen5f4ef3c2005-07-27 06:12:32 +0000273
Bill Wendlingd9fb4702011-08-15 20:10:51 +0000274 // We don't want the landingpad instruction removed by anything this general.
275 if (isa<LandingPadInst>(I))
276 return false;
277
Devang Patelc1431e62011-03-18 23:28:02 +0000278 // We don't want debug info removed by anything this general, unless
279 // debug info is empty.
280 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(I)) {
Nick Lewycky99890a22011-08-02 21:19:27 +0000281 if (DDI->getAddress())
Devang Patelc1431e62011-03-18 23:28:02 +0000282 return false;
Devang Patel17bbd7f2011-03-21 22:04:45 +0000283 return true;
Nick Lewycky99890a22011-08-02 21:19:27 +0000284 }
Devang Patel17bbd7f2011-03-21 22:04:45 +0000285 if (DbgValueInst *DVI = dyn_cast<DbgValueInst>(I)) {
Devang Patelc1431e62011-03-18 23:28:02 +0000286 if (DVI->getValue())
287 return false;
Devang Patel17bbd7f2011-03-21 22:04:45 +0000288 return true;
Devang Patelc1431e62011-03-18 23:28:02 +0000289 }
290
Duncan Sands1efabaa2009-05-06 06:49:50 +0000291 if (!I->mayHaveSideEffects()) return true;
292
293 // Special case intrinsics that "may have side effects" but can be deleted
294 // when dead.
Nick Lewycky99890a22011-08-02 21:19:27 +0000295 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
Chris Lattnere9665832007-12-29 00:59:12 +0000296 // Safe to delete llvm.stacksave if dead.
297 if (II->getIntrinsicID() == Intrinsic::stacksave)
298 return true;
Nick Lewycky99890a22011-08-02 21:19:27 +0000299
300 // Lifetime intrinsics are dead when their right-hand is undef.
301 if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
302 II->getIntrinsicID() == Intrinsic::lifetime_end)
303 return isa<UndefValue>(II->getArgOperand(1));
304 }
Nick Lewyckydd1d3df2011-10-24 04:35:36 +0000305
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000306 if (isAllocLikeFn(I, TLI)) return true;
Nick Lewyckydd1d3df2011-10-24 04:35:36 +0000307
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000308 if (CallInst *CI = isFreeCall(I, TLI))
Nick Lewyckydd1d3df2011-10-24 04:35:36 +0000309 if (Constant *C = dyn_cast<Constant>(CI->getArgOperand(0)))
310 return C->isNullValue() || isa<UndefValue>(C);
311
Chris Lattnera36d5252005-05-06 05:27:34 +0000312 return false;
Chris Lattner28537df2002-05-07 18:07:59 +0000313}
314
Chris Lattnerc6c481c2008-11-27 22:57:53 +0000315/// RecursivelyDeleteTriviallyDeadInstructions - If the specified value is a
316/// trivially dead instruction, delete it. If that makes any of its operands
Dan Gohmancb99fe92010-01-05 15:45:31 +0000317/// trivially dead, delete them too, recursively. Return true if any
318/// instructions were deleted.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000319bool
320llvm::RecursivelyDeleteTriviallyDeadInstructions(Value *V,
321 const TargetLibraryInfo *TLI) {
Chris Lattnerc6c481c2008-11-27 22:57:53 +0000322 Instruction *I = dyn_cast<Instruction>(V);
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000323 if (!I || !I->use_empty() || !isInstructionTriviallyDead(I, TLI))
Dan Gohmancb99fe92010-01-05 15:45:31 +0000324 return false;
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000325
Chris Lattnere9f6c352008-11-28 01:20:46 +0000326 SmallVector<Instruction*, 16> DeadInsts;
327 DeadInsts.push_back(I);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000328
Dan Gohman28943872010-01-05 16:27:25 +0000329 do {
Dan Gohman9a6fef02009-05-06 17:22:41 +0000330 I = DeadInsts.pop_back_val();
Chris Lattnerd4b5ba62008-11-28 00:58:15 +0000331
Chris Lattnere9f6c352008-11-28 01:20:46 +0000332 // Null out all of the instruction's operands to see if any operand becomes
333 // dead as we go.
334 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
335 Value *OpV = I->getOperand(i);
Craig Topperf40110f2014-04-25 05:29:35 +0000336 I->setOperand(i, nullptr);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000337
Chris Lattnere9f6c352008-11-28 01:20:46 +0000338 if (!OpV->use_empty()) continue;
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000339
Chris Lattnere9f6c352008-11-28 01:20:46 +0000340 // If the operand is an instruction that became dead as we nulled out the
341 // operand, and if it is 'trivially' dead, delete it in a future loop
342 // iteration.
343 if (Instruction *OpI = dyn_cast<Instruction>(OpV))
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000344 if (isInstructionTriviallyDead(OpI, TLI))
Chris Lattnere9f6c352008-11-28 01:20:46 +0000345 DeadInsts.push_back(OpI);
346 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000347
Chris Lattnere9f6c352008-11-28 01:20:46 +0000348 I->eraseFromParent();
Dan Gohman28943872010-01-05 16:27:25 +0000349 } while (!DeadInsts.empty());
Dan Gohmancb99fe92010-01-05 15:45:31 +0000350
351 return true;
Chris Lattner28537df2002-05-07 18:07:59 +0000352}
Chris Lattner99d68092008-11-27 07:43:12 +0000353
Nick Lewyckyc8a15692011-02-20 08:38:20 +0000354/// areAllUsesEqual - Check whether the uses of a value are all the same.
355/// This is similar to Instruction::hasOneUse() except this will also return
Duncan Sands6dcd49b2011-02-21 16:27:36 +0000356/// true when there are no uses or multiple uses that all refer to the same
357/// value.
Nick Lewyckyc8a15692011-02-20 08:38:20 +0000358static bool areAllUsesEqual(Instruction *I) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000359 Value::user_iterator UI = I->user_begin();
360 Value::user_iterator UE = I->user_end();
Nick Lewyckyc8a15692011-02-20 08:38:20 +0000361 if (UI == UE)
Duncan Sands6dcd49b2011-02-21 16:27:36 +0000362 return true;
Nick Lewyckyc8a15692011-02-20 08:38:20 +0000363
364 User *TheUse = *UI;
365 for (++UI; UI != UE; ++UI) {
366 if (*UI != TheUse)
367 return false;
368 }
369 return true;
370}
371
Dan Gohmanff089952009-05-02 18:29:22 +0000372/// RecursivelyDeleteDeadPHINode - If the specified value is an effectively
373/// dead PHI node, due to being a def-use chain of single-use nodes that
374/// either forms a cycle or is terminated by a trivially dead instruction,
375/// delete it. If that makes any of its operands trivially dead, delete them
Duncan Sandsecbbf082011-02-21 17:32:05 +0000376/// too, recursively. Return true if a change was made.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000377bool llvm::RecursivelyDeleteDeadPHINode(PHINode *PN,
378 const TargetLibraryInfo *TLI) {
Duncan Sands6dcd49b2011-02-21 16:27:36 +0000379 SmallPtrSet<Instruction*, 4> Visited;
380 for (Instruction *I = PN; areAllUsesEqual(I) && !I->mayHaveSideEffects();
Chandler Carruthcdf47882014-03-09 03:16:01 +0000381 I = cast<Instruction>(*I->user_begin())) {
Duncan Sands6dcd49b2011-02-21 16:27:36 +0000382 if (I->use_empty())
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000383 return RecursivelyDeleteTriviallyDeadInstructions(I, TLI);
Nick Lewycky183c24c2011-02-20 18:05:56 +0000384
Duncan Sands6dcd49b2011-02-21 16:27:36 +0000385 // If we find an instruction more than once, we're on a cycle that
Dan Gohmanff089952009-05-02 18:29:22 +0000386 // won't prove fruitful.
Duncan Sands6dcd49b2011-02-21 16:27:36 +0000387 if (!Visited.insert(I)) {
388 // Break the cycle and delete the instruction and its operands.
389 I->replaceAllUsesWith(UndefValue::get(I->getType()));
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000390 (void)RecursivelyDeleteTriviallyDeadInstructions(I, TLI);
Duncan Sandsecbbf082011-02-21 17:32:05 +0000391 return true;
Duncan Sands6dcd49b2011-02-21 16:27:36 +0000392 }
393 }
394 return false;
Dan Gohmanff089952009-05-02 18:29:22 +0000395}
Chris Lattnerc6c481c2008-11-27 22:57:53 +0000396
Chris Lattner7c743f22010-01-12 19:40:54 +0000397/// SimplifyInstructionsInBlock - Scan the specified basic block and try to
398/// simplify any instructions in it and recursively delete dead instructions.
399///
400/// This returns true if it changed the code, note that it can delete
401/// instructions in other blocks as well in this block.
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000402bool llvm::SimplifyInstructionsInBlock(BasicBlock *BB, const DataLayout *TD,
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000403 const TargetLibraryInfo *TLI) {
Chris Lattner7c743f22010-01-12 19:40:54 +0000404 bool MadeChange = false;
Chandler Carruth0c72e3f2012-03-25 03:29:25 +0000405
406#ifndef NDEBUG
407 // In debug builds, ensure that the terminator of the block is never replaced
408 // or deleted by these simplifications. The idea of simplification is that it
409 // cannot introduce new instructions, and there is no way to replace the
410 // terminator of a block without introducing a new instruction.
411 AssertingVH<Instruction> TerminatorVH(--BB->end());
412#endif
413
Chandler Carruth17fc6ef2012-03-24 23:03:27 +0000414 for (BasicBlock::iterator BI = BB->begin(), E = --BB->end(); BI != E; ) {
415 assert(!BI->isTerminator());
Chris Lattner7c743f22010-01-12 19:40:54 +0000416 Instruction *Inst = BI++;
Chandler Carruthcf1b5852012-03-24 21:11:24 +0000417
418 WeakVH BIHandle(BI);
Benjamin Kramer30d249a2013-09-24 16:37:40 +0000419 if (recursivelySimplifyInstruction(Inst, TD, TLI)) {
Chris Lattner7c743f22010-01-12 19:40:54 +0000420 MadeChange = true;
Chris Lattnere41ab072010-07-15 06:06:04 +0000421 if (BIHandle != BI)
Chris Lattner7c743f22010-01-12 19:40:54 +0000422 BI = BB->begin();
423 continue;
424 }
Eli Friedman17bf4922011-04-02 22:45:17 +0000425
Benjamin Kramer8bcc9712012-08-29 15:32:21 +0000426 MadeChange |= RecursivelyDeleteTriviallyDeadInstructions(Inst, TLI);
Eli Friedman17bf4922011-04-02 22:45:17 +0000427 if (BIHandle != BI)
428 BI = BB->begin();
Chris Lattner7c743f22010-01-12 19:40:54 +0000429 }
430 return MadeChange;
431}
432
Chris Lattner99d68092008-11-27 07:43:12 +0000433//===----------------------------------------------------------------------===//
Chris Lattner852d6d62009-11-10 22:26:15 +0000434// Control Flow Graph Restructuring.
Chris Lattner99d68092008-11-27 07:43:12 +0000435//
436
Chris Lattner852d6d62009-11-10 22:26:15 +0000437
438/// RemovePredecessorAndSimplify - Like BasicBlock::removePredecessor, this
439/// method is called when we're about to delete Pred as a predecessor of BB. If
440/// BB contains any PHI nodes, this drops the entries in the PHI nodes for Pred.
441///
442/// Unlike the removePredecessor method, this attempts to simplify uses of PHI
443/// nodes that collapse into identity values. For example, if we have:
444/// x = phi(1, 0, 0, 0)
445/// y = and x, z
446///
447/// .. and delete the predecessor corresponding to the '1', this will attempt to
448/// recursively fold the and to 0.
449void llvm::RemovePredecessorAndSimplify(BasicBlock *BB, BasicBlock *Pred,
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000450 DataLayout *TD) {
Chris Lattner852d6d62009-11-10 22:26:15 +0000451 // This only adjusts blocks with PHI nodes.
452 if (!isa<PHINode>(BB->begin()))
453 return;
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000454
Chris Lattner852d6d62009-11-10 22:26:15 +0000455 // Remove the entries for Pred from the PHI nodes in BB, but do not simplify
456 // them down. This will leave us with single entry phi nodes and other phis
457 // that can be removed.
458 BB->removePredecessor(Pred, true);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000459
Chris Lattner852d6d62009-11-10 22:26:15 +0000460 WeakVH PhiIt = &BB->front();
461 while (PHINode *PN = dyn_cast<PHINode>(PhiIt)) {
462 PhiIt = &*++BasicBlock::iterator(cast<Instruction>(PhiIt));
Chris Lattnere41ab072010-07-15 06:06:04 +0000463 Value *OldPhiIt = PhiIt;
Chandler Carruthcf1b5852012-03-24 21:11:24 +0000464
465 if (!recursivelySimplifyInstruction(PN, TD))
466 continue;
467
Chris Lattner852d6d62009-11-10 22:26:15 +0000468 // If recursive simplification ended up deleting the next PHI node we would
469 // iterate to, then our iterator is invalid, restart scanning from the top
470 // of the block.
Chris Lattnere41ab072010-07-15 06:06:04 +0000471 if (PhiIt != OldPhiIt) PhiIt = &BB->front();
Chris Lattner852d6d62009-11-10 22:26:15 +0000472 }
473}
474
475
Chris Lattner99d68092008-11-27 07:43:12 +0000476/// MergeBasicBlockIntoOnlyPred - DestBB is a block with one predecessor and its
477/// predecessor is known to have one successor (DestBB!). Eliminate the edge
478/// between them, moving the instructions in the predecessor into DestBB and
479/// deleting the predecessor block.
480///
Andreas Neustifterf8cb7582009-09-16 09:26:52 +0000481void llvm::MergeBasicBlockIntoOnlyPred(BasicBlock *DestBB, Pass *P) {
Chris Lattner99d68092008-11-27 07:43:12 +0000482 // If BB has single-entry PHI nodes, fold them.
483 while (PHINode *PN = dyn_cast<PHINode>(DestBB->begin())) {
484 Value *NewVal = PN->getIncomingValue(0);
485 // Replace self referencing PHI with undef, it must be dead.
Owen Andersonb292b8c2009-07-30 23:03:37 +0000486 if (NewVal == PN) NewVal = UndefValue::get(PN->getType());
Chris Lattner99d68092008-11-27 07:43:12 +0000487 PN->replaceAllUsesWith(NewVal);
488 PN->eraseFromParent();
489 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000490
Chris Lattner99d68092008-11-27 07:43:12 +0000491 BasicBlock *PredBB = DestBB->getSinglePredecessor();
492 assert(PredBB && "Block doesn't have a single predecessor!");
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000493
Chris Lattner6fbfe582010-02-15 20:47:49 +0000494 // Zap anything that took the address of DestBB. Not doing this will give the
495 // address an invalid value.
496 if (DestBB->hasAddressTaken()) {
497 BlockAddress *BA = BlockAddress::get(DestBB);
498 Constant *Replacement =
499 ConstantInt::get(llvm::Type::getInt32Ty(BA->getContext()), 1);
500 BA->replaceAllUsesWith(ConstantExpr::getIntToPtr(Replacement,
501 BA->getType()));
502 BA->destroyConstant();
503 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000504
Chris Lattner99d68092008-11-27 07:43:12 +0000505 // Anything that branched to PredBB now branches to DestBB.
506 PredBB->replaceAllUsesWith(DestBB);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000507
Jay Foad61ea0e42011-06-23 09:09:15 +0000508 // Splice all the instructions from PredBB to DestBB.
509 PredBB->getTerminator()->eraseFromParent();
Bill Wendling90dd90a2013-10-21 04:09:17 +0000510 DestBB->getInstList().splice(DestBB->begin(), PredBB->getInstList());
Jay Foad61ea0e42011-06-23 09:09:15 +0000511
Owen Andersona8d1c3e2014-07-12 07:12:47 +0000512 // If the PredBB is the entry block of the function, move DestBB up to
513 // become the entry block after we erase PredBB.
514 if (PredBB == &DestBB->getParent()->getEntryBlock())
515 DestBB->moveAfter(PredBB);
516
Andreas Neustifterf8cb7582009-09-16 09:26:52 +0000517 if (P) {
Chandler Carruth73523022014-01-13 13:07:17 +0000518 if (DominatorTreeWrapperPass *DTWP =
519 P->getAnalysisIfAvailable<DominatorTreeWrapperPass>()) {
520 DominatorTree &DT = DTWP->getDomTree();
521 BasicBlock *PredBBIDom = DT.getNode(PredBB)->getIDom()->getBlock();
522 DT.changeImmediateDominator(DestBB, PredBBIDom);
523 DT.eraseNode(PredBB);
Cameron Zwarich84986b22011-01-08 17:01:52 +0000524 }
Andreas Neustifterf8cb7582009-09-16 09:26:52 +0000525 }
Chris Lattner99d68092008-11-27 07:43:12 +0000526 // Nuke BB.
527 PredBB->eraseFromParent();
528}
Devang Patelcaf44852009-02-10 07:00:59 +0000529
Duncan Sandse773c082013-07-11 08:28:20 +0000530/// CanMergeValues - Return true if we can choose one of these values to use
531/// in place of the other. Note that we will always choose the non-undef
532/// value to keep.
533static bool CanMergeValues(Value *First, Value *Second) {
534 return First == Second || isa<UndefValue>(First) || isa<UndefValue>(Second);
535}
536
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000537/// CanPropagatePredecessorsForPHIs - Return true if we can fold BB, an
Mark Laceya2626552013-08-14 22:11:42 +0000538/// almost-empty BB ending in an unconditional branch to Succ, into Succ.
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000539///
540/// Assumption: Succ is the single successor for BB.
541///
542static bool CanPropagatePredecessorsForPHIs(BasicBlock *BB, BasicBlock *Succ) {
543 assert(*succ_begin(BB) == Succ && "Succ is not successor of BB!");
544
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000545 DEBUG(dbgs() << "Looking to fold " << BB->getName() << " into "
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000546 << Succ->getName() << "\n");
547 // Shortcut, if there is only a single predecessor it must be BB and merging
548 // is always safe
549 if (Succ->getSinglePredecessor()) return true;
550
551 // Make a list of the predecessors of BB
Benjamin Kramerb5188f12011-12-06 16:14:29 +0000552 SmallPtrSet<BasicBlock*, 16> BBPreds(pred_begin(BB), pred_end(BB));
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000553
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000554 // Look at all the phi nodes in Succ, to see if they present a conflict when
555 // merging these blocks
556 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
557 PHINode *PN = cast<PHINode>(I);
558
559 // If the incoming value from BB is again a PHINode in
560 // BB which has the same incoming value for *PI as PN does, we can
561 // merge the phi nodes and then the blocks can still be merged
562 PHINode *BBPN = dyn_cast<PHINode>(PN->getIncomingValueForBlock(BB));
563 if (BBPN && BBPN->getParent() == BB) {
Benjamin Kramerb5188f12011-12-06 16:14:29 +0000564 for (unsigned PI = 0, PE = PN->getNumIncomingValues(); PI != PE; ++PI) {
565 BasicBlock *IBB = PN->getIncomingBlock(PI);
566 if (BBPreds.count(IBB) &&
Duncan Sandse773c082013-07-11 08:28:20 +0000567 !CanMergeValues(BBPN->getIncomingValueForBlock(IBB),
568 PN->getIncomingValue(PI))) {
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000569 DEBUG(dbgs() << "Can't fold, phi node " << PN->getName() << " in "
570 << Succ->getName() << " is conflicting with "
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000571 << BBPN->getName() << " with regard to common predecessor "
Benjamin Kramerb5188f12011-12-06 16:14:29 +0000572 << IBB->getName() << "\n");
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000573 return false;
574 }
575 }
576 } else {
577 Value* Val = PN->getIncomingValueForBlock(BB);
Benjamin Kramerb5188f12011-12-06 16:14:29 +0000578 for (unsigned PI = 0, PE = PN->getNumIncomingValues(); PI != PE; ++PI) {
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000579 // See if the incoming value for the common predecessor is equal to the
580 // one for BB, in which case this phi node will not prevent the merging
581 // of the block.
Benjamin Kramerb5188f12011-12-06 16:14:29 +0000582 BasicBlock *IBB = PN->getIncomingBlock(PI);
Duncan Sandse773c082013-07-11 08:28:20 +0000583 if (BBPreds.count(IBB) &&
584 !CanMergeValues(Val, PN->getIncomingValue(PI))) {
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000585 DEBUG(dbgs() << "Can't fold, phi node " << PN->getName() << " in "
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000586 << Succ->getName() << " is conflicting with regard to common "
Benjamin Kramerb5188f12011-12-06 16:14:29 +0000587 << "predecessor " << IBB->getName() << "\n");
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000588 return false;
589 }
590 }
591 }
592 }
593
594 return true;
595}
596
Duncan Sandse773c082013-07-11 08:28:20 +0000597typedef SmallVector<BasicBlock *, 16> PredBlockVector;
598typedef DenseMap<BasicBlock *, Value *> IncomingValueMap;
599
600/// \brief Determines the value to use as the phi node input for a block.
601///
602/// Select between \p OldVal any value that we know flows from \p BB
603/// to a particular phi on the basis of which one (if either) is not
604/// undef. Update IncomingValues based on the selected value.
605///
606/// \param OldVal The value we are considering selecting.
607/// \param BB The block that the value flows in from.
608/// \param IncomingValues A map from block-to-value for other phi inputs
609/// that we have examined.
610///
611/// \returns the selected value.
612static Value *selectIncomingValueForBlock(Value *OldVal, BasicBlock *BB,
613 IncomingValueMap &IncomingValues) {
614 if (!isa<UndefValue>(OldVal)) {
615 assert((!IncomingValues.count(BB) ||
616 IncomingValues.find(BB)->second == OldVal) &&
617 "Expected OldVal to match incoming value from BB!");
618
619 IncomingValues.insert(std::make_pair(BB, OldVal));
620 return OldVal;
621 }
622
623 IncomingValueMap::const_iterator It = IncomingValues.find(BB);
624 if (It != IncomingValues.end()) return It->second;
625
626 return OldVal;
627}
628
629/// \brief Create a map from block to value for the operands of a
630/// given phi.
631///
632/// Create a map from block to value for each non-undef value flowing
633/// into \p PN.
634///
635/// \param PN The phi we are collecting the map for.
636/// \param IncomingValues [out] The map from block to value for this phi.
637static void gatherIncomingValuesToPhi(PHINode *PN,
638 IncomingValueMap &IncomingValues) {
639 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
640 BasicBlock *BB = PN->getIncomingBlock(i);
641 Value *V = PN->getIncomingValue(i);
642
643 if (!isa<UndefValue>(V))
644 IncomingValues.insert(std::make_pair(BB, V));
645 }
646}
647
648/// \brief Replace the incoming undef values to a phi with the values
649/// from a block-to-value map.
650///
651/// \param PN The phi we are replacing the undefs in.
652/// \param IncomingValues A map from block to value.
653static void replaceUndefValuesInPhi(PHINode *PN,
654 const IncomingValueMap &IncomingValues) {
655 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
656 Value *V = PN->getIncomingValue(i);
657
658 if (!isa<UndefValue>(V)) continue;
659
660 BasicBlock *BB = PN->getIncomingBlock(i);
661 IncomingValueMap::const_iterator It = IncomingValues.find(BB);
662 if (It == IncomingValues.end()) continue;
663
664 PN->setIncomingValue(i, It->second);
665 }
666}
667
668/// \brief Replace a value flowing from a block to a phi with
669/// potentially multiple instances of that value flowing from the
670/// block's predecessors to the phi.
671///
672/// \param BB The block with the value flowing into the phi.
673/// \param BBPreds The predecessors of BB.
674/// \param PN The phi that we are updating.
675static void redirectValuesFromPredecessorsToPhi(BasicBlock *BB,
676 const PredBlockVector &BBPreds,
677 PHINode *PN) {
678 Value *OldVal = PN->removeIncomingValue(BB, false);
679 assert(OldVal && "No entry in PHI for Pred BB!");
680
681 IncomingValueMap IncomingValues;
682
683 // We are merging two blocks - BB, and the block containing PN - and
684 // as a result we need to redirect edges from the predecessors of BB
685 // to go to the block containing PN, and update PN
686 // accordingly. Since we allow merging blocks in the case where the
687 // predecessor and successor blocks both share some predecessors,
688 // and where some of those common predecessors might have undef
689 // values flowing into PN, we want to rewrite those values to be
690 // consistent with the non-undef values.
691
692 gatherIncomingValuesToPhi(PN, IncomingValues);
693
694 // If this incoming value is one of the PHI nodes in BB, the new entries
695 // in the PHI node are the entries from the old PHI.
696 if (isa<PHINode>(OldVal) && cast<PHINode>(OldVal)->getParent() == BB) {
697 PHINode *OldValPN = cast<PHINode>(OldVal);
698 for (unsigned i = 0, e = OldValPN->getNumIncomingValues(); i != e; ++i) {
699 // Note that, since we are merging phi nodes and BB and Succ might
700 // have common predecessors, we could end up with a phi node with
701 // identical incoming branches. This will be cleaned up later (and
702 // will trigger asserts if we try to clean it up now, without also
703 // simplifying the corresponding conditional branch).
704 BasicBlock *PredBB = OldValPN->getIncomingBlock(i);
705 Value *PredVal = OldValPN->getIncomingValue(i);
706 Value *Selected = selectIncomingValueForBlock(PredVal, PredBB,
707 IncomingValues);
708
709 // And add a new incoming value for this predecessor for the
710 // newly retargeted branch.
711 PN->addIncoming(Selected, PredBB);
712 }
713 } else {
714 for (unsigned i = 0, e = BBPreds.size(); i != e; ++i) {
715 // Update existing incoming values in PN for this
716 // predecessor of BB.
717 BasicBlock *PredBB = BBPreds[i];
718 Value *Selected = selectIncomingValueForBlock(OldVal, PredBB,
719 IncomingValues);
720
721 // And add a new incoming value for this predecessor for the
722 // newly retargeted branch.
723 PN->addIncoming(Selected, PredBB);
724 }
725 }
726
727 replaceUndefValuesInPhi(PN, IncomingValues);
728}
729
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000730/// TryToSimplifyUncondBranchFromEmptyBlock - BB is known to contain an
731/// unconditional branch, and contains no instructions other than PHI nodes,
Rafael Espindolab10a0f22011-06-30 20:14:24 +0000732/// potential side-effect free intrinsics and the branch. If possible,
733/// eliminate BB by rewriting all the predecessors to branch to the successor
734/// block and return true. If we can't transform, return false.
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000735bool llvm::TryToSimplifyUncondBranchFromEmptyBlock(BasicBlock *BB) {
Dan Gohman4a63fad2010-08-14 00:29:42 +0000736 assert(BB != &BB->getParent()->getEntryBlock() &&
737 "TryToSimplifyUncondBranchFromEmptyBlock called on entry block!");
738
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000739 // We can't eliminate infinite loops.
740 BasicBlock *Succ = cast<BranchInst>(BB->getTerminator())->getSuccessor(0);
741 if (BB == Succ) return false;
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000742
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000743 // Check to see if merging these blocks would cause conflicts for any of the
744 // phi nodes in BB or Succ. If not, we can safely merge.
745 if (!CanPropagatePredecessorsForPHIs(BB, Succ)) return false;
746
747 // Check for cases where Succ has multiple predecessors and a PHI node in BB
748 // has uses which will not disappear when the PHI nodes are merged. It is
749 // possible to handle such cases, but difficult: it requires checking whether
750 // BB dominates Succ, which is non-trivial to calculate in the case where
751 // Succ has multiple predecessors. Also, it requires checking whether
Alexey Samsonov098842b2012-12-24 08:52:53 +0000752 // constructing the necessary self-referential PHI node doesn't introduce any
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000753 // conflicts; this isn't too difficult, but the previous code for doing this
754 // was incorrect.
755 //
756 // Note that if this check finds a live use, BB dominates Succ, so BB is
757 // something like a loop pre-header (or rarely, a part of an irreducible CFG);
758 // folding the branch isn't profitable in that case anyway.
759 if (!Succ->getSinglePredecessor()) {
760 BasicBlock::iterator BBI = BB->begin();
761 while (isa<PHINode>(*BBI)) {
Chandler Carruthcdf47882014-03-09 03:16:01 +0000762 for (Use &U : BBI->uses()) {
763 if (PHINode* PN = dyn_cast<PHINode>(U.getUser())) {
764 if (PN->getIncomingBlock(U) != BB)
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000765 return false;
766 } else {
767 return false;
768 }
769 }
770 ++BBI;
771 }
772 }
773
David Greene084b0dd2010-01-05 01:26:57 +0000774 DEBUG(dbgs() << "Killing Trivial BB: \n" << *BB);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000775
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000776 if (isa<PHINode>(Succ->begin())) {
777 // If there is more than one pred of succ, and there are PHI nodes in
778 // the successor, then we need to add incoming edges for the PHI nodes
779 //
Duncan Sandse773c082013-07-11 08:28:20 +0000780 const PredBlockVector BBPreds(pred_begin(BB), pred_end(BB));
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000781
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000782 // Loop over all of the PHI nodes in the successor of BB.
783 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
784 PHINode *PN = cast<PHINode>(I);
Duncan Sandse773c082013-07-11 08:28:20 +0000785
786 redirectValuesFromPredecessorsToPhi(BB, BBPreds, PN);
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000787 }
788 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000789
Rafael Espindolab10a0f22011-06-30 20:14:24 +0000790 if (Succ->getSinglePredecessor()) {
791 // BB is the only predecessor of Succ, so Succ will end up with exactly
792 // the same predecessors BB had.
793
794 // Copy over any phi, debug or lifetime instruction.
795 BB->getTerminator()->eraseFromParent();
796 Succ->getInstList().splice(Succ->getFirstNonPHI(), BB->getInstList());
797 } else {
798 while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) {
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000799 // We explicitly check for such uses in CanPropagatePredecessorsForPHIs.
800 assert(PN->use_empty() && "There shouldn't be any uses here!");
801 PN->eraseFromParent();
802 }
803 }
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000804
Chris Lattnercbd18fc2009-11-10 05:59:26 +0000805 // Everything that jumped to BB now goes to Succ.
806 BB->replaceAllUsesWith(Succ);
807 if (!Succ->hasName()) Succ->takeName(BB);
808 BB->eraseFromParent(); // Delete the old basic block.
809 return true;
810}
811
Jim Grosbachd831ef42009-12-02 17:06:45 +0000812/// EliminateDuplicatePHINodes - Check for and eliminate duplicate PHI
813/// nodes in this block. This doesn't try to be clever about PHI nodes
814/// which differ only in the order of the incoming values, but instcombine
815/// orders them so it usually won't matter.
816///
817bool llvm::EliminateDuplicatePHINodes(BasicBlock *BB) {
818 bool Changed = false;
819
820 // This implementation doesn't currently consider undef operands
Nick Lewyckyfa44dc62011-06-28 03:57:31 +0000821 // specially. Theoretically, two phis which are identical except for
Jim Grosbachd831ef42009-12-02 17:06:45 +0000822 // one having an undef where the other doesn't could be collapsed.
823
824 // Map from PHI hash values to PHI nodes. If multiple PHIs have
825 // the same hash value, the element is the first PHI in the
826 // linked list in CollisionMap.
827 DenseMap<uintptr_t, PHINode *> HashMap;
828
829 // Maintain linked lists of PHI nodes with common hash values.
830 DenseMap<PHINode *, PHINode *> CollisionMap;
831
832 // Examine each PHI.
833 for (BasicBlock::iterator I = BB->begin();
834 PHINode *PN = dyn_cast<PHINode>(I++); ) {
835 // Compute a hash value on the operands. Instcombine will likely have sorted
836 // them, which helps expose duplicates, but we have to check all the
837 // operands to be safe in case instcombine hasn't run.
838 uintptr_t Hash = 0;
Jay Foad61ea0e42011-06-23 09:09:15 +0000839 // This hash algorithm is quite weak as hash functions go, but it seems
840 // to do a good enough job for this particular purpose, and is very quick.
Jim Grosbachd831ef42009-12-02 17:06:45 +0000841 for (User::op_iterator I = PN->op_begin(), E = PN->op_end(); I != E; ++I) {
Jim Grosbachd831ef42009-12-02 17:06:45 +0000842 Hash ^= reinterpret_cast<uintptr_t>(static_cast<Value *>(*I));
843 Hash = (Hash << 7) | (Hash >> (sizeof(uintptr_t) * CHAR_BIT - 7));
844 }
Jay Foad61ea0e42011-06-23 09:09:15 +0000845 for (PHINode::block_iterator I = PN->block_begin(), E = PN->block_end();
846 I != E; ++I) {
847 Hash ^= reinterpret_cast<uintptr_t>(static_cast<BasicBlock *>(*I));
848 Hash = (Hash << 7) | (Hash >> (sizeof(uintptr_t) * CHAR_BIT - 7));
849 }
Jakob Stoklund Olesene2017b62011-03-04 02:48:56 +0000850 // Avoid colliding with the DenseMap sentinels ~0 and ~0-1.
851 Hash >>= 1;
Jim Grosbachd831ef42009-12-02 17:06:45 +0000852 // If we've never seen this hash value before, it's a unique PHI.
853 std::pair<DenseMap<uintptr_t, PHINode *>::iterator, bool> Pair =
854 HashMap.insert(std::make_pair(Hash, PN));
855 if (Pair.second) continue;
856 // Otherwise it's either a duplicate or a hash collision.
857 for (PHINode *OtherPN = Pair.first->second; ; ) {
858 if (OtherPN->isIdenticalTo(PN)) {
859 // A duplicate. Replace this PHI with its duplicate.
860 PN->replaceAllUsesWith(OtherPN);
861 PN->eraseFromParent();
862 Changed = true;
863 break;
864 }
865 // A non-duplicate hash collision.
866 DenseMap<PHINode *, PHINode *>::iterator I = CollisionMap.find(OtherPN);
867 if (I == CollisionMap.end()) {
868 // Set this PHI to be the head of the linked list of colliding PHIs.
869 PHINode *Old = Pair.first->second;
870 Pair.first->second = PN;
871 CollisionMap[PN] = Old;
872 break;
873 }
Benjamin Kramerbde91762012-06-02 10:20:22 +0000874 // Proceed to the next PHI in the list.
Jim Grosbachd831ef42009-12-02 17:06:45 +0000875 OtherPN = I->second;
876 }
877 }
878
879 return Changed;
880}
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000881
882/// enforceKnownAlignment - If the specified pointer points to an object that
883/// we control, modify the object's alignment to PrefAlign. This isn't
884/// often possible though. If alignment is important, a more reliable approach
885/// is to simply align all global variables and allocation instructions to
886/// their preferred alignment from the beginning.
887///
Benjamin Kramer570dd782010-12-30 22:34:44 +0000888static unsigned enforceKnownAlignment(Value *V, unsigned Align,
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000889 unsigned PrefAlign, const DataLayout *TD) {
Eli Friedman19ace4c2011-06-15 21:08:25 +0000890 V = V->stripPointerCasts();
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000891
Eli Friedman19ace4c2011-06-15 21:08:25 +0000892 if (AllocaInst *AI = dyn_cast<AllocaInst>(V)) {
Lang Hamesde7ab802011-10-10 23:42:08 +0000893 // If the preferred alignment is greater than the natural stack alignment
894 // then don't round up. This avoids dynamic stack realignment.
895 if (TD && TD->exceedsNaturalStackAlignment(PrefAlign))
896 return Align;
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000897 // If there is a requested alignment and if this is an alloca, round up.
898 if (AI->getAlignment() >= PrefAlign)
899 return AI->getAlignment();
900 AI->setAlignment(PrefAlign);
901 return PrefAlign;
902 }
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000903
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000904 if (auto *GO = dyn_cast<GlobalObject>(V)) {
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000905 // If there is a large requested alignment and we can, bump up the alignment
906 // of the global.
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000907 if (GO->isDeclaration())
Rafael Espindolafc13db42014-05-09 16:01:06 +0000908 return Align;
Duncan Sandsca6f8dd2011-11-29 18:26:38 +0000909 // If the memory we set aside for the global may not be the memory used by
910 // the final program then it is impossible for us to reliably enforce the
911 // preferred alignment.
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000912 if (GO->isWeakForLinker())
Rafael Espindolafc13db42014-05-09 16:01:06 +0000913 return Align;
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000914
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000915 if (GO->getAlignment() >= PrefAlign)
916 return GO->getAlignment();
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000917 // We can only increase the alignment of the global if it has no alignment
918 // specified or if it is not assigned a section. If it is assigned a
919 // section, the global could be densely packed with other objects in the
920 // section, increasing the alignment could cause padding issues.
Rafael Espindola99e05cf2014-05-13 18:45:48 +0000921 if (!GO->hasSection() || GO->getAlignment() == 0)
922 GO->setAlignment(PrefAlign);
923 return GO->getAlignment();
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000924 }
925
926 return Align;
927}
928
929/// getOrEnforceKnownAlignment - If the specified pointer has an alignment that
930/// we can determine, return it, otherwise return 0. If PrefAlign is specified,
931/// and it is more than the alignment of the ultimate object, see if we can
932/// increase the alignment of the ultimate object, making this check succeed.
933unsigned llvm::getOrEnforceKnownAlignment(Value *V, unsigned PrefAlign,
Matt Arsenault87dc6072013-08-01 22:42:18 +0000934 const DataLayout *DL) {
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000935 assert(V->getType()->isPointerTy() &&
936 "getOrEnforceKnownAlignment expects a pointer!");
Matt Arsenault87dc6072013-08-01 22:42:18 +0000937 unsigned BitWidth = DL ? DL->getPointerTypeSizeInBits(V->getType()) : 64;
938
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000939 APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
Jay Foada0653a32014-05-14 21:14:37 +0000940 computeKnownBits(V, KnownZero, KnownOne, DL);
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000941 unsigned TrailZ = KnownZero.countTrailingOnes();
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000942
Matt Arsenaultf64212b2013-07-23 22:20:57 +0000943 // Avoid trouble with ridiculously large TrailZ values, such as
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000944 // those computed from a null pointer.
945 TrailZ = std::min(TrailZ, unsigned(sizeof(unsigned) * CHAR_BIT - 1));
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000946
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000947 unsigned Align = 1u << std::min(BitWidth - 1, TrailZ);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000948
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000949 // LLVM doesn't support alignments larger than this currently.
950 Align = std::min(Align, +Value::MaximumAlignment);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000951
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000952 if (PrefAlign > Align)
Matt Arsenault87dc6072013-08-01 22:42:18 +0000953 Align = enforceKnownAlignment(V, Align, PrefAlign, DL);
Jakub Staszak8e1a6e72013-07-22 23:16:36 +0000954
Chris Lattner6fcd32e2010-12-25 20:37:57 +0000955 // We don't need to make any adjustment.
956 return Align;
957}
958
Devang Patel8c0b16b2011-03-17 21:58:19 +0000959///===---------------------------------------------------------------------===//
960/// Dbg Intrinsic utilities
961///
962
Adrian Prantl29b9de72013-04-26 17:48:33 +0000963/// See if there is a dbg.value intrinsic for DIVar before I.
964static bool LdStHasDebugValue(DIVariable &DIVar, Instruction *I) {
965 // Since we can't guarantee that the original dbg.declare instrinsic
966 // is removed by LowerDbgDeclare(), we need to make sure that we are
967 // not inserting the same dbg.value intrinsic over and over.
968 llvm::BasicBlock::InstListType::iterator PrevI(I);
969 if (PrevI != I->getParent()->getInstList().begin()) {
970 --PrevI;
971 if (DbgValueInst *DVI = dyn_cast<DbgValueInst>(PrevI))
972 if (DVI->getValue() == I->getOperand(0) &&
973 DVI->getOffset() == 0 &&
974 DVI->getVariable() == DIVar)
975 return true;
976 }
977 return false;
978}
979
Adrian Prantld00333a2013-04-26 18:10:50 +0000980/// Inserts a llvm.dbg.value intrinsic before a store to an alloca'd value
Devang Patel8c0b16b2011-03-17 21:58:19 +0000981/// that has an associated llvm.dbg.decl intrinsic.
982bool llvm::ConvertDebugDeclareToDebugValue(DbgDeclareInst *DDI,
983 StoreInst *SI, DIBuilder &Builder) {
984 DIVariable DIVar(DDI->getVariable());
Manman Ren983a16c2013-06-28 05:43:10 +0000985 assert((!DIVar || DIVar.isVariable()) &&
986 "Variable in DbgDeclareInst should be either null or a DIVariable.");
987 if (!DIVar)
Devang Patel8c0b16b2011-03-17 21:58:19 +0000988 return false;
989
Adrian Prantl29b9de72013-04-26 17:48:33 +0000990 if (LdStHasDebugValue(DIVar, SI))
991 return true;
992
Craig Topperf40110f2014-04-25 05:29:35 +0000993 Instruction *DbgVal = nullptr;
Devang Patel8e60ff12011-05-16 21:24:05 +0000994 // If an argument is zero extended then use argument directly. The ZExt
995 // may be zapped by an optimization pass in future.
Craig Topperf40110f2014-04-25 05:29:35 +0000996 Argument *ExtendedArg = nullptr;
Devang Patel8e60ff12011-05-16 21:24:05 +0000997 if (ZExtInst *ZExt = dyn_cast<ZExtInst>(SI->getOperand(0)))
998 ExtendedArg = dyn_cast<Argument>(ZExt->getOperand(0));
999 if (SExtInst *SExt = dyn_cast<SExtInst>(SI->getOperand(0)))
1000 ExtendedArg = dyn_cast<Argument>(SExt->getOperand(0));
1001 if (ExtendedArg)
1002 DbgVal = Builder.insertDbgValueIntrinsic(ExtendedArg, 0, DIVar, SI);
1003 else
1004 DbgVal = Builder.insertDbgValueIntrinsic(SI->getOperand(0), 0, DIVar, SI);
Adrian Prantl0840a222014-04-25 17:01:04 +00001005 DbgVal->setDebugLoc(DDI->getDebugLoc());
Devang Patel8c0b16b2011-03-17 21:58:19 +00001006 return true;
1007}
1008
Adrian Prantld00333a2013-04-26 18:10:50 +00001009/// Inserts a llvm.dbg.value intrinsic before a load of an alloca'd value
Devang Patel2c7ee272011-03-18 23:45:43 +00001010/// that has an associated llvm.dbg.decl intrinsic.
1011bool llvm::ConvertDebugDeclareToDebugValue(DbgDeclareInst *DDI,
1012 LoadInst *LI, DIBuilder &Builder) {
1013 DIVariable DIVar(DDI->getVariable());
Jakub Staszak8e1a6e72013-07-22 23:16:36 +00001014 assert((!DIVar || DIVar.isVariable()) &&
Manman Ren983a16c2013-06-28 05:43:10 +00001015 "Variable in DbgDeclareInst should be either null or a DIVariable.");
1016 if (!DIVar)
Devang Patel2c7ee272011-03-18 23:45:43 +00001017 return false;
1018
Adrian Prantl29b9de72013-04-26 17:48:33 +00001019 if (LdStHasDebugValue(DIVar, LI))
1020 return true;
1021
Jakub Staszak8e1a6e72013-07-22 23:16:36 +00001022 Instruction *DbgVal =
Devang Patel2c7ee272011-03-18 23:45:43 +00001023 Builder.insertDbgValueIntrinsic(LI->getOperand(0), 0,
1024 DIVar, LI);
Adrian Prantl0840a222014-04-25 17:01:04 +00001025 DbgVal->setDebugLoc(DDI->getDebugLoc());
Devang Patel2c7ee272011-03-18 23:45:43 +00001026 return true;
1027}
1028
Adrian Prantl232897f2014-04-25 23:00:25 +00001029/// Determine whether this alloca is either a VLA or an array.
1030static bool isArray(AllocaInst *AI) {
1031 return AI->isArrayAllocation() ||
1032 AI->getType()->getElementType()->isArrayTy();
1033}
1034
Devang Patelaad34d82011-03-17 22:18:16 +00001035/// LowerDbgDeclare - Lowers llvm.dbg.declare intrinsics into appropriate set
1036/// of llvm.dbg.value intrinsics.
1037bool llvm::LowerDbgDeclare(Function &F) {
1038 DIBuilder DIB(*F.getParent());
1039 SmallVector<DbgDeclareInst *, 4> Dbgs;
Adrian Prantl79c8e8f2014-03-27 23:30:04 +00001040 for (auto &FI : F)
1041 for (BasicBlock::iterator BI : FI)
1042 if (auto DDI = dyn_cast<DbgDeclareInst>(BI))
Devang Patelaad34d82011-03-17 22:18:16 +00001043 Dbgs.push_back(DDI);
Adrian Prantl79c8e8f2014-03-27 23:30:04 +00001044
Devang Patelaad34d82011-03-17 22:18:16 +00001045 if (Dbgs.empty())
1046 return false;
1047
Adrian Prantl79c8e8f2014-03-27 23:30:04 +00001048 for (auto &I : Dbgs) {
1049 DbgDeclareInst *DDI = I;
Adrian Prantl8e10fdb2013-11-18 23:04:38 +00001050 AllocaInst *AI = dyn_cast_or_null<AllocaInst>(DDI->getAddress());
1051 // If this is an alloca for a scalar variable, insert a dbg.value
1052 // at each load and store to the alloca and erase the dbg.declare.
Adrian Prantl32da8892014-04-25 20:49:25 +00001053 // The dbg.values allow tracking a variable even if it is not
1054 // stored on the stack, while the dbg.declare can only describe
1055 // the stack slot (and at a lexical-scope granularity). Later
1056 // passes will attempt to elide the stack slot.
Adrian Prantl232897f2014-04-25 23:00:25 +00001057 if (AI && !isArray(AI)) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001058 for (User *U : AI->users())
1059 if (StoreInst *SI = dyn_cast<StoreInst>(U))
Devang Patelaad34d82011-03-17 22:18:16 +00001060 ConvertDebugDeclareToDebugValue(DDI, SI, DIB);
Chandler Carruthcdf47882014-03-09 03:16:01 +00001061 else if (LoadInst *LI = dyn_cast<LoadInst>(U))
Devang Patel2c7ee272011-03-18 23:45:43 +00001062 ConvertDebugDeclareToDebugValue(DDI, LI, DIB);
Adrian Prantl32da8892014-04-25 20:49:25 +00001063 else if (CallInst *CI = dyn_cast<CallInst>(U)) {
1064 // This is a call by-value or some other instruction that
1065 // takes a pointer to the variable. Insert a *value*
1066 // intrinsic that describes the alloca.
1067 auto DbgVal =
1068 DIB.insertDbgValueIntrinsic(AI, 0,
1069 DIVariable(DDI->getVariable()), CI);
1070 DbgVal->setDebugLoc(DDI->getDebugLoc());
1071 }
1072 DDI->eraseFromParent();
Devang Patelaad34d82011-03-17 22:18:16 +00001073 }
Devang Patelaad34d82011-03-17 22:18:16 +00001074 }
1075 return true;
1076}
Cameron Zwarich843bc7d2011-05-24 03:10:43 +00001077
1078/// FindAllocaDbgDeclare - Finds the llvm.dbg.declare intrinsic describing the
1079/// alloca 'V', if any.
1080DbgDeclareInst *llvm::FindAllocaDbgDeclare(Value *V) {
1081 if (MDNode *DebugNode = MDNode::getIfExists(V->getContext(), V))
Chandler Carruthcdf47882014-03-09 03:16:01 +00001082 for (User *U : DebugNode->users())
1083 if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(U))
Cameron Zwarich843bc7d2011-05-24 03:10:43 +00001084 return DDI;
1085
Craig Topperf40110f2014-04-25 05:29:35 +00001086 return nullptr;
Cameron Zwarich843bc7d2011-05-24 03:10:43 +00001087}
Alexey Samsonov3d43b632012-12-12 14:31:53 +00001088
1089bool llvm::replaceDbgDeclareForAlloca(AllocaInst *AI, Value *NewAllocaAddress,
1090 DIBuilder &Builder) {
1091 DbgDeclareInst *DDI = FindAllocaDbgDeclare(AI);
1092 if (!DDI)
1093 return false;
1094 DIVariable DIVar(DDI->getVariable());
Jakub Staszak8e1a6e72013-07-22 23:16:36 +00001095 assert((!DIVar || DIVar.isVariable()) &&
Manman Ren983a16c2013-06-28 05:43:10 +00001096 "Variable in DbgDeclareInst should be either null or a DIVariable.");
1097 if (!DIVar)
Alexey Samsonov3d43b632012-12-12 14:31:53 +00001098 return false;
1099
1100 // Create a copy of the original DIDescriptor for user variable, appending
1101 // "deref" operation to a list of address elements, as new llvm.dbg.declare
1102 // will take a value storing address of the memory for variable, not
1103 // alloca itself.
1104 Type *Int64Ty = Type::getInt64Ty(AI->getContext());
1105 SmallVector<Value*, 4> NewDIVarAddress;
1106 if (DIVar.hasComplexAddress()) {
1107 for (unsigned i = 0, n = DIVar.getNumAddrElements(); i < n; ++i) {
1108 NewDIVarAddress.push_back(
1109 ConstantInt::get(Int64Ty, DIVar.getAddrElement(i)));
1110 }
1111 }
1112 NewDIVarAddress.push_back(ConstantInt::get(Int64Ty, DIBuilder::OpDeref));
1113 DIVariable NewDIVar = Builder.createComplexVariable(
1114 DIVar.getTag(), DIVar.getContext(), DIVar.getName(),
1115 DIVar.getFile(), DIVar.getLineNumber(), DIVar.getType(),
1116 NewDIVarAddress, DIVar.getArgNumber());
1117
1118 // Insert llvm.dbg.declare in the same basic block as the original alloca,
1119 // and remove old llvm.dbg.declare.
1120 BasicBlock *BB = AI->getParent();
1121 Builder.insertDeclare(NewAllocaAddress, NewDIVar, BB);
1122 DDI->eraseFromParent();
1123 return true;
1124}
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001125
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001126/// changeToUnreachable - Insert an unreachable instruction before the specified
1127/// instruction, making it and the rest of the code in the block dead.
1128static void changeToUnreachable(Instruction *I, bool UseLLVMTrap) {
1129 BasicBlock *BB = I->getParent();
1130 // Loop over all of the successors, removing BB's entry from any PHI
1131 // nodes.
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +00001132 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
1133 (*SI)->removePredecessor(BB);
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001134
1135 // Insert a call to llvm.trap right before this. This turns the undefined
1136 // behavior into a hard fail instead of falling through into random code.
1137 if (UseLLVMTrap) {
1138 Function *TrapFn =
1139 Intrinsic::getDeclaration(BB->getParent()->getParent(), Intrinsic::trap);
1140 CallInst *CallTrap = CallInst::Create(TrapFn, "", I);
1141 CallTrap->setDebugLoc(I->getDebugLoc());
1142 }
1143 new UnreachableInst(I->getContext(), I);
1144
1145 // All instructions after this are dead.
1146 BasicBlock::iterator BBI = I, BBE = BB->end();
1147 while (BBI != BBE) {
1148 if (!BBI->use_empty())
1149 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
1150 BB->getInstList().erase(BBI++);
1151 }
1152}
1153
1154/// changeToCall - Convert the specified invoke into a normal call.
1155static void changeToCall(InvokeInst *II) {
1156 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
1157 CallInst *NewCall = CallInst::Create(II->getCalledValue(), Args, "", II);
1158 NewCall->takeName(II);
1159 NewCall->setCallingConv(II->getCallingConv());
1160 NewCall->setAttributes(II->getAttributes());
1161 NewCall->setDebugLoc(II->getDebugLoc());
1162 II->replaceAllUsesWith(NewCall);
1163
1164 // Follow the call by a branch to the normal destination.
1165 BranchInst::Create(II->getNormalDest(), II);
1166
1167 // Update PHI nodes in the unwind destination
1168 II->getUnwindDest()->removePredecessor(II->getParent());
1169 II->eraseFromParent();
1170}
1171
1172static bool markAliveBlocks(BasicBlock *BB,
1173 SmallPtrSet<BasicBlock*, 128> &Reachable) {
1174
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001175 SmallVector<BasicBlock*, 128> Worklist;
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001176 Worklist.push_back(BB);
1177 Reachable.insert(BB);
1178 bool Changed = false;
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001179 do {
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001180 BB = Worklist.pop_back_val();
1181
1182 // Do a quick scan of the basic block, turning any obviously unreachable
1183 // instructions into LLVM unreachable insts. The instruction combining pass
1184 // canonicalizes unreachable insts into stores to null or undef.
1185 for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E;++BBI){
1186 if (CallInst *CI = dyn_cast<CallInst>(BBI)) {
1187 if (CI->doesNotReturn()) {
1188 // If we found a call to a no-return function, insert an unreachable
1189 // instruction after it. Make sure there isn't *already* one there
1190 // though.
1191 ++BBI;
1192 if (!isa<UnreachableInst>(BBI)) {
1193 // Don't insert a call to llvm.trap right before the unreachable.
1194 changeToUnreachable(BBI, false);
1195 Changed = true;
1196 }
1197 break;
1198 }
1199 }
1200
1201 // Store to undef and store to null are undefined and used to signal that
1202 // they should be changed to unreachable by passes that can't modify the
1203 // CFG.
1204 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
1205 // Don't touch volatile stores.
1206 if (SI->isVolatile()) continue;
1207
1208 Value *Ptr = SI->getOperand(1);
1209
1210 if (isa<UndefValue>(Ptr) ||
1211 (isa<ConstantPointerNull>(Ptr) &&
1212 SI->getPointerAddressSpace() == 0)) {
1213 changeToUnreachable(SI, true);
1214 Changed = true;
1215 break;
1216 }
1217 }
1218 }
1219
1220 // Turn invokes that call 'nounwind' functions into ordinary calls.
1221 if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
1222 Value *Callee = II->getCalledValue();
1223 if (isa<ConstantPointerNull>(Callee) || isa<UndefValue>(Callee)) {
1224 changeToUnreachable(II, true);
1225 Changed = true;
1226 } else if (II->doesNotThrow()) {
1227 if (II->use_empty() && II->onlyReadsMemory()) {
1228 // jump to the normal destination branch.
1229 BranchInst::Create(II->getNormalDest(), II);
1230 II->getUnwindDest()->removePredecessor(II->getParent());
1231 II->eraseFromParent();
1232 } else
1233 changeToCall(II);
1234 Changed = true;
1235 }
1236 }
1237
1238 Changed |= ConstantFoldTerminator(BB, true);
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +00001239 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
1240 if (Reachable.insert(*SI))
1241 Worklist.push_back(*SI);
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001242 } while (!Worklist.empty());
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001243 return Changed;
1244}
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001245
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001246/// removeUnreachableBlocksFromFn - Remove blocks that are not reachable, even
1247/// if they are in a dead cycle. Return true if a change was made, false
1248/// otherwise.
1249bool llvm::removeUnreachableBlocks(Function &F) {
1250 SmallPtrSet<BasicBlock*, 128> Reachable;
1251 bool Changed = markAliveBlocks(F.begin(), Reachable);
1252
1253 // If there are unreachable blocks in the CFG...
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001254 if (Reachable.size() == F.size())
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001255 return Changed;
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001256
1257 assert(Reachable.size() < F.size());
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001258 NumRemoved += F.size()-Reachable.size();
1259
1260 // Loop over all of the basic blocks that are not reachable, dropping all of
1261 // their internal references...
1262 for (Function::iterator BB = ++F.begin(), E = F.end(); BB != E; ++BB) {
1263 if (Reachable.count(BB))
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001264 continue;
1265
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +00001266 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
1267 if (Reachable.count(*SI))
1268 (*SI)->removePredecessor(BB);
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001269 BB->dropAllReferences();
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001270 }
Evgeniy Stepanov2a066af2013-03-22 08:43:04 +00001271
Peter Collingbourne8d642de2013-08-12 22:38:43 +00001272 for (Function::iterator I = ++F.begin(); I != F.end();)
Evgeniy Stepanov2a066af2013-03-22 08:43:04 +00001273 if (!Reachable.count(I))
1274 I = F.getBasicBlockList().erase(I);
1275 else
1276 ++I;
1277
Evgeniy Stepanov4fbc0d082012-12-21 11:18:49 +00001278 return true;
1279}