lib/Target/Mips/MipsRegisterInfo.cpp

   1 //===- MipsRegisterInfo.cpp - MIPS 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 MIPS implementation of the TargetRegisterInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "mips-reg-info"
  15
  16 #include "Mips.h"
  17 #include "MipsSubtarget.h"
  18 #include "MipsRegisterInfo.h"
  19 #include "MipsMachineFunction.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/Type.h"
  22 #include "llvm/Function.h"
  23 #include "llvm/CodeGen/ValueTypes.h"
  24 #include "llvm/CodeGen/MachineInstrBuilder.h"
  25 #include "llvm/CodeGen/MachineFunction.h"
  26 #include "llvm/CodeGen/MachineFrameInfo.h"
  27 #include "llvm/CodeGen/MachineLocation.h"
  28 #include "llvm/Target/TargetFrameInfo.h"
  29 #include "llvm/Target/TargetMachine.h"
  30 #include "llvm/Target/TargetOptions.h"
  31 #include "llvm/Target/TargetInstrInfo.h"
  32 #include "llvm/Support/CommandLine.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/ADT/BitVector.h"
  35 #include "llvm/ADT/STLExtras.h"
  36
  37 using namespace llvm;
  38
  39 MipsRegisterInfo::MipsRegisterInfo(const MipsSubtarget &ST,
  40                                    const TargetInstrInfo &tii)
  41   : MipsGenRegisterInfo(Mips::ADJCALLSTACKDOWN, Mips::ADJCALLSTACKUP),
  42     Subtarget(ST), TII(tii) {}
  43
  44 /// getRegisterNumbering - Given the enum value for some register, e.g.
  45 /// Mips::RA, return the number that it corresponds to (e.g. 31).
  46 unsigned MipsRegisterInfo::
  47 getRegisterNumbering(unsigned RegEnum)
  48 {
  49   switch (RegEnum) {
  50     case Mips::ZERO : case Mips::F0 : return 0;
  51     case Mips::AT   : case Mips::F1 : return 1;
  52     case Mips::V0   : case Mips::F2 : return 2;
  53     case Mips::V1   : case Mips::F3 : return 3;
  54     case Mips::A0   : case Mips::F4 : return 4;
  55     case Mips::A1   : case Mips::F5 : return 5;
  56     case Mips::A2   : case Mips::F6 : return 6;
  57     case Mips::A3   : case Mips::F7 : return 7;
  58     case Mips::T0   : case Mips::F8 : return 8;
  59     case Mips::T1   : case Mips::F9 : return 9;
  60     case Mips::T2   : case Mips::F10: return 10;
  61     case Mips::T3   : case Mips::F11: return 11;
  62     case Mips::T4   : case Mips::F12: return 12;
  63     case Mips::T5   : case Mips::F13: return 13;
  64     case Mips::T6   : case Mips::F14: return 14;
  65     case Mips::T7   : case Mips::F15: return 15;
  66     case Mips::T8   : case Mips::F16: return 16;
  67     case Mips::T9   : case Mips::F17: return 17;
  68     case Mips::S0   : case Mips::F18: return 18;
  69     case Mips::S1   : case Mips::F19: return 19;
  70     case Mips::S2   : case Mips::F20: return 20;
  71     case Mips::S3   : case Mips::F21: return 21;
  72     case Mips::S4   : case Mips::F22: return 22;
  73     case Mips::S5   : case Mips::F23: return 23;
  74     case Mips::S6   : case Mips::F24: return 24;
  75     case Mips::S7   : case Mips::F25: return 25;
  76     case Mips::K0   : case Mips::F26: return 26;
  77     case Mips::K1   : case Mips::F27: return 27;
  78     case Mips::GP   : case Mips::F28: return 28;
  79     case Mips::SP   : case Mips::F29: return 29;
  80     case Mips::FP   : case Mips::F30: return 30;
  81     case Mips::RA   : case Mips::F31: return 31;
  82     default: assert(0 && "Unknown register number!");
  83   }
  84   return 0; // Not reached
  85 }
  86
  87 unsigned MipsRegisterInfo::getPICCallReg(void) { return Mips::T9; }
  88
  89 //===----------------------------------------------------------------------===//
  90 // Callee Saved Registers methods
  91 //===----------------------------------------------------------------------===//
  92
  93 /// Mips Callee Saved Registers
  94 const unsigned* MipsRegisterInfo::
  95 getCalleeSavedRegs(const MachineFunction *MF) const
  96 {
  97   // Mips callee-save register range is $16-$23(s0-s7)
  98   static const unsigned CalleeSavedRegs[] = {
  99     Mips::S0, Mips::S1, Mips::S2, Mips::S3,
 100     Mips::S4, Mips::S5, Mips::S6, Mips::S7, 0
 101   };
 102
 103   return CalleeSavedRegs;
 104 }
 105
 106 /// Mips Callee Saved Register Classes
 107 const TargetRegisterClass* const*
 108 MipsRegisterInfo::getCalleeSavedRegClasses(const MachineFunction *MF) const
 109 {
 110   static const TargetRegisterClass * const CalleeSavedRegClasses[] = {
 111     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass,
 112     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass,
 113     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass,
 114     &Mips::CPURegsRegClass, &Mips::CPURegsRegClass, 0
 115   };
 116   return CalleeSavedRegClasses;
 117 }
 118
 119 BitVector MipsRegisterInfo::
 120 getReservedRegs(const MachineFunction &MF) const
 121 {
 122   BitVector Reserved(getNumRegs());
 123   Reserved.set(Mips::ZERO);
 124   Reserved.set(Mips::AT);
 125   Reserved.set(Mips::K0);
 126   Reserved.set(Mips::K1);
 127   Reserved.set(Mips::GP);
 128   Reserved.set(Mips::SP);
 129   Reserved.set(Mips::FP);
 130   Reserved.set(Mips::RA);
 131   return Reserved;
 132 }
 133
 134 //===----------------------------------------------------------------------===//
 135 //
 136 // Stack Frame Processing methods
 137 // +----------------------------+
 138 //
 139 // The stack is allocated decrementing the stack pointer on
 140 // the first instruction of a function prologue. Once decremented,
 141 // all stack referencesare are done thought a positive offset
 142 // from the stack/frame pointer, so the stack is considering
 143 // to grow up! Otherwise terrible hacks would have to be made
 144 // to get this stack ABI compliant :)
 145 //
 146 //  The stack frame required by the ABI:
 147 //  Offset
 148 //
 149 //  0                 ----------
 150 //  4                 Args to pass
 151 //  .                 saved $GP  (used in PIC)
 152 //  .                 Local Area
 153 //  .                 saved "Callee Saved" Registers
 154 //  .                 saved FP
 155 //  .                 saved RA
 156 //  StackSize         -----------
 157 //
 158 // Offset - offset from sp after stack allocation on function prologue
 159 //
 160 // The sp is the stack pointer subtracted/added from the stack size
 161 // at the Prologue/Epilogue
 162 //
 163 // References to the previous stack (to obtain arguments) are done
 164 // with offsets that exceeds the stack size: (stacksize+(4*(num_arg-1))
 165 //
 166 // Examples:
 167 // - reference to the actual stack frame
 168 //   for any local area var there is smt like : FI >= 0, StackOffset: 4
 169 //     sw REGX, 4(SP)
 170 //
 171 // - reference to previous stack frame
 172 //   suppose there's a load to the 5th arguments : FI < 0, StackOffset: 16.
 173 //   The emitted instruction will be something like:
 174 //     lw REGX, 16+StackSize(SP)
 175 //
 176 // Since the total stack size is unknown on LowerFORMAL_ARGUMENTS, all
 177 // stack references (ObjectOffset) created to reference the function
 178 // arguments, are negative numbers. This way, on eliminateFrameIndex it's
 179 // possible to detect those references and the offsets are adjusted to
 180 // their real location.
 181 //
 182 //
 183 //
 184 //===----------------------------------------------------------------------===//
 185
 186 // hasFP - Return true if the specified function should have a dedicated frame
 187 // pointer register.  This is true if the function has variable sized allocas or
 188 // if frame pointer elimination is disabled.
 189 bool MipsRegisterInfo::
 190 hasFP(const MachineFunction &MF) const {
 191   return (NoFramePointerElim || MF.getFrameInfo()->hasVarSizedObjects());
 192 }
 193
 194 // This function eliminate ADJCALLSTACKDOWN,
 195 // ADJCALLSTACKUP pseudo instructions
 196 void MipsRegisterInfo::
 197 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
 198                               MachineBasicBlock::iterator I) const {
 199   // Simply discard ADJCALLSTACKDOWN, ADJCALLSTACKUP instructions.
 200   MBB.erase(I);
 201 }
 202
 203 // FrameIndex represent objects inside a abstract stack.
 204 // We must replace FrameIndex with an stack/frame pointer
 205 // direct reference.
 206 void MipsRegisterInfo::
 207 eliminateFrameIndex(MachineBasicBlock::iterator II, int SPAdj,
 208                     RegScavenger *RS) const
 209 {
 210   MachineInstr &MI = *II;
 211   MachineFunction &MF = *MI.getParent()->getParent();
 212
 213   unsigned i = 0;
 214   while (!MI.getOperand(i).isFrameIndex()) {
 215     ++i;
 216     assert(i < MI.getNumOperands() &&
 217            "Instr doesn't have FrameIndex operand!");
 218   }
 219
 220   #ifndef NDEBUG
 221   DOUT << "\nFunction : " << MF.getFunction()->getName() << "\n";
 222   DOUT << "<--------->\n";
 223   MI.print(DOUT);
 224   #endif
 225
 226   int FrameIndex = MI.getOperand(i).getIndex();
 227   int stackSize  = MF.getFrameInfo()->getStackSize();
 228   int spOffset   = MF.getFrameInfo()->getObjectOffset(FrameIndex);
 229
 230   #ifndef NDEBUG
 231   DOUT << "FrameIndex : " << FrameIndex << "\n";
 232   DOUT << "spOffset   : " << spOffset << "\n";
 233   DOUT << "stackSize  : " << stackSize << "\n";
 234   #endif
 235
 236   // as explained on LowerFORMAL_ARGUMENTS, detect negative offsets
 237   // and adjust SPOffsets considering the final stack size.
 238   int Offset = ((spOffset < 0) ? (stackSize + (-(spOffset+4))) : (spOffset));
 239   Offset    += MI.getOperand(i-1).getImm();
 240
 241   #ifndef NDEBUG
 242   DOUT << "Offset     : " << Offset << "\n";
 243   DOUT << "<--------->\n";
 244   #endif
 245
 246   MI.getOperand(i-1).ChangeToImmediate(Offset);
 247   MI.getOperand(i).ChangeToRegister(getFrameRegister(MF), false);
 248 }
 249
 250 void MipsRegisterInfo::
 251 emitPrologue(MachineFunction &MF) const
 252 {
 253   MachineBasicBlock &MBB   = MF.front();
 254   MachineFrameInfo *MFI    = MF.getFrameInfo();
 255   MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
 256   MachineBasicBlock::iterator MBBI = MBB.begin();
 257   bool isPIC = (MF.getTarget().getRelocationModel() == Reloc::PIC_);
 258
 259   // Replace the dummy '0' SPOffset by the negative
 260   // offsets, as explained on LowerFORMAL_ARGUMENTS
 261   MipsFI->adjustLoadArgsFI(MFI);
 262   MipsFI->adjustStoreVarArgsFI(MFI);
 263
 264   // Get the number of bytes to allocate from the FrameInfo.
 265   int NumBytes = (int) MFI->getStackSize();
 266
 267   #ifndef NDEBUG
 268   DOUT << "\n<--- EMIT PROLOGUE --->\n";
 269   DOUT << "Actual Stack size :" << NumBytes << "\n";
 270   #endif
 271
 272   // No need to allocate space on the stack.
 273   if (NumBytes == 0 && !MFI->hasCalls()) return;
 274
 275   int FPOffset, RAOffset;
 276
 277   // Allocate space for saved RA and FP when needed
 278   // FIXME: within 64-bit registers, change hardcoded
 279   // sizes for RA and FP offsets.
 280   if ((hasFP(MF)) && (MFI->hasCalls())) {
 281     FPOffset = NumBytes;
 282     RAOffset = (NumBytes+4);
 283     NumBytes += 8;
 284   } else if ((!hasFP(MF)) && (MFI->hasCalls())) {
 285     FPOffset = 0;
 286     RAOffset = NumBytes;
 287     NumBytes += 4;
 288   } else if ((hasFP(MF)) && (!MFI->hasCalls())) {
 289     FPOffset = NumBytes;
 290     RAOffset = 0;
 291     NumBytes += 4;
 292   } else { // No calls and no fp.
 293     RAOffset = FPOffset = 0;
 294   }
 295
 296   MFI->setObjectOffset(MFI->CreateStackObject(4,4), FPOffset);
 297   MFI->setObjectOffset(MFI->CreateStackObject(4,4), RAOffset);
 298   MipsFI->setFPStackOffset(FPOffset);
 299   MipsFI->setRAStackOffset(RAOffset);
 300
 301   // Align stack.
 302   unsigned Align = MF.getTarget().getFrameInfo()->getStackAlignment();
 303   NumBytes = ((NumBytes+Align-1)/Align*Align);
 304
 305   #ifndef NDEBUG
 306   DOUT << "FPOffset :" << FPOffset << "\n";
 307   DOUT << "RAOffset :" << RAOffset << "\n";
 308   DOUT << "New stack size :" << NumBytes << "\n\n";
 309   #endif
 310
 311   // Update frame info
 312   MFI->setStackSize(NumBytes);
 313
 314   BuildMI(MBB, MBBI, TII.get(Mips::NOREORDER));
 315
 316   // TODO: check need from GP here.
 317   if (isPIC && Subtarget.isABI_O32())
 318     BuildMI(MBB, MBBI, TII.get(Mips::CPLOAD)).addReg(getPICCallReg());
 319   BuildMI(MBB, MBBI, TII.get(Mips::NOMACRO));
 320
 321   // Adjust stack : addi sp, sp, (-imm)
 322   BuildMI(MBB, MBBI, TII.get(Mips::ADDiu), Mips::SP)
 323       .addReg(Mips::SP).addImm(-NumBytes);
 324
 325   // Save the return address only if the function isnt a leaf one.
 326   // sw  $ra, stack_loc($sp)
 327   if (MFI->hasCalls()) {
 328     BuildMI(MBB, MBBI, TII.get(Mips::SW))
 329         .addReg(Mips::RA).addImm(RAOffset).addReg(Mips::SP);
 330   }
 331
 332   // if framepointer enabled, save it and set it
 333   // to point to the stack pointer
 334   if (hasFP(MF)) {
 335     // sw  $fp,stack_loc($sp)
 336     BuildMI(MBB, MBBI, TII.get(Mips::SW))
 337       .addReg(Mips::FP).addImm(FPOffset).addReg(Mips::SP);
 338
 339     // move $fp, $sp
 340     BuildMI(MBB, MBBI, TII.get(Mips::ADDu), Mips::FP)
 341       .addReg(Mips::SP).addReg(Mips::ZERO);
 342   }
 343
 344   // PIC speficic function prologue
 345   if ((isPIC) && (MFI->hasCalls())) {
 346     BuildMI(MBB, MBBI, TII.get(Mips::CPRESTORE))
 347       .addImm(MipsFI->getGPStackOffset());
 348   }
 349 }
 350
 351 void MipsRegisterInfo::
 352 emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const
 353 {
 354   MachineBasicBlock::iterator MBBI = prior(MBB.end());
 355   MachineFrameInfo *MFI            = MF.getFrameInfo();
 356   MipsFunctionInfo *MipsFI         = MF.getInfo<MipsFunctionInfo>();
 357
 358   // Get the number of bytes from FrameInfo
 359   int NumBytes = (int) MFI->getStackSize();
 360
 361   // Get the FI's where RA and FP are saved.
 362   int FPOffset = MipsFI->getFPStackOffset();
 363   int RAOffset = MipsFI->getRAStackOffset();
 364
 365   // if framepointer enabled, restore it and restore the
 366   // stack pointer
 367   if (hasFP(MF)) {
 368     // move $sp, $fp
 369     BuildMI(MBB, MBBI, TII.get(Mips::ADDu), Mips::SP)
 370       .addReg(Mips::FP).addReg(Mips::ZERO);
 371
 372     // lw  $fp,stack_loc($sp)
 373     BuildMI(MBB, MBBI, TII.get(Mips::LW))
 374       .addReg(Mips::FP).addImm(FPOffset).addReg(Mips::SP);
 375   }
 376
 377   // Restore the return address only if the function isnt a leaf one.
 378   // lw  $ra, stack_loc($sp)
 379   if (MFI->hasCalls()) {
 380     BuildMI(MBB, MBBI, TII.get(Mips::LW))
 381       .addReg(Mips::RA).addImm(RAOffset).addReg(Mips::SP);
 382   }
 383
 384   // adjust stack  : insert addi sp, sp, (imm)
 385   if (NumBytes) {
 386     BuildMI(MBB, MBBI, TII.get(Mips::ADDiu), Mips::SP)
 387       .addReg(Mips::SP).addImm(NumBytes);
 388   }
 389 }
 390
 391 void MipsRegisterInfo::
 392 processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
 393   // Set the SPOffset on the FI where GP must be saved/loaded.
 394   MachineFrameInfo *MFI = MF.getFrameInfo();
 395   bool isPIC = (MF.getTarget().getRelocationModel() == Reloc::PIC_);
 396   if (MFI->hasCalls() && isPIC) {
 397     MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
 398     #ifndef NDEBUG
 399     DOUT << "processFunctionBeforeFrameFinalized\n";
 400     DOUT << "GPOffset :" << MipsFI->getGPStackOffset() << "\n";
 401     DOUT << "FI :" << MipsFI->getGPFI() << "\n";
 402     #endif
 403     MFI->setObjectOffset(MipsFI->getGPFI(), MipsFI->getGPStackOffset());
 404   }
 405 }
 406
 407 unsigned MipsRegisterInfo::
 408 getRARegister() const {
 409   return Mips::RA;
 410 }
 411
 412 unsigned MipsRegisterInfo::
 413 getFrameRegister(MachineFunction &MF) const {
 414   return hasFP(MF) ? Mips::FP : Mips::SP;
 415 }
 416
 417 unsigned MipsRegisterInfo::
 418 getEHExceptionRegister() const {
 419   assert(0 && "What is the exception register");
 420   return 0;
 421 }
 422
 423 unsigned MipsRegisterInfo::
 424 getEHHandlerRegister() const {
 425   assert(0 && "What is the exception handler register");
 426   return 0;
 427 }
 428
 429 int MipsRegisterInfo::
 430 getDwarfRegNum(unsigned RegNum, bool isEH) const {
 431   assert(0 && "What is the dwarf register number");
 432   return -1;
 433 }
 434
 435 #include "MipsGenRegisterInfo.inc"
 436