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"
34 //===----------------------------------------------------------------------===//
36 //===----------------------------------------------------------------------===//
38 /// AllocaInst - an instruction to allocate memory on the stack
40 class AllocaInst : public UnaryInstruction {
42 virtual AllocaInst *clone_impl() const;
44 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
45 const Twine &Name = "", Instruction *InsertBefore = 0);
46 AllocaInst(const Type *Ty, Value *ArraySize,
47 const Twine &Name, BasicBlock *InsertAtEnd);
49 AllocaInst(const Type *Ty, const Twine &Name, Instruction *InsertBefore = 0);
50 AllocaInst(const Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd);
52 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
53 const Twine &Name = "", Instruction *InsertBefore = 0);
54 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
55 const Twine &Name, BasicBlock *InsertAtEnd);
57 // Out of line virtual method, so the vtable, etc. has a home.
58 virtual ~AllocaInst();
60 /// isArrayAllocation - Return true if there is an allocation size parameter
61 /// to the allocation instruction that is not 1.
63 bool isArrayAllocation() const;
65 /// getArraySize - Get the number of elements allocated. For a simple
66 /// allocation of a single element, this will return a constant 1 value.
68 const Value *getArraySize() const { return getOperand(0); }
69 Value *getArraySize() { return getOperand(0); }
71 /// getType - Overload to return most specific pointer type
73 const PointerType *getType() const {
74 return reinterpret_cast<const PointerType*>(Instruction::getType());
77 /// getAllocatedType - Return the type that is being allocated by the
80 const Type *getAllocatedType() const;
82 /// getAlignment - Return the alignment of the memory that is being allocated
83 /// by the instruction.
85 unsigned getAlignment() const {
86 return (1u << getSubclassDataFromInstruction()) >> 1;
88 void setAlignment(unsigned Align);
90 /// isStaticAlloca - Return true if this alloca is in the entry block of the
91 /// function and is a constant size. If so, the code generator will fold it
92 /// into the prolog/epilog code, so it is basically free.
93 bool isStaticAlloca() const;
95 // Methods for support type inquiry through isa, cast, and dyn_cast:
96 static inline bool classof(const AllocaInst *) { return true; }
97 static inline bool classof(const Instruction *I) {
98 return (I->getOpcode() == Instruction::Alloca);
100 static inline bool classof(const Value *V) {
101 return isa<Instruction>(V) && classof(cast<Instruction>(V));
104 // Shadow Instruction::setInstructionSubclassData with a private forwarding
105 // method so that subclasses cannot accidentally use it.
106 void setInstructionSubclassData(unsigned short D) {
107 Instruction::setInstructionSubclassData(D);
112 //===----------------------------------------------------------------------===//
114 //===----------------------------------------------------------------------===//
116 /// LoadInst - an instruction for reading from memory. This uses the
117 /// SubclassData field in Value to store whether or not the load is volatile.
119 class LoadInst : public UnaryInstruction {
122 virtual LoadInst *clone_impl() const;
124 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
125 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
126 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
127 Instruction *InsertBefore = 0);
128 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
129 unsigned Align, Instruction *InsertBefore = 0);
130 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
131 BasicBlock *InsertAtEnd);
132 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
133 unsigned Align, BasicBlock *InsertAtEnd);
135 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
136 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
137 explicit LoadInst(Value *Ptr, const char *NameStr = 0,
138 bool isVolatile = false, Instruction *InsertBefore = 0);
139 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
140 BasicBlock *InsertAtEnd);
142 /// isVolatile - Return true if this is a load from a volatile memory
145 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
147 /// setVolatile - Specify whether this is a volatile load or not.
149 void setVolatile(bool V) {
150 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
154 /// getAlignment - Return the alignment of the access that is being performed
156 unsigned getAlignment() const {
157 return (1 << (getSubclassDataFromInstruction() >> 1)) >> 1;
160 void setAlignment(unsigned Align);
162 Value *getPointerOperand() { return getOperand(0); }
163 const Value *getPointerOperand() const { return getOperand(0); }
164 static unsigned getPointerOperandIndex() { return 0U; }
166 unsigned getPointerAddressSpace() const {
167 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
171 // Methods for support type inquiry through isa, cast, and dyn_cast:
172 static inline bool classof(const LoadInst *) { return true; }
173 static inline bool classof(const Instruction *I) {
174 return I->getOpcode() == Instruction::Load;
176 static inline bool classof(const Value *V) {
177 return isa<Instruction>(V) && classof(cast<Instruction>(V));
180 // Shadow Instruction::setInstructionSubclassData with a private forwarding
181 // method so that subclasses cannot accidentally use it.
182 void setInstructionSubclassData(unsigned short D) {
183 Instruction::setInstructionSubclassData(D);
188 //===----------------------------------------------------------------------===//
190 //===----------------------------------------------------------------------===//
192 /// StoreInst - an instruction for storing to memory
194 class StoreInst : public Instruction {
195 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
198 virtual StoreInst *clone_impl() const;
200 // allocate space for exactly two operands
201 void *operator new(size_t s) {
202 return User::operator new(s, 2);
204 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
205 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
206 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
207 Instruction *InsertBefore = 0);
208 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
209 unsigned Align, Instruction *InsertBefore = 0);
210 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
211 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
212 unsigned Align, BasicBlock *InsertAtEnd);
215 /// isVolatile - Return true if this is a load from a volatile memory
218 bool isVolatile() const { return getSubclassDataFromInstruction() & 1; }
220 /// setVolatile - Specify whether this is a volatile load or not.
222 void setVolatile(bool V) {
223 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
227 /// Transparently provide more efficient getOperand methods.
228 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
230 /// getAlignment - Return the alignment of the access that is being performed
232 unsigned getAlignment() const {
233 return (1 << (getSubclassDataFromInstruction() >> 1)) >> 1;
236 void setAlignment(unsigned Align);
238 Value *getValueOperand() { return getOperand(0); }
239 const Value *getValueOperand() const { return getOperand(0); }
241 Value *getPointerOperand() { return getOperand(1); }
242 const Value *getPointerOperand() const { return getOperand(1); }
243 static unsigned getPointerOperandIndex() { return 1U; }
245 unsigned getPointerAddressSpace() const {
246 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
249 // Methods for support type inquiry through isa, cast, and dyn_cast:
250 static inline bool classof(const StoreInst *) { return true; }
251 static inline bool classof(const Instruction *I) {
252 return I->getOpcode() == Instruction::Store;
254 static inline bool classof(const Value *V) {
255 return isa<Instruction>(V) && classof(cast<Instruction>(V));
258 // Shadow Instruction::setInstructionSubclassData with a private forwarding
259 // method so that subclasses cannot accidentally use it.
260 void setInstructionSubclassData(unsigned short D) {
261 Instruction::setInstructionSubclassData(D);
266 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<2> {
269 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
271 //===----------------------------------------------------------------------===//
272 // GetElementPtrInst Class
273 //===----------------------------------------------------------------------===//
275 // checkType - Simple wrapper function to give a better assertion failure
276 // message on bad indexes for a gep instruction.
278 static inline const Type *checkType(const Type *Ty) {
279 assert(Ty && "Invalid GetElementPtrInst indices for type!");
283 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
284 /// access elements of arrays and structs
286 class GetElementPtrInst : public Instruction {
287 GetElementPtrInst(const GetElementPtrInst &GEPI);
288 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx,
289 const Twine &NameStr);
290 void init(Value *Ptr, Value *Idx, const Twine &NameStr);
292 template<typename InputIterator>
293 void init(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
294 const Twine &NameStr,
295 // This argument ensures that we have an iterator we can
296 // do arithmetic on in constant time
297 std::random_access_iterator_tag) {
298 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
301 // This requires that the iterator points to contiguous memory.
302 init(Ptr, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
303 // we have to build an array here
306 init(Ptr, 0, NumIdx, NameStr);
310 /// getIndexedType - Returns the type of the element that would be loaded with
311 /// a load instruction with the specified parameters.
313 /// Null is returned if the indices are invalid for the specified
316 template<typename InputIterator>
317 static const Type *getIndexedType(const Type *Ptr,
318 InputIterator IdxBegin,
319 InputIterator IdxEnd,
320 // This argument ensures that we
321 // have an iterator we can do
322 // arithmetic on in constant time
323 std::random_access_iterator_tag) {
324 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
327 // This requires that the iterator points to contiguous memory.
328 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
330 return getIndexedType(Ptr, (Value *const*)0, NumIdx);
333 /// Constructors - Create a getelementptr instruction with a base pointer an
334 /// list of indices. The first ctor can optionally insert before an existing
335 /// instruction, the second appends the new instruction to the specified
337 template<typename InputIterator>
338 inline GetElementPtrInst(Value *Ptr, InputIterator IdxBegin,
339 InputIterator IdxEnd,
341 const Twine &NameStr,
342 Instruction *InsertBefore);
343 template<typename InputIterator>
344 inline GetElementPtrInst(Value *Ptr,
345 InputIterator IdxBegin, InputIterator IdxEnd,
347 const Twine &NameStr, BasicBlock *InsertAtEnd);
349 /// Constructors - These two constructors are convenience methods because one
350 /// and two index getelementptr instructions are so common.
351 GetElementPtrInst(Value *Ptr, Value *Idx, const Twine &NameStr = "",
352 Instruction *InsertBefore = 0);
353 GetElementPtrInst(Value *Ptr, Value *Idx,
354 const Twine &NameStr, BasicBlock *InsertAtEnd);
356 virtual GetElementPtrInst *clone_impl() const;
358 template<typename InputIterator>
359 static GetElementPtrInst *Create(Value *Ptr, InputIterator IdxBegin,
360 InputIterator IdxEnd,
361 const Twine &NameStr = "",
362 Instruction *InsertBefore = 0) {
363 typename std::iterator_traits<InputIterator>::difference_type Values =
364 1 + std::distance(IdxBegin, IdxEnd);
366 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertBefore);
368 template<typename InputIterator>
369 static GetElementPtrInst *Create(Value *Ptr,
370 InputIterator IdxBegin, InputIterator IdxEnd,
371 const Twine &NameStr,
372 BasicBlock *InsertAtEnd) {
373 typename std::iterator_traits<InputIterator>::difference_type Values =
374 1 + std::distance(IdxBegin, IdxEnd);
376 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertAtEnd);
379 /// Constructors - These two creators are convenience methods because one
380 /// index getelementptr instructions are so common.
381 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
382 const Twine &NameStr = "",
383 Instruction *InsertBefore = 0) {
384 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertBefore);
386 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
387 const Twine &NameStr,
388 BasicBlock *InsertAtEnd) {
389 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertAtEnd);
392 /// Create an "inbounds" getelementptr. See the documentation for the
393 /// "inbounds" flag in LangRef.html for details.
394 template<typename InputIterator>
395 static GetElementPtrInst *CreateInBounds(Value *Ptr, InputIterator IdxBegin,
396 InputIterator IdxEnd,
397 const Twine &NameStr = "",
398 Instruction *InsertBefore = 0) {
399 GetElementPtrInst *GEP = Create(Ptr, IdxBegin, IdxEnd,
400 NameStr, InsertBefore);
401 GEP->setIsInBounds(true);
404 template<typename InputIterator>
405 static GetElementPtrInst *CreateInBounds(Value *Ptr,
406 InputIterator IdxBegin,
407 InputIterator IdxEnd,
408 const Twine &NameStr,
409 BasicBlock *InsertAtEnd) {
410 GetElementPtrInst *GEP = Create(Ptr, IdxBegin, IdxEnd,
411 NameStr, InsertAtEnd);
412 GEP->setIsInBounds(true);
415 static GetElementPtrInst *CreateInBounds(Value *Ptr, Value *Idx,
416 const Twine &NameStr = "",
417 Instruction *InsertBefore = 0) {
418 GetElementPtrInst *GEP = Create(Ptr, Idx, NameStr, InsertBefore);
419 GEP->setIsInBounds(true);
422 static GetElementPtrInst *CreateInBounds(Value *Ptr, Value *Idx,
423 const Twine &NameStr,
424 BasicBlock *InsertAtEnd) {
425 GetElementPtrInst *GEP = Create(Ptr, Idx, NameStr, InsertAtEnd);
426 GEP->setIsInBounds(true);
430 /// Transparently provide more efficient getOperand methods.
431 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
433 // getType - Overload to return most specific pointer type...
434 const PointerType *getType() const {
435 return reinterpret_cast<const PointerType*>(Instruction::getType());
438 /// getIndexedType - Returns the type of the element that would be loaded with
439 /// a load instruction with the specified parameters.
441 /// Null is returned if the indices are invalid for the specified
444 template<typename InputIterator>
445 static const Type *getIndexedType(const Type *Ptr,
446 InputIterator IdxBegin,
447 InputIterator IdxEnd) {
448 return getIndexedType(Ptr, IdxBegin, IdxEnd,
449 typename std::iterator_traits<InputIterator>::
450 iterator_category());
453 static const Type *getIndexedType(const Type *Ptr,
454 Value* const *Idx, unsigned NumIdx);
456 static const Type *getIndexedType(const Type *Ptr,
457 uint64_t const *Idx, unsigned NumIdx);
459 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
461 inline op_iterator idx_begin() { return op_begin()+1; }
462 inline const_op_iterator idx_begin() const { return op_begin()+1; }
463 inline op_iterator idx_end() { return op_end(); }
464 inline const_op_iterator idx_end() const { return op_end(); }
466 Value *getPointerOperand() {
467 return getOperand(0);
469 const Value *getPointerOperand() const {
470 return getOperand(0);
472 static unsigned getPointerOperandIndex() {
473 return 0U; // get index for modifying correct operand
476 unsigned getPointerAddressSpace() const {
477 return cast<PointerType>(getType())->getAddressSpace();
480 /// getPointerOperandType - Method to return the pointer operand as a
482 const PointerType *getPointerOperandType() const {
483 return reinterpret_cast<const PointerType*>(getPointerOperand()->getType());
487 unsigned getNumIndices() const { // Note: always non-negative
488 return getNumOperands() - 1;
491 bool hasIndices() const {
492 return getNumOperands() > 1;
495 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
496 /// zeros. If so, the result pointer and the first operand have the same
497 /// value, just potentially different types.
498 bool hasAllZeroIndices() const;
500 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
501 /// constant integers. If so, the result pointer and the first operand have
502 /// a constant offset between them.
503 bool hasAllConstantIndices() const;
505 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
506 /// See LangRef.html for the meaning of inbounds on a getelementptr.
507 void setIsInBounds(bool b = true);
509 /// isInBounds - Determine whether the GEP has the inbounds flag.
510 bool isInBounds() const;
512 // Methods for support type inquiry through isa, cast, and dyn_cast:
513 static inline bool classof(const GetElementPtrInst *) { return true; }
514 static inline bool classof(const Instruction *I) {
515 return (I->getOpcode() == Instruction::GetElementPtr);
517 static inline bool classof(const Value *V) {
518 return isa<Instruction>(V) && classof(cast<Instruction>(V));
523 struct OperandTraits<GetElementPtrInst> : public VariadicOperandTraits<1> {
526 template<typename InputIterator>
527 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
528 InputIterator IdxBegin,
529 InputIterator IdxEnd,
531 const Twine &NameStr,
532 Instruction *InsertBefore)
533 : Instruction(PointerType::get(checkType(
534 getIndexedType(Ptr->getType(),
536 cast<PointerType>(Ptr->getType())
537 ->getAddressSpace()),
539 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
540 Values, InsertBefore) {
541 init(Ptr, IdxBegin, IdxEnd, NameStr,
542 typename std::iterator_traits<InputIterator>::iterator_category());
544 template<typename InputIterator>
545 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
546 InputIterator IdxBegin,
547 InputIterator IdxEnd,
549 const Twine &NameStr,
550 BasicBlock *InsertAtEnd)
551 : Instruction(PointerType::get(checkType(
552 getIndexedType(Ptr->getType(),
554 cast<PointerType>(Ptr->getType())
555 ->getAddressSpace()),
557 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
558 Values, InsertAtEnd) {
559 init(Ptr, IdxBegin, IdxEnd, NameStr,
560 typename std::iterator_traits<InputIterator>::iterator_category());
564 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
567 //===----------------------------------------------------------------------===//
569 //===----------------------------------------------------------------------===//
571 /// This instruction compares its operands according to the predicate given
572 /// to the constructor. It only operates on integers or pointers. The operands
573 /// must be identical types.
574 /// @brief Represent an integer comparison operator.
575 class ICmpInst: public CmpInst {
577 /// @brief Clone an indentical ICmpInst
578 virtual ICmpInst *clone_impl() const;
580 /// @brief Constructor with insert-before-instruction semantics.
582 Instruction *InsertBefore, ///< Where to insert
583 Predicate pred, ///< The predicate to use for the comparison
584 Value *LHS, ///< The left-hand-side of the expression
585 Value *RHS, ///< The right-hand-side of the expression
586 const Twine &NameStr = "" ///< Name of the instruction
587 ) : CmpInst(makeCmpResultType(LHS->getType()),
588 Instruction::ICmp, pred, LHS, RHS, NameStr,
590 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
591 pred <= CmpInst::LAST_ICMP_PREDICATE &&
592 "Invalid ICmp predicate value");
593 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
594 "Both operands to ICmp instruction are not of the same type!");
595 // Check that the operands are the right type
596 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
597 getOperand(0)->getType()->isPointerTy()) &&
598 "Invalid operand types for ICmp instruction");
601 /// @brief Constructor with insert-at-end semantics.
603 BasicBlock &InsertAtEnd, ///< Block to insert into.
604 Predicate pred, ///< The predicate to use for the comparison
605 Value *LHS, ///< The left-hand-side of the expression
606 Value *RHS, ///< The right-hand-side of the expression
607 const Twine &NameStr = "" ///< Name of the instruction
608 ) : CmpInst(makeCmpResultType(LHS->getType()),
609 Instruction::ICmp, pred, LHS, RHS, NameStr,
611 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
612 pred <= CmpInst::LAST_ICMP_PREDICATE &&
613 "Invalid ICmp predicate value");
614 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
615 "Both operands to ICmp instruction are not of the same type!");
616 // Check that the operands are the right type
617 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
618 getOperand(0)->getType()->isPointerTy()) &&
619 "Invalid operand types for ICmp instruction");
622 /// @brief Constructor with no-insertion semantics
624 Predicate pred, ///< The predicate to use for the comparison
625 Value *LHS, ///< The left-hand-side of the expression
626 Value *RHS, ///< The right-hand-side of the expression
627 const Twine &NameStr = "" ///< Name of the instruction
628 ) : CmpInst(makeCmpResultType(LHS->getType()),
629 Instruction::ICmp, pred, LHS, RHS, NameStr) {
630 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
631 pred <= CmpInst::LAST_ICMP_PREDICATE &&
632 "Invalid ICmp predicate value");
633 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
634 "Both operands to ICmp instruction are not of the same type!");
635 // Check that the operands are the right type
636 assert((getOperand(0)->getType()->isIntOrIntVectorTy() ||
637 getOperand(0)->getType()->isPointerTy()) &&
638 "Invalid operand types for ICmp instruction");
641 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
642 /// @returns the predicate that would be the result if the operand were
643 /// regarded as signed.
644 /// @brief Return the signed version of the predicate
645 Predicate getSignedPredicate() const {
646 return getSignedPredicate(getPredicate());
649 /// This is a static version that you can use without an instruction.
650 /// @brief Return the signed version of the predicate.
651 static Predicate getSignedPredicate(Predicate pred);
653 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
654 /// @returns the predicate that would be the result if the operand were
655 /// regarded as unsigned.
656 /// @brief Return the unsigned version of the predicate
657 Predicate getUnsignedPredicate() const {
658 return getUnsignedPredicate(getPredicate());
661 /// This is a static version that you can use without an instruction.
662 /// @brief Return the unsigned version of the predicate.
663 static Predicate getUnsignedPredicate(Predicate pred);
665 /// isEquality - Return true if this predicate is either EQ or NE. This also
666 /// tests for commutativity.
667 static bool isEquality(Predicate P) {
668 return P == ICMP_EQ || P == ICMP_NE;
671 /// isEquality - Return true if this predicate is either EQ or NE. This also
672 /// tests for commutativity.
673 bool isEquality() const {
674 return isEquality(getPredicate());
677 /// @returns true if the predicate of this ICmpInst is commutative
678 /// @brief Determine if this relation is commutative.
679 bool isCommutative() const { return isEquality(); }
681 /// isRelational - Return true if the predicate is relational (not EQ or NE).
683 bool isRelational() const {
684 return !isEquality();
687 /// isRelational - Return true if the predicate is relational (not EQ or NE).
689 static bool isRelational(Predicate P) {
690 return !isEquality(P);
693 /// Initialize a set of values that all satisfy the predicate with C.
694 /// @brief Make a ConstantRange for a relation with a constant value.
695 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
697 /// Exchange the two operands to this instruction in such a way that it does
698 /// not modify the semantics of the instruction. The predicate value may be
699 /// changed to retain the same result if the predicate is order dependent
701 /// @brief Swap operands and adjust predicate.
702 void swapOperands() {
703 setPredicate(getSwappedPredicate());
704 Op<0>().swap(Op<1>());
707 // Methods for support type inquiry through isa, cast, and dyn_cast:
708 static inline bool classof(const ICmpInst *) { return true; }
709 static inline bool classof(const Instruction *I) {
710 return I->getOpcode() == Instruction::ICmp;
712 static inline bool classof(const Value *V) {
713 return isa<Instruction>(V) && classof(cast<Instruction>(V));
718 //===----------------------------------------------------------------------===//
720 //===----------------------------------------------------------------------===//
722 /// This instruction compares its operands according to the predicate given
723 /// to the constructor. It only operates on floating point values or packed
724 /// vectors of floating point values. The operands must be identical types.
725 /// @brief Represents a floating point comparison operator.
726 class FCmpInst: public CmpInst {
728 /// @brief Clone an indentical FCmpInst
729 virtual FCmpInst *clone_impl() const;
731 /// @brief Constructor with insert-before-instruction semantics.
733 Instruction *InsertBefore, ///< Where to insert
734 Predicate pred, ///< The predicate to use for the comparison
735 Value *LHS, ///< The left-hand-side of the expression
736 Value *RHS, ///< The right-hand-side of the expression
737 const Twine &NameStr = "" ///< Name of the instruction
738 ) : CmpInst(makeCmpResultType(LHS->getType()),
739 Instruction::FCmp, pred, LHS, RHS, NameStr,
741 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
742 "Invalid FCmp predicate value");
743 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
744 "Both operands to FCmp instruction are not of the same type!");
745 // Check that the operands are the right type
746 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
747 "Invalid operand types for FCmp instruction");
750 /// @brief Constructor with insert-at-end semantics.
752 BasicBlock &InsertAtEnd, ///< Block to insert into.
753 Predicate pred, ///< The predicate to use for the comparison
754 Value *LHS, ///< The left-hand-side of the expression
755 Value *RHS, ///< The right-hand-side of the expression
756 const Twine &NameStr = "" ///< Name of the instruction
757 ) : CmpInst(makeCmpResultType(LHS->getType()),
758 Instruction::FCmp, pred, LHS, RHS, NameStr,
760 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
761 "Invalid FCmp predicate value");
762 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
763 "Both operands to FCmp instruction are not of the same type!");
764 // Check that the operands are the right type
765 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
766 "Invalid operand types for FCmp instruction");
769 /// @brief Constructor with no-insertion semantics
771 Predicate pred, ///< The predicate to use for the comparison
772 Value *LHS, ///< The left-hand-side of the expression
773 Value *RHS, ///< The right-hand-side of the expression
774 const Twine &NameStr = "" ///< Name of the instruction
775 ) : CmpInst(makeCmpResultType(LHS->getType()),
776 Instruction::FCmp, pred, LHS, RHS, NameStr) {
777 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
778 "Invalid FCmp predicate value");
779 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
780 "Both operands to FCmp instruction are not of the same type!");
781 // Check that the operands are the right type
782 assert(getOperand(0)->getType()->isFPOrFPVectorTy() &&
783 "Invalid operand types for FCmp instruction");
786 /// @returns true if the predicate of this instruction is EQ or NE.
787 /// @brief Determine if this is an equality predicate.
788 bool isEquality() const {
789 return getPredicate() == FCMP_OEQ || getPredicate() == FCMP_ONE ||
790 getPredicate() == FCMP_UEQ || getPredicate() == FCMP_UNE;
793 /// @returns true if the predicate of this instruction is commutative.
794 /// @brief Determine if this is a commutative predicate.
795 bool isCommutative() const {
796 return isEquality() ||
797 getPredicate() == FCMP_FALSE ||
798 getPredicate() == FCMP_TRUE ||
799 getPredicate() == FCMP_ORD ||
800 getPredicate() == FCMP_UNO;
803 /// @returns true if the predicate is relational (not EQ or NE).
804 /// @brief Determine if this a relational predicate.
805 bool isRelational() const { return !isEquality(); }
807 /// Exchange the two operands to this instruction in such a way that it does
808 /// not modify the semantics of the instruction. The predicate value may be
809 /// changed to retain the same result if the predicate is order dependent
811 /// @brief Swap operands and adjust predicate.
812 void swapOperands() {
813 setPredicate(getSwappedPredicate());
814 Op<0>().swap(Op<1>());
817 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
818 static inline bool classof(const FCmpInst *) { return true; }
819 static inline bool classof(const Instruction *I) {
820 return I->getOpcode() == Instruction::FCmp;
822 static inline bool classof(const Value *V) {
823 return isa<Instruction>(V) && classof(cast<Instruction>(V));
827 //===----------------------------------------------------------------------===//
828 /// CallInst - This class represents a function call, abstracting a target
829 /// machine's calling convention. This class uses low bit of the SubClassData
830 /// field to indicate whether or not this is a tail call. The rest of the bits
831 /// hold the calling convention of the call.
833 class CallInst : public Instruction {
834 AttrListPtr AttributeList; ///< parameter attributes for call
835 CallInst(const CallInst &CI);
836 void init(Value *Func, Value* const *Params, unsigned NumParams);
837 void init(Value *Func, Value *Actual1, Value *Actual2);
838 void init(Value *Func, Value *Actual);
839 void init(Value *Func);
841 template<typename InputIterator>
842 void init(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
843 const Twine &NameStr,
844 // This argument ensures that we have an iterator we can
845 // do arithmetic on in constant time
846 std::random_access_iterator_tag) {
847 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
849 // This requires that the iterator points to contiguous memory.
850 init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
854 /// Construct a CallInst given a range of arguments. InputIterator
855 /// must be a random-access iterator pointing to contiguous storage
856 /// (e.g. a std::vector<>::iterator). Checks are made for
857 /// random-accessness but not for contiguous storage as that would
858 /// incur runtime overhead.
859 /// @brief Construct a CallInst from a range of arguments
860 template<typename InputIterator>
861 CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
862 const Twine &NameStr, Instruction *InsertBefore);
864 /// Construct a CallInst given a range of arguments. InputIterator
865 /// must be a random-access iterator pointing to contiguous storage
866 /// (e.g. a std::vector<>::iterator). Checks are made for
867 /// random-accessness but not for contiguous storage as that would
868 /// incur runtime overhead.
869 /// @brief Construct a CallInst from a range of arguments
870 template<typename InputIterator>
871 inline CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
872 const Twine &NameStr, BasicBlock *InsertAtEnd);
874 CallInst(Value *F, Value *Actual, const Twine &NameStr,
875 Instruction *InsertBefore);
876 CallInst(Value *F, Value *Actual, const Twine &NameStr,
877 BasicBlock *InsertAtEnd);
878 explicit CallInst(Value *F, const Twine &NameStr,
879 Instruction *InsertBefore);
880 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
882 virtual CallInst *clone_impl() const;
884 template<typename InputIterator>
885 static CallInst *Create(Value *Func,
886 InputIterator ArgBegin, InputIterator ArgEnd,
887 const Twine &NameStr = "",
888 Instruction *InsertBefore = 0) {
889 return new(unsigned(ArgEnd - ArgBegin + 1))
890 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertBefore);
892 template<typename InputIterator>
893 static CallInst *Create(Value *Func,
894 InputIterator ArgBegin, InputIterator ArgEnd,
895 const Twine &NameStr, BasicBlock *InsertAtEnd) {
896 return new(unsigned(ArgEnd - ArgBegin + 1))
897 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertAtEnd);
899 static CallInst *Create(Value *F, Value *Actual,
900 const Twine &NameStr = "",
901 Instruction *InsertBefore = 0) {
902 return new(2) CallInst(F, Actual, NameStr, InsertBefore);
904 static CallInst *Create(Value *F, Value *Actual, const Twine &NameStr,
905 BasicBlock *InsertAtEnd) {
906 return new(2) CallInst(F, Actual, NameStr, InsertAtEnd);
908 static CallInst *Create(Value *F, const Twine &NameStr = "",
909 Instruction *InsertBefore = 0) {
910 return new(1) CallInst(F, NameStr, InsertBefore);
912 static CallInst *Create(Value *F, const Twine &NameStr,
913 BasicBlock *InsertAtEnd) {
914 return new(1) CallInst(F, NameStr, InsertAtEnd);
916 /// CreateMalloc - Generate the IR for a call to malloc:
917 /// 1. Compute the malloc call's argument as the specified type's size,
918 /// possibly multiplied by the array size if the array size is not
920 /// 2. Call malloc with that argument.
921 /// 3. Bitcast the result of the malloc call to the specified type.
922 static Instruction *CreateMalloc(Instruction *InsertBefore,
923 const Type *IntPtrTy, const Type *AllocTy,
924 Value *AllocSize, Value *ArraySize = 0,
925 Function* MallocF = 0,
926 const Twine &Name = "");
927 static Instruction *CreateMalloc(BasicBlock *InsertAtEnd,
928 const Type *IntPtrTy, const Type *AllocTy,
929 Value *AllocSize, Value *ArraySize = 0,
930 Function* MallocF = 0,
931 const Twine &Name = "");
932 /// CreateFree - Generate the IR for a call to the builtin free function.
933 static Instruction* CreateFree(Value* Source, Instruction *InsertBefore);
934 static Instruction* CreateFree(Value* Source, BasicBlock *InsertAtEnd);
938 bool isTailCall() const { return getSubclassDataFromInstruction() & 1; }
939 void setTailCall(bool isTC = true) {
940 setInstructionSubclassData((getSubclassDataFromInstruction() & ~1) |
944 /// Provide fast operand accessors
945 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
947 /// getNumArgOperands - Return the number of call arguments.
949 unsigned getNumArgOperands() const { return getNumOperands() - 1; }
951 /// getArgOperand/setArgOperand - Return/set the i-th call argument.
953 Value *getArgOperand(unsigned i) const { return getOperand(i); }
954 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
956 /// getCallingConv/setCallingConv - Get or set the calling convention of this
958 CallingConv::ID getCallingConv() const {
959 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction() >> 1);
961 void setCallingConv(CallingConv::ID CC) {
962 setInstructionSubclassData((getSubclassDataFromInstruction() & 1) |
963 (static_cast<unsigned>(CC) << 1));
966 /// getAttributes - Return the parameter attributes for this call.
968 const AttrListPtr &getAttributes() const { return AttributeList; }
970 /// setAttributes - Set the parameter attributes for this call.
972 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
974 /// addAttribute - adds the attribute to the list of attributes.
975 void addAttribute(unsigned i, Attributes attr);
977 /// removeAttribute - removes the attribute from the list of attributes.
978 void removeAttribute(unsigned i, Attributes attr);
980 /// @brief Determine whether the call or the callee has the given attribute.
981 bool paramHasAttr(unsigned i, Attributes attr) const;
983 /// @brief Extract the alignment for a call or parameter (0=unknown).
984 unsigned getParamAlignment(unsigned i) const {
985 return AttributeList.getParamAlignment(i);
988 /// @brief Return true if the call should not be inlined.
989 bool isNoInline() const { return paramHasAttr(~0, Attribute::NoInline); }
990 void setIsNoInline(bool Value = true) {
991 if (Value) addAttribute(~0, Attribute::NoInline);
992 else removeAttribute(~0, Attribute::NoInline);
995 /// @brief Determine if the call does not access memory.
996 bool doesNotAccessMemory() const {
997 return paramHasAttr(~0, Attribute::ReadNone);
999 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1000 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
1001 else removeAttribute(~0, Attribute::ReadNone);
1004 /// @brief Determine if the call does not access or only reads memory.
1005 bool onlyReadsMemory() const {
1006 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
1008 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1009 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
1010 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
1013 /// @brief Determine if the call cannot return.
1014 bool doesNotReturn() const { return paramHasAttr(~0, Attribute::NoReturn); }
1015 void setDoesNotReturn(bool DoesNotReturn = true) {
1016 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
1017 else removeAttribute(~0, Attribute::NoReturn);
1020 /// @brief Determine if the call cannot unwind.
1021 bool doesNotThrow() const { return paramHasAttr(~0, Attribute::NoUnwind); }
1022 void setDoesNotThrow(bool DoesNotThrow = true) {
1023 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
1024 else removeAttribute(~0, Attribute::NoUnwind);
1027 /// @brief Determine if the call returns a structure through first
1028 /// pointer argument.
1029 bool hasStructRetAttr() const {
1030 // Be friendly and also check the callee.
1031 return paramHasAttr(1, Attribute::StructRet);
1034 /// @brief Determine if any call argument is an aggregate passed by value.
1035 bool hasByValArgument() const {
1036 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1039 /// getCalledFunction - Return the function called, or null if this is an
1040 /// indirect function invocation.
1042 Function *getCalledFunction() const {
1043 return dyn_cast<Function>(Op<-1>());
1046 /// getCalledValue - Get a pointer to the function that is invoked by this
1048 const Value *getCalledValue() const { return Op<-1>(); }
1049 Value *getCalledValue() { return Op<-1>(); }
1051 /// setCalledFunction - Set the function called.
1052 void setCalledFunction(Value* Fn) {
1056 /// isInlineAsm - Check if this call is an inline asm statement.
1057 bool isInlineAsm() const {
1058 return isa<InlineAsm>(Op<-1>());
1061 // Methods for support type inquiry through isa, cast, and dyn_cast:
1062 static inline bool classof(const CallInst *) { return true; }
1063 static inline bool classof(const Instruction *I) {
1064 return I->getOpcode() == Instruction::Call;
1066 static inline bool classof(const Value *V) {
1067 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1070 // Shadow Instruction::setInstructionSubclassData with a private forwarding
1071 // method so that subclasses cannot accidentally use it.
1072 void setInstructionSubclassData(unsigned short D) {
1073 Instruction::setInstructionSubclassData(D);
1078 struct OperandTraits<CallInst> : public VariadicOperandTraits<1> {
1081 template<typename InputIterator>
1082 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1083 const Twine &NameStr, BasicBlock *InsertAtEnd)
1084 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1085 ->getElementType())->getReturnType(),
1087 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1088 unsigned(ArgEnd - ArgBegin + 1), InsertAtEnd) {
1089 init(Func, ArgBegin, ArgEnd, NameStr,
1090 typename std::iterator_traits<InputIterator>::iterator_category());
1093 template<typename InputIterator>
1094 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1095 const Twine &NameStr, Instruction *InsertBefore)
1096 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1097 ->getElementType())->getReturnType(),
1099 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1100 unsigned(ArgEnd - ArgBegin + 1), InsertBefore) {
1101 init(Func, ArgBegin, ArgEnd, NameStr,
1102 typename std::iterator_traits<InputIterator>::iterator_category());
1106 // Note: if you get compile errors about private methods then
1107 // please update your code to use the high-level operand
1108 // interfaces. See line 943 above.
1109 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1111 //===----------------------------------------------------------------------===//
1113 //===----------------------------------------------------------------------===//
1115 /// SelectInst - This class represents the LLVM 'select' instruction.
1117 class SelectInst : public Instruction {
1118 void init(Value *C, Value *S1, Value *S2) {
1119 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1125 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1126 Instruction *InsertBefore)
1127 : Instruction(S1->getType(), Instruction::Select,
1128 &Op<0>(), 3, InsertBefore) {
1132 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1133 BasicBlock *InsertAtEnd)
1134 : Instruction(S1->getType(), Instruction::Select,
1135 &Op<0>(), 3, InsertAtEnd) {
1140 virtual SelectInst *clone_impl() const;
1142 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1143 const Twine &NameStr = "",
1144 Instruction *InsertBefore = 0) {
1145 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1147 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1148 const Twine &NameStr,
1149 BasicBlock *InsertAtEnd) {
1150 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1153 const Value *getCondition() const { return Op<0>(); }
1154 const Value *getTrueValue() const { return Op<1>(); }
1155 const Value *getFalseValue() const { return Op<2>(); }
1156 Value *getCondition() { return Op<0>(); }
1157 Value *getTrueValue() { return Op<1>(); }
1158 Value *getFalseValue() { return Op<2>(); }
1160 /// areInvalidOperands - Return a string if the specified operands are invalid
1161 /// for a select operation, otherwise return null.
1162 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1164 /// Transparently provide more efficient getOperand methods.
1165 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1167 OtherOps getOpcode() const {
1168 return static_cast<OtherOps>(Instruction::getOpcode());
1171 // Methods for support type inquiry through isa, cast, and dyn_cast:
1172 static inline bool classof(const SelectInst *) { return true; }
1173 static inline bool classof(const Instruction *I) {
1174 return I->getOpcode() == Instruction::Select;
1176 static inline bool classof(const Value *V) {
1177 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1182 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<3> {
1185 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1187 //===----------------------------------------------------------------------===//
1189 //===----------------------------------------------------------------------===//
1191 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1192 /// an argument of the specified type given a va_list and increments that list
1194 class VAArgInst : public UnaryInstruction {
1196 virtual VAArgInst *clone_impl() const;
1199 VAArgInst(Value *List, const Type *Ty, const Twine &NameStr = "",
1200 Instruction *InsertBefore = 0)
1201 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1204 VAArgInst(Value *List, const Type *Ty, const Twine &NameStr,
1205 BasicBlock *InsertAtEnd)
1206 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1210 Value *getPointerOperand() { return getOperand(0); }
1211 const Value *getPointerOperand() const { return getOperand(0); }
1212 static unsigned getPointerOperandIndex() { return 0U; }
1214 // Methods for support type inquiry through isa, cast, and dyn_cast:
1215 static inline bool classof(const VAArgInst *) { return true; }
1216 static inline bool classof(const Instruction *I) {
1217 return I->getOpcode() == VAArg;
1219 static inline bool classof(const Value *V) {
1220 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1224 //===----------------------------------------------------------------------===//
1225 // ExtractElementInst Class
1226 //===----------------------------------------------------------------------===//
1228 /// ExtractElementInst - This instruction extracts a single (scalar)
1229 /// element from a VectorType value
1231 class ExtractElementInst : public Instruction {
1232 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1233 Instruction *InsertBefore = 0);
1234 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1235 BasicBlock *InsertAtEnd);
1237 virtual ExtractElementInst *clone_impl() const;
1240 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1241 const Twine &NameStr = "",
1242 Instruction *InsertBefore = 0) {
1243 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1245 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1246 const Twine &NameStr,
1247 BasicBlock *InsertAtEnd) {
1248 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1251 /// isValidOperands - Return true if an extractelement instruction can be
1252 /// formed with the specified operands.
1253 static bool isValidOperands(const Value *Vec, const Value *Idx);
1255 Value *getVectorOperand() { return Op<0>(); }
1256 Value *getIndexOperand() { return Op<1>(); }
1257 const Value *getVectorOperand() const { return Op<0>(); }
1258 const Value *getIndexOperand() const { return Op<1>(); }
1260 const VectorType *getVectorOperandType() const {
1261 return reinterpret_cast<const VectorType*>(getVectorOperand()->getType());
1265 /// Transparently provide more efficient getOperand methods.
1266 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1268 // Methods for support type inquiry through isa, cast, and dyn_cast:
1269 static inline bool classof(const ExtractElementInst *) { return true; }
1270 static inline bool classof(const Instruction *I) {
1271 return I->getOpcode() == Instruction::ExtractElement;
1273 static inline bool classof(const Value *V) {
1274 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1279 struct OperandTraits<ExtractElementInst> : public FixedNumOperandTraits<2> {
1282 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1284 //===----------------------------------------------------------------------===//
1285 // InsertElementInst Class
1286 //===----------------------------------------------------------------------===//
1288 /// InsertElementInst - This instruction inserts a single (scalar)
1289 /// element into a VectorType value
1291 class InsertElementInst : public Instruction {
1292 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1293 const Twine &NameStr = "",
1294 Instruction *InsertBefore = 0);
1295 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1296 const Twine &NameStr, BasicBlock *InsertAtEnd);
1298 virtual InsertElementInst *clone_impl() const;
1301 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1302 const Twine &NameStr = "",
1303 Instruction *InsertBefore = 0) {
1304 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1306 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1307 const Twine &NameStr,
1308 BasicBlock *InsertAtEnd) {
1309 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1312 /// isValidOperands - Return true if an insertelement instruction can be
1313 /// formed with the specified operands.
1314 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1317 /// getType - Overload to return most specific vector type.
1319 const VectorType *getType() const {
1320 return reinterpret_cast<const VectorType*>(Instruction::getType());
1323 /// Transparently provide more efficient getOperand methods.
1324 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1326 // Methods for support type inquiry through isa, cast, and dyn_cast:
1327 static inline bool classof(const InsertElementInst *) { return true; }
1328 static inline bool classof(const Instruction *I) {
1329 return I->getOpcode() == Instruction::InsertElement;
1331 static inline bool classof(const Value *V) {
1332 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1337 struct OperandTraits<InsertElementInst> : public FixedNumOperandTraits<3> {
1340 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1342 //===----------------------------------------------------------------------===//
1343 // ShuffleVectorInst Class
1344 //===----------------------------------------------------------------------===//
1346 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1349 class ShuffleVectorInst : public Instruction {
1351 virtual ShuffleVectorInst *clone_impl() const;
1354 // allocate space for exactly three operands
1355 void *operator new(size_t s) {
1356 return User::operator new(s, 3);
1358 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1359 const Twine &NameStr = "",
1360 Instruction *InsertBefor = 0);
1361 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1362 const Twine &NameStr, BasicBlock *InsertAtEnd);
1364 /// isValidOperands - Return true if a shufflevector instruction can be
1365 /// formed with the specified operands.
1366 static bool isValidOperands(const Value *V1, const Value *V2,
1369 /// getType - Overload to return most specific vector type.
1371 const VectorType *getType() const {
1372 return reinterpret_cast<const VectorType*>(Instruction::getType());
1375 /// Transparently provide more efficient getOperand methods.
1376 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1378 /// getMaskValue - Return the index from the shuffle mask for the specified
1379 /// output result. This is either -1 if the element is undef or a number less
1380 /// than 2*numelements.
1381 int getMaskValue(unsigned i) const;
1383 // Methods for support type inquiry through isa, cast, and dyn_cast:
1384 static inline bool classof(const ShuffleVectorInst *) { return true; }
1385 static inline bool classof(const Instruction *I) {
1386 return I->getOpcode() == Instruction::ShuffleVector;
1388 static inline bool classof(const Value *V) {
1389 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1394 struct OperandTraits<ShuffleVectorInst> : public FixedNumOperandTraits<3> {
1397 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1399 //===----------------------------------------------------------------------===//
1400 // ExtractValueInst Class
1401 //===----------------------------------------------------------------------===//
1403 /// ExtractValueInst - This instruction extracts a struct member or array
1404 /// element value from an aggregate value.
1406 class ExtractValueInst : public UnaryInstruction {
1407 SmallVector<unsigned, 4> Indices;
1409 ExtractValueInst(const ExtractValueInst &EVI);
1410 void init(const unsigned *Idx, unsigned NumIdx,
1411 const Twine &NameStr);
1412 void init(unsigned Idx, const Twine &NameStr);
1414 template<typename InputIterator>
1415 void init(InputIterator IdxBegin, InputIterator IdxEnd,
1416 const Twine &NameStr,
1417 // This argument ensures that we have an iterator we can
1418 // do arithmetic on in constant time
1419 std::random_access_iterator_tag) {
1420 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1422 // There's no fundamental reason why we require at least one index
1423 // (other than weirdness with &*IdxBegin being invalid; see
1424 // getelementptr's init routine for example). But there's no
1425 // present need to support it.
1426 assert(NumIdx > 0 && "ExtractValueInst must have at least one index");
1428 // This requires that the iterator points to contiguous memory.
1429 init(&*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1430 // we have to build an array here
1433 /// getIndexedType - Returns the type of the element that would be extracted
1434 /// with an extractvalue instruction with the specified parameters.
1436 /// Null is returned if the indices are invalid for the specified
1439 static const Type *getIndexedType(const Type *Agg,
1440 const unsigned *Idx, unsigned NumIdx);
1442 template<typename InputIterator>
1443 static const Type *getIndexedType(const Type *Ptr,
1444 InputIterator IdxBegin,
1445 InputIterator IdxEnd,
1446 // This argument ensures that we
1447 // have an iterator we can do
1448 // arithmetic on in constant time
1449 std::random_access_iterator_tag) {
1450 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1453 // This requires that the iterator points to contiguous memory.
1454 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
1456 return getIndexedType(Ptr, (const unsigned *)0, NumIdx);
1459 /// Constructors - Create a extractvalue instruction with a base aggregate
1460 /// value and a list of indices. The first ctor can optionally insert before
1461 /// an existing instruction, the second appends the new instruction to the
1462 /// specified BasicBlock.
1463 template<typename InputIterator>
1464 inline ExtractValueInst(Value *Agg, InputIterator IdxBegin,
1465 InputIterator IdxEnd,
1466 const Twine &NameStr,
1467 Instruction *InsertBefore);
1468 template<typename InputIterator>
1469 inline ExtractValueInst(Value *Agg,
1470 InputIterator IdxBegin, InputIterator IdxEnd,
1471 const Twine &NameStr, BasicBlock *InsertAtEnd);
1473 // allocate space for exactly one operand
1474 void *operator new(size_t s) {
1475 return User::operator new(s, 1);
1478 virtual ExtractValueInst *clone_impl() const;
1481 template<typename InputIterator>
1482 static ExtractValueInst *Create(Value *Agg, InputIterator IdxBegin,
1483 InputIterator IdxEnd,
1484 const Twine &NameStr = "",
1485 Instruction *InsertBefore = 0) {
1487 ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertBefore);
1489 template<typename InputIterator>
1490 static ExtractValueInst *Create(Value *Agg,
1491 InputIterator IdxBegin, InputIterator IdxEnd,
1492 const Twine &NameStr,
1493 BasicBlock *InsertAtEnd) {
1494 return new ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertAtEnd);
1497 /// Constructors - These two creators are convenience methods because one
1498 /// index extractvalue instructions are much more common than those with
1500 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1501 const Twine &NameStr = "",
1502 Instruction *InsertBefore = 0) {
1503 unsigned Idxs[1] = { Idx };
1504 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertBefore);
1506 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1507 const Twine &NameStr,
1508 BasicBlock *InsertAtEnd) {
1509 unsigned Idxs[1] = { Idx };
1510 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertAtEnd);
1513 /// getIndexedType - Returns the type of the element that would be extracted
1514 /// with an extractvalue instruction with the specified parameters.
1516 /// Null is returned if the indices are invalid for the specified
1519 template<typename InputIterator>
1520 static const Type *getIndexedType(const Type *Ptr,
1521 InputIterator IdxBegin,
1522 InputIterator IdxEnd) {
1523 return getIndexedType(Ptr, IdxBegin, IdxEnd,
1524 typename std::iterator_traits<InputIterator>::
1525 iterator_category());
1527 static const Type *getIndexedType(const Type *Ptr, unsigned Idx);
1529 typedef const unsigned* idx_iterator;
1530 inline idx_iterator idx_begin() const { return Indices.begin(); }
1531 inline idx_iterator idx_end() const { return Indices.end(); }
1533 Value *getAggregateOperand() {
1534 return getOperand(0);
1536 const Value *getAggregateOperand() const {
1537 return getOperand(0);
1539 static unsigned getAggregateOperandIndex() {
1540 return 0U; // get index for modifying correct operand
1543 unsigned getNumIndices() const { // Note: always non-negative
1544 return (unsigned)Indices.size();
1547 bool hasIndices() const {
1551 // Methods for support type inquiry through isa, cast, and dyn_cast:
1552 static inline bool classof(const ExtractValueInst *) { return true; }
1553 static inline bool classof(const Instruction *I) {
1554 return I->getOpcode() == Instruction::ExtractValue;
1556 static inline bool classof(const Value *V) {
1557 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1561 template<typename InputIterator>
1562 ExtractValueInst::ExtractValueInst(Value *Agg,
1563 InputIterator IdxBegin,
1564 InputIterator IdxEnd,
1565 const Twine &NameStr,
1566 Instruction *InsertBefore)
1567 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1569 ExtractValue, Agg, InsertBefore) {
1570 init(IdxBegin, IdxEnd, NameStr,
1571 typename std::iterator_traits<InputIterator>::iterator_category());
1573 template<typename InputIterator>
1574 ExtractValueInst::ExtractValueInst(Value *Agg,
1575 InputIterator IdxBegin,
1576 InputIterator IdxEnd,
1577 const Twine &NameStr,
1578 BasicBlock *InsertAtEnd)
1579 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1581 ExtractValue, Agg, InsertAtEnd) {
1582 init(IdxBegin, IdxEnd, NameStr,
1583 typename std::iterator_traits<InputIterator>::iterator_category());
1587 //===----------------------------------------------------------------------===//
1588 // InsertValueInst Class
1589 //===----------------------------------------------------------------------===//
1591 /// InsertValueInst - This instruction inserts a struct field of array element
1592 /// value into an aggregate value.
1594 class InsertValueInst : public Instruction {
1595 SmallVector<unsigned, 4> Indices;
1597 void *operator new(size_t, unsigned); // Do not implement
1598 InsertValueInst(const InsertValueInst &IVI);
1599 void init(Value *Agg, Value *Val, const unsigned *Idx, unsigned NumIdx,
1600 const Twine &NameStr);
1601 void init(Value *Agg, Value *Val, unsigned Idx, const Twine &NameStr);
1603 template<typename InputIterator>
1604 void init(Value *Agg, Value *Val,
1605 InputIterator IdxBegin, InputIterator IdxEnd,
1606 const Twine &NameStr,
1607 // This argument ensures that we have an iterator we can
1608 // do arithmetic on in constant time
1609 std::random_access_iterator_tag) {
1610 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1612 // There's no fundamental reason why we require at least one index
1613 // (other than weirdness with &*IdxBegin being invalid; see
1614 // getelementptr's init routine for example). But there's no
1615 // present need to support it.
1616 assert(NumIdx > 0 && "InsertValueInst must have at least one index");
1618 // This requires that the iterator points to contiguous memory.
1619 init(Agg, Val, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1620 // we have to build an array here
1623 /// Constructors - Create a insertvalue instruction with a base aggregate
1624 /// value, a value to insert, and a list of indices. The first ctor can
1625 /// optionally insert before an existing instruction, the second appends
1626 /// the new instruction to the specified BasicBlock.
1627 template<typename InputIterator>
1628 inline InsertValueInst(Value *Agg, Value *Val, InputIterator IdxBegin,
1629 InputIterator IdxEnd,
1630 const Twine &NameStr,
1631 Instruction *InsertBefore);
1632 template<typename InputIterator>
1633 inline InsertValueInst(Value *Agg, Value *Val,
1634 InputIterator IdxBegin, InputIterator IdxEnd,
1635 const Twine &NameStr, BasicBlock *InsertAtEnd);
1637 /// Constructors - These two constructors are convenience methods because one
1638 /// and two index insertvalue instructions are so common.
1639 InsertValueInst(Value *Agg, Value *Val,
1640 unsigned Idx, const Twine &NameStr = "",
1641 Instruction *InsertBefore = 0);
1642 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1643 const Twine &NameStr, BasicBlock *InsertAtEnd);
1645 virtual InsertValueInst *clone_impl() const;
1647 // allocate space for exactly two operands
1648 void *operator new(size_t s) {
1649 return User::operator new(s, 2);
1652 template<typename InputIterator>
1653 static InsertValueInst *Create(Value *Agg, Value *Val, InputIterator IdxBegin,
1654 InputIterator IdxEnd,
1655 const Twine &NameStr = "",
1656 Instruction *InsertBefore = 0) {
1657 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1658 NameStr, InsertBefore);
1660 template<typename InputIterator>
1661 static InsertValueInst *Create(Value *Agg, Value *Val,
1662 InputIterator IdxBegin, InputIterator IdxEnd,
1663 const Twine &NameStr,
1664 BasicBlock *InsertAtEnd) {
1665 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1666 NameStr, InsertAtEnd);
1669 /// Constructors - These two creators are convenience methods because one
1670 /// index insertvalue instructions are much more common than those with
1672 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1673 const Twine &NameStr = "",
1674 Instruction *InsertBefore = 0) {
1675 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertBefore);
1677 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1678 const Twine &NameStr,
1679 BasicBlock *InsertAtEnd) {
1680 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertAtEnd);
1683 /// Transparently provide more efficient getOperand methods.
1684 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1686 typedef const unsigned* idx_iterator;
1687 inline idx_iterator idx_begin() const { return Indices.begin(); }
1688 inline idx_iterator idx_end() const { return Indices.end(); }
1690 Value *getAggregateOperand() {
1691 return getOperand(0);
1693 const Value *getAggregateOperand() const {
1694 return getOperand(0);
1696 static unsigned getAggregateOperandIndex() {
1697 return 0U; // get index for modifying correct operand
1700 Value *getInsertedValueOperand() {
1701 return getOperand(1);
1703 const Value *getInsertedValueOperand() const {
1704 return getOperand(1);
1706 static unsigned getInsertedValueOperandIndex() {
1707 return 1U; // get index for modifying correct operand
1710 unsigned getNumIndices() const { // Note: always non-negative
1711 return (unsigned)Indices.size();
1714 bool hasIndices() const {
1718 // Methods for support type inquiry through isa, cast, and dyn_cast:
1719 static inline bool classof(const InsertValueInst *) { return true; }
1720 static inline bool classof(const Instruction *I) {
1721 return I->getOpcode() == Instruction::InsertValue;
1723 static inline bool classof(const Value *V) {
1724 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1729 struct OperandTraits<InsertValueInst> : public FixedNumOperandTraits<2> {
1732 template<typename InputIterator>
1733 InsertValueInst::InsertValueInst(Value *Agg,
1735 InputIterator IdxBegin,
1736 InputIterator IdxEnd,
1737 const Twine &NameStr,
1738 Instruction *InsertBefore)
1739 : Instruction(Agg->getType(), InsertValue,
1740 OperandTraits<InsertValueInst>::op_begin(this),
1742 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1743 typename std::iterator_traits<InputIterator>::iterator_category());
1745 template<typename InputIterator>
1746 InsertValueInst::InsertValueInst(Value *Agg,
1748 InputIterator IdxBegin,
1749 InputIterator IdxEnd,
1750 const Twine &NameStr,
1751 BasicBlock *InsertAtEnd)
1752 : Instruction(Agg->getType(), InsertValue,
1753 OperandTraits<InsertValueInst>::op_begin(this),
1755 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1756 typename std::iterator_traits<InputIterator>::iterator_category());
1759 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1761 //===----------------------------------------------------------------------===//
1763 //===----------------------------------------------------------------------===//
1765 // PHINode - The PHINode class is used to represent the magical mystical PHI
1766 // node, that can not exist in nature, but can be synthesized in a computer
1767 // scientist's overactive imagination.
1769 class PHINode : public Instruction {
1770 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1771 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1772 /// the number actually in use.
1773 unsigned ReservedSpace;
1774 PHINode(const PHINode &PN);
1775 // allocate space for exactly zero operands
1776 void *operator new(size_t s) {
1777 return User::operator new(s, 0);
1779 explicit PHINode(const Type *Ty, const Twine &NameStr = "",
1780 Instruction *InsertBefore = 0)
1781 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1786 PHINode(const Type *Ty, const Twine &NameStr, BasicBlock *InsertAtEnd)
1787 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1792 virtual PHINode *clone_impl() const;
1794 static PHINode *Create(const Type *Ty, const Twine &NameStr = "",
1795 Instruction *InsertBefore = 0) {
1796 return new PHINode(Ty, NameStr, InsertBefore);
1798 static PHINode *Create(const Type *Ty, const Twine &NameStr,
1799 BasicBlock *InsertAtEnd) {
1800 return new PHINode(Ty, NameStr, InsertAtEnd);
1804 /// reserveOperandSpace - This method can be used to avoid repeated
1805 /// reallocation of PHI operand lists by reserving space for the correct
1806 /// number of operands before adding them. Unlike normal vector reserves,
1807 /// this method can also be used to trim the operand space.
1808 void reserveOperandSpace(unsigned NumValues) {
1809 resizeOperands(NumValues*2);
1812 /// Provide fast operand accessors
1813 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1815 /// getNumIncomingValues - Return the number of incoming edges
1817 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1819 /// getIncomingValue - Return incoming value number x
1821 Value *getIncomingValue(unsigned i) const {
1822 assert(i*2 < getNumOperands() && "Invalid value number!");
1823 return getOperand(i*2);
1825 void setIncomingValue(unsigned i, Value *V) {
1826 assert(i*2 < getNumOperands() && "Invalid value number!");
1829 static unsigned getOperandNumForIncomingValue(unsigned i) {
1832 static unsigned getIncomingValueNumForOperand(unsigned i) {
1833 assert(i % 2 == 0 && "Invalid incoming-value operand index!");
1837 /// getIncomingBlock - Return incoming basic block number @p i.
1839 BasicBlock *getIncomingBlock(unsigned i) const {
1840 return cast<BasicBlock>(getOperand(i*2+1));
1843 /// getIncomingBlock - Return incoming basic block corresponding
1844 /// to an operand of the PHI.
1846 BasicBlock *getIncomingBlock(const Use &U) const {
1847 assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?");
1848 return cast<BasicBlock>((&U + 1)->get());
1851 /// getIncomingBlock - Return incoming basic block corresponding
1852 /// to value use iterator.
1854 template <typename U>
1855 BasicBlock *getIncomingBlock(value_use_iterator<U> I) const {
1856 return getIncomingBlock(I.getUse());
1860 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1861 setOperand(i*2+1, (Value*)BB);
1863 static unsigned getOperandNumForIncomingBlock(unsigned i) {
1866 static unsigned getIncomingBlockNumForOperand(unsigned i) {
1867 assert(i % 2 == 1 && "Invalid incoming-block operand index!");
1871 /// addIncoming - Add an incoming value to the end of the PHI list
1873 void addIncoming(Value *V, BasicBlock *BB) {
1874 assert(V && "PHI node got a null value!");
1875 assert(BB && "PHI node got a null basic block!");
1876 assert(getType() == V->getType() &&
1877 "All operands to PHI node must be the same type as the PHI node!");
1878 unsigned OpNo = NumOperands;
1879 if (OpNo+2 > ReservedSpace)
1880 resizeOperands(0); // Get more space!
1881 // Initialize some new operands.
1882 NumOperands = OpNo+2;
1883 OperandList[OpNo] = V;
1884 OperandList[OpNo+1] = (Value*)BB;
1887 /// removeIncomingValue - Remove an incoming value. This is useful if a
1888 /// predecessor basic block is deleted. The value removed is returned.
1890 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1891 /// is true), the PHI node is destroyed and any uses of it are replaced with
1892 /// dummy values. The only time there should be zero incoming values to a PHI
1893 /// node is when the block is dead, so this strategy is sound.
1895 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1897 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
1898 int Idx = getBasicBlockIndex(BB);
1899 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1900 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1903 /// getBasicBlockIndex - Return the first index of the specified basic
1904 /// block in the value list for this PHI. Returns -1 if no instance.
1906 int getBasicBlockIndex(const BasicBlock *BB) const {
1907 Use *OL = OperandList;
1908 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1909 if (OL[i+1].get() == (const Value*)BB) return i/2;
1913 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1914 return getIncomingValue(getBasicBlockIndex(BB));
1917 /// hasConstantValue - If the specified PHI node always merges together the
1918 /// same value, return the value, otherwise return null.
1920 /// If the PHI has undef operands, but all the rest of the operands are
1921 /// some unique value, return that value if it can be proved that the
1922 /// value dominates the PHI. If DT is null, use a conservative check,
1923 /// otherwise use DT to test for dominance.
1925 Value *hasConstantValue(DominatorTree *DT = 0) const;
1927 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1928 static inline bool classof(const PHINode *) { return true; }
1929 static inline bool classof(const Instruction *I) {
1930 return I->getOpcode() == Instruction::PHI;
1932 static inline bool classof(const Value *V) {
1933 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1936 void resizeOperands(unsigned NumOperands);
1940 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
1943 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
1946 //===----------------------------------------------------------------------===//
1948 //===----------------------------------------------------------------------===//
1950 //===---------------------------------------------------------------------------
1951 /// ReturnInst - Return a value (possibly void), from a function. Execution
1952 /// does not continue in this function any longer.
1954 class ReturnInst : public TerminatorInst {
1955 ReturnInst(const ReturnInst &RI);
1958 // ReturnInst constructors:
1959 // ReturnInst() - 'ret void' instruction
1960 // ReturnInst( null) - 'ret void' instruction
1961 // ReturnInst(Value* X) - 'ret X' instruction
1962 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
1963 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
1964 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
1965 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
1967 // NOTE: If the Value* passed is of type void then the constructor behaves as
1968 // if it was passed NULL.
1969 explicit ReturnInst(LLVMContext &C, Value *retVal = 0,
1970 Instruction *InsertBefore = 0);
1971 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
1972 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
1974 virtual ReturnInst *clone_impl() const;
1976 static ReturnInst* Create(LLVMContext &C, Value *retVal = 0,
1977 Instruction *InsertBefore = 0) {
1978 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
1980 static ReturnInst* Create(LLVMContext &C, Value *retVal,
1981 BasicBlock *InsertAtEnd) {
1982 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
1984 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
1985 return new(0) ReturnInst(C, InsertAtEnd);
1987 virtual ~ReturnInst();
1989 /// Provide fast operand accessors
1990 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1992 /// Convenience accessor
1993 Value *getReturnValue(unsigned n = 0) const {
1994 return n < getNumOperands()
1999 unsigned getNumSuccessors() const { return 0; }
2001 // Methods for support type inquiry through isa, cast, and dyn_cast:
2002 static inline bool classof(const ReturnInst *) { return true; }
2003 static inline bool classof(const Instruction *I) {
2004 return (I->getOpcode() == Instruction::Ret);
2006 static inline bool classof(const Value *V) {
2007 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2010 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2011 virtual unsigned getNumSuccessorsV() const;
2012 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2016 struct OperandTraits<ReturnInst> : public VariadicOperandTraits<> {
2019 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2021 //===----------------------------------------------------------------------===//
2023 //===----------------------------------------------------------------------===//
2025 //===---------------------------------------------------------------------------
2026 /// BranchInst - Conditional or Unconditional Branch instruction.
2028 class BranchInst : public TerminatorInst {
2029 /// Ops list - Branches are strange. The operands are ordered:
2030 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2031 /// they don't have to check for cond/uncond branchness. These are mostly
2032 /// accessed relative from op_end().
2033 BranchInst(const BranchInst &BI);
2035 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2036 // BranchInst(BB *B) - 'br B'
2037 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2038 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2039 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2040 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2041 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2042 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2043 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2044 Instruction *InsertBefore = 0);
2045 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2046 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2047 BasicBlock *InsertAtEnd);
2049 virtual BranchInst *clone_impl() const;
2051 static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2052 return new(1, true) BranchInst(IfTrue, InsertBefore);
2054 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2055 Value *Cond, Instruction *InsertBefore = 0) {
2056 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2058 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2059 return new(1, true) BranchInst(IfTrue, InsertAtEnd);
2061 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2062 Value *Cond, BasicBlock *InsertAtEnd) {
2063 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2068 /// Transparently provide more efficient getOperand methods.
2069 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2071 bool isUnconditional() const { return getNumOperands() == 1; }
2072 bool isConditional() const { return getNumOperands() == 3; }
2074 Value *getCondition() const {
2075 assert(isConditional() && "Cannot get condition of an uncond branch!");
2079 void setCondition(Value *V) {
2080 assert(isConditional() && "Cannot set condition of unconditional branch!");
2084 // setUnconditionalDest - Change the current branch to an unconditional branch
2085 // targeting the specified block.
2086 // FIXME: Eliminate this ugly method.
2087 void setUnconditionalDest(BasicBlock *Dest) {
2088 Op<-1>() = (Value*)Dest;
2089 if (isConditional()) { // Convert this to an uncond branch.
2093 OperandList = op_begin();
2097 unsigned getNumSuccessors() const { return 1+isConditional(); }
2099 BasicBlock *getSuccessor(unsigned i) const {
2100 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2101 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2104 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2105 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2106 *(&Op<-1>() - idx) = (Value*)NewSucc;
2109 // Methods for support type inquiry through isa, cast, and dyn_cast:
2110 static inline bool classof(const BranchInst *) { return true; }
2111 static inline bool classof(const Instruction *I) {
2112 return (I->getOpcode() == Instruction::Br);
2114 static inline bool classof(const Value *V) {
2115 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2118 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2119 virtual unsigned getNumSuccessorsV() const;
2120 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2124 struct OperandTraits<BranchInst> : public VariadicOperandTraits<1> {};
2126 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2128 //===----------------------------------------------------------------------===//
2130 //===----------------------------------------------------------------------===//
2132 //===---------------------------------------------------------------------------
2133 /// SwitchInst - Multiway switch
2135 class SwitchInst : public TerminatorInst {
2136 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2137 unsigned ReservedSpace;
2138 // Operand[0] = Value to switch on
2139 // Operand[1] = Default basic block destination
2140 // Operand[2n ] = Value to match
2141 // Operand[2n+1] = BasicBlock to go to on match
2142 SwitchInst(const SwitchInst &SI);
2143 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
2144 void resizeOperands(unsigned No);
2145 // allocate space for exactly zero operands
2146 void *operator new(size_t s) {
2147 return User::operator new(s, 0);
2149 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2150 /// switch on and a default destination. The number of additional cases can
2151 /// be specified here to make memory allocation more efficient. This
2152 /// constructor can also autoinsert before another instruction.
2153 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2154 Instruction *InsertBefore);
2156 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2157 /// switch on and a default destination. The number of additional cases can
2158 /// be specified here to make memory allocation more efficient. This
2159 /// constructor also autoinserts at the end of the specified BasicBlock.
2160 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2161 BasicBlock *InsertAtEnd);
2163 virtual SwitchInst *clone_impl() const;
2165 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2166 unsigned NumCases, Instruction *InsertBefore = 0) {
2167 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2169 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2170 unsigned NumCases, BasicBlock *InsertAtEnd) {
2171 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2175 /// Provide fast operand accessors
2176 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2178 // Accessor Methods for Switch stmt
2179 Value *getCondition() const { return getOperand(0); }
2180 void setCondition(Value *V) { setOperand(0, V); }
2182 BasicBlock *getDefaultDest() const {
2183 return cast<BasicBlock>(getOperand(1));
2186 /// getNumCases - return the number of 'cases' in this switch instruction.
2187 /// Note that case #0 is always the default case.
2188 unsigned getNumCases() const {
2189 return getNumOperands()/2;
2192 /// getCaseValue - Return the specified case value. Note that case #0, the
2193 /// default destination, does not have a case value.
2194 ConstantInt *getCaseValue(unsigned i) {
2195 assert(i && i < getNumCases() && "Illegal case value to get!");
2196 return getSuccessorValue(i);
2199 /// getCaseValue - Return the specified case value. Note that case #0, the
2200 /// default destination, does not have a case value.
2201 const ConstantInt *getCaseValue(unsigned i) const {
2202 assert(i && i < getNumCases() && "Illegal case value to get!");
2203 return getSuccessorValue(i);
2206 /// findCaseValue - Search all of the case values for the specified constant.
2207 /// If it is explicitly handled, return the case number of it, otherwise
2208 /// return 0 to indicate that it is handled by the default handler.
2209 unsigned findCaseValue(const ConstantInt *C) const {
2210 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
2211 if (getCaseValue(i) == C)
2216 /// findCaseDest - Finds the unique case value for a given successor. Returns
2217 /// null if the successor is not found, not unique, or is the default case.
2218 ConstantInt *findCaseDest(BasicBlock *BB) {
2219 if (BB == getDefaultDest()) return NULL;
2221 ConstantInt *CI = NULL;
2222 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
2223 if (getSuccessor(i) == BB) {
2224 if (CI) return NULL; // Multiple cases lead to BB.
2225 else CI = getCaseValue(i);
2231 /// addCase - Add an entry to the switch instruction...
2233 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2235 /// removeCase - This method removes the specified successor from the switch
2236 /// instruction. Note that this cannot be used to remove the default
2237 /// destination (successor #0).
2239 void removeCase(unsigned idx);
2241 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2242 BasicBlock *getSuccessor(unsigned idx) const {
2243 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2244 return cast<BasicBlock>(getOperand(idx*2+1));
2246 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2247 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2248 setOperand(idx*2+1, (Value*)NewSucc);
2251 // getSuccessorValue - Return the value associated with the specified
2253 ConstantInt *getSuccessorValue(unsigned idx) const {
2254 assert(idx < getNumSuccessors() && "Successor # out of range!");
2255 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
2258 // Methods for support type inquiry through isa, cast, and dyn_cast:
2259 static inline bool classof(const SwitchInst *) { return true; }
2260 static inline bool classof(const Instruction *I) {
2261 return I->getOpcode() == Instruction::Switch;
2263 static inline bool classof(const Value *V) {
2264 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2267 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2268 virtual unsigned getNumSuccessorsV() const;
2269 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2273 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2276 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2279 //===----------------------------------------------------------------------===//
2280 // IndirectBrInst Class
2281 //===----------------------------------------------------------------------===//
2283 //===---------------------------------------------------------------------------
2284 /// IndirectBrInst - Indirect Branch Instruction.
2286 class IndirectBrInst : public TerminatorInst {
2287 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2288 unsigned ReservedSpace;
2289 // Operand[0] = Value to switch on
2290 // Operand[1] = Default basic block destination
2291 // Operand[2n ] = Value to match
2292 // Operand[2n+1] = BasicBlock to go to on match
2293 IndirectBrInst(const IndirectBrInst &IBI);
2294 void init(Value *Address, unsigned NumDests);
2295 void resizeOperands(unsigned No);
2296 // allocate space for exactly zero operands
2297 void *operator new(size_t s) {
2298 return User::operator new(s, 0);
2300 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2301 /// Address to jump to. The number of expected destinations can be specified
2302 /// here to make memory allocation more efficient. This constructor can also
2303 /// autoinsert before another instruction.
2304 IndirectBrInst(Value *Address, unsigned NumDests, Instruction *InsertBefore);
2306 /// IndirectBrInst ctor - Create a new indirectbr instruction, specifying an
2307 /// Address to jump to. The number of expected destinations can be specified
2308 /// here to make memory allocation more efficient. This constructor also
2309 /// autoinserts at the end of the specified BasicBlock.
2310 IndirectBrInst(Value *Address, unsigned NumDests, BasicBlock *InsertAtEnd);
2312 virtual IndirectBrInst *clone_impl() const;
2314 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2315 Instruction *InsertBefore = 0) {
2316 return new IndirectBrInst(Address, NumDests, InsertBefore);
2318 static IndirectBrInst *Create(Value *Address, unsigned NumDests,
2319 BasicBlock *InsertAtEnd) {
2320 return new IndirectBrInst(Address, NumDests, InsertAtEnd);
2324 /// Provide fast operand accessors.
2325 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2327 // Accessor Methods for IndirectBrInst instruction.
2328 Value *getAddress() { return getOperand(0); }
2329 const Value *getAddress() const { return getOperand(0); }
2330 void setAddress(Value *V) { setOperand(0, V); }
2333 /// getNumDestinations - return the number of possible destinations in this
2334 /// indirectbr instruction.
2335 unsigned getNumDestinations() const { return getNumOperands()-1; }
2337 /// getDestination - Return the specified destination.
2338 BasicBlock *getDestination(unsigned i) { return getSuccessor(i); }
2339 const BasicBlock *getDestination(unsigned i) const { return getSuccessor(i); }
2341 /// addDestination - Add a destination.
2343 void addDestination(BasicBlock *Dest);
2345 /// removeDestination - This method removes the specified successor from the
2346 /// indirectbr instruction.
2347 void removeDestination(unsigned i);
2349 unsigned getNumSuccessors() const { return getNumOperands()-1; }
2350 BasicBlock *getSuccessor(unsigned i) const {
2351 return cast<BasicBlock>(getOperand(i+1));
2353 void setSuccessor(unsigned i, BasicBlock *NewSucc) {
2354 setOperand(i+1, (Value*)NewSucc);
2357 // Methods for support type inquiry through isa, cast, and dyn_cast:
2358 static inline bool classof(const IndirectBrInst *) { return true; }
2359 static inline bool classof(const Instruction *I) {
2360 return I->getOpcode() == Instruction::IndirectBr;
2362 static inline bool classof(const Value *V) {
2363 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2366 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2367 virtual unsigned getNumSuccessorsV() const;
2368 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2372 struct OperandTraits<IndirectBrInst> : public HungoffOperandTraits<1> {
2375 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(IndirectBrInst, Value)
2378 //===----------------------------------------------------------------------===//
2380 //===----------------------------------------------------------------------===//
2382 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
2383 /// calling convention of the call.
2385 class InvokeInst : public TerminatorInst {
2386 AttrListPtr AttributeList;
2387 InvokeInst(const InvokeInst &BI);
2388 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
2389 Value* const *Args, unsigned NumArgs);
2391 template<typename InputIterator>
2392 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2393 InputIterator ArgBegin, InputIterator ArgEnd,
2394 const Twine &NameStr,
2395 // This argument ensures that we have an iterator we can
2396 // do arithmetic on in constant time
2397 std::random_access_iterator_tag) {
2398 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
2400 // This requires that the iterator points to contiguous memory.
2401 init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
2405 /// Construct an InvokeInst given a range of arguments.
2406 /// InputIterator must be a random-access iterator pointing to
2407 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2408 /// made for random-accessness but not for contiguous storage as
2409 /// that would incur runtime overhead.
2411 /// @brief Construct an InvokeInst from a range of arguments
2412 template<typename InputIterator>
2413 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2414 InputIterator ArgBegin, InputIterator ArgEnd,
2416 const Twine &NameStr, Instruction *InsertBefore);
2418 /// Construct an InvokeInst given a range of arguments.
2419 /// InputIterator must be a random-access iterator pointing to
2420 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2421 /// made for random-accessness but not for contiguous storage as
2422 /// that would incur runtime overhead.
2424 /// @brief Construct an InvokeInst from a range of arguments
2425 template<typename InputIterator>
2426 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2427 InputIterator ArgBegin, InputIterator ArgEnd,
2429 const Twine &NameStr, BasicBlock *InsertAtEnd);
2431 virtual InvokeInst *clone_impl() const;
2433 template<typename InputIterator>
2434 static InvokeInst *Create(Value *Func,
2435 BasicBlock *IfNormal, BasicBlock *IfException,
2436 InputIterator ArgBegin, InputIterator ArgEnd,
2437 const Twine &NameStr = "",
2438 Instruction *InsertBefore = 0) {
2439 unsigned Values(ArgEnd - ArgBegin + 3);
2440 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2441 Values, NameStr, InsertBefore);
2443 template<typename InputIterator>
2444 static InvokeInst *Create(Value *Func,
2445 BasicBlock *IfNormal, BasicBlock *IfException,
2446 InputIterator ArgBegin, InputIterator ArgEnd,
2447 const Twine &NameStr,
2448 BasicBlock *InsertAtEnd) {
2449 unsigned Values(ArgEnd - ArgBegin + 3);
2450 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2451 Values, NameStr, InsertAtEnd);
2454 /// Provide fast operand accessors
2455 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2457 /// getNumArgOperands - Return the number of invoke arguments.
2459 unsigned getNumArgOperands() const { return getNumOperands() - 3; }
2461 /// getArgOperand/setArgOperand - Return/set the i-th invoke argument.
2463 Value *getArgOperand(unsigned i) const { return getOperand(i); }
2464 void setArgOperand(unsigned i, Value *v) { setOperand(i, v); }
2466 /// getCallingConv/setCallingConv - Get or set the calling convention of this
2468 CallingConv::ID getCallingConv() const {
2469 return static_cast<CallingConv::ID>(getSubclassDataFromInstruction());
2471 void setCallingConv(CallingConv::ID CC) {
2472 setInstructionSubclassData(static_cast<unsigned>(CC));
2475 /// getAttributes - Return the parameter attributes for this invoke.
2477 const AttrListPtr &getAttributes() const { return AttributeList; }
2479 /// setAttributes - Set the parameter attributes for this invoke.
2481 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
2483 /// addAttribute - adds the attribute to the list of attributes.
2484 void addAttribute(unsigned i, Attributes attr);
2486 /// removeAttribute - removes the attribute from the list of attributes.
2487 void removeAttribute(unsigned i, Attributes attr);
2489 /// @brief Determine whether the call or the callee has the given attribute.
2490 bool paramHasAttr(unsigned i, Attributes attr) const;
2492 /// @brief Extract the alignment for a call or parameter (0=unknown).
2493 unsigned getParamAlignment(unsigned i) const {
2494 return AttributeList.getParamAlignment(i);
2497 /// @brief Return true if the call should not be inlined.
2498 bool isNoInline() const { return paramHasAttr(~0, Attribute::NoInline); }
2499 void setIsNoInline(bool Value = true) {
2500 if (Value) addAttribute(~0, Attribute::NoInline);
2501 else removeAttribute(~0, Attribute::NoInline);
2504 /// @brief Determine if the call does not access memory.
2505 bool doesNotAccessMemory() const {
2506 return paramHasAttr(~0, Attribute::ReadNone);
2508 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
2509 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
2510 else removeAttribute(~0, Attribute::ReadNone);
2513 /// @brief Determine if the call does not access or only reads memory.
2514 bool onlyReadsMemory() const {
2515 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
2517 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
2518 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
2519 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
2522 /// @brief Determine if the call cannot return.
2523 bool doesNotReturn() const { return paramHasAttr(~0, Attribute::NoReturn); }
2524 void setDoesNotReturn(bool DoesNotReturn = true) {
2525 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
2526 else removeAttribute(~0, Attribute::NoReturn);
2529 /// @brief Determine if the call cannot unwind.
2530 bool doesNotThrow() const { return paramHasAttr(~0, Attribute::NoUnwind); }
2531 void setDoesNotThrow(bool DoesNotThrow = true) {
2532 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
2533 else removeAttribute(~0, Attribute::NoUnwind);
2536 /// @brief Determine if the call returns a structure through first
2537 /// pointer argument.
2538 bool hasStructRetAttr() const {
2539 // Be friendly and also check the callee.
2540 return paramHasAttr(1, Attribute::StructRet);
2543 /// @brief Determine if any call argument is an aggregate passed by value.
2544 bool hasByValArgument() const {
2545 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
2548 /// getCalledFunction - Return the function called, or null if this is an
2549 /// indirect function invocation.
2551 Function *getCalledFunction() const {
2552 return dyn_cast<Function>(Op<-3>());
2555 /// getCalledValue - Get a pointer to the function that is invoked by this
2557 const Value *getCalledValue() const { return Op<-3>(); }
2558 Value *getCalledValue() { return Op<-3>(); }
2560 /// setCalledFunction - Set the function called.
2561 void setCalledFunction(Value* Fn) {
2565 // get*Dest - Return the destination basic blocks...
2566 BasicBlock *getNormalDest() const {
2567 return cast<BasicBlock>(Op<-2>());
2569 BasicBlock *getUnwindDest() const {
2570 return cast<BasicBlock>(Op<-1>());
2572 void setNormalDest(BasicBlock *B) {
2573 Op<-2>() = reinterpret_cast<Value*>(B);
2575 void setUnwindDest(BasicBlock *B) {
2576 Op<-1>() = reinterpret_cast<Value*>(B);
2579 BasicBlock *getSuccessor(unsigned i) const {
2580 assert(i < 2 && "Successor # out of range for invoke!");
2581 return i == 0 ? getNormalDest() : getUnwindDest();
2584 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2585 assert(idx < 2 && "Successor # out of range for invoke!");
2586 *(&Op<-2>() + idx) = reinterpret_cast<Value*>(NewSucc);
2589 unsigned getNumSuccessors() const { return 2; }
2591 // Methods for support type inquiry through isa, cast, and dyn_cast:
2592 static inline bool classof(const InvokeInst *) { return true; }
2593 static inline bool classof(const Instruction *I) {
2594 return (I->getOpcode() == Instruction::Invoke);
2596 static inline bool classof(const Value *V) {
2597 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2601 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2602 virtual unsigned getNumSuccessorsV() const;
2603 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2605 // Shadow Instruction::setInstructionSubclassData with a private forwarding
2606 // method so that subclasses cannot accidentally use it.
2607 void setInstructionSubclassData(unsigned short D) {
2608 Instruction::setInstructionSubclassData(D);
2613 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<3> {
2616 template<typename InputIterator>
2617 InvokeInst::InvokeInst(Value *Func,
2618 BasicBlock *IfNormal, BasicBlock *IfException,
2619 InputIterator ArgBegin, InputIterator ArgEnd,
2621 const Twine &NameStr, Instruction *InsertBefore)
2622 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2623 ->getElementType())->getReturnType(),
2624 Instruction::Invoke,
2625 OperandTraits<InvokeInst>::op_end(this) - Values,
2626 Values, InsertBefore) {
2627 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2628 typename std::iterator_traits<InputIterator>::iterator_category());
2630 template<typename InputIterator>
2631 InvokeInst::InvokeInst(Value *Func,
2632 BasicBlock *IfNormal, BasicBlock *IfException,
2633 InputIterator ArgBegin, InputIterator ArgEnd,
2635 const Twine &NameStr, BasicBlock *InsertAtEnd)
2636 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2637 ->getElementType())->getReturnType(),
2638 Instruction::Invoke,
2639 OperandTraits<InvokeInst>::op_end(this) - Values,
2640 Values, InsertAtEnd) {
2641 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2642 typename std::iterator_traits<InputIterator>::iterator_category());
2645 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
2647 //===----------------------------------------------------------------------===//
2649 //===----------------------------------------------------------------------===//
2651 //===---------------------------------------------------------------------------
2652 /// UnwindInst - Immediately exit the current function, unwinding the stack
2653 /// until an invoke instruction is found.
2655 class UnwindInst : public TerminatorInst {
2656 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2658 virtual UnwindInst *clone_impl() const;
2660 // allocate space for exactly zero operands
2661 void *operator new(size_t s) {
2662 return User::operator new(s, 0);
2664 explicit UnwindInst(LLVMContext &C, Instruction *InsertBefore = 0);
2665 explicit UnwindInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2667 unsigned getNumSuccessors() const { return 0; }
2669 // Methods for support type inquiry through isa, cast, and dyn_cast:
2670 static inline bool classof(const UnwindInst *) { return true; }
2671 static inline bool classof(const Instruction *I) {
2672 return I->getOpcode() == Instruction::Unwind;
2674 static inline bool classof(const Value *V) {
2675 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2678 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2679 virtual unsigned getNumSuccessorsV() const;
2680 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2683 //===----------------------------------------------------------------------===//
2684 // UnreachableInst Class
2685 //===----------------------------------------------------------------------===//
2687 //===---------------------------------------------------------------------------
2688 /// UnreachableInst - This function has undefined behavior. In particular, the
2689 /// presence of this instruction indicates some higher level knowledge that the
2690 /// end of the block cannot be reached.
2692 class UnreachableInst : public TerminatorInst {
2693 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2695 virtual UnreachableInst *clone_impl() const;
2698 // allocate space for exactly zero operands
2699 void *operator new(size_t s) {
2700 return User::operator new(s, 0);
2702 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = 0);
2703 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2705 unsigned getNumSuccessors() const { return 0; }
2707 // Methods for support type inquiry through isa, cast, and dyn_cast:
2708 static inline bool classof(const UnreachableInst *) { return true; }
2709 static inline bool classof(const Instruction *I) {
2710 return I->getOpcode() == Instruction::Unreachable;
2712 static inline bool classof(const Value *V) {
2713 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2716 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2717 virtual unsigned getNumSuccessorsV() const;
2718 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2721 //===----------------------------------------------------------------------===//
2723 //===----------------------------------------------------------------------===//
2725 /// @brief This class represents a truncation of integer types.
2726 class TruncInst : public CastInst {
2728 /// @brief Clone an identical TruncInst
2729 virtual TruncInst *clone_impl() const;
2732 /// @brief Constructor with insert-before-instruction semantics
2734 Value *S, ///< The value to be truncated
2735 const Type *Ty, ///< The (smaller) type to truncate to
2736 const Twine &NameStr = "", ///< A name for the new instruction
2737 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2740 /// @brief Constructor with insert-at-end-of-block semantics
2742 Value *S, ///< The value to be truncated
2743 const Type *Ty, ///< The (smaller) type to truncate to
2744 const Twine &NameStr, ///< A name for the new instruction
2745 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2748 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2749 static inline bool classof(const TruncInst *) { return true; }
2750 static inline bool classof(const Instruction *I) {
2751 return I->getOpcode() == Trunc;
2753 static inline bool classof(const Value *V) {
2754 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2758 //===----------------------------------------------------------------------===//
2760 //===----------------------------------------------------------------------===//
2762 /// @brief This class represents zero extension of integer types.
2763 class ZExtInst : public CastInst {
2765 /// @brief Clone an identical ZExtInst
2766 virtual ZExtInst *clone_impl() const;
2769 /// @brief Constructor with insert-before-instruction semantics
2771 Value *S, ///< The value to be zero extended
2772 const Type *Ty, ///< The type to zero extend to
2773 const Twine &NameStr = "", ///< A name for the new instruction
2774 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2777 /// @brief Constructor with insert-at-end semantics.
2779 Value *S, ///< The value to be zero extended
2780 const Type *Ty, ///< The type to zero extend to
2781 const Twine &NameStr, ///< A name for the new instruction
2782 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2785 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2786 static inline bool classof(const ZExtInst *) { return true; }
2787 static inline bool classof(const Instruction *I) {
2788 return I->getOpcode() == ZExt;
2790 static inline bool classof(const Value *V) {
2791 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2795 //===----------------------------------------------------------------------===//
2797 //===----------------------------------------------------------------------===//
2799 /// @brief This class represents a sign extension of integer types.
2800 class SExtInst : public CastInst {
2802 /// @brief Clone an identical SExtInst
2803 virtual SExtInst *clone_impl() const;
2806 /// @brief Constructor with insert-before-instruction semantics
2808 Value *S, ///< The value to be sign extended
2809 const Type *Ty, ///< The type to sign extend to
2810 const Twine &NameStr = "", ///< A name for the new instruction
2811 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2814 /// @brief Constructor with insert-at-end-of-block semantics
2816 Value *S, ///< The value to be sign extended
2817 const Type *Ty, ///< The type to sign extend to
2818 const Twine &NameStr, ///< A name for the new instruction
2819 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2822 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2823 static inline bool classof(const SExtInst *) { return true; }
2824 static inline bool classof(const Instruction *I) {
2825 return I->getOpcode() == SExt;
2827 static inline bool classof(const Value *V) {
2828 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2832 //===----------------------------------------------------------------------===//
2833 // FPTruncInst Class
2834 //===----------------------------------------------------------------------===//
2836 /// @brief This class represents a truncation of floating point types.
2837 class FPTruncInst : public CastInst {
2839 /// @brief Clone an identical FPTruncInst
2840 virtual FPTruncInst *clone_impl() const;
2843 /// @brief Constructor with insert-before-instruction semantics
2845 Value *S, ///< The value to be truncated
2846 const Type *Ty, ///< The type to truncate to
2847 const Twine &NameStr = "", ///< A name for the new instruction
2848 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2851 /// @brief Constructor with insert-before-instruction semantics
2853 Value *S, ///< The value to be truncated
2854 const Type *Ty, ///< The type to truncate to
2855 const Twine &NameStr, ///< A name for the new instruction
2856 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2859 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2860 static inline bool classof(const FPTruncInst *) { return true; }
2861 static inline bool classof(const Instruction *I) {
2862 return I->getOpcode() == FPTrunc;
2864 static inline bool classof(const Value *V) {
2865 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2869 //===----------------------------------------------------------------------===//
2871 //===----------------------------------------------------------------------===//
2873 /// @brief This class represents an extension of floating point types.
2874 class FPExtInst : public CastInst {
2876 /// @brief Clone an identical FPExtInst
2877 virtual FPExtInst *clone_impl() const;
2880 /// @brief Constructor with insert-before-instruction semantics
2882 Value *S, ///< The value to be extended
2883 const Type *Ty, ///< The type to extend to
2884 const Twine &NameStr = "", ///< A name for the new instruction
2885 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2888 /// @brief Constructor with insert-at-end-of-block semantics
2890 Value *S, ///< The value to be extended
2891 const Type *Ty, ///< The type to extend to
2892 const Twine &NameStr, ///< A name for the new instruction
2893 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2896 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2897 static inline bool classof(const FPExtInst *) { return true; }
2898 static inline bool classof(const Instruction *I) {
2899 return I->getOpcode() == FPExt;
2901 static inline bool classof(const Value *V) {
2902 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2906 //===----------------------------------------------------------------------===//
2908 //===----------------------------------------------------------------------===//
2910 /// @brief This class represents a cast unsigned integer to floating point.
2911 class UIToFPInst : public CastInst {
2913 /// @brief Clone an identical UIToFPInst
2914 virtual UIToFPInst *clone_impl() const;
2917 /// @brief Constructor with insert-before-instruction semantics
2919 Value *S, ///< The value to be converted
2920 const Type *Ty, ///< The type to convert to
2921 const Twine &NameStr = "", ///< A name for the new instruction
2922 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2925 /// @brief Constructor with insert-at-end-of-block semantics
2927 Value *S, ///< The value to be converted
2928 const Type *Ty, ///< The type to convert to
2929 const Twine &NameStr, ///< A name for the new instruction
2930 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2933 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2934 static inline bool classof(const UIToFPInst *) { return true; }
2935 static inline bool classof(const Instruction *I) {
2936 return I->getOpcode() == UIToFP;
2938 static inline bool classof(const Value *V) {
2939 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2943 //===----------------------------------------------------------------------===//
2945 //===----------------------------------------------------------------------===//
2947 /// @brief This class represents a cast from signed integer to floating point.
2948 class SIToFPInst : public CastInst {
2950 /// @brief Clone an identical SIToFPInst
2951 virtual SIToFPInst *clone_impl() const;
2954 /// @brief Constructor with insert-before-instruction semantics
2956 Value *S, ///< The value to be converted
2957 const Type *Ty, ///< The type to convert to
2958 const Twine &NameStr = "", ///< A name for the new instruction
2959 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2962 /// @brief Constructor with insert-at-end-of-block semantics
2964 Value *S, ///< The value to be converted
2965 const Type *Ty, ///< The type to convert to
2966 const Twine &NameStr, ///< A name for the new instruction
2967 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2970 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2971 static inline bool classof(const SIToFPInst *) { return true; }
2972 static inline bool classof(const Instruction *I) {
2973 return I->getOpcode() == SIToFP;
2975 static inline bool classof(const Value *V) {
2976 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2980 //===----------------------------------------------------------------------===//
2982 //===----------------------------------------------------------------------===//
2984 /// @brief This class represents a cast from floating point to unsigned integer
2985 class FPToUIInst : public CastInst {
2987 /// @brief Clone an identical FPToUIInst
2988 virtual FPToUIInst *clone_impl() const;
2991 /// @brief Constructor with insert-before-instruction semantics
2993 Value *S, ///< The value to be converted
2994 const Type *Ty, ///< The type to convert to
2995 const Twine &NameStr = "", ///< A name for the new instruction
2996 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2999 /// @brief Constructor with insert-at-end-of-block semantics
3001 Value *S, ///< The value to be converted
3002 const Type *Ty, ///< The type to convert to
3003 const Twine &NameStr, ///< A name for the new instruction
3004 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
3007 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3008 static inline bool classof(const FPToUIInst *) { return true; }
3009 static inline bool classof(const Instruction *I) {
3010 return I->getOpcode() == FPToUI;
3012 static inline bool classof(const Value *V) {
3013 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3017 //===----------------------------------------------------------------------===//
3019 //===----------------------------------------------------------------------===//
3021 /// @brief This class represents a cast from floating point to signed integer.
3022 class FPToSIInst : public CastInst {
3024 /// @brief Clone an identical FPToSIInst
3025 virtual FPToSIInst *clone_impl() const;
3028 /// @brief Constructor with insert-before-instruction semantics
3030 Value *S, ///< The value to be converted
3031 const Type *Ty, ///< The type to convert to
3032 const Twine &NameStr = "", ///< A name for the new instruction
3033 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3036 /// @brief Constructor with insert-at-end-of-block semantics
3038 Value *S, ///< The value to be converted
3039 const Type *Ty, ///< The type to convert to
3040 const Twine &NameStr, ///< A name for the new instruction
3041 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3044 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
3045 static inline bool classof(const FPToSIInst *) { return true; }
3046 static inline bool classof(const Instruction *I) {
3047 return I->getOpcode() == FPToSI;
3049 static inline bool classof(const Value *V) {
3050 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3054 //===----------------------------------------------------------------------===//
3055 // IntToPtrInst Class
3056 //===----------------------------------------------------------------------===//
3058 /// @brief This class represents a cast from an integer to a pointer.
3059 class IntToPtrInst : public CastInst {
3061 /// @brief Constructor with insert-before-instruction semantics
3063 Value *S, ///< The value to be converted
3064 const Type *Ty, ///< The type to convert to
3065 const Twine &NameStr = "", ///< A name for the new instruction
3066 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3069 /// @brief Constructor with insert-at-end-of-block semantics
3071 Value *S, ///< The value to be converted
3072 const Type *Ty, ///< The type to convert to
3073 const Twine &NameStr, ///< A name for the new instruction
3074 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3077 /// @brief Clone an identical IntToPtrInst
3078 virtual IntToPtrInst *clone_impl() const;
3080 // Methods for support type inquiry through isa, cast, and dyn_cast:
3081 static inline bool classof(const IntToPtrInst *) { return true; }
3082 static inline bool classof(const Instruction *I) {
3083 return I->getOpcode() == IntToPtr;
3085 static inline bool classof(const Value *V) {
3086 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3090 //===----------------------------------------------------------------------===//
3091 // PtrToIntInst Class
3092 //===----------------------------------------------------------------------===//
3094 /// @brief This class represents a cast from a pointer to an integer
3095 class PtrToIntInst : public CastInst {
3097 /// @brief Clone an identical PtrToIntInst
3098 virtual PtrToIntInst *clone_impl() const;
3101 /// @brief Constructor with insert-before-instruction semantics
3103 Value *S, ///< The value to be converted
3104 const Type *Ty, ///< The type to convert to
3105 const Twine &NameStr = "", ///< A name for the new instruction
3106 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3109 /// @brief Constructor with insert-at-end-of-block semantics
3111 Value *S, ///< The value to be converted
3112 const Type *Ty, ///< The type to convert to
3113 const Twine &NameStr, ///< A name for the new instruction
3114 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3117 // Methods for support type inquiry through isa, cast, and dyn_cast:
3118 static inline bool classof(const PtrToIntInst *) { return true; }
3119 static inline bool classof(const Instruction *I) {
3120 return I->getOpcode() == PtrToInt;
3122 static inline bool classof(const Value *V) {
3123 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3127 //===----------------------------------------------------------------------===//
3128 // BitCastInst Class
3129 //===----------------------------------------------------------------------===//
3131 /// @brief This class represents a no-op cast from one type to another.
3132 class BitCastInst : public CastInst {
3134 /// @brief Clone an identical BitCastInst
3135 virtual BitCastInst *clone_impl() const;
3138 /// @brief Constructor with insert-before-instruction semantics
3140 Value *S, ///< The value to be casted
3141 const Type *Ty, ///< The type to casted to
3142 const Twine &NameStr = "", ///< A name for the new instruction
3143 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3146 /// @brief Constructor with insert-at-end-of-block semantics
3148 Value *S, ///< The value to be casted
3149 const Type *Ty, ///< The type to casted to
3150 const Twine &NameStr, ///< A name for the new instruction
3151 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3154 // Methods for support type inquiry through isa, cast, and dyn_cast:
3155 static inline bool classof(const BitCastInst *) { return true; }
3156 static inline bool classof(const Instruction *I) {
3157 return I->getOpcode() == BitCast;
3159 static inline bool classof(const Value *V) {
3160 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3164 } // End llvm namespace