1 //===-- CodeGen/MachineFrameInfo.h - Abstract Stack Frame Rep. --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // The file defines the MachineFrameInfo class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CODEGEN_MACHINEFRAMEINFO_H
15 #define LLVM_CODEGEN_MACHINEFRAMEINFO_H
17 #include "llvm/ADT/SmallVector.h"
18 //#include "llvm/ADT/IndexedMap.h"
19 #include "llvm/System/DataTypes.h"
26 class TargetRegisterClass;
28 class MachineFunction;
29 class MachineBasicBlock;
30 class TargetFrameInfo;
33 /// The CalleeSavedInfo class tracks the information need to locate where a
34 /// callee saved register in the current frame.
35 class CalleeSavedInfo {
40 explicit CalleeSavedInfo(unsigned R, int FI = 0)
41 : Reg(R), FrameIdx(FI) {}
44 unsigned getReg() const { return Reg; }
45 int getFrameIdx() const { return FrameIdx; }
46 void setFrameIdx(int FI) { FrameIdx = FI; }
49 /// The MachineFrameInfo class represents an abstract stack frame until
50 /// prolog/epilog code is inserted. This class is key to allowing stack frame
51 /// representation optimizations, such as frame pointer elimination. It also
52 /// allows more mundane (but still important) optimizations, such as reordering
53 /// of abstract objects on the stack frame.
55 /// To support this, the class assigns unique integer identifiers to stack
56 /// objects requested clients. These identifiers are negative integers for
57 /// fixed stack objects (such as arguments passed on the stack) or nonnegative
58 /// for objects that may be reordered. Instructions which refer to stack
59 /// objects use a special MO_FrameIndex operand to represent these frame
62 /// Because this class keeps track of all references to the stack frame, it
63 /// knows when a variable sized object is allocated on the stack. This is the
64 /// sole condition which prevents frame pointer elimination, which is an
65 /// important optimization on register-poor architectures. Because original
66 /// variable sized alloca's in the source program are the only source of
67 /// variable sized stack objects, it is safe to decide whether there will be
68 /// any variable sized objects before all stack objects are known (for
69 /// example, register allocator spill code never needs variable sized
72 /// When prolog/epilog code emission is performed, the final stack frame is
73 /// built and the machine instructions are modified to refer to the actual
74 /// stack offsets of the object, eliminating all MO_FrameIndex operands from
77 /// @brief Abstract Stack Frame Information
78 class MachineFrameInfo {
80 // StackObject - Represent a single object allocated on the stack.
82 // SPOffset - The offset of this object from the stack pointer on entry to
83 // the function. This field has no meaning for a variable sized element.
86 // The size of this object on the stack. 0 means a variable sized object,
87 // ~0ULL means a dead object.
90 // Alignment - The required alignment of this stack slot.
93 // isImmutable - If true, the value of the stack object is set before
94 // entering the function and is not modified inside the function. By
95 // default, fixed objects are immutable unless marked otherwise.
98 // isSpillSlot - If true the stack object is used as spill slot. It
99 // cannot alias any other memory objects.
102 // MayNeedSP - If true the stack object triggered the creation of the stack
103 // protector. We should allocate this object right after the stack
107 // PreAllocated - If true, the object was mapped into the local frame
108 // block and doesn't need additional handling for allocation beyond that.
111 StackObject(uint64_t Sz, unsigned Al, int64_t SP, bool IM,
113 : SPOffset(SP), Size(Sz), Alignment(Al), isImmutable(IM),
114 isSpillSlot(isSS), MayNeedSP(NSP), PreAllocated(false) {}
117 /// Objects - The list of stack objects allocated...
119 std::vector<StackObject> Objects;
121 /// NumFixedObjects - This contains the number of fixed objects contained on
122 /// the stack. Because fixed objects are stored at a negative index in the
123 /// Objects list, this is also the index to the 0th object in the list.
125 unsigned NumFixedObjects;
127 /// HasVarSizedObjects - This boolean keeps track of whether any variable
128 /// sized objects have been allocated yet.
130 bool HasVarSizedObjects;
132 /// FrameAddressTaken - This boolean keeps track of whether there is a call
133 /// to builtin \@llvm.frameaddress.
134 bool FrameAddressTaken;
136 /// ReturnAddressTaken - This boolean keeps track of whether there is a call
137 /// to builtin \@llvm.returnaddress.
138 bool ReturnAddressTaken;
140 /// StackSize - The prolog/epilog code inserter calculates the final stack
141 /// offsets for all of the fixed size objects, updating the Objects list
142 /// above. It then updates StackSize to contain the number of bytes that need
143 /// to be allocated on entry to the function.
147 /// OffsetAdjustment - The amount that a frame offset needs to be adjusted to
148 /// have the actual offset from the stack/frame pointer. The exact usage of
149 /// this is target-dependent, but it is typically used to adjust between
150 /// SP-relative and FP-relative offsets. E.G., if objects are accessed via
151 /// SP then OffsetAdjustment is zero; if FP is used, OffsetAdjustment is set
152 /// to the distance between the initial SP and the value in FP. For many
153 /// targets, this value is only used when generating debug info (via
154 /// TargetRegisterInfo::getFrameIndexOffset); when generating code, the
155 /// corresponding adjustments are performed directly.
156 int OffsetAdjustment;
158 /// MaxAlignment - The prolog/epilog code inserter may process objects
159 /// that require greater alignment than the default alignment the target
160 /// provides. To handle this, MaxAlignment is set to the maximum alignment
161 /// needed by the objects on the current frame. If this is greater than the
162 /// native alignment maintained by the compiler, dynamic alignment code will
165 unsigned MaxAlignment;
167 /// AdjustsStack - Set to true if this function adjusts the stack -- e.g.,
168 /// when calling another function. This is only valid during and after
169 /// prolog/epilog code insertion.
172 /// HasCalls - Set to true if this function has any function calls.
175 /// StackProtectorIdx - The frame index for the stack protector.
176 int StackProtectorIdx;
178 /// MaxCallFrameSize - This contains the size of the largest call frame if the
179 /// target uses frame setup/destroy pseudo instructions (as defined in the
180 /// TargetFrameInfo class). This information is important for frame pointer
181 /// elimination. If is only valid during and after prolog/epilog code
184 unsigned MaxCallFrameSize;
186 /// CSInfo - The prolog/epilog code inserter fills in this vector with each
187 /// callee saved register saved in the frame. Beyond its use by the prolog/
188 /// epilog code inserter, this data used for debug info and exception
190 std::vector<CalleeSavedInfo> CSInfo;
192 /// CSIValid - Has CSInfo been set yet?
195 /// SpillObjects - A vector indicating which frame indices refer to
197 SmallVector<bool, 8> SpillObjects;
199 /// TargetFrameInfo - Target information about frame layout.
201 const TargetFrameInfo &TFI;
203 /// LocalFrameObjects - References to frame indices which are mapped
204 /// into the local frame allocation block. <FrameIdx, LocalOffset>
205 SmallVector<std::pair<int, int64_t>, 32> LocalFrameObjects;
207 /// LocalFrameSize - Size of the pre-allocated local frame block.
208 int64_t LocalFrameSize;
210 /// LocalFrameBaseOffset - The base offset from the stack pointer at
211 /// function entry of the local frame blob. Set by PEI for use by
212 /// target in eliminateFrameIndex().
213 int64_t LocalFrameBaseOffset;
215 /// Required alignment of the local object blob, which is the strictest
216 /// alignment of any object in it.
217 unsigned LocalFrameMaxAlign;
219 /// Whether the local object blob needs to be allocated together. If not,
220 /// PEI should ignore the isPreAllocated flags on the stack objects and
221 /// just allocate them normally.
222 bool UseLocalStackAllocationBlock;
225 explicit MachineFrameInfo(const TargetFrameInfo &tfi) : TFI(tfi) {
226 StackSize = NumFixedObjects = OffsetAdjustment = MaxAlignment = 0;
227 HasVarSizedObjects = false;
228 FrameAddressTaken = false;
229 ReturnAddressTaken = false;
230 AdjustsStack = false;
232 StackProtectorIdx = -1;
233 MaxCallFrameSize = 0;
236 LocalFrameBaseOffset = 0;
237 LocalFrameMaxAlign = 0;
240 /// hasStackObjects - Return true if there are any stack objects in this
243 bool hasStackObjects() const { return !Objects.empty(); }
245 /// hasVarSizedObjects - This method may be called any time after instruction
246 /// selection is complete to determine if the stack frame for this function
247 /// contains any variable sized objects.
249 bool hasVarSizedObjects() const { return HasVarSizedObjects; }
251 /// getStackProtectorIndex/setStackProtectorIndex - Return the index for the
252 /// stack protector object.
254 int getStackProtectorIndex() const { return StackProtectorIdx; }
255 void setStackProtectorIndex(int I) { StackProtectorIdx = I; }
257 /// isFrameAddressTaken - This method may be called any time after instruction
258 /// selection is complete to determine if there is a call to
259 /// \@llvm.frameaddress in this function.
260 bool isFrameAddressTaken() const { return FrameAddressTaken; }
261 void setFrameAddressIsTaken(bool T) { FrameAddressTaken = T; }
263 /// isReturnAddressTaken - This method may be called any time after
264 /// instruction selection is complete to determine if there is a call to
265 /// \@llvm.returnaddress in this function.
266 bool isReturnAddressTaken() const { return ReturnAddressTaken; }
267 void setReturnAddressIsTaken(bool s) { ReturnAddressTaken = s; }
269 /// getObjectIndexBegin - Return the minimum frame object index.
271 int getObjectIndexBegin() const { return -NumFixedObjects; }
273 /// getObjectIndexEnd - Return one past the maximum frame object index.
275 int getObjectIndexEnd() const { return (int)Objects.size()-NumFixedObjects; }
277 /// getNumFixedObjects - Return the number of fixed objects.
278 unsigned getNumFixedObjects() const { return NumFixedObjects; }
280 /// getNumObjects - Return the number of objects.
282 unsigned getNumObjects() const { return Objects.size(); }
284 /// mapLocalFrameObject - Map a frame index into the local object block
285 void mapLocalFrameObject(int ObjectIndex, int64_t Offset) {
286 LocalFrameObjects.push_back(std::pair<int, int64_t>(ObjectIndex, Offset));
287 Objects[ObjectIndex + NumFixedObjects].PreAllocated = true;
290 /// getLocalFrameObjectMap - Get the local offset mapping for a for an object
291 std::pair<int, int64_t> getLocalFrameObjectMap(int i) {
292 assert (i >= 0 && (unsigned)i < LocalFrameObjects.size() &&
293 "Invalid local object reference!");
294 return LocalFrameObjects[i];
297 /// getLocalFrameObjectCount - Return the number of objects allocated into
298 /// the local object block.
299 int64_t getLocalFrameObjectCount() { return LocalFrameObjects.size(); }
301 /// setLocalFrameBaseOffset - Set the base SP offset of the local frame
303 void setLocalFrameBaseOffset(int64_t o) { LocalFrameBaseOffset = o; }
305 /// getLocalFrameBaseOffset - Get the base SP offset of the local frame
307 int64_t getLocalFrameBaseOffset() const { return LocalFrameBaseOffset; }
309 /// setLocalFrameSize - Set the size of the local object blob.
310 void setLocalFrameSize(int64_t sz) { LocalFrameSize = sz; }
312 /// getLocalFrameSize - Get the size of the local object blob.
313 int64_t getLocalFrameSize() const { return LocalFrameSize; }
315 /// setLocalFrameMaxAlign - Required alignment of the local object blob,
316 /// which is the strictest alignment of any object in it.
317 void setLocalFrameMaxAlign(unsigned Align) { LocalFrameMaxAlign = Align; }
319 /// getLocalFrameMaxAlign - Return the required alignment of the local
321 unsigned getLocalFrameMaxAlign() { return LocalFrameMaxAlign; }
323 /// getUseLocalStackAllocationBlock - Get whether the local allocation blob
324 /// should be allocated together or let PEI allocate the locals in it
326 bool getUseLocalStackAllocationBlock() {return UseLocalStackAllocationBlock;}
328 /// setUseLocalStackAllocationBlock - Set whether the local allocation blob
329 /// should be allocated together or let PEI allocate the locals in it
331 void setUseLocalStackAllocationBlock(bool v) {
332 UseLocalStackAllocationBlock = v;
335 /// isObjectPreAllocated - Return true if the object was pre-allocated into
337 bool isObjectPreAllocated(int ObjectIdx) const {
338 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
339 "Invalid Object Idx!");
340 return Objects[ObjectIdx+NumFixedObjects].PreAllocated;
343 /// getObjectSize - Return the size of the specified object.
345 int64_t getObjectSize(int ObjectIdx) const {
346 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
347 "Invalid Object Idx!");
348 return Objects[ObjectIdx+NumFixedObjects].Size;
351 /// setObjectSize - Change the size of the specified stack object.
352 void setObjectSize(int ObjectIdx, int64_t Size) {
353 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
354 "Invalid Object Idx!");
355 Objects[ObjectIdx+NumFixedObjects].Size = Size;
358 /// getObjectAlignment - Return the alignment of the specified stack object.
359 unsigned getObjectAlignment(int ObjectIdx) const {
360 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
361 "Invalid Object Idx!");
362 return Objects[ObjectIdx+NumFixedObjects].Alignment;
365 /// setObjectAlignment - Change the alignment of the specified stack object.
366 void setObjectAlignment(int ObjectIdx, unsigned Align) {
367 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
368 "Invalid Object Idx!");
369 Objects[ObjectIdx+NumFixedObjects].Alignment = Align;
370 MaxAlignment = std::max(MaxAlignment, Align);
373 /// NeedsStackProtector - Returns true if the object may need stack
375 bool MayNeedStackProtector(int ObjectIdx) const {
376 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
377 "Invalid Object Idx!");
378 return Objects[ObjectIdx+NumFixedObjects].MayNeedSP;
381 /// getObjectOffset - Return the assigned stack offset of the specified object
382 /// from the incoming stack pointer.
384 int64_t getObjectOffset(int ObjectIdx) const {
385 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
386 "Invalid Object Idx!");
387 assert(!isDeadObjectIndex(ObjectIdx) &&
388 "Getting frame offset for a dead object?");
389 return Objects[ObjectIdx+NumFixedObjects].SPOffset;
392 /// setObjectOffset - Set the stack frame offset of the specified object. The
393 /// offset is relative to the stack pointer on entry to the function.
395 void setObjectOffset(int ObjectIdx, int64_t SPOffset) {
396 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
397 "Invalid Object Idx!");
398 assert(!isDeadObjectIndex(ObjectIdx) &&
399 "Setting frame offset for a dead object?");
400 Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
403 /// getStackSize - Return the number of bytes that must be allocated to hold
404 /// all of the fixed size frame objects. This is only valid after
405 /// Prolog/Epilog code insertion has finalized the stack frame layout.
407 uint64_t getStackSize() const { return StackSize; }
409 /// setStackSize - Set the size of the stack...
411 void setStackSize(uint64_t Size) { StackSize = Size; }
413 /// getOffsetAdjustment - Return the correction for frame offsets.
415 int getOffsetAdjustment() const { return OffsetAdjustment; }
417 /// setOffsetAdjustment - Set the correction for frame offsets.
419 void setOffsetAdjustment(int Adj) { OffsetAdjustment = Adj; }
421 /// getMaxAlignment - Return the alignment in bytes that this function must be
422 /// aligned to, which is greater than the default stack alignment provided by
425 unsigned getMaxAlignment() const { return MaxAlignment; }
427 /// setMaxAlignment - Set the preferred alignment.
429 void setMaxAlignment(unsigned Align) { MaxAlignment = Align; }
431 /// AdjustsStack - Return true if this function adjusts the stack -- e.g.,
432 /// when calling another function. This is only valid during and after
433 /// prolog/epilog code insertion.
434 bool adjustsStack() const { return AdjustsStack; }
435 void setAdjustsStack(bool V) { AdjustsStack = V; }
437 /// hasCalls - Return true if the current function has any function calls.
438 bool hasCalls() const { return HasCalls; }
439 void setHasCalls(bool V) { HasCalls = V; }
441 /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
442 /// allocated for an outgoing function call. This is only available if
443 /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
444 /// then only during or after prolog/epilog code insertion.
446 unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
447 void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
449 /// CreateFixedObject - Create a new object at a fixed location on the stack.
450 /// All fixed objects should be created before other objects are created for
451 /// efficiency. By default, fixed objects are immutable. This returns an
452 /// index with a negative value.
454 int CreateFixedObject(uint64_t Size, int64_t SPOffset, bool Immutable);
457 /// isFixedObjectIndex - Returns true if the specified index corresponds to a
458 /// fixed stack object.
459 bool isFixedObjectIndex(int ObjectIdx) const {
460 return ObjectIdx < 0 && (ObjectIdx >= -(int)NumFixedObjects);
463 /// isImmutableObjectIndex - Returns true if the specified index corresponds
464 /// to an immutable object.
465 bool isImmutableObjectIndex(int ObjectIdx) const {
466 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
467 "Invalid Object Idx!");
468 return Objects[ObjectIdx+NumFixedObjects].isImmutable;
471 /// isSpillSlotObjectIndex - Returns true if the specified index corresponds
472 /// to a spill slot..
473 bool isSpillSlotObjectIndex(int ObjectIdx) const {
474 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
475 "Invalid Object Idx!");
476 return Objects[ObjectIdx+NumFixedObjects].isSpillSlot;;
479 /// isDeadObjectIndex - Returns true if the specified index corresponds to
481 bool isDeadObjectIndex(int ObjectIdx) const {
482 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
483 "Invalid Object Idx!");
484 return Objects[ObjectIdx+NumFixedObjects].Size == ~0ULL;
487 /// CreateStackObject - Create a new statically sized stack object, returning
488 /// a nonnegative identifier to represent it.
490 int CreateStackObject(uint64_t Size, unsigned Alignment, bool isSS,
491 bool MayNeedSP = false) {
492 assert(Size != 0 && "Cannot allocate zero size stack objects!");
493 Objects.push_back(StackObject(Size, Alignment, 0, false, isSS, MayNeedSP));
494 int Index = (int)Objects.size() - NumFixedObjects - 1;
495 assert(Index >= 0 && "Bad frame index!");
496 MaxAlignment = std::max(MaxAlignment, Alignment);
500 /// CreateSpillStackObject - Create a new statically sized stack object that
501 /// represents a spill slot, returning a nonnegative identifier to represent
504 int CreateSpillStackObject(uint64_t Size, unsigned Alignment) {
505 CreateStackObject(Size, Alignment, true, false);
506 int Index = (int)Objects.size() - NumFixedObjects - 1;
507 MaxAlignment = std::max(MaxAlignment, Alignment);
511 /// RemoveStackObject - Remove or mark dead a statically sized stack object.
513 void RemoveStackObject(int ObjectIdx) {
515 Objects[ObjectIdx+NumFixedObjects].Size = ~0ULL;
518 /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
519 /// variable sized object has been created. This must be created whenever a
520 /// variable sized object is created, whether or not the index returned is
523 int CreateVariableSizedObject(unsigned Alignment) {
524 HasVarSizedObjects = true;
525 Objects.push_back(StackObject(0, Alignment, 0, false, false, true));
526 MaxAlignment = std::max(MaxAlignment, Alignment);
527 return (int)Objects.size()-NumFixedObjects-1;
530 /// getCalleeSavedInfo - Returns a reference to call saved info vector for the
531 /// current function.
532 const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
536 /// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
537 /// callee saved information.
538 void setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
542 /// isCalleeSavedInfoValid - Has the callee saved info been calculated yet?
543 bool isCalleeSavedInfoValid() const { return CSIValid; }
545 void setCalleeSavedInfoValid(bool v) { CSIValid = v; }
547 /// getPristineRegs - Return a set of physical registers that are pristine on
548 /// entry to the MBB.
550 /// Pristine registers hold a value that is useless to the current function,
551 /// but that must be preserved - they are callee saved registers that have not
554 /// Before the PrologueEpilogueInserter has placed the CSR spill code, this
555 /// method always returns an empty set.
556 BitVector getPristineRegs(const MachineBasicBlock *MBB) const;
558 /// print - Used by the MachineFunction printer to print information about
559 /// stack objects. Implemented in MachineFunction.cpp
561 void print(const MachineFunction &MF, raw_ostream &OS) const;
563 /// dump - Print the function to stderr.
564 void dump(const MachineFunction &MF) const;
567 } // End llvm namespace