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/ADT/DenseMap.h"
  19 #include "llvm/ADT/SmallSet.h"
  20 #include "llvm/ADT/Statistic.h"
  21 #include "llvm/ADT/ValueMap.h"
  22 #include "llvm/Analysis/InstructionSimplify.h"
  23 #include "llvm/IR/Constants.h"
  24 #include "llvm/IR/DataLayout.h"
  25 #include "llvm/IR/DerivedTypes.h"
  26 #include "llvm/IR/Dominators.h"
  27 #include "llvm/IR/Function.h"
  28 #include "llvm/IR/IRBuilder.h"
  29 #include "llvm/IR/InlineAsm.h"
  30 #include "llvm/IR/Instructions.h"
  31 #include "llvm/IR/IntrinsicInst.h"
  32 #include "llvm/Pass.h"
  33 #include "llvm/Support/CallSite.h"
  34 #include "llvm/Support/CommandLine.h"
  35 #include "llvm/Support/Debug.h"
  36 #include "llvm/Support/GetElementPtrTypeIterator.h"
  37 #include "llvm/Support/PatternMatch.h"
  38 #include "llvm/Support/ValueHandle.h"
  39 #include "llvm/Support/raw_ostream.h"
  40 #include "llvm/Target/TargetLibraryInfo.h"
  41 #include "llvm/Target/TargetLowering.h"
  42 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  43 #include "llvm/Transforms/Utils/BuildLibCalls.h"
  44 #include "llvm/Transforms/Utils/BypassSlowDivision.h"
  45 #include "llvm/Transforms/Utils/Local.h"
  46 using namespace llvm;
  47 using namespace llvm::PatternMatch;
  48
  49 STATISTIC(NumBlocksElim, "Number of blocks eliminated");
  50 STATISTIC(NumPHIsElim,   "Number of trivial PHIs eliminated");
  51 STATISTIC(NumGEPsElim,   "Number of GEPs converted to casts");
  52 STATISTIC(NumCmpUses, "Number of uses of Cmp expressions replaced with uses of "
  53                       "sunken Cmps");
  54 STATISTIC(NumCastUses, "Number of uses of Cast expressions replaced with uses "
  55                        "of sunken Casts");
  56 STATISTIC(NumMemoryInsts, "Number of memory instructions whose address "
  57                           "computations were sunk");
  58 STATISTIC(NumExtsMoved,  "Number of [s|z]ext instructions combined with loads");
  59 STATISTIC(NumExtUses,    "Number of uses of [s|z]ext instructions optimized");
  60 STATISTIC(NumRetsDup,    "Number of return instructions duplicated");
  61 STATISTIC(NumDbgValueMoved, "Number of debug value instructions moved");
  62 STATISTIC(NumSelectsExpanded, "Number of selects turned into branches");
  63
  64 static cl::opt<bool> DisableBranchOpts(
  65   "disable-cgp-branch-opts", cl::Hidden, cl::init(false),
  66   cl::desc("Disable branch optimizations in CodeGenPrepare"));
  67
  68 static cl::opt<bool> DisableSelectToBranch(
  69   "disable-cgp-select2branch", cl::Hidden, cl::init(false),
  70   cl::desc("Disable select to branch conversion."));
  71
  72 namespace {
  73   class CodeGenPrepare : public FunctionPass {
  74     /// TLI - Keep a pointer of a TargetLowering to consult for determining
  75     /// transformation profitability.
  76     const TargetMachine *TM;
  77     const TargetLowering *TLI;
  78     const TargetLibraryInfo *TLInfo;
  79     DominatorTree *DT;
  80
  81     /// CurInstIterator - As we scan instructions optimizing them, this is the
  82     /// next instruction to optimize.  Xforms that can invalidate this should
  83     /// update it.
  84     BasicBlock::iterator CurInstIterator;
  85
  86     /// Keeps track of non-local addresses that have been sunk into a block.
  87     /// This allows us to avoid inserting duplicate code for blocks with
  88     /// multiple load/stores of the same address.
  89     ValueMap<Value*, Value*> SunkAddrs;
  90
  91     /// ModifiedDT - If CFG is modified in anyway, dominator tree may need to
  92     /// be updated.
  93     bool ModifiedDT;
  94
  95     /// OptSize - True if optimizing for size.
  96     bool OptSize;
  97
  98   public:
  99     static char ID; // Pass identification, replacement for typeid
 100     explicit CodeGenPrepare(const TargetMachine *TM = 0)
 101       : FunctionPass(ID), TM(TM), TLI(0) {
 102         initializeCodeGenPreparePass(*PassRegistry::getPassRegistry());
 103       }
 104     bool runOnFunction(Function &F);
 105
 106     const char *getPassName() const { return "CodeGen Prepare"; }
 107
 108     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 109       AU.addPreserved<DominatorTreeWrapperPass>();
 110       AU.addRequired<TargetLibraryInfo>();
 111     }
 112
 113   private:
 114     bool EliminateFallThrough(Function &F);
 115     bool EliminateMostlyEmptyBlocks(Function &F);
 116     bool CanMergeBlocks(const BasicBlock *BB, const BasicBlock *DestBB) const;
 117     void EliminateMostlyEmptyBlock(BasicBlock *BB);
 118     bool OptimizeBlock(BasicBlock &BB);
 119     bool OptimizeInst(Instruction *I);
 120     bool OptimizeMemoryInst(Instruction *I, Value *Addr, Type *AccessTy);
 121     bool OptimizeInlineAsmInst(CallInst *CS);
 122     bool OptimizeCallInst(CallInst *CI);
 123     bool MoveExtToFormExtLoad(Instruction *I);
 124     bool OptimizeExtUses(Instruction *I);
 125     bool OptimizeSelectInst(SelectInst *SI);
 126     bool DupRetToEnableTailCallOpts(BasicBlock *BB);
 127     bool PlaceDbgValues(Function &F);
 128   };
 129 }
 130
 131 char CodeGenPrepare::ID = 0;
 132 static void *initializeCodeGenPreparePassOnce(PassRegistry &Registry) {
 133   initializeTargetLibraryInfoPass(Registry);
 134   PassInfo *PI = new PassInfo(
 135       "Optimize for code generation", "codegenprepare", &CodeGenPrepare::ID,
 136       PassInfo::NormalCtor_t(callDefaultCtor<CodeGenPrepare>), false, false,
 137       PassInfo::TargetMachineCtor_t(callTargetMachineCtor<CodeGenPrepare>));
 138   Registry.registerPass(*PI, true);
 139   return PI;
 140 }
 141
 142 void llvm::initializeCodeGenPreparePass(PassRegistry &Registry) {
 143   CALL_ONCE_INITIALIZATION(initializeCodeGenPreparePassOnce)
 144 }
 145
 146 FunctionPass *llvm::createCodeGenPreparePass(const TargetMachine *TM) {
 147   return new CodeGenPrepare(TM);
 148 }
 149
 150 bool CodeGenPrepare::runOnFunction(Function &F) {
 151   bool EverMadeChange = false;
 152
 153   ModifiedDT = false;
 154   if (TM) TLI = TM->getTargetLowering();
 155   TLInfo = &getAnalysis<TargetLibraryInfo>();
 156   DominatorTreeWrapperPass *DTWP =
 157       getAnalysisIfAvailable<DominatorTreeWrapperPass>();
 158   DT = DTWP ? &DTWP->getDomTree() : 0;
 159   OptSize = F.getAttributes().hasAttribute(AttributeSet::FunctionIndex,
 160                                            Attribute::OptimizeForSize);
 161
 162   /// This optimization identifies DIV instructions that can be
 163   /// profitably bypassed and carried out with a shorter, faster divide.
 164   if (!OptSize && TLI && TLI->isSlowDivBypassed()) {
 165     const DenseMap<unsigned int, unsigned int> &BypassWidths =
 166        TLI->getBypassSlowDivWidths();
 167     for (Function::iterator I = F.begin(); I != F.end(); I++)
 168       EverMadeChange |= bypassSlowDivision(F, I, BypassWidths);
 169   }
 170
 171   // Eliminate blocks that contain only PHI nodes and an
 172   // unconditional branch.
 173   EverMadeChange |= EliminateMostlyEmptyBlocks(F);
 174
 175   // llvm.dbg.value is far away from the value then iSel may not be able
 176   // handle it properly. iSel will drop llvm.dbg.value if it can not
 177   // find a node corresponding to the value.
 178   EverMadeChange |= PlaceDbgValues(F);
 179
 180   bool MadeChange = true;
 181   while (MadeChange) {
 182     MadeChange = false;
 183     for (Function::iterator I = F.begin(); I != F.end(); ) {
 184       BasicBlock *BB = I++;
 185       MadeChange |= OptimizeBlock(*BB);
 186     }
 187     EverMadeChange |= MadeChange;
 188   }
 189
 190   SunkAddrs.clear();
 191
 192   if (!DisableBranchOpts) {
 193     MadeChange = false;
 194     SmallPtrSet<BasicBlock*, 8> WorkList;
 195     for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
 196       SmallVector<BasicBlock*, 2> Successors(succ_begin(BB), succ_end(BB));
 197       MadeChange |= ConstantFoldTerminator(BB, true);
 198       if (!MadeChange) continue;
 199
 200       for (SmallVectorImpl<BasicBlock*>::iterator
 201              II = Successors.begin(), IE = Successors.end(); II != IE; ++II)
 202         if (pred_begin(*II) == pred_end(*II))
 203           WorkList.insert(*II);
 204     }
 205
 206     // Delete the dead blocks and any of their dead successors.
 207     MadeChange |= !WorkList.empty();
 208     while (!WorkList.empty()) {
 209       BasicBlock *BB = *WorkList.begin();
 210       WorkList.erase(BB);
 211       SmallVector<BasicBlock*, 2> Successors(succ_begin(BB), succ_end(BB));
 212
 213       DeleteDeadBlock(BB);
 214
 215       for (SmallVectorImpl<BasicBlock*>::iterator
 216              II = Successors.begin(), IE = Successors.end(); II != IE; ++II)
 217         if (pred_begin(*II) == pred_end(*II))
 218           WorkList.insert(*II);
 219     }
 220
 221     // Merge pairs of basic blocks with unconditional branches, connected by
 222     // a single edge.
 223     if (EverMadeChange || MadeChange)
 224       MadeChange |= EliminateFallThrough(F);
 225
 226     if (MadeChange)
 227       ModifiedDT = true;
 228     EverMadeChange |= MadeChange;
 229   }
 230
 231   if (ModifiedDT && DT)
 232     DT->recalculate(F);
 233
 234   return EverMadeChange;
 235 }
 236
 237 /// EliminateFallThrough - Merge basic blocks which are connected
 238 /// by a single edge, where one of the basic blocks has a single successor
 239 /// pointing to the other basic block, which has a single predecessor.
 240 bool CodeGenPrepare::EliminateFallThrough(Function &F) {
 241   bool Changed = false;
 242   // Scan all of the blocks in the function, except for the entry block.
 243   for (Function::iterator I = ++F.begin(), E = F.end(); I != E; ) {
 244     BasicBlock *BB = I++;
 245     // If the destination block has a single pred, then this is a trivial
 246     // edge, just collapse it.
 247     BasicBlock *SinglePred = BB->getSinglePredecessor();
 248
 249     // Don't merge if BB's address is taken.
 250     if (!SinglePred || SinglePred == BB || BB->hasAddressTaken()) continue;
 251
 252     BranchInst *Term = dyn_cast<BranchInst>(SinglePred->getTerminator());
 253     if (Term && !Term->isConditional()) {
 254       Changed = true;
 255       DEBUG(dbgs() << "To merge:\n"<< *SinglePred << "\n\n\n");
 256       // Remember if SinglePred was the entry block of the function.
 257       // If so, we will need to move BB back to the entry position.
 258       bool isEntry = SinglePred == &SinglePred->getParent()->getEntryBlock();
 259       MergeBasicBlockIntoOnlyPred(BB, this);
 260
 261       if (isEntry && BB != &BB->getParent()->getEntryBlock())
 262         BB->moveBefore(&BB->getParent()->getEntryBlock());
 263
 264       // We have erased a block. Update the iterator.
 265       I = BB;
 266     }
 267   }
 268   return Changed;
 269 }
 270
 271 /// EliminateMostlyEmptyBlocks - eliminate blocks that contain only PHI nodes,
 272 /// debug info directives, and an unconditional branch.  Passes before isel
 273 /// (e.g. LSR/loopsimplify) often split edges in ways that are non-optimal for
 274 /// isel.  Start by eliminating these blocks so we can split them the way we
 275 /// want them.
 276 bool CodeGenPrepare::EliminateMostlyEmptyBlocks(Function &F) {
 277   bool MadeChange = false;
 278   // Note that this intentionally skips the entry block.
 279   for (Function::iterator I = ++F.begin(), E = F.end(); I != E; ) {
 280     BasicBlock *BB = I++;
 281
 282     // If this block doesn't end with an uncond branch, ignore it.
 283     BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator());
 284     if (!BI || !BI->isUnconditional())
 285       continue;
 286
 287     // If the instruction before the branch (skipping debug info) isn't a phi
 288     // node, then other stuff is happening here.
 289     BasicBlock::iterator BBI = BI;
 290     if (BBI != BB->begin()) {
 291       --BBI;
 292       while (isa<DbgInfoIntrinsic>(BBI)) {
 293         if (BBI == BB->begin())
 294           break;
 295         --BBI;
 296       }
 297       if (!isa<DbgInfoIntrinsic>(BBI) && !isa<PHINode>(BBI))
 298         continue;
 299     }
 300
 301     // Do not break infinite loops.
 302     BasicBlock *DestBB = BI->getSuccessor(0);
 303     if (DestBB == BB)
 304       continue;
 305
 306     if (!CanMergeBlocks(BB, DestBB))
 307       continue;
 308
 309     EliminateMostlyEmptyBlock(BB);
 310     MadeChange = true;
 311   }
 312   return MadeChange;
 313 }
 314
 315 /// CanMergeBlocks - Return true if we can merge BB into DestBB if there is a
 316 /// single uncond branch between them, and BB contains no other non-phi
 317 /// instructions.
 318 bool CodeGenPrepare::CanMergeBlocks(const BasicBlock *BB,
 319                                     const BasicBlock *DestBB) const {
 320   // We only want to eliminate blocks whose phi nodes are used by phi nodes in
 321   // the successor.  If there are more complex condition (e.g. preheaders),
 322   // don't mess around with them.
 323   BasicBlock::const_iterator BBI = BB->begin();
 324   while (const PHINode *PN = dyn_cast<PHINode>(BBI++)) {
 325     for (Value::const_use_iterator UI = PN->use_begin(), E = PN->use_end();
 326          UI != E; ++UI) {
 327       const Instruction *User = cast<Instruction>(*UI);
 328       if (User->getParent() != DestBB || !isa<PHINode>(User))
 329         return false;
 330       // If User is inside DestBB block and it is a PHINode then check
 331       // incoming value. If incoming value is not from BB then this is
 332       // a complex condition (e.g. preheaders) we want to avoid here.
 333       if (User->getParent() == DestBB) {
 334         if (const PHINode *UPN = dyn_cast<PHINode>(User))
 335           for (unsigned I = 0, E = UPN->getNumIncomingValues(); I != E; ++I) {
 336             Instruction *Insn = dyn_cast<Instruction>(UPN->getIncomingValue(I));
 337             if (Insn && Insn->getParent() == BB &&
 338                 Insn->getParent() != UPN->getIncomingBlock(I))
 339               return false;
 340           }
 341       }
 342     }
 343   }
 344
 345   // If BB and DestBB contain any common predecessors, then the phi nodes in BB
 346   // and DestBB may have conflicting incoming values for the block.  If so, we
 347   // can't merge the block.
 348   const PHINode *DestBBPN = dyn_cast<PHINode>(DestBB->begin());
 349   if (!DestBBPN) return true;  // no conflict.
 350
 351   // Collect the preds of BB.
 352   SmallPtrSet<const BasicBlock*, 16> BBPreds;
 353   if (const PHINode *BBPN = dyn_cast<PHINode>(BB->begin())) {
 354     // It is faster to get preds from a PHI than with pred_iterator.
 355     for (unsigned i = 0, e = BBPN->getNumIncomingValues(); i != e; ++i)
 356       BBPreds.insert(BBPN->getIncomingBlock(i));
 357   } else {
 358     BBPreds.insert(pred_begin(BB), pred_end(BB));
 359   }
 360
 361   // Walk the preds of DestBB.
 362   for (unsigned i = 0, e = DestBBPN->getNumIncomingValues(); i != e; ++i) {
 363     BasicBlock *Pred = DestBBPN->getIncomingBlock(i);
 364     if (BBPreds.count(Pred)) {   // Common predecessor?
 365       BBI = DestBB->begin();
 366       while (const PHINode *PN = dyn_cast<PHINode>(BBI++)) {
 367         const Value *V1 = PN->getIncomingValueForBlock(Pred);
 368         const Value *V2 = PN->getIncomingValueForBlock(BB);
 369
 370         // If V2 is a phi node in BB, look up what the mapped value will be.
 371         if (const PHINode *V2PN = dyn_cast<PHINode>(V2))
 372           if (V2PN->getParent() == BB)
 373             V2 = V2PN->getIncomingValueForBlock(Pred);
 374
 375         // If there is a conflict, bail out.
 376         if (V1 != V2) return false;
 377       }
 378     }
 379   }
 380
 381   return true;
 382 }
 383
 384
 385 /// EliminateMostlyEmptyBlock - Eliminate a basic block that have only phi's and
 386 /// an unconditional branch in it.
 387 void CodeGenPrepare::EliminateMostlyEmptyBlock(BasicBlock *BB) {
 388   BranchInst *BI = cast<BranchInst>(BB->getTerminator());
 389   BasicBlock *DestBB = BI->getSuccessor(0);
 390
 391   DEBUG(dbgs() << "MERGING MOSTLY EMPTY BLOCKS - BEFORE:\n" << *BB << *DestBB);
 392
 393   // If the destination block has a single pred, then this is a trivial edge,
 394   // just collapse it.
 395   if (BasicBlock *SinglePred = DestBB->getSinglePredecessor()) {
 396     if (SinglePred != DestBB) {
 397       // Remember if SinglePred was the entry block of the function.  If so, we
 398       // will need to move BB back to the entry position.
 399       bool isEntry = SinglePred == &SinglePred->getParent()->getEntryBlock();
 400       MergeBasicBlockIntoOnlyPred(DestBB, this);
 401
 402       if (isEntry && BB != &BB->getParent()->getEntryBlock())
 403         BB->moveBefore(&BB->getParent()->getEntryBlock());
 404
 405       DEBUG(dbgs() << "AFTER:\n" << *DestBB << "\n\n\n");
 406       return;
 407     }
 408   }
 409
 410   // Otherwise, we have multiple predecessors of BB.  Update the PHIs in DestBB
 411   // to handle the new incoming edges it is about to have.
 412   PHINode *PN;
 413   for (BasicBlock::iterator BBI = DestBB->begin();
 414        (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
 415     // Remove the incoming value for BB, and remember it.
 416     Value *InVal = PN->removeIncomingValue(BB, false);
 417
 418     // Two options: either the InVal is a phi node defined in BB or it is some
 419     // value that dominates BB.
 420     PHINode *InValPhi = dyn_cast<PHINode>(InVal);
 421     if (InValPhi && InValPhi->getParent() == BB) {
 422       // Add all of the input values of the input PHI as inputs of this phi.
 423       for (unsigned i = 0, e = InValPhi->getNumIncomingValues(); i != e; ++i)
 424         PN->addIncoming(InValPhi->getIncomingValue(i),
 425                         InValPhi->getIncomingBlock(i));
 426     } else {
 427       // Otherwise, add one instance of the dominating value for each edge that
 428       // we will be adding.
 429       if (PHINode *BBPN = dyn_cast<PHINode>(BB->begin())) {
 430         for (unsigned i = 0, e = BBPN->getNumIncomingValues(); i != e; ++i)
 431           PN->addIncoming(InVal, BBPN->getIncomingBlock(i));
 432       } else {
 433         for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
 434           PN->addIncoming(InVal, *PI);
 435       }
 436     }
 437   }
 438
 439   // The PHIs are now updated, change everything that refers to BB to use
 440   // DestBB and remove BB.
 441   BB->replaceAllUsesWith(DestBB);
 442   if (DT && !ModifiedDT) {
 443     BasicBlock *BBIDom  = DT->getNode(BB)->getIDom()->getBlock();
 444     BasicBlock *DestBBIDom = DT->getNode(DestBB)->getIDom()->getBlock();
 445     BasicBlock *NewIDom = DT->findNearestCommonDominator(BBIDom, DestBBIDom);
 446     DT->changeImmediateDominator(DestBB, NewIDom);
 447     DT->eraseNode(BB);
 448   }
 449   BB->eraseFromParent();
 450   ++NumBlocksElim;
 451
 452   DEBUG(dbgs() << "AFTER:\n" << *DestBB << "\n\n\n");
 453 }
 454
 455 /// OptimizeNoopCopyExpression - If the specified cast instruction is a noop
 456 /// copy (e.g. it's casting from one pointer type to another, i32->i8 on PPC),
 457 /// sink it into user blocks to reduce the number of virtual
 458 /// registers that must be created and coalesced.
 459 ///
 460 /// Return true if any changes are made.
 461 ///
 462 static bool OptimizeNoopCopyExpression(CastInst *CI, const TargetLowering &TLI){
 463   // If this is a noop copy,
 464   EVT SrcVT = TLI.getValueType(CI->getOperand(0)->getType());
 465   EVT DstVT = TLI.getValueType(CI->getType());
 466
 467   // This is an fp<->int conversion?
 468   if (SrcVT.isInteger() != DstVT.isInteger())
 469     return false;
 470
 471   // If this is an extension, it will be a zero or sign extension, which
 472   // isn't a noop.
 473   if (SrcVT.bitsLT(DstVT)) return false;
 474
 475   // If these values will be promoted, find out what they will be promoted
 476   // to.  This helps us consider truncates on PPC as noop copies when they
 477   // are.
 478   if (TLI.getTypeAction(CI->getContext(), SrcVT) ==
 479       TargetLowering::TypePromoteInteger)
 480     SrcVT = TLI.getTypeToTransformTo(CI->getContext(), SrcVT);
 481   if (TLI.getTypeAction(CI->getContext(), DstVT) ==
 482       TargetLowering::TypePromoteInteger)
 483     DstVT = TLI.getTypeToTransformTo(CI->getContext(), DstVT);
 484
 485   // If, after promotion, these are the same types, this is a noop copy.
 486   if (SrcVT != DstVT)
 487     return false;
 488
 489   BasicBlock *DefBB = CI->getParent();
 490
 491   /// InsertedCasts - Only insert a cast in each block once.
 492   DenseMap<BasicBlock*, CastInst*> InsertedCasts;
 493
 494   bool MadeChange = false;
 495   for (Value::use_iterator UI = CI->use_begin(), E = CI->use_end();
 496        UI != E; ) {
 497     Use &TheUse = UI.getUse();
 498     Instruction *User = cast<Instruction>(*UI);
 499
 500     // Figure out which BB this cast is used in.  For PHI's this is the
 501     // appropriate predecessor block.
 502     BasicBlock *UserBB = User->getParent();
 503     if (PHINode *PN = dyn_cast<PHINode>(User)) {
 504       UserBB = PN->getIncomingBlock(UI);
 505     }
 506
 507     // Preincrement use iterator so we don't invalidate it.
 508     ++UI;
 509
 510     // If this user is in the same block as the cast, don't change the cast.
 511     if (UserBB == DefBB) continue;
 512
 513     // If we have already inserted a cast into this block, use it.
 514     CastInst *&InsertedCast = InsertedCasts[UserBB];
 515
 516     if (!InsertedCast) {
 517       BasicBlock::iterator InsertPt = UserBB->getFirstInsertionPt();
 518       InsertedCast =
 519         CastInst::Create(CI->getOpcode(), CI->getOperand(0), CI->getType(), "",
 520                          InsertPt);
 521       MadeChange = true;
 522     }
 523
 524     // Replace a use of the cast with a use of the new cast.
 525     TheUse = InsertedCast;
 526     ++NumCastUses;
 527   }
 528
 529   // If we removed all uses, nuke the cast.
 530   if (CI->use_empty()) {
 531     CI->eraseFromParent();
 532     MadeChange = true;
 533   }
 534
 535   return MadeChange;
 536 }
 537
 538 /// OptimizeCmpExpression - sink the given CmpInst into user blocks to reduce
 539 /// the number of virtual registers that must be created and coalesced.  This is
 540 /// a clear win except on targets with multiple condition code registers
 541 ///  (PowerPC), where it might lose; some adjustment may be wanted there.
 542 ///
 543 /// Return true if any changes are made.
 544 static bool OptimizeCmpExpression(CmpInst *CI) {
 545   BasicBlock *DefBB = CI->getParent();
 546
 547   /// InsertedCmp - Only insert a cmp in each block once.
 548   DenseMap<BasicBlock*, CmpInst*> InsertedCmps;
 549
 550   bool MadeChange = false;
 551   for (Value::use_iterator UI = CI->use_begin(), E = CI->use_end();
 552        UI != E; ) {
 553     Use &TheUse = UI.getUse();
 554     Instruction *User = cast<Instruction>(*UI);
 555
 556     // Preincrement use iterator so we don't invalidate it.
 557     ++UI;
 558
 559     // Don't bother for PHI nodes.
 560     if (isa<PHINode>(User))
 561       continue;
 562
 563     // Figure out which BB this cmp is used in.
 564     BasicBlock *UserBB = User->getParent();
 565
 566     // If this user is in the same block as the cmp, don't change the cmp.
 567     if (UserBB == DefBB) continue;
 568
 569     // If we have already inserted a cmp into this block, use it.
 570     CmpInst *&InsertedCmp = InsertedCmps[UserBB];
 571
 572     if (!InsertedCmp) {
 573       BasicBlock::iterator InsertPt = UserBB->getFirstInsertionPt();
 574       InsertedCmp =
 575         CmpInst::Create(CI->getOpcode(),
 576                         CI->getPredicate(),  CI->getOperand(0),
 577                         CI->getOperand(1), "", InsertPt);
 578       MadeChange = true;
 579     }
 580
 581     // Replace a use of the cmp with a use of the new cmp.
 582     TheUse = InsertedCmp;
 583     ++NumCmpUses;
 584   }
 585
 586   // If we removed all uses, nuke the cmp.
 587   if (CI->use_empty())
 588     CI->eraseFromParent();
 589
 590   return MadeChange;
 591 }
 592
 593 namespace {
 594 class CodeGenPrepareFortifiedLibCalls : public SimplifyFortifiedLibCalls {
 595 protected:
 596   void replaceCall(Value *With) {
 597     CI->replaceAllUsesWith(With);
 598     CI->eraseFromParent();
 599   }
 600   bool isFoldable(unsigned SizeCIOp, unsigned, bool) const {
 601       if (ConstantInt *SizeCI =
 602                              dyn_cast<ConstantInt>(CI->getArgOperand(SizeCIOp)))
 603         return SizeCI->isAllOnesValue();
 604     return false;
 605   }
 606 };
 607 } // end anonymous namespace
 608
 609 bool CodeGenPrepare::OptimizeCallInst(CallInst *CI) {
 610   BasicBlock *BB = CI->getParent();
 611
 612   // Lower inline assembly if we can.
 613   // If we found an inline asm expession, and if the target knows how to
 614   // lower it to normal LLVM code, do so now.
 615   if (TLI && isa<InlineAsm>(CI->getCalledValue())) {
 616     if (TLI->ExpandInlineAsm(CI)) {
 617       // Avoid invalidating the iterator.
 618       CurInstIterator = BB->begin();
 619       // Avoid processing instructions out of order, which could cause
 620       // reuse before a value is defined.
 621       SunkAddrs.clear();
 622       return true;
 623     }
 624     // Sink address computing for memory operands into the block.
 625     if (OptimizeInlineAsmInst(CI))
 626       return true;
 627   }
 628
 629   // Lower all uses of llvm.objectsize.*
 630   IntrinsicInst *II = dyn_cast<IntrinsicInst>(CI);
 631   if (II && II->getIntrinsicID() == Intrinsic::objectsize) {
 632     bool Min = (cast<ConstantInt>(II->getArgOperand(1))->getZExtValue() == 1);
 633     Type *ReturnTy = CI->getType();
 634     Constant *RetVal = ConstantInt::get(ReturnTy, Min ? 0 : -1ULL);
 635
 636     // Substituting this can cause recursive simplifications, which can
 637     // invalidate our iterator.  Use a WeakVH to hold onto it in case this
 638     // happens.
 639     WeakVH IterHandle(CurInstIterator);
 640
 641     replaceAndRecursivelySimplify(CI, RetVal, TLI ? TLI->getDataLayout() : 0,
 642                                   TLInfo, ModifiedDT ? 0 : DT);
 643
 644     // If the iterator instruction was recursively deleted, start over at the
 645     // start of the block.
 646     if (IterHandle != CurInstIterator) {
 647       CurInstIterator = BB->begin();
 648       SunkAddrs.clear();
 649     }
 650     return true;
 651   }
 652
 653   if (II && TLI) {
 654     SmallVector<Value*, 2> PtrOps;
 655     Type *AccessTy;
 656     if (TLI->GetAddrModeArguments(II, PtrOps, AccessTy))
 657       while (!PtrOps.empty())
 658         if (OptimizeMemoryInst(II, PtrOps.pop_back_val(), AccessTy))
 659           return true;
 660   }
 661
 662   // From here on out we're working with named functions.
 663   if (CI->getCalledFunction() == 0) return false;
 664
 665   // We'll need DataLayout from here on out.
 666   const DataLayout *TD = TLI ? TLI->getDataLayout() : 0;
 667   if (!TD) return false;
 668
 669   // Lower all default uses of _chk calls.  This is very similar
 670   // to what InstCombineCalls does, but here we are only lowering calls
 671   // that have the default "don't know" as the objectsize.  Anything else
 672   // should be left alone.
 673   CodeGenPrepareFortifiedLibCalls Simplifier;
 674   return Simplifier.fold(CI, TD, TLInfo);
 675 }
 676
 677 /// DupRetToEnableTailCallOpts - Look for opportunities to duplicate return
 678 /// instructions to the predecessor to enable tail call optimizations. The
 679 /// case it is currently looking for is:
 680 /// @code
 681 /// bb0:
 682 ///   %tmp0 = tail call i32 @f0()
 683 ///   br label %return
 684 /// bb1:
 685 ///   %tmp1 = tail call i32 @f1()
 686 ///   br label %return
 687 /// bb2:
 688 ///   %tmp2 = tail call i32 @f2()
 689 ///   br label %return
 690 /// return:
 691 ///   %retval = phi i32 [ %tmp0, %bb0 ], [ %tmp1, %bb1 ], [ %tmp2, %bb2 ]
 692 ///   ret i32 %retval
 693 /// @endcode
 694 ///
 695 /// =>
 696 ///
 697 /// @code
 698 /// bb0:
 699 ///   %tmp0 = tail call i32 @f0()
 700 ///   ret i32 %tmp0
 701 /// bb1:
 702 ///   %tmp1 = tail call i32 @f1()
 703 ///   ret i32 %tmp1
 704 /// bb2:
 705 ///   %tmp2 = tail call i32 @f2()
 706 ///   ret i32 %tmp2
 707 /// @endcode
 708 bool CodeGenPrepare::DupRetToEnableTailCallOpts(BasicBlock *BB) {
 709   if (!TLI)
 710     return false;
 711
 712   ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator());
 713   if (!RI)
 714     return false;
 715
 716   PHINode *PN = 0;
 717   BitCastInst *BCI = 0;
 718   Value *V = RI->getReturnValue();
 719   if (V) {
 720     BCI = dyn_cast<BitCastInst>(V);
 721     if (BCI)
 722       V = BCI->getOperand(0);
 723
 724     PN = dyn_cast<PHINode>(V);
 725     if (!PN)
 726       return false;
 727   }
 728
 729   if (PN && PN->getParent() != BB)
 730     return false;
 731
 732   // It's not safe to eliminate the sign / zero extension of the return value.
 733   // See llvm::isInTailCallPosition().
 734   const Function *F = BB->getParent();
 735   AttributeSet CallerAttrs = F->getAttributes();
 736   if (CallerAttrs.hasAttribute(AttributeSet::ReturnIndex, Attribute::ZExt) ||
 737       CallerAttrs.hasAttribute(AttributeSet::ReturnIndex, Attribute::SExt))
 738     return false;
 739
 740   // Make sure there are no instructions between the PHI and return, or that the
 741   // return is the first instruction in the block.
 742   if (PN) {
 743     BasicBlock::iterator BI = BB->begin();
 744     do { ++BI; } while (isa<DbgInfoIntrinsic>(BI));
 745     if (&*BI == BCI)
 746       // Also skip over the bitcast.
 747       ++BI;
 748     if (&*BI != RI)
 749       return false;
 750   } else {
 751     BasicBlock::iterator BI = BB->begin();
 752     while (isa<DbgInfoIntrinsic>(BI)) ++BI;
 753     if (&*BI != RI)
 754       return false;
 755   }
 756
 757   /// Only dup the ReturnInst if the CallInst is likely to be emitted as a tail
 758   /// call.
 759   SmallVector<CallInst*, 4> TailCalls;
 760   if (PN) {
 761     for (unsigned I = 0, E = PN->getNumIncomingValues(); I != E; ++I) {
 762       CallInst *CI = dyn_cast<CallInst>(PN->getIncomingValue(I));
 763       // Make sure the phi value is indeed produced by the tail call.
 764       if (CI && CI->hasOneUse() && CI->getParent() == PN->getIncomingBlock(I) &&
 765           TLI->mayBeEmittedAsTailCall(CI))
 766         TailCalls.push_back(CI);
 767     }
 768   } else {
 769     SmallPtrSet<BasicBlock*, 4> VisitedBBs;
 770     for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE; ++PI) {
 771       if (!VisitedBBs.insert(*PI))
 772         continue;
 773
 774       BasicBlock::InstListType &InstList = (*PI)->getInstList();
 775       BasicBlock::InstListType::reverse_iterator RI = InstList.rbegin();
 776       BasicBlock::InstListType::reverse_iterator RE = InstList.rend();
 777       do { ++RI; } while (RI != RE && isa<DbgInfoIntrinsic>(&*RI));
 778       if (RI == RE)
 779         continue;
 780
 781       CallInst *CI = dyn_cast<CallInst>(&*RI);
 782       if (CI && CI->use_empty() && TLI->mayBeEmittedAsTailCall(CI))
 783         TailCalls.push_back(CI);
 784     }
 785   }
 786
 787   bool Changed = false;
 788   for (unsigned i = 0, e = TailCalls.size(); i != e; ++i) {
 789     CallInst *CI = TailCalls[i];
 790     CallSite CS(CI);
 791
 792     // Conservatively require the attributes of the call to match those of the
 793     // return. Ignore noalias because it doesn't affect the call sequence.
 794     AttributeSet CalleeAttrs = CS.getAttributes();
 795     if (AttrBuilder(CalleeAttrs, AttributeSet::ReturnIndex).
 796           removeAttribute(Attribute::NoAlias) !=
 797         AttrBuilder(CalleeAttrs, AttributeSet::ReturnIndex).
 798           removeAttribute(Attribute::NoAlias))
 799       continue;
 800
 801     // Make sure the call instruction is followed by an unconditional branch to
 802     // the return block.
 803     BasicBlock *CallBB = CI->getParent();
 804     BranchInst *BI = dyn_cast<BranchInst>(CallBB->getTerminator());
 805     if (!BI || !BI->isUnconditional() || BI->getSuccessor(0) != BB)
 806       continue;
 807
 808     // Duplicate the return into CallBB.
 809     (void)FoldReturnIntoUncondBranch(RI, BB, CallBB);
 810     ModifiedDT = Changed = true;
 811     ++NumRetsDup;
 812   }
 813
 814   // If we eliminated all predecessors of the block, delete the block now.
 815   if (Changed && !BB->hasAddressTaken() && pred_begin(BB) == pred_end(BB))
 816     BB->eraseFromParent();
 817
 818   return Changed;
 819 }
 820
 821 //===----------------------------------------------------------------------===//
 822 // Memory Optimization
 823 //===----------------------------------------------------------------------===//
 824
 825 namespace {
 826
 827 /// ExtAddrMode - This is an extended version of TargetLowering::AddrMode
 828 /// which holds actual Value*'s for register values.
 829 struct ExtAddrMode : public TargetLowering::AddrMode {
 830   Value *BaseReg;
 831   Value *ScaledReg;
 832   ExtAddrMode() : BaseReg(0), ScaledReg(0) {}
 833   void print(raw_ostream &OS) const;
 834   void dump() const;
 835
 836   bool operator==(const ExtAddrMode& O) const {
 837     return (BaseReg == O.BaseReg) && (ScaledReg == O.ScaledReg) &&
 838            (BaseGV == O.BaseGV) && (BaseOffs == O.BaseOffs) &&
 839            (HasBaseReg == O.HasBaseReg) && (Scale == O.Scale);
 840   }
 841 };
 842
 843 #ifndef NDEBUG
 844 static inline raw_ostream &operator<<(raw_ostream &OS, const ExtAddrMode &AM) {
 845   AM.print(OS);
 846   return OS;
 847 }
 848 #endif
 849
 850 void ExtAddrMode::print(raw_ostream &OS) const {
 851   bool NeedPlus = false;
 852   OS << "[";
 853   if (BaseGV) {
 854     OS << (NeedPlus ? " + " : "")
 855        << "GV:";
 856     BaseGV->printAsOperand(OS, /*PrintType=*/false);
 857     NeedPlus = true;
 858   }
 859
 860   if (BaseOffs)
 861     OS << (NeedPlus ? " + " : "") << BaseOffs, NeedPlus = true;
 862
 863   if (BaseReg) {
 864     OS << (NeedPlus ? " + " : "")
 865        << "Base:";
 866     BaseReg->printAsOperand(OS, /*PrintType=*/false);
 867     NeedPlus = true;
 868   }
 869   if (Scale) {
 870     OS << (NeedPlus ? " + " : "")
 871        << Scale << "*";
 872     ScaledReg->printAsOperand(OS, /*PrintType=*/false);
 873   }
 874
 875   OS << ']';
 876 }
 877
 878 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 879 void ExtAddrMode::dump() const {
 880   print(dbgs());
 881   dbgs() << '\n';
 882 }
 883 #endif
 884
 885
 886 /// \brief A helper class for matching addressing modes.
 887 ///
 888 /// This encapsulates the logic for matching the target-legal addressing modes.
 889 class AddressingModeMatcher {
 890   SmallVectorImpl<Instruction*> &AddrModeInsts;
 891   const TargetLowering &TLI;
 892
 893   /// AccessTy/MemoryInst - This is the type for the access (e.g. double) and
 894   /// the memory instruction that we're computing this address for.
 895   Type *AccessTy;
 896   Instruction *MemoryInst;
 897
 898   /// AddrMode - This is the addressing mode that we're building up.  This is
 899   /// part of the return value of this addressing mode matching stuff.
 900   ExtAddrMode &AddrMode;
 901
 902   /// IgnoreProfitability - This is set to true when we should not do
 903   /// profitability checks.  When true, IsProfitableToFoldIntoAddressingMode
 904   /// always returns true.
 905   bool IgnoreProfitability;
 906
 907   AddressingModeMatcher(SmallVectorImpl<Instruction*> &AMI,
 908                         const TargetLowering &T, Type *AT,
 909                         Instruction *MI, ExtAddrMode &AM)
 910     : AddrModeInsts(AMI), TLI(T), AccessTy(AT), MemoryInst(MI), AddrMode(AM) {
 911     IgnoreProfitability = false;
 912   }
 913 public:
 914
 915   /// Match - Find the maximal addressing mode that a load/store of V can fold,
 916   /// give an access type of AccessTy.  This returns a list of involved
 917   /// instructions in AddrModeInsts.
 918   static ExtAddrMode Match(Value *V, Type *AccessTy,
 919                            Instruction *MemoryInst,
 920                            SmallVectorImpl<Instruction*> &AddrModeInsts,
 921                            const TargetLowering &TLI) {
 922     ExtAddrMode Result;
 923
 924     bool Success =
 925       AddressingModeMatcher(AddrModeInsts, TLI, AccessTy,
 926                             MemoryInst, Result).MatchAddr(V, 0);
 927     (void)Success; assert(Success && "Couldn't select *anything*?");
 928     return Result;
 929   }
 930 private:
 931   bool MatchScaledValue(Value *ScaleReg, int64_t Scale, unsigned Depth);
 932   bool MatchAddr(Value *V, unsigned Depth);
 933   bool MatchOperationAddr(User *Operation, unsigned Opcode, unsigned Depth);
 934   bool IsProfitableToFoldIntoAddressingMode(Instruction *I,
 935                                             ExtAddrMode &AMBefore,
 936                                             ExtAddrMode &AMAfter);
 937   bool ValueAlreadyLiveAtInst(Value *Val, Value *KnownLive1, Value *KnownLive2);
 938 };
 939
 940 /// MatchScaledValue - Try adding ScaleReg*Scale to the current addressing mode.
 941 /// Return true and update AddrMode if this addr mode is legal for the target,
 942 /// false if not.
 943 bool AddressingModeMatcher::MatchScaledValue(Value *ScaleReg, int64_t Scale,
 944                                              unsigned Depth) {
 945   // If Scale is 1, then this is the same as adding ScaleReg to the addressing
 946   // mode.  Just process that directly.
 947   if (Scale == 1)
 948     return MatchAddr(ScaleReg, Depth);
 949
 950   // If the scale is 0, it takes nothing to add this.
 951   if (Scale == 0)
 952     return true;
 953
 954   // If we already have a scale of this value, we can add to it, otherwise, we
 955   // need an available scale field.
 956   if (AddrMode.Scale != 0 && AddrMode.ScaledReg != ScaleReg)
 957     return false;
 958
 959   ExtAddrMode TestAddrMode = AddrMode;
 960
 961   // Add scale to turn X*4+X*3 -> X*7.  This could also do things like
 962   // [A+B + A*7] -> [B+A*8].
 963   TestAddrMode.Scale += Scale;
 964   TestAddrMode.ScaledReg = ScaleReg;
 965
 966   // If the new address isn't legal, bail out.
 967   if (!TLI.isLegalAddressingMode(TestAddrMode, AccessTy))
 968     return false;
 969
 970   // It was legal, so commit it.
 971   AddrMode = TestAddrMode;
 972
 973   // Okay, we decided that we can add ScaleReg+Scale to AddrMode.  Check now
 974   // to see if ScaleReg is actually X+C.  If so, we can turn this into adding
 975   // X*Scale + C*Scale to addr mode.
 976   ConstantInt *CI = 0; Value *AddLHS = 0;
 977   if (isa<Instruction>(ScaleReg) &&  // not a constant expr.
 978       match(ScaleReg, m_Add(m_Value(AddLHS), m_ConstantInt(CI)))) {
 979     TestAddrMode.ScaledReg = AddLHS;
 980     TestAddrMode.BaseOffs += CI->getSExtValue()*TestAddrMode.Scale;
 981
 982     // If this addressing mode is legal, commit it and remember that we folded
 983     // this instruction.
 984     if (TLI.isLegalAddressingMode(TestAddrMode, AccessTy)) {
 985       AddrModeInsts.push_back(cast<Instruction>(ScaleReg));
 986       AddrMode = TestAddrMode;
 987       return true;
 988     }
 989   }
 990
 991   // Otherwise, not (x+c)*scale, just return what we have.
 992   return true;
 993 }
 994
 995 /// MightBeFoldableInst - This is a little filter, which returns true if an
 996 /// addressing computation involving I might be folded into a load/store
 997 /// accessing it.  This doesn't need to be perfect, but needs to accept at least
 998 /// the set of instructions that MatchOperationAddr can.
 999 static bool MightBeFoldableInst(Instruction *I) {
1000   switch (I->getOpcode()) {
1001   case Instruction::BitCast:
1002     // Don't touch identity bitcasts.
1003     if (I->getType() == I->getOperand(0)->getType())
1004       return false;
1005     return I->getType()->isPointerTy() || I->getType()->isIntegerTy();
1006   case Instruction::PtrToInt:
1007     // PtrToInt is always a noop, as we know that the int type is pointer sized.
1008     return true;
1009   case Instruction::IntToPtr:
1010     // We know the input is intptr_t, so this is foldable.
1011     return true;
1012   case Instruction::Add:
1013     return true;
1014   case Instruction::Mul:
1015   case Instruction::Shl:
1016     // Can only handle X*C and X << C.
1017     return isa<ConstantInt>(I->getOperand(1));
1018   case Instruction::GetElementPtr:
1019     return true;
1020   default:
1021     return false;
1022   }
1023 }
1024
1025 /// MatchOperationAddr - Given an instruction or constant expr, see if we can
1026 /// fold the operation into the addressing mode.  If so, update the addressing
1027 /// mode and return true, otherwise return false without modifying AddrMode.
1028 bool AddressingModeMatcher::MatchOperationAddr(User *AddrInst, unsigned Opcode,
1029                                                unsigned Depth) {
1030   // Avoid exponential behavior on extremely deep expression trees.
1031   if (Depth >= 5) return false;
1032
1033   switch (Opcode) {
1034   case Instruction::PtrToInt:
1035     // PtrToInt is always a noop, as we know that the int type is pointer sized.
1036     return MatchAddr(AddrInst->getOperand(0), Depth);
1037   case Instruction::IntToPtr:
1038     // This inttoptr is a no-op if the integer type is pointer sized.
1039     if (TLI.getValueType(AddrInst->getOperand(0)->getType()) ==
1040         TLI.getPointerTy(AddrInst->getType()->getPointerAddressSpace()))
1041       return MatchAddr(AddrInst->getOperand(0), Depth);
1042     return false;
1043   case Instruction::BitCast:
1044     // BitCast is always a noop, and we can handle it as long as it is
1045     // int->int or pointer->pointer (we don't want int<->fp or something).
1046     if ((AddrInst->getOperand(0)->getType()->isPointerTy() ||
1047          AddrInst->getOperand(0)->getType()->isIntegerTy()) &&
1048         // Don't touch identity bitcasts.  These were probably put here by LSR,
1049         // and we don't want to mess around with them.  Assume it knows what it
1050         // is doing.
1051         AddrInst->getOperand(0)->getType() != AddrInst->getType())
1052       return MatchAddr(AddrInst->getOperand(0), Depth);
1053     return false;
1054   case Instruction::Add: {
1055     // Check to see if we can merge in the RHS then the LHS.  If so, we win.
1056     ExtAddrMode BackupAddrMode = AddrMode;
1057     unsigned OldSize = AddrModeInsts.size();
1058     if (MatchAddr(AddrInst->getOperand(1), Depth+1) &&
1059         MatchAddr(AddrInst->getOperand(0), Depth+1))
1060       return true;
1061
1062     // Restore the old addr mode info.
1063     AddrMode = BackupAddrMode;
1064     AddrModeInsts.resize(OldSize);
1065
1066     // Otherwise this was over-aggressive.  Try merging in the LHS then the RHS.
1067     if (MatchAddr(AddrInst->getOperand(0), Depth+1) &&
1068         MatchAddr(AddrInst->getOperand(1), Depth+1))
1069       return true;
1070
1071     // Otherwise we definitely can't merge the ADD in.
1072     AddrMode = BackupAddrMode;
1073     AddrModeInsts.resize(OldSize);
1074     break;
1075   }
1076   //case Instruction::Or:
1077   // TODO: We can handle "Or Val, Imm" iff this OR is equivalent to an ADD.
1078   //break;
1079   case Instruction::Mul:
1080   case Instruction::Shl: {
1081     // Can only handle X*C and X << C.
1082     ConstantInt *RHS = dyn_cast<ConstantInt>(AddrInst->getOperand(1));
1083     if (!RHS) return false;
1084     int64_t Scale = RHS->getSExtValue();
1085     if (Opcode == Instruction::Shl)
1086       Scale = 1LL << Scale;
1087
1088     return MatchScaledValue(AddrInst->getOperand(0), Scale, Depth);
1089   }
1090   case Instruction::GetElementPtr: {
1091     // Scan the GEP.  We check it if it contains constant offsets and at most
1092     // one variable offset.
1093     int VariableOperand = -1;
1094     unsigned VariableScale = 0;
1095
1096     int64_t ConstantOffset = 0;
1097     const DataLayout *TD = TLI.getDataLayout();
1098     gep_type_iterator GTI = gep_type_begin(AddrInst);
1099     for (unsigned i = 1, e = AddrInst->getNumOperands(); i != e; ++i, ++GTI) {
1100       if (StructType *STy = dyn_cast<StructType>(*GTI)) {
1101         const StructLayout *SL = TD->getStructLayout(STy);
1102         unsigned Idx =
1103           cast<ConstantInt>(AddrInst->getOperand(i))->getZExtValue();
1104         ConstantOffset += SL->getElementOffset(Idx);
1105       } else {
1106         uint64_t TypeSize = TD->getTypeAllocSize(GTI.getIndexedType());
1107         if (ConstantInt *CI = dyn_cast<ConstantInt>(AddrInst->getOperand(i))) {
1108           ConstantOffset += CI->getSExtValue()*TypeSize;
1109         } else if (TypeSize) {  // Scales of zero don't do anything.
1110           // We only allow one variable index at the moment.
1111           if (VariableOperand != -1)
1112             return false;
1113
1114           // Remember the variable index.
1115           VariableOperand = i;
1116           VariableScale = TypeSize;
1117         }
1118       }
1119     }
1120
1121     // A common case is for the GEP to only do a constant offset.  In this case,
1122     // just add it to the disp field and check validity.
1123     if (VariableOperand == -1) {
1124       AddrMode.BaseOffs += ConstantOffset;
1125       if (ConstantOffset == 0 || TLI.isLegalAddressingMode(AddrMode, AccessTy)){
1126         // Check to see if we can fold the base pointer in too.
1127         if (MatchAddr(AddrInst->getOperand(0), Depth+1))
1128           return true;
1129       }
1130       AddrMode.BaseOffs -= ConstantOffset;
1131       return false;
1132     }
1133
1134     // Save the valid addressing mode in case we can't match.
1135     ExtAddrMode BackupAddrMode = AddrMode;
1136     unsigned OldSize = AddrModeInsts.size();
1137
1138     // See if the scale and offset amount is valid for this target.
1139     AddrMode.BaseOffs += ConstantOffset;
1140
1141     // Match the base operand of the GEP.
1142     if (!MatchAddr(AddrInst->getOperand(0), Depth+1)) {
1143       // If it couldn't be matched, just stuff the value in a register.
1144       if (AddrMode.HasBaseReg) {
1145         AddrMode = BackupAddrMode;
1146         AddrModeInsts.resize(OldSize);
1147         return false;
1148       }
1149       AddrMode.HasBaseReg = true;
1150       AddrMode.BaseReg = AddrInst->getOperand(0);
1151     }
1152
1153     // Match the remaining variable portion of the GEP.
1154     if (!MatchScaledValue(AddrInst->getOperand(VariableOperand), VariableScale,
1155                           Depth)) {
1156       // If it couldn't be matched, try stuffing the base into a register
1157       // instead of matching it, and retrying the match of the scale.
1158       AddrMode = BackupAddrMode;
1159       AddrModeInsts.resize(OldSize);
1160       if (AddrMode.HasBaseReg)
1161         return false;
1162       AddrMode.HasBaseReg = true;
1163       AddrMode.BaseReg = AddrInst->getOperand(0);
1164       AddrMode.BaseOffs += ConstantOffset;
1165       if (!MatchScaledValue(AddrInst->getOperand(VariableOperand),
1166                             VariableScale, Depth)) {
1167         // If even that didn't work, bail.
1168         AddrMode = BackupAddrMode;
1169         AddrModeInsts.resize(OldSize);
1170         return false;
1171       }
1172     }
1173
1174     return true;
1175   }
1176   }
1177   return false;
1178 }
1179
1180 /// MatchAddr - If we can, try to add the value of 'Addr' into the current
1181 /// addressing mode.  If Addr can't be added to AddrMode this returns false and
1182 /// leaves AddrMode unmodified.  This assumes that Addr is either a pointer type
1183 /// or intptr_t for the target.
1184 ///
1185 bool AddressingModeMatcher::MatchAddr(Value *Addr, unsigned Depth) {
1186   if (ConstantInt *CI = dyn_cast<ConstantInt>(Addr)) {
1187     // Fold in immediates if legal for the target.
1188     AddrMode.BaseOffs += CI->getSExtValue();
1189     if (TLI.isLegalAddressingMode(AddrMode, AccessTy))
1190       return true;
1191     AddrMode.BaseOffs -= CI->getSExtValue();
1192   } else if (GlobalValue *GV = dyn_cast<GlobalValue>(Addr)) {
1193     // If this is a global variable, try to fold it into the addressing mode.
1194     if (AddrMode.BaseGV == 0) {
1195       AddrMode.BaseGV = GV;
1196       if (TLI.isLegalAddressingMode(AddrMode, AccessTy))
1197         return true;
1198       AddrMode.BaseGV = 0;
1199     }
1200   } else if (Instruction *I = dyn_cast<Instruction>(Addr)) {
1201     ExtAddrMode BackupAddrMode = AddrMode;
1202     unsigned OldSize = AddrModeInsts.size();
1203
1204     // Check to see if it is possible to fold this operation.
1205     if (MatchOperationAddr(I, I->getOpcode(), Depth)) {
1206       // Okay, it's possible to fold this.  Check to see if it is actually
1207       // *profitable* to do so.  We use a simple cost model to avoid increasing
1208       // register pressure too much.
1209       if (I->hasOneUse() ||
1210           IsProfitableToFoldIntoAddressingMode(I, BackupAddrMode, AddrMode)) {
1211         AddrModeInsts.push_back(I);
1212         return true;
1213       }
1214
1215       // It isn't profitable to do this, roll back.
1216       //cerr << "NOT FOLDING: " << *I;
1217       AddrMode = BackupAddrMode;
1218       AddrModeInsts.resize(OldSize);
1219     }
1220   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Addr)) {
1221     if (MatchOperationAddr(CE, CE->getOpcode(), Depth))
1222       return true;
1223   } else if (isa<ConstantPointerNull>(Addr)) {
1224     // Null pointer gets folded without affecting the addressing mode.
1225     return true;
1226   }
1227
1228   // Worse case, the target should support [reg] addressing modes. :)
1229   if (!AddrMode.HasBaseReg) {
1230     AddrMode.HasBaseReg = true;
1231     AddrMode.BaseReg = Addr;
1232     // Still check for legality in case the target supports [imm] but not [i+r].
1233     if (TLI.isLegalAddressingMode(AddrMode, AccessTy))
1234       return true;
1235     AddrMode.HasBaseReg = false;
1236     AddrMode.BaseReg = 0;
1237   }
1238
1239   // If the base register is already taken, see if we can do [r+r].
1240   if (AddrMode.Scale == 0) {
1241     AddrMode.Scale = 1;
1242     AddrMode.ScaledReg = Addr;
1243     if (TLI.isLegalAddressingMode(AddrMode, AccessTy))
1244       return true;
1245     AddrMode.Scale = 0;
1246     AddrMode.ScaledReg = 0;
1247   }
1248   // Couldn't match.
1249   return false;
1250 }
1251
1252 /// IsOperandAMemoryOperand - Check to see if all uses of OpVal by the specified
1253 /// inline asm call are due to memory operands.  If so, return true, otherwise
1254 /// return false.
1255 static bool IsOperandAMemoryOperand(CallInst *CI, InlineAsm *IA, Value *OpVal,
1256                                     const TargetLowering &TLI) {
1257   TargetLowering::AsmOperandInfoVector TargetConstraints = TLI.ParseConstraints(ImmutableCallSite(CI));
1258   for (unsigned i = 0, e = TargetConstraints.size(); i != e; ++i) {
1259     TargetLowering::AsmOperandInfo &OpInfo = TargetConstraints[i];
1260
1261     // Compute the constraint code and ConstraintType to use.
1262     TLI.ComputeConstraintToUse(OpInfo, SDValue());
1263
1264     // If this asm operand is our Value*, and if it isn't an indirect memory
1265     // operand, we can't fold it!
1266     if (OpInfo.CallOperandVal == OpVal &&
1267         (OpInfo.ConstraintType != TargetLowering::C_Memory ||
1268          !OpInfo.isIndirect))
1269       return false;
1270   }
1271
1272   return true;
1273 }
1274
1275 /// FindAllMemoryUses - Recursively walk all the uses of I until we find a
1276 /// memory use.  If we find an obviously non-foldable instruction, return true.
1277 /// Add the ultimately found memory instructions to MemoryUses.
1278 static bool FindAllMemoryUses(Instruction *I,
1279                 SmallVectorImpl<std::pair<Instruction*,unsigned> > &MemoryUses,
1280                               SmallPtrSet<Instruction*, 16> &ConsideredInsts,
1281                               const TargetLowering &TLI) {
1282   // If we already considered this instruction, we're done.
1283   if (!ConsideredInsts.insert(I))
1284     return false;
1285
1286   // If this is an obviously unfoldable instruction, bail out.
1287   if (!MightBeFoldableInst(I))
1288     return true;
1289
1290   // Loop over all the uses, recursively processing them.
1291   for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1292        UI != E; ++UI) {
1293     User *U = *UI;
1294
1295     if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
1296       MemoryUses.push_back(std::make_pair(LI, UI.getOperandNo()));
1297       continue;
1298     }
1299
1300     if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1301       unsigned opNo = UI.getOperandNo();
1302       if (opNo == 0) return true; // Storing addr, not into addr.
1303       MemoryUses.push_back(std::make_pair(SI, opNo));
1304       continue;
1305     }
1306
1307     if (CallInst *CI = dyn_cast<CallInst>(U)) {
1308       InlineAsm *IA = dyn_cast<InlineAsm>(CI->getCalledValue());
1309       if (!IA) return true;
1310
1311       // If this is a memory operand, we're cool, otherwise bail out.
1312       if (!IsOperandAMemoryOperand(CI, IA, I, TLI))
1313         return true;
1314       continue;
1315     }
1316
1317     if (FindAllMemoryUses(cast<Instruction>(U), MemoryUses, ConsideredInsts,
1318                           TLI))
1319       return true;
1320   }
1321
1322   return false;
1323 }
1324
1325 /// ValueAlreadyLiveAtInst - Retrn true if Val is already known to be live at
1326 /// the use site that we're folding it into.  If so, there is no cost to
1327 /// include it in the addressing mode.  KnownLive1 and KnownLive2 are two values
1328 /// that we know are live at the instruction already.
1329 bool AddressingModeMatcher::ValueAlreadyLiveAtInst(Value *Val,Value *KnownLive1,
1330                                                    Value *KnownLive2) {
1331   // If Val is either of the known-live values, we know it is live!
1332   if (Val == 0 || Val == KnownLive1 || Val == KnownLive2)
1333     return true;
1334
1335   // All values other than instructions and arguments (e.g. constants) are live.
1336   if (!isa<Instruction>(Val) && !isa<Argument>(Val)) return true;
1337
1338   // If Val is a constant sized alloca in the entry block, it is live, this is
1339   // true because it is just a reference to the stack/frame pointer, which is
1340   // live for the whole function.
1341   if (AllocaInst *AI = dyn_cast<AllocaInst>(Val))
1342     if (AI->isStaticAlloca())
1343       return true;
1344
1345   // Check to see if this value is already used in the memory instruction's
1346   // block.  If so, it's already live into the block at the very least, so we
1347   // can reasonably fold it.
1348   return Val->isUsedInBasicBlock(MemoryInst->getParent());
1349 }
1350
1351 /// IsProfitableToFoldIntoAddressingMode - It is possible for the addressing
1352 /// mode of the machine to fold the specified instruction into a load or store
1353 /// that ultimately uses it.  However, the specified instruction has multiple
1354 /// uses.  Given this, it may actually increase register pressure to fold it
1355 /// into the load.  For example, consider this code:
1356 ///
1357 ///     X = ...
1358 ///     Y = X+1
1359 ///     use(Y)   -> nonload/store
1360 ///     Z = Y+1
1361 ///     load Z
1362 ///
1363 /// In this case, Y has multiple uses, and can be folded into the load of Z
1364 /// (yielding load [X+2]).  However, doing this will cause both "X" and "X+1" to
1365 /// be live at the use(Y) line.  If we don't fold Y into load Z, we use one
1366 /// fewer register.  Since Y can't be folded into "use(Y)" we don't increase the
1367 /// number of computations either.
1368 ///
1369 /// Note that this (like most of CodeGenPrepare) is just a rough heuristic.  If
1370 /// X was live across 'load Z' for other reasons, we actually *would* want to
1371 /// fold the addressing mode in the Z case.  This would make Y die earlier.
1372 bool AddressingModeMatcher::
1373 IsProfitableToFoldIntoAddressingMode(Instruction *I, ExtAddrMode &AMBefore,
1374                                      ExtAddrMode &AMAfter) {
1375   if (IgnoreProfitability) return true;
1376
1377   // AMBefore is the addressing mode before this instruction was folded into it,
1378   // and AMAfter is the addressing mode after the instruction was folded.  Get
1379   // the set of registers referenced by AMAfter and subtract out those
1380   // referenced by AMBefore: this is the set of values which folding in this
1381   // address extends the lifetime of.
1382   //
1383   // Note that there are only two potential values being referenced here,
1384   // BaseReg and ScaleReg (global addresses are always available, as are any
1385   // folded immediates).
1386   Value *BaseReg = AMAfter.BaseReg, *ScaledReg = AMAfter.ScaledReg;
1387
1388   // If the BaseReg or ScaledReg was referenced by the previous addrmode, their
1389   // lifetime wasn't extended by adding this instruction.
1390   if (ValueAlreadyLiveAtInst(BaseReg, AMBefore.BaseReg, AMBefore.ScaledReg))
1391     BaseReg = 0;
1392   if (ValueAlreadyLiveAtInst(ScaledReg, AMBefore.BaseReg, AMBefore.ScaledReg))
1393     ScaledReg = 0;
1394
1395   // If folding this instruction (and it's subexprs) didn't extend any live
1396   // ranges, we're ok with it.
1397   if (BaseReg == 0 && ScaledReg == 0)
1398     return true;
1399
1400   // If all uses of this instruction are ultimately load/store/inlineasm's,
1401   // check to see if their addressing modes will include this instruction.  If
1402   // so, we can fold it into all uses, so it doesn't matter if it has multiple
1403   // uses.
1404   SmallVector<std::pair<Instruction*,unsigned>, 16> MemoryUses;
1405   SmallPtrSet<Instruction*, 16> ConsideredInsts;
1406   if (FindAllMemoryUses(I, MemoryUses, ConsideredInsts, TLI))
1407     return false;  // Has a non-memory, non-foldable use!
1408
1409   // Now that we know that all uses of this instruction are part of a chain of
1410   // computation involving only operations that could theoretically be folded
1411   // into a memory use, loop over each of these uses and see if they could
1412   // *actually* fold the instruction.
1413   SmallVector<Instruction*, 32> MatchedAddrModeInsts;
1414   for (unsigned i = 0, e = MemoryUses.size(); i != e; ++i) {
1415     Instruction *User = MemoryUses[i].first;
1416     unsigned OpNo = MemoryUses[i].second;
1417
1418     // Get the access type of this use.  If the use isn't a pointer, we don't
1419     // know what it accesses.
1420     Value *Address = User->getOperand(OpNo);
1421     if (!Address->getType()->isPointerTy())
1422       return false;
1423     Type *AddressAccessTy = Address->getType()->getPointerElementType();
1424
1425     // Do a match against the root of this address, ignoring profitability. This
1426     // will tell us if the addressing mode for the memory operation will
1427     // *actually* cover the shared instruction.
1428     ExtAddrMode Result;
1429     AddressingModeMatcher Matcher(MatchedAddrModeInsts, TLI, AddressAccessTy,
1430                                   MemoryInst, Result);
1431     Matcher.IgnoreProfitability = true;
1432     bool Success = Matcher.MatchAddr(Address, 0);
1433     (void)Success; assert(Success && "Couldn't select *anything*?");
1434
1435     // If the match didn't cover I, then it won't be shared by it.
1436     if (std::find(MatchedAddrModeInsts.begin(), MatchedAddrModeInsts.end(),
1437                   I) == MatchedAddrModeInsts.end())
1438       return false;
1439
1440     MatchedAddrModeInsts.clear();
1441   }
1442
1443   return true;
1444 }
1445
1446 } // end anonymous namespace
1447
1448 /// IsNonLocalValue - Return true if the specified values are defined in a
1449 /// different basic block than BB.
1450 static bool IsNonLocalValue(Value *V, BasicBlock *BB) {
1451   if (Instruction *I = dyn_cast<Instruction>(V))
1452     return I->getParent() != BB;
1453   return false;
1454 }
1455
1456 /// OptimizeMemoryInst - Load and Store Instructions often have
1457 /// addressing modes that can do significant amounts of computation.  As such,
1458 /// instruction selection will try to get the load or store to do as much
1459 /// computation as possible for the program.  The problem is that isel can only
1460 /// see within a single block.  As such, we sink as much legal addressing mode
1461 /// stuff into the block as possible.
1462 ///
1463 /// This method is used to optimize both load/store and inline asms with memory
1464 /// operands.
1465 bool CodeGenPrepare::OptimizeMemoryInst(Instruction *MemoryInst, Value *Addr,
1466                                         Type *AccessTy) {
1467   Value *Repl = Addr;
1468
1469   // Try to collapse single-value PHI nodes.  This is necessary to undo
1470   // unprofitable PRE transformations.
1471   SmallVector<Value*, 8> worklist;
1472   SmallPtrSet<Value*, 16> Visited;
1473   worklist.push_back(Addr);
1474
1475   // Use a worklist to iteratively look through PHI nodes, and ensure that
1476   // the addressing mode obtained from the non-PHI roots of the graph
1477   // are equivalent.
1478   Value *Consensus = 0;
1479   unsigned NumUsesConsensus = 0;
1480   bool IsNumUsesConsensusValid = false;
1481   SmallVector<Instruction*, 16> AddrModeInsts;
1482   ExtAddrMode AddrMode;
1483   while (!worklist.empty()) {
1484     Value *V = worklist.back();
1485     worklist.pop_back();
1486
1487     // Break use-def graph loops.
1488     if (!Visited.insert(V)) {
1489       Consensus = 0;
1490       break;
1491     }
1492
1493     // For a PHI node, push all of its incoming values.
1494     if (PHINode *P = dyn_cast<PHINode>(V)) {
1495       for (unsigned i = 0, e = P->getNumIncomingValues(); i != e; ++i)
1496         worklist.push_back(P->getIncomingValue(i));
1497       continue;
1498     }
1499
1500     // For non-PHIs, determine the addressing mode being computed.
1501     SmallVector<Instruction*, 16> NewAddrModeInsts;
1502     ExtAddrMode NewAddrMode =
1503       AddressingModeMatcher::Match(V, AccessTy, MemoryInst,
1504                                    NewAddrModeInsts, *TLI);
1505
1506     // This check is broken into two cases with very similar code to avoid using
1507     // getNumUses() as much as possible. Some values have a lot of uses, so
1508     // calling getNumUses() unconditionally caused a significant compile-time
1509     // regression.
1510     if (!Consensus) {
1511       Consensus = V;
1512       AddrMode = NewAddrMode;
1513       AddrModeInsts = NewAddrModeInsts;
1514       continue;
1515     } else if (NewAddrMode == AddrMode) {
1516       if (!IsNumUsesConsensusValid) {
1517         NumUsesConsensus = Consensus->getNumUses();
1518         IsNumUsesConsensusValid = true;
1519       }
1520
1521       // Ensure that the obtained addressing mode is equivalent to that obtained
1522       // for all other roots of the PHI traversal.  Also, when choosing one
1523       // such root as representative, select the one with the most uses in order
1524       // to keep the cost modeling heuristics in AddressingModeMatcher
1525       // applicable.
1526       unsigned NumUses = V->getNumUses();
1527       if (NumUses > NumUsesConsensus) {
1528         Consensus = V;
1529         NumUsesConsensus = NumUses;
1530         AddrModeInsts = NewAddrModeInsts;
1531       }
1532       continue;
1533     }
1534
1535     Consensus = 0;
1536     break;
1537   }
1538
1539   // If the addressing mode couldn't be determined, or if multiple different
1540   // ones were determined, bail out now.
1541   if (!Consensus) return false;
1542
1543   // Check to see if any of the instructions supersumed by this addr mode are
1544   // non-local to I's BB.
1545   bool AnyNonLocal = false;
1546   for (unsigned i = 0, e = AddrModeInsts.size(); i != e; ++i) {
1547     if (IsNonLocalValue(AddrModeInsts[i], MemoryInst->getParent())) {
1548       AnyNonLocal = true;
1549       break;
1550     }
1551   }
1552
1553   // If all the instructions matched are already in this BB, don't do anything.
1554   if (!AnyNonLocal) {
1555     DEBUG(dbgs() << "CGP: Found      local addrmode: " << AddrMode << "\n");
1556     return false;
1557   }
1558
1559   // Insert this computation right after this user.  Since our caller is
1560   // scanning from the top of the BB to the bottom, reuse of the expr are
1561   // guaranteed to happen later.
1562   IRBuilder<> Builder(MemoryInst);
1563
1564   // Now that we determined the addressing expression we want to use and know
1565   // that we have to sink it into this block.  Check to see if we have already
1566   // done this for some other load/store instr in this block.  If so, reuse the
1567   // computation.
1568   Value *&SunkAddr = SunkAddrs[Addr];
1569   if (SunkAddr) {
1570     DEBUG(dbgs() << "CGP: Reusing nonlocal addrmode: " << AddrMode << " for "
1571                  << *MemoryInst);
1572     if (SunkAddr->getType() != Addr->getType())
1573       SunkAddr = Builder.CreateBitCast(SunkAddr, Addr->getType());
1574   } else {
1575     DEBUG(dbgs() << "CGP: SINKING nonlocal addrmode: " << AddrMode << " for "
1576                  << *MemoryInst);
1577     Type *IntPtrTy = TLI->getDataLayout()->getIntPtrType(Addr->getType());
1578     Value *Result = 0;
1579
1580     // Start with the base register. Do this first so that subsequent address
1581     // matching finds it last, which will prevent it from trying to match it
1582     // as the scaled value in case it happens to be a mul. That would be
1583     // problematic if we've sunk a different mul for the scale, because then
1584     // we'd end up sinking both muls.
1585     if (AddrMode.BaseReg) {
1586       Value *V = AddrMode.BaseReg;
1587       if (V->getType()->isPointerTy())
1588         V = Builder.CreatePtrToInt(V, IntPtrTy, "sunkaddr");
1589       if (V->getType() != IntPtrTy)
1590         V = Builder.CreateIntCast(V, IntPtrTy, /*isSigned=*/true, "sunkaddr");
1591       Result = V;
1592     }
1593
1594     // Add the scale value.
1595     if (AddrMode.Scale) {
1596       Value *V = AddrMode.ScaledReg;
1597       if (V->getType() == IntPtrTy) {
1598         // done.
1599       } else if (V->getType()->isPointerTy()) {
1600         V = Builder.CreatePtrToInt(V, IntPtrTy, "sunkaddr");
1601       } else if (cast<IntegerType>(IntPtrTy)->getBitWidth() <
1602                  cast<IntegerType>(V->getType())->getBitWidth()) {
1603         V = Builder.CreateTrunc(V, IntPtrTy, "sunkaddr");
1604       } else {
1605         V = Builder.CreateSExt(V, IntPtrTy, "sunkaddr");
1606       }
1607       if (AddrMode.Scale != 1)
1608         V = Builder.CreateMul(V, ConstantInt::get(IntPtrTy, AddrMode.Scale),
1609                               "sunkaddr");
1610       if (Result)
1611         Result = Builder.CreateAdd(Result, V, "sunkaddr");
1612       else
1613         Result = V;
1614     }
1615
1616     // Add in the BaseGV if present.
1617     if (AddrMode.BaseGV) {
1618       Value *V = Builder.CreatePtrToInt(AddrMode.BaseGV, IntPtrTy, "sunkaddr");
1619       if (Result)
1620         Result = Builder.CreateAdd(Result, V, "sunkaddr");
1621       else
1622         Result = V;
1623     }
1624
1625     // Add in the Base Offset if present.
1626     if (AddrMode.BaseOffs) {
1627       Value *V = ConstantInt::get(IntPtrTy, AddrMode.BaseOffs);
1628       if (Result)
1629         Result = Builder.CreateAdd(Result, V, "sunkaddr");
1630       else
1631         Result = V;
1632     }
1633
1634     if (Result == 0)
1635       SunkAddr = Constant::getNullValue(Addr->getType());
1636     else
1637       SunkAddr = Builder.CreateIntToPtr(Result, Addr->getType(), "sunkaddr");
1638   }
1639
1640   MemoryInst->replaceUsesOfWith(Repl, SunkAddr);
1641
1642   // If we have no uses, recursively delete the value and all dead instructions
1643   // using it.
1644   if (Repl->use_empty()) {
1645     // This can cause recursive deletion, which can invalidate our iterator.
1646     // Use a WeakVH to hold onto it in case this happens.
1647     WeakVH IterHandle(CurInstIterator);
1648     BasicBlock *BB = CurInstIterator->getParent();
1649
1650     RecursivelyDeleteTriviallyDeadInstructions(Repl, TLInfo);
1651
1652     if (IterHandle != CurInstIterator) {
1653       // If the iterator instruction was recursively deleted, start over at the
1654       // start of the block.
1655       CurInstIterator = BB->begin();
1656       SunkAddrs.clear();
1657     }
1658   }
1659   ++NumMemoryInsts;
1660   return true;
1661 }
1662
1663 /// OptimizeInlineAsmInst - If there are any memory operands, use
1664 /// OptimizeMemoryInst to sink their address computing into the block when
1665 /// possible / profitable.
1666 bool CodeGenPrepare::OptimizeInlineAsmInst(CallInst *CS) {
1667   bool MadeChange = false;
1668
1669   TargetLowering::AsmOperandInfoVector
1670     TargetConstraints = TLI->ParseConstraints(CS);
1671   unsigned ArgNo = 0;
1672   for (unsigned i = 0, e = TargetConstraints.size(); i != e; ++i) {
1673     TargetLowering::AsmOperandInfo &OpInfo = TargetConstraints[i];
1674
1675     // Compute the constraint code and ConstraintType to use.
1676     TLI->ComputeConstraintToUse(OpInfo, SDValue());
1677
1678     if (OpInfo.ConstraintType == TargetLowering::C_Memory &&
1679         OpInfo.isIndirect) {
1680       Value *OpVal = CS->getArgOperand(ArgNo++);
1681       MadeChange |= OptimizeMemoryInst(CS, OpVal, OpVal->getType());
1682     } else if (OpInfo.Type == InlineAsm::isInput)
1683       ArgNo++;
1684   }
1685
1686   return MadeChange;
1687 }
1688
1689 /// MoveExtToFormExtLoad - Move a zext or sext fed by a load into the same
1690 /// basic block as the load, unless conditions are unfavorable. This allows
1691 /// SelectionDAG to fold the extend into the load.
1692 ///
1693 bool CodeGenPrepare::MoveExtToFormExtLoad(Instruction *I) {
1694   // Look for a load being extended.
1695   LoadInst *LI = dyn_cast<LoadInst>(I->getOperand(0));
1696   if (!LI) return false;
1697
1698   // If they're already in the same block, there's nothing to do.
1699   if (LI->getParent() == I->getParent())
1700     return false;
1701
1702   // If the load has other users and the truncate is not free, this probably
1703   // isn't worthwhile.
1704   if (!LI->hasOneUse() &&
1705       TLI && (TLI->isTypeLegal(TLI->getValueType(LI->getType())) ||
1706               !TLI->isTypeLegal(TLI->getValueType(I->getType()))) &&
1707       !TLI->isTruncateFree(I->getType(), LI->getType()))
1708     return false;
1709
1710   // Check whether the target supports casts folded into loads.
1711   unsigned LType;
1712   if (isa<ZExtInst>(I))
1713     LType = ISD::ZEXTLOAD;
1714   else {
1715     assert(isa<SExtInst>(I) && "Unexpected ext type!");
1716     LType = ISD::SEXTLOAD;
1717   }
1718   if (TLI && !TLI->isLoadExtLegal(LType, TLI->getValueType(LI->getType())))
1719     return false;
1720
1721   // Move the extend into the same block as the load, so that SelectionDAG
1722   // can fold it.
1723   I->removeFromParent();
1724   I->insertAfter(LI);
1725   ++NumExtsMoved;
1726   return true;
1727 }
1728
1729 bool CodeGenPrepare::OptimizeExtUses(Instruction *I) {
1730   BasicBlock *DefBB = I->getParent();
1731
1732   // If the result of a {s|z}ext and its source are both live out, rewrite all
1733   // other uses of the source with result of extension.
1734   Value *Src = I->getOperand(0);
1735   if (Src->hasOneUse())
1736     return false;
1737
1738   // Only do this xform if truncating is free.
1739   if (TLI && !TLI->isTruncateFree(I->getType(), Src->getType()))
1740     return false;
1741
1742   // Only safe to perform the optimization if the source is also defined in
1743   // this block.
1744   if (!isa<Instruction>(Src) || DefBB != cast<Instruction>(Src)->getParent())
1745     return false;
1746
1747   bool DefIsLiveOut = false;
1748   for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1749        UI != E; ++UI) {
1750     Instruction *User = cast<Instruction>(*UI);
1751
1752     // Figure out which BB this ext is used in.
1753     BasicBlock *UserBB = User->getParent();
1754     if (UserBB == DefBB) continue;
1755     DefIsLiveOut = true;
1756     break;
1757   }
1758   if (!DefIsLiveOut)
1759     return false;
1760
1761   // Make sure none of the uses are PHI nodes.
1762   for (Value::use_iterator UI = Src->use_begin(), E = Src->use_end();
1763        UI != E; ++UI) {
1764     Instruction *User = cast<Instruction>(*UI);
1765     BasicBlock *UserBB = User->getParent();
1766     if (UserBB == DefBB) continue;
1767     // Be conservative. We don't want this xform to end up introducing
1768     // reloads just before load / store instructions.
1769     if (isa<PHINode>(User) || isa<LoadInst>(User) || isa<StoreInst>(User))
1770       return false;
1771   }
1772
1773   // InsertedTruncs - Only insert one trunc in each block once.
1774   DenseMap<BasicBlock*, Instruction*> InsertedTruncs;
1775
1776   bool MadeChange = false;
1777   for (Value::use_iterator UI = Src->use_begin(), E = Src->use_end();
1778        UI != E; ++UI) {
1779     Use &TheUse = UI.getUse();
1780     Instruction *User = cast<Instruction>(*UI);
1781
1782     // Figure out which BB this ext is used in.
1783     BasicBlock *UserBB = User->getParent();
1784     if (UserBB == DefBB) continue;
1785
1786     // Both src and def are live in this block. Rewrite the use.
1787     Instruction *&InsertedTrunc = InsertedTruncs[UserBB];
1788
1789     if (!InsertedTrunc) {
1790       BasicBlock::iterator InsertPt = UserBB->getFirstInsertionPt();
1791       InsertedTrunc = new TruncInst(I, Src->getType(), "", InsertPt);
1792     }
1793
1794     // Replace a use of the {s|z}ext source with a use of the result.
1795     TheUse = InsertedTrunc;
1796     ++NumExtUses;
1797     MadeChange = true;
1798   }
1799
1800   return MadeChange;
1801 }
1802
1803 /// isFormingBranchFromSelectProfitable - Returns true if a SelectInst should be
1804 /// turned into an explicit branch.
1805 static bool isFormingBranchFromSelectProfitable(SelectInst *SI) {
1806   // FIXME: This should use the same heuristics as IfConversion to determine
1807   // whether a select is better represented as a branch.  This requires that
1808   // branch probability metadata is preserved for the select, which is not the
1809   // case currently.
1810
1811   CmpInst *Cmp = dyn_cast<CmpInst>(SI->getCondition());
1812
1813   // If the branch is predicted right, an out of order CPU can avoid blocking on
1814   // the compare.  Emit cmovs on compares with a memory operand as branches to
1815   // avoid stalls on the load from memory.  If the compare has more than one use
1816   // there's probably another cmov or setcc around so it's not worth emitting a
1817   // branch.
1818   if (!Cmp)
1819     return false;
1820
1821   Value *CmpOp0 = Cmp->getOperand(0);
1822   Value *CmpOp1 = Cmp->getOperand(1);
1823
1824   // We check that the memory operand has one use to avoid uses of the loaded
1825   // value directly after the compare, making branches unprofitable.
1826   return Cmp->hasOneUse() &&
1827          ((isa<LoadInst>(CmpOp0) && CmpOp0->hasOneUse()) ||
1828           (isa<LoadInst>(CmpOp1) && CmpOp1->hasOneUse()));
1829 }
1830
1831
1832 /// If we have a SelectInst that will likely profit from branch prediction,
1833 /// turn it into a branch.
1834 bool CodeGenPrepare::OptimizeSelectInst(SelectInst *SI) {
1835   bool VectorCond = !SI->getCondition()->getType()->isIntegerTy(1);
1836
1837   // Can we convert the 'select' to CF ?
1838   if (DisableSelectToBranch || OptSize || !TLI || VectorCond)
1839     return false;
1840
1841   TargetLowering::SelectSupportKind SelectKind;
1842   if (VectorCond)
1843     SelectKind = TargetLowering::VectorMaskSelect;
1844   else if (SI->getType()->isVectorTy())
1845     SelectKind = TargetLowering::ScalarCondVectorVal;
1846   else
1847     SelectKind = TargetLowering::ScalarValSelect;
1848
1849   // Do we have efficient codegen support for this kind of 'selects' ?
1850   if (TLI->isSelectSupported(SelectKind)) {
1851     // We have efficient codegen support for the select instruction.
1852     // Check if it is profitable to keep this 'select'.
1853     if (!TLI->isPredictableSelectExpensive() ||
1854         !isFormingBranchFromSelectProfitable(SI))
1855       return false;
1856   }
1857
1858   ModifiedDT = true;
1859
1860   // First, we split the block containing the select into 2 blocks.
1861   BasicBlock *StartBlock = SI->getParent();
1862   BasicBlock::iterator SplitPt = ++(BasicBlock::iterator(SI));
1863   BasicBlock *NextBlock = StartBlock->splitBasicBlock(SplitPt, "select.end");
1864
1865   // Create a new block serving as the landing pad for the branch.
1866   BasicBlock *SmallBlock = BasicBlock::Create(SI->getContext(), "select.mid",
1867                                              NextBlock->getParent(), NextBlock);
1868
1869   // Move the unconditional branch from the block with the select in it into our
1870   // landing pad block.
1871   StartBlock->getTerminator()->eraseFromParent();
1872   BranchInst::Create(NextBlock, SmallBlock);
1873
1874   // Insert the real conditional branch based on the original condition.
1875   BranchInst::Create(NextBlock, SmallBlock, SI->getCondition(), SI);
1876
1877   // The select itself is replaced with a PHI Node.
1878   PHINode *PN = PHINode::Create(SI->getType(), 2, "", NextBlock->begin());
1879   PN->takeName(SI);
1880   PN->addIncoming(SI->getTrueValue(), StartBlock);
1881   PN->addIncoming(SI->getFalseValue(), SmallBlock);
1882   SI->replaceAllUsesWith(PN);
1883   SI->eraseFromParent();
1884
1885   // Instruct OptimizeBlock to skip to the next block.
1886   CurInstIterator = StartBlock->end();
1887   ++NumSelectsExpanded;
1888   return true;
1889 }
1890
1891 bool CodeGenPrepare::OptimizeInst(Instruction *I) {
1892   if (PHINode *P = dyn_cast<PHINode>(I)) {
1893     // It is possible for very late stage optimizations (such as SimplifyCFG)
1894     // to introduce PHI nodes too late to be cleaned up.  If we detect such a
1895     // trivial PHI, go ahead and zap it here.
1896     if (Value *V = SimplifyInstruction(P, TLI ? TLI->getDataLayout() : 0,
1897                                        TLInfo, DT)) {
1898       P->replaceAllUsesWith(V);
1899       P->eraseFromParent();
1900       ++NumPHIsElim;
1901       return true;
1902     }
1903     return false;
1904   }
1905
1906   if (CastInst *CI = dyn_cast<CastInst>(I)) {
1907     // If the source of the cast is a constant, then this should have
1908     // already been constant folded.  The only reason NOT to constant fold
1909     // it is if something (e.g. LSR) was careful to place the constant
1910     // evaluation in a block other than then one that uses it (e.g. to hoist
1911     // the address of globals out of a loop).  If this is the case, we don't
1912     // want to forward-subst the cast.
1913     if (isa<Constant>(CI->getOperand(0)))
1914       return false;
1915
1916     if (TLI && OptimizeNoopCopyExpression(CI, *TLI))
1917       return true;
1918
1919     if (isa<ZExtInst>(I) || isa<SExtInst>(I)) {
1920       bool MadeChange = MoveExtToFormExtLoad(I);
1921       return MadeChange | OptimizeExtUses(I);
1922     }
1923     return false;
1924   }
1925
1926   if (CmpInst *CI = dyn_cast<CmpInst>(I))
1927     if (!TLI || !TLI->hasMultipleConditionRegisters())
1928       return OptimizeCmpExpression(CI);
1929
1930   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
1931     if (TLI)
1932       return OptimizeMemoryInst(I, I->getOperand(0), LI->getType());
1933     return false;
1934   }
1935
1936   if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
1937     if (TLI)
1938       return OptimizeMemoryInst(I, SI->getOperand(1),
1939                                 SI->getOperand(0)->getType());
1940     return false;
1941   }
1942
1943   if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
1944     if (GEPI->hasAllZeroIndices()) {
1945       /// The GEP operand must be a pointer, so must its result -> BitCast
1946       Instruction *NC = new BitCastInst(GEPI->getOperand(0), GEPI->getType(),
1947                                         GEPI->getName(), GEPI);
1948       GEPI->replaceAllUsesWith(NC);
1949       GEPI->eraseFromParent();
1950       ++NumGEPsElim;
1951       OptimizeInst(NC);
1952       return true;
1953     }
1954     return false;
1955   }
1956
1957   if (CallInst *CI = dyn_cast<CallInst>(I))
1958     return OptimizeCallInst(CI);
1959
1960   if (SelectInst *SI = dyn_cast<SelectInst>(I))
1961     return OptimizeSelectInst(SI);
1962
1963   return false;
1964 }
1965
1966 // In this pass we look for GEP and cast instructions that are used
1967 // across basic blocks and rewrite them to improve basic-block-at-a-time
1968 // selection.
1969 bool CodeGenPrepare::OptimizeBlock(BasicBlock &BB) {
1970   SunkAddrs.clear();
1971   bool MadeChange = false;
1972
1973   CurInstIterator = BB.begin();
1974   while (CurInstIterator != BB.end())
1975     MadeChange |= OptimizeInst(CurInstIterator++);
1976
1977   MadeChange |= DupRetToEnableTailCallOpts(&BB);
1978
1979   return MadeChange;
1980 }
1981
1982 // llvm.dbg.value is far away from the value then iSel may not be able
1983 // handle it properly. iSel will drop llvm.dbg.value if it can not
1984 // find a node corresponding to the value.
1985 bool CodeGenPrepare::PlaceDbgValues(Function &F) {
1986   bool MadeChange = false;
1987   for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I) {
1988     Instruction *PrevNonDbgInst = NULL;
1989     for (BasicBlock::iterator BI = I->begin(), BE = I->end(); BI != BE;) {
1990       Instruction *Insn = BI; ++BI;
1991       DbgValueInst *DVI = dyn_cast<DbgValueInst>(Insn);
1992       if (!DVI) {
1993         PrevNonDbgInst = Insn;
1994         continue;
1995       }
1996
1997       Instruction *VI = dyn_cast_or_null<Instruction>(DVI->getValue());
1998       if (VI && VI != PrevNonDbgInst && !VI->isTerminator()) {
1999         DEBUG(dbgs() << "Moving Debug Value before :\n" << *DVI << ' ' << *VI);
2000         DVI->removeFromParent();
2001         if (isa<PHINode>(VI))
2002           DVI->insertBefore(VI->getParent()->getFirstInsertionPt());
2003         else
2004           DVI->insertAfter(VI);
2005         MadeChange = true;
2006         ++NumDbgValueMoved;
2007       }
2008     }
2009   }
2010   return MadeChange;
2011 }