lib/Target/ARM/Thumb1FrameLowering.cpp

   1 //===-- Thumb1FrameLowering.cpp - Thumb1 Frame 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 Thumb1 implementation of TargetFrameLowering class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "Thumb1FrameLowering.h"
  15 #include "ARMMachineFunctionInfo.h"
  16 #include "llvm/CodeGen/MachineFrameInfo.h"
  17 #include "llvm/CodeGen/MachineFunction.h"
  18 #include "llvm/CodeGen/MachineInstrBuilder.h"
  19 #include "llvm/CodeGen/MachineModuleInfo.h"
  20 #include "llvm/CodeGen/MachineRegisterInfo.h"
  21
  22 using namespace llvm;
  23
  24 bool Thumb1FrameLowering::hasReservedCallFrame(const MachineFunction &MF) const{
  25   const MachineFrameInfo *FFI = MF.getFrameInfo();
  26   unsigned CFSize = FFI->getMaxCallFrameSize();
  27   // It's not always a good idea to include the call frame as part of the
  28   // stack frame. ARM (especially Thumb) has small immediate offset to
  29   // address the stack frame. So a large call frame can cause poor codegen
  30   // and may even makes it impossible to scavenge a register.
  31   if (CFSize >= ((1 << 8) - 1) * 4 / 2) // Half of imm8 * 4
  32     return false;
  33
  34   return !MF.getFrameInfo()->hasVarSizedObjects();
  35 }
  36
  37 static void
  38 emitSPUpdate(MachineBasicBlock &MBB,
  39              MachineBasicBlock::iterator &MBBI,
  40              const TargetInstrInfo &TII, DebugLoc dl,
  41              const Thumb1RegisterInfo &MRI,
  42              int NumBytes, unsigned MIFlags = MachineInstr::NoFlags)  {
  43   emitThumbRegPlusImmediate(MBB, MBBI, dl, ARM::SP, ARM::SP, NumBytes, TII,
  44                             MRI, MIFlags);
  45 }
  46
  47
  48 void Thumb1FrameLowering::
  49 eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB,
  50                               MachineBasicBlock::iterator I) const {
  51   const Thumb1InstrInfo &TII =
  52     *static_cast<const Thumb1InstrInfo*>(MF.getTarget().getInstrInfo());
  53   const Thumb1RegisterInfo *RegInfo =
  54     static_cast<const Thumb1RegisterInfo*>(MF.getTarget().getRegisterInfo());
  55   if (!hasReservedCallFrame(MF)) {
  56     // If we have alloca, convert as follows:
  57     // ADJCALLSTACKDOWN -> sub, sp, sp, amount
  58     // ADJCALLSTACKUP   -> add, sp, sp, amount
  59     MachineInstr *Old = I;
  60     DebugLoc dl = Old->getDebugLoc();
  61     unsigned Amount = Old->getOperand(0).getImm();
  62     if (Amount != 0) {
  63       // We need to keep the stack aligned properly.  To do this, we round the
  64       // amount of space needed for the outgoing arguments up to the next
  65       // alignment boundary.
  66       unsigned Align = getStackAlignment();
  67       Amount = (Amount+Align-1)/Align*Align;
  68
  69       // Replace the pseudo instruction with a new instruction...
  70       unsigned Opc = Old->getOpcode();
  71       if (Opc == ARM::ADJCALLSTACKDOWN || Opc == ARM::tADJCALLSTACKDOWN) {
  72         emitSPUpdate(MBB, I, TII, dl, *RegInfo, -Amount);
  73       } else {
  74         assert(Opc == ARM::ADJCALLSTACKUP || Opc == ARM::tADJCALLSTACKUP);
  75         emitSPUpdate(MBB, I, TII, dl, *RegInfo, Amount);
  76       }
  77     }
  78   }
  79   MBB.erase(I);
  80 }
  81
  82 void Thumb1FrameLowering::emitPrologue(MachineFunction &MF) const {
  83   MachineBasicBlock &MBB = MF.front();
  84   MachineBasicBlock::iterator MBBI = MBB.begin();
  85   MachineFrameInfo  *MFI = MF.getFrameInfo();
  86   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
  87   MachineModuleInfo &MMI = MF.getMMI();
  88   const MCRegisterInfo *MRI = MMI.getContext().getRegisterInfo();
  89   const Thumb1RegisterInfo *RegInfo =
  90     static_cast<const Thumb1RegisterInfo*>(MF.getTarget().getRegisterInfo());
  91   const Thumb1InstrInfo &TII =
  92     *static_cast<const Thumb1InstrInfo*>(MF.getTarget().getInstrInfo());
  93
  94   unsigned Align = MF.getTarget().getFrameLowering()->getStackAlignment();
  95   unsigned ArgRegsSaveSize = AFI->getArgRegsSaveSize(Align);
  96   unsigned NumBytes = MFI->getStackSize();
  97   assert(NumBytes >= ArgRegsSaveSize &&
  98          "ArgRegsSaveSize is included in NumBytes");
  99   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
 100   DebugLoc dl = MBBI != MBB.end() ? MBBI->getDebugLoc() : DebugLoc();
 101   unsigned FramePtr = RegInfo->getFrameRegister(MF);
 102   unsigned BasePtr = RegInfo->getBaseRegister();
 103   int CFAOffset = 0;
 104
 105   // Thumb add/sub sp, imm8 instructions implicitly multiply the offset by 4.
 106   NumBytes = (NumBytes + 3) & ~3;
 107   MFI->setStackSize(NumBytes);
 108
 109   // Determine the sizes of each callee-save spill areas and record which frame
 110   // belongs to which callee-save spill areas.
 111   unsigned GPRCS1Size = 0, GPRCS2Size = 0, DPRCSSize = 0;
 112   int FramePtrSpillFI = 0;
 113
 114   if (ArgRegsSaveSize) {
 115     emitSPUpdate(MBB, MBBI, TII, dl, *RegInfo, -ArgRegsSaveSize,
 116                  MachineInstr::FrameSetup);
 117     MCSymbol *SPLabel = MMI.getContext().CreateTempSymbol();
 118     BuildMI(MBB, MBBI, dl, TII.get(TargetOpcode::PROLOG_LABEL))
 119         .addSym(SPLabel);
 120     CFAOffset -= ArgRegsSaveSize;
 121     MMI.addFrameInst(
 122         MCCFIInstruction::createDefCfaOffset(SPLabel, CFAOffset));
 123   }
 124
 125   if (!AFI->hasStackFrame()) {
 126     if (NumBytes - ArgRegsSaveSize != 0) {
 127       emitSPUpdate(MBB, MBBI, TII, dl, *RegInfo, -(NumBytes - ArgRegsSaveSize),
 128                    MachineInstr::FrameSetup);
 129       MCSymbol *SPLabel = MMI.getContext().CreateTempSymbol();
 130       BuildMI(MBB, MBBI, dl, TII.get(TargetOpcode::PROLOG_LABEL))
 131           .addSym(SPLabel);
 132       CFAOffset -= NumBytes - ArgRegsSaveSize;
 133       MMI.addFrameInst(
 134           MCCFIInstruction::createDefCfaOffset(SPLabel, CFAOffset));
 135     }
 136     return;
 137   }
 138
 139   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
 140     unsigned Reg = CSI[i].getReg();
 141     int FI = CSI[i].getFrameIdx();
 142     switch (Reg) {
 143     case ARM::R8:
 144     case ARM::R9:
 145     case ARM::R10:
 146     case ARM::R11:
 147       if (STI.isTargetMachO()) {
 148         GPRCS2Size += 4;
 149         break;
 150       }
 151       // fallthrough
 152     case ARM::R4:
 153     case ARM::R5:
 154     case ARM::R6:
 155     case ARM::R7:
 156     case ARM::LR:
 157       if (Reg == FramePtr)
 158         FramePtrSpillFI = FI;
 159       GPRCS1Size += 4;
 160       break;
 161     default:
 162       DPRCSSize += 8;
 163     }
 164   }
 165
 166   if (MBBI != MBB.end() && MBBI->getOpcode() == ARM::tPUSH) {
 167     ++MBBI;
 168     if (MBBI != MBB.end())
 169       dl = MBBI->getDebugLoc();
 170   }
 171
 172   // Determine starting offsets of spill areas.
 173   unsigned DPRCSOffset  = NumBytes - ArgRegsSaveSize - (GPRCS1Size + GPRCS2Size + DPRCSSize);
 174   unsigned GPRCS2Offset = DPRCSOffset + DPRCSSize;
 175   unsigned GPRCS1Offset = GPRCS2Offset + GPRCS2Size;
 176   bool HasFP = hasFP(MF);
 177   if (HasFP)
 178     AFI->setFramePtrSpillOffset(MFI->getObjectOffset(FramePtrSpillFI) +
 179                                 NumBytes);
 180   AFI->setGPRCalleeSavedArea1Offset(GPRCS1Offset);
 181   AFI->setGPRCalleeSavedArea2Offset(GPRCS2Offset);
 182   AFI->setDPRCalleeSavedAreaOffset(DPRCSOffset);
 183   NumBytes = DPRCSOffset;
 184
 185   int FramePtrOffsetInBlock = 0;
 186   unsigned adjustedGPRCS1Size = GPRCS1Size;
 187   if (tryFoldSPUpdateIntoPushPop(STI, MF, std::prev(MBBI), NumBytes)) {
 188     FramePtrOffsetInBlock = NumBytes;
 189     adjustedGPRCS1Size += NumBytes;
 190     NumBytes = 0;
 191   }
 192
 193   MCSymbol *SPLabel = MMI.getContext().CreateTempSymbol();
 194   BuildMI(MBB, MBBI, dl, TII.get(TargetOpcode::PROLOG_LABEL)).addSym(SPLabel);
 195   if (adjustedGPRCS1Size) {
 196     CFAOffset -= adjustedGPRCS1Size;
 197     MMI.addFrameInst(
 198         MCCFIInstruction::createDefCfaOffset(SPLabel, CFAOffset));
 199   }
 200   for (std::vector<CalleeSavedInfo>::const_iterator I = CSI.begin(),
 201          E = CSI.end(); I != E; ++I) {
 202     unsigned Reg = I->getReg();
 203     int FI = I->getFrameIdx();
 204     switch (Reg) {
 205     case ARM::R8:
 206     case ARM::R9:
 207     case ARM::R10:
 208     case ARM::R11:
 209     case ARM::R12:
 210       if (STI.isTargetMachO())
 211         break;
 212       // fallthough
 213     case ARM::R0:
 214     case ARM::R1:
 215     case ARM::R2:
 216     case ARM::R3:
 217     case ARM::R4:
 218     case ARM::R5:
 219     case ARM::R6:
 220     case ARM::R7:
 221     case ARM::LR:
 222       MMI.addFrameInst(MCCFIInstruction::createOffset(SPLabel,
 223          MRI->getDwarfRegNum(Reg, true),
 224          MFI->getObjectOffset(FI)));
 225       break;
 226     }
 227   }
 228
 229
 230   // Adjust FP so it point to the stack slot that contains the previous FP.
 231   if (HasFP) {
 232     FramePtrOffsetInBlock += MFI->getObjectOffset(FramePtrSpillFI)
 233                                      + GPRCS1Size + ArgRegsSaveSize;
 234     AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tADDrSPi), FramePtr)
 235       .addReg(ARM::SP).addImm(FramePtrOffsetInBlock / 4)
 236       .setMIFlags(MachineInstr::FrameSetup));
 237     MCSymbol *SPLabel = MMI.getContext().CreateTempSymbol();
 238     BuildMI(MBB, MBBI, dl, TII.get(TargetOpcode::PROLOG_LABEL))
 239         .addSym(SPLabel);
 240     if(FramePtrOffsetInBlock) {
 241       CFAOffset += FramePtrOffsetInBlock;
 242       MMI.addFrameInst(
 243           MCCFIInstruction::createDefCfa(SPLabel,
 244               MRI->getDwarfRegNum(FramePtr, true), CFAOffset));
 245     } else
 246       MMI.addFrameInst(
 247           MCCFIInstruction::createDefCfaRegister(SPLabel,
 248               MRI->getDwarfRegNum(FramePtr, true)));
 249     if (NumBytes > 508)
 250       // If offset is > 508 then sp cannot be adjusted in a single instruction,
 251       // try restoring from fp instead.
 252       AFI->setShouldRestoreSPFromFP(true);
 253   }
 254
 255   if (NumBytes) {
 256     // Insert it after all the callee-save spills.
 257     emitSPUpdate(MBB, MBBI, TII, dl, *RegInfo, -NumBytes,
 258                  MachineInstr::FrameSetup);
 259     if (!HasFP) {
 260       MCSymbol *SPLabel = MMI.getContext().CreateTempSymbol();
 261       BuildMI(MBB, MBBI, dl, TII.get(TargetOpcode::PROLOG_LABEL))
 262           .addSym(SPLabel);
 263       CFAOffset -= NumBytes;
 264       MMI.addFrameInst(
 265           MCCFIInstruction::createDefCfaOffset(SPLabel, CFAOffset));
 266     }
 267   }
 268
 269   if (STI.isTargetELF() && HasFP)
 270     MFI->setOffsetAdjustment(MFI->getOffsetAdjustment() -
 271                              AFI->getFramePtrSpillOffset());
 272
 273   AFI->setGPRCalleeSavedArea1Size(GPRCS1Size);
 274   AFI->setGPRCalleeSavedArea2Size(GPRCS2Size);
 275   AFI->setDPRCalleeSavedAreaSize(DPRCSSize);
 276
 277   // Thumb1 does not currently support dynamic stack realignment.  Report a
 278   // fatal error rather then silently generate bad code.
 279   if (RegInfo->needsStackRealignment(MF))
 280       report_fatal_error("Dynamic stack realignment not supported for thumb1.");
 281
 282   // If we need a base pointer, set it up here. It's whatever the value
 283   // of the stack pointer is at this point. Any variable size objects
 284   // will be allocated after this, so we can still use the base pointer
 285   // to reference locals.
 286   if (RegInfo->hasBasePointer(MF))
 287     AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tMOVr), BasePtr)
 288                    .addReg(ARM::SP));
 289
 290   // If the frame has variable sized objects then the epilogue must restore
 291   // the sp from fp. We can assume there's an FP here since hasFP already
 292   // checks for hasVarSizedObjects.
 293   if (MFI->hasVarSizedObjects())
 294     AFI->setShouldRestoreSPFromFP(true);
 295 }
 296
 297 static bool isCSRestore(MachineInstr *MI, const uint16_t *CSRegs) {
 298   if (MI->getOpcode() == ARM::tLDRspi &&
 299       MI->getOperand(1).isFI() &&
 300       isCalleeSavedRegister(MI->getOperand(0).getReg(), CSRegs))
 301     return true;
 302   else if (MI->getOpcode() == ARM::tPOP) {
 303     // The first two operands are predicates. The last two are
 304     // imp-def and imp-use of SP. Check everything in between.
 305     for (int i = 2, e = MI->getNumOperands() - 2; i != e; ++i)
 306       if (!isCalleeSavedRegister(MI->getOperand(i).getReg(), CSRegs))
 307         return false;
 308     return true;
 309   }
 310   return false;
 311 }
 312
 313 void Thumb1FrameLowering::emitEpilogue(MachineFunction &MF,
 314                                    MachineBasicBlock &MBB) const {
 315   MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
 316   assert((MBBI->getOpcode() == ARM::tBX_RET ||
 317           MBBI->getOpcode() == ARM::tPOP_RET) &&
 318          "Can only insert epilog into returning blocks");
 319   DebugLoc dl = MBBI->getDebugLoc();
 320   MachineFrameInfo *MFI = MF.getFrameInfo();
 321   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
 322   const Thumb1RegisterInfo *RegInfo =
 323     static_cast<const Thumb1RegisterInfo*>(MF.getTarget().getRegisterInfo());
 324   const Thumb1InstrInfo &TII =
 325     *static_cast<const Thumb1InstrInfo*>(MF.getTarget().getInstrInfo());
 326
 327   unsigned Align = MF.getTarget().getFrameLowering()->getStackAlignment();
 328   unsigned ArgRegsSaveSize = AFI->getArgRegsSaveSize(Align);
 329   int NumBytes = (int)MFI->getStackSize();
 330   assert(NumBytes >= ArgRegsSaveSize &&
 331          "ArgRegsSaveSize is included in NumBytes");
 332   const uint16_t *CSRegs = RegInfo->getCalleeSavedRegs();
 333   unsigned FramePtr = RegInfo->getFrameRegister(MF);
 334
 335   if (!AFI->hasStackFrame()) {
 336     if (NumBytes - ArgRegsSaveSize != 0)
 337       emitSPUpdate(MBB, MBBI, TII, dl, *RegInfo, NumBytes - ArgRegsSaveSize);
 338   } else {
 339     // Unwind MBBI to point to first LDR / VLDRD.
 340     if (MBBI != MBB.begin()) {
 341       do
 342         --MBBI;
 343       while (MBBI != MBB.begin() && isCSRestore(MBBI, CSRegs));
 344       if (!isCSRestore(MBBI, CSRegs))
 345         ++MBBI;
 346     }
 347
 348     // Move SP to start of FP callee save spill area.
 349     NumBytes -= (AFI->getGPRCalleeSavedArea1Size() +
 350                  AFI->getGPRCalleeSavedArea2Size() +
 351                  AFI->getDPRCalleeSavedAreaSize() +
 352                  ArgRegsSaveSize);
 353
 354     if (AFI->shouldRestoreSPFromFP()) {
 355       NumBytes = AFI->getFramePtrSpillOffset() - NumBytes;
 356       // Reset SP based on frame pointer only if the stack frame extends beyond
 357       // frame pointer stack slot, the target is ELF and the function has FP, or
 358       // the target uses var sized objects.
 359       if (NumBytes) {
 360         assert(MF.getRegInfo().isPhysRegUsed(ARM::R4) &&
 361                "No scratch register to restore SP from FP!");
 362         emitThumbRegPlusImmediate(MBB, MBBI, dl, ARM::R4, FramePtr, -NumBytes,
 363                                   TII, *RegInfo);
 364         AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tMOVr),
 365                                ARM::SP)
 366           .addReg(ARM::R4));
 367       } else
 368         AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tMOVr),
 369                                ARM::SP)
 370           .addReg(FramePtr));
 371     } else {
 372       if (MBBI->getOpcode() == ARM::tBX_RET &&
 373           &MBB.front() != MBBI &&
 374           std::prev(MBBI)->getOpcode() == ARM::tPOP) {
 375         MachineBasicBlock::iterator PMBBI = std::prev(MBBI);
 376         if (!tryFoldSPUpdateIntoPushPop(STI, MF, PMBBI, NumBytes))
 377           emitSPUpdate(MBB, PMBBI, TII, dl, *RegInfo, NumBytes);
 378       } else if (!tryFoldSPUpdateIntoPushPop(STI, MF, MBBI, NumBytes))
 379         emitSPUpdate(MBB, MBBI, TII, dl, *RegInfo, NumBytes);
 380     }
 381   }
 382
 383   if (ArgRegsSaveSize) {
 384     // Unlike T2 and ARM mode, the T1 pop instruction cannot restore
 385     // to LR, and we can't pop the value directly to the PC since
 386     // we need to update the SP after popping the value. Therefore, we
 387     // pop the old LR into R3 as a temporary.
 388
 389     // Get the last instruction, tBX_RET
 390     MBBI = MBB.getLastNonDebugInstr();
 391     assert (MBBI->getOpcode() == ARM::tBX_RET);
 392     // Epilogue for vararg functions: pop LR to R3 and branch off it.
 393     AddDefaultPred(BuildMI(MBB, MBBI, dl, TII.get(ARM::tPOP)))
 394       .addReg(ARM::R3, RegState::Define);
 395
 396     emitSPUpdate(MBB, MBBI, TII, dl, *RegInfo, ArgRegsSaveSize);
 397
 398     MachineInstrBuilder MIB =
 399       BuildMI(MBB, MBBI, dl, TII.get(ARM::tBX_RET_vararg))
 400       .addReg(ARM::R3, RegState::Kill);
 401     AddDefaultPred(MIB);
 402     MIB.copyImplicitOps(&*MBBI);
 403     // erase the old tBX_RET instruction
 404     MBB.erase(MBBI);
 405   }
 406 }
 407
 408 bool Thumb1FrameLowering::
 409 spillCalleeSavedRegisters(MachineBasicBlock &MBB,
 410                           MachineBasicBlock::iterator MI,
 411                           const std::vector<CalleeSavedInfo> &CSI,
 412                           const TargetRegisterInfo *TRI) const {
 413   if (CSI.empty())
 414     return false;
 415
 416   DebugLoc DL;
 417   MachineFunction &MF = *MBB.getParent();
 418   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 419
 420   if (MI != MBB.end()) DL = MI->getDebugLoc();
 421
 422   MachineInstrBuilder MIB = BuildMI(MBB, MI, DL, TII.get(ARM::tPUSH));
 423   AddDefaultPred(MIB);
 424   for (unsigned i = CSI.size(); i != 0; --i) {
 425     unsigned Reg = CSI[i-1].getReg();
 426     bool isKill = true;
 427
 428     // Add the callee-saved register as live-in unless it's LR and
 429     // @llvm.returnaddress is called. If LR is returned for @llvm.returnaddress
 430     // then it's already added to the function and entry block live-in sets.
 431     if (Reg == ARM::LR) {
 432       MachineFunction &MF = *MBB.getParent();
 433       if (MF.getFrameInfo()->isReturnAddressTaken() &&
 434           MF.getRegInfo().isLiveIn(Reg))
 435         isKill = false;
 436     }
 437
 438     if (isKill)
 439       MBB.addLiveIn(Reg);
 440
 441     MIB.addReg(Reg, getKillRegState(isKill));
 442   }
 443   MIB.setMIFlags(MachineInstr::FrameSetup);
 444   return true;
 445 }
 446
 447 bool Thumb1FrameLowering::
 448 restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
 449                             MachineBasicBlock::iterator MI,
 450                             const std::vector<CalleeSavedInfo> &CSI,
 451                             const TargetRegisterInfo *TRI) const {
 452   if (CSI.empty())
 453     return false;
 454
 455   MachineFunction &MF = *MBB.getParent();
 456   ARMFunctionInfo *AFI = MF.getInfo<ARMFunctionInfo>();
 457   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 458
 459   bool isVarArg = AFI->getArgRegsSaveSize() > 0;
 460   DebugLoc DL = MI->getDebugLoc();
 461   MachineInstrBuilder MIB = BuildMI(MF, DL, TII.get(ARM::tPOP));
 462   AddDefaultPred(MIB);
 463
 464   bool NumRegs = false;
 465   for (unsigned i = CSI.size(); i != 0; --i) {
 466     unsigned Reg = CSI[i-1].getReg();
 467     if (Reg == ARM::LR) {
 468       // Special epilogue for vararg functions. See emitEpilogue
 469       if (isVarArg)
 470         continue;
 471       Reg = ARM::PC;
 472       (*MIB).setDesc(TII.get(ARM::tPOP_RET));
 473       MIB.copyImplicitOps(&*MI);
 474       MI = MBB.erase(MI);
 475     }
 476     MIB.addReg(Reg, getDefRegState(true));
 477     NumRegs = true;
 478   }
 479
 480   // It's illegal to emit pop instruction without operands.
 481   if (NumRegs)
 482     MBB.insert(MI, &*MIB);
 483   else
 484     MF.DeleteMachineInstr(MIB);
 485
 486   return true;
 487 }