lib/Transforms/Scalar/CodeGenPrepare.cpp

   1 //===- CodeGenPrepare.cpp - Prepare a function for code generation --------===//
   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 pass munges the code in the input function to better prepare it for
  11 // SelectionDAG-based code generation. This works around limitations in it's
  12 // basic-block-at-a-time approach. It should eventually be removed.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "codegenprepare"
  17 #include "llvm/Transforms/Scalar.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Function.h"
  21 #include "llvm/InlineAsm.h"
  22 #include "llvm/Instructions.h"
  23 #include "llvm/IntrinsicInst.h"
  24 #include "llvm/Pass.h"
  25 #include "llvm/Analysis/ProfileInfo.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/Target/TargetLowering.h"
  28 #include "llvm/Transforms/Utils/AddrModeMatcher.h"
  29 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  30 #include "llvm/Transforms/Utils/Local.h"
  31 #include "llvm/ADT/DenseMap.h"
  32 #include "llvm/ADT/SmallSet.h"
  33 #include "llvm/Assembly/Writer.h"
  34 #include "llvm/Support/CallSite.h"
  35 #include "llvm/Support/CommandLine.h"
  36 #include "llvm/Support/Debug.h"
  37 #include "llvm/Support/GetElementPtrTypeIterator.h"
  38 #include "llvm/Support/PatternMatch.h"
  39 #include "llvm/Support/raw_ostream.h"
  40 using namespace llvm;
  41 using namespace llvm::PatternMatch;
  42
  43 static cl::opt<bool> FactorCommonPreds("split-critical-paths-tweak",
  44                                        cl::init(false), cl::Hidden);
  45
  46 namespace {
  47   class CodeGenPrepare : public FunctionPass {
  48     /// TLI - Keep a pointer of a TargetLowering to consult for determining
  49     /// transformation profitability.
  50     const TargetLowering *TLI;
  51     ProfileInfo *PFI;
  52
  53     /// BackEdges - Keep a set of all the loop back edges.
  54     ///
  55     SmallSet<std::pair<const BasicBlock*, const BasicBlock*>, 8> BackEdges;
  56   public:
  57     static char ID; // Pass identification, replacement for typeid
  58     explicit CodeGenPrepare(const TargetLowering *tli = 0)
  59       : FunctionPass(&ID), TLI(tli) {}
  60     bool runOnFunction(Function &F);
  61
  62     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  63       AU.addPreserved<ProfileInfo>();
  64     }
  65
  66     virtual void releaseMemory() {
  67       BackEdges.clear();
  68     }
  69
  70   private:
  71     bool EliminateMostlyEmptyBlocks(Function &F);
  72     bool CanMergeBlocks(const BasicBlock *BB, const BasicBlock *DestBB) const;
  73     void EliminateMostlyEmptyBlock(BasicBlock *BB);
  74     bool OptimizeBlock(BasicBlock &BB);
  75     bool OptimizeMemoryInst(Instruction *I, Value *Addr, const Type *AccessTy,
  76                             DenseMap<Value*,Value*> &SunkAddrs);
  77     bool OptimizeInlineAsmInst(Instruction *I, CallSite CS,
  78                                DenseMap<Value*,Value*> &SunkAddrs);
  79     bool MoveExtToFormExtLoad(Instruction *I);
  80     bool OptimizeExtUses(Instruction *I);
  81     void findLoopBackEdges(const Function &F);
  82   };
  83 }
  84
  85 char CodeGenPrepare::ID = 0;
  86 static RegisterPass<CodeGenPrepare> X("codegenprepare",
  87                                       "Optimize for code generation");
  88
  89 FunctionPass *llvm::createCodeGenPreparePass(const TargetLowering *TLI) {
  90   return new CodeGenPrepare(TLI);
  91 }
  92
  93 /// findLoopBackEdges - Do a DFS walk to find loop back edges.
  94 ///
  95 void CodeGenPrepare::findLoopBackEdges(const Function &F) {
  96   SmallVector<std::pair<const BasicBlock*,const BasicBlock*>, 32> Edges;
  97   FindFunctionBackedges(F, Edges);
  98
  99   BackEdges.insert(Edges.begin(), Edges.end());
 100 }
 101
 102
 103 bool CodeGenPrepare::runOnFunction(Function &F) {
 104   bool EverMadeChange = false;
 105
 106   PFI = getAnalysisIfAvailable<ProfileInfo>();
 107   // First pass, eliminate blocks that contain only PHI nodes and an
 108   // unconditional branch.
 109   EverMadeChange |= EliminateMostlyEmptyBlocks(F);
 110
 111   // Now find loop back edges.
 112   findLoopBackEdges(F);
 113
 114   bool MadeChange = true;
 115   while (MadeChange) {
 116     MadeChange = false;
 117     for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 118       MadeChange |= OptimizeBlock(*BB);
 119     EverMadeChange |= MadeChange;
 120   }
 121   return EverMadeChange;
 122 }
 123
 124 /// EliminateMostlyEmptyBlocks - eliminate blocks that contain only PHI nodes,
 125 /// debug info directives, and an unconditional branch.  Passes before isel
 126 /// (e.g. LSR/loopsimplify) often split edges in ways that are non-optimal for
 127 /// isel.  Start by eliminating these blocks so we can split them the way we
 128 /// want them.
 129 bool CodeGenPrepare::EliminateMostlyEmptyBlocks(Function &F) {
 130   bool MadeChange = false;
 131   // Note that this intentionally skips the entry block.
 132   for (Function::iterator I = ++F.begin(), E = F.end(); I != E; ) {
 133     BasicBlock *BB = I++;
 134
 135     // If this block doesn't end with an uncond branch, ignore it.
 136     BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator());
 137     if (!BI || !BI->isUnconditional())
 138       continue;
 139
 140     // If the instruction before the branch (skipping debug info) isn't a phi
 141     // node, then other stuff is happening here.
 142     BasicBlock::iterator BBI = BI;
 143     if (BBI != BB->begin()) {
 144       --BBI;
 145       while (isa<DbgInfoIntrinsic>(BBI)) {
 146         if (BBI == BB->begin())
 147           break;
 148         --BBI;
 149       }
 150       if (!isa<DbgInfoIntrinsic>(BBI) && !isa<PHINode>(BBI))
 151         continue;
 152     }
 153
 154     // Do not break infinite loops.
 155     BasicBlock *DestBB = BI->getSuccessor(0);
 156     if (DestBB == BB)
 157       continue;
 158
 159     if (!CanMergeBlocks(BB, DestBB))
 160       continue;
 161
 162     EliminateMostlyEmptyBlock(BB);
 163     MadeChange = true;
 164   }
 165   return MadeChange;
 166 }
 167
 168 /// CanMergeBlocks - Return true if we can merge BB into DestBB if there is a
 169 /// single uncond branch between them, and BB contains no other non-phi
 170 /// instructions.
 171 bool CodeGenPrepare::CanMergeBlocks(const BasicBlock *BB,
 172                                     const BasicBlock *DestBB) const {
 173   // We only want to eliminate blocks whose phi nodes are used by phi nodes in
 174   // the successor.  If there are more complex condition (e.g. preheaders),
 175   // don't mess around with them.
 176   BasicBlock::const_iterator BBI = BB->begin();
 177   while (const PHINode *PN = dyn_cast<PHINode>(BBI++)) {
 178     for (Value::use_const_iterator UI = PN->use_begin(), E = PN->use_end();
 179          UI != E; ++UI) {
 180       const Instruction *User = cast<Instruction>(*UI);
 181       if (User->getParent() != DestBB || !isa<PHINode>(User))
 182         return false;
 183       // If User is inside DestBB block and it is a PHINode then check
 184       // incoming value. If incoming value is not from BB then this is
 185       // a complex condition (e.g. preheaders) we want to avoid here.
 186       if (User->getParent() == DestBB) {
 187         if (const PHINode *UPN = dyn_cast<PHINode>(User))
 188           for (unsigned I = 0, E = UPN->getNumIncomingValues(); I != E; ++I) {
 189             Instruction *Insn = dyn_cast<Instruction>(UPN->getIncomingValue(I));
 190             if (Insn && Insn->getParent() == BB &&
 191                 Insn->getParent() != UPN->getIncomingBlock(I))
 192               return false;
 193           }
 194       }
 195     }
 196   }
 197
 198   // If BB and DestBB contain any common predecessors, then the phi nodes in BB
 199   // and DestBB may have conflicting incoming values for the block.  If so, we
 200   // can't merge the block.
 201   const PHINode *DestBBPN = dyn_cast<PHINode>(DestBB->begin());
 202   if (!DestBBPN) return true;  // no conflict.
 203
 204   // Collect the preds of BB.
 205   SmallPtrSet<const BasicBlock*, 16> BBPreds;
 206   if (const PHINode *BBPN = dyn_cast<PHINode>(BB->begin())) {
 207     // It is faster to get preds from a PHI than with pred_iterator.
 208     for (unsigned i = 0, e = BBPN->getNumIncomingValues(); i != e; ++i)
 209       BBPreds.insert(BBPN->getIncomingBlock(i));
 210   } else {
 211     BBPreds.insert(pred_begin(BB), pred_end(BB));
 212   }
 213
 214   // Walk the preds of DestBB.
 215   for (unsigned i = 0, e = DestBBPN->getNumIncomingValues(); i != e; ++i) {
 216     BasicBlock *Pred = DestBBPN->getIncomingBlock(i);
 217     if (BBPreds.count(Pred)) {   // Common predecessor?
 218       BBI = DestBB->begin();
 219       while (const PHINode *PN = dyn_cast<PHINode>(BBI++)) {
 220         const Value *V1 = PN->getIncomingValueForBlock(Pred);
 221         const Value *V2 = PN->getIncomingValueForBlock(BB);
 222
 223         // If V2 is a phi node in BB, look up what the mapped value will be.
 224         if (const PHINode *V2PN = dyn_cast<PHINode>(V2))
 225           if (V2PN->getParent() == BB)
 226             V2 = V2PN->getIncomingValueForBlock(Pred);
 227
 228         // If there is a conflict, bail out.
 229         if (V1 != V2) return false;
 230       }
 231     }
 232   }
 233
 234   return true;
 235 }
 236
 237
 238 /// EliminateMostlyEmptyBlock - Eliminate a basic block that have only phi's and
 239 /// an unconditional branch in it.
 240 void CodeGenPrepare::EliminateMostlyEmptyBlock(BasicBlock *BB) {
 241   BranchInst *BI = cast<BranchInst>(BB->getTerminator());
 242   BasicBlock *DestBB = BI->getSuccessor(0);
 243
 244   DEBUG(dbgs() << "MERGING MOSTLY EMPTY BLOCKS - BEFORE:\n" << *BB << *DestBB);
 245
 246   // If the destination block has a single pred, then this is a trivial edge,
 247   // just collapse it.
 248   if (BasicBlock *SinglePred = DestBB->getSinglePredecessor()) {
 249     if (SinglePred != DestBB) {
 250       // Remember if SinglePred was the entry block of the function.  If so, we
 251       // will need to move BB back to the entry position.
 252       bool isEntry = SinglePred == &SinglePred->getParent()->getEntryBlock();
 253       MergeBasicBlockIntoOnlyPred(DestBB, this);
 254
 255       if (isEntry && BB != &BB->getParent()->getEntryBlock())
 256         BB->moveBefore(&BB->getParent()->getEntryBlock());
 257
 258       DEBUG(dbgs() << "AFTER:\n" << *DestBB << "\n\n\n");
 259       return;
 260     }
 261   }
 262
 263   // Otherwise, we have multiple predecessors of BB.  Update the PHIs in DestBB
 264   // to handle the new incoming edges it is about to have.
 265   PHINode *PN;
 266   for (BasicBlock::iterator BBI = DestBB->begin();
 267        (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
 268     // Remove the incoming value for BB, and remember it.
 269     Value *InVal = PN->removeIncomingValue(BB, false);
 270
 271     // Two options: either the InVal is a phi node defined in BB or it is some
 272     // value that dominates BB.
 273     PHINode *InValPhi = dyn_cast<PHINode>(InVal);
 274     if (InValPhi && InValPhi->getParent() == BB) {
 275       // Add all of the input values of the input PHI as inputs of this phi.
 276       for (unsigned i = 0, e = InValPhi->getNumIncomingValues(); i != e; ++i)
 277         PN->addIncoming(InValPhi->getIncomingValue(i),
 278                         InValPhi->getIncomingBlock(i));
 279     } else {
 280       // Otherwise, add one instance of the dominating value for each edge that
 281       // we will be adding.
 282       if (PHINode *BBPN = dyn_cast<PHINode>(BB->begin())) {
 283         for (unsigned i = 0, e = BBPN->getNumIncomingValues(); i != e; ++i)
 284           PN->addIncoming(InVal, BBPN->getIncomingBlock(i));
 285       } else {
 286         for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
 287           PN->addIncoming(InVal, *PI);
 288       }
 289     }
 290   }
 291
 292   // The PHIs are now updated, change everything that refers to BB to use
 293   // DestBB and remove BB.
 294   BB->replaceAllUsesWith(DestBB);
 295   if (PFI) {
 296     PFI->replaceAllUses(BB, DestBB);
 297     PFI->removeEdge(ProfileInfo::getEdge(BB, DestBB));
 298   }
 299   BB->eraseFromParent();
 300
 301   DEBUG(dbgs() << "AFTER:\n" << *DestBB << "\n\n\n");
 302 }
 303
 304 /// FindReusablePredBB - Check all of the predecessors of the block DestPHI
 305 /// lives in to see if there is a block that we can reuse as a critical edge
 306 /// from TIBB.
 307 static BasicBlock *FindReusablePredBB(PHINode *DestPHI, BasicBlock *TIBB) {
 308   BasicBlock *Dest = DestPHI->getParent();
 309
 310   /// TIPHIValues - This array is lazily computed to determine the values of
 311   /// PHIs in Dest that TI would provide.
 312   SmallVector<Value*, 32> TIPHIValues;
 313
 314   /// TIBBEntryNo - This is a cache to speed up pred queries for TIBB.
 315   unsigned TIBBEntryNo = 0;
 316
 317   // Check to see if Dest has any blocks that can be used as a split edge for
 318   // this terminator.
 319   for (unsigned pi = 0, e = DestPHI->getNumIncomingValues(); pi != e; ++pi) {
 320     BasicBlock *Pred = DestPHI->getIncomingBlock(pi);
 321     // To be usable, the pred has to end with an uncond branch to the dest.
 322     BranchInst *PredBr = dyn_cast<BranchInst>(Pred->getTerminator());
 323     if (!PredBr || !PredBr->isUnconditional())
 324       continue;
 325     // Must be empty other than the branch and debug info.
 326     BasicBlock::iterator I = Pred->begin();
 327     while (isa<DbgInfoIntrinsic>(I))
 328       I++;
 329     if (&*I != PredBr)
 330       continue;
 331     // Cannot be the entry block; its label does not get emitted.
 332     if (Pred == &Dest->getParent()->getEntryBlock())
 333       continue;
 334
 335     // Finally, since we know that Dest has phi nodes in it, we have to make
 336     // sure that jumping to Pred will have the same effect as going to Dest in
 337     // terms of PHI values.
 338     PHINode *PN;
 339     unsigned PHINo = 0;
 340     unsigned PredEntryNo = pi;
 341
 342     bool FoundMatch = true;
 343     for (BasicBlock::iterator I = Dest->begin();
 344          (PN = dyn_cast<PHINode>(I)); ++I, ++PHINo) {
 345       if (PHINo == TIPHIValues.size()) {
 346         if (PN->getIncomingBlock(TIBBEntryNo) != TIBB)
 347           TIBBEntryNo = PN->getBasicBlockIndex(TIBB);
 348         TIPHIValues.push_back(PN->getIncomingValue(TIBBEntryNo));
 349       }
 350
 351       // If the PHI entry doesn't work, we can't use this pred.
 352       if (PN->getIncomingBlock(PredEntryNo) != Pred)
 353         PredEntryNo = PN->getBasicBlockIndex(Pred);
 354
 355       if (TIPHIValues[PHINo] != PN->getIncomingValue(PredEntryNo)) {
 356         FoundMatch = false;
 357         break;
 358       }
 359     }
 360
 361     // If we found a workable predecessor, change TI to branch to Succ.
 362     if (FoundMatch)
 363       return Pred;
 364   }
 365   return 0;
 366 }
 367
 368
 369 /// SplitEdgeNicely - Split the critical edge from TI to its specified
 370 /// successor if it will improve codegen.  We only do this if the successor has
 371 /// phi nodes (otherwise critical edges are ok).  If there is already another
 372 /// predecessor of the succ that is empty (and thus has no phi nodes), use it
 373 /// instead of introducing a new block.
 374 static void SplitEdgeNicely(TerminatorInst *TI, unsigned SuccNum,
 375                      SmallSet<std::pair<const BasicBlock*,
 376                                         const BasicBlock*>, 8> &BackEdges,
 377                              Pass *P) {
 378   BasicBlock *TIBB = TI->getParent();
 379   BasicBlock *Dest = TI->getSuccessor(SuccNum);
 380   assert(isa<PHINode>(Dest->begin()) &&
 381          "This should only be called if Dest has a PHI!");
 382   PHINode *DestPHI = cast<PHINode>(Dest->begin());
 383
 384   // Do not split edges to EH landing pads.
 385   if (InvokeInst *Invoke = dyn_cast<InvokeInst>(TI))
 386     if (Invoke->getSuccessor(1) == Dest)
 387       return;
 388
 389   // As a hack, never split backedges of loops.  Even though the copy for any
 390   // PHIs inserted on the backedge would be dead for exits from the loop, we
 391   // assume that the cost of *splitting* the backedge would be too high.
 392   if (BackEdges.count(std::make_pair(TIBB, Dest)))
 393     return;
 394
 395   if (!FactorCommonPreds) {
 396     if (BasicBlock *ReuseBB = FindReusablePredBB(DestPHI, TIBB)) {
 397       ProfileInfo *PFI = P->getAnalysisIfAvailable<ProfileInfo>();
 398       if (PFI)
 399         PFI->splitEdge(TIBB, Dest, ReuseBB);
 400       Dest->removePredecessor(TIBB);
 401       TI->setSuccessor(SuccNum, ReuseBB);
 402       return;
 403     }
 404
 405     SplitCriticalEdge(TI, SuccNum, P, true);
 406     return;
 407   }
 408
 409   PHINode *PN;
 410   SmallVector<Value*, 8> TIPHIValues;
 411   for (BasicBlock::iterator I = Dest->begin();
 412        (PN = dyn_cast<PHINode>(I)); ++I)
 413     TIPHIValues.push_back(PN->getIncomingValueForBlock(TIBB));
 414
 415   SmallVector<BasicBlock*, 8> IdenticalPreds;
 416
 417   for (unsigned pi = 0, e = DestPHI->getNumIncomingValues(); pi != e; ++pi) {
 418     BasicBlock *Pred = DestPHI->getIncomingBlock(pi);
 419     if (BackEdges.count(std::make_pair(Pred, Dest)))
 420       continue;
 421     if (Pred == TIBB) {
 422       IdenticalPreds.push_back(Pred);
 423       continue;
 424     }
 425     bool Identical = true;
 426     unsigned PHINo = 0;
 427     for (BasicBlock::iterator I = Dest->begin();
 428          (PN = dyn_cast<PHINode>(I)); ++I, ++PHINo)
 429       if (TIPHIValues[PHINo] != PN->getIncomingValueForBlock(Pred)) {
 430         Identical = false;
 431         break;
 432       }
 433     if (Identical)
 434       IdenticalPreds.push_back(Pred);
 435   }
 436
 437   assert(!IdenticalPreds.empty());
 438   SplitBlockPredecessors(Dest, &IdenticalPreds[0], IdenticalPreds.size(),
 439                          ".critedge", P);
 440 }
 441
 442
 443 /// OptimizeNoopCopyExpression - If the specified cast instruction is a noop
 444 /// copy (e.g. it's casting from one pointer type to another, i32->i8 on PPC),
 445 /// sink it into user blocks to reduce the number of virtual
 446 /// registers that must be created and coalesced.
 447 ///
 448 /// Return true if any changes are made.
 449 ///
 450 static bool OptimizeNoopCopyExpression(CastInst *CI, const TargetLowering &TLI){
 451   // If this is a noop copy,
 452   EVT SrcVT = TLI.getValueType(CI->getOperand(0)->getType());
 453   EVT DstVT = TLI.getValueType(CI->getType());
 454
 455   // This is an fp<->int conversion?
 456   if (SrcVT.isInteger() != DstVT.isInteger())
 457     return false;
 458
 459   // If this is an extension, it will be a zero or sign extension, which
 460   // isn't a noop.
 461   if (SrcVT.bitsLT(DstVT)) return false;
 462
 463   // If these values will be promoted, find out what they will be promoted
 464   // to.  This helps us consider truncates on PPC as noop copies when they
 465   // are.
 466   if (TLI.getTypeAction(CI->getContext(), SrcVT) == TargetLowering::Promote)
 467     SrcVT = TLI.getTypeToTransformTo(CI->getContext(), SrcVT);
 468   if (TLI.getTypeAction(CI->getContext(), DstVT) == TargetLowering::Promote)
 469     DstVT = TLI.getTypeToTransformTo(CI->getContext(), DstVT);
 470
 471   // If, after promotion, these are the same types, this is a noop copy.
 472   if (SrcVT != DstVT)
 473     return false;
 474
 475   BasicBlock *DefBB = CI->getParent();
 476
 477   /// InsertedCasts - Only insert a cast in each block once.
 478   DenseMap<BasicBlock*, CastInst*> InsertedCasts;
 479
 480   bool MadeChange = false;
 481   for (Value::use_iterator UI = CI->use_begin(), E = CI->use_end();
 482        UI != E; ) {
 483     Use &TheUse = UI.getUse();
 484     Instruction *User = cast<Instruction>(*UI);
 485
 486     // Figure out which BB this cast is used in.  For PHI's this is the
 487     // appropriate predecessor block.
 488     BasicBlock *UserBB = User->getParent();
 489     if (PHINode *PN = dyn_cast<PHINode>(User)) {
 490       UserBB = PN->getIncomingBlock(UI);
 491     }
 492
 493     // Preincrement use iterator so we don't invalidate it.
 494     ++UI;
 495
 496     // If this user is in the same block as the cast, don't change the cast.
 497     if (UserBB == DefBB) continue;
 498
 499     // If we have already inserted a cast into this block, use it.
 500     CastInst *&InsertedCast = InsertedCasts[UserBB];
 501
 502     if (!InsertedCast) {
 503       BasicBlock::iterator InsertPt = UserBB->getFirstNonPHI();
 504
 505       InsertedCast =
 506         CastInst::Create(CI->getOpcode(), CI->getOperand(0), CI->getType(), "",
 507                          InsertPt);
 508       MadeChange = true;
 509     }
 510
 511     // Replace a use of the cast with a use of the new cast.
 512     TheUse = InsertedCast;
 513   }
 514
 515   // If we removed all uses, nuke the cast.
 516   if (CI->use_empty()) {
 517     CI->eraseFromParent();
 518     MadeChange = true;
 519   }
 520
 521   return MadeChange;
 522 }
 523
 524 /// OptimizeCmpExpression - sink the given CmpInst into user blocks to reduce
 525 /// the number of virtual registers that must be created and coalesced.  This is
 526 /// a clear win except on targets with multiple condition code registers
 527 ///  (PowerPC), where it might lose; some adjustment may be wanted there.
 528 ///
 529 /// Return true if any changes are made.
 530 static bool OptimizeCmpExpression(CmpInst *CI) {
 531   BasicBlock *DefBB = CI->getParent();
 532
 533   /// InsertedCmp - Only insert a cmp in each block once.
 534   DenseMap<BasicBlock*, CmpInst*> InsertedCmps;
 535
 536   bool MadeChange = false;
 537   for (Value::use_iterator UI = CI->use_begin(), E = CI->use_end();
 538        UI != E; ) {
 539     Use &TheUse = UI.getUse();
 540     Instruction *User = cast<Instruction>(*UI);
 541
 542     // Preincrement use iterator so we don't invalidate it.
 543     ++UI;
 544
 545     // Don't bother for PHI nodes.
 546     if (isa<PHINode>(User))
 547       continue;
 548
 549     // Figure out which BB this cmp is used in.
 550     BasicBlock *UserBB = User->getParent();
 551
 552     // If this user is in the same block as the cmp, don't change the cmp.
 553     if (UserBB == DefBB) continue;
 554
 555     // If we have already inserted a cmp into this block, use it.
 556     CmpInst *&InsertedCmp = InsertedCmps[UserBB];
 557
 558     if (!InsertedCmp) {
 559       BasicBlock::iterator InsertPt = UserBB->getFirstNonPHI();
 560
 561       InsertedCmp =
 562         CmpInst::Create(CI->getOpcode(),
 563                         CI->getPredicate(),  CI->getOperand(0),
 564                         CI->getOperand(1), "", InsertPt);
 565       MadeChange = true;
 566     }
 567
 568     // Replace a use of the cmp with a use of the new cmp.
 569     TheUse = InsertedCmp;
 570   }
 571
 572   // If we removed all uses, nuke the cmp.
 573   if (CI->use_empty())
 574     CI->eraseFromParent();
 575
 576   return MadeChange;
 577 }
 578
 579 //===----------------------------------------------------------------------===//
 580 // Memory Optimization
 581 //===----------------------------------------------------------------------===//
 582
 583 /// IsNonLocalValue - Return true if the specified values are defined in a
 584 /// different basic block than BB.
 585 static bool IsNonLocalValue(Value *V, BasicBlock *BB) {
 586   if (Instruction *I = dyn_cast<Instruction>(V))
 587     return I->getParent() != BB;
 588   return false;
 589 }
 590
 591 /// OptimizeMemoryInst - Load and Store Instructions often have
 592 /// addressing modes that can do significant amounts of computation.  As such,
 593 /// instruction selection will try to get the load or store to do as much
 594 /// computation as possible for the program.  The problem is that isel can only
 595 /// see within a single block.  As such, we sink as much legal addressing mode
 596 /// stuff into the block as possible.
 597 ///
 598 /// This method is used to optimize both load/store and inline asms with memory
 599 /// operands.
 600 bool CodeGenPrepare::OptimizeMemoryInst(Instruction *MemoryInst, Value *Addr,
 601                                         const Type *AccessTy,
 602                                         DenseMap<Value*,Value*> &SunkAddrs) {
 603   // Figure out what addressing mode will be built up for this operation.
 604   SmallVector<Instruction*, 16> AddrModeInsts;
 605   ExtAddrMode AddrMode = AddressingModeMatcher::Match(Addr, AccessTy,MemoryInst,
 606                                                       AddrModeInsts, *TLI);
 607
 608   // Check to see if any of the instructions supersumed by this addr mode are
 609   // non-local to I's BB.
 610   bool AnyNonLocal = false;
 611   for (unsigned i = 0, e = AddrModeInsts.size(); i != e; ++i) {
 612     if (IsNonLocalValue(AddrModeInsts[i], MemoryInst->getParent())) {
 613       AnyNonLocal = true;
 614       break;
 615     }
 616   }
 617
 618   // If all the instructions matched are already in this BB, don't do anything.
 619   if (!AnyNonLocal) {
 620     DEBUG(dbgs() << "CGP: Found      local addrmode: " << AddrMode << "\n");
 621     return false;
 622   }
 623
 624   // Insert this computation right after this user.  Since our caller is
 625   // scanning from the top of the BB to the bottom, reuse of the expr are
 626   // guaranteed to happen later.
 627   BasicBlock::iterator InsertPt = MemoryInst;
 628
 629   // Now that we determined the addressing expression we want to use and know
 630   // that we have to sink it into this block.  Check to see if we have already
 631   // done this for some other load/store instr in this block.  If so, reuse the
 632   // computation.
 633   Value *&SunkAddr = SunkAddrs[Addr];
 634   if (SunkAddr) {
 635     DEBUG(dbgs() << "CGP: Reusing nonlocal addrmode: " << AddrMode << " for "
 636                  << *MemoryInst);
 637     if (SunkAddr->getType() != Addr->getType())
 638       SunkAddr = new BitCastInst(SunkAddr, Addr->getType(), "tmp", InsertPt);
 639   } else {
 640     DEBUG(dbgs() << "CGP: SINKING nonlocal addrmode: " << AddrMode << " for "
 641                  << *MemoryInst);
 642     const Type *IntPtrTy =
 643           TLI->getTargetData()->getIntPtrType(AccessTy->getContext());
 644
 645     Value *Result = 0;
 646
 647     // Start with the base register. Do this first so that subsequent address
 648     // matching finds it last, which will prevent it from trying to match it
 649     // as the scaled value in case it happens to be a mul. That would be
 650     // problematic if we've sunk a different mul for the scale, because then
 651     // we'd end up sinking both muls.
 652     if (AddrMode.BaseReg) {
 653       Value *V = AddrMode.BaseReg;
 654       if (isa<PointerType>(V->getType()))
 655         V = new PtrToIntInst(V, IntPtrTy, "sunkaddr", InsertPt);
 656       if (V->getType() != IntPtrTy)
 657         V = CastInst::CreateIntegerCast(V, IntPtrTy, /*isSigned=*/true,
 658                                         "sunkaddr", InsertPt);
 659       Result = V;
 660     }
 661
 662     // Add the scale value.
 663     if (AddrMode.Scale) {
 664       Value *V = AddrMode.ScaledReg;
 665       if (V->getType() == IntPtrTy) {
 666         // done.
 667       } else if (isa<PointerType>(V->getType())) {
 668         V = new PtrToIntInst(V, IntPtrTy, "sunkaddr", InsertPt);
 669       } else if (cast<IntegerType>(IntPtrTy)->getBitWidth() <
 670                  cast<IntegerType>(V->getType())->getBitWidth()) {
 671         V = new TruncInst(V, IntPtrTy, "sunkaddr", InsertPt);
 672       } else {
 673         V = new SExtInst(V, IntPtrTy, "sunkaddr", InsertPt);
 674       }
 675       if (AddrMode.Scale != 1)
 676         V = BinaryOperator::CreateMul(V, ConstantInt::get(IntPtrTy,
 677                                                                 AddrMode.Scale),
 678                                       "sunkaddr", InsertPt);
 679       if (Result)
 680         Result = BinaryOperator::CreateAdd(Result, V, "sunkaddr", InsertPt);
 681       else
 682         Result = V;
 683     }
 684
 685     // Add in the BaseGV if present.
 686     if (AddrMode.BaseGV) {
 687       Value *V = new PtrToIntInst(AddrMode.BaseGV, IntPtrTy, "sunkaddr",
 688                                   InsertPt);
 689       if (Result)
 690         Result = BinaryOperator::CreateAdd(Result, V, "sunkaddr", InsertPt);
 691       else
 692         Result = V;
 693     }
 694
 695     // Add in the Base Offset if present.
 696     if (AddrMode.BaseOffs) {
 697       Value *V = ConstantInt::get(IntPtrTy, AddrMode.BaseOffs);
 698       if (Result)
 699         Result = BinaryOperator::CreateAdd(Result, V, "sunkaddr", InsertPt);
 700       else
 701         Result = V;
 702     }
 703
 704     if (Result == 0)
 705       SunkAddr = Constant::getNullValue(Addr->getType());
 706     else
 707       SunkAddr = new IntToPtrInst(Result, Addr->getType(), "sunkaddr",InsertPt);
 708   }
 709
 710   MemoryInst->replaceUsesOfWith(Addr, SunkAddr);
 711
 712   if (Addr->use_empty())
 713     RecursivelyDeleteTriviallyDeadInstructions(Addr);
 714   return true;
 715 }
 716
 717 /// OptimizeInlineAsmInst - If there are any memory operands, use
 718 /// OptimizeMemoryInst to sink their address computing into the block when
 719 /// possible / profitable.
 720 bool CodeGenPrepare::OptimizeInlineAsmInst(Instruction *I, CallSite CS,
 721                                            DenseMap<Value*,Value*> &SunkAddrs) {
 722   bool MadeChange = false;
 723   InlineAsm *IA = cast<InlineAsm>(CS.getCalledValue());
 724
 725   // Do a prepass over the constraints, canonicalizing them, and building up the
 726   // ConstraintOperands list.
 727   std::vector<InlineAsm::ConstraintInfo>
 728     ConstraintInfos = IA->ParseConstraints();
 729
 730   /// ConstraintOperands - Information about all of the constraints.
 731   std::vector<TargetLowering::AsmOperandInfo> ConstraintOperands;
 732   unsigned ArgNo = 0;   // ArgNo - The argument of the CallInst.
 733   for (unsigned i = 0, e = ConstraintInfos.size(); i != e; ++i) {
 734     ConstraintOperands.
 735       push_back(TargetLowering::AsmOperandInfo(ConstraintInfos[i]));
 736     TargetLowering::AsmOperandInfo &OpInfo = ConstraintOperands.back();
 737
 738     // Compute the value type for each operand.
 739     switch (OpInfo.Type) {
 740     case InlineAsm::isOutput:
 741       if (OpInfo.isIndirect)
 742         OpInfo.CallOperandVal = CS.getArgument(ArgNo++);
 743       break;
 744     case InlineAsm::isInput:
 745       OpInfo.CallOperandVal = CS.getArgument(ArgNo++);
 746       break;
 747     case InlineAsm::isClobber:
 748       // Nothing to do.
 749       break;
 750     }
 751
 752     // Compute the constraint code and ConstraintType to use.
 753     TLI->ComputeConstraintToUse(OpInfo, SDValue(),
 754                              OpInfo.ConstraintType == TargetLowering::C_Memory);
 755
 756     if (OpInfo.ConstraintType == TargetLowering::C_Memory &&
 757         OpInfo.isIndirect) {
 758       Value *OpVal = OpInfo.CallOperandVal;
 759       MadeChange |= OptimizeMemoryInst(I, OpVal, OpVal->getType(), SunkAddrs);
 760     }
 761   }
 762
 763   return MadeChange;
 764 }
 765
 766 /// MoveExtToFormExtLoad - Move a zext or sext fed by a load into the same
 767 /// basic block as the load, unless conditions are unfavorable. This allows
 768 /// SelectionDAG to fold the extend into the load.
 769 ///
 770 bool CodeGenPrepare::MoveExtToFormExtLoad(Instruction *I) {
 771   // Look for a load being extended.
 772   LoadInst *LI = dyn_cast<LoadInst>(I->getOperand(0));
 773   if (!LI) return false;
 774
 775   // If they're already in the same block, there's nothing to do.
 776   if (LI->getParent() == I->getParent())
 777     return false;
 778
 779   // If the load has other users and the truncate is not free, this probably
 780   // isn't worthwhile.
 781   if (!LI->hasOneUse() &&
 782       TLI && !TLI->isTruncateFree(I->getType(), LI->getType()))
 783     return false;
 784
 785   // Check whether the target supports casts folded into loads.
 786   unsigned LType;
 787   if (isa<ZExtInst>(I))
 788     LType = ISD::ZEXTLOAD;
 789   else {
 790     assert(isa<SExtInst>(I) && "Unexpected ext type!");
 791     LType = ISD::SEXTLOAD;
 792   }
 793   if (TLI && !TLI->isLoadExtLegal(LType, TLI->getValueType(LI->getType())))
 794     return false;
 795
 796   // Move the extend into the same block as the load, so that SelectionDAG
 797   // can fold it.
 798   I->removeFromParent();
 799   I->insertAfter(LI);
 800   return true;
 801 }
 802
 803 bool CodeGenPrepare::OptimizeExtUses(Instruction *I) {
 804   BasicBlock *DefBB = I->getParent();
 805
 806   // If both result of the {s|z}xt and its source are live out, rewrite all
 807   // other uses of the source with result of extension.
 808   Value *Src = I->getOperand(0);
 809   if (Src->hasOneUse())
 810     return false;
 811
 812   // Only do this xform if truncating is free.
 813   if (TLI && !TLI->isTruncateFree(I->getType(), Src->getType()))
 814     return false;
 815
 816   // Only safe to perform the optimization if the source is also defined in
 817   // this block.
 818   if (!isa<Instruction>(Src) || DefBB != cast<Instruction>(Src)->getParent())
 819     return false;
 820
 821   bool DefIsLiveOut = false;
 822   for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
 823        UI != E; ++UI) {
 824     Instruction *User = cast<Instruction>(*UI);
 825
 826     // Figure out which BB this ext is used in.
 827     BasicBlock *UserBB = User->getParent();
 828     if (UserBB == DefBB) continue;
 829     DefIsLiveOut = true;
 830     break;
 831   }
 832   if (!DefIsLiveOut)
 833     return false;
 834
 835   // Make sure non of the uses are PHI nodes.
 836   for (Value::use_iterator UI = Src->use_begin(), E = Src->use_end();
 837        UI != E; ++UI) {
 838     Instruction *User = cast<Instruction>(*UI);
 839     BasicBlock *UserBB = User->getParent();
 840     if (UserBB == DefBB) continue;
 841     // Be conservative. We don't want this xform to end up introducing
 842     // reloads just before load / store instructions.
 843     if (isa<PHINode>(User) || isa<LoadInst>(User) || isa<StoreInst>(User))
 844       return false;
 845   }
 846
 847   // InsertedTruncs - Only insert one trunc in each block once.
 848   DenseMap<BasicBlock*, Instruction*> InsertedTruncs;
 849
 850   bool MadeChange = false;
 851   for (Value::use_iterator UI = Src->use_begin(), E = Src->use_end();
 852        UI != E; ++UI) {
 853     Use &TheUse = UI.getUse();
 854     Instruction *User = cast<Instruction>(*UI);
 855
 856     // Figure out which BB this ext is used in.
 857     BasicBlock *UserBB = User->getParent();
 858     if (UserBB == DefBB) continue;
 859
 860     // Both src and def are live in this block. Rewrite the use.
 861     Instruction *&InsertedTrunc = InsertedTruncs[UserBB];
 862
 863     if (!InsertedTrunc) {
 864       BasicBlock::iterator InsertPt = UserBB->getFirstNonPHI();
 865
 866       InsertedTrunc = new TruncInst(I, Src->getType(), "", InsertPt);
 867     }
 868
 869     // Replace a use of the {s|z}ext source with a use of the result.
 870     TheUse = InsertedTrunc;
 871
 872     MadeChange = true;
 873   }
 874
 875   return MadeChange;
 876 }
 877
 878 // In this pass we look for GEP and cast instructions that are used
 879 // across basic blocks and rewrite them to improve basic-block-at-a-time
 880 // selection.
 881 bool CodeGenPrepare::OptimizeBlock(BasicBlock &BB) {
 882   bool MadeChange = false;
 883
 884   // Split all critical edges where the dest block has a PHI.
 885   TerminatorInst *BBTI = BB.getTerminator();
 886   if (BBTI->getNumSuccessors() > 1 && !isa<IndirectBrInst>(BBTI)) {
 887     for (unsigned i = 0, e = BBTI->getNumSuccessors(); i != e; ++i) {
 888       BasicBlock *SuccBB = BBTI->getSuccessor(i);
 889       if (isa<PHINode>(SuccBB->begin()) && isCriticalEdge(BBTI, i, true))
 890         SplitEdgeNicely(BBTI, i, BackEdges, this);
 891     }
 892   }
 893
 894   // Keep track of non-local addresses that have been sunk into this block.
 895   // This allows us to avoid inserting duplicate code for blocks with multiple
 896   // load/stores of the same address.
 897   DenseMap<Value*, Value*> SunkAddrs;
 898
 899   for (BasicBlock::iterator BBI = BB.begin(), E = BB.end(); BBI != E; ) {
 900     Instruction *I = BBI++;
 901
 902     if (CastInst *CI = dyn_cast<CastInst>(I)) {
 903       // If the source of the cast is a constant, then this should have
 904       // already been constant folded.  The only reason NOT to constant fold
 905       // it is if something (e.g. LSR) was careful to place the constant
 906       // evaluation in a block other than then one that uses it (e.g. to hoist
 907       // the address of globals out of a loop).  If this is the case, we don't
 908       // want to forward-subst the cast.
 909       if (isa<Constant>(CI->getOperand(0)))
 910         continue;
 911
 912       bool Change = false;
 913       if (TLI) {
 914         Change = OptimizeNoopCopyExpression(CI, *TLI);
 915         MadeChange |= Change;
 916       }
 917
 918       if (!Change && (isa<ZExtInst>(I) || isa<SExtInst>(I))) {
 919         MadeChange |= MoveExtToFormExtLoad(I);
 920         MadeChange |= OptimizeExtUses(I);
 921       }
 922     } else if (CmpInst *CI = dyn_cast<CmpInst>(I)) {
 923       MadeChange |= OptimizeCmpExpression(CI);
 924     } else if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
 925       if (TLI)
 926         MadeChange |= OptimizeMemoryInst(I, I->getOperand(0), LI->getType(),
 927                                          SunkAddrs);
 928     } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
 929       if (TLI)
 930         MadeChange |= OptimizeMemoryInst(I, SI->getOperand(1),
 931                                          SI->getOperand(0)->getType(),
 932                                          SunkAddrs);
 933     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
 934       if (GEPI->hasAllZeroIndices()) {
 935         /// The GEP operand must be a pointer, so must its result -> BitCast
 936         Instruction *NC = new BitCastInst(GEPI->getOperand(0), GEPI->getType(),
 937                                           GEPI->getName(), GEPI);
 938         GEPI->replaceAllUsesWith(NC);
 939         GEPI->eraseFromParent();
 940         MadeChange = true;
 941         BBI = NC;
 942       }
 943     } else if (CallInst *CI = dyn_cast<CallInst>(I)) {
 944       // If we found an inline asm expession, and if the target knows how to
 945       // lower it to normal LLVM code, do so now.
 946       if (TLI && isa<InlineAsm>(CI->getCalledValue())) {
 947         if (TLI->ExpandInlineAsm(CI)) {
 948           BBI = BB.begin();
 949           // Avoid processing instructions out of order, which could cause
 950           // reuse before a value is defined.
 951           SunkAddrs.clear();
 952         } else
 953           // Sink address computing for memory operands into the block.
 954           MadeChange |= OptimizeInlineAsmInst(I, &(*CI), SunkAddrs);
 955       }
 956     }
 957   }
 958
 959   return MadeChange;
 960 }