X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FInstruction.h;h=89e3e2349987b70d5fd25dff3ce4e347e061a228;hb=99ec779a93cf7a09ac336b63d2d67818960343a1;hp=871ed037ef1d27762cb26046042ee7c5637eb128;hpb=3bcd6394ecd3c928d2ea05bb64cacdcae8dc677a;p=oota-llvm.git diff --git a/include/llvm/Instruction.h b/include/llvm/Instruction.h index 871ed037ef1..89e3e234998 100644 --- a/include/llvm/Instruction.h +++ b/include/llvm/Instruction.h @@ -1,7 +1,14 @@ -//===-- llvm/Instruction.h - Instruction class definition --------*- C++ -*--=// +//===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file 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. // //===----------------------------------------------------------------------===// @@ -10,190 +17,229 @@ #include "llvm/User.h" -class Type; -class BasicBlock; -class Method; - -class Instruction : public User { - BasicBlock *Parent; - unsigned iType; // InstructionType +namespace llvm { - friend class ValueHolder; - inline void setParent(BasicBlock *P) { Parent = P; } +struct AssemblyAnnotationWriter; -public: - Instruction(const Type *Ty, unsigned iType, const string &Name = ""); - virtual ~Instruction(); // Virtual dtor == good. +template + 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; + void setParent(BasicBlock *P); +protected: + Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, + Instruction *InsertBefore = 0); + Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, + 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. + /// + bool mayWriteToMemory() const; + + /// mayReadFromMemory - Return true if this instruction may read memory. + /// + bool mayReadFromMemory() const; + + /// 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; + + /// isUsedOutsideOfBlock - Return true if there are any uses of this + /// instruction in blocks other than the specified block. Note that PHI nodes + /// are considered to evaluate their operands in the corresponding predecessor + /// block. + bool isUsedOutsideOfBlock(const BasicBlock *BB) 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(*use_begin());} + const Instruction *use_back() const { return cast(*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; + /// removeFromParent - This method unlinks 'this' from the containing basic + /// block, but does not delete it. + /// + void removeFromParent(); - // --------------------------------------------------------------------------- - // Operand Iterator interface... - // - template class OperandIterator; - typedef OperandIterator op_iterator; - typedef OperandIterator op_const_iterator; + /// eraseFromParent - This method unlinks 'this' from the containing basic + /// block and deletes it. + /// + void eraseFromParent(); - inline op_iterator op_begin() ; - inline op_const_iterator op_begin() const; - inline op_iterator op_end() ; - inline op_const_iterator op_end() const; + /// insertBefore - Insert an unlinked instructions into a basic block + /// immediately before the specified instruction. + void insertBefore(Instruction *InsertPos); + /// 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 getValueID() - InstructionVal; } + const char *getOpcodeName() const { return getOpcodeName(getOpcode()); } + bool isTerminator() const { return isTerminator(getOpcode()); } + bool isBinaryOp() const { return isBinaryOp(getOpcode()); } + bool isShift() { return isShift(getOpcode()); } + bool isCast() const { return isCast(getOpcode()); } + + + + static const char* getOpcodeName(unsigned OpCode); + + static inline bool isTerminator(unsigned OpCode) { + return OpCode >= TermOpsBegin && OpCode < TermOpsEnd; + } - unsigned getInstType() const { return iType; } - inline bool isTerminator() const { // Instance of TerminatorInst? - return iType >= FirstTermOp && iType < NumTermOps; + static inline bool isBinaryOp(unsigned Opcode) { + return Opcode >= BinaryOpsBegin && Opcode < BinaryOpsEnd; } - inline bool isDefinition() const { return !isTerminator(); } - inline bool isUnaryOp() const { - return iType >= FirstUnaryOp && iType < NumUnaryOps; + + /// @brief Determine if the Opcode is one of the shift instructions. + static inline bool isShift(unsigned Opcode) { + return Opcode >= Shl && Opcode <= AShr; } - inline bool isBinaryOp() const { - return iType >= FirstBinaryOp && iType < NumBinaryOps; + + /// isLogicalShift - Return true if this is a logical shift left or a logical + /// shift right. + inline bool isLogicalShift() const { + return getOpcode() == Shl || getOpcode() == LShr; } - // isPHINode() - This is used frequently enough to allow it to exist - inline bool isPHINode() const { return iType == PHINode; } + /// isLogicalShift - Return true if this is a logical shift left or a logical + /// shift right. + inline bool isArithmeticShift() const { + return getOpcode() == AShr; + } + /// @brief Determine if the OpCode is one of the CastInst instructions. + static inline bool isCast(unsigned OpCode) { + return OpCode >= CastOpsBegin && OpCode < CastOpsEnd; + } + + /// 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->getValueID() >= 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 // Operand Iterator Implementation - class OperandIterator { - const _Inst Inst; - unsigned idx; - public: - typedef OperandIterator<_Inst, _Val> _Self; - typedef bidirectional_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" }; - + +private: + // 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; } }; -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