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);
46 /// isArrayAllocation - Return true if there is an allocation size parameter
47 /// to the allocation instruction that is not 1.
49 bool isArrayAllocation() const;
51 /// getArraySize - Get the number of element allocated, for a simple
52 /// allocation of a single element, this will return a constant 1 value.
54 inline const Value *getArraySize() const { return getOperand(0); }
55 inline Value *getArraySize() { return getOperand(0); }
57 /// getType - Overload to return most specific pointer type
59 inline const PointerType *getType() const {
60 return reinterpret_cast<const PointerType*>(Instruction::getType());
63 /// getAllocatedType - Return the type that is being allocated by the
66 const Type *getAllocatedType() const;
68 /// getAlignment - Return the alignment of the memory that is being allocated
69 /// by the instruction.
71 unsigned getAlignment() const { return Alignment; }
72 void setAlignment(unsigned Align) {
73 assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
77 virtual Instruction *clone() const = 0;
79 // Methods for support type inquiry through isa, cast, and dyn_cast:
80 static inline bool classof(const AllocationInst *) { return true; }
81 static inline bool classof(const Instruction *I) {
82 return I->getOpcode() == Instruction::Alloca ||
83 I->getOpcode() == Instruction::Malloc;
85 static inline bool classof(const Value *V) {
86 return isa<Instruction>(V) && classof(cast<Instruction>(V));
91 //===----------------------------------------------------------------------===//
93 //===----------------------------------------------------------------------===//
95 /// MallocInst - an instruction to allocated memory on the heap
97 class MallocInst : public AllocationInst {
98 MallocInst(const MallocInst &MI);
100 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
101 const std::string &Name = "",
102 Instruction *InsertBefore = 0)
103 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
104 MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
105 BasicBlock *InsertAtEnd)
106 : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
108 explicit MallocInst(const Type *Ty, const std::string &Name,
109 Instruction *InsertBefore = 0)
110 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
111 MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
112 : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
114 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
115 const std::string &Name, BasicBlock *InsertAtEnd)
116 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
117 MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
118 const std::string &Name = "",
119 Instruction *InsertBefore = 0)
120 : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
122 virtual MallocInst *clone() const;
124 // Methods for support type inquiry through isa, cast, and dyn_cast:
125 static inline bool classof(const MallocInst *) { return true; }
126 static inline bool classof(const Instruction *I) {
127 return (I->getOpcode() == Instruction::Malloc);
129 static inline bool classof(const Value *V) {
130 return isa<Instruction>(V) && classof(cast<Instruction>(V));
135 //===----------------------------------------------------------------------===//
137 //===----------------------------------------------------------------------===//
139 /// AllocaInst - an instruction to allocate memory on the stack
141 class AllocaInst : public AllocationInst {
142 AllocaInst(const AllocaInst &);
144 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
145 const std::string &Name = "",
146 Instruction *InsertBefore = 0)
147 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
148 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
149 BasicBlock *InsertAtEnd)
150 : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
152 AllocaInst(const Type *Ty, const std::string &Name,
153 Instruction *InsertBefore = 0)
154 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
155 AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
156 : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
158 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
159 const std::string &Name = "", Instruction *InsertBefore = 0)
160 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
161 AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
162 const std::string &Name, BasicBlock *InsertAtEnd)
163 : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
165 virtual AllocaInst *clone() const;
167 // Methods for support type inquiry through isa, cast, and dyn_cast:
168 static inline bool classof(const AllocaInst *) { return true; }
169 static inline bool classof(const Instruction *I) {
170 return (I->getOpcode() == Instruction::Alloca);
172 static inline bool classof(const Value *V) {
173 return isa<Instruction>(V) && classof(cast<Instruction>(V));
178 //===----------------------------------------------------------------------===//
180 //===----------------------------------------------------------------------===//
182 /// FreeInst - an instruction to deallocate memory
184 class FreeInst : public UnaryInstruction {
187 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
188 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
190 virtual FreeInst *clone() const;
192 virtual bool mayWriteToMemory() const { return true; }
194 // Methods for support type inquiry through isa, cast, and dyn_cast:
195 static inline bool classof(const FreeInst *) { return true; }
196 static inline bool classof(const Instruction *I) {
197 return (I->getOpcode() == Instruction::Free);
199 static inline bool classof(const Value *V) {
200 return isa<Instruction>(V) && classof(cast<Instruction>(V));
205 //===----------------------------------------------------------------------===//
207 //===----------------------------------------------------------------------===//
209 /// LoadInst - an instruction for reading from memory. This uses the
210 /// SubclassData field in Value to store whether or not the load is volatile.
212 class LoadInst : public UnaryInstruction {
213 LoadInst(const LoadInst &LI)
214 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
215 setVolatile(LI.isVolatile());
223 LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
224 LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
225 LoadInst(Value *Ptr, const std::string &Name = "", bool isVolatile = false,
226 Instruction *InsertBefore = 0);
227 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
228 BasicBlock *InsertAtEnd);
230 /// isVolatile - Return true if this is a load from a volatile memory
233 bool isVolatile() const { return SubclassData; }
235 /// setVolatile - Specify whether this is a volatile load or not.
237 void setVolatile(bool V) { SubclassData = V; }
239 virtual LoadInst *clone() const;
241 virtual bool mayWriteToMemory() const { return isVolatile(); }
243 Value *getPointerOperand() { return getOperand(0); }
244 const Value *getPointerOperand() const { return getOperand(0); }
245 static unsigned getPointerOperandIndex() { return 0U; }
247 // Methods for support type inquiry through isa, cast, and dyn_cast:
248 static inline bool classof(const LoadInst *) { return true; }
249 static inline bool classof(const Instruction *I) {
250 return I->getOpcode() == Instruction::Load;
252 static inline bool classof(const Value *V) {
253 return isa<Instruction>(V) && classof(cast<Instruction>(V));
258 //===----------------------------------------------------------------------===//
260 //===----------------------------------------------------------------------===//
262 /// StoreInst - an instruction for storing to memory
264 class StoreInst : public Instruction {
266 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store, Ops, 2) {
267 Ops[0].init(SI.Ops[0], this);
268 Ops[1].init(SI.Ops[1], this);
269 setVolatile(SI.isVolatile());
276 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
277 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
278 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
279 Instruction *InsertBefore = 0);
280 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
283 /// isVolatile - Return true if this is a load from a volatile memory
286 bool isVolatile() const { return SubclassData; }
288 /// setVolatile - Specify whether this is a volatile load or not.
290 void setVolatile(bool V) { SubclassData = V; }
292 /// Transparently provide more efficient getOperand methods.
293 Value *getOperand(unsigned i) const {
294 assert(i < 2 && "getOperand() out of range!");
297 void setOperand(unsigned i, Value *Val) {
298 assert(i < 2 && "setOperand() out of range!");
301 unsigned getNumOperands() const { return 2; }
304 virtual StoreInst *clone() const;
306 virtual bool mayWriteToMemory() const { return true; }
308 Value *getPointerOperand() { return getOperand(1); }
309 const Value *getPointerOperand() const { return getOperand(1); }
310 static unsigned getPointerOperandIndex() { return 1U; }
312 // Methods for support type inquiry through isa, cast, and dyn_cast:
313 static inline bool classof(const StoreInst *) { return true; }
314 static inline bool classof(const Instruction *I) {
315 return I->getOpcode() == Instruction::Store;
317 static inline bool classof(const Value *V) {
318 return isa<Instruction>(V) && classof(cast<Instruction>(V));
323 //===----------------------------------------------------------------------===//
324 // GetElementPtrInst Class
325 //===----------------------------------------------------------------------===//
327 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
328 /// access elements of arrays and structs
330 class GetElementPtrInst : public Instruction {
331 GetElementPtrInst(const GetElementPtrInst &GEPI)
332 : Instruction(reinterpret_cast<const Type*>(GEPI.getType()), GetElementPtr,
333 0, GEPI.getNumOperands()) {
334 Use *OL = OperandList = new Use[NumOperands];
335 Use *GEPIOL = GEPI.OperandList;
336 for (unsigned i = 0, E = NumOperands; i != E; ++i)
337 OL[i].init(GEPIOL[i], this);
339 void init(Value *Ptr, const std::vector<Value*> &Idx);
340 void init(Value *Ptr, Value *Idx0, Value *Idx1);
341 void init(Value *Ptr, Value *Idx);
343 /// Constructors - Create a getelementptr instruction with a base pointer an
344 /// list of indices. The first ctor can optionally insert before an existing
345 /// instruction, the second appends the new instruction to the specified
347 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
348 const std::string &Name = "", Instruction *InsertBefore =0);
349 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
350 const std::string &Name, BasicBlock *InsertAtEnd);
352 /// Constructors - These two constructors are convenience methods because one
353 /// and two index getelementptr instructions are so common.
354 GetElementPtrInst(Value *Ptr, Value *Idx,
355 const std::string &Name = "", Instruction *InsertBefore =0);
356 GetElementPtrInst(Value *Ptr, Value *Idx,
357 const std::string &Name, BasicBlock *InsertAtEnd);
358 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
359 const std::string &Name = "", Instruction *InsertBefore =0);
360 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
361 const std::string &Name, BasicBlock *InsertAtEnd);
362 ~GetElementPtrInst();
364 virtual GetElementPtrInst *clone() const;
366 // getType - Overload to return most specific pointer type...
367 inline const PointerType *getType() const {
368 return reinterpret_cast<const PointerType*>(Instruction::getType());
371 /// getIndexedType - Returns the type of the element that would be loaded with
372 /// a load instruction with the specified parameters.
374 /// A null type is returned if the indices are invalid for the specified
377 static const Type *getIndexedType(const Type *Ptr,
378 const std::vector<Value*> &Indices,
379 bool AllowStructLeaf = false);
380 static const Type *getIndexedType(const Type *Ptr, Value *Idx0, Value *Idx1,
381 bool AllowStructLeaf = false);
382 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
384 inline op_iterator idx_begin() { return op_begin()+1; }
385 inline const_op_iterator idx_begin() const { return op_begin()+1; }
386 inline op_iterator idx_end() { return op_end(); }
387 inline const_op_iterator idx_end() const { return op_end(); }
389 Value *getPointerOperand() {
390 return getOperand(0);
392 const Value *getPointerOperand() const {
393 return getOperand(0);
395 static unsigned getPointerOperandIndex() {
396 return 0U; // get index for modifying correct operand
399 inline unsigned getNumIndices() const { // Note: always non-negative
400 return getNumOperands() - 1;
403 inline bool hasIndices() const {
404 return getNumOperands() > 1;
407 // Methods for support type inquiry through isa, cast, and dyn_cast:
408 static inline bool classof(const GetElementPtrInst *) { return true; }
409 static inline bool classof(const Instruction *I) {
410 return (I->getOpcode() == Instruction::GetElementPtr);
412 static inline bool classof(const Value *V) {
413 return isa<Instruction>(V) && classof(cast<Instruction>(V));
417 //===----------------------------------------------------------------------===//
419 //===----------------------------------------------------------------------===//
421 /// SetCondInst class - Represent a setCC operator, where CC is eq, ne, lt, gt,
424 class SetCondInst : public BinaryOperator {
426 SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
427 const std::string &Name = "", Instruction *InsertBefore = 0);
428 SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
429 const std::string &Name, BasicBlock *InsertAtEnd);
431 /// getInverseCondition - Return the inverse of the current condition opcode.
432 /// For example seteq -> setne, setgt -> setle, setlt -> setge, etc...
434 BinaryOps getInverseCondition() const {
435 return getInverseCondition(getOpcode());
438 /// getInverseCondition - Static version that you can use without an
439 /// instruction available.
441 static BinaryOps getInverseCondition(BinaryOps Opcode);
443 /// getSwappedCondition - Return the condition opcode that would be the result
444 /// of exchanging the two operands of the setcc instruction without changing
445 /// the result produced. Thus, seteq->seteq, setle->setge, setlt->setgt, etc.
447 BinaryOps getSwappedCondition() const {
448 return getSwappedCondition(getOpcode());
451 /// getSwappedCondition - Static version that you can use without an
452 /// instruction available.
454 static BinaryOps getSwappedCondition(BinaryOps Opcode);
457 // Methods for support type inquiry through isa, cast, and dyn_cast:
458 static inline bool classof(const SetCondInst *) { return true; }
459 static inline bool classof(const Instruction *I) {
460 return I->getOpcode() == SetEQ || I->getOpcode() == SetNE ||
461 I->getOpcode() == SetLE || I->getOpcode() == SetGE ||
462 I->getOpcode() == SetLT || I->getOpcode() == SetGT;
464 static inline bool classof(const Value *V) {
465 return isa<Instruction>(V) && classof(cast<Instruction>(V));
469 //===----------------------------------------------------------------------===//
471 //===----------------------------------------------------------------------===//
473 /// CastInst - This class represents a cast from Operand[0] to the type of
474 /// the instruction (i->getType()).
476 class CastInst : public UnaryInstruction {
477 CastInst(const CastInst &CI)
478 : UnaryInstruction(CI.getType(), Cast, CI.getOperand(0)) {
481 CastInst(Value *S, const Type *Ty, const std::string &Name = "",
482 Instruction *InsertBefore = 0)
483 : UnaryInstruction(Ty, Cast, S, Name, InsertBefore) {
485 CastInst(Value *S, const Type *Ty, const std::string &Name,
486 BasicBlock *InsertAtEnd)
487 : UnaryInstruction(Ty, Cast, S, Name, InsertAtEnd) {
490 virtual CastInst *clone() const;
492 // Methods for support type inquiry through isa, cast, and dyn_cast:
493 static inline bool classof(const CastInst *) { return true; }
494 static inline bool classof(const Instruction *I) {
495 return I->getOpcode() == Cast;
497 static inline bool classof(const Value *V) {
498 return isa<Instruction>(V) && classof(cast<Instruction>(V));
503 //===----------------------------------------------------------------------===//
505 //===----------------------------------------------------------------------===//
507 /// CallInst - This class represents a function call, abstracting a target
508 /// machine's calling convention. This class uses low bit of the SubClassData
509 /// field to indicate whether or not this is a tail call. The rest of the bits
510 /// hold the calling convention of the call.
512 class CallInst : public Instruction {
513 CallInst(const CallInst &CI);
514 void init(Value *Func, const std::vector<Value*> &Params);
515 void init(Value *Func, Value *Actual1, Value *Actual2);
516 void init(Value *Func, Value *Actual);
517 void init(Value *Func);
520 CallInst(Value *F, const std::vector<Value*> &Par,
521 const std::string &Name = "", Instruction *InsertBefore = 0);
522 CallInst(Value *F, const std::vector<Value*> &Par,
523 const std::string &Name, BasicBlock *InsertAtEnd);
525 // Alternate CallInst ctors w/ two actuals, w/ one actual and no
526 // actuals, respectively.
527 CallInst(Value *F, Value *Actual1, Value *Actual2,
528 const std::string& Name = "", Instruction *InsertBefore = 0);
529 CallInst(Value *F, Value *Actual1, Value *Actual2,
530 const std::string& Name, BasicBlock *InsertAtEnd);
531 CallInst(Value *F, Value *Actual, const std::string& Name = "",
532 Instruction *InsertBefore = 0);
533 CallInst(Value *F, Value *Actual, const std::string& Name,
534 BasicBlock *InsertAtEnd);
535 explicit CallInst(Value *F, const std::string &Name = "",
536 Instruction *InsertBefore = 0);
537 explicit CallInst(Value *F, const std::string &Name,
538 BasicBlock *InsertAtEnd);
541 virtual CallInst *clone() const;
542 bool mayWriteToMemory() const { return true; }
544 bool isTailCall() const { return SubclassData & 1; }
545 void setTailCall(bool isTailCall = true) {
546 SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
549 /// getCallingConv/setCallingConv - Get or set the calling convention of this
551 unsigned getCallingConv() const { return SubclassData >> 1; }
552 void setCallingConv(unsigned CC) {
553 SubclassData = (SubclassData & 1) | (CC << 1);
556 /// getCalledFunction - Return the function being called by this instruction
557 /// if it is a direct call. If it is a call through a function pointer,
559 Function *getCalledFunction() const {
560 return static_cast<Function*>(dyn_cast<Function>(getOperand(0)));
563 // getCalledValue - Get a pointer to a method that is invoked by this inst.
564 inline const Value *getCalledValue() const { return getOperand(0); }
565 inline Value *getCalledValue() { return getOperand(0); }
567 // Methods for support type inquiry through isa, cast, and dyn_cast:
568 static inline bool classof(const CallInst *) { return true; }
569 static inline bool classof(const Instruction *I) {
570 return I->getOpcode() == Instruction::Call;
572 static inline bool classof(const Value *V) {
573 return isa<Instruction>(V) && classof(cast<Instruction>(V));
578 //===----------------------------------------------------------------------===//
580 //===----------------------------------------------------------------------===//
582 /// ShiftInst - This class represents left and right shift instructions.
584 class ShiftInst : public Instruction {
586 ShiftInst(const ShiftInst &SI)
587 : Instruction(SI.getType(), SI.getOpcode(), Ops, 2) {
588 Ops[0].init(SI.Ops[0], this);
589 Ops[1].init(SI.Ops[1], this);
591 void init(OtherOps Opcode, Value *S, Value *SA) {
592 assert((Opcode == Shl || Opcode == Shr) && "ShiftInst Opcode invalid!");
593 Ops[0].init(S, this);
594 Ops[1].init(SA, this);
598 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name = "",
599 Instruction *InsertBefore = 0)
600 : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertBefore) {
603 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name,
604 BasicBlock *InsertAtEnd)
605 : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertAtEnd) {
609 OtherOps getOpcode() const {
610 return static_cast<OtherOps>(Instruction::getOpcode());
613 /// Transparently provide more efficient getOperand methods.
614 Value *getOperand(unsigned i) const {
615 assert(i < 2 && "getOperand() out of range!");
618 void setOperand(unsigned i, Value *Val) {
619 assert(i < 2 && "setOperand() out of range!");
622 unsigned getNumOperands() const { return 2; }
624 virtual ShiftInst *clone() const;
626 // Methods for support type inquiry through isa, cast, and dyn_cast:
627 static inline bool classof(const ShiftInst *) { return true; }
628 static inline bool classof(const Instruction *I) {
629 return (I->getOpcode() == Instruction::Shr) |
630 (I->getOpcode() == Instruction::Shl);
632 static inline bool classof(const Value *V) {
633 return isa<Instruction>(V) && classof(cast<Instruction>(V));
637 //===----------------------------------------------------------------------===//
639 //===----------------------------------------------------------------------===//
641 /// SelectInst - This class represents the LLVM 'select' instruction.
643 class SelectInst : public Instruction {
646 void init(Value *C, Value *S1, Value *S2) {
647 Ops[0].init(C, this);
648 Ops[1].init(S1, this);
649 Ops[2].init(S2, this);
652 SelectInst(const SelectInst &SI)
653 : Instruction(SI.getType(), SI.getOpcode(), Ops, 3) {
654 init(SI.Ops[0], SI.Ops[1], SI.Ops[2]);
657 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
658 Instruction *InsertBefore = 0)
659 : Instruction(S1->getType(), Instruction::Select, Ops, 3,
660 Name, InsertBefore) {
663 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
664 BasicBlock *InsertAtEnd)
665 : Instruction(S1->getType(), Instruction::Select, Ops, 3,
670 Value *getCondition() const { return Ops[0]; }
671 Value *getTrueValue() const { return Ops[1]; }
672 Value *getFalseValue() const { return Ops[2]; }
674 /// Transparently provide more efficient getOperand methods.
675 Value *getOperand(unsigned i) const {
676 assert(i < 3 && "getOperand() out of range!");
679 void setOperand(unsigned i, Value *Val) {
680 assert(i < 3 && "setOperand() out of range!");
683 unsigned getNumOperands() const { return 3; }
685 OtherOps getOpcode() const {
686 return static_cast<OtherOps>(Instruction::getOpcode());
689 virtual SelectInst *clone() const;
691 // Methods for support type inquiry through isa, cast, and dyn_cast:
692 static inline bool classof(const SelectInst *) { return true; }
693 static inline bool classof(const Instruction *I) {
694 return I->getOpcode() == Instruction::Select;
696 static inline bool classof(const Value *V) {
697 return isa<Instruction>(V) && classof(cast<Instruction>(V));
701 //===----------------------------------------------------------------------===//
703 //===----------------------------------------------------------------------===//
705 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
706 /// an argument of the specified type given a va_list and increments that list
708 class VAArgInst : public UnaryInstruction {
709 VAArgInst(const VAArgInst &VAA)
710 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
712 VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
713 Instruction *InsertBefore = 0)
714 : UnaryInstruction(Ty, VAArg, List, Name, InsertBefore) {
716 VAArgInst(Value *List, const Type *Ty, const std::string &Name,
717 BasicBlock *InsertAtEnd)
718 : UnaryInstruction(Ty, VAArg, List, Name, InsertAtEnd) {
721 virtual VAArgInst *clone() const;
722 bool mayWriteToMemory() const { return true; }
724 // Methods for support type inquiry through isa, cast, and dyn_cast:
725 static inline bool classof(const VAArgInst *) { return true; }
726 static inline bool classof(const Instruction *I) {
727 return I->getOpcode() == VAArg;
729 static inline bool classof(const Value *V) {
730 return isa<Instruction>(V) && classof(cast<Instruction>(V));
734 //===----------------------------------------------------------------------===//
735 // ExtractElementInst Class
736 //===----------------------------------------------------------------------===//
738 /// ExtractElementInst - This instruction extracts a single (scalar)
739 /// element from a PackedType value
741 class ExtractElementInst : public Instruction {
743 ExtractElementInst(const ExtractElementInst &EE) :
744 Instruction(EE.getType(), ExtractElement, Ops, 2) {
745 Ops[0].init(EE.Ops[0], this);
746 Ops[1].init(EE.Ops[1], this);
750 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
751 Instruction *InsertBefore = 0);
752 ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
753 BasicBlock *InsertAtEnd);
755 /// isValidOperands - Return true if an extractelement instruction can be
756 /// formed with the specified operands.
757 static bool isValidOperands(const Value *Vec, const Value *Idx);
759 virtual ExtractElementInst *clone() const;
761 virtual bool mayWriteToMemory() const { return false; }
763 /// Transparently provide more efficient getOperand methods.
764 Value *getOperand(unsigned i) const {
765 assert(i < 2 && "getOperand() out of range!");
768 void setOperand(unsigned i, Value *Val) {
769 assert(i < 2 && "setOperand() out of range!");
772 unsigned getNumOperands() const { return 2; }
774 // Methods for support type inquiry through isa, cast, and dyn_cast:
775 static inline bool classof(const ExtractElementInst *) { return true; }
776 static inline bool classof(const Instruction *I) {
777 return I->getOpcode() == Instruction::ExtractElement;
779 static inline bool classof(const Value *V) {
780 return isa<Instruction>(V) && classof(cast<Instruction>(V));
784 //===----------------------------------------------------------------------===//
785 // InsertElementInst Class
786 //===----------------------------------------------------------------------===//
788 /// InsertElementInst - This instruction inserts a single (scalar)
789 /// element into a PackedType value
791 class InsertElementInst : public Instruction {
793 InsertElementInst(const InsertElementInst &IE);
795 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
796 const std::string &Name = "",Instruction *InsertBefore = 0);
797 InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
798 const std::string &Name, BasicBlock *InsertAtEnd);
800 /// isValidOperands - Return true if an insertelement instruction can be
801 /// formed with the specified operands.
802 static bool isValidOperands(const Value *Vec, const Value *NewElt,
805 virtual InsertElementInst *clone() const;
807 virtual bool mayWriteToMemory() const { return false; }
809 /// getType - Overload to return most specific packed type.
811 inline const PackedType *getType() const {
812 return reinterpret_cast<const PackedType*>(Instruction::getType());
815 /// Transparently provide more efficient getOperand methods.
816 Value *getOperand(unsigned i) const {
817 assert(i < 3 && "getOperand() out of range!");
820 void setOperand(unsigned i, Value *Val) {
821 assert(i < 3 && "setOperand() out of range!");
824 unsigned getNumOperands() const { return 3; }
826 // Methods for support type inquiry through isa, cast, and dyn_cast:
827 static inline bool classof(const InsertElementInst *) { return true; }
828 static inline bool classof(const Instruction *I) {
829 return I->getOpcode() == Instruction::InsertElement;
831 static inline bool classof(const Value *V) {
832 return isa<Instruction>(V) && classof(cast<Instruction>(V));
836 //===----------------------------------------------------------------------===//
837 // ShuffleVectorInst Class
838 //===----------------------------------------------------------------------===//
840 /// ShuffleVectorInst - This instruction constructs a fixed permutation of two
843 class ShuffleVectorInst : public Instruction {
845 ShuffleVectorInst(const ShuffleVectorInst &IE);
847 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
848 const std::string &Name = "", Instruction *InsertBefor = 0);
849 ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
850 const std::string &Name, BasicBlock *InsertAtEnd);
852 /// isValidOperands - Return true if a shufflevector instruction can be
853 /// formed with the specified operands.
854 static bool isValidOperands(const Value *V1, const Value *V2,
857 virtual ShuffleVectorInst *clone() const;
859 virtual bool mayWriteToMemory() const { return false; }
861 /// getType - Overload to return most specific packed type.
863 inline const PackedType *getType() const {
864 return reinterpret_cast<const PackedType*>(Instruction::getType());
867 /// Transparently provide more efficient getOperand methods.
868 Value *getOperand(unsigned i) const {
869 assert(i < 3 && "getOperand() out of range!");
872 void setOperand(unsigned i, Value *Val) {
873 assert(i < 3 && "setOperand() out of range!");
876 unsigned getNumOperands() const { return 3; }
878 // Methods for support type inquiry through isa, cast, and dyn_cast:
879 static inline bool classof(const ShuffleVectorInst *) { return true; }
880 static inline bool classof(const Instruction *I) {
881 return I->getOpcode() == Instruction::ShuffleVector;
883 static inline bool classof(const Value *V) {
884 return isa<Instruction>(V) && classof(cast<Instruction>(V));
889 //===----------------------------------------------------------------------===//
891 //===----------------------------------------------------------------------===//
893 // PHINode - The PHINode class is used to represent the magical mystical PHI
894 // node, that can not exist in nature, but can be synthesized in a computer
895 // scientist's overactive imagination.
897 class PHINode : public Instruction {
898 /// ReservedSpace - The number of operands actually allocated. NumOperands is
899 /// the number actually in use.
900 unsigned ReservedSpace;
901 PHINode(const PHINode &PN);
903 PHINode(const Type *Ty, const std::string &Name = "",
904 Instruction *InsertBefore = 0)
905 : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertBefore),
909 PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
910 : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertAtEnd),
916 /// reserveOperandSpace - This method can be used to avoid repeated
917 /// reallocation of PHI operand lists by reserving space for the correct
918 /// number of operands before adding them. Unlike normal vector reserves,
919 /// this method can also be used to trim the operand space.
920 void reserveOperandSpace(unsigned NumValues) {
921 resizeOperands(NumValues*2);
924 virtual PHINode *clone() const;
926 /// getNumIncomingValues - Return the number of incoming edges
928 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
930 /// getIncomingValue - Return incoming value number x
932 Value *getIncomingValue(unsigned i) const {
933 assert(i*2 < getNumOperands() && "Invalid value number!");
934 return getOperand(i*2);
936 void setIncomingValue(unsigned i, Value *V) {
937 assert(i*2 < getNumOperands() && "Invalid value number!");
940 unsigned getOperandNumForIncomingValue(unsigned i) {
944 /// getIncomingBlock - Return incoming basic block number x
946 BasicBlock *getIncomingBlock(unsigned i) const {
947 return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
949 void setIncomingBlock(unsigned i, BasicBlock *BB) {
950 setOperand(i*2+1, reinterpret_cast<Value*>(BB));
952 unsigned getOperandNumForIncomingBlock(unsigned i) {
956 /// addIncoming - Add an incoming value to the end of the PHI list
958 void addIncoming(Value *V, BasicBlock *BB) {
959 assert(getType() == V->getType() &&
960 "All operands to PHI node must be the same type as the PHI node!");
961 unsigned OpNo = NumOperands;
962 if (OpNo+2 > ReservedSpace)
963 resizeOperands(0); // Get more space!
964 // Initialize some new operands.
965 NumOperands = OpNo+2;
966 OperandList[OpNo].init(V, this);
967 OperandList[OpNo+1].init(reinterpret_cast<Value*>(BB), this);
970 /// removeIncomingValue - Remove an incoming value. This is useful if a
971 /// predecessor basic block is deleted. The value removed is returned.
973 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
974 /// is true), the PHI node is destroyed and any uses of it are replaced with
975 /// dummy values. The only time there should be zero incoming values to a PHI
976 /// node is when the block is dead, so this strategy is sound.
978 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
980 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
981 int Idx = getBasicBlockIndex(BB);
982 assert(Idx >= 0 && "Invalid basic block argument to remove!");
983 return removeIncomingValue(Idx, DeletePHIIfEmpty);
986 /// getBasicBlockIndex - Return the first index of the specified basic
987 /// block in the value list for this PHI. Returns -1 if no instance.
989 int getBasicBlockIndex(const BasicBlock *BB) const {
990 Use *OL = OperandList;
991 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
992 if (OL[i+1] == reinterpret_cast<const Value*>(BB)) return i/2;
996 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
997 return getIncomingValue(getBasicBlockIndex(BB));
1000 /// hasConstantValue - If the specified PHI node always merges together the
1001 /// same value, return the value, otherwise return null.
1003 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
1005 /// Methods for support type inquiry through isa, cast, and dyn_cast:
1006 static inline bool classof(const PHINode *) { return true; }
1007 static inline bool classof(const Instruction *I) {
1008 return I->getOpcode() == Instruction::PHI;
1010 static inline bool classof(const Value *V) {
1011 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1014 void resizeOperands(unsigned NumOperands);
1017 //===----------------------------------------------------------------------===//
1019 //===----------------------------------------------------------------------===//
1021 //===---------------------------------------------------------------------------
1022 /// ReturnInst - Return a value (possibly void), from a function. Execution
1023 /// does not continue in this function any longer.
1025 class ReturnInst : public TerminatorInst {
1026 Use RetVal; // Possibly null retval.
1027 ReturnInst(const ReturnInst &RI) : TerminatorInst(Instruction::Ret, &RetVal,
1028 RI.getNumOperands()) {
1029 if (RI.getNumOperands())
1030 RetVal.init(RI.RetVal, this);
1033 void init(Value *RetVal);
1036 // ReturnInst constructors:
1037 // ReturnInst() - 'ret void' instruction
1038 // ReturnInst( null) - 'ret void' instruction
1039 // ReturnInst(Value* X) - 'ret X' instruction
1040 // ReturnInst( null, Inst *) - 'ret void' instruction, insert before I
1041 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
1042 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of BB
1043 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of BB
1045 // NOTE: If the Value* passed is of type void then the constructor behaves as
1046 // if it was passed NULL.
1047 ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0)
1048 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertBefore) {
1051 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd)
1052 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
1055 ReturnInst(BasicBlock *InsertAtEnd)
1056 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
1059 virtual ReturnInst *clone() const;
1061 // Transparently provide more efficient getOperand methods.
1062 Value *getOperand(unsigned i) const {
1063 assert(i < getNumOperands() && "getOperand() out of range!");
1066 void setOperand(unsigned i, Value *Val) {
1067 assert(i < getNumOperands() && "setOperand() out of range!");
1071 Value *getReturnValue() const { return RetVal; }
1073 unsigned getNumSuccessors() const { return 0; }
1075 // Methods for support type inquiry through isa, cast, and dyn_cast:
1076 static inline bool classof(const ReturnInst *) { return true; }
1077 static inline bool classof(const Instruction *I) {
1078 return (I->getOpcode() == Instruction::Ret);
1080 static inline bool classof(const Value *V) {
1081 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1084 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1085 virtual unsigned getNumSuccessorsV() const;
1086 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1089 //===----------------------------------------------------------------------===//
1091 //===----------------------------------------------------------------------===//
1093 //===---------------------------------------------------------------------------
1094 /// BranchInst - Conditional or Unconditional Branch instruction.
1096 class BranchInst : public TerminatorInst {
1097 /// Ops list - Branches are strange. The operands are ordered:
1098 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
1099 /// they don't have to check for cond/uncond branchness.
1101 BranchInst(const BranchInst &BI);
1104 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
1105 // BranchInst(BB *B) - 'br B'
1106 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
1107 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
1108 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
1109 // BranchInst(BB* B, BB *I) - 'br B' insert at end
1110 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
1111 BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0)
1112 : TerminatorInst(Instruction::Br, Ops, 1, InsertBefore) {
1113 assert(IfTrue != 0 && "Branch destination may not be null!");
1114 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1116 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1117 Instruction *InsertBefore = 0)
1118 : TerminatorInst(Instruction::Br, Ops, 3, InsertBefore) {
1119 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1120 Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
1121 Ops[2].init(Cond, this);
1127 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
1128 : TerminatorInst(Instruction::Br, Ops, 1, InsertAtEnd) {
1129 assert(IfTrue != 0 && "Branch destination may not be null!");
1130 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1133 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
1134 BasicBlock *InsertAtEnd)
1135 : TerminatorInst(Instruction::Br, Ops, 3, InsertAtEnd) {
1136 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
1137 Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
1138 Ops[2].init(Cond, this);
1145 /// Transparently provide more efficient getOperand methods.
1146 Value *getOperand(unsigned i) const {
1147 assert(i < getNumOperands() && "getOperand() out of range!");
1150 void setOperand(unsigned i, Value *Val) {
1151 assert(i < getNumOperands() && "setOperand() out of range!");
1155 virtual BranchInst *clone() const;
1157 inline bool isUnconditional() const { return getNumOperands() == 1; }
1158 inline bool isConditional() const { return getNumOperands() == 3; }
1160 inline Value *getCondition() const {
1161 assert(isConditional() && "Cannot get condition of an uncond branch!");
1162 return getOperand(2);
1165 void setCondition(Value *V) {
1166 assert(isConditional() && "Cannot set condition of unconditional branch!");
1170 // setUnconditionalDest - Change the current branch to an unconditional branch
1171 // targeting the specified block.
1172 // FIXME: Eliminate this ugly method.
1173 void setUnconditionalDest(BasicBlock *Dest) {
1174 if (isConditional()) { // Convert this to an uncond branch.
1179 setOperand(0, reinterpret_cast<Value*>(Dest));
1182 unsigned getNumSuccessors() const { return 1+isConditional(); }
1184 BasicBlock *getSuccessor(unsigned i) const {
1185 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
1186 return (i == 0) ? cast<BasicBlock>(getOperand(0)) :
1187 cast<BasicBlock>(getOperand(1));
1190 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1191 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
1192 setOperand(idx, reinterpret_cast<Value*>(NewSucc));
1195 // Methods for support type inquiry through isa, cast, and dyn_cast:
1196 static inline bool classof(const BranchInst *) { return true; }
1197 static inline bool classof(const Instruction *I) {
1198 return (I->getOpcode() == Instruction::Br);
1200 static inline bool classof(const Value *V) {
1201 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1204 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1205 virtual unsigned getNumSuccessorsV() const;
1206 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1209 //===----------------------------------------------------------------------===//
1211 //===----------------------------------------------------------------------===//
1213 //===---------------------------------------------------------------------------
1214 /// SwitchInst - Multiway switch
1216 class SwitchInst : public TerminatorInst {
1217 unsigned ReservedSpace;
1218 // Operand[0] = Value to switch on
1219 // Operand[1] = Default basic block destination
1220 // Operand[2n ] = Value to match
1221 // Operand[2n+1] = BasicBlock to go to on match
1222 SwitchInst(const SwitchInst &RI);
1223 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1224 void resizeOperands(unsigned No);
1226 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1227 /// switch on and a default destination. The number of additional cases can
1228 /// be specified here to make memory allocation more efficient. This
1229 /// constructor can also autoinsert before another instruction.
1230 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1231 Instruction *InsertBefore = 0)
1232 : TerminatorInst(Instruction::Switch, 0, 0, InsertBefore) {
1233 init(Value, Default, NumCases);
1236 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1237 /// switch on and a default destination. The number of additional cases can
1238 /// be specified here to make memory allocation more efficient. This
1239 /// constructor also autoinserts at the end of the specified BasicBlock.
1240 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1241 BasicBlock *InsertAtEnd)
1242 : TerminatorInst(Instruction::Switch, 0, 0, InsertAtEnd) {
1243 init(Value, Default, NumCases);
1248 // Accessor Methods for Switch stmt
1249 inline Value *getCondition() const { return getOperand(0); }
1250 void setCondition(Value *V) { setOperand(0, V); }
1252 inline BasicBlock *getDefaultDest() const {
1253 return cast<BasicBlock>(getOperand(1));
1256 /// getNumCases - return the number of 'cases' in this switch instruction.
1257 /// Note that case #0 is always the default case.
1258 unsigned getNumCases() const {
1259 return getNumOperands()/2;
1262 /// getCaseValue - Return the specified case value. Note that case #0, the
1263 /// default destination, does not have a case value.
1264 ConstantInt *getCaseValue(unsigned i) {
1265 assert(i && i < getNumCases() && "Illegal case value to get!");
1266 return getSuccessorValue(i);
1269 /// getCaseValue - Return the specified case value. Note that case #0, the
1270 /// default destination, does not have a case value.
1271 const ConstantInt *getCaseValue(unsigned i) const {
1272 assert(i && i < getNumCases() && "Illegal case value to get!");
1273 return getSuccessorValue(i);
1276 /// findCaseValue - Search all of the case values for the specified constant.
1277 /// If it is explicitly handled, return the case number of it, otherwise
1278 /// return 0 to indicate that it is handled by the default handler.
1279 unsigned findCaseValue(const ConstantInt *C) const {
1280 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1281 if (getCaseValue(i) == C)
1286 /// addCase - Add an entry to the switch instruction...
1288 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1290 /// removeCase - This method removes the specified successor from the switch
1291 /// instruction. Note that this cannot be used to remove the default
1292 /// destination (successor #0).
1294 void removeCase(unsigned idx);
1296 virtual SwitchInst *clone() const;
1298 unsigned getNumSuccessors() const { return getNumOperands()/2; }
1299 BasicBlock *getSuccessor(unsigned idx) const {
1300 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1301 return cast<BasicBlock>(getOperand(idx*2+1));
1303 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1304 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1305 setOperand(idx*2+1, reinterpret_cast<Value*>(NewSucc));
1308 // getSuccessorValue - Return the value associated with the specified
1310 inline ConstantInt *getSuccessorValue(unsigned idx) const {
1311 assert(idx < getNumSuccessors() && "Successor # out of range!");
1312 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1315 // Methods for support type inquiry through isa, cast, and dyn_cast:
1316 static inline bool classof(const SwitchInst *) { return true; }
1317 static inline bool classof(const Instruction *I) {
1318 return I->getOpcode() == Instruction::Switch;
1320 static inline bool classof(const Value *V) {
1321 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1324 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1325 virtual unsigned getNumSuccessorsV() const;
1326 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1329 //===----------------------------------------------------------------------===//
1331 //===----------------------------------------------------------------------===//
1333 //===---------------------------------------------------------------------------
1335 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
1336 /// calling convention of the call.
1338 class InvokeInst : public TerminatorInst {
1339 InvokeInst(const InvokeInst &BI);
1340 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1341 const std::vector<Value*> &Params);
1343 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1344 const std::vector<Value*> &Params, const std::string &Name = "",
1345 Instruction *InsertBefore = 0);
1346 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1347 const std::vector<Value*> &Params, const std::string &Name,
1348 BasicBlock *InsertAtEnd);
1351 virtual InvokeInst *clone() const;
1353 bool mayWriteToMemory() const { return true; }
1355 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1357 unsigned getCallingConv() const { return SubclassData; }
1358 void setCallingConv(unsigned CC) {
1362 /// getCalledFunction - Return the function called, or null if this is an
1363 /// indirect function invocation.
1365 Function *getCalledFunction() const {
1366 return dyn_cast<Function>(getOperand(0));
1369 // getCalledValue - Get a pointer to a function that is invoked by this inst.
1370 inline Value *getCalledValue() const { return getOperand(0); }
1372 // get*Dest - Return the destination basic blocks...
1373 BasicBlock *getNormalDest() const {
1374 return cast<BasicBlock>(getOperand(1));
1376 BasicBlock *getUnwindDest() const {
1377 return cast<BasicBlock>(getOperand(2));
1379 void setNormalDest(BasicBlock *B) {
1380 setOperand(1, reinterpret_cast<Value*>(B));
1383 void setUnwindDest(BasicBlock *B) {
1384 setOperand(2, reinterpret_cast<Value*>(B));
1387 inline BasicBlock *getSuccessor(unsigned i) const {
1388 assert(i < 2 && "Successor # out of range for invoke!");
1389 return i == 0 ? getNormalDest() : getUnwindDest();
1392 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1393 assert(idx < 2 && "Successor # out of range for invoke!");
1394 setOperand(idx+1, reinterpret_cast<Value*>(NewSucc));
1397 unsigned getNumSuccessors() const { return 2; }
1399 // Methods for support type inquiry through isa, cast, and dyn_cast:
1400 static inline bool classof(const InvokeInst *) { return true; }
1401 static inline bool classof(const Instruction *I) {
1402 return (I->getOpcode() == Instruction::Invoke);
1404 static inline bool classof(const Value *V) {
1405 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1408 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1409 virtual unsigned getNumSuccessorsV() const;
1410 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1414 //===----------------------------------------------------------------------===//
1416 //===----------------------------------------------------------------------===//
1418 //===---------------------------------------------------------------------------
1419 /// UnwindInst - Immediately exit the current function, unwinding the stack
1420 /// until an invoke instruction is found.
1422 class UnwindInst : public TerminatorInst {
1424 UnwindInst(Instruction *InsertBefore = 0)
1425 : TerminatorInst(Instruction::Unwind, 0, 0, InsertBefore) {
1427 UnwindInst(BasicBlock *InsertAtEnd)
1428 : TerminatorInst(Instruction::Unwind, 0, 0, InsertAtEnd) {
1431 virtual UnwindInst *clone() const;
1433 unsigned getNumSuccessors() const { return 0; }
1435 // Methods for support type inquiry through isa, cast, and dyn_cast:
1436 static inline bool classof(const UnwindInst *) { return true; }
1437 static inline bool classof(const Instruction *I) {
1438 return I->getOpcode() == Instruction::Unwind;
1440 static inline bool classof(const Value *V) {
1441 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1444 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1445 virtual unsigned getNumSuccessorsV() const;
1446 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1449 //===----------------------------------------------------------------------===//
1450 // UnreachableInst Class
1451 //===----------------------------------------------------------------------===//
1453 //===---------------------------------------------------------------------------
1454 /// UnreachableInst - This function has undefined behavior. In particular, the
1455 /// presence of this instruction indicates some higher level knowledge that the
1456 /// end of the block cannot be reached.
1458 class UnreachableInst : public TerminatorInst {
1460 UnreachableInst(Instruction *InsertBefore = 0)
1461 : TerminatorInst(Instruction::Unreachable, 0, 0, InsertBefore) {
1463 UnreachableInst(BasicBlock *InsertAtEnd)
1464 : TerminatorInst(Instruction::Unreachable, 0, 0, InsertAtEnd) {
1467 virtual UnreachableInst *clone() const;
1469 unsigned getNumSuccessors() const { return 0; }
1471 // Methods for support type inquiry through isa, cast, and dyn_cast:
1472 static inline bool classof(const UnreachableInst *) { return true; }
1473 static inline bool classof(const Instruction *I) {
1474 return I->getOpcode() == Instruction::Unreachable;
1476 static inline bool classof(const Value *V) {
1477 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1480 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1481 virtual unsigned getNumSuccessorsV() const;
1482 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1485 } // End llvm namespace