1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file exposes the class definitions of all of the subclasses of the
11 // Instruction class. This is meant to be an easy way to get access to all
12 // instruction subclasses.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_INSTRUCTIONS_H
17 #define LLVM_INSTRUCTIONS_H
21 #include "llvm/InstrTypes.h"
22 #include "llvm/DerivedTypes.h"
23 #include "llvm/Attributes.h"
24 #include "llvm/BasicBlock.h"
25 #include "llvm/ADT/SmallVector.h"
35 //===----------------------------------------------------------------------===//
36 // AllocationInst Class
37 //===----------------------------------------------------------------------===//
39 /// AllocationInst - This class is the common base class of MallocInst and
42 class AllocationInst : public UnaryInstruction {
44 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
45 const std::string &Name = "", Instruction *InsertBefore = 0);
46 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
47 const std::string &Name, BasicBlock *InsertAtEnd);
49 // Out of line virtual method, so the vtable, etc. has a home.
50 virtual ~AllocationInst();
52 /// isArrayAllocation - Return true if there is an allocation size parameter
53 /// to the allocation instruction that is not 1.
55 bool isArrayAllocation() const;
57 /// getArraySize - Get the number of element allocated, for a simple
58 /// allocation of a single element, this will return a constant 1 value.
60 const Value *getArraySize() const { return getOperand(0); }
61 Value *getArraySize() { return getOperand(0); }
63 /// getType - Overload to return most specific pointer type
65 const PointerType *getType() const {
66 return reinterpret_cast<const PointerType*>(Instruction::getType());
69 /// getAllocatedType - Return the type that is being allocated by the
72 const Type *getAllocatedType() const;
74 /// getAlignment - Return the alignment of the memory that is being allocated
75 /// by the instruction.
77 unsigned getAlignment() const { return (1u << SubclassData) >> 1; }
78 void setAlignment(unsigned Align);
80 virtual Instruction *clone() const = 0;
82 // Methods for support type inquiry through isa, cast, and dyn_cast:
83 static inline bool classof(const AllocationInst *) { return true; }
84 static inline bool classof(const Instruction *I) {
85 return I->getOpcode() == Instruction::Alloca ||
86 I->getOpcode() == Instruction::Malloc;
88 static inline bool classof(const Value *V) {
89 return isa<Instruction>(V) && classof(cast<Instruction>(V));
94 //===----------------------------------------------------------------------===//
96 //===----------------------------------------------------------------------===//
98 /// MallocInst - an instruction to allocated memory on the heap
100 class MallocInst : public AllocationInst {
101 MallocInst(const MallocInst &MI);
103 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
104 const std::string &NameStr = "",
105 Instruction *InsertBefore = 0)
106 : AllocationInst(Ty, ArraySize, Malloc, 0, NameStr, InsertBefore) {}
107 MallocInst(const Type *Ty, Value *ArraySize, const std::string &NameStr,
108 BasicBlock *InsertAtEnd)
109 : AllocationInst(Ty, ArraySize, Malloc, 0, NameStr, InsertAtEnd) {}
111 MallocInst(const Type *Ty, const std::string &NameStr,
112 Instruction *InsertBefore = 0)
113 : AllocationInst(Ty, 0, Malloc, 0, NameStr, InsertBefore) {}
114 MallocInst(const Type *Ty, const std::string &NameStr, BasicBlock *InsertAtEnd)
115 : AllocationInst(Ty, 0, Malloc, 0, NameStr, InsertAtEnd) {}
117 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
118 const std::string &NameStr, BasicBlock *InsertAtEnd)
119 : AllocationInst(Ty, ArraySize, Malloc, Align, NameStr, InsertAtEnd) {}
120 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
121 const std::string &NameStr = "",
122 Instruction *InsertBefore = 0)
123 : AllocationInst(Ty, ArraySize, Malloc, Align, NameStr, InsertBefore) {}
125 virtual MallocInst *clone() const;
127 // Methods for support type inquiry through isa, cast, and dyn_cast:
128 static inline bool classof(const MallocInst *) { return true; }
129 static inline bool classof(const Instruction *I) {
130 return (I->getOpcode() == Instruction::Malloc);
132 static inline bool classof(const Value *V) {
133 return isa<Instruction>(V) && classof(cast<Instruction>(V));
138 //===----------------------------------------------------------------------===//
140 //===----------------------------------------------------------------------===//
142 /// AllocaInst - an instruction to allocate memory on the stack
144 class AllocaInst : public AllocationInst {
145 AllocaInst(const AllocaInst &);
147 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
148 const std::string &NameStr = "",
149 Instruction *InsertBefore = 0)
150 : AllocationInst(Ty, ArraySize, Alloca, 0, NameStr, InsertBefore) {}
151 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &NameStr,
152 BasicBlock *InsertAtEnd)
153 : AllocationInst(Ty, ArraySize, Alloca, 0, NameStr, InsertAtEnd) {}
155 AllocaInst(const Type *Ty, const std::string &NameStr,
156 Instruction *InsertBefore = 0)
157 : AllocationInst(Ty, 0, Alloca, 0, NameStr, InsertBefore) {}
158 AllocaInst(const Type *Ty, const std::string &NameStr,
159 BasicBlock *InsertAtEnd)
160 : AllocationInst(Ty, 0, Alloca, 0, NameStr, InsertAtEnd) {}
162 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
163 const std::string &NameStr = "", Instruction *InsertBefore = 0)
164 : AllocationInst(Ty, ArraySize, Alloca, Align, NameStr, InsertBefore) {}
165 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
166 const std::string &NameStr, BasicBlock *InsertAtEnd)
167 : AllocationInst(Ty, ArraySize, Alloca, Align, NameStr, InsertAtEnd) {}
169 virtual AllocaInst *clone() const;
171 /// isStaticAlloca - Return true if this alloca is in the entry block of the
172 /// function and is a constant size. If so, the code generator will fold it
173 /// into the prolog/epilog code, so it is basically free.
174 bool isStaticAlloca() const;
176 // Methods for support type inquiry through isa, cast, and dyn_cast:
177 static inline bool classof(const AllocaInst *) { return true; }
178 static inline bool classof(const Instruction *I) {
179 return (I->getOpcode() == Instruction::Alloca);
181 static inline bool classof(const Value *V) {
182 return isa<Instruction>(V) && classof(cast<Instruction>(V));
187 //===----------------------------------------------------------------------===//
189 //===----------------------------------------------------------------------===//
191 /// FreeInst - an instruction to deallocate memory
193 class FreeInst : public UnaryInstruction {
196 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
197 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
199 virtual FreeInst *clone() const;
201 // Accessor methods for consistency with other memory operations
202 Value *getPointerOperand() { return getOperand(0); }
203 const Value *getPointerOperand() const { return getOperand(0); }
205 // Methods for support type inquiry through isa, cast, and dyn_cast:
206 static inline bool classof(const FreeInst *) { return true; }
207 static inline bool classof(const Instruction *I) {
208 return (I->getOpcode() == Instruction::Free);
210 static inline bool classof(const Value *V) {
211 return isa<Instruction>(V) && classof(cast<Instruction>(V));
216 //===----------------------------------------------------------------------===//
218 //===----------------------------------------------------------------------===//
220 /// LoadInst - an instruction for reading from memory. This uses the
221 /// SubclassData field in Value to store whether or not the load is volatile.
223 class LoadInst : public UnaryInstruction {
225 LoadInst(const LoadInst &LI)
226 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
227 setVolatile(LI.isVolatile());
228 setAlignment(LI.getAlignment());
236 LoadInst(Value *Ptr, const std::string &NameStr, Instruction *InsertBefore);
237 LoadInst(Value *Ptr, const std::string &NameStr, BasicBlock *InsertAtEnd);
238 LoadInst(Value *Ptr, const std::string &NameStr, bool isVolatile = false,
239 Instruction *InsertBefore = 0);
240 LoadInst(Value *Ptr, const std::string &NameStr, bool isVolatile,
241 unsigned Align, Instruction *InsertBefore = 0);
242 LoadInst(Value *Ptr, const std::string &NameStr, bool isVolatile,
243 BasicBlock *InsertAtEnd);
244 LoadInst(Value *Ptr, const std::string &NameStr, bool isVolatile,
245 unsigned Align, BasicBlock *InsertAtEnd);
247 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
248 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
249 explicit LoadInst(Value *Ptr, const char *NameStr = 0,
250 bool isVolatile = false, Instruction *InsertBefore = 0);
251 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
252 BasicBlock *InsertAtEnd);
254 /// isVolatile - Return true if this is a load from a volatile memory
257 bool isVolatile() const { return SubclassData & 1; }
259 /// setVolatile - Specify whether this is a volatile load or not.
261 void setVolatile(bool V) {
262 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
265 virtual LoadInst *clone() const;
267 /// getAlignment - Return the alignment of the access that is being performed
269 unsigned getAlignment() const {
270 return (1 << (SubclassData>>1)) >> 1;
273 void setAlignment(unsigned Align);
275 Value *getPointerOperand() { return getOperand(0); }
276 const Value *getPointerOperand() const { return getOperand(0); }
277 static unsigned getPointerOperandIndex() { return 0U; }
279 // Methods for support type inquiry through isa, cast, and dyn_cast:
280 static inline bool classof(const LoadInst *) { return true; }
281 static inline bool classof(const Instruction *I) {
282 return I->getOpcode() == Instruction::Load;
284 static inline bool classof(const Value *V) {
285 return isa<Instruction>(V) && classof(cast<Instruction>(V));
290 //===----------------------------------------------------------------------===//
292 //===----------------------------------------------------------------------===//
294 /// StoreInst - an instruction for storing to memory
296 class StoreInst : public Instruction {
297 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
299 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store,
301 Op<0>() = SI.Op<0>();
302 Op<1>() = SI.Op<1>();
303 setVolatile(SI.isVolatile());
304 setAlignment(SI.getAlignment());
312 // allocate space for exactly two operands
313 void *operator new(size_t s) {
314 return User::operator new(s, 2);
316 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
317 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
318 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
319 Instruction *InsertBefore = 0);
320 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
321 unsigned Align, Instruction *InsertBefore = 0);
322 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
323 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
324 unsigned Align, BasicBlock *InsertAtEnd);
327 /// isVolatile - Return true if this is a load from a volatile memory
330 bool isVolatile() const { return SubclassData & 1; }
332 /// setVolatile - Specify whether this is a volatile load or not.
334 void setVolatile(bool V) {
335 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
338 /// Transparently provide more efficient getOperand methods.
339 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
341 /// getAlignment - Return the alignment of the access that is being performed
343 unsigned getAlignment() const {
344 return (1 << (SubclassData>>1)) >> 1;
347 void setAlignment(unsigned Align);
349 virtual StoreInst *clone() const;
351 Value *getPointerOperand() { return getOperand(1); }
352 const Value *getPointerOperand() const { return getOperand(1); }
353 static unsigned getPointerOperandIndex() { return 1U; }
355 // Methods for support type inquiry through isa, cast, and dyn_cast:
356 static inline bool classof(const StoreInst *) { return true; }
357 static inline bool classof(const Instruction *I) {
358 return I->getOpcode() == Instruction::Store;
360 static inline bool classof(const Value *V) {
361 return isa<Instruction>(V) && classof(cast<Instruction>(V));
366 struct OperandTraits<StoreInst> : FixedNumOperandTraits<2> {
369 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
371 //===----------------------------------------------------------------------===//
372 // GetElementPtrInst Class
373 //===----------------------------------------------------------------------===//
375 // checkType - Simple wrapper function to give a better assertion failure
376 // message on bad indexes for a gep instruction.
378 static inline const Type *checkType(const Type *Ty) {
379 assert(Ty && "Invalid GetElementPtrInst indices for type!");
383 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
384 /// access elements of arrays and structs
386 class GetElementPtrInst : public Instruction {
387 GetElementPtrInst(const GetElementPtrInst &GEPI);
388 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx,
389 const std::string &NameStr);
390 void init(Value *Ptr, Value *Idx, const std::string &NameStr);
392 template<typename InputIterator>
393 void init(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
394 const std::string &NameStr,
395 // This argument ensures that we have an iterator we can
396 // do arithmetic on in constant time
397 std::random_access_iterator_tag) {
398 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
401 // This requires that the iterator points to contiguous memory.
402 init(Ptr, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
403 // we have to build an array here
406 init(Ptr, 0, NumIdx, NameStr);
410 /// getIndexedType - Returns the type of the element that would be loaded with
411 /// a load instruction with the specified parameters.
413 /// Null is returned if the indices are invalid for the specified
416 template<typename InputIterator>
417 static const Type *getIndexedType(const Type *Ptr,
418 InputIterator IdxBegin,
419 InputIterator IdxEnd,
420 // This argument ensures that we
421 // have an iterator we can do
422 // arithmetic on in constant time
423 std::random_access_iterator_tag) {
424 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
427 // This requires that the iterator points to contiguous memory.
428 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
430 return getIndexedType(Ptr, (Value *const*)0, NumIdx);
433 /// Constructors - Create a getelementptr instruction with a base pointer an
434 /// list of indices. The first ctor can optionally insert before an existing
435 /// instruction, the second appends the new instruction to the specified
437 template<typename InputIterator>
438 inline GetElementPtrInst(Value *Ptr, InputIterator IdxBegin,
439 InputIterator IdxEnd,
441 const std::string &NameStr,
442 Instruction *InsertBefore);
443 template<typename InputIterator>
444 inline GetElementPtrInst(Value *Ptr,
445 InputIterator IdxBegin, InputIterator IdxEnd,
447 const std::string &NameStr, BasicBlock *InsertAtEnd);
449 /// Constructors - These two constructors are convenience methods because one
450 /// and two index getelementptr instructions are so common.
451 GetElementPtrInst(Value *Ptr, Value *Idx, const std::string &NameStr = "",
452 Instruction *InsertBefore = 0);
453 GetElementPtrInst(Value *Ptr, Value *Idx,
454 const std::string &NameStr, BasicBlock *InsertAtEnd);
456 template<typename InputIterator>
457 static GetElementPtrInst *Create(Value *Ptr, InputIterator IdxBegin,
458 InputIterator IdxEnd,
459 const std::string &NameStr = "",
460 Instruction *InsertBefore = 0) {
461 typename std::iterator_traits<InputIterator>::difference_type Values =
462 1 + std::distance(IdxBegin, IdxEnd);
464 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertBefore);
466 template<typename InputIterator>
467 static GetElementPtrInst *Create(Value *Ptr,
468 InputIterator IdxBegin, InputIterator IdxEnd,
469 const std::string &NameStr,
470 BasicBlock *InsertAtEnd) {
471 typename std::iterator_traits<InputIterator>::difference_type Values =
472 1 + std::distance(IdxBegin, IdxEnd);
474 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertAtEnd);
477 /// Constructors - These two creators are convenience methods because one
478 /// index getelementptr instructions are so common.
479 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
480 const std::string &NameStr = "",
481 Instruction *InsertBefore = 0) {
482 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertBefore);
484 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
485 const std::string &NameStr,
486 BasicBlock *InsertAtEnd) {
487 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertAtEnd);
490 virtual GetElementPtrInst *clone() const;
492 /// Transparently provide more efficient getOperand methods.
493 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
495 // getType - Overload to return most specific pointer type...
496 const PointerType *getType() const {
497 return reinterpret_cast<const PointerType*>(Instruction::getType());
500 /// getIndexedType - Returns the type of the element that would be loaded with
501 /// a load instruction with the specified parameters.
503 /// Null is returned if the indices are invalid for the specified
506 template<typename InputIterator>
507 static const Type *getIndexedType(const Type *Ptr,
508 InputIterator IdxBegin,
509 InputIterator IdxEnd) {
510 return getIndexedType(Ptr, IdxBegin, IdxEnd,
511 typename std::iterator_traits<InputIterator>::
512 iterator_category());
515 static const Type *getIndexedType(const Type *Ptr,
516 Value* const *Idx, unsigned NumIdx);
518 static const Type *getIndexedType(const Type *Ptr,
519 uint64_t const *Idx, unsigned NumIdx);
521 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
523 inline op_iterator idx_begin() { return op_begin()+1; }
524 inline const_op_iterator idx_begin() const { return op_begin()+1; }
525 inline op_iterator idx_end() { return op_end(); }
526 inline const_op_iterator idx_end() const { return op_end(); }
528 Value *getPointerOperand() {
529 return getOperand(0);
531 const Value *getPointerOperand() const {
532 return getOperand(0);
534 static unsigned getPointerOperandIndex() {
535 return 0U; // get index for modifying correct operand
538 unsigned getNumIndices() const { // Note: always non-negative
539 return getNumOperands() - 1;
542 bool hasIndices() const {
543 return getNumOperands() > 1;
546 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
547 /// zeros. If so, the result pointer and the first operand have the same
548 /// value, just potentially different types.
549 bool hasAllZeroIndices() const;
551 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
552 /// constant integers. If so, the result pointer and the first operand have
553 /// a constant offset between them.
554 bool hasAllConstantIndices() const;
557 // Methods for support type inquiry through isa, cast, and dyn_cast:
558 static inline bool classof(const GetElementPtrInst *) { return true; }
559 static inline bool classof(const Instruction *I) {
560 return (I->getOpcode() == Instruction::GetElementPtr);
562 static inline bool classof(const Value *V) {
563 return isa<Instruction>(V) && classof(cast<Instruction>(V));
568 struct OperandTraits<GetElementPtrInst> : VariadicOperandTraits<1> {
571 template<typename InputIterator>
572 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
573 InputIterator IdxBegin,
574 InputIterator IdxEnd,
576 const std::string &NameStr,
577 Instruction *InsertBefore)
578 : Instruction(PointerType::get(checkType(
579 getIndexedType(Ptr->getType(),
581 cast<PointerType>(Ptr->getType())
582 ->getAddressSpace()),
584 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
585 Values, InsertBefore) {
586 init(Ptr, IdxBegin, IdxEnd, NameStr,
587 typename std::iterator_traits<InputIterator>::iterator_category());
589 template<typename InputIterator>
590 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
591 InputIterator IdxBegin,
592 InputIterator IdxEnd,
594 const std::string &NameStr,
595 BasicBlock *InsertAtEnd)
596 : Instruction(PointerType::get(checkType(
597 getIndexedType(Ptr->getType(),
599 cast<PointerType>(Ptr->getType())
600 ->getAddressSpace()),
602 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
603 Values, InsertAtEnd) {
604 init(Ptr, IdxBegin, IdxEnd, NameStr,
605 typename std::iterator_traits<InputIterator>::iterator_category());
609 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
612 //===----------------------------------------------------------------------===//
614 //===----------------------------------------------------------------------===//
616 /// This instruction compares its operands according to the predicate given
617 /// to the constructor. It only operates on integers or pointers. The operands
618 /// must be identical types.
619 /// @brief Represent an integer comparison operator.
620 class ICmpInst: public CmpInst {
622 /// @brief Constructor with insert-before-instruction semantics.
624 Predicate pred, ///< The predicate to use for the comparison
625 Value *LHS, ///< The left-hand-side of the expression
626 Value *RHS, ///< The right-hand-side of the expression
627 const std::string &NameStr = "", ///< Name of the instruction
628 Instruction *InsertBefore = 0 ///< Where to insert
629 ) : CmpInst(makeCmpResultType(LHS->getType()),
630 Instruction::ICmp, pred, LHS, RHS, NameStr,
632 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
633 pred <= CmpInst::LAST_ICMP_PREDICATE &&
634 "Invalid ICmp predicate value");
635 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
636 "Both operands to ICmp instruction are not of the same type!");
637 // Check that the operands are the right type
638 assert((getOperand(0)->getType()->isIntOrIntVector() ||
639 isa<PointerType>(getOperand(0)->getType())) &&
640 "Invalid operand types for ICmp instruction");
643 /// @brief Constructor with insert-at-block-end semantics.
645 Predicate pred, ///< The predicate to use for the comparison
646 Value *LHS, ///< The left-hand-side of the expression
647 Value *RHS, ///< The right-hand-side of the expression
648 const std::string &NameStr, ///< Name of the instruction
649 BasicBlock *InsertAtEnd ///< Block to insert into.
650 ) : CmpInst(makeCmpResultType(LHS->getType()),
651 Instruction::ICmp, pred, LHS, RHS, NameStr,
653 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
654 pred <= CmpInst::LAST_ICMP_PREDICATE &&
655 "Invalid ICmp predicate value");
656 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
657 "Both operands to ICmp instruction are not of the same type!");
658 // Check that the operands are the right type
659 assert((getOperand(0)->getType()->isIntOrIntVector() ||
660 isa<PointerType>(getOperand(0)->getType())) &&
661 "Invalid operand types for ICmp instruction");
664 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
665 /// @returns the predicate that would be the result if the operand were
666 /// regarded as signed.
667 /// @brief Return the signed version of the predicate
668 Predicate getSignedPredicate() const {
669 return getSignedPredicate(getPredicate());
672 /// This is a static version that you can use without an instruction.
673 /// @brief Return the signed version of the predicate.
674 static Predicate getSignedPredicate(Predicate pred);
676 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
677 /// @returns the predicate that would be the result if the operand were
678 /// regarded as unsigned.
679 /// @brief Return the unsigned version of the predicate
680 Predicate getUnsignedPredicate() const {
681 return getUnsignedPredicate(getPredicate());
684 /// This is a static version that you can use without an instruction.
685 /// @brief Return the unsigned version of the predicate.
686 static Predicate getUnsignedPredicate(Predicate pred);
688 /// isEquality - Return true if this predicate is either EQ or NE. This also
689 /// tests for commutativity.
690 static bool isEquality(Predicate P) {
691 return P == ICMP_EQ || P == ICMP_NE;
694 /// isEquality - Return true if this predicate is either EQ or NE. This also
695 /// tests for commutativity.
696 bool isEquality() const {
697 return isEquality(getPredicate());
700 /// @returns true if the predicate of this ICmpInst is commutative
701 /// @brief Determine if this relation is commutative.
702 bool isCommutative() const { return isEquality(); }
704 /// isRelational - Return true if the predicate is relational (not EQ or NE).
706 bool isRelational() const {
707 return !isEquality();
710 /// isRelational - Return true if the predicate is relational (not EQ or NE).
712 static bool isRelational(Predicate P) {
713 return !isEquality(P);
716 /// @returns true if the predicate of this ICmpInst is signed, false otherwise
717 /// @brief Determine if this instruction's predicate is signed.
718 bool isSignedPredicate() const { return isSignedPredicate(getPredicate()); }
720 /// @returns true if the predicate provided is signed, false otherwise
721 /// @brief Determine if the predicate is signed.
722 static bool isSignedPredicate(Predicate pred);
724 /// @returns true if the specified compare predicate is
725 /// true when both operands are equal...
726 /// @brief Determine if the icmp is true when both operands are equal
727 static bool isTrueWhenEqual(ICmpInst::Predicate pred) {
728 return pred == ICmpInst::ICMP_EQ || pred == ICmpInst::ICMP_UGE ||
729 pred == ICmpInst::ICMP_SGE || pred == ICmpInst::ICMP_ULE ||
730 pred == ICmpInst::ICMP_SLE;
733 /// @returns true if the specified compare instruction is
734 /// true when both operands are equal...
735 /// @brief Determine if the ICmpInst returns true when both operands are equal
736 bool isTrueWhenEqual() {
737 return isTrueWhenEqual(getPredicate());
740 /// Initialize a set of values that all satisfy the predicate with C.
741 /// @brief Make a ConstantRange for a relation with a constant value.
742 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
744 /// Exchange the two operands to this instruction in such a way that it does
745 /// not modify the semantics of the instruction. The predicate value may be
746 /// changed to retain the same result if the predicate is order dependent
748 /// @brief Swap operands and adjust predicate.
749 void swapOperands() {
750 SubclassData = getSwappedPredicate();
751 Op<0>().swap(Op<1>());
754 virtual ICmpInst *clone() const;
756 // Methods for support type inquiry through isa, cast, and dyn_cast:
757 static inline bool classof(const ICmpInst *) { return true; }
758 static inline bool classof(const Instruction *I) {
759 return I->getOpcode() == Instruction::ICmp;
761 static inline bool classof(const Value *V) {
762 return isa<Instruction>(V) && classof(cast<Instruction>(V));
767 //===----------------------------------------------------------------------===//
769 //===----------------------------------------------------------------------===//
771 /// This instruction compares its operands according to the predicate given
772 /// to the constructor. It only operates on floating point values or packed
773 /// vectors of floating point values. The operands must be identical types.
774 /// @brief Represents a floating point comparison operator.
775 class FCmpInst: public CmpInst {
777 /// @brief Constructor with insert-before-instruction semantics.
779 Predicate pred, ///< The predicate to use for the comparison
780 Value *LHS, ///< The left-hand-side of the expression
781 Value *RHS, ///< The right-hand-side of the expression
782 const std::string &NameStr = "", ///< Name of the instruction
783 Instruction *InsertBefore = 0 ///< Where to insert
784 ) : CmpInst(makeCmpResultType(LHS->getType()),
785 Instruction::FCmp, pred, LHS, RHS, NameStr,
787 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
788 "Invalid FCmp predicate value");
789 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
790 "Both operands to FCmp instruction are not of the same type!");
791 // Check that the operands are the right type
792 assert(getOperand(0)->getType()->isFPOrFPVector() &&
793 "Invalid operand types for FCmp instruction");
796 /// @brief Constructor with insert-at-block-end semantics.
798 Predicate pred, ///< The predicate to use for the comparison
799 Value *LHS, ///< The left-hand-side of the expression
800 Value *RHS, ///< The right-hand-side of the expression
801 const std::string &NameStr, ///< Name of the instruction
802 BasicBlock *InsertAtEnd ///< Block to insert into.
803 ) : CmpInst(makeCmpResultType(LHS->getType()),
804 Instruction::FCmp, pred, LHS, RHS, NameStr,
806 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
807 "Invalid FCmp predicate value");
808 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
809 "Both operands to FCmp instruction are not of the same type!");
810 // Check that the operands are the right type
811 assert(getOperand(0)->getType()->isFPOrFPVector() &&
812 "Invalid operand types for FCmp instruction");
815 /// @returns true if the predicate of this instruction is EQ or NE.
816 /// @brief Determine if this is an equality predicate.
817 bool isEquality() const {
818 return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
819 SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
822 /// @returns true if the predicate of this instruction is commutative.
823 /// @brief Determine if this is a commutative predicate.
824 bool isCommutative() const {
825 return isEquality() ||
826 SubclassData == FCMP_FALSE ||
827 SubclassData == FCMP_TRUE ||
828 SubclassData == FCMP_ORD ||
829 SubclassData == FCMP_UNO;
832 /// @returns true if the predicate is relational (not EQ or NE).
833 /// @brief Determine if this a relational predicate.
834 bool isRelational() const { return !isEquality(); }
836 /// Exchange the two operands to this instruction in such a way that it does
837 /// not modify the semantics of the instruction. The predicate value may be
838 /// changed to retain the same result if the predicate is order dependent
840 /// @brief Swap operands and adjust predicate.
841 void swapOperands() {
842 SubclassData = getSwappedPredicate();
843 Op<0>().swap(Op<1>());
846 virtual FCmpInst *clone() const;
848 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
849 static inline bool classof(const FCmpInst *) { return true; }
850 static inline bool classof(const Instruction *I) {
851 return I->getOpcode() == Instruction::FCmp;
853 static inline bool classof(const Value *V) {
854 return isa<Instruction>(V) && classof(cast<Instruction>(V));
859 //===----------------------------------------------------------------------===//
861 //===----------------------------------------------------------------------===//
863 /// This instruction compares its operands according to the predicate given
864 /// to the constructor. It only operates on vectors of integers.
865 /// The operands must be identical types.
866 /// @brief Represents a vector integer comparison operator.
867 class VICmpInst: public CmpInst {
869 /// @brief Constructor with insert-before-instruction semantics.
871 Predicate pred, ///< The predicate to use for the comparison
872 Value *LHS, ///< The left-hand-side of the expression
873 Value *RHS, ///< The right-hand-side of the expression
874 const std::string &NameStr = "", ///< Name of the instruction
875 Instruction *InsertBefore = 0 ///< Where to insert
876 ) : CmpInst(LHS->getType(), Instruction::VICmp, pred, LHS, RHS, NameStr,
878 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
879 pred <= CmpInst::LAST_ICMP_PREDICATE &&
880 "Invalid VICmp predicate value");
881 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
882 "Both operands to VICmp instruction are not of the same type!");
885 /// @brief Constructor with insert-at-block-end semantics.
887 Predicate pred, ///< The predicate to use for the comparison
888 Value *LHS, ///< The left-hand-side of the expression
889 Value *RHS, ///< The right-hand-side of the expression
890 const std::string &NameStr, ///< Name of the instruction
891 BasicBlock *InsertAtEnd ///< Block to insert into.
892 ) : CmpInst(LHS->getType(), Instruction::VICmp, pred, LHS, RHS, NameStr,
894 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
895 pred <= CmpInst::LAST_ICMP_PREDICATE &&
896 "Invalid VICmp predicate value");
897 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
898 "Both operands to VICmp instruction are not of the same type!");
901 /// @brief Return the predicate for this instruction.
902 Predicate getPredicate() const { return Predicate(SubclassData); }
904 virtual VICmpInst *clone() const;
906 // Methods for support type inquiry through isa, cast, and dyn_cast:
907 static inline bool classof(const VICmpInst *) { return true; }
908 static inline bool classof(const Instruction *I) {
909 return I->getOpcode() == Instruction::VICmp;
911 static inline bool classof(const Value *V) {
912 return isa<Instruction>(V) && classof(cast<Instruction>(V));
916 //===----------------------------------------------------------------------===//
918 //===----------------------------------------------------------------------===//
920 /// This instruction compares its operands according to the predicate given
921 /// to the constructor. It only operates on vectors of floating point values.
922 /// The operands must be identical types.
923 /// @brief Represents a vector floating point comparison operator.
924 class VFCmpInst: public CmpInst {
926 /// @brief Constructor with insert-before-instruction semantics.
928 Predicate pred, ///< The predicate to use for the comparison
929 Value *LHS, ///< The left-hand-side of the expression
930 Value *RHS, ///< The right-hand-side of the expression
931 const std::string &NameStr = "", ///< Name of the instruction
932 Instruction *InsertBefore = 0 ///< Where to insert
933 ) : CmpInst(VectorType::getInteger(cast<VectorType>(LHS->getType())),
934 Instruction::VFCmp, pred, LHS, RHS, NameStr, InsertBefore) {
935 assert(pred <= CmpInst::LAST_FCMP_PREDICATE &&
936 "Invalid VFCmp predicate value");
937 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
938 "Both operands to VFCmp instruction are not of the same type!");
941 /// @brief Constructor with insert-at-block-end semantics.
943 Predicate pred, ///< The predicate to use for the comparison
944 Value *LHS, ///< The left-hand-side of the expression
945 Value *RHS, ///< The right-hand-side of the expression
946 const std::string &NameStr, ///< Name of the instruction
947 BasicBlock *InsertAtEnd ///< Block to insert into.
948 ) : CmpInst(VectorType::getInteger(cast<VectorType>(LHS->getType())),
949 Instruction::VFCmp, pred, LHS, RHS, NameStr, InsertAtEnd) {
950 assert(pred <= CmpInst::LAST_FCMP_PREDICATE &&
951 "Invalid VFCmp predicate value");
952 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
953 "Both operands to VFCmp instruction are not of the same type!");
956 /// @brief Return the predicate for this instruction.
957 Predicate getPredicate() const { return Predicate(SubclassData); }
959 virtual VFCmpInst *clone() const;
961 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
962 static inline bool classof(const VFCmpInst *) { return true; }
963 static inline bool classof(const Instruction *I) {
964 return I->getOpcode() == Instruction::VFCmp;
966 static inline bool classof(const Value *V) {
967 return isa<Instruction>(V) && classof(cast<Instruction>(V));
971 //===----------------------------------------------------------------------===//
973 //===----------------------------------------------------------------------===//
974 /// CallInst - This class represents a function call, abstracting a target
975 /// machine's calling convention. This class uses low bit of the SubClassData
976 /// field to indicate whether or not this is a tail call. The rest of the bits
977 /// hold the calling convention of the call.
980 class CallInst : public Instruction {
981 AttrListPtr AttributeList; ///< parameter attributes for call
982 CallInst(const CallInst &CI);
983 void init(Value *Func, Value* const *Params, unsigned NumParams);
984 void init(Value *Func, Value *Actual1, Value *Actual2);
985 void init(Value *Func, Value *Actual);
986 void init(Value *Func);
988 template<typename InputIterator>
989 void init(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
990 const std::string &NameStr,
991 // This argument ensures that we have an iterator we can
992 // do arithmetic on in constant time
993 std::random_access_iterator_tag) {
994 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
996 // This requires that the iterator points to contiguous memory.
997 init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
1001 /// Construct a CallInst given a range of arguments. InputIterator
1002 /// must be a random-access iterator pointing to contiguous storage
1003 /// (e.g. a std::vector<>::iterator). Checks are made for
1004 /// random-accessness but not for contiguous storage as that would
1005 /// incur runtime overhead.
1006 /// @brief Construct a CallInst from a range of arguments
1007 template<typename InputIterator>
1008 CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1009 const std::string &NameStr, Instruction *InsertBefore);
1011 /// Construct a CallInst given a range of arguments. InputIterator
1012 /// must be a random-access iterator pointing to contiguous storage
1013 /// (e.g. a std::vector<>::iterator). Checks are made for
1014 /// random-accessness but not for contiguous storage as that would
1015 /// incur runtime overhead.
1016 /// @brief Construct a CallInst from a range of arguments
1017 template<typename InputIterator>
1018 inline CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1019 const std::string &NameStr, BasicBlock *InsertAtEnd);
1021 CallInst(Value *F, Value *Actual, const std::string& NameStr,
1022 Instruction *InsertBefore);
1023 CallInst(Value *F, Value *Actual, const std::string& NameStr,
1024 BasicBlock *InsertAtEnd);
1025 explicit CallInst(Value *F, const std::string &NameStr,
1026 Instruction *InsertBefore);
1027 CallInst(Value *F, const std::string &NameStr, BasicBlock *InsertAtEnd);
1029 template<typename InputIterator>
1030 static CallInst *Create(Value *Func,
1031 InputIterator ArgBegin, InputIterator ArgEnd,
1032 const std::string &NameStr = "",
1033 Instruction *InsertBefore = 0) {
1034 return new((unsigned)(ArgEnd - ArgBegin + 1))
1035 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertBefore);
1037 template<typename InputIterator>
1038 static CallInst *Create(Value *Func,
1039 InputIterator ArgBegin, InputIterator ArgEnd,
1040 const std::string &NameStr, BasicBlock *InsertAtEnd) {
1041 return new((unsigned)(ArgEnd - ArgBegin + 1))
1042 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertAtEnd);
1044 static CallInst *Create(Value *F, Value *Actual,
1045 const std::string& NameStr = "",
1046 Instruction *InsertBefore = 0) {
1047 return new(2) CallInst(F, Actual, NameStr, InsertBefore);
1049 static CallInst *Create(Value *F, Value *Actual, const std::string& NameStr,
1050 BasicBlock *InsertAtEnd) {
1051 return new(2) CallInst(F, Actual, NameStr, InsertAtEnd);
1053 static CallInst *Create(Value *F, const std::string &NameStr = "",
1054 Instruction *InsertBefore = 0) {
1055 return new(1) CallInst(F, NameStr, InsertBefore);
1057 static CallInst *Create(Value *F, const std::string &NameStr,
1058 BasicBlock *InsertAtEnd) {
1059 return new(1) CallInst(F, NameStr, InsertAtEnd);
1064 bool isTailCall() const { return SubclassData & 1; }
1065 void setTailCall(bool isTC = true) {
1066 SubclassData = (SubclassData & ~1) | unsigned(isTC);
1069 virtual CallInst *clone() const;
1071 /// Provide fast operand accessors
1072 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1074 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1076 unsigned getCallingConv() const { return SubclassData >> 1; }
1077 void setCallingConv(unsigned CC) {
1078 SubclassData = (SubclassData & 1) | (CC << 1);
1081 /// getAttributes - Return the parameter attributes for this call.
1083 const AttrListPtr &getAttributes() const { return AttributeList; }
1085 /// setAttributes - Set the parameter attributes for this call.
1087 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
1089 /// addAttribute - adds the attribute to the list of attributes.
1090 void addAttribute(unsigned i, Attributes attr);
1092 /// removeAttribute - removes the attribute from the list of attributes.
1093 void removeAttribute(unsigned i, Attributes attr);
1095 /// @brief Determine whether the call or the callee has the given attribute.
1096 bool paramHasAttr(unsigned i, Attributes attr) const;
1098 /// @brief Extract the alignment for a call or parameter (0=unknown).
1099 unsigned getParamAlignment(unsigned i) const {
1100 return AttributeList.getParamAlignment(i);
1103 /// @brief Determine if the call does not access memory.
1104 bool doesNotAccessMemory() const {
1105 return paramHasAttr(~0, Attribute::ReadNone);
1107 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1108 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
1109 else removeAttribute(~0, Attribute::ReadNone);
1112 /// @brief Determine if the call does not access or only reads memory.
1113 bool onlyReadsMemory() const {
1114 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
1116 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1117 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
1118 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
1121 /// @brief Determine if the call cannot return.
1122 bool doesNotReturn() const {
1123 return paramHasAttr(~0, Attribute::NoReturn);
1125 void setDoesNotReturn(bool DoesNotReturn = true) {
1126 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
1127 else removeAttribute(~0, Attribute::NoReturn);
1130 /// @brief Determine if the call cannot unwind.
1131 bool doesNotThrow() const {
1132 return paramHasAttr(~0, Attribute::NoUnwind);
1134 void setDoesNotThrow(bool DoesNotThrow = true) {
1135 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
1136 else removeAttribute(~0, Attribute::NoUnwind);
1139 /// @brief Determine if the call returns a structure through first
1140 /// pointer argument.
1141 bool hasStructRetAttr() const {
1142 // Be friendly and also check the callee.
1143 return paramHasAttr(1, Attribute::StructRet);
1146 /// @brief Determine if any call argument is an aggregate passed by value.
1147 bool hasByValArgument() const {
1148 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1151 /// getCalledFunction - Return the function called, or null if this is an
1152 /// indirect function invocation.
1154 Function *getCalledFunction() const {
1155 return dyn_cast<Function>(getOperand(0));
1158 /// getCalledValue - Get a pointer to the function that is invoked by this
1160 const Value *getCalledValue() const { return getOperand(0); }
1161 Value *getCalledValue() { return getOperand(0); }
1163 // Methods for support type inquiry through isa, cast, and dyn_cast:
1164 static inline bool classof(const CallInst *) { return true; }
1165 static inline bool classof(const Instruction *I) {
1166 return I->getOpcode() == Instruction::Call;
1168 static inline bool classof(const Value *V) {
1169 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1174 struct OperandTraits<CallInst> : VariadicOperandTraits<1> {
1177 template<typename InputIterator>
1178 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1179 const std::string &NameStr, BasicBlock *InsertAtEnd)
1180 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1181 ->getElementType())->getReturnType(),
1183 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1184 (unsigned)(ArgEnd - ArgBegin + 1), InsertAtEnd) {
1185 init(Func, ArgBegin, ArgEnd, NameStr,
1186 typename std::iterator_traits<InputIterator>::iterator_category());
1189 template<typename InputIterator>
1190 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1191 const std::string &NameStr, Instruction *InsertBefore)
1192 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1193 ->getElementType())->getReturnType(),
1195 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1196 (unsigned)(ArgEnd - ArgBegin + 1), InsertBefore) {
1197 init(Func, ArgBegin, ArgEnd, NameStr,
1198 typename std::iterator_traits<InputIterator>::iterator_category());
1201 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1203 //===----------------------------------------------------------------------===//
1205 //===----------------------------------------------------------------------===//
1207 /// SelectInst - This class represents the LLVM 'select' instruction.
1209 class SelectInst : public Instruction {
1210 void init(Value *C, Value *S1, Value *S2) {
1211 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1217 SelectInst(const SelectInst &SI)
1218 : Instruction(SI.getType(), SI.getOpcode(), &Op<0>(), 3) {
1219 init(SI.Op<0>(), SI.Op<1>(), SI.Op<2>());
1221 SelectInst(Value *C, Value *S1, Value *S2, const std::string &NameStr,
1222 Instruction *InsertBefore)
1223 : Instruction(S1->getType(), Instruction::Select,
1224 &Op<0>(), 3, InsertBefore) {
1228 SelectInst(Value *C, Value *S1, Value *S2, const std::string &NameStr,
1229 BasicBlock *InsertAtEnd)
1230 : Instruction(S1->getType(), Instruction::Select,
1231 &Op<0>(), 3, InsertAtEnd) {
1236 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1237 const std::string &NameStr = "",
1238 Instruction *InsertBefore = 0) {
1239 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1241 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1242 const std::string &NameStr,
1243 BasicBlock *InsertAtEnd) {
1244 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1247 Value *getCondition() const { return Op<0>(); }
1248 Value *getTrueValue() const { return Op<1>(); }
1249 Value *getFalseValue() const { return Op<2>(); }
1251 /// areInvalidOperands - Return a string if the specified operands are invalid
1252 /// for a select operation, otherwise return null.
1253 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1255 /// Transparently provide more efficient getOperand methods.
1256 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1258 OtherOps getOpcode() const {
1259 return static_cast<OtherOps>(Instruction::getOpcode());
1262 virtual SelectInst *clone() const;
1264 // Methods for support type inquiry through isa, cast, and dyn_cast:
1265 static inline bool classof(const SelectInst *) { return true; }
1266 static inline bool classof(const Instruction *I) {
1267 return I->getOpcode() == Instruction::Select;
1269 static inline bool classof(const Value *V) {
1270 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1275 struct OperandTraits<SelectInst> : FixedNumOperandTraits<3> {
1278 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1280 //===----------------------------------------------------------------------===//
1282 //===----------------------------------------------------------------------===//
1284 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1285 /// an argument of the specified type given a va_list and increments that list
1287 class VAArgInst : public UnaryInstruction {
1288 VAArgInst(const VAArgInst &VAA)
1289 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
1291 VAArgInst(Value *List, const Type *Ty, const std::string &NameStr = "",
1292 Instruction *InsertBefore = 0)
1293 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1296 VAArgInst(Value *List, const Type *Ty, const std::string &NameStr,
1297 BasicBlock *InsertAtEnd)
1298 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1302 virtual VAArgInst *clone() const;
1304 // Methods for support type inquiry through isa, cast, and dyn_cast:
1305 static inline bool classof(const VAArgInst *) { return true; }
1306 static inline bool classof(const Instruction *I) {
1307 return I->getOpcode() == VAArg;
1309 static inline bool classof(const Value *V) {
1310 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1314 //===----------------------------------------------------------------------===//
1315 // ExtractElementInst Class
1316 //===----------------------------------------------------------------------===//
1318 /// ExtractElementInst - This instruction extracts a single (scalar)
1319 /// element from a VectorType value
1321 class ExtractElementInst : public Instruction {
1322 ExtractElementInst(const ExtractElementInst &EE) :
1323 Instruction(EE.getType(), ExtractElement, &Op<0>(), 2) {
1324 Op<0>() = EE.Op<0>();
1325 Op<1>() = EE.Op<1>();
1329 // allocate space for exactly two operands
1330 void *operator new(size_t s) {
1331 return User::operator new(s, 2); // FIXME: "unsigned Idx" forms of ctor?
1333 ExtractElementInst(Value *Vec, Value *Idx, const std::string &NameStr = "",
1334 Instruction *InsertBefore = 0);
1335 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &NameStr = "",
1336 Instruction *InsertBefore = 0);
1337 ExtractElementInst(Value *Vec, Value *Idx, const std::string &NameStr,
1338 BasicBlock *InsertAtEnd);
1339 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &NameStr,
1340 BasicBlock *InsertAtEnd);
1342 /// isValidOperands - Return true if an extractelement instruction can be
1343 /// formed with the specified operands.
1344 static bool isValidOperands(const Value *Vec, const Value *Idx);
1346 virtual ExtractElementInst *clone() const;
1348 /// Transparently provide more efficient getOperand methods.
1349 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1351 // Methods for support type inquiry through isa, cast, and dyn_cast:
1352 static inline bool classof(const ExtractElementInst *) { return true; }
1353 static inline bool classof(const Instruction *I) {
1354 return I->getOpcode() == Instruction::ExtractElement;
1356 static inline bool classof(const Value *V) {
1357 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1362 struct OperandTraits<ExtractElementInst> : FixedNumOperandTraits<2> {
1365 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1367 //===----------------------------------------------------------------------===//
1368 // InsertElementInst Class
1369 //===----------------------------------------------------------------------===//
1371 /// InsertElementInst - This instruction inserts a single (scalar)
1372 /// element into a VectorType value
1374 class InsertElementInst : public Instruction {
1375 InsertElementInst(const InsertElementInst &IE);
1376 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1377 const std::string &NameStr = "",Instruction *InsertBefore = 0);
1378 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1379 const std::string &NameStr = "",Instruction *InsertBefore = 0);
1380 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1381 const std::string &NameStr, BasicBlock *InsertAtEnd);
1382 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1383 const std::string &NameStr, BasicBlock *InsertAtEnd);
1385 static InsertElementInst *Create(const InsertElementInst &IE) {
1386 return new(IE.getNumOperands()) InsertElementInst(IE);
1388 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1389 const std::string &NameStr = "",
1390 Instruction *InsertBefore = 0) {
1391 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1393 static InsertElementInst *Create(Value *Vec, Value *NewElt, unsigned Idx,
1394 const std::string &NameStr = "",
1395 Instruction *InsertBefore = 0) {
1396 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1398 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1399 const std::string &NameStr,
1400 BasicBlock *InsertAtEnd) {
1401 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1403 static InsertElementInst *Create(Value *Vec, Value *NewElt, unsigned Idx,
1404 const std::string &NameStr,
1405 BasicBlock *InsertAtEnd) {
1406 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1409 /// isValidOperands - Return true if an insertelement instruction can be
1410 /// formed with the specified operands.
1411 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1414 virtual InsertElementInst *clone() const;
1416 /// getType - Overload to return most specific vector type.
1418 const VectorType *getType() const {
1419 return reinterpret_cast<const VectorType*>(Instruction::getType());
1422 /// Transparently provide more efficient getOperand methods.
1423 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1425 // Methods for support type inquiry through isa, cast, and dyn_cast:
1426 static inline bool classof(const InsertElementInst *) { return true; }
1427 static inline bool classof(const Instruction *I) {
1428 return I->getOpcode() == Instruction::InsertElement;
1430 static inline bool classof(const Value *V) {
1431 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1436 struct OperandTraits<InsertElementInst> : FixedNumOperandTraits<3> {
1439 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1441 //===----------------------------------------------------------------------===//
1442 // ShuffleVectorInst Class
1443 //===----------------------------------------------------------------------===//
1445 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1448 class ShuffleVectorInst : public Instruction {
1449 ShuffleVectorInst(const ShuffleVectorInst &IE);
1451 // allocate space for exactly three operands
1452 void *operator new(size_t s) {
1453 return User::operator new(s, 3);
1455 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1456 const std::string &NameStr = "",
1457 Instruction *InsertBefor = 0);
1458 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1459 const std::string &NameStr, BasicBlock *InsertAtEnd);
1461 /// isValidOperands - Return true if a shufflevector instruction can be
1462 /// formed with the specified operands.
1463 static bool isValidOperands(const Value *V1, const Value *V2,
1466 virtual ShuffleVectorInst *clone() const;
1468 /// getType - Overload to return most specific vector type.
1470 const VectorType *getType() const {
1471 return reinterpret_cast<const VectorType*>(Instruction::getType());
1474 /// Transparently provide more efficient getOperand methods.
1475 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1477 /// getMaskValue - Return the index from the shuffle mask for the specified
1478 /// output result. This is either -1 if the element is undef or a number less
1479 /// than 2*numelements.
1480 int getMaskValue(unsigned i) const;
1482 // Methods for support type inquiry through isa, cast, and dyn_cast:
1483 static inline bool classof(const ShuffleVectorInst *) { return true; }
1484 static inline bool classof(const Instruction *I) {
1485 return I->getOpcode() == Instruction::ShuffleVector;
1487 static inline bool classof(const Value *V) {
1488 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1493 struct OperandTraits<ShuffleVectorInst> : FixedNumOperandTraits<3> {
1496 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1498 //===----------------------------------------------------------------------===//
1499 // ExtractValueInst Class
1500 //===----------------------------------------------------------------------===//
1502 /// ExtractValueInst - This instruction extracts a struct member or array
1503 /// element value from an aggregate value.
1505 class ExtractValueInst : public UnaryInstruction {
1506 SmallVector<unsigned, 4> Indices;
1508 ExtractValueInst(const ExtractValueInst &EVI);
1509 void init(const unsigned *Idx, unsigned NumIdx,
1510 const std::string &NameStr);
1511 void init(unsigned Idx, const std::string &NameStr);
1513 template<typename InputIterator>
1514 void init(InputIterator IdxBegin, InputIterator IdxEnd,
1515 const std::string &NameStr,
1516 // This argument ensures that we have an iterator we can
1517 // do arithmetic on in constant time
1518 std::random_access_iterator_tag) {
1519 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1521 // There's no fundamental reason why we require at least one index
1522 // (other than weirdness with &*IdxBegin being invalid; see
1523 // getelementptr's init routine for example). But there's no
1524 // present need to support it.
1525 assert(NumIdx > 0 && "ExtractValueInst must have at least one index");
1527 // This requires that the iterator points to contiguous memory.
1528 init(&*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1529 // we have to build an array here
1532 /// getIndexedType - Returns the type of the element that would be extracted
1533 /// with an extractvalue instruction with the specified parameters.
1535 /// Null is returned if the indices are invalid for the specified
1538 static const Type *getIndexedType(const Type *Agg,
1539 const unsigned *Idx, unsigned NumIdx);
1541 template<typename InputIterator>
1542 static const Type *getIndexedType(const Type *Ptr,
1543 InputIterator IdxBegin,
1544 InputIterator IdxEnd,
1545 // This argument ensures that we
1546 // have an iterator we can do
1547 // arithmetic on in constant time
1548 std::random_access_iterator_tag) {
1549 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1552 // This requires that the iterator points to contiguous memory.
1553 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
1555 return getIndexedType(Ptr, (const unsigned *)0, NumIdx);
1558 /// Constructors - Create a extractvalue instruction with a base aggregate
1559 /// value and a list of indices. The first ctor can optionally insert before
1560 /// an existing instruction, the second appends the new instruction to the
1561 /// specified BasicBlock.
1562 template<typename InputIterator>
1563 inline ExtractValueInst(Value *Agg, InputIterator IdxBegin,
1564 InputIterator IdxEnd,
1565 const std::string &NameStr,
1566 Instruction *InsertBefore);
1567 template<typename InputIterator>
1568 inline ExtractValueInst(Value *Agg,
1569 InputIterator IdxBegin, InputIterator IdxEnd,
1570 const std::string &NameStr, BasicBlock *InsertAtEnd);
1572 // allocate space for exactly one operand
1573 void *operator new(size_t s) {
1574 return User::operator new(s, 1);
1578 template<typename InputIterator>
1579 static ExtractValueInst *Create(Value *Agg, InputIterator IdxBegin,
1580 InputIterator IdxEnd,
1581 const std::string &NameStr = "",
1582 Instruction *InsertBefore = 0) {
1584 ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertBefore);
1586 template<typename InputIterator>
1587 static ExtractValueInst *Create(Value *Agg,
1588 InputIterator IdxBegin, InputIterator IdxEnd,
1589 const std::string &NameStr,
1590 BasicBlock *InsertAtEnd) {
1591 return new ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertAtEnd);
1594 /// Constructors - These two creators are convenience methods because one
1595 /// index extractvalue instructions are much more common than those with
1597 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1598 const std::string &NameStr = "",
1599 Instruction *InsertBefore = 0) {
1600 unsigned Idxs[1] = { Idx };
1601 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertBefore);
1603 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1604 const std::string &NameStr,
1605 BasicBlock *InsertAtEnd) {
1606 unsigned Idxs[1] = { Idx };
1607 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertAtEnd);
1610 virtual ExtractValueInst *clone() const;
1612 // getType - Overload to return most specific pointer type...
1613 const PointerType *getType() const {
1614 return reinterpret_cast<const PointerType*>(Instruction::getType());
1617 /// getIndexedType - Returns the type of the element that would be extracted
1618 /// with an extractvalue instruction with the specified parameters.
1620 /// Null is returned if the indices are invalid for the specified
1623 template<typename InputIterator>
1624 static const Type *getIndexedType(const Type *Ptr,
1625 InputIterator IdxBegin,
1626 InputIterator IdxEnd) {
1627 return getIndexedType(Ptr, IdxBegin, IdxEnd,
1628 typename std::iterator_traits<InputIterator>::
1629 iterator_category());
1631 static const Type *getIndexedType(const Type *Ptr, unsigned Idx);
1633 typedef const unsigned* idx_iterator;
1634 inline idx_iterator idx_begin() const { return Indices.begin(); }
1635 inline idx_iterator idx_end() const { return Indices.end(); }
1637 Value *getAggregateOperand() {
1638 return getOperand(0);
1640 const Value *getAggregateOperand() const {
1641 return getOperand(0);
1643 static unsigned getAggregateOperandIndex() {
1644 return 0U; // get index for modifying correct operand
1647 unsigned getNumIndices() const { // Note: always non-negative
1648 return (unsigned)Indices.size();
1651 bool hasIndices() const {
1655 // Methods for support type inquiry through isa, cast, and dyn_cast:
1656 static inline bool classof(const ExtractValueInst *) { return true; }
1657 static inline bool classof(const Instruction *I) {
1658 return I->getOpcode() == Instruction::ExtractValue;
1660 static inline bool classof(const Value *V) {
1661 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1665 template<typename InputIterator>
1666 ExtractValueInst::ExtractValueInst(Value *Agg,
1667 InputIterator IdxBegin,
1668 InputIterator IdxEnd,
1669 const std::string &NameStr,
1670 Instruction *InsertBefore)
1671 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1673 ExtractValue, Agg, InsertBefore) {
1674 init(IdxBegin, IdxEnd, NameStr,
1675 typename std::iterator_traits<InputIterator>::iterator_category());
1677 template<typename InputIterator>
1678 ExtractValueInst::ExtractValueInst(Value *Agg,
1679 InputIterator IdxBegin,
1680 InputIterator IdxEnd,
1681 const std::string &NameStr,
1682 BasicBlock *InsertAtEnd)
1683 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1685 ExtractValue, Agg, InsertAtEnd) {
1686 init(IdxBegin, IdxEnd, NameStr,
1687 typename std::iterator_traits<InputIterator>::iterator_category());
1691 //===----------------------------------------------------------------------===//
1692 // InsertValueInst Class
1693 //===----------------------------------------------------------------------===//
1695 /// InsertValueInst - This instruction inserts a struct field of array element
1696 /// value into an aggregate value.
1698 class InsertValueInst : public Instruction {
1699 SmallVector<unsigned, 4> Indices;
1701 void *operator new(size_t, unsigned); // Do not implement
1702 InsertValueInst(const InsertValueInst &IVI);
1703 void init(Value *Agg, Value *Val, const unsigned *Idx, unsigned NumIdx,
1704 const std::string &NameStr);
1705 void init(Value *Agg, Value *Val, unsigned Idx, const std::string &NameStr);
1707 template<typename InputIterator>
1708 void init(Value *Agg, Value *Val,
1709 InputIterator IdxBegin, InputIterator IdxEnd,
1710 const std::string &NameStr,
1711 // This argument ensures that we have an iterator we can
1712 // do arithmetic on in constant time
1713 std::random_access_iterator_tag) {
1714 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1716 // There's no fundamental reason why we require at least one index
1717 // (other than weirdness with &*IdxBegin being invalid; see
1718 // getelementptr's init routine for example). But there's no
1719 // present need to support it.
1720 assert(NumIdx > 0 && "InsertValueInst must have at least one index");
1722 // This requires that the iterator points to contiguous memory.
1723 init(Agg, Val, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1724 // we have to build an array here
1727 /// Constructors - Create a insertvalue instruction with a base aggregate
1728 /// value, a value to insert, and a list of indices. The first ctor can
1729 /// optionally insert before an existing instruction, the second appends
1730 /// the new instruction to the specified BasicBlock.
1731 template<typename InputIterator>
1732 inline InsertValueInst(Value *Agg, Value *Val, InputIterator IdxBegin,
1733 InputIterator IdxEnd,
1734 const std::string &NameStr,
1735 Instruction *InsertBefore);
1736 template<typename InputIterator>
1737 inline InsertValueInst(Value *Agg, Value *Val,
1738 InputIterator IdxBegin, InputIterator IdxEnd,
1739 const std::string &NameStr, BasicBlock *InsertAtEnd);
1741 /// Constructors - These two constructors are convenience methods because one
1742 /// and two index insertvalue instructions are so common.
1743 InsertValueInst(Value *Agg, Value *Val,
1744 unsigned Idx, const std::string &NameStr = "",
1745 Instruction *InsertBefore = 0);
1746 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1747 const std::string &NameStr, BasicBlock *InsertAtEnd);
1749 // allocate space for exactly two operands
1750 void *operator new(size_t s) {
1751 return User::operator new(s, 2);
1754 template<typename InputIterator>
1755 static InsertValueInst *Create(Value *Agg, Value *Val, InputIterator IdxBegin,
1756 InputIterator IdxEnd,
1757 const std::string &NameStr = "",
1758 Instruction *InsertBefore = 0) {
1759 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1760 NameStr, InsertBefore);
1762 template<typename InputIterator>
1763 static InsertValueInst *Create(Value *Agg, Value *Val,
1764 InputIterator IdxBegin, InputIterator IdxEnd,
1765 const std::string &NameStr,
1766 BasicBlock *InsertAtEnd) {
1767 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1768 NameStr, InsertAtEnd);
1771 /// Constructors - These two creators are convenience methods because one
1772 /// index insertvalue instructions are much more common than those with
1774 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1775 const std::string &NameStr = "",
1776 Instruction *InsertBefore = 0) {
1777 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertBefore);
1779 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1780 const std::string &NameStr,
1781 BasicBlock *InsertAtEnd) {
1782 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertAtEnd);
1785 virtual InsertValueInst *clone() const;
1787 /// Transparently provide more efficient getOperand methods.
1788 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1790 // getType - Overload to return most specific pointer type...
1791 const PointerType *getType() const {
1792 return reinterpret_cast<const PointerType*>(Instruction::getType());
1795 typedef const unsigned* idx_iterator;
1796 inline idx_iterator idx_begin() const { return Indices.begin(); }
1797 inline idx_iterator idx_end() const { return Indices.end(); }
1799 Value *getAggregateOperand() {
1800 return getOperand(0);
1802 const Value *getAggregateOperand() const {
1803 return getOperand(0);
1805 static unsigned getAggregateOperandIndex() {
1806 return 0U; // get index for modifying correct operand
1809 Value *getInsertedValueOperand() {
1810 return getOperand(1);
1812 const Value *getInsertedValueOperand() const {
1813 return getOperand(1);
1815 static unsigned getInsertedValueOperandIndex() {
1816 return 1U; // get index for modifying correct operand
1819 unsigned getNumIndices() const { // Note: always non-negative
1820 return (unsigned)Indices.size();
1823 bool hasIndices() const {
1827 // Methods for support type inquiry through isa, cast, and dyn_cast:
1828 static inline bool classof(const InsertValueInst *) { return true; }
1829 static inline bool classof(const Instruction *I) {
1830 return I->getOpcode() == Instruction::InsertValue;
1832 static inline bool classof(const Value *V) {
1833 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1838 struct OperandTraits<InsertValueInst> : FixedNumOperandTraits<2> {
1841 template<typename InputIterator>
1842 InsertValueInst::InsertValueInst(Value *Agg,
1844 InputIterator IdxBegin,
1845 InputIterator IdxEnd,
1846 const std::string &NameStr,
1847 Instruction *InsertBefore)
1848 : Instruction(Agg->getType(), InsertValue,
1849 OperandTraits<InsertValueInst>::op_begin(this),
1851 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1852 typename std::iterator_traits<InputIterator>::iterator_category());
1854 template<typename InputIterator>
1855 InsertValueInst::InsertValueInst(Value *Agg,
1857 InputIterator IdxBegin,
1858 InputIterator IdxEnd,
1859 const std::string &NameStr,
1860 BasicBlock *InsertAtEnd)
1861 : Instruction(Agg->getType(), InsertValue,
1862 OperandTraits<InsertValueInst>::op_begin(this),
1864 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1865 typename std::iterator_traits<InputIterator>::iterator_category());
1868 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1870 //===----------------------------------------------------------------------===//
1872 //===----------------------------------------------------------------------===//
1874 // PHINode - The PHINode class is used to represent the magical mystical PHI
1875 // node, that can not exist in nature, but can be synthesized in a computer
1876 // scientist's overactive imagination.
1878 class PHINode : public Instruction {
1879 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1880 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1881 /// the number actually in use.
1882 unsigned ReservedSpace;
1883 PHINode(const PHINode &PN);
1884 // allocate space for exactly zero operands
1885 void *operator new(size_t s) {
1886 return User::operator new(s, 0);
1888 explicit PHINode(const Type *Ty, const std::string &NameStr = "",
1889 Instruction *InsertBefore = 0)
1890 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1895 PHINode(const Type *Ty, const std::string &NameStr, BasicBlock *InsertAtEnd)
1896 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1901 static PHINode *Create(const Type *Ty, const std::string &NameStr = "",
1902 Instruction *InsertBefore = 0) {
1903 return new PHINode(Ty, NameStr, InsertBefore);
1905 static PHINode *Create(const Type *Ty, const std::string &NameStr,
1906 BasicBlock *InsertAtEnd) {
1907 return new PHINode(Ty, NameStr, InsertAtEnd);
1911 /// reserveOperandSpace - This method can be used to avoid repeated
1912 /// reallocation of PHI operand lists by reserving space for the correct
1913 /// number of operands before adding them. Unlike normal vector reserves,
1914 /// this method can also be used to trim the operand space.
1915 void reserveOperandSpace(unsigned NumValues) {
1916 resizeOperands(NumValues*2);
1919 virtual PHINode *clone() const;
1921 /// Provide fast operand accessors
1922 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1924 /// getNumIncomingValues - Return the number of incoming edges
1926 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1928 /// getIncomingValue - Return incoming value number x
1930 Value *getIncomingValue(unsigned i) const {
1931 assert(i*2 < getNumOperands() && "Invalid value number!");
1932 return getOperand(i*2);
1934 void setIncomingValue(unsigned i, Value *V) {
1935 assert(i*2 < getNumOperands() && "Invalid value number!");
1938 unsigned getOperandNumForIncomingValue(unsigned i) {
1942 /// getIncomingBlock - Return incoming basic block number x
1944 BasicBlock *getIncomingBlock(unsigned i) const {
1945 return static_cast<BasicBlock*>(getOperand(i*2+1));
1947 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1948 setOperand(i*2+1, BB);
1950 unsigned getOperandNumForIncomingBlock(unsigned i) {
1954 /// addIncoming - Add an incoming value to the end of the PHI list
1956 void addIncoming(Value *V, BasicBlock *BB) {
1957 assert(V && "PHI node got a null value!");
1958 assert(BB && "PHI node got a null basic block!");
1959 assert(getType() == V->getType() &&
1960 "All operands to PHI node must be the same type as the PHI node!");
1961 unsigned OpNo = NumOperands;
1962 if (OpNo+2 > ReservedSpace)
1963 resizeOperands(0); // Get more space!
1964 // Initialize some new operands.
1965 NumOperands = OpNo+2;
1966 OperandList[OpNo] = V;
1967 OperandList[OpNo+1] = BB;
1970 /// removeIncomingValue - Remove an incoming value. This is useful if a
1971 /// predecessor basic block is deleted. The value removed is returned.
1973 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1974 /// is true), the PHI node is destroyed and any uses of it are replaced with
1975 /// dummy values. The only time there should be zero incoming values to a PHI
1976 /// node is when the block is dead, so this strategy is sound.
1978 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1980 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
1981 int Idx = getBasicBlockIndex(BB);
1982 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1983 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1986 /// getBasicBlockIndex - Return the first index of the specified basic
1987 /// block in the value list for this PHI. Returns -1 if no instance.
1989 int getBasicBlockIndex(const BasicBlock *BB) const {
1990 Use *OL = OperandList;
1991 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1992 if (OL[i+1].get() == BB) return i/2;
1996 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1997 return getIncomingValue(getBasicBlockIndex(BB));
2000 /// hasConstantValue - If the specified PHI node always merges together the
2001 /// same value, return the value, otherwise return null.
2003 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
2005 /// Methods for support type inquiry through isa, cast, and dyn_cast:
2006 static inline bool classof(const PHINode *) { return true; }
2007 static inline bool classof(const Instruction *I) {
2008 return I->getOpcode() == Instruction::PHI;
2010 static inline bool classof(const Value *V) {
2011 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2014 void resizeOperands(unsigned NumOperands);
2018 struct OperandTraits<PHINode> : HungoffOperandTraits<2> {
2021 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2024 //===----------------------------------------------------------------------===//
2026 //===----------------------------------------------------------------------===//
2028 //===---------------------------------------------------------------------------
2029 /// ReturnInst - Return a value (possibly void), from a function. Execution
2030 /// does not continue in this function any longer.
2032 class ReturnInst : public TerminatorInst {
2033 ReturnInst(const ReturnInst &RI);
2036 // ReturnInst constructors:
2037 // ReturnInst() - 'ret void' instruction
2038 // ReturnInst( null) - 'ret void' instruction
2039 // ReturnInst(Value* X) - 'ret X' instruction
2040 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2041 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2042 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2043 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2045 // NOTE: If the Value* passed is of type void then the constructor behaves as
2046 // if it was passed NULL.
2047 explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0);
2048 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd);
2049 explicit ReturnInst(BasicBlock *InsertAtEnd);
2051 static ReturnInst* Create(Value *retVal = 0, Instruction *InsertBefore = 0) {
2052 return new(!!retVal) ReturnInst(retVal, InsertBefore);
2054 static ReturnInst* Create(Value *retVal, BasicBlock *InsertAtEnd) {
2055 return new(!!retVal) ReturnInst(retVal, InsertAtEnd);
2057 static ReturnInst* Create(BasicBlock *InsertAtEnd) {
2058 return new(0) ReturnInst(InsertAtEnd);
2060 virtual ~ReturnInst();
2062 virtual ReturnInst *clone() const;
2064 /// Provide fast operand accessors
2065 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2067 /// Convenience accessor
2068 Value *getReturnValue(unsigned n = 0) const {
2069 return n < getNumOperands()
2074 unsigned getNumSuccessors() const { return 0; }
2076 // Methods for support type inquiry through isa, cast, and dyn_cast:
2077 static inline bool classof(const ReturnInst *) { return true; }
2078 static inline bool classof(const Instruction *I) {
2079 return (I->getOpcode() == Instruction::Ret);
2081 static inline bool classof(const Value *V) {
2082 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2085 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2086 virtual unsigned getNumSuccessorsV() const;
2087 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2091 struct OperandTraits<ReturnInst> : OptionalOperandTraits<> {
2094 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2096 //===----------------------------------------------------------------------===//
2098 //===----------------------------------------------------------------------===//
2100 //===---------------------------------------------------------------------------
2101 /// BranchInst - Conditional or Unconditional Branch instruction.
2103 class BranchInst : public TerminatorInst {
2104 /// Ops list - Branches are strange. The operands are ordered:
2105 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
2106 /// they don't have to check for cond/uncond branchness.
2107 BranchInst(const BranchInst &BI);
2109 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2110 // BranchInst(BB *B) - 'br B'
2111 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2112 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2113 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2114 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2115 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2116 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2117 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2118 Instruction *InsertBefore = 0);
2119 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2120 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2121 BasicBlock *InsertAtEnd);
2123 static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2124 return new(1) BranchInst(IfTrue, InsertBefore);
2126 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2127 Value *Cond, Instruction *InsertBefore = 0) {
2128 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2130 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2131 return new(1) BranchInst(IfTrue, InsertAtEnd);
2133 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2134 Value *Cond, BasicBlock *InsertAtEnd) {
2135 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2139 if (NumOperands == 1)
2140 NumOperands = (unsigned)((Use*)this - OperandList);
2143 /// Transparently provide more efficient getOperand methods.
2144 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2146 virtual BranchInst *clone() const;
2148 bool isUnconditional() const { return getNumOperands() == 1; }
2149 bool isConditional() const { return getNumOperands() == 3; }
2151 Value *getCondition() const {
2152 assert(isConditional() && "Cannot get condition of an uncond branch!");
2153 return getOperand(2);
2156 void setCondition(Value *V) {
2157 assert(isConditional() && "Cannot set condition of unconditional branch!");
2161 // setUnconditionalDest - Change the current branch to an unconditional branch
2162 // targeting the specified block.
2163 // FIXME: Eliminate this ugly method.
2164 void setUnconditionalDest(BasicBlock *Dest) {
2166 if (isConditional()) { // Convert this to an uncond branch.
2173 unsigned getNumSuccessors() const { return 1+isConditional(); }
2175 BasicBlock *getSuccessor(unsigned i) const {
2176 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2177 return cast<BasicBlock>(getOperand(i));
2180 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2181 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2182 setOperand(idx, NewSucc);
2185 // Methods for support type inquiry through isa, cast, and dyn_cast:
2186 static inline bool classof(const BranchInst *) { return true; }
2187 static inline bool classof(const Instruction *I) {
2188 return (I->getOpcode() == Instruction::Br);
2190 static inline bool classof(const Value *V) {
2191 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2194 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2195 virtual unsigned getNumSuccessorsV() const;
2196 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2200 struct OperandTraits<BranchInst> : HungoffOperandTraits<> {
2201 // we need to access operands via OperandList, since
2202 // the NumOperands may change from 3 to 1
2203 static inline void *allocate(unsigned); // FIXME
2206 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2208 //===----------------------------------------------------------------------===//
2210 //===----------------------------------------------------------------------===//
2212 //===---------------------------------------------------------------------------
2213 /// SwitchInst - Multiway switch
2215 class SwitchInst : public TerminatorInst {
2216 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2217 unsigned ReservedSpace;
2218 // Operand[0] = Value to switch on
2219 // Operand[1] = Default basic block destination
2220 // Operand[2n ] = Value to match
2221 // Operand[2n+1] = BasicBlock to go to on match
2222 SwitchInst(const SwitchInst &RI);
2223 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
2224 void resizeOperands(unsigned No);
2225 // allocate space for exactly zero operands
2226 void *operator new(size_t s) {
2227 return User::operator new(s, 0);
2229 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2230 /// switch on and a default destination. The number of additional cases can
2231 /// be specified here to make memory allocation more efficient. This
2232 /// constructor can also autoinsert before another instruction.
2233 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2234 Instruction *InsertBefore = 0);
2236 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2237 /// switch on and a default destination. The number of additional cases can
2238 /// be specified here to make memory allocation more efficient. This
2239 /// constructor also autoinserts at the end of the specified BasicBlock.
2240 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2241 BasicBlock *InsertAtEnd);
2243 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2244 unsigned NumCases, Instruction *InsertBefore = 0) {
2245 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2247 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2248 unsigned NumCases, BasicBlock *InsertAtEnd) {
2249 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2253 /// Provide fast operand accessors
2254 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2256 // Accessor Methods for Switch stmt
2257 Value *getCondition() const { return getOperand(0); }
2258 void setCondition(Value *V) { setOperand(0, V); }
2260 BasicBlock *getDefaultDest() const {
2261 return cast<BasicBlock>(getOperand(1));
2264 /// getNumCases - return the number of 'cases' in this switch instruction.
2265 /// Note that case #0 is always the default case.
2266 unsigned getNumCases() const {
2267 return getNumOperands()/2;
2270 /// getCaseValue - Return the specified case value. Note that case #0, the
2271 /// default destination, does not have a case value.
2272 ConstantInt *getCaseValue(unsigned i) {
2273 assert(i && i < getNumCases() && "Illegal case value to get!");
2274 return getSuccessorValue(i);
2277 /// getCaseValue - Return the specified case value. Note that case #0, the
2278 /// default destination, does not have a case value.
2279 const ConstantInt *getCaseValue(unsigned i) const {
2280 assert(i && i < getNumCases() && "Illegal case value to get!");
2281 return getSuccessorValue(i);
2284 /// findCaseValue - Search all of the case values for the specified constant.
2285 /// If it is explicitly handled, return the case number of it, otherwise
2286 /// return 0 to indicate that it is handled by the default handler.
2287 unsigned findCaseValue(const ConstantInt *C) const {
2288 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
2289 if (getCaseValue(i) == C)
2294 /// findCaseDest - Finds the unique case value for a given successor. Returns
2295 /// null if the successor is not found, not unique, or is the default case.
2296 ConstantInt *findCaseDest(BasicBlock *BB) {
2297 if (BB == getDefaultDest()) return NULL;
2299 ConstantInt *CI = NULL;
2300 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
2301 if (getSuccessor(i) == BB) {
2302 if (CI) return NULL; // Multiple cases lead to BB.
2303 else CI = getCaseValue(i);
2309 /// addCase - Add an entry to the switch instruction...
2311 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2313 /// removeCase - This method removes the specified successor from the switch
2314 /// instruction. Note that this cannot be used to remove the default
2315 /// destination (successor #0).
2317 void removeCase(unsigned idx);
2319 virtual SwitchInst *clone() const;
2321 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2322 BasicBlock *getSuccessor(unsigned idx) const {
2323 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2324 return cast<BasicBlock>(getOperand(idx*2+1));
2326 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2327 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2328 setOperand(idx*2+1, NewSucc);
2331 // getSuccessorValue - Return the value associated with the specified
2333 ConstantInt *getSuccessorValue(unsigned idx) const {
2334 assert(idx < getNumSuccessors() && "Successor # out of range!");
2335 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
2338 // Methods for support type inquiry through isa, cast, and dyn_cast:
2339 static inline bool classof(const SwitchInst *) { return true; }
2340 static inline bool classof(const Instruction *I) {
2341 return I->getOpcode() == Instruction::Switch;
2343 static inline bool classof(const Value *V) {
2344 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2347 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2348 virtual unsigned getNumSuccessorsV() const;
2349 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2353 struct OperandTraits<SwitchInst> : HungoffOperandTraits<2> {
2356 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2359 //===----------------------------------------------------------------------===//
2361 //===----------------------------------------------------------------------===//
2363 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
2364 /// calling convention of the call.
2366 class InvokeInst : public TerminatorInst {
2367 AttrListPtr AttributeList;
2368 InvokeInst(const InvokeInst &BI);
2369 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
2370 Value* const *Args, unsigned NumArgs);
2372 template<typename InputIterator>
2373 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2374 InputIterator ArgBegin, InputIterator ArgEnd,
2375 const std::string &NameStr,
2376 // This argument ensures that we have an iterator we can
2377 // do arithmetic on in constant time
2378 std::random_access_iterator_tag) {
2379 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
2381 // This requires that the iterator points to contiguous memory.
2382 init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
2386 /// Construct an InvokeInst given a range of arguments.
2387 /// InputIterator must be a random-access iterator pointing to
2388 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2389 /// made for random-accessness but not for contiguous storage as
2390 /// that would incur runtime overhead.
2392 /// @brief Construct an InvokeInst from a range of arguments
2393 template<typename InputIterator>
2394 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2395 InputIterator ArgBegin, InputIterator ArgEnd,
2397 const std::string &NameStr, Instruction *InsertBefore);
2399 /// Construct an InvokeInst given a range of arguments.
2400 /// InputIterator must be a random-access iterator pointing to
2401 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2402 /// made for random-accessness but not for contiguous storage as
2403 /// that would incur runtime overhead.
2405 /// @brief Construct an InvokeInst from a range of arguments
2406 template<typename InputIterator>
2407 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2408 InputIterator ArgBegin, InputIterator ArgEnd,
2410 const std::string &NameStr, BasicBlock *InsertAtEnd);
2412 template<typename InputIterator>
2413 static InvokeInst *Create(Value *Func,
2414 BasicBlock *IfNormal, BasicBlock *IfException,
2415 InputIterator ArgBegin, InputIterator ArgEnd,
2416 const std::string &NameStr = "",
2417 Instruction *InsertBefore = 0) {
2418 unsigned Values(ArgEnd - ArgBegin + 3);
2419 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2420 Values, NameStr, InsertBefore);
2422 template<typename InputIterator>
2423 static InvokeInst *Create(Value *Func,
2424 BasicBlock *IfNormal, BasicBlock *IfException,
2425 InputIterator ArgBegin, InputIterator ArgEnd,
2426 const std::string &NameStr,
2427 BasicBlock *InsertAtEnd) {
2428 unsigned Values(ArgEnd - ArgBegin + 3);
2429 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2430 Values, NameStr, InsertAtEnd);
2433 virtual InvokeInst *clone() const;
2435 /// Provide fast operand accessors
2436 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2438 /// getCallingConv/setCallingConv - Get or set the calling convention of this
2440 unsigned getCallingConv() const { return SubclassData; }
2441 void setCallingConv(unsigned CC) {
2445 /// getAttributes - Return the parameter attributes for this invoke.
2447 const AttrListPtr &getAttributes() const { return AttributeList; }
2449 /// setAttributes - Set the parameter attributes for this invoke.
2451 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
2453 /// addAttribute - adds the attribute to the list of attributes.
2454 void addAttribute(unsigned i, Attributes attr);
2456 /// removeAttribute - removes the attribute from the list of attributes.
2457 void removeAttribute(unsigned i, Attributes attr);
2459 /// @brief Determine whether the call or the callee has the given attribute.
2460 bool paramHasAttr(unsigned i, Attributes attr) const;
2462 /// @brief Extract the alignment for a call or parameter (0=unknown).
2463 unsigned getParamAlignment(unsigned i) const {
2464 return AttributeList.getParamAlignment(i);
2467 /// @brief Determine if the call does not access memory.
2468 bool doesNotAccessMemory() const {
2469 return paramHasAttr(0, Attribute::ReadNone);
2471 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
2472 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
2473 else removeAttribute(~0, Attribute::ReadNone);
2476 /// @brief Determine if the call does not access or only reads memory.
2477 bool onlyReadsMemory() const {
2478 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
2480 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
2481 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
2482 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
2485 /// @brief Determine if the call cannot return.
2486 bool doesNotReturn() const {
2487 return paramHasAttr(~0, Attribute::NoReturn);
2489 void setDoesNotReturn(bool DoesNotReturn = true) {
2490 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
2491 else removeAttribute(~0, Attribute::NoReturn);
2494 /// @brief Determine if the call cannot unwind.
2495 bool doesNotThrow() const {
2496 return paramHasAttr(~0, Attribute::NoUnwind);
2498 void setDoesNotThrow(bool DoesNotThrow = true) {
2499 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
2500 else removeAttribute(~0, Attribute::NoUnwind);
2503 /// @brief Determine if the call returns a structure through first
2504 /// pointer argument.
2505 bool hasStructRetAttr() const {
2506 // Be friendly and also check the callee.
2507 return paramHasAttr(1, Attribute::StructRet);
2510 /// @brief Determine if any call argument is an aggregate passed by value.
2511 bool hasByValArgument() const {
2512 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
2515 /// getCalledFunction - Return the function called, or null if this is an
2516 /// indirect function invocation.
2518 Function *getCalledFunction() const {
2519 return dyn_cast<Function>(getOperand(0));
2522 /// getCalledValue - Get a pointer to the function that is invoked by this
2524 const Value *getCalledValue() const { return getOperand(0); }
2525 Value *getCalledValue() { return getOperand(0); }
2527 // get*Dest - Return the destination basic blocks...
2528 BasicBlock *getNormalDest() const {
2529 return cast<BasicBlock>(getOperand(1));
2531 BasicBlock *getUnwindDest() const {
2532 return cast<BasicBlock>(getOperand(2));
2534 void setNormalDest(BasicBlock *B) {
2538 void setUnwindDest(BasicBlock *B) {
2542 BasicBlock *getSuccessor(unsigned i) const {
2543 assert(i < 2 && "Successor # out of range for invoke!");
2544 return i == 0 ? getNormalDest() : getUnwindDest();
2547 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2548 assert(idx < 2 && "Successor # out of range for invoke!");
2549 setOperand(idx+1, NewSucc);
2552 unsigned getNumSuccessors() const { return 2; }
2554 // Methods for support type inquiry through isa, cast, and dyn_cast:
2555 static inline bool classof(const InvokeInst *) { return true; }
2556 static inline bool classof(const Instruction *I) {
2557 return (I->getOpcode() == Instruction::Invoke);
2559 static inline bool classof(const Value *V) {
2560 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2563 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2564 virtual unsigned getNumSuccessorsV() const;
2565 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2569 struct OperandTraits<InvokeInst> : VariadicOperandTraits<3> {
2572 template<typename InputIterator>
2573 InvokeInst::InvokeInst(Value *Func,
2574 BasicBlock *IfNormal, BasicBlock *IfException,
2575 InputIterator ArgBegin, InputIterator ArgEnd,
2577 const std::string &NameStr, Instruction *InsertBefore)
2578 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2579 ->getElementType())->getReturnType(),
2580 Instruction::Invoke,
2581 OperandTraits<InvokeInst>::op_end(this) - Values,
2582 Values, InsertBefore) {
2583 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2584 typename std::iterator_traits<InputIterator>::iterator_category());
2586 template<typename InputIterator>
2587 InvokeInst::InvokeInst(Value *Func,
2588 BasicBlock *IfNormal, BasicBlock *IfException,
2589 InputIterator ArgBegin, InputIterator ArgEnd,
2591 const std::string &NameStr, BasicBlock *InsertAtEnd)
2592 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2593 ->getElementType())->getReturnType(),
2594 Instruction::Invoke,
2595 OperandTraits<InvokeInst>::op_end(this) - Values,
2596 Values, InsertAtEnd) {
2597 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2598 typename std::iterator_traits<InputIterator>::iterator_category());
2601 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
2603 //===----------------------------------------------------------------------===//
2605 //===----------------------------------------------------------------------===//
2607 //===---------------------------------------------------------------------------
2608 /// UnwindInst - Immediately exit the current function, unwinding the stack
2609 /// until an invoke instruction is found.
2611 class UnwindInst : public TerminatorInst {
2612 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2614 // allocate space for exactly zero operands
2615 void *operator new(size_t s) {
2616 return User::operator new(s, 0);
2618 explicit UnwindInst(Instruction *InsertBefore = 0);
2619 explicit UnwindInst(BasicBlock *InsertAtEnd);
2621 virtual UnwindInst *clone() const;
2623 unsigned getNumSuccessors() const { return 0; }
2625 // Methods for support type inquiry through isa, cast, and dyn_cast:
2626 static inline bool classof(const UnwindInst *) { return true; }
2627 static inline bool classof(const Instruction *I) {
2628 return I->getOpcode() == Instruction::Unwind;
2630 static inline bool classof(const Value *V) {
2631 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2634 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2635 virtual unsigned getNumSuccessorsV() const;
2636 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2639 //===----------------------------------------------------------------------===//
2640 // UnreachableInst Class
2641 //===----------------------------------------------------------------------===//
2643 //===---------------------------------------------------------------------------
2644 /// UnreachableInst - This function has undefined behavior. In particular, the
2645 /// presence of this instruction indicates some higher level knowledge that the
2646 /// end of the block cannot be reached.
2648 class UnreachableInst : public TerminatorInst {
2649 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2651 // allocate space for exactly zero operands
2652 void *operator new(size_t s) {
2653 return User::operator new(s, 0);
2655 explicit UnreachableInst(Instruction *InsertBefore = 0);
2656 explicit UnreachableInst(BasicBlock *InsertAtEnd);
2658 virtual UnreachableInst *clone() const;
2660 unsigned getNumSuccessors() const { return 0; }
2662 // Methods for support type inquiry through isa, cast, and dyn_cast:
2663 static inline bool classof(const UnreachableInst *) { return true; }
2664 static inline bool classof(const Instruction *I) {
2665 return I->getOpcode() == Instruction::Unreachable;
2667 static inline bool classof(const Value *V) {
2668 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2671 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2672 virtual unsigned getNumSuccessorsV() const;
2673 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2676 //===----------------------------------------------------------------------===//
2678 //===----------------------------------------------------------------------===//
2680 /// @brief This class represents a truncation of integer types.
2681 class TruncInst : public CastInst {
2682 /// Private copy constructor
2683 TruncInst(const TruncInst &CI)
2684 : CastInst(CI.getType(), Trunc, CI.getOperand(0)) {
2687 /// @brief Constructor with insert-before-instruction semantics
2689 Value *S, ///< The value to be truncated
2690 const Type *Ty, ///< The (smaller) type to truncate to
2691 const std::string &NameStr = "", ///< A name for the new instruction
2692 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2695 /// @brief Constructor with insert-at-end-of-block semantics
2697 Value *S, ///< The value to be truncated
2698 const Type *Ty, ///< The (smaller) type to truncate to
2699 const std::string &NameStr, ///< A name for the new instruction
2700 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2703 /// @brief Clone an identical TruncInst
2704 virtual CastInst *clone() const;
2706 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2707 static inline bool classof(const TruncInst *) { return true; }
2708 static inline bool classof(const Instruction *I) {
2709 return I->getOpcode() == Trunc;
2711 static inline bool classof(const Value *V) {
2712 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2716 //===----------------------------------------------------------------------===//
2718 //===----------------------------------------------------------------------===//
2720 /// @brief This class represents zero extension of integer types.
2721 class ZExtInst : public CastInst {
2722 /// @brief Private copy constructor
2723 ZExtInst(const ZExtInst &CI)
2724 : CastInst(CI.getType(), ZExt, CI.getOperand(0)) {
2727 /// @brief Constructor with insert-before-instruction semantics
2729 Value *S, ///< The value to be zero extended
2730 const Type *Ty, ///< The type to zero extend to
2731 const std::string &NameStr = "", ///< A name for the new instruction
2732 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2735 /// @brief Constructor with insert-at-end semantics.
2737 Value *S, ///< The value to be zero extended
2738 const Type *Ty, ///< The type to zero extend to
2739 const std::string &NameStr, ///< A name for the new instruction
2740 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2743 /// @brief Clone an identical ZExtInst
2744 virtual CastInst *clone() const;
2746 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2747 static inline bool classof(const ZExtInst *) { return true; }
2748 static inline bool classof(const Instruction *I) {
2749 return I->getOpcode() == ZExt;
2751 static inline bool classof(const Value *V) {
2752 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2756 //===----------------------------------------------------------------------===//
2758 //===----------------------------------------------------------------------===//
2760 /// @brief This class represents a sign extension of integer types.
2761 class SExtInst : public CastInst {
2762 /// @brief Private copy constructor
2763 SExtInst(const SExtInst &CI)
2764 : CastInst(CI.getType(), SExt, CI.getOperand(0)) {
2767 /// @brief Constructor with insert-before-instruction semantics
2769 Value *S, ///< The value to be sign extended
2770 const Type *Ty, ///< The type to sign extend to
2771 const std::string &NameStr = "", ///< A name for the new instruction
2772 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2775 /// @brief Constructor with insert-at-end-of-block semantics
2777 Value *S, ///< The value to be sign extended
2778 const Type *Ty, ///< The type to sign extend to
2779 const std::string &NameStr, ///< A name for the new instruction
2780 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2783 /// @brief Clone an identical SExtInst
2784 virtual CastInst *clone() const;
2786 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2787 static inline bool classof(const SExtInst *) { return true; }
2788 static inline bool classof(const Instruction *I) {
2789 return I->getOpcode() == SExt;
2791 static inline bool classof(const Value *V) {
2792 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2796 //===----------------------------------------------------------------------===//
2797 // FPTruncInst Class
2798 //===----------------------------------------------------------------------===//
2800 /// @brief This class represents a truncation of floating point types.
2801 class FPTruncInst : public CastInst {
2802 FPTruncInst(const FPTruncInst &CI)
2803 : CastInst(CI.getType(), FPTrunc, CI.getOperand(0)) {
2806 /// @brief Constructor with insert-before-instruction semantics
2808 Value *S, ///< The value to be truncated
2809 const Type *Ty, ///< The type to truncate to
2810 const std::string &NameStr = "", ///< A name for the new instruction
2811 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2814 /// @brief Constructor with insert-before-instruction semantics
2816 Value *S, ///< The value to be truncated
2817 const Type *Ty, ///< The type to truncate to
2818 const std::string &NameStr, ///< A name for the new instruction
2819 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2822 /// @brief Clone an identical FPTruncInst
2823 virtual CastInst *clone() const;
2825 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2826 static inline bool classof(const FPTruncInst *) { return true; }
2827 static inline bool classof(const Instruction *I) {
2828 return I->getOpcode() == FPTrunc;
2830 static inline bool classof(const Value *V) {
2831 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2835 //===----------------------------------------------------------------------===//
2837 //===----------------------------------------------------------------------===//
2839 /// @brief This class represents an extension of floating point types.
2840 class FPExtInst : public CastInst {
2841 FPExtInst(const FPExtInst &CI)
2842 : CastInst(CI.getType(), FPExt, CI.getOperand(0)) {
2845 /// @brief Constructor with insert-before-instruction semantics
2847 Value *S, ///< The value to be extended
2848 const Type *Ty, ///< The type to extend to
2849 const std::string &NameStr = "", ///< A name for the new instruction
2850 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2853 /// @brief Constructor with insert-at-end-of-block semantics
2855 Value *S, ///< The value to be extended
2856 const Type *Ty, ///< The type to extend to
2857 const std::string &NameStr, ///< A name for the new instruction
2858 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2861 /// @brief Clone an identical FPExtInst
2862 virtual CastInst *clone() const;
2864 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2865 static inline bool classof(const FPExtInst *) { return true; }
2866 static inline bool classof(const Instruction *I) {
2867 return I->getOpcode() == FPExt;
2869 static inline bool classof(const Value *V) {
2870 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2874 //===----------------------------------------------------------------------===//
2876 //===----------------------------------------------------------------------===//
2878 /// @brief This class represents a cast unsigned integer to floating point.
2879 class UIToFPInst : public CastInst {
2880 UIToFPInst(const UIToFPInst &CI)
2881 : CastInst(CI.getType(), UIToFP, CI.getOperand(0)) {
2884 /// @brief Constructor with insert-before-instruction semantics
2886 Value *S, ///< The value to be converted
2887 const Type *Ty, ///< The type to convert to
2888 const std::string &NameStr = "", ///< A name for the new instruction
2889 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2892 /// @brief Constructor with insert-at-end-of-block semantics
2894 Value *S, ///< The value to be converted
2895 const Type *Ty, ///< The type to convert to
2896 const std::string &NameStr, ///< A name for the new instruction
2897 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2900 /// @brief Clone an identical UIToFPInst
2901 virtual CastInst *clone() const;
2903 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2904 static inline bool classof(const UIToFPInst *) { return true; }
2905 static inline bool classof(const Instruction *I) {
2906 return I->getOpcode() == UIToFP;
2908 static inline bool classof(const Value *V) {
2909 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2913 //===----------------------------------------------------------------------===//
2915 //===----------------------------------------------------------------------===//
2917 /// @brief This class represents a cast from signed integer to floating point.
2918 class SIToFPInst : public CastInst {
2919 SIToFPInst(const SIToFPInst &CI)
2920 : CastInst(CI.getType(), SIToFP, CI.getOperand(0)) {
2923 /// @brief Constructor with insert-before-instruction semantics
2925 Value *S, ///< The value to be converted
2926 const Type *Ty, ///< The type to convert to
2927 const std::string &NameStr = "", ///< A name for the new instruction
2928 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2931 /// @brief Constructor with insert-at-end-of-block semantics
2933 Value *S, ///< The value to be converted
2934 const Type *Ty, ///< The type to convert to
2935 const std::string &NameStr, ///< A name for the new instruction
2936 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2939 /// @brief Clone an identical SIToFPInst
2940 virtual CastInst *clone() const;
2942 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2943 static inline bool classof(const SIToFPInst *) { return true; }
2944 static inline bool classof(const Instruction *I) {
2945 return I->getOpcode() == SIToFP;
2947 static inline bool classof(const Value *V) {
2948 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2952 //===----------------------------------------------------------------------===//
2954 //===----------------------------------------------------------------------===//
2956 /// @brief This class represents a cast from floating point to unsigned integer
2957 class FPToUIInst : public CastInst {
2958 FPToUIInst(const FPToUIInst &CI)
2959 : CastInst(CI.getType(), FPToUI, CI.getOperand(0)) {
2962 /// @brief Constructor with insert-before-instruction semantics
2964 Value *S, ///< The value to be converted
2965 const Type *Ty, ///< The type to convert to
2966 const std::string &NameStr = "", ///< A name for the new instruction
2967 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2970 /// @brief Constructor with insert-at-end-of-block semantics
2972 Value *S, ///< The value to be converted
2973 const Type *Ty, ///< The type to convert to
2974 const std::string &NameStr, ///< A name for the new instruction
2975 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
2978 /// @brief Clone an identical FPToUIInst
2979 virtual CastInst *clone() const;
2981 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2982 static inline bool classof(const FPToUIInst *) { return true; }
2983 static inline bool classof(const Instruction *I) {
2984 return I->getOpcode() == FPToUI;
2986 static inline bool classof(const Value *V) {
2987 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2991 //===----------------------------------------------------------------------===//
2993 //===----------------------------------------------------------------------===//
2995 /// @brief This class represents a cast from floating point to signed integer.
2996 class FPToSIInst : public CastInst {
2997 FPToSIInst(const FPToSIInst &CI)
2998 : CastInst(CI.getType(), FPToSI, CI.getOperand(0)) {
3001 /// @brief Constructor with insert-before-instruction semantics
3003 Value *S, ///< The value to be converted
3004 const Type *Ty, ///< The type to convert to
3005 const std::string &NameStr = "", ///< A name for the new instruction
3006 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3009 /// @brief Constructor with insert-at-end-of-block semantics
3011 Value *S, ///< The value to be converted
3012 const Type *Ty, ///< The type to convert to
3013 const std::string &NameStr, ///< A name for the new instruction
3014 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3017 /// @brief Clone an identical FPToSIInst
3018 virtual CastInst *clone() const;
3020 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3021 static inline bool classof(const FPToSIInst *) { return true; }
3022 static inline bool classof(const Instruction *I) {
3023 return I->getOpcode() == FPToSI;
3025 static inline bool classof(const Value *V) {
3026 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3030 //===----------------------------------------------------------------------===//
3031 // IntToPtrInst Class
3032 //===----------------------------------------------------------------------===//
3034 /// @brief This class represents a cast from an integer to a pointer.
3035 class IntToPtrInst : public CastInst {
3036 IntToPtrInst(const IntToPtrInst &CI)
3037 : CastInst(CI.getType(), IntToPtr, CI.getOperand(0)) {
3040 /// @brief Constructor with insert-before-instruction semantics
3042 Value *S, ///< The value to be converted
3043 const Type *Ty, ///< The type to convert to
3044 const std::string &NameStr = "", ///< A name for the new instruction
3045 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3048 /// @brief Constructor with insert-at-end-of-block semantics
3050 Value *S, ///< The value to be converted
3051 const Type *Ty, ///< The type to convert to
3052 const std::string &NameStr, ///< A name for the new instruction
3053 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3056 /// @brief Clone an identical IntToPtrInst
3057 virtual CastInst *clone() const;
3059 // Methods for support type inquiry through isa, cast, and dyn_cast:
3060 static inline bool classof(const IntToPtrInst *) { return true; }
3061 static inline bool classof(const Instruction *I) {
3062 return I->getOpcode() == IntToPtr;
3064 static inline bool classof(const Value *V) {
3065 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3069 //===----------------------------------------------------------------------===//
3070 // PtrToIntInst Class
3071 //===----------------------------------------------------------------------===//
3073 /// @brief This class represents a cast from a pointer to an integer
3074 class PtrToIntInst : public CastInst {
3075 PtrToIntInst(const PtrToIntInst &CI)
3076 : CastInst(CI.getType(), PtrToInt, CI.getOperand(0)) {
3079 /// @brief Constructor with insert-before-instruction semantics
3081 Value *S, ///< The value to be converted
3082 const Type *Ty, ///< The type to convert to
3083 const std::string &NameStr = "", ///< A name for the new instruction
3084 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3087 /// @brief Constructor with insert-at-end-of-block semantics
3089 Value *S, ///< The value to be converted
3090 const Type *Ty, ///< The type to convert to
3091 const std::string &NameStr, ///< A name for the new instruction
3092 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3095 /// @brief Clone an identical PtrToIntInst
3096 virtual CastInst *clone() const;
3098 // Methods for support type inquiry through isa, cast, and dyn_cast:
3099 static inline bool classof(const PtrToIntInst *) { return true; }
3100 static inline bool classof(const Instruction *I) {
3101 return I->getOpcode() == PtrToInt;
3103 static inline bool classof(const Value *V) {
3104 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3108 //===----------------------------------------------------------------------===//
3109 // BitCastInst Class
3110 //===----------------------------------------------------------------------===//
3112 /// @brief This class represents a no-op cast from one type to another.
3113 class BitCastInst : public CastInst {
3114 BitCastInst(const BitCastInst &CI)
3115 : CastInst(CI.getType(), BitCast, CI.getOperand(0)) {
3118 /// @brief Constructor with insert-before-instruction semantics
3120 Value *S, ///< The value to be casted
3121 const Type *Ty, ///< The type to casted to
3122 const std::string &NameStr = "", ///< A name for the new instruction
3123 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3126 /// @brief Constructor with insert-at-end-of-block semantics
3128 Value *S, ///< The value to be casted
3129 const Type *Ty, ///< The type to casted to
3130 const std::string &NameStr, ///< A name for the new instruction
3131 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3134 /// @brief Clone an identical BitCastInst
3135 virtual CastInst *clone() const;
3137 // Methods for support type inquiry through isa, cast, and dyn_cast:
3138 static inline bool classof(const BitCastInst *) { return true; }
3139 static inline bool classof(const Instruction *I) {
3140 return I->getOpcode() == BitCast;
3142 static inline bool classof(const Value *V) {
3143 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3147 } // End llvm namespace