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 Resume: return "resume";
 105   case Unwind: return "unwind";
 106   case Unreachable: return "unreachable";
 107
 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";
 121
 122   // Logical operators...
 123   case And: return "and";
 124   case Or : return "or";
 125   case Xor: return "xor";
 126
 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";
 135
 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
 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";
 166
 167   default: return "<Invalid operator> ";
 168   }
 169
 170   return 0;
 171 }
 172
 173 /// isIdenticalTo - Return true if the specified instruction is exactly
 174 /// identical to the current one.  This means that all operands match and any
 175 /// extra information (e.g. load is volatile) agree.
 176 bool Instruction::isIdenticalTo(const Instruction *I) const {
 177   return isIdenticalToWhenDefined(I) &&
 178          SubclassOptionalData == I->SubclassOptionalData;
 179 }
 180
 181 /// isIdenticalToWhenDefined - This is like isIdenticalTo, except that it
 182 /// ignores the SubclassOptionalData flags, which specify conditions
 183 /// under which the instruction's result is undefined.
 184 bool Instruction::isIdenticalToWhenDefined(const Instruction *I) const {
 185   if (getOpcode() != I->getOpcode() ||
 186       getNumOperands() != I->getNumOperands() ||
 187       getType() != I->getType())
 188     return false;
 189
 190   // We have two instructions of identical opcode and #operands.  Check to see
 191   // if all operands are the same.
 192   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 193     if (getOperand(i) != I->getOperand(i))
 194       return false;
 195
 196   // Check special state that is a part of some instructions.
 197   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 198     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
 199            LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
 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   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 204     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 205   if (const CallInst *CI = dyn_cast<CallInst>(this))
 206     return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
 207            CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
 208            CI->getAttributes() == cast<CallInst>(I)->getAttributes();
 209   if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
 210     return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
 211            CI->getAttributes() == cast<InvokeInst>(I)->getAttributes();
 212   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this))
 213     return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices();
 214   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this))
 215     return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices();
 216   if (const FenceInst *FI = dyn_cast<FenceInst>(this))
 217     return FI->getOrdering() == cast<FenceInst>(FI)->getOrdering() &&
 218            FI->getSynchScope() == cast<FenceInst>(FI)->getSynchScope();
 219   if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(this))
 220     return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I)->isVolatile() &&
 221            CXI->getOrdering() == cast<AtomicCmpXchgInst>(I)->getOrdering() &&
 222            CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I)->getSynchScope();
 223   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(this))
 224     return RMWI->getOperation() == cast<AtomicRMWInst>(I)->getOperation() &&
 225            RMWI->isVolatile() == cast<AtomicRMWInst>(I)->isVolatile() &&
 226            RMWI->getOrdering() == cast<AtomicRMWInst>(I)->getOrdering() &&
 227            RMWI->getSynchScope() == cast<AtomicRMWInst>(I)->getSynchScope();
 228
 229   return true;
 230 }
 231
 232 // isSameOperationAs
 233 // This should be kept in sync with isEquivalentOperation in
 234 // lib/Transforms/IPO/MergeFunctions.cpp.
 235 bool Instruction::isSameOperationAs(const Instruction *I) const {
 236   if (getOpcode() != I->getOpcode() ||
 237       getNumOperands() != I->getNumOperands() ||
 238       getType() != I->getType())
 239     return false;
 240
 241   // We have two instructions of identical opcode and #operands.  Check to see
 242   // if all operands are the same type
 243   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 244     if (getOperand(i)->getType() != I->getOperand(i)->getType())
 245       return false;
 246
 247   // Check special state that is a part of some instructions.
 248   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 249     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
 250            LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
 251   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 252     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
 253            SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
 254   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 255     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 256   if (const CallInst *CI = dyn_cast<CallInst>(this))
 257     return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
 258            CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
 259            CI->getAttributes() == cast<CallInst>(I)->getAttributes();
 260   if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
 261     return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
 262            CI->getAttributes() ==
 263              cast<InvokeInst>(I)->getAttributes();
 264   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this))
 265     return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices();
 266   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this))
 267     return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices();
 268   if (const FenceInst *FI = dyn_cast<FenceInst>(this))
 269     return FI->getOrdering() == cast<FenceInst>(I)->getOrdering() &&
 270            FI->getSynchScope() == cast<FenceInst>(I)->getSynchScope();
 271   if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(this))
 272     return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I)->isVolatile() &&
 273            CXI->getOrdering() == cast<AtomicCmpXchgInst>(I)->getOrdering() &&
 274            CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I)->getSynchScope();
 275   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(this))
 276     return RMWI->getOperation() == cast<AtomicRMWInst>(I)->getOperation() &&
 277            RMWI->isVolatile() == cast<AtomicRMWInst>(I)->isVolatile() &&
 278            RMWI->getOrdering() == cast<AtomicRMWInst>(I)->getOrdering() &&
 279            RMWI->getSynchScope() == cast<AtomicRMWInst>(I)->getSynchScope();
 280
 281   return true;
 282 }
 283
 284 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
 285 /// specified block.  Note that PHI nodes are considered to evaluate their
 286 /// operands in the corresponding predecessor block.
 287 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
 288   for (const_use_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
 289     // PHI nodes uses values in the corresponding predecessor block.  For other
 290     // instructions, just check to see whether the parent of the use matches up.
 291     const User *U = *UI;
 292     const PHINode *PN = dyn_cast<PHINode>(U);
 293     if (PN == 0) {
 294       if (cast<Instruction>(U)->getParent() != BB)
 295         return true;
 296       continue;
 297     }
 298
 299     if (PN->getIncomingBlock(UI) != BB)
 300       return true;
 301   }
 302   return false;
 303 }
 304
 305 /// mayReadFromMemory - Return true if this instruction may read memory.
 306 ///
 307 bool Instruction::mayReadFromMemory() const {
 308   switch (getOpcode()) {
 309   default: return false;
 310   case Instruction::VAArg:
 311   case Instruction::Load:
 312   case Instruction::Fence: // FIXME: refine definition of mayReadFromMemory
 313   case Instruction::AtomicCmpXchg:
 314   case Instruction::AtomicRMW:
 315     return true;
 316   case Instruction::Call:
 317     return !cast<CallInst>(this)->doesNotAccessMemory();
 318   case Instruction::Invoke:
 319     return !cast<InvokeInst>(this)->doesNotAccessMemory();
 320   case Instruction::Store:
 321     return cast<StoreInst>(this)->isVolatile();
 322   }
 323 }
 324
 325 /// mayWriteToMemory - Return true if this instruction may modify memory.
 326 ///
 327 bool Instruction::mayWriteToMemory() const {
 328   switch (getOpcode()) {
 329   default: return false;
 330   case Instruction::Fence: // FIXME: refine definition of mayWriteToMemory
 331   case Instruction::Store:
 332   case Instruction::VAArg:
 333   case Instruction::AtomicCmpXchg:
 334   case Instruction::AtomicRMW:
 335     return true;
 336   case Instruction::Call:
 337     return !cast<CallInst>(this)->onlyReadsMemory();
 338   case Instruction::Invoke:
 339     return !cast<InvokeInst>(this)->onlyReadsMemory();
 340   case Instruction::Load:
 341     return cast<LoadInst>(this)->isVolatile();
 342   }
 343 }
 344
 345 /// mayThrow - Return true if this instruction may throw an exception.
 346 ///
 347 bool Instruction::mayThrow() const {
 348   if (const CallInst *CI = dyn_cast<CallInst>(this))
 349     return !CI->doesNotThrow();
 350   return false;
 351 }
 352
 353 /// isAssociative - Return true if the instruction is associative:
 354 ///
 355 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 356 ///
 357 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
 358 ///
 359 bool Instruction::isAssociative(unsigned Opcode) {
 360   return Opcode == And || Opcode == Or || Opcode == Xor ||
 361          Opcode == Add || Opcode == Mul;
 362 }
 363
 364 /// isCommutative - Return true if the instruction is commutative:
 365 ///
 366 ///   Commutative operators satisfy: (x op y) === (y op x)
 367 ///
 368 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 369 /// applied to any type.
 370 ///
 371 bool Instruction::isCommutative(unsigned op) {
 372   switch (op) {
 373   case Add:
 374   case FAdd:
 375   case Mul:
 376   case FMul:
 377   case And:
 378   case Or:
 379   case Xor:
 380     return true;
 381   default:
 382     return false;
 383   }
 384 }
 385
 386 bool Instruction::isSafeToSpeculativelyExecute() const {
 387   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 388     if (Constant *C = dyn_cast<Constant>(getOperand(i)))
 389       if (C->canTrap())
 390         return false;
 391
 392   switch (getOpcode()) {
 393   default:
 394     return true;
 395   case UDiv:
 396   case URem: {
 397     // x / y is undefined if y == 0, but calcuations like x / 3 are safe.
 398     ConstantInt *Op = dyn_cast<ConstantInt>(getOperand(1));
 399     return Op && !Op->isNullValue();
 400   }
 401   case SDiv:
 402   case SRem: {
 403     // x / y is undefined if y == 0, and might be undefined if y == -1,
 404     // but calcuations like x / 3 are safe.
 405     ConstantInt *Op = dyn_cast<ConstantInt>(getOperand(1));
 406     return Op && !Op->isNullValue() && !Op->isAllOnesValue();
 407   }
 408   case Load: {
 409     const LoadInst *LI = cast<LoadInst>(this);
 410     if (LI->isVolatile())
 411       return false;
 412     return LI->getPointerOperand()->isDereferenceablePointer();
 413   }
 414   case Call:
 415     return false; // The called function could have undefined behavior or
 416                   // side-effects.
 417                   // FIXME: We should special-case some intrinsics (bswap,
 418                   // overflow-checking arithmetic, etc.)
 419   case VAArg:
 420   case Alloca:
 421   case Invoke:
 422   case PHI:
 423   case Store:
 424   case Ret:
 425   case Br:
 426   case IndirectBr:
 427   case Switch:
 428   case Unwind:
 429   case Unreachable:
 430   case Fence:
 431     return false; // Misc instructions which have effects
 432   }
 433 }
 434
 435 Instruction *Instruction::clone() const {
 436   Instruction *New = clone_impl();
 437   New->SubclassOptionalData = SubclassOptionalData;
 438   if (!hasMetadata())
 439     return New;
 440
 441   // Otherwise, enumerate and copy over metadata from the old instruction to the
 442   // new one.
 443   SmallVector<std::pair<unsigned, MDNode*>, 4> TheMDs;
 444   getAllMetadataOtherThanDebugLoc(TheMDs);
 445   for (unsigned i = 0, e = TheMDs.size(); i != e; ++i)
 446     New->setMetadata(TheMDs[i].first, TheMDs[i].second);
 447
 448   New->setDebugLoc(getDebugLoc());
 449   return New;
 450 }