X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FInstruction.h;h=8da89e2f3893abf51b2f125454bf9d12c9280daf;hb=80a75bfae980df96f969f1c05b0c4a80ce975240;hp=cce9662122de771a286752a275bba9a61a4bf327;hpb=71496b3b50cfcba84eb4acd988ce88a4463e4515;p=oota-llvm.git diff --git a/include/llvm/Instruction.h b/include/llvm/Instruction.h index cce9662122d..8da89e2f389 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 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. // //===----------------------------------------------------------------------===// @@ -10,115 +17,223 @@ #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; +class BinaryOperator; -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; + + /// 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(*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 + + /// removeFromParent - This method unlinks 'this' from the containing basic + /// block, but does not delete it. + /// + void removeFromParent(); + + /// 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 const char *getOpcodeName() const = 0; - unsigned getOpcode() const { return iType; } + /// 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()); + } + static const char* getOpcodeName(unsigned OpCode); - // getInstType is deprecated, use getOpcode() instead. - unsigned getInstType() const { return iType; } + static inline bool isTerminator(unsigned OpCode) { + return OpCode >= TermOpsBegin && OpCode < TermOpsEnd; + } inline bool isTerminator() const { // Instance of TerminatorInst? - return iType >= FirstTermOp && iType < NumTermOps; - } - inline bool isDefinition() const { return !isTerminator(); } - inline bool isUnaryOp() const { - return iType >= FirstUnaryOp && iType < NumUnaryOps; + return isTerminator(getOpcode()); } + inline bool isBinaryOp() const { - return iType >= FirstBinaryOp && iType < NumBinaryOps; + return getOpcode() >= BinaryOpsBegin && getOpcode() < BinaryOpsEnd; + } + + /// @brief Determine if the Opcode is one of the shift instructions. + static inline bool isShift(unsigned Opcode) { + return Opcode >= Shl && Opcode <= AShr; + } + + /// @brief Determine if the instruction's opcode is one of the shift + /// instructions. + inline bool isShift() { return isShift(getOpcode()); } + + /// isLogicalShift - Return true if this is a logical shift left or a logical + /// shift right. + inline bool isLogicalShift() { + return getOpcode() == Shl || getOpcode() == LShr; + } + + /// isLogicalShift - Return true if this is a logical shift left or a logical + /// shift right. + inline bool isArithmeticShift() { + 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; } - // isPHINode() - This is used frequently enough to allow it to exist - inline bool isPHINode() const { return iType == PHINode; } + /// @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->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, - Not = NumTermOps, // Binary inverse - - 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 +#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" + }; - NumMemoryOps + 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" }; enum OtherOps { - FirstOtherOp = NumMemoryOps, - PHINode = NumMemoryOps, // PHI node instruction - Cast, // Type cast... - Call, // Call a function - - Shl, Shr, // Shift operations... - - NumOps, // Must be the last 'op' defined. - UserOp1, UserOp2 // May be used internally to a pass... +#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; } }; +} // End llvm namespace + #endif