Fix some bugs with the handling of indices in insertvalue/extractvalue.
[oota-llvm.git] / include / llvm / Instructions.h
index ba46b2031e0a59b5e191943c68f89fbaf650a70e..9393ec4953e19121d254f21e9a1785d812ff9eaa 100644 (file)
@@ -22,6 +22,7 @@
 #include "llvm/DerivedTypes.h"
 #include "llvm/ParameterAttributes.h"
 #include "llvm/BasicBlock.h"
+#include "llvm/ADT/SmallVector.h"
 
 namespace llvm {
 
@@ -291,8 +292,8 @@ class StoreInst : public Instruction {
   
   StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store,
                                                &Op<0>(), 2) {
-    Op<0>().init(SI.Op<0>(), this);
-    Op<1>().init(SI.Op<1>(), this);
+    Op<0>() = SI.Op<0>();
+    Op<1>() = SI.Op<1>();
     setVolatile(SI.isVolatile());
     setAlignment(SI.getAlignment());
     
@@ -649,38 +650,6 @@ public:
            "Invalid operand types for ICmp instruction");
   }
 
-  /// @brief Return the predicate for this instruction.
-  Predicate getPredicate() const { return Predicate(SubclassData); }
-
-  /// @brief Set the predicate for this instruction to the specified value.
-  void setPredicate(Predicate P) { SubclassData = P; }
-  
-  /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
-  /// @returns the inverse predicate for the instruction's current predicate. 
-  /// @brief Return the inverse of the instruction's predicate.
-  Predicate getInversePredicate() const {
-    return getInversePredicate(getPredicate());
-  }
-
-  /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
-  /// @returns the inverse predicate for predicate provided in \p pred. 
-  /// @brief Return the inverse of a given predicate
-  static Predicate getInversePredicate(Predicate pred);
-
-  /// For example, EQ->EQ, SLE->SGE, ULT->UGT, etc.
-  /// @returns the predicate that would be the result of exchanging the two 
-  /// operands of the ICmpInst instruction without changing the result 
-  /// produced.  
-  /// @brief Return the predicate as if the operands were swapped
-  Predicate getSwappedPredicate() const {
-    return getSwappedPredicate(getPredicate());
-  }
-
-  /// This is a static version that you can use without an instruction 
-  /// available.
-  /// @brief Return the predicate as if the operands were swapped.
-  static Predicate getSwappedPredicate(Predicate pred);
-
   /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
   /// @returns the predicate that would be the result if the operand were
   /// regarded as signed.
@@ -741,6 +710,22 @@ public:
   /// @brief Determine if the predicate is signed.
   static bool isSignedPredicate(Predicate pred);
 
+  /// @returns true if the specified compare predicate is
+  /// true when both operands are equal...
+  /// @brief Determine if the icmp is true when both operands are equal
+  static bool isTrueWhenEqual(ICmpInst::Predicate pred) {
+    return pred == ICmpInst::ICMP_EQ  || pred == ICmpInst::ICMP_UGE ||
+           pred == ICmpInst::ICMP_SGE || pred == ICmpInst::ICMP_ULE ||
+           pred == ICmpInst::ICMP_SLE;
+  }
+
+  /// @returns true if the specified compare instruction is
+  /// true when both operands are equal...
+  /// @brief Determine if the ICmpInst returns true when both operands are equal
+  bool isTrueWhenEqual() {
+    return isTrueWhenEqual(getPredicate());
+  }
+
   /// Initialize a set of values that all satisfy the predicate with C. 
   /// @brief Make a ConstantRange for a relation with a constant value.
   static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
@@ -813,38 +798,6 @@ public:
            "Invalid operand types for FCmp instruction");
   }
 
-  /// @brief Return the predicate for this instruction.
-  Predicate getPredicate() const { return Predicate(SubclassData); }
-
-  /// @brief Set the predicate for this instruction to the specified value.
-  void setPredicate(Predicate P) { SubclassData = P; }
-
-  /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
-  /// @returns the inverse predicate for the instructions current predicate. 
-  /// @brief Return the inverse of the predicate
-  Predicate getInversePredicate() const {
-    return getInversePredicate(getPredicate());
-  }
-
-  /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
-  /// @returns the inverse predicate for \p pred.
-  /// @brief Return the inverse of a given predicate
-  static Predicate getInversePredicate(Predicate pred);
-
-  /// For example, OEQ->OEQ, ULE->UGE, OLT->OGT, etc.
-  /// @returns the predicate that would be the result of exchanging the two 
-  /// operands of the ICmpInst instruction without changing the result 
-  /// produced.  
-  /// @brief Return the predicate as if the operands were swapped
-  Predicate getSwappedPredicate() const {
-    return getSwappedPredicate(getPredicate());
-  }
-
-  /// This is a static version that you can use without an instruction 
-  /// available.
-  /// @brief Return the predicate as if the operands were swapped.
-  static Predicate getSwappedPredicate(Predicate Opcode);
-
   /// This also tests for commutativity. If isEquality() returns true then
   /// the predicate is also commutative. Only the equality predicates are
   /// commutative.
@@ -1109,6 +1062,9 @@ public:
 
   /// setParamAttrs - Sets the parameter attributes for this call.
   void setParamAttrs(const PAListPtr &Attrs) { ParamAttrs = Attrs; }
+  
+  /// addParamAttr - adds the attribute to the list of attributes.
+  void addParamAttr(unsigned i, ParameterAttributes attr);
 
   /// @brief Determine whether the call or the callee has the given attribute.
   bool paramHasAttr(unsigned i, unsigned attr) const;
@@ -1318,8 +1274,8 @@ public:
 class ExtractElementInst : public Instruction {
   ExtractElementInst(const ExtractElementInst &EE) :
     Instruction(EE.getType(), ExtractElement, &Op<0>(), 2) {
-    Op<0>().init(EE.Op<0>(), this);
-    Op<1>().init(EE.Op<1>(), this);
+    Op<0>() = EE.Op<0>();
+    Op<1>() = EE.Op<1>();
   }
 
 public:
@@ -1499,9 +1455,11 @@ DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
 /// element value from an aggregate value.
 ///
 class ExtractValueInst : public Instruction {
+  SmallVector<unsigned, 4> Indices;
+
   ExtractValueInst(const ExtractValueInst &EVI);
-  void init(Value *Agg, Value* const *Idx, unsigned NumIdx);
-  void init(Value *Agg, Value *Idx);
+  void init(Value *Agg, const unsigned *Idx, unsigned NumIdx);
+  void init(Value *Agg, unsigned Idx);
 
   template<typename InputIterator>
   void init(Value *Agg, InputIterator IdxBegin, InputIterator IdxEnd,
@@ -1511,14 +1469,15 @@ class ExtractValueInst : public Instruction {
             std::random_access_iterator_tag) {
     unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
     
-    if (NumIdx > 0) {
-      // This requires that the iterator points to contiguous memory.
-      init(Agg, &*IdxBegin, NumIdx); // FIXME: for the general case
-                                     // we have to build an array here
-    }
-    else {
-      init(Agg, 0, NumIdx);
-    }
+    // There's no fundamental reason why we require at least one index
+    // (other than weirdness with &*IdxBegin being invalid; see
+    // getelementptr's init routine for example). But there's no
+    // present need to support it.
+    assert(NumIdx > 0 && "ExtractValueInst must have at least one index");
+
+    // This requires that the iterator points to contiguous memory.
+    init(Agg, &*IdxBegin, NumIdx); // FIXME: for the general case
+                                   // we have to build an array here
 
     setName(Name);
   }
@@ -1530,7 +1489,7 @@ class ExtractValueInst : public Instruction {
   /// pointer type.
   ///
   static const Type *getIndexedType(const Type *Agg,
-                                    Value* const *Idx, unsigned NumIdx);
+                                    const unsigned *Idx, unsigned NumIdx);
 
   template<typename InputIterator>
   static const Type *getIndexedType(const Type *Ptr,
@@ -1544,9 +1503,9 @@ class ExtractValueInst : public Instruction {
 
     if (NumIdx > 0)
       // This requires that the iterator points to contiguous memory.
-      return getIndexedType(Ptr, (Value *const *)&*IdxBegin, NumIdx);
+      return getIndexedType(Ptr, (const unsigned *)&*IdxBegin, NumIdx);
     else
-      return getIndexedType(Ptr, (Value *const*)0, NumIdx);
+      return getIndexedType(Ptr, (const unsigned *)0, NumIdx);
   }
 
   /// Constructors - Create a extractvalue instruction with a base aggregate
@@ -1556,55 +1515,53 @@ class ExtractValueInst : public Instruction {
   template<typename InputIterator>
   inline ExtractValueInst(Value *Agg, InputIterator IdxBegin, 
                           InputIterator IdxEnd,
-                          unsigned Values,
                           const std::string &Name,
                           Instruction *InsertBefore);
   template<typename InputIterator>
   inline ExtractValueInst(Value *Agg,
                           InputIterator IdxBegin, InputIterator IdxEnd,
-                          unsigned Values,
                           const std::string &Name, BasicBlock *InsertAtEnd);
 
   /// Constructors - These two constructors are convenience methods because one
   /// and two index extractvalue instructions are so common.
-  ExtractValueInst(Value *Agg, Value *Idx, const std::string &Name = "",
+  ExtractValueInst(Value *Agg, unsigned Idx, const std::string &Name = "",
                     Instruction *InsertBefore = 0);
-  ExtractValueInst(Value *Agg, Value *Idx,
+  ExtractValueInst(Value *Agg, unsigned Idx,
                     const std::string &Name, BasicBlock *InsertAtEnd);
 public:
+  // allocate space for exactly two operands
+  void *operator new(size_t s) {
+    return User::operator new(s, 1);
+  }
+
   template<typename InputIterator>
   static ExtractValueInst *Create(Value *Agg, InputIterator IdxBegin, 
                                   InputIterator IdxEnd,
                                   const std::string &Name = "",
                                   Instruction *InsertBefore = 0) {
-    typename std::iterator_traits<InputIterator>::difference_type Values = 
-      1 + std::distance(IdxBegin, IdxEnd);
-    return new(Values)
-      ExtractValueInst(Agg, IdxBegin, IdxEnd, Values, Name, InsertBefore);
+    return new
+      ExtractValueInst(Agg, IdxBegin, IdxEnd, Name, InsertBefore);
   }
   template<typename InputIterator>
   static ExtractValueInst *Create(Value *Agg,
                                   InputIterator IdxBegin, InputIterator IdxEnd,
                                   const std::string &Name,
                                   BasicBlock *InsertAtEnd) {
-    typename std::iterator_traits<InputIterator>::difference_type Values = 
-      1 + std::distance(IdxBegin, IdxEnd);
-    return new(Values)
-      ExtractValueInst(Agg, IdxBegin, IdxEnd, Values, Name, InsertAtEnd);
+    return new ExtractValueInst(Agg, IdxBegin, IdxEnd, Name, InsertAtEnd);
   }
 
   /// Constructors - These two creators are convenience methods because one
   /// index extractvalue instructions are much more common than those with
   /// more than one.
-  static ExtractValueInst *Create(Value *Agg, Value *Idx,
+  static ExtractValueInst *Create(Value *Agg, unsigned Idx,
                                   const std::string &Name = "",
                                   Instruction *InsertBefore = 0) {
-    return new(2) ExtractValueInst(Agg, Idx, Name, InsertBefore);
+    return new ExtractValueInst(Agg, Idx, Name, InsertBefore);
   }
-  static ExtractValueInst *Create(Value *Agg, Value *Idx,
+  static ExtractValueInst *Create(Value *Agg, unsigned Idx,
                                   const std::string &Name,
                                   BasicBlock *InsertAtEnd) {
-    return new(2) ExtractValueInst(Agg, Idx, Name, InsertAtEnd);
+    return new ExtractValueInst(Agg, Idx, Name, InsertAtEnd);
   }
 
   virtual ExtractValueInst *clone() const;
@@ -1631,12 +1588,10 @@ public:
                           typename std::iterator_traits<InputIterator>::
                           iterator_category());
   }  
-  static const Type *getIndexedType(const Type *Ptr, Value *Idx);
+  static const Type *getIndexedType(const Type *Ptr, unsigned Idx);
 
-  inline op_iterator       idx_begin()       { return op_begin()+1; }
-  inline const_op_iterator idx_begin() const { return op_begin()+1; }
-  inline op_iterator       idx_end()         { return op_end(); }
-  inline const_op_iterator idx_end()   const { return op_end(); }
+  inline const unsigned *idx_begin() const { return Indices.begin(); }
+  inline const unsigned *idx_end()   const { return Indices.end(); }
 
   Value *getAggregateOperand() {
     return getOperand(0);
@@ -1649,11 +1604,11 @@ public:
   }
 
   unsigned getNumIndices() const {  // Note: always non-negative
-    return getNumOperands() - 1;
+    return Indices.size();
   }
 
   bool hasIndices() const {
-    return getNumOperands() > 1;
+    return true;
   }
   
   // Methods for support type inquiry through isa, cast, and dyn_cast:
@@ -1667,11 +1622,39 @@ public:
 };
 
 template <>
-struct OperandTraits<ExtractValueInst> : VariadicOperandTraits<1> {
+struct OperandTraits<ExtractValueInst> : FixedNumOperandTraits<1> {
 };
 
+template<typename InputIterator>
+ExtractValueInst::ExtractValueInst(Value *Agg,
+                                   InputIterator IdxBegin, 
+                                   InputIterator IdxEnd,
+                                   const std::string &Name,
+                                   Instruction *InsertBefore)
+  : Instruction(checkType(getIndexedType(Agg->getType(), IdxBegin, IdxEnd)),
+                ExtractValue,
+                OperandTraits<ExtractValueInst>::op_begin(this),
+                1, InsertBefore) {
+  init(Agg, IdxBegin, IdxEnd, Name,
+       typename std::iterator_traits<InputIterator>::iterator_category());
+}
+template<typename InputIterator>
+ExtractValueInst::ExtractValueInst(Value *Agg,
+                                   InputIterator IdxBegin,
+                                   InputIterator IdxEnd,
+                                   const std::string &Name,
+                                   BasicBlock *InsertAtEnd)
+  : Instruction(checkType(getIndexedType(Agg->getType(), IdxBegin, IdxEnd)),
+                ExtractValue,
+                OperandTraits<ExtractValueInst>::op_begin(this),
+                1, InsertAtEnd) {
+  init(Agg, IdxBegin, IdxEnd, Name,
+       typename std::iterator_traits<InputIterator>::iterator_category());
+}
+
 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractValueInst, Value)
 
+
 //===----------------------------------------------------------------------===//
 //                                InsertValueInst Class
 //===----------------------------------------------------------------------===//
@@ -1680,9 +1663,12 @@ DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractValueInst, Value)
 /// value into an aggregate value.
 ///
 class InsertValueInst : public Instruction {
+  SmallVector<unsigned, 4> Indices;
+
+  void *operator new(size_t, unsigned); // Do not implement
   InsertValueInst(const InsertValueInst &IVI);
-  void init(Value *Agg, Value *Val, Value* const *Idx, unsigned NumIdx);
-  void init(Value *Agg, Value *Val, Value *Idx);
+  void init(Value *Agg, Value *Val, const unsigned *Idx, unsigned NumIdx);
+  void init(Value *Agg, Value *Val, unsigned Idx);
 
   template<typename InputIterator>
   void init(Value *Agg, Value *Val,
@@ -1693,14 +1679,15 @@ class InsertValueInst : public Instruction {
             std::random_access_iterator_tag) {
     unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
     
-    if (NumIdx > 0) {
-      // This requires that the iterator points to contiguous memory.
-      init(Agg, Val, &*IdxBegin, NumIdx); // FIXME: for the general case
-                                     // we have to build an array here
-    }
-    else {
-      init(Agg, Val, 0, NumIdx);
-    }
+    // There's no fundamental reason why we require at least one index
+    // (other than weirdness with &*IdxBegin being invalid; see
+    // getelementptr's init routine for example). But there's no
+    // present need to support it.
+    assert(NumIdx > 0 && "InsertValueInst must have at least one index");
+
+    // This requires that the iterator points to contiguous memory.
+    init(Agg, Val, &*IdxBegin, NumIdx); // FIXME: for the general case
+                                        // we have to build an array here
 
     setName(Name);
   }
@@ -1712,56 +1699,55 @@ class InsertValueInst : public Instruction {
   template<typename InputIterator>
   inline InsertValueInst(Value *Agg, Value *Val, InputIterator IdxBegin, 
                          InputIterator IdxEnd,
-                         unsigned Values,
                          const std::string &Name,
                          Instruction *InsertBefore);
   template<typename InputIterator>
   inline InsertValueInst(Value *Agg, Value *Val,
                          InputIterator IdxBegin, InputIterator IdxEnd,
-                         unsigned Values,
                          const std::string &Name, BasicBlock *InsertAtEnd);
 
   /// Constructors - These two constructors are convenience methods because one
   /// and two index insertvalue instructions are so common.
   InsertValueInst(Value *Agg, Value *Val,
-                  Value *Idx, const std::string &Name = "",
+                  unsigned Idx, const std::string &Name = "",
                   Instruction *InsertBefore = 0);
-  InsertValueInst(Value *Agg, Value *Val, Value *Idx,
+  InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
                   const std::string &Name, BasicBlock *InsertAtEnd);
 public:
+  // allocate space for exactly two operands
+  void *operator new(size_t s) {
+    return User::operator new(s, 2);
+  }
+
   template<typename InputIterator>
   static InsertValueInst *Create(Value *Agg, Value *Val, InputIterator IdxBegin, 
                                  InputIterator IdxEnd,
                                  const std::string &Name = "",
                                  Instruction *InsertBefore = 0) {
-    typename std::iterator_traits<InputIterator>::difference_type Values = 
-      1 + std::distance(IdxBegin, IdxEnd);
-    return new(Values)
-      InsertValueInst(Agg, Val, IdxBegin, IdxEnd, Values, Name, InsertBefore);
+    return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
+                               Name, InsertBefore);
   }
   template<typename InputIterator>
   static InsertValueInst *Create(Value *Agg, Value *Val,
                                  InputIterator IdxBegin, InputIterator IdxEnd,
                                  const std::string &Name,
                                  BasicBlock *InsertAtEnd) {
-    typename std::iterator_traits<InputIterator>::difference_type Values = 
-      1 + std::distance(IdxBegin, IdxEnd);
-    return new(Values)
-      InsertValueInst(Agg, Val, IdxBegin, IdxEnd, Values, Name, InsertAtEnd);
+    return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
+                               Name, InsertAtEnd);
   }
 
   /// Constructors - These two creators are convenience methods because one
   /// index insertvalue instructions are much more common than those with
   /// more than one.
-  static InsertValueInst *Create(Value *Agg, Value *Val, Value *Idx,
+  static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
                                  const std::string &Name = "",
                                  Instruction *InsertBefore = 0) {
-    return new(3) InsertValueInst(Agg, Val, Idx, Name, InsertBefore);
+    return new InsertValueInst(Agg, Val, Idx, Name, InsertBefore);
   }
-  static InsertValueInst *Create(Value *Agg, Value *Val, Value *Idx,
+  static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
                                  const std::string &Name,
                                  BasicBlock *InsertAtEnd) {
-    return new(3) InsertValueInst(Agg, Val, Idx, Name, InsertAtEnd);
+    return new InsertValueInst(Agg, Val, Idx, Name, InsertAtEnd);
   }
 
   virtual InsertValueInst *clone() const;
@@ -1774,10 +1760,8 @@ public:
     return reinterpret_cast<const PointerType*>(Instruction::getType());
   }
 
-  inline op_iterator       idx_begin()       { return op_begin()+1; }
-  inline const_op_iterator idx_begin() const { return op_begin()+1; }
-  inline op_iterator       idx_end()         { return op_end(); }
-  inline const_op_iterator idx_end()   const { return op_end(); }
+  inline const unsigned *idx_begin() const { return Indices.begin(); }
+  inline const unsigned *idx_end()   const { return Indices.end(); }
 
   Value *getAggregateOperand() {
     return getOperand(0);
@@ -1800,11 +1784,11 @@ public:
   }
 
   unsigned getNumIndices() const {  // Note: always non-negative
-    return getNumOperands() - 2;
+    return Indices.size();
   }
 
   bool hasIndices() const {
-    return getNumOperands() > 2;
+    return true;
   }
   
   // Methods for support type inquiry through isa, cast, and dyn_cast:
@@ -1818,9 +1802,36 @@ public:
 };
 
 template <>
-struct OperandTraits<InsertValueInst> : VariadicOperandTraits<2> {
+struct OperandTraits<InsertValueInst> : FixedNumOperandTraits<2> {
 };
 
+template<typename InputIterator>
+InsertValueInst::InsertValueInst(Value *Agg,
+                                 Value *Val,
+                                 InputIterator IdxBegin, 
+                                 InputIterator IdxEnd,
+                                 const std::string &Name,
+                                 Instruction *InsertBefore)
+  : Instruction(Agg->getType(), InsertValue,
+                OperandTraits<InsertValueInst>::op_begin(this),
+                2, InsertBefore) {
+  init(Agg, Val, IdxBegin, IdxEnd, Name,
+       typename std::iterator_traits<InputIterator>::iterator_category());
+}
+template<typename InputIterator>
+InsertValueInst::InsertValueInst(Value *Agg,
+                                 Value *Val,
+                                 InputIterator IdxBegin,
+                                 InputIterator IdxEnd,
+                                 const std::string &Name,
+                                 BasicBlock *InsertAtEnd)
+  : Instruction(Agg->getType(), InsertValue,
+                OperandTraits<InsertValueInst>::op_begin(this),
+                2, InsertAtEnd) {
+  init(Agg, Val, IdxBegin, IdxEnd, Name,
+       typename std::iterator_traits<InputIterator>::iterator_category());
+}
+
 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
 
 //===----------------------------------------------------------------------===//
@@ -1919,8 +1930,8 @@ public:
       resizeOperands(0);  // Get more space!
     // Initialize some new operands.
     NumOperands = OpNo+2;
-    OperandList[OpNo].init(V, this);
-    OperandList[OpNo+1].init(BB, this);
+    OperandList[OpNo] = V;
+    OperandList[OpNo+1] = BB;
   }
 
   /// removeIncomingValue - Remove an incoming value.  This is useful if a
@@ -2428,6 +2439,9 @@ public:
 
   /// @brief Determine whether the call or the callee has the given attribute.
   bool paramHasAttr(unsigned i, ParameterAttributes attr) const;
+  
+  /// addParamAttr - adds the attribute to the list of attributes.
+  void addParamAttr(unsigned i, ParameterAttributes attr);
 
   /// @brief Extract the alignment for a call or parameter (0=unknown).
   unsigned getParamAlignment(unsigned i) const {