1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_INSTRUCTIONS_H
17 #define LLVM_INSTRUCTIONS_H
19 #include "llvm/InstrTypes.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/Attributes.h"
22 #include "llvm/CallingConv.h"
23 #include "llvm/ADT/ArrayRef.h"
24 #include "llvm/ADT/SmallVector.h"
25 #include "llvm/Support/ErrorHandling.h"
39 // Consume = 3, // Not specified yet.
43 SequentiallyConsistent = 7
46 enum SynchronizationScope {
51 //===----------------------------------------------------------------------===//
53 //===----------------------------------------------------------------------===//
55 /// AllocaInst - an instruction to allocate memory on the stack
57 class AllocaInst : public UnaryInstruction {
59 virtual AllocaInst *clone_impl() const;
61 explicit AllocaInst(Type *Ty, Value *ArraySize = 0,
62 const Twine &Name = "", Instruction *InsertBefore = 0);
63 AllocaInst(Type *Ty, Value *ArraySize,
64 const Twine &Name, BasicBlock *InsertAtEnd);
66 AllocaInst(Type *Ty, const Twine &Name, Instruction *InsertBefore = 0);
67 AllocaInst(Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd);
69 AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
70 const Twine &Name = "", Instruction *InsertBefore = 0);
71 AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
72 const Twine &Name, BasicBlock *InsertAtEnd);
74 // Out of line virtual method, so the vtable, etc. has a home.
75 virtual ~AllocaInst();
77 /// isArrayAllocation - Return true if there is an allocation size parameter
78 /// to the allocation instruction that is not 1.
80 bool isArrayAllocation() const;
82 /// getArraySize - Get the number of elements allocated. For a simple
83 /// allocation of a single element, this will return a constant 1 value.
85 const Value *getArraySize() const { return getOperand(0); }
86 Value *getArraySize() { return getOperand(0); }
88 /// getType - Overload to return most specific pointer type
90 PointerType *getType() const {
91 return reinterpret_cast<PointerType*>(Instruction::getType());
94 /// getAllocatedType - Return the type that is being allocated by the
97 Type *getAllocatedType() const;
99 /// getAlignment - Return the alignment of the memory that is being allocated
100 /// by the instruction.
102 unsigned getAlignment() const {
103 return (1u << getSubclassDataFromInstruction()) >> 1;
105 void setAlignment(unsigned Align);
107 /// isStaticAlloca - Return true if this alloca is in the entry block of the
108 /// function and is a constant size. If so, the code generator will fold it
109 /// into the prolog/epilog code, so it is basically free.
110 bool isStaticAlloca() const;
112 // Methods for support type inquiry through isa, cast, and dyn_cast:
113 static inline bool classof(const AllocaInst *) { return true; }
114 static inline bool classof(const Instruction *I) {
115 return (I->getOpcode() == Instruction::Alloca);
117 static inline bool classof(const Value *V) {
118 return isa<Instruction>(V) && classof(cast<Instruction>(V));
121 // Shadow Instruction::setInstructionSubclassData with a private forwarding
122 // method so that subclasses cannot accidentally use it.
123 void setInstructionSubclassData(unsigned short D) {
124 Instruction::setInstructionSubclassData(D);
129 //===----------------------------------------------------------------------===//
131 //===----------------------------------------------------------------------===//
133 /// LoadInst - an instruction for reading from memory. This uses the
134 /// SubclassData field in Value to store whether or not the load is volatile.
136 class LoadInst : public UnaryInstruction {
139 virtual LoadInst *clone_impl() const;
141 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
142 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
143 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
144 Instruction *InsertBefore = 0);
145 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
146 BasicBlock *InsertAtEnd);
147 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
148 unsigned Align, Instruction *InsertBefore = 0);
149 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
150 unsigned Align, BasicBlock *InsertAtEnd);
151 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
152 unsigned Align, AtomicOrdering Order,
153 SynchronizationScope SynchScope = CrossThread,
154 Instruction *InsertBefore = 0);
155 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
156 unsigned Align, AtomicOrdering Order,
157 SynchronizationScope SynchScope,
158 BasicBlock *InsertAtEnd);
160 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
161 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
162 explicit LoadInst(Value *Ptr, const char *NameStr = 0,
163 bool isVolatile = false, Instruction *InsertBefore = 0);
164 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
165 BasicBlock *InsertAtEnd);
167 /// isVolatile - Return true if this is a load from a volatile memory
170 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
172 /// setVolatile - Specify whether this is a volatile load or not.
174 void setVolatile(bool V) {
175 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
179 /// getAlignment - Return the alignment of the access that is being performed
181 unsigned getAlignment() const {
182 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
185 void setAlignment(unsigned Align);
187 /// Returns the ordering effect of this fence.
188 AtomicOrdering getOrdering() const {
189 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
192 /// Set the ordering constraint on this load. May not be Release or
194 void setOrdering(AtomicOrdering Ordering) {
195 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
199 SynchronizationScope getSynchScope() const {
200 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
203 /// Specify whether this load is ordered with respect to all
204 /// concurrently executing threads, or only with respect to signal handlers
205 /// executing in the same thread.
206 void setSynchScope(SynchronizationScope xthread) {
207 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
211 bool isAtomic() const { return getOrdering() != NotAtomic; }
212 void setAtomic(AtomicOrdering Ordering,
213 SynchronizationScope SynchScope = CrossThread) {
214 setOrdering(Ordering);
215 setSynchScope(SynchScope);
218 bool isSimple() const { return !isAtomic() && !isVolatile(); }
219 bool isUnordered() const {
220 return getOrdering() <= Unordered && !isVolatile();
223 Value *getPointerOperand() { return getOperand(0); }
224 const Value *getPointerOperand() const { return getOperand(0); }
225 static unsigned getPointerOperandIndex() { return 0U; }
227 unsigned getPointerAddressSpace() const {
228 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
232 // Methods for support type inquiry through isa, cast, and dyn_cast:
233 static inline bool classof(const LoadInst *) { return true; }
234 static inline bool classof(const Instruction *I) {
235 return I->getOpcode() == Instruction::Load;
237 static inline bool classof(const Value *V) {
238 return isa<Instruction>(V) && classof(cast<Instruction>(V));
241 // Shadow Instruction::setInstructionSubclassData with a private forwarding
242 // method so that subclasses cannot accidentally use it.
243 void setInstructionSubclassData(unsigned short D) {
244 Instruction::setInstructionSubclassData(D);
249 //===----------------------------------------------------------------------===//
251 //===----------------------------------------------------------------------===//
253 /// StoreInst - an instruction for storing to memory
255 class StoreInst : public Instruction {
256 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
259 virtual StoreInst *clone_impl() const;
261 // allocate space for exactly two operands
262 void *operator new(size_t s) {
263 return User::operator new(s, 2);
265 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
266 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
267 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
268 Instruction *InsertBefore = 0);
269 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
270 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
271 unsigned Align, Instruction *InsertBefore = 0);
272 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
273 unsigned Align, BasicBlock *InsertAtEnd);
274 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
275 unsigned Align, AtomicOrdering Order,
276 SynchronizationScope SynchScope = CrossThread,
277 Instruction *InsertBefore = 0);
278 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
279 unsigned Align, AtomicOrdering Order,
280 SynchronizationScope SynchScope,
281 BasicBlock *InsertAtEnd);
284 /// isVolatile - Return true if this is a store to a volatile memory
287 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
289 /// setVolatile - Specify whether this is a volatile store or not.
291 void setVolatile(bool V) {
292 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
296 /// Transparently provide more efficient getOperand methods.
297 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
299 /// getAlignment - Return the alignment of the access that is being performed
301 unsigned getAlignment() const {
302 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
305 void setAlignment(unsigned Align);
307 /// Returns the ordering effect of this store.
308 AtomicOrdering getOrdering() const {
309 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
312 /// Set the ordering constraint on this store. May not be Acquire or
314 void setOrdering(AtomicOrdering Ordering) {
315 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
319 SynchronizationScope getSynchScope() const {
320 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
323 /// Specify whether this store instruction is ordered with respect to all
324 /// concurrently executing threads, or only with respect to signal handlers
325 /// executing in the same thread.
326 void setSynchScope(SynchronizationScope xthread) {
327 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
331 bool isAtomic() const { return getOrdering() != NotAtomic; }
332 void setAtomic(AtomicOrdering Ordering,
333 SynchronizationScope SynchScope = CrossThread) {
334 setOrdering(Ordering);
335 setSynchScope(SynchScope);
338 bool isSimple() const { return !isAtomic() && !isVolatile(); }
339 bool isUnordered() const {
340 return getOrdering() <= Unordered && !isVolatile();
343 Value *getValueOperand() { return getOperand(0); }
344 const Value *getValueOperand() const { return getOperand(0); }
346 Value *getPointerOperand() { return getOperand(1); }
347 const Value *getPointerOperand() const { return getOperand(1); }
348 static unsigned getPointerOperandIndex() { return 1U; }
350 unsigned getPointerAddressSpace() const {
351 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
354 // Methods for support type inquiry through isa, cast, and dyn_cast:
355 static inline bool classof(const StoreInst *) { return true; }
356 static inline bool classof(const Instruction *I) {
357 return I->getOpcode() == Instruction::Store;
359 static inline bool classof(const Value *V) {
360 return isa<Instruction>(V) && classof(cast<Instruction>(V));
363 // Shadow Instruction::setInstructionSubclassData with a private forwarding
364 // method so that subclasses cannot accidentally use it.
365 void setInstructionSubclassData(unsigned short D) {
366 Instruction::setInstructionSubclassData(D);
371 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
374 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
376 //===----------------------------------------------------------------------===//
378 //===----------------------------------------------------------------------===//
380 /// FenceInst - an instruction for ordering other memory operations
382 class FenceInst : public Instruction {
383 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
384 void Init(AtomicOrdering Ordering, SynchronizationScope SynchScope);
386 virtual FenceInst *clone_impl() const;
388 // allocate space for exactly zero operands
389 void *operator new(size_t s) {
390 return User::operator new(s, 0);
393 // Ordering may only be Acquire, Release, AcquireRelease, or
394 // SequentiallyConsistent.
395 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
396 SynchronizationScope SynchScope = CrossThread,
397 Instruction *InsertBefore = 0);
398 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
399 SynchronizationScope SynchScope,
400 BasicBlock *InsertAtEnd);
402 /// Returns the ordering effect of this fence.
403 AtomicOrdering getOrdering() const {
404 return AtomicOrdering(getSubclassDataFromInstruction() >> 1);
407 /// Set the ordering constraint on this fence. May only be Acquire, Release,
408 /// AcquireRelease, or SequentiallyConsistent.
409 void setOrdering(AtomicOrdering Ordering) {
410 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
414 SynchronizationScope getSynchScope() const {
415 return SynchronizationScope(getSubclassDataFromInstruction() & 1);
418 /// Specify whether this fence orders other operations with respect to all
419 /// concurrently executing threads, or only with respect to signal handlers
420 /// executing in the same thread.
421 void setSynchScope(SynchronizationScope xthread) {
422 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
426 // Methods for support type inquiry through isa, cast, and dyn_cast:
427 static inline bool classof(const FenceInst *) { return true; }
428 static inline bool classof(const Instruction *I) {
429 return I->getOpcode() == Instruction::Fence;
431 static inline bool classof(const Value *V) {
432 return isa<Instruction>(V) && classof(cast<Instruction>(V));
435 // Shadow Instruction::setInstructionSubclassData with a private forwarding
436 // method so that subclasses cannot accidentally use it.
437 void setInstructionSubclassData(unsigned short D) {
438 Instruction::setInstructionSubclassData(D);
442 //===----------------------------------------------------------------------===//
443 // AtomicCmpXchgInst Class
444 //===----------------------------------------------------------------------===//
446 /// AtomicCmpXchgInst - an instruction that atomically checks whether a
447 /// specified value is in a memory location, and, if it is, stores a new value
448 /// there. Returns the value that was loaded.
450 class AtomicCmpXchgInst : public Instruction {
451 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
452 void Init(Value *Ptr, Value *Cmp, Value *NewVal,
453 AtomicOrdering Ordering, SynchronizationScope SynchScope);
455 virtual AtomicCmpXchgInst *clone_impl() const;
457 // allocate space for exactly three operands
458 void *operator new(size_t s) {
459 return User::operator new(s, 3);
461 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
462 AtomicOrdering Ordering, SynchronizationScope SynchScope,
463 Instruction *InsertBefore = 0);
464 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
465 AtomicOrdering Ordering, SynchronizationScope SynchScope,
466 BasicBlock *InsertAtEnd);
468 /// isVolatile - Return true if this is a cmpxchg from a volatile memory
471 bool isVolatile() const {
472 return getSubclassDataFromInstruction() & 1;
475 /// setVolatile - Specify whether this is a volatile cmpxchg.
477 void setVolatile(bool V) {
478 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
482 /// Transparently provide more efficient getOperand methods.
483 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
485 /// Set the ordering constraint on this cmpxchg.
486 void setOrdering(AtomicOrdering Ordering) {
487 assert(Ordering != NotAtomic &&
488 "CmpXchg instructions can only be atomic.");
489 setInstructionSubclassData((getSubclassDataFromInstruction() & 3) |
493 /// Specify whether this cmpxchg is atomic and orders other operations with
494 /// respect to all concurrently executing threads, or only with respect to
495 /// signal handlers executing in the same thread.
496 void setSynchScope(SynchronizationScope SynchScope) {
497 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
501 /// Returns the ordering constraint on this cmpxchg.
502 AtomicOrdering getOrdering() const {
503 return AtomicOrdering(getSubclassDataFromInstruction() >> 2);
506 /// Returns whether this cmpxchg is atomic between threads or only within a
508 SynchronizationScope getSynchScope() const {
509 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
512 Value *getPointerOperand() { return getOperand(0); }
513 const Value *getPointerOperand() const { return getOperand(0); }
514 static unsigned getPointerOperandIndex() { return 0U; }
516 Value *getCompareOperand() { return getOperand(1); }
517 const Value *getCompareOperand() const { return getOperand(1); }
519 Value *getNewValOperand() { return getOperand(2); }
520 const Value *getNewValOperand() const { return getOperand(2); }
522 unsigned getPointerAddressSpace() const {
523 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
526 // Methods for support type inquiry through isa, cast, and dyn_cast:
527 static inline bool classof(const AtomicCmpXchgInst *) { return true; }
528 static inline bool classof(const Instruction *I) {
529 return I->getOpcode() == Instruction::AtomicCmpXchg;
531 static inline bool classof(const Value *V) {
532 return isa<Instruction>(V) && classof(cast<Instruction>(V));
535 // Shadow Instruction::setInstructionSubclassData with a private forwarding
536 // method so that subclasses cannot accidentally use it.
537 void setInstructionSubclassData(unsigned short D) {
538 Instruction::setInstructionSubclassData(D);
543 struct OperandTraits<AtomicCmpXchgInst> :
544 public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
547 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)
549 //===----------------------------------------------------------------------===//
550 // AtomicRMWInst Class
551 //===----------------------------------------------------------------------===//
553 /// AtomicRMWInst - an instruction that atomically reads a memory location,
554 /// combines it with another value, and then stores the result back. Returns
557 class AtomicRMWInst : public Instruction {
558 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
560 virtual AtomicRMWInst *clone_impl() const;
562 /// This enumeration lists the possible modifications atomicrmw can make. In
563 /// the descriptions, 'p' is the pointer to the instruction's memory location,
564 /// 'old' is the initial value of *p, and 'v' is the other value passed to the
565 /// instruction. These instructions always return 'old'.
581 /// *p = old >signed v ? old : v
583 /// *p = old <signed v ? old : v
585 /// *p = old >unsigned v ? old : v
587 /// *p = old <unsigned v ? old : v
595 // allocate space for exactly two operands
596 void *operator new(size_t s) {
597 return User::operator new(s, 2);
599 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
600 AtomicOrdering Ordering, SynchronizationScope SynchScope,
601 Instruction *InsertBefore = 0);
602 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
603 AtomicOrdering Ordering, SynchronizationScope SynchScope,
604 BasicBlock *InsertAtEnd);
606 BinOp getOperation() const {
607 return static_cast<BinOp>(getSubclassDataFromInstruction() >> 5);
610 void setOperation(BinOp Operation) {
611 unsigned short SubclassData = getSubclassDataFromInstruction();
612 setInstructionSubclassData((SubclassData & 31) |
616 /// isVolatile - Return true if this is a RMW on a volatile memory location.
618 bool isVolatile() const {
619 return getSubclassDataFromInstruction() & 1;
622 /// setVolatile - Specify whether this is a volatile RMW or not.
624 void setVolatile(bool V) {
625 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
629 /// Transparently provide more efficient getOperand methods.
630 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
632 /// Set the ordering constraint on this RMW.
633 void setOrdering(AtomicOrdering Ordering) {
634 assert(Ordering != NotAtomic &&
635 "atomicrmw instructions can only be atomic.");
636 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 2)) |
640 /// Specify whether this RMW orders other operations with respect to all
641 /// concurrently executing threads, or only with respect to signal handlers
642 /// executing in the same thread.
643 void setSynchScope(SynchronizationScope SynchScope) {
644 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
648 /// Returns the ordering constraint on this RMW.
649 AtomicOrdering getOrdering() const {
650 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
653 /// Returns whether this RMW is atomic between threads or only within a
655 SynchronizationScope getSynchScope() const {
656 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
659 Value *getPointerOperand() { return getOperand(0); }
660 const Value *getPointerOperand() const { return getOperand(0); }
661 static unsigned getPointerOperandIndex() { return 0U; }
663 Value *getValOperand() { return getOperand(1); }
664 const Value *getValOperand() const { return getOperand(1); }
666 unsigned getPointerAddressSpace() const {
667 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
670 // Methods for support type inquiry through isa, cast, and dyn_cast:
671 static inline bool classof(const AtomicRMWInst *) { return true; }
672 static inline bool classof(const Instruction *I) {
673 return I->getOpcode() == Instruction::AtomicRMW;
675 static inline bool classof(const Value *V) {
676 return isa<Instruction>(V) && classof(cast<Instruction>(V));
679 void Init(BinOp Operation, Value *Ptr, Value *Val,
680 AtomicOrdering Ordering, SynchronizationScope SynchScope);
681 // Shadow Instruction::setInstructionSubclassData with a private forwarding
682 // method so that subclasses cannot accidentally use it.
683 void setInstructionSubclassData(unsigned short D) {
684 Instruction::setInstructionSubclassData(D);
689 struct OperandTraits<AtomicRMWInst>
690 : public FixedNumOperandTraits<AtomicRMWInst,2> {
693 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)
695 //===----------------------------------------------------------------------===//
696 // GetElementPtrInst Class
697 //===----------------------------------------------------------------------===//
699 // checkGEPType - Simple wrapper function to give a better assertion failure
700 // message on bad indexes for a gep instruction.
702 static inline Type *checkGEPType(Type *Ty) {
703 assert(Ty && "Invalid GetElementPtrInst indices for type!");
707 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
708 /// access elements of arrays and structs
710 class GetElementPtrInst : public Instruction {
711 GetElementPtrInst(const GetElementPtrInst &GEPI);
712 void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
714 /// Constructors - Create a getelementptr instruction with a base pointer an
715 /// list of indices. The first ctor can optionally insert before an existing
716 /// instruction, the second appends the new instruction to the specified
718 inline GetElementPtrInst(Value *Ptr, ArrayRef<Value *> IdxList,
719 unsigned Values, const Twine &NameStr,
720 Instruction *InsertBefore);
721 inline GetElementPtrInst(Value *Ptr, ArrayRef<Value *> IdxList,
722 unsigned Values, const Twine &NameStr,
723 BasicBlock *InsertAtEnd);
725 virtual GetElementPtrInst *clone_impl() const;
727 static GetElementPtrInst *Create(Value *Ptr, ArrayRef<Value *> IdxList,
728 const Twine &NameStr = "",
729 Instruction *InsertBefore = 0) {
730 unsigned Values = 1 + unsigned(IdxList.size());
732 GetElementPtrInst(Ptr, IdxList, Values, NameStr, InsertBefore);
734 static GetElementPtrInst *Create(Value *Ptr, ArrayRef<Value *> IdxList,
735 const Twine &NameStr,
736 BasicBlock *InsertAtEnd) {
737 unsigned Values = 1 + unsigned(IdxList.size());
739 GetElementPtrInst(Ptr, IdxList, Values, NameStr, InsertAtEnd);
742 /// Create an "inbounds" getelementptr. See the documentation for the
743 /// "inbounds" flag in LangRef.html for details.
744 static GetElementPtrInst *CreateInBounds(Value *Ptr,
745 ArrayRef<Value *> IdxList,
746 const Twine &NameStr = "",
747 Instruction *InsertBefore = 0) {
748 GetElementPtrInst *GEP = Create(Ptr, IdxList, NameStr, InsertBefore);
749 GEP->setIsInBounds(true);
752 static GetElementPtrInst *CreateInBounds(Value *Ptr,
753 ArrayRef<Value *> IdxList,
754 const Twine &NameStr,
755 BasicBlock *InsertAtEnd) {
756 GetElementPtrInst *GEP = Create(Ptr, IdxList, NameStr, InsertAtEnd);
757 GEP->setIsInBounds(true);
761 /// Transparently provide more efficient getOperand methods.
762 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
764 // getType - Overload to return most specific pointer type...
765 PointerType *getType() const {
766 return reinterpret_cast<PointerType*>(Instruction::getType());
769 /// getIndexedType - Returns the type of the element that would be loaded with
770 /// a load instruction with the specified parameters.
772 /// Null is returned if the indices are invalid for the specified
775 static Type *getIndexedType(Type *Ptr, ArrayRef<Value *> IdxList);
776 static Type *getIndexedType(Type *Ptr, ArrayRef<Constant *> IdxList);
777 static Type *getIndexedType(Type *Ptr, ArrayRef<uint64_t> IdxList);
779 /// getIndexedType - Returns the address space used by the GEP pointer.
781 static unsigned getAddressSpace(Value *Ptr);
783 inline op_iterator idx_begin() { return op_begin()+1; }
784 inline const_op_iterator idx_begin() const { return op_begin()+1; }
785 inline op_iterator idx_end() { return op_end(); }
786 inline const_op_iterator idx_end() const { return op_end(); }
788 Value *getPointerOperand() {
789 return getOperand(0);
791 const Value *getPointerOperand() const {
792 return getOperand(0);
794 static unsigned getPointerOperandIndex() {
795 return 0U; // get index for modifying correct operand.
798 unsigned getPointerAddressSpace() const {
799 return cast<PointerType>(getType())->getAddressSpace();
802 /// getPointerOperandType - Method to return the pointer operand as a
804 Type *getPointerOperandType() const {
805 return getPointerOperand()->getType();
808 /// GetGEPReturnType - Returns the pointer type returned by the GEP
809 /// instruction, which may be a vector of pointers.
810 static Type *getGEPReturnType(Value *Ptr, ArrayRef<Value *> IdxList) {
811 Type *PtrTy = PointerType::get(checkGEPType(
812 getIndexedType(Ptr->getType(), IdxList)),
813 getAddressSpace(Ptr));
815 if (Ptr->getType()->isVectorTy()) {
816 unsigned NumElem = cast<VectorType>(Ptr->getType())->getNumElements();
817 return VectorType::get(PtrTy, NumElem);
824 unsigned getNumIndices() const { // Note: always non-negative
825 return getNumOperands() - 1;
828 bool hasIndices() const {
829 return getNumOperands() > 1;
832 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
833 /// zeros. If so, the result pointer and the first operand have the same
834 /// value, just potentially different types.
835 bool hasAllZeroIndices() const;
837 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
838 /// constant integers. If so, the result pointer and the first operand have
839 /// a constant offset between them.
840 bool hasAllConstantIndices() const;
842 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
843 /// See LangRef.html for the meaning of inbounds on a getelementptr.
844 void setIsInBounds(bool b = true);
846 /// isInBounds - Determine whether the GEP has the inbounds flag.
847 bool isInBounds() const;
849 // Methods for support type inquiry through isa, cast, and dyn_cast:
850 static inline bool classof(const GetElementPtrInst *) { return true; }
851 static inline bool classof(const Instruction *I) {
852 return (I->getOpcode() == Instruction::GetElementPtr);
854 static inline bool classof(const Value *V) {
855 return isa<Instruction>(V) && classof(cast<Instruction>(V));
860 struct OperandTraits<GetElementPtrInst> :
861 public VariadicOperandTraits<GetElementPtrInst, 1> {
864 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
865 ArrayRef<Value *> IdxList,
867 const Twine &NameStr,
868 Instruction *InsertBefore)
869 : Instruction(getGEPReturnType(Ptr, IdxList),
871 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
872 Values, InsertBefore) {
873 init(Ptr, IdxList, NameStr);
875 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
876 ArrayRef<Value *> IdxList,
878 const Twine &NameStr,
879 BasicBlock *InsertAtEnd)
880 : Instruction(getGEPReturnType(Ptr, IdxList),
882 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
883 Values, InsertAtEnd) {
884 init(Ptr, IdxList, NameStr);
888 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
891 //===----------------------------------------------------------------------===//
893 //===----------------------------------------------------------------------===//
895 /// This instruction compares its operands according to the predicate given
896 /// to the constructor. It only operates on integers or pointers. The operands
897 /// must be identical types.
898 /// @brief Represent an integer comparison operator.
899 class ICmpInst: public CmpInst {
901 /// @brief Clone an identical ICmpInst
902 virtual ICmpInst *clone_impl() const;
904 /// @brief Constructor with insert-before-instruction semantics.
906 Instruction *InsertBefore, ///< Where to insert
907 Predicate pred, ///< The predicate to use for the comparison
908 Value *LHS, ///< The left-hand-side of the expression
909 Value *RHS, ///< The right-hand-side of the expression
910 const Twine &NameStr = "" ///< Name of the instruction
911 ) : CmpInst(makeCmpResultType(LHS->getType()),
912 Instruction::ICmp, pred, LHS, RHS, NameStr,
914 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
915 pred <= CmpInst::LAST_ICMP_PREDICATE &&
916 "Invalid ICmp predicate value");
917 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
918 "Both operands to ICmp instruction are not of the same type!");
919 // Check that the operands are the right type
920 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
921 getOperand(0)->getType()->getScalarType()->isPointerTy()) &&
922 "Invalid operand types for ICmp instruction");
925 /// @brief Constructor with insert-at-end semantics.
927 BasicBlock &InsertAtEnd, ///< Block to insert into.
928 Predicate pred, ///< The predicate to use for the comparison
929 Value *LHS, ///< The left-hand-side of the expression
930 Value *RHS, ///< The right-hand-side of the expression
931 const Twine &NameStr = "" ///< Name of the instruction
932 ) : CmpInst(makeCmpResultType(LHS->getType()),
933 Instruction::ICmp, pred, LHS, RHS, NameStr,
935 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
936 pred <= CmpInst::LAST_ICMP_PREDICATE &&
937 "Invalid ICmp predicate value");
938 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
939 "Both operands to ICmp instruction are not of the same type!");
940 // Check that the operands are the right type
941 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
942 getOperand(0)->getType()->isPointerTy()) &&
943 "Invalid operand types for ICmp instruction");
946 /// @brief Constructor with no-insertion semantics
948 Predicate pred, ///< The predicate to use for the comparison
949 Value *LHS, ///< The left-hand-side of the expression
950 Value *RHS, ///< The right-hand-side of the expression
951 const Twine &NameStr = "" ///< Name of the instruction
952 ) : CmpInst(makeCmpResultType(LHS->getType()),
953 Instruction::ICmp, pred, LHS, RHS, NameStr) {
954 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
955 pred <= CmpInst::LAST_ICMP_PREDICATE &&
956 "Invalid ICmp predicate value");
957 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
958 "Both operands to ICmp instruction are not of the same type!");
959 // Check that the operands are the right type
960 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
961 getOperand(0)->getType()->getScalarType()->isPointerTy()) &&
962 "Invalid operand types for ICmp instruction");
965 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
966 /// @returns the predicate that would be the result if the operand were
967 /// regarded as signed.
968 /// @brief Return the signed version of the predicate
969 Predicate getSignedPredicate() const {
970 return getSignedPredicate(getPredicate());
973 /// This is a static version that you can use without an instruction.
974 /// @brief Return the signed version of the predicate.
975 static Predicate getSignedPredicate(Predicate pred);
977 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
978 /// @returns the predicate that would be the result if the operand were
979 /// regarded as unsigned.
980 /// @brief Return the unsigned version of the predicate
981 Predicate getUnsignedPredicate() const {
982 return getUnsignedPredicate(getPredicate());
985 /// This is a static version that you can use without an instruction.
986 /// @brief Return the unsigned version of the predicate.
987 static Predicate getUnsignedPredicate(Predicate pred);
989 /// isEquality - Return true if this predicate is either EQ or NE. This also
990 /// tests for commutativity.
991 static bool isEquality(Predicate P) {
992 return P == ICMP_EQ || P == ICMP_NE;
995 /// isEquality - Return true if this predicate is either EQ or NE. This also
996 /// tests for commutativity.
997 bool isEquality() const {
998 return isEquality(getPredicate());
1001 /// @returns true if the predicate of this ICmpInst is commutative
1002 /// @brief Determine if this relation is commutative.
1003 bool isCommutative() const { return isEquality(); }
1005 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1007 bool isRelational() const {
1008 return !isEquality();
1011 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1013 static bool isRelational(Predicate P) {
1014 return !isEquality(P);
1017 /// Initialize a set of values that all satisfy the predicate with C.
1018 /// @brief Make a ConstantRange for a relation with a constant value.
1019 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
1021 /// Exchange the two operands to this instruction in such a way that it does
1022 /// not modify the semantics of the instruction. The predicate value may be
1023 /// changed to retain the same result if the predicate is order dependent
1025 /// @brief Swap operands and adjust predicate.
1026 void swapOperands() {
1027 setPredicate(getSwappedPredicate());
1028 Op<0>().swap(Op<1>());
1031 // Methods for support type inquiry through isa, cast, and dyn_cast:
1032 static inline bool classof(const ICmpInst *) { return true; }
1033 static inline bool classof(const Instruction *I) {
1034 return I->getOpcode() == Instruction::ICmp;
1036 static inline bool classof(const Value *V) {
1037 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1042 //===----------------------------------------------------------------------===//
1044 //===----------------------------------------------------------------------===//
1046 /// This instruction compares its operands according to the predicate given
1047 /// to the constructor. It only operates on floating point values or packed
1048 /// vectors of floating point values. The operands must be identical types.
1049 /// @brief Represents a floating point comparison operator.
1050 class FCmpInst: public CmpInst {
1052 /// @brief Clone an identical FCmpInst
1053 virtual FCmpInst *clone_impl() const;
1055 /// @brief Constructor with insert-before-instruction semantics.
1057 Instruction *InsertBefore, ///< Where to insert
1058 Predicate pred, ///< The predicate to use for the comparison
1059 Value *LHS, ///< The left-hand-side of the expression
1060 Value *RHS, ///< The right-hand-side of the expression
1061 const Twine &NameStr = "" ///< Name of the instruction
1062 ) : CmpInst(makeCmpResultType(LHS->getType()),
1063 Instruction::FCmp, pred, LHS, RHS, NameStr,
1065 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1066 "Invalid FCmp predicate value");
1067 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1068 "Both operands to FCmp instruction are not of the same type!");
1069 // Check that the operands are the right type
1070 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1071 "Invalid operand types for FCmp instruction");
1074 /// @brief Constructor with insert-at-end semantics.
1076 BasicBlock &InsertAtEnd, ///< Block to insert into.
1077 Predicate pred, ///< The predicate to use for the comparison
1078 Value *LHS, ///< The left-hand-side of the expression
1079 Value *RHS, ///< The right-hand-side of the expression
1080 const Twine &NameStr = "" ///< Name of the instruction
1081 ) : CmpInst(makeCmpResultType(LHS->getType()),
1082 Instruction::FCmp, pred, LHS, RHS, NameStr,
1084 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1085 "Invalid FCmp predicate value");
1086 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1087 "Both operands to FCmp instruction are not of the same type!");
1088 // Check that the operands are the right type
1089 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1090 "Invalid operand types for FCmp instruction");
1093 /// @brief Constructor with no-insertion semantics
1095 Predicate pred, ///< The predicate to use for the comparison
1096 Value *LHS, ///< The left-hand-side of the expression
1097 Value *RHS, ///< The right-hand-side of the expression
1098 const Twine &NameStr = "" ///< Name of the instruction
1099 ) : CmpInst(makeCmpResultType(LHS->getType()),
1100 Instruction::FCmp, pred, LHS, RHS, NameStr) {
1101 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1102 "Invalid FCmp predicate value");
1103 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1104 "Both operands to FCmp instruction are not of the same type!");
1105 // Check that the operands are the right type
1106 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1107 "Invalid operand types for FCmp instruction");
1110 /// @returns true if the predicate of this instruction is EQ or NE.
1111 /// @brief Determine if this is an equality predicate.
1112 bool isEquality() const {
1113 return getPredicate() == FCMP_OEQ || getPredicate() == FCMP_ONE ||
1114 getPredicate() == FCMP_UEQ || getPredicate() == FCMP_UNE;
1117 /// @returns true if the predicate of this instruction is commutative.
1118 /// @brief Determine if this is a commutative predicate.
1119 bool isCommutative() const {
1120 return isEquality() ||
1121 getPredicate() == FCMP_FALSE ||
1122 getPredicate() == FCMP_TRUE ||
1123 getPredicate() == FCMP_ORD ||
1124 getPredicate() == FCMP_UNO;
1127 /// @returns true if the predicate is relational (not EQ or NE).
1128 /// @brief Determine if this a relational predicate.
1129 bool isRelational() const { return !isEquality(); }
1131 /// Exchange the two operands to this instruction in such a way that it does
1132 /// not modify the semantics of the instruction. The predicate value may be
1133 /// changed to retain the same result if the predicate is order dependent
1135 /// @brief Swap operands and adjust predicate.
1136 void swapOperands() {
1137 setPredicate(getSwappedPredicate());
1138 Op<0>().swap(Op<1>());
1141 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1142 static inline bool classof(const FCmpInst *) { return true; }
1143 static inline bool classof(const Instruction *I) {
1144 return I->getOpcode() == Instruction::FCmp;
1146 static inline bool classof(const Value *V) {
1147 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1151 //===----------------------------------------------------------------------===//
1152 /// CallInst - This class represents a function call, abstracting a target
1153 /// machine's calling convention. This class uses low bit of the SubClassData
1154 /// field to indicate whether or not this is a tail call. The rest of the bits
1155 /// hold the calling convention of the call.
1157 class CallInst : public Instruction {
1158 AttrListPtr AttributeList; ///< parameter attributes for call
1159 CallInst(const CallInst &CI);
1160 void init(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr);
1161 void init(Value *Func, const Twine &NameStr);
1163 /// Construct a CallInst given a range of arguments.
1164 /// @brief Construct a CallInst from a range of arguments
1165 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1166 const Twine &NameStr, Instruction *InsertBefore);
1168 /// Construct a CallInst given a range of arguments.
1169 /// @brief Construct a CallInst from a range of arguments
1170 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1171 const Twine &NameStr, BasicBlock *InsertAtEnd);
1173 CallInst(Value *F, Value *Actual, const Twine &NameStr,
1174 Instruction *InsertBefore);
1175 CallInst(Value *F, Value *Actual, const Twine &NameStr,
1176 BasicBlock *InsertAtEnd);
1177 explicit CallInst(Value *F, const Twine &NameStr,
1178 Instruction *InsertBefore);
1179 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1181 virtual CallInst *clone_impl() const;
1183 static CallInst *Create(Value *Func,
1184 ArrayRef<Value *> Args,
1185 const Twine &NameStr = "",
1186 Instruction *InsertBefore = 0) {
1187 return new(unsigned(Args.size() + 1))
1188 CallInst(Func, Args, NameStr, InsertBefore);
1190 static CallInst *Create(Value *Func,
1191 ArrayRef<Value *> Args,
1192 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1193 return new(unsigned(Args.size() + 1))
1194 CallInst(Func, Args, NameStr, InsertAtEnd);
1196 static CallInst *Create(Value *F, const Twine &NameStr = "",
1197 Instruction *InsertBefore = 0) {
1198 return new(1) CallInst(F, NameStr, InsertBefore);
1200 static CallInst *Create(Value *F, const Twine &NameStr,
1201 BasicBlock *InsertAtEnd) {
1202 return new(1) CallInst(F, NameStr, InsertAtEnd);
1204 /// CreateMalloc - Generate the IR for a call to malloc:
1205 /// 1. Compute the malloc call's argument as the specified type's size,
1206 /// possibly multiplied by the array size if the array size is not
1208 /// 2. Call malloc with that argument.
1209 /// 3. Bitcast the result of the malloc call to the specified type.
1210 static Instruction *CreateMalloc(Instruction *InsertBefore,
1211 Type *IntPtrTy, Type *AllocTy,
1212 Value *AllocSize, Value *ArraySize = 0,
1213 Function* MallocF = 0,
1214 const Twine &Name = "");
1215 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1216 Type *IntPtrTy, Type *AllocTy,
1217 Value *AllocSize, Value *ArraySize = 0,
1218 Function* MallocF = 0,
1219 const Twine &Name = "");
1220 /// CreateFree - Generate the IR for a call to the builtin free function.
1221 static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
1222 static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
1226 bool isTailCall() const { return getSubclassDataFromInstruction() & 1; }
1227 void setTailCall(bool isTC = true) {
1228 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
1232 /// Provide fast operand accessors
1233 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1235 /// getNumArgOperands - Return the number of call arguments.
1237 unsigned getNumArgOperands() const { return getNumOperands() - 1; }
1239 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
1241 Value *getArgOperand(unsigned i) const { return getOperand(i); }
1242 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
1244 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1246 CallingConv::ID getCallingConv() const {
1247 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 1);
1249 void setCallingConv(CallingConv::ID CC) {
1250 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
1251 (static_cast<unsigned>(CC) << 1));
1254 /// getAttributes - Return the parameter attributes for this call.
1256 const AttrListPtr &getAttributes() const { return AttributeList; }
1258 /// setAttributes - Set the parameter attributes for this call.
1260 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
1262 /// addAttribute - adds the attribute to the list of attributes.
1263 void addAttribute(unsigned i, Attributes attr);
1265 /// removeAttribute - removes the attribute from the list of attributes.
1266 void removeAttribute(unsigned i, Attributes attr);
1268 /// @brief Determine whether the call or the callee has the given attribute.
1269 bool paramHasAttr(unsigned i, Attributes attr) const;
1271 /// @brief Extract the alignment for a call or parameter (0=unknown).
1272 unsigned getParamAlignment(unsigned i) const {
1273 return AttributeList.getParamAlignment(i);
1276 /// @brief Return true if the call should not be inlined.
1277 bool isNoInline() const { return paramHasAttr(~0, Attribute::NoInline); }
1278 void setIsNoInline(bool Value = true) {
1279 if (Value) addAttribute(~0, Attribute::NoInline);
1280 else removeAttribute(~0, Attribute::NoInline);
1283 /// @brief Return true if the call can return twice
1284 bool canReturnTwice() const {
1285 return paramHasAttr(~0, Attribute::ReturnsTwice);
1287 void setCanReturnTwice(bool Value = true) {
1288 if (Value) addAttribute(~0, Attribute::ReturnsTwice);
1289 else removeAttribute(~0, Attribute::ReturnsTwice);
1292 /// @brief Determine if the call does not access memory.
1293 bool doesNotAccessMemory() const {
1294 return paramHasAttr(~0, Attribute::ReadNone);
1296 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1297 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
1298 else removeAttribute(~0, Attribute::ReadNone);
1301 /// @brief Determine if the call does not access or only reads memory.
1302 bool onlyReadsMemory() const {
1303 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
1305 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1306 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
1307 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
1310 /// @brief Determine if the call cannot return.
1311 bool doesNotReturn() const { return paramHasAttr(~0, Attribute::NoReturn); }
1312 void setDoesNotReturn(bool DoesNotReturn = true) {
1313 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
1314 else removeAttribute(~0, Attribute::NoReturn);
1317 /// @brief Determine if the call cannot unwind.
1318 bool doesNotThrow() const { return paramHasAttr(~0, Attribute::NoUnwind); }
1319 void setDoesNotThrow(bool DoesNotThrow = true) {
1320 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
1321 else removeAttribute(~0, Attribute::NoUnwind);
1324 /// @brief Determine if the call returns a structure through first
1325 /// pointer argument.
1326 bool hasStructRetAttr() const {
1327 // Be friendly and also check the callee.
1328 return paramHasAttr(1, Attribute::StructRet);
1331 /// @brief Determine if any call argument is an aggregate passed by value.
1332 bool hasByValArgument() const {
1333 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1336 /// getCalledFunction - Return the function called, or null if this is an
1337 /// indirect function invocation.
1339 Function *getCalledFunction() const {
1340 return dyn_cast<Function>(Op<-1>());
1343 /// getCalledValue - Get a pointer to the function that is invoked by this
1345 const Value *getCalledValue() const { return Op<-1>(); }
1346 Value *getCalledValue() { return Op<-1>(); }
1348 /// setCalledFunction - Set the function called.
1349 void setCalledFunction(Value* Fn) {
1353 /// isInlineAsm - Check if this call is an inline asm statement.
1354 bool isInlineAsm() const {
1355 return isa<InlineAsm>(Op<-1>());
1358 // Methods for support type inquiry through isa, cast, and dyn_cast:
1359 static inline bool classof(const CallInst *) { return true; }
1360 static inline bool classof(const Instruction *I) {
1361 return I->getOpcode() == Instruction::Call;
1363 static inline bool classof(const Value *V) {
1364 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1367 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1368 // method so that subclasses cannot accidentally use it.
1369 void setInstructionSubclassData(unsigned short D) {
1370 Instruction::setInstructionSubclassData(D);
1375 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1378 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1379 const Twine &NameStr, BasicBlock *InsertAtEnd)
1380 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1381 ->getElementType())->getReturnType(),
1383 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1384 unsigned(Args.size() + 1), InsertAtEnd) {
1385 init(Func, Args, NameStr);
1388 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1389 const Twine &NameStr, Instruction *InsertBefore)
1390 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1391 ->getElementType())->getReturnType(),
1393 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1394 unsigned(Args.size() + 1), InsertBefore) {
1395 init(Func, Args, NameStr);
1399 // Note: if you get compile errors about private methods then
1400 // please update your code to use the high-level operand
1401 // interfaces. See line 943 above.
1402 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1404 //===----------------------------------------------------------------------===//
1406 //===----------------------------------------------------------------------===//
1408 /// SelectInst - This class represents the LLVM 'select' instruction.
1410 class SelectInst : public Instruction {
1411 void init(Value *C, Value *S1, Value *S2) {
1412 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1418 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1419 Instruction *InsertBefore)
1420 : Instruction(S1->getType(), Instruction::Select,
1421 &Op<0>(), 3, InsertBefore) {
1425 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1426 BasicBlock *InsertAtEnd)
1427 : Instruction(S1->getType(), Instruction::Select,
1428 &Op<0>(), 3, InsertAtEnd) {
1433 virtual SelectInst *clone_impl() const;
1435 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1436 const Twine &NameStr = "",
1437 Instruction *InsertBefore = 0) {
1438 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1440 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1441 const Twine &NameStr,
1442 BasicBlock *InsertAtEnd) {
1443 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1446 const Value *getCondition() const { return Op<0>(); }
1447 const Value *getTrueValue() const { return Op<1>(); }
1448 const Value *getFalseValue() const { return Op<2>(); }
1449 Value *getCondition() { return Op<0>(); }
1450 Value *getTrueValue() { return Op<1>(); }
1451 Value *getFalseValue() { return Op<2>(); }
1453 /// areInvalidOperands - Return a string if the specified operands are invalid
1454 /// for a select operation, otherwise return null.
1455 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1457 /// Transparently provide more efficient getOperand methods.
1458 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1460 OtherOps getOpcode() const {
1461 return static_cast<OtherOps>(Instruction::getOpcode());
1464 // Methods for support type inquiry through isa, cast, and dyn_cast:
1465 static inline bool classof(const SelectInst *) { return true; }
1466 static inline bool classof(const Instruction *I) {
1467 return I->getOpcode() == Instruction::Select;
1469 static inline bool classof(const Value *V) {
1470 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1475 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1478 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1480 //===----------------------------------------------------------------------===//
1482 //===----------------------------------------------------------------------===//
1484 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1485 /// an argument of the specified type given a va_list and increments that list
1487 class VAArgInst : public UnaryInstruction {
1489 virtual VAArgInst *clone_impl() const;
1492 VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1493 Instruction *InsertBefore = 0)
1494 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1497 VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1498 BasicBlock *InsertAtEnd)
1499 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1503 Value *getPointerOperand() { return getOperand(0); }
1504 const Value *getPointerOperand() const { return getOperand(0); }
1505 static unsigned getPointerOperandIndex() { return 0U; }
1507 // Methods for support type inquiry through isa, cast, and dyn_cast:
1508 static inline bool classof(const VAArgInst *) { return true; }
1509 static inline bool classof(const Instruction *I) {
1510 return I->getOpcode() == VAArg;
1512 static inline bool classof(const Value *V) {
1513 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1517 //===----------------------------------------------------------------------===//
1518 // ExtractElementInst Class
1519 //===----------------------------------------------------------------------===//
1521 /// ExtractElementInst - This instruction extracts a single (scalar)
1522 /// element from a VectorType value
1524 class ExtractElementInst : public Instruction {
1525 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1526 Instruction *InsertBefore = 0);
1527 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1528 BasicBlock *InsertAtEnd);
1530 virtual ExtractElementInst *clone_impl() const;
1533 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1534 const Twine &NameStr = "",
1535 Instruction *InsertBefore = 0) {
1536 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1538 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1539 const Twine &NameStr,
1540 BasicBlock *InsertAtEnd) {
1541 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1544 /// isValidOperands - Return true if an extractelement instruction can be
1545 /// formed with the specified operands.
1546 static bool isValidOperands(const Value *Vec, const Value *Idx);
1548 Value *getVectorOperand() { return Op<0>(); }
1549 Value *getIndexOperand() { return Op<1>(); }
1550 const Value *getVectorOperand() const { return Op<0>(); }
1551 const Value *getIndexOperand() const { return Op<1>(); }
1553 VectorType *getVectorOperandType() const {
1554 return reinterpret_cast<VectorType*>(getVectorOperand()->getType());
1558 /// Transparently provide more efficient getOperand methods.
1559 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1561 // Methods for support type inquiry through isa, cast, and dyn_cast:
1562 static inline bool classof(const ExtractElementInst *) { return true; }
1563 static inline bool classof(const Instruction *I) {
1564 return I->getOpcode() == Instruction::ExtractElement;
1566 static inline bool classof(const Value *V) {
1567 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1572 struct OperandTraits<ExtractElementInst> :
1573 public FixedNumOperandTraits<ExtractElementInst, 2> {
1576 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1578 //===----------------------------------------------------------------------===//
1579 // InsertElementInst Class
1580 //===----------------------------------------------------------------------===//
1582 /// InsertElementInst - This instruction inserts a single (scalar)
1583 /// element into a VectorType value
1585 class InsertElementInst : public Instruction {
1586 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1587 const Twine &NameStr = "",
1588 Instruction *InsertBefore = 0);
1589 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1590 const Twine &NameStr, BasicBlock *InsertAtEnd);
1592 virtual InsertElementInst *clone_impl() const;
1595 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1596 const Twine &NameStr = "",
1597 Instruction *InsertBefore = 0) {
1598 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1600 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1601 const Twine &NameStr,
1602 BasicBlock *InsertAtEnd) {
1603 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1606 /// isValidOperands - Return true if an insertelement instruction can be
1607 /// formed with the specified operands.
1608 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1611 /// getType - Overload to return most specific vector type.
1613 VectorType *getType() const {
1614 return reinterpret_cast<VectorType*>(Instruction::getType());
1617 /// Transparently provide more efficient getOperand methods.
1618 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1620 // Methods for support type inquiry through isa, cast, and dyn_cast:
1621 static inline bool classof(const InsertElementInst *) { return true; }
1622 static inline bool classof(const Instruction *I) {
1623 return I->getOpcode() == Instruction::InsertElement;
1625 static inline bool classof(const Value *V) {
1626 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1631 struct OperandTraits<InsertElementInst> :
1632 public FixedNumOperandTraits<InsertElementInst, 3> {
1635 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1637 //===----------------------------------------------------------------------===//
1638 // ShuffleVectorInst Class
1639 //===----------------------------------------------------------------------===//
1641 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1644 class ShuffleVectorInst : public Instruction {
1646 virtual ShuffleVectorInst *clone_impl() const;
1649 // allocate space for exactly three operands
1650 void *operator new(size_t s) {
1651 return User::operator new(s, 3);
1653 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1654 const Twine &NameStr = "",
1655 Instruction *InsertBefor = 0);
1656 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1657 const Twine &NameStr, BasicBlock *InsertAtEnd);
1659 /// isValidOperands - Return true if a shufflevector instruction can be
1660 /// formed with the specified operands.
1661 static bool isValidOperands(const Value *V1, const Value *V2,
1664 /// getType - Overload to return most specific vector type.
1666 VectorType *getType() const {
1667 return reinterpret_cast<VectorType*>(Instruction::getType());
1670 /// Transparently provide more efficient getOperand methods.
1671 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1673 /// getMaskValue - Return the index from the shuffle mask for the specified
1674 /// output result. This is either -1 if the element is undef or a number less
1675 /// than 2*numelements.
1676 int getMaskValue(unsigned i) const;
1678 // Methods for support type inquiry through isa, cast, and dyn_cast:
1679 static inline bool classof(const ShuffleVectorInst *) { return true; }
1680 static inline bool classof(const Instruction *I) {
1681 return I->getOpcode() == Instruction::ShuffleVector;
1683 static inline bool classof(const Value *V) {
1684 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1689 struct OperandTraits<ShuffleVectorInst> :
1690 public FixedNumOperandTraits<ShuffleVectorInst, 3> {
1693 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1695 //===----------------------------------------------------------------------===//
1696 // ExtractValueInst Class
1697 //===----------------------------------------------------------------------===//
1699 /// ExtractValueInst - This instruction extracts a struct member or array
1700 /// element value from an aggregate value.
1702 class ExtractValueInst : public UnaryInstruction {
1703 SmallVector<unsigned, 4> Indices;
1705 ExtractValueInst(const ExtractValueInst &EVI);
1706 void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
1708 /// Constructors - Create a extractvalue instruction with a base aggregate
1709 /// value and a list of indices. The first ctor can optionally insert before
1710 /// an existing instruction, the second appends the new instruction to the
1711 /// specified BasicBlock.
1712 inline ExtractValueInst(Value *Agg,
1713 ArrayRef<unsigned> Idxs,
1714 const Twine &NameStr,
1715 Instruction *InsertBefore);
1716 inline ExtractValueInst(Value *Agg,
1717 ArrayRef<unsigned> Idxs,
1718 const Twine &NameStr, BasicBlock *InsertAtEnd);
1720 // allocate space for exactly one operand
1721 void *operator new(size_t s) {
1722 return User::operator new(s, 1);
1725 virtual ExtractValueInst *clone_impl() const;
1728 static ExtractValueInst *Create(Value *Agg,
1729 ArrayRef<unsigned> Idxs,
1730 const Twine &NameStr = "",
1731 Instruction *InsertBefore = 0) {
1733 ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
1735 static ExtractValueInst *Create(Value *Agg,
1736 ArrayRef<unsigned> Idxs,
1737 const Twine &NameStr,
1738 BasicBlock *InsertAtEnd) {
1739 return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
1742 /// getIndexedType - Returns the type of the element that would be extracted
1743 /// with an extractvalue instruction with the specified parameters.
1745 /// Null is returned if the indices are invalid for the specified type.
1746 static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
1748 typedef const unsigned* idx_iterator;
1749 inline idx_iterator idx_begin() const { return Indices.begin(); }
1750 inline idx_iterator idx_end() const { return Indices.end(); }
1752 Value *getAggregateOperand() {
1753 return getOperand(0);
1755 const Value *getAggregateOperand() const {
1756 return getOperand(0);
1758 static unsigned getAggregateOperandIndex() {
1759 return 0U; // get index for modifying correct operand
1762 ArrayRef<unsigned> getIndices() const {
1766 unsigned getNumIndices() const {
1767 return (unsigned)Indices.size();
1770 bool hasIndices() const {
1774 // Methods for support type inquiry through isa, cast, and dyn_cast:
1775 static inline bool classof(const ExtractValueInst *) { return true; }
1776 static inline bool classof(const Instruction *I) {
1777 return I->getOpcode() == Instruction::ExtractValue;
1779 static inline bool classof(const Value *V) {
1780 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1784 ExtractValueInst::ExtractValueInst(Value *Agg,
1785 ArrayRef<unsigned> Idxs,
1786 const Twine &NameStr,
1787 Instruction *InsertBefore)
1788 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
1789 ExtractValue, Agg, InsertBefore) {
1790 init(Idxs, NameStr);
1792 ExtractValueInst::ExtractValueInst(Value *Agg,
1793 ArrayRef<unsigned> Idxs,
1794 const Twine &NameStr,
1795 BasicBlock *InsertAtEnd)
1796 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
1797 ExtractValue, Agg, InsertAtEnd) {
1798 init(Idxs, NameStr);
1802 //===----------------------------------------------------------------------===//
1803 // InsertValueInst Class
1804 //===----------------------------------------------------------------------===//
1806 /// InsertValueInst - This instruction inserts a struct field of array element
1807 /// value into an aggregate value.
1809 class InsertValueInst : public Instruction {
1810 SmallVector<unsigned, 4> Indices;
1812 void *operator new(size_t, unsigned); // Do not implement
1813 InsertValueInst(const InsertValueInst &IVI);
1814 void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
1815 const Twine &NameStr);
1817 /// Constructors - Create a insertvalue instruction with a base aggregate
1818 /// value, a value to insert, and a list of indices. The first ctor can
1819 /// optionally insert before an existing instruction, the second appends
1820 /// the new instruction to the specified BasicBlock.
1821 inline InsertValueInst(Value *Agg, Value *Val,
1822 ArrayRef<unsigned> Idxs,
1823 const Twine &NameStr,
1824 Instruction *InsertBefore);
1825 inline InsertValueInst(Value *Agg, Value *Val,
1826 ArrayRef<unsigned> Idxs,
1827 const Twine &NameStr, BasicBlock *InsertAtEnd);
1829 /// Constructors - These two constructors are convenience methods because one
1830 /// and two index insertvalue instructions are so common.
1831 InsertValueInst(Value *Agg, Value *Val,
1832 unsigned Idx, const Twine &NameStr = "",
1833 Instruction *InsertBefore = 0);
1834 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1835 const Twine &NameStr, BasicBlock *InsertAtEnd);
1837 virtual InsertValueInst *clone_impl() const;
1839 // allocate space for exactly two operands
1840 void *operator new(size_t s) {
1841 return User::operator new(s, 2);
1844 static InsertValueInst *Create(Value *Agg, Value *Val,
1845 ArrayRef<unsigned> Idxs,
1846 const Twine &NameStr = "",
1847 Instruction *InsertBefore = 0) {
1848 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
1850 static InsertValueInst *Create(Value *Agg, Value *Val,
1851 ArrayRef<unsigned> Idxs,
1852 const Twine &NameStr,
1853 BasicBlock *InsertAtEnd) {
1854 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
1857 /// Transparently provide more efficient getOperand methods.
1858 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1860 typedef const unsigned* idx_iterator;
1861 inline idx_iterator idx_begin() const { return Indices.begin(); }
1862 inline idx_iterator idx_end() const { return Indices.end(); }
1864 Value *getAggregateOperand() {
1865 return getOperand(0);
1867 const Value *getAggregateOperand() const {
1868 return getOperand(0);
1870 static unsigned getAggregateOperandIndex() {
1871 return 0U; // get index for modifying correct operand
1874 Value *getInsertedValueOperand() {
1875 return getOperand(1);
1877 const Value *getInsertedValueOperand() const {
1878 return getOperand(1);
1880 static unsigned getInsertedValueOperandIndex() {
1881 return 1U; // get index for modifying correct operand
1884 ArrayRef<unsigned> getIndices() const {
1888 unsigned getNumIndices() const {
1889 return (unsigned)Indices.size();
1892 bool hasIndices() const {
1896 // Methods for support type inquiry through isa, cast, and dyn_cast:
1897 static inline bool classof(const InsertValueInst *) { return true; }
1898 static inline bool classof(const Instruction *I) {
1899 return I->getOpcode() == Instruction::InsertValue;
1901 static inline bool classof(const Value *V) {
1902 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1907 struct OperandTraits<InsertValueInst> :
1908 public FixedNumOperandTraits<InsertValueInst, 2> {
1911 InsertValueInst::InsertValueInst(Value *Agg,
1913 ArrayRef<unsigned> Idxs,
1914 const Twine &NameStr,
1915 Instruction *InsertBefore)
1916 : Instruction(Agg->getType(), InsertValue,
1917 OperandTraits<InsertValueInst>::op_begin(this),
1919 init(Agg, Val, Idxs, NameStr);
1921 InsertValueInst::InsertValueInst(Value *Agg,
1923 ArrayRef<unsigned> Idxs,
1924 const Twine &NameStr,
1925 BasicBlock *InsertAtEnd)
1926 : Instruction(Agg->getType(), InsertValue,
1927 OperandTraits<InsertValueInst>::op_begin(this),
1929 init(Agg, Val, Idxs, NameStr);
1932 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1934 //===----------------------------------------------------------------------===//
1936 //===----------------------------------------------------------------------===//
1938 // PHINode - The PHINode class is used to represent the magical mystical PHI
1939 // node, that can not exist in nature, but can be synthesized in a computer
1940 // scientist's overactive imagination.
1942 class PHINode : public Instruction {
1943 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1944 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1945 /// the number actually in use.
1946 unsigned ReservedSpace;
1947 PHINode(const PHINode &PN);
1948 // allocate space for exactly zero operands
1949 void *operator new(size_t s) {
1950 return User::operator new(s, 0);
1952 explicit PHINode(Type *Ty, unsigned NumReservedValues,
1953 const Twine &NameStr = "", Instruction *InsertBefore = 0)
1954 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1955 ReservedSpace(NumReservedValues) {
1957 OperandList = allocHungoffUses(ReservedSpace);
1960 PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
1961 BasicBlock *InsertAtEnd)
1962 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1963 ReservedSpace(NumReservedValues) {
1965 OperandList = allocHungoffUses(ReservedSpace);
1968 // allocHungoffUses - this is more complicated than the generic
1969 // User::allocHungoffUses, because we have to allocate Uses for the incoming
1970 // values and pointers to the incoming blocks, all in one allocation.
1971 Use *allocHungoffUses(unsigned) const;
1973 virtual PHINode *clone_impl() const;
1975 /// Constructors - NumReservedValues is a hint for the number of incoming
1976 /// edges that this phi node will have (use 0 if you really have no idea).
1977 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
1978 const Twine &NameStr = "",
1979 Instruction *InsertBefore = 0) {
1980 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
1982 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
1983 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1984 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
1988 /// Provide fast operand accessors
1989 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1991 // Block iterator interface. This provides access to the list of incoming
1992 // basic blocks, which parallels the list of incoming values.
1994 typedef BasicBlock **block_iterator;
1995 typedef BasicBlock * const *const_block_iterator;
1997 block_iterator block_begin() {
1999 reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2000 return reinterpret_cast<block_iterator>(ref + 1);
2003 const_block_iterator block_begin() const {
2004 const Use::UserRef *ref =
2005 reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2006 return reinterpret_cast<const_block_iterator>(ref + 1);
2009 block_iterator block_end() {
2010 return block_begin() + getNumOperands();
2013 const_block_iterator block_end() const {
2014 return block_begin() + getNumOperands();
2017 /// getNumIncomingValues - Return the number of incoming edges
2019 unsigned getNumIncomingValues() const { return getNumOperands(); }
2021 /// getIncomingValue - Return incoming value number x
2023 Value *getIncomingValue(unsigned i) const {
2024 return getOperand(i);
2026 void setIncomingValue(unsigned i, Value *V) {
2029 static unsigned getOperandNumForIncomingValue(unsigned i) {
2032 static unsigned getIncomingValueNumForOperand(unsigned i) {
2036 /// getIncomingBlock - Return incoming basic block number @p i.
2038 BasicBlock *getIncomingBlock(unsigned i) const {
2039 return block_begin()[i];
2042 /// getIncomingBlock - Return incoming basic block corresponding
2043 /// to an operand of the PHI.
2045 BasicBlock *getIncomingBlock(const Use &U) const {
2046 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2047 return getIncomingBlock(unsigned(&U - op_begin()));
2050 /// getIncomingBlock - Return incoming basic block corresponding
2051 /// to value use iterator.
2053 template <typename U>
2054 BasicBlock *getIncomingBlock(value_use_iterator<U> I) const {
2055 return getIncomingBlock(I.getUse());
2058 void setIncomingBlock(unsigned i, BasicBlock *BB) {
2059 block_begin()[i] = BB;
2062 /// addIncoming - Add an incoming value to the end of the PHI list
2064 void addIncoming(Value *V, BasicBlock *BB) {
2065 assert(V && "PHI node got a null value!");
2066 assert(BB && "PHI node got a null basic block!");
2067 assert(getType() == V->getType() &&
2068 "All operands to PHI node must be the same type as the PHI node!");
2069 if (NumOperands == ReservedSpace)
2070 growOperands(); // Get more space!
2071 // Initialize some new operands.
2073 setIncomingValue(NumOperands - 1, V);
2074 setIncomingBlock(NumOperands - 1, BB);
2077 /// removeIncomingValue - Remove an incoming value. This is useful if a
2078 /// predecessor basic block is deleted. The value removed is returned.
2080 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2081 /// is true), the PHI node is destroyed and any uses of it are replaced with
2082 /// dummy values. The only time there should be zero incoming values to a PHI
2083 /// node is when the block is dead, so this strategy is sound.
2085 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2087 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2088 int Idx = getBasicBlockIndex(BB);
2089 assert(Idx >= 0 && "Invalid basic block argument to remove!");
2090 return removeIncomingValue(Idx, DeletePHIIfEmpty);
2093 /// getBasicBlockIndex - Return the first index of the specified basic
2094 /// block in the value list for this PHI. Returns -1 if no instance.
2096 int getBasicBlockIndex(const BasicBlock *BB) const {
2097 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2098 if (block_begin()[i] == BB)
2103 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2104 int Idx = getBasicBlockIndex(BB);
2105 assert(Idx >= 0 && "Invalid basic block argument!");
2106 return getIncomingValue(Idx);
2109 /// hasConstantValue - If the specified PHI node always merges together the
2110 /// same value, return the value, otherwise return null.
2111 Value *hasConstantValue() const;
2113 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2114 static inline bool classof(const PHINode *) { return true; }
2115 static inline bool classof(const Instruction *I) {
2116 return I->getOpcode() == Instruction::PHI;
2118 static inline bool classof(const Value *V) {
2119 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2122 void growOperands();
2126 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2129 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2131 //===----------------------------------------------------------------------===//
2132 // LandingPadInst Class
2133 //===----------------------------------------------------------------------===//
2135 //===---------------------------------------------------------------------------
2136 /// LandingPadInst - The landingpad instruction holds all of the information
2137 /// necessary to generate correct exception handling. The landingpad instruction
2138 /// cannot be moved from the top of a landing pad block, which itself is
2139 /// accessible only from the 'unwind' edge of an invoke. This uses the
2140 /// SubclassData field in Value to store whether or not the landingpad is a
2143 class LandingPadInst : public Instruction {
2144 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2145 /// the number actually in use.
2146 unsigned ReservedSpace;
2147 LandingPadInst(const LandingPadInst &LP);
2149 enum ClauseType { Catch, Filter };
2151 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2152 // Allocate space for exactly zero operands.
2153 void *operator new(size_t s) {
2154 return User::operator new(s, 0);
2156 void growOperands(unsigned Size);
2157 void init(Value *PersFn, unsigned NumReservedValues, const Twine &NameStr);
2159 explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2160 unsigned NumReservedValues, const Twine &NameStr,
2161 Instruction *InsertBefore);
2162 explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2163 unsigned NumReservedValues, const Twine &NameStr,
2164 BasicBlock *InsertAtEnd);
2166 virtual LandingPadInst *clone_impl() const;
2168 /// Constructors - NumReservedClauses is a hint for the number of incoming
2169 /// clauses that this landingpad will have (use 0 if you really have no idea).
2170 static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2171 unsigned NumReservedClauses,
2172 const Twine &NameStr = "",
2173 Instruction *InsertBefore = 0);
2174 static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2175 unsigned NumReservedClauses,
2176 const Twine &NameStr, BasicBlock *InsertAtEnd);
2179 /// Provide fast operand accessors
2180 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2182 /// getPersonalityFn - Get the personality function associated with this
2184 Value *getPersonalityFn() const { return getOperand(0); }
2186 /// isCleanup - Return 'true' if this landingpad instruction is a
2187 /// cleanup. I.e., it should be run when unwinding even if its landing pad
2188 /// doesn't catch the exception.
2189 bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2191 /// setCleanup - Indicate that this landingpad instruction is a cleanup.
2192 void setCleanup(bool V) {
2193 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2197 /// addClause - Add a catch or filter clause to the landing pad.
2198 void addClause(Value *ClauseVal);
2200 /// getClause - Get the value of the clause at index Idx. Use isCatch/isFilter
2201 /// to determine what type of clause this is.
2202 Value *getClause(unsigned Idx) const { return OperandList[Idx + 1]; }
2204 /// isCatch - Return 'true' if the clause and index Idx is a catch clause.
2205 bool isCatch(unsigned Idx) const {
2206 return !isa<ArrayType>(OperandList[Idx + 1]->getType());
2209 /// isFilter - Return 'true' if the clause and index Idx is a filter clause.
2210 bool isFilter(unsigned Idx) const {
2211 return isa<ArrayType>(OperandList[Idx + 1]->getType());
2214 /// getNumClauses - Get the number of clauses for this landing pad.
2215 unsigned getNumClauses() const { return getNumOperands() - 1; }
2217 /// reserveClauses - Grow the size of the operand list to accomodate the new
2218 /// number of clauses.
2219 void reserveClauses(unsigned Size) { growOperands(Size); }
2221 // Methods for support type inquiry through isa, cast, and dyn_cast:
2222 static inline bool classof(const LandingPadInst *) { return true; }
2223 static inline bool classof(const Instruction *I) {
2224 return I->getOpcode() == Instruction::LandingPad;
2226 static inline bool classof(const Value *V) {
2227 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2232 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<2> {
2235 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2237 //===----------------------------------------------------------------------===//
2239 //===----------------------------------------------------------------------===//
2241 //===---------------------------------------------------------------------------
2242 /// ReturnInst - Return a value (possibly void), from a function. Execution
2243 /// does not continue in this function any longer.
2245 class ReturnInst : public TerminatorInst {
2246 ReturnInst(const ReturnInst &RI);
2249 // ReturnInst constructors:
2250 // ReturnInst() - 'ret void' instruction
2251 // ReturnInst( null) - 'ret void' instruction
2252 // ReturnInst(Value* X) - 'ret X' instruction
2253 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2254 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2255 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2256 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2258 // NOTE: If the Value* passed is of type void then the constructor behaves as
2259 // if it was passed NULL.
2260 explicit ReturnInst(LLVMContext &C, Value *retVal = 0,
2261 Instruction *InsertBefore = 0);
2262 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2263 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2265 virtual ReturnInst *clone_impl() const;
2267 static ReturnInst* Create(LLVMContext &C, Value *retVal = 0,
2268 Instruction *InsertBefore = 0) {
2269 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2271 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2272 BasicBlock *InsertAtEnd) {
2273 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2275 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2276 return new(0) ReturnInst(C, InsertAtEnd);
2278 virtual ~ReturnInst();
2280 /// Provide fast operand accessors
2281 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2283 /// Convenience accessor. Returns null if there is no return value.
2284 Value *getReturnValue() const {
2285 return getNumOperands() != 0 ? getOperand(0) : 0;
2288 unsigned getNumSuccessors() const { return 0; }
2290 // Methods for support type inquiry through isa, cast, and dyn_cast:
2291 static inline bool classof(const ReturnInst *) { return true; }
2292 static inline bool classof(const Instruction *I) {
2293 return (I->getOpcode() == Instruction::Ret);
2295 static inline bool classof(const Value *V) {
2296 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2299 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2300 virtual unsigned getNumSuccessorsV() const;
2301 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2305 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2308 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2310 //===----------------------------------------------------------------------===//
2312 //===----------------------------------------------------------------------===//
2314 //===---------------------------------------------------------------------------
2315 /// BranchInst - Conditional or Unconditional Branch instruction.
2317 class BranchInst : public TerminatorInst {
2318 /// Ops list - Branches are strange. The operands are ordered:
2319 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2320 /// they don't have to check for cond/uncond branchness. These are mostly
2321 /// accessed relative from op_end().
2322 BranchInst(const BranchInst &BI);
2324 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2325 // BranchInst(BB *B) - 'br B'
2326 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2327 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2328 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2329 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2330 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2331 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2332 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2333 Instruction *InsertBefore = 0);
2334 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2335 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2336 BasicBlock *InsertAtEnd);
2338 virtual BranchInst *clone_impl() const;
2340 static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2341 return new(1) BranchInst(IfTrue, InsertBefore);
2343 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2344 Value *Cond, Instruction *InsertBefore = 0) {
2345 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2347 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2348 return new(1) BranchInst(IfTrue, InsertAtEnd);
2350 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2351 Value *Cond, BasicBlock *InsertAtEnd) {
2352 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2355 /// Transparently provide more efficient getOperand methods.
2356 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2358 bool isUnconditional() const { return getNumOperands() == 1; }
2359 bool isConditional() const { return getNumOperands() == 3; }
2361 Value *getCondition() const {
2362 assert(isConditional() && "Cannot get condition of an uncond branch!");
2366 void setCondition(Value *V) {
2367 assert(isConditional() && "Cannot set condition of unconditional branch!");
2371 unsigned getNumSuccessors() const { return 1+isConditional(); }
2373 BasicBlock *getSuccessor(unsigned i) const {
2374 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2375 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2378 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2379 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2380 *(&Op<-1>() - idx) = (Value*)NewSucc;
2383 /// \brief Swap the successors of this branch instruction.
2385 /// Swaps the successors of the branch instruction. This also swaps any
2386 /// branch weight metadata associated with the instruction so that it
2387 /// continues to map correctly to each operand.
2388 void swapSuccessors();
2390 // Methods for support type inquiry through isa, cast, and dyn_cast:
2391 static inline bool classof(const BranchInst *) { return true; }
2392 static inline bool classof(const Instruction *I) {
2393 return (I->getOpcode() == Instruction::Br);
2395 static inline bool classof(const Value *V) {
2396 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2399 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2400 virtual unsigned getNumSuccessorsV() const;
2401 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2405 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2408 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2410 //===----------------------------------------------------------------------===//
2412 //===----------------------------------------------------------------------===//
2414 //===---------------------------------------------------------------------------
2415 /// SwitchInst - Multiway switch
2417 class SwitchInst : public TerminatorInst {
2418 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2419 unsigned ReservedSpace;
2420 // Operand[0] = Value to switch on
2421 // Operand[1] = Default basic block destination
2422 // Operand[2n ] = Value to match
2423 // Operand[2n+1] = BasicBlock to go to on match
2424 SwitchInst(const SwitchInst &SI);
2425 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2426 void growOperands();
2427 // allocate space for exactly zero operands
2428 void *operator new(size_t s) {
2429 return User::operator new(s, 0);
2431 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2432 /// switch on and a default destination. The number of additional cases can
2433 /// be specified here to make memory allocation more efficient. This
2434 /// constructor can also autoinsert before another instruction.
2435 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2436 Instruction *InsertBefore);
2438 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2439 /// switch on and a default destination. The number of additional cases can
2440 /// be specified here to make memory allocation more efficient. This
2441 /// constructor also autoinserts at the end of the specified BasicBlock.
2442 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2443 BasicBlock *InsertAtEnd);
2445 virtual SwitchInst *clone_impl() const;
2447 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2448 unsigned NumCases, Instruction *InsertBefore = 0) {
2449 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2451 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2452 unsigned NumCases, BasicBlock *InsertAtEnd) {
2453 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2457 /// Provide fast operand accessors
2458 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2460 // Accessor Methods for Switch stmt
2461 Value *getCondition() const { return getOperand(0); }
2462 void setCondition(Value *V) { setOperand(0, V); }
2464 BasicBlock *getDefaultDest() const {
2465 return cast<BasicBlock>(getOperand(1));
2468 /// getNumCases - return the number of 'cases' in this switch instruction.
2469 /// Note that case #0 is always the default case.
2470 unsigned getNumCases() const {
2471 return getNumOperands()/2;
2474 /// getCaseValue - Return the specified case value. Note that case #0, the
2475 /// default destination, does not have a case value.
2476 ConstantInt *getCaseValue(unsigned i) {
2477 assert(i && i < getNumCases() && "Illegal case value to get!");
2478 return getSuccessorValue(i);
2481 /// getCaseValue - Return the specified case value. Note that case #0, the
2482 /// default destination, does not have a case value.
2483 const ConstantInt *getCaseValue(unsigned i) const {
2484 assert(i && i < getNumCases() && "Illegal case value to get!");
2485 return getSuccessorValue(i);
2488 /// findCaseValue - Search all of the case values for the specified constant.
2489 /// If it is explicitly handled, return the case number of it, otherwise
2490 /// return 0 to indicate that it is handled by the default handler.
2491 unsigned findCaseValue(const ConstantInt *C) const {
2492 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
2493 if (getCaseValue(i) == C)
2498 /// findCaseDest - Finds the unique case value for a given successor. Returns
2499 /// null if the successor is not found, not unique, or is the default case.
2500 ConstantInt *findCaseDest(BasicBlock *BB) {
2501 if (BB == getDefaultDest()) return NULL;
2503 ConstantInt *CI = NULL;
2504 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
2505 if (getSuccessor(i) == BB) {
2506 if (CI) return NULL; // Multiple cases lead to BB.
2507 else CI = getCaseValue(i);
2513 /// addCase - Add an entry to the switch instruction...
2515 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2517 /// removeCase - This method removes the specified successor from the switch
2518 /// instruction. Note that this cannot be used to remove the default
2519 /// destination (successor #0). Also note that this operation may reorder the
2520 /// remaining cases at index idx and above.
2522 void removeCase(unsigned idx);
2524 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2525 BasicBlock *getSuccessor(unsigned idx) const {
2526 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2527 return cast<BasicBlock>(getOperand(idx*2+1));
2529 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2530 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2531 setOperand(idx*2+1, (Value*)NewSucc);
2534 // getSuccessorValue - Return the value associated with the specified
2536 ConstantInt *getSuccessorValue(unsigned idx) const {
2537 assert(idx < getNumSuccessors() && "Successor # out of range!");
2538 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
2541 // setSuccessorValue - Updates the value associated with the specified
2543 void setSuccessorValue(unsigned idx, ConstantInt* SuccessorValue) {
2544 assert(idx < getNumSuccessors() && "Successor # out of range!");
2545 setOperand(idx*2, reinterpret_cast<Value*>(SuccessorValue));
2548 // Methods for support type inquiry through isa, cast, and dyn_cast:
2549 static inline bool classof(const SwitchInst *) { return true; }
2550 static inline bool classof(const Instruction *I) {
2551 return I->getOpcode() == Instruction::Switch;
2553 static inline bool classof(const Value *V) {
2554 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2557 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2558 virtual unsigned getNumSuccessorsV() const;
2559 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2563 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2566 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2569 //===----------------------------------------------------------------------===//
2570 // IndirectBrInst Class
2571 //===----------------------------------------------------------------------===//
2573 //===---------------------------------------------------------------------------
2574 /// IndirectBrInst - Indirect Branch Instruction.
2576 class IndirectBrInst : public TerminatorInst {
2577 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2578 unsigned ReservedSpace;
2579 // Operand[0] = Value to switch on
2580 // Operand[1] = Default basic block destination
2581 // Operand[2n ] = Value to match
2582 // Operand[2n+1] = BasicBlock to go to on match
2583 IndirectBrInst(const IndirectBrInst &IBI);
2584 void init(Value *Address, unsigned NumDests);
2585 void growOperands();
2586 // allocate space for exactly zero operands
2587 void *operator new(size_t s) {
2588 return User::operator new(s, 0);
2590 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2591 /// Address to jump to. The number of expected destinations can be specified
2592 /// here to make memory allocation more efficient. This constructor can also
2593 /// autoinsert before another instruction.
2594 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
2596 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2597 /// Address to jump to. The number of expected destinations can be specified
2598 /// here to make memory allocation more efficient. This constructor also
2599 /// autoinserts at the end of the specified BasicBlock.
2600 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
2602 virtual IndirectBrInst *clone_impl() const;
2604 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2605 Instruction *InsertBefore = 0) {
2606 return new IndirectBrInst(Address, NumDests, InsertBefore);
2608 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2609 BasicBlock *InsertAtEnd) {
2610 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
2614 /// Provide fast operand accessors.
2615 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2617 // Accessor Methods for IndirectBrInst instruction.
2618 Value *getAddress() { return getOperand(0); }
2619 const Value *getAddress() const { return getOperand(0); }
2620 void setAddress(Value *V) { setOperand(0, V); }
2623 /// getNumDestinations - return the number of possible destinations in this
2624 /// indirectbr instruction.
2625 unsigned getNumDestinations() const { return getNumOperands()-1; }
2627 /// getDestination - Return the specified destination.
2628 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
2629 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
2631 /// addDestination - Add a destination.
2633 void addDestination(BasicBlock *Dest);
2635 /// removeDestination - This method removes the specified successor from the
2636 /// indirectbr instruction.
2637 void removeDestination(unsigned i);
2639 unsigned getNumSuccessors() const { return getNumOperands()-1; }
2640 BasicBlock *getSuccessor(unsigned i) const {
2641 return cast<BasicBlock>(getOperand(i+1));
2643 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
2644 setOperand(i+1, (Value*)NewSucc);
2647 // Methods for support type inquiry through isa, cast, and dyn_cast:
2648 static inline bool classof(const IndirectBrInst *) { return true; }
2649 static inline bool classof(const Instruction *I) {
2650 return I->getOpcode() == Instruction::IndirectBr;
2652 static inline bool classof(const Value *V) {
2653 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2656 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2657 virtual unsigned getNumSuccessorsV() const;
2658 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2662 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
2665 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
2668 //===----------------------------------------------------------------------===//
2670 //===----------------------------------------------------------------------===//
2672 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
2673 /// calling convention of the call.
2675 class InvokeInst : public TerminatorInst {
2676 AttrListPtr AttributeList;
2677 InvokeInst(const InvokeInst &BI);
2678 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2679 ArrayRef<Value *> Args, const Twine &NameStr);
2681 /// Construct an InvokeInst given a range of arguments.
2683 /// @brief Construct an InvokeInst from a range of arguments
2684 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2685 ArrayRef<Value *> Args, unsigned Values,
2686 const Twine &NameStr, Instruction *InsertBefore);
2688 /// Construct an InvokeInst given a range of arguments.
2690 /// @brief Construct an InvokeInst from a range of arguments
2691 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2692 ArrayRef<Value *> Args, unsigned Values,
2693 const Twine &NameStr, BasicBlock *InsertAtEnd);
2695 virtual InvokeInst *clone_impl() const;
2697 static InvokeInst *Create(Value *Func,
2698 BasicBlock *IfNormal, BasicBlock *IfException,
2699 ArrayRef<Value *> Args, const Twine &NameStr = "",
2700 Instruction *InsertBefore = 0) {
2701 unsigned Values = unsigned(Args.size()) + 3;
2702 return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
2703 Values, NameStr, InsertBefore);
2705 static InvokeInst *Create(Value *Func,
2706 BasicBlock *IfNormal, BasicBlock *IfException,
2707 ArrayRef<Value *> Args, const Twine &NameStr,
2708 BasicBlock *InsertAtEnd) {
2709 unsigned Values = unsigned(Args.size()) + 3;
2710 return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
2711 Values, NameStr, InsertAtEnd);
2714 /// Provide fast operand accessors
2715 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2717 /// getNumArgOperands - Return the number of invoke arguments.
2719 unsigned getNumArgOperands() const { return getNumOperands() - 3; }
2721 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
2723 Value *getArgOperand(unsigned i) const { return getOperand(i); }
2724 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
2726 /// getCallingConv/setCallingConv - Get or set the calling convention of this
2728 CallingConv::ID getCallingConv() const {
2729 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
2731 void setCallingConv(CallingConv::ID CC) {
2732 setInstructionSubclassData(static_cast<unsigned>(CC));
2735 /// getAttributes - Return the parameter attributes for this invoke.
2737 const AttrListPtr &getAttributes() const { return AttributeList; }
2739 /// setAttributes - Set the parameter attributes for this invoke.
2741 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
2743 /// addAttribute - adds the attribute to the list of attributes.
2744 void addAttribute(unsigned i, Attributes attr);
2746 /// removeAttribute - removes the attribute from the list of attributes.
2747 void removeAttribute(unsigned i, Attributes attr);
2749 /// @brief Determine whether the call or the callee has the given attribute.
2750 bool paramHasAttr(unsigned i, Attributes attr) const;
2752 /// @brief Extract the alignment for a call or parameter (0=unknown).
2753 unsigned getParamAlignment(unsigned i) const {
2754 return AttributeList.getParamAlignment(i);
2757 /// @brief Return true if the call should not be inlined.
2758 bool isNoInline() const { return paramHasAttr(~0, Attribute::NoInline); }
2759 void setIsNoInline(bool Value = true) {
2760 if (Value) addAttribute(~0, Attribute::NoInline);
2761 else removeAttribute(~0, Attribute::NoInline);
2764 /// @brief Determine if the call does not access memory.
2765 bool doesNotAccessMemory() const {
2766 return paramHasAttr(~0, Attribute::ReadNone);
2768 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
2769 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
2770 else removeAttribute(~0, Attribute::ReadNone);
2773 /// @brief Determine if the call does not access or only reads memory.
2774 bool onlyReadsMemory() const {
2775 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
2777 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
2778 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
2779 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
2782 /// @brief Determine if the call cannot return.
2783 bool doesNotReturn() const { return paramHasAttr(~0, Attribute::NoReturn); }
2784 void setDoesNotReturn(bool DoesNotReturn = true) {
2785 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
2786 else removeAttribute(~0, Attribute::NoReturn);
2789 /// @brief Determine if the call cannot unwind.
2790 bool doesNotThrow() const { return paramHasAttr(~0, Attribute::NoUnwind); }
2791 void setDoesNotThrow(bool DoesNotThrow = true) {
2792 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
2793 else removeAttribute(~0, Attribute::NoUnwind);
2796 /// @brief Determine if the call returns a structure through first
2797 /// pointer argument.
2798 bool hasStructRetAttr() const {
2799 // Be friendly and also check the callee.
2800 return paramHasAttr(1, Attribute::StructRet);
2803 /// @brief Determine if any call argument is an aggregate passed by value.
2804 bool hasByValArgument() const {
2805 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
2808 /// getCalledFunction - Return the function called, or null if this is an
2809 /// indirect function invocation.
2811 Function *getCalledFunction() const {
2812 return dyn_cast<Function>(Op<-3>());
2815 /// getCalledValue - Get a pointer to the function that is invoked by this
2817 const Value *getCalledValue() const { return Op<-3>(); }
2818 Value *getCalledValue() { return Op<-3>(); }
2820 /// setCalledFunction - Set the function called.
2821 void setCalledFunction(Value* Fn) {
2825 // get*Dest - Return the destination basic blocks...
2826 BasicBlock *getNormalDest() const {
2827 return cast<BasicBlock>(Op<-2>());
2829 BasicBlock *getUnwindDest() const {
2830 return cast<BasicBlock>(Op<-1>());
2832 void setNormalDest(BasicBlock *B) {
2833 Op<-2>() = reinterpret_cast<Value*>(B);
2835 void setUnwindDest(BasicBlock *B) {
2836 Op<-1>() = reinterpret_cast<Value*>(B);
2839 /// getLandingPadInst - Get the landingpad instruction from the landing pad
2840 /// block (the unwind destination).
2841 LandingPadInst *getLandingPadInst() const;
2843 BasicBlock *getSuccessor(unsigned i) const {
2844 assert(i < 2 && "Successor # out of range for invoke!");
2845 return i == 0 ? getNormalDest() : getUnwindDest();
2848 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2849 assert(idx < 2 && "Successor # out of range for invoke!");
2850 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
2853 unsigned getNumSuccessors() const { return 2; }
2855 // Methods for support type inquiry through isa, cast, and dyn_cast:
2856 static inline bool classof(const InvokeInst *) { return true; }
2857 static inline bool classof(const Instruction *I) {
2858 return (I->getOpcode() == Instruction::Invoke);
2860 static inline bool classof(const Value *V) {
2861 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2865 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2866 virtual unsigned getNumSuccessorsV() const;
2867 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2869 // Shadow Instruction::setInstructionSubclassData with a private forwarding
2870 // method so that subclasses cannot accidentally use it.
2871 void setInstructionSubclassData(unsigned short D) {
2872 Instruction::setInstructionSubclassData(D);
2877 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
2880 InvokeInst::InvokeInst(Value *Func,
2881 BasicBlock *IfNormal, BasicBlock *IfException,
2882 ArrayRef<Value *> Args, unsigned Values,
2883 const Twine &NameStr, Instruction *InsertBefore)
2884 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2885 ->getElementType())->getReturnType(),
2886 Instruction::Invoke,
2887 OperandTraits<InvokeInst>::op_end(this) - Values,
2888 Values, InsertBefore) {
2889 init(Func, IfNormal, IfException, Args, NameStr);
2891 InvokeInst::InvokeInst(Value *Func,
2892 BasicBlock *IfNormal, BasicBlock *IfException,
2893 ArrayRef<Value *> Args, unsigned Values,
2894 const Twine &NameStr, BasicBlock *InsertAtEnd)
2895 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2896 ->getElementType())->getReturnType(),
2897 Instruction::Invoke,
2898 OperandTraits<InvokeInst>::op_end(this) - Values,
2899 Values, InsertAtEnd) {
2900 init(Func, IfNormal, IfException, Args, NameStr);
2903 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
2905 //===----------------------------------------------------------------------===//
2907 //===----------------------------------------------------------------------===//
2909 //===---------------------------------------------------------------------------
2910 /// UnwindInst - Immediately exit the current function, unwinding the stack
2911 /// until an invoke instruction is found.
2913 class UnwindInst : public TerminatorInst {
2914 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2916 virtual UnwindInst *clone_impl() const;
2918 // allocate space for exactly zero operands
2919 void *operator new(size_t s) {
2920 return User::operator new(s, 0);
2922 explicit UnwindInst(LLVMContext &C, Instruction *InsertBefore = 0);
2923 explicit UnwindInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2925 unsigned getNumSuccessors() const { return 0; }
2927 // Methods for support type inquiry through isa, cast, and dyn_cast:
2928 static inline bool classof(const UnwindInst *) { return true; }
2929 static inline bool classof(const Instruction *I) {
2930 return I->getOpcode() == Instruction::Unwind;
2932 static inline bool classof(const Value *V) {
2933 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2936 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2937 virtual unsigned getNumSuccessorsV() const;
2938 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2941 //===----------------------------------------------------------------------===//
2943 //===----------------------------------------------------------------------===//
2945 //===---------------------------------------------------------------------------
2946 /// ResumeInst - Resume the propagation of an exception.
2948 class ResumeInst : public TerminatorInst {
2949 ResumeInst(const ResumeInst &RI);
2951 explicit ResumeInst(Value *Exn, Instruction *InsertBefore=0);
2952 ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
2954 virtual ResumeInst *clone_impl() const;
2956 static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = 0) {
2957 return new(1) ResumeInst(Exn, InsertBefore);
2959 static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
2960 return new(1) ResumeInst(Exn, InsertAtEnd);
2963 /// Provide fast operand accessors
2964 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2966 /// Convenience accessor.
2967 Value *getValue() const { return Op<0>(); }
2969 unsigned getNumSuccessors() const { return 0; }
2971 // Methods for support type inquiry through isa, cast, and dyn_cast:
2972 static inline bool classof(const ResumeInst *) { return true; }
2973 static inline bool classof(const Instruction *I) {
2974 return I->getOpcode() == Instruction::Resume;
2976 static inline bool classof(const Value *V) {
2977 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2980 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2981 virtual unsigned getNumSuccessorsV() const;
2982 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2986 struct OperandTraits<ResumeInst> :
2987 public FixedNumOperandTraits<ResumeInst, 1> {
2990 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
2992 //===----------------------------------------------------------------------===//
2993 // UnreachableInst Class
2994 //===----------------------------------------------------------------------===//
2996 //===---------------------------------------------------------------------------
2997 /// UnreachableInst - This function has undefined behavior. In particular, the
2998 /// presence of this instruction indicates some higher level knowledge that the
2999 /// end of the block cannot be reached.
3001 class UnreachableInst : public TerminatorInst {
3002 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
3004 virtual UnreachableInst *clone_impl() const;
3007 // allocate space for exactly zero operands
3008 void *operator new(size_t s) {
3009 return User::operator new(s, 0);
3011 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = 0);
3012 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
3014 unsigned getNumSuccessors() const { return 0; }
3016 // Methods for support type inquiry through isa, cast, and dyn_cast:
3017 static inline bool classof(const UnreachableInst *) { return true; }
3018 static inline bool classof(const Instruction *I) {
3019 return I->getOpcode() == Instruction::Unreachable;
3021 static inline bool classof(const Value *V) {
3022 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3025 virtual BasicBlock *getSuccessorV(unsigned idx) const;
3026 virtual unsigned getNumSuccessorsV() const;
3027 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3030 //===----------------------------------------------------------------------===//
3032 //===----------------------------------------------------------------------===//
3034 /// @brief This class represents a truncation of integer types.
3035 class TruncInst : public CastInst {
3037 /// @brief Clone an identical TruncInst
3038 virtual TruncInst *clone_impl() const;
3041 /// @brief Constructor with insert-before-instruction semantics
3043 Value *S, ///< The value to be truncated
3044 Type *Ty, ///< The (smaller) type to truncate to
3045 const Twine &NameStr = "", ///< A name for the new instruction
3046 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3049 /// @brief Constructor with insert-at-end-of-block semantics
3051 Value *S, ///< The value to be truncated
3052 Type *Ty, ///< The (smaller) type to truncate to
3053 const Twine &NameStr, ///< A name for the new instruction
3054 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3057 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3058 static inline bool classof(const TruncInst *) { return true; }
3059 static inline bool classof(const Instruction *I) {
3060 return I->getOpcode() == Trunc;
3062 static inline bool classof(const Value *V) {
3063 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3067 //===----------------------------------------------------------------------===//
3069 //===----------------------------------------------------------------------===//
3071 /// @brief This class represents zero extension of integer types.
3072 class ZExtInst : public CastInst {
3074 /// @brief Clone an identical ZExtInst
3075 virtual ZExtInst *clone_impl() const;
3078 /// @brief Constructor with insert-before-instruction semantics
3080 Value *S, ///< The value to be zero extended
3081 Type *Ty, ///< The type to zero extend to
3082 const Twine &NameStr = "", ///< A name for the new instruction
3083 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3086 /// @brief Constructor with insert-at-end semantics.
3088 Value *S, ///< The value to be zero extended
3089 Type *Ty, ///< The type to zero extend to
3090 const Twine &NameStr, ///< A name for the new instruction
3091 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3094 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3095 static inline bool classof(const ZExtInst *) { return true; }
3096 static inline bool classof(const Instruction *I) {
3097 return I->getOpcode() == ZExt;
3099 static inline bool classof(const Value *V) {
3100 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3104 //===----------------------------------------------------------------------===//
3106 //===----------------------------------------------------------------------===//
3108 /// @brief This class represents a sign extension of integer types.
3109 class SExtInst : public CastInst {
3111 /// @brief Clone an identical SExtInst
3112 virtual SExtInst *clone_impl() const;
3115 /// @brief Constructor with insert-before-instruction semantics
3117 Value *S, ///< The value to be sign extended
3118 Type *Ty, ///< The type to sign extend to
3119 const Twine &NameStr = "", ///< A name for the new instruction
3120 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3123 /// @brief Constructor with insert-at-end-of-block semantics
3125 Value *S, ///< The value to be sign extended
3126 Type *Ty, ///< The type to sign extend to
3127 const Twine &NameStr, ///< A name for the new instruction
3128 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3131 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3132 static inline bool classof(const SExtInst *) { return true; }
3133 static inline bool classof(const Instruction *I) {
3134 return I->getOpcode() == SExt;
3136 static inline bool classof(const Value *V) {
3137 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3141 //===----------------------------------------------------------------------===//
3142 // FPTruncInst Class
3143 //===----------------------------------------------------------------------===//
3145 /// @brief This class represents a truncation of floating point types.
3146 class FPTruncInst : public CastInst {
3148 /// @brief Clone an identical FPTruncInst
3149 virtual FPTruncInst *clone_impl() const;
3152 /// @brief Constructor with insert-before-instruction semantics
3154 Value *S, ///< The value to be truncated
3155 Type *Ty, ///< The type to truncate to
3156 const Twine &NameStr = "", ///< A name for the new instruction
3157 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3160 /// @brief Constructor with insert-before-instruction semantics
3162 Value *S, ///< The value to be truncated
3163 Type *Ty, ///< The type to truncate to
3164 const Twine &NameStr, ///< A name for the new instruction
3165 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3168 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3169 static inline bool classof(const FPTruncInst *) { return true; }
3170 static inline bool classof(const Instruction *I) {
3171 return I->getOpcode() == FPTrunc;
3173 static inline bool classof(const Value *V) {
3174 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3178 //===----------------------------------------------------------------------===//
3180 //===----------------------------------------------------------------------===//
3182 /// @brief This class represents an extension of floating point types.
3183 class FPExtInst : public CastInst {
3185 /// @brief Clone an identical FPExtInst
3186 virtual FPExtInst *clone_impl() const;
3189 /// @brief Constructor with insert-before-instruction semantics
3191 Value *S, ///< The value to be extended
3192 Type *Ty, ///< The type to extend to
3193 const Twine &NameStr = "", ///< A name for the new instruction
3194 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3197 /// @brief Constructor with insert-at-end-of-block semantics
3199 Value *S, ///< The value to be extended
3200 Type *Ty, ///< The type to extend to
3201 const Twine &NameStr, ///< A name for the new instruction
3202 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3205 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3206 static inline bool classof(const FPExtInst *) { return true; }
3207 static inline bool classof(const Instruction *I) {
3208 return I->getOpcode() == FPExt;
3210 static inline bool classof(const Value *V) {
3211 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3215 //===----------------------------------------------------------------------===//
3217 //===----------------------------------------------------------------------===//
3219 /// @brief This class represents a cast unsigned integer to floating point.
3220 class UIToFPInst : public CastInst {
3222 /// @brief Clone an identical UIToFPInst
3223 virtual UIToFPInst *clone_impl() const;
3226 /// @brief Constructor with insert-before-instruction semantics
3228 Value *S, ///< The value to be converted
3229 Type *Ty, ///< The type to convert to
3230 const Twine &NameStr = "", ///< A name for the new instruction
3231 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3234 /// @brief Constructor with insert-at-end-of-block semantics
3236 Value *S, ///< The value to be converted
3237 Type *Ty, ///< The type to convert to
3238 const Twine &NameStr, ///< A name for the new instruction
3239 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3242 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3243 static inline bool classof(const UIToFPInst *) { return true; }
3244 static inline bool classof(const Instruction *I) {
3245 return I->getOpcode() == UIToFP;
3247 static inline bool classof(const Value *V) {
3248 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3252 //===----------------------------------------------------------------------===//
3254 //===----------------------------------------------------------------------===//
3256 /// @brief This class represents a cast from signed integer to floating point.
3257 class SIToFPInst : public CastInst {
3259 /// @brief Clone an identical SIToFPInst
3260 virtual SIToFPInst *clone_impl() const;
3263 /// @brief Constructor with insert-before-instruction semantics
3265 Value *S, ///< The value to be converted
3266 Type *Ty, ///< The type to convert to
3267 const Twine &NameStr = "", ///< A name for the new instruction
3268 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3271 /// @brief Constructor with insert-at-end-of-block semantics
3273 Value *S, ///< The value to be converted
3274 Type *Ty, ///< The type to convert to
3275 const Twine &NameStr, ///< A name for the new instruction
3276 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3279 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3280 static inline bool classof(const SIToFPInst *) { return true; }
3281 static inline bool classof(const Instruction *I) {
3282 return I->getOpcode() == SIToFP;
3284 static inline bool classof(const Value *V) {
3285 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3289 //===----------------------------------------------------------------------===//
3291 //===----------------------------------------------------------------------===//
3293 /// @brief This class represents a cast from floating point to unsigned integer
3294 class FPToUIInst : public CastInst {
3296 /// @brief Clone an identical FPToUIInst
3297 virtual FPToUIInst *clone_impl() const;
3300 /// @brief Constructor with insert-before-instruction semantics
3302 Value *S, ///< The value to be converted
3303 Type *Ty, ///< The type to convert to
3304 const Twine &NameStr = "", ///< A name for the new instruction
3305 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3308 /// @brief Constructor with insert-at-end-of-block semantics
3310 Value *S, ///< The value to be converted
3311 Type *Ty, ///< The type to convert to
3312 const Twine &NameStr, ///< A name for the new instruction
3313 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
3316 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3317 static inline bool classof(const FPToUIInst *) { return true; }
3318 static inline bool classof(const Instruction *I) {
3319 return I->getOpcode() == FPToUI;
3321 static inline bool classof(const Value *V) {
3322 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3326 //===----------------------------------------------------------------------===//
3328 //===----------------------------------------------------------------------===//
3330 /// @brief This class represents a cast from floating point to signed integer.
3331 class FPToSIInst : public CastInst {
3333 /// @brief Clone an identical FPToSIInst
3334 virtual FPToSIInst *clone_impl() const;
3337 /// @brief Constructor with insert-before-instruction semantics
3339 Value *S, ///< The value to be converted
3340 Type *Ty, ///< The type to convert to
3341 const Twine &NameStr = "", ///< A name for the new instruction
3342 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3345 /// @brief Constructor with insert-at-end-of-block semantics
3347 Value *S, ///< The value to be converted
3348 Type *Ty, ///< The type to convert to
3349 const Twine &NameStr, ///< A name for the new instruction
3350 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3353 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3354 static inline bool classof(const FPToSIInst *) { return true; }
3355 static inline bool classof(const Instruction *I) {
3356 return I->getOpcode() == FPToSI;
3358 static inline bool classof(const Value *V) {
3359 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3363 //===----------------------------------------------------------------------===//
3364 // IntToPtrInst Class
3365 //===----------------------------------------------------------------------===//
3367 /// @brief This class represents a cast from an integer to a pointer.
3368 class IntToPtrInst : public CastInst {
3370 /// @brief Constructor with insert-before-instruction semantics
3372 Value *S, ///< The value to be converted
3373 Type *Ty, ///< The type to convert to
3374 const Twine &NameStr = "", ///< A name for the new instruction
3375 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3378 /// @brief Constructor with insert-at-end-of-block semantics
3380 Value *S, ///< The value to be converted
3381 Type *Ty, ///< The type to convert to
3382 const Twine &NameStr, ///< A name for the new instruction
3383 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3386 /// @brief Clone an identical IntToPtrInst
3387 virtual IntToPtrInst *clone_impl() const;
3389 // Methods for support type inquiry through isa, cast, and dyn_cast:
3390 static inline bool classof(const IntToPtrInst *) { return true; }
3391 static inline bool classof(const Instruction *I) {
3392 return I->getOpcode() == IntToPtr;
3394 static inline bool classof(const Value *V) {
3395 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3399 //===----------------------------------------------------------------------===//
3400 // PtrToIntInst Class
3401 //===----------------------------------------------------------------------===//
3403 /// @brief This class represents a cast from a pointer to an integer
3404 class PtrToIntInst : public CastInst {
3406 /// @brief Clone an identical PtrToIntInst
3407 virtual PtrToIntInst *clone_impl() const;
3410 /// @brief Constructor with insert-before-instruction semantics
3412 Value *S, ///< The value to be converted
3413 Type *Ty, ///< The type to convert to
3414 const Twine &NameStr = "", ///< A name for the new instruction
3415 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3418 /// @brief Constructor with insert-at-end-of-block semantics
3420 Value *S, ///< The value to be converted
3421 Type *Ty, ///< The type to convert to
3422 const Twine &NameStr, ///< A name for the new instruction
3423 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3426 // Methods for support type inquiry through isa, cast, and dyn_cast:
3427 static inline bool classof(const PtrToIntInst *) { return true; }
3428 static inline bool classof(const Instruction *I) {
3429 return I->getOpcode() == PtrToInt;
3431 static inline bool classof(const Value *V) {
3432 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3436 //===----------------------------------------------------------------------===//
3437 // BitCastInst Class
3438 //===----------------------------------------------------------------------===//
3440 /// @brief This class represents a no-op cast from one type to another.
3441 class BitCastInst : public CastInst {
3443 /// @brief Clone an identical BitCastInst
3444 virtual BitCastInst *clone_impl() const;
3447 /// @brief Constructor with insert-before-instruction semantics
3449 Value *S, ///< The value to be casted
3450 Type *Ty, ///< The type to casted to
3451 const Twine &NameStr = "", ///< A name for the new instruction
3452 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3455 /// @brief Constructor with insert-at-end-of-block semantics
3457 Value *S, ///< The value to be casted
3458 Type *Ty, ///< The type to casted to
3459 const Twine &NameStr, ///< A name for the new instruction
3460 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3463 // Methods for support type inquiry through isa, cast, and dyn_cast:
3464 static inline bool classof(const BitCastInst *) { return true; }
3465 static inline bool classof(const Instruction *I) {
3466 return I->getOpcode() == BitCast;
3468 static inline bool classof(const Value *V) {
3469 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3473 } // End llvm namespace