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 void Instruction::setOpcode(unsigned opc) {
  47   setValueType(Value::InstructionVal + opc);
  48 }
  49
  50 void Instruction::setParent(BasicBlock *P) {
  51   if (getParent()) {
  52     if (!P) LeakDetector::addGarbageObject(this);
  53   } else {
  54     if (P) LeakDetector::removeGarbageObject(this);
  55   }
  56
  57   Parent = P;
  58 }
  59
  60 void Instruction::removeFromParent() {
  61   getParent()->getInstList().remove(this);
  62 }
  63
  64 void Instruction::eraseFromParent() {
  65   getParent()->getInstList().erase(this);
  66 }
  67
  68 const char *Instruction::getOpcodeName(unsigned OpCode) {
  69   switch (OpCode) {
  70   // Terminators
  71   case Ret:    return "ret";
  72   case Br:     return "br";
  73   case Switch: return "switch";
  74   case Invoke: return "invoke";
  75   case Unwind: return "unwind";
  76   case Unreachable: return "unreachable";
  77
  78   // Standard binary operators...
  79   case Add: return "add";
  80   case Sub: return "sub";
  81   case Mul: return "mul";
  82   case Div: return "div";
  83   case Rem: return "rem";
  84
  85   // Logical operators...
  86   case And: return "and";
  87   case Or : return "or";
  88   case Xor: return "xor";
  89
  90   // SetCC operators...
  91   case SetLE:  return "setle";
  92   case SetGE:  return "setge";
  93   case SetLT:  return "setlt";
  94   case SetGT:  return "setgt";
  95   case SetEQ:  return "seteq";
  96   case SetNE:  return "setne";
  97
  98   // Memory instructions...
  99   case Malloc:        return "malloc";
 100   case Free:          return "free";
 101   case Alloca:        return "alloca";
 102   case Load:          return "load";
 103   case Store:         return "store";
 104   case GetElementPtr: return "getelementptr";
 105
 106   // Other instructions...
 107   case PHI:     return "phi";
 108   case Cast:    return "cast";
 109   case Select:  return "select";
 110   case Call:    return "call";
 111   case Shl:     return "shl";
 112   case Shr:     return "shr";
 113   case VAArg:   return "va_arg";
 114
 115   default: return "<Invalid operator> ";
 116   }
 117
 118   return 0;
 119 }
 120
 121 /// isIdenticalTo - Return true if the specified instruction is exactly
 122 /// identical to the current one.  This means that all operands match and any
 123 /// extra information (e.g. load is volatile) agree.
 124 bool Instruction::isIdenticalTo(Instruction *I) const {
 125   if (getOpcode() != I->getOpcode() ||
 126       getNumOperands() != I->getNumOperands() ||
 127       getType() != I->getType())
 128     return false;
 129
 130   // We have two instructions of identical opcode and #operands.  Check to see
 131   // if all operands are the same.
 132   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 133     if (getOperand(i) != I->getOperand(i))
 134       return false;
 135
 136   // Check special state that is a part of some instructions.
 137   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 138     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
 139   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 140     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
 141   if (const CallInst *CI = dyn_cast<CallInst>(this))
 142     return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
 143   return true;
 144 }
 145
 146
 147 /// isAssociative - Return true if the instruction is associative:
 148 ///
 149 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z)
 150 ///
 151 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when not
 152 /// applied to floating point types.
 153 ///
 154 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
 155   if (Opcode == Add || Opcode == Mul ||
 156       Opcode == And || Opcode == Or || Opcode == Xor) {
 157     // Floating point operations do not associate!
 158     return !Ty->isFloatingPoint();
 159   }
 160   return 0;
 161 }
 162
 163 /// isCommutative - Return true if the instruction is commutative:
 164 ///
 165 ///   Commutative operators satisfy: (x op y) === (y op x)
 166 ///
 167 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 168 /// applied to any type.
 169 ///
 170 bool Instruction::isCommutative(unsigned op) {
 171   switch (op) {
 172   case Add:
 173   case Mul:
 174   case And:
 175   case Or:
 176   case Xor:
 177   case SetEQ:
 178   case SetNE:
 179     return true;
 180   default:
 181     return false;
 182   }
 183 }
 184
 185 /// isRelational - Return true if the instruction is a Set* instruction:
 186 ///
 187 bool Instruction::isRelational(unsigned op) {
 188   switch (op) {
 189   case SetEQ:
 190   case SetNE:
 191   case SetLT:
 192   case SetGT:
 193   case SetLE:
 194   case SetGE:
 195     return true;
 196   }
 197   return false;
 198 }
 199
 200
 201
 202 /// isTrappingInstruction - Return true if the instruction may trap.
 203 ///
 204 bool Instruction::isTrapping(unsigned op) {
 205   switch(op) {
 206   case Div:
 207   case Rem:
 208   case Load:
 209   case Store:
 210   case Call:
 211   case Invoke:
 212     return true;
 213   default:
 214     return false;
 215   }
 216 }