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_IR_INSTRUCTIONS_H
17 #define LLVM_IR_INSTRUCTIONS_H
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/iterator_range.h"
22 #include "llvm/IR/Attributes.h"
23 #include "llvm/IR/CallingConv.h"
24 #include "llvm/IR/DerivedTypes.h"
25 #include "llvm/IR/Function.h"
26 #include "llvm/IR/InstrTypes.h"
27 #include "llvm/Support/ErrorHandling.h"
42 // Consume = 3, // Not specified yet.
46 SequentiallyConsistent = 7
49 enum SynchronizationScope {
54 /// Returns true if the ordering is at least as strong as acquire
55 /// (i.e. acquire, acq_rel or seq_cst)
56 inline bool isAtLeastAcquire(AtomicOrdering Ord) {
57 return (Ord == Acquire ||
58 Ord == AcquireRelease ||
59 Ord == SequentiallyConsistent);
62 /// Returns true if the ordering is at least as strong as release
63 /// (i.e. release, acq_rel or seq_cst)
64 inline bool isAtLeastRelease(AtomicOrdering Ord) {
65 return (Ord == Release ||
66 Ord == AcquireRelease ||
67 Ord == SequentiallyConsistent);
70 //===----------------------------------------------------------------------===//
72 //===----------------------------------------------------------------------===//
74 /// AllocaInst - an instruction to allocate memory on the stack
76 class AllocaInst : public UnaryInstruction {
80 // Note: Instruction needs to be a friend here to call cloneImpl.
81 friend class Instruction;
82 AllocaInst *cloneImpl() const;
85 explicit AllocaInst(Type *Ty, Value *ArraySize = nullptr,
86 const Twine &Name = "",
87 Instruction *InsertBefore = nullptr);
88 AllocaInst(Type *Ty, Value *ArraySize,
89 const Twine &Name, BasicBlock *InsertAtEnd);
91 AllocaInst(Type *Ty, const Twine &Name, Instruction *InsertBefore = nullptr);
92 AllocaInst(Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd);
94 AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
95 const Twine &Name = "", Instruction *InsertBefore = nullptr);
96 AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
97 const Twine &Name, BasicBlock *InsertAtEnd);
99 // Out of line virtual method, so the vtable, etc. has a home.
100 ~AllocaInst() override;
102 /// isArrayAllocation - Return true if there is an allocation size parameter
103 /// to the allocation instruction that is not 1.
105 bool isArrayAllocation() const;
107 /// getArraySize - Get the number of elements allocated. For a simple
108 /// allocation of a single element, this will return a constant 1 value.
110 const Value *getArraySize() const { return getOperand(0); }
111 Value *getArraySize() { return getOperand(0); }
113 /// getType - Overload to return most specific pointer type
115 PointerType *getType() const {
116 return cast<PointerType>(Instruction::getType());
119 /// getAllocatedType - Return the type that is being allocated by the
122 Type *getAllocatedType() const { return AllocatedType; }
123 /// \brief for use only in special circumstances that need to generically
124 /// transform a whole instruction (eg: IR linking and vectorization).
125 void setAllocatedType(Type *Ty) { AllocatedType = Ty; }
127 /// getAlignment - Return the alignment of the memory that is being allocated
128 /// by the instruction.
130 unsigned getAlignment() const {
131 return (1u << (getSubclassDataFromInstruction() & 31)) >> 1;
133 void setAlignment(unsigned Align);
135 /// isStaticAlloca - Return true if this alloca is in the entry block of the
136 /// function and is a constant size. If so, the code generator will fold it
137 /// into the prolog/epilog code, so it is basically free.
138 bool isStaticAlloca() const;
140 /// \brief Return true if this alloca is used as an inalloca argument to a
141 /// call. Such allocas are never considered static even if they are in the
143 bool isUsedWithInAlloca() const {
144 return getSubclassDataFromInstruction() & 32;
147 /// \brief Specify whether this alloca is used to represent the arguments to
149 void setUsedWithInAlloca(bool V) {
150 setInstructionSubclassData((getSubclassDataFromInstruction() & ~32) |
154 // Methods for support type inquiry through isa, cast, and dyn_cast:
155 static inline bool classof(const Instruction *I) {
156 return (I->getOpcode() == Instruction::Alloca);
158 static inline bool classof(const Value *V) {
159 return isa<Instruction>(V) && classof(cast<Instruction>(V));
163 // Shadow Instruction::setInstructionSubclassData with a private forwarding
164 // method so that subclasses cannot accidentally use it.
165 void setInstructionSubclassData(unsigned short D) {
166 Instruction::setInstructionSubclassData(D);
170 //===----------------------------------------------------------------------===//
172 //===----------------------------------------------------------------------===//
174 /// LoadInst - an instruction for reading from memory. This uses the
175 /// SubclassData field in Value to store whether or not the load is volatile.
177 class LoadInst : public UnaryInstruction {
181 // Note: Instruction needs to be a friend here to call cloneImpl.
182 friend class Instruction;
183 LoadInst *cloneImpl() const;
186 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
187 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
188 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile = false,
189 Instruction *InsertBefore = nullptr);
190 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
191 Instruction *InsertBefore = nullptr)
192 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
193 NameStr, isVolatile, InsertBefore) {}
194 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
195 BasicBlock *InsertAtEnd);
196 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile, unsigned Align,
197 Instruction *InsertBefore = nullptr)
198 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
199 NameStr, isVolatile, Align, InsertBefore) {}
200 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
201 unsigned Align, Instruction *InsertBefore = nullptr);
202 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
203 unsigned Align, BasicBlock *InsertAtEnd);
204 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile, unsigned Align,
205 AtomicOrdering Order, SynchronizationScope SynchScope = CrossThread,
206 Instruction *InsertBefore = nullptr)
207 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
208 NameStr, isVolatile, Align, Order, SynchScope, InsertBefore) {}
209 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
210 unsigned Align, AtomicOrdering Order,
211 SynchronizationScope SynchScope = CrossThread,
212 Instruction *InsertBefore = nullptr);
213 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
214 unsigned Align, AtomicOrdering Order,
215 SynchronizationScope SynchScope,
216 BasicBlock *InsertAtEnd);
218 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
219 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
220 LoadInst(Type *Ty, Value *Ptr, const char *NameStr = nullptr,
221 bool isVolatile = false, Instruction *InsertBefore = nullptr);
222 explicit LoadInst(Value *Ptr, const char *NameStr = nullptr,
223 bool isVolatile = false,
224 Instruction *InsertBefore = nullptr)
225 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
226 NameStr, isVolatile, InsertBefore) {}
227 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
228 BasicBlock *InsertAtEnd);
230 /// isVolatile - Return true if this is a load from a volatile memory
233 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
235 /// setVolatile - Specify whether this is a volatile load or not.
237 void setVolatile(bool V) {
238 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
242 /// getAlignment - Return the alignment of the access that is being performed
244 unsigned getAlignment() const {
245 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
248 void setAlignment(unsigned Align);
250 /// Returns the ordering effect of this fence.
251 AtomicOrdering getOrdering() const {
252 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
255 /// Set the ordering constraint on this load. May not be Release or
257 void setOrdering(AtomicOrdering Ordering) {
258 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
262 SynchronizationScope getSynchScope() const {
263 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
266 /// Specify whether this load is ordered with respect to all
267 /// concurrently executing threads, or only with respect to signal handlers
268 /// executing in the same thread.
269 void setSynchScope(SynchronizationScope xthread) {
270 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
274 void setAtomic(AtomicOrdering Ordering,
275 SynchronizationScope SynchScope = CrossThread) {
276 setOrdering(Ordering);
277 setSynchScope(SynchScope);
280 bool isSimple() const { return !isAtomic() && !isVolatile(); }
281 bool isUnordered() const {
282 return getOrdering() <= Unordered && !isVolatile();
285 Value *getPointerOperand() { return getOperand(0); }
286 const Value *getPointerOperand() const { return getOperand(0); }
287 static unsigned getPointerOperandIndex() { return 0U; }
289 /// \brief Returns the address space of the pointer operand.
290 unsigned getPointerAddressSpace() const {
291 return getPointerOperand()->getType()->getPointerAddressSpace();
294 // Methods for support type inquiry through isa, cast, and dyn_cast:
295 static inline bool classof(const Instruction *I) {
296 return I->getOpcode() == Instruction::Load;
298 static inline bool classof(const Value *V) {
299 return isa<Instruction>(V) && classof(cast<Instruction>(V));
303 // Shadow Instruction::setInstructionSubclassData with a private forwarding
304 // method so that subclasses cannot accidentally use it.
305 void setInstructionSubclassData(unsigned short D) {
306 Instruction::setInstructionSubclassData(D);
310 //===----------------------------------------------------------------------===//
312 //===----------------------------------------------------------------------===//
314 /// StoreInst - an instruction for storing to memory
316 class StoreInst : public Instruction {
317 void *operator new(size_t, unsigned) = delete;
321 // Note: Instruction needs to be a friend here to call cloneImpl.
322 friend class Instruction;
323 StoreInst *cloneImpl() const;
326 // allocate space for exactly two operands
327 void *operator new(size_t s) {
328 return User::operator new(s, 2);
330 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
331 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
332 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
333 Instruction *InsertBefore = nullptr);
334 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
335 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
336 unsigned Align, Instruction *InsertBefore = nullptr);
337 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
338 unsigned Align, BasicBlock *InsertAtEnd);
339 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
340 unsigned Align, AtomicOrdering Order,
341 SynchronizationScope SynchScope = CrossThread,
342 Instruction *InsertBefore = nullptr);
343 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
344 unsigned Align, AtomicOrdering Order,
345 SynchronizationScope SynchScope,
346 BasicBlock *InsertAtEnd);
348 /// isVolatile - Return true if this is a store to a volatile memory
351 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
353 /// setVolatile - Specify whether this is a volatile store or not.
355 void setVolatile(bool V) {
356 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
360 /// Transparently provide more efficient getOperand methods.
361 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
363 /// getAlignment - Return the alignment of the access that is being performed
365 unsigned getAlignment() const {
366 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
369 void setAlignment(unsigned Align);
371 /// Returns the ordering effect of this store.
372 AtomicOrdering getOrdering() const {
373 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
376 /// Set the ordering constraint on this store. May not be Acquire or
378 void setOrdering(AtomicOrdering Ordering) {
379 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
383 SynchronizationScope getSynchScope() const {
384 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
387 /// Specify whether this store instruction is ordered with respect to all
388 /// concurrently executing threads, or only with respect to signal handlers
389 /// executing in the same thread.
390 void setSynchScope(SynchronizationScope xthread) {
391 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
395 void setAtomic(AtomicOrdering Ordering,
396 SynchronizationScope SynchScope = CrossThread) {
397 setOrdering(Ordering);
398 setSynchScope(SynchScope);
401 bool isSimple() const { return !isAtomic() && !isVolatile(); }
402 bool isUnordered() const {
403 return getOrdering() <= Unordered && !isVolatile();
406 Value *getValueOperand() { return getOperand(0); }
407 const Value *getValueOperand() const { return getOperand(0); }
409 Value *getPointerOperand() { return getOperand(1); }
410 const Value *getPointerOperand() const { return getOperand(1); }
411 static unsigned getPointerOperandIndex() { return 1U; }
413 /// \brief Returns the address space of the pointer operand.
414 unsigned getPointerAddressSpace() const {
415 return getPointerOperand()->getType()->getPointerAddressSpace();
418 // Methods for support type inquiry through isa, cast, and dyn_cast:
419 static inline bool classof(const Instruction *I) {
420 return I->getOpcode() == Instruction::Store;
422 static inline bool classof(const Value *V) {
423 return isa<Instruction>(V) && classof(cast<Instruction>(V));
427 // Shadow Instruction::setInstructionSubclassData with a private forwarding
428 // method so that subclasses cannot accidentally use it.
429 void setInstructionSubclassData(unsigned short D) {
430 Instruction::setInstructionSubclassData(D);
435 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
438 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
440 //===----------------------------------------------------------------------===//
442 //===----------------------------------------------------------------------===//
444 /// FenceInst - an instruction for ordering other memory operations
446 class FenceInst : public Instruction {
447 void *operator new(size_t, unsigned) = delete;
448 void Init(AtomicOrdering Ordering, SynchronizationScope SynchScope);
451 // Note: Instruction needs to be a friend here to call cloneImpl.
452 friend class Instruction;
453 FenceInst *cloneImpl() const;
456 // allocate space for exactly zero operands
457 void *operator new(size_t s) {
458 return User::operator new(s, 0);
461 // Ordering may only be Acquire, Release, AcquireRelease, or
462 // SequentiallyConsistent.
463 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
464 SynchronizationScope SynchScope = CrossThread,
465 Instruction *InsertBefore = nullptr);
466 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
467 SynchronizationScope SynchScope,
468 BasicBlock *InsertAtEnd);
470 /// Returns the ordering effect of this fence.
471 AtomicOrdering getOrdering() const {
472 return AtomicOrdering(getSubclassDataFromInstruction() >> 1);
475 /// Set the ordering constraint on this fence. May only be Acquire, Release,
476 /// AcquireRelease, or SequentiallyConsistent.
477 void setOrdering(AtomicOrdering Ordering) {
478 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
482 SynchronizationScope getSynchScope() const {
483 return SynchronizationScope(getSubclassDataFromInstruction() & 1);
486 /// Specify whether this fence orders other operations with respect to all
487 /// concurrently executing threads, or only with respect to signal handlers
488 /// executing in the same thread.
489 void setSynchScope(SynchronizationScope xthread) {
490 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
494 // Methods for support type inquiry through isa, cast, and dyn_cast:
495 static inline bool classof(const Instruction *I) {
496 return I->getOpcode() == Instruction::Fence;
498 static inline bool classof(const Value *V) {
499 return isa<Instruction>(V) && classof(cast<Instruction>(V));
503 // Shadow Instruction::setInstructionSubclassData with a private forwarding
504 // method so that subclasses cannot accidentally use it.
505 void setInstructionSubclassData(unsigned short D) {
506 Instruction::setInstructionSubclassData(D);
510 //===----------------------------------------------------------------------===//
511 // AtomicCmpXchgInst Class
512 //===----------------------------------------------------------------------===//
514 /// AtomicCmpXchgInst - an instruction that atomically checks whether a
515 /// specified value is in a memory location, and, if it is, stores a new value
516 /// there. Returns the value that was loaded.
518 class AtomicCmpXchgInst : public Instruction {
519 void *operator new(size_t, unsigned) = delete;
520 void Init(Value *Ptr, Value *Cmp, Value *NewVal,
521 AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering,
522 SynchronizationScope SynchScope);
525 // Note: Instruction needs to be a friend here to call cloneImpl.
526 friend class Instruction;
527 AtomicCmpXchgInst *cloneImpl() const;
530 // allocate space for exactly three operands
531 void *operator new(size_t s) {
532 return User::operator new(s, 3);
534 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
535 AtomicOrdering SuccessOrdering,
536 AtomicOrdering FailureOrdering,
537 SynchronizationScope SynchScope,
538 Instruction *InsertBefore = nullptr);
539 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
540 AtomicOrdering SuccessOrdering,
541 AtomicOrdering FailureOrdering,
542 SynchronizationScope SynchScope,
543 BasicBlock *InsertAtEnd);
545 /// isVolatile - Return true if this is a cmpxchg from a volatile memory
548 bool isVolatile() const {
549 return getSubclassDataFromInstruction() & 1;
552 /// setVolatile - Specify whether this is a volatile cmpxchg.
554 void setVolatile(bool V) {
555 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
559 /// Return true if this cmpxchg may spuriously fail.
560 bool isWeak() const {
561 return getSubclassDataFromInstruction() & 0x100;
564 void setWeak(bool IsWeak) {
565 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x100) |
569 /// Transparently provide more efficient getOperand methods.
570 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
572 /// Set the ordering constraint on this cmpxchg.
573 void setSuccessOrdering(AtomicOrdering Ordering) {
574 assert(Ordering != NotAtomic &&
575 "CmpXchg instructions can only be atomic.");
576 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x1c) |
580 void setFailureOrdering(AtomicOrdering Ordering) {
581 assert(Ordering != NotAtomic &&
582 "CmpXchg instructions can only be atomic.");
583 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0xe0) |
587 /// Specify whether this cmpxchg is atomic and orders other operations with
588 /// respect to all concurrently executing threads, or only with respect to
589 /// signal handlers executing in the same thread.
590 void setSynchScope(SynchronizationScope SynchScope) {
591 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
595 /// Returns the ordering constraint on this cmpxchg.
596 AtomicOrdering getSuccessOrdering() const {
597 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
600 /// Returns the ordering constraint on this cmpxchg.
601 AtomicOrdering getFailureOrdering() const {
602 return AtomicOrdering((getSubclassDataFromInstruction() >> 5) & 7);
605 /// Returns whether this cmpxchg is atomic between threads or only within a
607 SynchronizationScope getSynchScope() const {
608 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
611 Value *getPointerOperand() { return getOperand(0); }
612 const Value *getPointerOperand() const { return getOperand(0); }
613 static unsigned getPointerOperandIndex() { return 0U; }
615 Value *getCompareOperand() { return getOperand(1); }
616 const Value *getCompareOperand() const { return getOperand(1); }
618 Value *getNewValOperand() { return getOperand(2); }
619 const Value *getNewValOperand() const { return getOperand(2); }
621 /// \brief Returns the address space of the pointer operand.
622 unsigned getPointerAddressSpace() const {
623 return getPointerOperand()->getType()->getPointerAddressSpace();
626 /// \brief Returns the strongest permitted ordering on failure, given the
627 /// desired ordering on success.
629 /// If the comparison in a cmpxchg operation fails, there is no atomic store
630 /// so release semantics cannot be provided. So this function drops explicit
631 /// Release requests from the AtomicOrdering. A SequentiallyConsistent
632 /// operation would remain SequentiallyConsistent.
633 static AtomicOrdering
634 getStrongestFailureOrdering(AtomicOrdering SuccessOrdering) {
635 switch (SuccessOrdering) {
636 default: llvm_unreachable("invalid cmpxchg success ordering");
643 case SequentiallyConsistent:
644 return SequentiallyConsistent;
648 // Methods for support type inquiry through isa, cast, and dyn_cast:
649 static inline bool classof(const Instruction *I) {
650 return I->getOpcode() == Instruction::AtomicCmpXchg;
652 static inline bool classof(const Value *V) {
653 return isa<Instruction>(V) && classof(cast<Instruction>(V));
657 // Shadow Instruction::setInstructionSubclassData with a private forwarding
658 // method so that subclasses cannot accidentally use it.
659 void setInstructionSubclassData(unsigned short D) {
660 Instruction::setInstructionSubclassData(D);
665 struct OperandTraits<AtomicCmpXchgInst> :
666 public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
669 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)
671 //===----------------------------------------------------------------------===//
672 // AtomicRMWInst Class
673 //===----------------------------------------------------------------------===//
675 /// AtomicRMWInst - an instruction that atomically reads a memory location,
676 /// combines it with another value, and then stores the result back. Returns
679 class AtomicRMWInst : public Instruction {
680 void *operator new(size_t, unsigned) = delete;
683 // Note: Instruction needs to be a friend here to call cloneImpl.
684 friend class Instruction;
685 AtomicRMWInst *cloneImpl() const;
688 /// This enumeration lists the possible modifications atomicrmw can make. In
689 /// the descriptions, 'p' is the pointer to the instruction's memory location,
690 /// 'old' is the initial value of *p, and 'v' is the other value passed to the
691 /// instruction. These instructions always return 'old'.
707 /// *p = old >signed v ? old : v
709 /// *p = old <signed v ? old : v
711 /// *p = old >unsigned v ? old : v
713 /// *p = old <unsigned v ? old : v
721 // allocate space for exactly two operands
722 void *operator new(size_t s) {
723 return User::operator new(s, 2);
725 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
726 AtomicOrdering Ordering, SynchronizationScope SynchScope,
727 Instruction *InsertBefore = nullptr);
728 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
729 AtomicOrdering Ordering, SynchronizationScope SynchScope,
730 BasicBlock *InsertAtEnd);
732 BinOp getOperation() const {
733 return static_cast<BinOp>(getSubclassDataFromInstruction() >> 5);
736 void setOperation(BinOp Operation) {
737 unsigned short SubclassData = getSubclassDataFromInstruction();
738 setInstructionSubclassData((SubclassData & 31) |
742 /// isVolatile - Return true if this is a RMW on a volatile memory location.
744 bool isVolatile() const {
745 return getSubclassDataFromInstruction() & 1;
748 /// setVolatile - Specify whether this is a volatile RMW or not.
750 void setVolatile(bool V) {
751 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
755 /// Transparently provide more efficient getOperand methods.
756 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
758 /// Set the ordering constraint on this RMW.
759 void setOrdering(AtomicOrdering Ordering) {
760 assert(Ordering != NotAtomic &&
761 "atomicrmw instructions can only be atomic.");
762 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 2)) |
766 /// Specify whether this RMW orders other operations with respect to all
767 /// concurrently executing threads, or only with respect to signal handlers
768 /// executing in the same thread.
769 void setSynchScope(SynchronizationScope SynchScope) {
770 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
774 /// Returns the ordering constraint on this RMW.
775 AtomicOrdering getOrdering() const {
776 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
779 /// Returns whether this RMW is atomic between threads or only within a
781 SynchronizationScope getSynchScope() const {
782 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
785 Value *getPointerOperand() { return getOperand(0); }
786 const Value *getPointerOperand() const { return getOperand(0); }
787 static unsigned getPointerOperandIndex() { return 0U; }
789 Value *getValOperand() { return getOperand(1); }
790 const Value *getValOperand() const { return getOperand(1); }
792 /// \brief Returns the address space of the pointer operand.
793 unsigned getPointerAddressSpace() const {
794 return getPointerOperand()->getType()->getPointerAddressSpace();
797 // Methods for support type inquiry through isa, cast, and dyn_cast:
798 static inline bool classof(const Instruction *I) {
799 return I->getOpcode() == Instruction::AtomicRMW;
801 static inline bool classof(const Value *V) {
802 return isa<Instruction>(V) && classof(cast<Instruction>(V));
806 void Init(BinOp Operation, Value *Ptr, Value *Val,
807 AtomicOrdering Ordering, SynchronizationScope SynchScope);
808 // Shadow Instruction::setInstructionSubclassData with a private forwarding
809 // method so that subclasses cannot accidentally use it.
810 void setInstructionSubclassData(unsigned short D) {
811 Instruction::setInstructionSubclassData(D);
816 struct OperandTraits<AtomicRMWInst>
817 : public FixedNumOperandTraits<AtomicRMWInst,2> {
820 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)
822 //===----------------------------------------------------------------------===//
823 // GetElementPtrInst Class
824 //===----------------------------------------------------------------------===//
826 // checkGEPType - Simple wrapper function to give a better assertion failure
827 // message on bad indexes for a gep instruction.
829 inline Type *checkGEPType(Type *Ty) {
830 assert(Ty && "Invalid GetElementPtrInst indices for type!");
834 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
835 /// access elements of arrays and structs
837 class GetElementPtrInst : public Instruction {
838 Type *SourceElementType;
839 Type *ResultElementType;
841 GetElementPtrInst(const GetElementPtrInst &GEPI);
842 void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
844 /// Constructors - Create a getelementptr instruction with a base pointer an
845 /// list of indices. The first ctor can optionally insert before an existing
846 /// instruction, the second appends the new instruction to the specified
848 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
849 ArrayRef<Value *> IdxList, unsigned Values,
850 const Twine &NameStr, Instruction *InsertBefore);
851 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
852 ArrayRef<Value *> IdxList, unsigned Values,
853 const Twine &NameStr, BasicBlock *InsertAtEnd);
856 // Note: Instruction needs to be a friend here to call cloneImpl.
857 friend class Instruction;
858 GetElementPtrInst *cloneImpl() const;
861 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
862 ArrayRef<Value *> IdxList,
863 const Twine &NameStr = "",
864 Instruction *InsertBefore = nullptr) {
865 unsigned Values = 1 + unsigned(IdxList.size());
868 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
872 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
873 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
874 NameStr, InsertBefore);
876 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
877 ArrayRef<Value *> IdxList,
878 const Twine &NameStr,
879 BasicBlock *InsertAtEnd) {
880 unsigned Values = 1 + unsigned(IdxList.size());
883 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
887 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
888 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
889 NameStr, InsertAtEnd);
892 /// Create an "inbounds" getelementptr. See the documentation for the
893 /// "inbounds" flag in LangRef.html for details.
894 static GetElementPtrInst *CreateInBounds(Value *Ptr,
895 ArrayRef<Value *> IdxList,
896 const Twine &NameStr = "",
897 Instruction *InsertBefore = nullptr){
898 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertBefore);
900 static GetElementPtrInst *
901 CreateInBounds(Type *PointeeType, Value *Ptr, ArrayRef<Value *> IdxList,
902 const Twine &NameStr = "",
903 Instruction *InsertBefore = nullptr) {
904 GetElementPtrInst *GEP =
905 Create(PointeeType, Ptr, IdxList, NameStr, InsertBefore);
906 GEP->setIsInBounds(true);
909 static GetElementPtrInst *CreateInBounds(Value *Ptr,
910 ArrayRef<Value *> IdxList,
911 const Twine &NameStr,
912 BasicBlock *InsertAtEnd) {
913 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertAtEnd);
915 static GetElementPtrInst *CreateInBounds(Type *PointeeType, Value *Ptr,
916 ArrayRef<Value *> IdxList,
917 const Twine &NameStr,
918 BasicBlock *InsertAtEnd) {
919 GetElementPtrInst *GEP =
920 Create(PointeeType, Ptr, IdxList, NameStr, InsertAtEnd);
921 GEP->setIsInBounds(true);
925 /// Transparently provide more efficient getOperand methods.
926 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
928 // getType - Overload to return most specific sequential type.
929 SequentialType *getType() const {
930 return cast<SequentialType>(Instruction::getType());
933 Type *getSourceElementType() const { return SourceElementType; }
935 void setSourceElementType(Type *Ty) { SourceElementType = Ty; }
936 void setResultElementType(Type *Ty) { ResultElementType = Ty; }
938 Type *getResultElementType() const {
939 assert(ResultElementType ==
940 cast<PointerType>(getType()->getScalarType())->getElementType());
941 return ResultElementType;
944 /// \brief Returns the address space of this instruction's pointer type.
945 unsigned getAddressSpace() const {
946 // Note that this is always the same as the pointer operand's address space
947 // and that is cheaper to compute, so cheat here.
948 return getPointerAddressSpace();
951 /// getIndexedType - Returns the type of the element that would be loaded with
952 /// a load instruction with the specified parameters.
954 /// Null is returned if the indices are invalid for the specified
957 static Type *getIndexedType(Type *Ty, ArrayRef<Value *> IdxList);
958 static Type *getIndexedType(Type *Ty, ArrayRef<Constant *> IdxList);
959 static Type *getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList);
961 inline op_iterator idx_begin() { return op_begin()+1; }
962 inline const_op_iterator idx_begin() const { return op_begin()+1; }
963 inline op_iterator idx_end() { return op_end(); }
964 inline const_op_iterator idx_end() const { return op_end(); }
966 Value *getPointerOperand() {
967 return getOperand(0);
969 const Value *getPointerOperand() const {
970 return getOperand(0);
972 static unsigned getPointerOperandIndex() {
973 return 0U; // get index for modifying correct operand.
976 /// getPointerOperandType - Method to return the pointer operand as a
978 Type *getPointerOperandType() const {
979 return getPointerOperand()->getType();
982 /// \brief Returns the address space of the pointer operand.
983 unsigned getPointerAddressSpace() const {
984 return getPointerOperandType()->getPointerAddressSpace();
987 /// GetGEPReturnType - Returns the pointer type returned by the GEP
988 /// instruction, which may be a vector of pointers.
989 static Type *getGEPReturnType(Value *Ptr, ArrayRef<Value *> IdxList) {
990 return getGEPReturnType(
991 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType(),
994 static Type *getGEPReturnType(Type *ElTy, Value *Ptr,
995 ArrayRef<Value *> IdxList) {
996 Type *PtrTy = PointerType::get(checkGEPType(getIndexedType(ElTy, IdxList)),
997 Ptr->getType()->getPointerAddressSpace());
999 if (Ptr->getType()->isVectorTy()) {
1000 unsigned NumElem = Ptr->getType()->getVectorNumElements();
1001 return VectorType::get(PtrTy, NumElem);
1003 for (Value *Index : IdxList)
1004 if (Index->getType()->isVectorTy()) {
1005 unsigned NumElem = Index->getType()->getVectorNumElements();
1006 return VectorType::get(PtrTy, NumElem);
1012 unsigned getNumIndices() const { // Note: always non-negative
1013 return getNumOperands() - 1;
1016 bool hasIndices() const {
1017 return getNumOperands() > 1;
1020 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
1021 /// zeros. If so, the result pointer and the first operand have the same
1022 /// value, just potentially different types.
1023 bool hasAllZeroIndices() const;
1025 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
1026 /// constant integers. If so, the result pointer and the first operand have
1027 /// a constant offset between them.
1028 bool hasAllConstantIndices() const;
1030 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
1031 /// See LangRef.html for the meaning of inbounds on a getelementptr.
1032 void setIsInBounds(bool b = true);
1034 /// isInBounds - Determine whether the GEP has the inbounds flag.
1035 bool isInBounds() const;
1037 /// \brief Accumulate the constant address offset of this GEP if possible.
1039 /// This routine accepts an APInt into which it will accumulate the constant
1040 /// offset of this GEP if the GEP is in fact constant. If the GEP is not
1041 /// all-constant, it returns false and the value of the offset APInt is
1042 /// undefined (it is *not* preserved!). The APInt passed into this routine
1043 /// must be at least as wide as the IntPtr type for the address space of
1044 /// the base GEP pointer.
1045 bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const;
1047 // Methods for support type inquiry through isa, cast, and dyn_cast:
1048 static inline bool classof(const Instruction *I) {
1049 return (I->getOpcode() == Instruction::GetElementPtr);
1051 static inline bool classof(const Value *V) {
1052 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1057 struct OperandTraits<GetElementPtrInst> :
1058 public VariadicOperandTraits<GetElementPtrInst, 1> {
1061 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1062 ArrayRef<Value *> IdxList, unsigned Values,
1063 const Twine &NameStr,
1064 Instruction *InsertBefore)
1065 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1066 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1067 Values, InsertBefore),
1068 SourceElementType(PointeeType),
1069 ResultElementType(getIndexedType(PointeeType, IdxList)) {
1070 assert(ResultElementType ==
1071 cast<PointerType>(getType()->getScalarType())->getElementType());
1072 init(Ptr, IdxList, NameStr);
1074 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1075 ArrayRef<Value *> IdxList, unsigned Values,
1076 const Twine &NameStr,
1077 BasicBlock *InsertAtEnd)
1078 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1079 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1080 Values, InsertAtEnd),
1081 SourceElementType(PointeeType),
1082 ResultElementType(getIndexedType(PointeeType, IdxList)) {
1083 assert(ResultElementType ==
1084 cast<PointerType>(getType()->getScalarType())->getElementType());
1085 init(Ptr, IdxList, NameStr);
1088 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
1090 //===----------------------------------------------------------------------===//
1092 //===----------------------------------------------------------------------===//
1094 /// This instruction compares its operands according to the predicate given
1095 /// to the constructor. It only operates on integers or pointers. The operands
1096 /// must be identical types.
1097 /// \brief Represent an integer comparison operator.
1098 class ICmpInst: public CmpInst {
1100 assert(getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
1101 getPredicate() <= CmpInst::LAST_ICMP_PREDICATE &&
1102 "Invalid ICmp predicate value");
1103 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1104 "Both operands to ICmp instruction are not of the same type!");
1105 // Check that the operands are the right type
1106 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
1107 getOperand(0)->getType()->isPtrOrPtrVectorTy()) &&
1108 "Invalid operand types for ICmp instruction");
1112 // Note: Instruction needs to be a friend here to call cloneImpl.
1113 friend class Instruction;
1114 /// \brief Clone an identical ICmpInst
1115 ICmpInst *cloneImpl() const;
1118 /// \brief Constructor with insert-before-instruction semantics.
1120 Instruction *InsertBefore, ///< Where to insert
1121 Predicate pred, ///< The predicate to use for the comparison
1122 Value *LHS, ///< The left-hand-side of the expression
1123 Value *RHS, ///< The right-hand-side of the expression
1124 const Twine &NameStr = "" ///< Name of the instruction
1125 ) : CmpInst(makeCmpResultType(LHS->getType()),
1126 Instruction::ICmp, pred, LHS, RHS, NameStr,
1133 /// \brief Constructor with insert-at-end semantics.
1135 BasicBlock &InsertAtEnd, ///< Block to insert into.
1136 Predicate pred, ///< The predicate to use for the comparison
1137 Value *LHS, ///< The left-hand-side of the expression
1138 Value *RHS, ///< The right-hand-side of the expression
1139 const Twine &NameStr = "" ///< Name of the instruction
1140 ) : CmpInst(makeCmpResultType(LHS->getType()),
1141 Instruction::ICmp, pred, LHS, RHS, NameStr,
1148 /// \brief Constructor with no-insertion semantics
1150 Predicate pred, ///< The predicate to use for the comparison
1151 Value *LHS, ///< The left-hand-side of the expression
1152 Value *RHS, ///< The right-hand-side of the expression
1153 const Twine &NameStr = "" ///< Name of the instruction
1154 ) : CmpInst(makeCmpResultType(LHS->getType()),
1155 Instruction::ICmp, pred, LHS, RHS, NameStr) {
1161 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
1162 /// @returns the predicate that would be the result if the operand were
1163 /// regarded as signed.
1164 /// \brief Return the signed version of the predicate
1165 Predicate getSignedPredicate() const {
1166 return getSignedPredicate(getPredicate());
1169 /// This is a static version that you can use without an instruction.
1170 /// \brief Return the signed version of the predicate.
1171 static Predicate getSignedPredicate(Predicate pred);
1173 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
1174 /// @returns the predicate that would be the result if the operand were
1175 /// regarded as unsigned.
1176 /// \brief Return the unsigned version of the predicate
1177 Predicate getUnsignedPredicate() const {
1178 return getUnsignedPredicate(getPredicate());
1181 /// This is a static version that you can use without an instruction.
1182 /// \brief Return the unsigned version of the predicate.
1183 static Predicate getUnsignedPredicate(Predicate pred);
1185 /// isEquality - Return true if this predicate is either EQ or NE. This also
1186 /// tests for commutativity.
1187 static bool isEquality(Predicate P) {
1188 return P == ICMP_EQ || P == ICMP_NE;
1191 /// isEquality - Return true if this predicate is either EQ or NE. This also
1192 /// tests for commutativity.
1193 bool isEquality() const {
1194 return isEquality(getPredicate());
1197 /// @returns true if the predicate of this ICmpInst is commutative
1198 /// \brief Determine if this relation is commutative.
1199 bool isCommutative() const { return isEquality(); }
1201 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1203 bool isRelational() const {
1204 return !isEquality();
1207 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1209 static bool isRelational(Predicate P) {
1210 return !isEquality(P);
1213 /// Initialize a set of values that all satisfy the predicate with C.
1214 /// \brief Make a ConstantRange for a relation with a constant value.
1215 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
1217 /// Exchange the two operands to this instruction in such a way that it does
1218 /// not modify the semantics of the instruction. The predicate value may be
1219 /// changed to retain the same result if the predicate is order dependent
1221 /// \brief Swap operands and adjust predicate.
1222 void swapOperands() {
1223 setPredicate(getSwappedPredicate());
1224 Op<0>().swap(Op<1>());
1227 // Methods for support type inquiry through isa, cast, and dyn_cast:
1228 static inline bool classof(const Instruction *I) {
1229 return I->getOpcode() == Instruction::ICmp;
1231 static inline bool classof(const Value *V) {
1232 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1236 //===----------------------------------------------------------------------===//
1238 //===----------------------------------------------------------------------===//
1240 /// This instruction compares its operands according to the predicate given
1241 /// to the constructor. It only operates on floating point values or packed
1242 /// vectors of floating point values. The operands must be identical types.
1243 /// \brief Represents a floating point comparison operator.
1244 class FCmpInst: public CmpInst {
1246 // Note: Instruction needs to be a friend here to call cloneImpl.
1247 friend class Instruction;
1248 /// \brief Clone an identical FCmpInst
1249 FCmpInst *cloneImpl() const;
1252 /// \brief Constructor with insert-before-instruction semantics.
1254 Instruction *InsertBefore, ///< Where to insert
1255 Predicate pred, ///< The predicate to use for the comparison
1256 Value *LHS, ///< The left-hand-side of the expression
1257 Value *RHS, ///< The right-hand-side of the expression
1258 const Twine &NameStr = "" ///< Name of the instruction
1259 ) : CmpInst(makeCmpResultType(LHS->getType()),
1260 Instruction::FCmp, pred, LHS, RHS, NameStr,
1262 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1263 "Invalid FCmp predicate value");
1264 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1265 "Both operands to FCmp instruction are not of the same type!");
1266 // Check that the operands are the right type
1267 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1268 "Invalid operand types for FCmp instruction");
1271 /// \brief Constructor with insert-at-end semantics.
1273 BasicBlock &InsertAtEnd, ///< Block to insert into.
1274 Predicate pred, ///< The predicate to use for the comparison
1275 Value *LHS, ///< The left-hand-side of the expression
1276 Value *RHS, ///< The right-hand-side of the expression
1277 const Twine &NameStr = "" ///< Name of the instruction
1278 ) : CmpInst(makeCmpResultType(LHS->getType()),
1279 Instruction::FCmp, pred, LHS, RHS, NameStr,
1281 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1282 "Invalid FCmp predicate value");
1283 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1284 "Both operands to FCmp instruction are not of the same type!");
1285 // Check that the operands are the right type
1286 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1287 "Invalid operand types for FCmp instruction");
1290 /// \brief Constructor with no-insertion semantics
1292 Predicate pred, ///< The predicate to use for the comparison
1293 Value *LHS, ///< The left-hand-side of the expression
1294 Value *RHS, ///< The right-hand-side of the expression
1295 const Twine &NameStr = "" ///< Name of the instruction
1296 ) : CmpInst(makeCmpResultType(LHS->getType()),
1297 Instruction::FCmp, pred, LHS, RHS, NameStr) {
1298 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1299 "Invalid FCmp predicate value");
1300 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1301 "Both operands to FCmp instruction are not of the same type!");
1302 // Check that the operands are the right type
1303 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1304 "Invalid operand types for FCmp instruction");
1307 /// @returns true if the predicate of this instruction is EQ or NE.
1308 /// \brief Determine if this is an equality predicate.
1309 static bool isEquality(Predicate Pred) {
1310 return Pred == FCMP_OEQ || Pred == FCMP_ONE || Pred == FCMP_UEQ ||
1314 /// @returns true if the predicate of this instruction is EQ or NE.
1315 /// \brief Determine if this is an equality predicate.
1316 bool isEquality() const { return isEquality(getPredicate()); }
1318 /// @returns true if the predicate of this instruction is commutative.
1319 /// \brief Determine if this is a commutative predicate.
1320 bool isCommutative() const {
1321 return isEquality() ||
1322 getPredicate() == FCMP_FALSE ||
1323 getPredicate() == FCMP_TRUE ||
1324 getPredicate() == FCMP_ORD ||
1325 getPredicate() == FCMP_UNO;
1328 /// @returns true if the predicate is relational (not EQ or NE).
1329 /// \brief Determine if this a relational predicate.
1330 bool isRelational() const { return !isEquality(); }
1332 /// Exchange the two operands to this instruction in such a way that it does
1333 /// not modify the semantics of the instruction. The predicate value may be
1334 /// changed to retain the same result if the predicate is order dependent
1336 /// \brief Swap operands and adjust predicate.
1337 void swapOperands() {
1338 setPredicate(getSwappedPredicate());
1339 Op<0>().swap(Op<1>());
1342 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
1343 static inline bool classof(const Instruction *I) {
1344 return I->getOpcode() == Instruction::FCmp;
1346 static inline bool classof(const Value *V) {
1347 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1351 //===----------------------------------------------------------------------===//
1352 /// CallInst - This class represents a function call, abstracting a target
1353 /// machine's calling convention. This class uses low bit of the SubClassData
1354 /// field to indicate whether or not this is a tail call. The rest of the bits
1355 /// hold the calling convention of the call.
1357 class CallInst : public Instruction,
1358 public OperandBundleUser<CallInst, User::op_iterator> {
1359 AttributeSet AttributeList; ///< parameter attributes for call
1361 CallInst(const CallInst &CI);
1362 void init(Value *Func, ArrayRef<Value *> Args,
1363 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr) {
1364 init(cast<FunctionType>(
1365 cast<PointerType>(Func->getType())->getElementType()),
1366 Func, Args, Bundles, NameStr);
1368 void init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
1369 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr);
1370 void init(Value *Func, const Twine &NameStr);
1372 /// Construct a CallInst given a range of arguments.
1373 /// \brief Construct a CallInst from a range of arguments
1374 inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1375 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1376 Instruction *InsertBefore);
1377 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1378 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1379 Instruction *InsertBefore)
1380 : CallInst(cast<FunctionType>(
1381 cast<PointerType>(Func->getType())->getElementType()),
1382 Func, Args, Bundles, NameStr, InsertBefore) {}
1384 inline CallInst(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr,
1385 Instruction *InsertBefore)
1386 : CallInst(Func, Args, None, NameStr, InsertBefore) {}
1388 /// Construct a CallInst given a range of arguments.
1389 /// \brief Construct a CallInst from a range of arguments
1390 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1391 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1392 BasicBlock *InsertAtEnd);
1394 explicit CallInst(Value *F, const Twine &NameStr,
1395 Instruction *InsertBefore);
1396 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1398 friend class OperandBundleUser<CallInst, User::op_iterator>;
1399 bool hasDescriptor() const { return HasDescriptor; }
1402 // Note: Instruction needs to be a friend here to call cloneImpl.
1403 friend class Instruction;
1404 CallInst *cloneImpl() const;
1407 static CallInst *Create(Value *Func, ArrayRef<Value *> Args,
1408 ArrayRef<OperandBundleDef> Bundles = None,
1409 const Twine &NameStr = "",
1410 Instruction *InsertBefore = nullptr) {
1411 return Create(cast<FunctionType>(
1412 cast<PointerType>(Func->getType())->getElementType()),
1413 Func, Args, Bundles, NameStr, InsertBefore);
1415 static CallInst *Create(Value *Func, ArrayRef<Value *> Args,
1416 const Twine &NameStr,
1417 Instruction *InsertBefore = nullptr) {
1418 return Create(cast<FunctionType>(
1419 cast<PointerType>(Func->getType())->getElementType()),
1420 Func, Args, None, NameStr, InsertBefore);
1422 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1423 const Twine &NameStr,
1424 Instruction *InsertBefore = nullptr) {
1425 return new (unsigned(Args.size() + 1))
1426 CallInst(Ty, Func, Args, None, NameStr, InsertBefore);
1428 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1429 ArrayRef<OperandBundleDef> Bundles = None,
1430 const Twine &NameStr = "",
1431 Instruction *InsertBefore = nullptr) {
1432 const unsigned TotalOps =
1433 unsigned(Args.size()) + CountBundleInputs(Bundles) + 1;
1434 const unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
1436 return new (TotalOps, DescriptorBytes)
1437 CallInst(Ty, Func, Args, Bundles, NameStr, InsertBefore);
1439 static CallInst *Create(Value *Func, ArrayRef<Value *> Args,
1440 ArrayRef<OperandBundleDef> Bundles,
1441 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1442 const unsigned TotalOps =
1443 unsigned(Args.size()) + CountBundleInputs(Bundles) + 1;
1444 const unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
1446 return new (TotalOps, DescriptorBytes)
1447 CallInst(Func, Args, Bundles, NameStr, InsertAtEnd);
1449 static CallInst *Create(Value *Func, ArrayRef<Value *> Args,
1450 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1451 return new (unsigned(Args.size() + 1))
1452 CallInst(Func, Args, None, NameStr, InsertAtEnd);
1454 static CallInst *Create(Value *F, const Twine &NameStr = "",
1455 Instruction *InsertBefore = nullptr) {
1456 return new(1) CallInst(F, NameStr, InsertBefore);
1458 static CallInst *Create(Value *F, const Twine &NameStr,
1459 BasicBlock *InsertAtEnd) {
1460 return new(1) CallInst(F, NameStr, InsertAtEnd);
1463 /// \brief Create a clone of \p CI with a different set of operand bundles and
1464 /// insert it before \p InsertPt.
1466 /// The returned call instruction is identical \p CI in every way except that
1467 /// the operand bundles for the new instruction are set to the operand bundles
1469 static CallInst *Create(CallInst *CI, ArrayRef<OperandBundleDef> Bundles,
1470 Instruction *InsertPt = nullptr);
1472 /// CreateMalloc - Generate the IR for a call to malloc:
1473 /// 1. Compute the malloc call's argument as the specified type's size,
1474 /// possibly multiplied by the array size if the array size is not
1476 /// 2. Call malloc with that argument.
1477 /// 3. Bitcast the result of the malloc call to the specified type.
1478 static Instruction *CreateMalloc(Instruction *InsertBefore,
1479 Type *IntPtrTy, Type *AllocTy,
1480 Value *AllocSize, Value *ArraySize = nullptr,
1481 Function* MallocF = nullptr,
1482 const Twine &Name = "");
1483 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1484 Type *IntPtrTy, Type *AllocTy,
1485 Value *AllocSize, Value *ArraySize = nullptr,
1486 Function* MallocF = nullptr,
1487 const Twine &Name = "");
1488 /// CreateFree - Generate the IR for a call to the builtin free function.
1489 static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
1490 static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
1492 ~CallInst() override;
1494 FunctionType *getFunctionType() const { return FTy; }
1496 void mutateFunctionType(FunctionType *FTy) {
1497 mutateType(FTy->getReturnType());
1501 // Note that 'musttail' implies 'tail'.
1502 enum TailCallKind { TCK_None = 0, TCK_Tail = 1, TCK_MustTail = 2,
1504 TailCallKind getTailCallKind() const {
1505 return TailCallKind(getSubclassDataFromInstruction() & 3);
1507 bool isTailCall() const {
1508 unsigned Kind = getSubclassDataFromInstruction() & 3;
1509 return Kind == TCK_Tail || Kind == TCK_MustTail;
1511 bool isMustTailCall() const {
1512 return (getSubclassDataFromInstruction() & 3) == TCK_MustTail;
1514 bool isNoTailCall() const {
1515 return (getSubclassDataFromInstruction() & 3) == TCK_NoTail;
1517 void setTailCall(bool isTC = true) {
1518 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1519 unsigned(isTC ? TCK_Tail : TCK_None));
1521 void setTailCallKind(TailCallKind TCK) {
1522 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1526 /// Provide fast operand accessors
1527 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1529 /// getNumArgOperands - Return the number of call arguments.
1531 unsigned getNumArgOperands() const {
1532 return getNumOperands() - getNumTotalBundleOperands() - 1;
1535 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
1537 Value *getArgOperand(unsigned i) const {
1538 assert(i < getNumArgOperands() && "Out of bounds!");
1539 return getOperand(i);
1541 void setArgOperand(unsigned i, Value *v) {
1542 assert(i < getNumArgOperands() && "Out of bounds!");
1546 /// arg_operands - iteration adapter for range-for loops.
1547 iterator_range<op_iterator> arg_operands() {
1548 // The last operand in the op list is the callee - it's not one of the args
1549 // so we don't want to iterate over it.
1550 return iterator_range<op_iterator>(
1551 op_begin(), op_end() - getNumTotalBundleOperands() - 1);
1554 /// arg_operands - iteration adapter for range-for loops.
1555 iterator_range<const_op_iterator> arg_operands() const {
1556 return iterator_range<const_op_iterator>(
1557 op_begin(), op_end() - getNumTotalBundleOperands() - 1);
1560 /// \brief Wrappers for getting the \c Use of a call argument.
1561 const Use &getArgOperandUse(unsigned i) const {
1562 assert(i < getNumArgOperands() && "Out of bounds!");
1563 return getOperandUse(i);
1565 Use &getArgOperandUse(unsigned i) {
1566 assert(i < getNumArgOperands() && "Out of bounds!");
1567 return getOperandUse(i);
1570 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1572 CallingConv::ID getCallingConv() const {
1573 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 2);
1575 void setCallingConv(CallingConv::ID CC) {
1576 auto ID = static_cast<unsigned>(CC);
1577 assert(!(ID & ~CallingConv::MaxID) && "Unsupported calling convention");
1578 setInstructionSubclassData((getSubclassDataFromInstruction() & 3) |
1582 /// getAttributes - Return the parameter attributes for this call.
1584 const AttributeSet &getAttributes() const { return AttributeList; }
1586 /// setAttributes - Set the parameter attributes for this call.
1588 void setAttributes(const AttributeSet &Attrs) { AttributeList = Attrs; }
1590 /// addAttribute - adds the attribute to the list of attributes.
1591 void addAttribute(unsigned i, Attribute::AttrKind attr);
1593 /// addAttribute - adds the attribute to the list of attributes.
1594 void addAttribute(unsigned i, StringRef Kind, StringRef Value);
1596 /// removeAttribute - removes the attribute from the list of attributes.
1597 void removeAttribute(unsigned i, Attribute attr);
1599 /// \brief adds the dereferenceable attribute to the list of attributes.
1600 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
1602 /// \brief adds the dereferenceable_or_null attribute to the list of
1604 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
1606 /// \brief Determine whether this call has the given attribute.
1607 bool hasFnAttr(Attribute::AttrKind A) const {
1608 assert(A != Attribute::NoBuiltin &&
1609 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
1610 return hasFnAttrImpl(A);
1613 /// \brief Determine whether this call has the given attribute.
1614 bool hasFnAttr(StringRef A) const {
1615 return hasFnAttrImpl(A);
1618 /// \brief Determine whether the call or the callee has the given attributes.
1619 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const;
1621 /// \brief Return true if the data operand at index \p i has the attribute \p
1624 /// Data operands include call arguments and values used in operand bundles,
1625 /// but does not include the callee operand. This routine dispatches to the
1626 /// underlying AttributeList or the OperandBundleUser as appropriate.
1628 /// The index \p i is interpreted as
1630 /// \p i == Attribute::ReturnIndex -> the return value
1631 /// \p i in [1, arg_size + 1) -> argument number (\p i - 1)
1632 /// \p i in [arg_size + 1, data_operand_size + 1) -> bundle operand at index
1633 /// (\p i - 1) in the operand list.
1634 bool dataOperandHasImpliedAttr(unsigned i, Attribute::AttrKind A) const;
1636 /// \brief Extract the alignment for a call or parameter (0=unknown).
1637 unsigned getParamAlignment(unsigned i) const {
1638 return AttributeList.getParamAlignment(i);
1641 /// Set the alignment for a call or parameter (0=unknown).
1642 void setParamAlignment(unsigned Index, unsigned Align) {
1643 // Its not valid to change the parameter alignment. Instead we have to
1644 // remove the old one if its there, and add a new one.
1645 if (AttributeList.hasAttribute(Index, Attribute::Alignment))
1646 AttributeList = AttributeList.removeAttribute(getContext(),
1648 Attribute::Alignment);
1650 // Now add the new alignment.
1651 llvm::AttrBuilder B;
1652 B.addAlignmentAttr(Align);
1653 AttributeList = AttributeList.addAttributes(getContext(), Index,
1654 AttributeSet::get(getContext(),
1658 /// \brief Extract the number of dereferenceable bytes for a call or
1659 /// parameter (0=unknown).
1660 uint64_t getDereferenceableBytes(unsigned i) const {
1661 return AttributeList.getDereferenceableBytes(i);
1664 /// \brief Extract the number of dereferenceable_or_null bytes for a call or
1665 /// parameter (0=unknown).
1666 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
1667 return AttributeList.getDereferenceableOrNullBytes(i);
1670 /// @brief Determine if the parameter or return value is marked with NoAlias
1672 /// @param n The parameter to check. 1 is the first parameter, 0 is the return
1673 bool doesNotAlias(unsigned n) const {
1674 return AttributeList.hasAttribute(n, Attribute::NoAlias);
1677 /// \brief Return true if the call should not be treated as a call to a
1679 bool isNoBuiltin() const {
1680 return hasFnAttrImpl(Attribute::NoBuiltin) &&
1681 !hasFnAttrImpl(Attribute::Builtin);
1684 /// \brief Return true if the call should not be inlined.
1685 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
1686 void setIsNoInline() {
1687 addAttribute(AttributeSet::FunctionIndex, Attribute::NoInline);
1690 /// \brief Return true if the call can return twice
1691 bool canReturnTwice() const {
1692 return hasFnAttr(Attribute::ReturnsTwice);
1694 void setCanReturnTwice() {
1695 addAttribute(AttributeSet::FunctionIndex, Attribute::ReturnsTwice);
1698 /// \brief Determine if the call does not access memory.
1699 bool doesNotAccessMemory() const {
1700 return hasFnAttr(Attribute::ReadNone);
1702 void setDoesNotAccessMemory() {
1703 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
1706 /// \brief Determine if the call does not access or only reads memory.
1707 bool onlyReadsMemory() const {
1708 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
1710 void setOnlyReadsMemory() {
1711 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
1714 /// @brief Determine if the call can access memmory only using pointers based
1715 /// on its arguments.
1716 bool onlyAccessesArgMemory() const {
1717 return hasFnAttr(Attribute::ArgMemOnly);
1719 void setOnlyAccessesArgMemory() {
1720 addAttribute(AttributeSet::FunctionIndex, Attribute::ArgMemOnly);
1723 /// \brief Determine if the call cannot return.
1724 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
1725 void setDoesNotReturn() {
1726 addAttribute(AttributeSet::FunctionIndex, Attribute::NoReturn);
1729 /// \brief Determine if the call cannot unwind.
1730 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
1731 void setDoesNotThrow() {
1732 addAttribute(AttributeSet::FunctionIndex, Attribute::NoUnwind);
1735 /// \brief Determine if the call cannot be duplicated.
1736 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
1737 void setCannotDuplicate() {
1738 addAttribute(AttributeSet::FunctionIndex, Attribute::NoDuplicate);
1741 /// \brief Determine if the call is convergent
1742 bool isConvergent() const { return hasFnAttr(Attribute::Convergent); }
1743 void setConvergent() {
1744 addAttribute(AttributeSet::FunctionIndex, Attribute::Convergent);
1747 /// \brief Determine if the call returns a structure through first
1748 /// pointer argument.
1749 bool hasStructRetAttr() const {
1750 // Be friendly and also check the callee.
1751 return paramHasAttr(1, Attribute::StructRet);
1754 /// \brief Determine if any call argument is an aggregate passed by value.
1755 bool hasByValArgument() const {
1756 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1759 /// getCalledFunction - Return the function called, or null if this is an
1760 /// indirect function invocation.
1762 Function *getCalledFunction() const {
1763 return dyn_cast<Function>(Op<-1>());
1766 /// getCalledValue - Get a pointer to the function that is invoked by this
1768 const Value *getCalledValue() const { return Op<-1>(); }
1769 Value *getCalledValue() { return Op<-1>(); }
1771 /// setCalledFunction - Set the function called.
1772 void setCalledFunction(Value* Fn) {
1774 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
1777 void setCalledFunction(FunctionType *FTy, Value *Fn) {
1779 assert(FTy == cast<FunctionType>(
1780 cast<PointerType>(Fn->getType())->getElementType()));
1784 /// isInlineAsm - Check if this call is an inline asm statement.
1785 bool isInlineAsm() const {
1786 return isa<InlineAsm>(Op<-1>());
1789 // Methods for support type inquiry through isa, cast, and dyn_cast:
1790 static inline bool classof(const Instruction *I) {
1791 return I->getOpcode() == Instruction::Call;
1793 static inline bool classof(const Value *V) {
1794 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1798 template <typename AttrKind> bool hasFnAttrImpl(AttrKind A) const {
1799 if (AttributeList.hasAttribute(AttributeSet::FunctionIndex, A))
1802 // Operand bundles override attributes on the called function, but don't
1803 // override attributes directly present on the call instruction.
1804 if (isFnAttrDisallowedByOpBundle(A))
1807 if (const Function *F = getCalledFunction())
1808 return F->getAttributes().hasAttribute(AttributeSet::FunctionIndex, A);
1812 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1813 // method so that subclasses cannot accidentally use it.
1814 void setInstructionSubclassData(unsigned short D) {
1815 Instruction::setInstructionSubclassData(D);
1820 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1823 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1824 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1825 BasicBlock *InsertAtEnd)
1827 cast<FunctionType>(cast<PointerType>(Func->getType())
1828 ->getElementType())->getReturnType(),
1829 Instruction::Call, OperandTraits<CallInst>::op_end(this) -
1830 (Args.size() + CountBundleInputs(Bundles) + 1),
1831 unsigned(Args.size() + CountBundleInputs(Bundles) + 1), InsertAtEnd) {
1832 init(Func, Args, Bundles, NameStr);
1835 CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1836 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1837 Instruction *InsertBefore)
1838 : Instruction(Ty->getReturnType(), Instruction::Call,
1839 OperandTraits<CallInst>::op_end(this) -
1840 (Args.size() + CountBundleInputs(Bundles) + 1),
1841 unsigned(Args.size() + CountBundleInputs(Bundles) + 1),
1843 init(Ty, Func, Args, Bundles, NameStr);
1846 // Note: if you get compile errors about private methods then
1847 // please update your code to use the high-level operand
1848 // interfaces. See line 943 above.
1849 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1851 //===----------------------------------------------------------------------===//
1853 //===----------------------------------------------------------------------===//
1855 /// SelectInst - This class represents the LLVM 'select' instruction.
1857 class SelectInst : public Instruction {
1858 void init(Value *C, Value *S1, Value *S2) {
1859 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1865 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1866 Instruction *InsertBefore)
1867 : Instruction(S1->getType(), Instruction::Select,
1868 &Op<0>(), 3, InsertBefore) {
1872 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1873 BasicBlock *InsertAtEnd)
1874 : Instruction(S1->getType(), Instruction::Select,
1875 &Op<0>(), 3, InsertAtEnd) {
1881 // Note: Instruction needs to be a friend here to call cloneImpl.
1882 friend class Instruction;
1883 SelectInst *cloneImpl() const;
1886 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1887 const Twine &NameStr = "",
1888 Instruction *InsertBefore = nullptr) {
1889 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1891 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1892 const Twine &NameStr,
1893 BasicBlock *InsertAtEnd) {
1894 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1897 const Value *getCondition() const { return Op<0>(); }
1898 const Value *getTrueValue() const { return Op<1>(); }
1899 const Value *getFalseValue() const { return Op<2>(); }
1900 Value *getCondition() { return Op<0>(); }
1901 Value *getTrueValue() { return Op<1>(); }
1902 Value *getFalseValue() { return Op<2>(); }
1904 /// areInvalidOperands - Return a string if the specified operands are invalid
1905 /// for a select operation, otherwise return null.
1906 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1908 /// Transparently provide more efficient getOperand methods.
1909 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1911 OtherOps getOpcode() const {
1912 return static_cast<OtherOps>(Instruction::getOpcode());
1915 // Methods for support type inquiry through isa, cast, and dyn_cast:
1916 static inline bool classof(const Instruction *I) {
1917 return I->getOpcode() == Instruction::Select;
1919 static inline bool classof(const Value *V) {
1920 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1925 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1928 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1930 //===----------------------------------------------------------------------===//
1932 //===----------------------------------------------------------------------===//
1934 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1935 /// an argument of the specified type given a va_list and increments that list
1937 class VAArgInst : public UnaryInstruction {
1939 // Note: Instruction needs to be a friend here to call cloneImpl.
1940 friend class Instruction;
1941 VAArgInst *cloneImpl() const;
1944 VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1945 Instruction *InsertBefore = nullptr)
1946 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1949 VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1950 BasicBlock *InsertAtEnd)
1951 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1955 Value *getPointerOperand() { return getOperand(0); }
1956 const Value *getPointerOperand() const { return getOperand(0); }
1957 static unsigned getPointerOperandIndex() { return 0U; }
1959 // Methods for support type inquiry through isa, cast, and dyn_cast:
1960 static inline bool classof(const Instruction *I) {
1961 return I->getOpcode() == VAArg;
1963 static inline bool classof(const Value *V) {
1964 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1968 //===----------------------------------------------------------------------===//
1969 // ExtractElementInst Class
1970 //===----------------------------------------------------------------------===//
1972 /// ExtractElementInst - This instruction extracts a single (scalar)
1973 /// element from a VectorType value
1975 class ExtractElementInst : public Instruction {
1976 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1977 Instruction *InsertBefore = nullptr);
1978 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1979 BasicBlock *InsertAtEnd);
1982 // Note: Instruction needs to be a friend here to call cloneImpl.
1983 friend class Instruction;
1984 ExtractElementInst *cloneImpl() const;
1987 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1988 const Twine &NameStr = "",
1989 Instruction *InsertBefore = nullptr) {
1990 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1992 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1993 const Twine &NameStr,
1994 BasicBlock *InsertAtEnd) {
1995 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1998 /// isValidOperands - Return true if an extractelement instruction can be
1999 /// formed with the specified operands.
2000 static bool isValidOperands(const Value *Vec, const Value *Idx);
2002 Value *getVectorOperand() { return Op<0>(); }
2003 Value *getIndexOperand() { return Op<1>(); }
2004 const Value *getVectorOperand() const { return Op<0>(); }
2005 const Value *getIndexOperand() const { return Op<1>(); }
2007 VectorType *getVectorOperandType() const {
2008 return cast<VectorType>(getVectorOperand()->getType());
2011 /// Transparently provide more efficient getOperand methods.
2012 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2014 // Methods for support type inquiry through isa, cast, and dyn_cast:
2015 static inline bool classof(const Instruction *I) {
2016 return I->getOpcode() == Instruction::ExtractElement;
2018 static inline bool classof(const Value *V) {
2019 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2024 struct OperandTraits<ExtractElementInst> :
2025 public FixedNumOperandTraits<ExtractElementInst, 2> {
2028 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
2030 //===----------------------------------------------------------------------===//
2031 // InsertElementInst Class
2032 //===----------------------------------------------------------------------===//
2034 /// InsertElementInst - This instruction inserts a single (scalar)
2035 /// element into a VectorType value
2037 class InsertElementInst : public Instruction {
2038 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
2039 const Twine &NameStr = "",
2040 Instruction *InsertBefore = nullptr);
2041 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx, const Twine &NameStr,
2042 BasicBlock *InsertAtEnd);
2045 // Note: Instruction needs to be a friend here to call cloneImpl.
2046 friend class Instruction;
2047 InsertElementInst *cloneImpl() const;
2050 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
2051 const Twine &NameStr = "",
2052 Instruction *InsertBefore = nullptr) {
2053 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
2055 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
2056 const Twine &NameStr,
2057 BasicBlock *InsertAtEnd) {
2058 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
2061 /// isValidOperands - Return true if an insertelement instruction can be
2062 /// formed with the specified operands.
2063 static bool isValidOperands(const Value *Vec, const Value *NewElt,
2066 /// getType - Overload to return most specific vector type.
2068 VectorType *getType() const {
2069 return cast<VectorType>(Instruction::getType());
2072 /// Transparently provide more efficient getOperand methods.
2073 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2075 // Methods for support type inquiry through isa, cast, and dyn_cast:
2076 static inline bool classof(const Instruction *I) {
2077 return I->getOpcode() == Instruction::InsertElement;
2079 static inline bool classof(const Value *V) {
2080 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2085 struct OperandTraits<InsertElementInst> :
2086 public FixedNumOperandTraits<InsertElementInst, 3> {
2089 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
2091 //===----------------------------------------------------------------------===//
2092 // ShuffleVectorInst Class
2093 //===----------------------------------------------------------------------===//
2095 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
2098 class ShuffleVectorInst : public Instruction {
2100 // Note: Instruction needs to be a friend here to call cloneImpl.
2101 friend class Instruction;
2102 ShuffleVectorInst *cloneImpl() const;
2105 // allocate space for exactly three operands
2106 void *operator new(size_t s) {
2107 return User::operator new(s, 3);
2109 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
2110 const Twine &NameStr = "",
2111 Instruction *InsertBefor = nullptr);
2112 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
2113 const Twine &NameStr, BasicBlock *InsertAtEnd);
2115 /// isValidOperands - Return true if a shufflevector instruction can be
2116 /// formed with the specified operands.
2117 static bool isValidOperands(const Value *V1, const Value *V2,
2120 /// getType - Overload to return most specific vector type.
2122 VectorType *getType() const {
2123 return cast<VectorType>(Instruction::getType());
2126 /// Transparently provide more efficient getOperand methods.
2127 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2129 Constant *getMask() const {
2130 return cast<Constant>(getOperand(2));
2133 /// getMaskValue - Return the index from the shuffle mask for the specified
2134 /// output result. This is either -1 if the element is undef or a number less
2135 /// than 2*numelements.
2136 static int getMaskValue(Constant *Mask, unsigned i);
2138 int getMaskValue(unsigned i) const {
2139 return getMaskValue(getMask(), i);
2142 /// getShuffleMask - Return the full mask for this instruction, where each
2143 /// element is the element number and undef's are returned as -1.
2144 static void getShuffleMask(Constant *Mask, SmallVectorImpl<int> &Result);
2146 void getShuffleMask(SmallVectorImpl<int> &Result) const {
2147 return getShuffleMask(getMask(), Result);
2150 SmallVector<int, 16> getShuffleMask() const {
2151 SmallVector<int, 16> Mask;
2152 getShuffleMask(Mask);
2156 // Methods for support type inquiry through isa, cast, and dyn_cast:
2157 static inline bool classof(const Instruction *I) {
2158 return I->getOpcode() == Instruction::ShuffleVector;
2160 static inline bool classof(const Value *V) {
2161 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2166 struct OperandTraits<ShuffleVectorInst> :
2167 public FixedNumOperandTraits<ShuffleVectorInst, 3> {
2170 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
2172 //===----------------------------------------------------------------------===//
2173 // ExtractValueInst Class
2174 //===----------------------------------------------------------------------===//
2176 /// ExtractValueInst - This instruction extracts a struct member or array
2177 /// element value from an aggregate value.
2179 class ExtractValueInst : public UnaryInstruction {
2180 SmallVector<unsigned, 4> Indices;
2182 ExtractValueInst(const ExtractValueInst &EVI);
2183 void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
2185 /// Constructors - Create a extractvalue instruction with a base aggregate
2186 /// value and a list of indices. The first ctor can optionally insert before
2187 /// an existing instruction, the second appends the new instruction to the
2188 /// specified BasicBlock.
2189 inline ExtractValueInst(Value *Agg,
2190 ArrayRef<unsigned> Idxs,
2191 const Twine &NameStr,
2192 Instruction *InsertBefore);
2193 inline ExtractValueInst(Value *Agg,
2194 ArrayRef<unsigned> Idxs,
2195 const Twine &NameStr, BasicBlock *InsertAtEnd);
2197 // allocate space for exactly one operand
2198 void *operator new(size_t s) { return User::operator new(s, 1); }
2201 // Note: Instruction needs to be a friend here to call cloneImpl.
2202 friend class Instruction;
2203 ExtractValueInst *cloneImpl() const;
2206 static ExtractValueInst *Create(Value *Agg,
2207 ArrayRef<unsigned> Idxs,
2208 const Twine &NameStr = "",
2209 Instruction *InsertBefore = nullptr) {
2211 ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
2213 static ExtractValueInst *Create(Value *Agg,
2214 ArrayRef<unsigned> Idxs,
2215 const Twine &NameStr,
2216 BasicBlock *InsertAtEnd) {
2217 return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
2220 /// getIndexedType - Returns the type of the element that would be extracted
2221 /// with an extractvalue instruction with the specified parameters.
2223 /// Null is returned if the indices are invalid for the specified type.
2224 static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
2226 typedef const unsigned* idx_iterator;
2227 inline idx_iterator idx_begin() const { return Indices.begin(); }
2228 inline idx_iterator idx_end() const { return Indices.end(); }
2229 inline iterator_range<idx_iterator> indices() const {
2230 return iterator_range<idx_iterator>(idx_begin(), idx_end());
2233 Value *getAggregateOperand() {
2234 return getOperand(0);
2236 const Value *getAggregateOperand() const {
2237 return getOperand(0);
2239 static unsigned getAggregateOperandIndex() {
2240 return 0U; // get index for modifying correct operand
2243 ArrayRef<unsigned> getIndices() const {
2247 unsigned getNumIndices() const {
2248 return (unsigned)Indices.size();
2251 bool hasIndices() const {
2255 // Methods for support type inquiry through isa, cast, and dyn_cast:
2256 static inline bool classof(const Instruction *I) {
2257 return I->getOpcode() == Instruction::ExtractValue;
2259 static inline bool classof(const Value *V) {
2260 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2264 ExtractValueInst::ExtractValueInst(Value *Agg,
2265 ArrayRef<unsigned> Idxs,
2266 const Twine &NameStr,
2267 Instruction *InsertBefore)
2268 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2269 ExtractValue, Agg, InsertBefore) {
2270 init(Idxs, NameStr);
2272 ExtractValueInst::ExtractValueInst(Value *Agg,
2273 ArrayRef<unsigned> Idxs,
2274 const Twine &NameStr,
2275 BasicBlock *InsertAtEnd)
2276 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2277 ExtractValue, Agg, InsertAtEnd) {
2278 init(Idxs, NameStr);
2281 //===----------------------------------------------------------------------===//
2282 // InsertValueInst Class
2283 //===----------------------------------------------------------------------===//
2285 /// InsertValueInst - This instruction inserts a struct field of array element
2286 /// value into an aggregate value.
2288 class InsertValueInst : public Instruction {
2289 SmallVector<unsigned, 4> Indices;
2291 void *operator new(size_t, unsigned) = delete;
2292 InsertValueInst(const InsertValueInst &IVI);
2293 void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
2294 const Twine &NameStr);
2296 /// Constructors - Create a insertvalue instruction with a base aggregate
2297 /// value, a value to insert, and a list of indices. The first ctor can
2298 /// optionally insert before an existing instruction, the second appends
2299 /// the new instruction to the specified BasicBlock.
2300 inline InsertValueInst(Value *Agg, Value *Val,
2301 ArrayRef<unsigned> Idxs,
2302 const Twine &NameStr,
2303 Instruction *InsertBefore);
2304 inline InsertValueInst(Value *Agg, Value *Val,
2305 ArrayRef<unsigned> Idxs,
2306 const Twine &NameStr, BasicBlock *InsertAtEnd);
2308 /// Constructors - These two constructors are convenience methods because one
2309 /// and two index insertvalue instructions are so common.
2310 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
2311 const Twine &NameStr = "",
2312 Instruction *InsertBefore = nullptr);
2313 InsertValueInst(Value *Agg, Value *Val, unsigned Idx, const Twine &NameStr,
2314 BasicBlock *InsertAtEnd);
2317 // Note: Instruction needs to be a friend here to call cloneImpl.
2318 friend class Instruction;
2319 InsertValueInst *cloneImpl() const;
2322 // allocate space for exactly two operands
2323 void *operator new(size_t s) {
2324 return User::operator new(s, 2);
2327 static InsertValueInst *Create(Value *Agg, Value *Val,
2328 ArrayRef<unsigned> Idxs,
2329 const Twine &NameStr = "",
2330 Instruction *InsertBefore = nullptr) {
2331 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
2333 static InsertValueInst *Create(Value *Agg, Value *Val,
2334 ArrayRef<unsigned> Idxs,
2335 const Twine &NameStr,
2336 BasicBlock *InsertAtEnd) {
2337 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
2340 /// Transparently provide more efficient getOperand methods.
2341 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2343 typedef const unsigned* idx_iterator;
2344 inline idx_iterator idx_begin() const { return Indices.begin(); }
2345 inline idx_iterator idx_end() const { return Indices.end(); }
2346 inline iterator_range<idx_iterator> indices() const {
2347 return iterator_range<idx_iterator>(idx_begin(), idx_end());
2350 Value *getAggregateOperand() {
2351 return getOperand(0);
2353 const Value *getAggregateOperand() const {
2354 return getOperand(0);
2356 static unsigned getAggregateOperandIndex() {
2357 return 0U; // get index for modifying correct operand
2360 Value *getInsertedValueOperand() {
2361 return getOperand(1);
2363 const Value *getInsertedValueOperand() const {
2364 return getOperand(1);
2366 static unsigned getInsertedValueOperandIndex() {
2367 return 1U; // get index for modifying correct operand
2370 ArrayRef<unsigned> getIndices() const {
2374 unsigned getNumIndices() const {
2375 return (unsigned)Indices.size();
2378 bool hasIndices() const {
2382 // Methods for support type inquiry through isa, cast, and dyn_cast:
2383 static inline bool classof(const Instruction *I) {
2384 return I->getOpcode() == Instruction::InsertValue;
2386 static inline bool classof(const Value *V) {
2387 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2392 struct OperandTraits<InsertValueInst> :
2393 public FixedNumOperandTraits<InsertValueInst, 2> {
2396 InsertValueInst::InsertValueInst(Value *Agg,
2398 ArrayRef<unsigned> Idxs,
2399 const Twine &NameStr,
2400 Instruction *InsertBefore)
2401 : Instruction(Agg->getType(), InsertValue,
2402 OperandTraits<InsertValueInst>::op_begin(this),
2404 init(Agg, Val, Idxs, NameStr);
2406 InsertValueInst::InsertValueInst(Value *Agg,
2408 ArrayRef<unsigned> Idxs,
2409 const Twine &NameStr,
2410 BasicBlock *InsertAtEnd)
2411 : Instruction(Agg->getType(), InsertValue,
2412 OperandTraits<InsertValueInst>::op_begin(this),
2414 init(Agg, Val, Idxs, NameStr);
2417 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
2419 //===----------------------------------------------------------------------===//
2421 //===----------------------------------------------------------------------===//
2423 // PHINode - The PHINode class is used to represent the magical mystical PHI
2424 // node, that can not exist in nature, but can be synthesized in a computer
2425 // scientist's overactive imagination.
2427 class PHINode : public Instruction {
2428 void *operator new(size_t, unsigned) = delete;
2429 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2430 /// the number actually in use.
2431 unsigned ReservedSpace;
2432 PHINode(const PHINode &PN);
2433 // allocate space for exactly zero operands
2434 void *operator new(size_t s) {
2435 return User::operator new(s);
2437 explicit PHINode(Type *Ty, unsigned NumReservedValues,
2438 const Twine &NameStr = "",
2439 Instruction *InsertBefore = nullptr)
2440 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertBefore),
2441 ReservedSpace(NumReservedValues) {
2443 allocHungoffUses(ReservedSpace);
2446 PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
2447 BasicBlock *InsertAtEnd)
2448 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertAtEnd),
2449 ReservedSpace(NumReservedValues) {
2451 allocHungoffUses(ReservedSpace);
2455 // allocHungoffUses - this is more complicated than the generic
2456 // User::allocHungoffUses, because we have to allocate Uses for the incoming
2457 // values and pointers to the incoming blocks, all in one allocation.
2458 void allocHungoffUses(unsigned N) {
2459 User::allocHungoffUses(N, /* IsPhi */ true);
2462 // Note: Instruction needs to be a friend here to call cloneImpl.
2463 friend class Instruction;
2464 PHINode *cloneImpl() const;
2467 /// Constructors - NumReservedValues is a hint for the number of incoming
2468 /// edges that this phi node will have (use 0 if you really have no idea).
2469 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2470 const Twine &NameStr = "",
2471 Instruction *InsertBefore = nullptr) {
2472 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2474 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2475 const Twine &NameStr, BasicBlock *InsertAtEnd) {
2476 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2479 /// Provide fast operand accessors
2480 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2482 // Block iterator interface. This provides access to the list of incoming
2483 // basic blocks, which parallels the list of incoming values.
2485 typedef BasicBlock **block_iterator;
2486 typedef BasicBlock * const *const_block_iterator;
2488 block_iterator block_begin() {
2490 reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2491 return reinterpret_cast<block_iterator>(ref + 1);
2494 const_block_iterator block_begin() const {
2495 const Use::UserRef *ref =
2496 reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2497 return reinterpret_cast<const_block_iterator>(ref + 1);
2500 block_iterator block_end() {
2501 return block_begin() + getNumOperands();
2504 const_block_iterator block_end() const {
2505 return block_begin() + getNumOperands();
2508 op_range incoming_values() { return operands(); }
2510 const_op_range incoming_values() const { return operands(); }
2512 /// getNumIncomingValues - Return the number of incoming edges
2514 unsigned getNumIncomingValues() const { return getNumOperands(); }
2516 /// getIncomingValue - Return incoming value number x
2518 Value *getIncomingValue(unsigned i) const {
2519 return getOperand(i);
2521 void setIncomingValue(unsigned i, Value *V) {
2522 assert(V && "PHI node got a null value!");
2523 assert(getType() == V->getType() &&
2524 "All operands to PHI node must be the same type as the PHI node!");
2527 static unsigned getOperandNumForIncomingValue(unsigned i) {
2530 static unsigned getIncomingValueNumForOperand(unsigned i) {
2534 /// getIncomingBlock - Return incoming basic block number @p i.
2536 BasicBlock *getIncomingBlock(unsigned i) const {
2537 return block_begin()[i];
2540 /// getIncomingBlock - Return incoming basic block corresponding
2541 /// to an operand of the PHI.
2543 BasicBlock *getIncomingBlock(const Use &U) const {
2544 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2545 return getIncomingBlock(unsigned(&U - op_begin()));
2548 /// getIncomingBlock - Return incoming basic block corresponding
2549 /// to value use iterator.
2551 BasicBlock *getIncomingBlock(Value::const_user_iterator I) const {
2552 return getIncomingBlock(I.getUse());
2555 void setIncomingBlock(unsigned i, BasicBlock *BB) {
2556 assert(BB && "PHI node got a null basic block!");
2557 block_begin()[i] = BB;
2560 /// addIncoming - Add an incoming value to the end of the PHI list
2562 void addIncoming(Value *V, BasicBlock *BB) {
2563 if (getNumOperands() == ReservedSpace)
2564 growOperands(); // Get more space!
2565 // Initialize some new operands.
2566 setNumHungOffUseOperands(getNumOperands() + 1);
2567 setIncomingValue(getNumOperands() - 1, V);
2568 setIncomingBlock(getNumOperands() - 1, BB);
2571 /// removeIncomingValue - Remove an incoming value. This is useful if a
2572 /// predecessor basic block is deleted. The value removed is returned.
2574 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2575 /// is true), the PHI node is destroyed and any uses of it are replaced with
2576 /// dummy values. The only time there should be zero incoming values to a PHI
2577 /// node is when the block is dead, so this strategy is sound.
2579 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2581 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2582 int Idx = getBasicBlockIndex(BB);
2583 assert(Idx >= 0 && "Invalid basic block argument to remove!");
2584 return removeIncomingValue(Idx, DeletePHIIfEmpty);
2587 /// getBasicBlockIndex - Return the first index of the specified basic
2588 /// block in the value list for this PHI. Returns -1 if no instance.
2590 int getBasicBlockIndex(const BasicBlock *BB) const {
2591 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2592 if (block_begin()[i] == BB)
2597 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2598 int Idx = getBasicBlockIndex(BB);
2599 assert(Idx >= 0 && "Invalid basic block argument!");
2600 return getIncomingValue(Idx);
2603 /// hasConstantValue - If the specified PHI node always merges together the
2604 /// same value, return the value, otherwise return null.
2605 Value *hasConstantValue() const;
2607 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2608 static inline bool classof(const Instruction *I) {
2609 return I->getOpcode() == Instruction::PHI;
2611 static inline bool classof(const Value *V) {
2612 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2616 void growOperands();
2620 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2623 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2625 //===----------------------------------------------------------------------===//
2626 // LandingPadInst Class
2627 //===----------------------------------------------------------------------===//
2629 //===---------------------------------------------------------------------------
2630 /// LandingPadInst - The landingpad instruction holds all of the information
2631 /// necessary to generate correct exception handling. The landingpad instruction
2632 /// cannot be moved from the top of a landing pad block, which itself is
2633 /// accessible only from the 'unwind' edge of an invoke. This uses the
2634 /// SubclassData field in Value to store whether or not the landingpad is a
2637 class LandingPadInst : public Instruction {
2638 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2639 /// the number actually in use.
2640 unsigned ReservedSpace;
2641 LandingPadInst(const LandingPadInst &LP);
2644 enum ClauseType { Catch, Filter };
2647 void *operator new(size_t, unsigned) = delete;
2648 // Allocate space for exactly zero operands.
2649 void *operator new(size_t s) {
2650 return User::operator new(s);
2652 void growOperands(unsigned Size);
2653 void init(unsigned NumReservedValues, const Twine &NameStr);
2655 explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues,
2656 const Twine &NameStr, Instruction *InsertBefore);
2657 explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues,
2658 const Twine &NameStr, BasicBlock *InsertAtEnd);
2661 // Note: Instruction needs to be a friend here to call cloneImpl.
2662 friend class Instruction;
2663 LandingPadInst *cloneImpl() const;
2666 /// Constructors - NumReservedClauses is a hint for the number of incoming
2667 /// clauses that this landingpad will have (use 0 if you really have no idea).
2668 static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses,
2669 const Twine &NameStr = "",
2670 Instruction *InsertBefore = nullptr);
2671 static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses,
2672 const Twine &NameStr, BasicBlock *InsertAtEnd);
2674 /// Provide fast operand accessors
2675 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2677 /// isCleanup - Return 'true' if this landingpad instruction is a
2678 /// cleanup. I.e., it should be run when unwinding even if its landing pad
2679 /// doesn't catch the exception.
2680 bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2682 /// setCleanup - Indicate that this landingpad instruction is a cleanup.
2683 void setCleanup(bool V) {
2684 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2688 /// Add a catch or filter clause to the landing pad.
2689 void addClause(Constant *ClauseVal);
2691 /// Get the value of the clause at index Idx. Use isCatch/isFilter to
2692 /// determine what type of clause this is.
2693 Constant *getClause(unsigned Idx) const {
2694 return cast<Constant>(getOperandList()[Idx]);
2697 /// isCatch - Return 'true' if the clause and index Idx is a catch clause.
2698 bool isCatch(unsigned Idx) const {
2699 return !isa<ArrayType>(getOperandList()[Idx]->getType());
2702 /// isFilter - Return 'true' if the clause and index Idx is a filter clause.
2703 bool isFilter(unsigned Idx) const {
2704 return isa<ArrayType>(getOperandList()[Idx]->getType());
2707 /// getNumClauses - Get the number of clauses for this landing pad.
2708 unsigned getNumClauses() const { return getNumOperands(); }
2710 /// reserveClauses - Grow the size of the operand list to accommodate the new
2711 /// number of clauses.
2712 void reserveClauses(unsigned Size) { growOperands(Size); }
2714 // Methods for support type inquiry through isa, cast, and dyn_cast:
2715 static inline bool classof(const Instruction *I) {
2716 return I->getOpcode() == Instruction::LandingPad;
2718 static inline bool classof(const Value *V) {
2719 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2724 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<1> {
2727 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2729 //===----------------------------------------------------------------------===//
2731 //===----------------------------------------------------------------------===//
2733 //===---------------------------------------------------------------------------
2734 /// ReturnInst - Return a value (possibly void), from a function. Execution
2735 /// does not continue in this function any longer.
2737 class ReturnInst : public TerminatorInst {
2738 ReturnInst(const ReturnInst &RI);
2741 // ReturnInst constructors:
2742 // ReturnInst() - 'ret void' instruction
2743 // ReturnInst( null) - 'ret void' instruction
2744 // ReturnInst(Value* X) - 'ret X' instruction
2745 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2746 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2747 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2748 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2750 // NOTE: If the Value* passed is of type void then the constructor behaves as
2751 // if it was passed NULL.
2752 explicit ReturnInst(LLVMContext &C, Value *retVal = nullptr,
2753 Instruction *InsertBefore = nullptr);
2754 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2755 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2758 // Note: Instruction needs to be a friend here to call cloneImpl.
2759 friend class Instruction;
2760 ReturnInst *cloneImpl() const;
2763 static ReturnInst* Create(LLVMContext &C, Value *retVal = nullptr,
2764 Instruction *InsertBefore = nullptr) {
2765 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2767 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2768 BasicBlock *InsertAtEnd) {
2769 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2771 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2772 return new(0) ReturnInst(C, InsertAtEnd);
2774 ~ReturnInst() override;
2776 /// Provide fast operand accessors
2777 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2779 /// Convenience accessor. Returns null if there is no return value.
2780 Value *getReturnValue() const {
2781 return getNumOperands() != 0 ? getOperand(0) : nullptr;
2784 unsigned getNumSuccessors() const { return 0; }
2786 // Methods for support type inquiry through isa, cast, and dyn_cast:
2787 static inline bool classof(const Instruction *I) {
2788 return (I->getOpcode() == Instruction::Ret);
2790 static inline bool classof(const Value *V) {
2791 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2795 BasicBlock *getSuccessorV(unsigned idx) const override;
2796 unsigned getNumSuccessorsV() const override;
2797 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2801 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2804 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2806 //===----------------------------------------------------------------------===//
2808 //===----------------------------------------------------------------------===//
2810 //===---------------------------------------------------------------------------
2811 /// BranchInst - Conditional or Unconditional Branch instruction.
2813 class BranchInst : public TerminatorInst {
2814 /// Ops list - Branches are strange. The operands are ordered:
2815 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2816 /// they don't have to check for cond/uncond branchness. These are mostly
2817 /// accessed relative from op_end().
2818 BranchInst(const BranchInst &BI);
2820 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2821 // BranchInst(BB *B) - 'br B'
2822 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2823 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2824 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2825 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2826 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2827 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = nullptr);
2828 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2829 Instruction *InsertBefore = nullptr);
2830 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2831 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2832 BasicBlock *InsertAtEnd);
2835 // Note: Instruction needs to be a friend here to call cloneImpl.
2836 friend class Instruction;
2837 BranchInst *cloneImpl() const;
2840 static BranchInst *Create(BasicBlock *IfTrue,
2841 Instruction *InsertBefore = nullptr) {
2842 return new(1) BranchInst(IfTrue, InsertBefore);
2844 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2845 Value *Cond, Instruction *InsertBefore = nullptr) {
2846 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2848 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2849 return new(1) BranchInst(IfTrue, InsertAtEnd);
2851 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2852 Value *Cond, BasicBlock *InsertAtEnd) {
2853 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2856 /// Transparently provide more efficient getOperand methods.
2857 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2859 bool isUnconditional() const { return getNumOperands() == 1; }
2860 bool isConditional() const { return getNumOperands() == 3; }
2862 Value *getCondition() const {
2863 assert(isConditional() && "Cannot get condition of an uncond branch!");
2867 void setCondition(Value *V) {
2868 assert(isConditional() && "Cannot set condition of unconditional branch!");
2872 unsigned getNumSuccessors() const { return 1+isConditional(); }
2874 BasicBlock *getSuccessor(unsigned i) const {
2875 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2876 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2879 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2880 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2881 *(&Op<-1>() - idx) = NewSucc;
2884 /// \brief Swap the successors of this branch instruction.
2886 /// Swaps the successors of the branch instruction. This also swaps any
2887 /// branch weight metadata associated with the instruction so that it
2888 /// continues to map correctly to each operand.
2889 void swapSuccessors();
2891 // Methods for support type inquiry through isa, cast, and dyn_cast:
2892 static inline bool classof(const Instruction *I) {
2893 return (I->getOpcode() == Instruction::Br);
2895 static inline bool classof(const Value *V) {
2896 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2900 BasicBlock *getSuccessorV(unsigned idx) const override;
2901 unsigned getNumSuccessorsV() const override;
2902 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2906 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2909 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2911 //===----------------------------------------------------------------------===//
2913 //===----------------------------------------------------------------------===//
2915 //===---------------------------------------------------------------------------
2916 /// SwitchInst - Multiway switch
2918 class SwitchInst : public TerminatorInst {
2919 void *operator new(size_t, unsigned) = delete;
2920 unsigned ReservedSpace;
2921 // Operand[0] = Value to switch on
2922 // Operand[1] = Default basic block destination
2923 // Operand[2n ] = Value to match
2924 // Operand[2n+1] = BasicBlock to go to on match
2925 SwitchInst(const SwitchInst &SI);
2926 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2927 void growOperands();
2928 // allocate space for exactly zero operands
2929 void *operator new(size_t s) {
2930 return User::operator new(s);
2932 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2933 /// switch on and a default destination. The number of additional cases can
2934 /// be specified here to make memory allocation more efficient. This
2935 /// constructor can also autoinsert before another instruction.
2936 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2937 Instruction *InsertBefore);
2939 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2940 /// switch on and a default destination. The number of additional cases can
2941 /// be specified here to make memory allocation more efficient. This
2942 /// constructor also autoinserts at the end of the specified BasicBlock.
2943 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2944 BasicBlock *InsertAtEnd);
2947 // Note: Instruction needs to be a friend here to call cloneImpl.
2948 friend class Instruction;
2949 SwitchInst *cloneImpl() const;
2953 static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
2955 template <class SwitchInstTy, class ConstantIntTy, class BasicBlockTy>
2956 class CaseIteratorT {
2962 typedef CaseIteratorT<SwitchInstTy, ConstantIntTy, BasicBlockTy> Self;
2964 /// Initializes case iterator for given SwitchInst and for given
2966 CaseIteratorT(SwitchInstTy *SI, unsigned CaseNum) {
2971 /// Initializes case iterator for given SwitchInst and for given
2972 /// TerminatorInst's successor index.
2973 static Self fromSuccessorIndex(SwitchInstTy *SI, unsigned SuccessorIndex) {
2974 assert(SuccessorIndex < SI->getNumSuccessors() &&
2975 "Successor index # out of range!");
2976 return SuccessorIndex != 0 ?
2977 Self(SI, SuccessorIndex - 1) :
2978 Self(SI, DefaultPseudoIndex);
2981 /// Resolves case value for current case.
2982 ConstantIntTy *getCaseValue() {
2983 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2984 return reinterpret_cast<ConstantIntTy*>(SI->getOperand(2 + Index*2));
2987 /// Resolves successor for current case.
2988 BasicBlockTy *getCaseSuccessor() {
2989 assert((Index < SI->getNumCases() ||
2990 Index == DefaultPseudoIndex) &&
2991 "Index out the number of cases.");
2992 return SI->getSuccessor(getSuccessorIndex());
2995 /// Returns number of current case.
2996 unsigned getCaseIndex() const { return Index; }
2998 /// Returns TerminatorInst's successor index for current case successor.
2999 unsigned getSuccessorIndex() const {
3000 assert((Index == DefaultPseudoIndex || Index < SI->getNumCases()) &&
3001 "Index out the number of cases.");
3002 return Index != DefaultPseudoIndex ? Index + 1 : 0;
3006 // Check index correctness after increment.
3007 // Note: Index == getNumCases() means end().
3008 assert(Index+1 <= SI->getNumCases() && "Index out the number of cases.");
3012 Self operator++(int) {
3018 // Check index correctness after decrement.
3019 // Note: Index == getNumCases() means end().
3020 // Also allow "-1" iterator here. That will became valid after ++.
3021 assert((Index == 0 || Index-1 <= SI->getNumCases()) &&
3022 "Index out the number of cases.");
3026 Self operator--(int) {
3031 bool operator==(const Self& RHS) const {
3032 assert(RHS.SI == SI && "Incompatible operators.");
3033 return RHS.Index == Index;
3035 bool operator!=(const Self& RHS) const {
3036 assert(RHS.SI == SI && "Incompatible operators.");
3037 return RHS.Index != Index;
3044 typedef CaseIteratorT<const SwitchInst, const ConstantInt, const BasicBlock>
3047 class CaseIt : public CaseIteratorT<SwitchInst, ConstantInt, BasicBlock> {
3049 typedef CaseIteratorT<SwitchInst, ConstantInt, BasicBlock> ParentTy;
3052 CaseIt(const ParentTy &Src) : ParentTy(Src) {}
3053 CaseIt(SwitchInst *SI, unsigned CaseNum) : ParentTy(SI, CaseNum) {}
3055 /// Sets the new value for current case.
3056 void setValue(ConstantInt *V) {
3057 assert(Index < SI->getNumCases() && "Index out the number of cases.");
3058 SI->setOperand(2 + Index*2, reinterpret_cast<Value*>(V));
3061 /// Sets the new successor for current case.
3062 void setSuccessor(BasicBlock *S) {
3063 SI->setSuccessor(getSuccessorIndex(), S);
3067 static SwitchInst *Create(Value *Value, BasicBlock *Default,
3069 Instruction *InsertBefore = nullptr) {
3070 return new SwitchInst(Value, Default, NumCases, InsertBefore);
3072 static SwitchInst *Create(Value *Value, BasicBlock *Default,
3073 unsigned NumCases, BasicBlock *InsertAtEnd) {
3074 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
3077 /// Provide fast operand accessors
3078 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3080 // Accessor Methods for Switch stmt
3081 Value *getCondition() const { return getOperand(0); }
3082 void setCondition(Value *V) { setOperand(0, V); }
3084 BasicBlock *getDefaultDest() const {
3085 return cast<BasicBlock>(getOperand(1));
3088 void setDefaultDest(BasicBlock *DefaultCase) {
3089 setOperand(1, reinterpret_cast<Value*>(DefaultCase));
3092 /// getNumCases - return the number of 'cases' in this switch instruction,
3093 /// except the default case
3094 unsigned getNumCases() const {
3095 return getNumOperands()/2 - 1;
3098 /// Returns a read/write iterator that points to the first
3099 /// case in SwitchInst.
3100 CaseIt case_begin() {
3101 return CaseIt(this, 0);
3103 /// Returns a read-only iterator that points to the first
3104 /// case in the SwitchInst.
3105 ConstCaseIt case_begin() const {
3106 return ConstCaseIt(this, 0);
3109 /// Returns a read/write iterator that points one past the last
3110 /// in the SwitchInst.
3112 return CaseIt(this, getNumCases());
3114 /// Returns a read-only iterator that points one past the last
3115 /// in the SwitchInst.
3116 ConstCaseIt case_end() const {
3117 return ConstCaseIt(this, getNumCases());
3120 /// cases - iteration adapter for range-for loops.
3121 iterator_range<CaseIt> cases() {
3122 return iterator_range<CaseIt>(case_begin(), case_end());
3125 /// cases - iteration adapter for range-for loops.
3126 iterator_range<ConstCaseIt> cases() const {
3127 return iterator_range<ConstCaseIt>(case_begin(), case_end());
3130 /// Returns an iterator that points to the default case.
3131 /// Note: this iterator allows to resolve successor only. Attempt
3132 /// to resolve case value causes an assertion.
3133 /// Also note, that increment and decrement also causes an assertion and
3134 /// makes iterator invalid.
3135 CaseIt case_default() {
3136 return CaseIt(this, DefaultPseudoIndex);
3138 ConstCaseIt case_default() const {
3139 return ConstCaseIt(this, DefaultPseudoIndex);
3142 /// findCaseValue - Search all of the case values for the specified constant.
3143 /// If it is explicitly handled, return the case iterator of it, otherwise
3144 /// return default case iterator to indicate
3145 /// that it is handled by the default handler.
3146 CaseIt findCaseValue(const ConstantInt *C) {
3147 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i)
3148 if (i.getCaseValue() == C)
3150 return case_default();
3152 ConstCaseIt findCaseValue(const ConstantInt *C) const {
3153 for (ConstCaseIt i = case_begin(), e = case_end(); i != e; ++i)
3154 if (i.getCaseValue() == C)
3156 return case_default();
3159 /// findCaseDest - Finds the unique case value for a given successor. Returns
3160 /// null if the successor is not found, not unique, or is the default case.
3161 ConstantInt *findCaseDest(BasicBlock *BB) {
3162 if (BB == getDefaultDest()) return nullptr;
3164 ConstantInt *CI = nullptr;
3165 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i) {
3166 if (i.getCaseSuccessor() == BB) {
3167 if (CI) return nullptr; // Multiple cases lead to BB.
3168 else CI = i.getCaseValue();
3174 /// addCase - Add an entry to the switch instruction...
3176 /// This action invalidates case_end(). Old case_end() iterator will
3177 /// point to the added case.
3178 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
3180 /// removeCase - This method removes the specified case and its successor
3181 /// from the switch instruction. Note that this operation may reorder the
3182 /// remaining cases at index idx and above.
3184 /// This action invalidates iterators for all cases following the one removed,
3185 /// including the case_end() iterator.
3186 void removeCase(CaseIt i);
3188 unsigned getNumSuccessors() const { return getNumOperands()/2; }
3189 BasicBlock *getSuccessor(unsigned idx) const {
3190 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
3191 return cast<BasicBlock>(getOperand(idx*2+1));
3193 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3194 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
3195 setOperand(idx * 2 + 1, NewSucc);
3198 // Methods for support type inquiry through isa, cast, and dyn_cast:
3199 static inline bool classof(const Instruction *I) {
3200 return I->getOpcode() == Instruction::Switch;
3202 static inline bool classof(const Value *V) {
3203 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3207 BasicBlock *getSuccessorV(unsigned idx) const override;
3208 unsigned getNumSuccessorsV() const override;
3209 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3213 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
3216 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
3218 //===----------------------------------------------------------------------===//
3219 // IndirectBrInst Class
3220 //===----------------------------------------------------------------------===//
3222 //===---------------------------------------------------------------------------
3223 /// IndirectBrInst - Indirect Branch Instruction.
3225 class IndirectBrInst : public TerminatorInst {
3226 void *operator new(size_t, unsigned) = delete;
3227 unsigned ReservedSpace;
3228 // Operand[0] = Value to switch on
3229 // Operand[1] = Default basic block destination
3230 // Operand[2n ] = Value to match
3231 // Operand[2n+1] = BasicBlock to go to on match
3232 IndirectBrInst(const IndirectBrInst &IBI);
3233 void init(Value *Address, unsigned NumDests);
3234 void growOperands();
3235 // allocate space for exactly zero operands
3236 void *operator new(size_t s) {
3237 return User::operator new(s);
3239 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
3240 /// Address to jump to. The number of expected destinations can be specified
3241 /// here to make memory allocation more efficient. This constructor can also
3242 /// autoinsert before another instruction.
3243 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
3245 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
3246 /// Address to jump to. The number of expected destinations can be specified
3247 /// here to make memory allocation more efficient. This constructor also
3248 /// autoinserts at the end of the specified BasicBlock.
3249 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
3252 // Note: Instruction needs to be a friend here to call cloneImpl.
3253 friend class Instruction;
3254 IndirectBrInst *cloneImpl() const;
3257 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3258 Instruction *InsertBefore = nullptr) {
3259 return new IndirectBrInst(Address, NumDests, InsertBefore);
3261 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3262 BasicBlock *InsertAtEnd) {
3263 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
3266 /// Provide fast operand accessors.
3267 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3269 // Accessor Methods for IndirectBrInst instruction.
3270 Value *getAddress() { return getOperand(0); }
3271 const Value *getAddress() const { return getOperand(0); }
3272 void setAddress(Value *V) { setOperand(0, V); }
3274 /// getNumDestinations - return the number of possible destinations in this
3275 /// indirectbr instruction.
3276 unsigned getNumDestinations() const { return getNumOperands()-1; }
3278 /// getDestination - Return the specified destination.
3279 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
3280 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
3282 /// addDestination - Add a destination.
3284 void addDestination(BasicBlock *Dest);
3286 /// removeDestination - This method removes the specified successor from the
3287 /// indirectbr instruction.
3288 void removeDestination(unsigned i);
3290 unsigned getNumSuccessors() const { return getNumOperands()-1; }
3291 BasicBlock *getSuccessor(unsigned i) const {
3292 return cast<BasicBlock>(getOperand(i+1));
3294 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
3295 setOperand(i + 1, NewSucc);
3298 // Methods for support type inquiry through isa, cast, and dyn_cast:
3299 static inline bool classof(const Instruction *I) {
3300 return I->getOpcode() == Instruction::IndirectBr;
3302 static inline bool classof(const Value *V) {
3303 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3307 BasicBlock *getSuccessorV(unsigned idx) const override;
3308 unsigned getNumSuccessorsV() const override;
3309 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3313 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
3316 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
3318 //===----------------------------------------------------------------------===//
3320 //===----------------------------------------------------------------------===//
3322 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
3323 /// calling convention of the call.
3325 class InvokeInst : public TerminatorInst,
3326 public OperandBundleUser<InvokeInst, User::op_iterator> {
3327 AttributeSet AttributeList;
3329 InvokeInst(const InvokeInst &BI);
3330 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3331 ArrayRef<Value *> Args, ArrayRef<OperandBundleDef> Bundles,
3332 const Twine &NameStr) {
3333 init(cast<FunctionType>(
3334 cast<PointerType>(Func->getType())->getElementType()),
3335 Func, IfNormal, IfException, Args, Bundles, NameStr);
3337 void init(FunctionType *FTy, Value *Func, BasicBlock *IfNormal,
3338 BasicBlock *IfException, ArrayRef<Value *> Args,
3339 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr);
3341 /// Construct an InvokeInst given a range of arguments.
3343 /// \brief Construct an InvokeInst from a range of arguments
3344 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3345 ArrayRef<Value *> Args, ArrayRef<OperandBundleDef> Bundles,
3346 unsigned Values, const Twine &NameStr,
3347 Instruction *InsertBefore)
3348 : InvokeInst(cast<FunctionType>(
3349 cast<PointerType>(Func->getType())->getElementType()),
3350 Func, IfNormal, IfException, Args, Bundles, Values, NameStr,
3353 inline InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3354 BasicBlock *IfException, ArrayRef<Value *> Args,
3355 ArrayRef<OperandBundleDef> Bundles, unsigned Values,
3356 const Twine &NameStr, Instruction *InsertBefore);
3357 /// Construct an InvokeInst given a range of arguments.
3359 /// \brief Construct an InvokeInst from a range of arguments
3360 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3361 ArrayRef<Value *> Args, ArrayRef<OperandBundleDef> Bundles,
3362 unsigned Values, const Twine &NameStr,
3363 BasicBlock *InsertAtEnd);
3365 friend class OperandBundleUser<InvokeInst, User::op_iterator>;
3366 bool hasDescriptor() const { return HasDescriptor; }
3369 // Note: Instruction needs to be a friend here to call cloneImpl.
3370 friend class Instruction;
3371 InvokeInst *cloneImpl() const;
3374 static InvokeInst *Create(Value *Func, BasicBlock *IfNormal,
3375 BasicBlock *IfException, ArrayRef<Value *> Args,
3376 const Twine &NameStr,
3377 Instruction *InsertBefore = nullptr) {
3378 return Create(cast<FunctionType>(
3379 cast<PointerType>(Func->getType())->getElementType()),
3380 Func, IfNormal, IfException, Args, None, NameStr,
3383 static InvokeInst *Create(Value *Func, BasicBlock *IfNormal,
3384 BasicBlock *IfException, ArrayRef<Value *> Args,
3385 ArrayRef<OperandBundleDef> Bundles = None,
3386 const Twine &NameStr = "",
3387 Instruction *InsertBefore = nullptr) {
3388 return Create(cast<FunctionType>(
3389 cast<PointerType>(Func->getType())->getElementType()),
3390 Func, IfNormal, IfException, Args, Bundles, NameStr,
3393 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3394 BasicBlock *IfException, ArrayRef<Value *> Args,
3395 const Twine &NameStr,
3396 Instruction *InsertBefore = nullptr) {
3397 unsigned Values = unsigned(Args.size()) + 3;
3398 return new (Values) InvokeInst(Ty, Func, IfNormal, IfException, Args, None,
3399 Values, NameStr, InsertBefore);
3401 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3402 BasicBlock *IfException, ArrayRef<Value *> Args,
3403 ArrayRef<OperandBundleDef> Bundles = None,
3404 const Twine &NameStr = "",
3405 Instruction *InsertBefore = nullptr) {
3406 unsigned Values = unsigned(Args.size()) + CountBundleInputs(Bundles) + 3;
3407 unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
3409 return new (Values, DescriptorBytes)
3410 InvokeInst(Ty, Func, IfNormal, IfException, Args, Bundles, Values,
3411 NameStr, InsertBefore);
3413 static InvokeInst *Create(Value *Func,
3414 BasicBlock *IfNormal, BasicBlock *IfException,
3415 ArrayRef<Value *> Args, const Twine &NameStr,
3416 BasicBlock *InsertAtEnd) {
3417 unsigned Values = unsigned(Args.size()) + 3;
3418 return new (Values) InvokeInst(Func, IfNormal, IfException, Args, None,
3419 Values, NameStr, InsertAtEnd);
3421 static InvokeInst *Create(Value *Func, BasicBlock *IfNormal,
3422 BasicBlock *IfException, ArrayRef<Value *> Args,
3423 ArrayRef<OperandBundleDef> Bundles,
3424 const Twine &NameStr, BasicBlock *InsertAtEnd) {
3425 unsigned Values = unsigned(Args.size()) + CountBundleInputs(Bundles) + 3;
3426 unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
3428 return new (Values, DescriptorBytes)
3429 InvokeInst(Func, IfNormal, IfException, Args, Bundles, Values, NameStr,
3433 /// \brief Create a clone of \p II with a different set of operand bundles and
3434 /// insert it before \p InsertPt.
3436 /// The returned invoke instruction is identical to \p II in every way except
3437 /// that the operand bundles for the new instruction are set to the operand
3438 /// bundles in \p Bundles.
3439 static InvokeInst *Create(InvokeInst *II, ArrayRef<OperandBundleDef> Bundles,
3440 Instruction *InsertPt = nullptr);
3442 /// Provide fast operand accessors
3443 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3445 FunctionType *getFunctionType() const { return FTy; }
3447 void mutateFunctionType(FunctionType *FTy) {
3448 mutateType(FTy->getReturnType());
3452 /// getNumArgOperands - Return the number of invoke arguments.
3454 unsigned getNumArgOperands() const {
3455 return getNumOperands() - getNumTotalBundleOperands() - 3;
3458 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
3460 Value *getArgOperand(unsigned i) const {
3461 assert(i < getNumArgOperands() && "Out of bounds!");
3462 return getOperand(i);
3464 void setArgOperand(unsigned i, Value *v) {
3465 assert(i < getNumArgOperands() && "Out of bounds!");
3469 /// arg_operands - iteration adapter for range-for loops.
3470 iterator_range<op_iterator> arg_operands() {
3471 return iterator_range<op_iterator>(
3472 op_begin(), op_end() - getNumTotalBundleOperands() - 3);
3475 /// arg_operands - iteration adapter for range-for loops.
3476 iterator_range<const_op_iterator> arg_operands() const {
3477 return iterator_range<const_op_iterator>(
3478 op_begin(), op_end() - getNumTotalBundleOperands() - 3);
3481 /// \brief Wrappers for getting the \c Use of a invoke argument.
3482 const Use &getArgOperandUse(unsigned i) const {
3483 assert(i < getNumArgOperands() && "Out of bounds!");
3484 return getOperandUse(i);
3486 Use &getArgOperandUse(unsigned i) {
3487 assert(i < getNumArgOperands() && "Out of bounds!");
3488 return getOperandUse(i);
3491 /// getCallingConv/setCallingConv - Get or set the calling convention of this
3493 CallingConv::ID getCallingConv() const {
3494 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
3496 void setCallingConv(CallingConv::ID CC) {
3497 auto ID = static_cast<unsigned>(CC);
3498 assert(!(ID & ~CallingConv::MaxID) && "Unsupported calling convention");
3499 setInstructionSubclassData(ID);
3502 /// getAttributes - Return the parameter attributes for this invoke.
3504 const AttributeSet &getAttributes() const { return AttributeList; }
3506 /// setAttributes - Set the parameter attributes for this invoke.
3508 void setAttributes(const AttributeSet &Attrs) { AttributeList = Attrs; }
3510 /// addAttribute - adds the attribute to the list of attributes.
3511 void addAttribute(unsigned i, Attribute::AttrKind attr);
3513 /// removeAttribute - removes the attribute from the list of attributes.
3514 void removeAttribute(unsigned i, Attribute attr);
3516 /// \brief adds the dereferenceable attribute to the list of attributes.
3517 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
3519 /// \brief adds the dereferenceable_or_null attribute to the list of
3521 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
3523 /// \brief Determine whether this call has the given attribute.
3524 bool hasFnAttr(Attribute::AttrKind A) const {
3525 assert(A != Attribute::NoBuiltin &&
3526 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
3527 return hasFnAttrImpl(A);
3530 /// \brief Determine whether the call or the callee has the given attributes.
3531 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const;
3533 /// \brief Return true if the data operand at index \p i has the attribute \p
3536 /// Data operands include invoke arguments and values used in operand bundles,
3537 /// but does not include the invokee operand, or the two successor blocks.
3538 /// This routine dispatches to the underlying AttributeList or the
3539 /// OperandBundleUser as appropriate.
3541 /// The index \p i is interpreted as
3543 /// \p i == Attribute::ReturnIndex -> the return value
3544 /// \p i in [1, arg_size + 1) -> argument number (\p i - 1)
3545 /// \p i in [arg_size + 1, data_operand_size + 1) -> bundle operand at index
3546 /// (\p i - 1) in the operand list.
3547 bool dataOperandHasImpliedAttr(unsigned i, Attribute::AttrKind A) const;
3549 /// \brief Extract the alignment for a call or parameter (0=unknown).
3550 unsigned getParamAlignment(unsigned i) const {
3551 return AttributeList.getParamAlignment(i);
3554 /// \brief Extract the number of dereferenceable bytes for a call or
3555 /// parameter (0=unknown).
3556 uint64_t getDereferenceableBytes(unsigned i) const {
3557 return AttributeList.getDereferenceableBytes(i);
3560 /// \brief Extract the number of dereferenceable_or_null bytes for a call or
3561 /// parameter (0=unknown).
3562 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
3563 return AttributeList.getDereferenceableOrNullBytes(i);
3566 /// @brief Determine if the parameter or return value is marked with NoAlias
3568 /// @param n The parameter to check. 1 is the first parameter, 0 is the return
3569 bool doesNotAlias(unsigned n) const {
3570 return AttributeList.hasAttribute(n, Attribute::NoAlias);
3573 /// \brief Return true if the call should not be treated as a call to a
3575 bool isNoBuiltin() const {
3576 // We assert in hasFnAttr if one passes in Attribute::NoBuiltin, so we have
3577 // to check it by hand.
3578 return hasFnAttrImpl(Attribute::NoBuiltin) &&
3579 !hasFnAttrImpl(Attribute::Builtin);
3582 /// \brief Return true if the call should not be inlined.
3583 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
3584 void setIsNoInline() {
3585 addAttribute(AttributeSet::FunctionIndex, Attribute::NoInline);
3588 /// \brief Determine if the call does not access memory.
3589 bool doesNotAccessMemory() const {
3590 return hasFnAttr(Attribute::ReadNone);
3592 void setDoesNotAccessMemory() {
3593 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
3596 /// \brief Determine if the call does not access or only reads memory.
3597 bool onlyReadsMemory() const {
3598 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
3600 void setOnlyReadsMemory() {
3601 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
3604 /// @brief Determine if the call access memmory only using it's pointer
3606 bool onlyAccessesArgMemory() const {
3607 return hasFnAttr(Attribute::ArgMemOnly);
3609 void setOnlyAccessesArgMemory() {
3610 addAttribute(AttributeSet::FunctionIndex, Attribute::ArgMemOnly);
3613 /// \brief Determine if the call cannot return.
3614 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
3615 void setDoesNotReturn() {
3616 addAttribute(AttributeSet::FunctionIndex, Attribute::NoReturn);
3619 /// \brief Determine if the call cannot unwind.
3620 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
3621 void setDoesNotThrow() {
3622 addAttribute(AttributeSet::FunctionIndex, Attribute::NoUnwind);
3625 /// \brief Determine if the invoke cannot be duplicated.
3626 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
3627 void setCannotDuplicate() {
3628 addAttribute(AttributeSet::FunctionIndex, Attribute::NoDuplicate);
3631 /// \brief Determine if the call returns a structure through first
3632 /// pointer argument.
3633 bool hasStructRetAttr() const {
3634 // Be friendly and also check the callee.
3635 return paramHasAttr(1, Attribute::StructRet);
3638 /// \brief Determine if any call argument is an aggregate passed by value.
3639 bool hasByValArgument() const {
3640 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
3643 /// getCalledFunction - Return the function called, or null if this is an
3644 /// indirect function invocation.
3646 Function *getCalledFunction() const {
3647 return dyn_cast<Function>(Op<-3>());
3650 /// getCalledValue - Get a pointer to the function that is invoked by this
3652 const Value *getCalledValue() const { return Op<-3>(); }
3653 Value *getCalledValue() { return Op<-3>(); }
3655 /// setCalledFunction - Set the function called.
3656 void setCalledFunction(Value* Fn) {
3658 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
3661 void setCalledFunction(FunctionType *FTy, Value *Fn) {
3663 assert(FTy == cast<FunctionType>(
3664 cast<PointerType>(Fn->getType())->getElementType()));
3668 // get*Dest - Return the destination basic blocks...
3669 BasicBlock *getNormalDest() const {
3670 return cast<BasicBlock>(Op<-2>());
3672 BasicBlock *getUnwindDest() const {
3673 return cast<BasicBlock>(Op<-1>());
3675 void setNormalDest(BasicBlock *B) {
3676 Op<-2>() = reinterpret_cast<Value*>(B);
3678 void setUnwindDest(BasicBlock *B) {
3679 Op<-1>() = reinterpret_cast<Value*>(B);
3682 /// getLandingPadInst - Get the landingpad instruction from the landing pad
3683 /// block (the unwind destination).
3684 LandingPadInst *getLandingPadInst() const;
3686 BasicBlock *getSuccessor(unsigned i) const {
3687 assert(i < 2 && "Successor # out of range for invoke!");
3688 return i == 0 ? getNormalDest() : getUnwindDest();
3691 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3692 assert(idx < 2 && "Successor # out of range for invoke!");
3693 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
3696 unsigned getNumSuccessors() const { return 2; }
3698 // Methods for support type inquiry through isa, cast, and dyn_cast:
3699 static inline bool classof(const Instruction *I) {
3700 return (I->getOpcode() == Instruction::Invoke);
3702 static inline bool classof(const Value *V) {
3703 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3707 BasicBlock *getSuccessorV(unsigned idx) const override;
3708 unsigned getNumSuccessorsV() const override;
3709 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3711 bool hasFnAttrImpl(Attribute::AttrKind A) const;
3713 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3714 // method so that subclasses cannot accidentally use it.
3715 void setInstructionSubclassData(unsigned short D) {
3716 Instruction::setInstructionSubclassData(D);
3721 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
3724 InvokeInst::InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3725 BasicBlock *IfException, ArrayRef<Value *> Args,
3726 ArrayRef<OperandBundleDef> Bundles, unsigned Values,
3727 const Twine &NameStr, Instruction *InsertBefore)
3728 : TerminatorInst(Ty->getReturnType(), Instruction::Invoke,
3729 OperandTraits<InvokeInst>::op_end(this) - Values, Values,
3731 init(Ty, Func, IfNormal, IfException, Args, Bundles, NameStr);
3733 InvokeInst::InvokeInst(Value *Func, BasicBlock *IfNormal,
3734 BasicBlock *IfException, ArrayRef<Value *> Args,
3735 ArrayRef<OperandBundleDef> Bundles, unsigned Values,
3736 const Twine &NameStr, BasicBlock *InsertAtEnd)
3738 cast<FunctionType>(cast<PointerType>(Func->getType())
3739 ->getElementType())->getReturnType(),
3740 Instruction::Invoke, OperandTraits<InvokeInst>::op_end(this) - Values,
3741 Values, InsertAtEnd) {
3742 init(Func, IfNormal, IfException, Args, Bundles, NameStr);
3745 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
3747 //===----------------------------------------------------------------------===//
3749 //===----------------------------------------------------------------------===//
3751 //===---------------------------------------------------------------------------
3752 /// ResumeInst - Resume the propagation of an exception.
3754 class ResumeInst : public TerminatorInst {
3755 ResumeInst(const ResumeInst &RI);
3757 explicit ResumeInst(Value *Exn, Instruction *InsertBefore=nullptr);
3758 ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
3761 // Note: Instruction needs to be a friend here to call cloneImpl.
3762 friend class Instruction;
3763 ResumeInst *cloneImpl() const;
3766 static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = nullptr) {
3767 return new(1) ResumeInst(Exn, InsertBefore);
3769 static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
3770 return new(1) ResumeInst(Exn, InsertAtEnd);
3773 /// Provide fast operand accessors
3774 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3776 /// Convenience accessor.
3777 Value *getValue() const { return Op<0>(); }
3779 unsigned getNumSuccessors() const { return 0; }
3781 // Methods for support type inquiry through isa, cast, and dyn_cast:
3782 static inline bool classof(const Instruction *I) {
3783 return I->getOpcode() == Instruction::Resume;
3785 static inline bool classof(const Value *V) {
3786 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3790 BasicBlock *getSuccessorV(unsigned idx) const override;
3791 unsigned getNumSuccessorsV() const override;
3792 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3796 struct OperandTraits<ResumeInst> :
3797 public FixedNumOperandTraits<ResumeInst, 1> {
3800 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
3802 //===----------------------------------------------------------------------===//
3803 // CatchEndPadInst Class
3804 //===----------------------------------------------------------------------===//
3806 class CatchEndPadInst : public TerminatorInst {
3808 CatchEndPadInst(const CatchEndPadInst &RI);
3810 void init(BasicBlock *UnwindBB);
3811 CatchEndPadInst(LLVMContext &C, BasicBlock *UnwindBB, unsigned Values,
3812 Instruction *InsertBefore = nullptr);
3813 CatchEndPadInst(LLVMContext &C, BasicBlock *UnwindBB, unsigned Values,
3814 BasicBlock *InsertAtEnd);
3817 // Note: Instruction needs to be a friend here to call cloneImpl.
3818 friend class Instruction;
3819 CatchEndPadInst *cloneImpl() const;
3822 static CatchEndPadInst *Create(LLVMContext &C, BasicBlock *UnwindBB = nullptr,
3823 Instruction *InsertBefore = nullptr) {
3824 unsigned Values = UnwindBB ? 1 : 0;
3825 return new (Values) CatchEndPadInst(C, UnwindBB, Values, InsertBefore);
3827 static CatchEndPadInst *Create(LLVMContext &C, BasicBlock *UnwindBB,
3828 BasicBlock *InsertAtEnd) {
3829 unsigned Values = UnwindBB ? 1 : 0;
3830 return new (Values) CatchEndPadInst(C, UnwindBB, Values, InsertAtEnd);
3833 /// Provide fast operand accessors
3834 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3836 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
3837 bool unwindsToCaller() const { return !hasUnwindDest(); }
3839 /// Convenience accessor. Returns null if there is no return value.
3840 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
3842 BasicBlock *getUnwindDest() const {
3843 return hasUnwindDest() ? cast<BasicBlock>(Op<-1>()) : nullptr;
3845 void setUnwindDest(BasicBlock *NewDest) {
3850 // Methods for support type inquiry through isa, cast, and dyn_cast:
3851 static inline bool classof(const Instruction *I) {
3852 return (I->getOpcode() == Instruction::CatchEndPad);
3854 static inline bool classof(const Value *V) {
3855 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3859 BasicBlock *getSuccessorV(unsigned Idx) const override;
3860 unsigned getNumSuccessorsV() const override;
3861 void setSuccessorV(unsigned Idx, BasicBlock *B) override;
3863 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3864 // method so that subclasses cannot accidentally use it.
3865 void setInstructionSubclassData(unsigned short D) {
3866 Instruction::setInstructionSubclassData(D);
3871 struct OperandTraits<CatchEndPadInst>
3872 : public VariadicOperandTraits<CatchEndPadInst> {};
3874 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchEndPadInst, Value)
3876 //===----------------------------------------------------------------------===//
3877 // CatchPadInst Class
3878 //===----------------------------------------------------------------------===//
3880 class CatchPadInst : public TerminatorInst {
3882 void init(BasicBlock *IfNormal, BasicBlock *IfException,
3883 ArrayRef<Value *> Args, const Twine &NameStr);
3885 CatchPadInst(const CatchPadInst &CPI);
3887 explicit CatchPadInst(BasicBlock *IfNormal, BasicBlock *IfException,
3888 ArrayRef<Value *> Args, unsigned Values,
3889 const Twine &NameStr, Instruction *InsertBefore);
3890 explicit CatchPadInst(BasicBlock *IfNormal, BasicBlock *IfException,
3891 ArrayRef<Value *> Args, unsigned Values,
3892 const Twine &NameStr, BasicBlock *InsertAtEnd);
3895 // Note: Instruction needs to be a friend here to call cloneImpl.
3896 friend class Instruction;
3897 CatchPadInst *cloneImpl() const;
3900 static CatchPadInst *Create(BasicBlock *IfNormal, BasicBlock *IfException,
3901 ArrayRef<Value *> Args, const Twine &NameStr = "",
3902 Instruction *InsertBefore = nullptr) {
3903 unsigned Values = unsigned(Args.size()) + 2;
3904 return new (Values) CatchPadInst(IfNormal, IfException, Args, Values,
3905 NameStr, InsertBefore);
3907 static CatchPadInst *Create(BasicBlock *IfNormal, BasicBlock *IfException,
3908 ArrayRef<Value *> Args, const Twine &NameStr,
3909 BasicBlock *InsertAtEnd) {
3910 unsigned Values = unsigned(Args.size()) + 2;
3912 CatchPadInst(IfNormal, IfException, Args, Values, NameStr, InsertAtEnd);
3915 /// Provide fast operand accessors
3916 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3918 /// getNumArgOperands - Return the number of catchpad arguments.
3920 unsigned getNumArgOperands() const { return getNumOperands() - 2; }
3922 /// getArgOperand/setArgOperand - Return/set the i-th catchpad argument.
3924 Value *getArgOperand(unsigned i) const { return getOperand(i); }
3925 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
3927 /// arg_operands - iteration adapter for range-for loops.
3928 iterator_range<op_iterator> arg_operands() {
3929 return iterator_range<op_iterator>(op_begin(), op_end() - 2);
3932 /// arg_operands - iteration adapter for range-for loops.
3933 iterator_range<const_op_iterator> arg_operands() const {
3934 return iterator_range<const_op_iterator>(op_begin(), op_end() - 2);
3937 /// \brief Wrappers for getting the \c Use of a catchpad argument.
3938 const Use &getArgOperandUse(unsigned i) const { return getOperandUse(i); }
3939 Use &getArgOperandUse(unsigned i) { return getOperandUse(i); }
3941 // get*Dest - Return the destination basic blocks...
3942 BasicBlock *getNormalDest() const { return cast<BasicBlock>(Op<-2>()); }
3943 BasicBlock *getUnwindDest() const { return cast<BasicBlock>(Op<-1>()); }
3944 void setNormalDest(BasicBlock *B) { Op<-2>() = B; }
3945 void setUnwindDest(BasicBlock *B) { Op<-1>() = B; }
3947 BasicBlock *getSuccessor(unsigned i) const {
3948 assert(i < 2 && "Successor # out of range for catchpad!");
3949 return i == 0 ? getNormalDest() : getUnwindDest();
3952 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3953 assert(idx < 2 && "Successor # out of range for catchpad!");
3954 *(&Op<-2>() + idx) = NewSucc;
3957 unsigned getNumSuccessors() const { return 2; }
3959 // Methods for support type inquiry through isa, cast, and dyn_cast:
3960 static inline bool classof(const Instruction *I) {
3961 return I->getOpcode() == Instruction::CatchPad;
3963 static inline bool classof(const Value *V) {
3964 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3968 BasicBlock *getSuccessorV(unsigned idx) const override;
3969 unsigned getNumSuccessorsV() const override;
3970 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3974 struct OperandTraits<CatchPadInst>
3975 : public VariadicOperandTraits<CatchPadInst, /*MINARITY=*/2> {};
3977 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchPadInst, Value)
3979 //===----------------------------------------------------------------------===//
3980 // TerminatePadInst Class
3981 //===----------------------------------------------------------------------===//
3983 class TerminatePadInst : public TerminatorInst {
3985 void init(BasicBlock *BB, ArrayRef<Value *> Args);
3987 TerminatePadInst(const TerminatePadInst &TPI);
3989 explicit TerminatePadInst(LLVMContext &C, BasicBlock *BB,
3990 ArrayRef<Value *> Args, unsigned Values,
3991 Instruction *InsertBefore);
3992 explicit TerminatePadInst(LLVMContext &C, BasicBlock *BB,
3993 ArrayRef<Value *> Args, unsigned Values,
3994 BasicBlock *InsertAtEnd);
3997 // Note: Instruction needs to be a friend here to call cloneImpl.
3998 friend class Instruction;
3999 TerminatePadInst *cloneImpl() const;
4002 static TerminatePadInst *Create(LLVMContext &C, BasicBlock *BB = nullptr,
4003 ArrayRef<Value *> Args = None,
4004 Instruction *InsertBefore = nullptr) {
4005 unsigned Values = unsigned(Args.size());
4008 return new (Values) TerminatePadInst(C, BB, Args, Values, InsertBefore);
4010 static TerminatePadInst *Create(LLVMContext &C, BasicBlock *BB,
4011 ArrayRef<Value *> Args,
4012 BasicBlock *InsertAtEnd) {
4013 unsigned Values = unsigned(Args.size());
4016 return new (Values) TerminatePadInst(C, BB, Args, Values, InsertAtEnd);
4019 /// Provide fast operand accessors
4020 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4022 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
4023 bool unwindsToCaller() const { return !hasUnwindDest(); }
4025 /// getNumArgOperands - Return the number of terminatepad arguments.
4027 unsigned getNumArgOperands() const {
4028 unsigned NumOperands = getNumOperands();
4029 if (hasUnwindDest())
4030 return NumOperands - 1;
4034 /// getArgOperand/setArgOperand - Return/set the i-th terminatepad argument.
4036 Value *getArgOperand(unsigned i) const { return getOperand(i); }
4037 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
4039 const_op_iterator arg_end() const {
4040 if (hasUnwindDest())
4041 return op_end() - 1;
4045 op_iterator arg_end() {
4046 if (hasUnwindDest())
4047 return op_end() - 1;
4051 /// arg_operands - iteration adapter for range-for loops.
4052 iterator_range<op_iterator> arg_operands() {
4053 return iterator_range<op_iterator>(op_begin(), arg_end());
4056 /// arg_operands - iteration adapter for range-for loops.
4057 iterator_range<const_op_iterator> arg_operands() const {
4058 return iterator_range<const_op_iterator>(op_begin(), arg_end());
4061 /// \brief Wrappers for getting the \c Use of a terminatepad argument.
4062 const Use &getArgOperandUse(unsigned i) const { return getOperandUse(i); }
4063 Use &getArgOperandUse(unsigned i) { return getOperandUse(i); }
4065 // get*Dest - Return the destination basic blocks...
4066 BasicBlock *getUnwindDest() const {
4067 if (!hasUnwindDest())
4069 return cast<BasicBlock>(Op<-1>());
4071 void setUnwindDest(BasicBlock *B) {
4072 assert(B && hasUnwindDest());
4076 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
4078 // Methods for support type inquiry through isa, cast, and dyn_cast:
4079 static inline bool classof(const Instruction *I) {
4080 return I->getOpcode() == Instruction::TerminatePad;
4082 static inline bool classof(const Value *V) {
4083 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4087 BasicBlock *getSuccessorV(unsigned idx) const override;
4088 unsigned getNumSuccessorsV() const override;
4089 void setSuccessorV(unsigned idx, BasicBlock *B) override;
4091 // Shadow Instruction::setInstructionSubclassData with a private forwarding
4092 // method so that subclasses cannot accidentally use it.
4093 void setInstructionSubclassData(unsigned short D) {
4094 Instruction::setInstructionSubclassData(D);
4099 struct OperandTraits<TerminatePadInst>
4100 : public VariadicOperandTraits<TerminatePadInst, /*MINARITY=*/1> {};
4102 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(TerminatePadInst, Value)
4104 //===----------------------------------------------------------------------===//
4105 // CleanupPadInst Class
4106 //===----------------------------------------------------------------------===//
4108 class CleanupPadInst : public Instruction {
4110 void init(ArrayRef<Value *> Args, const Twine &NameStr);
4112 CleanupPadInst(const CleanupPadInst &CPI);
4114 explicit CleanupPadInst(LLVMContext &C, ArrayRef<Value *> Args,
4115 const Twine &NameStr, Instruction *InsertBefore);
4116 explicit CleanupPadInst(LLVMContext &C, ArrayRef<Value *> Args,
4117 const Twine &NameStr, BasicBlock *InsertAtEnd);
4120 // Note: Instruction needs to be a friend here to call cloneImpl.
4121 friend class Instruction;
4122 CleanupPadInst *cloneImpl() const;
4125 static CleanupPadInst *Create(LLVMContext &C, ArrayRef<Value *> Args,
4126 const Twine &NameStr = "",
4127 Instruction *InsertBefore = nullptr) {
4128 return new (Args.size()) CleanupPadInst(C, Args, NameStr, InsertBefore);
4130 static CleanupPadInst *Create(LLVMContext &C, ArrayRef<Value *> Args,
4131 const Twine &NameStr, BasicBlock *InsertAtEnd) {
4132 return new (Args.size()) CleanupPadInst(C, Args, NameStr, InsertAtEnd);
4135 /// Provide fast operand accessors
4136 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4138 // Methods for support type inquiry through isa, cast, and dyn_cast:
4139 static inline bool classof(const Instruction *I) {
4140 return I->getOpcode() == Instruction::CleanupPad;
4142 static inline bool classof(const Value *V) {
4143 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4148 struct OperandTraits<CleanupPadInst>
4149 : public VariadicOperandTraits<CleanupPadInst, /*MINARITY=*/0> {};
4151 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CleanupPadInst, Value)
4153 //===----------------------------------------------------------------------===//
4154 // CatchReturnInst Class
4155 //===----------------------------------------------------------------------===//
4157 class CatchReturnInst : public TerminatorInst {
4158 CatchReturnInst(const CatchReturnInst &RI);
4160 void init(CatchPadInst *CatchPad, BasicBlock *BB);
4161 CatchReturnInst(CatchPadInst *CatchPad, BasicBlock *BB,
4162 Instruction *InsertBefore);
4163 CatchReturnInst(CatchPadInst *CatchPad, BasicBlock *BB,
4164 BasicBlock *InsertAtEnd);
4167 // Note: Instruction needs to be a friend here to call cloneImpl.
4168 friend class Instruction;
4169 CatchReturnInst *cloneImpl() const;
4172 static CatchReturnInst *Create(CatchPadInst *CatchPad, BasicBlock *BB,
4173 Instruction *InsertBefore = nullptr) {
4176 return new (2) CatchReturnInst(CatchPad, BB, InsertBefore);
4178 static CatchReturnInst *Create(CatchPadInst *CatchPad, BasicBlock *BB,
4179 BasicBlock *InsertAtEnd) {
4182 return new (2) CatchReturnInst(CatchPad, BB, InsertAtEnd);
4185 /// Provide fast operand accessors
4186 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4188 /// Convenience accessors.
4189 CatchPadInst *getCatchPad() const { return cast<CatchPadInst>(Op<0>()); }
4190 void setCatchPad(CatchPadInst *CatchPad) {
4195 BasicBlock *getSuccessor() const { return cast<BasicBlock>(Op<1>()); }
4196 void setSuccessor(BasicBlock *NewSucc) {
4200 unsigned getNumSuccessors() const { return 1; }
4202 // Methods for support type inquiry through isa, cast, and dyn_cast:
4203 static inline bool classof(const Instruction *I) {
4204 return (I->getOpcode() == Instruction::CatchRet);
4206 static inline bool classof(const Value *V) {
4207 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4211 BasicBlock *getSuccessorV(unsigned Idx) const override;
4212 unsigned getNumSuccessorsV() const override;
4213 void setSuccessorV(unsigned Idx, BasicBlock *B) override;
4217 struct OperandTraits<CatchReturnInst>
4218 : public FixedNumOperandTraits<CatchReturnInst, 2> {};
4220 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchReturnInst, Value)
4222 //===----------------------------------------------------------------------===//
4223 // CleanupEndPadInst Class
4224 //===----------------------------------------------------------------------===//
4226 class CleanupEndPadInst : public TerminatorInst {
4228 CleanupEndPadInst(const CleanupEndPadInst &CEPI);
4230 void init(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB);
4231 CleanupEndPadInst(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB,
4232 unsigned Values, Instruction *InsertBefore = nullptr);
4233 CleanupEndPadInst(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB,
4234 unsigned Values, BasicBlock *InsertAtEnd);
4237 // Note: Instruction needs to be a friend here to call cloneImpl.
4238 friend class Instruction;
4239 CleanupEndPadInst *cloneImpl() const;
4242 static CleanupEndPadInst *Create(CleanupPadInst *CleanupPad,
4243 BasicBlock *UnwindBB = nullptr,
4244 Instruction *InsertBefore = nullptr) {
4245 unsigned Values = UnwindBB ? 2 : 1;
4247 CleanupEndPadInst(CleanupPad, UnwindBB, Values, InsertBefore);
4249 static CleanupEndPadInst *Create(CleanupPadInst *CleanupPad,
4250 BasicBlock *UnwindBB,
4251 BasicBlock *InsertAtEnd) {
4252 unsigned Values = UnwindBB ? 2 : 1;
4254 CleanupEndPadInst(CleanupPad, UnwindBB, Values, InsertAtEnd);
4257 /// Provide fast operand accessors
4258 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4260 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
4261 bool unwindsToCaller() const { return !hasUnwindDest(); }
4263 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
4265 /// Convenience accessors
4266 CleanupPadInst *getCleanupPad() const {
4267 return cast<CleanupPadInst>(Op<-1>());
4269 void setCleanupPad(CleanupPadInst *CleanupPad) {
4271 Op<-1>() = CleanupPad;
4274 BasicBlock *getUnwindDest() const {
4275 return hasUnwindDest() ? cast<BasicBlock>(Op<-2>()) : nullptr;
4277 void setUnwindDest(BasicBlock *NewDest) {
4278 assert(hasUnwindDest());
4283 // Methods for support type inquiry through isa, cast, and dyn_cast:
4284 static inline bool classof(const Instruction *I) {
4285 return (I->getOpcode() == Instruction::CleanupEndPad);
4287 static inline bool classof(const Value *V) {
4288 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4292 BasicBlock *getSuccessorV(unsigned Idx) const override;
4293 unsigned getNumSuccessorsV() const override;
4294 void setSuccessorV(unsigned Idx, BasicBlock *B) override;
4296 // Shadow Instruction::setInstructionSubclassData with a private forwarding
4297 // method so that subclasses cannot accidentally use it.
4298 void setInstructionSubclassData(unsigned short D) {
4299 Instruction::setInstructionSubclassData(D);
4304 struct OperandTraits<CleanupEndPadInst>
4305 : public VariadicOperandTraits<CleanupEndPadInst, /*MINARITY=*/1> {};
4307 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CleanupEndPadInst, Value)
4309 //===----------------------------------------------------------------------===//
4310 // CleanupReturnInst Class
4311 //===----------------------------------------------------------------------===//
4313 class CleanupReturnInst : public TerminatorInst {
4315 CleanupReturnInst(const CleanupReturnInst &RI);
4317 void init(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB);
4318 CleanupReturnInst(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB,
4319 unsigned Values, Instruction *InsertBefore = nullptr);
4320 CleanupReturnInst(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB,
4321 unsigned Values, BasicBlock *InsertAtEnd);
4324 // Note: Instruction needs to be a friend here to call cloneImpl.
4325 friend class Instruction;
4326 CleanupReturnInst *cloneImpl() const;
4329 static CleanupReturnInst *Create(CleanupPadInst *CleanupPad,
4330 BasicBlock *UnwindBB = nullptr,
4331 Instruction *InsertBefore = nullptr) {
4333 unsigned Values = 1;
4337 CleanupReturnInst(CleanupPad, UnwindBB, Values, InsertBefore);
4339 static CleanupReturnInst *Create(CleanupPadInst *CleanupPad,
4340 BasicBlock *UnwindBB,
4341 BasicBlock *InsertAtEnd) {
4343 unsigned Values = 1;
4347 CleanupReturnInst(CleanupPad, UnwindBB, Values, InsertAtEnd);
4350 /// Provide fast operand accessors
4351 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4353 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
4354 bool unwindsToCaller() const { return !hasUnwindDest(); }
4356 /// Convenience accessor.
4357 CleanupPadInst *getCleanupPad() const {
4358 return cast<CleanupPadInst>(Op<-1>());
4360 void setCleanupPad(CleanupPadInst *CleanupPad) {
4362 Op<-1>() = CleanupPad;
4365 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
4367 BasicBlock *getUnwindDest() const {
4368 return hasUnwindDest() ? cast<BasicBlock>(Op<-2>()) : nullptr;
4370 void setUnwindDest(BasicBlock *NewDest) {
4372 assert(hasUnwindDest());
4376 // Methods for support type inquiry through isa, cast, and dyn_cast:
4377 static inline bool classof(const Instruction *I) {
4378 return (I->getOpcode() == Instruction::CleanupRet);
4380 static inline bool classof(const Value *V) {
4381 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4385 BasicBlock *getSuccessorV(unsigned Idx) const override;
4386 unsigned getNumSuccessorsV() const override;
4387 void setSuccessorV(unsigned Idx, BasicBlock *B) override;
4389 // Shadow Instruction::setInstructionSubclassData with a private forwarding
4390 // method so that subclasses cannot accidentally use it.
4391 void setInstructionSubclassData(unsigned short D) {
4392 Instruction::setInstructionSubclassData(D);
4397 struct OperandTraits<CleanupReturnInst>
4398 : public VariadicOperandTraits<CleanupReturnInst, /*MINARITY=*/1> {};
4400 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CleanupReturnInst, Value)
4402 //===----------------------------------------------------------------------===//
4403 // UnreachableInst Class
4404 //===----------------------------------------------------------------------===//
4406 //===---------------------------------------------------------------------------
4407 /// UnreachableInst - This function has undefined behavior. In particular, the
4408 /// presence of this instruction indicates some higher level knowledge that the
4409 /// end of the block cannot be reached.
4411 class UnreachableInst : public TerminatorInst {
4412 void *operator new(size_t, unsigned) = delete;
4415 // Note: Instruction needs to be a friend here to call cloneImpl.
4416 friend class Instruction;
4417 UnreachableInst *cloneImpl() const;
4420 // allocate space for exactly zero operands
4421 void *operator new(size_t s) {
4422 return User::operator new(s, 0);
4424 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = nullptr);
4425 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
4427 unsigned getNumSuccessors() const { return 0; }
4429 // Methods for support type inquiry through isa, cast, and dyn_cast:
4430 static inline bool classof(const Instruction *I) {
4431 return I->getOpcode() == Instruction::Unreachable;
4433 static inline bool classof(const Value *V) {
4434 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4438 BasicBlock *getSuccessorV(unsigned idx) const override;
4439 unsigned getNumSuccessorsV() const override;
4440 void setSuccessorV(unsigned idx, BasicBlock *B) override;
4443 //===----------------------------------------------------------------------===//
4445 //===----------------------------------------------------------------------===//
4447 /// \brief This class represents a truncation of integer types.
4448 class TruncInst : public CastInst {
4450 // Note: Instruction needs to be a friend here to call cloneImpl.
4451 friend class Instruction;
4452 /// \brief Clone an identical TruncInst
4453 TruncInst *cloneImpl() const;
4456 /// \brief Constructor with insert-before-instruction semantics
4458 Value *S, ///< The value to be truncated
4459 Type *Ty, ///< The (smaller) type to truncate to
4460 const Twine &NameStr = "", ///< A name for the new instruction
4461 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4464 /// \brief Constructor with insert-at-end-of-block semantics
4466 Value *S, ///< The value to be truncated
4467 Type *Ty, ///< The (smaller) type to truncate to
4468 const Twine &NameStr, ///< A name for the new instruction
4469 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4472 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4473 static inline bool classof(const Instruction *I) {
4474 return I->getOpcode() == Trunc;
4476 static inline bool classof(const Value *V) {
4477 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4481 //===----------------------------------------------------------------------===//
4483 //===----------------------------------------------------------------------===//
4485 /// \brief This class represents zero extension of integer types.
4486 class ZExtInst : public CastInst {
4488 // Note: Instruction needs to be a friend here to call cloneImpl.
4489 friend class Instruction;
4490 /// \brief Clone an identical ZExtInst
4491 ZExtInst *cloneImpl() const;
4494 /// \brief Constructor with insert-before-instruction semantics
4496 Value *S, ///< The value to be zero extended
4497 Type *Ty, ///< The type to zero extend to
4498 const Twine &NameStr = "", ///< A name for the new instruction
4499 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4502 /// \brief Constructor with insert-at-end semantics.
4504 Value *S, ///< The value to be zero extended
4505 Type *Ty, ///< The type to zero extend to
4506 const Twine &NameStr, ///< A name for the new instruction
4507 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4510 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4511 static inline bool classof(const Instruction *I) {
4512 return I->getOpcode() == ZExt;
4514 static inline bool classof(const Value *V) {
4515 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4519 //===----------------------------------------------------------------------===//
4521 //===----------------------------------------------------------------------===//
4523 /// \brief This class represents a sign extension of integer types.
4524 class SExtInst : public CastInst {
4526 // Note: Instruction needs to be a friend here to call cloneImpl.
4527 friend class Instruction;
4528 /// \brief Clone an identical SExtInst
4529 SExtInst *cloneImpl() const;
4532 /// \brief Constructor with insert-before-instruction semantics
4534 Value *S, ///< The value to be sign extended
4535 Type *Ty, ///< The type to sign extend to
4536 const Twine &NameStr = "", ///< A name for the new instruction
4537 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4540 /// \brief Constructor with insert-at-end-of-block semantics
4542 Value *S, ///< The value to be sign extended
4543 Type *Ty, ///< The type to sign extend to
4544 const Twine &NameStr, ///< A name for the new instruction
4545 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4548 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4549 static inline bool classof(const Instruction *I) {
4550 return I->getOpcode() == SExt;
4552 static inline bool classof(const Value *V) {
4553 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4557 //===----------------------------------------------------------------------===//
4558 // FPTruncInst Class
4559 //===----------------------------------------------------------------------===//
4561 /// \brief This class represents a truncation of floating point types.
4562 class FPTruncInst : public CastInst {
4564 // Note: Instruction needs to be a friend here to call cloneImpl.
4565 friend class Instruction;
4566 /// \brief Clone an identical FPTruncInst
4567 FPTruncInst *cloneImpl() const;
4570 /// \brief Constructor with insert-before-instruction semantics
4572 Value *S, ///< The value to be truncated
4573 Type *Ty, ///< The type to truncate to
4574 const Twine &NameStr = "", ///< A name for the new instruction
4575 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4578 /// \brief Constructor with insert-before-instruction semantics
4580 Value *S, ///< The value to be truncated
4581 Type *Ty, ///< The type to truncate to
4582 const Twine &NameStr, ///< A name for the new instruction
4583 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4586 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4587 static inline bool classof(const Instruction *I) {
4588 return I->getOpcode() == FPTrunc;
4590 static inline bool classof(const Value *V) {
4591 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4595 //===----------------------------------------------------------------------===//
4597 //===----------------------------------------------------------------------===//
4599 /// \brief This class represents an extension of floating point types.
4600 class FPExtInst : public CastInst {
4602 // Note: Instruction needs to be a friend here to call cloneImpl.
4603 friend class Instruction;
4604 /// \brief Clone an identical FPExtInst
4605 FPExtInst *cloneImpl() const;
4608 /// \brief Constructor with insert-before-instruction semantics
4610 Value *S, ///< The value to be extended
4611 Type *Ty, ///< The type to extend to
4612 const Twine &NameStr = "", ///< A name for the new instruction
4613 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4616 /// \brief Constructor with insert-at-end-of-block semantics
4618 Value *S, ///< The value to be extended
4619 Type *Ty, ///< The type to extend to
4620 const Twine &NameStr, ///< A name for the new instruction
4621 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4624 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4625 static inline bool classof(const Instruction *I) {
4626 return I->getOpcode() == FPExt;
4628 static inline bool classof(const Value *V) {
4629 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4633 //===----------------------------------------------------------------------===//
4635 //===----------------------------------------------------------------------===//
4637 /// \brief This class represents a cast unsigned integer to floating point.
4638 class UIToFPInst : public CastInst {
4640 // Note: Instruction needs to be a friend here to call cloneImpl.
4641 friend class Instruction;
4642 /// \brief Clone an identical UIToFPInst
4643 UIToFPInst *cloneImpl() const;
4646 /// \brief Constructor with insert-before-instruction semantics
4648 Value *S, ///< The value to be converted
4649 Type *Ty, ///< The type to convert to
4650 const Twine &NameStr = "", ///< A name for the new instruction
4651 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4654 /// \brief Constructor with insert-at-end-of-block semantics
4656 Value *S, ///< The value to be converted
4657 Type *Ty, ///< The type to convert to
4658 const Twine &NameStr, ///< A name for the new instruction
4659 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4662 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4663 static inline bool classof(const Instruction *I) {
4664 return I->getOpcode() == UIToFP;
4666 static inline bool classof(const Value *V) {
4667 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4671 //===----------------------------------------------------------------------===//
4673 //===----------------------------------------------------------------------===//
4675 /// \brief This class represents a cast from signed integer to floating point.
4676 class SIToFPInst : public CastInst {
4678 // Note: Instruction needs to be a friend here to call cloneImpl.
4679 friend class Instruction;
4680 /// \brief Clone an identical SIToFPInst
4681 SIToFPInst *cloneImpl() const;
4684 /// \brief Constructor with insert-before-instruction semantics
4686 Value *S, ///< The value to be converted
4687 Type *Ty, ///< The type to convert to
4688 const Twine &NameStr = "", ///< A name for the new instruction
4689 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4692 /// \brief Constructor with insert-at-end-of-block semantics
4694 Value *S, ///< The value to be converted
4695 Type *Ty, ///< The type to convert to
4696 const Twine &NameStr, ///< A name for the new instruction
4697 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4700 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4701 static inline bool classof(const Instruction *I) {
4702 return I->getOpcode() == SIToFP;
4704 static inline bool classof(const Value *V) {
4705 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4709 //===----------------------------------------------------------------------===//
4711 //===----------------------------------------------------------------------===//
4713 /// \brief This class represents a cast from floating point to unsigned integer
4714 class FPToUIInst : public CastInst {
4716 // Note: Instruction needs to be a friend here to call cloneImpl.
4717 friend class Instruction;
4718 /// \brief Clone an identical FPToUIInst
4719 FPToUIInst *cloneImpl() const;
4722 /// \brief Constructor with insert-before-instruction semantics
4724 Value *S, ///< The value to be converted
4725 Type *Ty, ///< The type to convert to
4726 const Twine &NameStr = "", ///< A name for the new instruction
4727 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4730 /// \brief Constructor with insert-at-end-of-block semantics
4732 Value *S, ///< The value to be converted
4733 Type *Ty, ///< The type to convert to
4734 const Twine &NameStr, ///< A name for the new instruction
4735 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
4738 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4739 static inline bool classof(const Instruction *I) {
4740 return I->getOpcode() == FPToUI;
4742 static inline bool classof(const Value *V) {
4743 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4747 //===----------------------------------------------------------------------===//
4749 //===----------------------------------------------------------------------===//
4751 /// \brief This class represents a cast from floating point to signed integer.
4752 class FPToSIInst : public CastInst {
4754 // Note: Instruction needs to be a friend here to call cloneImpl.
4755 friend class Instruction;
4756 /// \brief Clone an identical FPToSIInst
4757 FPToSIInst *cloneImpl() const;
4760 /// \brief Constructor with insert-before-instruction semantics
4762 Value *S, ///< The value to be converted
4763 Type *Ty, ///< The type to convert to
4764 const Twine &NameStr = "", ///< A name for the new instruction
4765 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4768 /// \brief Constructor with insert-at-end-of-block semantics
4770 Value *S, ///< The value to be converted
4771 Type *Ty, ///< The type to convert to
4772 const Twine &NameStr, ///< A name for the new instruction
4773 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4776 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4777 static inline bool classof(const Instruction *I) {
4778 return I->getOpcode() == FPToSI;
4780 static inline bool classof(const Value *V) {
4781 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4785 //===----------------------------------------------------------------------===//
4786 // IntToPtrInst Class
4787 //===----------------------------------------------------------------------===//
4789 /// \brief This class represents a cast from an integer to a pointer.
4790 class IntToPtrInst : public CastInst {
4792 /// \brief Constructor with insert-before-instruction semantics
4794 Value *S, ///< The value to be converted
4795 Type *Ty, ///< The type to convert to
4796 const Twine &NameStr = "", ///< A name for the new instruction
4797 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4800 /// \brief Constructor with insert-at-end-of-block semantics
4802 Value *S, ///< The value to be converted
4803 Type *Ty, ///< The type to convert to
4804 const Twine &NameStr, ///< A name for the new instruction
4805 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4808 // Note: Instruction needs to be a friend here to call cloneImpl.
4809 friend class Instruction;
4810 /// \brief Clone an identical IntToPtrInst
4811 IntToPtrInst *cloneImpl() const;
4813 /// \brief Returns the address space of this instruction's pointer type.
4814 unsigned getAddressSpace() const {
4815 return getType()->getPointerAddressSpace();
4818 // Methods for support type inquiry through isa, cast, and dyn_cast:
4819 static inline bool classof(const Instruction *I) {
4820 return I->getOpcode() == IntToPtr;
4822 static inline bool classof(const Value *V) {
4823 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4827 //===----------------------------------------------------------------------===//
4828 // PtrToIntInst Class
4829 //===----------------------------------------------------------------------===//
4831 /// \brief This class represents a cast from a pointer to an integer
4832 class PtrToIntInst : public CastInst {
4834 // Note: Instruction needs to be a friend here to call cloneImpl.
4835 friend class Instruction;
4836 /// \brief Clone an identical PtrToIntInst
4837 PtrToIntInst *cloneImpl() const;
4840 /// \brief Constructor with insert-before-instruction semantics
4842 Value *S, ///< The value to be converted
4843 Type *Ty, ///< The type to convert to
4844 const Twine &NameStr = "", ///< A name for the new instruction
4845 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4848 /// \brief Constructor with insert-at-end-of-block semantics
4850 Value *S, ///< The value to be converted
4851 Type *Ty, ///< The type to convert to
4852 const Twine &NameStr, ///< A name for the new instruction
4853 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4856 /// \brief Gets the pointer operand.
4857 Value *getPointerOperand() { return getOperand(0); }
4858 /// \brief Gets the pointer operand.
4859 const Value *getPointerOperand() const { return getOperand(0); }
4860 /// \brief Gets the operand index of the pointer operand.
4861 static unsigned getPointerOperandIndex() { return 0U; }
4863 /// \brief Returns the address space of the pointer operand.
4864 unsigned getPointerAddressSpace() const {
4865 return getPointerOperand()->getType()->getPointerAddressSpace();
4868 // Methods for support type inquiry through isa, cast, and dyn_cast:
4869 static inline bool classof(const Instruction *I) {
4870 return I->getOpcode() == PtrToInt;
4872 static inline bool classof(const Value *V) {
4873 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4877 //===----------------------------------------------------------------------===//
4878 // BitCastInst Class
4879 //===----------------------------------------------------------------------===//
4881 /// \brief This class represents a no-op cast from one type to another.
4882 class BitCastInst : public CastInst {
4884 // Note: Instruction needs to be a friend here to call cloneImpl.
4885 friend class Instruction;
4886 /// \brief Clone an identical BitCastInst
4887 BitCastInst *cloneImpl() const;
4890 /// \brief Constructor with insert-before-instruction semantics
4892 Value *S, ///< The value to be casted
4893 Type *Ty, ///< The type to casted to
4894 const Twine &NameStr = "", ///< A name for the new instruction
4895 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4898 /// \brief Constructor with insert-at-end-of-block semantics
4900 Value *S, ///< The value to be casted
4901 Type *Ty, ///< The type to casted to
4902 const Twine &NameStr, ///< A name for the new instruction
4903 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4906 // Methods for support type inquiry through isa, cast, and dyn_cast:
4907 static inline bool classof(const Instruction *I) {
4908 return I->getOpcode() == BitCast;
4910 static inline bool classof(const Value *V) {
4911 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4915 //===----------------------------------------------------------------------===//
4916 // AddrSpaceCastInst Class
4917 //===----------------------------------------------------------------------===//
4919 /// \brief This class represents a conversion between pointers from
4920 /// one address space to another.
4921 class AddrSpaceCastInst : public CastInst {
4923 // Note: Instruction needs to be a friend here to call cloneImpl.
4924 friend class Instruction;
4925 /// \brief Clone an identical AddrSpaceCastInst
4926 AddrSpaceCastInst *cloneImpl() const;
4929 /// \brief Constructor with insert-before-instruction semantics
4931 Value *S, ///< The value to be casted
4932 Type *Ty, ///< The type to casted to
4933 const Twine &NameStr = "", ///< A name for the new instruction
4934 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4937 /// \brief Constructor with insert-at-end-of-block semantics
4939 Value *S, ///< The value to be casted
4940 Type *Ty, ///< The type to casted to
4941 const Twine &NameStr, ///< A name for the new instruction
4942 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4945 // Methods for support type inquiry through isa, cast, and dyn_cast:
4946 static inline bool classof(const Instruction *I) {
4947 return I->getOpcode() == AddrSpaceCast;
4949 static inline bool classof(const Value *V) {
4950 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4954 } // End llvm namespace