Rename llvm.frameescape and llvm.framerecover to localescape and localrecover
[oota-llvm.git] / include / llvm / CodeGen / PseudoSourceValue.h
index c6be645040a8693d34eff4b8fdbdf0f94dee6fef..a518b6233250eb1a20d7fd2f25b5dc8336d73298 100644 (file)
 #ifndef LLVM_CODEGEN_PSEUDOSOURCEVALUE_H
 #define LLVM_CODEGEN_PSEUDOSOURCEVALUE_H
 
-#include "llvm/Value.h"
+#include "llvm/IR/Value.h"
 
 namespace llvm {
   class MachineFrameInfo;
+  class MachineMemOperand;
   class raw_ostream;
 
+  raw_ostream &operator<<(raw_ostream &OS, const MachineMemOperand &MMO);
+
   /// PseudoSourceValue - Special value supplied for machine level alias
-  /// analysis. It indicates that the a memory access references the functions
+  /// analysis. It indicates that a memory access references the functions
   /// stack frame (e.g., a spill slot), below the stack frame (e.g., argument
   /// space), or constant pool.
-  class PseudoSourceValue : public Value {
+  class PseudoSourceValue {
   private:
+    friend class MachineMemOperand; // For printCustom().
+
     /// printCustom - Implement printing for PseudoSourceValue. This is called
     /// from Value::print or Value's operator<<.
     ///
     virtual void printCustom(raw_ostream &O) const;
 
   public:
-    PseudoSourceValue();
+    /// isFixed - Whether this is a FixedStackPseudoSourceValue.
+    bool isFixed;
+
+    explicit PseudoSourceValue(bool isFixed = false);
+
+    virtual ~PseudoSourceValue();
 
     /// isConstant - Test whether the memory pointed to by this
     /// PseudoSourceValue has a constant value.
     ///
     virtual bool isConstant(const MachineFrameInfo *) const;
 
-    /// classof - Methods for support type inquiry through isa, cast, and
-    /// dyn_cast:
-    ///
-    static inline bool classof(const PseudoSourceValue *) { return true; }
-    static inline bool classof(const Value *V) {
-      return V->getValueID() == PseudoSourceValueVal;
-    }
+    /// isAliased - Test whether the memory pointed to by this
+    /// PseudoSourceValue may also be pointed to by an LLVM IR Value.
+    virtual bool isAliased(const MachineFrameInfo *) const;
+
+    /// mayAlias - Return true if the memory pointed to by this
+    /// PseudoSourceValue can ever alias an LLVM IR Value.
+    virtual bool mayAlias(const MachineFrameInfo *) const;
 
     /// A pseudo source value referencing a fixed stack frame entry,
     /// e.g., a spill slot.
@@ -68,6 +78,33 @@ namespace llvm {
     /// constant, this doesn't need to identify a specific jump table.
     static const PseudoSourceValue *getJumpTable();
   };
+
+  /// FixedStackPseudoSourceValue - A specialized PseudoSourceValue
+  /// for holding FixedStack values, which must include a frame
+  /// index.
+  class FixedStackPseudoSourceValue : public PseudoSourceValue {
+    const int FI;
+  public:
+    explicit FixedStackPseudoSourceValue(int fi) :
+        PseudoSourceValue(true), FI(fi) {}
+
+    /// classof - Methods for support type inquiry through isa, cast, and
+    /// dyn_cast:
+    ///
+    static inline bool classof(const PseudoSourceValue *V) {
+      return V->isFixed == true;
+    }
+
+    bool isConstant(const MachineFrameInfo *MFI) const override;
+
+    bool isAliased(const MachineFrameInfo *MFI) const override;
+
+    bool mayAlias(const MachineFrameInfo *) const override;
+
+    void printCustom(raw_ostream &OS) const override;
+
+    int getFrameIndex() const { return FI; }
+  };
 } // End llvm namespace
 
 #endif