lib/Target/XCore/XCoreRegisterInfo.cpp

   1 //===- XCoreRegisterInfo.cpp - XCore Register Information -------*- C++ -*-===//
   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 XCore implementation of the MRegisterInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "XCoreRegisterInfo.h"
  15 #include "XCoreMachineFunctionInfo.h"
  16 #include "XCore.h"
  17 #include "llvm/CodeGen/MachineInstrBuilder.h"
  18 #include "llvm/CodeGen/MachineFunction.h"
  19 #include "llvm/CodeGen/MachineFrameInfo.h"
  20 #include "llvm/CodeGen/MachineLocation.h"
  21 #include "llvm/CodeGen/MachineModuleInfo.h"
  22 #include "llvm/CodeGen/MachineRegisterInfo.h"
  23 #include "llvm/CodeGen/RegisterScavenging.h"
  24 #include "llvm/Target/TargetFrameInfo.h"
  25 #include "llvm/Target/TargetMachine.h"
  26 #include "llvm/Target/TargetOptions.h"
  27 #include "llvm/Target/TargetInstrInfo.h"
  28 #include "llvm/Type.h"
  29 #include "llvm/Function.h"
  30 #include "llvm/ADT/BitVector.h"
  31 #include "llvm/ADT/STLExtras.h"
  32 #include "llvm/Support/Debug.h"
  33 #include "llvm/Support/ErrorHandling.h"
  34 #include "llvm/Support/raw_ostream.h"
  35
  36 using namespace llvm;
  37
  38 XCoreRegisterInfo::XCoreRegisterInfo(const TargetInstrInfo &tii)
  39   : XCoreGenRegisterInfo(XCore::ADJCALLSTACKDOWN, XCore::ADJCALLSTACKUP),
  40     TII(tii) {
  41 }
  42
  43 // helper functions
  44 static inline bool isImmUs(unsigned val) {
  45   return val <= 11;
  46 }
  47
  48 static inline bool isImmU6(unsigned val) {
  49   return val < (1 << 6);
  50 }
  51
  52 static inline bool isImmU16(unsigned val) {
  53   return val < (1 << 16);
  54 }
  55
  56 static const unsigned XCore_ArgRegs[] = {
  57   XCore::R0, XCore::R1, XCore::R2, XCore::R3
  58 };
  59
  60 const unsigned * XCoreRegisterInfo::getArgRegs(const MachineFunction *MF)
  61 {
  62   return XCore_ArgRegs;
  63 }
  64
  65 unsigned XCoreRegisterInfo::getNumArgRegs(const MachineFunction *MF)
  66 {
  67   return array_lengthof(XCore_ArgRegs);
  68 }
  69
  70 bool XCoreRegisterInfo::needsFrameMoves(const MachineFunction &MF) {
  71   return MF.getMMI().hasDebugInfo() || !MF.getFunction()->doesNotThrow() ||
  72           UnwindTablesMandatory;
  73 }
  74
  75 const unsigned* XCoreRegisterInfo::getCalleeSavedRegs(const MachineFunction *MF)
  76                                                                          const {
  77   static const unsigned CalleeSavedRegs[] = {
  78     XCore::R4, XCore::R5, XCore::R6, XCore::R7,
  79     XCore::R8, XCore::R9, XCore::R10, XCore::LR,
  80     0
  81   };
  82   return CalleeSavedRegs;
  83 }
  84
  85 BitVector XCoreRegisterInfo::getReservedRegs(const MachineFunction &MF) const {
  86   BitVector Reserved(getNumRegs());
  87   const TargetFrameInfo *TFI = MF.getTarget().getFrameInfo();
  88
  89   Reserved.set(XCore::CP);
  90   Reserved.set(XCore::DP);
  91   Reserved.set(XCore::SP);
  92   Reserved.set(XCore::LR);
  93   if (TFI->hasFP(MF)) {
  94     Reserved.set(XCore::R10);
  95   }
  96   return Reserved;
  97 }
  98
  99 bool
 100 XCoreRegisterInfo::requiresRegisterScavenging(const MachineFunction &MF) const {
 101   const TargetFrameInfo *TFI = MF.getTarget().getFrameInfo();
 102
 103   // TODO can we estimate stack size?
 104   return TFI->hasFP(MF);
 105 }
 106
 107 // This function eliminates ADJCALLSTACKDOWN,
 108 // ADJCALLSTACKUP pseudo instructions
 109 void XCoreRegisterInfo::
 110 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
 111                               MachineBasicBlock::iterator I) const {
 112   const TargetFrameInfo *TFI = MF.getTarget().getFrameInfo();
 113
 114   if (!TFI->hasReservedCallFrame(MF)) {
 115     // Turn the adjcallstackdown instruction into 'extsp <amt>' and the
 116     // adjcallstackup instruction into 'ldaw sp, sp[<amt>]'
 117     MachineInstr *Old = I;
 118     uint64_t Amount = Old->getOperand(0).getImm();
 119     if (Amount != 0) {
 120       // We need to keep the stack aligned properly.  To do this, we round the
 121       // amount of space needed for the outgoing arguments up to the next
 122       // alignment boundary.
 123       unsigned Align = MF.getTarget().getFrameInfo()->getStackAlignment();
 124       Amount = (Amount+Align-1)/Align*Align;
 125
 126       assert(Amount%4 == 0);
 127       Amount /= 4;
 128
 129       bool isU6 = isImmU6(Amount);
 130
 131       if (!isU6 && !isImmU16(Amount)) {
 132         // FIX could emit multiple instructions in this case.
 133 #ifndef NDEBUG
 134         errs() << "eliminateCallFramePseudoInstr size too big: "
 135                << Amount << "\n";
 136 #endif
 137         llvm_unreachable(0);
 138       }
 139
 140       MachineInstr *New;
 141       if (Old->getOpcode() == XCore::ADJCALLSTACKDOWN) {
 142         int Opcode = isU6 ? XCore::EXTSP_u6 : XCore::EXTSP_lu6;
 143         New=BuildMI(MF, Old->getDebugLoc(), TII.get(Opcode))
 144           .addImm(Amount);
 145       } else {
 146         assert(Old->getOpcode() == XCore::ADJCALLSTACKUP);
 147         int Opcode = isU6 ? XCore::LDAWSP_ru6_RRegs : XCore::LDAWSP_lru6_RRegs;
 148         New=BuildMI(MF, Old->getDebugLoc(), TII.get(Opcode), XCore::SP)
 149           .addImm(Amount);
 150       }
 151
 152       // Replace the pseudo instruction with a new instruction...
 153       MBB.insert(I, New);
 154     }
 155   }
 156
 157   MBB.erase(I);
 158 }
 159
 160 void
 161 XCoreRegisterInfo::eliminateFrameIndex(MachineBasicBlock::iterator II,
 162                                        int SPAdj, RegScavenger *RS) const {
 163   assert(SPAdj == 0 && "Unexpected");
 164   MachineInstr &MI = *II;
 165   DebugLoc dl = MI.getDebugLoc();
 166   unsigned i = 0;
 167
 168   while (!MI.getOperand(i).isFI()) {
 169     ++i;
 170     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
 171   }
 172
 173   MachineOperand &FrameOp = MI.getOperand(i);
 174   int FrameIndex = FrameOp.getIndex();
 175
 176   MachineFunction &MF = *MI.getParent()->getParent();
 177   const TargetFrameInfo *TFI = MF.getTarget().getFrameInfo();
 178   int Offset = MF.getFrameInfo()->getObjectOffset(FrameIndex);
 179   int StackSize = MF.getFrameInfo()->getStackSize();
 180
 181   #ifndef NDEBUG
 182   DEBUG(errs() << "\nFunction         : "
 183         << MF.getFunction()->getName() << "\n");
 184   DEBUG(errs() << "<--------->\n");
 185   DEBUG(MI.print(errs()));
 186   DEBUG(errs() << "FrameIndex         : " << FrameIndex << "\n");
 187   DEBUG(errs() << "FrameOffset        : " << Offset << "\n");
 188   DEBUG(errs() << "StackSize          : " << StackSize << "\n");
 189   #endif
 190
 191   Offset += StackSize;
 192
 193   // fold constant into offset.
 194   Offset += MI.getOperand(i + 1).getImm();
 195   MI.getOperand(i + 1).ChangeToImmediate(0);
 196
 197   assert(Offset%4 == 0 && "Misaligned stack offset");
 198
 199   DEBUG(errs() << "Offset             : " << Offset << "\n" << "<--------->\n");
 200
 201   Offset/=4;
 202
 203   bool FP = TFI->hasFP(MF);
 204
 205   unsigned Reg = MI.getOperand(0).getReg();
 206   bool isKill = MI.getOpcode() == XCore::STWFI && MI.getOperand(0).isKill();
 207
 208   assert(XCore::GRRegsRegisterClass->contains(Reg) &&
 209          "Unexpected register operand");
 210
 211   MachineBasicBlock &MBB = *MI.getParent();
 212
 213   if (FP) {
 214     bool isUs = isImmUs(Offset);
 215     unsigned FramePtr = XCore::R10;
 216
 217     if (!isUs) {
 218       if (!RS)
 219         report_fatal_error("eliminateFrameIndex Frame size too big: " +
 220                            Twine(Offset));
 221       unsigned ScratchReg = RS->scavengeRegister(XCore::GRRegsRegisterClass, II,
 222                                                  SPAdj);
 223       loadConstant(MBB, II, ScratchReg, Offset, dl);
 224       switch (MI.getOpcode()) {
 225       case XCore::LDWFI:
 226         BuildMI(MBB, II, dl, TII.get(XCore::LDW_3r), Reg)
 227               .addReg(FramePtr)
 228               .addReg(ScratchReg, RegState::Kill);
 229         break;
 230       case XCore::STWFI:
 231         BuildMI(MBB, II, dl, TII.get(XCore::STW_3r))
 232               .addReg(Reg, getKillRegState(isKill))
 233               .addReg(FramePtr)
 234               .addReg(ScratchReg, RegState::Kill);
 235         break;
 236       case XCore::LDAWFI:
 237         BuildMI(MBB, II, dl, TII.get(XCore::LDAWF_l3r), Reg)
 238               .addReg(FramePtr)
 239               .addReg(ScratchReg, RegState::Kill);
 240         break;
 241       default:
 242         llvm_unreachable("Unexpected Opcode");
 243       }
 244     } else {
 245       switch (MI.getOpcode()) {
 246       case XCore::LDWFI:
 247         BuildMI(MBB, II, dl, TII.get(XCore::LDW_2rus), Reg)
 248               .addReg(FramePtr)
 249               .addImm(Offset);
 250         break;
 251       case XCore::STWFI:
 252         BuildMI(MBB, II, dl, TII.get(XCore::STW_2rus))
 253               .addReg(Reg, getKillRegState(isKill))
 254               .addReg(FramePtr)
 255               .addImm(Offset);
 256         break;
 257       case XCore::LDAWFI:
 258         BuildMI(MBB, II, dl, TII.get(XCore::LDAWF_l2rus), Reg)
 259               .addReg(FramePtr)
 260               .addImm(Offset);
 261         break;
 262       default:
 263         llvm_unreachable("Unexpected Opcode");
 264       }
 265     }
 266   } else {
 267     bool isU6 = isImmU6(Offset);
 268     if (!isU6 && !isImmU16(Offset))
 269       report_fatal_error("eliminateFrameIndex Frame size too big: " +
 270                          Twine(Offset));
 271
 272     switch (MI.getOpcode()) {
 273     int NewOpcode;
 274     case XCore::LDWFI:
 275       NewOpcode = (isU6) ? XCore::LDWSP_ru6 : XCore::LDWSP_lru6;
 276       BuildMI(MBB, II, dl, TII.get(NewOpcode), Reg)
 277             .addImm(Offset);
 278       break;
 279     case XCore::STWFI:
 280       NewOpcode = (isU6) ? XCore::STWSP_ru6 : XCore::STWSP_lru6;
 281       BuildMI(MBB, II, dl, TII.get(NewOpcode))
 282             .addReg(Reg, getKillRegState(isKill))
 283             .addImm(Offset);
 284       break;
 285     case XCore::LDAWFI:
 286       NewOpcode = (isU6) ? XCore::LDAWSP_ru6 : XCore::LDAWSP_lru6;
 287       BuildMI(MBB, II, dl, TII.get(NewOpcode), Reg)
 288             .addImm(Offset);
 289       break;
 290     default:
 291       llvm_unreachable("Unexpected Opcode");
 292     }
 293   }
 294   // Erase old instruction.
 295   MBB.erase(II);
 296 }
 297
 298 void
 299 XCoreRegisterInfo::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
 300                                                       RegScavenger *RS) const {
 301   MachineFrameInfo *MFI = MF.getFrameInfo();
 302   const TargetFrameInfo *TFI = MF.getTarget().getFrameInfo();
 303   bool LRUsed = MF.getRegInfo().isPhysRegUsed(XCore::LR);
 304   const TargetRegisterClass *RC = XCore::GRRegsRegisterClass;
 305   XCoreFunctionInfo *XFI = MF.getInfo<XCoreFunctionInfo>();
 306   if (LRUsed) {
 307     MF.getRegInfo().setPhysRegUnused(XCore::LR);
 308
 309     bool isVarArg = MF.getFunction()->isVarArg();
 310     int FrameIdx;
 311     if (! isVarArg) {
 312       // A fixed offset of 0 allows us to save / restore LR using entsp / retsp.
 313       FrameIdx = MFI->CreateFixedObject(RC->getSize(), 0, true);
 314     } else {
 315       FrameIdx = MFI->CreateStackObject(RC->getSize(), RC->getAlignment(),
 316                                         false);
 317     }
 318     XFI->setUsesLR(FrameIdx);
 319     XFI->setLRSpillSlot(FrameIdx);
 320   }
 321   if (requiresRegisterScavenging(MF)) {
 322     // Reserve a slot close to SP or frame pointer.
 323     RS->setScavengingFrameIndex(MFI->CreateStackObject(RC->getSize(),
 324                                                        RC->getAlignment(),
 325                                                        false));
 326   }
 327   if (TFI->hasFP(MF)) {
 328     // A callee save register is used to hold the FP.
 329     // This needs saving / restoring in the epilogue / prologue.
 330     XFI->setFPSpillSlot(MFI->CreateStackObject(RC->getSize(),
 331                                                RC->getAlignment(),
 332                                                false));
 333   }
 334 }
 335
 336 void XCoreRegisterInfo::
 337 processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
 338
 339 }
 340
 341 void XCoreRegisterInfo::
 342 loadConstant(MachineBasicBlock &MBB, MachineBasicBlock::iterator I,
 343             unsigned DstReg, int64_t Value, DebugLoc dl) const {
 344   // TODO use mkmsk if possible.
 345   if (!isImmU16(Value)) {
 346     // TODO use constant pool.
 347     report_fatal_error("loadConstant value too big " + Twine(Value));
 348   }
 349   int Opcode = isImmU6(Value) ? XCore::LDC_ru6 : XCore::LDC_lru6;
 350   BuildMI(MBB, I, dl, TII.get(Opcode), DstReg).addImm(Value);
 351 }
 352
 353 int XCoreRegisterInfo::getDwarfRegNum(unsigned RegNum, bool isEH) const {
 354   return XCoreGenRegisterInfo::getDwarfRegNumFull(RegNum, 0);
 355 }
 356
 357 unsigned XCoreRegisterInfo::getFrameRegister(const MachineFunction &MF) const {
 358   const TargetFrameInfo *TFI = MF.getTarget().getFrameInfo();
 359
 360   return TFI->hasFP(MF) ? XCore::R10 : XCore::SP;
 361 }
 362
 363 unsigned XCoreRegisterInfo::getRARegister() const {
 364   return XCore::LR;
 365 }
 366
 367 #include "XCoreGenRegisterInfo.inc"
 368