-//===-- 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 MachineInstr;
-class MachineCodeForVMInstr;
+template<typename SC> struct ilist_traits;
+template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
+ typename SubClass> class SymbolTableListTraits;
class Instruction : public User {
BasicBlock *Parent;
- unsigned iType; // InstructionType
+ Instruction *Prev, *Next; // Next and Prev links for our intrusive linked list
+
+ void setNext(Instruction *N) { Next = N; }
+ void setPrev(Instruction *N) { Prev = N; }
- MachineCodeForVMInstr* machineInstrVec;
- friend class ValueHolder<Instruction,BasicBlock,Method>;
- inline void setParent(BasicBlock *P) { Parent = P; }
+ friend class SymbolTableListTraits<Instruction, BasicBlock, Function,
+ ilist_traits<Instruction> >;
+ void setParent(BasicBlock *P);
+protected:
+ unsigned iType; // InstructionType: The opcode of the instruction
+ Instruction(const Type *Ty, unsigned iType, const std::string &Name = "",
+ Instruction *InsertBefore = 0);
public:
- Instruction(const Type *Ty, unsigned iType, const string &Name = "");
- virtual ~Instruction(); // Virtual dtor == good.
// Specialize setName to handle symbol table majik...
- virtual void setName(const string &name, SymbolTable *ST = 0);
+ virtual void setName(const std::string &name, SymbolTable *ST = 0);
- // 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
- //
+ /// 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;
// Accessor methods...
//
inline const BasicBlock *getParent() const { return Parent; }
inline BasicBlock *getParent() { return Parent; }
- virtual bool hasSideEffects() const { return false; } // Memory & Call insts
+
+ // 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; }
+
+ /// mayWriteToMemory - Return true if this instruction may modify memory.
+ ///
+ virtual bool mayWriteToMemory() const { return false; }
// ---------------------------------------------------------------------------
- // Machine code accessors...
- //
- inline MachineCodeForVMInstr &getMachineInstrVec() const {
- return *machineInstrVec;
- }
-
- // Add a machine instruction used to implement this instruction
- //
- void addMachineInstruction(MachineInstr* minstr);
-
- // ---------------------------------------------------------------------------
- // Subclass classification... getInstType() returns a member of
- // one of the enums that is coming soon (down below)...
- //
- virtual const char *getOpcodeName() const = 0;
+ /// Subclass classification... getOpcode() returns a member of
+ /// one of the enums that is coming soon (down below)...
+ ///
unsigned getOpcode() const { return iType; }
-
- // getInstType is deprecated, use getOpcode() instead.
- unsigned getInstType() const { return iType; }
+ virtual const char *getOpcodeName() const {
+ return getOpcodeName(getOpcode());
+ }
+ static const char* getOpcodeName(unsigned OpCode);
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 iType >= TermOpsBegin && iType < TermOpsEnd;
}
inline bool isBinaryOp() const {
- return iType >= FirstBinaryOp && iType < NumBinaryOps;
+ return iType >= BinaryOpsBegin && iType < BinaryOpsEnd;
}
- // dropAllReferences() - This function is in charge of "letting go" of all
- // objects that this Instruction refers to. This first lets go of all
- // references to hidden values generated code for this instruction,
- // and then drops all references to its operands.
- //
- void dropAllReferences();
-
+ /// 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;
- // Methods for support type inquiry through isa, cast, and dyn_cast:
+ /// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const Instruction *I) { return true; }
static inline bool classof(const Value *V) {
return V->getValueType() == Value::InstructionVal;
// Exported enumerations...
//
enum TermOps { // These terminate basic blocks
-#define FIRST_TERM_INST(N) FirstTermOp = N,
+#define FIRST_TERM_INST(N) TermOpsBegin = N,
#define HANDLE_TERM_INST(N, OPC, CLASS) OPC = N,
-#define LAST_TERM_INST(N) NumTermOps = N+1,
-#include "llvm/Instruction.def"
- };
-
- enum UnaryOps {
-#define FIRST_UNARY_INST(N) FirstUnaryOp = N,
-#define HANDLE_UNARY_INST(N, OPC, CLASS) OPC = N,
-#define LAST_UNARY_INST(N) NumUnaryOps = N+1,
+#define LAST_TERM_INST(N) TermOpsEnd = N+1,
#include "llvm/Instruction.def"
};
enum BinaryOps {
-#define FIRST_BINARY_INST(N) FirstBinaryOp = N,
+#define FIRST_BINARY_INST(N) BinaryOpsBegin = N,
#define HANDLE_BINARY_INST(N, OPC, CLASS) OPC = N,
-#define LAST_BINARY_INST(N) NumBinaryOps = N+1,
+#define LAST_BINARY_INST(N) BinaryOpsEnd = N+1,
#include "llvm/Instruction.def"
};
enum MemoryOps {
-#define FIRST_MEMORY_INST(N) FirstMemoryOp = N,
+#define FIRST_MEMORY_INST(N) MemoryOpsBegin = N,
#define HANDLE_MEMORY_INST(N, OPC, CLASS) OPC = N,
-#define LAST_MEMORY_INST(N) NumMemoryOps = N+1,
+#define LAST_MEMORY_INST(N) MemoryOpsEnd = N+1,
#include "llvm/Instruction.def"
};
enum OtherOps {
-#define FIRST_OTHER_INST(N) FirstOtherOp = N,
+#define FIRST_OTHER_INST(N) OtherOpsBegin = N,
#define HANDLE_OTHER_INST(N, OPC, CLASS) OPC = N,
-#define LAST_OTHER_INST(N) NumOtherOps = N+1,
+#define LAST_OTHER_INST(N) OtherOpsEnd = N+1,
#include "llvm/Instruction.def"
};
};
projects / oota-llvm.git / blobdiff