2002-12-28 21:08:28 +00:00
|
|
|
//===-- CodeGen/MachineFrameInfo.h - Abstract Stack Frame Rep. --*- C++ -*-===//
|
2005-04-21 20:39:54 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 19:59:42 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-21 20:39:54 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2008-01-25 17:49:41 +00:00
|
|
|
//
|
|
|
|
// The file defines the MachineFrameInfo class.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
2002-12-28 20:07:47 +00:00
|
|
|
|
2003-01-13 00:15:24 +00:00
|
|
|
#ifndef LLVM_CODEGEN_MACHINEFRAMEINFO_H
|
|
|
|
#define LLVM_CODEGEN_MACHINEFRAMEINFO_H
|
|
|
|
|
2009-11-12 20:49:22 +00:00
|
|
|
#include "llvm/ADT/SmallVector.h"
|
2010-11-29 18:16:10 +00:00
|
|
|
#include "llvm/Support/DataTypes.h"
|
2008-07-25 00:44:19 +00:00
|
|
|
#include <cassert>
|
2004-02-15 05:52:36 +00:00
|
|
|
#include <vector>
|
2003-11-11 22:41:34 +00:00
|
|
|
|
2004-02-15 05:52:36 +00:00
|
|
|
namespace llvm {
|
2009-08-23 01:12:47 +00:00
|
|
|
class raw_ostream;
|
2012-10-08 16:38:25 +00:00
|
|
|
class DataLayout;
|
2003-01-13 00:15:24 +00:00
|
|
|
class TargetRegisterClass;
|
2003-10-08 04:45:45 +00:00
|
|
|
class Type;
|
2003-01-16 18:35:57 +00:00
|
|
|
class MachineFunction;
|
2009-08-13 16:19:33 +00:00
|
|
|
class MachineBasicBlock;
|
2011-01-10 12:39:04 +00:00
|
|
|
class TargetFrameLowering;
|
2010-04-05 05:43:16 +00:00
|
|
|
class BitVector;
|
2012-09-06 09:17:37 +00:00
|
|
|
class Value;
|
2012-10-18 19:53:45 +00:00
|
|
|
class AllocaInst;
|
2003-11-11 22:41:34 +00:00
|
|
|
|
2006-08-25 19:45:51 +00:00
|
|
|
/// The CalleeSavedInfo class tracks the information need to locate where a
|
2010-08-27 21:38:11 +00:00
|
|
|
/// callee saved register is in the current frame.
|
2006-08-25 19:45:51 +00:00
|
|
|
class CalleeSavedInfo {
|
|
|
|
unsigned Reg;
|
|
|
|
int FrameIdx;
|
2010-08-13 20:08:59 +00:00
|
|
|
|
2006-08-25 19:45:51 +00:00
|
|
|
public:
|
2010-06-18 19:04:37 +00:00
|
|
|
explicit CalleeSavedInfo(unsigned R, int FI = 0)
|
2010-06-02 20:02:30 +00:00
|
|
|
: Reg(R), FrameIdx(FI) {}
|
2010-08-13 20:08:59 +00:00
|
|
|
|
2006-08-25 19:45:51 +00:00
|
|
|
// Accessors.
|
|
|
|
unsigned getReg() const { return Reg; }
|
|
|
|
int getFrameIdx() const { return FrameIdx; }
|
|
|
|
void setFrameIdx(int FI) { FrameIdx = FI; }
|
|
|
|
};
|
2006-05-23 15:32:15 +00:00
|
|
|
|
|
|
|
/// The MachineFrameInfo class represents an abstract stack frame until
|
|
|
|
/// prolog/epilog code is inserted. This class is key to allowing stack frame
|
|
|
|
/// representation optimizations, such as frame pointer elimination. It also
|
|
|
|
/// allows more mundane (but still important) optimizations, such as reordering
|
|
|
|
/// of abstract objects on the stack frame.
|
|
|
|
///
|
|
|
|
/// To support this, the class assigns unique integer identifiers to stack
|
|
|
|
/// objects requested clients. These identifiers are negative integers for
|
2008-07-10 19:57:25 +00:00
|
|
|
/// fixed stack objects (such as arguments passed on the stack) or nonnegative
|
2006-05-23 15:32:15 +00:00
|
|
|
/// for objects that may be reordered. Instructions which refer to stack
|
|
|
|
/// objects use a special MO_FrameIndex operand to represent these frame
|
|
|
|
/// indexes.
|
|
|
|
///
|
|
|
|
/// Because this class keeps track of all references to the stack frame, it
|
|
|
|
/// knows when a variable sized object is allocated on the stack. This is the
|
|
|
|
/// sole condition which prevents frame pointer elimination, which is an
|
|
|
|
/// important optimization on register-poor architectures. Because original
|
|
|
|
/// variable sized alloca's in the source program are the only source of
|
|
|
|
/// variable sized stack objects, it is safe to decide whether there will be
|
|
|
|
/// any variable sized objects before all stack objects are known (for
|
|
|
|
/// example, register allocator spill code never needs variable sized
|
|
|
|
/// objects).
|
|
|
|
///
|
|
|
|
/// When prolog/epilog code emission is performed, the final stack frame is
|
|
|
|
/// built and the machine instructions are modified to refer to the actual
|
|
|
|
/// stack offsets of the object, eliminating all MO_FrameIndex operands from
|
|
|
|
/// the program.
|
|
|
|
///
|
|
|
|
/// @brief Abstract Stack Frame Information
|
2002-12-28 21:08:28 +00:00
|
|
|
class MachineFrameInfo {
|
2002-12-28 20:07:47 +00:00
|
|
|
|
|
|
|
// StackObject - Represent a single object allocated on the stack.
|
|
|
|
struct StackObject {
|
2009-10-17 08:57:09 +00:00
|
|
|
// SPOffset - The offset of this object from the stack pointer on entry to
|
|
|
|
// the function. This field has no meaning for a variable sized element.
|
|
|
|
int64_t SPOffset;
|
2010-08-13 20:08:59 +00:00
|
|
|
|
2008-02-27 03:04:06 +00:00
|
|
|
// The size of this object on the stack. 0 means a variable sized object,
|
|
|
|
// ~0ULL means a dead object.
|
2007-04-25 04:07:31 +00:00
|
|
|
uint64_t Size;
|
2002-12-28 20:07:47 +00:00
|
|
|
|
|
|
|
// Alignment - The required alignment of this stack slot.
|
|
|
|
unsigned Alignment;
|
|
|
|
|
2008-01-10 07:19:43 +00:00
|
|
|
// isImmutable - If true, the value of the stack object is set before
|
|
|
|
// entering the function and is not modified inside the function. By
|
|
|
|
// default, fixed objects are immutable unless marked otherwise.
|
2008-01-10 02:18:37 +00:00
|
|
|
bool isImmutable;
|
2008-01-25 17:49:41 +00:00
|
|
|
|
2010-07-27 01:55:19 +00:00
|
|
|
// isSpillSlot - If true the stack object is used as spill slot. It
|
2009-10-17 09:20:14 +00:00
|
|
|
// cannot alias any other memory objects.
|
|
|
|
bool isSpillSlot;
|
|
|
|
|
2010-07-27 01:55:19 +00:00
|
|
|
// MayNeedSP - If true the stack object triggered the creation of the stack
|
|
|
|
// protector. We should allocate this object right after the stack
|
|
|
|
// protector.
|
|
|
|
bool MayNeedSP;
|
|
|
|
|
2012-09-06 09:17:37 +00:00
|
|
|
/// Alloca - If this stack object is originated from an Alloca instruction
|
|
|
|
/// this value saves the original IR allocation. Can be NULL.
|
2012-10-18 19:53:45 +00:00
|
|
|
const AllocaInst *Alloca;
|
2012-09-06 09:17:37 +00:00
|
|
|
|
2010-08-14 00:15:52 +00:00
|
|
|
// PreAllocated - If true, the object was mapped into the local frame
|
|
|
|
// block and doesn't need additional handling for allocation beyond that.
|
|
|
|
bool PreAllocated;
|
|
|
|
|
2010-07-27 01:55:19 +00:00
|
|
|
StackObject(uint64_t Sz, unsigned Al, int64_t SP, bool IM,
|
2012-10-18 19:53:45 +00:00
|
|
|
bool isSS, bool NSP, const AllocaInst *Val)
|
2009-10-17 09:20:14 +00:00
|
|
|
: SPOffset(SP), Size(Sz), Alignment(Al), isImmutable(IM),
|
2012-09-06 09:17:37 +00:00
|
|
|
isSpillSlot(isSS), MayNeedSP(NSP), Alloca(Val), PreAllocated(false) {}
|
2002-12-28 20:07:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/// Objects - The list of stack objects allocated...
|
|
|
|
///
|
|
|
|
std::vector<StackObject> Objects;
|
|
|
|
|
|
|
|
/// NumFixedObjects - This contains the number of fixed objects contained on
|
|
|
|
/// the stack. Because fixed objects are stored at a negative index in the
|
|
|
|
/// Objects list, this is also the index to the 0th object in the list.
|
|
|
|
///
|
|
|
|
unsigned NumFixedObjects;
|
|
|
|
|
|
|
|
/// HasVarSizedObjects - This boolean keeps track of whether any variable
|
|
|
|
/// sized objects have been allocated yet.
|
|
|
|
///
|
|
|
|
bool HasVarSizedObjects;
|
|
|
|
|
2008-09-27 01:56:22 +00:00
|
|
|
/// FrameAddressTaken - This boolean keeps track of whether there is a call
|
2009-03-03 02:55:14 +00:00
|
|
|
/// to builtin \@llvm.frameaddress.
|
2008-09-27 01:56:22 +00:00
|
|
|
bool FrameAddressTaken;
|
|
|
|
|
2010-05-22 01:47:14 +00:00
|
|
|
/// ReturnAddressTaken - This boolean keeps track of whether there is a call
|
|
|
|
/// to builtin \@llvm.returnaddress.
|
|
|
|
bool ReturnAddressTaken;
|
|
|
|
|
2002-12-28 20:07:47 +00:00
|
|
|
/// StackSize - The prolog/epilog code inserter calculates the final stack
|
|
|
|
/// offsets for all of the fixed size objects, updating the Objects list
|
|
|
|
/// above. It then updates StackSize to contain the number of bytes that need
|
|
|
|
/// to be allocated on entry to the function.
|
|
|
|
///
|
2007-04-25 04:07:31 +00:00
|
|
|
uint64_t StackSize;
|
2010-08-13 20:08:59 +00:00
|
|
|
|
2006-11-17 21:19:15 +00:00
|
|
|
/// OffsetAdjustment - The amount that a frame offset needs to be adjusted to
|
2009-09-25 05:30:55 +00:00
|
|
|
/// have the actual offset from the stack/frame pointer. The exact usage of
|
|
|
|
/// this is target-dependent, but it is typically used to adjust between
|
|
|
|
/// SP-relative and FP-relative offsets. E.G., if objects are accessed via
|
|
|
|
/// SP then OffsetAdjustment is zero; if FP is used, OffsetAdjustment is set
|
|
|
|
/// to the distance between the initial SP and the value in FP. For many
|
|
|
|
/// targets, this value is only used when generating debug info (via
|
|
|
|
/// TargetRegisterInfo::getFrameIndexOffset); when generating code, the
|
|
|
|
/// corresponding adjustments are performed directly.
|
2006-11-17 21:19:15 +00:00
|
|
|
int OffsetAdjustment;
|
2010-08-13 20:08:59 +00:00
|
|
|
|
|
|
|
/// MaxAlignment - The prolog/epilog code inserter may process objects
|
2005-11-06 09:00:38 +00:00
|
|
|
/// that require greater alignment than the default alignment the target
|
2010-08-13 20:08:59 +00:00
|
|
|
/// provides. To handle this, MaxAlignment is set to the maximum alignment
|
2005-11-06 17:40:18 +00:00
|
|
|
/// needed by the objects on the current frame. If this is greater than the
|
|
|
|
/// native alignment maintained by the compiler, dynamic alignment code will
|
|
|
|
/// be needed.
|
2005-11-06 09:00:38 +00:00
|
|
|
///
|
|
|
|
unsigned MaxAlignment;
|
2002-12-28 20:07:47 +00:00
|
|
|
|
2010-05-14 21:14:32 +00:00
|
|
|
/// AdjustsStack - Set to true if this function adjusts the stack -- e.g.,
|
|
|
|
/// when calling another function. This is only valid during and after
|
|
|
|
/// prolog/epilog code insertion.
|
|
|
|
bool AdjustsStack;
|
|
|
|
|
|
|
|
/// HasCalls - Set to true if this function has any function calls.
|
2002-12-28 20:07:47 +00:00
|
|
|
bool HasCalls;
|
|
|
|
|
2008-11-06 02:29:10 +00:00
|
|
|
/// StackProtectorIdx - The frame index for the stack protector.
|
|
|
|
int StackProtectorIdx;
|
|
|
|
|
2011-09-28 03:36:43 +00:00
|
|
|
/// FunctionContextIdx - The frame index for the function context. Used for
|
|
|
|
/// SjLj exceptions.
|
|
|
|
int FunctionContextIdx;
|
|
|
|
|
2002-12-28 20:07:47 +00:00
|
|
|
/// MaxCallFrameSize - This contains the size of the largest call frame if the
|
|
|
|
/// target uses frame setup/destroy pseudo instructions (as defined in the
|
|
|
|
/// TargetFrameInfo class). This information is important for frame pointer
|
|
|
|
/// elimination. If is only valid during and after prolog/epilog code
|
|
|
|
/// insertion.
|
|
|
|
///
|
|
|
|
unsigned MaxCallFrameSize;
|
2010-08-13 20:08:59 +00:00
|
|
|
|
2006-08-25 19:45:51 +00:00
|
|
|
/// CSInfo - The prolog/epilog code inserter fills in this vector with each
|
2006-08-25 22:56:30 +00:00
|
|
|
/// callee saved register saved in the frame. Beyond its use by the prolog/
|
2006-08-25 19:45:51 +00:00
|
|
|
/// epilog code inserter, this data used for debug info and exception
|
|
|
|
/// handling.
|
|
|
|
std::vector<CalleeSavedInfo> CSInfo;
|
2009-08-13 16:19:33 +00:00
|
|
|
|
|
|
|
/// CSIValid - Has CSInfo been set yet?
|
|
|
|
bool CSIValid;
|
|
|
|
|
2011-01-10 12:39:04 +00:00
|
|
|
/// TargetFrameLowering - Target information about frame layout.
|
2008-01-25 07:19:06 +00:00
|
|
|
///
|
2011-01-10 12:39:04 +00:00
|
|
|
const TargetFrameLowering &TFI;
|
2009-11-12 20:49:22 +00:00
|
|
|
|
2010-08-14 00:15:52 +00:00
|
|
|
/// LocalFrameObjects - References to frame indices which are mapped
|
|
|
|
/// into the local frame allocation block. <FrameIdx, LocalOffset>
|
|
|
|
SmallVector<std::pair<int, int64_t>, 32> LocalFrameObjects;
|
|
|
|
|
|
|
|
/// LocalFrameSize - Size of the pre-allocated local frame block.
|
|
|
|
int64_t LocalFrameSize;
|
|
|
|
|
2010-08-16 22:30:41 +00:00
|
|
|
/// Required alignment of the local object blob, which is the strictest
|
|
|
|
/// alignment of any object in it.
|
|
|
|
unsigned LocalFrameMaxAlign;
|
|
|
|
|
2010-08-19 02:47:08 +00:00
|
|
|
/// Whether the local object blob needs to be allocated together. If not,
|
|
|
|
/// PEI should ignore the isPreAllocated flags on the stack objects and
|
|
|
|
/// just allocate them normally.
|
|
|
|
bool UseLocalStackAllocationBlock;
|
|
|
|
|
2012-12-04 00:52:33 +00:00
|
|
|
/// Whether the "realign-stack" option is on.
|
|
|
|
bool RealignOption;
|
2002-12-28 20:07:47 +00:00
|
|
|
public:
|
2012-12-04 00:52:33 +00:00
|
|
|
explicit MachineFrameInfo(const TargetFrameLowering &tfi, bool RealignOpt)
|
|
|
|
: TFI(tfi), RealignOption(RealignOpt) {
|
2007-04-27 14:43:05 +00:00
|
|
|
StackSize = NumFixedObjects = OffsetAdjustment = MaxAlignment = 0;
|
2002-12-28 20:07:47 +00:00
|
|
|
HasVarSizedObjects = false;
|
2008-09-27 01:56:22 +00:00
|
|
|
FrameAddressTaken = false;
|
2010-05-22 01:47:14 +00:00
|
|
|
ReturnAddressTaken = false;
|
2010-05-14 21:14:32 +00:00
|
|
|
AdjustsStack = false;
|
2002-12-28 20:07:47 +00:00
|
|
|
HasCalls = false;
|
2008-11-06 02:29:10 +00:00
|
|
|
StackProtectorIdx = -1;
|
2011-09-28 03:36:43 +00:00
|
|
|
FunctionContextIdx = -1;
|
2002-12-28 20:07:47 +00:00
|
|
|
MaxCallFrameSize = 0;
|
2009-08-13 16:19:33 +00:00
|
|
|
CSIValid = false;
|
2010-08-14 00:15:52 +00:00
|
|
|
LocalFrameSize = 0;
|
2010-08-16 22:30:41 +00:00
|
|
|
LocalFrameMaxAlign = 0;
|
2010-08-20 17:34:22 +00:00
|
|
|
UseLocalStackAllocationBlock = false;
|
2002-12-28 20:07:47 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// hasStackObjects - Return true if there are any stack objects in this
|
|
|
|
/// function.
|
|
|
|
///
|
|
|
|
bool hasStackObjects() const { return !Objects.empty(); }
|
|
|
|
|
|
|
|
/// hasVarSizedObjects - This method may be called any time after instruction
|
|
|
|
/// selection is complete to determine if the stack frame for this function
|
|
|
|
/// contains any variable sized objects.
|
|
|
|
///
|
|
|
|
bool hasVarSizedObjects() const { return HasVarSizedObjects; }
|
|
|
|
|
2008-11-06 02:29:10 +00:00
|
|
|
/// getStackProtectorIndex/setStackProtectorIndex - Return the index for the
|
|
|
|
/// stack protector object.
|
|
|
|
///
|
|
|
|
int getStackProtectorIndex() const { return StackProtectorIdx; }
|
|
|
|
void setStackProtectorIndex(int I) { StackProtectorIdx = I; }
|
|
|
|
|
2011-09-28 03:36:43 +00:00
|
|
|
/// getFunctionContextIndex/setFunctionContextIndex - Return the index for the
|
|
|
|
/// function context object. This object is used for SjLj exceptions.
|
|
|
|
int getFunctionContextIndex() const { return FunctionContextIdx; }
|
|
|
|
void setFunctionContextIndex(int I) { FunctionContextIdx = I; }
|
|
|
|
|
2008-09-27 01:56:22 +00:00
|
|
|
/// isFrameAddressTaken - This method may be called any time after instruction
|
|
|
|
/// selection is complete to determine if there is a call to
|
2009-03-03 02:55:14 +00:00
|
|
|
/// \@llvm.frameaddress in this function.
|
2008-09-27 01:56:22 +00:00
|
|
|
bool isFrameAddressTaken() const { return FrameAddressTaken; }
|
|
|
|
void setFrameAddressIsTaken(bool T) { FrameAddressTaken = T; }
|
|
|
|
|
2010-08-13 20:08:59 +00:00
|
|
|
/// isReturnAddressTaken - This method may be called any time after
|
|
|
|
/// instruction selection is complete to determine if there is a call to
|
2010-05-22 01:47:14 +00:00
|
|
|
/// \@llvm.returnaddress in this function.
|
|
|
|
bool isReturnAddressTaken() const { return ReturnAddressTaken; }
|
|
|
|
void setReturnAddressIsTaken(bool s) { ReturnAddressTaken = s; }
|
|
|
|
|
2008-10-28 05:32:08 +00:00
|
|
|
/// getObjectIndexBegin - Return the minimum frame object index.
|
2002-12-28 20:07:47 +00:00
|
|
|
///
|
|
|
|
int getObjectIndexBegin() const { return -NumFixedObjects; }
|
|
|
|
|
2008-10-28 05:32:08 +00:00
|
|
|
/// getObjectIndexEnd - Return one past the maximum frame object index.
|
2002-12-28 20:07:47 +00:00
|
|
|
///
|
2008-05-05 18:30:58 +00:00
|
|
|
int getObjectIndexEnd() const { return (int)Objects.size()-NumFixedObjects; }
|
2002-12-28 20:07:47 +00:00
|
|
|
|
2010-08-13 20:32:35 +00:00
|
|
|
/// getNumFixedObjects - Return the number of fixed objects.
|
2008-06-04 09:18:41 +00:00
|
|
|
unsigned getNumFixedObjects() const { return NumFixedObjects; }
|
|
|
|
|
2010-08-13 20:32:35 +00:00
|
|
|
/// getNumObjects - Return the number of objects.
|
2008-06-04 09:18:41 +00:00
|
|
|
///
|
|
|
|
unsigned getNumObjects() const { return Objects.size(); }
|
|
|
|
|
2010-08-14 00:15:52 +00:00
|
|
|
/// mapLocalFrameObject - Map a frame index into the local object block
|
|
|
|
void mapLocalFrameObject(int ObjectIndex, int64_t Offset) {
|
|
|
|
LocalFrameObjects.push_back(std::pair<int, int64_t>(ObjectIndex, Offset));
|
|
|
|
Objects[ObjectIndex + NumFixedObjects].PreAllocated = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// getLocalFrameObjectMap - Get the local offset mapping for a for an object
|
|
|
|
std::pair<int, int64_t> getLocalFrameObjectMap(int i) {
|
|
|
|
assert (i >= 0 && (unsigned)i < LocalFrameObjects.size() &&
|
|
|
|
"Invalid local object reference!");
|
|
|
|
return LocalFrameObjects[i];
|
|
|
|
}
|
|
|
|
|
|
|
|
/// getLocalFrameObjectCount - Return the number of objects allocated into
|
|
|
|
/// the local object block.
|
|
|
|
int64_t getLocalFrameObjectCount() { return LocalFrameObjects.size(); }
|
|
|
|
|
2010-08-16 18:06:15 +00:00
|
|
|
/// setLocalFrameSize - Set the size of the local object blob.
|
|
|
|
void setLocalFrameSize(int64_t sz) { LocalFrameSize = sz; }
|
|
|
|
|
2010-08-14 00:15:52 +00:00
|
|
|
/// getLocalFrameSize - Get the size of the local object blob.
|
|
|
|
int64_t getLocalFrameSize() const { return LocalFrameSize; }
|
|
|
|
|
2010-08-16 22:30:41 +00:00
|
|
|
/// setLocalFrameMaxAlign - Required alignment of the local object blob,
|
|
|
|
/// which is the strictest alignment of any object in it.
|
|
|
|
void setLocalFrameMaxAlign(unsigned Align) { LocalFrameMaxAlign = Align; }
|
|
|
|
|
|
|
|
/// getLocalFrameMaxAlign - Return the required alignment of the local
|
|
|
|
/// object blob.
|
2010-09-03 18:17:16 +00:00
|
|
|
unsigned getLocalFrameMaxAlign() const { return LocalFrameMaxAlign; }
|
2010-08-16 22:30:41 +00:00
|
|
|
|
2010-08-19 02:47:08 +00:00
|
|
|
/// getUseLocalStackAllocationBlock - Get whether the local allocation blob
|
|
|
|
/// should be allocated together or let PEI allocate the locals in it
|
|
|
|
/// directly.
|
|
|
|
bool getUseLocalStackAllocationBlock() {return UseLocalStackAllocationBlock;}
|
|
|
|
|
|
|
|
/// setUseLocalStackAllocationBlock - Set whether the local allocation blob
|
|
|
|
/// should be allocated together or let PEI allocate the locals in it
|
|
|
|
/// directly.
|
|
|
|
void setUseLocalStackAllocationBlock(bool v) {
|
|
|
|
UseLocalStackAllocationBlock = v;
|
|
|
|
}
|
2010-08-16 22:30:41 +00:00
|
|
|
|
2010-08-14 00:15:52 +00:00
|
|
|
/// isObjectPreAllocated - Return true if the object was pre-allocated into
|
|
|
|
/// the local block.
|
|
|
|
bool isObjectPreAllocated(int ObjectIdx) const {
|
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
|
|
|
return Objects[ObjectIdx+NumFixedObjects].PreAllocated;
|
|
|
|
}
|
|
|
|
|
2008-10-28 05:32:08 +00:00
|
|
|
/// getObjectSize - Return the size of the specified object.
|
2002-12-28 20:07:47 +00:00
|
|
|
///
|
2007-04-25 04:20:54 +00:00
|
|
|
int64_t getObjectSize(int ObjectIdx) const {
|
2008-01-25 17:49:41 +00:00
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
2002-12-28 20:07:47 +00:00
|
|
|
return Objects[ObjectIdx+NumFixedObjects].Size;
|
|
|
|
}
|
|
|
|
|
2008-10-28 05:31:31 +00:00
|
|
|
/// setObjectSize - Change the size of the specified stack object.
|
2008-06-04 09:18:41 +00:00
|
|
|
void setObjectSize(int ObjectIdx, int64_t Size) {
|
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
|
|
|
Objects[ObjectIdx+NumFixedObjects].Size = Size;
|
|
|
|
}
|
|
|
|
|
2008-10-28 05:31:31 +00:00
|
|
|
/// getObjectAlignment - Return the alignment of the specified stack object.
|
2008-02-28 00:43:03 +00:00
|
|
|
unsigned getObjectAlignment(int ObjectIdx) const {
|
2008-01-25 17:49:41 +00:00
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
2002-12-28 20:07:47 +00:00
|
|
|
return Objects[ObjectIdx+NumFixedObjects].Alignment;
|
|
|
|
}
|
|
|
|
|
2008-10-28 05:31:31 +00:00
|
|
|
/// setObjectAlignment - Change the alignment of the specified stack object.
|
2008-05-15 08:39:06 +00:00
|
|
|
void setObjectAlignment(int ObjectIdx, unsigned Align) {
|
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
|
|
|
Objects[ObjectIdx+NumFixedObjects].Alignment = Align;
|
2012-06-19 22:59:12 +00:00
|
|
|
ensureMaxAlignment(Align);
|
2008-05-15 08:39:06 +00:00
|
|
|
}
|
|
|
|
|
2012-09-06 09:17:37 +00:00
|
|
|
/// getObjectAllocation - Return the underlying Alloca of the specified
|
|
|
|
/// stack object if it exists. Returns 0 if none exists.
|
2012-10-18 19:53:45 +00:00
|
|
|
const AllocaInst* getObjectAllocation(int ObjectIdx) const {
|
2012-09-06 09:17:37 +00:00
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
|
|
|
return Objects[ObjectIdx+NumFixedObjects].Alloca;
|
|
|
|
}
|
|
|
|
|
2010-07-27 01:55:19 +00:00
|
|
|
/// NeedsStackProtector - Returns true if the object may need stack
|
|
|
|
/// protectors.
|
|
|
|
bool MayNeedStackProtector(int ObjectIdx) const {
|
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
|
|
|
return Objects[ObjectIdx+NumFixedObjects].MayNeedSP;
|
|
|
|
}
|
|
|
|
|
2002-12-28 20:07:47 +00:00
|
|
|
/// getObjectOffset - Return the assigned stack offset of the specified object
|
|
|
|
/// from the incoming stack pointer.
|
|
|
|
///
|
2007-04-25 04:20:54 +00:00
|
|
|
int64_t getObjectOffset(int ObjectIdx) const {
|
2008-01-25 17:49:41 +00:00
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
2008-02-27 19:57:11 +00:00
|
|
|
assert(!isDeadObjectIndex(ObjectIdx) &&
|
|
|
|
"Getting frame offset for a dead object?");
|
2002-12-28 20:07:47 +00:00
|
|
|
return Objects[ObjectIdx+NumFixedObjects].SPOffset;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// setObjectOffset - Set the stack frame offset of the specified object. The
|
|
|
|
/// offset is relative to the stack pointer on entry to the function.
|
|
|
|
///
|
2007-04-25 04:20:54 +00:00
|
|
|
void setObjectOffset(int ObjectIdx, int64_t SPOffset) {
|
2008-01-25 17:49:41 +00:00
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
2008-02-27 19:57:11 +00:00
|
|
|
assert(!isDeadObjectIndex(ObjectIdx) &&
|
|
|
|
"Setting frame offset for a dead object?");
|
2002-12-28 20:07:47 +00:00
|
|
|
Objects[ObjectIdx+NumFixedObjects].SPOffset = SPOffset;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// getStackSize - Return the number of bytes that must be allocated to hold
|
|
|
|
/// all of the fixed size frame objects. This is only valid after
|
|
|
|
/// Prolog/Epilog code insertion has finalized the stack frame layout.
|
|
|
|
///
|
2007-04-25 04:29:06 +00:00
|
|
|
uint64_t getStackSize() const { return StackSize; }
|
2002-12-28 20:07:47 +00:00
|
|
|
|
|
|
|
/// setStackSize - Set the size of the stack...
|
|
|
|
///
|
2007-04-25 04:29:06 +00:00
|
|
|
void setStackSize(uint64_t Size) { StackSize = Size; }
|
2010-08-13 20:08:59 +00:00
|
|
|
|
2013-03-14 21:15:20 +00:00
|
|
|
/// Estimate and return the size of the stack frame.
|
|
|
|
unsigned estimateStackSize(const MachineFunction &MF) const;
|
|
|
|
|
2006-11-17 21:19:15 +00:00
|
|
|
/// getOffsetAdjustment - Return the correction for frame offsets.
|
|
|
|
///
|
|
|
|
int getOffsetAdjustment() const { return OffsetAdjustment; }
|
2010-08-13 20:08:59 +00:00
|
|
|
|
2006-11-17 21:19:15 +00:00
|
|
|
/// setOffsetAdjustment - Set the correction for frame offsets.
|
|
|
|
///
|
|
|
|
void setOffsetAdjustment(int Adj) { OffsetAdjustment = Adj; }
|
2002-12-28 20:07:47 +00:00
|
|
|
|
2010-08-13 20:08:59 +00:00
|
|
|
/// getMaxAlignment - Return the alignment in bytes that this function must be
|
|
|
|
/// aligned to, which is greater than the default stack alignment provided by
|
2005-11-06 09:00:38 +00:00
|
|
|
/// the target.
|
|
|
|
///
|
|
|
|
unsigned getMaxAlignment() const { return MaxAlignment; }
|
2010-08-13 20:08:59 +00:00
|
|
|
|
2012-06-19 22:59:12 +00:00
|
|
|
/// ensureMaxAlignment - Make sure the function is at least Align bytes
|
|
|
|
/// aligned.
|
2012-12-04 00:26:44 +00:00
|
|
|
void ensureMaxAlignment(unsigned Align);
|
2009-12-02 19:30:24 +00:00
|
|
|
|
2010-05-14 21:14:32 +00:00
|
|
|
/// AdjustsStack - Return true if this function adjusts the stack -- e.g.,
|
|
|
|
/// when calling another function. This is only valid during and after
|
|
|
|
/// prolog/epilog code insertion.
|
|
|
|
bool adjustsStack() const { return AdjustsStack; }
|
|
|
|
void setAdjustsStack(bool V) { AdjustsStack = V; }
|
|
|
|
|
|
|
|
/// hasCalls - Return true if the current function has any function calls.
|
2002-12-28 20:07:47 +00:00
|
|
|
bool hasCalls() const { return HasCalls; }
|
|
|
|
void setHasCalls(bool V) { HasCalls = V; }
|
2005-04-21 20:39:54 +00:00
|
|
|
|
2002-12-28 20:07:47 +00:00
|
|
|
/// getMaxCallFrameSize - Return the maximum size of a call frame that must be
|
|
|
|
/// allocated for an outgoing function call. This is only available if
|
|
|
|
/// CallFrameSetup/Destroy pseudo instructions are used by the target, and
|
|
|
|
/// then only during or after prolog/epilog code insertion.
|
|
|
|
///
|
|
|
|
unsigned getMaxCallFrameSize() const { return MaxCallFrameSize; }
|
|
|
|
void setMaxCallFrameSize(unsigned S) { MaxCallFrameSize = S; }
|
|
|
|
|
|
|
|
/// CreateFixedObject - Create a new object at a fixed location on the stack.
|
|
|
|
/// All fixed objects should be created before other objects are created for
|
2008-01-10 02:18:37 +00:00
|
|
|
/// efficiency. By default, fixed objects are immutable. This returns an
|
|
|
|
/// index with a negative value.
|
2002-12-28 20:07:47 +00:00
|
|
|
///
|
2010-07-03 00:40:23 +00:00
|
|
|
int CreateFixedObject(uint64_t Size, int64_t SPOffset, bool Immutable);
|
2010-08-13 20:08:59 +00:00
|
|
|
|
|
|
|
|
2007-04-04 07:38:25 +00:00
|
|
|
/// isFixedObjectIndex - Returns true if the specified index corresponds to a
|
|
|
|
/// fixed stack object.
|
|
|
|
bool isFixedObjectIndex(int ObjectIdx) const {
|
|
|
|
return ObjectIdx < 0 && (ObjectIdx >= -(int)NumFixedObjects);
|
|
|
|
}
|
|
|
|
|
2008-01-10 02:18:37 +00:00
|
|
|
/// isImmutableObjectIndex - Returns true if the specified index corresponds
|
|
|
|
/// to an immutable object.
|
|
|
|
bool isImmutableObjectIndex(int ObjectIdx) const {
|
2008-01-25 17:49:41 +00:00
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
2008-01-10 02:18:37 +00:00
|
|
|
return Objects[ObjectIdx+NumFixedObjects].isImmutable;
|
|
|
|
}
|
|
|
|
|
2009-10-17 09:20:14 +00:00
|
|
|
/// isSpillSlotObjectIndex - Returns true if the specified index corresponds
|
|
|
|
/// to a spill slot..
|
|
|
|
bool isSpillSlotObjectIndex(int ObjectIdx) const {
|
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
2011-12-10 03:16:20 +00:00
|
|
|
return Objects[ObjectIdx+NumFixedObjects].isSpillSlot;
|
2009-10-17 09:20:14 +00:00
|
|
|
}
|
|
|
|
|
2008-02-27 03:04:06 +00:00
|
|
|
/// isDeadObjectIndex - Returns true if the specified index corresponds to
|
|
|
|
/// a dead object.
|
|
|
|
bool isDeadObjectIndex(int ObjectIdx) const {
|
|
|
|
assert(unsigned(ObjectIdx+NumFixedObjects) < Objects.size() &&
|
|
|
|
"Invalid Object Idx!");
|
|
|
|
return Objects[ObjectIdx+NumFixedObjects].Size == ~0ULL;
|
|
|
|
}
|
|
|
|
|
2010-07-27 01:55:19 +00:00
|
|
|
/// CreateStackObject - Create a new statically sized stack object, returning
|
2013-02-08 20:35:15 +00:00
|
|
|
/// a nonnegative identifier to represent it.
|
2002-12-28 20:07:47 +00:00
|
|
|
///
|
2010-07-27 01:55:19 +00:00
|
|
|
int CreateStackObject(uint64_t Size, unsigned Alignment, bool isSS,
|
2013-02-08 20:35:15 +00:00
|
|
|
bool MayNeedSP = false, const AllocaInst *Alloca = 0);
|
2009-11-12 20:49:22 +00:00
|
|
|
|
2010-07-27 01:55:19 +00:00
|
|
|
/// CreateSpillStackObject - Create a new statically sized stack object that
|
|
|
|
/// represents a spill slot, returning a nonnegative identifier to represent
|
|
|
|
/// it.
|
2009-11-12 20:49:22 +00:00
|
|
|
///
|
2012-12-04 00:26:44 +00:00
|
|
|
int CreateSpillStackObject(uint64_t Size, unsigned Alignment);
|
2002-12-28 20:07:47 +00:00
|
|
|
|
2008-02-27 03:04:06 +00:00
|
|
|
/// RemoveStackObject - Remove or mark dead a statically sized stack object.
|
|
|
|
///
|
|
|
|
void RemoveStackObject(int ObjectIdx) {
|
2008-06-04 09:18:41 +00:00
|
|
|
// Mark it dead.
|
|
|
|
Objects[ObjectIdx+NumFixedObjects].Size = ~0ULL;
|
2008-02-27 03:04:06 +00:00
|
|
|
}
|
|
|
|
|
2002-12-28 21:08:28 +00:00
|
|
|
/// CreateVariableSizedObject - Notify the MachineFrameInfo object that a
|
2002-12-28 20:07:47 +00:00
|
|
|
/// variable sized object has been created. This must be created whenever a
|
|
|
|
/// variable sized object is created, whether or not the index returned is
|
|
|
|
/// actually used.
|
|
|
|
///
|
2013-02-08 20:35:15 +00:00
|
|
|
int CreateVariableSizedObject(unsigned Alignment);
|
2009-11-12 20:49:22 +00:00
|
|
|
|
2006-08-25 19:45:51 +00:00
|
|
|
/// getCalleeSavedInfo - Returns a reference to call saved info vector for the
|
|
|
|
/// current function.
|
2006-08-25 22:56:30 +00:00
|
|
|
const std::vector<CalleeSavedInfo> &getCalleeSavedInfo() const {
|
|
|
|
return CSInfo;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// setCalleeSavedInfo - Used by prolog/epilog inserter to set the function's
|
|
|
|
/// callee saved information.
|
2010-07-20 21:05:58 +00:00
|
|
|
void setCalleeSavedInfo(const std::vector<CalleeSavedInfo> &CSI) {
|
2006-08-25 22:56:30 +00:00
|
|
|
CSInfo = CSI;
|
|
|
|
}
|
2002-12-28 20:07:47 +00:00
|
|
|
|
2009-08-13 16:19:33 +00:00
|
|
|
/// isCalleeSavedInfoValid - Has the callee saved info been calculated yet?
|
|
|
|
bool isCalleeSavedInfoValid() const { return CSIValid; }
|
|
|
|
|
|
|
|
void setCalleeSavedInfoValid(bool v) { CSIValid = v; }
|
|
|
|
|
|
|
|
/// getPristineRegs - Return a set of physical registers that are pristine on
|
|
|
|
/// entry to the MBB.
|
|
|
|
///
|
|
|
|
/// Pristine registers hold a value that is useless to the current function,
|
|
|
|
/// but that must be preserved - they are callee saved registers that have not
|
|
|
|
/// been saved yet.
|
|
|
|
///
|
|
|
|
/// Before the PrologueEpilogueInserter has placed the CSR spill code, this
|
|
|
|
/// method always returns an empty set.
|
|
|
|
BitVector getPristineRegs(const MachineBasicBlock *MBB) const;
|
|
|
|
|
2002-12-28 20:07:47 +00:00
|
|
|
/// print - Used by the MachineFunction printer to print information about
|
2010-07-20 21:05:58 +00:00
|
|
|
/// stack objects. Implemented in MachineFunction.cpp
|
2002-12-28 20:07:47 +00:00
|
|
|
///
|
2009-08-23 01:12:47 +00:00
|
|
|
void print(const MachineFunction &MF, raw_ostream &OS) const;
|
2002-12-28 20:07:47 +00:00
|
|
|
|
2009-08-03 01:02:24 +00:00
|
|
|
/// dump - Print the function to stderr.
|
2003-01-16 18:35:57 +00:00
|
|
|
void dump(const MachineFunction &MF) const;
|
2002-12-28 20:07:47 +00:00
|
|
|
};
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2002-12-28 20:07:47 +00:00
|
|
|
#endif
|