lib/CodeGen/TwoAddressInstructionPass.cpp

   1 //===-- TwoAddressInstructionPass.cpp - Two-Address instruction 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 file implements the TwoAddress instruction pass which is used
  11 // by most register allocators. Two-Address instructions are rewritten
  12 // from:
  13 //
  14 //     A = B op C
  15 //
  16 // to:
  17 //
  18 //     A = B
  19 //     A op= C
  20 //
  21 // Note that if a register allocator chooses to use this pass, that it
  22 // has to be capable of handling the non-SSA nature of these rewritten
  23 // virtual registers.
  24 //
  25 // It is also worth noting that the duplicate operand of the two
  26 // address instruction is removed.
  27 //
  28 //===----------------------------------------------------------------------===//
  29
  30 #define DEBUG_TYPE "twoaddrinstr"
  31 #include "llvm/CodeGen/Passes.h"
  32 #include "llvm/Function.h"
  33 #include "llvm/CodeGen/LiveVariables.h"
  34 #include "llvm/CodeGen/MachineFunctionPass.h"
  35 #include "llvm/CodeGen/MachineInstr.h"
  36 #include "llvm/CodeGen/MachineRegisterInfo.h"
  37 #include "llvm/Target/TargetRegisterInfo.h"
  38 #include "llvm/Target/TargetInstrInfo.h"
  39 #include "llvm/Target/TargetMachine.h"
  40 #include "llvm/Support/Compiler.h"
  41 #include "llvm/Support/Debug.h"
  42 #include "llvm/ADT/BitVector.h"
  43 #include "llvm/ADT/DenseMap.h"
  44 #include "llvm/ADT/SmallPtrSet.h"
  45 #include "llvm/ADT/Statistic.h"
  46 #include "llvm/ADT/STLExtras.h"
  47 using namespace llvm;
  48
  49 STATISTIC(NumTwoAddressInstrs, "Number of two-address instructions");
  50 STATISTIC(NumCommuted        , "Number of instructions commuted to coalesce");
  51 STATISTIC(NumConvertedTo3Addr, "Number of instructions promoted to 3-address");
  52 STATISTIC(Num3AddrSunk,        "Number of 3-address instructions sunk");
  53 STATISTIC(NumReMats,           "Number of instructions re-materialized");
  54
  55 namespace {
  56   class VISIBILITY_HIDDEN TwoAddressInstructionPass
  57     : public MachineFunctionPass {
  58     const TargetInstrInfo *TII;
  59     const TargetRegisterInfo *TRI;
  60     MachineRegisterInfo *MRI;
  61     LiveVariables *LV;
  62
  63     bool Sink3AddrInstruction(MachineBasicBlock *MBB, MachineInstr *MI,
  64                               unsigned Reg,
  65                               MachineBasicBlock::iterator OldPos);
  66
  67     bool isSafeToReMat(unsigned DstReg, MachineInstr *MI);
  68     bool isProfitableToReMat(unsigned Reg, const TargetRegisterClass *RC,
  69                              MachineInstr *MI, MachineInstr *DefMI,
  70                              MachineBasicBlock *MBB, unsigned Loc,
  71                              DenseMap<MachineInstr*, unsigned> &DistanceMap);
  72   public:
  73     static char ID; // Pass identification, replacement for typeid
  74     TwoAddressInstructionPass() : MachineFunctionPass((intptr_t)&ID) {}
  75
  76     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  77       AU.addPreserved<LiveVariables>();
  78       AU.addPreservedID(MachineLoopInfoID);
  79       AU.addPreservedID(MachineDominatorsID);
  80       AU.addPreservedID(PHIEliminationID);
  81       MachineFunctionPass::getAnalysisUsage(AU);
  82     }
  83
  84     /// runOnMachineFunction - Pass entry point.
  85     bool runOnMachineFunction(MachineFunction&);
  86   };
  87 }
  88
  89 char TwoAddressInstructionPass::ID = 0;
  90 static RegisterPass<TwoAddressInstructionPass>
  91 X("twoaddressinstruction", "Two-Address instruction pass");
  92
  93 const PassInfo *const llvm::TwoAddressInstructionPassID = &X;
  94
  95 /// Sink3AddrInstruction - A two-address instruction has been converted to a
  96 /// three-address instruction to avoid clobbering a register. Try to sink it
  97 /// past the instruction that would kill the above mentioned register to reduce
  98 /// register pressure.
  99 bool TwoAddressInstructionPass::Sink3AddrInstruction(MachineBasicBlock *MBB,
 100                                            MachineInstr *MI, unsigned SavedReg,
 101                                            MachineBasicBlock::iterator OldPos) {
 102   // Check if it's safe to move this instruction.
 103   bool SeenStore = true; // Be conservative.
 104   if (!MI->isSafeToMove(TII, SeenStore))
 105     return false;
 106
 107   unsigned DefReg = 0;
 108   SmallSet<unsigned, 4> UseRegs;
 109
 110   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 111     const MachineOperand &MO = MI->getOperand(i);
 112     if (!MO.isRegister())
 113       continue;
 114     unsigned MOReg = MO.getReg();
 115     if (!MOReg)
 116       continue;
 117     if (MO.isUse() && MOReg != SavedReg)
 118       UseRegs.insert(MO.getReg());
 119     if (!MO.isDef())
 120       continue;
 121     if (MO.isImplicit())
 122       // Don't try to move it if it implicitly defines a register.
 123       return false;
 124     if (DefReg)
 125       // For now, don't move any instructions that define multiple registers.
 126       return false;
 127     DefReg = MO.getReg();
 128   }
 129
 130   // Find the instruction that kills SavedReg.
 131   MachineInstr *KillMI = NULL;
 132   for (MachineRegisterInfo::use_iterator UI = MRI->use_begin(SavedReg),
 133          UE = MRI->use_end(); UI != UE; ++UI) {
 134     MachineOperand &UseMO = UI.getOperand();
 135     if (!UseMO.isKill())
 136       continue;
 137     KillMI = UseMO.getParent();
 138     break;
 139   }
 140
 141   if (!KillMI || KillMI->getParent() != MBB)
 142     return false;
 143
 144   // If any of the definitions are used by another instruction between the
 145   // position and the kill use, then it's not safe to sink it.
 146   //
 147   // FIXME: This can be sped up if there is an easy way to query whether an
 148   // instruction is before or after another instruction. Then we can use
 149   // MachineRegisterInfo def / use instead.
 150   MachineOperand *KillMO = NULL;
 151   MachineBasicBlock::iterator KillPos = KillMI;
 152   ++KillPos;
 153
 154   unsigned NumVisited = 0;
 155   for (MachineBasicBlock::iterator I = next(OldPos); I != KillPos; ++I) {
 156     MachineInstr *OtherMI = I;
 157     if (NumVisited > 30)  // FIXME: Arbitrary limit to reduce compile time cost.
 158       return false;
 159     ++NumVisited;
 160     for (unsigned i = 0, e = OtherMI->getNumOperands(); i != e; ++i) {
 161       MachineOperand &MO = OtherMI->getOperand(i);
 162       if (!MO.isRegister())
 163         continue;
 164       unsigned MOReg = MO.getReg();
 165       if (!MOReg)
 166         continue;
 167       if (DefReg == MOReg)
 168         return false;
 169
 170       if (MO.isKill()) {
 171         if (OtherMI == KillMI && MOReg == SavedReg)
 172           // Save the operand that kills the register. We want to unset the kill
 173           // marker if we can sink MI past it.
 174           KillMO = &MO;
 175         else if (UseRegs.count(MOReg))
 176           // One of the uses is killed before the destination.
 177           return false;
 178       }
 179     }
 180   }
 181
 182   // Update kill and LV information.
 183   KillMO->setIsKill(false);
 184   KillMO = MI->findRegisterUseOperand(SavedReg, false, TRI);
 185   KillMO->setIsKill(true);
 186
 187   if (LV)
 188     LV->replaceKillInstruction(SavedReg, KillMI, MI);
 189
 190   // Move instruction to its destination.
 191   MBB->remove(MI);
 192   MBB->insert(KillPos, MI);
 193
 194   ++Num3AddrSunk;
 195   return true;
 196 }
 197
 198 /// isSafeToReMat - Return true if it's safe to rematerialize the specified
 199 /// instruction which defined the specified register instead of copying it.
 200 bool
 201 TwoAddressInstructionPass::isSafeToReMat(unsigned DstReg, MachineInstr *MI) {
 202   const TargetInstrDesc &TID = MI->getDesc();
 203   if (!TID.isAsCheapAsAMove())
 204     return false;
 205   bool SawStore = false;
 206   if (!MI->isSafeToMove(TII, SawStore))
 207     return false;
 208   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 209     MachineOperand &MO = MI->getOperand(i);
 210     if (!MO.isRegister())
 211       continue;
 212     // FIXME: For now, do not remat any instruction with register operands.
 213     // Later on, we can loosen the restriction is the register operands have
 214     // not been modified between the def and use. Note, this is different from
 215     // MachineSink because the code in no longer in two-address form (at least
 216     // partially).
 217     if (MO.isUse())
 218       return false;
 219     else if (!MO.isDead() && MO.getReg() != DstReg)
 220       return false;
 221   }
 222   return true;
 223 }
 224
 225 /// isTwoAddrUse - Return true if the specified MI is using the specified
 226 /// register as a two-address operand.
 227 static bool isTwoAddrUse(MachineInstr *UseMI, unsigned Reg) {
 228   const TargetInstrDesc &TID = UseMI->getDesc();
 229   for (unsigned i = 0, e = TID.getNumOperands(); i != e; ++i) {
 230     MachineOperand &MO = UseMI->getOperand(i);
 231     if (MO.isRegister() && MO.getReg() == Reg &&
 232         (MO.isDef() || TID.getOperandConstraint(i, TOI::TIED_TO) != -1))
 233       // Earlier use is a two-address one.
 234       return true;
 235   }
 236   return false;
 237 }
 238
 239 /// isProfitableToReMat - Return true if the heuristics determines it is likely
 240 /// to be profitable to re-materialize the definition of Reg rather than copy
 241 /// the register.
 242 bool
 243 TwoAddressInstructionPass::isProfitableToReMat(unsigned Reg,
 244                                 const TargetRegisterClass *RC,
 245                                 MachineInstr *MI, MachineInstr *DefMI,
 246                                 MachineBasicBlock *MBB, unsigned Loc,
 247                                 DenseMap<MachineInstr*, unsigned> &DistanceMap){
 248   bool OtherUse = false;
 249   for (MachineRegisterInfo::use_iterator UI = MRI->use_begin(Reg),
 250          UE = MRI->use_end(); UI != UE; ++UI) {
 251     MachineOperand &UseMO = UI.getOperand();
 252     if (!UseMO.isUse())
 253       continue;
 254     MachineInstr *UseMI = UseMO.getParent();
 255     MachineBasicBlock *UseMBB = UseMI->getParent();
 256     if (UseMBB == MBB) {
 257       DenseMap<MachineInstr*, unsigned>::iterator DI = DistanceMap.find(UseMI);
 258       if (DI != DistanceMap.end() && DI->second == Loc)
 259         continue;  // Current use.
 260       OtherUse = true;
 261       // There is at least one other use in the MBB that will clobber the
 262       // register.
 263       if (isTwoAddrUse(UseMI, Reg))
 264         return true;
 265     }
 266   }
 267
 268   // If other uses in MBB are not two-address uses, then don't remat.
 269   if (OtherUse)
 270     return false;
 271
 272   // No other uses in the same block, remat if it's defined in the same
 273   // block so it does not unnecessarily extend the live range.
 274   return MBB == DefMI->getParent();
 275 }
 276
 277 /// runOnMachineFunction - Reduce two-address instructions to two operands.
 278 ///
 279 bool TwoAddressInstructionPass::runOnMachineFunction(MachineFunction &MF) {
 280   DOUT << "Machine Function\n";
 281   const TargetMachine &TM = MF.getTarget();
 282   MRI = &MF.getRegInfo();
 283   TII = TM.getInstrInfo();
 284   TRI = TM.getRegisterInfo();
 285   LV = getAnalysisToUpdate<LiveVariables>();
 286
 287   bool MadeChange = false;
 288
 289   DOUT << "********** REWRITING TWO-ADDR INSTRS **********\n";
 290   DOUT << "********** Function: " << MF.getFunction()->getName() << '\n';
 291
 292   // ReMatRegs - Keep track of the registers whose def's are remat'ed.
 293   BitVector ReMatRegs;
 294   ReMatRegs.resize(MRI->getLastVirtReg()+1);
 295
 296   // DistanceMap - Keep track the distance of a MI from the start of the
 297   // current basic block.
 298   DenseMap<MachineInstr*, unsigned> DistanceMap;
 299
 300   for (MachineFunction::iterator mbbi = MF.begin(), mbbe = MF.end();
 301        mbbi != mbbe; ++mbbi) {
 302     unsigned Dist = 0;
 303     DistanceMap.clear();
 304     for (MachineBasicBlock::iterator mi = mbbi->begin(), me = mbbi->end();
 305          mi != me; ) {
 306       MachineBasicBlock::iterator nmi = next(mi);
 307       const TargetInstrDesc &TID = mi->getDesc();
 308       bool FirstTied = true;
 309
 310       DistanceMap.insert(std::make_pair(mi, ++Dist));
 311       for (unsigned si = 1, e = TID.getNumOperands(); si < e; ++si) {
 312         int ti = TID.getOperandConstraint(si, TOI::TIED_TO);
 313         if (ti == -1)
 314           continue;
 315
 316         if (FirstTied) {
 317           ++NumTwoAddressInstrs;
 318           DOUT << '\t'; DEBUG(mi->print(*cerr.stream(), &TM));
 319         }
 320
 321         FirstTied = false;
 322
 323         assert(mi->getOperand(si).isRegister() && mi->getOperand(si).getReg() &&
 324                mi->getOperand(si).isUse() && "two address instruction invalid");
 325
 326         // If the two operands are the same we just remove the use
 327         // and mark the def as def&use, otherwise we have to insert a copy.
 328         if (mi->getOperand(ti).getReg() != mi->getOperand(si).getReg()) {
 329           // Rewrite:
 330           //     a = b op c
 331           // to:
 332           //     a = b
 333           //     a = a op c
 334           unsigned regA = mi->getOperand(ti).getReg();
 335           unsigned regB = mi->getOperand(si).getReg();
 336
 337           assert(TargetRegisterInfo::isVirtualRegister(regA) &&
 338                  TargetRegisterInfo::isVirtualRegister(regB) &&
 339                  "cannot update physical register live information");
 340
 341 #ifndef NDEBUG
 342           // First, verify that we don't have a use of a in the instruction (a =
 343           // b + a for example) because our transformation will not work. This
 344           // should never occur because we are in SSA form.
 345           for (unsigned i = 0; i != mi->getNumOperands(); ++i)
 346             assert((int)i == ti ||
 347                    !mi->getOperand(i).isRegister() ||
 348                    mi->getOperand(i).getReg() != regA);
 349 #endif
 350
 351           // If this instruction is not the killing user of B, see if we can
 352           // rearrange the code to make it so.  Making it the killing user will
 353           // allow us to coalesce A and B together, eliminating the copy we are
 354           // about to insert.
 355           if (!mi->killsRegister(regB)) {
 356             // If this instruction is commutative, check to see if C dies.  If
 357             // so, swap the B and C operands.  This makes the live ranges of A
 358             // and C joinable.
 359             // FIXME: This code also works for A := B op C instructions.
 360             if (TID.isCommutable() && mi->getNumOperands() >= 3) {
 361               assert(mi->getOperand(3-si).isRegister() &&
 362                      "Not a proper commutative instruction!");
 363               unsigned regC = mi->getOperand(3-si).getReg();
 364
 365               if (mi->killsRegister(regC)) {
 366                 DOUT << "2addr: COMMUTING  : " << *mi;
 367                 MachineInstr *NewMI = TII->commuteInstruction(mi);
 368
 369                 if (NewMI == 0) {
 370                   DOUT << "2addr: COMMUTING FAILED!\n";
 371                 } else {
 372                   DOUT << "2addr: COMMUTED TO: " << *NewMI;
 373                   // If the instruction changed to commute it, update livevar.
 374                   if (NewMI != mi) {
 375                     if (LV)
 376                       // Update live variables
 377                       LV->replaceKillInstruction(regC, mi, NewMI);
 378
 379                     mbbi->insert(mi, NewMI);           // Insert the new inst
 380                     mbbi->erase(mi);                   // Nuke the old inst.
 381                     mi = NewMI;
 382                     DistanceMap.insert(std::make_pair(NewMI, Dist));
 383                   }
 384
 385                   ++NumCommuted;
 386                   regB = regC;
 387                   goto InstructionRearranged;
 388                 }
 389               }
 390             }
 391
 392             // If this instruction is potentially convertible to a true
 393             // three-address instruction,
 394             if (TID.isConvertibleTo3Addr()) {
 395               // FIXME: This assumes there are no more operands which are tied
 396               // to another register.
 397 #ifndef NDEBUG
 398               for (unsigned i = si + 1, e = TID.getNumOperands(); i < e; ++i)
 399                 assert(TID.getOperandConstraint(i, TOI::TIED_TO) == -1);
 400 #endif
 401
 402               MachineInstr *NewMI = TII->convertToThreeAddress(mbbi, mi, LV);
 403               if (NewMI) {
 404                 DOUT << "2addr: CONVERTING 2-ADDR: " << *mi;
 405                 DOUT << "2addr:         TO 3-ADDR: " << *NewMI;
 406                 bool Sunk = false;
 407
 408                 if (NewMI->findRegisterUseOperand(regB, false, TRI))
 409                   // FIXME: Temporary workaround. If the new instruction doesn't
 410                   // uses regB, convertToThreeAddress must have created more
 411                   // then one instruction.
 412                   Sunk = Sink3AddrInstruction(mbbi, NewMI, regB, mi);
 413
 414                 mbbi->erase(mi); // Nuke the old inst.
 415
 416                 if (!Sunk) {
 417                   DistanceMap.insert(std::make_pair(NewMI, Dist));
 418                   mi = NewMI;
 419                   nmi = next(mi);
 420                 }
 421
 422                 ++NumConvertedTo3Addr;
 423                 break; // Done with this instruction.
 424               }
 425             }
 426           }
 427
 428         InstructionRearranged:
 429           const TargetRegisterClass* rc = MRI->getRegClass(regA);
 430           MachineInstr *DefMI = MRI->getVRegDef(regB);
 431           // If it's safe and profitable, remat the definition instead of
 432           // copying it.
 433           if (DefMI &&
 434               isSafeToReMat(regB, DefMI) &&
 435               isProfitableToReMat(regB, rc, mi, DefMI, mbbi, Dist,DistanceMap)){
 436             DEBUG(cerr << "2addr: REMATTING : " << *DefMI << "\n");
 437             TII->reMaterialize(*mbbi, mi, regA, DefMI);
 438             ReMatRegs.set(regB);
 439             ++NumReMats;
 440           } else {
 441             TII->copyRegToReg(*mbbi, mi, regA, regB, rc, rc);
 442           }
 443
 444           MachineBasicBlock::iterator prevMi = prior(mi);
 445           DOUT << "\t\tprepend:\t"; DEBUG(prevMi->print(*cerr.stream(), &TM));
 446
 447           // Update live variables for regB.
 448           if (LV) {
 449             LiveVariables::VarInfo& varInfoB = LV->getVarInfo(regB);
 450
 451             // regB is used in this BB.
 452             varInfoB.UsedBlocks[mbbi->getNumber()] = true;
 453
 454             if (LV->removeVirtualRegisterKilled(regB,  mi))
 455               LV->addVirtualRegisterKilled(regB, prevMi);
 456
 457             if (LV->removeVirtualRegisterDead(regB, mi))
 458               LV->addVirtualRegisterDead(regB, prevMi);
 459           }
 460
 461           // Replace all occurences of regB with regA.
 462           for (unsigned i = 0, e = mi->getNumOperands(); i != e; ++i) {
 463             if (mi->getOperand(i).isRegister() &&
 464                 mi->getOperand(i).getReg() == regB)
 465               mi->getOperand(i).setReg(regA);
 466           }
 467         }
 468
 469         assert(mi->getOperand(ti).isDef() && mi->getOperand(si).isUse());
 470         mi->getOperand(ti).setReg(mi->getOperand(si).getReg());
 471         MadeChange = true;
 472
 473         DOUT << "\t\trewrite to:\t"; DEBUG(mi->print(*cerr.stream(), &TM));
 474       }
 475
 476       mi = nmi;
 477     }
 478   }
 479
 480   // Some remat'ed instructions are dead.
 481   int VReg = ReMatRegs.find_first();
 482   while (VReg != -1) {
 483     if (MRI->use_empty(VReg)) {
 484       MachineInstr *DefMI = MRI->getVRegDef(VReg);
 485       DefMI->eraseFromParent();
 486     }
 487     VReg = ReMatRegs.find_next(VReg);
 488   }
 489
 490   return MadeChange;
 491 }