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;
238 UseLocalStackAllocationBlock = false;
241 /// hasStackObjects - Return true if there are any stack objects in this
244 bool hasStackObjects() const { return !Objects.empty(); }
246 /// hasVarSizedObjects - This method may be called any time after instruction
247 /// selection is complete to determine if the stack frame for this function
248 /// contains any variable sized objects.
250 bool hasVarSizedObjects() const { return HasVarSizedObjects; }
252 /// getStackProtectorIndex/setStackProtectorIndex - Return the index for the
253 /// stack protector object.
255 int getStackProtectorIndex() const { return StackProtectorIdx; }
256 void setStackProtectorIndex(int I) { StackProtectorIdx = I; }
258 /// isFrameAddressTaken - This method may be called any time after instruction
259 /// selection is complete to determine if there is a call to
260 /// \@llvm.frameaddress in this function.
261 bool isFrameAddressTaken() const { return FrameAddressTaken; }
262 void setFrameAddressIsTaken(bool T) { FrameAddressTaken = T; }
264 /// isReturnAddressTaken - This method may be called any time after
265 /// instruction selection is complete to determine if there is a call to
266 /// \@llvm.returnaddress in this function.
267 bool isReturnAddressTaken() const { return ReturnAddressTaken; }
268 void setReturnAddressIsTaken(bool s) { ReturnAddressTaken = s; }
270 /// getObjectIndexBegin - Return the minimum frame object index.
272 int getObjectIndexBegin() const { return -NumFixedObjects; }
274 /// getObjectIndexEnd - Return one past the maximum frame object index.
276 int getObjectIndexEnd() const { return (int)Objects.size()-NumFixedObjects; }
278 /// getNumFixedObjects - Return the number of fixed objects.
279 unsigned getNumFixedObjects() const { return NumFixedObjects; }
281 /// getNumObjects - Return the number of objects.
283 unsigned getNumObjects() const { return Objects.size(); }
285 /// mapLocalFrameObject - Map a frame index into the local object block
286 void mapLocalFrameObject(int ObjectIndex, int64_t Offset) {
287 LocalFrameObjects.push_back(std::pair<int, int64_t>(ObjectIndex, Offset));
288 Objects[ObjectIndex + NumFixedObjects].PreAllocated = true;
291 /// getLocalFrameObjectMap - Get the local offset mapping for a for an object
292 std::pair<int, int64_t> getLocalFrameObjectMap(int i) {
293 assert (i >= 0 && (unsigned)i < LocalFrameObjects.size() &&
294 "Invalid local object reference!");
295 return LocalFrameObjects[i];
298 /// getLocalFrameObjectCount - Return the number of objects allocated into
299 /// the local object block.
300 int64_t getLocalFrameObjectCount() { return LocalFrameObjects.size(); }
302 /// setLocalFrameBaseOffset - Set the base SP offset of the local frame
304 void setLocalFrameBaseOffset(int64_t o) { LocalFrameBaseOffset = o; }
306 /// getLocalFrameBaseOffset - Get the base SP offset of the local frame
308 int64_t getLocalFrameBaseOffset() const { return LocalFrameBaseOffset; }
310 /// setLocalFrameSize - Set the size of the local object blob.
311 void setLocalFrameSize(int64_t sz) { LocalFrameSize = sz; }
313 /// getLocalFrameSize - Get the size of the local object blob.
314 int64_t getLocalFrameSize() const { return LocalFrameSize; }
316 /// setLocalFrameMaxAlign - Required alignment of the local object blob,
317 /// which is the strictest alignment of any object in it.
318 void setLocalFrameMaxAlign(unsigned Align) { LocalFrameMaxAlign = Align; }
320 /// getLocalFrameMaxAlign - Return the required alignment of the local
322 unsigned getLocalFrameMaxAlign() { return LocalFrameMaxAlign; }
324 /// getUseLocalStackAllocationBlock - Get whether the local allocation blob
325 /// should be allocated together or let PEI allocate the locals in it
327 bool getUseLocalStackAllocationBlock() {return UseLocalStackAllocationBlock;}
329 /// setUseLocalStackAllocationBlock - Set whether the local allocation blob
330 /// should be allocated together or let PEI allocate the locals in it
332 void setUseLocalStackAllocationBlock(bool v) {
333 UseLocalStackAllocationBlock = v;
336 /// isObjectPreAllocated - Return true if the object was pre-allocated into
338 bool isObjectPreAllocated(int ObjectIdx) const {
339 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
340 "Invalid Object Idx!");
341 return Objects[ObjectIdx+NumFixedObjects].PreAllocated;
344 /// getObjectSize - Return the size of the specified object.
346 int64_t getObjectSize(int ObjectIdx) const {
347 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
348 "Invalid Object Idx!");
349 return Objects[ObjectIdx+NumFixedObjects].Size;
352 /// setObjectSize - Change the size of the specified stack object.
353 void setObjectSize(int ObjectIdx, int64_t Size) {
354 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
355 "Invalid Object Idx!");
356 Objects[ObjectIdx+NumFixedObjects].Size = Size;
359 /// getObjectAlignment - Return the alignment of the specified stack object.
360 unsigned getObjectAlignment(int ObjectIdx) const {
361 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
362 "Invalid Object Idx!");
363 return Objects[ObjectIdx+NumFixedObjects].Alignment;
366 /// setObjectAlignment - Change the alignment of the specified stack object.
367 void setObjectAlignment(int ObjectIdx, unsigned Align) {
368 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
369 "Invalid Object Idx!");
370 Objects[ObjectIdx+NumFixedObjects].Alignment = Align;
371 MaxAlignment = std::max(MaxAlignment, Align);
374 /// NeedsStackProtector - Returns true if the object may need stack
376 bool MayNeedStackProtector(int ObjectIdx) const {
377 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
378 "Invalid Object Idx!");
379 return Objects[ObjectIdx+NumFixedObjects].MayNeedSP;
382 /// getObjectOffset - Return the assigned stack offset of the specified object
383 /// from the incoming stack pointer.
385 int64_t getObjectOffset(int ObjectIdx) const {
386 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
387 "Invalid Object Idx!");
388 assert(!isDeadObjectIndex(ObjectIdx) &&
389 "Getting frame offset for a dead object?");
390 return Objects[ObjectIdx+NumFixedObjects].SPOffset;
393 /// setObjectOffset - Set the stack frame offset of the specified object. The
394 /// offset is relative to the stack pointer on entry to the function.
396 void setObjectOffset(int ObjectIdx, int64_t SPOffset) {
397 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
398 "Invalid Object Idx!");
399 assert(!isDeadObjectIndex(ObjectIdx) &&
400 "Setting frame offset for a dead object?");
401 Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
404 /// getStackSize - Return the number of bytes that must be allocated to hold
405 /// all of the fixed size frame objects. This is only valid after
406 /// Prolog/Epilog code insertion has finalized the stack frame layout.
408 uint64_t getStackSize() const { return StackSize; }
410 /// setStackSize - Set the size of the stack...
412 void setStackSize(uint64_t Size) { StackSize = Size; }
414 /// getOffsetAdjustment - Return the correction for frame offsets.
416 int getOffsetAdjustment() const { return OffsetAdjustment; }
418 /// setOffsetAdjustment - Set the correction for frame offsets.
420 void setOffsetAdjustment(int Adj) { OffsetAdjustment = Adj; }
422 /// getMaxAlignment - Return the alignment in bytes that this function must be
423 /// aligned to, which is greater than the default stack alignment provided by
426 unsigned getMaxAlignment() const { return MaxAlignment; }
428 /// setMaxAlignment - Set the preferred alignment.
430 void setMaxAlignment(unsigned Align) { MaxAlignment = Align; }
432 /// AdjustsStack - Return true if this function adjusts the stack -- e.g.,
433 /// when calling another function. This is only valid during and after
434 /// prolog/epilog code insertion.
435 bool adjustsStack() const { return AdjustsStack; }
436 void setAdjustsStack(bool V) { AdjustsStack = V; }
438 /// hasCalls - Return true if the current function has any function calls.
439 bool hasCalls() const { return HasCalls; }
440 void setHasCalls(bool V) { HasCalls = V; }
442 /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
443 /// allocated for an outgoing function call. This is only available if
444 /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
445 /// then only during or after prolog/epilog code insertion.
447 unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
448 void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
450 /// CreateFixedObject - Create a new object at a fixed location on the stack.
451 /// All fixed objects should be created before other objects are created for
452 /// efficiency. By default, fixed objects are immutable. This returns an
453 /// index with a negative value.
455 int CreateFixedObject(uint64_t Size, int64_t SPOffset, bool Immutable);
458 /// isFixedObjectIndex - Returns true if the specified index corresponds to a
459 /// fixed stack object.
460 bool isFixedObjectIndex(int ObjectIdx) const {
461 return ObjectIdx < 0 && (ObjectIdx >= -(int)NumFixedObjects);
464 /// isImmutableObjectIndex - Returns true if the specified index corresponds
465 /// to an immutable object.
466 bool isImmutableObjectIndex(int ObjectIdx) const {
467 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
468 "Invalid Object Idx!");
469 return Objects[ObjectIdx+NumFixedObjects].isImmutable;
472 /// isSpillSlotObjectIndex - Returns true if the specified index corresponds
473 /// to a spill slot..
474 bool isSpillSlotObjectIndex(int ObjectIdx) const {
475 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
476 "Invalid Object Idx!");
477 return Objects[ObjectIdx+NumFixedObjects].isSpillSlot;;
480 /// isDeadObjectIndex - Returns true if the specified index corresponds to
482 bool isDeadObjectIndex(int ObjectIdx) const {
483 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
484 "Invalid Object Idx!");
485 return Objects[ObjectIdx+NumFixedObjects].Size == ~0ULL;
488 /// CreateStackObject - Create a new statically sized stack object, returning
489 /// a nonnegative identifier to represent it.
491 int CreateStackObject(uint64_t Size, unsigned Alignment, bool isSS,
492 bool MayNeedSP = false) {
493 assert(Size != 0 && "Cannot allocate zero size stack objects!");
494 Objects.push_back(StackObject(Size, Alignment, 0, false, isSS, MayNeedSP));
495 int Index = (int)Objects.size() - NumFixedObjects - 1;
496 assert(Index >= 0 && "Bad frame index!");
497 MaxAlignment = std::max(MaxAlignment, Alignment);
501 /// CreateSpillStackObject - Create a new statically sized stack object that
502 /// represents a spill slot, returning a nonnegative identifier to represent
505 int CreateSpillStackObject(uint64_t Size, unsigned Alignment) {
506 CreateStackObject(Size, Alignment, true, false);
507 int Index = (int)Objects.size() - NumFixedObjects - 1;
508 MaxAlignment = std::max(MaxAlignment, Alignment);
512 /// RemoveStackObject - Remove or mark dead a statically sized stack object.
514 void RemoveStackObject(int ObjectIdx) {
516 Objects[ObjectIdx+NumFixedObjects].Size = ~0ULL;
519 /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
520 /// variable sized object has been created. This must be created whenever a
521 /// variable sized object is created, whether or not the index returned is
524 int CreateVariableSizedObject(unsigned Alignment) {
525 HasVarSizedObjects = true;
526 Objects.push_back(StackObject(0, Alignment, 0, false, false, true));
527 MaxAlignment = std::max(MaxAlignment, Alignment);
528 return (int)Objects.size()-NumFixedObjects-1;
531 /// getCalleeSavedInfo - Returns a reference to call saved info vector for the
532 /// current function.
533 const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
537 /// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
538 /// callee saved information.
539 void setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
543 /// isCalleeSavedInfoValid - Has the callee saved info been calculated yet?
544 bool isCalleeSavedInfoValid() const { return CSIValid; }
546 void setCalleeSavedInfoValid(bool v) { CSIValid = v; }
548 /// getPristineRegs - Return a set of physical registers that are pristine on
549 /// entry to the MBB.
551 /// Pristine registers hold a value that is useless to the current function,
552 /// but that must be preserved - they are callee saved registers that have not
555 /// Before the PrologueEpilogueInserter has placed the CSR spill code, this
556 /// method always returns an empty set.
557 BitVector getPristineRegs(const MachineBasicBlock *MBB) const;
559 /// print - Used by the MachineFunction printer to print information about
560 /// stack objects. Implemented in MachineFunction.cpp
562 void print(const MachineFunction &MF, raw_ostream &OS) const;
564 /// dump - Print the function to stderr.
565 void dump(const MachineFunction &MF) const;
568 } // End llvm namespace