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(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile = false,
181 Instruction *InsertBefore = nullptr);
182 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
183 Instruction *InsertBefore = nullptr)
184 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
185 NameStr, isVolatile, InsertBefore) {}
186 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
187 BasicBlock *InsertAtEnd);
188 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile, unsigned Align,
189 Instruction *InsertBefore = nullptr)
190 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
191 NameStr, isVolatile, Align, InsertBefore) {}
192 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
193 unsigned Align, Instruction *InsertBefore = nullptr);
194 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
195 unsigned Align, BasicBlock *InsertAtEnd);
196 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile, unsigned Align,
197 AtomicOrdering Order, SynchronizationScope SynchScope = CrossThread,
198 Instruction *InsertBefore = nullptr)
199 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
200 NameStr, isVolatile, Align, Order, SynchScope, InsertBefore) {}
201 LoadInst(Type *Ty, Value *Ptr, const Twine &NameStr, bool isVolatile,
202 unsigned Align, AtomicOrdering Order,
203 SynchronizationScope SynchScope = CrossThread,
204 Instruction *InsertBefore = nullptr);
205 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
206 unsigned Align, AtomicOrdering Order,
207 SynchronizationScope SynchScope,
208 BasicBlock *InsertAtEnd);
210 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
211 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
212 LoadInst(Type *Ty, Value *Ptr, const char *NameStr = nullptr,
213 bool isVolatile = false, Instruction *InsertBefore = nullptr);
214 explicit LoadInst(Value *Ptr, const char *NameStr = nullptr,
215 bool isVolatile = false,
216 Instruction *InsertBefore = nullptr)
217 : LoadInst(cast<PointerType>(Ptr->getType())->getElementType(), Ptr,
218 NameStr, isVolatile, InsertBefore) {}
219 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
220 BasicBlock *InsertAtEnd);
222 /// isVolatile - Return true if this is a load from a volatile memory
225 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
227 /// setVolatile - Specify whether this is a volatile load or not.
229 void setVolatile(bool V) {
230 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
234 /// getAlignment - Return the alignment of the access that is being performed
236 unsigned getAlignment() const {
237 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
240 void setAlignment(unsigned Align);
242 /// Returns the ordering effect of this fence.
243 AtomicOrdering getOrdering() const {
244 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
247 /// Set the ordering constraint on this load. May not be Release or
249 void setOrdering(AtomicOrdering Ordering) {
250 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
254 SynchronizationScope getSynchScope() const {
255 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
258 /// Specify whether this load is ordered with respect to all
259 /// concurrently executing threads, or only with respect to signal handlers
260 /// executing in the same thread.
261 void setSynchScope(SynchronizationScope xthread) {
262 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
266 void setAtomic(AtomicOrdering Ordering,
267 SynchronizationScope SynchScope = CrossThread) {
268 setOrdering(Ordering);
269 setSynchScope(SynchScope);
272 bool isSimple() const { return !isAtomic() && !isVolatile(); }
273 bool isUnordered() const {
274 return getOrdering() <= Unordered && !isVolatile();
277 Value *getPointerOperand() { return getOperand(0); }
278 const Value *getPointerOperand() const { return getOperand(0); }
279 static unsigned getPointerOperandIndex() { return 0U; }
281 /// \brief Returns the address space of the pointer operand.
282 unsigned getPointerAddressSpace() const {
283 return getPointerOperand()->getType()->getPointerAddressSpace();
287 // Methods for support type inquiry through isa, cast, and dyn_cast:
288 static inline bool classof(const Instruction *I) {
289 return I->getOpcode() == Instruction::Load;
291 static inline bool classof(const Value *V) {
292 return isa<Instruction>(V) && classof(cast<Instruction>(V));
295 // Shadow Instruction::setInstructionSubclassData with a private forwarding
296 // method so that subclasses cannot accidentally use it.
297 void setInstructionSubclassData(unsigned short D) {
298 Instruction::setInstructionSubclassData(D);
303 //===----------------------------------------------------------------------===//
305 //===----------------------------------------------------------------------===//
307 /// StoreInst - an instruction for storing to memory
309 class StoreInst : public Instruction {
310 void *operator new(size_t, unsigned) = delete;
313 StoreInst *clone_impl() const override;
315 // allocate space for exactly two operands
316 void *operator new(size_t s) {
317 return User::operator new(s, 2);
319 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
320 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
321 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
322 Instruction *InsertBefore = nullptr);
323 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
324 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
325 unsigned Align, Instruction *InsertBefore = nullptr);
326 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
327 unsigned Align, BasicBlock *InsertAtEnd);
328 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
329 unsigned Align, AtomicOrdering Order,
330 SynchronizationScope SynchScope = CrossThread,
331 Instruction *InsertBefore = nullptr);
332 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
333 unsigned Align, AtomicOrdering Order,
334 SynchronizationScope SynchScope,
335 BasicBlock *InsertAtEnd);
338 /// isVolatile - Return true if this is a store to a volatile memory
341 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
343 /// setVolatile - Specify whether this is a volatile store or not.
345 void setVolatile(bool V) {
346 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
350 /// Transparently provide more efficient getOperand methods.
351 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
353 /// getAlignment - Return the alignment of the access that is being performed
355 unsigned getAlignment() const {
356 return (1 << ((getSubclassDataFromInstruction() >> 1) & 31)) >> 1;
359 void setAlignment(unsigned Align);
361 /// Returns the ordering effect of this store.
362 AtomicOrdering getOrdering() const {
363 return AtomicOrdering((getSubclassDataFromInstruction() >> 7) & 7);
366 /// Set the ordering constraint on this store. May not be Acquire or
368 void setOrdering(AtomicOrdering Ordering) {
369 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 7)) |
373 SynchronizationScope getSynchScope() const {
374 return SynchronizationScope((getSubclassDataFromInstruction() >> 6) & 1);
377 /// Specify whether this store instruction is ordered with respect to all
378 /// concurrently executing threads, or only with respect to signal handlers
379 /// executing in the same thread.
380 void setSynchScope(SynchronizationScope xthread) {
381 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(1 << 6)) |
385 void setAtomic(AtomicOrdering Ordering,
386 SynchronizationScope SynchScope = CrossThread) {
387 setOrdering(Ordering);
388 setSynchScope(SynchScope);
391 bool isSimple() const { return !isAtomic() && !isVolatile(); }
392 bool isUnordered() const {
393 return getOrdering() <= Unordered && !isVolatile();
396 Value *getValueOperand() { return getOperand(0); }
397 const Value *getValueOperand() const { return getOperand(0); }
399 Value *getPointerOperand() { return getOperand(1); }
400 const Value *getPointerOperand() const { return getOperand(1); }
401 static unsigned getPointerOperandIndex() { return 1U; }
403 /// \brief Returns the address space of the pointer operand.
404 unsigned getPointerAddressSpace() const {
405 return getPointerOperand()->getType()->getPointerAddressSpace();
408 // Methods for support type inquiry through isa, cast, and dyn_cast:
409 static inline bool classof(const Instruction *I) {
410 return I->getOpcode() == Instruction::Store;
412 static inline bool classof(const Value *V) {
413 return isa<Instruction>(V) && classof(cast<Instruction>(V));
416 // Shadow Instruction::setInstructionSubclassData with a private forwarding
417 // method so that subclasses cannot accidentally use it.
418 void setInstructionSubclassData(unsigned short D) {
419 Instruction::setInstructionSubclassData(D);
424 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
427 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
429 //===----------------------------------------------------------------------===//
431 //===----------------------------------------------------------------------===//
433 /// FenceInst - an instruction for ordering other memory operations
435 class FenceInst : public Instruction {
436 void *operator new(size_t, unsigned) = delete;
437 void Init(AtomicOrdering Ordering, SynchronizationScope SynchScope);
439 FenceInst *clone_impl() const override;
441 // allocate space for exactly zero operands
442 void *operator new(size_t s) {
443 return User::operator new(s, 0);
446 // Ordering may only be Acquire, Release, AcquireRelease, or
447 // SequentiallyConsistent.
448 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
449 SynchronizationScope SynchScope = CrossThread,
450 Instruction *InsertBefore = nullptr);
451 FenceInst(LLVMContext &C, AtomicOrdering Ordering,
452 SynchronizationScope SynchScope,
453 BasicBlock *InsertAtEnd);
455 /// Returns the ordering effect of this fence.
456 AtomicOrdering getOrdering() const {
457 return AtomicOrdering(getSubclassDataFromInstruction() >> 1);
460 /// Set the ordering constraint on this fence. May only be Acquire, Release,
461 /// AcquireRelease, or SequentiallyConsistent.
462 void setOrdering(AtomicOrdering Ordering) {
463 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
467 SynchronizationScope getSynchScope() const {
468 return SynchronizationScope(getSubclassDataFromInstruction() & 1);
471 /// Specify whether this fence orders other operations with respect to all
472 /// concurrently executing threads, or only with respect to signal handlers
473 /// executing in the same thread.
474 void setSynchScope(SynchronizationScope xthread) {
475 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
479 // Methods for support type inquiry through isa, cast, and dyn_cast:
480 static inline bool classof(const Instruction *I) {
481 return I->getOpcode() == Instruction::Fence;
483 static inline bool classof(const Value *V) {
484 return isa<Instruction>(V) && classof(cast<Instruction>(V));
487 // Shadow Instruction::setInstructionSubclassData with a private forwarding
488 // method so that subclasses cannot accidentally use it.
489 void setInstructionSubclassData(unsigned short D) {
490 Instruction::setInstructionSubclassData(D);
494 //===----------------------------------------------------------------------===//
495 // AtomicCmpXchgInst Class
496 //===----------------------------------------------------------------------===//
498 /// AtomicCmpXchgInst - an instruction that atomically checks whether a
499 /// specified value is in a memory location, and, if it is, stores a new value
500 /// there. Returns the value that was loaded.
502 class AtomicCmpXchgInst : public Instruction {
503 void *operator new(size_t, unsigned) = delete;
504 void Init(Value *Ptr, Value *Cmp, Value *NewVal,
505 AtomicOrdering SuccessOrdering, AtomicOrdering FailureOrdering,
506 SynchronizationScope SynchScope);
508 AtomicCmpXchgInst *clone_impl() const override;
510 // allocate space for exactly three operands
511 void *operator new(size_t s) {
512 return User::operator new(s, 3);
514 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
515 AtomicOrdering SuccessOrdering,
516 AtomicOrdering FailureOrdering,
517 SynchronizationScope SynchScope,
518 Instruction *InsertBefore = nullptr);
519 AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
520 AtomicOrdering SuccessOrdering,
521 AtomicOrdering FailureOrdering,
522 SynchronizationScope SynchScope,
523 BasicBlock *InsertAtEnd);
525 /// isVolatile - Return true if this is a cmpxchg from a volatile memory
528 bool isVolatile() const {
529 return getSubclassDataFromInstruction() & 1;
532 /// setVolatile - Specify whether this is a volatile cmpxchg.
534 void setVolatile(bool V) {
535 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
539 /// Return true if this cmpxchg may spuriously fail.
540 bool isWeak() const {
541 return getSubclassDataFromInstruction() & 0x100;
544 void setWeak(bool IsWeak) {
545 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x100) |
549 /// Transparently provide more efficient getOperand methods.
550 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
552 /// Set the ordering constraint on this cmpxchg.
553 void setSuccessOrdering(AtomicOrdering Ordering) {
554 assert(Ordering != NotAtomic &&
555 "CmpXchg instructions can only be atomic.");
556 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0x1c) |
560 void setFailureOrdering(AtomicOrdering Ordering) {
561 assert(Ordering != NotAtomic &&
562 "CmpXchg instructions can only be atomic.");
563 setInstructionSubclassData((getSubclassDataFromInstruction() & ~0xe0) |
567 /// Specify whether this cmpxchg is atomic and orders other operations with
568 /// respect to all concurrently executing threads, or only with respect to
569 /// signal handlers executing in the same thread.
570 void setSynchScope(SynchronizationScope SynchScope) {
571 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
575 /// Returns the ordering constraint on this cmpxchg.
576 AtomicOrdering getSuccessOrdering() const {
577 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
580 /// Returns the ordering constraint on this cmpxchg.
581 AtomicOrdering getFailureOrdering() const {
582 return AtomicOrdering((getSubclassDataFromInstruction() >> 5) & 7);
585 /// Returns whether this cmpxchg is atomic between threads or only within a
587 SynchronizationScope getSynchScope() const {
588 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
591 Value *getPointerOperand() { return getOperand(0); }
592 const Value *getPointerOperand() const { return getOperand(0); }
593 static unsigned getPointerOperandIndex() { return 0U; }
595 Value *getCompareOperand() { return getOperand(1); }
596 const Value *getCompareOperand() const { return getOperand(1); }
598 Value *getNewValOperand() { return getOperand(2); }
599 const Value *getNewValOperand() const { return getOperand(2); }
601 /// \brief Returns the address space of the pointer operand.
602 unsigned getPointerAddressSpace() const {
603 return getPointerOperand()->getType()->getPointerAddressSpace();
606 /// \brief Returns the strongest permitted ordering on failure, given the
607 /// desired ordering on success.
609 /// If the comparison in a cmpxchg operation fails, there is no atomic store
610 /// so release semantics cannot be provided. So this function drops explicit
611 /// Release requests from the AtomicOrdering. A SequentiallyConsistent
612 /// operation would remain SequentiallyConsistent.
613 static AtomicOrdering
614 getStrongestFailureOrdering(AtomicOrdering SuccessOrdering) {
615 switch (SuccessOrdering) {
616 default: llvm_unreachable("invalid cmpxchg success ordering");
623 case SequentiallyConsistent:
624 return SequentiallyConsistent;
628 // Methods for support type inquiry through isa, cast, and dyn_cast:
629 static inline bool classof(const Instruction *I) {
630 return I->getOpcode() == Instruction::AtomicCmpXchg;
632 static inline bool classof(const Value *V) {
633 return isa<Instruction>(V) && classof(cast<Instruction>(V));
636 // Shadow Instruction::setInstructionSubclassData with a private forwarding
637 // method so that subclasses cannot accidentally use it.
638 void setInstructionSubclassData(unsigned short D) {
639 Instruction::setInstructionSubclassData(D);
644 struct OperandTraits<AtomicCmpXchgInst> :
645 public FixedNumOperandTraits<AtomicCmpXchgInst, 3> {
648 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicCmpXchgInst, Value)
650 //===----------------------------------------------------------------------===//
651 // AtomicRMWInst Class
652 //===----------------------------------------------------------------------===//
654 /// AtomicRMWInst - an instruction that atomically reads a memory location,
655 /// combines it with another value, and then stores the result back. Returns
658 class AtomicRMWInst : public Instruction {
659 void *operator new(size_t, unsigned) = delete;
661 AtomicRMWInst *clone_impl() const override;
663 /// This enumeration lists the possible modifications atomicrmw can make. In
664 /// the descriptions, 'p' is the pointer to the instruction's memory location,
665 /// 'old' is the initial value of *p, and 'v' is the other value passed to the
666 /// instruction. These instructions always return 'old'.
682 /// *p = old >signed v ? old : v
684 /// *p = old <signed v ? old : v
686 /// *p = old >unsigned v ? old : v
688 /// *p = old <unsigned v ? old : v
696 // allocate space for exactly two operands
697 void *operator new(size_t s) {
698 return User::operator new(s, 2);
700 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
701 AtomicOrdering Ordering, SynchronizationScope SynchScope,
702 Instruction *InsertBefore = nullptr);
703 AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
704 AtomicOrdering Ordering, SynchronizationScope SynchScope,
705 BasicBlock *InsertAtEnd);
707 BinOp getOperation() const {
708 return static_cast<BinOp>(getSubclassDataFromInstruction() >> 5);
711 void setOperation(BinOp Operation) {
712 unsigned short SubclassData = getSubclassDataFromInstruction();
713 setInstructionSubclassData((SubclassData & 31) |
717 /// isVolatile - Return true if this is a RMW on a volatile memory location.
719 bool isVolatile() const {
720 return getSubclassDataFromInstruction() & 1;
723 /// setVolatile - Specify whether this is a volatile RMW or not.
725 void setVolatile(bool V) {
726 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
730 /// Transparently provide more efficient getOperand methods.
731 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
733 /// Set the ordering constraint on this RMW.
734 void setOrdering(AtomicOrdering Ordering) {
735 assert(Ordering != NotAtomic &&
736 "atomicrmw instructions can only be atomic.");
737 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(7 << 2)) |
741 /// Specify whether this RMW orders other operations with respect to all
742 /// concurrently executing threads, or only with respect to signal handlers
743 /// executing in the same thread.
744 void setSynchScope(SynchronizationScope SynchScope) {
745 setInstructionSubclassData((getSubclassDataFromInstruction() & ~2) |
749 /// Returns the ordering constraint on this RMW.
750 AtomicOrdering getOrdering() const {
751 return AtomicOrdering((getSubclassDataFromInstruction() >> 2) & 7);
754 /// Returns whether this RMW is atomic between threads or only within a
756 SynchronizationScope getSynchScope() const {
757 return SynchronizationScope((getSubclassDataFromInstruction() & 2) >> 1);
760 Value *getPointerOperand() { return getOperand(0); }
761 const Value *getPointerOperand() const { return getOperand(0); }
762 static unsigned getPointerOperandIndex() { return 0U; }
764 Value *getValOperand() { return getOperand(1); }
765 const Value *getValOperand() const { return getOperand(1); }
767 /// \brief Returns the address space of the pointer operand.
768 unsigned getPointerAddressSpace() const {
769 return getPointerOperand()->getType()->getPointerAddressSpace();
772 // Methods for support type inquiry through isa, cast, and dyn_cast:
773 static inline bool classof(const Instruction *I) {
774 return I->getOpcode() == Instruction::AtomicRMW;
776 static inline bool classof(const Value *V) {
777 return isa<Instruction>(V) && classof(cast<Instruction>(V));
780 void Init(BinOp Operation, Value *Ptr, Value *Val,
781 AtomicOrdering Ordering, SynchronizationScope SynchScope);
782 // Shadow Instruction::setInstructionSubclassData with a private forwarding
783 // method so that subclasses cannot accidentally use it.
784 void setInstructionSubclassData(unsigned short D) {
785 Instruction::setInstructionSubclassData(D);
790 struct OperandTraits<AtomicRMWInst>
791 : public FixedNumOperandTraits<AtomicRMWInst,2> {
794 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(AtomicRMWInst, Value)
796 //===----------------------------------------------------------------------===//
797 // GetElementPtrInst Class
798 //===----------------------------------------------------------------------===//
800 // checkGEPType - Simple wrapper function to give a better assertion failure
801 // message on bad indexes for a gep instruction.
803 inline Type *checkGEPType(Type *Ty) {
804 assert(Ty && "Invalid GetElementPtrInst indices for type!");
808 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
809 /// access elements of arrays and structs
811 class GetElementPtrInst : public Instruction {
812 Type *SourceElementType;
814 GetElementPtrInst(const GetElementPtrInst &GEPI);
815 void init(Value *Ptr, ArrayRef<Value *> IdxList, const Twine &NameStr);
817 /// Constructors - Create a getelementptr instruction with a base pointer an
818 /// list of indices. The first ctor can optionally insert before an existing
819 /// instruction, the second appends the new instruction to the specified
821 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
822 ArrayRef<Value *> IdxList, unsigned Values,
823 const Twine &NameStr, Instruction *InsertBefore);
824 inline GetElementPtrInst(Type *PointeeType, Value *Ptr,
825 ArrayRef<Value *> IdxList, unsigned Values,
826 const Twine &NameStr, BasicBlock *InsertAtEnd);
829 GetElementPtrInst *clone_impl() const override;
831 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
832 ArrayRef<Value *> IdxList,
833 const Twine &NameStr = "",
834 Instruction *InsertBefore = nullptr) {
835 unsigned Values = 1 + unsigned(IdxList.size());
838 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
842 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
843 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
844 NameStr, InsertBefore);
846 static GetElementPtrInst *Create(Type *PointeeType, Value *Ptr,
847 ArrayRef<Value *> IdxList,
848 const Twine &NameStr,
849 BasicBlock *InsertAtEnd) {
850 unsigned Values = 1 + unsigned(IdxList.size());
853 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType();
857 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType());
858 return new (Values) GetElementPtrInst(PointeeType, Ptr, IdxList, Values,
859 NameStr, InsertAtEnd);
862 /// Create an "inbounds" getelementptr. See the documentation for the
863 /// "inbounds" flag in LangRef.html for details.
864 static GetElementPtrInst *CreateInBounds(Value *Ptr,
865 ArrayRef<Value *> IdxList,
866 const Twine &NameStr = "",
867 Instruction *InsertBefore = nullptr){
868 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertBefore);
870 static GetElementPtrInst *
871 CreateInBounds(Type *PointeeType, Value *Ptr, ArrayRef<Value *> IdxList,
872 const Twine &NameStr = "",
873 Instruction *InsertBefore = nullptr) {
874 GetElementPtrInst *GEP =
875 Create(PointeeType, Ptr, IdxList, NameStr, InsertBefore);
876 GEP->setIsInBounds(true);
879 static GetElementPtrInst *CreateInBounds(Value *Ptr,
880 ArrayRef<Value *> IdxList,
881 const Twine &NameStr,
882 BasicBlock *InsertAtEnd) {
883 return CreateInBounds(nullptr, Ptr, IdxList, NameStr, InsertAtEnd);
885 static GetElementPtrInst *CreateInBounds(Type *PointeeType, Value *Ptr,
886 ArrayRef<Value *> IdxList,
887 const Twine &NameStr,
888 BasicBlock *InsertAtEnd) {
889 GetElementPtrInst *GEP =
890 Create(PointeeType, Ptr, IdxList, NameStr, InsertAtEnd);
891 GEP->setIsInBounds(true);
895 /// Transparently provide more efficient getOperand methods.
896 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
898 // getType - Overload to return most specific sequential type.
899 SequentialType *getType() const {
900 return cast<SequentialType>(Instruction::getType());
903 Type *getSourceElementType() const { return SourceElementType; }
905 void setSourceElementType(Type *Ty) { SourceElementType = Ty; }
907 Type *getResultElementType() const {
908 return cast<PointerType>(getType()->getScalarType())->getElementType();
911 /// \brief Returns the address space of this instruction's pointer type.
912 unsigned getAddressSpace() const {
913 // Note that this is always the same as the pointer operand's address space
914 // and that is cheaper to compute, so cheat here.
915 return getPointerAddressSpace();
918 /// getIndexedType - Returns the type of the element that would be loaded with
919 /// a load instruction with the specified parameters.
921 /// Null is returned if the indices are invalid for the specified
924 static Type *getIndexedType(Type *Ty, ArrayRef<Value *> IdxList);
925 static Type *getIndexedType(Type *Ty, ArrayRef<Constant *> IdxList);
926 static Type *getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList);
928 inline op_iterator idx_begin() { return op_begin()+1; }
929 inline const_op_iterator idx_begin() const { return op_begin()+1; }
930 inline op_iterator idx_end() { return op_end(); }
931 inline const_op_iterator idx_end() const { return op_end(); }
933 Value *getPointerOperand() {
934 return getOperand(0);
936 const Value *getPointerOperand() const {
937 return getOperand(0);
939 static unsigned getPointerOperandIndex() {
940 return 0U; // get index for modifying correct operand.
943 /// getPointerOperandType - Method to return the pointer operand as a
945 Type *getPointerOperandType() const {
946 return getPointerOperand()->getType();
949 /// \brief Returns the address space of the pointer operand.
950 unsigned getPointerAddressSpace() const {
951 return getPointerOperandType()->getPointerAddressSpace();
954 /// GetGEPReturnType - Returns the pointer type returned by the GEP
955 /// instruction, which may be a vector of pointers.
956 static Type *getGEPReturnType(Value *Ptr, ArrayRef<Value *> IdxList) {
957 return getGEPReturnType(
958 cast<PointerType>(Ptr->getType()->getScalarType())->getElementType(),
961 static Type *getGEPReturnType(Type *ElTy, Value *Ptr,
962 ArrayRef<Value *> IdxList) {
963 Type *PtrTy = PointerType::get(checkGEPType(getIndexedType(ElTy, IdxList)),
964 Ptr->getType()->getPointerAddressSpace());
966 if (Ptr->getType()->isVectorTy()) {
967 unsigned NumElem = cast<VectorType>(Ptr->getType())->getNumElements();
968 return VectorType::get(PtrTy, NumElem);
975 unsigned getNumIndices() const { // Note: always non-negative
976 return getNumOperands() - 1;
979 bool hasIndices() const {
980 return getNumOperands() > 1;
983 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
984 /// zeros. If so, the result pointer and the first operand have the same
985 /// value, just potentially different types.
986 bool hasAllZeroIndices() const;
988 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
989 /// constant integers. If so, the result pointer and the first operand have
990 /// a constant offset between them.
991 bool hasAllConstantIndices() const;
993 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
994 /// See LangRef.html for the meaning of inbounds on a getelementptr.
995 void setIsInBounds(bool b = true);
997 /// isInBounds - Determine whether the GEP has the inbounds flag.
998 bool isInBounds() const;
1000 /// \brief Accumulate the constant address offset of this GEP if possible.
1002 /// This routine accepts an APInt into which it will accumulate the constant
1003 /// offset of this GEP if the GEP is in fact constant. If the GEP is not
1004 /// all-constant, it returns false and the value of the offset APInt is
1005 /// undefined (it is *not* preserved!). The APInt passed into this routine
1006 /// must be at least as wide as the IntPtr type for the address space of
1007 /// the base GEP pointer.
1008 bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const;
1010 // Methods for support type inquiry through isa, cast, and dyn_cast:
1011 static inline bool classof(const Instruction *I) {
1012 return (I->getOpcode() == Instruction::GetElementPtr);
1014 static inline bool classof(const Value *V) {
1015 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1020 struct OperandTraits<GetElementPtrInst> :
1021 public VariadicOperandTraits<GetElementPtrInst, 1> {
1024 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1025 ArrayRef<Value *> IdxList, unsigned Values,
1026 const Twine &NameStr,
1027 Instruction *InsertBefore)
1028 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1029 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1030 Values, InsertBefore),
1031 SourceElementType(PointeeType) {
1032 init(Ptr, IdxList, NameStr);
1034 GetElementPtrInst::GetElementPtrInst(Type *PointeeType, Value *Ptr,
1035 ArrayRef<Value *> IdxList, unsigned Values,
1036 const Twine &NameStr,
1037 BasicBlock *InsertAtEnd)
1038 : Instruction(getGEPReturnType(PointeeType, Ptr, IdxList), GetElementPtr,
1039 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
1040 Values, InsertAtEnd),
1041 SourceElementType(PointeeType) {
1042 init(Ptr, IdxList, NameStr);
1046 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
1049 //===----------------------------------------------------------------------===//
1051 //===----------------------------------------------------------------------===//
1053 /// This instruction compares its operands according to the predicate given
1054 /// to the constructor. It only operates on integers or pointers. The operands
1055 /// must be identical types.
1056 /// \brief Represent an integer comparison operator.
1057 class ICmpInst: public CmpInst {
1059 assert(getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
1060 getPredicate() <= CmpInst::LAST_ICMP_PREDICATE &&
1061 "Invalid ICmp predicate value");
1062 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1063 "Both operands to ICmp instruction are not of the same type!");
1064 // Check that the operands are the right type
1065 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
1066 getOperand(0)->getType()->isPtrOrPtrVectorTy()) &&
1067 "Invalid operand types for ICmp instruction");
1071 /// \brief Clone an identical ICmpInst
1072 ICmpInst *clone_impl() const override;
1074 /// \brief Constructor with insert-before-instruction semantics.
1076 Instruction *InsertBefore, ///< Where to insert
1077 Predicate pred, ///< The predicate to use for the comparison
1078 Value *LHS, ///< The left-hand-side of the expression
1079 Value *RHS, ///< The right-hand-side of the expression
1080 const Twine &NameStr = "" ///< Name of the instruction
1081 ) : CmpInst(makeCmpResultType(LHS->getType()),
1082 Instruction::ICmp, pred, LHS, RHS, NameStr,
1089 /// \brief Constructor with insert-at-end semantics.
1091 BasicBlock &InsertAtEnd, ///< Block to insert into.
1092 Predicate pred, ///< The predicate to use for the comparison
1093 Value *LHS, ///< The left-hand-side of the expression
1094 Value *RHS, ///< The right-hand-side of the expression
1095 const Twine &NameStr = "" ///< Name of the instruction
1096 ) : CmpInst(makeCmpResultType(LHS->getType()),
1097 Instruction::ICmp, pred, LHS, RHS, NameStr,
1104 /// \brief Constructor with no-insertion semantics
1106 Predicate pred, ///< The predicate to use for the comparison
1107 Value *LHS, ///< The left-hand-side of the expression
1108 Value *RHS, ///< The right-hand-side of the expression
1109 const Twine &NameStr = "" ///< Name of the instruction
1110 ) : CmpInst(makeCmpResultType(LHS->getType()),
1111 Instruction::ICmp, pred, LHS, RHS, NameStr) {
1117 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
1118 /// @returns the predicate that would be the result if the operand were
1119 /// regarded as signed.
1120 /// \brief Return the signed version of the predicate
1121 Predicate getSignedPredicate() const {
1122 return getSignedPredicate(getPredicate());
1125 /// This is a static version that you can use without an instruction.
1126 /// \brief Return the signed version of the predicate.
1127 static Predicate getSignedPredicate(Predicate pred);
1129 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
1130 /// @returns the predicate that would be the result if the operand were
1131 /// regarded as unsigned.
1132 /// \brief Return the unsigned version of the predicate
1133 Predicate getUnsignedPredicate() const {
1134 return getUnsignedPredicate(getPredicate());
1137 /// This is a static version that you can use without an instruction.
1138 /// \brief Return the unsigned version of the predicate.
1139 static Predicate getUnsignedPredicate(Predicate pred);
1141 /// isEquality - Return true if this predicate is either EQ or NE. This also
1142 /// tests for commutativity.
1143 static bool isEquality(Predicate P) {
1144 return P == ICMP_EQ || P == ICMP_NE;
1147 /// isEquality - Return true if this predicate is either EQ or NE. This also
1148 /// tests for commutativity.
1149 bool isEquality() const {
1150 return isEquality(getPredicate());
1153 /// @returns true if the predicate of this ICmpInst is commutative
1154 /// \brief Determine if this relation is commutative.
1155 bool isCommutative() const { return isEquality(); }
1157 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1159 bool isRelational() const {
1160 return !isEquality();
1163 /// isRelational - Return true if the predicate is relational (not EQ or NE).
1165 static bool isRelational(Predicate P) {
1166 return !isEquality(P);
1169 /// Initialize a set of values that all satisfy the predicate with C.
1170 /// \brief Make a ConstantRange for a relation with a constant value.
1171 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
1173 /// Exchange the two operands to this instruction in such a way that it does
1174 /// not modify the semantics of the instruction. The predicate value may be
1175 /// changed to retain the same result if the predicate is order dependent
1177 /// \brief Swap operands and adjust predicate.
1178 void swapOperands() {
1179 setPredicate(getSwappedPredicate());
1180 Op<0>().swap(Op<1>());
1183 // Methods for support type inquiry through isa, cast, and dyn_cast:
1184 static inline bool classof(const Instruction *I) {
1185 return I->getOpcode() == Instruction::ICmp;
1187 static inline bool classof(const Value *V) {
1188 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1193 //===----------------------------------------------------------------------===//
1195 //===----------------------------------------------------------------------===//
1197 /// This instruction compares its operands according to the predicate given
1198 /// to the constructor. It only operates on floating point values or packed
1199 /// vectors of floating point values. The operands must be identical types.
1200 /// \brief Represents a floating point comparison operator.
1201 class FCmpInst: public CmpInst {
1203 /// \brief Clone an identical FCmpInst
1204 FCmpInst *clone_impl() const override;
1206 /// \brief Constructor with insert-before-instruction semantics.
1208 Instruction *InsertBefore, ///< Where to insert
1209 Predicate pred, ///< The predicate to use for the comparison
1210 Value *LHS, ///< The left-hand-side of the expression
1211 Value *RHS, ///< The right-hand-side of the expression
1212 const Twine &NameStr = "" ///< Name of the instruction
1213 ) : CmpInst(makeCmpResultType(LHS->getType()),
1214 Instruction::FCmp, pred, LHS, RHS, NameStr,
1216 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1217 "Invalid FCmp predicate value");
1218 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1219 "Both operands to FCmp instruction are not of the same type!");
1220 // Check that the operands are the right type
1221 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1222 "Invalid operand types for FCmp instruction");
1225 /// \brief Constructor with insert-at-end semantics.
1227 BasicBlock &InsertAtEnd, ///< Block to insert into.
1228 Predicate pred, ///< The predicate to use for the comparison
1229 Value *LHS, ///< The left-hand-side of the expression
1230 Value *RHS, ///< The right-hand-side of the expression
1231 const Twine &NameStr = "" ///< Name of the instruction
1232 ) : CmpInst(makeCmpResultType(LHS->getType()),
1233 Instruction::FCmp, pred, LHS, RHS, NameStr,
1235 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1236 "Invalid FCmp predicate value");
1237 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1238 "Both operands to FCmp instruction are not of the same type!");
1239 // Check that the operands are the right type
1240 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1241 "Invalid operand types for FCmp instruction");
1244 /// \brief Constructor with no-insertion semantics
1246 Predicate pred, ///< The predicate to use for the comparison
1247 Value *LHS, ///< The left-hand-side of the expression
1248 Value *RHS, ///< The right-hand-side of the expression
1249 const Twine &NameStr = "" ///< Name of the instruction
1250 ) : CmpInst(makeCmpResultType(LHS->getType()),
1251 Instruction::FCmp, pred, LHS, RHS, NameStr) {
1252 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
1253 "Invalid FCmp predicate value");
1254 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
1255 "Both operands to FCmp instruction are not of the same type!");
1256 // Check that the operands are the right type
1257 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
1258 "Invalid operand types for FCmp instruction");
1261 /// @returns true if the predicate of this instruction is EQ or NE.
1262 /// \brief Determine if this is an equality predicate.
1263 static bool isEquality(Predicate Pred) {
1264 return Pred == FCMP_OEQ || Pred == FCMP_ONE || Pred == FCMP_UEQ ||
1268 /// @returns true if the predicate of this instruction is EQ or NE.
1269 /// \brief Determine if this is an equality predicate.
1270 bool isEquality() const { return isEquality(getPredicate()); }
1272 /// @returns true if the predicate of this instruction is commutative.
1273 /// \brief Determine if this is a commutative predicate.
1274 bool isCommutative() const {
1275 return isEquality() ||
1276 getPredicate() == FCMP_FALSE ||
1277 getPredicate() == FCMP_TRUE ||
1278 getPredicate() == FCMP_ORD ||
1279 getPredicate() == FCMP_UNO;
1282 /// @returns true if the predicate is relational (not EQ or NE).
1283 /// \brief Determine if this a relational predicate.
1284 bool isRelational() const { return !isEquality(); }
1286 /// Exchange the two operands to this instruction in such a way that it does
1287 /// not modify the semantics of the instruction. The predicate value may be
1288 /// changed to retain the same result if the predicate is order dependent
1290 /// \brief Swap operands and adjust predicate.
1291 void swapOperands() {
1292 setPredicate(getSwappedPredicate());
1293 Op<0>().swap(Op<1>());
1296 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
1297 static inline bool classof(const Instruction *I) {
1298 return I->getOpcode() == Instruction::FCmp;
1300 static inline bool classof(const Value *V) {
1301 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1305 //===----------------------------------------------------------------------===//
1306 /// CallInst - This class represents a function call, abstracting a target
1307 /// machine's calling convention. This class uses low bit of the SubClassData
1308 /// field to indicate whether or not this is a tail call. The rest of the bits
1309 /// hold the calling convention of the call.
1311 class CallInst : public Instruction {
1312 AttributeSet AttributeList; ///< parameter attributes for call
1314 CallInst(const CallInst &CI);
1315 void init(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr) {
1316 init(cast<FunctionType>(
1317 cast<PointerType>(Func->getType())->getElementType()),
1318 Func, Args, NameStr);
1320 void init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
1321 const Twine &NameStr);
1322 void init(Value *Func, const Twine &NameStr);
1324 /// Construct a CallInst given a range of arguments.
1325 /// \brief Construct a CallInst from a range of arguments
1326 inline CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1327 const Twine &NameStr, Instruction *InsertBefore);
1328 inline CallInst(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr,
1329 Instruction *InsertBefore)
1330 : CallInst(cast<FunctionType>(
1331 cast<PointerType>(Func->getType())->getElementType()),
1332 Func, Args, NameStr, InsertBefore) {}
1334 /// Construct a CallInst given a range of arguments.
1335 /// \brief Construct a CallInst from a range of arguments
1336 inline CallInst(Value *Func, ArrayRef<Value *> Args,
1337 const Twine &NameStr, BasicBlock *InsertAtEnd);
1339 explicit CallInst(Value *F, const Twine &NameStr,
1340 Instruction *InsertBefore);
1341 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1343 CallInst *clone_impl() const override;
1345 static CallInst *Create(Value *Func,
1346 ArrayRef<Value *> Args,
1347 const Twine &NameStr = "",
1348 Instruction *InsertBefore = nullptr) {
1349 return Create(cast<FunctionType>(
1350 cast<PointerType>(Func->getType())->getElementType()),
1351 Func, Args, NameStr, InsertBefore);
1353 static CallInst *Create(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1354 const Twine &NameStr = "",
1355 Instruction *InsertBefore = nullptr) {
1356 return new (unsigned(Args.size() + 1))
1357 CallInst(Ty, Func, Args, NameStr, InsertBefore);
1359 static CallInst *Create(Value *Func,
1360 ArrayRef<Value *> Args,
1361 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1362 return new(unsigned(Args.size() + 1))
1363 CallInst(Func, Args, NameStr, InsertAtEnd);
1365 static CallInst *Create(Value *F, const Twine &NameStr = "",
1366 Instruction *InsertBefore = nullptr) {
1367 return new(1) CallInst(F, NameStr, InsertBefore);
1369 static CallInst *Create(Value *F, const Twine &NameStr,
1370 BasicBlock *InsertAtEnd) {
1371 return new(1) CallInst(F, NameStr, InsertAtEnd);
1373 /// CreateMalloc - Generate the IR for a call to malloc:
1374 /// 1. Compute the malloc call's argument as the specified type's size,
1375 /// possibly multiplied by the array size if the array size is not
1377 /// 2. Call malloc with that argument.
1378 /// 3. Bitcast the result of the malloc call to the specified type.
1379 static Instruction *CreateMalloc(Instruction *InsertBefore,
1380 Type *IntPtrTy, Type *AllocTy,
1381 Value *AllocSize, Value *ArraySize = nullptr,
1382 Function* MallocF = nullptr,
1383 const Twine &Name = "");
1384 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
1385 Type *IntPtrTy, Type *AllocTy,
1386 Value *AllocSize, Value *ArraySize = nullptr,
1387 Function* MallocF = nullptr,
1388 const Twine &Name = "");
1389 /// CreateFree - Generate the IR for a call to the builtin free function.
1390 static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
1391 static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
1393 ~CallInst() override;
1395 FunctionType *getFunctionType() const { return FTy; }
1397 void mutateFunctionType(FunctionType *FTy) {
1398 mutateType(FTy->getReturnType());
1402 // Note that 'musttail' implies 'tail'.
1403 enum TailCallKind { TCK_None = 0, TCK_Tail = 1, TCK_MustTail = 2 };
1404 TailCallKind getTailCallKind() const {
1405 return TailCallKind(getSubclassDataFromInstruction() & 3);
1407 bool isTailCall() const {
1408 return (getSubclassDataFromInstruction() & 3) != TCK_None;
1410 bool isMustTailCall() const {
1411 return (getSubclassDataFromInstruction() & 3) == TCK_MustTail;
1413 void setTailCall(bool isTC = true) {
1414 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1415 unsigned(isTC ? TCK_Tail : TCK_None));
1417 void setTailCallKind(TailCallKind TCK) {
1418 setInstructionSubclassData((getSubclassDataFromInstruction() & ~3) |
1422 /// Provide fast operand accessors
1423 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1425 /// getNumArgOperands - Return the number of call arguments.
1427 unsigned getNumArgOperands() const { return getNumOperands() - 1; }
1429 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
1431 Value *getArgOperand(unsigned i) const { return getOperand(i); }
1432 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
1434 /// arg_operands - iteration adapter for range-for loops.
1435 iterator_range<op_iterator> arg_operands() {
1436 // The last operand in the op list is the callee - it's not one of the args
1437 // so we don't want to iterate over it.
1438 return iterator_range<op_iterator>(op_begin(), op_end() - 1);
1441 /// arg_operands - iteration adapter for range-for loops.
1442 iterator_range<const_op_iterator> arg_operands() const {
1443 return iterator_range<const_op_iterator>(op_begin(), op_end() - 1);
1446 /// \brief Wrappers for getting the \c Use of a call argument.
1447 const Use &getArgOperandUse(unsigned i) const { return getOperandUse(i); }
1448 Use &getArgOperandUse(unsigned i) { return getOperandUse(i); }
1450 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1452 CallingConv::ID getCallingConv() const {
1453 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 2);
1455 void setCallingConv(CallingConv::ID CC) {
1456 setInstructionSubclassData((getSubclassDataFromInstruction() & 3) |
1457 (static_cast<unsigned>(CC) << 2));
1460 /// getAttributes - Return the parameter attributes for this call.
1462 const AttributeSet &getAttributes() const { return AttributeList; }
1464 /// setAttributes - Set the parameter attributes for this call.
1466 void setAttributes(const AttributeSet &Attrs) { AttributeList = Attrs; }
1468 /// addAttribute - adds the attribute to the list of attributes.
1469 void addAttribute(unsigned i, Attribute::AttrKind attr);
1471 /// removeAttribute - removes the attribute from the list of attributes.
1472 void removeAttribute(unsigned i, Attribute attr);
1474 /// \brief adds the dereferenceable attribute to the list of attributes.
1475 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
1477 /// \brief adds the dereferenceable_or_null attribute to the list of
1479 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
1481 /// \brief Determine whether this call has the given attribute.
1482 bool hasFnAttr(Attribute::AttrKind A) const {
1483 assert(A != Attribute::NoBuiltin &&
1484 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
1485 return hasFnAttrImpl(A);
1488 /// \brief Determine whether the call or the callee has the given attributes.
1489 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const;
1491 /// \brief Extract the alignment for a call or parameter (0=unknown).
1492 unsigned getParamAlignment(unsigned i) const {
1493 return AttributeList.getParamAlignment(i);
1496 /// \brief Extract the number of dereferenceable bytes for a call or
1497 /// parameter (0=unknown).
1498 uint64_t getDereferenceableBytes(unsigned i) const {
1499 return AttributeList.getDereferenceableBytes(i);
1502 /// \brief Extract the number of dereferenceable_or_null bytes for a call or
1503 /// parameter (0=unknown).
1504 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
1505 return AttributeList.getDereferenceableOrNullBytes(i);
1508 /// \brief Return true if the call should not be treated as a call to a
1510 bool isNoBuiltin() const {
1511 return hasFnAttrImpl(Attribute::NoBuiltin) &&
1512 !hasFnAttrImpl(Attribute::Builtin);
1515 /// \brief Return true if the call should not be inlined.
1516 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
1517 void setIsNoInline() {
1518 addAttribute(AttributeSet::FunctionIndex, Attribute::NoInline);
1521 /// \brief Return true if the call can return twice
1522 bool canReturnTwice() const {
1523 return hasFnAttr(Attribute::ReturnsTwice);
1525 void setCanReturnTwice() {
1526 addAttribute(AttributeSet::FunctionIndex, Attribute::ReturnsTwice);
1529 /// \brief Determine if the call does not access memory.
1530 bool doesNotAccessMemory() const {
1531 return hasFnAttr(Attribute::ReadNone);
1533 void setDoesNotAccessMemory() {
1534 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
1537 /// \brief Determine if the call does not access or only reads memory.
1538 bool onlyReadsMemory() const {
1539 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
1541 void setOnlyReadsMemory() {
1542 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
1545 /// \brief Determine if the call cannot return.
1546 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
1547 void setDoesNotReturn() {
1548 addAttribute(AttributeSet::FunctionIndex, Attribute::NoReturn);
1551 /// \brief Determine if the call cannot unwind.
1552 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
1553 void setDoesNotThrow() {
1554 addAttribute(AttributeSet::FunctionIndex, Attribute::NoUnwind);
1557 /// \brief Determine if the call cannot be duplicated.
1558 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
1559 void setCannotDuplicate() {
1560 addAttribute(AttributeSet::FunctionIndex, Attribute::NoDuplicate);
1563 /// \brief Determine if the call returns a structure through first
1564 /// pointer argument.
1565 bool hasStructRetAttr() const {
1566 // Be friendly and also check the callee.
1567 return paramHasAttr(1, Attribute::StructRet);
1570 /// \brief Determine if any call argument is an aggregate passed by value.
1571 bool hasByValArgument() const {
1572 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1575 /// getCalledFunction - Return the function called, or null if this is an
1576 /// indirect function invocation.
1578 Function *getCalledFunction() const {
1579 return dyn_cast<Function>(Op<-1>());
1582 /// getCalledValue - Get a pointer to the function that is invoked by this
1584 const Value *getCalledValue() const { return Op<-1>(); }
1585 Value *getCalledValue() { return Op<-1>(); }
1587 /// setCalledFunction - Set the function called.
1588 void setCalledFunction(Value* Fn) {
1590 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
1593 void setCalledFunction(FunctionType *FTy, Value *Fn) {
1595 assert(FTy == cast<FunctionType>(
1596 cast<PointerType>(Fn->getType())->getElementType()));
1600 /// isInlineAsm - Check if this call is an inline asm statement.
1601 bool isInlineAsm() const {
1602 return isa<InlineAsm>(Op<-1>());
1605 // Methods for support type inquiry through isa, cast, and dyn_cast:
1606 static inline bool classof(const Instruction *I) {
1607 return I->getOpcode() == Instruction::Call;
1609 static inline bool classof(const Value *V) {
1610 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1614 bool hasFnAttrImpl(Attribute::AttrKind A) const;
1616 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1617 // method so that subclasses cannot accidentally use it.
1618 void setInstructionSubclassData(unsigned short D) {
1619 Instruction::setInstructionSubclassData(D);
1624 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1627 CallInst::CallInst(Value *Func, ArrayRef<Value *> Args,
1628 const Twine &NameStr, BasicBlock *InsertAtEnd)
1629 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1630 ->getElementType())->getReturnType(),
1632 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1633 unsigned(Args.size() + 1), InsertAtEnd) {
1634 init(Func, Args, NameStr);
1637 CallInst::CallInst(FunctionType *Ty, Value *Func, ArrayRef<Value *> Args,
1638 const Twine &NameStr, Instruction *InsertBefore)
1639 : Instruction(Ty->getReturnType(), Instruction::Call,
1640 OperandTraits<CallInst>::op_end(this) - (Args.size() + 1),
1641 unsigned(Args.size() + 1), InsertBefore) {
1642 init(Ty, Func, Args, NameStr);
1646 // Note: if you get compile errors about private methods then
1647 // please update your code to use the high-level operand
1648 // interfaces. See line 943 above.
1649 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1651 //===----------------------------------------------------------------------===//
1653 //===----------------------------------------------------------------------===//
1655 /// SelectInst - This class represents the LLVM 'select' instruction.
1657 class SelectInst : public Instruction {
1658 void init(Value *C, Value *S1, Value *S2) {
1659 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1665 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1666 Instruction *InsertBefore)
1667 : Instruction(S1->getType(), Instruction::Select,
1668 &Op<0>(), 3, InsertBefore) {
1672 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1673 BasicBlock *InsertAtEnd)
1674 : Instruction(S1->getType(), Instruction::Select,
1675 &Op<0>(), 3, InsertAtEnd) {
1680 SelectInst *clone_impl() const override;
1682 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1683 const Twine &NameStr = "",
1684 Instruction *InsertBefore = nullptr) {
1685 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1687 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1688 const Twine &NameStr,
1689 BasicBlock *InsertAtEnd) {
1690 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1693 const Value *getCondition() const { return Op<0>(); }
1694 const Value *getTrueValue() const { return Op<1>(); }
1695 const Value *getFalseValue() const { return Op<2>(); }
1696 Value *getCondition() { return Op<0>(); }
1697 Value *getTrueValue() { return Op<1>(); }
1698 Value *getFalseValue() { return Op<2>(); }
1700 /// areInvalidOperands - Return a string if the specified operands are invalid
1701 /// for a select operation, otherwise return null.
1702 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1704 /// Transparently provide more efficient getOperand methods.
1705 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1707 OtherOps getOpcode() const {
1708 return static_cast<OtherOps>(Instruction::getOpcode());
1711 // Methods for support type inquiry through isa, cast, and dyn_cast:
1712 static inline bool classof(const Instruction *I) {
1713 return I->getOpcode() == Instruction::Select;
1715 static inline bool classof(const Value *V) {
1716 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1721 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1724 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1726 //===----------------------------------------------------------------------===//
1728 //===----------------------------------------------------------------------===//
1730 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1731 /// an argument of the specified type given a va_list and increments that list
1733 class VAArgInst : public UnaryInstruction {
1735 VAArgInst *clone_impl() const override;
1738 VAArgInst(Value *List, Type *Ty, const Twine &NameStr = "",
1739 Instruction *InsertBefore = nullptr)
1740 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1743 VAArgInst(Value *List, Type *Ty, const Twine &NameStr,
1744 BasicBlock *InsertAtEnd)
1745 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1749 Value *getPointerOperand() { return getOperand(0); }
1750 const Value *getPointerOperand() const { return getOperand(0); }
1751 static unsigned getPointerOperandIndex() { return 0U; }
1753 // Methods for support type inquiry through isa, cast, and dyn_cast:
1754 static inline bool classof(const Instruction *I) {
1755 return I->getOpcode() == VAArg;
1757 static inline bool classof(const Value *V) {
1758 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1762 //===----------------------------------------------------------------------===//
1763 // ExtractElementInst Class
1764 //===----------------------------------------------------------------------===//
1766 /// ExtractElementInst - This instruction extracts a single (scalar)
1767 /// element from a VectorType value
1769 class ExtractElementInst : public Instruction {
1770 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1771 Instruction *InsertBefore = nullptr);
1772 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1773 BasicBlock *InsertAtEnd);
1775 ExtractElementInst *clone_impl() const override;
1778 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1779 const Twine &NameStr = "",
1780 Instruction *InsertBefore = nullptr) {
1781 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1783 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1784 const Twine &NameStr,
1785 BasicBlock *InsertAtEnd) {
1786 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1789 /// isValidOperands - Return true if an extractelement instruction can be
1790 /// formed with the specified operands.
1791 static bool isValidOperands(const Value *Vec, const Value *Idx);
1793 Value *getVectorOperand() { return Op<0>(); }
1794 Value *getIndexOperand() { return Op<1>(); }
1795 const Value *getVectorOperand() const { return Op<0>(); }
1796 const Value *getIndexOperand() const { return Op<1>(); }
1798 VectorType *getVectorOperandType() const {
1799 return cast<VectorType>(getVectorOperand()->getType());
1803 /// Transparently provide more efficient getOperand methods.
1804 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1806 // Methods for support type inquiry through isa, cast, and dyn_cast:
1807 static inline bool classof(const Instruction *I) {
1808 return I->getOpcode() == Instruction::ExtractElement;
1810 static inline bool classof(const Value *V) {
1811 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1816 struct OperandTraits<ExtractElementInst> :
1817 public FixedNumOperandTraits<ExtractElementInst, 2> {
1820 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1822 //===----------------------------------------------------------------------===//
1823 // InsertElementInst Class
1824 //===----------------------------------------------------------------------===//
1826 /// InsertElementInst - This instruction inserts a single (scalar)
1827 /// element into a VectorType value
1829 class InsertElementInst : public Instruction {
1830 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1831 const Twine &NameStr = "",
1832 Instruction *InsertBefore = nullptr);
1833 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1834 const Twine &NameStr, BasicBlock *InsertAtEnd);
1836 InsertElementInst *clone_impl() const override;
1839 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1840 const Twine &NameStr = "",
1841 Instruction *InsertBefore = nullptr) {
1842 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1844 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1845 const Twine &NameStr,
1846 BasicBlock *InsertAtEnd) {
1847 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1850 /// isValidOperands - Return true if an insertelement instruction can be
1851 /// formed with the specified operands.
1852 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1855 /// getType - Overload to return most specific vector type.
1857 VectorType *getType() const {
1858 return cast<VectorType>(Instruction::getType());
1861 /// Transparently provide more efficient getOperand methods.
1862 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1864 // Methods for support type inquiry through isa, cast, and dyn_cast:
1865 static inline bool classof(const Instruction *I) {
1866 return I->getOpcode() == Instruction::InsertElement;
1868 static inline bool classof(const Value *V) {
1869 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1874 struct OperandTraits<InsertElementInst> :
1875 public FixedNumOperandTraits<InsertElementInst, 3> {
1878 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1880 //===----------------------------------------------------------------------===//
1881 // ShuffleVectorInst Class
1882 //===----------------------------------------------------------------------===//
1884 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1887 class ShuffleVectorInst : public Instruction {
1889 ShuffleVectorInst *clone_impl() const override;
1892 // allocate space for exactly three operands
1893 void *operator new(size_t s) {
1894 return User::operator new(s, 3);
1896 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1897 const Twine &NameStr = "",
1898 Instruction *InsertBefor = nullptr);
1899 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1900 const Twine &NameStr, BasicBlock *InsertAtEnd);
1902 /// isValidOperands - Return true if a shufflevector instruction can be
1903 /// formed with the specified operands.
1904 static bool isValidOperands(const Value *V1, const Value *V2,
1907 /// getType - Overload to return most specific vector type.
1909 VectorType *getType() const {
1910 return cast<VectorType>(Instruction::getType());
1913 /// Transparently provide more efficient getOperand methods.
1914 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1916 Constant *getMask() const {
1917 return cast<Constant>(getOperand(2));
1920 /// getMaskValue - Return the index from the shuffle mask for the specified
1921 /// output result. This is either -1 if the element is undef or a number less
1922 /// than 2*numelements.
1923 static int getMaskValue(Constant *Mask, unsigned i);
1925 int getMaskValue(unsigned i) const {
1926 return getMaskValue(getMask(), i);
1929 /// getShuffleMask - Return the full mask for this instruction, where each
1930 /// element is the element number and undef's are returned as -1.
1931 static void getShuffleMask(Constant *Mask, SmallVectorImpl<int> &Result);
1933 void getShuffleMask(SmallVectorImpl<int> &Result) const {
1934 return getShuffleMask(getMask(), Result);
1937 SmallVector<int, 16> getShuffleMask() const {
1938 SmallVector<int, 16> Mask;
1939 getShuffleMask(Mask);
1944 // Methods for support type inquiry through isa, cast, and dyn_cast:
1945 static inline bool classof(const Instruction *I) {
1946 return I->getOpcode() == Instruction::ShuffleVector;
1948 static inline bool classof(const Value *V) {
1949 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1954 struct OperandTraits<ShuffleVectorInst> :
1955 public FixedNumOperandTraits<ShuffleVectorInst, 3> {
1958 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1960 //===----------------------------------------------------------------------===//
1961 // ExtractValueInst Class
1962 //===----------------------------------------------------------------------===//
1964 /// ExtractValueInst - This instruction extracts a struct member or array
1965 /// element value from an aggregate value.
1967 class ExtractValueInst : public UnaryInstruction {
1968 SmallVector<unsigned, 4> Indices;
1970 ExtractValueInst(const ExtractValueInst &EVI);
1971 void init(ArrayRef<unsigned> Idxs, const Twine &NameStr);
1973 /// Constructors - Create a extractvalue instruction with a base aggregate
1974 /// value and a list of indices. The first ctor can optionally insert before
1975 /// an existing instruction, the second appends the new instruction to the
1976 /// specified BasicBlock.
1977 inline ExtractValueInst(Value *Agg,
1978 ArrayRef<unsigned> Idxs,
1979 const Twine &NameStr,
1980 Instruction *InsertBefore);
1981 inline ExtractValueInst(Value *Agg,
1982 ArrayRef<unsigned> Idxs,
1983 const Twine &NameStr, BasicBlock *InsertAtEnd);
1985 // allocate space for exactly one operand
1986 void *operator new(size_t s) {
1987 return User::operator new(s, 1);
1990 ExtractValueInst *clone_impl() const override;
1993 static ExtractValueInst *Create(Value *Agg,
1994 ArrayRef<unsigned> Idxs,
1995 const Twine &NameStr = "",
1996 Instruction *InsertBefore = nullptr) {
1998 ExtractValueInst(Agg, Idxs, NameStr, InsertBefore);
2000 static ExtractValueInst *Create(Value *Agg,
2001 ArrayRef<unsigned> Idxs,
2002 const Twine &NameStr,
2003 BasicBlock *InsertAtEnd) {
2004 return new ExtractValueInst(Agg, Idxs, NameStr, InsertAtEnd);
2007 /// getIndexedType - Returns the type of the element that would be extracted
2008 /// with an extractvalue instruction with the specified parameters.
2010 /// Null is returned if the indices are invalid for the specified type.
2011 static Type *getIndexedType(Type *Agg, ArrayRef<unsigned> Idxs);
2013 typedef const unsigned* idx_iterator;
2014 inline idx_iterator idx_begin() const { return Indices.begin(); }
2015 inline idx_iterator idx_end() const { return Indices.end(); }
2016 inline iterator_range<idx_iterator> indices() const {
2017 return iterator_range<idx_iterator>(idx_begin(), idx_end());
2020 Value *getAggregateOperand() {
2021 return getOperand(0);
2023 const Value *getAggregateOperand() const {
2024 return getOperand(0);
2026 static unsigned getAggregateOperandIndex() {
2027 return 0U; // get index for modifying correct operand
2030 ArrayRef<unsigned> getIndices() const {
2034 unsigned getNumIndices() const {
2035 return (unsigned)Indices.size();
2038 bool hasIndices() const {
2042 // Methods for support type inquiry through isa, cast, and dyn_cast:
2043 static inline bool classof(const Instruction *I) {
2044 return I->getOpcode() == Instruction::ExtractValue;
2046 static inline bool classof(const Value *V) {
2047 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2051 ExtractValueInst::ExtractValueInst(Value *Agg,
2052 ArrayRef<unsigned> Idxs,
2053 const Twine &NameStr,
2054 Instruction *InsertBefore)
2055 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2056 ExtractValue, Agg, InsertBefore) {
2057 init(Idxs, NameStr);
2059 ExtractValueInst::ExtractValueInst(Value *Agg,
2060 ArrayRef<unsigned> Idxs,
2061 const Twine &NameStr,
2062 BasicBlock *InsertAtEnd)
2063 : UnaryInstruction(checkGEPType(getIndexedType(Agg->getType(), Idxs)),
2064 ExtractValue, Agg, InsertAtEnd) {
2065 init(Idxs, NameStr);
2069 //===----------------------------------------------------------------------===//
2070 // InsertValueInst Class
2071 //===----------------------------------------------------------------------===//
2073 /// InsertValueInst - This instruction inserts a struct field of array element
2074 /// value into an aggregate value.
2076 class InsertValueInst : public Instruction {
2077 SmallVector<unsigned, 4> Indices;
2079 void *operator new(size_t, unsigned) = delete;
2080 InsertValueInst(const InsertValueInst &IVI);
2081 void init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
2082 const Twine &NameStr);
2084 /// Constructors - Create a insertvalue instruction with a base aggregate
2085 /// value, a value to insert, and a list of indices. The first ctor can
2086 /// optionally insert before an existing instruction, the second appends
2087 /// the new instruction to the specified BasicBlock.
2088 inline InsertValueInst(Value *Agg, Value *Val,
2089 ArrayRef<unsigned> Idxs,
2090 const Twine &NameStr,
2091 Instruction *InsertBefore);
2092 inline InsertValueInst(Value *Agg, Value *Val,
2093 ArrayRef<unsigned> Idxs,
2094 const Twine &NameStr, BasicBlock *InsertAtEnd);
2096 /// Constructors - These two constructors are convenience methods because one
2097 /// and two index insertvalue instructions are so common.
2098 InsertValueInst(Value *Agg, Value *Val,
2099 unsigned Idx, const Twine &NameStr = "",
2100 Instruction *InsertBefore = nullptr);
2101 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
2102 const Twine &NameStr, BasicBlock *InsertAtEnd);
2104 InsertValueInst *clone_impl() const override;
2106 // allocate space for exactly two operands
2107 void *operator new(size_t s) {
2108 return User::operator new(s, 2);
2111 static InsertValueInst *Create(Value *Agg, Value *Val,
2112 ArrayRef<unsigned> Idxs,
2113 const Twine &NameStr = "",
2114 Instruction *InsertBefore = nullptr) {
2115 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertBefore);
2117 static InsertValueInst *Create(Value *Agg, Value *Val,
2118 ArrayRef<unsigned> Idxs,
2119 const Twine &NameStr,
2120 BasicBlock *InsertAtEnd) {
2121 return new InsertValueInst(Agg, Val, Idxs, NameStr, InsertAtEnd);
2124 /// Transparently provide more efficient getOperand methods.
2125 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2127 typedef const unsigned* idx_iterator;
2128 inline idx_iterator idx_begin() const { return Indices.begin(); }
2129 inline idx_iterator idx_end() const { return Indices.end(); }
2130 inline iterator_range<idx_iterator> indices() const {
2131 return iterator_range<idx_iterator>(idx_begin(), idx_end());
2134 Value *getAggregateOperand() {
2135 return getOperand(0);
2137 const Value *getAggregateOperand() const {
2138 return getOperand(0);
2140 static unsigned getAggregateOperandIndex() {
2141 return 0U; // get index for modifying correct operand
2144 Value *getInsertedValueOperand() {
2145 return getOperand(1);
2147 const Value *getInsertedValueOperand() const {
2148 return getOperand(1);
2150 static unsigned getInsertedValueOperandIndex() {
2151 return 1U; // get index for modifying correct operand
2154 ArrayRef<unsigned> getIndices() const {
2158 unsigned getNumIndices() const {
2159 return (unsigned)Indices.size();
2162 bool hasIndices() const {
2166 // Methods for support type inquiry through isa, cast, and dyn_cast:
2167 static inline bool classof(const Instruction *I) {
2168 return I->getOpcode() == Instruction::InsertValue;
2170 static inline bool classof(const Value *V) {
2171 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2176 struct OperandTraits<InsertValueInst> :
2177 public FixedNumOperandTraits<InsertValueInst, 2> {
2180 InsertValueInst::InsertValueInst(Value *Agg,
2182 ArrayRef<unsigned> Idxs,
2183 const Twine &NameStr,
2184 Instruction *InsertBefore)
2185 : Instruction(Agg->getType(), InsertValue,
2186 OperandTraits<InsertValueInst>::op_begin(this),
2188 init(Agg, Val, Idxs, NameStr);
2190 InsertValueInst::InsertValueInst(Value *Agg,
2192 ArrayRef<unsigned> Idxs,
2193 const Twine &NameStr,
2194 BasicBlock *InsertAtEnd)
2195 : Instruction(Agg->getType(), InsertValue,
2196 OperandTraits<InsertValueInst>::op_begin(this),
2198 init(Agg, Val, Idxs, NameStr);
2201 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
2203 //===----------------------------------------------------------------------===//
2205 //===----------------------------------------------------------------------===//
2207 // PHINode - The PHINode class is used to represent the magical mystical PHI
2208 // node, that can not exist in nature, but can be synthesized in a computer
2209 // scientist's overactive imagination.
2211 class PHINode : public Instruction {
2212 void *operator new(size_t, unsigned) = delete;
2213 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2214 /// the number actually in use.
2215 unsigned ReservedSpace;
2216 PHINode(const PHINode &PN);
2217 // allocate space for exactly zero operands
2218 void *operator new(size_t s) {
2219 return User::operator new(s, 0);
2221 explicit PHINode(Type *Ty, unsigned NumReservedValues,
2222 const Twine &NameStr = "",
2223 Instruction *InsertBefore = nullptr)
2224 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertBefore),
2225 ReservedSpace(NumReservedValues) {
2227 OperandList = allocHungoffUses(ReservedSpace);
2230 PHINode(Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
2231 BasicBlock *InsertAtEnd)
2232 : Instruction(Ty, Instruction::PHI, nullptr, 0, InsertAtEnd),
2233 ReservedSpace(NumReservedValues) {
2235 OperandList = allocHungoffUses(ReservedSpace);
2238 // allocHungoffUses - this is more complicated than the generic
2239 // User::allocHungoffUses, because we have to allocate Uses for the incoming
2240 // values and pointers to the incoming blocks, all in one allocation.
2241 Use *allocHungoffUses(unsigned) const;
2243 PHINode *clone_impl() const override;
2245 /// Constructors - NumReservedValues is a hint for the number of incoming
2246 /// edges that this phi node will have (use 0 if you really have no idea).
2247 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2248 const Twine &NameStr = "",
2249 Instruction *InsertBefore = nullptr) {
2250 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
2252 static PHINode *Create(Type *Ty, unsigned NumReservedValues,
2253 const Twine &NameStr, BasicBlock *InsertAtEnd) {
2254 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
2256 ~PHINode() override;
2258 /// Provide fast operand accessors
2259 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2261 // Block iterator interface. This provides access to the list of incoming
2262 // basic blocks, which parallels the list of incoming values.
2264 typedef BasicBlock **block_iterator;
2265 typedef BasicBlock * const *const_block_iterator;
2267 block_iterator block_begin() {
2269 reinterpret_cast<Use::UserRef*>(op_begin() + ReservedSpace);
2270 return reinterpret_cast<block_iterator>(ref + 1);
2273 const_block_iterator block_begin() const {
2274 const Use::UserRef *ref =
2275 reinterpret_cast<const Use::UserRef*>(op_begin() + ReservedSpace);
2276 return reinterpret_cast<const_block_iterator>(ref + 1);
2279 block_iterator block_end() {
2280 return block_begin() + getNumOperands();
2283 const_block_iterator block_end() const {
2284 return block_begin() + getNumOperands();
2287 op_range incoming_values() { return operands(); }
2289 const_op_range incoming_values() const { return operands(); }
2291 /// getNumIncomingValues - Return the number of incoming edges
2293 unsigned getNumIncomingValues() const { return getNumOperands(); }
2295 /// getIncomingValue - Return incoming value number x
2297 Value *getIncomingValue(unsigned i) const {
2298 return getOperand(i);
2300 void setIncomingValue(unsigned i, Value *V) {
2303 static unsigned getOperandNumForIncomingValue(unsigned i) {
2306 static unsigned getIncomingValueNumForOperand(unsigned i) {
2310 /// getIncomingBlock - Return incoming basic block number @p i.
2312 BasicBlock *getIncomingBlock(unsigned i) const {
2313 return block_begin()[i];
2316 /// getIncomingBlock - Return incoming basic block corresponding
2317 /// to an operand of the PHI.
2319 BasicBlock *getIncomingBlock(const Use &U) const {
2320 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
2321 return getIncomingBlock(unsigned(&U - op_begin()));
2324 /// getIncomingBlock - Return incoming basic block corresponding
2325 /// to value use iterator.
2327 BasicBlock *getIncomingBlock(Value::const_user_iterator I) const {
2328 return getIncomingBlock(I.getUse());
2331 void setIncomingBlock(unsigned i, BasicBlock *BB) {
2332 block_begin()[i] = BB;
2335 /// addIncoming - Add an incoming value to the end of the PHI list
2337 void addIncoming(Value *V, BasicBlock *BB) {
2338 assert(V && "PHI node got a null value!");
2339 assert(BB && "PHI node got a null basic block!");
2340 assert(getType() == V->getType() &&
2341 "All operands to PHI node must be the same type as the PHI node!");
2342 if (NumOperands == ReservedSpace)
2343 growOperands(); // Get more space!
2344 // Initialize some new operands.
2346 setIncomingValue(NumOperands - 1, V);
2347 setIncomingBlock(NumOperands - 1, BB);
2350 /// removeIncomingValue - Remove an incoming value. This is useful if a
2351 /// predecessor basic block is deleted. The value removed is returned.
2353 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
2354 /// is true), the PHI node is destroyed and any uses of it are replaced with
2355 /// dummy values. The only time there should be zero incoming values to a PHI
2356 /// node is when the block is dead, so this strategy is sound.
2358 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
2360 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
2361 int Idx = getBasicBlockIndex(BB);
2362 assert(Idx >= 0 && "Invalid basic block argument to remove!");
2363 return removeIncomingValue(Idx, DeletePHIIfEmpty);
2366 /// getBasicBlockIndex - Return the first index of the specified basic
2367 /// block in the value list for this PHI. Returns -1 if no instance.
2369 int getBasicBlockIndex(const BasicBlock *BB) const {
2370 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2371 if (block_begin()[i] == BB)
2376 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
2377 int Idx = getBasicBlockIndex(BB);
2378 assert(Idx >= 0 && "Invalid basic block argument!");
2379 return getIncomingValue(Idx);
2382 /// hasConstantValue - If the specified PHI node always merges together the
2383 /// same value, return the value, otherwise return null.
2384 Value *hasConstantValue() const;
2386 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2387 static inline bool classof(const Instruction *I) {
2388 return I->getOpcode() == Instruction::PHI;
2390 static inline bool classof(const Value *V) {
2391 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2394 void growOperands();
2398 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2401 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2403 //===----------------------------------------------------------------------===//
2404 // LandingPadInst Class
2405 //===----------------------------------------------------------------------===//
2407 //===---------------------------------------------------------------------------
2408 /// LandingPadInst - The landingpad instruction holds all of the information
2409 /// necessary to generate correct exception handling. The landingpad instruction
2410 /// cannot be moved from the top of a landing pad block, which itself is
2411 /// accessible only from the 'unwind' edge of an invoke. This uses the
2412 /// SubclassData field in Value to store whether or not the landingpad is a
2415 class LandingPadInst : public Instruction {
2416 /// ReservedSpace - The number of operands actually allocated. NumOperands is
2417 /// the number actually in use.
2418 unsigned ReservedSpace;
2419 LandingPadInst(const LandingPadInst &LP);
2421 enum ClauseType { Catch, Filter };
2423 void *operator new(size_t, unsigned) = delete;
2424 // Allocate space for exactly zero operands.
2425 void *operator new(size_t s) {
2426 return User::operator new(s, 0);
2428 void growOperands(unsigned Size);
2429 void init(Value *PersFn, unsigned NumReservedValues, const Twine &NameStr);
2431 explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2432 unsigned NumReservedValues, const Twine &NameStr,
2433 Instruction *InsertBefore);
2434 explicit LandingPadInst(Type *RetTy, Value *PersonalityFn,
2435 unsigned NumReservedValues, const Twine &NameStr,
2436 BasicBlock *InsertAtEnd);
2438 LandingPadInst *clone_impl() const override;
2440 /// Constructors - NumReservedClauses is a hint for the number of incoming
2441 /// clauses that this landingpad will have (use 0 if you really have no idea).
2442 static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2443 unsigned NumReservedClauses,
2444 const Twine &NameStr = "",
2445 Instruction *InsertBefore = nullptr);
2446 static LandingPadInst *Create(Type *RetTy, Value *PersonalityFn,
2447 unsigned NumReservedClauses,
2448 const Twine &NameStr, BasicBlock *InsertAtEnd);
2449 ~LandingPadInst() override;
2451 /// Provide fast operand accessors
2452 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2454 /// getPersonalityFn - Get the personality function associated with this
2456 Value *getPersonalityFn() const { return getOperand(0); }
2458 /// isCleanup - Return 'true' if this landingpad instruction is a
2459 /// cleanup. I.e., it should be run when unwinding even if its landing pad
2460 /// doesn't catch the exception.
2461 bool isCleanup() const { return getSubclassDataFromInstruction() & 1; }
2463 /// setCleanup - Indicate that this landingpad instruction is a cleanup.
2464 void setCleanup(bool V) {
2465 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
2469 /// Add a catch or filter clause to the landing pad.
2470 void addClause(Constant *ClauseVal);
2472 /// Get the value of the clause at index Idx. Use isCatch/isFilter to
2473 /// determine what type of clause this is.
2474 Constant *getClause(unsigned Idx) const {
2475 return cast<Constant>(OperandList[Idx + 1]);
2478 /// isCatch - Return 'true' if the clause and index Idx is a catch clause.
2479 bool isCatch(unsigned Idx) const {
2480 return !isa<ArrayType>(OperandList[Idx + 1]->getType());
2483 /// isFilter - Return 'true' if the clause and index Idx is a filter clause.
2484 bool isFilter(unsigned Idx) const {
2485 return isa<ArrayType>(OperandList[Idx + 1]->getType());
2488 /// getNumClauses - Get the number of clauses for this landing pad.
2489 unsigned getNumClauses() const { return getNumOperands() - 1; }
2491 /// reserveClauses - Grow the size of the operand list to accommodate the new
2492 /// number of clauses.
2493 void reserveClauses(unsigned Size) { growOperands(Size); }
2495 // Methods for support type inquiry through isa, cast, and dyn_cast:
2496 static inline bool classof(const Instruction *I) {
2497 return I->getOpcode() == Instruction::LandingPad;
2499 static inline bool classof(const Value *V) {
2500 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2505 struct OperandTraits<LandingPadInst> : public HungoffOperandTraits<2> {
2508 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(LandingPadInst, Value)
2510 //===----------------------------------------------------------------------===//
2512 //===----------------------------------------------------------------------===//
2514 //===---------------------------------------------------------------------------
2515 /// ReturnInst - Return a value (possibly void), from a function. Execution
2516 /// does not continue in this function any longer.
2518 class ReturnInst : public TerminatorInst {
2519 ReturnInst(const ReturnInst &RI);
2522 // ReturnInst constructors:
2523 // ReturnInst() - 'ret void' instruction
2524 // ReturnInst( null) - 'ret void' instruction
2525 // ReturnInst(Value* X) - 'ret X' instruction
2526 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2527 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2528 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2529 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2531 // NOTE: If the Value* passed is of type void then the constructor behaves as
2532 // if it was passed NULL.
2533 explicit ReturnInst(LLVMContext &C, Value *retVal = nullptr,
2534 Instruction *InsertBefore = nullptr);
2535 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2536 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2538 ReturnInst *clone_impl() const override;
2540 static ReturnInst* Create(LLVMContext &C, Value *retVal = nullptr,
2541 Instruction *InsertBefore = nullptr) {
2542 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2544 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2545 BasicBlock *InsertAtEnd) {
2546 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2548 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2549 return new(0) ReturnInst(C, InsertAtEnd);
2551 ~ReturnInst() override;
2553 /// Provide fast operand accessors
2554 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2556 /// Convenience accessor. Returns null if there is no return value.
2557 Value *getReturnValue() const {
2558 return getNumOperands() != 0 ? getOperand(0) : nullptr;
2561 unsigned getNumSuccessors() const { return 0; }
2563 // Methods for support type inquiry through isa, cast, and dyn_cast:
2564 static inline bool classof(const Instruction *I) {
2565 return (I->getOpcode() == Instruction::Ret);
2567 static inline bool classof(const Value *V) {
2568 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2571 BasicBlock *getSuccessorV(unsigned idx) const override;
2572 unsigned getNumSuccessorsV() const override;
2573 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2577 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2580 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2582 //===----------------------------------------------------------------------===//
2584 //===----------------------------------------------------------------------===//
2586 //===---------------------------------------------------------------------------
2587 /// BranchInst - Conditional or Unconditional Branch instruction.
2589 class BranchInst : public TerminatorInst {
2590 /// Ops list - Branches are strange. The operands are ordered:
2591 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2592 /// they don't have to check for cond/uncond branchness. These are mostly
2593 /// accessed relative from op_end().
2594 BranchInst(const BranchInst &BI);
2596 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2597 // BranchInst(BB *B) - 'br B'
2598 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2599 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2600 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2601 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2602 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2603 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = nullptr);
2604 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2605 Instruction *InsertBefore = nullptr);
2606 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2607 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2608 BasicBlock *InsertAtEnd);
2610 BranchInst *clone_impl() const override;
2612 static BranchInst *Create(BasicBlock *IfTrue,
2613 Instruction *InsertBefore = nullptr) {
2614 return new(1) BranchInst(IfTrue, InsertBefore);
2616 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2617 Value *Cond, Instruction *InsertBefore = nullptr) {
2618 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2620 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2621 return new(1) BranchInst(IfTrue, InsertAtEnd);
2623 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2624 Value *Cond, BasicBlock *InsertAtEnd) {
2625 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2628 /// Transparently provide more efficient getOperand methods.
2629 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2631 bool isUnconditional() const { return getNumOperands() == 1; }
2632 bool isConditional() const { return getNumOperands() == 3; }
2634 Value *getCondition() const {
2635 assert(isConditional() && "Cannot get condition of an uncond branch!");
2639 void setCondition(Value *V) {
2640 assert(isConditional() && "Cannot set condition of unconditional branch!");
2644 unsigned getNumSuccessors() const { return 1+isConditional(); }
2646 BasicBlock *getSuccessor(unsigned i) const {
2647 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2648 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2651 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2652 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2653 *(&Op<-1>() - idx) = (Value*)NewSucc;
2656 /// \brief Swap the successors of this branch instruction.
2658 /// Swaps the successors of the branch instruction. This also swaps any
2659 /// branch weight metadata associated with the instruction so that it
2660 /// continues to map correctly to each operand.
2661 void swapSuccessors();
2663 // Methods for support type inquiry through isa, cast, and dyn_cast:
2664 static inline bool classof(const Instruction *I) {
2665 return (I->getOpcode() == Instruction::Br);
2667 static inline bool classof(const Value *V) {
2668 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2671 BasicBlock *getSuccessorV(unsigned idx) const override;
2672 unsigned getNumSuccessorsV() const override;
2673 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2677 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2680 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2682 //===----------------------------------------------------------------------===//
2684 //===----------------------------------------------------------------------===//
2686 //===---------------------------------------------------------------------------
2687 /// SwitchInst - Multiway switch
2689 class SwitchInst : public TerminatorInst {
2690 void *operator new(size_t, unsigned) = delete;
2691 unsigned ReservedSpace;
2692 // Operand[0] = Value to switch on
2693 // Operand[1] = Default basic block destination
2694 // Operand[2n ] = Value to match
2695 // Operand[2n+1] = BasicBlock to go to on match
2696 SwitchInst(const SwitchInst &SI);
2697 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2698 void growOperands();
2699 // allocate space for exactly zero operands
2700 void *operator new(size_t s) {
2701 return User::operator new(s, 0);
2703 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2704 /// switch on and a default destination. The number of additional cases can
2705 /// be specified here to make memory allocation more efficient. This
2706 /// constructor can also autoinsert before another instruction.
2707 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2708 Instruction *InsertBefore);
2710 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2711 /// switch on and a default destination. The number of additional cases can
2712 /// be specified here to make memory allocation more efficient. This
2713 /// constructor also autoinserts at the end of the specified BasicBlock.
2714 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2715 BasicBlock *InsertAtEnd);
2717 SwitchInst *clone_impl() const override;
2721 static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1);
2723 template <class SwitchInstTy, class ConstantIntTy, class BasicBlockTy>
2724 class CaseIteratorT {
2732 typedef CaseIteratorT<SwitchInstTy, ConstantIntTy, BasicBlockTy> Self;
2734 /// Initializes case iterator for given SwitchInst and for given
2736 CaseIteratorT(SwitchInstTy *SI, unsigned CaseNum) {
2741 /// Initializes case iterator for given SwitchInst and for given
2742 /// TerminatorInst's successor index.
2743 static Self fromSuccessorIndex(SwitchInstTy *SI, unsigned SuccessorIndex) {
2744 assert(SuccessorIndex < SI->getNumSuccessors() &&
2745 "Successor index # out of range!");
2746 return SuccessorIndex != 0 ?
2747 Self(SI, SuccessorIndex - 1) :
2748 Self(SI, DefaultPseudoIndex);
2751 /// Resolves case value for current case.
2752 ConstantIntTy *getCaseValue() {
2753 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2754 return reinterpret_cast<ConstantIntTy*>(SI->getOperand(2 + Index*2));
2757 /// Resolves successor for current case.
2758 BasicBlockTy *getCaseSuccessor() {
2759 assert((Index < SI->getNumCases() ||
2760 Index == DefaultPseudoIndex) &&
2761 "Index out the number of cases.");
2762 return SI->getSuccessor(getSuccessorIndex());
2765 /// Returns number of current case.
2766 unsigned getCaseIndex() const { return Index; }
2768 /// Returns TerminatorInst's successor index for current case successor.
2769 unsigned getSuccessorIndex() const {
2770 assert((Index == DefaultPseudoIndex || Index < SI->getNumCases()) &&
2771 "Index out the number of cases.");
2772 return Index != DefaultPseudoIndex ? Index + 1 : 0;
2776 // Check index correctness after increment.
2777 // Note: Index == getNumCases() means end().
2778 assert(Index+1 <= SI->getNumCases() && "Index out the number of cases.");
2782 Self operator++(int) {
2788 // Check index correctness after decrement.
2789 // Note: Index == getNumCases() means end().
2790 // Also allow "-1" iterator here. That will became valid after ++.
2791 assert((Index == 0 || Index-1 <= SI->getNumCases()) &&
2792 "Index out the number of cases.");
2796 Self operator--(int) {
2801 bool operator==(const Self& RHS) const {
2802 assert(RHS.SI == SI && "Incompatible operators.");
2803 return RHS.Index == Index;
2805 bool operator!=(const Self& RHS) const {
2806 assert(RHS.SI == SI && "Incompatible operators.");
2807 return RHS.Index != Index;
2814 typedef CaseIteratorT<const SwitchInst, const ConstantInt, const BasicBlock>
2817 class CaseIt : public CaseIteratorT<SwitchInst, ConstantInt, BasicBlock> {
2819 typedef CaseIteratorT<SwitchInst, ConstantInt, BasicBlock> ParentTy;
2823 CaseIt(const ParentTy& Src) : ParentTy(Src) {}
2824 CaseIt(SwitchInst *SI, unsigned CaseNum) : ParentTy(SI, CaseNum) {}
2826 /// Sets the new value for current case.
2827 void setValue(ConstantInt *V) {
2828 assert(Index < SI->getNumCases() && "Index out the number of cases.");
2829 SI->setOperand(2 + Index*2, reinterpret_cast<Value*>(V));
2832 /// Sets the new successor for current case.
2833 void setSuccessor(BasicBlock *S) {
2834 SI->setSuccessor(getSuccessorIndex(), S);
2838 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2840 Instruction *InsertBefore = nullptr) {
2841 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2843 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2844 unsigned NumCases, BasicBlock *InsertAtEnd) {
2845 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2848 ~SwitchInst() override;
2850 /// Provide fast operand accessors
2851 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2853 // Accessor Methods for Switch stmt
2854 Value *getCondition() const { return getOperand(0); }
2855 void setCondition(Value *V) { setOperand(0, V); }
2857 BasicBlock *getDefaultDest() const {
2858 return cast<BasicBlock>(getOperand(1));
2861 void setDefaultDest(BasicBlock *DefaultCase) {
2862 setOperand(1, reinterpret_cast<Value*>(DefaultCase));
2865 /// getNumCases - return the number of 'cases' in this switch instruction,
2866 /// except the default case
2867 unsigned getNumCases() const {
2868 return getNumOperands()/2 - 1;
2871 /// Returns a read/write iterator that points to the first
2872 /// case in SwitchInst.
2873 CaseIt case_begin() {
2874 return CaseIt(this, 0);
2876 /// Returns a read-only iterator that points to the first
2877 /// case in the SwitchInst.
2878 ConstCaseIt case_begin() const {
2879 return ConstCaseIt(this, 0);
2882 /// Returns a read/write iterator that points one past the last
2883 /// in the SwitchInst.
2885 return CaseIt(this, getNumCases());
2887 /// Returns a read-only iterator that points one past the last
2888 /// in the SwitchInst.
2889 ConstCaseIt case_end() const {
2890 return ConstCaseIt(this, getNumCases());
2893 /// cases - iteration adapter for range-for loops.
2894 iterator_range<CaseIt> cases() {
2895 return iterator_range<CaseIt>(case_begin(), case_end());
2898 /// cases - iteration adapter for range-for loops.
2899 iterator_range<ConstCaseIt> cases() const {
2900 return iterator_range<ConstCaseIt>(case_begin(), case_end());
2903 /// Returns an iterator that points to the default case.
2904 /// Note: this iterator allows to resolve successor only. Attempt
2905 /// to resolve case value causes an assertion.
2906 /// Also note, that increment and decrement also causes an assertion and
2907 /// makes iterator invalid.
2908 CaseIt case_default() {
2909 return CaseIt(this, DefaultPseudoIndex);
2911 ConstCaseIt case_default() const {
2912 return ConstCaseIt(this, DefaultPseudoIndex);
2915 /// findCaseValue - Search all of the case values for the specified constant.
2916 /// If it is explicitly handled, return the case iterator of it, otherwise
2917 /// return default case iterator to indicate
2918 /// that it is handled by the default handler.
2919 CaseIt findCaseValue(const ConstantInt *C) {
2920 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i)
2921 if (i.getCaseValue() == C)
2923 return case_default();
2925 ConstCaseIt findCaseValue(const ConstantInt *C) const {
2926 for (ConstCaseIt i = case_begin(), e = case_end(); i != e; ++i)
2927 if (i.getCaseValue() == C)
2929 return case_default();
2932 /// findCaseDest - Finds the unique case value for a given successor. Returns
2933 /// null if the successor is not found, not unique, or is the default case.
2934 ConstantInt *findCaseDest(BasicBlock *BB) {
2935 if (BB == getDefaultDest()) return nullptr;
2937 ConstantInt *CI = nullptr;
2938 for (CaseIt i = case_begin(), e = case_end(); i != e; ++i) {
2939 if (i.getCaseSuccessor() == BB) {
2940 if (CI) return nullptr; // Multiple cases lead to BB.
2941 else CI = i.getCaseValue();
2947 /// addCase - Add an entry to the switch instruction...
2949 /// This action invalidates case_end(). Old case_end() iterator will
2950 /// point to the added case.
2951 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2953 /// removeCase - This method removes the specified case and its successor
2954 /// from the switch instruction. Note that this operation may reorder the
2955 /// remaining cases at index idx and above.
2957 /// This action invalidates iterators for all cases following the one removed,
2958 /// including the case_end() iterator.
2959 void removeCase(CaseIt i);
2961 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2962 BasicBlock *getSuccessor(unsigned idx) const {
2963 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2964 return cast<BasicBlock>(getOperand(idx*2+1));
2966 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2967 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2968 setOperand(idx*2+1, (Value*)NewSucc);
2971 // Methods for support type inquiry through isa, cast, and dyn_cast:
2972 static inline bool classof(const Instruction *I) {
2973 return I->getOpcode() == Instruction::Switch;
2975 static inline bool classof(const Value *V) {
2976 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2979 BasicBlock *getSuccessorV(unsigned idx) const override;
2980 unsigned getNumSuccessorsV() const override;
2981 void setSuccessorV(unsigned idx, BasicBlock *B) override;
2985 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2988 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2991 //===----------------------------------------------------------------------===//
2992 // IndirectBrInst Class
2993 //===----------------------------------------------------------------------===//
2995 //===---------------------------------------------------------------------------
2996 /// IndirectBrInst - Indirect Branch Instruction.
2998 class IndirectBrInst : public TerminatorInst {
2999 void *operator new(size_t, unsigned) = delete;
3000 unsigned ReservedSpace;
3001 // Operand[0] = Value to switch on
3002 // Operand[1] = Default basic block destination
3003 // Operand[2n ] = Value to match
3004 // Operand[2n+1] = BasicBlock to go to on match
3005 IndirectBrInst(const IndirectBrInst &IBI);
3006 void init(Value *Address, unsigned NumDests);
3007 void growOperands();
3008 // allocate space for exactly zero operands
3009 void *operator new(size_t s) {
3010 return User::operator new(s, 0);
3012 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
3013 /// Address to jump to. The number of expected destinations can be specified
3014 /// here to make memory allocation more efficient. This constructor can also
3015 /// autoinsert before another instruction.
3016 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
3018 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
3019 /// Address to jump to. The number of expected destinations can be specified
3020 /// here to make memory allocation more efficient. This constructor also
3021 /// autoinserts at the end of the specified BasicBlock.
3022 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
3024 IndirectBrInst *clone_impl() const override;
3026 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3027 Instruction *InsertBefore = nullptr) {
3028 return new IndirectBrInst(Address, NumDests, InsertBefore);
3030 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
3031 BasicBlock *InsertAtEnd) {
3032 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
3034 ~IndirectBrInst() override;
3036 /// Provide fast operand accessors.
3037 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3039 // Accessor Methods for IndirectBrInst instruction.
3040 Value *getAddress() { return getOperand(0); }
3041 const Value *getAddress() const { return getOperand(0); }
3042 void setAddress(Value *V) { setOperand(0, V); }
3045 /// getNumDestinations - return the number of possible destinations in this
3046 /// indirectbr instruction.
3047 unsigned getNumDestinations() const { return getNumOperands()-1; }
3049 /// getDestination - Return the specified destination.
3050 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
3051 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
3053 /// addDestination - Add a destination.
3055 void addDestination(BasicBlock *Dest);
3057 /// removeDestination - This method removes the specified successor from the
3058 /// indirectbr instruction.
3059 void removeDestination(unsigned i);
3061 unsigned getNumSuccessors() const { return getNumOperands()-1; }
3062 BasicBlock *getSuccessor(unsigned i) const {
3063 return cast<BasicBlock>(getOperand(i+1));
3065 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
3066 setOperand(i+1, (Value*)NewSucc);
3069 // Methods for support type inquiry through isa, cast, and dyn_cast:
3070 static inline bool classof(const Instruction *I) {
3071 return I->getOpcode() == Instruction::IndirectBr;
3073 static inline bool classof(const Value *V) {
3074 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3077 BasicBlock *getSuccessorV(unsigned idx) const override;
3078 unsigned getNumSuccessorsV() const override;
3079 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3083 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
3086 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
3089 //===----------------------------------------------------------------------===//
3091 //===----------------------------------------------------------------------===//
3093 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
3094 /// calling convention of the call.
3096 class InvokeInst : public TerminatorInst {
3097 AttributeSet AttributeList;
3099 InvokeInst(const InvokeInst &BI);
3100 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3101 ArrayRef<Value *> Args, const Twine &NameStr) {
3102 init(cast<FunctionType>(
3103 cast<PointerType>(Func->getType())->getElementType()),
3104 Func, IfNormal, IfException, Args, NameStr);
3106 void init(FunctionType *FTy, Value *Func, BasicBlock *IfNormal,
3107 BasicBlock *IfException, ArrayRef<Value *> Args,
3108 const Twine &NameStr);
3110 /// Construct an InvokeInst given a range of arguments.
3112 /// \brief Construct an InvokeInst from a range of arguments
3113 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3114 ArrayRef<Value *> Args, unsigned Values,
3115 const Twine &NameStr, Instruction *InsertBefore)
3116 : InvokeInst(cast<FunctionType>(
3117 cast<PointerType>(Func->getType())->getElementType()),
3118 Func, IfNormal, IfException, Args, Values, NameStr,
3121 inline InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3122 BasicBlock *IfException, ArrayRef<Value *> Args,
3123 unsigned Values, const Twine &NameStr,
3124 Instruction *InsertBefore);
3125 /// Construct an InvokeInst given a range of arguments.
3127 /// \brief Construct an InvokeInst from a range of arguments
3128 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
3129 ArrayRef<Value *> Args, unsigned Values,
3130 const Twine &NameStr, BasicBlock *InsertAtEnd);
3132 InvokeInst *clone_impl() const override;
3134 static InvokeInst *Create(Value *Func,
3135 BasicBlock *IfNormal, BasicBlock *IfException,
3136 ArrayRef<Value *> Args, const Twine &NameStr = "",
3137 Instruction *InsertBefore = nullptr) {
3138 return Create(cast<FunctionType>(
3139 cast<PointerType>(Func->getType())->getElementType()),
3140 Func, IfNormal, IfException, Args, NameStr, InsertBefore);
3142 static InvokeInst *Create(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3143 BasicBlock *IfException, ArrayRef<Value *> Args,
3144 const Twine &NameStr = "",
3145 Instruction *InsertBefore = nullptr) {
3146 unsigned Values = unsigned(Args.size()) + 3;
3147 return new (Values) InvokeInst(Ty, Func, IfNormal, IfException, Args,
3148 Values, NameStr, InsertBefore);
3150 static InvokeInst *Create(Value *Func,
3151 BasicBlock *IfNormal, BasicBlock *IfException,
3152 ArrayRef<Value *> Args, const Twine &NameStr,
3153 BasicBlock *InsertAtEnd) {
3154 unsigned Values = unsigned(Args.size()) + 3;
3155 return new(Values) InvokeInst(Func, IfNormal, IfException, Args,
3156 Values, NameStr, InsertAtEnd);
3159 /// Provide fast operand accessors
3160 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3162 FunctionType *getFunctionType() const { return FTy; }
3164 void mutateFunctionType(FunctionType *FTy) {
3165 mutateType(FTy->getReturnType());
3169 /// getNumArgOperands - Return the number of invoke arguments.
3171 unsigned getNumArgOperands() const { return getNumOperands() - 3; }
3173 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
3175 Value *getArgOperand(unsigned i) const { return getOperand(i); }
3176 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
3178 /// arg_operands - iteration adapter for range-for loops.
3179 iterator_range<op_iterator> arg_operands() {
3180 return iterator_range<op_iterator>(op_begin(), op_end() - 3);
3183 /// arg_operands - iteration adapter for range-for loops.
3184 iterator_range<const_op_iterator> arg_operands() const {
3185 return iterator_range<const_op_iterator>(op_begin(), op_end() - 3);
3188 /// \brief Wrappers for getting the \c Use of a invoke argument.
3189 const Use &getArgOperandUse(unsigned i) const { return getOperandUse(i); }
3190 Use &getArgOperandUse(unsigned i) { return getOperandUse(i); }
3192 /// getCallingConv/setCallingConv - Get or set the calling convention of this
3194 CallingConv::ID getCallingConv() const {
3195 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
3197 void setCallingConv(CallingConv::ID CC) {
3198 setInstructionSubclassData(static_cast<unsigned>(CC));
3201 /// getAttributes - Return the parameter attributes for this invoke.
3203 const AttributeSet &getAttributes() const { return AttributeList; }
3205 /// setAttributes - Set the parameter attributes for this invoke.
3207 void setAttributes(const AttributeSet &Attrs) { AttributeList = Attrs; }
3209 /// addAttribute - adds the attribute to the list of attributes.
3210 void addAttribute(unsigned i, Attribute::AttrKind attr);
3212 /// removeAttribute - removes the attribute from the list of attributes.
3213 void removeAttribute(unsigned i, Attribute attr);
3215 /// \brief adds the dereferenceable attribute to the list of attributes.
3216 void addDereferenceableAttr(unsigned i, uint64_t Bytes);
3218 /// \brief adds the dereferenceable_or_null attribute to the list of
3220 void addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes);
3222 /// \brief Determine whether this call has the given attribute.
3223 bool hasFnAttr(Attribute::AttrKind A) const {
3224 assert(A != Attribute::NoBuiltin &&
3225 "Use CallInst::isNoBuiltin() to check for Attribute::NoBuiltin");
3226 return hasFnAttrImpl(A);
3229 /// \brief Determine whether the call or the callee has the given attributes.
3230 bool paramHasAttr(unsigned i, Attribute::AttrKind A) const;
3232 /// \brief Extract the alignment for a call or parameter (0=unknown).
3233 unsigned getParamAlignment(unsigned i) const {
3234 return AttributeList.getParamAlignment(i);
3237 /// \brief Extract the number of dereferenceable bytes for a call or
3238 /// parameter (0=unknown).
3239 uint64_t getDereferenceableBytes(unsigned i) const {
3240 return AttributeList.getDereferenceableBytes(i);
3243 /// \brief Extract the number of dereferenceable_or_null bytes for a call or
3244 /// parameter (0=unknown).
3245 uint64_t getDereferenceableOrNullBytes(unsigned i) const {
3246 return AttributeList.getDereferenceableOrNullBytes(i);
3249 /// \brief Return true if the call should not be treated as a call to a
3251 bool isNoBuiltin() const {
3252 // We assert in hasFnAttr if one passes in Attribute::NoBuiltin, so we have
3253 // to check it by hand.
3254 return hasFnAttrImpl(Attribute::NoBuiltin) &&
3255 !hasFnAttrImpl(Attribute::Builtin);
3258 /// \brief Return true if the call should not be inlined.
3259 bool isNoInline() const { return hasFnAttr(Attribute::NoInline); }
3260 void setIsNoInline() {
3261 addAttribute(AttributeSet::FunctionIndex, Attribute::NoInline);
3264 /// \brief Determine if the call does not access memory.
3265 bool doesNotAccessMemory() const {
3266 return hasFnAttr(Attribute::ReadNone);
3268 void setDoesNotAccessMemory() {
3269 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone);
3272 /// \brief Determine if the call does not access or only reads memory.
3273 bool onlyReadsMemory() const {
3274 return doesNotAccessMemory() || hasFnAttr(Attribute::ReadOnly);
3276 void setOnlyReadsMemory() {
3277 addAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly);
3280 /// \brief Determine if the call cannot return.
3281 bool doesNotReturn() const { return hasFnAttr(Attribute::NoReturn); }
3282 void setDoesNotReturn() {
3283 addAttribute(AttributeSet::FunctionIndex, Attribute::NoReturn);
3286 /// \brief Determine if the call cannot unwind.
3287 bool doesNotThrow() const { return hasFnAttr(Attribute::NoUnwind); }
3288 void setDoesNotThrow() {
3289 addAttribute(AttributeSet::FunctionIndex, Attribute::NoUnwind);
3292 /// \brief Determine if the invoke cannot be duplicated.
3293 bool cannotDuplicate() const {return hasFnAttr(Attribute::NoDuplicate); }
3294 void setCannotDuplicate() {
3295 addAttribute(AttributeSet::FunctionIndex, Attribute::NoDuplicate);
3298 /// \brief Determine if the call returns a structure through first
3299 /// pointer argument.
3300 bool hasStructRetAttr() const {
3301 // Be friendly and also check the callee.
3302 return paramHasAttr(1, Attribute::StructRet);
3305 /// \brief Determine if any call argument is an aggregate passed by value.
3306 bool hasByValArgument() const {
3307 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
3310 /// getCalledFunction - Return the function called, or null if this is an
3311 /// indirect function invocation.
3313 Function *getCalledFunction() const {
3314 return dyn_cast<Function>(Op<-3>());
3317 /// getCalledValue - Get a pointer to the function that is invoked by this
3319 const Value *getCalledValue() const { return Op<-3>(); }
3320 Value *getCalledValue() { return Op<-3>(); }
3322 /// setCalledFunction - Set the function called.
3323 void setCalledFunction(Value* Fn) {
3325 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType()),
3328 void setCalledFunction(FunctionType *FTy, Value *Fn) {
3330 assert(FTy == cast<FunctionType>(
3331 cast<PointerType>(Fn->getType())->getElementType()));
3335 // get*Dest - Return the destination basic blocks...
3336 BasicBlock *getNormalDest() const {
3337 return cast<BasicBlock>(Op<-2>());
3339 BasicBlock *getUnwindDest() const {
3340 return cast<BasicBlock>(Op<-1>());
3342 void setNormalDest(BasicBlock *B) {
3343 Op<-2>() = reinterpret_cast<Value*>(B);
3345 void setUnwindDest(BasicBlock *B) {
3346 Op<-1>() = reinterpret_cast<Value*>(B);
3349 /// getLandingPadInst - Get the landingpad instruction from the landing pad
3350 /// block (the unwind destination).
3351 LandingPadInst *getLandingPadInst() const;
3353 BasicBlock *getSuccessor(unsigned i) const {
3354 assert(i < 2 && "Successor # out of range for invoke!");
3355 return i == 0 ? getNormalDest() : getUnwindDest();
3358 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
3359 assert(idx < 2 && "Successor # out of range for invoke!");
3360 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
3363 unsigned getNumSuccessors() const { return 2; }
3365 // Methods for support type inquiry through isa, cast, and dyn_cast:
3366 static inline bool classof(const Instruction *I) {
3367 return (I->getOpcode() == Instruction::Invoke);
3369 static inline bool classof(const Value *V) {
3370 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3374 BasicBlock *getSuccessorV(unsigned idx) const override;
3375 unsigned getNumSuccessorsV() const override;
3376 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3378 bool hasFnAttrImpl(Attribute::AttrKind A) const;
3380 // Shadow Instruction::setInstructionSubclassData with a private forwarding
3381 // method so that subclasses cannot accidentally use it.
3382 void setInstructionSubclassData(unsigned short D) {
3383 Instruction::setInstructionSubclassData(D);
3388 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
3391 InvokeInst::InvokeInst(FunctionType *Ty, Value *Func, BasicBlock *IfNormal,
3392 BasicBlock *IfException, ArrayRef<Value *> Args,
3393 unsigned Values, const Twine &NameStr,
3394 Instruction *InsertBefore)
3395 : TerminatorInst(Ty->getReturnType(), Instruction::Invoke,
3396 OperandTraits<InvokeInst>::op_end(this) - Values, Values,
3398 init(Ty, Func, IfNormal, IfException, Args, NameStr);
3400 InvokeInst::InvokeInst(Value *Func,
3401 BasicBlock *IfNormal, BasicBlock *IfException,
3402 ArrayRef<Value *> Args, unsigned Values,
3403 const Twine &NameStr, BasicBlock *InsertAtEnd)
3404 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
3405 ->getElementType())->getReturnType(),
3406 Instruction::Invoke,
3407 OperandTraits<InvokeInst>::op_end(this) - Values,
3408 Values, InsertAtEnd) {
3409 init(Func, IfNormal, IfException, Args, NameStr);
3412 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
3414 //===----------------------------------------------------------------------===//
3416 //===----------------------------------------------------------------------===//
3418 //===---------------------------------------------------------------------------
3419 /// ResumeInst - Resume the propagation of an exception.
3421 class ResumeInst : public TerminatorInst {
3422 ResumeInst(const ResumeInst &RI);
3424 explicit ResumeInst(Value *Exn, Instruction *InsertBefore=nullptr);
3425 ResumeInst(Value *Exn, BasicBlock *InsertAtEnd);
3427 ResumeInst *clone_impl() const override;
3429 static ResumeInst *Create(Value *Exn, Instruction *InsertBefore = nullptr) {
3430 return new(1) ResumeInst(Exn, InsertBefore);
3432 static ResumeInst *Create(Value *Exn, BasicBlock *InsertAtEnd) {
3433 return new(1) ResumeInst(Exn, InsertAtEnd);
3436 /// Provide fast operand accessors
3437 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
3439 /// Convenience accessor.
3440 Value *getValue() const { return Op<0>(); }
3442 unsigned getNumSuccessors() const { return 0; }
3444 // Methods for support type inquiry through isa, cast, and dyn_cast:
3445 static inline bool classof(const Instruction *I) {
3446 return I->getOpcode() == Instruction::Resume;
3448 static inline bool classof(const Value *V) {
3449 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3452 BasicBlock *getSuccessorV(unsigned idx) const override;
3453 unsigned getNumSuccessorsV() const override;
3454 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3458 struct OperandTraits<ResumeInst> :
3459 public FixedNumOperandTraits<ResumeInst, 1> {
3462 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ResumeInst, Value)
3464 //===----------------------------------------------------------------------===//
3465 // UnreachableInst Class
3466 //===----------------------------------------------------------------------===//
3468 //===---------------------------------------------------------------------------
3469 /// UnreachableInst - This function has undefined behavior. In particular, the
3470 /// presence of this instruction indicates some higher level knowledge that the
3471 /// end of the block cannot be reached.
3473 class UnreachableInst : public TerminatorInst {
3474 void *operator new(size_t, unsigned) = delete;
3476 UnreachableInst *clone_impl() const override;
3479 // allocate space for exactly zero operands
3480 void *operator new(size_t s) {
3481 return User::operator new(s, 0);
3483 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = nullptr);
3484 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
3486 unsigned getNumSuccessors() const { return 0; }
3488 // Methods for support type inquiry through isa, cast, and dyn_cast:
3489 static inline bool classof(const Instruction *I) {
3490 return I->getOpcode() == Instruction::Unreachable;
3492 static inline bool classof(const Value *V) {
3493 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3496 BasicBlock *getSuccessorV(unsigned idx) const override;
3497 unsigned getNumSuccessorsV() const override;
3498 void setSuccessorV(unsigned idx, BasicBlock *B) override;
3501 //===----------------------------------------------------------------------===//
3503 //===----------------------------------------------------------------------===//
3505 /// \brief This class represents a truncation of integer types.
3506 class TruncInst : public CastInst {
3508 /// \brief Clone an identical TruncInst
3509 TruncInst *clone_impl() const override;
3512 /// \brief Constructor with insert-before-instruction semantics
3514 Value *S, ///< The value to be truncated
3515 Type *Ty, ///< The (smaller) type to truncate to
3516 const Twine &NameStr = "", ///< A name for the new instruction
3517 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3520 /// \brief Constructor with insert-at-end-of-block semantics
3522 Value *S, ///< The value to be truncated
3523 Type *Ty, ///< The (smaller) type to truncate to
3524 const Twine &NameStr, ///< A name for the new instruction
3525 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3528 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3529 static inline bool classof(const Instruction *I) {
3530 return I->getOpcode() == Trunc;
3532 static inline bool classof(const Value *V) {
3533 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3537 //===----------------------------------------------------------------------===//
3539 //===----------------------------------------------------------------------===//
3541 /// \brief This class represents zero extension of integer types.
3542 class ZExtInst : public CastInst {
3544 /// \brief Clone an identical ZExtInst
3545 ZExtInst *clone_impl() const override;
3548 /// \brief Constructor with insert-before-instruction semantics
3550 Value *S, ///< The value to be zero extended
3551 Type *Ty, ///< The type to zero extend to
3552 const Twine &NameStr = "", ///< A name for the new instruction
3553 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3556 /// \brief Constructor with insert-at-end semantics.
3558 Value *S, ///< The value to be zero extended
3559 Type *Ty, ///< The type to zero extend to
3560 const Twine &NameStr, ///< A name for the new instruction
3561 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3564 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3565 static inline bool classof(const Instruction *I) {
3566 return I->getOpcode() == ZExt;
3568 static inline bool classof(const Value *V) {
3569 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3573 //===----------------------------------------------------------------------===//
3575 //===----------------------------------------------------------------------===//
3577 /// \brief This class represents a sign extension of integer types.
3578 class SExtInst : public CastInst {
3580 /// \brief Clone an identical SExtInst
3581 SExtInst *clone_impl() const override;
3584 /// \brief Constructor with insert-before-instruction semantics
3586 Value *S, ///< The value to be sign extended
3587 Type *Ty, ///< The type to sign extend to
3588 const Twine &NameStr = "", ///< A name for the new instruction
3589 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3592 /// \brief Constructor with insert-at-end-of-block semantics
3594 Value *S, ///< The value to be sign extended
3595 Type *Ty, ///< The type to sign extend to
3596 const Twine &NameStr, ///< A name for the new instruction
3597 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3600 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3601 static inline bool classof(const Instruction *I) {
3602 return I->getOpcode() == SExt;
3604 static inline bool classof(const Value *V) {
3605 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3609 //===----------------------------------------------------------------------===//
3610 // FPTruncInst Class
3611 //===----------------------------------------------------------------------===//
3613 /// \brief This class represents a truncation of floating point types.
3614 class FPTruncInst : public CastInst {
3616 /// \brief Clone an identical FPTruncInst
3617 FPTruncInst *clone_impl() const override;
3620 /// \brief Constructor with insert-before-instruction semantics
3622 Value *S, ///< The value to be truncated
3623 Type *Ty, ///< The type to truncate to
3624 const Twine &NameStr = "", ///< A name for the new instruction
3625 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3628 /// \brief Constructor with insert-before-instruction semantics
3630 Value *S, ///< The value to be truncated
3631 Type *Ty, ///< The type to truncate to
3632 const Twine &NameStr, ///< A name for the new instruction
3633 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3636 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3637 static inline bool classof(const Instruction *I) {
3638 return I->getOpcode() == FPTrunc;
3640 static inline bool classof(const Value *V) {
3641 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3645 //===----------------------------------------------------------------------===//
3647 //===----------------------------------------------------------------------===//
3649 /// \brief This class represents an extension of floating point types.
3650 class FPExtInst : public CastInst {
3652 /// \brief Clone an identical FPExtInst
3653 FPExtInst *clone_impl() const override;
3656 /// \brief Constructor with insert-before-instruction semantics
3658 Value *S, ///< The value to be extended
3659 Type *Ty, ///< The type to extend to
3660 const Twine &NameStr = "", ///< A name for the new instruction
3661 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3664 /// \brief Constructor with insert-at-end-of-block semantics
3666 Value *S, ///< The value to be extended
3667 Type *Ty, ///< The type to extend to
3668 const Twine &NameStr, ///< A name for the new instruction
3669 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3672 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3673 static inline bool classof(const Instruction *I) {
3674 return I->getOpcode() == FPExt;
3676 static inline bool classof(const Value *V) {
3677 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3681 //===----------------------------------------------------------------------===//
3683 //===----------------------------------------------------------------------===//
3685 /// \brief This class represents a cast unsigned integer to floating point.
3686 class UIToFPInst : public CastInst {
3688 /// \brief Clone an identical UIToFPInst
3689 UIToFPInst *clone_impl() const override;
3692 /// \brief Constructor with insert-before-instruction semantics
3694 Value *S, ///< The value to be converted
3695 Type *Ty, ///< The type to convert to
3696 const Twine &NameStr = "", ///< A name for the new instruction
3697 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3700 /// \brief Constructor with insert-at-end-of-block semantics
3702 Value *S, ///< The value to be converted
3703 Type *Ty, ///< The type to convert to
3704 const Twine &NameStr, ///< A name for the new instruction
3705 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3708 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3709 static inline bool classof(const Instruction *I) {
3710 return I->getOpcode() == UIToFP;
3712 static inline bool classof(const Value *V) {
3713 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3717 //===----------------------------------------------------------------------===//
3719 //===----------------------------------------------------------------------===//
3721 /// \brief This class represents a cast from signed integer to floating point.
3722 class SIToFPInst : public CastInst {
3724 /// \brief Clone an identical SIToFPInst
3725 SIToFPInst *clone_impl() const override;
3728 /// \brief Constructor with insert-before-instruction semantics
3730 Value *S, ///< The value to be converted
3731 Type *Ty, ///< The type to convert to
3732 const Twine &NameStr = "", ///< A name for the new instruction
3733 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3736 /// \brief Constructor with insert-at-end-of-block semantics
3738 Value *S, ///< The value to be converted
3739 Type *Ty, ///< The type to convert to
3740 const Twine &NameStr, ///< A name for the new instruction
3741 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3744 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3745 static inline bool classof(const Instruction *I) {
3746 return I->getOpcode() == SIToFP;
3748 static inline bool classof(const Value *V) {
3749 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3753 //===----------------------------------------------------------------------===//
3755 //===----------------------------------------------------------------------===//
3757 /// \brief This class represents a cast from floating point to unsigned integer
3758 class FPToUIInst : public CastInst {
3760 /// \brief Clone an identical FPToUIInst
3761 FPToUIInst *clone_impl() const override;
3764 /// \brief Constructor with insert-before-instruction semantics
3766 Value *S, ///< The value to be converted
3767 Type *Ty, ///< The type to convert to
3768 const Twine &NameStr = "", ///< A name for the new instruction
3769 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3772 /// \brief Constructor with insert-at-end-of-block semantics
3774 Value *S, ///< The value to be converted
3775 Type *Ty, ///< The type to convert to
3776 const Twine &NameStr, ///< A name for the new instruction
3777 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
3780 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3781 static inline bool classof(const Instruction *I) {
3782 return I->getOpcode() == FPToUI;
3784 static inline bool classof(const Value *V) {
3785 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3789 //===----------------------------------------------------------------------===//
3791 //===----------------------------------------------------------------------===//
3793 /// \brief This class represents a cast from floating point to signed integer.
3794 class FPToSIInst : public CastInst {
3796 /// \brief Clone an identical FPToSIInst
3797 FPToSIInst *clone_impl() const override;
3800 /// \brief Constructor with insert-before-instruction semantics
3802 Value *S, ///< The value to be converted
3803 Type *Ty, ///< The type to convert to
3804 const Twine &NameStr = "", ///< A name for the new instruction
3805 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3808 /// \brief Constructor with insert-at-end-of-block semantics
3810 Value *S, ///< The value to be converted
3811 Type *Ty, ///< The type to convert to
3812 const Twine &NameStr, ///< A name for the new instruction
3813 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3816 /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
3817 static inline bool classof(const Instruction *I) {
3818 return I->getOpcode() == FPToSI;
3820 static inline bool classof(const Value *V) {
3821 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3825 //===----------------------------------------------------------------------===//
3826 // IntToPtrInst Class
3827 //===----------------------------------------------------------------------===//
3829 /// \brief This class represents a cast from an integer to a pointer.
3830 class IntToPtrInst : public CastInst {
3832 /// \brief Constructor with insert-before-instruction semantics
3834 Value *S, ///< The value to be converted
3835 Type *Ty, ///< The type to convert to
3836 const Twine &NameStr = "", ///< A name for the new instruction
3837 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3840 /// \brief Constructor with insert-at-end-of-block semantics
3842 Value *S, ///< The value to be converted
3843 Type *Ty, ///< The type to convert to
3844 const Twine &NameStr, ///< A name for the new instruction
3845 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3848 /// \brief Clone an identical IntToPtrInst
3849 IntToPtrInst *clone_impl() const override;
3851 /// \brief Returns the address space of this instruction's pointer type.
3852 unsigned getAddressSpace() const {
3853 return getType()->getPointerAddressSpace();
3856 // Methods for support type inquiry through isa, cast, and dyn_cast:
3857 static inline bool classof(const Instruction *I) {
3858 return I->getOpcode() == IntToPtr;
3860 static inline bool classof(const Value *V) {
3861 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3865 //===----------------------------------------------------------------------===//
3866 // PtrToIntInst Class
3867 //===----------------------------------------------------------------------===//
3869 /// \brief This class represents a cast from a pointer to an integer
3870 class PtrToIntInst : public CastInst {
3872 /// \brief Clone an identical PtrToIntInst
3873 PtrToIntInst *clone_impl() const override;
3876 /// \brief Constructor with insert-before-instruction semantics
3878 Value *S, ///< The value to be converted
3879 Type *Ty, ///< The type to convert to
3880 const Twine &NameStr = "", ///< A name for the new instruction
3881 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3884 /// \brief Constructor with insert-at-end-of-block semantics
3886 Value *S, ///< The value to be converted
3887 Type *Ty, ///< The type to convert to
3888 const Twine &NameStr, ///< A name for the new instruction
3889 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3892 /// \brief Gets the pointer operand.
3893 Value *getPointerOperand() { return getOperand(0); }
3894 /// \brief Gets the pointer operand.
3895 const Value *getPointerOperand() const { return getOperand(0); }
3896 /// \brief Gets the operand index of the pointer operand.
3897 static unsigned getPointerOperandIndex() { return 0U; }
3899 /// \brief Returns the address space of the pointer operand.
3900 unsigned getPointerAddressSpace() const {
3901 return getPointerOperand()->getType()->getPointerAddressSpace();
3904 // Methods for support type inquiry through isa, cast, and dyn_cast:
3905 static inline bool classof(const Instruction *I) {
3906 return I->getOpcode() == PtrToInt;
3908 static inline bool classof(const Value *V) {
3909 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3913 //===----------------------------------------------------------------------===//
3914 // BitCastInst Class
3915 //===----------------------------------------------------------------------===//
3917 /// \brief This class represents a no-op cast from one type to another.
3918 class BitCastInst : public CastInst {
3920 /// \brief Clone an identical BitCastInst
3921 BitCastInst *clone_impl() const override;
3924 /// \brief Constructor with insert-before-instruction semantics
3926 Value *S, ///< The value to be casted
3927 Type *Ty, ///< The type to casted to
3928 const Twine &NameStr = "", ///< A name for the new instruction
3929 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3932 /// \brief Constructor with insert-at-end-of-block semantics
3934 Value *S, ///< The value to be casted
3935 Type *Ty, ///< The type to casted to
3936 const Twine &NameStr, ///< A name for the new instruction
3937 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3940 // Methods for support type inquiry through isa, cast, and dyn_cast:
3941 static inline bool classof(const Instruction *I) {
3942 return I->getOpcode() == BitCast;
3944 static inline bool classof(const Value *V) {
3945 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3949 //===----------------------------------------------------------------------===//
3950 // AddrSpaceCastInst Class
3951 //===----------------------------------------------------------------------===//
3953 /// \brief This class represents a conversion between pointers from
3954 /// one address space to another.
3955 class AddrSpaceCastInst : public CastInst {
3957 /// \brief Clone an identical AddrSpaceCastInst
3958 AddrSpaceCastInst *clone_impl() const override;
3961 /// \brief Constructor with insert-before-instruction semantics
3963 Value *S, ///< The value to be casted
3964 Type *Ty, ///< The type to casted to
3965 const Twine &NameStr = "", ///< A name for the new instruction
3966 Instruction *InsertBefore = nullptr ///< Where to insert the new instruction
3969 /// \brief Constructor with insert-at-end-of-block semantics
3971 Value *S, ///< The value to be casted
3972 Type *Ty, ///< The type to casted to
3973 const Twine &NameStr, ///< A name for the new instruction
3974 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3977 // Methods for support type inquiry through isa, cast, and dyn_cast:
3978 static inline bool classof(const Instruction *I) {
3979 return I->getOpcode() == AddrSpaceCast;
3981 static inline bool classof(const Value *V) {
3982 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3986 } // End llvm namespace