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 /// moveBefore - Unlink this instruction from its current basic block and
  72 /// insert it into the basic block that MovePos lives in, right before
  73 /// MovePos.
  74 void Instruction::moveBefore(Instruction *MovePos) {
  75   MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
  76                                              this);
  77 }
  78
  79
  80 const char *Instruction::getOpcodeName(unsigned OpCode) {
  81   switch (OpCode) {
  82   // Terminators
  83   case Ret:    return "ret";
  84   case Br:     return "br";
  85   case Switch: return "switch";
  86   case Invoke: return "invoke";
  87   case Unwind: return "unwind";
  88   case Unreachable: return "unreachable";
  89
  90   // Standard binary operators...
  91   case Add: return "add";
  92   case Sub: return "sub";
  93   case Mul: return "mul";
  94   case UDiv: return "udiv";
  95   case SDiv: return "sdiv";
  96   case FDiv: return "fdiv";
  97   case URem: return "urem";
  98   case SRem: return "srem";
  99   case FRem: return "frem";
 100
 101   // Logical operators...
 102   case And: return "and";
 103   case Or : return "or";
 104   case Xor: return "xor";
 105
 106   // Memory instructions...
 107   case Malloc:        return "malloc";
 108   case Free:          return "free";
 109   case Alloca:        return "alloca";
 110   case Load:          return "load";
 111   case Store:         return "store";
 112   case GetElementPtr: return "getelementptr";
 113
 114   // Convert instructions...
 115   case Trunc:     return "trunc";
 116   case ZExt:      return "zext";
 117   case SExt:      return "sext";
 118   case FPTrunc:   return "fptrunc";
 119   case FPExt:     return "fpext";
 120   case FPToUI:    return "fptoui";
 121   case FPToSI:    return "fptosi";
 122   case UIToFP:    return "uitofp";
 123   case SIToFP:    return "sitofp";
 124   case IntToPtr:  return "inttoptr";
 125   case PtrToInt:  return "ptrtoint";
 126   case BitCast:   return "bitcast";
 127
 128   // Other instructions...
 129   case ICmp:           return "icmp";
 130   case FCmp:           return "fcmp";
 131   case VICmp:          return "vicmp";
 132   case VFCmp:          return "vfcmp";
 133   case PHI:            return "phi";
 134   case Select:         return "select";
 135   case Call:           return "call";
 136   case Shl:            return "shl";
 137   case LShr:           return "lshr";
 138   case AShr:           return "ashr";
 139   case VAArg:          return "va_arg";
 140   case ExtractElement: return "extractelement";
 141   case InsertElement:  return "insertelement";
 142   case ShuffleVector:  return "shufflevector";
 143   case GetResult:      return "getresult";
 144
 145   default: return "<Invalid operator> ";
 146   }
 147
 148   return 0;
 149 }
 150
 151 /// isIdenticalTo - Return true if the specified instruction is exactly
 152 /// identical to the current one.  This means that all operands match and any
 153 /// extra information (e.g. load is volatile) agree.
 154 bool Instruction::isIdenticalTo(Instruction *I) const {
 155   if (getOpcode() != I->getOpcode() ||
 156       getNumOperands() != I->getNumOperands() ||
 157       getType() != I->getType())
 158     return false;
 159
 160   // We have two instructions of identical opcode and #operands.  Check to see
 161   // if all operands are the same.
 162   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 163     if (getOperand(i) != I->getOperand(i))
 164       return false;
 165
 166   // Check special state that is a part of some instructions.
 167   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 168     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
 169   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 170     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
 171   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 172     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 173   if (const CallInst *CI = dyn_cast<CallInst>(this))
 174     return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
 175   return true;
 176 }
 177
 178 // isSameOperationAs
 179 bool Instruction::isSameOperationAs(Instruction *I) const {
 180   if (getOpcode() != I->getOpcode() || getType() != I->getType() ||
 181       getNumOperands() != I->getNumOperands())
 182     return false;
 183
 184   // We have two instructions of identical opcode and #operands.  Check to see
 185   // if all operands are the same type
 186   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 187     if (getOperand(i)->getType() != I->getOperand(i)->getType())
 188       return false;
 189
 190   // Check special state that is a part of some instructions.
 191   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 192     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
 193   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 194     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
 195   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 196     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 197   if (const CallInst *CI = dyn_cast<CallInst>(this))
 198     return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
 199
 200   return true;
 201 }
 202
 203 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
 204 /// specified block.  Note that PHI nodes are considered to evaluate their
 205 /// operands in the corresponding predecessor block.
 206 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
 207   for (use_const_iterator UI = use_begin(), E = use_end(); UI != E; ++UI) {
 208     // PHI nodes uses values in the corresponding predecessor block.  For other
 209     // instructions, just check to see whether the parent of the use matches up.
 210     const PHINode *PN = dyn_cast<PHINode>(*UI);
 211     if (PN == 0) {
 212       if (cast<Instruction>(*UI)->getParent() != BB)
 213         return true;
 214       continue;
 215     }
 216
 217     unsigned UseOperand = UI.getOperandNo();
 218     if (PN->getIncomingBlock(UseOperand/2) != BB)
 219       return true;
 220   }
 221   return false;
 222 }
 223
 224 /// mayReadFromMemory - Return true if this instruction may read memory.
 225 ///
 226 bool Instruction::mayReadFromMemory() const {
 227   switch (getOpcode()) {
 228   default: return false;
 229   case Instruction::Free:
 230   case Instruction::VAArg:
 231   case Instruction::Load:
 232     return true;
 233   case Instruction::Call:
 234     return !cast<CallInst>(this)->doesNotAccessMemory();
 235   case Instruction::Invoke:
 236     return !cast<InvokeInst>(this)->doesNotAccessMemory();
 237   case Instruction::Store:
 238     return cast<StoreInst>(this)->isVolatile();
 239   }
 240 }
 241
 242 /// mayWriteToMemory - Return true if this instruction may modify memory.
 243 ///
 244 bool Instruction::mayWriteToMemory() const {
 245   switch (getOpcode()) {
 246   default: return false;
 247   case Instruction::Free:
 248   case Instruction::Store:
 249   case Instruction::VAArg:
 250     return true;
 251   case Instruction::Call:
 252     return !cast<CallInst>(this)->onlyReadsMemory();
 253   case Instruction::Invoke:
 254     return !cast<InvokeInst>(this)->onlyReadsMemory();
 255   case Instruction::Load:
 256     return cast<LoadInst>(this)->isVolatile();
 257   }
 258 }
 259
 260 /// isAssociative - Return true if the instruction is associative:
 261 ///
 262 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z)
 263 ///
 264 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when not
 265 /// applied to floating point types.
 266 ///
 267 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
 268   if (Opcode == And || Opcode == Or || Opcode == Xor)
 269     return true;
 270
 271   // Add/Mul reassociate unless they are FP or FP vectors.
 272   if (Opcode == Add || Opcode == Mul)
 273     return !Ty->isFPOrFPVector();
 274   return 0;
 275 }
 276
 277 /// isCommutative - Return true if the instruction is commutative:
 278 ///
 279 ///   Commutative operators satisfy: (x op y) === (y op x)
 280 ///
 281 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 282 /// applied to any type.
 283 ///
 284 bool Instruction::isCommutative(unsigned op) {
 285   switch (op) {
 286   case Add:
 287   case Mul:
 288   case And:
 289   case Or:
 290   case Xor:
 291     return true;
 292   default:
 293     return false;
 294   }
 295 }
 296
 297 /// isTrappingInstruction - Return true if the instruction may trap.
 298 ///
 299 bool Instruction::isTrapping(unsigned op) {
 300   switch(op) {
 301   case UDiv:
 302   case SDiv:
 303   case FDiv:
 304   case URem:
 305   case SRem:
 306   case FRem:
 307   case Load:
 308   case Store:
 309   case Call:
 310   case Invoke:
 311   case VAArg:
 312     return true;
 313   default:
 314     return false;
 315   }
 316 }