Add methods which query for the specific attribute instead of using the
[oota-llvm.git] / include / llvm / Instructions.h
1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file exposes the class definitions of all of the subclasses of the
11 // Instruction class.  This is meant to be an easy way to get access to all
12 // instruction subclasses.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #ifndef LLVM_INSTRUCTIONS_H
17 #define LLVM_INSTRUCTIONS_H
18
19 #include "llvm/InstrTypes.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/Attributes.h"
22 #include "llvm/CallingConv.h"
23 #include "llvm/Support/IntegersSubset.h"
24 #include "llvm/Support/IntegersSubsetMapping.h"
25 #include "llvm/ADT/ArrayRef.h"
26 #include "llvm/ADT/SmallVector.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include <iterator>
29
30 namespace llvm {
31
32 class ConstantInt;
33 class ConstantRange;
34 class APInt;
35 class LLVMContext;
36
37 enum AtomicOrdering {
38   NotAtomic = 0,
39   Unordered = 1,
40   Monotonic = 2,
41   // Consume = 3,  // Not specified yet.
42   Acquire = 4,
43   Release = 5,
44   AcquireRelease = 6,
45   SequentiallyConsistent = 7
46 };
47
48 enum SynchronizationScope {
49   SingleThread = 0,
50   CrossThread = 1
51 };
52
53 //===----------------------------------------------------------------------===//
54 //                                AllocaInst Class
55 //===----------------------------------------------------------------------===//
56
57 /// AllocaInst - an instruction to allocate memory on the stack
58 ///
59 class AllocaInst : public UnaryInstruction {
60 protected:
61   virtual AllocaInst *clone_impl() const;
62 public:
63   explicit AllocaInst(Type *Ty, Value *ArraySize = 0,
64                       const Twine &Name = "", Instruction *InsertBefore = 0);
65   AllocaInst(Type *Ty, Value *ArraySize,
66              const Twine &Name, BasicBlock *InsertAtEnd);
67
68   AllocaInst(Type *Ty, const Twine &Name, Instruction *InsertBefore = 0);
69   AllocaInst(Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd);
70
71   AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
72              const Twine &Name = "", Instruction *InsertBefore = 0);
73   AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
74              const Twine &Name, BasicBlock *InsertAtEnd);
75
76   // Out of line virtual method, so the vtable, etc. has a home.
77   virtual ~AllocaInst();
78
79   /// isArrayAllocation - Return true if there is an allocation size parameter
80   /// to the allocation instruction that is not 1.
81   ///
82   bool isArrayAllocation() const;
83
84   /// getArraySize - Get the number of elements allocated. For a simple
85   /// allocation of a single element, this will return a constant 1 value.
86   ///
87   const Value *getArraySize() const { return getOperand(0); }
88   Value *getArraySize() { return getOperand(0); }
89
90   /// getType - Overload to return most specific pointer type
91   ///
92   PointerType *getType() const {
93     return reinterpret_cast<PointerType*>(Instruction::getType());
94   }
95
96   /// getAllocatedType - Return the type that is being allocated by the
97   /// instruction.
98   ///
99   Type *getAllocatedType() const;
100
101   /// getAlignment - Return the alignment of the memory that is being allocated
102   /// by the instruction.
103   ///
104   unsigned getAlignment() const {
105     return (1u << getSubclassDataFromInstruction()) >> 1;
106   }
107   void setAlignment(unsigned Align);
108
109   /// isStaticAlloca - Return true if this alloca is in the entry block of the
110   /// function and is a constant size.  If so, the code generator will fold it
111   /// into the prolog/epilog code, so it is basically free.
112   bool isStaticAlloca() const;
113
114   // Methods for support type inquiry through isa, cast, and dyn_cast:
115   static inline bool classof(const AllocaInst *) { return true; }
116   static inline bool classof(const Instruction *I) {
117     return (I->getOpcode() == Instruction::Alloca);
118   }
119   static inline bool classof(const Value *V) {
120     return isa<Instruction>(V) && classof(cast<Instruction>(V));
121   }
122 private:
123   // Shadow Instruction::setInstructionSubclassData with a private forwarding
124   // method so that subclasses cannot accidentally use it.
125   void setInstructionSubclassData(unsigned short D) {
126     Instruction::setInstructionSubclassData(D);
127   }
128 };
129
130
131 //===----------------------------------------------------------------------===//
132 //                                LoadInst Class
133 //===----------------------------------------------------------------------===//
134
135 /// LoadInst - an instruction for reading from memory.  This uses the
136 /// SubclassData field in Value to store whether or not the load is volatile.
137 ///
138 class LoadInst : public UnaryInstruction {
139   void AssertOK();
140 protected:
141   virtual LoadInst *clone_impl() const;
142 public:
143   LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
144   LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
145   LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
146            Instruction *InsertBefore = 0);
147   LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
148            BasicBlock *InsertAtEnd);
149   LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
150            unsigned Align, Instruction *InsertBefore = 0);
151   LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
152            unsigned Align, BasicBlock *InsertAtEnd);
153   LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
154            unsigned Align, AtomicOrdering Order,
155            SynchronizationScope SynchScope = CrossThread,
156            Instruction *InsertBefore = 0);
157   LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
158            unsigned Align, AtomicOrdering Order,
159            SynchronizationScope SynchScope,
160            BasicBlock *InsertAtEnd);
161
162   LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
163   LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
164   explicit LoadInst(Value *Ptr, const char *NameStr = 0,
165                     bool isVolatile = false,  Instruction *InsertBefore = 0);
166   LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
167            BasicBlock *InsertAtEnd);
168
169   /// isVolatile - Return true if this is a load from a volatile memory
170   /// location.
171   ///
172   bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
173
174   /// setVolatile - Specify whether this is a volatile load or not.
175   ///
176   void setVolatile(bool V) {
177     setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
178                                (V ? 1 : 0));
179   }
180
181   /// getAlignment - Return the alignment of the access that is being performed
182   ///
183   unsigned getAlignment() const {
184     return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
185   }
186
187   void setAlignment(unsigned Align);
188
189   /// Returns the ordering effect of this fence.
190   AtomicOrdering getOrdering() const {
191     return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
192   }
193
194   /// Set the ordering constraint on this load. May not be Release or
195   /// AcquireRelease.
196   void setOrdering(AtomicOrdering Ordering) {
197     setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
198                                (Ordering << 7));
199   }
200
201   SynchronizationScope getSynchScope() const {
202     return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
203   }
204
205   /// Specify whether this load is ordered with respect to all
206   /// concurrently executing threads, or only with respect to signal handlers
207   /// executing in the same thread.
208   void setSynchScope(SynchronizationScope xthread) {
209     setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
210                                (xthread << 6));
211   }
212
213   bool isAtomic() const { return getOrdering() != NotAtomic; }
214   void setAtomic(AtomicOrdering Ordering,
215                  SynchronizationScope SynchScope = CrossThread) {
216     setOrdering(Ordering);
217     setSynchScope(SynchScope);
218   }
219
220   bool isSimple() const { return !isAtomic() && !isVolatile(); }
221   bool isUnordered() const {
222     return getOrdering() <= Unordered && !isVolatile();
223   }
224
225   Value *getPointerOperand() { return getOperand(0); }
226   const Value *getPointerOperand() const { return getOperand(0); }
227   static unsigned getPointerOperandIndex() { return 0U; }
228
229   unsigned getPointerAddressSpace() const {
230     return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
231   }
232
233
234   // Methods for support type inquiry through isa, cast, and dyn_cast:
235   static inline bool classof(const LoadInst *) { return true; }
236   static inline bool classof(const Instruction *I) {
237     return I->getOpcode() == Instruction::Load;
238   }
239   static inline bool classof(const Value *V) {
240     return isa<Instruction>(V) && classof(cast<Instruction>(V));
241   }
242 private:
243   // Shadow Instruction::setInstructionSubclassData with a private forwarding
244   // method so that subclasses cannot accidentally use it.
245   void setInstructionSubclassData(unsigned short D) {
246     Instruction::setInstructionSubclassData(D);
247   }
248 };
249
250
251 //===----------------------------------------------------------------------===//
252 //                                StoreInst Class
253 //===----------------------------------------------------------------------===//
254
255 /// StoreInst - an instruction for storing to memory
256 ///
257 class StoreInst : public Instruction {
258   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
259   void AssertOK();
260 protected:
261   virtual StoreInst *clone_impl() const;
262 public:
263   // allocate space for exactly two operands
264   void *operator new(size_t s) {
265     return User::operator new(s, 2);
266   }
267   StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
268   StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
269   StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
270             Instruction *InsertBefore = 0);
271   StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
272   StoreInst(Value *Val, Value *Ptr, bool isVolatile,
273             unsigned Align, Instruction *InsertBefore = 0);
274   StoreInst(Value *Val, Value *Ptr, bool isVolatile,
275             unsigned Align, BasicBlock *InsertAtEnd);
276   StoreInst(Value *Val, Value *Ptr, bool isVolatile,
277             unsigned Align, AtomicOrdering Order,
278             SynchronizationScope SynchScope = CrossThread,
279             Instruction *InsertBefore = 0);
280   StoreInst(Value *Val, Value *Ptr, bool isVolatile,
281             unsigned Align, AtomicOrdering Order,
282             SynchronizationScope SynchScope,
283             BasicBlock *InsertAtEnd);
284           
285
286   /// isVolatile - Return true if this is a store to a volatile memory
287   /// location.
288   ///
289   bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
290
291   /// setVolatile - Specify whether this is a volatile store or not.
292   ///
293   void setVolatile(bool V) {
294     setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
295                                (V ? 1 : 0));
296   }
297
298   /// Transparently provide more efficient getOperand methods.
299   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
300
301   /// getAlignment - Return the alignment of the access that is being performed
302   ///
303   unsigned getAlignment() const {
304     return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
305   }
306
307   void setAlignment(unsigned Align);
308
309   /// Returns the ordering effect of this store.
310   AtomicOrdering getOrdering() const {
311     return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
312   }
313
314   /// Set the ordering constraint on this store.  May not be Acquire or
315   /// AcquireRelease.
316   void setOrdering(AtomicOrdering Ordering) {
317     setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
318                                (Ordering << 7));
319   }
320
321   SynchronizationScope getSynchScope() const {
322     return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
323   }
324
325   /// Specify whether this store instruction is ordered with respect to all
326   /// concurrently executing threads, or only with respect to signal handlers
327   /// executing in the same thread.
328   void setSynchScope(SynchronizationScope xthread) {
329     setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
330                                (xthread << 6));
331   }
332
333   bool isAtomic() const { return getOrdering() != NotAtomic; }
334   void setAtomic(AtomicOrdering Ordering,
335                  SynchronizationScope SynchScope = CrossThread) {
336     setOrdering(Ordering);
337     setSynchScope(SynchScope);
338   }
339
340   bool isSimple() const { return !isAtomic() && !isVolatile(); }
341   bool isUnordered() const {
342     return getOrdering() <= Unordered && !isVolatile();
343   }
344
345   Value *getValueOperand() { return getOperand(0); }
346   const Value *getValueOperand() const { return getOperand(0); }
347
348   Value *getPointerOperand() { return getOperand(1); }
349   const Value *getPointerOperand() const { return getOperand(1); }
350   static unsigned getPointerOperandIndex() { return 1U; }
351
352   unsigned getPointerAddressSpace() const {
353     return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
354   }
355
356   // Methods for support type inquiry through isa, cast, and dyn_cast:
357   static inline bool classof(const StoreInst *) { return true; }
358   static inline bool classof(const Instruction *I) {
359     return I->getOpcode() == Instruction::Store;
360   }
361   static inline bool classof(const Value *V) {
362     return isa<Instruction>(V) && classof(cast<Instruction>(V));
363   }
364 private:
365   // Shadow Instruction::setInstructionSubclassData with a private forwarding
366   // method so that subclasses cannot accidentally use it.
367   void setInstructionSubclassData(unsigned short D) {
368     Instruction::setInstructionSubclassData(D);
369   }
370 };
371
372 template <>
373 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
374 };
375
376 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
377
378 //===----------------------------------------------------------------------===//
379 //                                FenceInst Class
380 //===----------------------------------------------------------------------===//
381
382 /// FenceInst - an instruction for ordering other memory operations
383 ///
384 class FenceInst : public Instruction {
385   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
386   void Init(AtomicOrdering Ordering, SynchronizationScope SynchScope);
387 protected:
388   virtual FenceInst *clone_impl() const;
389 public:
390   // allocate space for exactly zero operands
391   void *operator new(size_t s) {
392     return User::operator new(s, 0);
393   }
394
395   // Ordering may only be Acquire, Release, AcquireRelease, or
396   // SequentiallyConsistent.
397   FenceInst(LLVMContext &C, AtomicOrdering Ordering,
398             SynchronizationScope SynchScope = CrossThread,
399             Instruction *InsertBefore = 0);
400   FenceInst(LLVMContext &C, AtomicOrdering Ordering,
401             SynchronizationScope SynchScope,
402             BasicBlock *InsertAtEnd);
403
404   /// Returns the ordering effect of this fence.
405   AtomicOrdering getOrdering() const {
406     return AtomicOrdering(getSubclassDataFromInstruction() >> 1);
407   }
408
409   /// Set the ordering constraint on this fence.  May only be Acquire, Release,
410   /// AcquireRelease, or SequentiallyConsistent.
411   void setOrdering(AtomicOrdering Ordering) {
412     setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
413                                (Ordering << 1));
414   }
415
416   SynchronizationScope getSynchScope() const {
417     return SynchronizationScope(getSubclassDataFromInstruction() & 1);
418   }
419
420   /// Specify whether this fence orders other operations with respect to all
421   /// concurrently executing threads, or only with respect to signal handlers
422   /// executing in the same thread.
423   void setSynchScope(SynchronizationScope xthread) {
424     setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
425                                xthread);
426   }
427
428   // Methods for support type inquiry through isa, cast, and dyn_cast:
429   static inline bool classof(const FenceInst *) { return true; }
430   static inline bool classof(const Instruction *I) {
431     return I->getOpcode() == Instruction::Fence;
432   }
433   static inline bool classof(const Value *V) {
434     return isa<Instruction>(V) && classof(cast<Instruction>(V));
435   }
436 private:
437   // Shadow Instruction::setInstructionSubclassData with a private forwarding
438   // method so that subclasses cannot accidentally use it.
439   void setInstructionSubclassData(unsigned short D) {
440     Instruction::setInstructionSubclassData(D);
441   }
442 };
443
444 //===----------------------------------------------------------------------===//
445 //                                AtomicCmpXchgInst Class
446 //===----------------------------------------------------------------------===//
447
448 /// AtomicCmpXchgInst - an instruction that atomically checks whether a
449 /// specified value is in a memory location, and, if it is, stores a new value
450 /// there.  Returns the value that was loaded.
451 ///
452 class AtomicCmpXchgInst : public Instruction {
453   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
454   void Init(Value *Ptr, Value *Cmp, Value *NewVal,
455             AtomicOrdering Ordering, SynchronizationScope SynchScope);
456 protected:
457   virtual AtomicCmpXchgInst *clone_impl() const;
458 public:
459   // allocate space for exactly three operands
460   void *operator new(size_t s) {
461     return User::operator new(s, 3);
462   }
463   AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
464                     AtomicOrdering Ordering, SynchronizationScope SynchScope,
465                     Instruction *InsertBefore = 0);
466   AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
467                     AtomicOrdering Ordering, SynchronizationScope SynchScope,
468                     BasicBlock *InsertAtEnd);
469
470   /// isVolatile - Return true if this is a cmpxchg from a volatile memory
471   /// location.
472   ///
473   bool isVolatile() const {
474     return getSubclassDataFromInstruction() & 1;
475   }
476
477   /// setVolatile - Specify whether this is a volatile cmpxchg.
478   ///
479   void setVolatile(bool V) {
480      setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
481                                 (unsigned)V);
482   }
483
484   /// Transparently provide more efficient getOperand methods.
485   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
486
487   /// Set the ordering constraint on this cmpxchg.
488   void setOrdering(AtomicOrdering Ordering) {
489     assert(Ordering != NotAtomic &&
490            "CmpXchg instructions can only be atomic.");
491     setInstructionSubclassData((getSubclassDataFromInstruction() & 3) |
492                                (Ordering << 2));
493   }
494
495   /// Specify whether this cmpxchg is atomic and orders other operations with
496   /// respect to all concurrently executing threads, or only with respect to
497   /// signal handlers executing in the same thread.
498   void setSynchScope(SynchronizationScope SynchScope) {
499     setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
500                                (SynchScope << 1));
501   }
502
503   /// Returns the ordering constraint on this cmpxchg.
504   AtomicOrdering getOrdering() const {
505     return AtomicOrdering(getSubclassDataFromInstruction() >> 2);
506   }
507
508   /// Returns whether this cmpxchg is atomic between threads or only within a
509   /// single thread.
510   SynchronizationScope getSynchScope() const {
511     return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
512   }
513
514   Value *getPointerOperand() { return getOperand(0); }
515   const Value *getPointerOperand() const { return getOperand(0); }
516   static unsigned getPointerOperandIndex() { return 0U; }
517
518   Value *getCompareOperand() { return getOperand(1); }
519   const Value *getCompareOperand() const { return getOperand(1); }
520   
521   Value *getNewValOperand() { return getOperand(2); }
522   const Value *getNewValOperand() const { return getOperand(2); }
523   
524   unsigned getPointerAddressSpace() const {
525     return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
526   }
527   
528   // Methods for support type inquiry through isa, cast, and dyn_cast:
529   static inline bool classof(const AtomicCmpXchgInst *) { return true; }
530   static inline bool classof(const Instruction *I) {
531     return I->getOpcode() == Instruction::AtomicCmpXchg;
532   }
533   static inline bool classof(const Value *V) {
534     return isa<Instruction>(V) && classof(cast<Instruction>(V));
535   }
536 private:
537   // Shadow Instruction::setInstructionSubclassData with a private forwarding
538   // method so that subclasses cannot accidentally use it.
539   void setInstructionSubclassData(unsigned short D) {
540     Instruction::setInstructionSubclassData(D);
541   }
542 };
543
544 template <>
545 struct OperandTraits<AtomicCmpXchgInst> :
546     public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
547 };
548
549 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)
550
551 //===----------------------------------------------------------------------===//
552 //                                AtomicRMWInst Class
553 //===----------------------------------------------------------------------===//
554
555 /// AtomicRMWInst - an instruction that atomically reads a memory location,
556 /// combines it with another value, and then stores the result back.  Returns
557 /// the old value.
558 ///
559 class AtomicRMWInst : public Instruction {
560   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
561 protected:
562   virtual AtomicRMWInst *clone_impl() const;
563 public:
564   /// This enumeration lists the possible modifications atomicrmw can make.  In
565   /// the descriptions, 'p' is the pointer to the instruction's memory location,
566   /// 'old' is the initial value of *p, and 'v' is the other value passed to the
567   /// instruction.  These instructions always return 'old'.
568   enum BinOp {
569     /// *p = v
570     Xchg,
571     /// *p = old + v
572     Add,
573     /// *p = old - v
574     Sub,
575     /// *p = old & v
576     And,
577     /// *p = ~old & v
578     Nand,
579     /// *p = old | v
580     Or,
581     /// *p = old ^ v
582     Xor,
583     /// *p = old >signed v ? old : v
584     Max,
585     /// *p = old <signed v ? old : v
586     Min,
587     /// *p = old >unsigned v ? old : v
588     UMax,
589     /// *p = old <unsigned v ? old : v
590     UMin,
591
592     FIRST_BINOP = Xchg,
593     LAST_BINOP = UMin,
594     BAD_BINOP
595   };
596
597   // allocate space for exactly two operands
598   void *operator new(size_t s) {
599     return User::operator new(s, 2);
600   }
601   AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
602                 AtomicOrdering Ordering, SynchronizationScope SynchScope,
603                 Instruction *InsertBefore = 0);
604   AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
605                 AtomicOrdering Ordering, SynchronizationScope SynchScope,
606                 BasicBlock *InsertAtEnd);
607
608   BinOp getOperation() const {
609     return static_cast<BinOp>(getSubclassDataFromInstruction() >> 5);
610   }
611
612   void setOperation(BinOp Operation) {
613     unsigned short SubclassData = getSubclassDataFromInstruction();
614     setInstructionSubclassData((SubclassData & 31) |
615                                (Operation << 5));
616   }
617
618   /// isVolatile - Return true if this is a RMW on a volatile memory location.
619   ///
620   bool isVolatile() const {
621     return getSubclassDataFromInstruction() & 1;
622   }
623
624   /// setVolatile - Specify whether this is a volatile RMW or not.
625   ///
626   void setVolatile(bool V) {
627      setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
628                                 (unsigned)V);
629   }
630
631   /// Transparently provide more efficient getOperand methods.
632   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
633
634   /// Set the ordering constraint on this RMW.
635   void setOrdering(AtomicOrdering Ordering) {
636     assert(Ordering != NotAtomic &&
637            "atomicrmw instructions can only be atomic.");
638     setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 2)) |
639                                (Ordering << 2));
640   }
641
642   /// Specify whether this RMW orders other operations with respect to all
643   /// concurrently executing threads, or only with respect to signal handlers
644   /// executing in the same thread.
645   void setSynchScope(SynchronizationScope SynchScope) {
646     setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
647                                (SynchScope << 1));
648   }
649
650   /// Returns the ordering constraint on this RMW.
651   AtomicOrdering getOrdering() const {
652     return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
653   }
654
655   /// Returns whether this RMW is atomic between threads or only within a
656   /// single thread.
657   SynchronizationScope getSynchScope() const {
658     return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
659   }
660
661   Value *getPointerOperand() { return getOperand(0); }
662   const Value *getPointerOperand() const { return getOperand(0); }
663   static unsigned getPointerOperandIndex() { return 0U; }
664
665   Value *getValOperand() { return getOperand(1); }
666   const Value *getValOperand() const { return getOperand(1); }
667
668   unsigned getPointerAddressSpace() const {
669     return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
670   }
671
672   // Methods for support type inquiry through isa, cast, and dyn_cast:
673   static inline bool classof(const AtomicRMWInst *) { return true; }
674   static inline bool classof(const Instruction *I) {
675     return I->getOpcode() == Instruction::AtomicRMW;
676   }
677   static inline bool classof(const Value *V) {
678     return isa<Instruction>(V) && classof(cast<Instruction>(V));
679   }
680 private:
681   void Init(BinOp Operation, Value *Ptr, Value *Val,
682             AtomicOrdering Ordering, SynchronizationScope SynchScope);
683   // Shadow Instruction::setInstructionSubclassData with a private forwarding
684   // method so that subclasses cannot accidentally use it.
685   void setInstructionSubclassData(unsigned short D) {
686     Instruction::setInstructionSubclassData(D);
687   }
688 };
689
690 template <>
691 struct OperandTraits<AtomicRMWInst>
692     : public FixedNumOperandTraits<AtomicRMWInst,2> {
693 };
694
695 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)
696
697 //===----------------------------------------------------------------------===//
698 //                             GetElementPtrInst Class
699 //===----------------------------------------------------------------------===//
700
701 // checkGEPType - Simple wrapper function to give a better assertion failure
702 // message on bad indexes for a gep instruction.
703 //
704 inline Type *checkGEPType(Type *Ty) {
705   assert(Ty && "Invalid GetElementPtrInst indices for type!");
706   return Ty;
707 }
708
709 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
710 /// access elements of arrays and structs
711 ///
712 class GetElementPtrInst : public Instruction {
713   GetElementPtrInst(const GetElementPtrInst &GEPI);
714   void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
715
716   /// Constructors - Create a getelementptr instruction with a base pointer an
717   /// list of indices. The first ctor can optionally insert before an existing
718   /// instruction, the second appends the new instruction to the specified
719   /// BasicBlock.
720   inline GetElementPtrInst(Value *Ptr, ArrayRef<Value *> IdxList,
721                            unsigned Values, const Twine &NameStr,
722                            Instruction *InsertBefore);
723   inline GetElementPtrInst(Value *Ptr, ArrayRef<Value *> IdxList,
724                            unsigned Values, const Twine &NameStr,
725                            BasicBlock *InsertAtEnd);
726 protected:
727   virtual GetElementPtrInst *clone_impl() const;
728 public:
729   static GetElementPtrInst *Create(Value *Ptr, ArrayRef<Value *> IdxList,
730                                    const Twine &NameStr = "",
731                                    Instruction *InsertBefore = 0) {
732     unsigned Values = 1 + unsigned(IdxList.size());
733     return new(Values)
734       GetElementPtrInst(Ptr, IdxList, Values, NameStr, InsertBefore);
735   }
736   static GetElementPtrInst *Create(Value *Ptr, ArrayRef<Value *> IdxList,
737                                    const Twine &NameStr,
738                                    BasicBlock *InsertAtEnd) {
739     unsigned Values = 1 + unsigned(IdxList.size());
740     return new(Values)
741       GetElementPtrInst(Ptr, IdxList, Values, NameStr, InsertAtEnd);
742   }
743
744   /// Create an "inbounds" getelementptr. See the documentation for the
745   /// "inbounds" flag in LangRef.html for details.
746   static GetElementPtrInst *CreateInBounds(Value *Ptr,
747                                            ArrayRef<Value *> IdxList,
748                                            const Twine &NameStr = "",
749                                            Instruction *InsertBefore = 0) {
750     GetElementPtrInst *GEP = Create(Ptr, IdxList, NameStr, InsertBefore);
751     GEP->setIsInBounds(true);
752     return GEP;
753   }
754   static GetElementPtrInst *CreateInBounds(Value *Ptr,
755                                            ArrayRef<Value *> IdxList,
756                                            const Twine &NameStr,
757                                            BasicBlock *InsertAtEnd) {
758     GetElementPtrInst *GEP = Create(Ptr, IdxList, NameStr, InsertAtEnd);
759     GEP->setIsInBounds(true);
760     return GEP;
761   }
762
763   /// Transparently provide more efficient getOperand methods.
764   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
765
766   // getType - Overload to return most specific pointer type...
767   PointerType *getType() const {
768     return reinterpret_cast<PointerType*>(Instruction::getType());
769   }
770
771   /// getIndexedType - Returns the type of the element that would be loaded with
772   /// a load instruction with the specified parameters.
773   ///
774   /// Null is returned if the indices are invalid for the specified
775   /// pointer type.
776   ///
777   static Type *getIndexedType(Type *Ptr, ArrayRef<Value *> IdxList);
778   static Type *getIndexedType(Type *Ptr, ArrayRef<Constant *> IdxList);
779   static Type *getIndexedType(Type *Ptr, ArrayRef<uint64_t> IdxList);
780
781   /// getIndexedType - Returns the address space used by the GEP pointer.
782   ///
783   static unsigned getAddressSpace(Value *Ptr);
784
785   inline op_iterator       idx_begin()       { return op_begin()+1; }
786   inline const_op_iterator idx_begin() const { return op_begin()+1; }
787   inline op_iterator       idx_end()         { return op_end(); }
788   inline const_op_iterator idx_end()   const { return op_end(); }
789
790   Value *getPointerOperand() {
791     return getOperand(0);
792   }
793   const Value *getPointerOperand() const {
794     return getOperand(0);
795   }
796   static unsigned getPointerOperandIndex() {
797     return 0U;    // get index for modifying correct operand.
798   }
799
800   unsigned getPointerAddressSpace() const {
801     return cast<PointerType>(getType())->getAddressSpace();
802   }
803
804   /// getPointerOperandType - Method to return the pointer operand as a
805   /// PointerType.
806   Type *getPointerOperandType() const {
807     return getPointerOperand()->getType();
808   }
809
810   /// GetGEPReturnType - Returns the pointer type returned by the GEP
811   /// instruction, which may be a vector of pointers.
812   static Type *getGEPReturnType(Value *Ptr, ArrayRef<Value *> IdxList) {
813     Type *PtrTy = PointerType::get(checkGEPType(
814                                    getIndexedType(Ptr->getType(), IdxList)),
815                                    getAddressSpace(Ptr));
816     // Vector GEP
817     if (Ptr->getType()->isVectorTy()) {
818       unsigned NumElem = cast<VectorType>(Ptr->getType())->getNumElements();
819       return VectorType::get(PtrTy, NumElem);
820     }
821
822     // Scalar GEP
823     return PtrTy;
824   }
825
826   unsigned getNumIndices() const {  // Note: always non-negative
827     return getNumOperands() - 1;
828   }
829
830   bool hasIndices() const {
831     return getNumOperands() > 1;
832   }
833
834   /// hasAllZeroIndices - Return true if all of the indices of this GEP are
835   /// zeros.  If so, the result pointer and the first operand have the same
836   /// value, just potentially different types.
837   bool hasAllZeroIndices() const;
838
839   /// hasAllConstantIndices - Return true if all of the indices of this GEP are
840   /// constant integers.  If so, the result pointer and the first operand have
841   /// a constant offset between them.
842   bool hasAllConstantIndices() const;
843
844   /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
845   /// See LangRef.html for the meaning of inbounds on a getelementptr.
846   void setIsInBounds(bool b = true);
847
848   /// isInBounds - Determine whether the GEP has the inbounds flag.
849   bool isInBounds() const;
850
851   // Methods for support type inquiry through isa, cast, and dyn_cast:
852   static inline bool classof(const GetElementPtrInst *) { return true; }
853   static inline bool classof(const Instruction *I) {
854     return (I->getOpcode() == Instruction::GetElementPtr);
855   }
856   static inline bool classof(const Value *V) {
857     return isa<Instruction>(V) && classof(cast<Instruction>(V));
858   }
859 };
860
861 template <>
862 struct OperandTraits<GetElementPtrInst> :
863   public VariadicOperandTraits<GetElementPtrInst, 1> {
864 };
865
866 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
867                                      ArrayRef<Value *> IdxList,
868                                      unsigned Values,
869                                      const Twine &NameStr,
870                                      Instruction *InsertBefore)
871   : Instruction(getGEPReturnType(Ptr, IdxList),
872                 GetElementPtr,
873                 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
874                 Values, InsertBefore) {
875   init(Ptr, IdxList, NameStr);
876 }
877 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
878                                      ArrayRef<Value *> IdxList,
879                                      unsigned Values,
880                                      const Twine &NameStr,
881                                      BasicBlock *InsertAtEnd)
882   : Instruction(getGEPReturnType(Ptr, IdxList),
883                 GetElementPtr,
884                 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
885                 Values, InsertAtEnd) {
886   init(Ptr, IdxList, NameStr);
887 }
888
889
890 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
891
892
893 //===----------------------------------------------------------------------===//
894 //                               ICmpInst Class
895 //===----------------------------------------------------------------------===//
896
897 /// This instruction compares its operands according to the predicate given
898 /// to the constructor. It only operates on integers or pointers. The operands
899 /// must be identical types.
900 /// @brief Represent an integer comparison operator.
901 class ICmpInst: public CmpInst {
902 protected:
903   /// @brief Clone an identical ICmpInst
904   virtual ICmpInst *clone_impl() const;
905 public:
906   /// @brief Constructor with insert-before-instruction semantics.
907   ICmpInst(
908     Instruction *InsertBefore,  ///< Where to insert
909     Predicate pred,  ///< The predicate to use for the comparison
910     Value *LHS,      ///< The left-hand-side of the expression
911     Value *RHS,      ///< The right-hand-side of the expression
912     const Twine &NameStr = ""  ///< Name of the instruction
913   ) : CmpInst(makeCmpResultType(LHS->getType()),
914               Instruction::ICmp, pred, LHS, RHS, NameStr,
915               InsertBefore) {
916     assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
917            pred <= CmpInst::LAST_ICMP_PREDICATE &&
918            "Invalid ICmp predicate value");
919     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
920           "Both operands to ICmp instruction are not of the same type!");
921     // Check that the operands are the right type
922     assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
923             getOperand(0)->getType()->getScalarType()->isPointerTy()) &&
924            "Invalid operand types for ICmp instruction");
925   }
926
927   /// @brief Constructor with insert-at-end semantics.
928   ICmpInst(
929     BasicBlock &InsertAtEnd, ///< Block to insert into.
930     Predicate pred,  ///< The predicate to use for the comparison
931     Value *LHS,      ///< The left-hand-side of the expression
932     Value *RHS,      ///< The right-hand-side of the expression
933     const Twine &NameStr = ""  ///< Name of the instruction
934   ) : CmpInst(makeCmpResultType(LHS->getType()),
935               Instruction::ICmp, pred, LHS, RHS, NameStr,
936               &InsertAtEnd) {
937     assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
938           pred <= CmpInst::LAST_ICMP_PREDICATE &&
939           "Invalid ICmp predicate value");
940     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
941           "Both operands to ICmp instruction are not of the same type!");
942     // Check that the operands are the right type
943     assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
944             getOperand(0)->getType()->isPointerTy()) &&
945            "Invalid operand types for ICmp instruction");
946   }
947
948   /// @brief Constructor with no-insertion semantics
949   ICmpInst(
950     Predicate pred, ///< The predicate to use for the comparison
951     Value *LHS,     ///< The left-hand-side of the expression
952     Value *RHS,     ///< The right-hand-side of the expression
953     const Twine &NameStr = "" ///< Name of the instruction
954   ) : CmpInst(makeCmpResultType(LHS->getType()),
955               Instruction::ICmp, pred, LHS, RHS, NameStr) {
956     assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
957            pred <= CmpInst::LAST_ICMP_PREDICATE &&
958            "Invalid ICmp predicate value");
959     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
960           "Both operands to ICmp instruction are not of the same type!");
961     // Check that the operands are the right type
962     assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
963             getOperand(0)->getType()->getScalarType()->isPointerTy()) &&
964            "Invalid operand types for ICmp instruction");
965   }
966
967   /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
968   /// @returns the predicate that would be the result if the operand were
969   /// regarded as signed.
970   /// @brief Return the signed version of the predicate
971   Predicate getSignedPredicate() const {
972     return getSignedPredicate(getPredicate());
973   }
974
975   /// This is a static version that you can use without an instruction.
976   /// @brief Return the signed version of the predicate.
977   static Predicate getSignedPredicate(Predicate pred);
978
979   /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
980   /// @returns the predicate that would be the result if the operand were
981   /// regarded as unsigned.
982   /// @brief Return the unsigned version of the predicate
983   Predicate getUnsignedPredicate() const {
984     return getUnsignedPredicate(getPredicate());
985   }
986
987   /// This is a static version that you can use without an instruction.
988   /// @brief Return the unsigned version of the predicate.
989   static Predicate getUnsignedPredicate(Predicate pred);
990
991   /// isEquality - Return true if this predicate is either EQ or NE.  This also
992   /// tests for commutativity.
993   static bool isEquality(Predicate P) {
994     return P == ICMP_EQ || P == ICMP_NE;
995   }
996
997   /// isEquality - Return true if this predicate is either EQ or NE.  This also
998   /// tests for commutativity.
999   bool isEquality() const {
1000     return isEquality(getPredicate());
1001   }
1002
1003   /// @returns true if the predicate of this ICmpInst is commutative
1004   /// @brief Determine if this relation is commutative.
1005   bool isCommutative() const { return isEquality(); }
1006
1007   /// isRelational - Return true if the predicate is relational (not EQ or NE).
1008   ///
1009   bool isRelational() const {
1010     return !isEquality();
1011   }
1012
1013   /// isRelational - Return true if the predicate is relational (not EQ or NE).
1014   ///
1015   static bool isRelational(Predicate P) {
1016     return !isEquality(P);
1017   }
1018
1019   /// Initialize a set of values that all satisfy the predicate with C.
1020   /// @brief Make a ConstantRange for a relation with a constant value.
1021   static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
1022
1023   /// Exchange the two operands to this instruction in such a way that it does
1024   /// not modify the semantics of the instruction. The predicate value may be
1025   /// changed to retain the same result if the predicate is order dependent
1026   /// (e.g. ult).
1027   /// @brief Swap operands and adjust predicate.
1028   void swapOperands() {
1029     setPredicate(getSwappedPredicate());
1030     Op<0>().swap(Op<1>());
1031   }
1032
1033   // Methods for support type inquiry through isa, cast, and dyn_cast:
1034   static inline bool classof(const ICmpInst *) { return true; }
1035   static inline bool classof(const Instruction *I) {
1036     return I->getOpcode() == Instruction::ICmp;
1037   }
1038   static inline bool classof(const Value *V) {
1039     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1040   }
1041
1042 };
1043
1044 //===----------------------------------------------------------------------===//
1045 //                               FCmpInst Class
1046 //===----------------------------------------------------------------------===//
1047
1048 /// This instruction compares its operands according to the predicate given
1049 /// to the constructor. It only operates on floating point values or packed
1050 /// vectors of floating point values. The operands must be identical types.
1051 /// @brief Represents a floating point comparison operator.
1052 class FCmpInst: public CmpInst {
1053 protected:
1054   /// @brief Clone an identical FCmpInst
1055   virtual FCmpInst *clone_impl() const;
1056 public:
1057   /// @brief Constructor with insert-before-instruction semantics.
1058   FCmpInst(
1059     Instruction *InsertBefore, ///< Where to insert
1060     Predicate pred,  ///< The predicate to use for the comparison
1061     Value *LHS,      ///< The left-hand-side of the expression
1062     Value *RHS,      ///< The right-hand-side of the expression
1063     const Twine &NameStr = ""  ///< Name of the instruction
1064   ) : CmpInst(makeCmpResultType(LHS->getType()),
1065               Instruction::FCmp, pred, LHS, RHS, NameStr,
1066               InsertBefore) {
1067     assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1068            "Invalid FCmp predicate value");
1069     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1070            "Both operands to FCmp instruction are not of the same type!");
1071     // Check that the operands are the right type
1072     assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1073            "Invalid operand types for FCmp instruction");
1074   }
1075
1076   /// @brief Constructor with insert-at-end semantics.
1077   FCmpInst(
1078     BasicBlock &InsertAtEnd, ///< Block to insert into.
1079     Predicate pred,  ///< The predicate to use for the comparison
1080     Value *LHS,      ///< The left-hand-side of the expression
1081     Value *RHS,      ///< The right-hand-side of the expression
1082     const Twine &NameStr = ""  ///< Name of the instruction
1083   ) : CmpInst(makeCmpResultType(LHS->getType()),
1084               Instruction::FCmp, pred, LHS, RHS, NameStr,
1085               &InsertAtEnd) {
1086     assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1087            "Invalid FCmp predicate value");
1088     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1089            "Both operands to FCmp instruction are not of the same type!");
1090     // Check that the operands are the right type
1091     assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1092            "Invalid operand types for FCmp instruction");
1093   }
1094
1095   /// @brief Constructor with no-insertion semantics
1096   FCmpInst(
1097     Predicate pred, ///< The predicate to use for the comparison
1098     Value *LHS,     ///< The left-hand-side of the expression
1099     Value *RHS,     ///< The right-hand-side of the expression
1100     const Twine &NameStr = "" ///< Name of the instruction
1101   ) : CmpInst(makeCmpResultType(LHS->getType()),
1102               Instruction::FCmp, pred, LHS, RHS, NameStr) {
1103     assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1104            "Invalid FCmp predicate value");
1105     assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1106            "Both operands to FCmp instruction are not of the same type!");
1107     // Check that the operands are the right type
1108     assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1109            "Invalid operand types for FCmp instruction");
1110   }
1111
1112   /// @returns true if the predicate of this instruction is EQ or NE.
1113   /// @brief Determine if this is an equality predicate.
1114   bool isEquality() const {
1115     return getPredicate() == FCMP_OEQ || getPredicate() == FCMP_ONE ||
1116            getPredicate() == FCMP_UEQ || getPredicate() == FCMP_UNE;
1117   }
1118
1119   /// @returns true if the predicate of this instruction is commutative.
1120   /// @brief Determine if this is a commutative predicate.
1121   bool isCommutative() const {
1122     return isEquality() ||
1123            getPredicate() == FCMP_FALSE ||
1124            getPredicate() == FCMP_TRUE ||
1125            getPredicate() == FCMP_ORD ||
1126            getPredicate() == FCMP_UNO;
1127   }
1128
1129   /// @returns true if the predicate is relational (not EQ or NE).
1130   /// @brief Determine if this a relational predicate.
1131   bool isRelational() const { return !isEquality(); }
1132
1133   /// Exchange the two operands to this instruction in such a way that it does
1134   /// not modify the semantics of the instruction. The predicate value may be
1135   /// changed to retain the same result if the predicate is order dependent
1136   /// (e.g. ult).
1137   /// @brief Swap operands and adjust predicate.
1138   void swapOperands() {
1139     setPredicate(getSwappedPredicate());
1140     Op<0>().swap(Op<1>());
1141   }
1142
1143   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1144   static inline bool classof(const FCmpInst *) { return true; }
1145   static inline bool classof(const Instruction *I) {
1146     return I->getOpcode() == Instruction::FCmp;
1147   }
1148   static inline bool classof(const Value *V) {
1149     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1150   }
1151 };
1152
1153 //===----------------------------------------------------------------------===//
1154 /// CallInst - This class represents a function call, abstracting a target
1155 /// machine's calling convention.  This class uses low bit of the SubClassData
1156 /// field to indicate whether or not this is a tail call.  The rest of the bits
1157 /// hold the calling convention of the call.
1158 ///
1159 class CallInst : public Instruction {
1160   AttrListPtr AttributeList; ///< parameter attributes for call
1161   CallInst(const CallInst &CI);
1162   void init(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr);
1163   void init(Value *Func, const Twine &NameStr);
1164
1165   /// Construct a CallInst given a range of arguments.
1166   /// @brief Construct a CallInst from a range of arguments
1167   inline CallInst(Value *Func, ArrayRef<Value *> Args,
1168                   const Twine &NameStr, Instruction *InsertBefore);
1169
1170   /// Construct a CallInst given a range of arguments.
1171   /// @brief Construct a CallInst from a range of arguments
1172   inline CallInst(Value *Func, ArrayRef<Value *> Args,
1173                   const Twine &NameStr, BasicBlock *InsertAtEnd);
1174
1175   CallInst(Value *F, Value *Actual, const Twine &NameStr,
1176            Instruction *InsertBefore);
1177   CallInst(Value *F, Value *Actual, const Twine &NameStr,
1178            BasicBlock *InsertAtEnd);
1179   explicit CallInst(Value *F, const Twine &NameStr,
1180                     Instruction *InsertBefore);
1181   CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1182 protected:
1183   virtual CallInst *clone_impl() const;
1184 public:
1185   static CallInst *Create(Value *Func,
1186                           ArrayRef<Value *> Args,
1187                           const Twine &NameStr = "",
1188                           Instruction *InsertBefore = 0) {
1189     return new(unsigned(Args.size() + 1))
1190       CallInst(Func, Args, NameStr, InsertBefore);
1191   }
1192   static CallInst *Create(Value *Func,
1193                           ArrayRef<Value *> Args,
1194                           const Twine &NameStr, BasicBlock *InsertAtEnd) {
1195     return new(unsigned(Args.size() + 1))
1196       CallInst(Func, Args, NameStr, InsertAtEnd);
1197   }
1198   static CallInst *Create(Value *F, const Twine &NameStr = "",
1199                           Instruction *InsertBefore = 0) {
1200     return new(1) CallInst(F, NameStr, InsertBefore);
1201   }
1202   static CallInst *Create(Value *F, const Twine &NameStr,
1203                           BasicBlock *InsertAtEnd) {
1204     return new(1) CallInst(F, NameStr, InsertAtEnd);
1205   }
1206   /// CreateMalloc - Generate the IR for a call to malloc:
1207   /// 1. Compute the malloc call's argument as the specified type's size,
1208   ///    possibly multiplied by the array size if the array size is not
1209   ///    constant 1.
1210   /// 2. Call malloc with that argument.
1211   /// 3. Bitcast the result of the malloc call to the specified type.
1212   static Instruction *CreateMalloc(Instruction *InsertBefore,
1213                                    Type *IntPtrTy, Type *AllocTy,
1214                                    Value *AllocSize, Value *ArraySize = 0,
1215                                    Function* MallocF = 0,
1216                                    const Twine &Name = "");
1217   static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1218                                    Type *IntPtrTy, Type *AllocTy,
1219                                    Value *AllocSize, Value *ArraySize = 0,
1220                                    Function* MallocF = 0,
1221                                    const Twine &Name = "");
1222   /// CreateFree - Generate the IR for a call to the builtin free function.
1223   static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
1224   static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
1225
1226   ~CallInst();
1227
1228   bool isTailCall() const { return getSubclassDataFromInstruction() & 1; }
1229   void setTailCall(bool isTC = true) {
1230     setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
1231                                unsigned(isTC));
1232   }
1233
1234   /// Provide fast operand accessors
1235   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1236
1237   /// getNumArgOperands - Return the number of call arguments.
1238   ///
1239   unsigned getNumArgOperands() const { return getNumOperands() - 1; }
1240
1241   /// getArgOperand/setArgOperand - Return/set the i-th call argument.
1242   ///
1243   Value *getArgOperand(unsigned i) const { return getOperand(i); }
1244   void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
1245
1246   /// getCallingConv/setCallingConv - Get or set the calling convention of this
1247   /// function call.
1248   CallingConv::ID getCallingConv() const {
1249     return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 1);
1250   }
1251   void setCallingConv(CallingConv::ID CC) {
1252     setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
1253                                (static_cast<unsigned>(CC) << 1));
1254   }
1255
1256   /// getAttributes - Return the parameter attributes for this call.
1257   ///
1258   const AttrListPtr &getAttributes() const { return AttributeList; }
1259
1260   /// setAttributes - Set the parameter attributes for this call.
1261   ///
1262   void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
1263
1264   /// addAttribute - adds the attribute to the list of attributes.
1265   void addAttribute(unsigned i, Attributes attr);
1266
1267   /// removeAttribute - removes the attribute from the list of attributes.
1268   void removeAttribute(unsigned i, Attributes attr);
1269
1270   /// \brief Return true if this call has the given attribute.
1271   bool hasFnAttr(Attributes N) const {
1272     return paramHasAttr(~0, N);
1273   }
1274
1275   /// @brief Determine whether the call or the callee has the given attributes.
1276   bool paramHasSExtAttr(unsigned i) const;
1277   bool paramHasZExtAttr(unsigned i) const;
1278   bool paramHasInRegAttr(unsigned i) const;
1279   bool paramHasStructRetAttr(unsigned i) const;
1280   bool paramHasNestAttr(unsigned i) const;
1281   bool paramHasByValAttr(unsigned i) const;
1282
1283   /// @brief Determine whether the call or the callee has the given attribute.
1284   bool paramHasAttr(unsigned i, Attributes attr) const;
1285
1286   /// @brief Extract the alignment for a call or parameter (0=unknown).
1287   unsigned getParamAlignment(unsigned i) const {
1288     return AttributeList.getParamAlignment(i);
1289   }
1290
1291   /// @brief Return true if the call should not be inlined.
1292   bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
1293   void setIsNoInline(bool Value = true) {
1294     if (Value) addAttribute(~0, Attribute::NoInline);
1295     else removeAttribute(~0, Attribute::NoInline);
1296   }
1297
1298   /// @brief Return true if the call can return twice
1299   bool canReturnTwice() const {
1300     return hasFnAttr(Attribute::ReturnsTwice);
1301   }
1302   void setCanReturnTwice(bool Value = true) {
1303     if (Value) addAttribute(~0, Attribute::ReturnsTwice);
1304     else removeAttribute(~0, Attribute::ReturnsTwice);
1305   }
1306
1307   /// @brief Determine if the call does not access memory.
1308   bool doesNotAccessMemory() const {
1309     return hasFnAttr(Attribute::ReadNone);
1310   }
1311   void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1312     if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
1313     else removeAttribute(~0, Attribute::ReadNone);
1314   }
1315
1316   /// @brief Determine if the call does not access or only reads memory.
1317   bool onlyReadsMemory() const {
1318     return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
1319   }
1320   void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1321     if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
1322     else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
1323   }
1324
1325   /// @brief Determine if the call cannot return.
1326   bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
1327   void setDoesNotReturn(bool DoesNotReturn = true) {
1328     if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
1329     else removeAttribute(~0, Attribute::NoReturn);
1330   }
1331
1332   /// @brief Determine if the call cannot unwind.
1333   bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
1334   void setDoesNotThrow(bool DoesNotThrow = true) {
1335     if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
1336     else removeAttribute(~0, Attribute::NoUnwind);
1337   }
1338
1339   /// @brief Determine if the call returns a structure through first
1340   /// pointer argument.
1341   bool hasStructRetAttr() const {
1342     // Be friendly and also check the callee.
1343     return paramHasAttr(1, Attribute::StructRet);
1344   }
1345
1346   /// @brief Determine if any call argument is an aggregate passed by value.
1347   bool hasByValArgument() const {
1348     return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1349   }
1350
1351   /// getCalledFunction - Return the function called, or null if this is an
1352   /// indirect function invocation.
1353   ///
1354   Function *getCalledFunction() const {
1355     return dyn_cast<Function>(Op<-1>());
1356   }
1357
1358   /// getCalledValue - Get a pointer to the function that is invoked by this
1359   /// instruction.
1360   const Value *getCalledValue() const { return Op<-1>(); }
1361         Value *getCalledValue()       { return Op<-1>(); }
1362
1363   /// setCalledFunction - Set the function called.
1364   void setCalledFunction(Value* Fn) {
1365     Op<-1>() = Fn;
1366   }
1367
1368   /// isInlineAsm - Check if this call is an inline asm statement.
1369   bool isInlineAsm() const {
1370     return isa<InlineAsm>(Op<-1>());
1371   }
1372
1373   // Methods for support type inquiry through isa, cast, and dyn_cast:
1374   static inline bool classof(const CallInst *) { return true; }
1375   static inline bool classof(const Instruction *I) {
1376     return I->getOpcode() == Instruction::Call;
1377   }
1378   static inline bool classof(const Value *V) {
1379     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1380   }
1381 private:
1382   // Shadow Instruction::setInstructionSubclassData with a private forwarding
1383   // method so that subclasses cannot accidentally use it.
1384   void setInstructionSubclassData(unsigned short D) {
1385     Instruction::setInstructionSubclassData(D);
1386   }
1387 };
1388
1389 template <>
1390 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1391 };
1392
1393 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1394                    const Twine &NameStr, BasicBlock *InsertAtEnd)
1395   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1396                                    ->getElementType())->getReturnType(),
1397                 Instruction::Call,
1398                 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1399                 unsigned(Args.size() + 1), InsertAtEnd) {
1400   init(Func, Args, NameStr);
1401 }
1402
1403 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1404                    const Twine &NameStr, Instruction *InsertBefore)
1405   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1406                                    ->getElementType())->getReturnType(),
1407                 Instruction::Call,
1408                 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1409                 unsigned(Args.size() + 1), InsertBefore) {
1410   init(Func, Args, NameStr);
1411 }
1412
1413
1414 // Note: if you get compile errors about private methods then
1415 //       please update your code to use the high-level operand
1416 //       interfaces. See line 943 above.
1417 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1418
1419 //===----------------------------------------------------------------------===//
1420 //                               SelectInst Class
1421 //===----------------------------------------------------------------------===//
1422
1423 /// SelectInst - This class represents the LLVM 'select' instruction.
1424 ///
1425 class SelectInst : public Instruction {
1426   void init(Value *C, Value *S1, Value *S2) {
1427     assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1428     Op<0>() = C;
1429     Op<1>() = S1;
1430     Op<2>() = S2;
1431   }
1432
1433   SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1434              Instruction *InsertBefore)
1435     : Instruction(S1->getType(), Instruction::Select,
1436                   &Op<0>(), 3, InsertBefore) {
1437     init(C, S1, S2);
1438     setName(NameStr);
1439   }
1440   SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1441              BasicBlock *InsertAtEnd)
1442     : Instruction(S1->getType(), Instruction::Select,
1443                   &Op<0>(), 3, InsertAtEnd) {
1444     init(C, S1, S2);
1445     setName(NameStr);
1446   }
1447 protected:
1448   virtual SelectInst *clone_impl() const;
1449 public:
1450   static SelectInst *Create(Value *C, Value *S1, Value *S2,
1451                             const Twine &NameStr = "",
1452                             Instruction *InsertBefore = 0) {
1453     return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1454   }
1455   static SelectInst *Create(Value *C, Value *S1, Value *S2,
1456                             const Twine &NameStr,
1457                             BasicBlock *InsertAtEnd) {
1458     return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1459   }
1460
1461   const Value *getCondition() const { return Op<0>(); }
1462   const Value *getTrueValue() const { return Op<1>(); }
1463   const Value *getFalseValue() const { return Op<2>(); }
1464   Value *getCondition() { return Op<0>(); }
1465   Value *getTrueValue() { return Op<1>(); }
1466   Value *getFalseValue() { return Op<2>(); }
1467
1468   /// areInvalidOperands - Return a string if the specified operands are invalid
1469   /// for a select operation, otherwise return null.
1470   static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1471
1472   /// Transparently provide more efficient getOperand methods.
1473   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1474
1475   OtherOps getOpcode() const {
1476     return static_cast<OtherOps>(Instruction::getOpcode());
1477   }
1478
1479   // Methods for support type inquiry through isa, cast, and dyn_cast:
1480   static inline bool classof(const SelectInst *) { return true; }
1481   static inline bool classof(const Instruction *I) {
1482     return I->getOpcode() == Instruction::Select;
1483   }
1484   static inline bool classof(const Value *V) {
1485     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1486   }
1487 };
1488
1489 template <>
1490 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1491 };
1492
1493 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1494
1495 //===----------------------------------------------------------------------===//
1496 //                                VAArgInst Class
1497 //===----------------------------------------------------------------------===//
1498
1499 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1500 /// an argument of the specified type given a va_list and increments that list
1501 ///
1502 class VAArgInst : public UnaryInstruction {
1503 protected:
1504   virtual VAArgInst *clone_impl() const;
1505
1506 public:
1507   VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1508              Instruction *InsertBefore = 0)
1509     : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1510     setName(NameStr);
1511   }
1512   VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1513             BasicBlock *InsertAtEnd)
1514     : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1515     setName(NameStr);
1516   }
1517
1518   Value *getPointerOperand() { return getOperand(0); }
1519   const Value *getPointerOperand() const { return getOperand(0); }
1520   static unsigned getPointerOperandIndex() { return 0U; }
1521
1522   // Methods for support type inquiry through isa, cast, and dyn_cast:
1523   static inline bool classof(const VAArgInst *) { return true; }
1524   static inline bool classof(const Instruction *I) {
1525     return I->getOpcode() == VAArg;
1526   }
1527   static inline bool classof(const Value *V) {
1528     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1529   }
1530 };
1531
1532 //===----------------------------------------------------------------------===//
1533 //                                ExtractElementInst Class
1534 //===----------------------------------------------------------------------===//
1535
1536 /// ExtractElementInst - This instruction extracts a single (scalar)
1537 /// element from a VectorType value
1538 ///
1539 class ExtractElementInst : public Instruction {
1540   ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1541                      Instruction *InsertBefore = 0);
1542   ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1543                      BasicBlock *InsertAtEnd);
1544 protected:
1545   virtual ExtractElementInst *clone_impl() const;
1546
1547 public:
1548   static ExtractElementInst *Create(Value *Vec, Value *Idx,
1549                                    const Twine &NameStr = "",
1550                                    Instruction *InsertBefore = 0) {
1551     return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1552   }
1553   static ExtractElementInst *Create(Value *Vec, Value *Idx,
1554                                    const Twine &NameStr,
1555                                    BasicBlock *InsertAtEnd) {
1556     return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1557   }
1558
1559   /// isValidOperands - Return true if an extractelement instruction can be
1560   /// formed with the specified operands.
1561   static bool isValidOperands(const Value *Vec, const Value *Idx);
1562
1563   Value *getVectorOperand() { return Op<0>(); }
1564   Value *getIndexOperand() { return Op<1>(); }
1565   const Value *getVectorOperand() const { return Op<0>(); }
1566   const Value *getIndexOperand() const { return Op<1>(); }
1567
1568   VectorType *getVectorOperandType() const {
1569     return reinterpret_cast<VectorType*>(getVectorOperand()->getType());
1570   }
1571
1572
1573   /// Transparently provide more efficient getOperand methods.
1574   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1575
1576   // Methods for support type inquiry through isa, cast, and dyn_cast:
1577   static inline bool classof(const ExtractElementInst *) { return true; }
1578   static inline bool classof(const Instruction *I) {
1579     return I->getOpcode() == Instruction::ExtractElement;
1580   }
1581   static inline bool classof(const Value *V) {
1582     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1583   }
1584 };
1585
1586 template <>
1587 struct OperandTraits<ExtractElementInst> :
1588   public FixedNumOperandTraits<ExtractElementInst, 2> {
1589 };
1590
1591 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1592
1593 //===----------------------------------------------------------------------===//
1594 //                                InsertElementInst Class
1595 //===----------------------------------------------------------------------===//
1596
1597 /// InsertElementInst - This instruction inserts a single (scalar)
1598 /// element into a VectorType value
1599 ///
1600 class InsertElementInst : public Instruction {
1601   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1602                     const Twine &NameStr = "",
1603                     Instruction *InsertBefore = 0);
1604   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1605                     const Twine &NameStr, BasicBlock *InsertAtEnd);
1606 protected:
1607   virtual InsertElementInst *clone_impl() const;
1608
1609 public:
1610   static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1611                                    const Twine &NameStr = "",
1612                                    Instruction *InsertBefore = 0) {
1613     return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1614   }
1615   static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1616                                    const Twine &NameStr,
1617                                    BasicBlock *InsertAtEnd) {
1618     return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1619   }
1620
1621   /// isValidOperands - Return true if an insertelement instruction can be
1622   /// formed with the specified operands.
1623   static bool isValidOperands(const Value *Vec, const Value *NewElt,
1624                               const Value *Idx);
1625
1626   /// getType - Overload to return most specific vector type.
1627   ///
1628   VectorType *getType() const {
1629     return reinterpret_cast<VectorType*>(Instruction::getType());
1630   }
1631
1632   /// Transparently provide more efficient getOperand methods.
1633   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1634
1635   // Methods for support type inquiry through isa, cast, and dyn_cast:
1636   static inline bool classof(const InsertElementInst *) { return true; }
1637   static inline bool classof(const Instruction *I) {
1638     return I->getOpcode() == Instruction::InsertElement;
1639   }
1640   static inline bool classof(const Value *V) {
1641     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1642   }
1643 };
1644
1645 template <>
1646 struct OperandTraits<InsertElementInst> :
1647   public FixedNumOperandTraits<InsertElementInst, 3> {
1648 };
1649
1650 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1651
1652 //===----------------------------------------------------------------------===//
1653 //                           ShuffleVectorInst Class
1654 //===----------------------------------------------------------------------===//
1655
1656 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1657 /// input vectors.
1658 ///
1659 class ShuffleVectorInst : public Instruction {
1660 protected:
1661   virtual ShuffleVectorInst *clone_impl() const;
1662
1663 public:
1664   // allocate space for exactly three operands
1665   void *operator new(size_t s) {
1666     return User::operator new(s, 3);
1667   }
1668   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1669                     const Twine &NameStr = "",
1670                     Instruction *InsertBefor = 0);
1671   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1672                     const Twine &NameStr, BasicBlock *InsertAtEnd);
1673
1674   /// isValidOperands - Return true if a shufflevector instruction can be
1675   /// formed with the specified operands.
1676   static bool isValidOperands(const Value *V1, const Value *V2,
1677                               const Value *Mask);
1678
1679   /// getType - Overload to return most specific vector type.
1680   ///
1681   VectorType *getType() const {
1682     return reinterpret_cast<VectorType*>(Instruction::getType());
1683   }
1684
1685   /// Transparently provide more efficient getOperand methods.
1686   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1687
1688   Constant *getMask() const {
1689     return reinterpret_cast<Constant*>(getOperand(2));
1690   }
1691   
1692   /// getMaskValue - Return the index from the shuffle mask for the specified
1693   /// output result.  This is either -1 if the element is undef or a number less
1694   /// than 2*numelements.
1695   static int getMaskValue(Constant *Mask, unsigned i);
1696
1697   int getMaskValue(unsigned i) const {
1698     return getMaskValue(getMask(), i);
1699   }
1700   
1701   /// getShuffleMask - Return the full mask for this instruction, where each
1702   /// element is the element number and undef's are returned as -1.
1703   static void getShuffleMask(Constant *Mask, SmallVectorImpl<int> &Result);
1704
1705   void getShuffleMask(SmallVectorImpl<int> &Result) const {
1706     return getShuffleMask(getMask(), Result);
1707   }
1708
1709   SmallVector<int, 16> getShuffleMask() const {
1710     SmallVector<int, 16> Mask;
1711     getShuffleMask(Mask);
1712     return Mask;
1713   }
1714
1715
1716   // Methods for support type inquiry through isa, cast, and dyn_cast:
1717   static inline bool classof(const ShuffleVectorInst *) { return true; }
1718   static inline bool classof(const Instruction *I) {
1719     return I->getOpcode() == Instruction::ShuffleVector;
1720   }
1721   static inline bool classof(const Value *V) {
1722     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1723   }
1724 };
1725
1726 template <>
1727 struct OperandTraits<ShuffleVectorInst> :
1728   public FixedNumOperandTraits<ShuffleVectorInst, 3> {
1729 };
1730
1731 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1732
1733 //===----------------------------------------------------------------------===//
1734 //                                ExtractValueInst Class
1735 //===----------------------------------------------------------------------===//
1736
1737 /// ExtractValueInst - This instruction extracts a struct member or array
1738 /// element value from an aggregate value.
1739 ///
1740 class ExtractValueInst : public UnaryInstruction {
1741   SmallVector<unsigned, 4> Indices;
1742
1743   ExtractValueInst(const ExtractValueInst &EVI);
1744   void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
1745
1746   /// Constructors - Create a extractvalue instruction with a base aggregate
1747   /// value and a list of indices.  The first ctor can optionally insert before
1748   /// an existing instruction, the second appends the new instruction to the
1749   /// specified BasicBlock.
1750   inline ExtractValueInst(Value *Agg,
1751                           ArrayRef<unsigned> Idxs,
1752                           const Twine &NameStr,
1753                           Instruction *InsertBefore);
1754   inline ExtractValueInst(Value *Agg,
1755                           ArrayRef<unsigned> Idxs,
1756                           const Twine &NameStr, BasicBlock *InsertAtEnd);
1757
1758   // allocate space for exactly one operand
1759   void *operator new(size_t s) {
1760     return User::operator new(s, 1);
1761   }
1762 protected:
1763   virtual ExtractValueInst *clone_impl() const;
1764
1765 public:
1766   static ExtractValueInst *Create(Value *Agg,
1767                                   ArrayRef<unsigned> Idxs,
1768                                   const Twine &NameStr = "",
1769                                   Instruction *InsertBefore = 0) {
1770     return new
1771       ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
1772   }
1773   static ExtractValueInst *Create(Value *Agg,
1774                                   ArrayRef<unsigned> Idxs,
1775                                   const Twine &NameStr,
1776                                   BasicBlock *InsertAtEnd) {
1777     return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
1778   }
1779
1780   /// getIndexedType - Returns the type of the element that would be extracted
1781   /// with an extractvalue instruction with the specified parameters.
1782   ///
1783   /// Null is returned if the indices are invalid for the specified type.
1784   static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
1785
1786   typedef const unsigned* idx_iterator;
1787   inline idx_iterator idx_begin() const { return Indices.begin(); }
1788   inline idx_iterator idx_end()   const { return Indices.end(); }
1789
1790   Value *getAggregateOperand() {
1791     return getOperand(0);
1792   }
1793   const Value *getAggregateOperand() const {
1794     return getOperand(0);
1795   }
1796   static unsigned getAggregateOperandIndex() {
1797     return 0U;                      // get index for modifying correct operand
1798   }
1799
1800   ArrayRef<unsigned> getIndices() const {
1801     return Indices;
1802   }
1803
1804   unsigned getNumIndices() const {
1805     return (unsigned)Indices.size();
1806   }
1807
1808   bool hasIndices() const {
1809     return true;
1810   }
1811
1812   // Methods for support type inquiry through isa, cast, and dyn_cast:
1813   static inline bool classof(const ExtractValueInst *) { return true; }
1814   static inline bool classof(const Instruction *I) {
1815     return I->getOpcode() == Instruction::ExtractValue;
1816   }
1817   static inline bool classof(const Value *V) {
1818     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1819   }
1820 };
1821
1822 ExtractValueInst::ExtractValueInst(Value *Agg,
1823                                    ArrayRef<unsigned> Idxs,
1824                                    const Twine &NameStr,
1825                                    Instruction *InsertBefore)
1826   : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
1827                      ExtractValue, Agg, InsertBefore) {
1828   init(Idxs, NameStr);
1829 }
1830 ExtractValueInst::ExtractValueInst(Value *Agg,
1831                                    ArrayRef<unsigned> Idxs,
1832                                    const Twine &NameStr,
1833                                    BasicBlock *InsertAtEnd)
1834   : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
1835                      ExtractValue, Agg, InsertAtEnd) {
1836   init(Idxs, NameStr);
1837 }
1838
1839
1840 //===----------------------------------------------------------------------===//
1841 //                                InsertValueInst Class
1842 //===----------------------------------------------------------------------===//
1843
1844 /// InsertValueInst - This instruction inserts a struct field of array element
1845 /// value into an aggregate value.
1846 ///
1847 class InsertValueInst : public Instruction {
1848   SmallVector<unsigned, 4> Indices;
1849
1850   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
1851   InsertValueInst(const InsertValueInst &IVI);
1852   void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
1853             const Twine &NameStr);
1854
1855   /// Constructors - Create a insertvalue instruction with a base aggregate
1856   /// value, a value to insert, and a list of indices.  The first ctor can
1857   /// optionally insert before an existing instruction, the second appends
1858   /// the new instruction to the specified BasicBlock.
1859   inline InsertValueInst(Value *Agg, Value *Val,
1860                          ArrayRef<unsigned> Idxs,
1861                          const Twine &NameStr,
1862                          Instruction *InsertBefore);
1863   inline InsertValueInst(Value *Agg, Value *Val,
1864                          ArrayRef<unsigned> Idxs,
1865                          const Twine &NameStr, BasicBlock *InsertAtEnd);
1866
1867   /// Constructors - These two constructors are convenience methods because one
1868   /// and two index insertvalue instructions are so common.
1869   InsertValueInst(Value *Agg, Value *Val,
1870                   unsigned Idx, const Twine &NameStr = "",
1871                   Instruction *InsertBefore = 0);
1872   InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1873                   const Twine &NameStr, BasicBlock *InsertAtEnd);
1874 protected:
1875   virtual InsertValueInst *clone_impl() const;
1876 public:
1877   // allocate space for exactly two operands
1878   void *operator new(size_t s) {
1879     return User::operator new(s, 2);
1880   }
1881
1882   static InsertValueInst *Create(Value *Agg, Value *Val,
1883                                  ArrayRef<unsigned> Idxs,
1884                                  const Twine &NameStr = "",
1885                                  Instruction *InsertBefore = 0) {
1886     return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
1887   }
1888   static InsertValueInst *Create(Value *Agg, Value *Val,
1889                                  ArrayRef<unsigned> Idxs,
1890                                  const Twine &NameStr,
1891                                  BasicBlock *InsertAtEnd) {
1892     return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
1893   }
1894
1895   /// Transparently provide more efficient getOperand methods.
1896   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1897
1898   typedef const unsigned* idx_iterator;
1899   inline idx_iterator idx_begin() const { return Indices.begin(); }
1900   inline idx_iterator idx_end()   const { return Indices.end(); }
1901
1902   Value *getAggregateOperand() {
1903     return getOperand(0);
1904   }
1905   const Value *getAggregateOperand() const {
1906     return getOperand(0);
1907   }
1908   static unsigned getAggregateOperandIndex() {
1909     return 0U;                      // get index for modifying correct operand
1910   }
1911
1912   Value *getInsertedValueOperand() {
1913     return getOperand(1);
1914   }
1915   const Value *getInsertedValueOperand() const {
1916     return getOperand(1);
1917   }
1918   static unsigned getInsertedValueOperandIndex() {
1919     return 1U;                      // get index for modifying correct operand
1920   }
1921
1922   ArrayRef<unsigned> getIndices() const {
1923     return Indices;
1924   }
1925
1926   unsigned getNumIndices() const {
1927     return (unsigned)Indices.size();
1928   }
1929
1930   bool hasIndices() const {
1931     return true;
1932   }
1933
1934   // Methods for support type inquiry through isa, cast, and dyn_cast:
1935   static inline bool classof(const InsertValueInst *) { return true; }
1936   static inline bool classof(const Instruction *I) {
1937     return I->getOpcode() == Instruction::InsertValue;
1938   }
1939   static inline bool classof(const Value *V) {
1940     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1941   }
1942 };
1943
1944 template <>
1945 struct OperandTraits<InsertValueInst> :
1946   public FixedNumOperandTraits<InsertValueInst, 2> {
1947 };
1948
1949 InsertValueInst::InsertValueInst(Value *Agg,
1950                                  Value *Val,
1951                                  ArrayRef<unsigned> Idxs,
1952                                  const Twine &NameStr,
1953                                  Instruction *InsertBefore)
1954   : Instruction(Agg->getType(), InsertValue,
1955                 OperandTraits<InsertValueInst>::op_begin(this),
1956                 2, InsertBefore) {
1957   init(Agg, Val, Idxs, NameStr);
1958 }
1959 InsertValueInst::InsertValueInst(Value *Agg,
1960                                  Value *Val,
1961                                  ArrayRef<unsigned> Idxs,
1962                                  const Twine &NameStr,
1963                                  BasicBlock *InsertAtEnd)
1964   : Instruction(Agg->getType(), InsertValue,
1965                 OperandTraits<InsertValueInst>::op_begin(this),
1966                 2, InsertAtEnd) {
1967   init(Agg, Val, Idxs, NameStr);
1968 }
1969
1970 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1971
1972 //===----------------------------------------------------------------------===//
1973 //                               PHINode Class
1974 //===----------------------------------------------------------------------===//
1975
1976 // PHINode - The PHINode class is used to represent the magical mystical PHI
1977 // node, that can not exist in nature, but can be synthesized in a computer
1978 // scientist's overactive imagination.
1979 //
1980 class PHINode : public Instruction {
1981   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
1982   /// ReservedSpace - The number of operands actually allocated.  NumOperands is
1983   /// the number actually in use.
1984   unsigned ReservedSpace;
1985   PHINode(const PHINode &PN);
1986   // allocate space for exactly zero operands
1987   void *operator new(size_t s) {
1988     return User::operator new(s, 0);
1989   }
1990   explicit PHINode(Type *Ty, unsigned NumReservedValues,
1991                    const Twine &NameStr = "", Instruction *InsertBefore = 0)
1992     : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1993       ReservedSpace(NumReservedValues) {
1994     setName(NameStr);
1995     OperandList = allocHungoffUses(ReservedSpace);
1996   }
1997
1998   PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
1999           BasicBlock *InsertAtEnd)
2000     : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
2001       ReservedSpace(NumReservedValues) {
2002     setName(NameStr);
2003     OperandList = allocHungoffUses(ReservedSpace);
2004   }
2005 protected:
2006   // allocHungoffUses - this is more complicated than the generic
2007   // User::allocHungoffUses, because we have to allocate Uses for the incoming
2008   // values and pointers to the incoming blocks, all in one allocation.
2009   Use *allocHungoffUses(unsigned) const;
2010
2011   virtual PHINode *clone_impl() const;
2012 public:
2013   /// Constructors - NumReservedValues is a hint for the number of incoming
2014   /// edges that this phi node will have (use 0 if you really have no idea).
2015   static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2016                          const Twine &NameStr = "",
2017                          Instruction *InsertBefore = 0) {
2018     return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2019   }
2020   static PHINode *Create(Type *Ty, unsigned NumReservedValues, 
2021                          const Twine &NameStr, BasicBlock *InsertAtEnd) {
2022     return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2023   }
2024   ~PHINode();
2025
2026   /// Provide fast operand accessors
2027   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2028
2029   // Block iterator interface. This provides access to the list of incoming
2030   // basic blocks, which parallels the list of incoming values.
2031
2032   typedef BasicBlock **block_iterator;
2033   typedef BasicBlock * const *const_block_iterator;
2034
2035   block_iterator block_begin() {
2036     Use::UserRef *ref =
2037       reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2038     return reinterpret_cast<block_iterator>(ref + 1);
2039   }
2040
2041   const_block_iterator block_begin() const {
2042     const Use::UserRef *ref =
2043       reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2044     return reinterpret_cast<const_block_iterator>(ref + 1);
2045   }
2046
2047   block_iterator block_end() {
2048     return block_begin() + getNumOperands();
2049   }
2050
2051   const_block_iterator block_end() const {
2052     return block_begin() + getNumOperands();
2053   }
2054
2055   /// getNumIncomingValues - Return the number of incoming edges
2056   ///
2057   unsigned getNumIncomingValues() const { return getNumOperands(); }
2058
2059   /// getIncomingValue - Return incoming value number x
2060   ///
2061   Value *getIncomingValue(unsigned i) const {
2062     return getOperand(i);
2063   }
2064   void setIncomingValue(unsigned i, Value *V) {
2065     setOperand(i, V);
2066   }
2067   static unsigned getOperandNumForIncomingValue(unsigned i) {
2068     return i;
2069   }
2070   static unsigned getIncomingValueNumForOperand(unsigned i) {
2071     return i;
2072   }
2073
2074   /// getIncomingBlock - Return incoming basic block number @p i.
2075   ///
2076   BasicBlock *getIncomingBlock(unsigned i) const {
2077     return block_begin()[i];
2078   }
2079
2080   /// getIncomingBlock - Return incoming basic block corresponding
2081   /// to an operand of the PHI.
2082   ///
2083   BasicBlock *getIncomingBlock(const Use &U) const {
2084     assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2085     return getIncomingBlock(unsigned(&U - op_begin()));
2086   }
2087
2088   /// getIncomingBlock - Return incoming basic block corresponding
2089   /// to value use iterator.
2090   ///
2091   template <typename U>
2092   BasicBlock *getIncomingBlock(value_use_iterator<U> I) const {
2093     return getIncomingBlock(I.getUse());
2094   }
2095
2096   void setIncomingBlock(unsigned i, BasicBlock *BB) {
2097     block_begin()[i] = BB;
2098   }
2099
2100   /// addIncoming - Add an incoming value to the end of the PHI list
2101   ///
2102   void addIncoming(Value *V, BasicBlock *BB) {
2103     assert(V && "PHI node got a null value!");
2104     assert(BB && "PHI node got a null basic block!");
2105     assert(getType() == V->getType() &&
2106            "All operands to PHI node must be the same type as the PHI node!");
2107     if (NumOperands == ReservedSpace)
2108       growOperands();  // Get more space!
2109     // Initialize some new operands.
2110     ++NumOperands;
2111     setIncomingValue(NumOperands - 1, V);
2112     setIncomingBlock(NumOperands - 1, BB);
2113   }
2114
2115   /// removeIncomingValue - Remove an incoming value.  This is useful if a
2116   /// predecessor basic block is deleted.  The value removed is returned.
2117   ///
2118   /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2119   /// is true), the PHI node is destroyed and any uses of it are replaced with
2120   /// dummy values.  The only time there should be zero incoming values to a PHI
2121   /// node is when the block is dead, so this strategy is sound.
2122   ///
2123   Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2124
2125   Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2126     int Idx = getBasicBlockIndex(BB);
2127     assert(Idx >= 0 && "Invalid basic block argument to remove!");
2128     return removeIncomingValue(Idx, DeletePHIIfEmpty);
2129   }
2130
2131   /// getBasicBlockIndex - Return the first index of the specified basic
2132   /// block in the value list for this PHI.  Returns -1 if no instance.
2133   ///
2134   int getBasicBlockIndex(const BasicBlock *BB) const {
2135     for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2136       if (block_begin()[i] == BB)
2137         return i;
2138     return -1;
2139   }
2140
2141   Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2142     int Idx = getBasicBlockIndex(BB);
2143     assert(Idx >= 0 && "Invalid basic block argument!");
2144     return getIncomingValue(Idx);
2145   }
2146
2147   /// hasConstantValue - If the specified PHI node always merges together the
2148   /// same value, return the value, otherwise return null.
2149   Value *hasConstantValue() const;
2150
2151   /// Methods for support type inquiry through isa, cast, and dyn_cast:
2152   static inline bool classof(const PHINode *) { return true; }
2153   static inline bool classof(const Instruction *I) {
2154     return I->getOpcode() == Instruction::PHI;
2155   }
2156   static inline bool classof(const Value *V) {
2157     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2158   }
2159  private:
2160   void growOperands();
2161 };
2162
2163 template <>
2164 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2165 };
2166
2167 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2168
2169 //===----------------------------------------------------------------------===//
2170 //                           LandingPadInst Class
2171 //===----------------------------------------------------------------------===//
2172
2173 //===---------------------------------------------------------------------------
2174 /// LandingPadInst - The landingpad instruction holds all of the information
2175 /// necessary to generate correct exception handling. The landingpad instruction
2176 /// cannot be moved from the top of a landing pad block, which itself is
2177 /// accessible only from the 'unwind' edge of an invoke. This uses the
2178 /// SubclassData field in Value to store whether or not the landingpad is a
2179 /// cleanup.
2180 ///
2181 class LandingPadInst : public Instruction {
2182   /// ReservedSpace - The number of operands actually allocated.  NumOperands is
2183   /// the number actually in use.
2184   unsigned ReservedSpace;
2185   LandingPadInst(const LandingPadInst &LP);
2186 public:
2187   enum ClauseType { Catch, Filter };
2188 private:
2189   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2190   // Allocate space for exactly zero operands.
2191   void *operator new(size_t s) {
2192     return User::operator new(s, 0);
2193   }
2194   void growOperands(unsigned Size);
2195   void init(Value *PersFn, unsigned NumReservedValues, const Twine &NameStr);
2196
2197   explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2198                           unsigned NumReservedValues, const Twine &NameStr,
2199                           Instruction *InsertBefore);
2200   explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2201                           unsigned NumReservedValues, const Twine &NameStr,
2202                           BasicBlock *InsertAtEnd);
2203 protected:
2204   virtual LandingPadInst *clone_impl() const;
2205 public:
2206   /// Constructors - NumReservedClauses is a hint for the number of incoming
2207   /// clauses that this landingpad will have (use 0 if you really have no idea).
2208   static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2209                                 unsigned NumReservedClauses,
2210                                 const Twine &NameStr = "",
2211                                 Instruction *InsertBefore = 0);
2212   static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2213                                 unsigned NumReservedClauses,
2214                                 const Twine &NameStr, BasicBlock *InsertAtEnd);
2215   ~LandingPadInst();
2216
2217   /// Provide fast operand accessors
2218   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2219
2220   /// getPersonalityFn - Get the personality function associated with this
2221   /// landing pad.
2222   Value *getPersonalityFn() const { return getOperand(0); }
2223
2224   /// isCleanup - Return 'true' if this landingpad instruction is a
2225   /// cleanup. I.e., it should be run when unwinding even if its landing pad
2226   /// doesn't catch the exception.
2227   bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2228
2229   /// setCleanup - Indicate that this landingpad instruction is a cleanup.
2230   void setCleanup(bool V) {
2231     setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2232                                (V ? 1 : 0));
2233   }
2234
2235   /// addClause - Add a catch or filter clause to the landing pad.
2236   void addClause(Value *ClauseVal);
2237
2238   /// getClause - Get the value of the clause at index Idx. Use isCatch/isFilter
2239   /// to determine what type of clause this is.
2240   Value *getClause(unsigned Idx) const { return OperandList[Idx + 1]; }
2241
2242   /// isCatch - Return 'true' if the clause and index Idx is a catch clause.
2243   bool isCatch(unsigned Idx) const {
2244     return !isa<ArrayType>(OperandList[Idx + 1]->getType());
2245   }
2246
2247   /// isFilter - Return 'true' if the clause and index Idx is a filter clause.
2248   bool isFilter(unsigned Idx) const {
2249     return isa<ArrayType>(OperandList[Idx + 1]->getType());
2250   }
2251
2252   /// getNumClauses - Get the number of clauses for this landing pad.
2253   unsigned getNumClauses() const { return getNumOperands() - 1; }
2254
2255   /// reserveClauses - Grow the size of the operand list to accommodate the new
2256   /// number of clauses.
2257   void reserveClauses(unsigned Size) { growOperands(Size); }
2258
2259   // Methods for support type inquiry through isa, cast, and dyn_cast:
2260   static inline bool classof(const LandingPadInst *) { return true; }
2261   static inline bool classof(const Instruction *I) {
2262     return I->getOpcode() == Instruction::LandingPad;
2263   }
2264   static inline bool classof(const Value *V) {
2265     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2266   }
2267 };
2268
2269 template <>
2270 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<2> {
2271 };
2272
2273 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2274
2275 //===----------------------------------------------------------------------===//
2276 //                               ReturnInst Class
2277 //===----------------------------------------------------------------------===//
2278
2279 //===---------------------------------------------------------------------------
2280 /// ReturnInst - Return a value (possibly void), from a function.  Execution
2281 /// does not continue in this function any longer.
2282 ///
2283 class ReturnInst : public TerminatorInst {
2284   ReturnInst(const ReturnInst &RI);
2285
2286 private:
2287   // ReturnInst constructors:
2288   // ReturnInst()                  - 'ret void' instruction
2289   // ReturnInst(    null)          - 'ret void' instruction
2290   // ReturnInst(Value* X)          - 'ret X'    instruction
2291   // ReturnInst(    null, Inst *I) - 'ret void' instruction, insert before I
2292   // ReturnInst(Value* X, Inst *I) - 'ret X'    instruction, insert before I
2293   // ReturnInst(    null, BB *B)   - 'ret void' instruction, insert @ end of B
2294   // ReturnInst(Value* X, BB *B)   - 'ret X'    instruction, insert @ end of B
2295   //
2296   // NOTE: If the Value* passed is of type void then the constructor behaves as
2297   // if it was passed NULL.
2298   explicit ReturnInst(LLVMContext &C, Value *retVal = 0,
2299                       Instruction *InsertBefore = 0);
2300   ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2301   explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2302 protected:
2303   virtual ReturnInst *clone_impl() const;
2304 public:
2305   static ReturnInst* Create(LLVMContext &C, Value *retVal = 0,
2306                             Instruction *InsertBefore = 0) {
2307     return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2308   }
2309   static ReturnInst* Create(LLVMContext &C, Value *retVal,
2310                             BasicBlock *InsertAtEnd) {
2311     return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2312   }
2313   static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2314     return new(0) ReturnInst(C, InsertAtEnd);
2315   }
2316   virtual ~ReturnInst();
2317
2318   /// Provide fast operand accessors
2319   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2320
2321   /// Convenience accessor. Returns null if there is no return value.
2322   Value *getReturnValue() const {
2323     return getNumOperands() != 0 ? getOperand(0) : 0;
2324   }
2325
2326   unsigned getNumSuccessors() const { return 0; }
2327
2328   // Methods for support type inquiry through isa, cast, and dyn_cast:
2329   static inline bool classof(const ReturnInst *) { return true; }
2330   static inline bool classof(const Instruction *I) {
2331     return (I->getOpcode() == Instruction::Ret);
2332   }
2333   static inline bool classof(const Value *V) {
2334     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2335   }
2336  private:
2337   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2338   virtual unsigned getNumSuccessorsV() const;
2339   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2340 };
2341
2342 template <>
2343 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2344 };
2345
2346 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2347
2348 //===----------------------------------------------------------------------===//
2349 //                               BranchInst Class
2350 //===----------------------------------------------------------------------===//
2351
2352 //===---------------------------------------------------------------------------
2353 /// BranchInst - Conditional or Unconditional Branch instruction.
2354 ///
2355 class BranchInst : public TerminatorInst {
2356   /// Ops list - Branches are strange.  The operands are ordered:
2357   ///  [Cond, FalseDest,] TrueDest.  This makes some accessors faster because
2358   /// they don't have to check for cond/uncond branchness. These are mostly
2359   /// accessed relative from op_end().
2360   BranchInst(const BranchInst &BI);
2361   void AssertOK();
2362   // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2363   // BranchInst(BB *B)                           - 'br B'
2364   // BranchInst(BB* T, BB *F, Value *C)          - 'br C, T, F'
2365   // BranchInst(BB* B, Inst *I)                  - 'br B'        insert before I
2366   // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2367   // BranchInst(BB* B, BB *I)                    - 'br B'        insert at end
2368   // BranchInst(BB* T, BB *F, Value *C, BB *I)   - 'br C, T, F', insert at end
2369   explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2370   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2371              Instruction *InsertBefore = 0);
2372   BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2373   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2374              BasicBlock *InsertAtEnd);
2375 protected:
2376   virtual BranchInst *clone_impl() const;
2377 public:
2378   static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2379     return new(1) BranchInst(IfTrue, InsertBefore);
2380   }
2381   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2382                             Value *Cond, Instruction *InsertBefore = 0) {
2383     return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2384   }
2385   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2386     return new(1) BranchInst(IfTrue, InsertAtEnd);
2387   }
2388   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2389                             Value *Cond, BasicBlock *InsertAtEnd) {
2390     return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2391   }
2392
2393   /// Transparently provide more efficient getOperand methods.
2394   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2395
2396   bool isUnconditional() const { return getNumOperands() == 1; }
2397   bool isConditional()   const { return getNumOperands() == 3; }
2398
2399   Value *getCondition() const {
2400     assert(isConditional() && "Cannot get condition of an uncond branch!");
2401     return Op<-3>();
2402   }
2403
2404   void setCondition(Value *V) {
2405     assert(isConditional() && "Cannot set condition of unconditional branch!");
2406     Op<-3>() = V;
2407   }
2408
2409   unsigned getNumSuccessors() const { return 1+isConditional(); }
2410
2411   BasicBlock *getSuccessor(unsigned i) const {
2412     assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2413     return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2414   }
2415
2416   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2417     assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2418     *(&Op<-1>() - idx) = (Value*)NewSucc;
2419   }
2420
2421   /// \brief Swap the successors of this branch instruction.
2422   ///
2423   /// Swaps the successors of the branch instruction. This also swaps any
2424   /// branch weight metadata associated with the instruction so that it
2425   /// continues to map correctly to each operand.
2426   void swapSuccessors();
2427
2428   // Methods for support type inquiry through isa, cast, and dyn_cast:
2429   static inline bool classof(const BranchInst *) { return true; }
2430   static inline bool classof(const Instruction *I) {
2431     return (I->getOpcode() == Instruction::Br);
2432   }
2433   static inline bool classof(const Value *V) {
2434     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2435   }
2436 private:
2437   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2438   virtual unsigned getNumSuccessorsV() const;
2439   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2440 };
2441
2442 template <>
2443 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2444 };
2445
2446 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2447
2448 //===----------------------------------------------------------------------===//
2449 //                               SwitchInst Class
2450 //===----------------------------------------------------------------------===//
2451
2452 //===---------------------------------------------------------------------------
2453 /// SwitchInst - Multiway switch
2454 ///
2455 class SwitchInst : public TerminatorInst {
2456   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2457   unsigned ReservedSpace;
2458   // Operands format:
2459   // Operand[0]    = Value to switch on
2460   // Operand[1]    = Default basic block destination
2461   // Operand[2n  ] = Value to match
2462   // Operand[2n+1] = BasicBlock to go to on match
2463   
2464   // Store case values separately from operands list. We needn't User-Use
2465   // concept here, since it is just a case value, it will always constant,
2466   // and case value couldn't reused with another instructions/values.
2467   // Additionally:
2468   // It allows us to use custom type for case values that is not inherited
2469   // from Value. Since case value is a complex type that implements
2470   // the subset of integers, we needn't extract sub-constants within
2471   // slow getAggregateElement method.
2472   // For case values we will use std::list to by two reasons:
2473   // 1. It allows to add/remove cases without whole collection reallocation.
2474   // 2. In most of cases we needn't random access.
2475   // Currently case values are also stored in Operands List, but it will moved
2476   // out in future commits.
2477   typedef std::list<IntegersSubset> Subsets;
2478   typedef Subsets::iterator SubsetsIt;
2479   typedef Subsets::const_iterator SubsetsConstIt;
2480   
2481   Subsets TheSubsets;
2482   
2483   SwitchInst(const SwitchInst &SI);
2484   void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2485   void growOperands();
2486   // allocate space for exactly zero operands
2487   void *operator new(size_t s) {
2488     return User::operator new(s, 0);
2489   }
2490   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2491   /// switch on and a default destination.  The number of additional cases can
2492   /// be specified here to make memory allocation more efficient.  This
2493   /// constructor can also autoinsert before another instruction.
2494   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2495              Instruction *InsertBefore);
2496
2497   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2498   /// switch on and a default destination.  The number of additional cases can
2499   /// be specified here to make memory allocation more efficient.  This
2500   /// constructor also autoinserts at the end of the specified BasicBlock.
2501   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2502              BasicBlock *InsertAtEnd);
2503 protected:
2504   virtual SwitchInst *clone_impl() const;
2505 public:
2506   
2507   // FIXME: Currently there are a lot of unclean template parameters,
2508   // we need to make refactoring in future.
2509   // All these parameters are used to implement both iterator and const_iterator
2510   // without code duplication.
2511   // SwitchInstTy may be "const SwitchInst" or "SwitchInst"
2512   // ConstantIntTy may be "const ConstantInt" or "ConstantInt"
2513   // SubsetsItTy may be SubsetsConstIt or SubsetsIt
2514   // BasicBlockTy may be "const BasicBlock" or "BasicBlock"
2515   template <class SwitchInstTy, class ConstantIntTy,
2516             class SubsetsItTy, class BasicBlockTy> 
2517     class CaseIteratorT;
2518
2519   typedef CaseIteratorT<const SwitchInst, const ConstantInt,
2520                         SubsetsConstIt, const BasicBlock> ConstCaseIt;
2521   class CaseIt;
2522   
2523   // -2
2524   static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
2525   
2526   static SwitchInst *Create(Value *Value, BasicBlock *Default,
2527                             unsigned NumCases, Instruction *InsertBefore = 0) {
2528     return new SwitchInst(Value, Default, NumCases, InsertBefore);
2529   }
2530   static SwitchInst *Create(Value *Value, BasicBlock *Default,
2531                             unsigned NumCases, BasicBlock *InsertAtEnd) {
2532     return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2533   }
2534   
2535   ~SwitchInst();
2536
2537   /// Provide fast operand accessors
2538   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2539
2540   // Accessor Methods for Switch stmt
2541   Value *getCondition() const { return getOperand(0); }
2542   void setCondition(Value *V) { setOperand(0, V); }
2543
2544   BasicBlock *getDefaultDest() const {
2545     return cast<BasicBlock>(getOperand(1));
2546   }
2547
2548   void setDefaultDest(BasicBlock *DefaultCase) {
2549     setOperand(1, reinterpret_cast<Value*>(DefaultCase));
2550   }
2551
2552   /// getNumCases - return the number of 'cases' in this switch instruction,
2553   /// except the default case
2554   unsigned getNumCases() const {
2555     return getNumOperands()/2 - 1;
2556   }
2557
2558   /// Returns a read/write iterator that points to the first
2559   /// case in SwitchInst.
2560   CaseIt case_begin() {
2561     return CaseIt(this, 0, TheSubsets.begin());
2562   }
2563   /// Returns a read-only iterator that points to the first
2564   /// case in the SwitchInst.
2565   ConstCaseIt case_begin() const {
2566     return ConstCaseIt(this, 0, TheSubsets.begin());
2567   }
2568   
2569   /// Returns a read/write iterator that points one past the last
2570   /// in the SwitchInst.
2571   CaseIt case_end() {
2572     return CaseIt(this, getNumCases(), TheSubsets.end());
2573   }
2574   /// Returns a read-only iterator that points one past the last
2575   /// in the SwitchInst.
2576   ConstCaseIt case_end() const {
2577     return ConstCaseIt(this, getNumCases(), TheSubsets.end());
2578   }
2579   /// Returns an iterator that points to the default case.
2580   /// Note: this iterator allows to resolve successor only. Attempt
2581   /// to resolve case value causes an assertion.
2582   /// Also note, that increment and decrement also causes an assertion and
2583   /// makes iterator invalid. 
2584   CaseIt case_default() {
2585     return CaseIt(this, DefaultPseudoIndex, TheSubsets.end());
2586   }
2587   ConstCaseIt case_default() const {
2588     return ConstCaseIt(this, DefaultPseudoIndex, TheSubsets.end());
2589   }
2590   
2591   /// findCaseValue - Search all of the case values for the specified constant.
2592   /// If it is explicitly handled, return the case iterator of it, otherwise
2593   /// return default case iterator to indicate
2594   /// that it is handled by the default handler.
2595   CaseIt findCaseValue(const ConstantInt *C) {
2596     for (CaseIt i = case_begin(), e = case_end(); i != e; ++i)
2597       if (i.getCaseValueEx().isSatisfies(IntItem::fromConstantInt(C)))
2598         return i;
2599     return case_default();
2600   }
2601   ConstCaseIt findCaseValue(const ConstantInt *C) const {
2602     for (ConstCaseIt i = case_begin(), e = case_end(); i != e; ++i)
2603       if (i.getCaseValueEx().isSatisfies(IntItem::fromConstantInt(C)))
2604         return i;
2605     return case_default();
2606   }    
2607   
2608   /// findCaseDest - Finds the unique case value for a given successor. Returns
2609   /// null if the successor is not found, not unique, or is the default case.
2610   ConstantInt *findCaseDest(BasicBlock *BB) {
2611     if (BB == getDefaultDest()) return NULL;
2612
2613     ConstantInt *CI = NULL;
2614     for (CaseIt i = case_begin(), e = case_end(); i != e; ++i) {
2615       if (i.getCaseSuccessor() == BB) {
2616         if (CI) return NULL;   // Multiple cases lead to BB.
2617         else CI = i.getCaseValue();
2618       }
2619     }
2620     return CI;
2621   }
2622
2623   /// addCase - Add an entry to the switch instruction...
2624   /// @deprecated
2625   /// Note:
2626   /// This action invalidates case_end(). Old case_end() iterator will
2627   /// point to the added case.
2628   void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2629   
2630   /// addCase - Add an entry to the switch instruction.
2631   /// Note:
2632   /// This action invalidates case_end(). Old case_end() iterator will
2633   /// point to the added case.
2634   void addCase(IntegersSubset& OnVal, BasicBlock *Dest);
2635
2636   /// removeCase - This method removes the specified case and its successor
2637   /// from the switch instruction. Note that this operation may reorder the
2638   /// remaining cases at index idx and above.
2639   /// Note:
2640   /// This action invalidates iterators for all cases following the one removed,
2641   /// including the case_end() iterator.
2642   void removeCase(CaseIt& i);
2643
2644   unsigned getNumSuccessors() const { return getNumOperands()/2; }
2645   BasicBlock *getSuccessor(unsigned idx) const {
2646     assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2647     return cast<BasicBlock>(getOperand(idx*2+1));
2648   }
2649   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2650     assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2651     setOperand(idx*2+1, (Value*)NewSucc);
2652   }
2653   
2654   uint16_t hash() const {
2655     uint32_t NumberOfCases = (uint32_t)getNumCases();
2656     uint16_t Hash = (0xFFFF & NumberOfCases) ^ (NumberOfCases >> 16);
2657     for (ConstCaseIt i = case_begin(), e = case_end();
2658          i != e; ++i) {
2659       uint32_t NumItems = (uint32_t)i.getCaseValueEx().getNumItems(); 
2660       Hash = (Hash << 1) ^ (0xFFFF & NumItems) ^ (NumItems >> 16);
2661     }
2662     return Hash;
2663   }  
2664   
2665   // Case iterators definition.
2666
2667   template <class SwitchInstTy, class ConstantIntTy,
2668             class SubsetsItTy, class BasicBlockTy> 
2669   class CaseIteratorT {
2670   protected:
2671     
2672     SwitchInstTy *SI;
2673     unsigned long Index;
2674     SubsetsItTy SubsetIt;
2675     
2676     /// Initializes case iterator for given SwitchInst and for given
2677     /// case number.    
2678     friend class SwitchInst;
2679     CaseIteratorT(SwitchInstTy *SI, unsigned SuccessorIndex,
2680                   SubsetsItTy CaseValueIt) {
2681       this->SI = SI;
2682       Index = SuccessorIndex;
2683       this->SubsetIt = CaseValueIt;
2684     }
2685     
2686   public:
2687     typedef typename SubsetsItTy::reference IntegersSubsetRef;
2688     typedef CaseIteratorT<SwitchInstTy, ConstantIntTy,
2689                           SubsetsItTy, BasicBlockTy> Self;
2690     
2691     CaseIteratorT(SwitchInstTy *SI, unsigned CaseNum) {
2692           this->SI = SI;
2693           Index = CaseNum;
2694           SubsetIt = SI->TheSubsets.begin();
2695           std::advance(SubsetIt, CaseNum);
2696         }
2697         
2698     
2699     /// Initializes case iterator for given SwitchInst and for given
2700     /// TerminatorInst's successor index.
2701     static Self fromSuccessorIndex(SwitchInstTy *SI, unsigned SuccessorIndex) {
2702       assert(SuccessorIndex < SI->getNumSuccessors() &&
2703              "Successor index # out of range!");    
2704       return SuccessorIndex != 0 ? 
2705              Self(SI, SuccessorIndex - 1) :
2706              Self(SI, DefaultPseudoIndex);       
2707     }
2708     
2709     /// Resolves case value for current case.
2710     /// @deprecated
2711     ConstantIntTy *getCaseValue() {
2712       assert(Index < SI->getNumCases() && "Index out the number of cases.");
2713       IntegersSubsetRef CaseRanges = *SubsetIt;
2714       
2715       // FIXME: Currently we work with ConstantInt based cases.
2716       // So return CaseValue as ConstantInt.
2717       return CaseRanges.getSingleNumber(0).toConstantInt();
2718     }
2719
2720     /// Resolves case value for current case.
2721     IntegersSubsetRef getCaseValueEx() {
2722       assert(Index < SI->getNumCases() && "Index out the number of cases.");
2723       return *SubsetIt;
2724     }
2725     
2726     /// Resolves successor for current case.
2727     BasicBlockTy *getCaseSuccessor() {
2728       assert((Index < SI->getNumCases() ||
2729               Index == DefaultPseudoIndex) &&
2730              "Index out the number of cases.");
2731       return SI->getSuccessor(getSuccessorIndex());      
2732     }
2733     
2734     /// Returns number of current case.
2735     unsigned getCaseIndex() const { return Index; }
2736     
2737     /// Returns TerminatorInst's successor index for current case successor.
2738     unsigned getSuccessorIndex() const {
2739       assert((Index == DefaultPseudoIndex || Index < SI->getNumCases()) &&
2740              "Index out the number of cases.");
2741       return Index != DefaultPseudoIndex ? Index + 1 : 0;
2742     }
2743     
2744     Self operator++() {
2745       // Check index correctness after increment.
2746       // Note: Index == getNumCases() means end().
2747       assert(Index+1 <= SI->getNumCases() && "Index out the number of cases.");
2748       ++Index;
2749       if (Index == 0)
2750         SubsetIt = SI->TheSubsets.begin();
2751       else
2752         ++SubsetIt;
2753       return *this;
2754     }
2755     Self operator++(int) {
2756       Self tmp = *this;
2757       ++(*this);
2758       return tmp;
2759     }
2760     Self operator--() { 
2761       // Check index correctness after decrement.
2762       // Note: Index == getNumCases() means end().
2763       // Also allow "-1" iterator here. That will became valid after ++.
2764       unsigned NumCases = SI->getNumCases();
2765       assert((Index == 0 || Index-1 <= NumCases) &&
2766              "Index out the number of cases.");
2767       --Index;
2768       if (Index == NumCases) {
2769         SubsetIt = SI->TheSubsets.end();
2770         return *this;
2771       }
2772         
2773       if (Index != -1UL)
2774         --SubsetIt;
2775       
2776       return *this;
2777     }
2778     Self operator--(int) {
2779       Self tmp = *this;
2780       --(*this);
2781       return tmp;
2782     }
2783     bool operator==(const Self& RHS) const {
2784       assert(RHS.SI == SI && "Incompatible operators.");
2785       return RHS.Index == Index;
2786     }
2787     bool operator!=(const Self& RHS) const {
2788       assert(RHS.SI == SI && "Incompatible operators.");
2789       return RHS.Index != Index;
2790     }
2791   };
2792
2793   class CaseIt : public CaseIteratorT<SwitchInst, ConstantInt,
2794                                       SubsetsIt, BasicBlock> {
2795     typedef CaseIteratorT<SwitchInst, ConstantInt, SubsetsIt, BasicBlock>
2796       ParentTy;
2797     
2798   protected:
2799     friend class SwitchInst;
2800     CaseIt(SwitchInst *SI, unsigned CaseNum, SubsetsIt SubsetIt) :
2801       ParentTy(SI, CaseNum, SubsetIt) {}
2802     
2803     void updateCaseValueOperand(IntegersSubset& V) {
2804       SI->setOperand(2 + Index*2, reinterpret_cast<Value*>((Constant*)V));      
2805     }
2806   
2807   public:
2808
2809     CaseIt(SwitchInst *SI, unsigned CaseNum) : ParentTy(SI, CaseNum) {}    
2810     
2811     CaseIt(const ParentTy& Src) : ParentTy(Src) {}
2812
2813     /// Sets the new value for current case.    
2814     /// @deprecated.
2815     void setValue(ConstantInt *V) {
2816       assert(Index < SI->getNumCases() && "Index out the number of cases.");
2817       IntegersSubsetToBB Mapping;
2818       // FIXME: Currently we work with ConstantInt based cases.
2819       // So inititalize IntItem container directly from ConstantInt.
2820       Mapping.add(IntItem::fromConstantInt(V));
2821       *SubsetIt = Mapping.getCase();
2822       updateCaseValueOperand(*SubsetIt);
2823     }
2824     
2825     /// Sets the new value for current case.
2826     void setValueEx(IntegersSubset& V) {
2827       assert(Index < SI->getNumCases() && "Index out the number of cases.");
2828       *SubsetIt = V;
2829       updateCaseValueOperand(*SubsetIt);   
2830     }
2831     
2832     /// Sets the new successor for current case.
2833     void setSuccessor(BasicBlock *S) {
2834       SI->setSuccessor(getSuccessorIndex(), S);      
2835     }
2836   };
2837
2838   // Methods for support type inquiry through isa, cast, and dyn_cast:
2839
2840   static inline bool classof(const SwitchInst *) { return true; }
2841   static inline bool classof(const Instruction *I) {
2842     return I->getOpcode() == Instruction::Switch;
2843   }
2844   static inline bool classof(const Value *V) {
2845     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2846   }
2847 private:
2848   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2849   virtual unsigned getNumSuccessorsV() const;
2850   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2851 };
2852
2853 template <>
2854 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2855 };
2856
2857 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2858
2859
2860 //===----------------------------------------------------------------------===//
2861 //                             IndirectBrInst Class
2862 //===----------------------------------------------------------------------===//
2863
2864 //===---------------------------------------------------------------------------
2865 /// IndirectBrInst - Indirect Branch Instruction.
2866 ///
2867 class IndirectBrInst : public TerminatorInst {
2868   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2869   unsigned ReservedSpace;
2870   // Operand[0]    = Value to switch on
2871   // Operand[1]    = Default basic block destination
2872   // Operand[2n  ] = Value to match
2873   // Operand[2n+1] = BasicBlock to go to on match
2874   IndirectBrInst(const IndirectBrInst &IBI);
2875   void init(Value *Address, unsigned NumDests);
2876   void growOperands();
2877   // allocate space for exactly zero operands
2878   void *operator new(size_t s) {
2879     return User::operator new(s, 0);
2880   }
2881   /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2882   /// Address to jump to.  The number of expected destinations can be specified
2883   /// here to make memory allocation more efficient.  This constructor can also
2884   /// autoinsert before another instruction.
2885   IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
2886
2887   /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2888   /// Address to jump to.  The number of expected destinations can be specified
2889   /// here to make memory allocation more efficient.  This constructor also
2890   /// autoinserts at the end of the specified BasicBlock.
2891   IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
2892 protected:
2893   virtual IndirectBrInst *clone_impl() const;
2894 public:
2895   static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2896                                 Instruction *InsertBefore = 0) {
2897     return new IndirectBrInst(Address, NumDests, InsertBefore);
2898   }
2899   static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2900                                 BasicBlock *InsertAtEnd) {
2901     return new IndirectBrInst(Address, NumDests, InsertAtEnd);
2902   }
2903   ~IndirectBrInst();
2904
2905   /// Provide fast operand accessors.
2906   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2907
2908   // Accessor Methods for IndirectBrInst instruction.
2909   Value *getAddress() { return getOperand(0); }
2910   const Value *getAddress() const { return getOperand(0); }
2911   void setAddress(Value *V) { setOperand(0, V); }
2912
2913
2914   /// getNumDestinations - return the number of possible destinations in this
2915   /// indirectbr instruction.
2916   unsigned getNumDestinations() const { return getNumOperands()-1; }
2917
2918   /// getDestination - Return the specified destination.
2919   BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
2920   const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
2921
2922   /// addDestination - Add a destination.
2923   ///
2924   void addDestination(BasicBlock *Dest);
2925
2926   /// removeDestination - This method removes the specified successor from the
2927   /// indirectbr instruction.
2928   void removeDestination(unsigned i);
2929
2930   unsigned getNumSuccessors() const { return getNumOperands()-1; }
2931   BasicBlock *getSuccessor(unsigned i) const {
2932     return cast<BasicBlock>(getOperand(i+1));
2933   }
2934   void setSuccessor(unsigned i, BasicBlock *NewSucc) {
2935     setOperand(i+1, (Value*)NewSucc);
2936   }
2937
2938   // Methods for support type inquiry through isa, cast, and dyn_cast:
2939   static inline bool classof(const IndirectBrInst *) { return true; }
2940   static inline bool classof(const Instruction *I) {
2941     return I->getOpcode() == Instruction::IndirectBr;
2942   }
2943   static inline bool classof(const Value *V) {
2944     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2945   }
2946 private:
2947   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2948   virtual unsigned getNumSuccessorsV() const;
2949   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2950 };
2951
2952 template <>
2953 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
2954 };
2955
2956 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
2957
2958
2959 //===----------------------------------------------------------------------===//
2960 //                               InvokeInst Class
2961 //===----------------------------------------------------------------------===//
2962
2963 /// InvokeInst - Invoke instruction.  The SubclassData field is used to hold the
2964 /// calling convention of the call.
2965 ///
2966 class InvokeInst : public TerminatorInst {
2967   AttrListPtr AttributeList;
2968   InvokeInst(const InvokeInst &BI);
2969   void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2970             ArrayRef<Value *> Args, const Twine &NameStr);
2971
2972   /// Construct an InvokeInst given a range of arguments.
2973   ///
2974   /// @brief Construct an InvokeInst from a range of arguments
2975   inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2976                     ArrayRef<Value *> Args, unsigned Values,
2977                     const Twine &NameStr, Instruction *InsertBefore);
2978
2979   /// Construct an InvokeInst given a range of arguments.
2980   ///
2981   /// @brief Construct an InvokeInst from a range of arguments
2982   inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2983                     ArrayRef<Value *> Args, unsigned Values,
2984                     const Twine &NameStr, BasicBlock *InsertAtEnd);
2985 protected:
2986   virtual InvokeInst *clone_impl() const;
2987 public:
2988   static InvokeInst *Create(Value *Func,
2989                             BasicBlock *IfNormal, BasicBlock *IfException,
2990                             ArrayRef<Value *> Args, const Twine &NameStr = "",
2991                             Instruction *InsertBefore = 0) {
2992     unsigned Values = unsigned(Args.size()) + 3;
2993     return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
2994                                   Values, NameStr, InsertBefore);
2995   }
2996   static InvokeInst *Create(Value *Func,
2997                             BasicBlock *IfNormal, BasicBlock *IfException,
2998                             ArrayRef<Value *> Args, const Twine &NameStr,
2999                             BasicBlock *InsertAtEnd) {
3000     unsigned Values = unsigned(Args.size()) + 3;
3001     return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3002                                   Values, NameStr, InsertAtEnd);
3003   }
3004
3005   /// Provide fast operand accessors
3006   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3007
3008   /// getNumArgOperands - Return the number of invoke arguments.
3009   ///
3010   unsigned getNumArgOperands() const { return getNumOperands() - 3; }
3011
3012   /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
3013   ///
3014   Value *getArgOperand(unsigned i) const { return getOperand(i); }
3015   void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
3016
3017   /// getCallingConv/setCallingConv - Get or set the calling convention of this
3018   /// function call.
3019   CallingConv::ID getCallingConv() const {
3020     return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
3021   }
3022   void setCallingConv(CallingConv::ID CC) {
3023     setInstructionSubclassData(static_cast<unsigned>(CC));
3024   }
3025
3026   /// getAttributes - Return the parameter attributes for this invoke.
3027   ///
3028   const AttrListPtr &getAttributes() const { return AttributeList; }
3029
3030   /// setAttributes - Set the parameter attributes for this invoke.
3031   ///
3032   void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
3033
3034   /// addAttribute - adds the attribute to the list of attributes.
3035   void addAttribute(unsigned i, Attributes attr);
3036
3037   /// removeAttribute - removes the attribute from the list of attributes.
3038   void removeAttribute(unsigned i, Attributes attr);
3039
3040   /// \brief Return true if this call has the given attribute.
3041   bool hasFnAttr(Attributes N) const {
3042     return paramHasAttr(~0, N);
3043   }
3044
3045   /// @brief Determine whether the call or the callee has the given attributes.
3046   bool paramHasSExtAttr(unsigned i) const;
3047   bool paramHasZExtAttr(unsigned i) const;
3048   bool paramHasInRegAttr(unsigned i) const;
3049   bool paramHasStructRetAttr(unsigned i) const;
3050   bool paramHasNestAttr(unsigned i) const;
3051   bool paramHasByValAttr(unsigned i) const;
3052
3053   /// @brief Determine whether the call or the callee has the given attribute.
3054   bool paramHasAttr(unsigned i, Attributes attr) const;
3055
3056   /// @brief Extract the alignment for a call or parameter (0=unknown).
3057   unsigned getParamAlignment(unsigned i) const {
3058     return AttributeList.getParamAlignment(i);
3059   }
3060
3061   /// @brief Return true if the call should not be inlined.
3062   bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
3063   void setIsNoInline(bool Value = true) {
3064     if (Value) addAttribute(~0, Attribute::NoInline);
3065     else removeAttribute(~0, Attribute::NoInline);
3066   }
3067
3068   /// @brief Determine if the call does not access memory.
3069   bool doesNotAccessMemory() const {
3070     return hasFnAttr(Attribute::ReadNone);
3071   }
3072   void setDoesNotAccessMemory(bool NotAccessMemory = true) {
3073     if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
3074     else removeAttribute(~0, Attribute::ReadNone);
3075   }
3076
3077   /// @brief Determine if the call does not access or only reads memory.
3078   bool onlyReadsMemory() const {
3079     return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
3080   }
3081   void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
3082     if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
3083     else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
3084   }
3085
3086   /// @brief Determine if the call cannot return.
3087   bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
3088   void setDoesNotReturn(bool DoesNotReturn = true) {
3089     if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
3090     else removeAttribute(~0, Attribute::NoReturn);
3091   }
3092
3093   /// @brief Determine if the call cannot unwind.
3094   bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
3095   void setDoesNotThrow(bool DoesNotThrow = true) {
3096     if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
3097     else removeAttribute(~0, Attribute::NoUnwind);
3098   }
3099
3100   /// @brief Determine if the call returns a structure through first
3101   /// pointer argument.
3102   bool hasStructRetAttr() const {
3103     // Be friendly and also check the callee.
3104     return paramHasAttr(1, Attribute::StructRet);
3105   }
3106
3107   /// @brief Determine if any call argument is an aggregate passed by value.
3108   bool hasByValArgument() const {
3109     return AttributeList.hasAttrSomewhere(Attribute::ByVal);
3110   }
3111
3112   /// getCalledFunction - Return the function called, or null if this is an
3113   /// indirect function invocation.
3114   ///
3115   Function *getCalledFunction() const {
3116     return dyn_cast<Function>(Op<-3>());
3117   }
3118
3119   /// getCalledValue - Get a pointer to the function that is invoked by this
3120   /// instruction
3121   const Value *getCalledValue() const { return Op<-3>(); }
3122         Value *getCalledValue()       { return Op<-3>(); }
3123
3124   /// setCalledFunction - Set the function called.
3125   void setCalledFunction(Value* Fn) {
3126     Op<-3>() = Fn;
3127   }
3128
3129   // get*Dest - Return the destination basic blocks...
3130   BasicBlock *getNormalDest() const {
3131     return cast<BasicBlock>(Op<-2>());
3132   }
3133   BasicBlock *getUnwindDest() const {
3134     return cast<BasicBlock>(Op<-1>());
3135   }
3136   void setNormalDest(BasicBlock *B) {
3137     Op<-2>() = reinterpret_cast<Value*>(B);
3138   }
3139   void setUnwindDest(BasicBlock *B) {
3140     Op<-1>() = reinterpret_cast<Value*>(B);
3141   }
3142
3143   /// getLandingPadInst - Get the landingpad instruction from the landing pad
3144   /// block (the unwind destination).
3145   LandingPadInst *getLandingPadInst() const;
3146
3147   BasicBlock *getSuccessor(unsigned i) const {
3148     assert(i < 2 && "Successor # out of range for invoke!");
3149     return i == 0 ? getNormalDest() : getUnwindDest();
3150   }
3151
3152   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3153     assert(idx < 2 && "Successor # out of range for invoke!");
3154     *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
3155   }
3156
3157   unsigned getNumSuccessors() const { return 2; }
3158
3159   // Methods for support type inquiry through isa, cast, and dyn_cast:
3160   static inline bool classof(const InvokeInst *) { return true; }
3161   static inline bool classof(const Instruction *I) {
3162     return (I->getOpcode() == Instruction::Invoke);
3163   }
3164   static inline bool classof(const Value *V) {
3165     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3166   }
3167
3168 private:
3169   virtual BasicBlock *getSuccessorV(unsigned idx) const;
3170   virtual unsigned getNumSuccessorsV() const;
3171   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3172
3173   // Shadow Instruction::setInstructionSubclassData with a private forwarding
3174   // method so that subclasses cannot accidentally use it.
3175   void setInstructionSubclassData(unsigned short D) {
3176     Instruction::setInstructionSubclassData(D);
3177   }
3178 };
3179
3180 template <>
3181 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
3182 };
3183
3184 InvokeInst::InvokeInst(Value *Func,
3185                        BasicBlock *IfNormal, BasicBlock *IfException,
3186                        ArrayRef<Value *> Args, unsigned Values,
3187                        const Twine &NameStr, Instruction *InsertBefore)
3188   : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3189                                       ->getElementType())->getReturnType(),
3190                    Instruction::Invoke,
3191                    OperandTraits<InvokeInst>::op_end(this) - Values,
3192                    Values, InsertBefore) {
3193   init(Func, IfNormal, IfException, Args, NameStr);
3194 }
3195 InvokeInst::InvokeInst(Value *Func,
3196                        BasicBlock *IfNormal, BasicBlock *IfException,
3197                        ArrayRef<Value *> Args, unsigned Values,
3198                        const Twine &NameStr, BasicBlock *InsertAtEnd)
3199   : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3200                                       ->getElementType())->getReturnType(),
3201                    Instruction::Invoke,
3202                    OperandTraits<InvokeInst>::op_end(this) - Values,
3203                    Values, InsertAtEnd) {
3204   init(Func, IfNormal, IfException, Args, NameStr);
3205 }
3206
3207 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
3208
3209 //===----------------------------------------------------------------------===//
3210 //                              ResumeInst Class
3211 //===----------------------------------------------------------------------===//
3212
3213 //===---------------------------------------------------------------------------
3214 /// ResumeInst - Resume the propagation of an exception.
3215 ///
3216 class ResumeInst : public TerminatorInst {
3217   ResumeInst(const ResumeInst &RI);
3218
3219   explicit ResumeInst(Value *Exn, Instruction *InsertBefore=0);
3220   ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
3221 protected:
3222   virtual ResumeInst *clone_impl() const;
3223 public:
3224   static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = 0) {
3225     return new(1) ResumeInst(Exn, InsertBefore);
3226   }
3227   static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
3228     return new(1) ResumeInst(Exn, InsertAtEnd);
3229   }
3230
3231   /// Provide fast operand accessors
3232   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3233
3234   /// Convenience accessor.
3235   Value *getValue() const { return Op<0>(); }
3236
3237   unsigned getNumSuccessors() const { return 0; }
3238
3239   // Methods for support type inquiry through isa, cast, and dyn_cast:
3240   static inline bool classof(const ResumeInst *) { return true; }
3241   static inline bool classof(const Instruction *I) {
3242     return I->getOpcode() == Instruction::Resume;
3243   }
3244   static inline bool classof(const Value *V) {
3245     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3246   }
3247 private:
3248   virtual BasicBlock *getSuccessorV(unsigned idx) const;
3249   virtual unsigned getNumSuccessorsV() const;
3250   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3251 };
3252
3253 template <>
3254 struct OperandTraits<ResumeInst> :
3255     public FixedNumOperandTraits<ResumeInst, 1> {
3256 };
3257
3258 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
3259
3260 //===----------------------------------------------------------------------===//
3261 //                           UnreachableInst Class
3262 //===----------------------------------------------------------------------===//
3263
3264 //===---------------------------------------------------------------------------
3265 /// UnreachableInst - This function has undefined behavior.  In particular, the
3266 /// presence of this instruction indicates some higher level knowledge that the
3267 /// end of the block cannot be reached.
3268 ///
3269 class UnreachableInst : public TerminatorInst {
3270   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
3271 protected:
3272   virtual UnreachableInst *clone_impl() const;
3273
3274 public:
3275   // allocate space for exactly zero operands
3276   void *operator new(size_t s) {
3277     return User::operator new(s, 0);
3278   }
3279   explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = 0);
3280   explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
3281
3282   unsigned getNumSuccessors() const { return 0; }
3283
3284   // Methods for support type inquiry through isa, cast, and dyn_cast:
3285   static inline bool classof(const UnreachableInst *) { return true; }
3286   static inline bool classof(const Instruction *I) {
3287     return I->getOpcode() == Instruction::Unreachable;
3288   }
3289   static inline bool classof(const Value *V) {
3290     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3291   }
3292 private:
3293   virtual BasicBlock *getSuccessorV(unsigned idx) const;
3294   virtual unsigned getNumSuccessorsV() const;
3295   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3296 };
3297
3298 //===----------------------------------------------------------------------===//
3299 //                                 TruncInst Class
3300 //===----------------------------------------------------------------------===//
3301
3302 /// @brief This class represents a truncation of integer types.
3303 class TruncInst : public CastInst {
3304 protected:
3305   /// @brief Clone an identical TruncInst
3306   virtual TruncInst *clone_impl() const;
3307
3308 public:
3309   /// @brief Constructor with insert-before-instruction semantics
3310   TruncInst(
3311     Value *S,                     ///< The value to be truncated
3312     Type *Ty,               ///< The (smaller) type to truncate to
3313     const Twine &NameStr = "",    ///< A name for the new instruction
3314     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3315   );
3316
3317   /// @brief Constructor with insert-at-end-of-block semantics
3318   TruncInst(
3319     Value *S,                     ///< The value to be truncated
3320     Type *Ty,               ///< The (smaller) type to truncate to
3321     const Twine &NameStr,         ///< A name for the new instruction
3322     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3323   );
3324
3325   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3326   static inline bool classof(const TruncInst *) { return true; }
3327   static inline bool classof(const Instruction *I) {
3328     return I->getOpcode() == Trunc;
3329   }
3330   static inline bool classof(const Value *V) {
3331     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3332   }
3333 };
3334
3335 //===----------------------------------------------------------------------===//
3336 //                                 ZExtInst Class
3337 //===----------------------------------------------------------------------===//
3338
3339 /// @brief This class represents zero extension of integer types.
3340 class ZExtInst : public CastInst {
3341 protected:
3342   /// @brief Clone an identical ZExtInst
3343   virtual ZExtInst *clone_impl() const;
3344
3345 public:
3346   /// @brief Constructor with insert-before-instruction semantics
3347   ZExtInst(
3348     Value *S,                     ///< The value to be zero extended
3349     Type *Ty,               ///< The type to zero extend to
3350     const Twine &NameStr = "",    ///< A name for the new instruction
3351     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3352   );
3353
3354   /// @brief Constructor with insert-at-end semantics.
3355   ZExtInst(
3356     Value *S,                     ///< The value to be zero extended
3357     Type *Ty,               ///< The type to zero extend to
3358     const Twine &NameStr,         ///< A name for the new instruction
3359     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3360   );
3361
3362   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3363   static inline bool classof(const ZExtInst *) { return true; }
3364   static inline bool classof(const Instruction *I) {
3365     return I->getOpcode() == ZExt;
3366   }
3367   static inline bool classof(const Value *V) {
3368     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3369   }
3370 };
3371
3372 //===----------------------------------------------------------------------===//
3373 //                                 SExtInst Class
3374 //===----------------------------------------------------------------------===//
3375
3376 /// @brief This class represents a sign extension of integer types.
3377 class SExtInst : public CastInst {
3378 protected:
3379   /// @brief Clone an identical SExtInst
3380   virtual SExtInst *clone_impl() const;
3381
3382 public:
3383   /// @brief Constructor with insert-before-instruction semantics
3384   SExtInst(
3385     Value *S,                     ///< The value to be sign extended
3386     Type *Ty,               ///< The type to sign extend to
3387     const Twine &NameStr = "",    ///< A name for the new instruction
3388     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3389   );
3390
3391   /// @brief Constructor with insert-at-end-of-block semantics
3392   SExtInst(
3393     Value *S,                     ///< The value to be sign extended
3394     Type *Ty,               ///< The type to sign extend to
3395     const Twine &NameStr,         ///< A name for the new instruction
3396     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3397   );
3398
3399   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3400   static inline bool classof(const SExtInst *) { return true; }
3401   static inline bool classof(const Instruction *I) {
3402     return I->getOpcode() == SExt;
3403   }
3404   static inline bool classof(const Value *V) {
3405     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3406   }
3407 };
3408
3409 //===----------------------------------------------------------------------===//
3410 //                                 FPTruncInst Class
3411 //===----------------------------------------------------------------------===//
3412
3413 /// @brief This class represents a truncation of floating point types.
3414 class FPTruncInst : public CastInst {
3415 protected:
3416   /// @brief Clone an identical FPTruncInst
3417   virtual FPTruncInst *clone_impl() const;
3418
3419 public:
3420   /// @brief Constructor with insert-before-instruction semantics
3421   FPTruncInst(
3422     Value *S,                     ///< The value to be truncated
3423     Type *Ty,               ///< The type to truncate to
3424     const Twine &NameStr = "",    ///< A name for the new instruction
3425     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3426   );
3427
3428   /// @brief Constructor with insert-before-instruction semantics
3429   FPTruncInst(
3430     Value *S,                     ///< The value to be truncated
3431     Type *Ty,               ///< The type to truncate to
3432     const Twine &NameStr,         ///< A name for the new instruction
3433     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3434   );
3435
3436   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3437   static inline bool classof(const FPTruncInst *) { return true; }
3438   static inline bool classof(const Instruction *I) {
3439     return I->getOpcode() == FPTrunc;
3440   }
3441   static inline bool classof(const Value *V) {
3442     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3443   }
3444 };
3445
3446 //===----------------------------------------------------------------------===//
3447 //                                 FPExtInst Class
3448 //===----------------------------------------------------------------------===//
3449
3450 /// @brief This class represents an extension of floating point types.
3451 class FPExtInst : public CastInst {
3452 protected:
3453   /// @brief Clone an identical FPExtInst
3454   virtual FPExtInst *clone_impl() const;
3455
3456 public:
3457   /// @brief Constructor with insert-before-instruction semantics
3458   FPExtInst(
3459     Value *S,                     ///< The value to be extended
3460     Type *Ty,               ///< The type to extend to
3461     const Twine &NameStr = "",    ///< A name for the new instruction
3462     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3463   );
3464
3465   /// @brief Constructor with insert-at-end-of-block semantics
3466   FPExtInst(
3467     Value *S,                     ///< The value to be extended
3468     Type *Ty,               ///< The type to extend to
3469     const Twine &NameStr,         ///< A name for the new instruction
3470     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3471   );
3472
3473   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3474   static inline bool classof(const FPExtInst *) { return true; }
3475   static inline bool classof(const Instruction *I) {
3476     return I->getOpcode() == FPExt;
3477   }
3478   static inline bool classof(const Value *V) {
3479     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3480   }
3481 };
3482
3483 //===----------------------------------------------------------------------===//
3484 //                                 UIToFPInst Class
3485 //===----------------------------------------------------------------------===//
3486
3487 /// @brief This class represents a cast unsigned integer to floating point.
3488 class UIToFPInst : public CastInst {
3489 protected:
3490   /// @brief Clone an identical UIToFPInst
3491   virtual UIToFPInst *clone_impl() const;
3492
3493 public:
3494   /// @brief Constructor with insert-before-instruction semantics
3495   UIToFPInst(
3496     Value *S,                     ///< The value to be converted
3497     Type *Ty,               ///< The type to convert to
3498     const Twine &NameStr = "",    ///< A name for the new instruction
3499     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3500   );
3501
3502   /// @brief Constructor with insert-at-end-of-block semantics
3503   UIToFPInst(
3504     Value *S,                     ///< The value to be converted
3505     Type *Ty,               ///< The type to convert to
3506     const Twine &NameStr,         ///< A name for the new instruction
3507     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3508   );
3509
3510   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3511   static inline bool classof(const UIToFPInst *) { return true; }
3512   static inline bool classof(const Instruction *I) {
3513     return I->getOpcode() == UIToFP;
3514   }
3515   static inline bool classof(const Value *V) {
3516     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3517   }
3518 };
3519
3520 //===----------------------------------------------------------------------===//
3521 //                                 SIToFPInst Class
3522 //===----------------------------------------------------------------------===//
3523
3524 /// @brief This class represents a cast from signed integer to floating point.
3525 class SIToFPInst : public CastInst {
3526 protected:
3527   /// @brief Clone an identical SIToFPInst
3528   virtual SIToFPInst *clone_impl() const;
3529
3530 public:
3531   /// @brief Constructor with insert-before-instruction semantics
3532   SIToFPInst(
3533     Value *S,                     ///< The value to be converted
3534     Type *Ty,               ///< The type to convert to
3535     const Twine &NameStr = "",    ///< A name for the new instruction
3536     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3537   );
3538
3539   /// @brief Constructor with insert-at-end-of-block semantics
3540   SIToFPInst(
3541     Value *S,                     ///< The value to be converted
3542     Type *Ty,               ///< The type to convert to
3543     const Twine &NameStr,         ///< A name for the new instruction
3544     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3545   );
3546
3547   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3548   static inline bool classof(const SIToFPInst *) { return true; }
3549   static inline bool classof(const Instruction *I) {
3550     return I->getOpcode() == SIToFP;
3551   }
3552   static inline bool classof(const Value *V) {
3553     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3554   }
3555 };
3556
3557 //===----------------------------------------------------------------------===//
3558 //                                 FPToUIInst Class
3559 //===----------------------------------------------------------------------===//
3560
3561 /// @brief This class represents a cast from floating point to unsigned integer
3562 class FPToUIInst  : public CastInst {
3563 protected:
3564   /// @brief Clone an identical FPToUIInst
3565   virtual FPToUIInst *clone_impl() const;
3566
3567 public:
3568   /// @brief Constructor with insert-before-instruction semantics
3569   FPToUIInst(
3570     Value *S,                     ///< The value to be converted
3571     Type *Ty,               ///< The type to convert to
3572     const Twine &NameStr = "",    ///< A name for the new instruction
3573     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3574   );
3575
3576   /// @brief Constructor with insert-at-end-of-block semantics
3577   FPToUIInst(
3578     Value *S,                     ///< The value to be converted
3579     Type *Ty,               ///< The type to convert to
3580     const Twine &NameStr,         ///< A name for the new instruction
3581     BasicBlock *InsertAtEnd       ///< Where to insert the new instruction
3582   );
3583
3584   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3585   static inline bool classof(const FPToUIInst *) { return true; }
3586   static inline bool classof(const Instruction *I) {
3587     return I->getOpcode() == FPToUI;
3588   }
3589   static inline bool classof(const Value *V) {
3590     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3591   }
3592 };
3593
3594 //===----------------------------------------------------------------------===//
3595 //                                 FPToSIInst Class
3596 //===----------------------------------------------------------------------===//
3597
3598 /// @brief This class represents a cast from floating point to signed integer.
3599 class FPToSIInst  : public CastInst {
3600 protected:
3601   /// @brief Clone an identical FPToSIInst
3602   virtual FPToSIInst *clone_impl() const;
3603
3604 public:
3605   /// @brief Constructor with insert-before-instruction semantics
3606   FPToSIInst(
3607     Value *S,                     ///< The value to be converted
3608     Type *Ty,               ///< The type to convert to
3609     const Twine &NameStr = "",    ///< A name for the new instruction
3610     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3611   );
3612
3613   /// @brief Constructor with insert-at-end-of-block semantics
3614   FPToSIInst(
3615     Value *S,                     ///< The value to be converted
3616     Type *Ty,               ///< The type to convert to
3617     const Twine &NameStr,         ///< A name for the new instruction
3618     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3619   );
3620
3621   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3622   static inline bool classof(const FPToSIInst *) { return true; }
3623   static inline bool classof(const Instruction *I) {
3624     return I->getOpcode() == FPToSI;
3625   }
3626   static inline bool classof(const Value *V) {
3627     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3628   }
3629 };
3630
3631 //===----------------------------------------------------------------------===//
3632 //                                 IntToPtrInst Class
3633 //===----------------------------------------------------------------------===//
3634
3635 /// @brief This class represents a cast from an integer to a pointer.
3636 class IntToPtrInst : public CastInst {
3637 public:
3638   /// @brief Constructor with insert-before-instruction semantics
3639   IntToPtrInst(
3640     Value *S,                     ///< The value to be converted
3641     Type *Ty,               ///< The type to convert to
3642     const Twine &NameStr = "",    ///< A name for the new instruction
3643     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3644   );
3645
3646   /// @brief Constructor with insert-at-end-of-block semantics
3647   IntToPtrInst(
3648     Value *S,                     ///< The value to be converted
3649     Type *Ty,               ///< The type to convert to
3650     const Twine &NameStr,         ///< A name for the new instruction
3651     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3652   );
3653
3654   /// @brief Clone an identical IntToPtrInst
3655   virtual IntToPtrInst *clone_impl() const;
3656
3657   // Methods for support type inquiry through isa, cast, and dyn_cast:
3658   static inline bool classof(const IntToPtrInst *) { return true; }
3659   static inline bool classof(const Instruction *I) {
3660     return I->getOpcode() == IntToPtr;
3661   }
3662   static inline bool classof(const Value *V) {
3663     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3664   }
3665 };
3666
3667 //===----------------------------------------------------------------------===//
3668 //                                 PtrToIntInst Class
3669 //===----------------------------------------------------------------------===//
3670
3671 /// @brief This class represents a cast from a pointer to an integer
3672 class PtrToIntInst : public CastInst {
3673 protected:
3674   /// @brief Clone an identical PtrToIntInst
3675   virtual PtrToIntInst *clone_impl() const;
3676
3677 public:
3678   /// @brief Constructor with insert-before-instruction semantics
3679   PtrToIntInst(
3680     Value *S,                     ///< The value to be converted
3681     Type *Ty,               ///< The type to convert to
3682     const Twine &NameStr = "",    ///< A name for the new instruction
3683     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3684   );
3685
3686   /// @brief Constructor with insert-at-end-of-block semantics
3687   PtrToIntInst(
3688     Value *S,                     ///< The value to be converted
3689     Type *Ty,               ///< The type to convert to
3690     const Twine &NameStr,         ///< A name for the new instruction
3691     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3692   );
3693
3694   // Methods for support type inquiry through isa, cast, and dyn_cast:
3695   static inline bool classof(const PtrToIntInst *) { return true; }
3696   static inline bool classof(const Instruction *I) {
3697     return I->getOpcode() == PtrToInt;
3698   }
3699   static inline bool classof(const Value *V) {
3700     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3701   }
3702 };
3703
3704 //===----------------------------------------------------------------------===//
3705 //                             BitCastInst Class
3706 //===----------------------------------------------------------------------===//
3707
3708 /// @brief This class represents a no-op cast from one type to another.
3709 class BitCastInst : public CastInst {
3710 protected:
3711   /// @brief Clone an identical BitCastInst
3712   virtual BitCastInst *clone_impl() const;
3713
3714 public:
3715   /// @brief Constructor with insert-before-instruction semantics
3716   BitCastInst(
3717     Value *S,                     ///< The value to be casted
3718     Type *Ty,               ///< The type to casted to
3719     const Twine &NameStr = "",    ///< A name for the new instruction
3720     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3721   );
3722
3723   /// @brief Constructor with insert-at-end-of-block semantics
3724   BitCastInst(
3725     Value *S,                     ///< The value to be casted
3726     Type *Ty,               ///< The type to casted to
3727     const Twine &NameStr,         ///< A name for the new instruction
3728     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3729   );
3730
3731   // Methods for support type inquiry through isa, cast, and dyn_cast:
3732   static inline bool classof(const BitCastInst *) { return true; }
3733   static inline bool classof(const Instruction *I) {
3734     return I->getOpcode() == BitCast;
3735   }
3736   static inline bool classof(const Value *V) {
3737     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3738   }
3739 };
3740
3741 } // End llvm namespace
3742
3743 #endif