lib/Target/PowerPC/PPCRegisterInfo.cpp

   1 //===-- PPCRegisterInfo.cpp - PowerPC Register Information ----------------===//
   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 PowerPC implementation of the TargetRegisterInfo
  11 // class.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "reginfo"
  16 #include "PPCRegisterInfo.h"
  17 #include "PPC.h"
  18 #include "PPCFrameLowering.h"
  19 #include "PPCInstrBuilder.h"
  20 #include "PPCMachineFunctionInfo.h"
  21 #include "PPCSubtarget.h"
  22 #include "llvm/ADT/BitVector.h"
  23 #include "llvm/ADT/STLExtras.h"
  24 #include "llvm/CodeGen/MachineFrameInfo.h"
  25 #include "llvm/CodeGen/MachineFunction.h"
  26 #include "llvm/CodeGen/MachineInstrBuilder.h"
  27 #include "llvm/CodeGen/MachineModuleInfo.h"
  28 #include "llvm/CodeGen/MachineRegisterInfo.h"
  29 #include "llvm/CodeGen/RegisterScavenging.h"
  30 #include "llvm/CodeGen/ValueTypes.h"
  31 #include "llvm/IR/CallingConv.h"
  32 #include "llvm/IR/Constants.h"
  33 #include "llvm/IR/Function.h"
  34 #include "llvm/IR/Type.h"
  35 #include "llvm/Support/CommandLine.h"
  36 #include "llvm/Support/Debug.h"
  37 #include "llvm/Support/ErrorHandling.h"
  38 #include "llvm/Support/MathExtras.h"
  39 #include "llvm/Support/raw_ostream.h"
  40 #include "llvm/Target/TargetFrameLowering.h"
  41 #include "llvm/Target/TargetInstrInfo.h"
  42 #include "llvm/Target/TargetMachine.h"
  43 #include "llvm/Target/TargetOptions.h"
  44 #include <cstdlib>
  45
  46 #define GET_REGINFO_TARGET_DESC
  47 #include "PPCGenRegisterInfo.inc"
  48
  49 using namespace llvm;
  50
  51 static cl::opt<bool>
  52 EnableBasePointer("ppc-use-base-pointer", cl::Hidden, cl::init(true),
  53          cl::desc("Enable use of a base pointer for complex stack frames"));
  54
  55 static cl::opt<bool>
  56 AlwaysBasePointer("ppc-always-use-base-pointer", cl::Hidden, cl::init(false),
  57          cl::desc("Force the use of a base pointer in every function"));
  58
  59 PPCRegisterInfo::PPCRegisterInfo(const PPCSubtarget &ST)
  60   : PPCGenRegisterInfo(ST.isPPC64() ? PPC::LR8 : PPC::LR,
  61                        ST.isPPC64() ? 0 : 1,
  62                        ST.isPPC64() ? 0 : 1),
  63     Subtarget(ST) {
  64   ImmToIdxMap[PPC::LD]   = PPC::LDX;    ImmToIdxMap[PPC::STD]  = PPC::STDX;
  65   ImmToIdxMap[PPC::LBZ]  = PPC::LBZX;   ImmToIdxMap[PPC::STB]  = PPC::STBX;
  66   ImmToIdxMap[PPC::LHZ]  = PPC::LHZX;   ImmToIdxMap[PPC::LHA]  = PPC::LHAX;
  67   ImmToIdxMap[PPC::LWZ]  = PPC::LWZX;   ImmToIdxMap[PPC::LWA]  = PPC::LWAX;
  68   ImmToIdxMap[PPC::LFS]  = PPC::LFSX;   ImmToIdxMap[PPC::LFD]  = PPC::LFDX;
  69   ImmToIdxMap[PPC::STH]  = PPC::STHX;   ImmToIdxMap[PPC::STW]  = PPC::STWX;
  70   ImmToIdxMap[PPC::STFS] = PPC::STFSX;  ImmToIdxMap[PPC::STFD] = PPC::STFDX;
  71   ImmToIdxMap[PPC::ADDI] = PPC::ADD4;
  72
  73   // 64-bit
  74   ImmToIdxMap[PPC::LHA8] = PPC::LHAX8; ImmToIdxMap[PPC::LBZ8] = PPC::LBZX8;
  75   ImmToIdxMap[PPC::LHZ8] = PPC::LHZX8; ImmToIdxMap[PPC::LWZ8] = PPC::LWZX8;
  76   ImmToIdxMap[PPC::STB8] = PPC::STBX8; ImmToIdxMap[PPC::STH8] = PPC::STHX8;
  77   ImmToIdxMap[PPC::STW8] = PPC::STWX8; ImmToIdxMap[PPC::STDU] = PPC::STDUX;
  78   ImmToIdxMap[PPC::ADDI8] = PPC::ADD8;
  79 }
  80
  81 /// getPointerRegClass - Return the register class to use to hold pointers.
  82 /// This is used for addressing modes.
  83 const TargetRegisterClass *
  84 PPCRegisterInfo::getPointerRegClass(const MachineFunction &MF, unsigned Kind)
  85                                                                        const {
  86   // Note that PPCInstrInfo::FoldImmediate also directly uses this Kind value
  87   // when it checks for ZERO folding.
  88   if (Kind == 1) {
  89     if (Subtarget.isPPC64())
  90       return &PPC::G8RC_NOX0RegClass;
  91     return &PPC::GPRC_NOR0RegClass;
  92   }
  93
  94   if (Subtarget.isPPC64())
  95     return &PPC::G8RCRegClass;
  96   return &PPC::GPRCRegClass;
  97 }
  98
  99 const uint16_t*
 100 PPCRegisterInfo::getCalleeSavedRegs(const MachineFunction *MF) const {
 101   if (Subtarget.isDarwinABI())
 102     return Subtarget.isPPC64() ? (Subtarget.hasAltivec() ?
 103                                   CSR_Darwin64_Altivec_SaveList :
 104                                   CSR_Darwin64_SaveList) :
 105                                  (Subtarget.hasAltivec() ?
 106                                   CSR_Darwin32_Altivec_SaveList :
 107                                   CSR_Darwin32_SaveList);
 108
 109   return Subtarget.isPPC64() ? (Subtarget.hasAltivec() ?
 110                                 CSR_SVR464_Altivec_SaveList :
 111                                 CSR_SVR464_SaveList) :
 112                                (Subtarget.hasAltivec() ?
 113                                 CSR_SVR432_Altivec_SaveList :
 114                                 CSR_SVR432_SaveList);
 115 }
 116
 117 const uint32_t*
 118 PPCRegisterInfo::getCallPreservedMask(CallingConv::ID CC) const {
 119   if (Subtarget.isDarwinABI())
 120     return Subtarget.isPPC64() ? (Subtarget.hasAltivec() ?
 121                                   CSR_Darwin64_Altivec_RegMask :
 122                                   CSR_Darwin64_RegMask) :
 123                                  (Subtarget.hasAltivec() ?
 124                                   CSR_Darwin32_Altivec_RegMask :
 125                                   CSR_Darwin32_RegMask);
 126
 127   return Subtarget.isPPC64() ? (Subtarget.hasAltivec() ?
 128                                 CSR_SVR464_Altivec_RegMask :
 129                                 CSR_SVR464_RegMask) :
 130                                (Subtarget.hasAltivec() ?
 131                                 CSR_SVR432_Altivec_RegMask :
 132                                 CSR_SVR432_RegMask);
 133 }
 134
 135 const uint32_t*
 136 PPCRegisterInfo::getNoPreservedMask() const {
 137   return CSR_NoRegs_RegMask;
 138 }
 139
 140 BitVector PPCRegisterInfo::getReservedRegs(const MachineFunction &MF) const {
 141   BitVector Reserved(getNumRegs());
 142   const PPCFrameLowering *PPCFI =
 143     static_cast<const PPCFrameLowering*>(MF.getTarget().getFrameLowering());
 144
 145   // The ZERO register is not really a register, but the representation of r0
 146   // when used in instructions that treat r0 as the constant 0.
 147   Reserved.set(PPC::ZERO);
 148   Reserved.set(PPC::ZERO8);
 149
 150   // The FP register is also not really a register, but is the representation
 151   // of the frame pointer register used by ISD::FRAMEADDR.
 152   Reserved.set(PPC::FP);
 153   Reserved.set(PPC::FP8);
 154
 155   // The BP register is also not really a register, but is the representation
 156   // of the base pointer register used by setjmp.
 157   Reserved.set(PPC::BP);
 158   Reserved.set(PPC::BP8);
 159
 160   // The counter registers must be reserved so that counter-based loops can
 161   // be correctly formed (and the mtctr instructions are not DCE'd).
 162   Reserved.set(PPC::CTR);
 163   Reserved.set(PPC::CTR8);
 164
 165   Reserved.set(PPC::R1);
 166   Reserved.set(PPC::LR);
 167   Reserved.set(PPC::LR8);
 168   Reserved.set(PPC::RM);
 169
 170   if (!Subtarget.isDarwinABI() || !Subtarget.hasAltivec())
 171     Reserved.set(PPC::VRSAVE);
 172
 173   // The SVR4 ABI reserves r2 and r13
 174   if (Subtarget.isSVR4ABI()) {
 175     Reserved.set(PPC::R2);  // System-reserved register
 176     Reserved.set(PPC::R13); // Small Data Area pointer register
 177   }
 178
 179   // On PPC64, r13 is the thread pointer. Never allocate this register.
 180   if (Subtarget.isPPC64()) {
 181     Reserved.set(PPC::R13);
 182
 183     Reserved.set(PPC::X1);
 184     Reserved.set(PPC::X13);
 185
 186     if (PPCFI->needsFP(MF))
 187       Reserved.set(PPC::X31);
 188
 189     if (hasBasePointer(MF))
 190       Reserved.set(PPC::X30);
 191
 192     // The 64-bit SVR4 ABI reserves r2 for the TOC pointer.
 193     if (Subtarget.isSVR4ABI()) {
 194       Reserved.set(PPC::X2);
 195     }
 196   }
 197
 198   if (PPCFI->needsFP(MF))
 199     Reserved.set(PPC::R31);
 200
 201   if (hasBasePointer(MF))
 202     Reserved.set(PPC::R30);
 203
 204   // Reserve Altivec registers when Altivec is unavailable.
 205   if (!Subtarget.hasAltivec())
 206     for (TargetRegisterClass::iterator I = PPC::VRRCRegClass.begin(),
 207          IE = PPC::VRRCRegClass.end(); I != IE; ++I)
 208       Reserved.set(*I);
 209
 210   return Reserved;
 211 }
 212
 213 unsigned
 214 PPCRegisterInfo::getRegPressureLimit(const TargetRegisterClass *RC,
 215                                          MachineFunction &MF) const {
 216   const TargetFrameLowering *TFI = MF.getTarget().getFrameLowering();
 217   const unsigned DefaultSafety = 1;
 218
 219   switch (RC->getID()) {
 220   default:
 221     return 0;
 222   case PPC::G8RC_NOX0RegClassID:
 223   case PPC::GPRC_NOR0RegClassID:
 224   case PPC::G8RCRegClassID:
 225   case PPC::GPRCRegClassID: {
 226     unsigned FP = TFI->hasFP(MF) ? 1 : 0;
 227     return 32 - FP - DefaultSafety;
 228   }
 229   case PPC::F8RCRegClassID:
 230   case PPC::F4RCRegClassID:
 231   case PPC::VRRCRegClassID:
 232     return 32 - DefaultSafety;
 233   case PPC::CRRCRegClassID:
 234     return 8 - DefaultSafety;
 235   }
 236 }
 237
 238 //===----------------------------------------------------------------------===//
 239 // Stack Frame Processing methods
 240 //===----------------------------------------------------------------------===//
 241
 242 /// lowerDynamicAlloc - Generate the code for allocating an object in the
 243 /// current frame.  The sequence of code with be in the general form
 244 ///
 245 ///   addi   R0, SP, \#frameSize ; get the address of the previous frame
 246 ///   stwxu  R0, SP, Rnegsize   ; add and update the SP with the negated size
 247 ///   addi   Rnew, SP, \#maxCalFrameSize ; get the top of the allocation
 248 ///
 249 void PPCRegisterInfo::lowerDynamicAlloc(MachineBasicBlock::iterator II) const {
 250   // Get the instruction.
 251   MachineInstr &MI = *II;
 252   // Get the instruction's basic block.
 253   MachineBasicBlock &MBB = *MI.getParent();
 254   // Get the basic block's function.
 255   MachineFunction &MF = *MBB.getParent();
 256   // Get the frame info.
 257   MachineFrameInfo *MFI = MF.getFrameInfo();
 258   // Get the instruction info.
 259   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 260   // Determine whether 64-bit pointers are used.
 261   bool LP64 = Subtarget.isPPC64();
 262   DebugLoc dl = MI.getDebugLoc();
 263
 264   // Get the maximum call stack size.
 265   unsigned maxCallFrameSize = MFI->getMaxCallFrameSize();
 266   // Get the total frame size.
 267   unsigned FrameSize = MFI->getStackSize();
 268
 269   // Get stack alignments.
 270   unsigned TargetAlign = MF.getTarget().getFrameLowering()->getStackAlignment();
 271   unsigned MaxAlign = MFI->getMaxAlignment();
 272   assert((maxCallFrameSize & (MaxAlign-1)) == 0 &&
 273          "Maximum call-frame size not sufficiently aligned");
 274
 275   // Determine the previous frame's address.  If FrameSize can't be
 276   // represented as 16 bits or we need special alignment, then we load the
 277   // previous frame's address from 0(SP).  Why not do an addis of the hi?
 278   // Because R0 is our only safe tmp register and addi/addis treat R0 as zero.
 279   // Constructing the constant and adding would take 3 instructions.
 280   // Fortunately, a frame greater than 32K is rare.
 281   const TargetRegisterClass *G8RC = &PPC::G8RCRegClass;
 282   const TargetRegisterClass *GPRC = &PPC::GPRCRegClass;
 283   unsigned Reg = MF.getRegInfo().createVirtualRegister(LP64 ? G8RC : GPRC);
 284
 285   if (MaxAlign < TargetAlign && isInt<16>(FrameSize)) {
 286     BuildMI(MBB, II, dl, TII.get(PPC::ADDI), Reg)
 287       .addReg(PPC::R31)
 288       .addImm(FrameSize);
 289   } else if (LP64) {
 290     BuildMI(MBB, II, dl, TII.get(PPC::LD), Reg)
 291       .addImm(0)
 292       .addReg(PPC::X1);
 293   } else {
 294     BuildMI(MBB, II, dl, TII.get(PPC::LWZ), Reg)
 295       .addImm(0)
 296       .addReg(PPC::R1);
 297   }
 298
 299   bool KillNegSizeReg = MI.getOperand(1).isKill();
 300   unsigned NegSizeReg = MI.getOperand(1).getReg();
 301
 302   // Grow the stack and update the stack pointer link, then determine the
 303   // address of new allocated space.
 304   if (LP64) {
 305     if (MaxAlign > TargetAlign) {
 306       unsigned UnalNegSizeReg = NegSizeReg;
 307       NegSizeReg = MF.getRegInfo().createVirtualRegister(G8RC);
 308
 309       // Unfortunately, there is no andi, only andi., and we can't insert that
 310       // here because we might clobber cr0 while it is live.
 311       BuildMI(MBB, II, dl, TII.get(PPC::LI8), NegSizeReg)
 312         .addImm(~(MaxAlign-1));
 313
 314       unsigned NegSizeReg1 = NegSizeReg;
 315       NegSizeReg = MF.getRegInfo().createVirtualRegister(G8RC);
 316       BuildMI(MBB, II, dl, TII.get(PPC::AND8), NegSizeReg)
 317         .addReg(UnalNegSizeReg, getKillRegState(KillNegSizeReg))
 318         .addReg(NegSizeReg1, RegState::Kill);
 319       KillNegSizeReg = true;
 320     }
 321
 322     BuildMI(MBB, II, dl, TII.get(PPC::STDUX), PPC::X1)
 323       .addReg(Reg, RegState::Kill)
 324       .addReg(PPC::X1)
 325       .addReg(NegSizeReg, getKillRegState(KillNegSizeReg));
 326     BuildMI(MBB, II, dl, TII.get(PPC::ADDI8), MI.getOperand(0).getReg())
 327       .addReg(PPC::X1)
 328       .addImm(maxCallFrameSize);
 329   } else {
 330     if (MaxAlign > TargetAlign) {
 331       unsigned UnalNegSizeReg = NegSizeReg;
 332       NegSizeReg = MF.getRegInfo().createVirtualRegister(GPRC);
 333
 334       // Unfortunately, there is no andi, only andi., and we can't insert that
 335       // here because we might clobber cr0 while it is live.
 336       BuildMI(MBB, II, dl, TII.get(PPC::LI), NegSizeReg)
 337         .addImm(~(MaxAlign-1));
 338
 339       unsigned NegSizeReg1 = NegSizeReg;
 340       NegSizeReg = MF.getRegInfo().createVirtualRegister(GPRC);
 341       BuildMI(MBB, II, dl, TII.get(PPC::AND), NegSizeReg)
 342         .addReg(UnalNegSizeReg, getKillRegState(KillNegSizeReg))
 343         .addReg(NegSizeReg1, RegState::Kill);
 344       KillNegSizeReg = true;
 345     }
 346
 347     BuildMI(MBB, II, dl, TII.get(PPC::STWUX), PPC::R1)
 348       .addReg(Reg, RegState::Kill)
 349       .addReg(PPC::R1)
 350       .addReg(NegSizeReg, getKillRegState(KillNegSizeReg));
 351     BuildMI(MBB, II, dl, TII.get(PPC::ADDI), MI.getOperand(0).getReg())
 352       .addReg(PPC::R1)
 353       .addImm(maxCallFrameSize);
 354   }
 355
 356   // Discard the DYNALLOC instruction.
 357   MBB.erase(II);
 358 }
 359
 360 /// lowerCRSpilling - Generate the code for spilling a CR register. Instead of
 361 /// reserving a whole register (R0), we scrounge for one here. This generates
 362 /// code like this:
 363 ///
 364 ///   mfcr rA                  ; Move the conditional register into GPR rA.
 365 ///   rlwinm rA, rA, SB, 0, 31 ; Shift the bits left so they are in CR0's slot.
 366 ///   stw rA, FI               ; Store rA to the frame.
 367 ///
 368 void PPCRegisterInfo::lowerCRSpilling(MachineBasicBlock::iterator II,
 369                                       unsigned FrameIndex) const {
 370   // Get the instruction.
 371   MachineInstr &MI = *II;       // ; SPILL_CR <SrcReg>, <offset>
 372   // Get the instruction's basic block.
 373   MachineBasicBlock &MBB = *MI.getParent();
 374   MachineFunction &MF = *MBB.getParent();
 375   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 376   DebugLoc dl = MI.getDebugLoc();
 377
 378   bool LP64 = Subtarget.isPPC64();
 379   const TargetRegisterClass *G8RC = &PPC::G8RCRegClass;
 380   const TargetRegisterClass *GPRC = &PPC::GPRCRegClass;
 381
 382   unsigned Reg = MF.getRegInfo().createVirtualRegister(LP64 ? G8RC : GPRC);
 383   unsigned SrcReg = MI.getOperand(0).getReg();
 384
 385   // We need to store the CR in the low 4-bits of the saved value. First, issue
 386   // an MFOCRF to save all of the CRBits and, if needed, kill the SrcReg.
 387   BuildMI(MBB, II, dl, TII.get(LP64 ? PPC::MFOCRF8 : PPC::MFOCRF), Reg)
 388           .addReg(SrcReg, getKillRegState(MI.getOperand(0).isKill()));
 389
 390   // If the saved register wasn't CR0, shift the bits left so that they are in
 391   // CR0's slot.
 392   if (SrcReg != PPC::CR0) {
 393     unsigned Reg1 = Reg;
 394     Reg = MF.getRegInfo().createVirtualRegister(LP64 ? G8RC : GPRC);
 395
 396     // rlwinm rA, rA, ShiftBits, 0, 31.
 397     BuildMI(MBB, II, dl, TII.get(LP64 ? PPC::RLWINM8 : PPC::RLWINM), Reg)
 398       .addReg(Reg1, RegState::Kill)
 399       .addImm(getEncodingValue(SrcReg) * 4)
 400       .addImm(0)
 401       .addImm(31);
 402   }
 403
 404   addFrameReference(BuildMI(MBB, II, dl, TII.get(LP64 ? PPC::STW8 : PPC::STW))
 405                     .addReg(Reg, RegState::Kill),
 406                     FrameIndex);
 407
 408   // Discard the pseudo instruction.
 409   MBB.erase(II);
 410 }
 411
 412 void PPCRegisterInfo::lowerCRRestore(MachineBasicBlock::iterator II,
 413                                       unsigned FrameIndex) const {
 414   // Get the instruction.
 415   MachineInstr &MI = *II;       // ; <DestReg> = RESTORE_CR <offset>
 416   // Get the instruction's basic block.
 417   MachineBasicBlock &MBB = *MI.getParent();
 418   MachineFunction &MF = *MBB.getParent();
 419   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 420   DebugLoc dl = MI.getDebugLoc();
 421
 422   bool LP64 = Subtarget.isPPC64();
 423   const TargetRegisterClass *G8RC = &PPC::G8RCRegClass;
 424   const TargetRegisterClass *GPRC = &PPC::GPRCRegClass;
 425
 426   unsigned Reg = MF.getRegInfo().createVirtualRegister(LP64 ? G8RC : GPRC);
 427   unsigned DestReg = MI.getOperand(0).getReg();
 428   assert(MI.definesRegister(DestReg) &&
 429     "RESTORE_CR does not define its destination");
 430
 431   addFrameReference(BuildMI(MBB, II, dl, TII.get(LP64 ? PPC::LWZ8 : PPC::LWZ),
 432                               Reg), FrameIndex);
 433
 434   // If the reloaded register isn't CR0, shift the bits right so that they are
 435   // in the right CR's slot.
 436   if (DestReg != PPC::CR0) {
 437     unsigned Reg1 = Reg;
 438     Reg = MF.getRegInfo().createVirtualRegister(LP64 ? G8RC : GPRC);
 439
 440     unsigned ShiftBits = getEncodingValue(DestReg)*4;
 441     // rlwinm r11, r11, 32-ShiftBits, 0, 31.
 442     BuildMI(MBB, II, dl, TII.get(LP64 ? PPC::RLWINM8 : PPC::RLWINM), Reg)
 443              .addReg(Reg1, RegState::Kill).addImm(32-ShiftBits).addImm(0)
 444              .addImm(31);
 445   }
 446
 447   BuildMI(MBB, II, dl, TII.get(LP64 ? PPC::MTOCRF8 : PPC::MTOCRF), DestReg)
 448              .addReg(Reg, RegState::Kill);
 449
 450   // Discard the pseudo instruction.
 451   MBB.erase(II);
 452 }
 453
 454 void PPCRegisterInfo::lowerVRSAVESpilling(MachineBasicBlock::iterator II,
 455                                           unsigned FrameIndex) const {
 456   // Get the instruction.
 457   MachineInstr &MI = *II;       // ; SPILL_VRSAVE <SrcReg>, <offset>
 458   // Get the instruction's basic block.
 459   MachineBasicBlock &MBB = *MI.getParent();
 460   MachineFunction &MF = *MBB.getParent();
 461   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 462   DebugLoc dl = MI.getDebugLoc();
 463
 464   const TargetRegisterClass *GPRC = &PPC::GPRCRegClass;
 465   unsigned Reg = MF.getRegInfo().createVirtualRegister(GPRC);
 466   unsigned SrcReg = MI.getOperand(0).getReg();
 467
 468   BuildMI(MBB, II, dl, TII.get(PPC::MFVRSAVEv), Reg)
 469           .addReg(SrcReg, getKillRegState(MI.getOperand(0).isKill()));
 470
 471   addFrameReference(BuildMI(MBB, II, dl, TII.get(PPC::STW))
 472                     .addReg(Reg, RegState::Kill),
 473                     FrameIndex);
 474
 475   // Discard the pseudo instruction.
 476   MBB.erase(II);
 477 }
 478
 479 void PPCRegisterInfo::lowerVRSAVERestore(MachineBasicBlock::iterator II,
 480                                          unsigned FrameIndex) const {
 481   // Get the instruction.
 482   MachineInstr &MI = *II;       // ; <DestReg> = RESTORE_VRSAVE <offset>
 483   // Get the instruction's basic block.
 484   MachineBasicBlock &MBB = *MI.getParent();
 485   MachineFunction &MF = *MBB.getParent();
 486   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 487   DebugLoc dl = MI.getDebugLoc();
 488
 489   const TargetRegisterClass *GPRC = &PPC::GPRCRegClass;
 490   unsigned Reg = MF.getRegInfo().createVirtualRegister(GPRC);
 491   unsigned DestReg = MI.getOperand(0).getReg();
 492   assert(MI.definesRegister(DestReg) &&
 493     "RESTORE_VRSAVE does not define its destination");
 494
 495   addFrameReference(BuildMI(MBB, II, dl, TII.get(PPC::LWZ),
 496                               Reg), FrameIndex);
 497
 498   BuildMI(MBB, II, dl, TII.get(PPC::MTVRSAVEv), DestReg)
 499              .addReg(Reg, RegState::Kill);
 500
 501   // Discard the pseudo instruction.
 502   MBB.erase(II);
 503 }
 504
 505 bool
 506 PPCRegisterInfo::hasReservedSpillSlot(const MachineFunction &MF,
 507                                       unsigned Reg, int &FrameIdx) const {
 508
 509   // For the nonvolatile condition registers (CR2, CR3, CR4) in an SVR4
 510   // ABI, return true to prevent allocating an additional frame slot.
 511   // For 64-bit, the CR save area is at SP+8; the value of FrameIdx = 0
 512   // is arbitrary and will be subsequently ignored.  For 32-bit, we have
 513   // previously created the stack slot if needed, so return its FrameIdx.
 514   if (Subtarget.isSVR4ABI() && PPC::CR2 <= Reg && Reg <= PPC::CR4) {
 515     if (Subtarget.isPPC64())
 516       FrameIdx = 0;
 517     else {
 518       const PPCFunctionInfo *FI = MF.getInfo<PPCFunctionInfo>();
 519       FrameIdx = FI->getCRSpillFrameIndex();
 520     }
 521     return true;
 522   }
 523   return false;
 524 }
 525
 526 // Figure out if the offset in the instruction must be a multiple of 4.
 527 // This is true for instructions like "STD".
 528 static bool usesIXAddr(const MachineInstr &MI) {
 529   unsigned OpC = MI.getOpcode();
 530
 531   switch (OpC) {
 532   default:
 533     return false;
 534   case PPC::LWA:
 535   case PPC::LD:
 536   case PPC::STD:
 537     return true;
 538   }
 539 }
 540
 541 // Return the OffsetOperandNo given the FIOperandNum (and the instruction).
 542 static unsigned getOffsetONFromFION(const MachineInstr &MI,
 543                                     unsigned FIOperandNum) {
 544   // Take into account whether it's an add or mem instruction
 545   unsigned OffsetOperandNo = (FIOperandNum == 2) ? 1 : 2;
 546   if (MI.isInlineAsm())
 547     OffsetOperandNo = FIOperandNum-1;
 548
 549   return OffsetOperandNo;
 550 }
 551
 552 void
 553 PPCRegisterInfo::eliminateFrameIndex(MachineBasicBlock::iterator II,
 554                                      int SPAdj, unsigned FIOperandNum,
 555                                      RegScavenger *RS) const {
 556   assert(SPAdj == 0 && "Unexpected");
 557
 558   // Get the instruction.
 559   MachineInstr &MI = *II;
 560   // Get the instruction's basic block.
 561   MachineBasicBlock &MBB = *MI.getParent();
 562   // Get the basic block's function.
 563   MachineFunction &MF = *MBB.getParent();
 564   // Get the instruction info.
 565   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 566   // Get the frame info.
 567   MachineFrameInfo *MFI = MF.getFrameInfo();
 568   DebugLoc dl = MI.getDebugLoc();
 569
 570   unsigned OffsetOperandNo = getOffsetONFromFION(MI, FIOperandNum);
 571
 572   // Get the frame index.
 573   int FrameIndex = MI.getOperand(FIOperandNum).getIndex();
 574
 575   // Get the frame pointer save index.  Users of this index are primarily
 576   // DYNALLOC instructions.
 577   PPCFunctionInfo *FI = MF.getInfo<PPCFunctionInfo>();
 578   int FPSI = FI->getFramePointerSaveIndex();
 579   // Get the instruction opcode.
 580   unsigned OpC = MI.getOpcode();
 581
 582   // Special case for dynamic alloca.
 583   if (FPSI && FrameIndex == FPSI &&
 584       (OpC == PPC::DYNALLOC || OpC == PPC::DYNALLOC8)) {
 585     lowerDynamicAlloc(II);
 586     return;
 587   }
 588
 589   // Special case for pseudo-ops SPILL_CR and RESTORE_CR, etc.
 590   if (OpC == PPC::SPILL_CR) {
 591     lowerCRSpilling(II, FrameIndex);
 592     return;
 593   } else if (OpC == PPC::RESTORE_CR) {
 594     lowerCRRestore(II, FrameIndex);
 595     return;
 596   } else if (OpC == PPC::SPILL_VRSAVE) {
 597     lowerVRSAVESpilling(II, FrameIndex);
 598     return;
 599   } else if (OpC == PPC::RESTORE_VRSAVE) {
 600     lowerVRSAVERestore(II, FrameIndex);
 601     return;
 602   }
 603
 604   // Replace the FrameIndex with base register with GPR1 (SP) or GPR31 (FP).
 605   MI.getOperand(FIOperandNum).ChangeToRegister(
 606     FrameIndex < 0 ? getBaseRegister(MF) : getFrameRegister(MF), false);
 607
 608   // Figure out if the offset in the instruction is shifted right two bits.
 609   bool isIXAddr = usesIXAddr(MI);
 610
 611   // If the instruction is not present in ImmToIdxMap, then it has no immediate
 612   // form (and must be r+r).
 613   bool noImmForm = !MI.isInlineAsm() && !ImmToIdxMap.count(OpC);
 614
 615   // Now add the frame object offset to the offset from r1.
 616   int Offset = MFI->getObjectOffset(FrameIndex);
 617   Offset += MI.getOperand(OffsetOperandNo).getImm();
 618
 619   // If we're not using a Frame Pointer that has been set to the value of the
 620   // SP before having the stack size subtracted from it, then add the stack size
 621   // to Offset to get the correct offset.
 622   // Naked functions have stack size 0, although getStackSize may not reflect that
 623   // because we didn't call all the pieces that compute it for naked functions.
 624   if (!MF.getFunction()->getAttributes().
 625         hasAttribute(AttributeSet::FunctionIndex, Attribute::Naked)) {
 626     if (!(hasBasePointer(MF) && FrameIndex < 0))
 627       Offset += MFI->getStackSize();
 628   }
 629
 630   // If we can, encode the offset directly into the instruction.  If this is a
 631   // normal PPC "ri" instruction, any 16-bit value can be safely encoded.  If
 632   // this is a PPC64 "ix" instruction, only a 16-bit value with the low two bits
 633   // clear can be encoded.  This is extremely uncommon, because normally you
 634   // only "std" to a stack slot that is at least 4-byte aligned, but it can
 635   // happen in invalid code.
 636   assert(OpC != PPC::DBG_VALUE &&
 637          "This should be handle in a target independent way");
 638   if (!noImmForm && isInt<16>(Offset) && (!isIXAddr || (Offset & 3) == 0)) {
 639     MI.getOperand(OffsetOperandNo).ChangeToImmediate(Offset);
 640     return;
 641   }
 642
 643   // The offset doesn't fit into a single register, scavenge one to build the
 644   // offset in.
 645
 646   bool is64Bit = Subtarget.isPPC64();
 647   const TargetRegisterClass *G8RC = &PPC::G8RCRegClass;
 648   const TargetRegisterClass *GPRC = &PPC::GPRCRegClass;
 649   const TargetRegisterClass *RC = is64Bit ? G8RC : GPRC;
 650   unsigned SRegHi = MF.getRegInfo().createVirtualRegister(RC),
 651            SReg = MF.getRegInfo().createVirtualRegister(RC);
 652
 653   // Insert a set of rA with the full offset value before the ld, st, or add
 654   BuildMI(MBB, II, dl, TII.get(is64Bit ? PPC::LIS8 : PPC::LIS), SRegHi)
 655     .addImm(Offset >> 16);
 656   BuildMI(MBB, II, dl, TII.get(is64Bit ? PPC::ORI8 : PPC::ORI), SReg)
 657     .addReg(SRegHi, RegState::Kill)
 658     .addImm(Offset);
 659
 660   // Convert into indexed form of the instruction:
 661   //
 662   //   sth 0:rA, 1:imm 2:(rB) ==> sthx 0:rA, 2:rB, 1:r0
 663   //   addi 0:rA 1:rB, 2, imm ==> add 0:rA, 1:rB, 2:r0
 664   unsigned OperandBase;
 665
 666   if (noImmForm)
 667     OperandBase = 1;
 668   else if (OpC != TargetOpcode::INLINEASM) {
 669     assert(ImmToIdxMap.count(OpC) &&
 670            "No indexed form of load or store available!");
 671     unsigned NewOpcode = ImmToIdxMap.find(OpC)->second;
 672     MI.setDesc(TII.get(NewOpcode));
 673     OperandBase = 1;
 674   } else {
 675     OperandBase = OffsetOperandNo;
 676   }
 677
 678   unsigned StackReg = MI.getOperand(FIOperandNum).getReg();
 679   MI.getOperand(OperandBase).ChangeToRegister(StackReg, false);
 680   MI.getOperand(OperandBase + 1).ChangeToRegister(SReg, false, false, true);
 681 }
 682
 683 unsigned PPCRegisterInfo::getFrameRegister(const MachineFunction &MF) const {
 684   const TargetFrameLowering *TFI = MF.getTarget().getFrameLowering();
 685
 686   if (!Subtarget.isPPC64())
 687     return TFI->hasFP(MF) ? PPC::R31 : PPC::R1;
 688   else
 689     return TFI->hasFP(MF) ? PPC::X31 : PPC::X1;
 690 }
 691
 692 unsigned PPCRegisterInfo::getEHExceptionRegister() const {
 693   return !Subtarget.isPPC64() ? PPC::R3 : PPC::X3;
 694 }
 695
 696 unsigned PPCRegisterInfo::getEHHandlerRegister() const {
 697   return !Subtarget.isPPC64() ? PPC::R4 : PPC::X4;
 698 }
 699
 700 unsigned PPCRegisterInfo::getBaseRegister(const MachineFunction &MF) const {
 701   if (!hasBasePointer(MF))
 702     return getFrameRegister(MF);
 703
 704   return Subtarget.isPPC64() ? PPC::X30 : PPC::R30;
 705 }
 706
 707 bool PPCRegisterInfo::hasBasePointer(const MachineFunction &MF) const {
 708   if (!EnableBasePointer)
 709     return false;
 710   if (AlwaysBasePointer)
 711     return true;
 712
 713   // If we need to realign the stack, then the stack pointer can no longer
 714   // serve as an offset into the caller's stack space. As a result, we need a
 715   // base pointer.
 716   return needsStackRealignment(MF);
 717 }
 718
 719 bool PPCRegisterInfo::canRealignStack(const MachineFunction &MF) const {
 720   if (MF.getFunction()->hasFnAttribute("no-realign-stack"))
 721     return false;
 722
 723   return true;
 724 }
 725
 726 bool PPCRegisterInfo::needsStackRealignment(const MachineFunction &MF) const {
 727   const MachineFrameInfo *MFI = MF.getFrameInfo();
 728   const Function *F = MF.getFunction();
 729   unsigned StackAlign = MF.getTarget().getFrameLowering()->getStackAlignment();
 730   bool requiresRealignment =
 731     ((MFI->getMaxAlignment() > StackAlign) ||
 732      F->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
 733                                      Attribute::StackAlignment));
 734
 735   return requiresRealignment && canRealignStack(MF);
 736 }
 737
 738 /// Returns true if the instruction's frame index
 739 /// reference would be better served by a base register other than FP
 740 /// or SP. Used by LocalStackFrameAllocation to determine which frame index
 741 /// references it should create new base registers for.
 742 bool PPCRegisterInfo::
 743 needsFrameBaseReg(MachineInstr *MI, int64_t Offset) const {
 744   assert(Offset < 0 && "Local offset must be negative");
 745
 746   unsigned FIOperandNum = 0;
 747   while (!MI->getOperand(FIOperandNum).isFI()) {
 748     ++FIOperandNum;
 749     assert(FIOperandNum < MI->getNumOperands() &&
 750            "Instr doesn't have FrameIndex operand!");
 751   }
 752
 753   unsigned OffsetOperandNo = getOffsetONFromFION(*MI, FIOperandNum);
 754   Offset += MI->getOperand(OffsetOperandNo).getImm();
 755
 756   // It's the load/store FI references that cause issues, as it can be difficult
 757   // to materialize the offset if it won't fit in the literal field. Estimate
 758   // based on the size of the local frame and some conservative assumptions
 759   // about the rest of the stack frame (note, this is pre-regalloc, so
 760   // we don't know everything for certain yet) whether this offset is likely
 761   // to be out of range of the immediate. Return true if so.
 762
 763   // We only generate virtual base registers for loads and stores that have
 764   // an r+i form. Return false for everything else.
 765   unsigned OpC = MI->getOpcode();
 766   if (!ImmToIdxMap.count(OpC))
 767     return false;
 768
 769   // Don't generate a new virtual base register just to add zero to it.
 770   if ((OpC == PPC::ADDI || OpC == PPC::ADDI8) &&
 771       MI->getOperand(2).getImm() == 0)
 772     return false;
 773
 774   MachineBasicBlock &MBB = *MI->getParent();
 775   MachineFunction &MF = *MBB.getParent();
 776
 777   const PPCFrameLowering *PPCFI =
 778     static_cast<const PPCFrameLowering*>(MF.getTarget().getFrameLowering());
 779   unsigned StackEst =
 780     PPCFI->determineFrameLayout(MF, false, true);
 781
 782   // If we likely don't need a stack frame, then we probably don't need a
 783   // virtual base register either.
 784   if (!StackEst)
 785     return false;
 786
 787   // Estimate an offset from the stack pointer.
 788   // The incoming offset is relating to the SP at the start of the function,
 789   // but when we access the local it'll be relative to the SP after local
 790   // allocation, so adjust our SP-relative offset by that allocation size.
 791   Offset += StackEst;
 792
 793   // The frame pointer will point to the end of the stack, so estimate the
 794   // offset as the difference between the object offset and the FP location.
 795   return !isFrameOffsetLegal(MI, Offset);
 796 }
 797
 798 /// Insert defining instruction(s) for BaseReg to
 799 /// be a pointer to FrameIdx at the beginning of the basic block.
 800 void PPCRegisterInfo::
 801 materializeFrameBaseRegister(MachineBasicBlock *MBB,
 802                              unsigned BaseReg, int FrameIdx,
 803                              int64_t Offset) const {
 804   unsigned ADDriOpc = Subtarget.isPPC64() ? PPC::ADDI8 : PPC::ADDI;
 805
 806   MachineBasicBlock::iterator Ins = MBB->begin();
 807   DebugLoc DL;                  // Defaults to "unknown"
 808   if (Ins != MBB->end())
 809     DL = Ins->getDebugLoc();
 810
 811   const MachineFunction &MF = *MBB->getParent();
 812   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 813   const MCInstrDesc &MCID = TII.get(ADDriOpc);
 814   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
 815   MRI.constrainRegClass(BaseReg, TII.getRegClass(MCID, 0, this, MF));
 816
 817   BuildMI(*MBB, Ins, DL, MCID, BaseReg)
 818     .addFrameIndex(FrameIdx).addImm(Offset);
 819 }
 820
 821 void
 822 PPCRegisterInfo::resolveFrameIndex(MachineBasicBlock::iterator I,
 823                                    unsigned BaseReg, int64_t Offset) const {
 824   MachineInstr &MI = *I;
 825
 826   unsigned FIOperandNum = 0;
 827   while (!MI.getOperand(FIOperandNum).isFI()) {
 828     ++FIOperandNum;
 829     assert(FIOperandNum < MI.getNumOperands() &&
 830            "Instr doesn't have FrameIndex operand!");
 831   }
 832
 833   MI.getOperand(FIOperandNum).ChangeToRegister(BaseReg, false);
 834   unsigned OffsetOperandNo = getOffsetONFromFION(MI, FIOperandNum);
 835   Offset += MI.getOperand(OffsetOperandNo).getImm();
 836   MI.getOperand(OffsetOperandNo).ChangeToImmediate(Offset);
 837 }
 838
 839 bool PPCRegisterInfo::isFrameOffsetLegal(const MachineInstr *MI,
 840                                          int64_t Offset) const {
 841   return MI->getOpcode() == PPC::DBG_VALUE || // DBG_VALUE is always Reg+Imm
 842          (isInt<16>(Offset) && (!usesIXAddr(*MI) || (Offset & 3) == 0));
 843 }
 844