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/Instructions.h"
  15 #include "llvm/Function.h"
  16 #include "llvm/SymbolTable.h"
  17 #include "llvm/Type.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                          const std::string &Name, Instruction *InsertBefore)
  23   : User(ty, Value::InstructionVal + it, Ops, NumOps, Name), 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                          const std::string &Name, BasicBlock *InsertAtEnd)
  37   : User(ty, Value::InstructionVal + it, Ops, NumOps, Name), 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 // Out of line virtual method, so the vtable, etc has a home.
  47 Instruction::~Instruction() {
  48   assert(Parent == 0 && "Instruction still linked in the program!");
  49 }
  50
  51
  52 void Instruction::setOpcode(unsigned opc) {
  53   setValueType(Value::InstructionVal + opc);
  54 }
  55
  56 void Instruction::setParent(BasicBlock *P) {
  57   if (getParent()) {
  58     if (!P) LeakDetector::addGarbageObject(this);
  59   } else {
  60     if (P) LeakDetector::removeGarbageObject(this);
  61   }
  62
  63   Parent = P;
  64 }
  65
  66 void Instruction::removeFromParent() {
  67   getParent()->getInstList().remove(this);
  68 }
  69
  70 void Instruction::eraseFromParent() {
  71   getParent()->getInstList().erase(this);
  72 }
  73
  74 /// moveBefore - Unlink this instruction from its current basic block and
  75 /// insert it into the basic block that MovePos lives in, right before
  76 /// MovePos.
  77 void Instruction::moveBefore(Instruction *MovePos) {
  78   MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
  79                                              this);
  80 }
  81
  82
  83 const char *Instruction::getOpcodeName(unsigned OpCode) {
  84   switch (OpCode) {
  85   // Terminators
  86   case Ret:    return "ret";
  87   case Br:     return "br";
  88   case Switch: return "switch";
  89   case Invoke: return "invoke";
  90   case Unwind: return "unwind";
  91   case Unreachable: return "unreachable";
  92
  93   // Standard binary operators...
  94   case Add: return "add";
  95   case Sub: return "sub";
  96   case Mul: return "mul";
  97   case UDiv: return "udiv";
  98   case SDiv: return "sdiv";
  99   case FDiv: return "fdiv";
 100   case URem: return "urem";
 101   case SRem: return "srem";
 102   case FRem: return "frem";
 103
 104   // Logical operators...
 105   case And: return "and";
 106   case Or : return "or";
 107   case Xor: return "xor";
 108
 109   // SetCC operators...
 110   case SetLE:  return "setle";
 111   case SetGE:  return "setge";
 112   case SetLT:  return "setlt";
 113   case SetGT:  return "setgt";
 114   case SetEQ:  return "seteq";
 115   case SetNE:  return "setne";
 116
 117   // Memory instructions...
 118   case Malloc:        return "malloc";
 119   case Free:          return "free";
 120   case Alloca:        return "alloca";
 121   case Load:          return "load";
 122   case Store:         return "store";
 123   case GetElementPtr: return "getelementptr";
 124
 125   // Other instructions...
 126   case PHI:     return "phi";
 127   case Cast:    return "cast";
 128   case Select:  return "select";
 129   case Call:    return "call";
 130   case Shl:     return "shl";
 131   case Shr:     return "shr";
 132   case VAArg:   return "va_arg";
 133   case ExtractElement: return "extractelement";
 134   case InsertElement: return "insertelement";
 135   case ShuffleVector: return "shufflevector";
 136
 137   default: return "<Invalid operator> ";
 138   }
 139
 140   return 0;
 141 }
 142
 143 /// isIdenticalTo - Return true if the specified instruction is exactly
 144 /// identical to the current one.  This means that all operands match and any
 145 /// extra information (e.g. load is volatile) agree.
 146 bool Instruction::isIdenticalTo(Instruction *I) const {
 147   if (getOpcode() != I->getOpcode() ||
 148       getNumOperands() != I->getNumOperands() ||
 149       getType() != I->getType())
 150     return false;
 151
 152   // We have two instructions of identical opcode and #operands.  Check to see
 153   // if all operands are the same.
 154   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 155     if (getOperand(i) != I->getOperand(i))
 156       return false;
 157
 158   // Check special state that is a part of some instructions.
 159   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 160     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
 161   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 162     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
 163   if (const CallInst *CI = dyn_cast<CallInst>(this))
 164     return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
 165   return true;
 166 }
 167
 168
 169 /// isAssociative - Return true if the instruction is associative:
 170 ///
 171 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z)
 172 ///
 173 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when not
 174 /// applied to floating point types.
 175 ///
 176 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
 177   if (Opcode == And || Opcode == Or || Opcode == Xor)
 178     return true;
 179
 180   // Add/Mul reassociate unless they are FP or FP vectors.
 181   if (Opcode == Add || Opcode == Mul)
 182     return !Ty->isFPOrFPVector();
 183   return 0;
 184 }
 185
 186 /// isCommutative - Return true if the instruction is commutative:
 187 ///
 188 ///   Commutative operators satisfy: (x op y) === (y op x)
 189 ///
 190 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 191 /// applied to any type.
 192 ///
 193 bool Instruction::isCommutative(unsigned op) {
 194   switch (op) {
 195   case Add:
 196   case Mul:
 197   case And:
 198   case Or:
 199   case Xor:
 200   case SetEQ:
 201   case SetNE:
 202     return true;
 203   default:
 204     return false;
 205   }
 206 }
 207
 208 /// isComparison - Return true if the instruction is a Set* instruction:
 209 ///
 210 bool Instruction::isComparison(unsigned op) {
 211   switch (op) {
 212   case SetEQ:
 213   case SetNE:
 214   case SetLT:
 215   case SetGT:
 216   case SetLE:
 217   case SetGE:
 218     return true;
 219   }
 220   return false;
 221 }
 222
 223
 224
 225 /// isTrappingInstruction - Return true if the instruction may trap.
 226 ///
 227 bool Instruction::isTrapping(unsigned op) {
 228   switch(op) {
 229   case UDiv:
 230   case SDiv:
 231   case FDiv:
 232   case URem:
 233   case SRem:
 234   case FRem:
 235   case Load:
 236   case Store:
 237   case Call:
 238   case Invoke:
 239     return true;
 240   default:
 241     return false;
 242   }
 243 }