Changed CPUResource to allow access to max num users for a resource.
[oota-llvm.git] / include / llvm / Target / TargetFrameInfo.h
index df16c730b2232abed957eedc591962a3ecdfeaa9..bdcf7930a0fc63d5826520d4410d0170aa9784ef 100644 (file)
-// $Id$ -*-c++-*-
-//***************************************************************************
-// File:
-//     MachineFrameInfo.h
+//===-- llvm/Target/TargetFrameInfo.h ---------------------------*- C++ -*-===//
 // 
-// Purpose:
-//     Interface to layout of stack frame on target machine.
+//                     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.
 // 
-// History:
-//     11/6/01  -  Vikram Adve  -  Created
-//**************************************************************************/
+//===----------------------------------------------------------------------===//
+//
+// Interface to describe the layout of a stack frame on the target machine.
+//
+//===----------------------------------------------------------------------===//
 
-#ifndef LLVM_CODEGEN_FRAMEINFO_H
-#define LLVM_CODEGEN_FRAMEINFO_H
+#ifndef LLVM_TARGET_TARGETFRAMEINFO_H
+#define LLVM_TARGET_TARGETFRAMEINFO_H
 
-#include "Support/NonCopyable.h"
-#include <vector>
+namespace llvm {
 
+class MachineFunction;
 
-//************************* Forward Declarations **************************/
+struct TargetFrameInfo {
+  enum StackDirection {
+    StackGrowsUp,        // Adding to the stack increases the stack address
+    StackGrowsDown       // Adding to the stack decreases the stack address
+  };
+private:
+  StackDirection StackDir;
+  unsigned StackAlignment;
+  int LocalAreaOffset;
+public:
+  TargetFrameInfo(StackDirection D, unsigned StackAl, int LAO)
+    : StackDir(D), StackAlignment(StackAl), LocalAreaOffset(LAO) {}
 
-class MachineCodeForMethod;
+  // These methods return information that describes the abstract stack layout
+  // of the target machine.
 
+  /// getStackGrowthDirection - Return the direction the stack grows
+  ///
+  StackDirection getStackGrowthDirection() const { return StackDir; }
 
-//*************************** External Classes ****************************/
+  /// 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.
+  ///
+  unsigned getStackAlignment() const { return StackAlignment; }
 
+  /// getOffsetOfLocalArea - This method returns the offset of the local area
+  /// from the stack pointer on entrance to a function.
+  ///
+  int getOffsetOfLocalArea() const { return LocalAreaOffset; }
 
-class MachineFrameInfo : public NonCopyableV {
-public:
-  const TargetMachine& target;
-  
-public:
-  /*ctor*/ MachineFrameInfo(const TargetMachine& tgt) : target(tgt) {}
-  
-  //
-  // These methods provide constant parameters of the frame layout.
+  //===--------------------------------------------------------------------===//
+  // These methods provide details of the stack frame used by Sparc, thus they
+  // are Sparc specific.
+  //===--------------------------------------------------------------------===//
+
+  virtual int  getStackFrameSizeAlignment       () const;
+  virtual int  getMinStackFrameSize             () const;
+  virtual int  getNumFixedOutgoingArgs          () const;
+  virtual int  getSizeOfEachArgOnStack          () const;
+  virtual bool argsOnStackHaveFixedSize         () const;
+
+  // This method adjusts a stack offset to meet alignment rules of target.
+  virtual int adjustAlignment(int unalignedOffset, bool growUp,
+                             unsigned align) const;
+
+  // 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  getStackFrameSizeAlignment       () const = 0;
-  virtual int  getMinStackFrameSize             () const = 0;
-  virtual int  getNumFixedOutgoingArgs          () const = 0;
-  virtual int  getSizeOfEachArgOnStack          () const = 0;
-  virtual bool argsOnStackHaveFixedSize         () const = 0;
+  virtual int getIncomingArgOffset              (MachineFunction& mcInfo,
+                                                unsigned argNum) const;
+  virtual int getOutgoingArgOffset              (MachineFunction& mcInfo,
+                                                unsigned argNum) const;
   
-  //
-  // These methods compute offsets using the frame contents for a
-  // particular method.  The frame contents are obtained from the
-  // MachineCodeInfoForMethod object for the given method.
-  // 
-  virtual int getFirstIncomingArgOffset         (MachineCodeForMethod& mcInfo,
-                                                 bool& pos) const=0;
-  virtual int getFirstOutgoingArgOffset         (MachineCodeForMethod& mcInfo,
-                                                 bool& pos) const=0;
-  virtual int getFirstOptionalOutgoingArgOffset (MachineCodeForMethod&,
-                                                 bool& pos) const=0;
-  virtual int getFirstAutomaticVarOffset        (MachineCodeForMethod& mcInfo,
-                                                 bool& pos) const=0;
-  virtual int getRegSpillAreaOffset             (MachineCodeForMethod& mcInfo,
-                                                 bool& pos) const=0;
-  virtual int getTmpAreaOffset                  (MachineCodeForMethod& mcInfo,
-                                                 bool& pos) const=0;
-  virtual int getDynamicAreaOffset              (MachineCodeForMethod& mcInfo,
-                                                 bool& pos) const=0;
+  virtual int getFirstIncomingArgOffset         (MachineFunction& mcInfo,
+                                                bool& growUp) const;
+  virtual int getFirstOutgoingArgOffset         (MachineFunction& mcInfo,
+                                                bool& growUp) const;
+  virtual int getFirstOptionalOutgoingArgOffset (MachineFunction&,
+                                                 bool& growUp) const;
+  virtual int getFirstAutomaticVarOffset        (MachineFunction& mcInfo,
+                                                 bool& growUp) const;
+  virtual int getRegSpillAreaOffset             (MachineFunction& mcInfo,
+                                                 bool& growUp) const;
+  virtual int getTmpAreaOffset                  (MachineFunction& mcInfo,
+                                                 bool& growUp) const;
+  virtual int getDynamicAreaOffset              (MachineFunction& mcInfo,
+                                                 bool& growUp) const;
 
   //
   // These methods specify the base register used for each stack area
   // (generally FP or SP)
   // 
-  virtual int getIncomingArgBaseRegNum()               const=0;
-  virtual int getOutgoingArgBaseRegNum()               const=0;
-  virtual int getOptionalOutgoingArgBaseRegNum()       const=0;
-  virtual int getAutomaticVarBaseRegNum()              const=0;
-  virtual int getRegSpillAreaBaseRegNum()              const=0;
-  virtual int getDynamicAreaBaseRegNum()               const=0;
+  virtual int getIncomingArgBaseRegNum()               const;
+  virtual int getOutgoingArgBaseRegNum()               const;
+  virtual int getOptionalOutgoingArgBaseRegNum()       const;
+  virtual int getAutomaticVarBaseRegNum()              const;
+  virtual int getRegSpillAreaBaseRegNum()              const;
+  virtual int getDynamicAreaBaseRegNum()               const;
 };
 
+} // End llvm namespace
+
 #endif