include/llvm/Instructions.h

   1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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 #include "llvm/BasicBlock.h"
  25 #include "llvm/ADT/SmallVector.h"
  26
  27 namespace llvm {
  28
  29 class ConstantInt;
  30 class PointerType;
  31 class VectorType;
  32 class ConstantRange;
  33 class APInt;
  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 protected:
  44   AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
  45                  const std::string &Name = "", Instruction *InsertBefore = 0);
  46   AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
  47                  const std::string &Name, BasicBlock *InsertAtEnd);
  48 public:
  49   // Out of line virtual method, so the vtable, etc. has a home.
  50   virtual ~AllocationInst();
  51
  52   /// isArrayAllocation - Return true if there is an allocation size parameter
  53   /// to the allocation instruction that is not 1.
  54   ///
  55   bool isArrayAllocation() const;
  56
  57   /// getArraySize - Get the number of element allocated, for a simple
  58   /// allocation of a single element, this will return a constant 1 value.
  59   ///
  60   const Value *getArraySize() const { return getOperand(0); }
  61   Value *getArraySize() { return getOperand(0); }
  62
  63   /// getType - Overload to return most specific pointer type
  64   ///
  65   const PointerType *getType() const {
  66     return reinterpret_cast<const PointerType*>(Instruction::getType());
  67   }
  68
  69   /// getAllocatedType - Return the type that is being allocated by the
  70   /// instruction.
  71   ///
  72   const Type *getAllocatedType() const;
  73
  74   /// getAlignment - Return the alignment of the memory that is being allocated
  75   /// by the instruction.
  76   ///
  77   unsigned getAlignment() const { return (1u << SubclassData) >> 1; }
  78   void setAlignment(unsigned Align);
  79
  80   virtual Instruction *clone() const = 0;
  81
  82   // Methods for support type inquiry through isa, cast, and dyn_cast:
  83   static inline bool classof(const AllocationInst *) { return true; }
  84   static inline bool classof(const Instruction *I) {
  85     return I->getOpcode() == Instruction::Alloca ||
  86            I->getOpcode() == Instruction::Malloc;
  87   }
  88   static inline bool classof(const Value *V) {
  89     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  90   }
  91 };
  92
  93
  94 //===----------------------------------------------------------------------===//
  95 //                                MallocInst Class
  96 //===----------------------------------------------------------------------===//
  97
  98 /// MallocInst - an instruction to allocated memory on the heap
  99 ///
 100 class MallocInst : public AllocationInst {
 101   MallocInst(const MallocInst &MI);
 102 public:
 103   explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
 104                       const std::string &Name = "",
 105                       Instruction *InsertBefore = 0)
 106     : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
 107   MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
 108              BasicBlock *InsertAtEnd)
 109     : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
 110
 111   MallocInst(const Type *Ty, const std::string &Name,
 112              Instruction *InsertBefore = 0)
 113     : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
 114   MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
 115     : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
 116
 117   MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
 118              const std::string &Name, BasicBlock *InsertAtEnd)
 119     : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
 120   MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
 121                       const std::string &Name = "",
 122                       Instruction *InsertBefore = 0)
 123     : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
 124
 125   virtual MallocInst *clone() const;
 126
 127   // Methods for support type inquiry through isa, cast, and dyn_cast:
 128   static inline bool classof(const MallocInst *) { return true; }
 129   static inline bool classof(const Instruction *I) {
 130     return (I->getOpcode() == Instruction::Malloc);
 131   }
 132   static inline bool classof(const Value *V) {
 133     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 134   }
 135 };
 136
 137
 138 //===----------------------------------------------------------------------===//
 139 //                                AllocaInst Class
 140 //===----------------------------------------------------------------------===//
 141
 142 /// AllocaInst - an instruction to allocate memory on the stack
 143 ///
 144 class AllocaInst : public AllocationInst {
 145   AllocaInst(const AllocaInst &);
 146 public:
 147   explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
 148                       const std::string &Name = "",
 149                       Instruction *InsertBefore = 0)
 150     : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
 151   AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
 152              BasicBlock *InsertAtEnd)
 153     : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
 154
 155   AllocaInst(const Type *Ty, const std::string &Name,
 156              Instruction *InsertBefore = 0)
 157     : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
 158   AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
 159     : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
 160
 161   AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
 162              const std::string &Name = "", Instruction *InsertBefore = 0)
 163     : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
 164   AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
 165              const std::string &Name, BasicBlock *InsertAtEnd)
 166     : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
 167
 168   virtual AllocaInst *clone() const;
 169
 170   // Methods for support type inquiry through isa, cast, and dyn_cast:
 171   static inline bool classof(const AllocaInst *) { return true; }
 172   static inline bool classof(const Instruction *I) {
 173     return (I->getOpcode() == Instruction::Alloca);
 174   }
 175   static inline bool classof(const Value *V) {
 176     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 177   }
 178 };
 179
 180
 181 //===----------------------------------------------------------------------===//
 182 //                                 FreeInst Class
 183 //===----------------------------------------------------------------------===//
 184
 185 /// FreeInst - an instruction to deallocate memory
 186 ///
 187 class FreeInst : public UnaryInstruction {
 188   void AssertOK();
 189 public:
 190   explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
 191   FreeInst(Value *Ptr, BasicBlock *InsertAfter);
 192
 193   virtual FreeInst *clone() const;
 194
 195   // Accessor methods for consistency with other memory operations
 196   Value *getPointerOperand() { return getOperand(0); }
 197   const Value *getPointerOperand() const { return getOperand(0); }
 198
 199   // Methods for support type inquiry through isa, cast, and dyn_cast:
 200   static inline bool classof(const FreeInst *) { return true; }
 201   static inline bool classof(const Instruction *I) {
 202     return (I->getOpcode() == Instruction::Free);
 203   }
 204   static inline bool classof(const Value *V) {
 205     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 206   }
 207 };
 208
 209
 210 //===----------------------------------------------------------------------===//
 211 //                                LoadInst Class
 212 //===----------------------------------------------------------------------===//
 213
 214 /// LoadInst - an instruction for reading from memory.  This uses the
 215 /// SubclassData field in Value to store whether or not the load is volatile.
 216 ///
 217 class LoadInst : public UnaryInstruction {
 218
 219   LoadInst(const LoadInst &LI)
 220     : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
 221     setVolatile(LI.isVolatile());
 222     setAlignment(LI.getAlignment());
 223
 224 #ifndef NDEBUG
 225     AssertOK();
 226 #endif
 227   }
 228   void AssertOK();
 229 public:
 230   LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
 231   LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
 232   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile = false,
 233            Instruction *InsertBefore = 0);
 234   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
 235            Instruction *InsertBefore = 0);
 236   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
 237            BasicBlock *InsertAtEnd);
 238   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
 239            BasicBlock *InsertAtEnd);
 240
 241   LoadInst(Value *Ptr, const char *Name, Instruction *InsertBefore);
 242   LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAtEnd);
 243   explicit LoadInst(Value *Ptr, const char *Name = 0, bool isVolatile = false,
 244                     Instruction *InsertBefore = 0);
 245   LoadInst(Value *Ptr, const char *Name, bool isVolatile,
 246            BasicBlock *InsertAtEnd);
 247
 248   /// isVolatile - Return true if this is a load from a volatile memory
 249   /// location.
 250   ///
 251   bool isVolatile() const { return SubclassData & 1; }
 252
 253   /// setVolatile - Specify whether this is a volatile load or not.
 254   ///
 255   void setVolatile(bool V) {
 256     SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
 257   }
 258
 259   virtual LoadInst *clone() const;
 260
 261   /// getAlignment - Return the alignment of the access that is being performed
 262   ///
 263   unsigned getAlignment() const {
 264     return (1 << (SubclassData>>1)) >> 1;
 265   }
 266
 267   void setAlignment(unsigned Align);
 268
 269   Value *getPointerOperand() { return getOperand(0); }
 270   const Value *getPointerOperand() const { return getOperand(0); }
 271   static unsigned getPointerOperandIndex() { return 0U; }
 272
 273   // Methods for support type inquiry through isa, cast, and dyn_cast:
 274   static inline bool classof(const LoadInst *) { return true; }
 275   static inline bool classof(const Instruction *I) {
 276     return I->getOpcode() == Instruction::Load;
 277   }
 278   static inline bool classof(const Value *V) {
 279     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 280   }
 281 };
 282
 283
 284 //===----------------------------------------------------------------------===//
 285 //                                StoreInst Class
 286 //===----------------------------------------------------------------------===//
 287
 288 /// StoreInst - an instruction for storing to memory
 289 ///
 290 class StoreInst : public Instruction {
 291   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
 292
 293   StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store,
 294                                                &Op<0>(), 2) {
 295     Op<0>() = SI.Op<0>();
 296     Op<1>() = SI.Op<1>();
 297     setVolatile(SI.isVolatile());
 298     setAlignment(SI.getAlignment());
 299
 300 #ifndef NDEBUG
 301     AssertOK();
 302 #endif
 303   }
 304   void AssertOK();
 305 public:
 306   // allocate space for exactly two operands
 307   void *operator new(size_t s) {
 308     return User::operator new(s, 2);
 309   }
 310   StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
 311   StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
 312   StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
 313             Instruction *InsertBefore = 0);
 314   StoreInst(Value *Val, Value *Ptr, bool isVolatile,
 315             unsigned Align, Instruction *InsertBefore = 0);
 316   StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
 317   StoreInst(Value *Val, Value *Ptr, bool isVolatile,
 318             unsigned Align, BasicBlock *InsertAtEnd);
 319
 320
 321   /// isVolatile - Return true if this is a load from a volatile memory
 322   /// location.
 323   ///
 324   bool isVolatile() const { return SubclassData & 1; }
 325
 326   /// setVolatile - Specify whether this is a volatile load or not.
 327   ///
 328   void setVolatile(bool V) {
 329     SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
 330   }
 331
 332   /// Transparently provide more efficient getOperand methods.
 333   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 334
 335   /// getAlignment - Return the alignment of the access that is being performed
 336   ///
 337   unsigned getAlignment() const {
 338     return (1 << (SubclassData>>1)) >> 1;
 339   }
 340
 341   void setAlignment(unsigned Align);
 342
 343   virtual StoreInst *clone() const;
 344
 345   Value *getPointerOperand() { return getOperand(1); }
 346   const Value *getPointerOperand() const { return getOperand(1); }
 347   static unsigned getPointerOperandIndex() { return 1U; }
 348
 349   // Methods for support type inquiry through isa, cast, and dyn_cast:
 350   static inline bool classof(const StoreInst *) { return true; }
 351   static inline bool classof(const Instruction *I) {
 352     return I->getOpcode() == Instruction::Store;
 353   }
 354   static inline bool classof(const Value *V) {
 355     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 356   }
 357 };
 358
 359 template <>
 360 struct OperandTraits<StoreInst> : FixedNumOperandTraits<2> {
 361 };
 362
 363 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
 364
 365 //===----------------------------------------------------------------------===//
 366 //                             GetElementPtrInst Class
 367 //===----------------------------------------------------------------------===//
 368
 369 // checkType - Simple wrapper function to give a better assertion failure
 370 // message on bad indexes for a gep instruction.
 371 //
 372 static inline const Type *checkType(const Type *Ty) {
 373   assert(Ty && "Invalid GetElementPtrInst indices for type!");
 374   return Ty;
 375 }
 376
 377 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
 378 /// access elements of arrays and structs
 379 ///
 380 class GetElementPtrInst : public Instruction {
 381   GetElementPtrInst(const GetElementPtrInst &GEPI);
 382   void init(Value *Ptr, Value* const *Idx, unsigned NumIdx,
 383             const std::string &Name);
 384   void init(Value *Ptr, Value *Idx, const std::string &Name);
 385
 386   template<typename InputIterator>
 387   void init(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
 388             const std::string &Name,
 389             // This argument ensures that we have an iterator we can
 390             // do arithmetic on in constant time
 391             std::random_access_iterator_tag) {
 392     unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
 393
 394     if (NumIdx > 0) {
 395       // This requires that the iterator points to contiguous memory.
 396       init(Ptr, &*IdxBegin, NumIdx, Name); // FIXME: for the general case
 397                                      // we have to build an array here
 398     }
 399     else {
 400       init(Ptr, 0, NumIdx, Name);
 401     }
 402   }
 403
 404   /// getIndexedType - Returns the type of the element that would be loaded with
 405   /// a load instruction with the specified parameters.
 406   ///
 407   /// Null is returned if the indices are invalid for the specified
 408   /// pointer type.
 409   ///
 410   static const Type *getIndexedType(const Type *Ptr,
 411                                     Value* const *Idx, unsigned NumIdx);
 412
 413   template<typename InputIterator>
 414   static const Type *getIndexedType(const Type *Ptr,
 415                                     InputIterator IdxBegin,
 416                                     InputIterator IdxEnd,
 417                                     // This argument ensures that we
 418                                     // have an iterator we can do
 419                                     // arithmetic on in constant time
 420                                     std::random_access_iterator_tag) {
 421     unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
 422
 423     if (NumIdx > 0)
 424       // This requires that the iterator points to contiguous memory.
 425       return getIndexedType(Ptr, (Value *const *)&*IdxBegin, NumIdx);
 426     else
 427       return getIndexedType(Ptr, (Value *const*)0, NumIdx);
 428   }
 429
 430   /// Constructors - Create a getelementptr instruction with a base pointer an
 431   /// list of indices.  The first ctor can optionally insert before an existing
 432   /// instruction, the second appends the new instruction to the specified
 433   /// BasicBlock.
 434   template<typename InputIterator>
 435   inline GetElementPtrInst(Value *Ptr, InputIterator IdxBegin,
 436                            InputIterator IdxEnd,
 437                            unsigned Values,
 438                            const std::string &Name,
 439                            Instruction *InsertBefore);
 440   template<typename InputIterator>
 441   inline GetElementPtrInst(Value *Ptr,
 442                            InputIterator IdxBegin, InputIterator IdxEnd,
 443                            unsigned Values,
 444                            const std::string &Name, BasicBlock *InsertAtEnd);
 445
 446   /// Constructors - These two constructors are convenience methods because one
 447   /// and two index getelementptr instructions are so common.
 448   GetElementPtrInst(Value *Ptr, Value *Idx, const std::string &Name = "",
 449                     Instruction *InsertBefore = 0);
 450   GetElementPtrInst(Value *Ptr, Value *Idx,
 451                     const std::string &Name, BasicBlock *InsertAtEnd);
 452 public:
 453   template<typename InputIterator>
 454   static GetElementPtrInst *Create(Value *Ptr, InputIterator IdxBegin,
 455                                    InputIterator IdxEnd,
 456                                    const std::string &Name = "",
 457                                    Instruction *InsertBefore = 0) {
 458     typename std::iterator_traits<InputIterator>::difference_type Values =
 459       1 + std::distance(IdxBegin, IdxEnd);
 460     return new(Values)
 461       GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, Name, InsertBefore);
 462   }
 463   template<typename InputIterator>
 464   static GetElementPtrInst *Create(Value *Ptr,
 465                                    InputIterator IdxBegin, InputIterator IdxEnd,
 466                                    const std::string &Name,
 467                                    BasicBlock *InsertAtEnd) {
 468     typename std::iterator_traits<InputIterator>::difference_type Values =
 469       1 + std::distance(IdxBegin, IdxEnd);
 470     return new(Values)
 471       GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, Name, InsertAtEnd);
 472   }
 473
 474   /// Constructors - These two creators are convenience methods because one
 475   /// index getelementptr instructions are so common.
 476   static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
 477                                    const std::string &Name = "",
 478                                    Instruction *InsertBefore = 0) {
 479     return new(2) GetElementPtrInst(Ptr, Idx, Name, InsertBefore);
 480   }
 481   static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
 482                                    const std::string &Name,
 483                                    BasicBlock *InsertAtEnd) {
 484     return new(2) GetElementPtrInst(Ptr, Idx, Name, InsertAtEnd);
 485   }
 486
 487   virtual GetElementPtrInst *clone() const;
 488
 489   /// Transparently provide more efficient getOperand methods.
 490   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 491
 492   // getType - Overload to return most specific pointer type...
 493   const PointerType *getType() const {
 494     return reinterpret_cast<const PointerType*>(Instruction::getType());
 495   }
 496
 497   /// getIndexedType - Returns the type of the element that would be loaded with
 498   /// a load instruction with the specified parameters.
 499   ///
 500   /// Null is returned if the indices are invalid for the specified
 501   /// pointer type.
 502   ///
 503   template<typename InputIterator>
 504   static const Type *getIndexedType(const Type *Ptr,
 505                                     InputIterator IdxBegin,
 506                                     InputIterator IdxEnd) {
 507     return getIndexedType(Ptr, IdxBegin, IdxEnd,
 508                           typename std::iterator_traits<InputIterator>::
 509                           iterator_category());
 510   }
 511   static const Type *getIndexedType(const Type *Ptr, Value *Idx);
 512
 513   inline op_iterator       idx_begin()       { return op_begin()+1; }
 514   inline const_op_iterator idx_begin() const { return op_begin()+1; }
 515   inline op_iterator       idx_end()         { return op_end(); }
 516   inline const_op_iterator idx_end()   const { return op_end(); }
 517
 518   Value *getPointerOperand() {
 519     return getOperand(0);
 520   }
 521   const Value *getPointerOperand() const {
 522     return getOperand(0);
 523   }
 524   static unsigned getPointerOperandIndex() {
 525     return 0U;                      // get index for modifying correct operand
 526   }
 527
 528   unsigned getNumIndices() const {  // Note: always non-negative
 529     return getNumOperands() - 1;
 530   }
 531
 532   bool hasIndices() const {
 533     return getNumOperands() > 1;
 534   }
 535
 536   /// hasAllZeroIndices - Return true if all of the indices of this GEP are
 537   /// zeros.  If so, the result pointer and the first operand have the same
 538   /// value, just potentially different types.
 539   bool hasAllZeroIndices() const;
 540
 541   /// hasAllConstantIndices - Return true if all of the indices of this GEP are
 542   /// constant integers.  If so, the result pointer and the first operand have
 543   /// a constant offset between them.
 544   bool hasAllConstantIndices() const;
 545
 546
 547   // Methods for support type inquiry through isa, cast, and dyn_cast:
 548   static inline bool classof(const GetElementPtrInst *) { return true; }
 549   static inline bool classof(const Instruction *I) {
 550     return (I->getOpcode() == Instruction::GetElementPtr);
 551   }
 552   static inline bool classof(const Value *V) {
 553     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 554   }
 555 };
 556
 557 template <>
 558 struct OperandTraits<GetElementPtrInst> : VariadicOperandTraits<1> {
 559 };
 560
 561 template<typename InputIterator>
 562 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
 563                                      InputIterator IdxBegin,
 564                                      InputIterator IdxEnd,
 565                                      unsigned Values,
 566                                      const std::string &Name,
 567                                      Instruction *InsertBefore)
 568   : Instruction(PointerType::get(checkType(
 569                                    getIndexedType(Ptr->getType(),
 570                                                   IdxBegin, IdxEnd)),
 571                                  cast<PointerType>(Ptr->getType())
 572                                    ->getAddressSpace()),
 573                 GetElementPtr,
 574                 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
 575                 Values, InsertBefore) {
 576   init(Ptr, IdxBegin, IdxEnd, Name,
 577        typename std::iterator_traits<InputIterator>::iterator_category());
 578 }
 579 template<typename InputIterator>
 580 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
 581                                      InputIterator IdxBegin,
 582                                      InputIterator IdxEnd,
 583                                      unsigned Values,
 584                                      const std::string &Name,
 585                                      BasicBlock *InsertAtEnd)
 586   : Instruction(PointerType::get(checkType(
 587                                    getIndexedType(Ptr->getType(),
 588                                                   IdxBegin, IdxEnd)),
 589                                  cast<PointerType>(Ptr->getType())
 590                                    ->getAddressSpace()),
 591                 GetElementPtr,
 592                 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
 593                 Values, InsertAtEnd) {
 594   init(Ptr, IdxBegin, IdxEnd, Name,
 595        typename std::iterator_traits<InputIterator>::iterator_category());
 596 }
 597
 598
 599 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
 600
 601
 602 //===----------------------------------------------------------------------===//
 603 //                               ICmpInst Class
 604 //===----------------------------------------------------------------------===//
 605
 606 /// This instruction compares its operands according to the predicate given
 607 /// to the constructor. It only operates on integers or pointers. The operands
 608 /// must be identical types.
 609 /// @brief Represent an integer comparison operator.
 610 class ICmpInst: public CmpInst {
 611 public:
 612   /// @brief Constructor with insert-before-instruction semantics.
 613   ICmpInst(
 614     Predicate pred,  ///< The predicate to use for the comparison
 615     Value *LHS,      ///< The left-hand-side of the expression
 616     Value *RHS,      ///< The right-hand-side of the expression
 617     const std::string &Name = "",  ///< Name of the instruction
 618     Instruction *InsertBefore = 0  ///< Where to insert
 619   ) : CmpInst(Type::Int1Ty, Instruction::ICmp, pred, LHS, RHS, Name,
 620               InsertBefore) {
 621     assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
 622            pred <= CmpInst::LAST_ICMP_PREDICATE &&
 623            "Invalid ICmp predicate value");
 624     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
 625           "Both operands to ICmp instruction are not of the same type!");
 626     // Check that the operands are the right type
 627     assert((getOperand(0)->getType()->isInteger() ||
 628             isa<PointerType>(getOperand(0)->getType())) &&
 629            "Invalid operand types for ICmp instruction");
 630   }
 631
 632   /// @brief Constructor with insert-at-block-end semantics.
 633   ICmpInst(
 634     Predicate pred, ///< The predicate to use for the comparison
 635     Value *LHS,     ///< The left-hand-side of the expression
 636     Value *RHS,     ///< The right-hand-side of the expression
 637     const std::string &Name,  ///< Name of the instruction
 638     BasicBlock *InsertAtEnd   ///< Block to insert into.
 639   ) : CmpInst(Type::Int1Ty, Instruction::ICmp, pred, LHS, RHS, Name,
 640               InsertAtEnd) {
 641     assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
 642            pred <= CmpInst::LAST_ICMP_PREDICATE &&
 643            "Invalid ICmp predicate value");
 644     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
 645           "Both operands to ICmp instruction are not of the same type!");
 646     // Check that the operands are the right type
 647     assert((getOperand(0)->getType()->isInteger() ||
 648             isa<PointerType>(getOperand(0)->getType())) &&
 649            "Invalid operand types for ICmp instruction");
 650   }
 651
 652   /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
 653   /// @returns the predicate that would be the result if the operand were
 654   /// regarded as signed.
 655   /// @brief Return the signed version of the predicate
 656   Predicate getSignedPredicate() const {
 657     return getSignedPredicate(getPredicate());
 658   }
 659
 660   /// This is a static version that you can use without an instruction.
 661   /// @brief Return the signed version of the predicate.
 662   static Predicate getSignedPredicate(Predicate pred);
 663
 664   /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
 665   /// @returns the predicate that would be the result if the operand were
 666   /// regarded as unsigned.
 667   /// @brief Return the unsigned version of the predicate
 668   Predicate getUnsignedPredicate() const {
 669     return getUnsignedPredicate(getPredicate());
 670   }
 671
 672   /// This is a static version that you can use without an instruction.
 673   /// @brief Return the unsigned version of the predicate.
 674   static Predicate getUnsignedPredicate(Predicate pred);
 675
 676   /// isEquality - Return true if this predicate is either EQ or NE.  This also
 677   /// tests for commutativity.
 678   static bool isEquality(Predicate P) {
 679     return P == ICMP_EQ || P == ICMP_NE;
 680   }
 681
 682   /// isEquality - Return true if this predicate is either EQ or NE.  This also
 683   /// tests for commutativity.
 684   bool isEquality() const {
 685     return isEquality(getPredicate());
 686   }
 687
 688   /// @returns true if the predicate of this ICmpInst is commutative
 689   /// @brief Determine if this relation is commutative.
 690   bool isCommutative() const { return isEquality(); }
 691
 692   /// isRelational - Return true if the predicate is relational (not EQ or NE).
 693   ///
 694   bool isRelational() const {
 695     return !isEquality();
 696   }
 697
 698   /// isRelational - Return true if the predicate is relational (not EQ or NE).
 699   ///
 700   static bool isRelational(Predicate P) {
 701     return !isEquality(P);
 702   }
 703
 704   /// @returns true if the predicate of this ICmpInst is signed, false otherwise
 705   /// @brief Determine if this instruction's predicate is signed.
 706   bool isSignedPredicate() const { return isSignedPredicate(getPredicate()); }
 707
 708   /// @returns true if the predicate provided is signed, false otherwise
 709   /// @brief Determine if the predicate is signed.
 710   static bool isSignedPredicate(Predicate pred);
 711
 712   /// @returns true if the specified compare predicate is
 713   /// true when both operands are equal...
 714   /// @brief Determine if the icmp is true when both operands are equal
 715   static bool isTrueWhenEqual(ICmpInst::Predicate pred) {
 716     return pred == ICmpInst::ICMP_EQ  || pred == ICmpInst::ICMP_UGE ||
 717            pred == ICmpInst::ICMP_SGE || pred == ICmpInst::ICMP_ULE ||
 718            pred == ICmpInst::ICMP_SLE;
 719   }
 720
 721   /// @returns true if the specified compare instruction is
 722   /// true when both operands are equal...
 723   /// @brief Determine if the ICmpInst returns true when both operands are equal
 724   bool isTrueWhenEqual() {
 725     return isTrueWhenEqual(getPredicate());
 726   }
 727
 728   /// Initialize a set of values that all satisfy the predicate with C.
 729   /// @brief Make a ConstantRange for a relation with a constant value.
 730   static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
 731
 732   /// Exchange the two operands to this instruction in such a way that it does
 733   /// not modify the semantics of the instruction. The predicate value may be
 734   /// changed to retain the same result if the predicate is order dependent
 735   /// (e.g. ult).
 736   /// @brief Swap operands and adjust predicate.
 737   void swapOperands() {
 738     SubclassData = getSwappedPredicate();
 739     Op<0>().swap(Op<1>());
 740   }
 741
 742   virtual ICmpInst *clone() const;
 743
 744   // Methods for support type inquiry through isa, cast, and dyn_cast:
 745   static inline bool classof(const ICmpInst *) { return true; }
 746   static inline bool classof(const Instruction *I) {
 747     return I->getOpcode() == Instruction::ICmp;
 748   }
 749   static inline bool classof(const Value *V) {
 750     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 751   }
 752 };
 753
 754 //===----------------------------------------------------------------------===//
 755 //                               FCmpInst Class
 756 //===----------------------------------------------------------------------===//
 757
 758 /// This instruction compares its operands according to the predicate given
 759 /// to the constructor. It only operates on floating point values or packed
 760 /// vectors of floating point values. The operands must be identical types.
 761 /// @brief Represents a floating point comparison operator.
 762 class FCmpInst: public CmpInst {
 763 public:
 764   /// @brief Constructor with insert-before-instruction semantics.
 765   FCmpInst(
 766     Predicate pred,  ///< The predicate to use for the comparison
 767     Value *LHS,      ///< The left-hand-side of the expression
 768     Value *RHS,      ///< The right-hand-side of the expression
 769     const std::string &Name = "",  ///< Name of the instruction
 770     Instruction *InsertBefore = 0  ///< Where to insert
 771   ) : CmpInst(Type::Int1Ty, Instruction::FCmp, pred, LHS, RHS, Name,
 772               InsertBefore) {
 773     assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
 774            "Invalid FCmp predicate value");
 775     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
 776            "Both operands to FCmp instruction are not of the same type!");
 777     // Check that the operands are the right type
 778     assert(getOperand(0)->getType()->isFloatingPoint() &&
 779            "Invalid operand types for FCmp instruction");
 780   }
 781
 782   /// @brief Constructor with insert-at-block-end semantics.
 783   FCmpInst(
 784     Predicate pred, ///< The predicate to use for the comparison
 785     Value *LHS,     ///< The left-hand-side of the expression
 786     Value *RHS,     ///< The right-hand-side of the expression
 787     const std::string &Name,  ///< Name of the instruction
 788     BasicBlock *InsertAtEnd   ///< Block to insert into.
 789   ) : CmpInst(Type::Int1Ty, Instruction::FCmp, pred, LHS, RHS, Name,
 790               InsertAtEnd) {
 791     assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
 792            "Invalid FCmp predicate value");
 793     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
 794            "Both operands to FCmp instruction are not of the same type!");
 795     // Check that the operands are the right type
 796     assert(getOperand(0)->getType()->isFloatingPoint() &&
 797            "Invalid operand types for FCmp instruction");
 798   }
 799
 800   /// This also tests for commutativity. If isEquality() returns true then
 801   /// the predicate is also commutative. Only the equality predicates are
 802   /// commutative.
 803   /// @returns true if the predicate of this instruction is EQ or NE.
 804   /// @brief Determine if this is an equality predicate.
 805   bool isEquality() const {
 806     return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
 807            SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
 808   }
 809   bool isCommutative() const { return isEquality(); }
 810
 811   /// @returns true if the predicate is relational (not EQ or NE).
 812   /// @brief Determine if this a relational predicate.
 813   bool isRelational() const { return !isEquality(); }
 814
 815   /// Exchange the two operands to this instruction in such a way that it does
 816   /// not modify the semantics of the instruction. The predicate value may be
 817   /// changed to retain the same result if the predicate is order dependent
 818   /// (e.g. ult).
 819   /// @brief Swap operands and adjust predicate.
 820   void swapOperands() {
 821     SubclassData = getSwappedPredicate();
 822     Op<0>().swap(Op<1>());
 823   }
 824
 825   virtual FCmpInst *clone() const;
 826
 827   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
 828   static inline bool classof(const FCmpInst *) { return true; }
 829   static inline bool classof(const Instruction *I) {
 830     return I->getOpcode() == Instruction::FCmp;
 831   }
 832   static inline bool classof(const Value *V) {
 833     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 834   }
 835 };
 836
 837 //===----------------------------------------------------------------------===//
 838 //                               VICmpInst Class
 839 //===----------------------------------------------------------------------===//
 840
 841 /// This instruction compares its operands according to the predicate given
 842 /// to the constructor. It only operates on vectors of integers.
 843 /// The operands must be identical types.
 844 /// @brief Represents a vector integer comparison operator.
 845 class VICmpInst: public CmpInst {
 846 public:
 847   /// @brief Constructor with insert-before-instruction semantics.
 848   VICmpInst(
 849     Predicate pred,  ///< The predicate to use for the comparison
 850     Value *LHS,      ///< The left-hand-side of the expression
 851     Value *RHS,      ///< The right-hand-side of the expression
 852     const std::string &Name = "",  ///< Name of the instruction
 853     Instruction *InsertBefore = 0  ///< Where to insert
 854   ) : CmpInst(LHS->getType(), Instruction::VICmp, pred, LHS, RHS, Name,
 855               InsertBefore) {
 856     assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
 857            pred <= CmpInst::LAST_ICMP_PREDICATE &&
 858            "Invalid VICmp predicate value");
 859     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
 860           "Both operands to VICmp instruction are not of the same type!");
 861   }
 862
 863   /// @brief Constructor with insert-at-block-end semantics.
 864   VICmpInst(
 865     Predicate pred, ///< The predicate to use for the comparison
 866     Value *LHS,     ///< The left-hand-side of the expression
 867     Value *RHS,     ///< The right-hand-side of the expression
 868     const std::string &Name,  ///< Name of the instruction
 869     BasicBlock *InsertAtEnd   ///< Block to insert into.
 870   ) : CmpInst(LHS->getType(), Instruction::VICmp, pred, LHS, RHS, Name,
 871               InsertAtEnd) {
 872     assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
 873            pred <= CmpInst::LAST_ICMP_PREDICATE &&
 874            "Invalid VICmp predicate value");
 875     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
 876           "Both operands to VICmp instruction are not of the same type!");
 877   }
 878
 879   /// @brief Return the predicate for this instruction.
 880   Predicate getPredicate() const { return Predicate(SubclassData); }
 881
 882   virtual VICmpInst *clone() const;
 883
 884   // Methods for support type inquiry through isa, cast, and dyn_cast:
 885   static inline bool classof(const VICmpInst *) { return true; }
 886   static inline bool classof(const Instruction *I) {
 887     return I->getOpcode() == Instruction::VICmp;
 888   }
 889   static inline bool classof(const Value *V) {
 890     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 891   }
 892 };
 893
 894 //===----------------------------------------------------------------------===//
 895 //                               VFCmpInst Class
 896 //===----------------------------------------------------------------------===//
 897
 898 /// This instruction compares its operands according to the predicate given
 899 /// to the constructor. It only operates on vectors of floating point values.
 900 /// The operands must be identical types.
 901 /// @brief Represents a vector floating point comparison operator.
 902 class VFCmpInst: public CmpInst {
 903 public:
 904   /// @brief Constructor with insert-before-instruction semantics.
 905   VFCmpInst(
 906     Predicate pred,  ///< The predicate to use for the comparison
 907     Value *LHS,      ///< The left-hand-side of the expression
 908     Value *RHS,      ///< The right-hand-side of the expression
 909     const std::string &Name = "",  ///< Name of the instruction
 910     Instruction *InsertBefore = 0  ///< Where to insert
 911   ) : CmpInst(VectorType::getInteger(cast<VectorType>(LHS->getType())),
 912               Instruction::VFCmp, pred, LHS, RHS, Name, InsertBefore) {
 913     assert(pred <= CmpInst::LAST_FCMP_PREDICATE &&
 914            "Invalid VFCmp predicate value");
 915     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
 916            "Both operands to VFCmp instruction are not of the same type!");
 917   }
 918
 919   /// @brief Constructor with insert-at-block-end semantics.
 920   VFCmpInst(
 921     Predicate pred, ///< The predicate to use for the comparison
 922     Value *LHS,     ///< The left-hand-side of the expression
 923     Value *RHS,     ///< The right-hand-side of the expression
 924     const std::string &Name,  ///< Name of the instruction
 925     BasicBlock *InsertAtEnd   ///< Block to insert into.
 926   ) : CmpInst(VectorType::getInteger(cast<VectorType>(LHS->getType())),
 927               Instruction::VFCmp, pred, LHS, RHS, Name, InsertAtEnd) {
 928     assert(pred <= CmpInst::LAST_FCMP_PREDICATE &&
 929            "Invalid VFCmp predicate value");
 930     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
 931            "Both operands to VFCmp instruction are not of the same type!");
 932   }
 933
 934   /// @brief Return the predicate for this instruction.
 935   Predicate getPredicate() const { return Predicate(SubclassData); }
 936
 937   virtual VFCmpInst *clone() const;
 938
 939   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
 940   static inline bool classof(const VFCmpInst *) { return true; }
 941   static inline bool classof(const Instruction *I) {
 942     return I->getOpcode() == Instruction::VFCmp;
 943   }
 944   static inline bool classof(const Value *V) {
 945     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 946   }
 947 };
 948
 949 //===----------------------------------------------------------------------===//
 950 //                                 CallInst Class
 951 //===----------------------------------------------------------------------===//
 952 /// CallInst - This class represents a function call, abstracting a target
 953 /// machine's calling convention.  This class uses low bit of the SubClassData
 954 /// field to indicate whether or not this is a tail call.  The rest of the bits
 955 /// hold the calling convention of the call.
 956 ///
 957
 958 class CallInst : public Instruction {
 959   PAListPtr ParamAttrs; ///< parameter attributes for call
 960   CallInst(const CallInst &CI);
 961   void init(Value *Func, Value* const *Params, unsigned NumParams);
 962   void init(Value *Func, Value *Actual1, Value *Actual2);
 963   void init(Value *Func, Value *Actual);
 964   void init(Value *Func);
 965
 966   template<typename InputIterator>
 967   void init(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
 968             const std::string &Name,
 969             // This argument ensures that we have an iterator we can
 970             // do arithmetic on in constant time
 971             std::random_access_iterator_tag) {
 972     unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
 973
 974     // This requires that the iterator points to contiguous memory.
 975     init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
 976     setName(Name);
 977   }
 978
 979   /// Construct a CallInst given a range of arguments.  InputIterator
 980   /// must be a random-access iterator pointing to contiguous storage
 981   /// (e.g. a std::vector<>::iterator).  Checks are made for
 982   /// random-accessness but not for contiguous storage as that would
 983   /// incur runtime overhead.
 984   /// @brief Construct a CallInst from a range of arguments
 985   template<typename InputIterator>
 986   CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
 987            const std::string &Name, Instruction *InsertBefore);
 988
 989   /// Construct a CallInst given a range of arguments.  InputIterator
 990   /// must be a random-access iterator pointing to contiguous storage
 991   /// (e.g. a std::vector<>::iterator).  Checks are made for
 992   /// random-accessness but not for contiguous storage as that would
 993   /// incur runtime overhead.
 994   /// @brief Construct a CallInst from a range of arguments
 995   template<typename InputIterator>
 996   inline CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
 997                   const std::string &Name, BasicBlock *InsertAtEnd);
 998
 999   CallInst(Value *F, Value *Actual, const std::string& Name,
1000            Instruction *InsertBefore);
1001   CallInst(Value *F, Value *Actual, const std::string& Name,
1002            BasicBlock *InsertAtEnd);
1003   explicit CallInst(Value *F, const std::string &Name,
1004                     Instruction *InsertBefore);
1005   CallInst(Value *F, const std::string &Name, BasicBlock *InsertAtEnd);
1006 public:
1007   template<typename InputIterator>
1008   static CallInst *Create(Value *Func,
1009                           InputIterator ArgBegin, InputIterator ArgEnd,
1010                           const std::string &Name = "",
1011                           Instruction *InsertBefore = 0) {
1012     return new((unsigned)(ArgEnd - ArgBegin + 1))
1013       CallInst(Func, ArgBegin, ArgEnd, Name, InsertBefore);
1014   }
1015   template<typename InputIterator>
1016   static CallInst *Create(Value *Func,
1017                           InputIterator ArgBegin, InputIterator ArgEnd,
1018                           const std::string &Name, BasicBlock *InsertAtEnd) {
1019     return new((unsigned)(ArgEnd - ArgBegin + 1))
1020       CallInst(Func, ArgBegin, ArgEnd, Name, InsertAtEnd);
1021   }
1022   static CallInst *Create(Value *F, Value *Actual, const std::string& Name = "",
1023                           Instruction *InsertBefore = 0) {
1024     return new(2) CallInst(F, Actual, Name, InsertBefore);
1025   }
1026   static CallInst *Create(Value *F, Value *Actual, const std::string& Name,
1027                           BasicBlock *InsertAtEnd) {
1028     return new(2) CallInst(F, Actual, Name, InsertAtEnd);
1029   }
1030   static CallInst *Create(Value *F, const std::string &Name = "",
1031                           Instruction *InsertBefore = 0) {
1032     return new(1) CallInst(F, Name, InsertBefore);
1033   }
1034   static CallInst *Create(Value *F, const std::string &Name,
1035                           BasicBlock *InsertAtEnd) {
1036     return new(1) CallInst(F, Name, InsertAtEnd);
1037   }
1038
1039   ~CallInst();
1040
1041   virtual CallInst *clone() const;
1042
1043   /// Provide fast operand accessors
1044   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1045
1046   bool isTailCall() const           { return SubclassData & 1; }
1047   void setTailCall(bool isTailCall = true) {
1048     SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
1049   }
1050
1051   /// getCallingConv/setCallingConv - Get or set the calling convention of this
1052   /// function call.
1053   unsigned getCallingConv() const { return SubclassData >> 1; }
1054   void setCallingConv(unsigned CC) {
1055     SubclassData = (SubclassData & 1) | (CC << 1);
1056   }
1057
1058   /// getParamAttrs - Return the parameter attributes for this call.
1059   ///
1060   const PAListPtr &getParamAttrs() const { return ParamAttrs; }
1061
1062   /// setParamAttrs - Sets the parameter attributes for this call.
1063   void setParamAttrs(const PAListPtr &Attrs) { ParamAttrs = Attrs; }
1064
1065   /// addParamAttr - adds the attribute to the list of attributes.
1066   void addParamAttr(unsigned i, ParameterAttributes attr);
1067
1068   /// @brief Determine whether the call or the callee has the given attribute.
1069   bool paramHasAttr(unsigned i, unsigned attr) const;
1070
1071   /// @brief Extract the alignment for a call or parameter (0=unknown).
1072   unsigned getParamAlignment(unsigned i) const {
1073     return ParamAttrs.getParamAlignment(i);
1074   }
1075
1076   /// @brief Determine if the call does not access memory.
1077   bool doesNotAccessMemory() const {
1078     return paramHasAttr(0, ParamAttr::ReadNone);
1079   }
1080
1081   /// @brief Determine if the call does not access or only reads memory.
1082   bool onlyReadsMemory() const {
1083     return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
1084   }
1085
1086   /// @brief Determine if the call cannot return.
1087   bool doesNotReturn() const {
1088     return paramHasAttr(0, ParamAttr::NoReturn);
1089   }
1090
1091   /// @brief Determine if the call cannot unwind.
1092   bool doesNotThrow() const {
1093     return paramHasAttr(0, ParamAttr::NoUnwind);
1094   }
1095   void setDoesNotThrow(bool doesNotThrow = true);
1096
1097   /// @brief Determine if the call returns a structure through first
1098   /// pointer argument.
1099   bool hasStructRetAttr() const {
1100     // Be friendly and also check the callee.
1101     return paramHasAttr(1, ParamAttr::StructRet);
1102   }
1103
1104   /// @brief Determine if any call argument is an aggregate passed by value.
1105   bool hasByValArgument() const {
1106     return ParamAttrs.hasAttrSomewhere(ParamAttr::ByVal);
1107   }
1108
1109   /// getCalledFunction - Return the function being called by this instruction
1110   /// if it is a direct call.  If it is a call through a function pointer,
1111   /// return null.
1112   Function *getCalledFunction() const {
1113     return dyn_cast<Function>(getOperand(0));
1114   }
1115
1116   /// getCalledValue - Get a pointer to the function that is invoked by this
1117   /// instruction
1118   const Value *getCalledValue() const { return getOperand(0); }
1119         Value *getCalledValue()       { return getOperand(0); }
1120
1121   // Methods for support type inquiry through isa, cast, and dyn_cast:
1122   static inline bool classof(const CallInst *) { return true; }
1123   static inline bool classof(const Instruction *I) {
1124     return I->getOpcode() == Instruction::Call;
1125   }
1126   static inline bool classof(const Value *V) {
1127     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1128   }
1129 };
1130
1131 template <>
1132 struct OperandTraits<CallInst> : VariadicOperandTraits<1> {
1133 };
1134
1135 template<typename InputIterator>
1136 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1137                    const std::string &Name, BasicBlock *InsertAtEnd)
1138   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1139                                    ->getElementType())->getReturnType(),
1140                 Instruction::Call,
1141                 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1142                 (unsigned)(ArgEnd - ArgBegin + 1), InsertAtEnd) {
1143   init(Func, ArgBegin, ArgEnd, Name,
1144        typename std::iterator_traits<InputIterator>::iterator_category());
1145 }
1146
1147 template<typename InputIterator>
1148 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1149                    const std::string &Name, Instruction *InsertBefore)
1150   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1151                                    ->getElementType())->getReturnType(),
1152                 Instruction::Call,
1153                 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1154                 (unsigned)(ArgEnd - ArgBegin + 1), InsertBefore) {
1155   init(Func, ArgBegin, ArgEnd, Name,
1156        typename std::iterator_traits<InputIterator>::iterator_category());
1157 }
1158
1159 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1160
1161 //===----------------------------------------------------------------------===//
1162 //                               SelectInst Class
1163 //===----------------------------------------------------------------------===//
1164
1165 /// SelectInst - This class represents the LLVM 'select' instruction.
1166 ///
1167 class SelectInst : public Instruction {
1168   void init(Value *C, Value *S1, Value *S2) {
1169     Op<0>() = C;
1170     Op<1>() = S1;
1171     Op<2>() = S2;
1172   }
1173
1174   SelectInst(const SelectInst &SI)
1175     : Instruction(SI.getType(), SI.getOpcode(), &Op<0>(), 3) {
1176     init(SI.Op<0>(), SI.Op<1>(), SI.Op<2>());
1177   }
1178   SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
1179              Instruction *InsertBefore)
1180     : Instruction(S1->getType(), Instruction::Select,
1181                   &Op<0>(), 3, InsertBefore) {
1182     init(C, S1, S2);
1183     setName(Name);
1184   }
1185   SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
1186              BasicBlock *InsertAtEnd)
1187     : Instruction(S1->getType(), Instruction::Select,
1188                   &Op<0>(), 3, InsertAtEnd) {
1189     init(C, S1, S2);
1190     setName(Name);
1191   }
1192 public:
1193   static SelectInst *Create(Value *C, Value *S1, Value *S2,
1194                             const std::string &Name = "",
1195                             Instruction *InsertBefore = 0) {
1196     return new(3) SelectInst(C, S1, S2, Name, InsertBefore);
1197   }
1198   static SelectInst *Create(Value *C, Value *S1, Value *S2,
1199                             const std::string &Name, BasicBlock *InsertAtEnd) {
1200     return new(3) SelectInst(C, S1, S2, Name, InsertAtEnd);
1201   }
1202
1203   Value *getCondition() const { return Op<0>(); }
1204   Value *getTrueValue() const { return Op<1>(); }
1205   Value *getFalseValue() const { return Op<2>(); }
1206
1207   /// Transparently provide more efficient getOperand methods.
1208   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1209
1210   OtherOps getOpcode() const {
1211     return static_cast<OtherOps>(Instruction::getOpcode());
1212   }
1213
1214   virtual SelectInst *clone() const;
1215
1216   // Methods for support type inquiry through isa, cast, and dyn_cast:
1217   static inline bool classof(const SelectInst *) { return true; }
1218   static inline bool classof(const Instruction *I) {
1219     return I->getOpcode() == Instruction::Select;
1220   }
1221   static inline bool classof(const Value *V) {
1222     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1223   }
1224 };
1225
1226 template <>
1227 struct OperandTraits<SelectInst> : FixedNumOperandTraits<3> {
1228 };
1229
1230 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1231
1232 //===----------------------------------------------------------------------===//
1233 //                                VAArgInst Class
1234 //===----------------------------------------------------------------------===//
1235
1236 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1237 /// an argument of the specified type given a va_list and increments that list
1238 ///
1239 class VAArgInst : public UnaryInstruction {
1240   VAArgInst(const VAArgInst &VAA)
1241     : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
1242 public:
1243   VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
1244              Instruction *InsertBefore = 0)
1245     : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1246     setName(Name);
1247   }
1248   VAArgInst(Value *List, const Type *Ty, const std::string &Name,
1249             BasicBlock *InsertAtEnd)
1250     : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1251     setName(Name);
1252   }
1253
1254   virtual VAArgInst *clone() const;
1255
1256   // Methods for support type inquiry through isa, cast, and dyn_cast:
1257   static inline bool classof(const VAArgInst *) { return true; }
1258   static inline bool classof(const Instruction *I) {
1259     return I->getOpcode() == VAArg;
1260   }
1261   static inline bool classof(const Value *V) {
1262     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1263   }
1264 };
1265
1266 //===----------------------------------------------------------------------===//
1267 //                                ExtractElementInst Class
1268 //===----------------------------------------------------------------------===//
1269
1270 /// ExtractElementInst - This instruction extracts a single (scalar)
1271 /// element from a VectorType value
1272 ///
1273 class ExtractElementInst : public Instruction {
1274   ExtractElementInst(const ExtractElementInst &EE) :
1275     Instruction(EE.getType(), ExtractElement, &Op<0>(), 2) {
1276     Op<0>() = EE.Op<0>();
1277     Op<1>() = EE.Op<1>();
1278   }
1279
1280 public:
1281   // allocate space for exactly two operands
1282   void *operator new(size_t s) {
1283     return User::operator new(s, 2); // FIXME: "unsigned Idx" forms of ctor?
1284   }
1285   ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
1286                      Instruction *InsertBefore = 0);
1287   ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name = "",
1288                      Instruction *InsertBefore = 0);
1289   ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
1290                      BasicBlock *InsertAtEnd);
1291   ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name,
1292                      BasicBlock *InsertAtEnd);
1293
1294   /// isValidOperands - Return true if an extractelement instruction can be
1295   /// formed with the specified operands.
1296   static bool isValidOperands(const Value *Vec, const Value *Idx);
1297
1298   virtual ExtractElementInst *clone() const;
1299
1300   /// Transparently provide more efficient getOperand methods.
1301   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1302
1303   // Methods for support type inquiry through isa, cast, and dyn_cast:
1304   static inline bool classof(const ExtractElementInst *) { return true; }
1305   static inline bool classof(const Instruction *I) {
1306     return I->getOpcode() == Instruction::ExtractElement;
1307   }
1308   static inline bool classof(const Value *V) {
1309     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1310   }
1311 };
1312
1313 template <>
1314 struct OperandTraits<ExtractElementInst> : FixedNumOperandTraits<2> {
1315 };
1316
1317 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1318
1319 //===----------------------------------------------------------------------===//
1320 //                                InsertElementInst Class
1321 //===----------------------------------------------------------------------===//
1322
1323 /// InsertElementInst - This instruction inserts a single (scalar)
1324 /// element into a VectorType value
1325 ///
1326 class InsertElementInst : public Instruction {
1327   InsertElementInst(const InsertElementInst &IE);
1328   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1329                     const std::string &Name = "",Instruction *InsertBefore = 0);
1330   InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1331                     const std::string &Name = "",Instruction *InsertBefore = 0);
1332   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1333                     const std::string &Name, BasicBlock *InsertAtEnd);
1334   InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1335                     const std::string &Name, BasicBlock *InsertAtEnd);
1336 public:
1337   static InsertElementInst *Create(const InsertElementInst &IE) {
1338     return new(IE.getNumOperands()) InsertElementInst(IE);
1339   }
1340   static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1341                                    const std::string &Name = "",
1342                                    Instruction *InsertBefore = 0) {
1343     return new(3) InsertElementInst(Vec, NewElt, Idx, Name, InsertBefore);
1344   }
1345   static InsertElementInst *Create(Value *Vec, Value *NewElt, unsigned Idx,
1346                                    const std::string &Name = "",
1347                                    Instruction *InsertBefore = 0) {
1348     return new(3) InsertElementInst(Vec, NewElt, Idx, Name, InsertBefore);
1349   }
1350   static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1351                                    const std::string &Name,
1352                                    BasicBlock *InsertAtEnd) {
1353     return new(3) InsertElementInst(Vec, NewElt, Idx, Name, InsertAtEnd);
1354   }
1355   static InsertElementInst *Create(Value *Vec, Value *NewElt, unsigned Idx,
1356                                    const std::string &Name,
1357                                    BasicBlock *InsertAtEnd) {
1358     return new(3) InsertElementInst(Vec, NewElt, Idx, Name, InsertAtEnd);
1359   }
1360
1361   /// isValidOperands - Return true if an insertelement instruction can be
1362   /// formed with the specified operands.
1363   static bool isValidOperands(const Value *Vec, const Value *NewElt,
1364                               const Value *Idx);
1365
1366   virtual InsertElementInst *clone() const;
1367
1368   /// getType - Overload to return most specific vector type.
1369   ///
1370   const VectorType *getType() const {
1371     return reinterpret_cast<const VectorType*>(Instruction::getType());
1372   }
1373
1374   /// Transparently provide more efficient getOperand methods.
1375   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1376
1377   // Methods for support type inquiry through isa, cast, and dyn_cast:
1378   static inline bool classof(const InsertElementInst *) { return true; }
1379   static inline bool classof(const Instruction *I) {
1380     return I->getOpcode() == Instruction::InsertElement;
1381   }
1382   static inline bool classof(const Value *V) {
1383     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1384   }
1385 };
1386
1387 template <>
1388 struct OperandTraits<InsertElementInst> : FixedNumOperandTraits<3> {
1389 };
1390
1391 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1392
1393 //===----------------------------------------------------------------------===//
1394 //                           ShuffleVectorInst Class
1395 //===----------------------------------------------------------------------===//
1396
1397 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1398 /// input vectors.
1399 ///
1400 class ShuffleVectorInst : public Instruction {
1401   ShuffleVectorInst(const ShuffleVectorInst &IE);
1402 public:
1403   // allocate space for exactly three operands
1404   void *operator new(size_t s) {
1405     return User::operator new(s, 3);
1406   }
1407   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1408                     const std::string &Name = "", Instruction *InsertBefor = 0);
1409   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1410                     const std::string &Name, BasicBlock *InsertAtEnd);
1411
1412   /// isValidOperands - Return true if a shufflevector instruction can be
1413   /// formed with the specified operands.
1414   static bool isValidOperands(const Value *V1, const Value *V2,
1415                               const Value *Mask);
1416
1417   virtual ShuffleVectorInst *clone() const;
1418
1419   /// getType - Overload to return most specific vector type.
1420   ///
1421   const VectorType *getType() const {
1422     return reinterpret_cast<const VectorType*>(Instruction::getType());
1423   }
1424
1425   /// Transparently provide more efficient getOperand methods.
1426   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1427
1428   /// getMaskValue - Return the index from the shuffle mask for the specified
1429   /// output result.  This is either -1 if the element is undef or a number less
1430   /// than 2*numelements.
1431   int getMaskValue(unsigned i) const;
1432
1433   // Methods for support type inquiry through isa, cast, and dyn_cast:
1434   static inline bool classof(const ShuffleVectorInst *) { return true; }
1435   static inline bool classof(const Instruction *I) {
1436     return I->getOpcode() == Instruction::ShuffleVector;
1437   }
1438   static inline bool classof(const Value *V) {
1439     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1440   }
1441 };
1442
1443 template <>
1444 struct OperandTraits<ShuffleVectorInst> : FixedNumOperandTraits<3> {
1445 };
1446
1447 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1448
1449 //===----------------------------------------------------------------------===//
1450 //                                ExtractValueInst Class
1451 //===----------------------------------------------------------------------===//
1452
1453 /// ExtractValueInst - This instruction extracts a struct member or array
1454 /// element value from an aggregate value.
1455 ///
1456 class ExtractValueInst : public UnaryInstruction {
1457   SmallVector<unsigned, 4> Indices;
1458
1459   ExtractValueInst(const ExtractValueInst &EVI);
1460   void init(const unsigned *Idx, unsigned NumIdx,
1461             const std::string &Name);
1462   void init(unsigned Idx, const std::string &Name);
1463
1464   template<typename InputIterator>
1465   void init(InputIterator IdxBegin, InputIterator IdxEnd,
1466             const std::string &Name,
1467             // This argument ensures that we have an iterator we can
1468             // do arithmetic on in constant time
1469             std::random_access_iterator_tag) {
1470     unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1471
1472     // There's no fundamental reason why we require at least one index
1473     // (other than weirdness with &*IdxBegin being invalid; see
1474     // getelementptr's init routine for example). But there's no
1475     // present need to support it.
1476     assert(NumIdx > 0 && "ExtractValueInst must have at least one index");
1477
1478     // This requires that the iterator points to contiguous memory.
1479     init(&*IdxBegin, NumIdx, Name); // FIXME: for the general case
1480                                          // we have to build an array here
1481   }
1482
1483   /// getIndexedType - Returns the type of the element that would be extracted
1484   /// with an extractvalue instruction with the specified parameters.
1485   ///
1486   /// Null is returned if the indices are invalid for the specified
1487   /// pointer type.
1488   ///
1489   static const Type *getIndexedType(const Type *Agg,
1490                                     const unsigned *Idx, unsigned NumIdx);
1491
1492   template<typename InputIterator>
1493   static const Type *getIndexedType(const Type *Ptr,
1494                                     InputIterator IdxBegin,
1495                                     InputIterator IdxEnd,
1496                                     // This argument ensures that we
1497                                     // have an iterator we can do
1498                                     // arithmetic on in constant time
1499                                     std::random_access_iterator_tag) {
1500     unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1501
1502     if (NumIdx > 0)
1503       // This requires that the iterator points to contiguous memory.
1504       return getIndexedType(Ptr, (const unsigned *)&*IdxBegin, NumIdx);
1505     else
1506       return getIndexedType(Ptr, (const unsigned *)0, NumIdx);
1507   }
1508
1509   /// Constructors - Create a extractvalue instruction with a base aggregate
1510   /// value and a list of indices.  The first ctor can optionally insert before
1511   /// an existing instruction, the second appends the new instruction to the
1512   /// specified BasicBlock.
1513   template<typename InputIterator>
1514   inline ExtractValueInst(Value *Agg, InputIterator IdxBegin,
1515                           InputIterator IdxEnd,
1516                           const std::string &Name,
1517                           Instruction *InsertBefore);
1518   template<typename InputIterator>
1519   inline ExtractValueInst(Value *Agg,
1520                           InputIterator IdxBegin, InputIterator IdxEnd,
1521                           const std::string &Name, BasicBlock *InsertAtEnd);
1522
1523   /// Constructors - These two constructors are convenience methods because one
1524   /// and two index extractvalue instructions are so common.
1525   ExtractValueInst(Value *Agg, unsigned Idx, const std::string &Name = "",
1526                     Instruction *InsertBefore = 0);
1527   ExtractValueInst(Value *Agg, unsigned Idx,
1528                     const std::string &Name, BasicBlock *InsertAtEnd);
1529
1530   // allocate space for exactly one operand
1531   void *operator new(size_t s) {
1532     return User::operator new(s, 1);
1533   }
1534
1535 public:
1536   template<typename InputIterator>
1537   static ExtractValueInst *Create(Value *Agg, InputIterator IdxBegin,
1538                                   InputIterator IdxEnd,
1539                                   const std::string &Name = "",
1540                                   Instruction *InsertBefore = 0) {
1541     return new
1542       ExtractValueInst(Agg, IdxBegin, IdxEnd, Name, InsertBefore);
1543   }
1544   template<typename InputIterator>
1545   static ExtractValueInst *Create(Value *Agg,
1546                                   InputIterator IdxBegin, InputIterator IdxEnd,
1547                                   const std::string &Name,
1548                                   BasicBlock *InsertAtEnd) {
1549     return new ExtractValueInst(Agg, IdxBegin, IdxEnd, Name, InsertAtEnd);
1550   }
1551
1552   /// Constructors - These two creators are convenience methods because one
1553   /// index extractvalue instructions are much more common than those with
1554   /// more than one.
1555   static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1556                                   const std::string &Name = "",
1557                                   Instruction *InsertBefore = 0) {
1558     return new ExtractValueInst(Agg, Idx, Name, InsertBefore);
1559   }
1560   static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1561                                   const std::string &Name,
1562                                   BasicBlock *InsertAtEnd) {
1563     return new ExtractValueInst(Agg, Idx, Name, InsertAtEnd);
1564   }
1565
1566   virtual ExtractValueInst *clone() const;
1567
1568   // getType - Overload to return most specific pointer type...
1569   const PointerType *getType() const {
1570     return reinterpret_cast<const PointerType*>(Instruction::getType());
1571   }
1572
1573   /// getIndexedType - Returns the type of the element that would be extracted
1574   /// with an extractvalue instruction with the specified parameters.
1575   ///
1576   /// Null is returned if the indices are invalid for the specified
1577   /// pointer type.
1578   ///
1579   template<typename InputIterator>
1580   static const Type *getIndexedType(const Type *Ptr,
1581                                     InputIterator IdxBegin,
1582                                     InputIterator IdxEnd) {
1583     return getIndexedType(Ptr, IdxBegin, IdxEnd,
1584                           typename std::iterator_traits<InputIterator>::
1585                           iterator_category());
1586   }
1587   static const Type *getIndexedType(const Type *Ptr, unsigned Idx);
1588
1589   inline const unsigned *idx_begin() const { return Indices.begin(); }
1590   inline const unsigned *idx_end()   const { return Indices.end(); }
1591
1592   Value *getAggregateOperand() {
1593     return getOperand(0);
1594   }
1595   const Value *getAggregateOperand() const {
1596     return getOperand(0);
1597   }
1598   static unsigned getAggregateOperandIndex() {
1599     return 0U;                      // get index for modifying correct operand
1600   }
1601
1602   unsigned getNumIndices() const {  // Note: always non-negative
1603     return (unsigned)Indices.size();
1604   }
1605
1606   bool hasIndices() const {
1607     return true;
1608   }
1609
1610   // Methods for support type inquiry through isa, cast, and dyn_cast:
1611   static inline bool classof(const ExtractValueInst *) { return true; }
1612   static inline bool classof(const Instruction *I) {
1613     return I->getOpcode() == Instruction::ExtractValue;
1614   }
1615   static inline bool classof(const Value *V) {
1616     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1617   }
1618 };
1619
1620 template<typename InputIterator>
1621 ExtractValueInst::ExtractValueInst(Value *Agg,
1622                                    InputIterator IdxBegin,
1623                                    InputIterator IdxEnd,
1624                                    const std::string &Name,
1625                                    Instruction *InsertBefore)
1626   : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1627                                               IdxBegin, IdxEnd)),
1628                      ExtractValue, Agg, InsertBefore) {
1629   init(IdxBegin, IdxEnd, Name,
1630        typename std::iterator_traits<InputIterator>::iterator_category());
1631 }
1632 template<typename InputIterator>
1633 ExtractValueInst::ExtractValueInst(Value *Agg,
1634                                    InputIterator IdxBegin,
1635                                    InputIterator IdxEnd,
1636                                    const std::string &Name,
1637                                    BasicBlock *InsertAtEnd)
1638   : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1639                                               IdxBegin, IdxEnd)),
1640                      ExtractValue, Agg, InsertAtEnd) {
1641   init(IdxBegin, IdxEnd, Name,
1642        typename std::iterator_traits<InputIterator>::iterator_category());
1643 }
1644
1645
1646 //===----------------------------------------------------------------------===//
1647 //                                InsertValueInst Class
1648 //===----------------------------------------------------------------------===//
1649
1650 /// InsertValueInst - This instruction inserts a struct field of array element
1651 /// value into an aggregate value.
1652 ///
1653 class InsertValueInst : public Instruction {
1654   SmallVector<unsigned, 4> Indices;
1655
1656   void *operator new(size_t, unsigned); // Do not implement
1657   InsertValueInst(const InsertValueInst &IVI);
1658   void init(Value *Agg, Value *Val, const unsigned *Idx, unsigned NumIdx,
1659             const std::string &Name);
1660   void init(Value *Agg, Value *Val, unsigned Idx, const std::string &Name);
1661
1662   template<typename InputIterator>
1663   void init(Value *Agg, Value *Val,
1664             InputIterator IdxBegin, InputIterator IdxEnd,
1665             const std::string &Name,
1666             // This argument ensures that we have an iterator we can
1667             // do arithmetic on in constant time
1668             std::random_access_iterator_tag) {
1669     unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1670
1671     // There's no fundamental reason why we require at least one index
1672     // (other than weirdness with &*IdxBegin being invalid; see
1673     // getelementptr's init routine for example). But there's no
1674     // present need to support it.
1675     assert(NumIdx > 0 && "InsertValueInst must have at least one index");
1676
1677     // This requires that the iterator points to contiguous memory.
1678     init(Agg, Val, &*IdxBegin, NumIdx, Name); // FIXME: for the general case
1679                                               // we have to build an array here
1680   }
1681
1682   /// Constructors - Create a insertvalue instruction with a base aggregate
1683   /// value, a value to insert, and a list of indices.  The first ctor can
1684   /// optionally insert before an existing instruction, the second appends
1685   /// the new instruction to the specified BasicBlock.
1686   template<typename InputIterator>
1687   inline InsertValueInst(Value *Agg, Value *Val, InputIterator IdxBegin,
1688                          InputIterator IdxEnd,
1689                          const std::string &Name,
1690                          Instruction *InsertBefore);
1691   template<typename InputIterator>
1692   inline InsertValueInst(Value *Agg, Value *Val,
1693                          InputIterator IdxBegin, InputIterator IdxEnd,
1694                          const std::string &Name, BasicBlock *InsertAtEnd);
1695
1696   /// Constructors - These two constructors are convenience methods because one
1697   /// and two index insertvalue instructions are so common.
1698   InsertValueInst(Value *Agg, Value *Val,
1699                   unsigned Idx, const std::string &Name = "",
1700                   Instruction *InsertBefore = 0);
1701   InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1702                   const std::string &Name, BasicBlock *InsertAtEnd);
1703 public:
1704   // allocate space for exactly two operands
1705   void *operator new(size_t s) {
1706     return User::operator new(s, 2);
1707   }
1708
1709   template<typename InputIterator>
1710   static InsertValueInst *Create(Value *Agg, Value *Val, InputIterator IdxBegin,
1711                                  InputIterator IdxEnd,
1712                                  const std::string &Name = "",
1713                                  Instruction *InsertBefore = 0) {
1714     return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1715                                Name, InsertBefore);
1716   }
1717   template<typename InputIterator>
1718   static InsertValueInst *Create(Value *Agg, Value *Val,
1719                                  InputIterator IdxBegin, InputIterator IdxEnd,
1720                                  const std::string &Name,
1721                                  BasicBlock *InsertAtEnd) {
1722     return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1723                                Name, InsertAtEnd);
1724   }
1725
1726   /// Constructors - These two creators are convenience methods because one
1727   /// index insertvalue instructions are much more common than those with
1728   /// more than one.
1729   static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1730                                  const std::string &Name = "",
1731                                  Instruction *InsertBefore = 0) {
1732     return new InsertValueInst(Agg, Val, Idx, Name, InsertBefore);
1733   }
1734   static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1735                                  const std::string &Name,
1736                                  BasicBlock *InsertAtEnd) {
1737     return new InsertValueInst(Agg, Val, Idx, Name, InsertAtEnd);
1738   }
1739
1740   virtual InsertValueInst *clone() const;
1741
1742   /// Transparently provide more efficient getOperand methods.
1743   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1744
1745   // getType - Overload to return most specific pointer type...
1746   const PointerType *getType() const {
1747     return reinterpret_cast<const PointerType*>(Instruction::getType());
1748   }
1749
1750   inline const unsigned *idx_begin() const { return Indices.begin(); }
1751   inline const unsigned *idx_end()   const { return Indices.end(); }
1752
1753   Value *getAggregateOperand() {
1754     return getOperand(0);
1755   }
1756   const Value *getAggregateOperand() const {
1757     return getOperand(0);
1758   }
1759   static unsigned getAggregateOperandIndex() {
1760     return 0U;                      // get index for modifying correct operand
1761   }
1762
1763   Value *getInsertedValueOperand() {
1764     return getOperand(1);
1765   }
1766   const Value *getInsertedValueOperand() const {
1767     return getOperand(1);
1768   }
1769   static unsigned getInsertedValueOperandIndex() {
1770     return 1U;                      // get index for modifying correct operand
1771   }
1772
1773   unsigned getNumIndices() const {  // Note: always non-negative
1774     return (unsigned)Indices.size();
1775   }
1776
1777   bool hasIndices() const {
1778     return true;
1779   }
1780
1781   // Methods for support type inquiry through isa, cast, and dyn_cast:
1782   static inline bool classof(const InsertValueInst *) { return true; }
1783   static inline bool classof(const Instruction *I) {
1784     return I->getOpcode() == Instruction::InsertValue;
1785   }
1786   static inline bool classof(const Value *V) {
1787     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1788   }
1789 };
1790
1791 template <>
1792 struct OperandTraits<InsertValueInst> : FixedNumOperandTraits<2> {
1793 };
1794
1795 template<typename InputIterator>
1796 InsertValueInst::InsertValueInst(Value *Agg,
1797                                  Value *Val,
1798                                  InputIterator IdxBegin,
1799                                  InputIterator IdxEnd,
1800                                  const std::string &Name,
1801                                  Instruction *InsertBefore)
1802   : Instruction(Agg->getType(), InsertValue,
1803                 OperandTraits<InsertValueInst>::op_begin(this),
1804                 2, InsertBefore) {
1805   init(Agg, Val, IdxBegin, IdxEnd, Name,
1806        typename std::iterator_traits<InputIterator>::iterator_category());
1807 }
1808 template<typename InputIterator>
1809 InsertValueInst::InsertValueInst(Value *Agg,
1810                                  Value *Val,
1811                                  InputIterator IdxBegin,
1812                                  InputIterator IdxEnd,
1813                                  const std::string &Name,
1814                                  BasicBlock *InsertAtEnd)
1815   : Instruction(Agg->getType(), InsertValue,
1816                 OperandTraits<InsertValueInst>::op_begin(this),
1817                 2, InsertAtEnd) {
1818   init(Agg, Val, IdxBegin, IdxEnd, Name,
1819        typename std::iterator_traits<InputIterator>::iterator_category());
1820 }
1821
1822 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1823
1824 //===----------------------------------------------------------------------===//
1825 //                               PHINode Class
1826 //===----------------------------------------------------------------------===//
1827
1828 // PHINode - The PHINode class is used to represent the magical mystical PHI
1829 // node, that can not exist in nature, but can be synthesized in a computer
1830 // scientist's overactive imagination.
1831 //
1832 class PHINode : public Instruction {
1833   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
1834   /// ReservedSpace - The number of operands actually allocated.  NumOperands is
1835   /// the number actually in use.
1836   unsigned ReservedSpace;
1837   PHINode(const PHINode &PN);
1838   // allocate space for exactly zero operands
1839   void *operator new(size_t s) {
1840     return User::operator new(s, 0);
1841   }
1842   explicit PHINode(const Type *Ty, const std::string &Name = "",
1843                    Instruction *InsertBefore = 0)
1844     : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1845       ReservedSpace(0) {
1846     setName(Name);
1847   }
1848
1849   PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
1850     : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1851       ReservedSpace(0) {
1852     setName(Name);
1853   }
1854 public:
1855   static PHINode *Create(const Type *Ty, const std::string &Name = "",
1856                          Instruction *InsertBefore = 0) {
1857     return new PHINode(Ty, Name, InsertBefore);
1858   }
1859   static PHINode *Create(const Type *Ty, const std::string &Name,
1860                          BasicBlock *InsertAtEnd) {
1861     return new PHINode(Ty, Name, InsertAtEnd);
1862   }
1863   ~PHINode();
1864
1865   /// reserveOperandSpace - This method can be used to avoid repeated
1866   /// reallocation of PHI operand lists by reserving space for the correct
1867   /// number of operands before adding them.  Unlike normal vector reserves,
1868   /// this method can also be used to trim the operand space.
1869   void reserveOperandSpace(unsigned NumValues) {
1870     resizeOperands(NumValues*2);
1871   }
1872
1873   virtual PHINode *clone() const;
1874
1875   /// Provide fast operand accessors
1876   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1877
1878   /// getNumIncomingValues - Return the number of incoming edges
1879   ///
1880   unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1881
1882   /// getIncomingValue - Return incoming value number x
1883   ///
1884   Value *getIncomingValue(unsigned i) const {
1885     assert(i*2 < getNumOperands() && "Invalid value number!");
1886     return getOperand(i*2);
1887   }
1888   void setIncomingValue(unsigned i, Value *V) {
1889     assert(i*2 < getNumOperands() && "Invalid value number!");
1890     setOperand(i*2, V);
1891   }
1892   unsigned getOperandNumForIncomingValue(unsigned i) {
1893     return i*2;
1894   }
1895
1896   /// getIncomingBlock - Return incoming basic block number x
1897   ///
1898   BasicBlock *getIncomingBlock(unsigned i) const {
1899     return static_cast<BasicBlock*>(getOperand(i*2+1));
1900   }
1901   void setIncomingBlock(unsigned i, BasicBlock *BB) {
1902     setOperand(i*2+1, BB);
1903   }
1904   unsigned getOperandNumForIncomingBlock(unsigned i) {
1905     return i*2+1;
1906   }
1907
1908   /// addIncoming - Add an incoming value to the end of the PHI list
1909   ///
1910   void addIncoming(Value *V, BasicBlock *BB) {
1911     assert(V && "PHI node got a null value!");
1912     assert(BB && "PHI node got a null basic block!");
1913     assert(getType() == V->getType() &&
1914            "All operands to PHI node must be the same type as the PHI node!");
1915     unsigned OpNo = NumOperands;
1916     if (OpNo+2 > ReservedSpace)
1917       resizeOperands(0);  // Get more space!
1918     // Initialize some new operands.
1919     NumOperands = OpNo+2;
1920     OperandList[OpNo] = V;
1921     OperandList[OpNo+1] = BB;
1922   }
1923
1924   /// removeIncomingValue - Remove an incoming value.  This is useful if a
1925   /// predecessor basic block is deleted.  The value removed is returned.
1926   ///
1927   /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1928   /// is true), the PHI node is destroyed and any uses of it are replaced with
1929   /// dummy values.  The only time there should be zero incoming values to a PHI
1930   /// node is when the block is dead, so this strategy is sound.
1931   ///
1932   Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1933
1934   Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
1935     int Idx = getBasicBlockIndex(BB);
1936     assert(Idx >= 0 && "Invalid basic block argument to remove!");
1937     return removeIncomingValue(Idx, DeletePHIIfEmpty);
1938   }
1939
1940   /// getBasicBlockIndex - Return the first index of the specified basic
1941   /// block in the value list for this PHI.  Returns -1 if no instance.
1942   ///
1943   int getBasicBlockIndex(const BasicBlock *BB) const {
1944     Use *OL = OperandList;
1945     for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1946       if (OL[i+1].get() == BB) return i/2;
1947     return -1;
1948   }
1949
1950   Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1951     return getIncomingValue(getBasicBlockIndex(BB));
1952   }
1953
1954   /// hasConstantValue - If the specified PHI node always merges together the
1955   /// same value, return the value, otherwise return null.
1956   ///
1957   Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1958
1959   /// Methods for support type inquiry through isa, cast, and dyn_cast:
1960   static inline bool classof(const PHINode *) { return true; }
1961   static inline bool classof(const Instruction *I) {
1962     return I->getOpcode() == Instruction::PHI;
1963   }
1964   static inline bool classof(const Value *V) {
1965     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1966   }
1967  private:
1968   void resizeOperands(unsigned NumOperands);
1969 };
1970
1971 template <>
1972 struct OperandTraits<PHINode> : HungoffOperandTraits<2> {
1973 };
1974
1975 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
1976
1977
1978 //===----------------------------------------------------------------------===//
1979 //                               ReturnInst Class
1980 //===----------------------------------------------------------------------===//
1981
1982 //===---------------------------------------------------------------------------
1983 /// ReturnInst - Return a value (possibly void), from a function.  Execution
1984 /// does not continue in this function any longer.
1985 ///
1986 class ReturnInst : public TerminatorInst {
1987   ReturnInst(const ReturnInst &RI);
1988   void init(Value * const* retVals, unsigned N);
1989
1990 private:
1991   // ReturnInst constructors:
1992   // ReturnInst()                  - 'ret void' instruction
1993   // ReturnInst(    null)          - 'ret void' instruction
1994   // ReturnInst(Value* X)          - 'ret X'    instruction
1995   // ReturnInst(    null, Inst *I) - 'ret void' instruction, insert before I
1996   // ReturnInst(Value* X, Inst *I) - 'ret X'    instruction, insert before I
1997   // ReturnInst(    null, BB *B)   - 'ret void' instruction, insert @ end of B
1998   // ReturnInst(Value* X, BB *B)   - 'ret X'    instruction, insert @ end of B
1999   // ReturnInst(Value* X, N)          - 'ret X,X+1...X+N-1' instruction
2000   // ReturnInst(Value* X, N, Inst *I) - 'ret X,X+1...X+N-1', insert before I
2001   // ReturnInst(Value* X, N, BB *B)   - 'ret X,X+1...X+N-1', insert @ end of B
2002   //
2003   // NOTE: If the Value* passed is of type void then the constructor behaves as
2004   // if it was passed NULL.
2005   explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0);
2006   ReturnInst(Value *retVal, BasicBlock *InsertAtEnd);
2007   ReturnInst(Value * const* retVals, unsigned N, Instruction *InsertBefore = 0);
2008   ReturnInst(Value * const* retVals, unsigned N, BasicBlock *InsertAtEnd);
2009   explicit ReturnInst(BasicBlock *InsertAtEnd);
2010 public:
2011   static ReturnInst* Create(Value *retVal = 0, Instruction *InsertBefore = 0) {
2012     return new(!!retVal) ReturnInst(retVal, InsertBefore);
2013   }
2014   static ReturnInst* Create(Value *retVal, BasicBlock *InsertAtEnd) {
2015     return new(!!retVal) ReturnInst(retVal, InsertAtEnd);
2016   }
2017   static ReturnInst* Create(Value * const* retVals, unsigned N,
2018                             Instruction *InsertBefore = 0) {
2019     return new(N) ReturnInst(retVals, N, InsertBefore);
2020   }
2021   static ReturnInst* Create(Value * const* retVals, unsigned N,
2022                             BasicBlock *InsertAtEnd) {
2023     return new(N) ReturnInst(retVals, N, InsertAtEnd);
2024   }
2025   static ReturnInst* Create(BasicBlock *InsertAtEnd) {
2026     return new(0) ReturnInst(InsertAtEnd);
2027   }
2028   virtual ~ReturnInst();
2029   inline void operator delete(void*);
2030
2031   virtual ReturnInst *clone() const;
2032
2033   /// Provide fast operand accessors
2034   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2035
2036   /// Convenience accessor
2037   Value *getReturnValue(unsigned n = 0) const {
2038     return n < getNumOperands()
2039       ? getOperand(n)
2040       : 0;
2041   }
2042
2043   unsigned getNumSuccessors() const { return 0; }
2044
2045   // Methods for support type inquiry through isa, cast, and dyn_cast:
2046   static inline bool classof(const ReturnInst *) { return true; }
2047   static inline bool classof(const Instruction *I) {
2048     return (I->getOpcode() == Instruction::Ret);
2049   }
2050   static inline bool classof(const Value *V) {
2051     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2052   }
2053  private:
2054   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2055   virtual unsigned getNumSuccessorsV() const;
2056   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2057 };
2058
2059 template <>
2060 struct OperandTraits<ReturnInst> : VariadicOperandTraits<> {
2061 };
2062
2063 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2064 void ReturnInst::operator delete(void *it) {
2065   ReturnInst* me(static_cast<ReturnInst*>(it));
2066   Use::zap(OperandTraits<ReturnInst>::op_begin(me),
2067            OperandTraits<ReturnInst>::op_end(me),
2068            true);
2069 }
2070
2071 //===----------------------------------------------------------------------===//
2072 //                               BranchInst Class
2073 //===----------------------------------------------------------------------===//
2074
2075 //===---------------------------------------------------------------------------
2076 /// BranchInst - Conditional or Unconditional Branch instruction.
2077 ///
2078 class BranchInst : public TerminatorInst {
2079   /// Ops list - Branches are strange.  The operands are ordered:
2080   ///  TrueDest, FalseDest, Cond.  This makes some accessors faster because
2081   /// they don't have to check for cond/uncond branchness.
2082   BranchInst(const BranchInst &BI);
2083   void AssertOK();
2084   // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2085   // BranchInst(BB *B)                           - 'br B'
2086   // BranchInst(BB* T, BB *F, Value *C)          - 'br C, T, F'
2087   // BranchInst(BB* B, Inst *I)                  - 'br B'        insert before I
2088   // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2089   // BranchInst(BB* B, BB *I)                    - 'br B'        insert at end
2090   // BranchInst(BB* T, BB *F, Value *C, BB *I)   - 'br C, T, F', insert at end
2091   explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2092   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2093              Instruction *InsertBefore = 0);
2094   BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2095   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2096              BasicBlock *InsertAtEnd);
2097 public:
2098   static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2099     return new(1) BranchInst(IfTrue, InsertBefore);
2100   }
2101   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2102                             Value *Cond, Instruction *InsertBefore = 0) {
2103     return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2104   }
2105   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2106     return new(1) BranchInst(IfTrue, InsertAtEnd);
2107   }
2108   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2109                             Value *Cond, BasicBlock *InsertAtEnd) {
2110     return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2111   }
2112
2113   ~BranchInst() {
2114     if (NumOperands == 1)
2115       NumOperands = (unsigned)((Use*)this - OperandList);
2116   }
2117
2118   /// Transparently provide more efficient getOperand methods.
2119   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2120
2121   virtual BranchInst *clone() const;
2122
2123   bool isUnconditional() const { return getNumOperands() == 1; }
2124   bool isConditional()   const { return getNumOperands() == 3; }
2125
2126   Value *getCondition() const {
2127     assert(isConditional() && "Cannot get condition of an uncond branch!");
2128     return getOperand(2);
2129   }
2130
2131   void setCondition(Value *V) {
2132     assert(isConditional() && "Cannot set condition of unconditional branch!");
2133     setOperand(2, V);
2134   }
2135
2136   // setUnconditionalDest - Change the current branch to an unconditional branch
2137   // targeting the specified block.
2138   // FIXME: Eliminate this ugly method.
2139   void setUnconditionalDest(BasicBlock *Dest) {
2140     Op<0>() = Dest;
2141     if (isConditional()) {  // Convert this to an uncond branch.
2142       Op<1>().set(0);
2143       Op<2>().set(0);
2144       NumOperands = 1;
2145     }
2146   }
2147
2148   unsigned getNumSuccessors() const { return 1+isConditional(); }
2149
2150   BasicBlock *getSuccessor(unsigned i) const {
2151     assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2152     return cast<BasicBlock>(getOperand(i));
2153   }
2154
2155   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2156     assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2157     setOperand(idx, NewSucc);
2158   }
2159
2160   // Methods for support type inquiry through isa, cast, and dyn_cast:
2161   static inline bool classof(const BranchInst *) { return true; }
2162   static inline bool classof(const Instruction *I) {
2163     return (I->getOpcode() == Instruction::Br);
2164   }
2165   static inline bool classof(const Value *V) {
2166     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2167   }
2168 private:
2169   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2170   virtual unsigned getNumSuccessorsV() const;
2171   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2172 };
2173
2174 template <>
2175 struct OperandTraits<BranchInst> : HungoffOperandTraits<> {
2176   // we need to access operands via OperandList, since
2177   // the NumOperands may change from 3 to 1
2178   static inline void *allocate(unsigned); // FIXME
2179 };
2180
2181 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2182
2183 //===----------------------------------------------------------------------===//
2184 //                               SwitchInst Class
2185 //===----------------------------------------------------------------------===//
2186
2187 //===---------------------------------------------------------------------------
2188 /// SwitchInst - Multiway switch
2189 ///
2190 class SwitchInst : public TerminatorInst {
2191   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
2192   unsigned ReservedSpace;
2193   // Operand[0]    = Value to switch on
2194   // Operand[1]    = Default basic block destination
2195   // Operand[2n  ] = Value to match
2196   // Operand[2n+1] = BasicBlock to go to on match
2197   SwitchInst(const SwitchInst &RI);
2198   void init(Value *Value, BasicBlock *Default, unsigned NumCases);
2199   void resizeOperands(unsigned No);
2200   // allocate space for exactly zero operands
2201   void *operator new(size_t s) {
2202     return User::operator new(s, 0);
2203   }
2204   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2205   /// switch on and a default destination.  The number of additional cases can
2206   /// be specified here to make memory allocation more efficient.  This
2207   /// constructor can also autoinsert before another instruction.
2208   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2209              Instruction *InsertBefore = 0);
2210
2211   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2212   /// switch on and a default destination.  The number of additional cases can
2213   /// be specified here to make memory allocation more efficient.  This
2214   /// constructor also autoinserts at the end of the specified BasicBlock.
2215   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2216              BasicBlock *InsertAtEnd);
2217 public:
2218   static SwitchInst *Create(Value *Value, BasicBlock *Default,
2219                             unsigned NumCases, Instruction *InsertBefore = 0) {
2220     return new SwitchInst(Value, Default, NumCases, InsertBefore);
2221   }
2222   static SwitchInst *Create(Value *Value, BasicBlock *Default,
2223                             unsigned NumCases, BasicBlock *InsertAtEnd) {
2224     return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2225   }
2226   ~SwitchInst();
2227
2228   /// Provide fast operand accessors
2229   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2230
2231   // Accessor Methods for Switch stmt
2232   Value *getCondition() const { return getOperand(0); }
2233   void setCondition(Value *V) { setOperand(0, V); }
2234
2235   BasicBlock *getDefaultDest() const {
2236     return cast<BasicBlock>(getOperand(1));
2237   }
2238
2239   /// getNumCases - return the number of 'cases' in this switch instruction.
2240   /// Note that case #0 is always the default case.
2241   unsigned getNumCases() const {
2242     return getNumOperands()/2;
2243   }
2244
2245   /// getCaseValue - Return the specified case value.  Note that case #0, the
2246   /// default destination, does not have a case value.
2247   ConstantInt *getCaseValue(unsigned i) {
2248     assert(i && i < getNumCases() && "Illegal case value to get!");
2249     return getSuccessorValue(i);
2250   }
2251
2252   /// getCaseValue - Return the specified case value.  Note that case #0, the
2253   /// default destination, does not have a case value.
2254   const ConstantInt *getCaseValue(unsigned i) const {
2255     assert(i && i < getNumCases() && "Illegal case value to get!");
2256     return getSuccessorValue(i);
2257   }
2258
2259   /// findCaseValue - Search all of the case values for the specified constant.
2260   /// If it is explicitly handled, return the case number of it, otherwise
2261   /// return 0 to indicate that it is handled by the default handler.
2262   unsigned findCaseValue(const ConstantInt *C) const {
2263     for (unsigned i = 1, e = getNumCases(); i != e; ++i)
2264       if (getCaseValue(i) == C)
2265         return i;
2266     return 0;
2267   }
2268
2269   /// findCaseDest - Finds the unique case value for a given successor. Returns
2270   /// null if the successor is not found, not unique, or is the default case.
2271   ConstantInt *findCaseDest(BasicBlock *BB) {
2272     if (BB == getDefaultDest()) return NULL;
2273
2274     ConstantInt *CI = NULL;
2275     for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
2276       if (getSuccessor(i) == BB) {
2277         if (CI) return NULL;   // Multiple cases lead to BB.
2278         else CI = getCaseValue(i);
2279       }
2280     }
2281     return CI;
2282   }
2283
2284   /// addCase - Add an entry to the switch instruction...
2285   ///
2286   void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2287
2288   /// removeCase - This method removes the specified successor from the switch
2289   /// instruction.  Note that this cannot be used to remove the default
2290   /// destination (successor #0).
2291   ///
2292   void removeCase(unsigned idx);
2293
2294   virtual SwitchInst *clone() const;
2295
2296   unsigned getNumSuccessors() const { return getNumOperands()/2; }
2297   BasicBlock *getSuccessor(unsigned idx) const {
2298     assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2299     return cast<BasicBlock>(getOperand(idx*2+1));
2300   }
2301   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2302     assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2303     setOperand(idx*2+1, NewSucc);
2304   }
2305
2306   // getSuccessorValue - Return the value associated with the specified
2307   // successor.
2308   ConstantInt *getSuccessorValue(unsigned idx) const {
2309     assert(idx < getNumSuccessors() && "Successor # out of range!");
2310     return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
2311   }
2312
2313   // Methods for support type inquiry through isa, cast, and dyn_cast:
2314   static inline bool classof(const SwitchInst *) { return true; }
2315   static inline bool classof(const Instruction *I) {
2316     return I->getOpcode() == Instruction::Switch;
2317   }
2318   static inline bool classof(const Value *V) {
2319     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2320   }
2321 private:
2322   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2323   virtual unsigned getNumSuccessorsV() const;
2324   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2325 };
2326
2327 template <>
2328 struct OperandTraits<SwitchInst> : HungoffOperandTraits<2> {
2329 };
2330
2331 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2332
2333
2334 //===----------------------------------------------------------------------===//
2335 //                               InvokeInst Class
2336 //===----------------------------------------------------------------------===//
2337
2338 /// InvokeInst - Invoke instruction.  The SubclassData field is used to hold the
2339 /// calling convention of the call.
2340 ///
2341 class InvokeInst : public TerminatorInst {
2342   PAListPtr ParamAttrs;
2343   InvokeInst(const InvokeInst &BI);
2344   void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
2345             Value* const *Args, unsigned NumArgs);
2346
2347   template<typename InputIterator>
2348   void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2349             InputIterator ArgBegin, InputIterator ArgEnd,
2350             const std::string &Name,
2351             // This argument ensures that we have an iterator we can
2352             // do arithmetic on in constant time
2353             std::random_access_iterator_tag) {
2354     unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
2355
2356     // This requires that the iterator points to contiguous memory.
2357     init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
2358     setName(Name);
2359   }
2360
2361   /// Construct an InvokeInst given a range of arguments.
2362   /// InputIterator must be a random-access iterator pointing to
2363   /// contiguous storage (e.g. a std::vector<>::iterator).  Checks are
2364   /// made for random-accessness but not for contiguous storage as
2365   /// that would incur runtime overhead.
2366   ///
2367   /// @brief Construct an InvokeInst from a range of arguments
2368   template<typename InputIterator>
2369   inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2370                     InputIterator ArgBegin, InputIterator ArgEnd,
2371                     unsigned Values,
2372                     const std::string &Name, Instruction *InsertBefore);
2373
2374   /// Construct an InvokeInst given a range of arguments.
2375   /// InputIterator must be a random-access iterator pointing to
2376   /// contiguous storage (e.g. a std::vector<>::iterator).  Checks are
2377   /// made for random-accessness but not for contiguous storage as
2378   /// that would incur runtime overhead.
2379   ///
2380   /// @brief Construct an InvokeInst from a range of arguments
2381   template<typename InputIterator>
2382   inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2383                     InputIterator ArgBegin, InputIterator ArgEnd,
2384                     unsigned Values,
2385                     const std::string &Name, BasicBlock *InsertAtEnd);
2386 public:
2387   template<typename InputIterator>
2388   static InvokeInst *Create(Value *Func,
2389                             BasicBlock *IfNormal, BasicBlock *IfException,
2390                             InputIterator ArgBegin, InputIterator ArgEnd,
2391                             const std::string &Name = "",
2392                             Instruction *InsertBefore = 0) {
2393     unsigned Values(ArgEnd - ArgBegin + 3);
2394     return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2395                                   Values, Name, InsertBefore);
2396   }
2397   template<typename InputIterator>
2398   static InvokeInst *Create(Value *Func,
2399                             BasicBlock *IfNormal, BasicBlock *IfException,
2400                             InputIterator ArgBegin, InputIterator ArgEnd,
2401                             const std::string &Name, BasicBlock *InsertAtEnd) {
2402     unsigned Values(ArgEnd - ArgBegin + 3);
2403     return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2404                                   Values, Name, InsertAtEnd);
2405   }
2406
2407   virtual InvokeInst *clone() const;
2408
2409   /// Provide fast operand accessors
2410   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2411
2412   /// getCallingConv/setCallingConv - Get or set the calling convention of this
2413   /// function call.
2414   unsigned getCallingConv() const { return SubclassData; }
2415   void setCallingConv(unsigned CC) {
2416     SubclassData = CC;
2417   }
2418
2419   /// getParamAttrs - Return the parameter attributes for this invoke.
2420   ///
2421   const PAListPtr &getParamAttrs() const { return ParamAttrs; }
2422
2423   /// setParamAttrs - Set the parameter attributes for this invoke.
2424   ///
2425   void setParamAttrs(const PAListPtr &Attrs) { ParamAttrs = Attrs; }
2426
2427   /// @brief Determine whether the call or the callee has the given attribute.
2428   bool paramHasAttr(unsigned i, ParameterAttributes attr) const;
2429
2430   /// addParamAttr - adds the attribute to the list of attributes.
2431   void addParamAttr(unsigned i, ParameterAttributes attr);
2432
2433   /// @brief Extract the alignment for a call or parameter (0=unknown).
2434   unsigned getParamAlignment(unsigned i) const {
2435     return ParamAttrs.getParamAlignment(i);
2436   }
2437
2438   /// @brief Determine if the call does not access memory.
2439   bool doesNotAccessMemory() const {
2440     return paramHasAttr(0, ParamAttr::ReadNone);
2441   }
2442
2443   /// @brief Determine if the call does not access or only reads memory.
2444   bool onlyReadsMemory() const {
2445     return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
2446   }
2447
2448   /// @brief Determine if the call cannot return.
2449   bool doesNotReturn() const {
2450     return paramHasAttr(0, ParamAttr::NoReturn);
2451   }
2452
2453   /// @brief Determine if the call cannot unwind.
2454   bool doesNotThrow() const {
2455     return paramHasAttr(0, ParamAttr::NoUnwind);
2456   }
2457   void setDoesNotThrow(bool doesNotThrow = true);
2458
2459   /// @brief Determine if the call returns a structure through first
2460   /// pointer argument.
2461   bool hasStructRetAttr() const {
2462     // Be friendly and also check the callee.
2463     return paramHasAttr(1, ParamAttr::StructRet);
2464   }
2465
2466   /// getCalledFunction - Return the function called, or null if this is an
2467   /// indirect function invocation.
2468   ///
2469   Function *getCalledFunction() const {
2470     return dyn_cast<Function>(getOperand(0));
2471   }
2472
2473   // getCalledValue - Get a pointer to a function that is invoked by this inst.
2474   Value *getCalledValue() const { return getOperand(0); }
2475
2476   // get*Dest - Return the destination basic blocks...
2477   BasicBlock *getNormalDest() const {
2478     return cast<BasicBlock>(getOperand(1));
2479   }
2480   BasicBlock *getUnwindDest() const {
2481     return cast<BasicBlock>(getOperand(2));
2482   }
2483   void setNormalDest(BasicBlock *B) {
2484     setOperand(1, B);
2485   }
2486
2487   void setUnwindDest(BasicBlock *B) {
2488     setOperand(2, B);
2489   }
2490
2491   BasicBlock *getSuccessor(unsigned i) const {
2492     assert(i < 2 && "Successor # out of range for invoke!");
2493     return i == 0 ? getNormalDest() : getUnwindDest();
2494   }
2495
2496   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2497     assert(idx < 2 && "Successor # out of range for invoke!");
2498     setOperand(idx+1, NewSucc);
2499   }
2500
2501   unsigned getNumSuccessors() const { return 2; }
2502
2503   // Methods for support type inquiry through isa, cast, and dyn_cast:
2504   static inline bool classof(const InvokeInst *) { return true; }
2505   static inline bool classof(const Instruction *I) {
2506     return (I->getOpcode() == Instruction::Invoke);
2507   }
2508   static inline bool classof(const Value *V) {
2509     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2510   }
2511 private:
2512   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2513   virtual unsigned getNumSuccessorsV() const;
2514   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2515 };
2516
2517 template <>
2518 struct OperandTraits<InvokeInst> : VariadicOperandTraits<3> {
2519 };
2520
2521 template<typename InputIterator>
2522 InvokeInst::InvokeInst(Value *Func,
2523                        BasicBlock *IfNormal, BasicBlock *IfException,
2524                        InputIterator ArgBegin, InputIterator ArgEnd,
2525                        unsigned Values,
2526                        const std::string &Name, Instruction *InsertBefore)
2527   : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2528                                       ->getElementType())->getReturnType(),
2529                    Instruction::Invoke,
2530                    OperandTraits<InvokeInst>::op_end(this) - Values,
2531                    Values, InsertBefore) {
2532   init(Func, IfNormal, IfException, ArgBegin, ArgEnd, Name,
2533        typename std::iterator_traits<InputIterator>::iterator_category());
2534 }
2535 template<typename InputIterator>
2536 InvokeInst::InvokeInst(Value *Func,
2537                        BasicBlock *IfNormal, BasicBlock *IfException,
2538                        InputIterator ArgBegin, InputIterator ArgEnd,
2539                        unsigned Values,
2540                        const std::string &Name, BasicBlock *InsertAtEnd)
2541   : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2542                                       ->getElementType())->getReturnType(),
2543                    Instruction::Invoke,
2544                    OperandTraits<InvokeInst>::op_end(this) - Values,
2545                    Values, InsertAtEnd) {
2546   init(Func, IfNormal, IfException, ArgBegin, ArgEnd, Name,
2547        typename std::iterator_traits<InputIterator>::iterator_category());
2548 }
2549
2550 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
2551
2552 //===----------------------------------------------------------------------===//
2553 //                              UnwindInst Class
2554 //===----------------------------------------------------------------------===//
2555
2556 //===---------------------------------------------------------------------------
2557 /// UnwindInst - Immediately exit the current function, unwinding the stack
2558 /// until an invoke instruction is found.
2559 ///
2560 class UnwindInst : public TerminatorInst {
2561   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
2562 public:
2563   // allocate space for exactly zero operands
2564   void *operator new(size_t s) {
2565     return User::operator new(s, 0);
2566   }
2567   explicit UnwindInst(Instruction *InsertBefore = 0);
2568   explicit UnwindInst(BasicBlock *InsertAtEnd);
2569
2570   virtual UnwindInst *clone() const;
2571
2572   unsigned getNumSuccessors() const { return 0; }
2573
2574   // Methods for support type inquiry through isa, cast, and dyn_cast:
2575   static inline bool classof(const UnwindInst *) { return true; }
2576   static inline bool classof(const Instruction *I) {
2577     return I->getOpcode() == Instruction::Unwind;
2578   }
2579   static inline bool classof(const Value *V) {
2580     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2581   }
2582 private:
2583   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2584   virtual unsigned getNumSuccessorsV() const;
2585   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2586 };
2587
2588 //===----------------------------------------------------------------------===//
2589 //                           UnreachableInst Class
2590 //===----------------------------------------------------------------------===//
2591
2592 //===---------------------------------------------------------------------------
2593 /// UnreachableInst - This function has undefined behavior.  In particular, the
2594 /// presence of this instruction indicates some higher level knowledge that the
2595 /// end of the block cannot be reached.
2596 ///
2597 class UnreachableInst : public TerminatorInst {
2598   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
2599 public:
2600   // allocate space for exactly zero operands
2601   void *operator new(size_t s) {
2602     return User::operator new(s, 0);
2603   }
2604   explicit UnreachableInst(Instruction *InsertBefore = 0);
2605   explicit UnreachableInst(BasicBlock *InsertAtEnd);
2606
2607   virtual UnreachableInst *clone() const;
2608
2609   unsigned getNumSuccessors() const { return 0; }
2610
2611   // Methods for support type inquiry through isa, cast, and dyn_cast:
2612   static inline bool classof(const UnreachableInst *) { return true; }
2613   static inline bool classof(const Instruction *I) {
2614     return I->getOpcode() == Instruction::Unreachable;
2615   }
2616   static inline bool classof(const Value *V) {
2617     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2618   }
2619 private:
2620   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2621   virtual unsigned getNumSuccessorsV() const;
2622   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2623 };
2624
2625 //===----------------------------------------------------------------------===//
2626 //                                 TruncInst Class
2627 //===----------------------------------------------------------------------===//
2628
2629 /// @brief This class represents a truncation of integer types.
2630 class TruncInst : public CastInst {
2631   /// Private copy constructor
2632   TruncInst(const TruncInst &CI)
2633     : CastInst(CI.getType(), Trunc, CI.getOperand(0)) {
2634   }
2635 public:
2636   /// @brief Constructor with insert-before-instruction semantics
2637   TruncInst(
2638     Value *S,                     ///< The value to be truncated
2639     const Type *Ty,               ///< The (smaller) type to truncate to
2640     const std::string &Name = "", ///< A name for the new instruction
2641     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2642   );
2643
2644   /// @brief Constructor with insert-at-end-of-block semantics
2645   TruncInst(
2646     Value *S,                     ///< The value to be truncated
2647     const Type *Ty,               ///< The (smaller) type to truncate to
2648     const std::string &Name,      ///< A name for the new instruction
2649     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2650   );
2651
2652   /// @brief Clone an identical TruncInst
2653   virtual CastInst *clone() const;
2654
2655   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2656   static inline bool classof(const TruncInst *) { return true; }
2657   static inline bool classof(const Instruction *I) {
2658     return I->getOpcode() == Trunc;
2659   }
2660   static inline bool classof(const Value *V) {
2661     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2662   }
2663 };
2664
2665 //===----------------------------------------------------------------------===//
2666 //                                 ZExtInst Class
2667 //===----------------------------------------------------------------------===//
2668
2669 /// @brief This class represents zero extension of integer types.
2670 class ZExtInst : public CastInst {
2671   /// @brief Private copy constructor
2672   ZExtInst(const ZExtInst &CI)
2673     : CastInst(CI.getType(), ZExt, CI.getOperand(0)) {
2674   }
2675 public:
2676   /// @brief Constructor with insert-before-instruction semantics
2677   ZExtInst(
2678     Value *S,                     ///< The value to be zero extended
2679     const Type *Ty,               ///< The type to zero extend to
2680     const std::string &Name = "", ///< A name for the new instruction
2681     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2682   );
2683
2684   /// @brief Constructor with insert-at-end semantics.
2685   ZExtInst(
2686     Value *S,                     ///< The value to be zero extended
2687     const Type *Ty,               ///< The type to zero extend to
2688     const std::string &Name,      ///< A name for the new instruction
2689     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2690   );
2691
2692   /// @brief Clone an identical ZExtInst
2693   virtual CastInst *clone() const;
2694
2695   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2696   static inline bool classof(const ZExtInst *) { return true; }
2697   static inline bool classof(const Instruction *I) {
2698     return I->getOpcode() == ZExt;
2699   }
2700   static inline bool classof(const Value *V) {
2701     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2702   }
2703 };
2704
2705 //===----------------------------------------------------------------------===//
2706 //                                 SExtInst Class
2707 //===----------------------------------------------------------------------===//
2708
2709 /// @brief This class represents a sign extension of integer types.
2710 class SExtInst : public CastInst {
2711   /// @brief Private copy constructor
2712   SExtInst(const SExtInst &CI)
2713     : CastInst(CI.getType(), SExt, CI.getOperand(0)) {
2714   }
2715 public:
2716   /// @brief Constructor with insert-before-instruction semantics
2717   SExtInst(
2718     Value *S,                     ///< The value to be sign extended
2719     const Type *Ty,               ///< The type to sign extend to
2720     const std::string &Name = "", ///< A name for the new instruction
2721     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2722   );
2723
2724   /// @brief Constructor with insert-at-end-of-block semantics
2725   SExtInst(
2726     Value *S,                     ///< The value to be sign extended
2727     const Type *Ty,               ///< The type to sign extend to
2728     const std::string &Name,      ///< A name for the new instruction
2729     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2730   );
2731
2732   /// @brief Clone an identical SExtInst
2733   virtual CastInst *clone() const;
2734
2735   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2736   static inline bool classof(const SExtInst *) { return true; }
2737   static inline bool classof(const Instruction *I) {
2738     return I->getOpcode() == SExt;
2739   }
2740   static inline bool classof(const Value *V) {
2741     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2742   }
2743 };
2744
2745 //===----------------------------------------------------------------------===//
2746 //                                 FPTruncInst Class
2747 //===----------------------------------------------------------------------===//
2748
2749 /// @brief This class represents a truncation of floating point types.
2750 class FPTruncInst : public CastInst {
2751   FPTruncInst(const FPTruncInst &CI)
2752     : CastInst(CI.getType(), FPTrunc, CI.getOperand(0)) {
2753   }
2754 public:
2755   /// @brief Constructor with insert-before-instruction semantics
2756   FPTruncInst(
2757     Value *S,                     ///< The value to be truncated
2758     const Type *Ty,               ///< The type to truncate to
2759     const std::string &Name = "", ///< A name for the new instruction
2760     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2761   );
2762
2763   /// @brief Constructor with insert-before-instruction semantics
2764   FPTruncInst(
2765     Value *S,                     ///< The value to be truncated
2766     const Type *Ty,               ///< The type to truncate to
2767     const std::string &Name,      ///< A name for the new instruction
2768     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2769   );
2770
2771   /// @brief Clone an identical FPTruncInst
2772   virtual CastInst *clone() const;
2773
2774   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2775   static inline bool classof(const FPTruncInst *) { return true; }
2776   static inline bool classof(const Instruction *I) {
2777     return I->getOpcode() == FPTrunc;
2778   }
2779   static inline bool classof(const Value *V) {
2780     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2781   }
2782 };
2783
2784 //===----------------------------------------------------------------------===//
2785 //                                 FPExtInst Class
2786 //===----------------------------------------------------------------------===//
2787
2788 /// @brief This class represents an extension of floating point types.
2789 class FPExtInst : public CastInst {
2790   FPExtInst(const FPExtInst &CI)
2791     : CastInst(CI.getType(), FPExt, CI.getOperand(0)) {
2792   }
2793 public:
2794   /// @brief Constructor with insert-before-instruction semantics
2795   FPExtInst(
2796     Value *S,                     ///< The value to be extended
2797     const Type *Ty,               ///< The type to extend to
2798     const std::string &Name = "", ///< A name for the new instruction
2799     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2800   );
2801
2802   /// @brief Constructor with insert-at-end-of-block semantics
2803   FPExtInst(
2804     Value *S,                     ///< The value to be extended
2805     const Type *Ty,               ///< The type to extend to
2806     const std::string &Name,      ///< A name for the new instruction
2807     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2808   );
2809
2810   /// @brief Clone an identical FPExtInst
2811   virtual CastInst *clone() const;
2812
2813   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2814   static inline bool classof(const FPExtInst *) { return true; }
2815   static inline bool classof(const Instruction *I) {
2816     return I->getOpcode() == FPExt;
2817   }
2818   static inline bool classof(const Value *V) {
2819     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2820   }
2821 };
2822
2823 //===----------------------------------------------------------------------===//
2824 //                                 UIToFPInst Class
2825 //===----------------------------------------------------------------------===//
2826
2827 /// @brief This class represents a cast unsigned integer to floating point.
2828 class UIToFPInst : public CastInst {
2829   UIToFPInst(const UIToFPInst &CI)
2830     : CastInst(CI.getType(), UIToFP, CI.getOperand(0)) {
2831   }
2832 public:
2833   /// @brief Constructor with insert-before-instruction semantics
2834   UIToFPInst(
2835     Value *S,                     ///< The value to be converted
2836     const Type *Ty,               ///< The type to convert to
2837     const std::string &Name = "", ///< A name for the new instruction
2838     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2839   );
2840
2841   /// @brief Constructor with insert-at-end-of-block semantics
2842   UIToFPInst(
2843     Value *S,                     ///< The value to be converted
2844     const Type *Ty,               ///< The type to convert to
2845     const std::string &Name,      ///< A name for the new instruction
2846     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2847   );
2848
2849   /// @brief Clone an identical UIToFPInst
2850   virtual CastInst *clone() const;
2851
2852   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2853   static inline bool classof(const UIToFPInst *) { return true; }
2854   static inline bool classof(const Instruction *I) {
2855     return I->getOpcode() == UIToFP;
2856   }
2857   static inline bool classof(const Value *V) {
2858     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2859   }
2860 };
2861
2862 //===----------------------------------------------------------------------===//
2863 //                                 SIToFPInst Class
2864 //===----------------------------------------------------------------------===//
2865
2866 /// @brief This class represents a cast from signed integer to floating point.
2867 class SIToFPInst : public CastInst {
2868   SIToFPInst(const SIToFPInst &CI)
2869     : CastInst(CI.getType(), SIToFP, CI.getOperand(0)) {
2870   }
2871 public:
2872   /// @brief Constructor with insert-before-instruction semantics
2873   SIToFPInst(
2874     Value *S,                     ///< The value to be converted
2875     const Type *Ty,               ///< The type to convert to
2876     const std::string &Name = "", ///< A name for the new instruction
2877     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2878   );
2879
2880   /// @brief Constructor with insert-at-end-of-block semantics
2881   SIToFPInst(
2882     Value *S,                     ///< The value to be converted
2883     const Type *Ty,               ///< The type to convert to
2884     const std::string &Name,      ///< A name for the new instruction
2885     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2886   );
2887
2888   /// @brief Clone an identical SIToFPInst
2889   virtual CastInst *clone() const;
2890
2891   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2892   static inline bool classof(const SIToFPInst *) { return true; }
2893   static inline bool classof(const Instruction *I) {
2894     return I->getOpcode() == SIToFP;
2895   }
2896   static inline bool classof(const Value *V) {
2897     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2898   }
2899 };
2900
2901 //===----------------------------------------------------------------------===//
2902 //                                 FPToUIInst Class
2903 //===----------------------------------------------------------------------===//
2904
2905 /// @brief This class represents a cast from floating point to unsigned integer
2906 class FPToUIInst  : public CastInst {
2907   FPToUIInst(const FPToUIInst &CI)
2908     : CastInst(CI.getType(), FPToUI, CI.getOperand(0)) {
2909   }
2910 public:
2911   /// @brief Constructor with insert-before-instruction semantics
2912   FPToUIInst(
2913     Value *S,                     ///< The value to be converted
2914     const Type *Ty,               ///< The type to convert to
2915     const std::string &Name = "", ///< A name for the new instruction
2916     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2917   );
2918
2919   /// @brief Constructor with insert-at-end-of-block semantics
2920   FPToUIInst(
2921     Value *S,                     ///< The value to be converted
2922     const Type *Ty,               ///< The type to convert to
2923     const std::string &Name,      ///< A name for the new instruction
2924     BasicBlock *InsertAtEnd       ///< Where to insert the new instruction
2925   );
2926
2927   /// @brief Clone an identical FPToUIInst
2928   virtual CastInst *clone() const;
2929
2930   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2931   static inline bool classof(const FPToUIInst *) { return true; }
2932   static inline bool classof(const Instruction *I) {
2933     return I->getOpcode() == FPToUI;
2934   }
2935   static inline bool classof(const Value *V) {
2936     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2937   }
2938 };
2939
2940 //===----------------------------------------------------------------------===//
2941 //                                 FPToSIInst Class
2942 //===----------------------------------------------------------------------===//
2943
2944 /// @brief This class represents a cast from floating point to signed integer.
2945 class FPToSIInst  : public CastInst {
2946   FPToSIInst(const FPToSIInst &CI)
2947     : CastInst(CI.getType(), FPToSI, CI.getOperand(0)) {
2948   }
2949 public:
2950   /// @brief Constructor with insert-before-instruction semantics
2951   FPToSIInst(
2952     Value *S,                     ///< The value to be converted
2953     const Type *Ty,               ///< The type to convert to
2954     const std::string &Name = "", ///< A name for the new instruction
2955     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2956   );
2957
2958   /// @brief Constructor with insert-at-end-of-block semantics
2959   FPToSIInst(
2960     Value *S,                     ///< The value to be converted
2961     const Type *Ty,               ///< The type to convert to
2962     const std::string &Name,      ///< A name for the new instruction
2963     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
2964   );
2965
2966   /// @brief Clone an identical FPToSIInst
2967   virtual CastInst *clone() const;
2968
2969   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2970   static inline bool classof(const FPToSIInst *) { return true; }
2971   static inline bool classof(const Instruction *I) {
2972     return I->getOpcode() == FPToSI;
2973   }
2974   static inline bool classof(const Value *V) {
2975     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2976   }
2977 };
2978
2979 //===----------------------------------------------------------------------===//
2980 //                                 IntToPtrInst Class
2981 //===----------------------------------------------------------------------===//
2982
2983 /// @brief This class represents a cast from an integer to a pointer.
2984 class IntToPtrInst : public CastInst {
2985   IntToPtrInst(const IntToPtrInst &CI)
2986     : CastInst(CI.getType(), IntToPtr, CI.getOperand(0)) {
2987   }
2988 public:
2989   /// @brief Constructor with insert-before-instruction semantics
2990   IntToPtrInst(
2991     Value *S,                     ///< The value to be converted
2992     const Type *Ty,               ///< The type to convert to
2993     const std::string &Name = "", ///< A name for the new instruction
2994     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2995   );
2996
2997   /// @brief Constructor with insert-at-end-of-block semantics
2998   IntToPtrInst(
2999     Value *S,                     ///< The value to be converted
3000     const Type *Ty,               ///< The type to convert to
3001     const std::string &Name,      ///< A name for the new instruction
3002     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3003   );
3004
3005   /// @brief Clone an identical IntToPtrInst
3006   virtual CastInst *clone() const;
3007
3008   // Methods for support type inquiry through isa, cast, and dyn_cast:
3009   static inline bool classof(const IntToPtrInst *) { return true; }
3010   static inline bool classof(const Instruction *I) {
3011     return I->getOpcode() == IntToPtr;
3012   }
3013   static inline bool classof(const Value *V) {
3014     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3015   }
3016 };
3017
3018 //===----------------------------------------------------------------------===//
3019 //                                 PtrToIntInst Class
3020 //===----------------------------------------------------------------------===//
3021
3022 /// @brief This class represents a cast from a pointer to an integer
3023 class PtrToIntInst : public CastInst {
3024   PtrToIntInst(const PtrToIntInst &CI)
3025     : CastInst(CI.getType(), PtrToInt, CI.getOperand(0)) {
3026   }
3027 public:
3028   /// @brief Constructor with insert-before-instruction semantics
3029   PtrToIntInst(
3030     Value *S,                     ///< The value to be converted
3031     const Type *Ty,               ///< The type to convert to
3032     const std::string &Name = "", ///< A name for the new instruction
3033     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3034   );
3035
3036   /// @brief Constructor with insert-at-end-of-block semantics
3037   PtrToIntInst(
3038     Value *S,                     ///< The value to be converted
3039     const Type *Ty,               ///< The type to convert to
3040     const std::string &Name,      ///< A name for the new instruction
3041     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3042   );
3043
3044   /// @brief Clone an identical PtrToIntInst
3045   virtual CastInst *clone() const;
3046
3047   // Methods for support type inquiry through isa, cast, and dyn_cast:
3048   static inline bool classof(const PtrToIntInst *) { return true; }
3049   static inline bool classof(const Instruction *I) {
3050     return I->getOpcode() == PtrToInt;
3051   }
3052   static inline bool classof(const Value *V) {
3053     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3054   }
3055 };
3056
3057 //===----------------------------------------------------------------------===//
3058 //                             BitCastInst Class
3059 //===----------------------------------------------------------------------===//
3060
3061 /// @brief This class represents a no-op cast from one type to another.
3062 class BitCastInst : public CastInst {
3063   BitCastInst(const BitCastInst &CI)
3064     : CastInst(CI.getType(), BitCast, CI.getOperand(0)) {
3065   }
3066 public:
3067   /// @brief Constructor with insert-before-instruction semantics
3068   BitCastInst(
3069     Value *S,                     ///< The value to be casted
3070     const Type *Ty,               ///< The type to casted to
3071     const std::string &Name = "", ///< A name for the new instruction
3072     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3073   );
3074
3075   /// @brief Constructor with insert-at-end-of-block semantics
3076   BitCastInst(
3077     Value *S,                     ///< The value to be casted
3078     const Type *Ty,               ///< The type to casted to
3079     const std::string &Name,      ///< A name for the new instruction
3080     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3081   );
3082
3083   /// @brief Clone an identical BitCastInst
3084   virtual CastInst *clone() const;
3085
3086   // Methods for support type inquiry through isa, cast, and dyn_cast:
3087   static inline bool classof(const BitCastInst *) { return true; }
3088   static inline bool classof(const Instruction *I) {
3089     return I->getOpcode() == BitCast;
3090   }
3091   static inline bool classof(const Value *V) {
3092     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3093   }
3094 };
3095
3096 //===----------------------------------------------------------------------===//
3097 //                             GetResultInst Class
3098 //===----------------------------------------------------------------------===//
3099
3100 /// GetResultInst - This instruction extracts individual result value from
3101 /// aggregate value, where aggregate value is returned by CallInst.
3102 ///
3103 class GetResultInst : public UnaryInstruction {
3104   unsigned Idx;
3105   GetResultInst(const GetResultInst &GRI) :
3106     UnaryInstruction(GRI.getType(), Instruction::GetResult, GRI.getOperand(0)),
3107     Idx(GRI.Idx) {
3108   }
3109
3110 public:
3111   GetResultInst(Value *Aggr, unsigned index,
3112                 const std::string &Name = "",
3113                 Instruction *InsertBefore = 0);
3114
3115   /// isValidOperands - Return true if an getresult instruction can be
3116   /// formed with the specified operands.
3117   static bool isValidOperands(const Value *Aggr, unsigned index);
3118
3119   virtual GetResultInst *clone() const;
3120
3121   Value *getAggregateValue() {
3122     return getOperand(0);
3123   }
3124
3125   const Value *getAggregateValue() const {
3126     return getOperand(0);
3127   }
3128
3129   unsigned getIndex() const {
3130     return Idx;
3131   }
3132
3133   // Methods for support type inquiry through isa, cast, and dyn_cast:
3134   static inline bool classof(const GetResultInst *) { return true; }
3135   static inline bool classof(const Instruction *I) {
3136     return (I->getOpcode() == Instruction::GetResult);
3137   }
3138   static inline bool classof(const Value *V) {
3139     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3140   }
3141 };
3142
3143 } // End llvm namespace
3144
3145 #endif