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/Support/IntegersSubset.h"
24 #include "llvm/Support/IntegersSubsetMapping.h"
25 #include "llvm/ADT/ArrayRef.h"
26 #include "llvm/ADT/SmallVector.h"
27 #include "llvm/Support/ErrorHandling.h"
41 // Consume = 3, // Not specified yet.
45 SequentiallyConsistent = 7
48 enum SynchronizationScope {
53 //===----------------------------------------------------------------------===//
55 //===----------------------------------------------------------------------===//
57 /// AllocaInst - an instruction to allocate memory on the stack
59 class AllocaInst : public UnaryInstruction {
61 virtual AllocaInst *clone_impl() const;
63 explicit AllocaInst(Type *Ty, Value *ArraySize = 0,
64 const Twine &Name = "", Instruction *InsertBefore = 0);
65 AllocaInst(Type *Ty, Value *ArraySize,
66 const Twine &Name, BasicBlock *InsertAtEnd);
68 AllocaInst(Type *Ty, const Twine &Name, Instruction *InsertBefore = 0);
69 AllocaInst(Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd);
71 AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
72 const Twine &Name = "", Instruction *InsertBefore = 0);
73 AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
74 const Twine &Name, BasicBlock *InsertAtEnd);
76 // Out of line virtual method, so the vtable, etc. has a home.
77 virtual ~AllocaInst();
79 /// isArrayAllocation - Return true if there is an allocation size parameter
80 /// to the allocation instruction that is not 1.
82 bool isArrayAllocation() const;
84 /// getArraySize - Get the number of elements allocated. For a simple
85 /// allocation of a single element, this will return a constant 1 value.
87 const Value *getArraySize() const { return getOperand(0); }
88 Value *getArraySize() { return getOperand(0); }
90 /// getType - Overload to return most specific pointer type
92 PointerType *getType() const {
93 return reinterpret_cast<PointerType*>(Instruction::getType());
96 /// getAllocatedType - Return the type that is being allocated by the
99 Type *getAllocatedType() const;
101 /// getAlignment - Return the alignment of the memory that is being allocated
102 /// by the instruction.
104 unsigned getAlignment() const {
105 return (1u << getSubclassDataFromInstruction()) >> 1;
107 void setAlignment(unsigned Align);
109 /// isStaticAlloca - Return true if this alloca is in the entry block of the
110 /// function and is a constant size. If so, the code generator will fold it
111 /// into the prolog/epilog code, so it is basically free.
112 bool isStaticAlloca() const;
114 // Methods for support type inquiry through isa, cast, and dyn_cast:
115 static inline bool classof(const AllocaInst *) { return true; }
116 static inline bool classof(const Instruction *I) {
117 return (I->getOpcode() == Instruction::Alloca);
119 static inline bool classof(const Value *V) {
120 return isa<Instruction>(V) && classof(cast<Instruction>(V));
123 // Shadow Instruction::setInstructionSubclassData with a private forwarding
124 // method so that subclasses cannot accidentally use it.
125 void setInstructionSubclassData(unsigned short D) {
126 Instruction::setInstructionSubclassData(D);
131 //===----------------------------------------------------------------------===//
133 //===----------------------------------------------------------------------===//
135 /// LoadInst - an instruction for reading from memory. This uses the
136 /// SubclassData field in Value to store whether or not the load is volatile.
138 class LoadInst : public UnaryInstruction {
141 virtual LoadInst *clone_impl() const;
143 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
144 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
145 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
146 Instruction *InsertBefore = 0);
147 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
148 BasicBlock *InsertAtEnd);
149 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
150 unsigned Align, Instruction *InsertBefore = 0);
151 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
152 unsigned Align, BasicBlock *InsertAtEnd);
153 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
154 unsigned Align, AtomicOrdering Order,
155 SynchronizationScope SynchScope = CrossThread,
156 Instruction *InsertBefore = 0);
157 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
158 unsigned Align, AtomicOrdering Order,
159 SynchronizationScope SynchScope,
160 BasicBlock *InsertAtEnd);
162 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
163 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
164 explicit LoadInst(Value *Ptr, const char *NameStr = 0,
165 bool isVolatile = false, Instruction *InsertBefore = 0);
166 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
167 BasicBlock *InsertAtEnd);
169 /// isVolatile - Return true if this is a load from a volatile memory
172 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
174 /// setVolatile - Specify whether this is a volatile load or not.
176 void setVolatile(bool V) {
177 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
181 /// getAlignment - Return the alignment of the access that is being performed
183 unsigned getAlignment() const {
184 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
187 void setAlignment(unsigned Align);
189 /// Returns the ordering effect of this fence.
190 AtomicOrdering getOrdering() const {
191 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
194 /// Set the ordering constraint on this load. May not be Release or
196 void setOrdering(AtomicOrdering Ordering) {
197 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
201 SynchronizationScope getSynchScope() const {
202 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
205 /// Specify whether this load is ordered with respect to all
206 /// concurrently executing threads, or only with respect to signal handlers
207 /// executing in the same thread.
208 void setSynchScope(SynchronizationScope xthread) {
209 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
213 bool isAtomic() const { return getOrdering() != NotAtomic; }
214 void setAtomic(AtomicOrdering Ordering,
215 SynchronizationScope SynchScope = CrossThread) {
216 setOrdering(Ordering);
217 setSynchScope(SynchScope);
220 bool isSimple() const { return !isAtomic() && !isVolatile(); }
221 bool isUnordered() const {
222 return getOrdering() <= Unordered && !isVolatile();
225 Value *getPointerOperand() { return getOperand(0); }
226 const Value *getPointerOperand() const { return getOperand(0); }
227 static unsigned getPointerOperandIndex() { return 0U; }
229 unsigned getPointerAddressSpace() const {
230 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
234 // Methods for support type inquiry through isa, cast, and dyn_cast:
235 static inline bool classof(const LoadInst *) { return true; }
236 static inline bool classof(const Instruction *I) {
237 return I->getOpcode() == Instruction::Load;
239 static inline bool classof(const Value *V) {
240 return isa<Instruction>(V) && classof(cast<Instruction>(V));
243 // Shadow Instruction::setInstructionSubclassData with a private forwarding
244 // method so that subclasses cannot accidentally use it.
245 void setInstructionSubclassData(unsigned short D) {
246 Instruction::setInstructionSubclassData(D);
251 //===----------------------------------------------------------------------===//
253 //===----------------------------------------------------------------------===//
255 /// StoreInst - an instruction for storing to memory
257 class StoreInst : public Instruction {
258 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
261 virtual StoreInst *clone_impl() const;
263 // allocate space for exactly two operands
264 void *operator new(size_t s) {
265 return User::operator new(s, 2);
267 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
268 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
269 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
270 Instruction *InsertBefore = 0);
271 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
272 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
273 unsigned Align, Instruction *InsertBefore = 0);
274 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
275 unsigned Align, BasicBlock *InsertAtEnd);
276 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
277 unsigned Align, AtomicOrdering Order,
278 SynchronizationScope SynchScope = CrossThread,
279 Instruction *InsertBefore = 0);
280 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
281 unsigned Align, AtomicOrdering Order,
282 SynchronizationScope SynchScope,
283 BasicBlock *InsertAtEnd);
286 /// isVolatile - Return true if this is a store to a volatile memory
289 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
291 /// setVolatile - Specify whether this is a volatile store or not.
293 void setVolatile(bool V) {
294 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
298 /// Transparently provide more efficient getOperand methods.
299 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
301 /// getAlignment - Return the alignment of the access that is being performed
303 unsigned getAlignment() const {
304 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
307 void setAlignment(unsigned Align);
309 /// Returns the ordering effect of this store.
310 AtomicOrdering getOrdering() const {
311 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
314 /// Set the ordering constraint on this store. May not be Acquire or
316 void setOrdering(AtomicOrdering Ordering) {
317 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
321 SynchronizationScope getSynchScope() const {
322 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
325 /// Specify whether this store instruction is ordered with respect to all
326 /// concurrently executing threads, or only with respect to signal handlers
327 /// executing in the same thread.
328 void setSynchScope(SynchronizationScope xthread) {
329 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
333 bool isAtomic() const { return getOrdering() != NotAtomic; }
334 void setAtomic(AtomicOrdering Ordering,
335 SynchronizationScope SynchScope = CrossThread) {
336 setOrdering(Ordering);
337 setSynchScope(SynchScope);
340 bool isSimple() const { return !isAtomic() && !isVolatile(); }
341 bool isUnordered() const {
342 return getOrdering() <= Unordered && !isVolatile();
345 Value *getValueOperand() { return getOperand(0); }
346 const Value *getValueOperand() const { return getOperand(0); }
348 Value *getPointerOperand() { return getOperand(1); }
349 const Value *getPointerOperand() const { return getOperand(1); }
350 static unsigned getPointerOperandIndex() { return 1U; }
352 unsigned getPointerAddressSpace() const {
353 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
356 // Methods for support type inquiry through isa, cast, and dyn_cast:
357 static inline bool classof(const StoreInst *) { return true; }
358 static inline bool classof(const Instruction *I) {
359 return I->getOpcode() == Instruction::Store;
361 static inline bool classof(const Value *V) {
362 return isa<Instruction>(V) && classof(cast<Instruction>(V));
365 // Shadow Instruction::setInstructionSubclassData with a private forwarding
366 // method so that subclasses cannot accidentally use it.
367 void setInstructionSubclassData(unsigned short D) {
368 Instruction::setInstructionSubclassData(D);
373 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
376 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
378 //===----------------------------------------------------------------------===//
380 //===----------------------------------------------------------------------===//
382 /// FenceInst - an instruction for ordering other memory operations
384 class FenceInst : public Instruction {
385 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
386 void Init(AtomicOrdering Ordering, SynchronizationScope SynchScope);
388 virtual FenceInst *clone_impl() const;
390 // allocate space for exactly zero operands
391 void *operator new(size_t s) {
392 return User::operator new(s, 0);
395 // Ordering may only be Acquire, Release, AcquireRelease, or
396 // SequentiallyConsistent.
397 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
398 SynchronizationScope SynchScope = CrossThread,
399 Instruction *InsertBefore = 0);
400 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
401 SynchronizationScope SynchScope,
402 BasicBlock *InsertAtEnd);
404 /// Returns the ordering effect of this fence.
405 AtomicOrdering getOrdering() const {
406 return AtomicOrdering(getSubclassDataFromInstruction() >> 1);
409 /// Set the ordering constraint on this fence. May only be Acquire, Release,
410 /// AcquireRelease, or SequentiallyConsistent.
411 void setOrdering(AtomicOrdering Ordering) {
412 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
416 SynchronizationScope getSynchScope() const {
417 return SynchronizationScope(getSubclassDataFromInstruction() & 1);
420 /// Specify whether this fence orders other operations with respect to all
421 /// concurrently executing threads, or only with respect to signal handlers
422 /// executing in the same thread.
423 void setSynchScope(SynchronizationScope xthread) {
424 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
428 // Methods for support type inquiry through isa, cast, and dyn_cast:
429 static inline bool classof(const FenceInst *) { return true; }
430 static inline bool classof(const Instruction *I) {
431 return I->getOpcode() == Instruction::Fence;
433 static inline bool classof(const Value *V) {
434 return isa<Instruction>(V) && classof(cast<Instruction>(V));
437 // Shadow Instruction::setInstructionSubclassData with a private forwarding
438 // method so that subclasses cannot accidentally use it.
439 void setInstructionSubclassData(unsigned short D) {
440 Instruction::setInstructionSubclassData(D);
444 //===----------------------------------------------------------------------===//
445 // AtomicCmpXchgInst Class
446 //===----------------------------------------------------------------------===//
448 /// AtomicCmpXchgInst - an instruction that atomically checks whether a
449 /// specified value is in a memory location, and, if it is, stores a new value
450 /// there. Returns the value that was loaded.
452 class AtomicCmpXchgInst : public Instruction {
453 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
454 void Init(Value *Ptr, Value *Cmp, Value *NewVal,
455 AtomicOrdering Ordering, SynchronizationScope SynchScope);
457 virtual AtomicCmpXchgInst *clone_impl() const;
459 // allocate space for exactly three operands
460 void *operator new(size_t s) {
461 return User::operator new(s, 3);
463 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
464 AtomicOrdering Ordering, SynchronizationScope SynchScope,
465 Instruction *InsertBefore = 0);
466 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
467 AtomicOrdering Ordering, SynchronizationScope SynchScope,
468 BasicBlock *InsertAtEnd);
470 /// isVolatile - Return true if this is a cmpxchg from a volatile memory
473 bool isVolatile() const {
474 return getSubclassDataFromInstruction() & 1;
477 /// setVolatile - Specify whether this is a volatile cmpxchg.
479 void setVolatile(bool V) {
480 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
484 /// Transparently provide more efficient getOperand methods.
485 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
487 /// Set the ordering constraint on this cmpxchg.
488 void setOrdering(AtomicOrdering Ordering) {
489 assert(Ordering != NotAtomic &&
490 "CmpXchg instructions can only be atomic.");
491 setInstructionSubclassData((getSubclassDataFromInstruction() & 3) |
495 /// Specify whether this cmpxchg is atomic and orders other operations with
496 /// respect to all concurrently executing threads, or only with respect to
497 /// signal handlers executing in the same thread.
498 void setSynchScope(SynchronizationScope SynchScope) {
499 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
503 /// Returns the ordering constraint on this cmpxchg.
504 AtomicOrdering getOrdering() const {
505 return AtomicOrdering(getSubclassDataFromInstruction() >> 2);
508 /// Returns whether this cmpxchg is atomic between threads or only within a
510 SynchronizationScope getSynchScope() const {
511 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
514 Value *getPointerOperand() { return getOperand(0); }
515 const Value *getPointerOperand() const { return getOperand(0); }
516 static unsigned getPointerOperandIndex() { return 0U; }
518 Value *getCompareOperand() { return getOperand(1); }
519 const Value *getCompareOperand() const { return getOperand(1); }
521 Value *getNewValOperand() { return getOperand(2); }
522 const Value *getNewValOperand() const { return getOperand(2); }
524 unsigned getPointerAddressSpace() const {
525 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
528 // Methods for support type inquiry through isa, cast, and dyn_cast:
529 static inline bool classof(const AtomicCmpXchgInst *) { return true; }
530 static inline bool classof(const Instruction *I) {
531 return I->getOpcode() == Instruction::AtomicCmpXchg;
533 static inline bool classof(const Value *V) {
534 return isa<Instruction>(V) && classof(cast<Instruction>(V));
537 // Shadow Instruction::setInstructionSubclassData with a private forwarding
538 // method so that subclasses cannot accidentally use it.
539 void setInstructionSubclassData(unsigned short D) {
540 Instruction::setInstructionSubclassData(D);
545 struct OperandTraits<AtomicCmpXchgInst> :
546 public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
549 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)
551 //===----------------------------------------------------------------------===//
552 // AtomicRMWInst Class
553 //===----------------------------------------------------------------------===//
555 /// AtomicRMWInst - an instruction that atomically reads a memory location,
556 /// combines it with another value, and then stores the result back. Returns
559 class AtomicRMWInst : public Instruction {
560 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
562 virtual AtomicRMWInst *clone_impl() const;
564 /// This enumeration lists the possible modifications atomicrmw can make. In
565 /// the descriptions, 'p' is the pointer to the instruction's memory location,
566 /// 'old' is the initial value of *p, and 'v' is the other value passed to the
567 /// instruction. These instructions always return 'old'.
583 /// *p = old >signed v ? old : v
585 /// *p = old <signed v ? old : v
587 /// *p = old >unsigned v ? old : v
589 /// *p = old <unsigned v ? old : v
597 // allocate space for exactly two operands
598 void *operator new(size_t s) {
599 return User::operator new(s, 2);
601 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
602 AtomicOrdering Ordering, SynchronizationScope SynchScope,
603 Instruction *InsertBefore = 0);
604 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
605 AtomicOrdering Ordering, SynchronizationScope SynchScope,
606 BasicBlock *InsertAtEnd);
608 BinOp getOperation() const {
609 return static_cast<BinOp>(getSubclassDataFromInstruction() >> 5);
612 void setOperation(BinOp Operation) {
613 unsigned short SubclassData = getSubclassDataFromInstruction();
614 setInstructionSubclassData((SubclassData & 31) |
618 /// isVolatile - Return true if this is a RMW on a volatile memory location.
620 bool isVolatile() const {
621 return getSubclassDataFromInstruction() & 1;
624 /// setVolatile - Specify whether this is a volatile RMW or not.
626 void setVolatile(bool V) {
627 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
631 /// Transparently provide more efficient getOperand methods.
632 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
634 /// Set the ordering constraint on this RMW.
635 void setOrdering(AtomicOrdering Ordering) {
636 assert(Ordering != NotAtomic &&
637 "atomicrmw instructions can only be atomic.");
638 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 2)) |
642 /// Specify whether this RMW orders other operations with respect to all
643 /// concurrently executing threads, or only with respect to signal handlers
644 /// executing in the same thread.
645 void setSynchScope(SynchronizationScope SynchScope) {
646 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
650 /// Returns the ordering constraint on this RMW.
651 AtomicOrdering getOrdering() const {
652 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
655 /// Returns whether this RMW is atomic between threads or only within a
657 SynchronizationScope getSynchScope() const {
658 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
661 Value *getPointerOperand() { return getOperand(0); }
662 const Value *getPointerOperand() const { return getOperand(0); }
663 static unsigned getPointerOperandIndex() { return 0U; }
665 Value *getValOperand() { return getOperand(1); }
666 const Value *getValOperand() const { return getOperand(1); }
668 unsigned getPointerAddressSpace() const {
669 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
672 // Methods for support type inquiry through isa, cast, and dyn_cast:
673 static inline bool classof(const AtomicRMWInst *) { return true; }
674 static inline bool classof(const Instruction *I) {
675 return I->getOpcode() == Instruction::AtomicRMW;
677 static inline bool classof(const Value *V) {
678 return isa<Instruction>(V) && classof(cast<Instruction>(V));
681 void Init(BinOp Operation, Value *Ptr, Value *Val,
682 AtomicOrdering Ordering, SynchronizationScope SynchScope);
683 // Shadow Instruction::setInstructionSubclassData with a private forwarding
684 // method so that subclasses cannot accidentally use it.
685 void setInstructionSubclassData(unsigned short D) {
686 Instruction::setInstructionSubclassData(D);
691 struct OperandTraits<AtomicRMWInst>
692 : public FixedNumOperandTraits<AtomicRMWInst,2> {
695 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)
697 //===----------------------------------------------------------------------===//
698 // GetElementPtrInst Class
699 //===----------------------------------------------------------------------===//
701 // checkGEPType - Simple wrapper function to give a better assertion failure
702 // message on bad indexes for a gep instruction.
704 inline Type *checkGEPType(Type *Ty) {
705 assert(Ty && "Invalid GetElementPtrInst indices for type!");
709 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
710 /// access elements of arrays and structs
712 class GetElementPtrInst : public Instruction {
713 GetElementPtrInst(const GetElementPtrInst &GEPI);
714 void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
716 /// Constructors - Create a getelementptr instruction with a base pointer an
717 /// list of indices. The first ctor can optionally insert before an existing
718 /// instruction, the second appends the new instruction to the specified
720 inline GetElementPtrInst(Value *Ptr, ArrayRef<Value *> IdxList,
721 unsigned Values, const Twine &NameStr,
722 Instruction *InsertBefore);
723 inline GetElementPtrInst(Value *Ptr, ArrayRef<Value *> IdxList,
724 unsigned Values, const Twine &NameStr,
725 BasicBlock *InsertAtEnd);
727 virtual GetElementPtrInst *clone_impl() const;
729 static GetElementPtrInst *Create(Value *Ptr, ArrayRef<Value *> IdxList,
730 const Twine &NameStr = "",
731 Instruction *InsertBefore = 0) {
732 unsigned Values = 1 + unsigned(IdxList.size());
734 GetElementPtrInst(Ptr, IdxList, Values, NameStr, InsertBefore);
736 static GetElementPtrInst *Create(Value *Ptr, ArrayRef<Value *> IdxList,
737 const Twine &NameStr,
738 BasicBlock *InsertAtEnd) {
739 unsigned Values = 1 + unsigned(IdxList.size());
741 GetElementPtrInst(Ptr, IdxList, Values, NameStr, InsertAtEnd);
744 /// Create an "inbounds" getelementptr. See the documentation for the
745 /// "inbounds" flag in LangRef.html for details.
746 static GetElementPtrInst *CreateInBounds(Value *Ptr,
747 ArrayRef<Value *> IdxList,
748 const Twine &NameStr = "",
749 Instruction *InsertBefore = 0) {
750 GetElementPtrInst *GEP = Create(Ptr, IdxList, NameStr, InsertBefore);
751 GEP->setIsInBounds(true);
754 static GetElementPtrInst *CreateInBounds(Value *Ptr,
755 ArrayRef<Value *> IdxList,
756 const Twine &NameStr,
757 BasicBlock *InsertAtEnd) {
758 GetElementPtrInst *GEP = Create(Ptr, IdxList, NameStr, InsertAtEnd);
759 GEP->setIsInBounds(true);
763 /// Transparently provide more efficient getOperand methods.
764 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
766 // getType - Overload to return most specific pointer type...
767 PointerType *getType() const {
768 return reinterpret_cast<PointerType*>(Instruction::getType());
771 /// getIndexedType - Returns the type of the element that would be loaded with
772 /// a load instruction with the specified parameters.
774 /// Null is returned if the indices are invalid for the specified
777 static Type *getIndexedType(Type *Ptr, ArrayRef<Value *> IdxList);
778 static Type *getIndexedType(Type *Ptr, ArrayRef<Constant *> IdxList);
779 static Type *getIndexedType(Type *Ptr, ArrayRef<uint64_t> IdxList);
781 /// getIndexedType - Returns the address space used by the GEP pointer.
783 static unsigned getAddressSpace(Value *Ptr);
785 inline op_iterator idx_begin() { return op_begin()+1; }
786 inline const_op_iterator idx_begin() const { return op_begin()+1; }
787 inline op_iterator idx_end() { return op_end(); }
788 inline const_op_iterator idx_end() const { return op_end(); }
790 Value *getPointerOperand() {
791 return getOperand(0);
793 const Value *getPointerOperand() const {
794 return getOperand(0);
796 static unsigned getPointerOperandIndex() {
797 return 0U; // get index for modifying correct operand.
800 unsigned getPointerAddressSpace() const {
801 return cast<PointerType>(getType())->getAddressSpace();
804 /// getPointerOperandType - Method to return the pointer operand as a
806 Type *getPointerOperandType() const {
807 return getPointerOperand()->getType();
810 /// GetGEPReturnType - Returns the pointer type returned by the GEP
811 /// instruction, which may be a vector of pointers.
812 static Type *getGEPReturnType(Value *Ptr, ArrayRef<Value *> IdxList) {
813 Type *PtrTy = PointerType::get(checkGEPType(
814 getIndexedType(Ptr->getType(), IdxList)),
815 getAddressSpace(Ptr));
817 if (Ptr->getType()->isVectorTy()) {
818 unsigned NumElem = cast<VectorType>(Ptr->getType())->getNumElements();
819 return VectorType::get(PtrTy, NumElem);
826 unsigned getNumIndices() const { // Note: always non-negative
827 return getNumOperands() - 1;
830 bool hasIndices() const {
831 return getNumOperands() > 1;
834 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
835 /// zeros. If so, the result pointer and the first operand have the same
836 /// value, just potentially different types.
837 bool hasAllZeroIndices() const;
839 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
840 /// constant integers. If so, the result pointer and the first operand have
841 /// a constant offset between them.
842 bool hasAllConstantIndices() const;
844 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
845 /// See LangRef.html for the meaning of inbounds on a getelementptr.
846 void setIsInBounds(bool b = true);
848 /// isInBounds - Determine whether the GEP has the inbounds flag.
849 bool isInBounds() const;
851 // Methods for support type inquiry through isa, cast, and dyn_cast:
852 static inline bool classof(const GetElementPtrInst *) { return true; }
853 static inline bool classof(const Instruction *I) {
854 return (I->getOpcode() == Instruction::GetElementPtr);
856 static inline bool classof(const Value *V) {
857 return isa<Instruction>(V) && classof(cast<Instruction>(V));
862 struct OperandTraits<GetElementPtrInst> :
863 public VariadicOperandTraits<GetElementPtrInst, 1> {
866 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
867 ArrayRef<Value *> IdxList,
869 const Twine &NameStr,
870 Instruction *InsertBefore)
871 : Instruction(getGEPReturnType(Ptr, IdxList),
873 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
874 Values, InsertBefore) {
875 init(Ptr, IdxList, NameStr);
877 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
878 ArrayRef<Value *> IdxList,
880 const Twine &NameStr,
881 BasicBlock *InsertAtEnd)
882 : Instruction(getGEPReturnType(Ptr, IdxList),
884 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
885 Values, InsertAtEnd) {
886 init(Ptr, IdxList, NameStr);
890 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
893 //===----------------------------------------------------------------------===//
895 //===----------------------------------------------------------------------===//
897 /// This instruction compares its operands according to the predicate given
898 /// to the constructor. It only operates on integers or pointers. The operands
899 /// must be identical types.
900 /// @brief Represent an integer comparison operator.
901 class ICmpInst: public CmpInst {
903 /// @brief Clone an identical ICmpInst
904 virtual ICmpInst *clone_impl() const;
906 /// @brief Constructor with insert-before-instruction semantics.
908 Instruction *InsertBefore, ///< Where to insert
909 Predicate pred, ///< The predicate to use for the comparison
910 Value *LHS, ///< The left-hand-side of the expression
911 Value *RHS, ///< The right-hand-side of the expression
912 const Twine &NameStr = "" ///< Name of the instruction
913 ) : CmpInst(makeCmpResultType(LHS->getType()),
914 Instruction::ICmp, pred, LHS, RHS, NameStr,
916 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
917 pred <= CmpInst::LAST_ICMP_PREDICATE &&
918 "Invalid ICmp predicate value");
919 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
920 "Both operands to ICmp instruction are not of the same type!");
921 // Check that the operands are the right type
922 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
923 getOperand(0)->getType()->getScalarType()->isPointerTy()) &&
924 "Invalid operand types for ICmp instruction");
927 /// @brief Constructor with insert-at-end semantics.
929 BasicBlock &InsertAtEnd, ///< Block to insert into.
930 Predicate pred, ///< The predicate to use for the comparison
931 Value *LHS, ///< The left-hand-side of the expression
932 Value *RHS, ///< The right-hand-side of the expression
933 const Twine &NameStr = "" ///< Name of the instruction
934 ) : CmpInst(makeCmpResultType(LHS->getType()),
935 Instruction::ICmp, pred, LHS, RHS, NameStr,
937 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
938 pred <= CmpInst::LAST_ICMP_PREDICATE &&
939 "Invalid ICmp predicate value");
940 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
941 "Both operands to ICmp instruction are not of the same type!");
942 // Check that the operands are the right type
943 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
944 getOperand(0)->getType()->isPointerTy()) &&
945 "Invalid operand types for ICmp instruction");
948 /// @brief Constructor with no-insertion semantics
950 Predicate pred, ///< The predicate to use for the comparison
951 Value *LHS, ///< The left-hand-side of the expression
952 Value *RHS, ///< The right-hand-side of the expression
953 const Twine &NameStr = "" ///< Name of the instruction
954 ) : CmpInst(makeCmpResultType(LHS->getType()),
955 Instruction::ICmp, pred, LHS, RHS, NameStr) {
956 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
957 pred <= CmpInst::LAST_ICMP_PREDICATE &&
958 "Invalid ICmp predicate value");
959 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
960 "Both operands to ICmp instruction are not of the same type!");
961 // Check that the operands are the right type
962 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
963 getOperand(0)->getType()->getScalarType()->isPointerTy()) &&
964 "Invalid operand types for ICmp instruction");
967 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
968 /// @returns the predicate that would be the result if the operand were
969 /// regarded as signed.
970 /// @brief Return the signed version of the predicate
971 Predicate getSignedPredicate() const {
972 return getSignedPredicate(getPredicate());
975 /// This is a static version that you can use without an instruction.
976 /// @brief Return the signed version of the predicate.
977 static Predicate getSignedPredicate(Predicate pred);
979 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
980 /// @returns the predicate that would be the result if the operand were
981 /// regarded as unsigned.
982 /// @brief Return the unsigned version of the predicate
983 Predicate getUnsignedPredicate() const {
984 return getUnsignedPredicate(getPredicate());
987 /// This is a static version that you can use without an instruction.
988 /// @brief Return the unsigned version of the predicate.
989 static Predicate getUnsignedPredicate(Predicate pred);
991 /// isEquality - Return true if this predicate is either EQ or NE. This also
992 /// tests for commutativity.
993 static bool isEquality(Predicate P) {
994 return P == ICMP_EQ || P == ICMP_NE;
997 /// isEquality - Return true if this predicate is either EQ or NE. This also
998 /// tests for commutativity.
999 bool isEquality() const {
1000 return isEquality(getPredicate());
1003 /// @returns true if the predicate of this ICmpInst is commutative
1004 /// @brief Determine if this relation is commutative.
1005 bool isCommutative() const { return isEquality(); }
1007 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1009 bool isRelational() const {
1010 return !isEquality();
1013 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1015 static bool isRelational(Predicate P) {
1016 return !isEquality(P);
1019 /// Initialize a set of values that all satisfy the predicate with C.
1020 /// @brief Make a ConstantRange for a relation with a constant value.
1021 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
1023 /// Exchange the two operands to this instruction in such a way that it does
1024 /// not modify the semantics of the instruction. The predicate value may be
1025 /// changed to retain the same result if the predicate is order dependent
1027 /// @brief Swap operands and adjust predicate.
1028 void swapOperands() {
1029 setPredicate(getSwappedPredicate());
1030 Op<0>().swap(Op<1>());
1033 // Methods for support type inquiry through isa, cast, and dyn_cast:
1034 static inline bool classof(const ICmpInst *) { return true; }
1035 static inline bool classof(const Instruction *I) {
1036 return I->getOpcode() == Instruction::ICmp;
1038 static inline bool classof(const Value *V) {
1039 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1044 //===----------------------------------------------------------------------===//
1046 //===----------------------------------------------------------------------===//
1048 /// This instruction compares its operands according to the predicate given
1049 /// to the constructor. It only operates on floating point values or packed
1050 /// vectors of floating point values. The operands must be identical types.
1051 /// @brief Represents a floating point comparison operator.
1052 class FCmpInst: public CmpInst {
1054 /// @brief Clone an identical FCmpInst
1055 virtual FCmpInst *clone_impl() const;
1057 /// @brief Constructor with insert-before-instruction semantics.
1059 Instruction *InsertBefore, ///< Where to insert
1060 Predicate pred, ///< The predicate to use for the comparison
1061 Value *LHS, ///< The left-hand-side of the expression
1062 Value *RHS, ///< The right-hand-side of the expression
1063 const Twine &NameStr = "" ///< Name of the instruction
1064 ) : CmpInst(makeCmpResultType(LHS->getType()),
1065 Instruction::FCmp, pred, LHS, RHS, NameStr,
1067 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1068 "Invalid FCmp predicate value");
1069 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1070 "Both operands to FCmp instruction are not of the same type!");
1071 // Check that the operands are the right type
1072 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1073 "Invalid operand types for FCmp instruction");
1076 /// @brief Constructor with insert-at-end semantics.
1078 BasicBlock &InsertAtEnd, ///< Block to insert into.
1079 Predicate pred, ///< The predicate to use for the comparison
1080 Value *LHS, ///< The left-hand-side of the expression
1081 Value *RHS, ///< The right-hand-side of the expression
1082 const Twine &NameStr = "" ///< Name of the instruction
1083 ) : CmpInst(makeCmpResultType(LHS->getType()),
1084 Instruction::FCmp, pred, LHS, RHS, NameStr,
1086 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1087 "Invalid FCmp predicate value");
1088 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1089 "Both operands to FCmp instruction are not of the same type!");
1090 // Check that the operands are the right type
1091 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1092 "Invalid operand types for FCmp instruction");
1095 /// @brief Constructor with no-insertion semantics
1097 Predicate pred, ///< The predicate to use for the comparison
1098 Value *LHS, ///< The left-hand-side of the expression
1099 Value *RHS, ///< The right-hand-side of the expression
1100 const Twine &NameStr = "" ///< Name of the instruction
1101 ) : CmpInst(makeCmpResultType(LHS->getType()),
1102 Instruction::FCmp, pred, LHS, RHS, NameStr) {
1103 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1104 "Invalid FCmp predicate value");
1105 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1106 "Both operands to FCmp instruction are not of the same type!");
1107 // Check that the operands are the right type
1108 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1109 "Invalid operand types for FCmp instruction");
1112 /// @returns true if the predicate of this instruction is EQ or NE.
1113 /// @brief Determine if this is an equality predicate.
1114 bool isEquality() const {
1115 return getPredicate() == FCMP_OEQ || getPredicate() == FCMP_ONE ||
1116 getPredicate() == FCMP_UEQ || getPredicate() == FCMP_UNE;
1119 /// @returns true if the predicate of this instruction is commutative.
1120 /// @brief Determine if this is a commutative predicate.
1121 bool isCommutative() const {
1122 return isEquality() ||
1123 getPredicate() == FCMP_FALSE ||
1124 getPredicate() == FCMP_TRUE ||
1125 getPredicate() == FCMP_ORD ||
1126 getPredicate() == FCMP_UNO;
1129 /// @returns true if the predicate is relational (not EQ or NE).
1130 /// @brief Determine if this a relational predicate.
1131 bool isRelational() const { return !isEquality(); }
1133 /// Exchange the two operands to this instruction in such a way that it does
1134 /// not modify the semantics of the instruction. The predicate value may be
1135 /// changed to retain the same result if the predicate is order dependent
1137 /// @brief Swap operands and adjust predicate.
1138 void swapOperands() {
1139 setPredicate(getSwappedPredicate());
1140 Op<0>().swap(Op<1>());
1143 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1144 static inline bool classof(const FCmpInst *) { return true; }
1145 static inline bool classof(const Instruction *I) {
1146 return I->getOpcode() == Instruction::FCmp;
1148 static inline bool classof(const Value *V) {
1149 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1153 //===----------------------------------------------------------------------===//
1154 /// CallInst - This class represents a function call, abstracting a target
1155 /// machine's calling convention. This class uses low bit of the SubClassData
1156 /// field to indicate whether or not this is a tail call. The rest of the bits
1157 /// hold the calling convention of the call.
1159 class CallInst : public Instruction {
1160 AttrListPtr AttributeList; ///< parameter attributes for call
1161 CallInst(const CallInst &CI);
1162 void init(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr);
1163 void init(Value *Func, const Twine &NameStr);
1165 /// Construct a CallInst given a range of arguments.
1166 /// @brief Construct a CallInst from a range of arguments
1167 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1168 const Twine &NameStr, Instruction *InsertBefore);
1170 /// Construct a CallInst given a range of arguments.
1171 /// @brief Construct a CallInst from a range of arguments
1172 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1173 const Twine &NameStr, BasicBlock *InsertAtEnd);
1175 CallInst(Value *F, Value *Actual, const Twine &NameStr,
1176 Instruction *InsertBefore);
1177 CallInst(Value *F, Value *Actual, const Twine &NameStr,
1178 BasicBlock *InsertAtEnd);
1179 explicit CallInst(Value *F, const Twine &NameStr,
1180 Instruction *InsertBefore);
1181 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1183 virtual CallInst *clone_impl() const;
1185 static CallInst *Create(Value *Func,
1186 ArrayRef<Value *> Args,
1187 const Twine &NameStr = "",
1188 Instruction *InsertBefore = 0) {
1189 return new(unsigned(Args.size() + 1))
1190 CallInst(Func, Args, NameStr, InsertBefore);
1192 static CallInst *Create(Value *Func,
1193 ArrayRef<Value *> Args,
1194 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1195 return new(unsigned(Args.size() + 1))
1196 CallInst(Func, Args, NameStr, InsertAtEnd);
1198 static CallInst *Create(Value *F, const Twine &NameStr = "",
1199 Instruction *InsertBefore = 0) {
1200 return new(1) CallInst(F, NameStr, InsertBefore);
1202 static CallInst *Create(Value *F, const Twine &NameStr,
1203 BasicBlock *InsertAtEnd) {
1204 return new(1) CallInst(F, NameStr, InsertAtEnd);
1206 /// CreateMalloc - Generate the IR for a call to malloc:
1207 /// 1. Compute the malloc call's argument as the specified type's size,
1208 /// possibly multiplied by the array size if the array size is not
1210 /// 2. Call malloc with that argument.
1211 /// 3. Bitcast the result of the malloc call to the specified type.
1212 static Instruction *CreateMalloc(Instruction *InsertBefore,
1213 Type *IntPtrTy, Type *AllocTy,
1214 Value *AllocSize, Value *ArraySize = 0,
1215 Function* MallocF = 0,
1216 const Twine &Name = "");
1217 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1218 Type *IntPtrTy, Type *AllocTy,
1219 Value *AllocSize, Value *ArraySize = 0,
1220 Function* MallocF = 0,
1221 const Twine &Name = "");
1222 /// CreateFree - Generate the IR for a call to the builtin free function.
1223 static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
1224 static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
1228 bool isTailCall() const { return getSubclassDataFromInstruction() & 1; }
1229 void setTailCall(bool isTC = true) {
1230 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
1234 /// Provide fast operand accessors
1235 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1237 /// getNumArgOperands - Return the number of call arguments.
1239 unsigned getNumArgOperands() const { return getNumOperands() - 1; }
1241 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
1243 Value *getArgOperand(unsigned i) const { return getOperand(i); }
1244 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
1246 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1248 CallingConv::ID getCallingConv() const {
1249 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 1);
1251 void setCallingConv(CallingConv::ID CC) {
1252 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
1253 (static_cast<unsigned>(CC) << 1));
1256 /// getAttributes - Return the parameter attributes for this call.
1258 const AttrListPtr &getAttributes() const { return AttributeList; }
1260 /// setAttributes - Set the parameter attributes for this call.
1262 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
1264 /// addAttribute - adds the attribute to the list of attributes.
1265 void addAttribute(unsigned i, Attributes attr);
1267 /// removeAttribute - removes the attribute from the list of attributes.
1268 void removeAttribute(unsigned i, Attributes attr);
1270 /// @brief Determine whether this call has the given attribute.
1271 bool fnHasNoAliasAttr() const;
1272 bool fnHasNoInlineAttr() const;
1273 bool fnHasNoReturnAttr() const;
1274 bool fnHasNoUnwindAttr() const;
1275 bool fnHasReadNoneAttr() const;
1276 bool fnHasReadOnlyAttr() const;
1277 bool fnHasReturnsTwiceAttr() const;
1279 /// \brief Return true if this call has the given attribute.
1280 bool hasFnAttr(Attributes N) const {
1281 return paramHasAttr(~0, N);
1284 /// @brief Determine whether the call or the callee has the given attributes.
1285 bool paramHasByValAttr(unsigned i) const;
1286 bool paramHasInRegAttr(unsigned i) const;
1287 bool paramHasNestAttr(unsigned i) const;
1288 bool paramHasNoAliasAttr(unsigned i) const;
1289 bool paramHasNoCaptureAttr(unsigned i) const;
1290 bool paramHasSExtAttr(unsigned i) const;
1291 bool paramHasStructRetAttr(unsigned i) const;
1292 bool paramHasZExtAttr(unsigned i) const;
1294 /// @brief Determine whether the call or the callee has the given attribute.
1295 bool paramHasAttr(unsigned i, Attributes attr) const;
1297 /// @brief Extract the alignment for a call or parameter (0=unknown).
1298 unsigned getParamAlignment(unsigned i) const {
1299 return AttributeList.getParamAlignment(i);
1302 /// @brief Return true if the call should not be inlined.
1303 bool isNoInline() const { return fnHasNoInlineAttr(); }
1304 void setIsNoInline(bool Value = true) {
1305 if (Value) addAttribute(~0, Attribute::NoInline);
1306 else removeAttribute(~0, Attribute::NoInline);
1309 /// @brief Return true if the call can return twice
1310 bool canReturnTwice() const {
1311 return fnHasReturnsTwiceAttr();
1313 void setCanReturnTwice(bool Value = true) {
1314 if (Value) addAttribute(~0, Attribute::ReturnsTwice);
1315 else removeAttribute(~0, Attribute::ReturnsTwice);
1318 /// @brief Determine if the call does not access memory.
1319 bool doesNotAccessMemory() const {
1320 return fnHasReadNoneAttr();
1322 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1323 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
1324 else removeAttribute(~0, Attribute::ReadNone);
1327 /// @brief Determine if the call does not access or only reads memory.
1328 bool onlyReadsMemory() const {
1329 return doesNotAccessMemory() || fnHasReadOnlyAttr();
1331 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1332 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
1333 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
1336 /// @brief Determine if the call cannot return.
1337 bool doesNotReturn() const { return fnHasNoReturnAttr(); }
1338 void setDoesNotReturn(bool DoesNotReturn = true) {
1339 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
1340 else removeAttribute(~0, Attribute::NoReturn);
1343 /// @brief Determine if the call cannot unwind.
1344 bool doesNotThrow() const { return fnHasNoUnwindAttr(); }
1345 void setDoesNotThrow(bool DoesNotThrow = true) {
1346 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
1347 else removeAttribute(~0, Attribute::NoUnwind);
1350 /// @brief Determine if the call returns a structure through first
1351 /// pointer argument.
1352 bool hasStructRetAttr() const {
1353 // Be friendly and also check the callee.
1354 return paramHasStructRetAttr(1);
1357 /// @brief Determine if any call argument is an aggregate passed by value.
1358 bool hasByValArgument() const {
1359 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1362 /// getCalledFunction - Return the function called, or null if this is an
1363 /// indirect function invocation.
1365 Function *getCalledFunction() const {
1366 return dyn_cast<Function>(Op<-1>());
1369 /// getCalledValue - Get a pointer to the function that is invoked by this
1371 const Value *getCalledValue() const { return Op<-1>(); }
1372 Value *getCalledValue() { return Op<-1>(); }
1374 /// setCalledFunction - Set the function called.
1375 void setCalledFunction(Value* Fn) {
1379 /// isInlineAsm - Check if this call is an inline asm statement.
1380 bool isInlineAsm() const {
1381 return isa<InlineAsm>(Op<-1>());
1384 // Methods for support type inquiry through isa, cast, and dyn_cast:
1385 static inline bool classof(const CallInst *) { return true; }
1386 static inline bool classof(const Instruction *I) {
1387 return I->getOpcode() == Instruction::Call;
1389 static inline bool classof(const Value *V) {
1390 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1393 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1394 // method so that subclasses cannot accidentally use it.
1395 void setInstructionSubclassData(unsigned short D) {
1396 Instruction::setInstructionSubclassData(D);
1401 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1404 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1405 const Twine &NameStr, BasicBlock *InsertAtEnd)
1406 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1407 ->getElementType())->getReturnType(),
1409 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1410 unsigned(Args.size() + 1), InsertAtEnd) {
1411 init(Func, Args, NameStr);
1414 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1415 const Twine &NameStr, Instruction *InsertBefore)
1416 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1417 ->getElementType())->getReturnType(),
1419 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1420 unsigned(Args.size() + 1), InsertBefore) {
1421 init(Func, Args, NameStr);
1425 // Note: if you get compile errors about private methods then
1426 // please update your code to use the high-level operand
1427 // interfaces. See line 943 above.
1428 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1430 //===----------------------------------------------------------------------===//
1432 //===----------------------------------------------------------------------===//
1434 /// SelectInst - This class represents the LLVM 'select' instruction.
1436 class SelectInst : public Instruction {
1437 void init(Value *C, Value *S1, Value *S2) {
1438 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1444 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1445 Instruction *InsertBefore)
1446 : Instruction(S1->getType(), Instruction::Select,
1447 &Op<0>(), 3, InsertBefore) {
1451 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1452 BasicBlock *InsertAtEnd)
1453 : Instruction(S1->getType(), Instruction::Select,
1454 &Op<0>(), 3, InsertAtEnd) {
1459 virtual SelectInst *clone_impl() const;
1461 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1462 const Twine &NameStr = "",
1463 Instruction *InsertBefore = 0) {
1464 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1466 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1467 const Twine &NameStr,
1468 BasicBlock *InsertAtEnd) {
1469 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1472 const Value *getCondition() const { return Op<0>(); }
1473 const Value *getTrueValue() const { return Op<1>(); }
1474 const Value *getFalseValue() const { return Op<2>(); }
1475 Value *getCondition() { return Op<0>(); }
1476 Value *getTrueValue() { return Op<1>(); }
1477 Value *getFalseValue() { return Op<2>(); }
1479 /// areInvalidOperands - Return a string if the specified operands are invalid
1480 /// for a select operation, otherwise return null.
1481 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1483 /// Transparently provide more efficient getOperand methods.
1484 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1486 OtherOps getOpcode() const {
1487 return static_cast<OtherOps>(Instruction::getOpcode());
1490 // Methods for support type inquiry through isa, cast, and dyn_cast:
1491 static inline bool classof(const SelectInst *) { return true; }
1492 static inline bool classof(const Instruction *I) {
1493 return I->getOpcode() == Instruction::Select;
1495 static inline bool classof(const Value *V) {
1496 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1501 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1504 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1506 //===----------------------------------------------------------------------===//
1508 //===----------------------------------------------------------------------===//
1510 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1511 /// an argument of the specified type given a va_list and increments that list
1513 class VAArgInst : public UnaryInstruction {
1515 virtual VAArgInst *clone_impl() const;
1518 VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1519 Instruction *InsertBefore = 0)
1520 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1523 VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1524 BasicBlock *InsertAtEnd)
1525 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1529 Value *getPointerOperand() { return getOperand(0); }
1530 const Value *getPointerOperand() const { return getOperand(0); }
1531 static unsigned getPointerOperandIndex() { return 0U; }
1533 // Methods for support type inquiry through isa, cast, and dyn_cast:
1534 static inline bool classof(const VAArgInst *) { return true; }
1535 static inline bool classof(const Instruction *I) {
1536 return I->getOpcode() == VAArg;
1538 static inline bool classof(const Value *V) {
1539 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1543 //===----------------------------------------------------------------------===//
1544 // ExtractElementInst Class
1545 //===----------------------------------------------------------------------===//
1547 /// ExtractElementInst - This instruction extracts a single (scalar)
1548 /// element from a VectorType value
1550 class ExtractElementInst : public Instruction {
1551 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1552 Instruction *InsertBefore = 0);
1553 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1554 BasicBlock *InsertAtEnd);
1556 virtual ExtractElementInst *clone_impl() const;
1559 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1560 const Twine &NameStr = "",
1561 Instruction *InsertBefore = 0) {
1562 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1564 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1565 const Twine &NameStr,
1566 BasicBlock *InsertAtEnd) {
1567 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1570 /// isValidOperands - Return true if an extractelement instruction can be
1571 /// formed with the specified operands.
1572 static bool isValidOperands(const Value *Vec, const Value *Idx);
1574 Value *getVectorOperand() { return Op<0>(); }
1575 Value *getIndexOperand() { return Op<1>(); }
1576 const Value *getVectorOperand() const { return Op<0>(); }
1577 const Value *getIndexOperand() const { return Op<1>(); }
1579 VectorType *getVectorOperandType() const {
1580 return reinterpret_cast<VectorType*>(getVectorOperand()->getType());
1584 /// Transparently provide more efficient getOperand methods.
1585 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1587 // Methods for support type inquiry through isa, cast, and dyn_cast:
1588 static inline bool classof(const ExtractElementInst *) { return true; }
1589 static inline bool classof(const Instruction *I) {
1590 return I->getOpcode() == Instruction::ExtractElement;
1592 static inline bool classof(const Value *V) {
1593 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1598 struct OperandTraits<ExtractElementInst> :
1599 public FixedNumOperandTraits<ExtractElementInst, 2> {
1602 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1604 //===----------------------------------------------------------------------===//
1605 // InsertElementInst Class
1606 //===----------------------------------------------------------------------===//
1608 /// InsertElementInst - This instruction inserts a single (scalar)
1609 /// element into a VectorType value
1611 class InsertElementInst : public Instruction {
1612 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1613 const Twine &NameStr = "",
1614 Instruction *InsertBefore = 0);
1615 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1616 const Twine &NameStr, BasicBlock *InsertAtEnd);
1618 virtual InsertElementInst *clone_impl() const;
1621 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1622 const Twine &NameStr = "",
1623 Instruction *InsertBefore = 0) {
1624 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1626 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1627 const Twine &NameStr,
1628 BasicBlock *InsertAtEnd) {
1629 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1632 /// isValidOperands - Return true if an insertelement instruction can be
1633 /// formed with the specified operands.
1634 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1637 /// getType - Overload to return most specific vector type.
1639 VectorType *getType() const {
1640 return reinterpret_cast<VectorType*>(Instruction::getType());
1643 /// Transparently provide more efficient getOperand methods.
1644 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1646 // Methods for support type inquiry through isa, cast, and dyn_cast:
1647 static inline bool classof(const InsertElementInst *) { return true; }
1648 static inline bool classof(const Instruction *I) {
1649 return I->getOpcode() == Instruction::InsertElement;
1651 static inline bool classof(const Value *V) {
1652 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1657 struct OperandTraits<InsertElementInst> :
1658 public FixedNumOperandTraits<InsertElementInst, 3> {
1661 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1663 //===----------------------------------------------------------------------===//
1664 // ShuffleVectorInst Class
1665 //===----------------------------------------------------------------------===//
1667 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1670 class ShuffleVectorInst : public Instruction {
1672 virtual ShuffleVectorInst *clone_impl() const;
1675 // allocate space for exactly three operands
1676 void *operator new(size_t s) {
1677 return User::operator new(s, 3);
1679 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1680 const Twine &NameStr = "",
1681 Instruction *InsertBefor = 0);
1682 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1683 const Twine &NameStr, BasicBlock *InsertAtEnd);
1685 /// isValidOperands - Return true if a shufflevector instruction can be
1686 /// formed with the specified operands.
1687 static bool isValidOperands(const Value *V1, const Value *V2,
1690 /// getType - Overload to return most specific vector type.
1692 VectorType *getType() const {
1693 return reinterpret_cast<VectorType*>(Instruction::getType());
1696 /// Transparently provide more efficient getOperand methods.
1697 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1699 Constant *getMask() const {
1700 return reinterpret_cast<Constant*>(getOperand(2));
1703 /// getMaskValue - Return the index from the shuffle mask for the specified
1704 /// output result. This is either -1 if the element is undef or a number less
1705 /// than 2*numelements.
1706 static int getMaskValue(Constant *Mask, unsigned i);
1708 int getMaskValue(unsigned i) const {
1709 return getMaskValue(getMask(), i);
1712 /// getShuffleMask - Return the full mask for this instruction, where each
1713 /// element is the element number and undef's are returned as -1.
1714 static void getShuffleMask(Constant *Mask, SmallVectorImpl<int> &Result);
1716 void getShuffleMask(SmallVectorImpl<int> &Result) const {
1717 return getShuffleMask(getMask(), Result);
1720 SmallVector<int, 16> getShuffleMask() const {
1721 SmallVector<int, 16> Mask;
1722 getShuffleMask(Mask);
1727 // Methods for support type inquiry through isa, cast, and dyn_cast:
1728 static inline bool classof(const ShuffleVectorInst *) { return true; }
1729 static inline bool classof(const Instruction *I) {
1730 return I->getOpcode() == Instruction::ShuffleVector;
1732 static inline bool classof(const Value *V) {
1733 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1738 struct OperandTraits<ShuffleVectorInst> :
1739 public FixedNumOperandTraits<ShuffleVectorInst, 3> {
1742 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1744 //===----------------------------------------------------------------------===//
1745 // ExtractValueInst Class
1746 //===----------------------------------------------------------------------===//
1748 /// ExtractValueInst - This instruction extracts a struct member or array
1749 /// element value from an aggregate value.
1751 class ExtractValueInst : public UnaryInstruction {
1752 SmallVector<unsigned, 4> Indices;
1754 ExtractValueInst(const ExtractValueInst &EVI);
1755 void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
1757 /// Constructors - Create a extractvalue instruction with a base aggregate
1758 /// value and a list of indices. The first ctor can optionally insert before
1759 /// an existing instruction, the second appends the new instruction to the
1760 /// specified BasicBlock.
1761 inline ExtractValueInst(Value *Agg,
1762 ArrayRef<unsigned> Idxs,
1763 const Twine &NameStr,
1764 Instruction *InsertBefore);
1765 inline ExtractValueInst(Value *Agg,
1766 ArrayRef<unsigned> Idxs,
1767 const Twine &NameStr, BasicBlock *InsertAtEnd);
1769 // allocate space for exactly one operand
1770 void *operator new(size_t s) {
1771 return User::operator new(s, 1);
1774 virtual ExtractValueInst *clone_impl() const;
1777 static ExtractValueInst *Create(Value *Agg,
1778 ArrayRef<unsigned> Idxs,
1779 const Twine &NameStr = "",
1780 Instruction *InsertBefore = 0) {
1782 ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
1784 static ExtractValueInst *Create(Value *Agg,
1785 ArrayRef<unsigned> Idxs,
1786 const Twine &NameStr,
1787 BasicBlock *InsertAtEnd) {
1788 return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
1791 /// getIndexedType - Returns the type of the element that would be extracted
1792 /// with an extractvalue instruction with the specified parameters.
1794 /// Null is returned if the indices are invalid for the specified type.
1795 static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
1797 typedef const unsigned* idx_iterator;
1798 inline idx_iterator idx_begin() const { return Indices.begin(); }
1799 inline idx_iterator idx_end() const { return Indices.end(); }
1801 Value *getAggregateOperand() {
1802 return getOperand(0);
1804 const Value *getAggregateOperand() const {
1805 return getOperand(0);
1807 static unsigned getAggregateOperandIndex() {
1808 return 0U; // get index for modifying correct operand
1811 ArrayRef<unsigned> getIndices() const {
1815 unsigned getNumIndices() const {
1816 return (unsigned)Indices.size();
1819 bool hasIndices() const {
1823 // Methods for support type inquiry through isa, cast, and dyn_cast:
1824 static inline bool classof(const ExtractValueInst *) { return true; }
1825 static inline bool classof(const Instruction *I) {
1826 return I->getOpcode() == Instruction::ExtractValue;
1828 static inline bool classof(const Value *V) {
1829 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1833 ExtractValueInst::ExtractValueInst(Value *Agg,
1834 ArrayRef<unsigned> Idxs,
1835 const Twine &NameStr,
1836 Instruction *InsertBefore)
1837 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
1838 ExtractValue, Agg, InsertBefore) {
1839 init(Idxs, NameStr);
1841 ExtractValueInst::ExtractValueInst(Value *Agg,
1842 ArrayRef<unsigned> Idxs,
1843 const Twine &NameStr,
1844 BasicBlock *InsertAtEnd)
1845 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
1846 ExtractValue, Agg, InsertAtEnd) {
1847 init(Idxs, NameStr);
1851 //===----------------------------------------------------------------------===//
1852 // InsertValueInst Class
1853 //===----------------------------------------------------------------------===//
1855 /// InsertValueInst - This instruction inserts a struct field of array element
1856 /// value into an aggregate value.
1858 class InsertValueInst : public Instruction {
1859 SmallVector<unsigned, 4> Indices;
1861 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
1862 InsertValueInst(const InsertValueInst &IVI);
1863 void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
1864 const Twine &NameStr);
1866 /// Constructors - Create a insertvalue instruction with a base aggregate
1867 /// value, a value to insert, and a list of indices. The first ctor can
1868 /// optionally insert before an existing instruction, the second appends
1869 /// the new instruction to the specified BasicBlock.
1870 inline InsertValueInst(Value *Agg, Value *Val,
1871 ArrayRef<unsigned> Idxs,
1872 const Twine &NameStr,
1873 Instruction *InsertBefore);
1874 inline InsertValueInst(Value *Agg, Value *Val,
1875 ArrayRef<unsigned> Idxs,
1876 const Twine &NameStr, BasicBlock *InsertAtEnd);
1878 /// Constructors - These two constructors are convenience methods because one
1879 /// and two index insertvalue instructions are so common.
1880 InsertValueInst(Value *Agg, Value *Val,
1881 unsigned Idx, const Twine &NameStr = "",
1882 Instruction *InsertBefore = 0);
1883 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1884 const Twine &NameStr, BasicBlock *InsertAtEnd);
1886 virtual InsertValueInst *clone_impl() const;
1888 // allocate space for exactly two operands
1889 void *operator new(size_t s) {
1890 return User::operator new(s, 2);
1893 static InsertValueInst *Create(Value *Agg, Value *Val,
1894 ArrayRef<unsigned> Idxs,
1895 const Twine &NameStr = "",
1896 Instruction *InsertBefore = 0) {
1897 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
1899 static InsertValueInst *Create(Value *Agg, Value *Val,
1900 ArrayRef<unsigned> Idxs,
1901 const Twine &NameStr,
1902 BasicBlock *InsertAtEnd) {
1903 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
1906 /// Transparently provide more efficient getOperand methods.
1907 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1909 typedef const unsigned* idx_iterator;
1910 inline idx_iterator idx_begin() const { return Indices.begin(); }
1911 inline idx_iterator idx_end() const { return Indices.end(); }
1913 Value *getAggregateOperand() {
1914 return getOperand(0);
1916 const Value *getAggregateOperand() const {
1917 return getOperand(0);
1919 static unsigned getAggregateOperandIndex() {
1920 return 0U; // get index for modifying correct operand
1923 Value *getInsertedValueOperand() {
1924 return getOperand(1);
1926 const Value *getInsertedValueOperand() const {
1927 return getOperand(1);
1929 static unsigned getInsertedValueOperandIndex() {
1930 return 1U; // get index for modifying correct operand
1933 ArrayRef<unsigned> getIndices() const {
1937 unsigned getNumIndices() const {
1938 return (unsigned)Indices.size();
1941 bool hasIndices() const {
1945 // Methods for support type inquiry through isa, cast, and dyn_cast:
1946 static inline bool classof(const InsertValueInst *) { return true; }
1947 static inline bool classof(const Instruction *I) {
1948 return I->getOpcode() == Instruction::InsertValue;
1950 static inline bool classof(const Value *V) {
1951 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1956 struct OperandTraits<InsertValueInst> :
1957 public FixedNumOperandTraits<InsertValueInst, 2> {
1960 InsertValueInst::InsertValueInst(Value *Agg,
1962 ArrayRef<unsigned> Idxs,
1963 const Twine &NameStr,
1964 Instruction *InsertBefore)
1965 : Instruction(Agg->getType(), InsertValue,
1966 OperandTraits<InsertValueInst>::op_begin(this),
1968 init(Agg, Val, Idxs, NameStr);
1970 InsertValueInst::InsertValueInst(Value *Agg,
1972 ArrayRef<unsigned> Idxs,
1973 const Twine &NameStr,
1974 BasicBlock *InsertAtEnd)
1975 : Instruction(Agg->getType(), InsertValue,
1976 OperandTraits<InsertValueInst>::op_begin(this),
1978 init(Agg, Val, Idxs, NameStr);
1981 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1983 //===----------------------------------------------------------------------===//
1985 //===----------------------------------------------------------------------===//
1987 // PHINode - The PHINode class is used to represent the magical mystical PHI
1988 // node, that can not exist in nature, but can be synthesized in a computer
1989 // scientist's overactive imagination.
1991 class PHINode : public Instruction {
1992 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
1993 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1994 /// the number actually in use.
1995 unsigned ReservedSpace;
1996 PHINode(const PHINode &PN);
1997 // allocate space for exactly zero operands
1998 void *operator new(size_t s) {
1999 return User::operator new(s, 0);
2001 explicit PHINode(Type *Ty, unsigned NumReservedValues,
2002 const Twine &NameStr = "", Instruction *InsertBefore = 0)
2003 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
2004 ReservedSpace(NumReservedValues) {
2006 OperandList = allocHungoffUses(ReservedSpace);
2009 PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
2010 BasicBlock *InsertAtEnd)
2011 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
2012 ReservedSpace(NumReservedValues) {
2014 OperandList = allocHungoffUses(ReservedSpace);
2017 // allocHungoffUses - this is more complicated than the generic
2018 // User::allocHungoffUses, because we have to allocate Uses for the incoming
2019 // values and pointers to the incoming blocks, all in one allocation.
2020 Use *allocHungoffUses(unsigned) const;
2022 virtual PHINode *clone_impl() const;
2024 /// Constructors - NumReservedValues is a hint for the number of incoming
2025 /// edges that this phi node will have (use 0 if you really have no idea).
2026 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2027 const Twine &NameStr = "",
2028 Instruction *InsertBefore = 0) {
2029 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2031 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2032 const Twine &NameStr, BasicBlock *InsertAtEnd) {
2033 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2037 /// Provide fast operand accessors
2038 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2040 // Block iterator interface. This provides access to the list of incoming
2041 // basic blocks, which parallels the list of incoming values.
2043 typedef BasicBlock **block_iterator;
2044 typedef BasicBlock * const *const_block_iterator;
2046 block_iterator block_begin() {
2048 reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2049 return reinterpret_cast<block_iterator>(ref + 1);
2052 const_block_iterator block_begin() const {
2053 const Use::UserRef *ref =
2054 reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2055 return reinterpret_cast<const_block_iterator>(ref + 1);
2058 block_iterator block_end() {
2059 return block_begin() + getNumOperands();
2062 const_block_iterator block_end() const {
2063 return block_begin() + getNumOperands();
2066 /// getNumIncomingValues - Return the number of incoming edges
2068 unsigned getNumIncomingValues() const { return getNumOperands(); }
2070 /// getIncomingValue - Return incoming value number x
2072 Value *getIncomingValue(unsigned i) const {
2073 return getOperand(i);
2075 void setIncomingValue(unsigned i, Value *V) {
2078 static unsigned getOperandNumForIncomingValue(unsigned i) {
2081 static unsigned getIncomingValueNumForOperand(unsigned i) {
2085 /// getIncomingBlock - Return incoming basic block number @p i.
2087 BasicBlock *getIncomingBlock(unsigned i) const {
2088 return block_begin()[i];
2091 /// getIncomingBlock - Return incoming basic block corresponding
2092 /// to an operand of the PHI.
2094 BasicBlock *getIncomingBlock(const Use &U) const {
2095 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2096 return getIncomingBlock(unsigned(&U - op_begin()));
2099 /// getIncomingBlock - Return incoming basic block corresponding
2100 /// to value use iterator.
2102 template <typename U>
2103 BasicBlock *getIncomingBlock(value_use_iterator<U> I) const {
2104 return getIncomingBlock(I.getUse());
2107 void setIncomingBlock(unsigned i, BasicBlock *BB) {
2108 block_begin()[i] = BB;
2111 /// addIncoming - Add an incoming value to the end of the PHI list
2113 void addIncoming(Value *V, BasicBlock *BB) {
2114 assert(V && "PHI node got a null value!");
2115 assert(BB && "PHI node got a null basic block!");
2116 assert(getType() == V->getType() &&
2117 "All operands to PHI node must be the same type as the PHI node!");
2118 if (NumOperands == ReservedSpace)
2119 growOperands(); // Get more space!
2120 // Initialize some new operands.
2122 setIncomingValue(NumOperands - 1, V);
2123 setIncomingBlock(NumOperands - 1, BB);
2126 /// removeIncomingValue - Remove an incoming value. This is useful if a
2127 /// predecessor basic block is deleted. The value removed is returned.
2129 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2130 /// is true), the PHI node is destroyed and any uses of it are replaced with
2131 /// dummy values. The only time there should be zero incoming values to a PHI
2132 /// node is when the block is dead, so this strategy is sound.
2134 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2136 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2137 int Idx = getBasicBlockIndex(BB);
2138 assert(Idx >= 0 && "Invalid basic block argument to remove!");
2139 return removeIncomingValue(Idx, DeletePHIIfEmpty);
2142 /// getBasicBlockIndex - Return the first index of the specified basic
2143 /// block in the value list for this PHI. Returns -1 if no instance.
2145 int getBasicBlockIndex(const BasicBlock *BB) const {
2146 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2147 if (block_begin()[i] == BB)
2152 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2153 int Idx = getBasicBlockIndex(BB);
2154 assert(Idx >= 0 && "Invalid basic block argument!");
2155 return getIncomingValue(Idx);
2158 /// hasConstantValue - If the specified PHI node always merges together the
2159 /// same value, return the value, otherwise return null.
2160 Value *hasConstantValue() const;
2162 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2163 static inline bool classof(const PHINode *) { return true; }
2164 static inline bool classof(const Instruction *I) {
2165 return I->getOpcode() == Instruction::PHI;
2167 static inline bool classof(const Value *V) {
2168 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2171 void growOperands();
2175 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2178 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2180 //===----------------------------------------------------------------------===//
2181 // LandingPadInst Class
2182 //===----------------------------------------------------------------------===//
2184 //===---------------------------------------------------------------------------
2185 /// LandingPadInst - The landingpad instruction holds all of the information
2186 /// necessary to generate correct exception handling. The landingpad instruction
2187 /// cannot be moved from the top of a landing pad block, which itself is
2188 /// accessible only from the 'unwind' edge of an invoke. This uses the
2189 /// SubclassData field in Value to store whether or not the landingpad is a
2192 class LandingPadInst : public Instruction {
2193 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2194 /// the number actually in use.
2195 unsigned ReservedSpace;
2196 LandingPadInst(const LandingPadInst &LP);
2198 enum ClauseType { Catch, Filter };
2200 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2201 // Allocate space for exactly zero operands.
2202 void *operator new(size_t s) {
2203 return User::operator new(s, 0);
2205 void growOperands(unsigned Size);
2206 void init(Value *PersFn, unsigned NumReservedValues, const Twine &NameStr);
2208 explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2209 unsigned NumReservedValues, const Twine &NameStr,
2210 Instruction *InsertBefore);
2211 explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2212 unsigned NumReservedValues, const Twine &NameStr,
2213 BasicBlock *InsertAtEnd);
2215 virtual LandingPadInst *clone_impl() const;
2217 /// Constructors - NumReservedClauses is a hint for the number of incoming
2218 /// clauses that this landingpad will have (use 0 if you really have no idea).
2219 static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2220 unsigned NumReservedClauses,
2221 const Twine &NameStr = "",
2222 Instruction *InsertBefore = 0);
2223 static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2224 unsigned NumReservedClauses,
2225 const Twine &NameStr, BasicBlock *InsertAtEnd);
2228 /// Provide fast operand accessors
2229 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2231 /// getPersonalityFn - Get the personality function associated with this
2233 Value *getPersonalityFn() const { return getOperand(0); }
2235 /// isCleanup - Return 'true' if this landingpad instruction is a
2236 /// cleanup. I.e., it should be run when unwinding even if its landing pad
2237 /// doesn't catch the exception.
2238 bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2240 /// setCleanup - Indicate that this landingpad instruction is a cleanup.
2241 void setCleanup(bool V) {
2242 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2246 /// addClause - Add a catch or filter clause to the landing pad.
2247 void addClause(Value *ClauseVal);
2249 /// getClause - Get the value of the clause at index Idx. Use isCatch/isFilter
2250 /// to determine what type of clause this is.
2251 Value *getClause(unsigned Idx) const { return OperandList[Idx + 1]; }
2253 /// isCatch - Return 'true' if the clause and index Idx is a catch clause.
2254 bool isCatch(unsigned Idx) const {
2255 return !isa<ArrayType>(OperandList[Idx + 1]->getType());
2258 /// isFilter - Return 'true' if the clause and index Idx is a filter clause.
2259 bool isFilter(unsigned Idx) const {
2260 return isa<ArrayType>(OperandList[Idx + 1]->getType());
2263 /// getNumClauses - Get the number of clauses for this landing pad.
2264 unsigned getNumClauses() const { return getNumOperands() - 1; }
2266 /// reserveClauses - Grow the size of the operand list to accommodate the new
2267 /// number of clauses.
2268 void reserveClauses(unsigned Size) { growOperands(Size); }
2270 // Methods for support type inquiry through isa, cast, and dyn_cast:
2271 static inline bool classof(const LandingPadInst *) { return true; }
2272 static inline bool classof(const Instruction *I) {
2273 return I->getOpcode() == Instruction::LandingPad;
2275 static inline bool classof(const Value *V) {
2276 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2281 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<2> {
2284 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2286 //===----------------------------------------------------------------------===//
2288 //===----------------------------------------------------------------------===//
2290 //===---------------------------------------------------------------------------
2291 /// ReturnInst - Return a value (possibly void), from a function. Execution
2292 /// does not continue in this function any longer.
2294 class ReturnInst : public TerminatorInst {
2295 ReturnInst(const ReturnInst &RI);
2298 // ReturnInst constructors:
2299 // ReturnInst() - 'ret void' instruction
2300 // ReturnInst( null) - 'ret void' instruction
2301 // ReturnInst(Value* X) - 'ret X' instruction
2302 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2303 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2304 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2305 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2307 // NOTE: If the Value* passed is of type void then the constructor behaves as
2308 // if it was passed NULL.
2309 explicit ReturnInst(LLVMContext &C, Value *retVal = 0,
2310 Instruction *InsertBefore = 0);
2311 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2312 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2314 virtual ReturnInst *clone_impl() const;
2316 static ReturnInst* Create(LLVMContext &C, Value *retVal = 0,
2317 Instruction *InsertBefore = 0) {
2318 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2320 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2321 BasicBlock *InsertAtEnd) {
2322 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2324 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2325 return new(0) ReturnInst(C, InsertAtEnd);
2327 virtual ~ReturnInst();
2329 /// Provide fast operand accessors
2330 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2332 /// Convenience accessor. Returns null if there is no return value.
2333 Value *getReturnValue() const {
2334 return getNumOperands() != 0 ? getOperand(0) : 0;
2337 unsigned getNumSuccessors() const { return 0; }
2339 // Methods for support type inquiry through isa, cast, and dyn_cast:
2340 static inline bool classof(const ReturnInst *) { return true; }
2341 static inline bool classof(const Instruction *I) {
2342 return (I->getOpcode() == Instruction::Ret);
2344 static inline bool classof(const Value *V) {
2345 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2348 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2349 virtual unsigned getNumSuccessorsV() const;
2350 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2354 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2357 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2359 //===----------------------------------------------------------------------===//
2361 //===----------------------------------------------------------------------===//
2363 //===---------------------------------------------------------------------------
2364 /// BranchInst - Conditional or Unconditional Branch instruction.
2366 class BranchInst : public TerminatorInst {
2367 /// Ops list - Branches are strange. The operands are ordered:
2368 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2369 /// they don't have to check for cond/uncond branchness. These are mostly
2370 /// accessed relative from op_end().
2371 BranchInst(const BranchInst &BI);
2373 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2374 // BranchInst(BB *B) - 'br B'
2375 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2376 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2377 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2378 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2379 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2380 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2381 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2382 Instruction *InsertBefore = 0);
2383 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2384 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2385 BasicBlock *InsertAtEnd);
2387 virtual BranchInst *clone_impl() const;
2389 static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2390 return new(1) BranchInst(IfTrue, InsertBefore);
2392 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2393 Value *Cond, Instruction *InsertBefore = 0) {
2394 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2396 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2397 return new(1) BranchInst(IfTrue, InsertAtEnd);
2399 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2400 Value *Cond, BasicBlock *InsertAtEnd) {
2401 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2404 /// Transparently provide more efficient getOperand methods.
2405 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2407 bool isUnconditional() const { return getNumOperands() == 1; }
2408 bool isConditional() const { return getNumOperands() == 3; }
2410 Value *getCondition() const {
2411 assert(isConditional() && "Cannot get condition of an uncond branch!");
2415 void setCondition(Value *V) {
2416 assert(isConditional() && "Cannot set condition of unconditional branch!");
2420 unsigned getNumSuccessors() const { return 1+isConditional(); }
2422 BasicBlock *getSuccessor(unsigned i) const {
2423 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2424 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2427 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2428 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2429 *(&Op<-1>() - idx) = (Value*)NewSucc;
2432 /// \brief Swap the successors of this branch instruction.
2434 /// Swaps the successors of the branch instruction. This also swaps any
2435 /// branch weight metadata associated with the instruction so that it
2436 /// continues to map correctly to each operand.
2437 void swapSuccessors();
2439 // Methods for support type inquiry through isa, cast, and dyn_cast:
2440 static inline bool classof(const BranchInst *) { return true; }
2441 static inline bool classof(const Instruction *I) {
2442 return (I->getOpcode() == Instruction::Br);
2444 static inline bool classof(const Value *V) {
2445 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2448 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2449 virtual unsigned getNumSuccessorsV() const;
2450 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2454 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2457 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2459 //===----------------------------------------------------------------------===//
2461 //===----------------------------------------------------------------------===//
2463 //===---------------------------------------------------------------------------
2464 /// SwitchInst - Multiway switch
2466 class SwitchInst : public TerminatorInst {
2467 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2468 unsigned ReservedSpace;
2470 // Operand[0] = Value to switch on
2471 // Operand[1] = Default basic block destination
2472 // Operand[2n ] = Value to match
2473 // Operand[2n+1] = BasicBlock to go to on match
2475 // Store case values separately from operands list. We needn't User-Use
2476 // concept here, since it is just a case value, it will always constant,
2477 // and case value couldn't reused with another instructions/values.
2479 // It allows us to use custom type for case values that is not inherited
2480 // from Value. Since case value is a complex type that implements
2481 // the subset of integers, we needn't extract sub-constants within
2482 // slow getAggregateElement method.
2483 // For case values we will use std::list to by two reasons:
2484 // 1. It allows to add/remove cases without whole collection reallocation.
2485 // 2. In most of cases we needn't random access.
2486 // Currently case values are also stored in Operands List, but it will moved
2487 // out in future commits.
2488 typedef std::list<IntegersSubset> Subsets;
2489 typedef Subsets::iterator SubsetsIt;
2490 typedef Subsets::const_iterator SubsetsConstIt;
2494 SwitchInst(const SwitchInst &SI);
2495 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2496 void growOperands();
2497 // allocate space for exactly zero operands
2498 void *operator new(size_t s) {
2499 return User::operator new(s, 0);
2501 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2502 /// switch on and a default destination. The number of additional cases can
2503 /// be specified here to make memory allocation more efficient. This
2504 /// constructor can also autoinsert before another instruction.
2505 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2506 Instruction *InsertBefore);
2508 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2509 /// switch on and a default destination. The number of additional cases can
2510 /// be specified here to make memory allocation more efficient. This
2511 /// constructor also autoinserts at the end of the specified BasicBlock.
2512 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2513 BasicBlock *InsertAtEnd);
2515 virtual SwitchInst *clone_impl() const;
2518 // FIXME: Currently there are a lot of unclean template parameters,
2519 // we need to make refactoring in future.
2520 // All these parameters are used to implement both iterator and const_iterator
2521 // without code duplication.
2522 // SwitchInstTy may be "const SwitchInst" or "SwitchInst"
2523 // ConstantIntTy may be "const ConstantInt" or "ConstantInt"
2524 // SubsetsItTy may be SubsetsConstIt or SubsetsIt
2525 // BasicBlockTy may be "const BasicBlock" or "BasicBlock"
2526 template <class SwitchInstTy, class ConstantIntTy,
2527 class SubsetsItTy, class BasicBlockTy>
2528 class CaseIteratorT;
2530 typedef CaseIteratorT<const SwitchInst, const ConstantInt,
2531 SubsetsConstIt, const BasicBlock> ConstCaseIt;
2535 static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
2537 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2538 unsigned NumCases, Instruction *InsertBefore = 0) {
2539 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2541 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2542 unsigned NumCases, BasicBlock *InsertAtEnd) {
2543 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2548 /// Provide fast operand accessors
2549 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2551 // Accessor Methods for Switch stmt
2552 Value *getCondition() const { return getOperand(0); }
2553 void setCondition(Value *V) { setOperand(0, V); }
2555 BasicBlock *getDefaultDest() const {
2556 return cast<BasicBlock>(getOperand(1));
2559 void setDefaultDest(BasicBlock *DefaultCase) {
2560 setOperand(1, reinterpret_cast<Value*>(DefaultCase));
2563 /// getNumCases - return the number of 'cases' in this switch instruction,
2564 /// except the default case
2565 unsigned getNumCases() const {
2566 return getNumOperands()/2 - 1;
2569 /// Returns a read/write iterator that points to the first
2570 /// case in SwitchInst.
2571 CaseIt case_begin() {
2572 return CaseIt(this, 0, TheSubsets.begin());
2574 /// Returns a read-only iterator that points to the first
2575 /// case in the SwitchInst.
2576 ConstCaseIt case_begin() const {
2577 return ConstCaseIt(this, 0, TheSubsets.begin());
2580 /// Returns a read/write iterator that points one past the last
2581 /// in the SwitchInst.
2583 return CaseIt(this, getNumCases(), TheSubsets.end());
2585 /// Returns a read-only iterator that points one past the last
2586 /// in the SwitchInst.
2587 ConstCaseIt case_end() const {
2588 return ConstCaseIt(this, getNumCases(), TheSubsets.end());
2590 /// Returns an iterator that points to the default case.
2591 /// Note: this iterator allows to resolve successor only. Attempt
2592 /// to resolve case value causes an assertion.
2593 /// Also note, that increment and decrement also causes an assertion and
2594 /// makes iterator invalid.
2595 CaseIt case_default() {
2596 return CaseIt(this, DefaultPseudoIndex, TheSubsets.end());
2598 ConstCaseIt case_default() const {
2599 return ConstCaseIt(this, DefaultPseudoIndex, TheSubsets.end());
2602 /// findCaseValue - Search all of the case values for the specified constant.
2603 /// If it is explicitly handled, return the case iterator of it, otherwise
2604 /// return default case iterator to indicate
2605 /// that it is handled by the default handler.
2606 CaseIt findCaseValue(const ConstantInt *C) {
2607 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i)
2608 if (i.getCaseValueEx().isSatisfies(IntItem::fromConstantInt(C)))
2610 return case_default();
2612 ConstCaseIt findCaseValue(const ConstantInt *C) const {
2613 for (ConstCaseIt i = case_begin(), e = case_end(); i != e; ++i)
2614 if (i.getCaseValueEx().isSatisfies(IntItem::fromConstantInt(C)))
2616 return case_default();
2619 /// findCaseDest - Finds the unique case value for a given successor. Returns
2620 /// null if the successor is not found, not unique, or is the default case.
2621 ConstantInt *findCaseDest(BasicBlock *BB) {
2622 if (BB == getDefaultDest()) return NULL;
2624 ConstantInt *CI = NULL;
2625 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i) {
2626 if (i.getCaseSuccessor() == BB) {
2627 if (CI) return NULL; // Multiple cases lead to BB.
2628 else CI = i.getCaseValue();
2634 /// addCase - Add an entry to the switch instruction...
2637 /// This action invalidates case_end(). Old case_end() iterator will
2638 /// point to the added case.
2639 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2641 /// addCase - Add an entry to the switch instruction.
2643 /// This action invalidates case_end(). Old case_end() iterator will
2644 /// point to the added case.
2645 void addCase(IntegersSubset& OnVal, BasicBlock *Dest);
2647 /// removeCase - This method removes the specified case and its successor
2648 /// from the switch instruction. Note that this operation may reorder the
2649 /// remaining cases at index idx and above.
2651 /// This action invalidates iterators for all cases following the one removed,
2652 /// including the case_end() iterator.
2653 void removeCase(CaseIt& i);
2655 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2656 BasicBlock *getSuccessor(unsigned idx) const {
2657 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2658 return cast<BasicBlock>(getOperand(idx*2+1));
2660 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2661 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2662 setOperand(idx*2+1, (Value*)NewSucc);
2665 uint16_t hash() const {
2666 uint32_t NumberOfCases = (uint32_t)getNumCases();
2667 uint16_t Hash = (0xFFFF & NumberOfCases) ^ (NumberOfCases >> 16);
2668 for (ConstCaseIt i = case_begin(), e = case_end();
2670 uint32_t NumItems = (uint32_t)i.getCaseValueEx().getNumItems();
2671 Hash = (Hash << 1) ^ (0xFFFF & NumItems) ^ (NumItems >> 16);
2676 // Case iterators definition.
2678 template <class SwitchInstTy, class ConstantIntTy,
2679 class SubsetsItTy, class BasicBlockTy>
2680 class CaseIteratorT {
2684 unsigned long Index;
2685 SubsetsItTy SubsetIt;
2687 /// Initializes case iterator for given SwitchInst and for given
2689 friend class SwitchInst;
2690 CaseIteratorT(SwitchInstTy *SI, unsigned SuccessorIndex,
2691 SubsetsItTy CaseValueIt) {
2693 Index = SuccessorIndex;
2694 this->SubsetIt = CaseValueIt;
2698 typedef typename SubsetsItTy::reference IntegersSubsetRef;
2699 typedef CaseIteratorT<SwitchInstTy, ConstantIntTy,
2700 SubsetsItTy, BasicBlockTy> Self;
2702 CaseIteratorT(SwitchInstTy *SI, unsigned CaseNum) {
2705 SubsetIt = SI->TheSubsets.begin();
2706 std::advance(SubsetIt, CaseNum);
2710 /// Initializes case iterator for given SwitchInst and for given
2711 /// TerminatorInst's successor index.
2712 static Self fromSuccessorIndex(SwitchInstTy *SI, unsigned SuccessorIndex) {
2713 assert(SuccessorIndex < SI->getNumSuccessors() &&
2714 "Successor index # out of range!");
2715 return SuccessorIndex != 0 ?
2716 Self(SI, SuccessorIndex - 1) :
2717 Self(SI, DefaultPseudoIndex);
2720 /// Resolves case value for current case.
2722 ConstantIntTy *getCaseValue() {
2723 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2724 IntegersSubsetRef CaseRanges = *SubsetIt;
2726 // FIXME: Currently we work with ConstantInt based cases.
2727 // So return CaseValue as ConstantInt.
2728 return CaseRanges.getSingleNumber(0).toConstantInt();
2731 /// Resolves case value for current case.
2732 IntegersSubsetRef getCaseValueEx() {
2733 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2737 /// Resolves successor for current case.
2738 BasicBlockTy *getCaseSuccessor() {
2739 assert((Index < SI->getNumCases() ||
2740 Index == DefaultPseudoIndex) &&
2741 "Index out the number of cases.");
2742 return SI->getSuccessor(getSuccessorIndex());
2745 /// Returns number of current case.
2746 unsigned getCaseIndex() const { return Index; }
2748 /// Returns TerminatorInst's successor index for current case successor.
2749 unsigned getSuccessorIndex() const {
2750 assert((Index == DefaultPseudoIndex || Index < SI->getNumCases()) &&
2751 "Index out the number of cases.");
2752 return Index != DefaultPseudoIndex ? Index + 1 : 0;
2756 // Check index correctness after increment.
2757 // Note: Index == getNumCases() means end().
2758 assert(Index+1 <= SI->getNumCases() && "Index out the number of cases.");
2761 SubsetIt = SI->TheSubsets.begin();
2766 Self operator++(int) {
2772 // Check index correctness after decrement.
2773 // Note: Index == getNumCases() means end().
2774 // Also allow "-1" iterator here. That will became valid after ++.
2775 unsigned NumCases = SI->getNumCases();
2776 assert((Index == 0 || Index-1 <= NumCases) &&
2777 "Index out the number of cases.");
2779 if (Index == NumCases) {
2780 SubsetIt = SI->TheSubsets.end();
2789 Self operator--(int) {
2794 bool operator==(const Self& RHS) const {
2795 assert(RHS.SI == SI && "Incompatible operators.");
2796 return RHS.Index == Index;
2798 bool operator!=(const Self& RHS) const {
2799 assert(RHS.SI == SI && "Incompatible operators.");
2800 return RHS.Index != Index;
2804 class CaseIt : public CaseIteratorT<SwitchInst, ConstantInt,
2805 SubsetsIt, BasicBlock> {
2806 typedef CaseIteratorT<SwitchInst, ConstantInt, SubsetsIt, BasicBlock>
2810 friend class SwitchInst;
2811 CaseIt(SwitchInst *SI, unsigned CaseNum, SubsetsIt SubsetIt) :
2812 ParentTy(SI, CaseNum, SubsetIt) {}
2814 void updateCaseValueOperand(IntegersSubset& V) {
2815 SI->setOperand(2 + Index*2, reinterpret_cast<Value*>((Constant*)V));
2820 CaseIt(SwitchInst *SI, unsigned CaseNum) : ParentTy(SI, CaseNum) {}
2822 CaseIt(const ParentTy& Src) : ParentTy(Src) {}
2824 /// Sets the new value for current case.
2826 void setValue(ConstantInt *V) {
2827 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2828 IntegersSubsetToBB Mapping;
2829 // FIXME: Currently we work with ConstantInt based cases.
2830 // So inititalize IntItem container directly from ConstantInt.
2831 Mapping.add(IntItem::fromConstantInt(V));
2832 *SubsetIt = Mapping.getCase();
2833 updateCaseValueOperand(*SubsetIt);
2836 /// Sets the new value for current case.
2837 void setValueEx(IntegersSubset& V) {
2838 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2840 updateCaseValueOperand(*SubsetIt);
2843 /// Sets the new successor for current case.
2844 void setSuccessor(BasicBlock *S) {
2845 SI->setSuccessor(getSuccessorIndex(), S);
2849 // Methods for support type inquiry through isa, cast, and dyn_cast:
2851 static inline bool classof(const SwitchInst *) { return true; }
2852 static inline bool classof(const Instruction *I) {
2853 return I->getOpcode() == Instruction::Switch;
2855 static inline bool classof(const Value *V) {
2856 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2859 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2860 virtual unsigned getNumSuccessorsV() const;
2861 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2865 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2868 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2871 //===----------------------------------------------------------------------===//
2872 // IndirectBrInst Class
2873 //===----------------------------------------------------------------------===//
2875 //===---------------------------------------------------------------------------
2876 /// IndirectBrInst - Indirect Branch Instruction.
2878 class IndirectBrInst : public TerminatorInst {
2879 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
2880 unsigned ReservedSpace;
2881 // Operand[0] = Value to switch on
2882 // Operand[1] = Default basic block destination
2883 // Operand[2n ] = Value to match
2884 // Operand[2n+1] = BasicBlock to go to on match
2885 IndirectBrInst(const IndirectBrInst &IBI);
2886 void init(Value *Address, unsigned NumDests);
2887 void growOperands();
2888 // allocate space for exactly zero operands
2889 void *operator new(size_t s) {
2890 return User::operator new(s, 0);
2892 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2893 /// Address to jump to. The number of expected destinations can be specified
2894 /// here to make memory allocation more efficient. This constructor can also
2895 /// autoinsert before another instruction.
2896 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
2898 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2899 /// Address to jump to. The number of expected destinations can be specified
2900 /// here to make memory allocation more efficient. This constructor also
2901 /// autoinserts at the end of the specified BasicBlock.
2902 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
2904 virtual IndirectBrInst *clone_impl() const;
2906 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2907 Instruction *InsertBefore = 0) {
2908 return new IndirectBrInst(Address, NumDests, InsertBefore);
2910 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2911 BasicBlock *InsertAtEnd) {
2912 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
2916 /// Provide fast operand accessors.
2917 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2919 // Accessor Methods for IndirectBrInst instruction.
2920 Value *getAddress() { return getOperand(0); }
2921 const Value *getAddress() const { return getOperand(0); }
2922 void setAddress(Value *V) { setOperand(0, V); }
2925 /// getNumDestinations - return the number of possible destinations in this
2926 /// indirectbr instruction.
2927 unsigned getNumDestinations() const { return getNumOperands()-1; }
2929 /// getDestination - Return the specified destination.
2930 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
2931 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
2933 /// addDestination - Add a destination.
2935 void addDestination(BasicBlock *Dest);
2937 /// removeDestination - This method removes the specified successor from the
2938 /// indirectbr instruction.
2939 void removeDestination(unsigned i);
2941 unsigned getNumSuccessors() const { return getNumOperands()-1; }
2942 BasicBlock *getSuccessor(unsigned i) const {
2943 return cast<BasicBlock>(getOperand(i+1));
2945 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
2946 setOperand(i+1, (Value*)NewSucc);
2949 // Methods for support type inquiry through isa, cast, and dyn_cast:
2950 static inline bool classof(const IndirectBrInst *) { return true; }
2951 static inline bool classof(const Instruction *I) {
2952 return I->getOpcode() == Instruction::IndirectBr;
2954 static inline bool classof(const Value *V) {
2955 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2958 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2959 virtual unsigned getNumSuccessorsV() const;
2960 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2964 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
2967 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
2970 //===----------------------------------------------------------------------===//
2972 //===----------------------------------------------------------------------===//
2974 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
2975 /// calling convention of the call.
2977 class InvokeInst : public TerminatorInst {
2978 AttrListPtr AttributeList;
2979 InvokeInst(const InvokeInst &BI);
2980 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2981 ArrayRef<Value *> Args, const Twine &NameStr);
2983 /// Construct an InvokeInst given a range of arguments.
2985 /// @brief Construct an InvokeInst from a range of arguments
2986 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2987 ArrayRef<Value *> Args, unsigned Values,
2988 const Twine &NameStr, Instruction *InsertBefore);
2990 /// Construct an InvokeInst given a range of arguments.
2992 /// @brief Construct an InvokeInst from a range of arguments
2993 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2994 ArrayRef<Value *> Args, unsigned Values,
2995 const Twine &NameStr, BasicBlock *InsertAtEnd);
2997 virtual InvokeInst *clone_impl() const;
2999 static InvokeInst *Create(Value *Func,
3000 BasicBlock *IfNormal, BasicBlock *IfException,
3001 ArrayRef<Value *> Args, const Twine &NameStr = "",
3002 Instruction *InsertBefore = 0) {
3003 unsigned Values = unsigned(Args.size()) + 3;
3004 return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3005 Values, NameStr, InsertBefore);
3007 static InvokeInst *Create(Value *Func,
3008 BasicBlock *IfNormal, BasicBlock *IfException,
3009 ArrayRef<Value *> Args, const Twine &NameStr,
3010 BasicBlock *InsertAtEnd) {
3011 unsigned Values = unsigned(Args.size()) + 3;
3012 return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3013 Values, NameStr, InsertAtEnd);
3016 /// Provide fast operand accessors
3017 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3019 /// getNumArgOperands - Return the number of invoke arguments.
3021 unsigned getNumArgOperands() const { return getNumOperands() - 3; }
3023 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
3025 Value *getArgOperand(unsigned i) const { return getOperand(i); }
3026 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
3028 /// getCallingConv/setCallingConv - Get or set the calling convention of this
3030 CallingConv::ID getCallingConv() const {
3031 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
3033 void setCallingConv(CallingConv::ID CC) {
3034 setInstructionSubclassData(static_cast<unsigned>(CC));
3037 /// getAttributes - Return the parameter attributes for this invoke.
3039 const AttrListPtr &getAttributes() const { return AttributeList; }
3041 /// setAttributes - Set the parameter attributes for this invoke.
3043 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
3045 /// addAttribute - adds the attribute to the list of attributes.
3046 void addAttribute(unsigned i, Attributes attr);
3048 /// removeAttribute - removes the attribute from the list of attributes.
3049 void removeAttribute(unsigned i, Attributes attr);
3051 /// @brief Determine whether this call has the NoAlias attribute.
3052 bool fnHasNoAliasAttr() const;
3053 bool fnHasNoInlineAttr() const;
3054 bool fnHasNoReturnAttr() const;
3055 bool fnHasNoUnwindAttr() const;
3056 bool fnHasReadNoneAttr() const;
3057 bool fnHasReadOnlyAttr() const;
3058 bool fnHasReturnsTwiceAttr() const;
3060 /// \brief Return true if this call has the given attribute.
3061 bool hasFnAttr(Attributes N) const {
3062 return paramHasAttr(~0, N);
3065 /// @brief Determine whether the call or the callee has the given attributes.
3066 bool paramHasSExtAttr(unsigned i) const;
3067 bool paramHasZExtAttr(unsigned i) const;
3068 bool paramHasInRegAttr(unsigned i) const;
3069 bool paramHasStructRetAttr(unsigned i) const;
3070 bool paramHasNestAttr(unsigned i) const;
3071 bool paramHasByValAttr(unsigned i) const;
3072 bool paramHasNoAliasAttr(unsigned i) const;
3073 bool paramHasNoCaptureAttr(unsigned i) const;
3075 /// @brief Determine whether the call or the callee has the given attribute.
3076 bool paramHasAttr(unsigned i, Attributes attr) const;
3078 /// @brief Extract the alignment for a call or parameter (0=unknown).
3079 unsigned getParamAlignment(unsigned i) const {
3080 return AttributeList.getParamAlignment(i);
3083 /// @brief Return true if the call should not be inlined.
3084 bool isNoInline() const { return fnHasNoInlineAttr(); }
3085 void setIsNoInline(bool Value = true) {
3086 if (Value) addAttribute(~0, Attribute::NoInline);
3087 else removeAttribute(~0, Attribute::NoInline);
3090 /// @brief Determine if the call does not access memory.
3091 bool doesNotAccessMemory() const {
3092 return fnHasReadNoneAttr();
3094 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
3095 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
3096 else removeAttribute(~0, Attribute::ReadNone);
3099 /// @brief Determine if the call does not access or only reads memory.
3100 bool onlyReadsMemory() const {
3101 return doesNotAccessMemory() || fnHasReadOnlyAttr();
3103 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
3104 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
3105 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
3108 /// @brief Determine if the call cannot return.
3109 bool doesNotReturn() const { return fnHasNoReturnAttr(); }
3110 void setDoesNotReturn(bool DoesNotReturn = true) {
3111 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
3112 else removeAttribute(~0, Attribute::NoReturn);
3115 /// @brief Determine if the call cannot unwind.
3116 bool doesNotThrow() const { return fnHasNoUnwindAttr(); }
3117 void setDoesNotThrow(bool DoesNotThrow = true) {
3118 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
3119 else removeAttribute(~0, Attribute::NoUnwind);
3122 /// @brief Determine if the call returns a structure through first
3123 /// pointer argument.
3124 bool hasStructRetAttr() const {
3125 // Be friendly and also check the callee.
3126 return paramHasStructRetAttr(1);
3129 /// @brief Determine if any call argument is an aggregate passed by value.
3130 bool hasByValArgument() const {
3131 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
3134 /// getCalledFunction - Return the function called, or null if this is an
3135 /// indirect function invocation.
3137 Function *getCalledFunction() const {
3138 return dyn_cast<Function>(Op<-3>());
3141 /// getCalledValue - Get a pointer to the function that is invoked by this
3143 const Value *getCalledValue() const { return Op<-3>(); }
3144 Value *getCalledValue() { return Op<-3>(); }
3146 /// setCalledFunction - Set the function called.
3147 void setCalledFunction(Value* Fn) {
3151 // get*Dest - Return the destination basic blocks...
3152 BasicBlock *getNormalDest() const {
3153 return cast<BasicBlock>(Op<-2>());
3155 BasicBlock *getUnwindDest() const {
3156 return cast<BasicBlock>(Op<-1>());
3158 void setNormalDest(BasicBlock *B) {
3159 Op<-2>() = reinterpret_cast<Value*>(B);
3161 void setUnwindDest(BasicBlock *B) {
3162 Op<-1>() = reinterpret_cast<Value*>(B);
3165 /// getLandingPadInst - Get the landingpad instruction from the landing pad
3166 /// block (the unwind destination).
3167 LandingPadInst *getLandingPadInst() const;
3169 BasicBlock *getSuccessor(unsigned i) const {
3170 assert(i < 2 && "Successor # out of range for invoke!");
3171 return i == 0 ? getNormalDest() : getUnwindDest();
3174 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3175 assert(idx < 2 && "Successor # out of range for invoke!");
3176 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
3179 unsigned getNumSuccessors() const { return 2; }
3181 // Methods for support type inquiry through isa, cast, and dyn_cast:
3182 static inline bool classof(const InvokeInst *) { return true; }
3183 static inline bool classof(const Instruction *I) {
3184 return (I->getOpcode() == Instruction::Invoke);
3186 static inline bool classof(const Value *V) {
3187 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3191 virtual BasicBlock *getSuccessorV(unsigned idx) const;
3192 virtual unsigned getNumSuccessorsV() const;
3193 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3195 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3196 // method so that subclasses cannot accidentally use it.
3197 void setInstructionSubclassData(unsigned short D) {
3198 Instruction::setInstructionSubclassData(D);
3203 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
3206 InvokeInst::InvokeInst(Value *Func,
3207 BasicBlock *IfNormal, BasicBlock *IfException,
3208 ArrayRef<Value *> Args, unsigned Values,
3209 const Twine &NameStr, Instruction *InsertBefore)
3210 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3211 ->getElementType())->getReturnType(),
3212 Instruction::Invoke,
3213 OperandTraits<InvokeInst>::op_end(this) - Values,
3214 Values, InsertBefore) {
3215 init(Func, IfNormal, IfException, Args, NameStr);
3217 InvokeInst::InvokeInst(Value *Func,
3218 BasicBlock *IfNormal, BasicBlock *IfException,
3219 ArrayRef<Value *> Args, unsigned Values,
3220 const Twine &NameStr, BasicBlock *InsertAtEnd)
3221 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3222 ->getElementType())->getReturnType(),
3223 Instruction::Invoke,
3224 OperandTraits<InvokeInst>::op_end(this) - Values,
3225 Values, InsertAtEnd) {
3226 init(Func, IfNormal, IfException, Args, NameStr);
3229 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
3231 //===----------------------------------------------------------------------===//
3233 //===----------------------------------------------------------------------===//
3235 //===---------------------------------------------------------------------------
3236 /// ResumeInst - Resume the propagation of an exception.
3238 class ResumeInst : public TerminatorInst {
3239 ResumeInst(const ResumeInst &RI);
3241 explicit ResumeInst(Value *Exn, Instruction *InsertBefore=0);
3242 ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
3244 virtual ResumeInst *clone_impl() const;
3246 static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = 0) {
3247 return new(1) ResumeInst(Exn, InsertBefore);
3249 static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
3250 return new(1) ResumeInst(Exn, InsertAtEnd);
3253 /// Provide fast operand accessors
3254 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3256 /// Convenience accessor.
3257 Value *getValue() const { return Op<0>(); }
3259 unsigned getNumSuccessors() const { return 0; }
3261 // Methods for support type inquiry through isa, cast, and dyn_cast:
3262 static inline bool classof(const ResumeInst *) { return true; }
3263 static inline bool classof(const Instruction *I) {
3264 return I->getOpcode() == Instruction::Resume;
3266 static inline bool classof(const Value *V) {
3267 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3270 virtual BasicBlock *getSuccessorV(unsigned idx) const;
3271 virtual unsigned getNumSuccessorsV() const;
3272 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3276 struct OperandTraits<ResumeInst> :
3277 public FixedNumOperandTraits<ResumeInst, 1> {
3280 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
3282 //===----------------------------------------------------------------------===//
3283 // UnreachableInst Class
3284 //===----------------------------------------------------------------------===//
3286 //===---------------------------------------------------------------------------
3287 /// UnreachableInst - This function has undefined behavior. In particular, the
3288 /// presence of this instruction indicates some higher level knowledge that the
3289 /// end of the block cannot be reached.
3291 class UnreachableInst : public TerminatorInst {
3292 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
3294 virtual UnreachableInst *clone_impl() const;
3297 // allocate space for exactly zero operands
3298 void *operator new(size_t s) {
3299 return User::operator new(s, 0);
3301 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = 0);
3302 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
3304 unsigned getNumSuccessors() const { return 0; }
3306 // Methods for support type inquiry through isa, cast, and dyn_cast:
3307 static inline bool classof(const UnreachableInst *) { return true; }
3308 static inline bool classof(const Instruction *I) {
3309 return I->getOpcode() == Instruction::Unreachable;
3311 static inline bool classof(const Value *V) {
3312 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3315 virtual BasicBlock *getSuccessorV(unsigned idx) const;
3316 virtual unsigned getNumSuccessorsV() const;
3317 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
3320 //===----------------------------------------------------------------------===//
3322 //===----------------------------------------------------------------------===//
3324 /// @brief This class represents a truncation of integer types.
3325 class TruncInst : public CastInst {
3327 /// @brief Clone an identical TruncInst
3328 virtual TruncInst *clone_impl() const;
3331 /// @brief Constructor with insert-before-instruction semantics
3333 Value *S, ///< The value to be truncated
3334 Type *Ty, ///< The (smaller) type to truncate to
3335 const Twine &NameStr = "", ///< A name for the new instruction
3336 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3339 /// @brief Constructor with insert-at-end-of-block semantics
3341 Value *S, ///< The value to be truncated
3342 Type *Ty, ///< The (smaller) type to truncate to
3343 const Twine &NameStr, ///< A name for the new instruction
3344 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3347 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3348 static inline bool classof(const TruncInst *) { return true; }
3349 static inline bool classof(const Instruction *I) {
3350 return I->getOpcode() == Trunc;
3352 static inline bool classof(const Value *V) {
3353 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3357 //===----------------------------------------------------------------------===//
3359 //===----------------------------------------------------------------------===//
3361 /// @brief This class represents zero extension of integer types.
3362 class ZExtInst : public CastInst {
3364 /// @brief Clone an identical ZExtInst
3365 virtual ZExtInst *clone_impl() const;
3368 /// @brief Constructor with insert-before-instruction semantics
3370 Value *S, ///< The value to be zero extended
3371 Type *Ty, ///< The type to zero extend to
3372 const Twine &NameStr = "", ///< A name for the new instruction
3373 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3376 /// @brief Constructor with insert-at-end semantics.
3378 Value *S, ///< The value to be zero extended
3379 Type *Ty, ///< The type to zero extend to
3380 const Twine &NameStr, ///< A name for the new instruction
3381 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3384 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3385 static inline bool classof(const ZExtInst *) { return true; }
3386 static inline bool classof(const Instruction *I) {
3387 return I->getOpcode() == ZExt;
3389 static inline bool classof(const Value *V) {
3390 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3394 //===----------------------------------------------------------------------===//
3396 //===----------------------------------------------------------------------===//
3398 /// @brief This class represents a sign extension of integer types.
3399 class SExtInst : public CastInst {
3401 /// @brief Clone an identical SExtInst
3402 virtual SExtInst *clone_impl() const;
3405 /// @brief Constructor with insert-before-instruction semantics
3407 Value *S, ///< The value to be sign extended
3408 Type *Ty, ///< The type to sign extend to
3409 const Twine &NameStr = "", ///< A name for the new instruction
3410 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3413 /// @brief Constructor with insert-at-end-of-block semantics
3415 Value *S, ///< The value to be sign extended
3416 Type *Ty, ///< The type to sign extend to
3417 const Twine &NameStr, ///< A name for the new instruction
3418 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3421 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3422 static inline bool classof(const SExtInst *) { return true; }
3423 static inline bool classof(const Instruction *I) {
3424 return I->getOpcode() == SExt;
3426 static inline bool classof(const Value *V) {
3427 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3431 //===----------------------------------------------------------------------===//
3432 // FPTruncInst Class
3433 //===----------------------------------------------------------------------===//
3435 /// @brief This class represents a truncation of floating point types.
3436 class FPTruncInst : public CastInst {
3438 /// @brief Clone an identical FPTruncInst
3439 virtual FPTruncInst *clone_impl() const;
3442 /// @brief Constructor with insert-before-instruction semantics
3444 Value *S, ///< The value to be truncated
3445 Type *Ty, ///< The type to truncate to
3446 const Twine &NameStr = "", ///< A name for the new instruction
3447 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3450 /// @brief Constructor with insert-before-instruction semantics
3452 Value *S, ///< The value to be truncated
3453 Type *Ty, ///< The type to truncate to
3454 const Twine &NameStr, ///< A name for the new instruction
3455 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3458 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3459 static inline bool classof(const FPTruncInst *) { return true; }
3460 static inline bool classof(const Instruction *I) {
3461 return I->getOpcode() == FPTrunc;
3463 static inline bool classof(const Value *V) {
3464 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3468 //===----------------------------------------------------------------------===//
3470 //===----------------------------------------------------------------------===//
3472 /// @brief This class represents an extension of floating point types.
3473 class FPExtInst : public CastInst {
3475 /// @brief Clone an identical FPExtInst
3476 virtual FPExtInst *clone_impl() const;
3479 /// @brief Constructor with insert-before-instruction semantics
3481 Value *S, ///< The value to be extended
3482 Type *Ty, ///< The type to extend to
3483 const Twine &NameStr = "", ///< A name for the new instruction
3484 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3487 /// @brief Constructor with insert-at-end-of-block semantics
3489 Value *S, ///< The value to be extended
3490 Type *Ty, ///< The type to extend to
3491 const Twine &NameStr, ///< A name for the new instruction
3492 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3495 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3496 static inline bool classof(const FPExtInst *) { return true; }
3497 static inline bool classof(const Instruction *I) {
3498 return I->getOpcode() == FPExt;
3500 static inline bool classof(const Value *V) {
3501 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3505 //===----------------------------------------------------------------------===//
3507 //===----------------------------------------------------------------------===//
3509 /// @brief This class represents a cast unsigned integer to floating point.
3510 class UIToFPInst : public CastInst {
3512 /// @brief Clone an identical UIToFPInst
3513 virtual UIToFPInst *clone_impl() const;
3516 /// @brief Constructor with insert-before-instruction semantics
3518 Value *S, ///< The value to be converted
3519 Type *Ty, ///< The type to convert to
3520 const Twine &NameStr = "", ///< A name for the new instruction
3521 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3524 /// @brief Constructor with insert-at-end-of-block semantics
3526 Value *S, ///< The value to be converted
3527 Type *Ty, ///< The type to convert to
3528 const Twine &NameStr, ///< A name for the new instruction
3529 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3532 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3533 static inline bool classof(const UIToFPInst *) { return true; }
3534 static inline bool classof(const Instruction *I) {
3535 return I->getOpcode() == UIToFP;
3537 static inline bool classof(const Value *V) {
3538 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3542 //===----------------------------------------------------------------------===//
3544 //===----------------------------------------------------------------------===//
3546 /// @brief This class represents a cast from signed integer to floating point.
3547 class SIToFPInst : public CastInst {
3549 /// @brief Clone an identical SIToFPInst
3550 virtual SIToFPInst *clone_impl() const;
3553 /// @brief Constructor with insert-before-instruction semantics
3555 Value *S, ///< The value to be converted
3556 Type *Ty, ///< The type to convert to
3557 const Twine &NameStr = "", ///< A name for the new instruction
3558 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3561 /// @brief Constructor with insert-at-end-of-block semantics
3563 Value *S, ///< The value to be converted
3564 Type *Ty, ///< The type to convert to
3565 const Twine &NameStr, ///< A name for the new instruction
3566 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3569 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3570 static inline bool classof(const SIToFPInst *) { return true; }
3571 static inline bool classof(const Instruction *I) {
3572 return I->getOpcode() == SIToFP;
3574 static inline bool classof(const Value *V) {
3575 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3579 //===----------------------------------------------------------------------===//
3581 //===----------------------------------------------------------------------===//
3583 /// @brief This class represents a cast from floating point to unsigned integer
3584 class FPToUIInst : public CastInst {
3586 /// @brief Clone an identical FPToUIInst
3587 virtual FPToUIInst *clone_impl() const;
3590 /// @brief Constructor with insert-before-instruction semantics
3592 Value *S, ///< The value to be converted
3593 Type *Ty, ///< The type to convert to
3594 const Twine &NameStr = "", ///< A name for the new instruction
3595 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3598 /// @brief Constructor with insert-at-end-of-block semantics
3600 Value *S, ///< The value to be converted
3601 Type *Ty, ///< The type to convert to
3602 const Twine &NameStr, ///< A name for the new instruction
3603 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
3606 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3607 static inline bool classof(const FPToUIInst *) { return true; }
3608 static inline bool classof(const Instruction *I) {
3609 return I->getOpcode() == FPToUI;
3611 static inline bool classof(const Value *V) {
3612 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3616 //===----------------------------------------------------------------------===//
3618 //===----------------------------------------------------------------------===//
3620 /// @brief This class represents a cast from floating point to signed integer.
3621 class FPToSIInst : public CastInst {
3623 /// @brief Clone an identical FPToSIInst
3624 virtual FPToSIInst *clone_impl() const;
3627 /// @brief Constructor with insert-before-instruction semantics
3629 Value *S, ///< The value to be converted
3630 Type *Ty, ///< The type to convert to
3631 const Twine &NameStr = "", ///< A name for the new instruction
3632 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3635 /// @brief Constructor with insert-at-end-of-block semantics
3637 Value *S, ///< The value to be converted
3638 Type *Ty, ///< The type to convert to
3639 const Twine &NameStr, ///< A name for the new instruction
3640 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3643 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3644 static inline bool classof(const FPToSIInst *) { return true; }
3645 static inline bool classof(const Instruction *I) {
3646 return I->getOpcode() == FPToSI;
3648 static inline bool classof(const Value *V) {
3649 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3653 //===----------------------------------------------------------------------===//
3654 // IntToPtrInst Class
3655 //===----------------------------------------------------------------------===//
3657 /// @brief This class represents a cast from an integer to a pointer.
3658 class IntToPtrInst : public CastInst {
3660 /// @brief Constructor with insert-before-instruction semantics
3662 Value *S, ///< The value to be converted
3663 Type *Ty, ///< The type to convert to
3664 const Twine &NameStr = "", ///< A name for the new instruction
3665 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3668 /// @brief Constructor with insert-at-end-of-block semantics
3670 Value *S, ///< The value to be converted
3671 Type *Ty, ///< The type to convert to
3672 const Twine &NameStr, ///< A name for the new instruction
3673 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3676 /// @brief Clone an identical IntToPtrInst
3677 virtual IntToPtrInst *clone_impl() const;
3679 // Methods for support type inquiry through isa, cast, and dyn_cast:
3680 static inline bool classof(const IntToPtrInst *) { return true; }
3681 static inline bool classof(const Instruction *I) {
3682 return I->getOpcode() == IntToPtr;
3684 static inline bool classof(const Value *V) {
3685 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3689 //===----------------------------------------------------------------------===//
3690 // PtrToIntInst Class
3691 //===----------------------------------------------------------------------===//
3693 /// @brief This class represents a cast from a pointer to an integer
3694 class PtrToIntInst : public CastInst {
3696 /// @brief Clone an identical PtrToIntInst
3697 virtual PtrToIntInst *clone_impl() const;
3700 /// @brief Constructor with insert-before-instruction semantics
3702 Value *S, ///< The value to be converted
3703 Type *Ty, ///< The type to convert to
3704 const Twine &NameStr = "", ///< A name for the new instruction
3705 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3708 /// @brief Constructor with insert-at-end-of-block semantics
3710 Value *S, ///< The value to be converted
3711 Type *Ty, ///< The type to convert to
3712 const Twine &NameStr, ///< A name for the new instruction
3713 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3716 // Methods for support type inquiry through isa, cast, and dyn_cast:
3717 static inline bool classof(const PtrToIntInst *) { return true; }
3718 static inline bool classof(const Instruction *I) {
3719 return I->getOpcode() == PtrToInt;
3721 static inline bool classof(const Value *V) {
3722 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3726 //===----------------------------------------------------------------------===//
3727 // BitCastInst Class
3728 //===----------------------------------------------------------------------===//
3730 /// @brief This class represents a no-op cast from one type to another.
3731 class BitCastInst : public CastInst {
3733 /// @brief Clone an identical BitCastInst
3734 virtual BitCastInst *clone_impl() const;
3737 /// @brief Constructor with insert-before-instruction semantics
3739 Value *S, ///< The value to be casted
3740 Type *Ty, ///< The type to casted to
3741 const Twine &NameStr = "", ///< A name for the new instruction
3742 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3745 /// @brief Constructor with insert-at-end-of-block semantics
3747 Value *S, ///< The value to be casted
3748 Type *Ty, ///< The type to casted to
3749 const Twine &NameStr, ///< A name for the new instruction
3750 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3753 // Methods for support type inquiry through isa, cast, and dyn_cast:
3754 static inline bool classof(const BitCastInst *) { return true; }
3755 static inline bool classof(const Instruction *I) {
3756 return I->getOpcode() == BitCast;
3758 static inline bool classof(const Value *V) {
3759 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3763 } // End llvm namespace