1 //===-- Instruction.cpp - Implement the Instruction class -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Instruction class for the VMCore library.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Type.h"
15 #include "llvm/Instructions.h"
16 #include "llvm/Function.h"
17 #include "llvm/Support/CallSite.h"
18 #include "llvm/Support/LeakDetector.h"
21 Instruction::Instruction(const Type *ty, unsigned it, Use *Ops, unsigned NumOps,
22 Instruction *InsertBefore)
23 : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
24 // Make sure that we get added to a basicblock
25 LeakDetector::addGarbageObject(this);
27 // If requested, insert this instruction into a basic block...
29 assert(InsertBefore->getParent() &&
30 "Instruction to insert before is not in a basic block!");
31 InsertBefore->getParent()->getInstList().insert(InsertBefore, this);
35 Instruction::Instruction(const Type *ty, unsigned it, Use *Ops, unsigned NumOps,
36 BasicBlock *InsertAtEnd)
37 : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
38 // Make sure that we get added to a basicblock
39 LeakDetector::addGarbageObject(this);
41 // append this instruction into the basic block
42 assert(InsertAtEnd && "Basic block to append to may not be NULL!");
43 InsertAtEnd->getInstList().push_back(this);
47 // Out of line virtual method, so the vtable, etc has a home.
48 Instruction::~Instruction() {
49 assert(Parent == 0 && "Instruction still linked in the program!");
53 void Instruction::setParent(BasicBlock *P) {
55 if (!P) LeakDetector::addGarbageObject(this);
57 if (P) LeakDetector::removeGarbageObject(this);
63 void Instruction::removeFromParent() {
64 getParent()->getInstList().remove(this);
67 void Instruction::eraseFromParent() {
68 getParent()->getInstList().erase(this);
71 /// moveBefore - Unlink this instruction from its current basic block and
72 /// insert it into the basic block that MovePos lives in, right before
74 void Instruction::moveBefore(Instruction *MovePos) {
75 MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
80 const char *Instruction::getOpcodeName(unsigned OpCode) {
83 case Ret: return "ret";
85 case Switch: return "switch";
86 case Invoke: return "invoke";
87 case Unwind: return "unwind";
88 case Unreachable: return "unreachable";
90 // Standard binary operators...
91 case Add: return "add";
92 case Sub: return "sub";
93 case Mul: return "mul";
94 case UDiv: return "udiv";
95 case SDiv: return "sdiv";
96 case FDiv: return "fdiv";
97 case URem: return "urem";
98 case SRem: return "srem";
99 case FRem: return "frem";
101 // Logical operators...
102 case And: return "and";
103 case Or : return "or";
104 case Xor: return "xor";
106 // Memory instructions...
107 case Malloc: return "malloc";
108 case Free: return "free";
109 case Alloca: return "alloca";
110 case Load: return "load";
111 case Store: return "store";
112 case GetElementPtr: return "getelementptr";
114 // Convert instructions...
115 case Trunc: return "trunc";
116 case ZExt: return "zext";
117 case SExt: return "sext";
118 case FPTrunc: return "fptrunc";
119 case FPExt: return "fpext";
120 case FPToUI: return "fptoui";
121 case FPToSI: return "fptosi";
122 case UIToFP: return "uitofp";
123 case SIToFP: return "sitofp";
124 case IntToPtr: return "inttoptr";
125 case PtrToInt: return "ptrtoint";
126 case BitCast: return "bitcast";
128 // Other instructions...
129 case ICmp: return "icmp";
130 case FCmp: return "fcmp";
131 case VICmp: return "vicmp";
132 case VFCmp: return "vfcmp";
133 case PHI: return "phi";
134 case Select: return "select";
135 case Call: return "call";
136 case Shl: return "shl";
137 case LShr: return "lshr";
138 case AShr: return "ashr";
139 case VAArg: return "va_arg";
140 case ExtractElement: return "extractelement";
141 case InsertElement: return "insertelement";
142 case ShuffleVector: return "shufflevector";
143 case GetResult: return "getresult";
144 case ExtractValue: return "extractvalue";
145 case InsertValue: return "insertvalue";
147 default: return "<Invalid operator> ";
153 /// isIdenticalTo - Return true if the specified instruction is exactly
154 /// identical to the current one. This means that all operands match and any
155 /// extra information (e.g. load is volatile) agree.
156 bool Instruction::isIdenticalTo(Instruction *I) const {
157 if (getOpcode() != I->getOpcode() ||
158 getNumOperands() != I->getNumOperands() ||
159 getType() != I->getType())
162 // We have two instructions of identical opcode and #operands. Check to see
163 // if all operands are the same.
164 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
165 if (getOperand(i) != I->getOperand(i))
168 // Check special state that is a part of some instructions.
169 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
170 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
171 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
172 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
173 if (const CmpInst *CI = dyn_cast<CmpInst>(this))
174 return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
175 if (const CallInst *CI = dyn_cast<CallInst>(this))
176 return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
181 bool Instruction::isSameOperationAs(Instruction *I) const {
182 if (getOpcode() != I->getOpcode() || getType() != I->getType() ||
183 getNumOperands() != I->getNumOperands())
186 // We have two instructions of identical opcode and #operands. Check to see
187 // if all operands are the same type
188 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
189 if (getOperand(i)->getType() != I->getOperand(i)->getType())
192 // Check special state that is a part of some instructions.
193 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
194 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
195 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
196 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
197 if (const CmpInst *CI = dyn_cast<CmpInst>(this))
198 return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
199 if (const CallInst *CI = dyn_cast<CallInst>(this))
200 return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
205 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
206 /// specified block. Note that PHI nodes are considered to evaluate their
207 /// operands in the corresponding predecessor block.
208 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
209 for (use_const_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
210 // PHI nodes uses values in the corresponding predecessor block. For other
211 // instructions, just check to see whether the parent of the use matches up.
212 const PHINode *PN = dyn_cast<PHINode>(*UI);
214 if (cast<Instruction>(*UI)->getParent() != BB)
219 unsigned UseOperand = UI.getOperandNo();
220 if (PN->getIncomingBlock(UseOperand/2) != BB)
226 /// mayReadFromMemory - Return true if this instruction may read memory.
228 bool Instruction::mayReadFromMemory() const {
229 switch (getOpcode()) {
230 default: return false;
231 case Instruction::Free:
232 case Instruction::VAArg:
233 case Instruction::Load:
235 case Instruction::Call:
236 return !cast<CallInst>(this)->doesNotAccessMemory();
237 case Instruction::Invoke:
238 return !cast<InvokeInst>(this)->doesNotAccessMemory();
239 case Instruction::Store:
240 return cast<StoreInst>(this)->isVolatile();
244 /// mayWriteToMemory - Return true if this instruction may modify memory.
246 bool Instruction::mayWriteToMemory() const {
247 switch (getOpcode()) {
248 default: return false;
249 case Instruction::Free:
250 case Instruction::Store:
251 case Instruction::VAArg:
253 case Instruction::Call:
254 return !cast<CallInst>(this)->onlyReadsMemory();
255 case Instruction::Invoke:
256 return !cast<InvokeInst>(this)->onlyReadsMemory();
257 case Instruction::Load:
258 return cast<LoadInst>(this)->isVolatile();
262 /// isAssociative - Return true if the instruction is associative:
264 /// Associative operators satisfy: x op (y op z) === (x op y) op z)
266 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when not
267 /// applied to floating point types.
269 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
270 if (Opcode == And || Opcode == Or || Opcode == Xor)
273 // Add/Mul reassociate unless they are FP or FP vectors.
274 if (Opcode == Add || Opcode == Mul)
275 return !Ty->isFPOrFPVector();
279 /// isCommutative - Return true if the instruction is commutative:
281 /// Commutative operators satisfy: (x op y) === (y op x)
283 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
284 /// applied to any type.
286 bool Instruction::isCommutative(unsigned op) {
299 /// isTrappingInstruction - Return true if the instruction may trap.
301 bool Instruction::isTrapping(unsigned op) {