Eliminate the distinction between "real" and "unreal" instructions
[oota-llvm.git] / include / llvm / Target / TargetRegInfo.h
index 29e10d395e59dbdb1c20c863262463e900e4135c..3b268ced41855441cf0fa6b71cff1053946e24e7 100644 (file)
@@ -1,4 +1,11 @@
-//===-- llvm/Target/TargetRegInfo.h - Target Register Info -------*- C++ -*-==//
+//===-- llvm/Target/TargetRegInfo.h - Target Register Info ------*- 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 used to describe the register system of a target to the
 // register allocator.
@@ -8,9 +15,11 @@
 #ifndef LLVM_TARGET_TARGETREGINFO_H
 #define LLVM_TARGET_TARGETREGINFO_H
 
-#include "Support/NonCopyable.h"
 #include "Support/hash_map"
 #include <string>
+#include <cassert>
+
+namespace llvm {
 
 class TargetMachine;
 class IGNode;
@@ -21,7 +30,6 @@ class Function;
 class LiveRange;
 class AddedInstrns;
 class MachineInstr;
-class PhyRegAlloc;
 class BasicBlock;
 
 ///----------------------------------------------------------------------------
@@ -39,12 +47,50 @@ public:
   inline unsigned getNumOfAvailRegs() const { return NumOfAvailRegs; }
   inline unsigned getNumOfAllRegs()   const { return NumOfAllRegs; }
 
+  // This method marks the registers used for a given register number.
+  // This defaults to marking a single register but may mark multiple
+  // registers when a single number denotes paired registers.
+  // 
+  virtual void markColorsUsed(unsigned RegInClass,
+                              int UserRegType,
+                              int RegTypeWanted,
+                              std::vector<bool> &IsColorUsedArr) const {
+    assert(RegInClass < NumOfAllRegs && RegInClass < IsColorUsedArr.size());
+    assert(UserRegType == RegTypeWanted &&
+       "Default method is probably incorrect for class with multiple types.");
+    IsColorUsedArr[RegInClass] = true;
+  }
+
+  // This method finds unused registers of the specified register type,
+  // using the given "used" flag array IsColorUsedArr.  It defaults to
+  // checking a single entry in the array directly, but that can be overridden
+  // for paired registers and other such silliness.
+  // It returns -1 if no unused color is found.
+  // 
+  virtual int findUnusedColor(int RegTypeWanted,
+                          const std::vector<bool> &IsColorUsedArr) const {
+    // find first unused color in the IsColorUsedArr directly
+    unsigned NC = this->getNumOfAvailRegs();
+    assert(IsColorUsedArr.size() >= NC && "Invalid colors-used array");
+    for (unsigned c = 0; c < NC; c++)
+      if (!IsColorUsedArr[c])
+        return c;
+    return -1;
+  }
+
   // 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,
-                           std::vector<bool> &IsColorUsedArr) const = 0;
+                           const std::vector<bool> &IsColorUsedArr) const = 0;
+
+  // Check whether a specific register is volatile, i.e., whether it is not
+  // preserved across calls
   virtual bool isRegVolatile(int Reg) const = 0;
 
+  // Check whether a specific register is modified as a side-effect of the
+  // call instruction itself,
+  virtual bool modifiedByCall(int Reg) const {return false; }
+
   virtual const char* const getRegName(unsigned reg) const = 0;
 
   TargetRegClassInfo(unsigned ID, unsigned NVR, unsigned NAR)
@@ -56,7 +102,9 @@ public:
 //---------------------------------------------------------------------------
 /// TargetRegInfo - Interface to register info of target machine
 ///
-class TargetRegInfo : public NonCopyableV {
+class TargetRegInfo {
+  TargetRegInfo(const TargetRegInfo &);  // DO NOT IMPLEMENT
+  void operator=(const TargetRegInfo &); // DO NOT IMPLEMENT
 protected:
   // A vector of all machine register classes
   //
@@ -71,7 +119,7 @@ public:
   static int getInvalidRegNum() { return -1; }
 
   TargetRegInfo(const TargetMachine& tgt) : target(tgt) { }
-  ~TargetRegInfo() {
+  virtual ~TargetRegInfo() {
     for (unsigned i = 0, e = MachineRegClassArr.size(); i != e; ++i)
       delete MachineRegClassArr[i];
   }
@@ -101,7 +149,7 @@ public:
 
   // returns the register that is hardwired to zero if any (-1 if none)
   //
-  virtual int getZeroRegNum() const = 0;
+  virtual unsigned getZeroRegNum() const = 0;
 
   // Number of registers used for passing int args (usually 6: %o0 - %o5)
   // and float args (usually 32: %f0 - %f31)
@@ -114,25 +162,18 @@ public:
   // as required. See SparcRegInfo.cpp for the implementation for Sparc.
   //
   virtual void suggestRegs4MethodArgs(const Function *Func, 
-                        LiveRangeInfo &LRI) const = 0;
+                                      LiveRangeInfo& LRI) const = 0;
 
   virtual void suggestRegs4CallArgs(MachineInstr *CallI, 
-                                    LiveRangeInfo &LRI) const = 0;
+                                    LiveRangeInfoLRI) const = 0;
 
   virtual void suggestReg4RetValue(MachineInstr *RetI, 
-                                  LiveRangeInfo &LRI) const = 0;
-
-  virtual void colorMethodArgs(const Function *Func,  LiveRangeInfo &LRI,
-                               AddedInstrns *FirstAI) const = 0;
-
-  virtual void colorCallArgs(MachineInstr *CalI, 
-                            LiveRangeInfo& LRI, AddedInstrns *CallAI, 
-                            PhyRegAlloc &PRA, const BasicBlock *BB) const = 0;
-
-  virtual void colorRetValue(MachineInstr *RetI, LiveRangeInfo &LRI,
-                            AddedInstrns *RetAI) const = 0;
-
+                                  LiveRangeInfo& LRI) const = 0;
 
+  virtual void colorMethodArgs(const Function *Func,
+                           LiveRangeInfo &LRI,
+                           std::vector<MachineInstr*>& InstrnsBefore,
+                           std::vector<MachineInstr*>& InstrnsAfter) const = 0;
 
   // The following methods are used to generate "copy" machine instructions
   // for an architecture. Currently they are used in TargetRegClass 
@@ -165,7 +206,17 @@ public:
   virtual void cpValue2Value(Value *Src, Value *Dest,
                              std::vector<MachineInstr*>& mvec) const = 0;
 
-  virtual bool isRegVolatile(int RegClassID, int Reg) const = 0;
+  // Check whether a specific register is volatile, i.e., whether it is not
+  // preserved across calls
+  inline virtual bool isRegVolatile(int RegClassID, int Reg) const {
+    return MachineRegClassArr[RegClassID]->isRegVolatile(Reg);
+  }
+
+  // Check whether a specific register is modified as a side-effect of the
+  // call instruction itself,
+  inline virtual bool modifiedByCall(int RegClassID, int Reg) const {
+    return MachineRegClassArr[RegClassID]->modifiedByCall(Reg);
+  }
   
   // Returns the reg used for pushing the address when a method is called.
   // This can be used for other purposes between calls
@@ -179,7 +230,7 @@ public:
   virtual unsigned getReturnAddressReg() const = 0; 
   
 
-  // Each register class has a seperate space for register IDs. To convert
+  // Each register class has a separate space for register IDs. To convert
   // a regId in a register class to a common Id, or vice versa,
   // we use the folloing two methods.
   //
@@ -222,9 +273,11 @@ public:
   }
 
   // Get the register type for a register identified different ways.
-  // 
-  virtual int getRegType(const Type* type) const = 0;
-  virtual int getRegType(const LiveRange *LR) const = 0;
+  // Note that getRegTypeForLR(LR) != getRegTypeForDataType(LR->getType())!
+  // The reg class of a LR depends both on the Value types in it and whether
+  // they are CC registers or not (for example).
+  virtual int getRegTypeForDataType(const Type* type) const = 0;
+  virtual int getRegTypeForLR(const LiveRange *LR) const = 0;
   virtual int getRegType(int unifiedRegNum) const = 0;
   
   // The following methods are used to get the frame/stack pointers
@@ -232,21 +285,12 @@ public:
   virtual unsigned getFramePointer() const = 0;
   virtual unsigned getStackPointer() 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(std::vector<MachineInstr*>& instrnsBefore,
-                                      std::vector<MachineInstr*>& instrnsAfter,
-                                      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 int getSpilledRegSize(int RegType) const = 0;
 };
 
+} // End llvm namespace
+
 #endif