Add a predicate
[oota-llvm.git] / include / llvm / CodeGen / MachineInstr.h
index d23252e5b80a8a92e3dfbd034b9df5e729dab1cd..b84388597af4a893c8c21ae522f21c22e96e33b4 100644 (file)
@@ -1,10 +1,10 @@
 //===-- llvm/CodeGen/MachineInstr.h - MachineInstr class --------*- 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 contains the declaration of the MachineInstr class, which is the
@@ -17,7 +17,7 @@
 #define LLVM_CODEGEN_MACHINEINSTR_H
 
 #include "llvm/ADT/iterator"
-#include <string>
+#include "llvm/Support/DataTypes.h"
 #include <vector>
 #include <cassert>
 
@@ -29,44 +29,44 @@ class MachineBasicBlock;
 class TargetMachine;
 class GlobalValue;
 
-template <typename T> class ilist_traits;
-template <typename T> class ilist;
+template <typename T> struct ilist_traits;
+template <typename T> struct ilist;
 
 typedef short MachineOpCode;
 
 //===----------------------------------------------------------------------===//
-// class MachineOperand 
-// 
+// class MachineOperand
+//
 // Purpose:
 //   Representation of each machine instruction operand.
 //   This class is designed so that you can allocate a vector of operands
 //   first and initialize each one later.
 //
 //   E.g, for this VM instruction:
-//             ptr = alloca type, numElements
+//     ptr = alloca type, numElements
 //   we generate 2 machine instructions on the SPARC:
-// 
-//             mul Constant, Numelements -> Reg
-//             add %sp, Reg -> Ptr
-// 
+//
+//    mul Constant, Numelements -> Reg
+//    add %sp, Reg -> Ptr
+//
 //   Each instruction has 3 operands, listed above.  Of those:
-//   - Reg, NumElements, and Ptr are of operand type MO_Register.
-//   - Constant is of operand type MO_SignExtendedImmed on the SPARC.
-//     
+//   - Reg, NumElements, and Ptr are of operand type MO_Register.
+//   - Constant is of operand type MO_SignExtendedImmed on the SPARC.
+//
 //   For the register operands, the virtual register type is as follows:
-//     
-//   -  Reg will be of virtual register type MO_MInstrVirtualReg.  The field
-//     MachineInstr* minstr will point to the instruction that computes reg.
-// 
-//   - %sp will be of virtual register type MO_MachineReg.
-//     The field regNum identifies the machine register.
-// 
-//   - NumElements will be of virtual register type MO_VirtualReg.
-//     The field Value* value identifies the value.
-// 
-//   - Ptr will also be of virtual register type MO_VirtualReg.
-//     Again, the field Value* value identifies the value.
-// 
+//
+//   - Reg will be of virtual register type MO_MInstrVirtualReg.  The field
+//     MachineInstr* minstr will point to the instruction that computes reg.
+//
+//   - %sp will be of virtual register type MO_MachineReg.
+//     The field regNum identifies the machine register.
+//
+//   - NumElements will be of virtual register type MO_VirtualReg.
+//     The field Value* value identifies the value.
+//
+//   - Ptr will also be of virtual register type MO_VirtualReg.
+//     Again, the field Value* value identifies the value.
+//
 //===----------------------------------------------------------------------===//
 
 struct MachineOperand {
@@ -79,7 +79,7 @@ private:
     LOFLAG32    = 0x08,       // operand is %lo32(value_or_immedVal)
     HIFLAG64    = 0x10,       // operand is %hi64(value_or_immedVal)
     LOFLAG64    = 0x20,       // operand is %lo64(value_or_immedVal)
-    PCRELATIVE  = 0x40,       // Operand is relative to PC, not a global address
+    PCRELATIVE  = 0x40        // Operand is relative to PC, not a global address
   };
 
 public:
@@ -96,8 +96,8 @@ public:
   };
 
   enum MachineOperandType {
-    MO_VirtualRegister,                // virtual register for *value
-    MO_MachineRegister,                // pre-assigned machine register `regNum'
+    MO_VirtualRegister,         // virtual register for *value
+    MO_MachineRegister,         // pre-assigned machine register `regNum'
     MO_CCRegister,
     MO_SignExtendedImmed,
     MO_UnextendedImmed,
@@ -106,44 +106,49 @@ public:
     MO_FrameIndex,              // Abstract Stack Frame Index
     MO_ConstantPoolIndex,       // Address of indexed Constant in Constant Pool
     MO_ExternalSymbol,          // Name of external global symbol
-    MO_GlobalAddress,           // Address of a global value
+    MO_GlobalAddress            // Address of a global value
   };
-  
+
 private:
   union {
     Value*  value;      // BasicBlockVal for a label operand.
                         // ConstantVal for a non-address immediate.
                         // Virtual register for an SSA operand,
                         //   including hidden operands required for
-                        //   the generated machine code.     
+                        //   the generated machine code.
                         // LLVM global for MO_GlobalAddress.
 
-    int immedVal;              // Constant value for an explicit constant
+    int64_t immedVal;   // Constant value for an explicit constant
 
     MachineBasicBlock *MBB;     // For MO_MachineBasicBlock type
-    std::string *SymbolName;    // For MO_ExternalSymbol type
+    const char *SymbolName;     // For MO_ExternalSymbol type
   } contents;
 
   char flags;                   // see bit field definitions above
   MachineOperandType opType:8;  // Pack into 8 bits efficiently after flags.
   union {
-    int regNum;                        // register number for an explicit register
+    int regNum;                 // register number for an explicit register
                                 // will be set for a value after reg allocation
 
     int offset;                 // Offset to address of global or external, only
-                                // valid for MO_GlobalAddress and MO_ExternalSym
+                                // valid for MO_GlobalAddress, MO_ExternalSym
+                                // and MO_ConstantPoolIndex
   } extra;
 
-  void zeroContents () { 
+  void zeroContents () {
     memset (&contents, 0, sizeof (contents));
     memset (&extra, 0, sizeof (extra));
   }
 
-  MachineOperand(int ImmVal = 0, MachineOperandType OpTy = MO_VirtualRegister)
+  MachineOperand(int64_t ImmVal = 0,
+        MachineOperandType OpTy = MO_VirtualRegister, int Offset = 0)
     : flags(0), opType(OpTy) {
     zeroContents ();
     contents.immedVal = ImmVal;
-    extra.regNum = -1;
+    if (OpTy == MachineOperand::MO_ConstantPoolIndex)
+      extra.offset = Offset;
+    else
+      extra.regNum = -1;
   }
 
   MachineOperand(int Reg, MachineOperandType OpTy, UseType UseTy)
@@ -153,10 +158,20 @@ private:
   }
 
   MachineOperand(Value *V, MachineOperandType OpTy, UseType UseTy,
-                bool isPCRelative = false, int Offset = 0)
+                 bool isPCRelative = false)
     : flags(UseTy | (isPCRelative?PCRELATIVE:0)), opType(OpTy) {
-    zeroContents ();
+    assert(OpTy != MachineOperand::MO_GlobalAddress);
+    zeroContents();
     contents.value = V;
+    extra.regNum = -1;
+  }
+
+  MachineOperand(GlobalValue *V, MachineOperandType OpTy, UseType UseTy,
+                 bool isPCRelative = false, int Offset = 0)
+    : flags(UseTy | (isPCRelative?PCRELATIVE:0)), opType(OpTy) {
+    assert(OpTy == MachineOperand::MO_GlobalAddress);
+    zeroContents ();
+    contents.value = (Value*)V;
     extra.offset = Offset;
   }
 
@@ -167,10 +182,10 @@ private:
     extra.regNum = -1;
   }
 
-  MachineOperand(const std::string &SymName, bool isPCRelative, int Offset)
+  MachineOperand(const char *SymName, bool isPCRelative, int Offset)
     : flags(isPCRelative?PCRELATIVE:0), opType(MO_ExternalSymbol) {
     zeroContents ();
-    contents.SymbolName = new std::string (SymName);
+    contents.SymbolName = SymName;
     extra.offset = Offset;
   }
 
@@ -180,30 +195,21 @@ public:
     zeroContents ();
     contents = M.contents;
     extra = M.extra;
-    if (isExternalSymbol())
-      contents.SymbolName = new std::string(M.getSymbolName());
   }
 
-  ~MachineOperand() {
-    if (isExternalSymbol())
-      delete contents.SymbolName;
-  }
-  
+
+  ~MachineOperand() {}
+
   const MachineOperand &operator=(const MachineOperand &MO) {
-    if (isExternalSymbol())             // if old operand had a symbol name,
-      delete contents.SymbolName;       // release old memory
     contents = MO.contents;
     flags    = MO.flags;
     opType   = MO.opType;
     extra    = MO.extra;
-    if (isExternalSymbol())
-      contents.SymbolName = new std::string(MO.getSymbolName());
     return *this;
   }
 
   /// getType - Returns the MachineOperandType for this operand.
-  /// 
+  ///
   MachineOperandType getType() const { return opType; }
 
   /// getUseType - Returns the MachineOperandUseType of this operand.
@@ -243,7 +249,7 @@ public:
   /// has one. This is deprecated and only used by the SPARC v9 backend.
   ///
   Value* getVRegValueOrNull() const {
-    return (opType == MO_VirtualRegister || opType == MO_CCRegister || 
+    return (opType == MO_VirtualRegister || opType == MO_CCRegister ||
             isPCRelativeDisp()) ? contents.value : NULL;
   }
 
@@ -259,7 +265,7 @@ public:
     assert(opType == MO_MachineRegister && "Wrong MachineOperand accessor");
     return extra.regNum;
   }
-  int getImmedValue() const {
+  int64_t getImmedValue() const {
     assert(isImmediate() && "Wrong MachineOperand accessor");
     return contents.immedVal;
   }
@@ -273,24 +279,24 @@ public:
   }
   int getFrameIndex() const {
     assert(isFrameIndex() && "Wrong MachineOperand accessor");
-    return contents.immedVal;
+    return (int)contents.immedVal;
   }
   unsigned getConstantPoolIndex() const {
     assert(isConstantPoolIndex() && "Wrong MachineOperand accessor");
-    return contents.immedVal;
+    return (unsigned)contents.immedVal;
   }
   GlobalValue *getGlobal() const {
     assert(isGlobalAddress() && "Wrong MachineOperand accessor");
     return (GlobalValue*)contents.value;
   }
   int getOffset() const {
-    assert((isGlobalAddress() || isExternalSymbol()) &&
+    assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
         "Wrong MachineOperand accessor");
     return extra.offset;
   }
-  const std::string &getSymbolName() const {
+  const char *getSymbolName() const {
     assert(isExternalSymbol() && "Wrong MachineOperand accessor");
-    return *contents.SymbolName;
+    return contents.SymbolName;
   }
 
   /// MachineOperand methods for testing that work on any kind of
@@ -310,7 +316,7 @@ public:
   ///
   bool hasAllocatedReg() const {
     return (extra.regNum >= 0 &&
-            (opType == MO_VirtualRegister || opType == MO_CCRegister || 
+            (opType == MO_VirtualRegister || opType == MO_CCRegister ||
              opType == MO_MachineRegister));
   }
 
@@ -329,20 +335,20 @@ public:
     // code.' It's not clear where the duplication is.
     assert(hasAllocatedReg() && "This operand cannot have a register number!");
     extra.regNum = Reg;
-  }  
+  }
 
   void setValueReg(Value *val) {
     assert(getVRegValueOrNull() != 0 && "Original operand must of type Value*");
     contents.value = val;
   }
-  
+
   void setImmedValue(int immVal) {
     assert(isImmediate() && "Wrong MachineOperand mutator");
     contents.immedVal = immVal;
   }
 
   void setOffset(int Offset) {
-    assert((isGlobalAddress() || isExternalSymbol()) &&
+    assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
         "Wrong MachineOperand accessor");
     extra.offset = Offset;
   }
@@ -356,35 +362,35 @@ public:
   void markLo32()      { flags |= LOFLAG32; }
   void markHi64()      { flags |= HIFLAG64; }
   void markLo64()      { flags |= LOFLAG64; }
-  
+
 private:
   /// setRegForValue - Replaces the Value with its corresponding physical
   /// register after register allocation is complete. This is deprecated
   /// and only used by the SPARC v9 back-end.
   ///
   void setRegForValue(int reg) {
-    assert(opType == MO_VirtualRegister || opType == MO_CCRegister || 
-          opType == MO_MachineRegister);
+    assert(opType == MO_VirtualRegister || opType == MO_CCRegister ||
+           opType == MO_MachineRegister);
     extra.regNum = reg;
   }
-  
+
   friend class MachineInstr;
 };
 
 
 //===----------------------------------------------------------------------===//
-// class MachineInstr 
-// 
+// class MachineInstr
+//
 // Purpose:
 //   Representation of each machine instruction.
-// 
+//
 //   MachineOpCode must be an enum, defined separately for each target.
 //   E.g., It is defined in SparcInstructionSelection.h for the SPARC.
-// 
+//
 //  There are 2 kinds of operands:
-// 
-//  (1) Explicit operands of the machine instruction in vector operands[] 
-// 
+//
+//  (1) Explicit operands of the machine instruction in vector operands[]
+//
 //  (2) "Implicit operands" are values implicitly used or defined by the
 //      machine instruction, such as arguments to a CALL, return value of
 //      a CALL (if any), and return value of a RETURN.
@@ -407,7 +413,7 @@ class MachineInstr {
 
   // Intrusive list support
   //
-  friend class ilist_traits<MachineInstr>;
+  friend struct ilist_traits<MachineInstr>;
 
 public:
   MachineInstr(short Opcode, unsigned numOperands);
@@ -424,7 +430,7 @@ public:
   /// block.
   ///
   MachineInstr(MachineBasicBlock *MBB, short Opcode, unsigned numOps);
-  
+
   ~MachineInstr();
 
   const MachineBasicBlock* getParent() const { return parent; }
@@ -437,7 +443,7 @@ public:
   /// Access to explicit operands of the instruction.
   ///
   unsigned getNumOperands() const { return operands.size() - numImplicitRefs; }
-  
+
   const MachineOperand& getOperand(unsigned i) const {
     assert(i < getNumOperands() && "getOperand() out of range!");
     return operands[i];
@@ -452,7 +458,7 @@ public:
   // This returns the i'th entry in the operand vector.
   // That represents the i'th explicit operand or the (i-N)'th implicit operand,
   // depending on whether i < N or i >= N.
-  // 
+  //
   const MachineOperand& getExplOrImplOperand(unsigned i) const {
     assert(i < operands.size() && "getExplOrImplOperand() out of range!");
     return (i < getNumOperands()? getOperand(i)
@@ -461,9 +467,9 @@ public:
 
   //
   // Access to implicit operands of the instruction
-  // 
+  //
   unsigned getNumImplicitRefs() const{ return numImplicitRefs; }
-  
+
   MachineOperand& getImplicitOp(unsigned i) {
     assert(i < numImplicitRefs && "implicit ref# out of range!");
     return operands[i + operands.size() - numImplicitRefs];
@@ -501,10 +507,10 @@ public:
   void dump() const;
   friend std::ostream& operator<<(std::ostream& os, const MachineInstr& minstr);
 
-  //
   // Define iterators to access the Value operands of the Machine Instruction.
   // Note that these iterators only enumerate the explicit operands.
-  // begin() and end() are defined to produce these iterators...
+  // begin() and end() are defined to produce these iterators.  NOTE, these are
+  // SparcV9 specific!
   //
   template<class _MI, class _V> class ValOpIterator;
   typedef ValOpIterator<const MachineInstr*,const Value*> const_val_op_iterator;
@@ -605,6 +611,16 @@ public:
       MachineOperand(intValue, MachineOperand::MO_UnextendedImmed));
   }
 
+  /// addZeroExtImm64Operand - Add a zero extended 64-bit constant argument
+  /// to the machine instruction.
+  ///
+  void addZeroExtImm64Operand(uint64_t intValue) {
+    assert(!OperandsComplete() &&
+           "Trying to add an operand to a machine instr that is already done!");
+    operands.push_back(
+      MachineOperand(intValue, MachineOperand::MO_UnextendedImmed));
+  }
+
   /// addSignExtImmOperand - Add a zero extended constant argument to the
   /// machine instruction.
   ///
@@ -632,7 +648,7 @@ public:
   /// addConstantPoolndexOperand - Add a constant pool object index to the
   /// instruction.
   ///
-  void addConstantPoolIndexOperand(unsigned I) {
+  void addConstantPoolIndexOperand(unsigned I, int Offset=0) {
     assert(!OperandsComplete() &&
            "Trying to add an operand to a machine instr that is already done!");
     operands.push_back(MachineOperand(I, MachineOperand::MO_ConstantPoolIndex));
@@ -642,13 +658,13 @@ public:
     assert(!OperandsComplete() &&
            "Trying to add an operand to a machine instr that is already done!");
     operands.push_back(
-      MachineOperand((Value*)GV, MachineOperand::MO_GlobalAddress,
+      MachineOperand(GV, MachineOperand::MO_GlobalAddress,
                      MachineOperand::Use, isPCRelative, Offset));
   }
 
   /// addExternalSymbolOperand - Add an external symbol operand to this instr
   ///
-  void addExternalSymbolOperand(const std::string &SymName, bool isPCRelative) {
+  void addExternalSymbolOperand(const char *SymName, bool isPCRelative) {
     operands.push_back(MachineOperand(SymName, isPCRelative, 0));
   }
 
@@ -660,7 +676,7 @@ public:
   /// replace - Support to rewrite a machine instruction in place: for now,
   /// simply replace() and then set new operands with Set.*Operand methods
   /// below.
-  /// 
+  ///
   void replace(short Opcode, unsigned numOperands);
 
   /// setOpcode - Replace the opcode of the current instruction with a new one.
@@ -675,7 +691,7 @@ public:
   }
 
   // Access to set the operands when building the machine instruction
-  // 
+  //
   void SetMachineOperandVal(unsigned i,
                             MachineOperand::MachineOperandType operandType,
                             Value* V);
@@ -690,22 +706,22 @@ public:
   unsigned substituteValue(const Value* oldVal, Value* newVal,
                            bool defsOnly, bool notDefsAndUses,
                            bool& someArgsWereIgnored);
-  
+
   // SetRegForOperand -
   // SetRegForImplicitRef -
   // Mark an explicit or implicit operand with its allocated physical register.
-  // 
+  //
   void SetRegForOperand(unsigned i, int regNum);
   void SetRegForImplicitRef(unsigned i, int regNum);
 
   //
-  // Iterator to enumerate machine operands.
-  // 
+  // Iterator to enumerate machine operands.  NOTE, this is SPARCV9 specific!
+  //
   template<class MITy, class VTy>
   class ValOpIterator : public forward_iterator<VTy, ptrdiff_t> {
     unsigned i;
     MITy MI;
-    
+
     void skipToNextVal() {
       while (i < MI->getNumOperands() &&
              !( (MI->getOperand(i).getType() == MachineOperand::MO_VirtualRegister ||
@@ -713,14 +729,14 @@ public:
                 && MI->getOperand(i).getVRegValue() != 0))
         ++i;
     }
-  
+
     inline ValOpIterator(MITy mi, unsigned I) : i(I), MI(mi) {
       skipToNextVal();
     }
-  
+
   public:
     typedef ValOpIterator<MITy, VTy> _Self;
-    
+
     inline VTy operator*() const {
       return MI->getOperand(i).getVRegValue();
     }
@@ -730,16 +746,16 @@ public:
 
     inline VTy operator->() const { return operator*(); }
 
-    inline bool isUse()   const { return MI->getOperand(i).isUse(); } 
-    inline bool isDef()   const { return MI->getOperand(i).isDef(); } 
+    inline bool isUse()   const { return MI->getOperand(i).isUse(); }
+    inline bool isDef()   const { return MI->getOperand(i).isDef(); }
 
     inline _Self& operator++() { i++; skipToNextVal(); return *this; }
     inline _Self  operator++(int) { _Self tmp = *this; ++*this; return tmp; }
 
-    inline bool operator==(const _Self &y) const { 
+    inline bool operator==(const _Self &y) const {
       return i == y.i;
     }
-    inline bool operator!=(const _Self &y) const { 
+    inline bool operator!=(const _Self &y) const {
       return !operator==(y);
     }
 
@@ -751,10 +767,9 @@ public:
     }
   };
 
-  // define begin() and end()
+  // Note: These are Sparc-V9 specific!
   val_op_iterator begin() { return val_op_iterator::begin(this); }
   val_op_iterator end()   { return val_op_iterator::end(this); }
-
   const_val_op_iterator begin() const {
     return const_val_op_iterator::begin(this);
   }