mem: Fix guest corruption when caches handle uncacheable accesses

[gem5.git] / src / mem / port.hh

diff --git a/src/mem/port.hh b/src/mem/port.hh
index eac92791e92963e4e8e6fb4f31b2572f77c64674..a4e823796e5d5fd6b5aa0d532216a2757aa4f040 100644 (file)
--- a/src/mem/port.hh
+++ b/src/mem/port.hh
@@ -52,7 +52,7 @@
 
 #include <list>
 
-#include "base/range.hh"
+#include "base/addr_range.hh"
 #include "mem/packet.hh"
 
 /**
@@ -62,9 +62,9 @@
  * defined.
  */
 
-typedef std::list<Range<Addr> > AddrRangeList;
-typedef std::list<Range<Addr> >::iterator AddrRangeIter;
-typedef std::list<Range<Addr> >::const_iterator AddrRangeConstIter;
+typedef std::list<AddrRange> AddrRangeList;
+typedef std::list<AddrRange>::iterator AddrRangeIter;
+typedef std::list<AddrRange>::const_iterator AddrRangeConstIter;
 
 class MemObject;
 
@@ -116,16 +116,68 @@ class Port
 
 };
 
+/** Forward declaration */
+class BaseSlavePort;
+
+/**
+ * A BaseMasterPort is a protocol-agnostic master port, responsible
+ * only for the structural connection to a slave port. The final
+ * master port that inherits from the base class must override the
+ * bind member function for the specific slave port class.
+ */
+class BaseMasterPort : public Port
+{
+
+  protected:
+
+    BaseSlavePort* _baseSlavePort;
+
+    BaseMasterPort(const std::string& name, MemObject* owner,
+                   PortID id = InvalidPortID);
+    virtual ~BaseMasterPort();
+
+  public:
+
+    virtual void bind(BaseSlavePort& slave_port) = 0;
+    virtual void unbind() = 0;
+    BaseSlavePort& getSlavePort() const;
+    bool isConnected() const;
+
+};
+
+/**
+ * A BaseSlavePort is a protocol-agnostic slave port, responsible
+ * only for the structural connection to a master port.
+ */
+class BaseSlavePort : public Port
+{
+
+  protected:
+
+    BaseMasterPort* _baseMasterPort;
+
+    BaseSlavePort(const std::string& name, MemObject* owner,
+                  PortID id = InvalidPortID);
+    virtual ~BaseSlavePort();
+
+  public:
+
+    BaseMasterPort& getMasterPort() const;
+    bool isConnected() const;
+
+};
+
 /** Forward declaration */
 class SlavePort;
 
 /**
- * A MasterPort is a specialisation of a port. In addition to the
- * basic functionality of sending packets to its slave peer, it also
- * has functions specific to a master, e.g. to receive range changes
- * or determine if the port is snooping or not.
+ * A MasterPort is a specialisation of a BaseMasterPort, which
+ * implements the default protocol for the three different level of
+ * transport functions. In addition to the basic functionality of
+ * sending packets, it also has functions to receive range changes or
+ * determine if the port is snooping or not.
  */
-class MasterPort : public Port
+class MasterPort : public BaseMasterPort
 {
 
     friend class SlavePort;
@@ -140,10 +192,16 @@ class MasterPort : public Port
                PortID id = InvalidPortID);
     virtual ~MasterPort();
 
-    void unBind();
-    void bind(SlavePort& slave_port);
-    SlavePort& getSlavePort() const;
-    bool isConnected() const;
+    /**
+     * Bind this master port to a slave port. This also does the
+     * mirror action and binds the slave port to the master port.
+     */
+    void bind(BaseSlavePort& slave_port);
+
+    /**
+     * Unbind this master port and the associated slave port.
+     */
+    void unbind();
 
     /**
      * Send an atomic request packet, where the data is moved and the
@@ -269,9 +327,9 @@ class MasterPort : public Port
 
     /**
      * Called to receive an address range change from the peer slave
-     * port. the default implementation ignored the change and does
+     * port. The default implementation ignores the change and does
      * nothing. Override this function in a derived class if the owner
-     * needs to be aware of he laesddress ranges, e.g. in an
+     * needs to be aware of the address ranges, e.g. in an
      * interconnect component like a bus.
      */
     virtual void recvRangeChange() { }
@@ -283,7 +341,7 @@ class MasterPort : public Port
  * has functions specific to a slave, e.g. to send range changes
  * and get the address ranges that the port responds to.
  */
-class SlavePort : public Port
+class SlavePort : public BaseSlavePort
 {
 
     friend class MasterPort;
@@ -298,11 +356,6 @@ class SlavePort : public Port
               PortID id = InvalidPortID);
     virtual ~SlavePort();
 
-    void unBind();
-    void bind(MasterPort& master_port);
-    MasterPort& getMasterPort() const;
-    bool isConnected() const;
-
     /**
      * Send an atomic snoop request packet, where the data is moved
      * and the state is updated in zero time, without interleaving
@@ -386,6 +439,18 @@ class SlavePort : public Port
 
   protected:
 
+    /**
+     * Called by the master port to unbind. Should never be called
+     * directly.
+     */
+    void unbind();
+
+    /**
+     * Called by the master port to bind. Should never be called
+     * directly.
+     */
+    void bind(MasterPort& master_port);
+
     /**
      * Receive an atomic request packet from the master port.
      */