LLVM  15.0.0git
AArch64FrameLowering.h
Go to the documentation of this file.
1 //==-- AArch64FrameLowering.h - TargetFrameLowering for AArch64 --*- 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 //
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_LIB_TARGET_AARCH64_AARCH64FRAMELOWERING_H
14 #define LLVM_LIB_TARGET_AARCH64_AARCH64FRAMELOWERING_H
15 
16 #include "llvm/Support/TypeSize.h"
18 
19 namespace llvm {
20 
21 class MCCFIInstruction;
22 
24 public:
27  true /*StackRealignable*/) {}
28 
31 
32  void resetCFIToInitialState(MachineBasicBlock &MBB) const override;
33 
36  MachineBasicBlock::iterator I) const override;
37 
38  /// emitProlog/emitEpilog - These methods insert prolog and epilog code into
39  /// the function.
40  void emitPrologue(MachineFunction &MF, MachineBasicBlock &MBB) const override;
41  void emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const override;
42 
43  bool canUseAsPrologue(const MachineBasicBlock &MBB) const override;
44 
46  Register &FrameReg) const override;
48  Register &FrameReg, bool PreferFP,
49  bool ForSimm) const;
51  int64_t ObjectOffset, bool isFixed,
52  bool isSVE, Register &FrameReg,
53  bool PreferFP, bool ForSimm) const;
57  const TargetRegisterInfo *TRI) const override;
58 
59  bool
63  const TargetRegisterInfo *TRI) const override;
64 
65  /// Can this function use the red zone for local allocations.
66  bool canUseRedZone(const MachineFunction &MF) const;
67 
68  bool hasFP(const MachineFunction &MF) const override;
69  bool hasReservedCallFrame(const MachineFunction &MF) const override;
70 
72  const TargetRegisterInfo *TRI,
73  std::vector<CalleeSavedInfo> &CSI,
74  unsigned &MinCSFrameIndex,
75  unsigned &MaxCSFrameIndex) const override;
76 
77  void determineCalleeSaves(MachineFunction &MF, BitVector &SavedRegs,
78  RegScavenger *RS) const override;
79 
80  /// Returns true if the target will correctly handle shrink wrapping.
81  bool enableShrinkWrapping(const MachineFunction &MF) const override {
82  return true;
83  }
84 
85  bool enableStackSlotScavenging(const MachineFunction &MF) const override;
87 
89  RegScavenger *RS) const override;
90 
91  void
93  RegScavenger *RS) const override;
94 
95  unsigned getWinEHParentFrameOffset(const MachineFunction &MF) const override;
96 
97  unsigned getWinEHFuncletFrameSize(const MachineFunction &MF) const;
98 
101  Register &FrameReg,
102  bool IgnoreSPUpdates) const override;
104  int FI) const override;
105  int getSEHFrameIndexOffset(const MachineFunction &MF, int FI) const;
106 
108  switch (ID) {
109  default:
110  return false;
114  return true;
115  }
116  }
117 
118  bool isStackIdSafeForLocalArea(unsigned StackId) const override {
119  // We don't support putting SVE objects into the pre-allocated local
120  // frame block at the moment.
121  return StackId != TargetStackID::ScalableVector;
122  }
123 
124  void
126  SmallVectorImpl<int> &ObjectsToAllocate) const override;
127 
128 private:
129  /// Returns true if a homogeneous prolog or epilog code can be emitted
130  /// for the size optimization. If so, HOM_Prolog/HOM_Epilog pseudo
131  /// instructions are emitted in place. When Exit block is given, this check is
132  /// for epilog.
133  bool homogeneousPrologEpilog(MachineFunction &MF,
134  MachineBasicBlock *Exit = nullptr) const;
135 
136  /// Returns true if CSRs should be paired.
137  bool producePairRegisters(MachineFunction &MF) const;
138 
139  bool shouldCombineCSRLocalStackBump(MachineFunction &MF,
140  uint64_t StackBumpBytes) const;
141 
142  int64_t estimateSVEStackObjectOffsets(MachineFrameInfo &MF) const;
143  int64_t assignSVEStackObjectOffsets(MachineFrameInfo &MF,
144  int &MinCSFrameIndex,
145  int &MaxCSFrameIndex) const;
146  bool shouldCombineCSRLocalStackBumpInEpilogue(MachineBasicBlock &MBB,
147  unsigned StackBumpBytes) const;
148  void emitCalleeSavedGPRLocations(MachineBasicBlock &MBB,
150  void emitCalleeSavedSVELocations(MachineBasicBlock &MBB,
152  void emitCalleeSavedGPRRestores(MachineBasicBlock &MBB,
154  void emitCalleeSavedSVERestores(MachineBasicBlock &MBB,
156 
157  /// Emit target zero call-used regs.
158  void emitZeroCallUsedRegs(BitVector RegsToZero,
159  MachineBasicBlock &MBB) const override;
160 };
161 
162 } // End llvm namespace
163 
164 #endif
MI
IRTranslator LLVM IR MI
Definition: IRTranslator.cpp:104
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:17
TargetFrameLowering.h
llvm::TargetFrameLowering
Information about stack frame layout on the target.
Definition: TargetFrameLowering.h:43
llvm::AArch64FrameLowering::emitCalleeSavedFrameMoves
void emitCalleeSavedFrameMoves(MachineBasicBlock &MBB, MachineBasicBlock::iterator MBBI) const
Definition: AArch64FrameLowering.cpp:578
TypeSize.h
llvm::TargetRegisterInfo
TargetRegisterInfo base class - We assume that the target defines a static array of TargetRegisterDes...
Definition: TargetRegisterInfo.h:234
true
basic Basic Alias true
Definition: BasicAliasAnalysis.cpp:1909
llvm::AArch64FrameLowering::enableStackSlotScavenging
bool enableStackSlotScavenging(const MachineFunction &MF) const override
Returns true if the stack slot holes in the fixed and callee-save stack area should be used when allo...
Definition: AArch64FrameLowering.cpp:3164
llvm::AArch64FrameLowering::assignCalleeSavedSpillSlots
bool assignCalleeSavedSpillSlots(MachineFunction &MF, const TargetRegisterInfo *TRI, std::vector< CalleeSavedInfo > &CSI, unsigned &MinCSFrameIndex, unsigned &MaxCSFrameIndex) const override
assignCalleeSavedSpillSlots - Allows target to override spill slot assignment logic.
Definition: AArch64FrameLowering.cpp:3111
llvm::AArch64FrameLowering::hasFP
bool hasFP(const MachineFunction &MF) const override
hasFP - Return true if the specified function should have a dedicated frame pointer register.
Definition: AArch64FrameLowering.cpp:425
TRI
unsigned const TargetRegisterInfo * TRI
Definition: MachineSink.cpp:1618
llvm::AArch64FrameLowering
Definition: AArch64FrameLowering.h:23
llvm::AArch64FrameLowering::processFunctionBeforeFrameFinalized
void processFunctionBeforeFrameFinalized(MachineFunction &MF, RegScavenger *RS) const override
processFunctionBeforeFrameFinalized - This method is called immediately before the specified function...
Definition: AArch64FrameLowering.cpp:3287
llvm::AArch64FrameLowering::resolveFrameOffsetReference
StackOffset resolveFrameOffsetReference(const MachineFunction &MF, int64_t ObjectOffset, bool isFixed, bool isSVE, Register &FrameReg, bool PreferFP, bool ForSimm) const
Definition: AArch64FrameLowering.cpp:2269
llvm::MutableArrayRef
MutableArrayRef - Represent a mutable reference to an array (0 or more elements consecutively in memo...
Definition: ArrayRef.h:306
llvm::AArch64FrameLowering::eliminateCallFramePseudoInstr
MachineBasicBlock::iterator eliminateCallFramePseudoInstr(MachineFunction &MF, MachineBasicBlock &MBB, MachineBasicBlock::iterator I) const override
This method is called during prolog/epilog code insertion to eliminate call frame setup and destroy p...
Definition: AArch64FrameLowering.cpp:465
llvm::AArch64FrameLowering::getFrameIndexReference
StackOffset getFrameIndexReference(const MachineFunction &MF, int FI, Register &FrameReg) const override
getFrameIndexReference - Provide a base+offset reference to an FI slot for debug info.
Definition: AArch64FrameLowering.cpp:2212
llvm::BitVector
Definition: BitVector.h:75
llvm::Align
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition: Alignment.h:39
llvm::CallingConv::ID
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
llvm::MachineBasicBlock
Definition: MachineBasicBlock.h:94
llvm::AArch64FrameLowering::resolveFrameIndexReference
StackOffset resolveFrameIndexReference(const MachineFunction &MF, int FI, Register &FrameReg, bool PreferFP, bool ForSimm) const
Definition: AArch64FrameLowering.cpp:2258
llvm::AArch64FrameLowering::resetCFIToInitialState
void resetCFIToInitialState(MachineBasicBlock &MBB) const override
Emit CFI instructions that recreate the state of the unwind information upon fucntion entry.
Definition: AArch64FrameLowering.cpp:593
uint64_t
llvm::AArch64FrameLowering::spillCalleeSavedRegisters
bool spillCalleeSavedRegisters(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, ArrayRef< CalleeSavedInfo > CSI, const TargetRegisterInfo *TRI) const override
spillCalleeSavedRegisters - Issues instruction(s) to spill all callee saved registers and returns tru...
Definition: AArch64FrameLowering.cpp:2689
I
#define I(x, y, z)
Definition: MD5.cpp:58
llvm::RegScavenger
Definition: RegisterScavenging.h:34
llvm::TargetStackID::ScalableVector
@ ScalableVector
Definition: TargetFrameLowering.h:30
llvm::AArch64FrameLowering::enableShrinkWrapping
bool enableShrinkWrapping(const MachineFunction &MF) const override
Returns true if the target will correctly handle shrink wrapping.
Definition: AArch64FrameLowering.h:81
llvm::AArch64FrameLowering::getStackIDForScalableVectors
TargetStackID::Value getStackIDForScalableVectors() const override
Returns the StackID that scalable vectors should be associated with.
Definition: AArch64FrameLowering.cpp:375
llvm::AArch64FrameLowering::getNonLocalFrameIndexReference
StackOffset getNonLocalFrameIndexReference(const MachineFunction &MF, int FI) const override
getNonLocalFrameIndexReference - This method returns the offset used to reference a frame index locat...
Definition: AArch64FrameLowering.cpp:2222
llvm::AArch64FrameLowering::canUseRedZone
bool canUseRedZone(const MachineFunction &MF) const
Can this function use the red zone for local allocations.
Definition: AArch64FrameLowering.cpp:403
llvm::MachineFunction
Definition: MachineFunction.h:241
llvm::AArch64FrameLowering::isSupportedStackID
bool isSupportedStackID(TargetStackID::Value ID) const override
Definition: AArch64FrameLowering.h:107
llvm::ArrayRef
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: APInt.h:32
llvm::AArch64FrameLowering::AArch64FrameLowering
AArch64FrameLowering()
Definition: AArch64FrameLowering.h:25
MBBI
MachineBasicBlock MachineBasicBlock::iterator MBBI
Definition: AArch64SLSHardening.cpp:75
llvm::TargetStackID::NoAlloc
@ NoAlloc
Definition: TargetFrameLowering.h:32
llvm::StackOffset
StackOffset is a class to represent an offset with 2 dimensions, named fixed and scalable,...
Definition: TypeSize.h:134
llvm::Register
Wrapper class representing virtual and physical registers.
Definition: Register.h:19
llvm::AArch64FrameLowering::hasReservedCallFrame
bool hasReservedCallFrame(const MachineFunction &MF) const override
hasReservedCallFrame - Under normal circumstances, when a frame pointer is not required,...
Definition: AArch64FrameLowering.cpp:461
MBB
MachineBasicBlock & MBB
Definition: AArch64SLSHardening.cpp:74
llvm::AArch64FrameLowering::getWinEHParentFrameOffset
unsigned getWinEHParentFrameOffset(const MachineFunction &MF) const override
The parent frame offset (aka dispFrame) is only used on X86_64 to retrieve the parent's frame pointer...
Definition: AArch64FrameLowering.cpp:3758
llvm::AArch64FrameLowering::processFunctionBeforeFrameIndicesReplaced
void processFunctionBeforeFrameIndicesReplaced(MachineFunction &MF, RegScavenger *RS) const override
processFunctionBeforeFrameIndicesReplaced - This method is called immediately before MO_FrameIndex op...
Definition: AArch64FrameLowering.cpp:3724
llvm::TargetStackID::Value
Value
Definition: TargetFrameLowering.h:27
llvm::TargetStackID::Default
@ Default
Definition: TargetFrameLowering.h:28
llvm::AArch64FrameLowering::getSEHFrameIndexOffset
int getSEHFrameIndexOffset(const MachineFunction &MF, int FI) const
Definition: AArch64FrameLowering.cpp:2248
llvm::AArch64FrameLowering::getFrameIndexReferencePreferSP
StackOffset getFrameIndexReferencePreferSP(const MachineFunction &MF, int FI, Register &FrameReg, bool IgnoreSPUpdates) const override
For Win64 AArch64 EH, the offset to the Unwind object is from the SP before the update.
Definition: AArch64FrameLowering.cpp:3735
llvm::AArch64FrameLowering::emitPrologue
void emitPrologue(MachineFunction &MF, MachineBasicBlock &MBB) const override
emitProlog/emitEpilog - These methods insert prolog and epilog code into the function.
Definition: AArch64FrameLowering.cpp:1369
llvm::MachineFrameInfo
The MachineFrameInfo class represents an abstract stack frame until prolog/epilog code is inserted.
Definition: MachineFrameInfo.h:105
llvm::AArch64FrameLowering::emitEpilogue
void emitEpilogue(MachineFunction &MF, MachineBasicBlock &MBB) const override
Definition: AArch64FrameLowering.cpp:1886
llvm::AArch64FrameLowering::canUseAsPrologue
bool canUseAsPrologue(const MachineBasicBlock &MBB) const override
Check whether or not the given MBB can be used as a prologue for the target.
Definition: AArch64FrameLowering.cpp:850
llvm::AArch64FrameLowering::getWinEHFuncletFrameSize
unsigned getWinEHFuncletFrameSize(const MachineFunction &MF) const
Funclets only need to account for space for the callee saved registers, as the locals are accounted f...
Definition: AArch64FrameLowering.cpp:3765
llvm::SmallVectorImpl< int >
llvm::TargetFrameLowering::StackGrowsDown
@ StackGrowsDown
Definition: TargetFrameLowering.h:47
llvm::AArch64FrameLowering::determineCalleeSaves
void determineCalleeSaves(MachineFunction &MF, BitVector &SavedRegs, RegScavenger *RS) const override
This method determines which of the registers reported by TargetRegisterInfo::getCalleeSavedRegs() sh...
Definition: AArch64FrameLowering.cpp:2938
llvm::AArch64FrameLowering::restoreCalleeSavedRegisters
bool restoreCalleeSavedRegisters(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, MutableArrayRef< CalleeSavedInfo > CSI, const TargetRegisterInfo *TRI) const override
restoreCalleeSavedRegisters - Issues instruction(s) to restore all callee saved registers and returns...
Definition: AArch64FrameLowering.cpp:2809
llvm::AArch64FrameLowering::isStackIdSafeForLocalArea
bool isStackIdSafeForLocalArea(unsigned StackId) const override
This method returns whether or not it is safe for an object with the given stack id to be bundled int...
Definition: AArch64FrameLowering.h:118
llvm::AArch64FrameLowering::orderFrameObjects
void orderFrameObjects(const MachineFunction &MF, SmallVectorImpl< int > &ObjectsToAllocate) const override
Order the symbols in the local stack frame.
Definition: AArch64FrameLowering.cpp:3839
llvm::MachineInstrBundleIterator< MachineInstr >