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/Support/DataTypes.h"
  19 #include <cassert>
  20 #include <vector>
  21
  22 namespace llvm {
  23 class raw_ostream;
  24 class DataLayout;
  25 class TargetRegisterClass;
  26 class Type;
  27 class MachineFunction;
  28 class MachineBasicBlock;
  29 class TargetFrameLowering;
  30 class TargetMachine;
  31 class BitVector;
  32 class Value;
  33 class AllocaInst;
  34
  35 /// The CalleeSavedInfo class tracks the information need to locate where a
  36 /// callee saved register is in the current frame.
  37 class CalleeSavedInfo {
  38   unsigned Reg;
  39   int FrameIdx;
  40
  41 public:
  42   explicit CalleeSavedInfo(unsigned R, int FI = 0)
  43   : Reg(R), FrameIdx(FI) {}
  44
  45   // Accessors.
  46   unsigned getReg()                        const { return Reg; }
  47   int getFrameIdx()                        const { return FrameIdx; }
  48   void setFrameIdx(int FI)                       { FrameIdx = FI; }
  49 };
  50
  51 /// The MachineFrameInfo class represents an abstract stack frame until
  52 /// prolog/epilog code is inserted.  This class is key to allowing stack frame
  53 /// representation optimizations, such as frame pointer elimination.  It also
  54 /// allows more mundane (but still important) optimizations, such as reordering
  55 /// of abstract objects on the stack frame.
  56 ///
  57 /// To support this, the class assigns unique integer identifiers to stack
  58 /// objects requested clients.  These identifiers are negative integers for
  59 /// fixed stack objects (such as arguments passed on the stack) or nonnegative
  60 /// for objects that may be reordered.  Instructions which refer to stack
  61 /// objects use a special MO_FrameIndex operand to represent these frame
  62 /// indexes.
  63 ///
  64 /// Because this class keeps track of all references to the stack frame, it
  65 /// knows when a variable sized object is allocated on the stack.  This is the
  66 /// sole condition which prevents frame pointer elimination, which is an
  67 /// important optimization on register-poor architectures.  Because original
  68 /// variable sized alloca's in the source program are the only source of
  69 /// variable sized stack objects, it is safe to decide whether there will be
  70 /// any variable sized objects before all stack objects are known (for
  71 /// example, register allocator spill code never needs variable sized
  72 /// objects).
  73 ///
  74 /// When prolog/epilog code emission is performed, the final stack frame is
  75 /// built and the machine instructions are modified to refer to the actual
  76 /// stack offsets of the object, eliminating all MO_FrameIndex operands from
  77 /// the program.
  78 ///
  79 /// @brief Abstract Stack Frame Information
  80 class MachineFrameInfo {
  81
  82   // StackObject - Represent a single object allocated on the stack.
  83   struct StackObject {
  84     // SPOffset - The offset of this object from the stack pointer on entry to
  85     // the function.  This field has no meaning for a variable sized element.
  86     int64_t SPOffset;
  87
  88     // The size of this object on the stack. 0 means a variable sized object,
  89     // ~0ULL means a dead object.
  90     uint64_t Size;
  91
  92     // Alignment - The required alignment of this stack slot.
  93     unsigned Alignment;
  94
  95     // isImmutable - If true, the value of the stack object is set before
  96     // entering the function and is not modified inside the function. By
  97     // default, fixed objects are immutable unless marked otherwise.
  98     bool isImmutable;
  99
 100     // isSpillSlot - If true the stack object is used as spill slot. It
 101     // cannot alias any other memory objects.
 102     bool isSpillSlot;
 103
 104     /// Alloca - If this stack object is originated from an Alloca instruction
 105     /// this value saves the original IR allocation. Can be NULL.
 106     const AllocaInst *Alloca;
 107
 108     // PreAllocated - If true, the object was mapped into the local frame
 109     // block and doesn't need additional handling for allocation beyond that.
 110     bool PreAllocated;
 111
 112     // If true, an LLVM IR value might point to this object.
 113     // Normally, spill slots and fixed-offset objects don't alias IR-accessible
 114     // objects, but there are exceptions (on PowerPC, for example, some byval
 115     // arguments have ABI-prescribed offsets).
 116     bool isAliased;
 117
 118     StackObject(uint64_t Sz, unsigned Al, int64_t SP, bool IM,
 119                 bool isSS, const AllocaInst *Val, bool A)
 120       : SPOffset(SP), Size(Sz), Alignment(Al), isImmutable(IM),
 121         isSpillSlot(isSS), Alloca(Val), PreAllocated(false), isAliased(A) {}
 122   };
 123
 124   /// StackAlignment - The alignment of the stack.
 125   unsigned StackAlignment;
 126
 127   /// StackRealignable - Can the stack be realigned.
 128   bool StackRealignable;
 129
 130   /// Objects - The list of stack objects allocated...
 131   ///
 132   std::vector<StackObject> Objects;
 133
 134   /// NumFixedObjects - This contains the number of fixed objects contained on
 135   /// the stack.  Because fixed objects are stored at a negative index in the
 136   /// Objects list, this is also the index to the 0th object in the list.
 137   ///
 138   unsigned NumFixedObjects;
 139
 140   /// HasVarSizedObjects - This boolean keeps track of whether any variable
 141   /// sized objects have been allocated yet.
 142   ///
 143   bool HasVarSizedObjects;
 144
 145   /// FrameAddressTaken - This boolean keeps track of whether there is a call
 146   /// to builtin \@llvm.frameaddress.
 147   bool FrameAddressTaken;
 148
 149   /// ReturnAddressTaken - This boolean keeps track of whether there is a call
 150   /// to builtin \@llvm.returnaddress.
 151   bool ReturnAddressTaken;
 152
 153   /// HasStackMap - This boolean keeps track of whether there is a call
 154   /// to builtin \@llvm.experimental.stackmap.
 155   bool HasStackMap;
 156
 157   /// HasPatchPoint - This boolean keeps track of whether there is a call
 158   /// to builtin \@llvm.experimental.patchpoint.
 159   bool HasPatchPoint;
 160
 161   /// StackSize - The prolog/epilog code inserter calculates the final stack
 162   /// offsets for all of the fixed size objects, updating the Objects list
 163   /// above.  It then updates StackSize to contain the number of bytes that need
 164   /// to be allocated on entry to the function.
 165   ///
 166   uint64_t StackSize;
 167
 168   /// OffsetAdjustment - The amount that a frame offset needs to be adjusted to
 169   /// have the actual offset from the stack/frame pointer.  The exact usage of
 170   /// this is target-dependent, but it is typically used to adjust between
 171   /// SP-relative and FP-relative offsets.  E.G., if objects are accessed via
 172   /// SP then OffsetAdjustment is zero; if FP is used, OffsetAdjustment is set
 173   /// to the distance between the initial SP and the value in FP.  For many
 174   /// targets, this value is only used when generating debug info (via
 175   /// TargetRegisterInfo::getFrameIndexOffset); when generating code, the
 176   /// corresponding adjustments are performed directly.
 177   int OffsetAdjustment;
 178
 179   /// MaxAlignment - The prolog/epilog code inserter may process objects
 180   /// that require greater alignment than the default alignment the target
 181   /// provides. To handle this, MaxAlignment is set to the maximum alignment
 182   /// needed by the objects on the current frame.  If this is greater than the
 183   /// native alignment maintained by the compiler, dynamic alignment code will
 184   /// be needed.
 185   ///
 186   unsigned MaxAlignment;
 187
 188   /// AdjustsStack - Set to true if this function adjusts the stack -- e.g.,
 189   /// when calling another function. This is only valid during and after
 190   /// prolog/epilog code insertion.
 191   bool AdjustsStack;
 192
 193   /// HasCalls - Set to true if this function has any function calls.
 194   bool HasCalls;
 195
 196   /// StackProtectorIdx - The frame index for the stack protector.
 197   int StackProtectorIdx;
 198
 199   /// FunctionContextIdx - The frame index for the function context. Used for
 200   /// SjLj exceptions.
 201   int FunctionContextIdx;
 202
 203   /// MaxCallFrameSize - This contains the size of the largest call frame if the
 204   /// target uses frame setup/destroy pseudo instructions (as defined in the
 205   /// TargetFrameInfo class).  This information is important for frame pointer
 206   /// elimination.  If is only valid during and after prolog/epilog code
 207   /// insertion.
 208   ///
 209   unsigned MaxCallFrameSize;
 210
 211   /// CSInfo - The prolog/epilog code inserter fills in this vector with each
 212   /// callee saved register saved in the frame.  Beyond its use by the prolog/
 213   /// epilog code inserter, this data used for debug info and exception
 214   /// handling.
 215   std::vector<CalleeSavedInfo> CSInfo;
 216
 217   /// CSIValid - Has CSInfo been set yet?
 218   bool CSIValid;
 219
 220   /// LocalFrameObjects - References to frame indices which are mapped
 221   /// into the local frame allocation block. <FrameIdx, LocalOffset>
 222   SmallVector<std::pair<int, int64_t>, 32> LocalFrameObjects;
 223
 224   /// LocalFrameSize - Size of the pre-allocated local frame block.
 225   int64_t LocalFrameSize;
 226
 227   /// Required alignment of the local object blob, which is the strictest
 228   /// alignment of any object in it.
 229   unsigned LocalFrameMaxAlign;
 230
 231   /// Whether the local object blob needs to be allocated together. If not,
 232   /// PEI should ignore the isPreAllocated flags on the stack objects and
 233   /// just allocate them normally.
 234   bool UseLocalStackAllocationBlock;
 235
 236   /// Whether the "realign-stack" option is on.
 237   bool RealignOption;
 238
 239   /// True if the function includes inline assembly that adjusts the stack
 240   /// pointer.
 241   bool HasInlineAsmWithSPAdjust;
 242
 243   /// True if the function contains a call to the llvm.vastart intrinsic.
 244   bool HasVAStart;
 245
 246   /// True if this is a varargs function that contains a musttail call.
 247   bool HasMustTailInVarArgFunc;
 248
 249   /// True if this function contains a tail call. If so immutable objects like
 250   /// function arguments are no longer so. A tail call *can* override fixed
 251   /// stack objects like arguments so we can't treat them as immutable.
 252   bool HasTailCall;
 253
 254   /// Not null, if shrink-wrapping found a better place for the prologue.
 255   MachineBasicBlock *Save;
 256   /// Not null, if shrink-wrapping found a better place for the epilogue.
 257   MachineBasicBlock *Restore;
 258
 259 public:
 260   explicit MachineFrameInfo(unsigned StackAlign, bool isStackRealign,
 261                             bool RealignOpt)
 262       : StackAlignment(StackAlign), StackRealignable(isStackRealign),
 263         RealignOption(RealignOpt) {
 264     StackSize = NumFixedObjects = OffsetAdjustment = MaxAlignment = 0;
 265     HasVarSizedObjects = false;
 266     FrameAddressTaken = false;
 267     ReturnAddressTaken = false;
 268     HasStackMap = false;
 269     HasPatchPoint = false;
 270     AdjustsStack = false;
 271     HasCalls = false;
 272     StackProtectorIdx = -1;
 273     FunctionContextIdx = -1;
 274     MaxCallFrameSize = 0;
 275     CSIValid = false;
 276     LocalFrameSize = 0;
 277     LocalFrameMaxAlign = 0;
 278     UseLocalStackAllocationBlock = false;
 279     HasInlineAsmWithSPAdjust = false;
 280     HasVAStart = false;
 281     HasMustTailInVarArgFunc = false;
 282     Save = nullptr;
 283     Restore = nullptr;
 284     HasTailCall = false;
 285   }
 286
 287   /// hasStackObjects - Return true if there are any stack objects in this
 288   /// function.
 289   ///
 290   bool hasStackObjects() const { return !Objects.empty(); }
 291
 292   /// hasVarSizedObjects - This method may be called any time after instruction
 293   /// selection is complete to determine if the stack frame for this function
 294   /// contains any variable sized objects.
 295   ///
 296   bool hasVarSizedObjects() const { return HasVarSizedObjects; }
 297
 298   /// getStackProtectorIndex/setStackProtectorIndex - Return the index for the
 299   /// stack protector object.
 300   ///
 301   int getStackProtectorIndex() const { return StackProtectorIdx; }
 302   void setStackProtectorIndex(int I) { StackProtectorIdx = I; }
 303
 304   /// getFunctionContextIndex/setFunctionContextIndex - Return the index for the
 305   /// function context object. This object is used for SjLj exceptions.
 306   int getFunctionContextIndex() const { return FunctionContextIdx; }
 307   void setFunctionContextIndex(int I) { FunctionContextIdx = I; }
 308
 309   /// isFrameAddressTaken - This method may be called any time after instruction
 310   /// selection is complete to determine if there is a call to
 311   /// \@llvm.frameaddress in this function.
 312   bool isFrameAddressTaken() const { return FrameAddressTaken; }
 313   void setFrameAddressIsTaken(bool T) { FrameAddressTaken = T; }
 314
 315   /// isReturnAddressTaken - This method may be called any time after
 316   /// instruction selection is complete to determine if there is a call to
 317   /// \@llvm.returnaddress in this function.
 318   bool isReturnAddressTaken() const { return ReturnAddressTaken; }
 319   void setReturnAddressIsTaken(bool s) { ReturnAddressTaken = s; }
 320
 321   /// hasStackMap - This method may be called any time after instruction
 322   /// selection is complete to determine if there is a call to builtin
 323   /// \@llvm.experimental.stackmap.
 324   bool hasStackMap() const { return HasStackMap; }
 325   void setHasStackMap(bool s = true) { HasStackMap = s; }
 326
 327   /// hasPatchPoint - This method may be called any time after instruction
 328   /// selection is complete to determine if there is a call to builtin
 329   /// \@llvm.experimental.patchpoint.
 330   bool hasPatchPoint() const { return HasPatchPoint; }
 331   void setHasPatchPoint(bool s = true) { HasPatchPoint = s; }
 332
 333   /// getObjectIndexBegin - Return the minimum frame object index.
 334   ///
 335   int getObjectIndexBegin() const { return -NumFixedObjects; }
 336
 337   /// getObjectIndexEnd - Return one past the maximum frame object index.
 338   ///
 339   int getObjectIndexEnd() const { return (int)Objects.size()-NumFixedObjects; }
 340
 341   /// getNumFixedObjects - Return the number of fixed objects.
 342   unsigned getNumFixedObjects() const { return NumFixedObjects; }
 343
 344   /// getNumObjects - Return the number of objects.
 345   ///
 346   unsigned getNumObjects() const { return Objects.size(); }
 347
 348   /// mapLocalFrameObject - Map a frame index into the local object block
 349   void mapLocalFrameObject(int ObjectIndex, int64_t Offset) {
 350     LocalFrameObjects.push_back(std::pair<int, int64_t>(ObjectIndex, Offset));
 351     Objects[ObjectIndex + NumFixedObjects].PreAllocated = true;
 352   }
 353
 354   /// getLocalFrameObjectMap - Get the local offset mapping for a for an object
 355   std::pair<int, int64_t> getLocalFrameObjectMap(int i) {
 356     assert (i >= 0 && (unsigned)i < LocalFrameObjects.size() &&
 357             "Invalid local object reference!");
 358     return LocalFrameObjects[i];
 359   }
 360
 361   /// getLocalFrameObjectCount - Return the number of objects allocated into
 362   /// the local object block.
 363   int64_t getLocalFrameObjectCount() { return LocalFrameObjects.size(); }
 364
 365   /// setLocalFrameSize - Set the size of the local object blob.
 366   void setLocalFrameSize(int64_t sz) { LocalFrameSize = sz; }
 367
 368   /// getLocalFrameSize - Get the size of the local object blob.
 369   int64_t getLocalFrameSize() const { return LocalFrameSize; }
 370
 371   /// setLocalFrameMaxAlign - Required alignment of the local object blob,
 372   /// which is the strictest alignment of any object in it.
 373   void setLocalFrameMaxAlign(unsigned Align) { LocalFrameMaxAlign = Align; }
 374
 375   /// getLocalFrameMaxAlign - Return the required alignment of the local
 376   /// object blob.
 377   unsigned getLocalFrameMaxAlign() const { return LocalFrameMaxAlign; }
 378
 379   /// getUseLocalStackAllocationBlock - Get whether the local allocation blob
 380   /// should be allocated together or let PEI allocate the locals in it
 381   /// directly.
 382   bool getUseLocalStackAllocationBlock() {return UseLocalStackAllocationBlock;}
 383
 384   /// setUseLocalStackAllocationBlock - Set whether the local allocation blob
 385   /// should be allocated together or let PEI allocate the locals in it
 386   /// directly.
 387   void setUseLocalStackAllocationBlock(bool v) {
 388     UseLocalStackAllocationBlock = v;
 389   }
 390
 391   /// isObjectPreAllocated - Return true if the object was pre-allocated into
 392   /// the local block.
 393   bool isObjectPreAllocated(int ObjectIdx) const {
 394     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 395            "Invalid Object Idx!");
 396     return Objects[ObjectIdx+NumFixedObjects].PreAllocated;
 397   }
 398
 399   /// getObjectSize - Return the size of the specified object.
 400   ///
 401   int64_t getObjectSize(int ObjectIdx) const {
 402     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 403            "Invalid Object Idx!");
 404     return Objects[ObjectIdx+NumFixedObjects].Size;
 405   }
 406
 407   /// setObjectSize - Change the size of the specified stack object.
 408   void setObjectSize(int ObjectIdx, int64_t Size) {
 409     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 410            "Invalid Object Idx!");
 411     Objects[ObjectIdx+NumFixedObjects].Size = Size;
 412   }
 413
 414   /// getObjectAlignment - Return the alignment of the specified stack object.
 415   unsigned getObjectAlignment(int ObjectIdx) const {
 416     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 417            "Invalid Object Idx!");
 418     return Objects[ObjectIdx+NumFixedObjects].Alignment;
 419   }
 420
 421   /// setObjectAlignment - Change the alignment of the specified stack object.
 422   void setObjectAlignment(int ObjectIdx, unsigned Align) {
 423     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 424            "Invalid Object Idx!");
 425     Objects[ObjectIdx+NumFixedObjects].Alignment = Align;
 426     ensureMaxAlignment(Align);
 427   }
 428
 429   /// getObjectAllocation - Return the underlying Alloca of the specified
 430   /// stack object if it exists. Returns 0 if none exists.
 431   const AllocaInst* getObjectAllocation(int ObjectIdx) const {
 432     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 433            "Invalid Object Idx!");
 434     return Objects[ObjectIdx+NumFixedObjects].Alloca;
 435   }
 436
 437   /// getObjectOffset - Return the assigned stack offset of the specified object
 438   /// from the incoming stack pointer.
 439   ///
 440   int64_t getObjectOffset(int ObjectIdx) const {
 441     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 442            "Invalid Object Idx!");
 443     assert(!isDeadObjectIndex(ObjectIdx) &&
 444            "Getting frame offset for a dead object?");
 445     return Objects[ObjectIdx+NumFixedObjects].SPOffset;
 446   }
 447
 448   /// setObjectOffset - Set the stack frame offset of the specified object.  The
 449   /// offset is relative to the stack pointer on entry to the function.
 450   ///
 451   void setObjectOffset(int ObjectIdx, int64_t SPOffset) {
 452     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 453            "Invalid Object Idx!");
 454     assert(!isDeadObjectIndex(ObjectIdx) &&
 455            "Setting frame offset for a dead object?");
 456     Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
 457   }
 458
 459   /// getStackSize - Return the number of bytes that must be allocated to hold
 460   /// all of the fixed size frame objects.  This is only valid after
 461   /// Prolog/Epilog code insertion has finalized the stack frame layout.
 462   ///
 463   uint64_t getStackSize() const { return StackSize; }
 464
 465   /// setStackSize - Set the size of the stack...
 466   ///
 467   void setStackSize(uint64_t Size) { StackSize = Size; }
 468
 469   /// Estimate and return the size of the stack frame.
 470   unsigned estimateStackSize(const MachineFunction &MF) const;
 471
 472   /// getOffsetAdjustment - Return the correction for frame offsets.
 473   ///
 474   int getOffsetAdjustment() const { return OffsetAdjustment; }
 475
 476   /// setOffsetAdjustment - Set the correction for frame offsets.
 477   ///
 478   void setOffsetAdjustment(int Adj) { OffsetAdjustment = Adj; }
 479
 480   /// getMaxAlignment - Return the alignment in bytes that this function must be
 481   /// aligned to, which is greater than the default stack alignment provided by
 482   /// the target.
 483   ///
 484   unsigned getMaxAlignment() const { return MaxAlignment; }
 485
 486   /// ensureMaxAlignment - Make sure the function is at least Align bytes
 487   /// aligned.
 488   void ensureMaxAlignment(unsigned Align);
 489
 490   /// AdjustsStack - Return true if this function adjusts the stack -- e.g.,
 491   /// when calling another function. This is only valid during and after
 492   /// prolog/epilog code insertion.
 493   bool adjustsStack() const { return AdjustsStack; }
 494   void setAdjustsStack(bool V) { AdjustsStack = V; }
 495
 496   /// hasCalls - Return true if the current function has any function calls.
 497   bool hasCalls() const { return HasCalls; }
 498   void setHasCalls(bool V) { HasCalls = V; }
 499
 500   /// Returns true if the function contains any stack-adjusting inline assembly.
 501   bool hasInlineAsmWithSPAdjust() const { return HasInlineAsmWithSPAdjust; }
 502   void setHasInlineAsmWithSPAdjust(bool B) { HasInlineAsmWithSPAdjust = B; }
 503
 504   /// Returns true if the function calls the llvm.va_start intrinsic.
 505   bool hasVAStart() const { return HasVAStart; }
 506   void setHasVAStart(bool B) { HasVAStart = B; }
 507
 508   /// Returns true if the function is variadic and contains a musttail call.
 509   bool hasMustTailInVarArgFunc() const { return HasMustTailInVarArgFunc; }
 510   void setHasMustTailInVarArgFunc(bool B) { HasMustTailInVarArgFunc = B; }
 511
 512   /// Returns true if the function contains a tail call.
 513   bool hasTailCall() const { return HasTailCall; }
 514   void setHasTailCall() { HasTailCall = true; }
 515
 516   /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
 517   /// allocated for an outgoing function call.  This is only available if
 518   /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
 519   /// then only during or after prolog/epilog code insertion.
 520   ///
 521   unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
 522   void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
 523
 524   /// CreateFixedObject - Create a new object at a fixed location on the stack.
 525   /// All fixed objects should be created before other objects are created for
 526   /// efficiency. By default, fixed objects are not pointed to by LLVM IR
 527   /// values. This returns an index with a negative value.
 528   ///
 529   int CreateFixedObject(uint64_t Size, int64_t SPOffset, bool Immutable,
 530                         bool isAliased = false);
 531
 532   /// CreateFixedSpillStackObject - Create a spill slot at a fixed location
 533   /// on the stack.  Returns an index with a negative value.
 534   int CreateFixedSpillStackObject(uint64_t Size, int64_t SPOffset);
 535
 536   /// isFixedObjectIndex - Returns true if the specified index corresponds to a
 537   /// fixed stack object.
 538   bool isFixedObjectIndex(int ObjectIdx) const {
 539     return ObjectIdx < 0 && (ObjectIdx >= -(int)NumFixedObjects);
 540   }
 541
 542   /// isAliasedObjectIndex - Returns true if the specified index corresponds
 543   /// to an object that might be pointed to by an LLVM IR value.
 544   bool isAliasedObjectIndex(int ObjectIdx) const {
 545     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 546            "Invalid Object Idx!");
 547     return Objects[ObjectIdx+NumFixedObjects].isAliased;
 548   }
 549
 550   /// isImmutableObjectIndex - Returns true if the specified index corresponds
 551   /// to an immutable object.
 552   bool isImmutableObjectIndex(int ObjectIdx) const {
 553     // Tail calling functions can clobber their function arguments.
 554     if (HasTailCall)
 555       return false;
 556     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 557            "Invalid Object Idx!");
 558     return Objects[ObjectIdx+NumFixedObjects].isImmutable;
 559   }
 560
 561   /// isSpillSlotObjectIndex - Returns true if the specified index corresponds
 562   /// to a spill slot..
 563   bool isSpillSlotObjectIndex(int ObjectIdx) const {
 564     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 565            "Invalid Object Idx!");
 566     return Objects[ObjectIdx+NumFixedObjects].isSpillSlot;
 567   }
 568
 569   /// isDeadObjectIndex - Returns true if the specified index corresponds to
 570   /// a dead object.
 571   bool isDeadObjectIndex(int ObjectIdx) const {
 572     assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
 573            "Invalid Object Idx!");
 574     return Objects[ObjectIdx+NumFixedObjects].Size == ~0ULL;
 575   }
 576
 577   /// CreateStackObject - Create a new statically sized stack object, returning
 578   /// a nonnegative identifier to represent it.
 579   ///
 580   int CreateStackObject(uint64_t Size, unsigned Alignment, bool isSS,
 581                         const AllocaInst *Alloca = nullptr);
 582
 583   /// CreateSpillStackObject - Create a new statically sized stack object that
 584   /// represents a spill slot, returning a nonnegative identifier to represent
 585   /// it.
 586   ///
 587   int CreateSpillStackObject(uint64_t Size, unsigned Alignment);
 588
 589   /// RemoveStackObject - Remove or mark dead a statically sized stack object.
 590   ///
 591   void RemoveStackObject(int ObjectIdx) {
 592     // Mark it dead.
 593     Objects[ObjectIdx+NumFixedObjects].Size = ~0ULL;
 594   }
 595
 596   /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
 597   /// variable sized object has been created.  This must be created whenever a
 598   /// variable sized object is created, whether or not the index returned is
 599   /// actually used.
 600   ///
 601   int CreateVariableSizedObject(unsigned Alignment, const AllocaInst *Alloca);
 602
 603   /// getCalleeSavedInfo - Returns a reference to call saved info vector for the
 604   /// current function.
 605   const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
 606     return CSInfo;
 607   }
 608
 609   /// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
 610   /// callee saved information.
 611   void setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
 612     CSInfo = CSI;
 613   }
 614
 615   /// isCalleeSavedInfoValid - Has the callee saved info been calculated yet?
 616   bool isCalleeSavedInfoValid() const { return CSIValid; }
 617
 618   void setCalleeSavedInfoValid(bool v) { CSIValid = v; }
 619
 620   MachineBasicBlock *getSavePoint() const { return Save; }
 621   void setSavePoint(MachineBasicBlock *NewSave) { Save = NewSave; }
 622   MachineBasicBlock *getRestorePoint() const { return Restore; }
 623   void setRestorePoint(MachineBasicBlock *NewRestore) { Restore = NewRestore; }
 624
 625   /// Return a set of physical registers that are pristine.
 626   ///
 627   /// Pristine registers hold a value that is useless to the current function,
 628   /// but that must be preserved - they are callee saved registers that are not
 629   /// saved.
 630   ///
 631   /// Before the PrologueEpilogueInserter has placed the CSR spill code, this
 632   /// method always returns an empty set.
 633   BitVector getPristineRegs(const MachineFunction &MF) const;
 634
 635   /// print - Used by the MachineFunction printer to print information about
 636   /// stack objects. Implemented in MachineFunction.cpp
 637   ///
 638   void print(const MachineFunction &MF, raw_ostream &OS) const;
 639
 640   /// dump - Print the function to stderr.
 641   void dump(const MachineFunction &MF) const;
 642 };
 643
 644 } // End llvm namespace
 645
 646 #endif