include/llvm/Target/TargetFrameInfo.h

   1 //===-- llvm/Target/TargetFrameInfo.h ---------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Interface to describe the layout of a stack frame on the target machine.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TARGET_TARGETFRAMEINFO_H
  15 #define LLVM_TARGET_TARGETFRAMEINFO_H
  16
  17 #include <utility>
  18
  19 namespace llvm {
  20
  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.
  24 ///
  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 {
  29 public:
  30   enum StackDirection {
  31     StackGrowsUp,        // Adding to the stack increases the stack address
  32     StackGrowsDown       // Adding to the stack decreases the stack address
  33   };
  34 private:
  35   StackDirection StackDir;
  36   unsigned StackAlignment;
  37   unsigned TransientStackAlignment;
  38   int LocalAreaOffset;
  39 public:
  40   TargetFrameInfo(StackDirection D, unsigned StackAl, int LAO,
  41                   unsigned TransAl = 1)
  42     : StackDir(D), StackAlignment(StackAl), TransientStackAlignment(TransAl),
  43       LocalAreaOffset(LAO) {}
  44
  45   virtual ~TargetFrameInfo();
  46
  47   // These methods return information that describes the abstract stack layout
  48   // of the target machine.
  49
  50   /// getStackGrowthDirection - Return the direction the stack grows
  51   ///
  52   StackDirection getStackGrowthDirection() const { return StackDir; }
  53
  54   /// getStackAlignment - This method returns the number of bytes to which the
  55   /// stack pointer must be aligned on entry to a function.  Typically, this
  56   /// is the largest alignment for any data object in the target.
  57   ///
  58   unsigned getStackAlignment() const { return StackAlignment; }
  59
  60   /// getTransientStackAlignment - This method returns the number of bytes to
  61   /// which the stack pointer must be aligned at all times, even between
  62   /// calls.
  63   ///
  64   unsigned getTransientStackAlignment() const {
  65     return TransientStackAlignment;
  66   }
  67
  68   /// getOffsetOfLocalArea - This method returns the offset of the local area
  69   /// from the stack pointer on entrance to a function.
  70   ///
  71   int getOffsetOfLocalArea() const { return LocalAreaOffset; }
  72
  73   /// getCalleeSavedSpillSlots - This method returns a pointer to an array of
  74   /// pairs, that contains an entry for each callee saved register that must be
  75   /// spilled to a particular stack location if it is spilled.
  76   ///
  77   /// Each entry in this array contains a <register,offset> pair, indicating the
  78   /// fixed offset from the incoming stack pointer that each register should be
  79   /// spilled at.  If a register is not listed here, the code generator is
  80   /// allowed to spill it anywhere it chooses.
  81   ///
  82   virtual const std::pair<unsigned, int> *
  83   getCalleeSavedSpillSlots(unsigned &NumEntries) const {
  84     NumEntries = 0;
  85     return 0;
  86   }
  87 };
  88
  89 } // End llvm namespace
  90
  91 #endif