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/None.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/ADT/StringRef.h"
24 #include "llvm/ADT/Twine.h"
25 #include "llvm/ADT/iterator.h"
26 #include "llvm/ADT/iterator_range.h"
27 #include "llvm/IR/Attributes.h"
28 #include "llvm/IR/BasicBlock.h"
29 #include "llvm/IR/CallingConv.h"
30 #include "llvm/IR/Constant.h"
31 #include "llvm/IR/DerivedTypes.h"
32 #include "llvm/IR/Function.h"
33 #include "llvm/IR/InstrTypes.h"
34 #include "llvm/IR/Instruction.h"
35 #include "llvm/IR/OperandTraits.h"
36 #include "llvm/IR/Type.h"
37 #include "llvm/IR/Use.h"
38 #include "llvm/IR/User.h"
39 #include "llvm/IR/Value.h"
40 #include "llvm/Support/AtomicOrdering.h"
41 #include "llvm/Support/Casting.h"
42 #include "llvm/Support/ErrorHandling.h"
55 //===----------------------------------------------------------------------===//
57 //===----------------------------------------------------------------------===//
59 /// an instruction to allocate memory on the stack
60 class AllocaInst : public UnaryInstruction {
64 // Note: Instruction needs to be a friend here to call cloneImpl.
65 friend class Instruction;
67 AllocaInst *cloneImpl() const;
70 explicit AllocaInst(Type *Ty, unsigned AddrSpace,
71 Value *ArraySize = nullptr,
72 const Twine &Name = "",
73 Instruction *InsertBefore = nullptr);
74 AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize,
75 const Twine &Name, BasicBlock *InsertAtEnd);
77 AllocaInst(Type *Ty, unsigned AddrSpace,
78 const Twine &Name, Instruction *InsertBefore = nullptr);
79 AllocaInst(Type *Ty, unsigned AddrSpace,
80 const Twine &Name, BasicBlock *InsertAtEnd);
82 AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize, unsigned Align,
83 const Twine &Name = "", Instruction *InsertBefore = nullptr);
84 AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize, unsigned Align,
85 const Twine &Name, BasicBlock *InsertAtEnd);
87 /// Return true if there is an allocation size parameter to the allocation
88 /// instruction that is not 1.
89 bool isArrayAllocation() const;
91 /// Get the number of elements allocated. For a simple allocation of a single
92 /// element, this will return a constant 1 value.
93 const Value *getArraySize() const { return getOperand(0); }
94 Value *getArraySize() { return getOperand(0); }
96 /// Overload to return most specific pointer type.
97 PointerType *getType() const {
98 return cast<PointerType>(Instruction::getType());
101 /// Return the type that is being allocated by the instruction.
102 Type *getAllocatedType() const { return AllocatedType; }
103 /// for use only in special circumstances that need to generically
104 /// transform a whole instruction (eg: IR linking and vectorization).
105 void setAllocatedType(Type *Ty) { AllocatedType = Ty; }
107 /// Return the alignment of the memory that is being allocated by the
109 unsigned getAlignment() const {
110 return (1u << (getSubclassDataFromInstruction() & 31)) >> 1;
112 void setAlignment(unsigned Align);
114 /// Return true if this alloca is in the entry block of the function and is a
115 /// constant size. If so, the code generator will fold it into the
116 /// prolog/epilog code, so it is basically free.
117 bool isStaticAlloca() const;
119 /// Return true if this alloca is used as an inalloca argument to a call. Such
120 /// allocas are never considered static even if they are in the entry block.
121 bool isUsedWithInAlloca() const {
122 return getSubclassDataFromInstruction() & 32;
125 /// Specify whether this alloca is used to represent the arguments to a call.
126 void setUsedWithInAlloca(bool V) {
127 setInstructionSubclassData((getSubclassDataFromInstruction() & ~32) |
131 /// Return true if this alloca is used as a swifterror argument to a call.
132 bool isSwiftError() const {
133 return getSubclassDataFromInstruction() & 64;
136 /// Specify whether this alloca is used to represent a swifterror.
137 void setSwiftError(bool V) {
138 setInstructionSubclassData((getSubclassDataFromInstruction() & ~64) |
142 // Methods for support type inquiry through isa, cast, and dyn_cast:
143 static bool classof(const Instruction *I) {
144 return (I->getOpcode() == Instruction::Alloca);
146 static bool classof(const Value *V) {
147 return isa<Instruction>(V) && classof(cast<Instruction>(V));
151 // Shadow Instruction::setInstructionSubclassData with a private forwarding
152 // method so that subclasses cannot accidentally use it.
153 void setInstructionSubclassData(unsigned short D) {
154 Instruction::setInstructionSubclassData(D);
158 //===----------------------------------------------------------------------===//
160 //===----------------------------------------------------------------------===//
162 /// An instruction for reading from memory. This uses the SubclassData field in
163 /// Value to store whether or not the load is volatile.
164 class LoadInst : public UnaryInstruction {
168 // Note: Instruction needs to be a friend here to call cloneImpl.
169 friend class Instruction;
171 LoadInst *cloneImpl() const;
174 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
175 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
176 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile = false,
177 Instruction *InsertBefore = nullptr);
178 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
179 Instruction *InsertBefore = nullptr)
180 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
181 NameStr, isVolatile, InsertBefore) {}
182 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
183 BasicBlock *InsertAtEnd);
184 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile, unsigned Align,
185 Instruction *InsertBefore = nullptr)
186 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
187 NameStr, isVolatile, Align, InsertBefore) {}
188 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
189 unsigned Align, Instruction *InsertBefore = nullptr);
190 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
191 unsigned Align, BasicBlock *InsertAtEnd);
192 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile, unsigned Align,
193 AtomicOrdering Order, SyncScope::ID SSID = SyncScope::System,
194 Instruction *InsertBefore = nullptr)
195 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
196 NameStr, isVolatile, Align, Order, SSID, InsertBefore) {}
197 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
198 unsigned Align, AtomicOrdering Order,
199 SyncScope::ID SSID = SyncScope::System,
200 Instruction *InsertBefore = nullptr);
201 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
202 unsigned Align, AtomicOrdering Order, SyncScope::ID SSID,
203 BasicBlock *InsertAtEnd);
204 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
205 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
206 LoadInst(Type *Ty, Value *Ptr, const char *NameStr = nullptr,
207 bool isVolatile = false, Instruction *InsertBefore = nullptr);
208 explicit LoadInst(Value *Ptr, const char *NameStr = nullptr,
209 bool isVolatile = false,
210 Instruction *InsertBefore = nullptr)
211 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
212 NameStr, isVolatile, InsertBefore) {}
213 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
214 BasicBlock *InsertAtEnd);
216 /// Return true if this is a load from a volatile memory location.
217 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
219 /// Specify whether this is a volatile load or not.
220 void setVolatile(bool V) {
221 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
225 /// Return the alignment of the access that is being performed.
226 unsigned getAlignment() const {
227 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
230 void setAlignment(unsigned Align);
232 /// Returns the ordering constraint of this load instruction.
233 AtomicOrdering getOrdering() const {
234 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
237 /// Sets the ordering constraint of this load instruction. May not be Release
238 /// or AcquireRelease.
239 void setOrdering(AtomicOrdering Ordering) {
240 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
241 ((unsigned)Ordering << 7));
244 /// Returns the synchronization scope ID of this load instruction.
245 SyncScope::ID getSyncScopeID() const {
249 /// Sets the synchronization scope ID of this load instruction.
250 void setSyncScopeID(SyncScope::ID SSID) {
254 /// Sets the ordering constraint and the synchronization scope ID of this load
256 void setAtomic(AtomicOrdering Ordering,
257 SyncScope::ID SSID = SyncScope::System) {
258 setOrdering(Ordering);
259 setSyncScopeID(SSID);
262 bool isSimple() const { return !isAtomic() && !isVolatile(); }
264 bool isUnordered() const {
265 return (getOrdering() == AtomicOrdering::NotAtomic ||
266 getOrdering() == AtomicOrdering::Unordered) &&
270 Value *getPointerOperand() { return getOperand(0); }
271 const Value *getPointerOperand() const { return getOperand(0); }
272 static unsigned getPointerOperandIndex() { return 0U; }
273 Type *getPointerOperandType() const { return getPointerOperand()->getType(); }
275 /// Returns the address space of the pointer operand.
276 unsigned getPointerAddressSpace() const {
277 return getPointerOperandType()->getPointerAddressSpace();
280 // Methods for support type inquiry through isa, cast, and dyn_cast:
281 static bool classof(const Instruction *I) {
282 return I->getOpcode() == Instruction::Load;
284 static bool classof(const Value *V) {
285 return isa<Instruction>(V) && classof(cast<Instruction>(V));
289 // Shadow Instruction::setInstructionSubclassData with a private forwarding
290 // method so that subclasses cannot accidentally use it.
291 void setInstructionSubclassData(unsigned short D) {
292 Instruction::setInstructionSubclassData(D);
295 /// The synchronization scope ID of this load instruction. Not quite enough
296 /// room in SubClassData for everything, so synchronization scope ID gets its
301 //===----------------------------------------------------------------------===//
303 //===----------------------------------------------------------------------===//
305 /// An instruction for storing to memory.
306 class StoreInst : public Instruction {
310 // Note: Instruction needs to be a friend here to call cloneImpl.
311 friend class Instruction;
313 StoreInst *cloneImpl() const;
316 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
317 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
318 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
319 Instruction *InsertBefore = nullptr);
320 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
321 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
322 unsigned Align, Instruction *InsertBefore = nullptr);
323 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
324 unsigned Align, BasicBlock *InsertAtEnd);
325 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
326 unsigned Align, AtomicOrdering Order,
327 SyncScope::ID SSID = SyncScope::System,
328 Instruction *InsertBefore = nullptr);
329 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
330 unsigned Align, AtomicOrdering Order, SyncScope::ID SSID,
331 BasicBlock *InsertAtEnd);
333 // allocate space for exactly two operands
334 void *operator new(size_t s) {
335 return User::operator new(s, 2);
338 /// Return true if this is a store to a volatile memory location.
339 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
341 /// Specify whether this is a volatile store or not.
342 void setVolatile(bool V) {
343 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
347 /// Transparently provide more efficient getOperand methods.
348 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
350 /// Return the alignment of the access that is being performed
351 unsigned getAlignment() const {
352 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
355 void setAlignment(unsigned Align);
357 /// Returns the ordering constraint of this store instruction.
358 AtomicOrdering getOrdering() const {
359 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
362 /// Sets the ordering constraint of this store instruction. May not be
363 /// Acquire or AcquireRelease.
364 void setOrdering(AtomicOrdering Ordering) {
365 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
366 ((unsigned)Ordering << 7));
369 /// Returns the synchronization scope ID of this store instruction.
370 SyncScope::ID getSyncScopeID() const {
374 /// Sets the synchronization scope ID of this store instruction.
375 void setSyncScopeID(SyncScope::ID SSID) {
379 /// Sets the ordering constraint and the synchronization scope ID of this
380 /// store instruction.
381 void setAtomic(AtomicOrdering Ordering,
382 SyncScope::ID SSID = SyncScope::System) {
383 setOrdering(Ordering);
384 setSyncScopeID(SSID);
387 bool isSimple() const { return !isAtomic() && !isVolatile(); }
389 bool isUnordered() const {
390 return (getOrdering() == AtomicOrdering::NotAtomic ||
391 getOrdering() == AtomicOrdering::Unordered) &&
395 Value *getValueOperand() { return getOperand(0); }
396 const Value *getValueOperand() const { return getOperand(0); }
398 Value *getPointerOperand() { return getOperand(1); }
399 const Value *getPointerOperand() const { return getOperand(1); }
400 static unsigned getPointerOperandIndex() { return 1U; }
401 Type *getPointerOperandType() const { return getPointerOperand()->getType(); }
403 /// Returns the address space of the pointer operand.
404 unsigned getPointerAddressSpace() const {
405 return getPointerOperandType()->getPointerAddressSpace();
408 // Methods for support type inquiry through isa, cast, and dyn_cast:
409 static bool classof(const Instruction *I) {
410 return I->getOpcode() == Instruction::Store;
412 static bool classof(const Value *V) {
413 return isa<Instruction>(V) && classof(cast<Instruction>(V));
417 // Shadow Instruction::setInstructionSubclassData with a private forwarding
418 // method so that subclasses cannot accidentally use it.
419 void setInstructionSubclassData(unsigned short D) {
420 Instruction::setInstructionSubclassData(D);
423 /// The synchronization scope ID of this store instruction. Not quite enough
424 /// room in SubClassData for everything, so synchronization scope ID gets its
430 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
433 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
435 //===----------------------------------------------------------------------===//
437 //===----------------------------------------------------------------------===//
439 /// An instruction for ordering other memory operations.
440 class FenceInst : public Instruction {
441 void Init(AtomicOrdering Ordering, SyncScope::ID SSID);
444 // Note: Instruction needs to be a friend here to call cloneImpl.
445 friend class Instruction;
447 FenceInst *cloneImpl() const;
450 // Ordering may only be Acquire, Release, AcquireRelease, or
451 // SequentiallyConsistent.
452 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
453 SyncScope::ID SSID = SyncScope::System,
454 Instruction *InsertBefore = nullptr);
455 FenceInst(LLVMContext &C, AtomicOrdering Ordering, SyncScope::ID SSID,
456 BasicBlock *InsertAtEnd);
458 // allocate space for exactly zero operands
459 void *operator new(size_t s) {
460 return User::operator new(s, 0);
463 /// Returns the ordering constraint of this fence instruction.
464 AtomicOrdering getOrdering() const {
465 return AtomicOrdering(getSubclassDataFromInstruction() >> 1);
468 /// Sets the ordering constraint of this fence instruction. May only be
469 /// Acquire, Release, AcquireRelease, or SequentiallyConsistent.
470 void setOrdering(AtomicOrdering Ordering) {
471 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
472 ((unsigned)Ordering << 1));
475 /// Returns the synchronization scope ID of this fence instruction.
476 SyncScope::ID getSyncScopeID() const {
480 /// Sets the synchronization scope ID of this fence instruction.
481 void setSyncScopeID(SyncScope::ID SSID) {
485 // Methods for support type inquiry through isa, cast, and dyn_cast:
486 static bool classof(const Instruction *I) {
487 return I->getOpcode() == Instruction::Fence;
489 static bool classof(const Value *V) {
490 return isa<Instruction>(V) && classof(cast<Instruction>(V));
494 // Shadow Instruction::setInstructionSubclassData with a private forwarding
495 // method so that subclasses cannot accidentally use it.
496 void setInstructionSubclassData(unsigned short D) {
497 Instruction::setInstructionSubclassData(D);
500 /// The synchronization scope ID of this fence instruction. Not quite enough
501 /// room in SubClassData for everything, so synchronization scope ID gets its
506 //===----------------------------------------------------------------------===//
507 // AtomicCmpXchgInst Class
508 //===----------------------------------------------------------------------===//
510 /// an instruction that atomically checks whether a
511 /// specified value is in a memory location, and, if it is, stores a new value
512 /// there. Returns the value that was loaded.
514 class AtomicCmpXchgInst : public Instruction {
515 void Init(Value *Ptr, Value *Cmp, Value *NewVal,
516 AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering,
520 // Note: Instruction needs to be a friend here to call cloneImpl.
521 friend class Instruction;
523 AtomicCmpXchgInst *cloneImpl() const;
526 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
527 AtomicOrdering SuccessOrdering,
528 AtomicOrdering FailureOrdering,
529 SyncScope::ID SSID, Instruction *InsertBefore = nullptr);
530 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
531 AtomicOrdering SuccessOrdering,
532 AtomicOrdering FailureOrdering,
533 SyncScope::ID SSID, BasicBlock *InsertAtEnd);
535 // allocate space for exactly three operands
536 void *operator new(size_t s) {
537 return User::operator new(s, 3);
540 /// Return true if this is a cmpxchg from a volatile memory
543 bool isVolatile() const {
544 return getSubclassDataFromInstruction() & 1;
547 /// Specify whether this is a volatile cmpxchg.
549 void setVolatile(bool V) {
550 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
554 /// Return true if this cmpxchg may spuriously fail.
555 bool isWeak() const {
556 return getSubclassDataFromInstruction() & 0x100;
559 void setWeak(bool IsWeak) {
560 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x100) |
564 /// Transparently provide more efficient getOperand methods.
565 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
567 /// Returns the success ordering constraint of this cmpxchg instruction.
568 AtomicOrdering getSuccessOrdering() const {
569 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
572 /// Sets the success ordering constraint of this cmpxchg instruction.
573 void setSuccessOrdering(AtomicOrdering Ordering) {
574 assert(Ordering != AtomicOrdering::NotAtomic &&
575 "CmpXchg instructions can only be atomic.");
576 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x1c) |
577 ((unsigned)Ordering << 2));
580 /// Returns the failure ordering constraint of this cmpxchg instruction.
581 AtomicOrdering getFailureOrdering() const {
582 return AtomicOrdering((getSubclassDataFromInstruction() >> 5) & 7);
585 /// Sets the failure ordering constraint of this cmpxchg instruction.
586 void setFailureOrdering(AtomicOrdering Ordering) {
587 assert(Ordering != AtomicOrdering::NotAtomic &&
588 "CmpXchg instructions can only be atomic.");
589 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0xe0) |
590 ((unsigned)Ordering << 5));
593 /// Returns the synchronization scope ID of this cmpxchg instruction.
594 SyncScope::ID getSyncScopeID() const {
598 /// Sets the synchronization scope ID of this cmpxchg instruction.
599 void setSyncScopeID(SyncScope::ID SSID) {
603 Value *getPointerOperand() { return getOperand(0); }
604 const Value *getPointerOperand() const { return getOperand(0); }
605 static unsigned getPointerOperandIndex() { return 0U; }
607 Value *getCompareOperand() { return getOperand(1); }
608 const Value *getCompareOperand() const { return getOperand(1); }
610 Value *getNewValOperand() { return getOperand(2); }
611 const Value *getNewValOperand() const { return getOperand(2); }
613 /// Returns the address space of the pointer operand.
614 unsigned getPointerAddressSpace() const {
615 return getPointerOperand()->getType()->getPointerAddressSpace();
618 /// Returns the strongest permitted ordering on failure, given the
619 /// desired ordering on success.
621 /// If the comparison in a cmpxchg operation fails, there is no atomic store
622 /// so release semantics cannot be provided. So this function drops explicit
623 /// Release requests from the AtomicOrdering. A SequentiallyConsistent
624 /// operation would remain SequentiallyConsistent.
625 static AtomicOrdering
626 getStrongestFailureOrdering(AtomicOrdering SuccessOrdering) {
627 switch (SuccessOrdering) {
629 llvm_unreachable("invalid cmpxchg success ordering");
630 case AtomicOrdering::Release:
631 case AtomicOrdering::Monotonic:
632 return AtomicOrdering::Monotonic;
633 case AtomicOrdering::AcquireRelease:
634 case AtomicOrdering::Acquire:
635 return AtomicOrdering::Acquire;
636 case AtomicOrdering::SequentiallyConsistent:
637 return AtomicOrdering::SequentiallyConsistent;
641 // Methods for support type inquiry through isa, cast, and dyn_cast:
642 static bool classof(const Instruction *I) {
643 return I->getOpcode() == Instruction::AtomicCmpXchg;
645 static bool classof(const Value *V) {
646 return isa<Instruction>(V) && classof(cast<Instruction>(V));
650 // Shadow Instruction::setInstructionSubclassData with a private forwarding
651 // method so that subclasses cannot accidentally use it.
652 void setInstructionSubclassData(unsigned short D) {
653 Instruction::setInstructionSubclassData(D);
656 /// The synchronization scope ID of this cmpxchg instruction. Not quite
657 /// enough room in SubClassData for everything, so synchronization scope ID
658 /// gets its own field.
663 struct OperandTraits<AtomicCmpXchgInst> :
664 public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
667 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)
669 //===----------------------------------------------------------------------===//
670 // AtomicRMWInst Class
671 //===----------------------------------------------------------------------===//
673 /// an instruction that atomically reads a memory location,
674 /// combines it with another value, and then stores the result back. Returns
677 class AtomicRMWInst : public Instruction {
679 // Note: Instruction needs to be a friend here to call cloneImpl.
680 friend class Instruction;
682 AtomicRMWInst *cloneImpl() const;
685 /// This enumeration lists the possible modifications atomicrmw can make. In
686 /// the descriptions, 'p' is the pointer to the instruction's memory location,
687 /// 'old' is the initial value of *p, and 'v' is the other value passed to the
688 /// instruction. These instructions always return 'old'.
704 /// *p = old >signed v ? old : v
706 /// *p = old <signed v ? old : v
708 /// *p = old >unsigned v ? old : v
710 /// *p = old <unsigned v ? old : v
718 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
719 AtomicOrdering Ordering, SyncScope::ID SSID,
720 Instruction *InsertBefore = nullptr);
721 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
722 AtomicOrdering Ordering, SyncScope::ID SSID,
723 BasicBlock *InsertAtEnd);
725 // allocate space for exactly two operands
726 void *operator new(size_t s) {
727 return User::operator new(s, 2);
730 BinOp getOperation() const {
731 return static_cast<BinOp>(getSubclassDataFromInstruction() >> 5);
734 void setOperation(BinOp Operation) {
735 unsigned short SubclassData = getSubclassDataFromInstruction();
736 setInstructionSubclassData((SubclassData & 31) |
740 /// Return true if this is a RMW on a volatile memory location.
742 bool isVolatile() const {
743 return getSubclassDataFromInstruction() & 1;
746 /// Specify whether this is a volatile RMW or not.
748 void setVolatile(bool V) {
749 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
753 /// Transparently provide more efficient getOperand methods.
754 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
756 /// Returns the ordering constraint of this rmw instruction.
757 AtomicOrdering getOrdering() const {
758 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
761 /// Sets the ordering constraint of this rmw instruction.
762 void setOrdering(AtomicOrdering Ordering) {
763 assert(Ordering != AtomicOrdering::NotAtomic &&
764 "atomicrmw instructions can only be atomic.");
765 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 2)) |
766 ((unsigned)Ordering << 2));
769 /// Returns the synchronization scope ID of this rmw instruction.
770 SyncScope::ID getSyncScopeID() const {
774 /// Sets the synchronization scope ID of this rmw instruction.
775 void setSyncScopeID(SyncScope::ID SSID) {
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 /// 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 bool classof(const Instruction *I) {
793 return I->getOpcode() == Instruction::AtomicRMW;
795 static bool classof(const Value *V) {
796 return isa<Instruction>(V) && classof(cast<Instruction>(V));
800 void Init(BinOp Operation, Value *Ptr, Value *Val,
801 AtomicOrdering Ordering, SyncScope::ID SSID);
803 // Shadow Instruction::setInstructionSubclassData with a private forwarding
804 // method so that subclasses cannot accidentally use it.
805 void setInstructionSubclassData(unsigned short D) {
806 Instruction::setInstructionSubclassData(D);
809 /// The synchronization scope ID of this rmw instruction. Not quite enough
810 /// room in SubClassData for everything, so synchronization scope ID gets its
816 struct OperandTraits<AtomicRMWInst>
817 : public FixedNumOperandTraits<AtomicRMWInst,2> {
820 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)
822 //===----------------------------------------------------------------------===//
823 // GetElementPtrInst Class
824 //===----------------------------------------------------------------------===//
826 // checkGEPType - Simple wrapper function to give a better assertion failure
827 // message on bad indexes for a gep instruction.
829 inline Type *checkGEPType(Type *Ty) {
830 assert(Ty && "Invalid GetElementPtrInst indices for type!");
834 /// an instruction for type-safe pointer arithmetic to
835 /// access elements of arrays and structs
837 class GetElementPtrInst : public Instruction {
838 Type *SourceElementType;
839 Type *ResultElementType;
841 GetElementPtrInst(const GetElementPtrInst &GEPI);
843 /// Constructors - Create a getelementptr instruction with a base pointer an
844 /// list of indices. The first ctor can optionally insert before an existing
845 /// instruction, the second appends the new instruction to the specified
847 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
848 ArrayRef<Value *> IdxList, unsigned Values,
849 const Twine &NameStr, Instruction *InsertBefore);
850 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
851 ArrayRef<Value *> IdxList, unsigned Values,
852 const Twine &NameStr, BasicBlock *InsertAtEnd);
854 void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
857 // Note: Instruction needs to be a friend here to call cloneImpl.
858 friend class Instruction;
860 GetElementPtrInst *cloneImpl() const;
863 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
864 ArrayRef<Value *> IdxList,
865 const Twine &NameStr = "",
866 Instruction *InsertBefore = nullptr) {
867 unsigned Values = 1 + unsigned(IdxList.size());
870 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
874 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
875 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
876 NameStr, InsertBefore);
879 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
880 ArrayRef<Value *> IdxList,
881 const Twine &NameStr,
882 BasicBlock *InsertAtEnd) {
883 unsigned Values = 1 + unsigned(IdxList.size());
886 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
890 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
891 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
892 NameStr, InsertAtEnd);
895 /// Create an "inbounds" getelementptr. See the documentation for the
896 /// "inbounds" flag in LangRef.html for details.
897 static GetElementPtrInst *CreateInBounds(Value *Ptr,
898 ArrayRef<Value *> IdxList,
899 const Twine &NameStr = "",
900 Instruction *InsertBefore = nullptr){
901 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertBefore);
904 static GetElementPtrInst *
905 CreateInBounds(Type *PointeeType, Value *Ptr, ArrayRef<Value *> IdxList,
906 const Twine &NameStr = "",
907 Instruction *InsertBefore = nullptr) {
908 GetElementPtrInst *GEP =
909 Create(PointeeType, Ptr, IdxList, NameStr, InsertBefore);
910 GEP->setIsInBounds(true);
914 static GetElementPtrInst *CreateInBounds(Value *Ptr,
915 ArrayRef<Value *> IdxList,
916 const Twine &NameStr,
917 BasicBlock *InsertAtEnd) {
918 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertAtEnd);
921 static GetElementPtrInst *CreateInBounds(Type *PointeeType, Value *Ptr,
922 ArrayRef<Value *> IdxList,
923 const Twine &NameStr,
924 BasicBlock *InsertAtEnd) {
925 GetElementPtrInst *GEP =
926 Create(PointeeType, Ptr, IdxList, NameStr, InsertAtEnd);
927 GEP->setIsInBounds(true);
931 /// Transparently provide more efficient getOperand methods.
932 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
934 Type *getSourceElementType() const { return SourceElementType; }
936 void setSourceElementType(Type *Ty) { SourceElementType = Ty; }
937 void setResultElementType(Type *Ty) { ResultElementType = Ty; }
939 Type *getResultElementType() const {
940 assert(ResultElementType ==
941 cast<PointerType>(getType()->getScalarType())->getElementType());
942 return ResultElementType;
945 /// Returns the address space of this instruction's pointer type.
946 unsigned getAddressSpace() const {
947 // Note that this is always the same as the pointer operand's address space
948 // and that is cheaper to compute, so cheat here.
949 return getPointerAddressSpace();
952 /// Returns the type of the element that would be loaded with
953 /// a load instruction with the specified parameters.
955 /// Null is returned if the indices are invalid for the specified
958 static Type *getIndexedType(Type *Ty, ArrayRef<Value *> IdxList);
959 static Type *getIndexedType(Type *Ty, ArrayRef<Constant *> IdxList);
960 static Type *getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList);
962 inline op_iterator idx_begin() { return op_begin()+1; }
963 inline const_op_iterator idx_begin() const { return op_begin()+1; }
964 inline op_iterator idx_end() { return op_end(); }
965 inline const_op_iterator idx_end() const { return op_end(); }
967 inline iterator_range<op_iterator> indices() {
968 return make_range(idx_begin(), idx_end());
971 inline iterator_range<const_op_iterator> indices() const {
972 return make_range(idx_begin(), idx_end());
975 Value *getPointerOperand() {
976 return getOperand(0);
978 const Value *getPointerOperand() const {
979 return getOperand(0);
981 static unsigned getPointerOperandIndex() {
982 return 0U; // get index for modifying correct operand.
985 /// Method to return the pointer operand as a
987 Type *getPointerOperandType() const {
988 return getPointerOperand()->getType();
991 /// Returns the address space of the pointer operand.
992 unsigned getPointerAddressSpace() const {
993 return getPointerOperandType()->getPointerAddressSpace();
996 /// Returns the pointer type returned by the GEP
997 /// instruction, which may be a vector of pointers.
998 static Type *getGEPReturnType(Value *Ptr, ArrayRef<Value *> IdxList) {
999 return getGEPReturnType(
1000 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType(),
1003 static Type *getGEPReturnType(Type *ElTy, Value *Ptr,
1004 ArrayRef<Value *> IdxList) {
1005 Type *PtrTy = PointerType::get(checkGEPType(getIndexedType(ElTy, IdxList)),
1006 Ptr->getType()->getPointerAddressSpace());
1008 if (Ptr->getType()->isVectorTy()) {
1009 unsigned NumElem = Ptr->getType()->getVectorNumElements();
1010 return VectorType::get(PtrTy, NumElem);
1012 for (Value *Index : IdxList)
1013 if (Index->getType()->isVectorTy()) {
1014 unsigned NumElem = Index->getType()->getVectorNumElements();
1015 return VectorType::get(PtrTy, NumElem);
1021 unsigned getNumIndices() const { // Note: always non-negative
1022 return getNumOperands() - 1;
1025 bool hasIndices() const {
1026 return getNumOperands() > 1;
1029 /// Return true if all of the indices of this GEP are
1030 /// zeros. If so, the result pointer and the first operand have the same
1031 /// value, just potentially different types.
1032 bool hasAllZeroIndices() const;
1034 /// Return true if all of the indices of this GEP are
1035 /// constant integers. If so, the result pointer and the first operand have
1036 /// a constant offset between them.
1037 bool hasAllConstantIndices() const;
1039 /// Set or clear the inbounds flag on this GEP instruction.
1040 /// See LangRef.html for the meaning of inbounds on a getelementptr.
1041 void setIsInBounds(bool b = true);
1043 /// Determine whether the GEP has the inbounds flag.
1044 bool isInBounds() const;
1046 /// Accumulate the constant address offset of this GEP if possible.
1048 /// This routine accepts an APInt into which it will accumulate the constant
1049 /// offset of this GEP if the GEP is in fact constant. If the GEP is not
1050 /// all-constant, it returns false and the value of the offset APInt is
1051 /// undefined (it is *not* preserved!). The APInt passed into this routine
1052 /// must be at least as wide as the IntPtr type for the address space of
1053 /// the base GEP pointer.
1054 bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const;
1056 // Methods for support type inquiry through isa, cast, and dyn_cast:
1057 static bool classof(const Instruction *I) {
1058 return (I->getOpcode() == Instruction::GetElementPtr);
1060 static bool classof(const Value *V) {
1061 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1066 struct OperandTraits<GetElementPtrInst> :
1067 public VariadicOperandTraits<GetElementPtrInst, 1> {
1070 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1071 ArrayRef<Value *> IdxList, unsigned Values,
1072 const Twine &NameStr,
1073 Instruction *InsertBefore)
1074 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1075 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1076 Values, InsertBefore),
1077 SourceElementType(PointeeType),
1078 ResultElementType(getIndexedType(PointeeType, IdxList)) {
1079 assert(ResultElementType ==
1080 cast<PointerType>(getType()->getScalarType())->getElementType());
1081 init(Ptr, IdxList, NameStr);
1084 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1085 ArrayRef<Value *> IdxList, unsigned Values,
1086 const Twine &NameStr,
1087 BasicBlock *InsertAtEnd)
1088 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1089 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1090 Values, InsertAtEnd),
1091 SourceElementType(PointeeType),
1092 ResultElementType(getIndexedType(PointeeType, IdxList)) {
1093 assert(ResultElementType ==
1094 cast<PointerType>(getType()->getScalarType())->getElementType());
1095 init(Ptr, IdxList, NameStr);
1098 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
1100 //===----------------------------------------------------------------------===//
1102 //===----------------------------------------------------------------------===//
1104 /// This instruction compares its operands according to the predicate given
1105 /// to the constructor. It only operates on integers or pointers. The operands
1106 /// must be identical types.
1107 /// Represent an integer comparison operator.
1108 class ICmpInst: public CmpInst {
1110 assert(isIntPredicate() &&
1111 "Invalid ICmp predicate value");
1112 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1113 "Both operands to ICmp instruction are not of the same type!");
1114 // Check that the operands are the right type
1115 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
1116 getOperand(0)->getType()->isPtrOrPtrVectorTy()) &&
1117 "Invalid operand types for ICmp instruction");
1121 // Note: Instruction needs to be a friend here to call cloneImpl.
1122 friend class Instruction;
1124 /// Clone an identical ICmpInst
1125 ICmpInst *cloneImpl() const;
1128 /// Constructor with insert-before-instruction semantics.
1130 Instruction *InsertBefore, ///< Where to insert
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 /// Constructor with insert-at-end semantics.
1145 BasicBlock &InsertAtEnd, ///< Block to insert into.
1146 Predicate pred, ///< The predicate to use for the comparison
1147 Value *LHS, ///< The left-hand-side of the expression
1148 Value *RHS, ///< The right-hand-side of the expression
1149 const Twine &NameStr = "" ///< Name of the instruction
1150 ) : CmpInst(makeCmpResultType(LHS->getType()),
1151 Instruction::ICmp, pred, LHS, RHS, NameStr,
1158 /// Constructor with no-insertion semantics
1160 Predicate pred, ///< The predicate to use for the comparison
1161 Value *LHS, ///< The left-hand-side of the expression
1162 Value *RHS, ///< The right-hand-side of the expression
1163 const Twine &NameStr = "" ///< Name of the instruction
1164 ) : CmpInst(makeCmpResultType(LHS->getType()),
1165 Instruction::ICmp, pred, LHS, RHS, NameStr) {
1171 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
1172 /// @returns the predicate that would be the result if the operand were
1173 /// regarded as signed.
1174 /// Return the signed version of the predicate
1175 Predicate getSignedPredicate() const {
1176 return getSignedPredicate(getPredicate());
1179 /// This is a static version that you can use without an instruction.
1180 /// Return the signed version of the predicate.
1181 static Predicate getSignedPredicate(Predicate pred);
1183 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
1184 /// @returns the predicate that would be the result if the operand were
1185 /// regarded as unsigned.
1186 /// Return the unsigned version of the predicate
1187 Predicate getUnsignedPredicate() const {
1188 return getUnsignedPredicate(getPredicate());
1191 /// This is a static version that you can use without an instruction.
1192 /// Return the unsigned version of the predicate.
1193 static Predicate getUnsignedPredicate(Predicate pred);
1195 /// Return true if this predicate is either EQ or NE. This also
1196 /// tests for commutativity.
1197 static bool isEquality(Predicate P) {
1198 return P == ICMP_EQ || P == ICMP_NE;
1201 /// Return true if this predicate is either EQ or NE. This also
1202 /// tests for commutativity.
1203 bool isEquality() const {
1204 return isEquality(getPredicate());
1207 /// @returns true if the predicate of this ICmpInst is commutative
1208 /// Determine if this relation is commutative.
1209 bool isCommutative() const { return isEquality(); }
1211 /// Return true if the predicate is relational (not EQ or NE).
1213 bool isRelational() const {
1214 return !isEquality();
1217 /// Return true if the predicate is relational (not EQ or NE).
1219 static bool isRelational(Predicate P) {
1220 return !isEquality(P);
1223 /// Exchange the two operands to this instruction in such a way that it does
1224 /// not modify the semantics of the instruction. The predicate value may be
1225 /// changed to retain the same result if the predicate is order dependent
1227 /// Swap operands and adjust predicate.
1228 void swapOperands() {
1229 setPredicate(getSwappedPredicate());
1230 Op<0>().swap(Op<1>());
1233 // Methods for support type inquiry through isa, cast, and dyn_cast:
1234 static bool classof(const Instruction *I) {
1235 return I->getOpcode() == Instruction::ICmp;
1237 static bool classof(const Value *V) {
1238 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1242 //===----------------------------------------------------------------------===//
1244 //===----------------------------------------------------------------------===//
1246 /// This instruction compares its operands according to the predicate given
1247 /// to the constructor. It only operates on floating point values or packed
1248 /// vectors of floating point values. The operands must be identical types.
1249 /// Represents a floating point comparison operator.
1250 class FCmpInst: public CmpInst {
1252 assert(isFPPredicate() && "Invalid FCmp predicate value");
1253 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1254 "Both operands to FCmp instruction are not of the same type!");
1255 // Check that the operands are the right type
1256 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1257 "Invalid operand types for FCmp instruction");
1261 // Note: Instruction needs to be a friend here to call cloneImpl.
1262 friend class Instruction;
1264 /// Clone an identical FCmpInst
1265 FCmpInst *cloneImpl() const;
1268 /// Constructor with insert-before-instruction semantics.
1270 Instruction *InsertBefore, ///< Where to insert
1271 Predicate pred, ///< The predicate to use for the comparison
1272 Value *LHS, ///< The left-hand-side of the expression
1273 Value *RHS, ///< The right-hand-side of the expression
1274 const Twine &NameStr = "" ///< Name of the instruction
1275 ) : CmpInst(makeCmpResultType(LHS->getType()),
1276 Instruction::FCmp, pred, LHS, RHS, NameStr,
1281 /// Constructor with insert-at-end semantics.
1283 BasicBlock &InsertAtEnd, ///< Block to insert into.
1284 Predicate pred, ///< The predicate to use for the comparison
1285 Value *LHS, ///< The left-hand-side of the expression
1286 Value *RHS, ///< The right-hand-side of the expression
1287 const Twine &NameStr = "" ///< Name of the instruction
1288 ) : CmpInst(makeCmpResultType(LHS->getType()),
1289 Instruction::FCmp, pred, LHS, RHS, NameStr,
1294 /// Constructor with no-insertion semantics
1296 Predicate pred, ///< The predicate to use for the comparison
1297 Value *LHS, ///< The left-hand-side of the expression
1298 Value *RHS, ///< The right-hand-side of the expression
1299 const Twine &NameStr = "" ///< Name of the instruction
1300 ) : CmpInst(makeCmpResultType(LHS->getType()),
1301 Instruction::FCmp, pred, LHS, RHS, NameStr) {
1305 /// @returns true if the predicate of this instruction is EQ or NE.
1306 /// Determine if this is an equality predicate.
1307 static bool isEquality(Predicate Pred) {
1308 return Pred == FCMP_OEQ || Pred == FCMP_ONE || Pred == FCMP_UEQ ||
1312 /// @returns true if the predicate of this instruction is EQ or NE.
1313 /// Determine if this is an equality predicate.
1314 bool isEquality() const { return isEquality(getPredicate()); }
1316 /// @returns true if the predicate of this instruction is commutative.
1317 /// Determine if this is a commutative predicate.
1318 bool isCommutative() const {
1319 return isEquality() ||
1320 getPredicate() == FCMP_FALSE ||
1321 getPredicate() == FCMP_TRUE ||
1322 getPredicate() == FCMP_ORD ||
1323 getPredicate() == FCMP_UNO;
1326 /// @returns true if the predicate is relational (not EQ or NE).
1327 /// Determine if this a relational predicate.
1328 bool isRelational() const { return !isEquality(); }
1330 /// Exchange the two operands to this instruction in such a way that it does
1331 /// not modify the semantics of the instruction. The predicate value may be
1332 /// changed to retain the same result if the predicate is order dependent
1334 /// Swap operands and adjust predicate.
1335 void swapOperands() {
1336 setPredicate(getSwappedPredicate());
1337 Op<0>().swap(Op<1>());
1340 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1341 static bool classof(const Instruction *I) {
1342 return I->getOpcode() == Instruction::FCmp;
1344 static bool classof(const Value *V) {
1345 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1349 //===----------------------------------------------------------------------===//
1350 /// This class represents a function call, abstracting a target
1351 /// machine's calling convention. This class uses low bit of the SubClassData
1352 /// field to indicate whether or not this is a tail call. The rest of the bits
1353 /// hold the calling convention of the call.
1355 class CallInst : public Instruction,
1356 public OperandBundleUser<CallInst, User::op_iterator> {
1357 friend class OperandBundleUser<CallInst, User::op_iterator>;
1359 AttributeList Attrs; ///< parameter attributes for call
1362 CallInst(const CallInst &CI);
1364 /// Construct a CallInst given a range of arguments.
1365 /// Construct a CallInst from a range of arguments
1366 inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1367 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1368 Instruction *InsertBefore);
1370 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1371 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1372 Instruction *InsertBefore)
1373 : CallInst(cast<FunctionType>(
1374 cast<PointerType>(Func->getType())->getElementType()),
1375 Func, Args, Bundles, NameStr, InsertBefore) {}
1377 inline CallInst(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr,
1378 Instruction *InsertBefore)
1379 : CallInst(Func, Args, None, NameStr, InsertBefore) {}
1381 /// Construct a CallInst given a range of arguments.
1382 /// Construct a CallInst from a range of arguments
1383 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1384 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1385 BasicBlock *InsertAtEnd);
1387 explicit CallInst(Value *F, const Twine &NameStr,
1388 Instruction *InsertBefore);
1390 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1392 void init(Value *Func, ArrayRef<Value *> Args,
1393 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr) {
1394 init(cast<FunctionType>(
1395 cast<PointerType>(Func->getType())->getElementType()),
1396 Func, Args, Bundles, NameStr);
1398 void init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
1399 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr);
1400 void init(Value *Func, const Twine &NameStr);
1402 bool hasDescriptor() const { return HasDescriptor; }
1405 // Note: Instruction needs to be a friend here to call cloneImpl.
1406 friend class Instruction;
1408 CallInst *cloneImpl() const;
1411 static CallInst *Create(Value *Func, ArrayRef<Value *> Args,
1412 ArrayRef<OperandBundleDef> Bundles = None,
1413 const Twine &NameStr = "",
1414 Instruction *InsertBefore = nullptr) {
1415 return Create(cast<FunctionType>(
1416 cast<PointerType>(Func->getType())->getElementType()),
1417 Func, Args, Bundles, NameStr, InsertBefore);
1420 static CallInst *Create(Value *Func, ArrayRef<Value *> Args,
1421 const Twine &NameStr,
1422 Instruction *InsertBefore = nullptr) {
1423 return Create(cast<FunctionType>(
1424 cast<PointerType>(Func->getType())->getElementType()),
1425 Func, Args, None, NameStr, InsertBefore);
1428 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1429 const Twine &NameStr,
1430 Instruction *InsertBefore = nullptr) {
1431 return new (unsigned(Args.size() + 1))
1432 CallInst(Ty, Func, Args, None, NameStr, InsertBefore);
1435 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1436 ArrayRef<OperandBundleDef> Bundles = None,
1437 const Twine &NameStr = "",
1438 Instruction *InsertBefore = nullptr) {
1439 const unsigned TotalOps =
1440 unsigned(Args.size()) + CountBundleInputs(Bundles) + 1;
1441 const unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
1443 return new (TotalOps, DescriptorBytes)
1444 CallInst(Ty, Func, Args, Bundles, NameStr, InsertBefore);
1447 static CallInst *Create(Value *Func, ArrayRef<Value *> Args,
1448 ArrayRef<OperandBundleDef> Bundles,
1449 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1450 const unsigned TotalOps =
1451 unsigned(Args.size()) + CountBundleInputs(Bundles) + 1;
1452 const unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
1454 return new (TotalOps, DescriptorBytes)
1455 CallInst(Func, Args, Bundles, NameStr, InsertAtEnd);
1458 static CallInst *Create(Value *Func, ArrayRef<Value *> Args,
1459 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1460 return new (unsigned(Args.size() + 1))
1461 CallInst(Func, Args, None, NameStr, InsertAtEnd);
1464 static CallInst *Create(Value *F, const Twine &NameStr = "",
1465 Instruction *InsertBefore = nullptr) {
1466 return new(1) CallInst(F, NameStr, InsertBefore);
1469 static CallInst *Create(Value *F, const Twine &NameStr,
1470 BasicBlock *InsertAtEnd) {
1471 return new(1) CallInst(F, NameStr, InsertAtEnd);
1474 /// Create a clone of \p CI with a different set of operand bundles and
1475 /// insert it before \p InsertPt.
1477 /// The returned call instruction is identical \p CI in every way except that
1478 /// the operand bundles for the new instruction are set to the operand bundles
1480 static CallInst *Create(CallInst *CI, ArrayRef<OperandBundleDef> Bundles,
1481 Instruction *InsertPt = nullptr);
1483 /// Generate the IR for a call to malloc:
1484 /// 1. Compute the malloc call's argument as the specified type's size,
1485 /// possibly multiplied by the array size if the array size is not
1487 /// 2. Call malloc with that argument.
1488 /// 3. Bitcast the result of the malloc call to the specified type.
1489 static Instruction *CreateMalloc(Instruction *InsertBefore,
1490 Type *IntPtrTy, Type *AllocTy,
1491 Value *AllocSize, Value *ArraySize = nullptr,
1492 Function* MallocF = nullptr,
1493 const Twine &Name = "");
1494 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1495 Type *IntPtrTy, Type *AllocTy,
1496 Value *AllocSize, Value *ArraySize = nullptr,
1497 Function* MallocF = nullptr,
1498 const Twine &Name = "");
1499 static Instruction *CreateMalloc(Instruction *InsertBefore,
1500 Type *IntPtrTy, Type *AllocTy,
1501 Value *AllocSize, Value *ArraySize = nullptr,
1502 ArrayRef<OperandBundleDef> Bundles = None,
1503 Function* MallocF = nullptr,
1504 const Twine &Name = "");
1505 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1506 Type *IntPtrTy, Type *AllocTy,
1507 Value *AllocSize, Value *ArraySize = nullptr,
1508 ArrayRef<OperandBundleDef> Bundles = None,
1509 Function* MallocF = nullptr,
1510 const Twine &Name = "");
1511 /// Generate the IR for a call to the builtin free function.
1512 static Instruction *CreateFree(Value *Source,
1513 Instruction *InsertBefore);
1514 static Instruction *CreateFree(Value *Source,
1515 BasicBlock *InsertAtEnd);
1516 static Instruction *CreateFree(Value *Source,
1517 ArrayRef<OperandBundleDef> Bundles,
1518 Instruction *InsertBefore);
1519 static Instruction *CreateFree(Value *Source,
1520 ArrayRef<OperandBundleDef> Bundles,
1521 BasicBlock *InsertAtEnd);
1523 FunctionType *getFunctionType() const { return FTy; }
1525 void mutateFunctionType(FunctionType *FTy) {
1526 mutateType(FTy->getReturnType());
1530 // Note that 'musttail' implies 'tail'.
1531 enum TailCallKind { TCK_None = 0, TCK_Tail = 1, TCK_MustTail = 2,
1533 TailCallKind getTailCallKind() const {
1534 return TailCallKind(getSubclassDataFromInstruction() & 3);
1537 bool isTailCall() const {
1538 unsigned Kind = getSubclassDataFromInstruction() & 3;
1539 return Kind == TCK_Tail || Kind == TCK_MustTail;
1542 bool isMustTailCall() const {
1543 return (getSubclassDataFromInstruction() & 3) == TCK_MustTail;
1546 bool isNoTailCall() const {
1547 return (getSubclassDataFromInstruction() & 3) == TCK_NoTail;
1550 void setTailCall(bool isTC = true) {
1551 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1552 unsigned(isTC ? TCK_Tail : TCK_None));
1555 void setTailCallKind(TailCallKind TCK) {
1556 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1560 /// Provide fast operand accessors
1561 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1563 /// Return the number of call arguments.
1565 unsigned getNumArgOperands() const {
1566 return getNumOperands() - getNumTotalBundleOperands() - 1;
1569 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
1571 Value *getArgOperand(unsigned i) const {
1572 assert(i < getNumArgOperands() && "Out of bounds!");
1573 return getOperand(i);
1575 void setArgOperand(unsigned i, Value *v) {
1576 assert(i < getNumArgOperands() && "Out of bounds!");
1580 /// Return the iterator pointing to the beginning of the argument list.
1581 op_iterator arg_begin() { return op_begin(); }
1583 /// Return the iterator pointing to the end of the argument list.
1584 op_iterator arg_end() {
1585 // [ call args ], [ operand bundles ], callee
1586 return op_end() - getNumTotalBundleOperands() - 1;
1589 /// Iteration adapter for range-for loops.
1590 iterator_range<op_iterator> arg_operands() {
1591 return make_range(arg_begin(), arg_end());
1594 /// Return the iterator pointing to the beginning of the argument list.
1595 const_op_iterator arg_begin() const { return op_begin(); }
1597 /// Return the iterator pointing to the end of the argument list.
1598 const_op_iterator arg_end() const {
1599 // [ call args ], [ operand bundles ], callee
1600 return op_end() - getNumTotalBundleOperands() - 1;
1603 /// Iteration adapter for range-for loops.
1604 iterator_range<const_op_iterator> arg_operands() const {
1605 return make_range(arg_begin(), arg_end());
1608 /// Wrappers for getting the \c Use of a call argument.
1609 const Use &getArgOperandUse(unsigned i) const {
1610 assert(i < getNumArgOperands() && "Out of bounds!");
1611 return getOperandUse(i);
1613 Use &getArgOperandUse(unsigned i) {
1614 assert(i < getNumArgOperands() && "Out of bounds!");
1615 return getOperandUse(i);
1618 /// If one of the arguments has the 'returned' attribute, return its
1619 /// operand value. Otherwise, return nullptr.
1620 Value *getReturnedArgOperand() const;
1622 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1624 CallingConv::ID getCallingConv() const {
1625 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 2);
1627 void setCallingConv(CallingConv::ID CC) {
1628 auto ID = static_cast<unsigned>(CC);
1629 assert(!(ID & ~CallingConv::MaxID) && "Unsupported calling convention");
1630 setInstructionSubclassData((getSubclassDataFromInstruction() & 3) |
1634 /// Return the parameter attributes for this call.
1636 AttributeList getAttributes() const { return Attrs; }
1638 /// Set the parameter attributes for this call.
1640 void setAttributes(AttributeList A) { Attrs = A; }
1642 /// adds the attribute to the list of attributes.
1643 void addAttribute(unsigned i, Attribute::AttrKind Kind);
1645 /// adds the attribute to the list of attributes.
1646 void addAttribute(unsigned i, Attribute Attr);
1648 /// Adds the attribute to the indicated argument
1649 void addParamAttr(unsigned ArgNo, Attribute::AttrKind Kind);
1651 /// Adds the attribute to the indicated argument
1652 void addParamAttr(unsigned ArgNo, Attribute Attr);
1654 /// removes the attribute from the list of attributes.
1655 void removeAttribute(unsigned i, Attribute::AttrKind Kind);
1657 /// removes the attribute from the list of attributes.
1658 void removeAttribute(unsigned i, StringRef Kind);
1660 /// Removes the attribute from the given argument
1661 void removeParamAttr(unsigned ArgNo, Attribute::AttrKind Kind);
1663 /// Removes the attribute from the given argument
1664 void removeParamAttr(unsigned ArgNo, StringRef Kind);
1666 /// adds the dereferenceable attribute to the list of attributes.
1667 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
1669 /// adds the dereferenceable_or_null attribute to the list of
1671 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
1673 /// Determine whether this call has the given attribute.
1674 bool hasFnAttr(Attribute::AttrKind Kind) const {
1675 assert(Kind != Attribute::NoBuiltin &&
1676 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
1677 return hasFnAttrImpl(Kind);
1680 /// Determine whether this call has the given attribute.
1681 bool hasFnAttr(StringRef Kind) const {
1682 return hasFnAttrImpl(Kind);
1685 /// Determine whether the return value has the given attribute.
1686 bool hasRetAttr(Attribute::AttrKind Kind) const;
1688 /// Determine whether the argument or parameter has the given attribute.
1689 bool paramHasAttr(unsigned ArgNo, Attribute::AttrKind Kind) const;
1691 /// Get the attribute of a given kind at a position.
1692 Attribute getAttribute(unsigned i, Attribute::AttrKind Kind) const {
1693 return getAttributes().getAttribute(i, Kind);
1696 /// Get the attribute of a given kind at a position.
1697 Attribute getAttribute(unsigned i, StringRef Kind) const {
1698 return getAttributes().getAttribute(i, Kind);
1701 /// Get the attribute of a given kind from a given arg
1702 Attribute getParamAttr(unsigned ArgNo, Attribute::AttrKind Kind) const {
1703 assert(ArgNo < getNumArgOperands() && "Out of bounds");
1704 return getAttributes().getParamAttr(ArgNo, Kind);
1707 /// Get the attribute of a given kind from a given arg
1708 Attribute getParamAttr(unsigned ArgNo, StringRef Kind) const {
1709 assert(ArgNo < getNumArgOperands() && "Out of bounds");
1710 return getAttributes().getParamAttr(ArgNo, Kind);
1713 /// Return true if the data operand at index \p i has the attribute \p
1716 /// Data operands include call arguments and values used in operand bundles,
1717 /// but does not include the callee operand. This routine dispatches to the
1718 /// underlying AttributeList or the OperandBundleUser as appropriate.
1720 /// The index \p i is interpreted as
1722 /// \p i == Attribute::ReturnIndex -> the return value
1723 /// \p i in [1, arg_size + 1) -> argument number (\p i - 1)
1724 /// \p i in [arg_size + 1, data_operand_size + 1) -> bundle operand at index
1725 /// (\p i - 1) in the operand list.
1726 bool dataOperandHasImpliedAttr(unsigned i, Attribute::AttrKind Kind) const;
1728 /// Extract the alignment of the return value.
1729 unsigned getRetAlignment() const { return Attrs.getRetAlignment(); }
1731 /// Extract the alignment for a call or parameter (0=unknown).
1732 unsigned getParamAlignment(unsigned ArgNo) const {
1733 return Attrs.getParamAlignment(ArgNo);
1736 /// Extract the number of dereferenceable bytes for a call or
1737 /// parameter (0=unknown).
1738 uint64_t getDereferenceableBytes(unsigned i) const {
1739 return Attrs.getDereferenceableBytes(i);
1742 /// Extract the number of dereferenceable_or_null bytes for a call or
1743 /// parameter (0=unknown).
1744 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
1745 return Attrs.getDereferenceableOrNullBytes(i);
1748 /// @brief Determine if the return value is marked with NoAlias attribute.
1749 bool returnDoesNotAlias() const {
1750 return Attrs.hasAttribute(AttributeList::ReturnIndex, Attribute::NoAlias);
1753 /// Return true if the call should not be treated as a call to a
1755 bool isNoBuiltin() const {
1756 return hasFnAttrImpl(Attribute::NoBuiltin) &&
1757 !hasFnAttrImpl(Attribute::Builtin);
1760 /// Return true if the call should not be inlined.
1761 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
1762 void setIsNoInline() {
1763 addAttribute(AttributeList::FunctionIndex, Attribute::NoInline);
1766 /// Return true if the call can return twice
1767 bool canReturnTwice() const {
1768 return hasFnAttr(Attribute::ReturnsTwice);
1770 void setCanReturnTwice() {
1771 addAttribute(AttributeList::FunctionIndex, Attribute::ReturnsTwice);
1774 /// Determine if the call does not access memory.
1775 bool doesNotAccessMemory() const {
1776 return hasFnAttr(Attribute::ReadNone);
1778 void setDoesNotAccessMemory() {
1779 addAttribute(AttributeList::FunctionIndex, Attribute::ReadNone);
1782 /// Determine if the call does not access or only reads memory.
1783 bool onlyReadsMemory() const {
1784 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
1786 void setOnlyReadsMemory() {
1787 addAttribute(AttributeList::FunctionIndex, Attribute::ReadOnly);
1790 /// Determine if the call does not access or only writes memory.
1791 bool doesNotReadMemory() const {
1792 return doesNotAccessMemory() || hasFnAttr(Attribute::WriteOnly);
1794 void setDoesNotReadMemory() {
1795 addAttribute(AttributeList::FunctionIndex, Attribute::WriteOnly);
1798 /// @brief Determine if the call can access memmory only using pointers based
1799 /// on its arguments.
1800 bool onlyAccessesArgMemory() const {
1801 return hasFnAttr(Attribute::ArgMemOnly);
1803 void setOnlyAccessesArgMemory() {
1804 addAttribute(AttributeList::FunctionIndex, Attribute::ArgMemOnly);
1807 /// Determine if the call cannot return.
1808 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
1809 void setDoesNotReturn() {
1810 addAttribute(AttributeList::FunctionIndex, Attribute::NoReturn);
1813 /// Determine if the call cannot unwind.
1814 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
1815 void setDoesNotThrow() {
1816 addAttribute(AttributeList::FunctionIndex, Attribute::NoUnwind);
1819 /// Determine if the call cannot be duplicated.
1820 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
1821 void setCannotDuplicate() {
1822 addAttribute(AttributeList::FunctionIndex, Attribute::NoDuplicate);
1825 /// Determine if the call is convergent
1826 bool isConvergent() const { return hasFnAttr(Attribute::Convergent); }
1827 void setConvergent() {
1828 addAttribute(AttributeList::FunctionIndex, Attribute::Convergent);
1830 void setNotConvergent() {
1831 removeAttribute(AttributeList::FunctionIndex, Attribute::Convergent);
1834 /// Determine if the call returns a structure through first
1835 /// pointer argument.
1836 bool hasStructRetAttr() const {
1837 if (getNumArgOperands() == 0)
1840 // Be friendly and also check the callee.
1841 return paramHasAttr(0, Attribute::StructRet);
1844 /// Determine if any call argument is an aggregate passed by value.
1845 bool hasByValArgument() const {
1846 return Attrs.hasAttrSomewhere(Attribute::ByVal);
1849 /// Return the function called, or null if this is an
1850 /// indirect function invocation.
1852 Function *getCalledFunction() const {
1853 return dyn_cast<Function>(Op<-1>());
1856 /// Get a pointer to the function that is invoked by this
1858 const Value *getCalledValue() const { return Op<-1>(); }
1859 Value *getCalledValue() { return Op<-1>(); }
1861 /// Set the function called.
1862 void setCalledFunction(Value* Fn) {
1864 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
1867 void setCalledFunction(FunctionType *FTy, Value *Fn) {
1869 assert(FTy == cast<FunctionType>(
1870 cast<PointerType>(Fn->getType())->getElementType()));
1874 /// Check if this call is an inline asm statement.
1875 bool isInlineAsm() const {
1876 return isa<InlineAsm>(Op<-1>());
1879 // Methods for support type inquiry through isa, cast, and dyn_cast:
1880 static bool classof(const Instruction *I) {
1881 return I->getOpcode() == Instruction::Call;
1883 static bool classof(const Value *V) {
1884 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1888 template <typename AttrKind> bool hasFnAttrImpl(AttrKind Kind) const {
1889 if (Attrs.hasAttribute(AttributeList::FunctionIndex, Kind))
1892 // Operand bundles override attributes on the called function, but don't
1893 // override attributes directly present on the call instruction.
1894 if (isFnAttrDisallowedByOpBundle(Kind))
1897 if (const Function *F = getCalledFunction())
1898 return F->getAttributes().hasAttribute(AttributeList::FunctionIndex,
1903 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1904 // method so that subclasses cannot accidentally use it.
1905 void setInstructionSubclassData(unsigned short D) {
1906 Instruction::setInstructionSubclassData(D);
1911 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1914 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1915 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1916 BasicBlock *InsertAtEnd)
1918 cast<FunctionType>(cast<PointerType>(Func->getType())
1919 ->getElementType())->getReturnType(),
1920 Instruction::Call, OperandTraits<CallInst>::op_end(this) -
1921 (Args.size() + CountBundleInputs(Bundles) + 1),
1922 unsigned(Args.size() + CountBundleInputs(Bundles) + 1), InsertAtEnd) {
1923 init(Func, Args, Bundles, NameStr);
1926 CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1927 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr,
1928 Instruction *InsertBefore)
1929 : Instruction(Ty->getReturnType(), Instruction::Call,
1930 OperandTraits<CallInst>::op_end(this) -
1931 (Args.size() + CountBundleInputs(Bundles) + 1),
1932 unsigned(Args.size() + CountBundleInputs(Bundles) + 1),
1934 init(Ty, Func, Args, Bundles, NameStr);
1937 // Note: if you get compile errors about private methods then
1938 // please update your code to use the high-level operand
1939 // interfaces. See line 943 above.
1940 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1942 //===----------------------------------------------------------------------===//
1944 //===----------------------------------------------------------------------===//
1946 /// This class represents the LLVM 'select' instruction.
1948 class SelectInst : public Instruction {
1949 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1950 Instruction *InsertBefore)
1951 : Instruction(S1->getType(), Instruction::Select,
1952 &Op<0>(), 3, InsertBefore) {
1957 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1958 BasicBlock *InsertAtEnd)
1959 : Instruction(S1->getType(), Instruction::Select,
1960 &Op<0>(), 3, InsertAtEnd) {
1965 void init(Value *C, Value *S1, Value *S2) {
1966 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1973 // Note: Instruction needs to be a friend here to call cloneImpl.
1974 friend class Instruction;
1976 SelectInst *cloneImpl() const;
1979 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1980 const Twine &NameStr = "",
1981 Instruction *InsertBefore = nullptr,
1982 Instruction *MDFrom = nullptr) {
1983 SelectInst *Sel = new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1985 Sel->copyMetadata(*MDFrom);
1989 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1990 const Twine &NameStr,
1991 BasicBlock *InsertAtEnd) {
1992 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1995 const Value *getCondition() const { return Op<0>(); }
1996 const Value *getTrueValue() const { return Op<1>(); }
1997 const Value *getFalseValue() const { return Op<2>(); }
1998 Value *getCondition() { return Op<0>(); }
1999 Value *getTrueValue() { return Op<1>(); }
2000 Value *getFalseValue() { return Op<2>(); }
2002 void setCondition(Value *V) { Op<0>() = V; }
2003 void setTrueValue(Value *V) { Op<1>() = V; }
2004 void setFalseValue(Value *V) { Op<2>() = V; }
2006 /// Return a string if the specified operands are invalid
2007 /// for a select operation, otherwise return null.
2008 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
2010 /// Transparently provide more efficient getOperand methods.
2011 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2013 OtherOps getOpcode() const {
2014 return static_cast<OtherOps>(Instruction::getOpcode());
2017 // Methods for support type inquiry through isa, cast, and dyn_cast:
2018 static bool classof(const Instruction *I) {
2019 return I->getOpcode() == Instruction::Select;
2021 static bool classof(const Value *V) {
2022 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2027 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
2030 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
2032 //===----------------------------------------------------------------------===//
2034 //===----------------------------------------------------------------------===//
2036 /// This class represents the va_arg llvm instruction, which returns
2037 /// an argument of the specified type given a va_list and increments that list
2039 class VAArgInst : public UnaryInstruction {
2041 // Note: Instruction needs to be a friend here to call cloneImpl.
2042 friend class Instruction;
2044 VAArgInst *cloneImpl() const;
2047 VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
2048 Instruction *InsertBefore = nullptr)
2049 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
2053 VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
2054 BasicBlock *InsertAtEnd)
2055 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
2059 Value *getPointerOperand() { return getOperand(0); }
2060 const Value *getPointerOperand() const { return getOperand(0); }
2061 static unsigned getPointerOperandIndex() { return 0U; }
2063 // Methods for support type inquiry through isa, cast, and dyn_cast:
2064 static bool classof(const Instruction *I) {
2065 return I->getOpcode() == VAArg;
2067 static bool classof(const Value *V) {
2068 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2072 //===----------------------------------------------------------------------===//
2073 // ExtractElementInst Class
2074 //===----------------------------------------------------------------------===//
2076 /// This instruction extracts a single (scalar)
2077 /// element from a VectorType value
2079 class ExtractElementInst : public Instruction {
2080 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
2081 Instruction *InsertBefore = nullptr);
2082 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
2083 BasicBlock *InsertAtEnd);
2086 // Note: Instruction needs to be a friend here to call cloneImpl.
2087 friend class Instruction;
2089 ExtractElementInst *cloneImpl() const;
2092 static ExtractElementInst *Create(Value *Vec, Value *Idx,
2093 const Twine &NameStr = "",
2094 Instruction *InsertBefore = nullptr) {
2095 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
2098 static ExtractElementInst *Create(Value *Vec, Value *Idx,
2099 const Twine &NameStr,
2100 BasicBlock *InsertAtEnd) {
2101 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
2104 /// Return true if an extractelement instruction can be
2105 /// formed with the specified operands.
2106 static bool isValidOperands(const Value *Vec, const Value *Idx);
2108 Value *getVectorOperand() { return Op<0>(); }
2109 Value *getIndexOperand() { return Op<1>(); }
2110 const Value *getVectorOperand() const { return Op<0>(); }
2111 const Value *getIndexOperand() const { return Op<1>(); }
2113 VectorType *getVectorOperandType() const {
2114 return cast<VectorType>(getVectorOperand()->getType());
2117 /// Transparently provide more efficient getOperand methods.
2118 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2120 // Methods for support type inquiry through isa, cast, and dyn_cast:
2121 static bool classof(const Instruction *I) {
2122 return I->getOpcode() == Instruction::ExtractElement;
2124 static bool classof(const Value *V) {
2125 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2130 struct OperandTraits<ExtractElementInst> :
2131 public FixedNumOperandTraits<ExtractElementInst, 2> {
2134 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
2136 //===----------------------------------------------------------------------===//
2137 // InsertElementInst Class
2138 //===----------------------------------------------------------------------===//
2140 /// This instruction inserts a single (scalar)
2141 /// element into a VectorType value
2143 class InsertElementInst : public Instruction {
2144 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
2145 const Twine &NameStr = "",
2146 Instruction *InsertBefore = nullptr);
2147 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx, const Twine &NameStr,
2148 BasicBlock *InsertAtEnd);
2151 // Note: Instruction needs to be a friend here to call cloneImpl.
2152 friend class Instruction;
2154 InsertElementInst *cloneImpl() const;
2157 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
2158 const Twine &NameStr = "",
2159 Instruction *InsertBefore = nullptr) {
2160 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
2163 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
2164 const Twine &NameStr,
2165 BasicBlock *InsertAtEnd) {
2166 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
2169 /// Return true if an insertelement instruction can be
2170 /// formed with the specified operands.
2171 static bool isValidOperands(const Value *Vec, const Value *NewElt,
2174 /// Overload to return most specific vector type.
2176 VectorType *getType() const {
2177 return cast<VectorType>(Instruction::getType());
2180 /// Transparently provide more efficient getOperand methods.
2181 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2183 // Methods for support type inquiry through isa, cast, and dyn_cast:
2184 static bool classof(const Instruction *I) {
2185 return I->getOpcode() == Instruction::InsertElement;
2187 static bool classof(const Value *V) {
2188 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2193 struct OperandTraits<InsertElementInst> :
2194 public FixedNumOperandTraits<InsertElementInst, 3> {
2197 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
2199 //===----------------------------------------------------------------------===//
2200 // ShuffleVectorInst Class
2201 //===----------------------------------------------------------------------===//
2203 /// This instruction constructs a fixed permutation of two
2206 class ShuffleVectorInst : public Instruction {
2208 // Note: Instruction needs to be a friend here to call cloneImpl.
2209 friend class Instruction;
2211 ShuffleVectorInst *cloneImpl() const;
2214 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
2215 const Twine &NameStr = "",
2216 Instruction *InsertBefor = nullptr);
2217 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
2218 const Twine &NameStr, BasicBlock *InsertAtEnd);
2220 // allocate space for exactly three operands
2221 void *operator new(size_t s) {
2222 return User::operator new(s, 3);
2225 /// Return true if a shufflevector instruction can be
2226 /// formed with the specified operands.
2227 static bool isValidOperands(const Value *V1, const Value *V2,
2230 /// Overload to return most specific vector type.
2232 VectorType *getType() const {
2233 return cast<VectorType>(Instruction::getType());
2236 /// Transparently provide more efficient getOperand methods.
2237 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2239 Constant *getMask() const {
2240 return cast<Constant>(getOperand(2));
2243 /// Return the shuffle mask value for the specified element of the mask.
2244 /// Return -1 if the element is undef.
2245 static int getMaskValue(Constant *Mask, unsigned Elt);
2247 /// Return the shuffle mask value of this instruction for the given element
2248 /// index. Return -1 if the element is undef.
2249 int getMaskValue(unsigned Elt) const {
2250 return getMaskValue(getMask(), Elt);
2253 /// Convert the input shuffle mask operand to a vector of integers. Undefined
2254 /// elements of the mask are returned as -1.
2255 static void getShuffleMask(Constant *Mask, SmallVectorImpl<int> &Result);
2257 /// Return the mask for this instruction as a vector of integers. Undefined
2258 /// elements of the mask are returned as -1.
2259 void getShuffleMask(SmallVectorImpl<int> &Result) const {
2260 return getShuffleMask(getMask(), Result);
2263 SmallVector<int, 16> getShuffleMask() const {
2264 SmallVector<int, 16> Mask;
2265 getShuffleMask(Mask);
2269 /// Change values in a shuffle permute mask assuming the two vector operands
2270 /// of length InVecNumElts have swapped position.
2271 static void commuteShuffleMask(MutableArrayRef<int> Mask,
2272 unsigned InVecNumElts) {
2273 for (int &Idx : Mask) {
2276 Idx = Idx < (int)InVecNumElts ? Idx + InVecNumElts : Idx - InVecNumElts;
2277 assert(Idx >= 0 && Idx < (int)InVecNumElts * 2 &&
2278 "shufflevector mask index out of range");
2282 // Methods for support type inquiry through isa, cast, and dyn_cast:
2283 static bool classof(const Instruction *I) {
2284 return I->getOpcode() == Instruction::ShuffleVector;
2286 static bool classof(const Value *V) {
2287 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2292 struct OperandTraits<ShuffleVectorInst> :
2293 public FixedNumOperandTraits<ShuffleVectorInst, 3> {
2296 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
2298 //===----------------------------------------------------------------------===//
2299 // ExtractValueInst Class
2300 //===----------------------------------------------------------------------===//
2302 /// This instruction extracts a struct member or array
2303 /// element value from an aggregate value.
2305 class ExtractValueInst : public UnaryInstruction {
2306 SmallVector<unsigned, 4> Indices;
2308 ExtractValueInst(const ExtractValueInst &EVI);
2310 /// Constructors - Create a extractvalue instruction with a base aggregate
2311 /// value and a list of indices. The first ctor can optionally insert before
2312 /// an existing instruction, the second appends the new instruction to the
2313 /// specified BasicBlock.
2314 inline ExtractValueInst(Value *Agg,
2315 ArrayRef<unsigned> Idxs,
2316 const Twine &NameStr,
2317 Instruction *InsertBefore);
2318 inline ExtractValueInst(Value *Agg,
2319 ArrayRef<unsigned> Idxs,
2320 const Twine &NameStr, BasicBlock *InsertAtEnd);
2322 void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
2325 // Note: Instruction needs to be a friend here to call cloneImpl.
2326 friend class Instruction;
2328 ExtractValueInst *cloneImpl() const;
2331 static ExtractValueInst *Create(Value *Agg,
2332 ArrayRef<unsigned> Idxs,
2333 const Twine &NameStr = "",
2334 Instruction *InsertBefore = nullptr) {
2336 ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
2339 static ExtractValueInst *Create(Value *Agg,
2340 ArrayRef<unsigned> Idxs,
2341 const Twine &NameStr,
2342 BasicBlock *InsertAtEnd) {
2343 return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
2346 /// Returns the type of the element that would be extracted
2347 /// with an extractvalue instruction with the specified parameters.
2349 /// Null is returned if the indices are invalid for the specified type.
2350 static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
2352 using idx_iterator = const unsigned*;
2354 inline idx_iterator idx_begin() const { return Indices.begin(); }
2355 inline idx_iterator idx_end() const { return Indices.end(); }
2356 inline iterator_range<idx_iterator> indices() const {
2357 return make_range(idx_begin(), idx_end());
2360 Value *getAggregateOperand() {
2361 return getOperand(0);
2363 const Value *getAggregateOperand() const {
2364 return getOperand(0);
2366 static unsigned getAggregateOperandIndex() {
2367 return 0U; // get index for modifying correct operand
2370 ArrayRef<unsigned> getIndices() const {
2374 unsigned getNumIndices() const {
2375 return (unsigned)Indices.size();
2378 bool hasIndices() const {
2382 // Methods for support type inquiry through isa, cast, and dyn_cast:
2383 static bool classof(const Instruction *I) {
2384 return I->getOpcode() == Instruction::ExtractValue;
2386 static bool classof(const Value *V) {
2387 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2391 ExtractValueInst::ExtractValueInst(Value *Agg,
2392 ArrayRef<unsigned> Idxs,
2393 const Twine &NameStr,
2394 Instruction *InsertBefore)
2395 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2396 ExtractValue, Agg, InsertBefore) {
2397 init(Idxs, NameStr);
2400 ExtractValueInst::ExtractValueInst(Value *Agg,
2401 ArrayRef<unsigned> Idxs,
2402 const Twine &NameStr,
2403 BasicBlock *InsertAtEnd)
2404 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2405 ExtractValue, Agg, InsertAtEnd) {
2406 init(Idxs, NameStr);
2409 //===----------------------------------------------------------------------===//
2410 // InsertValueInst Class
2411 //===----------------------------------------------------------------------===//
2413 /// This instruction inserts a struct field of array element
2414 /// value into an aggregate value.
2416 class InsertValueInst : public Instruction {
2417 SmallVector<unsigned, 4> Indices;
2419 InsertValueInst(const InsertValueInst &IVI);
2421 /// Constructors - Create a insertvalue instruction with a base aggregate
2422 /// value, a value to insert, and a list of indices. The first ctor can
2423 /// optionally insert before an existing instruction, the second appends
2424 /// the new instruction to the specified BasicBlock.
2425 inline InsertValueInst(Value *Agg, Value *Val,
2426 ArrayRef<unsigned> Idxs,
2427 const Twine &NameStr,
2428 Instruction *InsertBefore);
2429 inline InsertValueInst(Value *Agg, Value *Val,
2430 ArrayRef<unsigned> Idxs,
2431 const Twine &NameStr, BasicBlock *InsertAtEnd);
2433 /// Constructors - These two constructors are convenience methods because one
2434 /// and two index insertvalue instructions are so common.
2435 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
2436 const Twine &NameStr = "",
2437 Instruction *InsertBefore = nullptr);
2438 InsertValueInst(Value *Agg, Value *Val, unsigned Idx, const Twine &NameStr,
2439 BasicBlock *InsertAtEnd);
2441 void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
2442 const Twine &NameStr);
2445 // Note: Instruction needs to be a friend here to call cloneImpl.
2446 friend class Instruction;
2448 InsertValueInst *cloneImpl() const;
2451 // allocate space for exactly two operands
2452 void *operator new(size_t s) {
2453 return User::operator new(s, 2);
2456 static InsertValueInst *Create(Value *Agg, Value *Val,
2457 ArrayRef<unsigned> Idxs,
2458 const Twine &NameStr = "",
2459 Instruction *InsertBefore = nullptr) {
2460 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
2463 static InsertValueInst *Create(Value *Agg, Value *Val,
2464 ArrayRef<unsigned> Idxs,
2465 const Twine &NameStr,
2466 BasicBlock *InsertAtEnd) {
2467 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
2470 /// Transparently provide more efficient getOperand methods.
2471 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2473 using idx_iterator = const unsigned*;
2475 inline idx_iterator idx_begin() const { return Indices.begin(); }
2476 inline idx_iterator idx_end() const { return Indices.end(); }
2477 inline iterator_range<idx_iterator> indices() const {
2478 return make_range(idx_begin(), idx_end());
2481 Value *getAggregateOperand() {
2482 return getOperand(0);
2484 const Value *getAggregateOperand() const {
2485 return getOperand(0);
2487 static unsigned getAggregateOperandIndex() {
2488 return 0U; // get index for modifying correct operand
2491 Value *getInsertedValueOperand() {
2492 return getOperand(1);
2494 const Value *getInsertedValueOperand() const {
2495 return getOperand(1);
2497 static unsigned getInsertedValueOperandIndex() {
2498 return 1U; // get index for modifying correct operand
2501 ArrayRef<unsigned> getIndices() const {
2505 unsigned getNumIndices() const {
2506 return (unsigned)Indices.size();
2509 bool hasIndices() const {
2513 // Methods for support type inquiry through isa, cast, and dyn_cast:
2514 static bool classof(const Instruction *I) {
2515 return I->getOpcode() == Instruction::InsertValue;
2517 static bool classof(const Value *V) {
2518 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2523 struct OperandTraits<InsertValueInst> :
2524 public FixedNumOperandTraits<InsertValueInst, 2> {
2527 InsertValueInst::InsertValueInst(Value *Agg,
2529 ArrayRef<unsigned> Idxs,
2530 const Twine &NameStr,
2531 Instruction *InsertBefore)
2532 : Instruction(Agg->getType(), InsertValue,
2533 OperandTraits<InsertValueInst>::op_begin(this),
2535 init(Agg, Val, Idxs, NameStr);
2538 InsertValueInst::InsertValueInst(Value *Agg,
2540 ArrayRef<unsigned> Idxs,
2541 const Twine &NameStr,
2542 BasicBlock *InsertAtEnd)
2543 : Instruction(Agg->getType(), InsertValue,
2544 OperandTraits<InsertValueInst>::op_begin(this),
2546 init(Agg, Val, Idxs, NameStr);
2549 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
2551 //===----------------------------------------------------------------------===//
2553 //===----------------------------------------------------------------------===//
2555 // PHINode - The PHINode class is used to represent the magical mystical PHI
2556 // node, that can not exist in nature, but can be synthesized in a computer
2557 // scientist's overactive imagination.
2559 class PHINode : public Instruction {
2560 /// The number of operands actually allocated. NumOperands is
2561 /// the number actually in use.
2562 unsigned ReservedSpace;
2564 PHINode(const PHINode &PN);
2566 explicit PHINode(Type *Ty, unsigned NumReservedValues,
2567 const Twine &NameStr = "",
2568 Instruction *InsertBefore = nullptr)
2569 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertBefore),
2570 ReservedSpace(NumReservedValues) {
2572 allocHungoffUses(ReservedSpace);
2575 PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
2576 BasicBlock *InsertAtEnd)
2577 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertAtEnd),
2578 ReservedSpace(NumReservedValues) {
2580 allocHungoffUses(ReservedSpace);
2584 // Note: Instruction needs to be a friend here to call cloneImpl.
2585 friend class Instruction;
2587 PHINode *cloneImpl() const;
2589 // allocHungoffUses - this is more complicated than the generic
2590 // User::allocHungoffUses, because we have to allocate Uses for the incoming
2591 // values and pointers to the incoming blocks, all in one allocation.
2592 void allocHungoffUses(unsigned N) {
2593 User::allocHungoffUses(N, /* IsPhi */ true);
2597 /// Constructors - NumReservedValues is a hint for the number of incoming
2598 /// edges that this phi node will have (use 0 if you really have no idea).
2599 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2600 const Twine &NameStr = "",
2601 Instruction *InsertBefore = nullptr) {
2602 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2605 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2606 const Twine &NameStr, BasicBlock *InsertAtEnd) {
2607 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2610 /// Provide fast operand accessors
2611 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2613 // Block iterator interface. This provides access to the list of incoming
2614 // basic blocks, which parallels the list of incoming values.
2616 using block_iterator = BasicBlock **;
2617 using const_block_iterator = BasicBlock * const *;
2619 block_iterator block_begin() {
2621 reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2622 return reinterpret_cast<block_iterator>(ref + 1);
2625 const_block_iterator block_begin() const {
2626 const Use::UserRef *ref =
2627 reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2628 return reinterpret_cast<const_block_iterator>(ref + 1);
2631 block_iterator block_end() {
2632 return block_begin() + getNumOperands();
2635 const_block_iterator block_end() const {
2636 return block_begin() + getNumOperands();
2639 iterator_range<block_iterator> blocks() {
2640 return make_range(block_begin(), block_end());
2643 iterator_range<const_block_iterator> blocks() const {
2644 return make_range(block_begin(), block_end());
2647 op_range incoming_values() { return operands(); }
2649 const_op_range incoming_values() const { return operands(); }
2651 /// Return the number of incoming edges
2653 unsigned getNumIncomingValues() const { return getNumOperands(); }
2655 /// Return incoming value number x
2657 Value *getIncomingValue(unsigned i) const {
2658 return getOperand(i);
2660 void setIncomingValue(unsigned i, Value *V) {
2661 assert(V && "PHI node got a null value!");
2662 assert(getType() == V->getType() &&
2663 "All operands to PHI node must be the same type as the PHI node!");
2667 static unsigned getOperandNumForIncomingValue(unsigned i) {
2671 static unsigned getIncomingValueNumForOperand(unsigned i) {
2675 /// Return incoming basic block number @p i.
2677 BasicBlock *getIncomingBlock(unsigned i) const {
2678 return block_begin()[i];
2681 /// Return incoming basic block corresponding
2682 /// to an operand of the PHI.
2684 BasicBlock *getIncomingBlock(const Use &U) const {
2685 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2686 return getIncomingBlock(unsigned(&U - op_begin()));
2689 /// Return incoming basic block corresponding
2690 /// to value use iterator.
2692 BasicBlock *getIncomingBlock(Value::const_user_iterator I) const {
2693 return getIncomingBlock(I.getUse());
2696 void setIncomingBlock(unsigned i, BasicBlock *BB) {
2697 assert(BB && "PHI node got a null basic block!");
2698 block_begin()[i] = BB;
2701 /// Add an incoming value to the end of the PHI list
2703 void addIncoming(Value *V, BasicBlock *BB) {
2704 if (getNumOperands() == ReservedSpace)
2705 growOperands(); // Get more space!
2706 // Initialize some new operands.
2707 setNumHungOffUseOperands(getNumOperands() + 1);
2708 setIncomingValue(getNumOperands() - 1, V);
2709 setIncomingBlock(getNumOperands() - 1, BB);
2712 /// Remove an incoming value. This is useful if a
2713 /// predecessor basic block is deleted. The value removed is returned.
2715 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2716 /// is true), the PHI node is destroyed and any uses of it are replaced with
2717 /// dummy values. The only time there should be zero incoming values to a PHI
2718 /// node is when the block is dead, so this strategy is sound.
2720 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2722 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2723 int Idx = getBasicBlockIndex(BB);
2724 assert(Idx >= 0 && "Invalid basic block argument to remove!");
2725 return removeIncomingValue(Idx, DeletePHIIfEmpty);
2728 /// Return the first index of the specified basic
2729 /// block in the value list for this PHI. Returns -1 if no instance.
2731 int getBasicBlockIndex(const BasicBlock *BB) const {
2732 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2733 if (block_begin()[i] == BB)
2738 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2739 int Idx = getBasicBlockIndex(BB);
2740 assert(Idx >= 0 && "Invalid basic block argument!");
2741 return getIncomingValue(Idx);
2744 /// If the specified PHI node always merges together the
2745 /// same value, return the value, otherwise return null.
2746 Value *hasConstantValue() const;
2748 /// Whether the specified PHI node always merges
2749 /// together the same value, assuming undefs are equal to a unique
2750 /// non-undef value.
2751 bool hasConstantOrUndefValue() const;
2753 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2754 static bool classof(const Instruction *I) {
2755 return I->getOpcode() == Instruction::PHI;
2757 static bool classof(const Value *V) {
2758 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2762 void growOperands();
2766 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2769 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2771 //===----------------------------------------------------------------------===//
2772 // LandingPadInst Class
2773 //===----------------------------------------------------------------------===//
2775 //===---------------------------------------------------------------------------
2776 /// The landingpad instruction holds all of the information
2777 /// necessary to generate correct exception handling. The landingpad instruction
2778 /// cannot be moved from the top of a landing pad block, which itself is
2779 /// accessible only from the 'unwind' edge of an invoke. This uses the
2780 /// SubclassData field in Value to store whether or not the landingpad is a
2783 class LandingPadInst : public Instruction {
2784 /// The number of operands actually allocated. NumOperands is
2785 /// the number actually in use.
2786 unsigned ReservedSpace;
2788 LandingPadInst(const LandingPadInst &LP);
2791 enum ClauseType { Catch, Filter };
2794 explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues,
2795 const Twine &NameStr, Instruction *InsertBefore);
2796 explicit LandingPadInst(Type *RetTy, unsigned NumReservedValues,
2797 const Twine &NameStr, BasicBlock *InsertAtEnd);
2799 // Allocate space for exactly zero operands.
2800 void *operator new(size_t s) {
2801 return User::operator new(s);
2804 void growOperands(unsigned Size);
2805 void init(unsigned NumReservedValues, const Twine &NameStr);
2808 // Note: Instruction needs to be a friend here to call cloneImpl.
2809 friend class Instruction;
2811 LandingPadInst *cloneImpl() const;
2814 /// Constructors - NumReservedClauses is a hint for the number of incoming
2815 /// clauses that this landingpad will have (use 0 if you really have no idea).
2816 static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses,
2817 const Twine &NameStr = "",
2818 Instruction *InsertBefore = nullptr);
2819 static LandingPadInst *Create(Type *RetTy, unsigned NumReservedClauses,
2820 const Twine &NameStr, BasicBlock *InsertAtEnd);
2822 /// Provide fast operand accessors
2823 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2825 /// Return 'true' if this landingpad instruction is a
2826 /// cleanup. I.e., it should be run when unwinding even if its landing pad
2827 /// doesn't catch the exception.
2828 bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2830 /// Indicate that this landingpad instruction is a cleanup.
2831 void setCleanup(bool V) {
2832 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2836 /// Add a catch or filter clause to the landing pad.
2837 void addClause(Constant *ClauseVal);
2839 /// Get the value of the clause at index Idx. Use isCatch/isFilter to
2840 /// determine what type of clause this is.
2841 Constant *getClause(unsigned Idx) const {
2842 return cast<Constant>(getOperandList()[Idx]);
2845 /// Return 'true' if the clause and index Idx is a catch clause.
2846 bool isCatch(unsigned Idx) const {
2847 return !isa<ArrayType>(getOperandList()[Idx]->getType());
2850 /// Return 'true' if the clause and index Idx is a filter clause.
2851 bool isFilter(unsigned Idx) const {
2852 return isa<ArrayType>(getOperandList()[Idx]->getType());
2855 /// Get the number of clauses for this landing pad.
2856 unsigned getNumClauses() const { return getNumOperands(); }
2858 /// Grow the size of the operand list to accommodate the new
2859 /// number of clauses.
2860 void reserveClauses(unsigned Size) { growOperands(Size); }
2862 // Methods for support type inquiry through isa, cast, and dyn_cast:
2863 static bool classof(const Instruction *I) {
2864 return I->getOpcode() == Instruction::LandingPad;
2866 static bool classof(const Value *V) {
2867 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2872 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<1> {
2875 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2877 //===----------------------------------------------------------------------===//
2879 //===----------------------------------------------------------------------===//
2881 //===---------------------------------------------------------------------------
2882 /// Return a value (possibly void), from a function. Execution
2883 /// does not continue in this function any longer.
2885 class ReturnInst : public TerminatorInst {
2886 ReturnInst(const ReturnInst &RI);
2889 // ReturnInst constructors:
2890 // ReturnInst() - 'ret void' instruction
2891 // ReturnInst( null) - 'ret void' instruction
2892 // ReturnInst(Value* X) - 'ret X' instruction
2893 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2894 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2895 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2896 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2898 // NOTE: If the Value* passed is of type void then the constructor behaves as
2899 // if it was passed NULL.
2900 explicit ReturnInst(LLVMContext &C, Value *retVal = nullptr,
2901 Instruction *InsertBefore = nullptr);
2902 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2903 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2906 // Note: Instruction needs to be a friend here to call cloneImpl.
2907 friend class Instruction;
2909 ReturnInst *cloneImpl() const;
2912 static ReturnInst* Create(LLVMContext &C, Value *retVal = nullptr,
2913 Instruction *InsertBefore = nullptr) {
2914 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2917 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2918 BasicBlock *InsertAtEnd) {
2919 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2922 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2923 return new(0) ReturnInst(C, InsertAtEnd);
2926 /// Provide fast operand accessors
2927 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2929 /// Convenience accessor. Returns null if there is no return value.
2930 Value *getReturnValue() const {
2931 return getNumOperands() != 0 ? getOperand(0) : nullptr;
2934 unsigned getNumSuccessors() const { return 0; }
2936 // Methods for support type inquiry through isa, cast, and dyn_cast:
2937 static bool classof(const Instruction *I) {
2938 return (I->getOpcode() == Instruction::Ret);
2940 static bool classof(const Value *V) {
2941 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2945 friend TerminatorInst;
2947 BasicBlock *getSuccessor(unsigned idx) const {
2948 llvm_unreachable("ReturnInst has no successors!");
2951 void setSuccessor(unsigned idx, BasicBlock *B) {
2952 llvm_unreachable("ReturnInst has no successors!");
2957 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2960 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2962 //===----------------------------------------------------------------------===//
2964 //===----------------------------------------------------------------------===//
2966 //===---------------------------------------------------------------------------
2967 /// Conditional or Unconditional Branch instruction.
2969 class BranchInst : public TerminatorInst {
2970 /// Ops list - Branches are strange. The operands are ordered:
2971 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2972 /// they don't have to check for cond/uncond branchness. These are mostly
2973 /// accessed relative from op_end().
2974 BranchInst(const BranchInst &BI);
2975 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2976 // BranchInst(BB *B) - 'br B'
2977 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2978 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2979 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2980 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2981 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2982 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = nullptr);
2983 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2984 Instruction *InsertBefore = nullptr);
2985 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2986 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2987 BasicBlock *InsertAtEnd);
2992 // Note: Instruction needs to be a friend here to call cloneImpl.
2993 friend class Instruction;
2995 BranchInst *cloneImpl() const;
2998 static BranchInst *Create(BasicBlock *IfTrue,
2999 Instruction *InsertBefore = nullptr) {
3000 return new(1) BranchInst(IfTrue, InsertBefore);
3003 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
3004 Value *Cond, Instruction *InsertBefore = nullptr) {
3005 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
3008 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
3009 return new(1) BranchInst(IfTrue, InsertAtEnd);
3012 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
3013 Value *Cond, BasicBlock *InsertAtEnd) {
3014 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
3017 /// Transparently provide more efficient getOperand methods.
3018 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3020 bool isUnconditional() const { return getNumOperands() == 1; }
3021 bool isConditional() const { return getNumOperands() == 3; }
3023 Value *getCondition() const {
3024 assert(isConditional() && "Cannot get condition of an uncond branch!");
3028 void setCondition(Value *V) {
3029 assert(isConditional() && "Cannot set condition of unconditional branch!");
3033 unsigned getNumSuccessors() const { return 1+isConditional(); }
3035 BasicBlock *getSuccessor(unsigned i) const {
3036 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
3037 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
3040 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3041 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
3042 *(&Op<-1>() - idx) = NewSucc;
3045 /// Swap the successors of this branch instruction.
3047 /// Swaps the successors of the branch instruction. This also swaps any
3048 /// branch weight metadata associated with the instruction so that it
3049 /// continues to map correctly to each operand.
3050 void swapSuccessors();
3052 // Methods for support type inquiry through isa, cast, and dyn_cast:
3053 static bool classof(const Instruction *I) {
3054 return (I->getOpcode() == Instruction::Br);
3056 static bool classof(const Value *V) {
3057 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3062 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
3065 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
3067 //===----------------------------------------------------------------------===//
3069 //===----------------------------------------------------------------------===//
3071 //===---------------------------------------------------------------------------
3074 class SwitchInst : public TerminatorInst {
3075 unsigned ReservedSpace;
3077 // Operand[0] = Value to switch on
3078 // Operand[1] = Default basic block destination
3079 // Operand[2n ] = Value to match
3080 // Operand[2n+1] = BasicBlock to go to on match
3081 SwitchInst(const SwitchInst &SI);
3083 /// Create a new switch instruction, specifying a value to switch on and a
3084 /// default destination. The number of additional cases can be specified here
3085 /// to make memory allocation more efficient. This constructor can also
3086 /// auto-insert before another instruction.
3087 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
3088 Instruction *InsertBefore);
3090 /// Create a new switch instruction, specifying a value to switch on and a
3091 /// default destination. The number of additional cases can be specified here
3092 /// to make memory allocation more efficient. This constructor also
3093 /// auto-inserts at the end of the specified BasicBlock.
3094 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
3095 BasicBlock *InsertAtEnd);
3097 // allocate space for exactly zero operands
3098 void *operator new(size_t s) {
3099 return User::operator new(s);
3102 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
3103 void growOperands();
3106 // Note: Instruction needs to be a friend here to call cloneImpl.
3107 friend class Instruction;
3109 SwitchInst *cloneImpl() const;
3113 static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
3115 template <typename CaseHandleT> class CaseIteratorImpl;
3117 /// A handle to a particular switch case. It exposes a convenient interface
3118 /// to both the case value and the successor block.
3120 /// We define this as a template and instantiate it to form both a const and
3121 /// non-const handle.
3122 template <typename SwitchInstT, typename ConstantIntT, typename BasicBlockT>
3123 class CaseHandleImpl {
3124 // Directly befriend both const and non-const iterators.
3125 friend class SwitchInst::CaseIteratorImpl<
3126 CaseHandleImpl<SwitchInstT, ConstantIntT, BasicBlockT>>;
3129 // Expose the switch type we're parameterized with to the iterator.
3130 using SwitchInstType = SwitchInstT;
3135 CaseHandleImpl() = default;
3136 CaseHandleImpl(SwitchInstT *SI, ptrdiff_t Index) : SI(SI), Index(Index) {}
3139 /// Resolves case value for current case.
3140 ConstantIntT *getCaseValue() const {
3141 assert((unsigned)Index < SI->getNumCases() &&
3142 "Index out the number of cases.");
3143 return reinterpret_cast<ConstantIntT *>(SI->getOperand(2 + Index * 2));
3146 /// Resolves successor for current case.
3147 BasicBlockT *getCaseSuccessor() const {
3148 assert(((unsigned)Index < SI->getNumCases() ||
3149 (unsigned)Index == DefaultPseudoIndex) &&
3150 "Index out the number of cases.");
3151 return SI->getSuccessor(getSuccessorIndex());
3154 /// Returns number of current case.
3155 unsigned getCaseIndex() const { return Index; }
3157 /// Returns TerminatorInst's successor index for current case successor.
3158 unsigned getSuccessorIndex() const {
3159 assert(((unsigned)Index == DefaultPseudoIndex ||
3160 (unsigned)Index < SI->getNumCases()) &&
3161 "Index out the number of cases.");
3162 return (unsigned)Index != DefaultPseudoIndex ? Index + 1 : 0;
3165 bool operator==(const CaseHandleImpl &RHS) const {
3166 assert(SI == RHS.SI && "Incompatible operators.");
3167 return Index == RHS.Index;
3171 using ConstCaseHandle =
3172 CaseHandleImpl<const SwitchInst, const ConstantInt, const BasicBlock>;
3175 : public CaseHandleImpl<SwitchInst, ConstantInt, BasicBlock> {
3176 friend class SwitchInst::CaseIteratorImpl<CaseHandle>;
3179 CaseHandle(SwitchInst *SI, ptrdiff_t Index) : CaseHandleImpl(SI, Index) {}
3181 /// Sets the new value for current case.
3182 void setValue(ConstantInt *V) {
3183 assert((unsigned)Index < SI->getNumCases() &&
3184 "Index out the number of cases.");
3185 SI->setOperand(2 + Index*2, reinterpret_cast<Value*>(V));
3188 /// Sets the new successor for current case.
3189 void setSuccessor(BasicBlock *S) {
3190 SI->setSuccessor(getSuccessorIndex(), S);
3194 template <typename CaseHandleT>
3195 class CaseIteratorImpl
3196 : public iterator_facade_base<CaseIteratorImpl<CaseHandleT>,
3197 std::random_access_iterator_tag,
3199 using SwitchInstT = typename CaseHandleT::SwitchInstType;
3204 /// Default constructed iterator is in an invalid state until assigned to
3205 /// a case for a particular switch.
3206 CaseIteratorImpl() = default;
3208 /// Initializes case iterator for given SwitchInst and for given
3210 CaseIteratorImpl(SwitchInstT *SI, unsigned CaseNum) : Case(SI, CaseNum) {}
3212 /// Initializes case iterator for given SwitchInst and for given
3213 /// TerminatorInst's successor index.
3214 static CaseIteratorImpl fromSuccessorIndex(SwitchInstT *SI,
3215 unsigned SuccessorIndex) {
3216 assert(SuccessorIndex < SI->getNumSuccessors() &&
3217 "Successor index # out of range!");
3218 return SuccessorIndex != 0 ? CaseIteratorImpl(SI, SuccessorIndex - 1)
3219 : CaseIteratorImpl(SI, DefaultPseudoIndex);
3222 /// Support converting to the const variant. This will be a no-op for const
3224 operator CaseIteratorImpl<ConstCaseHandle>() const {
3225 return CaseIteratorImpl<ConstCaseHandle>(Case.SI, Case.Index);
3228 CaseIteratorImpl &operator+=(ptrdiff_t N) {
3229 // Check index correctness after addition.
3230 // Note: Index == getNumCases() means end().
3231 assert(Case.Index + N >= 0 &&
3232 (unsigned)(Case.Index + N) <= Case.SI->getNumCases() &&
3233 "Case.Index out the number of cases.");
3237 CaseIteratorImpl &operator-=(ptrdiff_t N) {
3238 // Check index correctness after subtraction.
3239 // Note: Case.Index == getNumCases() means end().
3240 assert(Case.Index - N >= 0 &&
3241 (unsigned)(Case.Index - N) <= Case.SI->getNumCases() &&
3242 "Case.Index out the number of cases.");
3246 ptrdiff_t operator-(const CaseIteratorImpl &RHS) const {
3247 assert(Case.SI == RHS.Case.SI && "Incompatible operators.");
3248 return Case.Index - RHS.Case.Index;
3250 bool operator==(const CaseIteratorImpl &RHS) const {
3251 return Case == RHS.Case;
3253 bool operator<(const CaseIteratorImpl &RHS) const {
3254 assert(Case.SI == RHS.Case.SI && "Incompatible operators.");
3255 return Case.Index < RHS.Case.Index;
3257 CaseHandleT &operator*() { return Case; }
3258 const CaseHandleT &operator*() const { return Case; }
3261 using CaseIt = CaseIteratorImpl<CaseHandle>;
3262 using ConstCaseIt = CaseIteratorImpl<ConstCaseHandle>;
3264 static SwitchInst *Create(Value *Value, BasicBlock *Default,
3266 Instruction *InsertBefore = nullptr) {
3267 return new SwitchInst(Value, Default, NumCases, InsertBefore);
3270 static SwitchInst *Create(Value *Value, BasicBlock *Default,
3271 unsigned NumCases, BasicBlock *InsertAtEnd) {
3272 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
3275 /// Provide fast operand accessors
3276 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3278 // Accessor Methods for Switch stmt
3279 Value *getCondition() const { return getOperand(0); }
3280 void setCondition(Value *V) { setOperand(0, V); }
3282 BasicBlock *getDefaultDest() const {
3283 return cast<BasicBlock>(getOperand(1));
3286 void setDefaultDest(BasicBlock *DefaultCase) {
3287 setOperand(1, reinterpret_cast<Value*>(DefaultCase));
3290 /// Return the number of 'cases' in this switch instruction, excluding the
3292 unsigned getNumCases() const {
3293 return getNumOperands()/2 - 1;
3296 /// Returns a read/write iterator that points to the first case in the
3298 CaseIt case_begin() {
3299 return CaseIt(this, 0);
3302 /// Returns a read-only iterator that points to the first case in the
3304 ConstCaseIt case_begin() const {
3305 return ConstCaseIt(this, 0);
3308 /// Returns a read/write iterator that points one past the last in the
3311 return CaseIt(this, getNumCases());
3314 /// Returns a read-only iterator that points one past the last in the
3316 ConstCaseIt case_end() const {
3317 return ConstCaseIt(this, getNumCases());
3320 /// Iteration adapter for range-for loops.
3321 iterator_range<CaseIt> cases() {
3322 return make_range(case_begin(), case_end());
3325 /// Constant iteration adapter for range-for loops.
3326 iterator_range<ConstCaseIt> cases() const {
3327 return make_range(case_begin(), case_end());
3330 /// Returns an iterator that points to the default case.
3331 /// Note: this iterator allows to resolve successor only. Attempt
3332 /// to resolve case value causes an assertion.
3333 /// Also note, that increment and decrement also causes an assertion and
3334 /// makes iterator invalid.
3335 CaseIt case_default() {
3336 return CaseIt(this, DefaultPseudoIndex);
3338 ConstCaseIt case_default() const {
3339 return ConstCaseIt(this, DefaultPseudoIndex);
3342 /// Search all of the case values for the specified constant. If it is
3343 /// explicitly handled, return the case iterator of it, otherwise return
3344 /// default case iterator to indicate that it is handled by the default
3346 CaseIt findCaseValue(const ConstantInt *C) {
3347 CaseIt I = llvm::find_if(
3348 cases(), [C](CaseHandle &Case) { return Case.getCaseValue() == C; });
3349 if (I != case_end())
3352 return case_default();
3354 ConstCaseIt findCaseValue(const ConstantInt *C) const {
3355 ConstCaseIt I = llvm::find_if(cases(), [C](ConstCaseHandle &Case) {
3356 return Case.getCaseValue() == C;
3358 if (I != case_end())
3361 return case_default();
3364 /// Finds the unique case value for a given successor. Returns null if the
3365 /// successor is not found, not unique, or is the default case.
3366 ConstantInt *findCaseDest(BasicBlock *BB) {
3367 if (BB == getDefaultDest())
3370 ConstantInt *CI = nullptr;
3371 for (auto Case : cases()) {
3372 if (Case.getCaseSuccessor() != BB)
3376 return nullptr; // Multiple cases lead to BB.
3378 CI = Case.getCaseValue();
3384 /// Add an entry to the switch instruction.
3386 /// This action invalidates case_end(). Old case_end() iterator will
3387 /// point to the added case.
3388 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
3390 /// This method removes the specified case and its successor from the switch
3391 /// instruction. Note that this operation may reorder the remaining cases at
3392 /// index idx and above.
3394 /// This action invalidates iterators for all cases following the one removed,
3395 /// including the case_end() iterator. It returns an iterator for the next
3397 CaseIt removeCase(CaseIt I);
3399 unsigned getNumSuccessors() const { return getNumOperands()/2; }
3400 BasicBlock *getSuccessor(unsigned idx) const {
3401 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
3402 return cast<BasicBlock>(getOperand(idx*2+1));
3404 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3405 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
3406 setOperand(idx * 2 + 1, NewSucc);
3409 // Methods for support type inquiry through isa, cast, and dyn_cast:
3410 static bool classof(const Instruction *I) {
3411 return I->getOpcode() == Instruction::Switch;
3413 static bool classof(const Value *V) {
3414 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3419 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
3422 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
3424 //===----------------------------------------------------------------------===//
3425 // IndirectBrInst Class
3426 //===----------------------------------------------------------------------===//
3428 //===---------------------------------------------------------------------------
3429 /// Indirect Branch Instruction.
3431 class IndirectBrInst : public TerminatorInst {
3432 unsigned ReservedSpace;
3434 // Operand[0] = Address to jump to
3435 // Operand[n+1] = n-th destination
3436 IndirectBrInst(const IndirectBrInst &IBI);
3438 /// Create a new indirectbr instruction, specifying an
3439 /// Address to jump to. The number of expected destinations can be specified
3440 /// here to make memory allocation more efficient. This constructor can also
3441 /// autoinsert before another instruction.
3442 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
3444 /// Create a new indirectbr instruction, specifying an
3445 /// Address to jump to. The number of expected destinations can be specified
3446 /// here to make memory allocation more efficient. This constructor also
3447 /// autoinserts at the end of the specified BasicBlock.
3448 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
3450 // allocate space for exactly zero operands
3451 void *operator new(size_t s) {
3452 return User::operator new(s);
3455 void init(Value *Address, unsigned NumDests);
3456 void growOperands();
3459 // Note: Instruction needs to be a friend here to call cloneImpl.
3460 friend class Instruction;
3462 IndirectBrInst *cloneImpl() const;
3465 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3466 Instruction *InsertBefore = nullptr) {
3467 return new IndirectBrInst(Address, NumDests, InsertBefore);
3470 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3471 BasicBlock *InsertAtEnd) {
3472 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
3475 /// Provide fast operand accessors.
3476 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3478 // Accessor Methods for IndirectBrInst instruction.
3479 Value *getAddress() { return getOperand(0); }
3480 const Value *getAddress() const { return getOperand(0); }
3481 void setAddress(Value *V) { setOperand(0, V); }
3483 /// return the number of possible destinations in this
3484 /// indirectbr instruction.
3485 unsigned getNumDestinations() const { return getNumOperands()-1; }
3487 /// Return the specified destination.
3488 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
3489 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
3491 /// Add a destination.
3493 void addDestination(BasicBlock *Dest);
3495 /// This method removes the specified successor from the
3496 /// indirectbr instruction.
3497 void removeDestination(unsigned i);
3499 unsigned getNumSuccessors() const { return getNumOperands()-1; }
3500 BasicBlock *getSuccessor(unsigned i) const {
3501 return cast<BasicBlock>(getOperand(i+1));
3503 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
3504 setOperand(i + 1, NewSucc);
3507 // Methods for support type inquiry through isa, cast, and dyn_cast:
3508 static bool classof(const Instruction *I) {
3509 return I->getOpcode() == Instruction::IndirectBr;
3511 static bool classof(const Value *V) {
3512 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3517 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
3520 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
3522 //===----------------------------------------------------------------------===//
3524 //===----------------------------------------------------------------------===//
3526 /// Invoke instruction. The SubclassData field is used to hold the
3527 /// calling convention of the call.
3529 class InvokeInst : public TerminatorInst,
3530 public OperandBundleUser<InvokeInst, User::op_iterator> {
3531 friend class OperandBundleUser<InvokeInst, User::op_iterator>;
3533 AttributeList Attrs;
3536 InvokeInst(const InvokeInst &BI);
3538 /// Construct an InvokeInst given a range of arguments.
3540 /// Construct an InvokeInst from a range of arguments
3541 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3542 ArrayRef<Value *> Args, ArrayRef<OperandBundleDef> Bundles,
3543 unsigned Values, const Twine &NameStr,
3544 Instruction *InsertBefore)
3545 : InvokeInst(cast<FunctionType>(
3546 cast<PointerType>(Func->getType())->getElementType()),
3547 Func, IfNormal, IfException, Args, Bundles, Values, NameStr,
3550 inline InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3551 BasicBlock *IfException, ArrayRef<Value *> Args,
3552 ArrayRef<OperandBundleDef> Bundles, unsigned Values,
3553 const Twine &NameStr, Instruction *InsertBefore);
3554 /// Construct an InvokeInst given a range of arguments.
3556 /// Construct an InvokeInst from a range of arguments
3557 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3558 ArrayRef<Value *> Args, ArrayRef<OperandBundleDef> Bundles,
3559 unsigned Values, const Twine &NameStr,
3560 BasicBlock *InsertAtEnd);
3562 bool hasDescriptor() const { return HasDescriptor; }
3564 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3565 ArrayRef<Value *> Args, ArrayRef<OperandBundleDef> Bundles,
3566 const Twine &NameStr) {
3567 init(cast<FunctionType>(
3568 cast<PointerType>(Func->getType())->getElementType()),
3569 Func, IfNormal, IfException, Args, Bundles, NameStr);
3572 void init(FunctionType *FTy, Value *Func, BasicBlock *IfNormal,
3573 BasicBlock *IfException, ArrayRef<Value *> Args,
3574 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr);
3577 // Note: Instruction needs to be a friend here to call cloneImpl.
3578 friend class Instruction;
3580 InvokeInst *cloneImpl() const;
3583 static InvokeInst *Create(Value *Func, BasicBlock *IfNormal,
3584 BasicBlock *IfException, ArrayRef<Value *> Args,
3585 const Twine &NameStr,
3586 Instruction *InsertBefore = nullptr) {
3587 return Create(cast<FunctionType>(
3588 cast<PointerType>(Func->getType())->getElementType()),
3589 Func, IfNormal, IfException, Args, None, NameStr,
3593 static InvokeInst *Create(Value *Func, BasicBlock *IfNormal,
3594 BasicBlock *IfException, ArrayRef<Value *> Args,
3595 ArrayRef<OperandBundleDef> Bundles = None,
3596 const Twine &NameStr = "",
3597 Instruction *InsertBefore = nullptr) {
3598 return Create(cast<FunctionType>(
3599 cast<PointerType>(Func->getType())->getElementType()),
3600 Func, IfNormal, IfException, Args, Bundles, NameStr,
3604 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3605 BasicBlock *IfException, ArrayRef<Value *> Args,
3606 const Twine &NameStr,
3607 Instruction *InsertBefore = nullptr) {
3608 unsigned Values = unsigned(Args.size()) + 3;
3609 return new (Values) InvokeInst(Ty, Func, IfNormal, IfException, Args, None,
3610 Values, NameStr, InsertBefore);
3613 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3614 BasicBlock *IfException, ArrayRef<Value *> Args,
3615 ArrayRef<OperandBundleDef> Bundles = None,
3616 const Twine &NameStr = "",
3617 Instruction *InsertBefore = nullptr) {
3618 unsigned Values = unsigned(Args.size()) + CountBundleInputs(Bundles) + 3;
3619 unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
3621 return new (Values, DescriptorBytes)
3622 InvokeInst(Ty, Func, IfNormal, IfException, Args, Bundles, Values,
3623 NameStr, InsertBefore);
3626 static InvokeInst *Create(Value *Func,
3627 BasicBlock *IfNormal, BasicBlock *IfException,
3628 ArrayRef<Value *> Args, const Twine &NameStr,
3629 BasicBlock *InsertAtEnd) {
3630 unsigned Values = unsigned(Args.size()) + 3;
3631 return new (Values) InvokeInst(Func, IfNormal, IfException, Args, None,
3632 Values, NameStr, InsertAtEnd);
3635 static InvokeInst *Create(Value *Func, BasicBlock *IfNormal,
3636 BasicBlock *IfException, ArrayRef<Value *> Args,
3637 ArrayRef<OperandBundleDef> Bundles,
3638 const Twine &NameStr, BasicBlock *InsertAtEnd) {
3639 unsigned Values = unsigned(Args.size()) + CountBundleInputs(Bundles) + 3;
3640 unsigned DescriptorBytes = Bundles.size() * sizeof(BundleOpInfo);
3642 return new (Values, DescriptorBytes)
3643 InvokeInst(Func, IfNormal, IfException, Args, Bundles, Values, NameStr,
3647 /// Create a clone of \p II with a different set of operand bundles and
3648 /// insert it before \p InsertPt.
3650 /// The returned invoke instruction is identical to \p II in every way except
3651 /// that the operand bundles for the new instruction are set to the operand
3652 /// bundles in \p Bundles.
3653 static InvokeInst *Create(InvokeInst *II, ArrayRef<OperandBundleDef> Bundles,
3654 Instruction *InsertPt = nullptr);
3656 /// Provide fast operand accessors
3657 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3659 FunctionType *getFunctionType() const { return FTy; }
3661 void mutateFunctionType(FunctionType *FTy) {
3662 mutateType(FTy->getReturnType());
3666 /// Return the number of invoke arguments.
3668 unsigned getNumArgOperands() const {
3669 return getNumOperands() - getNumTotalBundleOperands() - 3;
3672 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
3674 Value *getArgOperand(unsigned i) const {
3675 assert(i < getNumArgOperands() && "Out of bounds!");
3676 return getOperand(i);
3678 void setArgOperand(unsigned i, Value *v) {
3679 assert(i < getNumArgOperands() && "Out of bounds!");
3683 /// Return the iterator pointing to the beginning of the argument list.
3684 op_iterator arg_begin() { return op_begin(); }
3686 /// Return the iterator pointing to the end of the argument list.
3687 op_iterator arg_end() {
3688 // [ invoke args ], [ operand bundles ], normal dest, unwind dest, callee
3689 return op_end() - getNumTotalBundleOperands() - 3;
3692 /// Iteration adapter for range-for loops.
3693 iterator_range<op_iterator> arg_operands() {
3694 return make_range(arg_begin(), arg_end());
3697 /// Return the iterator pointing to the beginning of the argument list.
3698 const_op_iterator arg_begin() const { return op_begin(); }
3700 /// Return the iterator pointing to the end of the argument list.
3701 const_op_iterator arg_end() const {
3702 // [ invoke args ], [ operand bundles ], normal dest, unwind dest, callee
3703 return op_end() - getNumTotalBundleOperands() - 3;
3706 /// Iteration adapter for range-for loops.
3707 iterator_range<const_op_iterator> arg_operands() const {
3708 return make_range(arg_begin(), arg_end());
3711 /// Wrappers for getting the \c Use of a invoke argument.
3712 const Use &getArgOperandUse(unsigned i) const {
3713 assert(i < getNumArgOperands() && "Out of bounds!");
3714 return getOperandUse(i);
3716 Use &getArgOperandUse(unsigned i) {
3717 assert(i < getNumArgOperands() && "Out of bounds!");
3718 return getOperandUse(i);
3721 /// If one of the arguments has the 'returned' attribute, return its
3722 /// operand value. Otherwise, return nullptr.
3723 Value *getReturnedArgOperand() const;
3725 /// getCallingConv/setCallingConv - Get or set the calling convention of this
3727 CallingConv::ID getCallingConv() const {
3728 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
3730 void setCallingConv(CallingConv::ID CC) {
3731 auto ID = static_cast<unsigned>(CC);
3732 assert(!(ID & ~CallingConv::MaxID) && "Unsupported calling convention");
3733 setInstructionSubclassData(ID);
3736 /// Return the parameter attributes for this invoke.
3738 AttributeList getAttributes() const { return Attrs; }
3740 /// Set the parameter attributes for this invoke.
3742 void setAttributes(AttributeList A) { Attrs = A; }
3744 /// adds the attribute to the list of attributes.
3745 void addAttribute(unsigned i, Attribute::AttrKind Kind);
3747 /// adds the attribute to the list of attributes.
3748 void addAttribute(unsigned i, Attribute Attr);
3750 /// Adds the attribute to the indicated argument
3751 void addParamAttr(unsigned ArgNo, Attribute::AttrKind Kind);
3753 /// removes the attribute from the list of attributes.
3754 void removeAttribute(unsigned i, Attribute::AttrKind Kind);
3756 /// removes the attribute from the list of attributes.
3757 void removeAttribute(unsigned i, StringRef Kind);
3759 /// Removes the attribute from the given argument
3760 void removeParamAttr(unsigned ArgNo, Attribute::AttrKind Kind);
3762 /// adds the dereferenceable attribute to the list of attributes.
3763 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
3765 /// adds the dereferenceable_or_null attribute to the list of
3767 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
3769 /// Determine whether this call has the given attribute.
3770 bool hasFnAttr(Attribute::AttrKind Kind) const {
3771 assert(Kind != Attribute::NoBuiltin &&
3772 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
3773 return hasFnAttrImpl(Kind);
3776 /// Determine whether this call has the given attribute.
3777 bool hasFnAttr(StringRef Kind) const {
3778 return hasFnAttrImpl(Kind);
3781 /// Determine whether the return value has the given attribute.
3782 bool hasRetAttr(Attribute::AttrKind Kind) const;
3784 /// Determine whether the argument or parameter has the given attribute.
3785 bool paramHasAttr(unsigned ArgNo, Attribute::AttrKind Kind) const;
3787 /// Get the attribute of a given kind at a position.
3788 Attribute getAttribute(unsigned i, Attribute::AttrKind Kind) const {
3789 return getAttributes().getAttribute(i, Kind);
3792 /// Get the attribute of a given kind at a position.
3793 Attribute getAttribute(unsigned i, StringRef Kind) const {
3794 return getAttributes().getAttribute(i, Kind);
3797 /// Return true if the data operand at index \p i has the attribute \p
3800 /// Data operands include invoke arguments and values used in operand bundles,
3801 /// but does not include the invokee operand, or the two successor blocks.
3802 /// This routine dispatches to the underlying AttributeList or the
3803 /// OperandBundleUser as appropriate.
3805 /// The index \p i is interpreted as
3807 /// \p i == Attribute::ReturnIndex -> the return value
3808 /// \p i in [1, arg_size + 1) -> argument number (\p i - 1)
3809 /// \p i in [arg_size + 1, data_operand_size + 1) -> bundle operand at index
3810 /// (\p i - 1) in the operand list.
3811 bool dataOperandHasImpliedAttr(unsigned i, Attribute::AttrKind Kind) const;
3813 /// Extract the alignment of the return value.
3814 unsigned getRetAlignment() const { return Attrs.getRetAlignment(); }
3816 /// Extract the alignment for a call or parameter (0=unknown).
3817 unsigned getParamAlignment(unsigned ArgNo) const {
3818 return Attrs.getParamAlignment(ArgNo);
3821 /// Extract the number of dereferenceable bytes for a call or
3822 /// parameter (0=unknown).
3823 uint64_t getDereferenceableBytes(unsigned i) const {
3824 return Attrs.getDereferenceableBytes(i);
3827 /// Extract the number of dereferenceable_or_null bytes for a call or
3828 /// parameter (0=unknown).
3829 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
3830 return Attrs.getDereferenceableOrNullBytes(i);
3833 /// @brief Determine if the return value is marked with NoAlias attribute.
3834 bool returnDoesNotAlias() const {
3835 return Attrs.hasAttribute(AttributeList::ReturnIndex, Attribute::NoAlias);
3838 /// Return true if the call should not be treated as a call to a
3840 bool isNoBuiltin() const {
3841 // We assert in hasFnAttr if one passes in Attribute::NoBuiltin, so we have
3842 // to check it by hand.
3843 return hasFnAttrImpl(Attribute::NoBuiltin) &&
3844 !hasFnAttrImpl(Attribute::Builtin);
3847 /// Return true if the call should not be inlined.
3848 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
3849 void setIsNoInline() {
3850 addAttribute(AttributeList::FunctionIndex, Attribute::NoInline);
3853 /// Determine if the call does not access memory.
3854 bool doesNotAccessMemory() const {
3855 return hasFnAttr(Attribute::ReadNone);
3857 void setDoesNotAccessMemory() {
3858 addAttribute(AttributeList::FunctionIndex, Attribute::ReadNone);
3861 /// Determine if the call does not access or only reads memory.
3862 bool onlyReadsMemory() const {
3863 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
3865 void setOnlyReadsMemory() {
3866 addAttribute(AttributeList::FunctionIndex, Attribute::ReadOnly);
3869 /// Determine if the call does not access or only writes memory.
3870 bool doesNotReadMemory() const {
3871 return doesNotAccessMemory() || hasFnAttr(Attribute::WriteOnly);
3873 void setDoesNotReadMemory() {
3874 addAttribute(AttributeList::FunctionIndex, Attribute::WriteOnly);
3877 /// @brief Determine if the call access memmory only using it's pointer
3879 bool onlyAccessesArgMemory() const {
3880 return hasFnAttr(Attribute::ArgMemOnly);
3882 void setOnlyAccessesArgMemory() {
3883 addAttribute(AttributeList::FunctionIndex, Attribute::ArgMemOnly);
3886 /// Determine if the call cannot return.
3887 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
3888 void setDoesNotReturn() {
3889 addAttribute(AttributeList::FunctionIndex, Attribute::NoReturn);
3892 /// Determine if the call cannot unwind.
3893 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
3894 void setDoesNotThrow() {
3895 addAttribute(AttributeList::FunctionIndex, Attribute::NoUnwind);
3898 /// Determine if the invoke cannot be duplicated.
3899 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
3900 void setCannotDuplicate() {
3901 addAttribute(AttributeList::FunctionIndex, Attribute::NoDuplicate);
3904 /// Determine if the invoke is convergent
3905 bool isConvergent() const { return hasFnAttr(Attribute::Convergent); }
3906 void setConvergent() {
3907 addAttribute(AttributeList::FunctionIndex, Attribute::Convergent);
3909 void setNotConvergent() {
3910 removeAttribute(AttributeList::FunctionIndex, Attribute::Convergent);
3913 /// Determine if the call returns a structure through first
3914 /// pointer argument.
3915 bool hasStructRetAttr() const {
3916 if (getNumArgOperands() == 0)
3919 // Be friendly and also check the callee.
3920 return paramHasAttr(0, Attribute::StructRet);
3923 /// Determine if any call argument is an aggregate passed by value.
3924 bool hasByValArgument() const {
3925 return Attrs.hasAttrSomewhere(Attribute::ByVal);
3928 /// Return the function called, or null if this is an
3929 /// indirect function invocation.
3931 Function *getCalledFunction() const {
3932 return dyn_cast<Function>(Op<-3>());
3935 /// Get a pointer to the function that is invoked by this
3937 const Value *getCalledValue() const { return Op<-3>(); }
3938 Value *getCalledValue() { return Op<-3>(); }
3940 /// Set the function called.
3941 void setCalledFunction(Value* Fn) {
3943 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
3946 void setCalledFunction(FunctionType *FTy, Value *Fn) {
3948 assert(FTy == cast<FunctionType>(
3949 cast<PointerType>(Fn->getType())->getElementType()));
3953 // get*Dest - Return the destination basic blocks...
3954 BasicBlock *getNormalDest() const {
3955 return cast<BasicBlock>(Op<-2>());
3957 BasicBlock *getUnwindDest() const {
3958 return cast<BasicBlock>(Op<-1>());
3960 void setNormalDest(BasicBlock *B) {
3961 Op<-2>() = reinterpret_cast<Value*>(B);
3963 void setUnwindDest(BasicBlock *B) {
3964 Op<-1>() = reinterpret_cast<Value*>(B);
3967 /// Get the landingpad instruction from the landing pad
3968 /// block (the unwind destination).
3969 LandingPadInst *getLandingPadInst() const;
3971 BasicBlock *getSuccessor(unsigned i) const {
3972 assert(i < 2 && "Successor # out of range for invoke!");
3973 return i == 0 ? getNormalDest() : getUnwindDest();
3976 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3977 assert(idx < 2 && "Successor # out of range for invoke!");
3978 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
3981 unsigned getNumSuccessors() const { return 2; }
3983 // Methods for support type inquiry through isa, cast, and dyn_cast:
3984 static bool classof(const Instruction *I) {
3985 return (I->getOpcode() == Instruction::Invoke);
3987 static bool classof(const Value *V) {
3988 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3992 template <typename AttrKind> bool hasFnAttrImpl(AttrKind Kind) const {
3993 if (Attrs.hasAttribute(AttributeList::FunctionIndex, Kind))
3996 // Operand bundles override attributes on the called function, but don't
3997 // override attributes directly present on the invoke instruction.
3998 if (isFnAttrDisallowedByOpBundle(Kind))
4001 if (const Function *F = getCalledFunction())
4002 return F->getAttributes().hasAttribute(AttributeList::FunctionIndex,
4007 // Shadow Instruction::setInstructionSubclassData with a private forwarding
4008 // method so that subclasses cannot accidentally use it.
4009 void setInstructionSubclassData(unsigned short D) {
4010 Instruction::setInstructionSubclassData(D);
4015 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
4018 InvokeInst::InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
4019 BasicBlock *IfException, ArrayRef<Value *> Args,
4020 ArrayRef<OperandBundleDef> Bundles, unsigned Values,
4021 const Twine &NameStr, Instruction *InsertBefore)
4022 : TerminatorInst(Ty->getReturnType(), Instruction::Invoke,
4023 OperandTraits<InvokeInst>::op_end(this) - Values, Values,
4025 init(Ty, Func, IfNormal, IfException, Args, Bundles, NameStr);
4028 InvokeInst::InvokeInst(Value *Func, BasicBlock *IfNormal,
4029 BasicBlock *IfException, ArrayRef<Value *> Args,
4030 ArrayRef<OperandBundleDef> Bundles, unsigned Values,
4031 const Twine &NameStr, BasicBlock *InsertAtEnd)
4033 cast<FunctionType>(cast<PointerType>(Func->getType())
4034 ->getElementType())->getReturnType(),
4035 Instruction::Invoke, OperandTraits<InvokeInst>::op_end(this) - Values,
4036 Values, InsertAtEnd) {
4037 init(Func, IfNormal, IfException, Args, Bundles, NameStr);
4040 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
4042 //===----------------------------------------------------------------------===//
4044 //===----------------------------------------------------------------------===//
4046 //===---------------------------------------------------------------------------
4047 /// Resume the propagation of an exception.
4049 class ResumeInst : public TerminatorInst {
4050 ResumeInst(const ResumeInst &RI);
4052 explicit ResumeInst(Value *Exn, Instruction *InsertBefore=nullptr);
4053 ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
4056 // Note: Instruction needs to be a friend here to call cloneImpl.
4057 friend class Instruction;
4059 ResumeInst *cloneImpl() const;
4062 static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = nullptr) {
4063 return new(1) ResumeInst(Exn, InsertBefore);
4066 static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
4067 return new(1) ResumeInst(Exn, InsertAtEnd);
4070 /// Provide fast operand accessors
4071 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4073 /// Convenience accessor.
4074 Value *getValue() const { return Op<0>(); }
4076 unsigned getNumSuccessors() const { return 0; }
4078 // Methods for support type inquiry through isa, cast, and dyn_cast:
4079 static bool classof(const Instruction *I) {
4080 return I->getOpcode() == Instruction::Resume;
4082 static bool classof(const Value *V) {
4083 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4087 friend TerminatorInst;
4089 BasicBlock *getSuccessor(unsigned idx) const {
4090 llvm_unreachable("ResumeInst has no successors!");
4093 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
4094 llvm_unreachable("ResumeInst has no successors!");
4099 struct OperandTraits<ResumeInst> :
4100 public FixedNumOperandTraits<ResumeInst, 1> {
4103 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
4105 //===----------------------------------------------------------------------===//
4106 // CatchSwitchInst Class
4107 //===----------------------------------------------------------------------===//
4108 class CatchSwitchInst : public TerminatorInst {
4109 /// The number of operands actually allocated. NumOperands is
4110 /// the number actually in use.
4111 unsigned ReservedSpace;
4113 // Operand[0] = Outer scope
4114 // Operand[1] = Unwind block destination
4115 // Operand[n] = BasicBlock to go to on match
4116 CatchSwitchInst(const CatchSwitchInst &CSI);
4118 /// Create a new switch instruction, specifying a
4119 /// default destination. The number of additional handlers can be specified
4120 /// here to make memory allocation more efficient.
4121 /// This constructor can also autoinsert before another instruction.
4122 CatchSwitchInst(Value *ParentPad, BasicBlock *UnwindDest,
4123 unsigned NumHandlers, const Twine &NameStr,
4124 Instruction *InsertBefore);
4126 /// Create a new switch instruction, specifying a
4127 /// default destination. The number of additional handlers can be specified
4128 /// here to make memory allocation more efficient.
4129 /// This constructor also autoinserts at the end of the specified BasicBlock.
4130 CatchSwitchInst(Value *ParentPad, BasicBlock *UnwindDest,
4131 unsigned NumHandlers, const Twine &NameStr,
4132 BasicBlock *InsertAtEnd);
4134 // allocate space for exactly zero operands
4135 void *operator new(size_t s) { return User::operator new(s); }
4137 void init(Value *ParentPad, BasicBlock *UnwindDest, unsigned NumReserved);
4138 void growOperands(unsigned Size);
4141 // Note: Instruction needs to be a friend here to call cloneImpl.
4142 friend class Instruction;
4144 CatchSwitchInst *cloneImpl() const;
4147 static CatchSwitchInst *Create(Value *ParentPad, BasicBlock *UnwindDest,
4148 unsigned NumHandlers,
4149 const Twine &NameStr = "",
4150 Instruction *InsertBefore = nullptr) {
4151 return new CatchSwitchInst(ParentPad, UnwindDest, NumHandlers, NameStr,
4155 static CatchSwitchInst *Create(Value *ParentPad, BasicBlock *UnwindDest,
4156 unsigned NumHandlers, const Twine &NameStr,
4157 BasicBlock *InsertAtEnd) {
4158 return new CatchSwitchInst(ParentPad, UnwindDest, NumHandlers, NameStr,
4162 /// Provide fast operand accessors
4163 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4165 // Accessor Methods for CatchSwitch stmt
4166 Value *getParentPad() const { return getOperand(0); }
4167 void setParentPad(Value *ParentPad) { setOperand(0, ParentPad); }
4169 // Accessor Methods for CatchSwitch stmt
4170 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
4171 bool unwindsToCaller() const { return !hasUnwindDest(); }
4172 BasicBlock *getUnwindDest() const {
4173 if (hasUnwindDest())
4174 return cast<BasicBlock>(getOperand(1));
4177 void setUnwindDest(BasicBlock *UnwindDest) {
4179 assert(hasUnwindDest());
4180 setOperand(1, UnwindDest);
4183 /// return the number of 'handlers' in this catchswitch
4184 /// instruction, except the default handler
4185 unsigned getNumHandlers() const {
4186 if (hasUnwindDest())
4187 return getNumOperands() - 2;
4188 return getNumOperands() - 1;
4192 static BasicBlock *handler_helper(Value *V) { return cast<BasicBlock>(V); }
4193 static const BasicBlock *handler_helper(const Value *V) {
4194 return cast<BasicBlock>(V);
4198 using DerefFnTy = std::pointer_to_unary_function<Value *, BasicBlock *>;
4199 using handler_iterator = mapped_iterator<op_iterator, DerefFnTy>;
4200 using handler_range = iterator_range<handler_iterator>;
4201 using ConstDerefFnTy =
4202 std::pointer_to_unary_function<const Value *, const BasicBlock *>;
4203 using const_handler_iterator =
4204 mapped_iterator<const_op_iterator, ConstDerefFnTy>;
4205 using const_handler_range = iterator_range<const_handler_iterator>;
4207 /// Returns an iterator that points to the first handler in CatchSwitchInst.
4208 handler_iterator handler_begin() {
4209 op_iterator It = op_begin() + 1;
4210 if (hasUnwindDest())
4212 return handler_iterator(It, DerefFnTy(handler_helper));
4215 /// Returns an iterator that points to the first handler in the
4216 /// CatchSwitchInst.
4217 const_handler_iterator handler_begin() const {
4218 const_op_iterator It = op_begin() + 1;
4219 if (hasUnwindDest())
4221 return const_handler_iterator(It, ConstDerefFnTy(handler_helper));
4224 /// Returns a read-only iterator that points one past the last
4225 /// handler in the CatchSwitchInst.
4226 handler_iterator handler_end() {
4227 return handler_iterator(op_end(), DerefFnTy(handler_helper));
4230 /// Returns an iterator that points one past the last handler in the
4231 /// CatchSwitchInst.
4232 const_handler_iterator handler_end() const {
4233 return const_handler_iterator(op_end(), ConstDerefFnTy(handler_helper));
4236 /// iteration adapter for range-for loops.
4237 handler_range handlers() {
4238 return make_range(handler_begin(), handler_end());
4241 /// iteration adapter for range-for loops.
4242 const_handler_range handlers() const {
4243 return make_range(handler_begin(), handler_end());
4246 /// Add an entry to the switch instruction...
4248 /// This action invalidates handler_end(). Old handler_end() iterator will
4249 /// point to the added handler.
4250 void addHandler(BasicBlock *Dest);
4252 void removeHandler(handler_iterator HI);
4254 unsigned getNumSuccessors() const { return getNumOperands() - 1; }
4255 BasicBlock *getSuccessor(unsigned Idx) const {
4256 assert(Idx < getNumSuccessors() &&
4257 "Successor # out of range for catchswitch!");
4258 return cast<BasicBlock>(getOperand(Idx + 1));
4260 void setSuccessor(unsigned Idx, BasicBlock *NewSucc) {
4261 assert(Idx < getNumSuccessors() &&
4262 "Successor # out of range for catchswitch!");
4263 setOperand(Idx + 1, NewSucc);
4266 // Methods for support type inquiry through isa, cast, and dyn_cast:
4267 static bool classof(const Instruction *I) {
4268 return I->getOpcode() == Instruction::CatchSwitch;
4270 static bool classof(const Value *V) {
4271 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4276 struct OperandTraits<CatchSwitchInst> : public HungoffOperandTraits<2> {};
4278 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchSwitchInst, Value)
4280 //===----------------------------------------------------------------------===//
4281 // CleanupPadInst Class
4282 //===----------------------------------------------------------------------===//
4283 class CleanupPadInst : public FuncletPadInst {
4285 explicit CleanupPadInst(Value *ParentPad, ArrayRef<Value *> Args,
4286 unsigned Values, const Twine &NameStr,
4287 Instruction *InsertBefore)
4288 : FuncletPadInst(Instruction::CleanupPad, ParentPad, Args, Values,
4289 NameStr, InsertBefore) {}
4290 explicit CleanupPadInst(Value *ParentPad, ArrayRef<Value *> Args,
4291 unsigned Values, const Twine &NameStr,
4292 BasicBlock *InsertAtEnd)
4293 : FuncletPadInst(Instruction::CleanupPad, ParentPad, Args, Values,
4294 NameStr, InsertAtEnd) {}
4297 static CleanupPadInst *Create(Value *ParentPad, ArrayRef<Value *> Args = None,
4298 const Twine &NameStr = "",
4299 Instruction *InsertBefore = nullptr) {
4300 unsigned Values = 1 + Args.size();
4302 CleanupPadInst(ParentPad, Args, Values, NameStr, InsertBefore);
4305 static CleanupPadInst *Create(Value *ParentPad, ArrayRef<Value *> Args,
4306 const Twine &NameStr, BasicBlock *InsertAtEnd) {
4307 unsigned Values = 1 + Args.size();
4309 CleanupPadInst(ParentPad, Args, Values, NameStr, InsertAtEnd);
4312 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4313 static bool classof(const Instruction *I) {
4314 return I->getOpcode() == Instruction::CleanupPad;
4316 static bool classof(const Value *V) {
4317 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4321 //===----------------------------------------------------------------------===//
4322 // CatchPadInst Class
4323 //===----------------------------------------------------------------------===//
4324 class CatchPadInst : public FuncletPadInst {
4326 explicit CatchPadInst(Value *CatchSwitch, ArrayRef<Value *> Args,
4327 unsigned Values, const Twine &NameStr,
4328 Instruction *InsertBefore)
4329 : FuncletPadInst(Instruction::CatchPad, CatchSwitch, Args, Values,
4330 NameStr, InsertBefore) {}
4331 explicit CatchPadInst(Value *CatchSwitch, ArrayRef<Value *> Args,
4332 unsigned Values, const Twine &NameStr,
4333 BasicBlock *InsertAtEnd)
4334 : FuncletPadInst(Instruction::CatchPad, CatchSwitch, Args, Values,
4335 NameStr, InsertAtEnd) {}
4338 static CatchPadInst *Create(Value *CatchSwitch, ArrayRef<Value *> Args,
4339 const Twine &NameStr = "",
4340 Instruction *InsertBefore = nullptr) {
4341 unsigned Values = 1 + Args.size();
4343 CatchPadInst(CatchSwitch, Args, Values, NameStr, InsertBefore);
4346 static CatchPadInst *Create(Value *CatchSwitch, ArrayRef<Value *> Args,
4347 const Twine &NameStr, BasicBlock *InsertAtEnd) {
4348 unsigned Values = 1 + Args.size();
4350 CatchPadInst(CatchSwitch, Args, Values, NameStr, InsertAtEnd);
4353 /// Convenience accessors
4354 CatchSwitchInst *getCatchSwitch() const {
4355 return cast<CatchSwitchInst>(Op<-1>());
4357 void setCatchSwitch(Value *CatchSwitch) {
4358 assert(CatchSwitch);
4359 Op<-1>() = CatchSwitch;
4362 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4363 static bool classof(const Instruction *I) {
4364 return I->getOpcode() == Instruction::CatchPad;
4366 static bool classof(const Value *V) {
4367 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4371 //===----------------------------------------------------------------------===//
4372 // CatchReturnInst Class
4373 //===----------------------------------------------------------------------===//
4375 class CatchReturnInst : public TerminatorInst {
4376 CatchReturnInst(const CatchReturnInst &RI);
4377 CatchReturnInst(Value *CatchPad, BasicBlock *BB, Instruction *InsertBefore);
4378 CatchReturnInst(Value *CatchPad, BasicBlock *BB, BasicBlock *InsertAtEnd);
4380 void init(Value *CatchPad, BasicBlock *BB);
4383 // Note: Instruction needs to be a friend here to call cloneImpl.
4384 friend class Instruction;
4386 CatchReturnInst *cloneImpl() const;
4389 static CatchReturnInst *Create(Value *CatchPad, BasicBlock *BB,
4390 Instruction *InsertBefore = nullptr) {
4393 return new (2) CatchReturnInst(CatchPad, BB, InsertBefore);
4396 static CatchReturnInst *Create(Value *CatchPad, BasicBlock *BB,
4397 BasicBlock *InsertAtEnd) {
4400 return new (2) CatchReturnInst(CatchPad, BB, InsertAtEnd);
4403 /// Provide fast operand accessors
4404 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4406 /// Convenience accessors.
4407 CatchPadInst *getCatchPad() const { return cast<CatchPadInst>(Op<0>()); }
4408 void setCatchPad(CatchPadInst *CatchPad) {
4413 BasicBlock *getSuccessor() const { return cast<BasicBlock>(Op<1>()); }
4414 void setSuccessor(BasicBlock *NewSucc) {
4418 unsigned getNumSuccessors() const { return 1; }
4420 /// Get the parentPad of this catchret's catchpad's catchswitch.
4421 /// The successor block is implicitly a member of this funclet.
4422 Value *getCatchSwitchParentPad() const {
4423 return getCatchPad()->getCatchSwitch()->getParentPad();
4426 // Methods for support type inquiry through isa, cast, and dyn_cast:
4427 static bool classof(const Instruction *I) {
4428 return (I->getOpcode() == Instruction::CatchRet);
4430 static bool classof(const Value *V) {
4431 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4435 friend TerminatorInst;
4437 BasicBlock *getSuccessor(unsigned Idx) const {
4438 assert(Idx < getNumSuccessors() && "Successor # out of range for catchret!");
4439 return getSuccessor();
4442 void setSuccessor(unsigned Idx, BasicBlock *B) {
4443 assert(Idx < getNumSuccessors() && "Successor # out of range for catchret!");
4449 struct OperandTraits<CatchReturnInst>
4450 : public FixedNumOperandTraits<CatchReturnInst, 2> {};
4452 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CatchReturnInst, Value)
4454 //===----------------------------------------------------------------------===//
4455 // CleanupReturnInst Class
4456 //===----------------------------------------------------------------------===//
4458 class CleanupReturnInst : public TerminatorInst {
4460 CleanupReturnInst(const CleanupReturnInst &RI);
4461 CleanupReturnInst(Value *CleanupPad, BasicBlock *UnwindBB, unsigned Values,
4462 Instruction *InsertBefore = nullptr);
4463 CleanupReturnInst(Value *CleanupPad, BasicBlock *UnwindBB, unsigned Values,
4464 BasicBlock *InsertAtEnd);
4466 void init(Value *CleanupPad, BasicBlock *UnwindBB);
4469 // Note: Instruction needs to be a friend here to call cloneImpl.
4470 friend class Instruction;
4472 CleanupReturnInst *cloneImpl() const;
4475 static CleanupReturnInst *Create(Value *CleanupPad,
4476 BasicBlock *UnwindBB = nullptr,
4477 Instruction *InsertBefore = nullptr) {
4479 unsigned Values = 1;
4483 CleanupReturnInst(CleanupPad, UnwindBB, Values, InsertBefore);
4486 static CleanupReturnInst *Create(Value *CleanupPad, BasicBlock *UnwindBB,
4487 BasicBlock *InsertAtEnd) {
4489 unsigned Values = 1;
4493 CleanupReturnInst(CleanupPad, UnwindBB, Values, InsertAtEnd);
4496 /// Provide fast operand accessors
4497 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
4499 bool hasUnwindDest() const { return getSubclassDataFromInstruction() & 1; }
4500 bool unwindsToCaller() const { return !hasUnwindDest(); }
4502 /// Convenience accessor.
4503 CleanupPadInst *getCleanupPad() const {
4504 return cast<CleanupPadInst>(Op<0>());
4506 void setCleanupPad(CleanupPadInst *CleanupPad) {
4508 Op<0>() = CleanupPad;
4511 unsigned getNumSuccessors() const { return hasUnwindDest() ? 1 : 0; }
4513 BasicBlock *getUnwindDest() const {
4514 return hasUnwindDest() ? cast<BasicBlock>(Op<1>()) : nullptr;
4516 void setUnwindDest(BasicBlock *NewDest) {
4518 assert(hasUnwindDest());
4522 // Methods for support type inquiry through isa, cast, and dyn_cast:
4523 static bool classof(const Instruction *I) {
4524 return (I->getOpcode() == Instruction::CleanupRet);
4526 static bool classof(const Value *V) {
4527 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4531 friend TerminatorInst;
4533 BasicBlock *getSuccessor(unsigned Idx) const {
4535 return getUnwindDest();
4538 void setSuccessor(unsigned Idx, BasicBlock *B) {
4543 // Shadow Instruction::setInstructionSubclassData with a private forwarding
4544 // method so that subclasses cannot accidentally use it.
4545 void setInstructionSubclassData(unsigned short D) {
4546 Instruction::setInstructionSubclassData(D);
4551 struct OperandTraits<CleanupReturnInst>
4552 : public VariadicOperandTraits<CleanupReturnInst, /*MINARITY=*/1> {};
4554 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CleanupReturnInst, Value)
4556 //===----------------------------------------------------------------------===//
4557 // UnreachableInst Class
4558 //===----------------------------------------------------------------------===//
4560 //===---------------------------------------------------------------------------
4561 /// This function has undefined behavior. In particular, the
4562 /// presence of this instruction indicates some higher level knowledge that the
4563 /// end of the block cannot be reached.
4565 class UnreachableInst : public TerminatorInst {
4567 // Note: Instruction needs to be a friend here to call cloneImpl.
4568 friend class Instruction;
4570 UnreachableInst *cloneImpl() const;
4573 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = nullptr);
4574 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
4576 // allocate space for exactly zero operands
4577 void *operator new(size_t s) {
4578 return User::operator new(s, 0);
4581 unsigned getNumSuccessors() const { return 0; }
4583 // Methods for support type inquiry through isa, cast, and dyn_cast:
4584 static bool classof(const Instruction *I) {
4585 return I->getOpcode() == Instruction::Unreachable;
4587 static bool classof(const Value *V) {
4588 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4592 friend TerminatorInst;
4594 BasicBlock *getSuccessor(unsigned idx) const {
4595 llvm_unreachable("UnreachableInst has no successors!");
4598 void setSuccessor(unsigned idx, BasicBlock *B) {
4599 llvm_unreachable("UnreachableInst has no successors!");
4603 //===----------------------------------------------------------------------===//
4605 //===----------------------------------------------------------------------===//
4607 /// This class represents a truncation of integer types.
4608 class TruncInst : public CastInst {
4610 // Note: Instruction needs to be a friend here to call cloneImpl.
4611 friend class Instruction;
4613 /// Clone an identical TruncInst
4614 TruncInst *cloneImpl() const;
4617 /// Constructor with insert-before-instruction semantics
4619 Value *S, ///< The value to be truncated
4620 Type *Ty, ///< The (smaller) type to truncate to
4621 const Twine &NameStr = "", ///< A name for the new instruction
4622 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4625 /// Constructor with insert-at-end-of-block semantics
4627 Value *S, ///< The value to be truncated
4628 Type *Ty, ///< The (smaller) type to truncate to
4629 const Twine &NameStr, ///< A name for the new instruction
4630 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4633 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4634 static bool classof(const Instruction *I) {
4635 return I->getOpcode() == Trunc;
4637 static bool classof(const Value *V) {
4638 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4642 //===----------------------------------------------------------------------===//
4644 //===----------------------------------------------------------------------===//
4646 /// This class represents zero extension of integer types.
4647 class ZExtInst : public CastInst {
4649 // Note: Instruction needs to be a friend here to call cloneImpl.
4650 friend class Instruction;
4652 /// Clone an identical ZExtInst
4653 ZExtInst *cloneImpl() const;
4656 /// Constructor with insert-before-instruction semantics
4658 Value *S, ///< The value to be zero extended
4659 Type *Ty, ///< The type to zero extend to
4660 const Twine &NameStr = "", ///< A name for the new instruction
4661 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4664 /// Constructor with insert-at-end semantics.
4666 Value *S, ///< The value to be zero extended
4667 Type *Ty, ///< The type to zero extend to
4668 const Twine &NameStr, ///< A name for the new instruction
4669 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4672 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4673 static bool classof(const Instruction *I) {
4674 return I->getOpcode() == ZExt;
4676 static bool classof(const Value *V) {
4677 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4681 //===----------------------------------------------------------------------===//
4683 //===----------------------------------------------------------------------===//
4685 /// This class represents a sign extension of integer types.
4686 class SExtInst : public CastInst {
4688 // Note: Instruction needs to be a friend here to call cloneImpl.
4689 friend class Instruction;
4691 /// Clone an identical SExtInst
4692 SExtInst *cloneImpl() const;
4695 /// Constructor with insert-before-instruction semantics
4697 Value *S, ///< The value to be sign extended
4698 Type *Ty, ///< The type to sign extend to
4699 const Twine &NameStr = "", ///< A name for the new instruction
4700 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4703 /// Constructor with insert-at-end-of-block semantics
4705 Value *S, ///< The value to be sign extended
4706 Type *Ty, ///< The type to sign extend to
4707 const Twine &NameStr, ///< A name for the new instruction
4708 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4711 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4712 static bool classof(const Instruction *I) {
4713 return I->getOpcode() == SExt;
4715 static bool classof(const Value *V) {
4716 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4720 //===----------------------------------------------------------------------===//
4721 // FPTruncInst Class
4722 //===----------------------------------------------------------------------===//
4724 /// This class represents a truncation of floating point types.
4725 class FPTruncInst : public CastInst {
4727 // Note: Instruction needs to be a friend here to call cloneImpl.
4728 friend class Instruction;
4730 /// Clone an identical FPTruncInst
4731 FPTruncInst *cloneImpl() const;
4734 /// Constructor with insert-before-instruction semantics
4736 Value *S, ///< The value to be truncated
4737 Type *Ty, ///< The type to truncate to
4738 const Twine &NameStr = "", ///< A name for the new instruction
4739 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4742 /// Constructor with insert-before-instruction semantics
4744 Value *S, ///< The value to be truncated
4745 Type *Ty, ///< The type to truncate to
4746 const Twine &NameStr, ///< A name for the new instruction
4747 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4750 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4751 static bool classof(const Instruction *I) {
4752 return I->getOpcode() == FPTrunc;
4754 static bool classof(const Value *V) {
4755 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4759 //===----------------------------------------------------------------------===//
4761 //===----------------------------------------------------------------------===//
4763 /// This class represents an extension of floating point types.
4764 class FPExtInst : public CastInst {
4766 // Note: Instruction needs to be a friend here to call cloneImpl.
4767 friend class Instruction;
4769 /// Clone an identical FPExtInst
4770 FPExtInst *cloneImpl() const;
4773 /// Constructor with insert-before-instruction semantics
4775 Value *S, ///< The value to be extended
4776 Type *Ty, ///< The type to extend to
4777 const Twine &NameStr = "", ///< A name for the new instruction
4778 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4781 /// Constructor with insert-at-end-of-block semantics
4783 Value *S, ///< The value to be extended
4784 Type *Ty, ///< The type to extend to
4785 const Twine &NameStr, ///< A name for the new instruction
4786 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4789 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4790 static bool classof(const Instruction *I) {
4791 return I->getOpcode() == FPExt;
4793 static bool classof(const Value *V) {
4794 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4798 //===----------------------------------------------------------------------===//
4800 //===----------------------------------------------------------------------===//
4802 /// This class represents a cast unsigned integer to floating point.
4803 class UIToFPInst : public CastInst {
4805 // Note: Instruction needs to be a friend here to call cloneImpl.
4806 friend class Instruction;
4808 /// Clone an identical UIToFPInst
4809 UIToFPInst *cloneImpl() const;
4812 /// Constructor with insert-before-instruction semantics
4814 Value *S, ///< The value to be converted
4815 Type *Ty, ///< The type to convert to
4816 const Twine &NameStr = "", ///< A name for the new instruction
4817 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4820 /// Constructor with insert-at-end-of-block semantics
4822 Value *S, ///< The value to be converted
4823 Type *Ty, ///< The type to convert to
4824 const Twine &NameStr, ///< A name for the new instruction
4825 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4828 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4829 static bool classof(const Instruction *I) {
4830 return I->getOpcode() == UIToFP;
4832 static bool classof(const Value *V) {
4833 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4837 //===----------------------------------------------------------------------===//
4839 //===----------------------------------------------------------------------===//
4841 /// This class represents a cast from signed integer to floating point.
4842 class SIToFPInst : public CastInst {
4844 // Note: Instruction needs to be a friend here to call cloneImpl.
4845 friend class Instruction;
4847 /// Clone an identical SIToFPInst
4848 SIToFPInst *cloneImpl() const;
4851 /// Constructor with insert-before-instruction semantics
4853 Value *S, ///< The value to be converted
4854 Type *Ty, ///< The type to convert to
4855 const Twine &NameStr = "", ///< A name for the new instruction
4856 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4859 /// Constructor with insert-at-end-of-block semantics
4861 Value *S, ///< The value to be converted
4862 Type *Ty, ///< The type to convert to
4863 const Twine &NameStr, ///< A name for the new instruction
4864 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4867 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4868 static bool classof(const Instruction *I) {
4869 return I->getOpcode() == SIToFP;
4871 static bool classof(const Value *V) {
4872 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4876 //===----------------------------------------------------------------------===//
4878 //===----------------------------------------------------------------------===//
4880 /// This class represents a cast from floating point to unsigned integer
4881 class FPToUIInst : public CastInst {
4883 // Note: Instruction needs to be a friend here to call cloneImpl.
4884 friend class Instruction;
4886 /// Clone an identical FPToUIInst
4887 FPToUIInst *cloneImpl() const;
4890 /// Constructor with insert-before-instruction semantics
4892 Value *S, ///< The value to be converted
4893 Type *Ty, ///< The type to convert to
4894 const Twine &NameStr = "", ///< A name for the new instruction
4895 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4898 /// Constructor with insert-at-end-of-block semantics
4900 Value *S, ///< The value to be converted
4901 Type *Ty, ///< The type to convert to
4902 const Twine &NameStr, ///< A name for the new instruction
4903 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
4906 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4907 static bool classof(const Instruction *I) {
4908 return I->getOpcode() == FPToUI;
4910 static bool classof(const Value *V) {
4911 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4915 //===----------------------------------------------------------------------===//
4917 //===----------------------------------------------------------------------===//
4919 /// This class represents a cast from floating point to signed integer.
4920 class FPToSIInst : public CastInst {
4922 // Note: Instruction needs to be a friend here to call cloneImpl.
4923 friend class Instruction;
4925 /// Clone an identical FPToSIInst
4926 FPToSIInst *cloneImpl() const;
4929 /// Constructor with insert-before-instruction semantics
4931 Value *S, ///< The value to be converted
4932 Type *Ty, ///< The type to convert to
4933 const Twine &NameStr = "", ///< A name for the new instruction
4934 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4937 /// Constructor with insert-at-end-of-block semantics
4939 Value *S, ///< The value to be converted
4940 Type *Ty, ///< The type to convert to
4941 const Twine &NameStr, ///< A name for the new instruction
4942 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4945 /// Methods for support type inquiry through isa, cast, and dyn_cast:
4946 static bool classof(const Instruction *I) {
4947 return I->getOpcode() == FPToSI;
4949 static bool classof(const Value *V) {
4950 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4954 //===----------------------------------------------------------------------===//
4955 // IntToPtrInst Class
4956 //===----------------------------------------------------------------------===//
4958 /// This class represents a cast from an integer to a pointer.
4959 class IntToPtrInst : public CastInst {
4961 // Note: Instruction needs to be a friend here to call cloneImpl.
4962 friend class Instruction;
4964 /// Constructor with insert-before-instruction semantics
4966 Value *S, ///< The value to be converted
4967 Type *Ty, ///< The type to convert to
4968 const Twine &NameStr = "", ///< A name for the new instruction
4969 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
4972 /// Constructor with insert-at-end-of-block semantics
4974 Value *S, ///< The value to be converted
4975 Type *Ty, ///< The type to convert to
4976 const Twine &NameStr, ///< A name for the new instruction
4977 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
4980 /// Clone an identical IntToPtrInst.
4981 IntToPtrInst *cloneImpl() const;
4983 /// Returns the address space of this instruction's pointer type.
4984 unsigned getAddressSpace() const {
4985 return getType()->getPointerAddressSpace();
4988 // Methods for support type inquiry through isa, cast, and dyn_cast:
4989 static bool classof(const Instruction *I) {
4990 return I->getOpcode() == IntToPtr;
4992 static bool classof(const Value *V) {
4993 return isa<Instruction>(V) && classof(cast<Instruction>(V));
4997 //===----------------------------------------------------------------------===//
4998 // PtrToIntInst Class
4999 //===----------------------------------------------------------------------===//
5001 /// This class represents a cast from a pointer to an integer.
5002 class PtrToIntInst : public CastInst {
5004 // Note: Instruction needs to be a friend here to call cloneImpl.
5005 friend class Instruction;
5007 /// Clone an identical PtrToIntInst.
5008 PtrToIntInst *cloneImpl() const;
5011 /// Constructor with insert-before-instruction semantics
5013 Value *S, ///< The value to be converted
5014 Type *Ty, ///< The type to convert to
5015 const Twine &NameStr = "", ///< A name for the new instruction
5016 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
5019 /// Constructor with insert-at-end-of-block semantics
5021 Value *S, ///< The value to be converted
5022 Type *Ty, ///< The type to convert to
5023 const Twine &NameStr, ///< A name for the new instruction
5024 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
5027 /// Gets the pointer operand.
5028 Value *getPointerOperand() { return getOperand(0); }
5029 /// Gets the pointer operand.
5030 const Value *getPointerOperand() const { return getOperand(0); }
5031 /// Gets the operand index of the pointer operand.
5032 static unsigned getPointerOperandIndex() { return 0U; }
5034 /// Returns the address space of the pointer operand.
5035 unsigned getPointerAddressSpace() const {
5036 return getPointerOperand()->getType()->getPointerAddressSpace();
5039 // Methods for support type inquiry through isa, cast, and dyn_cast:
5040 static bool classof(const Instruction *I) {
5041 return I->getOpcode() == PtrToInt;
5043 static bool classof(const Value *V) {
5044 return isa<Instruction>(V) && classof(cast<Instruction>(V));
5048 //===----------------------------------------------------------------------===//
5049 // BitCastInst Class
5050 //===----------------------------------------------------------------------===//
5052 /// This class represents a no-op cast from one type to another.
5053 class BitCastInst : public CastInst {
5055 // Note: Instruction needs to be a friend here to call cloneImpl.
5056 friend class Instruction;
5058 /// Clone an identical BitCastInst.
5059 BitCastInst *cloneImpl() const;
5062 /// Constructor with insert-before-instruction semantics
5064 Value *S, ///< The value to be casted
5065 Type *Ty, ///< The type to casted to
5066 const Twine &NameStr = "", ///< A name for the new instruction
5067 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
5070 /// Constructor with insert-at-end-of-block semantics
5072 Value *S, ///< The value to be casted
5073 Type *Ty, ///< The type to casted to
5074 const Twine &NameStr, ///< A name for the new instruction
5075 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
5078 // Methods for support type inquiry through isa, cast, and dyn_cast:
5079 static bool classof(const Instruction *I) {
5080 return I->getOpcode() == BitCast;
5082 static bool classof(const Value *V) {
5083 return isa<Instruction>(V) && classof(cast<Instruction>(V));
5087 //===----------------------------------------------------------------------===//
5088 // AddrSpaceCastInst Class
5089 //===----------------------------------------------------------------------===//
5091 /// This class represents a conversion between pointers from one address space
5093 class AddrSpaceCastInst : public CastInst {
5095 // Note: Instruction needs to be a friend here to call cloneImpl.
5096 friend class Instruction;
5098 /// Clone an identical AddrSpaceCastInst.
5099 AddrSpaceCastInst *cloneImpl() const;
5102 /// Constructor with insert-before-instruction semantics
5104 Value *S, ///< The value to be casted
5105 Type *Ty, ///< The type to casted to
5106 const Twine &NameStr = "", ///< A name for the new instruction
5107 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
5110 /// Constructor with insert-at-end-of-block semantics
5112 Value *S, ///< The value to be casted
5113 Type *Ty, ///< The type to casted to
5114 const Twine &NameStr, ///< A name for the new instruction
5115 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
5118 // Methods for support type inquiry through isa, cast, and dyn_cast:
5119 static bool classof(const Instruction *I) {
5120 return I->getOpcode() == AddrSpaceCast;
5122 static bool classof(const Value *V) {
5123 return isa<Instruction>(V) && classof(cast<Instruction>(V));
5126 /// Gets the pointer operand.
5127 Value *getPointerOperand() {
5128 return getOperand(0);
5131 /// Gets the pointer operand.
5132 const Value *getPointerOperand() const {
5133 return getOperand(0);
5136 /// Gets the operand index of the pointer operand.
5137 static unsigned getPointerOperandIndex() {
5141 /// Returns the address space of the pointer operand.
5142 unsigned getSrcAddressSpace() const {
5143 return getPointerOperand()->getType()->getPointerAddressSpace();
5146 /// Returns the address space of the result.
5147 unsigned getDestAddressSpace() const {
5148 return getType()->getPointerAddressSpace();
5152 } // end namespace llvm
5154 #endif // LLVM_IR_INSTRUCTIONS_H