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"
28 //===----------------------------------------------------------------------===//
29 // AllocationInst Class
30 //===----------------------------------------------------------------------===//
32 /// AllocationInst - This class is the common base class of MallocInst and
35 class AllocationInst : public UnaryInstruction {
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 getOperand(0); }
53 inline Value *getArraySize() { return getOperand(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 UnaryInstruction {
149 explicit FreeInst(Value *Ptr, Instruction *InsertBefore = 0);
150 FreeInst(Value *Ptr, BasicBlock *InsertAfter);
152 virtual FreeInst *clone() const;
154 virtual bool mayWriteToMemory() const { return true; }
156 // Methods for support type inquiry through isa, cast, and dyn_cast:
157 static inline bool classof(const FreeInst *) { return true; }
158 static inline bool classof(const Instruction *I) {
159 return (I->getOpcode() == Instruction::Free);
161 static inline bool classof(const Value *V) {
162 return isa<Instruction>(V) && classof(cast<Instruction>(V));
167 //===----------------------------------------------------------------------===//
169 //===----------------------------------------------------------------------===//
171 /// LoadInst - an instruction for reading from memory. This uses the
172 /// SubclassData field in Value to store whether or not the load is volatile.
174 class LoadInst : public UnaryInstruction {
175 LoadInst(const LoadInst &LI)
176 : UnaryInstruction(LI.getType(), Load, LI.getOperand(0)) {
177 setVolatile(LI.isVolatile());
185 LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
186 LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
187 LoadInst(Value *Ptr, const std::string &Name = "", bool isVolatile = false,
188 Instruction *InsertBefore = 0);
189 LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
190 BasicBlock *InsertAtEnd);
192 /// isVolatile - Return true if this is a load from a volatile memory
195 bool isVolatile() const { return SubclassData; }
197 /// setVolatile - Specify whether this is a volatile load or not.
199 void setVolatile(bool V) { SubclassData = V; }
201 virtual LoadInst *clone() const;
203 virtual bool mayWriteToMemory() const { return isVolatile(); }
205 Value *getPointerOperand() { return getOperand(0); }
206 const Value *getPointerOperand() const { return getOperand(0); }
207 static unsigned getPointerOperandIndex() { return 0U; }
209 // Methods for support type inquiry through isa, cast, and dyn_cast:
210 static inline bool classof(const LoadInst *) { return true; }
211 static inline bool classof(const Instruction *I) {
212 return I->getOpcode() == Instruction::Load;
214 static inline bool classof(const Value *V) {
215 return isa<Instruction>(V) && classof(cast<Instruction>(V));
220 //===----------------------------------------------------------------------===//
222 //===----------------------------------------------------------------------===//
224 /// StoreInst - an instruction for storing to memory
226 class StoreInst : public Instruction {
228 StoreInst(const StoreInst &SI) : Instruction(SI.getType(), Store, Ops, 2) {
229 Ops[0].init(SI.Ops[0], this);
230 Ops[1].init(SI.Ops[1], this);
231 setVolatile(SI.isVolatile());
238 StoreInst(Value *Val, Value *Ptr, Instruction *InsertBefore);
239 StoreInst(Value *Val, Value *Ptr, BasicBlock *InsertAtEnd);
240 StoreInst(Value *Val, Value *Ptr, bool isVolatile = false,
241 Instruction *InsertBefore = 0);
242 StoreInst(Value *Val, Value *Ptr, bool isVolatile, BasicBlock *InsertAtEnd);
245 /// isVolatile - Return true if this is a load from a volatile memory
248 bool isVolatile() const { return SubclassData; }
250 /// setVolatile - Specify whether this is a volatile load or not.
252 void setVolatile(bool V) { SubclassData = V; }
254 /// Transparently provide more efficient getOperand methods.
255 Value *getOperand(unsigned i) const {
256 assert(i < 2 && "getOperand() out of range!");
259 void setOperand(unsigned i, Value *Val) {
260 assert(i < 2 && "setOperand() out of range!");
263 unsigned getNumOperands() const { return 2; }
266 virtual StoreInst *clone() const;
268 virtual bool mayWriteToMemory() const { return true; }
270 Value *getPointerOperand() { return getOperand(1); }
271 const Value *getPointerOperand() const { return getOperand(1); }
272 static unsigned getPointerOperandIndex() { return 1U; }
274 // Methods for support type inquiry through isa, cast, and dyn_cast:
275 static inline bool classof(const StoreInst *) { return true; }
276 static inline bool classof(const Instruction *I) {
277 return I->getOpcode() == Instruction::Store;
279 static inline bool classof(const Value *V) {
280 return isa<Instruction>(V) && classof(cast<Instruction>(V));
285 //===----------------------------------------------------------------------===//
286 // GetElementPtrInst Class
287 //===----------------------------------------------------------------------===//
289 /// GetElementPtrInst - an instruction for type-safe pointer arithmetic to
290 /// access elements of arrays and structs
292 class GetElementPtrInst : public Instruction {
293 GetElementPtrInst(const GetElementPtrInst &GEPI)
294 : Instruction(reinterpret_cast<const Type*>(GEPI.getType()), GetElementPtr,
295 0, GEPI.getNumOperands()) {
296 Use *OL = OperandList = new Use[NumOperands];
297 Use *GEPIOL = GEPI.OperandList;
298 for (unsigned i = 0, E = NumOperands; i != E; ++i)
299 OL[i].init(GEPIOL[i], this);
301 void init(Value *Ptr, const std::vector<Value*> &Idx);
302 void init(Value *Ptr, Value *Idx0, Value *Idx1);
303 void init(Value *Ptr, Value *Idx);
305 /// Constructors - Create a getelementptr instruction with a base pointer an
306 /// list of indices. The first ctor can optionally insert before an existing
307 /// instruction, the second appends the new instruction to the specified
309 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
310 const std::string &Name = "", Instruction *InsertBefore =0);
311 GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
312 const std::string &Name, BasicBlock *InsertAtEnd);
314 /// Constructors - These two constructors are convenience methods because one
315 /// and two index getelementptr instructions are so common.
316 GetElementPtrInst(Value *Ptr, Value *Idx,
317 const std::string &Name = "", Instruction *InsertBefore =0);
318 GetElementPtrInst(Value *Ptr, Value *Idx,
319 const std::string &Name, BasicBlock *InsertAtEnd);
320 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
321 const std::string &Name = "", Instruction *InsertBefore =0);
322 GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
323 const std::string &Name, BasicBlock *InsertAtEnd);
324 ~GetElementPtrInst();
326 virtual GetElementPtrInst *clone() const;
328 // getType - Overload to return most specific pointer type...
329 inline const PointerType *getType() const {
330 return reinterpret_cast<const PointerType*>(Instruction::getType());
333 /// getIndexedType - Returns the type of the element that would be loaded with
334 /// a load instruction with the specified parameters.
336 /// A null type is returned if the indices are invalid for the specified
339 static const Type *getIndexedType(const Type *Ptr,
340 const std::vector<Value*> &Indices,
341 bool AllowStructLeaf = false);
342 static const Type *getIndexedType(const Type *Ptr, Value *Idx0, Value *Idx1,
343 bool AllowStructLeaf = false);
344 static const Type *getIndexedType(const Type *Ptr, Value *Idx);
346 inline op_iterator idx_begin() { return op_begin()+1; }
347 inline const_op_iterator idx_begin() const { return op_begin()+1; }
348 inline op_iterator idx_end() { return op_end(); }
349 inline const_op_iterator idx_end() const { return op_end(); }
351 Value *getPointerOperand() {
352 return getOperand(0);
354 const Value *getPointerOperand() const {
355 return getOperand(0);
357 static unsigned getPointerOperandIndex() {
358 return 0U; // get index for modifying correct operand
361 inline unsigned getNumIndices() const { // Note: always non-negative
362 return getNumOperands() - 1;
365 inline bool hasIndices() const {
366 return getNumOperands() > 1;
369 // Methods for support type inquiry through isa, cast, and dyn_cast:
370 static inline bool classof(const GetElementPtrInst *) { return true; }
371 static inline bool classof(const Instruction *I) {
372 return (I->getOpcode() == Instruction::GetElementPtr);
374 static inline bool classof(const Value *V) {
375 return isa<Instruction>(V) && classof(cast<Instruction>(V));
379 //===----------------------------------------------------------------------===//
381 //===----------------------------------------------------------------------===//
383 /// SetCondInst class - Represent a setCC operator, where CC is eq, ne, lt, gt,
386 class SetCondInst : public BinaryOperator {
388 SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
389 const std::string &Name = "", Instruction *InsertBefore = 0);
390 SetCondInst(BinaryOps Opcode, Value *LHS, Value *RHS,
391 const std::string &Name, BasicBlock *InsertAtEnd);
393 /// getInverseCondition - Return the inverse of the current condition opcode.
394 /// For example seteq -> setne, setgt -> setle, setlt -> setge, etc...
396 BinaryOps getInverseCondition() const {
397 return getInverseCondition(getOpcode());
400 /// getInverseCondition - Static version that you can use without an
401 /// instruction available.
403 static BinaryOps getInverseCondition(BinaryOps Opcode);
405 /// getSwappedCondition - Return the condition opcode that would be the result
406 /// of exchanging the two operands of the setcc instruction without changing
407 /// the result produced. Thus, seteq->seteq, setle->setge, setlt->setgt, etc.
409 BinaryOps getSwappedCondition() const {
410 return getSwappedCondition(getOpcode());
413 /// getSwappedCondition - Static version that you can use without an
414 /// instruction available.
416 static BinaryOps getSwappedCondition(BinaryOps Opcode);
419 // Methods for support type inquiry through isa, cast, and dyn_cast:
420 static inline bool classof(const SetCondInst *) { return true; }
421 static inline bool classof(const Instruction *I) {
422 return I->getOpcode() == SetEQ || I->getOpcode() == SetNE ||
423 I->getOpcode() == SetLE || I->getOpcode() == SetGE ||
424 I->getOpcode() == SetLT || I->getOpcode() == SetGT;
426 static inline bool classof(const Value *V) {
427 return isa<Instruction>(V) && classof(cast<Instruction>(V));
431 //===----------------------------------------------------------------------===//
433 //===----------------------------------------------------------------------===//
435 /// CastInst - This class represents a cast from Operand[0] to the type of
436 /// the instruction (i->getType()).
438 class CastInst : public UnaryInstruction {
439 CastInst(const CastInst &CI)
440 : UnaryInstruction(CI.getType(), Cast, CI.getOperand(0)) {
443 CastInst(Value *S, const Type *Ty, const std::string &Name = "",
444 Instruction *InsertBefore = 0)
445 : UnaryInstruction(Ty, Cast, S, Name, InsertBefore) {
447 CastInst(Value *S, const Type *Ty, const std::string &Name,
448 BasicBlock *InsertAtEnd)
449 : UnaryInstruction(Ty, Cast, S, Name, InsertAtEnd) {
452 virtual CastInst *clone() const;
454 // Methods for support type inquiry through isa, cast, and dyn_cast:
455 static inline bool classof(const CastInst *) { return true; }
456 static inline bool classof(const Instruction *I) {
457 return I->getOpcode() == Cast;
459 static inline bool classof(const Value *V) {
460 return isa<Instruction>(V) && classof(cast<Instruction>(V));
465 //===----------------------------------------------------------------------===//
467 //===----------------------------------------------------------------------===//
469 /// CallInst - This class represents a function call, abstracting a target
470 /// machine's calling convention. This class uses low bit of the SubClassData
471 /// field to indicate whether or not this is a tail call. The rest of the bits
472 /// hold the calling convention of the call.
474 class CallInst : public Instruction {
475 CallInst(const CallInst &CI);
476 void init(Value *Func, const std::vector<Value*> &Params);
477 void init(Value *Func, Value *Actual1, Value *Actual2);
478 void init(Value *Func, Value *Actual);
479 void init(Value *Func);
482 CallInst(Value *F, const std::vector<Value*> &Par,
483 const std::string &Name = "", Instruction *InsertBefore = 0);
484 CallInst(Value *F, const std::vector<Value*> &Par,
485 const std::string &Name, BasicBlock *InsertAtEnd);
487 // Alternate CallInst ctors w/ two actuals, w/ one actual and no
488 // actuals, respectively.
489 CallInst(Value *F, Value *Actual1, Value *Actual2,
490 const std::string& Name = "", Instruction *InsertBefore = 0);
491 CallInst(Value *F, Value *Actual1, Value *Actual2,
492 const std::string& Name, BasicBlock *InsertAtEnd);
493 CallInst(Value *F, Value *Actual, const std::string& Name = "",
494 Instruction *InsertBefore = 0);
495 CallInst(Value *F, Value *Actual, const std::string& Name,
496 BasicBlock *InsertAtEnd);
497 explicit CallInst(Value *F, const std::string &Name = "",
498 Instruction *InsertBefore = 0);
499 explicit CallInst(Value *F, const std::string &Name,
500 BasicBlock *InsertAtEnd);
503 virtual CallInst *clone() const;
504 bool mayWriteToMemory() const { return true; }
506 bool isTailCall() const { return SubclassData & 1; }
507 void setTailCall(bool isTailCall = true) {
508 SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
511 /// getCallingConv/setCallingConv - Get or set the calling convention of this
513 unsigned getCallingConv() const { return SubclassData >> 1; }
514 void setCallingConv(unsigned CC) {
515 SubclassData = (SubclassData & 1) | (CC << 1);
518 /// getCalledFunction - Return the function being called by this instruction
519 /// if it is a direct call. If it is a call through a function pointer,
521 Function *getCalledFunction() const {
522 return static_cast<Function*>(dyn_cast<Function>(getOperand(0)));
525 // getCalledValue - Get a pointer to a method that is invoked by this inst.
526 inline const Value *getCalledValue() const { return getOperand(0); }
527 inline Value *getCalledValue() { return getOperand(0); }
529 // Methods for support type inquiry through isa, cast, and dyn_cast:
530 static inline bool classof(const CallInst *) { return true; }
531 static inline bool classof(const Instruction *I) {
532 return I->getOpcode() == Instruction::Call;
534 static inline bool classof(const Value *V) {
535 return isa<Instruction>(V) && classof(cast<Instruction>(V));
540 //===----------------------------------------------------------------------===//
542 //===----------------------------------------------------------------------===//
544 /// ShiftInst - This class represents left and right shift instructions.
546 class ShiftInst : public Instruction {
548 ShiftInst(const ShiftInst &SI)
549 : Instruction(SI.getType(), SI.getOpcode(), Ops, 2) {
550 Ops[0].init(SI.Ops[0], this);
551 Ops[1].init(SI.Ops[1], this);
553 void init(OtherOps Opcode, Value *S, Value *SA) {
554 assert((Opcode == Shl || Opcode == Shr) && "ShiftInst Opcode invalid!");
555 Ops[0].init(S, this);
556 Ops[1].init(SA, this);
560 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name = "",
561 Instruction *InsertBefore = 0)
562 : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertBefore) {
565 ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name,
566 BasicBlock *InsertAtEnd)
567 : Instruction(S->getType(), Opcode, Ops, 2, Name, InsertAtEnd) {
571 OtherOps getOpcode() const {
572 return static_cast<OtherOps>(Instruction::getOpcode());
575 /// Transparently provide more efficient getOperand methods.
576 Value *getOperand(unsigned i) const {
577 assert(i < 2 && "getOperand() out of range!");
580 void setOperand(unsigned i, Value *Val) {
581 assert(i < 2 && "setOperand() out of range!");
584 unsigned getNumOperands() const { return 2; }
586 virtual ShiftInst *clone() const;
588 // Methods for support type inquiry through isa, cast, and dyn_cast:
589 static inline bool classof(const ShiftInst *) { return true; }
590 static inline bool classof(const Instruction *I) {
591 return (I->getOpcode() == Instruction::Shr) |
592 (I->getOpcode() == Instruction::Shl);
594 static inline bool classof(const Value *V) {
595 return isa<Instruction>(V) && classof(cast<Instruction>(V));
599 //===----------------------------------------------------------------------===//
601 //===----------------------------------------------------------------------===//
603 /// SelectInst - This class represents the LLVM 'select' instruction.
605 class SelectInst : public Instruction {
608 void init(Value *C, Value *S1, Value *S2) {
609 Ops[0].init(C, this);
610 Ops[1].init(S1, this);
611 Ops[2].init(S2, this);
614 SelectInst(const SelectInst &SI)
615 : Instruction(SI.getType(), SI.getOpcode(), Ops, 3) {
616 init(SI.Ops[0], SI.Ops[1], SI.Ops[2]);
619 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name = "",
620 Instruction *InsertBefore = 0)
621 : Instruction(S1->getType(), Instruction::Select, Ops, 3,
622 Name, InsertBefore) {
625 SelectInst(Value *C, Value *S1, Value *S2, const std::string &Name,
626 BasicBlock *InsertAtEnd)
627 : Instruction(S1->getType(), Instruction::Select, Ops, 3,
632 Value *getCondition() const { return Ops[0]; }
633 Value *getTrueValue() const { return Ops[1]; }
634 Value *getFalseValue() const { return Ops[2]; }
636 /// Transparently provide more efficient getOperand methods.
637 Value *getOperand(unsigned i) const {
638 assert(i < 3 && "getOperand() out of range!");
641 void setOperand(unsigned i, Value *Val) {
642 assert(i < 3 && "setOperand() out of range!");
645 unsigned getNumOperands() const { return 3; }
647 OtherOps getOpcode() const {
648 return static_cast<OtherOps>(Instruction::getOpcode());
651 virtual SelectInst *clone() const;
653 // Methods for support type inquiry through isa, cast, and dyn_cast:
654 static inline bool classof(const SelectInst *) { return true; }
655 static inline bool classof(const Instruction *I) {
656 return I->getOpcode() == Instruction::Select;
658 static inline bool classof(const Value *V) {
659 return isa<Instruction>(V) && classof(cast<Instruction>(V));
663 //===----------------------------------------------------------------------===//
665 //===----------------------------------------------------------------------===//
667 /// VAArgInst - This class represents the va_arg llvm instruction, which returns
668 /// an argument of the specified type given a va_list and increments that list
670 class VAArgInst : public UnaryInstruction {
671 VAArgInst(const VAArgInst &VAA)
672 : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
674 VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
675 Instruction *InsertBefore = 0)
676 : UnaryInstruction(Ty, VAArg, List, Name, InsertBefore) {
678 VAArgInst(Value *List, const Type *Ty, const std::string &Name,
679 BasicBlock *InsertAtEnd)
680 : UnaryInstruction(Ty, VAArg, List, Name, InsertAtEnd) {
683 virtual VAArgInst *clone() const;
684 bool mayWriteToMemory() const { return true; }
686 // Methods for support type inquiry through isa, cast, and dyn_cast:
687 static inline bool classof(const VAArgInst *) { return true; }
688 static inline bool classof(const Instruction *I) {
689 return I->getOpcode() == VAArg;
691 static inline bool classof(const Value *V) {
692 return isa<Instruction>(V) && classof(cast<Instruction>(V));
696 //===----------------------------------------------------------------------===//
698 //===----------------------------------------------------------------------===//
700 // PHINode - The PHINode class is used to represent the magical mystical PHI
701 // node, that can not exist in nature, but can be synthesized in a computer
702 // scientist's overactive imagination.
704 class PHINode : public Instruction {
705 /// ReservedSpace - The number of operands actually allocated. NumOperands is
706 /// the number actually in use.
707 unsigned ReservedSpace;
708 PHINode(const PHINode &PN);
710 PHINode(const Type *Ty, const std::string &Name = "",
711 Instruction *InsertBefore = 0)
712 : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertBefore),
716 PHINode(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
717 : Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertAtEnd),
723 /// reserveOperandSpace - This method can be used to avoid repeated
724 /// reallocation of PHI operand lists by reserving space for the correct
725 /// number of operands before adding them. Unlike normal vector reserves,
726 /// this method can also be used to trim the operand space.
727 void reserveOperandSpace(unsigned NumValues) {
728 resizeOperands(NumValues*2);
731 virtual PHINode *clone() const;
733 /// getNumIncomingValues - Return the number of incoming edges
735 unsigned getNumIncomingValues() const { return getNumOperands()/2; }
737 /// getIncomingValue - Return incoming value #x
739 Value *getIncomingValue(unsigned i) const {
740 assert(i*2 < getNumOperands() && "Invalid value number!");
741 return getOperand(i*2);
743 void setIncomingValue(unsigned i, Value *V) {
744 assert(i*2 < getNumOperands() && "Invalid value number!");
747 unsigned getOperandNumForIncomingValue(unsigned i) {
751 /// getIncomingBlock - Return incoming basic block #x
753 BasicBlock *getIncomingBlock(unsigned i) const {
754 return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
756 void setIncomingBlock(unsigned i, BasicBlock *BB) {
757 setOperand(i*2+1, reinterpret_cast<Value*>(BB));
759 unsigned getOperandNumForIncomingBlock(unsigned i) {
763 /// addIncoming - Add an incoming value to the end of the PHI list
765 void addIncoming(Value *V, BasicBlock *BB) {
766 assert(getType() == V->getType() &&
767 "All operands to PHI node must be the same type as the PHI node!");
768 unsigned OpNo = NumOperands;
769 if (OpNo+2 > ReservedSpace)
770 resizeOperands(0); // Get more space!
771 // Initialize some new operands.
772 NumOperands = OpNo+2;
773 OperandList[OpNo].init(V, this);
774 OperandList[OpNo+1].init(reinterpret_cast<Value*>(BB), this);
777 /// removeIncomingValue - Remove an incoming value. This is useful if a
778 /// predecessor basic block is deleted. The value removed is returned.
780 /// If the last incoming value for a PHI node is removed (and DeletePHIIfEmpty
781 /// is true), the PHI node is destroyed and any uses of it are replaced with
782 /// dummy values. The only time there should be zero incoming values to a PHI
783 /// node is when the block is dead, so this strategy is sound.
785 Value *removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty = true);
787 Value *removeIncomingValue(const BasicBlock *BB, bool DeletePHIIfEmpty =true){
788 int Idx = getBasicBlockIndex(BB);
789 assert(Idx >= 0 && "Invalid basic block argument to remove!");
790 return removeIncomingValue(Idx, DeletePHIIfEmpty);
793 /// getBasicBlockIndex - Return the first index of the specified basic
794 /// block in the value list for this PHI. Returns -1 if no instance.
796 int getBasicBlockIndex(const BasicBlock *BB) const {
797 Use *OL = OperandList;
798 for (unsigned i = 0, e = getNumOperands(); i != e; i += 2)
799 if (OL[i+1] == reinterpret_cast<const Value*>(BB)) return i/2;
803 Value *getIncomingValueForBlock(const BasicBlock *BB) const {
804 return getIncomingValue(getBasicBlockIndex(BB));
807 /// hasConstantValue - If the specified PHI node always merges together the
808 /// same value, return the value, otherwise return null.
810 Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
812 /// Methods for support type inquiry through isa, cast, and dyn_cast:
813 static inline bool classof(const PHINode *) { return true; }
814 static inline bool classof(const Instruction *I) {
815 return I->getOpcode() == Instruction::PHI;
817 static inline bool classof(const Value *V) {
818 return isa<Instruction>(V) && classof(cast<Instruction>(V));
821 void resizeOperands(unsigned NumOperands);
824 //===----------------------------------------------------------------------===//
826 //===----------------------------------------------------------------------===//
828 //===---------------------------------------------------------------------------
829 /// ReturnInst - Return a value (possibly void), from a function. Execution
830 /// does not continue in this function any longer.
832 class ReturnInst : public TerminatorInst {
833 Use RetVal; // Possibly null retval.
834 ReturnInst(const ReturnInst &RI) : TerminatorInst(Instruction::Ret, &RetVal,
835 RI.getNumOperands()) {
836 if (RI.getNumOperands())
837 RetVal.init(RI.RetVal, this);
840 void init(Value *RetVal);
843 // ReturnInst constructors:
844 // ReturnInst() - 'ret void' instruction
845 // ReturnInst( null) - 'ret void' instruction
846 // ReturnInst(Value* X) - 'ret X' instruction
847 // ReturnInst( null, Inst *) - 'ret void' instruction, insert before I
848 // ReturnInst(Value* X, Inst *I) - 'ret X' instruction, insert before I
849 // ReturnInst( null, BB *B) - 'ret void' instruction, insert @ end of BB
850 // ReturnInst(Value* X, BB *B) - 'ret X' instruction, insert @ end of BB
852 // NOTE: If the Value* passed is of type void then the constructor behaves as
853 // if it was passed NULL.
854 ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0)
855 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertBefore) {
858 ReturnInst(Value *retVal, BasicBlock *InsertAtEnd)
859 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
862 ReturnInst(BasicBlock *InsertAtEnd)
863 : TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
866 virtual ReturnInst *clone() const;
868 // Transparently provide more efficient getOperand methods.
869 Value *getOperand(unsigned i) const {
870 assert(i < getNumOperands() && "getOperand() out of range!");
873 void setOperand(unsigned i, Value *Val) {
874 assert(i < getNumOperands() && "setOperand() out of range!");
878 Value *getReturnValue() const { return RetVal; }
880 unsigned getNumSuccessors() const { return 0; }
882 // Methods for support type inquiry through isa, cast, and dyn_cast:
883 static inline bool classof(const ReturnInst *) { return true; }
884 static inline bool classof(const Instruction *I) {
885 return (I->getOpcode() == Instruction::Ret);
887 static inline bool classof(const Value *V) {
888 return isa<Instruction>(V) && classof(cast<Instruction>(V));
891 virtual BasicBlock *getSuccessorV(unsigned idx) const;
892 virtual unsigned getNumSuccessorsV() const;
893 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
896 //===----------------------------------------------------------------------===//
898 //===----------------------------------------------------------------------===//
900 //===---------------------------------------------------------------------------
901 /// BranchInst - Conditional or Unconditional Branch instruction.
903 class BranchInst : public TerminatorInst {
904 /// Ops list - Branches are strange. The operands are ordered:
905 /// TrueDest, FalseDest, Cond. This makes some accessors faster because
906 /// they don't have to check for cond/uncond branchness.
908 BranchInst(const BranchInst &BI);
911 // BranchInst constructors (where {B, T, F} are blocks, and C is a condition):
912 // BranchInst(BB *B) - 'br B'
913 // BranchInst(BB* T, BB *F, Value *C) - 'br C, T, F'
914 // BranchInst(BB* B, Inst *I) - 'br B' insert before I
915 // BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
916 // BranchInst(BB* B, BB *I) - 'br B' insert at end
917 // BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
918 BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0)
919 : TerminatorInst(Instruction::Br, Ops, 1, InsertBefore) {
920 assert(IfTrue != 0 && "Branch destination may not be null!");
921 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
923 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
924 Instruction *InsertBefore = 0)
925 : TerminatorInst(Instruction::Br, Ops, 3, InsertBefore) {
926 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
927 Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
928 Ops[2].init(Cond, this);
934 BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
935 : TerminatorInst(Instruction::Br, Ops, 1, InsertAtEnd) {
936 assert(IfTrue != 0 && "Branch destination may not be null!");
937 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
940 BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
941 BasicBlock *InsertAtEnd)
942 : TerminatorInst(Instruction::Br, Ops, 3, InsertAtEnd) {
943 Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
944 Ops[1].init(reinterpret_cast<Value*>(IfFalse), this);
945 Ops[2].init(Cond, this);
952 /// Transparently provide more efficient getOperand methods.
953 Value *getOperand(unsigned i) const {
954 assert(i < getNumOperands() && "getOperand() out of range!");
957 void setOperand(unsigned i, Value *Val) {
958 assert(i < getNumOperands() && "setOperand() out of range!");
962 virtual BranchInst *clone() const;
964 inline bool isUnconditional() const { return getNumOperands() == 1; }
965 inline bool isConditional() const { return getNumOperands() == 3; }
967 inline Value *getCondition() const {
968 assert(isConditional() && "Cannot get condition of an uncond branch!");
969 return getOperand(2);
972 void setCondition(Value *V) {
973 assert(isConditional() && "Cannot set condition of unconditional branch!");
977 // setUnconditionalDest - Change the current branch to an unconditional branch
978 // targeting the specified block.
979 // FIXME: Eliminate this ugly method.
980 void setUnconditionalDest(BasicBlock *Dest) {
981 if (isConditional()) { // Convert this to an uncond branch.
986 setOperand(0, reinterpret_cast<Value*>(Dest));
989 unsigned getNumSuccessors() const { return 1+isConditional(); }
991 BasicBlock *getSuccessor(unsigned i) const {
992 assert(i < getNumSuccessors() && "Successor # out of range for Branch!");
993 return (i == 0) ? cast<BasicBlock>(getOperand(0)) :
994 cast<BasicBlock>(getOperand(1));
997 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
998 assert(idx < getNumSuccessors() && "Successor # out of range for Branch!");
999 setOperand(idx, reinterpret_cast<Value*>(NewSucc));
1002 // Methods for support type inquiry through isa, cast, and dyn_cast:
1003 static inline bool classof(const BranchInst *) { return true; }
1004 static inline bool classof(const Instruction *I) {
1005 return (I->getOpcode() == Instruction::Br);
1007 static inline bool classof(const Value *V) {
1008 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1011 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1012 virtual unsigned getNumSuccessorsV() const;
1013 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1016 //===----------------------------------------------------------------------===//
1018 //===----------------------------------------------------------------------===//
1020 //===---------------------------------------------------------------------------
1021 /// SwitchInst - Multiway switch
1023 class SwitchInst : public TerminatorInst {
1024 unsigned ReservedSpace;
1025 // Operand[0] = Value to switch on
1026 // Operand[1] = Default basic block destination
1027 // Operand[2n ] = Value to match
1028 // Operand[2n+1] = BasicBlock to go to on match
1029 SwitchInst(const SwitchInst &RI);
1030 void init(Value *Value, BasicBlock *Default, unsigned NumCases);
1031 void resizeOperands(unsigned No);
1033 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1034 /// switch on and a default destination. The number of additional cases can
1035 /// be specified here to make memory allocation more efficient. This
1036 /// constructor can also autoinsert before another instruction.
1037 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1038 Instruction *InsertBefore = 0)
1039 : TerminatorInst(Instruction::Switch, 0, 0, InsertBefore) {
1040 init(Value, Default, NumCases);
1043 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
1044 /// switch on and a default destination. The number of additional cases can
1045 /// be specified here to make memory allocation more efficient. This
1046 /// constructor also autoinserts at the end of the specified BasicBlock.
1047 SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
1048 BasicBlock *InsertAtEnd)
1049 : TerminatorInst(Instruction::Switch, 0, 0, InsertAtEnd) {
1050 init(Value, Default, NumCases);
1055 // Accessor Methods for Switch stmt
1056 inline Value *getCondition() const { return getOperand(0); }
1057 void setCondition(Value *V) { setOperand(0, V); }
1059 inline BasicBlock *getDefaultDest() const {
1060 return cast<BasicBlock>(getOperand(1));
1063 /// getNumCases - return the number of 'cases' in this switch instruction.
1064 /// Note that case #0 is always the default case.
1065 unsigned getNumCases() const {
1066 return getNumOperands()/2;
1069 /// getCaseValue - Return the specified case value. Note that case #0, the
1070 /// default destination, does not have a case value.
1071 ConstantInt *getCaseValue(unsigned i) {
1072 assert(i && i < getNumCases() && "Illegal case value to get!");
1073 return getSuccessorValue(i);
1076 /// getCaseValue - Return the specified case value. Note that case #0, the
1077 /// default destination, does not have a case value.
1078 const ConstantInt *getCaseValue(unsigned i) const {
1079 assert(i && i < getNumCases() && "Illegal case value to get!");
1080 return getSuccessorValue(i);
1083 /// findCaseValue - Search all of the case values for the specified constant.
1084 /// If it is explicitly handled, return the case number of it, otherwise
1085 /// return 0 to indicate that it is handled by the default handler.
1086 unsigned findCaseValue(const ConstantInt *C) const {
1087 for (unsigned i = 1, e = getNumCases(); i != e; ++i)
1088 if (getCaseValue(i) == C)
1093 /// addCase - Add an entry to the switch instruction...
1095 void addCase(ConstantInt *OnVal, BasicBlock *Dest);
1097 /// removeCase - This method removes the specified successor from the switch
1098 /// instruction. Note that this cannot be used to remove the default
1099 /// destination (successor #0).
1101 void removeCase(unsigned idx);
1103 virtual SwitchInst *clone() const;
1105 unsigned getNumSuccessors() const { return getNumOperands()/2; }
1106 BasicBlock *getSuccessor(unsigned idx) const {
1107 assert(idx < getNumSuccessors() &&"Successor idx out of range for switch!");
1108 return cast<BasicBlock>(getOperand(idx*2+1));
1110 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1111 assert(idx < getNumSuccessors() && "Successor # out of range for switch!");
1112 setOperand(idx*2+1, reinterpret_cast<Value*>(NewSucc));
1115 // getSuccessorValue - Return the value associated with the specified
1117 inline ConstantInt *getSuccessorValue(unsigned idx) const {
1118 assert(idx < getNumSuccessors() && "Successor # out of range!");
1119 return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
1122 // Methods for support type inquiry through isa, cast, and dyn_cast:
1123 static inline bool classof(const SwitchInst *) { return true; }
1124 static inline bool classof(const Instruction *I) {
1125 return I->getOpcode() == Instruction::Switch;
1127 static inline bool classof(const Value *V) {
1128 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1131 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1132 virtual unsigned getNumSuccessorsV() const;
1133 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1136 //===----------------------------------------------------------------------===//
1138 //===----------------------------------------------------------------------===//
1140 //===---------------------------------------------------------------------------
1142 /// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
1143 /// calling convention of the call.
1145 class InvokeInst : public TerminatorInst {
1146 InvokeInst(const InvokeInst &BI);
1147 void init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1148 const std::vector<Value*> &Params);
1150 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1151 const std::vector<Value*> &Params, const std::string &Name = "",
1152 Instruction *InsertBefore = 0);
1153 InvokeInst(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
1154 const std::vector<Value*> &Params, const std::string &Name,
1155 BasicBlock *InsertAtEnd);
1158 virtual InvokeInst *clone() const;
1160 bool mayWriteToMemory() const { return true; }
1162 /// getCallingConv/setCallingConv - Get or set the calling convention of this
1164 unsigned getCallingConv() const { return SubclassData; }
1165 void setCallingConv(unsigned CC) {
1169 /// getCalledFunction - Return the function called, or null if this is an
1170 /// indirect function invocation.
1172 Function *getCalledFunction() const {
1173 return dyn_cast<Function>(getOperand(0));
1176 // getCalledValue - Get a pointer to a function that is invoked by this inst.
1177 inline Value *getCalledValue() const { return getOperand(0); }
1179 // get*Dest - Return the destination basic blocks...
1180 BasicBlock *getNormalDest() const {
1181 return cast<BasicBlock>(getOperand(1));
1183 BasicBlock *getUnwindDest() const {
1184 return cast<BasicBlock>(getOperand(2));
1186 void setNormalDest(BasicBlock *B) {
1187 setOperand(1, reinterpret_cast<Value*>(B));
1190 void setUnwindDest(BasicBlock *B) {
1191 setOperand(2, reinterpret_cast<Value*>(B));
1194 inline BasicBlock *getSuccessor(unsigned i) const {
1195 assert(i < 2 && "Successor # out of range for invoke!");
1196 return i == 0 ? getNormalDest() : getUnwindDest();
1199 void setSuccessor(unsigned idx, BasicBlock *NewSucc) {
1200 assert(idx < 2 && "Successor # out of range for invoke!");
1201 setOperand(idx+1, reinterpret_cast<Value*>(NewSucc));
1204 unsigned getNumSuccessors() const { return 2; }
1206 // Methods for support type inquiry through isa, cast, and dyn_cast:
1207 static inline bool classof(const InvokeInst *) { return true; }
1208 static inline bool classof(const Instruction *I) {
1209 return (I->getOpcode() == Instruction::Invoke);
1211 static inline bool classof(const Value *V) {
1212 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1215 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1216 virtual unsigned getNumSuccessorsV() const;
1217 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1221 //===----------------------------------------------------------------------===//
1223 //===----------------------------------------------------------------------===//
1225 //===---------------------------------------------------------------------------
1226 /// UnwindInst - Immediately exit the current function, unwinding the stack
1227 /// until an invoke instruction is found.
1229 class UnwindInst : public TerminatorInst {
1231 UnwindInst(Instruction *InsertBefore = 0)
1232 : TerminatorInst(Instruction::Unwind, 0, 0, InsertBefore) {
1234 UnwindInst(BasicBlock *InsertAtEnd)
1235 : TerminatorInst(Instruction::Unwind, 0, 0, InsertAtEnd) {
1238 virtual UnwindInst *clone() const;
1240 unsigned getNumSuccessors() const { return 0; }
1242 // Methods for support type inquiry through isa, cast, and dyn_cast:
1243 static inline bool classof(const UnwindInst *) { return true; }
1244 static inline bool classof(const Instruction *I) {
1245 return I->getOpcode() == Instruction::Unwind;
1247 static inline bool classof(const Value *V) {
1248 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1251 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1252 virtual unsigned getNumSuccessorsV() const;
1253 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1256 //===----------------------------------------------------------------------===//
1257 // UnreachableInst Class
1258 //===----------------------------------------------------------------------===//
1260 //===---------------------------------------------------------------------------
1261 /// UnreachableInst - This function has undefined behavior. In particular, the
1262 /// presence of this instruction indicates some higher level knowledge that the
1263 /// end of the block cannot be reached.
1265 class UnreachableInst : public TerminatorInst {
1267 UnreachableInst(Instruction *InsertBefore = 0)
1268 : TerminatorInst(Instruction::Unreachable, 0, 0, InsertBefore) {
1270 UnreachableInst(BasicBlock *InsertAtEnd)
1271 : TerminatorInst(Instruction::Unreachable, 0, 0, InsertAtEnd) {
1274 virtual UnreachableInst *clone() const;
1276 unsigned getNumSuccessors() const { return 0; }
1278 // Methods for support type inquiry through isa, cast, and dyn_cast:
1279 static inline bool classof(const UnreachableInst *) { return true; }
1280 static inline bool classof(const Instruction *I) {
1281 return I->getOpcode() == Instruction::Unreachable;
1283 static inline bool classof(const Value *V) {
1284 return isa<Instruction>(V) && classof(cast<Instruction>(V));
1287 virtual BasicBlock *getSuccessorV(unsigned idx) const;
1288 virtual unsigned getNumSuccessorsV() const;
1289 virtual void setSuccessorV(unsigned idx, BasicBlock *B);
1292 } // End llvm namespace