lib/Target/Mips/Mips16InstrInfo.cpp

   1 //===-- Mips16InstrInfo.cpp - Mips16 Instruction Information --------------===//
   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 contains the Mips16 implementation of the TargetInstrInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13 #include "Mips16InstrInfo.h"
  14 #include "InstPrinter/MipsInstPrinter.h"
  15 #include "MipsMachineFunction.h"
  16 #include "MipsTargetMachine.h"
  17 #include "llvm/ADT/STLExtras.h"
  18 #include "llvm/ADT/StringRef.h"
  19 #include "llvm/CodeGen/MachineInstrBuilder.h"
  20 #include "llvm/CodeGen/MachineRegisterInfo.h"
  21 #include "llvm/CodeGen/RegisterScavenging.h"
  22 #include "llvm/MC/MCAsmInfo.h"
  23 #include "llvm/Support/CommandLine.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/Support/ErrorHandling.h"
  26 #include "llvm/Support/TargetRegistry.h"
  27 #include <cctype>
  28
  29 using namespace llvm;
  30
  31
  32 Mips16InstrInfo::Mips16InstrInfo(MipsTargetMachine &tm)
  33   : MipsInstrInfo(tm, Mips::Bimm16),
  34     RI(*tm.getSubtargetImpl()) {}
  35
  36 const MipsRegisterInfo &Mips16InstrInfo::getRegisterInfo() const {
  37   return RI;
  38 }
  39
  40 /// isLoadFromStackSlot - If the specified machine instruction is a direct
  41 /// load from a stack slot, return the virtual or physical register number of
  42 /// the destination along with the FrameIndex of the loaded stack slot.  If
  43 /// not, return 0.  This predicate must return 0 if the instruction has
  44 /// any side effects other than loading from the stack slot.
  45 unsigned Mips16InstrInfo::
  46 isLoadFromStackSlot(const MachineInstr *MI, int &FrameIndex) const
  47 {
  48   return 0;
  49 }
  50
  51 /// isStoreToStackSlot - If the specified machine instruction is a direct
  52 /// store to a stack slot, return the virtual or physical register number of
  53 /// the source reg along with the FrameIndex of the loaded stack slot.  If
  54 /// not, return 0.  This predicate must return 0 if the instruction has
  55 /// any side effects other than storing to the stack slot.
  56 unsigned Mips16InstrInfo::
  57 isStoreToStackSlot(const MachineInstr *MI, int &FrameIndex) const
  58 {
  59   return 0;
  60 }
  61
  62 void Mips16InstrInfo::copyPhysReg(MachineBasicBlock &MBB,
  63                                   MachineBasicBlock::iterator I, DebugLoc DL,
  64                                   unsigned DestReg, unsigned SrcReg,
  65                                   bool KillSrc) const {
  66   unsigned Opc = 0;
  67
  68   if (Mips::CPU16RegsRegClass.contains(DestReg) &&
  69       Mips::GPR32RegClass.contains(SrcReg))
  70     Opc = Mips::MoveR3216;
  71   else if (Mips::GPR32RegClass.contains(DestReg) &&
  72            Mips::CPU16RegsRegClass.contains(SrcReg))
  73     Opc = Mips::Move32R16;
  74   else if ((SrcReg == Mips::HI0) &&
  75            (Mips::CPU16RegsRegClass.contains(DestReg)))
  76     Opc = Mips::Mfhi16, SrcReg = 0;
  77
  78   else if ((SrcReg == Mips::LO0) &&
  79            (Mips::CPU16RegsRegClass.contains(DestReg)))
  80     Opc = Mips::Mflo16, SrcReg = 0;
  81
  82
  83   assert(Opc && "Cannot copy registers");
  84
  85   MachineInstrBuilder MIB = BuildMI(MBB, I, DL, get(Opc));
  86
  87   if (DestReg)
  88     MIB.addReg(DestReg, RegState::Define);
  89
  90   if (SrcReg)
  91     MIB.addReg(SrcReg, getKillRegState(KillSrc));
  92 }
  93
  94 void Mips16InstrInfo::
  95 storeRegToStack(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
  96                 unsigned SrcReg, bool isKill, int FI,
  97                 const TargetRegisterClass *RC, const TargetRegisterInfo *TRI,
  98                 int64_t Offset) const {
  99   DebugLoc DL;
 100   if (I != MBB.end()) DL = I->getDebugLoc();
 101   MachineMemOperand *MMO = GetMemOperand(MBB, FI, MachineMemOperand::MOStore);
 102   unsigned Opc = 0;
 103   if (Mips::CPU16RegsRegClass.hasSubClassEq(RC))
 104     Opc = Mips::SwRxSpImmX16;
 105   assert(Opc && "Register class not handled!");
 106   BuildMI(MBB, I, DL, get(Opc)).addReg(SrcReg, getKillRegState(isKill)).
 107       addFrameIndex(FI).addImm(Offset)
 108       .addMemOperand(MMO);
 109 }
 110
 111 void Mips16InstrInfo::
 112 loadRegFromStack(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
 113                  unsigned DestReg, int FI, const TargetRegisterClass *RC,
 114                  const TargetRegisterInfo *TRI, int64_t Offset) const {
 115   DebugLoc DL;
 116   if (I != MBB.end()) DL = I->getDebugLoc();
 117   MachineMemOperand *MMO = GetMemOperand(MBB, FI, MachineMemOperand::MOLoad);
 118   unsigned Opc = 0;
 119
 120   if (Mips::CPU16RegsRegClass.hasSubClassEq(RC))
 121     Opc = Mips::LwRxSpImmX16;
 122   assert(Opc && "Register class not handled!");
 123   BuildMI(MBB, I, DL, get(Opc), DestReg).addFrameIndex(FI).addImm(Offset)
 124     .addMemOperand(MMO);
 125 }
 126
 127 bool Mips16InstrInfo::expandPostRAPseudo(MachineBasicBlock::iterator MI) const {
 128   MachineBasicBlock &MBB = *MI->getParent();
 129   switch(MI->getDesc().getOpcode()) {
 130   default:
 131     return false;
 132   case Mips::RetRA16:
 133     ExpandRetRA16(MBB, MI, Mips::JrcRa16);
 134     break;
 135   }
 136
 137   MBB.erase(MI);
 138   return true;
 139 }
 140
 141 /// GetOppositeBranchOpc - Return the inverse of the specified
 142 /// opcode, e.g. turning BEQ to BNE.
 143 unsigned Mips16InstrInfo::getOppositeBranchOpc(unsigned Opc) const {
 144   switch (Opc) {
 145   default:  llvm_unreachable("Illegal opcode!");
 146   case Mips::BeqzRxImmX16: return Mips::BnezRxImmX16;
 147   case Mips::BnezRxImmX16: return Mips::BeqzRxImmX16;
 148   case Mips::BeqzRxImm16: return Mips::BnezRxImm16;
 149   case Mips::BnezRxImm16: return Mips::BeqzRxImm16;
 150   case Mips::BteqzT8CmpX16: return Mips::BtnezT8CmpX16;
 151   case Mips::BteqzT8SltX16: return Mips::BtnezT8SltX16;
 152   case Mips::BteqzT8SltiX16: return Mips::BtnezT8SltiX16;
 153   case Mips::Btnez16: return Mips::Bteqz16;
 154   case Mips::BtnezX16: return Mips::BteqzX16;
 155   case Mips::BtnezT8CmpiX16: return Mips::BteqzT8CmpiX16;
 156   case Mips::BtnezT8SltuX16: return Mips::BteqzT8SltuX16;
 157   case Mips::BtnezT8SltiuX16: return Mips::BteqzT8SltiuX16;
 158   case Mips::Bteqz16: return Mips::Btnez16;
 159   case Mips::BteqzX16: return Mips::BtnezX16;
 160   case Mips::BteqzT8CmpiX16: return Mips::BtnezT8CmpiX16;
 161   case Mips::BteqzT8SltuX16: return Mips::BtnezT8SltuX16;
 162   case Mips::BteqzT8SltiuX16: return Mips::BtnezT8SltiuX16;
 163   case Mips::BtnezT8CmpX16: return Mips::BteqzT8CmpX16;
 164   case Mips::BtnezT8SltX16: return Mips::BteqzT8SltX16;
 165   case Mips::BtnezT8SltiX16: return Mips::BteqzT8SltiX16;
 166   }
 167   assert(false && "Implement this function.");
 168   return 0;
 169 }
 170
 171 // Adjust SP by FrameSize bytes. Save RA, S0, S1
 172 void Mips16InstrInfo::makeFrame(unsigned SP, int64_t FrameSize,
 173                     MachineBasicBlock &MBB,
 174                     MachineBasicBlock::iterator I) const {
 175   DebugLoc DL = I != MBB.end() ? I->getDebugLoc() : DebugLoc();
 176   if (isUInt<11>(FrameSize))
 177     BuildMI(MBB, I, DL, get(Mips::SaveX16)).addReg(Mips::RA).
 178             addReg(Mips::S0).
 179             addReg(Mips::S1).addReg(Mips::S2).addImm(FrameSize);
 180   else {
 181     int Base = 2040; // should create template function like isUInt that
 182                      // returns largest possible n bit unsigned integer
 183     int64_t Remainder = FrameSize - Base;
 184     BuildMI(MBB, I, DL, get(Mips::SaveX16)).addReg(Mips::RA).
 185             addReg(Mips::S0).
 186             addReg(Mips::S1).addReg(Mips::S2).addImm(Base);
 187     if (isInt<16>(-Remainder))
 188       BuildAddiuSpImm(MBB, I, -Remainder);
 189     else
 190       adjustStackPtrBig(SP, -Remainder, MBB, I, Mips::V0, Mips::V1);
 191   }
 192 }
 193
 194 // Adjust SP by FrameSize bytes. Restore RA, S0, S1
 195 void Mips16InstrInfo::restoreFrame(unsigned SP, int64_t FrameSize,
 196                                    MachineBasicBlock &MBB,
 197                                    MachineBasicBlock::iterator I) const {
 198   DebugLoc DL = I != MBB.end() ? I->getDebugLoc() : DebugLoc();
 199   if (isUInt<11>(FrameSize))
 200     BuildMI(MBB, I, DL, get(Mips::RestoreX16)).
 201             addReg(Mips::RA, RegState::Define).
 202             addReg(Mips::S0, RegState::Define).
 203             addReg(Mips::S1, RegState::Define).
 204             addReg(Mips::S2, RegState::Define).addImm(FrameSize);
 205   else {
 206     int Base = 2040; // should create template function like isUInt that
 207                      // returns largest possible n bit unsigned integer
 208     int64_t Remainder = FrameSize - Base;
 209     if (isInt<16>(Remainder))
 210       BuildAddiuSpImm(MBB, I, Remainder);
 211     else
 212       adjustStackPtrBig(SP, Remainder, MBB, I, Mips::A0, Mips::A1);
 213     BuildMI(MBB, I, DL, get(Mips::RestoreX16)).
 214             addReg(Mips::RA, RegState::Define).
 215             addReg(Mips::S0, RegState::Define).
 216             addReg(Mips::S1, RegState::Define).
 217             addReg(Mips::S2, RegState::Define).addImm(Base);
 218   }
 219 }
 220
 221 // Adjust SP by Amount bytes where bytes can be up to 32bit number.
 222 // This can only be called at times that we know that there is at least one free
 223 // register.
 224 // This is clearly safe at prologue and epilogue.
 225 //
 226 void Mips16InstrInfo::adjustStackPtrBig(unsigned SP, int64_t Amount,
 227                                         MachineBasicBlock &MBB,
 228                                         MachineBasicBlock::iterator I,
 229                                         unsigned Reg1, unsigned Reg2) const {
 230   DebugLoc DL = I != MBB.end() ? I->getDebugLoc() : DebugLoc();
 231 //  MachineRegisterInfo &RegInfo = MBB.getParent()->getRegInfo();
 232 //  unsigned Reg1 = RegInfo.createVirtualRegister(&Mips::CPU16RegsRegClass);
 233 //  unsigned Reg2 = RegInfo.createVirtualRegister(&Mips::CPU16RegsRegClass);
 234   //
 235   // li reg1, constant
 236   // move reg2, sp
 237   // add reg1, reg1, reg2
 238   // move sp, reg1
 239   //
 240   //
 241   MachineInstrBuilder MIB1 = BuildMI(MBB, I, DL, get(Mips::LwConstant32), Reg1);
 242   MIB1.addImm(Amount).addImm(-1);
 243   MachineInstrBuilder MIB2 = BuildMI(MBB, I, DL, get(Mips::MoveR3216), Reg2);
 244   MIB2.addReg(Mips::SP, RegState::Kill);
 245   MachineInstrBuilder MIB3 = BuildMI(MBB, I, DL, get(Mips::AdduRxRyRz16), Reg1);
 246   MIB3.addReg(Reg1);
 247   MIB3.addReg(Reg2, RegState::Kill);
 248   MachineInstrBuilder MIB4 = BuildMI(MBB, I, DL, get(Mips::Move32R16),
 249                                                      Mips::SP);
 250   MIB4.addReg(Reg1, RegState::Kill);
 251 }
 252
 253 void Mips16InstrInfo::adjustStackPtrBigUnrestricted(unsigned SP, int64_t Amount,
 254                     MachineBasicBlock &MBB,
 255                     MachineBasicBlock::iterator I) const {
 256    assert(false && "adjust stack pointer amount exceeded");
 257 }
 258
 259 /// Adjust SP by Amount bytes.
 260 void Mips16InstrInfo::adjustStackPtr(unsigned SP, int64_t Amount,
 261                                      MachineBasicBlock &MBB,
 262                                      MachineBasicBlock::iterator I) const {
 263   if (isInt<16>(Amount))  // need to change to addiu sp, ....and isInt<16>
 264     BuildAddiuSpImm(MBB, I, Amount);
 265   else
 266     adjustStackPtrBigUnrestricted(SP, Amount, MBB, I);
 267 }
 268
 269 /// This function generates the sequence of instructions needed to get the
 270 /// result of adding register REG and immediate IMM.
 271 unsigned
 272 Mips16InstrInfo::loadImmediate(unsigned FrameReg,
 273                                int64_t Imm, MachineBasicBlock &MBB,
 274                                MachineBasicBlock::iterator II, DebugLoc DL,
 275                                unsigned &NewImm) const {
 276   //
 277   // given original instruction is:
 278   // Instr rx, T[offset] where offset is too big.
 279   //
 280   // lo = offset & 0xFFFF
 281   // hi = ((offset >> 16) + (lo >> 15)) & 0xFFFF;
 282   //
 283   // let T = temporary register
 284   // li T, hi
 285   // shl T, 16
 286   // add T, Rx, T
 287   //
 288   RegScavenger rs;
 289   int32_t lo = Imm & 0xFFFF;
 290   NewImm = lo;
 291   int Reg =0;
 292   int SpReg = 0;
 293
 294   rs.enterBasicBlock(&MBB);
 295   rs.forward(II);
 296   //
 297   // We need to know which registers can be used, in the case where there
 298   // are not enough free registers. We exclude all registers that
 299   // are used in the instruction that we are helping.
 300   //  // Consider all allocatable registers in the register class initially
 301   BitVector Candidates =
 302       RI.getAllocatableSet
 303       (*II->getParent()->getParent(), &Mips::CPU16RegsRegClass);
 304   // Exclude all the registers being used by the instruction.
 305   for (unsigned i = 0, e = II->getNumOperands(); i != e; ++i) {
 306     MachineOperand &MO = II->getOperand(i);
 307     if (MO.isReg() && MO.getReg() != 0 && !MO.isDef() &&
 308         !TargetRegisterInfo::isVirtualRegister(MO.getReg()))
 309       Candidates.reset(MO.getReg());
 310   }
 311   //
 312   // If the same register was used and defined in an instruction, then
 313   // it will not be in the list of candidates.
 314   //
 315   // we need to analyze the instruction that we are helping.
 316   // we need to know if it defines register x but register x is not
 317   // present as an operand of the instruction. this tells
 318   // whether the register is live before the instruction. if it's not
 319   // then we don't need to save it in case there are no free registers.
 320   //
 321   int DefReg = 0;
 322   for (unsigned i = 0, e = II->getNumOperands(); i != e; ++i) {
 323     MachineOperand &MO = II->getOperand(i);
 324     if (MO.isReg() && MO.isDef()) {
 325       DefReg = MO.getReg();
 326       break;
 327     }
 328   }
 329   //
 330   BitVector Available = rs.getRegsAvailable(&Mips::CPU16RegsRegClass);
 331
 332   Available &= Candidates;
 333   //
 334   // we use T0 for the first register, if we need to save something away.
 335   // we use T1 for the second register, if we need to save something away.
 336   //
 337   unsigned FirstRegSaved =0, SecondRegSaved=0;
 338   unsigned FirstRegSavedTo = 0, SecondRegSavedTo = 0;
 339
 340
 341   Reg = Available.find_first();
 342
 343   if (Reg == -1) {
 344     Reg = Candidates.find_first();
 345     Candidates.reset(Reg);
 346     if (DefReg != Reg) {
 347       FirstRegSaved = Reg;
 348       FirstRegSavedTo = Mips::T0;
 349       copyPhysReg(MBB, II, DL, FirstRegSavedTo, FirstRegSaved, true);
 350     }
 351   }
 352   else
 353     Available.reset(Reg);
 354   BuildMI(MBB, II, DL, get(Mips::LwConstant32), Reg).addImm(Imm).addImm(-1);
 355   NewImm = 0;
 356   if (FrameReg == Mips::SP) {
 357     SpReg = Available.find_first();
 358     if (SpReg == -1) {
 359       SpReg = Candidates.find_first();
 360       // Candidates.reset(SpReg); // not really needed
 361       if (DefReg!= SpReg) {
 362         SecondRegSaved = SpReg;
 363         SecondRegSavedTo = Mips::T1;
 364       }
 365       if (SecondRegSaved)
 366         copyPhysReg(MBB, II, DL, SecondRegSavedTo, SecondRegSaved, true);
 367     }
 368    else
 369      Available.reset(SpReg);
 370     copyPhysReg(MBB, II, DL, SpReg, Mips::SP, false);
 371     BuildMI(MBB, II, DL, get(Mips::  AdduRxRyRz16), Reg).addReg(SpReg, RegState::Kill)
 372       .addReg(Reg);
 373   }
 374   else
 375     BuildMI(MBB, II, DL, get(Mips::  AdduRxRyRz16), Reg).addReg(FrameReg)
 376       .addReg(Reg, RegState::Kill);
 377   if (FirstRegSaved || SecondRegSaved) {
 378     II = llvm::next(II);
 379     if (FirstRegSaved)
 380       copyPhysReg(MBB, II, DL, FirstRegSaved, FirstRegSavedTo, true);
 381     if (SecondRegSaved)
 382       copyPhysReg(MBB, II, DL, SecondRegSaved, SecondRegSavedTo, true);
 383   }
 384   return Reg;
 385 }
 386
 387 unsigned Mips16InstrInfo::getAnalyzableBrOpc(unsigned Opc) const {
 388   return (Opc == Mips::BeqzRxImmX16   || Opc == Mips::BimmX16  ||
 389           Opc == Mips::Bimm16  ||
 390           Opc == Mips::Bteqz16        || Opc == Mips::Btnez16 ||
 391           Opc == Mips::BeqzRxImm16    || Opc == Mips::BnezRxImm16   ||
 392           Opc == Mips::BnezRxImmX16   || Opc == Mips::BteqzX16 ||
 393           Opc == Mips::BteqzT8CmpX16  || Opc == Mips::BteqzT8CmpiX16 ||
 394           Opc == Mips::BteqzT8SltX16  || Opc == Mips::BteqzT8SltuX16  ||
 395           Opc == Mips::BteqzT8SltiX16 || Opc == Mips::BteqzT8SltiuX16 ||
 396           Opc == Mips::BtnezX16       || Opc == Mips::BtnezT8CmpX16 ||
 397           Opc == Mips::BtnezT8CmpiX16 || Opc == Mips::BtnezT8SltX16 ||
 398           Opc == Mips::BtnezT8SltuX16 || Opc == Mips::BtnezT8SltiX16 ||
 399           Opc == Mips::BtnezT8SltiuX16 ) ? Opc : 0;
 400 }
 401
 402 void Mips16InstrInfo::ExpandRetRA16(MachineBasicBlock &MBB,
 403                                   MachineBasicBlock::iterator I,
 404                                   unsigned Opc) const {
 405   BuildMI(MBB, I, I->getDebugLoc(), get(Opc));
 406 }
 407
 408
 409 const MCInstrDesc &Mips16InstrInfo::AddiuSpImm(int64_t Imm) const {
 410   if (validSpImm8(Imm))
 411     return get(Mips::AddiuSpImm16);
 412   else
 413     return get(Mips::AddiuSpImmX16);
 414 }
 415
 416 void Mips16InstrInfo::BuildAddiuSpImm
 417   (MachineBasicBlock &MBB, MachineBasicBlock::iterator I, int64_t Imm) const {
 418   DebugLoc DL = I != MBB.end() ? I->getDebugLoc() : DebugLoc();
 419   BuildMI(MBB, I, DL, AddiuSpImm(Imm)).addImm(Imm);
 420 }
 421
 422 const MipsInstrInfo *llvm::createMips16InstrInfo(MipsTargetMachine &TM) {
 423   return new Mips16InstrInfo(TM);
 424 }
 425
 426 bool Mips16InstrInfo::validImmediate(unsigned Opcode, unsigned Reg,
 427                                      int64_t Amount) {
 428   switch (Opcode) {
 429   case Mips::LbRxRyOffMemX16:
 430   case Mips::LbuRxRyOffMemX16:
 431   case Mips::LhRxRyOffMemX16:
 432   case Mips::LhuRxRyOffMemX16:
 433   case Mips::SbRxRyOffMemX16:
 434   case Mips::ShRxRyOffMemX16:
 435   case Mips::LwRxRyOffMemX16:
 436   case Mips::SwRxRyOffMemX16:
 437   case Mips::SwRxSpImmX16:
 438   case Mips::LwRxSpImmX16:
 439     return isInt<16>(Amount);
 440   case Mips::AddiuRxRyOffMemX16:
 441     if ((Reg == Mips::PC) || (Reg == Mips::SP))
 442       return isInt<16>(Amount);
 443     return isInt<15>(Amount);
 444   }
 445   llvm_unreachable("unexpected Opcode in validImmediate");
 446 }
 447
 448 /// Measure the specified inline asm to determine an approximation of its
 449 /// length.
 450 /// Comments (which run till the next SeparatorString or newline) do not
 451 /// count as an instruction.
 452 /// Any other non-whitespace text is considered an instruction, with
 453 /// multiple instructions separated by SeparatorString or newlines.
 454 /// Variable-length instructions are not handled here; this function
 455 /// may be overloaded in the target code to do that.
 456 /// We implement the special case of the .space directive taking only an
 457 /// integer argument, which is the size in bytes. This is used for creating
 458 /// inline code spacing for testing purposes using inline assembly.
 459 ///
 460 unsigned Mips16InstrInfo::getInlineAsmLength(const char *Str,
 461                                              const MCAsmInfo &MAI) const {
 462
 463
 464   // Count the number of instructions in the asm.
 465   bool atInsnStart = true;
 466   unsigned Length = 0;
 467   for (; *Str; ++Str) {
 468     if (*Str == '\n' || strncmp(Str, MAI.getSeparatorString(),
 469                                 strlen(MAI.getSeparatorString())) == 0)
 470       atInsnStart = true;
 471     if (atInsnStart && !std::isspace(static_cast<unsigned char>(*Str))) {
 472       if (strncmp(Str, ".space", 6)==0) {
 473         char *EStr; int Sz;
 474         Sz = strtol(Str+6, &EStr, 10);
 475         while (isspace(*EStr)) ++EStr;
 476         if (*EStr=='\0') {
 477           DEBUG(dbgs() << "parsed .space " << Sz << '\n');
 478           return Sz;
 479         }
 480       }
 481       Length += MAI.getMaxInstLength();
 482       atInsnStart = false;
 483     }
 484     if (atInsnStart && strncmp(Str, MAI.getCommentString(),
 485                                strlen(MAI.getCommentString())) == 0)
 486       atInsnStart = false;
 487   }
 488
 489   return Length;
 490 }