Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 1 | //===-- Local.cpp - Functions to perform local transformations ------------===// |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | b576c94 | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 4ee451d | 2007-12-29 20:36:04 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | b576c94 | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 9 | // |
| 10 | // This family of functions perform various local transformations to the |
| 11 | // program. |
| 12 | // |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
| 15 | #include "llvm/Transforms/Utils/Local.h" |
Chandler Carruth | d04a8d4 | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 16 | #include "llvm/ADT/DenseMap.h" |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 17 | #include "llvm/ADT/STLExtras.h" |
Chandler Carruth | 58a2cbe | 2013-01-02 10:22:59 +0000 | [diff] [blame] | 18 | #include "llvm/ADT/SmallPtrSet.h" |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 19 | #include "llvm/ADT/Statistic.h" |
Chandler Carruth | d04a8d4 | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 20 | #include "llvm/Analysis/InstructionSimplify.h" |
| 21 | #include "llvm/Analysis/MemoryBuiltins.h" |
Chandler Carruth | d04a8d4 | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 22 | #include "llvm/Analysis/ValueTracking.h" |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 23 | #include "llvm/IR/CFG.h" |
Chandler Carruth | 0b8c9a8 | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 24 | #include "llvm/IR/Constants.h" |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 25 | #include "llvm/IR/DIBuilder.h" |
Chandler Carruth | 0b8c9a8 | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 26 | #include "llvm/IR/DataLayout.h" |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 27 | #include "llvm/IR/DebugInfo.h" |
Chandler Carruth | 0b8c9a8 | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 28 | #include "llvm/IR/DerivedTypes.h" |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 29 | #include "llvm/IR/Dominators.h" |
| 30 | #include "llvm/IR/GetElementPtrTypeIterator.h" |
Chandler Carruth | 0b8c9a8 | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 31 | #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 Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 40 | #include "llvm/IR/ValueHandle.h" |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 41 | #include "llvm/Support/Debug.h" |
Chris Lattner | c5f52e6 | 2005-09-26 05:27:10 +0000 | [diff] [blame] | 42 | #include "llvm/Support/MathExtras.h" |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 43 | #include "llvm/Support/raw_ostream.h" |
Chris Lattner | abbc2dd | 2003-12-19 05:56:28 +0000 | [diff] [blame] | 44 | using namespace llvm; |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 45 | |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 46 | #define DEBUG_TYPE "local" |
| 47 | |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 48 | STATISTIC(NumRemoved, "Number of unreachable basic blocks removed"); |
| 49 | |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 50 | //===----------------------------------------------------------------------===// |
Chris Lattner | 3481f24 | 2008-11-27 22:57:53 +0000 | [diff] [blame] | 51 | // Local constant propagation. |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 52 | // |
| 53 | |
Frits van Bommel | 5649ba7 | 2011-05-22 16:24:18 +0000 | [diff] [blame] | 54 | /// 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 Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 61 | bool llvm::ConstantFoldTerminator(BasicBlock *BB, bool DeleteDeadConditions, |
| 62 | const TargetLibraryInfo *TLI) { |
Chris Lattner | 76ae344 | 2002-05-21 20:04:50 +0000 | [diff] [blame] | 63 | TerminatorInst *T = BB->getTerminator(); |
Devang Patel | 62fb355 | 2011-05-18 17:26:46 +0000 | [diff] [blame] | 64 | IRBuilder<> Builder(T); |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 65 | |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 66 | // 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 Greif | c1bb13f | 2009-01-30 18:21:13 +0000 | [diff] [blame] | 69 | BasicBlock *Dest1 = BI->getSuccessor(0); |
| 70 | BasicBlock *Dest2 = BI->getSuccessor(1); |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 71 | |
Zhou Sheng | 6b6b6ef | 2007-01-11 12:24:14 +0000 | [diff] [blame] | 72 | if (ConstantInt *Cond = dyn_cast<ConstantInt>(BI->getCondition())) { |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 73 | // Are we branching on constant? |
| 74 | // YES. Change to unconditional branch... |
Reid Spencer | 579dca1 | 2007-01-12 04:24:46 +0000 | [diff] [blame] | 75 | BasicBlock *Destination = Cond->getZExtValue() ? Dest1 : Dest2; |
| 76 | BasicBlock *OldDest = Cond->getZExtValue() ? Dest2 : Dest1; |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 77 | |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 78 | //cerr << "Function: " << T->getParent()->getParent() |
| 79 | // << "\nRemoving branch from " << T->getParent() |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 80 | // << "\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 Foad | 1a03902 | 2011-04-19 15:23:29 +0000 | [diff] [blame] | 84 | OldDest->removePredecessor(BB); |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 85 | |
Jay Foad | 8f9ffbd | 2011-01-07 20:25:56 +0000 | [diff] [blame] | 86 | // Replace the conditional branch with an unconditional one. |
Devang Patel | 62fb355 | 2011-05-18 17:26:46 +0000 | [diff] [blame] | 87 | Builder.CreateBr(Destination); |
Jay Foad | 8f9ffbd | 2011-01-07 20:25:56 +0000 | [diff] [blame] | 88 | BI->eraseFromParent(); |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 89 | return true; |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 90 | } |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 91 | |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 92 | if (Dest2 == Dest1) { // Conditional branch to same location? |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 93 | // This branch matches something like this: |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 94 | // 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 Foad | 8f9ffbd | 2011-01-07 20:25:56 +0000 | [diff] [blame] | 101 | // Replace the conditional branch with an unconditional one. |
Devang Patel | 62fb355 | 2011-05-18 17:26:46 +0000 | [diff] [blame] | 102 | Builder.CreateBr(Dest1); |
Frits van Bommel | 5649ba7 | 2011-05-22 16:24:18 +0000 | [diff] [blame] | 103 | Value *Cond = BI->getCondition(); |
Jay Foad | 8f9ffbd | 2011-01-07 20:25:56 +0000 | [diff] [blame] | 104 | BI->eraseFromParent(); |
Frits van Bommel | 5649ba7 | 2011-05-22 16:24:18 +0000 | [diff] [blame] | 105 | if (DeleteDeadConditions) |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 106 | RecursivelyDeleteTriviallyDeadInstructions(Cond, TLI); |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 107 | return true; |
| 108 | } |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 109 | return false; |
| 110 | } |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 111 | |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 112 | if (SwitchInst *SI = dyn_cast<SwitchInst>(T)) { |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 113 | // 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 Dyatkovskiy | c10fa6c | 2012-03-08 07:06:20 +0000 | [diff] [blame] | 116 | BasicBlock *TheOnlyDest = SI->getDefaultDest(); |
Chris Lattner | 7d6c24c | 2003-08-23 23:18:19 +0000 | [diff] [blame] | 117 | BasicBlock *DefaultDest = TheOnlyDest; |
Chris Lattner | 694e37f | 2003-08-17 19:41:53 +0000 | [diff] [blame] | 118 | |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 119 | // Figure out which case it goes to. |
Stepan Dyatkovskiy | 3d3abe0 | 2012-03-11 06:09:17 +0000 | [diff] [blame] | 120 | for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end(); |
Stepan Dyatkovskiy | c10fa6c | 2012-03-08 07:06:20 +0000 | [diff] [blame] | 121 | i != e; ++i) { |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 122 | // Found case matching a constant operand? |
Stepan Dyatkovskiy | c10fa6c | 2012-03-08 07:06:20 +0000 | [diff] [blame] | 123 | if (i.getCaseValue() == CI) { |
| 124 | TheOnlyDest = i.getCaseSuccessor(); |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 125 | break; |
| 126 | } |
Chris Lattner | 694e37f | 2003-08-17 19:41:53 +0000 | [diff] [blame] | 127 | |
Chris Lattner | 7d6c24c | 2003-08-23 23:18:19 +0000 | [diff] [blame] | 128 | // 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 Dyatkovskiy | c10fa6c | 2012-03-08 07:06:20 +0000 | [diff] [blame] | 130 | if (i.getCaseSuccessor() == DefaultDest) { |
Manman Ren | ee99c7f | 2012-09-12 17:04:11 +0000 | [diff] [blame] | 131 | MDNode* MD = SI->getMetadata(LLVMContext::MD_prof); |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 132 | 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 Ren | ee99c7f | 2012-09-12 17:04:11 +0000 | [diff] [blame] | 136 | // 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 Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 154 | // Remove this entry. |
Chris Lattner | 7d6c24c | 2003-08-23 23:18:19 +0000 | [diff] [blame] | 155 | DefaultDest->removePredecessor(SI->getParent()); |
| 156 | SI->removeCase(i); |
Stepan Dyatkovskiy | c10fa6c | 2012-03-08 07:06:20 +0000 | [diff] [blame] | 157 | --i; --e; |
Chris Lattner | 7d6c24c | 2003-08-23 23:18:19 +0000 | [diff] [blame] | 158 | continue; |
| 159 | } |
| 160 | |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 161 | // 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. |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 164 | if (i.getCaseSuccessor() != TheOnlyDest) TheOnlyDest = nullptr; |
Chris Lattner | 694e37f | 2003-08-17 19:41:53 +0000 | [diff] [blame] | 165 | } |
| 166 | |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 167 | 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 Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 176 | // Insert the new branch. |
Devang Patel | 62fb355 | 2011-05-18 17:26:46 +0000 | [diff] [blame] | 177 | Builder.CreateBr(TheOnlyDest); |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 178 | 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) |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 185 | TheOnlyDest = nullptr; // Don't modify the first branch to TheOnlyDest |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 186 | else |
| 187 | Succ->removePredecessor(BB); |
| 188 | } |
| 189 | |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 190 | // Delete the old switch. |
Frits van Bommel | 5649ba7 | 2011-05-22 16:24:18 +0000 | [diff] [blame] | 191 | Value *Cond = SI->getCondition(); |
| 192 | SI->eraseFromParent(); |
| 193 | if (DeleteDeadConditions) |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 194 | RecursivelyDeleteTriviallyDeadInstructions(Cond, TLI); |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 195 | return true; |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 196 | } |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 197 | |
Stepan Dyatkovskiy | 2447312 | 2012-02-01 07:49:51 +0000 | [diff] [blame] | 198 | if (SI->getNumCases() == 1) { |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 199 | // Otherwise, we can fold this switch into a conditional branch |
| 200 | // instruction if it has only one non-default destination. |
Stepan Dyatkovskiy | 3d3abe0 | 2012-03-11 06:09:17 +0000 | [diff] [blame] | 201 | SwitchInst::CaseIt FirstCase = SI->case_begin(); |
Bob Wilson | db3a9e6 | 2013-09-09 19:14:35 +0000 | [diff] [blame] | 202 | Value *Cond = Builder.CreateICmpEQ(SI->getCondition(), |
| 203 | FirstCase.getCaseValue(), "cond"); |
Devang Patel | 62fb355 | 2011-05-18 17:26:46 +0000 | [diff] [blame] | 204 | |
Bob Wilson | db3a9e6 | 2013-09-09 19:14:35 +0000 | [diff] [blame] | 205 | // 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 Dyatkovskiy | a2067fb | 2012-05-23 08:18:26 +0000 | [diff] [blame] | 219 | } |
Bob Wilson | db3a9e6 | 2013-09-09 19:14:35 +0000 | [diff] [blame] | 220 | |
| 221 | // Delete the old switch. |
| 222 | SI->eraseFromParent(); |
| 223 | return true; |
Chris Lattner | 10b1f5a | 2003-08-17 20:21:14 +0000 | [diff] [blame] | 224 | } |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 225 | return false; |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 226 | } |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 227 | |
| 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 Patel | 62fb355 | 2011-05-18 17:26:46 +0000 | [diff] [blame] | 234 | Builder.CreateBr(TheOnlyDest); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 235 | |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 236 | for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) { |
| 237 | if (IBI->getDestination(i) == TheOnlyDest) |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 238 | TheOnlyDest = nullptr; |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 239 | else |
| 240 | IBI->getDestination(i)->removePredecessor(IBI->getParent()); |
| 241 | } |
Frits van Bommel | 5649ba7 | 2011-05-22 16:24:18 +0000 | [diff] [blame] | 242 | Value *Address = IBI->getAddress(); |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 243 | IBI->eraseFromParent(); |
Frits van Bommel | 5649ba7 | 2011-05-22 16:24:18 +0000 | [diff] [blame] | 244 | if (DeleteDeadConditions) |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 245 | RecursivelyDeleteTriviallyDeadInstructions(Address, TLI); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 246 | |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 247 | // 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 Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 254 | |
Chris Lattner | 0a4c678 | 2009-11-01 03:40:38 +0000 | [diff] [blame] | 255 | return true; |
| 256 | } |
| 257 | } |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 258 | |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 259 | return false; |
| 260 | } |
| 261 | |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 262 | |
| 263 | //===----------------------------------------------------------------------===// |
Chris Lattner | 40d8c28 | 2009-11-10 22:26:15 +0000 | [diff] [blame] | 264 | // Local dead code elimination. |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 265 | // |
| 266 | |
Chris Lattner | 3481f24 | 2008-11-27 22:57:53 +0000 | [diff] [blame] | 267 | /// isInstructionTriviallyDead - Return true if the result produced by the |
| 268 | /// instruction is not used, and the instruction has no side effects. |
| 269 | /// |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 270 | bool llvm::isInstructionTriviallyDead(Instruction *I, |
| 271 | const TargetLibraryInfo *TLI) { |
Chris Lattner | ec710c5 | 2005-05-06 05:27:34 +0000 | [diff] [blame] | 272 | if (!I->use_empty() || isa<TerminatorInst>(I)) return false; |
Jeff Cohen | 00b16889 | 2005-07-27 06:12:32 +0000 | [diff] [blame] | 273 | |
Bill Wendling | 187b192 | 2011-08-15 20:10:51 +0000 | [diff] [blame] | 274 | // We don't want the landingpad instruction removed by anything this general. |
| 275 | if (isa<LandingPadInst>(I)) |
| 276 | return false; |
| 277 | |
Devang Patel | 9c5822a | 2011-03-18 23:28:02 +0000 | [diff] [blame] | 278 | // 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 Lewycky | 3e69c13 | 2011-08-02 21:19:27 +0000 | [diff] [blame] | 281 | if (DDI->getAddress()) |
Devang Patel | 9c5822a | 2011-03-18 23:28:02 +0000 | [diff] [blame] | 282 | return false; |
Devang Patel | b994621 | 2011-03-21 22:04:45 +0000 | [diff] [blame] | 283 | return true; |
Nick Lewycky | 3e69c13 | 2011-08-02 21:19:27 +0000 | [diff] [blame] | 284 | } |
Devang Patel | b994621 | 2011-03-21 22:04:45 +0000 | [diff] [blame] | 285 | if (DbgValueInst *DVI = dyn_cast<DbgValueInst>(I)) { |
Devang Patel | 9c5822a | 2011-03-18 23:28:02 +0000 | [diff] [blame] | 286 | if (DVI->getValue()) |
| 287 | return false; |
Devang Patel | b994621 | 2011-03-21 22:04:45 +0000 | [diff] [blame] | 288 | return true; |
Devang Patel | 9c5822a | 2011-03-18 23:28:02 +0000 | [diff] [blame] | 289 | } |
| 290 | |
Duncan Sands | 7af1c78 | 2009-05-06 06:49:50 +0000 | [diff] [blame] | 291 | if (!I->mayHaveSideEffects()) return true; |
| 292 | |
| 293 | // Special case intrinsics that "may have side effects" but can be deleted |
| 294 | // when dead. |
Nick Lewycky | 3e69c13 | 2011-08-02 21:19:27 +0000 | [diff] [blame] | 295 | if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) { |
Chris Lattner | 741c0ae | 2007-12-29 00:59:12 +0000 | [diff] [blame] | 296 | // Safe to delete llvm.stacksave if dead. |
| 297 | if (II->getIntrinsicID() == Intrinsic::stacksave) |
| 298 | return true; |
Nick Lewycky | 3e69c13 | 2011-08-02 21:19:27 +0000 | [diff] [blame] | 299 | |
| 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 Lewycky | 4a3935c | 2011-10-24 04:35:36 +0000 | [diff] [blame] | 305 | |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 306 | if (isAllocLikeFn(I, TLI)) return true; |
Nick Lewycky | 4a3935c | 2011-10-24 04:35:36 +0000 | [diff] [blame] | 307 | |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 308 | if (CallInst *CI = isFreeCall(I, TLI)) |
Nick Lewycky | 4a3935c | 2011-10-24 04:35:36 +0000 | [diff] [blame] | 309 | if (Constant *C = dyn_cast<Constant>(CI->getArgOperand(0))) |
| 310 | return C->isNullValue() || isa<UndefValue>(C); |
| 311 | |
Chris Lattner | ec710c5 | 2005-05-06 05:27:34 +0000 | [diff] [blame] | 312 | return false; |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 313 | } |
| 314 | |
Chris Lattner | 3481f24 | 2008-11-27 22:57:53 +0000 | [diff] [blame] | 315 | /// RecursivelyDeleteTriviallyDeadInstructions - If the specified value is a |
| 316 | /// trivially dead instruction, delete it. If that makes any of its operands |
Dan Gohman | 90fe0bd | 2010-01-05 15:45:31 +0000 | [diff] [blame] | 317 | /// trivially dead, delete them too, recursively. Return true if any |
| 318 | /// instructions were deleted. |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 319 | bool |
| 320 | llvm::RecursivelyDeleteTriviallyDeadInstructions(Value *V, |
| 321 | const TargetLibraryInfo *TLI) { |
Chris Lattner | 3481f24 | 2008-11-27 22:57:53 +0000 | [diff] [blame] | 322 | Instruction *I = dyn_cast<Instruction>(V); |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 323 | if (!I || !I->use_empty() || !isInstructionTriviallyDead(I, TLI)) |
Dan Gohman | 90fe0bd | 2010-01-05 15:45:31 +0000 | [diff] [blame] | 324 | return false; |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 325 | |
Chris Lattner | 7605730 | 2008-11-28 01:20:46 +0000 | [diff] [blame] | 326 | SmallVector<Instruction*, 16> DeadInsts; |
| 327 | DeadInsts.push_back(I); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 328 | |
Dan Gohman | 321a813 | 2010-01-05 16:27:25 +0000 | [diff] [blame] | 329 | do { |
Dan Gohman | e9d87f4 | 2009-05-06 17:22:41 +0000 | [diff] [blame] | 330 | I = DeadInsts.pop_back_val(); |
Chris Lattner | 2872177 | 2008-11-28 00:58:15 +0000 | [diff] [blame] | 331 | |
Chris Lattner | 7605730 | 2008-11-28 01:20:46 +0000 | [diff] [blame] | 332 | // 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); |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 336 | I->setOperand(i, nullptr); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 337 | |
Chris Lattner | 7605730 | 2008-11-28 01:20:46 +0000 | [diff] [blame] | 338 | if (!OpV->use_empty()) continue; |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 339 | |
Chris Lattner | 7605730 | 2008-11-28 01:20:46 +0000 | [diff] [blame] | 340 | // 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 Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 344 | if (isInstructionTriviallyDead(OpI, TLI)) |
Chris Lattner | 7605730 | 2008-11-28 01:20:46 +0000 | [diff] [blame] | 345 | DeadInsts.push_back(OpI); |
| 346 | } |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 347 | |
Chris Lattner | 7605730 | 2008-11-28 01:20:46 +0000 | [diff] [blame] | 348 | I->eraseFromParent(); |
Dan Gohman | 321a813 | 2010-01-05 16:27:25 +0000 | [diff] [blame] | 349 | } while (!DeadInsts.empty()); |
Dan Gohman | 90fe0bd | 2010-01-05 15:45:31 +0000 | [diff] [blame] | 350 | |
| 351 | return true; |
Chris Lattner | 4d1e46e | 2002-05-07 18:07:59 +0000 | [diff] [blame] | 352 | } |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 353 | |
Nick Lewycky | 1a4021a | 2011-02-20 08:38:20 +0000 | [diff] [blame] | 354 | /// 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 Sands | b4098ba | 2011-02-21 16:27:36 +0000 | [diff] [blame] | 356 | /// true when there are no uses or multiple uses that all refer to the same |
| 357 | /// value. |
Nick Lewycky | 1a4021a | 2011-02-20 08:38:20 +0000 | [diff] [blame] | 358 | static bool areAllUsesEqual(Instruction *I) { |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 359 | Value::user_iterator UI = I->user_begin(); |
| 360 | Value::user_iterator UE = I->user_end(); |
Nick Lewycky | 1a4021a | 2011-02-20 08:38:20 +0000 | [diff] [blame] | 361 | if (UI == UE) |
Duncan Sands | b4098ba | 2011-02-21 16:27:36 +0000 | [diff] [blame] | 362 | return true; |
Nick Lewycky | 1a4021a | 2011-02-20 08:38:20 +0000 | [diff] [blame] | 363 | |
| 364 | User *TheUse = *UI; |
| 365 | for (++UI; UI != UE; ++UI) { |
| 366 | if (*UI != TheUse) |
| 367 | return false; |
| 368 | } |
| 369 | return true; |
| 370 | } |
| 371 | |
Dan Gohman | afc36a9 | 2009-05-02 18:29:22 +0000 | [diff] [blame] | 372 | /// 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 Sands | 2cfbf01 | 2011-02-21 17:32:05 +0000 | [diff] [blame] | 376 | /// too, recursively. Return true if a change was made. |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 377 | bool llvm::RecursivelyDeleteDeadPHINode(PHINode *PN, |
| 378 | const TargetLibraryInfo *TLI) { |
Duncan Sands | b4098ba | 2011-02-21 16:27:36 +0000 | [diff] [blame] | 379 | SmallPtrSet<Instruction*, 4> Visited; |
| 380 | for (Instruction *I = PN; areAllUsesEqual(I) && !I->mayHaveSideEffects(); |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 381 | I = cast<Instruction>(*I->user_begin())) { |
Duncan Sands | b4098ba | 2011-02-21 16:27:36 +0000 | [diff] [blame] | 382 | if (I->use_empty()) |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 383 | return RecursivelyDeleteTriviallyDeadInstructions(I, TLI); |
Nick Lewycky | eff5e69 | 2011-02-20 18:05:56 +0000 | [diff] [blame] | 384 | |
Duncan Sands | b4098ba | 2011-02-21 16:27:36 +0000 | [diff] [blame] | 385 | // If we find an instruction more than once, we're on a cycle that |
Dan Gohman | afc36a9 | 2009-05-02 18:29:22 +0000 | [diff] [blame] | 386 | // won't prove fruitful. |
Duncan Sands | b4098ba | 2011-02-21 16:27:36 +0000 | [diff] [blame] | 387 | if (!Visited.insert(I)) { |
| 388 | // Break the cycle and delete the instruction and its operands. |
| 389 | I->replaceAllUsesWith(UndefValue::get(I->getType())); |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 390 | (void)RecursivelyDeleteTriviallyDeadInstructions(I, TLI); |
Duncan Sands | 2cfbf01 | 2011-02-21 17:32:05 +0000 | [diff] [blame] | 391 | return true; |
Duncan Sands | b4098ba | 2011-02-21 16:27:36 +0000 | [diff] [blame] | 392 | } |
| 393 | } |
| 394 | return false; |
Dan Gohman | afc36a9 | 2009-05-02 18:29:22 +0000 | [diff] [blame] | 395 | } |
Chris Lattner | 3481f24 | 2008-11-27 22:57:53 +0000 | [diff] [blame] | 396 | |
Chris Lattner | e234a30 | 2010-01-12 19:40:54 +0000 | [diff] [blame] | 397 | /// 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 Villmow | 3574eca | 2012-10-08 16:38:25 +0000 | [diff] [blame] | 402 | bool llvm::SimplifyInstructionsInBlock(BasicBlock *BB, const DataLayout *TD, |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 403 | const TargetLibraryInfo *TLI) { |
Chris Lattner | e234a30 | 2010-01-12 19:40:54 +0000 | [diff] [blame] | 404 | bool MadeChange = false; |
Chandler Carruth | acdae3e | 2012-03-25 03:29:25 +0000 | [diff] [blame] | 405 | |
| 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 Carruth | 858cd1c | 2012-03-24 23:03:27 +0000 | [diff] [blame] | 414 | for (BasicBlock::iterator BI = BB->begin(), E = --BB->end(); BI != E; ) { |
| 415 | assert(!BI->isTerminator()); |
Chris Lattner | e234a30 | 2010-01-12 19:40:54 +0000 | [diff] [blame] | 416 | Instruction *Inst = BI++; |
Chandler Carruth | 6b98054 | 2012-03-24 21:11:24 +0000 | [diff] [blame] | 417 | |
| 418 | WeakVH BIHandle(BI); |
Benjamin Kramer | d721520 | 2013-09-24 16:37:40 +0000 | [diff] [blame] | 419 | if (recursivelySimplifyInstruction(Inst, TD, TLI)) { |
Chris Lattner | e234a30 | 2010-01-12 19:40:54 +0000 | [diff] [blame] | 420 | MadeChange = true; |
Chris Lattner | 35a939b | 2010-07-15 06:06:04 +0000 | [diff] [blame] | 421 | if (BIHandle != BI) |
Chris Lattner | e234a30 | 2010-01-12 19:40:54 +0000 | [diff] [blame] | 422 | BI = BB->begin(); |
| 423 | continue; |
| 424 | } |
Eli Friedman | 71ad2c9 | 2011-04-02 22:45:17 +0000 | [diff] [blame] | 425 | |
Benjamin Kramer | 8e0d1c0 | 2012-08-29 15:32:21 +0000 | [diff] [blame] | 426 | MadeChange |= RecursivelyDeleteTriviallyDeadInstructions(Inst, TLI); |
Eli Friedman | 71ad2c9 | 2011-04-02 22:45:17 +0000 | [diff] [blame] | 427 | if (BIHandle != BI) |
| 428 | BI = BB->begin(); |
Chris Lattner | e234a30 | 2010-01-12 19:40:54 +0000 | [diff] [blame] | 429 | } |
| 430 | return MadeChange; |
| 431 | } |
| 432 | |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 433 | //===----------------------------------------------------------------------===// |
Chris Lattner | 40d8c28 | 2009-11-10 22:26:15 +0000 | [diff] [blame] | 434 | // Control Flow Graph Restructuring. |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 435 | // |
| 436 | |
Chris Lattner | 40d8c28 | 2009-11-10 22:26:15 +0000 | [diff] [blame] | 437 | |
| 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. |
| 449 | void llvm::RemovePredecessorAndSimplify(BasicBlock *BB, BasicBlock *Pred, |
Micah Villmow | 3574eca | 2012-10-08 16:38:25 +0000 | [diff] [blame] | 450 | DataLayout *TD) { |
Chris Lattner | 40d8c28 | 2009-11-10 22:26:15 +0000 | [diff] [blame] | 451 | // This only adjusts blocks with PHI nodes. |
| 452 | if (!isa<PHINode>(BB->begin())) |
| 453 | return; |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 454 | |
Chris Lattner | 40d8c28 | 2009-11-10 22:26:15 +0000 | [diff] [blame] | 455 | // 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 Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 459 | |
Chris Lattner | 40d8c28 | 2009-11-10 22:26:15 +0000 | [diff] [blame] | 460 | WeakVH PhiIt = &BB->front(); |
| 461 | while (PHINode *PN = dyn_cast<PHINode>(PhiIt)) { |
| 462 | PhiIt = &*++BasicBlock::iterator(cast<Instruction>(PhiIt)); |
Chris Lattner | 35a939b | 2010-07-15 06:06:04 +0000 | [diff] [blame] | 463 | Value *OldPhiIt = PhiIt; |
Chandler Carruth | 6b98054 | 2012-03-24 21:11:24 +0000 | [diff] [blame] | 464 | |
| 465 | if (!recursivelySimplifyInstruction(PN, TD)) |
| 466 | continue; |
| 467 | |
Chris Lattner | 40d8c28 | 2009-11-10 22:26:15 +0000 | [diff] [blame] | 468 | // 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 Lattner | 35a939b | 2010-07-15 06:06:04 +0000 | [diff] [blame] | 471 | if (PhiIt != OldPhiIt) PhiIt = &BB->front(); |
Chris Lattner | 40d8c28 | 2009-11-10 22:26:15 +0000 | [diff] [blame] | 472 | } |
| 473 | } |
| 474 | |
| 475 | |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 476 | /// 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 Neustifter | ad80981 | 2009-09-16 09:26:52 +0000 | [diff] [blame] | 481 | void llvm::MergeBasicBlockIntoOnlyPred(BasicBlock *DestBB, Pass *P) { |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 482 | // 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 Anderson | 9e9a0d5 | 2009-07-30 23:03:37 +0000 | [diff] [blame] | 486 | if (NewVal == PN) NewVal = UndefValue::get(PN->getType()); |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 487 | PN->replaceAllUsesWith(NewVal); |
| 488 | PN->eraseFromParent(); |
| 489 | } |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 490 | |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 491 | BasicBlock *PredBB = DestBB->getSinglePredecessor(); |
| 492 | assert(PredBB && "Block doesn't have a single predecessor!"); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 493 | |
Chris Lattner | 37914c8 | 2010-02-15 20:47:49 +0000 | [diff] [blame] | 494 | // 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 Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 504 | |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 505 | // Anything that branched to PredBB now branches to DestBB. |
| 506 | PredBB->replaceAllUsesWith(DestBB); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 507 | |
Jay Foad | 95c3e48 | 2011-06-23 09:09:15 +0000 | [diff] [blame] | 508 | // Splice all the instructions from PredBB to DestBB. |
| 509 | PredBB->getTerminator()->eraseFromParent(); |
Bill Wendling | 3e033f2 | 2013-10-21 04:09:17 +0000 | [diff] [blame] | 510 | DestBB->getInstList().splice(DestBB->begin(), PredBB->getInstList()); |
Jay Foad | 95c3e48 | 2011-06-23 09:09:15 +0000 | [diff] [blame] | 511 | |
Andreas Neustifter | ad80981 | 2009-09-16 09:26:52 +0000 | [diff] [blame] | 512 | if (P) { |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 513 | if (DominatorTreeWrapperPass *DTWP = |
| 514 | P->getAnalysisIfAvailable<DominatorTreeWrapperPass>()) { |
| 515 | DominatorTree &DT = DTWP->getDomTree(); |
| 516 | BasicBlock *PredBBIDom = DT.getNode(PredBB)->getIDom()->getBlock(); |
| 517 | DT.changeImmediateDominator(DestBB, PredBBIDom); |
| 518 | DT.eraseNode(PredBB); |
Cameron Zwarich | 80f6a50 | 2011-01-08 17:01:52 +0000 | [diff] [blame] | 519 | } |
Andreas Neustifter | ad80981 | 2009-09-16 09:26:52 +0000 | [diff] [blame] | 520 | } |
Chris Lattner | b29714a | 2008-11-27 07:43:12 +0000 | [diff] [blame] | 521 | // Nuke BB. |
| 522 | PredBB->eraseFromParent(); |
| 523 | } |
Devang Patel | 4afc90d | 2009-02-10 07:00:59 +0000 | [diff] [blame] | 524 | |
Duncan Sands | c48b55a | 2013-07-11 08:28:20 +0000 | [diff] [blame] | 525 | /// CanMergeValues - Return true if we can choose one of these values to use |
| 526 | /// in place of the other. Note that we will always choose the non-undef |
| 527 | /// value to keep. |
| 528 | static bool CanMergeValues(Value *First, Value *Second) { |
| 529 | return First == Second || isa<UndefValue>(First) || isa<UndefValue>(Second); |
| 530 | } |
| 531 | |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 532 | /// CanPropagatePredecessorsForPHIs - Return true if we can fold BB, an |
Mark Lacey | 1b6e10f | 2013-08-14 22:11:42 +0000 | [diff] [blame] | 533 | /// almost-empty BB ending in an unconditional branch to Succ, into Succ. |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 534 | /// |
| 535 | /// Assumption: Succ is the single successor for BB. |
| 536 | /// |
| 537 | static bool CanPropagatePredecessorsForPHIs(BasicBlock *BB, BasicBlock *Succ) { |
| 538 | assert(*succ_begin(BB) == Succ && "Succ is not successor of BB!"); |
| 539 | |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 540 | DEBUG(dbgs() << "Looking to fold " << BB->getName() << " into " |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 541 | << Succ->getName() << "\n"); |
| 542 | // Shortcut, if there is only a single predecessor it must be BB and merging |
| 543 | // is always safe |
| 544 | if (Succ->getSinglePredecessor()) return true; |
| 545 | |
| 546 | // Make a list of the predecessors of BB |
Benjamin Kramer | 88c0914 | 2011-12-06 16:14:29 +0000 | [diff] [blame] | 547 | SmallPtrSet<BasicBlock*, 16> BBPreds(pred_begin(BB), pred_end(BB)); |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 548 | |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 549 | // Look at all the phi nodes in Succ, to see if they present a conflict when |
| 550 | // merging these blocks |
| 551 | for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) { |
| 552 | PHINode *PN = cast<PHINode>(I); |
| 553 | |
| 554 | // If the incoming value from BB is again a PHINode in |
| 555 | // BB which has the same incoming value for *PI as PN does, we can |
| 556 | // merge the phi nodes and then the blocks can still be merged |
| 557 | PHINode *BBPN = dyn_cast<PHINode>(PN->getIncomingValueForBlock(BB)); |
| 558 | if (BBPN && BBPN->getParent() == BB) { |
Benjamin Kramer | 88c0914 | 2011-12-06 16:14:29 +0000 | [diff] [blame] | 559 | for (unsigned PI = 0, PE = PN->getNumIncomingValues(); PI != PE; ++PI) { |
| 560 | BasicBlock *IBB = PN->getIncomingBlock(PI); |
| 561 | if (BBPreds.count(IBB) && |
Duncan Sands | c48b55a | 2013-07-11 08:28:20 +0000 | [diff] [blame] | 562 | !CanMergeValues(BBPN->getIncomingValueForBlock(IBB), |
| 563 | PN->getIncomingValue(PI))) { |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 564 | DEBUG(dbgs() << "Can't fold, phi node " << PN->getName() << " in " |
| 565 | << Succ->getName() << " is conflicting with " |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 566 | << BBPN->getName() << " with regard to common predecessor " |
Benjamin Kramer | 88c0914 | 2011-12-06 16:14:29 +0000 | [diff] [blame] | 567 | << IBB->getName() << "\n"); |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 568 | return false; |
| 569 | } |
| 570 | } |
| 571 | } else { |
| 572 | Value* Val = PN->getIncomingValueForBlock(BB); |
Benjamin Kramer | 88c0914 | 2011-12-06 16:14:29 +0000 | [diff] [blame] | 573 | for (unsigned PI = 0, PE = PN->getNumIncomingValues(); PI != PE; ++PI) { |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 574 | // See if the incoming value for the common predecessor is equal to the |
| 575 | // one for BB, in which case this phi node will not prevent the merging |
| 576 | // of the block. |
Benjamin Kramer | 88c0914 | 2011-12-06 16:14:29 +0000 | [diff] [blame] | 577 | BasicBlock *IBB = PN->getIncomingBlock(PI); |
Duncan Sands | c48b55a | 2013-07-11 08:28:20 +0000 | [diff] [blame] | 578 | if (BBPreds.count(IBB) && |
| 579 | !CanMergeValues(Val, PN->getIncomingValue(PI))) { |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 580 | DEBUG(dbgs() << "Can't fold, phi node " << PN->getName() << " in " |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 581 | << Succ->getName() << " is conflicting with regard to common " |
Benjamin Kramer | 88c0914 | 2011-12-06 16:14:29 +0000 | [diff] [blame] | 582 | << "predecessor " << IBB->getName() << "\n"); |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 583 | return false; |
| 584 | } |
| 585 | } |
| 586 | } |
| 587 | } |
| 588 | |
| 589 | return true; |
| 590 | } |
| 591 | |
Duncan Sands | c48b55a | 2013-07-11 08:28:20 +0000 | [diff] [blame] | 592 | typedef SmallVector<BasicBlock *, 16> PredBlockVector; |
| 593 | typedef DenseMap<BasicBlock *, Value *> IncomingValueMap; |
| 594 | |
| 595 | /// \brief Determines the value to use as the phi node input for a block. |
| 596 | /// |
| 597 | /// Select between \p OldVal any value that we know flows from \p BB |
| 598 | /// to a particular phi on the basis of which one (if either) is not |
| 599 | /// undef. Update IncomingValues based on the selected value. |
| 600 | /// |
| 601 | /// \param OldVal The value we are considering selecting. |
| 602 | /// \param BB The block that the value flows in from. |
| 603 | /// \param IncomingValues A map from block-to-value for other phi inputs |
| 604 | /// that we have examined. |
| 605 | /// |
| 606 | /// \returns the selected value. |
| 607 | static Value *selectIncomingValueForBlock(Value *OldVal, BasicBlock *BB, |
| 608 | IncomingValueMap &IncomingValues) { |
| 609 | if (!isa<UndefValue>(OldVal)) { |
| 610 | assert((!IncomingValues.count(BB) || |
| 611 | IncomingValues.find(BB)->second == OldVal) && |
| 612 | "Expected OldVal to match incoming value from BB!"); |
| 613 | |
| 614 | IncomingValues.insert(std::make_pair(BB, OldVal)); |
| 615 | return OldVal; |
| 616 | } |
| 617 | |
| 618 | IncomingValueMap::const_iterator It = IncomingValues.find(BB); |
| 619 | if (It != IncomingValues.end()) return It->second; |
| 620 | |
| 621 | return OldVal; |
| 622 | } |
| 623 | |
| 624 | /// \brief Create a map from block to value for the operands of a |
| 625 | /// given phi. |
| 626 | /// |
| 627 | /// Create a map from block to value for each non-undef value flowing |
| 628 | /// into \p PN. |
| 629 | /// |
| 630 | /// \param PN The phi we are collecting the map for. |
| 631 | /// \param IncomingValues [out] The map from block to value for this phi. |
| 632 | static void gatherIncomingValuesToPhi(PHINode *PN, |
| 633 | IncomingValueMap &IncomingValues) { |
| 634 | for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { |
| 635 | BasicBlock *BB = PN->getIncomingBlock(i); |
| 636 | Value *V = PN->getIncomingValue(i); |
| 637 | |
| 638 | if (!isa<UndefValue>(V)) |
| 639 | IncomingValues.insert(std::make_pair(BB, V)); |
| 640 | } |
| 641 | } |
| 642 | |
| 643 | /// \brief Replace the incoming undef values to a phi with the values |
| 644 | /// from a block-to-value map. |
| 645 | /// |
| 646 | /// \param PN The phi we are replacing the undefs in. |
| 647 | /// \param IncomingValues A map from block to value. |
| 648 | static void replaceUndefValuesInPhi(PHINode *PN, |
| 649 | const IncomingValueMap &IncomingValues) { |
| 650 | for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { |
| 651 | Value *V = PN->getIncomingValue(i); |
| 652 | |
| 653 | if (!isa<UndefValue>(V)) continue; |
| 654 | |
| 655 | BasicBlock *BB = PN->getIncomingBlock(i); |
| 656 | IncomingValueMap::const_iterator It = IncomingValues.find(BB); |
| 657 | if (It == IncomingValues.end()) continue; |
| 658 | |
| 659 | PN->setIncomingValue(i, It->second); |
| 660 | } |
| 661 | } |
| 662 | |
| 663 | /// \brief Replace a value flowing from a block to a phi with |
| 664 | /// potentially multiple instances of that value flowing from the |
| 665 | /// block's predecessors to the phi. |
| 666 | /// |
| 667 | /// \param BB The block with the value flowing into the phi. |
| 668 | /// \param BBPreds The predecessors of BB. |
| 669 | /// \param PN The phi that we are updating. |
| 670 | static void redirectValuesFromPredecessorsToPhi(BasicBlock *BB, |
| 671 | const PredBlockVector &BBPreds, |
| 672 | PHINode *PN) { |
| 673 | Value *OldVal = PN->removeIncomingValue(BB, false); |
| 674 | assert(OldVal && "No entry in PHI for Pred BB!"); |
| 675 | |
| 676 | IncomingValueMap IncomingValues; |
| 677 | |
| 678 | // We are merging two blocks - BB, and the block containing PN - and |
| 679 | // as a result we need to redirect edges from the predecessors of BB |
| 680 | // to go to the block containing PN, and update PN |
| 681 | // accordingly. Since we allow merging blocks in the case where the |
| 682 | // predecessor and successor blocks both share some predecessors, |
| 683 | // and where some of those common predecessors might have undef |
| 684 | // values flowing into PN, we want to rewrite those values to be |
| 685 | // consistent with the non-undef values. |
| 686 | |
| 687 | gatherIncomingValuesToPhi(PN, IncomingValues); |
| 688 | |
| 689 | // If this incoming value is one of the PHI nodes in BB, the new entries |
| 690 | // in the PHI node are the entries from the old PHI. |
| 691 | if (isa<PHINode>(OldVal) && cast<PHINode>(OldVal)->getParent() == BB) { |
| 692 | PHINode *OldValPN = cast<PHINode>(OldVal); |
| 693 | for (unsigned i = 0, e = OldValPN->getNumIncomingValues(); i != e; ++i) { |
| 694 | // Note that, since we are merging phi nodes and BB and Succ might |
| 695 | // have common predecessors, we could end up with a phi node with |
| 696 | // identical incoming branches. This will be cleaned up later (and |
| 697 | // will trigger asserts if we try to clean it up now, without also |
| 698 | // simplifying the corresponding conditional branch). |
| 699 | BasicBlock *PredBB = OldValPN->getIncomingBlock(i); |
| 700 | Value *PredVal = OldValPN->getIncomingValue(i); |
| 701 | Value *Selected = selectIncomingValueForBlock(PredVal, PredBB, |
| 702 | IncomingValues); |
| 703 | |
| 704 | // And add a new incoming value for this predecessor for the |
| 705 | // newly retargeted branch. |
| 706 | PN->addIncoming(Selected, PredBB); |
| 707 | } |
| 708 | } else { |
| 709 | for (unsigned i = 0, e = BBPreds.size(); i != e; ++i) { |
| 710 | // Update existing incoming values in PN for this |
| 711 | // predecessor of BB. |
| 712 | BasicBlock *PredBB = BBPreds[i]; |
| 713 | Value *Selected = selectIncomingValueForBlock(OldVal, PredBB, |
| 714 | IncomingValues); |
| 715 | |
| 716 | // And add a new incoming value for this predecessor for the |
| 717 | // newly retargeted branch. |
| 718 | PN->addIncoming(Selected, PredBB); |
| 719 | } |
| 720 | } |
| 721 | |
| 722 | replaceUndefValuesInPhi(PN, IncomingValues); |
| 723 | } |
| 724 | |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 725 | /// TryToSimplifyUncondBranchFromEmptyBlock - BB is known to contain an |
| 726 | /// unconditional branch, and contains no instructions other than PHI nodes, |
Rafael Espindola | 77a2c37 | 2011-06-30 20:14:24 +0000 | [diff] [blame] | 727 | /// potential side-effect free intrinsics and the branch. If possible, |
| 728 | /// eliminate BB by rewriting all the predecessors to branch to the successor |
| 729 | /// block and return true. If we can't transform, return false. |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 730 | bool llvm::TryToSimplifyUncondBranchFromEmptyBlock(BasicBlock *BB) { |
Dan Gohman | e2c6d13 | 2010-08-14 00:29:42 +0000 | [diff] [blame] | 731 | assert(BB != &BB->getParent()->getEntryBlock() && |
| 732 | "TryToSimplifyUncondBranchFromEmptyBlock called on entry block!"); |
| 733 | |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 734 | // We can't eliminate infinite loops. |
| 735 | BasicBlock *Succ = cast<BranchInst>(BB->getTerminator())->getSuccessor(0); |
| 736 | if (BB == Succ) return false; |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 737 | |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 738 | // Check to see if merging these blocks would cause conflicts for any of the |
| 739 | // phi nodes in BB or Succ. If not, we can safely merge. |
| 740 | if (!CanPropagatePredecessorsForPHIs(BB, Succ)) return false; |
| 741 | |
| 742 | // Check for cases where Succ has multiple predecessors and a PHI node in BB |
| 743 | // has uses which will not disappear when the PHI nodes are merged. It is |
| 744 | // possible to handle such cases, but difficult: it requires checking whether |
| 745 | // BB dominates Succ, which is non-trivial to calculate in the case where |
| 746 | // Succ has multiple predecessors. Also, it requires checking whether |
Alexey Samsonov | 3a19999 | 2012-12-24 08:52:53 +0000 | [diff] [blame] | 747 | // constructing the necessary self-referential PHI node doesn't introduce any |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 748 | // conflicts; this isn't too difficult, but the previous code for doing this |
| 749 | // was incorrect. |
| 750 | // |
| 751 | // Note that if this check finds a live use, BB dominates Succ, so BB is |
| 752 | // something like a loop pre-header (or rarely, a part of an irreducible CFG); |
| 753 | // folding the branch isn't profitable in that case anyway. |
| 754 | if (!Succ->getSinglePredecessor()) { |
| 755 | BasicBlock::iterator BBI = BB->begin(); |
| 756 | while (isa<PHINode>(*BBI)) { |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 757 | for (Use &U : BBI->uses()) { |
| 758 | if (PHINode* PN = dyn_cast<PHINode>(U.getUser())) { |
| 759 | if (PN->getIncomingBlock(U) != BB) |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 760 | return false; |
| 761 | } else { |
| 762 | return false; |
| 763 | } |
| 764 | } |
| 765 | ++BBI; |
| 766 | } |
| 767 | } |
| 768 | |
David Greene | fae7706 | 2010-01-05 01:26:57 +0000 | [diff] [blame] | 769 | DEBUG(dbgs() << "Killing Trivial BB: \n" << *BB); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 770 | |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 771 | if (isa<PHINode>(Succ->begin())) { |
| 772 | // If there is more than one pred of succ, and there are PHI nodes in |
| 773 | // the successor, then we need to add incoming edges for the PHI nodes |
| 774 | // |
Duncan Sands | c48b55a | 2013-07-11 08:28:20 +0000 | [diff] [blame] | 775 | const PredBlockVector BBPreds(pred_begin(BB), pred_end(BB)); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 776 | |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 777 | // Loop over all of the PHI nodes in the successor of BB. |
| 778 | for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) { |
| 779 | PHINode *PN = cast<PHINode>(I); |
Duncan Sands | c48b55a | 2013-07-11 08:28:20 +0000 | [diff] [blame] | 780 | |
| 781 | redirectValuesFromPredecessorsToPhi(BB, BBPreds, PN); |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 782 | } |
| 783 | } |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 784 | |
Rafael Espindola | 77a2c37 | 2011-06-30 20:14:24 +0000 | [diff] [blame] | 785 | if (Succ->getSinglePredecessor()) { |
| 786 | // BB is the only predecessor of Succ, so Succ will end up with exactly |
| 787 | // the same predecessors BB had. |
| 788 | |
| 789 | // Copy over any phi, debug or lifetime instruction. |
| 790 | BB->getTerminator()->eraseFromParent(); |
| 791 | Succ->getInstList().splice(Succ->getFirstNonPHI(), BB->getInstList()); |
| 792 | } else { |
| 793 | while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) { |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 794 | // We explicitly check for such uses in CanPropagatePredecessorsForPHIs. |
| 795 | assert(PN->use_empty() && "There shouldn't be any uses here!"); |
| 796 | PN->eraseFromParent(); |
| 797 | } |
| 798 | } |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 799 | |
Chris Lattner | dce94d9 | 2009-11-10 05:59:26 +0000 | [diff] [blame] | 800 | // Everything that jumped to BB now goes to Succ. |
| 801 | BB->replaceAllUsesWith(Succ); |
| 802 | if (!Succ->hasName()) Succ->takeName(BB); |
| 803 | BB->eraseFromParent(); // Delete the old basic block. |
| 804 | return true; |
| 805 | } |
| 806 | |
Jim Grosbach | 43a8241 | 2009-12-02 17:06:45 +0000 | [diff] [blame] | 807 | /// EliminateDuplicatePHINodes - Check for and eliminate duplicate PHI |
| 808 | /// nodes in this block. This doesn't try to be clever about PHI nodes |
| 809 | /// which differ only in the order of the incoming values, but instcombine |
| 810 | /// orders them so it usually won't matter. |
| 811 | /// |
| 812 | bool llvm::EliminateDuplicatePHINodes(BasicBlock *BB) { |
| 813 | bool Changed = false; |
| 814 | |
| 815 | // This implementation doesn't currently consider undef operands |
Nick Lewycky | 89991d4 | 2011-06-28 03:57:31 +0000 | [diff] [blame] | 816 | // specially. Theoretically, two phis which are identical except for |
Jim Grosbach | 43a8241 | 2009-12-02 17:06:45 +0000 | [diff] [blame] | 817 | // one having an undef where the other doesn't could be collapsed. |
| 818 | |
| 819 | // Map from PHI hash values to PHI nodes. If multiple PHIs have |
| 820 | // the same hash value, the element is the first PHI in the |
| 821 | // linked list in CollisionMap. |
| 822 | DenseMap<uintptr_t, PHINode *> HashMap; |
| 823 | |
| 824 | // Maintain linked lists of PHI nodes with common hash values. |
| 825 | DenseMap<PHINode *, PHINode *> CollisionMap; |
| 826 | |
| 827 | // Examine each PHI. |
| 828 | for (BasicBlock::iterator I = BB->begin(); |
| 829 | PHINode *PN = dyn_cast<PHINode>(I++); ) { |
| 830 | // Compute a hash value on the operands. Instcombine will likely have sorted |
| 831 | // them, which helps expose duplicates, but we have to check all the |
| 832 | // operands to be safe in case instcombine hasn't run. |
| 833 | uintptr_t Hash = 0; |
Jay Foad | 95c3e48 | 2011-06-23 09:09:15 +0000 | [diff] [blame] | 834 | // This hash algorithm is quite weak as hash functions go, but it seems |
| 835 | // to do a good enough job for this particular purpose, and is very quick. |
Jim Grosbach | 43a8241 | 2009-12-02 17:06:45 +0000 | [diff] [blame] | 836 | for (User::op_iterator I = PN->op_begin(), E = PN->op_end(); I != E; ++I) { |
Jim Grosbach | 43a8241 | 2009-12-02 17:06:45 +0000 | [diff] [blame] | 837 | Hash ^= reinterpret_cast<uintptr_t>(static_cast<Value *>(*I)); |
| 838 | Hash = (Hash << 7) | (Hash >> (sizeof(uintptr_t) * CHAR_BIT - 7)); |
| 839 | } |
Jay Foad | 95c3e48 | 2011-06-23 09:09:15 +0000 | [diff] [blame] | 840 | for (PHINode::block_iterator I = PN->block_begin(), E = PN->block_end(); |
| 841 | I != E; ++I) { |
| 842 | Hash ^= reinterpret_cast<uintptr_t>(static_cast<BasicBlock *>(*I)); |
| 843 | Hash = (Hash << 7) | (Hash >> (sizeof(uintptr_t) * CHAR_BIT - 7)); |
| 844 | } |
Jakob Stoklund Olesen | 2bc2a08 | 2011-03-04 02:48:56 +0000 | [diff] [blame] | 845 | // Avoid colliding with the DenseMap sentinels ~0 and ~0-1. |
| 846 | Hash >>= 1; |
Jim Grosbach | 43a8241 | 2009-12-02 17:06:45 +0000 | [diff] [blame] | 847 | // If we've never seen this hash value before, it's a unique PHI. |
| 848 | std::pair<DenseMap<uintptr_t, PHINode *>::iterator, bool> Pair = |
| 849 | HashMap.insert(std::make_pair(Hash, PN)); |
| 850 | if (Pair.second) continue; |
| 851 | // Otherwise it's either a duplicate or a hash collision. |
| 852 | for (PHINode *OtherPN = Pair.first->second; ; ) { |
| 853 | if (OtherPN->isIdenticalTo(PN)) { |
| 854 | // A duplicate. Replace this PHI with its duplicate. |
| 855 | PN->replaceAllUsesWith(OtherPN); |
| 856 | PN->eraseFromParent(); |
| 857 | Changed = true; |
| 858 | break; |
| 859 | } |
| 860 | // A non-duplicate hash collision. |
| 861 | DenseMap<PHINode *, PHINode *>::iterator I = CollisionMap.find(OtherPN); |
| 862 | if (I == CollisionMap.end()) { |
| 863 | // Set this PHI to be the head of the linked list of colliding PHIs. |
| 864 | PHINode *Old = Pair.first->second; |
| 865 | Pair.first->second = PN; |
| 866 | CollisionMap[PN] = Old; |
| 867 | break; |
| 868 | } |
Benjamin Kramer | d9b0b02 | 2012-06-02 10:20:22 +0000 | [diff] [blame] | 869 | // Proceed to the next PHI in the list. |
Jim Grosbach | 43a8241 | 2009-12-02 17:06:45 +0000 | [diff] [blame] | 870 | OtherPN = I->second; |
| 871 | } |
| 872 | } |
| 873 | |
| 874 | return Changed; |
| 875 | } |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 876 | |
| 877 | /// enforceKnownAlignment - If the specified pointer points to an object that |
| 878 | /// we control, modify the object's alignment to PrefAlign. This isn't |
| 879 | /// often possible though. If alignment is important, a more reliable approach |
| 880 | /// is to simply align all global variables and allocation instructions to |
| 881 | /// their preferred alignment from the beginning. |
| 882 | /// |
Benjamin Kramer | 1928236 | 2010-12-30 22:34:44 +0000 | [diff] [blame] | 883 | static unsigned enforceKnownAlignment(Value *V, unsigned Align, |
Micah Villmow | 3574eca | 2012-10-08 16:38:25 +0000 | [diff] [blame] | 884 | unsigned PrefAlign, const DataLayout *TD) { |
Eli Friedman | b53c793 | 2011-06-15 21:08:25 +0000 | [diff] [blame] | 885 | V = V->stripPointerCasts(); |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 886 | |
Eli Friedman | b53c793 | 2011-06-15 21:08:25 +0000 | [diff] [blame] | 887 | if (AllocaInst *AI = dyn_cast<AllocaInst>(V)) { |
Lang Hames | bb5b3f3 | 2011-10-10 23:42:08 +0000 | [diff] [blame] | 888 | // If the preferred alignment is greater than the natural stack alignment |
| 889 | // then don't round up. This avoids dynamic stack realignment. |
| 890 | if (TD && TD->exceedsNaturalStackAlignment(PrefAlign)) |
| 891 | return Align; |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 892 | // If there is a requested alignment and if this is an alloca, round up. |
| 893 | if (AI->getAlignment() >= PrefAlign) |
| 894 | return AI->getAlignment(); |
| 895 | AI->setAlignment(PrefAlign); |
| 896 | return PrefAlign; |
| 897 | } |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 898 | |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 899 | if (auto *GO = dyn_cast<GlobalObject>(V)) { |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 900 | // If there is a large requested alignment and we can, bump up the alignment |
| 901 | // of the global. |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 902 | if (GO->isDeclaration()) |
| 903 | return Align; |
Duncan Sands | d3a38cc | 2011-11-29 18:26:38 +0000 | [diff] [blame] | 904 | // If the memory we set aside for the global may not be the memory used by |
| 905 | // the final program then it is impossible for us to reliably enforce the |
| 906 | // preferred alignment. |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 907 | if (GO->isWeakForLinker()) |
| 908 | return Align; |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 909 | |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 910 | if (GO->getAlignment() >= PrefAlign) |
| 911 | return GO->getAlignment(); |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 912 | // We can only increase the alignment of the global if it has no alignment |
| 913 | // specified or if it is not assigned a section. If it is assigned a |
| 914 | // section, the global could be densely packed with other objects in the |
| 915 | // section, increasing the alignment could cause padding issues. |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 916 | if (!GO->hasSection() || GO->getAlignment() == 0) |
| 917 | GO->setAlignment(PrefAlign); |
| 918 | return GO->getAlignment(); |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 919 | } |
| 920 | |
| 921 | return Align; |
| 922 | } |
| 923 | |
| 924 | /// getOrEnforceKnownAlignment - If the specified pointer has an alignment that |
| 925 | /// we can determine, return it, otherwise return 0. If PrefAlign is specified, |
| 926 | /// and it is more than the alignment of the ultimate object, see if we can |
| 927 | /// increase the alignment of the ultimate object, making this check succeed. |
| 928 | unsigned llvm::getOrEnforceKnownAlignment(Value *V, unsigned PrefAlign, |
Matt Arsenault | 186f8f9 | 2013-08-01 22:42:18 +0000 | [diff] [blame] | 929 | const DataLayout *DL) { |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 930 | assert(V->getType()->isPointerTy() && |
| 931 | "getOrEnforceKnownAlignment expects a pointer!"); |
Matt Arsenault | 186f8f9 | 2013-08-01 22:42:18 +0000 | [diff] [blame] | 932 | unsigned BitWidth = DL ? DL->getPointerTypeSizeInBits(V->getType()) : 64; |
| 933 | |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 934 | APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0); |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 935 | computeKnownBits(V, KnownZero, KnownOne, DL); |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 936 | unsigned TrailZ = KnownZero.countTrailingOnes(); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 937 | |
Matt Arsenault | 59a3878 | 2013-07-23 22:20:57 +0000 | [diff] [blame] | 938 | // Avoid trouble with ridiculously large TrailZ values, such as |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 939 | // those computed from a null pointer. |
| 940 | TrailZ = std::min(TrailZ, unsigned(sizeof(unsigned) * CHAR_BIT - 1)); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 941 | |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 942 | unsigned Align = 1u << std::min(BitWidth - 1, TrailZ); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 943 | |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 944 | // LLVM doesn't support alignments larger than this currently. |
| 945 | Align = std::min(Align, +Value::MaximumAlignment); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 946 | |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 947 | if (PrefAlign > Align) |
Matt Arsenault | 186f8f9 | 2013-08-01 22:42:18 +0000 | [diff] [blame] | 948 | Align = enforceKnownAlignment(V, Align, PrefAlign, DL); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 949 | |
Chris Lattner | 687140c | 2010-12-25 20:37:57 +0000 | [diff] [blame] | 950 | // We don't need to make any adjustment. |
| 951 | return Align; |
| 952 | } |
| 953 | |
Devang Patel | 5ee2068 | 2011-03-17 21:58:19 +0000 | [diff] [blame] | 954 | ///===---------------------------------------------------------------------===// |
| 955 | /// Dbg Intrinsic utilities |
| 956 | /// |
| 957 | |
Adrian Prantl | 163da93 | 2013-04-26 17:48:33 +0000 | [diff] [blame] | 958 | /// See if there is a dbg.value intrinsic for DIVar before I. |
| 959 | static bool LdStHasDebugValue(DIVariable &DIVar, Instruction *I) { |
| 960 | // Since we can't guarantee that the original dbg.declare instrinsic |
| 961 | // is removed by LowerDbgDeclare(), we need to make sure that we are |
| 962 | // not inserting the same dbg.value intrinsic over and over. |
| 963 | llvm::BasicBlock::InstListType::iterator PrevI(I); |
| 964 | if (PrevI != I->getParent()->getInstList().begin()) { |
| 965 | --PrevI; |
| 966 | if (DbgValueInst *DVI = dyn_cast<DbgValueInst>(PrevI)) |
| 967 | if (DVI->getValue() == I->getOperand(0) && |
| 968 | DVI->getOffset() == 0 && |
| 969 | DVI->getVariable() == DIVar) |
| 970 | return true; |
| 971 | } |
| 972 | return false; |
| 973 | } |
| 974 | |
Adrian Prantl | 9d5d58a | 2013-04-26 18:10:50 +0000 | [diff] [blame] | 975 | /// Inserts a llvm.dbg.value intrinsic before a store to an alloca'd value |
Devang Patel | 5ee2068 | 2011-03-17 21:58:19 +0000 | [diff] [blame] | 976 | /// that has an associated llvm.dbg.decl intrinsic. |
| 977 | bool llvm::ConvertDebugDeclareToDebugValue(DbgDeclareInst *DDI, |
| 978 | StoreInst *SI, DIBuilder &Builder) { |
| 979 | DIVariable DIVar(DDI->getVariable()); |
Manman Ren | cbafae6 | 2013-06-28 05:43:10 +0000 | [diff] [blame] | 980 | assert((!DIVar || DIVar.isVariable()) && |
| 981 | "Variable in DbgDeclareInst should be either null or a DIVariable."); |
| 982 | if (!DIVar) |
Devang Patel | 5ee2068 | 2011-03-17 21:58:19 +0000 | [diff] [blame] | 983 | return false; |
| 984 | |
Adrian Prantl | 163da93 | 2013-04-26 17:48:33 +0000 | [diff] [blame] | 985 | if (LdStHasDebugValue(DIVar, SI)) |
| 986 | return true; |
| 987 | |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 988 | Instruction *DbgVal = nullptr; |
Devang Patel | 227dfdb | 2011-05-16 21:24:05 +0000 | [diff] [blame] | 989 | // If an argument is zero extended then use argument directly. The ZExt |
| 990 | // may be zapped by an optimization pass in future. |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 991 | Argument *ExtendedArg = nullptr; |
Devang Patel | 227dfdb | 2011-05-16 21:24:05 +0000 | [diff] [blame] | 992 | if (ZExtInst *ZExt = dyn_cast<ZExtInst>(SI->getOperand(0))) |
| 993 | ExtendedArg = dyn_cast<Argument>(ZExt->getOperand(0)); |
| 994 | if (SExtInst *SExt = dyn_cast<SExtInst>(SI->getOperand(0))) |
| 995 | ExtendedArg = dyn_cast<Argument>(SExt->getOperand(0)); |
| 996 | if (ExtendedArg) |
| 997 | DbgVal = Builder.insertDbgValueIntrinsic(ExtendedArg, 0, DIVar, SI); |
| 998 | else |
| 999 | DbgVal = Builder.insertDbgValueIntrinsic(SI->getOperand(0), 0, DIVar, SI); |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 1000 | DbgVal->setDebugLoc(DDI->getDebugLoc()); |
Devang Patel | 5ee2068 | 2011-03-17 21:58:19 +0000 | [diff] [blame] | 1001 | return true; |
| 1002 | } |
| 1003 | |
Adrian Prantl | 9d5d58a | 2013-04-26 18:10:50 +0000 | [diff] [blame] | 1004 | /// Inserts a llvm.dbg.value intrinsic before a load of an alloca'd value |
Devang Patel | 36fae67 | 2011-03-18 23:45:43 +0000 | [diff] [blame] | 1005 | /// that has an associated llvm.dbg.decl intrinsic. |
| 1006 | bool llvm::ConvertDebugDeclareToDebugValue(DbgDeclareInst *DDI, |
| 1007 | LoadInst *LI, DIBuilder &Builder) { |
| 1008 | DIVariable DIVar(DDI->getVariable()); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 1009 | assert((!DIVar || DIVar.isVariable()) && |
Manman Ren | cbafae6 | 2013-06-28 05:43:10 +0000 | [diff] [blame] | 1010 | "Variable in DbgDeclareInst should be either null or a DIVariable."); |
| 1011 | if (!DIVar) |
Devang Patel | 36fae67 | 2011-03-18 23:45:43 +0000 | [diff] [blame] | 1012 | return false; |
| 1013 | |
Adrian Prantl | 163da93 | 2013-04-26 17:48:33 +0000 | [diff] [blame] | 1014 | if (LdStHasDebugValue(DIVar, LI)) |
| 1015 | return true; |
| 1016 | |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 1017 | Instruction *DbgVal = |
Devang Patel | 36fae67 | 2011-03-18 23:45:43 +0000 | [diff] [blame] | 1018 | Builder.insertDbgValueIntrinsic(LI->getOperand(0), 0, |
| 1019 | DIVar, LI); |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 1020 | DbgVal->setDebugLoc(DDI->getDebugLoc()); |
Devang Patel | 36fae67 | 2011-03-18 23:45:43 +0000 | [diff] [blame] | 1021 | return true; |
| 1022 | } |
| 1023 | |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 1024 | /// Determine whether this alloca is either a VLA or an array. |
| 1025 | static bool isArray(AllocaInst *AI) { |
| 1026 | return AI->isArrayAllocation() || |
| 1027 | AI->getType()->getElementType()->isArrayTy(); |
| 1028 | } |
| 1029 | |
Devang Patel | 813c9a0 | 2011-03-17 22:18:16 +0000 | [diff] [blame] | 1030 | /// LowerDbgDeclare - Lowers llvm.dbg.declare intrinsics into appropriate set |
| 1031 | /// of llvm.dbg.value intrinsics. |
| 1032 | bool llvm::LowerDbgDeclare(Function &F) { |
| 1033 | DIBuilder DIB(*F.getParent()); |
| 1034 | SmallVector<DbgDeclareInst *, 4> Dbgs; |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 1035 | for (auto &FI : F) |
| 1036 | for (BasicBlock::iterator BI : FI) |
| 1037 | if (auto DDI = dyn_cast<DbgDeclareInst>(BI)) |
Devang Patel | 813c9a0 | 2011-03-17 22:18:16 +0000 | [diff] [blame] | 1038 | Dbgs.push_back(DDI); |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 1039 | |
Devang Patel | 813c9a0 | 2011-03-17 22:18:16 +0000 | [diff] [blame] | 1040 | if (Dbgs.empty()) |
| 1041 | return false; |
| 1042 | |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 1043 | for (auto &I : Dbgs) { |
| 1044 | DbgDeclareInst *DDI = I; |
Adrian Prantl | 940267e | 2013-11-18 23:04:38 +0000 | [diff] [blame] | 1045 | AllocaInst *AI = dyn_cast_or_null<AllocaInst>(DDI->getAddress()); |
| 1046 | // If this is an alloca for a scalar variable, insert a dbg.value |
| 1047 | // at each load and store to the alloca and erase the dbg.declare. |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 1048 | // The dbg.values allow tracking a variable even if it is not |
| 1049 | // stored on the stack, while the dbg.declare can only describe |
| 1050 | // the stack slot (and at a lexical-scope granularity). Later |
| 1051 | // passes will attempt to elide the stack slot. |
| 1052 | if (AI && !isArray(AI)) { |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 1053 | for (User *U : AI->users()) |
| 1054 | if (StoreInst *SI = dyn_cast<StoreInst>(U)) |
Devang Patel | 813c9a0 | 2011-03-17 22:18:16 +0000 | [diff] [blame] | 1055 | ConvertDebugDeclareToDebugValue(DDI, SI, DIB); |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 1056 | else if (LoadInst *LI = dyn_cast<LoadInst>(U)) |
Devang Patel | 36fae67 | 2011-03-18 23:45:43 +0000 | [diff] [blame] | 1057 | ConvertDebugDeclareToDebugValue(DDI, LI, DIB); |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 1058 | else if (CallInst *CI = dyn_cast<CallInst>(U)) { |
| 1059 | // This is a call by-value or some other instruction that |
| 1060 | // takes a pointer to the variable. Insert a *value* |
| 1061 | // intrinsic that describes the alloca. |
| 1062 | auto DbgVal = |
| 1063 | DIB.insertDbgValueIntrinsic(AI, 0, |
| 1064 | DIVariable(DDI->getVariable()), CI); |
| 1065 | DbgVal->setDebugLoc(DDI->getDebugLoc()); |
| 1066 | } |
| 1067 | DDI->eraseFromParent(); |
Devang Patel | 813c9a0 | 2011-03-17 22:18:16 +0000 | [diff] [blame] | 1068 | } |
Devang Patel | 813c9a0 | 2011-03-17 22:18:16 +0000 | [diff] [blame] | 1069 | } |
| 1070 | return true; |
| 1071 | } |
Cameron Zwarich | c827939 | 2011-05-24 03:10:43 +0000 | [diff] [blame] | 1072 | |
| 1073 | /// FindAllocaDbgDeclare - Finds the llvm.dbg.declare intrinsic describing the |
| 1074 | /// alloca 'V', if any. |
| 1075 | DbgDeclareInst *llvm::FindAllocaDbgDeclare(Value *V) { |
| 1076 | if (MDNode *DebugNode = MDNode::getIfExists(V->getContext(), V)) |
Stephen Hines | 36b5688 | 2014-04-23 16:57:46 -0700 | [diff] [blame] | 1077 | for (User *U : DebugNode->users()) |
| 1078 | if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(U)) |
Cameron Zwarich | c827939 | 2011-05-24 03:10:43 +0000 | [diff] [blame] | 1079 | return DDI; |
| 1080 | |
Stephen Hines | dce4a40 | 2014-05-29 02:49:00 -0700 | [diff] [blame^] | 1081 | return nullptr; |
Cameron Zwarich | c827939 | 2011-05-24 03:10:43 +0000 | [diff] [blame] | 1082 | } |
Alexey Samsonov | 1afbb51 | 2012-12-12 14:31:53 +0000 | [diff] [blame] | 1083 | |
| 1084 | bool llvm::replaceDbgDeclareForAlloca(AllocaInst *AI, Value *NewAllocaAddress, |
| 1085 | DIBuilder &Builder) { |
| 1086 | DbgDeclareInst *DDI = FindAllocaDbgDeclare(AI); |
| 1087 | if (!DDI) |
| 1088 | return false; |
| 1089 | DIVariable DIVar(DDI->getVariable()); |
Jakub Staszak | a18c574 | 2013-07-22 23:16:36 +0000 | [diff] [blame] | 1090 | assert((!DIVar || DIVar.isVariable()) && |
Manman Ren | cbafae6 | 2013-06-28 05:43:10 +0000 | [diff] [blame] | 1091 | "Variable in DbgDeclareInst should be either null or a DIVariable."); |
| 1092 | if (!DIVar) |
Alexey Samsonov | 1afbb51 | 2012-12-12 14:31:53 +0000 | [diff] [blame] | 1093 | return false; |
| 1094 | |
| 1095 | // Create a copy of the original DIDescriptor for user variable, appending |
| 1096 | // "deref" operation to a list of address elements, as new llvm.dbg.declare |
| 1097 | // will take a value storing address of the memory for variable, not |
| 1098 | // alloca itself. |
| 1099 | Type *Int64Ty = Type::getInt64Ty(AI->getContext()); |
| 1100 | SmallVector<Value*, 4> NewDIVarAddress; |
| 1101 | if (DIVar.hasComplexAddress()) { |
| 1102 | for (unsigned i = 0, n = DIVar.getNumAddrElements(); i < n; ++i) { |
| 1103 | NewDIVarAddress.push_back( |
| 1104 | ConstantInt::get(Int64Ty, DIVar.getAddrElement(i))); |
| 1105 | } |
| 1106 | } |
| 1107 | NewDIVarAddress.push_back(ConstantInt::get(Int64Ty, DIBuilder::OpDeref)); |
| 1108 | DIVariable NewDIVar = Builder.createComplexVariable( |
| 1109 | DIVar.getTag(), DIVar.getContext(), DIVar.getName(), |
| 1110 | DIVar.getFile(), DIVar.getLineNumber(), DIVar.getType(), |
| 1111 | NewDIVarAddress, DIVar.getArgNumber()); |
| 1112 | |
| 1113 | // Insert llvm.dbg.declare in the same basic block as the original alloca, |
| 1114 | // and remove old llvm.dbg.declare. |
| 1115 | BasicBlock *BB = AI->getParent(); |
| 1116 | Builder.insertDeclare(NewAllocaAddress, NewDIVar, BB); |
| 1117 | DDI->eraseFromParent(); |
| 1118 | return true; |
| 1119 | } |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1120 | |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1121 | /// changeToUnreachable - Insert an unreachable instruction before the specified |
| 1122 | /// instruction, making it and the rest of the code in the block dead. |
| 1123 | static void changeToUnreachable(Instruction *I, bool UseLLVMTrap) { |
| 1124 | BasicBlock *BB = I->getParent(); |
| 1125 | // Loop over all of the successors, removing BB's entry from any PHI |
| 1126 | // nodes. |
| 1127 | for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI) |
| 1128 | (*SI)->removePredecessor(BB); |
| 1129 | |
| 1130 | // Insert a call to llvm.trap right before this. This turns the undefined |
| 1131 | // behavior into a hard fail instead of falling through into random code. |
| 1132 | if (UseLLVMTrap) { |
| 1133 | Function *TrapFn = |
| 1134 | Intrinsic::getDeclaration(BB->getParent()->getParent(), Intrinsic::trap); |
| 1135 | CallInst *CallTrap = CallInst::Create(TrapFn, "", I); |
| 1136 | CallTrap->setDebugLoc(I->getDebugLoc()); |
| 1137 | } |
| 1138 | new UnreachableInst(I->getContext(), I); |
| 1139 | |
| 1140 | // All instructions after this are dead. |
| 1141 | BasicBlock::iterator BBI = I, BBE = BB->end(); |
| 1142 | while (BBI != BBE) { |
| 1143 | if (!BBI->use_empty()) |
| 1144 | BBI->replaceAllUsesWith(UndefValue::get(BBI->getType())); |
| 1145 | BB->getInstList().erase(BBI++); |
| 1146 | } |
| 1147 | } |
| 1148 | |
| 1149 | /// changeToCall - Convert the specified invoke into a normal call. |
| 1150 | static void changeToCall(InvokeInst *II) { |
| 1151 | SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3); |
| 1152 | CallInst *NewCall = CallInst::Create(II->getCalledValue(), Args, "", II); |
| 1153 | NewCall->takeName(II); |
| 1154 | NewCall->setCallingConv(II->getCallingConv()); |
| 1155 | NewCall->setAttributes(II->getAttributes()); |
| 1156 | NewCall->setDebugLoc(II->getDebugLoc()); |
| 1157 | II->replaceAllUsesWith(NewCall); |
| 1158 | |
| 1159 | // Follow the call by a branch to the normal destination. |
| 1160 | BranchInst::Create(II->getNormalDest(), II); |
| 1161 | |
| 1162 | // Update PHI nodes in the unwind destination |
| 1163 | II->getUnwindDest()->removePredecessor(II->getParent()); |
| 1164 | II->eraseFromParent(); |
| 1165 | } |
| 1166 | |
| 1167 | static bool markAliveBlocks(BasicBlock *BB, |
| 1168 | SmallPtrSet<BasicBlock*, 128> &Reachable) { |
| 1169 | |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1170 | SmallVector<BasicBlock*, 128> Worklist; |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1171 | Worklist.push_back(BB); |
| 1172 | Reachable.insert(BB); |
| 1173 | bool Changed = false; |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1174 | do { |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1175 | BB = Worklist.pop_back_val(); |
| 1176 | |
| 1177 | // Do a quick scan of the basic block, turning any obviously unreachable |
| 1178 | // instructions into LLVM unreachable insts. The instruction combining pass |
| 1179 | // canonicalizes unreachable insts into stores to null or undef. |
| 1180 | for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E;++BBI){ |
| 1181 | if (CallInst *CI = dyn_cast<CallInst>(BBI)) { |
| 1182 | if (CI->doesNotReturn()) { |
| 1183 | // If we found a call to a no-return function, insert an unreachable |
| 1184 | // instruction after it. Make sure there isn't *already* one there |
| 1185 | // though. |
| 1186 | ++BBI; |
| 1187 | if (!isa<UnreachableInst>(BBI)) { |
| 1188 | // Don't insert a call to llvm.trap right before the unreachable. |
| 1189 | changeToUnreachable(BBI, false); |
| 1190 | Changed = true; |
| 1191 | } |
| 1192 | break; |
| 1193 | } |
| 1194 | } |
| 1195 | |
| 1196 | // Store to undef and store to null are undefined and used to signal that |
| 1197 | // they should be changed to unreachable by passes that can't modify the |
| 1198 | // CFG. |
| 1199 | if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) { |
| 1200 | // Don't touch volatile stores. |
| 1201 | if (SI->isVolatile()) continue; |
| 1202 | |
| 1203 | Value *Ptr = SI->getOperand(1); |
| 1204 | |
| 1205 | if (isa<UndefValue>(Ptr) || |
| 1206 | (isa<ConstantPointerNull>(Ptr) && |
| 1207 | SI->getPointerAddressSpace() == 0)) { |
| 1208 | changeToUnreachable(SI, true); |
| 1209 | Changed = true; |
| 1210 | break; |
| 1211 | } |
| 1212 | } |
| 1213 | } |
| 1214 | |
| 1215 | // Turn invokes that call 'nounwind' functions into ordinary calls. |
| 1216 | if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) { |
| 1217 | Value *Callee = II->getCalledValue(); |
| 1218 | if (isa<ConstantPointerNull>(Callee) || isa<UndefValue>(Callee)) { |
| 1219 | changeToUnreachable(II, true); |
| 1220 | Changed = true; |
| 1221 | } else if (II->doesNotThrow()) { |
| 1222 | if (II->use_empty() && II->onlyReadsMemory()) { |
| 1223 | // jump to the normal destination branch. |
| 1224 | BranchInst::Create(II->getNormalDest(), II); |
| 1225 | II->getUnwindDest()->removePredecessor(II->getParent()); |
| 1226 | II->eraseFromParent(); |
| 1227 | } else |
| 1228 | changeToCall(II); |
| 1229 | Changed = true; |
| 1230 | } |
| 1231 | } |
| 1232 | |
| 1233 | Changed |= ConstantFoldTerminator(BB, true); |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1234 | for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI) |
| 1235 | if (Reachable.insert(*SI)) |
| 1236 | Worklist.push_back(*SI); |
| 1237 | } while (!Worklist.empty()); |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1238 | return Changed; |
| 1239 | } |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1240 | |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1241 | /// removeUnreachableBlocksFromFn - Remove blocks that are not reachable, even |
| 1242 | /// if they are in a dead cycle. Return true if a change was made, false |
| 1243 | /// otherwise. |
| 1244 | bool llvm::removeUnreachableBlocks(Function &F) { |
| 1245 | SmallPtrSet<BasicBlock*, 128> Reachable; |
| 1246 | bool Changed = markAliveBlocks(F.begin(), Reachable); |
| 1247 | |
| 1248 | // If there are unreachable blocks in the CFG... |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1249 | if (Reachable.size() == F.size()) |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1250 | return Changed; |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1251 | |
| 1252 | assert(Reachable.size() < F.size()); |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1253 | NumRemoved += F.size()-Reachable.size(); |
| 1254 | |
| 1255 | // Loop over all of the basic blocks that are not reachable, dropping all of |
| 1256 | // their internal references... |
| 1257 | for (Function::iterator BB = ++F.begin(), E = F.end(); BB != E; ++BB) { |
| 1258 | if (Reachable.count(BB)) |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1259 | continue; |
| 1260 | |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1261 | for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI) |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1262 | if (Reachable.count(*SI)) |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1263 | (*SI)->removePredecessor(BB); |
| 1264 | BB->dropAllReferences(); |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1265 | } |
Evgeniy Stepanov | 7541cd3 | 2013-03-22 08:43:04 +0000 | [diff] [blame] | 1266 | |
Peter Collingbourne | 4f96b7e | 2013-08-12 22:38:43 +0000 | [diff] [blame] | 1267 | for (Function::iterator I = ++F.begin(); I != F.end();) |
Evgeniy Stepanov | 7541cd3 | 2013-03-22 08:43:04 +0000 | [diff] [blame] | 1268 | if (!Reachable.count(I)) |
| 1269 | I = F.getBasicBlockList().erase(I); |
| 1270 | else |
| 1271 | ++I; |
| 1272 | |
Evgeniy Stepanov | 3333e66 | 2012-12-21 11:18:49 +0000 | [diff] [blame] | 1273 | return true; |
| 1274 | } |