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