1 //===-- llvm/Instructions.h - Instruction subclass definitions --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file exposes the class definitions of all of the subclasses of the
11 // Instruction class. This is meant to be an easy way to get access to all
12 // instruction subclasses.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_INSTRUCTIONS_H
17 #define LLVM_INSTRUCTIONS_H
19 #include "llvm/Instruction.h"
20 #include "llvm/InstrTypes.h"
29 //===----------------------------------------------------------------------===//
30 // AllocationInst Class
31 //===----------------------------------------------------------------------===//
33 /// AllocationInst - This class is the common base class of MallocInst and
36 class AllocationInst : public UnaryInstruction {
39 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
40 const std::string &Name = "", Instruction *InsertBefore = 0);
41 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
42 const std::string &Name, BasicBlock *InsertAtEnd);
44 // Out of line virtual method, so the vtable, etc has a home.
45 virtual ~AllocationInst();
47 /// isArrayAllocation - Return true if there is an allocation size parameter
48 /// to the allocation instruction that is not 1.
50 bool isArrayAllocation() const;
52 /// getArraySize - Get the number of element allocated, for a simple
53 /// allocation of a single element, this will return a constant 1 value.
55 inline const Value *getArraySize() const { return getOperand(0); }
56 inline Value *getArraySize() { return getOperand(0); }
58 /// getType - Overload to return most specific pointer type
60 inline const PointerType *getType() const {
61 return reinterpret_cast<const PointerType*>(Instruction::getType());
64 /// getAllocatedType - Return the type that is being allocated by the
67 const Type *getAllocatedType() const;
69 /// getAlignment - Return the alignment of the memory that is being allocated
70 /// by the instruction.
72 unsigned getAlignment() const { return Alignment; }
73 void setAlignment(unsigned Align) {
74 assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
78 virtual Instruction *clone() const = 0;
80 // Methods for support type inquiry through isa, cast, and dyn_cast:
81 static inline bool classof(const AllocationInst *) { return true; }
82 static inline bool classof(const Instruction *I) {
83 return I->getOpcode() == Instruction::Alloca ||
84 I->getOpcode() == Instruction::Malloc;
86 static inline bool classof(const Value *V) {
87 return isa<Instruction>(V) && classof(cast<Instruction>(V));
92 //===----------------------------------------------------------------------===//
94 //===----------------------------------------------------------------------===//
96 /// MallocInst - an instruction to allocated memory on the heap
98 class MallocInst : public AllocationInst {
99 MallocInst(const MallocInst &MI);
101 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
102 const std::string &Name = "",
103 Instruction *InsertBefore = 0)
104 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
105 MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
106 BasicBlock *InsertAtEnd)
107 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
109 explicit MallocInst(const Type *Ty, const std::string &Name,
110 Instruction *InsertBefore = 0)
111 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
112 MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
113 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
115 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
116 const std::string &Name, BasicBlock *InsertAtEnd)
117 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
118 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
119 const std::string &Name = "",
120 Instruction *InsertBefore = 0)
121 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
123 virtual MallocInst *clone() const;
125 // Methods for support type inquiry through isa, cast, and dyn_cast:
126 static inline bool classof(const MallocInst *) { return true; }
127 static inline bool classof(const Instruction *I) {
128 return (I->getOpcode() == Instruction::Malloc);
130 static inline bool classof(const Value *V) {
131 return isa<Instruction>(V) && classof(cast<Instruction>(V));
136 //===----------------------------------------------------------------------===//
138 //===----------------------------------------------------------------------===//
140 /// AllocaInst - an instruction to allocate memory on the stack
142 class AllocaInst : public AllocationInst {
143 AllocaInst(const AllocaInst &);
145 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
146 const std::string &Name = "",
147 Instruction *InsertBefore = 0)
148 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
149 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
150 BasicBlock *InsertAtEnd)
151 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
153 AllocaInst(const Type *Ty, const std::string &Name,
154 Instruction *InsertBefore = 0)
155 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
156 AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
157 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
159 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
160 const std::string &Name = "", Instruction *InsertBefore = 0)
161 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
162 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
163 const std::string &Name, BasicBlock *InsertAtEnd)
164 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
166 virtual AllocaInst *clone() const;
168 // Methods for support type inquiry through isa, cast, and dyn_cast:
169 static inline bool classof(const AllocaInst *) { return true; }
170 static inline bool classof(const Instruction *I) {
171 return (I->getOpcode() == Instruction::Alloca);
173 static inline bool classof(const Value *V) {
174 return isa<Instruction>(V) && classof(cast<Instruction>(V));
179 //===----------------------------------------------------------------------===//
181 //===----------------------------------------------------------------------===//
183 /// FreeInst - an instruction to deallocate memory
185 class FreeInst : public UnaryInstruction {
188 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
189 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
191 virtual FreeInst *clone() const;
193 virtual bool mayWriteToMemory() const { return true; }
195 // Methods for support type inquiry through isa, cast, and dyn_cast:
196 static inline bool classof(const FreeInst *) { return true; }
197 static inline bool classof(const Instruction *I) {
198 return (I->getOpcode() == Instruction::Free);
200 static inline bool classof(const Value *V) {
201 return isa<Instruction>(V) && classof(cast<Instruction>(V));
206 //===----------------------------------------------------------------------===//
208 //===----------------------------------------------------------------------===//
210 /// LoadInst - an instruction for reading from memory. This uses the
211 /// SubclassData field in Value to store whether or not the load is volatile.
213 class LoadInst : public UnaryInstruction {
214 LoadInst(const LoadInst &LI)
215 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
216 setVolatile(LI.isVolatile());
224 LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
225 LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
226 LoadInst(Value *Ptr, const std::string &Name = "", bool isVolatile = false,
227 Instruction *InsertBefore = 0);
228 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
229 BasicBlock *InsertAtEnd);
231 /// isVolatile - Return true if this is a load from a volatile memory
234 bool isVolatile() const { return SubclassData; }
236 /// setVolatile - Specify whether this is a volatile load or not.
238 void setVolatile(bool V) { SubclassData = V; }
240 virtual LoadInst *clone() const;
242 virtual bool mayWriteToMemory() const { return isVolatile(); }
244 Value *getPointerOperand() { return getOperand(0); }
245 const Value *getPointerOperand() const { return getOperand(0); }
246 static unsigned getPointerOperandIndex() { return 0U; }
248 // Methods for support type inquiry through isa, cast, and dyn_cast:
249 static inline bool classof(const LoadInst *) { return true; }
250 static inline bool classof(const Instruction *I) {
251 return I->getOpcode() == Instruction::Load;
253 static inline bool classof(const Value *V) {
254 return isa<Instruction>(V) && classof(cast<Instruction>(V));
259 //===----------------------------------------------------------------------===//
261 //===----------------------------------------------------------------------===//
263 /// StoreInst - an instruction for storing to memory
265 class StoreInst : public Instruction {
267 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store, Ops, 2) {
268 Ops[0].init(SI.Ops[0], this);
269 Ops[1].init(SI.Ops[1], this);
270 setVolatile(SI.isVolatile());
277 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
278 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
279 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
280 Instruction *InsertBefore = 0);
281 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
284 /// isVolatile - Return true if this is a load from a volatile memory
287 bool isVolatile() const { return SubclassData; }
289 /// setVolatile - Specify whether this is a volatile load or not.
291 void setVolatile(bool V) { SubclassData = V; }
293 /// Transparently provide more efficient getOperand methods.
294 Value *getOperand(unsigned i) const {
295 assert(i < 2 && "getOperand() out of range!");
298 void setOperand(unsigned i, Value *Val) {
299 assert(i < 2 && "setOperand() out of range!");
302 unsigned getNumOperands() const { return 2; }
305 virtual StoreInst *clone() const;
307 virtual bool mayWriteToMemory() const { return true; }
309 Value *getPointerOperand() { return getOperand(1); }
310 const Value *getPointerOperand() const { return getOperand(1); }
311 static unsigned getPointerOperandIndex() { return 1U; }
313 // Methods for support type inquiry through isa, cast, and dyn_cast:
314 static inline bool classof(const StoreInst *) { return true; }
315 static inline bool classof(const Instruction *I) {
316 return I->getOpcode() == Instruction::Store;
318 static inline bool classof(const Value *V) {
319 return isa<Instruction>(V) && classof(cast<Instruction>(V));
324 //===----------------------------------------------------------------------===//
325 // GetElementPtrInst Class
326 //===----------------------------------------------------------------------===//
328 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
329 /// access elements of arrays and structs
331 class GetElementPtrInst : public Instruction {
332 GetElementPtrInst(const GetElementPtrInst &GEPI)
333 : Instruction(reinterpret_cast<const Type*>(GEPI.getType()), GetElementPtr,
334 0, GEPI.getNumOperands()) {
335 Use *OL = OperandList = new Use[NumOperands];
336 Use *GEPIOL = GEPI.OperandList;
337 for (unsigned i = 0, E = NumOperands; i != E; ++i)
338 OL[i].init(GEPIOL[i], this);
340 void init(Value *Ptr, const std::vector<Value*> &Idx);
341 void init(Value *Ptr, Value *Idx0, Value *Idx1);
342 void init(Value *Ptr, Value *Idx);
344 /// Constructors - Create a getelementptr instruction with a base pointer an
345 /// list of indices. The first ctor can optionally insert before an existing
346 /// instruction, the second appends the new instruction to the specified
348 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
349 const std::string &Name = "", Instruction *InsertBefore =0);
350 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
351 const std::string &Name, BasicBlock *InsertAtEnd);
353 /// Constructors - These two constructors are convenience methods because one
354 /// and two index getelementptr instructions are so common.
355 GetElementPtrInst(Value *Ptr, Value *Idx,
356 const std::string &Name = "", Instruction *InsertBefore =0);
357 GetElementPtrInst(Value *Ptr, Value *Idx,
358 const std::string &Name, BasicBlock *InsertAtEnd);
359 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
360 const std::string &Name = "", Instruction *InsertBefore =0);
361 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
362 const std::string &Name, BasicBlock *InsertAtEnd);
363 ~GetElementPtrInst();
365 virtual GetElementPtrInst *clone() const;
367 // getType - Overload to return most specific pointer type...
368 inline const PointerType *getType() const {
369 return reinterpret_cast<const PointerType*>(Instruction::getType());
372 /// getIndexedType - Returns the type of the element that would be loaded with
373 /// a load instruction with the specified parameters.
375 /// A null type is returned if the indices are invalid for the specified
378 static const Type *getIndexedType(const Type *Ptr,
379 const std::vector<Value*> &Indices,
380 bool AllowStructLeaf = false);
381 static const Type *getIndexedType(const Type *Ptr, Value *Idx0, Value *Idx1,
382 bool AllowStructLeaf = false);
383 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
385 inline op_iterator idx_begin() { return op_begin()+1; }
386 inline const_op_iterator idx_begin() const { return op_begin()+1; }
387 inline op_iterator idx_end() { return op_end(); }
388 inline const_op_iterator idx_end() const { return op_end(); }
390 Value *getPointerOperand() {
391 return getOperand(0);
393 const Value *getPointerOperand() const {
394 return getOperand(0);
396 static unsigned getPointerOperandIndex() {
397 return 0U; // get index for modifying correct operand
400 inline unsigned getNumIndices() const { // Note: always non-negative
401 return getNumOperands() - 1;
404 inline bool hasIndices() const {
405 return getNumOperands() > 1;
408 // Methods for support type inquiry through isa, cast, and dyn_cast:
409 static inline bool classof(const GetElementPtrInst *) { return true; }
410 static inline bool classof(const Instruction *I) {
411 return (I->getOpcode() == Instruction::GetElementPtr);
413 static inline bool classof(const Value *V) {
414 return isa<Instruction>(V) && classof(cast<Instruction>(V));
418 //===----------------------------------------------------------------------===//
420 //===----------------------------------------------------------------------===//
422 /// SetCondInst class - Represent a setCC operator, where CC is eq, ne, lt, gt,
425 class SetCondInst : public BinaryOperator {
427 SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
428 const std::string &Name = "", Instruction *InsertBefore = 0);
429 SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
430 const std::string &Name, BasicBlock *InsertAtEnd);
432 /// getInverseCondition - Return the inverse of the current condition opcode.
433 /// For example seteq -> setne, setgt -> setle, setlt -> setge, etc...
435 BinaryOps getInverseCondition() const {
436 return getInverseCondition(getOpcode());
439 /// getInverseCondition - Static version that you can use without an
440 /// instruction available.
442 static BinaryOps getInverseCondition(BinaryOps Opcode);
444 /// getSwappedCondition - Return the condition opcode that would be the result
445 /// of exchanging the two operands of the setcc instruction without changing
446 /// the result produced. Thus, seteq->seteq, setle->setge, setlt->setgt, etc.
448 BinaryOps getSwappedCondition() const {
449 return getSwappedCondition(getOpcode());
452 /// getSwappedCondition - Static version that you can use without an
453 /// instruction available.
455 static BinaryOps getSwappedCondition(BinaryOps Opcode);
458 // Methods for support type inquiry through isa, cast, and dyn_cast:
459 static inline bool classof(const SetCondInst *) { return true; }
460 static inline bool classof(const Instruction *I) {
461 return I->getOpcode() == SetEQ || I->getOpcode() == SetNE ||
462 I->getOpcode() == SetLE || I->getOpcode() == SetGE ||
463 I->getOpcode() == SetLT || I->getOpcode() == SetGT;
465 static inline bool classof(const Value *V) {
466 return isa<Instruction>(V) && classof(cast<Instruction>(V));
470 //===----------------------------------------------------------------------===//
472 //===----------------------------------------------------------------------===//
474 /// CastInst - This class represents a cast from Operand[0] to the type of
475 /// the instruction (i->getType()).
477 class CastInst : public UnaryInstruction {
478 CastInst(const CastInst &CI)
479 : UnaryInstruction(CI.getType(), Cast, CI.getOperand(0)) {
482 CastInst(Value *S, const Type *Ty, const std::string &Name = "",
483 Instruction *InsertBefore = 0)
484 : UnaryInstruction(Ty, Cast, S, Name, InsertBefore) {
486 CastInst(Value *S, const Type *Ty, const std::string &Name,
487 BasicBlock *InsertAtEnd)
488 : UnaryInstruction(Ty, Cast, S, Name, InsertAtEnd) {
491 virtual CastInst *clone() const;
493 // Methods for support type inquiry through isa, cast, and dyn_cast:
494 static inline bool classof(const CastInst *) { return true; }
495 static inline bool classof(const Instruction *I) {
496 return I->getOpcode() == Cast;
498 static inline bool classof(const Value *V) {
499 return isa<Instruction>(V) && classof(cast<Instruction>(V));
504 //===----------------------------------------------------------------------===//
506 //===----------------------------------------------------------------------===//
508 /// CallInst - This class represents a function call, abstracting a target
509 /// machine's calling convention. This class uses low bit of the SubClassData
510 /// field to indicate whether or not this is a tail call. The rest of the bits
511 /// hold the calling convention of the call.
513 class CallInst : public Instruction {
514 CallInst(const CallInst &CI);
515 void init(Value *Func, const std::vector<Value*> &Params);
516 void init(Value *Func, Value *Actual1, Value *Actual2);
517 void init(Value *Func, Value *Actual);
518 void init(Value *Func);
521 CallInst(Value *F, const std::vector<Value*> &Par,
522 const std::string &Name = "", Instruction *InsertBefore = 0);
523 CallInst(Value *F, const std::vector<Value*> &Par,
524 const std::string &Name, BasicBlock *InsertAtEnd);
526 // Alternate CallInst ctors w/ two actuals, w/ one actual and no
527 // actuals, respectively.
528 CallInst(Value *F, Value *Actual1, Value *Actual2,
529 const std::string& Name = "", Instruction *InsertBefore = 0);
530 CallInst(Value *F, Value *Actual1, Value *Actual2,
531 const std::string& Name, BasicBlock *InsertAtEnd);
532 CallInst(Value *F, Value *Actual, const std::string& Name = "",
533 Instruction *InsertBefore = 0);
534 CallInst(Value *F, Value *Actual, const std::string& Name,
535 BasicBlock *InsertAtEnd);
536 explicit CallInst(Value *F, const std::string &Name = "",
537 Instruction *InsertBefore = 0);
538 explicit CallInst(Value *F, const std::string &Name,
539 BasicBlock *InsertAtEnd);
542 virtual CallInst *clone() const;
543 bool mayWriteToMemory() const { return true; }
545 bool isTailCall() const { return SubclassData & 1; }
546 void setTailCall(bool isTailCall = true) {
547 SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
550 /// getCallingConv/setCallingConv - Get or set the calling convention of this
552 unsigned getCallingConv() const { return SubclassData >> 1; }
553 void setCallingConv(unsigned CC) {
554 SubclassData = (SubclassData & 1) | (CC << 1);
557 /// getCalledFunction - Return the function being called by this instruction
558 /// if it is a direct call. If it is a call through a function pointer,
560 Function *getCalledFunction() const {
561 return static_cast<Function*>(dyn_cast<Function>(getOperand(0)));
564 // getCalledValue - Get a pointer to a method that is invoked by this inst.
565 inline const Value *getCalledValue() const { return getOperand(0); }
566 inline Value *getCalledValue() { return getOperand(0); }
568 // Methods for support type inquiry through isa, cast, and dyn_cast:
569 static inline bool classof(const CallInst *) { return true; }
570 static inline bool classof(const Instruction *I) {
571 return I->getOpcode() == Instruction::Call;
573 static inline bool classof(const Value *V) {
574 return isa<Instruction>(V) && classof(cast<Instruction>(V));
579 //===----------------------------------------------------------------------===//
581 //===----------------------------------------------------------------------===//
583 /// ShiftInst - This class represents left and right shift instructions.
585 class ShiftInst : public Instruction {
587 ShiftInst(const ShiftInst &SI)
588 : Instruction(SI.getType(), SI.getOpcode(), Ops, 2) {
589 Ops[0].init(SI.Ops[0], this);
590 Ops[1].init(SI.Ops[1], this);
592 void init(OtherOps Opcode, Value *S, Value *SA) {
593 assert((Opcode == Shl || Opcode == Shr) && "ShiftInst Opcode invalid!");
594 Ops[0].init(S, this);
595 Ops[1].init(SA, this);
599 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name = "",
600 Instruction *InsertBefore = 0)
601 : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertBefore) {
604 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name,
605 BasicBlock *InsertAtEnd)
606 : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertAtEnd) {
610 OtherOps getOpcode() const {
611 return static_cast<OtherOps>(Instruction::getOpcode());
614 /// Transparently provide more efficient getOperand methods.
615 Value *getOperand(unsigned i) const {
616 assert(i < 2 && "getOperand() out of range!");
619 void setOperand(unsigned i, Value *Val) {
620 assert(i < 2 && "setOperand() out of range!");
623 unsigned getNumOperands() const { return 2; }
625 virtual ShiftInst *clone() const;
627 // Methods for support type inquiry through isa, cast, and dyn_cast:
628 static inline bool classof(const ShiftInst *) { return true; }
629 static inline bool classof(const Instruction *I) {
630 return (I->getOpcode() == Instruction::Shr) |
631 (I->getOpcode() == Instruction::Shl);
633 static inline bool classof(const Value *V) {
634 return isa<Instruction>(V) && classof(cast<Instruction>(V));
638 //===----------------------------------------------------------------------===//
640 //===----------------------------------------------------------------------===//
642 /// SelectInst - This class represents the LLVM 'select' instruction.
644 class SelectInst : public Instruction {
647 void init(Value *C, Value *S1, Value *S2) {
648 Ops[0].init(C, this);
649 Ops[1].init(S1, this);
650 Ops[2].init(S2, this);
653 SelectInst(const SelectInst &SI)
654 : Instruction(SI.getType(), SI.getOpcode(), Ops, 3) {
655 init(SI.Ops[0], SI.Ops[1], SI.Ops[2]);
658 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
659 Instruction *InsertBefore = 0)
660 : Instruction(S1->getType(), Instruction::Select, Ops, 3,
661 Name, InsertBefore) {
664 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
665 BasicBlock *InsertAtEnd)
666 : Instruction(S1->getType(), Instruction::Select, Ops, 3,
671 Value *getCondition() const { return Ops[0]; }
672 Value *getTrueValue() const { return Ops[1]; }
673 Value *getFalseValue() const { return Ops[2]; }
675 /// Transparently provide more efficient getOperand methods.
676 Value *getOperand(unsigned i) const {
677 assert(i < 3 && "getOperand() out of range!");
680 void setOperand(unsigned i, Value *Val) {
681 assert(i < 3 && "setOperand() out of range!");
684 unsigned getNumOperands() const { return 3; }
686 OtherOps getOpcode() const {
687 return static_cast<OtherOps>(Instruction::getOpcode());
690 virtual SelectInst *clone() const;
692 // Methods for support type inquiry through isa, cast, and dyn_cast:
693 static inline bool classof(const SelectInst *) { return true; }
694 static inline bool classof(const Instruction *I) {
695 return I->getOpcode() == Instruction::Select;
697 static inline bool classof(const Value *V) {
698 return isa<Instruction>(V) && classof(cast<Instruction>(V));
702 //===----------------------------------------------------------------------===//
704 //===----------------------------------------------------------------------===//
706 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
707 /// an argument of the specified type given a va_list and increments that list
709 class VAArgInst : public UnaryInstruction {
710 VAArgInst(const VAArgInst &VAA)
711 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
713 VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
714 Instruction *InsertBefore = 0)
715 : UnaryInstruction(Ty, VAArg, List, Name, InsertBefore) {
717 VAArgInst(Value *List, const Type *Ty, const std::string &Name,
718 BasicBlock *InsertAtEnd)
719 : UnaryInstruction(Ty, VAArg, List, Name, InsertAtEnd) {
722 virtual VAArgInst *clone() const;
723 bool mayWriteToMemory() const { return true; }
725 // Methods for support type inquiry through isa, cast, and dyn_cast:
726 static inline bool classof(const VAArgInst *) { return true; }
727 static inline bool classof(const Instruction *I) {
728 return I->getOpcode() == VAArg;
730 static inline bool classof(const Value *V) {
731 return isa<Instruction>(V) && classof(cast<Instruction>(V));
735 //===----------------------------------------------------------------------===//
736 // ExtractElementInst Class
737 //===----------------------------------------------------------------------===//
739 /// ExtractElementInst - This instruction extracts a single (scalar)
740 /// element from a PackedType value
742 class ExtractElementInst : public Instruction {
744 ExtractElementInst(const ExtractElementInst &EE) :
745 Instruction(EE.getType(), ExtractElement, Ops, 2) {
746 Ops[0].init(EE.Ops[0], this);
747 Ops[1].init(EE.Ops[1], this);
751 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
752 Instruction *InsertBefore = 0);
753 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
754 BasicBlock *InsertAtEnd);
756 /// isValidOperands - Return true if an extractelement instruction can be
757 /// formed with the specified operands.
758 static bool isValidOperands(const Value *Vec, const Value *Idx);
760 virtual ExtractElementInst *clone() const;
762 virtual bool mayWriteToMemory() const { return false; }
764 /// Transparently provide more efficient getOperand methods.
765 Value *getOperand(unsigned i) const {
766 assert(i < 2 && "getOperand() out of range!");
769 void setOperand(unsigned i, Value *Val) {
770 assert(i < 2 && "setOperand() out of range!");
773 unsigned getNumOperands() const { return 2; }
775 // Methods for support type inquiry through isa, cast, and dyn_cast:
776 static inline bool classof(const ExtractElementInst *) { return true; }
777 static inline bool classof(const Instruction *I) {
778 return I->getOpcode() == Instruction::ExtractElement;
780 static inline bool classof(const Value *V) {
781 return isa<Instruction>(V) && classof(cast<Instruction>(V));
785 //===----------------------------------------------------------------------===//
786 // InsertElementInst Class
787 //===----------------------------------------------------------------------===//
789 /// InsertElementInst - This instruction inserts a single (scalar)
790 /// element into a PackedType value
792 class InsertElementInst : public Instruction {
794 InsertElementInst(const InsertElementInst &IE);
796 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
797 const std::string &Name = "",Instruction *InsertBefore = 0);
798 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
799 const std::string &Name, BasicBlock *InsertAtEnd);
801 /// isValidOperands - Return true if an insertelement instruction can be
802 /// formed with the specified operands.
803 static bool isValidOperands(const Value *Vec, const Value *NewElt,
806 virtual InsertElementInst *clone() const;
808 virtual bool mayWriteToMemory() const { return false; }
810 /// getType - Overload to return most specific packed type.
812 inline const PackedType *getType() const {
813 return reinterpret_cast<const PackedType*>(Instruction::getType());
816 /// Transparently provide more efficient getOperand methods.
817 Value *getOperand(unsigned i) const {
818 assert(i < 3 && "getOperand() out of range!");
821 void setOperand(unsigned i, Value *Val) {
822 assert(i < 3 && "setOperand() out of range!");
825 unsigned getNumOperands() const { return 3; }
827 // Methods for support type inquiry through isa, cast, and dyn_cast:
828 static inline bool classof(const InsertElementInst *) { return true; }
829 static inline bool classof(const Instruction *I) {
830 return I->getOpcode() == Instruction::InsertElement;
832 static inline bool classof(const Value *V) {
833 return isa<Instruction>(V) && classof(cast<Instruction>(V));
837 //===----------------------------------------------------------------------===//
838 // ShuffleVectorInst Class
839 //===----------------------------------------------------------------------===//
841 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
844 class ShuffleVectorInst : public Instruction {
846 ShuffleVectorInst(const ShuffleVectorInst &IE);
848 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
849 const std::string &Name = "", Instruction *InsertBefor = 0);
850 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
851 const std::string &Name, BasicBlock *InsertAtEnd);
853 /// isValidOperands - Return true if a shufflevector instruction can be
854 /// formed with the specified operands.
855 static bool isValidOperands(const Value *V1, const Value *V2,
858 virtual ShuffleVectorInst *clone() const;
860 virtual bool mayWriteToMemory() const { return false; }
862 /// getType - Overload to return most specific packed type.
864 inline const PackedType *getType() const {
865 return reinterpret_cast<const PackedType*>(Instruction::getType());
868 /// Transparently provide more efficient getOperand methods.
869 Value *getOperand(unsigned i) const {
870 assert(i < 3 && "getOperand() out of range!");
873 void setOperand(unsigned i, Value *Val) {
874 assert(i < 3 && "setOperand() out of range!");
877 unsigned getNumOperands() const { return 3; }
879 // Methods for support type inquiry through isa, cast, and dyn_cast:
880 static inline bool classof(const ShuffleVectorInst *) { return true; }
881 static inline bool classof(const Instruction *I) {
882 return I->getOpcode() == Instruction::ShuffleVector;
884 static inline bool classof(const Value *V) {
885 return isa<Instruction>(V) && classof(cast<Instruction>(V));
890 //===----------------------------------------------------------------------===//
892 //===----------------------------------------------------------------------===//
894 // PHINode - The PHINode class is used to represent the magical mystical PHI
895 // node, that can not exist in nature, but can be synthesized in a computer
896 // scientist's overactive imagination.
898 class PHINode : public Instruction {
899 /// ReservedSpace - The number of operands actually allocated. NumOperands is
900 /// the number actually in use.
901 unsigned ReservedSpace;
902 PHINode(const PHINode &PN);
904 PHINode(const Type *Ty, const std::string &Name = "",
905 Instruction *InsertBefore = 0)
906 : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertBefore),
910 PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
911 : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertAtEnd),
917 /// reserveOperandSpace - This method can be used to avoid repeated
918 /// reallocation of PHI operand lists by reserving space for the correct
919 /// number of operands before adding them. Unlike normal vector reserves,
920 /// this method can also be used to trim the operand space.
921 void reserveOperandSpace(unsigned NumValues) {
922 resizeOperands(NumValues*2);
925 virtual PHINode *clone() const;
927 /// getNumIncomingValues - Return the number of incoming edges
929 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
931 /// getIncomingValue - Return incoming value number x
933 Value *getIncomingValue(unsigned i) const {
934 assert(i*2 < getNumOperands() && "Invalid value number!");
935 return getOperand(i*2);
937 void setIncomingValue(unsigned i, Value *V) {
938 assert(i*2 < getNumOperands() && "Invalid value number!");
941 unsigned getOperandNumForIncomingValue(unsigned i) {
945 /// getIncomingBlock - Return incoming basic block number x
947 BasicBlock *getIncomingBlock(unsigned i) const {
948 return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
950 void setIncomingBlock(unsigned i, BasicBlock *BB) {
951 setOperand(i*2+1, reinterpret_cast<Value*>(BB));
953 unsigned getOperandNumForIncomingBlock(unsigned i) {
957 /// addIncoming - Add an incoming value to the end of the PHI list
959 void addIncoming(Value *V, BasicBlock *BB) {
960 assert(getType() == V->getType() &&
961 "All operands to PHI node must be the same type as the PHI node!");
962 unsigned OpNo = NumOperands;
963 if (OpNo+2 > ReservedSpace)
964 resizeOperands(0); // Get more space!
965 // Initialize some new operands.
966 NumOperands = OpNo+2;
967 OperandList[OpNo].init(V, this);
968 OperandList[OpNo+1].init(reinterpret_cast<Value*>(BB), this);
971 /// removeIncomingValue - Remove an incoming value. This is useful if a
972 /// predecessor basic block is deleted. The value removed is returned.
974 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
975 /// is true), the PHI node is destroyed and any uses of it are replaced with
976 /// dummy values. The only time there should be zero incoming values to a PHI
977 /// node is when the block is dead, so this strategy is sound.
979 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
981 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
982 int Idx = getBasicBlockIndex(BB);
983 assert(Idx >= 0 && "Invalid basic block argument to remove!");
984 return removeIncomingValue(Idx, DeletePHIIfEmpty);
987 /// getBasicBlockIndex - Return the first index of the specified basic
988 /// block in the value list for this PHI. Returns -1 if no instance.
990 int getBasicBlockIndex(const BasicBlock *BB) const {
991 Use *OL = OperandList;
992 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
993 if (OL[i+1] == reinterpret_cast<const Value*>(BB)) return i/2;
997 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
998 return getIncomingValue(getBasicBlockIndex(BB));
1001 /// hasConstantValue - If the specified PHI node always merges together the
1002 /// same value, return the value, otherwise return null.
1004 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1006 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1007 static inline bool classof(const PHINode *) { return true; }
1008 static inline bool classof(const Instruction *I) {
1009 return I->getOpcode() == Instruction::PHI;
1011 static inline bool classof(const Value *V) {
1012 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1015 void resizeOperands(unsigned NumOperands);
1018 //===----------------------------------------------------------------------===//
1020 //===----------------------------------------------------------------------===//
1022 //===---------------------------------------------------------------------------
1023 /// ReturnInst - Return a value (possibly void), from a function. Execution
1024 /// does not continue in this function any longer.
1026 class ReturnInst : public TerminatorInst {
1027 Use RetVal; // Possibly null retval.
1028 ReturnInst(const ReturnInst &RI) : TerminatorInst(Instruction::Ret, &RetVal,
1029 RI.getNumOperands()) {
1030 if (RI.getNumOperands())
1031 RetVal.init(RI.RetVal, this);
1034 void init(Value *RetVal);
1037 // ReturnInst constructors:
1038 // ReturnInst() - 'ret void' instruction
1039 // ReturnInst( null) - 'ret void' instruction
1040 // ReturnInst(Value* X) - 'ret X' instruction
1041 // ReturnInst( null, Inst *) - 'ret void' instruction, insert before I
1042 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
1043 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of BB
1044 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of BB
1046 // NOTE: If the Value* passed is of type void then the constructor behaves as
1047 // if it was passed NULL.
1048 ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0)
1049 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertBefore) {
1052 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd)
1053 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
1056 ReturnInst(BasicBlock *InsertAtEnd)
1057 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
1060 virtual ReturnInst *clone() const;
1062 // Transparently provide more efficient getOperand methods.
1063 Value *getOperand(unsigned i) const {
1064 assert(i < getNumOperands() && "getOperand() out of range!");
1067 void setOperand(unsigned i, Value *Val) {
1068 assert(i < getNumOperands() && "setOperand() out of range!");
1072 Value *getReturnValue() const { return RetVal; }
1074 unsigned getNumSuccessors() const { return 0; }
1076 // Methods for support type inquiry through isa, cast, and dyn_cast:
1077 static inline bool classof(const ReturnInst *) { return true; }
1078 static inline bool classof(const Instruction *I) {
1079 return (I->getOpcode() == Instruction::Ret);
1081 static inline bool classof(const Value *V) {
1082 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1085 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1086 virtual unsigned getNumSuccessorsV() const;
1087 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1090 //===----------------------------------------------------------------------===//
1092 //===----------------------------------------------------------------------===//
1094 //===---------------------------------------------------------------------------
1095 /// BranchInst - Conditional or Unconditional Branch instruction.
1097 class BranchInst : public TerminatorInst {
1098 /// Ops list - Branches are strange. The operands are ordered:
1099 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
1100 /// they don't have to check for cond/uncond branchness.
1102 BranchInst(const BranchInst &BI);
1105 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
1106 // BranchInst(BB *B) - 'br B'
1107 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
1108 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
1109 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
1110 // BranchInst(BB* B, BB *I) - 'br B' insert at end
1111 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
1112 BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0)
1113 : TerminatorInst(Instruction::Br, Ops, 1, InsertBefore) {
1114 assert(IfTrue != 0 && "Branch destination may not be null!");
1115 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1117 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1118 Instruction *InsertBefore = 0)
1119 : TerminatorInst(Instruction::Br, Ops, 3, InsertBefore) {
1120 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1121 Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
1122 Ops[2].init(Cond, this);
1128 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
1129 : TerminatorInst(Instruction::Br, Ops, 1, InsertAtEnd) {
1130 assert(IfTrue != 0 && "Branch destination may not be null!");
1131 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1134 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1135 BasicBlock *InsertAtEnd)
1136 : TerminatorInst(Instruction::Br, Ops, 3, InsertAtEnd) {
1137 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1138 Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
1139 Ops[2].init(Cond, this);
1146 /// Transparently provide more efficient getOperand methods.
1147 Value *getOperand(unsigned i) const {
1148 assert(i < getNumOperands() && "getOperand() out of range!");
1151 void setOperand(unsigned i, Value *Val) {
1152 assert(i < getNumOperands() && "setOperand() out of range!");
1156 virtual BranchInst *clone() const;
1158 inline bool isUnconditional() const { return getNumOperands() == 1; }
1159 inline bool isConditional() const { return getNumOperands() == 3; }
1161 inline Value *getCondition() const {
1162 assert(isConditional() && "Cannot get condition of an uncond branch!");
1163 return getOperand(2);
1166 void setCondition(Value *V) {
1167 assert(isConditional() && "Cannot set condition of unconditional branch!");
1171 // setUnconditionalDest - Change the current branch to an unconditional branch
1172 // targeting the specified block.
1173 // FIXME: Eliminate this ugly method.
1174 void setUnconditionalDest(BasicBlock *Dest) {
1175 if (isConditional()) { // Convert this to an uncond branch.
1180 setOperand(0, reinterpret_cast<Value*>(Dest));
1183 unsigned getNumSuccessors() const { return 1+isConditional(); }
1185 BasicBlock *getSuccessor(unsigned i) const {
1186 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
1187 return (i == 0) ? cast<BasicBlock>(getOperand(0)) :
1188 cast<BasicBlock>(getOperand(1));
1191 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1192 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
1193 setOperand(idx, reinterpret_cast<Value*>(NewSucc));
1196 // Methods for support type inquiry through isa, cast, and dyn_cast:
1197 static inline bool classof(const BranchInst *) { return true; }
1198 static inline bool classof(const Instruction *I) {
1199 return (I->getOpcode() == Instruction::Br);
1201 static inline bool classof(const Value *V) {
1202 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1205 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1206 virtual unsigned getNumSuccessorsV() const;
1207 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1210 //===----------------------------------------------------------------------===//
1212 //===----------------------------------------------------------------------===//
1214 //===---------------------------------------------------------------------------
1215 /// SwitchInst - Multiway switch
1217 class SwitchInst : public TerminatorInst {
1218 unsigned ReservedSpace;
1219 // Operand[0] = Value to switch on
1220 // Operand[1] = Default basic block destination
1221 // Operand[2n ] = Value to match
1222 // Operand[2n+1] = BasicBlock to go to on match
1223 SwitchInst(const SwitchInst &RI);
1224 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1225 void resizeOperands(unsigned No);
1227 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1228 /// switch on and a default destination. The number of additional cases can
1229 /// be specified here to make memory allocation more efficient. This
1230 /// constructor can also autoinsert before another instruction.
1231 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1232 Instruction *InsertBefore = 0)
1233 : TerminatorInst(Instruction::Switch, 0, 0, InsertBefore) {
1234 init(Value, Default, NumCases);
1237 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1238 /// switch on and a default destination. The number of additional cases can
1239 /// be specified here to make memory allocation more efficient. This
1240 /// constructor also autoinserts at the end of the specified BasicBlock.
1241 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1242 BasicBlock *InsertAtEnd)
1243 : TerminatorInst(Instruction::Switch, 0, 0, InsertAtEnd) {
1244 init(Value, Default, NumCases);
1249 // Accessor Methods for Switch stmt
1250 inline Value *getCondition() const { return getOperand(0); }
1251 void setCondition(Value *V) { setOperand(0, V); }
1253 inline BasicBlock *getDefaultDest() const {
1254 return cast<BasicBlock>(getOperand(1));
1257 /// getNumCases - return the number of 'cases' in this switch instruction.
1258 /// Note that case #0 is always the default case.
1259 unsigned getNumCases() const {
1260 return getNumOperands()/2;
1263 /// getCaseValue - Return the specified case value. Note that case #0, the
1264 /// default destination, does not have a case value.
1265 ConstantInt *getCaseValue(unsigned i) {
1266 assert(i && i < getNumCases() && "Illegal case value to get!");
1267 return getSuccessorValue(i);
1270 /// getCaseValue - Return the specified case value. Note that case #0, the
1271 /// default destination, does not have a case value.
1272 const ConstantInt *getCaseValue(unsigned i) const {
1273 assert(i && i < getNumCases() && "Illegal case value to get!");
1274 return getSuccessorValue(i);
1277 /// findCaseValue - Search all of the case values for the specified constant.
1278 /// If it is explicitly handled, return the case number of it, otherwise
1279 /// return 0 to indicate that it is handled by the default handler.
1280 unsigned findCaseValue(const ConstantInt *C) const {
1281 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1282 if (getCaseValue(i) == C)
1287 /// addCase - Add an entry to the switch instruction...
1289 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1291 /// removeCase - This method removes the specified successor from the switch
1292 /// instruction. Note that this cannot be used to remove the default
1293 /// destination (successor #0).
1295 void removeCase(unsigned idx);
1297 virtual SwitchInst *clone() const;
1299 unsigned getNumSuccessors() const { return getNumOperands()/2; }
1300 BasicBlock *getSuccessor(unsigned idx) const {
1301 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1302 return cast<BasicBlock>(getOperand(idx*2+1));
1304 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1305 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1306 setOperand(idx*2+1, reinterpret_cast<Value*>(NewSucc));
1309 // getSuccessorValue - Return the value associated with the specified
1311 inline ConstantInt *getSuccessorValue(unsigned idx) const {
1312 assert(idx < getNumSuccessors() && "Successor # out of range!");
1313 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1316 // Methods for support type inquiry through isa, cast, and dyn_cast:
1317 static inline bool classof(const SwitchInst *) { return true; }
1318 static inline bool classof(const Instruction *I) {
1319 return I->getOpcode() == Instruction::Switch;
1321 static inline bool classof(const Value *V) {
1322 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1325 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1326 virtual unsigned getNumSuccessorsV() const;
1327 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1330 //===----------------------------------------------------------------------===//
1332 //===----------------------------------------------------------------------===//
1334 //===---------------------------------------------------------------------------
1336 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
1337 /// calling convention of the call.
1339 class InvokeInst : public TerminatorInst {
1340 InvokeInst(const InvokeInst &BI);
1341 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1342 const std::vector<Value*> &Params);
1344 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1345 const std::vector<Value*> &Params, const std::string &Name = "",
1346 Instruction *InsertBefore = 0);
1347 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1348 const std::vector<Value*> &Params, const std::string &Name,
1349 BasicBlock *InsertAtEnd);
1352 virtual InvokeInst *clone() const;
1354 bool mayWriteToMemory() const { return true; }
1356 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1358 unsigned getCallingConv() const { return SubclassData; }
1359 void setCallingConv(unsigned CC) {
1363 /// getCalledFunction - Return the function called, or null if this is an
1364 /// indirect function invocation.
1366 Function *getCalledFunction() const {
1367 return dyn_cast<Function>(getOperand(0));
1370 // getCalledValue - Get a pointer to a function that is invoked by this inst.
1371 inline Value *getCalledValue() const { return getOperand(0); }
1373 // get*Dest - Return the destination basic blocks...
1374 BasicBlock *getNormalDest() const {
1375 return cast<BasicBlock>(getOperand(1));
1377 BasicBlock *getUnwindDest() const {
1378 return cast<BasicBlock>(getOperand(2));
1380 void setNormalDest(BasicBlock *B) {
1381 setOperand(1, reinterpret_cast<Value*>(B));
1384 void setUnwindDest(BasicBlock *B) {
1385 setOperand(2, reinterpret_cast<Value*>(B));
1388 inline BasicBlock *getSuccessor(unsigned i) const {
1389 assert(i < 2 && "Successor # out of range for invoke!");
1390 return i == 0 ? getNormalDest() : getUnwindDest();
1393 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1394 assert(idx < 2 && "Successor # out of range for invoke!");
1395 setOperand(idx+1, reinterpret_cast<Value*>(NewSucc));
1398 unsigned getNumSuccessors() const { return 2; }
1400 // Methods for support type inquiry through isa, cast, and dyn_cast:
1401 static inline bool classof(const InvokeInst *) { return true; }
1402 static inline bool classof(const Instruction *I) {
1403 return (I->getOpcode() == Instruction::Invoke);
1405 static inline bool classof(const Value *V) {
1406 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1409 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1410 virtual unsigned getNumSuccessorsV() const;
1411 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1415 //===----------------------------------------------------------------------===//
1417 //===----------------------------------------------------------------------===//
1419 //===---------------------------------------------------------------------------
1420 /// UnwindInst - Immediately exit the current function, unwinding the stack
1421 /// until an invoke instruction is found.
1423 class UnwindInst : public TerminatorInst {
1425 UnwindInst(Instruction *InsertBefore = 0)
1426 : TerminatorInst(Instruction::Unwind, 0, 0, InsertBefore) {
1428 UnwindInst(BasicBlock *InsertAtEnd)
1429 : TerminatorInst(Instruction::Unwind, 0, 0, InsertAtEnd) {
1432 virtual UnwindInst *clone() const;
1434 unsigned getNumSuccessors() const { return 0; }
1436 // Methods for support type inquiry through isa, cast, and dyn_cast:
1437 static inline bool classof(const UnwindInst *) { return true; }
1438 static inline bool classof(const Instruction *I) {
1439 return I->getOpcode() == Instruction::Unwind;
1441 static inline bool classof(const Value *V) {
1442 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1445 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1446 virtual unsigned getNumSuccessorsV() const;
1447 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1450 //===----------------------------------------------------------------------===//
1451 // UnreachableInst Class
1452 //===----------------------------------------------------------------------===//
1454 //===---------------------------------------------------------------------------
1455 /// UnreachableInst - This function has undefined behavior. In particular, the
1456 /// presence of this instruction indicates some higher level knowledge that the
1457 /// end of the block cannot be reached.
1459 class UnreachableInst : public TerminatorInst {
1461 UnreachableInst(Instruction *InsertBefore = 0)
1462 : TerminatorInst(Instruction::Unreachable, 0, 0, InsertBefore) {
1464 UnreachableInst(BasicBlock *InsertAtEnd)
1465 : TerminatorInst(Instruction::Unreachable, 0, 0, InsertAtEnd) {
1468 virtual UnreachableInst *clone() const;
1470 unsigned getNumSuccessors() const { return 0; }
1472 // Methods for support type inquiry through isa, cast, and dyn_cast:
1473 static inline bool classof(const UnreachableInst *) { return true; }
1474 static inline bool classof(const Instruction *I) {
1475 return I->getOpcode() == Instruction::Unreachable;
1477 static inline bool classof(const Value *V) {
1478 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1481 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1482 virtual unsigned getNumSuccessorsV() const;
1483 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1486 } // End llvm namespace