include/llvm/Instructions.h

   1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file exposes the class definitions of all of the subclasses of the
  11 // Instruction class.  This is meant to be an easy way to get access to all
  12 // instruction subclasses.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_INSTRUCTIONS_H
  17 #define LLVM_INSTRUCTIONS_H
  18
  19 #include "llvm/InstrTypes.h"
  20
  21 namespace llvm {
  22
  23 class BasicBlock;
  24 class ConstantInt;
  25 class PointerType;
  26 class PackedType;
  27
  28 //===----------------------------------------------------------------------===//
  29 //                             AllocationInst Class
  30 //===----------------------------------------------------------------------===//
  31
  32 /// AllocationInst - This class is the common base class of MallocInst and
  33 /// AllocaInst.
  34 ///
  35 class AllocationInst : public UnaryInstruction {
  36   unsigned Alignment;
  37 protected:
  38   AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
  39                  const std::string &Name = "", Instruction *InsertBefore = 0);
  40   AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
  41                  const std::string &Name, BasicBlock *InsertAtEnd);
  42 public:
  43   // Out of line virtual method, so the vtable, etc has a home.
  44   virtual ~AllocationInst();
  45
  46   /// isArrayAllocation - Return true if there is an allocation size parameter
  47   /// to the allocation instruction that is not 1.
  48   ///
  49   bool isArrayAllocation() const;
  50
  51   /// getArraySize - Get the number of element allocated, for a simple
  52   /// allocation of a single element, this will return a constant 1 value.
  53   ///
  54   inline const Value *getArraySize() const { return getOperand(0); }
  55   inline Value *getArraySize() { return getOperand(0); }
  56
  57   /// getType - Overload to return most specific pointer type
  58   ///
  59   inline const PointerType *getType() const {
  60     return reinterpret_cast<const PointerType*>(Instruction::getType());
  61   }
  62
  63   /// getAllocatedType - Return the type that is being allocated by the
  64   /// instruction.
  65   ///
  66   const Type *getAllocatedType() const;
  67
  68   /// getAlignment - Return the alignment of the memory that is being allocated
  69   /// by the instruction.
  70   ///
  71   unsigned getAlignment() const { return Alignment; }
  72   void setAlignment(unsigned Align) {
  73     assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
  74     Alignment = Align;
  75   }
  76
  77   virtual Instruction *clone() const = 0;
  78
  79   // Methods for support type inquiry through isa, cast, and dyn_cast:
  80   static inline bool classof(const AllocationInst *) { return true; }
  81   static inline bool classof(const Instruction *I) {
  82     return I->getOpcode() == Instruction::Alloca ||
  83            I->getOpcode() == Instruction::Malloc;
  84   }
  85   static inline bool classof(const Value *V) {
  86     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  87   }
  88 };
  89
  90
  91 //===----------------------------------------------------------------------===//
  92 //                                MallocInst Class
  93 //===----------------------------------------------------------------------===//
  94
  95 /// MallocInst - an instruction to allocated memory on the heap
  96 ///
  97 class MallocInst : public AllocationInst {
  98   MallocInst(const MallocInst &MI);
  99 public:
 100   explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
 101                       const std::string &Name = "",
 102                       Instruction *InsertBefore = 0)
 103     : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
 104   MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
 105              BasicBlock *InsertAtEnd)
 106     : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
 107
 108   explicit MallocInst(const Type *Ty, const std::string &Name,
 109                       Instruction *InsertBefore = 0)
 110     : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
 111   MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
 112     : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
 113
 114   MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
 115              const std::string &Name, BasicBlock *InsertAtEnd)
 116     : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
 117   MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
 118                       const std::string &Name = "",
 119                       Instruction *InsertBefore = 0)
 120     : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
 121
 122   virtual MallocInst *clone() const;
 123
 124   // Methods for support type inquiry through isa, cast, and dyn_cast:
 125   static inline bool classof(const MallocInst *) { return true; }
 126   static inline bool classof(const Instruction *I) {
 127     return (I->getOpcode() == Instruction::Malloc);
 128   }
 129   static inline bool classof(const Value *V) {
 130     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 131   }
 132 };
 133
 134
 135 //===----------------------------------------------------------------------===//
 136 //                                AllocaInst Class
 137 //===----------------------------------------------------------------------===//
 138
 139 /// AllocaInst - an instruction to allocate memory on the stack
 140 ///
 141 class AllocaInst : public AllocationInst {
 142   AllocaInst(const AllocaInst &);
 143 public:
 144   explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
 145                       const std::string &Name = "",
 146                       Instruction *InsertBefore = 0)
 147     : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
 148   AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
 149              BasicBlock *InsertAtEnd)
 150     : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
 151
 152   AllocaInst(const Type *Ty, const std::string &Name,
 153              Instruction *InsertBefore = 0)
 154     : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
 155   AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
 156     : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
 157
 158   AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
 159              const std::string &Name = "", Instruction *InsertBefore = 0)
 160     : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
 161   AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
 162              const std::string &Name, BasicBlock *InsertAtEnd)
 163     : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
 164
 165   virtual AllocaInst *clone() const;
 166
 167   // Methods for support type inquiry through isa, cast, and dyn_cast:
 168   static inline bool classof(const AllocaInst *) { return true; }
 169   static inline bool classof(const Instruction *I) {
 170     return (I->getOpcode() == Instruction::Alloca);
 171   }
 172   static inline bool classof(const Value *V) {
 173     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 174   }
 175 };
 176
 177
 178 //===----------------------------------------------------------------------===//
 179 //                                 FreeInst Class
 180 //===----------------------------------------------------------------------===//
 181
 182 /// FreeInst - an instruction to deallocate memory
 183 ///
 184 class FreeInst : public UnaryInstruction {
 185   void AssertOK();
 186 public:
 187   explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
 188   FreeInst(Value *Ptr, BasicBlock *InsertAfter);
 189
 190   virtual FreeInst *clone() const;
 191
 192   virtual bool mayWriteToMemory() const { return true; }
 193
 194   // Methods for support type inquiry through isa, cast, and dyn_cast:
 195   static inline bool classof(const FreeInst *) { return true; }
 196   static inline bool classof(const Instruction *I) {
 197     return (I->getOpcode() == Instruction::Free);
 198   }
 199   static inline bool classof(const Value *V) {
 200     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 201   }
 202 };
 203
 204
 205 //===----------------------------------------------------------------------===//
 206 //                                LoadInst Class
 207 //===----------------------------------------------------------------------===//
 208
 209 /// LoadInst - an instruction for reading from memory.  This uses the
 210 /// SubclassData field in Value to store whether or not the load is volatile.
 211 ///
 212 class LoadInst : public UnaryInstruction {
 213   LoadInst(const LoadInst &LI)
 214     : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
 215     setVolatile(LI.isVolatile());
 216
 217 #ifndef NDEBUG
 218     AssertOK();
 219 #endif
 220   }
 221   void AssertOK();
 222 public:
 223   LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
 224   LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
 225   LoadInst(Value *Ptr, const std::string &Name = "", bool isVolatile = false,
 226            Instruction *InsertBefore = 0);
 227   LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
 228            BasicBlock *InsertAtEnd);
 229
 230   /// isVolatile - Return true if this is a load from a volatile memory
 231   /// location.
 232   ///
 233   bool isVolatile() const { return SubclassData; }
 234
 235   /// setVolatile - Specify whether this is a volatile load or not.
 236   ///
 237   void setVolatile(bool V) { SubclassData = V; }
 238
 239   virtual LoadInst *clone() const;
 240
 241   virtual bool mayWriteToMemory() const { return isVolatile(); }
 242
 243   Value *getPointerOperand() { return getOperand(0); }
 244   const Value *getPointerOperand() const { return getOperand(0); }
 245   static unsigned getPointerOperandIndex() { return 0U; }
 246
 247   // Methods for support type inquiry through isa, cast, and dyn_cast:
 248   static inline bool classof(const LoadInst *) { return true; }
 249   static inline bool classof(const Instruction *I) {
 250     return I->getOpcode() == Instruction::Load;
 251   }
 252   static inline bool classof(const Value *V) {
 253     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 254   }
 255 };
 256
 257
 258 //===----------------------------------------------------------------------===//
 259 //                                StoreInst Class
 260 //===----------------------------------------------------------------------===//
 261
 262 /// StoreInst - an instruction for storing to memory
 263 ///
 264 class StoreInst : public Instruction {
 265   Use Ops[2];
 266   StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store, Ops, 2) {
 267     Ops[0].init(SI.Ops[0], this);
 268     Ops[1].init(SI.Ops[1], this);
 269     setVolatile(SI.isVolatile());
 270 #ifndef NDEBUG
 271     AssertOK();
 272 #endif
 273   }
 274   void AssertOK();
 275 public:
 276   StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
 277   StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
 278   StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
 279             Instruction *InsertBefore = 0);
 280   StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
 281
 282
 283   /// isVolatile - Return true if this is a load from a volatile memory
 284   /// location.
 285   ///
 286   bool isVolatile() const { return SubclassData; }
 287
 288   /// setVolatile - Specify whether this is a volatile load or not.
 289   ///
 290   void setVolatile(bool V) { SubclassData = V; }
 291
 292   /// Transparently provide more efficient getOperand methods.
 293   Value *getOperand(unsigned i) const {
 294     assert(i < 2 && "getOperand() out of range!");
 295     return Ops[i];
 296   }
 297   void setOperand(unsigned i, Value *Val) {
 298     assert(i < 2 && "setOperand() out of range!");
 299     Ops[i] = Val;
 300   }
 301   unsigned getNumOperands() const { return 2; }
 302
 303
 304   virtual StoreInst *clone() const;
 305
 306   virtual bool mayWriteToMemory() const { return true; }
 307
 308   Value *getPointerOperand() { return getOperand(1); }
 309   const Value *getPointerOperand() const { return getOperand(1); }
 310   static unsigned getPointerOperandIndex() { return 1U; }
 311
 312   // Methods for support type inquiry through isa, cast, and dyn_cast:
 313   static inline bool classof(const StoreInst *) { return true; }
 314   static inline bool classof(const Instruction *I) {
 315     return I->getOpcode() == Instruction::Store;
 316   }
 317   static inline bool classof(const Value *V) {
 318     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 319   }
 320 };
 321
 322
 323 //===----------------------------------------------------------------------===//
 324 //                             GetElementPtrInst Class
 325 //===----------------------------------------------------------------------===//
 326
 327 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
 328 /// access elements of arrays and structs
 329 ///
 330 class GetElementPtrInst : public Instruction {
 331   GetElementPtrInst(const GetElementPtrInst &GEPI)
 332     : Instruction(reinterpret_cast<const Type*>(GEPI.getType()), GetElementPtr,
 333                   0, GEPI.getNumOperands()) {
 334     Use *OL = OperandList = new Use[NumOperands];
 335     Use *GEPIOL = GEPI.OperandList;
 336     for (unsigned i = 0, E = NumOperands; i != E; ++i)
 337       OL[i].init(GEPIOL[i], this);
 338   }
 339   void init(Value *Ptr, const std::vector<Value*> &Idx);
 340   void init(Value *Ptr, Value *Idx0, Value *Idx1);
 341   void init(Value *Ptr, Value *Idx);
 342 public:
 343   /// Constructors - Create a getelementptr instruction with a base pointer an
 344   /// list of indices.  The first ctor can optionally insert before an existing
 345   /// instruction, the second appends the new instruction to the specified
 346   /// BasicBlock.
 347   GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
 348                     const std::string &Name = "", Instruction *InsertBefore =0);
 349   GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
 350                     const std::string &Name, BasicBlock *InsertAtEnd);
 351
 352   /// Constructors - These two constructors are convenience methods because one
 353   /// and two index getelementptr instructions are so common.
 354   GetElementPtrInst(Value *Ptr, Value *Idx,
 355                     const std::string &Name = "", Instruction *InsertBefore =0);
 356   GetElementPtrInst(Value *Ptr, Value *Idx,
 357                     const std::string &Name, BasicBlock *InsertAtEnd);
 358   GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
 359                     const std::string &Name = "", Instruction *InsertBefore =0);
 360   GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
 361                     const std::string &Name, BasicBlock *InsertAtEnd);
 362   ~GetElementPtrInst();
 363
 364   virtual GetElementPtrInst *clone() const;
 365
 366   // getType - Overload to return most specific pointer type...
 367   inline const PointerType *getType() const {
 368     return reinterpret_cast<const PointerType*>(Instruction::getType());
 369   }
 370
 371   /// getIndexedType - Returns the type of the element that would be loaded with
 372   /// a load instruction with the specified parameters.
 373   ///
 374   /// A null type is returned if the indices are invalid for the specified
 375   /// pointer type.
 376   ///
 377   static const Type *getIndexedType(const Type *Ptr,
 378                                     const std::vector<Value*> &Indices,
 379                                     bool AllowStructLeaf = false);
 380   static const Type *getIndexedType(const Type *Ptr, Value *Idx0, Value *Idx1,
 381                                     bool AllowStructLeaf = false);
 382   static const Type *getIndexedType(const Type *Ptr, Value *Idx);
 383
 384   inline op_iterator       idx_begin()       { return op_begin()+1; }
 385   inline const_op_iterator idx_begin() const { return op_begin()+1; }
 386   inline op_iterator       idx_end()         { return op_end(); }
 387   inline const_op_iterator idx_end()   const { return op_end(); }
 388
 389   Value *getPointerOperand() {
 390     return getOperand(0);
 391   }
 392   const Value *getPointerOperand() const {
 393     return getOperand(0);
 394   }
 395   static unsigned getPointerOperandIndex() {
 396     return 0U;                      // get index for modifying correct operand
 397   }
 398
 399   inline unsigned getNumIndices() const {  // Note: always non-negative
 400     return getNumOperands() - 1;
 401   }
 402
 403   inline bool hasIndices() const {
 404     return getNumOperands() > 1;
 405   }
 406
 407   // Methods for support type inquiry through isa, cast, and dyn_cast:
 408   static inline bool classof(const GetElementPtrInst *) { return true; }
 409   static inline bool classof(const Instruction *I) {
 410     return (I->getOpcode() == Instruction::GetElementPtr);
 411   }
 412   static inline bool classof(const Value *V) {
 413     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 414   }
 415 };
 416
 417 //===----------------------------------------------------------------------===//
 418 //                            SetCondInst Class
 419 //===----------------------------------------------------------------------===//
 420
 421 /// SetCondInst class - Represent a setCC operator, where CC is eq, ne, lt, gt,
 422 /// le, or ge.
 423 ///
 424 class SetCondInst : public BinaryOperator {
 425 public:
 426   SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
 427               const std::string &Name = "", Instruction *InsertBefore = 0);
 428   SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
 429               const std::string &Name, BasicBlock *InsertAtEnd);
 430
 431   /// getInverseCondition - Return the inverse of the current condition opcode.
 432   /// For example seteq -> setne, setgt -> setle, setlt -> setge, etc...
 433   ///
 434   BinaryOps getInverseCondition() const {
 435     return getInverseCondition(getOpcode());
 436   }
 437
 438   /// getInverseCondition - Static version that you can use without an
 439   /// instruction available.
 440   ///
 441   static BinaryOps getInverseCondition(BinaryOps Opcode);
 442
 443   /// getSwappedCondition - Return the condition opcode that would be the result
 444   /// of exchanging the two operands of the setcc instruction without changing
 445   /// the result produced.  Thus, seteq->seteq, setle->setge, setlt->setgt, etc.
 446   ///
 447   BinaryOps getSwappedCondition() const {
 448     return getSwappedCondition(getOpcode());
 449   }
 450
 451   /// getSwappedCondition - Static version that you can use without an
 452   /// instruction available.
 453   ///
 454   static BinaryOps getSwappedCondition(BinaryOps Opcode);
 455
 456   /// isEquality - Return true if this comparison is an ==/!= comparison.
 457   ///
 458   bool isEquality() const {
 459     return getOpcode() == SetEQ || getOpcode() == SetNE;
 460   }
 461
 462   /// isRelational - Return true if this comparison is a </>/<=/>= comparison.
 463   ///
 464   bool isRelational() const {
 465     return !isEquality();
 466   }
 467
 468   // Methods for support type inquiry through isa, cast, and dyn_cast:
 469   static inline bool classof(const SetCondInst *) { return true; }
 470   static inline bool classof(const Instruction *I) {
 471     return I->getOpcode() == SetEQ || I->getOpcode() == SetNE ||
 472            I->getOpcode() == SetLE || I->getOpcode() == SetGE ||
 473            I->getOpcode() == SetLT || I->getOpcode() == SetGT;
 474   }
 475   static inline bool classof(const Value *V) {
 476     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 477   }
 478 };
 479
 480 //===----------------------------------------------------------------------===//
 481 //                                 CastInst Class
 482 //===----------------------------------------------------------------------===//
 483
 484 /// CastInst - This class represents a cast from Operand[0] to the type of
 485 /// the instruction (i->getType()).
 486 ///
 487 class CastInst : public UnaryInstruction {
 488   CastInst(const CastInst &CI)
 489     : UnaryInstruction(CI.getType(), Cast, CI.getOperand(0)) {
 490   }
 491 public:
 492   CastInst(Value *S, const Type *Ty, const std::string &Name = "",
 493            Instruction *InsertBefore = 0)
 494     : UnaryInstruction(Ty, Cast, S, Name, InsertBefore) {
 495   }
 496   CastInst(Value *S, const Type *Ty, const std::string &Name,
 497            BasicBlock *InsertAtEnd)
 498     : UnaryInstruction(Ty, Cast, S, Name, InsertAtEnd) {
 499   }
 500
 501   /// isTruncIntCast - Return true if this is a truncating integer cast
 502   /// instruction, e.g. a cast from long to uint.
 503   bool isTruncIntCast() const;
 504
 505
 506   virtual CastInst *clone() const;
 507
 508   // Methods for support type inquiry through isa, cast, and dyn_cast:
 509   static inline bool classof(const CastInst *) { return true; }
 510   static inline bool classof(const Instruction *I) {
 511     return I->getOpcode() == Cast;
 512   }
 513   static inline bool classof(const Value *V) {
 514     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 515   }
 516 };
 517
 518
 519 //===----------------------------------------------------------------------===//
 520 //                                 CallInst Class
 521 //===----------------------------------------------------------------------===//
 522
 523 /// CallInst - This class represents a function call, abstracting a target
 524 /// machine's calling convention.  This class uses low bit of the SubClassData
 525 /// field to indicate whether or not this is a tail call.  The rest of the bits
 526 /// hold the calling convention of the call.
 527 ///
 528 class CallInst : public Instruction {
 529   CallInst(const CallInst &CI);
 530   void init(Value *Func, const std::vector<Value*> &Params);
 531   void init(Value *Func, Value *Actual1, Value *Actual2);
 532   void init(Value *Func, Value *Actual);
 533   void init(Value *Func);
 534
 535 public:
 536   CallInst(Value *F, const std::vector<Value*> &Par,
 537            const std::string &Name = "", Instruction *InsertBefore = 0);
 538   CallInst(Value *F, const std::vector<Value*> &Par,
 539            const std::string &Name, BasicBlock *InsertAtEnd);
 540
 541   // Alternate CallInst ctors w/ two actuals, w/ one actual and no
 542   // actuals, respectively.
 543   CallInst(Value *F, Value *Actual1, Value *Actual2,
 544            const std::string& Name = "", Instruction *InsertBefore = 0);
 545   CallInst(Value *F, Value *Actual1, Value *Actual2,
 546            const std::string& Name, BasicBlock *InsertAtEnd);
 547   CallInst(Value *F, Value *Actual, const std::string& Name = "",
 548            Instruction *InsertBefore = 0);
 549   CallInst(Value *F, Value *Actual, const std::string& Name,
 550            BasicBlock *InsertAtEnd);
 551   explicit CallInst(Value *F, const std::string &Name = "",
 552                     Instruction *InsertBefore = 0);
 553   explicit CallInst(Value *F, const std::string &Name,
 554                     BasicBlock *InsertAtEnd);
 555   ~CallInst();
 556
 557   virtual CallInst *clone() const;
 558   bool mayWriteToMemory() const { return true; }
 559
 560   bool isTailCall() const           { return SubclassData & 1; }
 561   void setTailCall(bool isTailCall = true) {
 562     SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
 563   }
 564
 565   /// getCallingConv/setCallingConv - Get or set the calling convention of this
 566   /// function call.
 567   unsigned getCallingConv() const { return SubclassData >> 1; }
 568   void setCallingConv(unsigned CC) {
 569     SubclassData = (SubclassData & 1) | (CC << 1);
 570   }
 571
 572   /// getCalledFunction - Return the function being called by this instruction
 573   /// if it is a direct call.  If it is a call through a function pointer,
 574   /// return null.
 575   Function *getCalledFunction() const {
 576     return static_cast<Function*>(dyn_cast<Function>(getOperand(0)));
 577   }
 578
 579   // getCalledValue - Get a pointer to a method that is invoked by this inst.
 580   inline const Value *getCalledValue() const { return getOperand(0); }
 581   inline       Value *getCalledValue()       { return getOperand(0); }
 582
 583   // Methods for support type inquiry through isa, cast, and dyn_cast:
 584   static inline bool classof(const CallInst *) { return true; }
 585   static inline bool classof(const Instruction *I) {
 586     return I->getOpcode() == Instruction::Call;
 587   }
 588   static inline bool classof(const Value *V) {
 589     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 590   }
 591 };
 592
 593
 594 //===----------------------------------------------------------------------===//
 595 //                                 ShiftInst Class
 596 //===----------------------------------------------------------------------===//
 597
 598 /// ShiftInst - This class represents left and right shift instructions.
 599 ///
 600 class ShiftInst : public Instruction {
 601   Use Ops[2];
 602   ShiftInst(const ShiftInst &SI)
 603     : Instruction(SI.getType(), SI.getOpcode(), Ops, 2) {
 604     Ops[0].init(SI.Ops[0], this);
 605     Ops[1].init(SI.Ops[1], this);
 606   }
 607   void init(OtherOps Opcode, Value *S, Value *SA) {
 608     assert((Opcode == Shl || Opcode == Shr) && "ShiftInst Opcode invalid!");
 609     Ops[0].init(S, this);
 610     Ops[1].init(SA, this);
 611   }
 612
 613 public:
 614   ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name = "",
 615             Instruction *InsertBefore = 0)
 616     : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertBefore) {
 617     init(Opcode, S, SA);
 618   }
 619   ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name,
 620             BasicBlock *InsertAtEnd)
 621     : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertAtEnd) {
 622     init(Opcode, S, SA);
 623   }
 624
 625   OtherOps getOpcode() const {
 626     return static_cast<OtherOps>(Instruction::getOpcode());
 627   }
 628
 629   /// Transparently provide more efficient getOperand methods.
 630   Value *getOperand(unsigned i) const {
 631     assert(i < 2 && "getOperand() out of range!");
 632     return Ops[i];
 633   }
 634   void setOperand(unsigned i, Value *Val) {
 635     assert(i < 2 && "setOperand() out of range!");
 636     Ops[i] = Val;
 637   }
 638   unsigned getNumOperands() const { return 2; }
 639
 640   /// isLogicalShift - Return true if this is a logical shift left or a logical
 641   /// shift right.
 642   bool isLogicalShift() const;
 643
 644   /// isArithmeticShift - Return true if this is a sign-extending shift right
 645   /// operation.
 646   bool isArithmeticShift() const {
 647     return !isLogicalShift();
 648   }
 649
 650
 651   virtual ShiftInst *clone() const;
 652
 653   // Methods for support type inquiry through isa, cast, and dyn_cast:
 654   static inline bool classof(const ShiftInst *) { return true; }
 655   static inline bool classof(const Instruction *I) {
 656     return (I->getOpcode() == Instruction::Shr) |
 657            (I->getOpcode() == Instruction::Shl);
 658   }
 659   static inline bool classof(const Value *V) {
 660     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 661   }
 662 };
 663
 664 //===----------------------------------------------------------------------===//
 665 //                               SelectInst Class
 666 //===----------------------------------------------------------------------===//
 667
 668 /// SelectInst - This class represents the LLVM 'select' instruction.
 669 ///
 670 class SelectInst : public Instruction {
 671   Use Ops[3];
 672
 673   void init(Value *C, Value *S1, Value *S2) {
 674     Ops[0].init(C, this);
 675     Ops[1].init(S1, this);
 676     Ops[2].init(S2, this);
 677   }
 678
 679   SelectInst(const SelectInst &SI)
 680     : Instruction(SI.getType(), SI.getOpcode(), Ops, 3) {
 681     init(SI.Ops[0], SI.Ops[1], SI.Ops[2]);
 682   }
 683 public:
 684   SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
 685              Instruction *InsertBefore = 0)
 686     : Instruction(S1->getType(), Instruction::Select, Ops, 3,
 687                   Name, InsertBefore) {
 688     init(C, S1, S2);
 689   }
 690   SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
 691              BasicBlock *InsertAtEnd)
 692     : Instruction(S1->getType(), Instruction::Select, Ops, 3,
 693                   Name, InsertAtEnd) {
 694     init(C, S1, S2);
 695   }
 696
 697   Value *getCondition() const { return Ops[0]; }
 698   Value *getTrueValue() const { return Ops[1]; }
 699   Value *getFalseValue() const { return Ops[2]; }
 700
 701   /// Transparently provide more efficient getOperand methods.
 702   Value *getOperand(unsigned i) const {
 703     assert(i < 3 && "getOperand() out of range!");
 704     return Ops[i];
 705   }
 706   void setOperand(unsigned i, Value *Val) {
 707     assert(i < 3 && "setOperand() out of range!");
 708     Ops[i] = Val;
 709   }
 710   unsigned getNumOperands() const { return 3; }
 711
 712   OtherOps getOpcode() const {
 713     return static_cast<OtherOps>(Instruction::getOpcode());
 714   }
 715
 716   virtual SelectInst *clone() const;
 717
 718   // Methods for support type inquiry through isa, cast, and dyn_cast:
 719   static inline bool classof(const SelectInst *) { return true; }
 720   static inline bool classof(const Instruction *I) {
 721     return I->getOpcode() == Instruction::Select;
 722   }
 723   static inline bool classof(const Value *V) {
 724     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 725   }
 726 };
 727
 728 //===----------------------------------------------------------------------===//
 729 //                                VAArgInst Class
 730 //===----------------------------------------------------------------------===//
 731
 732 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
 733 /// an argument of the specified type given a va_list and increments that list
 734 ///
 735 class VAArgInst : public UnaryInstruction {
 736   VAArgInst(const VAArgInst &VAA)
 737     : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
 738 public:
 739   VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
 740              Instruction *InsertBefore = 0)
 741     : UnaryInstruction(Ty, VAArg, List, Name, InsertBefore) {
 742   }
 743   VAArgInst(Value *List, const Type *Ty, const std::string &Name,
 744             BasicBlock *InsertAtEnd)
 745     : UnaryInstruction(Ty, VAArg, List, Name, InsertAtEnd) {
 746   }
 747
 748   virtual VAArgInst *clone() const;
 749   bool mayWriteToMemory() const { return true; }
 750
 751   // Methods for support type inquiry through isa, cast, and dyn_cast:
 752   static inline bool classof(const VAArgInst *) { return true; }
 753   static inline bool classof(const Instruction *I) {
 754     return I->getOpcode() == VAArg;
 755   }
 756   static inline bool classof(const Value *V) {
 757     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 758   }
 759 };
 760
 761 //===----------------------------------------------------------------------===//
 762 //                                ExtractElementInst Class
 763 //===----------------------------------------------------------------------===//
 764
 765 /// ExtractElementInst - This instruction extracts a single (scalar)
 766 /// element from a PackedType value
 767 ///
 768 class ExtractElementInst : public Instruction {
 769   Use Ops[2];
 770   ExtractElementInst(const ExtractElementInst &EE) :
 771     Instruction(EE.getType(), ExtractElement, Ops, 2) {
 772     Ops[0].init(EE.Ops[0], this);
 773     Ops[1].init(EE.Ops[1], this);
 774   }
 775
 776 public:
 777   ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
 778                      Instruction *InsertBefore = 0);
 779   ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
 780                      BasicBlock *InsertAtEnd);
 781
 782   /// isValidOperands - Return true if an extractelement instruction can be
 783   /// formed with the specified operands.
 784   static bool isValidOperands(const Value *Vec, const Value *Idx);
 785
 786   virtual ExtractElementInst *clone() const;
 787
 788   virtual bool mayWriteToMemory() const { return false; }
 789
 790   /// Transparently provide more efficient getOperand methods.
 791   Value *getOperand(unsigned i) const {
 792     assert(i < 2 && "getOperand() out of range!");
 793     return Ops[i];
 794   }
 795   void setOperand(unsigned i, Value *Val) {
 796     assert(i < 2 && "setOperand() out of range!");
 797     Ops[i] = Val;
 798   }
 799   unsigned getNumOperands() const { return 2; }
 800
 801   // Methods for support type inquiry through isa, cast, and dyn_cast:
 802   static inline bool classof(const ExtractElementInst *) { return true; }
 803   static inline bool classof(const Instruction *I) {
 804     return I->getOpcode() == Instruction::ExtractElement;
 805   }
 806   static inline bool classof(const Value *V) {
 807     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 808   }
 809 };
 810
 811 //===----------------------------------------------------------------------===//
 812 //                                InsertElementInst Class
 813 //===----------------------------------------------------------------------===//
 814
 815 /// InsertElementInst - This instruction inserts a single (scalar)
 816 /// element into a PackedType value
 817 ///
 818 class InsertElementInst : public Instruction {
 819   Use Ops[3];
 820   InsertElementInst(const InsertElementInst &IE);
 821 public:
 822   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
 823                     const std::string &Name = "",Instruction *InsertBefore = 0);
 824   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
 825                     const std::string &Name, BasicBlock *InsertAtEnd);
 826
 827   /// isValidOperands - Return true if an insertelement instruction can be
 828   /// formed with the specified operands.
 829   static bool isValidOperands(const Value *Vec, const Value *NewElt,
 830                               const Value *Idx);
 831
 832   virtual InsertElementInst *clone() const;
 833
 834   virtual bool mayWriteToMemory() const { return false; }
 835
 836   /// getType - Overload to return most specific packed type.
 837   ///
 838   inline const PackedType *getType() const {
 839     return reinterpret_cast<const PackedType*>(Instruction::getType());
 840   }
 841
 842   /// Transparently provide more efficient getOperand methods.
 843   Value *getOperand(unsigned i) const {
 844     assert(i < 3 && "getOperand() out of range!");
 845     return Ops[i];
 846   }
 847   void setOperand(unsigned i, Value *Val) {
 848     assert(i < 3 && "setOperand() out of range!");
 849     Ops[i] = Val;
 850   }
 851   unsigned getNumOperands() const { return 3; }
 852
 853   // Methods for support type inquiry through isa, cast, and dyn_cast:
 854   static inline bool classof(const InsertElementInst *) { return true; }
 855   static inline bool classof(const Instruction *I) {
 856     return I->getOpcode() == Instruction::InsertElement;
 857   }
 858   static inline bool classof(const Value *V) {
 859     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 860   }
 861 };
 862
 863 //===----------------------------------------------------------------------===//
 864 //                           ShuffleVectorInst Class
 865 //===----------------------------------------------------------------------===//
 866
 867 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
 868 /// input vectors.
 869 ///
 870 class ShuffleVectorInst : public Instruction {
 871   Use Ops[3];
 872   ShuffleVectorInst(const ShuffleVectorInst &IE);
 873 public:
 874   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
 875                     const std::string &Name = "", Instruction *InsertBefor = 0);
 876   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
 877                     const std::string &Name, BasicBlock *InsertAtEnd);
 878
 879   /// isValidOperands - Return true if a shufflevector instruction can be
 880   /// formed with the specified operands.
 881   static bool isValidOperands(const Value *V1, const Value *V2,
 882                               const Value *Mask);
 883
 884   virtual ShuffleVectorInst *clone() const;
 885
 886   virtual bool mayWriteToMemory() const { return false; }
 887
 888   /// getType - Overload to return most specific packed type.
 889   ///
 890   inline const PackedType *getType() const {
 891     return reinterpret_cast<const PackedType*>(Instruction::getType());
 892   }
 893
 894   /// Transparently provide more efficient getOperand methods.
 895   Value *getOperand(unsigned i) const {
 896     assert(i < 3 && "getOperand() out of range!");
 897     return Ops[i];
 898   }
 899   void setOperand(unsigned i, Value *Val) {
 900     assert(i < 3 && "setOperand() out of range!");
 901     Ops[i] = Val;
 902   }
 903   unsigned getNumOperands() const { return 3; }
 904
 905   // Methods for support type inquiry through isa, cast, and dyn_cast:
 906   static inline bool classof(const ShuffleVectorInst *) { return true; }
 907   static inline bool classof(const Instruction *I) {
 908     return I->getOpcode() == Instruction::ShuffleVector;
 909   }
 910   static inline bool classof(const Value *V) {
 911     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 912   }
 913 };
 914
 915
 916 //===----------------------------------------------------------------------===//
 917 //                               PHINode Class
 918 //===----------------------------------------------------------------------===//
 919
 920 // PHINode - The PHINode class is used to represent the magical mystical PHI
 921 // node, that can not exist in nature, but can be synthesized in a computer
 922 // scientist's overactive imagination.
 923 //
 924 class PHINode : public Instruction {
 925   /// ReservedSpace - The number of operands actually allocated.  NumOperands is
 926   /// the number actually in use.
 927   unsigned ReservedSpace;
 928   PHINode(const PHINode &PN);
 929 public:
 930   PHINode(const Type *Ty, const std::string &Name = "",
 931           Instruction *InsertBefore = 0)
 932     : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertBefore),
 933       ReservedSpace(0) {
 934   }
 935
 936   PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
 937     : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertAtEnd),
 938       ReservedSpace(0) {
 939   }
 940
 941   ~PHINode();
 942
 943   /// reserveOperandSpace - This method can be used to avoid repeated
 944   /// reallocation of PHI operand lists by reserving space for the correct
 945   /// number of operands before adding them.  Unlike normal vector reserves,
 946   /// this method can also be used to trim the operand space.
 947   void reserveOperandSpace(unsigned NumValues) {
 948     resizeOperands(NumValues*2);
 949   }
 950
 951   virtual PHINode *clone() const;
 952
 953   /// getNumIncomingValues - Return the number of incoming edges
 954   ///
 955   unsigned getNumIncomingValues() const { return getNumOperands()/2; }
 956
 957   /// getIncomingValue - Return incoming value number x
 958   ///
 959   Value *getIncomingValue(unsigned i) const {
 960     assert(i*2 < getNumOperands() && "Invalid value number!");
 961     return getOperand(i*2);
 962   }
 963   void setIncomingValue(unsigned i, Value *V) {
 964     assert(i*2 < getNumOperands() && "Invalid value number!");
 965     setOperand(i*2, V);
 966   }
 967   unsigned getOperandNumForIncomingValue(unsigned i) {
 968     return i*2;
 969   }
 970
 971   /// getIncomingBlock - Return incoming basic block number x
 972   ///
 973   BasicBlock *getIncomingBlock(unsigned i) const {
 974     return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
 975   }
 976   void setIncomingBlock(unsigned i, BasicBlock *BB) {
 977     setOperand(i*2+1, reinterpret_cast<Value*>(BB));
 978   }
 979   unsigned getOperandNumForIncomingBlock(unsigned i) {
 980     return i*2+1;
 981   }
 982
 983   /// addIncoming - Add an incoming value to the end of the PHI list
 984   ///
 985   void addIncoming(Value *V, BasicBlock *BB) {
 986     assert(getType() == V->getType() &&
 987            "All operands to PHI node must be the same type as the PHI node!");
 988     unsigned OpNo = NumOperands;
 989     if (OpNo+2 > ReservedSpace)
 990       resizeOperands(0);  // Get more space!
 991     // Initialize some new operands.
 992     NumOperands = OpNo+2;
 993     OperandList[OpNo].init(V, this);
 994     OperandList[OpNo+1].init(reinterpret_cast<Value*>(BB), this);
 995   }
 996
 997   /// removeIncomingValue - Remove an incoming value.  This is useful if a
 998   /// predecessor basic block is deleted.  The value removed is returned.
 999   ///
1000   /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1001   /// is true), the PHI node is destroyed and any uses of it are replaced with
1002   /// dummy values.  The only time there should be zero incoming values to a PHI
1003   /// node is when the block is dead, so this strategy is sound.
1004   ///
1005   Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1006
1007   Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
1008     int Idx = getBasicBlockIndex(BB);
1009     assert(Idx >= 0 && "Invalid basic block argument to remove!");
1010     return removeIncomingValue(Idx, DeletePHIIfEmpty);
1011   }
1012
1013   /// getBasicBlockIndex - Return the first index of the specified basic
1014   /// block in the value list for this PHI.  Returns -1 if no instance.
1015   ///
1016   int getBasicBlockIndex(const BasicBlock *BB) const {
1017     Use *OL = OperandList;
1018     for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1019       if (OL[i+1] == reinterpret_cast<const Value*>(BB)) return i/2;
1020     return -1;
1021   }
1022
1023   Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1024     return getIncomingValue(getBasicBlockIndex(BB));
1025   }
1026
1027   /// hasConstantValue - If the specified PHI node always merges together the
1028   /// same value, return the value, otherwise return null.
1029   ///
1030   Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1031
1032   /// Methods for support type inquiry through isa, cast, and dyn_cast:
1033   static inline bool classof(const PHINode *) { return true; }
1034   static inline bool classof(const Instruction *I) {
1035     return I->getOpcode() == Instruction::PHI;
1036   }
1037   static inline bool classof(const Value *V) {
1038     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1039   }
1040  private:
1041   void resizeOperands(unsigned NumOperands);
1042 };
1043
1044 //===----------------------------------------------------------------------===//
1045 //                               ReturnInst Class
1046 //===----------------------------------------------------------------------===//
1047
1048 //===---------------------------------------------------------------------------
1049 /// ReturnInst - Return a value (possibly void), from a function.  Execution
1050 /// does not continue in this function any longer.
1051 ///
1052 class ReturnInst : public TerminatorInst {
1053   Use RetVal;  // Possibly null retval.
1054   ReturnInst(const ReturnInst &RI) : TerminatorInst(Instruction::Ret, &RetVal,
1055                                                     RI.getNumOperands()) {
1056     if (RI.getNumOperands())
1057       RetVal.init(RI.RetVal, this);
1058   }
1059
1060   void init(Value *RetVal);
1061
1062 public:
1063   // ReturnInst constructors:
1064   // ReturnInst()                  - 'ret void' instruction
1065   // ReturnInst(    null)          - 'ret void' instruction
1066   // ReturnInst(Value* X)          - 'ret X'    instruction
1067   // ReturnInst(    null, Inst *)  - 'ret void' instruction, insert before I
1068   // ReturnInst(Value* X, Inst *I) - 'ret X'    instruction, insert before I
1069   // ReturnInst(    null, BB *B)   - 'ret void' instruction, insert @ end of BB
1070   // ReturnInst(Value* X, BB *B)   - 'ret X'    instruction, insert @ end of BB
1071   //
1072   // NOTE: If the Value* passed is of type void then the constructor behaves as
1073   // if it was passed NULL.
1074   ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0)
1075     : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertBefore) {
1076     init(retVal);
1077   }
1078   ReturnInst(Value *retVal, BasicBlock *InsertAtEnd)
1079     : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
1080     init(retVal);
1081   }
1082   ReturnInst(BasicBlock *InsertAtEnd)
1083     : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
1084   }
1085
1086   virtual ReturnInst *clone() const;
1087
1088   // Transparently provide more efficient getOperand methods.
1089   Value *getOperand(unsigned i) const {
1090     assert(i < getNumOperands() && "getOperand() out of range!");
1091     return RetVal;
1092   }
1093   void setOperand(unsigned i, Value *Val) {
1094     assert(i < getNumOperands() && "setOperand() out of range!");
1095     RetVal = Val;
1096   }
1097
1098   Value *getReturnValue() const { return RetVal; }
1099
1100   unsigned getNumSuccessors() const { return 0; }
1101
1102   // Methods for support type inquiry through isa, cast, and dyn_cast:
1103   static inline bool classof(const ReturnInst *) { return true; }
1104   static inline bool classof(const Instruction *I) {
1105     return (I->getOpcode() == Instruction::Ret);
1106   }
1107   static inline bool classof(const Value *V) {
1108     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1109   }
1110  private:
1111   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1112   virtual unsigned getNumSuccessorsV() const;
1113   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1114 };
1115
1116 //===----------------------------------------------------------------------===//
1117 //                               BranchInst Class
1118 //===----------------------------------------------------------------------===//
1119
1120 //===---------------------------------------------------------------------------
1121 /// BranchInst - Conditional or Unconditional Branch instruction.
1122 ///
1123 class BranchInst : public TerminatorInst {
1124   /// Ops list - Branches are strange.  The operands are ordered:
1125   ///  TrueDest, FalseDest, Cond.  This makes some accessors faster because
1126   /// they don't have to check for cond/uncond branchness.
1127   Use Ops[3];
1128   BranchInst(const BranchInst &BI);
1129   void AssertOK();
1130 public:
1131   // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
1132   // BranchInst(BB *B)                           - 'br B'
1133   // BranchInst(BB* T, BB *F, Value *C)          - 'br C, T, F'
1134   // BranchInst(BB* B, Inst *I)                  - 'br B'        insert before I
1135   // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
1136   // BranchInst(BB* B, BB *I)                    - 'br B'        insert at end
1137   // BranchInst(BB* T, BB *F, Value *C, BB *I)   - 'br C, T, F', insert at end
1138   BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0)
1139     : TerminatorInst(Instruction::Br, Ops, 1, InsertBefore) {
1140     assert(IfTrue != 0 && "Branch destination may not be null!");
1141     Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1142   }
1143   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1144              Instruction *InsertBefore = 0)
1145     : TerminatorInst(Instruction::Br, Ops, 3, InsertBefore) {
1146     Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1147     Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
1148     Ops[2].init(Cond, this);
1149 #ifndef NDEBUG
1150     AssertOK();
1151 #endif
1152   }
1153
1154   BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
1155     : TerminatorInst(Instruction::Br, Ops, 1, InsertAtEnd) {
1156     assert(IfTrue != 0 && "Branch destination may not be null!");
1157     Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1158   }
1159
1160   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1161              BasicBlock *InsertAtEnd)
1162     : TerminatorInst(Instruction::Br, Ops, 3, InsertAtEnd) {
1163     Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1164     Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
1165     Ops[2].init(Cond, this);
1166 #ifndef NDEBUG
1167     AssertOK();
1168 #endif
1169   }
1170
1171
1172   /// Transparently provide more efficient getOperand methods.
1173   Value *getOperand(unsigned i) const {
1174     assert(i < getNumOperands() && "getOperand() out of range!");
1175     return Ops[i];
1176   }
1177   void setOperand(unsigned i, Value *Val) {
1178     assert(i < getNumOperands() && "setOperand() out of range!");
1179     Ops[i] = Val;
1180   }
1181
1182   virtual BranchInst *clone() const;
1183
1184   inline bool isUnconditional() const { return getNumOperands() == 1; }
1185   inline bool isConditional()   const { return getNumOperands() == 3; }
1186
1187   inline Value *getCondition() const {
1188     assert(isConditional() && "Cannot get condition of an uncond branch!");
1189     return getOperand(2);
1190   }
1191
1192   void setCondition(Value *V) {
1193     assert(isConditional() && "Cannot set condition of unconditional branch!");
1194     setOperand(2, V);
1195   }
1196
1197   // setUnconditionalDest - Change the current branch to an unconditional branch
1198   // targeting the specified block.
1199   // FIXME: Eliminate this ugly method.
1200   void setUnconditionalDest(BasicBlock *Dest) {
1201     if (isConditional()) {  // Convert this to an uncond branch.
1202       NumOperands = 1;
1203       Ops[1].set(0);
1204       Ops[2].set(0);
1205     }
1206     setOperand(0, reinterpret_cast<Value*>(Dest));
1207   }
1208
1209   unsigned getNumSuccessors() const { return 1+isConditional(); }
1210
1211   BasicBlock *getSuccessor(unsigned i) const {
1212     assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
1213     return (i == 0) ? cast<BasicBlock>(getOperand(0)) :
1214                       cast<BasicBlock>(getOperand(1));
1215   }
1216
1217   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1218     assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
1219     setOperand(idx, reinterpret_cast<Value*>(NewSucc));
1220   }
1221
1222   // Methods for support type inquiry through isa, cast, and dyn_cast:
1223   static inline bool classof(const BranchInst *) { return true; }
1224   static inline bool classof(const Instruction *I) {
1225     return (I->getOpcode() == Instruction::Br);
1226   }
1227   static inline bool classof(const Value *V) {
1228     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1229   }
1230 private:
1231   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1232   virtual unsigned getNumSuccessorsV() const;
1233   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1234 };
1235
1236 //===----------------------------------------------------------------------===//
1237 //                               SwitchInst Class
1238 //===----------------------------------------------------------------------===//
1239
1240 //===---------------------------------------------------------------------------
1241 /// SwitchInst - Multiway switch
1242 ///
1243 class SwitchInst : public TerminatorInst {
1244   unsigned ReservedSpace;
1245   // Operand[0]    = Value to switch on
1246   // Operand[1]    = Default basic block destination
1247   // Operand[2n  ] = Value to match
1248   // Operand[2n+1] = BasicBlock to go to on match
1249   SwitchInst(const SwitchInst &RI);
1250   void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1251   void resizeOperands(unsigned No);
1252 public:
1253   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1254   /// switch on and a default destination.  The number of additional cases can
1255   /// be specified here to make memory allocation more efficient.  This
1256   /// constructor can also autoinsert before another instruction.
1257   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1258              Instruction *InsertBefore = 0)
1259     : TerminatorInst(Instruction::Switch, 0, 0, InsertBefore) {
1260     init(Value, Default, NumCases);
1261   }
1262
1263   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1264   /// switch on and a default destination.  The number of additional cases can
1265   /// be specified here to make memory allocation more efficient.  This
1266   /// constructor also autoinserts at the end of the specified BasicBlock.
1267   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1268              BasicBlock *InsertAtEnd)
1269     : TerminatorInst(Instruction::Switch, 0, 0, InsertAtEnd) {
1270     init(Value, Default, NumCases);
1271   }
1272   ~SwitchInst();
1273
1274
1275   // Accessor Methods for Switch stmt
1276   inline Value *getCondition() const { return getOperand(0); }
1277   void setCondition(Value *V) { setOperand(0, V); }
1278
1279   inline BasicBlock *getDefaultDest() const {
1280     return cast<BasicBlock>(getOperand(1));
1281   }
1282
1283   /// getNumCases - return the number of 'cases' in this switch instruction.
1284   /// Note that case #0 is always the default case.
1285   unsigned getNumCases() const {
1286     return getNumOperands()/2;
1287   }
1288
1289   /// getCaseValue - Return the specified case value.  Note that case #0, the
1290   /// default destination, does not have a case value.
1291   ConstantInt *getCaseValue(unsigned i) {
1292     assert(i && i < getNumCases() && "Illegal case value to get!");
1293     return getSuccessorValue(i);
1294   }
1295
1296   /// getCaseValue - Return the specified case value.  Note that case #0, the
1297   /// default destination, does not have a case value.
1298   const ConstantInt *getCaseValue(unsigned i) const {
1299     assert(i && i < getNumCases() && "Illegal case value to get!");
1300     return getSuccessorValue(i);
1301   }
1302
1303   /// findCaseValue - Search all of the case values for the specified constant.
1304   /// If it is explicitly handled, return the case number of it, otherwise
1305   /// return 0 to indicate that it is handled by the default handler.
1306   unsigned findCaseValue(const ConstantInt *C) const {
1307     for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1308       if (getCaseValue(i) == C)
1309         return i;
1310     return 0;
1311   }
1312
1313   /// findCaseDest - Finds the unique case value for a given successor. Returns
1314   /// null if the successor is not found, not unique, or is the default case.
1315   ConstantInt *findCaseDest(BasicBlock *BB) {
1316     ConstantInt *CI = NULL;
1317     for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
1318       if (getSuccessor(i) == BB) {
1319         if (CI) return NULL;   // Multiple cases lead to BB.
1320         else CI = getCaseValue(i);
1321       }
1322     }
1323     return CI;
1324   }
1325
1326   /// addCase - Add an entry to the switch instruction...
1327   ///
1328   void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1329
1330   /// removeCase - This method removes the specified successor from the switch
1331   /// instruction.  Note that this cannot be used to remove the default
1332   /// destination (successor #0).
1333   ///
1334   void removeCase(unsigned idx);
1335
1336   virtual SwitchInst *clone() const;
1337
1338   unsigned getNumSuccessors() const { return getNumOperands()/2; }
1339   BasicBlock *getSuccessor(unsigned idx) const {
1340     assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1341     return cast<BasicBlock>(getOperand(idx*2+1));
1342   }
1343   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1344     assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1345     setOperand(idx*2+1, reinterpret_cast<Value*>(NewSucc));
1346   }
1347
1348   // getSuccessorValue - Return the value associated with the specified
1349   // successor.
1350   inline ConstantInt *getSuccessorValue(unsigned idx) const {
1351     assert(idx < getNumSuccessors() && "Successor # out of range!");
1352     return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1353   }
1354
1355   // Methods for support type inquiry through isa, cast, and dyn_cast:
1356   static inline bool classof(const SwitchInst *) { return true; }
1357   static inline bool classof(const Instruction *I) {
1358     return I->getOpcode() == Instruction::Switch;
1359   }
1360   static inline bool classof(const Value *V) {
1361     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1362   }
1363 private:
1364   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1365   virtual unsigned getNumSuccessorsV() const;
1366   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1367 };
1368
1369 //===----------------------------------------------------------------------===//
1370 //                               InvokeInst Class
1371 //===----------------------------------------------------------------------===//
1372
1373 //===---------------------------------------------------------------------------
1374
1375 /// InvokeInst - Invoke instruction.  The SubclassData field is used to hold the
1376 /// calling convention of the call.
1377 ///
1378 class InvokeInst : public TerminatorInst {
1379   InvokeInst(const InvokeInst &BI);
1380   void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1381             const std::vector<Value*> &Params);
1382 public:
1383   InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1384              const std::vector<Value*> &Params, const std::string &Name = "",
1385              Instruction *InsertBefore = 0);
1386   InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1387              const std::vector<Value*> &Params, const std::string &Name,
1388              BasicBlock *InsertAtEnd);
1389   ~InvokeInst();
1390
1391   virtual InvokeInst *clone() const;
1392
1393   bool mayWriteToMemory() const { return true; }
1394
1395   /// getCallingConv/setCallingConv - Get or set the calling convention of this
1396   /// function call.
1397   unsigned getCallingConv() const { return SubclassData; }
1398   void setCallingConv(unsigned CC) {
1399     SubclassData = CC;
1400   }
1401
1402   /// getCalledFunction - Return the function called, or null if this is an
1403   /// indirect function invocation.
1404   ///
1405   Function *getCalledFunction() const {
1406     return dyn_cast<Function>(getOperand(0));
1407   }
1408
1409   // getCalledValue - Get a pointer to a function that is invoked by this inst.
1410   inline Value *getCalledValue() const { return getOperand(0); }
1411
1412   // get*Dest - Return the destination basic blocks...
1413   BasicBlock *getNormalDest() const {
1414     return cast<BasicBlock>(getOperand(1));
1415   }
1416   BasicBlock *getUnwindDest() const {
1417     return cast<BasicBlock>(getOperand(2));
1418   }
1419   void setNormalDest(BasicBlock *B) {
1420     setOperand(1, reinterpret_cast<Value*>(B));
1421   }
1422
1423   void setUnwindDest(BasicBlock *B) {
1424     setOperand(2, reinterpret_cast<Value*>(B));
1425   }
1426
1427   inline BasicBlock *getSuccessor(unsigned i) const {
1428     assert(i < 2 && "Successor # out of range for invoke!");
1429     return i == 0 ? getNormalDest() : getUnwindDest();
1430   }
1431
1432   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1433     assert(idx < 2 && "Successor # out of range for invoke!");
1434     setOperand(idx+1, reinterpret_cast<Value*>(NewSucc));
1435   }
1436
1437   unsigned getNumSuccessors() const { return 2; }
1438
1439   // Methods for support type inquiry through isa, cast, and dyn_cast:
1440   static inline bool classof(const InvokeInst *) { return true; }
1441   static inline bool classof(const Instruction *I) {
1442     return (I->getOpcode() == Instruction::Invoke);
1443   }
1444   static inline bool classof(const Value *V) {
1445     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1446   }
1447 private:
1448   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1449   virtual unsigned getNumSuccessorsV() const;
1450   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1451 };
1452
1453
1454 //===----------------------------------------------------------------------===//
1455 //                              UnwindInst Class
1456 //===----------------------------------------------------------------------===//
1457
1458 //===---------------------------------------------------------------------------
1459 /// UnwindInst - Immediately exit the current function, unwinding the stack
1460 /// until an invoke instruction is found.
1461 ///
1462 class UnwindInst : public TerminatorInst {
1463 public:
1464   UnwindInst(Instruction *InsertBefore = 0)
1465     : TerminatorInst(Instruction::Unwind, 0, 0, InsertBefore) {
1466   }
1467   UnwindInst(BasicBlock *InsertAtEnd)
1468     : TerminatorInst(Instruction::Unwind, 0, 0, InsertAtEnd) {
1469   }
1470
1471   virtual UnwindInst *clone() const;
1472
1473   unsigned getNumSuccessors() const { return 0; }
1474
1475   // Methods for support type inquiry through isa, cast, and dyn_cast:
1476   static inline bool classof(const UnwindInst *) { return true; }
1477   static inline bool classof(const Instruction *I) {
1478     return I->getOpcode() == Instruction::Unwind;
1479   }
1480   static inline bool classof(const Value *V) {
1481     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1482   }
1483 private:
1484   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1485   virtual unsigned getNumSuccessorsV() const;
1486   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1487 };
1488
1489 //===----------------------------------------------------------------------===//
1490 //                           UnreachableInst Class
1491 //===----------------------------------------------------------------------===//
1492
1493 //===---------------------------------------------------------------------------
1494 /// UnreachableInst - This function has undefined behavior.  In particular, the
1495 /// presence of this instruction indicates some higher level knowledge that the
1496 /// end of the block cannot be reached.
1497 ///
1498 class UnreachableInst : public TerminatorInst {
1499 public:
1500   UnreachableInst(Instruction *InsertBefore = 0)
1501     : TerminatorInst(Instruction::Unreachable, 0, 0, InsertBefore) {
1502   }
1503   UnreachableInst(BasicBlock *InsertAtEnd)
1504     : TerminatorInst(Instruction::Unreachable, 0, 0, InsertAtEnd) {
1505   }
1506
1507   virtual UnreachableInst *clone() const;
1508
1509   unsigned getNumSuccessors() const { return 0; }
1510
1511   // Methods for support type inquiry through isa, cast, and dyn_cast:
1512   static inline bool classof(const UnreachableInst *) { return true; }
1513   static inline bool classof(const Instruction *I) {
1514     return I->getOpcode() == Instruction::Unreachable;
1515   }
1516   static inline bool classof(const Value *V) {
1517     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1518   }
1519 private:
1520   virtual BasicBlock *getSuccessorV(unsigned idx) const;
1521   virtual unsigned getNumSuccessorsV() const;
1522   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1523 };
1524
1525 } // End llvm namespace
1526
1527 #endif