-//===-- 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.
//
//===----------------------------------------------------------------------===//
#define LLVM_INSTRUCTION_H
#include "llvm/User.h"
+
+namespace llvm {
+
+struct AssemblyAnnotationWriter;
+class BinaryOperator;
+
template<typename SC> struct ilist_traits;
template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
typename SubClass> class SymbolTableListTraits;
friend class SymbolTableListTraits<Instruction, BasicBlock, Function,
ilist_traits<Instruction> >;
- inline void setParent(BasicBlock *P) { Parent = P; }
+ void setParent(BasicBlock *P);
+ void init();
+
+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:
- unsigned iType; // InstructionType
+ Instruction(const Type *Ty, unsigned iType, const std::string &Name = "",
+ Instruction *InsertBefore = 0);
+ Instruction(const Type *Ty, unsigned iType, const std::string &Name,
+ BasicBlock *InsertAtEnd);
public:
- Instruction(const Type *Ty, unsigned iType, const std::string &Name = "");
- virtual ~Instruction() {
- assert(Parent == 0 && "Instruction still embedded in basic block!");
+
+ ~Instruction() {
+ assert(Parent == 0 && "Instruction still linked in the program!");
}
// Specialize setName to handle symbol table majik...
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
- //
+ /// 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;
+
// Accessor methods...
//
Instruction *getPrev() { return Prev; }
const Instruction *getPrev() const { return Prev; }
- virtual bool hasSideEffects() const { return false; } // Memory & Call insts
+ /// 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();
// ---------------------------------------------------------------------------
- // Subclass classification... getOpcode() returns a member of
- // one of the enums that is coming soon (down below)...
- //
- 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 getValueType() - InstructionVal; }
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;
+ static inline bool isTerminator(unsigned OpCode) {
+ return OpCode >= TermOpsBegin && OpCode < TermOpsEnd;
}
- 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;
}
- virtual void print(std::ostream &OS) const;
+ /// 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);
+
+ /// isRelational - Return true if the instruction is a Set* instruction:
+ ///
+ bool isRelational() const { return isRelational(getOpcode()); }
+ static bool isRelational(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, AssemblyAnnotationWriter *AAW) 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;
+ 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"
};
};
+} // End llvm namespace
+
#endif