Have MachineFunction cache a pointer to the subtarget to make lookups
[oota-llvm.git] / lib / Target / SystemZ / SystemZFrameLowering.cpp
1 //===-- SystemZFrameLowering.cpp - Frame lowering for SystemZ -------------===//
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 #include "SystemZFrameLowering.h"
11 #include "SystemZCallingConv.h"
12 #include "SystemZInstrBuilder.h"
13 #include "SystemZInstrInfo.h"
14 #include "SystemZMachineFunctionInfo.h"
15 #include "SystemZRegisterInfo.h"
16 #include "SystemZSubtarget.h"
17 #include "llvm/CodeGen/MachineModuleInfo.h"
18 #include "llvm/CodeGen/MachineRegisterInfo.h"
19 #include "llvm/CodeGen/RegisterScavenging.h"
20 #include "llvm/IR/Function.h"
21
22 using namespace llvm;
23
24 namespace {
25 // The ABI-defined register save slots, relative to the incoming stack
26 // pointer.
27 static const TargetFrameLowering::SpillSlot SpillOffsetTable[] = {
28   { SystemZ::R2D,  0x10 },
29   { SystemZ::R3D,  0x18 },
30   { SystemZ::R4D,  0x20 },
31   { SystemZ::R5D,  0x28 },
32   { SystemZ::R6D,  0x30 },
33   { SystemZ::R7D,  0x38 },
34   { SystemZ::R8D,  0x40 },
35   { SystemZ::R9D,  0x48 },
36   { SystemZ::R10D, 0x50 },
37   { SystemZ::R11D, 0x58 },
38   { SystemZ::R12D, 0x60 },
39   { SystemZ::R13D, 0x68 },
40   { SystemZ::R14D, 0x70 },
41   { SystemZ::R15D, 0x78 },
42   { SystemZ::F0D,  0x80 },
43   { SystemZ::F2D,  0x88 },
44   { SystemZ::F4D,  0x90 },
45   { SystemZ::F6D,  0x98 }
46 };
47 } // end anonymous namespace
48
49 SystemZFrameLowering::SystemZFrameLowering()
50     : TargetFrameLowering(TargetFrameLowering::StackGrowsDown, 8,
51                           -SystemZMC::CallFrameSize, 8) {
52   // Create a mapping from register number to save slot offset.
53   RegSpillOffsets.grow(SystemZ::NUM_TARGET_REGS);
54   for (unsigned I = 0, E = array_lengthof(SpillOffsetTable); I != E; ++I)
55     RegSpillOffsets[SpillOffsetTable[I].Reg] = SpillOffsetTable[I].Offset;
56 }
57
58 const TargetFrameLowering::SpillSlot *
59 SystemZFrameLowering::getCalleeSavedSpillSlots(unsigned &NumEntries) const {
60   NumEntries = array_lengthof(SpillOffsetTable);
61   return SpillOffsetTable;
62 }
63
64 void SystemZFrameLowering::
65 processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
66                                      RegScavenger *RS) const {
67   MachineFrameInfo *MFFrame = MF.getFrameInfo();
68   MachineRegisterInfo &MRI = MF.getRegInfo();
69   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
70   bool HasFP = hasFP(MF);
71   SystemZMachineFunctionInfo *MFI = MF.getInfo<SystemZMachineFunctionInfo>();
72   bool IsVarArg = MF.getFunction()->isVarArg();
73
74   // va_start stores incoming FPR varargs in the normal way, but delegates
75   // the saving of incoming GPR varargs to spillCalleeSavedRegisters().
76   // Record these pending uses, which typically include the call-saved
77   // argument register R6D.
78   if (IsVarArg)
79     for (unsigned I = MFI->getVarArgsFirstGPR(); I < SystemZ::NumArgGPRs; ++I)
80       MRI.setPhysRegUsed(SystemZ::ArgGPRs[I]);
81
82   // If the function requires a frame pointer, record that the hard
83   // frame pointer will be clobbered.
84   if (HasFP)
85     MRI.setPhysRegUsed(SystemZ::R11D);
86
87   // If the function calls other functions, record that the return
88   // address register will be clobbered.
89   if (MFFrame->hasCalls())
90     MRI.setPhysRegUsed(SystemZ::R14D);
91
92   // If we are saving GPRs other than the stack pointer, we might as well
93   // save and restore the stack pointer at the same time, via STMG and LMG.
94   // This allows the deallocation to be done by the LMG, rather than needing
95   // a separate %r15 addition.
96   const MCPhysReg *CSRegs = TRI->getCalleeSavedRegs(&MF);
97   for (unsigned I = 0; CSRegs[I]; ++I) {
98     unsigned Reg = CSRegs[I];
99     if (SystemZ::GR64BitRegClass.contains(Reg) && MRI.isPhysRegUsed(Reg)) {
100       MRI.setPhysRegUsed(SystemZ::R15D);
101       break;
102     }
103   }
104 }
105
106 // Add GPR64 to the save instruction being built by MIB, which is in basic
107 // block MBB.  IsImplicit says whether this is an explicit operand to the
108 // instruction, or an implicit one that comes between the explicit start
109 // and end registers.
110 static void addSavedGPR(MachineBasicBlock &MBB, MachineInstrBuilder &MIB,
111                         unsigned GPR64, bool IsImplicit) {
112   const TargetRegisterInfo *RI =
113       MBB.getParent()->getSubtarget().getRegisterInfo();
114   unsigned GPR32 = RI->getSubReg(GPR64, SystemZ::subreg_l32);
115   bool IsLive = MBB.isLiveIn(GPR64) || MBB.isLiveIn(GPR32);
116   if (!IsLive || !IsImplicit) {
117     MIB.addReg(GPR64, getImplRegState(IsImplicit) | getKillRegState(!IsLive));
118     if (!IsLive)
119       MBB.addLiveIn(GPR64);
120   }
121 }
122
123 bool SystemZFrameLowering::
124 spillCalleeSavedRegisters(MachineBasicBlock &MBB,
125                           MachineBasicBlock::iterator MBBI,
126                           const std::vector<CalleeSavedInfo> &CSI,
127                           const TargetRegisterInfo *TRI) const {
128   if (CSI.empty())
129     return false;
130
131   MachineFunction &MF = *MBB.getParent();
132   const TargetInstrInfo *TII = MF.getSubtarget().getInstrInfo();
133   SystemZMachineFunctionInfo *ZFI = MF.getInfo<SystemZMachineFunctionInfo>();
134   bool IsVarArg = MF.getFunction()->isVarArg();
135   DebugLoc DL = MBBI != MBB.end() ? MBBI->getDebugLoc() : DebugLoc();
136
137   // Scan the call-saved GPRs and find the bounds of the register spill area.
138   unsigned LowGPR = 0;
139   unsigned HighGPR = SystemZ::R15D;
140   unsigned StartOffset = -1U;
141   for (unsigned I = 0, E = CSI.size(); I != E; ++I) {
142     unsigned Reg = CSI[I].getReg();
143     if (SystemZ::GR64BitRegClass.contains(Reg)) {
144       unsigned Offset = RegSpillOffsets[Reg];
145       assert(Offset && "Unexpected GPR save");
146       if (StartOffset > Offset) {
147         LowGPR = Reg;
148         StartOffset = Offset;
149       }
150     }
151   }
152
153   // Save the range of call-saved registers, for use by the epilogue inserter.
154   ZFI->setLowSavedGPR(LowGPR);
155   ZFI->setHighSavedGPR(HighGPR);
156
157   // Include the GPR varargs, if any.  R6D is call-saved, so would
158   // be included by the loop above, but we also need to handle the
159   // call-clobbered argument registers.
160   if (IsVarArg) {
161     unsigned FirstGPR = ZFI->getVarArgsFirstGPR();
162     if (FirstGPR < SystemZ::NumArgGPRs) {
163       unsigned Reg = SystemZ::ArgGPRs[FirstGPR];
164       unsigned Offset = RegSpillOffsets[Reg];
165       if (StartOffset > Offset) {
166         LowGPR = Reg; StartOffset = Offset;
167       }
168     }
169   }
170
171   // Save GPRs
172   if (LowGPR) {
173     assert(LowGPR != HighGPR && "Should be saving %r15 and something else");
174
175     // Build an STMG instruction.
176     MachineInstrBuilder MIB = BuildMI(MBB, MBBI, DL, TII->get(SystemZ::STMG));
177
178     // Add the explicit register operands.
179     addSavedGPR(MBB, MIB, LowGPR, false);
180     addSavedGPR(MBB, MIB, HighGPR, false);
181
182     // Add the address.
183     MIB.addReg(SystemZ::R15D).addImm(StartOffset);
184
185     // Make sure all call-saved GPRs are included as operands and are
186     // marked as live on entry.
187     for (unsigned I = 0, E = CSI.size(); I != E; ++I) {
188       unsigned Reg = CSI[I].getReg();
189       if (SystemZ::GR64BitRegClass.contains(Reg))
190         addSavedGPR(MBB, MIB, Reg, true);
191     }
192
193     // ...likewise GPR varargs.
194     if (IsVarArg)
195       for (unsigned I = ZFI->getVarArgsFirstGPR(); I < SystemZ::NumArgGPRs; ++I)
196         addSavedGPR(MBB, MIB, SystemZ::ArgGPRs[I], true);
197   }
198
199   // Save FPRs in the normal TargetInstrInfo way.
200   for (unsigned I = 0, E = CSI.size(); I != E; ++I) {
201     unsigned Reg = CSI[I].getReg();
202     if (SystemZ::FP64BitRegClass.contains(Reg)) {
203       MBB.addLiveIn(Reg);
204       TII->storeRegToStackSlot(MBB, MBBI, Reg, true, CSI[I].getFrameIdx(),
205                                &SystemZ::FP64BitRegClass, TRI);
206     }
207   }
208
209   return true;
210 }
211
212 bool SystemZFrameLowering::
213 restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
214                             MachineBasicBlock::iterator MBBI,
215                             const std::vector<CalleeSavedInfo> &CSI,
216                             const TargetRegisterInfo *TRI) const {
217   if (CSI.empty())
218     return false;
219
220   MachineFunction &MF = *MBB.getParent();
221   const TargetInstrInfo *TII = MF.getSubtarget().getInstrInfo();
222   SystemZMachineFunctionInfo *ZFI = MF.getInfo<SystemZMachineFunctionInfo>();
223   bool HasFP = hasFP(MF);
224   DebugLoc DL = MBBI != MBB.end() ? MBBI->getDebugLoc() : DebugLoc();
225
226   // Restore FPRs in the normal TargetInstrInfo way.
227   for (unsigned I = 0, E = CSI.size(); I != E; ++I) {
228     unsigned Reg = CSI[I].getReg();
229     if (SystemZ::FP64BitRegClass.contains(Reg))
230       TII->loadRegFromStackSlot(MBB, MBBI, Reg, CSI[I].getFrameIdx(),
231                                 &SystemZ::FP64BitRegClass, TRI);
232   }
233
234   // Restore call-saved GPRs (but not call-clobbered varargs, which at
235   // this point might hold return values).
236   unsigned LowGPR = ZFI->getLowSavedGPR();
237   unsigned HighGPR = ZFI->getHighSavedGPR();
238   unsigned StartOffset = RegSpillOffsets[LowGPR];
239   if (LowGPR) {
240     // If we saved any of %r2-%r5 as varargs, we should also be saving
241     // and restoring %r6.  If we're saving %r6 or above, we should be
242     // restoring it too.
243     assert(LowGPR != HighGPR && "Should be loading %r15 and something else");
244
245     // Build an LMG instruction.
246     MachineInstrBuilder MIB = BuildMI(MBB, MBBI, DL, TII->get(SystemZ::LMG));
247
248     // Add the explicit register operands.
249     MIB.addReg(LowGPR, RegState::Define);
250     MIB.addReg(HighGPR, RegState::Define);
251
252     // Add the address.
253     MIB.addReg(HasFP ? SystemZ::R11D : SystemZ::R15D);
254     MIB.addImm(StartOffset);
255
256     // Do a second scan adding regs as being defined by instruction
257     for (unsigned I = 0, E = CSI.size(); I != E; ++I) {
258       unsigned Reg = CSI[I].getReg();
259       if (Reg != LowGPR && Reg != HighGPR)
260         MIB.addReg(Reg, RegState::ImplicitDefine);
261     }
262   }
263
264   return true;
265 }
266
267 void SystemZFrameLowering::
268 processFunctionBeforeFrameFinalized(MachineFunction &MF,
269                                     RegScavenger *RS) const {
270   MachineFrameInfo *MFFrame = MF.getFrameInfo();
271   uint64_t MaxReach = (MFFrame->estimateStackSize(MF) +
272                        SystemZMC::CallFrameSize * 2);
273   if (!isUInt<12>(MaxReach)) {
274     // We may need register scavenging slots if some parts of the frame
275     // are outside the reach of an unsigned 12-bit displacement.
276     // Create 2 for the case where both addresses in an MVC are
277     // out of range.
278     RS->addScavengingFrameIndex(MFFrame->CreateStackObject(8, 8, false));
279     RS->addScavengingFrameIndex(MFFrame->CreateStackObject(8, 8, false));
280   }
281 }
282
283 // Emit instructions before MBBI (in MBB) to add NumBytes to Reg.
284 static void emitIncrement(MachineBasicBlock &MBB,
285                           MachineBasicBlock::iterator &MBBI,
286                           const DebugLoc &DL,
287                           unsigned Reg, int64_t NumBytes,
288                           const TargetInstrInfo *TII) {
289   while (NumBytes) {
290     unsigned Opcode;
291     int64_t ThisVal = NumBytes;
292     if (isInt<16>(NumBytes))
293       Opcode = SystemZ::AGHI;
294     else {
295       Opcode = SystemZ::AGFI;
296       // Make sure we maintain 8-byte stack alignment.
297       int64_t MinVal = -int64_t(1) << 31;
298       int64_t MaxVal = (int64_t(1) << 31) - 8;
299       if (ThisVal < MinVal)
300         ThisVal = MinVal;
301       else if (ThisVal > MaxVal)
302         ThisVal = MaxVal;
303     }
304     MachineInstr *MI = BuildMI(MBB, MBBI, DL, TII->get(Opcode), Reg)
305       .addReg(Reg).addImm(ThisVal);
306     // The CC implicit def is dead.
307     MI->getOperand(3).setIsDead();
308     NumBytes -= ThisVal;
309   }
310 }
311
312 void SystemZFrameLowering::emitPrologue(MachineFunction &MF) const {
313   MachineBasicBlock &MBB = MF.front();
314   MachineFrameInfo *MFFrame = MF.getFrameInfo();
315   auto *ZII =
316       static_cast<const SystemZInstrInfo *>(MF.getSubtarget().getInstrInfo());
317   SystemZMachineFunctionInfo *ZFI = MF.getInfo<SystemZMachineFunctionInfo>();
318   MachineBasicBlock::iterator MBBI = MBB.begin();
319   MachineModuleInfo &MMI = MF.getMMI();
320   const MCRegisterInfo *MRI = MMI.getContext().getRegisterInfo();
321   const std::vector<CalleeSavedInfo> &CSI = MFFrame->getCalleeSavedInfo();
322   bool HasFP = hasFP(MF);
323   DebugLoc DL = MBBI != MBB.end() ? MBBI->getDebugLoc() : DebugLoc();
324
325   // The current offset of the stack pointer from the CFA.
326   int64_t SPOffsetFromCFA = -SystemZMC::CFAOffsetFromInitialSP;
327
328   if (ZFI->getLowSavedGPR()) {
329     // Skip over the GPR saves.
330     if (MBBI != MBB.end() && MBBI->getOpcode() == SystemZ::STMG)
331       ++MBBI;
332     else
333       llvm_unreachable("Couldn't skip over GPR saves");
334
335     // Add CFI for the GPR saves.
336     for (auto &Save : CSI) {
337       unsigned Reg = Save.getReg();
338       if (SystemZ::GR64BitRegClass.contains(Reg)) {
339         int64_t Offset = SPOffsetFromCFA + RegSpillOffsets[Reg];
340         unsigned CFIIndex = MMI.addFrameInst(MCCFIInstruction::createOffset(
341             nullptr, MRI->getDwarfRegNum(Reg, true), Offset));
342         BuildMI(MBB, MBBI, DL, ZII->get(TargetOpcode::CFI_INSTRUCTION))
343             .addCFIIndex(CFIIndex);
344       }
345     }
346   }
347
348   uint64_t StackSize = getAllocatedStackSize(MF);
349   if (StackSize) {
350     // Allocate StackSize bytes.
351     int64_t Delta = -int64_t(StackSize);
352     emitIncrement(MBB, MBBI, DL, SystemZ::R15D, Delta, ZII);
353
354     // Add CFI for the allocation.
355     unsigned CFIIndex = MMI.addFrameInst(
356         MCCFIInstruction::createDefCfaOffset(nullptr, SPOffsetFromCFA + Delta));
357     BuildMI(MBB, MBBI, DL, ZII->get(TargetOpcode::CFI_INSTRUCTION))
358         .addCFIIndex(CFIIndex);
359     SPOffsetFromCFA += Delta;
360   }
361
362   if (HasFP) {
363     // Copy the base of the frame to R11.
364     BuildMI(MBB, MBBI, DL, ZII->get(SystemZ::LGR), SystemZ::R11D)
365       .addReg(SystemZ::R15D);
366
367     // Add CFI for the new frame location.
368     unsigned HardFP = MRI->getDwarfRegNum(SystemZ::R11D, true);
369     unsigned CFIIndex = MMI.addFrameInst(
370         MCCFIInstruction::createDefCfaRegister(nullptr, HardFP));
371     BuildMI(MBB, MBBI, DL, ZII->get(TargetOpcode::CFI_INSTRUCTION))
372         .addCFIIndex(CFIIndex);
373
374     // Mark the FramePtr as live at the beginning of every block except
375     // the entry block.  (We'll have marked R11 as live on entry when
376     // saving the GPRs.)
377     for (auto I = std::next(MF.begin()), E = MF.end(); I != E; ++I)
378       I->addLiveIn(SystemZ::R11D);
379   }
380
381   // Skip over the FPR saves.
382   SmallVector<unsigned, 8> CFIIndexes;
383   for (auto &Save : CSI) {
384     unsigned Reg = Save.getReg();
385     if (SystemZ::FP64BitRegClass.contains(Reg)) {
386       if (MBBI != MBB.end() &&
387           (MBBI->getOpcode() == SystemZ::STD ||
388            MBBI->getOpcode() == SystemZ::STDY))
389         ++MBBI;
390       else
391         llvm_unreachable("Couldn't skip over FPR save");
392
393       // Add CFI for the this save.
394       unsigned DwarfReg = MRI->getDwarfRegNum(Reg, true);
395       int64_t Offset = getFrameIndexOffset(MF, Save.getFrameIdx());
396       unsigned CFIIndex = MMI.addFrameInst(MCCFIInstruction::createOffset(
397           nullptr, DwarfReg, SPOffsetFromCFA + Offset));
398       CFIIndexes.push_back(CFIIndex);
399     }
400   }
401   // Complete the CFI for the FPR saves, modelling them as taking effect
402   // after the last save.
403   for (auto CFIIndex : CFIIndexes) {
404     BuildMI(MBB, MBBI, DL, ZII->get(TargetOpcode::CFI_INSTRUCTION))
405         .addCFIIndex(CFIIndex);
406   }
407 }
408
409 void SystemZFrameLowering::emitEpilogue(MachineFunction &MF,
410                                         MachineBasicBlock &MBB) const {
411   MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
412   auto *ZII =
413       static_cast<const SystemZInstrInfo *>(MF.getSubtarget().getInstrInfo());
414   SystemZMachineFunctionInfo *ZFI = MF.getInfo<SystemZMachineFunctionInfo>();
415
416   // Skip the return instruction.
417   assert(MBBI->isReturn() && "Can only insert epilogue into returning blocks");
418
419   uint64_t StackSize = getAllocatedStackSize(MF);
420   if (ZFI->getLowSavedGPR()) {
421     --MBBI;
422     unsigned Opcode = MBBI->getOpcode();
423     if (Opcode != SystemZ::LMG)
424       llvm_unreachable("Expected to see callee-save register restore code");
425
426     unsigned AddrOpNo = 2;
427     DebugLoc DL = MBBI->getDebugLoc();
428     uint64_t Offset = StackSize + MBBI->getOperand(AddrOpNo + 1).getImm();
429     unsigned NewOpcode = ZII->getOpcodeForOffset(Opcode, Offset);
430
431     // If the offset is too large, use the largest stack-aligned offset
432     // and add the rest to the base register (the stack or frame pointer).
433     if (!NewOpcode) {
434       uint64_t NumBytes = Offset - 0x7fff8;
435       emitIncrement(MBB, MBBI, DL, MBBI->getOperand(AddrOpNo).getReg(),
436                     NumBytes, ZII);
437       Offset -= NumBytes;
438       NewOpcode = ZII->getOpcodeForOffset(Opcode, Offset);
439       assert(NewOpcode && "No restore instruction available");
440     }
441
442     MBBI->setDesc(ZII->get(NewOpcode));
443     MBBI->getOperand(AddrOpNo + 1).ChangeToImmediate(Offset);
444   } else if (StackSize) {
445     DebugLoc DL = MBBI->getDebugLoc();
446     emitIncrement(MBB, MBBI, DL, SystemZ::R15D, StackSize, ZII);
447   }
448 }
449
450 bool SystemZFrameLowering::hasFP(const MachineFunction &MF) const {
451   return (MF.getTarget().Options.DisableFramePointerElim(MF) ||
452           MF.getFrameInfo()->hasVarSizedObjects() ||
453           MF.getInfo<SystemZMachineFunctionInfo>()->getManipulatesSP());
454 }
455
456 int SystemZFrameLowering::getFrameIndexOffset(const MachineFunction &MF,
457                                               int FI) const {
458   const MachineFrameInfo *MFFrame = MF.getFrameInfo();
459
460   // Start with the offset of FI from the top of the caller-allocated frame
461   // (i.e. the top of the 160 bytes allocated by the caller).  This initial
462   // offset is therefore negative.
463   int64_t Offset = (MFFrame->getObjectOffset(FI) +
464                     MFFrame->getOffsetAdjustment());
465
466   // Make the offset relative to the incoming stack pointer.
467   Offset -= getOffsetOfLocalArea();
468
469   // Make the offset relative to the bottom of the frame.
470   Offset += getAllocatedStackSize(MF);
471
472   return Offset;
473 }
474
475 uint64_t SystemZFrameLowering::
476 getAllocatedStackSize(const MachineFunction &MF) const {
477   const MachineFrameInfo *MFFrame = MF.getFrameInfo();
478
479   // Start with the size of the local variables and spill slots.
480   uint64_t StackSize = MFFrame->getStackSize();
481
482   // We need to allocate the ABI-defined 160-byte base area whenever
483   // we allocate stack space for our own use and whenever we call another
484   // function.
485   if (StackSize || MFFrame->hasVarSizedObjects() || MFFrame->hasCalls())
486     StackSize += SystemZMC::CallFrameSize;
487
488   return StackSize;
489 }
490
491 bool
492 SystemZFrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
493   // The ABI requires us to allocate 160 bytes of stack space for the callee,
494   // with any outgoing stack arguments being placed above that.  It seems
495   // better to make that area a permanent feature of the frame even if
496   // we're using a frame pointer.
497   return true;
498 }
499
500 void SystemZFrameLowering::
501 eliminateCallFramePseudoInstr(MachineFunction &MF,
502                               MachineBasicBlock &MBB,
503                               MachineBasicBlock::iterator MI) const {
504   switch (MI->getOpcode()) {
505   case SystemZ::ADJCALLSTACKDOWN:
506   case SystemZ::ADJCALLSTACKUP:
507     assert(hasReservedCallFrame(MF) &&
508            "ADJSTACKDOWN and ADJSTACKUP should be no-ops");
509     MBB.erase(MI);
510     break;
511
512   default:
513     llvm_unreachable("Unexpected call frame instruction");
514   }
515 }