lib/Transforms/Scalar/LoopUnroll.cpp

   1 //===-- LoopUnroll.cpp - Loop unroller pass -------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This pass implements a simple loop unroller.  It works best when loops have
  11 // been canonicalized by the -indvars pass, allowing it to determine the trip
  12 // counts of loops easily.
  13 //
  14 // This pass will multi-block loops only if they contain no non-unrolled
  15 // subloops.  The process of unrolling can produce extraneous basic blocks
  16 // linked with unconditional branches.  This will be corrected in the future.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #define DEBUG_TYPE "loop-unroll"
  21 #include "llvm/Transforms/Scalar.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/Function.h"
  24 #include "llvm/Instructions.h"
  25 #include "llvm/Analysis/ConstantFolding.h"
  26 #include "llvm/Analysis/LoopInfo.h"
  27 #include "llvm/Transforms/Utils/Cloning.h"
  28 #include "llvm/Transforms/Utils/Local.h"
  29 #include "llvm/Support/CFG.h"
  30 #include "llvm/Support/CommandLine.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/ADT/Statistic.h"
  33 #include "llvm/ADT/STLExtras.h"
  34 #include "llvm/IntrinsicInst.h"
  35 #include <cstdio>
  36 #include <set>
  37 #include <algorithm>
  38 using namespace llvm;
  39
  40 STATISTIC(NumUnrolled, "Number of loops completely unrolled");
  41
  42 namespace {
  43   cl::opt<unsigned>
  44   UnrollThreshold("unroll-threshold", cl::init(100), cl::Hidden,
  45                   cl::desc("The cut-off point for loop unrolling"));
  46
  47   class LoopUnroll : public FunctionPass {
  48     LoopInfo *LI;  // The current loop information
  49   public:
  50     virtual bool runOnFunction(Function &F);
  51     bool visitLoop(Loop *L);
  52     BasicBlock* FoldBlockIntoPredecessor(BasicBlock* BB);
  53
  54     /// This transformation requires natural loop information & requires that
  55     /// loop preheaders be inserted into the CFG...
  56     ///
  57     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  58       AU.addRequiredID(LoopSimplifyID);
  59       AU.addRequiredID(LCSSAID);
  60       AU.addRequired<LoopInfo>();
  61       AU.addPreservedID(LCSSAID);
  62       AU.addPreserved<LoopInfo>();
  63     }
  64   };
  65   RegisterPass<LoopUnroll> X("loop-unroll", "Unroll loops");
  66 }
  67
  68 FunctionPass *llvm::createLoopUnrollPass() { return new LoopUnroll(); }
  69
  70 bool LoopUnroll::runOnFunction(Function &F) {
  71   bool Changed = false;
  72   LI = &getAnalysis<LoopInfo>();
  73
  74   // Transform all the top-level loops.  Copy the loop list so that the child
  75   // can update the loop tree if it needs to delete the loop.
  76   std::vector<Loop*> SubLoops(LI->begin(), LI->end());
  77   for (unsigned i = 0, e = SubLoops.size(); i != e; ++i)
  78     Changed |= visitLoop(SubLoops[i]);
  79
  80   return Changed;
  81 }
  82
  83 /// ApproximateLoopSize - Approximate the size of the loop after it has been
  84 /// unrolled.
  85 static unsigned ApproximateLoopSize(const Loop *L) {
  86   unsigned Size = 0;
  87   for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i) {
  88     BasicBlock *BB = L->getBlocks()[i];
  89     Instruction *Term = BB->getTerminator();
  90     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
  91       if (isa<PHINode>(I) && BB == L->getHeader()) {
  92         // Ignore PHI nodes in the header.
  93       } else if (I->hasOneUse() && I->use_back() == Term) {
  94         // Ignore instructions only used by the loop terminator.
  95       } else if (isa<DbgInfoIntrinsic>(I)) {
  96         // Ignore debug instructions
  97       } else {
  98         ++Size;
  99       }
 100
 101       // TODO: Ignore expressions derived from PHI and constants if inval of phi
 102       // is a constant, or if operation is associative.  This will get induction
 103       // variables.
 104     }
 105   }
 106
 107   return Size;
 108 }
 109
 110 // RemapInstruction - Convert the instruction operands from referencing the
 111 // current values into those specified by ValueMap.
 112 //
 113 static inline void RemapInstruction(Instruction *I,
 114                                     std::map<const Value *, Value*> &ValueMap) {
 115   for (unsigned op = 0, E = I->getNumOperands(); op != E; ++op) {
 116     Value *Op = I->getOperand(op);
 117     std::map<const Value *, Value*>::iterator It = ValueMap.find(Op);
 118     if (It != ValueMap.end()) Op = It->second;
 119     I->setOperand(op, Op);
 120   }
 121 }
 122
 123 // FoldBlockIntoPredecessor - Folds a basic block into its predecessor if it
 124 // only has one predecessor, and that predecessor only has one successor.
 125 // Returns the new combined block.
 126 BasicBlock* LoopUnroll::FoldBlockIntoPredecessor(BasicBlock* BB) {
 127   // Merge basic blocks into their predecessor if there is only one distinct
 128   // pred, and if there is only one distinct successor of the predecessor, and
 129   // if there are no PHI nodes.
 130   //
 131   BasicBlock *OnlyPred = BB->getSinglePredecessor();
 132   if (!OnlyPred) return 0;
 133
 134   if (OnlyPred->getTerminator()->getNumSuccessors() != 1)
 135     return 0;
 136
 137   DOUT << "Merging: " << *BB << "into: " << *OnlyPred;
 138
 139   // Resolve any PHI nodes at the start of the block.  They are all
 140   // guaranteed to have exactly one entry if they exist, unless there are
 141   // multiple duplicate (but guaranteed to be equal) entries for the
 142   // incoming edges.  This occurs when there are multiple edges from
 143   // OnlyPred to OnlySucc.
 144   //
 145   while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) {
 146     PN->replaceAllUsesWith(PN->getIncomingValue(0));
 147     BB->getInstList().pop_front();  // Delete the phi node...
 148   }
 149
 150   // Delete the unconditional branch from the predecessor...
 151   OnlyPred->getInstList().pop_back();
 152
 153   // Move all definitions in the successor to the predecessor...
 154   OnlyPred->getInstList().splice(OnlyPred->end(), BB->getInstList());
 155
 156   // Make all PHI nodes that referred to BB now refer to Pred as their
 157   // source...
 158   BB->replaceAllUsesWith(OnlyPred);
 159
 160   std::string OldName = BB->getName();
 161
 162   // Erase basic block from the function...
 163   LI->removeBlock(BB);
 164   BB->eraseFromParent();
 165
 166   // Inherit predecessors name if it exists...
 167   if (!OldName.empty() && !OnlyPred->hasName())
 168     OnlyPred->setName(OldName);
 169
 170   return OnlyPred;
 171 }
 172
 173 bool LoopUnroll::visitLoop(Loop *L) {
 174   bool Changed = false;
 175
 176   // Recurse through all subloops before we process this loop.  Copy the loop
 177   // list so that the child can update the loop tree if it needs to delete the
 178   // loop.
 179   std::vector<Loop*> SubLoops(L->begin(), L->end());
 180   for (unsigned i = 0, e = SubLoops.size(); i != e; ++i)
 181     Changed |= visitLoop(SubLoops[i]);
 182
 183   BasicBlock* Header = L->getHeader();
 184   BasicBlock* LatchBlock = L->getLoopLatch();
 185
 186   BranchInst *BI = dyn_cast<BranchInst>(LatchBlock->getTerminator());
 187   if (BI == 0) return Changed;  // Must end in a conditional branch
 188
 189   ConstantInt *TripCountC = dyn_cast_or_null<ConstantInt>(L->getTripCount());
 190   if (!TripCountC) return Changed;  // Must have constant trip count!
 191
 192   uint64_t TripCountFull = TripCountC->getZExtValue();
 193   if (TripCountFull != TripCountC->getZExtValue() || TripCountFull == 0)
 194     return Changed; // More than 2^32 iterations???
 195
 196   unsigned LoopSize = ApproximateLoopSize(L);
 197   DOUT << "Loop Unroll: F[" << Header->getParent()->getName()
 198        << "] Loop %" << Header->getName() << " Loop Size = "
 199        << LoopSize << " Trip Count = " << TripCountFull << " - ";
 200   uint64_t Size = (uint64_t)LoopSize*TripCountFull;
 201   if (Size > UnrollThreshold) {
 202     DOUT << "TOO LARGE: " << Size << ">" << UnrollThreshold << "\n";
 203     return Changed;
 204   }
 205   DOUT << "UNROLLING!\n";
 206
 207   std::vector<BasicBlock*> LoopBlocks = L->getBlocks();
 208
 209   unsigned TripCount = (unsigned)TripCountFull;
 210
 211   BasicBlock *LoopExit = BI->getSuccessor(L->contains(BI->getSuccessor(0)));
 212
 213   // For the first iteration of the loop, we should use the precloned values for
 214   // PHI nodes.  Insert associations now.
 215   std::map<const Value*, Value*> LastValueMap;
 216   std::vector<PHINode*> OrigPHINode;
 217   for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
 218     PHINode *PN = cast<PHINode>(I);
 219     OrigPHINode.push_back(PN);
 220     if (Instruction *I =
 221                 dyn_cast<Instruction>(PN->getIncomingValueForBlock(LatchBlock)))
 222       if (L->contains(I->getParent()))
 223         LastValueMap[I] = I;
 224   }
 225
 226   // Remove the exit branch from the loop
 227   LatchBlock->getInstList().erase(BI);
 228
 229   std::vector<BasicBlock*> Headers;
 230   std::vector<BasicBlock*> Latches;
 231   Headers.push_back(Header);
 232   Latches.push_back(LatchBlock);
 233
 234   assert(TripCount != 0 && "Trip count of 0 is impossible!");
 235   for (unsigned It = 1; It != TripCount; ++It) {
 236     char SuffixBuffer[100];
 237     sprintf(SuffixBuffer, ".%d", It);
 238
 239     std::vector<BasicBlock*> NewBlocks;
 240
 241     for (std::vector<BasicBlock*>::iterator BB = LoopBlocks.begin(),
 242          E = LoopBlocks.end(); BB != E; ++BB) {
 243       std::map<const Value*, Value*> ValueMap;
 244       BasicBlock *New = CloneBasicBlock(*BB, ValueMap, SuffixBuffer);
 245       Header->getParent()->getBasicBlockList().push_back(New);
 246
 247       // Loop over all of the PHI nodes in the block, changing them to use the
 248       // incoming values from the previous block.
 249       if (*BB == Header)
 250         for (unsigned i = 0, e = OrigPHINode.size(); i != e; ++i) {
 251           PHINode *NewPHI = cast<PHINode>(ValueMap[OrigPHINode[i]]);
 252           Value *InVal = NewPHI->getIncomingValueForBlock(LatchBlock);
 253           if (Instruction *InValI = dyn_cast<Instruction>(InVal))
 254             if (It > 1 && L->contains(InValI->getParent()))
 255               InVal = LastValueMap[InValI];
 256           ValueMap[OrigPHINode[i]] = InVal;
 257           New->getInstList().erase(NewPHI);
 258         }
 259
 260       // Update our running map of newest clones
 261       LastValueMap[*BB] = New;
 262       for (std::map<const Value*, Value*>::iterator VI = ValueMap.begin(),
 263            VE = ValueMap.end(); VI != VE; ++VI)
 264         LastValueMap[VI->first] = VI->second;
 265
 266       L->addBasicBlockToLoop(New, *LI);
 267
 268       // Add phi entries for newly created values to all exit blocks except
 269       // the successor of the latch block.  The successor of the exit block will
 270       // be updated specially after unrolling all the way.
 271       if (*BB != LatchBlock)
 272         for (Value::use_iterator UI = (*BB)->use_begin(), UE = (*BB)->use_end();
 273              UI != UE; ++UI) {
 274           Instruction* UseInst = cast<Instruction>(*UI);
 275           if (isa<PHINode>(UseInst) && !L->contains(UseInst->getParent())) {
 276             PHINode* phi = cast<PHINode>(UseInst);
 277             Value* Incoming = phi->getIncomingValueForBlock(*BB);
 278             if (isa<Instruction>(Incoming))
 279               Incoming = LastValueMap[Incoming];
 280
 281             phi->addIncoming(Incoming, New);
 282           }
 283         }
 284
 285       // Keep track of new headers and latches as we create them, so that
 286       // we can insert the proper branches later.
 287       if (*BB == Header)
 288         Headers.push_back(New);
 289       if (*BB == LatchBlock)
 290         Latches.push_back(New);
 291
 292       NewBlocks.push_back(New);
 293     }
 294
 295     // Remap all instructions in the most recent iteration
 296     for (unsigned i = 0; i < NewBlocks.size(); ++i)
 297       for (BasicBlock::iterator I = NewBlocks[i]->begin(),
 298            E = NewBlocks[i]->end(); I != E; ++I)
 299         RemapInstruction(I, LastValueMap);
 300   }
 301
 302
 303
 304   // Update PHI nodes that reference the final latch block
 305   if (TripCount > 1) {
 306     std::set<PHINode*> Users;
 307     for (Value::use_iterator UI = LatchBlock->use_begin(),
 308          UE = LatchBlock->use_end(); UI != UE; ++UI)
 309       if (PHINode* phi = dyn_cast<PHINode>(*UI))
 310         Users.insert(phi);
 311
 312     for (std::set<PHINode*>::iterator SI = Users.begin(), SE = Users.end();
 313          SI != SE; ++SI) {
 314       Value* InVal = (*SI)->getIncomingValueForBlock(LatchBlock);
 315       if (isa<Instruction>(InVal))
 316         InVal = LastValueMap[InVal];
 317       (*SI)->removeIncomingValue(LatchBlock, false);
 318       if (InVal)
 319         (*SI)->addIncoming(InVal, cast<BasicBlock>(LastValueMap[LatchBlock]));
 320     }
 321   }
 322
 323   // Now loop over the PHI nodes in the original block, setting them to their
 324   // incoming values.
 325   BasicBlock *Preheader = L->getLoopPreheader();
 326   for (unsigned i = 0, e = OrigPHINode.size(); i != e; ++i) {
 327     PHINode *PN = OrigPHINode[i];
 328     PN->replaceAllUsesWith(PN->getIncomingValueForBlock(Preheader));
 329     Header->getInstList().erase(PN);
 330   }
 331
 332   //  Insert the branches that link the different iterations together
 333   for (unsigned i = 0; i < Latches.size()-1; ++i) {
 334     new BranchInst(Headers[i+1], Latches[i]);
 335     if(BasicBlock* Fold = FoldBlockIntoPredecessor(Headers[i+1])) {
 336       std::replace(Latches.begin(), Latches.end(), Headers[i+1], Fold);
 337       std::replace(Headers.begin(), Headers.end(), Headers[i+1], Fold);
 338     }
 339   }
 340
 341   // Finally, add an unconditional branch to the block to continue into the exit
 342   // block.
 343   new BranchInst(LoopExit, Latches[Latches.size()-1]);
 344   FoldBlockIntoPredecessor(LoopExit);
 345
 346   // At this point, the code is well formed.  We now do a quick sweep over the
 347   // inserted code, doing constant propagation and dead code elimination as we
 348   // go.
 349   const std::vector<BasicBlock*> &NewLoopBlocks = L->getBlocks();
 350   for (std::vector<BasicBlock*>::const_iterator BB = NewLoopBlocks.begin(),
 351        BBE = NewLoopBlocks.end(); BB != BBE; ++BB)
 352     for (BasicBlock::iterator I = (*BB)->begin(), E = (*BB)->end(); I != E; ) {
 353       Instruction *Inst = I++;
 354
 355       if (isInstructionTriviallyDead(Inst))
 356         (*BB)->getInstList().erase(Inst);
 357       else if (Constant *C = ConstantFoldInstruction(Inst)) {
 358         Inst->replaceAllUsesWith(C);
 359         (*BB)->getInstList().erase(Inst);
 360       }
 361     }
 362
 363   // Update the loop information for this loop.
 364   Loop *Parent = L->getParentLoop();
 365
 366   // Move all of the basic blocks in the loop into the parent loop.
 367   for (std::vector<BasicBlock*>::const_iterator BB = NewLoopBlocks.begin(),
 368        E = NewLoopBlocks.end(); BB != E; ++BB)
 369     LI->changeLoopFor(*BB, Parent);
 370
 371   // Remove the loop from the parent.
 372   if (Parent)
 373     delete Parent->removeChildLoop(std::find(Parent->begin(), Parent->end(),L));
 374   else
 375     delete LI->removeLoop(std::find(LI->begin(), LI->end(), L));
 376
 377   ++NumUnrolled;
 378   return true;
 379 }