1 //===-- Instruction.cpp - Implement the Instruction class -----------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Instruction class for the VMCore library.
12 //===----------------------------------------------------------------------===//
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"
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);
27 // If requested, insert this instruction into a basic block...
29 assert(InsertBefore->getParent() &&
30 "Instruction to insert before is not in a basic block!");
31 InsertBefore->getParent()->getInstList().insert(InsertBefore, this);
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);
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);
46 void Instruction::setOpcode(unsigned opc) {
47 setValueType(Value::InstructionVal + opc);
50 void Instruction::setParent(BasicBlock *P) {
52 if (!P) LeakDetector::addGarbageObject(this);
54 if (P) LeakDetector::removeGarbageObject(this);
60 void Instruction::removeFromParent() {
61 getParent()->getInstList().remove(this);
64 void Instruction::eraseFromParent() {
65 getParent()->getInstList().erase(this);
68 /// moveBefore - Unlink this instruction from its current basic block and
69 /// insert it into the basic block that MovePos lives in, right before
71 void Instruction::moveBefore(Instruction *MovePos) {
72 MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
77 const char *Instruction::getOpcodeName(unsigned OpCode) {
80 case Ret: return "ret";
82 case Switch: return "switch";
83 case Invoke: return "invoke";
84 case Unwind: return "unwind";
85 case Unreachable: return "unreachable";
87 // Standard binary operators...
88 case Add: return "add";
89 case Sub: return "sub";
90 case Mul: return "mul";
91 case Div: return "div";
92 case Rem: return "rem";
94 // Logical operators...
95 case And: return "and";
96 case Or : return "or";
97 case Xor: return "xor";
100 case SetLE: return "setle";
101 case SetGE: return "setge";
102 case SetLT: return "setlt";
103 case SetGT: return "setgt";
104 case SetEQ: return "seteq";
105 case SetNE: return "setne";
107 // Memory instructions...
108 case Malloc: return "malloc";
109 case Free: return "free";
110 case Alloca: return "alloca";
111 case Load: return "load";
112 case Store: return "store";
113 case GetElementPtr: return "getelementptr";
115 // Other instructions...
116 case PHI: return "phi";
117 case Cast: return "cast";
118 case Select: return "select";
119 case Call: return "call";
120 case Shl: return "shl";
121 case Shr: return "shr";
122 case VAArg: return "va_arg";
123 case ExtractElement: return "extractelement";
124 case InsertElement: return "insertelement";
125 case ShuffleVector: return "shufflevector";
127 default: return "<Invalid operator> ";
133 /// isIdenticalTo - Return true if the specified instruction is exactly
134 /// identical to the current one. This means that all operands match and any
135 /// extra information (e.g. load is volatile) agree.
136 bool Instruction::isIdenticalTo(Instruction *I) const {
137 if (getOpcode() != I->getOpcode() ||
138 getNumOperands() != I->getNumOperands() ||
139 getType() != I->getType())
142 // We have two instructions of identical opcode and #operands. Check to see
143 // if all operands are the same.
144 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
145 if (getOperand(i) != I->getOperand(i))
148 // Check special state that is a part of some instructions.
149 if (const LoadInst *LI = dyn_cast<LoadInst>(this))
150 return LI->isVolatile() == cast<LoadInst>(I)->isVolatile();
151 if (const StoreInst *SI = dyn_cast<StoreInst>(this))
152 return SI->isVolatile() == cast<StoreInst>(I)->isVolatile();
153 if (const CallInst *CI = dyn_cast<CallInst>(this))
154 return CI->isTailCall() == cast<CallInst>(I)->isTailCall();
159 /// isAssociative - Return true if the instruction is associative:
161 /// Associative operators satisfy: x op (y op z) === (x op y) op z)
163 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when not
164 /// applied to floating point types.
166 bool Instruction::isAssociative(unsigned Opcode, const Type *Ty) {
167 if (Opcode == Add || Opcode == Mul ||
168 Opcode == And || Opcode == Or || Opcode == Xor) {
169 // Floating point operations do not associate!
170 return !Ty->isFloatingPoint();
175 /// isCommutative - Return true if the instruction is commutative:
177 /// Commutative operators satisfy: (x op y) === (y op x)
179 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
180 /// applied to any type.
182 bool Instruction::isCommutative(unsigned op) {
197 /// isRelational - Return true if the instruction is a Set* instruction:
199 bool Instruction::isRelational(unsigned op) {
214 /// isTrappingInstruction - Return true if the instruction may trap.
216 bool Instruction::isTrapping(unsigned op) {