-//===-- llvm/Instruction.h - Instruction class definition --------*- C++ -*--=//
+//===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file contains the declaration of the Instruction class, which is the
-// base class for all of the VM instructions.
+// base class for all of the LLVM instructions.
//
//===----------------------------------------------------------------------===//
#include "llvm/User.h"
-class Type;
-class BasicBlock;
-class Method;
-
-class Instruction : public User {
- BasicBlock *Parent;
- unsigned iType; // InstructionType
+namespace llvm {
- friend class ValueHolder<Instruction,BasicBlock>;
- inline void setParent(BasicBlock *P) { Parent = P; }
+struct AssemblyAnnotationWriter;
+class BinaryOperator;
-public:
- Instruction(const Type *Ty, unsigned iType, const string &Name = "");
- virtual ~Instruction(); // Virtual dtor == good.
+template<typename SC> struct ilist_traits;
+template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
+ typename SubClass> class SymbolTableListTraits;
- // Specialize setName to handle symbol table majik...
- virtual void setName(const string &name);
+class Instruction : public User {
+ void operator=(const Instruction &); // Do not implement
+ Instruction(const Instruction &); // Do not implement
- // clone() - Create a copy of 'this' instruction that is identical in all ways
- // except the following:
- // * The instruction has no parent
- // * The instruction has no name
- //
+ BasicBlock *Parent;
+ Instruction *Prev, *Next; // Next and Prev links for our intrusive linked list
+
+ void setNext(Instruction *N) { Next = N; }
+ void setPrev(Instruction *N) { Prev = N; }
+
+ friend class SymbolTableListTraits<Instruction, BasicBlock, Function,
+ ilist_traits<Instruction> >;
+ void setParent(BasicBlock *P);
+
+private:
+ // FIXME: This is a dirty hack. Setcc instructions shouldn't encode the CC
+ // into the opcode field. When they don't, this will be unneeded.
+ void setOpcode(unsigned NewOpcode);
+ friend class BinaryOperator;
+protected:
+ Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
+ const std::string &Name = "",
+ Instruction *InsertBefore = 0);
+ Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
+ const std::string &Name, BasicBlock *InsertAtEnd);
+public:
+ // Out of line virtual method, so the vtable, etc has a home.
+ ~Instruction();
+
+ /// mayWriteToMemory - Return true if this instruction may modify memory.
+ ///
+ virtual bool mayWriteToMemory() const { return false; }
+
+ /// clone() - Create a copy of 'this' instruction that is identical in all
+ /// ways except the following:
+ /// * The instruction has no parent
+ /// * The instruction has no name
+ ///
virtual Instruction *clone() const = 0;
+ /// isIdenticalTo - Return true if the specified instruction is exactly
+ /// identical to the current one. This means that all operands match and any
+ /// extra information (e.g. load is volatile) agree.
+ bool isIdenticalTo(Instruction *I) const;
+
+ /// This function determines if the specified instruction executes the same
+ /// operation as the current one. This means that the opcodes, type, operand
+ /// types and any other factors affecting the operation must be the same. This
+ /// is similar to isIdenticalTo except the operands themselves don't have to
+ /// be identical.
+ /// @returns true if the specified instruction is the same operation as
+ /// the current one.
+ /// @brief Determine if one instruction is the same operation as another.
+ bool isSameOperationAs(Instruction *I) const;
+
+ /// use_back - Specialize the methods defined in Value, as we know that an
+ /// instruction can only be used by other instructions.
+ Instruction *use_back() { return cast<Instruction>(*use_begin());}
+ const Instruction *use_back() const { return cast<Instruction>(*use_begin());}
+
// Accessor methods...
//
inline const BasicBlock *getParent() const { return Parent; }
inline BasicBlock *getParent() { return Parent; }
- bool hasSideEffects() const { return false; } // Memory & Call insts = true
- // ---------------------------------------------------------------------------
- // Implement the User interface
- // if i > the number of operands, then getOperand() returns 0, and setOperand
- // returns false. setOperand() may also return false if the operand is of
- // the wrong type.
- //
- inline Value *getOperand(unsigned i) {
- return (Value*)((const Instruction *)this)->getOperand(i);
- }
- virtual const Value *getOperand(unsigned i) const = 0;
- virtual bool setOperand(unsigned i, Value *Val) = 0;
- virtual unsigned getNumOperands() const = 0;
+ // getNext/Prev - Return the next or previous instruction in the list. The
+ // last node in the list is a terminator instruction.
+ Instruction *getNext() { return Next; }
+ const Instruction *getNext() const { return Next; }
+ Instruction *getPrev() { return Prev; }
+ const Instruction *getPrev() const { return Prev; }
- // ---------------------------------------------------------------------------
- // Operand Iterator interface...
- //
- template <class _Inst, class _Val> class OperandIterator;
- typedef OperandIterator<Instruction *, Value *> op_iterator;
- typedef OperandIterator<const Instruction *, const Value *> op_const_iterator;
+ /// removeFromParent - This method unlinks 'this' from the containing basic
+ /// block, but does not delete it.
+ ///
+ void removeFromParent();
- inline op_iterator op_begin() ;
- inline op_const_iterator op_begin() const;
- inline op_iterator op_end() ;
- inline op_const_iterator op_end() const;
+ /// eraseFromParent - This method unlinks 'this' from the containing basic
+ /// block and deletes it.
+ ///
+ void eraseFromParent();
+ /// moveBefore - Unlink this instruction from its current basic block and
+ /// insert it into the basic block that MovePos lives in, right before
+ /// MovePos.
+ void moveBefore(Instruction *MovePos);
// ---------------------------------------------------------------------------
- // Subclass classification... getInstType() returns a member of
- // one of the enums that is coming soon (down below)...
- //
- virtual string getOpcode() const = 0;
+ /// Subclass classification... getOpcode() returns a member of
+ /// one of the enums that is coming soon (down below)...
+ ///
+ unsigned getOpcode() const { return getValueType() - InstructionVal; }
+ const char *getOpcodeName() const {
+ return getOpcodeName(getOpcode());
+ }
+ static const char* getOpcodeName(unsigned OpCode);
- unsigned getInstType() const { return iType; }
- inline bool isTerminator() const { // Instance of TerminatorInst?
- return iType >= FirstTermOp && iType < NumTermOps;
+ static inline bool isTerminator(unsigned OpCode) {
+ return OpCode >= TermOpsBegin && OpCode < TermOpsEnd;
}
- inline bool isDefinition() const { return !isTerminator(); }
- inline bool isUnaryOp() const {
- return iType >= FirstUnaryOp && iType < NumUnaryOps;
+
+ inline bool isTerminator() const { // Instance of TerminatorInst?
+ return isTerminator(getOpcode());
}
+
inline bool isBinaryOp() const {
- return iType >= FirstBinaryOp && iType < NumBinaryOps;
+ return getOpcode() >= BinaryOpsBegin && getOpcode() < BinaryOpsEnd;
}
- static Instruction *getBinaryOperator(unsigned Op, Value *S1, Value *S2);
- static Instruction *getUnaryOperator (unsigned Op, Value *Source);
+ /// @brief Determine if the OpCode is one of the CastInst instructions.
+ static inline bool isCast(unsigned OpCode) {
+ return OpCode >= CastOpsBegin && OpCode < CastOpsEnd;
+ }
+ /// @brief Determine if this is one of the CastInst instructions.
+ inline bool isCast() const {
+ return isCast(getOpcode());
+ }
+
+ /// isAssociative - Return true if the instruction is associative:
+ ///
+ /// Associative operators satisfy: x op (y op z) === (x op y) op z
+ ///
+ /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative, when
+ /// not applied to floating point types.
+ ///
+ bool isAssociative() const { return isAssociative(getOpcode(), getType()); }
+ static bool isAssociative(unsigned op, const Type *Ty);
+
+ /// isCommutative - Return true if the instruction is commutative:
+ ///
+ /// Commutative operators satisfy: (x op y) === (y op x)
+ ///
+ /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
+ /// applied to any type.
+ ///
+ bool isCommutative() const { return isCommutative(getOpcode()); }
+ static bool isCommutative(unsigned op);
+
+ /// isTrappingInstruction - Return true if the instruction may trap.
+ ///
+ bool isTrapping() const {
+ return isTrapping(getOpcode());
+ }
+ static bool isTrapping(unsigned op);
+
+ virtual void print(std::ostream &OS) const { print(OS, 0); }
+ void print(std::ostream *OS) const { if (OS) print(*OS); }
+ void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
+
+ /// Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const Instruction *) { return true; }
+ static inline bool classof(const Value *V) {
+ return V->getValueType() >= Value::InstructionVal;
+ }
//----------------------------------------------------------------------
// Exported enumerations...
//
enum TermOps { // These terminate basic blocks
- FirstTermOp = 1,
- Ret = 1, Br, Switch,
- NumTermOps // Must remain at end of enum
- };
-
- enum UnaryOps {
- FirstUnaryOp = NumTermOps,
- Neg = NumTermOps, Not,
-
- // Type conversions...
- ToBoolTy ,
- ToUByteTy , ToSByteTy, ToUShortTy, ToShortTy,
- ToUInt , ToInt, ToULongTy , ToLongTy,
-
- ToFloatTy , ToDoubleTy, ToArrayTy , ToPointerTy,
-
- NumUnaryOps // Must remain at end of enum
+#define FIRST_TERM_INST(N) TermOpsBegin = N,
+#define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
+#define LAST_TERM_INST(N) TermOpsEnd = N+1
+#include "llvm/Instruction.def"
};
enum BinaryOps {
- // Standard binary operators...
- FirstBinaryOp = NumUnaryOps,
- Add = NumUnaryOps, Sub, Mul, Div, Rem,
-
- // Logical operators...
- And, Or, Xor,
-
- // Binary comparison operators...
- SetEQ, SetNE, SetLE, SetGE, SetLT, SetGT,
-
- NumBinaryOps
+#define FIRST_BINARY_INST(N) BinaryOpsBegin = N,
+#define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
+#define LAST_BINARY_INST(N) BinaryOpsEnd = N+1
+#include "llvm/Instruction.def"
};
enum MemoryOps {
- FirstMemoryOp = NumBinaryOps,
- Malloc = NumBinaryOps, Free, // Heap management instructions
- Alloca, // Stack management instruction
-
- Load, Store, // Memory manipulation instructions.
-
- GetField, PutField, // Structure manipulation instructions
-
- NumMemoryOps
+#define FIRST_MEMORY_INST(N) MemoryOpsBegin = N,
+#define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
+#define LAST_MEMORY_INST(N) MemoryOpsEnd = N+1
+#include "llvm/Instruction.def"
};
- enum OtherOps {
- FirstOtherOp = NumMemoryOps,
- PHINode = NumMemoryOps, // PHI node instruction
- Call, // Call a function
-
- Shl, Shr, // Shift operations...
-
- NumOps, // Must be the last 'op' defined.
- UserOp1, UserOp2 // May be used internally to a pass...
+ enum CastOps {
+#define FIRST_CAST_INST(N) CastOpsBegin = N,
+#define HANDLE_CAST_INST(N, OPC, CLASS) OPC = N,
+#define LAST_CAST_INST(N) CastOpsEnd = N+1
+#include "llvm/Instruction.def"
};
-public:
- template <class _Inst, class _Val> // Operand Iterator Implementation
- class OperandIterator {
- const _Inst Inst;
- unsigned idx;
- public:
- typedef OperandIterator<_Inst, _Val> _Self;
- typedef forward_iterator_tag iterator_category;
- typedef _Val pointer;
-
- inline OperandIterator(_Inst T) : Inst(T), idx(0) {} // begin iterator
- inline OperandIterator(_Inst T, bool)
- : Inst(T), idx(Inst->getNumOperands()) {} // end iterator
-
- inline bool operator==(const _Self& x) const { return idx == x.idx; }
- inline bool operator!=(const _Self& x) const { return !operator==(x); }
-
- inline pointer operator*() const { return Inst->getOperand(idx); }
- inline pointer *operator->() const { return &(operator*()); }
-
- inline _Self& operator++() { ++idx; return *this; } // Preincrement
- inline _Self operator++(int) { // Postincrement
- _Self tmp = *this; ++*this; return tmp;
- }
-
- inline _Self& operator--() { --idx; return *this; } // Predecrement
- inline _Self operator--(int) { // Postdecrement
- _Self tmp = *this; --*this; return tmp;
- }
+ enum OtherOps {
+#define FIRST_OTHER_INST(N) OtherOpsBegin = N,
+#define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
+#define LAST_OTHER_INST(N) OtherOpsEnd = N+1
+#include "llvm/Instruction.def"
};
-
};
-inline Instruction::op_iterator Instruction::op_begin() {
- return op_iterator(this);
-}
-inline Instruction::op_const_iterator Instruction::op_begin() const {
- return op_const_iterator(this);
-}
-inline Instruction::op_iterator Instruction::op_end() {
- return op_iterator(this,true);
-}
-inline Instruction::op_const_iterator Instruction::op_end() const {
- return op_const_iterator(this,true);
-}
-
+} // End llvm namespace
#endif
projects / oota-llvm.git / blobdiff