lib/Target/X86/X86RegisterInfo.cpp

   1 //===- X86RegisterInfo.cpp - X86 Register Information -----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the X86 implementation of the MRegisterInfo class.  This
  11 // file is responsible for the frame pointer elimination optimization on X86.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "X86.h"
  16 #include "X86RegisterInfo.h"
  17 #include "X86InstrBuilder.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/Type.h"
  20 #include "llvm/CodeGen/ValueTypes.h"
  21 #include "llvm/CodeGen/MachineInstrBuilder.h"
  22 #include "llvm/CodeGen/MachineFunction.h"
  23 #include "llvm/CodeGen/MachineFrameInfo.h"
  24 #include "llvm/Target/TargetMachine.h"
  25 #include "llvm/Target/TargetFrameInfo.h"
  26 #include "Support/CommandLine.h"
  27
  28 namespace llvm {
  29
  30 namespace {
  31   cl::opt<bool>
  32   NoFPElim("disable-fp-elim",
  33            cl::desc("Disable frame pointer elimination optimization"));
  34 }
  35
  36 X86RegisterInfo::X86RegisterInfo()
  37   : X86GenRegisterInfo(X86::ADJCALLSTACKDOWN, X86::ADJCALLSTACKUP) {}
  38
  39 static unsigned getIdx(const TargetRegisterClass *RC) {
  40   switch (RC->getSize()) {
  41   default: assert(0 && "Invalid data size!");
  42   case 1:  return 0;
  43   case 2:  return 1;
  44   case 4:  return 2;
  45   case 10: return 3;
  46   }
  47 }
  48
  49 int X86RegisterInfo::storeRegToStackSlot(MachineBasicBlock &MBB,
  50                                          MachineInstr* MI,
  51                                          unsigned SrcReg, int FrameIdx,
  52                                          const TargetRegisterClass *RC) const {
  53   static const unsigned Opcode[] =
  54     { X86::MOVrm8, X86::MOVrm16, X86::MOVrm32, X86::FSTPr80 };
  55   MachineInstr *I = addFrameReference(BuildMI(Opcode[getIdx(RC)], 5),
  56                                        FrameIdx).addReg(SrcReg);
  57   MBB.insert(MI, I);
  58   return 1;
  59 }
  60
  61 int X86RegisterInfo::loadRegFromStackSlot(MachineBasicBlock &MBB,
  62                                           MachineInstr* MI,
  63                                           unsigned DestReg, int FrameIdx,
  64                                           const TargetRegisterClass *RC) const{
  65   static const unsigned Opcode[] =
  66     { X86::MOVmr8, X86::MOVmr16, X86::MOVmr32, X86::FLDr80 };
  67   unsigned OC = Opcode[getIdx(RC)];
  68   MBB.insert(MI, addFrameReference(BuildMI(OC, 4, DestReg), FrameIdx));
  69   return 1;
  70 }
  71
  72 int X86RegisterInfo::copyRegToReg(MachineBasicBlock &MBB,
  73                                   MachineInstr* MI,
  74                                   unsigned DestReg, unsigned SrcReg,
  75                                   const TargetRegisterClass *RC) const {
  76   static const unsigned Opcode[] =
  77     { X86::MOVrr8, X86::MOVrr16, X86::MOVrr32, X86::FpMOV };
  78   MBB.insert(MI, BuildMI(Opcode[getIdx(RC)],1,DestReg).addReg(SrcReg));
  79   return 1;
  80 }
  81
  82 //===----------------------------------------------------------------------===//
  83 // Stack Frame Processing methods
  84 //===----------------------------------------------------------------------===//
  85
  86 // hasFP - Return true if the specified function should have a dedicated frame
  87 // pointer register.  This is true if the function has variable sized allocas or
  88 // if frame pointer elimination is disabled.
  89 //
  90 static bool hasFP(MachineFunction &MF) {
  91   return NoFPElim || MF.getFrameInfo()->hasVarSizedObjects();
  92 }
  93
  94 int X86RegisterInfo::eliminateCallFramePseudoInstr(MachineFunction &MF,
  95                                                    MachineBasicBlock &MBB,
  96                                                    MachineInstr* I) const {
  97   MachineInstr *New = 0, *Old = I;
  98   if (hasFP(MF)) {
  99     // If we have a frame pointer, turn the adjcallstackup instruction into a
 100     // 'sub ESP, <amt>' and the adjcallstackdown instruction into 'add ESP,
 101     // <amt>'
 102     unsigned Amount = Old->getOperand(0).getImmedValue();
 103     if (Amount != 0) {
 104       // We need to keep the stack aligned properly.  To do this, we round the
 105       // amount of space needed for the outgoing arguments up to the next
 106       // alignment boundary.
 107       unsigned Align = MF.getTarget().getFrameInfo().getStackAlignment();
 108       Amount = (Amount+Align-1)/Align*Align;
 109
 110       if (Old->getOpcode() == X86::ADJCALLSTACKDOWN) {
 111         New=BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(Amount);
 112       } else {
 113         assert(Old->getOpcode() == X86::ADJCALLSTACKUP);
 114         New=BuildMI(X86::ADDri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(Amount);
 115       }
 116     }
 117   }
 118
 119   if (New) {
 120     // Replace the pseudo instruction with a new instruction...
 121     MBB.insert(MBB.erase(I), New);
 122     return 0;
 123   } else {
 124     MBB.erase(I);
 125     return -1;
 126   }
 127 }
 128
 129 int X86RegisterInfo::eliminateFrameIndex(MachineFunction &MF,
 130                                          MachineInstr* II) const {
 131   unsigned i = 0;
 132   MachineInstr &MI = *II;
 133   while (!MI.getOperand(i).isFrameIndex()) {
 134     ++i;
 135     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
 136   }
 137
 138   int FrameIndex = MI.getOperand(i).getFrameIndex();
 139
 140   // This must be part of a four operand memory reference.  Replace the
 141   // FrameIndex with base register with EBP.  Add add an offset to the offset.
 142   MI.SetMachineOperandReg(i, hasFP(MF) ? X86::EBP : X86::ESP);
 143
 144   // Now add the frame object offset to the offset from EBP.
 145   int Offset = MF.getFrameInfo()->getObjectOffset(FrameIndex) +
 146                MI.getOperand(i+3).getImmedValue()+4;
 147
 148   if (!hasFP(MF))
 149     Offset += MF.getFrameInfo()->getStackSize();
 150
 151   MI.SetMachineOperandConst(i+3, MachineOperand::MO_SignExtendedImmed, Offset);
 152   return 0;
 153 }
 154
 155 int X86RegisterInfo::processFunctionBeforeFrameFinalized(MachineFunction &MF)
 156   const {
 157   if (hasFP(MF)) {
 158     // Create a frame entry for the EBP register that must be saved.
 159     int FrameIdx = MF.getFrameInfo()->CreateStackObject(4, 4);
 160     assert(FrameIdx == MF.getFrameInfo()->getObjectIndexEnd()-1 &&
 161            "Slot for EBP register must be last in order to be found!");
 162   }
 163   return 0;
 164 }
 165
 166 int X86RegisterInfo::emitPrologue(MachineFunction &MF) const {
 167   MachineBasicBlock &MBB = MF.front();   // Prolog goes in entry BB
 168   MachineBasicBlock::iterator MBBI = MBB.begin();
 169   MachineFrameInfo *MFI = MF.getFrameInfo();
 170   MachineInstr *MI;
 171
 172   unsigned oldSize = MBB.size();
 173   // Get the number of bytes to allocate from the FrameInfo
 174   unsigned NumBytes = MFI->getStackSize();
 175   if (hasFP(MF)) {
 176     // Get the offset of the stack slot for the EBP register... which is
 177     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 178     int EBPOffset = MFI->getObjectOffset(MFI->getObjectIndexEnd()-1)+4;
 179
 180     if (NumBytes) {   // adjust stack pointer: ESP -= numbytes
 181       MI= BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 182       MBB.insert(MBBI, MI);
 183     }
 184
 185     // Save EBP into the appropriate stack slot...
 186     MI = addRegOffset(BuildMI(X86::MOVrm32, 5),    // mov [ESP-<offset>], EBP
 187                       X86::ESP, EBPOffset+NumBytes).addReg(X86::EBP);
 188     MBB.insert(MBBI, MI);
 189
 190     // Update EBP with the new base value...
 191     if (NumBytes == 0)    // mov EBP, ESP
 192       MI = BuildMI(X86::MOVrr32, 2, X86::EBP).addReg(X86::ESP);
 193     else                  // lea EBP, [ESP+StackSize]
 194       MI = addRegOffset(BuildMI(X86::LEAr32, 5, X86::EBP), X86::ESP, NumBytes);
 195
 196     MBB.insert(MBBI, MI);
 197
 198   } else {
 199     // When we have no frame pointer, we reserve argument space for call sites
 200     // in the function immediately on entry to the current function.  This
 201     // eliminates the need for add/sub ESP brackets around call sites.
 202     //
 203     NumBytes += MFI->getMaxCallFrameSize();
 204
 205     // Round the size to a multiple of the alignment (don't forget the 4 byte
 206     // offset though).
 207     unsigned Align = MF.getTarget().getFrameInfo().getStackAlignment();
 208     NumBytes = ((NumBytes+4)+Align-1)/Align*Align - 4;
 209
 210     // Update frame info to pretend that this is part of the stack...
 211     MFI->setStackSize(NumBytes);
 212
 213     if (NumBytes) {
 214       // adjust stack pointer: ESP -= numbytes
 215       MI= BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 216       MBB.insert(MBBI, MI);
 217     }
 218   }
 219   return MBB.size() - oldSize;
 220 }
 221
 222 int X86RegisterInfo::emitEpilogue(MachineFunction &MF,
 223                                   MachineBasicBlock &MBB) const {
 224   unsigned oldSize = MBB.size();
 225   const MachineFrameInfo *MFI = MF.getFrameInfo();
 226   MachineBasicBlock::iterator MBBI = MBB.end(); --MBBI;
 227   MachineInstr *MI;
 228   assert(MBBI->getOpcode() == X86::RET &&
 229          "Can only insert epilog into returning blocks");
 230
 231   if (hasFP(MF)) {
 232     // Get the offset of the stack slot for the EBP register... which is
 233     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 234     int EBPOffset = MFI->getObjectOffset(MFI->getObjectIndexEnd()-1)+4;
 235
 236     // mov ESP, EBP
 237     MI = BuildMI(X86::MOVrr32, 1,X86::ESP).addReg(X86::EBP);
 238     MBB.insert(MBBI, MI);
 239
 240     // mov EBP, [ESP-<offset>]
 241     MI = addRegOffset(BuildMI(X86::MOVmr32, 5, X86::EBP), X86::ESP, EBPOffset);
 242     MBB.insert(MBBI, MI);
 243   } else {
 244     // Get the number of bytes allocated from the FrameInfo...
 245     unsigned NumBytes = MFI->getStackSize();
 246
 247     if (NumBytes) {    // adjust stack pointer back: ESP += numbytes
 248       MI =BuildMI(X86::ADDri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 249       MBB.insert(MBBI, MI);
 250     }
 251   }
 252   return MBB.size() - oldSize;
 253 }
 254
 255 } // End llvm namespace
 256
 257 #include "X86GenRegisterInfo.inc"
 258
 259 namespace llvm {
 260
 261 const TargetRegisterClass*
 262 X86RegisterInfo::getRegClassForType(const Type* Ty) const {
 263   switch (Ty->getPrimitiveID()) {
 264   case Type::LongTyID:
 265   case Type::ULongTyID: assert(0 && "Long values can't fit in registers!");
 266   default:              assert(0 && "Invalid type to getClass!");
 267   case Type::BoolTyID:
 268   case Type::SByteTyID:
 269   case Type::UByteTyID:   return &R8Instance;
 270   case Type::ShortTyID:
 271   case Type::UShortTyID:  return &R16Instance;
 272   case Type::IntTyID:
 273   case Type::UIntTyID:
 274   case Type::PointerTyID: return &R32Instance;
 275
 276   case Type::FloatTyID:
 277   case Type::DoubleTyID: return &RFPInstance;
 278   }
 279 }
 280
 281 } // End llvm namespace