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 IR library.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/IR/Instruction.h"
15 #include "llvm/IR/CallSite.h"
16 #include "llvm/IR/Constants.h"
17 #include "llvm/IR/Instructions.h"
18 #include "llvm/IR/Module.h"
19 #include "llvm/IR/Operator.h"
20 #include "llvm/IR/Type.h"
23 Instruction::Instruction(Type *ty, unsigned it, Use *Ops, unsigned NumOps,
24 Instruction *InsertBefore)
25 : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(nullptr) {
27 // If requested, insert this instruction into a basic block...
29 BasicBlock *BB = InsertBefore->getParent();
30 assert(BB && "Instruction to insert before is not in a basic block!");
31 BB->getInstList().insert(InsertBefore, this);
35 Instruction::Instruction(Type *ty, unsigned it, Use *Ops, unsigned NumOps,
36 BasicBlock *InsertAtEnd)
37 : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(nullptr) {
39 // append this instruction into the basic block
40 assert(InsertAtEnd && "Basic block to append to may not be NULL!");
41 InsertAtEnd->getInstList().push_back(this);
45 // Out of line virtual method, so the vtable, etc has a home.
46 Instruction::~Instruction() {
47 assert(!Parent && "Instruction still linked in the program!");
48 if (hasMetadataHashEntry())
49 clearMetadataHashEntries();
53 void Instruction::setParent(BasicBlock *P) {
57 const Module *Instruction::getModule() const {
58 return getParent()->getModule();
61 Module *Instruction::getModule() {
62 return getParent()->getModule();
66 void Instruction::removeFromParent() {
67 getParent()->getInstList().remove(this);
70 iplist<Instruction>::iterator Instruction::eraseFromParent() {
71 return getParent()->getInstList().erase(this);
74 /// insertBefore - Insert an unlinked instructions into a basic block
75 /// immediately before the specified instruction.
76 void Instruction::insertBefore(Instruction *InsertPos) {
77 InsertPos->getParent()->getInstList().insert(InsertPos, this);
80 /// insertAfter - Insert an unlinked instructions into a basic block
81 /// immediately after the specified instruction.
82 void Instruction::insertAfter(Instruction *InsertPos) {
83 InsertPos->getParent()->getInstList().insertAfter(InsertPos, this);
86 /// moveBefore - Unlink this instruction from its current basic block and
87 /// insert it into the basic block that MovePos lives in, right before
89 void Instruction::moveBefore(Instruction *MovePos) {
90 MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
94 /// Set or clear the unsafe-algebra flag on this instruction, which must be an
95 /// operator which supports this flag. See LangRef.html for the meaning of this
97 void Instruction::setHasUnsafeAlgebra(bool B) {
98 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
99 cast<FPMathOperator>(this)->setHasUnsafeAlgebra(B);
102 /// Set or clear the NoNaNs flag on this instruction, which must be an operator
103 /// which supports this flag. See LangRef.html for the meaning of this flag.
104 void Instruction::setHasNoNaNs(bool B) {
105 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
106 cast<FPMathOperator>(this)->setHasNoNaNs(B);
109 /// Set or clear the no-infs flag on this instruction, which must be an operator
110 /// which supports this flag. See LangRef.html for the meaning of this flag.
111 void Instruction::setHasNoInfs(bool B) {
112 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
113 cast<FPMathOperator>(this)->setHasNoInfs(B);
116 /// Set or clear the no-signed-zeros flag on this instruction, which must be an
117 /// operator which supports this flag. See LangRef.html for the meaning of this
119 void Instruction::setHasNoSignedZeros(bool B) {
120 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
121 cast<FPMathOperator>(this)->setHasNoSignedZeros(B);
124 /// Set or clear the allow-reciprocal flag on this instruction, which must be an
125 /// operator which supports this flag. See LangRef.html for the meaning of this
127 void Instruction::setHasAllowReciprocal(bool B) {
128 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
129 cast<FPMathOperator>(this)->setHasAllowReciprocal(B);
132 /// Convenience function for setting all the fast-math flags on this
133 /// instruction, which must be an operator which supports these flags. See
134 /// LangRef.html for the meaning of these flats.
135 void Instruction::setFastMathFlags(FastMathFlags FMF) {
136 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
137 cast<FPMathOperator>(this)->setFastMathFlags(FMF);
140 void Instruction::copyFastMathFlags(FastMathFlags FMF) {
141 assert(isa<FPMathOperator>(this) && "copying fast-math flag on invalid op");
142 cast<FPMathOperator>(this)->copyFastMathFlags(FMF);
145 /// Determine whether the unsafe-algebra flag is set.
146 bool Instruction::hasUnsafeAlgebra() const {
147 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
148 return cast<FPMathOperator>(this)->hasUnsafeAlgebra();
151 /// Determine whether the no-NaNs flag is set.
152 bool Instruction::hasNoNaNs() const {
153 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
154 return cast<FPMathOperator>(this)->hasNoNaNs();
157 /// Determine whether the no-infs flag is set.
158 bool Instruction::hasNoInfs() const {
159 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
160 return cast<FPMathOperator>(this)->hasNoInfs();
163 /// Determine whether the no-signed-zeros flag is set.
164 bool Instruction::hasNoSignedZeros() const {
165 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
166 return cast<FPMathOperator>(this)->hasNoSignedZeros();
169 /// Determine whether the allow-reciprocal flag is set.
170 bool Instruction::hasAllowReciprocal() const {
171 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
172 return cast<FPMathOperator>(this)->hasAllowReciprocal();
175 /// Convenience function for getting all the fast-math flags, which must be an
176 /// operator which supports these flags. See LangRef.html for the meaning of
178 FastMathFlags Instruction::getFastMathFlags() const {
179 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
180 return cast<FPMathOperator>(this)->getFastMathFlags();
183 /// Copy I's fast-math flags
184 void Instruction::copyFastMathFlags(const Instruction *I) {
185 copyFastMathFlags(I->getFastMathFlags());
189 const char *Instruction::getOpcodeName(unsigned OpCode) {
192 case Ret: return "ret";
193 case Br: return "br";
194 case Switch: return "switch";
195 case IndirectBr: return "indirectbr";
196 case Invoke: return "invoke";
197 case Resume: return "resume";
198 case Unreachable: return "unreachable";
200 // Standard binary operators...
201 case Add: return "add";
202 case FAdd: return "fadd";
203 case Sub: return "sub";
204 case FSub: return "fsub";
205 case Mul: return "mul";
206 case FMul: return "fmul";
207 case UDiv: return "udiv";
208 case SDiv: return "sdiv";
209 case FDiv: return "fdiv";
210 case URem: return "urem";
211 case SRem: return "srem";
212 case FRem: return "frem";
214 // Logical operators...
215 case And: return "and";
216 case Or : return "or";
217 case Xor: return "xor";
219 // Memory instructions...
220 case Alloca: return "alloca";
221 case Load: return "load";
222 case Store: return "store";
223 case AtomicCmpXchg: return "cmpxchg";
224 case AtomicRMW: return "atomicrmw";
225 case Fence: return "fence";
226 case GetElementPtr: return "getelementptr";
228 // Convert instructions...
229 case Trunc: return "trunc";
230 case ZExt: return "zext";
231 case SExt: return "sext";
232 case FPTrunc: return "fptrunc";
233 case FPExt: return "fpext";
234 case FPToUI: return "fptoui";
235 case FPToSI: return "fptosi";
236 case UIToFP: return "uitofp";
237 case SIToFP: return "sitofp";
238 case IntToPtr: return "inttoptr";
239 case PtrToInt: return "ptrtoint";
240 case BitCast: return "bitcast";
241 case AddrSpaceCast: return "addrspacecast";
243 // Other instructions...
244 case ICmp: return "icmp";
245 case FCmp: return "fcmp";
246 case PHI: return "phi";
247 case Select: return "select";
248 case Call: return "call";
249 case Shl: return "shl";
250 case LShr: return "lshr";
251 case AShr: return "ashr";
252 case VAArg: return "va_arg";
253 case ExtractElement: return "extractelement";
254 case InsertElement: return "insertelement";
255 case ShuffleVector: return "shufflevector";
256 case ExtractValue: return "extractvalue";
257 case InsertValue: return "insertvalue";
258 case LandingPad: return "landingpad";
260 default: return "<Invalid operator> ";
264 /// Return true if both instructions have the same special state
265 /// This must be kept in sync with lib/Transforms/IPO/MergeFunctions.cpp.
266 static bool haveSameSpecialState(const Instruction *I1, const Instruction *I2,
267 bool IgnoreAlignment = false) {
268 assert(I1->getOpcode() == I2->getOpcode() &&
269 "Can not compare special state of different instructions");
271 if (const LoadInst *LI = dyn_cast<LoadInst>(I1))
272 return LI->isVolatile() == cast<LoadInst>(I2)->isVolatile() &&
273 (LI->getAlignment() == cast<LoadInst>(I2)->getAlignment() ||
275 LI->getOrdering() == cast<LoadInst>(I2)->getOrdering() &&
276 LI->getSynchScope() == cast<LoadInst>(I2)->getSynchScope();
277 if (const StoreInst *SI = dyn_cast<StoreInst>(I1))
278 return SI->isVolatile() == cast<StoreInst>(I2)->isVolatile() &&
279 (SI->getAlignment() == cast<StoreInst>(I2)->getAlignment() ||
281 SI->getOrdering() == cast<StoreInst>(I2)->getOrdering() &&
282 SI->getSynchScope() == cast<StoreInst>(I2)->getSynchScope();
283 if (const CmpInst *CI = dyn_cast<CmpInst>(I1))
284 return CI->getPredicate() == cast<CmpInst>(I2)->getPredicate();
285 if (const CallInst *CI = dyn_cast<CallInst>(I1))
286 return CI->isTailCall() == cast<CallInst>(I2)->isTailCall() &&
287 CI->getCallingConv() == cast<CallInst>(I2)->getCallingConv() &&
288 CI->getAttributes() == cast<CallInst>(I2)->getAttributes();
289 if (const InvokeInst *CI = dyn_cast<InvokeInst>(I1))
290 return CI->getCallingConv() == cast<InvokeInst>(I2)->getCallingConv() &&
291 CI->getAttributes() ==
292 cast<InvokeInst>(I2)->getAttributes();
293 if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(I1))
294 return IVI->getIndices() == cast<InsertValueInst>(I2)->getIndices();
295 if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(I1))
296 return EVI->getIndices() == cast<ExtractValueInst>(I2)->getIndices();
297 if (const FenceInst *FI = dyn_cast<FenceInst>(I1))
298 return FI->getOrdering() == cast<FenceInst>(I2)->getOrdering() &&
299 FI->getSynchScope() == cast<FenceInst>(I2)->getSynchScope();
300 if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(I1))
301 return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I2)->isVolatile() &&
302 CXI->isWeak() == cast<AtomicCmpXchgInst>(I2)->isWeak() &&
303 CXI->getSuccessOrdering() ==
304 cast<AtomicCmpXchgInst>(I2)->getSuccessOrdering() &&
305 CXI->getFailureOrdering() ==
306 cast<AtomicCmpXchgInst>(I2)->getFailureOrdering() &&
307 CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I2)->getSynchScope();
308 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(I1))
309 return RMWI->getOperation() == cast<AtomicRMWInst>(I2)->getOperation() &&
310 RMWI->isVolatile() == cast<AtomicRMWInst>(I2)->isVolatile() &&
311 RMWI->getOrdering() == cast<AtomicRMWInst>(I2)->getOrdering() &&
312 RMWI->getSynchScope() == cast<AtomicRMWInst>(I2)->getSynchScope();
317 /// isIdenticalTo - Return true if the specified instruction is exactly
318 /// identical to the current one. This means that all operands match and any
319 /// extra information (e.g. load is volatile) agree.
320 bool Instruction::isIdenticalTo(const Instruction *I) const {
321 return isIdenticalToWhenDefined(I) &&
322 SubclassOptionalData == I->SubclassOptionalData;
325 /// isIdenticalToWhenDefined - This is like isIdenticalTo, except that it
326 /// ignores the SubclassOptionalData flags, which specify conditions
327 /// under which the instruction's result is undefined.
328 bool Instruction::isIdenticalToWhenDefined(const Instruction *I) const {
329 if (getOpcode() != I->getOpcode() ||
330 getNumOperands() != I->getNumOperands() ||
331 getType() != I->getType())
334 // If both instructions have no operands, they are identical.
335 if (getNumOperands() == 0 && I->getNumOperands() == 0)
336 return haveSameSpecialState(this, I);
338 // We have two instructions of identical opcode and #operands. Check to see
339 // if all operands are the same.
340 if (!std::equal(op_begin(), op_end(), I->op_begin()))
343 if (const PHINode *thisPHI = dyn_cast<PHINode>(this)) {
344 const PHINode *otherPHI = cast<PHINode>(I);
345 return std::equal(thisPHI->block_begin(), thisPHI->block_end(),
346 otherPHI->block_begin());
349 return haveSameSpecialState(this, I);
353 // This should be kept in sync with isEquivalentOperation in
354 // lib/Transforms/IPO/MergeFunctions.cpp.
355 bool Instruction::isSameOperationAs(const Instruction *I,
356 unsigned flags) const {
357 bool IgnoreAlignment = flags & CompareIgnoringAlignment;
358 bool UseScalarTypes = flags & CompareUsingScalarTypes;
360 if (getOpcode() != I->getOpcode() ||
361 getNumOperands() != I->getNumOperands() ||
363 getType()->getScalarType() != I->getType()->getScalarType() :
364 getType() != I->getType()))
367 // We have two instructions of identical opcode and #operands. Check to see
368 // if all operands are the same type
369 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
371 getOperand(i)->getType()->getScalarType() !=
372 I->getOperand(i)->getType()->getScalarType() :
373 getOperand(i)->getType() != I->getOperand(i)->getType())
376 return haveSameSpecialState(this, I, IgnoreAlignment);
379 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
380 /// specified block. Note that PHI nodes are considered to evaluate their
381 /// operands in the corresponding predecessor block.
382 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
383 for (const Use &U : uses()) {
384 // PHI nodes uses values in the corresponding predecessor block. For other
385 // instructions, just check to see whether the parent of the use matches up.
386 const Instruction *I = cast<Instruction>(U.getUser());
387 const PHINode *PN = dyn_cast<PHINode>(I);
389 if (I->getParent() != BB)
394 if (PN->getIncomingBlock(U) != BB)
400 /// mayReadFromMemory - Return true if this instruction may read memory.
402 bool Instruction::mayReadFromMemory() const {
403 switch (getOpcode()) {
404 default: return false;
405 case Instruction::VAArg:
406 case Instruction::Load:
407 case Instruction::Fence: // FIXME: refine definition of mayReadFromMemory
408 case Instruction::AtomicCmpXchg:
409 case Instruction::AtomicRMW:
411 case Instruction::Call:
412 return !cast<CallInst>(this)->doesNotAccessMemory();
413 case Instruction::Invoke:
414 return !cast<InvokeInst>(this)->doesNotAccessMemory();
415 case Instruction::Store:
416 return !cast<StoreInst>(this)->isUnordered();
420 /// mayWriteToMemory - Return true if this instruction may modify memory.
422 bool Instruction::mayWriteToMemory() const {
423 switch (getOpcode()) {
424 default: return false;
425 case Instruction::Fence: // FIXME: refine definition of mayWriteToMemory
426 case Instruction::Store:
427 case Instruction::VAArg:
428 case Instruction::AtomicCmpXchg:
429 case Instruction::AtomicRMW:
431 case Instruction::Call:
432 return !cast<CallInst>(this)->onlyReadsMemory();
433 case Instruction::Invoke:
434 return !cast<InvokeInst>(this)->onlyReadsMemory();
435 case Instruction::Load:
436 return !cast<LoadInst>(this)->isUnordered();
440 bool Instruction::isAtomic() const {
441 switch (getOpcode()) {
444 case Instruction::AtomicCmpXchg:
445 case Instruction::AtomicRMW:
446 case Instruction::Fence:
448 case Instruction::Load:
449 return cast<LoadInst>(this)->getOrdering() != NotAtomic;
450 case Instruction::Store:
451 return cast<StoreInst>(this)->getOrdering() != NotAtomic;
455 bool Instruction::mayThrow() const {
456 if (const CallInst *CI = dyn_cast<CallInst>(this))
457 return !CI->doesNotThrow();
458 return isa<ResumeInst>(this);
461 bool Instruction::mayReturn() const {
462 if (const CallInst *CI = dyn_cast<CallInst>(this))
463 return !CI->doesNotReturn();
467 /// isAssociative - Return true if the instruction is associative:
469 /// Associative operators satisfy: x op (y op z) === (x op y) op z
471 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
473 bool Instruction::isAssociative(unsigned Opcode) {
474 return Opcode == And || Opcode == Or || Opcode == Xor ||
475 Opcode == Add || Opcode == Mul;
478 bool Instruction::isAssociative() const {
479 unsigned Opcode = getOpcode();
480 if (isAssociative(Opcode))
486 return cast<FPMathOperator>(this)->hasUnsafeAlgebra();
492 /// isCommutative - Return true if the instruction is commutative:
494 /// Commutative operators satisfy: (x op y) === (y op x)
496 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
497 /// applied to any type.
499 bool Instruction::isCommutative(unsigned op) {
514 /// isIdempotent - Return true if the instruction is idempotent:
516 /// Idempotent operators satisfy: x op x === x
518 /// In LLVM, the And and Or operators are idempotent.
520 bool Instruction::isIdempotent(unsigned Opcode) {
521 return Opcode == And || Opcode == Or;
524 /// isNilpotent - Return true if the instruction is nilpotent:
526 /// Nilpotent operators satisfy: x op x === Id,
528 /// where Id is the identity for the operator, i.e. a constant such that
529 /// x op Id === x and Id op x === x for all x.
531 /// In LLVM, the Xor operator is nilpotent.
533 bool Instruction::isNilpotent(unsigned Opcode) {
534 return Opcode == Xor;
537 Instruction *Instruction::clone() const {
538 Instruction *New = clone_impl();
539 New->SubclassOptionalData = SubclassOptionalData;
543 // Otherwise, enumerate and copy over metadata from the old instruction to the
545 SmallVector<std::pair<unsigned, MDNode *>, 4> TheMDs;
546 getAllMetadataOtherThanDebugLoc(TheMDs);
547 for (const auto &MD : TheMDs)
548 New->setMetadata(MD.first, MD.second);
550 New->setDebugLoc(getDebugLoc());