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/Instruction.h"
15 #include "llvm/Type.h"
16 #include "llvm/Instructions.h"
17 #include "llvm/Constants.h"
18 #include "llvm/Module.h"
19 #include "llvm/Support/CallSite.h"
20 #include "llvm/Support/LeakDetector.h"
23 Instruction::Instruction(Type *ty, unsigned it, Use *Ops, unsigned NumOps,
24 Instruction *InsertBefore)
25 : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
26 // Make sure that we get added to a basicblock
27 LeakDetector::addGarbageObject(this);
29 // If requested, insert this instruction into a basic block...
31 assert(InsertBefore->getParent() &&
32 "Instruction to insert before is not in a basic block!");
33 InsertBefore->getParent()->getInstList().insert(InsertBefore, this);
37 Instruction::Instruction(Type *ty, unsigned it, Use *Ops, unsigned NumOps,
38 BasicBlock *InsertAtEnd)
39 : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
40 // Make sure that we get added to a basicblock
41 LeakDetector::addGarbageObject(this);
43 // append this instruction into the basic block
44 assert(InsertAtEnd && "Basic block to append to may not be NULL!");
45 InsertAtEnd->getInstList().push_back(this);
49 // Out of line virtual method, so the vtable, etc has a home.
50 Instruction::~Instruction() {
51 assert(Parent == 0 && "Instruction still linked in the program!");
52 if (hasMetadataHashEntry())
53 clearMetadataHashEntries();
57 void Instruction::setParent(BasicBlock *P) {
59 if (!P) LeakDetector::addGarbageObject(this);
61 if (P) LeakDetector::removeGarbageObject(this);
67 void Instruction::removeFromParent() {
68 getParent()->getInstList().remove(this);
71 void Instruction::eraseFromParent() {
72 getParent()->getInstList().erase(this);
75 /// insertBefore - Insert an unlinked instructions into a basic block
76 /// immediately before the specified instruction.
77 void Instruction::insertBefore(Instruction *InsertPos) {
78 InsertPos->getParent()->getInstList().insert(InsertPos, this);
81 /// insertAfter - Insert an unlinked instructions into a basic block
82 /// immediately after the specified instruction.
83 void Instruction::insertAfter(Instruction *InsertPos) {
84 InsertPos->getParent()->getInstList().insertAfter(InsertPos, this);
87 /// moveBefore - Unlink this instruction from its current basic block and
88 /// insert it into the basic block that MovePos lives in, right before
90 void Instruction::moveBefore(Instruction *MovePos) {
91 MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
96 const char *Instruction::getOpcodeName(unsigned OpCode) {
99 case Ret: return "ret";
100 case Br: return "br";
101 case Switch: return "switch";
102 case IndirectBr: return "indirectbr";
103 case Invoke: return "invoke";
104 case Resume: return "resume";
105 case Unwind: return "unwind";
106 case Unreachable: return "unreachable";
108 // Standard binary operators...
109 case Add: return "add";
110 case FAdd: return "fadd";
111 case Sub: return "sub";
112 case FSub: return "fsub";
113 case Mul: return "mul";
114 case FMul: return "fmul";
115 case UDiv: return "udiv";
116 case SDiv: return "sdiv";
117 case FDiv: return "fdiv";
118 case URem: return "urem";
119 case SRem: return "srem";
120 case FRem: return "frem";
122 // Logical operators...
123 case And: return "and";
124 case Or : return "or";
125 case Xor: return "xor";
127 // Memory instructions...
128 case Alloca: return "alloca";
129 case Load: return "load";
130 case Store: return "store";
131 case AtomicCmpXchg: return "cmpxchg";
132 case AtomicRMW: return "atomicrmw";
133 case Fence: return "fence";
134 case GetElementPtr: return "getelementptr";
136 // Convert instructions...
137 case Trunc: return "trunc";
138 case ZExt: return "zext";
139 case SExt: return "sext";
140 case FPTrunc: return "fptrunc";
141 case FPExt: return "fpext";
142 case FPToUI: return "fptoui";
143 case FPToSI: return "fptosi";
144 case UIToFP: return "uitofp";
145 case SIToFP: return "sitofp";
146 case IntToPtr: return "inttoptr";
147 case PtrToInt: return "ptrtoint";
148 case BitCast: return "bitcast";
150 // Other instructions...
151 case ICmp: return "icmp";
152 case FCmp: return "fcmp";
153 case PHI: return "phi";
154 case Select: return "select";
155 case Call: return "call";
156 case Shl: return "shl";
157 case LShr: return "lshr";
158 case AShr: return "ashr";
159 case VAArg: return "va_arg";
160 case ExtractElement: return "extractelement";
161 case InsertElement: return "insertelement";
162 case ShuffleVector: return "shufflevector";
163 case ExtractValue: return "extractvalue";
164 case InsertValue: return "insertvalue";
165 case LandingPad: return "landingpad";
167 default: return "<Invalid operator> ";
171 /// isIdenticalTo - Return true if the specified instruction is exactly
172 /// identical to the current one. This means that all operands match and any
173 /// extra information (e.g. load is volatile) agree.
174 bool Instruction::isIdenticalTo(const Instruction *I) const {
175 return isIdenticalToWhenDefined(I) &&
176 SubclassOptionalData == I->SubclassOptionalData;
179 /// isIdenticalToWhenDefined - This is like isIdenticalTo, except that it
180 /// ignores the SubclassOptionalData flags, which specify conditions
181 /// under which the instruction's result is undefined.
182 bool Instruction::isIdenticalToWhenDefined(const Instruction *I) const {
183 if (getOpcode() != I->getOpcode() ||
184 getNumOperands() != I->getNumOperands() ||
185 getType() != I->getType())
188 // We have two instructions of identical opcode and #operands. Check to see
189 // if all operands are the same.
190 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
191 if (getOperand(i) != I->getOperand(i))
194 // Check special state that is a part of some instructions.
195 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
196 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
197 LI->getAlignment() == cast<LoadInst>(I)->getAlignment() &&
198 LI->getOrdering() == cast<LoadInst>(I)->getOrdering() &&
199 LI->getSynchScope() == cast<LoadInst>(I)->getSynchScope();
200 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
201 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
202 SI->getAlignment() == cast<StoreInst>(I)->getAlignment() &&
203 SI->getOrdering() == cast<StoreInst>(I)->getOrdering() &&
204 SI->getSynchScope() == cast<StoreInst>(I)->getSynchScope();
205 if (const CmpInst *CI = dyn_cast<CmpInst>(this))
206 return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
207 if (const CallInst *CI = dyn_cast<CallInst>(this))
208 return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
209 CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
210 CI->getAttributes() == cast<CallInst>(I)->getAttributes();
211 if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
212 return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
213 CI->getAttributes() == cast<InvokeInst>(I)->getAttributes();
214 if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this))
215 return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices();
216 if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this))
217 return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices();
218 if (const FenceInst *FI = dyn_cast<FenceInst>(this))
219 return FI->getOrdering() == cast<FenceInst>(FI)->getOrdering() &&
220 FI->getSynchScope() == cast<FenceInst>(FI)->getSynchScope();
221 if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(this))
222 return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I)->isVolatile() &&
223 CXI->getOrdering() == cast<AtomicCmpXchgInst>(I)->getOrdering() &&
224 CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I)->getSynchScope();
225 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(this))
226 return RMWI->getOperation() == cast<AtomicRMWInst>(I)->getOperation() &&
227 RMWI->isVolatile() == cast<AtomicRMWInst>(I)->isVolatile() &&
228 RMWI->getOrdering() == cast<AtomicRMWInst>(I)->getOrdering() &&
229 RMWI->getSynchScope() == cast<AtomicRMWInst>(I)->getSynchScope();
235 // This should be kept in sync with isEquivalentOperation in
236 // lib/Transforms/IPO/MergeFunctions.cpp.
237 bool Instruction::isSameOperationAs(const Instruction *I) const {
238 if (getOpcode() != I->getOpcode() ||
239 getNumOperands() != I->getNumOperands() ||
240 getType() != I->getType())
243 // We have two instructions of identical opcode and #operands. Check to see
244 // if all operands are the same type
245 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
246 if (getOperand(i)->getType() != I->getOperand(i)->getType())
249 // Check special state that is a part of some instructions.
250 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
251 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
252 LI->getAlignment() == cast<LoadInst>(I)->getAlignment() &&
253 LI->getOrdering() == cast<LoadInst>(I)->getOrdering() &&
254 LI->getSynchScope() == cast<LoadInst>(I)->getSynchScope();
255 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
256 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
257 SI->getAlignment() == cast<StoreInst>(I)->getAlignment() &&
258 SI->getOrdering() == cast<StoreInst>(I)->getOrdering() &&
259 SI->getSynchScope() == cast<StoreInst>(I)->getSynchScope();
260 if (const CmpInst *CI = dyn_cast<CmpInst>(this))
261 return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
262 if (const CallInst *CI = dyn_cast<CallInst>(this))
263 return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
264 CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
265 CI->getAttributes() == cast<CallInst>(I)->getAttributes();
266 if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
267 return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
268 CI->getAttributes() ==
269 cast<InvokeInst>(I)->getAttributes();
270 if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this))
271 return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices();
272 if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this))
273 return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices();
274 if (const FenceInst *FI = dyn_cast<FenceInst>(this))
275 return FI->getOrdering() == cast<FenceInst>(I)->getOrdering() &&
276 FI->getSynchScope() == cast<FenceInst>(I)->getSynchScope();
277 if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(this))
278 return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I)->isVolatile() &&
279 CXI->getOrdering() == cast<AtomicCmpXchgInst>(I)->getOrdering() &&
280 CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I)->getSynchScope();
281 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(this))
282 return RMWI->getOperation() == cast<AtomicRMWInst>(I)->getOperation() &&
283 RMWI->isVolatile() == cast<AtomicRMWInst>(I)->isVolatile() &&
284 RMWI->getOrdering() == cast<AtomicRMWInst>(I)->getOrdering() &&
285 RMWI->getSynchScope() == cast<AtomicRMWInst>(I)->getSynchScope();
290 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
291 /// specified block. Note that PHI nodes are considered to evaluate their
292 /// operands in the corresponding predecessor block.
293 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
294 for (const_use_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
295 // PHI nodes uses values in the corresponding predecessor block. For other
296 // instructions, just check to see whether the parent of the use matches up.
298 const PHINode *PN = dyn_cast<PHINode>(U);
300 if (cast<Instruction>(U)->getParent() != BB)
305 if (PN->getIncomingBlock(UI) != BB)
311 /// mayReadFromMemory - Return true if this instruction may read memory.
313 bool Instruction::mayReadFromMemory() const {
314 switch (getOpcode()) {
315 default: return false;
316 case Instruction::VAArg:
317 case Instruction::Load:
318 case Instruction::Fence: // FIXME: refine definition of mayReadFromMemory
319 case Instruction::AtomicCmpXchg:
320 case Instruction::AtomicRMW:
322 case Instruction::Call:
323 return !cast<CallInst>(this)->doesNotAccessMemory();
324 case Instruction::Invoke:
325 return !cast<InvokeInst>(this)->doesNotAccessMemory();
326 case Instruction::Store:
327 return !cast<StoreInst>(this)->isUnordered();
331 /// mayWriteToMemory - Return true if this instruction may modify memory.
333 bool Instruction::mayWriteToMemory() const {
334 switch (getOpcode()) {
335 default: return false;
336 case Instruction::Fence: // FIXME: refine definition of mayWriteToMemory
337 case Instruction::Store:
338 case Instruction::VAArg:
339 case Instruction::AtomicCmpXchg:
340 case Instruction::AtomicRMW:
342 case Instruction::Call:
343 return !cast<CallInst>(this)->onlyReadsMemory();
344 case Instruction::Invoke:
345 return !cast<InvokeInst>(this)->onlyReadsMemory();
346 case Instruction::Load:
347 return !cast<LoadInst>(this)->isUnordered();
351 /// mayThrow - Return true if this instruction may throw an exception.
353 bool Instruction::mayThrow() const {
354 if (const CallInst *CI = dyn_cast<CallInst>(this))
355 return !CI->doesNotThrow();
356 return isa<ResumeInst>(this);
359 /// isAssociative - Return true if the instruction is associative:
361 /// Associative operators satisfy: x op (y op z) === (x op y) op z
363 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
365 bool Instruction::isAssociative(unsigned Opcode) {
366 return Opcode == And || Opcode == Or || Opcode == Xor ||
367 Opcode == Add || Opcode == Mul;
370 /// isCommutative - Return true if the instruction is commutative:
372 /// Commutative operators satisfy: (x op y) === (y op x)
374 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
375 /// applied to any type.
377 bool Instruction::isCommutative(unsigned op) {
392 Instruction *Instruction::clone() const {
393 Instruction *New = clone_impl();
394 New->SubclassOptionalData = SubclassOptionalData;
398 // Otherwise, enumerate and copy over metadata from the old instruction to the
400 SmallVector<std::pair<unsigned, MDNode*>, 4> TheMDs;
401 getAllMetadataOtherThanDebugLoc(TheMDs);
402 for (unsigned i = 0, e = TheMDs.size(); i != e; ++i)
403 New->setMetadata(TheMDs[i].first, TheMDs[i].second);
405 New->setDebugLoc(getDebugLoc());