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