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
  54   char LowerSubregsInstructionPass::ID = 0;
  55 }
  56
  57 FunctionPass *llvm::createLowerSubregsPass() {
  58   return new LowerSubregsInstructionPass();
  59 }
  60
  61 bool LowerSubregsInstructionPass::LowerExtract(MachineInstr *MI) {
  62    MachineBasicBlock *MBB = MI->getParent();
  63    MachineFunction &MF = *MBB->getParent();
  64    const TargetRegisterInfo &TRI = *MF.getTarget().getRegisterInfo();
  65    const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
  66
  67    assert(MI->getOperand(0).isReg() && MI->getOperand(0).isDef() &&
  68           MI->getOperand(1).isReg() && MI->getOperand(1).isUse() &&
  69           MI->getOperand(2).isImm() && "Malformed extract_subreg");
  70
  71    unsigned DstReg   = MI->getOperand(0).getReg();
  72    unsigned SuperReg = MI->getOperand(1).getReg();
  73    unsigned SubIdx   = MI->getOperand(2).getImm();
  74    unsigned SrcReg   = TRI.getSubReg(SuperReg, SubIdx);
  75
  76    assert(TargetRegisterInfo::isPhysicalRegister(SuperReg) &&
  77           "Extract supperg source must be a physical register");
  78    assert(TargetRegisterInfo::isPhysicalRegister(DstReg) &&
  79           "Insert destination must be in a physical register");
  80
  81    DOUT << "subreg: CONVERTING: " << *MI;
  82
  83    if (SrcReg != DstReg) {
  84      const TargetRegisterClass *TRC = TRI.getPhysicalRegisterRegClass(DstReg);
  85      assert(TRC == TRI.getPhysicalRegisterRegClass(SrcReg) &&
  86              "Extract subreg and Dst must be of same register class");
  87      TII.copyRegToReg(*MBB, MI, DstReg, SrcReg, TRC, TRC);
  88
  89 #ifndef NDEBUG
  90      MachineBasicBlock::iterator dMI = MI;
  91      DOUT << "subreg: " << *(--dMI);
  92 #endif
  93    }
  94
  95    DOUT << "\n";
  96    MBB->erase(MI);
  97    return true;
  98 }
  99
 100 bool LowerSubregsInstructionPass::LowerSubregToReg(MachineInstr *MI) {
 101   MachineBasicBlock *MBB = MI->getParent();
 102   MachineFunction &MF = *MBB->getParent();
 103   const TargetRegisterInfo &TRI = *MF.getTarget().getRegisterInfo();
 104   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 105   assert((MI->getOperand(0).isReg() && MI->getOperand(0).isDef()) &&
 106          MI->getOperand(1).isImm() &&
 107          (MI->getOperand(2).isReg() && MI->getOperand(2).isUse()) &&
 108           MI->getOperand(3).isImm() && "Invalid subreg_to_reg");
 109
 110   unsigned DstReg  = MI->getOperand(0).getReg();
 111   unsigned InsReg  = MI->getOperand(2).getReg();
 112   unsigned SubIdx  = MI->getOperand(3).getImm();
 113
 114   assert(SubIdx != 0 && "Invalid index for insert_subreg");
 115   unsigned DstSubReg = TRI.getSubReg(DstReg, SubIdx);
 116
 117   assert(TargetRegisterInfo::isPhysicalRegister(DstReg) &&
 118          "Insert destination must be in a physical register");
 119   assert(TargetRegisterInfo::isPhysicalRegister(InsReg) &&
 120          "Inserted value must be in a physical register");
 121
 122   DOUT << "subreg: CONVERTING: " << *MI;
 123
 124   if (DstSubReg == InsReg) {
 125     // No need to insert an identify copy instruction.
 126     DOUT << "subreg: eliminated!";
 127   } else {
 128     // Insert sub-register copy
 129     const TargetRegisterClass *TRC0= TRI.getPhysicalRegisterRegClass(DstSubReg);
 130     const TargetRegisterClass *TRC1= TRI.getPhysicalRegisterRegClass(InsReg);
 131     TII.copyRegToReg(*MBB, MI, DstSubReg, InsReg, TRC0, TRC1);
 132
 133 #ifndef NDEBUG
 134     MachineBasicBlock::iterator dMI = MI;
 135     DOUT << "subreg: " << *(--dMI);
 136 #endif
 137   }
 138
 139   DOUT << "\n";
 140   MBB->erase(MI);
 141   return true;
 142 }
 143
 144 bool LowerSubregsInstructionPass::LowerInsert(MachineInstr *MI) {
 145   MachineBasicBlock *MBB = MI->getParent();
 146   MachineFunction &MF = *MBB->getParent();
 147   const TargetRegisterInfo &TRI = *MF.getTarget().getRegisterInfo();
 148   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 149   assert((MI->getOperand(0).isReg() && MI->getOperand(0).isDef()) &&
 150          (MI->getOperand(1).isReg() && MI->getOperand(1).isUse()) &&
 151          (MI->getOperand(2).isReg() && MI->getOperand(2).isUse()) &&
 152           MI->getOperand(3).isImm() && "Invalid insert_subreg");
 153
 154   unsigned DstReg = MI->getOperand(0).getReg();
 155 #ifndef NDEBUG
 156   unsigned SrcReg = MI->getOperand(1).getReg();
 157 #endif
 158   unsigned InsReg = MI->getOperand(2).getReg();
 159   unsigned SubIdx = MI->getOperand(3).getImm();
 160
 161   assert(DstReg == SrcReg && "insert_subreg not a two-address instruction?");
 162   assert(SubIdx != 0 && "Invalid index for insert_subreg");
 163   unsigned DstSubReg = TRI.getSubReg(DstReg, SubIdx);
 164
 165   assert(TargetRegisterInfo::isPhysicalRegister(SrcReg) &&
 166          "Insert superreg source must be in a physical register");
 167   assert(TargetRegisterInfo::isPhysicalRegister(InsReg) &&
 168          "Inserted value must be in a physical register");
 169
 170   DOUT << "subreg: CONVERTING: " << *MI;
 171
 172   if (DstSubReg == InsReg) {
 173     // No need to insert an identify copy instruction.
 174     DOUT << "subreg: eliminated!";
 175   } else {
 176     // Insert sub-register copy
 177     const TargetRegisterClass *TRC0= TRI.getPhysicalRegisterRegClass(DstSubReg);
 178     const TargetRegisterClass *TRC1= TRI.getPhysicalRegisterRegClass(InsReg);
 179     TII.copyRegToReg(*MBB, MI, DstSubReg, InsReg, TRC0, TRC1);
 180 #ifndef NDEBUG
 181     MachineBasicBlock::iterator dMI = MI;
 182     DOUT << "subreg: " << *(--dMI);
 183 #endif
 184   }
 185
 186   DOUT << "\n";
 187   MBB->erase(MI);
 188   return true;
 189 }
 190
 191 /// runOnMachineFunction - Reduce subregister inserts and extracts to register
 192 /// copies.
 193 ///
 194 bool LowerSubregsInstructionPass::runOnMachineFunction(MachineFunction &MF) {
 195   DOUT << "Machine Function\n";
 196
 197   bool MadeChange = false;
 198
 199   DOUT << "********** LOWERING SUBREG INSTRS **********\n";
 200   DOUT << "********** Function: " << MF.getFunction()->getName() << '\n';
 201
 202   for (MachineFunction::iterator mbbi = MF.begin(), mbbe = MF.end();
 203        mbbi != mbbe; ++mbbi) {
 204     for (MachineBasicBlock::iterator mi = mbbi->begin(), me = mbbi->end();
 205          mi != me;) {
 206       MachineInstr *MI = mi++;
 207
 208       if (MI->getOpcode() == TargetInstrInfo::EXTRACT_SUBREG) {
 209         MadeChange |= LowerExtract(MI);
 210       } else if (MI->getOpcode() == TargetInstrInfo::INSERT_SUBREG) {
 211         MadeChange |= LowerInsert(MI);
 212       } else if (MI->getOpcode() == TargetInstrInfo::SUBREG_TO_REG) {
 213         MadeChange |= LowerSubregToReg(MI);
 214       }
 215     }
 216   }
 217
 218   return MadeChange;
 219 }