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"
27 //===----------------------------------------------------------------------===//
28 // AllocationInst Class
29 //===----------------------------------------------------------------------===//
31 /// AllocationInst - This class is the common base class of MallocInst and
34 class AllocationInst : public Instruction {
36 void init(const Type *Ty, Value *ArraySize, unsigned iTy);
37 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
38 const std::string &Name = "", Instruction *InsertBefore = 0);
39 AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
40 const std::string &Name, BasicBlock *InsertAtEnd);
44 /// isArrayAllocation - Return true if there is an allocation size parameter
45 /// to the allocation instruction that is not 1.
47 bool isArrayAllocation() const;
49 /// getArraySize - Get the number of element allocated, for a simple
50 /// allocation of a single element, this will return a constant 1 value.
52 inline const Value *getArraySize() const { return Operands[0]; }
53 inline Value *getArraySize() { return Operands[0]; }
55 /// getType - Overload to return most specific pointer type
57 inline const PointerType *getType() const {
58 return reinterpret_cast<const PointerType*>(Instruction::getType());
61 /// getAllocatedType - Return the type that is being allocated by the
64 const Type *getAllocatedType() const;
66 virtual Instruction *clone() const = 0;
68 // Methods for support type inquiry through isa, cast, and dyn_cast:
69 static inline bool classof(const AllocationInst *) { return true; }
70 static inline bool classof(const Instruction *I) {
71 return I->getOpcode() == Instruction::Alloca ||
72 I->getOpcode() == Instruction::Malloc;
74 static inline bool classof(const Value *V) {
75 return isa<Instruction>(V) && classof(cast<Instruction>(V));
80 //===----------------------------------------------------------------------===//
82 //===----------------------------------------------------------------------===//
84 /// MallocInst - an instruction to allocated memory on the heap
86 class MallocInst : public AllocationInst {
87 MallocInst(const MallocInst &MI);
89 explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
90 const std::string &Name = "",
91 Instruction *InsertBefore = 0)
92 : AllocationInst(Ty, ArraySize, Malloc, Name, InsertBefore) {}
93 MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
94 BasicBlock *InsertAtEnd)
95 : AllocationInst(Ty, ArraySize, Malloc, Name, InsertAtEnd) {}
97 virtual MallocInst *clone() const;
99 // Methods for support type inquiry through isa, cast, and dyn_cast:
100 static inline bool classof(const MallocInst *) { return true; }
101 static inline bool classof(const Instruction *I) {
102 return (I->getOpcode() == Instruction::Malloc);
104 static inline bool classof(const Value *V) {
105 return isa<Instruction>(V) && classof(cast<Instruction>(V));
110 //===----------------------------------------------------------------------===//
112 //===----------------------------------------------------------------------===//
114 /// AllocaInst - an instruction to allocate memory on the stack
116 class AllocaInst : public AllocationInst {
117 AllocaInst(const AllocaInst &);
119 explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
120 const std::string &Name = "",
121 Instruction *InsertBefore = 0)
122 : AllocationInst(Ty, ArraySize, Alloca, Name, InsertBefore) {}
123 AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
124 BasicBlock *InsertAtEnd)
125 : AllocationInst(Ty, ArraySize, Alloca, Name, InsertAtEnd) {}
127 virtual AllocaInst *clone() const;
129 // Methods for support type inquiry through isa, cast, and dyn_cast:
130 static inline bool classof(const AllocaInst *) { return true; }
131 static inline bool classof(const Instruction *I) {
132 return (I->getOpcode() == Instruction::Alloca);
134 static inline bool classof(const Value *V) {
135 return isa<Instruction>(V) && classof(cast<Instruction>(V));
140 //===----------------------------------------------------------------------===//
142 //===----------------------------------------------------------------------===//
144 /// FreeInst - an instruction to deallocate memory
146 class FreeInst : public Instruction {
147 void init(Value *Ptr);
150 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
151 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
153 virtual FreeInst *clone() const;
155 virtual bool mayWriteToMemory() const { return true; }
157 // Methods for support type inquiry through isa, cast, and dyn_cast:
158 static inline bool classof(const FreeInst *) { return true; }
159 static inline bool classof(const Instruction *I) {
160 return (I->getOpcode() == Instruction::Free);
162 static inline bool classof(const Value *V) {
163 return isa<Instruction>(V) && classof(cast<Instruction>(V));
168 //===----------------------------------------------------------------------===//
170 //===----------------------------------------------------------------------===//
172 /// LoadInst - an instruction for reading from memory
174 class LoadInst : public Instruction {
175 LoadInst(const LoadInst &LI) : Instruction(LI.getType(), Load) {
176 Volatile = LI.isVolatile();
177 init(LI.Operands[0]);
179 bool Volatile; // True if this is a volatile load
180 void init(Value *Ptr);
182 LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
183 LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
184 LoadInst(Value *Ptr, const std::string &Name = "", bool isVolatile = false,
185 Instruction *InsertBefore = 0);
186 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
187 BasicBlock *InsertAtEnd);
189 /// isVolatile - Return true if this is a load from a volatile memory
192 bool isVolatile() const { return Volatile; }
194 /// setVolatile - Specify whether this is a volatile load or not.
196 void setVolatile(bool V) { Volatile = V; }
198 virtual LoadInst *clone() const;
200 virtual bool mayWriteToMemory() const { return isVolatile(); }
202 Value *getPointerOperand() { return getOperand(0); }
203 const Value *getPointerOperand() const { return getOperand(0); }
204 static unsigned getPointerOperandIndex() { return 0U; }
206 // Methods for support type inquiry through isa, cast, and dyn_cast:
207 static inline bool classof(const LoadInst *) { return true; }
208 static inline bool classof(const Instruction *I) {
209 return I->getOpcode() == Instruction::Load;
211 static inline bool classof(const Value *V) {
212 return isa<Instruction>(V) && classof(cast<Instruction>(V));
217 //===----------------------------------------------------------------------===//
219 //===----------------------------------------------------------------------===//
221 /// StoreInst - an instruction for storing to memory
223 class StoreInst : public Instruction {
224 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store) {
225 Volatile = SI.isVolatile();
226 init(SI.Operands[0], SI.Operands[1]);
228 bool Volatile; // True if this is a volatile store
229 void init(Value *Val, Value *Ptr);
231 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
232 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
233 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
234 Instruction *InsertBefore = 0);
235 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
238 /// isVolatile - Return true if this is a load from a volatile memory
241 bool isVolatile() const { return Volatile; }
243 /// setVolatile - Specify whether this is a volatile load or not.
245 void setVolatile(bool V) { Volatile = V; }
247 virtual StoreInst *clone() const;
249 virtual bool mayWriteToMemory() const { return true; }
251 Value *getPointerOperand() { return getOperand(1); }
252 const Value *getPointerOperand() const { return getOperand(1); }
253 static unsigned getPointerOperandIndex() { return 1U; }
255 // Methods for support type inquiry through isa, cast, and dyn_cast:
256 static inline bool classof(const StoreInst *) { return true; }
257 static inline bool classof(const Instruction *I) {
258 return I->getOpcode() == Instruction::Store;
260 static inline bool classof(const Value *V) {
261 return isa<Instruction>(V) && classof(cast<Instruction>(V));
266 //===----------------------------------------------------------------------===//
267 // GetElementPtrInst Class
268 //===----------------------------------------------------------------------===//
270 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
271 /// access elements of arrays and structs
273 class GetElementPtrInst : public Instruction {
274 GetElementPtrInst(const GetElementPtrInst &EPI)
275 : Instruction((static_cast<const Instruction*>(&EPI)->getType()),
277 Operands.reserve(EPI.Operands.size());
278 for (unsigned i = 0, E = (unsigned)EPI.Operands.size(); i != E; ++i)
279 Operands.push_back(Use(EPI.Operands[i], this));
281 void init(Value *Ptr, const std::vector<Value*> &Idx);
282 void init(Value *Ptr, Value *Idx0, Value *Idx1);
284 /// Constructors - Create a getelementptr instruction with a base pointer an
285 /// list of indices. The first ctor can optionally insert before an existing
286 /// instruction, the second appends the new instruction to the specified
288 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
289 const std::string &Name = "", Instruction *InsertBefore =0);
290 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
291 const std::string &Name, BasicBlock *InsertAtEnd);
293 /// Constructors - These two constructors are convenience methods because two
294 /// index getelementptr instructions are so common.
295 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
296 const std::string &Name = "", Instruction *InsertBefore =0);
297 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
298 const std::string &Name, BasicBlock *InsertAtEnd);
300 virtual GetElementPtrInst *clone() const;
302 // getType - Overload to return most specific pointer type...
303 inline const PointerType *getType() const {
304 return reinterpret_cast<const PointerType*>(Instruction::getType());
307 /// getIndexedType - Returns the type of the element that would be loaded with
308 /// a load instruction with the specified parameters.
310 /// A null type is returned if the indices are invalid for the specified
313 static const Type *getIndexedType(const Type *Ptr,
314 const std::vector<Value*> &Indices,
315 bool AllowStructLeaf = false);
316 static const Type *getIndexedType(const Type *Ptr, Value *Idx0, Value *Idx1,
317 bool AllowStructLeaf = false);
319 inline op_iterator idx_begin() { return op_begin()+1; }
320 inline const_op_iterator idx_begin() const { return op_begin()+1; }
321 inline op_iterator idx_end() { return op_end(); }
322 inline const_op_iterator idx_end() const { return op_end(); }
324 Value *getPointerOperand() {
325 return getOperand(0);
327 const Value *getPointerOperand() const {
328 return getOperand(0);
330 static unsigned getPointerOperandIndex() {
331 return 0U; // get index for modifying correct operand
334 inline unsigned getNumIndices() const { // Note: always non-negative
335 return getNumOperands() - 1;
338 inline bool hasIndices() const {
339 return getNumOperands() > 1;
342 // Methods for support type inquiry through isa, cast, and dyn_cast:
343 static inline bool classof(const GetElementPtrInst *) { return true; }
344 static inline bool classof(const Instruction *I) {
345 return (I->getOpcode() == Instruction::GetElementPtr);
347 static inline bool classof(const Value *V) {
348 return isa<Instruction>(V) && classof(cast<Instruction>(V));
352 //===----------------------------------------------------------------------===//
354 //===----------------------------------------------------------------------===//
356 /// SetCondInst class - Represent a setCC operator, where CC is eq, ne, lt, gt,
359 class SetCondInst : public BinaryOperator {
362 SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
363 const std::string &Name = "", Instruction *InsertBefore = 0);
364 SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
365 const std::string &Name, BasicBlock *InsertAtEnd);
367 /// getInverseCondition - Return the inverse of the current condition opcode.
368 /// For example seteq -> setne, setgt -> setle, setlt -> setge, etc...
370 BinaryOps getInverseCondition() const {
371 return getInverseCondition(getOpcode());
374 /// getInverseCondition - Static version that you can use without an
375 /// instruction available.
377 static BinaryOps getInverseCondition(BinaryOps Opcode);
379 /// getSwappedCondition - Return the condition opcode that would be the result
380 /// of exchanging the two operands of the setcc instruction without changing
381 /// the result produced. Thus, seteq->seteq, setle->setge, setlt->setgt, etc.
383 BinaryOps getSwappedCondition() const {
384 return getSwappedCondition(getOpcode());
387 /// getSwappedCondition - Static version that you can use without an
388 /// instruction available.
390 static BinaryOps getSwappedCondition(BinaryOps Opcode);
393 // Methods for support type inquiry through isa, cast, and dyn_cast:
394 static inline bool classof(const SetCondInst *) { return true; }
395 static inline bool classof(const Instruction *I) {
396 return I->getOpcode() == SetEQ || I->getOpcode() == SetNE ||
397 I->getOpcode() == SetLE || I->getOpcode() == SetGE ||
398 I->getOpcode() == SetLT || I->getOpcode() == SetGT;
400 static inline bool classof(const Value *V) {
401 return isa<Instruction>(V) && classof(cast<Instruction>(V));
405 //===----------------------------------------------------------------------===//
407 //===----------------------------------------------------------------------===//
409 /// CastInst - This class represents a cast from Operand[0] to the type of
410 /// the instruction (i->getType()).
412 class CastInst : public Instruction {
413 CastInst(const CastInst &CI) : Instruction(CI.getType(), Cast) {
415 Operands.push_back(Use(CI.Operands[0], this));
417 void init(Value *S) {
419 Operands.push_back(Use(S, this));
422 CastInst(Value *S, const Type *Ty, const std::string &Name = "",
423 Instruction *InsertBefore = 0)
424 : Instruction(Ty, Cast, Name, InsertBefore) {
427 CastInst(Value *S, const Type *Ty, const std::string &Name,
428 BasicBlock *InsertAtEnd)
429 : Instruction(Ty, Cast, Name, InsertAtEnd) {
433 virtual CastInst *clone() const;
435 // Methods for support type inquiry through isa, cast, and dyn_cast:
436 static inline bool classof(const CastInst *) { return true; }
437 static inline bool classof(const Instruction *I) {
438 return I->getOpcode() == Cast;
440 static inline bool classof(const Value *V) {
441 return isa<Instruction>(V) && classof(cast<Instruction>(V));
446 //===----------------------------------------------------------------------===//
448 //===----------------------------------------------------------------------===//
450 /// CallInst - This class represents a function call, abstracting a target
451 /// machine's calling convention.
453 class CallInst : public Instruction {
454 CallInst(const CallInst &CI);
455 void init(Value *Func, const std::vector<Value*> &Params);
456 void init(Value *Func, Value *Actual1, Value *Actual2);
457 void init(Value *Func, Value *Actual);
458 void init(Value *Func);
461 CallInst(Value *F, const std::vector<Value*> &Par,
462 const std::string &Name = "", Instruction *InsertBefore = 0);
463 CallInst(Value *F, const std::vector<Value*> &Par,
464 const std::string &Name, BasicBlock *InsertAtEnd);
466 // Alternate CallInst ctors w/ two actuals, w/ one actual and no
467 // actuals, respectively.
468 CallInst(Value *F, Value *Actual1, Value *Actual2,
469 const std::string& Name = "", Instruction *InsertBefore = 0);
470 CallInst(Value *F, Value *Actual1, Value *Actual2,
471 const std::string& Name, BasicBlock *InsertAtEnd);
472 CallInst(Value *F, Value *Actual, const std::string& Name = "",
473 Instruction *InsertBefore = 0);
474 CallInst(Value *F, Value *Actual, const std::string& Name,
475 BasicBlock *InsertAtEnd);
476 explicit CallInst(Value *F, const std::string &Name = "",
477 Instruction *InsertBefore = 0);
478 explicit CallInst(Value *F, const std::string &Name,
479 BasicBlock *InsertAtEnd);
481 virtual CallInst *clone() const;
482 bool mayWriteToMemory() const { return true; }
484 // FIXME: These methods should be inline once we eliminate
485 // ConstantPointerRefs!
486 const Function *getCalledFunction() const;
487 Function *getCalledFunction();
489 // getCalledValue - Get a pointer to a method that is invoked by this inst.
490 inline const Value *getCalledValue() const { return Operands[0]; }
491 inline Value *getCalledValue() { return Operands[0]; }
493 // Methods for support type inquiry through isa, cast, and dyn_cast:
494 static inline bool classof(const CallInst *) { return true; }
495 static inline bool classof(const Instruction *I) {
496 return I->getOpcode() == Instruction::Call;
498 static inline bool classof(const Value *V) {
499 return isa<Instruction>(V) && classof(cast<Instruction>(V));
504 //===----------------------------------------------------------------------===//
506 //===----------------------------------------------------------------------===//
508 /// ShiftInst - This class represents left and right shift instructions.
510 class ShiftInst : public Instruction {
511 ShiftInst(const ShiftInst &SI) : Instruction(SI.getType(), SI.getOpcode()) {
513 Operands.push_back(Use(SI.Operands[0], this));
514 Operands.push_back(Use(SI.Operands[1], this));
516 void init(OtherOps Opcode, Value *S, Value *SA) {
517 assert((Opcode == Shl || Opcode == Shr) && "ShiftInst Opcode invalid!");
519 Operands.push_back(Use(S, this));
520 Operands.push_back(Use(SA, this));
524 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name = "",
525 Instruction *InsertBefore = 0)
526 : Instruction(S->getType(), Opcode, Name, InsertBefore) {
529 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name,
530 BasicBlock *InsertAtEnd)
531 : Instruction(S->getType(), Opcode, Name, InsertAtEnd) {
535 OtherOps getOpcode() const {
536 return static_cast<OtherOps>(Instruction::getOpcode());
539 virtual ShiftInst *clone() const;
541 // Methods for support type inquiry through isa, cast, and dyn_cast:
542 static inline bool classof(const ShiftInst *) { return true; }
543 static inline bool classof(const Instruction *I) {
544 return (I->getOpcode() == Instruction::Shr) |
545 (I->getOpcode() == Instruction::Shl);
547 static inline bool classof(const Value *V) {
548 return isa<Instruction>(V) && classof(cast<Instruction>(V));
552 //===----------------------------------------------------------------------===//
554 //===----------------------------------------------------------------------===//
556 /// SelectInst - This class represents the LLVM 'select' instruction.
558 class SelectInst : public Instruction {
559 SelectInst(const SelectInst &SI) : Instruction(SI.getType(), SI.getOpcode()) {
561 Operands.push_back(Use(SI.Operands[0], this));
562 Operands.push_back(Use(SI.Operands[1], this));
563 Operands.push_back(Use(SI.Operands[2], this));
565 void init(Value *C, Value *S1, Value *S2) {
567 Operands.push_back(Use(C, this));
568 Operands.push_back(Use(S1, this));
569 Operands.push_back(Use(S2, this));
573 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
574 Instruction *InsertBefore = 0)
575 : Instruction(S1->getType(), Instruction::Select, Name, InsertBefore) {
578 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
579 BasicBlock *InsertAtEnd)
580 : Instruction(S1->getType(), Instruction::Select, Name, InsertAtEnd) {
584 Value *getCondition() const { return Operands[0]; }
585 Value *getTrueValue() const { return Operands[1]; }
586 Value *getFalseValue() const { return Operands[2]; }
588 OtherOps getOpcode() const {
589 return static_cast<OtherOps>(Instruction::getOpcode());
592 virtual SelectInst *clone() const;
594 // Methods for support type inquiry through isa, cast, and dyn_cast:
595 static inline bool classof(const SelectInst *) { return true; }
596 static inline bool classof(const Instruction *I) {
597 return I->getOpcode() == Instruction::Select;
599 static inline bool classof(const Value *V) {
600 return isa<Instruction>(V) && classof(cast<Instruction>(V));
605 //===----------------------------------------------------------------------===//
607 //===----------------------------------------------------------------------===//
609 /// VANextInst - This class represents the va_next llvm instruction, which
610 /// advances a vararg list passed an argument of the specified type, returning
611 /// the resultant list.
613 class VANextInst : public Instruction {
615 void init(Value *List) {
617 Operands.push_back(Use(List, this));
619 VANextInst(const VANextInst &VAN)
620 : Instruction(VAN.getType(), VANext), ArgTy(VAN.getArgType()) {
621 init(VAN.Operands[0]);
625 VANextInst(Value *List, const Type *Ty, const std::string &Name = "",
626 Instruction *InsertBefore = 0)
627 : Instruction(List->getType(), VANext, Name, InsertBefore), ArgTy(Ty) {
630 VANextInst(Value *List, const Type *Ty, const std::string &Name,
631 BasicBlock *InsertAtEnd)
632 : Instruction(List->getType(), VANext, Name, InsertAtEnd), ArgTy(Ty) {
636 const Type *getArgType() const { return ArgTy; }
638 virtual VANextInst *clone() const;
640 // Methods for support type inquiry through isa, cast, and dyn_cast:
641 static inline bool classof(const VANextInst *) { return true; }
642 static inline bool classof(const Instruction *I) {
643 return I->getOpcode() == VANext;
645 static inline bool classof(const Value *V) {
646 return isa<Instruction>(V) && classof(cast<Instruction>(V));
651 //===----------------------------------------------------------------------===//
653 //===----------------------------------------------------------------------===//
655 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
656 /// an argument of the specified type given a va_list.
658 class VAArgInst : public Instruction {
659 void init(Value* List) {
661 Operands.push_back(Use(List, this));
663 VAArgInst(const VAArgInst &VAA)
664 : Instruction(VAA.getType(), VAArg) {
665 init(VAA.Operands[0]);
668 VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
669 Instruction *InsertBefore = 0)
670 : Instruction(Ty, VAArg, Name, InsertBefore) {
673 VAArgInst(Value *List, const Type *Ty, const std::string &Name,
674 BasicBlock *InsertAtEnd)
675 : Instruction(Ty, VAArg, Name, InsertAtEnd) {
679 virtual VAArgInst *clone() const;
681 // Methods for support type inquiry through isa, cast, and dyn_cast:
682 static inline bool classof(const VAArgInst *) { return true; }
683 static inline bool classof(const Instruction *I) {
684 return I->getOpcode() == VAArg;
686 static inline bool classof(const Value *V) {
687 return isa<Instruction>(V) && classof(cast<Instruction>(V));
691 //===----------------------------------------------------------------------===//
693 //===----------------------------------------------------------------------===//
695 // PHINode - The PHINode class is used to represent the magical mystical PHI
696 // node, that can not exist in nature, but can be synthesized in a computer
697 // scientist's overactive imagination.
699 class PHINode : public Instruction {
700 PHINode(const PHINode &PN);
702 PHINode(const Type *Ty, const std::string &Name = "",
703 Instruction *InsertBefore = 0)
704 : Instruction(Ty, Instruction::PHI, Name, InsertBefore) {
707 PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
708 : Instruction(Ty, Instruction::PHI, Name, InsertAtEnd) {
711 virtual PHINode *clone() const;
713 /// getNumIncomingValues - Return the number of incoming edges
715 unsigned getNumIncomingValues() const { return (unsigned)Operands.size()/2; }
717 /// getIncomingValue - Return incoming value #x
719 Value *getIncomingValue(unsigned i) const {
720 assert(i*2 < Operands.size() && "Invalid value number!");
721 return Operands[i*2];
723 void setIncomingValue(unsigned i, Value *V) {
724 assert(i*2 < Operands.size() && "Invalid value number!");
727 inline unsigned getOperandNumForIncomingValue(unsigned i) {
731 /// getIncomingBlock - Return incoming basic block #x
733 BasicBlock *getIncomingBlock(unsigned i) const {
734 assert(i*2+1 < Operands.size() && "Invalid value number!");
735 return reinterpret_cast<BasicBlock*>(Operands[i*2+1].get());
737 void setIncomingBlock(unsigned i, BasicBlock *BB) {
738 assert(i*2+1 < Operands.size() && "Invalid value number!");
739 Operands[i*2+1] = reinterpret_cast<Value*>(BB);
741 unsigned getOperandNumForIncomingBlock(unsigned i) {
745 /// addIncoming - Add an incoming value to the end of the PHI list
747 void addIncoming(Value *V, BasicBlock *BB) {
748 assert(getType() == V->getType() &&
749 "All operands to PHI node must be the same type as the PHI node!");
750 Operands.push_back(Use(V, this));
751 Operands.push_back(Use(reinterpret_cast<Value*>(BB), this));
754 /// removeIncomingValue - Remove an incoming value. This is useful if a
755 /// predecessor basic block is deleted. The value removed is returned.
757 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
758 /// is true), the PHI node is destroyed and any uses of it are replaced with
759 /// dummy values. The only time there should be zero incoming values to a PHI
760 /// node is when the block is dead, so this strategy is sound.
762 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
764 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
765 int Idx = getBasicBlockIndex(BB);
766 assert(Idx >= 0 && "Invalid basic block argument to remove!");
767 return removeIncomingValue(Idx, DeletePHIIfEmpty);
770 /// getBasicBlockIndex - Return the first index of the specified basic
771 /// block in the value list for this PHI. Returns -1 if no instance.
773 int getBasicBlockIndex(const BasicBlock *BB) const {
774 for (unsigned i = 0; i < Operands.size()/2; ++i)
775 if (getIncomingBlock(i) == BB) return i;
779 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
780 return getIncomingValue(getBasicBlockIndex(BB));
783 /// Methods for support type inquiry through isa, cast, and dyn_cast:
784 static inline bool classof(const PHINode *) { return true; }
785 static inline bool classof(const Instruction *I) {
786 return I->getOpcode() == Instruction::PHI;
788 static inline bool classof(const Value *V) {
789 return isa<Instruction>(V) && classof(cast<Instruction>(V));
793 //===----------------------------------------------------------------------===//
795 //===----------------------------------------------------------------------===//
797 //===---------------------------------------------------------------------------
798 /// ReturnInst - Return a value (possibly void), from a function. Execution
799 /// does not continue in this function any longer.
801 class ReturnInst : public TerminatorInst {
802 ReturnInst(const ReturnInst &RI) : TerminatorInst(Instruction::Ret) {
803 if (RI.Operands.size()) {
804 assert(RI.Operands.size() == 1 && "Return insn can only have 1 operand!");
806 Operands.push_back(Use(RI.Operands[0], this));
810 void init(Value *RetVal) {
812 assert(!isa<BasicBlock>(RetVal) &&
813 "Cannot return basic block. Probably using the incorrect ctor");
815 Operands.push_back(Use(RetVal, this));
820 // ReturnInst constructors:
821 // ReturnInst() - 'ret void' instruction
822 // ReturnInst(Value* X) - 'ret X' instruction
823 // ReturnInst( null, Inst *) - 'ret void' instruction, insert before I
824 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
825 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of BB
826 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of BB
827 ReturnInst(Value *RetVal = 0, Instruction *InsertBefore = 0)
828 : TerminatorInst(Instruction::Ret, InsertBefore) {
831 ReturnInst(Value *RetVal, BasicBlock *InsertAtEnd)
832 : TerminatorInst(Instruction::Ret, InsertAtEnd) {
835 ReturnInst(BasicBlock *InsertAtEnd)
836 : TerminatorInst(Instruction::Ret, InsertAtEnd) {
839 virtual ReturnInst *clone() const;
841 inline const Value *getReturnValue() const {
842 return Operands.size() ? Operands[0].get() : 0;
844 inline Value *getReturnValue() {
845 return Operands.size() ? Operands[0].get() : 0;
848 virtual const BasicBlock *getSuccessor(unsigned idx) const {
849 assert(0 && "ReturnInst has no successors!");
853 virtual void setSuccessor(unsigned idx, BasicBlock *NewSucc);
854 virtual unsigned getNumSuccessors() const { return 0; }
856 // Methods for support type inquiry through isa, cast, and dyn_cast:
857 static inline bool classof(const ReturnInst *) { return true; }
858 static inline bool classof(const Instruction *I) {
859 return (I->getOpcode() == Instruction::Ret);
861 static inline bool classof(const Value *V) {
862 return isa<Instruction>(V) && classof(cast<Instruction>(V));
866 //===----------------------------------------------------------------------===//
868 //===----------------------------------------------------------------------===//
870 //===---------------------------------------------------------------------------
871 /// BranchInst - Conditional or Unconditional Branch instruction.
873 class BranchInst : public TerminatorInst {
874 BranchInst(const BranchInst &BI);
875 void init(BasicBlock *IfTrue);
876 void init(BasicBlock *True, BasicBlock *False, Value *Cond);
878 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
879 // BranchInst(BB *B) - 'br B'
880 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
881 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
882 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
883 // BranchInst(BB* B, BB *I) - 'br B' insert at end
884 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
885 BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0)
886 : TerminatorInst(Instruction::Br, InsertBefore) {
889 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
890 Instruction *InsertBefore = 0)
891 : TerminatorInst(Instruction::Br, InsertBefore) {
892 init(IfTrue, IfFalse, Cond);
895 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
896 : TerminatorInst(Instruction::Br, InsertAtEnd) {
900 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
901 BasicBlock *InsertAtEnd)
902 : TerminatorInst(Instruction::Br, InsertAtEnd) {
903 init(IfTrue, IfFalse, Cond);
906 virtual BranchInst *clone() const;
908 inline bool isUnconditional() const { return Operands.size() == 1; }
909 inline bool isConditional() const { return Operands.size() == 3; }
911 inline Value *getCondition() const {
912 assert(isConditional() && "Cannot get condition of an uncond branch!");
913 return Operands[2].get();
916 void setCondition(Value *V) {
917 assert(isConditional() && "Cannot set condition of unconditional branch!");
921 // setUnconditionalDest - Change the current branch to an unconditional branch
922 // targeting the specified block.
924 void setUnconditionalDest(BasicBlock *Dest) {
925 if (isConditional()) Operands.erase(Operands.begin()+1, Operands.end());
926 Operands[0] = reinterpret_cast<Value*>(Dest);
929 virtual const BasicBlock *getSuccessor(unsigned i) const {
930 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
931 return (i == 0) ? cast<BasicBlock>(Operands[0].get()) :
932 cast<BasicBlock>(Operands[1].get());
934 inline BasicBlock *getSuccessor(unsigned idx) {
935 const BranchInst *BI = this;
936 return const_cast<BasicBlock*>(BI->getSuccessor(idx));
939 virtual void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
940 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
941 Operands[idx] = reinterpret_cast<Value*>(NewSucc);
944 virtual unsigned getNumSuccessors() const { return 1+isConditional(); }
946 // Methods for support type inquiry through isa, cast, and dyn_cast:
947 static inline bool classof(const BranchInst *) { return true; }
948 static inline bool classof(const Instruction *I) {
949 return (I->getOpcode() == Instruction::Br);
951 static inline bool classof(const Value *V) {
952 return isa<Instruction>(V) && classof(cast<Instruction>(V));
956 //===----------------------------------------------------------------------===//
958 //===----------------------------------------------------------------------===//
960 //===---------------------------------------------------------------------------
961 /// SwitchInst - Multiway switch
963 class SwitchInst : public TerminatorInst {
964 // Operand[0] = Value to switch on
965 // Operand[1] = Default basic block destination
966 // Operand[2n ] = Value to match
967 // Operand[2n+1] = BasicBlock to go to on match
968 SwitchInst(const SwitchInst &RI);
969 void init(Value *Value, BasicBlock *Default);
972 SwitchInst(Value *Value, BasicBlock *Default, Instruction *InsertBefore = 0)
973 : TerminatorInst(Instruction::Switch, InsertBefore) {
974 init(Value, Default);
976 SwitchInst(Value *Value, BasicBlock *Default, BasicBlock *InsertAtEnd)
977 : TerminatorInst(Instruction::Switch, InsertAtEnd) {
978 init(Value, Default);
981 virtual SwitchInst *clone() const;
983 // Accessor Methods for Switch stmt
985 inline const Value *getCondition() const { return Operands[0]; }
986 inline Value *getCondition() { return Operands[0]; }
987 inline const BasicBlock *getDefaultDest() const {
988 return cast<BasicBlock>(Operands[1].get());
990 inline BasicBlock *getDefaultDest() {
991 return cast<BasicBlock>(Operands[1].get());
994 /// getNumCases - return the number of 'cases' in this switch instruction.
995 /// Note that case #0 is always the default case.
996 unsigned getNumCases() const {
997 return (unsigned)Operands.size()/2;
1000 /// getCaseValue - Return the specified case value. Note that case #0, the
1001 /// default destination, does not have a case value.
1002 Constant *getCaseValue(unsigned i) {
1003 assert(i && i < getNumCases() && "Illegal case value to get!");
1004 return getSuccessorValue(i);
1007 /// getCaseValue - Return the specified case value. Note that case #0, the
1008 /// default destination, does not have a case value.
1009 const Constant *getCaseValue(unsigned i) const {
1010 assert(i && i < getNumCases() && "Illegal case value to get!");
1011 return getSuccessorValue(i);
1014 /// findCaseValue - Search all of the case values for the specified constant.
1015 /// If it is explicitly handled, return the case number of it, otherwise
1016 /// return 0 to indicate that it is handled by the default handler.
1017 unsigned findCaseValue(const Constant *C) const {
1018 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1019 if (getCaseValue(i) == C)
1024 /// addCase - Add an entry to the switch instruction...
1026 void addCase(Constant *OnVal, BasicBlock *Dest);
1028 /// removeCase - This method removes the specified successor from the switch
1029 /// instruction. Note that this cannot be used to remove the default
1030 /// destination (successor #0).
1032 void removeCase(unsigned idx);
1034 virtual const BasicBlock *getSuccessor(unsigned idx) const {
1035 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1036 return cast<BasicBlock>(Operands[idx*2+1].get());
1038 inline BasicBlock *getSuccessor(unsigned idx) {
1039 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1040 return cast<BasicBlock>(Operands[idx*2+1].get());
1043 virtual void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1044 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1045 Operands[idx*2+1] = reinterpret_cast<Value*>(NewSucc);
1048 // getSuccessorValue - Return the value associated with the specified
1050 inline const Constant *getSuccessorValue(unsigned idx) const {
1051 assert(idx < getNumSuccessors() && "Successor # out of range!");
1052 return cast<Constant>(Operands[idx*2].get());
1054 inline Constant *getSuccessorValue(unsigned idx) {
1055 assert(idx < getNumSuccessors() && "Successor # out of range!");
1056 return cast<Constant>(Operands[idx*2].get());
1058 virtual unsigned getNumSuccessors() const { return (unsigned)Operands.size()/2; }
1060 // Methods for support type inquiry through isa, cast, and dyn_cast:
1061 static inline bool classof(const SwitchInst *) { return true; }
1062 static inline bool classof(const Instruction *I) {
1063 return (I->getOpcode() == Instruction::Switch);
1065 static inline bool classof(const Value *V) {
1066 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1070 //===----------------------------------------------------------------------===//
1072 //===----------------------------------------------------------------------===//
1074 //===---------------------------------------------------------------------------
1075 /// InvokeInst - Invoke instruction
1077 class InvokeInst : public TerminatorInst {
1078 InvokeInst(const InvokeInst &BI);
1079 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1080 const std::vector<Value*> &Params);
1082 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1083 const std::vector<Value*> &Params, const std::string &Name = "",
1084 Instruction *InsertBefore = 0);
1085 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1086 const std::vector<Value*> &Params, const std::string &Name,
1087 BasicBlock *InsertAtEnd);
1089 virtual InvokeInst *clone() const;
1091 bool mayWriteToMemory() const { return true; }
1093 /// getCalledFunction - Return the function called, or null if this is an
1094 /// indirect function invocation...
1096 /// FIXME: These should be inlined once we get rid of ConstantPointerRefs!
1098 const Function *getCalledFunction() const;
1099 Function *getCalledFunction();
1101 // getCalledValue - Get a pointer to a function that is invoked by this inst.
1102 inline const Value *getCalledValue() const { return Operands[0]; }
1103 inline Value *getCalledValue() { return Operands[0]; }
1105 // get*Dest - Return the destination basic blocks...
1106 inline const BasicBlock *getNormalDest() const {
1107 return cast<BasicBlock>(Operands[1].get());
1109 inline BasicBlock *getNormalDest() {
1110 return cast<BasicBlock>(Operands[1].get());
1112 inline const BasicBlock *getUnwindDest() const {
1113 return cast<BasicBlock>(Operands[2].get());
1115 inline BasicBlock *getUnwindDest() {
1116 return cast<BasicBlock>(Operands[2].get());
1119 inline void setNormalDest(BasicBlock *B){
1120 Operands[1] = reinterpret_cast<Value*>(B);
1123 inline void setUnwindDest(BasicBlock *B){
1124 Operands[2] = reinterpret_cast<Value*>(B);
1127 virtual const BasicBlock *getSuccessor(unsigned i) const {
1128 assert(i < 2 && "Successor # out of range for invoke!");
1129 return i == 0 ? getNormalDest() : getUnwindDest();
1131 inline BasicBlock *getSuccessor(unsigned i) {
1132 assert(i < 2 && "Successor # out of range for invoke!");
1133 return i == 0 ? getNormalDest() : getUnwindDest();
1136 virtual void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1137 assert(idx < 2 && "Successor # out of range for invoke!");
1138 Operands[idx+1] = reinterpret_cast<Value*>(NewSucc);
1141 virtual unsigned getNumSuccessors() const { return 2; }
1143 // Methods for support type inquiry through isa, cast, and dyn_cast:
1144 static inline bool classof(const InvokeInst *) { return true; }
1145 static inline bool classof(const Instruction *I) {
1146 return (I->getOpcode() == Instruction::Invoke);
1148 static inline bool classof(const Value *V) {
1149 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1154 //===----------------------------------------------------------------------===//
1156 //===----------------------------------------------------------------------===//
1158 //===---------------------------------------------------------------------------
1159 /// UnwindInst - Immediately exit the current function, unwinding the stack
1160 /// until an invoke instruction is found.
1162 class UnwindInst : public TerminatorInst {
1164 UnwindInst(Instruction *InsertBefore = 0)
1165 : TerminatorInst(Instruction::Unwind, InsertBefore) {
1167 UnwindInst(BasicBlock *InsertAtEnd)
1168 : TerminatorInst(Instruction::Unwind, InsertAtEnd) {
1171 virtual UnwindInst *clone() const;
1173 virtual const BasicBlock *getSuccessor(unsigned idx) const {
1174 assert(0 && "UnwindInst has no successors!");
1178 virtual void setSuccessor(unsigned idx, BasicBlock *NewSucc);
1179 virtual unsigned getNumSuccessors() const { return 0; }
1181 // Methods for support type inquiry through isa, cast, and dyn_cast:
1182 static inline bool classof(const UnwindInst *) { return true; }
1183 static inline bool classof(const Instruction *I) {
1184 return I->getOpcode() == Instruction::Unwind;
1186 static inline bool classof(const Value *V) {
1187 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1191 //===----------------------------------------------------------------------===//
1192 // UnreachableInst Class
1193 //===----------------------------------------------------------------------===//
1195 //===---------------------------------------------------------------------------
1196 /// UnreachableInst - This function has undefined behavior. In particular, the
1197 /// presence of this instruction indicates some higher level knowledge that the
1198 /// end of the block cannot be reached.
1200 class UnreachableInst : public TerminatorInst {
1202 UnreachableInst(Instruction *InsertBefore = 0)
1203 : TerminatorInst(Instruction::Unreachable, InsertBefore) {
1205 UnreachableInst(BasicBlock *InsertAtEnd)
1206 : TerminatorInst(Instruction::Unreachable, InsertAtEnd) {
1209 virtual UnreachableInst *clone() const;
1211 virtual const BasicBlock *getSuccessor(unsigned idx) const {
1212 assert(0 && "UnreachableInst has no successors!");
1216 virtual void setSuccessor(unsigned idx, BasicBlock *NewSucc);
1217 virtual unsigned getNumSuccessors() const { return 0; }
1219 // Methods for support type inquiry through isa, cast, and dyn_cast:
1220 static inline bool classof(const UnreachableInst *) { return true; }
1221 static inline bool classof(const Instruction *I) {
1222 return I->getOpcode() == Instruction::Unreachable;
1224 static inline bool classof(const Value *V) {
1225 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1229 } // End llvm namespace