lib/CodeGen/LowerSubregs.cpp

   1 //===-- LowerSubregs.cpp - Subregister Lowering 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 defines a MachineFunction pass which runs after register
  11 // allocation that turns subreg insert/extract instructions into register
  12 // copies, as needed. This ensures correct codegen even if the coalescer
  13 // isn't able to remove all subreg instructions.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #define DEBUG_TYPE "lowersubregs"
  18 #include "llvm/CodeGen/Passes.h"
  19 #include "llvm/Function.h"
  20 #include "llvm/CodeGen/MachineFunctionPass.h"
  21 #include "llvm/CodeGen/MachineInstr.h"
  22 #include "llvm/CodeGen/MachineInstrBuilder.h"
  23 #include "llvm/CodeGen/MachineRegisterInfo.h"
  24 #include "llvm/Target/TargetRegisterInfo.h"
  25 #include "llvm/Target/TargetInstrInfo.h"
  26 #include "llvm/Target/TargetMachine.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 using namespace llvm;
  30
  31 namespace {
  32   struct LowerSubregsInstructionPass : public MachineFunctionPass {
  33   private:
  34     const TargetRegisterInfo *TRI;
  35     const TargetInstrInfo *TII;
  36
  37   public:
  38     static char ID; // Pass identification, replacement for typeid
  39     LowerSubregsInstructionPass() : MachineFunctionPass(&ID) {}
  40
  41     const char *getPassName() const {
  42       return "Subregister lowering instruction pass";
  43     }
  44
  45     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  46       AU.setPreservesCFG();
  47       AU.addPreservedID(MachineLoopInfoID);
  48       AU.addPreservedID(MachineDominatorsID);
  49       MachineFunctionPass::getAnalysisUsage(AU);
  50     }
  51
  52     /// runOnMachineFunction - pass entry point
  53     bool runOnMachineFunction(MachineFunction&);
  54
  55   private:
  56     bool LowerExtract(MachineInstr *MI);
  57     bool LowerInsert(MachineInstr *MI);
  58     bool LowerSubregToReg(MachineInstr *MI);
  59     bool LowerCopy(MachineInstr *MI);
  60
  61     void TransferDeadFlag(MachineInstr *MI, unsigned DstReg,
  62                           const TargetRegisterInfo *TRI);
  63     void TransferKillFlag(MachineInstr *MI, unsigned SrcReg,
  64                           const TargetRegisterInfo *TRI,
  65                           bool AddIfNotFound = false);
  66     void TransferImplicitDefs(MachineInstr *MI);
  67   };
  68
  69   char LowerSubregsInstructionPass::ID = 0;
  70 }
  71
  72 FunctionPass *llvm::createLowerSubregsPass() {
  73   return new LowerSubregsInstructionPass();
  74 }
  75
  76 /// TransferDeadFlag - MI is a pseudo-instruction with DstReg dead,
  77 /// and the lowered replacement instructions immediately precede it.
  78 /// Mark the replacement instructions with the dead flag.
  79 void
  80 LowerSubregsInstructionPass::TransferDeadFlag(MachineInstr *MI,
  81                                               unsigned DstReg,
  82                                               const TargetRegisterInfo *TRI) {
  83   for (MachineBasicBlock::iterator MII =
  84         prior(MachineBasicBlock::iterator(MI)); ; --MII) {
  85     if (MII->addRegisterDead(DstReg, TRI))
  86       break;
  87     assert(MII != MI->getParent()->begin() &&
  88            "copyRegToReg output doesn't reference destination register!");
  89   }
  90 }
  91
  92 /// TransferKillFlag - MI is a pseudo-instruction with SrcReg killed,
  93 /// and the lowered replacement instructions immediately precede it.
  94 /// Mark the replacement instructions with the kill flag.
  95 void
  96 LowerSubregsInstructionPass::TransferKillFlag(MachineInstr *MI,
  97                                               unsigned SrcReg,
  98                                               const TargetRegisterInfo *TRI,
  99                                               bool AddIfNotFound) {
 100   for (MachineBasicBlock::iterator MII =
 101         prior(MachineBasicBlock::iterator(MI)); ; --MII) {
 102     if (MII->addRegisterKilled(SrcReg, TRI, AddIfNotFound))
 103       break;
 104     assert(MII != MI->getParent()->begin() &&
 105            "copyRegToReg output doesn't reference source register!");
 106   }
 107 }
 108
 109 /// TransferImplicitDefs - MI is a pseudo-instruction, and the lowered
 110 /// replacement instructions immediately precede it.  Copy any implicit-def
 111 /// operands from MI to the replacement instruction.
 112 void
 113 LowerSubregsInstructionPass::TransferImplicitDefs(MachineInstr *MI) {
 114   MachineBasicBlock::iterator CopyMI = MI;
 115   --CopyMI;
 116
 117   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 118     MachineOperand &MO = MI->getOperand(i);
 119     if (!MO.isReg() || !MO.isImplicit() || MO.isUse())
 120       continue;
 121     CopyMI->addOperand(MachineOperand::CreateReg(MO.getReg(), true, true));
 122   }
 123 }
 124
 125 bool LowerSubregsInstructionPass::LowerExtract(MachineInstr *MI) {
 126   MachineBasicBlock *MBB = MI->getParent();
 127
 128   assert(MI->getOperand(0).isReg() && MI->getOperand(0).isDef() &&
 129          MI->getOperand(1).isReg() && MI->getOperand(1).isUse() &&
 130          MI->getOperand(2).isImm() && "Malformed extract_subreg");
 131
 132   unsigned DstReg   = MI->getOperand(0).getReg();
 133   unsigned SuperReg = MI->getOperand(1).getReg();
 134   unsigned SubIdx   = MI->getOperand(2).getImm();
 135   unsigned SrcReg   = TRI->getSubReg(SuperReg, SubIdx);
 136
 137   assert(TargetRegisterInfo::isPhysicalRegister(SuperReg) &&
 138          "Extract supperg source must be a physical register");
 139   assert(TargetRegisterInfo::isPhysicalRegister(DstReg) &&
 140          "Extract destination must be in a physical register");
 141   assert(SrcReg && "invalid subregister index for register");
 142
 143   DEBUG(dbgs() << "subreg: CONVERTING: " << *MI);
 144
 145   if (SrcReg == DstReg) {
 146     // No need to insert an identity copy instruction.
 147     if (MI->getOperand(1).isKill()) {
 148       // We must make sure the super-register gets killed. Replace the
 149       // instruction with KILL.
 150       MI->setDesc(TII->get(TargetOpcode::KILL));
 151       MI->RemoveOperand(2);     // SubIdx
 152       DEBUG(dbgs() << "subreg: replace by: " << *MI);
 153       return true;
 154     }
 155
 156     DEBUG(dbgs() << "subreg: eliminated!");
 157   } else {
 158     // Insert copy
 159     const TargetRegisterClass *TRCS = TRI->getPhysicalRegisterRegClass(DstReg);
 160     const TargetRegisterClass *TRCD = TRI->getPhysicalRegisterRegClass(SrcReg);
 161     bool Emitted = TII->copyRegToReg(*MBB, MI, DstReg, SrcReg, TRCD, TRCS,
 162                                      MI->getDebugLoc());
 163     (void)Emitted;
 164     assert(Emitted && "Subreg and Dst must be of compatible register class");
 165     // Transfer the kill/dead flags, if needed.
 166     if (MI->getOperand(0).isDead())
 167       TransferDeadFlag(MI, DstReg, TRI);
 168     if (MI->getOperand(1).isKill())
 169       TransferKillFlag(MI, SuperReg, TRI, true);
 170     TransferImplicitDefs(MI);
 171     DEBUG({
 172         MachineBasicBlock::iterator dMI = MI;
 173         dbgs() << "subreg: " << *(--dMI);
 174       });
 175   }
 176
 177   DEBUG(dbgs() << '\n');
 178   MBB->erase(MI);
 179   return true;
 180 }
 181
 182 bool LowerSubregsInstructionPass::LowerSubregToReg(MachineInstr *MI) {
 183   MachineBasicBlock *MBB = MI->getParent();
 184   assert((MI->getOperand(0).isReg() && MI->getOperand(0).isDef()) &&
 185          MI->getOperand(1).isImm() &&
 186          (MI->getOperand(2).isReg() && MI->getOperand(2).isUse()) &&
 187           MI->getOperand(3).isImm() && "Invalid subreg_to_reg");
 188
 189   unsigned DstReg  = MI->getOperand(0).getReg();
 190   unsigned InsReg  = MI->getOperand(2).getReg();
 191   assert(!MI->getOperand(2).getSubReg() && "SubIdx on physreg?");
 192   unsigned SubIdx  = MI->getOperand(3).getImm();
 193
 194   assert(SubIdx != 0 && "Invalid index for insert_subreg");
 195   unsigned DstSubReg = TRI->getSubReg(DstReg, SubIdx);
 196
 197   assert(TargetRegisterInfo::isPhysicalRegister(DstReg) &&
 198          "Insert destination must be in a physical register");
 199   assert(TargetRegisterInfo::isPhysicalRegister(InsReg) &&
 200          "Inserted value must be in a physical register");
 201
 202   DEBUG(dbgs() << "subreg: CONVERTING: " << *MI);
 203
 204   if (DstSubReg == InsReg) {
 205     // No need to insert an identify copy instruction.
 206     // Watch out for case like this:
 207     // %RAX<def> = SUBREG_TO_REG 0, %EAX<kill>, 3
 208     // We must leave %RAX live.
 209     if (DstReg != InsReg) {
 210       MI->setDesc(TII->get(TargetOpcode::KILL));
 211       MI->RemoveOperand(3);     // SubIdx
 212       MI->RemoveOperand(1);     // Imm
 213       DEBUG(dbgs() << "subreg: replace by: " << *MI);
 214       return true;
 215     }
 216     DEBUG(dbgs() << "subreg: eliminated!");
 217   } else {
 218     // Insert sub-register copy
 219     const TargetRegisterClass *TRC0= TRI->getPhysicalRegisterRegClass(DstSubReg);
 220     const TargetRegisterClass *TRC1= TRI->getPhysicalRegisterRegClass(InsReg);
 221     bool Emitted = TII->copyRegToReg(*MBB, MI, DstSubReg, InsReg, TRC0, TRC1,
 222                                      MI->getDebugLoc());
 223     (void)Emitted;
 224     assert(Emitted && "Subreg and Dst must be of compatible register class");
 225     // Transfer the kill/dead flags, if needed.
 226     if (MI->getOperand(0).isDead())
 227       TransferDeadFlag(MI, DstSubReg, TRI);
 228     if (MI->getOperand(2).isKill())
 229       TransferKillFlag(MI, InsReg, TRI);
 230     DEBUG({
 231         MachineBasicBlock::iterator dMI = MI;
 232         dbgs() << "subreg: " << *(--dMI);
 233       });
 234   }
 235
 236   DEBUG(dbgs() << '\n');
 237   MBB->erase(MI);
 238   return true;
 239 }
 240
 241 bool LowerSubregsInstructionPass::LowerInsert(MachineInstr *MI) {
 242   MachineBasicBlock *MBB = MI->getParent();
 243   assert((MI->getOperand(0).isReg() && MI->getOperand(0).isDef()) &&
 244          (MI->getOperand(1).isReg() && MI->getOperand(1).isUse()) &&
 245          (MI->getOperand(2).isReg() && MI->getOperand(2).isUse()) &&
 246           MI->getOperand(3).isImm() && "Invalid insert_subreg");
 247
 248   unsigned DstReg = MI->getOperand(0).getReg();
 249 #ifndef NDEBUG
 250   unsigned SrcReg = MI->getOperand(1).getReg();
 251 #endif
 252   unsigned InsReg = MI->getOperand(2).getReg();
 253   unsigned SubIdx = MI->getOperand(3).getImm();
 254
 255   assert(DstReg == SrcReg && "insert_subreg not a two-address instruction?");
 256   assert(SubIdx != 0 && "Invalid index for insert_subreg");
 257   unsigned DstSubReg = TRI->getSubReg(DstReg, SubIdx);
 258   assert(DstSubReg && "invalid subregister index for register");
 259   assert(TargetRegisterInfo::isPhysicalRegister(SrcReg) &&
 260          "Insert superreg source must be in a physical register");
 261   assert(TargetRegisterInfo::isPhysicalRegister(InsReg) &&
 262          "Inserted value must be in a physical register");
 263
 264   DEBUG(dbgs() << "subreg: CONVERTING: " << *MI);
 265
 266   if (DstSubReg == InsReg) {
 267     // No need to insert an identity copy instruction. If the SrcReg was
 268     // <undef>, we need to make sure it is alive by inserting a KILL
 269     if (MI->getOperand(1).isUndef() && !MI->getOperand(0).isDead()) {
 270       MachineInstrBuilder MIB = BuildMI(*MBB, MI, MI->getDebugLoc(),
 271                                 TII->get(TargetOpcode::KILL), DstReg);
 272       if (MI->getOperand(2).isUndef())
 273         MIB.addReg(InsReg, RegState::Undef);
 274       else
 275         MIB.addReg(InsReg, RegState::Kill);
 276     } else {
 277       DEBUG(dbgs() << "subreg: eliminated!\n");
 278       MBB->erase(MI);
 279       return true;
 280     }
 281   } else {
 282     // Insert sub-register copy
 283     const TargetRegisterClass *TRC0= TRI->getPhysicalRegisterRegClass(DstSubReg);
 284     const TargetRegisterClass *TRC1= TRI->getPhysicalRegisterRegClass(InsReg);
 285     if (MI->getOperand(2).isUndef())
 286       // If the source register being inserted is undef, then this becomes a
 287       // KILL.
 288       BuildMI(*MBB, MI, MI->getDebugLoc(),
 289               TII->get(TargetOpcode::KILL), DstSubReg);
 290     else {
 291       bool Emitted = TII->copyRegToReg(*MBB, MI, DstSubReg, InsReg, TRC0, TRC1,
 292                                        MI->getDebugLoc());
 293       (void)Emitted;
 294       assert(Emitted && "Subreg and Dst must be of compatible register class");
 295     }
 296     MachineBasicBlock::iterator CopyMI = MI;
 297     --CopyMI;
 298
 299     // INSERT_SUBREG is a two-address instruction so it implicitly kills SrcReg.
 300     if (!MI->getOperand(1).isUndef())
 301       CopyMI->addOperand(MachineOperand::CreateReg(DstReg, false, true, true));
 302
 303     // Transfer the kill/dead flags, if needed.
 304     if (MI->getOperand(0).isDead()) {
 305       TransferDeadFlag(MI, DstSubReg, TRI);
 306     } else {
 307       // Make sure the full DstReg is live after this replacement.
 308       CopyMI->addOperand(MachineOperand::CreateReg(DstReg, true, true));
 309     }
 310
 311     // Make sure the inserted register gets killed
 312     if (MI->getOperand(2).isKill() && !MI->getOperand(2).isUndef())
 313       TransferKillFlag(MI, InsReg, TRI);
 314   }
 315
 316   DEBUG({
 317       MachineBasicBlock::iterator dMI = MI;
 318       dbgs() << "subreg: " << *(--dMI) << "\n";
 319     });
 320
 321   MBB->erase(MI);
 322   return true;
 323 }
 324
 325 bool LowerSubregsInstructionPass::LowerCopy(MachineInstr *MI) {
 326   MachineOperand &DstMO = MI->getOperand(0);
 327   MachineOperand &SrcMO = MI->getOperand(1);
 328
 329   if (SrcMO.getReg() == DstMO.getReg()) {
 330     DEBUG(dbgs() << "identity copy: " << *MI);
 331     // No need to insert an identity copy instruction, but replace with a KILL
 332     // if liveness is changed.
 333     if (DstMO.isDead() || SrcMO.isUndef() || MI->getNumOperands() > 2) {
 334       // We must make sure the super-register gets killed. Replace the
 335       // instruction with KILL.
 336       MI->setDesc(TII->get(TargetOpcode::KILL));
 337       DEBUG(dbgs() << "replaced by:   " << *MI);
 338       return true;
 339     }
 340     // Vanilla identity copy.
 341     MI->eraseFromParent();
 342     return true;
 343   }
 344
 345   DEBUG(dbgs() << "real copy:   " << *MI);
 346   // Ask target for a lowered copy instruction.
 347   const TargetRegisterClass *DstRC =
 348     TRI->getPhysicalRegisterRegClass(DstMO.getReg());
 349   const TargetRegisterClass *SrcRC =
 350     TRI->getPhysicalRegisterRegClass(SrcMO.getReg());
 351   bool Emitted = TII->copyRegToReg(*MI->getParent(), MI,
 352                                    DstMO.getReg(), SrcMO.getReg(),
 353                                    DstRC, SrcRC, MI->getDebugLoc());
 354   (void)Emitted;
 355   assert(Emitted && "Cannot emit copy");
 356
 357   if (DstMO.isDead())
 358     TransferDeadFlag(MI, DstMO.getReg(), TRI);
 359   if (SrcMO.isKill())
 360     TransferKillFlag(MI, SrcMO.getReg(), TRI, true);
 361   if (MI->getNumOperands() > 2)
 362     TransferImplicitDefs(MI);
 363   DEBUG({
 364     MachineBasicBlock::iterator dMI = MI;
 365     dbgs() << "replaced by: " << *(--dMI);
 366   });
 367   MI->eraseFromParent();
 368   return true;
 369 }
 370
 371 /// runOnMachineFunction - Reduce subregister inserts and extracts to register
 372 /// copies.
 373 ///
 374 bool LowerSubregsInstructionPass::runOnMachineFunction(MachineFunction &MF) {
 375   DEBUG(dbgs() << "Machine Function\n"
 376                << "********** LOWERING SUBREG INSTRS **********\n"
 377                << "********** Function: "
 378                << MF.getFunction()->getName() << '\n');
 379   TRI = MF.getTarget().getRegisterInfo();
 380   TII = MF.getTarget().getInstrInfo();
 381
 382   bool MadeChange = false;
 383
 384   for (MachineFunction::iterator mbbi = MF.begin(), mbbe = MF.end();
 385        mbbi != mbbe; ++mbbi) {
 386     for (MachineBasicBlock::iterator mi = mbbi->begin(), me = mbbi->end();
 387          mi != me;) {
 388       MachineBasicBlock::iterator nmi = llvm::next(mi);
 389       MachineInstr *MI = mi;
 390       if (MI->isExtractSubreg()) {
 391         MadeChange |= LowerExtract(MI);
 392       } else if (MI->isInsertSubreg()) {
 393         MadeChange |= LowerInsert(MI);
 394       } else if (MI->isSubregToReg()) {
 395         MadeChange |= LowerSubregToReg(MI);
 396       } else if (MI->isCopy()) {
 397         MadeChange |= LowerCopy(MI);
 398       }
 399       mi = nmi;
 400     }
 401   }
 402
 403   return MadeChange;
 404 }