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 /// insertBefore - Insert an unlinked instructions into a basic block
72 /// immediately before the specified instruction.
73 void Instruction::insertBefore(Instruction *InsertPos) {
74 InsertPos->getParent()->getInstList().insert(InsertPos, this);
77 /// insertAfter - Insert an unlinked instructions into a basic block
78 /// immediately after the specified instruction.
79 void Instruction::insertAfter(Instruction *InsertPos) {
80 InsertPos->getParent()->getInstList().insertAfter(InsertPos, this);
83 /// moveBefore - Unlink this instruction from its current basic block and
84 /// insert it into the basic block that MovePos lives in, right before
86 void Instruction::moveBefore(Instruction *MovePos) {
87 MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
92 const char *Instruction::getOpcodeName(unsigned OpCode) {
95 case Ret: return "ret";
97 case Switch: return "switch";
98 case Invoke: return "invoke";
99 case Unwind: return "unwind";
100 case Unreachable: return "unreachable";
102 // Standard binary operators...
103 case Add: return "add";
104 case FAdd: return "fadd";
105 case Sub: return "sub";
106 case FSub: return "fsub";
107 case Mul: return "mul";
108 case FMul: return "fmul";
109 case UDiv: return "udiv";
110 case SDiv: return "sdiv";
111 case FDiv: return "fdiv";
112 case URem: return "urem";
113 case SRem: return "srem";
114 case FRem: return "frem";
116 // Logical operators...
117 case And: return "and";
118 case Or : return "or";
119 case Xor: return "xor";
121 // Memory instructions...
122 case Malloc: return "malloc";
123 case Free: return "free";
124 case Alloca: return "alloca";
125 case Load: return "load";
126 case Store: return "store";
127 case GetElementPtr: return "getelementptr";
129 // Convert instructions...
130 case Trunc: return "trunc";
131 case ZExt: return "zext";
132 case SExt: return "sext";
133 case FPTrunc: return "fptrunc";
134 case FPExt: return "fpext";
135 case FPToUI: return "fptoui";
136 case FPToSI: return "fptosi";
137 case UIToFP: return "uitofp";
138 case SIToFP: return "sitofp";
139 case IntToPtr: return "inttoptr";
140 case PtrToInt: return "ptrtoint";
141 case BitCast: return "bitcast";
143 // Other instructions...
144 case ICmp: return "icmp";
145 case FCmp: return "fcmp";
146 case VICmp: return "vicmp";
147 case VFCmp: return "vfcmp";
148 case PHI: return "phi";
149 case Select: return "select";
150 case Call: return "call";
151 case Shl: return "shl";
152 case LShr: return "lshr";
153 case AShr: return "ashr";
154 case VAArg: return "va_arg";
155 case ExtractElement: return "extractelement";
156 case InsertElement: return "insertelement";
157 case ShuffleVector: return "shufflevector";
158 case ExtractValue: return "extractvalue";
159 case InsertValue: return "insertvalue";
161 default: return "<Invalid operator> ";
167 /// isIdenticalTo - Return true if the specified instruction is exactly
168 /// identical to the current one. This means that all operands match and any
169 /// extra information (e.g. load is volatile) agree.
170 bool Instruction::isIdenticalTo(const Instruction *I) const {
171 if (getOpcode() != I->getOpcode() ||
172 getNumOperands() != I->getNumOperands() ||
173 getType() != I->getType())
176 // We have two instructions of identical opcode and #operands. Check to see
177 // if all operands are the same.
178 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
179 if (getOperand(i) != I->getOperand(i))
182 // Check special state that is a part of some instructions.
183 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
184 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
185 LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
186 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
187 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
188 SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
189 if (const CmpInst *CI = dyn_cast<CmpInst>(this))
190 return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
191 if (const CallInst *CI = dyn_cast<CallInst>(this))
192 return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
193 CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
194 CI->getAttributes().getRawPointer() ==
195 cast<CallInst>(I)->getAttributes().getRawPointer();
196 if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
197 return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
198 CI->getAttributes().getRawPointer() ==
199 cast<InvokeInst>(I)->getAttributes().getRawPointer();
200 if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this)) {
201 if (IVI->getNumIndices() != cast<InsertValueInst>(I)->getNumIndices())
203 for (unsigned i = 0, e = IVI->getNumIndices(); i != e; ++i)
204 if (IVI->idx_begin()[i] != cast<InsertValueInst>(I)->idx_begin()[i])
208 if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this)) {
209 if (EVI->getNumIndices() != cast<ExtractValueInst>(I)->getNumIndices())
211 for (unsigned i = 0, e = EVI->getNumIndices(); i != e; ++i)
212 if (EVI->idx_begin()[i] != cast<ExtractValueInst>(I)->idx_begin()[i])
221 // This should be kept in sync with isEquivalentOperation in
222 // lib/Transforms/IPO/MergeFunctions.cpp.
223 bool Instruction::isSameOperationAs(const Instruction *I) const {
224 if (getOpcode() != I->getOpcode() ||
225 getNumOperands() != I->getNumOperands() ||
226 getType() != I->getType())
229 // We have two instructions of identical opcode and #operands. Check to see
230 // if all operands are the same type
231 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
232 if (getOperand(i)->getType() != I->getOperand(i)->getType())
235 // Check special state that is a part of some instructions.
236 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
237 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
238 LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
239 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
240 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
241 SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
242 if (const CmpInst *CI = dyn_cast<CmpInst>(this))
243 return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
244 if (const CallInst *CI = dyn_cast<CallInst>(this))
245 return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
246 CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
247 CI->getAttributes().getRawPointer() ==
248 cast<CallInst>(I)->getAttributes().getRawPointer();
249 if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
250 return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
251 CI->getAttributes().getRawPointer() ==
252 cast<InvokeInst>(I)->getAttributes().getRawPointer();
253 if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this)) {
254 if (IVI->getNumIndices() != cast<InsertValueInst>(I)->getNumIndices())
256 for (unsigned i = 0, e = IVI->getNumIndices(); i != e; ++i)
257 if (IVI->idx_begin()[i] != cast<InsertValueInst>(I)->idx_begin()[i])
261 if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this)) {
262 if (EVI->getNumIndices() != cast<ExtractValueInst>(I)->getNumIndices())
264 for (unsigned i = 0, e = EVI->getNumIndices(); i != e; ++i)
265 if (EVI->idx_begin()[i] != cast<ExtractValueInst>(I)->idx_begin()[i])
273 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
274 /// specified block. Note that PHI nodes are considered to evaluate their
275 /// operands in the corresponding predecessor block.
276 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
277 for (use_const_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
278 // PHI nodes uses values in the corresponding predecessor block. For other
279 // instructions, just check to see whether the parent of the use matches up.
280 const PHINode *PN = dyn_cast<PHINode>(*UI);
282 if (cast<Instruction>(*UI)->getParent() != BB)
287 if (PN->getIncomingBlock(UI) != BB)
293 /// mayReadFromMemory - Return true if this instruction may read memory.
295 bool Instruction::mayReadFromMemory() const {
296 switch (getOpcode()) {
297 default: return false;
298 case Instruction::Free:
299 case Instruction::VAArg:
300 case Instruction::Load:
302 case Instruction::Call:
303 return !cast<CallInst>(this)->doesNotAccessMemory();
304 case Instruction::Invoke:
305 return !cast<InvokeInst>(this)->doesNotAccessMemory();
306 case Instruction::Store:
307 return cast<StoreInst>(this)->isVolatile();
311 /// mayWriteToMemory - Return true if this instruction may modify memory.
313 bool Instruction::mayWriteToMemory() const {
314 switch (getOpcode()) {
315 default: return false;
316 case Instruction::Free:
317 case Instruction::Store:
318 case Instruction::VAArg:
320 case Instruction::Call:
321 return !cast<CallInst>(this)->onlyReadsMemory();
322 case Instruction::Invoke:
323 return !cast<InvokeInst>(this)->onlyReadsMemory();
324 case Instruction::Load:
325 return cast<LoadInst>(this)->isVolatile();
329 /// mayThrow - Return true if this instruction may throw an exception.
331 bool Instruction::mayThrow() const {
332 if (const CallInst *CI = dyn_cast<CallInst>(this))
333 return !CI->doesNotThrow();
337 /// isAssociative - Return true if the instruction is associative:
339 /// Associative operators satisfy: x op (y op z) === (x op y) op z
341 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
343 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
344 return Opcode == And || Opcode == Or || Opcode == Xor ||
345 Opcode == Add || Opcode == Mul;
348 /// isCommutative - Return true if the instruction is commutative:
350 /// Commutative operators satisfy: (x op y) === (y op x)
352 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
353 /// applied to any type.
355 bool Instruction::isCommutative(unsigned op) {
370 /// isTrapping - Return true if the instruction may trap.
372 bool Instruction::isTrapping(unsigned op) {