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 Fence:         return "fence";
 132   case GetElementPtr: return "getelementptr";
 133
 134   // Convert instructions...
 135   case Trunc:     return "trunc";
 136   case ZExt:      return "zext";
 137   case SExt:      return "sext";
 138   case FPTrunc:   return "fptrunc";
 139   case FPExt:     return "fpext";
 140   case FPToUI:    return "fptoui";
 141   case FPToSI:    return "fptosi";
 142   case UIToFP:    return "uitofp";
 143   case SIToFP:    return "sitofp";
 144   case IntToPtr:  return "inttoptr";
 145   case PtrToInt:  return "ptrtoint";
 146   case BitCast:   return "bitcast";
 147
 148   // Other instructions...
 149   case ICmp:           return "icmp";
 150   case FCmp:           return "fcmp";
 151   case PHI:            return "phi";
 152   case Select:         return "select";
 153   case Call:           return "call";
 154   case Shl:            return "shl";
 155   case LShr:           return "lshr";
 156   case AShr:           return "ashr";
 157   case VAArg:          return "va_arg";
 158   case ExtractElement: return "extractelement";
 159   case InsertElement:  return "insertelement";
 160   case ShuffleVector:  return "shufflevector";
 161   case ExtractValue:   return "extractvalue";
 162   case InsertValue:    return "insertvalue";
 163   case LandingPad:     return "landingpad";
 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
 218   return true;
 219 }
 220
 221 // isSameOperationAs
 222 // This should be kept in sync with isEquivalentOperation in
 223 // lib/Transforms/IPO/MergeFunctions.cpp.
 224 bool Instruction::isSameOperationAs(const Instruction *I) const {
 225   if (getOpcode() != I->getOpcode() ||
 226       getNumOperands() != I->getNumOperands() ||
 227       getType() != I->getType())
 228     return false;
 229
 230   // We have two instructions of identical opcode and #operands.  Check to see
 231   // if all operands are the same type
 232   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 233     if (getOperand(i)->getType() != I->getOperand(i)->getType())
 234       return false;
 235
 236   // Check special state that is a part of some instructions.
 237   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 238     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
 239            LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
 240   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 241     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
 242            SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
 243   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 244     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 245   if (const CallInst *CI = dyn_cast<CallInst>(this))
 246     return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
 247            CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
 248            CI->getAttributes() == cast<CallInst>(I)->getAttributes();
 249   if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
 250     return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
 251            CI->getAttributes() ==
 252              cast<InvokeInst>(I)->getAttributes();
 253   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this))
 254     return IVI->getIndices() == cast<InsertValueInst>(I)->getIndices();
 255   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this))
 256     return EVI->getIndices() == cast<ExtractValueInst>(I)->getIndices();
 257   if (const FenceInst *FI = dyn_cast<FenceInst>(this))
 258     return FI->getOrdering() == cast<FenceInst>(FI)->getOrdering() &&
 259            FI->getSynchScope() == cast<FenceInst>(FI)->getSynchScope();
 260
 261   return true;
 262 }
 263
 264 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
 265 /// specified block.  Note that PHI nodes are considered to evaluate their
 266 /// operands in the corresponding predecessor block.
 267 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
 268   for (const_use_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
 269     // PHI nodes uses values in the corresponding predecessor block.  For other
 270     // instructions, just check to see whether the parent of the use matches up.
 271     const User *U = *UI;
 272     const PHINode *PN = dyn_cast<PHINode>(U);
 273     if (PN == 0) {
 274       if (cast<Instruction>(U)->getParent() != BB)
 275         return true;
 276       continue;
 277     }
 278
 279     if (PN->getIncomingBlock(UI) != BB)
 280       return true;
 281   }
 282   return false;
 283 }
 284
 285 /// mayReadFromMemory - Return true if this instruction may read memory.
 286 ///
 287 bool Instruction::mayReadFromMemory() const {
 288   switch (getOpcode()) {
 289   default: return false;
 290   case Instruction::VAArg:
 291   case Instruction::Load:
 292   case Instruction::Fence: // FIXME: refine definition of mayReadFromMemory
 293     return true;
 294   case Instruction::Call:
 295     return !cast<CallInst>(this)->doesNotAccessMemory();
 296   case Instruction::Invoke:
 297     return !cast<InvokeInst>(this)->doesNotAccessMemory();
 298   case Instruction::Store:
 299     return cast<StoreInst>(this)->isVolatile();
 300   }
 301 }
 302
 303 /// mayWriteToMemory - Return true if this instruction may modify memory.
 304 ///
 305 bool Instruction::mayWriteToMemory() const {
 306   switch (getOpcode()) {
 307   default: return false;
 308   case Instruction::Fence: // FIXME: refine definition of mayWriteToMemory
 309   case Instruction::Store:
 310   case Instruction::VAArg:
 311     return true;
 312   case Instruction::Call:
 313     return !cast<CallInst>(this)->onlyReadsMemory();
 314   case Instruction::Invoke:
 315     return !cast<InvokeInst>(this)->onlyReadsMemory();
 316   case Instruction::Load:
 317     return cast<LoadInst>(this)->isVolatile();
 318   }
 319 }
 320
 321 /// mayThrow - Return true if this instruction may throw an exception.
 322 ///
 323 bool Instruction::mayThrow() const {
 324   if (const CallInst *CI = dyn_cast<CallInst>(this))
 325     return !CI->doesNotThrow();
 326   return false;
 327 }
 328
 329 /// isAssociative - Return true if the instruction is associative:
 330 ///
 331 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 332 ///
 333 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
 334 ///
 335 bool Instruction::isAssociative(unsigned Opcode) {
 336   return Opcode == And || Opcode == Or || Opcode == Xor ||
 337          Opcode == Add || Opcode == Mul;
 338 }
 339
 340 /// isCommutative - Return true if the instruction is commutative:
 341 ///
 342 ///   Commutative operators satisfy: (x op y) === (y op x)
 343 ///
 344 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 345 /// applied to any type.
 346 ///
 347 bool Instruction::isCommutative(unsigned op) {
 348   switch (op) {
 349   case Add:
 350   case FAdd:
 351   case Mul:
 352   case FMul:
 353   case And:
 354   case Or:
 355   case Xor:
 356     return true;
 357   default:
 358     return false;
 359   }
 360 }
 361
 362 bool Instruction::isSafeToSpeculativelyExecute() const {
 363   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 364     if (Constant *C = dyn_cast<Constant>(getOperand(i)))
 365       if (C->canTrap())
 366         return false;
 367
 368   switch (getOpcode()) {
 369   default:
 370     return true;
 371   case UDiv:
 372   case URem: {
 373     // x / y is undefined if y == 0, but calcuations like x / 3 are safe.
 374     ConstantInt *Op = dyn_cast<ConstantInt>(getOperand(1));
 375     return Op && !Op->isNullValue();
 376   }
 377   case SDiv:
 378   case SRem: {
 379     // x / y is undefined if y == 0, and might be undefined if y == -1,
 380     // but calcuations like x / 3 are safe.
 381     ConstantInt *Op = dyn_cast<ConstantInt>(getOperand(1));
 382     return Op && !Op->isNullValue() && !Op->isAllOnesValue();
 383   }
 384   case Load: {
 385     const LoadInst *LI = cast<LoadInst>(this);
 386     if (LI->isVolatile())
 387       return false;
 388     return LI->getPointerOperand()->isDereferenceablePointer();
 389   }
 390   case Call:
 391     return false; // The called function could have undefined behavior or
 392                   // side-effects.
 393                   // FIXME: We should special-case some intrinsics (bswap,
 394                   // overflow-checking arithmetic, etc.)
 395   case VAArg:
 396   case Alloca:
 397   case Invoke:
 398   case PHI:
 399   case Store:
 400   case Ret:
 401   case Br:
 402   case IndirectBr:
 403   case Switch:
 404   case Unwind:
 405   case Unreachable:
 406   case Fence:
 407     return false; // Misc instructions which have effects
 408   }
 409 }
 410
 411 Instruction *Instruction::clone() const {
 412   Instruction *New = clone_impl();
 413   New->SubclassOptionalData = SubclassOptionalData;
 414   if (!hasMetadata())
 415     return New;
 416
 417   // Otherwise, enumerate and copy over metadata from the old instruction to the
 418   // new one.
 419   SmallVector<std::pair<unsigned, MDNode*>, 4> TheMDs;
 420   getAllMetadataOtherThanDebugLoc(TheMDs);
 421   for (unsigned i = 0, e = TheMDs.size(); i != e; ++i)
 422     New->setMetadata(TheMDs[i].first, TheMDs[i].second);
 423
 424   New->setDebugLoc(getDebugLoc());
 425   return New;
 426 }