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   explicit 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     // MayNeedSP - If true the stack object triggered the creation of the stack
 102     // protector. We should allocate this object right after the stack
 103     // protector.
 104     bool MayNeedSP;
 105
 106     StackObject(uint64_t Sz, unsigned Al, int64_t SP, bool IM,
 107                 bool isSS, bool NSP)
 108       : SPOffset(SP), Size(Sz), Alignment(Al), isImmutable(IM),
 109         isSpillSlot(isSS), MayNeedSP(NSP) {}
 110   };
 111
 112   /// Objects - The list of stack objects allocated...
 113   ///
 114   std::vector<StackObject> Objects;
 115
 116   /// NumFixedObjects - This contains the number of fixed objects contained on
 117   /// the stack.  Because fixed objects are stored at a negative index in the
 118   /// Objects list, this is also the index to the 0th object in the list.
 119   ///
 120   unsigned NumFixedObjects;
 121
 122   /// HasVarSizedObjects - This boolean keeps track of whether any variable
 123   /// sized objects have been allocated yet.
 124   ///
 125   bool HasVarSizedObjects;
 126
 127   /// FrameAddressTaken - This boolean keeps track of whether there is a call
 128   /// to builtin \@llvm.frameaddress.
 129   bool FrameAddressTaken;
 130
 131   /// ReturnAddressTaken - This boolean keeps track of whether there is a call
 132   /// to builtin \@llvm.returnaddress.
 133   bool ReturnAddressTaken;
 134
 135   /// StackSize - The prolog/epilog code inserter calculates the final stack
 136   /// offsets for all of the fixed size objects, updating the Objects list
 137   /// above.  It then updates StackSize to contain the number of bytes that need
 138   /// to be allocated on entry to the function.
 139   ///
 140   uint64_t StackSize;
 141
 142   /// OffsetAdjustment - The amount that a frame offset needs to be adjusted to
 143   /// have the actual offset from the stack/frame pointer.  The exact usage of
 144   /// this is target-dependent, but it is typically used to adjust between
 145   /// SP-relative and FP-relative offsets.  E.G., if objects are accessed via
 146   /// SP then OffsetAdjustment is zero; if FP is used, OffsetAdjustment is set
 147   /// to the distance between the initial SP and the value in FP.  For many
 148   /// targets, this value is only used when generating debug info (via
 149   /// TargetRegisterInfo::getFrameIndexOffset); when generating code, the
 150   /// corresponding adjustments are performed directly.
 151   int OffsetAdjustment;
 152
 153   /// MaxAlignment - The prolog/epilog code inserter may process objects
 154   /// that require greater alignment than the default alignment the target
 155   /// provides. To handle this, MaxAlignment is set to the maximum alignment
 156   /// needed by the objects on the current frame.  If this is greater than the
 157   /// native alignment maintained by the compiler, dynamic alignment code will
 158   /// be needed.
 159   ///
 160   unsigned MaxAlignment;
 161
 162   /// AdjustsStack - Set to true if this function adjusts the stack -- e.g.,
 163   /// when calling another function. This is only valid during and after
 164   /// prolog/epilog code insertion.
 165   bool AdjustsStack;
 166
 167   /// HasCalls - Set to true if this function has any function calls.
 168   bool HasCalls;
 169
 170   /// StackProtectorIdx - The frame index for the stack protector.
 171   int StackProtectorIdx;
 172
 173   /// MaxCallFrameSize - This contains the size of the largest call frame if the
 174   /// target uses frame setup/destroy pseudo instructions (as defined in the
 175   /// TargetFrameInfo class).  This information is important for frame pointer
 176   /// elimination.  If is only valid during and after prolog/epilog code
 177   /// insertion.
 178   ///
 179   unsigned MaxCallFrameSize;
 180
 181   /// CSInfo - The prolog/epilog code inserter fills in this vector with each
 182   /// callee saved register saved in the frame.  Beyond its use by the prolog/
 183   /// epilog code inserter, this data used for debug info and exception
 184   /// handling.
 185   std::vector<CalleeSavedInfo> CSInfo;
 186
 187   /// CSIValid - Has CSInfo been set yet?
 188   bool CSIValid;
 189
 190   /// SpillObjects - A vector indicating which frame indices refer to
 191   /// spill slots.
 192   SmallVector<bool, 8> SpillObjects;
 193
 194   /// TargetFrameInfo - Target information about frame layout.
 195   ///
 196   const TargetFrameInfo &TFI;
 197
 198 public:
 199   explicit MachineFrameInfo(const TargetFrameInfo &tfi) : TFI(tfi) {
 200     StackSize = NumFixedObjects = OffsetAdjustment = MaxAlignment = 0;
 201     HasVarSizedObjects = false;
 202     FrameAddressTaken = false;
 203     ReturnAddressTaken = false;
 204     AdjustsStack = false;
 205     HasCalls = false;
 206     StackProtectorIdx = -1;
 207     MaxCallFrameSize = 0;
 208     CSIValid = false;
 209   }
 210
 211   /// hasStackObjects - Return true if there are any stack objects in this
 212   /// function.
 213   ///
 214   bool hasStackObjects() const { return !Objects.empty(); }
 215
 216   /// hasVarSizedObjects - This method may be called any time after instruction
 217   /// selection is complete to determine if the stack frame for this function
 218   /// contains any variable sized objects.
 219   ///
 220   bool hasVarSizedObjects() const { return HasVarSizedObjects; }
 221
 222   /// getStackProtectorIndex/setStackProtectorIndex - Return the index for the
 223   /// stack protector object.
 224   ///
 225   int getStackProtectorIndex() const { return StackProtectorIdx; }
 226   void setStackProtectorIndex(int I) { StackProtectorIdx = I; }
 227
 228   /// isFrameAddressTaken - This method may be called any time after instruction
 229   /// selection is complete to determine if there is a call to
 230   /// \@llvm.frameaddress in this function.
 231   bool isFrameAddressTaken() const { return FrameAddressTaken; }
 232   void setFrameAddressIsTaken(bool T) { FrameAddressTaken = T; }
 233
 234   /// isReturnAddressTaken - This method may be called any time after
 235   /// instruction selection is complete to determine if there is a call to
 236   /// \@llvm.returnaddress in this function.
 237   bool isReturnAddressTaken() const { return ReturnAddressTaken; }
 238   void setReturnAddressIsTaken(bool s) { ReturnAddressTaken = s; }
 239
 240   /// getObjectIndexBegin - Return the minimum frame object index.
 241   ///
 242   int getObjectIndexBegin() const { return -NumFixedObjects; }
 243
 244   /// getObjectIndexEnd - Return one past the maximum frame object index.
 245   ///
 246   int getObjectIndexEnd() const { return (int)Objects.size()-NumFixedObjects; }
 247
 248   /// getNumFixedObjects() - Return the number of fixed objects.
 249   unsigned getNumFixedObjects() const { return NumFixedObjects; }
 250
 251   /// getNumObjects() - Return the number of objects.
 252   ///
 253   unsigned getNumObjects() const { return Objects.size(); }
 254
 255   /// getObjectSize - Return the size of the specified object.
 256   ///
 257   int64_t getObjectSize(int ObjectIdx) const {
 258     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 259            "Invalid Object Idx!");
 260     return Objects[ObjectIdx+NumFixedObjects].Size;
 261   }
 262
 263   /// setObjectSize - Change the size of the specified stack object.
 264   void setObjectSize(int ObjectIdx, int64_t Size) {
 265     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 266            "Invalid Object Idx!");
 267     Objects[ObjectIdx+NumFixedObjects].Size = Size;
 268   }
 269
 270   /// getObjectAlignment - Return the alignment of the specified stack object.
 271   unsigned getObjectAlignment(int ObjectIdx) const {
 272     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 273            "Invalid Object Idx!");
 274     return Objects[ObjectIdx+NumFixedObjects].Alignment;
 275   }
 276
 277   /// setObjectAlignment - Change the alignment of the specified stack object.
 278   void setObjectAlignment(int ObjectIdx, unsigned Align) {
 279     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 280            "Invalid Object Idx!");
 281     Objects[ObjectIdx+NumFixedObjects].Alignment = Align;
 282     MaxAlignment = std::max(MaxAlignment, Align);
 283   }
 284
 285   /// NeedsStackProtector - Returns true if the object may need stack
 286   /// protectors.
 287   bool MayNeedStackProtector(int ObjectIdx) const {
 288     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 289            "Invalid Object Idx!");
 290     return Objects[ObjectIdx+NumFixedObjects].MayNeedSP;
 291   }
 292
 293   /// getObjectOffset - Return the assigned stack offset of the specified object
 294   /// from the incoming stack pointer.
 295   ///
 296   int64_t getObjectOffset(int ObjectIdx) const {
 297     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 298            "Invalid Object Idx!");
 299     assert(!isDeadObjectIndex(ObjectIdx) &&
 300            "Getting frame offset for a dead object?");
 301     return Objects[ObjectIdx+NumFixedObjects].SPOffset;
 302   }
 303
 304   /// setObjectOffset - Set the stack frame offset of the specified object.  The
 305   /// offset is relative to the stack pointer on entry to the function.
 306   ///
 307   void setObjectOffset(int ObjectIdx, int64_t SPOffset) {
 308     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 309            "Invalid Object Idx!");
 310     assert(!isDeadObjectIndex(ObjectIdx) &&
 311            "Setting frame offset for a dead object?");
 312     Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
 313   }
 314
 315   /// getStackSize - Return the number of bytes that must be allocated to hold
 316   /// all of the fixed size frame objects.  This is only valid after
 317   /// Prolog/Epilog code insertion has finalized the stack frame layout.
 318   ///
 319   uint64_t getStackSize() const { return StackSize; }
 320
 321   /// setStackSize - Set the size of the stack...
 322   ///
 323   void setStackSize(uint64_t Size) { StackSize = Size; }
 324
 325   /// getOffsetAdjustment - Return the correction for frame offsets.
 326   ///
 327   int getOffsetAdjustment() const { return OffsetAdjustment; }
 328
 329   /// setOffsetAdjustment - Set the correction for frame offsets.
 330   ///
 331   void setOffsetAdjustment(int Adj) { OffsetAdjustment = Adj; }
 332
 333   /// getMaxAlignment - Return the alignment in bytes that this function must be
 334   /// aligned to, which is greater than the default stack alignment provided by
 335   /// the target.
 336   ///
 337   unsigned getMaxAlignment() const { return MaxAlignment; }
 338
 339   /// setMaxAlignment - Set the preferred alignment.
 340   ///
 341   void setMaxAlignment(unsigned Align) { MaxAlignment = Align; }
 342
 343   /// AdjustsStack - Return true if this function adjusts the stack -- e.g.,
 344   /// when calling another function. This is only valid during and after
 345   /// prolog/epilog code insertion.
 346   bool adjustsStack() const { return AdjustsStack; }
 347   void setAdjustsStack(bool V) { AdjustsStack = V; }
 348
 349   /// hasCalls - Return true if the current function has any function calls.
 350   bool hasCalls() const { return HasCalls; }
 351   void setHasCalls(bool V) { HasCalls = V; }
 352
 353   /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
 354   /// allocated for an outgoing function call.  This is only available if
 355   /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
 356   /// then only during or after prolog/epilog code insertion.
 357   ///
 358   unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
 359   void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
 360
 361   /// CreateFixedObject - Create a new object at a fixed location on the stack.
 362   /// All fixed objects should be created before other objects are created for
 363   /// efficiency. By default, fixed objects are immutable. This returns an
 364   /// index with a negative value.
 365   ///
 366   int CreateFixedObject(uint64_t Size, int64_t SPOffset, bool Immutable);
 367
 368
 369   /// isFixedObjectIndex - Returns true if the specified index corresponds to a
 370   /// fixed stack object.
 371   bool isFixedObjectIndex(int ObjectIdx) const {
 372     return ObjectIdx < 0 && (ObjectIdx >= -(int)NumFixedObjects);
 373   }
 374
 375   /// isImmutableObjectIndex - Returns true if the specified index corresponds
 376   /// to an immutable object.
 377   bool isImmutableObjectIndex(int ObjectIdx) const {
 378     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 379            "Invalid Object Idx!");
 380     return Objects[ObjectIdx+NumFixedObjects].isImmutable;
 381   }
 382
 383   /// isSpillSlotObjectIndex - Returns true if the specified index corresponds
 384   /// to a spill slot..
 385   bool isSpillSlotObjectIndex(int ObjectIdx) const {
 386     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 387            "Invalid Object Idx!");
 388     return Objects[ObjectIdx+NumFixedObjects].isSpillSlot;;
 389   }
 390
 391   /// isDeadObjectIndex - Returns true if the specified index corresponds to
 392   /// a dead object.
 393   bool isDeadObjectIndex(int ObjectIdx) const {
 394     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 395            "Invalid Object Idx!");
 396     return Objects[ObjectIdx+NumFixedObjects].Size == ~0ULL;
 397   }
 398
 399   /// CreateStackObject - Create a new statically sized stack object, returning
 400   /// a nonnegative identifier to represent it.
 401   ///
 402   int CreateStackObject(uint64_t Size, unsigned Alignment, bool isSS,
 403                         bool MayNeedSP = false) {
 404     assert(Size != 0 && "Cannot allocate zero size stack objects!");
 405     Objects.push_back(StackObject(Size, Alignment, 0, false, isSS, MayNeedSP));
 406     int Index = (int)Objects.size() - NumFixedObjects - 1;
 407     assert(Index >= 0 && "Bad frame index!");
 408     MaxAlignment = std::max(MaxAlignment, Alignment);
 409     return Index;
 410   }
 411
 412   /// CreateSpillStackObject - Create a new statically sized stack object that
 413   /// represents a spill slot, returning a nonnegative identifier to represent
 414   /// it.
 415   ///
 416   int CreateSpillStackObject(uint64_t Size, unsigned Alignment) {
 417     CreateStackObject(Size, Alignment, true, false);
 418     int Index = (int)Objects.size() - NumFixedObjects - 1;
 419     MaxAlignment = std::max(MaxAlignment, Alignment);
 420     return Index;
 421   }
 422
 423   /// RemoveStackObject - Remove or mark dead a statically sized stack object.
 424   ///
 425   void RemoveStackObject(int ObjectIdx) {
 426     // Mark it dead.
 427     Objects[ObjectIdx+NumFixedObjects].Size = ~0ULL;
 428   }
 429
 430   /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
 431   /// variable sized object has been created.  This must be created whenever a
 432   /// variable sized object is created, whether or not the index returned is
 433   /// actually used.
 434   ///
 435   int CreateVariableSizedObject(unsigned Alignment) {
 436     HasVarSizedObjects = true;
 437     Objects.push_back(StackObject(0, Alignment, 0, false, false, true));
 438     MaxAlignment = std::max(MaxAlignment, Alignment);
 439     return (int)Objects.size()-NumFixedObjects-1;
 440   }
 441
 442   /// getCalleeSavedInfo - Returns a reference to call saved info vector for the
 443   /// current function.
 444   const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
 445     return CSInfo;
 446   }
 447
 448   /// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
 449   /// callee saved information.
 450   void setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
 451     CSInfo = CSI;
 452   }
 453
 454   /// isCalleeSavedInfoValid - Has the callee saved info been calculated yet?
 455   bool isCalleeSavedInfoValid() const { return CSIValid; }
 456
 457   void setCalleeSavedInfoValid(bool v) { CSIValid = v; }
 458
 459   /// getPristineRegs - Return a set of physical registers that are pristine on
 460   /// entry to the MBB.
 461   ///
 462   /// Pristine registers hold a value that is useless to the current function,
 463   /// but that must be preserved - they are callee saved registers that have not
 464   /// been saved yet.
 465   ///
 466   /// Before the PrologueEpilogueInserter has placed the CSR spill code, this
 467   /// method always returns an empty set.
 468   BitVector getPristineRegs(const MachineBasicBlock *MBB) const;
 469
 470   /// print - Used by the MachineFunction printer to print information about
 471   /// stack objects. Implemented in MachineFunction.cpp
 472   ///
 473   void print(const MachineFunction &MF, raw_ostream &OS) const;
 474
 475   /// dump - Print the function to stderr.
 476   void dump(const MachineFunction &MF) const;
 477 };
 478
 479 } // End llvm namespace
 480
 481 #endif