lib/VMCore/Instruction.cpp

   1 //===-- Instruction.cpp - Implement the Instruction class -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the Instruction class for the VMCore library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  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"
  21 using namespace llvm;
  22
  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);
  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   }
  35 }
  36
  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);
  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);
  46 }
  47
  48
  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();
  54 }
  55
  56
  57 void Instruction::setParent(BasicBlock *P) {
  58   if (getParent()) {
  59     if (!P) LeakDetector::addGarbageObject(this);
  60   } else {
  61     if (P) LeakDetector::removeGarbageObject(this);
  62   }
  63
  64   Parent = P;
  65 }
  66
  67 void Instruction::removeFromParent() {
  68   getParent()->getInstList().remove(this);
  69 }
  70
  71 void Instruction::eraseFromParent() {
  72   getParent()->getInstList().erase(this);
  73 }
  74
  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
  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
  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
  96 const char *Instruction::getOpcodeName(unsigned OpCode) {
  97   switch (OpCode) {
  98   // Terminators
  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 Unwind: return "unwind";
 105   case Unreachable: return "unreachable";
 106
 107   // Standard binary operators...
 108   case Add: return "add";
 109   case FAdd: return "fadd";
 110   case Sub: return "sub";
 111   case FSub: return "fsub";
 112   case Mul: return "mul";
 113   case FMul: return "fmul";
 114   case UDiv: return "udiv";
 115   case SDiv: return "sdiv";
 116   case FDiv: return "fdiv";
 117   case URem: return "urem";
 118   case SRem: return "srem";
 119   case FRem: return "frem";
 120
 121   // Logical operators...
 122   case And: return "and";
 123   case Or : return "or";
 124   case Xor: return "xor";
 125
 126   // Memory instructions...
 127   case Alloca:        return "alloca";
 128   case Load:          return "load";
 129   case Store:         return "store";
 130   case AtomicCmpXchg: return "cmpxchg";
 131   case AtomicRMW:     return "atomicrmw";
 132   case Fence:         return "fence";
 133   case GetElementPtr: return "getelementptr";
 134
 135   // Convert instructions...
 136   case Trunc:     return "trunc";
 137   case ZExt:      return "zext";
 138   case SExt:      return "sext";
 139   case FPTrunc:   return "fptrunc";
 140   case FPExt:     return "fpext";
 141   case FPToUI:    return "fptoui";
 142   case FPToSI:    return "fptosi";
 143   case UIToFP:    return "uitofp";
 144   case SIToFP:    return "sitofp";
 145   case IntToPtr:  return "inttoptr";
 146   case PtrToInt:  return "ptrtoint";
 147   case BitCast:   return "bitcast";
 148
 149   // Other instructions...
 150   case ICmp:           return "icmp";
 151   case FCmp:           return "fcmp";
 152   case PHI:            return "phi";
 153   case Select:         return "select";
 154   case Call:           return "call";
 155   case Shl:            return "shl";
 156   case LShr:           return "lshr";
 157   case AShr:           return "ashr";
 158   case VAArg:          return "va_arg";
 159   case ExtractElement: return "extractelement";
 160   case InsertElement:  return "insertelement";
 161   case ShuffleVector:  return "shufflevector";
 162   case ExtractValue:   return "extractvalue";
 163   case InsertValue:    return "insertvalue";
 164
 165   default: return "<Invalid operator> ";
 166   }
 167
 168   return 0;
 169 }
 170
 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;
 177 }
 178
 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())
 186     return false;
 187
 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))
 192       return false;
 193
 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   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 199     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
 200            SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
 201   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 202     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 203   if (const CallInst *CI = dyn_cast<CallInst>(this))
 204     return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
 205            CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
 206            CI->getAttributes() == cast<CallInst>(I)->getAttributes();
 207   if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
 208     return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
 209            CI->getAttributes() == cast<InvokeInst>(I)->getAttributes();
 210   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this))
 211     return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices();
 212   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this))
 213     return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices();
 214   if (const FenceInst *FI = dyn_cast<FenceInst>(this))
 215     return FI->getOrdering() == cast<FenceInst>(FI)->getOrdering() &&
 216            FI->getSynchScope() == cast<FenceInst>(FI)->getSynchScope();
 217   if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(this))
 218     return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I)->isVolatile() &&
 219            CXI->getOrdering() == cast<AtomicCmpXchgInst>(I)->getOrdering() &&
 220            CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I)->getSynchScope();
 221   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(this))
 222     return RMWI->getOperation() == cast<AtomicRMWInst>(I)->getOperation() &&
 223            RMWI->isVolatile() == cast<AtomicRMWInst>(I)->isVolatile() &&
 224            RMWI->getOrdering() == cast<AtomicRMWInst>(I)->getOrdering() &&
 225            RMWI->getSynchScope() == cast<AtomicRMWInst>(I)->getSynchScope();
 226
 227   return true;
 228 }
 229
 230 // isSameOperationAs
 231 // This should be kept in sync with isEquivalentOperation in
 232 // lib/Transforms/IPO/MergeFunctions.cpp.
 233 bool Instruction::isSameOperationAs(const Instruction *I) const {
 234   if (getOpcode() != I->getOpcode() ||
 235       getNumOperands() != I->getNumOperands() ||
 236       getType() != I->getType())
 237     return false;
 238
 239   // We have two instructions of identical opcode and #operands.  Check to see
 240   // if all operands are the same type
 241   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 242     if (getOperand(i)->getType() != I->getOperand(i)->getType())
 243       return false;
 244
 245   // Check special state that is a part of some instructions.
 246   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 247     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
 248            LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
 249   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 250     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
 251            SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
 252   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 253     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 254   if (const CallInst *CI = dyn_cast<CallInst>(this))
 255     return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
 256            CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
 257            CI->getAttributes() == cast<CallInst>(I)->getAttributes();
 258   if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
 259     return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
 260            CI->getAttributes() ==
 261              cast<InvokeInst>(I)->getAttributes();
 262   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this))
 263     return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices();
 264   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this))
 265     return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices();
 266   if (const FenceInst *FI = dyn_cast<FenceInst>(this))
 267     return FI->getOrdering() == cast<FenceInst>(I)->getOrdering() &&
 268            FI->getSynchScope() == cast<FenceInst>(I)->getSynchScope();
 269   if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(this))
 270     return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I)->isVolatile() &&
 271            CXI->getOrdering() == cast<AtomicCmpXchgInst>(I)->getOrdering() &&
 272            CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I)->getSynchScope();
 273   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(this))
 274     return RMWI->getOperation() == cast<AtomicRMWInst>(I)->getOperation() &&
 275            RMWI->isVolatile() == cast<AtomicRMWInst>(I)->isVolatile() &&
 276            RMWI->getOrdering() == cast<AtomicRMWInst>(I)->getOrdering() &&
 277            RMWI->getSynchScope() == cast<AtomicRMWInst>(I)->getSynchScope();
 278
 279   return true;
 280 }
 281
 282 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
 283 /// specified block.  Note that PHI nodes are considered to evaluate their
 284 /// operands in the corresponding predecessor block.
 285 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
 286   for (const_use_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
 287     // PHI nodes uses values in the corresponding predecessor block.  For other
 288     // instructions, just check to see whether the parent of the use matches up.
 289     const User *U = *UI;
 290     const PHINode *PN = dyn_cast<PHINode>(U);
 291     if (PN == 0) {
 292       if (cast<Instruction>(U)->getParent() != BB)
 293         return true;
 294       continue;
 295     }
 296
 297     if (PN->getIncomingBlock(UI) != BB)
 298       return true;
 299   }
 300   return false;
 301 }
 302
 303 /// mayReadFromMemory - Return true if this instruction may read memory.
 304 ///
 305 bool Instruction::mayReadFromMemory() const {
 306   switch (getOpcode()) {
 307   default: return false;
 308   case Instruction::VAArg:
 309   case Instruction::Load:
 310   case Instruction::Fence: // FIXME: refine definition of mayReadFromMemory
 311   case Instruction::AtomicCmpXchg:
 312   case Instruction::AtomicRMW:
 313     return true;
 314   case Instruction::Call:
 315     return !cast<CallInst>(this)->doesNotAccessMemory();
 316   case Instruction::Invoke:
 317     return !cast<InvokeInst>(this)->doesNotAccessMemory();
 318   case Instruction::Store:
 319     return cast<StoreInst>(this)->isVolatile();
 320   }
 321 }
 322
 323 /// mayWriteToMemory - Return true if this instruction may modify memory.
 324 ///
 325 bool Instruction::mayWriteToMemory() const {
 326   switch (getOpcode()) {
 327   default: return false;
 328   case Instruction::Fence: // FIXME: refine definition of mayWriteToMemory
 329   case Instruction::Store:
 330   case Instruction::VAArg:
 331   case Instruction::AtomicCmpXchg:
 332   case Instruction::AtomicRMW:
 333     return true;
 334   case Instruction::Call:
 335     return !cast<CallInst>(this)->onlyReadsMemory();
 336   case Instruction::Invoke:
 337     return !cast<InvokeInst>(this)->onlyReadsMemory();
 338   case Instruction::Load:
 339     return cast<LoadInst>(this)->isVolatile();
 340   }
 341 }
 342
 343 /// mayThrow - Return true if this instruction may throw an exception.
 344 ///
 345 bool Instruction::mayThrow() const {
 346   if (const CallInst *CI = dyn_cast<CallInst>(this))
 347     return !CI->doesNotThrow();
 348   return false;
 349 }
 350
 351 /// isAssociative - Return true if the instruction is associative:
 352 ///
 353 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 354 ///
 355 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
 356 ///
 357 bool Instruction::isAssociative(unsigned Opcode) {
 358   return Opcode == And || Opcode == Or || Opcode == Xor ||
 359          Opcode == Add || Opcode == Mul;
 360 }
 361
 362 /// isCommutative - Return true if the instruction is commutative:
 363 ///
 364 ///   Commutative operators satisfy: (x op y) === (y op x)
 365 ///
 366 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 367 /// applied to any type.
 368 ///
 369 bool Instruction::isCommutative(unsigned op) {
 370   switch (op) {
 371   case Add:
 372   case FAdd:
 373   case Mul:
 374   case FMul:
 375   case And:
 376   case Or:
 377   case Xor:
 378     return true;
 379   default:
 380     return false;
 381   }
 382 }
 383
 384 bool Instruction::isSafeToSpeculativelyExecute() const {
 385   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 386     if (Constant *C = dyn_cast<Constant>(getOperand(i)))
 387       if (C->canTrap())
 388         return false;
 389
 390   switch (getOpcode()) {
 391   default:
 392     return true;
 393   case UDiv:
 394   case URem: {
 395     // x / y is undefined if y == 0, but calcuations like x / 3 are safe.
 396     ConstantInt *Op = dyn_cast<ConstantInt>(getOperand(1));
 397     return Op && !Op->isNullValue();
 398   }
 399   case SDiv:
 400   case SRem: {
 401     // x / y is undefined if y == 0, and might be undefined if y == -1,
 402     // but calcuations like x / 3 are safe.
 403     ConstantInt *Op = dyn_cast<ConstantInt>(getOperand(1));
 404     return Op && !Op->isNullValue() && !Op->isAllOnesValue();
 405   }
 406   case Load: {
 407     const LoadInst *LI = cast<LoadInst>(this);
 408     if (LI->isVolatile())
 409       return false;
 410     return LI->getPointerOperand()->isDereferenceablePointer();
 411   }
 412   case Call:
 413     return false; // The called function could have undefined behavior or
 414                   // side-effects.
 415                   // FIXME: We should special-case some intrinsics (bswap,
 416                   // overflow-checking arithmetic, etc.)
 417   case VAArg:
 418   case Alloca:
 419   case Invoke:
 420   case PHI:
 421   case Store:
 422   case Ret:
 423   case Br:
 424   case IndirectBr:
 425   case Switch:
 426   case Unwind:
 427   case Unreachable:
 428   case Fence:
 429     return false; // Misc instructions which have effects
 430   }
 431 }
 432
 433 Instruction *Instruction::clone() const {
 434   Instruction *New = clone_impl();
 435   New->SubclassOptionalData = SubclassOptionalData;
 436   if (!hasMetadata())
 437     return New;
 438
 439   // Otherwise, enumerate and copy over metadata from the old instruction to the
 440   // new one.
 441   SmallVector<std::pair<unsigned, MDNode*>, 4> TheMDs;
 442   getAllMetadataOtherThanDebugLoc(TheMDs);
 443   for (unsigned i = 0, e = TheMDs.size(); i != e; ++i)
 444     New->setMetadata(TheMDs[i].first, TheMDs[i].second);
 445
 446   New->setDebugLoc(getDebugLoc());
 447   return New;
 448 }