Chris Lattner | cf3056d | 2003-10-13 03:32:08 +0000 | [diff] [blame] | 1 | //===-- Instruction.cpp - Implement the Instruction class -----------------===// |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | b576c94 | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 4ee451d | 2007-12-29 20:36:04 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | b576c94 | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 9 | // |
| 10 | // This file implements the Instruction class for the VMCore library. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Chris Lattner | 508b19a | 2009-12-29 07:44:16 +0000 | [diff] [blame] | 14 | #include "llvm/Instruction.h" |
Reid Spencer | 45fb3f3 | 2006-11-20 01:22:35 +0000 | [diff] [blame] | 15 | #include "llvm/Type.h" |
Chris Lattner | 38f1455 | 2004-11-30 02:51:53 +0000 | [diff] [blame] | 16 | #include "llvm/Instructions.h" |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 17 | #include "llvm/Constants.h" |
Victor Hernandez | 88d9839 | 2009-09-18 19:20:02 +0000 | [diff] [blame] | 18 | #include "llvm/Module.h" |
Duncan Sands | a3355ff | 2007-12-03 20:06:50 +0000 | [diff] [blame] | 19 | #include "llvm/Support/CallSite.h" |
Reid Spencer | 551ccae | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 20 | #include "llvm/Support/LeakDetector.h" |
Chris Lattner | 4b74c83 | 2003-11-20 17:45:12 +0000 | [diff] [blame] | 21 | using namespace llvm; |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 22 | |
Chris Lattner | db125cf | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 23 | Instruction::Instruction(Type *ty, unsigned it, Use *Ops, unsigned NumOps, |
Chris Lattner | 910c80a | 2007-02-24 00:55:48 +0000 | [diff] [blame] | 24 | Instruction *InsertBefore) |
Chris Lattner | 61336ae | 2010-04-01 05:23:13 +0000 | [diff] [blame] | 25 | : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) { |
Chris Lattner | d1e693f | 2002-09-08 18:59:35 +0000 | [diff] [blame] | 26 | // Make sure that we get added to a basicblock |
| 27 | LeakDetector::addGarbageObject(this); |
Chris Lattner | 2aa8311 | 2002-09-10 15:45:53 +0000 | [diff] [blame] | 28 | |
| 29 | // If requested, insert this instruction into a basic block... |
| 30 | if (InsertBefore) { |
| 31 | assert(InsertBefore->getParent() && |
| 32 | "Instruction to insert before is not in a basic block!"); |
| 33 | InsertBefore->getParent()->getInstList().insert(InsertBefore, this); |
| 34 | } |
Chris Lattner | 0095054 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 35 | } |
| 36 | |
Chris Lattner | db125cf | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 37 | Instruction::Instruction(Type *ty, unsigned it, Use *Ops, unsigned NumOps, |
Chris Lattner | 910c80a | 2007-02-24 00:55:48 +0000 | [diff] [blame] | 38 | BasicBlock *InsertAtEnd) |
Chris Lattner | 61336ae | 2010-04-01 05:23:13 +0000 | [diff] [blame] | 39 | : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) { |
Chris Lattner | 96d83f6 | 2005-01-29 00:35:33 +0000 | [diff] [blame] | 40 | // Make sure that we get added to a basicblock |
| 41 | LeakDetector::addGarbageObject(this); |
Alkis Evlogimenos | e5828f1 | 2004-05-26 21:41:09 +0000 | [diff] [blame] | 42 | |
| 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); |
Chris Lattner | f00042a | 2007-02-13 07:54:42 +0000 | [diff] [blame] | 46 | } |
| 47 | |
| 48 | |
Chris Lattner | 70aa33e | 2006-06-21 16:53:47 +0000 | [diff] [blame] | 49 | // Out of line virtual method, so the vtable, etc has a home. |
Gordon Henriksen | afba8fe | 2007-12-10 02:14:30 +0000 | [diff] [blame] | 50 | Instruction::~Instruction() { |
Devang Patel | f9e0a22 | 2009-09-24 16:19:11 +0000 | [diff] [blame] | 51 | assert(Parent == 0 && "Instruction still linked in the program!"); |
Dan Gohman | 4f1be4a | 2010-07-20 22:25:04 +0000 | [diff] [blame] | 52 | if (hasMetadataHashEntry()) |
| 53 | clearMetadataHashEntries(); |
Chris Lattner | 70aa33e | 2006-06-21 16:53:47 +0000 | [diff] [blame] | 54 | } |
| 55 | |
| 56 | |
Chris Lattner | bded132 | 2002-09-06 21:33:15 +0000 | [diff] [blame] | 57 | void Instruction::setParent(BasicBlock *P) { |
Chris Lattner | 786993c | 2004-02-04 01:06:38 +0000 | [diff] [blame] | 58 | if (getParent()) { |
| 59 | if (!P) LeakDetector::addGarbageObject(this); |
| 60 | } else { |
| 61 | if (P) LeakDetector::removeGarbageObject(this); |
| 62 | } |
Chris Lattner | d1e693f | 2002-09-08 18:59:35 +0000 | [diff] [blame] | 63 | |
Chris Lattner | bded132 | 2002-09-06 21:33:15 +0000 | [diff] [blame] | 64 | Parent = P; |
| 65 | } |
| 66 | |
Chris Lattner | 4b83380 | 2004-10-11 22:21:39 +0000 | [diff] [blame] | 67 | void Instruction::removeFromParent() { |
| 68 | getParent()->getInstList().remove(this); |
| 69 | } |
| 70 | |
| 71 | void Instruction::eraseFromParent() { |
| 72 | getParent()->getInstList().erase(this); |
| 73 | } |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 74 | |
Owen Anderson | 26bb50a | 2008-06-17 18:29:27 +0000 | [diff] [blame] | 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); |
| 79 | } |
| 80 | |
Chris Lattner | 3ff704f | 2009-01-13 07:43:51 +0000 | [diff] [blame] | 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); |
| 85 | } |
| 86 | |
Chris Lattner | 0fe34d8 | 2005-08-08 05:21:50 +0000 | [diff] [blame] | 87 | /// moveBefore - Unlink this instruction from its current basic block and |
| 88 | /// insert it into the basic block that MovePos lives in, right before |
| 89 | /// MovePos. |
| 90 | void Instruction::moveBefore(Instruction *MovePos) { |
| 91 | MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(), |
| 92 | this); |
| 93 | } |
| 94 | |
| 95 | |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 96 | const char *Instruction::getOpcodeName(unsigned OpCode) { |
| 97 | switch (OpCode) { |
| 98 | // Terminators |
Chris Lattner | 0513e9f | 2002-08-14 18:18:02 +0000 | [diff] [blame] | 99 | case Ret: return "ret"; |
| 100 | case Br: return "br"; |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 101 | case Switch: return "switch"; |
Chris Lattner | ab21db7 | 2009-10-28 00:19:10 +0000 | [diff] [blame] | 102 | case IndirectBr: return "indirectbr"; |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 103 | case Invoke: return "invoke"; |
Bill Wendling | dccc03b | 2011-07-31 06:30:59 +0000 | [diff] [blame] | 104 | case Resume: return "resume"; |
Chris Lattner | a6ce898 | 2003-09-08 18:54:36 +0000 | [diff] [blame] | 105 | case Unwind: return "unwind"; |
Chris Lattner | b976e66 | 2004-10-16 18:08:06 +0000 | [diff] [blame] | 106 | case Unreachable: return "unreachable"; |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 107 | |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 108 | // Standard binary operators... |
| 109 | case Add: return "add"; |
Dan Gohman | ae3a0be | 2009-06-04 22:49:04 +0000 | [diff] [blame] | 110 | case FAdd: return "fadd"; |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 111 | case Sub: return "sub"; |
Dan Gohman | ae3a0be | 2009-06-04 22:49:04 +0000 | [diff] [blame] | 112 | case FSub: return "fsub"; |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 113 | case Mul: return "mul"; |
Dan Gohman | ae3a0be | 2009-06-04 22:49:04 +0000 | [diff] [blame] | 114 | case FMul: return "fmul"; |
Reid Spencer | 1628cec | 2006-10-26 06:15:43 +0000 | [diff] [blame] | 115 | case UDiv: return "udiv"; |
| 116 | case SDiv: return "sdiv"; |
| 117 | case FDiv: return "fdiv"; |
Reid Spencer | 0a783f7 | 2006-11-02 01:53:59 +0000 | [diff] [blame] | 118 | case URem: return "urem"; |
| 119 | case SRem: return "srem"; |
| 120 | case FRem: return "frem"; |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 121 | |
| 122 | // Logical operators... |
| 123 | case And: return "and"; |
| 124 | case Or : return "or"; |
| 125 | case Xor: return "xor"; |
| 126 | |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 127 | // Memory instructions... |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 128 | case Alloca: return "alloca"; |
| 129 | case Load: return "load"; |
| 130 | case Store: return "store"; |
Eli Friedman | ff03048 | 2011-07-28 21:48:00 +0000 | [diff] [blame] | 131 | case AtomicCmpXchg: return "cmpxchg"; |
| 132 | case AtomicRMW: return "atomicrmw"; |
Eli Friedman | 47f3513 | 2011-07-25 23:16:38 +0000 | [diff] [blame] | 133 | case Fence: return "fence"; |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 134 | case GetElementPtr: return "getelementptr"; |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 135 | |
Reid Spencer | 3da59db | 2006-11-27 01:05:10 +0000 | [diff] [blame] | 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"; |
| 149 | |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 150 | // Other instructions... |
Reid Spencer | 74f1642 | 2006-12-03 06:27:29 +0000 | [diff] [blame] | 151 | case ICmp: return "icmp"; |
| 152 | case FCmp: return "fcmp"; |
Reid Spencer | 3da59db | 2006-11-27 01:05:10 +0000 | [diff] [blame] | 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"; |
Robert Bocchino | b52ee7f | 2006-01-10 19:05:34 +0000 | [diff] [blame] | 160 | case ExtractElement: return "extractelement"; |
Reid Spencer | 3da59db | 2006-11-27 01:05:10 +0000 | [diff] [blame] | 161 | case InsertElement: return "insertelement"; |
| 162 | case ShuffleVector: return "shufflevector"; |
Matthijs Kooijman | 74b5e07 | 2008-05-30 10:31:54 +0000 | [diff] [blame] | 163 | case ExtractValue: return "extractvalue"; |
| 164 | case InsertValue: return "insertvalue"; |
Chris Lattner | 8f77dae | 2003-05-08 02:44:12 +0000 | [diff] [blame] | 165 | |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 166 | default: return "<Invalid operator> "; |
| 167 | } |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 168 | |
Vikram S. Adve | c105645 | 2002-07-14 23:09:40 +0000 | [diff] [blame] | 169 | return 0; |
| 170 | } |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 171 | |
Chris Lattner | 38f1455 | 2004-11-30 02:51:53 +0000 | [diff] [blame] | 172 | /// isIdenticalTo - Return true if the specified instruction is exactly |
| 173 | /// identical to the current one. This means that all operands match and any |
| 174 | /// extra information (e.g. load is volatile) agree. |
Chris Lattner | e3a0884 | 2008-11-27 08:39:18 +0000 | [diff] [blame] | 175 | bool Instruction::isIdenticalTo(const Instruction *I) const { |
Dan Gohman | 75b0eda | 2009-08-25 22:24:20 +0000 | [diff] [blame] | 176 | return isIdenticalToWhenDefined(I) && |
Dan Gohman | 58cfa3b | 2009-08-25 22:11:20 +0000 | [diff] [blame] | 177 | SubclassOptionalData == I->SubclassOptionalData; |
| 178 | } |
| 179 | |
Dan Gohman | 75b0eda | 2009-08-25 22:24:20 +0000 | [diff] [blame] | 180 | /// isIdenticalToWhenDefined - This is like isIdenticalTo, except that it |
Dan Gohman | 58cfa3b | 2009-08-25 22:11:20 +0000 | [diff] [blame] | 181 | /// ignores the SubclassOptionalData flags, which specify conditions |
| 182 | /// under which the instruction's result is undefined. |
| 183 | bool Instruction::isIdenticalToWhenDefined(const Instruction *I) const { |
Chris Lattner | 38f1455 | 2004-11-30 02:51:53 +0000 | [diff] [blame] | 184 | if (getOpcode() != I->getOpcode() || |
| 185 | getNumOperands() != I->getNumOperands() || |
| 186 | getType() != I->getType()) |
| 187 | return false; |
| 188 | |
| 189 | // We have two instructions of identical opcode and #operands. Check to see |
| 190 | // if all operands are the same. |
| 191 | for (unsigned i = 0, e = getNumOperands(); i != e; ++i) |
| 192 | if (getOperand(i) != I->getOperand(i)) |
| 193 | return false; |
| 194 | |
| 195 | // Check special state that is a part of some instructions. |
| 196 | if (const LoadInst *LI = dyn_cast<LoadInst>(this)) |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 197 | return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() && |
| 198 | LI->getAlignment() == cast<LoadInst>(I)->getAlignment(); |
Chris Lattner | 38f1455 | 2004-11-30 02:51:53 +0000 | [diff] [blame] | 199 | if (const StoreInst *SI = dyn_cast<StoreInst>(this)) |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 200 | return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() && |
| 201 | SI->getAlignment() == cast<StoreInst>(I)->getAlignment(); |
Reid Spencer | e4d87aa | 2006-12-23 06:05:41 +0000 | [diff] [blame] | 202 | if (const CmpInst *CI = dyn_cast<CmpInst>(this)) |
| 203 | return CI->getPredicate() == cast<CmpInst>(I)->getPredicate(); |
Chris Lattner | ddb6db4 | 2005-05-06 05:51:46 +0000 | [diff] [blame] | 204 | if (const CallInst *CI = dyn_cast<CallInst>(this)) |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 205 | return CI->isTailCall() == cast<CallInst>(I)->isTailCall() && |
| 206 | CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() && |
Nick Lewycky | f6c63c2 | 2011-01-26 09:23:19 +0000 | [diff] [blame] | 207 | CI->getAttributes() == cast<CallInst>(I)->getAttributes(); |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 208 | if (const InvokeInst *CI = dyn_cast<InvokeInst>(this)) |
Nick Lewycky | 41fe88b | 2008-10-27 07:28:44 +0000 | [diff] [blame] | 209 | return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() && |
Nick Lewycky | f6c63c2 | 2011-01-26 09:23:19 +0000 | [diff] [blame] | 210 | CI->getAttributes() == cast<InvokeInst>(I)->getAttributes(); |
Jay Foad | fc6d3a4 | 2011-07-13 10:26:04 +0000 | [diff] [blame] | 211 | if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this)) |
| 212 | return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices(); |
| 213 | if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this)) |
| 214 | return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices(); |
Eli Friedman | 8a552bb | 2011-07-27 01:08:30 +0000 | [diff] [blame] | 215 | if (const FenceInst *FI = dyn_cast<FenceInst>(this)) |
| 216 | return FI->getOrdering() == cast<FenceInst>(FI)->getOrdering() && |
| 217 | FI->getSynchScope() == cast<FenceInst>(FI)->getSynchScope(); |
Eli Friedman | 55ba816 | 2011-07-29 03:05:32 +0000 | [diff] [blame] | 218 | if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(this)) |
| 219 | return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I)->isVolatile() && |
| 220 | CXI->getOrdering() == cast<AtomicCmpXchgInst>(I)->getOrdering() && |
| 221 | CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I)->getSynchScope(); |
| 222 | if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(this)) |
| 223 | return RMWI->getOperation() == cast<AtomicRMWInst>(I)->getOperation() && |
| 224 | RMWI->isVolatile() == cast<AtomicRMWInst>(I)->isVolatile() && |
| 225 | RMWI->getOrdering() == cast<AtomicRMWInst>(I)->getOrdering() && |
| 226 | RMWI->getSynchScope() == cast<AtomicRMWInst>(I)->getSynchScope(); |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 227 | |
Chris Lattner | 38f1455 | 2004-11-30 02:51:53 +0000 | [diff] [blame] | 228 | return true; |
| 229 | } |
| 230 | |
Reid Spencer | e4d87aa | 2006-12-23 06:05:41 +0000 | [diff] [blame] | 231 | // isSameOperationAs |
Dan Gohman | 194ae78 | 2009-06-12 19:03:05 +0000 | [diff] [blame] | 232 | // This should be kept in sync with isEquivalentOperation in |
| 233 | // lib/Transforms/IPO/MergeFunctions.cpp. |
Chris Lattner | e3a0884 | 2008-11-27 08:39:18 +0000 | [diff] [blame] | 234 | bool Instruction::isSameOperationAs(const Instruction *I) const { |
Dan Gohman | 194ae78 | 2009-06-12 19:03:05 +0000 | [diff] [blame] | 235 | if (getOpcode() != I->getOpcode() || |
| 236 | getNumOperands() != I->getNumOperands() || |
| 237 | getType() != I->getType()) |
Reid Spencer | e4d87aa | 2006-12-23 06:05:41 +0000 | [diff] [blame] | 238 | return false; |
| 239 | |
| 240 | // We have two instructions of identical opcode and #operands. Check to see |
| 241 | // if all operands are the same type |
| 242 | for (unsigned i = 0, e = getNumOperands(); i != e; ++i) |
| 243 | if (getOperand(i)->getType() != I->getOperand(i)->getType()) |
| 244 | return false; |
| 245 | |
| 246 | // Check special state that is a part of some instructions. |
| 247 | if (const LoadInst *LI = dyn_cast<LoadInst>(this)) |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 248 | return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() && |
| 249 | LI->getAlignment() == cast<LoadInst>(I)->getAlignment(); |
Reid Spencer | e4d87aa | 2006-12-23 06:05:41 +0000 | [diff] [blame] | 250 | if (const StoreInst *SI = dyn_cast<StoreInst>(this)) |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 251 | return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() && |
| 252 | SI->getAlignment() == cast<StoreInst>(I)->getAlignment(); |
Reid Spencer | e4d87aa | 2006-12-23 06:05:41 +0000 | [diff] [blame] | 253 | if (const CmpInst *CI = dyn_cast<CmpInst>(this)) |
| 254 | return CI->getPredicate() == cast<CmpInst>(I)->getPredicate(); |
| 255 | if (const CallInst *CI = dyn_cast<CallInst>(this)) |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 256 | return CI->isTailCall() == cast<CallInst>(I)->isTailCall() && |
| 257 | CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() && |
Nick Lewycky | f6c63c2 | 2011-01-26 09:23:19 +0000 | [diff] [blame] | 258 | CI->getAttributes() == cast<CallInst>(I)->getAttributes(); |
Dan Gohman | 9a8af45 | 2008-10-16 01:24:45 +0000 | [diff] [blame] | 259 | if (const InvokeInst *CI = dyn_cast<InvokeInst>(this)) |
Nick Lewycky | 41fe88b | 2008-10-27 07:28:44 +0000 | [diff] [blame] | 260 | return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() && |
Nick Lewycky | f6c63c2 | 2011-01-26 09:23:19 +0000 | [diff] [blame] | 261 | CI->getAttributes() == |
| 262 | cast<InvokeInst>(I)->getAttributes(); |
Jay Foad | fc6d3a4 | 2011-07-13 10:26:04 +0000 | [diff] [blame] | 263 | if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this)) |
| 264 | return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices(); |
| 265 | if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this)) |
| 266 | return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices(); |
Eli Friedman | 8a552bb | 2011-07-27 01:08:30 +0000 | [diff] [blame] | 267 | if (const FenceInst *FI = dyn_cast<FenceInst>(this)) |
Eli Friedman | 55ba816 | 2011-07-29 03:05:32 +0000 | [diff] [blame] | 268 | return FI->getOrdering() == cast<FenceInst>(I)->getOrdering() && |
| 269 | FI->getSynchScope() == cast<FenceInst>(I)->getSynchScope(); |
| 270 | if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(this)) |
| 271 | return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I)->isVolatile() && |
| 272 | CXI->getOrdering() == cast<AtomicCmpXchgInst>(I)->getOrdering() && |
| 273 | CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I)->getSynchScope(); |
| 274 | if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(this)) |
| 275 | return RMWI->getOperation() == cast<AtomicRMWInst>(I)->getOperation() && |
| 276 | RMWI->isVolatile() == cast<AtomicRMWInst>(I)->isVolatile() && |
| 277 | RMWI->getOrdering() == cast<AtomicRMWInst>(I)->getOrdering() && |
| 278 | RMWI->getSynchScope() == cast<AtomicRMWInst>(I)->getSynchScope(); |
Reid Spencer | e4d87aa | 2006-12-23 06:05:41 +0000 | [diff] [blame] | 279 | |
| 280 | return true; |
| 281 | } |
| 282 | |
Chris Lattner | 7ae40e7 | 2008-04-20 22:11:30 +0000 | [diff] [blame] | 283 | /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the |
| 284 | /// specified block. Note that PHI nodes are considered to evaluate their |
| 285 | /// operands in the corresponding predecessor block. |
| 286 | bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const { |
Gabor Greif | 60ad781 | 2010-03-25 23:06:16 +0000 | [diff] [blame] | 287 | for (const_use_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) { |
Chris Lattner | 7ae40e7 | 2008-04-20 22:11:30 +0000 | [diff] [blame] | 288 | // PHI nodes uses values in the corresponding predecessor block. For other |
| 289 | // instructions, just check to see whether the parent of the use matches up. |
Gabor Greif | a8b9df7 | 2010-07-12 10:36:48 +0000 | [diff] [blame] | 290 | const User *U = *UI; |
| 291 | const PHINode *PN = dyn_cast<PHINode>(U); |
Chris Lattner | 7ae40e7 | 2008-04-20 22:11:30 +0000 | [diff] [blame] | 292 | if (PN == 0) { |
Gabor Greif | a8b9df7 | 2010-07-12 10:36:48 +0000 | [diff] [blame] | 293 | if (cast<Instruction>(U)->getParent() != BB) |
Chris Lattner | 7ae40e7 | 2008-04-20 22:11:30 +0000 | [diff] [blame] | 294 | return true; |
| 295 | continue; |
| 296 | } |
Daniel Dunbar | a279bc3 | 2009-09-20 02:20:51 +0000 | [diff] [blame] | 297 | |
Gabor Greif | a36791d | 2009-01-23 19:40:15 +0000 | [diff] [blame] | 298 | if (PN->getIncomingBlock(UI) != BB) |
Chris Lattner | 7ae40e7 | 2008-04-20 22:11:30 +0000 | [diff] [blame] | 299 | return true; |
| 300 | } |
Daniel Dunbar | a279bc3 | 2009-09-20 02:20:51 +0000 | [diff] [blame] | 301 | return false; |
Chris Lattner | 7ae40e7 | 2008-04-20 22:11:30 +0000 | [diff] [blame] | 302 | } |
| 303 | |
Chris Lattner | d96288a | 2008-05-08 17:16:51 +0000 | [diff] [blame] | 304 | /// mayReadFromMemory - Return true if this instruction may read memory. |
| 305 | /// |
| 306 | bool Instruction::mayReadFromMemory() const { |
| 307 | switch (getOpcode()) { |
| 308 | default: return false; |
Chris Lattner | d96288a | 2008-05-08 17:16:51 +0000 | [diff] [blame] | 309 | case Instruction::VAArg: |
Chris Lattner | 748118d | 2008-05-08 21:58:49 +0000 | [diff] [blame] | 310 | case Instruction::Load: |
Eli Friedman | 8a552bb | 2011-07-27 01:08:30 +0000 | [diff] [blame] | 311 | case Instruction::Fence: // FIXME: refine definition of mayReadFromMemory |
Eli Friedman | 55ba816 | 2011-07-29 03:05:32 +0000 | [diff] [blame] | 312 | case Instruction::AtomicCmpXchg: |
| 313 | case Instruction::AtomicRMW: |
Chris Lattner | d96288a | 2008-05-08 17:16:51 +0000 | [diff] [blame] | 314 | return true; |
| 315 | case Instruction::Call: |
| 316 | return !cast<CallInst>(this)->doesNotAccessMemory(); |
| 317 | case Instruction::Invoke: |
| 318 | return !cast<InvokeInst>(this)->doesNotAccessMemory(); |
Chris Lattner | 748118d | 2008-05-08 21:58:49 +0000 | [diff] [blame] | 319 | case Instruction::Store: |
| 320 | return cast<StoreInst>(this)->isVolatile(); |
Chris Lattner | d96288a | 2008-05-08 17:16:51 +0000 | [diff] [blame] | 321 | } |
| 322 | } |
Chris Lattner | 7ae40e7 | 2008-04-20 22:11:30 +0000 | [diff] [blame] | 323 | |
Chris Lattner | bb5493d | 2007-02-15 23:15:00 +0000 | [diff] [blame] | 324 | /// mayWriteToMemory - Return true if this instruction may modify memory. |
| 325 | /// |
| 326 | bool Instruction::mayWriteToMemory() const { |
| 327 | switch (getOpcode()) { |
| 328 | default: return false; |
Eli Friedman | 8a552bb | 2011-07-27 01:08:30 +0000 | [diff] [blame] | 329 | case Instruction::Fence: // FIXME: refine definition of mayWriteToMemory |
Duncan Sands | a3355ff | 2007-12-03 20:06:50 +0000 | [diff] [blame] | 330 | case Instruction::Store: |
Chris Lattner | bb5493d | 2007-02-15 23:15:00 +0000 | [diff] [blame] | 331 | case Instruction::VAArg: |
Eli Friedman | 55ba816 | 2011-07-29 03:05:32 +0000 | [diff] [blame] | 332 | case Instruction::AtomicCmpXchg: |
| 333 | case Instruction::AtomicRMW: |
Chris Lattner | bb5493d | 2007-02-15 23:15:00 +0000 | [diff] [blame] | 334 | return true; |
| 335 | case Instruction::Call: |
Duncan Sands | a3355ff | 2007-12-03 20:06:50 +0000 | [diff] [blame] | 336 | return !cast<CallInst>(this)->onlyReadsMemory(); |
Chris Lattner | d96288a | 2008-05-08 17:16:51 +0000 | [diff] [blame] | 337 | case Instruction::Invoke: |
| 338 | return !cast<InvokeInst>(this)->onlyReadsMemory(); |
Chris Lattner | bb5493d | 2007-02-15 23:15:00 +0000 | [diff] [blame] | 339 | case Instruction::Load: |
| 340 | return cast<LoadInst>(this)->isVolatile(); |
| 341 | } |
| 342 | } |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 343 | |
Duncan Sands | 7af1c78 | 2009-05-06 06:49:50 +0000 | [diff] [blame] | 344 | /// mayThrow - Return true if this instruction may throw an exception. |
| 345 | /// |
| 346 | bool Instruction::mayThrow() const { |
| 347 | if (const CallInst *CI = dyn_cast<CallInst>(this)) |
| 348 | return !CI->doesNotThrow(); |
| 349 | return false; |
| 350 | } |
| 351 | |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 352 | /// isAssociative - Return true if the instruction is associative: |
| 353 | /// |
Dan Gohman | ae3a0be | 2009-06-04 22:49:04 +0000 | [diff] [blame] | 354 | /// Associative operators satisfy: x op (y op z) === (x op y) op z |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 355 | /// |
Dan Gohman | ae3a0be | 2009-06-04 22:49:04 +0000 | [diff] [blame] | 356 | /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative. |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 357 | /// |
Duncan Sands | 0d7ce5f | 2010-12-20 13:10:23 +0000 | [diff] [blame] | 358 | bool Instruction::isAssociative(unsigned Opcode) { |
Dan Gohman | ae3a0be | 2009-06-04 22:49:04 +0000 | [diff] [blame] | 359 | return Opcode == And || Opcode == Or || Opcode == Xor || |
| 360 | Opcode == Add || Opcode == Mul; |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 361 | } |
| 362 | |
| 363 | /// isCommutative - Return true if the instruction is commutative: |
| 364 | /// |
Misha Brukman | 6b63452 | 2003-10-10 17:54:14 +0000 | [diff] [blame] | 365 | /// Commutative operators satisfy: (x op y) === (y op x) |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 366 | /// |
| 367 | /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when |
| 368 | /// applied to any type. |
| 369 | /// |
| 370 | bool Instruction::isCommutative(unsigned op) { |
| 371 | switch (op) { |
| 372 | case Add: |
Dan Gohman | ae3a0be | 2009-06-04 22:49:04 +0000 | [diff] [blame] | 373 | case FAdd: |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 374 | case Mul: |
Dan Gohman | ae3a0be | 2009-06-04 22:49:04 +0000 | [diff] [blame] | 375 | case FMul: |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 376 | case And: |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 377 | case Or: |
| 378 | case Xor: |
Chris Lattner | f2da724 | 2002-10-31 04:14:01 +0000 | [diff] [blame] | 379 | return true; |
| 380 | default: |
| 381 | return false; |
| 382 | } |
| 383 | } |
Tanya Lattner | 741bb00 | 2003-07-31 04:05:50 +0000 | [diff] [blame] | 384 | |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 385 | bool Instruction::isSafeToSpeculativelyExecute() const { |
| 386 | for (unsigned i = 0, e = getNumOperands(); i != e; ++i) |
| 387 | if (Constant *C = dyn_cast<Constant>(getOperand(i))) |
| 388 | if (C->canTrap()) |
| 389 | return false; |
| 390 | |
| 391 | switch (getOpcode()) { |
Tanya Lattner | 741bb00 | 2003-07-31 04:05:50 +0000 | [diff] [blame] | 392 | default: |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 393 | return true; |
| 394 | case UDiv: |
| 395 | case URem: { |
| 396 | // x / y is undefined if y == 0, but calcuations like x / 3 are safe. |
| 397 | ConstantInt *Op = dyn_cast<ConstantInt>(getOperand(1)); |
| 398 | return Op && !Op->isNullValue(); |
| 399 | } |
| 400 | case SDiv: |
| 401 | case SRem: { |
| 402 | // x / y is undefined if y == 0, and might be undefined if y == -1, |
| 403 | // but calcuations like x / 3 are safe. |
| 404 | ConstantInt *Op = dyn_cast<ConstantInt>(getOperand(1)); |
| 405 | return Op && !Op->isNullValue() && !Op->isAllOnesValue(); |
| 406 | } |
| 407 | case Load: { |
Dan Gohman | 4d70a29 | 2010-11-11 21:23:25 +0000 | [diff] [blame] | 408 | const LoadInst *LI = cast<LoadInst>(this); |
| 409 | if (LI->isVolatile()) |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 410 | return false; |
Dan Gohman | 4d70a29 | 2010-11-11 21:23:25 +0000 | [diff] [blame] | 411 | return LI->getPointerOperand()->isDereferenceablePointer(); |
Tanya Lattner | 741bb00 | 2003-07-31 04:05:50 +0000 | [diff] [blame] | 412 | } |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 413 | case Call: |
| 414 | return false; // The called function could have undefined behavior or |
| 415 | // side-effects. |
| 416 | // FIXME: We should special-case some intrinsics (bswap, |
| 417 | // overflow-checking arithmetic, etc.) |
| 418 | case VAArg: |
| 419 | case Alloca: |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 420 | case Invoke: |
| 421 | case PHI: |
| 422 | case Store: |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 423 | case Ret: |
| 424 | case Br: |
Dan Gohman | 108e370 | 2010-07-02 00:35:34 +0000 | [diff] [blame] | 425 | case IndirectBr: |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 426 | case Switch: |
| 427 | case Unwind: |
| 428 | case Unreachable: |
Eli Friedman | 8a552bb | 2011-07-27 01:08:30 +0000 | [diff] [blame] | 429 | case Fence: |
Eli Friedman | 0b79a77 | 2009-07-17 04:28:42 +0000 | [diff] [blame] | 430 | return false; // Misc instructions which have effects |
| 431 | } |
Tanya Lattner | 741bb00 | 2003-07-31 04:05:50 +0000 | [diff] [blame] | 432 | } |
Devang Patel | 50b6e33 | 2009-10-27 22:16:29 +0000 | [diff] [blame] | 433 | |
| 434 | Instruction *Instruction::clone() const { |
| 435 | Instruction *New = clone_impl(); |
| 436 | New->SubclassOptionalData = SubclassOptionalData; |
Chris Lattner | 508b19a | 2009-12-29 07:44:16 +0000 | [diff] [blame] | 437 | if (!hasMetadata()) |
| 438 | return New; |
| 439 | |
| 440 | // Otherwise, enumerate and copy over metadata from the old instruction to the |
| 441 | // new one. |
| 442 | SmallVector<std::pair<unsigned, MDNode*>, 4> TheMDs; |
Chris Lattner | 4baa510 | 2011-07-14 18:57:51 +0000 | [diff] [blame] | 443 | getAllMetadataOtherThanDebugLoc(TheMDs); |
Chris Lattner | 508b19a | 2009-12-29 07:44:16 +0000 | [diff] [blame] | 444 | for (unsigned i = 0, e = TheMDs.size(); i != e; ++i) |
| 445 | New->setMetadata(TheMDs[i].first, TheMDs[i].second); |
Chris Lattner | 4baa510 | 2011-07-14 18:57:51 +0000 | [diff] [blame] | 446 | |
| 447 | New->setDebugLoc(getDebugLoc()); |
Devang Patel | 50b6e33 | 2009-10-27 22:16:29 +0000 | [diff] [blame] | 448 | return New; |
| 449 | } |