include/llvm/CodeGen/MachineFrameInfo.h

   1 //===-- CodeGen/MachineFrameInfo.h - Abstract Stack Frame Rep. --*- 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 // The file defines the MachineFrameInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CODEGEN_MACHINEFRAMEINFO_H
  15 #define LLVM_CODEGEN_MACHINEFRAMEINFO_H
  16
  17 #include "llvm/ADT/SmallVector.h"
  18 #include "llvm/System/DataTypes.h"
  19 #include <cassert>
  20 #include <vector>
  21
  22 namespace llvm {
  23 class raw_ostream;
  24 class TargetData;
  25 class TargetRegisterClass;
  26 class Type;
  27 class MachineFunction;
  28 class MachineBasicBlock;
  29 class TargetFrameInfo;
  30 class BitVector;
  31
  32 /// The CalleeSavedInfo class tracks the information need to locate where a
  33 /// callee saved register in the current frame.
  34 class CalleeSavedInfo {
  35   unsigned Reg;
  36   int FrameIdx;
  37
  38 public:
  39   CalleeSavedInfo(unsigned R, int FI = 0)
  40   : Reg(R), FrameIdx(FI) {}
  41
  42   // Accessors.
  43   unsigned getReg()                        const { return Reg; }
  44   int getFrameIdx()                        const { return FrameIdx; }
  45   void setFrameIdx(int FI)                       { FrameIdx = FI; }
  46 };
  47
  48 /// The MachineFrameInfo class represents an abstract stack frame until
  49 /// prolog/epilog code is inserted.  This class is key to allowing stack frame
  50 /// representation optimizations, such as frame pointer elimination.  It also
  51 /// allows more mundane (but still important) optimizations, such as reordering
  52 /// of abstract objects on the stack frame.
  53 ///
  54 /// To support this, the class assigns unique integer identifiers to stack
  55 /// objects requested clients.  These identifiers are negative integers for
  56 /// fixed stack objects (such as arguments passed on the stack) or nonnegative
  57 /// for objects that may be reordered.  Instructions which refer to stack
  58 /// objects use a special MO_FrameIndex operand to represent these frame
  59 /// indexes.
  60 ///
  61 /// Because this class keeps track of all references to the stack frame, it
  62 /// knows when a variable sized object is allocated on the stack.  This is the
  63 /// sole condition which prevents frame pointer elimination, which is an
  64 /// important optimization on register-poor architectures.  Because original
  65 /// variable sized alloca's in the source program are the only source of
  66 /// variable sized stack objects, it is safe to decide whether there will be
  67 /// any variable sized objects before all stack objects are known (for
  68 /// example, register allocator spill code never needs variable sized
  69 /// objects).
  70 ///
  71 /// When prolog/epilog code emission is performed, the final stack frame is
  72 /// built and the machine instructions are modified to refer to the actual
  73 /// stack offsets of the object, eliminating all MO_FrameIndex operands from
  74 /// the program.
  75 ///
  76 /// @brief Abstract Stack Frame Information
  77 class MachineFrameInfo {
  78
  79   // StackObject - Represent a single object allocated on the stack.
  80   struct StackObject {
  81     // SPOffset - The offset of this object from the stack pointer on entry to
  82     // the function.  This field has no meaning for a variable sized element.
  83     int64_t SPOffset;
  84
  85     // The size of this object on the stack. 0 means a variable sized object,
  86     // ~0ULL means a dead object.
  87     uint64_t Size;
  88
  89     // Alignment - The required alignment of this stack slot.
  90     unsigned Alignment;
  91
  92     // isImmutable - If true, the value of the stack object is set before
  93     // entering the function and is not modified inside the function. By
  94     // default, fixed objects are immutable unless marked otherwise.
  95     bool isImmutable;
  96
  97     // isSpillSlot - If true, the stack object is used as spill slot. It
  98     // cannot alias any other memory objects.
  99     bool isSpillSlot;
 100
 101     StackObject(uint64_t Sz, unsigned Al, int64_t SP, bool IM,
 102                 bool isSS)
 103       : SPOffset(SP), Size(Sz), Alignment(Al), isImmutable(IM),
 104         isSpillSlot(isSS) {}
 105   };
 106
 107   /// Objects - The list of stack objects allocated...
 108   ///
 109   std::vector<StackObject> Objects;
 110
 111   /// NumFixedObjects - This contains the number of fixed objects contained on
 112   /// the stack.  Because fixed objects are stored at a negative index in the
 113   /// Objects list, this is also the index to the 0th object in the list.
 114   ///
 115   unsigned NumFixedObjects;
 116
 117   /// HasVarSizedObjects - This boolean keeps track of whether any variable
 118   /// sized objects have been allocated yet.
 119   ///
 120   bool HasVarSizedObjects;
 121
 122   /// FrameAddressTaken - This boolean keeps track of whether there is a call
 123   /// to builtin \@llvm.frameaddress.
 124   bool FrameAddressTaken;
 125
 126   /// ReturnAddressTaken - This boolean keeps track of whether there is a call
 127   /// to builtin \@llvm.returnaddress.
 128   bool ReturnAddressTaken;
 129
 130   /// StackSize - The prolog/epilog code inserter calculates the final stack
 131   /// offsets for all of the fixed size objects, updating the Objects list
 132   /// above.  It then updates StackSize to contain the number of bytes that need
 133   /// to be allocated on entry to the function.
 134   ///
 135   uint64_t StackSize;
 136
 137   /// OffsetAdjustment - The amount that a frame offset needs to be adjusted to
 138   /// have the actual offset from the stack/frame pointer.  The exact usage of
 139   /// this is target-dependent, but it is typically used to adjust between
 140   /// SP-relative and FP-relative offsets.  E.G., if objects are accessed via
 141   /// SP then OffsetAdjustment is zero; if FP is used, OffsetAdjustment is set
 142   /// to the distance between the initial SP and the value in FP.  For many
 143   /// targets, this value is only used when generating debug info (via
 144   /// TargetRegisterInfo::getFrameIndexOffset); when generating code, the
 145   /// corresponding adjustments are performed directly.
 146   int OffsetAdjustment;
 147
 148   /// MaxAlignment - The prolog/epilog code inserter may process objects
 149   /// that require greater alignment than the default alignment the target
 150   /// provides. To handle this, MaxAlignment is set to the maximum alignment
 151   /// needed by the objects on the current frame.  If this is greater than the
 152   /// native alignment maintained by the compiler, dynamic alignment code will
 153   /// be needed.
 154   ///
 155   unsigned MaxAlignment;
 156
 157   /// AdjustsStack - Set to true if this function adjusts the stack -- e.g.,
 158   /// when calling another function. This is only valid during and after
 159   /// prolog/epilog code insertion.
 160   bool AdjustsStack;
 161
 162   /// HasCalls - Set to true if this function has any function calls.
 163   bool HasCalls;
 164
 165   /// StackProtectorIdx - The frame index for the stack protector.
 166   int StackProtectorIdx;
 167
 168   /// MaxCallFrameSize - This contains the size of the largest call frame if the
 169   /// target uses frame setup/destroy pseudo instructions (as defined in the
 170   /// TargetFrameInfo class).  This information is important for frame pointer
 171   /// elimination.  If is only valid during and after prolog/epilog code
 172   /// insertion.
 173   ///
 174   unsigned MaxCallFrameSize;
 175
 176   /// CSInfo - The prolog/epilog code inserter fills in this vector with each
 177   /// callee saved register saved in the frame.  Beyond its use by the prolog/
 178   /// epilog code inserter, this data used for debug info and exception
 179   /// handling.
 180   std::vector<CalleeSavedInfo> CSInfo;
 181
 182   /// CSIValid - Has CSInfo been set yet?
 183   bool CSIValid;
 184
 185   /// SpillObjects - A vector indicating which frame indices refer to
 186   /// spill slots.
 187   SmallVector<bool, 8> SpillObjects;
 188
 189   /// TargetFrameInfo - Target information about frame layout.
 190   ///
 191   const TargetFrameInfo &TFI;
 192
 193 public:
 194   explicit MachineFrameInfo(const TargetFrameInfo &tfi) : TFI(tfi) {
 195     StackSize = NumFixedObjects = OffsetAdjustment = MaxAlignment = 0;
 196     HasVarSizedObjects = false;
 197     FrameAddressTaken = false;
 198     ReturnAddressTaken = false;
 199     AdjustsStack = false;
 200     HasCalls = false;
 201     StackProtectorIdx = -1;
 202     MaxCallFrameSize = 0;
 203     CSIValid = false;
 204   }
 205
 206   /// hasStackObjects - Return true if there are any stack objects in this
 207   /// function.
 208   ///
 209   bool hasStackObjects() const { return !Objects.empty(); }
 210
 211   /// hasVarSizedObjects - This method may be called any time after instruction
 212   /// selection is complete to determine if the stack frame for this function
 213   /// contains any variable sized objects.
 214   ///
 215   bool hasVarSizedObjects() const { return HasVarSizedObjects; }
 216
 217   /// getStackProtectorIndex/setStackProtectorIndex - Return the index for the
 218   /// stack protector object.
 219   ///
 220   int getStackProtectorIndex() const { return StackProtectorIdx; }
 221   void setStackProtectorIndex(int I) { StackProtectorIdx = I; }
 222
 223   /// isFrameAddressTaken - This method may be called any time after instruction
 224   /// selection is complete to determine if there is a call to
 225   /// \@llvm.frameaddress in this function.
 226   bool isFrameAddressTaken() const { return FrameAddressTaken; }
 227   void setFrameAddressIsTaken(bool T) { FrameAddressTaken = T; }
 228
 229   /// isReturnAddressTaken - This method may be called any time after instruction
 230   /// selection is complete to determine if there is a call to
 231   /// \@llvm.returnaddress in this function.
 232   bool isReturnAddressTaken() const { return ReturnAddressTaken; }
 233   void setReturnAddressIsTaken(bool s) { ReturnAddressTaken = s; }
 234
 235   /// getObjectIndexBegin - Return the minimum frame object index.
 236   ///
 237   int getObjectIndexBegin() const { return -NumFixedObjects; }
 238
 239   /// getObjectIndexEnd - Return one past the maximum frame object index.
 240   ///
 241   int getObjectIndexEnd() const { return (int)Objects.size()-NumFixedObjects; }
 242
 243   /// getNumFixedObjects() - Return the number of fixed objects.
 244   unsigned getNumFixedObjects() const { return NumFixedObjects; }
 245
 246   /// getNumObjects() - Return the number of objects.
 247   ///
 248   unsigned getNumObjects() const { return Objects.size(); }
 249
 250   /// getObjectSize - Return the size of the specified object.
 251   ///
 252   int64_t getObjectSize(int ObjectIdx) const {
 253     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 254            "Invalid Object Idx!");
 255     return Objects[ObjectIdx+NumFixedObjects].Size;
 256   }
 257
 258   /// setObjectSize - Change the size of the specified stack object.
 259   void setObjectSize(int ObjectIdx, int64_t Size) {
 260     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 261            "Invalid Object Idx!");
 262     Objects[ObjectIdx+NumFixedObjects].Size = Size;
 263   }
 264
 265   /// getObjectAlignment - Return the alignment of the specified stack object.
 266   unsigned getObjectAlignment(int ObjectIdx) const {
 267     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 268            "Invalid Object Idx!");
 269     return Objects[ObjectIdx+NumFixedObjects].Alignment;
 270   }
 271
 272   /// setObjectAlignment - Change the alignment of the specified stack object.
 273   void setObjectAlignment(int ObjectIdx, unsigned Align) {
 274     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 275            "Invalid Object Idx!");
 276     Objects[ObjectIdx+NumFixedObjects].Alignment = Align;
 277     MaxAlignment = std::max(MaxAlignment, Align);
 278   }
 279
 280   /// getObjectOffset - Return the assigned stack offset of the specified object
 281   /// from the incoming stack pointer.
 282   ///
 283   int64_t getObjectOffset(int ObjectIdx) const {
 284     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 285            "Invalid Object Idx!");
 286     assert(!isDeadObjectIndex(ObjectIdx) &&
 287            "Getting frame offset for a dead object?");
 288     return Objects[ObjectIdx+NumFixedObjects].SPOffset;
 289   }
 290
 291   /// setObjectOffset - Set the stack frame offset of the specified object.  The
 292   /// offset is relative to the stack pointer on entry to the function.
 293   ///
 294   void setObjectOffset(int ObjectIdx, int64_t SPOffset) {
 295     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 296            "Invalid Object Idx!");
 297     assert(!isDeadObjectIndex(ObjectIdx) &&
 298            "Setting frame offset for a dead object?");
 299     Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
 300   }
 301
 302   /// getStackSize - Return the number of bytes that must be allocated to hold
 303   /// all of the fixed size frame objects.  This is only valid after
 304   /// Prolog/Epilog code insertion has finalized the stack frame layout.
 305   ///
 306   uint64_t getStackSize() const { return StackSize; }
 307
 308   /// setStackSize - Set the size of the stack...
 309   ///
 310   void setStackSize(uint64_t Size) { StackSize = Size; }
 311
 312   /// getOffsetAdjustment - Return the correction for frame offsets.
 313   ///
 314   int getOffsetAdjustment() const { return OffsetAdjustment; }
 315
 316   /// setOffsetAdjustment - Set the correction for frame offsets.
 317   ///
 318   void setOffsetAdjustment(int Adj) { OffsetAdjustment = Adj; }
 319
 320   /// getMaxAlignment - Return the alignment in bytes that this function must be
 321   /// aligned to, which is greater than the default stack alignment provided by
 322   /// the target.
 323   ///
 324   unsigned getMaxAlignment() const { return MaxAlignment; }
 325
 326   /// setMaxAlignment - Set the preferred alignment.
 327   ///
 328   void setMaxAlignment(unsigned Align) { MaxAlignment = Align; }
 329
 330   /// AdjustsStack - Return true if this function adjusts the stack -- e.g.,
 331   /// when calling another function. This is only valid during and after
 332   /// prolog/epilog code insertion.
 333   bool adjustsStack() const { return AdjustsStack; }
 334   void setAdjustsStack(bool V) { AdjustsStack = V; }
 335
 336   /// hasCalls - Return true if the current function has any function calls.
 337   bool hasCalls() const { return HasCalls; }
 338   void setHasCalls(bool V) { HasCalls = V; }
 339
 340   /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
 341   /// allocated for an outgoing function call.  This is only available if
 342   /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
 343   /// then only during or after prolog/epilog code insertion.
 344   ///
 345   unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
 346   void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
 347
 348   /// CreateFixedObject - Create a new object at a fixed location on the stack.
 349   /// All fixed objects should be created before other objects are created for
 350   /// efficiency. By default, fixed objects are immutable. This returns an
 351   /// index with a negative value.
 352   ///
 353   int CreateFixedObject(uint64_t Size, int64_t SPOffset,
 354                         bool Immutable, bool isSS);
 355
 356
 357   /// isFixedObjectIndex - Returns true if the specified index corresponds to a
 358   /// fixed stack object.
 359   bool isFixedObjectIndex(int ObjectIdx) const {
 360     return ObjectIdx < 0 && (ObjectIdx >= -(int)NumFixedObjects);
 361   }
 362
 363   /// isImmutableObjectIndex - Returns true if the specified index corresponds
 364   /// to an immutable object.
 365   bool isImmutableObjectIndex(int ObjectIdx) const {
 366     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 367            "Invalid Object Idx!");
 368     return Objects[ObjectIdx+NumFixedObjects].isImmutable;
 369   }
 370
 371   /// isSpillSlotObjectIndex - Returns true if the specified index corresponds
 372   /// to a spill slot..
 373   bool isSpillSlotObjectIndex(int ObjectIdx) const {
 374     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 375            "Invalid Object Idx!");
 376     return Objects[ObjectIdx+NumFixedObjects].isSpillSlot;;
 377   }
 378
 379   /// isDeadObjectIndex - Returns true if the specified index corresponds to
 380   /// a dead object.
 381   bool isDeadObjectIndex(int ObjectIdx) const {
 382     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 383            "Invalid Object Idx!");
 384     return Objects[ObjectIdx+NumFixedObjects].Size == ~0ULL;
 385   }
 386
 387   /// CreateStackObject - Create a new statically sized stack object,
 388   /// returning a nonnegative identifier to represent it.
 389   ///
 390   int CreateStackObject(uint64_t Size, unsigned Alignment, bool isSS) {
 391     assert(Size != 0 && "Cannot allocate zero size stack objects!");
 392     Objects.push_back(StackObject(Size, Alignment, 0, false, isSS));
 393     int Index = (int)Objects.size()-NumFixedObjects-1;
 394     assert(Index >= 0 && "Bad frame index!");
 395     MaxAlignment = std::max(MaxAlignment, Alignment);
 396     return Index;
 397   }
 398
 399   /// CreateSpillStackObject - Create a new statically sized stack
 400   /// object that represents a spill slot, returning a nonnegative
 401   /// identifier to represent it.
 402   ///
 403   int CreateSpillStackObject(uint64_t Size, unsigned Alignment) {
 404     CreateStackObject(Size, Alignment, true);
 405     int Index = (int)Objects.size()-NumFixedObjects-1;
 406     MaxAlignment = std::max(MaxAlignment, Alignment);
 407     return Index;
 408   }
 409
 410   /// RemoveStackObject - Remove or mark dead a statically sized stack object.
 411   ///
 412   void RemoveStackObject(int ObjectIdx) {
 413     // Mark it dead.
 414     Objects[ObjectIdx+NumFixedObjects].Size = ~0ULL;
 415   }
 416
 417   /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
 418   /// variable sized object has been created.  This must be created whenever a
 419   /// variable sized object is created, whether or not the index returned is
 420   /// actually used.
 421   ///
 422   int CreateVariableSizedObject() {
 423     HasVarSizedObjects = true;
 424     Objects.push_back(StackObject(0, 1, 0, false, false));
 425     return (int)Objects.size()-NumFixedObjects-1;
 426   }
 427
 428   /// getCalleeSavedInfo - Returns a reference to call saved info vector for the
 429   /// current function.
 430   const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
 431     return CSInfo;
 432   }
 433
 434   /// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
 435   /// callee saved information.
 436   void  setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
 437     CSInfo = CSI;
 438   }
 439
 440   /// isCalleeSavedInfoValid - Has the callee saved info been calculated yet?
 441   bool isCalleeSavedInfoValid() const { return CSIValid; }
 442
 443   void setCalleeSavedInfoValid(bool v) { CSIValid = v; }
 444
 445   /// getPristineRegs - Return a set of physical registers that are pristine on
 446   /// entry to the MBB.
 447   ///
 448   /// Pristine registers hold a value that is useless to the current function,
 449   /// but that must be preserved - they are callee saved registers that have not
 450   /// been saved yet.
 451   ///
 452   /// Before the PrologueEpilogueInserter has placed the CSR spill code, this
 453   /// method always returns an empty set.
 454   BitVector getPristineRegs(const MachineBasicBlock *MBB) const;
 455
 456   /// print - Used by the MachineFunction printer to print information about
 457   /// stack objects.  Implemented in MachineFunction.cpp
 458   ///
 459   void print(const MachineFunction &MF, raw_ostream &OS) const;
 460
 461   /// dump - Print the function to stderr.
 462   void dump(const MachineFunction &MF) const;
 463 };
 464
 465 } // End llvm namespace
 466
 467 #endif