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));
162 // Shadow Instruction::setInstructionSubclassData with a private forwarding
163 // method so that subclasses cannot accidentally use it.
164 void setInstructionSubclassData(unsigned short D) {
165 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 {
180 // Note: Instruction needs to be a friend here to call cloneImpl.
181 friend class Instruction;
182 LoadInst *cloneImpl() const;
185 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
186 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
187 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile = false,
188 Instruction *InsertBefore = nullptr);
189 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
190 Instruction *InsertBefore = nullptr)
191 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
192 NameStr, isVolatile, InsertBefore) {}
193 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
194 BasicBlock *InsertAtEnd);
195 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile, unsigned Align,
196 Instruction *InsertBefore = nullptr)
197 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
198 NameStr, isVolatile, Align, InsertBefore) {}
199 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
200 unsigned Align, Instruction *InsertBefore = nullptr);
201 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
202 unsigned Align, BasicBlock *InsertAtEnd);
203 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile, unsigned Align,
204 AtomicOrdering Order, SynchronizationScope SynchScope = CrossThread,
205 Instruction *InsertBefore = nullptr)
206 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
207 NameStr, isVolatile, Align, Order, SynchScope, InsertBefore) {}
208 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
209 unsigned Align, AtomicOrdering Order,
210 SynchronizationScope SynchScope = CrossThread,
211 Instruction *InsertBefore = nullptr);
212 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
213 unsigned Align, AtomicOrdering Order,
214 SynchronizationScope SynchScope,
215 BasicBlock *InsertAtEnd);
217 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
218 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
219 LoadInst(Type *Ty, Value *Ptr, const char *NameStr = nullptr,
220 bool isVolatile = false, Instruction *InsertBefore = nullptr);
221 explicit LoadInst(Value *Ptr, const char *NameStr = nullptr,
222 bool isVolatile = false,
223 Instruction *InsertBefore = nullptr)
224 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
225 NameStr, isVolatile, InsertBefore) {}
226 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
227 BasicBlock *InsertAtEnd);
229 /// isVolatile - Return true if this is a load from a volatile memory
232 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
234 /// setVolatile - Specify whether this is a volatile load or not.
236 void setVolatile(bool V) {
237 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
241 /// getAlignment - Return the alignment of the access that is being performed
243 unsigned getAlignment() const {
244 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
247 void setAlignment(unsigned Align);
249 /// Returns the ordering effect of this fence.
250 AtomicOrdering getOrdering() const {
251 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
254 /// Set the ordering constraint on this load. May not be Release or
256 void setOrdering(AtomicOrdering Ordering) {
257 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
261 SynchronizationScope getSynchScope() const {
262 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
265 /// Specify whether this load is ordered with respect to all
266 /// concurrently executing threads, or only with respect to signal handlers
267 /// executing in the same thread.
268 void setSynchScope(SynchronizationScope xthread) {
269 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
273 void setAtomic(AtomicOrdering Ordering,
274 SynchronizationScope SynchScope = CrossThread) {
275 setOrdering(Ordering);
276 setSynchScope(SynchScope);
279 bool isSimple() const { return !isAtomic() && !isVolatile(); }
280 bool isUnordered() const {
281 return getOrdering() <= Unordered && !isVolatile();
284 Value *getPointerOperand() { return getOperand(0); }
285 const Value *getPointerOperand() const { return getOperand(0); }
286 static unsigned getPointerOperandIndex() { return 0U; }
288 /// \brief Returns the address space of the pointer operand.
289 unsigned getPointerAddressSpace() const {
290 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));
302 // Shadow Instruction::setInstructionSubclassData with a private forwarding
303 // method so that subclasses cannot accidentally use it.
304 void setInstructionSubclassData(unsigned short D) {
305 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;
320 // Note: Instruction needs to be a friend here to call cloneImpl.
321 friend class Instruction;
322 StoreInst *cloneImpl() const;
325 // allocate space for exactly two operands
326 void *operator new(size_t s) {
327 return User::operator new(s, 2);
329 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
330 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
331 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
332 Instruction *InsertBefore = nullptr);
333 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
334 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
335 unsigned Align, Instruction *InsertBefore = nullptr);
336 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
337 unsigned Align, BasicBlock *InsertAtEnd);
338 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
339 unsigned Align, AtomicOrdering Order,
340 SynchronizationScope SynchScope = CrossThread,
341 Instruction *InsertBefore = nullptr);
342 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
343 unsigned Align, AtomicOrdering Order,
344 SynchronizationScope SynchScope,
345 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));
426 // Shadow Instruction::setInstructionSubclassData with a private forwarding
427 // method so that subclasses cannot accidentally use it.
428 void setInstructionSubclassData(unsigned short D) {
429 Instruction::setInstructionSubclassData(D);
434 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
437 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
439 //===----------------------------------------------------------------------===//
441 //===----------------------------------------------------------------------===//
443 /// FenceInst - an instruction for ordering other memory operations
445 class FenceInst : public Instruction {
446 void *operator new(size_t, unsigned) = delete;
447 void Init(AtomicOrdering Ordering, SynchronizationScope SynchScope);
449 // Note: Instruction needs to be a friend here to call cloneImpl.
450 friend class Instruction;
451 FenceInst *cloneImpl() const;
454 // allocate space for exactly zero operands
455 void *operator new(size_t s) {
456 return User::operator new(s, 0);
459 // Ordering may only be Acquire, Release, AcquireRelease, or
460 // SequentiallyConsistent.
461 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
462 SynchronizationScope SynchScope = CrossThread,
463 Instruction *InsertBefore = nullptr);
464 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
465 SynchronizationScope SynchScope,
466 BasicBlock *InsertAtEnd);
468 /// Returns the ordering effect of this fence.
469 AtomicOrdering getOrdering() const {
470 return AtomicOrdering(getSubclassDataFromInstruction() >> 1);
473 /// Set the ordering constraint on this fence. May only be Acquire, Release,
474 /// AcquireRelease, or SequentiallyConsistent.
475 void setOrdering(AtomicOrdering Ordering) {
476 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
480 SynchronizationScope getSynchScope() const {
481 return SynchronizationScope(getSubclassDataFromInstruction() & 1);
484 /// Specify whether this fence orders other operations with respect to all
485 /// concurrently executing threads, or only with respect to signal handlers
486 /// executing in the same thread.
487 void setSynchScope(SynchronizationScope xthread) {
488 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
492 // Methods for support type inquiry through isa, cast, and dyn_cast:
493 static inline bool classof(const Instruction *I) {
494 return I->getOpcode() == Instruction::Fence;
496 static inline bool classof(const Value *V) {
497 return isa<Instruction>(V) && classof(cast<Instruction>(V));
500 // Shadow Instruction::setInstructionSubclassData with a private forwarding
501 // method so that subclasses cannot accidentally use it.
502 void setInstructionSubclassData(unsigned short D) {
503 Instruction::setInstructionSubclassData(D);
507 //===----------------------------------------------------------------------===//
508 // AtomicCmpXchgInst Class
509 //===----------------------------------------------------------------------===//
511 /// AtomicCmpXchgInst - an instruction that atomically checks whether a
512 /// specified value is in a memory location, and, if it is, stores a new value
513 /// there. Returns the value that was loaded.
515 class AtomicCmpXchgInst : public Instruction {
516 void *operator new(size_t, unsigned) = delete;
517 void Init(Value *Ptr, Value *Cmp, Value *NewVal,
518 AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering,
519 SynchronizationScope SynchScope);
521 // Note: Instruction needs to be a friend here to call cloneImpl.
522 friend class Instruction;
523 AtomicCmpXchgInst *cloneImpl() const;
526 // allocate space for exactly three operands
527 void *operator new(size_t s) {
528 return User::operator new(s, 3);
530 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
531 AtomicOrdering SuccessOrdering,
532 AtomicOrdering FailureOrdering,
533 SynchronizationScope SynchScope,
534 Instruction *InsertBefore = nullptr);
535 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
536 AtomicOrdering SuccessOrdering,
537 AtomicOrdering FailureOrdering,
538 SynchronizationScope SynchScope,
539 BasicBlock *InsertAtEnd);
541 /// isVolatile - Return true if this is a cmpxchg from a volatile memory
544 bool isVolatile() const {
545 return getSubclassDataFromInstruction() & 1;
548 /// setVolatile - Specify whether this is a volatile cmpxchg.
550 void setVolatile(bool V) {
551 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
555 /// Return true if this cmpxchg may spuriously fail.
556 bool isWeak() const {
557 return getSubclassDataFromInstruction() & 0x100;
560 void setWeak(bool IsWeak) {
561 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x100) |
565 /// Transparently provide more efficient getOperand methods.
566 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
568 /// Set the ordering constraint on this cmpxchg.
569 void setSuccessOrdering(AtomicOrdering Ordering) {
570 assert(Ordering != NotAtomic &&
571 "CmpXchg instructions can only be atomic.");
572 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x1c) |
576 void setFailureOrdering(AtomicOrdering Ordering) {
577 assert(Ordering != NotAtomic &&
578 "CmpXchg instructions can only be atomic.");
579 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0xe0) |
583 /// Specify whether this cmpxchg is atomic and orders other operations with
584 /// respect to all concurrently executing threads, or only with respect to
585 /// signal handlers executing in the same thread.
586 void setSynchScope(SynchronizationScope SynchScope) {
587 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
591 /// Returns the ordering constraint on this cmpxchg.
592 AtomicOrdering getSuccessOrdering() const {
593 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
596 /// Returns the ordering constraint on this cmpxchg.
597 AtomicOrdering getFailureOrdering() const {
598 return AtomicOrdering((getSubclassDataFromInstruction() >> 5) & 7);
601 /// Returns whether this cmpxchg is atomic between threads or only within a
603 SynchronizationScope getSynchScope() const {
604 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
607 Value *getPointerOperand() { return getOperand(0); }
608 const Value *getPointerOperand() const { return getOperand(0); }
609 static unsigned getPointerOperandIndex() { return 0U; }
611 Value *getCompareOperand() { return getOperand(1); }
612 const Value *getCompareOperand() const { return getOperand(1); }
614 Value *getNewValOperand() { return getOperand(2); }
615 const Value *getNewValOperand() const { return getOperand(2); }
617 /// \brief Returns the address space of the pointer operand.
618 unsigned getPointerAddressSpace() const {
619 return getPointerOperand()->getType()->getPointerAddressSpace();
622 /// \brief Returns the strongest permitted ordering on failure, given the
623 /// desired ordering on success.
625 /// If the comparison in a cmpxchg operation fails, there is no atomic store
626 /// so release semantics cannot be provided. So this function drops explicit
627 /// Release requests from the AtomicOrdering. A SequentiallyConsistent
628 /// operation would remain SequentiallyConsistent.
629 static AtomicOrdering
630 getStrongestFailureOrdering(AtomicOrdering SuccessOrdering) {
631 switch (SuccessOrdering) {
632 default: llvm_unreachable("invalid cmpxchg success ordering");
639 case SequentiallyConsistent:
640 return SequentiallyConsistent;
644 // Methods for support type inquiry through isa, cast, and dyn_cast:
645 static inline bool classof(const Instruction *I) {
646 return I->getOpcode() == Instruction::AtomicCmpXchg;
648 static inline bool classof(const Value *V) {
649 return isa<Instruction>(V) && classof(cast<Instruction>(V));
652 // Shadow Instruction::setInstructionSubclassData with a private forwarding
653 // method so that subclasses cannot accidentally use it.
654 void setInstructionSubclassData(unsigned short D) {
655 Instruction::setInstructionSubclassData(D);
660 struct OperandTraits<AtomicCmpXchgInst> :
661 public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
664 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)
666 //===----------------------------------------------------------------------===//
667 // AtomicRMWInst Class
668 //===----------------------------------------------------------------------===//
670 /// AtomicRMWInst - an instruction that atomically reads a memory location,
671 /// combines it with another value, and then stores the result back. Returns
674 class AtomicRMWInst : public Instruction {
675 void *operator new(size_t, unsigned) = delete;
677 // Note: Instruction needs to be a friend here to call cloneImpl.
678 friend class Instruction;
679 AtomicRMWInst *cloneImpl() const;
682 /// This enumeration lists the possible modifications atomicrmw can make. In
683 /// the descriptions, 'p' is the pointer to the instruction's memory location,
684 /// 'old' is the initial value of *p, and 'v' is the other value passed to the
685 /// instruction. These instructions always return 'old'.
701 /// *p = old >signed v ? old : v
703 /// *p = old <signed v ? old : v
705 /// *p = old >unsigned v ? old : v
707 /// *p = old <unsigned v ? old : v
715 // allocate space for exactly two operands
716 void *operator new(size_t s) {
717 return User::operator new(s, 2);
719 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
720 AtomicOrdering Ordering, SynchronizationScope SynchScope,
721 Instruction *InsertBefore = nullptr);
722 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
723 AtomicOrdering Ordering, SynchronizationScope SynchScope,
724 BasicBlock *InsertAtEnd);
726 BinOp getOperation() const {
727 return static_cast<BinOp>(getSubclassDataFromInstruction() >> 5);
730 void setOperation(BinOp Operation) {
731 unsigned short SubclassData = getSubclassDataFromInstruction();
732 setInstructionSubclassData((SubclassData & 31) |
736 /// isVolatile - Return true if this is a RMW on a volatile memory location.
738 bool isVolatile() const {
739 return getSubclassDataFromInstruction() & 1;
742 /// setVolatile - Specify whether this is a volatile RMW or not.
744 void setVolatile(bool V) {
745 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
749 /// Transparently provide more efficient getOperand methods.
750 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
752 /// Set the ordering constraint on this RMW.
753 void setOrdering(AtomicOrdering Ordering) {
754 assert(Ordering != NotAtomic &&
755 "atomicrmw instructions can only be atomic.");
756 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 2)) |
760 /// Specify whether this RMW orders other operations with respect to all
761 /// concurrently executing threads, or only with respect to signal handlers
762 /// executing in the same thread.
763 void setSynchScope(SynchronizationScope SynchScope) {
764 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
768 /// Returns the ordering constraint on this RMW.
769 AtomicOrdering getOrdering() const {
770 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
773 /// Returns whether this RMW is atomic between threads or only within a
775 SynchronizationScope getSynchScope() const {
776 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
779 Value *getPointerOperand() { return getOperand(0); }
780 const Value *getPointerOperand() const { return getOperand(0); }
781 static unsigned getPointerOperandIndex() { return 0U; }
783 Value *getValOperand() { return getOperand(1); }
784 const Value *getValOperand() const { return getOperand(1); }
786 /// \brief Returns the address space of the pointer operand.
787 unsigned getPointerAddressSpace() const {
788 return getPointerOperand()->getType()->getPointerAddressSpace();
791 // Methods for support type inquiry through isa, cast, and dyn_cast:
792 static inline bool classof(const Instruction *I) {
793 return I->getOpcode() == Instruction::AtomicRMW;
795 static inline bool classof(const Value *V) {
796 return isa<Instruction>(V) && classof(cast<Instruction>(V));
799 void Init(BinOp Operation, Value *Ptr, Value *Val,
800 AtomicOrdering Ordering, SynchronizationScope SynchScope);
801 // Shadow Instruction::setInstructionSubclassData with a private forwarding
802 // method so that subclasses cannot accidentally use it.
803 void setInstructionSubclassData(unsigned short D) {
804 Instruction::setInstructionSubclassData(D);
809 struct OperandTraits<AtomicRMWInst>
810 : public FixedNumOperandTraits<AtomicRMWInst,2> {
813 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)
815 //===----------------------------------------------------------------------===//
816 // GetElementPtrInst Class
817 //===----------------------------------------------------------------------===//
819 // checkGEPType - Simple wrapper function to give a better assertion failure
820 // message on bad indexes for a gep instruction.
822 inline Type *checkGEPType(Type *Ty) {
823 assert(Ty && "Invalid GetElementPtrInst indices for type!");
827 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
828 /// access elements of arrays and structs
830 class GetElementPtrInst : public Instruction {
831 Type *SourceElementType;
832 Type *ResultElementType;
834 GetElementPtrInst(const GetElementPtrInst &GEPI);
835 void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
837 /// Constructors - Create a getelementptr instruction with a base pointer an
838 /// list of indices. The first ctor can optionally insert before an existing
839 /// instruction, the second appends the new instruction to the specified
841 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
842 ArrayRef<Value *> IdxList, unsigned Values,
843 const Twine &NameStr, Instruction *InsertBefore);
844 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
845 ArrayRef<Value *> IdxList, unsigned Values,
846 const Twine &NameStr, BasicBlock *InsertAtEnd);
849 // Note: Instruction needs to be a friend here to call cloneImpl.
850 friend class Instruction;
851 GetElementPtrInst *cloneImpl() const;
854 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
855 ArrayRef<Value *> IdxList,
856 const Twine &NameStr = "",
857 Instruction *InsertBefore = nullptr) {
858 unsigned Values = 1 + unsigned(IdxList.size());
861 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
865 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
866 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
867 NameStr, InsertBefore);
869 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
870 ArrayRef<Value *> IdxList,
871 const Twine &NameStr,
872 BasicBlock *InsertAtEnd) {
873 unsigned Values = 1 + unsigned(IdxList.size());
876 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
880 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
881 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
882 NameStr, InsertAtEnd);
885 /// Create an "inbounds" getelementptr. See the documentation for the
886 /// "inbounds" flag in LangRef.html for details.
887 static GetElementPtrInst *CreateInBounds(Value *Ptr,
888 ArrayRef<Value *> IdxList,
889 const Twine &NameStr = "",
890 Instruction *InsertBefore = nullptr){
891 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertBefore);
893 static GetElementPtrInst *
894 CreateInBounds(Type *PointeeType, Value *Ptr, ArrayRef<Value *> IdxList,
895 const Twine &NameStr = "",
896 Instruction *InsertBefore = nullptr) {
897 GetElementPtrInst *GEP =
898 Create(PointeeType, Ptr, IdxList, NameStr, InsertBefore);
899 GEP->setIsInBounds(true);
902 static GetElementPtrInst *CreateInBounds(Value *Ptr,
903 ArrayRef<Value *> IdxList,
904 const Twine &NameStr,
905 BasicBlock *InsertAtEnd) {
906 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertAtEnd);
908 static GetElementPtrInst *CreateInBounds(Type *PointeeType, Value *Ptr,
909 ArrayRef<Value *> IdxList,
910 const Twine &NameStr,
911 BasicBlock *InsertAtEnd) {
912 GetElementPtrInst *GEP =
913 Create(PointeeType, Ptr, IdxList, NameStr, InsertAtEnd);
914 GEP->setIsInBounds(true);
918 /// Transparently provide more efficient getOperand methods.
919 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
921 // getType - Overload to return most specific sequential type.
922 SequentialType *getType() const {
923 return cast<SequentialType>(Instruction::getType());
926 Type *getSourceElementType() const { return SourceElementType; }
928 void setSourceElementType(Type *Ty) { SourceElementType = Ty; }
929 void setResultElementType(Type *Ty) { ResultElementType = Ty; }
931 Type *getResultElementType() const {
932 assert(ResultElementType ==
933 cast<PointerType>(getType()->getScalarType())->getElementType());
934 return ResultElementType;
937 /// \brief Returns the address space of this instruction's pointer type.
938 unsigned getAddressSpace() const {
939 // Note that this is always the same as the pointer operand's address space
940 // and that is cheaper to compute, so cheat here.
941 return getPointerAddressSpace();
944 /// getIndexedType - Returns the type of the element that would be loaded with
945 /// a load instruction with the specified parameters.
947 /// Null is returned if the indices are invalid for the specified
950 static Type *getIndexedType(Type *Ty, ArrayRef<Value *> IdxList);
951 static Type *getIndexedType(Type *Ty, ArrayRef<Constant *> IdxList);
952 static Type *getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList);
954 inline op_iterator idx_begin() { return op_begin()+1; }
955 inline const_op_iterator idx_begin() const { return op_begin()+1; }
956 inline op_iterator idx_end() { return op_end(); }
957 inline const_op_iterator idx_end() const { return op_end(); }
959 Value *getPointerOperand() {
960 return getOperand(0);
962 const Value *getPointerOperand() const {
963 return getOperand(0);
965 static unsigned getPointerOperandIndex() {
966 return 0U; // get index for modifying correct operand.
969 /// getPointerOperandType - Method to return the pointer operand as a
971 Type *getPointerOperandType() const {
972 return getPointerOperand()->getType();
975 /// \brief Returns the address space of the pointer operand.
976 unsigned getPointerAddressSpace() const {
977 return getPointerOperandType()->getPointerAddressSpace();
980 /// GetGEPReturnType - Returns the pointer type returned by the GEP
981 /// instruction, which may be a vector of pointers.
982 static Type *getGEPReturnType(Value *Ptr, ArrayRef<Value *> IdxList) {
983 return getGEPReturnType(
984 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType(),
987 static Type *getGEPReturnType(Type *ElTy, Value *Ptr,
988 ArrayRef<Value *> IdxList) {
989 Type *PtrTy = PointerType::get(checkGEPType(getIndexedType(ElTy, IdxList)),
990 Ptr->getType()->getPointerAddressSpace());
992 if (Ptr->getType()->isVectorTy()) {
993 unsigned NumElem = Ptr->getType()->getVectorNumElements();
994 return VectorType::get(PtrTy, NumElem);
996 for (Value *Index : IdxList)
997 if (Index->getType()->isVectorTy()) {
998 unsigned NumElem = Index->getType()->getVectorNumElements();
999 return VectorType::get(PtrTy, NumElem);
1005 unsigned getNumIndices() const { // Note: always non-negative
1006 return getNumOperands() - 1;
1009 bool hasIndices() const {
1010 return getNumOperands() > 1;
1013 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
1014 /// zeros. If so, the result pointer and the first operand have the same
1015 /// value, just potentially different types.
1016 bool hasAllZeroIndices() const;
1018 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
1019 /// constant integers. If so, the result pointer and the first operand have
1020 /// a constant offset between them.
1021 bool hasAllConstantIndices() const;
1023 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
1024 /// See LangRef.html for the meaning of inbounds on a getelementptr.
1025 void setIsInBounds(bool b = true);
1027 /// isInBounds - Determine whether the GEP has the inbounds flag.
1028 bool isInBounds() const;
1030 /// \brief Accumulate the constant address offset of this GEP if possible.
1032 /// This routine accepts an APInt into which it will accumulate the constant
1033 /// offset of this GEP if the GEP is in fact constant. If the GEP is not
1034 /// all-constant, it returns false and the value of the offset APInt is
1035 /// undefined (it is *not* preserved!). The APInt passed into this routine
1036 /// must be at least as wide as the IntPtr type for the address space of
1037 /// the base GEP pointer.
1038 bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const;
1040 // Methods for support type inquiry through isa, cast, and dyn_cast:
1041 static inline bool classof(const Instruction *I) {
1042 return (I->getOpcode() == Instruction::GetElementPtr);
1044 static inline bool classof(const Value *V) {
1045 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1050 struct OperandTraits<GetElementPtrInst> :
1051 public VariadicOperandTraits<GetElementPtrInst, 1> {
1054 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1055 ArrayRef<Value *> IdxList, unsigned Values,
1056 const Twine &NameStr,
1057 Instruction *InsertBefore)
1058 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1059 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1060 Values, InsertBefore),
1061 SourceElementType(PointeeType),
1062 ResultElementType(getIndexedType(PointeeType, IdxList)) {
1063 assert(ResultElementType ==
1064 cast<PointerType>(getType()->getScalarType())->getElementType());
1065 init(Ptr, IdxList, NameStr);
1067 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1068 ArrayRef<Value *> IdxList, unsigned Values,
1069 const Twine &NameStr,
1070 BasicBlock *InsertAtEnd)
1071 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1072 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1073 Values, InsertAtEnd),
1074 SourceElementType(PointeeType),
1075 ResultElementType(getIndexedType(PointeeType, IdxList)) {
1076 assert(ResultElementType ==
1077 cast<PointerType>(getType()->getScalarType())->getElementType());
1078 init(Ptr, IdxList, NameStr);
1082 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
1085 //===----------------------------------------------------------------------===//
1087 //===----------------------------------------------------------------------===//
1089 /// This instruction compares its operands according to the predicate given
1090 /// to the constructor. It only operates on integers or pointers. The operands
1091 /// must be identical types.
1092 /// \brief Represent an integer comparison operator.
1093 class ICmpInst: public CmpInst {
1095 assert(getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
1096 getPredicate() <= CmpInst::LAST_ICMP_PREDICATE &&
1097 "Invalid ICmp predicate value");
1098 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1099 "Both operands to ICmp instruction are not of the same type!");
1100 // Check that the operands are the right type
1101 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
1102 getOperand(0)->getType()->isPtrOrPtrVectorTy()) &&
1103 "Invalid operand types for ICmp instruction");
1107 // Note: Instruction needs to be a friend here to call cloneImpl.
1108 friend class Instruction;
1109 /// \brief Clone an identical ICmpInst
1110 ICmpInst *cloneImpl() const;
1113 /// \brief Constructor with insert-before-instruction semantics.
1115 Instruction *InsertBefore, ///< Where to insert
1116 Predicate pred, ///< The predicate to use for the comparison
1117 Value *LHS, ///< The left-hand-side of the expression
1118 Value *RHS, ///< The right-hand-side of the expression
1119 const Twine &NameStr = "" ///< Name of the instruction
1120 ) : CmpInst(makeCmpResultType(LHS->getType()),
1121 Instruction::ICmp, pred, LHS, RHS, NameStr,
1128 /// \brief Constructor with insert-at-end semantics.
1130 BasicBlock &InsertAtEnd, ///< Block to insert into.
1131 Predicate pred, ///< The predicate to use for the comparison
1132 Value *LHS, ///< The left-hand-side of the expression
1133 Value *RHS, ///< The right-hand-side of the expression
1134 const Twine &NameStr = "" ///< Name of the instruction
1135 ) : CmpInst(makeCmpResultType(LHS->getType()),
1136 Instruction::ICmp, pred, LHS, RHS, NameStr,
1143 /// \brief Constructor with no-insertion semantics
1145 Predicate pred, ///< The predicate to use for the comparison
1146 Value *LHS, ///< The left-hand-side of the expression
1147 Value *RHS, ///< The right-hand-side of the expression
1148 const Twine &NameStr = "" ///< Name of the instruction
1149 ) : CmpInst(makeCmpResultType(LHS->getType()),
1150 Instruction::ICmp, pred, LHS, RHS, NameStr) {
1156 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
1157 /// @returns the predicate that would be the result if the operand were
1158 /// regarded as signed.
1159 /// \brief Return the signed version of the predicate
1160 Predicate getSignedPredicate() const {
1161 return getSignedPredicate(getPredicate());
1164 /// This is a static version that you can use without an instruction.
1165 /// \brief Return the signed version of the predicate.
1166 static Predicate getSignedPredicate(Predicate pred);
1168 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
1169 /// @returns the predicate that would be the result if the operand were
1170 /// regarded as unsigned.
1171 /// \brief Return the unsigned version of the predicate
1172 Predicate getUnsignedPredicate() const {
1173 return getUnsignedPredicate(getPredicate());
1176 /// This is a static version that you can use without an instruction.
1177 /// \brief Return the unsigned version of the predicate.
1178 static Predicate getUnsignedPredicate(Predicate pred);
1180 /// isEquality - Return true if this predicate is either EQ or NE. This also
1181 /// tests for commutativity.
1182 static bool isEquality(Predicate P) {
1183 return P == ICMP_EQ || P == ICMP_NE;
1186 /// isEquality - Return true if this predicate is either EQ or NE. This also
1187 /// tests for commutativity.
1188 bool isEquality() const {
1189 return isEquality(getPredicate());
1192 /// @returns true if the predicate of this ICmpInst is commutative
1193 /// \brief Determine if this relation is commutative.
1194 bool isCommutative() const { return isEquality(); }
1196 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1198 bool isRelational() const {
1199 return !isEquality();
1202 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1204 static bool isRelational(Predicate P) {
1205 return !isEquality(P);
1208 /// Initialize a set of values that all satisfy the predicate with C.
1209 /// \brief Make a ConstantRange for a relation with a constant value.
1210 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
1212 /// Exchange the two operands to this instruction in such a way that it does
1213 /// not modify the semantics of the instruction. The predicate value may be
1214 /// changed to retain the same result if the predicate is order dependent
1216 /// \brief Swap operands and adjust predicate.
1217 void swapOperands() {
1218 setPredicate(getSwappedPredicate());
1219 Op<0>().swap(Op<1>());
1222 // Methods for support type inquiry through isa, cast, and dyn_cast:
1223 static inline bool classof(const Instruction *I) {
1224 return I->getOpcode() == Instruction::ICmp;
1226 static inline bool classof(const Value *V) {
1227 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1232 //===----------------------------------------------------------------------===//
1234 //===----------------------------------------------------------------------===//
1236 /// This instruction compares its operands according to the predicate given
1237 /// to the constructor. It only operates on floating point values or packed
1238 /// vectors of floating point values. The operands must be identical types.
1239 /// \brief Represents a floating point comparison operator.
1240 class FCmpInst: public CmpInst {
1242 // Note: Instruction needs to be a friend here to call cloneImpl.
1243 friend class Instruction;
1244 /// \brief Clone an identical FCmpInst
1245 FCmpInst *cloneImpl() const;
1248 /// \brief Constructor with insert-before-instruction semantics.
1250 Instruction *InsertBefore, ///< Where to insert
1251 Predicate pred, ///< The predicate to use for the comparison
1252 Value *LHS, ///< The left-hand-side of the expression
1253 Value *RHS, ///< The right-hand-side of the expression
1254 const Twine &NameStr = "" ///< Name of the instruction
1255 ) : CmpInst(makeCmpResultType(LHS->getType()),
1256 Instruction::FCmp, pred, LHS, RHS, NameStr,
1258 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1259 "Invalid FCmp predicate value");
1260 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1261 "Both operands to FCmp instruction are not of the same type!");
1262 // Check that the operands are the right type
1263 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1264 "Invalid operand types for FCmp instruction");
1267 /// \brief Constructor with insert-at-end semantics.
1269 BasicBlock &InsertAtEnd, ///< Block to insert into.
1270 Predicate pred, ///< The predicate to use for the comparison
1271 Value *LHS, ///< The left-hand-side of the expression
1272 Value *RHS, ///< The right-hand-side of the expression
1273 const Twine &NameStr = "" ///< Name of the instruction
1274 ) : CmpInst(makeCmpResultType(LHS->getType()),
1275 Instruction::FCmp, pred, LHS, RHS, NameStr,
1277 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1278 "Invalid FCmp predicate value");
1279 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1280 "Both operands to FCmp instruction are not of the same type!");
1281 // Check that the operands are the right type
1282 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1283 "Invalid operand types for FCmp instruction");
1286 /// \brief Constructor with no-insertion semantics
1288 Predicate pred, ///< The predicate to use for the comparison
1289 Value *LHS, ///< The left-hand-side of the expression
1290 Value *RHS, ///< The right-hand-side of the expression
1291 const Twine &NameStr = "" ///< Name of the instruction
1292 ) : CmpInst(makeCmpResultType(LHS->getType()),
1293 Instruction::FCmp, pred, LHS, RHS, NameStr) {
1294 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1295 "Invalid FCmp predicate value");
1296 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1297 "Both operands to FCmp instruction are not of the same type!");
1298 // Check that the operands are the right type
1299 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1300 "Invalid operand types for FCmp instruction");
1303 /// @returns true if the predicate of this instruction is EQ or NE.
1304 /// \brief Determine if this is an equality predicate.
1305 static bool isEquality(Predicate Pred) {
1306 return Pred == FCMP_OEQ || Pred == FCMP_ONE || Pred == FCMP_UEQ ||
1310 /// @returns true if the predicate of this instruction is EQ or NE.
1311 /// \brief Determine if this is an equality predicate.
1312 bool isEquality() const { return isEquality(getPredicate()); }
1314 /// @returns true if the predicate of this instruction is commutative.
1315 /// \brief Determine if this is a commutative predicate.
1316 bool isCommutative() const {
1317 return isEquality() ||
1318 getPredicate() == FCMP_FALSE ||
1319 getPredicate() == FCMP_TRUE ||
1320 getPredicate() == FCMP_ORD ||
1321 getPredicate() == FCMP_UNO;
1324 /// @returns true if the predicate is relational (not EQ or NE).
1325 /// \brief Determine if this a relational predicate.
1326 bool isRelational() const { return !isEquality(); }
1328 /// Exchange the two operands to this instruction in such a way that it does
1329 /// not modify the semantics of the instruction. The predicate value may be
1330 /// changed to retain the same result if the predicate is order dependent
1332 /// \brief Swap operands and adjust predicate.
1333 void swapOperands() {
1334 setPredicate(getSwappedPredicate());
1335 Op<0>().swap(Op<1>());
1338 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
1339 static inline bool classof(const Instruction *I) {
1340 return I->getOpcode() == Instruction::FCmp;
1342 static inline bool classof(const Value *V) {
1343 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1347 //===----------------------------------------------------------------------===//
1348 /// CallInst - This class represents a function call, abstracting a target
1349 /// machine's calling convention. This class uses low bit of the SubClassData
1350 /// field to indicate whether or not this is a tail call. The rest of the bits
1351 /// hold the calling convention of the call.
1353 class CallInst : public Instruction {
1354 AttributeSet AttributeList; ///< parameter attributes for call
1356 CallInst(const CallInst &CI);
1357 void init(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr) {
1358 init(cast<FunctionType>(
1359 cast<PointerType>(Func->getType())->getElementType()),
1360 Func, Args, NameStr);
1362 void init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
1363 const Twine &NameStr);
1364 void init(Value *Func, const Twine &NameStr);
1366 /// Construct a CallInst given a range of arguments.
1367 /// \brief Construct a CallInst from a range of arguments
1368 inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1369 const Twine &NameStr, Instruction *InsertBefore);
1370 inline CallInst(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr,
1371 Instruction *InsertBefore)
1372 : CallInst(cast<FunctionType>(
1373 cast<PointerType>(Func->getType())->getElementType()),
1374 Func, Args, NameStr, InsertBefore) {}
1376 /// Construct a CallInst given a range of arguments.
1377 /// \brief Construct a CallInst from a range of arguments
1378 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1379 const Twine &NameStr, BasicBlock *InsertAtEnd);
1381 explicit CallInst(Value *F, const Twine &NameStr,
1382 Instruction *InsertBefore);
1383 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1385 // Note: Instruction needs to be a friend here to call cloneImpl.
1386 friend class Instruction;
1387 CallInst *cloneImpl() const;
1390 static CallInst *Create(Value *Func,
1391 ArrayRef<Value *> Args,
1392 const Twine &NameStr = "",
1393 Instruction *InsertBefore = nullptr) {
1394 return Create(cast<FunctionType>(
1395 cast<PointerType>(Func->getType())->getElementType()),
1396 Func, Args, NameStr, InsertBefore);
1398 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1399 const Twine &NameStr = "",
1400 Instruction *InsertBefore = nullptr) {
1401 return new (unsigned(Args.size() + 1))
1402 CallInst(Ty, Func, Args, NameStr, InsertBefore);
1404 static CallInst *Create(Value *Func,
1405 ArrayRef<Value *> Args,
1406 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1407 return new(unsigned(Args.size() + 1))
1408 CallInst(Func, Args, NameStr, InsertAtEnd);
1410 static CallInst *Create(Value *F, const Twine &NameStr = "",
1411 Instruction *InsertBefore = nullptr) {
1412 return new(1) CallInst(F, NameStr, InsertBefore);
1414 static CallInst *Create(Value *F, const Twine &NameStr,
1415 BasicBlock *InsertAtEnd) {
1416 return new(1) CallInst(F, NameStr, InsertAtEnd);
1418 /// CreateMalloc - Generate the IR for a call to malloc:
1419 /// 1. Compute the malloc call's argument as the specified type's size,
1420 /// possibly multiplied by the array size if the array size is not
1422 /// 2. Call malloc with that argument.
1423 /// 3. Bitcast the result of the malloc call to the specified type.
1424 static Instruction *CreateMalloc(Instruction *InsertBefore,
1425 Type *IntPtrTy, Type *AllocTy,
1426 Value *AllocSize, Value *ArraySize = nullptr,
1427 Function* MallocF = nullptr,
1428 const Twine &Name = "");
1429 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1430 Type *IntPtrTy, Type *AllocTy,
1431 Value *AllocSize, Value *ArraySize = nullptr,
1432 Function* MallocF = nullptr,
1433 const Twine &Name = "");
1434 /// CreateFree - Generate the IR for a call to the builtin free function.
1435 static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
1436 static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
1438 ~CallInst() override;
1440 FunctionType *getFunctionType() const { return FTy; }
1442 void mutateFunctionType(FunctionType *FTy) {
1443 mutateType(FTy->getReturnType());
1447 // Note that 'musttail' implies 'tail'.
1448 enum TailCallKind { TCK_None = 0, TCK_Tail = 1, TCK_MustTail = 2 };
1449 TailCallKind getTailCallKind() const {
1450 return TailCallKind(getSubclassDataFromInstruction() & 3);
1452 bool isTailCall() const {
1453 return (getSubclassDataFromInstruction() & 3) != TCK_None;
1455 bool isMustTailCall() const {
1456 return (getSubclassDataFromInstruction() & 3) == TCK_MustTail;
1458 void setTailCall(bool isTC = true) {
1459 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1460 unsigned(isTC ? TCK_Tail : TCK_None));
1462 void setTailCallKind(TailCallKind TCK) {
1463 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1467 /// Provide fast operand accessors
1468 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1470 /// getNumArgOperands - Return the number of call arguments.
1472 unsigned getNumArgOperands() const { return getNumOperands() - 1; }
1474 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
1476 Value *getArgOperand(unsigned i) const {
1477 assert(i < getNumArgOperands() && "Out of bounds!");
1478 return getOperand(i);
1480 void setArgOperand(unsigned i, Value *v) {
1481 assert(i < getNumArgOperands() && "Out of bounds!");
1485 /// arg_operands - iteration adapter for range-for loops.
1486 iterator_range<op_iterator> arg_operands() {
1487 // The last operand in the op list is the callee - it's not one of the args
1488 // so we don't want to iterate over it.
1489 return iterator_range<op_iterator>(op_begin(), op_end() - 1);
1492 /// arg_operands - iteration adapter for range-for loops.
1493 iterator_range<const_op_iterator> arg_operands() const {
1494 return iterator_range<const_op_iterator>(op_begin(), op_end() - 1);
1497 /// \brief Wrappers for getting the \c Use of a call argument.
1498 const Use &getArgOperandUse(unsigned i) const {
1499 assert(i < getNumArgOperands() && "Out of bounds!");
1500 return getOperandUse(i);
1502 Use &getArgOperandUse(unsigned i) {
1503 assert(i < getNumArgOperands() && "Out of bounds!");
1504 return getOperandUse(i);
1507 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1509 CallingConv::ID getCallingConv() const {
1510 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 2);
1512 void setCallingConv(CallingConv::ID CC) {
1513 setInstructionSubclassData((getSubclassDataFromInstruction() & 3) |
1514 (static_cast<unsigned>(CC) << 2));
1517 /// getAttributes - Return the parameter attributes for this call.
1519 const AttributeSet &getAttributes() const { return AttributeList; }
1521 /// setAttributes - Set the parameter attributes for this call.
1523 void setAttributes(const AttributeSet &Attrs) { AttributeList = Attrs; }
1525 /// addAttribute - adds the attribute to the list of attributes.
1526 void addAttribute(unsigned i, Attribute::AttrKind attr);
1528 /// addAttribute - adds the attribute to the list of attributes.
1529 void addAttribute(unsigned i, StringRef Kind, StringRef Value);
1531 /// removeAttribute - removes the attribute from the list of attributes.
1532 void removeAttribute(unsigned i, Attribute attr);
1534 /// \brief adds the dereferenceable attribute to the list of attributes.
1535 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
1537 /// \brief adds the dereferenceable_or_null attribute to the list of
1539 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
1541 /// \brief Determine whether this call has the given attribute.
1542 bool hasFnAttr(Attribute::AttrKind A) const {
1543 assert(A != Attribute::NoBuiltin &&
1544 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
1545 return hasFnAttrImpl(A);
1548 /// \brief Determine whether this call has the given attribute.
1549 bool hasFnAttr(StringRef A) const {
1550 return hasFnAttrImpl(A);
1553 /// \brief Determine whether the call or the callee has the given attributes.
1554 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const;
1556 /// \brief Extract the alignment for a call or parameter (0=unknown).
1557 unsigned getParamAlignment(unsigned i) const {
1558 return AttributeList.getParamAlignment(i);
1561 /// \brief Extract the number of dereferenceable bytes for a call or
1562 /// parameter (0=unknown).
1563 uint64_t getDereferenceableBytes(unsigned i) const {
1564 return AttributeList.getDereferenceableBytes(i);
1567 /// \brief Extract the number of dereferenceable_or_null bytes for a call or
1568 /// parameter (0=unknown).
1569 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
1570 return AttributeList.getDereferenceableOrNullBytes(i);
1573 /// \brief Return true if the call should not be treated as a call to a
1575 bool isNoBuiltin() const {
1576 return hasFnAttrImpl(Attribute::NoBuiltin) &&
1577 !hasFnAttrImpl(Attribute::Builtin);
1580 /// \brief Return true if the call should not be inlined.
1581 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
1582 void setIsNoInline() {
1583 addAttribute(AttributeSet::FunctionIndex, Attribute::NoInline);
1586 /// \brief Return true if the call can return twice
1587 bool canReturnTwice() const {
1588 return hasFnAttr(Attribute::ReturnsTwice);
1590 void setCanReturnTwice() {
1591 addAttribute(AttributeSet::FunctionIndex, Attribute::ReturnsTwice);
1594 /// \brief Determine if the call does not access memory.
1595 bool doesNotAccessMemory() const {
1596 return hasFnAttr(Attribute::ReadNone);
1598 void setDoesNotAccessMemory() {
1599 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
1602 /// \brief Determine if the call does not access or only reads memory.
1603 bool onlyReadsMemory() const {
1604 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
1606 void setOnlyReadsMemory() {
1607 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
1610 /// @brief Determine if the call can access memmory only using pointers based
1611 /// on its arguments.
1612 bool onlyAccessesArgMemory() const {
1613 return hasFnAttr(Attribute::ArgMemOnly);
1615 void setOnlyAccessesArgMemory() {
1616 addAttribute(AttributeSet::FunctionIndex, Attribute::ArgMemOnly);
1619 /// \brief Determine if the call cannot return.
1620 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
1621 void setDoesNotReturn() {
1622 addAttribute(AttributeSet::FunctionIndex, Attribute::NoReturn);
1625 /// \brief Determine if the call cannot unwind.
1626 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
1627 void setDoesNotThrow() {
1628 addAttribute(AttributeSet::FunctionIndex, Attribute::NoUnwind);
1631 /// \brief Determine if the call cannot be duplicated.
1632 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
1633 void setCannotDuplicate() {
1634 addAttribute(AttributeSet::FunctionIndex, Attribute::NoDuplicate);
1637 /// \brief Determine if the call is convergent
1638 bool isConvergent() const { return hasFnAttr(Attribute::Convergent); }
1639 void setConvergent() {
1640 addAttribute(AttributeSet::FunctionIndex, Attribute::Convergent);
1643 /// \brief Determine if the call returns a structure through first
1644 /// pointer argument.
1645 bool hasStructRetAttr() const {
1646 // Be friendly and also check the callee.
1647 return paramHasAttr(1, Attribute::StructRet);
1650 /// \brief Determine if any call argument is an aggregate passed by value.
1651 bool hasByValArgument() const {
1652 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1655 /// getCalledFunction - Return the function called, or null if this is an
1656 /// indirect function invocation.
1658 Function *getCalledFunction() const {
1659 return dyn_cast<Function>(Op<-1>());
1662 /// getCalledValue - Get a pointer to the function that is invoked by this
1664 const Value *getCalledValue() const { return Op<-1>(); }
1665 Value *getCalledValue() { return Op<-1>(); }
1667 /// setCalledFunction - Set the function called.
1668 void setCalledFunction(Value* Fn) {
1670 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
1673 void setCalledFunction(FunctionType *FTy, Value *Fn) {
1675 assert(FTy == cast<FunctionType>(
1676 cast<PointerType>(Fn->getType())->getElementType()));
1680 /// isInlineAsm - Check if this call is an inline asm statement.
1681 bool isInlineAsm() const {
1682 return isa<InlineAsm>(Op<-1>());
1685 // Methods for support type inquiry through isa, cast, and dyn_cast:
1686 static inline bool classof(const Instruction *I) {
1687 return I->getOpcode() == Instruction::Call;
1689 static inline bool classof(const Value *V) {
1690 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1694 template <typename AttrKind> bool hasFnAttrImpl(AttrKind A) const {
1695 if (AttributeList.hasAttribute(AttributeSet::FunctionIndex, A))
1697 if (const Function *F = getCalledFunction())
1698 return F->getAttributes().hasAttribute(AttributeSet::FunctionIndex, A);
1702 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1703 // method so that subclasses cannot accidentally use it.
1704 void setInstructionSubclassData(unsigned short D) {
1705 Instruction::setInstructionSubclassData(D);
1710 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1713 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1714 const Twine &NameStr, BasicBlock *InsertAtEnd)
1715 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1716 ->getElementType())->getReturnType(),
1718 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1719 unsigned(Args.size() + 1), InsertAtEnd) {
1720 init(Func, Args, NameStr);
1723 CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1724 const Twine &NameStr, Instruction *InsertBefore)
1725 : Instruction(Ty->getReturnType(), Instruction::Call,
1726 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1727 unsigned(Args.size() + 1), InsertBefore) {
1728 init(Ty, Func, Args, NameStr);
1732 // Note: if you get compile errors about private methods then
1733 // please update your code to use the high-level operand
1734 // interfaces. See line 943 above.
1735 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1737 //===----------------------------------------------------------------------===//
1739 //===----------------------------------------------------------------------===//
1741 /// SelectInst - This class represents the LLVM 'select' instruction.
1743 class SelectInst : public Instruction {
1744 void init(Value *C, Value *S1, Value *S2) {
1745 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1751 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1752 Instruction *InsertBefore)
1753 : Instruction(S1->getType(), Instruction::Select,
1754 &Op<0>(), 3, InsertBefore) {
1758 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1759 BasicBlock *InsertAtEnd)
1760 : Instruction(S1->getType(), Instruction::Select,
1761 &Op<0>(), 3, InsertAtEnd) {
1766 // Note: Instruction needs to be a friend here to call cloneImpl.
1767 friend class Instruction;
1768 SelectInst *cloneImpl() const;
1771 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1772 const Twine &NameStr = "",
1773 Instruction *InsertBefore = nullptr) {
1774 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1776 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1777 const Twine &NameStr,
1778 BasicBlock *InsertAtEnd) {
1779 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1782 const Value *getCondition() const { return Op<0>(); }
1783 const Value *getTrueValue() const { return Op<1>(); }
1784 const Value *getFalseValue() const { return Op<2>(); }
1785 Value *getCondition() { return Op<0>(); }
1786 Value *getTrueValue() { return Op<1>(); }
1787 Value *getFalseValue() { return Op<2>(); }
1789 /// areInvalidOperands - Return a string if the specified operands are invalid
1790 /// for a select operation, otherwise return null.
1791 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1793 /// Transparently provide more efficient getOperand methods.
1794 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1796 OtherOps getOpcode() const {
1797 return static_cast<OtherOps>(Instruction::getOpcode());
1800 // Methods for support type inquiry through isa, cast, and dyn_cast:
1801 static inline bool classof(const Instruction *I) {
1802 return I->getOpcode() == Instruction::Select;
1804 static inline bool classof(const Value *V) {
1805 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1810 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1813 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1815 //===----------------------------------------------------------------------===//
1817 //===----------------------------------------------------------------------===//
1819 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1820 /// an argument of the specified type given a va_list and increments that list
1822 class VAArgInst : public UnaryInstruction {
1824 // Note: Instruction needs to be a friend here to call cloneImpl.
1825 friend class Instruction;
1826 VAArgInst *cloneImpl() const;
1829 VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1830 Instruction *InsertBefore = nullptr)
1831 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1834 VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1835 BasicBlock *InsertAtEnd)
1836 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1840 Value *getPointerOperand() { return getOperand(0); }
1841 const Value *getPointerOperand() const { return getOperand(0); }
1842 static unsigned getPointerOperandIndex() { return 0U; }
1844 // Methods for support type inquiry through isa, cast, and dyn_cast:
1845 static inline bool classof(const Instruction *I) {
1846 return I->getOpcode() == VAArg;
1848 static inline bool classof(const Value *V) {
1849 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1853 //===----------------------------------------------------------------------===//
1854 // ExtractElementInst Class
1855 //===----------------------------------------------------------------------===//
1857 /// ExtractElementInst - This instruction extracts a single (scalar)
1858 /// element from a VectorType value
1860 class ExtractElementInst : public Instruction {
1861 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1862 Instruction *InsertBefore = nullptr);
1863 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1864 BasicBlock *InsertAtEnd);
1866 // Note: Instruction needs to be a friend here to call cloneImpl.
1867 friend class Instruction;
1868 ExtractElementInst *cloneImpl() const;
1871 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1872 const Twine &NameStr = "",
1873 Instruction *InsertBefore = nullptr) {
1874 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1876 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1877 const Twine &NameStr,
1878 BasicBlock *InsertAtEnd) {
1879 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1882 /// isValidOperands - Return true if an extractelement instruction can be
1883 /// formed with the specified operands.
1884 static bool isValidOperands(const Value *Vec, const Value *Idx);
1886 Value *getVectorOperand() { return Op<0>(); }
1887 Value *getIndexOperand() { return Op<1>(); }
1888 const Value *getVectorOperand() const { return Op<0>(); }
1889 const Value *getIndexOperand() const { return Op<1>(); }
1891 VectorType *getVectorOperandType() const {
1892 return cast<VectorType>(getVectorOperand()->getType());
1896 /// Transparently provide more efficient getOperand methods.
1897 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1899 // Methods for support type inquiry through isa, cast, and dyn_cast:
1900 static inline bool classof(const Instruction *I) {
1901 return I->getOpcode() == Instruction::ExtractElement;
1903 static inline bool classof(const Value *V) {
1904 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1909 struct OperandTraits<ExtractElementInst> :
1910 public FixedNumOperandTraits<ExtractElementInst, 2> {
1913 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1915 //===----------------------------------------------------------------------===//
1916 // InsertElementInst Class
1917 //===----------------------------------------------------------------------===//
1919 /// InsertElementInst - This instruction inserts a single (scalar)
1920 /// element into a VectorType value
1922 class InsertElementInst : public Instruction {
1923 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1924 const Twine &NameStr = "",
1925 Instruction *InsertBefore = nullptr);
1926 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx, const Twine &NameStr,
1927 BasicBlock *InsertAtEnd);
1930 // Note: Instruction needs to be a friend here to call cloneImpl.
1931 friend class Instruction;
1932 InsertElementInst *cloneImpl() const;
1935 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1936 const Twine &NameStr = "",
1937 Instruction *InsertBefore = nullptr) {
1938 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1940 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1941 const Twine &NameStr,
1942 BasicBlock *InsertAtEnd) {
1943 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1946 /// isValidOperands - Return true if an insertelement instruction can be
1947 /// formed with the specified operands.
1948 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1951 /// getType - Overload to return most specific vector type.
1953 VectorType *getType() const {
1954 return cast<VectorType>(Instruction::getType());
1957 /// Transparently provide more efficient getOperand methods.
1958 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1960 // Methods for support type inquiry through isa, cast, and dyn_cast:
1961 static inline bool classof(const Instruction *I) {
1962 return I->getOpcode() == Instruction::InsertElement;
1964 static inline bool classof(const Value *V) {
1965 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1970 struct OperandTraits<InsertElementInst> :
1971 public FixedNumOperandTraits<InsertElementInst, 3> {
1974 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1976 //===----------------------------------------------------------------------===//
1977 // ShuffleVectorInst Class
1978 //===----------------------------------------------------------------------===//
1980 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1983 class ShuffleVectorInst : public Instruction {
1985 // Note: Instruction needs to be a friend here to call cloneImpl.
1986 friend class Instruction;
1987 ShuffleVectorInst *cloneImpl() const;
1990 // allocate space for exactly three operands
1991 void *operator new(size_t s) {
1992 return User::operator new(s, 3);
1994 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1995 const Twine &NameStr = "",
1996 Instruction *InsertBefor = nullptr);
1997 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1998 const Twine &NameStr, BasicBlock *InsertAtEnd);
2000 /// isValidOperands - Return true if a shufflevector instruction can be
2001 /// formed with the specified operands.
2002 static bool isValidOperands(const Value *V1, const Value *V2,
2005 /// getType - Overload to return most specific vector type.
2007 VectorType *getType() const {
2008 return cast<VectorType>(Instruction::getType());
2011 /// Transparently provide more efficient getOperand methods.
2012 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2014 Constant *getMask() const {
2015 return cast<Constant>(getOperand(2));
2018 /// getMaskValue - Return the index from the shuffle mask for the specified
2019 /// output result. This is either -1 if the element is undef or a number less
2020 /// than 2*numelements.
2021 static int getMaskValue(Constant *Mask, unsigned i);
2023 int getMaskValue(unsigned i) const {
2024 return getMaskValue(getMask(), i);
2027 /// getShuffleMask - Return the full mask for this instruction, where each
2028 /// element is the element number and undef's are returned as -1.
2029 static void getShuffleMask(Constant *Mask, SmallVectorImpl<int> &Result);
2031 void getShuffleMask(SmallVectorImpl<int> &Result) const {
2032 return getShuffleMask(getMask(), Result);
2035 SmallVector<int, 16> getShuffleMask() const {
2036 SmallVector<int, 16> Mask;
2037 getShuffleMask(Mask);
2042 // Methods for support type inquiry through isa, cast, and dyn_cast:
2043 static inline bool classof(const Instruction *I) {
2044 return I->getOpcode() == Instruction::ShuffleVector;
2046 static inline bool classof(const Value *V) {
2047 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2052 struct OperandTraits<ShuffleVectorInst> :
2053 public FixedNumOperandTraits<ShuffleVectorInst, 3> {
2056 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
2058 //===----------------------------------------------------------------------===//
2059 // ExtractValueInst Class
2060 //===----------------------------------------------------------------------===//
2062 /// ExtractValueInst - This instruction extracts a struct member or array
2063 /// element value from an aggregate value.
2065 class ExtractValueInst : public UnaryInstruction {
2066 SmallVector<unsigned, 4> Indices;
2068 ExtractValueInst(const ExtractValueInst &EVI);
2069 void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
2071 /// Constructors - Create a extractvalue instruction with a base aggregate
2072 /// value and a list of indices. The first ctor can optionally insert before
2073 /// an existing instruction, the second appends the new instruction to the
2074 /// specified BasicBlock.
2075 inline ExtractValueInst(Value *Agg,
2076 ArrayRef<unsigned> Idxs,
2077 const Twine &NameStr,
2078 Instruction *InsertBefore);
2079 inline ExtractValueInst(Value *Agg,
2080 ArrayRef<unsigned> Idxs,
2081 const Twine &NameStr, BasicBlock *InsertAtEnd);
2083 // allocate space for exactly one operand
2084 void *operator new(size_t s) { return User::operator new(s, 1); }
2087 // Note: Instruction needs to be a friend here to call cloneImpl.
2088 friend class Instruction;
2089 ExtractValueInst *cloneImpl() const;
2092 static ExtractValueInst *Create(Value *Agg,
2093 ArrayRef<unsigned> Idxs,
2094 const Twine &NameStr = "",
2095 Instruction *InsertBefore = nullptr) {
2097 ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
2099 static ExtractValueInst *Create(Value *Agg,
2100 ArrayRef<unsigned> Idxs,
2101 const Twine &NameStr,
2102 BasicBlock *InsertAtEnd) {
2103 return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
2106 /// getIndexedType - Returns the type of the element that would be extracted
2107 /// with an extractvalue instruction with the specified parameters.
2109 /// Null is returned if the indices are invalid for the specified type.
2110 static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
2112 typedef const unsigned* idx_iterator;
2113 inline idx_iterator idx_begin() const { return Indices.begin(); }
2114 inline idx_iterator idx_end() const { return Indices.end(); }
2115 inline iterator_range<idx_iterator> indices() const {
2116 return iterator_range<idx_iterator>(idx_begin(), idx_end());
2119 Value *getAggregateOperand() {
2120 return getOperand(0);
2122 const Value *getAggregateOperand() const {
2123 return getOperand(0);
2125 static unsigned getAggregateOperandIndex() {
2126 return 0U; // get index for modifying correct operand
2129 ArrayRef<unsigned> getIndices() const {
2133 unsigned getNumIndices() const {
2134 return (unsigned)Indices.size();
2137 bool hasIndices() const {
2141 // Methods for support type inquiry through isa, cast, and dyn_cast:
2142 static inline bool classof(const Instruction *I) {
2143 return I->getOpcode() == Instruction::ExtractValue;
2145 static inline bool classof(const Value *V) {
2146 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2150 ExtractValueInst::ExtractValueInst(Value *Agg,
2151 ArrayRef<unsigned> Idxs,
2152 const Twine &NameStr,
2153 Instruction *InsertBefore)
2154 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2155 ExtractValue, Agg, InsertBefore) {
2156 init(Idxs, NameStr);
2158 ExtractValueInst::ExtractValueInst(Value *Agg,
2159 ArrayRef<unsigned> Idxs,
2160 const Twine &NameStr,
2161 BasicBlock *InsertAtEnd)
2162 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2163 ExtractValue, Agg, InsertAtEnd) {
2164 init(Idxs, NameStr);
2168 //===----------------------------------------------------------------------===//
2169 // InsertValueInst Class
2170 //===----------------------------------------------------------------------===//
2172 /// InsertValueInst - This instruction inserts a struct field of array element
2173 /// value into an aggregate value.
2175 class InsertValueInst : public Instruction {
2176 SmallVector<unsigned, 4> Indices;
2178 void *operator new(size_t, unsigned) = delete;
2179 InsertValueInst(const InsertValueInst &IVI);
2180 void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
2181 const Twine &NameStr);
2183 /// Constructors - Create a insertvalue instruction with a base aggregate
2184 /// value, a value to insert, and a list of indices. The first ctor can
2185 /// optionally insert before an existing instruction, the second appends
2186 /// the new instruction to the specified BasicBlock.
2187 inline InsertValueInst(Value *Agg, Value *Val,
2188 ArrayRef<unsigned> Idxs,
2189 const Twine &NameStr,
2190 Instruction *InsertBefore);
2191 inline InsertValueInst(Value *Agg, Value *Val,
2192 ArrayRef<unsigned> Idxs,
2193 const Twine &NameStr, BasicBlock *InsertAtEnd);
2195 /// Constructors - These two constructors are convenience methods because one
2196 /// and two index insertvalue instructions are so common.
2197 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
2198 const Twine &NameStr = "",
2199 Instruction *InsertBefore = nullptr);
2200 InsertValueInst(Value *Agg, Value *Val, unsigned Idx, const Twine &NameStr,
2201 BasicBlock *InsertAtEnd);
2204 // Note: Instruction needs to be a friend here to call cloneImpl.
2205 friend class Instruction;
2206 InsertValueInst *cloneImpl() const;
2209 // allocate space for exactly two operands
2210 void *operator new(size_t s) {
2211 return User::operator new(s, 2);
2214 static InsertValueInst *Create(Value *Agg, Value *Val,
2215 ArrayRef<unsigned> Idxs,
2216 const Twine &NameStr = "",
2217 Instruction *InsertBefore = nullptr) {
2218 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
2220 static InsertValueInst *Create(Value *Agg, Value *Val,
2221 ArrayRef<unsigned> Idxs,
2222 const Twine &NameStr,
2223 BasicBlock *InsertAtEnd) {
2224 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
2227 /// Transparently provide more efficient getOperand methods.
2228 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2230 typedef const unsigned* idx_iterator;
2231 inline idx_iterator idx_begin() const { return Indices.begin(); }
2232 inline idx_iterator idx_end() const { return Indices.end(); }
2233 inline iterator_range<idx_iterator> indices() const {
2234 return iterator_range<idx_iterator>(idx_begin(), idx_end());
2237 Value *getAggregateOperand() {
2238 return getOperand(0);
2240 const Value *getAggregateOperand() const {
2241 return getOperand(0);
2243 static unsigned getAggregateOperandIndex() {
2244 return 0U; // get index for modifying correct operand
2247 Value *getInsertedValueOperand() {
2248 return getOperand(1);
2250 const Value *getInsertedValueOperand() const {
2251 return getOperand(1);
2253 static unsigned getInsertedValueOperandIndex() {
2254 return 1U; // get index for modifying correct operand
2257 ArrayRef<unsigned> getIndices() const {
2261 unsigned getNumIndices() const {
2262 return (unsigned)Indices.size();
2265 bool hasIndices() const {
2269 // Methods for support type inquiry through isa, cast, and dyn_cast:
2270 static inline bool classof(const Instruction *I) {
2271 return I->getOpcode() == Instruction::InsertValue;
2273 static inline bool classof(const Value *V) {
2274 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2279 struct OperandTraits<InsertValueInst> :
2280 public FixedNumOperandTraits<InsertValueInst, 2> {
2283 InsertValueInst::InsertValueInst(Value *Agg,
2285 ArrayRef<unsigned> Idxs,
2286 const Twine &NameStr,
2287 Instruction *InsertBefore)
2288 : Instruction(Agg->getType(), InsertValue,
2289 OperandTraits<InsertValueInst>::op_begin(this),
2291 init(Agg, Val, Idxs, NameStr);
2293 InsertValueInst::InsertValueInst(Value *Agg,
2295 ArrayRef<unsigned> Idxs,
2296 const Twine &NameStr,
2297 BasicBlock *InsertAtEnd)
2298 : Instruction(Agg->getType(), InsertValue,
2299 OperandTraits<InsertValueInst>::op_begin(this),
2301 init(Agg, Val, Idxs, NameStr);
2304 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
2306 //===----------------------------------------------------------------------===//
2308 //===----------------------------------------------------------------------===//
2310 // PHINode - The PHINode class is used to represent the magical mystical PHI
2311 // node, that can not exist in nature, but can be synthesized in a computer
2312 // scientist's overactive imagination.
2314 class PHINode : public Instruction {
2315 void *operator new(size_t, unsigned) = delete;
2316 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2317 /// the number actually in use.
2318 unsigned ReservedSpace;
2319 PHINode(const PHINode &PN);
2320 // allocate space for exactly zero operands
2321 void *operator new(size_t s) {
2322 return User::operator new(s);
2324 explicit PHINode(Type *Ty, unsigned NumReservedValues,
2325 const Twine &NameStr = "",
2326 Instruction *InsertBefore = nullptr)
2327 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertBefore),
2328 ReservedSpace(NumReservedValues) {
2330 allocHungoffUses(ReservedSpace);
2333 PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
2334 BasicBlock *InsertAtEnd)
2335 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertAtEnd),
2336 ReservedSpace(NumReservedValues) {
2338 allocHungoffUses(ReservedSpace);
2341 // allocHungoffUses - this is more complicated than the generic
2342 // User::allocHungoffUses, because we have to allocate Uses for the incoming
2343 // values and pointers to the incoming blocks, all in one allocation.
2344 void allocHungoffUses(unsigned N) {
2345 User::allocHungoffUses(N, /* IsPhi */ true);
2348 // Note: Instruction needs to be a friend here to call cloneImpl.
2349 friend class Instruction;
2350 PHINode *cloneImpl() const;
2353 /// Constructors - NumReservedValues is a hint for the number of incoming
2354 /// edges that this phi node will have (use 0 if you really have no idea).
2355 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2356 const Twine &NameStr = "",
2357 Instruction *InsertBefore = nullptr) {
2358 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2360 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2361 const Twine &NameStr, BasicBlock *InsertAtEnd) {
2362 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2365 /// Provide fast operand accessors
2366 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2368 // Block iterator interface. This provides access to the list of incoming
2369 // basic blocks, which parallels the list of incoming values.
2371 typedef BasicBlock **block_iterator;
2372 typedef BasicBlock * const *const_block_iterator;
2374 block_iterator block_begin() {
2376 reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2377 return reinterpret_cast<block_iterator>(ref + 1);
2380 const_block_iterator block_begin() const {
2381 const Use::UserRef *ref =
2382 reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2383 return reinterpret_cast<const_block_iterator>(ref + 1);
2386 block_iterator block_end() {
2387 return block_begin() + getNumOperands();
2390 const_block_iterator block_end() const {
2391 return block_begin() + getNumOperands();
2394 op_range incoming_values() { return operands(); }
2396 const_op_range incoming_values() const { return operands(); }
2398 /// getNumIncomingValues - Return the number of incoming edges
2400 unsigned getNumIncomingValues() const { return getNumOperands(); }
2402 /// getIncomingValue - Return incoming value number x
2404 Value *getIncomingValue(unsigned i) const {
2405 return getOperand(i);
2407 void setIncomingValue(unsigned i, Value *V) {
2408 assert(V && "PHI node got a null value!");
2409 assert(getType() == V->getType() &&
2410 "All operands to PHI node must be the same type as the PHI node!");
2413 static unsigned getOperandNumForIncomingValue(unsigned i) {
2416 static unsigned getIncomingValueNumForOperand(unsigned i) {
2420 /// getIncomingBlock - Return incoming basic block number @p i.
2422 BasicBlock *getIncomingBlock(unsigned i) const {
2423 return block_begin()[i];
2426 /// getIncomingBlock - Return incoming basic block corresponding
2427 /// to an operand of the PHI.
2429 BasicBlock *getIncomingBlock(const Use &U) const {
2430 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2431 return getIncomingBlock(unsigned(&U - op_begin()));
2434 /// getIncomingBlock - Return incoming basic block corresponding
2435 /// to value use iterator.
2437 BasicBlock *getIncomingBlock(Value::const_user_iterator I) const {
2438 return getIncomingBlock(I.getUse());
2441 void setIncomingBlock(unsigned i, BasicBlock *BB) {
2442 assert(BB && "PHI node got a null basic block!");
2443 block_begin()[i] = BB;
2446 /// addIncoming - Add an incoming value to the end of the PHI list
2448 void addIncoming(Value *V, BasicBlock *BB) {
2449 if (getNumOperands() == ReservedSpace)
2450 growOperands(); // Get more space!
2451 // Initialize some new operands.
2452 setNumHungOffUseOperands(getNumOperands() + 1);
2453 setIncomingValue(getNumOperands() - 1, V);
2454 setIncomingBlock(getNumOperands() - 1, BB);
2457 /// removeIncomingValue - Remove an incoming value. This is useful if a
2458 /// predecessor basic block is deleted. The value removed is returned.
2460 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2461 /// is true), the PHI node is destroyed and any uses of it are replaced with
2462 /// dummy values. The only time there should be zero incoming values to a PHI
2463 /// node is when the block is dead, so this strategy is sound.
2465 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2467 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2468 int Idx = getBasicBlockIndex(BB);
2469 assert(Idx >= 0 && "Invalid basic block argument to remove!");
2470 return removeIncomingValue(Idx, DeletePHIIfEmpty);
2473 /// getBasicBlockIndex - Return the first index of the specified basic
2474 /// block in the value list for this PHI. Returns -1 if no instance.
2476 int getBasicBlockIndex(const BasicBlock *BB) const {
2477 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2478 if (block_begin()[i] == BB)
2483 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2484 int Idx = getBasicBlockIndex(BB);
2485 assert(Idx >= 0 && "Invalid basic block argument!");
2486 return getIncomingValue(Idx);
2489 /// hasConstantValue - If the specified PHI node always merges together the
2490 /// same value, return the value, otherwise return null.
2491 Value *hasConstantValue() const;
2493 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2494 static inline bool classof(const Instruction *I) {
2495 return I->getOpcode() == Instruction::PHI;
2497 static inline bool classof(const Value *V) {
2498 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2501 void growOperands();
2505 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2508 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2510 //===----------------------------------------------------------------------===//
2511 // LandingPadInst Class
2512 //===----------------------------------------------------------------------===//
2514 //===---------------------------------------------------------------------------
2515 /// LandingPadInst - The landingpad instruction holds all of the information
2516 /// necessary to generate correct exception handling. The landingpad instruction
2517 /// cannot be moved from the top of a landing pad block, which itself is
2518 /// accessible only from the 'unwind' edge of an invoke. This uses the
2519 /// SubclassData field in Value to store whether or not the landingpad is a
2522 class LandingPadInst : public Instruction {
2523 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2524 /// the number actually in use.
2525 unsigned ReservedSpace;
2526 LandingPadInst(const LandingPadInst &LP);
2528 enum ClauseType { Catch, Filter };
2530 void *operator new(size_t, unsigned) = delete;
2531 // Allocate space for exactly zero operands.
2532 void *operator new(size_t s) {
2533 return User::operator new(s);
2535 void growOperands(unsigned Size);
2536 void init(unsigned NumReservedValues, const Twine &NameStr);
2538 explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues,
2539 const Twine &NameStr, Instruction *InsertBefore);
2540 explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues,
2541 const Twine &NameStr, BasicBlock *InsertAtEnd);
2544 // Note: Instruction needs to be a friend here to call cloneImpl.
2545 friend class Instruction;
2546 LandingPadInst *cloneImpl() const;
2549 /// Constructors - NumReservedClauses is a hint for the number of incoming
2550 /// clauses that this landingpad will have (use 0 if you really have no idea).
2551 static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses,
2552 const Twine &NameStr = "",
2553 Instruction *InsertBefore = nullptr);
2554 static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses,
2555 const Twine &NameStr, BasicBlock *InsertAtEnd);
2557 /// Provide fast operand accessors
2558 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2560 /// isCleanup - Return 'true' if this landingpad instruction is a
2561 /// cleanup. I.e., it should be run when unwinding even if its landing pad
2562 /// doesn't catch the exception.
2563 bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2565 /// setCleanup - Indicate that this landingpad instruction is a cleanup.
2566 void setCleanup(bool V) {
2567 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2571 /// Add a catch or filter clause to the landing pad.
2572 void addClause(Constant *ClauseVal);
2574 /// Get the value of the clause at index Idx. Use isCatch/isFilter to
2575 /// determine what type of clause this is.
2576 Constant *getClause(unsigned Idx) const {
2577 return cast<Constant>(getOperandList()[Idx]);
2580 /// isCatch - Return 'true' if the clause and index Idx is a catch clause.
2581 bool isCatch(unsigned Idx) const {
2582 return !isa<ArrayType>(getOperandList()[Idx]->getType());
2585 /// isFilter - Return 'true' if the clause and index Idx is a filter clause.
2586 bool isFilter(unsigned Idx) const {
2587 return isa<ArrayType>(getOperandList()[Idx]->getType());
2590 /// getNumClauses - Get the number of clauses for this landing pad.
2591 unsigned getNumClauses() const { return getNumOperands(); }
2593 /// reserveClauses - Grow the size of the operand list to accommodate the new
2594 /// number of clauses.
2595 void reserveClauses(unsigned Size) { growOperands(Size); }
2597 // Methods for support type inquiry through isa, cast, and dyn_cast:
2598 static inline bool classof(const Instruction *I) {
2599 return I->getOpcode() == Instruction::LandingPad;
2601 static inline bool classof(const Value *V) {
2602 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2607 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<1> {
2610 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2612 //===----------------------------------------------------------------------===//
2614 //===----------------------------------------------------------------------===//
2616 //===---------------------------------------------------------------------------
2617 /// ReturnInst - Return a value (possibly void), from a function. Execution
2618 /// does not continue in this function any longer.
2620 class ReturnInst : public TerminatorInst {
2621 ReturnInst(const ReturnInst &RI);
2624 // ReturnInst constructors:
2625 // ReturnInst() - 'ret void' instruction
2626 // ReturnInst( null) - 'ret void' instruction
2627 // ReturnInst(Value* X) - 'ret X' instruction
2628 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2629 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2630 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2631 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2633 // NOTE: If the Value* passed is of type void then the constructor behaves as
2634 // if it was passed NULL.
2635 explicit ReturnInst(LLVMContext &C, Value *retVal = nullptr,
2636 Instruction *InsertBefore = nullptr);
2637 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2638 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2640 // Note: Instruction needs to be a friend here to call cloneImpl.
2641 friend class Instruction;
2642 ReturnInst *cloneImpl() const;
2645 static ReturnInst* Create(LLVMContext &C, Value *retVal = nullptr,
2646 Instruction *InsertBefore = nullptr) {
2647 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2649 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2650 BasicBlock *InsertAtEnd) {
2651 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2653 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2654 return new(0) ReturnInst(C, InsertAtEnd);
2656 ~ReturnInst() override;
2658 /// Provide fast operand accessors
2659 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2661 /// Convenience accessor. Returns null if there is no return value.
2662 Value *getReturnValue() const {
2663 return getNumOperands() != 0 ? getOperand(0) : nullptr;
2666 unsigned getNumSuccessors() const { return 0; }
2668 // Methods for support type inquiry through isa, cast, and dyn_cast:
2669 static inline bool classof(const Instruction *I) {
2670 return (I->getOpcode() == Instruction::Ret);
2672 static inline bool classof(const Value *V) {
2673 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2676 BasicBlock *getSuccessorV(unsigned idx) const override;
2677 unsigned getNumSuccessorsV() const override;
2678 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2682 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2685 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2687 //===----------------------------------------------------------------------===//
2689 //===----------------------------------------------------------------------===//
2691 //===---------------------------------------------------------------------------
2692 /// BranchInst - Conditional or Unconditional Branch instruction.
2694 class BranchInst : public TerminatorInst {
2695 /// Ops list - Branches are strange. The operands are ordered:
2696 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2697 /// they don't have to check for cond/uncond branchness. These are mostly
2698 /// accessed relative from op_end().
2699 BranchInst(const BranchInst &BI);
2701 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2702 // BranchInst(BB *B) - 'br B'
2703 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2704 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2705 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2706 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2707 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2708 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = nullptr);
2709 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2710 Instruction *InsertBefore = nullptr);
2711 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2712 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2713 BasicBlock *InsertAtEnd);
2715 // Note: Instruction needs to be a friend here to call cloneImpl.
2716 friend class Instruction;
2717 BranchInst *cloneImpl() const;
2720 static BranchInst *Create(BasicBlock *IfTrue,
2721 Instruction *InsertBefore = nullptr) {
2722 return new(1) BranchInst(IfTrue, InsertBefore);
2724 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2725 Value *Cond, Instruction *InsertBefore = nullptr) {
2726 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2728 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2729 return new(1) BranchInst(IfTrue, InsertAtEnd);
2731 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2732 Value *Cond, BasicBlock *InsertAtEnd) {
2733 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2736 /// Transparently provide more efficient getOperand methods.
2737 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2739 bool isUnconditional() const { return getNumOperands() == 1; }
2740 bool isConditional() const { return getNumOperands() == 3; }
2742 Value *getCondition() const {
2743 assert(isConditional() && "Cannot get condition of an uncond branch!");
2747 void setCondition(Value *V) {
2748 assert(isConditional() && "Cannot set condition of unconditional branch!");
2752 unsigned getNumSuccessors() const { return 1+isConditional(); }
2754 BasicBlock *getSuccessor(unsigned i) const {
2755 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2756 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2759 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2760 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2761 *(&Op<-1>() - idx) = NewSucc;
2764 /// \brief Swap the successors of this branch instruction.
2766 /// Swaps the successors of the branch instruction. This also swaps any
2767 /// branch weight metadata associated with the instruction so that it
2768 /// continues to map correctly to each operand.
2769 void swapSuccessors();
2771 // Methods for support type inquiry through isa, cast, and dyn_cast:
2772 static inline bool classof(const Instruction *I) {
2773 return (I->getOpcode() == Instruction::Br);
2775 static inline bool classof(const Value *V) {
2776 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2779 BasicBlock *getSuccessorV(unsigned idx) const override;
2780 unsigned getNumSuccessorsV() const override;
2781 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2785 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2788 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2790 //===----------------------------------------------------------------------===//
2792 //===----------------------------------------------------------------------===//
2794 //===---------------------------------------------------------------------------
2795 /// SwitchInst - Multiway switch
2797 class SwitchInst : public TerminatorInst {
2798 void *operator new(size_t, unsigned) = delete;
2799 unsigned ReservedSpace;
2800 // Operand[0] = Value to switch on
2801 // Operand[1] = Default basic block destination
2802 // Operand[2n ] = Value to match
2803 // Operand[2n+1] = BasicBlock to go to on match
2804 SwitchInst(const SwitchInst &SI);
2805 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2806 void growOperands();
2807 // allocate space for exactly zero operands
2808 void *operator new(size_t s) {
2809 return User::operator new(s);
2811 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2812 /// switch on and a default destination. The number of additional cases can
2813 /// be specified here to make memory allocation more efficient. This
2814 /// constructor can also autoinsert before another instruction.
2815 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2816 Instruction *InsertBefore);
2818 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2819 /// switch on and a default destination. The number of additional cases can
2820 /// be specified here to make memory allocation more efficient. This
2821 /// constructor also autoinserts at the end of the specified BasicBlock.
2822 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2823 BasicBlock *InsertAtEnd);
2825 // Note: Instruction needs to be a friend here to call cloneImpl.
2826 friend class Instruction;
2827 SwitchInst *cloneImpl() const;
2832 static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
2834 template <class SwitchInstTy, class ConstantIntTy, class BasicBlockTy>
2835 class CaseIteratorT {
2843 typedef CaseIteratorT<SwitchInstTy, ConstantIntTy, BasicBlockTy> Self;
2845 /// Initializes case iterator for given SwitchInst and for given
2847 CaseIteratorT(SwitchInstTy *SI, unsigned CaseNum) {
2852 /// Initializes case iterator for given SwitchInst and for given
2853 /// TerminatorInst's successor index.
2854 static Self fromSuccessorIndex(SwitchInstTy *SI, unsigned SuccessorIndex) {
2855 assert(SuccessorIndex < SI->getNumSuccessors() &&
2856 "Successor index # out of range!");
2857 return SuccessorIndex != 0 ?
2858 Self(SI, SuccessorIndex - 1) :
2859 Self(SI, DefaultPseudoIndex);
2862 /// Resolves case value for current case.
2863 ConstantIntTy *getCaseValue() {
2864 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2865 return reinterpret_cast<ConstantIntTy*>(SI->getOperand(2 + Index*2));
2868 /// Resolves successor for current case.
2869 BasicBlockTy *getCaseSuccessor() {
2870 assert((Index < SI->getNumCases() ||
2871 Index == DefaultPseudoIndex) &&
2872 "Index out the number of cases.");
2873 return SI->getSuccessor(getSuccessorIndex());
2876 /// Returns number of current case.
2877 unsigned getCaseIndex() const { return Index; }
2879 /// Returns TerminatorInst's successor index for current case successor.
2880 unsigned getSuccessorIndex() const {
2881 assert((Index == DefaultPseudoIndex || Index < SI->getNumCases()) &&
2882 "Index out the number of cases.");
2883 return Index != DefaultPseudoIndex ? Index + 1 : 0;
2887 // Check index correctness after increment.
2888 // Note: Index == getNumCases() means end().
2889 assert(Index+1 <= SI->getNumCases() && "Index out the number of cases.");
2893 Self operator++(int) {
2899 // Check index correctness after decrement.
2900 // Note: Index == getNumCases() means end().
2901 // Also allow "-1" iterator here. That will became valid after ++.
2902 assert((Index == 0 || Index-1 <= SI->getNumCases()) &&
2903 "Index out the number of cases.");
2907 Self operator--(int) {
2912 bool operator==(const Self& RHS) const {
2913 assert(RHS.SI == SI && "Incompatible operators.");
2914 return RHS.Index == Index;
2916 bool operator!=(const Self& RHS) const {
2917 assert(RHS.SI == SI && "Incompatible operators.");
2918 return RHS.Index != Index;
2925 typedef CaseIteratorT<const SwitchInst, const ConstantInt, const BasicBlock>
2928 class CaseIt : public CaseIteratorT<SwitchInst, ConstantInt, BasicBlock> {
2930 typedef CaseIteratorT<SwitchInst, ConstantInt, BasicBlock> ParentTy;
2933 CaseIt(const ParentTy &Src) : ParentTy(Src) {}
2934 CaseIt(SwitchInst *SI, unsigned CaseNum) : ParentTy(SI, CaseNum) {}
2936 /// Sets the new value for current case.
2937 void setValue(ConstantInt *V) {
2938 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2939 SI->setOperand(2 + Index*2, reinterpret_cast<Value*>(V));
2942 /// Sets the new successor for current case.
2943 void setSuccessor(BasicBlock *S) {
2944 SI->setSuccessor(getSuccessorIndex(), S);
2948 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2950 Instruction *InsertBefore = nullptr) {
2951 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2953 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2954 unsigned NumCases, BasicBlock *InsertAtEnd) {
2955 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2958 /// Provide fast operand accessors
2959 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2961 // Accessor Methods for Switch stmt
2962 Value *getCondition() const { return getOperand(0); }
2963 void setCondition(Value *V) { setOperand(0, V); }
2965 BasicBlock *getDefaultDest() const {
2966 return cast<BasicBlock>(getOperand(1));
2969 void setDefaultDest(BasicBlock *DefaultCase) {
2970 setOperand(1, reinterpret_cast<Value*>(DefaultCase));
2973 /// getNumCases - return the number of 'cases' in this switch instruction,
2974 /// except the default case
2975 unsigned getNumCases() const {
2976 return getNumOperands()/2 - 1;
2979 /// Returns a read/write iterator that points to the first
2980 /// case in SwitchInst.
2981 CaseIt case_begin() {
2982 return CaseIt(this, 0);
2984 /// Returns a read-only iterator that points to the first
2985 /// case in the SwitchInst.
2986 ConstCaseIt case_begin() const {
2987 return ConstCaseIt(this, 0);
2990 /// Returns a read/write iterator that points one past the last
2991 /// in the SwitchInst.
2993 return CaseIt(this, getNumCases());
2995 /// Returns a read-only iterator that points one past the last
2996 /// in the SwitchInst.
2997 ConstCaseIt case_end() const {
2998 return ConstCaseIt(this, getNumCases());
3001 /// cases - iteration adapter for range-for loops.
3002 iterator_range<CaseIt> cases() {
3003 return iterator_range<CaseIt>(case_begin(), case_end());
3006 /// cases - iteration adapter for range-for loops.
3007 iterator_range<ConstCaseIt> cases() const {
3008 return iterator_range<ConstCaseIt>(case_begin(), case_end());
3011 /// Returns an iterator that points to the default case.
3012 /// Note: this iterator allows to resolve successor only. Attempt
3013 /// to resolve case value causes an assertion.
3014 /// Also note, that increment and decrement also causes an assertion and
3015 /// makes iterator invalid.
3016 CaseIt case_default() {
3017 return CaseIt(this, DefaultPseudoIndex);
3019 ConstCaseIt case_default() const {
3020 return ConstCaseIt(this, DefaultPseudoIndex);
3023 /// findCaseValue - Search all of the case values for the specified constant.
3024 /// If it is explicitly handled, return the case iterator of it, otherwise
3025 /// return default case iterator to indicate
3026 /// that it is handled by the default handler.
3027 CaseIt findCaseValue(const ConstantInt *C) {
3028 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i)
3029 if (i.getCaseValue() == C)
3031 return case_default();
3033 ConstCaseIt findCaseValue(const ConstantInt *C) const {
3034 for (ConstCaseIt i = case_begin(), e = case_end(); i != e; ++i)
3035 if (i.getCaseValue() == C)
3037 return case_default();
3040 /// findCaseDest - Finds the unique case value for a given successor. Returns
3041 /// null if the successor is not found, not unique, or is the default case.
3042 ConstantInt *findCaseDest(BasicBlock *BB) {
3043 if (BB == getDefaultDest()) return nullptr;
3045 ConstantInt *CI = nullptr;
3046 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i) {
3047 if (i.getCaseSuccessor() == BB) {
3048 if (CI) return nullptr; // Multiple cases lead to BB.
3049 else CI = i.getCaseValue();
3055 /// addCase - Add an entry to the switch instruction...
3057 /// This action invalidates case_end(). Old case_end() iterator will
3058 /// point to the added case.
3059 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
3061 /// removeCase - This method removes the specified case and its successor
3062 /// from the switch instruction. Note that this operation may reorder the
3063 /// remaining cases at index idx and above.
3065 /// This action invalidates iterators for all cases following the one removed,
3066 /// including the case_end() iterator.
3067 void removeCase(CaseIt i);
3069 unsigned getNumSuccessors() const { return getNumOperands()/2; }
3070 BasicBlock *getSuccessor(unsigned idx) const {
3071 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
3072 return cast<BasicBlock>(getOperand(idx*2+1));
3074 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3075 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
3076 setOperand(idx * 2 + 1, NewSucc);
3079 // Methods for support type inquiry through isa, cast, and dyn_cast:
3080 static inline bool classof(const Instruction *I) {
3081 return I->getOpcode() == Instruction::Switch;
3083 static inline bool classof(const Value *V) {
3084 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3087 BasicBlock *getSuccessorV(unsigned idx) const override;
3088 unsigned getNumSuccessorsV() const override;
3089 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3093 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
3096 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
3099 //===----------------------------------------------------------------------===//
3100 // IndirectBrInst Class
3101 //===----------------------------------------------------------------------===//
3103 //===---------------------------------------------------------------------------
3104 /// IndirectBrInst - Indirect Branch Instruction.
3106 class IndirectBrInst : public TerminatorInst {
3107 void *operator new(size_t, unsigned) = delete;
3108 unsigned ReservedSpace;
3109 // Operand[0] = Value to switch on
3110 // Operand[1] = Default basic block destination
3111 // Operand[2n ] = Value to match
3112 // Operand[2n+1] = BasicBlock to go to on match
3113 IndirectBrInst(const IndirectBrInst &IBI);
3114 void init(Value *Address, unsigned NumDests);
3115 void growOperands();
3116 // allocate space for exactly zero operands
3117 void *operator new(size_t s) {
3118 return User::operator new(s);
3120 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
3121 /// Address to jump to. The number of expected destinations can be specified
3122 /// here to make memory allocation more efficient. This constructor can also
3123 /// autoinsert before another instruction.
3124 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
3126 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
3127 /// Address to jump to. The number of expected destinations can be specified
3128 /// here to make memory allocation more efficient. This constructor also
3129 /// autoinserts at the end of the specified BasicBlock.
3130 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
3132 // Note: Instruction needs to be a friend here to call cloneImpl.
3133 friend class Instruction;
3134 IndirectBrInst *cloneImpl() const;
3137 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3138 Instruction *InsertBefore = nullptr) {
3139 return new IndirectBrInst(Address, NumDests, InsertBefore);
3141 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3142 BasicBlock *InsertAtEnd) {
3143 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
3146 /// Provide fast operand accessors.
3147 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3149 // Accessor Methods for IndirectBrInst instruction.
3150 Value *getAddress() { return getOperand(0); }
3151 const Value *getAddress() const { return getOperand(0); }
3152 void setAddress(Value *V) { setOperand(0, V); }
3155 /// getNumDestinations - return the number of possible destinations in this
3156 /// indirectbr instruction.
3157 unsigned getNumDestinations() const { return getNumOperands()-1; }
3159 /// getDestination - Return the specified destination.
3160 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
3161 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
3163 /// addDestination - Add a destination.
3165 void addDestination(BasicBlock *Dest);
3167 /// removeDestination - This method removes the specified successor from the
3168 /// indirectbr instruction.
3169 void removeDestination(unsigned i);
3171 unsigned getNumSuccessors() const { return getNumOperands()-1; }
3172 BasicBlock *getSuccessor(unsigned i) const {
3173 return cast<BasicBlock>(getOperand(i+1));
3175 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
3176 setOperand(i + 1, NewSucc);
3179 // Methods for support type inquiry through isa, cast, and dyn_cast:
3180 static inline bool classof(const Instruction *I) {
3181 return I->getOpcode() == Instruction::IndirectBr;
3183 static inline bool classof(const Value *V) {
3184 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3187 BasicBlock *getSuccessorV(unsigned idx) const override;
3188 unsigned getNumSuccessorsV() const override;
3189 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3193 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
3196 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
3199 //===----------------------------------------------------------------------===//
3201 //===----------------------------------------------------------------------===//
3203 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
3204 /// calling convention of the call.
3206 class InvokeInst : public TerminatorInst {
3207 AttributeSet AttributeList;
3209 InvokeInst(const InvokeInst &BI);
3210 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3211 ArrayRef<Value *> Args, const Twine &NameStr) {
3212 init(cast<FunctionType>(
3213 cast<PointerType>(Func->getType())->getElementType()),
3214 Func, IfNormal, IfException, Args, NameStr);
3216 void init(FunctionType *FTy, Value *Func, BasicBlock *IfNormal,
3217 BasicBlock *IfException, ArrayRef<Value *> Args,
3218 const Twine &NameStr);
3220 /// Construct an InvokeInst given a range of arguments.
3222 /// \brief Construct an InvokeInst from a range of arguments
3223 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3224 ArrayRef<Value *> Args, unsigned Values,
3225 const Twine &NameStr, Instruction *InsertBefore)
3226 : InvokeInst(cast<FunctionType>(
3227 cast<PointerType>(Func->getType())->getElementType()),
3228 Func, IfNormal, IfException, Args, Values, NameStr,
3231 inline InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3232 BasicBlock *IfException, ArrayRef<Value *> Args,
3233 unsigned Values, const Twine &NameStr,
3234 Instruction *InsertBefore);
3235 /// Construct an InvokeInst given a range of arguments.
3237 /// \brief Construct an InvokeInst from a range of arguments
3238 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3239 ArrayRef<Value *> Args, unsigned Values,
3240 const Twine &NameStr, BasicBlock *InsertAtEnd);
3242 // Note: Instruction needs to be a friend here to call cloneImpl.
3243 friend class Instruction;
3244 InvokeInst *cloneImpl() const;
3247 static InvokeInst *Create(Value *Func,
3248 BasicBlock *IfNormal, BasicBlock *IfException,
3249 ArrayRef<Value *> Args, const Twine &NameStr = "",
3250 Instruction *InsertBefore = nullptr) {
3251 return Create(cast<FunctionType>(
3252 cast<PointerType>(Func->getType())->getElementType()),
3253 Func, IfNormal, IfException, Args, NameStr, InsertBefore);
3255 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3256 BasicBlock *IfException, ArrayRef<Value *> Args,
3257 const Twine &NameStr = "",
3258 Instruction *InsertBefore = nullptr) {
3259 unsigned Values = unsigned(Args.size()) + 3;
3260 return new (Values) InvokeInst(Ty, Func, IfNormal, IfException, Args,
3261 Values, NameStr, InsertBefore);
3263 static InvokeInst *Create(Value *Func,
3264 BasicBlock *IfNormal, BasicBlock *IfException,
3265 ArrayRef<Value *> Args, const Twine &NameStr,
3266 BasicBlock *InsertAtEnd) {
3267 unsigned Values = unsigned(Args.size()) + 3;
3268 return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3269 Values, NameStr, InsertAtEnd);
3272 /// Provide fast operand accessors
3273 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3275 FunctionType *getFunctionType() const { return FTy; }
3277 void mutateFunctionType(FunctionType *FTy) {
3278 mutateType(FTy->getReturnType());
3282 /// getNumArgOperands - Return the number of invoke arguments.
3284 unsigned getNumArgOperands() const { return getNumOperands() - 3; }
3286 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
3288 Value *getArgOperand(unsigned i) const {
3289 assert(i < getNumArgOperands() && "Out of bounds!");
3290 return getOperand(i);
3292 void setArgOperand(unsigned i, Value *v) {
3293 assert(i < getNumArgOperands() && "Out of bounds!");
3297 /// arg_operands - iteration adapter for range-for loops.
3298 iterator_range<op_iterator> arg_operands() {
3299 return iterator_range<op_iterator>(op_begin(), op_end() - 3);
3302 /// arg_operands - iteration adapter for range-for loops.
3303 iterator_range<const_op_iterator> arg_operands() const {
3304 return iterator_range<const_op_iterator>(op_begin(), op_end() - 3);
3307 /// \brief Wrappers for getting the \c Use of a invoke argument.
3308 const Use &getArgOperandUse(unsigned i) const {
3309 assert(i < getNumArgOperands() && "Out of bounds!");
3310 return getOperandUse(i);
3312 Use &getArgOperandUse(unsigned i) {
3313 assert(i < getNumArgOperands() && "Out of bounds!");
3314 return getOperandUse(i);
3317 /// getCallingConv/setCallingConv - Get or set the calling convention of this
3319 CallingConv::ID getCallingConv() const {
3320 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
3322 void setCallingConv(CallingConv::ID CC) {
3323 setInstructionSubclassData(static_cast<unsigned>(CC));
3326 /// getAttributes - Return the parameter attributes for this invoke.
3328 const AttributeSet &getAttributes() const { return AttributeList; }
3330 /// setAttributes - Set the parameter attributes for this invoke.
3332 void setAttributes(const AttributeSet &Attrs) { AttributeList = Attrs; }
3334 /// addAttribute - adds the attribute to the list of attributes.
3335 void addAttribute(unsigned i, Attribute::AttrKind attr);
3337 /// removeAttribute - removes the attribute from the list of attributes.
3338 void removeAttribute(unsigned i, Attribute attr);
3340 /// \brief adds the dereferenceable attribute to the list of attributes.
3341 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
3343 /// \brief adds the dereferenceable_or_null attribute to the list of
3345 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
3347 /// \brief Determine whether this call has the given attribute.
3348 bool hasFnAttr(Attribute::AttrKind A) const {
3349 assert(A != Attribute::NoBuiltin &&
3350 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
3351 return hasFnAttrImpl(A);
3354 /// \brief Determine whether the call or the callee has the given attributes.
3355 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const;
3357 /// \brief Extract the alignment for a call or parameter (0=unknown).
3358 unsigned getParamAlignment(unsigned i) const {
3359 return AttributeList.getParamAlignment(i);
3362 /// \brief Extract the number of dereferenceable bytes for a call or
3363 /// parameter (0=unknown).
3364 uint64_t getDereferenceableBytes(unsigned i) const {
3365 return AttributeList.getDereferenceableBytes(i);
3368 /// \brief Extract the number of dereferenceable_or_null bytes for a call or
3369 /// parameter (0=unknown).
3370 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
3371 return AttributeList.getDereferenceableOrNullBytes(i);
3374 /// \brief Return true if the call should not be treated as a call to a
3376 bool isNoBuiltin() const {
3377 // We assert in hasFnAttr if one passes in Attribute::NoBuiltin, so we have
3378 // to check it by hand.
3379 return hasFnAttrImpl(Attribute::NoBuiltin) &&
3380 !hasFnAttrImpl(Attribute::Builtin);
3383 /// \brief Return true if the call should not be inlined.
3384 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
3385 void setIsNoInline() {
3386 addAttribute(AttributeSet::FunctionIndex, Attribute::NoInline);
3389 /// \brief Determine if the call does not access memory.
3390 bool doesNotAccessMemory() const {
3391 return hasFnAttr(Attribute::ReadNone);
3393 void setDoesNotAccessMemory() {
3394 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
3397 /// \brief Determine if the call does not access or only reads memory.
3398 bool onlyReadsMemory() const {
3399 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
3401 void setOnlyReadsMemory() {
3402 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
3405 /// @brief Determine if the call access memmory only using it's pointer
3407 bool onlyAccessesArgMemory() const {
3408 return hasFnAttr(Attribute::ArgMemOnly);
3410 void setOnlyAccessesArgMemory() {
3411 addAttribute(AttributeSet::FunctionIndex, Attribute::ArgMemOnly);
3414 /// \brief Determine if the call cannot return.
3415 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
3416 void setDoesNotReturn() {
3417 addAttribute(AttributeSet::FunctionIndex, Attribute::NoReturn);
3420 /// \brief Determine if the call cannot unwind.
3421 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
3422 void setDoesNotThrow() {
3423 addAttribute(AttributeSet::FunctionIndex, Attribute::NoUnwind);
3426 /// \brief Determine if the invoke cannot be duplicated.
3427 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
3428 void setCannotDuplicate() {
3429 addAttribute(AttributeSet::FunctionIndex, Attribute::NoDuplicate);
3432 /// \brief Determine if the call returns a structure through first
3433 /// pointer argument.
3434 bool hasStructRetAttr() const {
3435 // Be friendly and also check the callee.
3436 return paramHasAttr(1, Attribute::StructRet);
3439 /// \brief Determine if any call argument is an aggregate passed by value.
3440 bool hasByValArgument() const {
3441 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
3444 /// getCalledFunction - Return the function called, or null if this is an
3445 /// indirect function invocation.
3447 Function *getCalledFunction() const {
3448 return dyn_cast<Function>(Op<-3>());
3451 /// getCalledValue - Get a pointer to the function that is invoked by this
3453 const Value *getCalledValue() const { return Op<-3>(); }
3454 Value *getCalledValue() { return Op<-3>(); }
3456 /// setCalledFunction - Set the function called.
3457 void setCalledFunction(Value* Fn) {
3459 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
3462 void setCalledFunction(FunctionType *FTy, Value *Fn) {
3464 assert(FTy == cast<FunctionType>(
3465 cast<PointerType>(Fn->getType())->getElementType()));
3469 // get*Dest - Return the destination basic blocks...
3470 BasicBlock *getNormalDest() const {
3471 return cast<BasicBlock>(Op<-2>());
3473 BasicBlock *getUnwindDest() const {
3474 return cast<BasicBlock>(Op<-1>());
3476 void setNormalDest(BasicBlock *B) {
3477 Op<-2>() = reinterpret_cast<Value*>(B);
3479 void setUnwindDest(BasicBlock *B) {
3480 Op<-1>() = reinterpret_cast<Value*>(B);
3483 /// getLandingPadInst - Get the landingpad instruction from the landing pad
3484 /// block (the unwind destination).
3485 LandingPadInst *getLandingPadInst() const;
3487 BasicBlock *getSuccessor(unsigned i) const {
3488 assert(i < 2 && "Successor # out of range for invoke!");
3489 return i == 0 ? getNormalDest() : getUnwindDest();
3492 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3493 assert(idx < 2 && "Successor # out of range for invoke!");
3494 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
3497 unsigned getNumSuccessors() const { return 2; }
3499 // Methods for support type inquiry through isa, cast, and dyn_cast:
3500 static inline bool classof(const Instruction *I) {
3501 return (I->getOpcode() == Instruction::Invoke);
3503 static inline bool classof(const Value *V) {
3504 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3508 BasicBlock *getSuccessorV(unsigned idx) const override;
3509 unsigned getNumSuccessorsV() const override;
3510 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3512 bool hasFnAttrImpl(Attribute::AttrKind A) const;
3514 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3515 // method so that subclasses cannot accidentally use it.
3516 void setInstructionSubclassData(unsigned short D) {
3517 Instruction::setInstructionSubclassData(D);
3522 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
3525 InvokeInst::InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3526 BasicBlock *IfException, ArrayRef<Value *> Args,
3527 unsigned Values, const Twine &NameStr,
3528 Instruction *InsertBefore)
3529 : TerminatorInst(Ty->getReturnType(), Instruction::Invoke,
3530 OperandTraits<InvokeInst>::op_end(this) - Values, Values,
3532 init(Ty, Func, IfNormal, IfException, Args, NameStr);
3534 InvokeInst::InvokeInst(Value *Func,
3535 BasicBlock *IfNormal, BasicBlock *IfException,
3536 ArrayRef<Value *> Args, unsigned Values,
3537 const Twine &NameStr, BasicBlock *InsertAtEnd)
3538 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3539 ->getElementType())->getReturnType(),
3540 Instruction::Invoke,
3541 OperandTraits<InvokeInst>::op_end(this) - Values,
3542 Values, InsertAtEnd) {
3543 init(Func, IfNormal, IfException, Args, NameStr);
3546 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
3548 //===----------------------------------------------------------------------===//
3550 //===----------------------------------------------------------------------===//
3552 //===---------------------------------------------------------------------------
3553 /// ResumeInst - Resume the propagation of an exception.
3555 class ResumeInst : public TerminatorInst {
3556 ResumeInst(const ResumeInst &RI);
3558 explicit ResumeInst(Value *Exn, Instruction *InsertBefore=nullptr);
3559 ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
3561 // Note: Instruction needs to be a friend here to call cloneImpl.
3562 friend class Instruction;
3563 ResumeInst *cloneImpl() const;
3566 static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = nullptr) {
3567 return new(1) ResumeInst(Exn, InsertBefore);
3569 static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
3570 return new(1) ResumeInst(Exn, InsertAtEnd);
3573 /// Provide fast operand accessors
3574 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3576 /// Convenience accessor.
3577 Value *getValue() const { return Op<0>(); }
3579 unsigned getNumSuccessors() const { return 0; }
3581 // Methods for support type inquiry through isa, cast, and dyn_cast:
3582 static inline bool classof(const Instruction *I) {
3583 return I->getOpcode() == Instruction::Resume;
3585 static inline bool classof(const Value *V) {
3586 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3589 BasicBlock *getSuccessorV(unsigned idx) const override;
3590 unsigned getNumSuccessorsV() const override;
3591 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3595 struct OperandTraits<ResumeInst> :
3596 public FixedNumOperandTraits<ResumeInst, 1> {
3599 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
3601 //===----------------------------------------------------------------------===//
3602 // CatchEndPadInst Class
3603 //===----------------------------------------------------------------------===//
3605 class CatchEndPadInst : public TerminatorInst {
3607 CatchEndPadInst(const CatchEndPadInst &RI);
3609 void init(BasicBlock *UnwindBB);
3610 CatchEndPadInst(LLVMContext &C, BasicBlock *UnwindBB, unsigned Values,
3611 Instruction *InsertBefore = nullptr);
3612 CatchEndPadInst(LLVMContext &C, BasicBlock *UnwindBB, unsigned Values,
3613 BasicBlock *InsertAtEnd);
3616 // Note: Instruction needs to be a friend here to call cloneImpl.
3617 friend class Instruction;
3618 CatchEndPadInst *cloneImpl() const;
3621 static CatchEndPadInst *Create(LLVMContext &C, BasicBlock *UnwindBB = nullptr,
3622 Instruction *InsertBefore = nullptr) {
3623 unsigned Values = UnwindBB ? 1 : 0;
3624 return new (Values) CatchEndPadInst(C, UnwindBB, Values, InsertBefore);
3626 static CatchEndPadInst *Create(LLVMContext &C, BasicBlock *UnwindBB,
3627 BasicBlock *InsertAtEnd) {
3628 unsigned Values = UnwindBB ? 1 : 0;
3629 return new (Values) CatchEndPadInst(C, UnwindBB, Values, InsertAtEnd);
3632 /// Provide fast operand accessors
3633 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3635 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
3636 bool unwindsToCaller() const { return !hasUnwindDest(); }
3638 /// Convenience accessor. Returns null if there is no return value.
3639 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
3641 BasicBlock *getUnwindDest() const {
3642 return hasUnwindDest() ? cast<BasicBlock>(Op<-1>()) : nullptr;
3644 void setUnwindDest(BasicBlock *NewDest) {
3649 // Methods for support type inquiry through isa, cast, and dyn_cast:
3650 static inline bool classof(const Instruction *I) {
3651 return (I->getOpcode() == Instruction::CatchEndPad);
3653 static inline bool classof(const Value *V) {
3654 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3658 BasicBlock *getSuccessorV(unsigned Idx) const override;
3659 unsigned getNumSuccessorsV() const override;
3660 void setSuccessorV(unsigned Idx, BasicBlock *B) override;
3662 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3663 // method so that subclasses cannot accidentally use it.
3664 void setInstructionSubclassData(unsigned short D) {
3665 Instruction::setInstructionSubclassData(D);
3670 struct OperandTraits<CatchEndPadInst>
3671 : public VariadicOperandTraits<CatchEndPadInst> {};
3673 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchEndPadInst, Value)
3675 //===----------------------------------------------------------------------===//
3676 // CatchPadInst Class
3677 //===----------------------------------------------------------------------===//
3679 class CatchPadInst : public TerminatorInst {
3681 void init(BasicBlock *IfNormal, BasicBlock *IfException,
3682 ArrayRef<Value *> Args, const Twine &NameStr);
3684 CatchPadInst(const CatchPadInst &CPI);
3686 explicit CatchPadInst(BasicBlock *IfNormal, BasicBlock *IfException,
3687 ArrayRef<Value *> Args, unsigned Values,
3688 const Twine &NameStr, Instruction *InsertBefore);
3689 explicit CatchPadInst(BasicBlock *IfNormal, BasicBlock *IfException,
3690 ArrayRef<Value *> Args, unsigned Values,
3691 const Twine &NameStr, BasicBlock *InsertAtEnd);
3694 // Note: Instruction needs to be a friend here to call cloneImpl.
3695 friend class Instruction;
3696 CatchPadInst *cloneImpl() const;
3699 static CatchPadInst *Create(BasicBlock *IfNormal, BasicBlock *IfException,
3700 ArrayRef<Value *> Args, const Twine &NameStr = "",
3701 Instruction *InsertBefore = nullptr) {
3702 unsigned Values = unsigned(Args.size()) + 2;
3703 return new (Values) CatchPadInst(IfNormal, IfException, Args, Values,
3704 NameStr, InsertBefore);
3706 static CatchPadInst *Create(BasicBlock *IfNormal, BasicBlock *IfException,
3707 ArrayRef<Value *> Args, const Twine &NameStr,
3708 BasicBlock *InsertAtEnd) {
3709 unsigned Values = unsigned(Args.size()) + 2;
3711 CatchPadInst(IfNormal, IfException, Args, Values, NameStr, InsertAtEnd);
3714 /// Provide fast operand accessors
3715 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3717 /// getNumArgOperands - Return the number of catchpad arguments.
3719 unsigned getNumArgOperands() const { return getNumOperands() - 2; }
3721 /// getArgOperand/setArgOperand - Return/set the i-th catchpad argument.
3723 Value *getArgOperand(unsigned i) const { return getOperand(i); }
3724 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
3726 /// arg_operands - iteration adapter for range-for loops.
3727 iterator_range<op_iterator> arg_operands() {
3728 return iterator_range<op_iterator>(op_begin(), op_end() - 2);
3731 /// arg_operands - iteration adapter for range-for loops.
3732 iterator_range<const_op_iterator> arg_operands() const {
3733 return iterator_range<const_op_iterator>(op_begin(), op_end() - 2);
3736 /// \brief Wrappers for getting the \c Use of a catchpad argument.
3737 const Use &getArgOperandUse(unsigned i) const { return getOperandUse(i); }
3738 Use &getArgOperandUse(unsigned i) { return getOperandUse(i); }
3740 // get*Dest - Return the destination basic blocks...
3741 BasicBlock *getNormalDest() const { return cast<BasicBlock>(Op<-2>()); }
3742 BasicBlock *getUnwindDest() const { return cast<BasicBlock>(Op<-1>()); }
3743 void setNormalDest(BasicBlock *B) { Op<-2>() = B; }
3744 void setUnwindDest(BasicBlock *B) { Op<-1>() = B; }
3746 BasicBlock *getSuccessor(unsigned i) const {
3747 assert(i < 2 && "Successor # out of range for catchpad!");
3748 return i == 0 ? getNormalDest() : getUnwindDest();
3751 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3752 assert(idx < 2 && "Successor # out of range for catchpad!");
3753 *(&Op<-2>() + idx) = NewSucc;
3756 unsigned getNumSuccessors() const { return 2; }
3758 // Methods for support type inquiry through isa, cast, and dyn_cast:
3759 static inline bool classof(const Instruction *I) {
3760 return I->getOpcode() == Instruction::CatchPad;
3762 static inline bool classof(const Value *V) {
3763 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3767 BasicBlock *getSuccessorV(unsigned idx) const override;
3768 unsigned getNumSuccessorsV() const override;
3769 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3773 struct OperandTraits<CatchPadInst>
3774 : public VariadicOperandTraits<CatchPadInst, /*MINARITY=*/2> {};
3776 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchPadInst, Value)
3778 //===----------------------------------------------------------------------===//
3779 // TerminatePadInst Class
3780 //===----------------------------------------------------------------------===//
3782 class TerminatePadInst : public TerminatorInst {
3784 void init(BasicBlock *BB, ArrayRef<Value *> Args);
3786 TerminatePadInst(const TerminatePadInst &TPI);
3788 explicit TerminatePadInst(LLVMContext &C, BasicBlock *BB,
3789 ArrayRef<Value *> Args, unsigned Values,
3790 Instruction *InsertBefore);
3791 explicit TerminatePadInst(LLVMContext &C, BasicBlock *BB,
3792 ArrayRef<Value *> Args, unsigned Values,
3793 BasicBlock *InsertAtEnd);
3796 // Note: Instruction needs to be a friend here to call cloneImpl.
3797 friend class Instruction;
3798 TerminatePadInst *cloneImpl() const;
3801 static TerminatePadInst *Create(LLVMContext &C, BasicBlock *BB = nullptr,
3802 ArrayRef<Value *> Args = None,
3803 Instruction *InsertBefore = nullptr) {
3804 unsigned Values = unsigned(Args.size());
3807 return new (Values) TerminatePadInst(C, BB, Args, Values, InsertBefore);
3809 static TerminatePadInst *Create(LLVMContext &C, BasicBlock *BB,
3810 ArrayRef<Value *> Args,
3811 BasicBlock *InsertAtEnd) {
3812 unsigned Values = unsigned(Args.size());
3815 return new (Values) TerminatePadInst(C, BB, Args, Values, InsertAtEnd);
3818 /// Provide fast operand accessors
3819 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3821 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
3822 bool unwindsToCaller() const { return !hasUnwindDest(); }
3824 /// getNumArgOperands - Return the number of terminatepad arguments.
3826 unsigned getNumArgOperands() const {
3827 unsigned NumOperands = getNumOperands();
3828 if (hasUnwindDest())
3829 return NumOperands - 1;
3833 /// getArgOperand/setArgOperand - Return/set the i-th terminatepad argument.
3835 Value *getArgOperand(unsigned i) const { return getOperand(i); }
3836 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
3838 const_op_iterator arg_end() const {
3839 if (hasUnwindDest())
3840 return op_end() - 1;
3844 op_iterator arg_end() {
3845 if (hasUnwindDest())
3846 return op_end() - 1;
3850 /// arg_operands - iteration adapter for range-for loops.
3851 iterator_range<op_iterator> arg_operands() {
3852 return iterator_range<op_iterator>(op_begin(), arg_end());
3855 /// arg_operands - iteration adapter for range-for loops.
3856 iterator_range<const_op_iterator> arg_operands() const {
3857 return iterator_range<const_op_iterator>(op_begin(), arg_end());
3860 /// \brief Wrappers for getting the \c Use of a terminatepad argument.
3861 const Use &getArgOperandUse(unsigned i) const { return getOperandUse(i); }
3862 Use &getArgOperandUse(unsigned i) { return getOperandUse(i); }
3864 // get*Dest - Return the destination basic blocks...
3865 BasicBlock *getUnwindDest() const {
3866 if (!hasUnwindDest())
3868 return cast<BasicBlock>(Op<-1>());
3870 void setUnwindDest(BasicBlock *B) {
3871 assert(B && hasUnwindDest());
3875 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
3877 // Methods for support type inquiry through isa, cast, and dyn_cast:
3878 static inline bool classof(const Instruction *I) {
3879 return I->getOpcode() == Instruction::TerminatePad;
3881 static inline bool classof(const Value *V) {
3882 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3886 BasicBlock *getSuccessorV(unsigned idx) const override;
3887 unsigned getNumSuccessorsV() const override;
3888 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3890 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3891 // method so that subclasses cannot accidentally use it.
3892 void setInstructionSubclassData(unsigned short D) {
3893 Instruction::setInstructionSubclassData(D);
3898 struct OperandTraits<TerminatePadInst>
3899 : public VariadicOperandTraits<TerminatePadInst, /*MINARITY=*/1> {};
3901 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(TerminatePadInst, Value)
3903 //===----------------------------------------------------------------------===//
3904 // CleanupPadInst Class
3905 //===----------------------------------------------------------------------===//
3907 class CleanupPadInst : public Instruction {
3909 void init(ArrayRef<Value *> Args, const Twine &NameStr);
3911 CleanupPadInst(const CleanupPadInst &CPI);
3913 explicit CleanupPadInst(LLVMContext &C, ArrayRef<Value *> Args,
3914 const Twine &NameStr, Instruction *InsertBefore);
3915 explicit CleanupPadInst(LLVMContext &C, ArrayRef<Value *> Args,
3916 const Twine &NameStr, BasicBlock *InsertAtEnd);
3919 // Note: Instruction needs to be a friend here to call cloneImpl.
3920 friend class Instruction;
3921 CleanupPadInst *cloneImpl() const;
3924 static CleanupPadInst *Create(LLVMContext &C, ArrayRef<Value *> Args,
3925 const Twine &NameStr = "",
3926 Instruction *InsertBefore = nullptr) {
3927 return new (Args.size()) CleanupPadInst(C, Args, NameStr, InsertBefore);
3929 static CleanupPadInst *Create(LLVMContext &C, ArrayRef<Value *> Args,
3930 const Twine &NameStr, BasicBlock *InsertAtEnd) {
3931 return new (Args.size()) CleanupPadInst(C, Args, NameStr, InsertAtEnd);
3934 /// Provide fast operand accessors
3935 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3937 // Methods for support type inquiry through isa, cast, and dyn_cast:
3938 static inline bool classof(const Instruction *I) {
3939 return I->getOpcode() == Instruction::CleanupPad;
3941 static inline bool classof(const Value *V) {
3942 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3947 struct OperandTraits<CleanupPadInst>
3948 : public VariadicOperandTraits<CleanupPadInst, /*MINARITY=*/0> {};
3950 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CleanupPadInst, Value)
3952 //===----------------------------------------------------------------------===//
3953 // CatchReturnInst Class
3954 //===----------------------------------------------------------------------===//
3956 class CatchReturnInst : public TerminatorInst {
3957 CatchReturnInst(const CatchReturnInst &RI);
3959 void init(CatchPadInst *CatchPad, BasicBlock *BB);
3960 CatchReturnInst(CatchPadInst *CatchPad, BasicBlock *BB,
3961 Instruction *InsertBefore);
3962 CatchReturnInst(CatchPadInst *CatchPad, BasicBlock *BB,
3963 BasicBlock *InsertAtEnd);
3966 // Note: Instruction needs to be a friend here to call cloneImpl.
3967 friend class Instruction;
3968 CatchReturnInst *cloneImpl() const;
3971 static CatchReturnInst *Create(CatchPadInst *CatchPad, BasicBlock *BB,
3972 Instruction *InsertBefore = nullptr) {
3975 return new (2) CatchReturnInst(CatchPad, BB, InsertBefore);
3977 static CatchReturnInst *Create(CatchPadInst *CatchPad, BasicBlock *BB,
3978 BasicBlock *InsertAtEnd) {
3981 return new (2) CatchReturnInst(CatchPad, BB, InsertAtEnd);
3984 /// Provide fast operand accessors
3985 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3987 /// Convenience accessors.
3988 CatchPadInst *getCatchPad() const { return cast<CatchPadInst>(Op<0>()); }
3989 void setCatchPad(CatchPadInst *CatchPad) {
3994 BasicBlock *getSuccessor() const { return cast<BasicBlock>(Op<1>()); }
3995 void setSuccessor(BasicBlock *NewSucc) {
3999 unsigned getNumSuccessors() const { return 1; }
4001 // Methods for support type inquiry through isa, cast, and dyn_cast:
4002 static inline bool classof(const Instruction *I) {
4003 return (I->getOpcode() == Instruction::CatchRet);
4005 static inline bool classof(const Value *V) {
4006 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4010 BasicBlock *getSuccessorV(unsigned Idx) const override;
4011 unsigned getNumSuccessorsV() const override;
4012 void setSuccessorV(unsigned Idx, BasicBlock *B) override;
4016 struct OperandTraits<CatchReturnInst>
4017 : public FixedNumOperandTraits<CatchReturnInst, 2> {};
4019 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchReturnInst, Value)
4021 //===----------------------------------------------------------------------===//
4022 // CleanupEndPadInst Class
4023 //===----------------------------------------------------------------------===//
4025 class CleanupEndPadInst : public TerminatorInst {
4027 CleanupEndPadInst(const CleanupEndPadInst &CEPI);
4029 void init(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB);
4030 CleanupEndPadInst(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB,
4031 unsigned Values, Instruction *InsertBefore = nullptr);
4032 CleanupEndPadInst(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB,
4033 unsigned Values, BasicBlock *InsertAtEnd);
4036 // Note: Instruction needs to be a friend here to call cloneImpl.
4037 friend class Instruction;
4038 CleanupEndPadInst *cloneImpl() const;
4041 static CleanupEndPadInst *Create(CleanupPadInst *CleanupPad,
4042 BasicBlock *UnwindBB = nullptr,
4043 Instruction *InsertBefore = nullptr) {
4044 unsigned Values = UnwindBB ? 2 : 1;
4046 CleanupEndPadInst(CleanupPad, UnwindBB, Values, InsertBefore);
4048 static CleanupEndPadInst *Create(CleanupPadInst *CleanupPad,
4049 BasicBlock *UnwindBB,
4050 BasicBlock *InsertAtEnd) {
4051 unsigned Values = UnwindBB ? 2 : 1;
4053 CleanupEndPadInst(CleanupPad, UnwindBB, Values, InsertAtEnd);
4056 /// Provide fast operand accessors
4057 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4059 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
4060 bool unwindsToCaller() const { return !hasUnwindDest(); }
4062 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
4064 /// Convenience accessors
4065 CleanupPadInst *getCleanupPad() const {
4066 return cast<CleanupPadInst>(Op<-1>());
4068 void setCleanupPad(CleanupPadInst *CleanupPad) {
4070 Op<-1>() = CleanupPad;
4073 BasicBlock *getUnwindDest() const {
4074 return hasUnwindDest() ? cast<BasicBlock>(Op<-2>()) : nullptr;
4076 void setUnwindDest(BasicBlock *NewDest) {
4077 assert(hasUnwindDest());
4082 // Methods for support type inquiry through isa, cast, and dyn_cast:
4083 static inline bool classof(const Instruction *I) {
4084 return (I->getOpcode() == Instruction::CleanupEndPad);
4086 static inline bool classof(const Value *V) {
4087 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4091 BasicBlock *getSuccessorV(unsigned Idx) const override;
4092 unsigned getNumSuccessorsV() const override;
4093 void setSuccessorV(unsigned Idx, BasicBlock *B) override;
4095 // Shadow Instruction::setInstructionSubclassData with a private forwarding
4096 // method so that subclasses cannot accidentally use it.
4097 void setInstructionSubclassData(unsigned short D) {
4098 Instruction::setInstructionSubclassData(D);
4103 struct OperandTraits<CleanupEndPadInst>
4104 : public VariadicOperandTraits<CleanupEndPadInst, /*MINARITY=*/1> {};
4106 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CleanupEndPadInst, Value)
4108 //===----------------------------------------------------------------------===//
4109 // CleanupReturnInst Class
4110 //===----------------------------------------------------------------------===//
4112 class CleanupReturnInst : public TerminatorInst {
4114 CleanupReturnInst(const CleanupReturnInst &RI);
4116 void init(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB);
4117 CleanupReturnInst(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB,
4118 unsigned Values, Instruction *InsertBefore = nullptr);
4119 CleanupReturnInst(CleanupPadInst *CleanupPad, BasicBlock *UnwindBB,
4120 unsigned Values, BasicBlock *InsertAtEnd);
4123 // Note: Instruction needs to be a friend here to call cloneImpl.
4124 friend class Instruction;
4125 CleanupReturnInst *cloneImpl() const;
4128 static CleanupReturnInst *Create(CleanupPadInst *CleanupPad,
4129 BasicBlock *UnwindBB = nullptr,
4130 Instruction *InsertBefore = nullptr) {
4132 unsigned Values = 1;
4136 CleanupReturnInst(CleanupPad, UnwindBB, Values, InsertBefore);
4138 static CleanupReturnInst *Create(CleanupPadInst *CleanupPad,
4139 BasicBlock *UnwindBB,
4140 BasicBlock *InsertAtEnd) {
4142 unsigned Values = 1;
4146 CleanupReturnInst(CleanupPad, UnwindBB, Values, InsertAtEnd);
4149 /// Provide fast operand accessors
4150 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4152 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
4153 bool unwindsToCaller() const { return !hasUnwindDest(); }
4155 /// Convenience accessor.
4156 CleanupPadInst *getCleanupPad() const {
4157 return cast<CleanupPadInst>(Op<-1>());
4159 void setCleanupPad(CleanupPadInst *CleanupPad) {
4161 Op<-1>() = CleanupPad;
4164 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
4166 BasicBlock *getUnwindDest() const {
4167 return hasUnwindDest() ? cast<BasicBlock>(Op<-2>()) : nullptr;
4169 void setUnwindDest(BasicBlock *NewDest) {
4171 assert(hasUnwindDest());
4175 // Methods for support type inquiry through isa, cast, and dyn_cast:
4176 static inline bool classof(const Instruction *I) {
4177 return (I->getOpcode() == Instruction::CleanupRet);
4179 static inline bool classof(const Value *V) {
4180 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4184 BasicBlock *getSuccessorV(unsigned Idx) const override;
4185 unsigned getNumSuccessorsV() const override;
4186 void setSuccessorV(unsigned Idx, BasicBlock *B) override;
4188 // Shadow Instruction::setInstructionSubclassData with a private forwarding
4189 // method so that subclasses cannot accidentally use it.
4190 void setInstructionSubclassData(unsigned short D) {
4191 Instruction::setInstructionSubclassData(D);
4196 struct OperandTraits<CleanupReturnInst>
4197 : public VariadicOperandTraits<CleanupReturnInst, /*MINARITY=*/1> {};
4199 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CleanupReturnInst, Value)
4201 //===----------------------------------------------------------------------===//
4202 // UnreachableInst Class
4203 //===----------------------------------------------------------------------===//
4205 //===---------------------------------------------------------------------------
4206 /// UnreachableInst - This function has undefined behavior. In particular, the
4207 /// presence of this instruction indicates some higher level knowledge that the
4208 /// end of the block cannot be reached.
4210 class UnreachableInst : public TerminatorInst {
4211 void *operator new(size_t, unsigned) = delete;
4213 // Note: Instruction needs to be a friend here to call cloneImpl.
4214 friend class Instruction;
4215 UnreachableInst *cloneImpl() const;
4218 // allocate space for exactly zero operands
4219 void *operator new(size_t s) {
4220 return User::operator new(s, 0);
4222 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = nullptr);
4223 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
4225 unsigned getNumSuccessors() const { return 0; }
4227 // Methods for support type inquiry through isa, cast, and dyn_cast:
4228 static inline bool classof(const Instruction *I) {
4229 return I->getOpcode() == Instruction::Unreachable;
4231 static inline bool classof(const Value *V) {
4232 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4235 BasicBlock *getSuccessorV(unsigned idx) const override;
4236 unsigned getNumSuccessorsV() const override;
4237 void setSuccessorV(unsigned idx, BasicBlock *B) override;
4240 //===----------------------------------------------------------------------===//
4242 //===----------------------------------------------------------------------===//
4244 /// \brief This class represents a truncation of integer types.
4245 class TruncInst : public CastInst {
4247 // Note: Instruction needs to be a friend here to call cloneImpl.
4248 friend class Instruction;
4249 /// \brief Clone an identical TruncInst
4250 TruncInst *cloneImpl() const;
4253 /// \brief Constructor with insert-before-instruction semantics
4255 Value *S, ///< The value to be truncated
4256 Type *Ty, ///< The (smaller) type to truncate to
4257 const Twine &NameStr = "", ///< A name for the new instruction
4258 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4261 /// \brief Constructor with insert-at-end-of-block semantics
4263 Value *S, ///< The value to be truncated
4264 Type *Ty, ///< The (smaller) type to truncate to
4265 const Twine &NameStr, ///< A name for the new instruction
4266 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4269 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4270 static inline bool classof(const Instruction *I) {
4271 return I->getOpcode() == Trunc;
4273 static inline bool classof(const Value *V) {
4274 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4278 //===----------------------------------------------------------------------===//
4280 //===----------------------------------------------------------------------===//
4282 /// \brief This class represents zero extension of integer types.
4283 class ZExtInst : public CastInst {
4285 // Note: Instruction needs to be a friend here to call cloneImpl.
4286 friend class Instruction;
4287 /// \brief Clone an identical ZExtInst
4288 ZExtInst *cloneImpl() const;
4291 /// \brief Constructor with insert-before-instruction semantics
4293 Value *S, ///< The value to be zero extended
4294 Type *Ty, ///< The type to zero extend to
4295 const Twine &NameStr = "", ///< A name for the new instruction
4296 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4299 /// \brief Constructor with insert-at-end semantics.
4301 Value *S, ///< The value to be zero extended
4302 Type *Ty, ///< The type to zero extend to
4303 const Twine &NameStr, ///< A name for the new instruction
4304 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4307 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4308 static inline bool classof(const Instruction *I) {
4309 return I->getOpcode() == ZExt;
4311 static inline bool classof(const Value *V) {
4312 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4316 //===----------------------------------------------------------------------===//
4318 //===----------------------------------------------------------------------===//
4320 /// \brief This class represents a sign extension of integer types.
4321 class SExtInst : public CastInst {
4323 // Note: Instruction needs to be a friend here to call cloneImpl.
4324 friend class Instruction;
4325 /// \brief Clone an identical SExtInst
4326 SExtInst *cloneImpl() const;
4329 /// \brief Constructor with insert-before-instruction semantics
4331 Value *S, ///< The value to be sign extended
4332 Type *Ty, ///< The type to sign extend to
4333 const Twine &NameStr = "", ///< A name for the new instruction
4334 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4337 /// \brief Constructor with insert-at-end-of-block semantics
4339 Value *S, ///< The value to be sign extended
4340 Type *Ty, ///< The type to sign extend to
4341 const Twine &NameStr, ///< A name for the new instruction
4342 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4345 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4346 static inline bool classof(const Instruction *I) {
4347 return I->getOpcode() == SExt;
4349 static inline bool classof(const Value *V) {
4350 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4354 //===----------------------------------------------------------------------===//
4355 // FPTruncInst Class
4356 //===----------------------------------------------------------------------===//
4358 /// \brief This class represents a truncation of floating point types.
4359 class FPTruncInst : public CastInst {
4361 // Note: Instruction needs to be a friend here to call cloneImpl.
4362 friend class Instruction;
4363 /// \brief Clone an identical FPTruncInst
4364 FPTruncInst *cloneImpl() const;
4367 /// \brief Constructor with insert-before-instruction semantics
4369 Value *S, ///< The value to be truncated
4370 Type *Ty, ///< The type to truncate to
4371 const Twine &NameStr = "", ///< A name for the new instruction
4372 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4375 /// \brief Constructor with insert-before-instruction semantics
4377 Value *S, ///< The value to be truncated
4378 Type *Ty, ///< The type to truncate to
4379 const Twine &NameStr, ///< A name for the new instruction
4380 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4383 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4384 static inline bool classof(const Instruction *I) {
4385 return I->getOpcode() == FPTrunc;
4387 static inline bool classof(const Value *V) {
4388 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4392 //===----------------------------------------------------------------------===//
4394 //===----------------------------------------------------------------------===//
4396 /// \brief This class represents an extension of floating point types.
4397 class FPExtInst : public CastInst {
4399 // Note: Instruction needs to be a friend here to call cloneImpl.
4400 friend class Instruction;
4401 /// \brief Clone an identical FPExtInst
4402 FPExtInst *cloneImpl() const;
4405 /// \brief Constructor with insert-before-instruction semantics
4407 Value *S, ///< The value to be extended
4408 Type *Ty, ///< The type to extend to
4409 const Twine &NameStr = "", ///< A name for the new instruction
4410 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4413 /// \brief Constructor with insert-at-end-of-block semantics
4415 Value *S, ///< The value to be extended
4416 Type *Ty, ///< The type to extend to
4417 const Twine &NameStr, ///< A name for the new instruction
4418 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4421 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4422 static inline bool classof(const Instruction *I) {
4423 return I->getOpcode() == FPExt;
4425 static inline bool classof(const Value *V) {
4426 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4430 //===----------------------------------------------------------------------===//
4432 //===----------------------------------------------------------------------===//
4434 /// \brief This class represents a cast unsigned integer to floating point.
4435 class UIToFPInst : public CastInst {
4437 // Note: Instruction needs to be a friend here to call cloneImpl.
4438 friend class Instruction;
4439 /// \brief Clone an identical UIToFPInst
4440 UIToFPInst *cloneImpl() const;
4443 /// \brief Constructor with insert-before-instruction semantics
4445 Value *S, ///< The value to be converted
4446 Type *Ty, ///< The type to convert to
4447 const Twine &NameStr = "", ///< A name for the new instruction
4448 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4451 /// \brief Constructor with insert-at-end-of-block semantics
4453 Value *S, ///< The value to be converted
4454 Type *Ty, ///< The type to convert to
4455 const Twine &NameStr, ///< A name for the new instruction
4456 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4459 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4460 static inline bool classof(const Instruction *I) {
4461 return I->getOpcode() == UIToFP;
4463 static inline bool classof(const Value *V) {
4464 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4468 //===----------------------------------------------------------------------===//
4470 //===----------------------------------------------------------------------===//
4472 /// \brief This class represents a cast from signed integer to floating point.
4473 class SIToFPInst : public CastInst {
4475 // Note: Instruction needs to be a friend here to call cloneImpl.
4476 friend class Instruction;
4477 /// \brief Clone an identical SIToFPInst
4478 SIToFPInst *cloneImpl() const;
4481 /// \brief Constructor with insert-before-instruction semantics
4483 Value *S, ///< The value to be converted
4484 Type *Ty, ///< The type to convert to
4485 const Twine &NameStr = "", ///< A name for the new instruction
4486 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4489 /// \brief Constructor with insert-at-end-of-block semantics
4491 Value *S, ///< The value to be converted
4492 Type *Ty, ///< The type to convert to
4493 const Twine &NameStr, ///< A name for the new instruction
4494 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4497 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4498 static inline bool classof(const Instruction *I) {
4499 return I->getOpcode() == SIToFP;
4501 static inline bool classof(const Value *V) {
4502 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4506 //===----------------------------------------------------------------------===//
4508 //===----------------------------------------------------------------------===//
4510 /// \brief This class represents a cast from floating point to unsigned integer
4511 class FPToUIInst : public CastInst {
4513 // Note: Instruction needs to be a friend here to call cloneImpl.
4514 friend class Instruction;
4515 /// \brief Clone an identical FPToUIInst
4516 FPToUIInst *cloneImpl() const;
4519 /// \brief Constructor with insert-before-instruction semantics
4521 Value *S, ///< The value to be converted
4522 Type *Ty, ///< The type to convert to
4523 const Twine &NameStr = "", ///< A name for the new instruction
4524 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4527 /// \brief Constructor with insert-at-end-of-block semantics
4529 Value *S, ///< The value to be converted
4530 Type *Ty, ///< The type to convert to
4531 const Twine &NameStr, ///< A name for the new instruction
4532 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
4535 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4536 static inline bool classof(const Instruction *I) {
4537 return I->getOpcode() == FPToUI;
4539 static inline bool classof(const Value *V) {
4540 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4544 //===----------------------------------------------------------------------===//
4546 //===----------------------------------------------------------------------===//
4548 /// \brief This class represents a cast from floating point to signed integer.
4549 class FPToSIInst : public CastInst {
4551 // Note: Instruction needs to be a friend here to call cloneImpl.
4552 friend class Instruction;
4553 /// \brief Clone an identical FPToSIInst
4554 FPToSIInst *cloneImpl() const;
4557 /// \brief Constructor with insert-before-instruction semantics
4559 Value *S, ///< The value to be converted
4560 Type *Ty, ///< The type to convert to
4561 const Twine &NameStr = "", ///< A name for the new instruction
4562 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4565 /// \brief Constructor with insert-at-end-of-block semantics
4567 Value *S, ///< The value to be converted
4568 Type *Ty, ///< The type to convert to
4569 const Twine &NameStr, ///< A name for the new instruction
4570 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4573 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
4574 static inline bool classof(const Instruction *I) {
4575 return I->getOpcode() == FPToSI;
4577 static inline bool classof(const Value *V) {
4578 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4582 //===----------------------------------------------------------------------===//
4583 // IntToPtrInst Class
4584 //===----------------------------------------------------------------------===//
4586 /// \brief This class represents a cast from an integer to a pointer.
4587 class IntToPtrInst : public CastInst {
4589 /// \brief Constructor with insert-before-instruction semantics
4591 Value *S, ///< The value to be converted
4592 Type *Ty, ///< The type to convert to
4593 const Twine &NameStr = "", ///< A name for the new instruction
4594 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4597 /// \brief Constructor with insert-at-end-of-block semantics
4599 Value *S, ///< The value to be converted
4600 Type *Ty, ///< The type to convert to
4601 const Twine &NameStr, ///< A name for the new instruction
4602 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4605 // Note: Instruction needs to be a friend here to call cloneImpl.
4606 friend class Instruction;
4607 /// \brief Clone an identical IntToPtrInst
4608 IntToPtrInst *cloneImpl() const;
4610 /// \brief Returns the address space of this instruction's pointer type.
4611 unsigned getAddressSpace() const {
4612 return getType()->getPointerAddressSpace();
4615 // Methods for support type inquiry through isa, cast, and dyn_cast:
4616 static inline bool classof(const Instruction *I) {
4617 return I->getOpcode() == IntToPtr;
4619 static inline bool classof(const Value *V) {
4620 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4624 //===----------------------------------------------------------------------===//
4625 // PtrToIntInst Class
4626 //===----------------------------------------------------------------------===//
4628 /// \brief This class represents a cast from a pointer to an integer
4629 class PtrToIntInst : public CastInst {
4631 // Note: Instruction needs to be a friend here to call cloneImpl.
4632 friend class Instruction;
4633 /// \brief Clone an identical PtrToIntInst
4634 PtrToIntInst *cloneImpl() const;
4637 /// \brief Constructor with insert-before-instruction semantics
4639 Value *S, ///< The value to be converted
4640 Type *Ty, ///< The type to convert to
4641 const Twine &NameStr = "", ///< A name for the new instruction
4642 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4645 /// \brief Constructor with insert-at-end-of-block semantics
4647 Value *S, ///< The value to be converted
4648 Type *Ty, ///< The type to convert to
4649 const Twine &NameStr, ///< A name for the new instruction
4650 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4653 /// \brief Gets the pointer operand.
4654 Value *getPointerOperand() { return getOperand(0); }
4655 /// \brief Gets the pointer operand.
4656 const Value *getPointerOperand() const { return getOperand(0); }
4657 /// \brief Gets the operand index of the pointer operand.
4658 static unsigned getPointerOperandIndex() { return 0U; }
4660 /// \brief Returns the address space of the pointer operand.
4661 unsigned getPointerAddressSpace() const {
4662 return getPointerOperand()->getType()->getPointerAddressSpace();
4665 // Methods for support type inquiry through isa, cast, and dyn_cast:
4666 static inline bool classof(const Instruction *I) {
4667 return I->getOpcode() == PtrToInt;
4669 static inline bool classof(const Value *V) {
4670 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4674 //===----------------------------------------------------------------------===//
4675 // BitCastInst Class
4676 //===----------------------------------------------------------------------===//
4678 /// \brief This class represents a no-op cast from one type to another.
4679 class BitCastInst : public CastInst {
4681 // Note: Instruction needs to be a friend here to call cloneImpl.
4682 friend class Instruction;
4683 /// \brief Clone an identical BitCastInst
4684 BitCastInst *cloneImpl() const;
4687 /// \brief Constructor with insert-before-instruction semantics
4689 Value *S, ///< The value to be casted
4690 Type *Ty, ///< The type to casted to
4691 const Twine &NameStr = "", ///< A name for the new instruction
4692 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4695 /// \brief Constructor with insert-at-end-of-block semantics
4697 Value *S, ///< The value to be casted
4698 Type *Ty, ///< The type to casted to
4699 const Twine &NameStr, ///< A name for the new instruction
4700 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4703 // Methods for support type inquiry through isa, cast, and dyn_cast:
4704 static inline bool classof(const Instruction *I) {
4705 return I->getOpcode() == BitCast;
4707 static inline bool classof(const Value *V) {
4708 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4712 //===----------------------------------------------------------------------===//
4713 // AddrSpaceCastInst Class
4714 //===----------------------------------------------------------------------===//
4716 /// \brief This class represents a conversion between pointers from
4717 /// one address space to another.
4718 class AddrSpaceCastInst : public CastInst {
4720 // Note: Instruction needs to be a friend here to call cloneImpl.
4721 friend class Instruction;
4722 /// \brief Clone an identical AddrSpaceCastInst
4723 AddrSpaceCastInst *cloneImpl() const;
4726 /// \brief Constructor with insert-before-instruction semantics
4728 Value *S, ///< The value to be casted
4729 Type *Ty, ///< The type to casted to
4730 const Twine &NameStr = "", ///< A name for the new instruction
4731 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4734 /// \brief Constructor with insert-at-end-of-block semantics
4736 Value *S, ///< The value to be casted
4737 Type *Ty, ///< The type to casted to
4738 const Twine &NameStr, ///< A name for the new instruction
4739 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4742 // Methods for support type inquiry through isa, cast, and dyn_cast:
4743 static inline bool classof(const Instruction *I) {
4744 return I->getOpcode() == AddrSpaceCast;
4746 static inline bool classof(const Value *V) {
4747 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4751 } // End llvm namespace