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