TargetFrameLowering.h revision 3080d23fde4981835d8a7faf46c152441fadb11f 
1//===-- llvm/Target/TargetFrameLowering.h ---------------------------*- C++ -*-===//
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// Interface to describe the layout of a stack frame on the target machine.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_TARGET_TARGETFRAMELOWERING_H
15#define LLVM_TARGET_TARGETFRAMELOWERING_H
16
17#include "llvm/CodeGen/MachineBasicBlock.h"
18#include <utility>
19#include <vector>
20
21namespace llvm {
22  class CalleeSavedInfo;
23  class MachineFunction;
24  class RegScavenger;
25
26/// Information about stack frame layout on the target.  It holds the direction
27/// of stack growth, the known stack alignment on entry to each function, and
28/// the offset to the locals area.
29///
30/// The offset to the local area is the offset from the stack pointer on
31/// function entry to the first location where function data (local variables,
32/// spill locations) can be stored.
33class TargetFrameLowering {
34public:
35  enum StackDirection {
36    StackGrowsUp,        // Adding to the stack increases the stack address
37    StackGrowsDown       // Adding to the stack decreases the stack address
38  };
39
40  // Maps a callee saved register to a stack slot with a fixed offset.
41  struct SpillSlot {
42    unsigned Reg;
43    int Offset; // Offset relative to stack pointer on function entry.
44  };
45private:
46  StackDirection StackDir;
47  unsigned StackAlignment;
48  unsigned TransientStackAlignment;
49  int LocalAreaOffset;
50  bool StackRealignable;
51public:
52  TargetFrameLowering(StackDirection D, unsigned StackAl, int LAO,
53                      unsigned TransAl = 1, bool StackReal = true)
54    : StackDir(D), StackAlignment(StackAl), TransientStackAlignment(TransAl),
55      LocalAreaOffset(LAO), StackRealignable(StackReal) {}
56
57  virtual ~TargetFrameLowering();
58
59  // These methods return information that describes the abstract stack layout
60  // of the target machine.
61
62  /// getStackGrowthDirection - Return the direction the stack grows
63  ///
64  StackDirection getStackGrowthDirection() const { return StackDir; }
65
66  /// getStackAlignment - This method returns the number of bytes to which the
67  /// stack pointer must be aligned on entry to a function.  Typically, this
68  /// is the largest alignment for any data object in the target.
69  ///
70  unsigned getStackAlignment() const { return StackAlignment; }
71
72  /// getTransientStackAlignment - This method returns the number of bytes to
73  /// which the stack pointer must be aligned at all times, even between
74  /// calls.
75  ///
76  unsigned getTransientStackAlignment() const {
77    return TransientStackAlignment;
78  }
79
80  /// isStackRealignable - This method returns whether the stack can be
81  /// realigned.
82  bool isStackRealignable() const {
83    return StackRealignable;
84  }
85
86  /// getOffsetOfLocalArea - This method returns the offset of the local area
87  /// from the stack pointer on entrance to a function.
88  ///
89  int getOffsetOfLocalArea() const { return LocalAreaOffset; }
90
91  /// getCalleeSavedSpillSlots - This method returns a pointer to an array of
92  /// pairs, that contains an entry for each callee saved register that must be
93  /// spilled to a particular stack location if it is spilled.
94  ///
95  /// Each entry in this array contains a <register,offset> pair, indicating the
96  /// fixed offset from the incoming stack pointer that each register should be
97  /// spilled at. If a register is not listed here, the code generator is
98  /// allowed to spill it anywhere it chooses.
99  ///
100  virtual const SpillSlot *
101  getCalleeSavedSpillSlots(unsigned &NumEntries) const {
102    NumEntries = 0;
103    return 0;
104  }
105
106  /// targetHandlesStackFrameRounding - Returns true if the target is
107  /// responsible for rounding up the stack frame (probably at emitPrologue
108  /// time).
109  virtual bool targetHandlesStackFrameRounding() const {
110    return false;
111  }
112
113  /// emitProlog/emitEpilog - These methods insert prolog and epilog code into
114  /// the function.
115  virtual void emitPrologue(MachineFunction &MF) const = 0;
116  virtual void emitEpilogue(MachineFunction &MF,
117                            MachineBasicBlock &MBB) const = 0;
118
119  /// Adjust the prologue to have the function use segmented stacks. This works
120  /// by adding a check even before the "normal" function prologue.
121  virtual void adjustForSegmentedStacks(MachineFunction &MF) const { }
122
123  /// Adjust the prologue to add Erlang Run-Time System (ERTS) specific code in
124  /// the assembly prologue to explicitly handle the stack.
125  virtual void adjustForHiPEPrologue(MachineFunction &MF) const { }
126
127  /// spillCalleeSavedRegisters - Issues instruction(s) to spill all callee
128  /// saved registers and returns true if it isn't possible / profitable to do
129  /// so by issuing a series of store instructions via
130  /// storeRegToStackSlot(). Returns false otherwise.
131  virtual bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
132                                         MachineBasicBlock::iterator MI,
133                                        const std::vector<CalleeSavedInfo> &CSI,
134                                         const TargetRegisterInfo *TRI) const {
135    return false;
136  }
137
138  /// restoreCalleeSavedRegisters - Issues instruction(s) to restore all callee
139  /// saved registers and returns true if it isn't possible / profitable to do
140  /// so by issuing a series of load instructions via loadRegToStackSlot().
141  /// Returns false otherwise.
142  virtual bool restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
143                                           MachineBasicBlock::iterator MI,
144                                        const std::vector<CalleeSavedInfo> &CSI,
145                                        const TargetRegisterInfo *TRI) const {
146    return false;
147  }
148
149  /// hasFP - Return true if the specified function should have a dedicated
150  /// frame pointer register. For most targets this is true only if the function
151  /// has variable sized allocas or if frame pointer elimination is disabled.
152  virtual bool hasFP(const MachineFunction &MF) const = 0;
153
154  /// hasReservedCallFrame - Under normal circumstances, when a frame pointer is
155  /// not required, we reserve argument space for call sites in the function
156  /// immediately on entry to the current function. This eliminates the need for
157  /// add/sub sp brackets around call sites. Returns true if the call frame is
158  /// included as part of the stack frame.
159  virtual bool hasReservedCallFrame(const MachineFunction &MF) const {
160    return !hasFP(MF);
161  }
162
163  /// canSimplifyCallFramePseudos - When possible, it's best to simplify the
164  /// call frame pseudo ops before doing frame index elimination. This is
165  /// possible only when frame index references between the pseudos won't
166  /// need adjusting for the call frame adjustments. Normally, that's true
167  /// if the function has a reserved call frame or a frame pointer. Some
168  /// targets (Thumb2, for example) may have more complicated criteria,
169  /// however, and can override this behavior.
170  virtual bool canSimplifyCallFramePseudos(const MachineFunction &MF) const {
171    return hasReservedCallFrame(MF) || hasFP(MF);
172  }
173
174  /// getFrameIndexOffset - Returns the displacement from the frame register to
175  /// the stack frame of the specified index.
176  virtual int getFrameIndexOffset(const MachineFunction &MF, int FI) const;
177
178  /// getFrameIndexReference - This method should return the base register
179  /// and offset used to reference a frame index location. The offset is
180  /// returned directly, and the base register is returned via FrameReg.
181  virtual int getFrameIndexReference(const MachineFunction &MF, int FI,
182                                     unsigned &FrameReg) const;
183
184  /// processFunctionBeforeCalleeSavedScan - This method is called immediately
185  /// before PrologEpilogInserter scans the physical registers used to determine
186  /// what callee saved registers should be spilled. This method is optional.
187  virtual void processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
188                                                RegScavenger *RS = NULL) const {
189
190  }
191
192  /// processFunctionBeforeFrameFinalized - This method is called immediately
193  /// before the specified function's frame layout (MF.getFrameInfo()) is
194  /// finalized.  Once the frame is finalized, MO_FrameIndex operands are
195  /// replaced with direct constants.  This method is optional.
196  ///
197  virtual void processFunctionBeforeFrameFinalized(MachineFunction &MF,
198                                               RegScavenger *RS = NULL) const {
199  }
200
201  /// eliminateCallFramePseudoInstr - This method is called during prolog/epilog
202  /// code insertion to eliminate call frame setup and destroy pseudo
203  /// instructions (but only if the Target is using them).  It is responsible
204  /// for eliminating these instructions, replacing them with concrete
205  /// instructions.  This method need only be implemented if using call frame
206  /// setup/destroy pseudo instructions.
207  ///
208  virtual void
209  eliminateCallFramePseudoInstr(MachineFunction &MF,
210                                MachineBasicBlock &MBB,
211                                MachineBasicBlock::iterator MI) const {
212    llvm_unreachable("Call Frame Pseudo Instructions do not exist on this "
213                     "target!");
214  }
215};
216
217} // End llvm namespace
218
219#endif
220