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/System/DataTypes.h"
25 class TargetRegisterClass;
27 class MachineModuleInfo;
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 {
37 const TargetRegisterClass *RegClass;
41 CalleeSavedInfo(unsigned R, const TargetRegisterClass *RC, int FI = 0)
42 : Reg(R), RegClass(RC), FrameIdx(FI) {}
45 unsigned getReg() const { return Reg; }
46 const TargetRegisterClass *getRegClass() const { return RegClass; }
47 int getFrameIdx() const { return FrameIdx; }
48 void setFrameIdx(int FI) { FrameIdx = FI; }
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.
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
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
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
79 /// @brief Abstract Stack Frame Information
80 class MachineFrameInfo {
82 // StackObject - Represent a single object allocated on the stack.
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.
88 // The size of this object on the stack. 0 means a variable sized object,
89 // ~0ULL means a dead object.
92 // Alignment - The required alignment of this stack slot.
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.
100 // isSpillSlot - If true, the stack object is used as spill slot. It
101 // cannot alias any other memory objects.
104 StackObject(uint64_t Sz, unsigned Al, int64_t SP, bool IM,
106 : SPOffset(SP), Size(Sz), Alignment(Al), isImmutable(IM),
110 /// Objects - The list of stack objects allocated...
112 std::vector<StackObject> Objects;
114 /// NumFixedObjects - This contains the number of fixed objects contained on
115 /// the stack. Because fixed objects are stored at a negative index in the
116 /// Objects list, this is also the index to the 0th object in the list.
118 unsigned NumFixedObjects;
120 /// HasVarSizedObjects - This boolean keeps track of whether any variable
121 /// sized objects have been allocated yet.
123 bool HasVarSizedObjects;
125 /// FrameAddressTaken - This boolean keeps track of whether there is a call
126 /// to builtin \@llvm.frameaddress.
127 bool FrameAddressTaken;
129 /// StackSize - The prolog/epilog code inserter calculates the final stack
130 /// offsets for all of the fixed size objects, updating the Objects list
131 /// above. It then updates StackSize to contain the number of bytes that need
132 /// to be allocated on entry to the function.
136 /// OffsetAdjustment - The amount that a frame offset needs to be adjusted to
137 /// have the actual offset from the stack/frame pointer. The exact usage of
138 /// this is target-dependent, but it is typically used to adjust between
139 /// SP-relative and FP-relative offsets. E.G., if objects are accessed via
140 /// SP then OffsetAdjustment is zero; if FP is used, OffsetAdjustment is set
141 /// to the distance between the initial SP and the value in FP. For many
142 /// targets, this value is only used when generating debug info (via
143 /// TargetRegisterInfo::getFrameIndexOffset); when generating code, the
144 /// corresponding adjustments are performed directly.
145 int OffsetAdjustment;
147 /// MaxAlignment - The prolog/epilog code inserter may process objects
148 /// that require greater alignment than the default alignment the target
149 /// provides. To handle this, MaxAlignment is set to the maximum alignment
150 /// needed by the objects on the current frame. If this is greater than the
151 /// native alignment maintained by the compiler, dynamic alignment code will
154 unsigned MaxAlignment;
156 /// HasCalls - Set to true if this function has any function calls. This is
157 /// only valid during and after prolog/epilog code insertion.
160 /// StackProtectorIdx - The frame index for the stack protector.
161 int StackProtectorIdx;
163 /// MaxCallFrameSize - This contains the size of the largest call frame if the
164 /// target uses frame setup/destroy pseudo instructions (as defined in the
165 /// TargetFrameInfo class). This information is important for frame pointer
166 /// elimination. If is only valid during and after prolog/epilog code
169 unsigned MaxCallFrameSize;
171 /// CSInfo - The prolog/epilog code inserter fills in this vector with each
172 /// callee saved register saved in the frame. Beyond its use by the prolog/
173 /// epilog code inserter, this data used for debug info and exception
175 std::vector<CalleeSavedInfo> CSInfo;
177 /// CSIValid - Has CSInfo been set yet?
180 /// SpillObjects - A vector indicating which frame indices refer to
182 SmallVector<bool, 8> SpillObjects;
184 /// MMI - This field is set (via setMachineModuleInfo) by a module info
185 /// consumer to indicate that frame layout information
186 /// should be acquired. Typically, it's the responsibility of the target's
187 /// TargetRegisterInfo prologue/epilogue emitting code to inform
188 /// MachineModuleInfo of frame layouts.
189 MachineModuleInfo *MMI;
191 /// TargetFrameInfo - Target information about frame layout.
193 const TargetFrameInfo &TFI;
196 explicit MachineFrameInfo(const TargetFrameInfo &tfi) : TFI(tfi) {
197 StackSize = NumFixedObjects = OffsetAdjustment = MaxAlignment = 0;
198 HasVarSizedObjects = false;
199 FrameAddressTaken = false;
201 StackProtectorIdx = -1;
202 MaxCallFrameSize = 0;
207 /// hasStackObjects - Return true if there are any stack objects in this
210 bool hasStackObjects() const { return !Objects.empty(); }
212 /// hasVarSizedObjects - This method may be called any time after instruction
213 /// selection is complete to determine if the stack frame for this function
214 /// contains any variable sized objects.
216 bool hasVarSizedObjects() const { return HasVarSizedObjects; }
218 /// getStackProtectorIndex/setStackProtectorIndex - Return the index for the
219 /// stack protector object.
221 int getStackProtectorIndex() const { return StackProtectorIdx; }
222 void setStackProtectorIndex(int I) { StackProtectorIdx = I; }
224 /// isFrameAddressTaken - This method may be called any time after instruction
225 /// selection is complete to determine if there is a call to
226 /// \@llvm.frameaddress in this function.
227 bool isFrameAddressTaken() const { return FrameAddressTaken; }
228 void setFrameAddressIsTaken(bool T) { FrameAddressTaken = T; }
230 /// getObjectIndexBegin - Return the minimum frame object index.
232 int getObjectIndexBegin() const { return -NumFixedObjects; }
234 /// getObjectIndexEnd - Return one past the maximum frame object index.
236 int getObjectIndexEnd() const { return (int)Objects.size()-NumFixedObjects; }
238 /// getNumFixedObjects() - Return the number of fixed objects.
239 unsigned getNumFixedObjects() const { return NumFixedObjects; }
241 /// getNumObjects() - Return the number of objects.
243 unsigned getNumObjects() const { return Objects.size(); }
245 /// getObjectSize - Return the size of the specified object.
247 int64_t getObjectSize(int ObjectIdx) const {
248 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
249 "Invalid Object Idx!");
250 return Objects[ObjectIdx+NumFixedObjects].Size;
253 /// setObjectSize - Change the size of the specified stack object.
254 void setObjectSize(int ObjectIdx, int64_t Size) {
255 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
256 "Invalid Object Idx!");
257 Objects[ObjectIdx+NumFixedObjects].Size = Size;
260 /// getObjectAlignment - Return the alignment of the specified stack object.
261 unsigned getObjectAlignment(int ObjectIdx) const {
262 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
263 "Invalid Object Idx!");
264 return Objects[ObjectIdx+NumFixedObjects].Alignment;
267 /// setObjectAlignment - Change the alignment of the specified stack object.
268 void setObjectAlignment(int ObjectIdx, unsigned Align) {
269 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
270 "Invalid Object Idx!");
271 Objects[ObjectIdx+NumFixedObjects].Alignment = Align;
272 MaxAlignment = std::max(MaxAlignment, Align);
275 /// getObjectOffset - Return the assigned stack offset of the specified object
276 /// from the incoming stack pointer.
278 int64_t getObjectOffset(int ObjectIdx) const {
279 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
280 "Invalid Object Idx!");
281 assert(!isDeadObjectIndex(ObjectIdx) &&
282 "Getting frame offset for a dead object?");
283 return Objects[ObjectIdx+NumFixedObjects].SPOffset;
286 /// setObjectOffset - Set the stack frame offset of the specified object. The
287 /// offset is relative to the stack pointer on entry to the function.
289 void setObjectOffset(int ObjectIdx, int64_t SPOffset) {
290 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
291 "Invalid Object Idx!");
292 assert(!isDeadObjectIndex(ObjectIdx) &&
293 "Setting frame offset for a dead object?");
294 Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
297 /// getStackSize - Return the number of bytes that must be allocated to hold
298 /// all of the fixed size frame objects. This is only valid after
299 /// Prolog/Epilog code insertion has finalized the stack frame layout.
301 uint64_t getStackSize() const { return StackSize; }
303 /// setStackSize - Set the size of the stack...
305 void setStackSize(uint64_t Size) { StackSize = Size; }
307 /// getOffsetAdjustment - Return the correction for frame offsets.
309 int getOffsetAdjustment() const { return OffsetAdjustment; }
311 /// setOffsetAdjustment - Set the correction for frame offsets.
313 void setOffsetAdjustment(int Adj) { OffsetAdjustment = Adj; }
315 /// getMaxAlignment - Return the alignment in bytes that this function must be
316 /// aligned to, which is greater than the default stack alignment provided by
319 unsigned getMaxAlignment() const { return MaxAlignment; }
321 /// setMaxAlignment - Set the preferred alignment.
323 void setMaxAlignment(unsigned Align) { MaxAlignment = Align; }
325 /// hasCalls - Return true if the current function has no function calls.
326 /// This is only valid during or after prolog/epilog code emission.
328 bool hasCalls() const { return HasCalls; }
329 void setHasCalls(bool V) { HasCalls = V; }
331 /// getMaxCallFrameSize - Return the maximum size of a call frame that must be
332 /// allocated for an outgoing function call. This is only available if
333 /// CallFrameSetup/Destroy pseudo instructions are used by the target, and
334 /// then only during or after prolog/epilog code insertion.
336 unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
337 void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
339 /// CreateFixedObject - Create a new object at a fixed location on the stack.
340 /// All fixed objects should be created before other objects are created for
341 /// efficiency. By default, fixed objects are immutable. This returns an
342 /// index with a negative value.
344 int CreateFixedObject(uint64_t Size, int64_t SPOffset,
345 bool Immutable, bool isSS);
348 /// isFixedObjectIndex - Returns true if the specified index corresponds to a
349 /// fixed stack object.
350 bool isFixedObjectIndex(int ObjectIdx) const {
351 return ObjectIdx < 0 && (ObjectIdx >= -(int)NumFixedObjects);
354 /// isImmutableObjectIndex - Returns true if the specified index corresponds
355 /// to an immutable object.
356 bool isImmutableObjectIndex(int ObjectIdx) const {
357 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
358 "Invalid Object Idx!");
359 return Objects[ObjectIdx+NumFixedObjects].isImmutable;
362 /// isSpillSlotObjectIndex - Returns true if the specified index corresponds
363 /// to a spill slot..
364 bool isSpillSlotObjectIndex(int ObjectIdx) const {
365 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
366 "Invalid Object Idx!");
367 return Objects[ObjectIdx+NumFixedObjects].isSpillSlot;;
370 /// isDeadObjectIndex - Returns true if the specified index corresponds to
372 bool isDeadObjectIndex(int ObjectIdx) const {
373 assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
374 "Invalid Object Idx!");
375 return Objects[ObjectIdx+NumFixedObjects].Size == ~0ULL;
378 /// CreateStackObject - Create a new statically sized stack object,
379 /// returning a nonnegative identifier to represent it.
381 int CreateStackObject(uint64_t Size, unsigned Alignment, bool isSS) {
382 assert(Size != 0 && "Cannot allocate zero size stack objects!");
383 Objects.push_back(StackObject(Size, Alignment, 0, false, isSS));
384 int Index = (int)Objects.size()-NumFixedObjects-1;
385 assert(Index >= 0 && "Bad frame index!");
386 MaxAlignment = std::max(MaxAlignment, Alignment);
390 /// CreateSpillStackObject - Create a new statically sized stack
391 /// object that represents a spill slot, returning a nonnegative
392 /// identifier to represent it.
394 int CreateSpillStackObject(uint64_t Size, unsigned Alignment) {
395 CreateStackObject(Size, Alignment, true);
396 int Index = (int)Objects.size()-NumFixedObjects-1;
397 MaxAlignment = std::max(MaxAlignment, Alignment);
401 /// RemoveStackObject - Remove or mark dead a statically sized stack object.
403 void RemoveStackObject(int ObjectIdx) {
405 Objects[ObjectIdx+NumFixedObjects].Size = ~0ULL;
408 /// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
409 /// variable sized object has been created. This must be created whenever a
410 /// variable sized object is created, whether or not the index returned is
413 int CreateVariableSizedObject() {
414 HasVarSizedObjects = true;
415 Objects.push_back(StackObject(0, 1, 0, false, false));
416 return (int)Objects.size()-NumFixedObjects-1;
419 /// getCalleeSavedInfo - Returns a reference to call saved info vector for the
420 /// current function.
421 const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
425 /// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
426 /// callee saved information.
427 void setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
431 /// isCalleeSavedInfoValid - Has the callee saved info been calculated yet?
432 bool isCalleeSavedInfoValid() const { return CSIValid; }
434 void setCalleeSavedInfoValid(bool v) { CSIValid = v; }
436 /// getPristineRegs - Return a set of physical registers that are pristine on
437 /// entry to the MBB.
439 /// Pristine registers hold a value that is useless to the current function,
440 /// but that must be preserved - they are callee saved registers that have not
443 /// Before the PrologueEpilogueInserter has placed the CSR spill code, this
444 /// method always returns an empty set.
445 BitVector getPristineRegs(const MachineBasicBlock *MBB) const;
447 /// getMachineModuleInfo - Used by a prologue/epilogue
448 /// emitter (TargetRegisterInfo) to provide frame layout information.
449 MachineModuleInfo *getMachineModuleInfo() const { return MMI; }
451 /// setMachineModuleInfo - Used by a meta info consumer to
452 /// indicate that frame layout information should be gathered.
453 void setMachineModuleInfo(MachineModuleInfo *mmi) { MMI = mmi; }
455 /// print - Used by the MachineFunction printer to print information about
456 /// stack objects. Implemented in MachineFunction.cpp
458 void print(const MachineFunction &MF, raw_ostream &OS) const;
460 /// dump - Print the function to stderr.
461 void dump(const MachineFunction &MF) const;
464 } // End llvm namespace