1 //===-- llvm/Target/TargetFrameInfo.h ---------------------------*- 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 // Interface to describe the layout of a stack frame on the target machine.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_TARGET_TARGETFRAMEINFO_H
15 #define LLVM_TARGET_TARGETFRAMEINFO_H
21 /// Information about stack frame layout on the target. It holds the direction
22 /// of stack growth, the known stack alignment on entry to each function, and
23 /// the offset to the locals area.
25 /// The offset to the local area is the offset from the stack pointer on
26 /// function entry to the first location where function data (local variables,
27 /// spill locations) can be stored.
28 class TargetFrameInfo {
31 StackGrowsUp, // Adding to the stack increases the stack address
32 StackGrowsDown // Adding to the stack decreases the stack address
35 StackDirection StackDir;
36 unsigned StackAlignment;
39 TargetFrameInfo(StackDirection D, unsigned StackAl, int LAO)
40 : StackDir(D), StackAlignment(StackAl), LocalAreaOffset(LAO) {}
42 virtual ~TargetFrameInfo();
44 // These methods return information that describes the abstract stack layout
45 // of the target machine.
47 /// getStackGrowthDirection - Return the direction the stack grows
49 StackDirection getStackGrowthDirection() const { return StackDir; }
51 /// getStackAlignment - This method returns the number of bytes that the stack
52 /// pointer must be aligned to. Typically, this is the largest alignment for
53 /// any data object in the target.
55 unsigned getStackAlignment() const { return StackAlignment; }
57 /// getOffsetOfLocalArea - This method returns the offset of the local area
58 /// from the stack pointer on entrance to a function.
60 int getOffsetOfLocalArea() const { return LocalAreaOffset; }
62 /// getCalleeSavedSpillSlots - This method returns a pointer to an array of
63 /// pairs, that contains an entry for each callee saved register that must be
64 /// spilled to a particular stack location if it is spilled.
66 /// Each entry in this array contains a <register,offset> pair, indicating the
67 /// fixed offset from the incoming stack pointer that each register should be
68 /// spilled at. If a register is not listed here, the code generator is
69 /// allowed to spill it anywhere it chooses.
71 virtual const std::pair<unsigned, int> *
72 getCalleeSavedSpillSlots(unsigned &NumEntries) const {
78 } // End llvm namespace