Remove isImm(), isReg(), and friends, in favor of
[oota-llvm.git] / include / llvm / CodeGen / MachineOperand.h
index a092fb45d8992a99c36d122dbfdfe8db0e3b5841..6d4c98919ac0e0f2571603127d80b4baff3b1167 100644 (file)
 #define LLVM_CODEGEN_MACHINEOPERAND_H
 
 #include "llvm/Support/DataTypes.h"
-#include <vector>
 #include <cassert>
 #include <iosfwd>
 
 namespace llvm {
   
+class ConstantFP;
 class MachineBasicBlock;
 class GlobalValue;
-  class MachineInstr;
+class MachineInstr;
+class TargetMachine;
+class MachineRegisterInfo;
+class raw_ostream;
   
 /// MachineOperand class - Representation of each machine instruction operand.
 ///
@@ -32,6 +35,7 @@ public:
   enum MachineOperandType {
     MO_Register,                // Register operand.
     MO_Immediate,               // Immediate Operand
+    MO_FPImmediate,
     MO_MachineBasicBlock,       // MachineBasicBlock reference
     MO_FrameIndex,              // Abstract Stack Frame Index
     MO_ConstantPoolIndex,       // Address of indexed Constant in Constant Pool
@@ -41,43 +45,69 @@ public:
   };
 
 private:
-  union {
-    GlobalValue *GV;          // For MO_GlobalAddress.
-    MachineBasicBlock *MBB;   // For MO_MachineBasicBlock.
-    const char *SymbolName;   // For MO_ExternalSymbol.
-    unsigned RegNo;           // For MO_Register.
-    int64_t immedVal;         // For MO_Immediate and MO_*Index.
-  } contents;
-
-  /// ParentMI - This is the instruction that this operand is embedded into.
-  MachineInstr *ParentMI;
+  /// OpKind - Specify what kind of operand this is.  This discriminates the
+  /// union.
+  MachineOperandType OpKind : 8;
   
-  MachineOperandType opType:8; // Discriminate the union.
-  bool IsDef : 1;              // True if this is a def, false if this is a use.
-  bool IsImp : 1;              // True if this is an implicit def or use.
-
-  bool IsKill : 1;             // True if this is a reg use and the reg is dead
-                               // immediately after the read.
-  bool IsDead : 1;             // True if this is a reg def and the reg is dead
-                               // immediately after the write. i.e. A register
-                               // that is defined but never used.
+  /// IsDef/IsImp/IsKill/IsDead flags - These are only valid for MO_Register
+  /// operands.
   
-  /// auxInfo - auxiliary information used by the MachineOperand
-  union {
-    /// offset - Offset to address of global or external, only valid for
-    /// MO_GlobalAddress, MO_ExternalSym and MO_ConstantPoolIndex
-    int offset;
+  /// IsDef - True if this is a def, false if this is a use of the register.
+  ///
+  bool IsDef : 1;
+  
+  /// IsImp - True if this is an implicit def or use, false if it is explicit.
+  ///
+  bool IsImp : 1;
 
-    /// subReg - SubRegister number, only valid for MO_Register.  A value of 0
-    /// indicates the MO_Register has no subReg.
-    unsigned char subReg;
-  } auxInfo;
+  /// IsKill - True if this instruction is the last use of the register on this
+  /// path through the function.  This is only valid on uses of registers.
+  bool IsKill : 1;
+
+  /// IsDead - True if this register is never used by a subsequent instruction.
+  /// This is only valid on definitions of registers.
+  bool IsDead : 1;
+
+  /// IsEarlyClobber flag - this is only valid for MO_Register operands in
+  /// an inline asm.
+
+  /// IsEarlyClobber - True if this operand is marked earlyclobber in an
+  /// inline asm.  See gcc doc for description of earlyclobber.
+  bool IsEarlyClobber : 1;
+
+  /// SubReg - Subregister number, only valid for MO_Register.  A value of 0
+  /// indicates the MO_Register has no subReg.
+  unsigned char SubReg;
   
-  MachineOperand() : ParentMI(0) {}
+  /// ParentMI - This is the instruction that this operand is embedded into. 
+  /// This is valid for all operand types, when the operand is in an instr.
+  MachineInstr *ParentMI;
 
-  void print(std::ostream &os) const;
-  void print(std::ostream *os) const { if (os) print(*os); }
+  /// Contents union - This contains the payload for the various operand types.
+  union {
+    MachineBasicBlock *MBB;   // For MO_MachineBasicBlock.
+    const ConstantFP *CFP;    // For MO_FPImmediate.
+    int64_t ImmVal;           // For MO_Immediate.
 
+    struct {                  // For MO_Register.
+      unsigned RegNo;
+      MachineOperand **Prev;  // Access list for register.
+      MachineOperand *Next;
+    } Reg;
+    
+    /// OffsetedInfo - This struct contains the offset and an object identifier.
+    /// this represent the object as with an optional offset from it.
+    struct {
+      union {
+        int Index;                // For MO_*Index - The index itself.
+        const char *SymbolName;   // For MO_ExternalSymbol.
+        GlobalValue *GV;          // For MO_GlobalAddress.
+      } Val;
+      int Offset;   // An offset from the object.
+    } OffsetedInfo;
+  } Contents;
+  
+  explicit MachineOperand(MachineOperandType K) : OpKind(K), ParentMI(0) {}
 public:
   MachineOperand(const MachineOperand &M) {
     *this = M;
@@ -87,271 +117,331 @@ public:
   
   /// getType - Returns the MachineOperandType for this operand.
   ///
-  MachineOperandType getType() const { return opType; }
+  MachineOperandType getType() const { return OpKind; }
+
+  /// getParent - Return the instruction that this operand belongs to.
+  ///
+  MachineInstr *getParent() { return ParentMI; }
+  const MachineInstr *getParent() const { return ParentMI; }
+  
+  void print(std::ostream &os, const TargetMachine *TM = 0) const;
+  void print(raw_ostream &os, const TargetMachine *TM = 0) const;
 
   /// Accessors that tell you what kind of MachineOperand you're looking at.
   ///
-  bool isRegister() const { return opType == MO_Register; }
-  bool isImmediate() const { return opType == MO_Immediate; }
-  bool isMachineBasicBlock() const { return opType == MO_MachineBasicBlock; }
-  bool isFrameIndex() const { return opType == MO_FrameIndex; }
-  bool isConstantPoolIndex() const { return opType == MO_ConstantPoolIndex; }
-  bool isJumpTableIndex() const { return opType == MO_JumpTableIndex; }
-  bool isGlobalAddress() const { return opType == MO_GlobalAddress; }
-  bool isExternalSymbol() const { return opType == MO_ExternalSymbol; }
+  bool isRegister() const { return OpKind == MO_Register; }
+  bool isImmediate() const { return OpKind == MO_Immediate; }
+  bool isFPImmediate() const { return OpKind == MO_FPImmediate; }
+  bool isMachineBasicBlock() const { return OpKind == MO_MachineBasicBlock; }
+  bool isFrameIndex() const { return OpKind == MO_FrameIndex; }
+  bool isConstantPoolIndex() const { return OpKind == MO_ConstantPoolIndex; }
+  bool isJumpTableIndex() const { return OpKind == MO_JumpTableIndex; }
+  bool isGlobalAddress() const { return OpKind == MO_GlobalAddress; }
+  bool isExternalSymbol() const { return OpKind == MO_ExternalSymbol; }
 
-  int64_t getImm() const {
-    assert(isImmediate() && "Wrong MachineOperand accessor");
-    return contents.immedVal;
+  //===--------------------------------------------------------------------===//
+  // Accessors for Register Operands
+  //===--------------------------------------------------------------------===//
+
+  /// getReg - Returns the register number.
+  unsigned getReg() const {
+    assert(isRegister() && "This is not a register operand!");
+    return Contents.Reg.RegNo;
   }
   
-  int64_t getImmedValue() const {
-    assert(isImmediate() && "Wrong MachineOperand accessor");
-    return contents.immedVal;
-  }
-  MachineBasicBlock *getMBB() const {
-    assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
-    return contents.MBB;
-  }
-  MachineBasicBlock *getMachineBasicBlock() const {
-    assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
-    return contents.MBB;
-  }
-  void setMachineBasicBlock(MachineBasicBlock *MBB) {
-    assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
-    contents.MBB = MBB;
-  }
-  int getFrameIndex() const {
-    assert(isFrameIndex() && "Wrong MachineOperand accessor");
-    return (int)contents.immedVal;
-  }
-  unsigned getConstantPoolIndex() const {
-    assert(isConstantPoolIndex() && "Wrong MachineOperand accessor");
-    return (unsigned)contents.immedVal;
-  }
-  unsigned getJumpTableIndex() const {
-    assert(isJumpTableIndex() && "Wrong MachineOperand accessor");
-    return (unsigned)contents.immedVal;
-  }
-  GlobalValue *getGlobal() const {
-    assert(isGlobalAddress() && "Wrong MachineOperand accessor");
-    return contents.GV;
-  }
-  int getOffset() const {
-    assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
-        "Wrong MachineOperand accessor");
-    return auxInfo.offset;
-  }
   unsigned getSubReg() const {
     assert(isRegister() && "Wrong MachineOperand accessor");
-    return (unsigned)auxInfo.subReg;
+    return (unsigned)SubReg;
   }
-  const char *getSymbolName() const {
-    assert(isExternalSymbol() && "Wrong MachineOperand accessor");
-    return contents.SymbolName;
-  }
-
+  
   bool isUse() const { 
     assert(isRegister() && "Wrong MachineOperand accessor");
     return !IsDef;
   }
+  
   bool isDef() const {
     assert(isRegister() && "Wrong MachineOperand accessor");
     return IsDef;
   }
-  void setIsUse() {
+  
+  bool isImplicit() const { 
     assert(isRegister() && "Wrong MachineOperand accessor");
-    IsDef = false;
+    return IsImp;
   }
-  void setIsDef() {
+  
+  bool isDead() const {
     assert(isRegister() && "Wrong MachineOperand accessor");
-    IsDef = true;
+    return IsDead;
   }
-
-  bool isImplicit() const { 
+  
+  bool isKill() const {
     assert(isRegister() && "Wrong MachineOperand accessor");
-    return IsImp;
+    return IsKill;
   }
-  void setImplicit() { 
+  
+  bool isEarlyClobber() const {
     assert(isRegister() && "Wrong MachineOperand accessor");
-    IsImp = true;
+    return IsEarlyClobber;
   }
 
-  bool isKill() const {
+  /// getNextOperandForReg - Return the next MachineOperand in the function that
+  /// uses or defines this register.
+  MachineOperand *getNextOperandForReg() const {
+    assert(isRegister() && "This is not a register operand!");
+    return Contents.Reg.Next;
+  }
+
+  //===--------------------------------------------------------------------===//
+  // Mutators for Register Operands
+  //===--------------------------------------------------------------------===//
+  
+  /// Change the register this operand corresponds to.
+  ///
+  void setReg(unsigned Reg);
+  
+  void setSubReg(unsigned subReg) {
     assert(isRegister() && "Wrong MachineOperand accessor");
-    return IsKill;
+    SubReg = (unsigned char)subReg;
   }
-  bool isDead() const {
+  
+  void setIsUse(bool Val = true) {
     assert(isRegister() && "Wrong MachineOperand accessor");
-    return IsDead;
+    IsDef = !Val;
   }
-  void setIsKill() {
-    assert(isRegister() && !IsDef && "Wrong MachineOperand accessor");
-    IsKill = true;
+  
+  void setIsDef(bool Val = true) {
+    assert(isRegister() && "Wrong MachineOperand accessor");
+    IsDef = Val;
   }
-  void setIsDead() {
-    assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
-    IsDead = true;
+
+  void setImplicit(bool Val = true) { 
+    assert(isRegister() && "Wrong MachineOperand accessor");
+    IsImp = Val;
   }
-  void unsetIsKill() {
+
+  void setIsKill(bool Val = true) {
     assert(isRegister() && !IsDef && "Wrong MachineOperand accessor");
-    IsKill = false;
+    IsKill = Val;
   }
-  void unsetIsDead() {
+  
+  void setIsDead(bool Val = true) {
     assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
-    IsDead = false;
+    IsDead = Val;
   }
 
-  /// getReg - Returns the register number.
-  ///
-  unsigned getReg() const {
-    assert(isRegister() && "This is not a register operand!");
-    return contents.RegNo;
+  void setIsEarlyClobber(bool Val = true) {
+    assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
+    IsEarlyClobber = Val;
   }
 
-  /// MachineOperand mutators.
-  ///
-  void setReg(unsigned Reg) {
-    assert(isRegister() && "This is not a register operand!");
-    contents.RegNo = Reg;
+  //===--------------------------------------------------------------------===//
+  // Accessors for various operand types.
+  //===--------------------------------------------------------------------===//
+  
+  int64_t getImm() const {
+    assert(isImmediate() && "Wrong MachineOperand accessor");
+    return Contents.ImmVal;
+  }
+  
+  const ConstantFP *getFPImm() const {
+    assert(isFPImmediate() && "Wrong MachineOperand accessor");
+    return Contents.CFP;
+  }
+  
+  MachineBasicBlock *getMBB() const {
+    assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
+    return Contents.MBB;
   }
 
-  void setImmedValue(int64_t immVal) {
-    assert(isImmediate() && "Wrong MachineOperand mutator");
-    contents.immedVal = immVal;
+  int getIndex() const {
+    assert((isFrameIndex() || isConstantPoolIndex() || isJumpTableIndex()) &&
+           "Wrong MachineOperand accessor");
+    return Contents.OffsetedInfo.Val.Index;
+  }
+  
+  GlobalValue *getGlobal() const {
+    assert(isGlobalAddress() && "Wrong MachineOperand accessor");
+    return Contents.OffsetedInfo.Val.GV;
   }
+  
+  int getOffset() const {
+    assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
+           "Wrong MachineOperand accessor");
+    return Contents.OffsetedInfo.Offset;
+  }
+  
+  const char *getSymbolName() const {
+    assert(isExternalSymbol() && "Wrong MachineOperand accessor");
+    return Contents.OffsetedInfo.Val.SymbolName;
+  }
+  
+  //===--------------------------------------------------------------------===//
+  // Mutators for various operand types.
+  //===--------------------------------------------------------------------===//
+  
   void setImm(int64_t immVal) {
     assert(isImmediate() && "Wrong MachineOperand mutator");
-    contents.immedVal = immVal;
+    Contents.ImmVal = immVal;
   }
 
   void setOffset(int Offset) {
-    assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex() ||
-            isJumpTableIndex()) &&
+    assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
         "Wrong MachineOperand accessor");
-    auxInfo.offset = Offset;
-  }
-  void setSubReg(unsigned subReg) {
-    assert(isRegister() && "Wrong MachineOperand accessor");
-    auxInfo.subReg = (unsigned char)subReg;
+    Contents.OffsetedInfo.Offset = Offset;
   }
-  void setConstantPoolIndex(unsigned Idx) {
-    assert(isConstantPoolIndex() && "Wrong MachineOperand accessor");
-    contents.immedVal = Idx;
+  
+  void setIndex(int Idx) {
+    assert((isFrameIndex() || isConstantPoolIndex() || isJumpTableIndex()) &&
+           "Wrong MachineOperand accessor");
+    Contents.OffsetedInfo.Val.Index = Idx;
   }
-  void setJumpTableIndex(unsigned Idx) {
-    assert(isJumpTableIndex() && "Wrong MachineOperand accessor");
-    contents.immedVal = Idx;
+  
+  void setMBB(MachineBasicBlock *MBB) {
+    assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
+    Contents.MBB = MBB;
   }
   
+  //===--------------------------------------------------------------------===//
+  // Other methods.
+  //===--------------------------------------------------------------------===//
+  
   /// isIdenticalTo - Return true if this operand is identical to the specified
   /// operand. Note: This method ignores isKill and isDead properties.
   bool isIdenticalTo(const MachineOperand &Other) const;
   
   /// ChangeToImmediate - Replace this operand with a new immediate operand of
   /// the specified value.  If an operand is known to be an immediate already,
-  /// the setImmedValue method should be used.
-  void ChangeToImmediate(int64_t ImmVal) {
-    opType = MO_Immediate;
-    contents.immedVal = ImmVal;
-  }
-
+  /// the setImm method should be used.
+  void ChangeToImmediate(int64_t ImmVal);
+  
   /// ChangeToRegister - Replace this operand with a new register operand of
   /// the specified value.  If an operand is known to be an register already,
   /// the setReg method should be used.
   void ChangeToRegister(unsigned Reg, bool isDef, bool isImp = false,
-                        bool isKill = false, bool isDead = false) {
-    opType = MO_Register;
-    contents.RegNo = Reg;
-    IsDef = isDef;
-    IsImp = isImp;
-    IsKill = isKill;
-    IsDead = isDead;
-  }
+                        bool isKill = false, bool isDead = false,
+                        bool isEarlyClobber = false);
+  
+  //===--------------------------------------------------------------------===//
+  // Construction methods.
+  //===--------------------------------------------------------------------===//
   
   static MachineOperand CreateImm(int64_t Val) {
-    MachineOperand Op;
-    Op.opType = MachineOperand::MO_Immediate;
-    Op.contents.immedVal = Val;
-    Op.auxInfo.offset = 0;
+    MachineOperand Op(MachineOperand::MO_Immediate);
+    Op.setImm(Val);
+    return Op;
+  }
+  
+  static MachineOperand CreateFPImm(const ConstantFP *CFP) {
+    MachineOperand Op(MachineOperand::MO_FPImmediate);
+    Op.Contents.CFP = CFP;
     return Op;
   }
+  
   static MachineOperand CreateReg(unsigned Reg, bool isDef, bool isImp = false,
                                   bool isKill = false, bool isDead = false,
-                                  unsigned SubReg = 0) {
-    MachineOperand Op;
-    Op.opType = MachineOperand::MO_Register;
+                                  unsigned SubReg = 0,
+                                  bool isEarlyClobber = false) {
+    MachineOperand Op(MachineOperand::MO_Register);
     Op.IsDef = isDef;
     Op.IsImp = isImp;
     Op.IsKill = isKill;
     Op.IsDead = isDead;
-    Op.contents.RegNo = Reg;
-    Op.auxInfo.subReg = SubReg;
+    Op.IsEarlyClobber = isEarlyClobber;
+    Op.Contents.Reg.RegNo = Reg;
+    Op.Contents.Reg.Prev = 0;
+    Op.Contents.Reg.Next = 0;
+    Op.SubReg = SubReg;
     return Op;
   }
   static MachineOperand CreateMBB(MachineBasicBlock *MBB) {
-    MachineOperand Op;
-    Op.opType = MachineOperand::MO_MachineBasicBlock;
-    Op.contents.MBB = MBB;
-    Op.auxInfo.offset = 0;
+    MachineOperand Op(MachineOperand::MO_MachineBasicBlock);
+    Op.setMBB(MBB);
     return Op;
   }
   static MachineOperand CreateFI(unsigned Idx) {
-    MachineOperand Op;
-    Op.opType = MachineOperand::MO_FrameIndex;
-    Op.contents.immedVal = Idx;
-    Op.auxInfo.offset = 0;
+    MachineOperand Op(MachineOperand::MO_FrameIndex);
+    Op.setIndex(Idx);
     return Op;
   }
   static MachineOperand CreateCPI(unsigned Idx, int Offset) {
-    MachineOperand Op;
-    Op.opType = MachineOperand::MO_ConstantPoolIndex;
-    Op.contents.immedVal = Idx;
-    Op.auxInfo.offset = Offset;
+    MachineOperand Op(MachineOperand::MO_ConstantPoolIndex);
+    Op.setIndex(Idx);
+    Op.setOffset(Offset);
     return Op;
   }
   static MachineOperand CreateJTI(unsigned Idx) {
-    MachineOperand Op;
-    Op.opType = MachineOperand::MO_JumpTableIndex;
-    Op.contents.immedVal = Idx;
-    Op.auxInfo.offset = 0;
+    MachineOperand Op(MachineOperand::MO_JumpTableIndex);
+    Op.setIndex(Idx);
     return Op;
   }
   static MachineOperand CreateGA(GlobalValue *GV, int Offset) {
-    MachineOperand Op;
-    Op.opType = MachineOperand::MO_GlobalAddress;
-    Op.contents.GV = GV;
-    Op.auxInfo.offset = Offset;
+    MachineOperand Op(MachineOperand::MO_GlobalAddress);
+    Op.Contents.OffsetedInfo.Val.GV = GV;
+    Op.setOffset(Offset);
     return Op;
   }
   static MachineOperand CreateES(const char *SymName, int Offset = 0) {
-    MachineOperand Op;
-    Op.opType = MachineOperand::MO_ExternalSymbol;
-    Op.contents.SymbolName = SymName;
-    Op.auxInfo.offset = Offset;
+    MachineOperand Op(MachineOperand::MO_ExternalSymbol);
+    Op.Contents.OffsetedInfo.Val.SymbolName = SymName;
+    Op.setOffset(Offset);
     return Op;
   }
   const MachineOperand &operator=(const MachineOperand &MO) {
-    contents = MO.contents;
+    OpKind   = MO.OpKind;
     IsDef    = MO.IsDef;
     IsImp    = MO.IsImp;
     IsKill   = MO.IsKill;
     IsDead   = MO.IsDead;
-    opType   = MO.opType;
-    auxInfo  = MO.auxInfo;
+    IsEarlyClobber = MO.IsEarlyClobber;
+    SubReg   = MO.SubReg;
     ParentMI = MO.ParentMI;
+    Contents = MO.Contents;
     return *this;
   }
 
-  friend std::ostream& operator<<(std::ostream& os, const MachineOperand& mop) {
-    mop.print(os);
-    return os;
+  friend class MachineInstr;
+  friend class MachineRegisterInfo;
+private:
+  //===--------------------------------------------------------------------===//
+  // Methods for handling register use/def lists.
+  //===--------------------------------------------------------------------===//
+
+  /// isOnRegUseList - Return true if this operand is on a register use/def list
+  /// or false if not.  This can only be called for register operands that are
+  /// part of a machine instruction.
+  bool isOnRegUseList() const {
+    assert(isRegister() && "Can only add reg operand to use lists");
+    return Contents.Reg.Prev != 0;
   }
+  
+  /// AddRegOperandToRegInfo - Add this register operand to the specified
+  /// MachineRegisterInfo.  If it is null, then the next/prev fields should be
+  /// explicitly nulled out.
+  void AddRegOperandToRegInfo(MachineRegisterInfo *RegInfo);
 
-  friend class MachineInstr;
+  void RemoveRegOperandFromRegInfo() {
+    assert(isOnRegUseList() && "Reg operand is not on a use list");
+    // Unlink this from the doubly linked list of operands.
+    MachineOperand *NextOp = Contents.Reg.Next;
+    *Contents.Reg.Prev = NextOp; 
+    if (NextOp) {
+      assert(NextOp->getReg() == getReg() && "Corrupt reg use/def chain!");
+      NextOp->Contents.Reg.Prev = Contents.Reg.Prev;
+    }
+    Contents.Reg.Prev = 0;
+    Contents.Reg.Next = 0;
+  }
 };
 
-std::ostream& operator<<(std::ostream &OS, const MachineOperand &MO);
+inline std::ostream &operator<<(std::ostream &OS, const MachineOperand &MO) {
+  MO.print(OS, 0);
+  return OS;
+}
+
+inline raw_ostream &operator<<(raw_ostream &OS, const MachineOperand& MO) {
+  MO.print(OS, 0);
+  return OS;
+}
 
 } // End llvm namespace