include/llvm/Instructions.h

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