include/llvm/CodeGen/MachineFrameInfo.h

   1 //===-- CodeGen/MachineFrameInfo.h - Abstract Stack Frame Rep. --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10
  11 #ifndef LLVM_CODEGEN_MACHINEFRAMEINFO_H
  12 #define LLVM_CODEGEN_MACHINEFRAMEINFO_H
  13
  14 #include <vector>
  15
  16 namespace llvm {
  17 class TargetData;
  18 class TargetRegisterClass;
  19 class Type;
  20 class MachineModuleInfo;
  21 class MachineFunction;
  22
  23 /// The CalleeSavedInfo class tracks the information need to locate where a
  24 /// callee saved register in the current frame.
  25 class CalleeSavedInfo {
  26
  27 private:
  28   unsigned Reg;
  29   const TargetRegisterClass *RegClass;
  30   int FrameIdx;
  31
  32 public:
  33   CalleeSavedInfo(unsigned R, const TargetRegisterClass *RC, int FI = 0)
  34   : Reg(R)
  35   , RegClass(RC)
  36   , FrameIdx(FI)
  37   {}
  38
  39   // Accessors.
  40   unsigned getReg()                        const { return Reg; }
  41   const TargetRegisterClass *getRegClass() const { return RegClass; }
  42   int getFrameIdx()                        const { return FrameIdx; }
  43   void setFrameIdx(int FI)                       { FrameIdx = FI; }
  44 };
  45
  46 /// The MachineFrameInfo class represents an abstract stack frame until
  47 /// prolog/epilog code is inserted.  This class is key to allowing stack frame
  48 /// representation optimizations, such as frame pointer elimination.  It also
  49 /// allows more mundane (but still important) optimizations, such as reordering
  50 /// of abstract objects on the stack frame.
  51 ///
  52 /// To support this, the class assigns unique integer identifiers to stack
  53 /// objects requested clients.  These identifiers are negative integers for
  54 /// fixed stack objects (such as arguments passed on the stack) or positive
  55 /// for objects that may be reordered.  Instructions which refer to stack
  56 /// objects use a special MO_FrameIndex operand to represent these frame
  57 /// indexes.
  58 ///
  59 /// Because this class keeps track of all references to the stack frame, it
  60 /// knows when a variable sized object is allocated on the stack.  This is the
  61 /// sole condition which prevents frame pointer elimination, which is an
  62 /// important optimization on register-poor architectures.  Because original
  63 /// variable sized alloca's in the source program are the only source of
  64 /// variable sized stack objects, it is safe to decide whether there will be
  65 /// any variable sized objects before all stack objects are known (for
  66 /// example, register allocator spill code never needs variable sized
  67 /// objects).
  68 ///
  69 /// When prolog/epilog code emission is performed, the final stack frame is
  70 /// built and the machine instructions are modified to refer to the actual
  71 /// stack offsets of the object, eliminating all MO_FrameIndex operands from
  72 /// the program.
  73 ///
  74 /// @brief Abstract Stack Frame Information
  75 class MachineFrameInfo {
  76
  77   // StackObject - Represent a single object allocated on the stack.
  78   struct StackObject {
  79     // The size of this object on the stack. 0 means a variable sized object
  80     uint64_t Size;
  81
  82     // Alignment - The required alignment of this stack slot.
  83     unsigned Alignment;
  84
  85     // SPOffset - The offset of this object from the stack pointer on entry to
  86     // the function.  This field has no meaning for a variable sized element.
  87     int64_t SPOffset;
  88
  89     StackObject(uint64_t Sz, unsigned Al, int64_t SP)
  90       : Size(Sz), Alignment(Al), SPOffset(SP) {}
  91   };
  92
  93   /// Objects - The list of stack objects allocated...
  94   ///
  95   std::vector<StackObject> Objects;
  96
  97   /// NumFixedObjects - This contains the number of fixed objects contained on
  98   /// the stack.  Because fixed objects are stored at a negative index in the
  99   /// Objects list, this is also the index to the 0th object in the list.
 100   ///
 101   unsigned NumFixedObjects;
 102
 103   /// HasVarSizedObjects - This boolean keeps track of whether any variable
 104   /// sized objects have been allocated yet.
 105   ///
 106   bool HasVarSizedObjects;
 107
 108   /// StackSize - The prolog/epilog code inserter calculates the final stack
 109   /// offsets for all of the fixed size objects, updating the Objects list
 110   /// above.  It then updates StackSize to contain the number of bytes that need
 111   /// to be allocated on entry to the function.
 112   ///
 113   uint64_t StackSize;
 114
 115   /// OffsetAdjustment - The amount that a frame offset needs to be adjusted to
 116   /// have the actual offset from the stack/frame pointer.  The calculation is
 117   /// MFI->getObjectOffset(Index) + StackSize - TFI.getOffsetOfLocalArea() +
 118   /// OffsetAdjustment.  If OffsetAdjustment is zero (default) then offsets are
 119   /// away from TOS. If OffsetAdjustment == StackSize then offsets are toward
 120   /// TOS.
 121   int OffsetAdjustment;
 122
 123   /// MaxAlignment - The prolog/epilog code inserter may process objects
 124   /// that require greater alignment than the default alignment the target
 125   /// provides. To handle this, MaxAlignment is set to the maximum alignment
 126   /// needed by the objects on the current frame.  If this is greater than the
 127   /// native alignment maintained by the compiler, dynamic alignment code will
 128   /// be needed.
 129   ///
 130   unsigned MaxAlignment;
 131
 132   /// HasCalls - Set to true if this function has any function calls.  This is
 133   /// only valid during and after prolog/epilog code insertion.
 134   bool HasCalls;
 135
 136   /// MaxCallFrameSize - This contains the size of the largest call frame if the
 137   /// target uses frame setup/destroy pseudo instructions (as defined in the
 138   /// TargetFrameInfo class).  This information is important for frame pointer
 139   /// elimination.  If is only valid during and after prolog/epilog code
 140   /// insertion.
 141   ///
 142   unsigned MaxCallFrameSize;
 143
 144   /// CSInfo - The prolog/epilog code inserter fills in this vector with each
 145   /// callee saved register saved in the frame.  Beyond its use by the prolog/
 146   /// epilog code inserter, this data used for debug info and exception
 147   /// handling.
 148   std::vector<CalleeSavedInfo> CSInfo;
 149
 150   /// MMI - This field is set (via setMachineModuleInfo) by a module info
 151   /// consumer (ex. DwarfWriter) to indicate that frame layout information
 152   /// should be acquired.  Typically, it's the responsibility of the target's
 153   /// MRegisterInfo prologue/epilogue emitting code to inform MachineModuleInfo
 154   /// of frame layouts.
 155   MachineModuleInfo *MMI;
 156
 157 public:
 158   MachineFrameInfo() {
 159     StackSize = NumFixedObjects = OffsetAdjustment = MaxAlignment = 0;
 160     HasVarSizedObjects = false;
 161     HasCalls = false;
 162     MaxCallFrameSize = 0;
 163     MMI = 0;
 164   }
 165
 166   /// hasStackObjects - Return true if there are any stack objects in this
 167   /// function.
 168   ///
 169   bool hasStackObjects() const { return !Objects.empty(); }
 170
 171   /// hasVarSizedObjects - This method may be called any time after instruction
 172   /// selection is complete to determine if the stack frame for this function
 173   /// contains any variable sized objects.
 174   ///
 175   bool hasVarSizedObjects() const { return HasVarSizedObjects; }
 176
 177   /// getObjectIndexBegin - Return the minimum frame object index...
 178   ///
 179   int getObjectIndexBegin() const { return -NumFixedObjects; }
 180
 181   /// getObjectIndexEnd - Return one past the maximum frame object index...
 182   ///
 183   int getObjectIndexEnd() const { return Objects.size()-NumFixedObjects; }
 184
 185   /// getObjectSize - Return the size of the specified object
 186   ///
 187   int64_t getObjectSize(int ObjectIdx) const {
 188     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 189     return Objects[ObjectIdx+NumFixedObjects].Size;
 190   }
 191
 192   /// getObjectAlignment - Return the alignment of the specified stack object...
 193   int getObjectAlignment(int ObjectIdx) const {
 194     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 195     return Objects[ObjectIdx+NumFixedObjects].Alignment;
 196   }
 197
 198   /// getObjectOffset - Return the assigned stack offset of the specified object
 199   /// from the incoming stack pointer.
 200   ///
 201   int64_t getObjectOffset(int ObjectIdx) const {
 202     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 203     return Objects[ObjectIdx+NumFixedObjects].SPOffset;
 204   }
 205
 206   /// setObjectOffset - Set the stack frame offset of the specified object.  The
 207   /// offset is relative to the stack pointer on entry to the function.
 208   ///
 209   void setObjectOffset(int ObjectIdx, int64_t SPOffset) {
 210     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 211     Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
 212   }
 213
 214   /// getStackSize - Return the number of bytes that must be allocated to hold
 215   /// all of the fixed size frame objects.  This is only valid after
 216   /// Prolog/Epilog code insertion has finalized the stack frame layout.
 217   ///
 218   uint64_t getStackSize() const { return StackSize; }
 219
 220   /// setStackSize - Set the size of the stack...
 221   ///
 222   void setStackSize(uint64_t Size) { StackSize = Size; }
 223
 224   /// getOffsetAdjustment - Return the correction for frame offsets.
 225   ///
 226   int getOffsetAdjustment() const { return OffsetAdjustment; }
 227
 228   /// setOffsetAdjustment - Set the correction for frame offsets.
 229   ///
 230   void setOffsetAdjustment(int Adj) { OffsetAdjustment = Adj; }
 231
 232   /// getMaxAlignment - Return the alignment in bytes that this function must be
 233   /// aligned to, which is greater than the default stack alignment provided by
 234   /// the target.
 235   ///
 236   unsigned getMaxAlignment() const { return MaxAlignment; }
 237
 238   /// setMaxAlignment - Set the preferred alignment.
 239   ///
 240   void setMaxAlignment(unsigned Align) { MaxAlignment = Align; }
 241
 242   /// hasCalls - Return true if the current function has no function calls.
 243   /// This is only valid during or after prolog/epilog code emission.
 244   ///
 245   bool hasCalls() const { return HasCalls; }
 246   void setHasCalls(bool V) { HasCalls = V; }
 247
 248   /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
 249   /// allocated for an outgoing function call.  This is only available if
 250   /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
 251   /// then only during or after prolog/epilog code insertion.
 252   ///
 253   unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
 254   void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
 255
 256   /// CreateFixedObject - Create a new object at a fixed location on the stack.
 257   /// All fixed objects should be created before other objects are created for
 258   /// efficiency.  This returns an index with a negative value.
 259   ///
 260   int CreateFixedObject(uint64_t Size, int64_t SPOffset) {
 261     assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
 262     Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset));
 263     return -++NumFixedObjects;
 264   }
 265
 266   /// isFixedObjectIndex - Returns true if the specified index corresponds to a
 267   /// fixed stack object.
 268   bool isFixedObjectIndex(int ObjectIdx) const {
 269     return ObjectIdx < 0 && (ObjectIdx >= -(int)NumFixedObjects);
 270   }
 271
 272   /// CreateStackObject - Create a new statically sized stack object, returning
 273   /// a postive identifier to represent it.
 274   ///
 275   int CreateStackObject(uint64_t Size, unsigned Alignment) {
 276     // Keep track of the maximum alignment.
 277     if (MaxAlignment < Alignment) MaxAlignment = Alignment;
 278
 279     assert(Size != 0 && "Cannot allocate zero size stack objects!");
 280     Objects.push_back(StackObject(Size, Alignment, -1));
 281     return Objects.size()-NumFixedObjects-1;
 282   }
 283
 284   /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
 285   /// variable sized object has been created.  This must be created whenever a
 286   /// variable sized object is created, whether or not the index returned is
 287   /// actually used.
 288   ///
 289   int CreateVariableSizedObject() {
 290     HasVarSizedObjects = true;
 291     if (MaxAlignment < 1) MaxAlignment = 1;
 292     Objects.push_back(StackObject(0, 1, -1));
 293     return Objects.size()-NumFixedObjects-1;
 294   }
 295
 296   /// getCalleeSavedInfo - Returns a reference to call saved info vector for the
 297   /// current function.
 298   const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
 299     return CSInfo;
 300   }
 301
 302   /// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
 303   /// callee saved information.
 304   void  setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
 305     CSInfo = CSI;
 306   }
 307
 308   /// getMachineModuleInfo - Used by a prologue/epilogue emitter (MRegisterInfo)
 309   /// to provide frame layout information.
 310   MachineModuleInfo *getMachineModuleInfo() const { return MMI; }
 311
 312   /// setMachineModuleInfo - Used by a meta info consumer (DwarfWriter) to
 313   /// indicate that frame layout information should be gathered.
 314   void setMachineModuleInfo(MachineModuleInfo *mmi) { MMI = mmi; }
 315
 316   /// print - Used by the MachineFunction printer to print information about
 317   /// stack objects.  Implemented in MachineFunction.cpp
 318   ///
 319   void print(const MachineFunction &MF, std::ostream &OS) const;
 320
 321   /// dump - Call print(MF, std::cerr) to be called from the debugger.
 322   void dump(const MachineFunction &MF) const;
 323 };
 324
 325 } // End llvm namespace
 326
 327 #endif