include/llvm/Instructions.h

   1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file exposes the class definitions of all of the subclasses of the
  11 // Instruction class.  This is meant to be an easy way to get access to all
  12 // instruction subclasses.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_INSTRUCTIONS_H
  17 #define LLVM_INSTRUCTIONS_H
  18
  19 #include <iterator>
  20
  21 #include "llvm/InstrTypes.h"
  22 #include "llvm/DerivedTypes.h"
  23
  24 namespace llvm {
  25
  26 class BasicBlock;
  27 class ConstantInt;
  28 class PointerType;
  29 class VectorType;
  30 class ConstantRange;
  31 class APInt;
  32 class ParamAttrsList;
  33
  34 //===----------------------------------------------------------------------===//
  35 //                             AllocationInst Class
  36 //===----------------------------------------------------------------------===//
  37
  38 /// AllocationInst - This class is the common base class of MallocInst and
  39 /// AllocaInst.
  40 ///
  41 class AllocationInst : public UnaryInstruction {
  42   unsigned Alignment;
  43 protected:
  44   AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
  45                  const std::string &Name = "", Instruction *InsertBefore = 0);
  46   AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
  47                  const std::string &Name, BasicBlock *InsertAtEnd);
  48 public:
  49   // Out of line virtual method, so the vtable, etc has a home.
  50   virtual ~AllocationInst();
  51
  52   /// isArrayAllocation - Return true if there is an allocation size parameter
  53   /// to the allocation instruction that is not 1.
  54   ///
  55   bool isArrayAllocation() const;
  56
  57   /// getArraySize - Get the number of element allocated, for a simple
  58   /// allocation of a single element, this will return a constant 1 value.
  59   ///
  60   inline const Value *getArraySize() const { return getOperand(0); }
  61   inline Value *getArraySize() { return getOperand(0); }
  62
  63   /// getType - Overload to return most specific pointer type
  64   ///
  65   inline const PointerType *getType() const {
  66     return reinterpret_cast<const PointerType*>(Instruction::getType());
  67   }
  68
  69   /// getAllocatedType - Return the type that is being allocated by the
  70   /// instruction.
  71   ///
  72   const Type *getAllocatedType() const;
  73
  74   /// getAlignment - Return the alignment of the memory that is being allocated
  75   /// by the instruction.
  76   ///
  77   unsigned getAlignment() const { return Alignment; }
  78   void setAlignment(unsigned Align) {
  79     assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
  80     Alignment = Align;
  81   }
  82
  83   virtual Instruction *clone() const = 0;
  84
  85   // Methods for support type inquiry through isa, cast, and dyn_cast:
  86   static inline bool classof(const AllocationInst *) { return true; }
  87   static inline bool classof(const Instruction *I) {
  88     return I->getOpcode() == Instruction::Alloca ||
  89            I->getOpcode() == Instruction::Malloc;
  90   }
  91   static inline bool classof(const Value *V) {
  92     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  93   }
  94 };
  95
  96
  97 //===----------------------------------------------------------------------===//
  98 //                                MallocInst Class
  99 //===----------------------------------------------------------------------===//
 100
 101 /// MallocInst - an instruction to allocated memory on the heap
 102 ///
 103 class MallocInst : public AllocationInst {
 104   MallocInst(const MallocInst &MI);
 105 public:
 106   explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
 107                       const std::string &Name = "",
 108                       Instruction *InsertBefore = 0)
 109     : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
 110   MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
 111              BasicBlock *InsertAtEnd)
 112     : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
 113
 114   MallocInst(const Type *Ty, const std::string &Name,
 115              Instruction *InsertBefore = 0)
 116     : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
 117   MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
 118     : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
 119
 120   MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
 121              const std::string &Name, BasicBlock *InsertAtEnd)
 122     : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
 123   MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
 124                       const std::string &Name = "",
 125                       Instruction *InsertBefore = 0)
 126     : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
 127
 128   virtual MallocInst *clone() const;
 129
 130   // Methods for support type inquiry through isa, cast, and dyn_cast:
 131   static inline bool classof(const MallocInst *) { return true; }
 132   static inline bool classof(const Instruction *I) {
 133     return (I->getOpcode() == Instruction::Malloc);
 134   }
 135   static inline bool classof(const Value *V) {
 136     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 137   }
 138 };
 139
 140
 141 //===----------------------------------------------------------------------===//
 142 //                                AllocaInst Class
 143 //===----------------------------------------------------------------------===//
 144
 145 /// AllocaInst - an instruction to allocate memory on the stack
 146 ///
 147 class AllocaInst : public AllocationInst {
 148   AllocaInst(const AllocaInst &);
 149 public:
 150   explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
 151                       const std::string &Name = "",
 152                       Instruction *InsertBefore = 0)
 153     : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
 154   AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
 155              BasicBlock *InsertAtEnd)
 156     : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
 157
 158   AllocaInst(const Type *Ty, const std::string &Name,
 159              Instruction *InsertBefore = 0)
 160     : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
 161   AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
 162     : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
 163
 164   AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
 165              const std::string &Name = "", Instruction *InsertBefore = 0)
 166     : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
 167   AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
 168              const std::string &Name, BasicBlock *InsertAtEnd)
 169     : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
 170
 171   virtual AllocaInst *clone() const;
 172
 173   // Methods for support type inquiry through isa, cast, and dyn_cast:
 174   static inline bool classof(const AllocaInst *) { return true; }
 175   static inline bool classof(const Instruction *I) {
 176     return (I->getOpcode() == Instruction::Alloca);
 177   }
 178   static inline bool classof(const Value *V) {
 179     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 180   }
 181 };
 182
 183
 184 //===----------------------------------------------------------------------===//
 185 //                                 FreeInst Class
 186 //===----------------------------------------------------------------------===//
 187
 188 /// FreeInst - an instruction to deallocate memory
 189 ///
 190 class FreeInst : public UnaryInstruction {
 191   void AssertOK();
 192 public:
 193   explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
 194   FreeInst(Value *Ptr, BasicBlock *InsertAfter);
 195
 196   virtual FreeInst *clone() const;
 197
 198   // Accessor methods for consistency with other memory operations
 199   Value *getPointerOperand() { return getOperand(0); }
 200   const Value *getPointerOperand() const { return getOperand(0); }
 201
 202   // Methods for support type inquiry through isa, cast, and dyn_cast:
 203   static inline bool classof(const FreeInst *) { return true; }
 204   static inline bool classof(const Instruction *I) {
 205     return (I->getOpcode() == Instruction::Free);
 206   }
 207   static inline bool classof(const Value *V) {
 208     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 209   }
 210 };
 211
 212
 213 //===----------------------------------------------------------------------===//
 214 //                                LoadInst Class
 215 //===----------------------------------------------------------------------===//
 216
 217 /// LoadInst - an instruction for reading from memory.  This uses the
 218 /// SubclassData field in Value to store whether or not the load is volatile.
 219 ///
 220 class LoadInst : public UnaryInstruction {
 221
 222   LoadInst(const LoadInst &LI)
 223     : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
 224     setVolatile(LI.isVolatile());
 225     setAlignment(LI.getAlignment());
 226
 227 #ifndef NDEBUG
 228     AssertOK();
 229 #endif
 230   }
 231   void AssertOK();
 232 public:
 233   LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
 234   LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
 235   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile = false,
 236            Instruction *InsertBefore = 0);
 237   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
 238            Instruction *InsertBefore = 0);
 239   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
 240            BasicBlock *InsertAtEnd);
 241   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
 242            BasicBlock *InsertAtEnd);
 243
 244   LoadInst(Value *Ptr, const char *Name, Instruction *InsertBefore);
 245   LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAtEnd);
 246   explicit LoadInst(Value *Ptr, const char *Name = 0, bool isVolatile = false,
 247                     Instruction *InsertBefore = 0);
 248   LoadInst(Value *Ptr, const char *Name, bool isVolatile,
 249            BasicBlock *InsertAtEnd);
 250
 251   /// isVolatile - Return true if this is a load from a volatile memory
 252   /// location.
 253   ///
 254   bool isVolatile() const { return SubclassData & 1; }
 255
 256   /// setVolatile - Specify whether this is a volatile load or not.
 257   ///
 258   void setVolatile(bool V) {
 259     SubclassData = (SubclassData & ~1) | V;
 260   }
 261
 262   virtual LoadInst *clone() const;
 263
 264   /// getAlignment - Return the alignment of the access that is being performed
 265   ///
 266   unsigned getAlignment() const {
 267     return (1 << (SubclassData>>1)) >> 1;
 268   }
 269
 270   void setAlignment(unsigned Align);
 271
 272   Value *getPointerOperand() { return getOperand(0); }
 273   const Value *getPointerOperand() const { return getOperand(0); }
 274   static unsigned getPointerOperandIndex() { return 0U; }
 275
 276   // Methods for support type inquiry through isa, cast, and dyn_cast:
 277   static inline bool classof(const LoadInst *) { return true; }
 278   static inline bool classof(const Instruction *I) {
 279     return I->getOpcode() == Instruction::Load;
 280   }
 281   static inline bool classof(const Value *V) {
 282     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 283   }
 284 };
 285
 286
 287 //===----------------------------------------------------------------------===//
 288 //                                StoreInst Class
 289 //===----------------------------------------------------------------------===//
 290
 291 /// StoreInst - an instruction for storing to memory
 292 ///
 293 class StoreInst : public Instruction {
 294   Use Ops[2];
 295
 296   StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store, Ops, 2) {
 297     Ops[0].init(SI.Ops[0], this);
 298     Ops[1].init(SI.Ops[1], this);
 299     setVolatile(SI.isVolatile());
 300     setAlignment(SI.getAlignment());
 301
 302 #ifndef NDEBUG
 303     AssertOK();
 304 #endif
 305   }
 306   void AssertOK();
 307 public:
 308   StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
 309   StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
 310   StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
 311             Instruction *InsertBefore = 0);
 312   StoreInst(Value *Val, Value *Ptr, bool isVolatile,
 313             unsigned Align, Instruction *InsertBefore = 0);
 314   StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
 315   StoreInst(Value *Val, Value *Ptr, bool isVolatile,
 316             unsigned Align, BasicBlock *InsertAtEnd);
 317
 318
 319   /// isVolatile - Return true if this is a load from a volatile memory
 320   /// location.
 321   ///
 322   bool isVolatile() const { return SubclassData & 1; }
 323
 324   /// setVolatile - Specify whether this is a volatile load or not.
 325   ///
 326   void setVolatile(bool V) {
 327     SubclassData = (SubclassData & ~1) | V;
 328   }
 329
 330   /// Transparently provide more efficient getOperand methods.
 331   Value *getOperand(unsigned i) const {
 332     assert(i < 2 && "getOperand() out of range!");
 333     return Ops[i];
 334   }
 335   void setOperand(unsigned i, Value *Val) {
 336     assert(i < 2 && "setOperand() out of range!");
 337     Ops[i] = Val;
 338   }
 339   unsigned getNumOperands() const { return 2; }
 340
 341   /// getAlignment - Return the alignment of the access that is being performed
 342   ///
 343   unsigned getAlignment() const {
 344     return (1 << (SubclassData>>1)) >> 1;
 345   }
 346
 347   void setAlignment(unsigned Align);
 348
 349   virtual StoreInst *clone() const;
 350
 351   Value *getPointerOperand() { return getOperand(1); }
 352   const Value *getPointerOperand() const { return getOperand(1); }
 353   static unsigned getPointerOperandIndex() { return 1U; }
 354
 355   // Methods for support type inquiry through isa, cast, and dyn_cast:
 356   static inline bool classof(const StoreInst *) { return true; }
 357   static inline bool classof(const Instruction *I) {
 358     return I->getOpcode() == Instruction::Store;
 359   }
 360   static inline bool classof(const Value *V) {
 361     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 362   }
 363 };
 364
 365
 366 //===----------------------------------------------------------------------===//
 367 //                             GetElementPtrInst Class
 368 //===----------------------------------------------------------------------===//
 369
 370 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
 371 /// access elements of arrays and structs
 372 ///
 373 class GetElementPtrInst : public Instruction {
 374   GetElementPtrInst(const GetElementPtrInst &GEPI)
 375     : Instruction(reinterpret_cast<const Type*>(GEPI.getType()), GetElementPtr,
 376                   0, GEPI.getNumOperands()) {
 377     Use *OL = OperandList = new Use[NumOperands];
 378     Use *GEPIOL = GEPI.OperandList;
 379     for (unsigned i = 0, E = NumOperands; i != E; ++i)
 380       OL[i].init(GEPIOL[i], this);
 381   }
 382   void init(Value *Ptr, Value* const *Idx, unsigned NumIdx);
 383   void init(Value *Ptr, Value *Idx0, Value *Idx1);
 384   void init(Value *Ptr, Value *Idx);
 385 public:
 386   /// Constructors - Create a getelementptr instruction with a base pointer an
 387   /// list of indices.  The first ctor can optionally insert before an existing
 388   /// instruction, the second appends the new instruction to the specified
 389   /// BasicBlock.
 390   GetElementPtrInst(Value *Ptr, Value* const *Idx, unsigned NumIdx,
 391                     const std::string &Name = "", Instruction *InsertBefore =0);
 392   GetElementPtrInst(Value *Ptr, Value* const *Idx, unsigned NumIdx,
 393                     const std::string &Name, BasicBlock *InsertAtEnd);
 394
 395   /// Constructors - These two constructors are convenience methods because one
 396   /// and two index getelementptr instructions are so common.
 397   GetElementPtrInst(Value *Ptr, Value *Idx,
 398                     const std::string &Name = "", Instruction *InsertBefore =0);
 399   GetElementPtrInst(Value *Ptr, Value *Idx,
 400                     const std::string &Name, BasicBlock *InsertAtEnd);
 401   GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
 402                     const std::string &Name = "", Instruction *InsertBefore =0);
 403   GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
 404                     const std::string &Name, BasicBlock *InsertAtEnd);
 405   ~GetElementPtrInst();
 406
 407   virtual GetElementPtrInst *clone() const;
 408
 409   // getType - Overload to return most specific pointer type...
 410   inline const PointerType *getType() const {
 411     return reinterpret_cast<const PointerType*>(Instruction::getType());
 412   }
 413
 414   /// getIndexedType - Returns the type of the element that would be loaded with
 415   /// a load instruction with the specified parameters.
 416   ///
 417   /// A null type is returned if the indices are invalid for the specified
 418   /// pointer type.
 419   ///
 420   static const Type *getIndexedType(const Type *Ptr,
 421                                     Value* const *Idx, unsigned NumIdx,
 422                                     bool AllowStructLeaf = false);
 423
 424   static const Type *getIndexedType(const Type *Ptr, Value *Idx0, Value *Idx1,
 425                                     bool AllowStructLeaf = false);
 426   static const Type *getIndexedType(const Type *Ptr, Value *Idx);
 427
 428   inline op_iterator       idx_begin()       { return op_begin()+1; }
 429   inline const_op_iterator idx_begin() const { return op_begin()+1; }
 430   inline op_iterator       idx_end()         { return op_end(); }
 431   inline const_op_iterator idx_end()   const { return op_end(); }
 432
 433   Value *getPointerOperand() {
 434     return getOperand(0);
 435   }
 436   const Value *getPointerOperand() const {
 437     return getOperand(0);
 438   }
 439   static unsigned getPointerOperandIndex() {
 440     return 0U;                      // get index for modifying correct operand
 441   }
 442
 443   inline unsigned getNumIndices() const {  // Note: always non-negative
 444     return getNumOperands() - 1;
 445   }
 446
 447   inline bool hasIndices() const {
 448     return getNumOperands() > 1;
 449   }
 450
 451   /// hasAllZeroIndices - Return true if all of the indices of this GEP are
 452   /// zeros.  If so, the result pointer and the first operand have the same
 453   /// value, just potentially different types.
 454   bool hasAllZeroIndices() const;
 455
 456   /// hasAllConstantIndices - Return true if all of the indices of this GEP are
 457   /// constant integers.  If so, the result pointer and the first operand have
 458   /// a constant offset between them.
 459   bool hasAllConstantIndices() const;
 460
 461
 462   // Methods for support type inquiry through isa, cast, and dyn_cast:
 463   static inline bool classof(const GetElementPtrInst *) { return true; }
 464   static inline bool classof(const Instruction *I) {
 465     return (I->getOpcode() == Instruction::GetElementPtr);
 466   }
 467   static inline bool classof(const Value *V) {
 468     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 469   }
 470 };
 471
 472 //===----------------------------------------------------------------------===//
 473 //                               ICmpInst Class
 474 //===----------------------------------------------------------------------===//
 475
 476 /// This instruction compares its operands according to the predicate given
 477 /// to the constructor. It only operates on integers, pointers, or packed
 478 /// vectors of integrals. The two operands must be the same type.
 479 /// @brief Represent an integer comparison operator.
 480 class ICmpInst: public CmpInst {
 481 public:
 482   /// This enumeration lists the possible predicates for the ICmpInst. The
 483   /// values in the range 0-31 are reserved for FCmpInst while values in the
 484   /// range 32-64 are reserved for ICmpInst. This is necessary to ensure the
 485   /// predicate values are not overlapping between the classes.
 486   enum Predicate {
 487     ICMP_EQ  = 32,    ///< equal
 488     ICMP_NE  = 33,    ///< not equal
 489     ICMP_UGT = 34,    ///< unsigned greater than
 490     ICMP_UGE = 35,    ///< unsigned greater or equal
 491     ICMP_ULT = 36,    ///< unsigned less than
 492     ICMP_ULE = 37,    ///< unsigned less or equal
 493     ICMP_SGT = 38,    ///< signed greater than
 494     ICMP_SGE = 39,    ///< signed greater or equal
 495     ICMP_SLT = 40,    ///< signed less than
 496     ICMP_SLE = 41,    ///< signed less or equal
 497     FIRST_ICMP_PREDICATE = ICMP_EQ,
 498     LAST_ICMP_PREDICATE = ICMP_SLE,
 499     BAD_ICMP_PREDICATE = ICMP_SLE + 1
 500   };
 501
 502   /// @brief Constructor with insert-before-instruction semantics.
 503   ICmpInst(
 504     Predicate pred,  ///< The predicate to use for the comparison
 505     Value *LHS,      ///< The left-hand-side of the expression
 506     Value *RHS,      ///< The right-hand-side of the expression
 507     const std::string &Name = "",  ///< Name of the instruction
 508     Instruction *InsertBefore = 0  ///< Where to insert
 509   ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertBefore) {
 510   }
 511
 512   /// @brief Constructor with insert-at-block-end semantics.
 513   ICmpInst(
 514     Predicate pred, ///< The predicate to use for the comparison
 515     Value *LHS,     ///< The left-hand-side of the expression
 516     Value *RHS,     ///< The right-hand-side of the expression
 517     const std::string &Name,  ///< Name of the instruction
 518     BasicBlock *InsertAtEnd   ///< Block to insert into.
 519   ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertAtEnd) {
 520   }
 521
 522   /// @brief Return the predicate for this instruction.
 523   Predicate getPredicate() const { return Predicate(SubclassData); }
 524
 525   /// @brief Set the predicate for this instruction to the specified value.
 526   void setPredicate(Predicate P) { SubclassData = P; }
 527
 528   /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
 529   /// @returns the inverse predicate for the instruction's current predicate.
 530   /// @brief Return the inverse of the instruction's predicate.
 531   Predicate getInversePredicate() const {
 532     return getInversePredicate(getPredicate());
 533   }
 534
 535   /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
 536   /// @returns the inverse predicate for predicate provided in \p pred.
 537   /// @brief Return the inverse of a given predicate
 538   static Predicate getInversePredicate(Predicate pred);
 539
 540   /// For example, EQ->EQ, SLE->SGE, ULT->UGT, etc.
 541   /// @returns the predicate that would be the result of exchanging the two
 542   /// operands of the ICmpInst instruction without changing the result
 543   /// produced.
 544   /// @brief Return the predicate as if the operands were swapped
 545   Predicate getSwappedPredicate() const {
 546     return getSwappedPredicate(getPredicate());
 547   }
 548
 549   /// This is a static version that you can use without an instruction
 550   /// available.
 551   /// @brief Return the predicate as if the operands were swapped.
 552   static Predicate getSwappedPredicate(Predicate pred);
 553
 554   /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
 555   /// @returns the predicate that would be the result if the operand were
 556   /// regarded as signed.
 557   /// @brief Return the signed version of the predicate
 558   Predicate getSignedPredicate() const {
 559     return getSignedPredicate(getPredicate());
 560   }
 561
 562   /// This is a static version that you can use without an instruction.
 563   /// @brief Return the signed version of the predicate.
 564   static Predicate getSignedPredicate(Predicate pred);
 565
 566   /// This also tests for commutativity. If isEquality() returns true then
 567   /// the predicate is also commutative.
 568   /// @returns true if the predicate of this instruction is EQ or NE.
 569   /// @brief Determine if this is an equality predicate.
 570   bool isEquality() const {
 571     return SubclassData == ICMP_EQ || SubclassData == ICMP_NE;
 572   }
 573
 574   /// @returns true if the predicate of this ICmpInst is commutative
 575   /// @brief Determine if this relation is commutative.
 576   bool isCommutative() const { return isEquality(); }
 577
 578   /// @returns true if the predicate is relational (not EQ or NE).
 579   /// @brief Determine if this a relational predicate.
 580   bool isRelational() const {
 581     return !isEquality();
 582   }
 583
 584   /// @returns true if the predicate of this ICmpInst is signed, false otherwise
 585   /// @brief Determine if this instruction's predicate is signed.
 586   bool isSignedPredicate() { return isSignedPredicate(getPredicate()); }
 587
 588   /// @returns true if the predicate provided is signed, false otherwise
 589   /// @brief Determine if the predicate is signed.
 590   static bool isSignedPredicate(Predicate pred);
 591
 592   /// Initialize a set of values that all satisfy the predicate with C.
 593   /// @brief Make a ConstantRange for a relation with a constant value.
 594   static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
 595
 596   /// Exchange the two operands to this instruction in such a way that it does
 597   /// not modify the semantics of the instruction. The predicate value may be
 598   /// changed to retain the same result if the predicate is order dependent
 599   /// (e.g. ult).
 600   /// @brief Swap operands and adjust predicate.
 601   void swapOperands() {
 602     SubclassData = getSwappedPredicate();
 603     std::swap(Ops[0], Ops[1]);
 604   }
 605
 606   virtual ICmpInst *clone() const;
 607
 608   // Methods for support type inquiry through isa, cast, and dyn_cast:
 609   static inline bool classof(const ICmpInst *) { return true; }
 610   static inline bool classof(const Instruction *I) {
 611     return I->getOpcode() == Instruction::ICmp;
 612   }
 613   static inline bool classof(const Value *V) {
 614     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 615   }
 616 };
 617
 618 //===----------------------------------------------------------------------===//
 619 //                               FCmpInst Class
 620 //===----------------------------------------------------------------------===//
 621
 622 /// This instruction compares its operands according to the predicate given
 623 /// to the constructor. It only operates on floating point values or packed
 624 /// vectors of floating point values. The operands must be identical types.
 625 /// @brief Represents a floating point comparison operator.
 626 class FCmpInst: public CmpInst {
 627 public:
 628   /// This enumeration lists the possible predicates for the FCmpInst. Values
 629   /// in the range 0-31 are reserved for FCmpInst.
 630   enum Predicate {
 631     // Opcode        U L G E    Intuitive operation
 632     FCMP_FALSE = 0, ///<  0 0 0 0    Always false (always folded)
 633     FCMP_OEQ   = 1, ///<  0 0 0 1    True if ordered and equal
 634     FCMP_OGT   = 2, ///<  0 0 1 0    True if ordered and greater than
 635     FCMP_OGE   = 3, ///<  0 0 1 1    True if ordered and greater than or equal
 636     FCMP_OLT   = 4, ///<  0 1 0 0    True if ordered and less than
 637     FCMP_OLE   = 5, ///<  0 1 0 1    True if ordered and less than or equal
 638     FCMP_ONE   = 6, ///<  0 1 1 0    True if ordered and operands are unequal
 639     FCMP_ORD   = 7, ///<  0 1 1 1    True if ordered (no nans)
 640     FCMP_UNO   = 8, ///<  1 0 0 0    True if unordered: isnan(X) | isnan(Y)
 641     FCMP_UEQ   = 9, ///<  1 0 0 1    True if unordered or equal
 642     FCMP_UGT   =10, ///<  1 0 1 0    True if unordered or greater than
 643     FCMP_UGE   =11, ///<  1 0 1 1    True if unordered, greater than, or equal
 644     FCMP_ULT   =12, ///<  1 1 0 0    True if unordered or less than
 645     FCMP_ULE   =13, ///<  1 1 0 1    True if unordered, less than, or equal
 646     FCMP_UNE   =14, ///<  1 1 1 0    True if unordered or not equal
 647     FCMP_TRUE  =15, ///<  1 1 1 1    Always true (always folded)
 648     FIRST_FCMP_PREDICATE = FCMP_FALSE,
 649     LAST_FCMP_PREDICATE = FCMP_TRUE,
 650     BAD_FCMP_PREDICATE = FCMP_TRUE + 1
 651   };
 652
 653   /// @brief Constructor with insert-before-instruction semantics.
 654   FCmpInst(
 655     Predicate pred,  ///< The predicate to use for the comparison
 656     Value *LHS,      ///< The left-hand-side of the expression
 657     Value *RHS,      ///< The right-hand-side of the expression
 658     const std::string &Name = "",  ///< Name of the instruction
 659     Instruction *InsertBefore = 0  ///< Where to insert
 660   ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertBefore) {
 661   }
 662
 663   /// @brief Constructor with insert-at-block-end semantics.
 664   FCmpInst(
 665     Predicate pred, ///< The predicate to use for the comparison
 666     Value *LHS,     ///< The left-hand-side of the expression
 667     Value *RHS,     ///< The right-hand-side of the expression
 668     const std::string &Name,  ///< Name of the instruction
 669     BasicBlock *InsertAtEnd   ///< Block to insert into.
 670   ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertAtEnd) {
 671   }
 672
 673   /// @brief Return the predicate for this instruction.
 674   Predicate getPredicate() const { return Predicate(SubclassData); }
 675
 676   /// @brief Set the predicate for this instruction to the specified value.
 677   void setPredicate(Predicate P) { SubclassData = P; }
 678
 679   /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
 680   /// @returns the inverse predicate for the instructions current predicate.
 681   /// @brief Return the inverse of the predicate
 682   Predicate getInversePredicate() const {
 683     return getInversePredicate(getPredicate());
 684   }
 685
 686   /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
 687   /// @returns the inverse predicate for \p pred.
 688   /// @brief Return the inverse of a given predicate
 689   static Predicate getInversePredicate(Predicate pred);
 690
 691   /// For example, OEQ->OEQ, ULE->UGE, OLT->OGT, etc.
 692   /// @returns the predicate that would be the result of exchanging the two
 693   /// operands of the ICmpInst instruction without changing the result
 694   /// produced.
 695   /// @brief Return the predicate as if the operands were swapped
 696   Predicate getSwappedPredicate() const {
 697     return getSwappedPredicate(getPredicate());
 698   }
 699
 700   /// This is a static version that you can use without an instruction
 701   /// available.
 702   /// @brief Return the predicate as if the operands were swapped.
 703   static Predicate getSwappedPredicate(Predicate Opcode);
 704
 705   /// This also tests for commutativity. If isEquality() returns true then
 706   /// the predicate is also commutative. Only the equality predicates are
 707   /// commutative.
 708   /// @returns true if the predicate of this instruction is EQ or NE.
 709   /// @brief Determine if this is an equality predicate.
 710   bool isEquality() const {
 711     return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
 712            SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
 713   }
 714   bool isCommutative() const { return isEquality(); }
 715
 716   /// @returns true if the predicate is relational (not EQ or NE).
 717   /// @brief Determine if this a relational predicate.
 718   bool isRelational() const { return !isEquality(); }
 719
 720   /// Exchange the two operands to this instruction in such a way that it does
 721   /// not modify the semantics of the instruction. The predicate value may be
 722   /// changed to retain the same result if the predicate is order dependent
 723   /// (e.g. ult).
 724   /// @brief Swap operands and adjust predicate.
 725   void swapOperands() {
 726     SubclassData = getSwappedPredicate();
 727     std::swap(Ops[0], Ops[1]);
 728   }
 729
 730   virtual FCmpInst *clone() const;
 731
 732   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
 733   static inline bool classof(const FCmpInst *) { return true; }
 734   static inline bool classof(const Instruction *I) {
 735     return I->getOpcode() == Instruction::FCmp;
 736   }
 737   static inline bool classof(const Value *V) {
 738     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 739   }
 740 };
 741
 742 //===----------------------------------------------------------------------===//
 743 //                                 CallInst Class
 744 //===----------------------------------------------------------------------===//
 745 /// CallInst - This class represents a function call, abstracting a target
 746 /// machine's calling convention.  This class uses low bit of the SubClassData
 747 /// field to indicate whether or not this is a tail call.  The rest of the bits
 748 /// hold the calling convention of the call.
 749 ///
 750
 751 class CallInst : public Instruction {
 752   ParamAttrsList *ParamAttrs; ///< parameter attributes for call
 753   CallInst(const CallInst &CI);
 754   void init(Value *Func, Value* const *Params, unsigned NumParams);
 755   void init(Value *Func, Value *Actual1, Value *Actual2);
 756   void init(Value *Func, Value *Actual);
 757   void init(Value *Func);
 758
 759   template<typename InputIterator>
 760   void init(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
 761             const std::string &Name,
 762             // This argument ensures that we have an iterator we can
 763             // do arithmetic on in constant time
 764             std::random_access_iterator_tag) {
 765     unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
 766
 767     // This requires that the iterator points to contiguous memory.
 768     init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
 769     setName(Name);
 770   }
 771
 772 public:
 773   /// Construct a CallInst given a range of arguments.  InputIterator
 774   /// must be a random-access iterator pointing to contiguous storage
 775   /// (e.g. a std::vector<>::iterator).  Checks are made for
 776   /// random-accessness but not for contiguous storage as that would
 777   /// incur runtime overhead.
 778   /// @brief Construct a CallInst from a range of arguments
 779   template<typename InputIterator>
 780   CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
 781            const std::string &Name = "", Instruction *InsertBefore = 0)
 782       : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
 783                                        ->getElementType())->getReturnType(),
 784                     Instruction::Call, 0, 0, InsertBefore) {
 785     init(Func, ArgBegin, ArgEnd, Name,
 786          typename std::iterator_traits<InputIterator>::iterator_category());
 787   }
 788
 789   /// Construct a CallInst given a range of arguments.  InputIterator
 790   /// must be a random-access iterator pointing to contiguous storage
 791   /// (e.g. a std::vector<>::iterator).  Checks are made for
 792   /// random-accessness but not for contiguous storage as that would
 793   /// incur runtime overhead.
 794   /// @brief Construct a CallInst from a range of arguments
 795   template<typename InputIterator>
 796   CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
 797            const std::string &Name, BasicBlock *InsertAtEnd)
 798       : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
 799                                        ->getElementType())->getReturnType(),
 800                     Instruction::Call, 0, 0, InsertAtEnd) {
 801     init(Func, ArgBegin, ArgEnd, Name,
 802          typename std::iterator_traits<InputIterator>::iterator_category());
 803   }
 804
 805   CallInst(Value *F, Value *Actual, const std::string& Name = "",
 806            Instruction *InsertBefore = 0);
 807   CallInst(Value *F, Value *Actual, const std::string& Name,
 808            BasicBlock *InsertAtEnd);
 809   explicit CallInst(Value *F, const std::string &Name = "",
 810                     Instruction *InsertBefore = 0);
 811   CallInst(Value *F, const std::string &Name, BasicBlock *InsertAtEnd);
 812   ~CallInst();
 813
 814   virtual CallInst *clone() const;
 815
 816   bool isTailCall() const           { return SubclassData & 1; }
 817   void setTailCall(bool isTailCall = true) {
 818     SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
 819   }
 820
 821   /// getCallingConv/setCallingConv - Get or set the calling convention of this
 822   /// function call.
 823   unsigned getCallingConv() const { return SubclassData >> 1; }
 824   void setCallingConv(unsigned CC) {
 825     SubclassData = (SubclassData & 1) | (CC << 1);
 826   }
 827
 828   /// Obtains a pointer to the ParamAttrsList object which holds the
 829   /// parameter attributes information, if any.
 830   /// @returns 0 if no attributes have been set.
 831   /// @brief Get the parameter attributes.
 832   ParamAttrsList *getParamAttrs() const { return ParamAttrs; }
 833
 834   /// Sets the parameter attributes for this CallInst. To construct a
 835   /// ParamAttrsList, see ParameterAttributes.h
 836   /// @brief Set the parameter attributes.
 837   void setParamAttrs(ParamAttrsList *attrs);
 838
 839   /// getCalledFunction - Return the function being called by this instruction
 840   /// if it is a direct call.  If it is a call through a function pointer,
 841   /// return null.
 842   Function *getCalledFunction() const {
 843     return static_cast<Function*>(dyn_cast<Function>(getOperand(0)));
 844   }
 845
 846   /// getCalledValue - Get a pointer to the function that is invoked by this
 847   /// instruction
 848   inline const Value *getCalledValue() const { return getOperand(0); }
 849   inline       Value *getCalledValue()       { return getOperand(0); }
 850
 851   // Methods for support type inquiry through isa, cast, and dyn_cast:
 852   static inline bool classof(const CallInst *) { return true; }
 853   static inline bool classof(const Instruction *I) {
 854     return I->getOpcode() == Instruction::Call;
 855   }
 856   static inline bool classof(const Value *V) {
 857     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 858   }
 859 };
 860
 861 //===----------------------------------------------------------------------===//
 862 //                               SelectInst Class
 863 //===----------------------------------------------------------------------===//
 864
 865 /// SelectInst - This class represents the LLVM 'select' instruction.
 866 ///
 867 class SelectInst : public Instruction {
 868   Use Ops[3];
 869
 870   void init(Value *C, Value *S1, Value *S2) {
 871     Ops[0].init(C, this);
 872     Ops[1].init(S1, this);
 873     Ops[2].init(S2, this);
 874   }
 875
 876   SelectInst(const SelectInst &SI)
 877     : Instruction(SI.getType(), SI.getOpcode(), Ops, 3) {
 878     init(SI.Ops[0], SI.Ops[1], SI.Ops[2]);
 879   }
 880 public:
 881   SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
 882              Instruction *InsertBefore = 0)
 883     : Instruction(S1->getType(), Instruction::Select, Ops, 3, InsertBefore) {
 884     init(C, S1, S2);
 885     setName(Name);
 886   }
 887   SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
 888              BasicBlock *InsertAtEnd)
 889     : Instruction(S1->getType(), Instruction::Select, Ops, 3, InsertAtEnd) {
 890     init(C, S1, S2);
 891     setName(Name);
 892   }
 893
 894   Value *getCondition() const { return Ops[0]; }
 895   Value *getTrueValue() const { return Ops[1]; }
 896   Value *getFalseValue() const { return Ops[2]; }
 897
 898   /// Transparently provide more efficient getOperand methods.
 899   Value *getOperand(unsigned i) const {
 900     assert(i < 3 && "getOperand() out of range!");
 901     return Ops[i];
 902   }
 903   void setOperand(unsigned i, Value *Val) {
 904     assert(i < 3 && "setOperand() out of range!");
 905     Ops[i] = Val;
 906   }
 907   unsigned getNumOperands() const { return 3; }
 908
 909   OtherOps getOpcode() const {
 910     return static_cast<OtherOps>(Instruction::getOpcode());
 911   }
 912
 913   virtual SelectInst *clone() const;
 914
 915   // Methods for support type inquiry through isa, cast, and dyn_cast:
 916   static inline bool classof(const SelectInst *) { return true; }
 917   static inline bool classof(const Instruction *I) {
 918     return I->getOpcode() == Instruction::Select;
 919   }
 920   static inline bool classof(const Value *V) {
 921     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 922   }
 923 };
 924
 925 //===----------------------------------------------------------------------===//
 926 //                                VAArgInst Class
 927 //===----------------------------------------------------------------------===//
 928
 929 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
 930 /// an argument of the specified type given a va_list and increments that list
 931 ///
 932 class VAArgInst : public UnaryInstruction {
 933   VAArgInst(const VAArgInst &VAA)
 934     : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
 935 public:
 936   VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
 937              Instruction *InsertBefore = 0)
 938     : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
 939     setName(Name);
 940   }
 941   VAArgInst(Value *List, const Type *Ty, const std::string &Name,
 942             BasicBlock *InsertAtEnd)
 943     : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
 944     setName(Name);
 945   }
 946
 947   virtual VAArgInst *clone() const;
 948
 949   // Methods for support type inquiry through isa, cast, and dyn_cast:
 950   static inline bool classof(const VAArgInst *) { return true; }
 951   static inline bool classof(const Instruction *I) {
 952     return I->getOpcode() == VAArg;
 953   }
 954   static inline bool classof(const Value *V) {
 955     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 956   }
 957 };
 958
 959 //===----------------------------------------------------------------------===//
 960 //                                ExtractElementInst Class
 961 //===----------------------------------------------------------------------===//
 962
 963 /// ExtractElementInst - This instruction extracts a single (scalar)
 964 /// element from a VectorType value
 965 ///
 966 class ExtractElementInst : public Instruction {
 967   Use Ops[2];
 968   ExtractElementInst(const ExtractElementInst &EE) :
 969     Instruction(EE.getType(), ExtractElement, Ops, 2) {
 970     Ops[0].init(EE.Ops[0], this);
 971     Ops[1].init(EE.Ops[1], this);
 972   }
 973
 974 public:
 975   ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
 976                      Instruction *InsertBefore = 0);
 977   ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name = "",
 978                      Instruction *InsertBefore = 0);
 979   ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
 980                      BasicBlock *InsertAtEnd);
 981   ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name,
 982                      BasicBlock *InsertAtEnd);
 983
 984   /// isValidOperands - Return true if an extractelement instruction can be
 985   /// formed with the specified operands.
 986   static bool isValidOperands(const Value *Vec, const Value *Idx);
 987
 988   virtual ExtractElementInst *clone() const;
 989
 990   /// Transparently provide more efficient getOperand methods.
 991   Value *getOperand(unsigned i) const {
 992     assert(i < 2 && "getOperand() out of range!");
 993     return Ops[i];
 994   }
 995   void setOperand(unsigned i, Value *Val) {
 996     assert(i < 2 && "setOperand() out of range!");
 997     Ops[i] = Val;
 998   }
 999   unsigned getNumOperands() const { return 2; }
1000
1001   // Methods for support type inquiry through isa, cast, and dyn_cast:
1002   static inline bool classof(const ExtractElementInst *) { return true; }
1003   static inline bool classof(const Instruction *I) {
1004     return I->getOpcode() == Instruction::ExtractElement;
1005   }
1006   static inline bool classof(const Value *V) {
1007     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1008   }
1009 };
1010
1011 //===----------------------------------------------------------------------===//
1012 //                                InsertElementInst Class
1013 //===----------------------------------------------------------------------===//
1014
1015 /// InsertElementInst - This instruction inserts a single (scalar)
1016 /// element into a VectorType value
1017 ///
1018 class InsertElementInst : public Instruction {
1019   Use Ops[3];
1020   InsertElementInst(const InsertElementInst &IE);
1021 public:
1022   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1023                     const std::string &Name = "",Instruction *InsertBefore = 0);
1024   InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1025                     const std::string &Name = "",Instruction *InsertBefore = 0);
1026   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1027                     const std::string &Name, BasicBlock *InsertAtEnd);
1028   InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1029                     const std::string &Name, BasicBlock *InsertAtEnd);
1030
1031   /// isValidOperands - Return true if an insertelement instruction can be
1032   /// formed with the specified operands.
1033   static bool isValidOperands(const Value *Vec, const Value *NewElt,
1034                               const Value *Idx);
1035
1036   virtual InsertElementInst *clone() const;
1037
1038   /// getType - Overload to return most specific vector type.
1039   ///
1040   inline const VectorType *getType() const {
1041     return reinterpret_cast<const VectorType*>(Instruction::getType());
1042   }
1043
1044   /// Transparently provide more efficient getOperand methods.
1045   Value *getOperand(unsigned i) const {
1046     assert(i < 3 && "getOperand() out of range!");
1047     return Ops[i];
1048   }
1049   void setOperand(unsigned i, Value *Val) {
1050     assert(i < 3 && "setOperand() out of range!");
1051     Ops[i] = Val;
1052   }
1053   unsigned getNumOperands() const { return 3; }
1054
1055   // Methods for support type inquiry through isa, cast, and dyn_cast:
1056   static inline bool classof(const InsertElementInst *) { return true; }
1057   static inline bool classof(const Instruction *I) {
1058     return I->getOpcode() == Instruction::InsertElement;
1059   }
1060   static inline bool classof(const Value *V) {
1061     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1062   }
1063 };
1064
1065 //===----------------------------------------------------------------------===//
1066 //                           ShuffleVectorInst Class
1067 //===----------------------------------------------------------------------===//
1068
1069 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1070 /// input vectors.
1071 ///
1072 class ShuffleVectorInst : public Instruction {
1073   Use Ops[3];
1074   ShuffleVectorInst(const ShuffleVectorInst &IE);
1075 public:
1076   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1077                     const std::string &Name = "", Instruction *InsertBefor = 0);
1078   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1079                     const std::string &Name, BasicBlock *InsertAtEnd);
1080
1081   /// isValidOperands - Return true if a shufflevector instruction can be
1082   /// formed with the specified operands.
1083   static bool isValidOperands(const Value *V1, const Value *V2,
1084                               const Value *Mask);
1085
1086   virtual ShuffleVectorInst *clone() const;
1087
1088   /// getType - Overload to return most specific vector type.
1089   ///
1090   inline const VectorType *getType() const {
1091     return reinterpret_cast<const VectorType*>(Instruction::getType());
1092   }
1093
1094   /// Transparently provide more efficient getOperand methods.
1095   Value *getOperand(unsigned i) const {
1096     assert(i < 3 && "getOperand() out of range!");
1097     return Ops[i];
1098   }
1099   void setOperand(unsigned i, Value *Val) {
1100     assert(i < 3 && "setOperand() out of range!");
1101     Ops[i] = Val;
1102   }
1103   unsigned getNumOperands() const { return 3; }
1104
1105   // Methods for support type inquiry through isa, cast, and dyn_cast:
1106   static inline bool classof(const ShuffleVectorInst *) { return true; }
1107   static inline bool classof(const Instruction *I) {
1108     return I->getOpcode() == Instruction::ShuffleVector;
1109   }
1110   static inline bool classof(const Value *V) {
1111     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1112   }
1113 };
1114
1115
1116 //===----------------------------------------------------------------------===//
1117 //                               PHINode Class
1118 //===----------------------------------------------------------------------===//
1119
1120 // PHINode - The PHINode class is used to represent the magical mystical PHI
1121 // node, that can not exist in nature, but can be synthesized in a computer
1122 // scientist's overactive imagination.
1123 //
1124 class PHINode : public Instruction {
1125   /// ReservedSpace - The number of operands actually allocated.  NumOperands is
1126   /// the number actually in use.
1127   unsigned ReservedSpace;
1128   PHINode(const PHINode &PN);
1129 public:
1130   explicit PHINode(const Type *Ty, const std::string &Name = "",
1131                    Instruction *InsertBefore = 0)
1132     : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1133       ReservedSpace(0) {
1134     setName(Name);
1135   }
1136
1137   PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
1138     : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1139       ReservedSpace(0) {
1140     setName(Name);
1141   }
1142
1143   ~PHINode();
1144
1145   /// reserveOperandSpace - This method can be used to avoid repeated
1146   /// reallocation of PHI operand lists by reserving space for the correct
1147   /// number of operands before adding them.  Unlike normal vector reserves,
1148   /// this method can also be used to trim the operand space.
1149   void reserveOperandSpace(unsigned NumValues) {
1150     resizeOperands(NumValues*2);
1151   }
1152
1153   virtual PHINode *clone() const;
1154
1155   /// getNumIncomingValues - Return the number of incoming edges
1156   ///
1157   unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1158
1159   /// getIncomingValue - Return incoming value number x
1160   ///
1161   Value *getIncomingValue(unsigned i) const {
1162     assert(i*2 < getNumOperands() && "Invalid value number!");
1163     return getOperand(i*2);
1164   }
1165   void setIncomingValue(unsigned i, Value *V) {
1166     assert(i*2 < getNumOperands() && "Invalid value number!");
1167     setOperand(i*2, V);
1168   }
1169   unsigned getOperandNumForIncomingValue(unsigned i) {
1170     return i*2;
1171   }
1172
1173   /// getIncomingBlock - Return incoming basic block number x
1174   ///
1175   BasicBlock *getIncomingBlock(unsigned i) const {
1176     return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
1177   }
1178   void setIncomingBlock(unsigned i, BasicBlock *BB) {
1179     setOperand(i*2+1, reinterpret_cast<Value*>(BB));
1180   }
1181   unsigned getOperandNumForIncomingBlock(unsigned i) {
1182     return i*2+1;
1183   }
1184
1185   /// addIncoming - Add an incoming value to the end of the PHI list
1186   ///
1187   void addIncoming(Value *V, BasicBlock *BB) {
1188     assert(getType() == V->getType() &&
1189            "All operands to PHI node must be the same type as the PHI node!");
1190     unsigned OpNo = NumOperands;
1191     if (OpNo+2 > ReservedSpace)
1192       resizeOperands(0);  // Get more space!
1193     // Initialize some new operands.
1194     NumOperands = OpNo+2;
1195     OperandList[OpNo].init(V, this);
1196     OperandList[OpNo+1].init(reinterpret_cast<Value*>(BB), this);
1197   }
1198
1199   /// removeIncomingValue - Remove an incoming value.  This is useful if a
1200   /// predecessor basic block is deleted.  The value removed is returned.
1201   ///
1202   /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1203   /// is true), the PHI node is destroyed and any uses of it are replaced with
1204   /// dummy values.  The only time there should be zero incoming values to a PHI
1205   /// node is when the block is dead, so this strategy is sound.
1206   ///
1207   Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1208
1209   Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
1210     int Idx = getBasicBlockIndex(BB);
1211     assert(Idx >= 0 && "Invalid basic block argument to remove!");
1212     return removeIncomingValue(Idx, DeletePHIIfEmpty);
1213   }
1214
1215   /// getBasicBlockIndex - Return the first index of the specified basic
1216   /// block in the value list for this PHI.  Returns -1 if no instance.
1217   ///
1218   int getBasicBlockIndex(const BasicBlock *BB) const {
1219     Use *OL = OperandList;
1220     for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1221       if (OL[i+1] == reinterpret_cast<const Value*>(BB)) return i/2;
1222     return -1;
1223   }
1224
1225   Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1226     return getIncomingValue(getBasicBlockIndex(BB));
1227   }
1228
1229   /// hasConstantValue - If the specified PHI node always merges together the
1230   /// same value, return the value, otherwise return null.
1231   ///
1232   Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1233
1234   /// Methods for support type inquiry through isa, cast, and dyn_cast:
1235   static inline bool classof(const PHINode *) { return true; }
1236   static inline bool classof(const Instruction *I) {
1237     return I->getOpcode() == Instruction::PHI;
1238   }
1239   static inline bool classof(const Value *V) {
1240     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1241   }
1242  private:
1243   void resizeOperands(unsigned NumOperands);
1244 };
1245
1246 //===----------------------------------------------------------------------===//
1247 //                               ReturnInst Class
1248 //===----------------------------------------------------------------------===//
1249
1250 //===---------------------------------------------------------------------------
1251 /// ReturnInst - Return a value (possibly void), from a function.  Execution
1252 /// does not continue in this function any longer.
1253 ///
1254 class ReturnInst : public TerminatorInst {
1255   Use RetVal;  // Return Value: null if 'void'.
1256   ReturnInst(const ReturnInst &RI);
1257   void init(Value *RetVal);
1258
1259 public:
1260   // ReturnInst constructors:
1261   // ReturnInst()                  - 'ret void' instruction
1262   // ReturnInst(    null)          - 'ret void' instruction
1263   // ReturnInst(Value* X)          - 'ret X'    instruction
1264   // ReturnInst(    null, Inst *)  - 'ret void' instruction, insert before I
1265   // ReturnInst(Value* X, Inst *I) - 'ret X'    instruction, insert before I
1266   // ReturnInst(    null, BB *B)   - 'ret void' instruction, insert @ end of BB
1267   // ReturnInst(Value* X, BB *B)   - 'ret X'    instruction, insert @ end of BB
1268   //
1269   // NOTE: If the Value* passed is of type void then the constructor behaves as
1270   // if it was passed NULL.
1271   explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0);
1272   ReturnInst(Value *retVal, BasicBlock *InsertAtEnd);
1273   explicit ReturnInst(BasicBlock *InsertAtEnd);
1274
1275   virtual ReturnInst *clone() const;
1276
1277   // Transparently provide more efficient getOperand methods.
1278   Value *getOperand(unsigned i) const {
1279     assert(i < getNumOperands() && "getOperand() out of range!");
1280     return RetVal;
1281   }
1282   void setOperand(unsigned i, Value *Val) {
1283     assert(i < getNumOperands() && "setOperand() out of range!");
1284     RetVal = Val;
1285   }
1286
1287   Value *getReturnValue() const { return RetVal; }
1288
1289   unsigned getNumSuccessors() const { return 0; }
1290
1291   // Methods for support type inquiry through isa, cast, and dyn_cast:
1292   static inline bool classof(const ReturnInst *) { return true; }
1293   static inline bool classof(const Instruction *I) {
1294     return (I->getOpcode() == Instruction::Ret);
1295   }
1296   static inline bool classof(const Value *V) {
1297     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1298   }
1299  private:
1300   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1301   virtual unsigned getNumSuccessorsV() const;
1302   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1303 };
1304
1305 //===----------------------------------------------------------------------===//
1306 //                               BranchInst Class
1307 //===----------------------------------------------------------------------===//
1308
1309 //===---------------------------------------------------------------------------
1310 /// BranchInst - Conditional or Unconditional Branch instruction.
1311 ///
1312 class BranchInst : public TerminatorInst {
1313   /// Ops list - Branches are strange.  The operands are ordered:
1314   ///  TrueDest, FalseDest, Cond.  This makes some accessors faster because
1315   /// they don't have to check for cond/uncond branchness.
1316   Use Ops[3];
1317   BranchInst(const BranchInst &BI);
1318   void AssertOK();
1319 public:
1320   // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
1321   // BranchInst(BB *B)                           - 'br B'
1322   // BranchInst(BB* T, BB *F, Value *C)          - 'br C, T, F'
1323   // BranchInst(BB* B, Inst *I)                  - 'br B'        insert before I
1324   // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
1325   // BranchInst(BB* B, BB *I)                    - 'br B'        insert at end
1326   // BranchInst(BB* T, BB *F, Value *C, BB *I)   - 'br C, T, F', insert at end
1327   explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
1328   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1329              Instruction *InsertBefore = 0);
1330   BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
1331   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1332              BasicBlock *InsertAtEnd);
1333
1334   /// Transparently provide more efficient getOperand methods.
1335   Value *getOperand(unsigned i) const {
1336     assert(i < getNumOperands() && "getOperand() out of range!");
1337     return Ops[i];
1338   }
1339   void setOperand(unsigned i, Value *Val) {
1340     assert(i < getNumOperands() && "setOperand() out of range!");
1341     Ops[i] = Val;
1342   }
1343
1344   virtual BranchInst *clone() const;
1345
1346   inline bool isUnconditional() const { return getNumOperands() == 1; }
1347   inline bool isConditional()   const { return getNumOperands() == 3; }
1348
1349   inline Value *getCondition() const {
1350     assert(isConditional() && "Cannot get condition of an uncond branch!");
1351     return getOperand(2);
1352   }
1353
1354   void setCondition(Value *V) {
1355     assert(isConditional() && "Cannot set condition of unconditional branch!");
1356     setOperand(2, V);
1357   }
1358
1359   // setUnconditionalDest - Change the current branch to an unconditional branch
1360   // targeting the specified block.
1361   // FIXME: Eliminate this ugly method.
1362   void setUnconditionalDest(BasicBlock *Dest) {
1363     if (isConditional()) {  // Convert this to an uncond branch.
1364       NumOperands = 1;
1365       Ops[1].set(0);
1366       Ops[2].set(0);
1367     }
1368     setOperand(0, reinterpret_cast<Value*>(Dest));
1369   }
1370
1371   unsigned getNumSuccessors() const { return 1+isConditional(); }
1372
1373   BasicBlock *getSuccessor(unsigned i) const {
1374     assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
1375     return cast<BasicBlock>(getOperand(i));
1376   }
1377
1378   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1379     assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
1380     setOperand(idx, reinterpret_cast<Value*>(NewSucc));
1381   }
1382
1383   // Methods for support type inquiry through isa, cast, and dyn_cast:
1384   static inline bool classof(const BranchInst *) { return true; }
1385   static inline bool classof(const Instruction *I) {
1386     return (I->getOpcode() == Instruction::Br);
1387   }
1388   static inline bool classof(const Value *V) {
1389     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1390   }
1391 private:
1392   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1393   virtual unsigned getNumSuccessorsV() const;
1394   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1395 };
1396
1397 //===----------------------------------------------------------------------===//
1398 //                               SwitchInst Class
1399 //===----------------------------------------------------------------------===//
1400
1401 //===---------------------------------------------------------------------------
1402 /// SwitchInst - Multiway switch
1403 ///
1404 class SwitchInst : public TerminatorInst {
1405   unsigned ReservedSpace;
1406   // Operand[0]    = Value to switch on
1407   // Operand[1]    = Default basic block destination
1408   // Operand[2n  ] = Value to match
1409   // Operand[2n+1] = BasicBlock to go to on match
1410   SwitchInst(const SwitchInst &RI);
1411   void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1412   void resizeOperands(unsigned No);
1413 public:
1414   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1415   /// switch on and a default destination.  The number of additional cases can
1416   /// be specified here to make memory allocation more efficient.  This
1417   /// constructor can also autoinsert before another instruction.
1418   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1419              Instruction *InsertBefore = 0);
1420
1421   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1422   /// switch on and a default destination.  The number of additional cases can
1423   /// be specified here to make memory allocation more efficient.  This
1424   /// constructor also autoinserts at the end of the specified BasicBlock.
1425   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1426              BasicBlock *InsertAtEnd);
1427   ~SwitchInst();
1428
1429
1430   // Accessor Methods for Switch stmt
1431   inline Value *getCondition() const { return getOperand(0); }
1432   void setCondition(Value *V) { setOperand(0, V); }
1433
1434   inline BasicBlock *getDefaultDest() const {
1435     return cast<BasicBlock>(getOperand(1));
1436   }
1437
1438   /// getNumCases - return the number of 'cases' in this switch instruction.
1439   /// Note that case #0 is always the default case.
1440   unsigned getNumCases() const {
1441     return getNumOperands()/2;
1442   }
1443
1444   /// getCaseValue - Return the specified case value.  Note that case #0, the
1445   /// default destination, does not have a case value.
1446   ConstantInt *getCaseValue(unsigned i) {
1447     assert(i && i < getNumCases() && "Illegal case value to get!");
1448     return getSuccessorValue(i);
1449   }
1450
1451   /// getCaseValue - Return the specified case value.  Note that case #0, the
1452   /// default destination, does not have a case value.
1453   const ConstantInt *getCaseValue(unsigned i) const {
1454     assert(i && i < getNumCases() && "Illegal case value to get!");
1455     return getSuccessorValue(i);
1456   }
1457
1458   /// findCaseValue - Search all of the case values for the specified constant.
1459   /// If it is explicitly handled, return the case number of it, otherwise
1460   /// return 0 to indicate that it is handled by the default handler.
1461   unsigned findCaseValue(const ConstantInt *C) const {
1462     for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1463       if (getCaseValue(i) == C)
1464         return i;
1465     return 0;
1466   }
1467
1468   /// findCaseDest - Finds the unique case value for a given successor. Returns
1469   /// null if the successor is not found, not unique, or is the default case.
1470   ConstantInt *findCaseDest(BasicBlock *BB) {
1471     if (BB == getDefaultDest()) return NULL;
1472
1473     ConstantInt *CI = NULL;
1474     for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
1475       if (getSuccessor(i) == BB) {
1476         if (CI) return NULL;   // Multiple cases lead to BB.
1477         else CI = getCaseValue(i);
1478       }
1479     }
1480     return CI;
1481   }
1482
1483   /// addCase - Add an entry to the switch instruction...
1484   ///
1485   void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1486
1487   /// removeCase - This method removes the specified successor from the switch
1488   /// instruction.  Note that this cannot be used to remove the default
1489   /// destination (successor #0).
1490   ///
1491   void removeCase(unsigned idx);
1492
1493   virtual SwitchInst *clone() const;
1494
1495   unsigned getNumSuccessors() const { return getNumOperands()/2; }
1496   BasicBlock *getSuccessor(unsigned idx) const {
1497     assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1498     return cast<BasicBlock>(getOperand(idx*2+1));
1499   }
1500   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1501     assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1502     setOperand(idx*2+1, reinterpret_cast<Value*>(NewSucc));
1503   }
1504
1505   // getSuccessorValue - Return the value associated with the specified
1506   // successor.
1507   inline ConstantInt *getSuccessorValue(unsigned idx) const {
1508     assert(idx < getNumSuccessors() && "Successor # out of range!");
1509     return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1510   }
1511
1512   // Methods for support type inquiry through isa, cast, and dyn_cast:
1513   static inline bool classof(const SwitchInst *) { return true; }
1514   static inline bool classof(const Instruction *I) {
1515     return I->getOpcode() == Instruction::Switch;
1516   }
1517   static inline bool classof(const Value *V) {
1518     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1519   }
1520 private:
1521   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1522   virtual unsigned getNumSuccessorsV() const;
1523   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1524 };
1525
1526 //===----------------------------------------------------------------------===//
1527 //                               InvokeInst Class
1528 //===----------------------------------------------------------------------===//
1529
1530 //===---------------------------------------------------------------------------
1531
1532 /// InvokeInst - Invoke instruction.  The SubclassData field is used to hold the
1533 /// calling convention of the call.
1534 ///
1535 class InvokeInst : public TerminatorInst {
1536   ParamAttrsList *ParamAttrs;
1537   InvokeInst(const InvokeInst &BI);
1538   void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1539             Value* const *Args, unsigned NumArgs);
1540
1541   template<typename InputIterator>
1542   void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1543             InputIterator ArgBegin, InputIterator ArgEnd,
1544             const std::string &Name,
1545             // This argument ensures that we have an iterator we can
1546             // do arithmetic on in constant time
1547             std::random_access_iterator_tag) {
1548     unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
1549
1550     // This requires that the iterator points to contiguous memory.
1551     init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
1552     setName(Name);
1553   }
1554
1555 public:
1556   /// Construct an InvokeInst given a range of arguments.
1557   /// InputIterator must be a random-access iterator pointing to
1558   /// contiguous storage (e.g. a std::vector<>::iterator).  Checks are
1559   /// made for random-accessness but not for contiguous storage as
1560   /// that would incur runtime overhead.
1561   ///
1562   /// @brief Construct an InvokeInst from a range of arguments
1563   template<typename InputIterator>
1564   InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1565              InputIterator ArgBegin, InputIterator ArgEnd,
1566              const std::string &Name = "", Instruction *InsertBefore = 0)
1567       : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
1568                                           ->getElementType())->getReturnType(),
1569                        Instruction::Invoke, 0, 0, InsertBefore) {
1570     init(Func, IfNormal, IfException, ArgBegin, ArgEnd, Name,
1571          typename std::iterator_traits<InputIterator>::iterator_category());
1572   }
1573
1574   /// Construct an InvokeInst given a range of arguments.
1575   /// InputIterator must be a random-access iterator pointing to
1576   /// contiguous storage (e.g. a std::vector<>::iterator).  Checks are
1577   /// made for random-accessness but not for contiguous storage as
1578   /// that would incur runtime overhead.
1579   ///
1580   /// @brief Construct an InvokeInst from a range of arguments
1581   template<typename InputIterator>
1582   InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1583              InputIterator ArgBegin, InputIterator ArgEnd,
1584              const std::string &Name, BasicBlock *InsertAtEnd)
1585       : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
1586                                           ->getElementType())->getReturnType(),
1587                        Instruction::Invoke, 0, 0, InsertAtEnd) {
1588     init(Func, IfNormal, IfException, ArgBegin, ArgEnd, Name,
1589          typename std::iterator_traits<InputIterator>::iterator_category());
1590   }
1591
1592   ~InvokeInst();
1593
1594   virtual InvokeInst *clone() const;
1595
1596   /// getCallingConv/setCallingConv - Get or set the calling convention of this
1597   /// function call.
1598   unsigned getCallingConv() const { return SubclassData; }
1599   void setCallingConv(unsigned CC) {
1600     SubclassData = CC;
1601   }
1602
1603   /// Obtains a pointer to the ParamAttrsList object which holds the
1604   /// parameter attributes information, if any.
1605   /// @returns 0 if no attributes have been set.
1606   /// @brief Get the parameter attributes.
1607   ParamAttrsList *getParamAttrs() const { return ParamAttrs; }
1608
1609   /// Sets the parameter attributes for this InvokeInst. To construct a
1610   /// ParamAttrsList, see ParameterAttributes.h
1611   /// @brief Set the parameter attributes.
1612   void setParamAttrs(ParamAttrsList *attrs);
1613
1614   /// getCalledFunction - Return the function called, or null if this is an
1615   /// indirect function invocation.
1616   ///
1617   Function *getCalledFunction() const {
1618     return dyn_cast<Function>(getOperand(0));
1619   }
1620
1621   // getCalledValue - Get a pointer to a function that is invoked by this inst.
1622   inline Value *getCalledValue() const { return getOperand(0); }
1623
1624   // get*Dest - Return the destination basic blocks...
1625   BasicBlock *getNormalDest() const {
1626     return cast<BasicBlock>(getOperand(1));
1627   }
1628   BasicBlock *getUnwindDest() const {
1629     return cast<BasicBlock>(getOperand(2));
1630   }
1631   void setNormalDest(BasicBlock *B) {
1632     setOperand(1, reinterpret_cast<Value*>(B));
1633   }
1634
1635   void setUnwindDest(BasicBlock *B) {
1636     setOperand(2, reinterpret_cast<Value*>(B));
1637   }
1638
1639   inline BasicBlock *getSuccessor(unsigned i) const {
1640     assert(i < 2 && "Successor # out of range for invoke!");
1641     return i == 0 ? getNormalDest() : getUnwindDest();
1642   }
1643
1644   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1645     assert(idx < 2 && "Successor # out of range for invoke!");
1646     setOperand(idx+1, reinterpret_cast<Value*>(NewSucc));
1647   }
1648
1649   unsigned getNumSuccessors() const { return 2; }
1650
1651   // Methods for support type inquiry through isa, cast, and dyn_cast:
1652   static inline bool classof(const InvokeInst *) { return true; }
1653   static inline bool classof(const Instruction *I) {
1654     return (I->getOpcode() == Instruction::Invoke);
1655   }
1656   static inline bool classof(const Value *V) {
1657     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1658   }
1659 private:
1660   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1661   virtual unsigned getNumSuccessorsV() const;
1662   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1663 };
1664
1665
1666 //===----------------------------------------------------------------------===//
1667 //                              UnwindInst Class
1668 //===----------------------------------------------------------------------===//
1669
1670 //===---------------------------------------------------------------------------
1671 /// UnwindInst - Immediately exit the current function, unwinding the stack
1672 /// until an invoke instruction is found.
1673 ///
1674 class UnwindInst : public TerminatorInst {
1675 public:
1676   explicit UnwindInst(Instruction *InsertBefore = 0);
1677   explicit UnwindInst(BasicBlock *InsertAtEnd);
1678
1679   virtual UnwindInst *clone() const;
1680
1681   unsigned getNumSuccessors() const { return 0; }
1682
1683   // Methods for support type inquiry through isa, cast, and dyn_cast:
1684   static inline bool classof(const UnwindInst *) { return true; }
1685   static inline bool classof(const Instruction *I) {
1686     return I->getOpcode() == Instruction::Unwind;
1687   }
1688   static inline bool classof(const Value *V) {
1689     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1690   }
1691 private:
1692   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1693   virtual unsigned getNumSuccessorsV() const;
1694   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1695 };
1696
1697 //===----------------------------------------------------------------------===//
1698 //                           UnreachableInst Class
1699 //===----------------------------------------------------------------------===//
1700
1701 //===---------------------------------------------------------------------------
1702 /// UnreachableInst - This function has undefined behavior.  In particular, the
1703 /// presence of this instruction indicates some higher level knowledge that the
1704 /// end of the block cannot be reached.
1705 ///
1706 class UnreachableInst : public TerminatorInst {
1707 public:
1708   explicit UnreachableInst(Instruction *InsertBefore = 0);
1709   explicit UnreachableInst(BasicBlock *InsertAtEnd);
1710
1711   virtual UnreachableInst *clone() const;
1712
1713   unsigned getNumSuccessors() const { return 0; }
1714
1715   // Methods for support type inquiry through isa, cast, and dyn_cast:
1716   static inline bool classof(const UnreachableInst *) { return true; }
1717   static inline bool classof(const Instruction *I) {
1718     return I->getOpcode() == Instruction::Unreachable;
1719   }
1720   static inline bool classof(const Value *V) {
1721     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1722   }
1723 private:
1724   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1725   virtual unsigned getNumSuccessorsV() const;
1726   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1727 };
1728
1729 //===----------------------------------------------------------------------===//
1730 //                                 TruncInst Class
1731 //===----------------------------------------------------------------------===//
1732
1733 /// @brief This class represents a truncation of integer types.
1734 class TruncInst : public CastInst {
1735   /// Private copy constructor
1736   TruncInst(const TruncInst &CI)
1737     : CastInst(CI.getType(), Trunc, CI.getOperand(0)) {
1738   }
1739 public:
1740   /// @brief Constructor with insert-before-instruction semantics
1741   TruncInst(
1742     Value *S,                     ///< The value to be truncated
1743     const Type *Ty,               ///< The (smaller) type to truncate to
1744     const std::string &Name = "", ///< A name for the new instruction
1745     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1746   );
1747
1748   /// @brief Constructor with insert-at-end-of-block semantics
1749   TruncInst(
1750     Value *S,                     ///< The value to be truncated
1751     const Type *Ty,               ///< The (smaller) type to truncate to
1752     const std::string &Name,      ///< A name for the new instruction
1753     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
1754   );
1755
1756   /// @brief Clone an identical TruncInst
1757   virtual CastInst *clone() const;
1758
1759   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1760   static inline bool classof(const TruncInst *) { return true; }
1761   static inline bool classof(const Instruction *I) {
1762     return I->getOpcode() == Trunc;
1763   }
1764   static inline bool classof(const Value *V) {
1765     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1766   }
1767 };
1768
1769 //===----------------------------------------------------------------------===//
1770 //                                 ZExtInst Class
1771 //===----------------------------------------------------------------------===//
1772
1773 /// @brief This class represents zero extension of integer types.
1774 class ZExtInst : public CastInst {
1775   /// @brief Private copy constructor
1776   ZExtInst(const ZExtInst &CI)
1777     : CastInst(CI.getType(), ZExt, CI.getOperand(0)) {
1778   }
1779 public:
1780   /// @brief Constructor with insert-before-instruction semantics
1781   ZExtInst(
1782     Value *S,                     ///< The value to be zero extended
1783     const Type *Ty,               ///< The type to zero extend to
1784     const std::string &Name = "", ///< A name for the new instruction
1785     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1786   );
1787
1788   /// @brief Constructor with insert-at-end semantics.
1789   ZExtInst(
1790     Value *S,                     ///< The value to be zero extended
1791     const Type *Ty,               ///< The type to zero extend to
1792     const std::string &Name,      ///< A name for the new instruction
1793     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
1794   );
1795
1796   /// @brief Clone an identical ZExtInst
1797   virtual CastInst *clone() const;
1798
1799   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1800   static inline bool classof(const ZExtInst *) { return true; }
1801   static inline bool classof(const Instruction *I) {
1802     return I->getOpcode() == ZExt;
1803   }
1804   static inline bool classof(const Value *V) {
1805     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1806   }
1807 };
1808
1809 //===----------------------------------------------------------------------===//
1810 //                                 SExtInst Class
1811 //===----------------------------------------------------------------------===//
1812
1813 /// @brief This class represents a sign extension of integer types.
1814 class SExtInst : public CastInst {
1815   /// @brief Private copy constructor
1816   SExtInst(const SExtInst &CI)
1817     : CastInst(CI.getType(), SExt, CI.getOperand(0)) {
1818   }
1819 public:
1820   /// @brief Constructor with insert-before-instruction semantics
1821   SExtInst(
1822     Value *S,                     ///< The value to be sign extended
1823     const Type *Ty,               ///< The type to sign extend to
1824     const std::string &Name = "", ///< A name for the new instruction
1825     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1826   );
1827
1828   /// @brief Constructor with insert-at-end-of-block semantics
1829   SExtInst(
1830     Value *S,                     ///< The value to be sign extended
1831     const Type *Ty,               ///< The type to sign extend to
1832     const std::string &Name,      ///< A name for the new instruction
1833     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
1834   );
1835
1836   /// @brief Clone an identical SExtInst
1837   virtual CastInst *clone() const;
1838
1839   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1840   static inline bool classof(const SExtInst *) { return true; }
1841   static inline bool classof(const Instruction *I) {
1842     return I->getOpcode() == SExt;
1843   }
1844   static inline bool classof(const Value *V) {
1845     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1846   }
1847 };
1848
1849 //===----------------------------------------------------------------------===//
1850 //                                 FPTruncInst Class
1851 //===----------------------------------------------------------------------===//
1852
1853 /// @brief This class represents a truncation of floating point types.
1854 class FPTruncInst : public CastInst {
1855   FPTruncInst(const FPTruncInst &CI)
1856     : CastInst(CI.getType(), FPTrunc, CI.getOperand(0)) {
1857   }
1858 public:
1859   /// @brief Constructor with insert-before-instruction semantics
1860   FPTruncInst(
1861     Value *S,                     ///< The value to be truncated
1862     const Type *Ty,               ///< The type to truncate to
1863     const std::string &Name = "", ///< A name for the new instruction
1864     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1865   );
1866
1867   /// @brief Constructor with insert-before-instruction semantics
1868   FPTruncInst(
1869     Value *S,                     ///< The value to be truncated
1870     const Type *Ty,               ///< The type to truncate to
1871     const std::string &Name,      ///< A name for the new instruction
1872     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
1873   );
1874
1875   /// @brief Clone an identical FPTruncInst
1876   virtual CastInst *clone() const;
1877
1878   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1879   static inline bool classof(const FPTruncInst *) { return true; }
1880   static inline bool classof(const Instruction *I) {
1881     return I->getOpcode() == FPTrunc;
1882   }
1883   static inline bool classof(const Value *V) {
1884     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1885   }
1886 };
1887
1888 //===----------------------------------------------------------------------===//
1889 //                                 FPExtInst Class
1890 //===----------------------------------------------------------------------===//
1891
1892 /// @brief This class represents an extension of floating point types.
1893 class FPExtInst : public CastInst {
1894   FPExtInst(const FPExtInst &CI)
1895     : CastInst(CI.getType(), FPExt, CI.getOperand(0)) {
1896   }
1897 public:
1898   /// @brief Constructor with insert-before-instruction semantics
1899   FPExtInst(
1900     Value *S,                     ///< The value to be extended
1901     const Type *Ty,               ///< The type to extend to
1902     const std::string &Name = "", ///< A name for the new instruction
1903     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1904   );
1905
1906   /// @brief Constructor with insert-at-end-of-block semantics
1907   FPExtInst(
1908     Value *S,                     ///< The value to be extended
1909     const Type *Ty,               ///< The type to extend to
1910     const std::string &Name,      ///< A name for the new instruction
1911     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
1912   );
1913
1914   /// @brief Clone an identical FPExtInst
1915   virtual CastInst *clone() const;
1916
1917   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1918   static inline bool classof(const FPExtInst *) { return true; }
1919   static inline bool classof(const Instruction *I) {
1920     return I->getOpcode() == FPExt;
1921   }
1922   static inline bool classof(const Value *V) {
1923     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1924   }
1925 };
1926
1927 //===----------------------------------------------------------------------===//
1928 //                                 UIToFPInst Class
1929 //===----------------------------------------------------------------------===//
1930
1931 /// @brief This class represents a cast unsigned integer to floating point.
1932 class UIToFPInst : public CastInst {
1933   UIToFPInst(const UIToFPInst &CI)
1934     : CastInst(CI.getType(), UIToFP, CI.getOperand(0)) {
1935   }
1936 public:
1937   /// @brief Constructor with insert-before-instruction semantics
1938   UIToFPInst(
1939     Value *S,                     ///< The value to be converted
1940     const Type *Ty,               ///< The type to convert to
1941     const std::string &Name = "", ///< A name for the new instruction
1942     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1943   );
1944
1945   /// @brief Constructor with insert-at-end-of-block semantics
1946   UIToFPInst(
1947     Value *S,                     ///< The value to be converted
1948     const Type *Ty,               ///< The type to convert to
1949     const std::string &Name,      ///< A name for the new instruction
1950     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
1951   );
1952
1953   /// @brief Clone an identical UIToFPInst
1954   virtual CastInst *clone() const;
1955
1956   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1957   static inline bool classof(const UIToFPInst *) { return true; }
1958   static inline bool classof(const Instruction *I) {
1959     return I->getOpcode() == UIToFP;
1960   }
1961   static inline bool classof(const Value *V) {
1962     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1963   }
1964 };
1965
1966 //===----------------------------------------------------------------------===//
1967 //                                 SIToFPInst Class
1968 //===----------------------------------------------------------------------===//
1969
1970 /// @brief This class represents a cast from signed integer to floating point.
1971 class SIToFPInst : public CastInst {
1972   SIToFPInst(const SIToFPInst &CI)
1973     : CastInst(CI.getType(), SIToFP, CI.getOperand(0)) {
1974   }
1975 public:
1976   /// @brief Constructor with insert-before-instruction semantics
1977   SIToFPInst(
1978     Value *S,                     ///< The value to be converted
1979     const Type *Ty,               ///< The type to convert to
1980     const std::string &Name = "", ///< A name for the new instruction
1981     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1982   );
1983
1984   /// @brief Constructor with insert-at-end-of-block semantics
1985   SIToFPInst(
1986     Value *S,                     ///< The value to be converted
1987     const Type *Ty,               ///< The type to convert to
1988     const std::string &Name,      ///< A name for the new instruction
1989     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
1990   );
1991
1992   /// @brief Clone an identical SIToFPInst
1993   virtual CastInst *clone() const;
1994
1995   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1996   static inline bool classof(const SIToFPInst *) { return true; }
1997   static inline bool classof(const Instruction *I) {
1998     return I->getOpcode() == SIToFP;
1999   }
2000   static inline bool classof(const Value *V) {
2001     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2002   }
2003 };
2004
2005 //===----------------------------------------------------------------------===//
2006 //                                 FPToUIInst Class
2007 //===----------------------------------------------------------------------===//
2008
2009 /// @brief This class represents a cast from floating point to unsigned integer
2010 class FPToUIInst  : public CastInst {
2011   FPToUIInst(const FPToUIInst &CI)
2012     : CastInst(CI.getType(), FPToUI, CI.getOperand(0)) {
2013   }
2014 public:
2015   /// @brief Constructor with insert-before-instruction semantics
2016   FPToUIInst(
2017     Value *S,                     ///< The value to be converted
2018     const Type *Ty,               ///< The type to convert to
2019     const std::string &Name = "", ///< A name for the new instruction
2020     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2021   );
2022
2023   /// @brief Constructor with insert-at-end-of-block semantics
2024   FPToUIInst(
2025     Value *S,                     ///< The value to be converted
2026     const Type *Ty,               ///< The type to convert to
2027     const std::string &Name,      ///< A name for the new instruction
2028     BasicBlock *InsertAtEnd       ///< Where to insert the new instruction
2029   );
2030
2031   /// @brief Clone an identical FPToUIInst
2032   virtual CastInst *clone() const;
2033
2034   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2035   static inline bool classof(const FPToUIInst *) { return true; }
2036   static inline bool classof(const Instruction *I) {
2037     return I->getOpcode() == FPToUI;
2038   }
2039   static inline bool classof(const Value *V) {
2040     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2041   }
2042 };
2043
2044 //===----------------------------------------------------------------------===//
2045 //                                 FPToSIInst Class
2046 //===----------------------------------------------------------------------===//
2047
2048 /// @brief This class represents a cast from floating point to signed integer.
2049 class FPToSIInst  : public CastInst {
2050   FPToSIInst(const FPToSIInst &CI)
2051     : CastInst(CI.getType(), FPToSI, CI.getOperand(0)) {
2052   }
2053 public:
2054   /// @brief Constructor with insert-before-instruction semantics
2055   FPToSIInst(
2056     Value *S,                     ///< The value to be converted
2057     const Type *Ty,               ///< The type to convert to
2058     const std::string &Name = "", ///< A name for the new instruction
2059     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2060   );
2061
2062   /// @brief Constructor with insert-at-end-of-block semantics
2063   FPToSIInst(
2064     Value *S,                     ///< The value to be converted
2065     const Type *Ty,               ///< The type to convert to
2066     const std::string &Name,      ///< A name for the new instruction
2067     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2068   );
2069
2070   /// @brief Clone an identical FPToSIInst
2071   virtual CastInst *clone() const;
2072
2073   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2074   static inline bool classof(const FPToSIInst *) { return true; }
2075   static inline bool classof(const Instruction *I) {
2076     return I->getOpcode() == FPToSI;
2077   }
2078   static inline bool classof(const Value *V) {
2079     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2080   }
2081 };
2082
2083 //===----------------------------------------------------------------------===//
2084 //                                 IntToPtrInst Class
2085 //===----------------------------------------------------------------------===//
2086
2087 /// @brief This class represents a cast from an integer to a pointer.
2088 class IntToPtrInst : public CastInst {
2089   IntToPtrInst(const IntToPtrInst &CI)
2090     : CastInst(CI.getType(), IntToPtr, CI.getOperand(0)) {
2091   }
2092 public:
2093   /// @brief Constructor with insert-before-instruction semantics
2094   IntToPtrInst(
2095     Value *S,                     ///< The value to be converted
2096     const Type *Ty,               ///< The type to convert to
2097     const std::string &Name = "", ///< A name for the new instruction
2098     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2099   );
2100
2101   /// @brief Constructor with insert-at-end-of-block semantics
2102   IntToPtrInst(
2103     Value *S,                     ///< The value to be converted
2104     const Type *Ty,               ///< The type to convert to
2105     const std::string &Name,      ///< A name for the new instruction
2106     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2107   );
2108
2109   /// @brief Clone an identical IntToPtrInst
2110   virtual CastInst *clone() const;
2111
2112   // Methods for support type inquiry through isa, cast, and dyn_cast:
2113   static inline bool classof(const IntToPtrInst *) { return true; }
2114   static inline bool classof(const Instruction *I) {
2115     return I->getOpcode() == IntToPtr;
2116   }
2117   static inline bool classof(const Value *V) {
2118     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2119   }
2120 };
2121
2122 //===----------------------------------------------------------------------===//
2123 //                                 PtrToIntInst Class
2124 //===----------------------------------------------------------------------===//
2125
2126 /// @brief This class represents a cast from a pointer to an integer
2127 class PtrToIntInst : public CastInst {
2128   PtrToIntInst(const PtrToIntInst &CI)
2129     : CastInst(CI.getType(), PtrToInt, CI.getOperand(0)) {
2130   }
2131 public:
2132   /// @brief Constructor with insert-before-instruction semantics
2133   PtrToIntInst(
2134     Value *S,                     ///< The value to be converted
2135     const Type *Ty,               ///< The type to convert to
2136     const std::string &Name = "", ///< A name for the new instruction
2137     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2138   );
2139
2140   /// @brief Constructor with insert-at-end-of-block semantics
2141   PtrToIntInst(
2142     Value *S,                     ///< The value to be converted
2143     const Type *Ty,               ///< The type to convert to
2144     const std::string &Name,      ///< A name for the new instruction
2145     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2146   );
2147
2148   /// @brief Clone an identical PtrToIntInst
2149   virtual CastInst *clone() const;
2150
2151   // Methods for support type inquiry through isa, cast, and dyn_cast:
2152   static inline bool classof(const PtrToIntInst *) { return true; }
2153   static inline bool classof(const Instruction *I) {
2154     return I->getOpcode() == PtrToInt;
2155   }
2156   static inline bool classof(const Value *V) {
2157     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2158   }
2159 };
2160
2161 //===----------------------------------------------------------------------===//
2162 //                             BitCastInst Class
2163 //===----------------------------------------------------------------------===//
2164
2165 /// @brief This class represents a no-op cast from one type to another.
2166 class BitCastInst : public CastInst {
2167   BitCastInst(const BitCastInst &CI)
2168     : CastInst(CI.getType(), BitCast, CI.getOperand(0)) {
2169   }
2170 public:
2171   /// @brief Constructor with insert-before-instruction semantics
2172   BitCastInst(
2173     Value *S,                     ///< The value to be casted
2174     const Type *Ty,               ///< The type to casted to
2175     const std::string &Name = "", ///< A name for the new instruction
2176     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2177   );
2178
2179   /// @brief Constructor with insert-at-end-of-block semantics
2180   BitCastInst(
2181     Value *S,                     ///< The value to be casted
2182     const Type *Ty,               ///< The type to casted to
2183     const std::string &Name,      ///< A name for the new instruction
2184     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2185   );
2186
2187   /// @brief Clone an identical BitCastInst
2188   virtual CastInst *clone() const;
2189
2190   // Methods for support type inquiry through isa, cast, and dyn_cast:
2191   static inline bool classof(const BitCastInst *) { return true; }
2192   static inline bool classof(const Instruction *I) {
2193     return I->getOpcode() == BitCast;
2194   }
2195   static inline bool classof(const Value *V) {
2196     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2197   }
2198 };
2199
2200 } // End llvm namespace
2201
2202 #endif