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/Type.h"
  15 #include "llvm/Instructions.h"
  16 #include "llvm/Function.h"
  17 #include "llvm/Support/CallSite.h"
  18 #include "llvm/Support/LeakDetector.h"
  19 using namespace llvm;
  20
  21 Instruction::Instruction(const Type *ty, unsigned it, Use *Ops, unsigned NumOps,
  22                          Instruction *InsertBefore)
  23   : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
  24   // Make sure that we get added to a basicblock
  25   LeakDetector::addGarbageObject(this);
  26
  27   // If requested, insert this instruction into a basic block...
  28   if (InsertBefore) {
  29     assert(InsertBefore->getParent() &&
  30            "Instruction to insert before is not in a basic block!");
  31     InsertBefore->getParent()->getInstList().insert(InsertBefore, this);
  32   }
  33 }
  34
  35 Instruction::Instruction(const Type *ty, unsigned it, Use *Ops, unsigned NumOps,
  36                          BasicBlock *InsertAtEnd)
  37   : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
  38   // Make sure that we get added to a basicblock
  39   LeakDetector::addGarbageObject(this);
  40
  41   // append this instruction into the basic block
  42   assert(InsertAtEnd && "Basic block to append to may not be NULL!");
  43   InsertAtEnd->getInstList().push_back(this);
  44 }
  45
  46
  47 // Out of line virtual method, so the vtable, etc has a home.
  48 Instruction::~Instruction() {
  49   assert(Parent == 0 && "Instruction still linked in the program!");
  50 }
  51
  52
  53 void Instruction::setParent(BasicBlock *P) {
  54   if (getParent()) {
  55     if (!P) LeakDetector::addGarbageObject(this);
  56   } else {
  57     if (P) LeakDetector::removeGarbageObject(this);
  58   }
  59
  60   Parent = P;
  61 }
  62
  63 void Instruction::removeFromParent() {
  64   getParent()->getInstList().remove(this);
  65 }
  66
  67 void Instruction::eraseFromParent() {
  68   getParent()->getInstList().erase(this);
  69 }
  70
  71 /// insertBefore - Insert an unlinked instructions into a basic block
  72 /// immediately before the specified instruction.
  73 void Instruction::insertBefore(Instruction *InsertPos) {
  74   InsertPos->getParent()->getInstList().insert(InsertPos, this);
  75 }
  76
  77 /// insertAfter - Insert an unlinked instructions into a basic block
  78 /// immediately after the specified instruction.
  79 void Instruction::insertAfter(Instruction *InsertPos) {
  80   InsertPos->getParent()->getInstList().insertAfter(InsertPos, this);
  81 }
  82
  83 /// moveBefore - Unlink this instruction from its current basic block and
  84 /// insert it into the basic block that MovePos lives in, right before
  85 /// MovePos.
  86 void Instruction::moveBefore(Instruction *MovePos) {
  87   MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
  88                                              this);
  89 }
  90
  91
  92 const char *Instruction::getOpcodeName(unsigned OpCode) {
  93   switch (OpCode) {
  94   // Terminators
  95   case Ret:    return "ret";
  96   case Br:     return "br";
  97   case Switch: return "switch";
  98   case Invoke: return "invoke";
  99   case Unwind: return "unwind";
 100   case Unreachable: return "unreachable";
 101
 102   // Standard binary operators...
 103   case Add: return "add";
 104   case FAdd: return "fadd";
 105   case Sub: return "sub";
 106   case FSub: return "fsub";
 107   case Mul: return "mul";
 108   case FMul: return "fmul";
 109   case UDiv: return "udiv";
 110   case SDiv: return "sdiv";
 111   case FDiv: return "fdiv";
 112   case URem: return "urem";
 113   case SRem: return "srem";
 114   case FRem: return "frem";
 115
 116   // Logical operators...
 117   case And: return "and";
 118   case Or : return "or";
 119   case Xor: return "xor";
 120
 121   // Memory instructions...
 122   case Malloc:        return "malloc";
 123   case Free:          return "free";
 124   case Alloca:        return "alloca";
 125   case Load:          return "load";
 126   case Store:         return "store";
 127   case GetElementPtr: return "getelementptr";
 128
 129   // Convert instructions...
 130   case Trunc:     return "trunc";
 131   case ZExt:      return "zext";
 132   case SExt:      return "sext";
 133   case FPTrunc:   return "fptrunc";
 134   case FPExt:     return "fpext";
 135   case FPToUI:    return "fptoui";
 136   case FPToSI:    return "fptosi";
 137   case UIToFP:    return "uitofp";
 138   case SIToFP:    return "sitofp";
 139   case IntToPtr:  return "inttoptr";
 140   case PtrToInt:  return "ptrtoint";
 141   case BitCast:   return "bitcast";
 142
 143   // Other instructions...
 144   case ICmp:           return "icmp";
 145   case FCmp:           return "fcmp";
 146   case PHI:            return "phi";
 147   case Select:         return "select";
 148   case Call:           return "call";
 149   case Shl:            return "shl";
 150   case LShr:           return "lshr";
 151   case AShr:           return "ashr";
 152   case VAArg:          return "va_arg";
 153   case ExtractElement: return "extractelement";
 154   case InsertElement:  return "insertelement";
 155   case ShuffleVector:  return "shufflevector";
 156   case ExtractValue:   return "extractvalue";
 157   case InsertValue:    return "insertvalue";
 158
 159   default: return "<Invalid operator> ";
 160   }
 161
 162   return 0;
 163 }
 164
 165 /// isIdenticalTo - Return true if the specified instruction is exactly
 166 /// identical to the current one.  This means that all operands match and any
 167 /// extra information (e.g. load is volatile) agree.
 168 bool Instruction::isIdenticalTo(const Instruction *I) const {
 169   if (getOpcode() != I->getOpcode() ||
 170       getNumOperands() != I->getNumOperands() ||
 171       getType() != I->getType())
 172     return false;
 173
 174   // We have two instructions of identical opcode and #operands.  Check to see
 175   // if all operands are the same.
 176   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 177     if (getOperand(i) != I->getOperand(i))
 178       return false;
 179
 180   // Check special state that is a part of some instructions.
 181   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 182     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
 183            LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
 184   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 185     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
 186            SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
 187   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 188     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 189   if (const CallInst *CI = dyn_cast<CallInst>(this))
 190     return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
 191            CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
 192            CI->getAttributes().getRawPointer() ==
 193              cast<CallInst>(I)->getAttributes().getRawPointer();
 194   if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
 195     return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
 196            CI->getAttributes().getRawPointer() ==
 197              cast<InvokeInst>(I)->getAttributes().getRawPointer();
 198   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this)) {
 199     if (IVI->getNumIndices() != cast<InsertValueInst>(I)->getNumIndices())
 200       return false;
 201     for (unsigned i = 0, e = IVI->getNumIndices(); i != e; ++i)
 202       if (IVI->idx_begin()[i] != cast<InsertValueInst>(I)->idx_begin()[i])
 203         return false;
 204     return true;
 205   }
 206   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this)) {
 207     if (EVI->getNumIndices() != cast<ExtractValueInst>(I)->getNumIndices())
 208       return false;
 209     for (unsigned i = 0, e = EVI->getNumIndices(); i != e; ++i)
 210       if (EVI->idx_begin()[i] != cast<ExtractValueInst>(I)->idx_begin()[i])
 211         return false;
 212     return true;
 213   }
 214
 215   return true;
 216 }
 217
 218 // isSameOperationAs
 219 // This should be kept in sync with isEquivalentOperation in
 220 // lib/Transforms/IPO/MergeFunctions.cpp.
 221 bool Instruction::isSameOperationAs(const Instruction *I) const {
 222   if (getOpcode() != I->getOpcode() ||
 223       getNumOperands() != I->getNumOperands() ||
 224       getType() != I->getType())
 225     return false;
 226
 227   // We have two instructions of identical opcode and #operands.  Check to see
 228   // if all operands are the same type
 229   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 230     if (getOperand(i)->getType() != I->getOperand(i)->getType())
 231       return false;
 232
 233   // Check special state that is a part of some instructions.
 234   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 235     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile() &&
 236            LI->getAlignment() == cast<LoadInst>(I)->getAlignment();
 237   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 238     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile() &&
 239            SI->getAlignment() == cast<StoreInst>(I)->getAlignment();
 240   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 241     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 242   if (const CallInst *CI = dyn_cast<CallInst>(this))
 243     return CI->isTailCall() == cast<CallInst>(I)->isTailCall() &&
 244            CI->getCallingConv() == cast<CallInst>(I)->getCallingConv() &&
 245            CI->getAttributes().getRawPointer() ==
 246              cast<CallInst>(I)->getAttributes().getRawPointer();
 247   if (const InvokeInst *CI = dyn_cast<InvokeInst>(this))
 248     return CI->getCallingConv() == cast<InvokeInst>(I)->getCallingConv() &&
 249            CI->getAttributes().getRawPointer() ==
 250              cast<InvokeInst>(I)->getAttributes().getRawPointer();
 251   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(this)) {
 252     if (IVI->getNumIndices() != cast<InsertValueInst>(I)->getNumIndices())
 253       return false;
 254     for (unsigned i = 0, e = IVI->getNumIndices(); i != e; ++i)
 255       if (IVI->idx_begin()[i] != cast<InsertValueInst>(I)->idx_begin()[i])
 256         return false;
 257     return true;
 258   }
 259   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(this)) {
 260     if (EVI->getNumIndices() != cast<ExtractValueInst>(I)->getNumIndices())
 261       return false;
 262     for (unsigned i = 0, e = EVI->getNumIndices(); i != e; ++i)
 263       if (EVI->idx_begin()[i] != cast<ExtractValueInst>(I)->idx_begin()[i])
 264         return false;
 265     return true;
 266   }
 267
 268   return true;
 269 }
 270
 271 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
 272 /// specified block.  Note that PHI nodes are considered to evaluate their
 273 /// operands in the corresponding predecessor block.
 274 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
 275   for (use_const_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
 276     // PHI nodes uses values in the corresponding predecessor block.  For other
 277     // instructions, just check to see whether the parent of the use matches up.
 278     const PHINode *PN = dyn_cast<PHINode>(*UI);
 279     if (PN == 0) {
 280       if (cast<Instruction>(*UI)->getParent() != BB)
 281         return true;
 282       continue;
 283     }
 284
 285     if (PN->getIncomingBlock(UI) != BB)
 286       return true;
 287   }
 288   return false;
 289 }
 290
 291 /// mayReadFromMemory - Return true if this instruction may read memory.
 292 ///
 293 bool Instruction::mayReadFromMemory() const {
 294   switch (getOpcode()) {
 295   default: return false;
 296   case Instruction::Free:
 297   case Instruction::VAArg:
 298   case Instruction::Load:
 299     return true;
 300   case Instruction::Call:
 301     return !cast<CallInst>(this)->doesNotAccessMemory();
 302   case Instruction::Invoke:
 303     return !cast<InvokeInst>(this)->doesNotAccessMemory();
 304   case Instruction::Store:
 305     return cast<StoreInst>(this)->isVolatile();
 306   }
 307 }
 308
 309 /// mayWriteToMemory - Return true if this instruction may modify memory.
 310 ///
 311 bool Instruction::mayWriteToMemory() const {
 312   switch (getOpcode()) {
 313   default: return false;
 314   case Instruction::Free:
 315   case Instruction::Store:
 316   case Instruction::VAArg:
 317     return true;
 318   case Instruction::Call:
 319     return !cast<CallInst>(this)->onlyReadsMemory();
 320   case Instruction::Invoke:
 321     return !cast<InvokeInst>(this)->onlyReadsMemory();
 322   case Instruction::Load:
 323     return cast<LoadInst>(this)->isVolatile();
 324   }
 325 }
 326
 327 /// mayThrow - Return true if this instruction may throw an exception.
 328 ///
 329 bool Instruction::mayThrow() const {
 330   if (const CallInst *CI = dyn_cast<CallInst>(this))
 331     return !CI->doesNotThrow();
 332   return false;
 333 }
 334
 335 /// isAssociative - Return true if the instruction is associative:
 336 ///
 337 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 338 ///
 339 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
 340 ///
 341 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
 342   return Opcode == And || Opcode == Or || Opcode == Xor ||
 343          Opcode == Add || Opcode == Mul;
 344 }
 345
 346 /// isCommutative - Return true if the instruction is commutative:
 347 ///
 348 ///   Commutative operators satisfy: (x op y) === (y op x)
 349 ///
 350 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 351 /// applied to any type.
 352 ///
 353 bool Instruction::isCommutative(unsigned op) {
 354   switch (op) {
 355   case Add:
 356   case FAdd:
 357   case Mul:
 358   case FMul:
 359   case And:
 360   case Or:
 361   case Xor:
 362     return true;
 363   default:
 364     return false;
 365   }
 366 }
 367
 368 /// isTrapping - Return true if the instruction may trap.
 369 ///
 370 bool Instruction::isTrapping(unsigned op) {
 371   switch(op) {
 372   case UDiv:
 373   case SDiv:
 374   case FDiv:
 375   case URem:
 376   case SRem:
 377   case FRem:
 378   case Load:
 379   case Store:
 380   case Call:
 381   case Invoke:
 382   case VAArg:
 383     return true;
 384   default:
 385     return false;
 386   }
 387 }