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 /// moveBefore - Unlink this instruction from its current basic block and
78 /// insert it into the basic block that MovePos lives in, right before
80 void Instruction::moveBefore(Instruction *MovePos) {
81 MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
86 const char *Instruction::getOpcodeName(unsigned OpCode) {
89 case Ret: return "ret";
91 case Switch: return "switch";
92 case Invoke: return "invoke";
93 case Unwind: return "unwind";
94 case Unreachable: return "unreachable";
96 // Standard binary operators...
97 case Add: return "add";
98 case Sub: return "sub";
99 case Mul: return "mul";
100 case UDiv: return "udiv";
101 case SDiv: return "sdiv";
102 case FDiv: return "fdiv";
103 case URem: return "urem";
104 case SRem: return "srem";
105 case FRem: return "frem";
107 // Logical operators...
108 case And: return "and";
109 case Or : return "or";
110 case Xor: return "xor";
112 // Memory instructions...
113 case Malloc: return "malloc";
114 case Free: return "free";
115 case Alloca: return "alloca";
116 case Load: return "load";
117 case Store: return "store";
118 case GetElementPtr: return "getelementptr";
120 // Convert instructions...
121 case Trunc: return "trunc";
122 case ZExt: return "zext";
123 case SExt: return "sext";
124 case FPTrunc: return "fptrunc";
125 case FPExt: return "fpext";
126 case FPToUI: return "fptoui";
127 case FPToSI: return "fptosi";
128 case UIToFP: return "uitofp";
129 case SIToFP: return "sitofp";
130 case IntToPtr: return "inttoptr";
131 case PtrToInt: return "ptrtoint";
132 case BitCast: return "bitcast";
134 // Other instructions...
135 case ICmp: return "icmp";
136 case FCmp: return "fcmp";
137 case VICmp: return "vicmp";
138 case VFCmp: return "vfcmp";
139 case PHI: return "phi";
140 case Select: return "select";
141 case Call: return "call";
142 case Shl: return "shl";
143 case LShr: return "lshr";
144 case AShr: return "ashr";
145 case VAArg: return "va_arg";
146 case ExtractElement: return "extractelement";
147 case InsertElement: return "insertelement";
148 case ShuffleVector: return "shufflevector";
149 case ExtractValue: return "extractvalue";
150 case InsertValue: return "insertvalue";
152 default: return "<Invalid operator> ";
158 /// isIdenticalTo - Return true if the specified instruction is exactly
159 /// identical to the current one. This means that all operands match and any
160 /// extra information (e.g. load is volatile) agree.
161 bool Instruction::isIdenticalTo(Instruction *I) const {
162 if (getOpcode() != I->getOpcode() ||
163 getNumOperands() != I->getNumOperands() ||
164 getType() != I->getType())
167 // We have two instructions of identical opcode and #operands. Check to see
168 // if all operands are the same.
169 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
170 if (getOperand(i) != I->getOperand(i))
173 // Check special state that is a part of some instructions.
174 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
175 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
176 LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
177 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
178 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
179 SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
180 if (const CmpInst *CI = dyn_cast<CmpInst>(this))
181 return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
182 if (const CallInst *CI = dyn_cast<CallInst>(this))
183 return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
184 CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
185 CI->getAttributes().getRawPointer() ==
186 cast<CallInst>(I)->getAttributes().getRawPointer();
187 if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
188 return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
189 CI->getAttributes().getRawPointer() ==
190 cast<InvokeInst>(I)->getAttributes().getRawPointer();
191 if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this)) {
192 if (IVI->getNumIndices() != cast<InsertValueInst>(I)->getNumIndices())
194 for (unsigned i = 0, e = IVI->getNumIndices(); i != e; ++i)
195 if (IVI->idx_begin()[i] != cast<InsertValueInst>(I)->idx_begin()[i])
199 if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this)) {
200 if (EVI->getNumIndices() != cast<ExtractValueInst>(I)->getNumIndices())
202 for (unsigned i = 0, e = EVI->getNumIndices(); i != e; ++i)
203 if (EVI->idx_begin()[i] != cast<ExtractValueInst>(I)->idx_begin()[i])
212 bool Instruction::isSameOperationAs(Instruction *I) const {
213 if (getOpcode() != I->getOpcode() || getType() != I->getType() ||
214 getNumOperands() != I->getNumOperands())
217 // We have two instructions of identical opcode and #operands. Check to see
218 // if all operands are the same type
219 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
220 if (getOperand(i)->getType() != I->getOperand(i)->getType())
223 // Check special state that is a part of some instructions.
224 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
225 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
226 LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
227 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
228 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
229 SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
230 if (const CmpInst *CI = dyn_cast<CmpInst>(this))
231 return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
232 if (const CallInst *CI = dyn_cast<CallInst>(this))
233 return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
234 CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
235 CI->getAttributes().getRawPointer() ==
236 cast<CallInst>(I)->getAttributes().getRawPointer();
237 if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
238 return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
239 CI->getAttributes().getRawPointer() ==
240 cast<InvokeInst>(I)->getAttributes().getRawPointer();
241 if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this)) {
242 if (IVI->getNumIndices() != cast<InsertValueInst>(I)->getNumIndices())
244 for (unsigned i = 0, e = IVI->getNumIndices(); i != e; ++i)
245 if (IVI->idx_begin()[i] != cast<InsertValueInst>(I)->idx_begin()[i])
249 if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this)) {
250 if (EVI->getNumIndices() != cast<ExtractValueInst>(I)->getNumIndices())
252 for (unsigned i = 0, e = EVI->getNumIndices(); i != e; ++i)
253 if (EVI->idx_begin()[i] != cast<ExtractValueInst>(I)->idx_begin()[i])
261 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
262 /// specified block. Note that PHI nodes are considered to evaluate their
263 /// operands in the corresponding predecessor block.
264 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
265 for (use_const_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
266 // PHI nodes uses values in the corresponding predecessor block. For other
267 // instructions, just check to see whether the parent of the use matches up.
268 const PHINode *PN = dyn_cast<PHINode>(*UI);
270 if (cast<Instruction>(*UI)->getParent() != BB)
275 unsigned UseOperand = UI.getOperandNo();
276 if (PN->getIncomingBlock(UseOperand/2) != BB)
282 /// mayReadFromMemory - Return true if this instruction may read memory.
284 bool Instruction::mayReadFromMemory() const {
285 switch (getOpcode()) {
286 default: return false;
287 case Instruction::Free:
288 case Instruction::VAArg:
289 case Instruction::Load:
291 case Instruction::Call:
292 return !cast<CallInst>(this)->doesNotAccessMemory();
293 case Instruction::Invoke:
294 return !cast<InvokeInst>(this)->doesNotAccessMemory();
295 case Instruction::Store:
296 return cast<StoreInst>(this)->isVolatile();
300 /// mayWriteToMemory - Return true if this instruction may modify memory.
302 bool Instruction::mayWriteToMemory() const {
303 switch (getOpcode()) {
304 default: return false;
305 case Instruction::Free:
306 case Instruction::Store:
307 case Instruction::VAArg:
309 case Instruction::Call:
310 return !cast<CallInst>(this)->onlyReadsMemory();
311 case Instruction::Invoke:
312 return !cast<InvokeInst>(this)->onlyReadsMemory();
313 case Instruction::Load:
314 return cast<LoadInst>(this)->isVolatile();
318 /// isAssociative - Return true if the instruction is associative:
320 /// Associative operators satisfy: x op (y op z) === (x op y) op z)
322 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when not
323 /// applied to floating point types.
325 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
326 if (Opcode == And || Opcode == Or || Opcode == Xor)
329 // Add/Mul reassociate unless they are FP or FP vectors.
330 if (Opcode == Add || Opcode == Mul)
331 return !Ty->isFPOrFPVector();
335 /// isCommutative - Return true if the instruction is commutative:
337 /// Commutative operators satisfy: (x op y) === (y op x)
339 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
340 /// applied to any type.
342 bool Instruction::isCommutative(unsigned op) {
355 /// isTrapping - Return true if the instruction may trap.
357 bool Instruction::isTrapping(unsigned op) {