lib/CodeGen/MachineCSE.cpp

   1 //===-- MachineCSE.cpp - Machine Common Subexpression Elimination 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 global common subexpression elimination on machine
  11 // instructions using a scoped hash table based value numbering scheme. It
  12 // must be run while the machine function is still in SSA form.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "machine-cse"
  17 #include "llvm/CodeGen/Passes.h"
  18 #include "llvm/CodeGen/MachineDominators.h"
  19 #include "llvm/CodeGen/MachineInstr.h"
  20 #include "llvm/CodeGen/MachineRegisterInfo.h"
  21 #include "llvm/Analysis/AliasAnalysis.h"
  22 #include "llvm/Target/TargetInstrInfo.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include "llvm/ADT/ScopedHashTable.h"
  25 #include "llvm/ADT/Statistic.h"
  26 #include "llvm/Support/Debug.h"
  27
  28 using namespace llvm;
  29
  30 STATISTIC(NumCoalesces, "Number of copies coalesced");
  31 STATISTIC(NumCSEs,      "Number of common subexpression eliminated");
  32
  33 namespace {
  34   class MachineCSE : public MachineFunctionPass {
  35     const TargetInstrInfo *TII;
  36     const TargetRegisterInfo *TRI;
  37     AliasAnalysis *AA;
  38     MachineDominatorTree *DT;
  39     MachineRegisterInfo *MRI;
  40   public:
  41     static char ID; // Pass identification
  42     MachineCSE() : MachineFunctionPass(&ID), CurrVN(0) {}
  43
  44     virtual bool runOnMachineFunction(MachineFunction &MF);
  45
  46     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  47       AU.setPreservesCFG();
  48       MachineFunctionPass::getAnalysisUsage(AU);
  49       AU.addRequired<AliasAnalysis>();
  50       AU.addRequired<MachineDominatorTree>();
  51       AU.addPreserved<MachineDominatorTree>();
  52     }
  53
  54   private:
  55     typedef ScopedHashTableScope<MachineInstr*, unsigned,
  56                                  MachineInstrExpressionTrait> ScopeType;
  57     DenseMap<MachineBasicBlock*, ScopeType*> ScopeMap;
  58     ScopedHashTable<MachineInstr*, unsigned, MachineInstrExpressionTrait> VNT;
  59     SmallVector<MachineInstr*, 64> Exps;
  60     unsigned CurrVN;
  61
  62     bool PerformTrivialCoalescing(MachineInstr *MI, MachineBasicBlock *MBB);
  63     bool isPhysDefTriviallyDead(unsigned Reg,
  64                                 MachineBasicBlock::const_iterator I,
  65                                 MachineBasicBlock::const_iterator E);
  66     bool hasLivePhysRegDefUse(MachineInstr *MI, MachineBasicBlock *MBB);
  67     bool isCSECandidate(MachineInstr *MI);
  68     bool isProfitableToCSE(unsigned CSReg, unsigned Reg,
  69                            MachineInstr *CSMI, MachineInstr *MI);
  70     void EnterScope(MachineBasicBlock *MBB);
  71     void ExitScope(MachineBasicBlock *MBB);
  72     bool ProcessBlock(MachineBasicBlock *MBB);
  73     void ExitScopeIfDone(MachineDomTreeNode *Node,
  74                  DenseMap<MachineDomTreeNode*, unsigned> &OpenChildren,
  75                  DenseMap<MachineDomTreeNode*, MachineDomTreeNode*> &ParentMap);
  76     bool PerformCSE(MachineDomTreeNode *Node);
  77   };
  78 } // end anonymous namespace
  79
  80 char MachineCSE::ID = 0;
  81 static RegisterPass<MachineCSE>
  82 X("machine-cse", "Machine Common Subexpression Elimination");
  83
  84 FunctionPass *llvm::createMachineCSEPass() { return new MachineCSE(); }
  85
  86 bool MachineCSE::PerformTrivialCoalescing(MachineInstr *MI,
  87                                           MachineBasicBlock *MBB) {
  88   bool Changed = false;
  89   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
  90     MachineOperand &MO = MI->getOperand(i);
  91     if (!MO.isReg() || !MO.isUse())
  92       continue;
  93     unsigned Reg = MO.getReg();
  94     if (!Reg || TargetRegisterInfo::isPhysicalRegister(Reg))
  95       continue;
  96     if (!MRI->hasOneUse(Reg))
  97       // Only coalesce single use copies. This ensure the copy will be
  98       // deleted.
  99       continue;
 100     MachineInstr *DefMI = MRI->getVRegDef(Reg);
 101     if (DefMI->getParent() != MBB)
 102       continue;
 103     unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
 104     if (TII->isMoveInstr(*DefMI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) &&
 105         TargetRegisterInfo::isVirtualRegister(SrcReg) &&
 106         !SrcSubIdx && !DstSubIdx) {
 107       const TargetRegisterClass *SRC   = MRI->getRegClass(SrcReg);
 108       const TargetRegisterClass *RC    = MRI->getRegClass(Reg);
 109       const TargetRegisterClass *NewRC = getCommonSubClass(RC, SRC);
 110       if (!NewRC)
 111         continue;
 112       DEBUG(dbgs() << "Coalescing: " << *DefMI);
 113       DEBUG(dbgs() << "*** to: " << *MI);
 114       MO.setReg(SrcReg);
 115       MRI->clearKillFlags(SrcReg);
 116       if (NewRC != SRC)
 117         MRI->setRegClass(SrcReg, NewRC);
 118       DefMI->eraseFromParent();
 119       ++NumCoalesces;
 120       Changed = true;
 121     }
 122   }
 123
 124   return Changed;
 125 }
 126
 127 bool MachineCSE::isPhysDefTriviallyDead(unsigned Reg,
 128                                         MachineBasicBlock::const_iterator I,
 129                                         MachineBasicBlock::const_iterator E) {
 130   unsigned LookAheadLeft = 5;
 131   while (LookAheadLeft) {
 132     // Skip over dbg_value's.
 133     while (I != E && I->isDebugValue())
 134       ++I;
 135
 136     if (I == E)
 137       // Reached end of block, register is obviously dead.
 138       return true;
 139
 140     bool SeenDef = false;
 141     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
 142       const MachineOperand &MO = I->getOperand(i);
 143       if (!MO.isReg() || !MO.getReg())
 144         continue;
 145       if (!TRI->regsOverlap(MO.getReg(), Reg))
 146         continue;
 147       if (MO.isUse())
 148         return false;
 149       SeenDef = true;
 150     }
 151     if (SeenDef)
 152       // See a def of Reg (or an alias) before encountering any use, it's
 153       // trivially dead.
 154       return true;
 155
 156     --LookAheadLeft;
 157     ++I;
 158   }
 159   return false;
 160 }
 161
 162 /// hasLivePhysRegDefUse - Return true if the specified instruction read / write
 163 /// physical registers (except for dead defs of physical registers).
 164 bool MachineCSE::hasLivePhysRegDefUse(MachineInstr *MI, MachineBasicBlock *MBB){
 165   unsigned PhysDef = 0;
 166   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 167     MachineOperand &MO = MI->getOperand(i);
 168     if (!MO.isReg())
 169       continue;
 170     unsigned Reg = MO.getReg();
 171     if (!Reg)
 172       continue;
 173     if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
 174       if (MO.isUse())
 175         // Can't touch anything to read a physical register.
 176         return true;
 177       if (MO.isDead())
 178         // If the def is dead, it's ok.
 179         continue;
 180       // Ok, this is a physical register def that's not marked "dead". That's
 181       // common since this pass is run before livevariables. We can scan
 182       // forward a few instructions and check if it is obviously dead.
 183       if (PhysDef)
 184         // Multiple physical register defs. These are rare, forget about it.
 185         return true;
 186       PhysDef = Reg;
 187     }
 188   }
 189
 190   if (PhysDef) {
 191     MachineBasicBlock::iterator I = MI; I = llvm::next(I);
 192     if (!isPhysDefTriviallyDead(PhysDef, I, MBB->end()))
 193       return true;
 194   }
 195   return false;
 196 }
 197
 198 static bool isCopy(const MachineInstr *MI, const TargetInstrInfo *TII) {
 199   unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
 200   return TII->isMoveInstr(*MI, SrcReg, DstReg, SrcSubIdx, DstSubIdx) ||
 201     MI->isExtractSubreg() || MI->isInsertSubreg() || MI->isSubregToReg();
 202 }
 203
 204 bool MachineCSE::isCSECandidate(MachineInstr *MI) {
 205   if (MI->isLabel() || MI->isPHI() || MI->isImplicitDef() ||
 206       MI->isKill() || MI->isInlineAsm() || MI->isDebugValue())
 207     return false;
 208
 209   // Ignore copies.
 210   if (isCopy(MI, TII))
 211     return false;
 212
 213   // Ignore stuff that we obviously can't move.
 214   const TargetInstrDesc &TID = MI->getDesc();
 215   if (TID.mayStore() || TID.isCall() || TID.isTerminator() ||
 216       TID.hasUnmodeledSideEffects())
 217     return false;
 218
 219   if (TID.mayLoad()) {
 220     // Okay, this instruction does a load. As a refinement, we allow the target
 221     // to decide whether the loaded value is actually a constant. If so, we can
 222     // actually use it as a load.
 223     if (!MI->isInvariantLoad(AA))
 224       // FIXME: we should be able to hoist loads with no other side effects if
 225       // there are no other instructions which can change memory in this loop.
 226       // This is a trivial form of alias analysis.
 227       return false;
 228   }
 229   return true;
 230 }
 231
 232 /// isProfitableToCSE - Return true if it's profitable to eliminate MI with a
 233 /// common expression that defines Reg.
 234 bool MachineCSE::isProfitableToCSE(unsigned CSReg, unsigned Reg,
 235                                    MachineInstr *CSMI, MachineInstr *MI) {
 236   // FIXME: Heuristics that works around the lack the live range splitting.
 237
 238   // Heuristics #1: Don't cse "cheap" computating if the def is not local or in an
 239   // immediate predecessor. We don't want to increase register pressure and end up
 240   // causing other computation to be spilled.
 241   if (MI->getDesc().isAsCheapAsAMove()) {
 242     MachineBasicBlock *CSBB = CSMI->getParent();
 243     MachineBasicBlock *BB = MI->getParent();
 244     if (CSBB != BB &&
 245         find(CSBB->succ_begin(), CSBB->succ_end(), BB) == CSBB->succ_end())
 246       return false;
 247   }
 248
 249   // Heuristics #2: If the expression doesn't not use a vr and the only use
 250   // of the redundant computation are copies, do not cse.
 251   bool HasVRegUse = false;
 252   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 253     const MachineOperand &MO = MI->getOperand(i);
 254     if (MO.isReg() && MO.isUse() && MO.getReg() &&
 255         TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
 256       HasVRegUse = true;
 257       break;
 258     }
 259   }
 260   if (!HasVRegUse) {
 261     bool HasNonCopyUse = false;
 262     for (MachineRegisterInfo::use_nodbg_iterator I =  MRI->use_nodbg_begin(Reg),
 263            E = MRI->use_nodbg_end(); I != E; ++I) {
 264       MachineInstr *Use = &*I;
 265       // Ignore copies.
 266       if (!isCopy(Use, TII)) {
 267         HasNonCopyUse = true;
 268         break;
 269       }
 270     }
 271     if (!HasNonCopyUse)
 272       return false;
 273   }
 274
 275   // Heuristics #3: If the common subexpression is used by PHIs, do not reuse
 276   // it unless the defined value is already used in the BB of the new use.
 277   bool HasPHI = false;
 278   SmallPtrSet<MachineBasicBlock*, 4> CSBBs;
 279   for (MachineRegisterInfo::use_nodbg_iterator I =  MRI->use_nodbg_begin(CSReg),
 280        E = MRI->use_nodbg_end(); I != E; ++I) {
 281     MachineInstr *Use = &*I;
 282     HasPHI |= Use->isPHI();
 283     CSBBs.insert(Use->getParent());
 284   }
 285
 286   if (!HasPHI)
 287     return true;
 288   return CSBBs.count(MI->getParent());
 289 }
 290
 291 void MachineCSE::EnterScope(MachineBasicBlock *MBB) {
 292   DEBUG(dbgs() << "Entering: " << MBB->getName() << '\n');
 293   ScopeType *Scope = new ScopeType(VNT);
 294   ScopeMap[MBB] = Scope;
 295 }
 296
 297 void MachineCSE::ExitScope(MachineBasicBlock *MBB) {
 298   DEBUG(dbgs() << "Exiting: " << MBB->getName() << '\n');
 299   DenseMap<MachineBasicBlock*, ScopeType*>::iterator SI = ScopeMap.find(MBB);
 300   assert(SI != ScopeMap.end());
 301   ScopeMap.erase(SI);
 302   delete SI->second;
 303 }
 304
 305 bool MachineCSE::ProcessBlock(MachineBasicBlock *MBB) {
 306   bool Changed = false;
 307
 308   SmallVector<std::pair<unsigned, unsigned>, 8> CSEPairs;
 309   for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end(); I != E; ) {
 310     MachineInstr *MI = &*I;
 311     ++I;
 312
 313     if (!isCSECandidate(MI))
 314       continue;
 315
 316     bool FoundCSE = VNT.count(MI);
 317     if (!FoundCSE) {
 318       // Look for trivial copy coalescing opportunities.
 319       if (PerformTrivialCoalescing(MI, MBB)) {
 320         // After coalescing MI itself may become a copy.
 321         if (isCopy(MI, TII))
 322           continue;
 323         FoundCSE = VNT.count(MI);
 324       }
 325     }
 326     // FIXME: commute commutable instructions?
 327
 328     // If the instruction defines a physical register and the value *may* be
 329     // used, then it's not safe to replace it with a common subexpression.
 330     if (FoundCSE && hasLivePhysRegDefUse(MI, MBB))
 331       FoundCSE = false;
 332
 333     if (!FoundCSE) {
 334       VNT.insert(MI, CurrVN++);
 335       Exps.push_back(MI);
 336       continue;
 337     }
 338
 339     // Found a common subexpression, eliminate it.
 340     unsigned CSVN = VNT.lookup(MI);
 341     MachineInstr *CSMI = Exps[CSVN];
 342     DEBUG(dbgs() << "Examining: " << *MI);
 343     DEBUG(dbgs() << "*** Found a common subexpression: " << *CSMI);
 344
 345     // Check if it's profitable to perform this CSE.
 346     bool DoCSE = true;
 347     unsigned NumDefs = MI->getDesc().getNumDefs();
 348     for (unsigned i = 0, e = MI->getNumOperands(); NumDefs && i != e; ++i) {
 349       MachineOperand &MO = MI->getOperand(i);
 350       if (!MO.isReg() || !MO.isDef())
 351         continue;
 352       unsigned OldReg = MO.getReg();
 353       unsigned NewReg = CSMI->getOperand(i).getReg();
 354       if (OldReg == NewReg)
 355         continue;
 356       assert(TargetRegisterInfo::isVirtualRegister(OldReg) &&
 357              TargetRegisterInfo::isVirtualRegister(NewReg) &&
 358              "Do not CSE physical register defs!");
 359       if (!isProfitableToCSE(NewReg, OldReg, CSMI, MI)) {
 360         DoCSE = false;
 361         break;
 362       }
 363       CSEPairs.push_back(std::make_pair(OldReg, NewReg));
 364       --NumDefs;
 365     }
 366
 367     // Actually perform the elimination.
 368     if (DoCSE) {
 369       for (unsigned i = 0, e = CSEPairs.size(); i != e; ++i) {
 370         MRI->replaceRegWith(CSEPairs[i].first, CSEPairs[i].second);
 371         MRI->clearKillFlags(CSEPairs[i].second);
 372       }
 373       MI->eraseFromParent();
 374       ++NumCSEs;
 375     } else {
 376       DEBUG(dbgs() << "*** Not profitable, avoid CSE!\n");
 377       VNT.insert(MI, CurrVN++);
 378       Exps.push_back(MI);
 379     }
 380     CSEPairs.clear();
 381   }
 382
 383   return Changed;
 384 }
 385
 386 /// ExitScopeIfDone - Destroy scope for the MBB that corresponds to the given
 387 /// dominator tree node if its a leaf or all of its children are done. Walk
 388 /// up the dominator tree to destroy ancestors which are now done.
 389 void
 390 MachineCSE::ExitScopeIfDone(MachineDomTreeNode *Node,
 391                 DenseMap<MachineDomTreeNode*, unsigned> &OpenChildren,
 392                 DenseMap<MachineDomTreeNode*, MachineDomTreeNode*> &ParentMap) {
 393   if (OpenChildren[Node])
 394     return;
 395
 396   // Pop scope.
 397   ExitScope(Node->getBlock());
 398
 399   // Now traverse upwards to pop ancestors whose offsprings are all done.
 400   while (MachineDomTreeNode *Parent = ParentMap[Node]) {
 401     unsigned Left = --OpenChildren[Parent];
 402     if (Left != 0)
 403       break;
 404     ExitScope(Parent->getBlock());
 405     Node = Parent;
 406   }
 407 }
 408
 409 bool MachineCSE::PerformCSE(MachineDomTreeNode *Node) {
 410   SmallVector<MachineDomTreeNode*, 32> Scopes;
 411   SmallVector<MachineDomTreeNode*, 8> WorkList;
 412   DenseMap<MachineDomTreeNode*, MachineDomTreeNode*> ParentMap;
 413   DenseMap<MachineDomTreeNode*, unsigned> OpenChildren;
 414
 415   // Perform a DFS walk to determine the order of visit.
 416   WorkList.push_back(Node);
 417   do {
 418     Node = WorkList.pop_back_val();
 419     Scopes.push_back(Node);
 420     const std::vector<MachineDomTreeNode*> &Children = Node->getChildren();
 421     unsigned NumChildren = Children.size();
 422     OpenChildren[Node] = NumChildren;
 423     for (unsigned i = 0; i != NumChildren; ++i) {
 424       MachineDomTreeNode *Child = Children[i];
 425       ParentMap[Child] = Node;
 426       WorkList.push_back(Child);
 427     }
 428   } while (!WorkList.empty());
 429
 430   // Now perform CSE.
 431   bool Changed = false;
 432   for (unsigned i = 0, e = Scopes.size(); i != e; ++i) {
 433     MachineDomTreeNode *Node = Scopes[i];
 434     MachineBasicBlock *MBB = Node->getBlock();
 435     EnterScope(MBB);
 436     Changed |= ProcessBlock(MBB);
 437     // If it's a leaf node, it's done. Traverse upwards to pop ancestors.
 438     ExitScopeIfDone(Node, OpenChildren, ParentMap);
 439   }
 440
 441   return Changed;
 442 }
 443
 444 bool MachineCSE::runOnMachineFunction(MachineFunction &MF) {
 445   TII = MF.getTarget().getInstrInfo();
 446   TRI = MF.getTarget().getRegisterInfo();
 447   MRI = &MF.getRegInfo();
 448   AA = &getAnalysis<AliasAnalysis>();
 449   DT = &getAnalysis<MachineDominatorTree>();
 450   return PerformCSE(DT->getRootNode());
 451 }