1 //===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains the declaration of the Instruction class, which is the
11 // base class for all of the LLVM instructions.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_INSTRUCTION_H
16 #define LLVM_INSTRUCTION_H
18 #include "llvm/User.h"
22 struct AssemblyAnnotationWriter;
25 template<typename ValueSubClass, typename ItemParentClass>
26 class SymbolTableListTraits;
28 class Instruction : public User {
29 void operator=(const Instruction &); // Do not implement
30 Instruction(const Instruction &); // Do not implement
33 Instruction *Prev, *Next; // Next and Prev links for our intrusive linked list
35 void setNext(Instruction *N) { Next = N; }
36 void setPrev(Instruction *N) { Prev = N; }
38 friend class SymbolTableListTraits<Instruction, BasicBlock>;
39 void setParent(BasicBlock *P);
41 Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
42 Instruction *InsertBefore = 0);
43 Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
44 BasicBlock *InsertAtEnd);
46 // Out of line virtual method, so the vtable, etc has a home.
49 /// mayWriteToMemory - Return true if this instruction may modify memory.
51 bool mayWriteToMemory() const;
53 /// clone() - Create a copy of 'this' instruction that is identical in all
54 /// ways except the following:
55 /// * The instruction has no parent
56 /// * The instruction has no name
58 virtual Instruction *clone() const = 0;
60 /// isIdenticalTo - Return true if the specified instruction is exactly
61 /// identical to the current one. This means that all operands match and any
62 /// extra information (e.g. load is volatile) agree.
63 bool isIdenticalTo(Instruction *I) const;
65 /// This function determines if the specified instruction executes the same
66 /// operation as the current one. This means that the opcodes, type, operand
67 /// types and any other factors affecting the operation must be the same. This
68 /// is similar to isIdenticalTo except the operands themselves don't have to
70 /// @returns true if the specified instruction is the same operation as
72 /// @brief Determine if one instruction is the same operation as another.
73 bool isSameOperationAs(Instruction *I) const;
75 /// use_back - Specialize the methods defined in Value, as we know that an
76 /// instruction can only be used by other instructions.
77 Instruction *use_back() { return cast<Instruction>(*use_begin());}
78 const Instruction *use_back() const { return cast<Instruction>(*use_begin());}
80 // Accessor methods...
82 inline const BasicBlock *getParent() const { return Parent; }
83 inline BasicBlock *getParent() { return Parent; }
85 /// removeFromParent - This method unlinks 'this' from the containing basic
86 /// block, but does not delete it.
88 void removeFromParent();
90 /// eraseFromParent - This method unlinks 'this' from the containing basic
91 /// block and deletes it.
93 void eraseFromParent();
95 /// moveBefore - Unlink this instruction from its current basic block and
96 /// insert it into the basic block that MovePos lives in, right before
98 void moveBefore(Instruction *MovePos);
100 // ---------------------------------------------------------------------------
101 /// Subclass classification... getOpcode() returns a member of
102 /// one of the enums that is coming soon (down below)...
104 unsigned getOpcode() const { return getValueID() - InstructionVal; }
105 const char *getOpcodeName() const { return getOpcodeName(getOpcode()); }
106 bool isTerminator() const { return isTerminator(getOpcode()); }
107 bool isBinaryOp() const { return isBinaryOp(getOpcode()); }
108 bool isShift() { return isShift(getOpcode()); }
109 bool isCast() const { return isCast(getOpcode()); }
113 static const char* getOpcodeName(unsigned OpCode);
115 static inline bool isTerminator(unsigned OpCode) {
116 return OpCode >= TermOpsBegin && OpCode < TermOpsEnd;
119 static inline bool isBinaryOp(unsigned Opcode) {
120 return Opcode >= BinaryOpsBegin && Opcode < BinaryOpsEnd;
123 /// @brief Determine if the Opcode is one of the shift instructions.
124 static inline bool isShift(unsigned Opcode) {
125 return Opcode >= Shl && Opcode <= AShr;
128 /// isLogicalShift - Return true if this is a logical shift left or a logical
130 inline bool isLogicalShift() {
131 return getOpcode() == Shl || getOpcode() == LShr;
134 /// isLogicalShift - Return true if this is a logical shift left or a logical
136 inline bool isArithmeticShift() {
137 return getOpcode() == AShr;
140 /// @brief Determine if the OpCode is one of the CastInst instructions.
141 static inline bool isCast(unsigned OpCode) {
142 return OpCode >= CastOpsBegin && OpCode < CastOpsEnd;
145 /// isAssociative - Return true if the instruction is associative:
147 /// Associative operators satisfy: x op (y op z) === (x op y) op z
149 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when
150 /// not applied to floating point types.
152 bool isAssociative() const { return isAssociative(getOpcode(), getType()); }
153 static bool isAssociative(unsigned op, const Type *Ty);
155 /// isCommutative - Return true if the instruction is commutative:
157 /// Commutative operators satisfy: (x op y) === (y op x)
159 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
160 /// applied to any type.
162 bool isCommutative() const { return isCommutative(getOpcode()); }
163 static bool isCommutative(unsigned op);
165 /// isTrappingInstruction - Return true if the instruction may trap.
167 bool isTrapping() const {
168 return isTrapping(getOpcode());
170 static bool isTrapping(unsigned op);
172 virtual void print(std::ostream &OS) const { print(OS, 0); }
173 void print(std::ostream *OS) const { if (OS) print(*OS); }
174 void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
176 /// Methods for support type inquiry through isa, cast, and dyn_cast:
177 static inline bool classof(const Instruction *) { return true; }
178 static inline bool classof(const Value *V) {
179 return V->getValueID() >= Value::InstructionVal;
182 //----------------------------------------------------------------------
183 // Exported enumerations...
185 enum TermOps { // These terminate basic blocks
186 #define FIRST_TERM_INST(N) TermOpsBegin = N,
187 #define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
188 #define LAST_TERM_INST(N) TermOpsEnd = N+1
189 #include "llvm/Instruction.def"
193 #define FIRST_BINARY_INST(N) BinaryOpsBegin = N,
194 #define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
195 #define LAST_BINARY_INST(N) BinaryOpsEnd = N+1
196 #include "llvm/Instruction.def"
200 #define FIRST_MEMORY_INST(N) MemoryOpsBegin = N,
201 #define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
202 #define LAST_MEMORY_INST(N) MemoryOpsEnd = N+1
203 #include "llvm/Instruction.def"
207 #define FIRST_CAST_INST(N) CastOpsBegin = N,
208 #define HANDLE_CAST_INST(N, OPC, CLASS) OPC = N,
209 #define LAST_CAST_INST(N) CastOpsEnd = N+1
210 #include "llvm/Instruction.def"
214 #define FIRST_OTHER_INST(N) OtherOpsBegin = N,
215 #define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
216 #define LAST_OTHER_INST(N) OtherOpsEnd = N+1
217 #include "llvm/Instruction.def"
221 // getNext/Prev - Return the next or previous instruction in the list. The
222 // last node in the list is a terminator instruction.
223 Instruction *getNext() { return Next; }
224 const Instruction *getNext() const { return Next; }
225 Instruction *getPrev() { return Prev; }
226 const Instruction *getPrev() const { return Prev; }
229 } // End llvm namespace