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/BasicBlock.h"
23 #include "llvm/CallingConv.h"
24 #include "llvm/LLVMContext.h"
25 #include "llvm/ADT/SmallVector.h"
36 //===----------------------------------------------------------------------===//
37 // AllocationInst Class
38 //===----------------------------------------------------------------------===//
40 /// AllocationInst - This class is the common base class of MallocInst and
43 class AllocationInst : public UnaryInstruction {
45 AllocationInst(const Type *Ty, Value *ArraySize,
46 unsigned iTy, unsigned Align, const Twine &Name = "",
47 Instruction *InsertBefore = 0);
48 AllocationInst(const Type *Ty, Value *ArraySize,
49 unsigned iTy, unsigned Align, const Twine &Name,
50 BasicBlock *InsertAtEnd);
52 // Out of line virtual method, so the vtable, etc. has a home.
53 virtual ~AllocationInst();
55 /// isArrayAllocation - Return true if there is an allocation size parameter
56 /// to the allocation instruction that is not 1.
58 bool isArrayAllocation() const;
60 /// getArraySize - Get the number of elements allocated. For a simple
61 /// allocation of a single element, this will return a constant 1 value.
63 const Value *getArraySize() const { return getOperand(0); }
64 Value *getArraySize() { return getOperand(0); }
66 /// getType - Overload to return most specific pointer type
68 const PointerType *getType() const {
69 return reinterpret_cast<const PointerType*>(Instruction::getType());
72 /// getAllocatedType - Return the type that is being allocated by the
75 const Type *getAllocatedType() const;
77 /// getAlignment - Return the alignment of the memory that is being allocated
78 /// by the instruction.
80 unsigned getAlignment() const { return (1u << SubclassData) >> 1; }
81 void setAlignment(unsigned Align);
83 virtual AllocationInst *clone(LLVMContext &Context) const = 0;
85 // Methods for support type inquiry through isa, cast, and dyn_cast:
86 static inline bool classof(const AllocationInst *) { return true; }
87 static inline bool classof(const Instruction *I) {
88 return I->getOpcode() == Instruction::Alloca ||
89 I->getOpcode() == Instruction::Malloc;
91 static inline bool classof(const Value *V) {
92 return isa<Instruction>(V) && classof(cast<Instruction>(V));
97 //===----------------------------------------------------------------------===//
99 //===----------------------------------------------------------------------===//
101 /// MallocInst - an instruction to allocated memory on the heap
103 class MallocInst : public AllocationInst {
105 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
106 const Twine &NameStr = "",
107 Instruction *InsertBefore = 0)
108 : AllocationInst(Ty, ArraySize, Malloc,
109 0, NameStr, InsertBefore) {}
110 MallocInst(const Type *Ty, Value *ArraySize,
111 const Twine &NameStr, BasicBlock *InsertAtEnd)
112 : AllocationInst(Ty, ArraySize, Malloc, 0, NameStr, InsertAtEnd) {}
114 MallocInst(const Type *Ty, const Twine &NameStr,
115 Instruction *InsertBefore = 0)
116 : AllocationInst(Ty, 0, Malloc, 0, NameStr, InsertBefore) {}
117 MallocInst(const Type *Ty, const Twine &NameStr,
118 BasicBlock *InsertAtEnd)
119 : AllocationInst(Ty, 0, Malloc, 0, NameStr, InsertAtEnd) {}
121 MallocInst(const Type *Ty, Value *ArraySize,
122 unsigned Align, const Twine &NameStr,
123 BasicBlock *InsertAtEnd)
124 : AllocationInst(Ty, ArraySize, Malloc,
125 Align, NameStr, InsertAtEnd) {}
126 MallocInst(const Type *Ty, Value *ArraySize,
127 unsigned Align, const Twine &NameStr = "",
128 Instruction *InsertBefore = 0)
129 : AllocationInst(Ty, ArraySize,
130 Malloc, Align, NameStr, InsertBefore) {}
132 virtual MallocInst *clone(LLVMContext &Context) const;
134 // Methods for support type inquiry through isa, cast, and dyn_cast:
135 static inline bool classof(const MallocInst *) { return true; }
136 static inline bool classof(const Instruction *I) {
137 return (I->getOpcode() == Instruction::Malloc);
139 static inline bool classof(const Value *V) {
140 return isa<Instruction>(V) && classof(cast<Instruction>(V));
145 //===----------------------------------------------------------------------===//
147 //===----------------------------------------------------------------------===//
149 /// AllocaInst - an instruction to allocate memory on the stack
151 class AllocaInst : public AllocationInst {
153 explicit AllocaInst(const Type *Ty,
154 Value *ArraySize = 0,
155 const Twine &NameStr = "",
156 Instruction *InsertBefore = 0)
157 : AllocationInst(Ty, ArraySize, Alloca,
158 0, NameStr, InsertBefore) {}
159 AllocaInst(const Type *Ty,
160 Value *ArraySize, const Twine &NameStr,
161 BasicBlock *InsertAtEnd)
162 : AllocationInst(Ty, ArraySize, Alloca, 0, NameStr, InsertAtEnd) {}
164 AllocaInst(const Type *Ty, const Twine &NameStr,
165 Instruction *InsertBefore = 0)
166 : AllocationInst(Ty, 0, Alloca, 0, NameStr, InsertBefore) {}
167 AllocaInst(const Type *Ty, const Twine &NameStr,
168 BasicBlock *InsertAtEnd)
169 : AllocationInst(Ty, 0, Alloca, 0, NameStr, InsertAtEnd) {}
171 AllocaInst(const Type *Ty, Value *ArraySize,
172 unsigned Align, const Twine &NameStr = "",
173 Instruction *InsertBefore = 0)
174 : AllocationInst(Ty, ArraySize, Alloca,
175 Align, NameStr, InsertBefore) {}
176 AllocaInst(const Type *Ty, Value *ArraySize,
177 unsigned Align, const Twine &NameStr,
178 BasicBlock *InsertAtEnd)
179 : AllocationInst(Ty, ArraySize, Alloca,
180 Align, NameStr, InsertAtEnd) {}
182 virtual AllocaInst *clone(LLVMContext &Context) const;
184 /// isStaticAlloca - Return true if this alloca is in the entry block of the
185 /// function and is a constant size. If so, the code generator will fold it
186 /// into the prolog/epilog code, so it is basically free.
187 bool isStaticAlloca() const;
189 // Methods for support type inquiry through isa, cast, and dyn_cast:
190 static inline bool classof(const AllocaInst *) { return true; }
191 static inline bool classof(const Instruction *I) {
192 return (I->getOpcode() == Instruction::Alloca);
194 static inline bool classof(const Value *V) {
195 return isa<Instruction>(V) && classof(cast<Instruction>(V));
200 //===----------------------------------------------------------------------===//
202 //===----------------------------------------------------------------------===//
204 /// FreeInst - an instruction to deallocate memory
206 class FreeInst : public UnaryInstruction {
209 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
210 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
212 virtual FreeInst *clone(LLVMContext &Context) const;
214 // Accessor methods for consistency with other memory operations
215 Value *getPointerOperand() { return getOperand(0); }
216 const Value *getPointerOperand() const { return getOperand(0); }
218 // Methods for support type inquiry through isa, cast, and dyn_cast:
219 static inline bool classof(const FreeInst *) { return true; }
220 static inline bool classof(const Instruction *I) {
221 return (I->getOpcode() == Instruction::Free);
223 static inline bool classof(const Value *V) {
224 return isa<Instruction>(V) && classof(cast<Instruction>(V));
229 //===----------------------------------------------------------------------===//
231 //===----------------------------------------------------------------------===//
233 /// LoadInst - an instruction for reading from memory. This uses the
234 /// SubclassData field in Value to store whether or not the load is volatile.
236 class LoadInst : public UnaryInstruction {
239 LoadInst(Value *Ptr, const Twine &NameStr, Instruction *InsertBefore);
240 LoadInst(Value *Ptr, const Twine &NameStr, BasicBlock *InsertAtEnd);
241 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile = false,
242 Instruction *InsertBefore = 0);
243 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
244 unsigned Align, Instruction *InsertBefore = 0);
245 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
246 BasicBlock *InsertAtEnd);
247 LoadInst(Value *Ptr, const Twine &NameStr, bool isVolatile,
248 unsigned Align, BasicBlock *InsertAtEnd);
250 LoadInst(Value *Ptr, const char *NameStr, Instruction *InsertBefore);
251 LoadInst(Value *Ptr, const char *NameStr, BasicBlock *InsertAtEnd);
252 explicit LoadInst(Value *Ptr, const char *NameStr = 0,
253 bool isVolatile = false, Instruction *InsertBefore = 0);
254 LoadInst(Value *Ptr, const char *NameStr, bool isVolatile,
255 BasicBlock *InsertAtEnd);
257 /// isVolatile - Return true if this is a load from a volatile memory
260 bool isVolatile() const { return SubclassData & 1; }
262 /// setVolatile - Specify whether this is a volatile load or not.
264 void setVolatile(bool V) {
265 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
268 virtual LoadInst *clone(LLVMContext &Context) const;
270 /// getAlignment - Return the alignment of the access that is being performed
272 unsigned getAlignment() const {
273 return (1 << (SubclassData>>1)) >> 1;
276 void setAlignment(unsigned Align);
278 Value *getPointerOperand() { return getOperand(0); }
279 const Value *getPointerOperand() const { return getOperand(0); }
280 static unsigned getPointerOperandIndex() { return 0U; }
282 unsigned getPointerAddressSpace() const {
283 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
287 // Methods for support type inquiry through isa, cast, and dyn_cast:
288 static inline bool classof(const LoadInst *) { return true; }
289 static inline bool classof(const Instruction *I) {
290 return I->getOpcode() == Instruction::Load;
292 static inline bool classof(const Value *V) {
293 return isa<Instruction>(V) && classof(cast<Instruction>(V));
298 //===----------------------------------------------------------------------===//
300 //===----------------------------------------------------------------------===//
302 /// StoreInst - an instruction for storing to memory
304 class StoreInst : public Instruction {
305 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
308 // allocate space for exactly two operands
309 void *operator new(size_t s) {
310 return User::operator new(s, 2);
312 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
313 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
314 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
315 Instruction *InsertBefore = 0);
316 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
317 unsigned Align, Instruction *InsertBefore = 0);
318 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
319 StoreInst(Value *Val, Value *Ptr, bool isVolatile,
320 unsigned Align, BasicBlock *InsertAtEnd);
323 /// isVolatile - Return true if this is a load from a volatile memory
326 bool isVolatile() const { return SubclassData & 1; }
328 /// setVolatile - Specify whether this is a volatile load or not.
330 void setVolatile(bool V) {
331 SubclassData = (SubclassData & ~1) | (V ? 1 : 0);
334 /// Transparently provide more efficient getOperand methods.
335 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
337 /// getAlignment - Return the alignment of the access that is being performed
339 unsigned getAlignment() const {
340 return (1 << (SubclassData>>1)) >> 1;
343 void setAlignment(unsigned Align);
345 virtual StoreInst *clone(LLVMContext &Context) const;
347 Value *getPointerOperand() { return getOperand(1); }
348 const Value *getPointerOperand() const { return getOperand(1); }
349 static unsigned getPointerOperandIndex() { return 1U; }
351 unsigned getPointerAddressSpace() const {
352 return cast<PointerType>(getPointerOperand()->getType())->getAddressSpace();
355 // Methods for support type inquiry through isa, cast, and dyn_cast:
356 static inline bool classof(const StoreInst *) { return true; }
357 static inline bool classof(const Instruction *I) {
358 return I->getOpcode() == Instruction::Store;
360 static inline bool classof(const Value *V) {
361 return isa<Instruction>(V) && classof(cast<Instruction>(V));
366 struct OperandTraits<StoreInst> : public FixedNumOperandTraits<2> {
369 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(StoreInst, Value)
371 //===----------------------------------------------------------------------===//
372 // GetElementPtrInst Class
373 //===----------------------------------------------------------------------===//
375 // checkType - Simple wrapper function to give a better assertion failure
376 // message on bad indexes for a gep instruction.
378 static inline const Type *checkType(const Type *Ty) {
379 assert(Ty && "Invalid GetElementPtrInst indices for type!");
383 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
384 /// access elements of arrays and structs
386 class GetElementPtrInst : public Instruction {
387 GetElementPtrInst(const GetElementPtrInst &GEPI);
388 void init(Value *Ptr, Value* const *Idx, unsigned NumIdx,
389 const Twine &NameStr);
390 void init(Value *Ptr, Value *Idx, const Twine &NameStr);
392 template<typename InputIterator>
393 void init(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
394 const Twine &NameStr,
395 // This argument ensures that we have an iterator we can
396 // do arithmetic on in constant time
397 std::random_access_iterator_tag) {
398 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
401 // This requires that the iterator points to contiguous memory.
402 init(Ptr, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
403 // we have to build an array here
406 init(Ptr, 0, NumIdx, NameStr);
410 /// getIndexedType - Returns the type of the element that would be loaded with
411 /// a load instruction with the specified parameters.
413 /// Null is returned if the indices are invalid for the specified
416 template<typename InputIterator>
417 static const Type *getIndexedType(const Type *Ptr,
418 InputIterator IdxBegin,
419 InputIterator IdxEnd,
420 // This argument ensures that we
421 // have an iterator we can do
422 // arithmetic on in constant time
423 std::random_access_iterator_tag) {
424 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
427 // This requires that the iterator points to contiguous memory.
428 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
430 return getIndexedType(Ptr, (Value *const*)0, NumIdx);
433 /// Constructors - Create a getelementptr instruction with a base pointer an
434 /// list of indices. The first ctor can optionally insert before an existing
435 /// instruction, the second appends the new instruction to the specified
437 template<typename InputIterator>
438 inline GetElementPtrInst(Value *Ptr, InputIterator IdxBegin,
439 InputIterator IdxEnd,
441 const Twine &NameStr,
442 Instruction *InsertBefore);
443 template<typename InputIterator>
444 inline GetElementPtrInst(Value *Ptr,
445 InputIterator IdxBegin, InputIterator IdxEnd,
447 const Twine &NameStr, BasicBlock *InsertAtEnd);
449 /// Constructors - These two constructors are convenience methods because one
450 /// and two index getelementptr instructions are so common.
451 GetElementPtrInst(Value *Ptr, Value *Idx, const Twine &NameStr = "",
452 Instruction *InsertBefore = 0);
453 GetElementPtrInst(Value *Ptr, Value *Idx,
454 const Twine &NameStr, BasicBlock *InsertAtEnd);
456 template<typename InputIterator>
457 static GetElementPtrInst *Create(Value *Ptr, InputIterator IdxBegin,
458 InputIterator IdxEnd,
459 const Twine &NameStr = "",
460 Instruction *InsertBefore = 0) {
461 typename std::iterator_traits<InputIterator>::difference_type Values =
462 1 + std::distance(IdxBegin, IdxEnd);
464 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertBefore);
466 template<typename InputIterator>
467 static GetElementPtrInst *Create(Value *Ptr,
468 InputIterator IdxBegin, InputIterator IdxEnd,
469 const Twine &NameStr,
470 BasicBlock *InsertAtEnd) {
471 typename std::iterator_traits<InputIterator>::difference_type Values =
472 1 + std::distance(IdxBegin, IdxEnd);
474 GetElementPtrInst(Ptr, IdxBegin, IdxEnd, Values, NameStr, InsertAtEnd);
477 /// Constructors - These two creators are convenience methods because one
478 /// index getelementptr instructions are so common.
479 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
480 const Twine &NameStr = "",
481 Instruction *InsertBefore = 0) {
482 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertBefore);
484 static GetElementPtrInst *Create(Value *Ptr, Value *Idx,
485 const Twine &NameStr,
486 BasicBlock *InsertAtEnd) {
487 return new(2) GetElementPtrInst(Ptr, Idx, NameStr, InsertAtEnd);
490 /// Create an "inbounds" getelementptr. See the documentation for the
491 /// "inbounds" flag in LangRef.html for details.
492 template<typename InputIterator>
493 static GetElementPtrInst *CreateInBounds(Value *Ptr, InputIterator IdxBegin,
494 InputIterator IdxEnd,
495 const Twine &NameStr = "",
496 Instruction *InsertBefore = 0) {
497 GetElementPtrInst *GEP = Create(Ptr, IdxBegin, IdxEnd,
498 NameStr, InsertBefore);
499 GEP->setIsInBounds(true);
502 template<typename InputIterator>
503 static GetElementPtrInst *CreateInBounds(Value *Ptr,
504 InputIterator IdxBegin,
505 InputIterator IdxEnd,
506 const Twine &NameStr,
507 BasicBlock *InsertAtEnd) {
508 GetElementPtrInst *GEP = Create(Ptr, IdxBegin, IdxEnd,
509 NameStr, InsertAtEnd);
510 GEP->setIsInBounds(true);
513 static GetElementPtrInst *CreateInBounds(Value *Ptr, Value *Idx,
514 const Twine &NameStr = "",
515 Instruction *InsertBefore = 0) {
516 GetElementPtrInst *GEP = Create(Ptr, Idx, NameStr, InsertBefore);
517 GEP->setIsInBounds(true);
520 static GetElementPtrInst *CreateInBounds(Value *Ptr, Value *Idx,
521 const Twine &NameStr,
522 BasicBlock *InsertAtEnd) {
523 GetElementPtrInst *GEP = Create(Ptr, Idx, NameStr, InsertAtEnd);
524 GEP->setIsInBounds(true);
528 virtual GetElementPtrInst *clone(LLVMContext &Context) const;
530 /// Transparently provide more efficient getOperand methods.
531 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
533 // getType - Overload to return most specific pointer type...
534 const PointerType *getType() const {
535 return reinterpret_cast<const PointerType*>(Instruction::getType());
538 /// getIndexedType - Returns the type of the element that would be loaded with
539 /// a load instruction with the specified parameters.
541 /// Null is returned if the indices are invalid for the specified
544 template<typename InputIterator>
545 static const Type *getIndexedType(const Type *Ptr,
546 InputIterator IdxBegin,
547 InputIterator IdxEnd) {
548 return getIndexedType(Ptr, IdxBegin, IdxEnd,
549 typename std::iterator_traits<InputIterator>::
550 iterator_category());
553 static const Type *getIndexedType(const Type *Ptr,
554 Value* const *Idx, unsigned NumIdx);
556 static const Type *getIndexedType(const Type *Ptr,
557 uint64_t const *Idx, unsigned NumIdx);
559 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
561 inline op_iterator idx_begin() { return op_begin()+1; }
562 inline const_op_iterator idx_begin() const { return op_begin()+1; }
563 inline op_iterator idx_end() { return op_end(); }
564 inline const_op_iterator idx_end() const { return op_end(); }
566 Value *getPointerOperand() {
567 return getOperand(0);
569 const Value *getPointerOperand() const {
570 return getOperand(0);
572 static unsigned getPointerOperandIndex() {
573 return 0U; // get index for modifying correct operand
576 unsigned getPointerAddressSpace() const {
577 return cast<PointerType>(getType())->getAddressSpace();
580 /// getPointerOperandType - Method to return the pointer operand as a
582 const PointerType *getPointerOperandType() const {
583 return reinterpret_cast<const PointerType*>(getPointerOperand()->getType());
587 unsigned getNumIndices() const { // Note: always non-negative
588 return getNumOperands() - 1;
591 bool hasIndices() const {
592 return getNumOperands() > 1;
595 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
596 /// zeros. If so, the result pointer and the first operand have the same
597 /// value, just potentially different types.
598 bool hasAllZeroIndices() const;
600 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
601 /// constant integers. If so, the result pointer and the first operand have
602 /// a constant offset between them.
603 bool hasAllConstantIndices() const;
605 /// setIsInBounds - Set or clear the inbounds flag on this GEP instruction.
606 /// See LangRef.html for the meaning of inbounds on a getelementptr.
607 void setIsInBounds(bool);
609 // Methods for support type inquiry through isa, cast, and dyn_cast:
610 static inline bool classof(const GetElementPtrInst *) { return true; }
611 static inline bool classof(const Instruction *I) {
612 return (I->getOpcode() == Instruction::GetElementPtr);
614 static inline bool classof(const Value *V) {
615 return isa<Instruction>(V) && classof(cast<Instruction>(V));
620 struct OperandTraits<GetElementPtrInst> : public VariadicOperandTraits<1> {
623 template<typename InputIterator>
624 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
625 InputIterator IdxBegin,
626 InputIterator IdxEnd,
628 const Twine &NameStr,
629 Instruction *InsertBefore)
630 : Instruction(PointerType::get(checkType(
631 getIndexedType(Ptr->getType(),
633 cast<PointerType>(Ptr->getType())
634 ->getAddressSpace()),
636 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
637 Values, InsertBefore) {
638 init(Ptr, IdxBegin, IdxEnd, NameStr,
639 typename std::iterator_traits<InputIterator>::iterator_category());
641 template<typename InputIterator>
642 GetElementPtrInst::GetElementPtrInst(Value *Ptr,
643 InputIterator IdxBegin,
644 InputIterator IdxEnd,
646 const Twine &NameStr,
647 BasicBlock *InsertAtEnd)
648 : Instruction(PointerType::get(checkType(
649 getIndexedType(Ptr->getType(),
651 cast<PointerType>(Ptr->getType())
652 ->getAddressSpace()),
654 OperandTraits<GetElementPtrInst>::op_end(this) - Values,
655 Values, InsertAtEnd) {
656 init(Ptr, IdxBegin, IdxEnd, NameStr,
657 typename std::iterator_traits<InputIterator>::iterator_category());
661 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(GetElementPtrInst, Value)
664 //===----------------------------------------------------------------------===//
666 //===----------------------------------------------------------------------===//
668 /// This instruction compares its operands according to the predicate given
669 /// to the constructor. It only operates on integers or pointers. The operands
670 /// must be identical types.
671 /// @brief Represent an integer comparison operator.
672 class ICmpInst: public CmpInst {
674 /// @brief Constructor with insert-before-instruction semantics.
676 Instruction *InsertBefore, ///< Where to insert
677 Predicate pred, ///< The predicate to use for the comparison
678 Value *LHS, ///< The left-hand-side of the expression
679 Value *RHS, ///< The right-hand-side of the expression
680 const Twine &NameStr = "" ///< Name of the instruction
681 ) : CmpInst(makeCmpResultType(LHS->getType()),
682 Instruction::ICmp, pred, LHS, RHS, NameStr,
684 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
685 pred <= CmpInst::LAST_ICMP_PREDICATE &&
686 "Invalid ICmp predicate value");
687 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
688 "Both operands to ICmp instruction are not of the same type!");
689 // Check that the operands are the right type
690 assert((getOperand(0)->getType()->isIntOrIntVector() ||
691 isa<PointerType>(getOperand(0)->getType())) &&
692 "Invalid operand types for ICmp instruction");
695 /// @brief Constructor with insert-at-end semantics.
697 BasicBlock &InsertAtEnd, ///< Block to insert into.
698 Predicate pred, ///< The predicate to use for the comparison
699 Value *LHS, ///< The left-hand-side of the expression
700 Value *RHS, ///< The right-hand-side of the expression
701 const Twine &NameStr = "" ///< Name of the instruction
702 ) : CmpInst(makeCmpResultType(LHS->getType()),
703 Instruction::ICmp, pred, LHS, RHS, NameStr,
705 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
706 pred <= CmpInst::LAST_ICMP_PREDICATE &&
707 "Invalid ICmp predicate value");
708 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
709 "Both operands to ICmp instruction are not of the same type!");
710 // Check that the operands are the right type
711 assert((getOperand(0)->getType()->isIntOrIntVector() ||
712 isa<PointerType>(getOperand(0)->getType())) &&
713 "Invalid operand types for ICmp instruction");
716 /// @brief Constructor with no-insertion semantics
718 Predicate pred, ///< The predicate to use for the comparison
719 Value *LHS, ///< The left-hand-side of the expression
720 Value *RHS, ///< The right-hand-side of the expression
721 const Twine &NameStr = "" ///< Name of the instruction
722 ) : CmpInst(makeCmpResultType(LHS->getType()),
723 Instruction::ICmp, pred, LHS, RHS, NameStr) {
724 assert(pred >= CmpInst::FIRST_ICMP_PREDICATE &&
725 pred <= CmpInst::LAST_ICMP_PREDICATE &&
726 "Invalid ICmp predicate value");
727 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
728 "Both operands to ICmp instruction are not of the same type!");
729 // Check that the operands are the right type
730 assert((getOperand(0)->getType()->isIntOrIntVector() ||
731 isa<PointerType>(getOperand(0)->getType())) &&
732 "Invalid operand types for ICmp instruction");
735 /// For example, EQ->EQ, SLE->SLE, UGT->SGT, etc.
736 /// @returns the predicate that would be the result if the operand were
737 /// regarded as signed.
738 /// @brief Return the signed version of the predicate
739 Predicate getSignedPredicate() const {
740 return getSignedPredicate(getPredicate());
743 /// This is a static version that you can use without an instruction.
744 /// @brief Return the signed version of the predicate.
745 static Predicate getSignedPredicate(Predicate pred);
747 /// For example, EQ->EQ, SLE->ULE, UGT->UGT, etc.
748 /// @returns the predicate that would be the result if the operand were
749 /// regarded as unsigned.
750 /// @brief Return the unsigned version of the predicate
751 Predicate getUnsignedPredicate() const {
752 return getUnsignedPredicate(getPredicate());
755 /// This is a static version that you can use without an instruction.
756 /// @brief Return the unsigned version of the predicate.
757 static Predicate getUnsignedPredicate(Predicate pred);
759 /// isEquality - Return true if this predicate is either EQ or NE. This also
760 /// tests for commutativity.
761 static bool isEquality(Predicate P) {
762 return P == ICMP_EQ || P == ICMP_NE;
765 /// isEquality - Return true if this predicate is either EQ or NE. This also
766 /// tests for commutativity.
767 bool isEquality() const {
768 return isEquality(getPredicate());
771 /// @returns true if the predicate of this ICmpInst is commutative
772 /// @brief Determine if this relation is commutative.
773 bool isCommutative() const { return isEquality(); }
775 /// isRelational - Return true if the predicate is relational (not EQ or NE).
777 bool isRelational() const {
778 return !isEquality();
781 /// isRelational - Return true if the predicate is relational (not EQ or NE).
783 static bool isRelational(Predicate P) {
784 return !isEquality(P);
787 /// @returns true if the predicate of this ICmpInst is signed, false otherwise
788 /// @brief Determine if this instruction's predicate is signed.
789 bool isSignedPredicate() const { return isSignedPredicate(getPredicate()); }
791 /// @returns true if the predicate provided is signed, false otherwise
792 /// @brief Determine if the predicate is signed.
793 static bool isSignedPredicate(Predicate pred);
795 /// @returns true if the specified compare predicate is
796 /// true when both operands are equal...
797 /// @brief Determine if the icmp is true when both operands are equal
798 static bool isTrueWhenEqual(ICmpInst::Predicate pred) {
799 return pred == ICmpInst::ICMP_EQ || pred == ICmpInst::ICMP_UGE ||
800 pred == ICmpInst::ICMP_SGE || pred == ICmpInst::ICMP_ULE ||
801 pred == ICmpInst::ICMP_SLE;
804 /// @returns true if the specified compare instruction is
805 /// true when both operands are equal...
806 /// @brief Determine if the ICmpInst returns true when both operands are equal
807 bool isTrueWhenEqual() {
808 return isTrueWhenEqual(getPredicate());
811 /// Initialize a set of values that all satisfy the predicate with C.
812 /// @brief Make a ConstantRange for a relation with a constant value.
813 static ConstantRange makeConstantRange(Predicate pred, const APInt &C);
815 /// Exchange the two operands to this instruction in such a way that it does
816 /// not modify the semantics of the instruction. The predicate value may be
817 /// changed to retain the same result if the predicate is order dependent
819 /// @brief Swap operands and adjust predicate.
820 void swapOperands() {
821 SubclassData = getSwappedPredicate();
822 Op<0>().swap(Op<1>());
825 virtual ICmpInst *clone(LLVMContext &Context) const;
827 // Methods for support type inquiry through isa, cast, and dyn_cast:
828 static inline bool classof(const ICmpInst *) { return true; }
829 static inline bool classof(const Instruction *I) {
830 return I->getOpcode() == Instruction::ICmp;
832 static inline bool classof(const Value *V) {
833 return isa<Instruction>(V) && classof(cast<Instruction>(V));
838 //===----------------------------------------------------------------------===//
840 //===----------------------------------------------------------------------===//
842 /// This instruction compares its operands according to the predicate given
843 /// to the constructor. It only operates on floating point values or packed
844 /// vectors of floating point values. The operands must be identical types.
845 /// @brief Represents a floating point comparison operator.
846 class FCmpInst: public CmpInst {
848 /// @brief Constructor with insert-before-instruction semantics.
850 Instruction *InsertBefore, ///< Where to insert
851 Predicate pred, ///< The predicate to use for the comparison
852 Value *LHS, ///< The left-hand-side of the expression
853 Value *RHS, ///< The right-hand-side of the expression
854 const Twine &NameStr = "" ///< Name of the instruction
855 ) : CmpInst(makeCmpResultType(LHS->getType()),
856 Instruction::FCmp, pred, LHS, RHS, NameStr,
858 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
859 "Invalid FCmp predicate value");
860 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
861 "Both operands to FCmp instruction are not of the same type!");
862 // Check that the operands are the right type
863 assert(getOperand(0)->getType()->isFPOrFPVector() &&
864 "Invalid operand types for FCmp instruction");
867 /// @brief Constructor with insert-at-end semantics.
869 BasicBlock &InsertAtEnd, ///< Block to insert into.
870 Predicate pred, ///< The predicate to use for the comparison
871 Value *LHS, ///< The left-hand-side of the expression
872 Value *RHS, ///< The right-hand-side of the expression
873 const Twine &NameStr = "" ///< Name of the instruction
874 ) : CmpInst(makeCmpResultType(LHS->getType()),
875 Instruction::FCmp, pred, LHS, RHS, NameStr,
877 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
878 "Invalid FCmp predicate value");
879 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
880 "Both operands to FCmp instruction are not of the same type!");
881 // Check that the operands are the right type
882 assert(getOperand(0)->getType()->isFPOrFPVector() &&
883 "Invalid operand types for FCmp instruction");
886 /// @brief Constructor with no-insertion semantics
888 Predicate pred, ///< The predicate to use for the comparison
889 Value *LHS, ///< The left-hand-side of the expression
890 Value *RHS, ///< The right-hand-side of the expression
891 const Twine &NameStr = "" ///< Name of the instruction
892 ) : CmpInst(makeCmpResultType(LHS->getType()),
893 Instruction::FCmp, pred, LHS, RHS, NameStr) {
894 assert(pred <= FCmpInst::LAST_FCMP_PREDICATE &&
895 "Invalid FCmp predicate value");
896 assert(getOperand(0)->getType() == getOperand(1)->getType() &&
897 "Both operands to FCmp instruction are not of the same type!");
898 // Check that the operands are the right type
899 assert(getOperand(0)->getType()->isFPOrFPVector() &&
900 "Invalid operand types for FCmp instruction");
903 /// @returns true if the predicate of this instruction is EQ or NE.
904 /// @brief Determine if this is an equality predicate.
905 bool isEquality() const {
906 return SubclassData == FCMP_OEQ || SubclassData == FCMP_ONE ||
907 SubclassData == FCMP_UEQ || SubclassData == FCMP_UNE;
910 /// @returns true if the predicate of this instruction is commutative.
911 /// @brief Determine if this is a commutative predicate.
912 bool isCommutative() const {
913 return isEquality() ||
914 SubclassData == FCMP_FALSE ||
915 SubclassData == FCMP_TRUE ||
916 SubclassData == FCMP_ORD ||
917 SubclassData == FCMP_UNO;
920 /// @returns true if the predicate is relational (not EQ or NE).
921 /// @brief Determine if this a relational predicate.
922 bool isRelational() const { return !isEquality(); }
924 /// Exchange the two operands to this instruction in such a way that it does
925 /// not modify the semantics of the instruction. The predicate value may be
926 /// changed to retain the same result if the predicate is order dependent
928 /// @brief Swap operands and adjust predicate.
929 void swapOperands() {
930 SubclassData = getSwappedPredicate();
931 Op<0>().swap(Op<1>());
934 virtual FCmpInst *clone(LLVMContext &Context) const;
936 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
937 static inline bool classof(const FCmpInst *) { return true; }
938 static inline bool classof(const Instruction *I) {
939 return I->getOpcode() == Instruction::FCmp;
941 static inline bool classof(const Value *V) {
942 return isa<Instruction>(V) && classof(cast<Instruction>(V));
946 //===----------------------------------------------------------------------===//
948 //===----------------------------------------------------------------------===//
949 /// CallInst - This class represents a function call, abstracting a target
950 /// machine's calling convention. This class uses low bit of the SubClassData
951 /// field to indicate whether or not this is a tail call. The rest of the bits
952 /// hold the calling convention of the call.
955 class CallInst : public Instruction {
956 AttrListPtr AttributeList; ///< parameter attributes for call
957 CallInst(const CallInst &CI);
958 void init(Value *Func, Value* const *Params, unsigned NumParams);
959 void init(Value *Func, Value *Actual1, Value *Actual2);
960 void init(Value *Func, Value *Actual);
961 void init(Value *Func);
963 template<typename InputIterator>
964 void init(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
965 const Twine &NameStr,
966 // This argument ensures that we have an iterator we can
967 // do arithmetic on in constant time
968 std::random_access_iterator_tag) {
969 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
971 // This requires that the iterator points to contiguous memory.
972 init(Func, NumArgs ? &*ArgBegin : 0, NumArgs);
976 /// Construct a CallInst given a range of arguments. InputIterator
977 /// must be a random-access iterator pointing to contiguous storage
978 /// (e.g. a std::vector<>::iterator). Checks are made for
979 /// random-accessness but not for contiguous storage as that would
980 /// incur runtime overhead.
981 /// @brief Construct a CallInst from a range of arguments
982 template<typename InputIterator>
983 CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
984 const Twine &NameStr, Instruction *InsertBefore);
986 /// Construct a CallInst given a range of arguments. InputIterator
987 /// must be a random-access iterator pointing to contiguous storage
988 /// (e.g. a std::vector<>::iterator). Checks are made for
989 /// random-accessness but not for contiguous storage as that would
990 /// incur runtime overhead.
991 /// @brief Construct a CallInst from a range of arguments
992 template<typename InputIterator>
993 inline CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
994 const Twine &NameStr, BasicBlock *InsertAtEnd);
996 CallInst(Value *F, Value *Actual, const Twine &NameStr,
997 Instruction *InsertBefore);
998 CallInst(Value *F, Value *Actual, const Twine &NameStr,
999 BasicBlock *InsertAtEnd);
1000 explicit CallInst(Value *F, const Twine &NameStr,
1001 Instruction *InsertBefore);
1002 CallInst(Value *F, const Twine &NameStr, BasicBlock *InsertAtEnd);
1004 template<typename InputIterator>
1005 static CallInst *Create(Value *Func,
1006 InputIterator ArgBegin, InputIterator ArgEnd,
1007 const Twine &NameStr = "",
1008 Instruction *InsertBefore = 0) {
1009 return new((unsigned)(ArgEnd - ArgBegin + 1))
1010 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertBefore);
1012 template<typename InputIterator>
1013 static CallInst *Create(Value *Func,
1014 InputIterator ArgBegin, InputIterator ArgEnd,
1015 const Twine &NameStr, BasicBlock *InsertAtEnd) {
1016 return new((unsigned)(ArgEnd - ArgBegin + 1))
1017 CallInst(Func, ArgBegin, ArgEnd, NameStr, InsertAtEnd);
1019 static CallInst *Create(Value *F, Value *Actual,
1020 const Twine &NameStr = "",
1021 Instruction *InsertBefore = 0) {
1022 return new(2) CallInst(F, Actual, NameStr, InsertBefore);
1024 static CallInst *Create(Value *F, Value *Actual, const Twine &NameStr,
1025 BasicBlock *InsertAtEnd) {
1026 return new(2) CallInst(F, Actual, NameStr, InsertAtEnd);
1028 static CallInst *Create(Value *F, const Twine &NameStr = "",
1029 Instruction *InsertBefore = 0) {
1030 return new(1) CallInst(F, NameStr, InsertBefore);
1032 static CallInst *Create(Value *F, const Twine &NameStr,
1033 BasicBlock *InsertAtEnd) {
1034 return new(1) CallInst(F, NameStr, InsertAtEnd);
1036 /// CreateMalloc - Generate the IR for a call to malloc:
1037 /// 1. Compute the malloc call's argument as the specified type's size,
1038 /// possibly multiplied by the array size if the array size is not
1040 /// 2. Call malloc with that argument.
1041 /// 3. Bitcast the result of the malloc call to the specified type.
1042 static Value *CreateMalloc(Instruction *InsertBefore, const Type *IntPtrTy,
1043 const Type *AllocTy, Value *ArraySize = 0,
1044 const Twine &Name = "");
1045 static Value *CreateMalloc(BasicBlock *InsertAtEnd, const Type *IntPtrTy,
1046 const Type *AllocTy, Value *ArraySize = 0,
1047 Function* MallocF = 0, const Twine &Name = "");
1051 bool isTailCall() const { return SubclassData & 1; }
1052 void setTailCall(bool isTC = true) {
1053 SubclassData = (SubclassData & ~1) | unsigned(isTC);
1056 virtual CallInst *clone(LLVMContext &Context) const;
1058 /// Provide fast operand accessors
1059 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1061 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1063 CallingConv::ID getCallingConv() const {
1064 return static_cast<CallingConv::ID>(SubclassData >> 1);
1066 void setCallingConv(CallingConv::ID CC) {
1067 SubclassData = (SubclassData & 1) | (static_cast<unsigned>(CC) << 1);
1070 /// getAttributes - Return the parameter attributes for this call.
1072 const AttrListPtr &getAttributes() const { return AttributeList; }
1074 /// setAttributes - Set the parameter attributes for this call.
1076 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
1078 /// addAttribute - adds the attribute to the list of attributes.
1079 void addAttribute(unsigned i, Attributes attr);
1081 /// removeAttribute - removes the attribute from the list of attributes.
1082 void removeAttribute(unsigned i, Attributes attr);
1084 /// @brief Determine whether the call or the callee has the given attribute.
1085 bool paramHasAttr(unsigned i, Attributes attr) const;
1087 /// @brief Extract the alignment for a call or parameter (0=unknown).
1088 unsigned getParamAlignment(unsigned i) const {
1089 return AttributeList.getParamAlignment(i);
1092 /// @brief Determine if the call does not access memory.
1093 bool doesNotAccessMemory() const {
1094 return paramHasAttr(~0, Attribute::ReadNone);
1096 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
1097 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
1098 else removeAttribute(~0, Attribute::ReadNone);
1101 /// @brief Determine if the call does not access or only reads memory.
1102 bool onlyReadsMemory() const {
1103 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
1105 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
1106 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
1107 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
1110 /// @brief Determine if the call cannot return.
1111 bool doesNotReturn() const {
1112 return paramHasAttr(~0, Attribute::NoReturn);
1114 void setDoesNotReturn(bool DoesNotReturn = true) {
1115 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
1116 else removeAttribute(~0, Attribute::NoReturn);
1119 /// @brief Determine if the call cannot unwind.
1120 bool doesNotThrow() const {
1121 return paramHasAttr(~0, Attribute::NoUnwind);
1123 void setDoesNotThrow(bool DoesNotThrow = true) {
1124 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
1125 else removeAttribute(~0, Attribute::NoUnwind);
1128 /// @brief Determine if the call returns a structure through first
1129 /// pointer argument.
1130 bool hasStructRetAttr() const {
1131 // Be friendly and also check the callee.
1132 return paramHasAttr(1, Attribute::StructRet);
1135 /// @brief Determine if any call argument is an aggregate passed by value.
1136 bool hasByValArgument() const {
1137 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
1140 /// getCalledFunction - Return the function called, or null if this is an
1141 /// indirect function invocation.
1143 Function *getCalledFunction() const {
1144 return dyn_cast<Function>(Op<0>());
1147 /// getCalledValue - Get a pointer to the function that is invoked by this
1149 const Value *getCalledValue() const { return Op<0>(); }
1150 Value *getCalledValue() { return Op<0>(); }
1152 /// setCalledFunction - Set the function called
1153 void setCalledFunction(Value* Fn) {
1157 // Methods for support type inquiry through isa, cast, and dyn_cast:
1158 static inline bool classof(const CallInst *) { return true; }
1159 static inline bool classof(const Instruction *I) {
1160 return I->getOpcode() == Instruction::Call;
1162 static inline bool classof(const Value *V) {
1163 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1168 struct OperandTraits<CallInst> : public VariadicOperandTraits<1> {
1171 template<typename InputIterator>
1172 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1173 const Twine &NameStr, BasicBlock *InsertAtEnd)
1174 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1175 ->getElementType())->getReturnType(),
1177 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1178 (unsigned)(ArgEnd - ArgBegin + 1), InsertAtEnd) {
1179 init(Func, ArgBegin, ArgEnd, NameStr,
1180 typename std::iterator_traits<InputIterator>::iterator_category());
1183 template<typename InputIterator>
1184 CallInst::CallInst(Value *Func, InputIterator ArgBegin, InputIterator ArgEnd,
1185 const Twine &NameStr, Instruction *InsertBefore)
1186 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
1187 ->getElementType())->getReturnType(),
1189 OperandTraits<CallInst>::op_end(this) - (ArgEnd - ArgBegin + 1),
1190 (unsigned)(ArgEnd - ArgBegin + 1), InsertBefore) {
1191 init(Func, ArgBegin, ArgEnd, NameStr,
1192 typename std::iterator_traits<InputIterator>::iterator_category());
1195 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(CallInst, Value)
1197 //===----------------------------------------------------------------------===//
1199 //===----------------------------------------------------------------------===//
1201 /// SelectInst - This class represents the LLVM 'select' instruction.
1203 class SelectInst : public Instruction {
1204 void init(Value *C, Value *S1, Value *S2) {
1205 assert(!areInvalidOperands(C, S1, S2) && "Invalid operands for select");
1211 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1212 Instruction *InsertBefore)
1213 : Instruction(S1->getType(), Instruction::Select,
1214 &Op<0>(), 3, InsertBefore) {
1218 SelectInst(Value *C, Value *S1, Value *S2, const Twine &NameStr,
1219 BasicBlock *InsertAtEnd)
1220 : Instruction(S1->getType(), Instruction::Select,
1221 &Op<0>(), 3, InsertAtEnd) {
1226 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1227 const Twine &NameStr = "",
1228 Instruction *InsertBefore = 0) {
1229 return new(3) SelectInst(C, S1, S2, NameStr, InsertBefore);
1231 static SelectInst *Create(Value *C, Value *S1, Value *S2,
1232 const Twine &NameStr,
1233 BasicBlock *InsertAtEnd) {
1234 return new(3) SelectInst(C, S1, S2, NameStr, InsertAtEnd);
1237 const Value *getCondition() const { return Op<0>(); }
1238 const Value *getTrueValue() const { return Op<1>(); }
1239 const Value *getFalseValue() const { return Op<2>(); }
1240 Value *getCondition() { return Op<0>(); }
1241 Value *getTrueValue() { return Op<1>(); }
1242 Value *getFalseValue() { return Op<2>(); }
1244 /// areInvalidOperands - Return a string if the specified operands are invalid
1245 /// for a select operation, otherwise return null.
1246 static const char *areInvalidOperands(Value *Cond, Value *True, Value *False);
1248 /// Transparently provide more efficient getOperand methods.
1249 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1251 OtherOps getOpcode() const {
1252 return static_cast<OtherOps>(Instruction::getOpcode());
1255 virtual SelectInst *clone(LLVMContext &Context) const;
1257 // Methods for support type inquiry through isa, cast, and dyn_cast:
1258 static inline bool classof(const SelectInst *) { return true; }
1259 static inline bool classof(const Instruction *I) {
1260 return I->getOpcode() == Instruction::Select;
1262 static inline bool classof(const Value *V) {
1263 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1268 struct OperandTraits<SelectInst> : public FixedNumOperandTraits<3> {
1271 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SelectInst, Value)
1273 //===----------------------------------------------------------------------===//
1275 //===----------------------------------------------------------------------===//
1277 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
1278 /// an argument of the specified type given a va_list and increments that list
1280 class VAArgInst : public UnaryInstruction {
1282 VAArgInst(Value *List, const Type *Ty, const Twine &NameStr = "",
1283 Instruction *InsertBefore = 0)
1284 : UnaryInstruction(Ty, VAArg, List, InsertBefore) {
1287 VAArgInst(Value *List, const Type *Ty, const Twine &NameStr,
1288 BasicBlock *InsertAtEnd)
1289 : UnaryInstruction(Ty, VAArg, List, InsertAtEnd) {
1293 virtual VAArgInst *clone(LLVMContext &Context) const;
1295 // Methods for support type inquiry through isa, cast, and dyn_cast:
1296 static inline bool classof(const VAArgInst *) { return true; }
1297 static inline bool classof(const Instruction *I) {
1298 return I->getOpcode() == VAArg;
1300 static inline bool classof(const Value *V) {
1301 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1305 //===----------------------------------------------------------------------===//
1306 // ExtractElementInst Class
1307 //===----------------------------------------------------------------------===//
1309 /// ExtractElementInst - This instruction extracts a single (scalar)
1310 /// element from a VectorType value
1312 class ExtractElementInst : public Instruction {
1313 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr = "",
1314 Instruction *InsertBefore = 0);
1315 ExtractElementInst(Value *Vec, Value *Idx, const Twine &NameStr,
1316 BasicBlock *InsertAtEnd);
1318 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1319 const Twine &NameStr = "",
1320 Instruction *InsertBefore = 0) {
1321 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertBefore);
1323 static ExtractElementInst *Create(Value *Vec, Value *Idx,
1324 const Twine &NameStr,
1325 BasicBlock *InsertAtEnd) {
1326 return new(2) ExtractElementInst(Vec, Idx, NameStr, InsertAtEnd);
1329 /// isValidOperands - Return true if an extractelement instruction can be
1330 /// formed with the specified operands.
1331 static bool isValidOperands(const Value *Vec, const Value *Idx);
1333 virtual ExtractElementInst *clone(LLVMContext &Context) const;
1335 Value *getVectorOperand() { return Op<0>(); }
1336 Value *getIndexOperand() { return Op<1>(); }
1337 const Value *getVectorOperand() const { return Op<0>(); }
1338 const Value *getIndexOperand() const { return Op<1>(); }
1340 const VectorType *getVectorOperandType() const {
1341 return reinterpret_cast<const VectorType*>(getVectorOperand()->getType());
1345 /// Transparently provide more efficient getOperand methods.
1346 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1348 // Methods for support type inquiry through isa, cast, and dyn_cast:
1349 static inline bool classof(const ExtractElementInst *) { return true; }
1350 static inline bool classof(const Instruction *I) {
1351 return I->getOpcode() == Instruction::ExtractElement;
1353 static inline bool classof(const Value *V) {
1354 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1359 struct OperandTraits<ExtractElementInst> : public FixedNumOperandTraits<2> {
1362 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ExtractElementInst, Value)
1364 //===----------------------------------------------------------------------===//
1365 // InsertElementInst Class
1366 //===----------------------------------------------------------------------===//
1368 /// InsertElementInst - This instruction inserts a single (scalar)
1369 /// element into a VectorType value
1371 class InsertElementInst : public Instruction {
1372 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1373 const Twine &NameStr = "",
1374 Instruction *InsertBefore = 0);
1375 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
1376 const Twine &NameStr, BasicBlock *InsertAtEnd);
1378 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1379 const Twine &NameStr = "",
1380 Instruction *InsertBefore = 0) {
1381 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertBefore);
1383 static InsertElementInst *Create(Value *Vec, Value *NewElt, Value *Idx,
1384 const Twine &NameStr,
1385 BasicBlock *InsertAtEnd) {
1386 return new(3) InsertElementInst(Vec, NewElt, Idx, NameStr, InsertAtEnd);
1389 /// isValidOperands - Return true if an insertelement instruction can be
1390 /// formed with the specified operands.
1391 static bool isValidOperands(const Value *Vec, const Value *NewElt,
1394 virtual InsertElementInst *clone(LLVMContext &Context) const;
1396 /// getType - Overload to return most specific vector type.
1398 const VectorType *getType() const {
1399 return reinterpret_cast<const VectorType*>(Instruction::getType());
1402 /// Transparently provide more efficient getOperand methods.
1403 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1405 // Methods for support type inquiry through isa, cast, and dyn_cast:
1406 static inline bool classof(const InsertElementInst *) { return true; }
1407 static inline bool classof(const Instruction *I) {
1408 return I->getOpcode() == Instruction::InsertElement;
1410 static inline bool classof(const Value *V) {
1411 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1416 struct OperandTraits<InsertElementInst> : public FixedNumOperandTraits<3> {
1419 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertElementInst, Value)
1421 //===----------------------------------------------------------------------===//
1422 // ShuffleVectorInst Class
1423 //===----------------------------------------------------------------------===//
1425 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
1428 class ShuffleVectorInst : public Instruction {
1430 // allocate space for exactly three operands
1431 void *operator new(size_t s) {
1432 return User::operator new(s, 3);
1434 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1435 const Twine &NameStr = "",
1436 Instruction *InsertBefor = 0);
1437 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1438 const Twine &NameStr, BasicBlock *InsertAtEnd);
1440 /// isValidOperands - Return true if a shufflevector instruction can be
1441 /// formed with the specified operands.
1442 static bool isValidOperands(const Value *V1, const Value *V2,
1445 virtual ShuffleVectorInst *clone(LLVMContext &Context) const;
1447 /// getType - Overload to return most specific vector type.
1449 const VectorType *getType() const {
1450 return reinterpret_cast<const VectorType*>(Instruction::getType());
1453 /// Transparently provide more efficient getOperand methods.
1454 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1456 /// getMaskValue - Return the index from the shuffle mask for the specified
1457 /// output result. This is either -1 if the element is undef or a number less
1458 /// than 2*numelements.
1459 int getMaskValue(unsigned i) const;
1461 // Methods for support type inquiry through isa, cast, and dyn_cast:
1462 static inline bool classof(const ShuffleVectorInst *) { return true; }
1463 static inline bool classof(const Instruction *I) {
1464 return I->getOpcode() == Instruction::ShuffleVector;
1466 static inline bool classof(const Value *V) {
1467 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1472 struct OperandTraits<ShuffleVectorInst> : public FixedNumOperandTraits<3> {
1475 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ShuffleVectorInst, Value)
1477 //===----------------------------------------------------------------------===//
1478 // ExtractValueInst Class
1479 //===----------------------------------------------------------------------===//
1481 /// ExtractValueInst - This instruction extracts a struct member or array
1482 /// element value from an aggregate value.
1484 class ExtractValueInst : public UnaryInstruction {
1485 SmallVector<unsigned, 4> Indices;
1487 ExtractValueInst(const ExtractValueInst &EVI);
1488 void init(const unsigned *Idx, unsigned NumIdx,
1489 const Twine &NameStr);
1490 void init(unsigned Idx, const Twine &NameStr);
1492 template<typename InputIterator>
1493 void init(InputIterator IdxBegin, InputIterator IdxEnd,
1494 const Twine &NameStr,
1495 // This argument ensures that we have an iterator we can
1496 // do arithmetic on in constant time
1497 std::random_access_iterator_tag) {
1498 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1500 // There's no fundamental reason why we require at least one index
1501 // (other than weirdness with &*IdxBegin being invalid; see
1502 // getelementptr's init routine for example). But there's no
1503 // present need to support it.
1504 assert(NumIdx > 0 && "ExtractValueInst must have at least one index");
1506 // This requires that the iterator points to contiguous memory.
1507 init(&*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1508 // we have to build an array here
1511 /// getIndexedType - Returns the type of the element that would be extracted
1512 /// with an extractvalue instruction with the specified parameters.
1514 /// Null is returned if the indices are invalid for the specified
1517 static const Type *getIndexedType(const Type *Agg,
1518 const unsigned *Idx, unsigned NumIdx);
1520 template<typename InputIterator>
1521 static const Type *getIndexedType(const Type *Ptr,
1522 InputIterator IdxBegin,
1523 InputIterator IdxEnd,
1524 // This argument ensures that we
1525 // have an iterator we can do
1526 // arithmetic on in constant time
1527 std::random_access_iterator_tag) {
1528 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1531 // This requires that the iterator points to contiguous memory.
1532 return getIndexedType(Ptr, &*IdxBegin, NumIdx);
1534 return getIndexedType(Ptr, (const unsigned *)0, NumIdx);
1537 /// Constructors - Create a extractvalue instruction with a base aggregate
1538 /// value and a list of indices. The first ctor can optionally insert before
1539 /// an existing instruction, the second appends the new instruction to the
1540 /// specified BasicBlock.
1541 template<typename InputIterator>
1542 inline ExtractValueInst(Value *Agg, InputIterator IdxBegin,
1543 InputIterator IdxEnd,
1544 const Twine &NameStr,
1545 Instruction *InsertBefore);
1546 template<typename InputIterator>
1547 inline ExtractValueInst(Value *Agg,
1548 InputIterator IdxBegin, InputIterator IdxEnd,
1549 const Twine &NameStr, BasicBlock *InsertAtEnd);
1551 // allocate space for exactly one operand
1552 void *operator new(size_t s) {
1553 return User::operator new(s, 1);
1557 template<typename InputIterator>
1558 static ExtractValueInst *Create(Value *Agg, InputIterator IdxBegin,
1559 InputIterator IdxEnd,
1560 const Twine &NameStr = "",
1561 Instruction *InsertBefore = 0) {
1563 ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertBefore);
1565 template<typename InputIterator>
1566 static ExtractValueInst *Create(Value *Agg,
1567 InputIterator IdxBegin, InputIterator IdxEnd,
1568 const Twine &NameStr,
1569 BasicBlock *InsertAtEnd) {
1570 return new ExtractValueInst(Agg, IdxBegin, IdxEnd, NameStr, InsertAtEnd);
1573 /// Constructors - These two creators are convenience methods because one
1574 /// index extractvalue instructions are much more common than those with
1576 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1577 const Twine &NameStr = "",
1578 Instruction *InsertBefore = 0) {
1579 unsigned Idxs[1] = { Idx };
1580 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertBefore);
1582 static ExtractValueInst *Create(Value *Agg, unsigned Idx,
1583 const Twine &NameStr,
1584 BasicBlock *InsertAtEnd) {
1585 unsigned Idxs[1] = { Idx };
1586 return new ExtractValueInst(Agg, Idxs, Idxs + 1, NameStr, InsertAtEnd);
1589 virtual ExtractValueInst *clone(LLVMContext &Context) const;
1591 /// getIndexedType - Returns the type of the element that would be extracted
1592 /// with an extractvalue instruction with the specified parameters.
1594 /// Null is returned if the indices are invalid for the specified
1597 template<typename InputIterator>
1598 static const Type *getIndexedType(const Type *Ptr,
1599 InputIterator IdxBegin,
1600 InputIterator IdxEnd) {
1601 return getIndexedType(Ptr, IdxBegin, IdxEnd,
1602 typename std::iterator_traits<InputIterator>::
1603 iterator_category());
1605 static const Type *getIndexedType(const Type *Ptr, unsigned Idx);
1607 typedef const unsigned* idx_iterator;
1608 inline idx_iterator idx_begin() const { return Indices.begin(); }
1609 inline idx_iterator idx_end() const { return Indices.end(); }
1611 Value *getAggregateOperand() {
1612 return getOperand(0);
1614 const Value *getAggregateOperand() const {
1615 return getOperand(0);
1617 static unsigned getAggregateOperandIndex() {
1618 return 0U; // get index for modifying correct operand
1621 unsigned getNumIndices() const { // Note: always non-negative
1622 return (unsigned)Indices.size();
1625 bool hasIndices() const {
1629 // Methods for support type inquiry through isa, cast, and dyn_cast:
1630 static inline bool classof(const ExtractValueInst *) { return true; }
1631 static inline bool classof(const Instruction *I) {
1632 return I->getOpcode() == Instruction::ExtractValue;
1634 static inline bool classof(const Value *V) {
1635 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1639 template<typename InputIterator>
1640 ExtractValueInst::ExtractValueInst(Value *Agg,
1641 InputIterator IdxBegin,
1642 InputIterator IdxEnd,
1643 const Twine &NameStr,
1644 Instruction *InsertBefore)
1645 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1647 ExtractValue, Agg, InsertBefore) {
1648 init(IdxBegin, IdxEnd, NameStr,
1649 typename std::iterator_traits<InputIterator>::iterator_category());
1651 template<typename InputIterator>
1652 ExtractValueInst::ExtractValueInst(Value *Agg,
1653 InputIterator IdxBegin,
1654 InputIterator IdxEnd,
1655 const Twine &NameStr,
1656 BasicBlock *InsertAtEnd)
1657 : UnaryInstruction(checkType(getIndexedType(Agg->getType(),
1659 ExtractValue, Agg, InsertAtEnd) {
1660 init(IdxBegin, IdxEnd, NameStr,
1661 typename std::iterator_traits<InputIterator>::iterator_category());
1665 //===----------------------------------------------------------------------===//
1666 // InsertValueInst Class
1667 //===----------------------------------------------------------------------===//
1669 /// InsertValueInst - This instruction inserts a struct field of array element
1670 /// value into an aggregate value.
1672 class InsertValueInst : public Instruction {
1673 SmallVector<unsigned, 4> Indices;
1675 void *operator new(size_t, unsigned); // Do not implement
1676 InsertValueInst(const InsertValueInst &IVI);
1677 void init(Value *Agg, Value *Val, const unsigned *Idx, unsigned NumIdx,
1678 const Twine &NameStr);
1679 void init(Value *Agg, Value *Val, unsigned Idx, const Twine &NameStr);
1681 template<typename InputIterator>
1682 void init(Value *Agg, Value *Val,
1683 InputIterator IdxBegin, InputIterator IdxEnd,
1684 const Twine &NameStr,
1685 // This argument ensures that we have an iterator we can
1686 // do arithmetic on in constant time
1687 std::random_access_iterator_tag) {
1688 unsigned NumIdx = static_cast<unsigned>(std::distance(IdxBegin, IdxEnd));
1690 // There's no fundamental reason why we require at least one index
1691 // (other than weirdness with &*IdxBegin being invalid; see
1692 // getelementptr's init routine for example). But there's no
1693 // present need to support it.
1694 assert(NumIdx > 0 && "InsertValueInst must have at least one index");
1696 // This requires that the iterator points to contiguous memory.
1697 init(Agg, Val, &*IdxBegin, NumIdx, NameStr); // FIXME: for the general case
1698 // we have to build an array here
1701 /// Constructors - Create a insertvalue instruction with a base aggregate
1702 /// value, a value to insert, and a list of indices. The first ctor can
1703 /// optionally insert before an existing instruction, the second appends
1704 /// the new instruction to the specified BasicBlock.
1705 template<typename InputIterator>
1706 inline InsertValueInst(Value *Agg, Value *Val, InputIterator IdxBegin,
1707 InputIterator IdxEnd,
1708 const Twine &NameStr,
1709 Instruction *InsertBefore);
1710 template<typename InputIterator>
1711 inline InsertValueInst(Value *Agg, Value *Val,
1712 InputIterator IdxBegin, InputIterator IdxEnd,
1713 const Twine &NameStr, BasicBlock *InsertAtEnd);
1715 /// Constructors - These two constructors are convenience methods because one
1716 /// and two index insertvalue instructions are so common.
1717 InsertValueInst(Value *Agg, Value *Val,
1718 unsigned Idx, const Twine &NameStr = "",
1719 Instruction *InsertBefore = 0);
1720 InsertValueInst(Value *Agg, Value *Val, unsigned Idx,
1721 const Twine &NameStr, BasicBlock *InsertAtEnd);
1723 // allocate space for exactly two operands
1724 void *operator new(size_t s) {
1725 return User::operator new(s, 2);
1728 template<typename InputIterator>
1729 static InsertValueInst *Create(Value *Agg, Value *Val, InputIterator IdxBegin,
1730 InputIterator IdxEnd,
1731 const Twine &NameStr = "",
1732 Instruction *InsertBefore = 0) {
1733 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1734 NameStr, InsertBefore);
1736 template<typename InputIterator>
1737 static InsertValueInst *Create(Value *Agg, Value *Val,
1738 InputIterator IdxBegin, InputIterator IdxEnd,
1739 const Twine &NameStr,
1740 BasicBlock *InsertAtEnd) {
1741 return new InsertValueInst(Agg, Val, IdxBegin, IdxEnd,
1742 NameStr, InsertAtEnd);
1745 /// Constructors - These two creators are convenience methods because one
1746 /// index insertvalue instructions are much more common than those with
1748 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1749 const Twine &NameStr = "",
1750 Instruction *InsertBefore = 0) {
1751 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertBefore);
1753 static InsertValueInst *Create(Value *Agg, Value *Val, unsigned Idx,
1754 const Twine &NameStr,
1755 BasicBlock *InsertAtEnd) {
1756 return new InsertValueInst(Agg, Val, Idx, NameStr, InsertAtEnd);
1759 virtual InsertValueInst *clone(LLVMContext &Context) const;
1761 /// Transparently provide more efficient getOperand methods.
1762 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1764 typedef const unsigned* idx_iterator;
1765 inline idx_iterator idx_begin() const { return Indices.begin(); }
1766 inline idx_iterator idx_end() const { return Indices.end(); }
1768 Value *getAggregateOperand() {
1769 return getOperand(0);
1771 const Value *getAggregateOperand() const {
1772 return getOperand(0);
1774 static unsigned getAggregateOperandIndex() {
1775 return 0U; // get index for modifying correct operand
1778 Value *getInsertedValueOperand() {
1779 return getOperand(1);
1781 const Value *getInsertedValueOperand() const {
1782 return getOperand(1);
1784 static unsigned getInsertedValueOperandIndex() {
1785 return 1U; // get index for modifying correct operand
1788 unsigned getNumIndices() const { // Note: always non-negative
1789 return (unsigned)Indices.size();
1792 bool hasIndices() const {
1796 // Methods for support type inquiry through isa, cast, and dyn_cast:
1797 static inline bool classof(const InsertValueInst *) { return true; }
1798 static inline bool classof(const Instruction *I) {
1799 return I->getOpcode() == Instruction::InsertValue;
1801 static inline bool classof(const Value *V) {
1802 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1807 struct OperandTraits<InsertValueInst> : public FixedNumOperandTraits<2> {
1810 template<typename InputIterator>
1811 InsertValueInst::InsertValueInst(Value *Agg,
1813 InputIterator IdxBegin,
1814 InputIterator IdxEnd,
1815 const Twine &NameStr,
1816 Instruction *InsertBefore)
1817 : Instruction(Agg->getType(), InsertValue,
1818 OperandTraits<InsertValueInst>::op_begin(this),
1820 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1821 typename std::iterator_traits<InputIterator>::iterator_category());
1823 template<typename InputIterator>
1824 InsertValueInst::InsertValueInst(Value *Agg,
1826 InputIterator IdxBegin,
1827 InputIterator IdxEnd,
1828 const Twine &NameStr,
1829 BasicBlock *InsertAtEnd)
1830 : Instruction(Agg->getType(), InsertValue,
1831 OperandTraits<InsertValueInst>::op_begin(this),
1833 init(Agg, Val, IdxBegin, IdxEnd, NameStr,
1834 typename std::iterator_traits<InputIterator>::iterator_category());
1837 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InsertValueInst, Value)
1839 //===----------------------------------------------------------------------===//
1841 //===----------------------------------------------------------------------===//
1843 // PHINode - The PHINode class is used to represent the magical mystical PHI
1844 // node, that can not exist in nature, but can be synthesized in a computer
1845 // scientist's overactive imagination.
1847 class PHINode : public Instruction {
1848 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1849 /// ReservedSpace - The number of operands actually allocated. NumOperands is
1850 /// the number actually in use.
1851 unsigned ReservedSpace;
1852 PHINode(const PHINode &PN);
1853 // allocate space for exactly zero operands
1854 void *operator new(size_t s) {
1855 return User::operator new(s, 0);
1857 explicit PHINode(const Type *Ty, const Twine &NameStr = "",
1858 Instruction *InsertBefore = 0)
1859 : Instruction(Ty, Instruction::PHI, 0, 0, InsertBefore),
1864 PHINode(const Type *Ty, const Twine &NameStr, BasicBlock *InsertAtEnd)
1865 : Instruction(Ty, Instruction::PHI, 0, 0, InsertAtEnd),
1870 static PHINode *Create(const Type *Ty, const Twine &NameStr = "",
1871 Instruction *InsertBefore = 0) {
1872 return new PHINode(Ty, NameStr, InsertBefore);
1874 static PHINode *Create(const Type *Ty, const Twine &NameStr,
1875 BasicBlock *InsertAtEnd) {
1876 return new PHINode(Ty, NameStr, InsertAtEnd);
1880 /// reserveOperandSpace - This method can be used to avoid repeated
1881 /// reallocation of PHI operand lists by reserving space for the correct
1882 /// number of operands before adding them. Unlike normal vector reserves,
1883 /// this method can also be used to trim the operand space.
1884 void reserveOperandSpace(unsigned NumValues) {
1885 resizeOperands(NumValues*2);
1888 virtual PHINode *clone(LLVMContext &Context) const;
1890 /// Provide fast operand accessors
1891 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
1893 /// getNumIncomingValues - Return the number of incoming edges
1895 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
1897 /// getIncomingValue - Return incoming value number x
1899 Value *getIncomingValue(unsigned i) const {
1900 assert(i*2 < getNumOperands() && "Invalid value number!");
1901 return getOperand(i*2);
1903 void setIncomingValue(unsigned i, Value *V) {
1904 assert(i*2 < getNumOperands() && "Invalid value number!");
1907 static unsigned getOperandNumForIncomingValue(unsigned i) {
1910 static unsigned getIncomingValueNumForOperand(unsigned i) {
1911 assert(i % 2 == 0 && "Invalid incoming-value operand index!");
1915 /// getIncomingBlock - Return incoming basic block corresponding
1916 /// to value use iterator
1918 template <typename U>
1919 BasicBlock *getIncomingBlock(value_use_iterator<U> I) const {
1920 assert(this == *I && "Iterator doesn't point to PHI's Uses?");
1921 return static_cast<BasicBlock*>((&I.getUse() + 1)->get());
1923 /// getIncomingBlock - Return incoming basic block number x
1925 BasicBlock *getIncomingBlock(unsigned i) const {
1926 return static_cast<BasicBlock*>(getOperand(i*2+1));
1928 void setIncomingBlock(unsigned i, BasicBlock *BB) {
1929 setOperand(i*2+1, BB);
1931 static unsigned getOperandNumForIncomingBlock(unsigned i) {
1934 static unsigned getIncomingBlockNumForOperand(unsigned i) {
1935 assert(i % 2 == 1 && "Invalid incoming-block operand index!");
1939 /// addIncoming - Add an incoming value to the end of the PHI list
1941 void addIncoming(Value *V, BasicBlock *BB) {
1942 assert(V && "PHI node got a null value!");
1943 assert(BB && "PHI node got a null basic block!");
1944 assert(getType() == V->getType() &&
1945 "All operands to PHI node must be the same type as the PHI node!");
1946 unsigned OpNo = NumOperands;
1947 if (OpNo+2 > ReservedSpace)
1948 resizeOperands(0); // Get more space!
1949 // Initialize some new operands.
1950 NumOperands = OpNo+2;
1951 OperandList[OpNo] = V;
1952 OperandList[OpNo+1] = BB;
1955 /// removeIncomingValue - Remove an incoming value. This is useful if a
1956 /// predecessor basic block is deleted. The value removed is returned.
1958 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
1959 /// is true), the PHI node is destroyed and any uses of it are replaced with
1960 /// dummy values. The only time there should be zero incoming values to a PHI
1961 /// node is when the block is dead, so this strategy is sound.
1963 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
1965 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty=true) {
1966 int Idx = getBasicBlockIndex(BB);
1967 assert(Idx >= 0 && "Invalid basic block argument to remove!");
1968 return removeIncomingValue(Idx, DeletePHIIfEmpty);
1971 /// getBasicBlockIndex - Return the first index of the specified basic
1972 /// block in the value list for this PHI. Returns -1 if no instance.
1974 int getBasicBlockIndex(const BasicBlock *BB) const {
1975 Use *OL = OperandList;
1976 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
1977 if (OL[i+1].get() == BB) return i/2;
1981 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
1982 return getIncomingValue(getBasicBlockIndex(BB));
1985 /// hasConstantValue - If the specified PHI node always merges together the
1986 /// same value, return the value, otherwise return null.
1988 /// If the PHI has undef operands, but all the rest of the operands are
1989 /// some unique value, return that value if it can be proved that the
1990 /// value dominates the PHI. If DT is null, use a conservative check,
1991 /// otherwise use DT to test for dominance.
1993 Value *hasConstantValue(DominatorTree *DT = 0) const;
1995 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1996 static inline bool classof(const PHINode *) { return true; }
1997 static inline bool classof(const Instruction *I) {
1998 return I->getOpcode() == Instruction::PHI;
2000 static inline bool classof(const Value *V) {
2001 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2004 void resizeOperands(unsigned NumOperands);
2008 struct OperandTraits<PHINode> : public HungoffOperandTraits<2> {
2011 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(PHINode, Value)
2014 //===----------------------------------------------------------------------===//
2016 //===----------------------------------------------------------------------===//
2018 //===---------------------------------------------------------------------------
2019 /// ReturnInst - Return a value (possibly void), from a function. Execution
2020 /// does not continue in this function any longer.
2022 class ReturnInst : public TerminatorInst {
2023 ReturnInst(const ReturnInst &RI);
2026 // ReturnInst constructors:
2027 // ReturnInst() - 'ret void' instruction
2028 // ReturnInst( null) - 'ret void' instruction
2029 // ReturnInst(Value* X) - 'ret X' instruction
2030 // ReturnInst( null, Inst *I) - 'ret void' instruction, insert before I
2031 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
2032 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of B
2033 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of B
2035 // NOTE: If the Value* passed is of type void then the constructor behaves as
2036 // if it was passed NULL.
2037 explicit ReturnInst(LLVMContext &C, Value *retVal = 0,
2038 Instruction *InsertBefore = 0);
2039 ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd);
2040 explicit ReturnInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2042 static ReturnInst* Create(LLVMContext &C, Value *retVal = 0,
2043 Instruction *InsertBefore = 0) {
2044 return new(!!retVal) ReturnInst(C, retVal, InsertBefore);
2046 static ReturnInst* Create(LLVMContext &C, Value *retVal,
2047 BasicBlock *InsertAtEnd) {
2048 return new(!!retVal) ReturnInst(C, retVal, InsertAtEnd);
2050 static ReturnInst* Create(LLVMContext &C, BasicBlock *InsertAtEnd) {
2051 return new(0) ReturnInst(C, InsertAtEnd);
2053 virtual ~ReturnInst();
2055 virtual ReturnInst *clone(LLVMContext &Context) const;
2057 /// Provide fast operand accessors
2058 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2060 /// Convenience accessor
2061 Value *getReturnValue(unsigned n = 0) const {
2062 return n < getNumOperands()
2067 unsigned getNumSuccessors() const { return 0; }
2069 // Methods for support type inquiry through isa, cast, and dyn_cast:
2070 static inline bool classof(const ReturnInst *) { return true; }
2071 static inline bool classof(const Instruction *I) {
2072 return (I->getOpcode() == Instruction::Ret);
2074 static inline bool classof(const Value *V) {
2075 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2078 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2079 virtual unsigned getNumSuccessorsV() const;
2080 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2084 struct OperandTraits<ReturnInst> : public OptionalOperandTraits<> {
2087 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ReturnInst, Value)
2089 //===----------------------------------------------------------------------===//
2091 //===----------------------------------------------------------------------===//
2093 //===---------------------------------------------------------------------------
2094 /// BranchInst - Conditional or Unconditional Branch instruction.
2096 class BranchInst : public TerminatorInst {
2097 /// Ops list - Branches are strange. The operands are ordered:
2098 /// [Cond, FalseDest,] TrueDest. This makes some accessors faster because
2099 /// they don't have to check for cond/uncond branchness. These are mostly
2100 /// accessed relative from op_end().
2101 BranchInst(const BranchInst &BI);
2103 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
2104 // BranchInst(BB *B) - 'br B'
2105 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
2106 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
2107 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
2108 // BranchInst(BB* B, BB *I) - 'br B' insert at end
2109 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
2110 explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0);
2111 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2112 Instruction *InsertBefore = 0);
2113 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd);
2114 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
2115 BasicBlock *InsertAtEnd);
2117 static BranchInst *Create(BasicBlock *IfTrue, Instruction *InsertBefore = 0) {
2118 return new(1, true) BranchInst(IfTrue, InsertBefore);
2120 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2121 Value *Cond, Instruction *InsertBefore = 0) {
2122 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertBefore);
2124 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *InsertAtEnd) {
2125 return new(1, true) BranchInst(IfTrue, InsertAtEnd);
2127 static BranchInst *Create(BasicBlock *IfTrue, BasicBlock *IfFalse,
2128 Value *Cond, BasicBlock *InsertAtEnd) {
2129 return new(3) BranchInst(IfTrue, IfFalse, Cond, InsertAtEnd);
2134 /// Transparently provide more efficient getOperand methods.
2135 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2137 virtual BranchInst *clone(LLVMContext &Context) const;
2139 bool isUnconditional() const { return getNumOperands() == 1; }
2140 bool isConditional() const { return getNumOperands() == 3; }
2142 Value *getCondition() const {
2143 assert(isConditional() && "Cannot get condition of an uncond branch!");
2147 void setCondition(Value *V) {
2148 assert(isConditional() && "Cannot set condition of unconditional branch!");
2152 // setUnconditionalDest - Change the current branch to an unconditional branch
2153 // targeting the specified block.
2154 // FIXME: Eliminate this ugly method.
2155 void setUnconditionalDest(BasicBlock *Dest) {
2157 if (isConditional()) { // Convert this to an uncond branch.
2161 OperandList = op_begin();
2165 unsigned getNumSuccessors() const { return 1+isConditional(); }
2167 BasicBlock *getSuccessor(unsigned i) const {
2168 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
2169 return cast_or_null<BasicBlock>((&Op<-1>() - i)->get());
2172 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2173 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
2174 *(&Op<-1>() - idx) = NewSucc;
2177 // Methods for support type inquiry through isa, cast, and dyn_cast:
2178 static inline bool classof(const BranchInst *) { return true; }
2179 static inline bool classof(const Instruction *I) {
2180 return (I->getOpcode() == Instruction::Br);
2182 static inline bool classof(const Value *V) {
2183 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2186 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2187 virtual unsigned getNumSuccessorsV() const;
2188 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2192 struct OperandTraits<BranchInst> : public VariadicOperandTraits<1> {};
2194 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BranchInst, Value)
2196 //===----------------------------------------------------------------------===//
2198 //===----------------------------------------------------------------------===//
2200 //===---------------------------------------------------------------------------
2201 /// SwitchInst - Multiway switch
2203 class SwitchInst : public TerminatorInst {
2204 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2205 unsigned ReservedSpace;
2206 // Operand[0] = Value to switch on
2207 // Operand[1] = Default basic block destination
2208 // Operand[2n ] = Value to match
2209 // Operand[2n+1] = BasicBlock to go to on match
2210 SwitchInst(const SwitchInst &RI);
2211 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
2212 void resizeOperands(unsigned No);
2213 // allocate space for exactly zero operands
2214 void *operator new(size_t s) {
2215 return User::operator new(s, 0);
2217 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2218 /// switch on and a default destination. The number of additional cases can
2219 /// be specified here to make memory allocation more efficient. This
2220 /// constructor can also autoinsert before another instruction.
2221 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2222 Instruction *InsertBefore = 0);
2224 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2225 /// switch on and a default destination. The number of additional cases can
2226 /// be specified here to make memory allocation more efficient. This
2227 /// constructor also autoinserts at the end of the specified BasicBlock.
2228 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2229 BasicBlock *InsertAtEnd);
2231 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2232 unsigned NumCases, Instruction *InsertBefore = 0) {
2233 return new SwitchInst(Value, Default, NumCases, InsertBefore);
2235 static SwitchInst *Create(Value *Value, BasicBlock *Default,
2236 unsigned NumCases, BasicBlock *InsertAtEnd) {
2237 return new SwitchInst(Value, Default, NumCases, InsertAtEnd);
2241 /// Provide fast operand accessors
2242 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2244 // Accessor Methods for Switch stmt
2245 Value *getCondition() const { return getOperand(0); }
2246 void setCondition(Value *V) { setOperand(0, V); }
2248 BasicBlock *getDefaultDest() const {
2249 return cast<BasicBlock>(getOperand(1));
2252 /// getNumCases - return the number of 'cases' in this switch instruction.
2253 /// Note that case #0 is always the default case.
2254 unsigned getNumCases() const {
2255 return getNumOperands()/2;
2258 /// getCaseValue - Return the specified case value. Note that case #0, the
2259 /// default destination, does not have a case value.
2260 ConstantInt *getCaseValue(unsigned i) {
2261 assert(i && i < getNumCases() && "Illegal case value to get!");
2262 return getSuccessorValue(i);
2265 /// getCaseValue - Return the specified case value. Note that case #0, the
2266 /// default destination, does not have a case value.
2267 const ConstantInt *getCaseValue(unsigned i) const {
2268 assert(i && i < getNumCases() && "Illegal case value to get!");
2269 return getSuccessorValue(i);
2272 /// findCaseValue - Search all of the case values for the specified constant.
2273 /// If it is explicitly handled, return the case number of it, otherwise
2274 /// return 0 to indicate that it is handled by the default handler.
2275 unsigned findCaseValue(const ConstantInt *C) const {
2276 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
2277 if (getCaseValue(i) == C)
2282 /// findCaseDest - Finds the unique case value for a given successor. Returns
2283 /// null if the successor is not found, not unique, or is the default case.
2284 ConstantInt *findCaseDest(BasicBlock *BB) {
2285 if (BB == getDefaultDest()) return NULL;
2287 ConstantInt *CI = NULL;
2288 for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
2289 if (getSuccessor(i) == BB) {
2290 if (CI) return NULL; // Multiple cases lead to BB.
2291 else CI = getCaseValue(i);
2297 /// addCase - Add an entry to the switch instruction...
2299 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
2301 /// removeCase - This method removes the specified successor from the switch
2302 /// instruction. Note that this cannot be used to remove the default
2303 /// destination (successor #0).
2305 void removeCase(unsigned idx);
2307 virtual SwitchInst *clone(LLVMContext &Context) const;
2309 unsigned getNumSuccessors() const { return getNumOperands()/2; }
2310 BasicBlock *getSuccessor(unsigned idx) const {
2311 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
2312 return cast<BasicBlock>(getOperand(idx*2+1));
2314 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2315 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
2316 setOperand(idx*2+1, NewSucc);
2319 // getSuccessorValue - Return the value associated with the specified
2321 ConstantInt *getSuccessorValue(unsigned idx) const {
2322 assert(idx < getNumSuccessors() && "Successor # out of range!");
2323 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
2326 // Methods for support type inquiry through isa, cast, and dyn_cast:
2327 static inline bool classof(const SwitchInst *) { return true; }
2328 static inline bool classof(const Instruction *I) {
2329 return I->getOpcode() == Instruction::Switch;
2331 static inline bool classof(const Value *V) {
2332 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2335 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2336 virtual unsigned getNumSuccessorsV() const;
2337 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2341 struct OperandTraits<SwitchInst> : public HungoffOperandTraits<2> {
2344 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(SwitchInst, Value)
2347 //===----------------------------------------------------------------------===//
2349 //===----------------------------------------------------------------------===//
2351 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
2352 /// calling convention of the call.
2354 class InvokeInst : public TerminatorInst {
2355 AttrListPtr AttributeList;
2356 InvokeInst(const InvokeInst &BI);
2357 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
2358 Value* const *Args, unsigned NumArgs);
2360 template<typename InputIterator>
2361 void init(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2362 InputIterator ArgBegin, InputIterator ArgEnd,
2363 const Twine &NameStr,
2364 // This argument ensures that we have an iterator we can
2365 // do arithmetic on in constant time
2366 std::random_access_iterator_tag) {
2367 unsigned NumArgs = (unsigned)std::distance(ArgBegin, ArgEnd);
2369 // This requires that the iterator points to contiguous memory.
2370 init(Func, IfNormal, IfException, NumArgs ? &*ArgBegin : 0, NumArgs);
2374 /// Construct an InvokeInst given a range of arguments.
2375 /// InputIterator must be a random-access iterator pointing to
2376 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2377 /// made for random-accessness but not for contiguous storage as
2378 /// that would incur runtime overhead.
2380 /// @brief Construct an InvokeInst from a range of arguments
2381 template<typename InputIterator>
2382 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2383 InputIterator ArgBegin, InputIterator ArgEnd,
2385 const Twine &NameStr, Instruction *InsertBefore);
2387 /// Construct an InvokeInst given a range of arguments.
2388 /// InputIterator must be a random-access iterator pointing to
2389 /// contiguous storage (e.g. a std::vector<>::iterator). Checks are
2390 /// made for random-accessness but not for contiguous storage as
2391 /// that would incur runtime overhead.
2393 /// @brief Construct an InvokeInst from a range of arguments
2394 template<typename InputIterator>
2395 inline InvokeInst(Value *Func, BasicBlock *IfNormal, BasicBlock *IfException,
2396 InputIterator ArgBegin, InputIterator ArgEnd,
2398 const Twine &NameStr, BasicBlock *InsertAtEnd);
2400 template<typename InputIterator>
2401 static InvokeInst *Create(Value *Func,
2402 BasicBlock *IfNormal, BasicBlock *IfException,
2403 InputIterator ArgBegin, InputIterator ArgEnd,
2404 const Twine &NameStr = "",
2405 Instruction *InsertBefore = 0) {
2406 unsigned Values(ArgEnd - ArgBegin + 3);
2407 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2408 Values, NameStr, InsertBefore);
2410 template<typename InputIterator>
2411 static InvokeInst *Create(Value *Func,
2412 BasicBlock *IfNormal, BasicBlock *IfException,
2413 InputIterator ArgBegin, InputIterator ArgEnd,
2414 const Twine &NameStr,
2415 BasicBlock *InsertAtEnd) {
2416 unsigned Values(ArgEnd - ArgBegin + 3);
2417 return new(Values) InvokeInst(Func, IfNormal, IfException, ArgBegin, ArgEnd,
2418 Values, NameStr, InsertAtEnd);
2421 virtual InvokeInst *clone(LLVMContext &Context) const;
2423 /// Provide fast operand accessors
2424 DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
2426 /// getCallingConv/setCallingConv - Get or set the calling convention of this
2428 CallingConv::ID getCallingConv() const {
2429 return static_cast<CallingConv::ID>(SubclassData);
2431 void setCallingConv(CallingConv::ID CC) {
2432 SubclassData = static_cast<unsigned>(CC);
2435 /// getAttributes - Return the parameter attributes for this invoke.
2437 const AttrListPtr &getAttributes() const { return AttributeList; }
2439 /// setAttributes - Set the parameter attributes for this invoke.
2441 void setAttributes(const AttrListPtr &Attrs) { AttributeList = Attrs; }
2443 /// addAttribute - adds the attribute to the list of attributes.
2444 void addAttribute(unsigned i, Attributes attr);
2446 /// removeAttribute - removes the attribute from the list of attributes.
2447 void removeAttribute(unsigned i, Attributes attr);
2449 /// @brief Determine whether the call or the callee has the given attribute.
2450 bool paramHasAttr(unsigned i, Attributes attr) const;
2452 /// @brief Extract the alignment for a call or parameter (0=unknown).
2453 unsigned getParamAlignment(unsigned i) const {
2454 return AttributeList.getParamAlignment(i);
2457 /// @brief Determine if the call does not access memory.
2458 bool doesNotAccessMemory() const {
2459 return paramHasAttr(~0, Attribute::ReadNone);
2461 void setDoesNotAccessMemory(bool NotAccessMemory = true) {
2462 if (NotAccessMemory) addAttribute(~0, Attribute::ReadNone);
2463 else removeAttribute(~0, Attribute::ReadNone);
2466 /// @brief Determine if the call does not access or only reads memory.
2467 bool onlyReadsMemory() const {
2468 return doesNotAccessMemory() || paramHasAttr(~0, Attribute::ReadOnly);
2470 void setOnlyReadsMemory(bool OnlyReadsMemory = true) {
2471 if (OnlyReadsMemory) addAttribute(~0, Attribute::ReadOnly);
2472 else removeAttribute(~0, Attribute::ReadOnly | Attribute::ReadNone);
2475 /// @brief Determine if the call cannot return.
2476 bool doesNotReturn() const {
2477 return paramHasAttr(~0, Attribute::NoReturn);
2479 void setDoesNotReturn(bool DoesNotReturn = true) {
2480 if (DoesNotReturn) addAttribute(~0, Attribute::NoReturn);
2481 else removeAttribute(~0, Attribute::NoReturn);
2484 /// @brief Determine if the call cannot unwind.
2485 bool doesNotThrow() const {
2486 return paramHasAttr(~0, Attribute::NoUnwind);
2488 void setDoesNotThrow(bool DoesNotThrow = true) {
2489 if (DoesNotThrow) addAttribute(~0, Attribute::NoUnwind);
2490 else removeAttribute(~0, Attribute::NoUnwind);
2493 /// @brief Determine if the call returns a structure through first
2494 /// pointer argument.
2495 bool hasStructRetAttr() const {
2496 // Be friendly and also check the callee.
2497 return paramHasAttr(1, Attribute::StructRet);
2500 /// @brief Determine if any call argument is an aggregate passed by value.
2501 bool hasByValArgument() const {
2502 return AttributeList.hasAttrSomewhere(Attribute::ByVal);
2505 /// getCalledFunction - Return the function called, or null if this is an
2506 /// indirect function invocation.
2508 Function *getCalledFunction() const {
2509 return dyn_cast<Function>(getOperand(0));
2512 /// getCalledValue - Get a pointer to the function that is invoked by this
2514 const Value *getCalledValue() const { return getOperand(0); }
2515 Value *getCalledValue() { return getOperand(0); }
2517 // get*Dest - Return the destination basic blocks...
2518 BasicBlock *getNormalDest() const {
2519 return cast<BasicBlock>(getOperand(1));
2521 BasicBlock *getUnwindDest() const {
2522 return cast<BasicBlock>(getOperand(2));
2524 void setNormalDest(BasicBlock *B) {
2528 void setUnwindDest(BasicBlock *B) {
2532 BasicBlock *getSuccessor(unsigned i) const {
2533 assert(i < 2 && "Successor # out of range for invoke!");
2534 return i == 0 ? getNormalDest() : getUnwindDest();
2537 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
2538 assert(idx < 2 && "Successor # out of range for invoke!");
2539 setOperand(idx+1, NewSucc);
2542 unsigned getNumSuccessors() const { return 2; }
2544 // Methods for support type inquiry through isa, cast, and dyn_cast:
2545 static inline bool classof(const InvokeInst *) { return true; }
2546 static inline bool classof(const Instruction *I) {
2547 return (I->getOpcode() == Instruction::Invoke);
2549 static inline bool classof(const Value *V) {
2550 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2553 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2554 virtual unsigned getNumSuccessorsV() const;
2555 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2559 struct OperandTraits<InvokeInst> : public VariadicOperandTraits<3> {
2562 template<typename InputIterator>
2563 InvokeInst::InvokeInst(Value *Func,
2564 BasicBlock *IfNormal, BasicBlock *IfException,
2565 InputIterator ArgBegin, InputIterator ArgEnd,
2567 const Twine &NameStr, Instruction *InsertBefore)
2568 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2569 ->getElementType())->getReturnType(),
2570 Instruction::Invoke,
2571 OperandTraits<InvokeInst>::op_end(this) - Values,
2572 Values, InsertBefore) {
2573 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2574 typename std::iterator_traits<InputIterator>::iterator_category());
2576 template<typename InputIterator>
2577 InvokeInst::InvokeInst(Value *Func,
2578 BasicBlock *IfNormal, BasicBlock *IfException,
2579 InputIterator ArgBegin, InputIterator ArgEnd,
2581 const Twine &NameStr, BasicBlock *InsertAtEnd)
2582 : TerminatorInst(cast<FunctionType>(cast<PointerType>(Func->getType())
2583 ->getElementType())->getReturnType(),
2584 Instruction::Invoke,
2585 OperandTraits<InvokeInst>::op_end(this) - Values,
2586 Values, InsertAtEnd) {
2587 init(Func, IfNormal, IfException, ArgBegin, ArgEnd, NameStr,
2588 typename std::iterator_traits<InputIterator>::iterator_category());
2591 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(InvokeInst, Value)
2593 //===----------------------------------------------------------------------===//
2595 //===----------------------------------------------------------------------===//
2597 //===---------------------------------------------------------------------------
2598 /// UnwindInst - Immediately exit the current function, unwinding the stack
2599 /// until an invoke instruction is found.
2601 class UnwindInst : public TerminatorInst {
2602 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2604 // allocate space for exactly zero operands
2605 void *operator new(size_t s) {
2606 return User::operator new(s, 0);
2608 explicit UnwindInst(LLVMContext &C, Instruction *InsertBefore = 0);
2609 explicit UnwindInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2611 virtual UnwindInst *clone(LLVMContext &Context) const;
2613 unsigned getNumSuccessors() const { return 0; }
2615 // Methods for support type inquiry through isa, cast, and dyn_cast:
2616 static inline bool classof(const UnwindInst *) { return true; }
2617 static inline bool classof(const Instruction *I) {
2618 return I->getOpcode() == Instruction::Unwind;
2620 static inline bool classof(const Value *V) {
2621 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2624 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2625 virtual unsigned getNumSuccessorsV() const;
2626 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2629 //===----------------------------------------------------------------------===//
2630 // UnreachableInst Class
2631 //===----------------------------------------------------------------------===//
2633 //===---------------------------------------------------------------------------
2634 /// UnreachableInst - This function has undefined behavior. In particular, the
2635 /// presence of this instruction indicates some higher level knowledge that the
2636 /// end of the block cannot be reached.
2638 class UnreachableInst : public TerminatorInst {
2639 void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
2641 // allocate space for exactly zero operands
2642 void *operator new(size_t s) {
2643 return User::operator new(s, 0);
2645 explicit UnreachableInst(LLVMContext &C, Instruction *InsertBefore = 0);
2646 explicit UnreachableInst(LLVMContext &C, BasicBlock *InsertAtEnd);
2648 virtual UnreachableInst *clone(LLVMContext &Context) const;
2650 unsigned getNumSuccessors() const { return 0; }
2652 // Methods for support type inquiry through isa, cast, and dyn_cast:
2653 static inline bool classof(const UnreachableInst *) { return true; }
2654 static inline bool classof(const Instruction *I) {
2655 return I->getOpcode() == Instruction::Unreachable;
2657 static inline bool classof(const Value *V) {
2658 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2661 virtual BasicBlock *getSuccessorV(unsigned idx) const;
2662 virtual unsigned getNumSuccessorsV() const;
2663 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
2666 //===----------------------------------------------------------------------===//
2668 //===----------------------------------------------------------------------===//
2670 /// @brief This class represents a truncation of integer types.
2671 class TruncInst : public CastInst {
2673 /// @brief Constructor with insert-before-instruction semantics
2675 Value *S, ///< The value to be truncated
2676 const Type *Ty, ///< The (smaller) type to truncate to
2677 const Twine &NameStr = "", ///< A name for the new instruction
2678 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2681 /// @brief Constructor with insert-at-end-of-block semantics
2683 Value *S, ///< The value to be truncated
2684 const Type *Ty, ///< The (smaller) type to truncate to
2685 const Twine &NameStr, ///< A name for the new instruction
2686 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2689 /// @brief Clone an identical TruncInst
2690 virtual TruncInst *clone(LLVMContext &Context) const;
2692 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2693 static inline bool classof(const TruncInst *) { return true; }
2694 static inline bool classof(const Instruction *I) {
2695 return I->getOpcode() == Trunc;
2697 static inline bool classof(const Value *V) {
2698 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2702 //===----------------------------------------------------------------------===//
2704 //===----------------------------------------------------------------------===//
2706 /// @brief This class represents zero extension of integer types.
2707 class ZExtInst : public CastInst {
2709 /// @brief Constructor with insert-before-instruction semantics
2711 Value *S, ///< The value to be zero extended
2712 const Type *Ty, ///< The type to zero extend to
2713 const Twine &NameStr = "", ///< A name for the new instruction
2714 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2717 /// @brief Constructor with insert-at-end semantics.
2719 Value *S, ///< The value to be zero extended
2720 const Type *Ty, ///< The type to zero extend to
2721 const Twine &NameStr, ///< A name for the new instruction
2722 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2725 /// @brief Clone an identical ZExtInst
2726 virtual ZExtInst *clone(LLVMContext &Context) const;
2728 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2729 static inline bool classof(const ZExtInst *) { return true; }
2730 static inline bool classof(const Instruction *I) {
2731 return I->getOpcode() == ZExt;
2733 static inline bool classof(const Value *V) {
2734 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2738 //===----------------------------------------------------------------------===//
2740 //===----------------------------------------------------------------------===//
2742 /// @brief This class represents a sign extension of integer types.
2743 class SExtInst : public CastInst {
2745 /// @brief Constructor with insert-before-instruction semantics
2747 Value *S, ///< The value to be sign extended
2748 const Type *Ty, ///< The type to sign extend to
2749 const Twine &NameStr = "", ///< A name for the new instruction
2750 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2753 /// @brief Constructor with insert-at-end-of-block semantics
2755 Value *S, ///< The value to be sign extended
2756 const Type *Ty, ///< The type to sign extend to
2757 const Twine &NameStr, ///< A name for the new instruction
2758 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2761 /// @brief Clone an identical SExtInst
2762 virtual SExtInst *clone(LLVMContext &Context) const;
2764 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2765 static inline bool classof(const SExtInst *) { return true; }
2766 static inline bool classof(const Instruction *I) {
2767 return I->getOpcode() == SExt;
2769 static inline bool classof(const Value *V) {
2770 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2774 //===----------------------------------------------------------------------===//
2775 // FPTruncInst Class
2776 //===----------------------------------------------------------------------===//
2778 /// @brief This class represents a truncation of floating point types.
2779 class FPTruncInst : public CastInst {
2781 /// @brief Constructor with insert-before-instruction semantics
2783 Value *S, ///< The value to be truncated
2784 const Type *Ty, ///< The type to truncate to
2785 const Twine &NameStr = "", ///< A name for the new instruction
2786 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2789 /// @brief Constructor with insert-before-instruction semantics
2791 Value *S, ///< The value to be truncated
2792 const Type *Ty, ///< The type to truncate to
2793 const Twine &NameStr, ///< A name for the new instruction
2794 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2797 /// @brief Clone an identical FPTruncInst
2798 virtual FPTruncInst *clone(LLVMContext &Context) const;
2800 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2801 static inline bool classof(const FPTruncInst *) { return true; }
2802 static inline bool classof(const Instruction *I) {
2803 return I->getOpcode() == FPTrunc;
2805 static inline bool classof(const Value *V) {
2806 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2810 //===----------------------------------------------------------------------===//
2812 //===----------------------------------------------------------------------===//
2814 /// @brief This class represents an extension of floating point types.
2815 class FPExtInst : public CastInst {
2817 /// @brief Constructor with insert-before-instruction semantics
2819 Value *S, ///< The value to be extended
2820 const Type *Ty, ///< The type to extend to
2821 const Twine &NameStr = "", ///< A name for the new instruction
2822 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2825 /// @brief Constructor with insert-at-end-of-block semantics
2827 Value *S, ///< The value to be extended
2828 const Type *Ty, ///< The type to extend to
2829 const Twine &NameStr, ///< A name for the new instruction
2830 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2833 /// @brief Clone an identical FPExtInst
2834 virtual FPExtInst *clone(LLVMContext &Context) const;
2836 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2837 static inline bool classof(const FPExtInst *) { return true; }
2838 static inline bool classof(const Instruction *I) {
2839 return I->getOpcode() == FPExt;
2841 static inline bool classof(const Value *V) {
2842 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2846 //===----------------------------------------------------------------------===//
2848 //===----------------------------------------------------------------------===//
2850 /// @brief This class represents a cast unsigned integer to floating point.
2851 class UIToFPInst : public CastInst {
2853 /// @brief Constructor with insert-before-instruction semantics
2855 Value *S, ///< The value to be converted
2856 const Type *Ty, ///< The type to convert to
2857 const Twine &NameStr = "", ///< A name for the new instruction
2858 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2861 /// @brief Constructor with insert-at-end-of-block semantics
2863 Value *S, ///< The value to be converted
2864 const Type *Ty, ///< The type to convert to
2865 const Twine &NameStr, ///< A name for the new instruction
2866 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2869 /// @brief Clone an identical UIToFPInst
2870 virtual UIToFPInst *clone(LLVMContext &Context) const;
2872 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2873 static inline bool classof(const UIToFPInst *) { return true; }
2874 static inline bool classof(const Instruction *I) {
2875 return I->getOpcode() == UIToFP;
2877 static inline bool classof(const Value *V) {
2878 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2882 //===----------------------------------------------------------------------===//
2884 //===----------------------------------------------------------------------===//
2886 /// @brief This class represents a cast from signed integer to floating point.
2887 class SIToFPInst : public CastInst {
2889 /// @brief Constructor with insert-before-instruction semantics
2891 Value *S, ///< The value to be converted
2892 const Type *Ty, ///< The type to convert to
2893 const Twine &NameStr = "", ///< A name for the new instruction
2894 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2897 /// @brief Constructor with insert-at-end-of-block semantics
2899 Value *S, ///< The value to be converted
2900 const Type *Ty, ///< The type to convert to
2901 const Twine &NameStr, ///< A name for the new instruction
2902 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2905 /// @brief Clone an identical SIToFPInst
2906 virtual SIToFPInst *clone(LLVMContext &Context) const;
2908 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2909 static inline bool classof(const SIToFPInst *) { return true; }
2910 static inline bool classof(const Instruction *I) {
2911 return I->getOpcode() == SIToFP;
2913 static inline bool classof(const Value *V) {
2914 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2918 //===----------------------------------------------------------------------===//
2920 //===----------------------------------------------------------------------===//
2922 /// @brief This class represents a cast from floating point to unsigned integer
2923 class FPToUIInst : public CastInst {
2925 /// @brief Constructor with insert-before-instruction 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 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2933 /// @brief Constructor with insert-at-end-of-block semantics
2935 Value *S, ///< The value to be converted
2936 const Type *Ty, ///< The type to convert to
2937 const Twine &NameStr, ///< A name for the new instruction
2938 BasicBlock *InsertAtEnd ///< Where to insert the new instruction
2941 /// @brief Clone an identical FPToUIInst
2942 virtual FPToUIInst *clone(LLVMContext &Context) const;
2944 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2945 static inline bool classof(const FPToUIInst *) { return true; }
2946 static inline bool classof(const Instruction *I) {
2947 return I->getOpcode() == FPToUI;
2949 static inline bool classof(const Value *V) {
2950 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2954 //===----------------------------------------------------------------------===//
2956 //===----------------------------------------------------------------------===//
2958 /// @brief This class represents a cast from floating point to signed integer.
2959 class FPToSIInst : public CastInst {
2961 /// @brief Constructor with insert-before-instruction semantics
2963 Value *S, ///< The value to be converted
2964 const Type *Ty, ///< The type to convert to
2965 const Twine &NameStr = "", ///< A name for the new instruction
2966 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
2969 /// @brief Constructor with insert-at-end-of-block semantics
2971 Value *S, ///< The value to be converted
2972 const Type *Ty, ///< The type to convert to
2973 const Twine &NameStr, ///< A name for the new instruction
2974 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
2977 /// @brief Clone an identical FPToSIInst
2978 virtual FPToSIInst *clone(LLVMContext &Context) const;
2980 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
2981 static inline bool classof(const FPToSIInst *) { return true; }
2982 static inline bool classof(const Instruction *I) {
2983 return I->getOpcode() == FPToSI;
2985 static inline bool classof(const Value *V) {
2986 return isa<Instruction>(V) && classof(cast<Instruction>(V));
2990 //===----------------------------------------------------------------------===//
2991 // IntToPtrInst Class
2992 //===----------------------------------------------------------------------===//
2994 /// @brief This class represents a cast from an integer to a pointer.
2995 class IntToPtrInst : public CastInst {
2997 /// @brief Constructor with insert-before-instruction semantics
2999 Value *S, ///< The value to be converted
3000 const Type *Ty, ///< The type to convert to
3001 const Twine &NameStr = "", ///< A name for the new instruction
3002 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3005 /// @brief Constructor with insert-at-end-of-block semantics
3007 Value *S, ///< The value to be converted
3008 const Type *Ty, ///< The type to convert to
3009 const Twine &NameStr, ///< A name for the new instruction
3010 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3013 /// @brief Clone an identical IntToPtrInst
3014 virtual IntToPtrInst *clone(LLVMContext &Context) const;
3016 // Methods for support type inquiry through isa, cast, and dyn_cast:
3017 static inline bool classof(const IntToPtrInst *) { return true; }
3018 static inline bool classof(const Instruction *I) {
3019 return I->getOpcode() == IntToPtr;
3021 static inline bool classof(const Value *V) {
3022 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3026 //===----------------------------------------------------------------------===//
3027 // PtrToIntInst Class
3028 //===----------------------------------------------------------------------===//
3030 /// @brief This class represents a cast from a pointer to an integer
3031 class PtrToIntInst : public CastInst {
3033 /// @brief Constructor with insert-before-instruction semantics
3035 Value *S, ///< The value to be converted
3036 const Type *Ty, ///< The type to convert to
3037 const Twine &NameStr = "", ///< A name for the new instruction
3038 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3041 /// @brief Constructor with insert-at-end-of-block semantics
3043 Value *S, ///< The value to be converted
3044 const Type *Ty, ///< The type to convert to
3045 const Twine &NameStr, ///< A name for the new instruction
3046 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3049 /// @brief Clone an identical PtrToIntInst
3050 virtual PtrToIntInst *clone(LLVMContext &Context) const;
3052 // Methods for support type inquiry through isa, cast, and dyn_cast:
3053 static inline bool classof(const PtrToIntInst *) { return true; }
3054 static inline bool classof(const Instruction *I) {
3055 return I->getOpcode() == PtrToInt;
3057 static inline bool classof(const Value *V) {
3058 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3062 //===----------------------------------------------------------------------===//
3063 // BitCastInst Class
3064 //===----------------------------------------------------------------------===//
3066 /// @brief This class represents a no-op cast from one type to another.
3067 class BitCastInst : public CastInst {
3069 /// @brief Constructor with insert-before-instruction semantics
3071 Value *S, ///< The value to be casted
3072 const Type *Ty, ///< The type to casted to
3073 const Twine &NameStr = "", ///< A name for the new instruction
3074 Instruction *InsertBefore = 0 ///< Where to insert the new instruction
3077 /// @brief Constructor with insert-at-end-of-block semantics
3079 Value *S, ///< The value to be casted
3080 const Type *Ty, ///< The type to casted to
3081 const Twine &NameStr, ///< A name for the new instruction
3082 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
3085 /// @brief Clone an identical BitCastInst
3086 virtual BitCastInst *clone(LLVMContext &Context) const;
3088 // Methods for support type inquiry through isa, cast, and dyn_cast:
3089 static inline bool classof(const BitCastInst *) { return true; }
3090 static inline bool classof(const Instruction *I) {
3091 return I->getOpcode() == BitCast;
3093 static inline bool classof(const Value *V) {
3094 return isa<Instruction>(V) && classof(cast<Instruction>(V));
3098 } // End llvm namespace