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
  24 /// The MachineFrameInfo class represents an abstract stack frame until
  25 /// prolog/epilog code is inserted.  This class is key to allowing stack frame
  26 /// representation optimizations, such as frame pointer elimination.  It also
  27 /// allows more mundane (but still important) optimizations, such as reordering
  28 /// of abstract objects on the stack frame.
  29 ///
  30 /// To support this, the class assigns unique integer identifiers to stack
  31 /// objects requested clients.  These identifiers are negative integers for
  32 /// fixed stack objects (such as arguments passed on the stack) or positive
  33 /// for objects that may be reordered.  Instructions which refer to stack
  34 /// objects use a special MO_FrameIndex operand to represent these frame
  35 /// indexes.
  36 ///
  37 /// Because this class keeps track of all references to the stack frame, it
  38 /// knows when a variable sized object is allocated on the stack.  This is the
  39 /// sole condition which prevents frame pointer elimination, which is an
  40 /// important optimization on register-poor architectures.  Because original
  41 /// variable sized alloca's in the source program are the only source of
  42 /// variable sized stack objects, it is safe to decide whether there will be
  43 /// any variable sized objects before all stack objects are known (for
  44 /// example, register allocator spill code never needs variable sized
  45 /// objects).
  46 ///
  47 /// When prolog/epilog code emission is performed, the final stack frame is
  48 /// built and the machine instructions are modified to refer to the actual
  49 /// stack offsets of the object, eliminating all MO_FrameIndex operands from
  50 /// the program.
  51 ///
  52 /// @brief Abstract Stack Frame Information
  53 class MachineFrameInfo {
  54
  55   // StackObject - Represent a single object allocated on the stack.
  56   struct StackObject {
  57     // The size of this object on the stack. 0 means a variable sized object
  58     unsigned Size;
  59
  60     // Alignment - The required alignment of this stack slot.
  61     unsigned Alignment;
  62
  63     // SPOffset - The offset of this object from the stack pointer on entry to
  64     // the function.  This field has no meaning for a variable sized element.
  65     int SPOffset;
  66
  67     StackObject(unsigned Sz, unsigned Al, int SP)
  68       : Size(Sz), Alignment(Al), SPOffset(SP) {}
  69   };
  70
  71   /// Objects - The list of stack objects allocated...
  72   ///
  73   std::vector<StackObject> Objects;
  74
  75   /// NumFixedObjects - This contains the number of fixed objects contained on
  76   /// the stack.  Because fixed objects are stored at a negative index in the
  77   /// Objects list, this is also the index to the 0th object in the list.
  78   ///
  79   unsigned NumFixedObjects;
  80
  81   /// HasVarSizedObjects - This boolean keeps track of whether any variable
  82   /// sized objects have been allocated yet.
  83   ///
  84   bool HasVarSizedObjects;
  85
  86   /// StackSize - The prolog/epilog code inserter calculates the final stack
  87   /// offsets for all of the fixed size objects, updating the Objects list
  88   /// above.  It then updates StackSize to contain the number of bytes that need
  89   /// to be allocated on entry to the function.
  90   ///
  91   unsigned StackSize;
  92
  93   /// MaxAlignment - The prolog/epilog code inserter may process objects
  94   /// that require greater alignment than the default alignment the target
  95   /// provides. To handle this, MaxAlignment is set to the maximum alignment
  96   /// needed by the objects on the current frame.  If this is greater than the
  97   /// native alignment maintained by the compiler, dynamic alignment code will
  98   /// be needed.
  99   ///
 100   unsigned MaxAlignment;
 101
 102   /// HasCalls - Set to true if this function has any function calls.  This is
 103   /// only valid during and after prolog/epilog code insertion.
 104   bool HasCalls;
 105
 106   /// MaxCallFrameSize - This contains the size of the largest call frame if the
 107   /// target uses frame setup/destroy pseudo instructions (as defined in the
 108   /// TargetFrameInfo class).  This information is important for frame pointer
 109   /// elimination.  If is only valid during and after prolog/epilog code
 110   /// insertion.
 111   ///
 112   unsigned MaxCallFrameSize;
 113
 114   /// DebugInfo - This field is set (via setMachineDebugInfo) by a debug info
 115   /// consumer (ex. DwarfWriter) to indicate that frame layout information
 116   /// should be acquired.  Typically, it's the responsibility of the target's
 117   /// MRegisterInfo prologue/epilogue emitting code to inform MachineDebugInfo
 118   /// of frame layouts.
 119   MachineDebugInfo *DebugInfo;
 120
 121 public:
 122   MachineFrameInfo() {
 123     NumFixedObjects = StackSize = MaxAlignment = 0;
 124     HasVarSizedObjects = false;
 125     HasCalls = false;
 126     MaxCallFrameSize = 0;
 127     DebugInfo = 0;
 128   }
 129
 130   /// hasStackObjects - Return true if there are any stack objects in this
 131   /// function.
 132   ///
 133   bool hasStackObjects() const { return !Objects.empty(); }
 134
 135   /// hasVarSizedObjects - This method may be called any time after instruction
 136   /// selection is complete to determine if the stack frame for this function
 137   /// contains any variable sized objects.
 138   ///
 139   bool hasVarSizedObjects() const { return HasVarSizedObjects; }
 140
 141   /// getObjectIndexBegin - Return the minimum frame object index...
 142   ///
 143   int getObjectIndexBegin() const { return -NumFixedObjects; }
 144
 145   /// getObjectIndexEnd - Return one past the maximum frame object index...
 146   ///
 147   int getObjectIndexEnd() const { return Objects.size()-NumFixedObjects; }
 148
 149   /// getObjectSize - Return the size of the specified object
 150   ///
 151   int getObjectSize(int ObjectIdx) const {
 152     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 153     return Objects[ObjectIdx+NumFixedObjects].Size;
 154   }
 155
 156   /// getObjectAlignment - Return the alignment of the specified stack object...
 157   int getObjectAlignment(int ObjectIdx) const {
 158     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 159     return Objects[ObjectIdx+NumFixedObjects].Alignment;
 160   }
 161
 162   /// getObjectOffset - Return the assigned stack offset of the specified object
 163   /// from the incoming stack pointer.
 164   ///
 165   int getObjectOffset(int ObjectIdx) const {
 166     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 167     return Objects[ObjectIdx+NumFixedObjects].SPOffset;
 168   }
 169
 170   /// setObjectOffset - Set the stack frame offset of the specified object.  The
 171   /// offset is relative to the stack pointer on entry to the function.
 172   ///
 173   void setObjectOffset(int ObjectIdx, int SPOffset) {
 174     assert(ObjectIdx+NumFixedObjects < Objects.size() && "Invalid Object Idx!");
 175     Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
 176   }
 177
 178   /// getStackSize - Return the number of bytes that must be allocated to hold
 179   /// all of the fixed size frame objects.  This is only valid after
 180   /// Prolog/Epilog code insertion has finalized the stack frame layout.
 181   ///
 182   unsigned getStackSize() const { return StackSize; }
 183
 184   /// setStackSize - Set the size of the stack...
 185   ///
 186   void setStackSize(unsigned Size) { StackSize = Size; }
 187
 188   /// getMaxAlignment - Return the alignment in bytes that this function must be
 189   /// aligned to, which is greater than the default stack alignment provided by
 190   /// the target.
 191   ///
 192   unsigned getMaxAlignment() const { return MaxAlignment; }
 193
 194   /// setMaxAlignment - Set the preferred alignment.
 195   ///
 196   void setMaxAlignment(unsigned Align) { MaxAlignment = Align; }
 197
 198   /// hasCalls - Return true if the current function has no function calls.
 199   /// This is only valid during or after prolog/epilog code emission.
 200   ///
 201   bool hasCalls() const { return HasCalls; }
 202   void setHasCalls(bool V) { HasCalls = V; }
 203
 204   /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
 205   /// allocated for an outgoing function call.  This is only available if
 206   /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
 207   /// then only during or after prolog/epilog code insertion.
 208   ///
 209   unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
 210   void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
 211
 212   /// CreateFixedObject - Create a new object at a fixed location on the stack.
 213   /// All fixed objects should be created before other objects are created for
 214   /// efficiency.  This returns an index with a negative value.
 215   ///
 216   int CreateFixedObject(unsigned Size, int SPOffset) {
 217     assert(Size != 0 && "Cannot allocate zero size fixed stack objects!");
 218     Objects.insert(Objects.begin(), StackObject(Size, 1, SPOffset));
 219     return -++NumFixedObjects;
 220   }
 221
 222   /// CreateStackObject - Create a new statically sized stack object, returning
 223   /// a postive identifier to represent it.
 224   ///
 225   int CreateStackObject(unsigned Size, unsigned Alignment) {
 226     // Keep track of the maximum alignment.
 227     if (MaxAlignment < Alignment) MaxAlignment = Alignment;
 228
 229     assert(Size != 0 && "Cannot allocate zero size stack objects!");
 230     Objects.push_back(StackObject(Size, Alignment, -1));
 231     return Objects.size()-NumFixedObjects-1;
 232   }
 233
 234   /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
 235   /// variable sized object has been created.  This must be created whenever a
 236   /// variable sized object is created, whether or not the index returned is
 237   /// actually used.
 238   ///
 239   int CreateVariableSizedObject() {
 240     HasVarSizedObjects = true;
 241     if (MaxAlignment < 1) MaxAlignment = 1;
 242     Objects.push_back(StackObject(0, 1, -1));
 243     return Objects.size()-NumFixedObjects-1;
 244   }
 245
 246   /// getMachineDebugInfo - Used by a prologue/epilogue emitter (MRegisterInfo)
 247   /// to provide frame layout information.
 248   MachineDebugInfo *getMachineDebugInfo() const { return DebugInfo; }
 249
 250   /// setMachineDebugInfo - Used by a debug consumer (DwarfWriter) to indicate
 251   /// that frame layout information should be gathered.
 252   void setMachineDebugInfo(MachineDebugInfo *DI) { DebugInfo = DI; }
 253
 254   /// print - Used by the MachineFunction printer to print information about
 255   /// stack objects.  Implemented in MachineFunction.cpp
 256   ///
 257   void print(const MachineFunction &MF, std::ostream &OS) const;
 258
 259   /// dump - Call print(MF, std::cerr) to be called from the debugger.
 260   void dump(const MachineFunction &MF) const;
 261 };
 262
 263 } // End llvm namespace
 264
 265 #endif