blob: 4d1234905370bb11ef7ec2734c3f5d4b23e1f462 [file] [log] [blame]
Devang Patelf42389f2007-04-07 01:25:15 +00001//===- LoopRotation.cpp - Loop Rotation Pass ------------------------------===//
2//
3// 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.
Devang Patelf42389f2007-04-07 01:25:15 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements Loop Rotation Pass.
11//
12//===----------------------------------------------------------------------===//
13
Devang Patelf42389f2007-04-07 01:25:15 +000014#include "llvm/Transforms/Scalar.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000015#include "llvm/ADT/Statistic.h"
Chandler Carruth66b31302015-01-04 12:03:27 +000016#include "llvm/Analysis/AssumptionCache.h"
Chris Lattner679572e2011-01-02 07:35:53 +000017#include "llvm/Analysis/CodeMetrics.h"
Chris Lattner8c5defd2011-01-08 08:24:46 +000018#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "llvm/Analysis/LoopPass.h"
Devang Patelfac4d1f2007-07-11 23:47:28 +000020#include "llvm/Analysis/ScalarEvolution.h"
Chandler Carruthbb9caa92013-01-21 13:04:33 +000021#include "llvm/Analysis/TargetTransformInfo.h"
Andrew Trick10cc4532012-02-14 00:00:23 +000022#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000023#include "llvm/IR/CFG.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000024#include "llvm/IR/Dominators.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000025#include "llvm/IR/Function.h"
26#include "llvm/IR/IntrinsicInst.h"
Owen Anderson115aa162014-05-26 08:58:51 +000027#include "llvm/Support/CommandLine.h"
Devang Patelf42389f2007-04-07 01:25:15 +000028#include "llvm/Support/Debug.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000029#include "llvm/Transforms/Utils/BasicBlockUtils.h"
30#include "llvm/Transforms/Utils/Local.h"
31#include "llvm/Transforms/Utils/SSAUpdater.h"
32#include "llvm/Transforms/Utils/ValueMapper.h"
Devang Patelf42389f2007-04-07 01:25:15 +000033using namespace llvm;
34
Chandler Carruth964daaa2014-04-22 02:55:47 +000035#define DEBUG_TYPE "loop-rotate"
36
Owen Anderson115aa162014-05-26 08:58:51 +000037static cl::opt<unsigned>
38DefaultRotationThreshold("rotation-max-header-size", cl::init(16), cl::Hidden,
39 cl::desc("The default maximum header size for automatic loop rotation"));
Devang Patelf42389f2007-04-07 01:25:15 +000040
41STATISTIC(NumRotated, "Number of loops rotated");
42namespace {
43
Chris Lattner2dd09db2009-09-02 06:11:42 +000044 class LoopRotate : public LoopPass {
Devang Patelf42389f2007-04-07 01:25:15 +000045 public:
Devang Patel8c78a0b2007-05-03 01:11:54 +000046 static char ID; // Pass ID, replacement for typeid
Owen Anderson115aa162014-05-26 08:58:51 +000047 LoopRotate(int SpecifiedMaxHeaderSize = -1) : LoopPass(ID) {
Owen Anderson6c18d1a2010-10-19 17:21:58 +000048 initializeLoopRotatePass(*PassRegistry::getPassRegistry());
Owen Anderson115aa162014-05-26 08:58:51 +000049 if (SpecifiedMaxHeaderSize == -1)
50 MaxHeaderSize = DefaultRotationThreshold;
51 else
52 MaxHeaderSize = unsigned(SpecifiedMaxHeaderSize);
Owen Anderson6c18d1a2010-10-19 17:21:58 +000053 }
Devang Patel09f162c2007-05-01 21:15:47 +000054
Devang Patel88bc2c62007-04-09 16:11:48 +000055 // LCSSA form makes instruction renaming easier.
Craig Topper3e4c6972014-03-05 09:10:37 +000056 void getAnalysisUsage(AnalysisUsage &AU) const override {
Chandler Carruth66b31302015-01-04 12:03:27 +000057 AU.addRequired<AssumptionCacheTracker>();
Chandler Carruth73523022014-01-13 13:07:17 +000058 AU.addPreserved<DominatorTreeWrapperPass>();
Chandler Carruth4f8f3072015-01-17 14:16:18 +000059 AU.addRequired<LoopInfoWrapperPass>();
60 AU.addPreserved<LoopInfoWrapperPass>();
Devang Patela42c3142008-02-15 01:24:49 +000061 AU.addRequiredID(LoopSimplifyID);
62 AU.addPreservedID(LoopSimplifyID);
Devang Patelf42389f2007-04-07 01:25:15 +000063 AU.addRequiredID(LCSSAID);
64 AU.addPreservedID(LCSSAID);
Devang Patelfac4d1f2007-07-11 23:47:28 +000065 AU.addPreserved<ScalarEvolution>();
Chandler Carruth705b1852015-01-31 03:43:40 +000066 AU.addRequired<TargetTransformInfoWrapperPass>();
Devang Patelf42389f2007-04-07 01:25:15 +000067 }
68
Craig Topper3e4c6972014-03-05 09:10:37 +000069 bool runOnLoop(Loop *L, LPPassManager &LPM) override;
Andrew Trick9c72b072013-05-06 17:58:18 +000070 bool simplifyLoopLatch(Loop *L);
71 bool rotateLoop(Loop *L, bool SimplifiedLatch);
Andrew Tricka20f1982012-02-14 00:00:19 +000072
Devang Patelf42389f2007-04-07 01:25:15 +000073 private:
Owen Anderson115aa162014-05-26 08:58:51 +000074 unsigned MaxHeaderSize;
Chris Lattner25ba40a2011-01-08 17:38:45 +000075 LoopInfo *LI;
Chandler Carruthbb9caa92013-01-21 13:04:33 +000076 const TargetTransformInfo *TTI;
Chandler Carruth66b31302015-01-04 12:03:27 +000077 AssumptionCache *AC;
Chandler Carruth94209092015-01-18 02:08:05 +000078 DominatorTree *DT;
Devang Patelf42389f2007-04-07 01:25:15 +000079 };
Devang Patelf42389f2007-04-07 01:25:15 +000080}
Andrew Tricka20f1982012-02-14 00:00:19 +000081
Dan Gohmand78c4002008-05-13 00:00:25 +000082char LoopRotate::ID = 0;
Owen Anderson8ac477f2010-10-12 19:48:12 +000083INITIALIZE_PASS_BEGIN(LoopRotate, "loop-rotate", "Rotate Loops", false, false)
Chandler Carruth705b1852015-01-31 03:43:40 +000084INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass)
Chandler Carruth66b31302015-01-04 12:03:27 +000085INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
Chandler Carruth4f8f3072015-01-17 14:16:18 +000086INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
Owen Anderson8ac477f2010-10-12 19:48:12 +000087INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
88INITIALIZE_PASS_DEPENDENCY(LCSSA)
Owen Anderson8ac477f2010-10-12 19:48:12 +000089INITIALIZE_PASS_END(LoopRotate, "loop-rotate", "Rotate Loops", false, false)
Devang Patelf42389f2007-04-07 01:25:15 +000090
Owen Anderson115aa162014-05-26 08:58:51 +000091Pass *llvm::createLoopRotatePass(int MaxHeaderSize) {
92 return new LoopRotate(MaxHeaderSize);
93}
Devang Patelf42389f2007-04-07 01:25:15 +000094
Devang Patel88bc2c62007-04-09 16:11:48 +000095/// Rotate Loop L as many times as possible. Return true if
Dan Gohman091e4402009-06-25 00:22:44 +000096/// the loop is rotated at least once.
Chris Lattner385f2ec2011-01-08 17:48:33 +000097bool LoopRotate::runOnLoop(Loop *L, LPPassManager &LPM) {
Paul Robinsonaf4e64d2014-02-06 00:07:05 +000098 if (skipOptnoneFunction(L))
99 return false;
100
Alexey Bataevb97f9e82014-04-15 09:37:30 +0000101 // Save the loop metadata.
102 MDNode *LoopMD = L->getLoopID();
103
Chandler Carruthfdb9c572015-02-01 12:01:35 +0000104 Function &F = *L->getHeader()->getParent();
105
Chandler Carruth4f8f3072015-01-17 14:16:18 +0000106 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
Chandler Carruthfdb9c572015-02-01 12:01:35 +0000107 TTI = &getAnalysis<TargetTransformInfoWrapperPass>().getTTI(F);
108 AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
Chandler Carruth94209092015-01-18 02:08:05 +0000109 auto *DTWP = getAnalysisIfAvailable<DominatorTreeWrapperPass>();
110 DT = DTWP ? &DTWP->getDomTree() : nullptr;
Devang Patelfac4d1f2007-07-11 23:47:28 +0000111
Andrew Trick10cc4532012-02-14 00:00:23 +0000112 // Simplify the loop latch before attempting to rotate the header
113 // upward. Rotation may not be needed if the loop tail can be folded into the
114 // loop exit.
Andrew Trick9c72b072013-05-06 17:58:18 +0000115 bool SimplifiedLatch = simplifyLoopLatch(L);
Andrew Trick10cc4532012-02-14 00:00:23 +0000116
Devang Patelf42389f2007-04-07 01:25:15 +0000117 // One loop can be rotated multiple times.
Chris Lattner25ba40a2011-01-08 17:38:45 +0000118 bool MadeChange = false;
Andrew Trick9c72b072013-05-06 17:58:18 +0000119 while (rotateLoop(L, SimplifiedLatch)) {
Chris Lattner25ba40a2011-01-08 17:38:45 +0000120 MadeChange = true;
Andrew Trick9c72b072013-05-06 17:58:18 +0000121 SimplifiedLatch = false;
122 }
Alexey Bataevb97f9e82014-04-15 09:37:30 +0000123
124 // Restore the loop metadata.
125 // NB! We presume LoopRotation DOESN'T ADD its own metadata.
126 if ((MadeChange || SimplifiedLatch) && LoopMD)
127 L->setLoopID(LoopMD);
128
Chris Lattner25ba40a2011-01-08 17:38:45 +0000129 return MadeChange;
Devang Patelf42389f2007-04-07 01:25:15 +0000130}
131
Chris Lattner30f318e2011-01-08 19:26:33 +0000132/// RewriteUsesOfClonedInstructions - We just cloned the instructions from the
133/// old header into the preheader. If there were uses of the values produced by
134/// these instruction that were outside of the loop, we have to insert PHI nodes
135/// to merge the two values. Do this now.
136static void RewriteUsesOfClonedInstructions(BasicBlock *OrigHeader,
137 BasicBlock *OrigPreheader,
138 ValueToValueMapTy &ValueMap) {
139 // Remove PHI node entries that are no longer live.
140 BasicBlock::iterator I, E = OrigHeader->end();
141 for (I = OrigHeader->begin(); PHINode *PN = dyn_cast<PHINode>(I); ++I)
142 PN->removeIncomingValue(PN->getBasicBlockIndex(OrigPreheader));
Andrew Tricka20f1982012-02-14 00:00:19 +0000143
Chris Lattner30f318e2011-01-08 19:26:33 +0000144 // Now fix up users of the instructions in OrigHeader, inserting PHI nodes
145 // as necessary.
146 SSAUpdater SSA;
147 for (I = OrigHeader->begin(); I != E; ++I) {
148 Value *OrigHeaderVal = I;
Andrew Tricka20f1982012-02-14 00:00:19 +0000149
Chris Lattner30f318e2011-01-08 19:26:33 +0000150 // If there are no uses of the value (e.g. because it returns void), there
151 // is nothing to rewrite.
152 if (OrigHeaderVal->use_empty())
153 continue;
Andrew Tricka20f1982012-02-14 00:00:19 +0000154
Chris Lattner30f318e2011-01-08 19:26:33 +0000155 Value *OrigPreHeaderVal = ValueMap[OrigHeaderVal];
156
157 // The value now exits in two versions: the initial value in the preheader
158 // and the loop "next" value in the original header.
159 SSA.Initialize(OrigHeaderVal->getType(), OrigHeaderVal->getName());
160 SSA.AddAvailableValue(OrigHeader, OrigHeaderVal);
161 SSA.AddAvailableValue(OrigPreheader, OrigPreHeaderVal);
Andrew Tricka20f1982012-02-14 00:00:19 +0000162
Chris Lattner30f318e2011-01-08 19:26:33 +0000163 // Visit each use of the OrigHeader instruction.
164 for (Value::use_iterator UI = OrigHeaderVal->use_begin(),
165 UE = OrigHeaderVal->use_end(); UI != UE; ) {
166 // Grab the use before incrementing the iterator.
Chandler Carruthcdf47882014-03-09 03:16:01 +0000167 Use &U = *UI;
Andrew Tricka20f1982012-02-14 00:00:19 +0000168
Chris Lattner30f318e2011-01-08 19:26:33 +0000169 // Increment the iterator before removing the use from the list.
170 ++UI;
Andrew Tricka20f1982012-02-14 00:00:19 +0000171
Chris Lattner30f318e2011-01-08 19:26:33 +0000172 // SSAUpdater can't handle a non-PHI use in the same block as an
173 // earlier def. We can easily handle those cases manually.
174 Instruction *UserInst = cast<Instruction>(U.getUser());
175 if (!isa<PHINode>(UserInst)) {
176 BasicBlock *UserBB = UserInst->getParent();
Andrew Tricka20f1982012-02-14 00:00:19 +0000177
Chris Lattner30f318e2011-01-08 19:26:33 +0000178 // The original users in the OrigHeader are already using the
179 // original definitions.
180 if (UserBB == OrigHeader)
181 continue;
Andrew Tricka20f1982012-02-14 00:00:19 +0000182
Chris Lattner30f318e2011-01-08 19:26:33 +0000183 // Users in the OrigPreHeader need to use the value to which the
184 // original definitions are mapped.
185 if (UserBB == OrigPreheader) {
186 U = OrigPreHeaderVal;
187 continue;
188 }
189 }
Andrew Tricka20f1982012-02-14 00:00:19 +0000190
Chris Lattner30f318e2011-01-08 19:26:33 +0000191 // Anything else can be handled by SSAUpdater.
192 SSA.RewriteUse(U);
193 }
194 }
Andrew Tricka20f1982012-02-14 00:00:19 +0000195}
Chris Lattner30f318e2011-01-08 19:26:33 +0000196
JF Bastienac8b66b2014-08-05 23:27:34 +0000197/// Determine whether the instructions in this range may be safely and cheaply
Andrew Trick10cc4532012-02-14 00:00:23 +0000198/// speculated. This is not an important enough situation to develop complex
199/// heuristics. We handle a single arithmetic instruction along with any type
200/// conversions.
201static bool shouldSpeculateInstrs(BasicBlock::iterator Begin,
Yi Jiangab19fff2014-10-29 20:19:47 +0000202 BasicBlock::iterator End, Loop *L) {
Andrew Trick10cc4532012-02-14 00:00:23 +0000203 bool seenIncrement = false;
Yi Jiangab19fff2014-10-29 20:19:47 +0000204 bool MultiExitLoop = false;
205
206 if (!L->getExitingBlock())
207 MultiExitLoop = true;
208
Andrew Trick10cc4532012-02-14 00:00:23 +0000209 for (BasicBlock::iterator I = Begin; I != End; ++I) {
210
211 if (!isSafeToSpeculativelyExecute(I))
212 return false;
213
214 if (isa<DbgInfoIntrinsic>(I))
215 continue;
216
217 switch (I->getOpcode()) {
218 default:
219 return false;
220 case Instruction::GetElementPtr:
221 // GEPs are cheap if all indices are constant.
222 if (!cast<GEPOperator>(I)->hasAllConstantIndices())
223 return false;
224 // fall-thru to increment case
225 case Instruction::Add:
226 case Instruction::Sub:
227 case Instruction::And:
228 case Instruction::Or:
229 case Instruction::Xor:
230 case Instruction::Shl:
231 case Instruction::LShr:
Yi Jiangab19fff2014-10-29 20:19:47 +0000232 case Instruction::AShr: {
David Majnemer4c82dae2015-01-27 06:21:43 +0000233 Value *IVOpnd = !isa<Constant>(I->getOperand(0))
234 ? I->getOperand(0)
235 : !isa<Constant>(I->getOperand(1))
236 ? I->getOperand(1)
237 : nullptr;
238 if (!IVOpnd)
239 return false;
Yi Jiangab19fff2014-10-29 20:19:47 +0000240
241 // If increment operand is used outside of the loop, this speculation
242 // could cause extra live range interference.
David Majnemer4c82dae2015-01-27 06:21:43 +0000243 if (MultiExitLoop) {
Yi Jiangab19fff2014-10-29 20:19:47 +0000244 for (User *UseI : IVOpnd->users()) {
245 auto *UserInst = cast<Instruction>(UseI);
246 if (!L->contains(UserInst))
247 return false;
248 }
249 }
250
Andrew Trick10cc4532012-02-14 00:00:23 +0000251 if (seenIncrement)
252 return false;
253 seenIncrement = true;
254 break;
Yi Jiangab19fff2014-10-29 20:19:47 +0000255 }
Andrew Trick10cc4532012-02-14 00:00:23 +0000256 case Instruction::Trunc:
257 case Instruction::ZExt:
258 case Instruction::SExt:
259 // ignore type conversions
260 break;
261 }
262 }
263 return true;
264}
265
266/// Fold the loop tail into the loop exit by speculating the loop tail
267/// instructions. Typically, this is a single post-increment. In the case of a
268/// simple 2-block loop, hoisting the increment can be much better than
JF Bastienac8b66b2014-08-05 23:27:34 +0000269/// duplicating the entire loop header. In the case of loops with early exits,
Andrew Trick10cc4532012-02-14 00:00:23 +0000270/// rotation will not work anyway, but simplifyLoopLatch will put the loop in
271/// canonical form so downstream passes can handle it.
272///
273/// I don't believe this invalidates SCEV.
Andrew Trick9c72b072013-05-06 17:58:18 +0000274bool LoopRotate::simplifyLoopLatch(Loop *L) {
Andrew Trick10cc4532012-02-14 00:00:23 +0000275 BasicBlock *Latch = L->getLoopLatch();
276 if (!Latch || Latch->hasAddressTaken())
Andrew Trick9c72b072013-05-06 17:58:18 +0000277 return false;
Andrew Trick10cc4532012-02-14 00:00:23 +0000278
279 BranchInst *Jmp = dyn_cast<BranchInst>(Latch->getTerminator());
280 if (!Jmp || !Jmp->isUnconditional())
Andrew Trick9c72b072013-05-06 17:58:18 +0000281 return false;
Andrew Trick10cc4532012-02-14 00:00:23 +0000282
283 BasicBlock *LastExit = Latch->getSinglePredecessor();
284 if (!LastExit || !L->isLoopExiting(LastExit))
Andrew Trick9c72b072013-05-06 17:58:18 +0000285 return false;
Andrew Trick10cc4532012-02-14 00:00:23 +0000286
287 BranchInst *BI = dyn_cast<BranchInst>(LastExit->getTerminator());
288 if (!BI)
Andrew Trick9c72b072013-05-06 17:58:18 +0000289 return false;
Andrew Trick10cc4532012-02-14 00:00:23 +0000290
Yi Jiangab19fff2014-10-29 20:19:47 +0000291 if (!shouldSpeculateInstrs(Latch->begin(), Jmp, L))
Andrew Trick9c72b072013-05-06 17:58:18 +0000292 return false;
Andrew Trick10cc4532012-02-14 00:00:23 +0000293
294 DEBUG(dbgs() << "Folding loop latch " << Latch->getName() << " into "
295 << LastExit->getName() << "\n");
296
297 // Hoist the instructions from Latch into LastExit.
298 LastExit->getInstList().splice(BI, Latch->getInstList(), Latch->begin(), Jmp);
299
300 unsigned FallThruPath = BI->getSuccessor(0) == Latch ? 0 : 1;
301 BasicBlock *Header = Jmp->getSuccessor(0);
302 assert(Header == L->getHeader() && "expected a backward branch");
303
304 // Remove Latch from the CFG so that LastExit becomes the new Latch.
305 BI->setSuccessor(FallThruPath, Header);
306 Latch->replaceSuccessorsPhiUsesWith(LastExit);
307 Jmp->eraseFromParent();
308
309 // Nuke the Latch block.
310 assert(Latch->empty() && "unable to evacuate Latch");
311 LI->removeBlock(Latch);
Chandler Carruth94209092015-01-18 02:08:05 +0000312 if (DT)
313 DT->eraseNode(Latch);
Andrew Trick10cc4532012-02-14 00:00:23 +0000314 Latch->eraseFromParent();
Andrew Trick9c72b072013-05-06 17:58:18 +0000315 return true;
Andrew Trick10cc4532012-02-14 00:00:23 +0000316}
317
Dan Gohmanb5650eb2007-05-11 21:10:54 +0000318/// Rotate loop LP. Return true if the loop is rotated.
Andrew Trick9c72b072013-05-06 17:58:18 +0000319///
320/// \param SimplifiedLatch is true if the latch was just folded into the final
321/// loop exit. In this case we may want to rotate even though the new latch is
322/// now an exiting branch. This rotation would have happened had the latch not
323/// been simplified. However, if SimplifiedLatch is false, then we avoid
324/// rotating loops in which the latch exits to avoid excessive or endless
325/// rotation. LoopRotate should be repeatable and converge to a canonical
326/// form. This property is satisfied because simplifying the loop latch can only
327/// happen once across multiple invocations of the LoopRotate pass.
328bool LoopRotate::rotateLoop(Loop *L, bool SimplifiedLatch) {
Dan Gohman091e4402009-06-25 00:22:44 +0000329 // If the loop has only one block then there is not much to rotate.
Devang Patel88bc2c62007-04-09 16:11:48 +0000330 if (L->getBlocks().size() == 1)
Devang Patelf42389f2007-04-07 01:25:15 +0000331 return false;
Andrew Tricka20f1982012-02-14 00:00:19 +0000332
Chris Lattner7fab23b2011-01-08 18:06:22 +0000333 BasicBlock *OrigHeader = L->getHeader();
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000334 BasicBlock *OrigLatch = L->getLoopLatch();
Andrew Tricka20f1982012-02-14 00:00:19 +0000335
Chris Lattner7fab23b2011-01-08 18:06:22 +0000336 BranchInst *BI = dyn_cast<BranchInst>(OrigHeader->getTerminator());
Craig Topperf40110f2014-04-25 05:29:35 +0000337 if (!BI || BI->isUnconditional())
Chris Lattner7fab23b2011-01-08 18:06:22 +0000338 return false;
Andrew Tricka20f1982012-02-14 00:00:19 +0000339
Dan Gohman091e4402009-06-25 00:22:44 +0000340 // If the loop header is not one of the loop exiting blocks then
341 // either this loop is already rotated or it is not
Devang Patelf42389f2007-04-07 01:25:15 +0000342 // suitable for loop rotation transformations.
Dan Gohman8f4078b2009-10-24 23:34:26 +0000343 if (!L->isLoopExiting(OrigHeader))
Devang Patelf42389f2007-04-07 01:25:15 +0000344 return false;
345
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000346 // If the loop latch already contains a branch that leaves the loop then the
347 // loop is already rotated.
Craig Topperf40110f2014-04-25 05:29:35 +0000348 if (!OrigLatch)
Andrew Trick9c72b072013-05-06 17:58:18 +0000349 return false;
350
351 // Rotate if either the loop latch does *not* exit the loop, or if the loop
352 // latch was just simplified.
353 if (L->isLoopExiting(OrigLatch) && !SimplifiedLatch)
Devang Patelf42389f2007-04-07 01:25:15 +0000354 return false;
355
James Molloy4f6fb952012-12-20 16:04:27 +0000356 // Check size of original header and reject loop if it is very big or we can't
357 // duplicate blocks inside it.
Chris Lattner679572e2011-01-02 07:35:53 +0000358 {
Hal Finkel57f03dd2014-09-07 13:49:57 +0000359 SmallPtrSet<const Value *, 32> EphValues;
Chandler Carruth66b31302015-01-04 12:03:27 +0000360 CodeMetrics::collectEphemeralValues(L, AC, EphValues);
Hal Finkel57f03dd2014-09-07 13:49:57 +0000361
Chris Lattner679572e2011-01-02 07:35:53 +0000362 CodeMetrics Metrics;
Hal Finkel57f03dd2014-09-07 13:49:57 +0000363 Metrics.analyzeBasicBlock(OrigHeader, *TTI, EphValues);
James Molloy4f6fb952012-12-20 16:04:27 +0000364 if (Metrics.notDuplicatable) {
Alp Tokerf907b892013-12-05 05:44:44 +0000365 DEBUG(dbgs() << "LoopRotation: NOT rotating - contains non-duplicatable"
James Molloy4f6fb952012-12-20 16:04:27 +0000366 << " instructions: "; L->dump());
367 return false;
368 }
Owen Anderson115aa162014-05-26 08:58:51 +0000369 if (Metrics.NumInsts > MaxHeaderSize)
Chris Lattner679572e2011-01-02 07:35:53 +0000370 return false;
Devang Patelbab43b42009-03-06 03:51:30 +0000371 }
372
Devang Patelfac4d1f2007-07-11 23:47:28 +0000373 // Now, this loop is suitable for rotation.
Chris Lattner30f318e2011-01-08 19:26:33 +0000374 BasicBlock *OrigPreheader = L->getLoopPreheader();
Andrew Tricka20f1982012-02-14 00:00:19 +0000375
Chris Lattner88974f42011-04-09 07:25:58 +0000376 // If the loop could not be converted to canonical form, it must have an
377 // indirectbr in it, just give up.
Craig Topperf40110f2014-04-25 05:29:35 +0000378 if (!OrigPreheader)
Chris Lattner88974f42011-04-09 07:25:58 +0000379 return false;
Devang Patelfac4d1f2007-07-11 23:47:28 +0000380
Dan Gohmanfc20b672009-09-27 15:37:03 +0000381 // Anything ScalarEvolution may know about this loop or the PHI nodes
382 // in its header will soon be invalidated.
383 if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
Dan Gohman880c92a2009-10-31 15:04:55 +0000384 SE->forgetLoop(L);
Dan Gohmanfc20b672009-09-27 15:37:03 +0000385
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000386 DEBUG(dbgs() << "LoopRotation: rotating "; L->dump());
387
Devang Patelf42389f2007-04-07 01:25:15 +0000388 // Find new Loop header. NewHeader is a Header's one and only successor
Chris Lattner57cb4722009-01-26 01:57:01 +0000389 // that is inside loop. Header's other successor is outside the
390 // loop. Otherwise loop is not suitable for rotation.
Chris Lattner385f2ec2011-01-08 17:48:33 +0000391 BasicBlock *Exit = BI->getSuccessor(0);
392 BasicBlock *NewHeader = BI->getSuccessor(1);
Devang Patel88bc2c62007-04-09 16:11:48 +0000393 if (L->contains(Exit))
394 std::swap(Exit, NewHeader);
Chris Lattnerd67aaa62009-01-26 01:38:24 +0000395 assert(NewHeader && "Unable to determine new loop header");
Andrew Tricka20f1982012-02-14 00:00:19 +0000396 assert(L->contains(NewHeader) && !L->contains(Exit) &&
Devang Patel88bc2c62007-04-09 16:11:48 +0000397 "Unable to determine loop header and exit blocks");
Andrew Tricka20f1982012-02-14 00:00:19 +0000398
Dan Gohman091e4402009-06-25 00:22:44 +0000399 // This code assumes that the new header has exactly one predecessor.
400 // Remove any single-entry PHI nodes in it.
Chris Lattner7b6647c2009-01-26 02:11:30 +0000401 assert(NewHeader->getSinglePredecessor() &&
402 "New header doesn't have one pred!");
403 FoldSingleEntryPHINodes(NewHeader);
Devang Patelf42389f2007-04-07 01:25:15 +0000404
Dan Gohmanb9797942009-10-24 23:19:52 +0000405 // Begin by walking OrigHeader and populating ValueMap with an entry for
406 // each Instruction.
Devang Patel88bc2c62007-04-09 16:11:48 +0000407 BasicBlock::iterator I = OrigHeader->begin(), E = OrigHeader->end();
Chris Lattner2b3f20e2011-01-08 07:21:31 +0000408 ValueToValueMapTy ValueMap;
Devang Patelb9af5742007-04-09 19:04:21 +0000409
Dan Gohmanb9797942009-10-24 23:19:52 +0000410 // For PHI nodes, the value available in OldPreHeader is just the
411 // incoming value from OldPreHeader.
412 for (; PHINode *PN = dyn_cast<PHINode>(I); ++I)
Jay Foad372ad642011-06-20 14:18:48 +0000413 ValueMap[PN] = PN->getIncomingValueForBlock(OrigPreheader);
Devang Patelf42389f2007-04-07 01:25:15 +0000414
Chris Lattnerb01c24a2010-09-06 01:10:22 +0000415 // For the rest of the instructions, either hoist to the OrigPreheader if
416 // possible or create a clone in the OldPreHeader if not.
Chris Lattner30f318e2011-01-08 19:26:33 +0000417 TerminatorInst *LoopEntryBranch = OrigPreheader->getTerminator();
Chris Lattnerb01c24a2010-09-06 01:10:22 +0000418 while (I != E) {
419 Instruction *Inst = I++;
Andrew Tricka20f1982012-02-14 00:00:19 +0000420
Chris Lattnerb01c24a2010-09-06 01:10:22 +0000421 // If the instruction's operands are invariant and it doesn't read or write
422 // memory, then it is safe to hoist. Doing this doesn't change the order of
423 // execution in the preheader, but does prevent the instruction from
424 // executing in each iteration of the loop. This means it is safe to hoist
425 // something that might trap, but isn't safe to hoist something that reads
426 // memory (without proving that the loop doesn't write).
427 if (L->hasLoopInvariantOperands(Inst) &&
428 !Inst->mayReadFromMemory() && !Inst->mayWriteToMemory() &&
Eli Friedmanc4588852012-02-16 00:41:10 +0000429 !isa<TerminatorInst>(Inst) && !isa<DbgInfoIntrinsic>(Inst) &&
430 !isa<AllocaInst>(Inst)) {
Chris Lattnerb01c24a2010-09-06 01:10:22 +0000431 Inst->moveBefore(LoopEntryBranch);
432 continue;
433 }
Andrew Tricka20f1982012-02-14 00:00:19 +0000434
Chris Lattnerb01c24a2010-09-06 01:10:22 +0000435 // Otherwise, create a duplicate of the instruction.
436 Instruction *C = Inst->clone();
Andrew Tricka20f1982012-02-14 00:00:19 +0000437
Chris Lattner8c5defd2011-01-08 08:24:46 +0000438 // Eagerly remap the operands of the instruction.
439 RemapInstruction(C, ValueMap,
440 RF_NoModuleLevelChanges|RF_IgnoreMissingEntries);
Andrew Tricka20f1982012-02-14 00:00:19 +0000441
Chris Lattner8c5defd2011-01-08 08:24:46 +0000442 // With the operands remapped, see if the instruction constant folds or is
443 // otherwise simplifyable. This commonly occurs because the entry from PHI
444 // nodes allows icmps and other instructions to fold.
Chandler Carruth66b31302015-01-04 12:03:27 +0000445 // FIXME: Provide DL, TLI, DT, AC to SimplifyInstruction.
Chris Lattner25ba40a2011-01-08 17:38:45 +0000446 Value *V = SimplifyInstruction(C);
447 if (V && LI->replacementPreservesLCSSAForm(C, V)) {
Chris Lattner8c5defd2011-01-08 08:24:46 +0000448 // If so, then delete the temporary instruction and stick the folded value
449 // in the map.
450 delete C;
451 ValueMap[Inst] = V;
452 } else {
453 // Otherwise, stick the new instruction into the new block!
454 C->setName(Inst->getName());
455 C->insertBefore(LoopEntryBranch);
456 ValueMap[Inst] = C;
457 }
Devang Patelf42389f2007-04-07 01:25:15 +0000458 }
459
Dan Gohmanb9797942009-10-24 23:19:52 +0000460 // Along with all the other instructions, we just cloned OrigHeader's
461 // terminator into OrigPreHeader. Fix up the PHI nodes in each of OrigHeader's
462 // successors by duplicating their incoming values for OrigHeader.
463 TerminatorInst *TI = OrigHeader->getTerminator();
464 for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
465 for (BasicBlock::iterator BI = TI->getSuccessor(i)->begin();
466 PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
Chris Lattner30f318e2011-01-08 19:26:33 +0000467 PN->addIncoming(PN->getIncomingValueForBlock(OrigHeader), OrigPreheader);
Devang Patelf42389f2007-04-07 01:25:15 +0000468
Dan Gohmanb9797942009-10-24 23:19:52 +0000469 // Now that OrigPreHeader has a clone of OrigHeader's terminator, remove
470 // OrigPreHeader's old terminator (the original branch into the loop), and
471 // remove the corresponding incoming values from the PHI nodes in OrigHeader.
472 LoopEntryBranch->eraseFromParent();
Devang Patelf42389f2007-04-07 01:25:15 +0000473
Chris Lattner30f318e2011-01-08 19:26:33 +0000474 // If there were any uses of instructions in the duplicated block outside the
475 // loop, update them, inserting PHI nodes as required
476 RewriteUsesOfClonedInstructions(OrigHeader, OrigPreheader, ValueMap);
Devang Patelf42389f2007-04-07 01:25:15 +0000477
Dan Gohmanb9797942009-10-24 23:19:52 +0000478 // NewHeader is now the header of the loop.
Devang Patelf42389f2007-04-07 01:25:15 +0000479 L->moveToHeader(NewHeader);
Chris Lattner26151302011-01-08 19:10:28 +0000480 assert(L->getHeader() == NewHeader && "Latch block is our new header");
Devang Patelf42389f2007-04-07 01:25:15 +0000481
Andrew Tricka20f1982012-02-14 00:00:19 +0000482
Chris Lattner59c82f82011-01-08 19:59:06 +0000483 // At this point, we've finished our major CFG changes. As part of cloning
484 // the loop into the preheader we've simplified instructions and the
485 // duplicated conditional branch may now be branching on a constant. If it is
486 // branching on a constant and if that constant means that we enter the loop,
487 // then we fold away the cond branch to an uncond branch. This simplifies the
488 // loop in cases important for nested loops, and it also means we don't have
489 // to split as many edges.
490 BranchInst *PHBI = cast<BranchInst>(OrigPreheader->getTerminator());
491 assert(PHBI->isConditional() && "Should be clone of BI condbr!");
492 if (!isa<ConstantInt>(PHBI->getCondition()) ||
493 PHBI->getSuccessor(cast<ConstantInt>(PHBI->getCondition())->isZero())
494 != NewHeader) {
495 // The conditional branch can't be folded, handle the general case.
496 // Update DominatorTree to reflect the CFG change we just made. Then split
497 // edges as necessary to preserve LoopSimplify form.
Chandler Carruth94209092015-01-18 02:08:05 +0000498 if (DT) {
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000499 // Everything that was dominated by the old loop header is now dominated
500 // by the original loop preheader. Conceptually the header was merged
501 // into the preheader, even though we reuse the actual block as a new
502 // loop latch.
Chandler Carruth94209092015-01-18 02:08:05 +0000503 DomTreeNode *OrigHeaderNode = DT->getNode(OrigHeader);
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000504 SmallVector<DomTreeNode *, 8> HeaderChildren(OrigHeaderNode->begin(),
505 OrigHeaderNode->end());
Chandler Carruth94209092015-01-18 02:08:05 +0000506 DomTreeNode *OrigPreheaderNode = DT->getNode(OrigPreheader);
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000507 for (unsigned I = 0, E = HeaderChildren.size(); I != E; ++I)
Chandler Carruth94209092015-01-18 02:08:05 +0000508 DT->changeImmediateDominator(HeaderChildren[I], OrigPreheaderNode);
Andrew Tricka20f1982012-02-14 00:00:19 +0000509
Chandler Carruth94209092015-01-18 02:08:05 +0000510 assert(DT->getNode(Exit)->getIDom() == OrigPreheaderNode);
511 assert(DT->getNode(NewHeader)->getIDom() == OrigPreheaderNode);
Benjamin Kramer3be6a482012-09-01 12:04:51 +0000512
Chris Lattner59c82f82011-01-08 19:59:06 +0000513 // Update OrigHeader to be dominated by the new header block.
Chandler Carruth94209092015-01-18 02:08:05 +0000514 DT->changeImmediateDominator(OrigHeader, OrigLatch);
Chris Lattner59c82f82011-01-08 19:59:06 +0000515 }
Andrew Tricka20f1982012-02-14 00:00:19 +0000516
Chris Lattner59c82f82011-01-08 19:59:06 +0000517 // Right now OrigPreHeader has two successors, NewHeader and ExitBlock, and
Nadav Rotem465834c2012-07-24 10:51:42 +0000518 // thus is not a preheader anymore.
519 // Split the edge to form a real preheader.
Chandler Carruth37df2cf2015-01-19 12:09:11 +0000520 BasicBlock *NewPH = SplitCriticalEdge(
521 OrigPreheader, NewHeader,
522 CriticalEdgeSplittingOptions(DT, LI).setPreserveLCSSA());
Chris Lattner59c82f82011-01-08 19:59:06 +0000523 NewPH->setName(NewHeader->getName() + ".lr.ph");
Andrew Tricka20f1982012-02-14 00:00:19 +0000524
Nadav Rotem465834c2012-07-24 10:51:42 +0000525 // Preserve canonical loop form, which means that 'Exit' should have only
Chandler Carruthd4be9dc2014-01-29 13:16:53 +0000526 // one predecessor. Note that Exit could be an exit block for multiple
527 // nested loops, causing both of the edges to now be critical and need to
528 // be split.
529 SmallVector<BasicBlock *, 4> ExitPreds(pred_begin(Exit), pred_end(Exit));
530 bool SplitLatchEdge = false;
531 for (SmallVectorImpl<BasicBlock *>::iterator PI = ExitPreds.begin(),
532 PE = ExitPreds.end();
533 PI != PE; ++PI) {
534 // We only need to split loop exit edges.
535 Loop *PredLoop = LI->getLoopFor(*PI);
536 if (!PredLoop || PredLoop->contains(Exit))
537 continue;
Benjamin Kramer911d5b32015-02-20 20:49:25 +0000538 if (isa<IndirectBrInst>((*PI)->getTerminator()))
539 continue;
Chandler Carruthd4be9dc2014-01-29 13:16:53 +0000540 SplitLatchEdge |= L->getLoopLatch() == *PI;
Chandler Carruth37df2cf2015-01-19 12:09:11 +0000541 BasicBlock *ExitSplit = SplitCriticalEdge(
542 *PI, Exit, CriticalEdgeSplittingOptions(DT, LI).setPreserveLCSSA());
Chandler Carruthd4be9dc2014-01-29 13:16:53 +0000543 ExitSplit->moveBefore(Exit);
544 }
545 assert(SplitLatchEdge &&
546 "Despite splitting all preds, failed to split latch exit?");
Chris Lattner59c82f82011-01-08 19:59:06 +0000547 } else {
548 // We can fold the conditional branch in the preheader, this makes things
549 // simpler. The first step is to remove the extra edge to the Exit block.
550 Exit->removePredecessor(OrigPreheader, true /*preserve LCSSA*/);
Devang Patelc1f7c1d2011-04-29 20:38:55 +0000551 BranchInst *NewBI = BranchInst::Create(NewHeader, PHBI);
552 NewBI->setDebugLoc(PHBI->getDebugLoc());
Chris Lattner59c82f82011-01-08 19:59:06 +0000553 PHBI->eraseFromParent();
Andrew Tricka20f1982012-02-14 00:00:19 +0000554
Chris Lattner59c82f82011-01-08 19:59:06 +0000555 // With our CFG finalized, update DomTree if it is available.
Chandler Carruth94209092015-01-18 02:08:05 +0000556 if (DT) {
Chris Lattner59c82f82011-01-08 19:59:06 +0000557 // Update OrigHeader to be dominated by the new header block.
Chandler Carruth94209092015-01-18 02:08:05 +0000558 DT->changeImmediateDominator(NewHeader, OrigPreheader);
559 DT->changeImmediateDominator(OrigHeader, OrigLatch);
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000560
561 // Brute force incremental dominator tree update. Call
562 // findNearestCommonDominator on all CFG predecessors of each child of the
563 // original header.
Chandler Carruth94209092015-01-18 02:08:05 +0000564 DomTreeNode *OrigHeaderNode = DT->getNode(OrigHeader);
Benjamin Kramer599a4bb2012-09-02 11:57:22 +0000565 SmallVector<DomTreeNode *, 8> HeaderChildren(OrigHeaderNode->begin(),
566 OrigHeaderNode->end());
567 bool Changed;
568 do {
569 Changed = false;
570 for (unsigned I = 0, E = HeaderChildren.size(); I != E; ++I) {
571 DomTreeNode *Node = HeaderChildren[I];
572 BasicBlock *BB = Node->getBlock();
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000573
Benjamin Kramer599a4bb2012-09-02 11:57:22 +0000574 pred_iterator PI = pred_begin(BB);
575 BasicBlock *NearestDom = *PI;
576 for (pred_iterator PE = pred_end(BB); PI != PE; ++PI)
Chandler Carruth94209092015-01-18 02:08:05 +0000577 NearestDom = DT->findNearestCommonDominator(NearestDom, *PI);
Benjamin Kramer599a4bb2012-09-02 11:57:22 +0000578
579 // Remember if this changes the DomTree.
580 if (Node->getIDom()->getBlock() != NearestDom) {
Chandler Carruth94209092015-01-18 02:08:05 +0000581 DT->changeImmediateDominator(BB, NearestDom);
Benjamin Kramer599a4bb2012-09-02 11:57:22 +0000582 Changed = true;
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000583 }
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000584 }
585
Benjamin Kramer599a4bb2012-09-02 11:57:22 +0000586 // If the dominator changed, this may have an effect on other
587 // predecessors, continue until we reach a fixpoint.
588 } while (Changed);
Chris Lattner59c82f82011-01-08 19:59:06 +0000589 }
Devang Patelfac4d1f2007-07-11 23:47:28 +0000590 }
Andrew Tricka20f1982012-02-14 00:00:19 +0000591
Chris Lattner59c82f82011-01-08 19:59:06 +0000592 assert(L->getLoopPreheader() && "Invalid loop preheader after loop rotation");
Chris Lattner063dca02011-01-08 18:52:51 +0000593 assert(L->getLoopLatch() && "Invalid loop latch after loop rotation");
Chris Lattnerfee37c52011-01-08 18:55:50 +0000594
Chris Lattner63fe78d2011-01-11 07:47:59 +0000595 // Now that the CFG and DomTree are in a consistent state again, try to merge
596 // the OrigHeader block into OrigLatch. This will succeed if they are
597 // connected by an unconditional branch. This is just a cleanup so the
598 // emitted code isn't too gross in this common case.
Chandler Carruthb5c11532015-01-18 02:11:23 +0000599 MergeBlockIntoPredecessor(OrigHeader, DT, LI);
Andrew Tricka20f1982012-02-14 00:00:19 +0000600
Benjamin Kramerafdfdb52012-08-30 15:39:42 +0000601 DEBUG(dbgs() << "LoopRotation: into "; L->dump());
602
Chris Lattnerfee37c52011-01-08 18:55:50 +0000603 ++NumRotated;
604 return true;
Devang Patel85419782007-04-09 20:19:46 +0000605}