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 MachineDebugInfo;
  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     unsigned 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     int SPOffset;
  88
  89     StackObject(unsigned Sz, unsigned Al, int 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   unsigned StackSize;
 114
 115   /// MaxAlignment - The prolog/epilog code inserter may process objects
 116   /// that require greater alignment than the default alignment the target
 117   /// provides. To handle this, MaxAlignment is set to the maximum alignment
 118   /// needed by the objects on the current frame.  If this is greater than the
 119   /// native alignment maintained by the compiler, dynamic alignment code will
 120   /// be needed.
 121   ///
 122   unsigned MaxAlignment;
 123
 124   /// HasCalls - Set to true if this function has any function calls.  This is
 125   /// only valid during and after prolog/epilog code insertion.
 126   bool HasCalls;
 127
 128   /// MaxCallFrameSize - This contains the size of the largest call frame if the
 129   /// target uses frame setup/destroy pseudo instructions (as defined in the
 130   /// TargetFrameInfo class).  This information is important for frame pointer
 131   /// elimination.  If is only valid during and after prolog/epilog code
 132   /// insertion.
 133   ///
 134   unsigned MaxCallFrameSize;
 135
 136   /// CSInfo - The prolog/epilog code inserter fills in this vector with each
 137   /// callee saved register saved in the frame.  Beyond its use by the prolog/
 138   /// epilog code inserter, this data used for debug info and exception
 139   /// handling.
 140   std::vector<CalleeSavedInfo> CSInfo;
 141
 142   /// DebugInfo - This field is set (via setMachineDebugInfo) by a debug info
 143   /// consumer (ex. DwarfWriter) to indicate that frame layout information
 144   /// should be acquired.  Typically, it's the responsibility of the target's
 145   /// MRegisterInfo prologue/epilogue emitting code to inform MachineDebugInfo
 146   /// of frame layouts.
 147   MachineDebugInfo *DebugInfo;
 148
 149 public:
 150   MachineFrameInfo() {
 151     NumFixedObjects = StackSize = MaxAlignment = 0;
 152     HasVarSizedObjects = false;
 153     HasCalls = false;
 154     MaxCallFrameSize = 0;
 155     DebugInfo = 0;
 156   }
 157
 158   /// hasStackObjects - Return true if there are any stack objects in this
 159   /// function.
 160   ///
 161   bool hasStackObjects() const { return !Objects.empty(); }
 162
 163   /// hasVarSizedObjects - This method may be called any time after instruction
 164   /// selection is complete to determine if the stack frame for this function
 165   /// contains any variable sized objects.
 166   ///
 167   bool hasVarSizedObjects() const { return HasVarSizedObjects; }
 168
 169   /// getObjectIndexBegin - Return the minimum frame object index...
 170   ///
 171   int getObjectIndexBegin() const { return -NumFixedObjects; }
 172
 173   /// getObjectIndexEnd - Return one past the maximum frame object index...
 174   ///
 175   int getObjectIndexEnd() const { return Objects.size()-NumFixedObjects; }
 176
 177   /// getObjectSize - Return the size of the specified object
 178   ///
 179   int getObjectSize(int ObjectIdx) const {
 180     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 181     return Objects[ObjectIdx+NumFixedObjects].Size;
 182   }
 183
 184   /// getObjectAlignment - Return the alignment of the specified stack object...
 185   int getObjectAlignment(int ObjectIdx) const {
 186     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 187     return Objects[ObjectIdx+NumFixedObjects].Alignment;
 188   }
 189
 190   /// getObjectOffset - Return the assigned stack offset of the specified object
 191   /// from the incoming stack pointer.
 192   ///
 193   int getObjectOffset(int ObjectIdx) const {
 194     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 195     return Objects[ObjectIdx+NumFixedObjects].SPOffset;
 196   }
 197
 198   /// setObjectOffset - Set the stack frame offset of the specified object.  The
 199   /// offset is relative to the stack pointer on entry to the function.
 200   ///
 201   void setObjectOffset(int ObjectIdx, int SPOffset) {
 202     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 203     Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
 204   }
 205
 206   /// getStackSize - Return the number of bytes that must be allocated to hold
 207   /// all of the fixed size frame objects.  This is only valid after
 208   /// Prolog/Epilog code insertion has finalized the stack frame layout.
 209   ///
 210   unsigned getStackSize() const { return StackSize; }
 211
 212   /// setStackSize - Set the size of the stack...
 213   ///
 214   void setStackSize(unsigned Size) { StackSize = Size; }
 215
 216   /// getMaxAlignment - Return the alignment in bytes that this function must be
 217   /// aligned to, which is greater than the default stack alignment provided by
 218   /// the target.
 219   ///
 220   unsigned getMaxAlignment() const { return MaxAlignment; }
 221
 222   /// setMaxAlignment - Set the preferred alignment.
 223   ///
 224   void setMaxAlignment(unsigned Align) { MaxAlignment = Align; }
 225
 226   /// hasCalls - Return true if the current function has no function calls.
 227   /// This is only valid during or after prolog/epilog code emission.
 228   ///
 229   bool hasCalls() const { return HasCalls; }
 230   void setHasCalls(bool V) { HasCalls = V; }
 231
 232   /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
 233   /// allocated for an outgoing function call.  This is only available if
 234   /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
 235   /// then only during or after prolog/epilog code insertion.
 236   ///
 237   unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
 238   void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
 239
 240   /// CreateFixedObject - Create a new object at a fixed location on the stack.
 241   /// All fixed objects should be created before other objects are created for
 242   /// efficiency.  This returns an index with a negative value.
 243   ///
 244   int CreateFixedObject(unsigned Size, int SPOffset) {
 245     assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
 246     Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset));
 247     return -++NumFixedObjects;
 248   }
 249
 250   /// CreateStackObject - Create a new statically sized stack object, returning
 251   /// a postive identifier to represent it.
 252   ///
 253   int CreateStackObject(unsigned Size, unsigned Alignment) {
 254     // Keep track of the maximum alignment.
 255     if (MaxAlignment < Alignment) MaxAlignment = Alignment;
 256
 257     assert(Size != 0 && "Cannot allocate zero size stack objects!");
 258     Objects.push_back(StackObject(Size, Alignment, -1));
 259     return Objects.size()-NumFixedObjects-1;
 260   }
 261
 262   /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
 263   /// variable sized object has been created.  This must be created whenever a
 264   /// variable sized object is created, whether or not the index returned is
 265   /// actually used.
 266   ///
 267   int CreateVariableSizedObject() {
 268     HasVarSizedObjects = true;
 269     if (MaxAlignment < 1) MaxAlignment = 1;
 270     Objects.push_back(StackObject(0, 1, -1));
 271     return Objects.size()-NumFixedObjects-1;
 272   }
 273
 274   /// getCalleeSavedInfo - Returns a reference to call saved info vector for the
 275   /// current function.
 276   const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
 277     return CSInfo;
 278   }
 279
 280   /// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
 281   /// callee saved information.
 282   void  setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
 283     CSInfo = CSI;
 284   }
 285
 286   /// getMachineDebugInfo - Used by a prologue/epilogue emitter (MRegisterInfo)
 287   /// to provide frame layout information.
 288   MachineDebugInfo *getMachineDebugInfo() const { return DebugInfo; }
 289
 290   /// setMachineDebugInfo - Used by a debug consumer (DwarfWriter) to indicate
 291   /// that frame layout information should be gathered.
 292   void setMachineDebugInfo(MachineDebugInfo *DI) { DebugInfo = DI; }
 293
 294   /// print - Used by the MachineFunction printer to print information about
 295   /// stack objects.  Implemented in MachineFunction.cpp
 296   ///
 297   void print(const MachineFunction &MF, std::ostream &OS) const;
 298
 299   /// dump - Call print(MF, std::cerr) to be called from the debugger.
 300   void dump(const MachineFunction &MF) const;
 301 };
 302
 303 } // End llvm namespace
 304
 305 #endif