1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file exposes the class definitions of all of the subclasses of the
11 // Instruction class. This is meant to be an easy way to get access to all
12 // instruction subclasses.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_INSTRUCTIONS_H
17 #define LLVM_INSTRUCTIONS_H
19 #include "llvm/InstrTypes.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/Attributes.h"
22 #include "llvm/CallingConv.h"
23 #include "llvm/ADT/SmallVector.h"
33 //===----------------------------------------------------------------------===//
35 //===----------------------------------------------------------------------===//
37 /// AllocaInst - an instruction to allocate memory on the stack
39 class AllocaInst : public UnaryInstruction {
41 virtual AllocaInst *clone_impl() const;
43 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
44 const Twine &Name = "", Instruction *InsertBefore = 0);
45 AllocaInst(const Type *Ty, Value *ArraySize,
46 const Twine &Name, BasicBlock *InsertAtEnd);
48 AllocaInst(const Type *Ty, const Twine &Name, Instruction *InsertBefore = 0);
49 AllocaInst(const Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd);
51 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
52 const Twine &Name = "", Instruction *InsertBefore = 0);
53 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
54 const Twine &Name, BasicBlock *InsertAtEnd);
56 // Out of line virtual method, so the vtable, etc. has a home.
57 virtual ~AllocaInst();
59 /// isArrayAllocation - Return true if there is an allocation size parameter
60 /// to the allocation instruction that is not 1.
62 bool isArrayAllocation() const;
64 /// getArraySize - Get the number of elements allocated. For a simple
65 /// allocation of a single element, this will return a constant 1 value.
67 const Value *getArraySize() const { return getOperand(0); }
68 Value *getArraySize() { return getOperand(0); }
70 /// getType - Overload to return most specific pointer type
72 const PointerType *getType() const {
73 return reinterpret_cast<const PointerType*>(Instruction::getType());
76 /// getAllocatedType - Return the type that is being allocated by the
79 const Type *getAllocatedType() const;
81 /// getAlignment - Return the alignment of the memory that is being allocated
82 /// by the instruction.
84 unsigned getAlignment() const {
85 return (1u << getSubclassDataFromInstruction()) >> 1;
87 void setAlignment(unsigned Align);
89 /// isStaticAlloca - Return true if this alloca is in the entry block of the
90 /// function and is a constant size. If so, the code generator will fold it
91 /// into the prolog/epilog code, so it is basically free.
92 bool isStaticAlloca() const;
94 // Methods for support type inquiry through isa, cast, and dyn_cast:
95 static inline bool classof(const AllocaInst *) { return true; }
96 static inline bool classof(const Instruction *I) {
97 return (I->getOpcode() == Instruction::Alloca);
99 static inline bool classof(const Value *V) {
100 return isa<Instruction>(V) && classof(cast<Instruction>(V));
103 // Shadow Instruction::setInstructionSubclassData with a private forwarding
104 // method so that subclasses cannot accidentally use it.
105 void setInstructionSubclassData(unsigned short D) {
106 Instruction::setInstructionSubclassData(D);
111 //===----------------------------------------------------------------------===//
113 //===----------------------------------------------------------------------===//
115 /// LoadInst - an instruction for reading from memory. This uses the
116 /// SubclassData field in Value to store whether or not the load is volatile.
118 class LoadInst : public UnaryInstruction {
121 virtual LoadInst *clone_impl() const;
123 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
124 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
125 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
126 Instruction *InsertBefore = 0);
127 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
128 unsigned Align, Instruction *InsertBefore = 0);
129 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
130 BasicBlock *InsertAtEnd);
131 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
132 unsigned Align, BasicBlock *InsertAtEnd);
134 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
135 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
136 explicit LoadInst(Value *Ptr, const char *NameStr = 0,
137 bool isVolatile = false, Instruction *InsertBefore = 0);
138 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
139 BasicBlock *InsertAtEnd);
141 /// isVolatile - Return true if this is a load from a volatile memory
144 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
146 /// setVolatile - Specify whether this is a volatile load or not.
148 void setVolatile(bool V) {
149 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
153 /// getAlignment - Return the alignment of the access that is being performed
155 unsigned getAlignment() const {
156 return (1 << (getSubclassDataFromInstruction() >> 1)) >> 1;
159 void setAlignment(unsigned Align);
161 Value *getPointerOperand() { return getOperand(0); }
162 const Value *getPointerOperand() const { return getOperand(0); }
163 static unsigned getPointerOperandIndex() { return 0U; }
165 unsigned getPointerAddressSpace() const {
166 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
170 // Methods for support type inquiry through isa, cast, and dyn_cast:
171 static inline bool classof(const LoadInst *) { return true; }
172 static inline bool classof(const Instruction *I) {
173 return I->getOpcode() == Instruction::Load;
175 static inline bool classof(const Value *V) {
176 return isa<Instruction>(V) && classof(cast<Instruction>(V));
179 // Shadow Instruction::setInstructionSubclassData with a private forwarding
180 // method so that subclasses cannot accidentally use it.
181 void setInstructionSubclassData(unsigned short D) {
182 Instruction::setInstructionSubclassData(D);
187 //===----------------------------------------------------------------------===//
189 //===----------------------------------------------------------------------===//
191 /// StoreInst - an instruction for storing to memory
193 class StoreInst : public Instruction {
194 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
197 virtual StoreInst *clone_impl() const;
199 // allocate space for exactly two operands
200 void *operator new(size_t s) {
201 return User::operator new(s, 2);
203 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
204 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
205 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
206 Instruction *InsertBefore = 0);
207 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
208 unsigned Align, Instruction *InsertBefore = 0);
209 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
210 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
211 unsigned Align, BasicBlock *InsertAtEnd);
214 /// isVolatile - Return true if this is a load from a volatile memory
217 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
219 /// setVolatile - Specify whether this is a volatile load or not.
221 void setVolatile(bool V) {
222 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
226 /// Transparently provide more efficient getOperand methods.
227 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
229 /// getAlignment - Return the alignment of the access that is being performed
231 unsigned getAlignment() const {
232 return (1 << (getSubclassDataFromInstruction() >> 1)) >> 1;
235 void setAlignment(unsigned Align);
237 Value *getValueOperand() { return getOperand(0); }
238 const Value *getValueOperand() const { return getOperand(0); }
240 Value *getPointerOperand() { return getOperand(1); }
241 const Value *getPointerOperand() const { return getOperand(1); }
242 static unsigned getPointerOperandIndex() { return 1U; }
244 unsigned getPointerAddressSpace() const {
245 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
248 // Methods for support type inquiry through isa, cast, and dyn_cast:
249 static inline bool classof(const StoreInst *) { return true; }
250 static inline bool classof(const Instruction *I) {
251 return I->getOpcode() == Instruction::Store;
253 static inline bool classof(const Value *V) {
254 return isa<Instruction>(V) && classof(cast<Instruction>(V));
257 // Shadow Instruction::setInstructionSubclassData with a private forwarding
258 // method so that subclasses cannot accidentally use it.
259 void setInstructionSubclassData(unsigned short D) {
260 Instruction::setInstructionSubclassData(D);
265 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<StoreInst, 2> {
268 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
270 //===----------------------------------------------------------------------===//
271 // GetElementPtrInst Class
272 //===----------------------------------------------------------------------===//
274 // checkType - Simple wrapper function to give a better assertion failure
275 // message on bad indexes for a gep instruction.
277 static inline const Type *checkType(const Type *Ty) {
278 assert(Ty && "Invalid GetElementPtrInst indices for type!");
282 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
283 /// access elements of arrays and structs
285 class GetElementPtrInst : public Instruction {
286 GetElementPtrInst(const GetElementPtrInst &GEPI);
287 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx,
288 const Twine &NameStr);
289 void init(Value *Ptr, Value *Idx, const Twine &NameStr);
291 template<typename RandomAccessIterator>
292 void init(Value *Ptr,
293 RandomAccessIterator IdxBegin,
294 RandomAccessIterator IdxEnd,
295 const Twine &NameStr,
296 // This argument ensures that we have an iterator we can
297 // do arithmetic on in constant time
298 std::random_access_iterator_tag) {
299 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
302 // This requires that the iterator points to contiguous memory.
303 init(Ptr, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
304 // we have to build an array here
307 init(Ptr, 0, NumIdx, NameStr);
311 /// getIndexedType - Returns the type of the element that would be loaded with
312 /// a load instruction with the specified parameters.
314 /// Null is returned if the indices are invalid for the specified
317 template<typename RandomAccessIterator>
318 static const Type *getIndexedType(const Type *Ptr,
319 RandomAccessIterator IdxBegin,
320 RandomAccessIterator IdxEnd,
321 // This argument ensures that we
322 // have an iterator we can do
323 // arithmetic on in constant time
324 std::random_access_iterator_tag) {
325 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
328 // This requires that the iterator points to contiguous memory.
329 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
331 return getIndexedType(Ptr, (Value *const*)0, NumIdx);
334 /// Constructors - Create a getelementptr instruction with a base pointer an
335 /// list of indices. The first ctor can optionally insert before an existing
336 /// instruction, the second appends the new instruction to the specified
338 template<typename RandomAccessIterator>
339 inline GetElementPtrInst(Value *Ptr, RandomAccessIterator IdxBegin,
340 RandomAccessIterator IdxEnd,
342 const Twine &NameStr,
343 Instruction *InsertBefore);
344 template<typename RandomAccessIterator>
345 inline GetElementPtrInst(Value *Ptr,
346 RandomAccessIterator IdxBegin,
347 RandomAccessIterator IdxEnd,
349 const Twine &NameStr, BasicBlock *InsertAtEnd);
351 /// Constructors - These two constructors are convenience methods because one
352 /// and two index getelementptr instructions are so common.
353 GetElementPtrInst(Value *Ptr, Value *Idx, const Twine &NameStr = "",
354 Instruction *InsertBefore = 0);
355 GetElementPtrInst(Value *Ptr, Value *Idx,
356 const Twine &NameStr, BasicBlock *InsertAtEnd);
358 virtual GetElementPtrInst *clone_impl() const;
360 template<typename RandomAccessIterator>
361 static GetElementPtrInst *Create(Value *Ptr, RandomAccessIterator IdxBegin,
362 RandomAccessIterator IdxEnd,
363 const Twine &NameStr = "",
364 Instruction *InsertBefore = 0) {
365 typename std::iterator_traits<RandomAccessIterator>::difference_type
366 Values = 1 + std::distance(IdxBegin, IdxEnd);
368 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertBefore);
370 template<typename RandomAccessIterator>
371 static GetElementPtrInst *Create(Value *Ptr,
372 RandomAccessIterator IdxBegin,
373 RandomAccessIterator IdxEnd,
374 const Twine &NameStr,
375 BasicBlock *InsertAtEnd) {
376 typename std::iterator_traits<RandomAccessIterator>::difference_type
377 Values = 1 + std::distance(IdxBegin, IdxEnd);
379 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertAtEnd);
382 /// Constructors - These two creators are convenience methods because one
383 /// index getelementptr instructions are so common.
384 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
385 const Twine &NameStr = "",
386 Instruction *InsertBefore = 0) {
387 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertBefore);
389 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
390 const Twine &NameStr,
391 BasicBlock *InsertAtEnd) {
392 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertAtEnd);
395 /// Create an "inbounds" getelementptr. See the documentation for the
396 /// "inbounds" flag in LangRef.html for details.
397 template<typename RandomAccessIterator>
398 static GetElementPtrInst *CreateInBounds(Value *Ptr,
399 RandomAccessIterator IdxBegin,
400 RandomAccessIterator IdxEnd,
401 const Twine &NameStr = "",
402 Instruction *InsertBefore = 0) {
403 GetElementPtrInst *GEP = Create(Ptr, IdxBegin, IdxEnd,
404 NameStr, InsertBefore);
405 GEP->setIsInBounds(true);
408 template<typename RandomAccessIterator>
409 static GetElementPtrInst *CreateInBounds(Value *Ptr,
410 RandomAccessIterator IdxBegin,
411 RandomAccessIterator IdxEnd,
412 const Twine &NameStr,
413 BasicBlock *InsertAtEnd) {
414 GetElementPtrInst *GEP = Create(Ptr, IdxBegin, IdxEnd,
415 NameStr, InsertAtEnd);
416 GEP->setIsInBounds(true);
419 static GetElementPtrInst *CreateInBounds(Value *Ptr, Value *Idx,
420 const Twine &NameStr = "",
421 Instruction *InsertBefore = 0) {
422 GetElementPtrInst *GEP = Create(Ptr, Idx, NameStr, InsertBefore);
423 GEP->setIsInBounds(true);
426 static GetElementPtrInst *CreateInBounds(Value *Ptr, Value *Idx,
427 const Twine &NameStr,
428 BasicBlock *InsertAtEnd) {
429 GetElementPtrInst *GEP = Create(Ptr, Idx, NameStr, InsertAtEnd);
430 GEP->setIsInBounds(true);
434 /// Transparently provide more efficient getOperand methods.
435 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
437 // getType - Overload to return most specific pointer type...
438 const PointerType *getType() const {
439 return reinterpret_cast<const PointerType*>(Instruction::getType());
442 /// getIndexedType - Returns the type of the element that would be loaded with
443 /// a load instruction with the specified parameters.
445 /// Null is returned if the indices are invalid for the specified
448 template<typename RandomAccessIterator>
449 static const Type *getIndexedType(const Type *Ptr,
450 RandomAccessIterator IdxBegin,
451 RandomAccessIterator IdxEnd) {
452 return getIndexedType(Ptr, IdxBegin, IdxEnd,
453 typename std::iterator_traits<RandomAccessIterator>::
454 iterator_category());
457 static const Type *getIndexedType(const Type *Ptr,
458 Value* const *Idx, unsigned NumIdx);
460 static const Type *getIndexedType(const Type *Ptr,
461 Constant* const *Idx, unsigned NumIdx);
463 static const Type *getIndexedType(const Type *Ptr,
464 uint64_t const *Idx, unsigned NumIdx);
466 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
468 inline op_iterator idx_begin() { return op_begin()+1; }
469 inline const_op_iterator idx_begin() const { return op_begin()+1; }
470 inline op_iterator idx_end() { return op_end(); }
471 inline const_op_iterator idx_end() const { return op_end(); }
473 Value *getPointerOperand() {
474 return getOperand(0);
476 const Value *getPointerOperand() const {
477 return getOperand(0);
479 static unsigned getPointerOperandIndex() {
480 return 0U; // get index for modifying correct operand
483 unsigned getPointerAddressSpace() const {
484 return cast<PointerType>(getType())->getAddressSpace();
487 /// getPointerOperandType - Method to return the pointer operand as a
489 const PointerType *getPointerOperandType() const {
490 return reinterpret_cast<const PointerType*>(getPointerOperand()->getType());
494 unsigned getNumIndices() const { // Note: always non-negative
495 return getNumOperands() - 1;
498 bool hasIndices() const {
499 return getNumOperands() > 1;
502 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
503 /// zeros. If so, the result pointer and the first operand have the same
504 /// value, just potentially different types.
505 bool hasAllZeroIndices() const;
507 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
508 /// constant integers. If so, the result pointer and the first operand have
509 /// a constant offset between them.
510 bool hasAllConstantIndices() const;
512 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
513 /// See LangRef.html for the meaning of inbounds on a getelementptr.
514 void setIsInBounds(bool b = true);
516 /// isInBounds - Determine whether the GEP has the inbounds flag.
517 bool isInBounds() const;
519 // Methods for support type inquiry through isa, cast, and dyn_cast:
520 static inline bool classof(const GetElementPtrInst *) { return true; }
521 static inline bool classof(const Instruction *I) {
522 return (I->getOpcode() == Instruction::GetElementPtr);
524 static inline bool classof(const Value *V) {
525 return isa<Instruction>(V) && classof(cast<Instruction>(V));
530 struct OperandTraits<GetElementPtrInst> :
531 public VariadicOperandTraits<GetElementPtrInst, 1> {
534 template<typename RandomAccessIterator>
535 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
536 RandomAccessIterator IdxBegin,
537 RandomAccessIterator IdxEnd,
539 const Twine &NameStr,
540 Instruction *InsertBefore)
541 : Instruction(PointerType::get(checkType(
542 getIndexedType(Ptr->getType(),
544 cast<PointerType>(Ptr->getType())
545 ->getAddressSpace()),
547 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
548 Values, InsertBefore) {
549 init(Ptr, IdxBegin, IdxEnd, NameStr,
550 typename std::iterator_traits<RandomAccessIterator>
551 ::iterator_category());
553 template<typename RandomAccessIterator>
554 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
555 RandomAccessIterator IdxBegin,
556 RandomAccessIterator IdxEnd,
558 const Twine &NameStr,
559 BasicBlock *InsertAtEnd)
560 : Instruction(PointerType::get(checkType(
561 getIndexedType(Ptr->getType(),
563 cast<PointerType>(Ptr->getType())
564 ->getAddressSpace()),
566 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
567 Values, InsertAtEnd) {
568 init(Ptr, IdxBegin, IdxEnd, NameStr,
569 typename std::iterator_traits<RandomAccessIterator>
570 ::iterator_category());
574 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
577 //===----------------------------------------------------------------------===//
579 //===----------------------------------------------------------------------===//
581 /// This instruction compares its operands according to the predicate given
582 /// to the constructor. It only operates on integers or pointers. The operands
583 /// must be identical types.
584 /// @brief Represent an integer comparison operator.
585 class ICmpInst: public CmpInst {
587 /// @brief Clone an indentical ICmpInst
588 virtual ICmpInst *clone_impl() const;
590 /// @brief Constructor with insert-before-instruction semantics.
592 Instruction *InsertBefore, ///< Where to insert
593 Predicate pred, ///< The predicate to use for the comparison
594 Value *LHS, ///< The left-hand-side of the expression
595 Value *RHS, ///< The right-hand-side of the expression
596 const Twine &NameStr = "" ///< Name of the instruction
597 ) : CmpInst(makeCmpResultType(LHS->getType()),
598 Instruction::ICmp, pred, LHS, RHS, NameStr,
600 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
601 pred <= CmpInst::LAST_ICMP_PREDICATE &&
602 "Invalid ICmp predicate value");
603 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
604 "Both operands to ICmp instruction are not of the same type!");
605 // Check that the operands are the right type
606 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
607 getOperand(0)->getType()->isPointerTy()) &&
608 "Invalid operand types for ICmp instruction");
611 /// @brief Constructor with insert-at-end semantics.
613 BasicBlock &InsertAtEnd, ///< Block to insert into.
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 Twine &NameStr = "" ///< Name of the instruction
618 ) : CmpInst(makeCmpResultType(LHS->getType()),
619 Instruction::ICmp, pred, LHS, RHS, NameStr,
621 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
622 pred <= CmpInst::LAST_ICMP_PREDICATE &&
623 "Invalid ICmp predicate value");
624 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
625 "Both operands to ICmp instruction are not of the same type!");
626 // Check that the operands are the right type
627 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
628 getOperand(0)->getType()->isPointerTy()) &&
629 "Invalid operand types for ICmp instruction");
632 /// @brief Constructor with no-insertion semantics
634 Predicate pred, ///< The predicate to use for the comparison
635 Value *LHS, ///< The left-hand-side of the expression
636 Value *RHS, ///< The right-hand-side of the expression
637 const Twine &NameStr = "" ///< Name of the instruction
638 ) : CmpInst(makeCmpResultType(LHS->getType()),
639 Instruction::ICmp, pred, LHS, RHS, NameStr) {
640 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
641 pred <= CmpInst::LAST_ICMP_PREDICATE &&
642 "Invalid ICmp predicate value");
643 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
644 "Both operands to ICmp instruction are not of the same type!");
645 // Check that the operands are the right type
646 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
647 getOperand(0)->getType()->isPointerTy()) &&
648 "Invalid operand types for ICmp instruction");
651 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
652 /// @returns the predicate that would be the result if the operand were
653 /// regarded as signed.
654 /// @brief Return the signed version of the predicate
655 Predicate getSignedPredicate() const {
656 return getSignedPredicate(getPredicate());
659 /// This is a static version that you can use without an instruction.
660 /// @brief Return the signed version of the predicate.
661 static Predicate getSignedPredicate(Predicate pred);
663 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
664 /// @returns the predicate that would be the result if the operand were
665 /// regarded as unsigned.
666 /// @brief Return the unsigned version of the predicate
667 Predicate getUnsignedPredicate() const {
668 return getUnsignedPredicate(getPredicate());
671 /// This is a static version that you can use without an instruction.
672 /// @brief Return the unsigned version of the predicate.
673 static Predicate getUnsignedPredicate(Predicate pred);
675 /// isEquality - Return true if this predicate is either EQ or NE. This also
676 /// tests for commutativity.
677 static bool isEquality(Predicate P) {
678 return P == ICMP_EQ || P == ICMP_NE;
681 /// isEquality - Return true if this predicate is either EQ or NE. This also
682 /// tests for commutativity.
683 bool isEquality() const {
684 return isEquality(getPredicate());
687 /// @returns true if the predicate of this ICmpInst is commutative
688 /// @brief Determine if this relation is commutative.
689 bool isCommutative() const { return isEquality(); }
691 /// isRelational - Return true if the predicate is relational (not EQ or NE).
693 bool isRelational() const {
694 return !isEquality();
697 /// isRelational - Return true if the predicate is relational (not EQ or NE).
699 static bool isRelational(Predicate P) {
700 return !isEquality(P);
703 /// Initialize a set of values that all satisfy the predicate with C.
704 /// @brief Make a ConstantRange for a relation with a constant value.
705 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
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 setPredicate(getSwappedPredicate());
714 Op<0>().swap(Op<1>());
717 // Methods for support type inquiry through isa, cast, and dyn_cast:
718 static inline bool classof(const ICmpInst *) { return true; }
719 static inline bool classof(const Instruction *I) {
720 return I->getOpcode() == Instruction::ICmp;
722 static inline bool classof(const Value *V) {
723 return isa<Instruction>(V) && classof(cast<Instruction>(V));
728 //===----------------------------------------------------------------------===//
730 //===----------------------------------------------------------------------===//
732 /// This instruction compares its operands according to the predicate given
733 /// to the constructor. It only operates on floating point values or packed
734 /// vectors of floating point values. The operands must be identical types.
735 /// @brief Represents a floating point comparison operator.
736 class FCmpInst: public CmpInst {
738 /// @brief Clone an indentical FCmpInst
739 virtual FCmpInst *clone_impl() const;
741 /// @brief Constructor with insert-before-instruction semantics.
743 Instruction *InsertBefore, ///< Where to insert
744 Predicate pred, ///< The predicate to use for the comparison
745 Value *LHS, ///< The left-hand-side of the expression
746 Value *RHS, ///< The right-hand-side of the expression
747 const Twine &NameStr = "" ///< Name of the instruction
748 ) : CmpInst(makeCmpResultType(LHS->getType()),
749 Instruction::FCmp, pred, LHS, RHS, NameStr,
751 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
752 "Invalid FCmp predicate value");
753 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
754 "Both operands to FCmp instruction are not of the same type!");
755 // Check that the operands are the right type
756 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
757 "Invalid operand types for FCmp instruction");
760 /// @brief Constructor with insert-at-end semantics.
762 BasicBlock &InsertAtEnd, ///< Block to insert into.
763 Predicate pred, ///< The predicate to use for the comparison
764 Value *LHS, ///< The left-hand-side of the expression
765 Value *RHS, ///< The right-hand-side of the expression
766 const Twine &NameStr = "" ///< Name of the instruction
767 ) : CmpInst(makeCmpResultType(LHS->getType()),
768 Instruction::FCmp, pred, LHS, RHS, NameStr,
770 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
771 "Invalid FCmp predicate value");
772 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
773 "Both operands to FCmp instruction are not of the same type!");
774 // Check that the operands are the right type
775 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
776 "Invalid operand types for FCmp instruction");
779 /// @brief Constructor with no-insertion semantics
781 Predicate pred, ///< The predicate to use for the comparison
782 Value *LHS, ///< The left-hand-side of the expression
783 Value *RHS, ///< The right-hand-side of the expression
784 const Twine &NameStr = "" ///< Name of the instruction
785 ) : CmpInst(makeCmpResultType(LHS->getType()),
786 Instruction::FCmp, pred, LHS, RHS, NameStr) {
787 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
788 "Invalid FCmp predicate value");
789 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
790 "Both operands to FCmp instruction are not of the same type!");
791 // Check that the operands are the right type
792 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
793 "Invalid operand types for FCmp instruction");
796 /// @returns true if the predicate of this instruction is EQ or NE.
797 /// @brief Determine if this is an equality predicate.
798 bool isEquality() const {
799 return getPredicate() == FCMP_OEQ || getPredicate() == FCMP_ONE ||
800 getPredicate() == FCMP_UEQ || getPredicate() == FCMP_UNE;
803 /// @returns true if the predicate of this instruction is commutative.
804 /// @brief Determine if this is a commutative predicate.
805 bool isCommutative() const {
806 return isEquality() ||
807 getPredicate() == FCMP_FALSE ||
808 getPredicate() == FCMP_TRUE ||
809 getPredicate() == FCMP_ORD ||
810 getPredicate() == FCMP_UNO;
813 /// @returns true if the predicate is relational (not EQ or NE).
814 /// @brief Determine if this a relational predicate.
815 bool isRelational() const { return !isEquality(); }
817 /// Exchange the two operands to this instruction in such a way that it does
818 /// not modify the semantics of the instruction. The predicate value may be
819 /// changed to retain the same result if the predicate is order dependent
821 /// @brief Swap operands and adjust predicate.
822 void swapOperands() {
823 setPredicate(getSwappedPredicate());
824 Op<0>().swap(Op<1>());
827 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
828 static inline bool classof(const FCmpInst *) { return true; }
829 static inline bool classof(const Instruction *I) {
830 return I->getOpcode() == Instruction::FCmp;
832 static inline bool classof(const Value *V) {
833 return isa<Instruction>(V) && classof(cast<Instruction>(V));
837 //===----------------------------------------------------------------------===//
838 /// CallInst - This class represents a function call, abstracting a target
839 /// machine's calling convention. This class uses low bit of the SubClassData
840 /// field to indicate whether or not this is a tail call. The rest of the bits
841 /// hold the calling convention of the call.
843 class CallInst : public Instruction {
844 AttrListPtr AttributeList; ///< parameter attributes for call
845 CallInst(const CallInst &CI);
846 void init(Value *Func, Value* const *Params, unsigned NumParams);
847 void init(Value *Func, Value *Actual1, Value *Actual2);
848 void init(Value *Func, Value *Actual);
849 void init(Value *Func);
851 template<typename RandomAccessIterator>
852 void init(Value *Func,
853 RandomAccessIterator ArgBegin,
854 RandomAccessIterator ArgEnd,
855 const Twine &NameStr,
856 // This argument ensures that we have an iterator we can
857 // do arithmetic on in constant time
858 std::random_access_iterator_tag) {
859 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
861 // This requires that the iterator points to contiguous memory.
862 init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
866 /// Construct a CallInst given a range of arguments. RandomAccessIterator
867 /// must be a random-access iterator pointing to contiguous storage
868 /// (e.g. a std::vector<>::iterator). Checks are made for
869 /// random-accessness but not for contiguous storage as that would
870 /// incur runtime overhead.
871 /// @brief Construct a CallInst from a range of arguments
872 template<typename RandomAccessIterator>
873 CallInst(Value *Func,
874 RandomAccessIterator ArgBegin, RandomAccessIterator ArgEnd,
875 const Twine &NameStr, Instruction *InsertBefore);
877 /// Construct a CallInst given a range of arguments. RandomAccessIterator
878 /// must be a random-access iterator pointing to contiguous storage
879 /// (e.g. a std::vector<>::iterator). Checks are made for
880 /// random-accessness but not for contiguous storage as that would
881 /// incur runtime overhead.
882 /// @brief Construct a CallInst from a range of arguments
883 template<typename RandomAccessIterator>
884 inline CallInst(Value *Func,
885 RandomAccessIterator ArgBegin, RandomAccessIterator ArgEnd,
886 const Twine &NameStr, BasicBlock *InsertAtEnd);
888 CallInst(Value *F, Value *Actual, const Twine &NameStr,
889 Instruction *InsertBefore);
890 CallInst(Value *F, Value *Actual, const Twine &NameStr,
891 BasicBlock *InsertAtEnd);
892 explicit CallInst(Value *F, const Twine &NameStr,
893 Instruction *InsertBefore);
894 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
896 virtual CallInst *clone_impl() const;
898 template<typename RandomAccessIterator>
899 static CallInst *Create(Value *Func,
900 RandomAccessIterator ArgBegin,
901 RandomAccessIterator ArgEnd,
902 const Twine &NameStr = "",
903 Instruction *InsertBefore = 0) {
904 return new(unsigned(ArgEnd - ArgBegin + 1))
905 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertBefore);
907 template<typename RandomAccessIterator>
908 static CallInst *Create(Value *Func,
909 RandomAccessIterator ArgBegin,
910 RandomAccessIterator ArgEnd,
911 const Twine &NameStr, BasicBlock *InsertAtEnd) {
912 return new(unsigned(ArgEnd - ArgBegin + 1))
913 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertAtEnd);
915 static CallInst *Create(Value *F, Value *Actual,
916 const Twine &NameStr = "",
917 Instruction *InsertBefore = 0) {
918 return new(2) CallInst(F, Actual, NameStr, InsertBefore);
920 static CallInst *Create(Value *F, Value *Actual, const Twine &NameStr,
921 BasicBlock *InsertAtEnd) {
922 return new(2) CallInst(F, Actual, NameStr, InsertAtEnd);
924 static CallInst *Create(Value *F, const Twine &NameStr = "",
925 Instruction *InsertBefore = 0) {
926 return new(1) CallInst(F, NameStr, InsertBefore);
928 static CallInst *Create(Value *F, const Twine &NameStr,
929 BasicBlock *InsertAtEnd) {
930 return new(1) CallInst(F, NameStr, InsertAtEnd);
932 /// CreateMalloc - Generate the IR for a call to malloc:
933 /// 1. Compute the malloc call's argument as the specified type's size,
934 /// possibly multiplied by the array size if the array size is not
936 /// 2. Call malloc with that argument.
937 /// 3. Bitcast the result of the malloc call to the specified type.
938 static Instruction *CreateMalloc(Instruction *InsertBefore,
939 const Type *IntPtrTy, const Type *AllocTy,
940 Value *AllocSize, Value *ArraySize = 0,
941 Function* MallocF = 0,
942 const Twine &Name = "");
943 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
944 const Type *IntPtrTy, const Type *AllocTy,
945 Value *AllocSize, Value *ArraySize = 0,
946 Function* MallocF = 0,
947 const Twine &Name = "");
948 /// CreateFree - Generate the IR for a call to the builtin free function.
949 static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
950 static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
954 bool isTailCall() const { return getSubclassDataFromInstruction() & 1; }
955 void setTailCall(bool isTC = true) {
956 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
960 /// Provide fast operand accessors
961 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
963 /// getNumArgOperands - Return the number of call arguments.
965 unsigned getNumArgOperands() const { return getNumOperands() - 1; }
967 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
969 Value *getArgOperand(unsigned i) const { return getOperand(i); }
970 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
972 /// getCallingConv/setCallingConv - Get or set the calling convention of this
974 CallingConv::ID getCallingConv() const {
975 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 1);
977 void setCallingConv(CallingConv::ID CC) {
978 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
979 (static_cast<unsigned>(CC) << 1));
982 /// getAttributes - Return the parameter attributes for this call.
984 const AttrListPtr &getAttributes() const { return AttributeList; }
986 /// setAttributes - Set the parameter attributes for this call.
988 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
990 /// addAttribute - adds the attribute to the list of attributes.
991 void addAttribute(unsigned i, Attributes attr);
993 /// removeAttribute - removes the attribute from the list of attributes.
994 void removeAttribute(unsigned i, Attributes attr);
996 /// @brief Determine whether the call or the callee has the given attribute.
997 bool paramHasAttr(unsigned i, Attributes attr) const;
999 /// @brief Extract the alignment for a call or parameter (0=unknown).
1000 unsigned getParamAlignment(unsigned i) const {
1001 return AttributeList.getParamAlignment(i);
1004 /// @brief Return true if the call should not be inlined.
1005 bool isNoInline() const { return paramHasAttr(~0, Attribute::NoInline); }
1006 void setIsNoInline(bool Value = true) {
1007 if (Value) addAttribute(~0, Attribute::NoInline);
1008 else removeAttribute(~0, Attribute::NoInline);
1011 /// @brief Determine if the call does not access memory.
1012 bool doesNotAccessMemory() const {
1013 return paramHasAttr(~0, Attribute::ReadNone);
1015 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1016 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
1017 else removeAttribute(~0, Attribute::ReadNone);
1020 /// @brief Determine if the call does not access or only reads memory.
1021 bool onlyReadsMemory() const {
1022 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
1024 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1025 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
1026 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
1029 /// @brief Determine if the call cannot return.
1030 bool doesNotReturn() const { return paramHasAttr(~0, Attribute::NoReturn); }
1031 void setDoesNotReturn(bool DoesNotReturn = true) {
1032 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
1033 else removeAttribute(~0, Attribute::NoReturn);
1036 /// @brief Determine if the call cannot unwind.
1037 bool doesNotThrow() const { return paramHasAttr(~0, Attribute::NoUnwind); }
1038 void setDoesNotThrow(bool DoesNotThrow = true) {
1039 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
1040 else removeAttribute(~0, Attribute::NoUnwind);
1043 /// @brief Determine if the call returns a structure through first
1044 /// pointer argument.
1045 bool hasStructRetAttr() const {
1046 // Be friendly and also check the callee.
1047 return paramHasAttr(1, Attribute::StructRet);
1050 /// @brief Determine if any call argument is an aggregate passed by value.
1051 bool hasByValArgument() const {
1052 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1055 /// getCalledFunction - Return the function called, or null if this is an
1056 /// indirect function invocation.
1058 Function *getCalledFunction() const {
1059 return dyn_cast<Function>(Op<-1>());
1062 /// getCalledValue - Get a pointer to the function that is invoked by this
1064 const Value *getCalledValue() const { return Op<-1>(); }
1065 Value *getCalledValue() { return Op<-1>(); }
1067 /// setCalledFunction - Set the function called.
1068 void setCalledFunction(Value* Fn) {
1072 /// isInlineAsm - Check if this call is an inline asm statement.
1073 bool isInlineAsm() const {
1074 return isa<InlineAsm>(Op<-1>());
1077 // Methods for support type inquiry through isa, cast, and dyn_cast:
1078 static inline bool classof(const CallInst *) { return true; }
1079 static inline bool classof(const Instruction *I) {
1080 return I->getOpcode() == Instruction::Call;
1082 static inline bool classof(const Value *V) {
1083 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1086 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1087 // method so that subclasses cannot accidentally use it.
1088 void setInstructionSubclassData(unsigned short D) {
1089 Instruction::setInstructionSubclassData(D);
1094 struct OperandTraits<CallInst> : public VariadicOperandTraits<CallInst, 1> {
1097 template<typename RandomAccessIterator>
1098 CallInst::CallInst(Value *Func,
1099 RandomAccessIterator ArgBegin, RandomAccessIterator ArgEnd,
1100 const Twine &NameStr, BasicBlock *InsertAtEnd)
1101 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1102 ->getElementType())->getReturnType(),
1104 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1105 unsigned(ArgEnd - ArgBegin + 1), InsertAtEnd) {
1106 init(Func, ArgBegin, ArgEnd, NameStr,
1107 typename std::iterator_traits<RandomAccessIterator>
1108 ::iterator_category());
1111 template<typename RandomAccessIterator>
1112 CallInst::CallInst(Value *Func,
1113 RandomAccessIterator ArgBegin, RandomAccessIterator ArgEnd,
1114 const Twine &NameStr, Instruction *InsertBefore)
1115 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1116 ->getElementType())->getReturnType(),
1118 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1119 unsigned(ArgEnd - ArgBegin + 1), InsertBefore) {
1120 init(Func, ArgBegin, ArgEnd, NameStr,
1121 typename std::iterator_traits<RandomAccessIterator>
1122 ::iterator_category());
1126 // Note: if you get compile errors about private methods then
1127 // please update your code to use the high-level operand
1128 // interfaces. See line 943 above.
1129 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1131 //===----------------------------------------------------------------------===//
1133 //===----------------------------------------------------------------------===//
1135 /// SelectInst - This class represents the LLVM 'select' instruction.
1137 class SelectInst : public Instruction {
1138 void init(Value *C, Value *S1, Value *S2) {
1139 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1145 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1146 Instruction *InsertBefore)
1147 : Instruction(S1->getType(), Instruction::Select,
1148 &Op<0>(), 3, InsertBefore) {
1152 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1153 BasicBlock *InsertAtEnd)
1154 : Instruction(S1->getType(), Instruction::Select,
1155 &Op<0>(), 3, InsertAtEnd) {
1160 virtual SelectInst *clone_impl() const;
1162 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1163 const Twine &NameStr = "",
1164 Instruction *InsertBefore = 0) {
1165 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1167 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1168 const Twine &NameStr,
1169 BasicBlock *InsertAtEnd) {
1170 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1173 const Value *getCondition() const { return Op<0>(); }
1174 const Value *getTrueValue() const { return Op<1>(); }
1175 const Value *getFalseValue() const { return Op<2>(); }
1176 Value *getCondition() { return Op<0>(); }
1177 Value *getTrueValue() { return Op<1>(); }
1178 Value *getFalseValue() { return Op<2>(); }
1180 /// areInvalidOperands - Return a string if the specified operands are invalid
1181 /// for a select operation, otherwise return null.
1182 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1184 /// Transparently provide more efficient getOperand methods.
1185 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1187 OtherOps getOpcode() const {
1188 return static_cast<OtherOps>(Instruction::getOpcode());
1191 // Methods for support type inquiry through isa, cast, and dyn_cast:
1192 static inline bool classof(const SelectInst *) { return true; }
1193 static inline bool classof(const Instruction *I) {
1194 return I->getOpcode() == Instruction::Select;
1196 static inline bool classof(const Value *V) {
1197 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1202 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<SelectInst, 3> {
1205 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1207 //===----------------------------------------------------------------------===//
1209 //===----------------------------------------------------------------------===//
1211 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1212 /// an argument of the specified type given a va_list and increments that list
1214 class VAArgInst : public UnaryInstruction {
1216 virtual VAArgInst *clone_impl() const;
1219 VAArgInst(Value *List, const Type *Ty, const Twine &NameStr = "",
1220 Instruction *InsertBefore = 0)
1221 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1224 VAArgInst(Value *List, const Type *Ty, const Twine &NameStr,
1225 BasicBlock *InsertAtEnd)
1226 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1230 Value *getPointerOperand() { return getOperand(0); }
1231 const Value *getPointerOperand() const { return getOperand(0); }
1232 static unsigned getPointerOperandIndex() { return 0U; }
1234 // Methods for support type inquiry through isa, cast, and dyn_cast:
1235 static inline bool classof(const VAArgInst *) { return true; }
1236 static inline bool classof(const Instruction *I) {
1237 return I->getOpcode() == VAArg;
1239 static inline bool classof(const Value *V) {
1240 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1244 //===----------------------------------------------------------------------===//
1245 // ExtractElementInst Class
1246 //===----------------------------------------------------------------------===//
1248 /// ExtractElementInst - This instruction extracts a single (scalar)
1249 /// element from a VectorType value
1251 class ExtractElementInst : public Instruction {
1252 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1253 Instruction *InsertBefore = 0);
1254 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1255 BasicBlock *InsertAtEnd);
1257 virtual ExtractElementInst *clone_impl() const;
1260 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1261 const Twine &NameStr = "",
1262 Instruction *InsertBefore = 0) {
1263 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1265 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1266 const Twine &NameStr,
1267 BasicBlock *InsertAtEnd) {
1268 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1271 /// isValidOperands - Return true if an extractelement instruction can be
1272 /// formed with the specified operands.
1273 static bool isValidOperands(const Value *Vec, const Value *Idx);
1275 Value *getVectorOperand() { return Op<0>(); }
1276 Value *getIndexOperand() { return Op<1>(); }
1277 const Value *getVectorOperand() const { return Op<0>(); }
1278 const Value *getIndexOperand() const { return Op<1>(); }
1280 const VectorType *getVectorOperandType() const {
1281 return reinterpret_cast<const VectorType*>(getVectorOperand()->getType());
1285 /// Transparently provide more efficient getOperand methods.
1286 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1288 // Methods for support type inquiry through isa, cast, and dyn_cast:
1289 static inline bool classof(const ExtractElementInst *) { return true; }
1290 static inline bool classof(const Instruction *I) {
1291 return I->getOpcode() == Instruction::ExtractElement;
1293 static inline bool classof(const Value *V) {
1294 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1299 struct OperandTraits<ExtractElementInst> :
1300 public FixedNumOperandTraits<ExtractElementInst, 2> {
1303 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1305 //===----------------------------------------------------------------------===//
1306 // InsertElementInst Class
1307 //===----------------------------------------------------------------------===//
1309 /// InsertElementInst - This instruction inserts a single (scalar)
1310 /// element into a VectorType value
1312 class InsertElementInst : public Instruction {
1313 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1314 const Twine &NameStr = "",
1315 Instruction *InsertBefore = 0);
1316 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1317 const Twine &NameStr, BasicBlock *InsertAtEnd);
1319 virtual InsertElementInst *clone_impl() const;
1322 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1323 const Twine &NameStr = "",
1324 Instruction *InsertBefore = 0) {
1325 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1327 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1328 const Twine &NameStr,
1329 BasicBlock *InsertAtEnd) {
1330 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1333 /// isValidOperands - Return true if an insertelement instruction can be
1334 /// formed with the specified operands.
1335 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1338 /// getType - Overload to return most specific vector type.
1340 const VectorType *getType() const {
1341 return reinterpret_cast<const VectorType*>(Instruction::getType());
1344 /// Transparently provide more efficient getOperand methods.
1345 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1347 // Methods for support type inquiry through isa, cast, and dyn_cast:
1348 static inline bool classof(const InsertElementInst *) { return true; }
1349 static inline bool classof(const Instruction *I) {
1350 return I->getOpcode() == Instruction::InsertElement;
1352 static inline bool classof(const Value *V) {
1353 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1358 struct OperandTraits<InsertElementInst> :
1359 public FixedNumOperandTraits<InsertElementInst, 3> {
1362 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1364 //===----------------------------------------------------------------------===//
1365 // ShuffleVectorInst Class
1366 //===----------------------------------------------------------------------===//
1368 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1371 class ShuffleVectorInst : public Instruction {
1373 virtual ShuffleVectorInst *clone_impl() const;
1376 // allocate space for exactly three operands
1377 void *operator new(size_t s) {
1378 return User::operator new(s, 3);
1380 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1381 const Twine &NameStr = "",
1382 Instruction *InsertBefor = 0);
1383 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1384 const Twine &NameStr, BasicBlock *InsertAtEnd);
1386 /// isValidOperands - Return true if a shufflevector instruction can be
1387 /// formed with the specified operands.
1388 static bool isValidOperands(const Value *V1, const Value *V2,
1391 /// getType - Overload to return most specific vector type.
1393 const VectorType *getType() const {
1394 return reinterpret_cast<const VectorType*>(Instruction::getType());
1397 /// Transparently provide more efficient getOperand methods.
1398 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1400 /// getMaskValue - Return the index from the shuffle mask for the specified
1401 /// output result. This is either -1 if the element is undef or a number less
1402 /// than 2*numelements.
1403 int getMaskValue(unsigned i) const;
1405 // Methods for support type inquiry through isa, cast, and dyn_cast:
1406 static inline bool classof(const ShuffleVectorInst *) { return true; }
1407 static inline bool classof(const Instruction *I) {
1408 return I->getOpcode() == Instruction::ShuffleVector;
1410 static inline bool classof(const Value *V) {
1411 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1416 struct OperandTraits<ShuffleVectorInst> :
1417 public FixedNumOperandTraits<ShuffleVectorInst, 3> {
1420 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1422 //===----------------------------------------------------------------------===//
1423 // ExtractValueInst Class
1424 //===----------------------------------------------------------------------===//
1426 /// ExtractValueInst - This instruction extracts a struct member or array
1427 /// element value from an aggregate value.
1429 class ExtractValueInst : public UnaryInstruction {
1430 SmallVector<unsigned, 4> Indices;
1432 ExtractValueInst(const ExtractValueInst &EVI);
1433 void init(const unsigned *Idx, unsigned NumIdx,
1434 const Twine &NameStr);
1435 void init(unsigned Idx, const Twine &NameStr);
1437 template<typename RandomAccessIterator>
1438 void init(RandomAccessIterator IdxBegin,
1439 RandomAccessIterator IdxEnd,
1440 const Twine &NameStr,
1441 // This argument ensures that we have an iterator we can
1442 // do arithmetic on in constant time
1443 std::random_access_iterator_tag) {
1444 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1446 // There's no fundamental reason why we require at least one index
1447 // (other than weirdness with &*IdxBegin being invalid; see
1448 // getelementptr's init routine for example). But there's no
1449 // present need to support it.
1450 assert(NumIdx > 0 && "ExtractValueInst must have at least one index");
1452 // This requires that the iterator points to contiguous memory.
1453 init(&*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1454 // we have to build an array here
1457 /// getIndexedType - Returns the type of the element that would be extracted
1458 /// with an extractvalue instruction with the specified parameters.
1460 /// Null is returned if the indices are invalid for the specified type.
1462 static const Type *getIndexedType(const Type *Agg,
1463 const unsigned *Idx, unsigned NumIdx);
1465 template<typename RandomAccessIterator>
1466 static const Type *getIndexedType(const Type *Ptr,
1467 RandomAccessIterator IdxBegin,
1468 RandomAccessIterator IdxEnd,
1469 // This argument ensures that we
1470 // have an iterator we can do
1471 // arithmetic on in constant time
1472 std::random_access_iterator_tag) {
1473 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1476 // This requires that the iterator points to contiguous memory.
1477 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
1479 return getIndexedType(Ptr, (const unsigned *)0, NumIdx);
1482 /// Constructors - Create a extractvalue instruction with a base aggregate
1483 /// value and a list of indices. The first ctor can optionally insert before
1484 /// an existing instruction, the second appends the new instruction to the
1485 /// specified BasicBlock.
1486 template<typename RandomAccessIterator>
1487 inline ExtractValueInst(Value *Agg,
1488 RandomAccessIterator IdxBegin,
1489 RandomAccessIterator IdxEnd,
1490 const Twine &NameStr,
1491 Instruction *InsertBefore);
1492 template<typename RandomAccessIterator>
1493 inline ExtractValueInst(Value *Agg,
1494 RandomAccessIterator IdxBegin,
1495 RandomAccessIterator IdxEnd,
1496 const Twine &NameStr, BasicBlock *InsertAtEnd);
1498 // allocate space for exactly one operand
1499 void *operator new(size_t s) {
1500 return User::operator new(s, 1);
1503 virtual ExtractValueInst *clone_impl() const;
1506 template<typename RandomAccessIterator>
1507 static ExtractValueInst *Create(Value *Agg,
1508 RandomAccessIterator IdxBegin,
1509 RandomAccessIterator IdxEnd,
1510 const Twine &NameStr = "",
1511 Instruction *InsertBefore = 0) {
1513 ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertBefore);
1515 template<typename RandomAccessIterator>
1516 static ExtractValueInst *Create(Value *Agg,
1517 RandomAccessIterator IdxBegin,
1518 RandomAccessIterator IdxEnd,
1519 const Twine &NameStr,
1520 BasicBlock *InsertAtEnd) {
1521 return new ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertAtEnd);
1524 /// Constructors - These two creators are convenience methods because one
1525 /// index extractvalue instructions are much more common than those with
1527 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1528 const Twine &NameStr = "",
1529 Instruction *InsertBefore = 0) {
1530 unsigned Idxs[1] = { Idx };
1531 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertBefore);
1533 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1534 const Twine &NameStr,
1535 BasicBlock *InsertAtEnd) {
1536 unsigned Idxs[1] = { Idx };
1537 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertAtEnd);
1540 /// getIndexedType - Returns the type of the element that would be extracted
1541 /// with an extractvalue instruction with the specified parameters.
1543 /// Null is returned if the indices are invalid for the specified type.
1545 template<typename RandomAccessIterator>
1546 static const Type *getIndexedType(const Type *Ptr,
1547 RandomAccessIterator IdxBegin,
1548 RandomAccessIterator IdxEnd) {
1549 return getIndexedType(Ptr, IdxBegin, IdxEnd,
1550 typename std::iterator_traits<RandomAccessIterator>::
1551 iterator_category());
1553 static const Type *getIndexedType(const Type *Ptr, unsigned Idx);
1555 typedef const unsigned* idx_iterator;
1556 inline idx_iterator idx_begin() const { return Indices.begin(); }
1557 inline idx_iterator idx_end() const { return Indices.end(); }
1559 Value *getAggregateOperand() {
1560 return getOperand(0);
1562 const Value *getAggregateOperand() const {
1563 return getOperand(0);
1565 static unsigned getAggregateOperandIndex() {
1566 return 0U; // get index for modifying correct operand
1569 unsigned getNumIndices() const { // Note: always non-negative
1570 return (unsigned)Indices.size();
1573 bool hasIndices() const {
1577 // Methods for support type inquiry through isa, cast, and dyn_cast:
1578 static inline bool classof(const ExtractValueInst *) { return true; }
1579 static inline bool classof(const Instruction *I) {
1580 return I->getOpcode() == Instruction::ExtractValue;
1582 static inline bool classof(const Value *V) {
1583 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1587 template<typename RandomAccessIterator>
1588 ExtractValueInst::ExtractValueInst(Value *Agg,
1589 RandomAccessIterator IdxBegin,
1590 RandomAccessIterator IdxEnd,
1591 const Twine &NameStr,
1592 Instruction *InsertBefore)
1593 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1595 ExtractValue, Agg, InsertBefore) {
1596 init(IdxBegin, IdxEnd, NameStr,
1597 typename std::iterator_traits<RandomAccessIterator>
1598 ::iterator_category());
1600 template<typename RandomAccessIterator>
1601 ExtractValueInst::ExtractValueInst(Value *Agg,
1602 RandomAccessIterator IdxBegin,
1603 RandomAccessIterator IdxEnd,
1604 const Twine &NameStr,
1605 BasicBlock *InsertAtEnd)
1606 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1608 ExtractValue, Agg, InsertAtEnd) {
1609 init(IdxBegin, IdxEnd, NameStr,
1610 typename std::iterator_traits<RandomAccessIterator>
1611 ::iterator_category());
1615 //===----------------------------------------------------------------------===//
1616 // InsertValueInst Class
1617 //===----------------------------------------------------------------------===//
1619 /// InsertValueInst - This instruction inserts a struct field of array element
1620 /// value into an aggregate value.
1622 class InsertValueInst : public Instruction {
1623 SmallVector<unsigned, 4> Indices;
1625 void *operator new(size_t, unsigned); // Do not implement
1626 InsertValueInst(const InsertValueInst &IVI);
1627 void init(Value *Agg, Value *Val, const unsigned *Idx, unsigned NumIdx,
1628 const Twine &NameStr);
1629 void init(Value *Agg, Value *Val, unsigned Idx, const Twine &NameStr);
1631 template<typename RandomAccessIterator>
1632 void init(Value *Agg, Value *Val,
1633 RandomAccessIterator IdxBegin, RandomAccessIterator IdxEnd,
1634 const Twine &NameStr,
1635 // This argument ensures that we have an iterator we can
1636 // do arithmetic on in constant time
1637 std::random_access_iterator_tag) {
1638 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1640 // There's no fundamental reason why we require at least one index
1641 // (other than weirdness with &*IdxBegin being invalid; see
1642 // getelementptr's init routine for example). But there's no
1643 // present need to support it.
1644 assert(NumIdx > 0 && "InsertValueInst must have at least one index");
1646 // This requires that the iterator points to contiguous memory.
1647 init(Agg, Val, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1648 // we have to build an array here
1651 /// Constructors - Create a insertvalue instruction with a base aggregate
1652 /// value, a value to insert, and a list of indices. The first ctor can
1653 /// optionally insert before an existing instruction, the second appends
1654 /// the new instruction to the specified BasicBlock.
1655 template<typename RandomAccessIterator>
1656 inline InsertValueInst(Value *Agg, Value *Val,
1657 RandomAccessIterator IdxBegin,
1658 RandomAccessIterator IdxEnd,
1659 const Twine &NameStr,
1660 Instruction *InsertBefore);
1661 template<typename RandomAccessIterator>
1662 inline InsertValueInst(Value *Agg, Value *Val,
1663 RandomAccessIterator IdxBegin,
1664 RandomAccessIterator IdxEnd,
1665 const Twine &NameStr, BasicBlock *InsertAtEnd);
1667 /// Constructors - These two constructors are convenience methods because one
1668 /// and two index insertvalue instructions are so common.
1669 InsertValueInst(Value *Agg, Value *Val,
1670 unsigned Idx, const Twine &NameStr = "",
1671 Instruction *InsertBefore = 0);
1672 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1673 const Twine &NameStr, BasicBlock *InsertAtEnd);
1675 virtual InsertValueInst *clone_impl() const;
1677 // allocate space for exactly two operands
1678 void *operator new(size_t s) {
1679 return User::operator new(s, 2);
1682 template<typename RandomAccessIterator>
1683 static InsertValueInst *Create(Value *Agg, Value *Val,
1684 RandomAccessIterator IdxBegin,
1685 RandomAccessIterator IdxEnd,
1686 const Twine &NameStr = "",
1687 Instruction *InsertBefore = 0) {
1688 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1689 NameStr, InsertBefore);
1691 template<typename RandomAccessIterator>
1692 static InsertValueInst *Create(Value *Agg, Value *Val,
1693 RandomAccessIterator IdxBegin,
1694 RandomAccessIterator IdxEnd,
1695 const Twine &NameStr,
1696 BasicBlock *InsertAtEnd) {
1697 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1698 NameStr, InsertAtEnd);
1701 /// Constructors - These two creators are convenience methods because one
1702 /// index insertvalue instructions are much more common than those with
1704 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1705 const Twine &NameStr = "",
1706 Instruction *InsertBefore = 0) {
1707 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertBefore);
1709 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1710 const Twine &NameStr,
1711 BasicBlock *InsertAtEnd) {
1712 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertAtEnd);
1715 /// Transparently provide more efficient getOperand methods.
1716 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1718 typedef const unsigned* idx_iterator;
1719 inline idx_iterator idx_begin() const { return Indices.begin(); }
1720 inline idx_iterator idx_end() const { return Indices.end(); }
1722 Value *getAggregateOperand() {
1723 return getOperand(0);
1725 const Value *getAggregateOperand() const {
1726 return getOperand(0);
1728 static unsigned getAggregateOperandIndex() {
1729 return 0U; // get index for modifying correct operand
1732 Value *getInsertedValueOperand() {
1733 return getOperand(1);
1735 const Value *getInsertedValueOperand() const {
1736 return getOperand(1);
1738 static unsigned getInsertedValueOperandIndex() {
1739 return 1U; // get index for modifying correct operand
1742 unsigned getNumIndices() const { // Note: always non-negative
1743 return (unsigned)Indices.size();
1746 bool hasIndices() const {
1750 // Methods for support type inquiry through isa, cast, and dyn_cast:
1751 static inline bool classof(const InsertValueInst *) { return true; }
1752 static inline bool classof(const Instruction *I) {
1753 return I->getOpcode() == Instruction::InsertValue;
1755 static inline bool classof(const Value *V) {
1756 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1761 struct OperandTraits<InsertValueInst> :
1762 public FixedNumOperandTraits<InsertValueInst, 2> {
1765 template<typename RandomAccessIterator>
1766 InsertValueInst::InsertValueInst(Value *Agg,
1768 RandomAccessIterator IdxBegin,
1769 RandomAccessIterator IdxEnd,
1770 const Twine &NameStr,
1771 Instruction *InsertBefore)
1772 : Instruction(Agg->getType(), InsertValue,
1773 OperandTraits<InsertValueInst>::op_begin(this),
1775 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1776 typename std::iterator_traits<RandomAccessIterator>
1777 ::iterator_category());
1779 template<typename RandomAccessIterator>
1780 InsertValueInst::InsertValueInst(Value *Agg,
1782 RandomAccessIterator IdxBegin,
1783 RandomAccessIterator IdxEnd,
1784 const Twine &NameStr,
1785 BasicBlock *InsertAtEnd)
1786 : Instruction(Agg->getType(), InsertValue,
1787 OperandTraits<InsertValueInst>::op_begin(this),
1789 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1790 typename std::iterator_traits<RandomAccessIterator>
1791 ::iterator_category());
1794 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1796 //===----------------------------------------------------------------------===//
1798 //===----------------------------------------------------------------------===//
1800 // PHINode - The PHINode class is used to represent the magical mystical PHI
1801 // node, that can not exist in nature, but can be synthesized in a computer
1802 // scientist's overactive imagination.
1804 class PHINode : public Instruction {
1805 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1806 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1807 /// the number actually in use.
1808 unsigned ReservedSpace;
1809 PHINode(const PHINode &PN);
1810 // allocate space for exactly zero operands
1811 void *operator new(size_t s) {
1812 return User::operator new(s, 0);
1814 explicit PHINode(const Type *Ty, unsigned NumReservedValues,
1815 const Twine &NameStr = "", Instruction *InsertBefore = 0)
1816 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1817 ReservedSpace(NumReservedValues * 2) {
1819 OperandList = allocHungoffUses(ReservedSpace);
1822 PHINode(const Type *Ty, unsigned NumReservedValues, const Twine &NameStr,
1823 BasicBlock *InsertAtEnd)
1824 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1825 ReservedSpace(NumReservedValues * 2) {
1827 OperandList = allocHungoffUses(ReservedSpace);
1830 virtual PHINode *clone_impl() const;
1832 static PHINode *Create(const Type *Ty, unsigned NumReservedValues,
1833 const Twine &NameStr = "",
1834 Instruction *InsertBefore = 0) {
1835 return new PHINode(Ty, NumReservedValues, NameStr, InsertBefore);
1837 static PHINode *Create(const Type *Ty, unsigned NumReservedValues,
1838 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1839 return new PHINode(Ty, NumReservedValues, NameStr, InsertAtEnd);
1843 /// Provide fast operand accessors
1844 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1846 /// getNumIncomingValues - Return the number of incoming edges
1848 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1850 /// getIncomingValue - Return incoming value number x
1852 Value *getIncomingValue(unsigned i) const {
1853 assert(i*2 < getNumOperands() && "Invalid value number!");
1854 return getOperand(i*2);
1856 void setIncomingValue(unsigned i, Value *V) {
1857 assert(i*2 < getNumOperands() && "Invalid value number!");
1860 static unsigned getOperandNumForIncomingValue(unsigned i) {
1863 static unsigned getIncomingValueNumForOperand(unsigned i) {
1864 assert(i % 2 == 0 && "Invalid incoming-value operand index!");
1868 /// getIncomingBlock - Return incoming basic block number @p i.
1870 BasicBlock *getIncomingBlock(unsigned i) const {
1871 return cast<BasicBlock>(getOperand(i*2+1));
1874 /// getIncomingBlock - Return incoming basic block corresponding
1875 /// to an operand of the PHI.
1877 BasicBlock *getIncomingBlock(const Use &U) const {
1878 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
1879 return cast<BasicBlock>((&U + 1)->get());
1882 /// getIncomingBlock - Return incoming basic block corresponding
1883 /// to value use iterator.
1885 template <typename U>
1886 BasicBlock *getIncomingBlock(value_use_iterator<U> I) const {
1887 return getIncomingBlock(I.getUse());
1891 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1892 setOperand(i*2+1, (Value*)BB);
1894 static unsigned getOperandNumForIncomingBlock(unsigned i) {
1897 static unsigned getIncomingBlockNumForOperand(unsigned i) {
1898 assert(i % 2 == 1 && "Invalid incoming-block operand index!");
1902 /// addIncoming - Add an incoming value to the end of the PHI list
1904 void addIncoming(Value *V, BasicBlock *BB) {
1905 assert(V && "PHI node got a null value!");
1906 assert(BB && "PHI node got a null basic block!");
1907 assert(getType() == V->getType() &&
1908 "All operands to PHI node must be the same type as the PHI node!");
1909 unsigned OpNo = NumOperands;
1910 if (OpNo+2 > ReservedSpace)
1911 resizeOperands(0); // Get more space!
1912 // Initialize some new operands.
1913 NumOperands = OpNo+2;
1914 OperandList[OpNo] = V;
1915 OperandList[OpNo+1] = (Value*)BB;
1918 /// removeIncomingValue - Remove an incoming value. This is useful if a
1919 /// predecessor basic block is deleted. The value removed is returned.
1921 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1922 /// is true), the PHI node is destroyed and any uses of it are replaced with
1923 /// dummy values. The only time there should be zero incoming values to a PHI
1924 /// node is when the block is dead, so this strategy is sound.
1926 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1928 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
1929 int Idx = getBasicBlockIndex(BB);
1930 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1931 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1934 /// getBasicBlockIndex - Return the first index of the specified basic
1935 /// block in the value list for this PHI. Returns -1 if no instance.
1937 int getBasicBlockIndex(const BasicBlock *BB) const {
1938 Use *OL = OperandList;
1939 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1940 if (OL[i+1].get() == (const Value*)BB) return i/2;
1944 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1945 return getIncomingValue(getBasicBlockIndex(BB));
1948 /// hasConstantValue - If the specified PHI node always merges together the
1949 /// same value, return the value, otherwise return null.
1950 Value *hasConstantValue() const;
1952 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1953 static inline bool classof(const PHINode *) { return true; }
1954 static inline bool classof(const Instruction *I) {
1955 return I->getOpcode() == Instruction::PHI;
1957 static inline bool classof(const Value *V) {
1958 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1961 void resizeOperands(unsigned NumOperands);
1965 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
1968 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
1971 //===----------------------------------------------------------------------===//
1973 //===----------------------------------------------------------------------===//
1975 //===---------------------------------------------------------------------------
1976 /// ReturnInst - Return a value (possibly void), from a function. Execution
1977 /// does not continue in this function any longer.
1979 class ReturnInst : public TerminatorInst {
1980 ReturnInst(const ReturnInst &RI);
1983 // ReturnInst constructors:
1984 // ReturnInst() - 'ret void' instruction
1985 // ReturnInst( null) - 'ret void' instruction
1986 // ReturnInst(Value* X) - 'ret X' instruction
1987 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
1988 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
1989 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
1990 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
1992 // NOTE: If the Value* passed is of type void then the constructor behaves as
1993 // if it was passed NULL.
1994 explicit ReturnInst(LLVMContext &C, Value *retVal = 0,
1995 Instruction *InsertBefore = 0);
1996 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
1997 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
1999 virtual ReturnInst *clone_impl() const;
2001 static ReturnInst* Create(LLVMContext &C, Value *retVal = 0,
2002 Instruction *InsertBefore = 0) {
2003 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2005 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2006 BasicBlock *InsertAtEnd) {
2007 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2009 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2010 return new(0) ReturnInst(C, InsertAtEnd);
2012 virtual ~ReturnInst();
2014 /// Provide fast operand accessors
2015 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2017 /// Convenience accessor. Returns null if there is no return value.
2018 Value *getReturnValue() const {
2019 return getNumOperands() != 0 ? getOperand(0) : 0;
2022 unsigned getNumSuccessors() const { return 0; }
2024 // Methods for support type inquiry through isa, cast, and dyn_cast:
2025 static inline bool classof(const ReturnInst *) { return true; }
2026 static inline bool classof(const Instruction *I) {
2027 return (I->getOpcode() == Instruction::Ret);
2029 static inline bool classof(const Value *V) {
2030 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2033 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2034 virtual unsigned getNumSuccessorsV() const;
2035 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2039 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<ReturnInst> {
2042 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2044 //===----------------------------------------------------------------------===//
2046 //===----------------------------------------------------------------------===//
2048 //===---------------------------------------------------------------------------
2049 /// BranchInst - Conditional or Unconditional Branch instruction.
2051 class BranchInst : public TerminatorInst {
2052 /// Ops list - Branches are strange. The operands are ordered:
2053 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2054 /// they don't have to check for cond/uncond branchness. These are mostly
2055 /// accessed relative from op_end().
2056 BranchInst(const BranchInst &BI);
2058 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2059 // BranchInst(BB *B) - 'br B'
2060 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2061 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2062 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2063 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2064 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2065 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2066 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2067 Instruction *InsertBefore = 0);
2068 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2069 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2070 BasicBlock *InsertAtEnd);
2072 virtual BranchInst *clone_impl() const;
2074 static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2075 return new(1) BranchInst(IfTrue, InsertBefore);
2077 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2078 Value *Cond, Instruction *InsertBefore = 0) {
2079 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2081 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2082 return new(1) BranchInst(IfTrue, InsertAtEnd);
2084 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2085 Value *Cond, BasicBlock *InsertAtEnd) {
2086 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2089 /// Transparently provide more efficient getOperand methods.
2090 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2092 bool isUnconditional() const { return getNumOperands() == 1; }
2093 bool isConditional() const { return getNumOperands() == 3; }
2095 Value *getCondition() const {
2096 assert(isConditional() && "Cannot get condition of an uncond branch!");
2100 void setCondition(Value *V) {
2101 assert(isConditional() && "Cannot set condition of unconditional branch!");
2105 unsigned getNumSuccessors() const { return 1+isConditional(); }
2107 BasicBlock *getSuccessor(unsigned i) const {
2108 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2109 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2112 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2113 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2114 *(&Op<-1>() - idx) = (Value*)NewSucc;
2117 // Methods for support type inquiry through isa, cast, and dyn_cast:
2118 static inline bool classof(const BranchInst *) { return true; }
2119 static inline bool classof(const Instruction *I) {
2120 return (I->getOpcode() == Instruction::Br);
2122 static inline bool classof(const Value *V) {
2123 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2126 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2127 virtual unsigned getNumSuccessorsV() const;
2128 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2132 struct OperandTraits<BranchInst> : public VariadicOperandTraits<BranchInst, 1> {
2135 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2137 //===----------------------------------------------------------------------===//
2139 //===----------------------------------------------------------------------===//
2141 //===---------------------------------------------------------------------------
2142 /// SwitchInst - Multiway switch
2144 class SwitchInst : public TerminatorInst {
2145 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2146 unsigned ReservedSpace;
2147 // Operand[0] = Value to switch on
2148 // Operand[1] = Default basic block destination
2149 // Operand[2n ] = Value to match
2150 // Operand[2n+1] = BasicBlock to go to on match
2151 SwitchInst(const SwitchInst &SI);
2152 void init(Value *Value, BasicBlock *Default, unsigned NumReserved);
2153 void resizeOperands(unsigned No);
2154 // allocate space for exactly zero operands
2155 void *operator new(size_t s) {
2156 return User::operator new(s, 0);
2158 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2159 /// switch on and a default destination. The number of additional cases can
2160 /// be specified here to make memory allocation more efficient. This
2161 /// constructor can also autoinsert before another instruction.
2162 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2163 Instruction *InsertBefore);
2165 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2166 /// switch on and a default destination. The number of additional cases can
2167 /// be specified here to make memory allocation more efficient. This
2168 /// constructor also autoinserts at the end of the specified BasicBlock.
2169 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2170 BasicBlock *InsertAtEnd);
2172 virtual SwitchInst *clone_impl() const;
2174 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2175 unsigned NumCases, Instruction *InsertBefore = 0) {
2176 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2178 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2179 unsigned NumCases, BasicBlock *InsertAtEnd) {
2180 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2184 /// Provide fast operand accessors
2185 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2187 // Accessor Methods for Switch stmt
2188 Value *getCondition() const { return getOperand(0); }
2189 void setCondition(Value *V) { setOperand(0, V); }
2191 BasicBlock *getDefaultDest() const {
2192 return cast<BasicBlock>(getOperand(1));
2195 /// getNumCases - return the number of 'cases' in this switch instruction.
2196 /// Note that case #0 is always the default case.
2197 unsigned getNumCases() const {
2198 return getNumOperands()/2;
2201 /// getCaseValue - Return the specified case value. Note that case #0, the
2202 /// default destination, does not have a case value.
2203 ConstantInt *getCaseValue(unsigned i) {
2204 assert(i && i < getNumCases() && "Illegal case value to get!");
2205 return getSuccessorValue(i);
2208 /// getCaseValue - Return the specified case value. Note that case #0, the
2209 /// default destination, does not have a case value.
2210 const ConstantInt *getCaseValue(unsigned i) const {
2211 assert(i && i < getNumCases() && "Illegal case value to get!");
2212 return getSuccessorValue(i);
2215 /// findCaseValue - Search all of the case values for the specified constant.
2216 /// If it is explicitly handled, return the case number of it, otherwise
2217 /// return 0 to indicate that it is handled by the default handler.
2218 unsigned findCaseValue(const ConstantInt *C) const {
2219 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
2220 if (getCaseValue(i) == C)
2225 /// findCaseDest - Finds the unique case value for a given successor. Returns
2226 /// null if the successor is not found, not unique, or is the default case.
2227 ConstantInt *findCaseDest(BasicBlock *BB) {
2228 if (BB == getDefaultDest()) return NULL;
2230 ConstantInt *CI = NULL;
2231 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
2232 if (getSuccessor(i) == BB) {
2233 if (CI) return NULL; // Multiple cases lead to BB.
2234 else CI = getCaseValue(i);
2240 /// addCase - Add an entry to the switch instruction...
2242 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2244 /// removeCase - This method removes the specified successor from the switch
2245 /// instruction. Note that this cannot be used to remove the default
2246 /// destination (successor #0). Also note that this operation may reorder the
2247 /// remaining cases at index idx and above.
2249 void removeCase(unsigned idx);
2251 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2252 BasicBlock *getSuccessor(unsigned idx) const {
2253 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2254 return cast<BasicBlock>(getOperand(idx*2+1));
2256 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2257 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2258 setOperand(idx*2+1, (Value*)NewSucc);
2261 // getSuccessorValue - Return the value associated with the specified
2263 ConstantInt *getSuccessorValue(unsigned idx) const {
2264 assert(idx < getNumSuccessors() && "Successor # out of range!");
2265 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
2268 // Methods for support type inquiry through isa, cast, and dyn_cast:
2269 static inline bool classof(const SwitchInst *) { return true; }
2270 static inline bool classof(const Instruction *I) {
2271 return I->getOpcode() == Instruction::Switch;
2273 static inline bool classof(const Value *V) {
2274 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2277 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2278 virtual unsigned getNumSuccessorsV() const;
2279 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2283 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2286 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2289 //===----------------------------------------------------------------------===//
2290 // IndirectBrInst Class
2291 //===----------------------------------------------------------------------===//
2293 //===---------------------------------------------------------------------------
2294 /// IndirectBrInst - Indirect Branch Instruction.
2296 class IndirectBrInst : public TerminatorInst {
2297 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2298 unsigned ReservedSpace;
2299 // Operand[0] = Value to switch on
2300 // Operand[1] = Default basic block destination
2301 // Operand[2n ] = Value to match
2302 // Operand[2n+1] = BasicBlock to go to on match
2303 IndirectBrInst(const IndirectBrInst &IBI);
2304 void init(Value *Address, unsigned NumDests);
2305 void resizeOperands(unsigned No);
2306 // allocate space for exactly zero operands
2307 void *operator new(size_t s) {
2308 return User::operator new(s, 0);
2310 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2311 /// Address to jump to. The number of expected destinations can be specified
2312 /// here to make memory allocation more efficient. This constructor can also
2313 /// autoinsert before another instruction.
2314 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
2316 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2317 /// Address to jump to. The number of expected destinations can be specified
2318 /// here to make memory allocation more efficient. This constructor also
2319 /// autoinserts at the end of the specified BasicBlock.
2320 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
2322 virtual IndirectBrInst *clone_impl() const;
2324 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2325 Instruction *InsertBefore = 0) {
2326 return new IndirectBrInst(Address, NumDests, InsertBefore);
2328 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2329 BasicBlock *InsertAtEnd) {
2330 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
2334 /// Provide fast operand accessors.
2335 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2337 // Accessor Methods for IndirectBrInst instruction.
2338 Value *getAddress() { return getOperand(0); }
2339 const Value *getAddress() const { return getOperand(0); }
2340 void setAddress(Value *V) { setOperand(0, V); }
2343 /// getNumDestinations - return the number of possible destinations in this
2344 /// indirectbr instruction.
2345 unsigned getNumDestinations() const { return getNumOperands()-1; }
2347 /// getDestination - Return the specified destination.
2348 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
2349 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
2351 /// addDestination - Add a destination.
2353 void addDestination(BasicBlock *Dest);
2355 /// removeDestination - This method removes the specified successor from the
2356 /// indirectbr instruction.
2357 void removeDestination(unsigned i);
2359 unsigned getNumSuccessors() const { return getNumOperands()-1; }
2360 BasicBlock *getSuccessor(unsigned i) const {
2361 return cast<BasicBlock>(getOperand(i+1));
2363 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
2364 setOperand(i+1, (Value*)NewSucc);
2367 // Methods for support type inquiry through isa, cast, and dyn_cast:
2368 static inline bool classof(const IndirectBrInst *) { return true; }
2369 static inline bool classof(const Instruction *I) {
2370 return I->getOpcode() == Instruction::IndirectBr;
2372 static inline bool classof(const Value *V) {
2373 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2376 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2377 virtual unsigned getNumSuccessorsV() const;
2378 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2382 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
2385 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
2388 //===----------------------------------------------------------------------===//
2390 //===----------------------------------------------------------------------===//
2392 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
2393 /// calling convention of the call.
2395 class InvokeInst : public TerminatorInst {
2396 AttrListPtr AttributeList;
2397 InvokeInst(const InvokeInst &BI);
2398 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
2399 Value* const *Args, unsigned NumArgs);
2401 template<typename RandomAccessIterator>
2402 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2403 RandomAccessIterator ArgBegin, RandomAccessIterator ArgEnd,
2404 const Twine &NameStr,
2405 // This argument ensures that we have an iterator we can
2406 // do arithmetic on in constant time
2407 std::random_access_iterator_tag) {
2408 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
2410 // This requires that the iterator points to contiguous memory.
2411 init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
2415 /// Construct an InvokeInst given a range of arguments.
2416 /// RandomAccessIterator must be a random-access iterator pointing to
2417 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2418 /// made for random-accessness but not for contiguous storage as
2419 /// that would incur runtime overhead.
2421 /// @brief Construct an InvokeInst from a range of arguments
2422 template<typename RandomAccessIterator>
2423 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2424 RandomAccessIterator ArgBegin, RandomAccessIterator ArgEnd,
2426 const Twine &NameStr, Instruction *InsertBefore);
2428 /// Construct an InvokeInst given a range of arguments.
2429 /// RandomAccessIterator must be a random-access iterator pointing to
2430 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2431 /// made for random-accessness but not for contiguous storage as
2432 /// that would incur runtime overhead.
2434 /// @brief Construct an InvokeInst from a range of arguments
2435 template<typename RandomAccessIterator>
2436 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2437 RandomAccessIterator ArgBegin, RandomAccessIterator ArgEnd,
2439 const Twine &NameStr, BasicBlock *InsertAtEnd);
2441 virtual InvokeInst *clone_impl() const;
2443 template<typename RandomAccessIterator>
2444 static InvokeInst *Create(Value *Func,
2445 BasicBlock *IfNormal, BasicBlock *IfException,
2446 RandomAccessIterator ArgBegin,
2447 RandomAccessIterator ArgEnd,
2448 const Twine &NameStr = "",
2449 Instruction *InsertBefore = 0) {
2450 unsigned Values(ArgEnd - ArgBegin + 3);
2451 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2452 Values, NameStr, InsertBefore);
2454 template<typename RandomAccessIterator>
2455 static InvokeInst *Create(Value *Func,
2456 BasicBlock *IfNormal, BasicBlock *IfException,
2457 RandomAccessIterator ArgBegin,
2458 RandomAccessIterator ArgEnd,
2459 const Twine &NameStr,
2460 BasicBlock *InsertAtEnd) {
2461 unsigned Values(ArgEnd - ArgBegin + 3);
2462 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2463 Values, NameStr, InsertAtEnd);
2466 /// Provide fast operand accessors
2467 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2469 /// getNumArgOperands - Return the number of invoke arguments.
2471 unsigned getNumArgOperands() const { return getNumOperands() - 3; }
2473 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
2475 Value *getArgOperand(unsigned i) const { return getOperand(i); }
2476 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
2478 /// getCallingConv/setCallingConv - Get or set the calling convention of this
2480 CallingConv::ID getCallingConv() const {
2481 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
2483 void setCallingConv(CallingConv::ID CC) {
2484 setInstructionSubclassData(static_cast<unsigned>(CC));
2487 /// getAttributes - Return the parameter attributes for this invoke.
2489 const AttrListPtr &getAttributes() const { return AttributeList; }
2491 /// setAttributes - Set the parameter attributes for this invoke.
2493 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
2495 /// addAttribute - adds the attribute to the list of attributes.
2496 void addAttribute(unsigned i, Attributes attr);
2498 /// removeAttribute - removes the attribute from the list of attributes.
2499 void removeAttribute(unsigned i, Attributes attr);
2501 /// @brief Determine whether the call or the callee has the given attribute.
2502 bool paramHasAttr(unsigned i, Attributes attr) const;
2504 /// @brief Extract the alignment for a call or parameter (0=unknown).
2505 unsigned getParamAlignment(unsigned i) const {
2506 return AttributeList.getParamAlignment(i);
2509 /// @brief Return true if the call should not be inlined.
2510 bool isNoInline() const { return paramHasAttr(~0, Attribute::NoInline); }
2511 void setIsNoInline(bool Value = true) {
2512 if (Value) addAttribute(~0, Attribute::NoInline);
2513 else removeAttribute(~0, Attribute::NoInline);
2516 /// @brief Determine if the call does not access memory.
2517 bool doesNotAccessMemory() const {
2518 return paramHasAttr(~0, Attribute::ReadNone);
2520 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
2521 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
2522 else removeAttribute(~0, Attribute::ReadNone);
2525 /// @brief Determine if the call does not access or only reads memory.
2526 bool onlyReadsMemory() const {
2527 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
2529 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
2530 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
2531 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
2534 /// @brief Determine if the call cannot return.
2535 bool doesNotReturn() const { return paramHasAttr(~0, Attribute::NoReturn); }
2536 void setDoesNotReturn(bool DoesNotReturn = true) {
2537 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
2538 else removeAttribute(~0, Attribute::NoReturn);
2541 /// @brief Determine if the call cannot unwind.
2542 bool doesNotThrow() const { return paramHasAttr(~0, Attribute::NoUnwind); }
2543 void setDoesNotThrow(bool DoesNotThrow = true) {
2544 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
2545 else removeAttribute(~0, Attribute::NoUnwind);
2548 /// @brief Determine if the call returns a structure through first
2549 /// pointer argument.
2550 bool hasStructRetAttr() const {
2551 // Be friendly and also check the callee.
2552 return paramHasAttr(1, Attribute::StructRet);
2555 /// @brief Determine if any call argument is an aggregate passed by value.
2556 bool hasByValArgument() const {
2557 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
2560 /// getCalledFunction - Return the function called, or null if this is an
2561 /// indirect function invocation.
2563 Function *getCalledFunction() const {
2564 return dyn_cast<Function>(Op<-3>());
2567 /// getCalledValue - Get a pointer to the function that is invoked by this
2569 const Value *getCalledValue() const { return Op<-3>(); }
2570 Value *getCalledValue() { return Op<-3>(); }
2572 /// setCalledFunction - Set the function called.
2573 void setCalledFunction(Value* Fn) {
2577 // get*Dest - Return the destination basic blocks...
2578 BasicBlock *getNormalDest() const {
2579 return cast<BasicBlock>(Op<-2>());
2581 BasicBlock *getUnwindDest() const {
2582 return cast<BasicBlock>(Op<-1>());
2584 void setNormalDest(BasicBlock *B) {
2585 Op<-2>() = reinterpret_cast<Value*>(B);
2587 void setUnwindDest(BasicBlock *B) {
2588 Op<-1>() = reinterpret_cast<Value*>(B);
2591 BasicBlock *getSuccessor(unsigned i) const {
2592 assert(i < 2 && "Successor # out of range for invoke!");
2593 return i == 0 ? getNormalDest() : getUnwindDest();
2596 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2597 assert(idx < 2 && "Successor # out of range for invoke!");
2598 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
2601 unsigned getNumSuccessors() const { return 2; }
2603 // Methods for support type inquiry through isa, cast, and dyn_cast:
2604 static inline bool classof(const InvokeInst *) { return true; }
2605 static inline bool classof(const Instruction *I) {
2606 return (I->getOpcode() == Instruction::Invoke);
2608 static inline bool classof(const Value *V) {
2609 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2613 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2614 virtual unsigned getNumSuccessorsV() const;
2615 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2617 // Shadow Instruction::setInstructionSubclassData with a private forwarding
2618 // method so that subclasses cannot accidentally use it.
2619 void setInstructionSubclassData(unsigned short D) {
2620 Instruction::setInstructionSubclassData(D);
2625 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<InvokeInst, 3> {
2628 template<typename RandomAccessIterator>
2629 InvokeInst::InvokeInst(Value *Func,
2630 BasicBlock *IfNormal, BasicBlock *IfException,
2631 RandomAccessIterator ArgBegin,
2632 RandomAccessIterator ArgEnd,
2634 const Twine &NameStr, Instruction *InsertBefore)
2635 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2636 ->getElementType())->getReturnType(),
2637 Instruction::Invoke,
2638 OperandTraits<InvokeInst>::op_end(this) - Values,
2639 Values, InsertBefore) {
2640 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2641 typename std::iterator_traits<RandomAccessIterator>
2642 ::iterator_category());
2644 template<typename RandomAccessIterator>
2645 InvokeInst::InvokeInst(Value *Func,
2646 BasicBlock *IfNormal, BasicBlock *IfException,
2647 RandomAccessIterator ArgBegin,
2648 RandomAccessIterator ArgEnd,
2650 const Twine &NameStr, BasicBlock *InsertAtEnd)
2651 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2652 ->getElementType())->getReturnType(),
2653 Instruction::Invoke,
2654 OperandTraits<InvokeInst>::op_end(this) - Values,
2655 Values, InsertAtEnd) {
2656 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2657 typename std::iterator_traits<RandomAccessIterator>
2658 ::iterator_category());
2661 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
2663 //===----------------------------------------------------------------------===//
2665 //===----------------------------------------------------------------------===//
2667 //===---------------------------------------------------------------------------
2668 /// UnwindInst - Immediately exit the current function, unwinding the stack
2669 /// until an invoke instruction is found.
2671 class UnwindInst : public TerminatorInst {
2672 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2674 virtual UnwindInst *clone_impl() const;
2676 // allocate space for exactly zero operands
2677 void *operator new(size_t s) {
2678 return User::operator new(s, 0);
2680 explicit UnwindInst(LLVMContext &C, Instruction *InsertBefore = 0);
2681 explicit UnwindInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2683 unsigned getNumSuccessors() const { return 0; }
2685 // Methods for support type inquiry through isa, cast, and dyn_cast:
2686 static inline bool classof(const UnwindInst *) { return true; }
2687 static inline bool classof(const Instruction *I) {
2688 return I->getOpcode() == Instruction::Unwind;
2690 static inline bool classof(const Value *V) {
2691 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2694 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2695 virtual unsigned getNumSuccessorsV() const;
2696 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2699 //===----------------------------------------------------------------------===//
2700 // UnreachableInst Class
2701 //===----------------------------------------------------------------------===//
2703 //===---------------------------------------------------------------------------
2704 /// UnreachableInst - This function has undefined behavior. In particular, the
2705 /// presence of this instruction indicates some higher level knowledge that the
2706 /// end of the block cannot be reached.
2708 class UnreachableInst : public TerminatorInst {
2709 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2711 virtual UnreachableInst *clone_impl() const;
2714 // allocate space for exactly zero operands
2715 void *operator new(size_t s) {
2716 return User::operator new(s, 0);
2718 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = 0);
2719 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2721 unsigned getNumSuccessors() const { return 0; }
2723 // Methods for support type inquiry through isa, cast, and dyn_cast:
2724 static inline bool classof(const UnreachableInst *) { return true; }
2725 static inline bool classof(const Instruction *I) {
2726 return I->getOpcode() == Instruction::Unreachable;
2728 static inline bool classof(const Value *V) {
2729 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2732 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2733 virtual unsigned getNumSuccessorsV() const;
2734 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2737 //===----------------------------------------------------------------------===//
2739 //===----------------------------------------------------------------------===//
2741 /// @brief This class represents a truncation of integer types.
2742 class TruncInst : public CastInst {
2744 /// @brief Clone an identical TruncInst
2745 virtual TruncInst *clone_impl() const;
2748 /// @brief Constructor with insert-before-instruction semantics
2750 Value *S, ///< The value to be truncated
2751 const Type *Ty, ///< The (smaller) type to truncate to
2752 const Twine &NameStr = "", ///< A name for the new instruction
2753 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2756 /// @brief Constructor with insert-at-end-of-block semantics
2758 Value *S, ///< The value to be truncated
2759 const Type *Ty, ///< The (smaller) type to truncate to
2760 const Twine &NameStr, ///< A name for the new instruction
2761 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2764 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2765 static inline bool classof(const TruncInst *) { return true; }
2766 static inline bool classof(const Instruction *I) {
2767 return I->getOpcode() == Trunc;
2769 static inline bool classof(const Value *V) {
2770 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2774 //===----------------------------------------------------------------------===//
2776 //===----------------------------------------------------------------------===//
2778 /// @brief This class represents zero extension of integer types.
2779 class ZExtInst : public CastInst {
2781 /// @brief Clone an identical ZExtInst
2782 virtual ZExtInst *clone_impl() const;
2785 /// @brief Constructor with insert-before-instruction semantics
2787 Value *S, ///< The value to be zero extended
2788 const Type *Ty, ///< The type to zero extend to
2789 const Twine &NameStr = "", ///< A name for the new instruction
2790 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2793 /// @brief Constructor with insert-at-end semantics.
2795 Value *S, ///< The value to be zero extended
2796 const Type *Ty, ///< The type to zero extend to
2797 const Twine &NameStr, ///< A name for the new instruction
2798 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2801 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2802 static inline bool classof(const ZExtInst *) { return true; }
2803 static inline bool classof(const Instruction *I) {
2804 return I->getOpcode() == ZExt;
2806 static inline bool classof(const Value *V) {
2807 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2811 //===----------------------------------------------------------------------===//
2813 //===----------------------------------------------------------------------===//
2815 /// @brief This class represents a sign extension of integer types.
2816 class SExtInst : public CastInst {
2818 /// @brief Clone an identical SExtInst
2819 virtual SExtInst *clone_impl() const;
2822 /// @brief Constructor with insert-before-instruction semantics
2824 Value *S, ///< The value to be sign extended
2825 const Type *Ty, ///< The type to sign extend to
2826 const Twine &NameStr = "", ///< A name for the new instruction
2827 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2830 /// @brief Constructor with insert-at-end-of-block semantics
2832 Value *S, ///< The value to be sign extended
2833 const Type *Ty, ///< The type to sign extend to
2834 const Twine &NameStr, ///< A name for the new instruction
2835 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2838 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2839 static inline bool classof(const SExtInst *) { return true; }
2840 static inline bool classof(const Instruction *I) {
2841 return I->getOpcode() == SExt;
2843 static inline bool classof(const Value *V) {
2844 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2848 //===----------------------------------------------------------------------===//
2849 // FPTruncInst Class
2850 //===----------------------------------------------------------------------===//
2852 /// @brief This class represents a truncation of floating point types.
2853 class FPTruncInst : public CastInst {
2855 /// @brief Clone an identical FPTruncInst
2856 virtual FPTruncInst *clone_impl() const;
2859 /// @brief Constructor with insert-before-instruction semantics
2861 Value *S, ///< The value to be truncated
2862 const Type *Ty, ///< The type to truncate to
2863 const Twine &NameStr = "", ///< A name for the new instruction
2864 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2867 /// @brief Constructor with insert-before-instruction semantics
2869 Value *S, ///< The value to be truncated
2870 const Type *Ty, ///< The type to truncate to
2871 const Twine &NameStr, ///< A name for the new instruction
2872 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2875 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2876 static inline bool classof(const FPTruncInst *) { return true; }
2877 static inline bool classof(const Instruction *I) {
2878 return I->getOpcode() == FPTrunc;
2880 static inline bool classof(const Value *V) {
2881 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2885 //===----------------------------------------------------------------------===//
2887 //===----------------------------------------------------------------------===//
2889 /// @brief This class represents an extension of floating point types.
2890 class FPExtInst : public CastInst {
2892 /// @brief Clone an identical FPExtInst
2893 virtual FPExtInst *clone_impl() const;
2896 /// @brief Constructor with insert-before-instruction semantics
2898 Value *S, ///< The value to be extended
2899 const Type *Ty, ///< The type to extend to
2900 const Twine &NameStr = "", ///< A name for the new instruction
2901 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2904 /// @brief Constructor with insert-at-end-of-block semantics
2906 Value *S, ///< The value to be extended
2907 const Type *Ty, ///< The type to extend to
2908 const Twine &NameStr, ///< A name for the new instruction
2909 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2912 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2913 static inline bool classof(const FPExtInst *) { return true; }
2914 static inline bool classof(const Instruction *I) {
2915 return I->getOpcode() == FPExt;
2917 static inline bool classof(const Value *V) {
2918 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2922 //===----------------------------------------------------------------------===//
2924 //===----------------------------------------------------------------------===//
2926 /// @brief This class represents a cast unsigned integer to floating point.
2927 class UIToFPInst : public CastInst {
2929 /// @brief Clone an identical UIToFPInst
2930 virtual UIToFPInst *clone_impl() const;
2933 /// @brief Constructor with insert-before-instruction semantics
2935 Value *S, ///< The value to be converted
2936 const Type *Ty, ///< The type to convert to
2937 const Twine &NameStr = "", ///< A name for the new instruction
2938 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2941 /// @brief Constructor with insert-at-end-of-block semantics
2943 Value *S, ///< The value to be converted
2944 const Type *Ty, ///< The type to convert to
2945 const Twine &NameStr, ///< A name for the new instruction
2946 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2949 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2950 static inline bool classof(const UIToFPInst *) { return true; }
2951 static inline bool classof(const Instruction *I) {
2952 return I->getOpcode() == UIToFP;
2954 static inline bool classof(const Value *V) {
2955 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2959 //===----------------------------------------------------------------------===//
2961 //===----------------------------------------------------------------------===//
2963 /// @brief This class represents a cast from signed integer to floating point.
2964 class SIToFPInst : public CastInst {
2966 /// @brief Clone an identical SIToFPInst
2967 virtual SIToFPInst *clone_impl() const;
2970 /// @brief Constructor with insert-before-instruction semantics
2972 Value *S, ///< The value to be converted
2973 const Type *Ty, ///< The type to convert to
2974 const Twine &NameStr = "", ///< A name for the new instruction
2975 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2978 /// @brief Constructor with insert-at-end-of-block semantics
2980 Value *S, ///< The value to be converted
2981 const Type *Ty, ///< The type to convert to
2982 const Twine &NameStr, ///< A name for the new instruction
2983 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2986 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2987 static inline bool classof(const SIToFPInst *) { return true; }
2988 static inline bool classof(const Instruction *I) {
2989 return I->getOpcode() == SIToFP;
2991 static inline bool classof(const Value *V) {
2992 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2996 //===----------------------------------------------------------------------===//
2998 //===----------------------------------------------------------------------===//
3000 /// @brief This class represents a cast from floating point to unsigned integer
3001 class FPToUIInst : public CastInst {
3003 /// @brief Clone an identical FPToUIInst
3004 virtual FPToUIInst *clone_impl() const;
3007 /// @brief Constructor with insert-before-instruction semantics
3009 Value *S, ///< The value to be converted
3010 const Type *Ty, ///< The type to convert to
3011 const Twine &NameStr = "", ///< A name for the new instruction
3012 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3015 /// @brief Constructor with insert-at-end-of-block semantics
3017 Value *S, ///< The value to be converted
3018 const Type *Ty, ///< The type to convert to
3019 const Twine &NameStr, ///< A name for the new instruction
3020 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
3023 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3024 static inline bool classof(const FPToUIInst *) { return true; }
3025 static inline bool classof(const Instruction *I) {
3026 return I->getOpcode() == FPToUI;
3028 static inline bool classof(const Value *V) {
3029 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3033 //===----------------------------------------------------------------------===//
3035 //===----------------------------------------------------------------------===//
3037 /// @brief This class represents a cast from floating point to signed integer.
3038 class FPToSIInst : public CastInst {
3040 /// @brief Clone an identical FPToSIInst
3041 virtual FPToSIInst *clone_impl() const;
3044 /// @brief Constructor with insert-before-instruction semantics
3046 Value *S, ///< The value to be converted
3047 const Type *Ty, ///< The type to convert to
3048 const Twine &NameStr = "", ///< A name for the new instruction
3049 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3052 /// @brief Constructor with insert-at-end-of-block semantics
3054 Value *S, ///< The value to be converted
3055 const Type *Ty, ///< The type to convert to
3056 const Twine &NameStr, ///< A name for the new instruction
3057 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3060 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3061 static inline bool classof(const FPToSIInst *) { return true; }
3062 static inline bool classof(const Instruction *I) {
3063 return I->getOpcode() == FPToSI;
3065 static inline bool classof(const Value *V) {
3066 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3070 //===----------------------------------------------------------------------===//
3071 // IntToPtrInst Class
3072 //===----------------------------------------------------------------------===//
3074 /// @brief This class represents a cast from an integer to a pointer.
3075 class IntToPtrInst : public CastInst {
3077 /// @brief Constructor with insert-before-instruction semantics
3079 Value *S, ///< The value to be converted
3080 const Type *Ty, ///< The type to convert to
3081 const Twine &NameStr = "", ///< A name for the new instruction
3082 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3085 /// @brief Constructor with insert-at-end-of-block semantics
3087 Value *S, ///< The value to be converted
3088 const Type *Ty, ///< The type to convert to
3089 const Twine &NameStr, ///< A name for the new instruction
3090 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3093 /// @brief Clone an identical IntToPtrInst
3094 virtual IntToPtrInst *clone_impl() const;
3096 // Methods for support type inquiry through isa, cast, and dyn_cast:
3097 static inline bool classof(const IntToPtrInst *) { return true; }
3098 static inline bool classof(const Instruction *I) {
3099 return I->getOpcode() == IntToPtr;
3101 static inline bool classof(const Value *V) {
3102 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3106 //===----------------------------------------------------------------------===//
3107 // PtrToIntInst Class
3108 //===----------------------------------------------------------------------===//
3110 /// @brief This class represents a cast from a pointer to an integer
3111 class PtrToIntInst : public CastInst {
3113 /// @brief Clone an identical PtrToIntInst
3114 virtual PtrToIntInst *clone_impl() const;
3117 /// @brief Constructor with insert-before-instruction semantics
3119 Value *S, ///< The value to be converted
3120 const Type *Ty, ///< The type to convert to
3121 const Twine &NameStr = "", ///< A name for the new instruction
3122 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3125 /// @brief Constructor with insert-at-end-of-block semantics
3127 Value *S, ///< The value to be converted
3128 const Type *Ty, ///< The type to convert to
3129 const Twine &NameStr, ///< A name for the new instruction
3130 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3133 // Methods for support type inquiry through isa, cast, and dyn_cast:
3134 static inline bool classof(const PtrToIntInst *) { return true; }
3135 static inline bool classof(const Instruction *I) {
3136 return I->getOpcode() == PtrToInt;
3138 static inline bool classof(const Value *V) {
3139 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3143 //===----------------------------------------------------------------------===//
3144 // BitCastInst Class
3145 //===----------------------------------------------------------------------===//
3147 /// @brief This class represents a no-op cast from one type to another.
3148 class BitCastInst : public CastInst {
3150 /// @brief Clone an identical BitCastInst
3151 virtual BitCastInst *clone_impl() const;
3154 /// @brief Constructor with insert-before-instruction semantics
3156 Value *S, ///< The value to be casted
3157 const Type *Ty, ///< The type to casted to
3158 const Twine &NameStr = "", ///< A name for the new instruction
3159 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3162 /// @brief Constructor with insert-at-end-of-block semantics
3164 Value *S, ///< The value to be casted
3165 const Type *Ty, ///< The type to casted to
3166 const Twine &NameStr, ///< A name for the new instruction
3167 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3170 // Methods for support type inquiry through isa, cast, and dyn_cast:
3171 static inline bool classof(const BitCastInst *) { return true; }
3172 static inline bool classof(const Instruction *I) {
3173 return I->getOpcode() == BitCast;
3175 static inline bool classof(const Value *V) {
3176 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3180 } // End llvm namespace