lib/VMCore/Instruction.cpp

   1 //===-- Instruction.cpp - Implement the Instruction class -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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/LeakDetector.h"
  18 using namespace llvm;
  19
  20 Instruction::Instruction(const Type *ty, unsigned it, Use *Ops, unsigned NumOps,
  21                          const std::string &Name, Instruction *InsertBefore)
  22   : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
  23   // Make sure that we get added to a basicblock
  24   LeakDetector::addGarbageObject(this);
  25
  26   // If requested, insert this instruction into a basic block...
  27   if (InsertBefore) {
  28     assert(InsertBefore->getParent() &&
  29            "Instruction to insert before is not in a basic block!");
  30     InsertBefore->getParent()->getInstList().insert(InsertBefore, this);
  31   }
  32   setName(Name);
  33 }
  34
  35 Instruction::Instruction(const Type *ty, unsigned it, Use *Ops, unsigned NumOps,
  36                          const std::string &Name, 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   setName(Name);
  45 }
  46
  47 Instruction::Instruction(const Type *ty, unsigned it, Use *Ops, unsigned NumOps,
  48                          const char *Name, Instruction *InsertBefore)
  49   : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
  50   // Make sure that we get added to a basicblock
  51   LeakDetector::addGarbageObject(this);
  52
  53   // If requested, insert this instruction into a basic block...
  54   if (InsertBefore) {
  55     assert(InsertBefore->getParent() &&
  56            "Instruction to insert before is not in a basic block!");
  57     InsertBefore->getParent()->getInstList().insert(InsertBefore, this);
  58   }
  59   if (Name && *Name) setName(Name);
  60 }
  61
  62 Instruction::Instruction(const Type *ty, unsigned it, Use *Ops, unsigned NumOps,
  63                          const char *Name, BasicBlock *InsertAtEnd)
  64   : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(0) {
  65   // Make sure that we get added to a basicblock
  66   LeakDetector::addGarbageObject(this);
  67
  68   // append this instruction into the basic block
  69   assert(InsertAtEnd && "Basic block to append to may not be NULL!");
  70   InsertAtEnd->getInstList().push_back(this);
  71   if (Name && *Name) setName(Name);
  72 }
  73
  74
  75 // Out of line virtual method, so the vtable, etc has a home.
  76 Instruction::~Instruction() {
  77   assert(Parent == 0 && "Instruction still linked in the program!");
  78 }
  79
  80
  81 void Instruction::setParent(BasicBlock *P) {
  82   if (getParent()) {
  83     if (!P) LeakDetector::addGarbageObject(this);
  84   } else {
  85     if (P) LeakDetector::removeGarbageObject(this);
  86   }
  87
  88   Parent = P;
  89 }
  90
  91 void Instruction::removeFromParent() {
  92   getParent()->getInstList().remove(this);
  93 }
  94
  95 void Instruction::eraseFromParent() {
  96   getParent()->getInstList().erase(this);
  97 }
  98
  99 /// moveBefore - Unlink this instruction from its current basic block and
 100 /// insert it into the basic block that MovePos lives in, right before
 101 /// MovePos.
 102 void Instruction::moveBefore(Instruction *MovePos) {
 103   MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
 104                                              this);
 105 }
 106
 107
 108 const char *Instruction::getOpcodeName(unsigned OpCode) {
 109   switch (OpCode) {
 110   // Terminators
 111   case Ret:    return "ret";
 112   case Br:     return "br";
 113   case Switch: return "switch";
 114   case Invoke: return "invoke";
 115   case Unwind: return "unwind";
 116   case Unreachable: return "unreachable";
 117
 118   // Standard binary operators...
 119   case Add: return "add";
 120   case Sub: return "sub";
 121   case Mul: return "mul";
 122   case UDiv: return "udiv";
 123   case SDiv: return "sdiv";
 124   case FDiv: return "fdiv";
 125   case URem: return "urem";
 126   case SRem: return "srem";
 127   case FRem: return "frem";
 128
 129   // Logical operators...
 130   case And: return "and";
 131   case Or : return "or";
 132   case Xor: return "xor";
 133
 134   // Memory instructions...
 135   case Malloc:        return "malloc";
 136   case Free:          return "free";
 137   case Alloca:        return "alloca";
 138   case Load:          return "load";
 139   case Store:         return "store";
 140   case GetElementPtr: return "getelementptr";
 141
 142   // Convert instructions...
 143   case Trunc:     return "trunc";
 144   case ZExt:      return "zext";
 145   case SExt:      return "sext";
 146   case FPTrunc:   return "fptrunc";
 147   case FPExt:     return "fpext";
 148   case FPToUI:    return "fptoui";
 149   case FPToSI:    return "fptosi";
 150   case UIToFP:    return "uitofp";
 151   case SIToFP:    return "sitofp";
 152   case IntToPtr:  return "inttoptr";
 153   case PtrToInt:  return "ptrtoint";
 154   case BitCast:   return "bitcast";
 155
 156   // Other instructions...
 157   case ICmp:           return "icmp";
 158   case FCmp:           return "fcmp";
 159   case PHI:            return "phi";
 160   case Select:         return "select";
 161   case Call:           return "call";
 162   case Shl:            return "shl";
 163   case LShr:           return "lshr";
 164   case AShr:           return "ashr";
 165   case VAArg:          return "va_arg";
 166   case ExtractElement: return "extractelement";
 167   case InsertElement:  return "insertelement";
 168   case ShuffleVector:  return "shufflevector";
 169
 170   default: return "<Invalid operator> ";
 171   }
 172
 173   return 0;
 174 }
 175
 176 /// isIdenticalTo - Return true if the specified instruction is exactly
 177 /// identical to the current one.  This means that all operands match and any
 178 /// extra information (e.g. load is volatile) agree.
 179 bool Instruction::isIdenticalTo(Instruction *I) const {
 180   if (getOpcode() != I->getOpcode() ||
 181       getNumOperands() != I->getNumOperands() ||
 182       getType() != I->getType())
 183     return false;
 184
 185   // We have two instructions of identical opcode and #operands.  Check to see
 186   // if all operands are the same.
 187   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 188     if (getOperand(i) != I->getOperand(i))
 189       return false;
 190
 191   // Check special state that is a part of some instructions.
 192   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 193     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
 194   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 195     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
 196   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 197     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 198   if (const CallInst *CI = dyn_cast<CallInst>(this))
 199     return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
 200   return true;
 201 }
 202
 203 // isSameOperationAs
 204 bool Instruction::isSameOperationAs(Instruction *I) const {
 205   if (getOpcode() != I->getOpcode() || getType() != I->getType() ||
 206       getNumOperands() != I->getNumOperands())
 207     return false;
 208
 209   // We have two instructions of identical opcode and #operands.  Check to see
 210   // if all operands are the same type
 211   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 212     if (getOperand(i)->getType() != I->getOperand(i)->getType())
 213       return false;
 214
 215   // Check special state that is a part of some instructions.
 216   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 217     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
 218   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 219     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
 220   if (const CmpInst *CI = dyn_cast<CmpInst>(this))
 221     return CI->getPredicate() == cast<CmpInst>(I)->getPredicate();
 222   if (const CallInst *CI = dyn_cast<CallInst>(this))
 223     return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
 224
 225   return true;
 226 }
 227
 228 /// mayWriteToMemory - Return true if this instruction may modify memory.
 229 ///
 230 bool Instruction::mayWriteToMemory() const {
 231   switch (getOpcode()) {
 232   default: return false;
 233   case Instruction::Free:
 234   case Instruction::Store:
 235   case Instruction::Invoke:
 236   case Instruction::VAArg:
 237     return true;
 238   case Instruction::Call:
 239     if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(this)) {
 240       // If the intrinsic doesn't write memory, it is safe.
 241     }
 242     return true;
 243   case Instruction::Load:
 244     return cast<LoadInst>(this)->isVolatile();
 245   }
 246 }
 247
 248 /// isAssociative - Return true if the instruction is associative:
 249 ///
 250 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z)
 251 ///
 252 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when not
 253 /// applied to floating point types.
 254 ///
 255 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
 256   if (Opcode == And || Opcode == Or || Opcode == Xor)
 257     return true;
 258
 259   // Add/Mul reassociate unless they are FP or FP vectors.
 260   if (Opcode == Add || Opcode == Mul)
 261     return !Ty->isFPOrFPVector();
 262   return 0;
 263 }
 264
 265 /// isCommutative - Return true if the instruction is commutative:
 266 ///
 267 ///   Commutative operators satisfy: (x op y) === (y op x)
 268 ///
 269 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 270 /// applied to any type.
 271 ///
 272 bool Instruction::isCommutative(unsigned op) {
 273   switch (op) {
 274   case Add:
 275   case Mul:
 276   case And:
 277   case Or:
 278   case Xor:
 279     return true;
 280   default:
 281     return false;
 282   }
 283 }
 284
 285 /// isTrappingInstruction - Return true if the instruction may trap.
 286 ///
 287 bool Instruction::isTrapping(unsigned op) {
 288   switch(op) {
 289   case UDiv:
 290   case SDiv:
 291   case FDiv:
 292   case URem:
 293   case SRem:
 294   case FRem:
 295   case Load:
 296   case Store:
 297   case Call:
 298   case Invoke:
 299     return true;
 300   default:
 301     return false;
 302   }
 303 }