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 // Specialize setName to take care of symbol table majik
  61 void Instruction::setName(const std::string &name, SymbolTable *ST) {
  62   BasicBlock *P = 0; Function *PP = 0;
  63   assert((ST == 0 || !getParent() || !getParent()->getParent() ||
  64           ST == &getParent()->getParent()->getSymbolTable()) &&
  65          "Invalid symtab argument!");
  66   if ((P = getParent()) && (PP = P->getParent()) && hasName())
  67     PP->getSymbolTable().remove(this);
  68   Value::setName(name);
  69   if (PP && hasName()) PP->getSymbolTable().insert(this);
  70 }
  71
  72 void Instruction::removeFromParent() {
  73   getParent()->getInstList().remove(this);
  74 }
  75
  76 void Instruction::eraseFromParent() {
  77   getParent()->getInstList().erase(this);
  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 Div: return "div";
  95   case Rem: return "rem";
  96
  97   // Logical operators...
  98   case And: return "and";
  99   case Or : return "or";
 100   case Xor: return "xor";
 101
 102   // SetCC operators...
 103   case SetLE:  return "setle";
 104   case SetGE:  return "setge";
 105   case SetLT:  return "setlt";
 106   case SetGT:  return "setgt";
 107   case SetEQ:  return "seteq";
 108   case SetNE:  return "setne";
 109
 110   // Memory instructions...
 111   case Malloc:        return "malloc";
 112   case Free:          return "free";
 113   case Alloca:        return "alloca";
 114   case Load:          return "load";
 115   case Store:         return "store";
 116   case GetElementPtr: return "getelementptr";
 117
 118   // Other instructions...
 119   case PHI:     return "phi";
 120   case Cast:    return "cast";
 121   case Select:  return "select";
 122   case Call:    return "call";
 123   case Shl:     return "shl";
 124   case Shr:     return "shr";
 125   case VANext:  return "vanext";
 126   case VAArg:   return "vaarg";
 127
 128   default: return "<Invalid operator> ";
 129   }
 130
 131   return 0;
 132 }
 133
 134 /// isIdenticalTo - Return true if the specified instruction is exactly
 135 /// identical to the current one.  This means that all operands match and any
 136 /// extra information (e.g. load is volatile) agree.
 137 bool Instruction::isIdenticalTo(Instruction *I) const {
 138   if (getOpcode() != I->getOpcode() ||
 139       getNumOperands() != I->getNumOperands() ||
 140       getType() != I->getType())
 141     return false;
 142
 143   // We have two instructions of identical opcode and #operands.  Check to see
 144   // if all operands are the same.
 145   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 146     if (getOperand(i) != I->getOperand(i))
 147       return false;
 148
 149   // Check special state that is a part of some instructions.
 150   if (const LoadInst *LI = dyn_cast<LoadInst>(this))
 151     return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
 152   if (const StoreInst *SI = dyn_cast<StoreInst>(this))
 153     return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
 154   if (const VANextInst *VAN = dyn_cast<VANextInst>(this))
 155     return VAN->getArgType() == cast<VANextInst>(I)->getArgType();
 156   return true;
 157 }
 158
 159
 160 /// isAssociative - Return true if the instruction is associative:
 161 ///
 162 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z)
 163 ///
 164 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when not
 165 /// applied to floating point types.
 166 ///
 167 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
 168   if (Opcode == Add || Opcode == Mul ||
 169       Opcode == And || Opcode == Or || Opcode == Xor) {
 170     // Floating point operations do not associate!
 171     return !Ty->isFloatingPoint();
 172   }
 173   return 0;
 174 }
 175
 176 /// isCommutative - Return true if the instruction is commutative:
 177 ///
 178 ///   Commutative operators satisfy: (x op y) === (y op x)
 179 ///
 180 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 181 /// applied to any type.
 182 ///
 183 bool Instruction::isCommutative(unsigned op) {
 184   switch (op) {
 185   case Add:
 186   case Mul:
 187   case And:
 188   case Or:
 189   case Xor:
 190   case SetEQ:
 191   case SetNE:
 192     return true;
 193   default:
 194     return false;
 195   }
 196 }
 197
 198 /// isRelational - Return true if the instruction is a Set* instruction:
 199 ///
 200 bool Instruction::isRelational(unsigned op) {
 201   switch (op) {
 202   case SetEQ:
 203   case SetNE:
 204   case SetLT:
 205   case SetGT:
 206   case SetLE:
 207   case SetGE:
 208     return true;
 209   }
 210   return false;
 211 }
 212
 213
 214
 215 /// isTrappingInstruction - Return true if the instruction may trap.
 216 ///
 217 bool Instruction::isTrapping(unsigned op) {
 218   switch(op) {
 219   case Div:
 220   case Rem:
 221   case Load:
 222   case Store:
 223   case Call:
 224   case Invoke:
 225     return true;
 226   default:
 227     return false;
 228   }
 229 }