lib/CodeGen/MachineSink.cpp

   1 //===-- MachineSink.cpp - Sinking for machine instructions ----------------===//
   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
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "machine-sink"
  15 #include "llvm/CodeGen/Passes.h"
  16 #include "llvm/CodeGen/MachineRegisterInfo.h"
  17 #include "llvm/CodeGen/MachineDominators.h"
  18 #include "llvm/Target/MRegisterInfo.h"
  19 #include "llvm/Target/TargetInstrInfo.h"
  20 #include "llvm/Target/TargetMachine.h"
  21 #include "llvm/ADT/SmallVector.h"
  22 #include "llvm/ADT/Statistic.h"
  23 #include "llvm/Support/Compiler.h"
  24 #include "llvm/Support/Debug.h"
  25 using namespace llvm;
  26
  27 STATISTIC(NumSunk, "Number of machine instructions sunk");
  28
  29 namespace {
  30   class VISIBILITY_HIDDEN MachineSinking : public MachineFunctionPass {
  31     const TargetMachine   *TM;
  32     const TargetInstrInfo *TII;
  33     MachineFunction       *CurMF; // Current MachineFunction
  34     MachineRegisterInfo  *RegInfo; // Machine register information
  35     MachineDominatorTree *DT;   // Machine dominator tree for the current Loop
  36
  37   public:
  38     static char ID; // Pass identification
  39     MachineSinking() : MachineFunctionPass((intptr_t)&ID) {}
  40
  41     virtual bool runOnMachineFunction(MachineFunction &MF);
  42
  43     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  44       MachineFunctionPass::getAnalysisUsage(AU);
  45       AU.addRequired<MachineDominatorTree>();
  46       AU.addPreserved<MachineDominatorTree>();
  47     }
  48   private:
  49     bool ProcessBlock(MachineBasicBlock &MBB);
  50     bool SinkInstruction(MachineInstr *MI);
  51     bool AllUsesDominatedByBlock(unsigned Reg, MachineBasicBlock *MBB) const;
  52   };
  53
  54   char MachineSinking::ID = 0;
  55   RegisterPass<MachineSinking> X("machine-sink", "Machine code sinking");
  56 } // end anonymous namespace
  57
  58 FunctionPass *llvm::createMachineSinkingPass() { return new MachineSinking(); }
  59
  60 /// AllUsesDominatedByBlock - Return true if all uses of the specified register
  61 /// occur in blocks dominated by the specified block.
  62 bool MachineSinking::AllUsesDominatedByBlock(unsigned Reg,
  63                                              MachineBasicBlock *MBB) const {
  64   assert(MRegisterInfo::isVirtualRegister(Reg) && "Only makes sense for vregs");
  65   for (MachineRegisterInfo::reg_iterator I = RegInfo->reg_begin(Reg),
  66        E = RegInfo->reg_end(); I != E; ++I) {
  67     if (I.getOperand().isDef()) continue;  // ignore def.
  68
  69     // Determine the block of the use.
  70     MachineInstr *UseInst = &*I;
  71     MachineBasicBlock *UseBlock = UseInst->getParent();
  72     if (UseInst->getOpcode() == TargetInstrInfo::PHI) {
  73       // PHI nodes use the operand in the predecessor block, not the block with
  74       // the PHI.
  75       UseBlock = UseInst->getOperand(I.getOperandNo()+1).getMBB();
  76     }
  77     // Check that it dominates.
  78     if (!DT->dominates(MBB, UseBlock))
  79       return false;
  80   }
  81   return true;
  82 }
  83
  84
  85
  86 bool MachineSinking::runOnMachineFunction(MachineFunction &MF) {
  87   DOUT << "******** Machine Sinking ********\n";
  88
  89   CurMF = &MF;
  90   TM = &CurMF->getTarget();
  91   TII = TM->getInstrInfo();
  92   RegInfo = &CurMF->getRegInfo();
  93   DT = &getAnalysis<MachineDominatorTree>();
  94
  95   bool EverMadeChange = false;
  96
  97   while (1) {
  98     bool MadeChange = false;
  99
 100     // Process all basic blocks.
 101     for (MachineFunction::iterator I = CurMF->begin(), E = CurMF->end();
 102          I != E; ++I)
 103       MadeChange |= ProcessBlock(*I);
 104
 105     // If this iteration over the code changed anything, keep iterating.
 106     if (!MadeChange) break;
 107     EverMadeChange = true;
 108   }
 109   return EverMadeChange;
 110 }
 111
 112 bool MachineSinking::ProcessBlock(MachineBasicBlock &MBB) {
 113   bool MadeChange = false;
 114
 115   // Can't sink anything out of a block that has less than two successors.
 116   if (MBB.succ_size() <= 1) return false;
 117
 118   // Walk the basic block bottom-up
 119   for (MachineBasicBlock::iterator I = MBB.end(); I != MBB.begin(); ){
 120     MachineBasicBlock::iterator LastIt = I;
 121     if (SinkInstruction(--I)) {
 122       I = LastIt;
 123       ++NumSunk;
 124     }
 125   }
 126
 127   return MadeChange;
 128 }
 129
 130 /// SinkInstruction - Determine whether it is safe to sink the specified machine
 131 /// instruction out of its current block into a successor.
 132 bool MachineSinking::SinkInstruction(MachineInstr *MI) {
 133   const TargetInstrDesc &TID = MI->getDesc();
 134
 135   // Ignore stuff that we obviously can't sink.
 136   if (TID.mayStore() || TID.isCall() || TID.isReturn() || TID.isBranch())
 137     return false;
 138
 139   if (TID.mayLoad())
 140     return false;
 141
 142   // Don't sink things with side-effects we don't understand.
 143   if (TII->hasUnmodelledSideEffects(MI))
 144     return false;
 145
 146   // FIXME: we should be able to sink loads with no other side effects if there
 147   // is nothing that can change memory from here until the end of block.  This
 148   // is a trivial form of alias analysis.
 149
 150   // FIXME: This should include support for sinking instructions within the
 151   // block they are currently in to shorten the live ranges.  We often get
 152   // instructions sunk into the top of a large block, but it would be better to
 153   // also sink them down before their first use in the block.  This xform has to
 154   // be careful not to *increase* register pressure though, e.g. sinking
 155   // "x = y + z" down if it kills y and z would increase the live ranges of y
 156   // and z only the shrink the live range of x.
 157
 158   // Loop over all the operands of the specified instruction.  If there is
 159   // anything we can't handle, bail out.
 160   MachineBasicBlock *ParentBlock = MI->getParent();
 161
 162   // SuccToSinkTo - This is the successor to sink this instruction to, once we
 163   // decide.
 164   MachineBasicBlock *SuccToSinkTo = 0;
 165
 166   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 167     const MachineOperand &MO = MI->getOperand(i);
 168     if (!MO.isReg()) continue;  // Ignore non-register operands.
 169
 170     unsigned Reg = MO.getReg();
 171     if (Reg == 0) continue;
 172
 173     if (MRegisterInfo::isPhysicalRegister(Reg)) {
 174       // If this is a physical register use, we can't move it.  If it is a def,
 175       // we can move it, but only if the def is dead.
 176       if (MO.isUse() || !MO.isDead())
 177         return false;
 178     } else {
 179       // Virtual register uses are always safe to sink.
 180       if (MO.isUse()) continue;
 181
 182       // FIXME: This picks a successor to sink into based on having one
 183       // successor that dominates all the uses.  However, there are cases where
 184       // sinking can happen but where the sink point isn't a successor.  For
 185       // example:
 186       //   x = computation
 187       //   if () {} else {}
 188       //   use x
 189       // the instruction could be sunk over the whole diamond for the
 190       // if/then/else (or loop, etc), allowing it to be sunk into other blocks
 191       // after that.
 192
 193       // Virtual register defs can only be sunk if all their uses are in blocks
 194       // dominated by one of the successors.
 195       if (SuccToSinkTo) {
 196         // If a previous operand picked a block to sink to, then this operand
 197         // must be sinkable to the same block.
 198         if (!AllUsesDominatedByBlock(Reg, SuccToSinkTo))
 199           return false;
 200         continue;
 201       }
 202
 203       // Otherwise, we should look at all the successors and decide which one
 204       // we should sink to.
 205       for (MachineBasicBlock::succ_iterator SI = ParentBlock->succ_begin(),
 206            E = ParentBlock->succ_end(); SI != E; ++SI) {
 207         if (AllUsesDominatedByBlock(Reg, *SI)) {
 208           SuccToSinkTo = *SI;
 209           break;
 210         }
 211       }
 212
 213       // If we couldn't find a block to sink to, ignore this instruction.
 214       if (SuccToSinkTo == 0)
 215         return false;
 216     }
 217   }
 218
 219   // If there are no outputs, it must have side-effects.
 220   if (SuccToSinkTo == 0)
 221     return false;
 222
 223   DEBUG(cerr << "Sink instr " << *MI);
 224   DEBUG(cerr << "to block " << *SuccToSinkTo);
 225
 226   // If the block has multiple predecessors, this would introduce computation on
 227   // a path that it doesn't already exist.  We could split the critical edge,
 228   // but for now we just punt.
 229   // FIXME: Split critical edges if not backedges.
 230   if (SuccToSinkTo->pred_size() > 1) {
 231     DEBUG(cerr << " *** PUNTING: Critical edge found\n");
 232     return false;
 233   }
 234
 235   // Determine where to insert into.  Skip phi nodes.
 236   MachineBasicBlock::iterator InsertPos = SuccToSinkTo->begin();
 237   while (InsertPos != SuccToSinkTo->end() &&
 238          InsertPos->getOpcode() == TargetInstrInfo::PHI)
 239     ++InsertPos;
 240
 241   // Move the instruction.
 242   SuccToSinkTo->splice(InsertPos, ParentBlock, MI,
 243                        ++MachineBasicBlock::iterator(MI));
 244   return true;
 245 }