1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file exposes the class definitions of all of the subclasses of the
11 // Instruction class. This is meant to be an easy way to get access to all
12 // instruction subclasses.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_IR_INSTRUCTIONS_H
17 #define LLVM_IR_INSTRUCTIONS_H
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/iterator_range.h"
22 #include "llvm/IR/Attributes.h"
23 #include "llvm/IR/CallingConv.h"
24 #include "llvm/IR/DerivedTypes.h"
25 #include "llvm/IR/InstrTypes.h"
26 #include "llvm/Support/ErrorHandling.h"
41 // Consume = 3, // Not specified yet.
45 SequentiallyConsistent = 7
48 enum SynchronizationScope {
53 /// Returns true if the ordering is at least as strong as acquire
54 /// (i.e. acquire, acq_rel or seq_cst)
55 inline bool isAtLeastAcquire(AtomicOrdering Ord) {
56 return (Ord == Acquire ||
57 Ord == AcquireRelease ||
58 Ord == SequentiallyConsistent);
61 /// Returns true if the ordering is at least as strong as release
62 /// (i.e. release, acq_rel or seq_cst)
63 inline bool isAtLeastRelease(AtomicOrdering Ord) {
64 return (Ord == Release ||
65 Ord == AcquireRelease ||
66 Ord == SequentiallyConsistent);
69 //===----------------------------------------------------------------------===//
71 //===----------------------------------------------------------------------===//
73 /// AllocaInst - an instruction to allocate memory on the stack
75 class AllocaInst : public UnaryInstruction {
79 AllocaInst *clone_impl() const override;
81 explicit AllocaInst(Type *Ty, Value *ArraySize = nullptr,
82 const Twine &Name = "",
83 Instruction *InsertBefore = nullptr);
84 AllocaInst(Type *Ty, Value *ArraySize,
85 const Twine &Name, BasicBlock *InsertAtEnd);
87 AllocaInst(Type *Ty, const Twine &Name, Instruction *InsertBefore = nullptr);
88 AllocaInst(Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd);
90 AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
91 const Twine &Name = "", Instruction *InsertBefore = nullptr);
92 AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
93 const Twine &Name, BasicBlock *InsertAtEnd);
95 // Out of line virtual method, so the vtable, etc. has a home.
96 ~AllocaInst() override;
98 /// isArrayAllocation - Return true if there is an allocation size parameter
99 /// to the allocation instruction that is not 1.
101 bool isArrayAllocation() const;
103 /// getArraySize - Get the number of elements allocated. For a simple
104 /// allocation of a single element, this will return a constant 1 value.
106 const Value *getArraySize() const { return getOperand(0); }
107 Value *getArraySize() { return getOperand(0); }
109 /// getType - Overload to return most specific pointer type
111 PointerType *getType() const {
112 return cast<PointerType>(Instruction::getType());
115 /// getAllocatedType - Return the type that is being allocated by the
118 Type *getAllocatedType() const { return AllocatedType; }
119 /// \brief for use only in special circumstances that need to generically
120 /// transform a whole instruction (eg: IR linking and vectorization).
121 void setAllocatedType(Type *Ty) { AllocatedType = Ty; }
123 /// getAlignment - Return the alignment of the memory that is being allocated
124 /// by the instruction.
126 unsigned getAlignment() const {
127 return (1u << (getSubclassDataFromInstruction() & 31)) >> 1;
129 void setAlignment(unsigned Align);
131 /// isStaticAlloca - Return true if this alloca is in the entry block of the
132 /// function and is a constant size. If so, the code generator will fold it
133 /// into the prolog/epilog code, so it is basically free.
134 bool isStaticAlloca() const;
136 /// \brief Return true if this alloca is used as an inalloca argument to a
137 /// call. Such allocas are never considered static even if they are in the
139 bool isUsedWithInAlloca() const {
140 return getSubclassDataFromInstruction() & 32;
143 /// \brief Specify whether this alloca is used to represent the arguments to
145 void setUsedWithInAlloca(bool V) {
146 setInstructionSubclassData((getSubclassDataFromInstruction() & ~32) |
150 // Methods for support type inquiry through isa, cast, and dyn_cast:
151 static inline bool classof(const Instruction *I) {
152 return (I->getOpcode() == Instruction::Alloca);
154 static inline bool classof(const Value *V) {
155 return isa<Instruction>(V) && classof(cast<Instruction>(V));
158 // Shadow Instruction::setInstructionSubclassData with a private forwarding
159 // method so that subclasses cannot accidentally use it.
160 void setInstructionSubclassData(unsigned short D) {
161 Instruction::setInstructionSubclassData(D);
166 //===----------------------------------------------------------------------===//
168 //===----------------------------------------------------------------------===//
170 /// LoadInst - an instruction for reading from memory. This uses the
171 /// SubclassData field in Value to store whether or not the load is volatile.
173 class LoadInst : public UnaryInstruction {
176 LoadInst *clone_impl() const override;
178 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
179 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
180 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
181 Instruction *InsertBefore = nullptr);
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, SynchronizationScope SynchScope = CrossThread,
194 Instruction *InsertBefore = nullptr)
195 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
196 NameStr, isVolatile, Align, Order, SynchScope, InsertBefore) {}
197 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
198 unsigned Align, AtomicOrdering Order,
199 SynchronizationScope SynchScope = CrossThread,
200 Instruction *InsertBefore = nullptr);
201 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
202 unsigned Align, AtomicOrdering Order,
203 SynchronizationScope SynchScope,
204 BasicBlock *InsertAtEnd);
206 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
207 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
208 explicit LoadInst(Value *Ptr, const char *NameStr = nullptr,
209 bool isVolatile = false,
210 Instruction *InsertBefore = nullptr);
211 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
212 BasicBlock *InsertAtEnd);
214 /// isVolatile - Return true if this is a load from a volatile memory
217 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
219 /// setVolatile - Specify whether this is a volatile load or not.
221 void setVolatile(bool V) {
222 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
226 /// getAlignment - Return the alignment of the access that is being performed
228 unsigned getAlignment() const {
229 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
232 void setAlignment(unsigned Align);
234 /// Returns the ordering effect of this fence.
235 AtomicOrdering getOrdering() const {
236 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
239 /// Set the ordering constraint on this load. May not be Release or
241 void setOrdering(AtomicOrdering Ordering) {
242 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
246 SynchronizationScope getSynchScope() const {
247 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
250 /// Specify whether this load is ordered with respect to all
251 /// concurrently executing threads, or only with respect to signal handlers
252 /// executing in the same thread.
253 void setSynchScope(SynchronizationScope xthread) {
254 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
258 void setAtomic(AtomicOrdering Ordering,
259 SynchronizationScope SynchScope = CrossThread) {
260 setOrdering(Ordering);
261 setSynchScope(SynchScope);
264 bool isSimple() const { return !isAtomic() && !isVolatile(); }
265 bool isUnordered() const {
266 return getOrdering() <= Unordered && !isVolatile();
269 Value *getPointerOperand() { return getOperand(0); }
270 const Value *getPointerOperand() const { return getOperand(0); }
271 static unsigned getPointerOperandIndex() { return 0U; }
273 /// \brief Returns the address space of the pointer operand.
274 unsigned getPointerAddressSpace() const {
275 return getPointerOperand()->getType()->getPointerAddressSpace();
279 // Methods for support type inquiry through isa, cast, and dyn_cast:
280 static inline bool classof(const Instruction *I) {
281 return I->getOpcode() == Instruction::Load;
283 static inline bool classof(const Value *V) {
284 return isa<Instruction>(V) && classof(cast<Instruction>(V));
287 // Shadow Instruction::setInstructionSubclassData with a private forwarding
288 // method so that subclasses cannot accidentally use it.
289 void setInstructionSubclassData(unsigned short D) {
290 Instruction::setInstructionSubclassData(D);
295 //===----------------------------------------------------------------------===//
297 //===----------------------------------------------------------------------===//
299 /// StoreInst - an instruction for storing to memory
301 class StoreInst : public Instruction {
302 void *operator new(size_t, unsigned) = delete;
305 StoreInst *clone_impl() const override;
307 // allocate space for exactly two operands
308 void *operator new(size_t s) {
309 return User::operator new(s, 2);
311 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
312 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
313 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
314 Instruction *InsertBefore = nullptr);
315 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
316 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
317 unsigned Align, Instruction *InsertBefore = nullptr);
318 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
319 unsigned Align, BasicBlock *InsertAtEnd);
320 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
321 unsigned Align, AtomicOrdering Order,
322 SynchronizationScope SynchScope = CrossThread,
323 Instruction *InsertBefore = nullptr);
324 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
325 unsigned Align, AtomicOrdering Order,
326 SynchronizationScope SynchScope,
327 BasicBlock *InsertAtEnd);
330 /// isVolatile - Return true if this is a store to a volatile memory
333 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
335 /// setVolatile - Specify whether this is a volatile store or not.
337 void setVolatile(bool V) {
338 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
342 /// Transparently provide more efficient getOperand methods.
343 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
345 /// getAlignment - Return the alignment of the access that is being performed
347 unsigned getAlignment() const {
348 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
351 void setAlignment(unsigned Align);
353 /// Returns the ordering effect of this store.
354 AtomicOrdering getOrdering() const {
355 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
358 /// Set the ordering constraint on this store. May not be Acquire or
360 void setOrdering(AtomicOrdering Ordering) {
361 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
365 SynchronizationScope getSynchScope() const {
366 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
369 /// Specify whether this store instruction is ordered with respect to all
370 /// concurrently executing threads, or only with respect to signal handlers
371 /// executing in the same thread.
372 void setSynchScope(SynchronizationScope xthread) {
373 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
377 void setAtomic(AtomicOrdering Ordering,
378 SynchronizationScope SynchScope = CrossThread) {
379 setOrdering(Ordering);
380 setSynchScope(SynchScope);
383 bool isSimple() const { return !isAtomic() && !isVolatile(); }
384 bool isUnordered() const {
385 return getOrdering() <= Unordered && !isVolatile();
388 Value *getValueOperand() { return getOperand(0); }
389 const Value *getValueOperand() const { return getOperand(0); }
391 Value *getPointerOperand() { return getOperand(1); }
392 const Value *getPointerOperand() const { return getOperand(1); }
393 static unsigned getPointerOperandIndex() { return 1U; }
395 /// \brief Returns the address space of the pointer operand.
396 unsigned getPointerAddressSpace() const {
397 return getPointerOperand()->getType()->getPointerAddressSpace();
400 // Methods for support type inquiry through isa, cast, and dyn_cast:
401 static inline bool classof(const Instruction *I) {
402 return I->getOpcode() == Instruction::Store;
404 static inline bool classof(const Value *V) {
405 return isa<Instruction>(V) && classof(cast<Instruction>(V));
408 // Shadow Instruction::setInstructionSubclassData with a private forwarding
409 // method so that subclasses cannot accidentally use it.
410 void setInstructionSubclassData(unsigned short D) {
411 Instruction::setInstructionSubclassData(D);
416 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
419 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
421 //===----------------------------------------------------------------------===//
423 //===----------------------------------------------------------------------===//
425 /// FenceInst - an instruction for ordering other memory operations
427 class FenceInst : public Instruction {
428 void *operator new(size_t, unsigned) = delete;
429 void Init(AtomicOrdering Ordering, SynchronizationScope SynchScope);
431 FenceInst *clone_impl() const override;
433 // allocate space for exactly zero operands
434 void *operator new(size_t s) {
435 return User::operator new(s, 0);
438 // Ordering may only be Acquire, Release, AcquireRelease, or
439 // SequentiallyConsistent.
440 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
441 SynchronizationScope SynchScope = CrossThread,
442 Instruction *InsertBefore = nullptr);
443 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
444 SynchronizationScope SynchScope,
445 BasicBlock *InsertAtEnd);
447 /// Returns the ordering effect of this fence.
448 AtomicOrdering getOrdering() const {
449 return AtomicOrdering(getSubclassDataFromInstruction() >> 1);
452 /// Set the ordering constraint on this fence. May only be Acquire, Release,
453 /// AcquireRelease, or SequentiallyConsistent.
454 void setOrdering(AtomicOrdering Ordering) {
455 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
459 SynchronizationScope getSynchScope() const {
460 return SynchronizationScope(getSubclassDataFromInstruction() & 1);
463 /// Specify whether this fence orders other operations with respect to all
464 /// concurrently executing threads, or only with respect to signal handlers
465 /// executing in the same thread.
466 void setSynchScope(SynchronizationScope xthread) {
467 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
471 // Methods for support type inquiry through isa, cast, and dyn_cast:
472 static inline bool classof(const Instruction *I) {
473 return I->getOpcode() == Instruction::Fence;
475 static inline bool classof(const Value *V) {
476 return isa<Instruction>(V) && classof(cast<Instruction>(V));
479 // Shadow Instruction::setInstructionSubclassData with a private forwarding
480 // method so that subclasses cannot accidentally use it.
481 void setInstructionSubclassData(unsigned short D) {
482 Instruction::setInstructionSubclassData(D);
486 //===----------------------------------------------------------------------===//
487 // AtomicCmpXchgInst Class
488 //===----------------------------------------------------------------------===//
490 /// AtomicCmpXchgInst - an instruction that atomically checks whether a
491 /// specified value is in a memory location, and, if it is, stores a new value
492 /// there. Returns the value that was loaded.
494 class AtomicCmpXchgInst : public Instruction {
495 void *operator new(size_t, unsigned) = delete;
496 void Init(Value *Ptr, Value *Cmp, Value *NewVal,
497 AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering,
498 SynchronizationScope SynchScope);
500 AtomicCmpXchgInst *clone_impl() const override;
502 // allocate space for exactly three operands
503 void *operator new(size_t s) {
504 return User::operator new(s, 3);
506 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
507 AtomicOrdering SuccessOrdering,
508 AtomicOrdering FailureOrdering,
509 SynchronizationScope SynchScope,
510 Instruction *InsertBefore = nullptr);
511 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
512 AtomicOrdering SuccessOrdering,
513 AtomicOrdering FailureOrdering,
514 SynchronizationScope SynchScope,
515 BasicBlock *InsertAtEnd);
517 /// isVolatile - Return true if this is a cmpxchg from a volatile memory
520 bool isVolatile() const {
521 return getSubclassDataFromInstruction() & 1;
524 /// setVolatile - Specify whether this is a volatile cmpxchg.
526 void setVolatile(bool V) {
527 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
531 /// Return true if this cmpxchg may spuriously fail.
532 bool isWeak() const {
533 return getSubclassDataFromInstruction() & 0x100;
536 void setWeak(bool IsWeak) {
537 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x100) |
541 /// Transparently provide more efficient getOperand methods.
542 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
544 /// Set the ordering constraint on this cmpxchg.
545 void setSuccessOrdering(AtomicOrdering Ordering) {
546 assert(Ordering != NotAtomic &&
547 "CmpXchg instructions can only be atomic.");
548 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x1c) |
552 void setFailureOrdering(AtomicOrdering Ordering) {
553 assert(Ordering != NotAtomic &&
554 "CmpXchg instructions can only be atomic.");
555 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0xe0) |
559 /// Specify whether this cmpxchg is atomic and orders other operations with
560 /// respect to all concurrently executing threads, or only with respect to
561 /// signal handlers executing in the same thread.
562 void setSynchScope(SynchronizationScope SynchScope) {
563 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
567 /// Returns the ordering constraint on this cmpxchg.
568 AtomicOrdering getSuccessOrdering() const {
569 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
572 /// Returns the ordering constraint on this cmpxchg.
573 AtomicOrdering getFailureOrdering() const {
574 return AtomicOrdering((getSubclassDataFromInstruction() >> 5) & 7);
577 /// Returns whether this cmpxchg is atomic between threads or only within a
579 SynchronizationScope getSynchScope() const {
580 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
583 Value *getPointerOperand() { return getOperand(0); }
584 const Value *getPointerOperand() const { return getOperand(0); }
585 static unsigned getPointerOperandIndex() { return 0U; }
587 Value *getCompareOperand() { return getOperand(1); }
588 const Value *getCompareOperand() const { return getOperand(1); }
590 Value *getNewValOperand() { return getOperand(2); }
591 const Value *getNewValOperand() const { return getOperand(2); }
593 /// \brief Returns the address space of the pointer operand.
594 unsigned getPointerAddressSpace() const {
595 return getPointerOperand()->getType()->getPointerAddressSpace();
598 /// \brief Returns the strongest permitted ordering on failure, given the
599 /// desired ordering on success.
601 /// If the comparison in a cmpxchg operation fails, there is no atomic store
602 /// so release semantics cannot be provided. So this function drops explicit
603 /// Release requests from the AtomicOrdering. A SequentiallyConsistent
604 /// operation would remain SequentiallyConsistent.
605 static AtomicOrdering
606 getStrongestFailureOrdering(AtomicOrdering SuccessOrdering) {
607 switch (SuccessOrdering) {
608 default: llvm_unreachable("invalid cmpxchg success ordering");
615 case SequentiallyConsistent:
616 return SequentiallyConsistent;
620 // Methods for support type inquiry through isa, cast, and dyn_cast:
621 static inline bool classof(const Instruction *I) {
622 return I->getOpcode() == Instruction::AtomicCmpXchg;
624 static inline bool classof(const Value *V) {
625 return isa<Instruction>(V) && classof(cast<Instruction>(V));
628 // Shadow Instruction::setInstructionSubclassData with a private forwarding
629 // method so that subclasses cannot accidentally use it.
630 void setInstructionSubclassData(unsigned short D) {
631 Instruction::setInstructionSubclassData(D);
636 struct OperandTraits<AtomicCmpXchgInst> :
637 public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
640 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)
642 //===----------------------------------------------------------------------===//
643 // AtomicRMWInst Class
644 //===----------------------------------------------------------------------===//
646 /// AtomicRMWInst - an instruction that atomically reads a memory location,
647 /// combines it with another value, and then stores the result back. Returns
650 class AtomicRMWInst : public Instruction {
651 void *operator new(size_t, unsigned) = delete;
653 AtomicRMWInst *clone_impl() const override;
655 /// This enumeration lists the possible modifications atomicrmw can make. In
656 /// the descriptions, 'p' is the pointer to the instruction's memory location,
657 /// 'old' is the initial value of *p, and 'v' is the other value passed to the
658 /// instruction. These instructions always return 'old'.
674 /// *p = old >signed v ? old : v
676 /// *p = old <signed v ? old : v
678 /// *p = old >unsigned v ? old : v
680 /// *p = old <unsigned v ? old : v
688 // allocate space for exactly two operands
689 void *operator new(size_t s) {
690 return User::operator new(s, 2);
692 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
693 AtomicOrdering Ordering, SynchronizationScope SynchScope,
694 Instruction *InsertBefore = nullptr);
695 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
696 AtomicOrdering Ordering, SynchronizationScope SynchScope,
697 BasicBlock *InsertAtEnd);
699 BinOp getOperation() const {
700 return static_cast<BinOp>(getSubclassDataFromInstruction() >> 5);
703 void setOperation(BinOp Operation) {
704 unsigned short SubclassData = getSubclassDataFromInstruction();
705 setInstructionSubclassData((SubclassData & 31) |
709 /// isVolatile - Return true if this is a RMW on a volatile memory location.
711 bool isVolatile() const {
712 return getSubclassDataFromInstruction() & 1;
715 /// setVolatile - Specify whether this is a volatile RMW or not.
717 void setVolatile(bool V) {
718 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
722 /// Transparently provide more efficient getOperand methods.
723 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
725 /// Set the ordering constraint on this RMW.
726 void setOrdering(AtomicOrdering Ordering) {
727 assert(Ordering != NotAtomic &&
728 "atomicrmw instructions can only be atomic.");
729 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 2)) |
733 /// Specify whether this RMW orders other operations with respect to all
734 /// concurrently executing threads, or only with respect to signal handlers
735 /// executing in the same thread.
736 void setSynchScope(SynchronizationScope SynchScope) {
737 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
741 /// Returns the ordering constraint on this RMW.
742 AtomicOrdering getOrdering() const {
743 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
746 /// Returns whether this RMW is atomic between threads or only within a
748 SynchronizationScope getSynchScope() const {
749 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
752 Value *getPointerOperand() { return getOperand(0); }
753 const Value *getPointerOperand() const { return getOperand(0); }
754 static unsigned getPointerOperandIndex() { return 0U; }
756 Value *getValOperand() { return getOperand(1); }
757 const Value *getValOperand() const { return getOperand(1); }
759 /// \brief Returns the address space of the pointer operand.
760 unsigned getPointerAddressSpace() const {
761 return getPointerOperand()->getType()->getPointerAddressSpace();
764 // Methods for support type inquiry through isa, cast, and dyn_cast:
765 static inline bool classof(const Instruction *I) {
766 return I->getOpcode() == Instruction::AtomicRMW;
768 static inline bool classof(const Value *V) {
769 return isa<Instruction>(V) && classof(cast<Instruction>(V));
772 void Init(BinOp Operation, Value *Ptr, Value *Val,
773 AtomicOrdering Ordering, SynchronizationScope SynchScope);
774 // Shadow Instruction::setInstructionSubclassData with a private forwarding
775 // method so that subclasses cannot accidentally use it.
776 void setInstructionSubclassData(unsigned short D) {
777 Instruction::setInstructionSubclassData(D);
782 struct OperandTraits<AtomicRMWInst>
783 : public FixedNumOperandTraits<AtomicRMWInst,2> {
786 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)
788 //===----------------------------------------------------------------------===//
789 // GetElementPtrInst Class
790 //===----------------------------------------------------------------------===//
792 // checkGEPType - Simple wrapper function to give a better assertion failure
793 // message on bad indexes for a gep instruction.
795 inline Type *checkGEPType(Type *Ty) {
796 assert(Ty && "Invalid GetElementPtrInst indices for type!");
800 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
801 /// access elements of arrays and structs
803 class GetElementPtrInst : public Instruction {
804 Type *SourceElementType;
806 GetElementPtrInst(const GetElementPtrInst &GEPI);
807 void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
809 /// Constructors - Create a getelementptr instruction with a base pointer an
810 /// list of indices. The first ctor can optionally insert before an existing
811 /// instruction, the second appends the new instruction to the specified
813 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
814 ArrayRef<Value *> IdxList, unsigned Values,
815 const Twine &NameStr, Instruction *InsertBefore);
816 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
817 ArrayRef<Value *> IdxList, unsigned Values,
818 const Twine &NameStr, BasicBlock *InsertAtEnd);
821 GetElementPtrInst *clone_impl() const override;
823 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
824 ArrayRef<Value *> IdxList,
825 const Twine &NameStr = "",
826 Instruction *InsertBefore = nullptr) {
827 unsigned Values = 1 + unsigned(IdxList.size());
830 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
834 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
835 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
836 NameStr, InsertBefore);
838 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
839 ArrayRef<Value *> IdxList,
840 const Twine &NameStr,
841 BasicBlock *InsertAtEnd) {
842 unsigned Values = 1 + unsigned(IdxList.size());
845 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
849 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
850 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
851 NameStr, InsertAtEnd);
854 /// Create an "inbounds" getelementptr. See the documentation for the
855 /// "inbounds" flag in LangRef.html for details.
856 static GetElementPtrInst *CreateInBounds(Value *Ptr,
857 ArrayRef<Value *> IdxList,
858 const Twine &NameStr = "",
859 Instruction *InsertBefore = nullptr){
860 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertBefore);
862 static GetElementPtrInst *
863 CreateInBounds(Type *PointeeType, Value *Ptr, ArrayRef<Value *> IdxList,
864 const Twine &NameStr = "",
865 Instruction *InsertBefore = nullptr) {
866 GetElementPtrInst *GEP =
867 Create(PointeeType, Ptr, IdxList, NameStr, InsertBefore);
868 GEP->setIsInBounds(true);
871 static GetElementPtrInst *CreateInBounds(Value *Ptr,
872 ArrayRef<Value *> IdxList,
873 const Twine &NameStr,
874 BasicBlock *InsertAtEnd) {
875 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertAtEnd);
877 static GetElementPtrInst *CreateInBounds(Type *PointeeType, Value *Ptr,
878 ArrayRef<Value *> IdxList,
879 const Twine &NameStr,
880 BasicBlock *InsertAtEnd) {
881 GetElementPtrInst *GEP =
882 Create(PointeeType, Ptr, IdxList, NameStr, InsertAtEnd);
883 GEP->setIsInBounds(true);
887 /// Transparently provide more efficient getOperand methods.
888 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
890 // getType - Overload to return most specific sequential type.
891 SequentialType *getType() const {
892 return cast<SequentialType>(Instruction::getType());
895 Type *getSourceElementType() const { return SourceElementType; }
897 void setSourceElementType(Type *Ty) { SourceElementType = Ty; }
899 Type *getResultElementType() const {
900 return cast<PointerType>(getType()->getScalarType())->getElementType();
903 /// \brief Returns the address space of this instruction's pointer type.
904 unsigned getAddressSpace() const {
905 // Note that this is always the same as the pointer operand's address space
906 // and that is cheaper to compute, so cheat here.
907 return getPointerAddressSpace();
910 /// getIndexedType - Returns the type of the element that would be loaded with
911 /// a load instruction with the specified parameters.
913 /// Null is returned if the indices are invalid for the specified
916 static Type *getIndexedType(Type *Ty, ArrayRef<Value *> IdxList);
917 static Type *getIndexedType(Type *Ty, ArrayRef<Constant *> IdxList);
918 static Type *getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList);
920 inline op_iterator idx_begin() { return op_begin()+1; }
921 inline const_op_iterator idx_begin() const { return op_begin()+1; }
922 inline op_iterator idx_end() { return op_end(); }
923 inline const_op_iterator idx_end() const { return op_end(); }
925 Value *getPointerOperand() {
926 return getOperand(0);
928 const Value *getPointerOperand() const {
929 return getOperand(0);
931 static unsigned getPointerOperandIndex() {
932 return 0U; // get index for modifying correct operand.
935 /// getPointerOperandType - Method to return the pointer operand as a
937 Type *getPointerOperandType() const {
938 return getPointerOperand()->getType();
941 /// \brief Returns the address space of the pointer operand.
942 unsigned getPointerAddressSpace() const {
943 return getPointerOperandType()->getPointerAddressSpace();
946 /// GetGEPReturnType - Returns the pointer type returned by the GEP
947 /// instruction, which may be a vector of pointers.
948 static Type *getGEPReturnType(Value *Ptr, ArrayRef<Value *> IdxList) {
949 return getGEPReturnType(
950 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType(),
953 static Type *getGEPReturnType(Type *ElTy, Value *Ptr,
954 ArrayRef<Value *> IdxList) {
955 Type *PtrTy = PointerType::get(checkGEPType(getIndexedType(ElTy, IdxList)),
956 Ptr->getType()->getPointerAddressSpace());
958 if (Ptr->getType()->isVectorTy()) {
959 unsigned NumElem = cast<VectorType>(Ptr->getType())->getNumElements();
960 return VectorType::get(PtrTy, NumElem);
967 unsigned getNumIndices() const { // Note: always non-negative
968 return getNumOperands() - 1;
971 bool hasIndices() const {
972 return getNumOperands() > 1;
975 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
976 /// zeros. If so, the result pointer and the first operand have the same
977 /// value, just potentially different types.
978 bool hasAllZeroIndices() const;
980 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
981 /// constant integers. If so, the result pointer and the first operand have
982 /// a constant offset between them.
983 bool hasAllConstantIndices() const;
985 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
986 /// See LangRef.html for the meaning of inbounds on a getelementptr.
987 void setIsInBounds(bool b = true);
989 /// isInBounds - Determine whether the GEP has the inbounds flag.
990 bool isInBounds() const;
992 /// \brief Accumulate the constant address offset of this GEP if possible.
994 /// This routine accepts an APInt into which it will accumulate the constant
995 /// offset of this GEP if the GEP is in fact constant. If the GEP is not
996 /// all-constant, it returns false and the value of the offset APInt is
997 /// undefined (it is *not* preserved!). The APInt passed into this routine
998 /// must be at least as wide as the IntPtr type for the address space of
999 /// the base GEP pointer.
1000 bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const;
1002 // Methods for support type inquiry through isa, cast, and dyn_cast:
1003 static inline bool classof(const Instruction *I) {
1004 return (I->getOpcode() == Instruction::GetElementPtr);
1006 static inline bool classof(const Value *V) {
1007 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1012 struct OperandTraits<GetElementPtrInst> :
1013 public VariadicOperandTraits<GetElementPtrInst, 1> {
1016 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1017 ArrayRef<Value *> IdxList, unsigned Values,
1018 const Twine &NameStr,
1019 Instruction *InsertBefore)
1020 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1021 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1022 Values, InsertBefore),
1023 SourceElementType(PointeeType) {
1024 init(Ptr, IdxList, NameStr);
1026 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1027 ArrayRef<Value *> IdxList, unsigned Values,
1028 const Twine &NameStr,
1029 BasicBlock *InsertAtEnd)
1030 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1031 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1032 Values, InsertAtEnd),
1033 SourceElementType(PointeeType) {
1034 init(Ptr, IdxList, NameStr);
1038 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
1041 //===----------------------------------------------------------------------===//
1043 //===----------------------------------------------------------------------===//
1045 /// This instruction compares its operands according to the predicate given
1046 /// to the constructor. It only operates on integers or pointers. The operands
1047 /// must be identical types.
1048 /// \brief Represent an integer comparison operator.
1049 class ICmpInst: public CmpInst {
1051 assert(getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
1052 getPredicate() <= CmpInst::LAST_ICMP_PREDICATE &&
1053 "Invalid ICmp predicate value");
1054 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1055 "Both operands to ICmp instruction are not of the same type!");
1056 // Check that the operands are the right type
1057 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
1058 getOperand(0)->getType()->isPtrOrPtrVectorTy()) &&
1059 "Invalid operand types for ICmp instruction");
1063 /// \brief Clone an identical ICmpInst
1064 ICmpInst *clone_impl() const override;
1066 /// \brief Constructor with insert-before-instruction semantics.
1068 Instruction *InsertBefore, ///< Where to insert
1069 Predicate pred, ///< The predicate to use for the comparison
1070 Value *LHS, ///< The left-hand-side of the expression
1071 Value *RHS, ///< The right-hand-side of the expression
1072 const Twine &NameStr = "" ///< Name of the instruction
1073 ) : CmpInst(makeCmpResultType(LHS->getType()),
1074 Instruction::ICmp, pred, LHS, RHS, NameStr,
1081 /// \brief Constructor with insert-at-end semantics.
1083 BasicBlock &InsertAtEnd, ///< Block to insert into.
1084 Predicate pred, ///< The predicate to use for the comparison
1085 Value *LHS, ///< The left-hand-side of the expression
1086 Value *RHS, ///< The right-hand-side of the expression
1087 const Twine &NameStr = "" ///< Name of the instruction
1088 ) : CmpInst(makeCmpResultType(LHS->getType()),
1089 Instruction::ICmp, pred, LHS, RHS, NameStr,
1096 /// \brief Constructor with no-insertion semantics
1098 Predicate pred, ///< The predicate to use for the comparison
1099 Value *LHS, ///< The left-hand-side of the expression
1100 Value *RHS, ///< The right-hand-side of the expression
1101 const Twine &NameStr = "" ///< Name of the instruction
1102 ) : CmpInst(makeCmpResultType(LHS->getType()),
1103 Instruction::ICmp, pred, LHS, RHS, NameStr) {
1109 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
1110 /// @returns the predicate that would be the result if the operand were
1111 /// regarded as signed.
1112 /// \brief Return the signed version of the predicate
1113 Predicate getSignedPredicate() const {
1114 return getSignedPredicate(getPredicate());
1117 /// This is a static version that you can use without an instruction.
1118 /// \brief Return the signed version of the predicate.
1119 static Predicate getSignedPredicate(Predicate pred);
1121 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
1122 /// @returns the predicate that would be the result if the operand were
1123 /// regarded as unsigned.
1124 /// \brief Return the unsigned version of the predicate
1125 Predicate getUnsignedPredicate() const {
1126 return getUnsignedPredicate(getPredicate());
1129 /// This is a static version that you can use without an instruction.
1130 /// \brief Return the unsigned version of the predicate.
1131 static Predicate getUnsignedPredicate(Predicate pred);
1133 /// isEquality - Return true if this predicate is either EQ or NE. This also
1134 /// tests for commutativity.
1135 static bool isEquality(Predicate P) {
1136 return P == ICMP_EQ || P == ICMP_NE;
1139 /// isEquality - Return true if this predicate is either EQ or NE. This also
1140 /// tests for commutativity.
1141 bool isEquality() const {
1142 return isEquality(getPredicate());
1145 /// @returns true if the predicate of this ICmpInst is commutative
1146 /// \brief Determine if this relation is commutative.
1147 bool isCommutative() const { return isEquality(); }
1149 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1151 bool isRelational() const {
1152 return !isEquality();
1155 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1157 static bool isRelational(Predicate P) {
1158 return !isEquality(P);
1161 /// Initialize a set of values that all satisfy the predicate with C.
1162 /// \brief Make a ConstantRange for a relation with a constant value.
1163 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
1165 /// Exchange the two operands to this instruction in such a way that it does
1166 /// not modify the semantics of the instruction. The predicate value may be
1167 /// changed to retain the same result if the predicate is order dependent
1169 /// \brief Swap operands and adjust predicate.
1170 void swapOperands() {
1171 setPredicate(getSwappedPredicate());
1172 Op<0>().swap(Op<1>());
1175 // Methods for support type inquiry through isa, cast, and dyn_cast:
1176 static inline bool classof(const Instruction *I) {
1177 return I->getOpcode() == Instruction::ICmp;
1179 static inline bool classof(const Value *V) {
1180 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1185 //===----------------------------------------------------------------------===//
1187 //===----------------------------------------------------------------------===//
1189 /// This instruction compares its operands according to the predicate given
1190 /// to the constructor. It only operates on floating point values or packed
1191 /// vectors of floating point values. The operands must be identical types.
1192 /// \brief Represents a floating point comparison operator.
1193 class FCmpInst: public CmpInst {
1195 /// \brief Clone an identical FCmpInst
1196 FCmpInst *clone_impl() const override;
1198 /// \brief Constructor with insert-before-instruction semantics.
1200 Instruction *InsertBefore, ///< Where to insert
1201 Predicate pred, ///< The predicate to use for the comparison
1202 Value *LHS, ///< The left-hand-side of the expression
1203 Value *RHS, ///< The right-hand-side of the expression
1204 const Twine &NameStr = "" ///< Name of the instruction
1205 ) : CmpInst(makeCmpResultType(LHS->getType()),
1206 Instruction::FCmp, pred, LHS, RHS, NameStr,
1208 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1209 "Invalid FCmp predicate value");
1210 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1211 "Both operands to FCmp instruction are not of the same type!");
1212 // Check that the operands are the right type
1213 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1214 "Invalid operand types for FCmp instruction");
1217 /// \brief Constructor with insert-at-end semantics.
1219 BasicBlock &InsertAtEnd, ///< Block to insert into.
1220 Predicate pred, ///< The predicate to use for the comparison
1221 Value *LHS, ///< The left-hand-side of the expression
1222 Value *RHS, ///< The right-hand-side of the expression
1223 const Twine &NameStr = "" ///< Name of the instruction
1224 ) : CmpInst(makeCmpResultType(LHS->getType()),
1225 Instruction::FCmp, pred, LHS, RHS, NameStr,
1227 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1228 "Invalid FCmp predicate value");
1229 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1230 "Both operands to FCmp instruction are not of the same type!");
1231 // Check that the operands are the right type
1232 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1233 "Invalid operand types for FCmp instruction");
1236 /// \brief Constructor with no-insertion semantics
1238 Predicate pred, ///< The predicate to use for the comparison
1239 Value *LHS, ///< The left-hand-side of the expression
1240 Value *RHS, ///< The right-hand-side of the expression
1241 const Twine &NameStr = "" ///< Name of the instruction
1242 ) : CmpInst(makeCmpResultType(LHS->getType()),
1243 Instruction::FCmp, pred, LHS, RHS, NameStr) {
1244 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1245 "Invalid FCmp predicate value");
1246 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1247 "Both operands to FCmp instruction are not of the same type!");
1248 // Check that the operands are the right type
1249 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1250 "Invalid operand types for FCmp instruction");
1253 /// @returns true if the predicate of this instruction is EQ or NE.
1254 /// \brief Determine if this is an equality predicate.
1255 static bool isEquality(Predicate Pred) {
1256 return Pred == FCMP_OEQ || Pred == FCMP_ONE || Pred == FCMP_UEQ ||
1260 /// @returns true if the predicate of this instruction is EQ or NE.
1261 /// \brief Determine if this is an equality predicate.
1262 bool isEquality() const { return isEquality(getPredicate()); }
1264 /// @returns true if the predicate of this instruction is commutative.
1265 /// \brief Determine if this is a commutative predicate.
1266 bool isCommutative() const {
1267 return isEquality() ||
1268 getPredicate() == FCMP_FALSE ||
1269 getPredicate() == FCMP_TRUE ||
1270 getPredicate() == FCMP_ORD ||
1271 getPredicate() == FCMP_UNO;
1274 /// @returns true if the predicate is relational (not EQ or NE).
1275 /// \brief Determine if this a relational predicate.
1276 bool isRelational() const { return !isEquality(); }
1278 /// Exchange the two operands to this instruction in such a way that it does
1279 /// not modify the semantics of the instruction. The predicate value may be
1280 /// changed to retain the same result if the predicate is order dependent
1282 /// \brief Swap operands and adjust predicate.
1283 void swapOperands() {
1284 setPredicate(getSwappedPredicate());
1285 Op<0>().swap(Op<1>());
1288 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
1289 static inline bool classof(const Instruction *I) {
1290 return I->getOpcode() == Instruction::FCmp;
1292 static inline bool classof(const Value *V) {
1293 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1297 //===----------------------------------------------------------------------===//
1298 /// CallInst - This class represents a function call, abstracting a target
1299 /// machine's calling convention. This class uses low bit of the SubClassData
1300 /// field to indicate whether or not this is a tail call. The rest of the bits
1301 /// hold the calling convention of the call.
1303 class CallInst : public Instruction {
1304 AttributeSet AttributeList; ///< parameter attributes for call
1306 CallInst(const CallInst &CI);
1307 void init(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr) {
1308 init(cast<FunctionType>(
1309 cast<PointerType>(Func->getType())->getElementType()),
1310 Func, Args, NameStr);
1312 void init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
1313 const Twine &NameStr);
1314 void init(Value *Func, const Twine &NameStr);
1316 /// Construct a CallInst given a range of arguments.
1317 /// \brief Construct a CallInst from a range of arguments
1318 inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1319 const Twine &NameStr, Instruction *InsertBefore);
1320 inline CallInst(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr,
1321 Instruction *InsertBefore)
1322 : CallInst(cast<FunctionType>(
1323 cast<PointerType>(Func->getType())->getElementType()),
1324 Func, Args, NameStr, InsertBefore) {}
1326 /// Construct a CallInst given a range of arguments.
1327 /// \brief Construct a CallInst from a range of arguments
1328 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1329 const Twine &NameStr, BasicBlock *InsertAtEnd);
1331 explicit CallInst(Value *F, const Twine &NameStr,
1332 Instruction *InsertBefore);
1333 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1335 CallInst *clone_impl() const override;
1337 static CallInst *Create(Value *Func,
1338 ArrayRef<Value *> Args,
1339 const Twine &NameStr = "",
1340 Instruction *InsertBefore = nullptr) {
1341 return Create(cast<FunctionType>(
1342 cast<PointerType>(Func->getType())->getElementType()),
1343 Func, Args, NameStr, InsertBefore);
1345 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1346 const Twine &NameStr = "",
1347 Instruction *InsertBefore = nullptr) {
1348 return new (unsigned(Args.size() + 1))
1349 CallInst(Ty, Func, Args, NameStr, InsertBefore);
1351 static CallInst *Create(Value *Func,
1352 ArrayRef<Value *> Args,
1353 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1354 return new(unsigned(Args.size() + 1))
1355 CallInst(Func, Args, NameStr, InsertAtEnd);
1357 static CallInst *Create(Value *F, const Twine &NameStr = "",
1358 Instruction *InsertBefore = nullptr) {
1359 return new(1) CallInst(F, NameStr, InsertBefore);
1361 static CallInst *Create(Value *F, const Twine &NameStr,
1362 BasicBlock *InsertAtEnd) {
1363 return new(1) CallInst(F, NameStr, InsertAtEnd);
1365 /// CreateMalloc - Generate the IR for a call to malloc:
1366 /// 1. Compute the malloc call's argument as the specified type's size,
1367 /// possibly multiplied by the array size if the array size is not
1369 /// 2. Call malloc with that argument.
1370 /// 3. Bitcast the result of the malloc call to the specified type.
1371 static Instruction *CreateMalloc(Instruction *InsertBefore,
1372 Type *IntPtrTy, Type *AllocTy,
1373 Value *AllocSize, Value *ArraySize = nullptr,
1374 Function* MallocF = nullptr,
1375 const Twine &Name = "");
1376 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1377 Type *IntPtrTy, Type *AllocTy,
1378 Value *AllocSize, Value *ArraySize = nullptr,
1379 Function* MallocF = nullptr,
1380 const Twine &Name = "");
1381 /// CreateFree - Generate the IR for a call to the builtin free function.
1382 static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
1383 static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
1385 ~CallInst() override;
1387 FunctionType *getFunctionType() const { return FTy; }
1389 void mutateFunctionType(FunctionType *FTy) {
1390 mutateType(FTy->getReturnType());
1394 // Note that 'musttail' implies 'tail'.
1395 enum TailCallKind { TCK_None = 0, TCK_Tail = 1, TCK_MustTail = 2 };
1396 TailCallKind getTailCallKind() const {
1397 return TailCallKind(getSubclassDataFromInstruction() & 3);
1399 bool isTailCall() const {
1400 return (getSubclassDataFromInstruction() & 3) != TCK_None;
1402 bool isMustTailCall() const {
1403 return (getSubclassDataFromInstruction() & 3) == TCK_MustTail;
1405 void setTailCall(bool isTC = true) {
1406 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1407 unsigned(isTC ? TCK_Tail : TCK_None));
1409 void setTailCallKind(TailCallKind TCK) {
1410 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1414 /// Provide fast operand accessors
1415 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1417 /// getNumArgOperands - Return the number of call arguments.
1419 unsigned getNumArgOperands() const { return getNumOperands() - 1; }
1421 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
1423 Value *getArgOperand(unsigned i) const { return getOperand(i); }
1424 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
1426 /// arg_operands - iteration adapter for range-for loops.
1427 iterator_range<op_iterator> arg_operands() {
1428 // The last operand in the op list is the callee - it's not one of the args
1429 // so we don't want to iterate over it.
1430 return iterator_range<op_iterator>(op_begin(), op_end() - 1);
1433 /// arg_operands - iteration adapter for range-for loops.
1434 iterator_range<const_op_iterator> arg_operands() const {
1435 return iterator_range<const_op_iterator>(op_begin(), op_end() - 1);
1438 /// \brief Wrappers for getting the \c Use of a call argument.
1439 const Use &getArgOperandUse(unsigned i) const { return getOperandUse(i); }
1440 Use &getArgOperandUse(unsigned i) { return getOperandUse(i); }
1442 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1444 CallingConv::ID getCallingConv() const {
1445 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 2);
1447 void setCallingConv(CallingConv::ID CC) {
1448 setInstructionSubclassData((getSubclassDataFromInstruction() & 3) |
1449 (static_cast<unsigned>(CC) << 2));
1452 /// getAttributes - Return the parameter attributes for this call.
1454 const AttributeSet &getAttributes() const { return AttributeList; }
1456 /// setAttributes - Set the parameter attributes for this call.
1458 void setAttributes(const AttributeSet &Attrs) { AttributeList = Attrs; }
1460 /// addAttribute - adds the attribute to the list of attributes.
1461 void addAttribute(unsigned i, Attribute::AttrKind attr);
1463 /// removeAttribute - removes the attribute from the list of attributes.
1464 void removeAttribute(unsigned i, Attribute attr);
1466 /// \brief adds the dereferenceable attribute to the list of attributes.
1467 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
1469 /// \brief adds the dereferenceable_or_null attribute to the list of
1471 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
1473 /// \brief Determine whether this call has the given attribute.
1474 bool hasFnAttr(Attribute::AttrKind A) const {
1475 assert(A != Attribute::NoBuiltin &&
1476 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
1477 return hasFnAttrImpl(A);
1480 /// \brief Determine whether the call or the callee has the given attributes.
1481 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const;
1483 /// \brief Extract the alignment for a call or parameter (0=unknown).
1484 unsigned getParamAlignment(unsigned i) const {
1485 return AttributeList.getParamAlignment(i);
1488 /// \brief Extract the number of dereferenceable bytes for a call or
1489 /// parameter (0=unknown).
1490 uint64_t getDereferenceableBytes(unsigned i) const {
1491 return AttributeList.getDereferenceableBytes(i);
1494 /// \brief Extract the number of dereferenceable_or_null bytes for a call or
1495 /// parameter (0=unknown).
1496 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
1497 return AttributeList.getDereferenceableOrNullBytes(i);
1500 /// \brief Return true if the call should not be treated as a call to a
1502 bool isNoBuiltin() const {
1503 return hasFnAttrImpl(Attribute::NoBuiltin) &&
1504 !hasFnAttrImpl(Attribute::Builtin);
1507 /// \brief Return true if the call should not be inlined.
1508 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
1509 void setIsNoInline() {
1510 addAttribute(AttributeSet::FunctionIndex, Attribute::NoInline);
1513 /// \brief Return true if the call can return twice
1514 bool canReturnTwice() const {
1515 return hasFnAttr(Attribute::ReturnsTwice);
1517 void setCanReturnTwice() {
1518 addAttribute(AttributeSet::FunctionIndex, Attribute::ReturnsTwice);
1521 /// \brief Determine if the call does not access memory.
1522 bool doesNotAccessMemory() const {
1523 return hasFnAttr(Attribute::ReadNone);
1525 void setDoesNotAccessMemory() {
1526 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
1529 /// \brief Determine if the call does not access or only reads memory.
1530 bool onlyReadsMemory() const {
1531 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
1533 void setOnlyReadsMemory() {
1534 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
1537 /// \brief Determine if the call cannot return.
1538 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
1539 void setDoesNotReturn() {
1540 addAttribute(AttributeSet::FunctionIndex, Attribute::NoReturn);
1543 /// \brief Determine if the call cannot unwind.
1544 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
1545 void setDoesNotThrow() {
1546 addAttribute(AttributeSet::FunctionIndex, Attribute::NoUnwind);
1549 /// \brief Determine if the call cannot be duplicated.
1550 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
1551 void setCannotDuplicate() {
1552 addAttribute(AttributeSet::FunctionIndex, Attribute::NoDuplicate);
1555 /// \brief Determine if the call returns a structure through first
1556 /// pointer argument.
1557 bool hasStructRetAttr() const {
1558 // Be friendly and also check the callee.
1559 return paramHasAttr(1, Attribute::StructRet);
1562 /// \brief Determine if any call argument is an aggregate passed by value.
1563 bool hasByValArgument() const {
1564 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1567 /// getCalledFunction - Return the function called, or null if this is an
1568 /// indirect function invocation.
1570 Function *getCalledFunction() const {
1571 return dyn_cast<Function>(Op<-1>());
1574 /// getCalledValue - Get a pointer to the function that is invoked by this
1576 const Value *getCalledValue() const { return Op<-1>(); }
1577 Value *getCalledValue() { return Op<-1>(); }
1579 /// setCalledFunction - Set the function called.
1580 void setCalledFunction(Value* Fn) {
1582 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
1585 void setCalledFunction(FunctionType *FTy, Value *Fn) {
1587 assert(FTy == cast<FunctionType>(
1588 cast<PointerType>(Fn->getType())->getElementType()));
1592 /// isInlineAsm - Check if this call is an inline asm statement.
1593 bool isInlineAsm() const {
1594 return isa<InlineAsm>(Op<-1>());
1597 // Methods for support type inquiry through isa, cast, and dyn_cast:
1598 static inline bool classof(const Instruction *I) {
1599 return I->getOpcode() == Instruction::Call;
1601 static inline bool classof(const Value *V) {
1602 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1606 bool hasFnAttrImpl(Attribute::AttrKind A) const;
1608 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1609 // method so that subclasses cannot accidentally use it.
1610 void setInstructionSubclassData(unsigned short D) {
1611 Instruction::setInstructionSubclassData(D);
1616 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1619 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1620 const Twine &NameStr, BasicBlock *InsertAtEnd)
1621 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1622 ->getElementType())->getReturnType(),
1624 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1625 unsigned(Args.size() + 1), InsertAtEnd) {
1626 init(Func, Args, NameStr);
1629 CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1630 const Twine &NameStr, Instruction *InsertBefore)
1631 : Instruction(Ty->getReturnType(), Instruction::Call,
1632 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1633 unsigned(Args.size() + 1), InsertBefore) {
1634 init(Ty, Func, Args, NameStr);
1638 // Note: if you get compile errors about private methods then
1639 // please update your code to use the high-level operand
1640 // interfaces. See line 943 above.
1641 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1643 //===----------------------------------------------------------------------===//
1645 //===----------------------------------------------------------------------===//
1647 /// SelectInst - This class represents the LLVM 'select' instruction.
1649 class SelectInst : public Instruction {
1650 void init(Value *C, Value *S1, Value *S2) {
1651 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1657 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1658 Instruction *InsertBefore)
1659 : Instruction(S1->getType(), Instruction::Select,
1660 &Op<0>(), 3, InsertBefore) {
1664 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1665 BasicBlock *InsertAtEnd)
1666 : Instruction(S1->getType(), Instruction::Select,
1667 &Op<0>(), 3, InsertAtEnd) {
1672 SelectInst *clone_impl() const override;
1674 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1675 const Twine &NameStr = "",
1676 Instruction *InsertBefore = nullptr) {
1677 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1679 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1680 const Twine &NameStr,
1681 BasicBlock *InsertAtEnd) {
1682 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1685 const Value *getCondition() const { return Op<0>(); }
1686 const Value *getTrueValue() const { return Op<1>(); }
1687 const Value *getFalseValue() const { return Op<2>(); }
1688 Value *getCondition() { return Op<0>(); }
1689 Value *getTrueValue() { return Op<1>(); }
1690 Value *getFalseValue() { return Op<2>(); }
1692 /// areInvalidOperands - Return a string if the specified operands are invalid
1693 /// for a select operation, otherwise return null.
1694 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1696 /// Transparently provide more efficient getOperand methods.
1697 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1699 OtherOps getOpcode() const {
1700 return static_cast<OtherOps>(Instruction::getOpcode());
1703 // Methods for support type inquiry through isa, cast, and dyn_cast:
1704 static inline bool classof(const Instruction *I) {
1705 return I->getOpcode() == Instruction::Select;
1707 static inline bool classof(const Value *V) {
1708 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1713 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1716 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1718 //===----------------------------------------------------------------------===//
1720 //===----------------------------------------------------------------------===//
1722 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1723 /// an argument of the specified type given a va_list and increments that list
1725 class VAArgInst : public UnaryInstruction {
1727 VAArgInst *clone_impl() const override;
1730 VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1731 Instruction *InsertBefore = nullptr)
1732 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1735 VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1736 BasicBlock *InsertAtEnd)
1737 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1741 Value *getPointerOperand() { return getOperand(0); }
1742 const Value *getPointerOperand() const { return getOperand(0); }
1743 static unsigned getPointerOperandIndex() { return 0U; }
1745 // Methods for support type inquiry through isa, cast, and dyn_cast:
1746 static inline bool classof(const Instruction *I) {
1747 return I->getOpcode() == VAArg;
1749 static inline bool classof(const Value *V) {
1750 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1754 //===----------------------------------------------------------------------===//
1755 // ExtractElementInst Class
1756 //===----------------------------------------------------------------------===//
1758 /// ExtractElementInst - This instruction extracts a single (scalar)
1759 /// element from a VectorType value
1761 class ExtractElementInst : public Instruction {
1762 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1763 Instruction *InsertBefore = nullptr);
1764 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1765 BasicBlock *InsertAtEnd);
1767 ExtractElementInst *clone_impl() const override;
1770 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1771 const Twine &NameStr = "",
1772 Instruction *InsertBefore = nullptr) {
1773 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1775 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1776 const Twine &NameStr,
1777 BasicBlock *InsertAtEnd) {
1778 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1781 /// isValidOperands - Return true if an extractelement instruction can be
1782 /// formed with the specified operands.
1783 static bool isValidOperands(const Value *Vec, const Value *Idx);
1785 Value *getVectorOperand() { return Op<0>(); }
1786 Value *getIndexOperand() { return Op<1>(); }
1787 const Value *getVectorOperand() const { return Op<0>(); }
1788 const Value *getIndexOperand() const { return Op<1>(); }
1790 VectorType *getVectorOperandType() const {
1791 return cast<VectorType>(getVectorOperand()->getType());
1795 /// Transparently provide more efficient getOperand methods.
1796 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1798 // Methods for support type inquiry through isa, cast, and dyn_cast:
1799 static inline bool classof(const Instruction *I) {
1800 return I->getOpcode() == Instruction::ExtractElement;
1802 static inline bool classof(const Value *V) {
1803 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1808 struct OperandTraits<ExtractElementInst> :
1809 public FixedNumOperandTraits<ExtractElementInst, 2> {
1812 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1814 //===----------------------------------------------------------------------===//
1815 // InsertElementInst Class
1816 //===----------------------------------------------------------------------===//
1818 /// InsertElementInst - This instruction inserts a single (scalar)
1819 /// element into a VectorType value
1821 class InsertElementInst : public Instruction {
1822 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1823 const Twine &NameStr = "",
1824 Instruction *InsertBefore = nullptr);
1825 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1826 const Twine &NameStr, BasicBlock *InsertAtEnd);
1828 InsertElementInst *clone_impl() const override;
1831 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1832 const Twine &NameStr = "",
1833 Instruction *InsertBefore = nullptr) {
1834 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1836 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1837 const Twine &NameStr,
1838 BasicBlock *InsertAtEnd) {
1839 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1842 /// isValidOperands - Return true if an insertelement instruction can be
1843 /// formed with the specified operands.
1844 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1847 /// getType - Overload to return most specific vector type.
1849 VectorType *getType() const {
1850 return cast<VectorType>(Instruction::getType());
1853 /// Transparently provide more efficient getOperand methods.
1854 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1856 // Methods for support type inquiry through isa, cast, and dyn_cast:
1857 static inline bool classof(const Instruction *I) {
1858 return I->getOpcode() == Instruction::InsertElement;
1860 static inline bool classof(const Value *V) {
1861 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1866 struct OperandTraits<InsertElementInst> :
1867 public FixedNumOperandTraits<InsertElementInst, 3> {
1870 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1872 //===----------------------------------------------------------------------===//
1873 // ShuffleVectorInst Class
1874 //===----------------------------------------------------------------------===//
1876 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1879 class ShuffleVectorInst : public Instruction {
1881 ShuffleVectorInst *clone_impl() const override;
1884 // allocate space for exactly three operands
1885 void *operator new(size_t s) {
1886 return User::operator new(s, 3);
1888 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1889 const Twine &NameStr = "",
1890 Instruction *InsertBefor = nullptr);
1891 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1892 const Twine &NameStr, BasicBlock *InsertAtEnd);
1894 /// isValidOperands - Return true if a shufflevector instruction can be
1895 /// formed with the specified operands.
1896 static bool isValidOperands(const Value *V1, const Value *V2,
1899 /// getType - Overload to return most specific vector type.
1901 VectorType *getType() const {
1902 return cast<VectorType>(Instruction::getType());
1905 /// Transparently provide more efficient getOperand methods.
1906 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1908 Constant *getMask() const {
1909 return cast<Constant>(getOperand(2));
1912 /// getMaskValue - Return the index from the shuffle mask for the specified
1913 /// output result. This is either -1 if the element is undef or a number less
1914 /// than 2*numelements.
1915 static int getMaskValue(Constant *Mask, unsigned i);
1917 int getMaskValue(unsigned i) const {
1918 return getMaskValue(getMask(), i);
1921 /// getShuffleMask - Return the full mask for this instruction, where each
1922 /// element is the element number and undef's are returned as -1.
1923 static void getShuffleMask(Constant *Mask, SmallVectorImpl<int> &Result);
1925 void getShuffleMask(SmallVectorImpl<int> &Result) const {
1926 return getShuffleMask(getMask(), Result);
1929 SmallVector<int, 16> getShuffleMask() const {
1930 SmallVector<int, 16> Mask;
1931 getShuffleMask(Mask);
1936 // Methods for support type inquiry through isa, cast, and dyn_cast:
1937 static inline bool classof(const Instruction *I) {
1938 return I->getOpcode() == Instruction::ShuffleVector;
1940 static inline bool classof(const Value *V) {
1941 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1946 struct OperandTraits<ShuffleVectorInst> :
1947 public FixedNumOperandTraits<ShuffleVectorInst, 3> {
1950 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1952 //===----------------------------------------------------------------------===//
1953 // ExtractValueInst Class
1954 //===----------------------------------------------------------------------===//
1956 /// ExtractValueInst - This instruction extracts a struct member or array
1957 /// element value from an aggregate value.
1959 class ExtractValueInst : public UnaryInstruction {
1960 SmallVector<unsigned, 4> Indices;
1962 ExtractValueInst(const ExtractValueInst &EVI);
1963 void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
1965 /// Constructors - Create a extractvalue instruction with a base aggregate
1966 /// value and a list of indices. The first ctor can optionally insert before
1967 /// an existing instruction, the second appends the new instruction to the
1968 /// specified BasicBlock.
1969 inline ExtractValueInst(Value *Agg,
1970 ArrayRef<unsigned> Idxs,
1971 const Twine &NameStr,
1972 Instruction *InsertBefore);
1973 inline ExtractValueInst(Value *Agg,
1974 ArrayRef<unsigned> Idxs,
1975 const Twine &NameStr, BasicBlock *InsertAtEnd);
1977 // allocate space for exactly one operand
1978 void *operator new(size_t s) {
1979 return User::operator new(s, 1);
1982 ExtractValueInst *clone_impl() const override;
1985 static ExtractValueInst *Create(Value *Agg,
1986 ArrayRef<unsigned> Idxs,
1987 const Twine &NameStr = "",
1988 Instruction *InsertBefore = nullptr) {
1990 ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
1992 static ExtractValueInst *Create(Value *Agg,
1993 ArrayRef<unsigned> Idxs,
1994 const Twine &NameStr,
1995 BasicBlock *InsertAtEnd) {
1996 return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
1999 /// getIndexedType - Returns the type of the element that would be extracted
2000 /// with an extractvalue instruction with the specified parameters.
2002 /// Null is returned if the indices are invalid for the specified type.
2003 static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
2005 typedef const unsigned* idx_iterator;
2006 inline idx_iterator idx_begin() const { return Indices.begin(); }
2007 inline idx_iterator idx_end() const { return Indices.end(); }
2008 inline iterator_range<idx_iterator> indices() const {
2009 return iterator_range<idx_iterator>(idx_begin(), idx_end());
2012 Value *getAggregateOperand() {
2013 return getOperand(0);
2015 const Value *getAggregateOperand() const {
2016 return getOperand(0);
2018 static unsigned getAggregateOperandIndex() {
2019 return 0U; // get index for modifying correct operand
2022 ArrayRef<unsigned> getIndices() const {
2026 unsigned getNumIndices() const {
2027 return (unsigned)Indices.size();
2030 bool hasIndices() const {
2034 // Methods for support type inquiry through isa, cast, and dyn_cast:
2035 static inline bool classof(const Instruction *I) {
2036 return I->getOpcode() == Instruction::ExtractValue;
2038 static inline bool classof(const Value *V) {
2039 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2043 ExtractValueInst::ExtractValueInst(Value *Agg,
2044 ArrayRef<unsigned> Idxs,
2045 const Twine &NameStr,
2046 Instruction *InsertBefore)
2047 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2048 ExtractValue, Agg, InsertBefore) {
2049 init(Idxs, NameStr);
2051 ExtractValueInst::ExtractValueInst(Value *Agg,
2052 ArrayRef<unsigned> Idxs,
2053 const Twine &NameStr,
2054 BasicBlock *InsertAtEnd)
2055 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2056 ExtractValue, Agg, InsertAtEnd) {
2057 init(Idxs, NameStr);
2061 //===----------------------------------------------------------------------===//
2062 // InsertValueInst Class
2063 //===----------------------------------------------------------------------===//
2065 /// InsertValueInst - This instruction inserts a struct field of array element
2066 /// value into an aggregate value.
2068 class InsertValueInst : public Instruction {
2069 SmallVector<unsigned, 4> Indices;
2071 void *operator new(size_t, unsigned) = delete;
2072 InsertValueInst(const InsertValueInst &IVI);
2073 void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
2074 const Twine &NameStr);
2076 /// Constructors - Create a insertvalue instruction with a base aggregate
2077 /// value, a value to insert, and a list of indices. The first ctor can
2078 /// optionally insert before an existing instruction, the second appends
2079 /// the new instruction to the specified BasicBlock.
2080 inline InsertValueInst(Value *Agg, Value *Val,
2081 ArrayRef<unsigned> Idxs,
2082 const Twine &NameStr,
2083 Instruction *InsertBefore);
2084 inline InsertValueInst(Value *Agg, Value *Val,
2085 ArrayRef<unsigned> Idxs,
2086 const Twine &NameStr, BasicBlock *InsertAtEnd);
2088 /// Constructors - These two constructors are convenience methods because one
2089 /// and two index insertvalue instructions are so common.
2090 InsertValueInst(Value *Agg, Value *Val,
2091 unsigned Idx, const Twine &NameStr = "",
2092 Instruction *InsertBefore = nullptr);
2093 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
2094 const Twine &NameStr, BasicBlock *InsertAtEnd);
2096 InsertValueInst *clone_impl() const override;
2098 // allocate space for exactly two operands
2099 void *operator new(size_t s) {
2100 return User::operator new(s, 2);
2103 static InsertValueInst *Create(Value *Agg, Value *Val,
2104 ArrayRef<unsigned> Idxs,
2105 const Twine &NameStr = "",
2106 Instruction *InsertBefore = nullptr) {
2107 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
2109 static InsertValueInst *Create(Value *Agg, Value *Val,
2110 ArrayRef<unsigned> Idxs,
2111 const Twine &NameStr,
2112 BasicBlock *InsertAtEnd) {
2113 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
2116 /// Transparently provide more efficient getOperand methods.
2117 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2119 typedef const unsigned* idx_iterator;
2120 inline idx_iterator idx_begin() const { return Indices.begin(); }
2121 inline idx_iterator idx_end() const { return Indices.end(); }
2122 inline iterator_range<idx_iterator> indices() const {
2123 return iterator_range<idx_iterator>(idx_begin(), idx_end());
2126 Value *getAggregateOperand() {
2127 return getOperand(0);
2129 const Value *getAggregateOperand() const {
2130 return getOperand(0);
2132 static unsigned getAggregateOperandIndex() {
2133 return 0U; // get index for modifying correct operand
2136 Value *getInsertedValueOperand() {
2137 return getOperand(1);
2139 const Value *getInsertedValueOperand() const {
2140 return getOperand(1);
2142 static unsigned getInsertedValueOperandIndex() {
2143 return 1U; // get index for modifying correct operand
2146 ArrayRef<unsigned> getIndices() const {
2150 unsigned getNumIndices() const {
2151 return (unsigned)Indices.size();
2154 bool hasIndices() const {
2158 // Methods for support type inquiry through isa, cast, and dyn_cast:
2159 static inline bool classof(const Instruction *I) {
2160 return I->getOpcode() == Instruction::InsertValue;
2162 static inline bool classof(const Value *V) {
2163 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2168 struct OperandTraits<InsertValueInst> :
2169 public FixedNumOperandTraits<InsertValueInst, 2> {
2172 InsertValueInst::InsertValueInst(Value *Agg,
2174 ArrayRef<unsigned> Idxs,
2175 const Twine &NameStr,
2176 Instruction *InsertBefore)
2177 : Instruction(Agg->getType(), InsertValue,
2178 OperandTraits<InsertValueInst>::op_begin(this),
2180 init(Agg, Val, Idxs, NameStr);
2182 InsertValueInst::InsertValueInst(Value *Agg,
2184 ArrayRef<unsigned> Idxs,
2185 const Twine &NameStr,
2186 BasicBlock *InsertAtEnd)
2187 : Instruction(Agg->getType(), InsertValue,
2188 OperandTraits<InsertValueInst>::op_begin(this),
2190 init(Agg, Val, Idxs, NameStr);
2193 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
2195 //===----------------------------------------------------------------------===//
2197 //===----------------------------------------------------------------------===//
2199 // PHINode - The PHINode class is used to represent the magical mystical PHI
2200 // node, that can not exist in nature, but can be synthesized in a computer
2201 // scientist's overactive imagination.
2203 class PHINode : public Instruction {
2204 void *operator new(size_t, unsigned) = delete;
2205 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2206 /// the number actually in use.
2207 unsigned ReservedSpace;
2208 PHINode(const PHINode &PN);
2209 // allocate space for exactly zero operands
2210 void *operator new(size_t s) {
2211 return User::operator new(s, 0);
2213 explicit PHINode(Type *Ty, unsigned NumReservedValues,
2214 const Twine &NameStr = "",
2215 Instruction *InsertBefore = nullptr)
2216 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertBefore),
2217 ReservedSpace(NumReservedValues) {
2219 OperandList = allocHungoffUses(ReservedSpace);
2222 PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
2223 BasicBlock *InsertAtEnd)
2224 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertAtEnd),
2225 ReservedSpace(NumReservedValues) {
2227 OperandList = allocHungoffUses(ReservedSpace);
2230 // allocHungoffUses - this is more complicated than the generic
2231 // User::allocHungoffUses, because we have to allocate Uses for the incoming
2232 // values and pointers to the incoming blocks, all in one allocation.
2233 Use *allocHungoffUses(unsigned) const;
2235 PHINode *clone_impl() const override;
2237 /// Constructors - NumReservedValues is a hint for the number of incoming
2238 /// edges that this phi node will have (use 0 if you really have no idea).
2239 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2240 const Twine &NameStr = "",
2241 Instruction *InsertBefore = nullptr) {
2242 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2244 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2245 const Twine &NameStr, BasicBlock *InsertAtEnd) {
2246 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2248 ~PHINode() override;
2250 /// Provide fast operand accessors
2251 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2253 // Block iterator interface. This provides access to the list of incoming
2254 // basic blocks, which parallels the list of incoming values.
2256 typedef BasicBlock **block_iterator;
2257 typedef BasicBlock * const *const_block_iterator;
2259 block_iterator block_begin() {
2261 reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2262 return reinterpret_cast<block_iterator>(ref + 1);
2265 const_block_iterator block_begin() const {
2266 const Use::UserRef *ref =
2267 reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2268 return reinterpret_cast<const_block_iterator>(ref + 1);
2271 block_iterator block_end() {
2272 return block_begin() + getNumOperands();
2275 const_block_iterator block_end() const {
2276 return block_begin() + getNumOperands();
2279 op_range incoming_values() { return operands(); }
2281 /// getNumIncomingValues - Return the number of incoming edges
2283 unsigned getNumIncomingValues() const { return getNumOperands(); }
2285 /// getIncomingValue - Return incoming value number x
2287 Value *getIncomingValue(unsigned i) const {
2288 return getOperand(i);
2290 void setIncomingValue(unsigned i, Value *V) {
2293 static unsigned getOperandNumForIncomingValue(unsigned i) {
2296 static unsigned getIncomingValueNumForOperand(unsigned i) {
2300 /// getIncomingBlock - Return incoming basic block number @p i.
2302 BasicBlock *getIncomingBlock(unsigned i) const {
2303 return block_begin()[i];
2306 /// getIncomingBlock - Return incoming basic block corresponding
2307 /// to an operand of the PHI.
2309 BasicBlock *getIncomingBlock(const Use &U) const {
2310 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2311 return getIncomingBlock(unsigned(&U - op_begin()));
2314 /// getIncomingBlock - Return incoming basic block corresponding
2315 /// to value use iterator.
2317 BasicBlock *getIncomingBlock(Value::const_user_iterator I) const {
2318 return getIncomingBlock(I.getUse());
2321 void setIncomingBlock(unsigned i, BasicBlock *BB) {
2322 block_begin()[i] = BB;
2325 /// addIncoming - Add an incoming value to the end of the PHI list
2327 void addIncoming(Value *V, BasicBlock *BB) {
2328 assert(V && "PHI node got a null value!");
2329 assert(BB && "PHI node got a null basic block!");
2330 assert(getType() == V->getType() &&
2331 "All operands to PHI node must be the same type as the PHI node!");
2332 if (NumOperands == ReservedSpace)
2333 growOperands(); // Get more space!
2334 // Initialize some new operands.
2336 setIncomingValue(NumOperands - 1, V);
2337 setIncomingBlock(NumOperands - 1, BB);
2340 /// removeIncomingValue - Remove an incoming value. This is useful if a
2341 /// predecessor basic block is deleted. The value removed is returned.
2343 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2344 /// is true), the PHI node is destroyed and any uses of it are replaced with
2345 /// dummy values. The only time there should be zero incoming values to a PHI
2346 /// node is when the block is dead, so this strategy is sound.
2348 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2350 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2351 int Idx = getBasicBlockIndex(BB);
2352 assert(Idx >= 0 && "Invalid basic block argument to remove!");
2353 return removeIncomingValue(Idx, DeletePHIIfEmpty);
2356 /// getBasicBlockIndex - Return the first index of the specified basic
2357 /// block in the value list for this PHI. Returns -1 if no instance.
2359 int getBasicBlockIndex(const BasicBlock *BB) const {
2360 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2361 if (block_begin()[i] == BB)
2366 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2367 int Idx = getBasicBlockIndex(BB);
2368 assert(Idx >= 0 && "Invalid basic block argument!");
2369 return getIncomingValue(Idx);
2372 /// hasConstantValue - If the specified PHI node always merges together the
2373 /// same value, return the value, otherwise return null.
2374 Value *hasConstantValue() const;
2376 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2377 static inline bool classof(const Instruction *I) {
2378 return I->getOpcode() == Instruction::PHI;
2380 static inline bool classof(const Value *V) {
2381 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2384 void growOperands();
2388 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2391 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2393 //===----------------------------------------------------------------------===//
2394 // LandingPadInst Class
2395 //===----------------------------------------------------------------------===//
2397 //===---------------------------------------------------------------------------
2398 /// LandingPadInst - The landingpad instruction holds all of the information
2399 /// necessary to generate correct exception handling. The landingpad instruction
2400 /// cannot be moved from the top of a landing pad block, which itself is
2401 /// accessible only from the 'unwind' edge of an invoke. This uses the
2402 /// SubclassData field in Value to store whether or not the landingpad is a
2405 class LandingPadInst : public Instruction {
2406 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2407 /// the number actually in use.
2408 unsigned ReservedSpace;
2409 LandingPadInst(const LandingPadInst &LP);
2411 enum ClauseType { Catch, Filter };
2413 void *operator new(size_t, unsigned) = delete;
2414 // Allocate space for exactly zero operands.
2415 void *operator new(size_t s) {
2416 return User::operator new(s, 0);
2418 void growOperands(unsigned Size);
2419 void init(Value *PersFn, unsigned NumReservedValues, const Twine &NameStr);
2421 explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2422 unsigned NumReservedValues, const Twine &NameStr,
2423 Instruction *InsertBefore);
2424 explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2425 unsigned NumReservedValues, const Twine &NameStr,
2426 BasicBlock *InsertAtEnd);
2428 LandingPadInst *clone_impl() const override;
2430 /// Constructors - NumReservedClauses is a hint for the number of incoming
2431 /// clauses that this landingpad will have (use 0 if you really have no idea).
2432 static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2433 unsigned NumReservedClauses,
2434 const Twine &NameStr = "",
2435 Instruction *InsertBefore = nullptr);
2436 static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2437 unsigned NumReservedClauses,
2438 const Twine &NameStr, BasicBlock *InsertAtEnd);
2439 ~LandingPadInst() override;
2441 /// Provide fast operand accessors
2442 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2444 /// getPersonalityFn - Get the personality function associated with this
2446 Value *getPersonalityFn() const { return getOperand(0); }
2448 /// isCleanup - Return 'true' if this landingpad instruction is a
2449 /// cleanup. I.e., it should be run when unwinding even if its landing pad
2450 /// doesn't catch the exception.
2451 bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2453 /// setCleanup - Indicate that this landingpad instruction is a cleanup.
2454 void setCleanup(bool V) {
2455 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2459 /// Add a catch or filter clause to the landing pad.
2460 void addClause(Constant *ClauseVal);
2462 /// Get the value of the clause at index Idx. Use isCatch/isFilter to
2463 /// determine what type of clause this is.
2464 Constant *getClause(unsigned Idx) const {
2465 return cast<Constant>(OperandList[Idx + 1]);
2468 /// isCatch - Return 'true' if the clause and index Idx is a catch clause.
2469 bool isCatch(unsigned Idx) const {
2470 return !isa<ArrayType>(OperandList[Idx + 1]->getType());
2473 /// isFilter - Return 'true' if the clause and index Idx is a filter clause.
2474 bool isFilter(unsigned Idx) const {
2475 return isa<ArrayType>(OperandList[Idx + 1]->getType());
2478 /// getNumClauses - Get the number of clauses for this landing pad.
2479 unsigned getNumClauses() const { return getNumOperands() - 1; }
2481 /// reserveClauses - Grow the size of the operand list to accommodate the new
2482 /// number of clauses.
2483 void reserveClauses(unsigned Size) { growOperands(Size); }
2485 // Methods for support type inquiry through isa, cast, and dyn_cast:
2486 static inline bool classof(const Instruction *I) {
2487 return I->getOpcode() == Instruction::LandingPad;
2489 static inline bool classof(const Value *V) {
2490 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2495 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<2> {
2498 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2500 //===----------------------------------------------------------------------===//
2502 //===----------------------------------------------------------------------===//
2504 //===---------------------------------------------------------------------------
2505 /// ReturnInst - Return a value (possibly void), from a function. Execution
2506 /// does not continue in this function any longer.
2508 class ReturnInst : public TerminatorInst {
2509 ReturnInst(const ReturnInst &RI);
2512 // ReturnInst constructors:
2513 // ReturnInst() - 'ret void' instruction
2514 // ReturnInst( null) - 'ret void' instruction
2515 // ReturnInst(Value* X) - 'ret X' instruction
2516 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2517 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2518 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2519 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2521 // NOTE: If the Value* passed is of type void then the constructor behaves as
2522 // if it was passed NULL.
2523 explicit ReturnInst(LLVMContext &C, Value *retVal = nullptr,
2524 Instruction *InsertBefore = nullptr);
2525 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2526 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2528 ReturnInst *clone_impl() const override;
2530 static ReturnInst* Create(LLVMContext &C, Value *retVal = nullptr,
2531 Instruction *InsertBefore = nullptr) {
2532 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2534 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2535 BasicBlock *InsertAtEnd) {
2536 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2538 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2539 return new(0) ReturnInst(C, InsertAtEnd);
2541 ~ReturnInst() override;
2543 /// Provide fast operand accessors
2544 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2546 /// Convenience accessor. Returns null if there is no return value.
2547 Value *getReturnValue() const {
2548 return getNumOperands() != 0 ? getOperand(0) : nullptr;
2551 unsigned getNumSuccessors() const { return 0; }
2553 // Methods for support type inquiry through isa, cast, and dyn_cast:
2554 static inline bool classof(const Instruction *I) {
2555 return (I->getOpcode() == Instruction::Ret);
2557 static inline bool classof(const Value *V) {
2558 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2561 BasicBlock *getSuccessorV(unsigned idx) const override;
2562 unsigned getNumSuccessorsV() const override;
2563 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2567 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2570 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2572 //===----------------------------------------------------------------------===//
2574 //===----------------------------------------------------------------------===//
2576 //===---------------------------------------------------------------------------
2577 /// BranchInst - Conditional or Unconditional Branch instruction.
2579 class BranchInst : public TerminatorInst {
2580 /// Ops list - Branches are strange. The operands are ordered:
2581 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2582 /// they don't have to check for cond/uncond branchness. These are mostly
2583 /// accessed relative from op_end().
2584 BranchInst(const BranchInst &BI);
2586 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2587 // BranchInst(BB *B) - 'br B'
2588 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2589 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2590 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2591 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2592 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2593 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = nullptr);
2594 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2595 Instruction *InsertBefore = nullptr);
2596 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2597 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2598 BasicBlock *InsertAtEnd);
2600 BranchInst *clone_impl() const override;
2602 static BranchInst *Create(BasicBlock *IfTrue,
2603 Instruction *InsertBefore = nullptr) {
2604 return new(1) BranchInst(IfTrue, InsertBefore);
2606 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2607 Value *Cond, Instruction *InsertBefore = nullptr) {
2608 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2610 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2611 return new(1) BranchInst(IfTrue, InsertAtEnd);
2613 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2614 Value *Cond, BasicBlock *InsertAtEnd) {
2615 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2618 /// Transparently provide more efficient getOperand methods.
2619 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2621 bool isUnconditional() const { return getNumOperands() == 1; }
2622 bool isConditional() const { return getNumOperands() == 3; }
2624 Value *getCondition() const {
2625 assert(isConditional() && "Cannot get condition of an uncond branch!");
2629 void setCondition(Value *V) {
2630 assert(isConditional() && "Cannot set condition of unconditional branch!");
2634 unsigned getNumSuccessors() const { return 1+isConditional(); }
2636 BasicBlock *getSuccessor(unsigned i) const {
2637 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2638 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2641 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2642 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2643 *(&Op<-1>() - idx) = (Value*)NewSucc;
2646 /// \brief Swap the successors of this branch instruction.
2648 /// Swaps the successors of the branch instruction. This also swaps any
2649 /// branch weight metadata associated with the instruction so that it
2650 /// continues to map correctly to each operand.
2651 void swapSuccessors();
2653 // Methods for support type inquiry through isa, cast, and dyn_cast:
2654 static inline bool classof(const Instruction *I) {
2655 return (I->getOpcode() == Instruction::Br);
2657 static inline bool classof(const Value *V) {
2658 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2661 BasicBlock *getSuccessorV(unsigned idx) const override;
2662 unsigned getNumSuccessorsV() const override;
2663 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2667 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2670 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2672 //===----------------------------------------------------------------------===//
2674 //===----------------------------------------------------------------------===//
2676 //===---------------------------------------------------------------------------
2677 /// SwitchInst - Multiway switch
2679 class SwitchInst : public TerminatorInst {
2680 void *operator new(size_t, unsigned) = delete;
2681 unsigned ReservedSpace;
2682 // Operand[0] = Value to switch on
2683 // Operand[1] = Default basic block destination
2684 // Operand[2n ] = Value to match
2685 // Operand[2n+1] = BasicBlock to go to on match
2686 SwitchInst(const SwitchInst &SI);
2687 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2688 void growOperands();
2689 // allocate space for exactly zero operands
2690 void *operator new(size_t s) {
2691 return User::operator new(s, 0);
2693 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2694 /// switch on and a default destination. The number of additional cases can
2695 /// be specified here to make memory allocation more efficient. This
2696 /// constructor can also autoinsert before another instruction.
2697 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2698 Instruction *InsertBefore);
2700 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2701 /// switch on and a default destination. The number of additional cases can
2702 /// be specified here to make memory allocation more efficient. This
2703 /// constructor also autoinserts at the end of the specified BasicBlock.
2704 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2705 BasicBlock *InsertAtEnd);
2707 SwitchInst *clone_impl() const override;
2711 static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
2713 template <class SwitchInstTy, class ConstantIntTy, class BasicBlockTy>
2714 class CaseIteratorT {
2722 typedef CaseIteratorT<SwitchInstTy, ConstantIntTy, BasicBlockTy> Self;
2724 /// Initializes case iterator for given SwitchInst and for given
2726 CaseIteratorT(SwitchInstTy *SI, unsigned CaseNum) {
2731 /// Initializes case iterator for given SwitchInst and for given
2732 /// TerminatorInst's successor index.
2733 static Self fromSuccessorIndex(SwitchInstTy *SI, unsigned SuccessorIndex) {
2734 assert(SuccessorIndex < SI->getNumSuccessors() &&
2735 "Successor index # out of range!");
2736 return SuccessorIndex != 0 ?
2737 Self(SI, SuccessorIndex - 1) :
2738 Self(SI, DefaultPseudoIndex);
2741 /// Resolves case value for current case.
2742 ConstantIntTy *getCaseValue() {
2743 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2744 return reinterpret_cast<ConstantIntTy*>(SI->getOperand(2 + Index*2));
2747 /// Resolves successor for current case.
2748 BasicBlockTy *getCaseSuccessor() {
2749 assert((Index < SI->getNumCases() ||
2750 Index == DefaultPseudoIndex) &&
2751 "Index out the number of cases.");
2752 return SI->getSuccessor(getSuccessorIndex());
2755 /// Returns number of current case.
2756 unsigned getCaseIndex() const { return Index; }
2758 /// Returns TerminatorInst's successor index for current case successor.
2759 unsigned getSuccessorIndex() const {
2760 assert((Index == DefaultPseudoIndex || Index < SI->getNumCases()) &&
2761 "Index out the number of cases.");
2762 return Index != DefaultPseudoIndex ? Index + 1 : 0;
2766 // Check index correctness after increment.
2767 // Note: Index == getNumCases() means end().
2768 assert(Index+1 <= SI->getNumCases() && "Index out the number of cases.");
2772 Self operator++(int) {
2778 // Check index correctness after decrement.
2779 // Note: Index == getNumCases() means end().
2780 // Also allow "-1" iterator here. That will became valid after ++.
2781 assert((Index == 0 || Index-1 <= SI->getNumCases()) &&
2782 "Index out the number of cases.");
2786 Self operator--(int) {
2791 bool operator==(const Self& RHS) const {
2792 assert(RHS.SI == SI && "Incompatible operators.");
2793 return RHS.Index == Index;
2795 bool operator!=(const Self& RHS) const {
2796 assert(RHS.SI == SI && "Incompatible operators.");
2797 return RHS.Index != Index;
2804 typedef CaseIteratorT<const SwitchInst, const ConstantInt, const BasicBlock>
2807 class CaseIt : public CaseIteratorT<SwitchInst, ConstantInt, BasicBlock> {
2809 typedef CaseIteratorT<SwitchInst, ConstantInt, BasicBlock> ParentTy;
2813 CaseIt(const ParentTy& Src) : ParentTy(Src) {}
2814 CaseIt(SwitchInst *SI, unsigned CaseNum) : ParentTy(SI, CaseNum) {}
2816 /// Sets the new value for current case.
2817 void setValue(ConstantInt *V) {
2818 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2819 SI->setOperand(2 + Index*2, reinterpret_cast<Value*>(V));
2822 /// Sets the new successor for current case.
2823 void setSuccessor(BasicBlock *S) {
2824 SI->setSuccessor(getSuccessorIndex(), S);
2828 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2830 Instruction *InsertBefore = nullptr) {
2831 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2833 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2834 unsigned NumCases, BasicBlock *InsertAtEnd) {
2835 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2838 ~SwitchInst() override;
2840 /// Provide fast operand accessors
2841 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2843 // Accessor Methods for Switch stmt
2844 Value *getCondition() const { return getOperand(0); }
2845 void setCondition(Value *V) { setOperand(0, V); }
2847 BasicBlock *getDefaultDest() const {
2848 return cast<BasicBlock>(getOperand(1));
2851 void setDefaultDest(BasicBlock *DefaultCase) {
2852 setOperand(1, reinterpret_cast<Value*>(DefaultCase));
2855 /// getNumCases - return the number of 'cases' in this switch instruction,
2856 /// except the default case
2857 unsigned getNumCases() const {
2858 return getNumOperands()/2 - 1;
2861 /// Returns a read/write iterator that points to the first
2862 /// case in SwitchInst.
2863 CaseIt case_begin() {
2864 return CaseIt(this, 0);
2866 /// Returns a read-only iterator that points to the first
2867 /// case in the SwitchInst.
2868 ConstCaseIt case_begin() const {
2869 return ConstCaseIt(this, 0);
2872 /// Returns a read/write iterator that points one past the last
2873 /// in the SwitchInst.
2875 return CaseIt(this, getNumCases());
2877 /// Returns a read-only iterator that points one past the last
2878 /// in the SwitchInst.
2879 ConstCaseIt case_end() const {
2880 return ConstCaseIt(this, getNumCases());
2883 /// cases - iteration adapter for range-for loops.
2884 iterator_range<CaseIt> cases() {
2885 return iterator_range<CaseIt>(case_begin(), case_end());
2888 /// cases - iteration adapter for range-for loops.
2889 iterator_range<ConstCaseIt> cases() const {
2890 return iterator_range<ConstCaseIt>(case_begin(), case_end());
2893 /// Returns an iterator that points to the default case.
2894 /// Note: this iterator allows to resolve successor only. Attempt
2895 /// to resolve case value causes an assertion.
2896 /// Also note, that increment and decrement also causes an assertion and
2897 /// makes iterator invalid.
2898 CaseIt case_default() {
2899 return CaseIt(this, DefaultPseudoIndex);
2901 ConstCaseIt case_default() const {
2902 return ConstCaseIt(this, DefaultPseudoIndex);
2905 /// findCaseValue - Search all of the case values for the specified constant.
2906 /// If it is explicitly handled, return the case iterator of it, otherwise
2907 /// return default case iterator to indicate
2908 /// that it is handled by the default handler.
2909 CaseIt findCaseValue(const ConstantInt *C) {
2910 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i)
2911 if (i.getCaseValue() == C)
2913 return case_default();
2915 ConstCaseIt findCaseValue(const ConstantInt *C) const {
2916 for (ConstCaseIt i = case_begin(), e = case_end(); i != e; ++i)
2917 if (i.getCaseValue() == C)
2919 return case_default();
2922 /// findCaseDest - Finds the unique case value for a given successor. Returns
2923 /// null if the successor is not found, not unique, or is the default case.
2924 ConstantInt *findCaseDest(BasicBlock *BB) {
2925 if (BB == getDefaultDest()) return nullptr;
2927 ConstantInt *CI = nullptr;
2928 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i) {
2929 if (i.getCaseSuccessor() == BB) {
2930 if (CI) return nullptr; // Multiple cases lead to BB.
2931 else CI = i.getCaseValue();
2937 /// addCase - Add an entry to the switch instruction...
2939 /// This action invalidates case_end(). Old case_end() iterator will
2940 /// point to the added case.
2941 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2943 /// removeCase - This method removes the specified case and its successor
2944 /// from the switch instruction. Note that this operation may reorder the
2945 /// remaining cases at index idx and above.
2947 /// This action invalidates iterators for all cases following the one removed,
2948 /// including the case_end() iterator.
2949 void removeCase(CaseIt i);
2951 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2952 BasicBlock *getSuccessor(unsigned idx) const {
2953 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2954 return cast<BasicBlock>(getOperand(idx*2+1));
2956 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2957 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2958 setOperand(idx*2+1, (Value*)NewSucc);
2961 // Methods for support type inquiry through isa, cast, and dyn_cast:
2962 static inline bool classof(const Instruction *I) {
2963 return I->getOpcode() == Instruction::Switch;
2965 static inline bool classof(const Value *V) {
2966 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2969 BasicBlock *getSuccessorV(unsigned idx) const override;
2970 unsigned getNumSuccessorsV() const override;
2971 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2975 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2978 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2981 //===----------------------------------------------------------------------===//
2982 // IndirectBrInst Class
2983 //===----------------------------------------------------------------------===//
2985 //===---------------------------------------------------------------------------
2986 /// IndirectBrInst - Indirect Branch Instruction.
2988 class IndirectBrInst : public TerminatorInst {
2989 void *operator new(size_t, unsigned) = delete;
2990 unsigned ReservedSpace;
2991 // Operand[0] = Value to switch on
2992 // Operand[1] = Default basic block destination
2993 // Operand[2n ] = Value to match
2994 // Operand[2n+1] = BasicBlock to go to on match
2995 IndirectBrInst(const IndirectBrInst &IBI);
2996 void init(Value *Address, unsigned NumDests);
2997 void growOperands();
2998 // allocate space for exactly zero operands
2999 void *operator new(size_t s) {
3000 return User::operator new(s, 0);
3002 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
3003 /// Address to jump to. The number of expected destinations can be specified
3004 /// here to make memory allocation more efficient. This constructor can also
3005 /// autoinsert before another instruction.
3006 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
3008 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
3009 /// Address to jump to. The number of expected destinations can be specified
3010 /// here to make memory allocation more efficient. This constructor also
3011 /// autoinserts at the end of the specified BasicBlock.
3012 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
3014 IndirectBrInst *clone_impl() const override;
3016 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3017 Instruction *InsertBefore = nullptr) {
3018 return new IndirectBrInst(Address, NumDests, InsertBefore);
3020 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3021 BasicBlock *InsertAtEnd) {
3022 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
3024 ~IndirectBrInst() override;
3026 /// Provide fast operand accessors.
3027 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3029 // Accessor Methods for IndirectBrInst instruction.
3030 Value *getAddress() { return getOperand(0); }
3031 const Value *getAddress() const { return getOperand(0); }
3032 void setAddress(Value *V) { setOperand(0, V); }
3035 /// getNumDestinations - return the number of possible destinations in this
3036 /// indirectbr instruction.
3037 unsigned getNumDestinations() const { return getNumOperands()-1; }
3039 /// getDestination - Return the specified destination.
3040 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
3041 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
3043 /// addDestination - Add a destination.
3045 void addDestination(BasicBlock *Dest);
3047 /// removeDestination - This method removes the specified successor from the
3048 /// indirectbr instruction.
3049 void removeDestination(unsigned i);
3051 unsigned getNumSuccessors() const { return getNumOperands()-1; }
3052 BasicBlock *getSuccessor(unsigned i) const {
3053 return cast<BasicBlock>(getOperand(i+1));
3055 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
3056 setOperand(i+1, (Value*)NewSucc);
3059 // Methods for support type inquiry through isa, cast, and dyn_cast:
3060 static inline bool classof(const Instruction *I) {
3061 return I->getOpcode() == Instruction::IndirectBr;
3063 static inline bool classof(const Value *V) {
3064 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3067 BasicBlock *getSuccessorV(unsigned idx) const override;
3068 unsigned getNumSuccessorsV() const override;
3069 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3073 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
3076 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
3079 //===----------------------------------------------------------------------===//
3081 //===----------------------------------------------------------------------===//
3083 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
3084 /// calling convention of the call.
3086 class InvokeInst : public TerminatorInst {
3087 AttributeSet AttributeList;
3089 InvokeInst(const InvokeInst &BI);
3090 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3091 ArrayRef<Value *> Args, const Twine &NameStr);
3093 /// Construct an InvokeInst given a range of arguments.
3095 /// \brief Construct an InvokeInst from a range of arguments
3096 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3097 ArrayRef<Value *> Args, unsigned Values,
3098 const Twine &NameStr, Instruction *InsertBefore);
3100 /// Construct an InvokeInst given a range of arguments.
3102 /// \brief Construct an InvokeInst from a range of arguments
3103 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3104 ArrayRef<Value *> Args, unsigned Values,
3105 const Twine &NameStr, BasicBlock *InsertAtEnd);
3107 InvokeInst *clone_impl() const override;
3109 static InvokeInst *Create(Value *Func,
3110 BasicBlock *IfNormal, BasicBlock *IfException,
3111 ArrayRef<Value *> Args, const Twine &NameStr = "",
3112 Instruction *InsertBefore = nullptr) {
3113 unsigned Values = unsigned(Args.size()) + 3;
3114 return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3115 Values, NameStr, InsertBefore);
3117 static InvokeInst *Create(Value *Func,
3118 BasicBlock *IfNormal, BasicBlock *IfException,
3119 ArrayRef<Value *> Args, const Twine &NameStr,
3120 BasicBlock *InsertAtEnd) {
3121 unsigned Values = unsigned(Args.size()) + 3;
3122 return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3123 Values, NameStr, InsertAtEnd);
3126 /// Provide fast operand accessors
3127 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3129 FunctionType *getFunctionType() const { return FTy; }
3131 void mutateFunctionType(FunctionType *FTy) {
3132 mutateType(FTy->getReturnType());
3136 /// getNumArgOperands - Return the number of invoke arguments.
3138 unsigned getNumArgOperands() const { return getNumOperands() - 3; }
3140 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
3142 Value *getArgOperand(unsigned i) const { return getOperand(i); }
3143 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
3145 /// arg_operands - iteration adapter for range-for loops.
3146 iterator_range<op_iterator> arg_operands() {
3147 return iterator_range<op_iterator>(op_begin(), op_end() - 3);
3150 /// arg_operands - iteration adapter for range-for loops.
3151 iterator_range<const_op_iterator> arg_operands() const {
3152 return iterator_range<const_op_iterator>(op_begin(), op_end() - 3);
3155 /// \brief Wrappers for getting the \c Use of a invoke argument.
3156 const Use &getArgOperandUse(unsigned i) const { return getOperandUse(i); }
3157 Use &getArgOperandUse(unsigned i) { return getOperandUse(i); }
3159 /// getCallingConv/setCallingConv - Get or set the calling convention of this
3161 CallingConv::ID getCallingConv() const {
3162 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
3164 void setCallingConv(CallingConv::ID CC) {
3165 setInstructionSubclassData(static_cast<unsigned>(CC));
3168 /// getAttributes - Return the parameter attributes for this invoke.
3170 const AttributeSet &getAttributes() const { return AttributeList; }
3172 /// setAttributes - Set the parameter attributes for this invoke.
3174 void setAttributes(const AttributeSet &Attrs) { AttributeList = Attrs; }
3176 /// addAttribute - adds the attribute to the list of attributes.
3177 void addAttribute(unsigned i, Attribute::AttrKind attr);
3179 /// removeAttribute - removes the attribute from the list of attributes.
3180 void removeAttribute(unsigned i, Attribute attr);
3182 /// \brief adds the dereferenceable attribute to the list of attributes.
3183 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
3185 /// \brief adds the dereferenceable_or_null attribute to the list of
3187 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
3189 /// \brief Determine whether this call has the given attribute.
3190 bool hasFnAttr(Attribute::AttrKind A) const {
3191 assert(A != Attribute::NoBuiltin &&
3192 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
3193 return hasFnAttrImpl(A);
3196 /// \brief Determine whether the call or the callee has the given attributes.
3197 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const;
3199 /// \brief Extract the alignment for a call or parameter (0=unknown).
3200 unsigned getParamAlignment(unsigned i) const {
3201 return AttributeList.getParamAlignment(i);
3204 /// \brief Extract the number of dereferenceable bytes for a call or
3205 /// parameter (0=unknown).
3206 uint64_t getDereferenceableBytes(unsigned i) const {
3207 return AttributeList.getDereferenceableBytes(i);
3210 /// \brief Extract the number of dereferenceable_or_null bytes for a call or
3211 /// parameter (0=unknown).
3212 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
3213 return AttributeList.getDereferenceableOrNullBytes(i);
3216 /// \brief Return true if the call should not be treated as a call to a
3218 bool isNoBuiltin() const {
3219 // We assert in hasFnAttr if one passes in Attribute::NoBuiltin, so we have
3220 // to check it by hand.
3221 return hasFnAttrImpl(Attribute::NoBuiltin) &&
3222 !hasFnAttrImpl(Attribute::Builtin);
3225 /// \brief Return true if the call should not be inlined.
3226 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
3227 void setIsNoInline() {
3228 addAttribute(AttributeSet::FunctionIndex, Attribute::NoInline);
3231 /// \brief Determine if the call does not access memory.
3232 bool doesNotAccessMemory() const {
3233 return hasFnAttr(Attribute::ReadNone);
3235 void setDoesNotAccessMemory() {
3236 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
3239 /// \brief Determine if the call does not access or only reads memory.
3240 bool onlyReadsMemory() const {
3241 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
3243 void setOnlyReadsMemory() {
3244 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
3247 /// \brief Determine if the call cannot return.
3248 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
3249 void setDoesNotReturn() {
3250 addAttribute(AttributeSet::FunctionIndex, Attribute::NoReturn);
3253 /// \brief Determine if the call cannot unwind.
3254 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
3255 void setDoesNotThrow() {
3256 addAttribute(AttributeSet::FunctionIndex, Attribute::NoUnwind);
3259 /// \brief Determine if the invoke cannot be duplicated.
3260 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
3261 void setCannotDuplicate() {
3262 addAttribute(AttributeSet::FunctionIndex, Attribute::NoDuplicate);
3265 /// \brief Determine if the call returns a structure through first
3266 /// pointer argument.
3267 bool hasStructRetAttr() const {
3268 // Be friendly and also check the callee.
3269 return paramHasAttr(1, Attribute::StructRet);
3272 /// \brief Determine if any call argument is an aggregate passed by value.
3273 bool hasByValArgument() const {
3274 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
3277 /// getCalledFunction - Return the function called, or null if this is an
3278 /// indirect function invocation.
3280 Function *getCalledFunction() const {
3281 return dyn_cast<Function>(Op<-3>());
3284 /// getCalledValue - Get a pointer to the function that is invoked by this
3286 const Value *getCalledValue() const { return Op<-3>(); }
3287 Value *getCalledValue() { return Op<-3>(); }
3289 /// setCalledFunction - Set the function called.
3290 void setCalledFunction(Value* Fn) {
3292 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
3295 void setCalledFunction(FunctionType *FTy, Value *Fn) {
3297 assert(FTy == cast<FunctionType>(
3298 cast<PointerType>(Fn->getType())->getElementType()));
3302 // get*Dest - Return the destination basic blocks...
3303 BasicBlock *getNormalDest() const {
3304 return cast<BasicBlock>(Op<-2>());
3306 BasicBlock *getUnwindDest() const {
3307 return cast<BasicBlock>(Op<-1>());
3309 void setNormalDest(BasicBlock *B) {
3310 Op<-2>() = reinterpret_cast<Value*>(B);
3312 void setUnwindDest(BasicBlock *B) {
3313 Op<-1>() = reinterpret_cast<Value*>(B);
3316 /// getLandingPadInst - Get the landingpad instruction from the landing pad
3317 /// block (the unwind destination).
3318 LandingPadInst *getLandingPadInst() const;
3320 BasicBlock *getSuccessor(unsigned i) const {
3321 assert(i < 2 && "Successor # out of range for invoke!");
3322 return i == 0 ? getNormalDest() : getUnwindDest();
3325 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3326 assert(idx < 2 && "Successor # out of range for invoke!");
3327 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
3330 unsigned getNumSuccessors() const { return 2; }
3332 // Methods for support type inquiry through isa, cast, and dyn_cast:
3333 static inline bool classof(const Instruction *I) {
3334 return (I->getOpcode() == Instruction::Invoke);
3336 static inline bool classof(const Value *V) {
3337 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3341 BasicBlock *getSuccessorV(unsigned idx) const override;
3342 unsigned getNumSuccessorsV() const override;
3343 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3345 bool hasFnAttrImpl(Attribute::AttrKind A) const;
3347 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3348 // method so that subclasses cannot accidentally use it.
3349 void setInstructionSubclassData(unsigned short D) {
3350 Instruction::setInstructionSubclassData(D);
3355 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
3358 InvokeInst::InvokeInst(Value *Func,
3359 BasicBlock *IfNormal, BasicBlock *IfException,
3360 ArrayRef<Value *> Args, unsigned Values,
3361 const Twine &NameStr, Instruction *InsertBefore)
3362 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3363 ->getElementType())->getReturnType(),
3364 Instruction::Invoke,
3365 OperandTraits<InvokeInst>::op_end(this) - Values,
3366 Values, InsertBefore) {
3367 init(Func, IfNormal, IfException, Args, NameStr);
3369 InvokeInst::InvokeInst(Value *Func,
3370 BasicBlock *IfNormal, BasicBlock *IfException,
3371 ArrayRef<Value *> Args, unsigned Values,
3372 const Twine &NameStr, BasicBlock *InsertAtEnd)
3373 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3374 ->getElementType())->getReturnType(),
3375 Instruction::Invoke,
3376 OperandTraits<InvokeInst>::op_end(this) - Values,
3377 Values, InsertAtEnd) {
3378 init(Func, IfNormal, IfException, Args, NameStr);
3381 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
3383 //===----------------------------------------------------------------------===//
3385 //===----------------------------------------------------------------------===//
3387 //===---------------------------------------------------------------------------
3388 /// ResumeInst - Resume the propagation of an exception.
3390 class ResumeInst : public TerminatorInst {
3391 ResumeInst(const ResumeInst &RI);
3393 explicit ResumeInst(Value *Exn, Instruction *InsertBefore=nullptr);
3394 ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
3396 ResumeInst *clone_impl() const override;
3398 static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = nullptr) {
3399 return new(1) ResumeInst(Exn, InsertBefore);
3401 static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
3402 return new(1) ResumeInst(Exn, InsertAtEnd);
3405 /// Provide fast operand accessors
3406 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3408 /// Convenience accessor.
3409 Value *getValue() const { return Op<0>(); }
3411 unsigned getNumSuccessors() const { return 0; }
3413 // Methods for support type inquiry through isa, cast, and dyn_cast:
3414 static inline bool classof(const Instruction *I) {
3415 return I->getOpcode() == Instruction::Resume;
3417 static inline bool classof(const Value *V) {
3418 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3421 BasicBlock *getSuccessorV(unsigned idx) const override;
3422 unsigned getNumSuccessorsV() const override;
3423 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3427 struct OperandTraits<ResumeInst> :
3428 public FixedNumOperandTraits<ResumeInst, 1> {
3431 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
3433 //===----------------------------------------------------------------------===//
3434 // UnreachableInst Class
3435 //===----------------------------------------------------------------------===//
3437 //===---------------------------------------------------------------------------
3438 /// UnreachableInst - This function has undefined behavior. In particular, the
3439 /// presence of this instruction indicates some higher level knowledge that the
3440 /// end of the block cannot be reached.
3442 class UnreachableInst : public TerminatorInst {
3443 void *operator new(size_t, unsigned) = delete;
3445 UnreachableInst *clone_impl() const override;
3448 // allocate space for exactly zero operands
3449 void *operator new(size_t s) {
3450 return User::operator new(s, 0);
3452 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = nullptr);
3453 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
3455 unsigned getNumSuccessors() const { return 0; }
3457 // Methods for support type inquiry through isa, cast, and dyn_cast:
3458 static inline bool classof(const Instruction *I) {
3459 return I->getOpcode() == Instruction::Unreachable;
3461 static inline bool classof(const Value *V) {
3462 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3465 BasicBlock *getSuccessorV(unsigned idx) const override;
3466 unsigned getNumSuccessorsV() const override;
3467 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3470 //===----------------------------------------------------------------------===//
3472 //===----------------------------------------------------------------------===//
3474 /// \brief This class represents a truncation of integer types.
3475 class TruncInst : public CastInst {
3477 /// \brief Clone an identical TruncInst
3478 TruncInst *clone_impl() const override;
3481 /// \brief Constructor with insert-before-instruction semantics
3483 Value *S, ///< The value to be truncated
3484 Type *Ty, ///< The (smaller) type to truncate to
3485 const Twine &NameStr = "", ///< A name for the new instruction
3486 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3489 /// \brief Constructor with insert-at-end-of-block semantics
3491 Value *S, ///< The value to be truncated
3492 Type *Ty, ///< The (smaller) type to truncate to
3493 const Twine &NameStr, ///< A name for the new instruction
3494 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3497 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3498 static inline bool classof(const Instruction *I) {
3499 return I->getOpcode() == Trunc;
3501 static inline bool classof(const Value *V) {
3502 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3506 //===----------------------------------------------------------------------===//
3508 //===----------------------------------------------------------------------===//
3510 /// \brief This class represents zero extension of integer types.
3511 class ZExtInst : public CastInst {
3513 /// \brief Clone an identical ZExtInst
3514 ZExtInst *clone_impl() const override;
3517 /// \brief Constructor with insert-before-instruction semantics
3519 Value *S, ///< The value to be zero extended
3520 Type *Ty, ///< The type to zero extend to
3521 const Twine &NameStr = "", ///< A name for the new instruction
3522 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3525 /// \brief Constructor with insert-at-end semantics.
3527 Value *S, ///< The value to be zero extended
3528 Type *Ty, ///< The type to zero extend to
3529 const Twine &NameStr, ///< A name for the new instruction
3530 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3533 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3534 static inline bool classof(const Instruction *I) {
3535 return I->getOpcode() == ZExt;
3537 static inline bool classof(const Value *V) {
3538 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3542 //===----------------------------------------------------------------------===//
3544 //===----------------------------------------------------------------------===//
3546 /// \brief This class represents a sign extension of integer types.
3547 class SExtInst : public CastInst {
3549 /// \brief Clone an identical SExtInst
3550 SExtInst *clone_impl() const override;
3553 /// \brief Constructor with insert-before-instruction semantics
3555 Value *S, ///< The value to be sign extended
3556 Type *Ty, ///< The type to sign extend to
3557 const Twine &NameStr = "", ///< A name for the new instruction
3558 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3561 /// \brief Constructor with insert-at-end-of-block semantics
3563 Value *S, ///< The value to be sign extended
3564 Type *Ty, ///< The type to sign extend to
3565 const Twine &NameStr, ///< A name for the new instruction
3566 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3569 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3570 static inline bool classof(const Instruction *I) {
3571 return I->getOpcode() == SExt;
3573 static inline bool classof(const Value *V) {
3574 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3578 //===----------------------------------------------------------------------===//
3579 // FPTruncInst Class
3580 //===----------------------------------------------------------------------===//
3582 /// \brief This class represents a truncation of floating point types.
3583 class FPTruncInst : public CastInst {
3585 /// \brief Clone an identical FPTruncInst
3586 FPTruncInst *clone_impl() const override;
3589 /// \brief Constructor with insert-before-instruction semantics
3591 Value *S, ///< The value to be truncated
3592 Type *Ty, ///< The type to truncate to
3593 const Twine &NameStr = "", ///< A name for the new instruction
3594 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3597 /// \brief Constructor with insert-before-instruction semantics
3599 Value *S, ///< The value to be truncated
3600 Type *Ty, ///< The type to truncate to
3601 const Twine &NameStr, ///< A name for the new instruction
3602 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3605 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3606 static inline bool classof(const Instruction *I) {
3607 return I->getOpcode() == FPTrunc;
3609 static inline bool classof(const Value *V) {
3610 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3614 //===----------------------------------------------------------------------===//
3616 //===----------------------------------------------------------------------===//
3618 /// \brief This class represents an extension of floating point types.
3619 class FPExtInst : public CastInst {
3621 /// \brief Clone an identical FPExtInst
3622 FPExtInst *clone_impl() const override;
3625 /// \brief Constructor with insert-before-instruction semantics
3627 Value *S, ///< The value to be extended
3628 Type *Ty, ///< The type to extend to
3629 const Twine &NameStr = "", ///< A name for the new instruction
3630 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3633 /// \brief Constructor with insert-at-end-of-block semantics
3635 Value *S, ///< The value to be extended
3636 Type *Ty, ///< The type to extend to
3637 const Twine &NameStr, ///< A name for the new instruction
3638 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3641 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3642 static inline bool classof(const Instruction *I) {
3643 return I->getOpcode() == FPExt;
3645 static inline bool classof(const Value *V) {
3646 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3650 //===----------------------------------------------------------------------===//
3652 //===----------------------------------------------------------------------===//
3654 /// \brief This class represents a cast unsigned integer to floating point.
3655 class UIToFPInst : public CastInst {
3657 /// \brief Clone an identical UIToFPInst
3658 UIToFPInst *clone_impl() const override;
3661 /// \brief Constructor with insert-before-instruction semantics
3663 Value *S, ///< The value to be converted
3664 Type *Ty, ///< The type to convert to
3665 const Twine &NameStr = "", ///< A name for the new instruction
3666 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3669 /// \brief Constructor with insert-at-end-of-block semantics
3671 Value *S, ///< The value to be converted
3672 Type *Ty, ///< The type to convert to
3673 const Twine &NameStr, ///< A name for the new instruction
3674 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3677 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3678 static inline bool classof(const Instruction *I) {
3679 return I->getOpcode() == UIToFP;
3681 static inline bool classof(const Value *V) {
3682 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3686 //===----------------------------------------------------------------------===//
3688 //===----------------------------------------------------------------------===//
3690 /// \brief This class represents a cast from signed integer to floating point.
3691 class SIToFPInst : public CastInst {
3693 /// \brief Clone an identical SIToFPInst
3694 SIToFPInst *clone_impl() const override;
3697 /// \brief Constructor with insert-before-instruction semantics
3699 Value *S, ///< The value to be converted
3700 Type *Ty, ///< The type to convert to
3701 const Twine &NameStr = "", ///< A name for the new instruction
3702 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3705 /// \brief Constructor with insert-at-end-of-block semantics
3707 Value *S, ///< The value to be converted
3708 Type *Ty, ///< The type to convert to
3709 const Twine &NameStr, ///< A name for the new instruction
3710 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3713 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3714 static inline bool classof(const Instruction *I) {
3715 return I->getOpcode() == SIToFP;
3717 static inline bool classof(const Value *V) {
3718 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3722 //===----------------------------------------------------------------------===//
3724 //===----------------------------------------------------------------------===//
3726 /// \brief This class represents a cast from floating point to unsigned integer
3727 class FPToUIInst : public CastInst {
3729 /// \brief Clone an identical FPToUIInst
3730 FPToUIInst *clone_impl() const override;
3733 /// \brief Constructor with insert-before-instruction semantics
3735 Value *S, ///< The value to be converted
3736 Type *Ty, ///< The type to convert to
3737 const Twine &NameStr = "", ///< A name for the new instruction
3738 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3741 /// \brief Constructor with insert-at-end-of-block semantics
3743 Value *S, ///< The value to be converted
3744 Type *Ty, ///< The type to convert to
3745 const Twine &NameStr, ///< A name for the new instruction
3746 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
3749 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3750 static inline bool classof(const Instruction *I) {
3751 return I->getOpcode() == FPToUI;
3753 static inline bool classof(const Value *V) {
3754 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3758 //===----------------------------------------------------------------------===//
3760 //===----------------------------------------------------------------------===//
3762 /// \brief This class represents a cast from floating point to signed integer.
3763 class FPToSIInst : public CastInst {
3765 /// \brief Clone an identical FPToSIInst
3766 FPToSIInst *clone_impl() const override;
3769 /// \brief Constructor with insert-before-instruction semantics
3771 Value *S, ///< The value to be converted
3772 Type *Ty, ///< The type to convert to
3773 const Twine &NameStr = "", ///< A name for the new instruction
3774 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3777 /// \brief Constructor with insert-at-end-of-block semantics
3779 Value *S, ///< The value to be converted
3780 Type *Ty, ///< The type to convert to
3781 const Twine &NameStr, ///< A name for the new instruction
3782 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3785 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3786 static inline bool classof(const Instruction *I) {
3787 return I->getOpcode() == FPToSI;
3789 static inline bool classof(const Value *V) {
3790 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3794 //===----------------------------------------------------------------------===//
3795 // IntToPtrInst Class
3796 //===----------------------------------------------------------------------===//
3798 /// \brief This class represents a cast from an integer to a pointer.
3799 class IntToPtrInst : public CastInst {
3801 /// \brief Constructor with insert-before-instruction semantics
3803 Value *S, ///< The value to be converted
3804 Type *Ty, ///< The type to convert to
3805 const Twine &NameStr = "", ///< A name for the new instruction
3806 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3809 /// \brief Constructor with insert-at-end-of-block semantics
3811 Value *S, ///< The value to be converted
3812 Type *Ty, ///< The type to convert to
3813 const Twine &NameStr, ///< A name for the new instruction
3814 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3817 /// \brief Clone an identical IntToPtrInst
3818 IntToPtrInst *clone_impl() const override;
3820 /// \brief Returns the address space of this instruction's pointer type.
3821 unsigned getAddressSpace() const {
3822 return getType()->getPointerAddressSpace();
3825 // Methods for support type inquiry through isa, cast, and dyn_cast:
3826 static inline bool classof(const Instruction *I) {
3827 return I->getOpcode() == IntToPtr;
3829 static inline bool classof(const Value *V) {
3830 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3834 //===----------------------------------------------------------------------===//
3835 // PtrToIntInst Class
3836 //===----------------------------------------------------------------------===//
3838 /// \brief This class represents a cast from a pointer to an integer
3839 class PtrToIntInst : public CastInst {
3841 /// \brief Clone an identical PtrToIntInst
3842 PtrToIntInst *clone_impl() const override;
3845 /// \brief Constructor with insert-before-instruction semantics
3847 Value *S, ///< The value to be converted
3848 Type *Ty, ///< The type to convert to
3849 const Twine &NameStr = "", ///< A name for the new instruction
3850 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3853 /// \brief Constructor with insert-at-end-of-block semantics
3855 Value *S, ///< The value to be converted
3856 Type *Ty, ///< The type to convert to
3857 const Twine &NameStr, ///< A name for the new instruction
3858 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3861 /// \brief Gets the pointer operand.
3862 Value *getPointerOperand() { return getOperand(0); }
3863 /// \brief Gets the pointer operand.
3864 const Value *getPointerOperand() const { return getOperand(0); }
3865 /// \brief Gets the operand index of the pointer operand.
3866 static unsigned getPointerOperandIndex() { return 0U; }
3868 /// \brief Returns the address space of the pointer operand.
3869 unsigned getPointerAddressSpace() const {
3870 return getPointerOperand()->getType()->getPointerAddressSpace();
3873 // Methods for support type inquiry through isa, cast, and dyn_cast:
3874 static inline bool classof(const Instruction *I) {
3875 return I->getOpcode() == PtrToInt;
3877 static inline bool classof(const Value *V) {
3878 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3882 //===----------------------------------------------------------------------===//
3883 // BitCastInst Class
3884 //===----------------------------------------------------------------------===//
3886 /// \brief This class represents a no-op cast from one type to another.
3887 class BitCastInst : public CastInst {
3889 /// \brief Clone an identical BitCastInst
3890 BitCastInst *clone_impl() const override;
3893 /// \brief Constructor with insert-before-instruction semantics
3895 Value *S, ///< The value to be casted
3896 Type *Ty, ///< The type to casted to
3897 const Twine &NameStr = "", ///< A name for the new instruction
3898 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3901 /// \brief Constructor with insert-at-end-of-block semantics
3903 Value *S, ///< The value to be casted
3904 Type *Ty, ///< The type to casted to
3905 const Twine &NameStr, ///< A name for the new instruction
3906 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3909 // Methods for support type inquiry through isa, cast, and dyn_cast:
3910 static inline bool classof(const Instruction *I) {
3911 return I->getOpcode() == BitCast;
3913 static inline bool classof(const Value *V) {
3914 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3918 //===----------------------------------------------------------------------===//
3919 // AddrSpaceCastInst Class
3920 //===----------------------------------------------------------------------===//
3922 /// \brief This class represents a conversion between pointers from
3923 /// one address space to another.
3924 class AddrSpaceCastInst : public CastInst {
3926 /// \brief Clone an identical AddrSpaceCastInst
3927 AddrSpaceCastInst *clone_impl() const override;
3930 /// \brief Constructor with insert-before-instruction semantics
3932 Value *S, ///< The value to be casted
3933 Type *Ty, ///< The type to casted to
3934 const Twine &NameStr = "", ///< A name for the new instruction
3935 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3938 /// \brief Constructor with insert-at-end-of-block semantics
3940 Value *S, ///< The value to be casted
3941 Type *Ty, ///< The type to casted to
3942 const Twine &NameStr, ///< A name for the new instruction
3943 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3946 // Methods for support type inquiry through isa, cast, and dyn_cast:
3947 static inline bool classof(const Instruction *I) {
3948 return I->getOpcode() == AddrSpaceCast;
3950 static inline bool classof(const Value *V) {
3951 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3955 } // End llvm namespace