Cache: Remove dangling doWriteback declaration
[gem5.git] / src / mem / physical.hh
index 8b13d32c1381c8339f1fd5fe8a7d1c27b05d1575..e78b1d2da3342ee52b88827310f2a173bf4ab499 100644 (file)
@@ -1,6 +1,15 @@
 /*
- * Copyright (c) 2001-2005 The Regents of The University of Michigan
- * All rights reserved.
+ * Copyright (c) 2012 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
- * Authors: Ron Dreslinski
- */
-
-/* @file
+ * Authors: Andreas Hansson
  */
 
 #ifndef __PHYSICAL_MEMORY_HH__
 #define __PHYSICAL_MEMORY_HH__
 
-#include "base/range.hh"
-#include "mem/mem_object.hh"
+#include "base/range_map.hh"
+#include "mem/abstract_mem.hh"
 #include "mem/packet.hh"
-#include "mem/tport.hh"
-#include "sim/eventq.hh"
-#include <map>
-#include <string>
-
-//
-// Functional model for a contiguous block of physical memory. (i.e. RAM)
-//
-class PhysicalMemory : public MemObject
-{
-    class MemoryPort : public SimpleTimingPort
-    {
-        PhysicalMemory *memory;
-
-      public:
 
-        MemoryPort(const std::string &_name, PhysicalMemory *_memory);
-
-      protected:
-
-        virtual Tick recvAtomic(PacketPtr pkt);
+/**
+ * The physical memory encapsulates all memories in the system and
+ * provides basic functionality for accessing those memories without
+ * going through the memory system and interconnect.
+ */
+class PhysicalMemory
+{
 
-        virtual void recvFunctional(PacketPtr pkt);
+  private:
 
-        virtual void recvStatusChange(Status status);
+    // Global address map
+    range_map<Addr, AbstractMemory* > addrMap;
 
-        virtual void getDeviceAddressRanges(AddrRangeList &resp,
-                                            bool &snoop);
+    // a mutable cache for the last range that matched an address
+    mutable Range<Addr> rangeCache;
 
-        virtual int deviceBlockSize();
-    };
+    // All address-mapped memories
+    std::vector<AbstractMemory*> memories;
 
-    int numPorts;
+    // The total memory size
+    uint64_t size;
 
+    // Prevent copying
+    PhysicalMemory(const PhysicalMemory&);
 
-  private:
-    // prevent copying of a MainMemory object
-    PhysicalMemory(const PhysicalMemory &specmem);
-    const PhysicalMemory &operator=(const PhysicalMemory &specmem);
-
-  protected:
-
-    class LockedAddr {
-      public:
-        // on alpha, minimum LL/SC granularity is 16 bytes, so lower
-        // bits need to masked off.
-        static const Addr Addr_Mask = 0xf;
-
-        static Addr mask(Addr paddr) { return (paddr & ~Addr_Mask); }
-
-        Addr addr;     // locked address
-        int cpuNum;    // locking CPU
-        int threadNum; // locking thread ID within CPU
-
-        // check for matching execution context
-        bool matchesContext(Request *req)
-        {
-            return (cpuNum == req->getCpuNum() &&
-                    threadNum == req->getThreadNum());
-        }
-
-        LockedAddr(Request *req)
-            : addr(mask(req->getPaddr())),
-              cpuNum(req->getCpuNum()),
-              threadNum(req->getThreadNum())
-        {
-        }
-    };
-
-    std::list<LockedAddr> lockedAddrList;
-
-    // helper function for checkLockedAddrs(): we really want to
-    // inline a quick check for an empty locked addr list (hopefully
-    // the common case), and do the full list search (if necessary) in
-    // this out-of-line function
-    bool checkLockedAddrList(PacketPtr pkt);
-
-    // Record the address of a load-locked operation so that we can
-    // clear the execution context's lock flag if a matching store is
-    // performed
-    void trackLoadLocked(PacketPtr pkt);
-
-    // Compare a store address with any locked addresses so we can
-    // clear the lock flag appropriately.  Return value set to 'false'
-    // if store operation should be suppressed (because it was a
-    // conditional store and the address was no longer locked by the
-    // requesting execution context), 'true' otherwise.  Note that
-    // this method must be called on *all* stores since even
-    // non-conditional stores must clear any matching lock addresses.
-    bool writeOK(PacketPtr pkt) {
-        Request *req = pkt->req;
-        if (lockedAddrList.empty()) {
-            // no locked addrs: nothing to check, store_conditional fails
-            bool isLocked = pkt->isLocked();
-            if (isLocked) {
-                req->setExtraData(0);
-            }
-            return !isLocked; // only do write if not an sc
-        } else {
-            // iterate over list...
-            return checkLockedAddrList(pkt);
-        }
-    }
-
-    uint8_t *pmemAddr;
-    int pagePtr;
-    Tick lat;
-    std::vector<MemoryPort*> ports;
-    typedef std::vector<MemoryPort*>::iterator PortIterator;
+    // Prevent assignment
+    PhysicalMemory& operator=(const PhysicalMemory&);
 
   public:
-    Addr new_page();
-    uint64_t size() { return params()->addrRange.size(); }
-    uint64_t start() { return params()->addrRange.start; }
-
-    struct Params
-    {
-        std::string name;
-        Range<Addr> addrRange;
-        Tick latency;
-        bool zero;
-    };
 
-  protected:
-    Params *_params;
-
-  public:
-    const Params *params() const { return _params; }
-    PhysicalMemory(Params *p);
-    virtual ~PhysicalMemory();
+    /**
+     * Create a physical memory object, wrapping a number of memories.
+     */
+    PhysicalMemory(const std::vector<AbstractMemory*>& _memories);
+
+    /**
+     * Nothing to destruct.
+     */
+    ~PhysicalMemory() { }
+
+    /**
+     * Check if a physical address is within a range of a memory that
+     * is part of the global address map.
+     *
+     * @param addr A physical address
+     * @return Whether the address corresponds to a memory
+     */
+    bool isMemAddr(Addr addr) const;
+
+    /**
+     * Get the memory ranges for all memories that are to be reported
+     * to the configuration table.
+     *
+     * @return All configuration table memory ranges
+     */
+    AddrRangeList getConfAddrRanges() const;
+
+    /**
+     * Get the total physical memory size.
+     *
+     * @return The sum of all memory sizes
+     */
+    uint64_t totalSize() const { return size; }
+
+    /**
+     *
+     */
+    void access(PacketPtr pkt);
+    void functionalAccess(PacketPtr pkt);
+};
 
-  public:
-    int deviceBlockSize();
-    void getAddressRanges(AddrRangeList &resp, bool &snoop);
-    virtual Port *getPort(const std::string &if_name, int idx = -1);
-    void virtual init();
-    unsigned int drain(Event *de);
-
-  protected:
-    Tick doAtomicAccess(PacketPtr pkt);
-    void doFunctionalAccess(PacketPtr pkt);
-    virtual Tick calculateLatency(PacketPtr pkt);
-    void recvStatusChange(Port::Status status);
 
-  public:
-    virtual void serialize(std::ostream &os);
-    virtual void unserialize(Checkpoint *cp, const std::string &section);
 
-};
 
 #endif //__PHYSICAL_MEMORY_HH__