1 //===- ARMTargetFrameLowering.h - Define frame lowering for ARM -*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_LIB_TARGET_ARM_ARMFRAMELOWERING_H
10 #define LLVM_LIB_TARGET_ARM_ARMFRAMELOWERING_H
11 
12 #include "llvm/CodeGen/MachineBasicBlock.h"
13 #include "llvm/CodeGen/TargetFrameLowering.h"
14 #include <vector>
15 
16 namespace llvm {
17 
18 class ARMSubtarget;
19 class CalleeSavedInfo;
20 class MachineFunction;
21 
22 class ARMFrameLowering : public TargetFrameLowering {
23 protected:
24   const ARMSubtarget &STI;
25 
26 public:
27   explicit ARMFrameLowering(const ARMSubtarget &sti);
28 
29   /// emitProlog/emitEpilog - These methods insert prolog and epilog code into
30   /// the function.
31   void emitPrologue(MachineFunction &MF, MachineBasicBlock &MBB) const override;
32   void emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const override;
33 
34   bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
35                                  MachineBasicBlock::iterator MI,
36                                  ArrayRef<CalleeSavedInfo> CSI,
37                                  const TargetRegisterInfo *TRI) const override;
38 
39   bool
40   restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
41                               MachineBasicBlock::iterator MI,
42                               MutableArrayRef<CalleeSavedInfo> CSI,
43                               const TargetRegisterInfo *TRI) const override;
44 
45   bool keepFramePointer(const MachineFunction &MF) const override;
46 
47   bool enableCalleeSaveSkip(const MachineFunction &MF) const override;
48 
49   bool hasFP(const MachineFunction &MF) const override;
50   bool hasReservedCallFrame(const MachineFunction &MF) const override;
51   bool canSimplifyCallFramePseudos(const MachineFunction &MF) const override;
52   int getFrameIndexReference(const MachineFunction &MF, int FI,
53                              Register &FrameReg) const override;
54   int ResolveFrameIndexReference(const MachineFunction &MF, int FI,
55                                  Register &FrameReg, int SPAdj) const;
56 
57   void getCalleeSaves(const MachineFunction &MF,
58                       BitVector &SavedRegs) const override;
59   void determineCalleeSaves(MachineFunction &MF, BitVector &SavedRegs,
60                             RegScavenger *RS) const override;
61 
62   void adjustForSegmentedStacks(MachineFunction &MF,
63                                 MachineBasicBlock &MBB) const override;
64 
65   /// Returns true if the target will correctly handle shrink wrapping.
66   bool enableShrinkWrapping(const MachineFunction &MF) const override {
67     return true;
68   }
69   bool isProfitableForNoCSROpt(const Function &F) const override {
70     // The no-CSR optimisation is bad for code size on ARM, because we can save
71     // many registers with a single PUSH/POP pair.
72     return false;
73   }
74 
75 private:
76   void emitPushInst(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
77                     ArrayRef<CalleeSavedInfo> CSI, unsigned StmOpc,
78                     unsigned StrOpc, bool NoGap, bool (*Func)(unsigned, bool),
79                     unsigned NumAlignedDPRCS2Regs, unsigned MIFlags = 0) const;
80   void emitPopInst(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
81                    MutableArrayRef<CalleeSavedInfo> CSI, unsigned LdmOpc,
82                    unsigned LdrOpc, bool isVarArg, bool NoGap,
83                    bool (*Func)(unsigned, bool),
84                    unsigned NumAlignedDPRCS2Regs) const;
85 
86   MachineBasicBlock::iterator
87   eliminateCallFramePseudoInstr(MachineFunction &MF,
88                                 MachineBasicBlock &MBB,
89                                 MachineBasicBlock::iterator MI) const override;
90 };
91 
92 } // end namespace llvm
93 
94 #endif // LLVM_LIB_TARGET_ARM_ARMFRAMELOWERING_H
95