lib/CodeGen/MachineLICM.cpp

   1 //===-- MachineLICM.cpp - Machine Loop Invariant Code Motion Pass ---------===//
   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 performs loop invariant code motion on machine instructions. We
  11 // attempt to remove as much code from the body of a loop as possible.
  12 //
  13 // This pass does not attempt to throttle itself to limit register pressure.
  14 // The register allocation phases are expected to perform rematerialization
  15 // to recover when register pressure is high.
  16 //
  17 // This pass is not intended to be a replacement or a complete alternative
  18 // for the LLVM-IR-level LICM pass. It is only designed to hoist simple
  19 // constructs that are not exposed before lowering and instruction selection.
  20 //
  21 //===----------------------------------------------------------------------===//
  22
  23 #define DEBUG_TYPE "machine-licm"
  24 #include "llvm/CodeGen/Passes.h"
  25 #include "llvm/CodeGen/MachineDominators.h"
  26 #include "llvm/CodeGen/MachineFrameInfo.h"
  27 #include "llvm/CodeGen/MachineLoopInfo.h"
  28 #include "llvm/CodeGen/MachineMemOperand.h"
  29 #include "llvm/CodeGen/MachineRegisterInfo.h"
  30 #include "llvm/CodeGen/PseudoSourceValue.h"
  31 #include "llvm/Target/TargetRegisterInfo.h"
  32 #include "llvm/Target/TargetInstrInfo.h"
  33 #include "llvm/Target/TargetMachine.h"
  34 #include "llvm/Analysis/AliasAnalysis.h"
  35 #include "llvm/ADT/DenseMap.h"
  36 #include "llvm/ADT/SmallSet.h"
  37 #include "llvm/ADT/Statistic.h"
  38 #include "llvm/Support/Debug.h"
  39 #include "llvm/Support/raw_ostream.h"
  40
  41 using namespace llvm;
  42
  43 STATISTIC(NumHoisted, "Number of machine instructions hoisted out of loops");
  44 STATISTIC(NumCSEed,   "Number of hoisted machine instructions CSEed");
  45 STATISTIC(NumPostRAHoisted,
  46           "Number of machine instructions hoisted out of loops post regalloc");
  47
  48 namespace {
  49   class MachineLICM : public MachineFunctionPass {
  50     bool PreRegAlloc;
  51
  52     const TargetMachine   *TM;
  53     const TargetInstrInfo *TII;
  54     const TargetRegisterInfo *TRI;
  55     const MachineFrameInfo *MFI;
  56     MachineRegisterInfo *RegInfo;
  57
  58     // Various analyses that we use...
  59     AliasAnalysis        *AA;      // Alias analysis info.
  60     MachineLoopInfo      *MLI;     // Current MachineLoopInfo
  61     MachineDominatorTree *DT;      // Machine dominator tree for the cur loop
  62
  63     // State that is updated as we process loops
  64     bool         Changed;          // True if a loop is changed.
  65     bool         FirstInLoop;      // True if it's the first LICM in the loop.
  66     MachineLoop *CurLoop;          // The current loop we are working on.
  67     MachineBasicBlock *CurPreheader; // The preheader for CurLoop.
  68
  69     BitVector AllocatableSet;
  70
  71     // For each opcode, keep a list of potential CSE instructions.
  72     DenseMap<unsigned, std::vector<const MachineInstr*> > CSEMap;
  73
  74   public:
  75     static char ID; // Pass identification, replacement for typeid
  76     MachineLICM() :
  77       MachineFunctionPass(ID), PreRegAlloc(true) {}
  78
  79     explicit MachineLICM(bool PreRA) :
  80       MachineFunctionPass(ID), PreRegAlloc(PreRA) {}
  81
  82     virtual bool runOnMachineFunction(MachineFunction &MF);
  83
  84     const char *getPassName() const { return "Machine Instruction LICM"; }
  85
  86     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  87       AU.setPreservesCFG();
  88       AU.addRequired<MachineLoopInfo>();
  89       AU.addRequired<MachineDominatorTree>();
  90       AU.addRequired<AliasAnalysis>();
  91       AU.addPreserved<MachineLoopInfo>();
  92       AU.addPreserved<MachineDominatorTree>();
  93       MachineFunctionPass::getAnalysisUsage(AU);
  94     }
  95
  96     virtual void releaseMemory() {
  97       CSEMap.clear();
  98     }
  99
 100   private:
 101     /// CandidateInfo - Keep track of information about hoisting candidates.
 102     struct CandidateInfo {
 103       MachineInstr *MI;
 104       unsigned      Def;
 105       int           FI;
 106       CandidateInfo(MachineInstr *mi, unsigned def, int fi)
 107         : MI(mi), Def(def), FI(fi) {}
 108     };
 109
 110     /// HoistRegionPostRA - Walk the specified region of the CFG and hoist loop
 111     /// invariants out to the preheader.
 112     void HoistRegionPostRA();
 113
 114     /// HoistPostRA - When an instruction is found to only use loop invariant
 115     /// operands that is safe to hoist, this instruction is called to do the
 116     /// dirty work.
 117     void HoistPostRA(MachineInstr *MI, unsigned Def);
 118
 119     /// ProcessMI - Examine the instruction for potentai LICM candidate. Also
 120     /// gather register def and frame object update information.
 121     void ProcessMI(MachineInstr *MI, unsigned *PhysRegDefs,
 122                    SmallSet<int, 32> &StoredFIs,
 123                    SmallVector<CandidateInfo, 32> &Candidates);
 124
 125     /// AddToLiveIns - Add register 'Reg' to the livein sets of BBs in the
 126     /// current loop.
 127     void AddToLiveIns(unsigned Reg);
 128
 129     /// IsLICMCandidate - Returns true if the instruction may be a suitable
 130     /// candidate for LICM. e.g. If the instruction is a call, then it's
 131     /// obviously not safe to hoist it.
 132     bool IsLICMCandidate(MachineInstr &I);
 133
 134     /// IsLoopInvariantInst - Returns true if the instruction is loop
 135     /// invariant. I.e., all virtual register operands are defined outside of
 136     /// the loop, physical registers aren't accessed (explicitly or implicitly),
 137     /// and the instruction is hoistable.
 138     ///
 139     bool IsLoopInvariantInst(MachineInstr &I);
 140
 141     /// IsProfitableToHoist - Return true if it is potentially profitable to
 142     /// hoist the given loop invariant.
 143     bool IsProfitableToHoist(MachineInstr &MI);
 144
 145     /// HoistRegion - Walk the specified region of the CFG (defined by all
 146     /// blocks dominated by the specified block, and that are in the current
 147     /// loop) in depth first order w.r.t the DominatorTree. This allows us to
 148     /// visit definitions before uses, allowing us to hoist a loop body in one
 149     /// pass without iteration.
 150     ///
 151     void HoistRegion(MachineDomTreeNode *N);
 152
 153     /// isLoadFromConstantMemory - Return true if the given instruction is a
 154     /// load from constant memory.
 155     bool isLoadFromConstantMemory(MachineInstr *MI);
 156
 157     /// ExtractHoistableLoad - Unfold a load from the given machineinstr if
 158     /// the load itself could be hoisted. Return the unfolded and hoistable
 159     /// load, or null if the load couldn't be unfolded or if it wouldn't
 160     /// be hoistable.
 161     MachineInstr *ExtractHoistableLoad(MachineInstr *MI);
 162
 163     /// LookForDuplicate - Find an instruction amount PrevMIs that is a
 164     /// duplicate of MI. Return this instruction if it's found.
 165     const MachineInstr *LookForDuplicate(const MachineInstr *MI,
 166                                      std::vector<const MachineInstr*> &PrevMIs);
 167
 168     /// EliminateCSE - Given a LICM'ed instruction, look for an instruction on
 169     /// the preheader that compute the same value. If it's found, do a RAU on
 170     /// with the definition of the existing instruction rather than hoisting
 171     /// the instruction to the preheader.
 172     bool EliminateCSE(MachineInstr *MI,
 173            DenseMap<unsigned, std::vector<const MachineInstr*> >::iterator &CI);
 174
 175     /// Hoist - When an instruction is found to only use loop invariant operands
 176     /// that is safe to hoist, this instruction is called to do the dirty work.
 177     ///
 178     void Hoist(MachineInstr *MI);
 179
 180     /// InitCSEMap - Initialize the CSE map with instructions that are in the
 181     /// current loop preheader that may become duplicates of instructions that
 182     /// are hoisted out of the loop.
 183     void InitCSEMap(MachineBasicBlock *BB);
 184
 185     /// getCurPreheader - Get the preheader for the current loop, splitting
 186     /// a critical edge if needed.
 187     MachineBasicBlock *getCurPreheader();
 188   };
 189 } // end anonymous namespace
 190
 191 char MachineLICM::ID = 0;
 192 INITIALIZE_PASS_BEGIN(MachineLICM, "machinelicm",
 193                 "Machine Loop Invariant Code Motion", false, false)
 194 INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
 195 INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
 196 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
 197 INITIALIZE_PASS_END(MachineLICM, "machinelicm",
 198                 "Machine Loop Invariant Code Motion", false, false)
 199
 200 FunctionPass *llvm::createMachineLICMPass(bool PreRegAlloc) {
 201   return new MachineLICM(PreRegAlloc);
 202 }
 203
 204 /// LoopIsOuterMostWithPredecessor - Test if the given loop is the outer-most
 205 /// loop that has a unique predecessor.
 206 static bool LoopIsOuterMostWithPredecessor(MachineLoop *CurLoop) {
 207   // Check whether this loop even has a unique predecessor.
 208   if (!CurLoop->getLoopPredecessor())
 209     return false;
 210   // Ok, now check to see if any of its outer loops do.
 211   for (MachineLoop *L = CurLoop->getParentLoop(); L; L = L->getParentLoop())
 212     if (L->getLoopPredecessor())
 213       return false;
 214   // None of them did, so this is the outermost with a unique predecessor.
 215   return true;
 216 }
 217
 218 bool MachineLICM::runOnMachineFunction(MachineFunction &MF) {
 219   if (PreRegAlloc)
 220     DEBUG(dbgs() << "******** Pre-regalloc Machine LICM ********\n");
 221   else
 222     DEBUG(dbgs() << "******** Post-regalloc Machine LICM ********\n");
 223
 224   Changed = FirstInLoop = false;
 225   TM = &MF.getTarget();
 226   TII = TM->getInstrInfo();
 227   TRI = TM->getRegisterInfo();
 228   MFI = MF.getFrameInfo();
 229   RegInfo = &MF.getRegInfo();
 230   AllocatableSet = TRI->getAllocatableSet(MF);
 231
 232   // Get our Loop information...
 233   MLI = &getAnalysis<MachineLoopInfo>();
 234   DT  = &getAnalysis<MachineDominatorTree>();
 235   AA  = &getAnalysis<AliasAnalysis>();
 236
 237   SmallVector<MachineLoop *, 8> Worklist(MLI->begin(), MLI->end());
 238   while (!Worklist.empty()) {
 239     CurLoop = Worklist.pop_back_val();
 240     CurPreheader = 0;
 241
 242     // If this is done before regalloc, only visit outer-most preheader-sporting
 243     // loops.
 244     if (PreRegAlloc && !LoopIsOuterMostWithPredecessor(CurLoop)) {
 245       Worklist.append(CurLoop->begin(), CurLoop->end());
 246       continue;
 247     }
 248
 249     if (!PreRegAlloc)
 250       HoistRegionPostRA();
 251     else {
 252       // CSEMap is initialized for loop header when the first instruction is
 253       // being hoisted.
 254       MachineDomTreeNode *N = DT->getNode(CurLoop->getHeader());
 255       FirstInLoop = true;
 256       HoistRegion(N);
 257       CSEMap.clear();
 258     }
 259   }
 260
 261   return Changed;
 262 }
 263
 264 /// InstructionStoresToFI - Return true if instruction stores to the
 265 /// specified frame.
 266 static bool InstructionStoresToFI(const MachineInstr *MI, int FI) {
 267   for (MachineInstr::mmo_iterator o = MI->memoperands_begin(),
 268          oe = MI->memoperands_end(); o != oe; ++o) {
 269     if (!(*o)->isStore() || !(*o)->getValue())
 270       continue;
 271     if (const FixedStackPseudoSourceValue *Value =
 272         dyn_cast<const FixedStackPseudoSourceValue>((*o)->getValue())) {
 273       if (Value->getFrameIndex() == FI)
 274         return true;
 275     }
 276   }
 277   return false;
 278 }
 279
 280 /// ProcessMI - Examine the instruction for potentai LICM candidate. Also
 281 /// gather register def and frame object update information.
 282 void MachineLICM::ProcessMI(MachineInstr *MI,
 283                             unsigned *PhysRegDefs,
 284                             SmallSet<int, 32> &StoredFIs,
 285                             SmallVector<CandidateInfo, 32> &Candidates) {
 286   bool RuledOut = false;
 287   bool HasNonInvariantUse = false;
 288   unsigned Def = 0;
 289   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 290     const MachineOperand &MO = MI->getOperand(i);
 291     if (MO.isFI()) {
 292       // Remember if the instruction stores to the frame index.
 293       int FI = MO.getIndex();
 294       if (!StoredFIs.count(FI) &&
 295           MFI->isSpillSlotObjectIndex(FI) &&
 296           InstructionStoresToFI(MI, FI))
 297         StoredFIs.insert(FI);
 298       HasNonInvariantUse = true;
 299       continue;
 300     }
 301
 302     if (!MO.isReg())
 303       continue;
 304     unsigned Reg = MO.getReg();
 305     if (!Reg)
 306       continue;
 307     assert(TargetRegisterInfo::isPhysicalRegister(Reg) &&
 308            "Not expecting virtual register!");
 309
 310     if (!MO.isDef()) {
 311       if (Reg && PhysRegDefs[Reg])
 312         // If it's using a non-loop-invariant register, then it's obviously not
 313         // safe to hoist.
 314         HasNonInvariantUse = true;
 315       continue;
 316     }
 317
 318     if (MO.isImplicit()) {
 319       ++PhysRegDefs[Reg];
 320       for (const unsigned *AS = TRI->getAliasSet(Reg); *AS; ++AS)
 321         ++PhysRegDefs[*AS];
 322       if (!MO.isDead())
 323         // Non-dead implicit def? This cannot be hoisted.
 324         RuledOut = true;
 325       // No need to check if a dead implicit def is also defined by
 326       // another instruction.
 327       continue;
 328     }
 329
 330     // FIXME: For now, avoid instructions with multiple defs, unless
 331     // it's a dead implicit def.
 332     if (Def)
 333       RuledOut = true;
 334     else
 335       Def = Reg;
 336
 337     // If we have already seen another instruction that defines the same
 338     // register, then this is not safe.
 339     if (++PhysRegDefs[Reg] > 1)
 340       // MI defined register is seen defined by another instruction in
 341       // the loop, it cannot be a LICM candidate.
 342       RuledOut = true;
 343     for (const unsigned *AS = TRI->getAliasSet(Reg); *AS; ++AS)
 344       if (++PhysRegDefs[*AS] > 1)
 345         RuledOut = true;
 346   }
 347
 348   // Only consider reloads for now and remats which do not have register
 349   // operands. FIXME: Consider unfold load folding instructions.
 350   if (Def && !RuledOut) {
 351     int FI = INT_MIN;
 352     if ((!HasNonInvariantUse && IsLICMCandidate(*MI)) ||
 353         (TII->isLoadFromStackSlot(MI, FI) && MFI->isSpillSlotObjectIndex(FI)))
 354       Candidates.push_back(CandidateInfo(MI, Def, FI));
 355   }
 356 }
 357
 358 /// HoistRegionPostRA - Walk the specified region of the CFG and hoist loop
 359 /// invariants out to the preheader.
 360 void MachineLICM::HoistRegionPostRA() {
 361   unsigned NumRegs = TRI->getNumRegs();
 362   unsigned *PhysRegDefs = new unsigned[NumRegs];
 363   std::fill(PhysRegDefs, PhysRegDefs + NumRegs, 0);
 364
 365   SmallVector<CandidateInfo, 32> Candidates;
 366   SmallSet<int, 32> StoredFIs;
 367
 368   // Walk the entire region, count number of defs for each register, and
 369   // collect potential LICM candidates.
 370   const std::vector<MachineBasicBlock*> Blocks = CurLoop->getBlocks();
 371   for (unsigned i = 0, e = Blocks.size(); i != e; ++i) {
 372     MachineBasicBlock *BB = Blocks[i];
 373     // Conservatively treat live-in's as an external def.
 374     // FIXME: That means a reload that're reused in successor block(s) will not
 375     // be LICM'ed.
 376     for (MachineBasicBlock::livein_iterator I = BB->livein_begin(),
 377            E = BB->livein_end(); I != E; ++I) {
 378       unsigned Reg = *I;
 379       ++PhysRegDefs[Reg];
 380       for (const unsigned *AS = TRI->getAliasSet(Reg); *AS; ++AS)
 381         ++PhysRegDefs[*AS];
 382     }
 383
 384     for (MachineBasicBlock::iterator
 385            MII = BB->begin(), E = BB->end(); MII != E; ++MII) {
 386       MachineInstr *MI = &*MII;
 387       ProcessMI(MI, PhysRegDefs, StoredFIs, Candidates);
 388     }
 389   }
 390
 391   // Now evaluate whether the potential candidates qualify.
 392   // 1. Check if the candidate defined register is defined by another
 393   //    instruction in the loop.
 394   // 2. If the candidate is a load from stack slot (always true for now),
 395   //    check if the slot is stored anywhere in the loop.
 396   for (unsigned i = 0, e = Candidates.size(); i != e; ++i) {
 397     if (Candidates[i].FI != INT_MIN &&
 398         StoredFIs.count(Candidates[i].FI))
 399       continue;
 400
 401     if (PhysRegDefs[Candidates[i].Def] == 1) {
 402       bool Safe = true;
 403       MachineInstr *MI = Candidates[i].MI;
 404       for (unsigned j = 0, ee = MI->getNumOperands(); j != ee; ++j) {
 405         const MachineOperand &MO = MI->getOperand(j);
 406         if (!MO.isReg() || MO.isDef() || !MO.getReg())
 407           continue;
 408         if (PhysRegDefs[MO.getReg()]) {
 409           // If it's using a non-loop-invariant register, then it's obviously
 410           // not safe to hoist.
 411           Safe = false;
 412           break;
 413         }
 414       }
 415       if (Safe)
 416         HoistPostRA(MI, Candidates[i].Def);
 417     }
 418   }
 419
 420   delete[] PhysRegDefs;
 421 }
 422
 423 /// AddToLiveIns - Add register 'Reg' to the livein sets of BBs in the current
 424 /// loop, and make sure it is not killed by any instructions in the loop.
 425 void MachineLICM::AddToLiveIns(unsigned Reg) {
 426   const std::vector<MachineBasicBlock*> Blocks = CurLoop->getBlocks();
 427   for (unsigned i = 0, e = Blocks.size(); i != e; ++i) {
 428     MachineBasicBlock *BB = Blocks[i];
 429     if (!BB->isLiveIn(Reg))
 430       BB->addLiveIn(Reg);
 431     for (MachineBasicBlock::iterator
 432            MII = BB->begin(), E = BB->end(); MII != E; ++MII) {
 433       MachineInstr *MI = &*MII;
 434       for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 435         MachineOperand &MO = MI->getOperand(i);
 436         if (!MO.isReg() || !MO.getReg() || MO.isDef()) continue;
 437         if (MO.getReg() == Reg || TRI->isSuperRegister(Reg, MO.getReg()))
 438           MO.setIsKill(false);
 439       }
 440     }
 441   }
 442 }
 443
 444 /// HoistPostRA - When an instruction is found to only use loop invariant
 445 /// operands that is safe to hoist, this instruction is called to do the
 446 /// dirty work.
 447 void MachineLICM::HoistPostRA(MachineInstr *MI, unsigned Def) {
 448   MachineBasicBlock *Preheader = getCurPreheader();
 449   if (!Preheader) return;
 450
 451   // Now move the instructions to the predecessor, inserting it before any
 452   // terminator instructions.
 453   DEBUG({
 454       dbgs() << "Hoisting " << *MI;
 455       if (Preheader->getBasicBlock())
 456         dbgs() << " to MachineBasicBlock "
 457                << Preheader->getName();
 458       if (MI->getParent()->getBasicBlock())
 459         dbgs() << " from MachineBasicBlock "
 460                << MI->getParent()->getName();
 461       dbgs() << "\n";
 462     });
 463
 464   // Splice the instruction to the preheader.
 465   MachineBasicBlock *MBB = MI->getParent();
 466   Preheader->splice(Preheader->getFirstTerminator(), MBB, MI);
 467
 468   // Add register to livein list to all the BBs in the current loop since a
 469   // loop invariant must be kept live throughout the whole loop. This is
 470   // important to ensure later passes do not scavenge the def register.
 471   AddToLiveIns(Def);
 472
 473   ++NumPostRAHoisted;
 474   Changed = true;
 475 }
 476
 477 /// HoistRegion - Walk the specified region of the CFG (defined by all blocks
 478 /// dominated by the specified block, and that are in the current loop) in depth
 479 /// first order w.r.t the DominatorTree. This allows us to visit definitions
 480 /// before uses, allowing us to hoist a loop body in one pass without iteration.
 481 ///
 482 void MachineLICM::HoistRegion(MachineDomTreeNode *N) {
 483   assert(N != 0 && "Null dominator tree node?");
 484   MachineBasicBlock *BB = N->getBlock();
 485
 486   // If this subregion is not in the top level loop at all, exit.
 487   if (!CurLoop->contains(BB)) return;
 488
 489   for (MachineBasicBlock::iterator
 490          MII = BB->begin(), E = BB->end(); MII != E; ) {
 491     MachineBasicBlock::iterator NextMII = MII; ++NextMII;
 492     Hoist(&*MII);
 493     MII = NextMII;
 494   }
 495
 496   // Don't hoist things out of a large switch statement.  This often causes
 497   // code to be hoisted that wasn't going to be executed, and increases
 498   // register pressure in a situation where it's likely to matter.
 499   if (BB->succ_size() < 25) {
 500     const std::vector<MachineDomTreeNode*> &Children = N->getChildren();
 501     for (unsigned I = 0, E = Children.size(); I != E; ++I)
 502       HoistRegion(Children[I]);
 503   }
 504 }
 505
 506 /// IsLICMCandidate - Returns true if the instruction may be a suitable
 507 /// candidate for LICM. e.g. If the instruction is a call, then it's obviously
 508 /// not safe to hoist it.
 509 bool MachineLICM::IsLICMCandidate(MachineInstr &I) {
 510   // Check if it's safe to move the instruction.
 511   bool DontMoveAcrossStore = true;
 512   if (!I.isSafeToMove(TII, AA, DontMoveAcrossStore))
 513     return false;
 514
 515   return true;
 516 }
 517
 518 /// IsLoopInvariantInst - Returns true if the instruction is loop
 519 /// invariant. I.e., all virtual register operands are defined outside of the
 520 /// loop, physical registers aren't accessed explicitly, and there are no side
 521 /// effects that aren't captured by the operands or other flags.
 522 ///
 523 bool MachineLICM::IsLoopInvariantInst(MachineInstr &I) {
 524   if (!IsLICMCandidate(I))
 525     return false;
 526
 527   // The instruction is loop invariant if all of its operands are.
 528   for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
 529     const MachineOperand &MO = I.getOperand(i);
 530
 531     if (!MO.isReg())
 532       continue;
 533
 534     unsigned Reg = MO.getReg();
 535     if (Reg == 0) continue;
 536
 537     // Don't hoist an instruction that uses or defines a physical register.
 538     if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
 539       if (MO.isUse()) {
 540         // If the physreg has no defs anywhere, it's just an ambient register
 541         // and we can freely move its uses. Alternatively, if it's allocatable,
 542         // it could get allocated to something with a def during allocation.
 543         if (!RegInfo->def_empty(Reg))
 544           return false;
 545         if (AllocatableSet.test(Reg))
 546           return false;
 547         // Check for a def among the register's aliases too.
 548         for (const unsigned *Alias = TRI->getAliasSet(Reg); *Alias; ++Alias) {
 549           unsigned AliasReg = *Alias;
 550           if (!RegInfo->def_empty(AliasReg))
 551             return false;
 552           if (AllocatableSet.test(AliasReg))
 553             return false;
 554         }
 555         // Otherwise it's safe to move.
 556         continue;
 557       } else if (!MO.isDead()) {
 558         // A def that isn't dead. We can't move it.
 559         return false;
 560       } else if (CurLoop->getHeader()->isLiveIn(Reg)) {
 561         // If the reg is live into the loop, we can't hoist an instruction
 562         // which would clobber it.
 563         return false;
 564       }
 565     }
 566
 567     if (!MO.isUse())
 568       continue;
 569
 570     assert(RegInfo->getVRegDef(Reg) &&
 571            "Machine instr not mapped for this vreg?!");
 572
 573     // If the loop contains the definition of an operand, then the instruction
 574     // isn't loop invariant.
 575     if (CurLoop->contains(RegInfo->getVRegDef(Reg)))
 576       return false;
 577   }
 578
 579   // If we got this far, the instruction is loop invariant!
 580   return true;
 581 }
 582
 583
 584 /// HasPHIUses - Return true if the specified register has any PHI use.
 585 static bool HasPHIUses(unsigned Reg, MachineRegisterInfo *RegInfo) {
 586   for (MachineRegisterInfo::use_iterator UI = RegInfo->use_begin(Reg),
 587          UE = RegInfo->use_end(); UI != UE; ++UI) {
 588     MachineInstr *UseMI = &*UI;
 589     if (UseMI->isPHI())
 590       return true;
 591   }
 592   return false;
 593 }
 594
 595 /// isLoadFromConstantMemory - Return true if the given instruction is a
 596 /// load from constant memory. Machine LICM will hoist these even if they are
 597 /// not re-materializable.
 598 bool MachineLICM::isLoadFromConstantMemory(MachineInstr *MI) {
 599   if (!MI->getDesc().mayLoad()) return false;
 600   if (!MI->hasOneMemOperand()) return false;
 601   MachineMemOperand *MMO = *MI->memoperands_begin();
 602   if (MMO->isVolatile()) return false;
 603   if (!MMO->getValue()) return false;
 604   const PseudoSourceValue *PSV = dyn_cast<PseudoSourceValue>(MMO->getValue());
 605   if (PSV) {
 606     MachineFunction &MF = *MI->getParent()->getParent();
 607     return PSV->isConstant(MF.getFrameInfo());
 608   } else {
 609     return AA->pointsToConstantMemory(MMO->getValue());
 610   }
 611 }
 612
 613 /// IsProfitableToHoist - Return true if it is potentially profitable to hoist
 614 /// the given loop invariant.
 615 bool MachineLICM::IsProfitableToHoist(MachineInstr &MI) {
 616   // FIXME: For now, only hoist re-materilizable instructions. LICM will
 617   // increase register pressure. We want to make sure it doesn't increase
 618   // spilling.
 619   // Also hoist loads from constant memory, e.g. load from stubs, GOT. Hoisting
 620   // these tend to help performance in low register pressure situation. The
 621   // trade off is it may cause spill in high pressure situation. It will end up
 622   // adding a store in the loop preheader. But the reload is no more expensive.
 623   // The side benefit is these loads are frequently CSE'ed.
 624   if (!TII->isTriviallyReMaterializable(&MI, AA)) {
 625     if (!isLoadFromConstantMemory(&MI))
 626       return false;
 627   }
 628
 629   // If result(s) of this instruction is used by PHIs, then don't hoist it.
 630   // The presence of joins makes it difficult for current register allocator
 631   // implementation to perform remat.
 632   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
 633     const MachineOperand &MO = MI.getOperand(i);
 634     if (!MO.isReg() || !MO.isDef())
 635       continue;
 636     if (HasPHIUses(MO.getReg(), RegInfo))
 637       return false;
 638   }
 639
 640   return true;
 641 }
 642
 643 MachineInstr *MachineLICM::ExtractHoistableLoad(MachineInstr *MI) {
 644   // Don't unfold simple loads.
 645   if (MI->getDesc().canFoldAsLoad())
 646     return 0;
 647
 648   // If not, we may be able to unfold a load and hoist that.
 649   // First test whether the instruction is loading from an amenable
 650   // memory location.
 651   if (!isLoadFromConstantMemory(MI))
 652     return 0;
 653
 654   // Next determine the register class for a temporary register.
 655   unsigned LoadRegIndex;
 656   unsigned NewOpc =
 657     TII->getOpcodeAfterMemoryUnfold(MI->getOpcode(),
 658                                     /*UnfoldLoad=*/true,
 659                                     /*UnfoldStore=*/false,
 660                                     &LoadRegIndex);
 661   if (NewOpc == 0) return 0;
 662   const TargetInstrDesc &TID = TII->get(NewOpc);
 663   if (TID.getNumDefs() != 1) return 0;
 664   const TargetRegisterClass *RC = TID.OpInfo[LoadRegIndex].getRegClass(TRI);
 665   // Ok, we're unfolding. Create a temporary register and do the unfold.
 666   unsigned Reg = RegInfo->createVirtualRegister(RC);
 667
 668   MachineFunction &MF = *MI->getParent()->getParent();
 669   SmallVector<MachineInstr *, 2> NewMIs;
 670   bool Success =
 671     TII->unfoldMemoryOperand(MF, MI, Reg,
 672                              /*UnfoldLoad=*/true, /*UnfoldStore=*/false,
 673                              NewMIs);
 674   (void)Success;
 675   assert(Success &&
 676          "unfoldMemoryOperand failed when getOpcodeAfterMemoryUnfold "
 677          "succeeded!");
 678   assert(NewMIs.size() == 2 &&
 679          "Unfolded a load into multiple instructions!");
 680   MachineBasicBlock *MBB = MI->getParent();
 681   MBB->insert(MI, NewMIs[0]);
 682   MBB->insert(MI, NewMIs[1]);
 683   // If unfolding produced a load that wasn't loop-invariant or profitable to
 684   // hoist, discard the new instructions and bail.
 685   if (!IsLoopInvariantInst(*NewMIs[0]) || !IsProfitableToHoist(*NewMIs[0])) {
 686     NewMIs[0]->eraseFromParent();
 687     NewMIs[1]->eraseFromParent();
 688     return 0;
 689   }
 690   // Otherwise we successfully unfolded a load that we can hoist.
 691   MI->eraseFromParent();
 692   return NewMIs[0];
 693 }
 694
 695 void MachineLICM::InitCSEMap(MachineBasicBlock *BB) {
 696   for (MachineBasicBlock::iterator I = BB->begin(),E = BB->end(); I != E; ++I) {
 697     const MachineInstr *MI = &*I;
 698     // FIXME: For now, only hoist re-materilizable instructions. LICM will
 699     // increase register pressure. We want to make sure it doesn't increase
 700     // spilling.
 701     if (TII->isTriviallyReMaterializable(MI, AA)) {
 702       unsigned Opcode = MI->getOpcode();
 703       DenseMap<unsigned, std::vector<const MachineInstr*> >::iterator
 704         CI = CSEMap.find(Opcode);
 705       if (CI != CSEMap.end())
 706         CI->second.push_back(MI);
 707       else {
 708         std::vector<const MachineInstr*> CSEMIs;
 709         CSEMIs.push_back(MI);
 710         CSEMap.insert(std::make_pair(Opcode, CSEMIs));
 711       }
 712     }
 713   }
 714 }
 715
 716 const MachineInstr*
 717 MachineLICM::LookForDuplicate(const MachineInstr *MI,
 718                               std::vector<const MachineInstr*> &PrevMIs) {
 719   for (unsigned i = 0, e = PrevMIs.size(); i != e; ++i) {
 720     const MachineInstr *PrevMI = PrevMIs[i];
 721     if (TII->produceSameValue(MI, PrevMI))
 722       return PrevMI;
 723   }
 724   return 0;
 725 }
 726
 727 bool MachineLICM::EliminateCSE(MachineInstr *MI,
 728           DenseMap<unsigned, std::vector<const MachineInstr*> >::iterator &CI) {
 729   // Do not CSE implicit_def so ProcessImplicitDefs can properly propagate
 730   // the undef property onto uses.
 731   if (CI == CSEMap.end() || MI->isImplicitDef())
 732     return false;
 733
 734   if (const MachineInstr *Dup = LookForDuplicate(MI, CI->second)) {
 735     DEBUG(dbgs() << "CSEing " << *MI << " with " << *Dup);
 736
 737     // Replace virtual registers defined by MI by their counterparts defined
 738     // by Dup.
 739     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 740       const MachineOperand &MO = MI->getOperand(i);
 741
 742       // Physical registers may not differ here.
 743       assert((!MO.isReg() || MO.getReg() == 0 ||
 744               !TargetRegisterInfo::isPhysicalRegister(MO.getReg()) ||
 745               MO.getReg() == Dup->getOperand(i).getReg()) &&
 746              "Instructions with different phys regs are not identical!");
 747
 748       if (MO.isReg() && MO.isDef() &&
 749           !TargetRegisterInfo::isPhysicalRegister(MO.getReg())) {
 750         RegInfo->replaceRegWith(MO.getReg(), Dup->getOperand(i).getReg());
 751         RegInfo->clearKillFlags(Dup->getOperand(i).getReg());
 752       }
 753     }
 754     MI->eraseFromParent();
 755     ++NumCSEed;
 756     return true;
 757   }
 758   return false;
 759 }
 760
 761 /// Hoist - When an instruction is found to use only loop invariant operands
 762 /// that are safe to hoist, this instruction is called to do the dirty work.
 763 ///
 764 void MachineLICM::Hoist(MachineInstr *MI) {
 765   MachineBasicBlock *Preheader = getCurPreheader();
 766   if (!Preheader) return;
 767
 768   // First check whether we should hoist this instruction.
 769   if (!IsLoopInvariantInst(*MI) || !IsProfitableToHoist(*MI)) {
 770     // If not, try unfolding a hoistable load.
 771     MI = ExtractHoistableLoad(MI);
 772     if (!MI) return;
 773   }
 774
 775   // Now move the instructions to the predecessor, inserting it before any
 776   // terminator instructions.
 777   DEBUG({
 778       dbgs() << "Hoisting " << *MI;
 779       if (Preheader->getBasicBlock())
 780         dbgs() << " to MachineBasicBlock "
 781                << Preheader->getName();
 782       if (MI->getParent()->getBasicBlock())
 783         dbgs() << " from MachineBasicBlock "
 784                << MI->getParent()->getName();
 785       dbgs() << "\n";
 786     });
 787
 788   // If this is the first instruction being hoisted to the preheader,
 789   // initialize the CSE map with potential common expressions.
 790   if (FirstInLoop) {
 791     InitCSEMap(Preheader);
 792     FirstInLoop = false;
 793   }
 794
 795   // Look for opportunity to CSE the hoisted instruction.
 796   unsigned Opcode = MI->getOpcode();
 797   DenseMap<unsigned, std::vector<const MachineInstr*> >::iterator
 798     CI = CSEMap.find(Opcode);
 799   if (!EliminateCSE(MI, CI)) {
 800     // Otherwise, splice the instruction to the preheader.
 801     Preheader->splice(Preheader->getFirstTerminator(),MI->getParent(),MI);
 802
 803     // Clear the kill flags of any register this instruction defines,
 804     // since they may need to be live throughout the entire loop
 805     // rather than just live for part of it.
 806     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 807       MachineOperand &MO = MI->getOperand(i);
 808       if (MO.isReg() && MO.isDef() && !MO.isDead())
 809         RegInfo->clearKillFlags(MO.getReg());
 810     }
 811
 812     // Add to the CSE map.
 813     if (CI != CSEMap.end())
 814       CI->second.push_back(MI);
 815     else {
 816       std::vector<const MachineInstr*> CSEMIs;
 817       CSEMIs.push_back(MI);
 818       CSEMap.insert(std::make_pair(Opcode, CSEMIs));
 819     }
 820   }
 821
 822   ++NumHoisted;
 823   Changed = true;
 824 }
 825
 826 MachineBasicBlock *MachineLICM::getCurPreheader() {
 827   // Determine the block to which to hoist instructions. If we can't find a
 828   // suitable loop predecessor, we can't do any hoisting.
 829
 830   // If we've tried to get a preheader and failed, don't try again.
 831   if (CurPreheader == reinterpret_cast<MachineBasicBlock *>(-1))
 832     return 0;
 833
 834   if (!CurPreheader) {
 835     CurPreheader = CurLoop->getLoopPreheader();
 836     if (!CurPreheader) {
 837       MachineBasicBlock *Pred = CurLoop->getLoopPredecessor();
 838       if (!Pred) {
 839         CurPreheader = reinterpret_cast<MachineBasicBlock *>(-1);
 840         return 0;
 841       }
 842
 843       CurPreheader = Pred->SplitCriticalEdge(CurLoop->getHeader(), this);
 844       if (!CurPreheader) {
 845         CurPreheader = reinterpret_cast<MachineBasicBlock *>(-1);
 846         return 0;
 847       }
 848     }
 849   }
 850   return CurPreheader;
 851 }