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_INSTRUCTIONS_H
17 #define LLVM_INSTRUCTIONS_H
21 #include "llvm/InstrTypes.h"
22 #include "llvm/DerivedTypes.h"
23 #include "llvm/Attributes.h"
24 #include "llvm/BasicBlock.h"
25 #include "llvm/ADT/SmallVector.h"
35 //===----------------------------------------------------------------------===//
36 // AllocationInst Class
37 //===----------------------------------------------------------------------===//
39 /// AllocationInst - This class is the common base class of MallocInst and
42 class AllocationInst : public UnaryInstruction {
44 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
45 const std::string &Name = "", Instruction *InsertBefore = 0);
46 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
47 const std::string &Name, BasicBlock *InsertAtEnd);
49 // Out of line virtual method, so the vtable, etc. has a home.
50 virtual ~AllocationInst();
52 /// isArrayAllocation - Return true if there is an allocation size parameter
53 /// to the allocation instruction that is not 1.
55 bool isArrayAllocation() const;
57 /// getArraySize - Get the number of element allocated, for a simple
58 /// allocation of a single element, this will return a constant 1 value.
60 const Value *getArraySize() const { return getOperand(0); }
61 Value *getArraySize() { return getOperand(0); }
63 /// getType - Overload to return most specific pointer type
65 const PointerType *getType() const {
66 return reinterpret_cast<const PointerType*>(Instruction::getType());
69 /// getAllocatedType - Return the type that is being allocated by the
72 const Type *getAllocatedType() const;
74 /// getAlignment - Return the alignment of the memory that is being allocated
75 /// by the instruction.
77 unsigned getAlignment() const { return (1u << SubclassData) >> 1; }
78 void setAlignment(unsigned Align);
80 virtual Instruction *clone() const = 0;
82 // Methods for support type inquiry through isa, cast, and dyn_cast:
83 static inline bool classof(const AllocationInst *) { return true; }
84 static inline bool classof(const Instruction *I) {
85 return I->getOpcode() == Instruction::Alloca ||
86 I->getOpcode() == Instruction::Malloc;
88 static inline bool classof(const Value *V) {
89 return isa<Instruction>(V) && classof(cast<Instruction>(V));
94 //===----------------------------------------------------------------------===//
96 //===----------------------------------------------------------------------===//
98 /// MallocInst - an instruction to allocated memory on the heap
100 class MallocInst : public AllocationInst {
101 MallocInst(const MallocInst &MI);
103 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
104 const std::string &NameStr = "",
105 Instruction *InsertBefore = 0)
106 : AllocationInst(Ty, ArraySize, Malloc, 0, NameStr, InsertBefore) {}
107 MallocInst(const Type *Ty, Value *ArraySize, const std::string &NameStr,
108 BasicBlock *InsertAtEnd)
109 : AllocationInst(Ty, ArraySize, Malloc, 0, NameStr, InsertAtEnd) {}
111 MallocInst(const Type *Ty, const std::string &NameStr,
112 Instruction *InsertBefore = 0)
113 : AllocationInst(Ty, 0, Malloc, 0, NameStr, InsertBefore) {}
114 MallocInst(const Type *Ty, const std::string &NameStr, BasicBlock *InsertAtEnd)
115 : AllocationInst(Ty, 0, Malloc, 0, NameStr, InsertAtEnd) {}
117 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
118 const std::string &NameStr, BasicBlock *InsertAtEnd)
119 : AllocationInst(Ty, ArraySize, Malloc, Align, NameStr, InsertAtEnd) {}
120 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
121 const std::string &NameStr = "",
122 Instruction *InsertBefore = 0)
123 : AllocationInst(Ty, ArraySize, Malloc, Align, NameStr, InsertBefore) {}
125 virtual MallocInst *clone() const;
127 // Methods for support type inquiry through isa, cast, and dyn_cast:
128 static inline bool classof(const MallocInst *) { return true; }
129 static inline bool classof(const Instruction *I) {
130 return (I->getOpcode() == Instruction::Malloc);
132 static inline bool classof(const Value *V) {
133 return isa<Instruction>(V) && classof(cast<Instruction>(V));
138 //===----------------------------------------------------------------------===//
140 //===----------------------------------------------------------------------===//
142 /// AllocaInst - an instruction to allocate memory on the stack
144 class AllocaInst : public AllocationInst {
145 AllocaInst(const AllocaInst &);
147 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
148 const std::string &NameStr = "",
149 Instruction *InsertBefore = 0)
150 : AllocationInst(Ty, ArraySize, Alloca, 0, NameStr, InsertBefore) {}
151 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &NameStr,
152 BasicBlock *InsertAtEnd)
153 : AllocationInst(Ty, ArraySize, Alloca, 0, NameStr, InsertAtEnd) {}
155 AllocaInst(const Type *Ty, const std::string &NameStr,
156 Instruction *InsertBefore = 0)
157 : AllocationInst(Ty, 0, Alloca, 0, NameStr, InsertBefore) {}
158 AllocaInst(const Type *Ty, const std::string &NameStr,
159 BasicBlock *InsertAtEnd)
160 : AllocationInst(Ty, 0, Alloca, 0, NameStr, InsertAtEnd) {}
162 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
163 const std::string &NameStr = "", Instruction *InsertBefore = 0)
164 : AllocationInst(Ty, ArraySize, Alloca, Align, NameStr, InsertBefore) {}
165 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
166 const std::string &NameStr, BasicBlock *InsertAtEnd)
167 : AllocationInst(Ty, ArraySize, Alloca, Align, NameStr, InsertAtEnd) {}
169 virtual AllocaInst *clone() const;
171 // Methods for support type inquiry through isa, cast, and dyn_cast:
172 static inline bool classof(const AllocaInst *) { return true; }
173 static inline bool classof(const Instruction *I) {
174 return (I->getOpcode() == Instruction::Alloca);
176 static inline bool classof(const Value *V) {
177 return isa<Instruction>(V) && classof(cast<Instruction>(V));
182 //===----------------------------------------------------------------------===//
184 //===----------------------------------------------------------------------===//
186 /// FreeInst - an instruction to deallocate memory
188 class FreeInst : public UnaryInstruction {
191 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
192 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
194 virtual FreeInst *clone() const;
196 // Accessor methods for consistency with other memory operations
197 Value *getPointerOperand() { return getOperand(0); }
198 const Value *getPointerOperand() const { return getOperand(0); }
200 // Methods for support type inquiry through isa, cast, and dyn_cast:
201 static inline bool classof(const FreeInst *) { return true; }
202 static inline bool classof(const Instruction *I) {
203 return (I->getOpcode() == Instruction::Free);
205 static inline bool classof(const Value *V) {
206 return isa<Instruction>(V) && classof(cast<Instruction>(V));
211 //===----------------------------------------------------------------------===//
213 //===----------------------------------------------------------------------===//
215 /// LoadInst - an instruction for reading from memory. This uses the
216 /// SubclassData field in Value to store whether or not the load is volatile.
218 class LoadInst : public UnaryInstruction {
220 LoadInst(const LoadInst &LI)
221 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
222 setVolatile(LI.isVolatile());
223 setAlignment(LI.getAlignment());
231 LoadInst(Value *Ptr, const std::string &NameStr, Instruction *InsertBefore);
232 LoadInst(Value *Ptr, const std::string &NameStr, BasicBlock *InsertAtEnd);
233 LoadInst(Value *Ptr, const std::string &NameStr, bool isVolatile = false,
234 Instruction *InsertBefore = 0);
235 LoadInst(Value *Ptr, const std::string &NameStr, bool isVolatile,
236 unsigned Align, Instruction *InsertBefore = 0);
237 LoadInst(Value *Ptr, const std::string &NameStr, bool isVolatile,
238 BasicBlock *InsertAtEnd);
239 LoadInst(Value *Ptr, const std::string &NameStr, bool isVolatile,
240 unsigned Align, BasicBlock *InsertAtEnd);
242 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
243 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
244 explicit LoadInst(Value *Ptr, const char *NameStr = 0,
245 bool isVolatile = false, Instruction *InsertBefore = 0);
246 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
247 BasicBlock *InsertAtEnd);
249 /// isVolatile - Return true if this is a load from a volatile memory
252 bool isVolatile() const { return SubclassData & 1; }
254 /// setVolatile - Specify whether this is a volatile load or not.
256 void setVolatile(bool V) {
257 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
260 virtual LoadInst *clone() const;
262 /// getAlignment - Return the alignment of the access that is being performed
264 unsigned getAlignment() const {
265 return (1 << (SubclassData>>1)) >> 1;
268 void setAlignment(unsigned Align);
270 Value *getPointerOperand() { return getOperand(0); }
271 const Value *getPointerOperand() const { return getOperand(0); }
272 static unsigned getPointerOperandIndex() { return 0U; }
274 // Methods for support type inquiry through isa, cast, and dyn_cast:
275 static inline bool classof(const LoadInst *) { return true; }
276 static inline bool classof(const Instruction *I) {
277 return I->getOpcode() == Instruction::Load;
279 static inline bool classof(const Value *V) {
280 return isa<Instruction>(V) && classof(cast<Instruction>(V));
285 //===----------------------------------------------------------------------===//
287 //===----------------------------------------------------------------------===//
289 /// StoreInst - an instruction for storing to memory
291 class StoreInst : public Instruction {
292 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
294 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store,
296 Op<0>() = SI.Op<0>();
297 Op<1>() = SI.Op<1>();
298 setVolatile(SI.isVolatile());
299 setAlignment(SI.getAlignment());
307 // allocate space for exactly two operands
308 void *operator new(size_t s) {
309 return User::operator new(s, 2);
311 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
312 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
313 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
314 Instruction *InsertBefore = 0);
315 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
316 unsigned Align, Instruction *InsertBefore = 0);
317 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
318 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
319 unsigned Align, BasicBlock *InsertAtEnd);
322 /// isVolatile - Return true if this is a load from a volatile memory
325 bool isVolatile() const { return SubclassData & 1; }
327 /// setVolatile - Specify whether this is a volatile load or not.
329 void setVolatile(bool V) {
330 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
333 /// Transparently provide more efficient getOperand methods.
334 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
336 /// getAlignment - Return the alignment of the access that is being performed
338 unsigned getAlignment() const {
339 return (1 << (SubclassData>>1)) >> 1;
342 void setAlignment(unsigned Align);
344 virtual StoreInst *clone() const;
346 Value *getPointerOperand() { return getOperand(1); }
347 const Value *getPointerOperand() const { return getOperand(1); }
348 static unsigned getPointerOperandIndex() { return 1U; }
350 // Methods for support type inquiry through isa, cast, and dyn_cast:
351 static inline bool classof(const StoreInst *) { return true; }
352 static inline bool classof(const Instruction *I) {
353 return I->getOpcode() == Instruction::Store;
355 static inline bool classof(const Value *V) {
356 return isa<Instruction>(V) && classof(cast<Instruction>(V));
361 struct OperandTraits<StoreInst> : FixedNumOperandTraits<2> {
364 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
366 //===----------------------------------------------------------------------===//
367 // GetElementPtrInst Class
368 //===----------------------------------------------------------------------===//
370 // checkType - Simple wrapper function to give a better assertion failure
371 // message on bad indexes for a gep instruction.
373 static inline const Type *checkType(const Type *Ty) {
374 assert(Ty && "Invalid GetElementPtrInst indices for type!");
378 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
379 /// access elements of arrays and structs
381 class GetElementPtrInst : public Instruction {
382 GetElementPtrInst(const GetElementPtrInst &GEPI);
383 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx,
384 const std::string &NameStr);
385 void init(Value *Ptr, Value *Idx, const std::string &NameStr);
387 template<typename InputIterator>
388 void init(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
389 const std::string &NameStr,
390 // This argument ensures that we have an iterator we can
391 // do arithmetic on in constant time
392 std::random_access_iterator_tag) {
393 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
396 // This requires that the iterator points to contiguous memory.
397 init(Ptr, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
398 // we have to build an array here
401 init(Ptr, 0, NumIdx, NameStr);
405 /// getIndexedType - Returns the type of the element that would be loaded with
406 /// a load instruction with the specified parameters.
408 /// Null is returned if the indices are invalid for the specified
411 template<typename InputIterator>
412 static const Type *getIndexedType(const Type *Ptr,
413 InputIterator IdxBegin,
414 InputIterator IdxEnd,
415 // This argument ensures that we
416 // have an iterator we can do
417 // arithmetic on in constant time
418 std::random_access_iterator_tag) {
419 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
422 // This requires that the iterator points to contiguous memory.
423 return getIndexedType(Ptr, (Value *const *)&*IdxBegin, NumIdx);
425 return getIndexedType(Ptr, (Value *const*)0, NumIdx);
428 /// Constructors - Create a getelementptr instruction with a base pointer an
429 /// list of indices. The first ctor can optionally insert before an existing
430 /// instruction, the second appends the new instruction to the specified
432 template<typename InputIterator>
433 inline GetElementPtrInst(Value *Ptr, InputIterator IdxBegin,
434 InputIterator IdxEnd,
436 const std::string &NameStr,
437 Instruction *InsertBefore);
438 template<typename InputIterator>
439 inline GetElementPtrInst(Value *Ptr,
440 InputIterator IdxBegin, InputIterator IdxEnd,
442 const std::string &NameStr, BasicBlock *InsertAtEnd);
444 /// Constructors - These two constructors are convenience methods because one
445 /// and two index getelementptr instructions are so common.
446 GetElementPtrInst(Value *Ptr, Value *Idx, const std::string &NameStr = "",
447 Instruction *InsertBefore = 0);
448 GetElementPtrInst(Value *Ptr, Value *Idx,
449 const std::string &NameStr, BasicBlock *InsertAtEnd);
451 template<typename InputIterator>
452 static GetElementPtrInst *Create(Value *Ptr, InputIterator IdxBegin,
453 InputIterator IdxEnd,
454 const std::string &NameStr = "",
455 Instruction *InsertBefore = 0) {
456 typename std::iterator_traits<InputIterator>::difference_type Values =
457 1 + std::distance(IdxBegin, IdxEnd);
459 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertBefore);
461 template<typename InputIterator>
462 static GetElementPtrInst *Create(Value *Ptr,
463 InputIterator IdxBegin, InputIterator IdxEnd,
464 const std::string &NameStr,
465 BasicBlock *InsertAtEnd) {
466 typename std::iterator_traits<InputIterator>::difference_type Values =
467 1 + std::distance(IdxBegin, IdxEnd);
469 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertAtEnd);
472 /// Constructors - These two creators are convenience methods because one
473 /// index getelementptr instructions are so common.
474 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
475 const std::string &NameStr = "",
476 Instruction *InsertBefore = 0) {
477 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertBefore);
479 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
480 const std::string &NameStr,
481 BasicBlock *InsertAtEnd) {
482 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertAtEnd);
485 virtual GetElementPtrInst *clone() const;
487 /// Transparently provide more efficient getOperand methods.
488 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
490 // getType - Overload to return most specific pointer type...
491 const PointerType *getType() const {
492 return reinterpret_cast<const PointerType*>(Instruction::getType());
495 /// getIndexedType - Returns the type of the element that would be loaded with
496 /// a load instruction with the specified parameters.
498 /// Null is returned if the indices are invalid for the specified
501 template<typename InputIterator>
502 static const Type *getIndexedType(const Type *Ptr,
503 InputIterator IdxBegin,
504 InputIterator IdxEnd) {
505 return getIndexedType(Ptr, IdxBegin, IdxEnd,
506 typename std::iterator_traits<InputIterator>::
507 iterator_category());
510 static const Type *getIndexedType(const Type *Ptr,
511 Value* const *Idx, unsigned NumIdx);
513 static const Type *getIndexedType(const Type *Ptr,
514 uint64_t const *Idx, unsigned NumIdx);
516 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
518 inline op_iterator idx_begin() { return op_begin()+1; }
519 inline const_op_iterator idx_begin() const { return op_begin()+1; }
520 inline op_iterator idx_end() { return op_end(); }
521 inline const_op_iterator idx_end() const { return op_end(); }
523 Value *getPointerOperand() {
524 return getOperand(0);
526 const Value *getPointerOperand() const {
527 return getOperand(0);
529 static unsigned getPointerOperandIndex() {
530 return 0U; // get index for modifying correct operand
533 unsigned getNumIndices() const { // Note: always non-negative
534 return getNumOperands() - 1;
537 bool hasIndices() const {
538 return getNumOperands() > 1;
541 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
542 /// zeros. If so, the result pointer and the first operand have the same
543 /// value, just potentially different types.
544 bool hasAllZeroIndices() const;
546 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
547 /// constant integers. If so, the result pointer and the first operand have
548 /// a constant offset between them.
549 bool hasAllConstantIndices() const;
552 // Methods for support type inquiry through isa, cast, and dyn_cast:
553 static inline bool classof(const GetElementPtrInst *) { return true; }
554 static inline bool classof(const Instruction *I) {
555 return (I->getOpcode() == Instruction::GetElementPtr);
557 static inline bool classof(const Value *V) {
558 return isa<Instruction>(V) && classof(cast<Instruction>(V));
563 struct OperandTraits<GetElementPtrInst> : VariadicOperandTraits<1> {
566 template<typename InputIterator>
567 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
568 InputIterator IdxBegin,
569 InputIterator IdxEnd,
571 const std::string &NameStr,
572 Instruction *InsertBefore)
573 : Instruction(PointerType::get(checkType(
574 getIndexedType(Ptr->getType(),
576 cast<PointerType>(Ptr->getType())
577 ->getAddressSpace()),
579 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
580 Values, InsertBefore) {
581 init(Ptr, IdxBegin, IdxEnd, NameStr,
582 typename std::iterator_traits<InputIterator>::iterator_category());
584 template<typename InputIterator>
585 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
586 InputIterator IdxBegin,
587 InputIterator IdxEnd,
589 const std::string &NameStr,
590 BasicBlock *InsertAtEnd)
591 : Instruction(PointerType::get(checkType(
592 getIndexedType(Ptr->getType(),
594 cast<PointerType>(Ptr->getType())
595 ->getAddressSpace()),
597 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
598 Values, InsertAtEnd) {
599 init(Ptr, IdxBegin, IdxEnd, NameStr,
600 typename std::iterator_traits<InputIterator>::iterator_category());
604 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
607 //===----------------------------------------------------------------------===//
609 //===----------------------------------------------------------------------===//
611 /// This instruction compares its operands according to the predicate given
612 /// to the constructor. It only operates on integers or pointers. The operands
613 /// must be identical types.
614 /// @brief Represent an integer comparison operator.
615 class ICmpInst: public CmpInst {
617 /// @brief Constructor with insert-before-instruction semantics.
619 Predicate pred, ///< The predicate to use for the comparison
620 Value *LHS, ///< The left-hand-side of the expression
621 Value *RHS, ///< The right-hand-side of the expression
622 const std::string &NameStr = "", ///< Name of the instruction
623 Instruction *InsertBefore = 0 ///< Where to insert
624 ) : CmpInst(makeCmpResultType(LHS->getType()),
625 Instruction::ICmp, pred, LHS, RHS, NameStr,
627 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
628 pred <= CmpInst::LAST_ICMP_PREDICATE &&
629 "Invalid ICmp predicate value");
630 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
631 "Both operands to ICmp instruction are not of the same type!");
632 // Check that the operands are the right type
633 assert((getOperand(0)->getType()->isIntOrIntVector() ||
634 isa<PointerType>(getOperand(0)->getType())) &&
635 "Invalid operand types for ICmp instruction");
638 /// @brief Constructor with insert-at-block-end semantics.
640 Predicate pred, ///< The predicate to use for the comparison
641 Value *LHS, ///< The left-hand-side of the expression
642 Value *RHS, ///< The right-hand-side of the expression
643 const std::string &NameStr, ///< Name of the instruction
644 BasicBlock *InsertAtEnd ///< Block to insert into.
645 ) : CmpInst(makeCmpResultType(LHS->getType()),
646 Instruction::ICmp, pred, LHS, RHS, NameStr,
648 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
649 pred <= CmpInst::LAST_ICMP_PREDICATE &&
650 "Invalid ICmp predicate value");
651 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
652 "Both operands to ICmp instruction are not of the same type!");
653 // Check that the operands are the right type
654 assert((getOperand(0)->getType()->isIntOrIntVector() ||
655 isa<PointerType>(getOperand(0)->getType())) &&
656 "Invalid operand types for ICmp instruction");
659 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
660 /// @returns the predicate that would be the result if the operand were
661 /// regarded as signed.
662 /// @brief Return the signed version of the predicate
663 Predicate getSignedPredicate() const {
664 return getSignedPredicate(getPredicate());
667 /// This is a static version that you can use without an instruction.
668 /// @brief Return the signed version of the predicate.
669 static Predicate getSignedPredicate(Predicate pred);
671 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
672 /// @returns the predicate that would be the result if the operand were
673 /// regarded as unsigned.
674 /// @brief Return the unsigned version of the predicate
675 Predicate getUnsignedPredicate() const {
676 return getUnsignedPredicate(getPredicate());
679 /// This is a static version that you can use without an instruction.
680 /// @brief Return the unsigned version of the predicate.
681 static Predicate getUnsignedPredicate(Predicate pred);
683 /// isEquality - Return true if this predicate is either EQ or NE. This also
684 /// tests for commutativity.
685 static bool isEquality(Predicate P) {
686 return P == ICMP_EQ || P == ICMP_NE;
689 /// isEquality - Return true if this predicate is either EQ or NE. This also
690 /// tests for commutativity.
691 bool isEquality() const {
692 return isEquality(getPredicate());
695 /// @returns true if the predicate of this ICmpInst is commutative
696 /// @brief Determine if this relation is commutative.
697 bool isCommutative() const { return isEquality(); }
699 /// isRelational - Return true if the predicate is relational (not EQ or NE).
701 bool isRelational() const {
702 return !isEquality();
705 /// isRelational - Return true if the predicate is relational (not EQ or NE).
707 static bool isRelational(Predicate P) {
708 return !isEquality(P);
711 /// @returns true if the predicate of this ICmpInst is signed, false otherwise
712 /// @brief Determine if this instruction's predicate is signed.
713 bool isSignedPredicate() const { return isSignedPredicate(getPredicate()); }
715 /// @returns true if the predicate provided is signed, false otherwise
716 /// @brief Determine if the predicate is signed.
717 static bool isSignedPredicate(Predicate pred);
719 /// @returns true if the specified compare predicate is
720 /// true when both operands are equal...
721 /// @brief Determine if the icmp is true when both operands are equal
722 static bool isTrueWhenEqual(ICmpInst::Predicate pred) {
723 return pred == ICmpInst::ICMP_EQ || pred == ICmpInst::ICMP_UGE ||
724 pred == ICmpInst::ICMP_SGE || pred == ICmpInst::ICMP_ULE ||
725 pred == ICmpInst::ICMP_SLE;
728 /// @returns true if the specified compare instruction is
729 /// true when both operands are equal...
730 /// @brief Determine if the ICmpInst returns true when both operands are equal
731 bool isTrueWhenEqual() {
732 return isTrueWhenEqual(getPredicate());
735 /// Initialize a set of values that all satisfy the predicate with C.
736 /// @brief Make a ConstantRange for a relation with a constant value.
737 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
739 /// Exchange the two operands to this instruction in such a way that it does
740 /// not modify the semantics of the instruction. The predicate value may be
741 /// changed to retain the same result if the predicate is order dependent
743 /// @brief Swap operands and adjust predicate.
744 void swapOperands() {
745 SubclassData = getSwappedPredicate();
746 Op<0>().swap(Op<1>());
749 virtual ICmpInst *clone() const;
751 // Methods for support type inquiry through isa, cast, and dyn_cast:
752 static inline bool classof(const ICmpInst *) { return true; }
753 static inline bool classof(const Instruction *I) {
754 return I->getOpcode() == Instruction::ICmp;
756 static inline bool classof(const Value *V) {
757 return isa<Instruction>(V) && classof(cast<Instruction>(V));
762 //===----------------------------------------------------------------------===//
764 //===----------------------------------------------------------------------===//
766 /// This instruction compares its operands according to the predicate given
767 /// to the constructor. It only operates on floating point values or packed
768 /// vectors of floating point values. The operands must be identical types.
769 /// @brief Represents a floating point comparison operator.
770 class FCmpInst: public CmpInst {
772 /// @brief Constructor with insert-before-instruction semantics.
774 Predicate pred, ///< The predicate to use for the comparison
775 Value *LHS, ///< The left-hand-side of the expression
776 Value *RHS, ///< The right-hand-side of the expression
777 const std::string &NameStr = "", ///< Name of the instruction
778 Instruction *InsertBefore = 0 ///< Where to insert
779 ) : CmpInst(makeCmpResultType(LHS->getType()),
780 Instruction::FCmp, pred, LHS, RHS, NameStr,
782 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
783 "Invalid FCmp predicate value");
784 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
785 "Both operands to FCmp instruction are not of the same type!");
786 // Check that the operands are the right type
787 assert(getOperand(0)->getType()->isFPOrFPVector() &&
788 "Invalid operand types for FCmp instruction");
791 /// @brief Constructor with insert-at-block-end semantics.
793 Predicate pred, ///< The predicate to use for the comparison
794 Value *LHS, ///< The left-hand-side of the expression
795 Value *RHS, ///< The right-hand-side of the expression
796 const std::string &NameStr, ///< Name of the instruction
797 BasicBlock *InsertAtEnd ///< Block to insert into.
798 ) : CmpInst(makeCmpResultType(LHS->getType()),
799 Instruction::FCmp, pred, LHS, RHS, NameStr,
801 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
802 "Invalid FCmp predicate value");
803 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
804 "Both operands to FCmp instruction are not of the same type!");
805 // Check that the operands are the right type
806 assert(getOperand(0)->getType()->isFPOrFPVector() &&
807 "Invalid operand types for FCmp instruction");
810 /// @returns true if the predicate of this instruction is EQ or NE.
811 /// @brief Determine if this is an equality predicate.
812 bool isEquality() const {
813 return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
814 SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
817 /// @returns true if the predicate of this instruction is commutative.
818 /// @brief Determine if this is a commutative predicate.
819 bool isCommutative() const {
820 return isEquality() ||
821 SubclassData == FCMP_FALSE ||
822 SubclassData == FCMP_TRUE ||
823 SubclassData == FCMP_ORD ||
824 SubclassData == FCMP_UNO;
827 /// @returns true if the predicate is relational (not EQ or NE).
828 /// @brief Determine if this a relational predicate.
829 bool isRelational() const { return !isEquality(); }
831 /// Exchange the two operands to this instruction in such a way that it does
832 /// not modify the semantics of the instruction. The predicate value may be
833 /// changed to retain the same result if the predicate is order dependent
835 /// @brief Swap operands and adjust predicate.
836 void swapOperands() {
837 SubclassData = getSwappedPredicate();
838 Op<0>().swap(Op<1>());
841 virtual FCmpInst *clone() const;
843 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
844 static inline bool classof(const FCmpInst *) { return true; }
845 static inline bool classof(const Instruction *I) {
846 return I->getOpcode() == Instruction::FCmp;
848 static inline bool classof(const Value *V) {
849 return isa<Instruction>(V) && classof(cast<Instruction>(V));
854 //===----------------------------------------------------------------------===//
856 //===----------------------------------------------------------------------===//
858 /// This instruction compares its operands according to the predicate given
859 /// to the constructor. It only operates on vectors of integers.
860 /// The operands must be identical types.
861 /// @brief Represents a vector integer comparison operator.
862 class VICmpInst: public CmpInst {
864 /// @brief Constructor with insert-before-instruction semantics.
866 Predicate pred, ///< The predicate to use for the comparison
867 Value *LHS, ///< The left-hand-side of the expression
868 Value *RHS, ///< The right-hand-side of the expression
869 const std::string &NameStr = "", ///< Name of the instruction
870 Instruction *InsertBefore = 0 ///< Where to insert
871 ) : CmpInst(LHS->getType(), Instruction::VICmp, pred, LHS, RHS, NameStr,
873 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
874 pred <= CmpInst::LAST_ICMP_PREDICATE &&
875 "Invalid VICmp predicate value");
876 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
877 "Both operands to VICmp instruction are not of the same type!");
880 /// @brief Constructor with insert-at-block-end semantics.
882 Predicate pred, ///< The predicate to use for the comparison
883 Value *LHS, ///< The left-hand-side of the expression
884 Value *RHS, ///< The right-hand-side of the expression
885 const std::string &NameStr, ///< Name of the instruction
886 BasicBlock *InsertAtEnd ///< Block to insert into.
887 ) : CmpInst(LHS->getType(), Instruction::VICmp, pred, LHS, RHS, NameStr,
889 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
890 pred <= CmpInst::LAST_ICMP_PREDICATE &&
891 "Invalid VICmp predicate value");
892 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
893 "Both operands to VICmp instruction are not of the same type!");
896 /// @brief Return the predicate for this instruction.
897 Predicate getPredicate() const { return Predicate(SubclassData); }
899 virtual VICmpInst *clone() const;
901 // Methods for support type inquiry through isa, cast, and dyn_cast:
902 static inline bool classof(const VICmpInst *) { return true; }
903 static inline bool classof(const Instruction *I) {
904 return I->getOpcode() == Instruction::VICmp;
906 static inline bool classof(const Value *V) {
907 return isa<Instruction>(V) && classof(cast<Instruction>(V));
911 //===----------------------------------------------------------------------===//
913 //===----------------------------------------------------------------------===//
915 /// This instruction compares its operands according to the predicate given
916 /// to the constructor. It only operates on vectors of floating point values.
917 /// The operands must be identical types.
918 /// @brief Represents a vector floating point comparison operator.
919 class VFCmpInst: public CmpInst {
921 /// @brief Constructor with insert-before-instruction semantics.
923 Predicate pred, ///< The predicate to use for the comparison
924 Value *LHS, ///< The left-hand-side of the expression
925 Value *RHS, ///< The right-hand-side of the expression
926 const std::string &NameStr = "", ///< Name of the instruction
927 Instruction *InsertBefore = 0 ///< Where to insert
928 ) : CmpInst(VectorType::getInteger(cast<VectorType>(LHS->getType())),
929 Instruction::VFCmp, pred, LHS, RHS, NameStr, InsertBefore) {
930 assert(pred <= CmpInst::LAST_FCMP_PREDICATE &&
931 "Invalid VFCmp predicate value");
932 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
933 "Both operands to VFCmp instruction are not of the same type!");
936 /// @brief Constructor with insert-at-block-end semantics.
938 Predicate pred, ///< The predicate to use for the comparison
939 Value *LHS, ///< The left-hand-side of the expression
940 Value *RHS, ///< The right-hand-side of the expression
941 const std::string &NameStr, ///< Name of the instruction
942 BasicBlock *InsertAtEnd ///< Block to insert into.
943 ) : CmpInst(VectorType::getInteger(cast<VectorType>(LHS->getType())),
944 Instruction::VFCmp, pred, LHS, RHS, NameStr, InsertAtEnd) {
945 assert(pred <= CmpInst::LAST_FCMP_PREDICATE &&
946 "Invalid VFCmp predicate value");
947 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
948 "Both operands to VFCmp instruction are not of the same type!");
951 /// @brief Return the predicate for this instruction.
952 Predicate getPredicate() const { return Predicate(SubclassData); }
954 virtual VFCmpInst *clone() const;
956 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
957 static inline bool classof(const VFCmpInst *) { return true; }
958 static inline bool classof(const Instruction *I) {
959 return I->getOpcode() == Instruction::VFCmp;
961 static inline bool classof(const Value *V) {
962 return isa<Instruction>(V) && classof(cast<Instruction>(V));
966 //===----------------------------------------------------------------------===//
968 //===----------------------------------------------------------------------===//
969 /// CallInst - This class represents a function call, abstracting a target
970 /// machine's calling convention. This class uses low bit of the SubClassData
971 /// field to indicate whether or not this is a tail call. The rest of the bits
972 /// hold the calling convention of the call.
975 class CallInst : public Instruction {
976 AttrListPtr AttributeList; ///< parameter attributes for call
977 CallInst(const CallInst &CI);
978 void init(Value *Func, Value* const *Params, unsigned NumParams);
979 void init(Value *Func, Value *Actual1, Value *Actual2);
980 void init(Value *Func, Value *Actual);
981 void init(Value *Func);
983 template<typename InputIterator>
984 void init(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
985 const std::string &NameStr,
986 // This argument ensures that we have an iterator we can
987 // do arithmetic on in constant time
988 std::random_access_iterator_tag) {
989 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
991 // This requires that the iterator points to contiguous memory.
992 init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
996 /// Construct a CallInst given a range of arguments. InputIterator
997 /// must be a random-access iterator pointing to contiguous storage
998 /// (e.g. a std::vector<>::iterator). Checks are made for
999 /// random-accessness but not for contiguous storage as that would
1000 /// incur runtime overhead.
1001 /// @brief Construct a CallInst from a range of arguments
1002 template<typename InputIterator>
1003 CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1004 const std::string &NameStr, Instruction *InsertBefore);
1006 /// Construct a CallInst given a range of arguments. InputIterator
1007 /// must be a random-access iterator pointing to contiguous storage
1008 /// (e.g. a std::vector<>::iterator). Checks are made for
1009 /// random-accessness but not for contiguous storage as that would
1010 /// incur runtime overhead.
1011 /// @brief Construct a CallInst from a range of arguments
1012 template<typename InputIterator>
1013 inline CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1014 const std::string &NameStr, BasicBlock *InsertAtEnd);
1016 CallInst(Value *F, Value *Actual, const std::string& NameStr,
1017 Instruction *InsertBefore);
1018 CallInst(Value *F, Value *Actual, const std::string& NameStr,
1019 BasicBlock *InsertAtEnd);
1020 explicit CallInst(Value *F, const std::string &NameStr,
1021 Instruction *InsertBefore);
1022 CallInst(Value *F, const std::string &NameStr, BasicBlock *InsertAtEnd);
1024 template<typename InputIterator>
1025 static CallInst *Create(Value *Func,
1026 InputIterator ArgBegin, InputIterator ArgEnd,
1027 const std::string &NameStr = "",
1028 Instruction *InsertBefore = 0) {
1029 return new((unsigned)(ArgEnd - ArgBegin + 1))
1030 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertBefore);
1032 template<typename InputIterator>
1033 static CallInst *Create(Value *Func,
1034 InputIterator ArgBegin, InputIterator ArgEnd,
1035 const std::string &NameStr, BasicBlock *InsertAtEnd) {
1036 return new((unsigned)(ArgEnd - ArgBegin + 1))
1037 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertAtEnd);
1039 static CallInst *Create(Value *F, Value *Actual,
1040 const std::string& NameStr = "",
1041 Instruction *InsertBefore = 0) {
1042 return new(2) CallInst(F, Actual, NameStr, InsertBefore);
1044 static CallInst *Create(Value *F, Value *Actual, const std::string& NameStr,
1045 BasicBlock *InsertAtEnd) {
1046 return new(2) CallInst(F, Actual, NameStr, InsertAtEnd);
1048 static CallInst *Create(Value *F, const std::string &NameStr = "",
1049 Instruction *InsertBefore = 0) {
1050 return new(1) CallInst(F, NameStr, InsertBefore);
1052 static CallInst *Create(Value *F, const std::string &NameStr,
1053 BasicBlock *InsertAtEnd) {
1054 return new(1) CallInst(F, NameStr, InsertAtEnd);
1059 virtual CallInst *clone() const;
1061 /// Provide fast operand accessors
1062 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1064 bool isTailCall() const { return SubclassData & 1; }
1065 void setTailCall(bool isTC = true) {
1066 SubclassData = (SubclassData & ~1) | unsigned(isTC);
1069 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1071 unsigned getCallingConv() const { return SubclassData >> 1; }
1072 void setCallingConv(unsigned CC) {
1073 SubclassData = (SubclassData & 1) | (CC << 1);
1076 /// getAttributes - Return the parameter attributes for this call.
1078 const AttrListPtr &getAttributes() const { return AttributeList; }
1080 /// setAttributes - Sets the parameter attributes for this call.
1081 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
1083 /// addAttribute - adds the attribute to the list of attributes.
1084 void addAttribute(unsigned i, Attributes attr);
1086 /// removeAttribute - removes the attribute from the list of attributes.
1087 void removeAttribute(unsigned i, Attributes attr);
1089 /// @brief Determine whether the call or the callee has the given attribute.
1090 bool paramHasAttr(unsigned i, unsigned attr) const;
1092 /// @brief Extract the alignment for a call or parameter (0=unknown).
1093 unsigned getParamAlignment(unsigned i) const {
1094 return AttributeList.getParamAlignment(i);
1097 /// @brief Determine if the call does not access memory.
1098 bool doesNotAccessMemory() const {
1099 return paramHasAttr(0, Attribute::ReadNone);
1101 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1102 if (NotAccessMemory) addAttribute(0, Attribute::ReadNone);
1103 else removeAttribute(0, Attribute::ReadNone);
1106 /// @brief Determine if the call does not access or only reads memory.
1107 bool onlyReadsMemory() const {
1108 return doesNotAccessMemory() || paramHasAttr(0, Attribute::ReadOnly);
1110 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1111 if (OnlyReadsMemory) addAttribute(0, Attribute::ReadOnly);
1112 else removeAttribute(0, Attribute::ReadOnly | Attribute::ReadNone);
1115 /// @brief Determine if the call cannot return.
1116 bool doesNotReturn() const {
1117 return paramHasAttr(0, Attribute::NoReturn);
1119 void setDoesNotReturn(bool DoesNotReturn = true) {
1120 if (DoesNotReturn) addAttribute(0, Attribute::NoReturn);
1121 else removeAttribute(0, Attribute::NoReturn);
1124 /// @brief Determine if the call cannot unwind.
1125 bool doesNotThrow() const {
1126 return paramHasAttr(0, Attribute::NoUnwind);
1128 void setDoesNotThrow(bool DoesNotThrow = true) {
1129 if (DoesNotThrow) addAttribute(0, Attribute::NoUnwind);
1130 else removeAttribute(0, Attribute::NoUnwind);
1133 /// @brief Determine if the call returns a structure through first
1134 /// pointer argument.
1135 bool hasStructRetAttr() const {
1136 // Be friendly and also check the callee.
1137 return paramHasAttr(1, Attribute::StructRet);
1140 /// @brief Determine if any call argument is an aggregate passed by value.
1141 bool hasByValArgument() const {
1142 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1145 /// getCalledFunction - Return the function being called by this instruction
1146 /// if it is a direct call. If it is a call through a function pointer,
1148 Function *getCalledFunction() const {
1149 return dyn_cast<Function>(getOperand(0));
1152 /// getCalledValue - Get a pointer to the function that is invoked by this
1154 const Value *getCalledValue() const { return getOperand(0); }
1155 Value *getCalledValue() { return getOperand(0); }
1157 // Methods for support type inquiry through isa, cast, and dyn_cast:
1158 static inline bool classof(const CallInst *) { return true; }
1159 static inline bool classof(const Instruction *I) {
1160 return I->getOpcode() == Instruction::Call;
1162 static inline bool classof(const Value *V) {
1163 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1168 struct OperandTraits<CallInst> : VariadicOperandTraits<1> {
1171 template<typename InputIterator>
1172 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1173 const std::string &NameStr, BasicBlock *InsertAtEnd)
1174 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1175 ->getElementType())->getReturnType(),
1177 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1178 (unsigned)(ArgEnd - ArgBegin + 1), InsertAtEnd) {
1179 init(Func, ArgBegin, ArgEnd, NameStr,
1180 typename std::iterator_traits<InputIterator>::iterator_category());
1183 template<typename InputIterator>
1184 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1185 const std::string &NameStr, Instruction *InsertBefore)
1186 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1187 ->getElementType())->getReturnType(),
1189 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1190 (unsigned)(ArgEnd - ArgBegin + 1), InsertBefore) {
1191 init(Func, ArgBegin, ArgEnd, NameStr,
1192 typename std::iterator_traits<InputIterator>::iterator_category());
1195 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1197 //===----------------------------------------------------------------------===//
1199 //===----------------------------------------------------------------------===//
1201 /// SelectInst - This class represents the LLVM 'select' instruction.
1203 class SelectInst : public Instruction {
1204 void init(Value *C, Value *S1, Value *S2) {
1210 SelectInst(const SelectInst &SI)
1211 : Instruction(SI.getType(), SI.getOpcode(), &Op<0>(), 3) {
1212 init(SI.Op<0>(), SI.Op<1>(), SI.Op<2>());
1214 SelectInst(Value *C, Value *S1, Value *S2, const std::string &NameStr,
1215 Instruction *InsertBefore)
1216 : Instruction(S1->getType(), Instruction::Select,
1217 &Op<0>(), 3, InsertBefore) {
1221 SelectInst(Value *C, Value *S1, Value *S2, const std::string &NameStr,
1222 BasicBlock *InsertAtEnd)
1223 : Instruction(S1->getType(), Instruction::Select,
1224 &Op<0>(), 3, InsertAtEnd) {
1229 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1230 const std::string &NameStr = "",
1231 Instruction *InsertBefore = 0) {
1232 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1234 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1235 const std::string &NameStr,
1236 BasicBlock *InsertAtEnd) {
1237 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1240 Value *getCondition() const { return Op<0>(); }
1241 Value *getTrueValue() const { return Op<1>(); }
1242 Value *getFalseValue() const { return Op<2>(); }
1244 /// Transparently provide more efficient getOperand methods.
1245 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1247 OtherOps getOpcode() const {
1248 return static_cast<OtherOps>(Instruction::getOpcode());
1251 virtual SelectInst *clone() const;
1253 // Methods for support type inquiry through isa, cast, and dyn_cast:
1254 static inline bool classof(const SelectInst *) { return true; }
1255 static inline bool classof(const Instruction *I) {
1256 return I->getOpcode() == Instruction::Select;
1258 static inline bool classof(const Value *V) {
1259 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1264 struct OperandTraits<SelectInst> : FixedNumOperandTraits<3> {
1267 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1269 //===----------------------------------------------------------------------===//
1271 //===----------------------------------------------------------------------===//
1273 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1274 /// an argument of the specified type given a va_list and increments that list
1276 class VAArgInst : public UnaryInstruction {
1277 VAArgInst(const VAArgInst &VAA)
1278 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
1280 VAArgInst(Value *List, const Type *Ty, const std::string &NameStr = "",
1281 Instruction *InsertBefore = 0)
1282 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1285 VAArgInst(Value *List, const Type *Ty, const std::string &NameStr,
1286 BasicBlock *InsertAtEnd)
1287 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1291 virtual VAArgInst *clone() const;
1293 // Methods for support type inquiry through isa, cast, and dyn_cast:
1294 static inline bool classof(const VAArgInst *) { return true; }
1295 static inline bool classof(const Instruction *I) {
1296 return I->getOpcode() == VAArg;
1298 static inline bool classof(const Value *V) {
1299 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1303 //===----------------------------------------------------------------------===//
1304 // ExtractElementInst Class
1305 //===----------------------------------------------------------------------===//
1307 /// ExtractElementInst - This instruction extracts a single (scalar)
1308 /// element from a VectorType value
1310 class ExtractElementInst : public Instruction {
1311 ExtractElementInst(const ExtractElementInst &EE) :
1312 Instruction(EE.getType(), ExtractElement, &Op<0>(), 2) {
1313 Op<0>() = EE.Op<0>();
1314 Op<1>() = EE.Op<1>();
1318 // allocate space for exactly two operands
1319 void *operator new(size_t s) {
1320 return User::operator new(s, 2); // FIXME: "unsigned Idx" forms of ctor?
1322 ExtractElementInst(Value *Vec, Value *Idx, const std::string &NameStr = "",
1323 Instruction *InsertBefore = 0);
1324 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &NameStr = "",
1325 Instruction *InsertBefore = 0);
1326 ExtractElementInst(Value *Vec, Value *Idx, const std::string &NameStr,
1327 BasicBlock *InsertAtEnd);
1328 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &NameStr,
1329 BasicBlock *InsertAtEnd);
1331 /// isValidOperands - Return true if an extractelement instruction can be
1332 /// formed with the specified operands.
1333 static bool isValidOperands(const Value *Vec, const Value *Idx);
1335 virtual ExtractElementInst *clone() const;
1337 /// Transparently provide more efficient getOperand methods.
1338 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1340 // Methods for support type inquiry through isa, cast, and dyn_cast:
1341 static inline bool classof(const ExtractElementInst *) { return true; }
1342 static inline bool classof(const Instruction *I) {
1343 return I->getOpcode() == Instruction::ExtractElement;
1345 static inline bool classof(const Value *V) {
1346 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1351 struct OperandTraits<ExtractElementInst> : FixedNumOperandTraits<2> {
1354 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1356 //===----------------------------------------------------------------------===//
1357 // InsertElementInst Class
1358 //===----------------------------------------------------------------------===//
1360 /// InsertElementInst - This instruction inserts a single (scalar)
1361 /// element into a VectorType value
1363 class InsertElementInst : public Instruction {
1364 InsertElementInst(const InsertElementInst &IE);
1365 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1366 const std::string &NameStr = "",Instruction *InsertBefore = 0);
1367 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1368 const std::string &NameStr = "",Instruction *InsertBefore = 0);
1369 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1370 const std::string &NameStr, BasicBlock *InsertAtEnd);
1371 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1372 const std::string &NameStr, BasicBlock *InsertAtEnd);
1374 static InsertElementInst *Create(const InsertElementInst &IE) {
1375 return new(IE.getNumOperands()) InsertElementInst(IE);
1377 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1378 const std::string &NameStr = "",
1379 Instruction *InsertBefore = 0) {
1380 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1382 static InsertElementInst *Create(Value *Vec, Value *NewElt, unsigned Idx,
1383 const std::string &NameStr = "",
1384 Instruction *InsertBefore = 0) {
1385 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1387 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1388 const std::string &NameStr,
1389 BasicBlock *InsertAtEnd) {
1390 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1392 static InsertElementInst *Create(Value *Vec, Value *NewElt, unsigned Idx,
1393 const std::string &NameStr,
1394 BasicBlock *InsertAtEnd) {
1395 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1398 /// isValidOperands - Return true if an insertelement instruction can be
1399 /// formed with the specified operands.
1400 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1403 virtual InsertElementInst *clone() const;
1405 /// getType - Overload to return most specific vector type.
1407 const VectorType *getType() const {
1408 return reinterpret_cast<const VectorType*>(Instruction::getType());
1411 /// Transparently provide more efficient getOperand methods.
1412 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1414 // Methods for support type inquiry through isa, cast, and dyn_cast:
1415 static inline bool classof(const InsertElementInst *) { return true; }
1416 static inline bool classof(const Instruction *I) {
1417 return I->getOpcode() == Instruction::InsertElement;
1419 static inline bool classof(const Value *V) {
1420 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1425 struct OperandTraits<InsertElementInst> : FixedNumOperandTraits<3> {
1428 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1430 //===----------------------------------------------------------------------===//
1431 // ShuffleVectorInst Class
1432 //===----------------------------------------------------------------------===//
1434 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1437 class ShuffleVectorInst : public Instruction {
1438 ShuffleVectorInst(const ShuffleVectorInst &IE);
1440 // allocate space for exactly three operands
1441 void *operator new(size_t s) {
1442 return User::operator new(s, 3);
1444 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1445 const std::string &NameStr = "",
1446 Instruction *InsertBefor = 0);
1447 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1448 const std::string &NameStr, BasicBlock *InsertAtEnd);
1450 /// isValidOperands - Return true if a shufflevector instruction can be
1451 /// formed with the specified operands.
1452 static bool isValidOperands(const Value *V1, const Value *V2,
1455 virtual ShuffleVectorInst *clone() const;
1457 /// getType - Overload to return most specific vector type.
1459 const VectorType *getType() const {
1460 return reinterpret_cast<const VectorType*>(Instruction::getType());
1463 /// Transparently provide more efficient getOperand methods.
1464 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1466 /// getMaskValue - Return the index from the shuffle mask for the specified
1467 /// output result. This is either -1 if the element is undef or a number less
1468 /// than 2*numelements.
1469 int getMaskValue(unsigned i) const;
1471 // Methods for support type inquiry through isa, cast, and dyn_cast:
1472 static inline bool classof(const ShuffleVectorInst *) { return true; }
1473 static inline bool classof(const Instruction *I) {
1474 return I->getOpcode() == Instruction::ShuffleVector;
1476 static inline bool classof(const Value *V) {
1477 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1482 struct OperandTraits<ShuffleVectorInst> : FixedNumOperandTraits<3> {
1485 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1487 //===----------------------------------------------------------------------===//
1488 // ExtractValueInst Class
1489 //===----------------------------------------------------------------------===//
1491 /// ExtractValueInst - This instruction extracts a struct member or array
1492 /// element value from an aggregate value.
1494 class ExtractValueInst : public UnaryInstruction {
1495 SmallVector<unsigned, 4> Indices;
1497 ExtractValueInst(const ExtractValueInst &EVI);
1498 void init(const unsigned *Idx, unsigned NumIdx,
1499 const std::string &NameStr);
1500 void init(unsigned Idx, const std::string &NameStr);
1502 template<typename InputIterator>
1503 void init(InputIterator IdxBegin, InputIterator IdxEnd,
1504 const std::string &NameStr,
1505 // This argument ensures that we have an iterator we can
1506 // do arithmetic on in constant time
1507 std::random_access_iterator_tag) {
1508 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1510 // There's no fundamental reason why we require at least one index
1511 // (other than weirdness with &*IdxBegin being invalid; see
1512 // getelementptr's init routine for example). But there's no
1513 // present need to support it.
1514 assert(NumIdx > 0 && "ExtractValueInst must have at least one index");
1516 // This requires that the iterator points to contiguous memory.
1517 init(&*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1518 // we have to build an array here
1521 /// getIndexedType - Returns the type of the element that would be extracted
1522 /// with an extractvalue instruction with the specified parameters.
1524 /// Null is returned if the indices are invalid for the specified
1527 static const Type *getIndexedType(const Type *Agg,
1528 const unsigned *Idx, unsigned NumIdx);
1530 template<typename InputIterator>
1531 static const Type *getIndexedType(const Type *Ptr,
1532 InputIterator IdxBegin,
1533 InputIterator IdxEnd,
1534 // This argument ensures that we
1535 // have an iterator we can do
1536 // arithmetic on in constant time
1537 std::random_access_iterator_tag) {
1538 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1541 // This requires that the iterator points to contiguous memory.
1542 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
1544 return getIndexedType(Ptr, (const unsigned *)0, NumIdx);
1547 /// Constructors - Create a extractvalue instruction with a base aggregate
1548 /// value and a list of indices. The first ctor can optionally insert before
1549 /// an existing instruction, the second appends the new instruction to the
1550 /// specified BasicBlock.
1551 template<typename InputIterator>
1552 inline ExtractValueInst(Value *Agg, InputIterator IdxBegin,
1553 InputIterator IdxEnd,
1554 const std::string &NameStr,
1555 Instruction *InsertBefore);
1556 template<typename InputIterator>
1557 inline ExtractValueInst(Value *Agg,
1558 InputIterator IdxBegin, InputIterator IdxEnd,
1559 const std::string &NameStr, BasicBlock *InsertAtEnd);
1561 // allocate space for exactly one operand
1562 void *operator new(size_t s) {
1563 return User::operator new(s, 1);
1567 template<typename InputIterator>
1568 static ExtractValueInst *Create(Value *Agg, InputIterator IdxBegin,
1569 InputIterator IdxEnd,
1570 const std::string &NameStr = "",
1571 Instruction *InsertBefore = 0) {
1573 ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertBefore);
1575 template<typename InputIterator>
1576 static ExtractValueInst *Create(Value *Agg,
1577 InputIterator IdxBegin, InputIterator IdxEnd,
1578 const std::string &NameStr,
1579 BasicBlock *InsertAtEnd) {
1580 return new ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertAtEnd);
1583 /// Constructors - These two creators are convenience methods because one
1584 /// index extractvalue instructions are much more common than those with
1586 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1587 const std::string &NameStr = "",
1588 Instruction *InsertBefore = 0) {
1589 unsigned Idxs[1] = { Idx };
1590 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertBefore);
1592 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1593 const std::string &NameStr,
1594 BasicBlock *InsertAtEnd) {
1595 unsigned Idxs[1] = { Idx };
1596 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertAtEnd);
1599 virtual ExtractValueInst *clone() const;
1601 // getType - Overload to return most specific pointer type...
1602 const PointerType *getType() const {
1603 return reinterpret_cast<const PointerType*>(Instruction::getType());
1606 /// getIndexedType - Returns the type of the element that would be extracted
1607 /// with an extractvalue instruction with the specified parameters.
1609 /// Null is returned if the indices are invalid for the specified
1612 template<typename InputIterator>
1613 static const Type *getIndexedType(const Type *Ptr,
1614 InputIterator IdxBegin,
1615 InputIterator IdxEnd) {
1616 return getIndexedType(Ptr, IdxBegin, IdxEnd,
1617 typename std::iterator_traits<InputIterator>::
1618 iterator_category());
1620 static const Type *getIndexedType(const Type *Ptr, unsigned Idx);
1622 typedef const unsigned* idx_iterator;
1623 inline idx_iterator idx_begin() const { return Indices.begin(); }
1624 inline idx_iterator idx_end() const { return Indices.end(); }
1626 Value *getAggregateOperand() {
1627 return getOperand(0);
1629 const Value *getAggregateOperand() const {
1630 return getOperand(0);
1632 static unsigned getAggregateOperandIndex() {
1633 return 0U; // get index for modifying correct operand
1636 unsigned getNumIndices() const { // Note: always non-negative
1637 return (unsigned)Indices.size();
1640 bool hasIndices() const {
1644 // Methods for support type inquiry through isa, cast, and dyn_cast:
1645 static inline bool classof(const ExtractValueInst *) { return true; }
1646 static inline bool classof(const Instruction *I) {
1647 return I->getOpcode() == Instruction::ExtractValue;
1649 static inline bool classof(const Value *V) {
1650 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1654 template<typename InputIterator>
1655 ExtractValueInst::ExtractValueInst(Value *Agg,
1656 InputIterator IdxBegin,
1657 InputIterator IdxEnd,
1658 const std::string &NameStr,
1659 Instruction *InsertBefore)
1660 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1662 ExtractValue, Agg, InsertBefore) {
1663 init(IdxBegin, IdxEnd, NameStr,
1664 typename std::iterator_traits<InputIterator>::iterator_category());
1666 template<typename InputIterator>
1667 ExtractValueInst::ExtractValueInst(Value *Agg,
1668 InputIterator IdxBegin,
1669 InputIterator IdxEnd,
1670 const std::string &NameStr,
1671 BasicBlock *InsertAtEnd)
1672 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1674 ExtractValue, Agg, InsertAtEnd) {
1675 init(IdxBegin, IdxEnd, NameStr,
1676 typename std::iterator_traits<InputIterator>::iterator_category());
1680 //===----------------------------------------------------------------------===//
1681 // InsertValueInst Class
1682 //===----------------------------------------------------------------------===//
1684 /// InsertValueInst - This instruction inserts a struct field of array element
1685 /// value into an aggregate value.
1687 class InsertValueInst : public Instruction {
1688 SmallVector<unsigned, 4> Indices;
1690 void *operator new(size_t, unsigned); // Do not implement
1691 InsertValueInst(const InsertValueInst &IVI);
1692 void init(Value *Agg, Value *Val, const unsigned *Idx, unsigned NumIdx,
1693 const std::string &NameStr);
1694 void init(Value *Agg, Value *Val, unsigned Idx, const std::string &NameStr);
1696 template<typename InputIterator>
1697 void init(Value *Agg, Value *Val,
1698 InputIterator IdxBegin, InputIterator IdxEnd,
1699 const std::string &NameStr,
1700 // This argument ensures that we have an iterator we can
1701 // do arithmetic on in constant time
1702 std::random_access_iterator_tag) {
1703 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1705 // There's no fundamental reason why we require at least one index
1706 // (other than weirdness with &*IdxBegin being invalid; see
1707 // getelementptr's init routine for example). But there's no
1708 // present need to support it.
1709 assert(NumIdx > 0 && "InsertValueInst must have at least one index");
1711 // This requires that the iterator points to contiguous memory.
1712 init(Agg, Val, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1713 // we have to build an array here
1716 /// Constructors - Create a insertvalue instruction with a base aggregate
1717 /// value, a value to insert, and a list of indices. The first ctor can
1718 /// optionally insert before an existing instruction, the second appends
1719 /// the new instruction to the specified BasicBlock.
1720 template<typename InputIterator>
1721 inline InsertValueInst(Value *Agg, Value *Val, InputIterator IdxBegin,
1722 InputIterator IdxEnd,
1723 const std::string &NameStr,
1724 Instruction *InsertBefore);
1725 template<typename InputIterator>
1726 inline InsertValueInst(Value *Agg, Value *Val,
1727 InputIterator IdxBegin, InputIterator IdxEnd,
1728 const std::string &NameStr, BasicBlock *InsertAtEnd);
1730 /// Constructors - These two constructors are convenience methods because one
1731 /// and two index insertvalue instructions are so common.
1732 InsertValueInst(Value *Agg, Value *Val,
1733 unsigned Idx, const std::string &NameStr = "",
1734 Instruction *InsertBefore = 0);
1735 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1736 const std::string &NameStr, BasicBlock *InsertAtEnd);
1738 // allocate space for exactly two operands
1739 void *operator new(size_t s) {
1740 return User::operator new(s, 2);
1743 template<typename InputIterator>
1744 static InsertValueInst *Create(Value *Agg, Value *Val, InputIterator IdxBegin,
1745 InputIterator IdxEnd,
1746 const std::string &NameStr = "",
1747 Instruction *InsertBefore = 0) {
1748 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1749 NameStr, InsertBefore);
1751 template<typename InputIterator>
1752 static InsertValueInst *Create(Value *Agg, Value *Val,
1753 InputIterator IdxBegin, InputIterator IdxEnd,
1754 const std::string &NameStr,
1755 BasicBlock *InsertAtEnd) {
1756 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1757 NameStr, InsertAtEnd);
1760 /// Constructors - These two creators are convenience methods because one
1761 /// index insertvalue instructions are much more common than those with
1763 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1764 const std::string &NameStr = "",
1765 Instruction *InsertBefore = 0) {
1766 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertBefore);
1768 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1769 const std::string &NameStr,
1770 BasicBlock *InsertAtEnd) {
1771 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertAtEnd);
1774 virtual InsertValueInst *clone() const;
1776 /// Transparently provide more efficient getOperand methods.
1777 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1779 // getType - Overload to return most specific pointer type...
1780 const PointerType *getType() const {
1781 return reinterpret_cast<const PointerType*>(Instruction::getType());
1784 typedef const unsigned* idx_iterator;
1785 inline idx_iterator idx_begin() const { return Indices.begin(); }
1786 inline idx_iterator idx_end() const { return Indices.end(); }
1788 Value *getAggregateOperand() {
1789 return getOperand(0);
1791 const Value *getAggregateOperand() const {
1792 return getOperand(0);
1794 static unsigned getAggregateOperandIndex() {
1795 return 0U; // get index for modifying correct operand
1798 Value *getInsertedValueOperand() {
1799 return getOperand(1);
1801 const Value *getInsertedValueOperand() const {
1802 return getOperand(1);
1804 static unsigned getInsertedValueOperandIndex() {
1805 return 1U; // get index for modifying correct operand
1808 unsigned getNumIndices() const { // Note: always non-negative
1809 return (unsigned)Indices.size();
1812 bool hasIndices() const {
1816 // Methods for support type inquiry through isa, cast, and dyn_cast:
1817 static inline bool classof(const InsertValueInst *) { return true; }
1818 static inline bool classof(const Instruction *I) {
1819 return I->getOpcode() == Instruction::InsertValue;
1821 static inline bool classof(const Value *V) {
1822 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1827 struct OperandTraits<InsertValueInst> : FixedNumOperandTraits<2> {
1830 template<typename InputIterator>
1831 InsertValueInst::InsertValueInst(Value *Agg,
1833 InputIterator IdxBegin,
1834 InputIterator IdxEnd,
1835 const std::string &NameStr,
1836 Instruction *InsertBefore)
1837 : Instruction(Agg->getType(), InsertValue,
1838 OperandTraits<InsertValueInst>::op_begin(this),
1840 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1841 typename std::iterator_traits<InputIterator>::iterator_category());
1843 template<typename InputIterator>
1844 InsertValueInst::InsertValueInst(Value *Agg,
1846 InputIterator IdxBegin,
1847 InputIterator IdxEnd,
1848 const std::string &NameStr,
1849 BasicBlock *InsertAtEnd)
1850 : Instruction(Agg->getType(), InsertValue,
1851 OperandTraits<InsertValueInst>::op_begin(this),
1853 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1854 typename std::iterator_traits<InputIterator>::iterator_category());
1857 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1859 //===----------------------------------------------------------------------===//
1861 //===----------------------------------------------------------------------===//
1863 // PHINode - The PHINode class is used to represent the magical mystical PHI
1864 // node, that can not exist in nature, but can be synthesized in a computer
1865 // scientist's overactive imagination.
1867 class PHINode : public Instruction {
1868 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1869 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1870 /// the number actually in use.
1871 unsigned ReservedSpace;
1872 PHINode(const PHINode &PN);
1873 // allocate space for exactly zero operands
1874 void *operator new(size_t s) {
1875 return User::operator new(s, 0);
1877 explicit PHINode(const Type *Ty, const std::string &NameStr = "",
1878 Instruction *InsertBefore = 0)
1879 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1884 PHINode(const Type *Ty, const std::string &NameStr, BasicBlock *InsertAtEnd)
1885 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1890 static PHINode *Create(const Type *Ty, const std::string &NameStr = "",
1891 Instruction *InsertBefore = 0) {
1892 return new PHINode(Ty, NameStr, InsertBefore);
1894 static PHINode *Create(const Type *Ty, const std::string &NameStr,
1895 BasicBlock *InsertAtEnd) {
1896 return new PHINode(Ty, NameStr, InsertAtEnd);
1900 /// reserveOperandSpace - This method can be used to avoid repeated
1901 /// reallocation of PHI operand lists by reserving space for the correct
1902 /// number of operands before adding them. Unlike normal vector reserves,
1903 /// this method can also be used to trim the operand space.
1904 void reserveOperandSpace(unsigned NumValues) {
1905 resizeOperands(NumValues*2);
1908 virtual PHINode *clone() const;
1910 /// Provide fast operand accessors
1911 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1913 /// getNumIncomingValues - Return the number of incoming edges
1915 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1917 /// getIncomingValue - Return incoming value number x
1919 Value *getIncomingValue(unsigned i) const {
1920 assert(i*2 < getNumOperands() && "Invalid value number!");
1921 return getOperand(i*2);
1923 void setIncomingValue(unsigned i, Value *V) {
1924 assert(i*2 < getNumOperands() && "Invalid value number!");
1927 unsigned getOperandNumForIncomingValue(unsigned i) {
1931 /// getIncomingBlock - Return incoming basic block number x
1933 BasicBlock *getIncomingBlock(unsigned i) const {
1934 return static_cast<BasicBlock*>(getOperand(i*2+1));
1936 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1937 setOperand(i*2+1, BB);
1939 unsigned getOperandNumForIncomingBlock(unsigned i) {
1943 /// addIncoming - Add an incoming value to the end of the PHI list
1945 void addIncoming(Value *V, BasicBlock *BB) {
1946 assert(V && "PHI node got a null value!");
1947 assert(BB && "PHI node got a null basic block!");
1948 assert(getType() == V->getType() &&
1949 "All operands to PHI node must be the same type as the PHI node!");
1950 unsigned OpNo = NumOperands;
1951 if (OpNo+2 > ReservedSpace)
1952 resizeOperands(0); // Get more space!
1953 // Initialize some new operands.
1954 NumOperands = OpNo+2;
1955 OperandList[OpNo] = V;
1956 OperandList[OpNo+1] = BB;
1959 /// removeIncomingValue - Remove an incoming value. This is useful if a
1960 /// predecessor basic block is deleted. The value removed is returned.
1962 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1963 /// is true), the PHI node is destroyed and any uses of it are replaced with
1964 /// dummy values. The only time there should be zero incoming values to a PHI
1965 /// node is when the block is dead, so this strategy is sound.
1967 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1969 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
1970 int Idx = getBasicBlockIndex(BB);
1971 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1972 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1975 /// getBasicBlockIndex - Return the first index of the specified basic
1976 /// block in the value list for this PHI. Returns -1 if no instance.
1978 int getBasicBlockIndex(const BasicBlock *BB) const {
1979 Use *OL = OperandList;
1980 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1981 if (OL[i+1].get() == BB) return i/2;
1985 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1986 return getIncomingValue(getBasicBlockIndex(BB));
1989 /// hasConstantValue - If the specified PHI node always merges together the
1990 /// same value, return the value, otherwise return null.
1992 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1994 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1995 static inline bool classof(const PHINode *) { return true; }
1996 static inline bool classof(const Instruction *I) {
1997 return I->getOpcode() == Instruction::PHI;
1999 static inline bool classof(const Value *V) {
2000 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2003 void resizeOperands(unsigned NumOperands);
2007 struct OperandTraits<PHINode> : HungoffOperandTraits<2> {
2010 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2013 //===----------------------------------------------------------------------===//
2015 //===----------------------------------------------------------------------===//
2017 //===---------------------------------------------------------------------------
2018 /// ReturnInst - Return a value (possibly void), from a function. Execution
2019 /// does not continue in this function any longer.
2021 class ReturnInst : public TerminatorInst {
2022 ReturnInst(const ReturnInst &RI);
2025 // ReturnInst constructors:
2026 // ReturnInst() - 'ret void' instruction
2027 // ReturnInst( null) - 'ret void' instruction
2028 // ReturnInst(Value* X) - 'ret X' instruction
2029 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2030 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2031 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2032 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2034 // NOTE: If the Value* passed is of type void then the constructor behaves as
2035 // if it was passed NULL.
2036 explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0);
2037 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd);
2038 explicit ReturnInst(BasicBlock *InsertAtEnd);
2040 static ReturnInst* Create(Value *retVal = 0, Instruction *InsertBefore = 0) {
2041 return new(!!retVal) ReturnInst(retVal, InsertBefore);
2043 static ReturnInst* Create(Value *retVal, BasicBlock *InsertAtEnd) {
2044 return new(!!retVal) ReturnInst(retVal, InsertAtEnd);
2046 static ReturnInst* Create(BasicBlock *InsertAtEnd) {
2047 return new(0) ReturnInst(InsertAtEnd);
2049 virtual ~ReturnInst();
2051 virtual ReturnInst *clone() const;
2053 /// Provide fast operand accessors
2054 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2056 /// Convenience accessor
2057 Value *getReturnValue(unsigned n = 0) const {
2058 return n < getNumOperands()
2063 unsigned getNumSuccessors() const { return 0; }
2065 // Methods for support type inquiry through isa, cast, and dyn_cast:
2066 static inline bool classof(const ReturnInst *) { return true; }
2067 static inline bool classof(const Instruction *I) {
2068 return (I->getOpcode() == Instruction::Ret);
2070 static inline bool classof(const Value *V) {
2071 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2074 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2075 virtual unsigned getNumSuccessorsV() const;
2076 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2080 struct OperandTraits<ReturnInst> : OptionalOperandTraits<> {
2083 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2085 //===----------------------------------------------------------------------===//
2087 //===----------------------------------------------------------------------===//
2089 //===---------------------------------------------------------------------------
2090 /// BranchInst - Conditional or Unconditional Branch instruction.
2092 class BranchInst : public TerminatorInst {
2093 /// Ops list - Branches are strange. The operands are ordered:
2094 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
2095 /// they don't have to check for cond/uncond branchness.
2096 BranchInst(const BranchInst &BI);
2098 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2099 // BranchInst(BB *B) - 'br B'
2100 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2101 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2102 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2103 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2104 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2105 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2106 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2107 Instruction *InsertBefore = 0);
2108 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2109 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2110 BasicBlock *InsertAtEnd);
2112 static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2113 return new(1) BranchInst(IfTrue, InsertBefore);
2115 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2116 Value *Cond, Instruction *InsertBefore = 0) {
2117 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2119 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2120 return new(1) BranchInst(IfTrue, InsertAtEnd);
2122 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2123 Value *Cond, BasicBlock *InsertAtEnd) {
2124 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2128 if (NumOperands == 1)
2129 NumOperands = (unsigned)((Use*)this - OperandList);
2132 /// Transparently provide more efficient getOperand methods.
2133 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2135 virtual BranchInst *clone() const;
2137 bool isUnconditional() const { return getNumOperands() == 1; }
2138 bool isConditional() const { return getNumOperands() == 3; }
2140 Value *getCondition() const {
2141 assert(isConditional() && "Cannot get condition of an uncond branch!");
2142 return getOperand(2);
2145 void setCondition(Value *V) {
2146 assert(isConditional() && "Cannot set condition of unconditional branch!");
2150 // setUnconditionalDest - Change the current branch to an unconditional branch
2151 // targeting the specified block.
2152 // FIXME: Eliminate this ugly method.
2153 void setUnconditionalDest(BasicBlock *Dest) {
2155 if (isConditional()) { // Convert this to an uncond branch.
2162 unsigned getNumSuccessors() const { return 1+isConditional(); }
2164 BasicBlock *getSuccessor(unsigned i) const {
2165 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2166 return cast<BasicBlock>(getOperand(i));
2169 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2170 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2171 setOperand(idx, NewSucc);
2174 // Methods for support type inquiry through isa, cast, and dyn_cast:
2175 static inline bool classof(const BranchInst *) { return true; }
2176 static inline bool classof(const Instruction *I) {
2177 return (I->getOpcode() == Instruction::Br);
2179 static inline bool classof(const Value *V) {
2180 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2183 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2184 virtual unsigned getNumSuccessorsV() const;
2185 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2189 struct OperandTraits<BranchInst> : HungoffOperandTraits<> {
2190 // we need to access operands via OperandList, since
2191 // the NumOperands may change from 3 to 1
2192 static inline void *allocate(unsigned); // FIXME
2195 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2197 //===----------------------------------------------------------------------===//
2199 //===----------------------------------------------------------------------===//
2201 //===---------------------------------------------------------------------------
2202 /// SwitchInst - Multiway switch
2204 class SwitchInst : public TerminatorInst {
2205 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2206 unsigned ReservedSpace;
2207 // Operand[0] = Value to switch on
2208 // Operand[1] = Default basic block destination
2209 // Operand[2n ] = Value to match
2210 // Operand[2n+1] = BasicBlock to go to on match
2211 SwitchInst(const SwitchInst &RI);
2212 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
2213 void resizeOperands(unsigned No);
2214 // allocate space for exactly zero operands
2215 void *operator new(size_t s) {
2216 return User::operator new(s, 0);
2218 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2219 /// switch on and a default destination. The number of additional cases can
2220 /// be specified here to make memory allocation more efficient. This
2221 /// constructor can also autoinsert before another instruction.
2222 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2223 Instruction *InsertBefore = 0);
2225 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2226 /// switch on and a default destination. The number of additional cases can
2227 /// be specified here to make memory allocation more efficient. This
2228 /// constructor also autoinserts at the end of the specified BasicBlock.
2229 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2230 BasicBlock *InsertAtEnd);
2232 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2233 unsigned NumCases, Instruction *InsertBefore = 0) {
2234 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2236 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2237 unsigned NumCases, BasicBlock *InsertAtEnd) {
2238 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2242 /// Provide fast operand accessors
2243 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2245 // Accessor Methods for Switch stmt
2246 Value *getCondition() const { return getOperand(0); }
2247 void setCondition(Value *V) { setOperand(0, V); }
2249 BasicBlock *getDefaultDest() const {
2250 return cast<BasicBlock>(getOperand(1));
2253 /// getNumCases - return the number of 'cases' in this switch instruction.
2254 /// Note that case #0 is always the default case.
2255 unsigned getNumCases() const {
2256 return getNumOperands()/2;
2259 /// getCaseValue - Return the specified case value. Note that case #0, the
2260 /// default destination, does not have a case value.
2261 ConstantInt *getCaseValue(unsigned i) {
2262 assert(i && i < getNumCases() && "Illegal case value to get!");
2263 return getSuccessorValue(i);
2266 /// getCaseValue - Return the specified case value. Note that case #0, the
2267 /// default destination, does not have a case value.
2268 const ConstantInt *getCaseValue(unsigned i) const {
2269 assert(i && i < getNumCases() && "Illegal case value to get!");
2270 return getSuccessorValue(i);
2273 /// findCaseValue - Search all of the case values for the specified constant.
2274 /// If it is explicitly handled, return the case number of it, otherwise
2275 /// return 0 to indicate that it is handled by the default handler.
2276 unsigned findCaseValue(const ConstantInt *C) const {
2277 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
2278 if (getCaseValue(i) == C)
2283 /// findCaseDest - Finds the unique case value for a given successor. Returns
2284 /// null if the successor is not found, not unique, or is the default case.
2285 ConstantInt *findCaseDest(BasicBlock *BB) {
2286 if (BB == getDefaultDest()) return NULL;
2288 ConstantInt *CI = NULL;
2289 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
2290 if (getSuccessor(i) == BB) {
2291 if (CI) return NULL; // Multiple cases lead to BB.
2292 else CI = getCaseValue(i);
2298 /// addCase - Add an entry to the switch instruction...
2300 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2302 /// removeCase - This method removes the specified successor from the switch
2303 /// instruction. Note that this cannot be used to remove the default
2304 /// destination (successor #0).
2306 void removeCase(unsigned idx);
2308 virtual SwitchInst *clone() const;
2310 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2311 BasicBlock *getSuccessor(unsigned idx) const {
2312 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2313 return cast<BasicBlock>(getOperand(idx*2+1));
2315 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2316 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2317 setOperand(idx*2+1, NewSucc);
2320 // getSuccessorValue - Return the value associated with the specified
2322 ConstantInt *getSuccessorValue(unsigned idx) const {
2323 assert(idx < getNumSuccessors() && "Successor # out of range!");
2324 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
2327 // Methods for support type inquiry through isa, cast, and dyn_cast:
2328 static inline bool classof(const SwitchInst *) { return true; }
2329 static inline bool classof(const Instruction *I) {
2330 return I->getOpcode() == Instruction::Switch;
2332 static inline bool classof(const Value *V) {
2333 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2336 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2337 virtual unsigned getNumSuccessorsV() const;
2338 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2342 struct OperandTraits<SwitchInst> : HungoffOperandTraits<2> {
2345 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2348 //===----------------------------------------------------------------------===//
2350 //===----------------------------------------------------------------------===//
2352 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
2353 /// calling convention of the call.
2355 class InvokeInst : public TerminatorInst {
2356 AttrListPtr AttributeList;
2357 InvokeInst(const InvokeInst &BI);
2358 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
2359 Value* const *Args, unsigned NumArgs);
2361 template<typename InputIterator>
2362 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2363 InputIterator ArgBegin, InputIterator ArgEnd,
2364 const std::string &NameStr,
2365 // This argument ensures that we have an iterator we can
2366 // do arithmetic on in constant time
2367 std::random_access_iterator_tag) {
2368 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
2370 // This requires that the iterator points to contiguous memory.
2371 init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
2375 /// Construct an InvokeInst given a range of arguments.
2376 /// InputIterator must be a random-access iterator pointing to
2377 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2378 /// made for random-accessness but not for contiguous storage as
2379 /// that would incur runtime overhead.
2381 /// @brief Construct an InvokeInst from a range of arguments
2382 template<typename InputIterator>
2383 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2384 InputIterator ArgBegin, InputIterator ArgEnd,
2386 const std::string &NameStr, Instruction *InsertBefore);
2388 /// Construct an InvokeInst given a range of arguments.
2389 /// InputIterator must be a random-access iterator pointing to
2390 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2391 /// made for random-accessness but not for contiguous storage as
2392 /// that would incur runtime overhead.
2394 /// @brief Construct an InvokeInst from a range of arguments
2395 template<typename InputIterator>
2396 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2397 InputIterator ArgBegin, InputIterator ArgEnd,
2399 const std::string &NameStr, BasicBlock *InsertAtEnd);
2401 template<typename InputIterator>
2402 static InvokeInst *Create(Value *Func,
2403 BasicBlock *IfNormal, BasicBlock *IfException,
2404 InputIterator ArgBegin, InputIterator ArgEnd,
2405 const std::string &NameStr = "",
2406 Instruction *InsertBefore = 0) {
2407 unsigned Values(ArgEnd - ArgBegin + 3);
2408 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2409 Values, NameStr, InsertBefore);
2411 template<typename InputIterator>
2412 static InvokeInst *Create(Value *Func,
2413 BasicBlock *IfNormal, BasicBlock *IfException,
2414 InputIterator ArgBegin, InputIterator ArgEnd,
2415 const std::string &NameStr,
2416 BasicBlock *InsertAtEnd) {
2417 unsigned Values(ArgEnd - ArgBegin + 3);
2418 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2419 Values, NameStr, InsertAtEnd);
2422 virtual InvokeInst *clone() const;
2424 /// Provide fast operand accessors
2425 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2427 /// getCallingConv/setCallingConv - Get or set the calling convention of this
2429 unsigned getCallingConv() const { return SubclassData; }
2430 void setCallingConv(unsigned CC) {
2434 /// getAttributes - Return the parameter attributes for this invoke.
2436 const AttrListPtr &getAttributes() const { return AttributeList; }
2438 /// setAttributes - Set the parameter attributes for this invoke.
2440 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
2442 /// @brief Determine whether the call or the callee has the given attribute.
2443 bool paramHasAttr(unsigned i, Attributes attr) const;
2445 /// addAttribute - adds the attribute to the list of attributes.
2446 void addAttribute(unsigned i, Attributes attr);
2448 /// removeAttribute - removes the attribute from the list of attributes.
2449 void removeAttribute(unsigned i, Attributes attr);
2451 /// @brief Extract the alignment for a call or parameter (0=unknown).
2452 unsigned getParamAlignment(unsigned i) const {
2453 return AttributeList.getParamAlignment(i);
2456 /// @brief Determine if the call does not access memory.
2457 bool doesNotAccessMemory() const {
2458 return paramHasAttr(0, Attribute::ReadNone);
2460 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
2461 if (NotAccessMemory) addAttribute(0, Attribute::ReadNone);
2462 else removeAttribute(0, Attribute::ReadNone);
2465 /// @brief Determine if the call does not access or only reads memory.
2466 bool onlyReadsMemory() const {
2467 return doesNotAccessMemory() || paramHasAttr(0, Attribute::ReadOnly);
2469 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
2470 if (OnlyReadsMemory) addAttribute(0, Attribute::ReadOnly);
2471 else removeAttribute(0, Attribute::ReadOnly | Attribute::ReadNone);
2474 /// @brief Determine if the call cannot return.
2475 bool doesNotReturn() const {
2476 return paramHasAttr(0, Attribute::NoReturn);
2478 void setDoesNotReturn(bool DoesNotReturn = true) {
2479 if (DoesNotReturn) addAttribute(0, Attribute::NoReturn);
2480 else removeAttribute(0, Attribute::NoReturn);
2483 /// @brief Determine if the call cannot unwind.
2484 bool doesNotThrow() const {
2485 return paramHasAttr(0, Attribute::NoUnwind);
2487 void setDoesNotThrow(bool DoesNotThrow = true) {
2488 if (DoesNotThrow) addAttribute(0, Attribute::NoUnwind);
2489 else removeAttribute(0, Attribute::NoUnwind);
2492 /// @brief Determine if the call returns a structure through first
2493 /// pointer argument.
2494 bool hasStructRetAttr() const {
2495 // Be friendly and also check the callee.
2496 return paramHasAttr(1, Attribute::StructRet);
2499 /// getCalledFunction - Return the function called, or null if this is an
2500 /// indirect function invocation.
2502 Function *getCalledFunction() const {
2503 return dyn_cast<Function>(getOperand(0));
2506 // getCalledValue - Get a pointer to a function that is invoked by this inst.
2507 Value *getCalledValue() const { return getOperand(0); }
2509 // get*Dest - Return the destination basic blocks...
2510 BasicBlock *getNormalDest() const {
2511 return cast<BasicBlock>(getOperand(1));
2513 BasicBlock *getUnwindDest() const {
2514 return cast<BasicBlock>(getOperand(2));
2516 void setNormalDest(BasicBlock *B) {
2520 void setUnwindDest(BasicBlock *B) {
2524 BasicBlock *getSuccessor(unsigned i) const {
2525 assert(i < 2 && "Successor # out of range for invoke!");
2526 return i == 0 ? getNormalDest() : getUnwindDest();
2529 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2530 assert(idx < 2 && "Successor # out of range for invoke!");
2531 setOperand(idx+1, NewSucc);
2534 unsigned getNumSuccessors() const { return 2; }
2536 // Methods for support type inquiry through isa, cast, and dyn_cast:
2537 static inline bool classof(const InvokeInst *) { return true; }
2538 static inline bool classof(const Instruction *I) {
2539 return (I->getOpcode() == Instruction::Invoke);
2541 static inline bool classof(const Value *V) {
2542 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2545 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2546 virtual unsigned getNumSuccessorsV() const;
2547 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2551 struct OperandTraits<InvokeInst> : VariadicOperandTraits<3> {
2554 template<typename InputIterator>
2555 InvokeInst::InvokeInst(Value *Func,
2556 BasicBlock *IfNormal, BasicBlock *IfException,
2557 InputIterator ArgBegin, InputIterator ArgEnd,
2559 const std::string &NameStr, Instruction *InsertBefore)
2560 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2561 ->getElementType())->getReturnType(),
2562 Instruction::Invoke,
2563 OperandTraits<InvokeInst>::op_end(this) - Values,
2564 Values, InsertBefore) {
2565 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2566 typename std::iterator_traits<InputIterator>::iterator_category());
2568 template<typename InputIterator>
2569 InvokeInst::InvokeInst(Value *Func,
2570 BasicBlock *IfNormal, BasicBlock *IfException,
2571 InputIterator ArgBegin, InputIterator ArgEnd,
2573 const std::string &NameStr, BasicBlock *InsertAtEnd)
2574 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2575 ->getElementType())->getReturnType(),
2576 Instruction::Invoke,
2577 OperandTraits<InvokeInst>::op_end(this) - Values,
2578 Values, InsertAtEnd) {
2579 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2580 typename std::iterator_traits<InputIterator>::iterator_category());
2583 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
2585 //===----------------------------------------------------------------------===//
2587 //===----------------------------------------------------------------------===//
2589 //===---------------------------------------------------------------------------
2590 /// UnwindInst - Immediately exit the current function, unwinding the stack
2591 /// until an invoke instruction is found.
2593 class UnwindInst : public TerminatorInst {
2594 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2596 // allocate space for exactly zero operands
2597 void *operator new(size_t s) {
2598 return User::operator new(s, 0);
2600 explicit UnwindInst(Instruction *InsertBefore = 0);
2601 explicit UnwindInst(BasicBlock *InsertAtEnd);
2603 virtual UnwindInst *clone() const;
2605 unsigned getNumSuccessors() const { return 0; }
2607 // Methods for support type inquiry through isa, cast, and dyn_cast:
2608 static inline bool classof(const UnwindInst *) { return true; }
2609 static inline bool classof(const Instruction *I) {
2610 return I->getOpcode() == Instruction::Unwind;
2612 static inline bool classof(const Value *V) {
2613 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2616 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2617 virtual unsigned getNumSuccessorsV() const;
2618 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2621 //===----------------------------------------------------------------------===//
2622 // UnreachableInst Class
2623 //===----------------------------------------------------------------------===//
2625 //===---------------------------------------------------------------------------
2626 /// UnreachableInst - This function has undefined behavior. In particular, the
2627 /// presence of this instruction indicates some higher level knowledge that the
2628 /// end of the block cannot be reached.
2630 class UnreachableInst : public TerminatorInst {
2631 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2633 // allocate space for exactly zero operands
2634 void *operator new(size_t s) {
2635 return User::operator new(s, 0);
2637 explicit UnreachableInst(Instruction *InsertBefore = 0);
2638 explicit UnreachableInst(BasicBlock *InsertAtEnd);
2640 virtual UnreachableInst *clone() const;
2642 unsigned getNumSuccessors() const { return 0; }
2644 // Methods for support type inquiry through isa, cast, and dyn_cast:
2645 static inline bool classof(const UnreachableInst *) { return true; }
2646 static inline bool classof(const Instruction *I) {
2647 return I->getOpcode() == Instruction::Unreachable;
2649 static inline bool classof(const Value *V) {
2650 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2653 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2654 virtual unsigned getNumSuccessorsV() const;
2655 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2658 //===----------------------------------------------------------------------===//
2660 //===----------------------------------------------------------------------===//
2662 /// @brief This class represents a truncation of integer types.
2663 class TruncInst : public CastInst {
2664 /// Private copy constructor
2665 TruncInst(const TruncInst &CI)
2666 : CastInst(CI.getType(), Trunc, CI.getOperand(0)) {
2669 /// @brief Constructor with insert-before-instruction semantics
2671 Value *S, ///< The value to be truncated
2672 const Type *Ty, ///< The (smaller) type to truncate to
2673 const std::string &NameStr = "", ///< A name for the new instruction
2674 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2677 /// @brief Constructor with insert-at-end-of-block semantics
2679 Value *S, ///< The value to be truncated
2680 const Type *Ty, ///< The (smaller) type to truncate to
2681 const std::string &NameStr, ///< A name for the new instruction
2682 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2685 /// @brief Clone an identical TruncInst
2686 virtual CastInst *clone() const;
2688 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2689 static inline bool classof(const TruncInst *) { return true; }
2690 static inline bool classof(const Instruction *I) {
2691 return I->getOpcode() == Trunc;
2693 static inline bool classof(const Value *V) {
2694 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2698 //===----------------------------------------------------------------------===//
2700 //===----------------------------------------------------------------------===//
2702 /// @brief This class represents zero extension of integer types.
2703 class ZExtInst : public CastInst {
2704 /// @brief Private copy constructor
2705 ZExtInst(const ZExtInst &CI)
2706 : CastInst(CI.getType(), ZExt, CI.getOperand(0)) {
2709 /// @brief Constructor with insert-before-instruction semantics
2711 Value *S, ///< The value to be zero extended
2712 const Type *Ty, ///< The type to zero extend to
2713 const std::string &NameStr = "", ///< A name for the new instruction
2714 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2717 /// @brief Constructor with insert-at-end semantics.
2719 Value *S, ///< The value to be zero extended
2720 const Type *Ty, ///< The type to zero extend to
2721 const std::string &NameStr, ///< A name for the new instruction
2722 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2725 /// @brief Clone an identical ZExtInst
2726 virtual CastInst *clone() const;
2728 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2729 static inline bool classof(const ZExtInst *) { return true; }
2730 static inline bool classof(const Instruction *I) {
2731 return I->getOpcode() == ZExt;
2733 static inline bool classof(const Value *V) {
2734 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2738 //===----------------------------------------------------------------------===//
2740 //===----------------------------------------------------------------------===//
2742 /// @brief This class represents a sign extension of integer types.
2743 class SExtInst : public CastInst {
2744 /// @brief Private copy constructor
2745 SExtInst(const SExtInst &CI)
2746 : CastInst(CI.getType(), SExt, CI.getOperand(0)) {
2749 /// @brief Constructor with insert-before-instruction semantics
2751 Value *S, ///< The value to be sign extended
2752 const Type *Ty, ///< The type to sign extend to
2753 const std::string &NameStr = "", ///< A name for the new instruction
2754 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2757 /// @brief Constructor with insert-at-end-of-block semantics
2759 Value *S, ///< The value to be sign extended
2760 const Type *Ty, ///< The type to sign extend to
2761 const std::string &NameStr, ///< A name for the new instruction
2762 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2765 /// @brief Clone an identical SExtInst
2766 virtual CastInst *clone() const;
2768 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2769 static inline bool classof(const SExtInst *) { return true; }
2770 static inline bool classof(const Instruction *I) {
2771 return I->getOpcode() == SExt;
2773 static inline bool classof(const Value *V) {
2774 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2778 //===----------------------------------------------------------------------===//
2779 // FPTruncInst Class
2780 //===----------------------------------------------------------------------===//
2782 /// @brief This class represents a truncation of floating point types.
2783 class FPTruncInst : public CastInst {
2784 FPTruncInst(const FPTruncInst &CI)
2785 : CastInst(CI.getType(), FPTrunc, CI.getOperand(0)) {
2788 /// @brief Constructor with insert-before-instruction semantics
2790 Value *S, ///< The value to be truncated
2791 const Type *Ty, ///< The type to truncate to
2792 const std::string &NameStr = "", ///< A name for the new instruction
2793 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2796 /// @brief Constructor with insert-before-instruction semantics
2798 Value *S, ///< The value to be truncated
2799 const Type *Ty, ///< The type to truncate to
2800 const std::string &NameStr, ///< A name for the new instruction
2801 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2804 /// @brief Clone an identical FPTruncInst
2805 virtual CastInst *clone() const;
2807 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2808 static inline bool classof(const FPTruncInst *) { return true; }
2809 static inline bool classof(const Instruction *I) {
2810 return I->getOpcode() == FPTrunc;
2812 static inline bool classof(const Value *V) {
2813 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2817 //===----------------------------------------------------------------------===//
2819 //===----------------------------------------------------------------------===//
2821 /// @brief This class represents an extension of floating point types.
2822 class FPExtInst : public CastInst {
2823 FPExtInst(const FPExtInst &CI)
2824 : CastInst(CI.getType(), FPExt, CI.getOperand(0)) {
2827 /// @brief Constructor with insert-before-instruction semantics
2829 Value *S, ///< The value to be extended
2830 const Type *Ty, ///< The type to extend to
2831 const std::string &NameStr = "", ///< A name for the new instruction
2832 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2835 /// @brief Constructor with insert-at-end-of-block semantics
2837 Value *S, ///< The value to be extended
2838 const Type *Ty, ///< The type to extend to
2839 const std::string &NameStr, ///< A name for the new instruction
2840 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2843 /// @brief Clone an identical FPExtInst
2844 virtual CastInst *clone() const;
2846 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2847 static inline bool classof(const FPExtInst *) { return true; }
2848 static inline bool classof(const Instruction *I) {
2849 return I->getOpcode() == FPExt;
2851 static inline bool classof(const Value *V) {
2852 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2856 //===----------------------------------------------------------------------===//
2858 //===----------------------------------------------------------------------===//
2860 /// @brief This class represents a cast unsigned integer to floating point.
2861 class UIToFPInst : public CastInst {
2862 UIToFPInst(const UIToFPInst &CI)
2863 : CastInst(CI.getType(), UIToFP, CI.getOperand(0)) {
2866 /// @brief Constructor with insert-before-instruction semantics
2868 Value *S, ///< The value to be converted
2869 const Type *Ty, ///< The type to convert to
2870 const std::string &NameStr = "", ///< A name for the new instruction
2871 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2874 /// @brief Constructor with insert-at-end-of-block semantics
2876 Value *S, ///< The value to be converted
2877 const Type *Ty, ///< The type to convert to
2878 const std::string &NameStr, ///< A name for the new instruction
2879 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2882 /// @brief Clone an identical UIToFPInst
2883 virtual CastInst *clone() const;
2885 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2886 static inline bool classof(const UIToFPInst *) { return true; }
2887 static inline bool classof(const Instruction *I) {
2888 return I->getOpcode() == UIToFP;
2890 static inline bool classof(const Value *V) {
2891 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2895 //===----------------------------------------------------------------------===//
2897 //===----------------------------------------------------------------------===//
2899 /// @brief This class represents a cast from signed integer to floating point.
2900 class SIToFPInst : public CastInst {
2901 SIToFPInst(const SIToFPInst &CI)
2902 : CastInst(CI.getType(), SIToFP, CI.getOperand(0)) {
2905 /// @brief Constructor with insert-before-instruction semantics
2907 Value *S, ///< The value to be converted
2908 const Type *Ty, ///< The type to convert to
2909 const std::string &NameStr = "", ///< A name for the new instruction
2910 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2913 /// @brief Constructor with insert-at-end-of-block semantics
2915 Value *S, ///< The value to be converted
2916 const Type *Ty, ///< The type to convert to
2917 const std::string &NameStr, ///< A name for the new instruction
2918 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2921 /// @brief Clone an identical SIToFPInst
2922 virtual CastInst *clone() const;
2924 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2925 static inline bool classof(const SIToFPInst *) { return true; }
2926 static inline bool classof(const Instruction *I) {
2927 return I->getOpcode() == SIToFP;
2929 static inline bool classof(const Value *V) {
2930 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2934 //===----------------------------------------------------------------------===//
2936 //===----------------------------------------------------------------------===//
2938 /// @brief This class represents a cast from floating point to unsigned integer
2939 class FPToUIInst : public CastInst {
2940 FPToUIInst(const FPToUIInst &CI)
2941 : CastInst(CI.getType(), FPToUI, CI.getOperand(0)) {
2944 /// @brief Constructor with insert-before-instruction semantics
2946 Value *S, ///< The value to be converted
2947 const Type *Ty, ///< The type to convert to
2948 const std::string &NameStr = "", ///< A name for the new instruction
2949 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2952 /// @brief Constructor with insert-at-end-of-block semantics
2954 Value *S, ///< The value to be converted
2955 const Type *Ty, ///< The type to convert to
2956 const std::string &NameStr, ///< A name for the new instruction
2957 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
2960 /// @brief Clone an identical FPToUIInst
2961 virtual CastInst *clone() const;
2963 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2964 static inline bool classof(const FPToUIInst *) { return true; }
2965 static inline bool classof(const Instruction *I) {
2966 return I->getOpcode() == FPToUI;
2968 static inline bool classof(const Value *V) {
2969 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2973 //===----------------------------------------------------------------------===//
2975 //===----------------------------------------------------------------------===//
2977 /// @brief This class represents a cast from floating point to signed integer.
2978 class FPToSIInst : public CastInst {
2979 FPToSIInst(const FPToSIInst &CI)
2980 : CastInst(CI.getType(), FPToSI, CI.getOperand(0)) {
2983 /// @brief Constructor with insert-before-instruction semantics
2985 Value *S, ///< The value to be converted
2986 const Type *Ty, ///< The type to convert to
2987 const std::string &NameStr = "", ///< A name for the new instruction
2988 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2991 /// @brief Constructor with insert-at-end-of-block semantics
2993 Value *S, ///< The value to be converted
2994 const Type *Ty, ///< The type to convert to
2995 const std::string &NameStr, ///< A name for the new instruction
2996 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2999 /// @brief Clone an identical FPToSIInst
3000 virtual CastInst *clone() const;
3002 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3003 static inline bool classof(const FPToSIInst *) { return true; }
3004 static inline bool classof(const Instruction *I) {
3005 return I->getOpcode() == FPToSI;
3007 static inline bool classof(const Value *V) {
3008 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3012 //===----------------------------------------------------------------------===//
3013 // IntToPtrInst Class
3014 //===----------------------------------------------------------------------===//
3016 /// @brief This class represents a cast from an integer to a pointer.
3017 class IntToPtrInst : public CastInst {
3018 IntToPtrInst(const IntToPtrInst &CI)
3019 : CastInst(CI.getType(), IntToPtr, CI.getOperand(0)) {
3022 /// @brief Constructor with insert-before-instruction semantics
3024 Value *S, ///< The value to be converted
3025 const Type *Ty, ///< The type to convert to
3026 const std::string &NameStr = "", ///< A name for the new instruction
3027 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3030 /// @brief Constructor with insert-at-end-of-block semantics
3032 Value *S, ///< The value to be converted
3033 const Type *Ty, ///< The type to convert to
3034 const std::string &NameStr, ///< A name for the new instruction
3035 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3038 /// @brief Clone an identical IntToPtrInst
3039 virtual CastInst *clone() const;
3041 // Methods for support type inquiry through isa, cast, and dyn_cast:
3042 static inline bool classof(const IntToPtrInst *) { return true; }
3043 static inline bool classof(const Instruction *I) {
3044 return I->getOpcode() == IntToPtr;
3046 static inline bool classof(const Value *V) {
3047 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3051 //===----------------------------------------------------------------------===//
3052 // PtrToIntInst Class
3053 //===----------------------------------------------------------------------===//
3055 /// @brief This class represents a cast from a pointer to an integer
3056 class PtrToIntInst : public CastInst {
3057 PtrToIntInst(const PtrToIntInst &CI)
3058 : CastInst(CI.getType(), PtrToInt, CI.getOperand(0)) {
3061 /// @brief Constructor with insert-before-instruction semantics
3063 Value *S, ///< The value to be converted
3064 const Type *Ty, ///< The type to convert to
3065 const std::string &NameStr = "", ///< A name for the new instruction
3066 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3069 /// @brief Constructor with insert-at-end-of-block semantics
3071 Value *S, ///< The value to be converted
3072 const Type *Ty, ///< The type to convert to
3073 const std::string &NameStr, ///< A name for the new instruction
3074 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3077 /// @brief Clone an identical PtrToIntInst
3078 virtual CastInst *clone() const;
3080 // Methods for support type inquiry through isa, cast, and dyn_cast:
3081 static inline bool classof(const PtrToIntInst *) { return true; }
3082 static inline bool classof(const Instruction *I) {
3083 return I->getOpcode() == PtrToInt;
3085 static inline bool classof(const Value *V) {
3086 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3090 //===----------------------------------------------------------------------===//
3091 // BitCastInst Class
3092 //===----------------------------------------------------------------------===//
3094 /// @brief This class represents a no-op cast from one type to another.
3095 class BitCastInst : public CastInst {
3096 BitCastInst(const BitCastInst &CI)
3097 : CastInst(CI.getType(), BitCast, CI.getOperand(0)) {
3100 /// @brief Constructor with insert-before-instruction semantics
3102 Value *S, ///< The value to be casted
3103 const Type *Ty, ///< The type to casted to
3104 const std::string &NameStr = "", ///< A name for the new instruction
3105 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3108 /// @brief Constructor with insert-at-end-of-block semantics
3110 Value *S, ///< The value to be casted
3111 const Type *Ty, ///< The type to casted to
3112 const std::string &NameStr, ///< A name for the new instruction
3113 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3116 /// @brief Clone an identical BitCastInst
3117 virtual CastInst *clone() const;
3119 // Methods for support type inquiry through isa, cast, and dyn_cast:
3120 static inline bool classof(const BitCastInst *) { return true; }
3121 static inline bool classof(const Instruction *I) {
3122 return I->getOpcode() == BitCast;
3124 static inline bool classof(const Value *V) {
3125 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3129 } // End llvm namespace