Remove some dead methods.
[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 Determine whether this call has the given attribute.
1271   bool fnHasNoAliasAttr() const;
1272   bool fnHasNoInlineAttr() const;
1273   bool fnHasNoReturnAttr() const;
1274   bool fnHasNoUnwindAttr() const;
1275   bool fnHasReadNoneAttr() const;
1276   bool fnHasReadOnlyAttr() const;
1277   bool fnHasReturnsTwiceAttr() const;
1278
1279   /// @brief Determine whether the call or the callee has the given attributes.
1280   bool paramHasByValAttr(unsigned i) const;
1281   bool paramHasInRegAttr(unsigned i) const;
1282   bool paramHasNestAttr(unsigned i) const;
1283   bool paramHasNoAliasAttr(unsigned i) const;
1284   bool paramHasNoCaptureAttr(unsigned i) const;
1285   bool paramHasSExtAttr(unsigned i) const;
1286   bool paramHasStructRetAttr(unsigned i) const;
1287   bool paramHasZExtAttr(unsigned i) const;
1288
1289   /// @brief Extract the alignment for a call or parameter (0=unknown).
1290   unsigned getParamAlignment(unsigned i) const {
1291     return AttributeList.getParamAlignment(i);
1292   }
1293
1294   /// @brief Return true if the call should not be inlined.
1295   bool isNoInline() const { return fnHasNoInlineAttr(); }
1296   void setIsNoInline(bool Value = true) {
1297     if (Value) addAttribute(~0, Attribute::NoInline);
1298     else removeAttribute(~0, Attribute::NoInline);
1299   }
1300
1301   /// @brief Return true if the call can return twice
1302   bool canReturnTwice() const {
1303     return fnHasReturnsTwiceAttr();
1304   }
1305   void setCanReturnTwice(bool Value = true) {
1306     if (Value) addAttribute(~0, Attribute::ReturnsTwice);
1307     else removeAttribute(~0, Attribute::ReturnsTwice);
1308   }
1309
1310   /// @brief Determine if the call does not access memory.
1311   bool doesNotAccessMemory() const {
1312     return fnHasReadNoneAttr();
1313   }
1314   void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1315     if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
1316     else removeAttribute(~0, Attribute::ReadNone);
1317   }
1318
1319   /// @brief Determine if the call does not access or only reads memory.
1320   bool onlyReadsMemory() const {
1321     return doesNotAccessMemory() || fnHasReadOnlyAttr();
1322   }
1323   void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1324     if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
1325     else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
1326   }
1327
1328   /// @brief Determine if the call cannot return.
1329   bool doesNotReturn() const { return fnHasNoReturnAttr(); }
1330   void setDoesNotReturn(bool DoesNotReturn = true) {
1331     if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
1332     else removeAttribute(~0, Attribute::NoReturn);
1333   }
1334
1335   /// @brief Determine if the call cannot unwind.
1336   bool doesNotThrow() const { return fnHasNoUnwindAttr(); }
1337   void setDoesNotThrow(bool DoesNotThrow = true) {
1338     if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
1339     else removeAttribute(~0, Attribute::NoUnwind);
1340   }
1341
1342   /// @brief Determine if the call returns a structure through first
1343   /// pointer argument.
1344   bool hasStructRetAttr() const {
1345     // Be friendly and also check the callee.
1346     return paramHasStructRetAttr(1);
1347   }
1348
1349   /// @brief Determine if any call argument is an aggregate passed by value.
1350   bool hasByValArgument() const {
1351     for (unsigned I = 0, E = AttributeList.getNumAttrs(); I != E; ++I)
1352       if (AttributeList.getAttributesAtIndex(I).hasByValAttr())
1353         return true;
1354     return false;
1355   }
1356
1357   /// getCalledFunction - Return the function called, or null if this is an
1358   /// indirect function invocation.
1359   ///
1360   Function *getCalledFunction() const {
1361     return dyn_cast<Function>(Op<-1>());
1362   }
1363
1364   /// getCalledValue - Get a pointer to the function that is invoked by this
1365   /// instruction.
1366   const Value *getCalledValue() const { return Op<-1>(); }
1367         Value *getCalledValue()       { return Op<-1>(); }
1368
1369   /// setCalledFunction - Set the function called.
1370   void setCalledFunction(Value* Fn) {
1371     Op<-1>() = Fn;
1372   }
1373
1374   /// isInlineAsm - Check if this call is an inline asm statement.
1375   bool isInlineAsm() const {
1376     return isa<InlineAsm>(Op<-1>());
1377   }
1378
1379   // Methods for support type inquiry through isa, cast, and dyn_cast:
1380   static inline bool classof(const CallInst *) { return true; }
1381   static inline bool classof(const Instruction *I) {
1382     return I->getOpcode() == Instruction::Call;
1383   }
1384   static inline bool classof(const Value *V) {
1385     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1386   }
1387 private:
1388   // Shadow Instruction::setInstructionSubclassData with a private forwarding
1389   // method so that subclasses cannot accidentally use it.
1390   void setInstructionSubclassData(unsigned short D) {
1391     Instruction::setInstructionSubclassData(D);
1392   }
1393 };
1394
1395 template <>
1396 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1397 };
1398
1399 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1400                    const Twine &NameStr, BasicBlock *InsertAtEnd)
1401   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1402                                    ->getElementType())->getReturnType(),
1403                 Instruction::Call,
1404                 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1405                 unsigned(Args.size() + 1), InsertAtEnd) {
1406   init(Func, Args, NameStr);
1407 }
1408
1409 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1410                    const Twine &NameStr, Instruction *InsertBefore)
1411   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1412                                    ->getElementType())->getReturnType(),
1413                 Instruction::Call,
1414                 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1415                 unsigned(Args.size() + 1), InsertBefore) {
1416   init(Func, Args, NameStr);
1417 }
1418
1419
1420 // Note: if you get compile errors about private methods then
1421 //       please update your code to use the high-level operand
1422 //       interfaces. See line 943 above.
1423 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1424
1425 //===----------------------------------------------------------------------===//
1426 //                               SelectInst Class
1427 //===----------------------------------------------------------------------===//
1428
1429 /// SelectInst - This class represents the LLVM 'select' instruction.
1430 ///
1431 class SelectInst : public Instruction {
1432   void init(Value *C, Value *S1, Value *S2) {
1433     assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1434     Op<0>() = C;
1435     Op<1>() = S1;
1436     Op<2>() = S2;
1437   }
1438
1439   SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1440              Instruction *InsertBefore)
1441     : Instruction(S1->getType(), Instruction::Select,
1442                   &Op<0>(), 3, InsertBefore) {
1443     init(C, S1, S2);
1444     setName(NameStr);
1445   }
1446   SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1447              BasicBlock *InsertAtEnd)
1448     : Instruction(S1->getType(), Instruction::Select,
1449                   &Op<0>(), 3, InsertAtEnd) {
1450     init(C, S1, S2);
1451     setName(NameStr);
1452   }
1453 protected:
1454   virtual SelectInst *clone_impl() const;
1455 public:
1456   static SelectInst *Create(Value *C, Value *S1, Value *S2,
1457                             const Twine &NameStr = "",
1458                             Instruction *InsertBefore = 0) {
1459     return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1460   }
1461   static SelectInst *Create(Value *C, Value *S1, Value *S2,
1462                             const Twine &NameStr,
1463                             BasicBlock *InsertAtEnd) {
1464     return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1465   }
1466
1467   const Value *getCondition() const { return Op<0>(); }
1468   const Value *getTrueValue() const { return Op<1>(); }
1469   const Value *getFalseValue() const { return Op<2>(); }
1470   Value *getCondition() { return Op<0>(); }
1471   Value *getTrueValue() { return Op<1>(); }
1472   Value *getFalseValue() { return Op<2>(); }
1473
1474   /// areInvalidOperands - Return a string if the specified operands are invalid
1475   /// for a select operation, otherwise return null.
1476   static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1477
1478   /// Transparently provide more efficient getOperand methods.
1479   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1480
1481   OtherOps getOpcode() const {
1482     return static_cast<OtherOps>(Instruction::getOpcode());
1483   }
1484
1485   // Methods for support type inquiry through isa, cast, and dyn_cast:
1486   static inline bool classof(const SelectInst *) { return true; }
1487   static inline bool classof(const Instruction *I) {
1488     return I->getOpcode() == Instruction::Select;
1489   }
1490   static inline bool classof(const Value *V) {
1491     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1492   }
1493 };
1494
1495 template <>
1496 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1497 };
1498
1499 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1500
1501 //===----------------------------------------------------------------------===//
1502 //                                VAArgInst Class
1503 //===----------------------------------------------------------------------===//
1504
1505 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1506 /// an argument of the specified type given a va_list and increments that list
1507 ///
1508 class VAArgInst : public UnaryInstruction {
1509 protected:
1510   virtual VAArgInst *clone_impl() const;
1511
1512 public:
1513   VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1514              Instruction *InsertBefore = 0)
1515     : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1516     setName(NameStr);
1517   }
1518   VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1519             BasicBlock *InsertAtEnd)
1520     : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1521     setName(NameStr);
1522   }
1523
1524   Value *getPointerOperand() { return getOperand(0); }
1525   const Value *getPointerOperand() const { return getOperand(0); }
1526   static unsigned getPointerOperandIndex() { return 0U; }
1527
1528   // Methods for support type inquiry through isa, cast, and dyn_cast:
1529   static inline bool classof(const VAArgInst *) { return true; }
1530   static inline bool classof(const Instruction *I) {
1531     return I->getOpcode() == VAArg;
1532   }
1533   static inline bool classof(const Value *V) {
1534     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1535   }
1536 };
1537
1538 //===----------------------------------------------------------------------===//
1539 //                                ExtractElementInst Class
1540 //===----------------------------------------------------------------------===//
1541
1542 /// ExtractElementInst - This instruction extracts a single (scalar)
1543 /// element from a VectorType value
1544 ///
1545 class ExtractElementInst : public Instruction {
1546   ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1547                      Instruction *InsertBefore = 0);
1548   ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1549                      BasicBlock *InsertAtEnd);
1550 protected:
1551   virtual ExtractElementInst *clone_impl() const;
1552
1553 public:
1554   static ExtractElementInst *Create(Value *Vec, Value *Idx,
1555                                    const Twine &NameStr = "",
1556                                    Instruction *InsertBefore = 0) {
1557     return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1558   }
1559   static ExtractElementInst *Create(Value *Vec, Value *Idx,
1560                                    const Twine &NameStr,
1561                                    BasicBlock *InsertAtEnd) {
1562     return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1563   }
1564
1565   /// isValidOperands - Return true if an extractelement instruction can be
1566   /// formed with the specified operands.
1567   static bool isValidOperands(const Value *Vec, const Value *Idx);
1568
1569   Value *getVectorOperand() { return Op<0>(); }
1570   Value *getIndexOperand() { return Op<1>(); }
1571   const Value *getVectorOperand() const { return Op<0>(); }
1572   const Value *getIndexOperand() const { return Op<1>(); }
1573
1574   VectorType *getVectorOperandType() const {
1575     return reinterpret_cast<VectorType*>(getVectorOperand()->getType());
1576   }
1577
1578
1579   /// Transparently provide more efficient getOperand methods.
1580   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1581
1582   // Methods for support type inquiry through isa, cast, and dyn_cast:
1583   static inline bool classof(const ExtractElementInst *) { return true; }
1584   static inline bool classof(const Instruction *I) {
1585     return I->getOpcode() == Instruction::ExtractElement;
1586   }
1587   static inline bool classof(const Value *V) {
1588     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1589   }
1590 };
1591
1592 template <>
1593 struct OperandTraits<ExtractElementInst> :
1594   public FixedNumOperandTraits<ExtractElementInst, 2> {
1595 };
1596
1597 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1598
1599 //===----------------------------------------------------------------------===//
1600 //                                InsertElementInst Class
1601 //===----------------------------------------------------------------------===//
1602
1603 /// InsertElementInst - This instruction inserts a single (scalar)
1604 /// element into a VectorType value
1605 ///
1606 class InsertElementInst : public Instruction {
1607   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1608                     const Twine &NameStr = "",
1609                     Instruction *InsertBefore = 0);
1610   InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1611                     const Twine &NameStr, BasicBlock *InsertAtEnd);
1612 protected:
1613   virtual InsertElementInst *clone_impl() const;
1614
1615 public:
1616   static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1617                                    const Twine &NameStr = "",
1618                                    Instruction *InsertBefore = 0) {
1619     return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1620   }
1621   static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1622                                    const Twine &NameStr,
1623                                    BasicBlock *InsertAtEnd) {
1624     return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1625   }
1626
1627   /// isValidOperands - Return true if an insertelement instruction can be
1628   /// formed with the specified operands.
1629   static bool isValidOperands(const Value *Vec, const Value *NewElt,
1630                               const Value *Idx);
1631
1632   /// getType - Overload to return most specific vector type.
1633   ///
1634   VectorType *getType() const {
1635     return reinterpret_cast<VectorType*>(Instruction::getType());
1636   }
1637
1638   /// Transparently provide more efficient getOperand methods.
1639   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1640
1641   // Methods for support type inquiry through isa, cast, and dyn_cast:
1642   static inline bool classof(const InsertElementInst *) { return true; }
1643   static inline bool classof(const Instruction *I) {
1644     return I->getOpcode() == Instruction::InsertElement;
1645   }
1646   static inline bool classof(const Value *V) {
1647     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1648   }
1649 };
1650
1651 template <>
1652 struct OperandTraits<InsertElementInst> :
1653   public FixedNumOperandTraits<InsertElementInst, 3> {
1654 };
1655
1656 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1657
1658 //===----------------------------------------------------------------------===//
1659 //                           ShuffleVectorInst Class
1660 //===----------------------------------------------------------------------===//
1661
1662 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1663 /// input vectors.
1664 ///
1665 class ShuffleVectorInst : public Instruction {
1666 protected:
1667   virtual ShuffleVectorInst *clone_impl() const;
1668
1669 public:
1670   // allocate space for exactly three operands
1671   void *operator new(size_t s) {
1672     return User::operator new(s, 3);
1673   }
1674   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1675                     const Twine &NameStr = "",
1676                     Instruction *InsertBefor = 0);
1677   ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1678                     const Twine &NameStr, BasicBlock *InsertAtEnd);
1679
1680   /// isValidOperands - Return true if a shufflevector instruction can be
1681   /// formed with the specified operands.
1682   static bool isValidOperands(const Value *V1, const Value *V2,
1683                               const Value *Mask);
1684
1685   /// getType - Overload to return most specific vector type.
1686   ///
1687   VectorType *getType() const {
1688     return reinterpret_cast<VectorType*>(Instruction::getType());
1689   }
1690
1691   /// Transparently provide more efficient getOperand methods.
1692   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1693
1694   Constant *getMask() const {
1695     return reinterpret_cast<Constant*>(getOperand(2));
1696   }
1697   
1698   /// getMaskValue - Return the index from the shuffle mask for the specified
1699   /// output result.  This is either -1 if the element is undef or a number less
1700   /// than 2*numelements.
1701   static int getMaskValue(Constant *Mask, unsigned i);
1702
1703   int getMaskValue(unsigned i) const {
1704     return getMaskValue(getMask(), i);
1705   }
1706   
1707   /// getShuffleMask - Return the full mask for this instruction, where each
1708   /// element is the element number and undef's are returned as -1.
1709   static void getShuffleMask(Constant *Mask, SmallVectorImpl<int> &Result);
1710
1711   void getShuffleMask(SmallVectorImpl<int> &Result) const {
1712     return getShuffleMask(getMask(), Result);
1713   }
1714
1715   SmallVector<int, 16> getShuffleMask() const {
1716     SmallVector<int, 16> Mask;
1717     getShuffleMask(Mask);
1718     return Mask;
1719   }
1720
1721
1722   // Methods for support type inquiry through isa, cast, and dyn_cast:
1723   static inline bool classof(const ShuffleVectorInst *) { return true; }
1724   static inline bool classof(const Instruction *I) {
1725     return I->getOpcode() == Instruction::ShuffleVector;
1726   }
1727   static inline bool classof(const Value *V) {
1728     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1729   }
1730 };
1731
1732 template <>
1733 struct OperandTraits<ShuffleVectorInst> :
1734   public FixedNumOperandTraits<ShuffleVectorInst, 3> {
1735 };
1736
1737 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1738
1739 //===----------------------------------------------------------------------===//
1740 //                                ExtractValueInst Class
1741 //===----------------------------------------------------------------------===//
1742
1743 /// ExtractValueInst - This instruction extracts a struct member or array
1744 /// element value from an aggregate value.
1745 ///
1746 class ExtractValueInst : public UnaryInstruction {
1747   SmallVector<unsigned, 4> Indices;
1748
1749   ExtractValueInst(const ExtractValueInst &EVI);
1750   void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
1751
1752   /// Constructors - Create a extractvalue instruction with a base aggregate
1753   /// value and a list of indices.  The first ctor can optionally insert before
1754   /// an existing instruction, the second appends the new instruction to the
1755   /// specified BasicBlock.
1756   inline ExtractValueInst(Value *Agg,
1757                           ArrayRef<unsigned> Idxs,
1758                           const Twine &NameStr,
1759                           Instruction *InsertBefore);
1760   inline ExtractValueInst(Value *Agg,
1761                           ArrayRef<unsigned> Idxs,
1762                           const Twine &NameStr, BasicBlock *InsertAtEnd);
1763
1764   // allocate space for exactly one operand
1765   void *operator new(size_t s) {
1766     return User::operator new(s, 1);
1767   }
1768 protected:
1769   virtual ExtractValueInst *clone_impl() const;
1770
1771 public:
1772   static ExtractValueInst *Create(Value *Agg,
1773                                   ArrayRef<unsigned> Idxs,
1774                                   const Twine &NameStr = "",
1775                                   Instruction *InsertBefore = 0) {
1776     return new
1777       ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
1778   }
1779   static ExtractValueInst *Create(Value *Agg,
1780                                   ArrayRef<unsigned> Idxs,
1781                                   const Twine &NameStr,
1782                                   BasicBlock *InsertAtEnd) {
1783     return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
1784   }
1785
1786   /// getIndexedType - Returns the type of the element that would be extracted
1787   /// with an extractvalue instruction with the specified parameters.
1788   ///
1789   /// Null is returned if the indices are invalid for the specified type.
1790   static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
1791
1792   typedef const unsigned* idx_iterator;
1793   inline idx_iterator idx_begin() const { return Indices.begin(); }
1794   inline idx_iterator idx_end()   const { return Indices.end(); }
1795
1796   Value *getAggregateOperand() {
1797     return getOperand(0);
1798   }
1799   const Value *getAggregateOperand() const {
1800     return getOperand(0);
1801   }
1802   static unsigned getAggregateOperandIndex() {
1803     return 0U;                      // get index for modifying correct operand
1804   }
1805
1806   ArrayRef<unsigned> getIndices() const {
1807     return Indices;
1808   }
1809
1810   unsigned getNumIndices() const {
1811     return (unsigned)Indices.size();
1812   }
1813
1814   bool hasIndices() const {
1815     return true;
1816   }
1817
1818   // Methods for support type inquiry through isa, cast, and dyn_cast:
1819   static inline bool classof(const ExtractValueInst *) { return true; }
1820   static inline bool classof(const Instruction *I) {
1821     return I->getOpcode() == Instruction::ExtractValue;
1822   }
1823   static inline bool classof(const Value *V) {
1824     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1825   }
1826 };
1827
1828 ExtractValueInst::ExtractValueInst(Value *Agg,
1829                                    ArrayRef<unsigned> Idxs,
1830                                    const Twine &NameStr,
1831                                    Instruction *InsertBefore)
1832   : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
1833                      ExtractValue, Agg, InsertBefore) {
1834   init(Idxs, NameStr);
1835 }
1836 ExtractValueInst::ExtractValueInst(Value *Agg,
1837                                    ArrayRef<unsigned> Idxs,
1838                                    const Twine &NameStr,
1839                                    BasicBlock *InsertAtEnd)
1840   : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
1841                      ExtractValue, Agg, InsertAtEnd) {
1842   init(Idxs, NameStr);
1843 }
1844
1845
1846 //===----------------------------------------------------------------------===//
1847 //                                InsertValueInst Class
1848 //===----------------------------------------------------------------------===//
1849
1850 /// InsertValueInst - This instruction inserts a struct field of array element
1851 /// value into an aggregate value.
1852 ///
1853 class InsertValueInst : public Instruction {
1854   SmallVector<unsigned, 4> Indices;
1855
1856   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
1857   InsertValueInst(const InsertValueInst &IVI);
1858   void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
1859             const Twine &NameStr);
1860
1861   /// Constructors - Create a insertvalue instruction with a base aggregate
1862   /// value, a value to insert, and a list of indices.  The first ctor can
1863   /// optionally insert before an existing instruction, the second appends
1864   /// the new instruction to the specified BasicBlock.
1865   inline InsertValueInst(Value *Agg, Value *Val,
1866                          ArrayRef<unsigned> Idxs,
1867                          const Twine &NameStr,
1868                          Instruction *InsertBefore);
1869   inline InsertValueInst(Value *Agg, Value *Val,
1870                          ArrayRef<unsigned> Idxs,
1871                          const Twine &NameStr, BasicBlock *InsertAtEnd);
1872
1873   /// Constructors - These two constructors are convenience methods because one
1874   /// and two index insertvalue instructions are so common.
1875   InsertValueInst(Value *Agg, Value *Val,
1876                   unsigned Idx, const Twine &NameStr = "",
1877                   Instruction *InsertBefore = 0);
1878   InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1879                   const Twine &NameStr, BasicBlock *InsertAtEnd);
1880 protected:
1881   virtual InsertValueInst *clone_impl() const;
1882 public:
1883   // allocate space for exactly two operands
1884   void *operator new(size_t s) {
1885     return User::operator new(s, 2);
1886   }
1887
1888   static InsertValueInst *Create(Value *Agg, Value *Val,
1889                                  ArrayRef<unsigned> Idxs,
1890                                  const Twine &NameStr = "",
1891                                  Instruction *InsertBefore = 0) {
1892     return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
1893   }
1894   static InsertValueInst *Create(Value *Agg, Value *Val,
1895                                  ArrayRef<unsigned> Idxs,
1896                                  const Twine &NameStr,
1897                                  BasicBlock *InsertAtEnd) {
1898     return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
1899   }
1900
1901   /// Transparently provide more efficient getOperand methods.
1902   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1903
1904   typedef const unsigned* idx_iterator;
1905   inline idx_iterator idx_begin() const { return Indices.begin(); }
1906   inline idx_iterator idx_end()   const { return Indices.end(); }
1907
1908   Value *getAggregateOperand() {
1909     return getOperand(0);
1910   }
1911   const Value *getAggregateOperand() const {
1912     return getOperand(0);
1913   }
1914   static unsigned getAggregateOperandIndex() {
1915     return 0U;                      // get index for modifying correct operand
1916   }
1917
1918   Value *getInsertedValueOperand() {
1919     return getOperand(1);
1920   }
1921   const Value *getInsertedValueOperand() const {
1922     return getOperand(1);
1923   }
1924   static unsigned getInsertedValueOperandIndex() {
1925     return 1U;                      // get index for modifying correct operand
1926   }
1927
1928   ArrayRef<unsigned> getIndices() const {
1929     return Indices;
1930   }
1931
1932   unsigned getNumIndices() const {
1933     return (unsigned)Indices.size();
1934   }
1935
1936   bool hasIndices() const {
1937     return true;
1938   }
1939
1940   // Methods for support type inquiry through isa, cast, and dyn_cast:
1941   static inline bool classof(const InsertValueInst *) { return true; }
1942   static inline bool classof(const Instruction *I) {
1943     return I->getOpcode() == Instruction::InsertValue;
1944   }
1945   static inline bool classof(const Value *V) {
1946     return isa<Instruction>(V) && classof(cast<Instruction>(V));
1947   }
1948 };
1949
1950 template <>
1951 struct OperandTraits<InsertValueInst> :
1952   public FixedNumOperandTraits<InsertValueInst, 2> {
1953 };
1954
1955 InsertValueInst::InsertValueInst(Value *Agg,
1956                                  Value *Val,
1957                                  ArrayRef<unsigned> Idxs,
1958                                  const Twine &NameStr,
1959                                  Instruction *InsertBefore)
1960   : Instruction(Agg->getType(), InsertValue,
1961                 OperandTraits<InsertValueInst>::op_begin(this),
1962                 2, InsertBefore) {
1963   init(Agg, Val, Idxs, NameStr);
1964 }
1965 InsertValueInst::InsertValueInst(Value *Agg,
1966                                  Value *Val,
1967                                  ArrayRef<unsigned> Idxs,
1968                                  const Twine &NameStr,
1969                                  BasicBlock *InsertAtEnd)
1970   : Instruction(Agg->getType(), InsertValue,
1971                 OperandTraits<InsertValueInst>::op_begin(this),
1972                 2, InsertAtEnd) {
1973   init(Agg, Val, Idxs, NameStr);
1974 }
1975
1976 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1977
1978 //===----------------------------------------------------------------------===//
1979 //                               PHINode Class
1980 //===----------------------------------------------------------------------===//
1981
1982 // PHINode - The PHINode class is used to represent the magical mystical PHI
1983 // node, that can not exist in nature, but can be synthesized in a computer
1984 // scientist's overactive imagination.
1985 //
1986 class PHINode : public Instruction {
1987   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
1988   /// ReservedSpace - The number of operands actually allocated.  NumOperands is
1989   /// the number actually in use.
1990   unsigned ReservedSpace;
1991   PHINode(const PHINode &PN);
1992   // allocate space for exactly zero operands
1993   void *operator new(size_t s) {
1994     return User::operator new(s, 0);
1995   }
1996   explicit PHINode(Type *Ty, unsigned NumReservedValues,
1997                    const Twine &NameStr = "", Instruction *InsertBefore = 0)
1998     : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1999       ReservedSpace(NumReservedValues) {
2000     setName(NameStr);
2001     OperandList = allocHungoffUses(ReservedSpace);
2002   }
2003
2004   PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
2005           BasicBlock *InsertAtEnd)
2006     : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
2007       ReservedSpace(NumReservedValues) {
2008     setName(NameStr);
2009     OperandList = allocHungoffUses(ReservedSpace);
2010   }
2011 protected:
2012   // allocHungoffUses - this is more complicated than the generic
2013   // User::allocHungoffUses, because we have to allocate Uses for the incoming
2014   // values and pointers to the incoming blocks, all in one allocation.
2015   Use *allocHungoffUses(unsigned) const;
2016
2017   virtual PHINode *clone_impl() const;
2018 public:
2019   /// Constructors - NumReservedValues is a hint for the number of incoming
2020   /// edges that this phi node will have (use 0 if you really have no idea).
2021   static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2022                          const Twine &NameStr = "",
2023                          Instruction *InsertBefore = 0) {
2024     return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2025   }
2026   static PHINode *Create(Type *Ty, unsigned NumReservedValues, 
2027                          const Twine &NameStr, BasicBlock *InsertAtEnd) {
2028     return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2029   }
2030   ~PHINode();
2031
2032   /// Provide fast operand accessors
2033   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2034
2035   // Block iterator interface. This provides access to the list of incoming
2036   // basic blocks, which parallels the list of incoming values.
2037
2038   typedef BasicBlock **block_iterator;
2039   typedef BasicBlock * const *const_block_iterator;
2040
2041   block_iterator block_begin() {
2042     Use::UserRef *ref =
2043       reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2044     return reinterpret_cast<block_iterator>(ref + 1);
2045   }
2046
2047   const_block_iterator block_begin() const {
2048     const Use::UserRef *ref =
2049       reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2050     return reinterpret_cast<const_block_iterator>(ref + 1);
2051   }
2052
2053   block_iterator block_end() {
2054     return block_begin() + getNumOperands();
2055   }
2056
2057   const_block_iterator block_end() const {
2058     return block_begin() + getNumOperands();
2059   }
2060
2061   /// getNumIncomingValues - Return the number of incoming edges
2062   ///
2063   unsigned getNumIncomingValues() const { return getNumOperands(); }
2064
2065   /// getIncomingValue - Return incoming value number x
2066   ///
2067   Value *getIncomingValue(unsigned i) const {
2068     return getOperand(i);
2069   }
2070   void setIncomingValue(unsigned i, Value *V) {
2071     setOperand(i, V);
2072   }
2073   static unsigned getOperandNumForIncomingValue(unsigned i) {
2074     return i;
2075   }
2076   static unsigned getIncomingValueNumForOperand(unsigned i) {
2077     return i;
2078   }
2079
2080   /// getIncomingBlock - Return incoming basic block number @p i.
2081   ///
2082   BasicBlock *getIncomingBlock(unsigned i) const {
2083     return block_begin()[i];
2084   }
2085
2086   /// getIncomingBlock - Return incoming basic block corresponding
2087   /// to an operand of the PHI.
2088   ///
2089   BasicBlock *getIncomingBlock(const Use &U) const {
2090     assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2091     return getIncomingBlock(unsigned(&U - op_begin()));
2092   }
2093
2094   /// getIncomingBlock - Return incoming basic block corresponding
2095   /// to value use iterator.
2096   ///
2097   template <typename U>
2098   BasicBlock *getIncomingBlock(value_use_iterator<U> I) const {
2099     return getIncomingBlock(I.getUse());
2100   }
2101
2102   void setIncomingBlock(unsigned i, BasicBlock *BB) {
2103     block_begin()[i] = BB;
2104   }
2105
2106   /// addIncoming - Add an incoming value to the end of the PHI list
2107   ///
2108   void addIncoming(Value *V, BasicBlock *BB) {
2109     assert(V && "PHI node got a null value!");
2110     assert(BB && "PHI node got a null basic block!");
2111     assert(getType() == V->getType() &&
2112            "All operands to PHI node must be the same type as the PHI node!");
2113     if (NumOperands == ReservedSpace)
2114       growOperands();  // Get more space!
2115     // Initialize some new operands.
2116     ++NumOperands;
2117     setIncomingValue(NumOperands - 1, V);
2118     setIncomingBlock(NumOperands - 1, BB);
2119   }
2120
2121   /// removeIncomingValue - Remove an incoming value.  This is useful if a
2122   /// predecessor basic block is deleted.  The value removed is returned.
2123   ///
2124   /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2125   /// is true), the PHI node is destroyed and any uses of it are replaced with
2126   /// dummy values.  The only time there should be zero incoming values to a PHI
2127   /// node is when the block is dead, so this strategy is sound.
2128   ///
2129   Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2130
2131   Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2132     int Idx = getBasicBlockIndex(BB);
2133     assert(Idx >= 0 && "Invalid basic block argument to remove!");
2134     return removeIncomingValue(Idx, DeletePHIIfEmpty);
2135   }
2136
2137   /// getBasicBlockIndex - Return the first index of the specified basic
2138   /// block in the value list for this PHI.  Returns -1 if no instance.
2139   ///
2140   int getBasicBlockIndex(const BasicBlock *BB) const {
2141     for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2142       if (block_begin()[i] == BB)
2143         return i;
2144     return -1;
2145   }
2146
2147   Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2148     int Idx = getBasicBlockIndex(BB);
2149     assert(Idx >= 0 && "Invalid basic block argument!");
2150     return getIncomingValue(Idx);
2151   }
2152
2153   /// hasConstantValue - If the specified PHI node always merges together the
2154   /// same value, return the value, otherwise return null.
2155   Value *hasConstantValue() const;
2156
2157   /// Methods for support type inquiry through isa, cast, and dyn_cast:
2158   static inline bool classof(const PHINode *) { return true; }
2159   static inline bool classof(const Instruction *I) {
2160     return I->getOpcode() == Instruction::PHI;
2161   }
2162   static inline bool classof(const Value *V) {
2163     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2164   }
2165  private:
2166   void growOperands();
2167 };
2168
2169 template <>
2170 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2171 };
2172
2173 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2174
2175 //===----------------------------------------------------------------------===//
2176 //                           LandingPadInst Class
2177 //===----------------------------------------------------------------------===//
2178
2179 //===---------------------------------------------------------------------------
2180 /// LandingPadInst - The landingpad instruction holds all of the information
2181 /// necessary to generate correct exception handling. The landingpad instruction
2182 /// cannot be moved from the top of a landing pad block, which itself is
2183 /// accessible only from the 'unwind' edge of an invoke. This uses the
2184 /// SubclassData field in Value to store whether or not the landingpad is a
2185 /// cleanup.
2186 ///
2187 class LandingPadInst : public Instruction {
2188   /// ReservedSpace - The number of operands actually allocated.  NumOperands is
2189   /// the number actually in use.
2190   unsigned ReservedSpace;
2191   LandingPadInst(const LandingPadInst &LP);
2192 public:
2193   enum ClauseType { Catch, Filter };
2194 private:
2195   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2196   // Allocate space for exactly zero operands.
2197   void *operator new(size_t s) {
2198     return User::operator new(s, 0);
2199   }
2200   void growOperands(unsigned Size);
2201   void init(Value *PersFn, unsigned NumReservedValues, const Twine &NameStr);
2202
2203   explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2204                           unsigned NumReservedValues, const Twine &NameStr,
2205                           Instruction *InsertBefore);
2206   explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2207                           unsigned NumReservedValues, const Twine &NameStr,
2208                           BasicBlock *InsertAtEnd);
2209 protected:
2210   virtual LandingPadInst *clone_impl() const;
2211 public:
2212   /// Constructors - NumReservedClauses is a hint for the number of incoming
2213   /// clauses that this landingpad will have (use 0 if you really have no idea).
2214   static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2215                                 unsigned NumReservedClauses,
2216                                 const Twine &NameStr = "",
2217                                 Instruction *InsertBefore = 0);
2218   static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2219                                 unsigned NumReservedClauses,
2220                                 const Twine &NameStr, BasicBlock *InsertAtEnd);
2221   ~LandingPadInst();
2222
2223   /// Provide fast operand accessors
2224   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2225
2226   /// getPersonalityFn - Get the personality function associated with this
2227   /// landing pad.
2228   Value *getPersonalityFn() const { return getOperand(0); }
2229
2230   /// isCleanup - Return 'true' if this landingpad instruction is a
2231   /// cleanup. I.e., it should be run when unwinding even if its landing pad
2232   /// doesn't catch the exception.
2233   bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2234
2235   /// setCleanup - Indicate that this landingpad instruction is a cleanup.
2236   void setCleanup(bool V) {
2237     setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2238                                (V ? 1 : 0));
2239   }
2240
2241   /// addClause - Add a catch or filter clause to the landing pad.
2242   void addClause(Value *ClauseVal);
2243
2244   /// getClause - Get the value of the clause at index Idx. Use isCatch/isFilter
2245   /// to determine what type of clause this is.
2246   Value *getClause(unsigned Idx) const { return OperandList[Idx + 1]; }
2247
2248   /// isCatch - Return 'true' if the clause and index Idx is a catch clause.
2249   bool isCatch(unsigned Idx) const {
2250     return !isa<ArrayType>(OperandList[Idx + 1]->getType());
2251   }
2252
2253   /// isFilter - Return 'true' if the clause and index Idx is a filter clause.
2254   bool isFilter(unsigned Idx) const {
2255     return isa<ArrayType>(OperandList[Idx + 1]->getType());
2256   }
2257
2258   /// getNumClauses - Get the number of clauses for this landing pad.
2259   unsigned getNumClauses() const { return getNumOperands() - 1; }
2260
2261   /// reserveClauses - Grow the size of the operand list to accommodate the new
2262   /// number of clauses.
2263   void reserveClauses(unsigned Size) { growOperands(Size); }
2264
2265   // Methods for support type inquiry through isa, cast, and dyn_cast:
2266   static inline bool classof(const LandingPadInst *) { return true; }
2267   static inline bool classof(const Instruction *I) {
2268     return I->getOpcode() == Instruction::LandingPad;
2269   }
2270   static inline bool classof(const Value *V) {
2271     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2272   }
2273 };
2274
2275 template <>
2276 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<2> {
2277 };
2278
2279 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2280
2281 //===----------------------------------------------------------------------===//
2282 //                               ReturnInst Class
2283 //===----------------------------------------------------------------------===//
2284
2285 //===---------------------------------------------------------------------------
2286 /// ReturnInst - Return a value (possibly void), from a function.  Execution
2287 /// does not continue in this function any longer.
2288 ///
2289 class ReturnInst : public TerminatorInst {
2290   ReturnInst(const ReturnInst &RI);
2291
2292 private:
2293   // ReturnInst constructors:
2294   // ReturnInst()                  - 'ret void' instruction
2295   // ReturnInst(    null)          - 'ret void' instruction
2296   // ReturnInst(Value* X)          - 'ret X'    instruction
2297   // ReturnInst(    null, Inst *I) - 'ret void' instruction, insert before I
2298   // ReturnInst(Value* X, Inst *I) - 'ret X'    instruction, insert before I
2299   // ReturnInst(    null, BB *B)   - 'ret void' instruction, insert @ end of B
2300   // ReturnInst(Value* X, BB *B)   - 'ret X'    instruction, insert @ end of B
2301   //
2302   // NOTE: If the Value* passed is of type void then the constructor behaves as
2303   // if it was passed NULL.
2304   explicit ReturnInst(LLVMContext &C, Value *retVal = 0,
2305                       Instruction *InsertBefore = 0);
2306   ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2307   explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2308 protected:
2309   virtual ReturnInst *clone_impl() const;
2310 public:
2311   static ReturnInst* Create(LLVMContext &C, Value *retVal = 0,
2312                             Instruction *InsertBefore = 0) {
2313     return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2314   }
2315   static ReturnInst* Create(LLVMContext &C, Value *retVal,
2316                             BasicBlock *InsertAtEnd) {
2317     return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2318   }
2319   static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2320     return new(0) ReturnInst(C, InsertAtEnd);
2321   }
2322   virtual ~ReturnInst();
2323
2324   /// Provide fast operand accessors
2325   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2326
2327   /// Convenience accessor. Returns null if there is no return value.
2328   Value *getReturnValue() const {
2329     return getNumOperands() != 0 ? getOperand(0) : 0;
2330   }
2331
2332   unsigned getNumSuccessors() const { return 0; }
2333
2334   // Methods for support type inquiry through isa, cast, and dyn_cast:
2335   static inline bool classof(const ReturnInst *) { return true; }
2336   static inline bool classof(const Instruction *I) {
2337     return (I->getOpcode() == Instruction::Ret);
2338   }
2339   static inline bool classof(const Value *V) {
2340     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2341   }
2342  private:
2343   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2344   virtual unsigned getNumSuccessorsV() const;
2345   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2346 };
2347
2348 template <>
2349 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2350 };
2351
2352 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2353
2354 //===----------------------------------------------------------------------===//
2355 //                               BranchInst Class
2356 //===----------------------------------------------------------------------===//
2357
2358 //===---------------------------------------------------------------------------
2359 /// BranchInst - Conditional or Unconditional Branch instruction.
2360 ///
2361 class BranchInst : public TerminatorInst {
2362   /// Ops list - Branches are strange.  The operands are ordered:
2363   ///  [Cond, FalseDest,] TrueDest.  This makes some accessors faster because
2364   /// they don't have to check for cond/uncond branchness. These are mostly
2365   /// accessed relative from op_end().
2366   BranchInst(const BranchInst &BI);
2367   void AssertOK();
2368   // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2369   // BranchInst(BB *B)                           - 'br B'
2370   // BranchInst(BB* T, BB *F, Value *C)          - 'br C, T, F'
2371   // BranchInst(BB* B, Inst *I)                  - 'br B'        insert before I
2372   // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2373   // BranchInst(BB* B, BB *I)                    - 'br B'        insert at end
2374   // BranchInst(BB* T, BB *F, Value *C, BB *I)   - 'br C, T, F', insert at end
2375   explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2376   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2377              Instruction *InsertBefore = 0);
2378   BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2379   BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2380              BasicBlock *InsertAtEnd);
2381 protected:
2382   virtual BranchInst *clone_impl() const;
2383 public:
2384   static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2385     return new(1) BranchInst(IfTrue, InsertBefore);
2386   }
2387   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2388                             Value *Cond, Instruction *InsertBefore = 0) {
2389     return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2390   }
2391   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2392     return new(1) BranchInst(IfTrue, InsertAtEnd);
2393   }
2394   static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2395                             Value *Cond, BasicBlock *InsertAtEnd) {
2396     return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2397   }
2398
2399   /// Transparently provide more efficient getOperand methods.
2400   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2401
2402   bool isUnconditional() const { return getNumOperands() == 1; }
2403   bool isConditional()   const { return getNumOperands() == 3; }
2404
2405   Value *getCondition() const {
2406     assert(isConditional() && "Cannot get condition of an uncond branch!");
2407     return Op<-3>();
2408   }
2409
2410   void setCondition(Value *V) {
2411     assert(isConditional() && "Cannot set condition of unconditional branch!");
2412     Op<-3>() = V;
2413   }
2414
2415   unsigned getNumSuccessors() const { return 1+isConditional(); }
2416
2417   BasicBlock *getSuccessor(unsigned i) const {
2418     assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2419     return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2420   }
2421
2422   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2423     assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2424     *(&Op<-1>() - idx) = (Value*)NewSucc;
2425   }
2426
2427   /// \brief Swap the successors of this branch instruction.
2428   ///
2429   /// Swaps the successors of the branch instruction. This also swaps any
2430   /// branch weight metadata associated with the instruction so that it
2431   /// continues to map correctly to each operand.
2432   void swapSuccessors();
2433
2434   // Methods for support type inquiry through isa, cast, and dyn_cast:
2435   static inline bool classof(const BranchInst *) { return true; }
2436   static inline bool classof(const Instruction *I) {
2437     return (I->getOpcode() == Instruction::Br);
2438   }
2439   static inline bool classof(const Value *V) {
2440     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2441   }
2442 private:
2443   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2444   virtual unsigned getNumSuccessorsV() const;
2445   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2446 };
2447
2448 template <>
2449 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2450 };
2451
2452 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2453
2454 //===----------------------------------------------------------------------===//
2455 //                               SwitchInst Class
2456 //===----------------------------------------------------------------------===//
2457
2458 //===---------------------------------------------------------------------------
2459 /// SwitchInst - Multiway switch
2460 ///
2461 class SwitchInst : public TerminatorInst {
2462   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2463   unsigned ReservedSpace;
2464   // Operands format:
2465   // Operand[0]    = Value to switch on
2466   // Operand[1]    = Default basic block destination
2467   // Operand[2n  ] = Value to match
2468   // Operand[2n+1] = BasicBlock to go to on match
2469   
2470   // Store case values separately from operands list. We needn't User-Use
2471   // concept here, since it is just a case value, it will always constant,
2472   // and case value couldn't reused with another instructions/values.
2473   // Additionally:
2474   // It allows us to use custom type for case values that is not inherited
2475   // from Value. Since case value is a complex type that implements
2476   // the subset of integers, we needn't extract sub-constants within
2477   // slow getAggregateElement method.
2478   // For case values we will use std::list to by two reasons:
2479   // 1. It allows to add/remove cases without whole collection reallocation.
2480   // 2. In most of cases we needn't random access.
2481   // Currently case values are also stored in Operands List, but it will moved
2482   // out in future commits.
2483   typedef std::list<IntegersSubset> Subsets;
2484   typedef Subsets::iterator SubsetsIt;
2485   typedef Subsets::const_iterator SubsetsConstIt;
2486   
2487   Subsets TheSubsets;
2488   
2489   SwitchInst(const SwitchInst &SI);
2490   void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2491   void growOperands();
2492   // allocate space for exactly zero operands
2493   void *operator new(size_t s) {
2494     return User::operator new(s, 0);
2495   }
2496   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2497   /// switch on and a default destination.  The number of additional cases can
2498   /// be specified here to make memory allocation more efficient.  This
2499   /// constructor can also autoinsert before another instruction.
2500   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2501              Instruction *InsertBefore);
2502
2503   /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2504   /// switch on and a default destination.  The number of additional cases can
2505   /// be specified here to make memory allocation more efficient.  This
2506   /// constructor also autoinserts at the end of the specified BasicBlock.
2507   SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2508              BasicBlock *InsertAtEnd);
2509 protected:
2510   virtual SwitchInst *clone_impl() const;
2511 public:
2512   
2513   // FIXME: Currently there are a lot of unclean template parameters,
2514   // we need to make refactoring in future.
2515   // All these parameters are used to implement both iterator and const_iterator
2516   // without code duplication.
2517   // SwitchInstTy may be "const SwitchInst" or "SwitchInst"
2518   // ConstantIntTy may be "const ConstantInt" or "ConstantInt"
2519   // SubsetsItTy may be SubsetsConstIt or SubsetsIt
2520   // BasicBlockTy may be "const BasicBlock" or "BasicBlock"
2521   template <class SwitchInstTy, class ConstantIntTy,
2522             class SubsetsItTy, class BasicBlockTy> 
2523     class CaseIteratorT;
2524
2525   typedef CaseIteratorT<const SwitchInst, const ConstantInt,
2526                         SubsetsConstIt, const BasicBlock> ConstCaseIt;
2527   class CaseIt;
2528   
2529   // -2
2530   static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
2531   
2532   static SwitchInst *Create(Value *Value, BasicBlock *Default,
2533                             unsigned NumCases, Instruction *InsertBefore = 0) {
2534     return new SwitchInst(Value, Default, NumCases, InsertBefore);
2535   }
2536   static SwitchInst *Create(Value *Value, BasicBlock *Default,
2537                             unsigned NumCases, BasicBlock *InsertAtEnd) {
2538     return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2539   }
2540   
2541   ~SwitchInst();
2542
2543   /// Provide fast operand accessors
2544   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2545
2546   // Accessor Methods for Switch stmt
2547   Value *getCondition() const { return getOperand(0); }
2548   void setCondition(Value *V) { setOperand(0, V); }
2549
2550   BasicBlock *getDefaultDest() const {
2551     return cast<BasicBlock>(getOperand(1));
2552   }
2553
2554   void setDefaultDest(BasicBlock *DefaultCase) {
2555     setOperand(1, reinterpret_cast<Value*>(DefaultCase));
2556   }
2557
2558   /// getNumCases - return the number of 'cases' in this switch instruction,
2559   /// except the default case
2560   unsigned getNumCases() const {
2561     return getNumOperands()/2 - 1;
2562   }
2563
2564   /// Returns a read/write iterator that points to the first
2565   /// case in SwitchInst.
2566   CaseIt case_begin() {
2567     return CaseIt(this, 0, TheSubsets.begin());
2568   }
2569   /// Returns a read-only iterator that points to the first
2570   /// case in the SwitchInst.
2571   ConstCaseIt case_begin() const {
2572     return ConstCaseIt(this, 0, TheSubsets.begin());
2573   }
2574   
2575   /// Returns a read/write iterator that points one past the last
2576   /// in the SwitchInst.
2577   CaseIt case_end() {
2578     return CaseIt(this, getNumCases(), TheSubsets.end());
2579   }
2580   /// Returns a read-only iterator that points one past the last
2581   /// in the SwitchInst.
2582   ConstCaseIt case_end() const {
2583     return ConstCaseIt(this, getNumCases(), TheSubsets.end());
2584   }
2585   /// Returns an iterator that points to the default case.
2586   /// Note: this iterator allows to resolve successor only. Attempt
2587   /// to resolve case value causes an assertion.
2588   /// Also note, that increment and decrement also causes an assertion and
2589   /// makes iterator invalid. 
2590   CaseIt case_default() {
2591     return CaseIt(this, DefaultPseudoIndex, TheSubsets.end());
2592   }
2593   ConstCaseIt case_default() const {
2594     return ConstCaseIt(this, DefaultPseudoIndex, TheSubsets.end());
2595   }
2596   
2597   /// findCaseValue - Search all of the case values for the specified constant.
2598   /// If it is explicitly handled, return the case iterator of it, otherwise
2599   /// return default case iterator to indicate
2600   /// that it is handled by the default handler.
2601   CaseIt findCaseValue(const ConstantInt *C) {
2602     for (CaseIt 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   ConstCaseIt findCaseValue(const ConstantInt *C) const {
2608     for (ConstCaseIt i = case_begin(), e = case_end(); i != e; ++i)
2609       if (i.getCaseValueEx().isSatisfies(IntItem::fromConstantInt(C)))
2610         return i;
2611     return case_default();
2612   }    
2613   
2614   /// findCaseDest - Finds the unique case value for a given successor. Returns
2615   /// null if the successor is not found, not unique, or is the default case.
2616   ConstantInt *findCaseDest(BasicBlock *BB) {
2617     if (BB == getDefaultDest()) return NULL;
2618
2619     ConstantInt *CI = NULL;
2620     for (CaseIt i = case_begin(), e = case_end(); i != e; ++i) {
2621       if (i.getCaseSuccessor() == BB) {
2622         if (CI) return NULL;   // Multiple cases lead to BB.
2623         else CI = i.getCaseValue();
2624       }
2625     }
2626     return CI;
2627   }
2628
2629   /// addCase - Add an entry to the switch instruction...
2630   /// @deprecated
2631   /// Note:
2632   /// This action invalidates case_end(). Old case_end() iterator will
2633   /// point to the added case.
2634   void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2635   
2636   /// addCase - Add an entry to the switch instruction.
2637   /// Note:
2638   /// This action invalidates case_end(). Old case_end() iterator will
2639   /// point to the added case.
2640   void addCase(IntegersSubset& OnVal, BasicBlock *Dest);
2641
2642   /// removeCase - This method removes the specified case and its successor
2643   /// from the switch instruction. Note that this operation may reorder the
2644   /// remaining cases at index idx and above.
2645   /// Note:
2646   /// This action invalidates iterators for all cases following the one removed,
2647   /// including the case_end() iterator.
2648   void removeCase(CaseIt& i);
2649
2650   unsigned getNumSuccessors() const { return getNumOperands()/2; }
2651   BasicBlock *getSuccessor(unsigned idx) const {
2652     assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2653     return cast<BasicBlock>(getOperand(idx*2+1));
2654   }
2655   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2656     assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2657     setOperand(idx*2+1, (Value*)NewSucc);
2658   }
2659   
2660   uint16_t hash() const {
2661     uint32_t NumberOfCases = (uint32_t)getNumCases();
2662     uint16_t Hash = (0xFFFF & NumberOfCases) ^ (NumberOfCases >> 16);
2663     for (ConstCaseIt i = case_begin(), e = case_end();
2664          i != e; ++i) {
2665       uint32_t NumItems = (uint32_t)i.getCaseValueEx().getNumItems(); 
2666       Hash = (Hash << 1) ^ (0xFFFF & NumItems) ^ (NumItems >> 16);
2667     }
2668     return Hash;
2669   }  
2670   
2671   // Case iterators definition.
2672
2673   template <class SwitchInstTy, class ConstantIntTy,
2674             class SubsetsItTy, class BasicBlockTy> 
2675   class CaseIteratorT {
2676   protected:
2677     
2678     SwitchInstTy *SI;
2679     unsigned long Index;
2680     SubsetsItTy SubsetIt;
2681     
2682     /// Initializes case iterator for given SwitchInst and for given
2683     /// case number.    
2684     friend class SwitchInst;
2685     CaseIteratorT(SwitchInstTy *SI, unsigned SuccessorIndex,
2686                   SubsetsItTy CaseValueIt) {
2687       this->SI = SI;
2688       Index = SuccessorIndex;
2689       this->SubsetIt = CaseValueIt;
2690     }
2691     
2692   public:
2693     typedef typename SubsetsItTy::reference IntegersSubsetRef;
2694     typedef CaseIteratorT<SwitchInstTy, ConstantIntTy,
2695                           SubsetsItTy, BasicBlockTy> Self;
2696     
2697     CaseIteratorT(SwitchInstTy *SI, unsigned CaseNum) {
2698           this->SI = SI;
2699           Index = CaseNum;
2700           SubsetIt = SI->TheSubsets.begin();
2701           std::advance(SubsetIt, CaseNum);
2702         }
2703         
2704     
2705     /// Initializes case iterator for given SwitchInst and for given
2706     /// TerminatorInst's successor index.
2707     static Self fromSuccessorIndex(SwitchInstTy *SI, unsigned SuccessorIndex) {
2708       assert(SuccessorIndex < SI->getNumSuccessors() &&
2709              "Successor index # out of range!");    
2710       return SuccessorIndex != 0 ? 
2711              Self(SI, SuccessorIndex - 1) :
2712              Self(SI, DefaultPseudoIndex);       
2713     }
2714     
2715     /// Resolves case value for current case.
2716     /// @deprecated
2717     ConstantIntTy *getCaseValue() {
2718       assert(Index < SI->getNumCases() && "Index out the number of cases.");
2719       IntegersSubsetRef CaseRanges = *SubsetIt;
2720       
2721       // FIXME: Currently we work with ConstantInt based cases.
2722       // So return CaseValue as ConstantInt.
2723       return CaseRanges.getSingleNumber(0).toConstantInt();
2724     }
2725
2726     /// Resolves case value for current case.
2727     IntegersSubsetRef getCaseValueEx() {
2728       assert(Index < SI->getNumCases() && "Index out the number of cases.");
2729       return *SubsetIt;
2730     }
2731     
2732     /// Resolves successor for current case.
2733     BasicBlockTy *getCaseSuccessor() {
2734       assert((Index < SI->getNumCases() ||
2735               Index == DefaultPseudoIndex) &&
2736              "Index out the number of cases.");
2737       return SI->getSuccessor(getSuccessorIndex());      
2738     }
2739     
2740     /// Returns number of current case.
2741     unsigned getCaseIndex() const { return Index; }
2742     
2743     /// Returns TerminatorInst's successor index for current case successor.
2744     unsigned getSuccessorIndex() const {
2745       assert((Index == DefaultPseudoIndex || Index < SI->getNumCases()) &&
2746              "Index out the number of cases.");
2747       return Index != DefaultPseudoIndex ? Index + 1 : 0;
2748     }
2749     
2750     Self operator++() {
2751       // Check index correctness after increment.
2752       // Note: Index == getNumCases() means end().
2753       assert(Index+1 <= SI->getNumCases() && "Index out the number of cases.");
2754       ++Index;
2755       if (Index == 0)
2756         SubsetIt = SI->TheSubsets.begin();
2757       else
2758         ++SubsetIt;
2759       return *this;
2760     }
2761     Self operator++(int) {
2762       Self tmp = *this;
2763       ++(*this);
2764       return tmp;
2765     }
2766     Self operator--() { 
2767       // Check index correctness after decrement.
2768       // Note: Index == getNumCases() means end().
2769       // Also allow "-1" iterator here. That will became valid after ++.
2770       unsigned NumCases = SI->getNumCases();
2771       assert((Index == 0 || Index-1 <= NumCases) &&
2772              "Index out the number of cases.");
2773       --Index;
2774       if (Index == NumCases) {
2775         SubsetIt = SI->TheSubsets.end();
2776         return *this;
2777       }
2778         
2779       if (Index != -1UL)
2780         --SubsetIt;
2781       
2782       return *this;
2783     }
2784     Self operator--(int) {
2785       Self tmp = *this;
2786       --(*this);
2787       return tmp;
2788     }
2789     bool operator==(const Self& RHS) const {
2790       assert(RHS.SI == SI && "Incompatible operators.");
2791       return RHS.Index == Index;
2792     }
2793     bool operator!=(const Self& RHS) const {
2794       assert(RHS.SI == SI && "Incompatible operators.");
2795       return RHS.Index != Index;
2796     }
2797   };
2798
2799   class CaseIt : public CaseIteratorT<SwitchInst, ConstantInt,
2800                                       SubsetsIt, BasicBlock> {
2801     typedef CaseIteratorT<SwitchInst, ConstantInt, SubsetsIt, BasicBlock>
2802       ParentTy;
2803     
2804   protected:
2805     friend class SwitchInst;
2806     CaseIt(SwitchInst *SI, unsigned CaseNum, SubsetsIt SubsetIt) :
2807       ParentTy(SI, CaseNum, SubsetIt) {}
2808     
2809     void updateCaseValueOperand(IntegersSubset& V) {
2810       SI->setOperand(2 + Index*2, reinterpret_cast<Value*>((Constant*)V));      
2811     }
2812   
2813   public:
2814
2815     CaseIt(SwitchInst *SI, unsigned CaseNum) : ParentTy(SI, CaseNum) {}    
2816     
2817     CaseIt(const ParentTy& Src) : ParentTy(Src) {}
2818
2819     /// Sets the new value for current case.    
2820     /// @deprecated.
2821     void setValue(ConstantInt *V) {
2822       assert(Index < SI->getNumCases() && "Index out the number of cases.");
2823       IntegersSubsetToBB Mapping;
2824       // FIXME: Currently we work with ConstantInt based cases.
2825       // So inititalize IntItem container directly from ConstantInt.
2826       Mapping.add(IntItem::fromConstantInt(V));
2827       *SubsetIt = Mapping.getCase();
2828       updateCaseValueOperand(*SubsetIt);
2829     }
2830     
2831     /// Sets the new value for current case.
2832     void setValueEx(IntegersSubset& V) {
2833       assert(Index < SI->getNumCases() && "Index out the number of cases.");
2834       *SubsetIt = V;
2835       updateCaseValueOperand(*SubsetIt);   
2836     }
2837     
2838     /// Sets the new successor for current case.
2839     void setSuccessor(BasicBlock *S) {
2840       SI->setSuccessor(getSuccessorIndex(), S);      
2841     }
2842   };
2843
2844   // Methods for support type inquiry through isa, cast, and dyn_cast:
2845
2846   static inline bool classof(const SwitchInst *) { return true; }
2847   static inline bool classof(const Instruction *I) {
2848     return I->getOpcode() == Instruction::Switch;
2849   }
2850   static inline bool classof(const Value *V) {
2851     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2852   }
2853 private:
2854   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2855   virtual unsigned getNumSuccessorsV() const;
2856   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2857 };
2858
2859 template <>
2860 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2861 };
2862
2863 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2864
2865
2866 //===----------------------------------------------------------------------===//
2867 //                             IndirectBrInst Class
2868 //===----------------------------------------------------------------------===//
2869
2870 //===---------------------------------------------------------------------------
2871 /// IndirectBrInst - Indirect Branch Instruction.
2872 ///
2873 class IndirectBrInst : public TerminatorInst {
2874   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2875   unsigned ReservedSpace;
2876   // Operand[0]    = Value to switch on
2877   // Operand[1]    = Default basic block destination
2878   // Operand[2n  ] = Value to match
2879   // Operand[2n+1] = BasicBlock to go to on match
2880   IndirectBrInst(const IndirectBrInst &IBI);
2881   void init(Value *Address, unsigned NumDests);
2882   void growOperands();
2883   // allocate space for exactly zero operands
2884   void *operator new(size_t s) {
2885     return User::operator new(s, 0);
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 can also
2890   /// autoinsert before another instruction.
2891   IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
2892
2893   /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2894   /// Address to jump to.  The number of expected destinations can be specified
2895   /// here to make memory allocation more efficient.  This constructor also
2896   /// autoinserts at the end of the specified BasicBlock.
2897   IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
2898 protected:
2899   virtual IndirectBrInst *clone_impl() const;
2900 public:
2901   static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2902                                 Instruction *InsertBefore = 0) {
2903     return new IndirectBrInst(Address, NumDests, InsertBefore);
2904   }
2905   static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2906                                 BasicBlock *InsertAtEnd) {
2907     return new IndirectBrInst(Address, NumDests, InsertAtEnd);
2908   }
2909   ~IndirectBrInst();
2910
2911   /// Provide fast operand accessors.
2912   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2913
2914   // Accessor Methods for IndirectBrInst instruction.
2915   Value *getAddress() { return getOperand(0); }
2916   const Value *getAddress() const { return getOperand(0); }
2917   void setAddress(Value *V) { setOperand(0, V); }
2918
2919
2920   /// getNumDestinations - return the number of possible destinations in this
2921   /// indirectbr instruction.
2922   unsigned getNumDestinations() const { return getNumOperands()-1; }
2923
2924   /// getDestination - Return the specified destination.
2925   BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
2926   const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
2927
2928   /// addDestination - Add a destination.
2929   ///
2930   void addDestination(BasicBlock *Dest);
2931
2932   /// removeDestination - This method removes the specified successor from the
2933   /// indirectbr instruction.
2934   void removeDestination(unsigned i);
2935
2936   unsigned getNumSuccessors() const { return getNumOperands()-1; }
2937   BasicBlock *getSuccessor(unsigned i) const {
2938     return cast<BasicBlock>(getOperand(i+1));
2939   }
2940   void setSuccessor(unsigned i, BasicBlock *NewSucc) {
2941     setOperand(i+1, (Value*)NewSucc);
2942   }
2943
2944   // Methods for support type inquiry through isa, cast, and dyn_cast:
2945   static inline bool classof(const IndirectBrInst *) { return true; }
2946   static inline bool classof(const Instruction *I) {
2947     return I->getOpcode() == Instruction::IndirectBr;
2948   }
2949   static inline bool classof(const Value *V) {
2950     return isa<Instruction>(V) && classof(cast<Instruction>(V));
2951   }
2952 private:
2953   virtual BasicBlock *getSuccessorV(unsigned idx) const;
2954   virtual unsigned getNumSuccessorsV() const;
2955   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2956 };
2957
2958 template <>
2959 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
2960 };
2961
2962 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
2963
2964
2965 //===----------------------------------------------------------------------===//
2966 //                               InvokeInst Class
2967 //===----------------------------------------------------------------------===//
2968
2969 /// InvokeInst - Invoke instruction.  The SubclassData field is used to hold the
2970 /// calling convention of the call.
2971 ///
2972 class InvokeInst : public TerminatorInst {
2973   AttrListPtr AttributeList;
2974   InvokeInst(const InvokeInst &BI);
2975   void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2976             ArrayRef<Value *> Args, const Twine &NameStr);
2977
2978   /// Construct an InvokeInst given a range of arguments.
2979   ///
2980   /// @brief Construct an InvokeInst from a range of arguments
2981   inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2982                     ArrayRef<Value *> Args, unsigned Values,
2983                     const Twine &NameStr, Instruction *InsertBefore);
2984
2985   /// Construct an InvokeInst given a range of arguments.
2986   ///
2987   /// @brief Construct an InvokeInst from a range of arguments
2988   inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2989                     ArrayRef<Value *> Args, unsigned Values,
2990                     const Twine &NameStr, BasicBlock *InsertAtEnd);
2991 protected:
2992   virtual InvokeInst *clone_impl() const;
2993 public:
2994   static InvokeInst *Create(Value *Func,
2995                             BasicBlock *IfNormal, BasicBlock *IfException,
2996                             ArrayRef<Value *> Args, const Twine &NameStr = "",
2997                             Instruction *InsertBefore = 0) {
2998     unsigned Values = unsigned(Args.size()) + 3;
2999     return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3000                                   Values, NameStr, InsertBefore);
3001   }
3002   static InvokeInst *Create(Value *Func,
3003                             BasicBlock *IfNormal, BasicBlock *IfException,
3004                             ArrayRef<Value *> Args, const Twine &NameStr,
3005                             BasicBlock *InsertAtEnd) {
3006     unsigned Values = unsigned(Args.size()) + 3;
3007     return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3008                                   Values, NameStr, InsertAtEnd);
3009   }
3010
3011   /// Provide fast operand accessors
3012   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3013
3014   /// getNumArgOperands - Return the number of invoke arguments.
3015   ///
3016   unsigned getNumArgOperands() const { return getNumOperands() - 3; }
3017
3018   /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
3019   ///
3020   Value *getArgOperand(unsigned i) const { return getOperand(i); }
3021   void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
3022
3023   /// getCallingConv/setCallingConv - Get or set the calling convention of this
3024   /// function call.
3025   CallingConv::ID getCallingConv() const {
3026     return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
3027   }
3028   void setCallingConv(CallingConv::ID CC) {
3029     setInstructionSubclassData(static_cast<unsigned>(CC));
3030   }
3031
3032   /// getAttributes - Return the parameter attributes for this invoke.
3033   ///
3034   const AttrListPtr &getAttributes() const { return AttributeList; }
3035
3036   /// setAttributes - Set the parameter attributes for this invoke.
3037   ///
3038   void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
3039
3040   /// addAttribute - adds the attribute to the list of attributes.
3041   void addAttribute(unsigned i, Attributes attr);
3042
3043   /// removeAttribute - removes the attribute from the list of attributes.
3044   void removeAttribute(unsigned i, Attributes attr);
3045
3046   /// @brief Determine whether this call has the NoAlias attribute.
3047   bool fnHasNoAliasAttr() const;
3048   bool fnHasNoInlineAttr() const;
3049   bool fnHasNoReturnAttr() const;
3050   bool fnHasNoUnwindAttr() const;
3051   bool fnHasReadNoneAttr() const;
3052   bool fnHasReadOnlyAttr() const;
3053   bool fnHasReturnsTwiceAttr() const;
3054
3055   /// @brief Determine whether the call or the callee has the given attributes.
3056   bool paramHasSExtAttr(unsigned i) const;
3057   bool paramHasZExtAttr(unsigned i) const;
3058   bool paramHasInRegAttr(unsigned i) const;
3059   bool paramHasStructRetAttr(unsigned i) const;
3060   bool paramHasNestAttr(unsigned i) const;
3061   bool paramHasByValAttr(unsigned i) const;
3062   bool paramHasNoAliasAttr(unsigned i) const;
3063   bool paramHasNoCaptureAttr(unsigned i) const;
3064
3065   /// @brief Extract the alignment for a call or parameter (0=unknown).
3066   unsigned getParamAlignment(unsigned i) const {
3067     return AttributeList.getParamAlignment(i);
3068   }
3069
3070   /// @brief Return true if the call should not be inlined.
3071   bool isNoInline() const { return fnHasNoInlineAttr(); }
3072   void setIsNoInline(bool Value = true) {
3073     if (Value) addAttribute(~0, Attribute::NoInline);
3074     else removeAttribute(~0, Attribute::NoInline);
3075   }
3076
3077   /// @brief Determine if the call does not access memory.
3078   bool doesNotAccessMemory() const {
3079     return fnHasReadNoneAttr();
3080   }
3081   void setDoesNotAccessMemory(bool NotAccessMemory = true) {
3082     if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
3083     else removeAttribute(~0, Attribute::ReadNone);
3084   }
3085
3086   /// @brief Determine if the call does not access or only reads memory.
3087   bool onlyReadsMemory() const {
3088     return doesNotAccessMemory() || fnHasReadOnlyAttr();
3089   }
3090   void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
3091     if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
3092     else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
3093   }
3094
3095   /// @brief Determine if the call cannot return.
3096   bool doesNotReturn() const { return fnHasNoReturnAttr(); }
3097   void setDoesNotReturn(bool DoesNotReturn = true) {
3098     if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
3099     else removeAttribute(~0, Attribute::NoReturn);
3100   }
3101
3102   /// @brief Determine if the call cannot unwind.
3103   bool doesNotThrow() const { return fnHasNoUnwindAttr(); }
3104   void setDoesNotThrow(bool DoesNotThrow = true) {
3105     if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
3106     else removeAttribute(~0, Attribute::NoUnwind);
3107   }
3108
3109   /// @brief Determine if the call returns a structure through first
3110   /// pointer argument.
3111   bool hasStructRetAttr() const {
3112     // Be friendly and also check the callee.
3113     return paramHasStructRetAttr(1);
3114   }
3115
3116   /// @brief Determine if any call argument is an aggregate passed by value.
3117   bool hasByValArgument() const {
3118     for (unsigned I = 0, E = AttributeList.getNumAttrs(); I != E; ++I)
3119       if (AttributeList.getAttributesAtIndex(I).hasByValAttr())
3120         return true;
3121     return false;
3122   }
3123
3124   /// getCalledFunction - Return the function called, or null if this is an
3125   /// indirect function invocation.
3126   ///
3127   Function *getCalledFunction() const {
3128     return dyn_cast<Function>(Op<-3>());
3129   }
3130
3131   /// getCalledValue - Get a pointer to the function that is invoked by this
3132   /// instruction
3133   const Value *getCalledValue() const { return Op<-3>(); }
3134         Value *getCalledValue()       { return Op<-3>(); }
3135
3136   /// setCalledFunction - Set the function called.
3137   void setCalledFunction(Value* Fn) {
3138     Op<-3>() = Fn;
3139   }
3140
3141   // get*Dest - Return the destination basic blocks...
3142   BasicBlock *getNormalDest() const {
3143     return cast<BasicBlock>(Op<-2>());
3144   }
3145   BasicBlock *getUnwindDest() const {
3146     return cast<BasicBlock>(Op<-1>());
3147   }
3148   void setNormalDest(BasicBlock *B) {
3149     Op<-2>() = reinterpret_cast<Value*>(B);
3150   }
3151   void setUnwindDest(BasicBlock *B) {
3152     Op<-1>() = reinterpret_cast<Value*>(B);
3153   }
3154
3155   /// getLandingPadInst - Get the landingpad instruction from the landing pad
3156   /// block (the unwind destination).
3157   LandingPadInst *getLandingPadInst() const;
3158
3159   BasicBlock *getSuccessor(unsigned i) const {
3160     assert(i < 2 && "Successor # out of range for invoke!");
3161     return i == 0 ? getNormalDest() : getUnwindDest();
3162   }
3163
3164   void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3165     assert(idx < 2 && "Successor # out of range for invoke!");
3166     *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
3167   }
3168
3169   unsigned getNumSuccessors() const { return 2; }
3170
3171   // Methods for support type inquiry through isa, cast, and dyn_cast:
3172   static inline bool classof(const InvokeInst *) { return true; }
3173   static inline bool classof(const Instruction *I) {
3174     return (I->getOpcode() == Instruction::Invoke);
3175   }
3176   static inline bool classof(const Value *V) {
3177     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3178   }
3179
3180 private:
3181   virtual BasicBlock *getSuccessorV(unsigned idx) const;
3182   virtual unsigned getNumSuccessorsV() const;
3183   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3184
3185   // Shadow Instruction::setInstructionSubclassData with a private forwarding
3186   // method so that subclasses cannot accidentally use it.
3187   void setInstructionSubclassData(unsigned short D) {
3188     Instruction::setInstructionSubclassData(D);
3189   }
3190 };
3191
3192 template <>
3193 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
3194 };
3195
3196 InvokeInst::InvokeInst(Value *Func,
3197                        BasicBlock *IfNormal, BasicBlock *IfException,
3198                        ArrayRef<Value *> Args, unsigned Values,
3199                        const Twine &NameStr, Instruction *InsertBefore)
3200   : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3201                                       ->getElementType())->getReturnType(),
3202                    Instruction::Invoke,
3203                    OperandTraits<InvokeInst>::op_end(this) - Values,
3204                    Values, InsertBefore) {
3205   init(Func, IfNormal, IfException, Args, NameStr);
3206 }
3207 InvokeInst::InvokeInst(Value *Func,
3208                        BasicBlock *IfNormal, BasicBlock *IfException,
3209                        ArrayRef<Value *> Args, unsigned Values,
3210                        const Twine &NameStr, BasicBlock *InsertAtEnd)
3211   : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3212                                       ->getElementType())->getReturnType(),
3213                    Instruction::Invoke,
3214                    OperandTraits<InvokeInst>::op_end(this) - Values,
3215                    Values, InsertAtEnd) {
3216   init(Func, IfNormal, IfException, Args, NameStr);
3217 }
3218
3219 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
3220
3221 //===----------------------------------------------------------------------===//
3222 //                              ResumeInst Class
3223 //===----------------------------------------------------------------------===//
3224
3225 //===---------------------------------------------------------------------------
3226 /// ResumeInst - Resume the propagation of an exception.
3227 ///
3228 class ResumeInst : public TerminatorInst {
3229   ResumeInst(const ResumeInst &RI);
3230
3231   explicit ResumeInst(Value *Exn, Instruction *InsertBefore=0);
3232   ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
3233 protected:
3234   virtual ResumeInst *clone_impl() const;
3235 public:
3236   static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = 0) {
3237     return new(1) ResumeInst(Exn, InsertBefore);
3238   }
3239   static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
3240     return new(1) ResumeInst(Exn, InsertAtEnd);
3241   }
3242
3243   /// Provide fast operand accessors
3244   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3245
3246   /// Convenience accessor.
3247   Value *getValue() const { return Op<0>(); }
3248
3249   unsigned getNumSuccessors() const { return 0; }
3250
3251   // Methods for support type inquiry through isa, cast, and dyn_cast:
3252   static inline bool classof(const ResumeInst *) { return true; }
3253   static inline bool classof(const Instruction *I) {
3254     return I->getOpcode() == Instruction::Resume;
3255   }
3256   static inline bool classof(const Value *V) {
3257     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3258   }
3259 private:
3260   virtual BasicBlock *getSuccessorV(unsigned idx) const;
3261   virtual unsigned getNumSuccessorsV() const;
3262   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3263 };
3264
3265 template <>
3266 struct OperandTraits<ResumeInst> :
3267     public FixedNumOperandTraits<ResumeInst, 1> {
3268 };
3269
3270 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
3271
3272 //===----------------------------------------------------------------------===//
3273 //                           UnreachableInst Class
3274 //===----------------------------------------------------------------------===//
3275
3276 //===---------------------------------------------------------------------------
3277 /// UnreachableInst - This function has undefined behavior.  In particular, the
3278 /// presence of this instruction indicates some higher level knowledge that the
3279 /// end of the block cannot be reached.
3280 ///
3281 class UnreachableInst : public TerminatorInst {
3282   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
3283 protected:
3284   virtual UnreachableInst *clone_impl() const;
3285
3286 public:
3287   // allocate space for exactly zero operands
3288   void *operator new(size_t s) {
3289     return User::operator new(s, 0);
3290   }
3291   explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = 0);
3292   explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
3293
3294   unsigned getNumSuccessors() const { return 0; }
3295
3296   // Methods for support type inquiry through isa, cast, and dyn_cast:
3297   static inline bool classof(const UnreachableInst *) { return true; }
3298   static inline bool classof(const Instruction *I) {
3299     return I->getOpcode() == Instruction::Unreachable;
3300   }
3301   static inline bool classof(const Value *V) {
3302     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3303   }
3304 private:
3305   virtual BasicBlock *getSuccessorV(unsigned idx) const;
3306   virtual unsigned getNumSuccessorsV() const;
3307   virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3308 };
3309
3310 //===----------------------------------------------------------------------===//
3311 //                                 TruncInst Class
3312 //===----------------------------------------------------------------------===//
3313
3314 /// @brief This class represents a truncation of integer types.
3315 class TruncInst : public CastInst {
3316 protected:
3317   /// @brief Clone an identical TruncInst
3318   virtual TruncInst *clone_impl() const;
3319
3320 public:
3321   /// @brief Constructor with insert-before-instruction semantics
3322   TruncInst(
3323     Value *S,                     ///< The value to be truncated
3324     Type *Ty,               ///< The (smaller) type to truncate to
3325     const Twine &NameStr = "",    ///< A name for the new instruction
3326     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3327   );
3328
3329   /// @brief Constructor with insert-at-end-of-block semantics
3330   TruncInst(
3331     Value *S,                     ///< The value to be truncated
3332     Type *Ty,               ///< The (smaller) type to truncate to
3333     const Twine &NameStr,         ///< A name for the new instruction
3334     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3335   );
3336
3337   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3338   static inline bool classof(const TruncInst *) { return true; }
3339   static inline bool classof(const Instruction *I) {
3340     return I->getOpcode() == Trunc;
3341   }
3342   static inline bool classof(const Value *V) {
3343     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3344   }
3345 };
3346
3347 //===----------------------------------------------------------------------===//
3348 //                                 ZExtInst Class
3349 //===----------------------------------------------------------------------===//
3350
3351 /// @brief This class represents zero extension of integer types.
3352 class ZExtInst : public CastInst {
3353 protected:
3354   /// @brief Clone an identical ZExtInst
3355   virtual ZExtInst *clone_impl() const;
3356
3357 public:
3358   /// @brief Constructor with insert-before-instruction semantics
3359   ZExtInst(
3360     Value *S,                     ///< The value to be zero extended
3361     Type *Ty,               ///< The type to zero extend to
3362     const Twine &NameStr = "",    ///< A name for the new instruction
3363     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3364   );
3365
3366   /// @brief Constructor with insert-at-end semantics.
3367   ZExtInst(
3368     Value *S,                     ///< The value to be zero extended
3369     Type *Ty,               ///< The type to zero extend to
3370     const Twine &NameStr,         ///< A name for the new instruction
3371     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3372   );
3373
3374   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3375   static inline bool classof(const ZExtInst *) { return true; }
3376   static inline bool classof(const Instruction *I) {
3377     return I->getOpcode() == ZExt;
3378   }
3379   static inline bool classof(const Value *V) {
3380     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3381   }
3382 };
3383
3384 //===----------------------------------------------------------------------===//
3385 //                                 SExtInst Class
3386 //===----------------------------------------------------------------------===//
3387
3388 /// @brief This class represents a sign extension of integer types.
3389 class SExtInst : public CastInst {
3390 protected:
3391   /// @brief Clone an identical SExtInst
3392   virtual SExtInst *clone_impl() const;
3393
3394 public:
3395   /// @brief Constructor with insert-before-instruction semantics
3396   SExtInst(
3397     Value *S,                     ///< The value to be sign extended
3398     Type *Ty,               ///< The type to sign extend to
3399     const Twine &NameStr = "",    ///< A name for the new instruction
3400     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3401   );
3402
3403   /// @brief Constructor with insert-at-end-of-block semantics
3404   SExtInst(
3405     Value *S,                     ///< The value to be sign extended
3406     Type *Ty,               ///< The type to sign extend to
3407     const Twine &NameStr,         ///< A name for the new instruction
3408     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3409   );
3410
3411   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3412   static inline bool classof(const SExtInst *) { return true; }
3413   static inline bool classof(const Instruction *I) {
3414     return I->getOpcode() == SExt;
3415   }
3416   static inline bool classof(const Value *V) {
3417     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3418   }
3419 };
3420
3421 //===----------------------------------------------------------------------===//
3422 //                                 FPTruncInst Class
3423 //===----------------------------------------------------------------------===//
3424
3425 /// @brief This class represents a truncation of floating point types.
3426 class FPTruncInst : public CastInst {
3427 protected:
3428   /// @brief Clone an identical FPTruncInst
3429   virtual FPTruncInst *clone_impl() const;
3430
3431 public:
3432   /// @brief Constructor with insert-before-instruction semantics
3433   FPTruncInst(
3434     Value *S,                     ///< The value to be truncated
3435     Type *Ty,               ///< The type to truncate to
3436     const Twine &NameStr = "",    ///< A name for the new instruction
3437     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3438   );
3439
3440   /// @brief Constructor with insert-before-instruction semantics
3441   FPTruncInst(
3442     Value *S,                     ///< The value to be truncated
3443     Type *Ty,               ///< The type to truncate to
3444     const Twine &NameStr,         ///< A name for the new instruction
3445     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3446   );
3447
3448   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3449   static inline bool classof(const FPTruncInst *) { return true; }
3450   static inline bool classof(const Instruction *I) {
3451     return I->getOpcode() == FPTrunc;
3452   }
3453   static inline bool classof(const Value *V) {
3454     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3455   }
3456 };
3457
3458 //===----------------------------------------------------------------------===//
3459 //                                 FPExtInst Class
3460 //===----------------------------------------------------------------------===//
3461
3462 /// @brief This class represents an extension of floating point types.
3463 class FPExtInst : public CastInst {
3464 protected:
3465   /// @brief Clone an identical FPExtInst
3466   virtual FPExtInst *clone_impl() const;
3467
3468 public:
3469   /// @brief Constructor with insert-before-instruction semantics
3470   FPExtInst(
3471     Value *S,                     ///< The value to be extended
3472     Type *Ty,               ///< The type to extend to
3473     const Twine &NameStr = "",    ///< A name for the new instruction
3474     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3475   );
3476
3477   /// @brief Constructor with insert-at-end-of-block semantics
3478   FPExtInst(
3479     Value *S,                     ///< The value to be extended
3480     Type *Ty,               ///< The type to extend to
3481     const Twine &NameStr,         ///< A name for the new instruction
3482     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3483   );
3484
3485   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3486   static inline bool classof(const FPExtInst *) { return true; }
3487   static inline bool classof(const Instruction *I) {
3488     return I->getOpcode() == FPExt;
3489   }
3490   static inline bool classof(const Value *V) {
3491     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3492   }
3493 };
3494
3495 //===----------------------------------------------------------------------===//
3496 //                                 UIToFPInst Class
3497 //===----------------------------------------------------------------------===//
3498
3499 /// @brief This class represents a cast unsigned integer to floating point.
3500 class UIToFPInst : public CastInst {
3501 protected:
3502   /// @brief Clone an identical UIToFPInst
3503   virtual UIToFPInst *clone_impl() const;
3504
3505 public:
3506   /// @brief Constructor with insert-before-instruction semantics
3507   UIToFPInst(
3508     Value *S,                     ///< The value to be converted
3509     Type *Ty,               ///< The type to convert to
3510     const Twine &NameStr = "",    ///< A name for the new instruction
3511     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3512   );
3513
3514   /// @brief Constructor with insert-at-end-of-block semantics
3515   UIToFPInst(
3516     Value *S,                     ///< The value to be converted
3517     Type *Ty,               ///< The type to convert to
3518     const Twine &NameStr,         ///< A name for the new instruction
3519     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3520   );
3521
3522   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3523   static inline bool classof(const UIToFPInst *) { return true; }
3524   static inline bool classof(const Instruction *I) {
3525     return I->getOpcode() == UIToFP;
3526   }
3527   static inline bool classof(const Value *V) {
3528     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3529   }
3530 };
3531
3532 //===----------------------------------------------------------------------===//
3533 //                                 SIToFPInst Class
3534 //===----------------------------------------------------------------------===//
3535
3536 /// @brief This class represents a cast from signed integer to floating point.
3537 class SIToFPInst : public CastInst {
3538 protected:
3539   /// @brief Clone an identical SIToFPInst
3540   virtual SIToFPInst *clone_impl() const;
3541
3542 public:
3543   /// @brief Constructor with insert-before-instruction semantics
3544   SIToFPInst(
3545     Value *S,                     ///< The value to be converted
3546     Type *Ty,               ///< The type to convert to
3547     const Twine &NameStr = "",    ///< A name for the new instruction
3548     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3549   );
3550
3551   /// @brief Constructor with insert-at-end-of-block semantics
3552   SIToFPInst(
3553     Value *S,                     ///< The value to be converted
3554     Type *Ty,               ///< The type to convert to
3555     const Twine &NameStr,         ///< A name for the new instruction
3556     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3557   );
3558
3559   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3560   static inline bool classof(const SIToFPInst *) { return true; }
3561   static inline bool classof(const Instruction *I) {
3562     return I->getOpcode() == SIToFP;
3563   }
3564   static inline bool classof(const Value *V) {
3565     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3566   }
3567 };
3568
3569 //===----------------------------------------------------------------------===//
3570 //                                 FPToUIInst Class
3571 //===----------------------------------------------------------------------===//
3572
3573 /// @brief This class represents a cast from floating point to unsigned integer
3574 class FPToUIInst  : public CastInst {
3575 protected:
3576   /// @brief Clone an identical FPToUIInst
3577   virtual FPToUIInst *clone_impl() const;
3578
3579 public:
3580   /// @brief Constructor with insert-before-instruction semantics
3581   FPToUIInst(
3582     Value *S,                     ///< The value to be converted
3583     Type *Ty,               ///< The type to convert to
3584     const Twine &NameStr = "",    ///< A name for the new instruction
3585     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3586   );
3587
3588   /// @brief Constructor with insert-at-end-of-block semantics
3589   FPToUIInst(
3590     Value *S,                     ///< The value to be converted
3591     Type *Ty,               ///< The type to convert to
3592     const Twine &NameStr,         ///< A name for the new instruction
3593     BasicBlock *InsertAtEnd       ///< Where to insert the new instruction
3594   );
3595
3596   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3597   static inline bool classof(const FPToUIInst *) { return true; }
3598   static inline bool classof(const Instruction *I) {
3599     return I->getOpcode() == FPToUI;
3600   }
3601   static inline bool classof(const Value *V) {
3602     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3603   }
3604 };
3605
3606 //===----------------------------------------------------------------------===//
3607 //                                 FPToSIInst Class
3608 //===----------------------------------------------------------------------===//
3609
3610 /// @brief This class represents a cast from floating point to signed integer.
3611 class FPToSIInst  : public CastInst {
3612 protected:
3613   /// @brief Clone an identical FPToSIInst
3614   virtual FPToSIInst *clone_impl() const;
3615
3616 public:
3617   /// @brief Constructor with insert-before-instruction semantics
3618   FPToSIInst(
3619     Value *S,                     ///< The value to be converted
3620     Type *Ty,               ///< The type to convert to
3621     const Twine &NameStr = "",    ///< A name for the new instruction
3622     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3623   );
3624
3625   /// @brief Constructor with insert-at-end-of-block semantics
3626   FPToSIInst(
3627     Value *S,                     ///< The value to be converted
3628     Type *Ty,               ///< The type to convert to
3629     const Twine &NameStr,         ///< A name for the new instruction
3630     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3631   );
3632
3633   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3634   static inline bool classof(const FPToSIInst *) { return true; }
3635   static inline bool classof(const Instruction *I) {
3636     return I->getOpcode() == FPToSI;
3637   }
3638   static inline bool classof(const Value *V) {
3639     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3640   }
3641 };
3642
3643 //===----------------------------------------------------------------------===//
3644 //                                 IntToPtrInst Class
3645 //===----------------------------------------------------------------------===//
3646
3647 /// @brief This class represents a cast from an integer to a pointer.
3648 class IntToPtrInst : public CastInst {
3649 public:
3650   /// @brief Constructor with insert-before-instruction semantics
3651   IntToPtrInst(
3652     Value *S,                     ///< The value to be converted
3653     Type *Ty,               ///< The type to convert to
3654     const Twine &NameStr = "",    ///< A name for the new instruction
3655     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3656   );
3657
3658   /// @brief Constructor with insert-at-end-of-block semantics
3659   IntToPtrInst(
3660     Value *S,                     ///< The value to be converted
3661     Type *Ty,               ///< The type to convert to
3662     const Twine &NameStr,         ///< A name for the new instruction
3663     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3664   );
3665
3666   /// @brief Clone an identical IntToPtrInst
3667   virtual IntToPtrInst *clone_impl() const;
3668
3669   // Methods for support type inquiry through isa, cast, and dyn_cast:
3670   static inline bool classof(const IntToPtrInst *) { return true; }
3671   static inline bool classof(const Instruction *I) {
3672     return I->getOpcode() == IntToPtr;
3673   }
3674   static inline bool classof(const Value *V) {
3675     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3676   }
3677 };
3678
3679 //===----------------------------------------------------------------------===//
3680 //                                 PtrToIntInst Class
3681 //===----------------------------------------------------------------------===//
3682
3683 /// @brief This class represents a cast from a pointer to an integer
3684 class PtrToIntInst : public CastInst {
3685 protected:
3686   /// @brief Clone an identical PtrToIntInst
3687   virtual PtrToIntInst *clone_impl() const;
3688
3689 public:
3690   /// @brief Constructor with insert-before-instruction semantics
3691   PtrToIntInst(
3692     Value *S,                     ///< The value to be converted
3693     Type *Ty,               ///< The type to convert to
3694     const Twine &NameStr = "",    ///< A name for the new instruction
3695     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3696   );
3697
3698   /// @brief Constructor with insert-at-end-of-block semantics
3699   PtrToIntInst(
3700     Value *S,                     ///< The value to be converted
3701     Type *Ty,               ///< The type to convert to
3702     const Twine &NameStr,         ///< A name for the new instruction
3703     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3704   );
3705
3706   // Methods for support type inquiry through isa, cast, and dyn_cast:
3707   static inline bool classof(const PtrToIntInst *) { return true; }
3708   static inline bool classof(const Instruction *I) {
3709     return I->getOpcode() == PtrToInt;
3710   }
3711   static inline bool classof(const Value *V) {
3712     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3713   }
3714 };
3715
3716 //===----------------------------------------------------------------------===//
3717 //                             BitCastInst Class
3718 //===----------------------------------------------------------------------===//
3719
3720 /// @brief This class represents a no-op cast from one type to another.
3721 class BitCastInst : public CastInst {
3722 protected:
3723   /// @brief Clone an identical BitCastInst
3724   virtual BitCastInst *clone_impl() const;
3725
3726 public:
3727   /// @brief Constructor with insert-before-instruction semantics
3728   BitCastInst(
3729     Value *S,                     ///< The value to be casted
3730     Type *Ty,               ///< The type to casted to
3731     const Twine &NameStr = "",    ///< A name for the new instruction
3732     Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3733   );
3734
3735   /// @brief Constructor with insert-at-end-of-block semantics
3736   BitCastInst(
3737     Value *S,                     ///< The value to be casted
3738     Type *Ty,               ///< The type to casted to
3739     const Twine &NameStr,         ///< A name for the new instruction
3740     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
3741   );
3742
3743   // Methods for support type inquiry through isa, cast, and dyn_cast:
3744   static inline bool classof(const BitCastInst *) { return true; }
3745   static inline bool classof(const Instruction *I) {
3746     return I->getOpcode() == BitCast;
3747   }
3748   static inline bool classof(const Value *V) {
3749     return isa<Instruction>(V) && classof(cast<Instruction>(V));
3750   }
3751 };
3752
3753 } // End llvm namespace
3754
3755 #endif