lib/Transforms/Utils/LoopUnroll.cpp

   1 //===-- UnrollLoop.cpp - Loop unrolling utilities -------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements some loop unrolling utilities. It does not define any
  11 // actual pass or policy, but provides a single function to perform loop
  12 // unrolling.
  13 //
  14 // The process of unrolling can produce extraneous basic blocks linked with
  15 // unconditional branches.  This will be corrected in the future.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #define DEBUG_TYPE "loop-unroll"
  20 #include "llvm/Transforms/Utils/UnrollLoop.h"
  21 #include "llvm/BasicBlock.h"
  22 #include "llvm/ADT/Statistic.h"
  23 #include "llvm/Analysis/InstructionSimplify.h"
  24 #include "llvm/Analysis/LoopPass.h"
  25 #include "llvm/Analysis/ScalarEvolution.h"
  26 #include "llvm/Support/Debug.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  29 #include "llvm/Transforms/Utils/Cloning.h"
  30 #include "llvm/Transforms/Utils/Local.h"
  31 using namespace llvm;
  32
  33 // TODO: Should these be here or in LoopUnroll?
  34 STATISTIC(NumCompletelyUnrolled, "Number of loops completely unrolled");
  35 STATISTIC(NumUnrolled, "Number of loops unrolled (completely or otherwise)");
  36
  37 /// RemapInstruction - Convert the instruction operands from referencing the
  38 /// current values into those specified by VMap.
  39 static inline void RemapInstruction(Instruction *I,
  40                                     ValueToValueMapTy &VMap) {
  41   for (unsigned op = 0, E = I->getNumOperands(); op != E; ++op) {
  42     Value *Op = I->getOperand(op);
  43     ValueToValueMapTy::iterator It = VMap.find(Op);
  44     if (It != VMap.end())
  45       I->setOperand(op, It->second);
  46   }
  47
  48   if (PHINode *PN = dyn_cast<PHINode>(I)) {
  49     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
  50       ValueToValueMapTy::iterator It = VMap.find(PN->getIncomingBlock(i));
  51       if (It != VMap.end())
  52         PN->setIncomingBlock(i, cast<BasicBlock>(It->second));
  53     }
  54   }
  55 }
  56
  57 /// FoldBlockIntoPredecessor - Folds a basic block into its predecessor if it
  58 /// only has one predecessor, and that predecessor only has one successor.
  59 /// The LoopInfo Analysis that is passed will be kept consistent.
  60 /// Returns the new combined block.
  61 static BasicBlock *FoldBlockIntoPredecessor(BasicBlock *BB, LoopInfo* LI,
  62                                             LPPassManager *LPM) {
  63   // Merge basic blocks into their predecessor if there is only one distinct
  64   // pred, and if there is only one distinct successor of the predecessor, and
  65   // if there are no PHI nodes.
  66   BasicBlock *OnlyPred = BB->getSinglePredecessor();
  67   if (!OnlyPred) return 0;
  68
  69   if (OnlyPred->getTerminator()->getNumSuccessors() != 1)
  70     return 0;
  71
  72   DEBUG(dbgs() << "Merging: " << *BB << "into: " << *OnlyPred);
  73
  74   // Resolve any PHI nodes at the start of the block.  They are all
  75   // guaranteed to have exactly one entry if they exist, unless there are
  76   // multiple duplicate (but guaranteed to be equal) entries for the
  77   // incoming edges.  This occurs when there are multiple edges from
  78   // OnlyPred to OnlySucc.
  79   FoldSingleEntryPHINodes(BB);
  80
  81   // Delete the unconditional branch from the predecessor...
  82   OnlyPred->getInstList().pop_back();
  83
  84   // Make all PHI nodes that referred to BB now refer to Pred as their
  85   // source...
  86   BB->replaceAllUsesWith(OnlyPred);
  87
  88   // Move all definitions in the successor to the predecessor...
  89   OnlyPred->getInstList().splice(OnlyPred->end(), BB->getInstList());
  90
  91   std::string OldName = BB->getName();
  92
  93   // Erase basic block from the function...
  94
  95   // ScalarEvolution holds references to loop exit blocks.
  96   if (ScalarEvolution *SE = LPM->getAnalysisIfAvailable<ScalarEvolution>()) {
  97     if (Loop *L = LI->getLoopFor(BB))
  98       SE->forgetLoop(L);
  99   }
 100   LI->removeBlock(BB);
 101   BB->eraseFromParent();
 102
 103   // Inherit predecessor's name if it exists...
 104   if (!OldName.empty() && !OnlyPred->hasName())
 105     OnlyPred->setName(OldName);
 106
 107   return OnlyPred;
 108 }
 109
 110 /// Unroll the given loop by Count. The loop must be in LCSSA form. Returns true
 111 /// if unrolling was successful, or false if the loop was unmodified. Unrolling
 112 /// can only fail when the loop's latch block is not terminated by a conditional
 113 /// branch instruction. However, if the trip count (and multiple) are not known,
 114 /// loop unrolling will mostly produce more code that is no faster.
 115 ///
 116 /// TripCount is generally defined as the number of times the loop header
 117 /// executes. UnrollLoop relaxes the definition to permit early exits: here
 118 /// TripCount is the iteration on which control exits LatchBlock if no early
 119 /// exits were taken. Note that UnrollLoop assumes that the loop counter test
 120 /// terminates LatchBlock in order to remove unnecesssary instances of the
 121 /// test. In other words, control may exit the loop prior to TripCount
 122 /// iterations via an early branch, but control may not exit the loop from the
 123 /// LatchBlock's terminator prior to TripCount iterations.
 124 ///
 125 /// Similarly, TripMultiple divides the number of times that the LatchBlock may
 126 /// execute without exiting the loop.
 127 ///
 128 /// The LoopInfo Analysis that is passed will be kept consistent.
 129 ///
 130 /// If a LoopPassManager is passed in, and the loop is fully removed, it will be
 131 /// removed from the LoopPassManager as well. LPM can also be NULL.
 132 bool llvm::UnrollLoop(Loop *L, unsigned Count, unsigned TripCount,
 133                       unsigned TripMultiple, LoopInfo *LI, LPPassManager *LPM) {
 134   BasicBlock *Preheader = L->getLoopPreheader();
 135   if (!Preheader) {
 136     DEBUG(dbgs() << "  Can't unroll; loop preheader-insertion failed.\n");
 137     return false;
 138   }
 139
 140   BasicBlock *LatchBlock = L->getLoopLatch();
 141   if (!LatchBlock) {
 142     DEBUG(dbgs() << "  Can't unroll; loop exit-block-insertion failed.\n");
 143     return false;
 144   }
 145
 146   BasicBlock *Header = L->getHeader();
 147   BranchInst *BI = dyn_cast<BranchInst>(LatchBlock->getTerminator());
 148
 149   if (!BI || BI->isUnconditional()) {
 150     // The loop-rotate pass can be helpful to avoid this in many cases.
 151     DEBUG(dbgs() <<
 152              "  Can't unroll; loop not terminated by a conditional branch.\n");
 153     return false;
 154   }
 155
 156   if (Header->hasAddressTaken()) {
 157     // The loop-rotate pass can be helpful to avoid this in many cases.
 158     DEBUG(dbgs() <<
 159           "  Won't unroll loop: address of header block is taken.\n");
 160     return false;
 161   }
 162
 163   // Notify ScalarEvolution that the loop will be substantially changed,
 164   // if not outright eliminated.
 165   if (ScalarEvolution *SE = LPM->getAnalysisIfAvailable<ScalarEvolution>())
 166     SE->forgetLoop(L);
 167
 168   if (TripCount != 0)
 169     DEBUG(dbgs() << "  Trip Count = " << TripCount << "\n");
 170   if (TripMultiple != 1)
 171     DEBUG(dbgs() << "  Trip Multiple = " << TripMultiple << "\n");
 172
 173   // Effectively "DCE" unrolled iterations that are beyond the tripcount
 174   // and will never be executed.
 175   if (TripCount != 0 && Count > TripCount)
 176     Count = TripCount;
 177
 178   assert(Count > 0);
 179   assert(TripMultiple > 0);
 180   assert(TripCount == 0 || TripCount % TripMultiple == 0);
 181
 182   // Are we eliminating the loop control altogether?
 183   bool CompletelyUnroll = Count == TripCount;
 184
 185   // If we know the trip count, we know the multiple...
 186   unsigned BreakoutTrip = 0;
 187   if (TripCount != 0) {
 188     BreakoutTrip = TripCount % Count;
 189     TripMultiple = 0;
 190   } else {
 191     // Figure out what multiple to use.
 192     BreakoutTrip = TripMultiple =
 193       (unsigned)GreatestCommonDivisor64(Count, TripMultiple);
 194   }
 195
 196   if (CompletelyUnroll) {
 197     DEBUG(dbgs() << "COMPLETELY UNROLLING loop %" << Header->getName()
 198           << " with trip count " << TripCount << "!\n");
 199   } else {
 200     DEBUG(dbgs() << "UNROLLING loop %" << Header->getName()
 201           << " by " << Count);
 202     if (TripMultiple == 0 || BreakoutTrip != TripMultiple) {
 203       DEBUG(dbgs() << " with a breakout at trip " << BreakoutTrip);
 204     } else if (TripMultiple != 1) {
 205       DEBUG(dbgs() << " with " << TripMultiple << " trips per branch");
 206     }
 207     DEBUG(dbgs() << "!\n");
 208   }
 209
 210   std::vector<BasicBlock*> LoopBlocks = L->getBlocks();
 211
 212   bool ContinueOnTrue = L->contains(BI->getSuccessor(0));
 213   BasicBlock *LoopExit = BI->getSuccessor(ContinueOnTrue);
 214
 215   // For the first iteration of the loop, we should use the precloned values for
 216   // PHI nodes.  Insert associations now.
 217   ValueToValueMapTy LastValueMap;
 218   std::vector<PHINode*> OrigPHINode;
 219   for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
 220     OrigPHINode.push_back(cast<PHINode>(I));
 221   }
 222
 223   std::vector<BasicBlock*> Headers;
 224   std::vector<BasicBlock*> Latches;
 225   Headers.push_back(Header);
 226   Latches.push_back(LatchBlock);
 227
 228   for (unsigned It = 1; It != Count; ++It) {
 229     std::vector<BasicBlock*> NewBlocks;
 230
 231     for (std::vector<BasicBlock*>::iterator BB = LoopBlocks.begin(),
 232          E = LoopBlocks.end(); BB != E; ++BB) {
 233       ValueToValueMapTy VMap;
 234       BasicBlock *New = CloneBasicBlock(*BB, VMap, "." + Twine(It));
 235       Header->getParent()->getBasicBlockList().push_back(New);
 236
 237       // Loop over all of the PHI nodes in the block, changing them to use the
 238       // incoming values from the previous block.
 239       if (*BB == Header)
 240         for (unsigned i = 0, e = OrigPHINode.size(); i != e; ++i) {
 241           PHINode *NewPHI = cast<PHINode>(VMap[OrigPHINode[i]]);
 242           Value *InVal = NewPHI->getIncomingValueForBlock(LatchBlock);
 243           if (Instruction *InValI = dyn_cast<Instruction>(InVal))
 244             if (It > 1 && L->contains(InValI))
 245               InVal = LastValueMap[InValI];
 246           VMap[OrigPHINode[i]] = InVal;
 247           New->getInstList().erase(NewPHI);
 248         }
 249
 250       // Update our running map of newest clones
 251       LastValueMap[*BB] = New;
 252       for (ValueToValueMapTy::iterator VI = VMap.begin(), VE = VMap.end();
 253            VI != VE; ++VI)
 254         LastValueMap[VI->first] = VI->second;
 255
 256       L->addBasicBlockToLoop(New, LI->getBase());
 257
 258       // Add phi entries for newly created values to all exit blocks except
 259       // the successor of the latch block.  The successor of the exit block will
 260       // be updated specially after unrolling all the way.
 261       if (*BB != LatchBlock)
 262         for (succ_iterator SI = succ_begin(*BB), SE = succ_end(*BB); SI != SE;
 263              ++SI)
 264           if (!L->contains(*SI))
 265             for (BasicBlock::iterator BBI = (*SI)->begin();
 266                  PHINode *phi = dyn_cast<PHINode>(BBI); ++BBI) {
 267               Value *Incoming = phi->getIncomingValueForBlock(*BB);
 268               phi->addIncoming(Incoming, New);
 269             }
 270
 271       // Keep track of new headers and latches as we create them, so that
 272       // we can insert the proper branches later.
 273       if (*BB == Header)
 274         Headers.push_back(New);
 275       if (*BB == LatchBlock) {
 276         Latches.push_back(New);
 277
 278         // Also, clear out the new latch's back edge so that it doesn't look
 279         // like a new loop, so that it's amenable to being merged with adjacent
 280         // blocks later on.
 281         TerminatorInst *Term = New->getTerminator();
 282         assert(L->contains(Term->getSuccessor(!ContinueOnTrue)));
 283         assert(Term->getSuccessor(ContinueOnTrue) == LoopExit);
 284         Term->setSuccessor(!ContinueOnTrue, NULL);
 285       }
 286
 287       NewBlocks.push_back(New);
 288     }
 289
 290     // Remap all instructions in the most recent iteration
 291     for (unsigned i = 0; i < NewBlocks.size(); ++i)
 292       for (BasicBlock::iterator I = NewBlocks[i]->begin(),
 293            E = NewBlocks[i]->end(); I != E; ++I)
 294         ::RemapInstruction(I, LastValueMap);
 295   }
 296
 297   // The latch block exits the loop.  If there are any PHI nodes in the
 298   // successor blocks, update them to use the appropriate values computed as the
 299   // last iteration of the loop.
 300   if (Count != 1) {
 301     BasicBlock *LastIterationBB = cast<BasicBlock>(LastValueMap[LatchBlock]);
 302     for (succ_iterator SI = succ_begin(LatchBlock), SE = succ_end(LatchBlock);
 303          SI != SE; ++SI) {
 304       for (BasicBlock::iterator BBI = (*SI)->begin();
 305            PHINode *PN = dyn_cast<PHINode>(BBI); ++BBI) {
 306         Value *InVal = PN->removeIncomingValue(LatchBlock, false);
 307         // If this value was defined in the loop, take the value defined by the
 308         // last iteration of the loop.
 309         if (Instruction *InValI = dyn_cast<Instruction>(InVal)) {
 310           if (L->contains(InValI))
 311             InVal = LastValueMap[InVal];
 312         }
 313         PN->addIncoming(InVal, LastIterationBB);
 314       }
 315     }
 316   }
 317
 318   // Now, if we're doing complete unrolling, loop over the PHI nodes in the
 319   // original block, setting them to their incoming values.
 320   if (CompletelyUnroll) {
 321     BasicBlock *Preheader = L->getLoopPreheader();
 322     for (unsigned i = 0, e = OrigPHINode.size(); i != e; ++i) {
 323       PHINode *PN = OrigPHINode[i];
 324       PN->replaceAllUsesWith(PN->getIncomingValueForBlock(Preheader));
 325       Header->getInstList().erase(PN);
 326     }
 327   }
 328
 329   // Now that all the basic blocks for the unrolled iterations are in place,
 330   // set up the branches to connect them.
 331   for (unsigned i = 0, e = Latches.size(); i != e; ++i) {
 332     // The original branch was replicated in each unrolled iteration.
 333     BranchInst *Term = cast<BranchInst>(Latches[i]->getTerminator());
 334
 335     // The branch destination.
 336     unsigned j = (i + 1) % e;
 337     BasicBlock *Dest = Headers[j];
 338     bool NeedConditional = true;
 339
 340     // For a complete unroll, make the last iteration end with a branch
 341     // to the exit block.
 342     if (CompletelyUnroll && j == 0) {
 343       Dest = LoopExit;
 344       NeedConditional = false;
 345     }
 346
 347     // If we know the trip count or a multiple of it, we can safely use an
 348     // unconditional branch for some iterations.
 349     if (j != BreakoutTrip && (TripMultiple == 0 || j % TripMultiple != 0)) {
 350       NeedConditional = false;
 351     }
 352
 353     if (NeedConditional) {
 354       // Update the conditional branch's successor for the following
 355       // iteration.
 356       Term->setSuccessor(!ContinueOnTrue, Dest);
 357     } else {
 358       // Replace the conditional branch with an unconditional one.
 359       BranchInst::Create(Dest, Term);
 360       Term->eraseFromParent();
 361     }
 362   }
 363
 364   // Merge adjacent basic blocks, if possible.
 365   for (unsigned i = 0, e = Latches.size(); i != e; ++i) {
 366     BranchInst *Term = cast<BranchInst>(Latches[i]->getTerminator());
 367     if (Term->isUnconditional()) {
 368       BasicBlock *Dest = Term->getSuccessor(0);
 369       if (BasicBlock *Fold = FoldBlockIntoPredecessor(Dest, LI, LPM))
 370         std::replace(Latches.begin(), Latches.end(), Dest, Fold);
 371     }
 372   }
 373
 374   // At this point, the code is well formed.  We now do a quick sweep over the
 375   // inserted code, doing constant propagation and dead code elimination as we
 376   // go.
 377   const std::vector<BasicBlock*> &NewLoopBlocks = L->getBlocks();
 378   for (std::vector<BasicBlock*>::const_iterator BB = NewLoopBlocks.begin(),
 379        BBE = NewLoopBlocks.end(); BB != BBE; ++BB)
 380     for (BasicBlock::iterator I = (*BB)->begin(), E = (*BB)->end(); I != E; ) {
 381       Instruction *Inst = I++;
 382
 383       if (isInstructionTriviallyDead(Inst))
 384         (*BB)->getInstList().erase(Inst);
 385       else if (Value *V = SimplifyInstruction(Inst))
 386         if (LI->replacementPreservesLCSSAForm(Inst, V)) {
 387           Inst->replaceAllUsesWith(V);
 388           (*BB)->getInstList().erase(Inst);
 389         }
 390     }
 391
 392   NumCompletelyUnrolled += CompletelyUnroll;
 393   ++NumUnrolled;
 394   // Remove the loop from the LoopPassManager if it's completely removed.
 395   if (CompletelyUnroll && LPM != NULL)
 396     LPM->deleteLoopFromQueue(L);
 397
 398   return true;
 399 }