1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file exposes the class definitions of all of the subclasses of the
11 // Instruction class. This is meant to be an easy way to get access to all
12 // instruction subclasses.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_INSTRUCTIONS_H
17 #define LLVM_INSTRUCTIONS_H
21 #include "llvm/InstrTypes.h"
22 #include "llvm/DerivedTypes.h"
23 #include "llvm/ParameterAttributes.h"
35 //===----------------------------------------------------------------------===//
36 // AllocationInst Class
37 //===----------------------------------------------------------------------===//
39 /// AllocationInst - This class is the common base class of MallocInst and
42 class AllocationInst : public UnaryInstruction {
45 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
46 const std::string &Name = "", Instruction *InsertBefore = 0);
47 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
48 const std::string &Name, BasicBlock *InsertAtEnd);
50 // Out of line virtual method, so the vtable, etc has a home.
51 virtual ~AllocationInst();
53 /// isArrayAllocation - Return true if there is an allocation size parameter
54 /// to the allocation instruction that is not 1.
56 bool isArrayAllocation() const;
58 /// getArraySize - Get the number of element allocated, for a simple
59 /// allocation of a single element, this will return a constant 1 value.
61 inline const Value *getArraySize() const { return getOperand(0); }
62 inline Value *getArraySize() { return getOperand(0); }
64 /// getType - Overload to return most specific pointer type
66 inline const PointerType *getType() const {
67 return reinterpret_cast<const PointerType*>(Instruction::getType());
70 /// getAllocatedType - Return the type that is being allocated by the
73 const Type *getAllocatedType() const;
75 /// getAlignment - Return the alignment of the memory that is being allocated
76 /// by the instruction.
78 unsigned getAlignment() const { return Alignment; }
79 void setAlignment(unsigned Align) {
80 assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
84 virtual Instruction *clone() const = 0;
86 // Methods for support type inquiry through isa, cast, and dyn_cast:
87 static inline bool classof(const AllocationInst *) { return true; }
88 static inline bool classof(const Instruction *I) {
89 return I->getOpcode() == Instruction::Alloca ||
90 I->getOpcode() == Instruction::Malloc;
92 static inline bool classof(const Value *V) {
93 return isa<Instruction>(V) && classof(cast<Instruction>(V));
98 //===----------------------------------------------------------------------===//
100 //===----------------------------------------------------------------------===//
102 /// MallocInst - an instruction to allocated memory on the heap
104 class MallocInst : public AllocationInst {
105 MallocInst(const MallocInst &MI);
107 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
108 const std::string &Name = "",
109 Instruction *InsertBefore = 0)
110 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
111 MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
112 BasicBlock *InsertAtEnd)
113 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
115 MallocInst(const Type *Ty, const std::string &Name,
116 Instruction *InsertBefore = 0)
117 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
118 MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
119 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
121 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
122 const std::string &Name, BasicBlock *InsertAtEnd)
123 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
124 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
125 const std::string &Name = "",
126 Instruction *InsertBefore = 0)
127 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
129 virtual MallocInst *clone() const;
131 // Methods for support type inquiry through isa, cast, and dyn_cast:
132 static inline bool classof(const MallocInst *) { return true; }
133 static inline bool classof(const Instruction *I) {
134 return (I->getOpcode() == Instruction::Malloc);
136 static inline bool classof(const Value *V) {
137 return isa<Instruction>(V) && classof(cast<Instruction>(V));
142 //===----------------------------------------------------------------------===//
144 //===----------------------------------------------------------------------===//
146 /// AllocaInst - an instruction to allocate memory on the stack
148 class AllocaInst : public AllocationInst {
149 AllocaInst(const AllocaInst &);
151 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
152 const std::string &Name = "",
153 Instruction *InsertBefore = 0)
154 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
155 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
156 BasicBlock *InsertAtEnd)
157 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
159 AllocaInst(const Type *Ty, const std::string &Name,
160 Instruction *InsertBefore = 0)
161 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
162 AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
163 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
165 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
166 const std::string &Name = "", Instruction *InsertBefore = 0)
167 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
168 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
169 const std::string &Name, BasicBlock *InsertAtEnd)
170 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
172 virtual AllocaInst *clone() const;
174 // Methods for support type inquiry through isa, cast, and dyn_cast:
175 static inline bool classof(const AllocaInst *) { return true; }
176 static inline bool classof(const Instruction *I) {
177 return (I->getOpcode() == Instruction::Alloca);
179 static inline bool classof(const Value *V) {
180 return isa<Instruction>(V) && classof(cast<Instruction>(V));
185 //===----------------------------------------------------------------------===//
187 //===----------------------------------------------------------------------===//
189 /// FreeInst - an instruction to deallocate memory
191 class FreeInst : public UnaryInstruction {
194 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
195 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
197 virtual FreeInst *clone() const;
199 // Accessor methods for consistency with other memory operations
200 Value *getPointerOperand() { return getOperand(0); }
201 const Value *getPointerOperand() const { return getOperand(0); }
203 // Methods for support type inquiry through isa, cast, and dyn_cast:
204 static inline bool classof(const FreeInst *) { return true; }
205 static inline bool classof(const Instruction *I) {
206 return (I->getOpcode() == Instruction::Free);
208 static inline bool classof(const Value *V) {
209 return isa<Instruction>(V) && classof(cast<Instruction>(V));
214 //===----------------------------------------------------------------------===//
216 //===----------------------------------------------------------------------===//
218 /// LoadInst - an instruction for reading from memory. This uses the
219 /// SubclassData field in Value to store whether or not the load is volatile.
221 class LoadInst : public UnaryInstruction {
223 LoadInst(const LoadInst &LI)
224 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
225 setVolatile(LI.isVolatile());
226 setAlignment(LI.getAlignment());
234 LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
235 LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
236 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile = false,
237 Instruction *InsertBefore = 0);
238 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
239 Instruction *InsertBefore = 0);
240 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
241 BasicBlock *InsertAtEnd);
242 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
243 BasicBlock *InsertAtEnd);
245 LoadInst(Value *Ptr, const char *Name, Instruction *InsertBefore);
246 LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAtEnd);
247 explicit LoadInst(Value *Ptr, const char *Name = 0, bool isVolatile = false,
248 Instruction *InsertBefore = 0);
249 LoadInst(Value *Ptr, const char *Name, bool isVolatile,
250 BasicBlock *InsertAtEnd);
252 /// isVolatile - Return true if this is a load from a volatile memory
255 bool isVolatile() const { return SubclassData & 1; }
257 /// setVolatile - Specify whether this is a volatile load or not.
259 void setVolatile(bool V) {
260 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
263 virtual LoadInst *clone() const;
265 /// getAlignment - Return the alignment of the access that is being performed
267 unsigned getAlignment() const {
268 return (1 << (SubclassData>>1)) >> 1;
271 void setAlignment(unsigned Align);
273 Value *getPointerOperand() { return getOperand(0); }
274 const Value *getPointerOperand() const { return getOperand(0); }
275 static unsigned getPointerOperandIndex() { return 0U; }
277 // Methods for support type inquiry through isa, cast, and dyn_cast:
278 static inline bool classof(const LoadInst *) { return true; }
279 static inline bool classof(const Instruction *I) {
280 return I->getOpcode() == Instruction::Load;
282 static inline bool classof(const Value *V) {
283 return isa<Instruction>(V) && classof(cast<Instruction>(V));
288 //===----------------------------------------------------------------------===//
290 //===----------------------------------------------------------------------===//
292 /// StoreInst - an instruction for storing to memory
294 class StoreInst : public Instruction {
297 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store, Ops, 2) {
298 Ops[0].init(SI.Ops[0], this);
299 Ops[1].init(SI.Ops[1], this);
300 setVolatile(SI.isVolatile());
301 setAlignment(SI.getAlignment());
309 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
310 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
311 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
312 Instruction *InsertBefore = 0);
313 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
314 unsigned Align, Instruction *InsertBefore = 0);
315 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
316 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
317 unsigned Align, BasicBlock *InsertAtEnd);
320 /// isVolatile - Return true if this is a load from a volatile memory
323 bool isVolatile() const { return SubclassData & 1; }
325 /// setVolatile - Specify whether this is a volatile load or not.
327 void setVolatile(bool V) {
328 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
331 /// Transparently provide more efficient getOperand methods.
332 Value *getOperand(unsigned i) const {
333 assert(i < 2 && "getOperand() out of range!");
336 void setOperand(unsigned i, Value *Val) {
337 assert(i < 2 && "setOperand() out of range!");
340 unsigned getNumOperands() const { return 2; }
342 /// getAlignment - Return the alignment of the access that is being performed
344 unsigned getAlignment() const {
345 return (1 << (SubclassData>>1)) >> 1;
348 void setAlignment(unsigned Align);
350 virtual StoreInst *clone() const;
352 Value *getPointerOperand() { return getOperand(1); }
353 const Value *getPointerOperand() const { return getOperand(1); }
354 static unsigned getPointerOperandIndex() { return 1U; }
356 // Methods for support type inquiry through isa, cast, and dyn_cast:
357 static inline bool classof(const StoreInst *) { return true; }
358 static inline bool classof(const Instruction *I) {
359 return I->getOpcode() == Instruction::Store;
361 static inline bool classof(const Value *V) {
362 return isa<Instruction>(V) && classof(cast<Instruction>(V));
367 //===----------------------------------------------------------------------===//
368 // GetElementPtrInst Class
369 //===----------------------------------------------------------------------===//
371 // checkType - Simple wrapper function to give a better assertion failure
372 // message on bad indexes for a gep instruction.
374 static inline const Type *checkType(const Type *Ty) {
375 assert(Ty && "Invalid GetElementPtrInst indices for type!");
379 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
380 /// access elements of arrays and structs
382 class GetElementPtrInst : public Instruction {
383 GetElementPtrInst(const GetElementPtrInst &GEPI)
384 : Instruction(reinterpret_cast<const Type*>(GEPI.getType()), GetElementPtr,
385 0, GEPI.getNumOperands()) {
386 Use *OL = OperandList = new Use[NumOperands];
387 Use *GEPIOL = GEPI.OperandList;
388 for (unsigned i = 0, E = NumOperands; i != E; ++i)
389 OL[i].init(GEPIOL[i], this);
391 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx);
392 void init(Value *Ptr, Value *Idx);
394 template<typename InputIterator>
395 void init(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
396 const std::string &Name,
397 // This argument ensures that we have an iterator we can
398 // do arithmetic on in constant time
399 std::random_access_iterator_tag) {
400 typename std::iterator_traits<InputIterator>::difference_type NumIdx =
401 std::distance(IdxBegin, IdxEnd);
404 // This requires that the itoerator points to contiguous memory.
405 init(Ptr, &*IdxBegin, NumIdx);
408 init(Ptr, 0, NumIdx);
414 /// getIndexedType - Returns the type of the element that would be loaded with
415 /// a load instruction with the specified parameters.
417 /// A null type is returned if the indices are invalid for the specified
420 static const Type *getIndexedType(const Type *Ptr,
421 Value* const *Idx, unsigned NumIdx,
422 bool AllowStructLeaf = false);
424 template<typename InputIterator>
425 static const Type *getIndexedType(const Type *Ptr,
426 InputIterator IdxBegin,
427 InputIterator IdxEnd,
428 bool AllowStructLeaf,
429 // This argument ensures that we
430 // have an iterator we can do
431 // arithmetic on in constant time
432 std::random_access_iterator_tag) {
433 typename std::iterator_traits<InputIterator>::difference_type NumIdx =
434 std::distance(IdxBegin, IdxEnd);
437 // This requires that the iterator points to contiguous memory.
438 return(getIndexedType(Ptr, (Value *const *)&*IdxBegin, NumIdx,
442 return(getIndexedType(Ptr, (Value *const*)0, NumIdx, AllowStructLeaf));
447 /// Constructors - Create a getelementptr instruction with a base pointer an
448 /// list of indices. The first ctor can optionally insert before an existing
449 /// instruction, the second appends the new instruction to the specified
451 template<typename InputIterator>
452 GetElementPtrInst(Value *Ptr, InputIterator IdxBegin,
453 InputIterator IdxEnd,
454 const std::string &Name = "",
455 Instruction *InsertBefore =0)
456 : Instruction(PointerType::get(
457 checkType(getIndexedType(Ptr->getType(),
458 IdxBegin, IdxEnd, true)),
459 cast<PointerType>(Ptr->getType())->getAddressSpace()),
460 GetElementPtr, 0, 0, InsertBefore) {
461 init(Ptr, IdxBegin, IdxEnd, Name,
462 typename std::iterator_traits<InputIterator>::iterator_category());
464 template<typename InputIterator>
465 GetElementPtrInst(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
466 const std::string &Name, BasicBlock *InsertAtEnd)
467 : Instruction(PointerType::get(
468 checkType(getIndexedType(Ptr->getType(),
469 IdxBegin, IdxEnd, true)),
470 cast<PointerType>(Ptr->getType())->getAddressSpace()),
471 GetElementPtr, 0, 0, InsertAtEnd) {
472 init(Ptr, IdxBegin, IdxEnd, Name,
473 typename std::iterator_traits<InputIterator>::iterator_category());
476 /// Constructors - These two constructors are convenience methods because one
477 /// and two index getelementptr instructions are so common.
478 GetElementPtrInst(Value *Ptr, Value *Idx,
479 const std::string &Name = "", Instruction *InsertBefore =0);
480 GetElementPtrInst(Value *Ptr, Value *Idx,
481 const std::string &Name, BasicBlock *InsertAtEnd);
482 ~GetElementPtrInst();
484 virtual GetElementPtrInst *clone() const;
486 // getType - Overload to return most specific pointer type...
487 inline const PointerType *getType() const {
488 return reinterpret_cast<const PointerType*>(Instruction::getType());
491 /// getIndexedType - Returns the type of the element that would be loaded with
492 /// a load instruction with the specified parameters.
494 /// A null type is returned if the indices are invalid for the specified
497 template<typename InputIterator>
498 static const Type *getIndexedType(const Type *Ptr,
499 InputIterator IdxBegin,
500 InputIterator IdxEnd,
501 bool AllowStructLeaf = false) {
502 return(getIndexedType(Ptr, IdxBegin, IdxEnd, AllowStructLeaf,
503 typename std::iterator_traits<InputIterator>::
504 iterator_category()));
506 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
508 inline op_iterator idx_begin() { return op_begin()+1; }
509 inline const_op_iterator idx_begin() const { return op_begin()+1; }
510 inline op_iterator idx_end() { return op_end(); }
511 inline const_op_iterator idx_end() const { return op_end(); }
513 Value *getPointerOperand() {
514 return getOperand(0);
516 const Value *getPointerOperand() const {
517 return getOperand(0);
519 static unsigned getPointerOperandIndex() {
520 return 0U; // get index for modifying correct operand
523 inline unsigned getNumIndices() const { // Note: always non-negative
524 return getNumOperands() - 1;
527 inline bool hasIndices() const {
528 return getNumOperands() > 1;
531 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
532 /// zeros. If so, the result pointer and the first operand have the same
533 /// value, just potentially different types.
534 bool hasAllZeroIndices() const;
536 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
537 /// constant integers. If so, the result pointer and the first operand have
538 /// a constant offset between them.
539 bool hasAllConstantIndices() const;
542 // Methods for support type inquiry through isa, cast, and dyn_cast:
543 static inline bool classof(const GetElementPtrInst *) { return true; }
544 static inline bool classof(const Instruction *I) {
545 return (I->getOpcode() == Instruction::GetElementPtr);
547 static inline bool classof(const Value *V) {
548 return isa<Instruction>(V) && classof(cast<Instruction>(V));
552 //===----------------------------------------------------------------------===//
554 //===----------------------------------------------------------------------===//
556 /// This instruction compares its operands according to the predicate given
557 /// to the constructor. It only operates on integers, pointers, or packed
558 /// vectors of integrals. The two operands must be the same type.
559 /// @brief Represent an integer comparison operator.
560 class ICmpInst: public CmpInst {
562 /// This enumeration lists the possible predicates for the ICmpInst. The
563 /// values in the range 0-31 are reserved for FCmpInst while values in the
564 /// range 32-64 are reserved for ICmpInst. This is necessary to ensure the
565 /// predicate values are not overlapping between the classes.
567 ICMP_EQ = 32, ///< equal
568 ICMP_NE = 33, ///< not equal
569 ICMP_UGT = 34, ///< unsigned greater than
570 ICMP_UGE = 35, ///< unsigned greater or equal
571 ICMP_ULT = 36, ///< unsigned less than
572 ICMP_ULE = 37, ///< unsigned less or equal
573 ICMP_SGT = 38, ///< signed greater than
574 ICMP_SGE = 39, ///< signed greater or equal
575 ICMP_SLT = 40, ///< signed less than
576 ICMP_SLE = 41, ///< signed less or equal
577 FIRST_ICMP_PREDICATE = ICMP_EQ,
578 LAST_ICMP_PREDICATE = ICMP_SLE,
579 BAD_ICMP_PREDICATE = ICMP_SLE + 1
582 /// @brief Constructor with insert-before-instruction semantics.
584 Predicate pred, ///< The predicate to use for the comparison
585 Value *LHS, ///< The left-hand-side of the expression
586 Value *RHS, ///< The right-hand-side of the expression
587 const std::string &Name = "", ///< Name of the instruction
588 Instruction *InsertBefore = 0 ///< Where to insert
589 ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertBefore) {
592 /// @brief Constructor with insert-at-block-end semantics.
594 Predicate pred, ///< The predicate to use for the comparison
595 Value *LHS, ///< The left-hand-side of the expression
596 Value *RHS, ///< The right-hand-side of the expression
597 const std::string &Name, ///< Name of the instruction
598 BasicBlock *InsertAtEnd ///< Block to insert into.
599 ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertAtEnd) {
602 /// @brief Return the predicate for this instruction.
603 Predicate getPredicate() const { return Predicate(SubclassData); }
605 /// @brief Set the predicate for this instruction to the specified value.
606 void setPredicate(Predicate P) { SubclassData = P; }
608 /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
609 /// @returns the inverse predicate for the instruction's current predicate.
610 /// @brief Return the inverse of the instruction's predicate.
611 Predicate getInversePredicate() const {
612 return getInversePredicate(getPredicate());
615 /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
616 /// @returns the inverse predicate for predicate provided in \p pred.
617 /// @brief Return the inverse of a given predicate
618 static Predicate getInversePredicate(Predicate pred);
620 /// For example, EQ->EQ, SLE->SGE, ULT->UGT, etc.
621 /// @returns the predicate that would be the result of exchanging the two
622 /// operands of the ICmpInst instruction without changing the result
624 /// @brief Return the predicate as if the operands were swapped
625 Predicate getSwappedPredicate() const {
626 return getSwappedPredicate(getPredicate());
629 /// This is a static version that you can use without an instruction
631 /// @brief Return the predicate as if the operands were swapped.
632 static Predicate getSwappedPredicate(Predicate pred);
634 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
635 /// @returns the predicate that would be the result if the operand were
636 /// regarded as signed.
637 /// @brief Return the signed version of the predicate
638 Predicate getSignedPredicate() const {
639 return getSignedPredicate(getPredicate());
642 /// This is a static version that you can use without an instruction.
643 /// @brief Return the signed version of the predicate.
644 static Predicate getSignedPredicate(Predicate pred);
646 /// isEquality - Return true if this predicate is either EQ or NE. This also
647 /// tests for commutativity.
648 static bool isEquality(Predicate P) {
649 return P == ICMP_EQ || P == ICMP_NE;
652 /// isEquality - Return true if this predicate is either EQ or NE. This also
653 /// tests for commutativity.
654 bool isEquality() const {
655 return isEquality(getPredicate());
658 /// @returns true if the predicate of this ICmpInst is commutative
659 /// @brief Determine if this relation is commutative.
660 bool isCommutative() const { return isEquality(); }
662 /// isRelational - Return true if the predicate is relational (not EQ or NE).
664 bool isRelational() const {
665 return !isEquality();
668 /// isRelational - Return true if the predicate is relational (not EQ or NE).
670 static bool isRelational(Predicate P) {
671 return !isEquality(P);
674 /// @returns true if the predicate of this ICmpInst is signed, false otherwise
675 /// @brief Determine if this instruction's predicate is signed.
676 bool isSignedPredicate() const { return isSignedPredicate(getPredicate()); }
678 /// @returns true if the predicate provided is signed, false otherwise
679 /// @brief Determine if the predicate is signed.
680 static bool isSignedPredicate(Predicate pred);
682 /// Initialize a set of values that all satisfy the predicate with C.
683 /// @brief Make a ConstantRange for a relation with a constant value.
684 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
686 /// Exchange the two operands to this instruction in such a way that it does
687 /// not modify the semantics of the instruction. The predicate value may be
688 /// changed to retain the same result if the predicate is order dependent
690 /// @brief Swap operands and adjust predicate.
691 void swapOperands() {
692 SubclassData = getSwappedPredicate();
693 std::swap(Ops[0], Ops[1]);
696 virtual ICmpInst *clone() const;
698 // Methods for support type inquiry through isa, cast, and dyn_cast:
699 static inline bool classof(const ICmpInst *) { return true; }
700 static inline bool classof(const Instruction *I) {
701 return I->getOpcode() == Instruction::ICmp;
703 static inline bool classof(const Value *V) {
704 return isa<Instruction>(V) && classof(cast<Instruction>(V));
708 //===----------------------------------------------------------------------===//
710 //===----------------------------------------------------------------------===//
712 /// This instruction compares its operands according to the predicate given
713 /// to the constructor. It only operates on floating point values or packed
714 /// vectors of floating point values. The operands must be identical types.
715 /// @brief Represents a floating point comparison operator.
716 class FCmpInst: public CmpInst {
718 /// This enumeration lists the possible predicates for the FCmpInst. Values
719 /// in the range 0-31 are reserved for FCmpInst.
721 // Opcode U L G E Intuitive operation
722 FCMP_FALSE = 0, ///< 0 0 0 0 Always false (always folded)
723 FCMP_OEQ = 1, ///< 0 0 0 1 True if ordered and equal
724 FCMP_OGT = 2, ///< 0 0 1 0 True if ordered and greater than
725 FCMP_OGE = 3, ///< 0 0 1 1 True if ordered and greater than or equal
726 FCMP_OLT = 4, ///< 0 1 0 0 True if ordered and less than
727 FCMP_OLE = 5, ///< 0 1 0 1 True if ordered and less than or equal
728 FCMP_ONE = 6, ///< 0 1 1 0 True if ordered and operands are unequal
729 FCMP_ORD = 7, ///< 0 1 1 1 True if ordered (no nans)
730 FCMP_UNO = 8, ///< 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
731 FCMP_UEQ = 9, ///< 1 0 0 1 True if unordered or equal
732 FCMP_UGT =10, ///< 1 0 1 0 True if unordered or greater than
733 FCMP_UGE =11, ///< 1 0 1 1 True if unordered, greater than, or equal
734 FCMP_ULT =12, ///< 1 1 0 0 True if unordered or less than
735 FCMP_ULE =13, ///< 1 1 0 1 True if unordered, less than, or equal
736 FCMP_UNE =14, ///< 1 1 1 0 True if unordered or not equal
737 FCMP_TRUE =15, ///< 1 1 1 1 Always true (always folded)
738 FIRST_FCMP_PREDICATE = FCMP_FALSE,
739 LAST_FCMP_PREDICATE = FCMP_TRUE,
740 BAD_FCMP_PREDICATE = FCMP_TRUE + 1
743 /// @brief Constructor with insert-before-instruction semantics.
745 Predicate pred, ///< The predicate to use for the comparison
746 Value *LHS, ///< The left-hand-side of the expression
747 Value *RHS, ///< The right-hand-side of the expression
748 const std::string &Name = "", ///< Name of the instruction
749 Instruction *InsertBefore = 0 ///< Where to insert
750 ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertBefore) {
753 /// @brief Constructor with insert-at-block-end semantics.
755 Predicate pred, ///< The predicate to use for the comparison
756 Value *LHS, ///< The left-hand-side of the expression
757 Value *RHS, ///< The right-hand-side of the expression
758 const std::string &Name, ///< Name of the instruction
759 BasicBlock *InsertAtEnd ///< Block to insert into.
760 ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertAtEnd) {
763 /// @brief Return the predicate for this instruction.
764 Predicate getPredicate() const { return Predicate(SubclassData); }
766 /// @brief Set the predicate for this instruction to the specified value.
767 void setPredicate(Predicate P) { SubclassData = P; }
769 /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
770 /// @returns the inverse predicate for the instructions current predicate.
771 /// @brief Return the inverse of the predicate
772 Predicate getInversePredicate() const {
773 return getInversePredicate(getPredicate());
776 /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
777 /// @returns the inverse predicate for \p pred.
778 /// @brief Return the inverse of a given predicate
779 static Predicate getInversePredicate(Predicate pred);
781 /// For example, OEQ->OEQ, ULE->UGE, OLT->OGT, etc.
782 /// @returns the predicate that would be the result of exchanging the two
783 /// operands of the ICmpInst instruction without changing the result
785 /// @brief Return the predicate as if the operands were swapped
786 Predicate getSwappedPredicate() const {
787 return getSwappedPredicate(getPredicate());
790 /// This is a static version that you can use without an instruction
792 /// @brief Return the predicate as if the operands were swapped.
793 static Predicate getSwappedPredicate(Predicate Opcode);
795 /// This also tests for commutativity. If isEquality() returns true then
796 /// the predicate is also commutative. Only the equality predicates are
798 /// @returns true if the predicate of this instruction is EQ or NE.
799 /// @brief Determine if this is an equality predicate.
800 bool isEquality() const {
801 return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
802 SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
804 bool isCommutative() const { return isEquality(); }
806 /// @returns true if the predicate is relational (not EQ or NE).
807 /// @brief Determine if this a relational predicate.
808 bool isRelational() const { return !isEquality(); }
810 /// Exchange the two operands to this instruction in such a way that it does
811 /// not modify the semantics of the instruction. The predicate value may be
812 /// changed to retain the same result if the predicate is order dependent
814 /// @brief Swap operands and adjust predicate.
815 void swapOperands() {
816 SubclassData = getSwappedPredicate();
817 std::swap(Ops[0], Ops[1]);
820 virtual FCmpInst *clone() const;
822 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
823 static inline bool classof(const FCmpInst *) { return true; }
824 static inline bool classof(const Instruction *I) {
825 return I->getOpcode() == Instruction::FCmp;
827 static inline bool classof(const Value *V) {
828 return isa<Instruction>(V) && classof(cast<Instruction>(V));
832 //===----------------------------------------------------------------------===//
834 //===----------------------------------------------------------------------===//
835 /// CallInst - This class represents a function call, abstracting a target
836 /// machine's calling convention. This class uses low bit of the SubClassData
837 /// field to indicate whether or not this is a tail call. The rest of the bits
838 /// hold the calling convention of the call.
841 class CallInst : public Instruction {
842 const ParamAttrsList *ParamAttrs; ///< parameter attributes for call
843 CallInst(const CallInst &CI);
844 void init(Value *Func, Value* const *Params, unsigned NumParams);
845 void init(Value *Func, Value *Actual1, Value *Actual2);
846 void init(Value *Func, Value *Actual);
847 void init(Value *Func);
849 template<typename InputIterator>
850 void init(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
851 const std::string &Name,
852 // This argument ensures that we have an iterator we can
853 // do arithmetic on in constant time
854 std::random_access_iterator_tag) {
855 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
857 // This requires that the iterator points to contiguous memory.
858 init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
863 /// Construct a CallInst given a range of arguments. InputIterator
864 /// must be a random-access iterator pointing to contiguous storage
865 /// (e.g. a std::vector<>::iterator). Checks are made for
866 /// random-accessness but not for contiguous storage as that would
867 /// incur runtime overhead.
868 /// @brief Construct a CallInst from a range of arguments
869 template<typename InputIterator>
870 CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
871 const std::string &Name = "", Instruction *InsertBefore = 0)
872 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
873 ->getElementType())->getReturnType(),
874 Instruction::Call, 0, 0, InsertBefore) {
875 init(Func, ArgBegin, ArgEnd, Name,
876 typename std::iterator_traits<InputIterator>::iterator_category());
879 /// Construct a CallInst given a range of arguments. InputIterator
880 /// must be a random-access iterator pointing to contiguous storage
881 /// (e.g. a std::vector<>::iterator). Checks are made for
882 /// random-accessness but not for contiguous storage as that would
883 /// incur runtime overhead.
884 /// @brief Construct a CallInst from a range of arguments
885 template<typename InputIterator>
886 CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
887 const std::string &Name, BasicBlock *InsertAtEnd)
888 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
889 ->getElementType())->getReturnType(),
890 Instruction::Call, 0, 0, InsertAtEnd) {
891 init(Func, ArgBegin, ArgEnd, Name,
892 typename std::iterator_traits<InputIterator>::iterator_category());
895 CallInst(Value *F, Value *Actual, const std::string& Name = "",
896 Instruction *InsertBefore = 0);
897 CallInst(Value *F, Value *Actual, const std::string& Name,
898 BasicBlock *InsertAtEnd);
899 explicit CallInst(Value *F, const std::string &Name = "",
900 Instruction *InsertBefore = 0);
901 CallInst(Value *F, const std::string &Name, BasicBlock *InsertAtEnd);
904 virtual CallInst *clone() const;
906 bool isTailCall() const { return SubclassData & 1; }
907 void setTailCall(bool isTailCall = true) {
908 SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
911 /// getCallingConv/setCallingConv - Get or set the calling convention of this
913 unsigned getCallingConv() const { return SubclassData >> 1; }
914 void setCallingConv(unsigned CC) {
915 SubclassData = (SubclassData & 1) | (CC << 1);
918 /// Obtains a pointer to the ParamAttrsList object which holds the
919 /// parameter attributes information, if any.
920 /// @returns 0 if no attributes have been set.
921 /// @brief Get the parameter attributes.
922 const ParamAttrsList *getParamAttrs() const { return ParamAttrs; }
924 /// Sets the parameter attributes for this CallInst. To construct a
925 /// ParamAttrsList, see ParameterAttributes.h
926 /// @brief Set the parameter attributes.
927 void setParamAttrs(const ParamAttrsList *attrs);
929 /// @brief Determine whether the call or the callee has the given attribute.
930 bool paramHasAttr(uint16_t i, ParameterAttributes attr) const;
932 /// @brief Determine if the call does not access memory.
933 bool doesNotAccessMemory() const {
934 return paramHasAttr(0, ParamAttr::ReadNone);
937 /// @brief Determine if the call does not access or only reads memory.
938 bool onlyReadsMemory() const {
939 return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
942 /// @brief Determine if the call cannot return.
943 bool isNoReturn() const {
944 return paramHasAttr(0, ParamAttr::NoReturn);
947 /// @brief Determine if the call cannot unwind.
948 bool isNoUnwind() const {
949 return paramHasAttr(0, ParamAttr::NoUnwind);
952 /// @brief Determine if the call returns a structure.
953 bool isStructReturn() const {
954 // Be friendly and also check the callee.
955 return paramHasAttr(1, ParamAttr::StructRet);
958 /// getCalledFunction - Return the function being called by this instruction
959 /// if it is a direct call. If it is a call through a function pointer,
961 Function *getCalledFunction() const {
962 return dyn_cast<Function>(getOperand(0));
965 /// getCalledValue - Get a pointer to the function that is invoked by this
967 inline const Value *getCalledValue() const { return getOperand(0); }
968 inline Value *getCalledValue() { return getOperand(0); }
970 // Methods for support type inquiry through isa, cast, and dyn_cast:
971 static inline bool classof(const CallInst *) { return true; }
972 static inline bool classof(const Instruction *I) {
973 return I->getOpcode() == Instruction::Call;
975 static inline bool classof(const Value *V) {
976 return isa<Instruction>(V) && classof(cast<Instruction>(V));
980 //===----------------------------------------------------------------------===//
982 //===----------------------------------------------------------------------===//
984 /// SelectInst - This class represents the LLVM 'select' instruction.
986 class SelectInst : public Instruction {
989 void init(Value *C, Value *S1, Value *S2) {
990 Ops[0].init(C, this);
991 Ops[1].init(S1, this);
992 Ops[2].init(S2, this);
995 SelectInst(const SelectInst &SI)
996 : Instruction(SI.getType(), SI.getOpcode(), Ops, 3) {
997 init(SI.Ops[0], SI.Ops[1], SI.Ops[2]);
1000 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
1001 Instruction *InsertBefore = 0)
1002 : Instruction(S1->getType(), Instruction::Select, Ops, 3, InsertBefore) {
1006 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
1007 BasicBlock *InsertAtEnd)
1008 : Instruction(S1->getType(), Instruction::Select, Ops, 3, InsertAtEnd) {
1013 Value *getCondition() const { return Ops[0]; }
1014 Value *getTrueValue() const { return Ops[1]; }
1015 Value *getFalseValue() const { return Ops[2]; }
1017 /// Transparently provide more efficient getOperand methods.
1018 Value *getOperand(unsigned i) const {
1019 assert(i < 3 && "getOperand() out of range!");
1022 void setOperand(unsigned i, Value *Val) {
1023 assert(i < 3 && "setOperand() out of range!");
1026 unsigned getNumOperands() const { return 3; }
1028 OtherOps getOpcode() const {
1029 return static_cast<OtherOps>(Instruction::getOpcode());
1032 virtual SelectInst *clone() const;
1034 // Methods for support type inquiry through isa, cast, and dyn_cast:
1035 static inline bool classof(const SelectInst *) { return true; }
1036 static inline bool classof(const Instruction *I) {
1037 return I->getOpcode() == Instruction::Select;
1039 static inline bool classof(const Value *V) {
1040 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1044 //===----------------------------------------------------------------------===//
1046 //===----------------------------------------------------------------------===//
1048 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1049 /// an argument of the specified type given a va_list and increments that list
1051 class VAArgInst : public UnaryInstruction {
1052 VAArgInst(const VAArgInst &VAA)
1053 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
1055 VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
1056 Instruction *InsertBefore = 0)
1057 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1060 VAArgInst(Value *List, const Type *Ty, const std::string &Name,
1061 BasicBlock *InsertAtEnd)
1062 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1066 virtual VAArgInst *clone() const;
1068 // Methods for support type inquiry through isa, cast, and dyn_cast:
1069 static inline bool classof(const VAArgInst *) { return true; }
1070 static inline bool classof(const Instruction *I) {
1071 return I->getOpcode() == VAArg;
1073 static inline bool classof(const Value *V) {
1074 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1078 //===----------------------------------------------------------------------===//
1079 // ExtractElementInst Class
1080 //===----------------------------------------------------------------------===//
1082 /// ExtractElementInst - This instruction extracts a single (scalar)
1083 /// element from a VectorType value
1085 class ExtractElementInst : public Instruction {
1087 ExtractElementInst(const ExtractElementInst &EE) :
1088 Instruction(EE.getType(), ExtractElement, Ops, 2) {
1089 Ops[0].init(EE.Ops[0], this);
1090 Ops[1].init(EE.Ops[1], this);
1094 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
1095 Instruction *InsertBefore = 0);
1096 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name = "",
1097 Instruction *InsertBefore = 0);
1098 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
1099 BasicBlock *InsertAtEnd);
1100 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name,
1101 BasicBlock *InsertAtEnd);
1103 /// isValidOperands - Return true if an extractelement instruction can be
1104 /// formed with the specified operands.
1105 static bool isValidOperands(const Value *Vec, const Value *Idx);
1107 virtual ExtractElementInst *clone() const;
1109 /// Transparently provide more efficient getOperand methods.
1110 Value *getOperand(unsigned i) const {
1111 assert(i < 2 && "getOperand() out of range!");
1114 void setOperand(unsigned i, Value *Val) {
1115 assert(i < 2 && "setOperand() out of range!");
1118 unsigned getNumOperands() const { return 2; }
1120 // Methods for support type inquiry through isa, cast, and dyn_cast:
1121 static inline bool classof(const ExtractElementInst *) { return true; }
1122 static inline bool classof(const Instruction *I) {
1123 return I->getOpcode() == Instruction::ExtractElement;
1125 static inline bool classof(const Value *V) {
1126 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1130 //===----------------------------------------------------------------------===//
1131 // InsertElementInst Class
1132 //===----------------------------------------------------------------------===//
1134 /// InsertElementInst - This instruction inserts a single (scalar)
1135 /// element into a VectorType value
1137 class InsertElementInst : public Instruction {
1139 InsertElementInst(const InsertElementInst &IE);
1141 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1142 const std::string &Name = "",Instruction *InsertBefore = 0);
1143 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1144 const std::string &Name = "",Instruction *InsertBefore = 0);
1145 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1146 const std::string &Name, BasicBlock *InsertAtEnd);
1147 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1148 const std::string &Name, BasicBlock *InsertAtEnd);
1150 /// isValidOperands - Return true if an insertelement instruction can be
1151 /// formed with the specified operands.
1152 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1155 virtual InsertElementInst *clone() const;
1157 /// getType - Overload to return most specific vector type.
1159 inline const VectorType *getType() const {
1160 return reinterpret_cast<const VectorType*>(Instruction::getType());
1163 /// Transparently provide more efficient getOperand methods.
1164 Value *getOperand(unsigned i) const {
1165 assert(i < 3 && "getOperand() out of range!");
1168 void setOperand(unsigned i, Value *Val) {
1169 assert(i < 3 && "setOperand() out of range!");
1172 unsigned getNumOperands() const { return 3; }
1174 // Methods for support type inquiry through isa, cast, and dyn_cast:
1175 static inline bool classof(const InsertElementInst *) { return true; }
1176 static inline bool classof(const Instruction *I) {
1177 return I->getOpcode() == Instruction::InsertElement;
1179 static inline bool classof(const Value *V) {
1180 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1184 //===----------------------------------------------------------------------===//
1185 // ShuffleVectorInst Class
1186 //===----------------------------------------------------------------------===//
1188 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1191 class ShuffleVectorInst : public Instruction {
1193 ShuffleVectorInst(const ShuffleVectorInst &IE);
1195 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1196 const std::string &Name = "", Instruction *InsertBefor = 0);
1197 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1198 const std::string &Name, BasicBlock *InsertAtEnd);
1200 /// isValidOperands - Return true if a shufflevector instruction can be
1201 /// formed with the specified operands.
1202 static bool isValidOperands(const Value *V1, const Value *V2,
1205 virtual ShuffleVectorInst *clone() const;
1207 /// getType - Overload to return most specific vector type.
1209 inline const VectorType *getType() const {
1210 return reinterpret_cast<const VectorType*>(Instruction::getType());
1213 /// Transparently provide more efficient getOperand methods.
1214 Value *getOperand(unsigned i) const {
1215 assert(i < 3 && "getOperand() out of range!");
1218 void setOperand(unsigned i, Value *Val) {
1219 assert(i < 3 && "setOperand() out of range!");
1222 unsigned getNumOperands() const { return 3; }
1224 // Methods for support type inquiry through isa, cast, and dyn_cast:
1225 static inline bool classof(const ShuffleVectorInst *) { return true; }
1226 static inline bool classof(const Instruction *I) {
1227 return I->getOpcode() == Instruction::ShuffleVector;
1229 static inline bool classof(const Value *V) {
1230 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1235 //===----------------------------------------------------------------------===//
1237 //===----------------------------------------------------------------------===//
1239 // PHINode - The PHINode class is used to represent the magical mystical PHI
1240 // node, that can not exist in nature, but can be synthesized in a computer
1241 // scientist's overactive imagination.
1243 class PHINode : public Instruction {
1244 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1245 /// the number actually in use.
1246 unsigned ReservedSpace;
1247 PHINode(const PHINode &PN);
1249 explicit PHINode(const Type *Ty, const std::string &Name = "",
1250 Instruction *InsertBefore = 0)
1251 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1256 PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
1257 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1264 /// reserveOperandSpace - This method can be used to avoid repeated
1265 /// reallocation of PHI operand lists by reserving space for the correct
1266 /// number of operands before adding them. Unlike normal vector reserves,
1267 /// this method can also be used to trim the operand space.
1268 void reserveOperandSpace(unsigned NumValues) {
1269 resizeOperands(NumValues*2);
1272 virtual PHINode *clone() const;
1274 /// getNumIncomingValues - Return the number of incoming edges
1276 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1278 /// getIncomingValue - Return incoming value number x
1280 Value *getIncomingValue(unsigned i) const {
1281 assert(i*2 < getNumOperands() && "Invalid value number!");
1282 return getOperand(i*2);
1284 void setIncomingValue(unsigned i, Value *V) {
1285 assert(i*2 < getNumOperands() && "Invalid value number!");
1288 unsigned getOperandNumForIncomingValue(unsigned i) {
1292 /// getIncomingBlock - Return incoming basic block number x
1294 BasicBlock *getIncomingBlock(unsigned i) const {
1295 return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
1297 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1298 setOperand(i*2+1, reinterpret_cast<Value*>(BB));
1300 unsigned getOperandNumForIncomingBlock(unsigned i) {
1304 /// addIncoming - Add an incoming value to the end of the PHI list
1306 void addIncoming(Value *V, BasicBlock *BB) {
1307 assert(getType() == V->getType() &&
1308 "All operands to PHI node must be the same type as the PHI node!");
1309 unsigned OpNo = NumOperands;
1310 if (OpNo+2 > ReservedSpace)
1311 resizeOperands(0); // Get more space!
1312 // Initialize some new operands.
1313 NumOperands = OpNo+2;
1314 OperandList[OpNo].init(V, this);
1315 OperandList[OpNo+1].init(reinterpret_cast<Value*>(BB), this);
1318 /// removeIncomingValue - Remove an incoming value. This is useful if a
1319 /// predecessor basic block is deleted. The value removed is returned.
1321 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1322 /// is true), the PHI node is destroyed and any uses of it are replaced with
1323 /// dummy values. The only time there should be zero incoming values to a PHI
1324 /// node is when the block is dead, so this strategy is sound.
1326 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1328 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
1329 int Idx = getBasicBlockIndex(BB);
1330 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1331 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1334 /// getBasicBlockIndex - Return the first index of the specified basic
1335 /// block in the value list for this PHI. Returns -1 if no instance.
1337 int getBasicBlockIndex(const BasicBlock *BB) const {
1338 Use *OL = OperandList;
1339 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1340 if (OL[i+1] == reinterpret_cast<const Value*>(BB)) return i/2;
1344 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1345 return getIncomingValue(getBasicBlockIndex(BB));
1348 /// hasConstantValue - If the specified PHI node always merges together the
1349 /// same value, return the value, otherwise return null.
1351 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1353 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1354 static inline bool classof(const PHINode *) { return true; }
1355 static inline bool classof(const Instruction *I) {
1356 return I->getOpcode() == Instruction::PHI;
1358 static inline bool classof(const Value *V) {
1359 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1362 void resizeOperands(unsigned NumOperands);
1365 //===----------------------------------------------------------------------===//
1367 //===----------------------------------------------------------------------===//
1369 //===---------------------------------------------------------------------------
1370 /// ReturnInst - Return a value (possibly void), from a function. Execution
1371 /// does not continue in this function any longer.
1373 class ReturnInst : public TerminatorInst {
1374 Use RetVal; // Return Value: null if 'void'.
1375 ReturnInst(const ReturnInst &RI);
1376 void init(Value *RetVal);
1379 // ReturnInst constructors:
1380 // ReturnInst() - 'ret void' instruction
1381 // ReturnInst( null) - 'ret void' instruction
1382 // ReturnInst(Value* X) - 'ret X' instruction
1383 // ReturnInst( null, Inst *) - 'ret void' instruction, insert before I
1384 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
1385 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of BB
1386 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of BB
1388 // NOTE: If the Value* passed is of type void then the constructor behaves as
1389 // if it was passed NULL.
1390 explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0);
1391 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd);
1392 explicit ReturnInst(BasicBlock *InsertAtEnd);
1394 virtual ReturnInst *clone() const;
1396 // Transparently provide more efficient getOperand methods.
1397 Value *getOperand(unsigned i) const {
1398 assert(i < getNumOperands() && "getOperand() out of range!");
1401 void setOperand(unsigned i, Value *Val) {
1402 assert(i < getNumOperands() && "setOperand() out of range!");
1406 Value *getReturnValue() const { return RetVal; }
1408 unsigned getNumSuccessors() const { return 0; }
1410 // Methods for support type inquiry through isa, cast, and dyn_cast:
1411 static inline bool classof(const ReturnInst *) { return true; }
1412 static inline bool classof(const Instruction *I) {
1413 return (I->getOpcode() == Instruction::Ret);
1415 static inline bool classof(const Value *V) {
1416 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1419 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1420 virtual unsigned getNumSuccessorsV() const;
1421 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1424 //===----------------------------------------------------------------------===//
1426 //===----------------------------------------------------------------------===//
1428 //===---------------------------------------------------------------------------
1429 /// BranchInst - Conditional or Unconditional Branch instruction.
1431 class BranchInst : public TerminatorInst {
1432 /// Ops list - Branches are strange. The operands are ordered:
1433 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
1434 /// they don't have to check for cond/uncond branchness.
1436 BranchInst(const BranchInst &BI);
1439 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
1440 // BranchInst(BB *B) - 'br B'
1441 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
1442 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
1443 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
1444 // BranchInst(BB* B, BB *I) - 'br B' insert at end
1445 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
1446 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
1447 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1448 Instruction *InsertBefore = 0);
1449 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
1450 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1451 BasicBlock *InsertAtEnd);
1453 /// Transparently provide more efficient getOperand methods.
1454 Value *getOperand(unsigned i) const {
1455 assert(i < getNumOperands() && "getOperand() out of range!");
1458 void setOperand(unsigned i, Value *Val) {
1459 assert(i < getNumOperands() && "setOperand() out of range!");
1463 virtual BranchInst *clone() const;
1465 inline bool isUnconditional() const { return getNumOperands() == 1; }
1466 inline bool isConditional() const { return getNumOperands() == 3; }
1468 inline Value *getCondition() const {
1469 assert(isConditional() && "Cannot get condition of an uncond branch!");
1470 return getOperand(2);
1473 void setCondition(Value *V) {
1474 assert(isConditional() && "Cannot set condition of unconditional branch!");
1478 // setUnconditionalDest - Change the current branch to an unconditional branch
1479 // targeting the specified block.
1480 // FIXME: Eliminate this ugly method.
1481 void setUnconditionalDest(BasicBlock *Dest) {
1482 if (isConditional()) { // Convert this to an uncond branch.
1487 setOperand(0, reinterpret_cast<Value*>(Dest));
1490 unsigned getNumSuccessors() const { return 1+isConditional(); }
1492 BasicBlock *getSuccessor(unsigned i) const {
1493 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
1494 return cast<BasicBlock>(getOperand(i));
1497 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1498 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
1499 setOperand(idx, reinterpret_cast<Value*>(NewSucc));
1502 // Methods for support type inquiry through isa, cast, and dyn_cast:
1503 static inline bool classof(const BranchInst *) { return true; }
1504 static inline bool classof(const Instruction *I) {
1505 return (I->getOpcode() == Instruction::Br);
1507 static inline bool classof(const Value *V) {
1508 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1511 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1512 virtual unsigned getNumSuccessorsV() const;
1513 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1516 //===----------------------------------------------------------------------===//
1518 //===----------------------------------------------------------------------===//
1520 //===---------------------------------------------------------------------------
1521 /// SwitchInst - Multiway switch
1523 class SwitchInst : public TerminatorInst {
1524 unsigned ReservedSpace;
1525 // Operand[0] = Value to switch on
1526 // Operand[1] = Default basic block destination
1527 // Operand[2n ] = Value to match
1528 // Operand[2n+1] = BasicBlock to go to on match
1529 SwitchInst(const SwitchInst &RI);
1530 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1531 void resizeOperands(unsigned No);
1533 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1534 /// switch on and a default destination. The number of additional cases can
1535 /// be specified here to make memory allocation more efficient. This
1536 /// constructor can also autoinsert before another instruction.
1537 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1538 Instruction *InsertBefore = 0);
1540 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1541 /// switch on and a default destination. The number of additional cases can
1542 /// be specified here to make memory allocation more efficient. This
1543 /// constructor also autoinserts at the end of the specified BasicBlock.
1544 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1545 BasicBlock *InsertAtEnd);
1549 // Accessor Methods for Switch stmt
1550 inline Value *getCondition() const { return getOperand(0); }
1551 void setCondition(Value *V) { setOperand(0, V); }
1553 inline BasicBlock *getDefaultDest() const {
1554 return cast<BasicBlock>(getOperand(1));
1557 /// getNumCases - return the number of 'cases' in this switch instruction.
1558 /// Note that case #0 is always the default case.
1559 unsigned getNumCases() const {
1560 return getNumOperands()/2;
1563 /// getCaseValue - Return the specified case value. Note that case #0, the
1564 /// default destination, does not have a case value.
1565 ConstantInt *getCaseValue(unsigned i) {
1566 assert(i && i < getNumCases() && "Illegal case value to get!");
1567 return getSuccessorValue(i);
1570 /// getCaseValue - Return the specified case value. Note that case #0, the
1571 /// default destination, does not have a case value.
1572 const ConstantInt *getCaseValue(unsigned i) const {
1573 assert(i && i < getNumCases() && "Illegal case value to get!");
1574 return getSuccessorValue(i);
1577 /// findCaseValue - Search all of the case values for the specified constant.
1578 /// If it is explicitly handled, return the case number of it, otherwise
1579 /// return 0 to indicate that it is handled by the default handler.
1580 unsigned findCaseValue(const ConstantInt *C) const {
1581 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1582 if (getCaseValue(i) == C)
1587 /// findCaseDest - Finds the unique case value for a given successor. Returns
1588 /// null if the successor is not found, not unique, or is the default case.
1589 ConstantInt *findCaseDest(BasicBlock *BB) {
1590 if (BB == getDefaultDest()) return NULL;
1592 ConstantInt *CI = NULL;
1593 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
1594 if (getSuccessor(i) == BB) {
1595 if (CI) return NULL; // Multiple cases lead to BB.
1596 else CI = getCaseValue(i);
1602 /// addCase - Add an entry to the switch instruction...
1604 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1606 /// removeCase - This method removes the specified successor from the switch
1607 /// instruction. Note that this cannot be used to remove the default
1608 /// destination (successor #0).
1610 void removeCase(unsigned idx);
1612 virtual SwitchInst *clone() const;
1614 unsigned getNumSuccessors() const { return getNumOperands()/2; }
1615 BasicBlock *getSuccessor(unsigned idx) const {
1616 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1617 return cast<BasicBlock>(getOperand(idx*2+1));
1619 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1620 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1621 setOperand(idx*2+1, reinterpret_cast<Value*>(NewSucc));
1624 // getSuccessorValue - Return the value associated with the specified
1626 inline ConstantInt *getSuccessorValue(unsigned idx) const {
1627 assert(idx < getNumSuccessors() && "Successor # out of range!");
1628 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1631 // Methods for support type inquiry through isa, cast, and dyn_cast:
1632 static inline bool classof(const SwitchInst *) { return true; }
1633 static inline bool classof(const Instruction *I) {
1634 return I->getOpcode() == Instruction::Switch;
1636 static inline bool classof(const Value *V) {
1637 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1640 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1641 virtual unsigned getNumSuccessorsV() const;
1642 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1645 //===----------------------------------------------------------------------===//
1647 //===----------------------------------------------------------------------===//
1649 //===---------------------------------------------------------------------------
1651 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
1652 /// calling convention of the call.
1654 class InvokeInst : public TerminatorInst {
1655 const ParamAttrsList *ParamAttrs;
1656 InvokeInst(const InvokeInst &BI);
1657 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1658 Value* const *Args, unsigned NumArgs);
1660 template<typename InputIterator>
1661 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1662 InputIterator ArgBegin, InputIterator ArgEnd,
1663 const std::string &Name,
1664 // This argument ensures that we have an iterator we can
1665 // do arithmetic on in constant time
1666 std::random_access_iterator_tag) {
1667 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
1669 // This requires that the iterator points to contiguous memory.
1670 init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
1675 /// Construct an InvokeInst given a range of arguments.
1676 /// InputIterator must be a random-access iterator pointing to
1677 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
1678 /// made for random-accessness but not for contiguous storage as
1679 /// that would incur runtime overhead.
1681 /// @brief Construct an InvokeInst from a range of arguments
1682 template<typename InputIterator>
1683 InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1684 InputIterator ArgBegin, InputIterator ArgEnd,
1685 const std::string &Name = "", Instruction *InsertBefore = 0)
1686 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
1687 ->getElementType())->getReturnType(),
1688 Instruction::Invoke, 0, 0, InsertBefore) {
1689 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, Name,
1690 typename std::iterator_traits<InputIterator>::iterator_category());
1693 /// Construct an InvokeInst given a range of arguments.
1694 /// InputIterator must be a random-access iterator pointing to
1695 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
1696 /// made for random-accessness but not for contiguous storage as
1697 /// that would incur runtime overhead.
1699 /// @brief Construct an InvokeInst from a range of arguments
1700 template<typename InputIterator>
1701 InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
1702 InputIterator ArgBegin, InputIterator ArgEnd,
1703 const std::string &Name, BasicBlock *InsertAtEnd)
1704 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
1705 ->getElementType())->getReturnType(),
1706 Instruction::Invoke, 0, 0, InsertAtEnd) {
1707 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, Name,
1708 typename std::iterator_traits<InputIterator>::iterator_category());
1713 virtual InvokeInst *clone() const;
1715 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1717 unsigned getCallingConv() const { return SubclassData; }
1718 void setCallingConv(unsigned CC) {
1722 /// Obtains a pointer to the ParamAttrsList object which holds the
1723 /// parameter attributes information, if any.
1724 /// @returns 0 if no attributes have been set.
1725 /// @brief Get the parameter attributes.
1726 const ParamAttrsList *getParamAttrs() const { return ParamAttrs; }
1728 /// Sets the parameter attributes for this InvokeInst. To construct a
1729 /// ParamAttrsList, see ParameterAttributes.h
1730 /// @brief Set the parameter attributes.
1731 void setParamAttrs(const ParamAttrsList *attrs);
1733 /// @brief Determine whether the call or the callee has the given attribute.
1734 bool paramHasAttr(uint16_t i, ParameterAttributes attr) const;
1736 /// @brief Determine if the call does not access memory.
1737 bool doesNotAccessMemory() const {
1738 return paramHasAttr(0, ParamAttr::ReadNone);
1741 /// @brief Determine if the call does not access or only reads memory.
1742 bool onlyReadsMemory() const {
1743 return doesNotAccessMemory() || paramHasAttr(0, ParamAttr::ReadOnly);
1746 /// @brief Determine if the call cannot return.
1747 bool isNoReturn() const {
1748 return paramHasAttr(0, ParamAttr::NoReturn);
1751 /// @brief Determine if the call cannot unwind.
1752 bool isNoUnwind() const {
1753 return paramHasAttr(0, ParamAttr::NoUnwind);
1756 /// @brief Determine if the call returns a structure.
1757 bool isStructReturn() const {
1758 // Be friendly and also check the callee.
1759 return paramHasAttr(1, ParamAttr::StructRet);
1762 /// getCalledFunction - Return the function called, or null if this is an
1763 /// indirect function invocation.
1765 Function *getCalledFunction() const {
1766 return dyn_cast<Function>(getOperand(0));
1769 // getCalledValue - Get a pointer to a function that is invoked by this inst.
1770 inline Value *getCalledValue() const { return getOperand(0); }
1772 // get*Dest - Return the destination basic blocks...
1773 BasicBlock *getNormalDest() const {
1774 return cast<BasicBlock>(getOperand(1));
1776 BasicBlock *getUnwindDest() const {
1777 return cast<BasicBlock>(getOperand(2));
1779 void setNormalDest(BasicBlock *B) {
1780 setOperand(1, reinterpret_cast<Value*>(B));
1783 void setUnwindDest(BasicBlock *B) {
1784 setOperand(2, reinterpret_cast<Value*>(B));
1787 inline BasicBlock *getSuccessor(unsigned i) const {
1788 assert(i < 2 && "Successor # out of range for invoke!");
1789 return i == 0 ? getNormalDest() : getUnwindDest();
1792 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1793 assert(idx < 2 && "Successor # out of range for invoke!");
1794 setOperand(idx+1, reinterpret_cast<Value*>(NewSucc));
1797 unsigned getNumSuccessors() const { return 2; }
1799 // Methods for support type inquiry through isa, cast, and dyn_cast:
1800 static inline bool classof(const InvokeInst *) { return true; }
1801 static inline bool classof(const Instruction *I) {
1802 return (I->getOpcode() == Instruction::Invoke);
1804 static inline bool classof(const Value *V) {
1805 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1808 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1809 virtual unsigned getNumSuccessorsV() const;
1810 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1814 //===----------------------------------------------------------------------===//
1816 //===----------------------------------------------------------------------===//
1818 //===---------------------------------------------------------------------------
1819 /// UnwindInst - Immediately exit the current function, unwinding the stack
1820 /// until an invoke instruction is found.
1822 class UnwindInst : public TerminatorInst {
1824 explicit UnwindInst(Instruction *InsertBefore = 0);
1825 explicit UnwindInst(BasicBlock *InsertAtEnd);
1827 virtual UnwindInst *clone() const;
1829 unsigned getNumSuccessors() const { return 0; }
1831 // Methods for support type inquiry through isa, cast, and dyn_cast:
1832 static inline bool classof(const UnwindInst *) { return true; }
1833 static inline bool classof(const Instruction *I) {
1834 return I->getOpcode() == Instruction::Unwind;
1836 static inline bool classof(const Value *V) {
1837 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1840 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1841 virtual unsigned getNumSuccessorsV() const;
1842 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1845 //===----------------------------------------------------------------------===//
1846 // UnreachableInst Class
1847 //===----------------------------------------------------------------------===//
1849 //===---------------------------------------------------------------------------
1850 /// UnreachableInst - This function has undefined behavior. In particular, the
1851 /// presence of this instruction indicates some higher level knowledge that the
1852 /// end of the block cannot be reached.
1854 class UnreachableInst : public TerminatorInst {
1856 explicit UnreachableInst(Instruction *InsertBefore = 0);
1857 explicit UnreachableInst(BasicBlock *InsertAtEnd);
1859 virtual UnreachableInst *clone() const;
1861 unsigned getNumSuccessors() const { return 0; }
1863 // Methods for support type inquiry through isa, cast, and dyn_cast:
1864 static inline bool classof(const UnreachableInst *) { return true; }
1865 static inline bool classof(const Instruction *I) {
1866 return I->getOpcode() == Instruction::Unreachable;
1868 static inline bool classof(const Value *V) {
1869 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1872 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1873 virtual unsigned getNumSuccessorsV() const;
1874 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1877 //===----------------------------------------------------------------------===//
1879 //===----------------------------------------------------------------------===//
1881 /// @brief This class represents a truncation of integer types.
1882 class TruncInst : public CastInst {
1883 /// Private copy constructor
1884 TruncInst(const TruncInst &CI)
1885 : CastInst(CI.getType(), Trunc, CI.getOperand(0)) {
1888 /// @brief Constructor with insert-before-instruction semantics
1890 Value *S, ///< The value to be truncated
1891 const Type *Ty, ///< The (smaller) type to truncate to
1892 const std::string &Name = "", ///< A name for the new instruction
1893 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1896 /// @brief Constructor with insert-at-end-of-block semantics
1898 Value *S, ///< The value to be truncated
1899 const Type *Ty, ///< The (smaller) type to truncate to
1900 const std::string &Name, ///< A name for the new instruction
1901 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1904 /// @brief Clone an identical TruncInst
1905 virtual CastInst *clone() const;
1907 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1908 static inline bool classof(const TruncInst *) { return true; }
1909 static inline bool classof(const Instruction *I) {
1910 return I->getOpcode() == Trunc;
1912 static inline bool classof(const Value *V) {
1913 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1917 //===----------------------------------------------------------------------===//
1919 //===----------------------------------------------------------------------===//
1921 /// @brief This class represents zero extension of integer types.
1922 class ZExtInst : public CastInst {
1923 /// @brief Private copy constructor
1924 ZExtInst(const ZExtInst &CI)
1925 : CastInst(CI.getType(), ZExt, CI.getOperand(0)) {
1928 /// @brief Constructor with insert-before-instruction semantics
1930 Value *S, ///< The value to be zero extended
1931 const Type *Ty, ///< The type to zero extend to
1932 const std::string &Name = "", ///< A name for the new instruction
1933 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1936 /// @brief Constructor with insert-at-end semantics.
1938 Value *S, ///< The value to be zero extended
1939 const Type *Ty, ///< The type to zero extend to
1940 const std::string &Name, ///< A name for the new instruction
1941 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1944 /// @brief Clone an identical ZExtInst
1945 virtual CastInst *clone() const;
1947 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1948 static inline bool classof(const ZExtInst *) { return true; }
1949 static inline bool classof(const Instruction *I) {
1950 return I->getOpcode() == ZExt;
1952 static inline bool classof(const Value *V) {
1953 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1957 //===----------------------------------------------------------------------===//
1959 //===----------------------------------------------------------------------===//
1961 /// @brief This class represents a sign extension of integer types.
1962 class SExtInst : public CastInst {
1963 /// @brief Private copy constructor
1964 SExtInst(const SExtInst &CI)
1965 : CastInst(CI.getType(), SExt, CI.getOperand(0)) {
1968 /// @brief Constructor with insert-before-instruction semantics
1970 Value *S, ///< The value to be sign extended
1971 const Type *Ty, ///< The type to sign extend to
1972 const std::string &Name = "", ///< A name for the new instruction
1973 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1976 /// @brief Constructor with insert-at-end-of-block semantics
1978 Value *S, ///< The value to be sign extended
1979 const Type *Ty, ///< The type to sign extend to
1980 const std::string &Name, ///< A name for the new instruction
1981 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1984 /// @brief Clone an identical SExtInst
1985 virtual CastInst *clone() const;
1987 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1988 static inline bool classof(const SExtInst *) { return true; }
1989 static inline bool classof(const Instruction *I) {
1990 return I->getOpcode() == SExt;
1992 static inline bool classof(const Value *V) {
1993 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1997 //===----------------------------------------------------------------------===//
1998 // FPTruncInst Class
1999 //===----------------------------------------------------------------------===//
2001 /// @brief This class represents a truncation of floating point types.
2002 class FPTruncInst : public CastInst {
2003 FPTruncInst(const FPTruncInst &CI)
2004 : CastInst(CI.getType(), FPTrunc, CI.getOperand(0)) {
2007 /// @brief Constructor with insert-before-instruction semantics
2009 Value *S, ///< The value to be truncated
2010 const Type *Ty, ///< The type to truncate to
2011 const std::string &Name = "", ///< A name for the new instruction
2012 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2015 /// @brief Constructor with insert-before-instruction semantics
2017 Value *S, ///< The value to be truncated
2018 const Type *Ty, ///< The type to truncate to
2019 const std::string &Name, ///< A name for the new instruction
2020 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2023 /// @brief Clone an identical FPTruncInst
2024 virtual CastInst *clone() const;
2026 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2027 static inline bool classof(const FPTruncInst *) { return true; }
2028 static inline bool classof(const Instruction *I) {
2029 return I->getOpcode() == FPTrunc;
2031 static inline bool classof(const Value *V) {
2032 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2036 //===----------------------------------------------------------------------===//
2038 //===----------------------------------------------------------------------===//
2040 /// @brief This class represents an extension of floating point types.
2041 class FPExtInst : public CastInst {
2042 FPExtInst(const FPExtInst &CI)
2043 : CastInst(CI.getType(), FPExt, CI.getOperand(0)) {
2046 /// @brief Constructor with insert-before-instruction semantics
2048 Value *S, ///< The value to be extended
2049 const Type *Ty, ///< The type to extend to
2050 const std::string &Name = "", ///< A name for the new instruction
2051 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2054 /// @brief Constructor with insert-at-end-of-block semantics
2056 Value *S, ///< The value to be extended
2057 const Type *Ty, ///< The type to extend to
2058 const std::string &Name, ///< A name for the new instruction
2059 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2062 /// @brief Clone an identical FPExtInst
2063 virtual CastInst *clone() const;
2065 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2066 static inline bool classof(const FPExtInst *) { return true; }
2067 static inline bool classof(const Instruction *I) {
2068 return I->getOpcode() == FPExt;
2070 static inline bool classof(const Value *V) {
2071 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2075 //===----------------------------------------------------------------------===//
2077 //===----------------------------------------------------------------------===//
2079 /// @brief This class represents a cast unsigned integer to floating point.
2080 class UIToFPInst : public CastInst {
2081 UIToFPInst(const UIToFPInst &CI)
2082 : CastInst(CI.getType(), UIToFP, CI.getOperand(0)) {
2085 /// @brief Constructor with insert-before-instruction semantics
2087 Value *S, ///< The value to be converted
2088 const Type *Ty, ///< The type to convert to
2089 const std::string &Name = "", ///< A name for the new instruction
2090 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2093 /// @brief Constructor with insert-at-end-of-block semantics
2095 Value *S, ///< The value to be converted
2096 const Type *Ty, ///< The type to convert to
2097 const std::string &Name, ///< A name for the new instruction
2098 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2101 /// @brief Clone an identical UIToFPInst
2102 virtual CastInst *clone() const;
2104 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2105 static inline bool classof(const UIToFPInst *) { return true; }
2106 static inline bool classof(const Instruction *I) {
2107 return I->getOpcode() == UIToFP;
2109 static inline bool classof(const Value *V) {
2110 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2114 //===----------------------------------------------------------------------===//
2116 //===----------------------------------------------------------------------===//
2118 /// @brief This class represents a cast from signed integer to floating point.
2119 class SIToFPInst : public CastInst {
2120 SIToFPInst(const SIToFPInst &CI)
2121 : CastInst(CI.getType(), SIToFP, CI.getOperand(0)) {
2124 /// @brief Constructor with insert-before-instruction semantics
2126 Value *S, ///< The value to be converted
2127 const Type *Ty, ///< The type to convert to
2128 const std::string &Name = "", ///< A name for the new instruction
2129 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2132 /// @brief Constructor with insert-at-end-of-block semantics
2134 Value *S, ///< The value to be converted
2135 const Type *Ty, ///< The type to convert to
2136 const std::string &Name, ///< A name for the new instruction
2137 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2140 /// @brief Clone an identical SIToFPInst
2141 virtual CastInst *clone() const;
2143 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2144 static inline bool classof(const SIToFPInst *) { return true; }
2145 static inline bool classof(const Instruction *I) {
2146 return I->getOpcode() == SIToFP;
2148 static inline bool classof(const Value *V) {
2149 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2153 //===----------------------------------------------------------------------===//
2155 //===----------------------------------------------------------------------===//
2157 /// @brief This class represents a cast from floating point to unsigned integer
2158 class FPToUIInst : public CastInst {
2159 FPToUIInst(const FPToUIInst &CI)
2160 : CastInst(CI.getType(), FPToUI, CI.getOperand(0)) {
2163 /// @brief Constructor with insert-before-instruction semantics
2165 Value *S, ///< The value to be converted
2166 const Type *Ty, ///< The type to convert to
2167 const std::string &Name = "", ///< A name for the new instruction
2168 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2171 /// @brief Constructor with insert-at-end-of-block semantics
2173 Value *S, ///< The value to be converted
2174 const Type *Ty, ///< The type to convert to
2175 const std::string &Name, ///< A name for the new instruction
2176 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
2179 /// @brief Clone an identical FPToUIInst
2180 virtual CastInst *clone() const;
2182 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2183 static inline bool classof(const FPToUIInst *) { return true; }
2184 static inline bool classof(const Instruction *I) {
2185 return I->getOpcode() == FPToUI;
2187 static inline bool classof(const Value *V) {
2188 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2192 //===----------------------------------------------------------------------===//
2194 //===----------------------------------------------------------------------===//
2196 /// @brief This class represents a cast from floating point to signed integer.
2197 class FPToSIInst : public CastInst {
2198 FPToSIInst(const FPToSIInst &CI)
2199 : CastInst(CI.getType(), FPToSI, CI.getOperand(0)) {
2202 /// @brief Constructor with insert-before-instruction semantics
2204 Value *S, ///< The value to be converted
2205 const Type *Ty, ///< The type to convert to
2206 const std::string &Name = "", ///< A name for the new instruction
2207 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2210 /// @brief Constructor with insert-at-end-of-block semantics
2212 Value *S, ///< The value to be converted
2213 const Type *Ty, ///< The type to convert to
2214 const std::string &Name, ///< A name for the new instruction
2215 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2218 /// @brief Clone an identical FPToSIInst
2219 virtual CastInst *clone() const;
2221 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2222 static inline bool classof(const FPToSIInst *) { return true; }
2223 static inline bool classof(const Instruction *I) {
2224 return I->getOpcode() == FPToSI;
2226 static inline bool classof(const Value *V) {
2227 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2231 //===----------------------------------------------------------------------===//
2232 // IntToPtrInst Class
2233 //===----------------------------------------------------------------------===//
2235 /// @brief This class represents a cast from an integer to a pointer.
2236 class IntToPtrInst : public CastInst {
2237 IntToPtrInst(const IntToPtrInst &CI)
2238 : CastInst(CI.getType(), IntToPtr, CI.getOperand(0)) {
2241 /// @brief Constructor with insert-before-instruction semantics
2243 Value *S, ///< The value to be converted
2244 const Type *Ty, ///< The type to convert to
2245 const std::string &Name = "", ///< A name for the new instruction
2246 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2249 /// @brief Constructor with insert-at-end-of-block semantics
2251 Value *S, ///< The value to be converted
2252 const Type *Ty, ///< The type to convert to
2253 const std::string &Name, ///< A name for the new instruction
2254 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2257 /// @brief Clone an identical IntToPtrInst
2258 virtual CastInst *clone() const;
2260 // Methods for support type inquiry through isa, cast, and dyn_cast:
2261 static inline bool classof(const IntToPtrInst *) { return true; }
2262 static inline bool classof(const Instruction *I) {
2263 return I->getOpcode() == IntToPtr;
2265 static inline bool classof(const Value *V) {
2266 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2270 //===----------------------------------------------------------------------===//
2271 // PtrToIntInst Class
2272 //===----------------------------------------------------------------------===//
2274 /// @brief This class represents a cast from a pointer to an integer
2275 class PtrToIntInst : public CastInst {
2276 PtrToIntInst(const PtrToIntInst &CI)
2277 : CastInst(CI.getType(), PtrToInt, CI.getOperand(0)) {
2280 /// @brief Constructor with insert-before-instruction semantics
2282 Value *S, ///< The value to be converted
2283 const Type *Ty, ///< The type to convert to
2284 const std::string &Name = "", ///< A name for the new instruction
2285 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2288 /// @brief Constructor with insert-at-end-of-block semantics
2290 Value *S, ///< The value to be converted
2291 const Type *Ty, ///< The type to convert to
2292 const std::string &Name, ///< A name for the new instruction
2293 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2296 /// @brief Clone an identical PtrToIntInst
2297 virtual CastInst *clone() const;
2299 // Methods for support type inquiry through isa, cast, and dyn_cast:
2300 static inline bool classof(const PtrToIntInst *) { return true; }
2301 static inline bool classof(const Instruction *I) {
2302 return I->getOpcode() == PtrToInt;
2304 static inline bool classof(const Value *V) {
2305 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2309 //===----------------------------------------------------------------------===//
2310 // BitCastInst Class
2311 //===----------------------------------------------------------------------===//
2313 /// @brief This class represents a no-op cast from one type to another.
2314 class BitCastInst : public CastInst {
2315 BitCastInst(const BitCastInst &CI)
2316 : CastInst(CI.getType(), BitCast, CI.getOperand(0)) {
2319 /// @brief Constructor with insert-before-instruction semantics
2321 Value *S, ///< The value to be casted
2322 const Type *Ty, ///< The type to casted to
2323 const std::string &Name = "", ///< A name for the new instruction
2324 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2327 /// @brief Constructor with insert-at-end-of-block semantics
2329 Value *S, ///< The value to be casted
2330 const Type *Ty, ///< The type to casted to
2331 const std::string &Name, ///< A name for the new instruction
2332 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2335 /// @brief Clone an identical BitCastInst
2336 virtual CastInst *clone() const;
2338 // Methods for support type inquiry through isa, cast, and dyn_cast:
2339 static inline bool classof(const BitCastInst *) { return true; }
2340 static inline bool classof(const Instruction *I) {
2341 return I->getOpcode() == BitCast;
2343 static inline bool classof(const Value *V) {
2344 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2348 } // End llvm namespace