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/MachineRegisterInfo.h"
  23 #include "llvm/Target/TargetRegisterInfo.h"
  24 #include "llvm/Target/TargetInstrInfo.h"
  25 #include "llvm/Target/TargetMachine.h"
  26 #include "llvm/Support/Debug.h"
  27 #include "llvm/Support/Compiler.h"
  28 using namespace llvm;
  29
  30 namespace {
  31   struct VISIBILITY_HIDDEN LowerSubregsInstructionPass
  32    : public MachineFunctionPass {
  33     static char ID; // Pass identification, replacement for typeid
  34     LowerSubregsInstructionPass() : MachineFunctionPass(&ID) {}
  35
  36     const char *getPassName() const {
  37       return "Subregister lowering instruction pass";
  38     }
  39
  40     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  41       AU.addPreservedID(MachineLoopInfoID);
  42       AU.addPreservedID(MachineDominatorsID);
  43       MachineFunctionPass::getAnalysisUsage(AU);
  44     }
  45
  46     /// runOnMachineFunction - pass entry point
  47     bool runOnMachineFunction(MachineFunction&);
  48
  49     bool LowerExtract(MachineInstr *MI);
  50     bool LowerInsert(MachineInstr *MI);
  51     bool LowerSubregToReg(MachineInstr *MI);
  52
  53     void TransferDeadFlag(MachineInstr *MI, unsigned DstReg,
  54                           const TargetRegisterInfo &TRI);
  55     void TransferKillFlag(MachineInstr *MI, unsigned SrcReg,
  56                           const TargetRegisterInfo &TRI);
  57   };
  58
  59   char LowerSubregsInstructionPass::ID = 0;
  60 }
  61
  62 FunctionPass *llvm::createLowerSubregsPass() {
  63   return new LowerSubregsInstructionPass();
  64 }
  65
  66 /// TransferDeadFlag - MI is a pseudo-instruction with DstReg dead,
  67 /// and the lowered replacement instructions immediately precede it.
  68 /// Mark the replacement instructions with the dead flag.
  69 void
  70 LowerSubregsInstructionPass::TransferDeadFlag(MachineInstr *MI,
  71                                               unsigned DstReg,
  72                                               const TargetRegisterInfo &TRI) {
  73   for (MachineBasicBlock::iterator MII =
  74         prior(MachineBasicBlock::iterator(MI)); ; --MII) {
  75     if (MII->addRegisterDead(DstReg, &TRI))
  76       break;
  77     assert(MII != MI->getParent()->begin() &&
  78            "copyRegToReg output doesn't reference destination register!");
  79   }
  80 }
  81
  82 /// TransferKillFlag - MI is a pseudo-instruction with SrcReg killed,
  83 /// and the lowered replacement instructions immediately precede it.
  84 /// Mark the replacement instructions with the kill flag.
  85 void
  86 LowerSubregsInstructionPass::TransferKillFlag(MachineInstr *MI,
  87                                               unsigned SrcReg,
  88                                               const TargetRegisterInfo &TRI) {
  89   for (MachineBasicBlock::iterator MII =
  90         prior(MachineBasicBlock::iterator(MI)); ; --MII) {
  91     if (MII->addRegisterKilled(SrcReg, &TRI))
  92       break;
  93     assert(MII != MI->getParent()->begin() &&
  94            "copyRegToReg output doesn't reference source register!");
  95   }
  96 }
  97
  98 bool LowerSubregsInstructionPass::LowerExtract(MachineInstr *MI) {
  99   MachineBasicBlock *MBB = MI->getParent();
 100   MachineFunction &MF = *MBB->getParent();
 101   const TargetRegisterInfo &TRI = *MF.getTarget().getRegisterInfo();
 102   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 103
 104   assert(MI->getOperand(0).isReg() && MI->getOperand(0).isDef() &&
 105          MI->getOperand(1).isReg() && MI->getOperand(1).isUse() &&
 106          MI->getOperand(2).isImm() && "Malformed extract_subreg");
 107
 108   unsigned DstReg   = MI->getOperand(0).getReg();
 109   unsigned SuperReg = MI->getOperand(1).getReg();
 110   unsigned SubIdx   = MI->getOperand(2).getImm();
 111   unsigned SrcReg   = TRI.getSubReg(SuperReg, SubIdx);
 112
 113   assert(TargetRegisterInfo::isPhysicalRegister(SuperReg) &&
 114          "Extract supperg source must be a physical register");
 115   assert(TargetRegisterInfo::isPhysicalRegister(DstReg) &&
 116          "Extract destination must be in a physical register");
 117
 118   DOUT << "subreg: CONVERTING: " << *MI;
 119
 120   if (SrcReg == DstReg) {
 121     // No need to insert an identify copy instruction.
 122     DOUT << "subreg: eliminated!";
 123     // Find the kill of the destination register's live range, and insert
 124     // a kill of the source register at that point.
 125     if (MI->getOperand(1).isKill() && !MI->getOperand(0).isDead())
 126       for (MachineBasicBlock::iterator MII =
 127              next(MachineBasicBlock::iterator(MI));
 128            MII != MBB->end(); ++MII)
 129         if (MII->killsRegister(DstReg, &TRI)) {
 130           MII->addRegisterKilled(SuperReg, &TRI, /*AddIfNotFound=*/true);
 131           break;
 132         }
 133   } else {
 134     // Insert copy
 135     const TargetRegisterClass *TRCS = TRI.getPhysicalRegisterRegClass(DstReg);
 136     const TargetRegisterClass *TRCD = TRI.getPhysicalRegisterRegClass(SrcReg);
 137     bool Emitted = TII.copyRegToReg(*MBB, MI, DstReg, SrcReg, TRCD, TRCS);
 138     (void)Emitted;
 139     assert(Emitted && "Subreg and Dst must be of compatible register class");
 140     // Transfer the kill/dead flags, if needed.
 141     if (MI->getOperand(0).isDead())
 142       TransferDeadFlag(MI, DstReg, TRI);
 143     if (MI->getOperand(1).isKill())
 144       TransferKillFlag(MI, SrcReg, TRI);
 145
 146 #ifndef NDEBUG
 147     MachineBasicBlock::iterator dMI = MI;
 148     DOUT << "subreg: " << *(--dMI);
 149 #endif
 150   }
 151
 152   DOUT << "\n";
 153   MBB->erase(MI);
 154   return true;
 155 }
 156
 157 bool LowerSubregsInstructionPass::LowerSubregToReg(MachineInstr *MI) {
 158   MachineBasicBlock *MBB = MI->getParent();
 159   MachineFunction &MF = *MBB->getParent();
 160   const TargetRegisterInfo &TRI = *MF.getTarget().getRegisterInfo();
 161   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 162   assert((MI->getOperand(0).isReg() && MI->getOperand(0).isDef()) &&
 163          MI->getOperand(1).isImm() &&
 164          (MI->getOperand(2).isReg() && MI->getOperand(2).isUse()) &&
 165           MI->getOperand(3).isImm() && "Invalid subreg_to_reg");
 166
 167   unsigned DstReg  = MI->getOperand(0).getReg();
 168   unsigned InsReg  = MI->getOperand(2).getReg();
 169   unsigned InsSIdx = MI->getOperand(2).getSubReg();
 170   unsigned SubIdx  = MI->getOperand(3).getImm();
 171
 172   assert(SubIdx != 0 && "Invalid index for insert_subreg");
 173   unsigned DstSubReg = TRI.getSubReg(DstReg, SubIdx);
 174
 175   assert(TargetRegisterInfo::isPhysicalRegister(DstReg) &&
 176          "Insert destination must be in a physical register");
 177   assert(TargetRegisterInfo::isPhysicalRegister(InsReg) &&
 178          "Inserted value must be in a physical register");
 179
 180   DOUT << "subreg: CONVERTING: " << *MI;
 181
 182   if (DstSubReg == InsReg && InsSIdx == 0) {
 183     // No need to insert an identify copy instruction.
 184     // Watch out for case like this:
 185     // %RAX<def> = ...
 186     // %RAX<def> = SUBREG_TO_REG 0, %EAX:3<kill>, 3
 187     // The first def is defining RAX, not EAX so the top bits were not
 188     // zero extended.
 189     DOUT << "subreg: eliminated!";
 190   } else {
 191     // Insert sub-register copy
 192     const TargetRegisterClass *TRC0= TRI.getPhysicalRegisterRegClass(DstSubReg);
 193     const TargetRegisterClass *TRC1= TRI.getPhysicalRegisterRegClass(InsReg);
 194     TII.copyRegToReg(*MBB, MI, DstSubReg, InsReg, TRC0, TRC1);
 195     // Transfer the kill/dead flags, if needed.
 196     if (MI->getOperand(0).isDead())
 197       TransferDeadFlag(MI, DstSubReg, TRI);
 198     if (MI->getOperand(2).isKill())
 199       TransferKillFlag(MI, InsReg, TRI);
 200
 201 #ifndef NDEBUG
 202     MachineBasicBlock::iterator dMI = MI;
 203     DOUT << "subreg: " << *(--dMI);
 204 #endif
 205   }
 206
 207   DOUT << "\n";
 208   MBB->erase(MI);
 209   return true;
 210 }
 211
 212 bool LowerSubregsInstructionPass::LowerInsert(MachineInstr *MI) {
 213   MachineBasicBlock *MBB = MI->getParent();
 214   MachineFunction &MF = *MBB->getParent();
 215   const TargetRegisterInfo &TRI = *MF.getTarget().getRegisterInfo();
 216   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 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
 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   DOUT << "subreg: CONVERTING: " << *MI;
 239
 240   if (DstSubReg == InsReg) {
 241     // No need to insert an identify copy instruction.
 242     DOUT << "subreg: eliminated!";
 243   } else {
 244     // Insert sub-register copy
 245     const TargetRegisterClass *TRC0= TRI.getPhysicalRegisterRegClass(DstSubReg);
 246     const TargetRegisterClass *TRC1= TRI.getPhysicalRegisterRegClass(InsReg);
 247     TII.copyRegToReg(*MBB, MI, DstSubReg, InsReg, TRC0, TRC1);
 248     // Transfer the kill/dead flags, if needed.
 249     if (MI->getOperand(0).isDead())
 250       TransferDeadFlag(MI, DstSubReg, TRI);
 251     if (MI->getOperand(1).isKill())
 252       TransferKillFlag(MI, InsReg, TRI);
 253
 254 #ifndef NDEBUG
 255     MachineBasicBlock::iterator dMI = MI;
 256     DOUT << "subreg: " << *(--dMI);
 257 #endif
 258   }
 259
 260   DOUT << "\n";
 261   MBB->erase(MI);
 262   return true;
 263 }
 264
 265 /// runOnMachineFunction - Reduce subregister inserts and extracts to register
 266 /// copies.
 267 ///
 268 bool LowerSubregsInstructionPass::runOnMachineFunction(MachineFunction &MF) {
 269   DOUT << "Machine Function\n";
 270
 271   bool MadeChange = false;
 272
 273   DOUT << "********** LOWERING SUBREG INSTRS **********\n";
 274   DOUT << "********** Function: " << MF.getFunction()->getName() << '\n';
 275
 276   for (MachineFunction::iterator mbbi = MF.begin(), mbbe = MF.end();
 277        mbbi != mbbe; ++mbbi) {
 278     for (MachineBasicBlock::iterator mi = mbbi->begin(), me = mbbi->end();
 279          mi != me;) {
 280       MachineInstr *MI = mi++;
 281
 282       if (MI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG) {
 283         MadeChange |= LowerExtract(MI);
 284       } else if (MI->getOpcode() == TargetInstrInfo::INSERT_SUBREG) {
 285         MadeChange |= LowerInsert(MI);
 286       } else if (MI->getOpcode() == TargetInstrInfo::SUBREG_TO_REG) {
 287         MadeChange |= LowerSubregToReg(MI);
 288       }
 289     }
 290   }
 291
 292   return MadeChange;
 293 }