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 {
  29   cl::opt<bool>
  30   NoFPElim("disable-fp-elim",
  31            cl::desc("Disable frame pointer elimination optimization"));
  32 }
  33
  34 X86RegisterInfo::X86RegisterInfo()
  35   : X86GenRegisterInfo(X86::ADJCALLSTACKDOWN, X86::ADJCALLSTACKUP) {}
  36
  37 static unsigned getIdx(const TargetRegisterClass *RC) {
  38   switch (RC->getSize()) {
  39   default: assert(0 && "Invalid data size!");
  40   case 1:  return 0;
  41   case 2:  return 1;
  42   case 4:  return 2;
  43   case 10: return 3;
  44   }
  45 }
  46
  47 int X86RegisterInfo::storeRegToStackSlot(MachineBasicBlock &MBB,
  48                                          MachineBasicBlock::iterator &MBBI,
  49                                          unsigned SrcReg, int FrameIdx,
  50                                          const TargetRegisterClass *RC) const {
  51   static const unsigned Opcode[] =
  52     { X86::MOVrm8, X86::MOVrm16, X86::MOVrm32, X86::FSTPr80 };
  53   MachineInstr *MI = addFrameReference(BuildMI(Opcode[getIdx(RC)], 5),
  54                                        FrameIdx).addReg(SrcReg);
  55   MBBI = MBB.insert(MBBI, MI)+1;
  56   return 1;
  57 }
  58
  59 int X86RegisterInfo::loadRegFromStackSlot(MachineBasicBlock &MBB,
  60                                           MachineBasicBlock::iterator &MBBI,
  61                                           unsigned DestReg, int FrameIdx,
  62                                           const TargetRegisterClass *RC) const{
  63   static const unsigned Opcode[] =
  64     { X86::MOVmr8, X86::MOVmr16, X86::MOVmr32, X86::FLDr80 };
  65   MachineInstr *MI = addFrameReference(BuildMI(Opcode[getIdx(RC)], 4, DestReg),
  66                                        FrameIdx);
  67   MBBI = MBB.insert(MBBI, MI)+1;
  68   return 1;
  69 }
  70
  71 int X86RegisterInfo::copyRegToReg(MachineBasicBlock &MBB,
  72                                   MachineBasicBlock::iterator &MBBI,
  73                                   unsigned DestReg, unsigned SrcReg,
  74                                   const TargetRegisterClass *RC) const {
  75   static const unsigned Opcode[] =
  76     { X86::MOVrr8, X86::MOVrr16, X86::MOVrr32, X86::FpMOV };
  77   MachineInstr *MI = BuildMI(Opcode[getIdx(RC)],1,DestReg).addReg(SrcReg);
  78   MBBI = MBB.insert(MBBI, MI)+1;
  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                                          MachineBasicBlock::iterator &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, 2, X86::ESP).addReg(X86::ESP).addZImm(Amount);
 112       } else {
 113         assert(Old->getOpcode() == X86::ADJCALLSTACKUP);
 114         New=BuildMI(X86::ADDri32, 2, X86::ESP).addReg(X86::ESP).addZImm(Amount);
 115       }
 116     }
 117   }
 118
 119   if (New) {
 120     *I = New;        // Replace the pseudo instruction with a new instruction...
 121     delete Old;
 122     return 0;
 123   } else {
 124     I = MBB.erase(I);// Just delete the pseudo instruction...
 125     delete Old;
 126     return -1;
 127   }
 128 }
 129
 130 int X86RegisterInfo::eliminateFrameIndex(MachineFunction &MF,
 131                                         MachineBasicBlock::iterator &II) const {
 132   unsigned i = 0;
 133   MachineInstr &MI = **II;
 134   while (!MI.getOperand(i).isFrameIndex()) {
 135     ++i;
 136     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
 137   }
 138
 139   int FrameIndex = MI.getOperand(i).getFrameIndex();
 140
 141   // This must be part of a four operand memory reference.  Replace the
 142   // FrameIndex with base register with EBP.  Add add an offset to the offset.
 143   MI.SetMachineOperandReg(i, hasFP(MF) ? X86::EBP : X86::ESP);
 144
 145   // Now add the frame object offset to the offset from EBP.
 146   int Offset = MF.getFrameInfo()->getObjectOffset(FrameIndex) +
 147                MI.getOperand(i+3).getImmedValue()+4;
 148
 149   if (!hasFP(MF))
 150     Offset += MF.getFrameInfo()->getStackSize();
 151
 152   MI.SetMachineOperandConst(i+3, MachineOperand::MO_SignExtendedImmed, Offset);
 153   return 0;
 154 }
 155
 156 int X86RegisterInfo::processFunctionBeforeFrameFinalized(MachineFunction &MF)
 157   const {
 158   if (hasFP(MF)) {
 159     // Create a frame entry for the EBP register that must be saved.
 160     int FrameIdx = MF.getFrameInfo()->CreateStackObject(4, 4);
 161     assert(FrameIdx == MF.getFrameInfo()->getObjectIndexEnd()-1 &&
 162            "Slot for EBP register must be last in order to be found!");
 163   }
 164   return 0;
 165 }
 166
 167 int X86RegisterInfo::emitPrologue(MachineFunction &MF) const {
 168   MachineBasicBlock &MBB = MF.front();   // Prolog goes in entry BB
 169   MachineBasicBlock::iterator MBBI = MBB.begin();
 170   MachineFrameInfo *MFI = MF.getFrameInfo();
 171   MachineInstr *MI;
 172
 173   unsigned oldSize = MBB.size();
 174   // Get the number of bytes to allocate from the FrameInfo
 175   unsigned NumBytes = MFI->getStackSize();
 176   if (hasFP(MF)) {
 177     // Get the offset of the stack slot for the EBP register... which is
 178     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 179     int EBPOffset = MFI->getObjectOffset(MFI->getObjectIndexEnd()-1)+4;
 180
 181     if (NumBytes) {   // adjust stack pointer: ESP -= numbytes
 182       MI= BuildMI(X86::SUBri32, 2, X86::ESP).addReg(X86::ESP).addZImm(NumBytes);
 183       MBBI = MBB.insert(MBBI, MI)+1;
 184     }
 185
 186     // Save EBP into the appropriate stack slot...
 187     MI = addRegOffset(BuildMI(X86::MOVrm32, 5),    // mov [ESP-<offset>], EBP
 188                       X86::ESP, EBPOffset+NumBytes).addReg(X86::EBP);
 189     MBBI = MBB.insert(MBBI, MI)+1;
 190
 191     // Update EBP with the new base value...
 192     if (NumBytes == 0)    // mov EBP, ESP
 193       MI = BuildMI(X86::MOVrr32, 2, X86::EBP).addReg(X86::ESP);
 194     else                  // lea EBP, [ESP+StackSize]
 195       MI = addRegOffset(BuildMI(X86::LEAr32, 5, X86::EBP), X86::ESP, NumBytes);
 196
 197     MBBI = MBB.insert(MBBI, MI)+1;
 198
 199   } else {
 200     // When we have no frame pointer, we reserve argument space for call sites
 201     // in the function immediately on entry to the current function.  This
 202     // eliminates the need for add/sub ESP brackets around call sites.
 203     //
 204     NumBytes += MFI->getMaxCallFrameSize();
 205
 206     // Round the size to a multiple of the alignment (don't forget the 4 byte
 207     // offset though).
 208     unsigned Align = MF.getTarget().getFrameInfo().getStackAlignment();
 209     NumBytes = ((NumBytes+4)+Align-1)/Align*Align - 4;
 210
 211     // Update frame info to pretend that this is part of the stack...
 212     MFI->setStackSize(NumBytes);
 213
 214     if (NumBytes) {
 215       // adjust stack pointer: ESP -= numbytes
 216       MI= BuildMI(X86::SUBri32, 2, X86::ESP).addReg(X86::ESP).addZImm(NumBytes);
 217       MBB.insert(MBBI, MI);
 218     }
 219   }
 220   return MBB.size() - oldSize;
 221 }
 222
 223 int X86RegisterInfo::emitEpilogue(MachineFunction &MF,
 224                                   MachineBasicBlock &MBB) const {
 225   unsigned oldSize = MBB.size();
 226   const MachineFrameInfo *MFI = MF.getFrameInfo();
 227   MachineBasicBlock::iterator MBBI = MBB.end()-1;
 228   MachineInstr *MI;
 229   assert((*MBBI)->getOpcode() == X86::RET &&
 230          "Can only insert epilog into returning blocks");
 231
 232   if (hasFP(MF)) {
 233     // Get the offset of the stack slot for the EBP register... which is
 234     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 235     int EBPOffset = MFI->getObjectOffset(MFI->getObjectIndexEnd()-1)+4;
 236
 237     // mov ESP, EBP
 238     MI = BuildMI(X86::MOVrr32, 1,X86::ESP).addReg(X86::EBP);
 239     MBBI = 1+MBB.insert(MBBI, MI);
 240
 241     // mov EBP, [ESP-<offset>]
 242     MI = addRegOffset(BuildMI(X86::MOVmr32, 5, X86::EBP), X86::ESP, EBPOffset);
 243     MBBI = 1+MBB.insert(MBBI, MI);
 244   } else {
 245     // Get the number of bytes allocated from the FrameInfo...
 246     unsigned NumBytes = MFI->getStackSize();
 247
 248     if (NumBytes) {    // adjust stack pointer back: ESP += numbytes
 249       MI =BuildMI(X86::ADDri32, 2, X86::ESP).addReg(X86::ESP).addZImm(NumBytes);
 250       MBBI = 1+MBB.insert(MBBI, MI);
 251     }
 252   }
 253   return MBB.size() - oldSize;
 254 }
 255
 256 #include "X86GenRegisterInfo.inc"
 257
 258 const TargetRegisterClass*
 259 X86RegisterInfo::getRegClassForType(const Type* Ty) const {
 260   switch (Ty->getPrimitiveID()) {
 261   case Type::LongTyID:
 262   case Type::ULongTyID: assert(0 && "Long values can't fit in registers!");
 263   default:              assert(0 && "Invalid type to getClass!");
 264   case Type::BoolTyID:
 265   case Type::SByteTyID:
 266   case Type::UByteTyID:   return &R8Instance;
 267   case Type::ShortTyID:
 268   case Type::UShortTyID:  return &R16Instance;
 269   case Type::IntTyID:
 270   case Type::UIntTyID:
 271   case Type::PointerTyID: return &R32Instance;
 272
 273   case Type::FloatTyID:
 274   case Type::DoubleTyID: return &RFPInstance;
 275   }
 276 }