Use InstrSlots::NUM rather than pre-dividing by four. Also, mark this const.
[oota-llvm.git] / include / llvm / Instruction.h
index ed0357f823bf27de4eda5c797b7bef621b3ef9d2..89e3e2349987b70d5fd25dff3ce4e347e061a228 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     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 is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 namespace llvm {
 
 struct AssemblyAnnotationWriter;
-class BinaryOperator;
 
-template<typename SC> struct ilist_traits;
-template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
-         typename SubClass> class SymbolTableListTraits;
+template<typename ValueSubClass, typename ItemParentClass>
+  class SymbolTableListTraits;
 
 class Instruction : public User {
   void operator=(const Instruction &);     // Do not implement
@@ -36,8 +34,7 @@ class Instruction : public User {
   void setNext(Instruction *N) { Next = N; }
   void setPrev(Instruction *N) { Prev = N; }
 
-  friend class SymbolTableListTraits<Instruction, BasicBlock, Function,
-                                     ilist_traits<Instruction> >;
+  friend class SymbolTableListTraits<Instruction, BasicBlock>;
   void setParent(BasicBlock *P);
 protected:
   Instruction(const Type *Ty, unsigned iType, Use *Ops, unsigned NumOps,
@@ -52,6 +49,10 @@ public:
   ///
   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
@@ -74,6 +75,13 @@ public:
   /// @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<Instruction>(*use_begin());}
@@ -84,13 +92,6 @@ public:
   inline const BasicBlock *getParent() const { return Parent; }
   inline       BasicBlock *getParent()       { return Parent; }
 
-  // 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; }
-
   /// removeFromParent - This method unlinks 'this' from the containing basic
   /// block, but does not delete it.
   ///
@@ -101,6 +102,10 @@ public:
   ///
   void eraseFromParent();
 
+  /// 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.
@@ -111,21 +116,22 @@ public:
   /// one of the enums that is coming soon (down below)...
   ///
   unsigned getOpcode() const { return getValueID() - InstructionVal; }
-  const char *getOpcodeName() const {
-    return getOpcodeName(getOpcode());
-  }
+  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;
   }
 
-  inline bool isTerminator() const {   // Instance of TerminatorInst?
-    return isTerminator(getOpcode());
-  }
-
-  inline bool isBinaryOp() const {
-    return getOpcode() >= BinaryOpsBegin && getOpcode() < BinaryOpsEnd;
+  static inline bool isBinaryOp(unsigned Opcode) {
+    return Opcode >= BinaryOpsBegin && Opcode < BinaryOpsEnd;
   }
 
   /// @brief Determine if the Opcode is one of the shift instructions.
@@ -133,19 +139,15 @@ public:
     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() {
+  inline bool isLogicalShift() const {
     return getOpcode() == Shl || getOpcode() == LShr;
   }
 
   /// isLogicalShift - Return true if this is a logical shift left or a logical
   /// shift right.
-  inline bool isArithmeticShift() {
+  inline bool isArithmeticShift() const {
     return getOpcode() == AShr;
   }
 
@@ -154,11 +156,6 @@ public:
     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
@@ -233,6 +230,14 @@ public:
 #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