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"
28 //===----------------------------------------------------------------------===//
29 // AllocationInst Class
30 //===----------------------------------------------------------------------===//
32 /// AllocationInst - This class is the common base class of MallocInst and
35 class AllocationInst : public UnaryInstruction {
38 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
39 const std::string &Name = "", Instruction *InsertBefore = 0);
40 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
41 const std::string &Name, BasicBlock *InsertAtEnd);
43 // Out of line virtual method, so the vtable, etc has a home.
44 virtual ~AllocationInst();
46 /// isArrayAllocation - Return true if there is an allocation size parameter
47 /// to the allocation instruction that is not 1.
49 bool isArrayAllocation() const;
51 /// getArraySize - Get the number of element allocated, for a simple
52 /// allocation of a single element, this will return a constant 1 value.
54 inline const Value *getArraySize() const { return getOperand(0); }
55 inline Value *getArraySize() { return getOperand(0); }
57 /// getType - Overload to return most specific pointer type
59 inline const PointerType *getType() const {
60 return reinterpret_cast<const PointerType*>(Instruction::getType());
63 /// getAllocatedType - Return the type that is being allocated by the
66 const Type *getAllocatedType() const;
68 /// getAlignment - Return the alignment of the memory that is being allocated
69 /// by the instruction.
71 unsigned getAlignment() const { return Alignment; }
72 void setAlignment(unsigned Align) {
73 assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
77 virtual Instruction *clone() const = 0;
79 // Methods for support type inquiry through isa, cast, and dyn_cast:
80 static inline bool classof(const AllocationInst *) { return true; }
81 static inline bool classof(const Instruction *I) {
82 return I->getOpcode() == Instruction::Alloca ||
83 I->getOpcode() == Instruction::Malloc;
85 static inline bool classof(const Value *V) {
86 return isa<Instruction>(V) && classof(cast<Instruction>(V));
91 //===----------------------------------------------------------------------===//
93 //===----------------------------------------------------------------------===//
95 /// MallocInst - an instruction to allocated memory on the heap
97 class MallocInst : public AllocationInst {
98 MallocInst(const MallocInst &MI);
100 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
101 const std::string &Name = "",
102 Instruction *InsertBefore = 0)
103 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
104 MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
105 BasicBlock *InsertAtEnd)
106 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
108 MallocInst(const Type *Ty, const std::string &Name,
109 Instruction *InsertBefore = 0)
110 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
111 MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
112 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
114 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
115 const std::string &Name, BasicBlock *InsertAtEnd)
116 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
117 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
118 const std::string &Name = "",
119 Instruction *InsertBefore = 0)
120 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
122 virtual MallocInst *clone() const;
124 // Methods for support type inquiry through isa, cast, and dyn_cast:
125 static inline bool classof(const MallocInst *) { return true; }
126 static inline bool classof(const Instruction *I) {
127 return (I->getOpcode() == Instruction::Malloc);
129 static inline bool classof(const Value *V) {
130 return isa<Instruction>(V) && classof(cast<Instruction>(V));
135 //===----------------------------------------------------------------------===//
137 //===----------------------------------------------------------------------===//
139 /// AllocaInst - an instruction to allocate memory on the stack
141 class AllocaInst : public AllocationInst {
142 AllocaInst(const AllocaInst &);
144 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
145 const std::string &Name = "",
146 Instruction *InsertBefore = 0)
147 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
148 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
149 BasicBlock *InsertAtEnd)
150 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
152 AllocaInst(const Type *Ty, const std::string &Name,
153 Instruction *InsertBefore = 0)
154 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
155 AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
156 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
158 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
159 const std::string &Name = "", Instruction *InsertBefore = 0)
160 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
161 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
162 const std::string &Name, BasicBlock *InsertAtEnd)
163 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
165 virtual AllocaInst *clone() const;
167 // Methods for support type inquiry through isa, cast, and dyn_cast:
168 static inline bool classof(const AllocaInst *) { return true; }
169 static inline bool classof(const Instruction *I) {
170 return (I->getOpcode() == Instruction::Alloca);
172 static inline bool classof(const Value *V) {
173 return isa<Instruction>(V) && classof(cast<Instruction>(V));
178 //===----------------------------------------------------------------------===//
180 //===----------------------------------------------------------------------===//
182 /// FreeInst - an instruction to deallocate memory
184 class FreeInst : public UnaryInstruction {
187 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
188 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
190 virtual FreeInst *clone() const;
192 virtual bool mayWriteToMemory() const { return true; }
194 // Methods for support type inquiry through isa, cast, and dyn_cast:
195 static inline bool classof(const FreeInst *) { return true; }
196 static inline bool classof(const Instruction *I) {
197 return (I->getOpcode() == Instruction::Free);
199 static inline bool classof(const Value *V) {
200 return isa<Instruction>(V) && classof(cast<Instruction>(V));
205 //===----------------------------------------------------------------------===//
207 //===----------------------------------------------------------------------===//
209 /// LoadInst - an instruction for reading from memory. This uses the
210 /// SubclassData field in Value to store whether or not the load is volatile.
212 class LoadInst : public UnaryInstruction {
213 LoadInst(const LoadInst &LI)
214 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
215 setVolatile(LI.isVolatile());
223 LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
224 LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
225 explicit LoadInst(Value *Ptr, const std::string &Name = "",
226 bool isVolatile = false, Instruction *InsertBefore = 0);
227 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
228 BasicBlock *InsertAtEnd);
230 /// isVolatile - Return true if this is a load from a volatile memory
233 bool isVolatile() const { return SubclassData; }
235 /// setVolatile - Specify whether this is a volatile load or not.
237 void setVolatile(bool V) { SubclassData = V; }
239 virtual LoadInst *clone() const;
241 virtual bool mayWriteToMemory() const { return isVolatile(); }
243 Value *getPointerOperand() { return getOperand(0); }
244 const Value *getPointerOperand() const { return getOperand(0); }
245 static unsigned getPointerOperandIndex() { return 0U; }
247 // Methods for support type inquiry through isa, cast, and dyn_cast:
248 static inline bool classof(const LoadInst *) { return true; }
249 static inline bool classof(const Instruction *I) {
250 return I->getOpcode() == Instruction::Load;
252 static inline bool classof(const Value *V) {
253 return isa<Instruction>(V) && classof(cast<Instruction>(V));
258 //===----------------------------------------------------------------------===//
260 //===----------------------------------------------------------------------===//
262 /// StoreInst - an instruction for storing to memory
264 class StoreInst : public Instruction {
266 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store, Ops, 2) {
267 Ops[0].init(SI.Ops[0], this);
268 Ops[1].init(SI.Ops[1], this);
269 setVolatile(SI.isVolatile());
276 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
277 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
278 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
279 Instruction *InsertBefore = 0);
280 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
283 /// isVolatile - Return true if this is a load from a volatile memory
286 bool isVolatile() const { return SubclassData; }
288 /// setVolatile - Specify whether this is a volatile load or not.
290 void setVolatile(bool V) { SubclassData = V; }
292 /// Transparently provide more efficient getOperand methods.
293 Value *getOperand(unsigned i) const {
294 assert(i < 2 && "getOperand() out of range!");
297 void setOperand(unsigned i, Value *Val) {
298 assert(i < 2 && "setOperand() out of range!");
301 unsigned getNumOperands() const { return 2; }
304 virtual StoreInst *clone() const;
306 virtual bool mayWriteToMemory() const { return true; }
308 Value *getPointerOperand() { return getOperand(1); }
309 const Value *getPointerOperand() const { return getOperand(1); }
310 static unsigned getPointerOperandIndex() { return 1U; }
312 // Methods for support type inquiry through isa, cast, and dyn_cast:
313 static inline bool classof(const StoreInst *) { return true; }
314 static inline bool classof(const Instruction *I) {
315 return I->getOpcode() == Instruction::Store;
317 static inline bool classof(const Value *V) {
318 return isa<Instruction>(V) && classof(cast<Instruction>(V));
323 //===----------------------------------------------------------------------===//
324 // GetElementPtrInst Class
325 //===----------------------------------------------------------------------===//
327 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
328 /// access elements of arrays and structs
330 class GetElementPtrInst : public Instruction {
331 GetElementPtrInst(const GetElementPtrInst &GEPI)
332 : Instruction(reinterpret_cast<const Type*>(GEPI.getType()), GetElementPtr,
333 0, GEPI.getNumOperands()) {
334 Use *OL = OperandList = new Use[NumOperands];
335 Use *GEPIOL = GEPI.OperandList;
336 for (unsigned i = 0, E = NumOperands; i != E; ++i)
337 OL[i].init(GEPIOL[i], this);
339 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx);
340 void init(Value *Ptr, Value *Idx0, Value *Idx1);
341 void init(Value *Ptr, Value *Idx);
343 /// Constructors - Create a getelementptr instruction with a base pointer an
344 /// list of indices. The first ctor can optionally insert before an existing
345 /// instruction, the second appends the new instruction to the specified
347 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
348 const std::string &Name = "", Instruction *InsertBefore =0);
349 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
350 const std::string &Name, BasicBlock *InsertAtEnd);
351 GetElementPtrInst(Value *Ptr, Value* const *Idx, unsigned NumIdx,
352 const std::string &Name = "", Instruction *InsertBefore =0);
353 GetElementPtrInst(Value *Ptr, Value* const *Idx, unsigned NumIdx,
354 const std::string &Name, BasicBlock *InsertAtEnd);
356 /// Constructors - These two constructors are convenience methods because one
357 /// and two index getelementptr instructions are so common.
358 GetElementPtrInst(Value *Ptr, Value *Idx,
359 const std::string &Name = "", Instruction *InsertBefore =0);
360 GetElementPtrInst(Value *Ptr, Value *Idx,
361 const std::string &Name, BasicBlock *InsertAtEnd);
362 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
363 const std::string &Name = "", Instruction *InsertBefore =0);
364 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
365 const std::string &Name, BasicBlock *InsertAtEnd);
366 ~GetElementPtrInst();
368 virtual GetElementPtrInst *clone() const;
370 // getType - Overload to return most specific pointer type...
371 inline const PointerType *getType() const {
372 return reinterpret_cast<const PointerType*>(Instruction::getType());
375 /// getIndexedType - Returns the type of the element that would be loaded with
376 /// a load instruction with the specified parameters.
378 /// A null type is returned if the indices are invalid for the specified
381 static const Type *getIndexedType(const Type *Ptr,
382 Value* const *Idx, unsigned NumIdx,
383 bool AllowStructLeaf = false);
385 static const Type *getIndexedType(const Type *Ptr,
386 const std::vector<Value*> &Indices,
387 bool AllowStructLeaf = false) {
388 return getIndexedType(Ptr, &Indices[0], Indices.size(), AllowStructLeaf);
390 static const Type *getIndexedType(const Type *Ptr, Value *Idx0, Value *Idx1,
391 bool AllowStructLeaf = false);
392 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
394 inline op_iterator idx_begin() { return op_begin()+1; }
395 inline const_op_iterator idx_begin() const { return op_begin()+1; }
396 inline op_iterator idx_end() { return op_end(); }
397 inline const_op_iterator idx_end() const { return op_end(); }
399 Value *getPointerOperand() {
400 return getOperand(0);
402 const Value *getPointerOperand() const {
403 return getOperand(0);
405 static unsigned getPointerOperandIndex() {
406 return 0U; // get index for modifying correct operand
409 inline unsigned getNumIndices() const { // Note: always non-negative
410 return getNumOperands() - 1;
413 inline bool hasIndices() const {
414 return getNumOperands() > 1;
417 // Methods for support type inquiry through isa, cast, and dyn_cast:
418 static inline bool classof(const GetElementPtrInst *) { return true; }
419 static inline bool classof(const Instruction *I) {
420 return (I->getOpcode() == Instruction::GetElementPtr);
422 static inline bool classof(const Value *V) {
423 return isa<Instruction>(V) && classof(cast<Instruction>(V));
427 //===----------------------------------------------------------------------===//
429 //===----------------------------------------------------------------------===//
431 /// This instruction compares its operands according to the predicate given
432 /// to the constructor. It only operates on integers, pointers, or packed
433 /// vectors of integrals. The two operands must be the same type.
434 /// @brief Represent an integer comparison operator.
435 class ICmpInst: public CmpInst {
437 /// This enumeration lists the possible predicates for the ICmpInst. The
438 /// values in the range 0-31 are reserved for FCmpInst while values in the
439 /// range 32-64 are reserved for ICmpInst. This is necessary to ensure the
440 /// predicate values are not overlapping between the classes.
442 ICMP_EQ = 32, ///< equal
443 ICMP_NE = 33, ///< not equal
444 ICMP_UGT = 34, ///< unsigned greater than
445 ICMP_UGE = 35, ///< unsigned greater or equal
446 ICMP_ULT = 36, ///< unsigned less than
447 ICMP_ULE = 37, ///< unsigned less or equal
448 ICMP_SGT = 38, ///< signed greater than
449 ICMP_SGE = 39, ///< signed greater or equal
450 ICMP_SLT = 40, ///< signed less than
451 ICMP_SLE = 41, ///< signed less or equal
452 FIRST_ICMP_PREDICATE = ICMP_EQ,
453 LAST_ICMP_PREDICATE = ICMP_SLE,
454 BAD_ICMP_PREDICATE = ICMP_SLE + 1
457 /// @brief Constructor with insert-before-instruction semantics.
459 Predicate pred, ///< The predicate to use for the comparison
460 Value *LHS, ///< The left-hand-side of the expression
461 Value *RHS, ///< The right-hand-side of the expression
462 const std::string &Name = "", ///< Name of the instruction
463 Instruction *InsertBefore = 0 ///< Where to insert
464 ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertBefore) {
467 /// @brief Constructor with insert-at-block-end semantics.
469 Predicate pred, ///< The predicate to use for the comparison
470 Value *LHS, ///< The left-hand-side of the expression
471 Value *RHS, ///< The right-hand-side of the expression
472 const std::string &Name, ///< Name of the instruction
473 BasicBlock *InsertAtEnd ///< Block to insert into.
474 ) : CmpInst(Instruction::ICmp, pred, LHS, RHS, Name, InsertAtEnd) {
477 /// @brief Return the predicate for this instruction.
478 Predicate getPredicate() const { return Predicate(SubclassData); }
480 /// @brief Set the predicate for this instruction to the specified value.
481 void setPredicate(Predicate P) { SubclassData = P; }
483 /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
484 /// @returns the inverse predicate for the instruction's current predicate.
485 /// @brief Return the inverse of the instruction's predicate.
486 Predicate getInversePredicate() const {
487 return getInversePredicate(getPredicate());
490 /// For example, EQ -> NE, UGT -> ULE, SLT -> SGE, etc.
491 /// @returns the inverse predicate for predicate provided in \p pred.
492 /// @brief Return the inverse of a given predicate
493 static Predicate getInversePredicate(Predicate pred);
495 /// For example, EQ->EQ, SLE->SGE, ULT->UGT, etc.
496 /// @returns the predicate that would be the result of exchanging the two
497 /// operands of the ICmpInst instruction without changing the result
499 /// @brief Return the predicate as if the operands were swapped
500 Predicate getSwappedPredicate() const {
501 return getSwappedPredicate(getPredicate());
504 /// This is a static version that you can use without an instruction
506 /// @brief Return the predicate as if the operands were swapped.
507 static Predicate getSwappedPredicate(Predicate pred);
509 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
510 /// @returns the predicate that would be the result if the operand were
511 /// regarded as signed.
512 /// @brief Return the signed version of the predicate
513 Predicate getSignedPredicate() const {
514 return getSignedPredicate(getPredicate());
517 /// This is a static version that you can use without an instruction.
518 /// @brief Return the signed version of the predicate.
519 static Predicate getSignedPredicate(Predicate pred);
521 /// This also tests for commutativity. If isEquality() returns true then
522 /// the predicate is also commutative.
523 /// @returns true if the predicate of this instruction is EQ or NE.
524 /// @brief Determine if this is an equality predicate.
525 bool isEquality() const {
526 return SubclassData == ICMP_EQ || SubclassData == ICMP_NE;
529 /// @returns true if the predicate of this ICmpInst is commutative
530 /// @brief Determine if this relation is commutative.
531 bool isCommutative() const { return isEquality(); }
533 /// @returns true if the predicate is relational (not EQ or NE).
534 /// @brief Determine if this a relational predicate.
535 bool isRelational() const {
536 return !isEquality();
539 /// @returns true if the predicate of this ICmpInst is signed, false otherwise
540 /// @brief Determine if this instruction's predicate is signed.
541 bool isSignedPredicate() { return isSignedPredicate(getPredicate()); }
543 /// @returns true if the predicate provided is signed, false otherwise
544 /// @brief Determine if the predicate is signed.
545 static bool isSignedPredicate(Predicate pred);
547 /// Exchange the two operands to this instruction in such a way that it does
548 /// not modify the semantics of the instruction. The predicate value may be
549 /// changed to retain the same result if the predicate is order dependent
551 /// @brief Swap operands and adjust predicate.
552 void swapOperands() {
553 SubclassData = getSwappedPredicate();
554 std::swap(Ops[0], Ops[1]);
557 // Methods for support type inquiry through isa, cast, and dyn_cast:
558 static inline bool classof(const ICmpInst *) { return true; }
559 static inline bool classof(const Instruction *I) {
560 return I->getOpcode() == Instruction::ICmp;
562 static inline bool classof(const Value *V) {
563 return isa<Instruction>(V) && classof(cast<Instruction>(V));
567 //===----------------------------------------------------------------------===//
569 //===----------------------------------------------------------------------===//
571 /// This instruction compares its operands according to the predicate given
572 /// to the constructor. It only operates on floating point values or packed
573 /// vectors of floating point values. The operands must be identical types.
574 /// @brief Represents a floating point comparison operator.
575 class FCmpInst: public CmpInst {
577 /// This enumeration lists the possible predicates for the FCmpInst. Values
578 /// in the range 0-31 are reserved for FCmpInst.
580 // Opcode U L G E Intuitive operation
581 FCMP_FALSE = 0, ///< 0 0 0 0 Always false (always folded)
582 FCMP_OEQ = 1, ///< 0 0 0 1 True if ordered and equal
583 FCMP_OGT = 2, ///< 0 0 1 0 True if ordered and greater than
584 FCMP_OGE = 3, ///< 0 0 1 1 True if ordered and greater than or equal
585 FCMP_OLT = 4, ///< 0 1 0 0 True if ordered and less than
586 FCMP_OLE = 5, ///< 0 1 0 1 True if ordered and less than or equal
587 FCMP_ONE = 6, ///< 0 1 1 0 True if ordered and operands are unequal
588 FCMP_ORD = 7, ///< 0 1 1 1 True if ordered (no nans)
589 FCMP_UNO = 8, ///< 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
590 FCMP_UEQ = 9, ///< 1 0 0 1 True if unordered or equal
591 FCMP_UGT =10, ///< 1 0 1 0 True if unordered or greater than
592 FCMP_UGE =11, ///< 1 0 1 1 True if unordered, greater than, or equal
593 FCMP_ULT =12, ///< 1 1 0 0 True if unordered or less than
594 FCMP_ULE =13, ///< 1 1 0 1 True if unordered, less than, or equal
595 FCMP_UNE =14, ///< 1 1 1 0 True if unordered or not equal
596 FCMP_TRUE =15, ///< 1 1 1 1 Always true (always folded)
597 FIRST_FCMP_PREDICATE = FCMP_FALSE,
598 LAST_FCMP_PREDICATE = FCMP_TRUE,
599 BAD_FCMP_PREDICATE = FCMP_TRUE + 1
602 /// @brief Constructor with insert-before-instruction semantics.
604 Predicate pred, ///< The predicate to use for the comparison
605 Value *LHS, ///< The left-hand-side of the expression
606 Value *RHS, ///< The right-hand-side of the expression
607 const std::string &Name = "", ///< Name of the instruction
608 Instruction *InsertBefore = 0 ///< Where to insert
609 ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertBefore) {
612 /// @brief Constructor with insert-at-block-end semantics.
614 Predicate pred, ///< The predicate to use for the comparison
615 Value *LHS, ///< The left-hand-side of the expression
616 Value *RHS, ///< The right-hand-side of the expression
617 const std::string &Name, ///< Name of the instruction
618 BasicBlock *InsertAtEnd ///< Block to insert into.
619 ) : CmpInst(Instruction::FCmp, pred, LHS, RHS, Name, InsertAtEnd) {
622 /// @brief Return the predicate for this instruction.
623 Predicate getPredicate() const { return Predicate(SubclassData); }
625 /// @brief Set the predicate for this instruction to the specified value.
626 void setPredicate(Predicate P) { SubclassData = P; }
628 /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
629 /// @returns the inverse predicate for the instructions current predicate.
630 /// @brief Return the inverse of the predicate
631 Predicate getInversePredicate() const {
632 return getInversePredicate(getPredicate());
635 /// For example, OEQ -> UNE, UGT -> OLE, OLT -> UGE, etc.
636 /// @returns the inverse predicate for \p pred.
637 /// @brief Return the inverse of a given predicate
638 static Predicate getInversePredicate(Predicate pred);
640 /// For example, OEQ->OEQ, ULE->UGE, OLT->OGT, etc.
641 /// @returns the predicate that would be the result of exchanging the two
642 /// operands of the ICmpInst instruction without changing the result
644 /// @brief Return the predicate as if the operands were swapped
645 Predicate getSwappedPredicate() const {
646 return getSwappedPredicate(getPredicate());
649 /// This is a static version that you can use without an instruction
651 /// @brief Return the predicate as if the operands were swapped.
652 static Predicate getSwappedPredicate(Predicate Opcode);
654 /// This also tests for commutativity. If isEquality() returns true then
655 /// the predicate is also commutative. Only the equality predicates are
657 /// @returns true if the predicate of this instruction is EQ or NE.
658 /// @brief Determine if this is an equality predicate.
659 bool isEquality() const {
660 return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
661 SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
663 bool isCommutative() const { return isEquality(); }
665 /// @returns true if the predicate is relational (not EQ or NE).
666 /// @brief Determine if this a relational predicate.
667 bool isRelational() const { return !isEquality(); }
669 /// Exchange the two operands to this instruction in such a way that it does
670 /// not modify the semantics of the instruction. The predicate value may be
671 /// changed to retain the same result if the predicate is order dependent
673 /// @brief Swap operands and adjust predicate.
674 void swapOperands() {
675 SubclassData = getSwappedPredicate();
676 std::swap(Ops[0], Ops[1]);
679 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
680 static inline bool classof(const FCmpInst *) { return true; }
681 static inline bool classof(const Instruction *I) {
682 return I->getOpcode() == Instruction::FCmp;
684 static inline bool classof(const Value *V) {
685 return isa<Instruction>(V) && classof(cast<Instruction>(V));
689 //===----------------------------------------------------------------------===//
691 //===----------------------------------------------------------------------===//
693 /// CallInst - This class represents a function call, abstracting a target
694 /// machine's calling convention. This class uses low bit of the SubClassData
695 /// field to indicate whether or not this is a tail call. The rest of the bits
696 /// hold the calling convention of the call.
698 class CallInst : public Instruction {
699 CallInst(const CallInst &CI);
700 void init(Value *Func, const std::vector<Value*> &Params);
701 void init(Value *Func, Value *Actual1, Value *Actual2);
702 void init(Value *Func, Value *Actual);
703 void init(Value *Func);
706 CallInst(Value *F, const std::vector<Value*> &Par,
707 const std::string &Name = "", Instruction *InsertBefore = 0);
708 CallInst(Value *F, const std::vector<Value*> &Par,
709 const std::string &Name, BasicBlock *InsertAtEnd);
711 // Alternate CallInst ctors w/ two actuals, w/ one actual and no
712 // actuals, respectively.
713 CallInst(Value *F, Value *Actual1, Value *Actual2,
714 const std::string& Name = "", Instruction *InsertBefore = 0);
715 CallInst(Value *F, Value *Actual1, Value *Actual2,
716 const std::string& Name, BasicBlock *InsertAtEnd);
717 CallInst(Value *F, Value *Actual, const std::string& Name = "",
718 Instruction *InsertBefore = 0);
719 CallInst(Value *F, Value *Actual, const std::string& Name,
720 BasicBlock *InsertAtEnd);
721 explicit CallInst(Value *F, const std::string &Name = "",
722 Instruction *InsertBefore = 0);
723 CallInst(Value *F, const std::string &Name, BasicBlock *InsertAtEnd);
726 virtual CallInst *clone() const;
727 bool mayWriteToMemory() const { return true; }
729 bool isTailCall() const { return SubclassData & 1; }
730 void setTailCall(bool isTailCall = true) {
731 SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
734 /// getCallingConv/setCallingConv - Get or set the calling convention of this
736 unsigned getCallingConv() const { return SubclassData >> 1; }
737 void setCallingConv(unsigned CC) {
738 SubclassData = (SubclassData & 1) | (CC << 1);
741 /// getCalledFunction - Return the function being called by this instruction
742 /// if it is a direct call. If it is a call through a function pointer,
744 Function *getCalledFunction() const {
745 return static_cast<Function*>(dyn_cast<Function>(getOperand(0)));
748 /// getCalledValue - Get a pointer to the function that is invoked by this
750 inline const Value *getCalledValue() const { return getOperand(0); }
751 inline Value *getCalledValue() { return getOperand(0); }
753 // Methods for support type inquiry through isa, cast, and dyn_cast:
754 static inline bool classof(const CallInst *) { return true; }
755 static inline bool classof(const Instruction *I) {
756 return I->getOpcode() == Instruction::Call;
758 static inline bool classof(const Value *V) {
759 return isa<Instruction>(V) && classof(cast<Instruction>(V));
764 //===----------------------------------------------------------------------===//
766 //===----------------------------------------------------------------------===//
768 /// ShiftInst - This class represents left and right shift instructions.
770 class ShiftInst : public Instruction {
772 ShiftInst(const ShiftInst &SI)
773 : Instruction(SI.getType(), SI.getOpcode(), Ops, 2) {
774 Ops[0].init(SI.Ops[0], this);
775 Ops[1].init(SI.Ops[1], this);
777 void init(OtherOps Opcode, Value *S, Value *SA) {
778 assert((Opcode == Shl || Opcode == LShr || Opcode == AShr) &&
779 "ShiftInst Opcode invalid!");
780 Ops[0].init(S, this);
781 Ops[1].init(SA, this);
785 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name = "",
786 Instruction *InsertBefore = 0)
787 : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertBefore) {
790 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name,
791 BasicBlock *InsertAtEnd)
792 : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertAtEnd) {
796 OtherOps getOpcode() const {
797 return static_cast<OtherOps>(Instruction::getOpcode());
800 /// Transparently provide more efficient getOperand methods.
801 Value *getOperand(unsigned i) const {
802 assert(i < 2 && "getOperand() out of range!");
805 void setOperand(unsigned i, Value *Val) {
806 assert(i < 2 && "setOperand() out of range!");
809 unsigned getNumOperands() const { return 2; }
811 /// isLogicalShift - Return true if this is a logical shift left or a logical
813 bool isLogicalShift() const {
814 unsigned opcode = getOpcode();
815 return opcode == Instruction::Shl || opcode == Instruction::LShr;
819 /// isArithmeticShift - Return true if this is a sign-extending shift right
821 bool isArithmeticShift() const {
822 return !isLogicalShift();
826 virtual ShiftInst *clone() const;
828 // Methods for support type inquiry through isa, cast, and dyn_cast:
829 static inline bool classof(const ShiftInst *) { return true; }
830 static inline bool classof(const Instruction *I) {
831 return (I->getOpcode() == Instruction::LShr) |
832 (I->getOpcode() == Instruction::AShr) |
833 (I->getOpcode() == Instruction::Shl);
835 static inline bool classof(const Value *V) {
836 return isa<Instruction>(V) && classof(cast<Instruction>(V));
840 //===----------------------------------------------------------------------===//
842 //===----------------------------------------------------------------------===//
844 /// SelectInst - This class represents the LLVM 'select' instruction.
846 class SelectInst : public Instruction {
849 void init(Value *C, Value *S1, Value *S2) {
850 Ops[0].init(C, this);
851 Ops[1].init(S1, this);
852 Ops[2].init(S2, this);
855 SelectInst(const SelectInst &SI)
856 : Instruction(SI.getType(), SI.getOpcode(), Ops, 3) {
857 init(SI.Ops[0], SI.Ops[1], SI.Ops[2]);
860 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
861 Instruction *InsertBefore = 0)
862 : Instruction(S1->getType(), Instruction::Select, Ops, 3,
863 Name, InsertBefore) {
866 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
867 BasicBlock *InsertAtEnd)
868 : Instruction(S1->getType(), Instruction::Select, Ops, 3,
873 Value *getCondition() const { return Ops[0]; }
874 Value *getTrueValue() const { return Ops[1]; }
875 Value *getFalseValue() const { return Ops[2]; }
877 /// Transparently provide more efficient getOperand methods.
878 Value *getOperand(unsigned i) const {
879 assert(i < 3 && "getOperand() out of range!");
882 void setOperand(unsigned i, Value *Val) {
883 assert(i < 3 && "setOperand() out of range!");
886 unsigned getNumOperands() const { return 3; }
888 OtherOps getOpcode() const {
889 return static_cast<OtherOps>(Instruction::getOpcode());
892 virtual SelectInst *clone() const;
894 // Methods for support type inquiry through isa, cast, and dyn_cast:
895 static inline bool classof(const SelectInst *) { return true; }
896 static inline bool classof(const Instruction *I) {
897 return I->getOpcode() == Instruction::Select;
899 static inline bool classof(const Value *V) {
900 return isa<Instruction>(V) && classof(cast<Instruction>(V));
904 //===----------------------------------------------------------------------===//
906 //===----------------------------------------------------------------------===//
908 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
909 /// an argument of the specified type given a va_list and increments that list
911 class VAArgInst : public UnaryInstruction {
912 VAArgInst(const VAArgInst &VAA)
913 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
915 VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
916 Instruction *InsertBefore = 0)
917 : UnaryInstruction(Ty, VAArg, List, Name, InsertBefore) {
919 VAArgInst(Value *List, const Type *Ty, const std::string &Name,
920 BasicBlock *InsertAtEnd)
921 : UnaryInstruction(Ty, VAArg, List, Name, InsertAtEnd) {
924 virtual VAArgInst *clone() const;
925 bool mayWriteToMemory() const { return true; }
927 // Methods for support type inquiry through isa, cast, and dyn_cast:
928 static inline bool classof(const VAArgInst *) { return true; }
929 static inline bool classof(const Instruction *I) {
930 return I->getOpcode() == VAArg;
932 static inline bool classof(const Value *V) {
933 return isa<Instruction>(V) && classof(cast<Instruction>(V));
937 //===----------------------------------------------------------------------===//
938 // ExtractElementInst Class
939 //===----------------------------------------------------------------------===//
941 /// ExtractElementInst - This instruction extracts a single (scalar)
942 /// element from a PackedType value
944 class ExtractElementInst : public Instruction {
946 ExtractElementInst(const ExtractElementInst &EE) :
947 Instruction(EE.getType(), ExtractElement, Ops, 2) {
948 Ops[0].init(EE.Ops[0], this);
949 Ops[1].init(EE.Ops[1], this);
953 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
954 Instruction *InsertBefore = 0);
955 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name = "",
956 Instruction *InsertBefore = 0);
957 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
958 BasicBlock *InsertAtEnd);
959 ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name,
960 BasicBlock *InsertAtEnd);
962 /// isValidOperands - Return true if an extractelement instruction can be
963 /// formed with the specified operands.
964 static bool isValidOperands(const Value *Vec, const Value *Idx);
966 virtual ExtractElementInst *clone() const;
968 virtual bool mayWriteToMemory() const { return false; }
970 /// Transparently provide more efficient getOperand methods.
971 Value *getOperand(unsigned i) const {
972 assert(i < 2 && "getOperand() out of range!");
975 void setOperand(unsigned i, Value *Val) {
976 assert(i < 2 && "setOperand() out of range!");
979 unsigned getNumOperands() const { return 2; }
981 // Methods for support type inquiry through isa, cast, and dyn_cast:
982 static inline bool classof(const ExtractElementInst *) { return true; }
983 static inline bool classof(const Instruction *I) {
984 return I->getOpcode() == Instruction::ExtractElement;
986 static inline bool classof(const Value *V) {
987 return isa<Instruction>(V) && classof(cast<Instruction>(V));
991 //===----------------------------------------------------------------------===//
992 // InsertElementInst Class
993 //===----------------------------------------------------------------------===//
995 /// InsertElementInst - This instruction inserts a single (scalar)
996 /// element into a PackedType value
998 class InsertElementInst : public Instruction {
1000 InsertElementInst(const InsertElementInst &IE);
1002 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1003 const std::string &Name = "",Instruction *InsertBefore = 0);
1004 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1005 const std::string &Name = "",Instruction *InsertBefore = 0);
1006 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1007 const std::string &Name, BasicBlock *InsertAtEnd);
1008 InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
1009 const std::string &Name, BasicBlock *InsertAtEnd);
1011 /// isValidOperands - Return true if an insertelement instruction can be
1012 /// formed with the specified operands.
1013 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1016 virtual InsertElementInst *clone() const;
1018 virtual bool mayWriteToMemory() const { return false; }
1020 /// getType - Overload to return most specific packed type.
1022 inline const PackedType *getType() const {
1023 return reinterpret_cast<const PackedType*>(Instruction::getType());
1026 /// Transparently provide more efficient getOperand methods.
1027 Value *getOperand(unsigned i) const {
1028 assert(i < 3 && "getOperand() out of range!");
1031 void setOperand(unsigned i, Value *Val) {
1032 assert(i < 3 && "setOperand() out of range!");
1035 unsigned getNumOperands() const { return 3; }
1037 // Methods for support type inquiry through isa, cast, and dyn_cast:
1038 static inline bool classof(const InsertElementInst *) { return true; }
1039 static inline bool classof(const Instruction *I) {
1040 return I->getOpcode() == Instruction::InsertElement;
1042 static inline bool classof(const Value *V) {
1043 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1047 //===----------------------------------------------------------------------===//
1048 // ShuffleVectorInst Class
1049 //===----------------------------------------------------------------------===//
1051 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1054 class ShuffleVectorInst : public Instruction {
1056 ShuffleVectorInst(const ShuffleVectorInst &IE);
1058 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1059 const std::string &Name = "", Instruction *InsertBefor = 0);
1060 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1061 const std::string &Name, BasicBlock *InsertAtEnd);
1063 /// isValidOperands - Return true if a shufflevector instruction can be
1064 /// formed with the specified operands.
1065 static bool isValidOperands(const Value *V1, const Value *V2,
1068 virtual ShuffleVectorInst *clone() const;
1070 virtual bool mayWriteToMemory() const { return false; }
1072 /// getType - Overload to return most specific packed type.
1074 inline const PackedType *getType() const {
1075 return reinterpret_cast<const PackedType*>(Instruction::getType());
1078 /// Transparently provide more efficient getOperand methods.
1079 Value *getOperand(unsigned i) const {
1080 assert(i < 3 && "getOperand() out of range!");
1083 void setOperand(unsigned i, Value *Val) {
1084 assert(i < 3 && "setOperand() out of range!");
1087 unsigned getNumOperands() const { return 3; }
1089 // Methods for support type inquiry through isa, cast, and dyn_cast:
1090 static inline bool classof(const ShuffleVectorInst *) { return true; }
1091 static inline bool classof(const Instruction *I) {
1092 return I->getOpcode() == Instruction::ShuffleVector;
1094 static inline bool classof(const Value *V) {
1095 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1100 //===----------------------------------------------------------------------===//
1102 //===----------------------------------------------------------------------===//
1104 // PHINode - The PHINode class is used to represent the magical mystical PHI
1105 // node, that can not exist in nature, but can be synthesized in a computer
1106 // scientist's overactive imagination.
1108 class PHINode : public Instruction {
1109 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1110 /// the number actually in use.
1111 unsigned ReservedSpace;
1112 PHINode(const PHINode &PN);
1114 explicit PHINode(const Type *Ty, const std::string &Name = "",
1115 Instruction *InsertBefore = 0)
1116 : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertBefore),
1120 PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
1121 : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertAtEnd),
1127 /// reserveOperandSpace - This method can be used to avoid repeated
1128 /// reallocation of PHI operand lists by reserving space for the correct
1129 /// number of operands before adding them. Unlike normal vector reserves,
1130 /// this method can also be used to trim the operand space.
1131 void reserveOperandSpace(unsigned NumValues) {
1132 resizeOperands(NumValues*2);
1135 virtual PHINode *clone() const;
1137 /// getNumIncomingValues - Return the number of incoming edges
1139 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1141 /// getIncomingValue - Return incoming value number x
1143 Value *getIncomingValue(unsigned i) const {
1144 assert(i*2 < getNumOperands() && "Invalid value number!");
1145 return getOperand(i*2);
1147 void setIncomingValue(unsigned i, Value *V) {
1148 assert(i*2 < getNumOperands() && "Invalid value number!");
1151 unsigned getOperandNumForIncomingValue(unsigned i) {
1155 /// getIncomingBlock - Return incoming basic block number x
1157 BasicBlock *getIncomingBlock(unsigned i) const {
1158 return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
1160 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1161 setOperand(i*2+1, reinterpret_cast<Value*>(BB));
1163 unsigned getOperandNumForIncomingBlock(unsigned i) {
1167 /// addIncoming - Add an incoming value to the end of the PHI list
1169 void addIncoming(Value *V, BasicBlock *BB) {
1170 assert(getType() == V->getType() &&
1171 "All operands to PHI node must be the same type as the PHI node!");
1172 unsigned OpNo = NumOperands;
1173 if (OpNo+2 > ReservedSpace)
1174 resizeOperands(0); // Get more space!
1175 // Initialize some new operands.
1176 NumOperands = OpNo+2;
1177 OperandList[OpNo].init(V, this);
1178 OperandList[OpNo+1].init(reinterpret_cast<Value*>(BB), this);
1181 /// removeIncomingValue - Remove an incoming value. This is useful if a
1182 /// predecessor basic block is deleted. The value removed is returned.
1184 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1185 /// is true), the PHI node is destroyed and any uses of it are replaced with
1186 /// dummy values. The only time there should be zero incoming values to a PHI
1187 /// node is when the block is dead, so this strategy is sound.
1189 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1191 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
1192 int Idx = getBasicBlockIndex(BB);
1193 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1194 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1197 /// getBasicBlockIndex - Return the first index of the specified basic
1198 /// block in the value list for this PHI. Returns -1 if no instance.
1200 int getBasicBlockIndex(const BasicBlock *BB) const {
1201 Use *OL = OperandList;
1202 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1203 if (OL[i+1] == reinterpret_cast<const Value*>(BB)) return i/2;
1207 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1208 return getIncomingValue(getBasicBlockIndex(BB));
1211 /// hasConstantValue - If the specified PHI node always merges together the
1212 /// same value, return the value, otherwise return null.
1214 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1216 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1217 static inline bool classof(const PHINode *) { return true; }
1218 static inline bool classof(const Instruction *I) {
1219 return I->getOpcode() == Instruction::PHI;
1221 static inline bool classof(const Value *V) {
1222 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1225 void resizeOperands(unsigned NumOperands);
1228 //===----------------------------------------------------------------------===//
1230 //===----------------------------------------------------------------------===//
1232 //===---------------------------------------------------------------------------
1233 /// ReturnInst - Return a value (possibly void), from a function. Execution
1234 /// does not continue in this function any longer.
1236 class ReturnInst : public TerminatorInst {
1237 Use RetVal; // Possibly null retval.
1238 ReturnInst(const ReturnInst &RI) : TerminatorInst(Instruction::Ret, &RetVal,
1239 RI.getNumOperands()) {
1240 if (RI.getNumOperands())
1241 RetVal.init(RI.RetVal, this);
1244 void init(Value *RetVal);
1247 // ReturnInst constructors:
1248 // ReturnInst() - 'ret void' instruction
1249 // ReturnInst( null) - 'ret void' instruction
1250 // ReturnInst(Value* X) - 'ret X' instruction
1251 // ReturnInst( null, Inst *) - 'ret void' instruction, insert before I
1252 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
1253 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of BB
1254 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of BB
1256 // NOTE: If the Value* passed is of type void then the constructor behaves as
1257 // if it was passed NULL.
1258 explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0)
1259 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertBefore) {
1262 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd)
1263 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
1266 explicit ReturnInst(BasicBlock *InsertAtEnd)
1267 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
1270 virtual ReturnInst *clone() const;
1272 // Transparently provide more efficient getOperand methods.
1273 Value *getOperand(unsigned i) const {
1274 assert(i < getNumOperands() && "getOperand() out of range!");
1277 void setOperand(unsigned i, Value *Val) {
1278 assert(i < getNumOperands() && "setOperand() out of range!");
1282 Value *getReturnValue() const { return RetVal; }
1284 unsigned getNumSuccessors() const { return 0; }
1286 // Methods for support type inquiry through isa, cast, and dyn_cast:
1287 static inline bool classof(const ReturnInst *) { return true; }
1288 static inline bool classof(const Instruction *I) {
1289 return (I->getOpcode() == Instruction::Ret);
1291 static inline bool classof(const Value *V) {
1292 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1295 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1296 virtual unsigned getNumSuccessorsV() const;
1297 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1300 //===----------------------------------------------------------------------===//
1302 //===----------------------------------------------------------------------===//
1304 //===---------------------------------------------------------------------------
1305 /// BranchInst - Conditional or Unconditional Branch instruction.
1307 class BranchInst : public TerminatorInst {
1308 /// Ops list - Branches are strange. The operands are ordered:
1309 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
1310 /// they don't have to check for cond/uncond branchness.
1312 BranchInst(const BranchInst &BI);
1315 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
1316 // BranchInst(BB *B) - 'br B'
1317 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
1318 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
1319 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
1320 // BranchInst(BB* B, BB *I) - 'br B' insert at end
1321 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
1322 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0)
1323 : TerminatorInst(Instruction::Br, Ops, 1, InsertBefore) {
1324 assert(IfTrue != 0 && "Branch destination may not be null!");
1325 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1327 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1328 Instruction *InsertBefore = 0)
1329 : TerminatorInst(Instruction::Br, Ops, 3, InsertBefore) {
1330 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1331 Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
1332 Ops[2].init(Cond, this);
1338 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
1339 : TerminatorInst(Instruction::Br, Ops, 1, InsertAtEnd) {
1340 assert(IfTrue != 0 && "Branch destination may not be null!");
1341 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1344 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1345 BasicBlock *InsertAtEnd)
1346 : TerminatorInst(Instruction::Br, Ops, 3, InsertAtEnd) {
1347 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1348 Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
1349 Ops[2].init(Cond, this);
1356 /// Transparently provide more efficient getOperand methods.
1357 Value *getOperand(unsigned i) const {
1358 assert(i < getNumOperands() && "getOperand() out of range!");
1361 void setOperand(unsigned i, Value *Val) {
1362 assert(i < getNumOperands() && "setOperand() out of range!");
1366 virtual BranchInst *clone() const;
1368 inline bool isUnconditional() const { return getNumOperands() == 1; }
1369 inline bool isConditional() const { return getNumOperands() == 3; }
1371 inline Value *getCondition() const {
1372 assert(isConditional() && "Cannot get condition of an uncond branch!");
1373 return getOperand(2);
1376 void setCondition(Value *V) {
1377 assert(isConditional() && "Cannot set condition of unconditional branch!");
1381 // setUnconditionalDest - Change the current branch to an unconditional branch
1382 // targeting the specified block.
1383 // FIXME: Eliminate this ugly method.
1384 void setUnconditionalDest(BasicBlock *Dest) {
1385 if (isConditional()) { // Convert this to an uncond branch.
1390 setOperand(0, reinterpret_cast<Value*>(Dest));
1393 unsigned getNumSuccessors() const { return 1+isConditional(); }
1395 BasicBlock *getSuccessor(unsigned i) const {
1396 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
1397 return (i == 0) ? cast<BasicBlock>(getOperand(0)) :
1398 cast<BasicBlock>(getOperand(1));
1401 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1402 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
1403 setOperand(idx, reinterpret_cast<Value*>(NewSucc));
1406 // Methods for support type inquiry through isa, cast, and dyn_cast:
1407 static inline bool classof(const BranchInst *) { return true; }
1408 static inline bool classof(const Instruction *I) {
1409 return (I->getOpcode() == Instruction::Br);
1411 static inline bool classof(const Value *V) {
1412 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1415 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1416 virtual unsigned getNumSuccessorsV() const;
1417 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1420 //===----------------------------------------------------------------------===//
1422 //===----------------------------------------------------------------------===//
1424 //===---------------------------------------------------------------------------
1425 /// SwitchInst - Multiway switch
1427 class SwitchInst : public TerminatorInst {
1428 unsigned ReservedSpace;
1429 // Operand[0] = Value to switch on
1430 // Operand[1] = Default basic block destination
1431 // Operand[2n ] = Value to match
1432 // Operand[2n+1] = BasicBlock to go to on match
1433 SwitchInst(const SwitchInst &RI);
1434 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1435 void resizeOperands(unsigned No);
1437 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1438 /// switch on and a default destination. The number of additional cases can
1439 /// be specified here to make memory allocation more efficient. This
1440 /// constructor can also autoinsert before another instruction.
1441 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1442 Instruction *InsertBefore = 0)
1443 : TerminatorInst(Instruction::Switch, 0, 0, InsertBefore) {
1444 init(Value, Default, NumCases);
1447 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1448 /// switch on and a default destination. The number of additional cases can
1449 /// be specified here to make memory allocation more efficient. This
1450 /// constructor also autoinserts at the end of the specified BasicBlock.
1451 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1452 BasicBlock *InsertAtEnd)
1453 : TerminatorInst(Instruction::Switch, 0, 0, InsertAtEnd) {
1454 init(Value, Default, NumCases);
1459 // Accessor Methods for Switch stmt
1460 inline Value *getCondition() const { return getOperand(0); }
1461 void setCondition(Value *V) { setOperand(0, V); }
1463 inline BasicBlock *getDefaultDest() const {
1464 return cast<BasicBlock>(getOperand(1));
1467 /// getNumCases - return the number of 'cases' in this switch instruction.
1468 /// Note that case #0 is always the default case.
1469 unsigned getNumCases() const {
1470 return getNumOperands()/2;
1473 /// getCaseValue - Return the specified case value. Note that case #0, the
1474 /// default destination, does not have a case value.
1475 ConstantInt *getCaseValue(unsigned i) {
1476 assert(i && i < getNumCases() && "Illegal case value to get!");
1477 return getSuccessorValue(i);
1480 /// getCaseValue - Return the specified case value. Note that case #0, the
1481 /// default destination, does not have a case value.
1482 const ConstantInt *getCaseValue(unsigned i) const {
1483 assert(i && i < getNumCases() && "Illegal case value to get!");
1484 return getSuccessorValue(i);
1487 /// findCaseValue - Search all of the case values for the specified constant.
1488 /// If it is explicitly handled, return the case number of it, otherwise
1489 /// return 0 to indicate that it is handled by the default handler.
1490 unsigned findCaseValue(const ConstantInt *C) const {
1491 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1492 if (getCaseValue(i) == C)
1497 /// findCaseDest - Finds the unique case value for a given successor. Returns
1498 /// null if the successor is not found, not unique, or is the default case.
1499 ConstantInt *findCaseDest(BasicBlock *BB) {
1500 if (BB == getDefaultDest()) return NULL;
1502 ConstantInt *CI = NULL;
1503 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
1504 if (getSuccessor(i) == BB) {
1505 if (CI) return NULL; // Multiple cases lead to BB.
1506 else CI = getCaseValue(i);
1512 /// addCase - Add an entry to the switch instruction...
1514 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1516 /// removeCase - This method removes the specified successor from the switch
1517 /// instruction. Note that this cannot be used to remove the default
1518 /// destination (successor #0).
1520 void removeCase(unsigned idx);
1522 virtual SwitchInst *clone() const;
1524 unsigned getNumSuccessors() const { return getNumOperands()/2; }
1525 BasicBlock *getSuccessor(unsigned idx) const {
1526 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1527 return cast<BasicBlock>(getOperand(idx*2+1));
1529 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1530 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1531 setOperand(idx*2+1, reinterpret_cast<Value*>(NewSucc));
1534 // getSuccessorValue - Return the value associated with the specified
1536 inline ConstantInt *getSuccessorValue(unsigned idx) const {
1537 assert(idx < getNumSuccessors() && "Successor # out of range!");
1538 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1541 // Methods for support type inquiry through isa, cast, and dyn_cast:
1542 static inline bool classof(const SwitchInst *) { return true; }
1543 static inline bool classof(const Instruction *I) {
1544 return I->getOpcode() == Instruction::Switch;
1546 static inline bool classof(const Value *V) {
1547 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1550 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1551 virtual unsigned getNumSuccessorsV() const;
1552 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1555 //===----------------------------------------------------------------------===//
1557 //===----------------------------------------------------------------------===//
1559 //===---------------------------------------------------------------------------
1561 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
1562 /// calling convention of the call.
1564 class InvokeInst : public TerminatorInst {
1565 InvokeInst(const InvokeInst &BI);
1566 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1567 const std::vector<Value*> &Params);
1569 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1570 const std::vector<Value*> &Params, const std::string &Name = "",
1571 Instruction *InsertBefore = 0);
1572 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1573 const std::vector<Value*> &Params, const std::string &Name,
1574 BasicBlock *InsertAtEnd);
1577 virtual InvokeInst *clone() const;
1579 bool mayWriteToMemory() const { return true; }
1581 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1583 unsigned getCallingConv() const { return SubclassData; }
1584 void setCallingConv(unsigned CC) {
1588 /// getCalledFunction - Return the function called, or null if this is an
1589 /// indirect function invocation.
1591 Function *getCalledFunction() const {
1592 return dyn_cast<Function>(getOperand(0));
1595 // getCalledValue - Get a pointer to a function that is invoked by this inst.
1596 inline Value *getCalledValue() const { return getOperand(0); }
1598 // get*Dest - Return the destination basic blocks...
1599 BasicBlock *getNormalDest() const {
1600 return cast<BasicBlock>(getOperand(1));
1602 BasicBlock *getUnwindDest() const {
1603 return cast<BasicBlock>(getOperand(2));
1605 void setNormalDest(BasicBlock *B) {
1606 setOperand(1, reinterpret_cast<Value*>(B));
1609 void setUnwindDest(BasicBlock *B) {
1610 setOperand(2, reinterpret_cast<Value*>(B));
1613 inline BasicBlock *getSuccessor(unsigned i) const {
1614 assert(i < 2 && "Successor # out of range for invoke!");
1615 return i == 0 ? getNormalDest() : getUnwindDest();
1618 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1619 assert(idx < 2 && "Successor # out of range for invoke!");
1620 setOperand(idx+1, reinterpret_cast<Value*>(NewSucc));
1623 unsigned getNumSuccessors() const { return 2; }
1625 // Methods for support type inquiry through isa, cast, and dyn_cast:
1626 static inline bool classof(const InvokeInst *) { return true; }
1627 static inline bool classof(const Instruction *I) {
1628 return (I->getOpcode() == Instruction::Invoke);
1630 static inline bool classof(const Value *V) {
1631 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1634 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1635 virtual unsigned getNumSuccessorsV() const;
1636 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1640 //===----------------------------------------------------------------------===//
1642 //===----------------------------------------------------------------------===//
1644 //===---------------------------------------------------------------------------
1645 /// UnwindInst - Immediately exit the current function, unwinding the stack
1646 /// until an invoke instruction is found.
1648 class UnwindInst : public TerminatorInst {
1650 explicit UnwindInst(Instruction *InsertBefore = 0)
1651 : TerminatorInst(Instruction::Unwind, 0, 0, InsertBefore) {
1653 explicit UnwindInst(BasicBlock *InsertAtEnd)
1654 : TerminatorInst(Instruction::Unwind, 0, 0, InsertAtEnd) {
1657 virtual UnwindInst *clone() const;
1659 unsigned getNumSuccessors() const { return 0; }
1661 // Methods for support type inquiry through isa, cast, and dyn_cast:
1662 static inline bool classof(const UnwindInst *) { return true; }
1663 static inline bool classof(const Instruction *I) {
1664 return I->getOpcode() == Instruction::Unwind;
1666 static inline bool classof(const Value *V) {
1667 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1670 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1671 virtual unsigned getNumSuccessorsV() const;
1672 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1675 //===----------------------------------------------------------------------===//
1676 // UnreachableInst Class
1677 //===----------------------------------------------------------------------===//
1679 //===---------------------------------------------------------------------------
1680 /// UnreachableInst - This function has undefined behavior. In particular, the
1681 /// presence of this instruction indicates some higher level knowledge that the
1682 /// end of the block cannot be reached.
1684 class UnreachableInst : public TerminatorInst {
1686 explicit UnreachableInst(Instruction *InsertBefore = 0)
1687 : TerminatorInst(Instruction::Unreachable, 0, 0, InsertBefore) {
1689 explicit UnreachableInst(BasicBlock *InsertAtEnd)
1690 : TerminatorInst(Instruction::Unreachable, 0, 0, InsertAtEnd) {
1693 virtual UnreachableInst *clone() const;
1695 unsigned getNumSuccessors() const { return 0; }
1697 // Methods for support type inquiry through isa, cast, and dyn_cast:
1698 static inline bool classof(const UnreachableInst *) { return true; }
1699 static inline bool classof(const Instruction *I) {
1700 return I->getOpcode() == Instruction::Unreachable;
1702 static inline bool classof(const Value *V) {
1703 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1706 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1707 virtual unsigned getNumSuccessorsV() const;
1708 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1711 //===----------------------------------------------------------------------===//
1713 //===----------------------------------------------------------------------===//
1715 /// @brief This class represents a truncation of integer types.
1716 class TruncInst : public CastInst {
1717 /// Private copy constructor
1718 TruncInst(const TruncInst &CI)
1719 : CastInst(CI.getType(), Trunc, CI.getOperand(0)) {
1722 /// @brief Constructor with insert-before-instruction semantics
1724 Value *S, ///< The value to be truncated
1725 const Type *Ty, ///< The (smaller) type to truncate to
1726 const std::string &Name = "", ///< A name for the new instruction
1727 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1730 /// @brief Constructor with insert-at-end-of-block semantics
1732 Value *S, ///< The value to be truncated
1733 const Type *Ty, ///< The (smaller) type to truncate to
1734 const std::string &Name, ///< A name for the new instruction
1735 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1738 /// @brief Clone an identical TruncInst
1739 virtual CastInst *clone() const;
1741 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1742 static inline bool classof(const TruncInst *) { return true; }
1743 static inline bool classof(const Instruction *I) {
1744 return I->getOpcode() == Trunc;
1746 static inline bool classof(const Value *V) {
1747 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1751 //===----------------------------------------------------------------------===//
1753 //===----------------------------------------------------------------------===//
1755 /// @brief This class represents zero extension of integer types.
1756 class ZExtInst : public CastInst {
1757 /// @brief Private copy constructor
1758 ZExtInst(const ZExtInst &CI)
1759 : CastInst(CI.getType(), ZExt, CI.getOperand(0)) {
1762 /// @brief Constructor with insert-before-instruction semantics
1764 Value *S, ///< The value to be zero extended
1765 const Type *Ty, ///< The type to zero extend to
1766 const std::string &Name = "", ///< A name for the new instruction
1767 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1770 /// @brief Constructor with insert-at-end semantics.
1772 Value *S, ///< The value to be zero extended
1773 const Type *Ty, ///< The type to zero extend to
1774 const std::string &Name, ///< A name for the new instruction
1775 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1778 /// @brief Clone an identical ZExtInst
1779 virtual CastInst *clone() const;
1781 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1782 static inline bool classof(const ZExtInst *) { return true; }
1783 static inline bool classof(const Instruction *I) {
1784 return I->getOpcode() == ZExt;
1786 static inline bool classof(const Value *V) {
1787 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1791 //===----------------------------------------------------------------------===//
1793 //===----------------------------------------------------------------------===//
1795 /// @brief This class represents a sign extension of integer types.
1796 class SExtInst : public CastInst {
1797 /// @brief Private copy constructor
1798 SExtInst(const SExtInst &CI)
1799 : CastInst(CI.getType(), SExt, CI.getOperand(0)) {
1802 /// @brief Constructor with insert-before-instruction semantics
1804 Value *S, ///< The value to be sign extended
1805 const Type *Ty, ///< The type to sign extend to
1806 const std::string &Name = "", ///< A name for the new instruction
1807 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1810 /// @brief Constructor with insert-at-end-of-block semantics
1812 Value *S, ///< The value to be sign extended
1813 const Type *Ty, ///< The type to sign extend to
1814 const std::string &Name, ///< A name for the new instruction
1815 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1818 /// @brief Clone an identical SExtInst
1819 virtual CastInst *clone() const;
1821 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1822 static inline bool classof(const SExtInst *) { return true; }
1823 static inline bool classof(const Instruction *I) {
1824 return I->getOpcode() == SExt;
1826 static inline bool classof(const Value *V) {
1827 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1831 //===----------------------------------------------------------------------===//
1832 // FPTruncInst Class
1833 //===----------------------------------------------------------------------===//
1835 /// @brief This class represents a truncation of floating point types.
1836 class FPTruncInst : public CastInst {
1837 FPTruncInst(const FPTruncInst &CI)
1838 : CastInst(CI.getType(), FPTrunc, CI.getOperand(0)) {
1841 /// @brief Constructor with insert-before-instruction semantics
1843 Value *S, ///< The value to be truncated
1844 const Type *Ty, ///< The type to truncate to
1845 const std::string &Name = "", ///< A name for the new instruction
1846 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1849 /// @brief Constructor with insert-before-instruction semantics
1851 Value *S, ///< The value to be truncated
1852 const Type *Ty, ///< The type to truncate to
1853 const std::string &Name, ///< A name for the new instruction
1854 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1857 /// @brief Clone an identical FPTruncInst
1858 virtual CastInst *clone() const;
1860 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1861 static inline bool classof(const FPTruncInst *) { return true; }
1862 static inline bool classof(const Instruction *I) {
1863 return I->getOpcode() == FPTrunc;
1865 static inline bool classof(const Value *V) {
1866 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1870 //===----------------------------------------------------------------------===//
1872 //===----------------------------------------------------------------------===//
1874 /// @brief This class represents an extension of floating point types.
1875 class FPExtInst : public CastInst {
1876 FPExtInst(const FPExtInst &CI)
1877 : CastInst(CI.getType(), FPExt, CI.getOperand(0)) {
1880 /// @brief Constructor with insert-before-instruction semantics
1882 Value *S, ///< The value to be extended
1883 const Type *Ty, ///< The type to extend to
1884 const std::string &Name = "", ///< A name for the new instruction
1885 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1888 /// @brief Constructor with insert-at-end-of-block semantics
1890 Value *S, ///< The value to be extended
1891 const Type *Ty, ///< The type to extend to
1892 const std::string &Name, ///< A name for the new instruction
1893 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1896 /// @brief Clone an identical FPExtInst
1897 virtual CastInst *clone() const;
1899 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1900 static inline bool classof(const FPExtInst *) { return true; }
1901 static inline bool classof(const Instruction *I) {
1902 return I->getOpcode() == FPExt;
1904 static inline bool classof(const Value *V) {
1905 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1909 //===----------------------------------------------------------------------===//
1911 //===----------------------------------------------------------------------===//
1913 /// @brief This class represents a cast unsigned integer to floating point.
1914 class UIToFPInst : public CastInst {
1915 UIToFPInst(const UIToFPInst &CI)
1916 : CastInst(CI.getType(), UIToFP, CI.getOperand(0)) {
1919 /// @brief Constructor with insert-before-instruction semantics
1921 Value *S, ///< The value to be converted
1922 const Type *Ty, ///< The type to convert to
1923 const std::string &Name = "", ///< A name for the new instruction
1924 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1927 /// @brief Constructor with insert-at-end-of-block semantics
1929 Value *S, ///< The value to be converted
1930 const Type *Ty, ///< The type to convert to
1931 const std::string &Name, ///< A name for the new instruction
1932 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1935 /// @brief Clone an identical UIToFPInst
1936 virtual CastInst *clone() const;
1938 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1939 static inline bool classof(const UIToFPInst *) { return true; }
1940 static inline bool classof(const Instruction *I) {
1941 return I->getOpcode() == UIToFP;
1943 static inline bool classof(const Value *V) {
1944 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1948 //===----------------------------------------------------------------------===//
1950 //===----------------------------------------------------------------------===//
1952 /// @brief This class represents a cast from signed integer to floating point.
1953 class SIToFPInst : public CastInst {
1954 SIToFPInst(const SIToFPInst &CI)
1955 : CastInst(CI.getType(), SIToFP, CI.getOperand(0)) {
1958 /// @brief Constructor with insert-before-instruction semantics
1960 Value *S, ///< The value to be converted
1961 const Type *Ty, ///< The type to convert to
1962 const std::string &Name = "", ///< A name for the new instruction
1963 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
1966 /// @brief Constructor with insert-at-end-of-block semantics
1968 Value *S, ///< The value to be converted
1969 const Type *Ty, ///< The type to convert to
1970 const std::string &Name, ///< A name for the new instruction
1971 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
1974 /// @brief Clone an identical SIToFPInst
1975 virtual CastInst *clone() const;
1977 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
1978 static inline bool classof(const SIToFPInst *) { return true; }
1979 static inline bool classof(const Instruction *I) {
1980 return I->getOpcode() == SIToFP;
1982 static inline bool classof(const Value *V) {
1983 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1987 //===----------------------------------------------------------------------===//
1989 //===----------------------------------------------------------------------===//
1991 /// @brief This class represents a cast from floating point to unsigned integer
1992 class FPToUIInst : public CastInst {
1993 FPToUIInst(const FPToUIInst &CI)
1994 : CastInst(CI.getType(), FPToUI, CI.getOperand(0)) {
1997 /// @brief Constructor with insert-before-instruction semantics
1999 Value *S, ///< The value to be converted
2000 const Type *Ty, ///< The type to convert to
2001 const std::string &Name = "", ///< A name for the new instruction
2002 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2005 /// @brief Constructor with insert-at-end-of-block semantics
2007 Value *S, ///< The value to be converted
2008 const Type *Ty, ///< The type to convert to
2009 const std::string &Name, ///< A name for the new instruction
2010 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
2013 /// @brief Clone an identical FPToUIInst
2014 virtual CastInst *clone() const;
2016 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2017 static inline bool classof(const FPToUIInst *) { return true; }
2018 static inline bool classof(const Instruction *I) {
2019 return I->getOpcode() == FPToUI;
2021 static inline bool classof(const Value *V) {
2022 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2026 //===----------------------------------------------------------------------===//
2028 //===----------------------------------------------------------------------===//
2030 /// @brief This class represents a cast from floating point to signed integer.
2031 class FPToSIInst : public CastInst {
2032 FPToSIInst(const FPToSIInst &CI)
2033 : CastInst(CI.getType(), FPToSI, CI.getOperand(0)) {
2036 /// @brief Constructor with insert-before-instruction semantics
2038 Value *S, ///< The value to be converted
2039 const Type *Ty, ///< The type to convert to
2040 const std::string &Name = "", ///< A name for the new instruction
2041 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2044 /// @brief Constructor with insert-at-end-of-block semantics
2046 Value *S, ///< The value to be converted
2047 const Type *Ty, ///< The type to convert to
2048 const std::string &Name, ///< A name for the new instruction
2049 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2052 /// @brief Clone an identical FPToSIInst
2053 virtual CastInst *clone() const;
2055 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2056 static inline bool classof(const FPToSIInst *) { return true; }
2057 static inline bool classof(const Instruction *I) {
2058 return I->getOpcode() == FPToSI;
2060 static inline bool classof(const Value *V) {
2061 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2065 //===----------------------------------------------------------------------===//
2066 // IntToPtrInst Class
2067 //===----------------------------------------------------------------------===//
2069 /// @brief This class represents a cast from an integer to a pointer.
2070 class IntToPtrInst : public CastInst {
2071 IntToPtrInst(const IntToPtrInst &CI)
2072 : CastInst(CI.getType(), IntToPtr, CI.getOperand(0)) {
2075 /// @brief Constructor with insert-before-instruction semantics
2077 Value *S, ///< The value to be converted
2078 const Type *Ty, ///< The type to convert to
2079 const std::string &Name = "", ///< A name for the new instruction
2080 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2083 /// @brief Constructor with insert-at-end-of-block semantics
2085 Value *S, ///< The value to be converted
2086 const Type *Ty, ///< The type to convert to
2087 const std::string &Name, ///< A name for the new instruction
2088 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2091 /// @brief Clone an identical IntToPtrInst
2092 virtual CastInst *clone() const;
2094 // Methods for support type inquiry through isa, cast, and dyn_cast:
2095 static inline bool classof(const IntToPtrInst *) { return true; }
2096 static inline bool classof(const Instruction *I) {
2097 return I->getOpcode() == IntToPtr;
2099 static inline bool classof(const Value *V) {
2100 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2104 //===----------------------------------------------------------------------===//
2105 // PtrToIntInst Class
2106 //===----------------------------------------------------------------------===//
2108 /// @brief This class represents a cast from a pointer to an integer
2109 class PtrToIntInst : public CastInst {
2110 PtrToIntInst(const PtrToIntInst &CI)
2111 : CastInst(CI.getType(), PtrToInt, CI.getOperand(0)) {
2114 /// @brief Constructor with insert-before-instruction semantics
2116 Value *S, ///< The value to be converted
2117 const Type *Ty, ///< The type to convert to
2118 const std::string &Name = "", ///< A name for the new instruction
2119 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2122 /// @brief Constructor with insert-at-end-of-block semantics
2124 Value *S, ///< The value to be converted
2125 const Type *Ty, ///< The type to convert to
2126 const std::string &Name, ///< A name for the new instruction
2127 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2130 /// @brief Clone an identical PtrToIntInst
2131 virtual CastInst *clone() const;
2133 // Methods for support type inquiry through isa, cast, and dyn_cast:
2134 static inline bool classof(const PtrToIntInst *) { return true; }
2135 static inline bool classof(const Instruction *I) {
2136 return I->getOpcode() == PtrToInt;
2138 static inline bool classof(const Value *V) {
2139 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2143 //===----------------------------------------------------------------------===//
2144 // BitCastInst Class
2145 //===----------------------------------------------------------------------===//
2147 /// @brief This class represents a no-op cast from one type to another.
2148 class BitCastInst : public CastInst {
2149 BitCastInst(const BitCastInst &CI)
2150 : CastInst(CI.getType(), BitCast, CI.getOperand(0)) {
2153 /// @brief Constructor with insert-before-instruction semantics
2155 Value *S, ///< The value to be casted
2156 const Type *Ty, ///< The type to casted to
2157 const std::string &Name = "", ///< A name for the new instruction
2158 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2161 /// @brief Constructor with insert-at-end-of-block semantics
2163 Value *S, ///< The value to be casted
2164 const Type *Ty, ///< The type to casted to
2165 const std::string &Name, ///< A name for the new instruction
2166 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2169 /// @brief Clone an identical BitCastInst
2170 virtual CastInst *clone() const;
2172 // Methods for support type inquiry through isa, cast, and dyn_cast:
2173 static inline bool classof(const BitCastInst *) { return true; }
2174 static inline bool classof(const Instruction *I) {
2175 return I->getOpcode() == BitCast;
2177 static inline bool classof(const Value *V) {
2178 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2182 } // End llvm namespace