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