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