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
19 #include "llvm/InstrTypes.h"
31 //===----------------------------------------------------------------------===//
32 // AllocationInst Class
33 //===----------------------------------------------------------------------===//
35 /// AllocationInst - This class is the common base class of MallocInst and
38 class AllocationInst : public UnaryInstruction {
41 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
42 const std::string &Name = "", Instruction *InsertBefore = 0);
43 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
44 const std::string &Name, BasicBlock *InsertAtEnd);
46 // Out of line virtual method, so the vtable, etc has a home.
47 virtual ~AllocationInst();
49 /// isArrayAllocation - Return true if there is an allocation size parameter
50 /// to the allocation instruction that is not 1.
52 bool isArrayAllocation() const;
54 /// getArraySize - Get the number of element allocated, for a simple
55 /// allocation of a single element, this will return a constant 1 value.
57 inline const Value *getArraySize() const { return getOperand(0); }
58 inline Value *getArraySize() { return getOperand(0); }
60 /// getType - Overload to return most specific pointer type
62 inline const PointerType *getType() const {
63 return reinterpret_cast<const PointerType*>(Instruction::getType());
66 /// getAllocatedType - Return the type that is being allocated by the
69 const Type *getAllocatedType() const;
71 /// getAlignment - Return the alignment of the memory that is being allocated
72 /// by the instruction.
74 unsigned getAlignment() const { return Alignment; }
75 void setAlignment(unsigned Align) {
76 assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
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 &Name = "",
105 Instruction *InsertBefore = 0)
106 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
107 MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
108 BasicBlock *InsertAtEnd)
109 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
111 MallocInst(const Type *Ty, const std::string &Name,
112 Instruction *InsertBefore = 0)
113 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
114 MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
115 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
117 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
118 const std::string &Name, BasicBlock *InsertAtEnd)
119 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
120 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
121 const std::string &Name = "",
122 Instruction *InsertBefore = 0)
123 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, 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 &Name = "",
149 Instruction *InsertBefore = 0)
150 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
151 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
152 BasicBlock *InsertAtEnd)
153 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
155 AllocaInst(const Type *Ty, const std::string &Name,
156 Instruction *InsertBefore = 0)
157 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
158 AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
159 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
161 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
162 const std::string &Name = "", Instruction *InsertBefore = 0)
163 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
164 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
165 const std::string &Name, BasicBlock *InsertAtEnd)
166 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
168 virtual AllocaInst *clone() const;
170 // Methods for support type inquiry through isa, cast, and dyn_cast:
171 static inline bool classof(const AllocaInst *) { return true; }
172 static inline bool classof(const Instruction *I) {
173 return (I->getOpcode() == Instruction::Alloca);
175 static inline bool classof(const Value *V) {
176 return isa<Instruction>(V) && classof(cast<Instruction>(V));
181 //===----------------------------------------------------------------------===//
183 //===----------------------------------------------------------------------===//
185 /// FreeInst - an instruction to deallocate memory
187 class FreeInst : public UnaryInstruction {
190 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
191 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
193 virtual FreeInst *clone() const;
195 // Methods for support type inquiry through isa, cast, and dyn_cast:
196 static inline bool classof(const FreeInst *) { return true; }
197 static inline bool classof(const Instruction *I) {
198 return (I->getOpcode() == Instruction::Free);
200 static inline bool classof(const Value *V) {
201 return isa<Instruction>(V) && classof(cast<Instruction>(V));
206 //===----------------------------------------------------------------------===//
208 //===----------------------------------------------------------------------===//
210 /// LoadInst - an instruction for reading from memory. This uses the
211 /// SubclassData field in Value to store whether or not the load is volatile.
213 class LoadInst : public UnaryInstruction {
215 LoadInst(const LoadInst &LI)
216 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
217 setVolatile(LI.isVolatile());
218 setAlignment(LI.getAlignment());
226 LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
227 LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
228 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile = false,
229 Instruction *InsertBefore = 0);
230 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, unsigned Align,
231 Instruction *InsertBefore = 0);
232 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
233 BasicBlock *InsertAtEnd);
235 LoadInst(Value *Ptr, const char *Name, Instruction *InsertBefore);
236 LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAtEnd);
237 explicit LoadInst(Value *Ptr, const char *Name = 0, bool isVolatile = false,
238 Instruction *InsertBefore = 0);
239 LoadInst(Value *Ptr, const char *Name, bool isVolatile,
240 BasicBlock *InsertAtEnd);
242 /// isVolatile - Return true if this is a load from a volatile memory
245 bool isVolatile() const { return SubclassData & 1; }
247 /// setVolatile - Specify whether this is a volatile load or not.
249 void setVolatile(bool V) {
250 SubclassData = (SubclassData & ~1) | ((V) ? 1 : 0);
253 virtual LoadInst *clone() const;
255 /// getAlignment - Return the alignment of the access that is being performed
257 unsigned getAlignment() const {
258 return (1 << (SubclassData>>1)) >> 1;
261 void setAlignment(unsigned Align);
263 Value *getPointerOperand() { return getOperand(0); }
264 const Value *getPointerOperand() const { return getOperand(0); }
265 static unsigned getPointerOperandIndex() { return 0U; }
267 // Methods for support type inquiry through isa, cast, and dyn_cast:
268 static inline bool classof(const LoadInst *) { return true; }
269 static inline bool classof(const Instruction *I) {
270 return I->getOpcode() == Instruction::Load;
272 static inline bool classof(const Value *V) {
273 return isa<Instruction>(V) && classof(cast<Instruction>(V));
278 //===----------------------------------------------------------------------===//
280 //===----------------------------------------------------------------------===//
282 /// StoreInst - an instruction for storing to memory
284 class StoreInst : public Instruction {
287 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store, Ops, 2) {
288 Ops[0].init(SI.Ops[0], this);
289 Ops[1].init(SI.Ops[1], this);
290 setVolatile(SI.isVolatile());
291 setAlignment(SI.getAlignment());
299 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
300 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
301 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
302 Instruction *InsertBefore = 0);
303 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
304 unsigned Align, Instruction *InsertBefore = 0);
305 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
308 /// isVolatile - Return true if this is a load from a volatile memory
311 bool isVolatile() const { return SubclassData & 1; }
313 /// setVolatile - Specify whether this is a volatile load or not.
315 void setVolatile(bool V) {
316 SubclassData = (SubclassData & ~1) | ((V) ? 1 : 0);
319 /// Transparently provide more efficient getOperand methods.
320 Value *getOperand(unsigned i) const {
321 assert(i < 2 && "getOperand() out of range!");
324 void setOperand(unsigned i, Value *Val) {
325 assert(i < 2 && "setOperand() out of range!");
328 unsigned getNumOperands() const { return 2; }
330 /// getAlignment - Return the alignment of the access that is being performed
332 unsigned getAlignment() const {
333 return (1 << (SubclassData>>1)) >> 1;
336 void setAlignment(unsigned Align);
338 virtual StoreInst *clone() const;
340 Value *getPointerOperand() { return getOperand(1); }
341 const Value *getPointerOperand() const { return getOperand(1); }
342 static unsigned getPointerOperandIndex() { return 1U; }
344 // Methods for support type inquiry through isa, cast, and dyn_cast:
345 static inline bool classof(const StoreInst *) { return true; }
346 static inline bool classof(const Instruction *I) {
347 return I->getOpcode() == Instruction::Store;
349 static inline bool classof(const Value *V) {
350 return isa<Instruction>(V) && classof(cast<Instruction>(V));
355 //===----------------------------------------------------------------------===//
356 // GetElementPtrInst Class
357 //===----------------------------------------------------------------------===//
359 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
360 /// access elements of arrays and structs
362 class GetElementPtrInst : public Instruction {
363 GetElementPtrInst(const GetElementPtrInst &GEPI)
364 : Instruction(reinterpret_cast<const Type*>(GEPI.getType()), GetElementPtr,
365 0, GEPI.getNumOperands()) {
366 Use *OL = OperandList = new Use[NumOperands];
367 Use *GEPIOL = GEPI.OperandList;
368 for (unsigned i = 0, E = NumOperands; i != E; ++i)
369 OL[i].init(GEPIOL[i], this);
371 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx);
372 void init(Value *Ptr, Value *Idx0, Value *Idx1);
373 void init(Value *Ptr, Value *Idx);
375 /// Constructors - Create a getelementptr instruction with a base pointer an
376 /// list of indices. The first ctor can optionally insert before an existing
377 /// instruction, the second appends the new instruction to the specified
379 GetElementPtrInst(Value *Ptr, Value* const *Idx, unsigned NumIdx,
380 const std::string &Name = "", Instruction *InsertBefore =0);
381 GetElementPtrInst(Value *Ptr, Value* const *Idx, unsigned NumIdx,
382 const std::string &Name, BasicBlock *InsertAtEnd);
384 /// Constructors - These two constructors are convenience methods because one
385 /// and two index getelementptr instructions are so common.
386 GetElementPtrInst(Value *Ptr, Value *Idx,
387 const std::string &Name = "", Instruction *InsertBefore =0);
388 GetElementPtrInst(Value *Ptr, Value *Idx,
389 const std::string &Name, BasicBlock *InsertAtEnd);
390 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
391 const std::string &Name = "", Instruction *InsertBefore =0);
392 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
393 const std::string &Name, BasicBlock *InsertAtEnd);
394 ~GetElementPtrInst();
396 virtual GetElementPtrInst *clone() const;
398 // getType - Overload to return most specific pointer type...
399 inline const PointerType *getType() const {
400 return reinterpret_cast<const PointerType*>(Instruction::getType());
403 /// getIndexedType - Returns the type of the element that would be loaded with
404 /// a load instruction with the specified parameters.
406 /// A null type is returned if the indices are invalid for the specified
409 static const Type *getIndexedType(const Type *Ptr,
410 Value* const *Idx, unsigned NumIdx,
411 bool AllowStructLeaf = false);
413 static const Type *getIndexedType(const Type *Ptr, Value *Idx0, Value *Idx1,
414 bool AllowStructLeaf = false);
415 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
417 inline op_iterator idx_begin() { return op_begin()+1; }
418 inline const_op_iterator idx_begin() const { return op_begin()+1; }
419 inline op_iterator idx_end() { return op_end(); }
420 inline const_op_iterator idx_end() const { return op_end(); }
422 Value *getPointerOperand() {
423 return getOperand(0);
425 const Value *getPointerOperand() const {
426 return getOperand(0);
428 static unsigned getPointerOperandIndex() {
429 return 0U; // get index for modifying correct operand
432 inline unsigned getNumIndices() const { // Note: always non-negative
433 return getNumOperands() - 1;
436 inline bool hasIndices() const {
437 return getNumOperands() > 1;
440 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
441 /// zeros. If so, the result pointer and the first operand have the same
442 /// value, just potentially different types.
443 bool hasAllZeroIndices() const;
445 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
446 /// constant integers. If so, the result pointer and the first operand have
447 /// a constant offset between them.
448 bool hasAllConstantIndices() const;
451 // Methods for support type inquiry through isa, cast, and dyn_cast:
452 static inline bool classof(const GetElementPtrInst *) { return true; }
453 static inline bool classof(const Instruction *I) {
454 return (I->getOpcode() == Instruction::GetElementPtr);
456 static inline bool classof(const Value *V) {
457 return isa<Instruction>(V) && classof(cast<Instruction>(V));
461 //===----------------------------------------------------------------------===//
463 //===----------------------------------------------------------------------===//
465 /// This instruction compares its operands according to the predicate given
466 /// to the constructor. It only operates on integers, pointers, or packed
467 /// vectors of integrals. The two operands must be the same type.
468 /// @brief Represent an integer comparison operator.
469 class ICmpInst: public CmpInst {
471 /// This enumeration lists the possible predicates for the ICmpInst. The
472 /// values in the range 0-31 are reserved for FCmpInst while values in the
473 /// range 32-64 are reserved for ICmpInst. This is necessary to ensure the
474 /// predicate values are not overlapping between the classes.
476 ICMP_EQ = 32, ///< equal
477 ICMP_NE = 33, ///< not equal
478 ICMP_UGT = 34, ///< unsigned greater than
479 ICMP_UGE = 35, ///< unsigned greater or equal
480 ICMP_ULT = 36, ///< unsigned less than
481 ICMP_ULE = 37, ///< unsigned less or equal
482 ICMP_SGT = 38, ///< signed greater than
483 ICMP_SGE = 39, ///< signed greater or equal
484 ICMP_SLT = 40, ///< signed less than
485 ICMP_SLE = 41, ///< signed less or equal
486 FIRST_ICMP_PREDICATE = ICMP_EQ,
487 LAST_ICMP_PREDICATE = ICMP_SLE,
488 BAD_ICMP_PREDICATE = ICMP_SLE + 1
491 /// @brief Constructor with insert-before-instruction semantics.
493 Predicate pred, ///< The predicate to use for the comparison
494 Value *LHS, ///< The left-hand-side of the expression
495 Value *RHS, ///< The right-hand-side of the expression
496 const std::string &Name = "", ///< Name of the instruction
497 Instruction *InsertBefore = 0 ///< Where to insert
498 ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertBefore) {
501 /// @brief Constructor with insert-at-block-end semantics.
503 Predicate pred, ///< The predicate to use for the comparison
504 Value *LHS, ///< The left-hand-side of the expression
505 Value *RHS, ///< The right-hand-side of the expression
506 const std::string &Name, ///< Name of the instruction
507 BasicBlock *InsertAtEnd ///< Block to insert into.
508 ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertAtEnd) {
511 /// @brief Return the predicate for this instruction.
512 Predicate getPredicate() const { return Predicate(SubclassData); }
514 /// @brief Set the predicate for this instruction to the specified value.
515 void setPredicate(Predicate P) { SubclassData = P; }
517 /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
518 /// @returns the inverse predicate for the instruction's current predicate.
519 /// @brief Return the inverse of the instruction's predicate.
520 Predicate getInversePredicate() const {
521 return getInversePredicate(getPredicate());
524 /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
525 /// @returns the inverse predicate for predicate provided in \p pred.
526 /// @brief Return the inverse of a given predicate
527 static Predicate getInversePredicate(Predicate pred);
529 /// For example, EQ->EQ, SLE->SGE, ULT->UGT, etc.
530 /// @returns the predicate that would be the result of exchanging the two
531 /// operands of the ICmpInst instruction without changing the result
533 /// @brief Return the predicate as if the operands were swapped
534 Predicate getSwappedPredicate() const {
535 return getSwappedPredicate(getPredicate());
538 /// This is a static version that you can use without an instruction
540 /// @brief Return the predicate as if the operands were swapped.
541 static Predicate getSwappedPredicate(Predicate pred);
543 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
544 /// @returns the predicate that would be the result if the operand were
545 /// regarded as signed.
546 /// @brief Return the signed version of the predicate
547 Predicate getSignedPredicate() const {
548 return getSignedPredicate(getPredicate());
551 /// This is a static version that you can use without an instruction.
552 /// @brief Return the signed version of the predicate.
553 static Predicate getSignedPredicate(Predicate pred);
555 /// This also tests for commutativity. If isEquality() returns true then
556 /// the predicate is also commutative.
557 /// @returns true if the predicate of this instruction is EQ or NE.
558 /// @brief Determine if this is an equality predicate.
559 bool isEquality() const {
560 return SubclassData == ICMP_EQ || SubclassData == ICMP_NE;
563 /// @returns true if the predicate of this ICmpInst is commutative
564 /// @brief Determine if this relation is commutative.
565 bool isCommutative() const { return isEquality(); }
567 /// @returns true if the predicate is relational (not EQ or NE).
568 /// @brief Determine if this a relational predicate.
569 bool isRelational() const {
570 return !isEquality();
573 /// @returns true if the predicate of this ICmpInst is signed, false otherwise
574 /// @brief Determine if this instruction's predicate is signed.
575 bool isSignedPredicate() { return isSignedPredicate(getPredicate()); }
577 /// @returns true if the predicate provided is signed, false otherwise
578 /// @brief Determine if the predicate is signed.
579 static bool isSignedPredicate(Predicate pred);
581 /// Initialize a set of values that all satisfy the predicate with C.
582 /// @brief Make a ConstantRange for a relation with a constant value.
583 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
585 /// Exchange the two operands to this instruction in such a way that it does
586 /// not modify the semantics of the instruction. The predicate value may be
587 /// changed to retain the same result if the predicate is order dependent
589 /// @brief Swap operands and adjust predicate.
590 void swapOperands() {
591 SubclassData = getSwappedPredicate();
592 std::swap(Ops[0], Ops[1]);
595 // Methods for support type inquiry through isa, cast, and dyn_cast:
596 static inline bool classof(const ICmpInst *) { return true; }
597 static inline bool classof(const Instruction *I) {
598 return I->getOpcode() == Instruction::ICmp;
600 static inline bool classof(const Value *V) {
601 return isa<Instruction>(V) && classof(cast<Instruction>(V));
605 //===----------------------------------------------------------------------===//
607 //===----------------------------------------------------------------------===//
609 /// This instruction compares its operands according to the predicate given
610 /// to the constructor. It only operates on floating point values or packed
611 /// vectors of floating point values. The operands must be identical types.
612 /// @brief Represents a floating point comparison operator.
613 class FCmpInst: public CmpInst {
615 /// This enumeration lists the possible predicates for the FCmpInst. Values
616 /// in the range 0-31 are reserved for FCmpInst.
618 // Opcode U L G E Intuitive operation
619 FCMP_FALSE = 0, ///< 0 0 0 0 Always false (always folded)
620 FCMP_OEQ = 1, ///< 0 0 0 1 True if ordered and equal
621 FCMP_OGT = 2, ///< 0 0 1 0 True if ordered and greater than
622 FCMP_OGE = 3, ///< 0 0 1 1 True if ordered and greater than or equal
623 FCMP_OLT = 4, ///< 0 1 0 0 True if ordered and less than
624 FCMP_OLE = 5, ///< 0 1 0 1 True if ordered and less than or equal
625 FCMP_ONE = 6, ///< 0 1 1 0 True if ordered and operands are unequal
626 FCMP_ORD = 7, ///< 0 1 1 1 True if ordered (no nans)
627 FCMP_UNO = 8, ///< 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
628 FCMP_UEQ = 9, ///< 1 0 0 1 True if unordered or equal
629 FCMP_UGT =10, ///< 1 0 1 0 True if unordered or greater than
630 FCMP_UGE =11, ///< 1 0 1 1 True if unordered, greater than, or equal
631 FCMP_ULT =12, ///< 1 1 0 0 True if unordered or less than
632 FCMP_ULE =13, ///< 1 1 0 1 True if unordered, less than, or equal
633 FCMP_UNE =14, ///< 1 1 1 0 True if unordered or not equal
634 FCMP_TRUE =15, ///< 1 1 1 1 Always true (always folded)
635 FIRST_FCMP_PREDICATE = FCMP_FALSE,
636 LAST_FCMP_PREDICATE = FCMP_TRUE,
637 BAD_FCMP_PREDICATE = FCMP_TRUE + 1
640 /// @brief Constructor with insert-before-instruction semantics.
642 Predicate pred, ///< The predicate to use for the comparison
643 Value *LHS, ///< The left-hand-side of the expression
644 Value *RHS, ///< The right-hand-side of the expression
645 const std::string &Name = "", ///< Name of the instruction
646 Instruction *InsertBefore = 0 ///< Where to insert
647 ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertBefore) {
650 /// @brief Constructor with insert-at-block-end semantics.
652 Predicate pred, ///< The predicate to use for the comparison
653 Value *LHS, ///< The left-hand-side of the expression
654 Value *RHS, ///< The right-hand-side of the expression
655 const std::string &Name, ///< Name of the instruction
656 BasicBlock *InsertAtEnd ///< Block to insert into.
657 ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertAtEnd) {
660 /// @brief Return the predicate for this instruction.
661 Predicate getPredicate() const { return Predicate(SubclassData); }
663 /// @brief Set the predicate for this instruction to the specified value.
664 void setPredicate(Predicate P) { SubclassData = P; }
666 /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
667 /// @returns the inverse predicate for the instructions current predicate.
668 /// @brief Return the inverse of the predicate
669 Predicate getInversePredicate() const {
670 return getInversePredicate(getPredicate());
673 /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
674 /// @returns the inverse predicate for \p pred.
675 /// @brief Return the inverse of a given predicate
676 static Predicate getInversePredicate(Predicate pred);
678 /// For example, OEQ->OEQ, ULE->UGE, OLT->OGT, etc.
679 /// @returns the predicate that would be the result of exchanging the two
680 /// operands of the ICmpInst instruction without changing the result
682 /// @brief Return the predicate as if the operands were swapped
683 Predicate getSwappedPredicate() const {
684 return getSwappedPredicate(getPredicate());
687 /// This is a static version that you can use without an instruction
689 /// @brief Return the predicate as if the operands were swapped.
690 static Predicate getSwappedPredicate(Predicate Opcode);
692 /// This also tests for commutativity. If isEquality() returns true then
693 /// the predicate is also commutative. Only the equality predicates are
695 /// @returns true if the predicate of this instruction is EQ or NE.
696 /// @brief Determine if this is an equality predicate.
697 bool isEquality() const {
698 return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
699 SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
701 bool isCommutative() const { return isEquality(); }
703 /// @returns true if the predicate is relational (not EQ or NE).
704 /// @brief Determine if this a relational predicate.
705 bool isRelational() const { return !isEquality(); }
707 /// Exchange the two operands to this instruction in such a way that it does
708 /// not modify the semantics of the instruction. The predicate value may be
709 /// changed to retain the same result if the predicate is order dependent
711 /// @brief Swap operands and adjust predicate.
712 void swapOperands() {
713 SubclassData = getSwappedPredicate();
714 std::swap(Ops[0], Ops[1]);
717 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
718 static inline bool classof(const FCmpInst *) { return true; }
719 static inline bool classof(const Instruction *I) {
720 return I->getOpcode() == Instruction::FCmp;
722 static inline bool classof(const Value *V) {
723 return isa<Instruction>(V) && classof(cast<Instruction>(V));
727 //===----------------------------------------------------------------------===//
729 //===----------------------------------------------------------------------===//
731 /// CallInst - This class represents a function call, abstracting a target
732 /// machine's calling convention. This class uses low bit of the SubClassData
733 /// field to indicate whether or not this is a tail call. The rest of the bits
734 /// hold the calling convention of the call.
736 class CallInst : public Instruction {
737 ParamAttrsList *ParamAttrs; ///< parameter attributes for call
738 CallInst(const CallInst &CI);
739 void init(Value *Func, Value* const *Params, unsigned NumParams);
740 void init(Value *Func, Value *Actual1, Value *Actual2);
741 void init(Value *Func, Value *Actual);
742 void init(Value *Func);
745 CallInst(Value *F, Value* const *Args, unsigned NumArgs,
746 const std::string &Name = "", Instruction *InsertBefore = 0);
747 CallInst(Value *F, Value *const *Args, unsigned NumArgs,
748 const std::string &Name, BasicBlock *InsertAtEnd);
750 // Alternate CallInst ctors w/ two actuals, w/ one actual and no
751 // actuals, respectively.
752 CallInst(Value *F, Value *Actual1, Value *Actual2,
753 const std::string& Name = "", Instruction *InsertBefore = 0);
754 CallInst(Value *F, Value *Actual1, Value *Actual2,
755 const std::string& Name, BasicBlock *InsertAtEnd);
756 CallInst(Value *F, Value *Actual, const std::string& Name = "",
757 Instruction *InsertBefore = 0);
758 CallInst(Value *F, Value *Actual, const std::string& Name,
759 BasicBlock *InsertAtEnd);
760 explicit CallInst(Value *F, const std::string &Name = "",
761 Instruction *InsertBefore = 0);
762 CallInst(Value *F, const std::string &Name, BasicBlock *InsertAtEnd);
765 virtual CallInst *clone() const;
767 bool isTailCall() const { return SubclassData & 1; }
768 void setTailCall(bool isTailCall = true) {
769 SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
772 /// getCallingConv/setCallingConv - Get or set the calling convention of this
774 unsigned getCallingConv() const { return SubclassData >> 1; }
775 void setCallingConv(unsigned CC) {
776 SubclassData = (SubclassData & 1) | (CC << 1);
779 /// Obtains a pointer to the ParamAttrsList object which holds the
780 /// parameter attributes information, if any.
781 /// @returns 0 if no attributes have been set.
782 /// @brief Get the parameter attributes.
783 ParamAttrsList *getParamAttrs() const { return ParamAttrs; }
785 /// Sets the parameter attributes for this CallInst. To construct a
786 /// ParamAttrsList, see ParameterAttributes.h
787 /// @brief Set the parameter attributes.
788 void setParamAttrs(ParamAttrsList *attrs);
790 /// getCalledFunction - Return the function being called by this instruction
791 /// if it is a direct call. If it is a call through a function pointer,
793 Function *getCalledFunction() const {
794 return static_cast<Function*>(dyn_cast<Function>(getOperand(0)));
797 /// getCalledValue - Get a pointer to the function that is invoked by this
799 inline const Value *getCalledValue() const { return getOperand(0); }
800 inline Value *getCalledValue() { return getOperand(0); }
802 // Methods for support type inquiry through isa, cast, and dyn_cast:
803 static inline bool classof(const CallInst *) { return true; }
804 static inline bool classof(const Instruction *I) {
805 return I->getOpcode() == Instruction::Call;
807 static inline bool classof(const Value *V) {
808 return isa<Instruction>(V) && classof(cast<Instruction>(V));
812 //===----------------------------------------------------------------------===//
814 //===----------------------------------------------------------------------===//
816 /// SelectInst - This class represents the LLVM 'select' instruction.
818 class SelectInst : public Instruction {
821 void init(Value *C, Value *S1, Value *S2) {
822 Ops[0].init(C, this);
823 Ops[1].init(S1, this);
824 Ops[2].init(S2, this);
827 SelectInst(const SelectInst &SI)
828 : Instruction(SI.getType(), SI.getOpcode(), Ops, 3) {
829 init(SI.Ops[0], SI.Ops[1], SI.Ops[2]);
832 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
833 Instruction *InsertBefore = 0)
834 : Instruction(S1->getType(), Instruction::Select, Ops, 3, InsertBefore) {
838 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
839 BasicBlock *InsertAtEnd)
840 : Instruction(S1->getType(), Instruction::Select, Ops, 3, InsertAtEnd) {
845 Value *getCondition() const { return Ops[0]; }
846 Value *getTrueValue() const { return Ops[1]; }
847 Value *getFalseValue() const { return Ops[2]; }
849 /// Transparently provide more efficient getOperand methods.
850 Value *getOperand(unsigned i) const {
851 assert(i < 3 && "getOperand() out of range!");
854 void setOperand(unsigned i, Value *Val) {
855 assert(i < 3 && "setOperand() out of range!");
858 unsigned getNumOperands() const { return 3; }
860 OtherOps getOpcode() const {
861 return static_cast<OtherOps>(Instruction::getOpcode());
864 virtual SelectInst *clone() const;
866 // Methods for support type inquiry through isa, cast, and dyn_cast:
867 static inline bool classof(const SelectInst *) { return true; }
868 static inline bool classof(const Instruction *I) {
869 return I->getOpcode() == Instruction::Select;
871 static inline bool classof(const Value *V) {
872 return isa<Instruction>(V) && classof(cast<Instruction>(V));
876 //===----------------------------------------------------------------------===//
878 //===----------------------------------------------------------------------===//
880 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
881 /// an argument of the specified type given a va_list and increments that list
883 class VAArgInst : public UnaryInstruction {
884 VAArgInst(const VAArgInst &VAA)
885 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
887 VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
888 Instruction *InsertBefore = 0)
889 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
892 VAArgInst(Value *List, const Type *Ty, const std::string &Name,
893 BasicBlock *InsertAtEnd)
894 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
898 virtual VAArgInst *clone() const;
900 // Methods for support type inquiry through isa, cast, and dyn_cast:
901 static inline bool classof(const VAArgInst *) { return true; }
902 static inline bool classof(const Instruction *I) {
903 return I->getOpcode() == VAArg;
905 static inline bool classof(const Value *V) {
906 return isa<Instruction>(V) && classof(cast<Instruction>(V));
910 //===----------------------------------------------------------------------===//
911 // ExtractElementInst Class
912 //===----------------------------------------------------------------------===//
914 /// ExtractElementInst - This instruction extracts a single (scalar)
915 /// element from a VectorType value
917 class ExtractElementInst : public Instruction {
919 ExtractElementInst(const ExtractElementInst &EE) :
920 Instruction(EE.getType(), ExtractElement, Ops, 2) {
921 Ops[0].init(EE.Ops[0], this);
922 Ops[1].init(EE.Ops[1], this);
926 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
927 Instruction *InsertBefore = 0);
928 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name = "",
929 Instruction *InsertBefore = 0);
930 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
931 BasicBlock *InsertAtEnd);
932 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name,
933 BasicBlock *InsertAtEnd);
935 /// isValidOperands - Return true if an extractelement instruction can be
936 /// formed with the specified operands.
937 static bool isValidOperands(const Value *Vec, const Value *Idx);
939 virtual ExtractElementInst *clone() const;
941 /// Transparently provide more efficient getOperand methods.
942 Value *getOperand(unsigned i) const {
943 assert(i < 2 && "getOperand() out of range!");
946 void setOperand(unsigned i, Value *Val) {
947 assert(i < 2 && "setOperand() out of range!");
950 unsigned getNumOperands() const { return 2; }
952 // Methods for support type inquiry through isa, cast, and dyn_cast:
953 static inline bool classof(const ExtractElementInst *) { return true; }
954 static inline bool classof(const Instruction *I) {
955 return I->getOpcode() == Instruction::ExtractElement;
957 static inline bool classof(const Value *V) {
958 return isa<Instruction>(V) && classof(cast<Instruction>(V));
962 //===----------------------------------------------------------------------===//
963 // InsertElementInst Class
964 //===----------------------------------------------------------------------===//
966 /// InsertElementInst - This instruction inserts a single (scalar)
967 /// element into a VectorType value
969 class InsertElementInst : public Instruction {
971 InsertElementInst(const InsertElementInst &IE);
973 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
974 const std::string &Name = "",Instruction *InsertBefore = 0);
975 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
976 const std::string &Name = "",Instruction *InsertBefore = 0);
977 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
978 const std::string &Name, BasicBlock *InsertAtEnd);
979 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
980 const std::string &Name, BasicBlock *InsertAtEnd);
982 /// isValidOperands - Return true if an insertelement instruction can be
983 /// formed with the specified operands.
984 static bool isValidOperands(const Value *Vec, const Value *NewElt,
987 virtual InsertElementInst *clone() const;
989 /// getType - Overload to return most specific vector type.
991 inline const VectorType *getType() const {
992 return reinterpret_cast<const VectorType*>(Instruction::getType());
995 /// Transparently provide more efficient getOperand methods.
996 Value *getOperand(unsigned i) const {
997 assert(i < 3 && "getOperand() out of range!");
1000 void setOperand(unsigned i, Value *Val) {
1001 assert(i < 3 && "setOperand() out of range!");
1004 unsigned getNumOperands() const { return 3; }
1006 // Methods for support type inquiry through isa, cast, and dyn_cast:
1007 static inline bool classof(const InsertElementInst *) { return true; }
1008 static inline bool classof(const Instruction *I) {
1009 return I->getOpcode() == Instruction::InsertElement;
1011 static inline bool classof(const Value *V) {
1012 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1016 //===----------------------------------------------------------------------===//
1017 // ShuffleVectorInst Class
1018 //===----------------------------------------------------------------------===//
1020 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1023 class ShuffleVectorInst : public Instruction {
1025 ShuffleVectorInst(const ShuffleVectorInst &IE);
1027 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1028 const std::string &Name = "", Instruction *InsertBefor = 0);
1029 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1030 const std::string &Name, BasicBlock *InsertAtEnd);
1032 /// isValidOperands - Return true if a shufflevector instruction can be
1033 /// formed with the specified operands.
1034 static bool isValidOperands(const Value *V1, const Value *V2,
1037 virtual ShuffleVectorInst *clone() const;
1039 /// getType - Overload to return most specific vector type.
1041 inline const VectorType *getType() const {
1042 return reinterpret_cast<const VectorType*>(Instruction::getType());
1045 /// Transparently provide more efficient getOperand methods.
1046 Value *getOperand(unsigned i) const {
1047 assert(i < 3 && "getOperand() out of range!");
1050 void setOperand(unsigned i, Value *Val) {
1051 assert(i < 3 && "setOperand() out of range!");
1054 unsigned getNumOperands() const { return 3; }
1056 // Methods for support type inquiry through isa, cast, and dyn_cast:
1057 static inline bool classof(const ShuffleVectorInst *) { return true; }
1058 static inline bool classof(const Instruction *I) {
1059 return I->getOpcode() == Instruction::ShuffleVector;
1061 static inline bool classof(const Value *V) {
1062 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1067 //===----------------------------------------------------------------------===//
1069 //===----------------------------------------------------------------------===//
1071 // PHINode - The PHINode class is used to represent the magical mystical PHI
1072 // node, that can not exist in nature, but can be synthesized in a computer
1073 // scientist's overactive imagination.
1075 class PHINode : public Instruction {
1076 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1077 /// the number actually in use.
1078 unsigned ReservedSpace;
1079 PHINode(const PHINode &PN);
1081 explicit PHINode(const Type *Ty, const std::string &Name = "",
1082 Instruction *InsertBefore = 0)
1083 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1088 PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
1089 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1096 /// reserveOperandSpace - This method can be used to avoid repeated
1097 /// reallocation of PHI operand lists by reserving space for the correct
1098 /// number of operands before adding them. Unlike normal vector reserves,
1099 /// this method can also be used to trim the operand space.
1100 void reserveOperandSpace(unsigned NumValues) {
1101 resizeOperands(NumValues*2);
1104 virtual PHINode *clone() const;
1106 /// getNumIncomingValues - Return the number of incoming edges
1108 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1110 /// getIncomingValue - Return incoming value number x
1112 Value *getIncomingValue(unsigned i) const {
1113 assert(i*2 < getNumOperands() && "Invalid value number!");
1114 return getOperand(i*2);
1116 void setIncomingValue(unsigned i, Value *V) {
1117 assert(i*2 < getNumOperands() && "Invalid value number!");
1120 unsigned getOperandNumForIncomingValue(unsigned i) {
1124 /// getIncomingBlock - Return incoming basic block number x
1126 BasicBlock *getIncomingBlock(unsigned i) const {
1127 return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
1129 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1130 setOperand(i*2+1, reinterpret_cast<Value*>(BB));
1132 unsigned getOperandNumForIncomingBlock(unsigned i) {
1136 /// addIncoming - Add an incoming value to the end of the PHI list
1138 void addIncoming(Value *V, BasicBlock *BB) {
1139 assert(getType() == V->getType() &&
1140 "All operands to PHI node must be the same type as the PHI node!");
1141 unsigned OpNo = NumOperands;
1142 if (OpNo+2 > ReservedSpace)
1143 resizeOperands(0); // Get more space!
1144 // Initialize some new operands.
1145 NumOperands = OpNo+2;
1146 OperandList[OpNo].init(V, this);
1147 OperandList[OpNo+1].init(reinterpret_cast<Value*>(BB), this);
1150 /// removeIncomingValue - Remove an incoming value. This is useful if a
1151 /// predecessor basic block is deleted. The value removed is returned.
1153 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1154 /// is true), the PHI node is destroyed and any uses of it are replaced with
1155 /// dummy values. The only time there should be zero incoming values to a PHI
1156 /// node is when the block is dead, so this strategy is sound.
1158 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1160 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
1161 int Idx = getBasicBlockIndex(BB);
1162 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1163 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1166 /// getBasicBlockIndex - Return the first index of the specified basic
1167 /// block in the value list for this PHI. Returns -1 if no instance.
1169 int getBasicBlockIndex(const BasicBlock *BB) const {
1170 Use *OL = OperandList;
1171 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1172 if (OL[i+1] == reinterpret_cast<const Value*>(BB)) return i/2;
1176 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1177 return getIncomingValue(getBasicBlockIndex(BB));
1180 /// hasConstantValue - If the specified PHI node always merges together the
1181 /// same value, return the value, otherwise return null.
1183 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1185 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1186 static inline bool classof(const PHINode *) { return true; }
1187 static inline bool classof(const Instruction *I) {
1188 return I->getOpcode() == Instruction::PHI;
1190 static inline bool classof(const Value *V) {
1191 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1194 void resizeOperands(unsigned NumOperands);
1197 //===----------------------------------------------------------------------===//
1199 //===----------------------------------------------------------------------===//
1201 //===---------------------------------------------------------------------------
1202 /// ReturnInst - Return a value (possibly void), from a function. Execution
1203 /// does not continue in this function any longer.
1205 class ReturnInst : public TerminatorInst {
1206 Use RetVal; // Return Value: null if 'void'.
1207 ReturnInst(const ReturnInst &RI);
1208 void init(Value *RetVal);
1211 // ReturnInst constructors:
1212 // ReturnInst() - 'ret void' instruction
1213 // ReturnInst( null) - 'ret void' instruction
1214 // ReturnInst(Value* X) - 'ret X' instruction
1215 // ReturnInst( null, Inst *) - 'ret void' instruction, insert before I
1216 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
1217 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of BB
1218 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of BB
1220 // NOTE: If the Value* passed is of type void then the constructor behaves as
1221 // if it was passed NULL.
1222 explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0);
1223 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd);
1224 explicit ReturnInst(BasicBlock *InsertAtEnd);
1226 virtual ReturnInst *clone() const;
1228 // Transparently provide more efficient getOperand methods.
1229 Value *getOperand(unsigned i) const {
1230 assert(i < getNumOperands() && "getOperand() out of range!");
1233 void setOperand(unsigned i, Value *Val) {
1234 assert(i < getNumOperands() && "setOperand() out of range!");
1238 Value *getReturnValue() const { return RetVal; }
1240 unsigned getNumSuccessors() const { return 0; }
1242 // Methods for support type inquiry through isa, cast, and dyn_cast:
1243 static inline bool classof(const ReturnInst *) { return true; }
1244 static inline bool classof(const Instruction *I) {
1245 return (I->getOpcode() == Instruction::Ret);
1247 static inline bool classof(const Value *V) {
1248 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1251 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1252 virtual unsigned getNumSuccessorsV() const;
1253 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1256 //===----------------------------------------------------------------------===//
1258 //===----------------------------------------------------------------------===//
1260 //===---------------------------------------------------------------------------
1261 /// BranchInst - Conditional or Unconditional Branch instruction.
1263 class BranchInst : public TerminatorInst {
1264 /// Ops list - Branches are strange. The operands are ordered:
1265 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
1266 /// they don't have to check for cond/uncond branchness.
1268 BranchInst(const BranchInst &BI);
1271 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
1272 // BranchInst(BB *B) - 'br B'
1273 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
1274 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
1275 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
1276 // BranchInst(BB* B, BB *I) - 'br B' insert at end
1277 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
1278 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
1279 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1280 Instruction *InsertBefore = 0);
1281 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
1282 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1283 BasicBlock *InsertAtEnd);
1285 /// Transparently provide more efficient getOperand methods.
1286 Value *getOperand(unsigned i) const {
1287 assert(i < getNumOperands() && "getOperand() out of range!");
1290 void setOperand(unsigned i, Value *Val) {
1291 assert(i < getNumOperands() && "setOperand() out of range!");
1295 virtual BranchInst *clone() const;
1297 inline bool isUnconditional() const { return getNumOperands() == 1; }
1298 inline bool isConditional() const { return getNumOperands() == 3; }
1300 inline Value *getCondition() const {
1301 assert(isConditional() && "Cannot get condition of an uncond branch!");
1302 return getOperand(2);
1305 void setCondition(Value *V) {
1306 assert(isConditional() && "Cannot set condition of unconditional branch!");
1310 // setUnconditionalDest - Change the current branch to an unconditional branch
1311 // targeting the specified block.
1312 // FIXME: Eliminate this ugly method.
1313 void setUnconditionalDest(BasicBlock *Dest) {
1314 if (isConditional()) { // Convert this to an uncond branch.
1319 setOperand(0, reinterpret_cast<Value*>(Dest));
1322 unsigned getNumSuccessors() const { return 1+isConditional(); }
1324 BasicBlock *getSuccessor(unsigned i) const {
1325 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
1326 return cast<BasicBlock>(getOperand(i));
1329 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1330 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
1331 setOperand(idx, reinterpret_cast<Value*>(NewSucc));
1334 // Methods for support type inquiry through isa, cast, and dyn_cast:
1335 static inline bool classof(const BranchInst *) { return true; }
1336 static inline bool classof(const Instruction *I) {
1337 return (I->getOpcode() == Instruction::Br);
1339 static inline bool classof(const Value *V) {
1340 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1343 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1344 virtual unsigned getNumSuccessorsV() const;
1345 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1348 //===----------------------------------------------------------------------===//
1350 //===----------------------------------------------------------------------===//
1352 //===---------------------------------------------------------------------------
1353 /// SwitchInst - Multiway switch
1355 class SwitchInst : public TerminatorInst {
1356 unsigned ReservedSpace;
1357 // Operand[0] = Value to switch on
1358 // Operand[1] = Default basic block destination
1359 // Operand[2n ] = Value to match
1360 // Operand[2n+1] = BasicBlock to go to on match
1361 SwitchInst(const SwitchInst &RI);
1362 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1363 void resizeOperands(unsigned No);
1365 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1366 /// switch on and a default destination. The number of additional cases can
1367 /// be specified here to make memory allocation more efficient. This
1368 /// constructor can also autoinsert before another instruction.
1369 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1370 Instruction *InsertBefore = 0);
1372 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1373 /// switch on and a default destination. The number of additional cases can
1374 /// be specified here to make memory allocation more efficient. This
1375 /// constructor also autoinserts at the end of the specified BasicBlock.
1376 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1377 BasicBlock *InsertAtEnd);
1381 // Accessor Methods for Switch stmt
1382 inline Value *getCondition() const { return getOperand(0); }
1383 void setCondition(Value *V) { setOperand(0, V); }
1385 inline BasicBlock *getDefaultDest() const {
1386 return cast<BasicBlock>(getOperand(1));
1389 /// getNumCases - return the number of 'cases' in this switch instruction.
1390 /// Note that case #0 is always the default case.
1391 unsigned getNumCases() const {
1392 return getNumOperands()/2;
1395 /// getCaseValue - Return the specified case value. Note that case #0, the
1396 /// default destination, does not have a case value.
1397 ConstantInt *getCaseValue(unsigned i) {
1398 assert(i && i < getNumCases() && "Illegal case value to get!");
1399 return getSuccessorValue(i);
1402 /// getCaseValue - Return the specified case value. Note that case #0, the
1403 /// default destination, does not have a case value.
1404 const ConstantInt *getCaseValue(unsigned i) const {
1405 assert(i && i < getNumCases() && "Illegal case value to get!");
1406 return getSuccessorValue(i);
1409 /// findCaseValue - Search all of the case values for the specified constant.
1410 /// If it is explicitly handled, return the case number of it, otherwise
1411 /// return 0 to indicate that it is handled by the default handler.
1412 unsigned findCaseValue(const ConstantInt *C) const {
1413 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1414 if (getCaseValue(i) == C)
1419 /// findCaseDest - Finds the unique case value for a given successor. Returns
1420 /// null if the successor is not found, not unique, or is the default case.
1421 ConstantInt *findCaseDest(BasicBlock *BB) {
1422 if (BB == getDefaultDest()) return NULL;
1424 ConstantInt *CI = NULL;
1425 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
1426 if (getSuccessor(i) == BB) {
1427 if (CI) return NULL; // Multiple cases lead to BB.
1428 else CI = getCaseValue(i);
1434 /// addCase - Add an entry to the switch instruction...
1436 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1438 /// removeCase - This method removes the specified successor from the switch
1439 /// instruction. Note that this cannot be used to remove the default
1440 /// destination (successor #0).
1442 void removeCase(unsigned idx);
1444 virtual SwitchInst *clone() const;
1446 unsigned getNumSuccessors() const { return getNumOperands()/2; }
1447 BasicBlock *getSuccessor(unsigned idx) const {
1448 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1449 return cast<BasicBlock>(getOperand(idx*2+1));
1451 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1452 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1453 setOperand(idx*2+1, reinterpret_cast<Value*>(NewSucc));
1456 // getSuccessorValue - Return the value associated with the specified
1458 inline ConstantInt *getSuccessorValue(unsigned idx) const {
1459 assert(idx < getNumSuccessors() && "Successor # out of range!");
1460 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1463 // Methods for support type inquiry through isa, cast, and dyn_cast:
1464 static inline bool classof(const SwitchInst *) { return true; }
1465 static inline bool classof(const Instruction *I) {
1466 return I->getOpcode() == Instruction::Switch;
1468 static inline bool classof(const Value *V) {
1469 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1472 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1473 virtual unsigned getNumSuccessorsV() const;
1474 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1477 //===----------------------------------------------------------------------===//
1479 //===----------------------------------------------------------------------===//
1481 //===---------------------------------------------------------------------------
1483 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
1484 /// calling convention of the call.
1486 class InvokeInst : public TerminatorInst {
1487 ParamAttrsList *ParamAttrs;
1488 InvokeInst(const InvokeInst &BI);
1489 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1490 Value* const *Args, unsigned NumArgs);
1492 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1493 Value* const* Args, unsigned NumArgs, const std::string &Name = "",
1494 Instruction *InsertBefore = 0);
1495 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1496 Value* const* Args, unsigned NumArgs, const std::string &Name,
1497 BasicBlock *InsertAtEnd);
1500 virtual InvokeInst *clone() const;
1502 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1504 unsigned getCallingConv() const { return SubclassData; }
1505 void setCallingConv(unsigned CC) {
1509 /// Obtains a pointer to the ParamAttrsList object which holds the
1510 /// parameter attributes information, if any.
1511 /// @returns 0 if no attributes have been set.
1512 /// @brief Get the parameter attributes.
1513 ParamAttrsList *getParamAttrs() const { return ParamAttrs; }
1515 /// Sets the parameter attributes for this InvokeInst. To construct a
1516 /// ParamAttrsList, see ParameterAttributes.h
1517 /// @brief Set the parameter attributes.
1518 void setParamAttrs(ParamAttrsList *attrs);
1520 /// getCalledFunction - Return the function called, or null if this is an
1521 /// indirect function invocation.
1523 Function *getCalledFunction() const {
1524 return dyn_cast<Function>(getOperand(0));
1527 // getCalledValue - Get a pointer to a function that is invoked by this inst.
1528 inline Value *getCalledValue() const { return getOperand(0); }
1530 // get*Dest - Return the destination basic blocks...
1531 BasicBlock *getNormalDest() const {
1532 return cast<BasicBlock>(getOperand(1));
1534 BasicBlock *getUnwindDest() const {
1535 return cast<BasicBlock>(getOperand(2));
1537 void setNormalDest(BasicBlock *B) {
1538 setOperand(1, reinterpret_cast<Value*>(B));
1541 void setUnwindDest(BasicBlock *B) {
1542 setOperand(2, reinterpret_cast<Value*>(B));
1545 inline BasicBlock *getSuccessor(unsigned i) const {
1546 assert(i < 2 && "Successor # out of range for invoke!");
1547 return i == 0 ? getNormalDest() : getUnwindDest();
1550 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1551 assert(idx < 2 && "Successor # out of range for invoke!");
1552 setOperand(idx+1, reinterpret_cast<Value*>(NewSucc));
1555 unsigned getNumSuccessors() const { return 2; }
1557 // Methods for support type inquiry through isa, cast, and dyn_cast:
1558 static inline bool classof(const InvokeInst *) { return true; }
1559 static inline bool classof(const Instruction *I) {
1560 return (I->getOpcode() == Instruction::Invoke);
1562 static inline bool classof(const Value *V) {
1563 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1566 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1567 virtual unsigned getNumSuccessorsV() const;
1568 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1572 //===----------------------------------------------------------------------===//
1574 //===----------------------------------------------------------------------===//
1576 //===---------------------------------------------------------------------------
1577 /// UnwindInst - Immediately exit the current function, unwinding the stack
1578 /// until an invoke instruction is found.
1580 class UnwindInst : public TerminatorInst {
1582 explicit UnwindInst(Instruction *InsertBefore = 0);
1583 explicit UnwindInst(BasicBlock *InsertAtEnd);
1585 virtual UnwindInst *clone() const;
1587 unsigned getNumSuccessors() const { return 0; }
1589 // Methods for support type inquiry through isa, cast, and dyn_cast:
1590 static inline bool classof(const UnwindInst *) { return true; }
1591 static inline bool classof(const Instruction *I) {
1592 return I->getOpcode() == Instruction::Unwind;
1594 static inline bool classof(const Value *V) {
1595 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1598 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1599 virtual unsigned getNumSuccessorsV() const;
1600 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1603 //===----------------------------------------------------------------------===//
1604 // UnreachableInst Class
1605 //===----------------------------------------------------------------------===//
1607 //===---------------------------------------------------------------------------
1608 /// UnreachableInst - This function has undefined behavior. In particular, the
1609 /// presence of this instruction indicates some higher level knowledge that the
1610 /// end of the block cannot be reached.
1612 class UnreachableInst : public TerminatorInst {
1614 explicit UnreachableInst(Instruction *InsertBefore = 0);
1615 explicit UnreachableInst(BasicBlock *InsertAtEnd);
1617 virtual UnreachableInst *clone() const;
1619 unsigned getNumSuccessors() const { return 0; }
1621 // Methods for support type inquiry through isa, cast, and dyn_cast:
1622 static inline bool classof(const UnreachableInst *) { return true; }
1623 static inline bool classof(const Instruction *I) {
1624 return I->getOpcode() == Instruction::Unreachable;
1626 static inline bool classof(const Value *V) {
1627 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1630 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1631 virtual unsigned getNumSuccessorsV() const;
1632 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1635 //===----------------------------------------------------------------------===//
1637 //===----------------------------------------------------------------------===//
1639 /// @brief This class represents a truncation of integer types.
1640 class TruncInst : public CastInst {
1641 /// Private copy constructor
1642 TruncInst(const TruncInst &CI)
1643 : CastInst(CI.getType(), Trunc, CI.getOperand(0)) {
1646 /// @brief Constructor with insert-before-instruction semantics
1648 Value *S, ///< The value to be truncated
1649 const Type *Ty, ///< The (smaller) type to truncate to
1650 const std::string &Name = "", ///< A name for the new instruction
1651 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1654 /// @brief Constructor with insert-at-end-of-block semantics
1656 Value *S, ///< The value to be truncated
1657 const Type *Ty, ///< The (smaller) type to truncate to
1658 const std::string &Name, ///< A name for the new instruction
1659 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1662 /// @brief Clone an identical TruncInst
1663 virtual CastInst *clone() const;
1665 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1666 static inline bool classof(const TruncInst *) { return true; }
1667 static inline bool classof(const Instruction *I) {
1668 return I->getOpcode() == Trunc;
1670 static inline bool classof(const Value *V) {
1671 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1675 //===----------------------------------------------------------------------===//
1677 //===----------------------------------------------------------------------===//
1679 /// @brief This class represents zero extension of integer types.
1680 class ZExtInst : public CastInst {
1681 /// @brief Private copy constructor
1682 ZExtInst(const ZExtInst &CI)
1683 : CastInst(CI.getType(), ZExt, CI.getOperand(0)) {
1686 /// @brief Constructor with insert-before-instruction semantics
1688 Value *S, ///< The value to be zero extended
1689 const Type *Ty, ///< The type to zero extend to
1690 const std::string &Name = "", ///< A name for the new instruction
1691 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1694 /// @brief Constructor with insert-at-end semantics.
1696 Value *S, ///< The value to be zero extended
1697 const Type *Ty, ///< The type to zero extend to
1698 const std::string &Name, ///< A name for the new instruction
1699 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1702 /// @brief Clone an identical ZExtInst
1703 virtual CastInst *clone() const;
1705 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1706 static inline bool classof(const ZExtInst *) { return true; }
1707 static inline bool classof(const Instruction *I) {
1708 return I->getOpcode() == ZExt;
1710 static inline bool classof(const Value *V) {
1711 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1715 //===----------------------------------------------------------------------===//
1717 //===----------------------------------------------------------------------===//
1719 /// @brief This class represents a sign extension of integer types.
1720 class SExtInst : public CastInst {
1721 /// @brief Private copy constructor
1722 SExtInst(const SExtInst &CI)
1723 : CastInst(CI.getType(), SExt, CI.getOperand(0)) {
1726 /// @brief Constructor with insert-before-instruction semantics
1728 Value *S, ///< The value to be sign extended
1729 const Type *Ty, ///< The type to sign extend to
1730 const std::string &Name = "", ///< A name for the new instruction
1731 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1734 /// @brief Constructor with insert-at-end-of-block semantics
1736 Value *S, ///< The value to be sign extended
1737 const Type *Ty, ///< The type to sign extend to
1738 const std::string &Name, ///< A name for the new instruction
1739 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1742 /// @brief Clone an identical SExtInst
1743 virtual CastInst *clone() const;
1745 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1746 static inline bool classof(const SExtInst *) { return true; }
1747 static inline bool classof(const Instruction *I) {
1748 return I->getOpcode() == SExt;
1750 static inline bool classof(const Value *V) {
1751 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1755 //===----------------------------------------------------------------------===//
1756 // FPTruncInst Class
1757 //===----------------------------------------------------------------------===//
1759 /// @brief This class represents a truncation of floating point types.
1760 class FPTruncInst : public CastInst {
1761 FPTruncInst(const FPTruncInst &CI)
1762 : CastInst(CI.getType(), FPTrunc, CI.getOperand(0)) {
1765 /// @brief Constructor with insert-before-instruction semantics
1767 Value *S, ///< The value to be truncated
1768 const Type *Ty, ///< The type to truncate to
1769 const std::string &Name = "", ///< A name for the new instruction
1770 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1773 /// @brief Constructor with insert-before-instruction semantics
1775 Value *S, ///< The value to be truncated
1776 const Type *Ty, ///< The type to truncate to
1777 const std::string &Name, ///< A name for the new instruction
1778 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1781 /// @brief Clone an identical FPTruncInst
1782 virtual CastInst *clone() const;
1784 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1785 static inline bool classof(const FPTruncInst *) { return true; }
1786 static inline bool classof(const Instruction *I) {
1787 return I->getOpcode() == FPTrunc;
1789 static inline bool classof(const Value *V) {
1790 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1794 //===----------------------------------------------------------------------===//
1796 //===----------------------------------------------------------------------===//
1798 /// @brief This class represents an extension of floating point types.
1799 class FPExtInst : public CastInst {
1800 FPExtInst(const FPExtInst &CI)
1801 : CastInst(CI.getType(), FPExt, CI.getOperand(0)) {
1804 /// @brief Constructor with insert-before-instruction semantics
1806 Value *S, ///< The value to be extended
1807 const Type *Ty, ///< The type to extend to
1808 const std::string &Name = "", ///< A name for the new instruction
1809 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1812 /// @brief Constructor with insert-at-end-of-block semantics
1814 Value *S, ///< The value to be extended
1815 const Type *Ty, ///< The type to extend to
1816 const std::string &Name, ///< A name for the new instruction
1817 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1820 /// @brief Clone an identical FPExtInst
1821 virtual CastInst *clone() const;
1823 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1824 static inline bool classof(const FPExtInst *) { return true; }
1825 static inline bool classof(const Instruction *I) {
1826 return I->getOpcode() == FPExt;
1828 static inline bool classof(const Value *V) {
1829 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1833 //===----------------------------------------------------------------------===//
1835 //===----------------------------------------------------------------------===//
1837 /// @brief This class represents a cast unsigned integer to floating point.
1838 class UIToFPInst : public CastInst {
1839 UIToFPInst(const UIToFPInst &CI)
1840 : CastInst(CI.getType(), UIToFP, CI.getOperand(0)) {
1843 /// @brief Constructor with insert-before-instruction semantics
1845 Value *S, ///< The value to be converted
1846 const Type *Ty, ///< The type to convert to
1847 const std::string &Name = "", ///< A name for the new instruction
1848 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1851 /// @brief Constructor with insert-at-end-of-block semantics
1853 Value *S, ///< The value to be converted
1854 const Type *Ty, ///< The type to convert to
1855 const std::string &Name, ///< A name for the new instruction
1856 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1859 /// @brief Clone an identical UIToFPInst
1860 virtual CastInst *clone() const;
1862 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1863 static inline bool classof(const UIToFPInst *) { return true; }
1864 static inline bool classof(const Instruction *I) {
1865 return I->getOpcode() == UIToFP;
1867 static inline bool classof(const Value *V) {
1868 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1872 //===----------------------------------------------------------------------===//
1874 //===----------------------------------------------------------------------===//
1876 /// @brief This class represents a cast from signed integer to floating point.
1877 class SIToFPInst : public CastInst {
1878 SIToFPInst(const SIToFPInst &CI)
1879 : CastInst(CI.getType(), SIToFP, CI.getOperand(0)) {
1882 /// @brief Constructor with insert-before-instruction semantics
1884 Value *S, ///< The value to be converted
1885 const Type *Ty, ///< The type to convert to
1886 const std::string &Name = "", ///< A name for the new instruction
1887 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1890 /// @brief Constructor with insert-at-end-of-block semantics
1892 Value *S, ///< The value to be converted
1893 const Type *Ty, ///< The type to convert to
1894 const std::string &Name, ///< A name for the new instruction
1895 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1898 /// @brief Clone an identical SIToFPInst
1899 virtual CastInst *clone() const;
1901 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1902 static inline bool classof(const SIToFPInst *) { return true; }
1903 static inline bool classof(const Instruction *I) {
1904 return I->getOpcode() == SIToFP;
1906 static inline bool classof(const Value *V) {
1907 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1911 //===----------------------------------------------------------------------===//
1913 //===----------------------------------------------------------------------===//
1915 /// @brief This class represents a cast from floating point to unsigned integer
1916 class FPToUIInst : public CastInst {
1917 FPToUIInst(const FPToUIInst &CI)
1918 : CastInst(CI.getType(), FPToUI, CI.getOperand(0)) {
1921 /// @brief Constructor with insert-before-instruction semantics
1923 Value *S, ///< The value to be converted
1924 const Type *Ty, ///< The type to convert to
1925 const std::string &Name = "", ///< A name for the new instruction
1926 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1929 /// @brief Constructor with insert-at-end-of-block semantics
1931 Value *S, ///< The value to be converted
1932 const Type *Ty, ///< The type to convert to
1933 const std::string &Name, ///< A name for the new instruction
1934 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
1937 /// @brief Clone an identical FPToUIInst
1938 virtual CastInst *clone() const;
1940 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1941 static inline bool classof(const FPToUIInst *) { return true; }
1942 static inline bool classof(const Instruction *I) {
1943 return I->getOpcode() == FPToUI;
1945 static inline bool classof(const Value *V) {
1946 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1950 //===----------------------------------------------------------------------===//
1952 //===----------------------------------------------------------------------===//
1954 /// @brief This class represents a cast from floating point to signed integer.
1955 class FPToSIInst : public CastInst {
1956 FPToSIInst(const FPToSIInst &CI)
1957 : CastInst(CI.getType(), FPToSI, CI.getOperand(0)) {
1960 /// @brief Constructor with insert-before-instruction semantics
1962 Value *S, ///< The value to be converted
1963 const Type *Ty, ///< The type to convert to
1964 const std::string &Name = "", ///< A name for the new instruction
1965 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1968 /// @brief Constructor with insert-at-end-of-block semantics
1970 Value *S, ///< The value to be converted
1971 const Type *Ty, ///< The type to convert to
1972 const std::string &Name, ///< A name for the new instruction
1973 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1976 /// @brief Clone an identical FPToSIInst
1977 virtual CastInst *clone() const;
1979 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1980 static inline bool classof(const FPToSIInst *) { return true; }
1981 static inline bool classof(const Instruction *I) {
1982 return I->getOpcode() == FPToSI;
1984 static inline bool classof(const Value *V) {
1985 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1989 //===----------------------------------------------------------------------===//
1990 // IntToPtrInst Class
1991 //===----------------------------------------------------------------------===//
1993 /// @brief This class represents a cast from an integer to a pointer.
1994 class IntToPtrInst : public CastInst {
1995 IntToPtrInst(const IntToPtrInst &CI)
1996 : CastInst(CI.getType(), IntToPtr, CI.getOperand(0)) {
1999 /// @brief Constructor with insert-before-instruction semantics
2001 Value *S, ///< The value to be converted
2002 const Type *Ty, ///< The type to convert to
2003 const std::string &Name = "", ///< A name for the new instruction
2004 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2007 /// @brief Constructor with insert-at-end-of-block semantics
2009 Value *S, ///< The value to be converted
2010 const Type *Ty, ///< The type to convert to
2011 const std::string &Name, ///< A name for the new instruction
2012 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2015 /// @brief Clone an identical IntToPtrInst
2016 virtual CastInst *clone() const;
2018 // Methods for support type inquiry through isa, cast, and dyn_cast:
2019 static inline bool classof(const IntToPtrInst *) { return true; }
2020 static inline bool classof(const Instruction *I) {
2021 return I->getOpcode() == IntToPtr;
2023 static inline bool classof(const Value *V) {
2024 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2028 //===----------------------------------------------------------------------===//
2029 // PtrToIntInst Class
2030 //===----------------------------------------------------------------------===//
2032 /// @brief This class represents a cast from a pointer to an integer
2033 class PtrToIntInst : public CastInst {
2034 PtrToIntInst(const PtrToIntInst &CI)
2035 : CastInst(CI.getType(), PtrToInt, CI.getOperand(0)) {
2038 /// @brief Constructor with insert-before-instruction semantics
2040 Value *S, ///< The value to be converted
2041 const Type *Ty, ///< The type to convert to
2042 const std::string &Name = "", ///< A name for the new instruction
2043 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2046 /// @brief Constructor with insert-at-end-of-block semantics
2048 Value *S, ///< The value to be converted
2049 const Type *Ty, ///< The type to convert to
2050 const std::string &Name, ///< A name for the new instruction
2051 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2054 /// @brief Clone an identical PtrToIntInst
2055 virtual CastInst *clone() const;
2057 // Methods for support type inquiry through isa, cast, and dyn_cast:
2058 static inline bool classof(const PtrToIntInst *) { return true; }
2059 static inline bool classof(const Instruction *I) {
2060 return I->getOpcode() == PtrToInt;
2062 static inline bool classof(const Value *V) {
2063 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2067 //===----------------------------------------------------------------------===//
2068 // BitCastInst Class
2069 //===----------------------------------------------------------------------===//
2071 /// @brief This class represents a no-op cast from one type to another.
2072 class BitCastInst : public CastInst {
2073 BitCastInst(const BitCastInst &CI)
2074 : CastInst(CI.getType(), BitCast, CI.getOperand(0)) {
2077 /// @brief Constructor with insert-before-instruction semantics
2079 Value *S, ///< The value to be casted
2080 const Type *Ty, ///< The type to casted to
2081 const std::string &Name = "", ///< A name for the new instruction
2082 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2085 /// @brief Constructor with insert-at-end-of-block semantics
2087 Value *S, ///< The value to be casted
2088 const Type *Ty, ///< The type to casted to
2089 const std::string &Name, ///< A name for the new instruction
2090 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2093 /// @brief Clone an identical BitCastInst
2094 virtual CastInst *clone() const;
2096 // Methods for support type inquiry through isa, cast, and dyn_cast:
2097 static inline bool classof(const BitCastInst *) { return true; }
2098 static inline bool classof(const Instruction *I) {
2099 return I->getOpcode() == BitCast;
2101 static inline bool classof(const Value *V) {
2102 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2106 } // End llvm namespace