//===-- llvm/Target/RegInfo.h - Target Register Information ------*- C++ -*-==//
//
// This file is used to describe the register system of a target to the
// register allocator.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_TARGET_MACHINEREGINFO_H
#define LLVM_TARGET_MACHINEREGINFO_H

#include "Support/NonCopyable.h"
#include <hash_map>
#include <string>

class TargetMachine;
class IGNode;
class Value;
class LiveRangeInfo;
class Method;
class Instruction;
class LiveRange;
class AddedInstrns;
class MachineInstr;
class RegClass;
class CallInst;
class ReturnInst;
class PhyRegAlloc;
class BasicBlock;

//-----------------------------------------------------------------------------
// class MachineRegClassInfo
// 
// Purpose:
//   Interface to description of machine register class (e.g., int reg class
//   float reg class etc)
// 
//--------------------------------------------------------------------------


class MachineRegClassInfo {
protected:
  
  const unsigned RegClassID;        // integer ID of a reg class
  const unsigned NumOfAvailRegs;    // # of avail for coloring -without SP etc.
  const unsigned NumOfAllRegs;      // # of all registers -including SP,g0 etc.
  
public:
  
  inline unsigned getRegClassID()     const { return RegClassID; }
  inline unsigned getNumOfAvailRegs() const { return NumOfAvailRegs; }
  inline unsigned getNumOfAllRegs()   const { return NumOfAllRegs; }



  // This method should find a color which is not used by neighbors
  // (i.e., a false position in IsColorUsedArr) and 
  virtual void colorIGNode(IGNode * Node, bool IsColorUsedArr[] ) const = 0;
  virtual bool isRegVolatile(const int Reg) const = 0;

  MachineRegClassInfo(const unsigned ID, const unsigned NVR, 
		      const unsigned NAR): RegClassID(ID), NumOfAvailRegs(NVR),
                                             NumOfAllRegs(NAR)
  { }                         // empty constructor

};



//---------------------------------------------------------------------------
// class MachineRegInfo
// 
// Purpose:
//   Interface to register info of target machine
// 
//--------------------------------------------------------------------------



typedef hash_map<const MachineInstr *, AddedInstrns *> AddedInstrMapType;

// A vector of all machine register classes
//
typedef vector<const MachineRegClassInfo *> MachineRegClassArrayType;


class MachineRegInfo : public NonCopyableV {
public:
  const TargetMachine& target;

protected:

  MachineRegClassArrayType MachineRegClassArr;    
  
public:

  // empty constructor
  //
  MachineRegInfo(const TargetMachine& tgt) : target(tgt) { }


  // According the definition of a MachineOperand class, a Value in a
  // machine instruction can go into either a normal register or a 
  // condition code register. If isCCReg is true below, the ID of the condition
  // code regiter class will be returned. Otherwise, the normal register
  // class (eg. int, float) must be returned.
  virtual unsigned getRegClassIDOfValue (const Value *const Val,
					 bool isCCReg = false) const =0;


  inline unsigned int getNumOfRegClasses() const { 
    return MachineRegClassArr.size(); 
  }  

  const MachineRegClassInfo *const getMachineRegClass(unsigned i) const { 
    return MachineRegClassArr[i]; 
  }

  // returns the register that is hardwired to zero if any (-1 if none)
  //
  virtual inline int  getZeroRegNum()  const = 0;


  // The following methods are used to color special live ranges (e.g.
  // method args and return values etc.) with specific hardware registers
  // as required. See SparcRegInfo.cpp for the implementation for Sparc.
  //
  virtual void suggestRegs4MethodArgs(const Method *const Meth, 
			 LiveRangeInfo & LRI) const = 0;

  virtual void suggestRegs4CallArgs(const MachineInstr *const CallI, 
			LiveRangeInfo& LRI, vector<RegClass *> RCL) const = 0;

  virtual void suggestReg4RetValue(const MachineInstr *const RetI, 
				   LiveRangeInfo& LRI) const = 0;

  virtual void colorMethodArgs(const Method *const Meth,  LiveRangeInfo& LRI,
		       AddedInstrns *const FirstAI) const = 0;

  virtual void colorCallArgs(const MachineInstr *const CalI, 
			     LiveRangeInfo& LRI, AddedInstrns *const CallAI, 
			     PhyRegAlloc &PRA, const BasicBlock *BB) const = 0;

  virtual void colorRetValue(const MachineInstr *const RetI,LiveRangeInfo& LRI,
			     AddedInstrns *const RetAI) const = 0;



  // The following methods are used to generate "copy" machine instructions
  // for an architecture. Currently they are used in MachineRegClass 
  // interface. However, they can be moved to MachineInstrInfo interface if
  // necessary.
  //
  virtual MachineInstr * 
  cpReg2RegMI(const unsigned SrcReg, const unsigned DestReg,
	      const int RegType) const=0;

  virtual MachineInstr * 
  cpReg2MemMI(const unsigned SrcReg, const unsigned DestPtrReg,
	       const int Offset, const int RegType) const=0;

  virtual MachineInstr *
   cpMem2RegMI(const unsigned SrcPtrReg, const int Offset,
	       const unsigned DestReg, const int RegType) const=0;

  virtual MachineInstr *cpValue2Value( Value *Src, Value *Dest) const=0;

  virtual bool isRegVolatile(const int RegClassID, const int Reg) const=0;



 
  // Returns the reg used for pushing the address when a method is called.
  // This can be used for other purposes between calls
  //
  virtual unsigned getCallAddressReg() const = 0;

  // Returns the register containing the return address.
  //It should be made sure that this 
  // register contains the return value when a return instruction is reached.
  //
  virtual unsigned getReturnAddressReg() const = 0; 
  

  // Each register class has a seperate space for register IDs. To convert
  // a regId in a register class to a common Id, we use the folloing method(s)
  //
  virtual int getUnifiedRegNum(int RegClassID, int reg) const = 0;

  virtual const string getUnifiedRegName(int UnifiedRegNum) const = 0;


  // Gives the type of a register based on the type of the LR
  //
  virtual int getRegType(const LiveRange *const LR) const=0;

  // Gives the return value contained in a CALL machine instruction
  //
  virtual const Value * getCallInstRetVal(const MachineInstr *CallMI) const=0;

  // The following methods are used to get the frame/stack pointers
  // 
  inline virtual unsigned getFramePointer() const=0;
  inline virtual unsigned getStackPointer() const=0;

  // A register can be initialized to an invalid number. That number can
  // be obtained using this method.
  //
  inline virtual int getInvalidRegNum() const=0;


  // Method for inserting caller saving code. The caller must save all the
  // volatile registers across a call based on the calling conventions of
  // an architecture. This must insert code for saving and restoring 
  // such registers on
  //
  virtual void insertCallerSavingCode(const MachineInstr *MInst, 
				      const BasicBlock *BB, 
				      PhyRegAlloc &PRA ) const = 0;

  // This method gives the the number of bytes of stack spaceallocated 
  // to a register when it is spilled to the stack.
  //
  virtual inline int getSpilledRegSize(const int RegType) const = 0;



};




#endif