Aggressively prune the DFS when inserting phi-defs.
[oota-llvm.git] / include / llvm / Target / TargetFrameInfo.h
index 0f82e27470adf323586e2e14582a6e7aa321fcf7..975d15659c15f1c6730036ce744262ab5dad0625 100644 (file)
@@ -1,10 +1,10 @@
 //===-- llvm/Target/TargetFrameInfo.h ---------------------------*- C++ -*-===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
 //===----------------------------------------------------------------------===//
 //
 // Interface to describe the layout of a stack frame on the target machine.
 #ifndef LLVM_TARGET_TARGETFRAMEINFO_H
 #define LLVM_TARGET_TARGETFRAMEINFO_H
 
-class MachineFunction;
+#include <utility>
 
-struct TargetFrameInfo {
+namespace llvm {
+
+/// Information about stack frame layout on the target.  It holds the direction
+/// of stack growth, the known stack alignment on entry to each function, and
+/// the offset to the locals area.
+///
+/// The offset to the local area is the offset from the stack pointer on
+/// function entry to the first location where function data (local variables,
+/// spill locations) can be stored.
+class TargetFrameInfo {
+public:
   enum StackDirection {
     StackGrowsUp,        // Adding to the stack increases the stack address
     StackGrowsDown       // Adding to the stack decreases the stack address
   };
+
+  // Maps a callee saved register to a stack slot with a fixed offset.
+  struct SpillSlot {
+    unsigned Reg;
+    int Offset; // Offset relative to stack pointer on function entry.
+  };
 private:
   StackDirection StackDir;
   unsigned StackAlignment;
+  unsigned TransientStackAlignment;
   int LocalAreaOffset;
 public:
-  TargetFrameInfo(StackDirection D, unsigned StackAl, int LAO)
-    : StackDir(D), StackAlignment(StackAl), LocalAreaOffset(LAO) {}
+  TargetFrameInfo(StackDirection D, unsigned StackAl, int LAO,
+                  unsigned TransAl = 1)
+    : StackDir(D), StackAlignment(StackAl), TransientStackAlignment(TransAl),
+      LocalAreaOffset(LAO) {}
+
+  virtual ~TargetFrameInfo();
 
   // These methods return information that describes the abstract stack layout
   // of the target machine.
@@ -36,67 +57,41 @@ public:
   ///
   StackDirection getStackGrowthDirection() const { return StackDir; }
 
-  /// getStackAlignment - This method returns the number of bytes that the stack
-  /// pointer must be aligned to.  Typically, this is the largest alignment for
-  /// any data object in the target.
+  /// getStackAlignment - This method returns the number of bytes to which the
+  /// stack pointer must be aligned on entry to a function.  Typically, this
+  /// is the largest alignment for any data object in the target.
   ///
   unsigned getStackAlignment() const { return StackAlignment; }
 
+  /// getTransientStackAlignment - This method returns the number of bytes to
+  /// which the stack pointer must be aligned at all times, even between
+  /// calls.
+  ///
+  unsigned getTransientStackAlignment() const {
+    return TransientStackAlignment;
+  }
+
   /// getOffsetOfLocalArea - This method returns the offset of the local area
   /// from the stack pointer on entrance to a function.
   ///
   int getOffsetOfLocalArea() const { return LocalAreaOffset; }
 
-  //===--------------------------------------------------------------------===//
-  // These methods provide details of the stack frame used by Sparc, thus they
-  // are Sparc specific.
-  //===--------------------------------------------------------------------===//
-
-  virtual int  getStackFrameSizeAlignment       () const { abort(); }
-  virtual int  getMinStackFrameSize             () const { abort(); }
-  virtual int  getNumFixedOutgoingArgs          () const { abort(); }
-  virtual int  getSizeOfEachArgOnStack          () const { abort(); }
-  virtual bool argsOnStackHaveFixedSize         () const { abort(); }
-
-  // This method adjusts a stack offset to meet alignment rules of target.
-  virtual int adjustAlignment(int unalignedOffset, bool growUp,
-                             unsigned align) const { abort(); }
-
-  // These methods compute offsets using the frame contents for a particular
-  // function.  The frame contents are obtained from the MachineFunction object
-  // for the given function.  The rest must be implemented by the
-  // machine-specific subclass.
-  // 
-  virtual int getIncomingArgOffset              (MachineFunction& mcInfo,
-                                                unsigned argNum)const{abort();}
-  virtual int getOutgoingArgOffset              (MachineFunction& mcInfo,
-                                                unsigned argNum)const{abort();}
-  
-  virtual int getFirstIncomingArgOffset         (MachineFunction& mcInfo,
-                                                bool& growUp) const { abort();}
-  virtual int getFirstOutgoingArgOffset         (MachineFunction& mcInfo,
-                                                bool& growUp) const {abort();}
-  virtual int getFirstOptionalOutgoingArgOffset (MachineFunction&,
-                                                 bool& growUp) const {abort();}
-  virtual int getFirstAutomaticVarOffset        (MachineFunction& mcInfo,
-                                                 bool& growUp) const {abort();}
-  virtual int getRegSpillAreaOffset             (MachineFunction& mcInfo,
-                                                 bool& growUp) const {abort();}
-  virtual int getTmpAreaOffset                  (MachineFunction& mcInfo,
-                                                 bool& growUp) const {abort();}
-  virtual int getDynamicAreaOffset              (MachineFunction& mcInfo,
-                                                 bool& growUp) const {abort();}
-
-  //
-  // These methods specify the base register used for each stack area
-  // (generally FP or SP)
-  // 
-  virtual int getIncomingArgBaseRegNum()               const { abort(); }
-  virtual int getOutgoingArgBaseRegNum()               const { abort(); }
-  virtual int getOptionalOutgoingArgBaseRegNum()       const { abort(); }
-  virtual int getAutomaticVarBaseRegNum()              const { abort(); }
-  virtual int getRegSpillAreaBaseRegNum()              const { abort(); }
-  virtual int getDynamicAreaBaseRegNum()               const { abort(); }
+  /// getCalleeSavedSpillSlots - This method returns a pointer to an array of
+  /// pairs, that contains an entry for each callee saved register that must be
+  /// spilled to a particular stack location if it is spilled.
+  ///
+  /// Each entry in this array contains a <register,offset> pair, indicating the
+  /// fixed offset from the incoming stack pointer that each register should be
+  /// spilled at. If a register is not listed here, the code generator is
+  /// allowed to spill it anywhere it chooses.
+  ///
+  virtual const SpillSlot *
+  getCalleeSavedSpillSlots(unsigned &NumEntries) const {
+    NumEntries = 0;
+    return 0;
+  }
 };
 
+} // End llvm namespace
+
 #endif