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/ParameterAttributes.h"
24 #include "llvm/BasicBlock.h"
34 //===----------------------------------------------------------------------===//
35 // AllocationInst Class
36 //===----------------------------------------------------------------------===//
38 /// AllocationInst - This class is the common base class of MallocInst and
41 class AllocationInst : public UnaryInstruction {
43 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
44 const std::string &Name = "", Instruction *InsertBefore = 0);
45 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
46 const std::string &Name, BasicBlock *InsertAtEnd);
48 // Out of line virtual method, so the vtable, etc. has a home.
49 virtual ~AllocationInst();
51 /// isArrayAllocation - Return true if there is an allocation size parameter
52 /// to the allocation instruction that is not 1.
54 bool isArrayAllocation() const;
56 /// getArraySize - Get the number of element allocated, for a simple
57 /// allocation of a single element, this will return a constant 1 value.
59 const Value *getArraySize() const { return getOperand(0); }
60 Value *getArraySize() { return getOperand(0); }
62 /// getType - Overload to return most specific pointer type
64 const PointerType *getType() const {
65 return reinterpret_cast<const PointerType*>(Instruction::getType());
68 /// getAllocatedType - Return the type that is being allocated by the
71 const Type *getAllocatedType() const;
73 /// getAlignment - Return the alignment of the memory that is being allocated
74 /// by the instruction.
76 unsigned getAlignment() const { return (1u << SubclassData) >> 1; }
77 void setAlignment(unsigned Align);
79 virtual Instruction *clone() const = 0;
81 // Methods for support type inquiry through isa, cast, and dyn_cast:
82 static inline bool classof(const AllocationInst *) { return true; }
83 static inline bool classof(const Instruction *I) {
84 return I->getOpcode() == Instruction::Alloca ||
85 I->getOpcode() == Instruction::Malloc;
87 static inline bool classof(const Value *V) {
88 return isa<Instruction>(V) && classof(cast<Instruction>(V));
93 //===----------------------------------------------------------------------===//
95 //===----------------------------------------------------------------------===//
97 /// MallocInst - an instruction to allocated memory on the heap
99 class MallocInst : public AllocationInst {
100 MallocInst(const MallocInst &MI);
102 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
103 const std::string &Name = "",
104 Instruction *InsertBefore = 0)
105 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
106 MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
107 BasicBlock *InsertAtEnd)
108 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
110 MallocInst(const Type *Ty, const std::string &Name,
111 Instruction *InsertBefore = 0)
112 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
113 MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
114 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
116 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
117 const std::string &Name, BasicBlock *InsertAtEnd)
118 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
119 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
120 const std::string &Name = "",
121 Instruction *InsertBefore = 0)
122 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
124 virtual MallocInst *clone() const;
126 // Methods for support type inquiry through isa, cast, and dyn_cast:
127 static inline bool classof(const MallocInst *) { return true; }
128 static inline bool classof(const Instruction *I) {
129 return (I->getOpcode() == Instruction::Malloc);
131 static inline bool classof(const Value *V) {
132 return isa<Instruction>(V) && classof(cast<Instruction>(V));
137 //===----------------------------------------------------------------------===//
139 //===----------------------------------------------------------------------===//
141 /// AllocaInst - an instruction to allocate memory on the stack
143 class AllocaInst : public AllocationInst {
144 AllocaInst(const AllocaInst &);
146 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
147 const std::string &Name = "",
148 Instruction *InsertBefore = 0)
149 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
150 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
151 BasicBlock *InsertAtEnd)
152 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
154 AllocaInst(const Type *Ty, const std::string &Name,
155 Instruction *InsertBefore = 0)
156 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
157 AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
158 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
160 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
161 const std::string &Name = "", Instruction *InsertBefore = 0)
162 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
163 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
164 const std::string &Name, BasicBlock *InsertAtEnd)
165 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
167 virtual AllocaInst *clone() const;
169 // Methods for support type inquiry through isa, cast, and dyn_cast:
170 static inline bool classof(const AllocaInst *) { return true; }
171 static inline bool classof(const Instruction *I) {
172 return (I->getOpcode() == Instruction::Alloca);
174 static inline bool classof(const Value *V) {
175 return isa<Instruction>(V) && classof(cast<Instruction>(V));
180 //===----------------------------------------------------------------------===//
182 //===----------------------------------------------------------------------===//
184 /// FreeInst - an instruction to deallocate memory
186 class FreeInst : public UnaryInstruction {
189 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
190 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
192 virtual FreeInst *clone() const;
194 // Accessor methods for consistency with other memory operations
195 Value *getPointerOperand() { return getOperand(0); }
196 const Value *getPointerOperand() const { return getOperand(0); }
198 // Methods for support type inquiry through isa, cast, and dyn_cast:
199 static inline bool classof(const FreeInst *) { return true; }
200 static inline bool classof(const Instruction *I) {
201 return (I->getOpcode() == Instruction::Free);
203 static inline bool classof(const Value *V) {
204 return isa<Instruction>(V) && classof(cast<Instruction>(V));
209 //===----------------------------------------------------------------------===//
211 //===----------------------------------------------------------------------===//
213 /// LoadInst - an instruction for reading from memory. This uses the
214 /// SubclassData field in Value to store whether or not the load is volatile.
216 class LoadInst : public UnaryInstruction {
218 LoadInst(const LoadInst &LI)
219 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
220 setVolatile(LI.isVolatile());
221 setAlignment(LI.getAlignment());
229 LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
230 LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
231 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile = false,
232 Instruction *InsertBefore = 0);
233 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
234 Instruction *InsertBefore = 0);
235 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
236 BasicBlock *InsertAtEnd);
237 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
238 BasicBlock *InsertAtEnd);
240 LoadInst(Value *Ptr, const char *Name, Instruction *InsertBefore);
241 LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAtEnd);
242 explicit LoadInst(Value *Ptr, const char *Name = 0, bool isVolatile = false,
243 Instruction *InsertBefore = 0);
244 LoadInst(Value *Ptr, const char *Name, bool isVolatile,
245 BasicBlock *InsertAtEnd);
247 /// isVolatile - Return true if this is a load from a volatile memory
250 bool isVolatile() const { return SubclassData & 1; }
252 /// setVolatile - Specify whether this is a volatile load or not.
254 void setVolatile(bool V) {
255 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
258 virtual LoadInst *clone() const;
260 /// getAlignment - Return the alignment of the access that is being performed
262 unsigned getAlignment() const {
263 return (1 << (SubclassData>>1)) >> 1;
266 void setAlignment(unsigned Align);
268 Value *getPointerOperand() { return getOperand(0); }
269 const Value *getPointerOperand() const { return getOperand(0); }
270 static unsigned getPointerOperandIndex() { return 0U; }
272 // Methods for support type inquiry through isa, cast, and dyn_cast:
273 static inline bool classof(const LoadInst *) { return true; }
274 static inline bool classof(const Instruction *I) {
275 return I->getOpcode() == Instruction::Load;
277 static inline bool classof(const Value *V) {
278 return isa<Instruction>(V) && classof(cast<Instruction>(V));
283 //===----------------------------------------------------------------------===//
285 //===----------------------------------------------------------------------===//
287 /// StoreInst - an instruction for storing to memory
289 class StoreInst : public Instruction {
290 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
292 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store,
294 Op<0>().init(SI.Op<0>(), this);
295 Op<1>().init(SI.Op<1>(), this);
296 setVolatile(SI.isVolatile());
297 setAlignment(SI.getAlignment());
305 // allocate space for exactly two operands
306 void *operator new(size_t s) {
307 return User::operator new(s, 2);
309 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
310 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
311 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
312 Instruction *InsertBefore = 0);
313 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
314 unsigned Align, Instruction *InsertBefore = 0);
315 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
316 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
317 unsigned Align, BasicBlock *InsertAtEnd);
320 /// isVolatile - Return true if this is a load from a volatile memory
323 bool isVolatile() const { return SubclassData & 1; }
325 /// setVolatile - Specify whether this is a volatile load or not.
327 void setVolatile(bool V) {
328 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
331 /// Transparently provide more efficient getOperand methods.
332 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
334 /// getAlignment - Return the alignment of the access that is being performed
336 unsigned getAlignment() const {
337 return (1 << (SubclassData>>1)) >> 1;
340 void setAlignment(unsigned Align);
342 virtual StoreInst *clone() const;
344 Value *getPointerOperand() { return getOperand(1); }
345 const Value *getPointerOperand() const { return getOperand(1); }
346 static unsigned getPointerOperandIndex() { return 1U; }
348 // Methods for support type inquiry through isa, cast, and dyn_cast:
349 static inline bool classof(const StoreInst *) { return true; }
350 static inline bool classof(const Instruction *I) {
351 return I->getOpcode() == Instruction::Store;
353 static inline bool classof(const Value *V) {
354 return isa<Instruction>(V) && classof(cast<Instruction>(V));
359 struct OperandTraits<StoreInst> : FixedNumOperandTraits<2> {
362 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
364 //===----------------------------------------------------------------------===//
365 // GetElementPtrInst Class
366 //===----------------------------------------------------------------------===//
368 // checkType - Simple wrapper function to give a better assertion failure
369 // message on bad indexes for a gep instruction.
371 static inline const Type *checkType(const Type *Ty) {
372 assert(Ty && "Invalid GetElementPtrInst indices for type!");
376 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
377 /// access elements of arrays and structs
379 class GetElementPtrInst : public Instruction {
380 GetElementPtrInst(const GetElementPtrInst &GEPI);
381 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx);
382 void init(Value *Ptr, Value *Idx);
384 template<typename InputIterator>
385 void init(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
386 const std::string &Name,
387 // This argument ensures that we have an iterator we can
388 // do arithmetic on in constant time
389 std::random_access_iterator_tag) {
390 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
393 // This requires that the iterator points to contiguous memory.
394 init(Ptr, &*IdxBegin, NumIdx); // FIXME: for the general case
395 // we have to build an array here
398 init(Ptr, 0, NumIdx);
404 /// getIndexedType - Returns the type of the element that would be loaded with
405 /// a load instruction with the specified parameters.
407 /// A null type is returned if the indices are invalid for the specified
410 static const Type *getIndexedType(const Type *Ptr,
411 Value* const *Idx, unsigned NumIdx,
412 bool AllowStructLeaf = false);
414 template<typename InputIterator>
415 static const Type *getIndexedType(const Type *Ptr,
416 InputIterator IdxBegin,
417 InputIterator IdxEnd,
418 bool AllowStructLeaf,
419 // This argument ensures that we
420 // have an iterator we can do
421 // arithmetic on in constant time
422 std::random_access_iterator_tag) {
423 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
426 // This requires that the iterator points to contiguous memory.
427 return(getIndexedType(Ptr, (Value *const *)&*IdxBegin, NumIdx,
431 return(getIndexedType(Ptr, (Value *const*)0, NumIdx, AllowStructLeaf));
435 /// Constructors - Create a getelementptr instruction with a base pointer an
436 /// list of indices. The first ctor can optionally insert before an existing
437 /// instruction, the second appends the new instruction to the specified
439 template<typename InputIterator>
440 inline GetElementPtrInst(Value *Ptr, InputIterator IdxBegin,
441 InputIterator IdxEnd,
443 const std::string &Name,
444 Instruction *InsertBefore);
445 template<typename InputIterator>
446 inline GetElementPtrInst(Value *Ptr,
447 InputIterator IdxBegin, InputIterator IdxEnd,
449 const std::string &Name, BasicBlock *InsertAtEnd);
451 /// Constructors - These two constructors are convenience methods because one
452 /// and two index getelementptr instructions are so common.
453 GetElementPtrInst(Value *Ptr, Value *Idx, const std::string &Name = "",
454 Instruction *InsertBefore = 0);
455 GetElementPtrInst(Value *Ptr, Value *Idx,
456 const std::string &Name, BasicBlock *InsertAtEnd);
458 template<typename InputIterator>
459 static GetElementPtrInst *Create(Value *Ptr, InputIterator IdxBegin,
460 InputIterator IdxEnd,
461 const std::string &Name = "",
462 Instruction *InsertBefore = 0) {
463 typename std::iterator_traits<InputIterator>::difference_type Values =
464 1 + std::distance(IdxBegin, IdxEnd);
466 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, Name, InsertBefore);
468 template<typename InputIterator>
469 static GetElementPtrInst *Create(Value *Ptr,
470 InputIterator IdxBegin, InputIterator IdxEnd,
471 const std::string &Name,
472 BasicBlock *InsertAtEnd) {
473 typename std::iterator_traits<InputIterator>::difference_type Values =
474 1 + std::distance(IdxBegin, IdxEnd);
476 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, Name, InsertAtEnd);
479 /// Constructors - These two creators are convenience methods because one
480 /// index getelementptr instructions are so common.
481 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
482 const std::string &Name = "",
483 Instruction *InsertBefore = 0) {
484 return new(2) GetElementPtrInst(Ptr, Idx, Name, InsertBefore);
486 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
487 const std::string &Name,
488 BasicBlock *InsertAtEnd) {
489 return new(2) GetElementPtrInst(Ptr, Idx, Name, InsertAtEnd);
492 virtual GetElementPtrInst *clone() const;
494 /// Transparently provide more efficient getOperand methods.
495 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
497 // getType - Overload to return most specific pointer type...
498 const PointerType *getType() const {
499 return reinterpret_cast<const PointerType*>(Instruction::getType());
502 /// getIndexedType - Returns the type of the element that would be loaded with
503 /// a load instruction with the specified parameters.
505 /// A null type is returned if the indices are invalid for the specified
508 template<typename InputIterator>
509 static const Type *getIndexedType(const Type *Ptr,
510 InputIterator IdxBegin,
511 InputIterator IdxEnd,
512 bool AllowStructLeaf = false) {
513 return(getIndexedType(Ptr, IdxBegin, IdxEnd, AllowStructLeaf,
514 typename std::iterator_traits<InputIterator>::
515 iterator_category()));
517 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
519 inline op_iterator idx_begin() { return op_begin()+1; }
520 inline const_op_iterator idx_begin() const { return op_begin()+1; }
521 inline op_iterator idx_end() { return op_end(); }
522 inline const_op_iterator idx_end() const { return op_end(); }
524 Value *getPointerOperand() {
525 return getOperand(0);
527 const Value *getPointerOperand() const {
528 return getOperand(0);
530 static unsigned getPointerOperandIndex() {
531 return 0U; // get index for modifying correct operand
534 unsigned getNumIndices() const { // Note: always non-negative
535 return getNumOperands() - 1;
538 bool hasIndices() const {
539 return getNumOperands() > 1;
542 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
543 /// zeros. If so, the result pointer and the first operand have the same
544 /// value, just potentially different types.
545 bool hasAllZeroIndices() const;
547 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
548 /// constant integers. If so, the result pointer and the first operand have
549 /// a constant offset between them.
550 bool hasAllConstantIndices() const;
553 // Methods for support type inquiry through isa, cast, and dyn_cast:
554 static inline bool classof(const GetElementPtrInst *) { return true; }
555 static inline bool classof(const Instruction *I) {
556 return (I->getOpcode() == Instruction::GetElementPtr);
558 static inline bool classof(const Value *V) {
559 return isa<Instruction>(V) && classof(cast<Instruction>(V));
564 struct OperandTraits<GetElementPtrInst> : VariadicOperandTraits<1> {
567 template<typename InputIterator>
568 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
569 InputIterator IdxBegin,
570 InputIterator IdxEnd,
572 const std::string &Name,
573 Instruction *InsertBefore)
574 : Instruction(PointerType::get(checkType(
575 getIndexedType(Ptr->getType(),
576 IdxBegin, IdxEnd, true)),
577 cast<PointerType>(Ptr->getType())
578 ->getAddressSpace()),
580 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
581 Values, InsertBefore) {
582 init(Ptr, IdxBegin, IdxEnd, Name,
583 typename std::iterator_traits<InputIterator>::iterator_category());
585 template<typename InputIterator>
586 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
587 InputIterator IdxBegin,
588 InputIterator IdxEnd,
590 const std::string &Name,
591 BasicBlock *InsertAtEnd)
592 : Instruction(PointerType::get(checkType(
593 getIndexedType(Ptr->getType(),
594 IdxBegin, IdxEnd, true)),
595 cast<PointerType>(Ptr->getType())
596 ->getAddressSpace()),
598 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
599 Values, InsertAtEnd) {
600 init(Ptr, IdxBegin, IdxEnd, Name,
601 typename std::iterator_traits<InputIterator>::iterator_category());
605 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
608 //===----------------------------------------------------------------------===//
610 //===----------------------------------------------------------------------===//
612 /// This instruction compares its operands according to the predicate given
613 /// to the constructor. It only operates on integers, pointers, or packed
614 /// vectors of integrals. The two operands must be the same type.
615 /// @brief Represent an integer comparison operator.
616 class ICmpInst: public CmpInst {
618 /// This enumeration lists the possible predicates for the ICmpInst. The
619 /// values in the range 0-31 are reserved for FCmpInst while values in the
620 /// range 32-64 are reserved for ICmpInst. This is necessary to ensure the
621 /// predicate values are not overlapping between the classes.
623 ICMP_EQ = 32, ///< equal
624 ICMP_NE = 33, ///< not equal
625 ICMP_UGT = 34, ///< unsigned greater than
626 ICMP_UGE = 35, ///< unsigned greater or equal
627 ICMP_ULT = 36, ///< unsigned less than
628 ICMP_ULE = 37, ///< unsigned less or equal
629 ICMP_SGT = 38, ///< signed greater than
630 ICMP_SGE = 39, ///< signed greater or equal
631 ICMP_SLT = 40, ///< signed less than
632 ICMP_SLE = 41, ///< signed less or equal
633 FIRST_ICMP_PREDICATE = ICMP_EQ,
634 LAST_ICMP_PREDICATE = ICMP_SLE,
635 BAD_ICMP_PREDICATE = ICMP_SLE + 1
638 /// @brief Constructor with insert-before-instruction 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 &Name = "", ///< Name of the instruction
644 Instruction *InsertBefore = 0 ///< Where to insert
645 ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertBefore) {
648 /// @brief Constructor with insert-at-block-end semantics.
650 Predicate pred, ///< The predicate to use for the comparison
651 Value *LHS, ///< The left-hand-side of the expression
652 Value *RHS, ///< The right-hand-side of the expression
653 const std::string &Name, ///< Name of the instruction
654 BasicBlock *InsertAtEnd ///< Block to insert into.
655 ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertAtEnd) {
658 /// @brief Return the predicate for this instruction.
659 Predicate getPredicate() const { return Predicate(SubclassData); }
661 /// @brief Set the predicate for this instruction to the specified value.
662 void setPredicate(Predicate P) { SubclassData = P; }
664 /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
665 /// @returns the inverse predicate for the instruction's current predicate.
666 /// @brief Return the inverse of the instruction's predicate.
667 Predicate getInversePredicate() const {
668 return getInversePredicate(getPredicate());
671 /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
672 /// @returns the inverse predicate for predicate provided in \p pred.
673 /// @brief Return the inverse of a given predicate
674 static Predicate getInversePredicate(Predicate pred);
676 /// For example, EQ->EQ, SLE->SGE, ULT->UGT, etc.
677 /// @returns the predicate that would be the result of exchanging the two
678 /// operands of the ICmpInst instruction without changing the result
680 /// @brief Return the predicate as if the operands were swapped
681 Predicate getSwappedPredicate() const {
682 return getSwappedPredicate(getPredicate());
685 /// This is a static version that you can use without an instruction
687 /// @brief Return the predicate as if the operands were swapped.
688 static Predicate getSwappedPredicate(Predicate pred);
690 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
691 /// @returns the predicate that would be the result if the operand were
692 /// regarded as signed.
693 /// @brief Return the signed version of the predicate
694 Predicate getSignedPredicate() const {
695 return getSignedPredicate(getPredicate());
698 /// This is a static version that you can use without an instruction.
699 /// @brief Return the signed version of the predicate.
700 static Predicate getSignedPredicate(Predicate pred);
702 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
703 /// @returns the predicate that would be the result if the operand were
704 /// regarded as unsigned.
705 /// @brief Return the unsigned version of the predicate
706 Predicate getUnsignedPredicate() const {
707 return getUnsignedPredicate(getPredicate());
710 /// This is a static version that you can use without an instruction.
711 /// @brief Return the unsigned version of the predicate.
712 static Predicate getUnsignedPredicate(Predicate pred);
714 /// isEquality - Return true if this predicate is either EQ or NE. This also
715 /// tests for commutativity.
716 static bool isEquality(Predicate P) {
717 return P == ICMP_EQ || P == ICMP_NE;
720 /// isEquality - Return true if this predicate is either EQ or NE. This also
721 /// tests for commutativity.
722 bool isEquality() const {
723 return isEquality(getPredicate());
726 /// @returns true if the predicate of this ICmpInst is commutative
727 /// @brief Determine if this relation is commutative.
728 bool isCommutative() const { return isEquality(); }
730 /// isRelational - Return true if the predicate is relational (not EQ or NE).
732 bool isRelational() const {
733 return !isEquality();
736 /// isRelational - Return true if the predicate is relational (not EQ or NE).
738 static bool isRelational(Predicate P) {
739 return !isEquality(P);
742 /// @returns true if the predicate of this ICmpInst is signed, false otherwise
743 /// @brief Determine if this instruction's predicate is signed.
744 bool isSignedPredicate() const { return isSignedPredicate(getPredicate()); }
746 /// @returns true if the predicate provided is signed, false otherwise
747 /// @brief Determine if the predicate is signed.
748 static bool isSignedPredicate(Predicate pred);
750 /// Initialize a set of values that all satisfy the predicate with C.
751 /// @brief Make a ConstantRange for a relation with a constant value.
752 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
754 /// Exchange the two operands to this instruction in such a way that it does
755 /// not modify the semantics of the instruction. The predicate value may be
756 /// changed to retain the same result if the predicate is order dependent
758 /// @brief Swap operands and adjust predicate.
759 void swapOperands() {
760 SubclassData = getSwappedPredicate();
761 std::swap(Op<0>(), Op<1>());
764 virtual ICmpInst *clone() const;
766 // Methods for support type inquiry through isa, cast, and dyn_cast:
767 static inline bool classof(const ICmpInst *) { return true; }
768 static inline bool classof(const Instruction *I) {
769 return I->getOpcode() == Instruction::ICmp;
771 static inline bool classof(const Value *V) {
772 return isa<Instruction>(V) && classof(cast<Instruction>(V));
776 //===----------------------------------------------------------------------===//
778 //===----------------------------------------------------------------------===//
780 /// This instruction compares its operands according to the predicate given
781 /// to the constructor. It only operates on floating point values or packed
782 /// vectors of floating point values. The operands must be identical types.
783 /// @brief Represents a floating point comparison operator.
784 class FCmpInst: public CmpInst {
786 /// This enumeration lists the possible predicates for the FCmpInst. Values
787 /// in the range 0-31 are reserved for FCmpInst.
789 // Opcode U L G E Intuitive operation
790 FCMP_FALSE = 0, ///< 0 0 0 0 Always false (always folded)
791 FCMP_OEQ = 1, ///< 0 0 0 1 True if ordered and equal
792 FCMP_OGT = 2, ///< 0 0 1 0 True if ordered and greater than
793 FCMP_OGE = 3, ///< 0 0 1 1 True if ordered and greater than or equal
794 FCMP_OLT = 4, ///< 0 1 0 0 True if ordered and less than
795 FCMP_OLE = 5, ///< 0 1 0 1 True if ordered and less than or equal
796 FCMP_ONE = 6, ///< 0 1 1 0 True if ordered and operands are unequal
797 FCMP_ORD = 7, ///< 0 1 1 1 True if ordered (no nans)
798 FCMP_UNO = 8, ///< 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
799 FCMP_UEQ = 9, ///< 1 0 0 1 True if unordered or equal
800 FCMP_UGT =10, ///< 1 0 1 0 True if unordered or greater than
801 FCMP_UGE =11, ///< 1 0 1 1 True if unordered, greater than, or equal
802 FCMP_ULT =12, ///< 1 1 0 0 True if unordered or less than
803 FCMP_ULE =13, ///< 1 1 0 1 True if unordered, less than, or equal
804 FCMP_UNE =14, ///< 1 1 1 0 True if unordered or not equal
805 FCMP_TRUE =15, ///< 1 1 1 1 Always true (always folded)
806 FIRST_FCMP_PREDICATE = FCMP_FALSE,
807 LAST_FCMP_PREDICATE = FCMP_TRUE,
808 BAD_FCMP_PREDICATE = FCMP_TRUE + 1
811 /// @brief Constructor with insert-before-instruction semantics.
813 Predicate pred, ///< The predicate to use for the comparison
814 Value *LHS, ///< The left-hand-side of the expression
815 Value *RHS, ///< The right-hand-side of the expression
816 const std::string &Name = "", ///< Name of the instruction
817 Instruction *InsertBefore = 0 ///< Where to insert
818 ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertBefore) {
821 /// @brief Constructor with insert-at-block-end semantics.
823 Predicate pred, ///< The predicate to use for the comparison
824 Value *LHS, ///< The left-hand-side of the expression
825 Value *RHS, ///< The right-hand-side of the expression
826 const std::string &Name, ///< Name of the instruction
827 BasicBlock *InsertAtEnd ///< Block to insert into.
828 ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertAtEnd) {
831 /// @brief Return the predicate for this instruction.
832 Predicate getPredicate() const { return Predicate(SubclassData); }
834 /// @brief Set the predicate for this instruction to the specified value.
835 void setPredicate(Predicate P) { SubclassData = P; }
837 /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
838 /// @returns the inverse predicate for the instructions current predicate.
839 /// @brief Return the inverse of the predicate
840 Predicate getInversePredicate() const {
841 return getInversePredicate(getPredicate());
844 /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
845 /// @returns the inverse predicate for \p pred.
846 /// @brief Return the inverse of a given predicate
847 static Predicate getInversePredicate(Predicate pred);
849 /// For example, OEQ->OEQ, ULE->UGE, OLT->OGT, etc.
850 /// @returns the predicate that would be the result of exchanging the two
851 /// operands of the ICmpInst instruction without changing the result
853 /// @brief Return the predicate as if the operands were swapped
854 Predicate getSwappedPredicate() const {
855 return getSwappedPredicate(getPredicate());
858 /// This is a static version that you can use without an instruction
860 /// @brief Return the predicate as if the operands were swapped.
861 static Predicate getSwappedPredicate(Predicate Opcode);
863 /// This also tests for commutativity. If isEquality() returns true then
864 /// the predicate is also commutative. Only the equality predicates are
866 /// @returns true if the predicate of this instruction is EQ or NE.
867 /// @brief Determine if this is an equality predicate.
868 bool isEquality() const {
869 return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
870 SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
872 bool isCommutative() const { return isEquality(); }
874 /// @returns true if the predicate is relational (not EQ or NE).
875 /// @brief Determine if this a relational predicate.
876 bool isRelational() const { return !isEquality(); }
878 /// Exchange the two operands to this instruction in such a way that it does
879 /// not modify the semantics of the instruction. The predicate value may be
880 /// changed to retain the same result if the predicate is order dependent
882 /// @brief Swap operands and adjust predicate.
883 void swapOperands() {
884 SubclassData = getSwappedPredicate();
885 std::swap(Op<0>(), Op<1>());
888 virtual FCmpInst *clone() const;
890 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
891 static inline bool classof(const FCmpInst *) { return true; }
892 static inline bool classof(const Instruction *I) {
893 return I->getOpcode() == Instruction::FCmp;
895 static inline bool classof(const Value *V) {
896 return isa<Instruction>(V) && classof(cast<Instruction>(V));
900 //===----------------------------------------------------------------------===//
902 //===----------------------------------------------------------------------===//
903 /// CallInst - This class represents a function call, abstracting a target
904 /// machine's calling convention. This class uses low bit of the SubClassData
905 /// field to indicate whether or not this is a tail call. The rest of the bits
906 /// hold the calling convention of the call.
909 class CallInst : public Instruction {
910 PAListPtr ParamAttrs; ///< parameter attributes for call
911 CallInst(const CallInst &CI);
912 void init(Value *Func, Value* const *Params, unsigned NumParams);
913 void init(Value *Func, Value *Actual1, Value *Actual2);
914 void init(Value *Func, Value *Actual);
915 void init(Value *Func);
917 template<typename InputIterator>
918 void init(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
919 const std::string &Name,
920 // This argument ensures that we have an iterator we can
921 // do arithmetic on in constant time
922 std::random_access_iterator_tag) {
923 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
925 // This requires that the iterator points to contiguous memory.
926 init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
930 /// Construct a CallInst given a range of arguments. InputIterator
931 /// must be a random-access iterator pointing to contiguous storage
932 /// (e.g. a std::vector<>::iterator). Checks are made for
933 /// random-accessness but not for contiguous storage as that would
934 /// incur runtime overhead.
935 /// @brief Construct a CallInst from a range of arguments
936 template<typename InputIterator>
937 CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
938 const std::string &Name, Instruction *InsertBefore);
940 /// Construct a CallInst given a range of arguments. InputIterator
941 /// must be a random-access iterator pointing to contiguous storage
942 /// (e.g. a std::vector<>::iterator). Checks are made for
943 /// random-accessness but not for contiguous storage as that would
944 /// incur runtime overhead.
945 /// @brief Construct a CallInst from a range of arguments
946 template<typename InputIterator>
947 inline CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
948 const std::string &Name, BasicBlock *InsertAtEnd);
950 CallInst(Value *F, Value *Actual, const std::string& Name,
951 Instruction *InsertBefore);
952 CallInst(Value *F, Value *Actual, const std::string& Name,
953 BasicBlock *InsertAtEnd);
954 explicit CallInst(Value *F, const std::string &Name,
955 Instruction *InsertBefore);
956 CallInst(Value *F, const std::string &Name, BasicBlock *InsertAtEnd);
958 template<typename InputIterator>
959 static CallInst *Create(Value *Func,
960 InputIterator ArgBegin, InputIterator ArgEnd,
961 const std::string &Name = "",
962 Instruction *InsertBefore = 0) {
963 return new(ArgEnd - ArgBegin + 1)
964 CallInst(Func, ArgBegin, ArgEnd, Name, InsertBefore);
966 template<typename InputIterator>
967 static CallInst *Create(Value *Func,
968 InputIterator ArgBegin, InputIterator ArgEnd,
969 const std::string &Name, BasicBlock *InsertAtEnd) {
970 return new(ArgEnd - ArgBegin + 1)
971 CallInst(Func, ArgBegin, ArgEnd, Name, InsertAtEnd);
973 static CallInst *Create(Value *F, Value *Actual, const std::string& Name = "",
974 Instruction *InsertBefore = 0) {
975 return new(2) CallInst(F, Actual, Name, InsertBefore);
977 static CallInst *Create(Value *F, Value *Actual, const std::string& Name,
978 BasicBlock *InsertAtEnd) {
979 return new(2) CallInst(F, Actual, Name, InsertAtEnd);
981 static CallInst *Create(Value *F, const std::string &Name = "",
982 Instruction *InsertBefore = 0) {
983 return new(1) CallInst(F, Name, InsertBefore);
985 static CallInst *Create(Value *F, const std::string &Name,
986 BasicBlock *InsertAtEnd) {
987 return new(1) CallInst(F, Name, InsertAtEnd);
992 virtual CallInst *clone() const;
994 /// Provide fast operand accessors
995 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
997 bool isTailCall() const { return SubclassData & 1; }
998 void setTailCall(bool isTailCall = true) {
999 SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
1002 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1004 unsigned getCallingConv() const { return SubclassData >> 1; }
1005 void setCallingConv(unsigned CC) {
1006 SubclassData = (SubclassData & 1) | (CC << 1);
1009 /// getParamAttrs - Return the parameter attributes for this call.
1011 const PAListPtr &getParamAttrs() const { return ParamAttrs; }
1013 /// setParamAttrs - Sets the parameter attributes for this call.
1014 void setParamAttrs(const PAListPtr &Attrs) { ParamAttrs = Attrs; }
1016 /// @brief Determine whether the call or the callee has the given attribute.
1017 bool paramHasAttr(unsigned i, unsigned attr) const;
1019 /// @brief Extract the alignment for a call or parameter (0=unknown).
1020 unsigned getParamAlignment(unsigned i) const {
1021 return ParamAttrs.getParamAlignment(i);
1024 /// @brief Determine if the call does not access memory.
1025 bool doesNotAccessMemory() const {
1026 return paramHasAttr(0, ParamAttr::ReadNone);
1029 /// @brief Determine if the call does not access or only reads memory.
1030 bool onlyReadsMemory() const {
1031 return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
1034 /// @brief Determine if the call cannot return.
1035 bool doesNotReturn() const {
1036 return paramHasAttr(0, ParamAttr::NoReturn);
1039 /// @brief Determine if the call cannot unwind.
1040 bool doesNotThrow() const {
1041 return paramHasAttr(0, ParamAttr::NoUnwind);
1043 void setDoesNotThrow(bool doesNotThrow = true);
1045 /// @brief Determine if the call returns a structure through first
1046 /// pointer argument.
1047 bool hasStructRetAttr() const {
1048 // Be friendly and also check the callee.
1049 return paramHasAttr(1, ParamAttr::StructRet);
1052 /// @brief Determine if any call argument is an aggregate passed by value.
1053 bool hasByValArgument() const {
1054 return ParamAttrs.hasAttrSomewhere(ParamAttr::ByVal);
1057 /// getCalledFunction - Return the function being called by this instruction
1058 /// if it is a direct call. If it is a call through a function pointer,
1060 Function *getCalledFunction() const {
1061 return dyn_cast<Function>(getOperand(0));
1064 /// getCalledValue - Get a pointer to the function that is invoked by this
1066 const Value *getCalledValue() const { return getOperand(0); }
1067 Value *getCalledValue() { return getOperand(0); }
1069 // Methods for support type inquiry through isa, cast, and dyn_cast:
1070 static inline bool classof(const CallInst *) { return true; }
1071 static inline bool classof(const Instruction *I) {
1072 return I->getOpcode() == Instruction::Call;
1074 static inline bool classof(const Value *V) {
1075 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1080 struct OperandTraits<CallInst> : VariadicOperandTraits<1> {
1083 template<typename InputIterator>
1084 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1085 const std::string &Name, BasicBlock *InsertAtEnd)
1086 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1087 ->getElementType())->getReturnType(),
1089 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1090 (unsigned)(ArgEnd - ArgBegin + 1), InsertAtEnd) {
1091 init(Func, ArgBegin, ArgEnd, Name,
1092 typename std::iterator_traits<InputIterator>::iterator_category());
1095 template<typename InputIterator>
1096 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1097 const std::string &Name, Instruction *InsertBefore)
1098 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1099 ->getElementType())->getReturnType(),
1101 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1102 (unsigned)(ArgEnd - ArgBegin + 1), InsertBefore) {
1103 init(Func, ArgBegin, ArgEnd, Name,
1104 typename std::iterator_traits<InputIterator>::iterator_category());
1107 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1109 //===----------------------------------------------------------------------===//
1111 //===----------------------------------------------------------------------===//
1113 /// SelectInst - This class represents the LLVM 'select' instruction.
1115 class SelectInst : public Instruction {
1116 void init(Value *C, Value *S1, Value *S2) {
1122 SelectInst(const SelectInst &SI)
1123 : Instruction(SI.getType(), SI.getOpcode(), &Op<0>(), 3) {
1124 init(SI.Op<0>(), SI.Op<1>(), SI.Op<2>());
1126 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
1127 Instruction *InsertBefore)
1128 : Instruction(S1->getType(), Instruction::Select,
1129 &Op<0>(), 3, InsertBefore) {
1133 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
1134 BasicBlock *InsertAtEnd)
1135 : Instruction(S1->getType(), Instruction::Select,
1136 &Op<0>(), 3, InsertAtEnd) {
1141 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1142 const std::string &Name = "",
1143 Instruction *InsertBefore = 0) {
1144 return new(3) SelectInst(C, S1, S2, Name, InsertBefore);
1146 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1147 const std::string &Name, BasicBlock *InsertAtEnd) {
1148 return new(3) SelectInst(C, S1, S2, Name, InsertAtEnd);
1151 Value *getCondition() const { return Op<0>(); }
1152 Value *getTrueValue() const { return Op<1>(); }
1153 Value *getFalseValue() const { return Op<2>(); }
1155 /// Transparently provide more efficient getOperand methods.
1156 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1158 OtherOps getOpcode() const {
1159 return static_cast<OtherOps>(Instruction::getOpcode());
1162 virtual SelectInst *clone() const;
1164 // Methods for support type inquiry through isa, cast, and dyn_cast:
1165 static inline bool classof(const SelectInst *) { return true; }
1166 static inline bool classof(const Instruction *I) {
1167 return I->getOpcode() == Instruction::Select;
1169 static inline bool classof(const Value *V) {
1170 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1175 struct OperandTraits<SelectInst> : FixedNumOperandTraits<3> {
1178 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1180 //===----------------------------------------------------------------------===//
1182 //===----------------------------------------------------------------------===//
1184 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1185 /// an argument of the specified type given a va_list and increments that list
1187 class VAArgInst : public UnaryInstruction {
1188 VAArgInst(const VAArgInst &VAA)
1189 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
1191 VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
1192 Instruction *InsertBefore = 0)
1193 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1196 VAArgInst(Value *List, const Type *Ty, const std::string &Name,
1197 BasicBlock *InsertAtEnd)
1198 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1202 virtual VAArgInst *clone() const;
1204 // Methods for support type inquiry through isa, cast, and dyn_cast:
1205 static inline bool classof(const VAArgInst *) { return true; }
1206 static inline bool classof(const Instruction *I) {
1207 return I->getOpcode() == VAArg;
1209 static inline bool classof(const Value *V) {
1210 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1214 //===----------------------------------------------------------------------===//
1215 // ExtractElementInst Class
1216 //===----------------------------------------------------------------------===//
1218 /// ExtractElementInst - This instruction extracts a single (scalar)
1219 /// element from a VectorType value
1221 class ExtractElementInst : public Instruction {
1222 ExtractElementInst(const ExtractElementInst &EE) :
1223 Instruction(EE.getType(), ExtractElement, &Op<0>(), 2) {
1224 Op<0>().init(EE.Op<0>(), this);
1225 Op<1>().init(EE.Op<1>(), this);
1229 // allocate space for exactly two operands
1230 void *operator new(size_t s) {
1231 return User::operator new(s, 2); // FIXME: "unsigned Idx" forms of ctor?
1233 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
1234 Instruction *InsertBefore = 0);
1235 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name = "",
1236 Instruction *InsertBefore = 0);
1237 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
1238 BasicBlock *InsertAtEnd);
1239 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name,
1240 BasicBlock *InsertAtEnd);
1242 /// isValidOperands - Return true if an extractelement instruction can be
1243 /// formed with the specified operands.
1244 static bool isValidOperands(const Value *Vec, const Value *Idx);
1246 virtual ExtractElementInst *clone() const;
1248 /// Transparently provide more efficient getOperand methods.
1249 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1251 // Methods for support type inquiry through isa, cast, and dyn_cast:
1252 static inline bool classof(const ExtractElementInst *) { return true; }
1253 static inline bool classof(const Instruction *I) {
1254 return I->getOpcode() == Instruction::ExtractElement;
1256 static inline bool classof(const Value *V) {
1257 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1262 struct OperandTraits<ExtractElementInst> : FixedNumOperandTraits<2> {
1265 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1267 //===----------------------------------------------------------------------===//
1268 // InsertElementInst Class
1269 //===----------------------------------------------------------------------===//
1271 /// InsertElementInst - This instruction inserts a single (scalar)
1272 /// element into a VectorType value
1274 class InsertElementInst : public Instruction {
1275 InsertElementInst(const InsertElementInst &IE);
1276 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1277 const std::string &Name = "",Instruction *InsertBefore = 0);
1278 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1279 const std::string &Name = "",Instruction *InsertBefore = 0);
1280 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1281 const std::string &Name, BasicBlock *InsertAtEnd);
1282 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1283 const std::string &Name, BasicBlock *InsertAtEnd);
1285 static InsertElementInst *Create(const InsertElementInst &IE) {
1286 return new(IE.getNumOperands()) InsertElementInst(IE);
1288 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1289 const std::string &Name = "",
1290 Instruction *InsertBefore = 0) {
1291 return new(3) InsertElementInst(Vec, NewElt, Idx, Name, InsertBefore);
1293 static InsertElementInst *Create(Value *Vec, Value *NewElt, unsigned Idx,
1294 const std::string &Name = "",
1295 Instruction *InsertBefore = 0) {
1296 return new(3) InsertElementInst(Vec, NewElt, Idx, Name, InsertBefore);
1298 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1299 const std::string &Name,
1300 BasicBlock *InsertAtEnd) {
1301 return new(3) InsertElementInst(Vec, NewElt, Idx, Name, InsertAtEnd);
1303 static InsertElementInst *Create(Value *Vec, Value *NewElt, unsigned Idx,
1304 const std::string &Name,
1305 BasicBlock *InsertAtEnd) {
1306 return new(3) InsertElementInst(Vec, NewElt, Idx, Name, InsertAtEnd);
1309 /// isValidOperands - Return true if an insertelement instruction can be
1310 /// formed with the specified operands.
1311 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1314 virtual InsertElementInst *clone() const;
1316 /// getType - Overload to return most specific vector type.
1318 const VectorType *getType() const {
1319 return reinterpret_cast<const VectorType*>(Instruction::getType());
1322 /// Transparently provide more efficient getOperand methods.
1323 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1325 // Methods for support type inquiry through isa, cast, and dyn_cast:
1326 static inline bool classof(const InsertElementInst *) { return true; }
1327 static inline bool classof(const Instruction *I) {
1328 return I->getOpcode() == Instruction::InsertElement;
1330 static inline bool classof(const Value *V) {
1331 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1336 struct OperandTraits<InsertElementInst> : FixedNumOperandTraits<3> {
1339 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1341 //===----------------------------------------------------------------------===//
1342 // ShuffleVectorInst Class
1343 //===----------------------------------------------------------------------===//
1345 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1348 class ShuffleVectorInst : public Instruction {
1349 ShuffleVectorInst(const ShuffleVectorInst &IE);
1351 // allocate space for exactly three operands
1352 void *operator new(size_t s) {
1353 return User::operator new(s, 3);
1355 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1356 const std::string &Name = "", Instruction *InsertBefor = 0);
1357 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1358 const std::string &Name, BasicBlock *InsertAtEnd);
1360 /// isValidOperands - Return true if a shufflevector instruction can be
1361 /// formed with the specified operands.
1362 static bool isValidOperands(const Value *V1, const Value *V2,
1365 virtual ShuffleVectorInst *clone() const;
1367 /// getType - Overload to return most specific vector type.
1369 const VectorType *getType() const {
1370 return reinterpret_cast<const VectorType*>(Instruction::getType());
1373 /// Transparently provide more efficient getOperand methods.
1374 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1376 /// getMaskValue - Return the index from the shuffle mask for the specified
1377 /// output result. This is either -1 if the element is undef or a number less
1378 /// than 2*numelements.
1379 int getMaskValue(unsigned i) const;
1381 // Methods for support type inquiry through isa, cast, and dyn_cast:
1382 static inline bool classof(const ShuffleVectorInst *) { return true; }
1383 static inline bool classof(const Instruction *I) {
1384 return I->getOpcode() == Instruction::ShuffleVector;
1386 static inline bool classof(const Value *V) {
1387 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1392 struct OperandTraits<ShuffleVectorInst> : FixedNumOperandTraits<3> {
1395 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1397 //===----------------------------------------------------------------------===//
1399 //===----------------------------------------------------------------------===//
1401 // PHINode - The PHINode class is used to represent the magical mystical PHI
1402 // node, that can not exist in nature, but can be synthesized in a computer
1403 // scientist's overactive imagination.
1405 class PHINode : public Instruction {
1406 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1407 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1408 /// the number actually in use.
1409 unsigned ReservedSpace;
1410 PHINode(const PHINode &PN);
1411 // allocate space for exactly zero operands
1412 void *operator new(size_t s) {
1413 return User::operator new(s, 0);
1415 explicit PHINode(const Type *Ty, const std::string &Name = "",
1416 Instruction *InsertBefore = 0)
1417 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1422 PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
1423 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1428 static PHINode *Create(const Type *Ty, const std::string &Name = "",
1429 Instruction *InsertBefore = 0) {
1430 return new PHINode(Ty, Name, InsertBefore);
1432 static PHINode *Create(const Type *Ty, const std::string &Name,
1433 BasicBlock *InsertAtEnd) {
1434 return new PHINode(Ty, Name, InsertAtEnd);
1438 /// reserveOperandSpace - This method can be used to avoid repeated
1439 /// reallocation of PHI operand lists by reserving space for the correct
1440 /// number of operands before adding them. Unlike normal vector reserves,
1441 /// this method can also be used to trim the operand space.
1442 void reserveOperandSpace(unsigned NumValues) {
1443 resizeOperands(NumValues*2);
1446 virtual PHINode *clone() const;
1448 /// Provide fast operand accessors
1449 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1451 /// getNumIncomingValues - Return the number of incoming edges
1453 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1455 /// getIncomingValue - Return incoming value number x
1457 Value *getIncomingValue(unsigned i) const {
1458 assert(i*2 < getNumOperands() && "Invalid value number!");
1459 return getOperand(i*2);
1461 void setIncomingValue(unsigned i, Value *V) {
1462 assert(i*2 < getNumOperands() && "Invalid value number!");
1465 unsigned getOperandNumForIncomingValue(unsigned i) {
1469 /// getIncomingBlock - Return incoming basic block number x
1471 BasicBlock *getIncomingBlock(unsigned i) const {
1472 return static_cast<BasicBlock*>(getOperand(i*2+1));
1474 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1475 setOperand(i*2+1, BB);
1477 unsigned getOperandNumForIncomingBlock(unsigned i) {
1481 /// addIncoming - Add an incoming value to the end of the PHI list
1483 void addIncoming(Value *V, BasicBlock *BB) {
1484 assert(V && "PHI node got a null value!");
1485 assert(BB && "PHI node got a null basic block!");
1486 assert(getType() == V->getType() &&
1487 "All operands to PHI node must be the same type as the PHI node!");
1488 unsigned OpNo = NumOperands;
1489 if (OpNo+2 > ReservedSpace)
1490 resizeOperands(0); // Get more space!
1491 // Initialize some new operands.
1492 NumOperands = OpNo+2;
1493 OperandList[OpNo].init(V, this);
1494 OperandList[OpNo+1].init(BB, this);
1497 /// removeIncomingValue - Remove an incoming value. This is useful if a
1498 /// predecessor basic block is deleted. The value removed is returned.
1500 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1501 /// is true), the PHI node is destroyed and any uses of it are replaced with
1502 /// dummy values. The only time there should be zero incoming values to a PHI
1503 /// node is when the block is dead, so this strategy is sound.
1505 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1507 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
1508 int Idx = getBasicBlockIndex(BB);
1509 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1510 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1513 /// getBasicBlockIndex - Return the first index of the specified basic
1514 /// block in the value list for this PHI. Returns -1 if no instance.
1516 int getBasicBlockIndex(const BasicBlock *BB) const {
1517 Use *OL = OperandList;
1518 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1519 if (OL[i+1].get() == BB) return i/2;
1523 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1524 return getIncomingValue(getBasicBlockIndex(BB));
1527 /// hasConstantValue - If the specified PHI node always merges together the
1528 /// same value, return the value, otherwise return null.
1530 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1532 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1533 static inline bool classof(const PHINode *) { return true; }
1534 static inline bool classof(const Instruction *I) {
1535 return I->getOpcode() == Instruction::PHI;
1537 static inline bool classof(const Value *V) {
1538 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1541 void resizeOperands(unsigned NumOperands);
1545 struct OperandTraits<PHINode> : HungoffOperandTraits<2> {
1548 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
1551 //===----------------------------------------------------------------------===//
1553 //===----------------------------------------------------------------------===//
1555 //===---------------------------------------------------------------------------
1556 /// ReturnInst - Return a value (possibly void), from a function. Execution
1557 /// does not continue in this function any longer.
1559 class ReturnInst : public TerminatorInst {
1560 ReturnInst(const ReturnInst &RI);
1561 void init(Value * const* retVals, unsigned N);
1564 // ReturnInst constructors:
1565 // ReturnInst() - 'ret void' instruction
1566 // ReturnInst( null) - 'ret void' instruction
1567 // ReturnInst(Value* X) - 'ret X' instruction
1568 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
1569 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
1570 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
1571 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
1572 // ReturnInst(Value* X, N) - 'ret X,X+1...X+N-1' instruction
1573 // ReturnInst(Value* X, N, Inst *I) - 'ret X,X+1...X+N-1', insert before I
1574 // ReturnInst(Value* X, N, BB *B) - 'ret X,X+1...X+N-1', insert @ end of B
1576 // NOTE: If the Value* passed is of type void then the constructor behaves as
1577 // if it was passed NULL.
1578 explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0);
1579 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd);
1580 ReturnInst(Value * const* retVals, unsigned N, Instruction *InsertBefore = 0);
1581 ReturnInst(Value * const* retVals, unsigned N, BasicBlock *InsertAtEnd);
1582 explicit ReturnInst(BasicBlock *InsertAtEnd);
1584 static ReturnInst* Create(Value *retVal = 0, Instruction *InsertBefore = 0) {
1585 return new(!!retVal) ReturnInst(retVal, InsertBefore);
1587 static ReturnInst* Create(Value *retVal, BasicBlock *InsertAtEnd) {
1588 return new(!!retVal) ReturnInst(retVal, InsertAtEnd);
1590 static ReturnInst* Create(Value * const* retVals, unsigned N,
1591 Instruction *InsertBefore = 0) {
1592 return new(N) ReturnInst(retVals, N, InsertBefore);
1594 static ReturnInst* Create(Value * const* retVals, unsigned N,
1595 BasicBlock *InsertAtEnd) {
1596 return new(N) ReturnInst(retVals, N, InsertAtEnd);
1598 static ReturnInst* Create(BasicBlock *InsertAtEnd) {
1599 return new(0) ReturnInst(InsertAtEnd);
1601 virtual ~ReturnInst();
1602 inline void operator delete(void*);
1604 virtual ReturnInst *clone() const;
1606 /// Provide fast operand accessors
1607 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1609 /// Convenience accessor
1610 Value *getReturnValue(unsigned n = 0) const {
1611 return n < getNumOperands()
1616 unsigned getNumSuccessors() const { return 0; }
1618 // Methods for support type inquiry through isa, cast, and dyn_cast:
1619 static inline bool classof(const ReturnInst *) { return true; }
1620 static inline bool classof(const Instruction *I) {
1621 return (I->getOpcode() == Instruction::Ret);
1623 static inline bool classof(const Value *V) {
1624 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1627 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1628 virtual unsigned getNumSuccessorsV() const;
1629 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1633 struct OperandTraits<ReturnInst> : VariadicOperandTraits<> {
1636 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
1637 void ReturnInst::operator delete(void *it) {
1638 ReturnInst* me(static_cast<ReturnInst*>(it));
1639 Use::zap(OperandTraits<ReturnInst>::op_begin(me),
1640 OperandTraits<ReturnInst>::op_end(me),
1644 //===----------------------------------------------------------------------===//
1646 //===----------------------------------------------------------------------===//
1648 //===---------------------------------------------------------------------------
1649 /// BranchInst - Conditional or Unconditional Branch instruction.
1651 class BranchInst : public TerminatorInst {
1652 /// Ops list - Branches are strange. The operands are ordered:
1653 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
1654 /// they don't have to check for cond/uncond branchness.
1655 BranchInst(const BranchInst &BI);
1657 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
1658 // BranchInst(BB *B) - 'br B'
1659 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
1660 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
1661 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
1662 // BranchInst(BB* B, BB *I) - 'br B' insert at end
1663 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
1664 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
1665 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1666 Instruction *InsertBefore = 0);
1667 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
1668 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1669 BasicBlock *InsertAtEnd);
1671 static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
1672 return new(1) BranchInst(IfTrue, InsertBefore);
1674 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
1675 Value *Cond, Instruction *InsertBefore = 0) {
1676 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
1678 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
1679 return new(1) BranchInst(IfTrue, InsertAtEnd);
1681 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
1682 Value *Cond, BasicBlock *InsertAtEnd) {
1683 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
1687 if (NumOperands == 1)
1688 NumOperands = (unsigned)(uintptr_t)((Use*)this - OperandList);
1691 /// Transparently provide more efficient getOperand methods.
1692 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1694 virtual BranchInst *clone() const;
1696 bool isUnconditional() const { return getNumOperands() == 1; }
1697 bool isConditional() const { return getNumOperands() == 3; }
1699 Value *getCondition() const {
1700 assert(isConditional() && "Cannot get condition of an uncond branch!");
1701 return getOperand(2);
1704 void setCondition(Value *V) {
1705 assert(isConditional() && "Cannot set condition of unconditional branch!");
1709 // setUnconditionalDest - Change the current branch to an unconditional branch
1710 // targeting the specified block.
1711 // FIXME: Eliminate this ugly method.
1712 void setUnconditionalDest(BasicBlock *Dest) {
1714 if (isConditional()) { // Convert this to an uncond branch.
1721 unsigned getNumSuccessors() const { return 1+isConditional(); }
1723 BasicBlock *getSuccessor(unsigned i) const {
1724 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
1725 return cast<BasicBlock>(getOperand(i));
1728 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1729 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
1730 setOperand(idx, NewSucc);
1733 // Methods for support type inquiry through isa, cast, and dyn_cast:
1734 static inline bool classof(const BranchInst *) { return true; }
1735 static inline bool classof(const Instruction *I) {
1736 return (I->getOpcode() == Instruction::Br);
1738 static inline bool classof(const Value *V) {
1739 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1742 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1743 virtual unsigned getNumSuccessorsV() const;
1744 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1748 struct OperandTraits<BranchInst> : HungoffOperandTraits<> {
1749 // we need to access operands via OperandList, since
1750 // the NumOperands may change from 3 to 1
1751 static inline void *allocate(unsigned); // FIXME
1754 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
1756 //===----------------------------------------------------------------------===//
1758 //===----------------------------------------------------------------------===//
1760 //===---------------------------------------------------------------------------
1761 /// SwitchInst - Multiway switch
1763 class SwitchInst : public TerminatorInst {
1764 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1765 unsigned ReservedSpace;
1766 // Operand[0] = Value to switch on
1767 // Operand[1] = Default basic block destination
1768 // Operand[2n ] = Value to match
1769 // Operand[2n+1] = BasicBlock to go to on match
1770 SwitchInst(const SwitchInst &RI);
1771 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1772 void resizeOperands(unsigned No);
1773 // allocate space for exactly zero operands
1774 void *operator new(size_t s) {
1775 return User::operator new(s, 0);
1777 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1778 /// switch on and a default destination. The number of additional cases can
1779 /// be specified here to make memory allocation more efficient. This
1780 /// constructor can also autoinsert before another instruction.
1781 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1782 Instruction *InsertBefore = 0);
1784 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1785 /// switch on and a default destination. The number of additional cases can
1786 /// be specified here to make memory allocation more efficient. This
1787 /// constructor also autoinserts at the end of the specified BasicBlock.
1788 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1789 BasicBlock *InsertAtEnd);
1791 static SwitchInst *Create(Value *Value, BasicBlock *Default,
1792 unsigned NumCases, Instruction *InsertBefore = 0) {
1793 return new SwitchInst(Value, Default, NumCases, InsertBefore);
1795 static SwitchInst *Create(Value *Value, BasicBlock *Default,
1796 unsigned NumCases, BasicBlock *InsertAtEnd) {
1797 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
1801 /// Provide fast operand accessors
1802 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1804 // Accessor Methods for Switch stmt
1805 Value *getCondition() const { return getOperand(0); }
1806 void setCondition(Value *V) { setOperand(0, V); }
1808 BasicBlock *getDefaultDest() const {
1809 return cast<BasicBlock>(getOperand(1));
1812 /// getNumCases - return the number of 'cases' in this switch instruction.
1813 /// Note that case #0 is always the default case.
1814 unsigned getNumCases() const {
1815 return getNumOperands()/2;
1818 /// getCaseValue - Return the specified case value. Note that case #0, the
1819 /// default destination, does not have a case value.
1820 ConstantInt *getCaseValue(unsigned i) {
1821 assert(i && i < getNumCases() && "Illegal case value to get!");
1822 return getSuccessorValue(i);
1825 /// getCaseValue - Return the specified case value. Note that case #0, the
1826 /// default destination, does not have a case value.
1827 const ConstantInt *getCaseValue(unsigned i) const {
1828 assert(i && i < getNumCases() && "Illegal case value to get!");
1829 return getSuccessorValue(i);
1832 /// findCaseValue - Search all of the case values for the specified constant.
1833 /// If it is explicitly handled, return the case number of it, otherwise
1834 /// return 0 to indicate that it is handled by the default handler.
1835 unsigned findCaseValue(const ConstantInt *C) const {
1836 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1837 if (getCaseValue(i) == C)
1842 /// findCaseDest - Finds the unique case value for a given successor. Returns
1843 /// null if the successor is not found, not unique, or is the default case.
1844 ConstantInt *findCaseDest(BasicBlock *BB) {
1845 if (BB == getDefaultDest()) return NULL;
1847 ConstantInt *CI = NULL;
1848 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
1849 if (getSuccessor(i) == BB) {
1850 if (CI) return NULL; // Multiple cases lead to BB.
1851 else CI = getCaseValue(i);
1857 /// addCase - Add an entry to the switch instruction...
1859 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1861 /// removeCase - This method removes the specified successor from the switch
1862 /// instruction. Note that this cannot be used to remove the default
1863 /// destination (successor #0).
1865 void removeCase(unsigned idx);
1867 virtual SwitchInst *clone() const;
1869 unsigned getNumSuccessors() const { return getNumOperands()/2; }
1870 BasicBlock *getSuccessor(unsigned idx) const {
1871 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1872 return cast<BasicBlock>(getOperand(idx*2+1));
1874 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1875 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1876 setOperand(idx*2+1, NewSucc);
1879 // getSuccessorValue - Return the value associated with the specified
1881 ConstantInt *getSuccessorValue(unsigned idx) const {
1882 assert(idx < getNumSuccessors() && "Successor # out of range!");
1883 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1886 // Methods for support type inquiry through isa, cast, and dyn_cast:
1887 static inline bool classof(const SwitchInst *) { return true; }
1888 static inline bool classof(const Instruction *I) {
1889 return I->getOpcode() == Instruction::Switch;
1891 static inline bool classof(const Value *V) {
1892 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1895 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1896 virtual unsigned getNumSuccessorsV() const;
1897 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1901 struct OperandTraits<SwitchInst> : HungoffOperandTraits<2> {
1904 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
1907 //===----------------------------------------------------------------------===//
1909 //===----------------------------------------------------------------------===//
1911 //===---------------------------------------------------------------------------
1913 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
1914 /// calling convention of the call.
1916 class InvokeInst : public TerminatorInst {
1917 PAListPtr ParamAttrs;
1918 InvokeInst(const InvokeInst &BI);
1919 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1920 Value* const *Args, unsigned NumArgs);
1922 template<typename InputIterator>
1923 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1924 InputIterator ArgBegin, InputIterator ArgEnd,
1925 const std::string &Name,
1926 // This argument ensures that we have an iterator we can
1927 // do arithmetic on in constant time
1928 std::random_access_iterator_tag) {
1929 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
1931 // This requires that the iterator points to contiguous memory.
1932 init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
1936 /// Construct an InvokeInst given a range of arguments.
1937 /// InputIterator must be a random-access iterator pointing to
1938 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
1939 /// made for random-accessness but not for contiguous storage as
1940 /// that would incur runtime overhead.
1942 /// @brief Construct an InvokeInst from a range of arguments
1943 template<typename InputIterator>
1944 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1945 InputIterator ArgBegin, InputIterator ArgEnd,
1947 const std::string &Name, Instruction *InsertBefore);
1949 /// Construct an InvokeInst given a range of arguments.
1950 /// InputIterator must be a random-access iterator pointing to
1951 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
1952 /// made for random-accessness but not for contiguous storage as
1953 /// that would incur runtime overhead.
1955 /// @brief Construct an InvokeInst from a range of arguments
1956 template<typename InputIterator>
1957 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1958 InputIterator ArgBegin, InputIterator ArgEnd,
1960 const std::string &Name, BasicBlock *InsertAtEnd);
1962 template<typename InputIterator>
1963 static InvokeInst *Create(Value *Func,
1964 BasicBlock *IfNormal, BasicBlock *IfException,
1965 InputIterator ArgBegin, InputIterator ArgEnd,
1966 const std::string &Name = "",
1967 Instruction *InsertBefore = 0) {
1968 unsigned Values(ArgEnd - ArgBegin + 3);
1969 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
1970 Values, Name, InsertBefore);
1972 template<typename InputIterator>
1973 static InvokeInst *Create(Value *Func,
1974 BasicBlock *IfNormal, BasicBlock *IfException,
1975 InputIterator ArgBegin, InputIterator ArgEnd,
1976 const std::string &Name, BasicBlock *InsertAtEnd) {
1977 unsigned Values(ArgEnd - ArgBegin + 3);
1978 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
1979 Values, Name, InsertAtEnd);
1982 virtual InvokeInst *clone() const;
1984 /// Provide fast operand accessors
1985 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1987 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1989 unsigned getCallingConv() const { return SubclassData; }
1990 void setCallingConv(unsigned CC) {
1994 /// getParamAttrs - Return the parameter attributes for this invoke.
1996 const PAListPtr &getParamAttrs() const { return ParamAttrs; }
1998 /// setParamAttrs - Set the parameter attributes for this invoke.
2000 void setParamAttrs(const PAListPtr &Attrs) { ParamAttrs = Attrs; }
2002 /// @brief Determine whether the call or the callee has the given attribute.
2003 bool paramHasAttr(unsigned i, ParameterAttributes attr) const;
2005 /// @brief Extract the alignment for a call or parameter (0=unknown).
2006 unsigned getParamAlignment(unsigned i) const {
2007 return ParamAttrs.getParamAlignment(i);
2010 /// @brief Determine if the call does not access memory.
2011 bool doesNotAccessMemory() const {
2012 return paramHasAttr(0, ParamAttr::ReadNone);
2015 /// @brief Determine if the call does not access or only reads memory.
2016 bool onlyReadsMemory() const {
2017 return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
2020 /// @brief Determine if the call cannot return.
2021 bool doesNotReturn() const {
2022 return paramHasAttr(0, ParamAttr::NoReturn);
2025 /// @brief Determine if the call cannot unwind.
2026 bool doesNotThrow() const {
2027 return paramHasAttr(0, ParamAttr::NoUnwind);
2029 void setDoesNotThrow(bool doesNotThrow = true);
2031 /// @brief Determine if the call returns a structure through first
2032 /// pointer argument.
2033 bool hasStructRetAttr() const {
2034 // Be friendly and also check the callee.
2035 return paramHasAttr(1, ParamAttr::StructRet);
2038 /// getCalledFunction - Return the function called, or null if this is an
2039 /// indirect function invocation.
2041 Function *getCalledFunction() const {
2042 return dyn_cast<Function>(getOperand(0));
2045 // getCalledValue - Get a pointer to a function that is invoked by this inst.
2046 Value *getCalledValue() const { return getOperand(0); }
2048 // get*Dest - Return the destination basic blocks...
2049 BasicBlock *getNormalDest() const {
2050 return cast<BasicBlock>(getOperand(1));
2052 BasicBlock *getUnwindDest() const {
2053 return cast<BasicBlock>(getOperand(2));
2055 void setNormalDest(BasicBlock *B) {
2059 void setUnwindDest(BasicBlock *B) {
2063 BasicBlock *getSuccessor(unsigned i) const {
2064 assert(i < 2 && "Successor # out of range for invoke!");
2065 return i == 0 ? getNormalDest() : getUnwindDest();
2068 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2069 assert(idx < 2 && "Successor # out of range for invoke!");
2070 setOperand(idx+1, NewSucc);
2073 unsigned getNumSuccessors() const { return 2; }
2075 // Methods for support type inquiry through isa, cast, and dyn_cast:
2076 static inline bool classof(const InvokeInst *) { return true; }
2077 static inline bool classof(const Instruction *I) {
2078 return (I->getOpcode() == Instruction::Invoke);
2080 static inline bool classof(const Value *V) {
2081 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2084 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2085 virtual unsigned getNumSuccessorsV() const;
2086 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2090 struct OperandTraits<InvokeInst> : VariadicOperandTraits<3> {
2093 template<typename InputIterator>
2094 InvokeInst::InvokeInst(Value *Func,
2095 BasicBlock *IfNormal, BasicBlock *IfException,
2096 InputIterator ArgBegin, InputIterator ArgEnd,
2098 const std::string &Name, Instruction *InsertBefore)
2099 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2100 ->getElementType())->getReturnType(),
2101 Instruction::Invoke,
2102 OperandTraits<InvokeInst>::op_end(this) - Values,
2103 Values, InsertBefore) {
2104 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, Name,
2105 typename std::iterator_traits<InputIterator>::iterator_category());
2107 template<typename InputIterator>
2108 InvokeInst::InvokeInst(Value *Func,
2109 BasicBlock *IfNormal, BasicBlock *IfException,
2110 InputIterator ArgBegin, InputIterator ArgEnd,
2112 const std::string &Name, BasicBlock *InsertAtEnd)
2113 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2114 ->getElementType())->getReturnType(),
2115 Instruction::Invoke,
2116 OperandTraits<InvokeInst>::op_end(this) - Values,
2117 Values, InsertAtEnd) {
2118 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, Name,
2119 typename std::iterator_traits<InputIterator>::iterator_category());
2122 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
2124 //===----------------------------------------------------------------------===//
2126 //===----------------------------------------------------------------------===//
2128 //===---------------------------------------------------------------------------
2129 /// UnwindInst - Immediately exit the current function, unwinding the stack
2130 /// until an invoke instruction is found.
2132 class UnwindInst : public TerminatorInst {
2133 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2135 // allocate space for exactly zero operands
2136 void *operator new(size_t s) {
2137 return User::operator new(s, 0);
2139 explicit UnwindInst(Instruction *InsertBefore = 0);
2140 explicit UnwindInst(BasicBlock *InsertAtEnd);
2142 virtual UnwindInst *clone() const;
2144 unsigned getNumSuccessors() const { return 0; }
2146 // Methods for support type inquiry through isa, cast, and dyn_cast:
2147 static inline bool classof(const UnwindInst *) { return true; }
2148 static inline bool classof(const Instruction *I) {
2149 return I->getOpcode() == Instruction::Unwind;
2151 static inline bool classof(const Value *V) {
2152 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2155 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2156 virtual unsigned getNumSuccessorsV() const;
2157 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2160 //===----------------------------------------------------------------------===//
2161 // UnreachableInst Class
2162 //===----------------------------------------------------------------------===//
2164 //===---------------------------------------------------------------------------
2165 /// UnreachableInst - This function has undefined behavior. In particular, the
2166 /// presence of this instruction indicates some higher level knowledge that the
2167 /// end of the block cannot be reached.
2169 class UnreachableInst : public TerminatorInst {
2170 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2172 // allocate space for exactly zero operands
2173 void *operator new(size_t s) {
2174 return User::operator new(s, 0);
2176 explicit UnreachableInst(Instruction *InsertBefore = 0);
2177 explicit UnreachableInst(BasicBlock *InsertAtEnd);
2179 virtual UnreachableInst *clone() const;
2181 unsigned getNumSuccessors() const { return 0; }
2183 // Methods for support type inquiry through isa, cast, and dyn_cast:
2184 static inline bool classof(const UnreachableInst *) { return true; }
2185 static inline bool classof(const Instruction *I) {
2186 return I->getOpcode() == Instruction::Unreachable;
2188 static inline bool classof(const Value *V) {
2189 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2192 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2193 virtual unsigned getNumSuccessorsV() const;
2194 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2197 //===----------------------------------------------------------------------===//
2199 //===----------------------------------------------------------------------===//
2201 /// @brief This class represents a truncation of integer types.
2202 class TruncInst : public CastInst {
2203 /// Private copy constructor
2204 TruncInst(const TruncInst &CI)
2205 : CastInst(CI.getType(), Trunc, CI.getOperand(0)) {
2208 /// @brief Constructor with insert-before-instruction semantics
2210 Value *S, ///< The value to be truncated
2211 const Type *Ty, ///< The (smaller) type to truncate to
2212 const std::string &Name = "", ///< A name for the new instruction
2213 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2216 /// @brief Constructor with insert-at-end-of-block semantics
2218 Value *S, ///< The value to be truncated
2219 const Type *Ty, ///< The (smaller) type to truncate to
2220 const std::string &Name, ///< A name for the new instruction
2221 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2224 /// @brief Clone an identical TruncInst
2225 virtual CastInst *clone() const;
2227 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2228 static inline bool classof(const TruncInst *) { return true; }
2229 static inline bool classof(const Instruction *I) {
2230 return I->getOpcode() == Trunc;
2232 static inline bool classof(const Value *V) {
2233 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2237 //===----------------------------------------------------------------------===//
2239 //===----------------------------------------------------------------------===//
2241 /// @brief This class represents zero extension of integer types.
2242 class ZExtInst : public CastInst {
2243 /// @brief Private copy constructor
2244 ZExtInst(const ZExtInst &CI)
2245 : CastInst(CI.getType(), ZExt, CI.getOperand(0)) {
2248 /// @brief Constructor with insert-before-instruction semantics
2250 Value *S, ///< The value to be zero extended
2251 const Type *Ty, ///< The type to zero extend to
2252 const std::string &Name = "", ///< A name for the new instruction
2253 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2256 /// @brief Constructor with insert-at-end semantics.
2258 Value *S, ///< The value to be zero extended
2259 const Type *Ty, ///< The type to zero extend to
2260 const std::string &Name, ///< A name for the new instruction
2261 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2264 /// @brief Clone an identical ZExtInst
2265 virtual CastInst *clone() const;
2267 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2268 static inline bool classof(const ZExtInst *) { return true; }
2269 static inline bool classof(const Instruction *I) {
2270 return I->getOpcode() == ZExt;
2272 static inline bool classof(const Value *V) {
2273 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2277 //===----------------------------------------------------------------------===//
2279 //===----------------------------------------------------------------------===//
2281 /// @brief This class represents a sign extension of integer types.
2282 class SExtInst : public CastInst {
2283 /// @brief Private copy constructor
2284 SExtInst(const SExtInst &CI)
2285 : CastInst(CI.getType(), SExt, CI.getOperand(0)) {
2288 /// @brief Constructor with insert-before-instruction semantics
2290 Value *S, ///< The value to be sign extended
2291 const Type *Ty, ///< The type to sign extend to
2292 const std::string &Name = "", ///< A name for the new instruction
2293 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2296 /// @brief Constructor with insert-at-end-of-block semantics
2298 Value *S, ///< The value to be sign extended
2299 const Type *Ty, ///< The type to sign extend to
2300 const std::string &Name, ///< A name for the new instruction
2301 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2304 /// @brief Clone an identical SExtInst
2305 virtual CastInst *clone() const;
2307 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2308 static inline bool classof(const SExtInst *) { return true; }
2309 static inline bool classof(const Instruction *I) {
2310 return I->getOpcode() == SExt;
2312 static inline bool classof(const Value *V) {
2313 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2317 //===----------------------------------------------------------------------===//
2318 // FPTruncInst Class
2319 //===----------------------------------------------------------------------===//
2321 /// @brief This class represents a truncation of floating point types.
2322 class FPTruncInst : public CastInst {
2323 FPTruncInst(const FPTruncInst &CI)
2324 : CastInst(CI.getType(), FPTrunc, CI.getOperand(0)) {
2327 /// @brief Constructor with insert-before-instruction semantics
2329 Value *S, ///< The value to be truncated
2330 const Type *Ty, ///< The type to truncate to
2331 const std::string &Name = "", ///< A name for the new instruction
2332 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2335 /// @brief Constructor with insert-before-instruction semantics
2337 Value *S, ///< The value to be truncated
2338 const Type *Ty, ///< The type to truncate to
2339 const std::string &Name, ///< A name for the new instruction
2340 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2343 /// @brief Clone an identical FPTruncInst
2344 virtual CastInst *clone() const;
2346 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2347 static inline bool classof(const FPTruncInst *) { return true; }
2348 static inline bool classof(const Instruction *I) {
2349 return I->getOpcode() == FPTrunc;
2351 static inline bool classof(const Value *V) {
2352 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2356 //===----------------------------------------------------------------------===//
2358 //===----------------------------------------------------------------------===//
2360 /// @brief This class represents an extension of floating point types.
2361 class FPExtInst : public CastInst {
2362 FPExtInst(const FPExtInst &CI)
2363 : CastInst(CI.getType(), FPExt, CI.getOperand(0)) {
2366 /// @brief Constructor with insert-before-instruction semantics
2368 Value *S, ///< The value to be extended
2369 const Type *Ty, ///< The type to extend to
2370 const std::string &Name = "", ///< A name for the new instruction
2371 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2374 /// @brief Constructor with insert-at-end-of-block semantics
2376 Value *S, ///< The value to be extended
2377 const Type *Ty, ///< The type to extend to
2378 const std::string &Name, ///< A name for the new instruction
2379 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2382 /// @brief Clone an identical FPExtInst
2383 virtual CastInst *clone() const;
2385 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2386 static inline bool classof(const FPExtInst *) { return true; }
2387 static inline bool classof(const Instruction *I) {
2388 return I->getOpcode() == FPExt;
2390 static inline bool classof(const Value *V) {
2391 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2395 //===----------------------------------------------------------------------===//
2397 //===----------------------------------------------------------------------===//
2399 /// @brief This class represents a cast unsigned integer to floating point.
2400 class UIToFPInst : public CastInst {
2401 UIToFPInst(const UIToFPInst &CI)
2402 : CastInst(CI.getType(), UIToFP, CI.getOperand(0)) {
2405 /// @brief Constructor with insert-before-instruction semantics
2407 Value *S, ///< The value to be converted
2408 const Type *Ty, ///< The type to convert to
2409 const std::string &Name = "", ///< A name for the new instruction
2410 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2413 /// @brief Constructor with insert-at-end-of-block semantics
2415 Value *S, ///< The value to be converted
2416 const Type *Ty, ///< The type to convert to
2417 const std::string &Name, ///< A name for the new instruction
2418 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2421 /// @brief Clone an identical UIToFPInst
2422 virtual CastInst *clone() const;
2424 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2425 static inline bool classof(const UIToFPInst *) { return true; }
2426 static inline bool classof(const Instruction *I) {
2427 return I->getOpcode() == UIToFP;
2429 static inline bool classof(const Value *V) {
2430 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2434 //===----------------------------------------------------------------------===//
2436 //===----------------------------------------------------------------------===//
2438 /// @brief This class represents a cast from signed integer to floating point.
2439 class SIToFPInst : public CastInst {
2440 SIToFPInst(const SIToFPInst &CI)
2441 : CastInst(CI.getType(), SIToFP, CI.getOperand(0)) {
2444 /// @brief Constructor with insert-before-instruction semantics
2446 Value *S, ///< The value to be converted
2447 const Type *Ty, ///< The type to convert to
2448 const std::string &Name = "", ///< A name for the new instruction
2449 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2452 /// @brief Constructor with insert-at-end-of-block semantics
2454 Value *S, ///< The value to be converted
2455 const Type *Ty, ///< The type to convert to
2456 const std::string &Name, ///< A name for the new instruction
2457 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2460 /// @brief Clone an identical SIToFPInst
2461 virtual CastInst *clone() const;
2463 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2464 static inline bool classof(const SIToFPInst *) { return true; }
2465 static inline bool classof(const Instruction *I) {
2466 return I->getOpcode() == SIToFP;
2468 static inline bool classof(const Value *V) {
2469 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2473 //===----------------------------------------------------------------------===//
2475 //===----------------------------------------------------------------------===//
2477 /// @brief This class represents a cast from floating point to unsigned integer
2478 class FPToUIInst : public CastInst {
2479 FPToUIInst(const FPToUIInst &CI)
2480 : CastInst(CI.getType(), FPToUI, CI.getOperand(0)) {
2483 /// @brief Constructor with insert-before-instruction semantics
2485 Value *S, ///< The value to be converted
2486 const Type *Ty, ///< The type to convert to
2487 const std::string &Name = "", ///< A name for the new instruction
2488 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2491 /// @brief Constructor with insert-at-end-of-block semantics
2493 Value *S, ///< The value to be converted
2494 const Type *Ty, ///< The type to convert to
2495 const std::string &Name, ///< A name for the new instruction
2496 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
2499 /// @brief Clone an identical FPToUIInst
2500 virtual CastInst *clone() const;
2502 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2503 static inline bool classof(const FPToUIInst *) { return true; }
2504 static inline bool classof(const Instruction *I) {
2505 return I->getOpcode() == FPToUI;
2507 static inline bool classof(const Value *V) {
2508 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2512 //===----------------------------------------------------------------------===//
2514 //===----------------------------------------------------------------------===//
2516 /// @brief This class represents a cast from floating point to signed integer.
2517 class FPToSIInst : public CastInst {
2518 FPToSIInst(const FPToSIInst &CI)
2519 : CastInst(CI.getType(), FPToSI, CI.getOperand(0)) {
2522 /// @brief Constructor with insert-before-instruction semantics
2524 Value *S, ///< The value to be converted
2525 const Type *Ty, ///< The type to convert to
2526 const std::string &Name = "", ///< A name for the new instruction
2527 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2530 /// @brief Constructor with insert-at-end-of-block semantics
2532 Value *S, ///< The value to be converted
2533 const Type *Ty, ///< The type to convert to
2534 const std::string &Name, ///< A name for the new instruction
2535 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2538 /// @brief Clone an identical FPToSIInst
2539 virtual CastInst *clone() const;
2541 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2542 static inline bool classof(const FPToSIInst *) { return true; }
2543 static inline bool classof(const Instruction *I) {
2544 return I->getOpcode() == FPToSI;
2546 static inline bool classof(const Value *V) {
2547 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2551 //===----------------------------------------------------------------------===//
2552 // IntToPtrInst Class
2553 //===----------------------------------------------------------------------===//
2555 /// @brief This class represents a cast from an integer to a pointer.
2556 class IntToPtrInst : public CastInst {
2557 IntToPtrInst(const IntToPtrInst &CI)
2558 : CastInst(CI.getType(), IntToPtr, CI.getOperand(0)) {
2561 /// @brief Constructor with insert-before-instruction semantics
2563 Value *S, ///< The value to be converted
2564 const Type *Ty, ///< The type to convert to
2565 const std::string &Name = "", ///< A name for the new instruction
2566 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2569 /// @brief Constructor with insert-at-end-of-block semantics
2571 Value *S, ///< The value to be converted
2572 const Type *Ty, ///< The type to convert to
2573 const std::string &Name, ///< A name for the new instruction
2574 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2577 /// @brief Clone an identical IntToPtrInst
2578 virtual CastInst *clone() const;
2580 // Methods for support type inquiry through isa, cast, and dyn_cast:
2581 static inline bool classof(const IntToPtrInst *) { return true; }
2582 static inline bool classof(const Instruction *I) {
2583 return I->getOpcode() == IntToPtr;
2585 static inline bool classof(const Value *V) {
2586 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2590 //===----------------------------------------------------------------------===//
2591 // PtrToIntInst Class
2592 //===----------------------------------------------------------------------===//
2594 /// @brief This class represents a cast from a pointer to an integer
2595 class PtrToIntInst : public CastInst {
2596 PtrToIntInst(const PtrToIntInst &CI)
2597 : CastInst(CI.getType(), PtrToInt, CI.getOperand(0)) {
2600 /// @brief Constructor with insert-before-instruction semantics
2602 Value *S, ///< The value to be converted
2603 const Type *Ty, ///< The type to convert to
2604 const std::string &Name = "", ///< A name for the new instruction
2605 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2608 /// @brief Constructor with insert-at-end-of-block semantics
2610 Value *S, ///< The value to be converted
2611 const Type *Ty, ///< The type to convert to
2612 const std::string &Name, ///< A name for the new instruction
2613 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2616 /// @brief Clone an identical PtrToIntInst
2617 virtual CastInst *clone() const;
2619 // Methods for support type inquiry through isa, cast, and dyn_cast:
2620 static inline bool classof(const PtrToIntInst *) { return true; }
2621 static inline bool classof(const Instruction *I) {
2622 return I->getOpcode() == PtrToInt;
2624 static inline bool classof(const Value *V) {
2625 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2629 //===----------------------------------------------------------------------===//
2630 // BitCastInst Class
2631 //===----------------------------------------------------------------------===//
2633 /// @brief This class represents a no-op cast from one type to another.
2634 class BitCastInst : public CastInst {
2635 BitCastInst(const BitCastInst &CI)
2636 : CastInst(CI.getType(), BitCast, CI.getOperand(0)) {
2639 /// @brief Constructor with insert-before-instruction semantics
2641 Value *S, ///< The value to be casted
2642 const Type *Ty, ///< The type to casted to
2643 const std::string &Name = "", ///< A name for the new instruction
2644 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2647 /// @brief Constructor with insert-at-end-of-block semantics
2649 Value *S, ///< The value to be casted
2650 const Type *Ty, ///< The type to casted to
2651 const std::string &Name, ///< A name for the new instruction
2652 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2655 /// @brief Clone an identical BitCastInst
2656 virtual CastInst *clone() const;
2658 // Methods for support type inquiry through isa, cast, and dyn_cast:
2659 static inline bool classof(const BitCastInst *) { return true; }
2660 static inline bool classof(const Instruction *I) {
2661 return I->getOpcode() == BitCast;
2663 static inline bool classof(const Value *V) {
2664 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2668 //===----------------------------------------------------------------------===//
2669 // GetResultInst Class
2670 //===----------------------------------------------------------------------===//
2672 /// GetResultInst - This instruction extracts individual result value from
2673 /// aggregate value, where aggregate value is returned by CallInst.
2675 class GetResultInst : public /*FIXME: Unary*/Instruction {
2676 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2678 GetResultInst(const GetResultInst &GRI) :
2679 Instruction(GRI.getType(), Instruction::GetResult, &Op<0>(), 1) {
2680 Op<0>().init(GRI.Op<0>(), this);
2685 // allocate space for exactly one operand
2686 void *operator new(size_t s) {
2687 return User::operator new(s, 1);
2689 GetResultInst(Value *Aggr, unsigned index,
2690 const std::string &Name = "",
2691 Instruction *InsertBefore = 0);
2693 /// isValidOperands - Return true if an getresult instruction can be
2694 /// formed with the specified operands.
2695 static bool isValidOperands(const Value *Aggr, unsigned index);
2697 virtual GetResultInst *clone() const;
2699 Value *getAggregateValue() {
2700 return getOperand(0);
2703 const Value *getAggregateValue() const {
2704 return getOperand(0);
2707 unsigned getIndex() const {
2711 /// Provide fast operand accessors
2712 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2714 // Methods for support type inquiry through isa, cast, and dyn_cast:
2715 static inline bool classof(const GetResultInst *) { return true; }
2716 static inline bool classof(const Instruction *I) {
2717 return (I->getOpcode() == Instruction::GetResult);
2719 static inline bool classof(const Value *V) {
2720 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2724 // FIXME: these are redundant if GetResultInst < UnaryInstruction
2726 struct OperandTraits<GetResultInst> : FixedNumOperandTraits<1> {
2729 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetResultInst, Value)
2732 } // End llvm namespace