include/llvm/Target/TargetFrameLowering.h

   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
  21 namespace llvm {
  22   class BitVector;
  23   class CalleeSavedInfo;
  24   class MachineFunction;
  25   class RegScavenger;
  26
  27 /// Information about stack frame layout on the target.  It holds the direction
  28 /// of stack growth, the known stack alignment on entry to each function, and
  29 /// the offset to the locals area.
  30 ///
  31 /// The offset to the local area is the offset from the stack pointer on
  32 /// function entry to the first location where function data (local variables,
  33 /// spill locations) can be stored.
  34 class TargetFrameLowering {
  35 public:
  36   enum StackDirection {
  37     StackGrowsUp,        // Adding to the stack increases the stack address
  38     StackGrowsDown       // Adding to the stack decreases the stack address
  39   };
  40
  41   // Maps a callee saved register to a stack slot with a fixed offset.
  42   struct SpillSlot {
  43     unsigned Reg;
  44     int Offset; // Offset relative to stack pointer on function entry.
  45   };
  46 private:
  47   StackDirection StackDir;
  48   unsigned StackAlignment;
  49   unsigned TransientStackAlignment;
  50   int LocalAreaOffset;
  51   bool StackRealignable;
  52 public:
  53   TargetFrameLowering(StackDirection D, unsigned StackAl, int LAO,
  54                       unsigned TransAl = 1, bool StackReal = true)
  55     : StackDir(D), StackAlignment(StackAl), TransientStackAlignment(TransAl),
  56       LocalAreaOffset(LAO), StackRealignable(StackReal) {}
  57
  58   virtual ~TargetFrameLowering();
  59
  60   // These methods return information that describes the abstract stack layout
  61   // of the target machine.
  62
  63   /// getStackGrowthDirection - Return the direction the stack grows
  64   ///
  65   StackDirection getStackGrowthDirection() const { return StackDir; }
  66
  67   /// getStackAlignment - This method returns the number of bytes to which the
  68   /// stack pointer must be aligned on entry to a function.  Typically, this
  69   /// is the largest alignment for any data object in the target.
  70   ///
  71   unsigned getStackAlignment() const { return StackAlignment; }
  72
  73   /// alignSPAdjust - This method aligns the stack adjustment to the correct
  74   /// alignment.
  75   ///
  76   int alignSPAdjust(int SPAdj) const {
  77     if (SPAdj < 0) {
  78       SPAdj = -RoundUpToAlignment(-SPAdj, StackAlignment);
  79     } else {
  80       SPAdj = RoundUpToAlignment(SPAdj, StackAlignment);
  81     }
  82     return SPAdj;
  83   }
  84
  85   /// getTransientStackAlignment - This method returns the number of bytes to
  86   /// which the stack pointer must be aligned at all times, even between
  87   /// calls.
  88   ///
  89   unsigned getTransientStackAlignment() const {
  90     return TransientStackAlignment;
  91   }
  92
  93   /// isStackRealignable - This method returns whether the stack can be
  94   /// realigned.
  95   bool isStackRealignable() const {
  96     return StackRealignable;
  97   }
  98
  99   /// Return the skew that has to be applied to stack alignment under
 100   /// certain conditions (e.g. stack was adjusted before function \p MF
 101   /// was called).
 102   virtual unsigned getStackAlignmentSkew(const MachineFunction &MF) const;
 103
 104   /// getOffsetOfLocalArea - This method returns the offset of the local area
 105   /// from the stack pointer on entrance to a function.
 106   ///
 107   int getOffsetOfLocalArea() const { return LocalAreaOffset; }
 108
 109   /// isFPCloseToIncomingSP - Return true if the frame pointer is close to
 110   /// the incoming stack pointer, false if it is close to the post-prologue
 111   /// stack pointer.
 112   virtual bool isFPCloseToIncomingSP() const { return true; }
 113
 114   /// assignCalleeSavedSpillSlots - Allows target to override spill slot
 115   /// assignment logic.  If implemented, assignCalleeSavedSpillSlots() should
 116   /// assign frame slots to all CSI entries and return true.  If this method
 117   /// returns false, spill slots will be assigned using generic implementation.
 118   /// assignCalleeSavedSpillSlots() may add, delete or rearrange elements of
 119   /// CSI.
 120   virtual bool
 121   assignCalleeSavedSpillSlots(MachineFunction &MF,
 122                               const TargetRegisterInfo *TRI,
 123                               std::vector<CalleeSavedInfo> &CSI) const {
 124     return false;
 125   }
 126
 127   /// getCalleeSavedSpillSlots - This method returns a pointer to an array of
 128   /// pairs, that contains an entry for each callee saved register that must be
 129   /// spilled to a particular stack location if it is spilled.
 130   ///
 131   /// Each entry in this array contains a <register,offset> pair, indicating the
 132   /// fixed offset from the incoming stack pointer that each register should be
 133   /// spilled at. If a register is not listed here, the code generator is
 134   /// allowed to spill it anywhere it chooses.
 135   ///
 136   virtual const SpillSlot *
 137   getCalleeSavedSpillSlots(unsigned &NumEntries) const {
 138     NumEntries = 0;
 139     return nullptr;
 140   }
 141
 142   /// targetHandlesStackFrameRounding - Returns true if the target is
 143   /// responsible for rounding up the stack frame (probably at emitPrologue
 144   /// time).
 145   virtual bool targetHandlesStackFrameRounding() const {
 146     return false;
 147   }
 148
 149   /// Returns true if the target will correctly handle shrink wrapping.
 150   virtual bool enableShrinkWrapping(const MachineFunction &MF) const {
 151     return false;
 152   }
 153
 154   /// emitProlog/emitEpilog - These methods insert prolog and epilog code into
 155   /// the function.
 156   virtual void emitPrologue(MachineFunction &MF,
 157                             MachineBasicBlock &MBB) const = 0;
 158   virtual void emitEpilogue(MachineFunction &MF,
 159                             MachineBasicBlock &MBB) const = 0;
 160
 161   /// Adjust the prologue to have the function use segmented stacks. This works
 162   /// by adding a check even before the "normal" function prologue.
 163   virtual void adjustForSegmentedStacks(MachineFunction &MF,
 164                                         MachineBasicBlock &PrologueMBB) const {}
 165
 166   /// Adjust the prologue to add Erlang Run-Time System (ERTS) specific code in
 167   /// the assembly prologue to explicitly handle the stack.
 168   virtual void adjustForHiPEPrologue(MachineFunction &MF,
 169                                      MachineBasicBlock &PrologueMBB) const {}
 170
 171   /// Adjust the prologue to add an allocation at a fixed offset from the frame
 172   /// pointer.
 173   virtual void
 174   adjustForFrameAllocatePrologue(MachineFunction &MF,
 175                                  MachineBasicBlock &PrologueMBB) const {}
 176
 177   /// spillCalleeSavedRegisters - Issues instruction(s) to spill all callee
 178   /// saved registers and returns true if it isn't possible / profitable to do
 179   /// so by issuing a series of store instructions via
 180   /// storeRegToStackSlot(). Returns false otherwise.
 181   virtual bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
 182                                          MachineBasicBlock::iterator MI,
 183                                         const std::vector<CalleeSavedInfo> &CSI,
 184                                          const TargetRegisterInfo *TRI) const {
 185     return false;
 186   }
 187
 188   /// restoreCalleeSavedRegisters - Issues instruction(s) to restore all callee
 189   /// saved registers and returns true if it isn't possible / profitable to do
 190   /// so by issuing a series of load instructions via loadRegToStackSlot().
 191   /// Returns false otherwise.
 192   virtual bool restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
 193                                            MachineBasicBlock::iterator MI,
 194                                         const std::vector<CalleeSavedInfo> &CSI,
 195                                         const TargetRegisterInfo *TRI) const {
 196     return false;
 197   }
 198
 199   /// Return true if the target needs to disable frame pointer elimination.
 200   virtual bool noFramePointerElim(const MachineFunction &MF) const;
 201
 202   /// hasFP - Return true if the specified function should have a dedicated
 203   /// frame pointer register. For most targets this is true only if the function
 204   /// has variable sized allocas or if frame pointer elimination is disabled.
 205   virtual bool hasFP(const MachineFunction &MF) const = 0;
 206
 207   /// hasReservedCallFrame - Under normal circumstances, when a frame pointer is
 208   /// not required, we reserve argument space for call sites in the function
 209   /// immediately on entry to the current function. This eliminates the need for
 210   /// add/sub sp brackets around call sites. Returns true if the call frame is
 211   /// included as part of the stack frame.
 212   virtual bool hasReservedCallFrame(const MachineFunction &MF) const {
 213     return !hasFP(MF);
 214   }
 215
 216   /// canSimplifyCallFramePseudos - When possible, it's best to simplify the
 217   /// call frame pseudo ops before doing frame index elimination. This is
 218   /// possible only when frame index references between the pseudos won't
 219   /// need adjusting for the call frame adjustments. Normally, that's true
 220   /// if the function has a reserved call frame or a frame pointer. Some
 221   /// targets (Thumb2, for example) may have more complicated criteria,
 222   /// however, and can override this behavior.
 223   virtual bool canSimplifyCallFramePseudos(const MachineFunction &MF) const {
 224     return hasReservedCallFrame(MF) || hasFP(MF);
 225   }
 226
 227   // needsFrameIndexResolution - Do we need to perform FI resolution for
 228   // this function. Normally, this is required only when the function
 229   // has any stack objects. However, targets may want to override this.
 230   virtual bool needsFrameIndexResolution(const MachineFunction &MF) const;
 231
 232   /// getFrameIndexReference - This method should return the base register
 233   /// and offset used to reference a frame index location. The offset is
 234   /// returned directly, and the base register is returned via FrameReg.
 235   virtual int getFrameIndexReference(const MachineFunction &MF, int FI,
 236                                      unsigned &FrameReg) const;
 237
 238   /// Same as above, except that the 'base register' will always be RSP, not
 239   /// RBP on x86.  This is used exclusively for lowering STATEPOINT nodes.
 240   /// TODO: This should really be a parameterizable choice.
 241   virtual int getFrameIndexReferenceFromSP(const MachineFunction &MF, int FI,
 242                                           unsigned &FrameReg) const {
 243     // default to calling normal version, we override this on x86 only
 244     llvm_unreachable("unimplemented for non-x86");
 245     return 0;
 246   }
 247
 248   /// This method determines which of the registers reported by
 249   /// TargetRegisterInfo::getCalleeSavedRegs() should actually get saved.
 250   /// The default implementation checks populates the \p SavedRegs bitset with
 251   /// all registers which are modified in the function, targets may override
 252   /// this function to save additional registers.
 253   /// This method also sets up the register scavenger ensuring there is a free
 254   /// register or a frameindex available.
 255   virtual void determineCalleeSaves(MachineFunction &MF, BitVector &SavedRegs,
 256                                     RegScavenger *RS = nullptr) const;
 257
 258   /// processFunctionBeforeFrameFinalized - This method is called immediately
 259   /// before the specified function's frame layout (MF.getFrameInfo()) is
 260   /// finalized.  Once the frame is finalized, MO_FrameIndex operands are
 261   /// replaced with direct constants.  This method is optional.
 262   ///
 263   virtual void processFunctionBeforeFrameFinalized(MachineFunction &MF,
 264                                              RegScavenger *RS = nullptr) const {
 265   }
 266
 267   /// eliminateCallFramePseudoInstr - This method is called during prolog/epilog
 268   /// code insertion to eliminate call frame setup and destroy pseudo
 269   /// instructions (but only if the Target is using them).  It is responsible
 270   /// for eliminating these instructions, replacing them with concrete
 271   /// instructions.  This method need only be implemented if using call frame
 272   /// setup/destroy pseudo instructions.
 273   ///
 274   virtual void
 275   eliminateCallFramePseudoInstr(MachineFunction &MF,
 276                                 MachineBasicBlock &MBB,
 277                                 MachineBasicBlock::iterator MI) const {
 278     llvm_unreachable("Call Frame Pseudo Instructions do not exist on this "
 279                      "target!");
 280   }
 281
 282   /// Check whether or not the given \p MBB can be used as a prologue
 283   /// for the target.
 284   /// The prologue will be inserted first in this basic block.
 285   /// This method is used by the shrink-wrapping pass to decide if
 286   /// \p MBB will be correctly handled by the target.
 287   /// As soon as the target enable shrink-wrapping without overriding
 288   /// this method, we assume that each basic block is a valid
 289   /// prologue.
 290   virtual bool canUseAsPrologue(const MachineBasicBlock &MBB) const {
 291     return true;
 292   }
 293
 294   /// Check whether or not the given \p MBB can be used as a epilogue
 295   /// for the target.
 296   /// The epilogue will be inserted before the first terminator of that block.
 297   /// This method is used by the shrink-wrapping pass to decide if
 298   /// \p MBB will be correctly handled by the target.
 299   /// As soon as the target enable shrink-wrapping without overriding
 300   /// this method, we assume that each basic block is a valid
 301   /// epilogue.
 302   virtual bool canUseAsEpilogue(const MachineBasicBlock &MBB) const {
 303     return true;
 304   }
 305 };
 306
 307 } // End llvm namespace
 308
 309 #endif