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 #include "Support/STLExtras.h"
  28 using 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                                          MachineBasicBlock::iterator 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                                           MachineBasicBlock::iterator 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                                   MachineBasicBlock::iterator 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 void X86RegisterInfo::
  95 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
  96                               MachineBasicBlock::iterator I) const {
  97   if (hasFP(MF)) {
  98     // If we have a frame pointer, turn the adjcallstackup instruction into a
  99     // 'sub ESP, <amt>' and the adjcallstackdown instruction into 'add ESP,
 100     // <amt>'
 101     MachineInstr *Old = I;
 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       MachineInstr *New;
 111       if (Old->getOpcode() == X86::ADJCALLSTACKDOWN) {
 112         New=BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(Amount);
 113       } else {
 114         assert(Old->getOpcode() == X86::ADJCALLSTACKUP);
 115         New=BuildMI(X86::ADDri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(Amount);
 116       }
 117
 118       // Replace the pseudo instruction with a new instruction...
 119       MBB.insert(I, New);
 120     }
 121   }
 122
 123   MBB.erase(I);
 124 }
 125
 126 void X86RegisterInfo::eliminateFrameIndex(MachineFunction &MF,
 127                                          MachineBasicBlock::iterator II) const {
 128   unsigned i = 0;
 129   MachineInstr &MI = *II;
 130   while (!MI.getOperand(i).isFrameIndex()) {
 131     ++i;
 132     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
 133   }
 134
 135   int FrameIndex = MI.getOperand(i).getFrameIndex();
 136
 137   // This must be part of a four operand memory reference.  Replace the
 138   // FrameIndex with base register with EBP.  Add add an offset to the offset.
 139   MI.SetMachineOperandReg(i, hasFP(MF) ? X86::EBP : X86::ESP);
 140
 141   // Now add the frame object offset to the offset from EBP.
 142   int Offset = MF.getFrameInfo()->getObjectOffset(FrameIndex) +
 143                MI.getOperand(i+3).getImmedValue()+4;
 144
 145   if (!hasFP(MF))
 146     Offset += MF.getFrameInfo()->getStackSize();
 147
 148   MI.SetMachineOperandConst(i+3, MachineOperand::MO_SignExtendedImmed, Offset);
 149 }
 150
 151 void
 152 X86RegisterInfo::processFunctionBeforeFrameFinalized(MachineFunction &MF) const{
 153   if (hasFP(MF)) {
 154     // Create a frame entry for the EBP register that must be saved.
 155     int FrameIdx = MF.getFrameInfo()->CreateStackObject(4, 4);
 156     assert(FrameIdx == MF.getFrameInfo()->getObjectIndexEnd()-1 &&
 157            "Slot for EBP register must be last in order to be found!");
 158   }
 159 }
 160
 161 void X86RegisterInfo::emitPrologue(MachineFunction &MF) const {
 162   MachineBasicBlock &MBB = MF.front();   // Prolog goes in entry BB
 163   MachineBasicBlock::iterator MBBI = MBB.begin();
 164   MachineFrameInfo *MFI = MF.getFrameInfo();
 165   MachineInstr *MI;
 166
 167   // Get the number of bytes to allocate from the FrameInfo
 168   unsigned NumBytes = MFI->getStackSize();
 169   if (hasFP(MF)) {
 170     // Get the offset of the stack slot for the EBP register... which is
 171     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 172     int EBPOffset = MFI->getObjectOffset(MFI->getObjectIndexEnd()-1)+4;
 173
 174     if (NumBytes) {   // adjust stack pointer: ESP -= numbytes
 175       MI= BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 176       MBB.insert(MBBI, MI);
 177     }
 178
 179     // Save EBP into the appropriate stack slot...
 180     MI = addRegOffset(BuildMI(X86::MOVrm32, 5),    // mov [ESP-<offset>], EBP
 181                       X86::ESP, EBPOffset+NumBytes).addReg(X86::EBP);
 182     MBB.insert(MBBI, MI);
 183
 184     // Update EBP with the new base value...
 185     if (NumBytes == 0)    // mov EBP, ESP
 186       MI = BuildMI(X86::MOVrr32, 2, X86::EBP).addReg(X86::ESP);
 187     else                  // lea EBP, [ESP+StackSize]
 188       MI = addRegOffset(BuildMI(X86::LEAr32, 5, X86::EBP), X86::ESP, NumBytes);
 189
 190     MBB.insert(MBBI, MI);
 191
 192   } else {
 193     // When we have no frame pointer, we reserve argument space for call sites
 194     // in the function immediately on entry to the current function.  This
 195     // eliminates the need for add/sub ESP brackets around call sites.
 196     //
 197     NumBytes += MFI->getMaxCallFrameSize();
 198
 199     // Round the size to a multiple of the alignment (don't forget the 4 byte
 200     // offset though).
 201     unsigned Align = MF.getTarget().getFrameInfo().getStackAlignment();
 202     NumBytes = ((NumBytes+4)+Align-1)/Align*Align - 4;
 203
 204     // Update frame info to pretend that this is part of the stack...
 205     MFI->setStackSize(NumBytes);
 206
 207     if (NumBytes) {
 208       // adjust stack pointer: ESP -= numbytes
 209       MI= BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 210       MBB.insert(MBBI, MI);
 211     }
 212   }
 213 }
 214
 215 void X86RegisterInfo::emitEpilogue(MachineFunction &MF,
 216                                    MachineBasicBlock &MBB) const {
 217   const MachineFrameInfo *MFI = MF.getFrameInfo();
 218   MachineBasicBlock::iterator MBBI = prior(MBB.end());
 219   MachineInstr *MI;
 220   assert(MBBI->getOpcode() == X86::RET &&
 221          "Can only insert epilog into returning blocks");
 222
 223   if (hasFP(MF)) {
 224     // Get the offset of the stack slot for the EBP register... which is
 225     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 226     int EBPOffset = MFI->getObjectOffset(MFI->getObjectIndexEnd()-1)+4;
 227
 228     // mov ESP, EBP
 229     MI = BuildMI(X86::MOVrr32, 1,X86::ESP).addReg(X86::EBP);
 230     MBB.insert(MBBI, MI);
 231
 232     // mov EBP, [ESP-<offset>]
 233     MI = addRegOffset(BuildMI(X86::MOVmr32, 5, X86::EBP), X86::ESP, EBPOffset);
 234     MBB.insert(MBBI, MI);
 235   } else {
 236     // Get the number of bytes allocated from the FrameInfo...
 237     unsigned NumBytes = MFI->getStackSize();
 238
 239     if (NumBytes) {    // adjust stack pointer back: ESP += numbytes
 240       MI =BuildMI(X86::ADDri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 241       MBB.insert(MBBI, MI);
 242     }
 243   }
 244 }
 245
 246 #include "X86GenRegisterInfo.inc"
 247
 248 const TargetRegisterClass*
 249 X86RegisterInfo::getRegClassForType(const Type* Ty) const {
 250   switch (Ty->getPrimitiveID()) {
 251   case Type::LongTyID:
 252   case Type::ULongTyID: assert(0 && "Long values can't fit in registers!");
 253   default:              assert(0 && "Invalid type to getClass!");
 254   case Type::BoolTyID:
 255   case Type::SByteTyID:
 256   case Type::UByteTyID:   return &R8Instance;
 257   case Type::ShortTyID:
 258   case Type::UShortTyID:  return &R16Instance;
 259   case Type::IntTyID:
 260   case Type::UIntTyID:
 261   case Type::PointerTyID: return &R32Instance;
 262
 263   case Type::FloatTyID:
 264   case Type::DoubleTyID: return &RFPInstance;
 265   }
 266 }