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   cl::opt<bool>
  35   NoFusing("disable-spill-fusing",
  36            cl::desc("Disable fusing of spill code into instructions"));
  37 }
  38
  39 X86RegisterInfo::X86RegisterInfo()
  40   : X86GenRegisterInfo(X86::ADJCALLSTACKDOWN, X86::ADJCALLSTACKUP) {}
  41
  42 static unsigned getIdx(const TargetRegisterClass *RC) {
  43   switch (RC->getSize()) {
  44   default: assert(0 && "Invalid data size!");
  45   case 1:  return 0;
  46   case 2:  return 1;
  47   case 4:  return 2;
  48   case 10: return 3;
  49   }
  50 }
  51
  52 int X86RegisterInfo::storeRegToStackSlot(MachineBasicBlock &MBB,
  53                                          MachineBasicBlock::iterator MI,
  54                                          unsigned SrcReg, int FrameIdx,
  55                                          const TargetRegisterClass *RC) const {
  56   static const unsigned Opcode[] =
  57     { X86::MOVmr8, X86::MOVmr16, X86::MOVmr32, X86::FSTPr80 };
  58   MachineInstr *I = addFrameReference(BuildMI(Opcode[getIdx(RC)], 5),
  59                                        FrameIdx).addReg(SrcReg);
  60   MBB.insert(MI, I);
  61   return 1;
  62 }
  63
  64 int X86RegisterInfo::loadRegFromStackSlot(MachineBasicBlock &MBB,
  65                                           MachineBasicBlock::iterator MI,
  66                                           unsigned DestReg, int FrameIdx,
  67                                           const TargetRegisterClass *RC) const{
  68   static const unsigned Opcode[] =
  69     { X86::MOVrm8, X86::MOVrm16, X86::MOVrm32, X86::FLDr80 };
  70   unsigned OC = Opcode[getIdx(RC)];
  71   MBB.insert(MI, addFrameReference(BuildMI(OC, 4, DestReg), FrameIdx));
  72   return 1;
  73 }
  74
  75 int X86RegisterInfo::copyRegToReg(MachineBasicBlock &MBB,
  76                                   MachineBasicBlock::iterator MI,
  77                                   unsigned DestReg, unsigned SrcReg,
  78                                   const TargetRegisterClass *RC) const {
  79   static const unsigned Opcode[] =
  80     { X86::MOVrr8, X86::MOVrr16, X86::MOVrr32, X86::FpMOV };
  81   MBB.insert(MI, BuildMI(Opcode[getIdx(RC)],1,DestReg).addReg(SrcReg));
  82   return 1;
  83 }
  84
  85 static MachineInstr *MakeMRInst(unsigned Opcode, unsigned FrameIndex,
  86                                 MachineInstr *MI) {
  87   return addFrameReference(BuildMI(Opcode, 5), FrameIndex)
  88                  .addReg(MI->getOperand(1).getReg());
  89 }
  90
  91 static MachineInstr *MakeMIInst(unsigned Opcode, unsigned FrameIndex,
  92                                 MachineInstr *MI) {
  93   return addFrameReference(BuildMI(Opcode, 5), FrameIndex)
  94                  .addZImm(MI->getOperand(1).getImmedValue());
  95 }
  96
  97 static MachineInstr *MakeRMInst(unsigned Opcode, unsigned FrameIndex,
  98                                 MachineInstr *MI) {
  99   return addFrameReference(BuildMI(Opcode, 5, MI->getOperand(0).getReg()),
 100                            FrameIndex);
 101 }
 102
 103 static MachineInstr *MakeRMIInst(unsigned Opcode, unsigned FrameIndex,
 104                                  MachineInstr *MI) {
 105   return addFrameReference(BuildMI(Opcode, 5, MI->getOperand(0).getReg()),
 106                         FrameIndex).addZImm(MI->getOperand(2).getImmedValue());
 107 }
 108
 109
 110 bool X86RegisterInfo::foldMemoryOperand(MachineBasicBlock::iterator &MI,
 111                                         unsigned i, int FrameIndex) const {
 112   if (NoFusing) return false;
 113
 114   /// FIXME: This should obviously be autogenerated by tablegen when patterns
 115   /// are available!
 116   MachineBasicBlock& MBB = *MI->getParent();
 117   MachineInstr* NI = 0;
 118   if (i == 0) {
 119     switch(MI->getOpcode()) {
 120     case X86::MOVrr8:  NI = MakeMRInst(X86::MOVmr8 , FrameIndex, MI); break;
 121     case X86::MOVrr16: NI = MakeMRInst(X86::MOVmr16, FrameIndex, MI); break;
 122     case X86::MOVrr32: NI = MakeMRInst(X86::MOVmr32, FrameIndex, MI); break;
 123     case X86::MOVri8:  NI = MakeMIInst(X86::MOVmi8 , FrameIndex, MI); break;
 124     case X86::MOVri16: NI = MakeMIInst(X86::MOVmi16, FrameIndex, MI); break;
 125     case X86::MOVri32: NI = MakeMIInst(X86::MOVmi32, FrameIndex, MI); break;
 126     case X86::ADDrr8:  NI = MakeMRInst(X86::ADDmr8 , FrameIndex, MI); break;
 127     case X86::ADDrr16: NI = MakeMRInst(X86::ADDmr16, FrameIndex, MI); break;
 128     case X86::ADDrr32: NI = MakeMRInst(X86::ADDmr32, FrameIndex, MI); break;
 129     case X86::ADDri8:  NI = MakeMIInst(X86::ADDmi8 , FrameIndex, MI); break;
 130     case X86::ADDri16: NI = MakeMIInst(X86::ADDmi16, FrameIndex, MI); break;
 131     case X86::ADDri32: NI = MakeMIInst(X86::ADDmi32, FrameIndex, MI); break;
 132     case X86::ANDrr8:  NI = MakeMRInst(X86::ANDmr8 , FrameIndex, MI); break;
 133     case X86::ANDrr16: NI = MakeMRInst(X86::ANDmr16, FrameIndex, MI); break;
 134     case X86::ANDrr32: NI = MakeMRInst(X86::ANDmr32, FrameIndex, MI); break;
 135     case X86::ANDri8:  NI = MakeMIInst(X86::ANDmi8 , FrameIndex, MI); break;
 136     case X86::ANDri16: NI = MakeMIInst(X86::ANDmi16, FrameIndex, MI); break;
 137     case X86::ANDri32: NI = MakeMIInst(X86::ANDmi32, FrameIndex, MI); break;
 138     default: return false; // Cannot fold
 139     }
 140   } else if (i == 1) {
 141     switch(MI->getOpcode()) {
 142     case X86::MOVrr8:  NI = MakeRMInst(X86::MOVrm8 , FrameIndex, MI); break;
 143     case X86::MOVrr16: NI = MakeRMInst(X86::MOVrm16, FrameIndex, MI); break;
 144     case X86::MOVrr32: NI = MakeRMInst(X86::MOVrm32, FrameIndex, MI); break;
 145     case X86::ADDrr8:  NI = MakeRMInst(X86::ADDrm8 , FrameIndex, MI); break;
 146     case X86::ADDrr16: NI = MakeRMInst(X86::ADDrm16, FrameIndex, MI); break;
 147     case X86::ADDrr32: NI = MakeRMInst(X86::ADDrm32, FrameIndex, MI); break;
 148     case X86::ANDrr8:  NI = MakeRMInst(X86::ANDrm8 , FrameIndex, MI); break;
 149     case X86::ANDrr16: NI = MakeRMInst(X86::ANDrm16, FrameIndex, MI); break;
 150     case X86::ANDrr32: NI = MakeRMInst(X86::ANDrm32, FrameIndex, MI); break;
 151     case X86::IMULrr16:NI = MakeRMInst(X86::IMULrm16, FrameIndex, MI); break;
 152     case X86::IMULrr32:NI = MakeRMInst(X86::IMULrm32, FrameIndex, MI); break;
 153     case X86::IMULrri16: NI = MakeRMIInst(X86::IMULrmi16, FrameIndex, MI); break;
 154     case X86::IMULrri32: NI = MakeRMIInst(X86::IMULrmi32, FrameIndex, MI); break;
 155     default: return false;  // cannot fold.
 156     }
 157   } else {
 158     return false; // cannot fold.
 159   }
 160
 161   MI = MBB.insert(MBB.erase(MI), NI);
 162   return true;
 163 }
 164
 165 //===----------------------------------------------------------------------===//
 166 // Stack Frame Processing methods
 167 //===----------------------------------------------------------------------===//
 168
 169 // hasFP - Return true if the specified function should have a dedicated frame
 170 // pointer register.  This is true if the function has variable sized allocas or
 171 // if frame pointer elimination is disabled.
 172 //
 173 static bool hasFP(MachineFunction &MF) {
 174   return NoFPElim || MF.getFrameInfo()->hasVarSizedObjects();
 175 }
 176
 177 void X86RegisterInfo::
 178 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
 179                               MachineBasicBlock::iterator I) const {
 180   if (hasFP(MF)) {
 181     // If we have a frame pointer, turn the adjcallstackup instruction into a
 182     // 'sub ESP, <amt>' and the adjcallstackdown instruction into 'add ESP,
 183     // <amt>'
 184     MachineInstr *Old = I;
 185     unsigned Amount = Old->getOperand(0).getImmedValue();
 186     if (Amount != 0) {
 187       // We need to keep the stack aligned properly.  To do this, we round the
 188       // amount of space needed for the outgoing arguments up to the next
 189       // alignment boundary.
 190       unsigned Align = MF.getTarget().getFrameInfo().getStackAlignment();
 191       Amount = (Amount+Align-1)/Align*Align;
 192
 193       MachineInstr *New;
 194       if (Old->getOpcode() == X86::ADJCALLSTACKDOWN) {
 195         New=BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(Amount);
 196       } else {
 197         assert(Old->getOpcode() == X86::ADJCALLSTACKUP);
 198         New=BuildMI(X86::ADDri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(Amount);
 199       }
 200
 201       // Replace the pseudo instruction with a new instruction...
 202       MBB.insert(I, New);
 203     }
 204   }
 205
 206   MBB.erase(I);
 207 }
 208
 209 void X86RegisterInfo::eliminateFrameIndex(MachineFunction &MF,
 210                                          MachineBasicBlock::iterator II) const {
 211   unsigned i = 0;
 212   MachineInstr &MI = *II;
 213   while (!MI.getOperand(i).isFrameIndex()) {
 214     ++i;
 215     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
 216   }
 217
 218   int FrameIndex = MI.getOperand(i).getFrameIndex();
 219
 220   // This must be part of a four operand memory reference.  Replace the
 221   // FrameIndex with base register with EBP.  Add add an offset to the offset.
 222   MI.SetMachineOperandReg(i, hasFP(MF) ? X86::EBP : X86::ESP);
 223
 224   // Now add the frame object offset to the offset from EBP.
 225   int Offset = MF.getFrameInfo()->getObjectOffset(FrameIndex) +
 226                MI.getOperand(i+3).getImmedValue()+4;
 227
 228   if (!hasFP(MF))
 229     Offset += MF.getFrameInfo()->getStackSize();
 230   else
 231     Offset += 4;  // Skip the saved EBP
 232
 233   MI.SetMachineOperandConst(i+3, MachineOperand::MO_SignExtendedImmed, Offset);
 234 }
 235
 236 void
 237 X86RegisterInfo::processFunctionBeforeFrameFinalized(MachineFunction &MF) const{
 238   if (hasFP(MF)) {
 239     // Create a frame entry for the EBP register that must be saved.
 240     int FrameIdx = MF.getFrameInfo()->CreateFixedObject(4, -8);
 241     assert(FrameIdx == MF.getFrameInfo()->getObjectIndexBegin() &&
 242            "Slot for EBP register must be last in order to be found!");
 243   }
 244 }
 245
 246 void X86RegisterInfo::emitPrologue(MachineFunction &MF) const {
 247   MachineBasicBlock &MBB = MF.front();   // Prolog goes in entry BB
 248   MachineBasicBlock::iterator MBBI = MBB.begin();
 249   MachineFrameInfo *MFI = MF.getFrameInfo();
 250   MachineInstr *MI;
 251
 252   // Get the number of bytes to allocate from the FrameInfo
 253   unsigned NumBytes = MFI->getStackSize();
 254   if (hasFP(MF)) {
 255     // Get the offset of the stack slot for the EBP register... which is
 256     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 257     int EBPOffset = MFI->getObjectOffset(MFI->getObjectIndexBegin())+4;
 258
 259     if (NumBytes) {   // adjust stack pointer: ESP -= numbytes
 260       MI= BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 261       MBB.insert(MBBI, MI);
 262     }
 263
 264     // Save EBP into the appropriate stack slot...
 265     MI = addRegOffset(BuildMI(X86::MOVmr32, 5),    // mov [ESP-<offset>], EBP
 266                       X86::ESP, EBPOffset+NumBytes).addReg(X86::EBP);
 267     MBB.insert(MBBI, MI);
 268
 269     // Update EBP with the new base value...
 270     if (NumBytes == 4)    // mov EBP, ESP
 271       MI = BuildMI(X86::MOVrr32, 2, X86::EBP).addReg(X86::ESP);
 272     else                  // lea EBP, [ESP+StackSize]
 273       MI = addRegOffset(BuildMI(X86::LEAr32, 5, X86::EBP), X86::ESP,NumBytes-4);
 274
 275     MBB.insert(MBBI, MI);
 276
 277   } else {
 278     if (MFI->hasCalls()) {
 279       // When we have no frame pointer, we reserve argument space for call sites
 280       // in the function immediately on entry to the current function.  This
 281       // eliminates the need for add/sub ESP brackets around call sites.
 282       //
 283       NumBytes += MFI->getMaxCallFrameSize();
 284
 285       // Round the size to a multiple of the alignment (don't forget the 4 byte
 286       // offset though).
 287       unsigned Align = MF.getTarget().getFrameInfo().getStackAlignment();
 288       NumBytes = ((NumBytes+4)+Align-1)/Align*Align - 4;
 289     }
 290
 291     // Update frame info to pretend that this is part of the stack...
 292     MFI->setStackSize(NumBytes);
 293
 294     if (NumBytes) {
 295       // adjust stack pointer: ESP -= numbytes
 296       MI= BuildMI(X86::SUBri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 297       MBB.insert(MBBI, MI);
 298     }
 299   }
 300 }
 301
 302 void X86RegisterInfo::emitEpilogue(MachineFunction &MF,
 303                                    MachineBasicBlock &MBB) const {
 304   const MachineFrameInfo *MFI = MF.getFrameInfo();
 305   MachineBasicBlock::iterator MBBI = prior(MBB.end());
 306   MachineInstr *MI;
 307   assert(MBBI->getOpcode() == X86::RET &&
 308          "Can only insert epilog into returning blocks");
 309
 310   if (hasFP(MF)) {
 311     // Get the offset of the stack slot for the EBP register... which is
 312     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 313     int EBPOffset = MFI->getObjectOffset(MFI->getObjectIndexEnd()-1)+4;
 314
 315     // mov ESP, EBP
 316     MI = BuildMI(X86::MOVrr32, 1,X86::ESP).addReg(X86::EBP);
 317     MBB.insert(MBBI, MI);
 318
 319     // pop EBP
 320     MI = BuildMI(X86::POPr32, 0, X86::EBP);
 321     MBB.insert(MBBI, MI);
 322   } else {
 323     // Get the number of bytes allocated from the FrameInfo...
 324     unsigned NumBytes = MFI->getStackSize();
 325
 326     if (NumBytes) {    // adjust stack pointer back: ESP += numbytes
 327       MI =BuildMI(X86::ADDri32, 1, X86::ESP, MOTy::UseAndDef).addZImm(NumBytes);
 328       MBB.insert(MBBI, MI);
 329     }
 330   }
 331 }
 332
 333 #include "X86GenRegisterInfo.inc"
 334
 335 const TargetRegisterClass*
 336 X86RegisterInfo::getRegClassForType(const Type* Ty) const {
 337   switch (Ty->getPrimitiveID()) {
 338   case Type::LongTyID:
 339   case Type::ULongTyID: assert(0 && "Long values can't fit in registers!");
 340   default:              assert(0 && "Invalid type to getClass!");
 341   case Type::BoolTyID:
 342   case Type::SByteTyID:
 343   case Type::UByteTyID:   return &R8Instance;
 344   case Type::ShortTyID:
 345   case Type::UShortTyID:  return &R16Instance;
 346   case Type::IntTyID:
 347   case Type::UIntTyID:
 348   case Type::PointerTyID: return &R32Instance;
 349
 350   case Type::FloatTyID:
 351   case Type::DoubleTyID: return &RFPInstance;
 352   }
 353 }