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
  60     void TransferDeadFlag(MachineInstr *MI, unsigned DstReg,
  61                           const TargetRegisterInfo *TRI);
  62     void TransferKillFlag(MachineInstr *MI, unsigned SrcReg,
  63                           const TargetRegisterInfo *TRI,
  64                           bool AddIfNotFound = false);
  65   };
  66
  67   char LowerSubregsInstructionPass::ID = 0;
  68 }
  69
  70 FunctionPass *llvm::createLowerSubregsPass() {
  71   return new LowerSubregsInstructionPass();
  72 }
  73
  74 /// TransferDeadFlag - MI is a pseudo-instruction with DstReg dead,
  75 /// and the lowered replacement instructions immediately precede it.
  76 /// Mark the replacement instructions with the dead flag.
  77 void
  78 LowerSubregsInstructionPass::TransferDeadFlag(MachineInstr *MI,
  79                                               unsigned DstReg,
  80                                               const TargetRegisterInfo *TRI) {
  81   for (MachineBasicBlock::iterator MII =
  82         prior(MachineBasicBlock::iterator(MI)); ; --MII) {
  83     if (MII->addRegisterDead(DstReg, TRI))
  84       break;
  85     assert(MII != MI->getParent()->begin() &&
  86            "copyRegToReg output doesn't reference destination register!");
  87   }
  88 }
  89
  90 /// TransferKillFlag - MI is a pseudo-instruction with SrcReg killed,
  91 /// and the lowered replacement instructions immediately precede it.
  92 /// Mark the replacement instructions with the kill flag.
  93 void
  94 LowerSubregsInstructionPass::TransferKillFlag(MachineInstr *MI,
  95                                               unsigned SrcReg,
  96                                               const TargetRegisterInfo *TRI,
  97                                               bool AddIfNotFound) {
  98   for (MachineBasicBlock::iterator MII =
  99         prior(MachineBasicBlock::iterator(MI)); ; --MII) {
 100     if (MII->addRegisterKilled(SrcReg, TRI, AddIfNotFound))
 101       break;
 102     assert(MII != MI->getParent()->begin() &&
 103            "copyRegToReg output doesn't reference source register!");
 104   }
 105 }
 106
 107 bool LowerSubregsInstructionPass::LowerExtract(MachineInstr *MI) {
 108   MachineBasicBlock *MBB = MI->getParent();
 109
 110   assert(MI->getOperand(0).isReg() && MI->getOperand(0).isDef() &&
 111          MI->getOperand(1).isReg() && MI->getOperand(1).isUse() &&
 112          MI->getOperand(2).isImm() && "Malformed extract_subreg");
 113
 114   unsigned DstReg   = MI->getOperand(0).getReg();
 115   unsigned SuperReg = MI->getOperand(1).getReg();
 116   unsigned SubIdx   = MI->getOperand(2).getImm();
 117   unsigned SrcReg   = TRI->getSubReg(SuperReg, SubIdx);
 118
 119   assert(TargetRegisterInfo::isPhysicalRegister(SuperReg) &&
 120          "Extract supperg source must be a physical register");
 121   assert(TargetRegisterInfo::isPhysicalRegister(DstReg) &&
 122          "Extract destination must be in a physical register");
 123   assert(SrcReg && "invalid subregister index for register");
 124
 125   DEBUG(dbgs() << "subreg: CONVERTING: " << *MI);
 126
 127   if (SrcReg == DstReg) {
 128     // No need to insert an identity copy instruction.
 129     if (MI->getOperand(1).isKill()) {
 130       // We must make sure the super-register gets killed. Replace the
 131       // instruction with KILL.
 132       MI->setDesc(TII->get(TargetOpcode::KILL));
 133       MI->RemoveOperand(2);     // SubIdx
 134       DEBUG(dbgs() << "subreg: replace by: " << *MI);
 135       return true;
 136     }
 137
 138     DEBUG(dbgs() << "subreg: eliminated!");
 139   } else {
 140     // Insert copy
 141     const TargetRegisterClass *TRCS = TRI->getPhysicalRegisterRegClass(DstReg);
 142     const TargetRegisterClass *TRCD = TRI->getPhysicalRegisterRegClass(SrcReg);
 143     bool Emitted = TII->copyRegToReg(*MBB, MI, DstReg, SrcReg, TRCD, TRCS);
 144     (void)Emitted;
 145     assert(Emitted && "Subreg and Dst must be of compatible register class");
 146     // Transfer the kill/dead flags, if needed.
 147     if (MI->getOperand(0).isDead())
 148       TransferDeadFlag(MI, DstReg, TRI);
 149     if (MI->getOperand(1).isKill())
 150       TransferKillFlag(MI, SuperReg, TRI, true);
 151     DEBUG({
 152         MachineBasicBlock::iterator dMI = MI;
 153         dbgs() << "subreg: " << *(--dMI);
 154       });
 155   }
 156
 157   DEBUG(dbgs() << '\n');
 158   MBB->erase(MI);
 159   return true;
 160 }
 161
 162 bool LowerSubregsInstructionPass::LowerSubregToReg(MachineInstr *MI) {
 163   MachineBasicBlock *MBB = MI->getParent();
 164   assert((MI->getOperand(0).isReg() && MI->getOperand(0).isDef()) &&
 165          MI->getOperand(1).isImm() &&
 166          (MI->getOperand(2).isReg() && MI->getOperand(2).isUse()) &&
 167           MI->getOperand(3).isImm() && "Invalid subreg_to_reg");
 168
 169   unsigned DstReg  = MI->getOperand(0).getReg();
 170   unsigned InsReg  = MI->getOperand(2).getReg();
 171   unsigned InsSIdx = MI->getOperand(2).getSubReg();
 172   unsigned SubIdx  = MI->getOperand(3).getImm();
 173
 174   assert(SubIdx != 0 && "Invalid index for insert_subreg");
 175   unsigned DstSubReg = TRI->getSubReg(DstReg, SubIdx);
 176
 177   assert(TargetRegisterInfo::isPhysicalRegister(DstReg) &&
 178          "Insert destination must be in a physical register");
 179   assert(TargetRegisterInfo::isPhysicalRegister(InsReg) &&
 180          "Inserted value must be in a physical register");
 181
 182   DEBUG(dbgs() << "subreg: CONVERTING: " << *MI);
 183
 184   if (DstSubReg == InsReg && InsSIdx == 0) {
 185     // No need to insert an identify copy instruction.
 186     // Watch out for case like this:
 187     // %RAX<def> = ...
 188     // %RAX<def> = SUBREG_TO_REG 0, %EAX:3<kill>, 3
 189     // The first def is defining RAX, not EAX so the top bits were not
 190     // zero extended.
 191     DEBUG(dbgs() << "subreg: eliminated!");
 192   } else {
 193     // Insert sub-register copy
 194     const TargetRegisterClass *TRC0= TRI->getPhysicalRegisterRegClass(DstSubReg);
 195     const TargetRegisterClass *TRC1= TRI->getPhysicalRegisterRegClass(InsReg);
 196     bool Emitted = TII->copyRegToReg(*MBB, MI, DstSubReg, InsReg, TRC0, TRC1);
 197     (void)Emitted;
 198     assert(Emitted && "Subreg and Dst must be of compatible register class");
 199     // Transfer the kill/dead flags, if needed.
 200     if (MI->getOperand(0).isDead())
 201       TransferDeadFlag(MI, DstSubReg, TRI);
 202     if (MI->getOperand(2).isKill())
 203       TransferKillFlag(MI, InsReg, TRI);
 204     DEBUG({
 205         MachineBasicBlock::iterator dMI = MI;
 206         dbgs() << "subreg: " << *(--dMI);
 207       });
 208   }
 209
 210   DEBUG(dbgs() << '\n');
 211   MBB->erase(MI);
 212   return true;
 213 }
 214
 215 bool LowerSubregsInstructionPass::LowerInsert(MachineInstr *MI) {
 216   MachineBasicBlock *MBB = MI->getParent();
 217   assert((MI->getOperand(0).isReg() && MI->getOperand(0).isDef()) &&
 218          (MI->getOperand(1).isReg() && MI->getOperand(1).isUse()) &&
 219          (MI->getOperand(2).isReg() && MI->getOperand(2).isUse()) &&
 220           MI->getOperand(3).isImm() && "Invalid insert_subreg");
 221
 222   unsigned DstReg = MI->getOperand(0).getReg();
 223 #ifndef NDEBUG
 224   unsigned SrcReg = MI->getOperand(1).getReg();
 225 #endif
 226   unsigned InsReg = MI->getOperand(2).getReg();
 227   unsigned SubIdx = MI->getOperand(3).getImm();
 228
 229   assert(DstReg == SrcReg && "insert_subreg not a two-address instruction?");
 230   assert(SubIdx != 0 && "Invalid index for insert_subreg");
 231   unsigned DstSubReg = TRI->getSubReg(DstReg, SubIdx);
 232   assert(DstSubReg && "invalid subregister index for register");
 233   assert(TargetRegisterInfo::isPhysicalRegister(SrcReg) &&
 234          "Insert superreg source must be in a physical register");
 235   assert(TargetRegisterInfo::isPhysicalRegister(InsReg) &&
 236          "Inserted value must be in a physical register");
 237
 238   DEBUG(dbgs() << "subreg: CONVERTING: " << *MI);
 239
 240   if (DstSubReg == InsReg) {
 241     // No need to insert an identity copy instruction. If the SrcReg was
 242     // <undef>, we need to make sure it is alive by inserting a KILL
 243     if (MI->getOperand(1).isUndef() && !MI->getOperand(0).isDead()) {
 244       MachineInstrBuilder MIB = BuildMI(*MBB, MI, MI->getDebugLoc(),
 245                                 TII->get(TargetOpcode::KILL), DstReg);
 246       if (MI->getOperand(2).isUndef())
 247         MIB.addReg(InsReg, RegState::Undef);
 248       else
 249         MIB.addReg(InsReg, RegState::Kill);
 250     } else {
 251       DEBUG(dbgs() << "subreg: eliminated!\n");
 252       MBB->erase(MI);
 253       return true;
 254     }
 255   } else {
 256     // Insert sub-register copy
 257     const TargetRegisterClass *TRC0= TRI->getPhysicalRegisterRegClass(DstSubReg);
 258     const TargetRegisterClass *TRC1= TRI->getPhysicalRegisterRegClass(InsReg);
 259     if (MI->getOperand(2).isUndef())
 260       // If the source register being inserted is undef, then this becomes a
 261       // KILL.
 262       BuildMI(*MBB, MI, MI->getDebugLoc(),
 263               TII->get(TargetOpcode::KILL), DstSubReg);
 264     else {
 265       bool Emitted = TII->copyRegToReg(*MBB, MI, DstSubReg, InsReg, TRC0, TRC1);
 266       (void)Emitted;
 267       assert(Emitted && "Subreg and Dst must be of compatible register class");
 268     }
 269     MachineBasicBlock::iterator CopyMI = MI;
 270     --CopyMI;
 271
 272     // INSERT_SUBREG is a two-address instruction so it implicitly kills SrcReg.
 273     if (!MI->getOperand(1).isUndef())
 274       CopyMI->addOperand(MachineOperand::CreateReg(DstReg, false, true, true));
 275
 276     // Transfer the kill/dead flags, if needed.
 277     if (MI->getOperand(0).isDead()) {
 278       TransferDeadFlag(MI, DstSubReg, TRI);
 279     } else {
 280       // Make sure the full DstReg is live after this replacement.
 281       CopyMI->addOperand(MachineOperand::CreateReg(DstReg, true, true));
 282     }
 283
 284     // Make sure the inserted register gets killed
 285     if (MI->getOperand(2).isKill() && !MI->getOperand(2).isUndef())
 286       TransferKillFlag(MI, InsReg, TRI);
 287   }
 288
 289   DEBUG({
 290       MachineBasicBlock::iterator dMI = MI;
 291       dbgs() << "subreg: " << *(--dMI) << "\n";
 292     });
 293
 294   MBB->erase(MI);
 295   return true;
 296 }
 297
 298 /// runOnMachineFunction - Reduce subregister inserts and extracts to register
 299 /// copies.
 300 ///
 301 bool LowerSubregsInstructionPass::runOnMachineFunction(MachineFunction &MF) {
 302   DEBUG(dbgs() << "Machine Function\n"
 303                << "********** LOWERING SUBREG INSTRS **********\n"
 304                << "********** Function: "
 305                << MF.getFunction()->getName() << '\n');
 306   TRI = MF.getTarget().getRegisterInfo();
 307   TII = MF.getTarget().getInstrInfo();
 308
 309   bool MadeChange = false;
 310
 311   for (MachineFunction::iterator mbbi = MF.begin(), mbbe = MF.end();
 312        mbbi != mbbe; ++mbbi) {
 313     for (MachineBasicBlock::iterator mi = mbbi->begin(), me = mbbi->end();
 314          mi != me;) {
 315       MachineBasicBlock::iterator nmi = llvm::next(mi);
 316       MachineInstr *MI = mi;
 317       if (MI->isExtractSubreg()) {
 318         MadeChange |= LowerExtract(MI);
 319       } else if (MI->isInsertSubreg()) {
 320         MadeChange |= LowerInsert(MI);
 321       } else if (MI->isSubregToReg()) {
 322         MadeChange |= LowerSubregToReg(MI);
 323       }
 324       mi = nmi;
 325     }
 326   }
 327
 328   return MadeChange;
 329 }