mem-cache: Templatize DictionaryCompressor
[gem5.git] / src / mem / cache / mshr_queue.hh
index eebfed827ed906f8080a1b1ea08f21a503ee96cd..1e4eaeb514a2d7bd099adf1e6a67c10aea8a007c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2013, 2015 ARM Limited
+ * Copyright (c) 2012-2013, 2015-2016, 2018 ARM Limited
  * All rights reserved.
  *
  * The license below extends only to copyright in the software and shall
 #ifndef __MEM_CACHE_MSHR_QUEUE_HH__
 #define __MEM_CACHE_MSHR_QUEUE_HH__
 
-#include <vector>
+#include <string>
 
+#include "base/types.hh"
 #include "mem/cache/mshr.hh"
+#include "mem/cache/queue.hh"
 #include "mem/packet.hh"
-#include "sim/drain.hh"
 
 /**
  * A Class for maintaining a list of pending and allocated memory requests.
  */
-class MSHRQueue : public Drainable
+class MSHRQueue : public Queue<MSHR>
 {
   private:
-    /** Local label (for functional print requests) */
-    const std::string label;
-
-    // Parameters
-    /**
-     * The total number of entries in this queue. This number is set as the
-     * number of entries requested plus (numReserve - 1). This allows for
-     * the same number of effective entries while still maintaining the reserve.
-     */
-    const int numEntries;
-
-    /**
-     * The number of entries to hold in reserve. This is needed because copy
-     * operations can allocate upto 4 entries at one time.
-     */
-    const int numReserve;
 
     /**
      * The number of entries to reserve for future demand accesses.
@@ -83,26 +68,7 @@ class MSHRQueue : public Drainable
      */
     const int demandReserve;
 
-    /**  MSHR storage. */
-    std::vector<MSHR> registers;
-    /** Holds pointers to all allocated entries. */
-    MSHR::List allocatedList;
-    /** Holds pointers to entries that haven't been sent to the bus. */
-    MSHR::List readyList;
-    /** Holds non allocated entries. */
-    MSHR::List freeList;
-
-    MSHR::Iterator addToReadyList(MSHR *mshr);
-
-
   public:
-    /** The number of allocated entries. */
-    int allocated;
-    /** The number of entries that have been forwarded to the bus. */
-    int inServiceEntries;
-    /** The index of this queue within the cache (MSHR queue vs. write
-     * buffer). */
-    const int index;
 
     /**
      * Create a queue with a given number of entries.
@@ -113,35 +79,7 @@ class MSHRQueue : public Drainable
      * demand accesses.
      */
     MSHRQueue(const std::string &_label, int num_entries, int reserve,
-              int demand_reserve, int index);
-
-    /**
-     * Find the first MSHR that matches the provided address.
-     * @param blk_addr The block address to find.
-     * @param is_secure True if the target memory space is secure.
-     * @return Pointer to the matching MSHR, null if not found.
-     */
-    MSHR *findMatch(Addr blk_addr, bool is_secure) const;
-
-    /**
-     * Find and return all the matching entries in the provided vector.
-     * @param blk_addr The block  address to find.
-     * @param is_secure True if the target memory space is secure.
-     * @param matches The vector to return pointers to the matching entries.
-     * @return True if any matches are found, false otherwise.
-     */
-    bool findMatches(Addr blk_addr, bool is_secure,
-                     std::vector<MSHR*>& matches) const;
-
-    /**
-     * Find any pending requests that overlap the given request.
-     * @param blk_addr Block address.
-     * @param is_secure True if the target memory space is secure.
-     * @return A pointer to the earliest matching MSHR.
-     */
-    MSHR *findPending(Addr blk_addr, bool is_secure) const;
-
-    bool checkFunctional(PacketPtr pkt, Addr blk_addr);
+              int demand_reserve);
 
     /**
      * Allocates a new MSHR for the request and size. This places the request
@@ -152,28 +90,14 @@ class MSHRQueue : public Drainable
      * @param pkt The original miss.
      * @param when_ready When should the MSHR be ready to act upon.
      * @param order The logical order of this MSHR
+     * @param alloc_on_fill Should the cache allocate a block on fill
      *
      * @return The a pointer to the MSHR allocated.
      *
      * @pre There are free entries.
      */
     MSHR *allocate(Addr blk_addr, unsigned blk_size, PacketPtr pkt,
-                   Tick when_ready, Counter order);
-
-    /**
-     * Removes the given MSHR from the queue. This places the MSHR on the
-     * free list.
-     * @param mshr
-     */
-    void deallocate(MSHR *mshr);
-
-    /**
-     * Remove a MSHR from the queue. Returns an iterator into the
-     * allocatedList for faster squash implementation.
-     * @param mshr The MSHR to remove.
-     * @return An iterator to the next entry in the allocatedList.
-     */
-    MSHR::Iterator deallocateOne(MSHR *mshr);
+                   Tick when_ready, Counter order, bool alloc_on_fill);
 
     /**
      * Moves the MSHR to the front of the pending list if it is not
@@ -182,15 +106,24 @@ class MSHRQueue : public Drainable
      */
     void moveToFront(MSHR *mshr);
 
+    /**
+     * Adds a delay to the provided MSHR and moves MSHRs that will be
+     * ready earlier than this entry to the top of the list
+     *
+     * @param mshr that needs to be delayed
+     * @param delay_ticks ticks of the desired delay
+     */
+    void delay(MSHR *mshr, Tick delay_ticks);
+
     /**
      * Mark the given MSHR as in service. This removes the MSHR from the
      * readyList or deallocates the MSHR if it does not expect a response.
      *
      * @param mshr The MSHR to mark in service.
-     * @param pending_dirty_resp Whether we expect a dirty response
-     *                           from another cache
+     * @param pending_modified_resp Whether we expect a modified response
+     *                              from another cache
      */
-    void markInService(MSHR *mshr, bool pending_dirty_resp);
+    void markInService(MSHR *mshr, bool pending_modified_resp);
 
     /**
      * Mark an in service entry as pending, used to resend a request.
@@ -198,13 +131,6 @@ class MSHRQueue : public Drainable
      */
     void markPending(MSHR *mshr);
 
-    /**
-     * Squash outstanding requests with the given thread number. If a request
-     * is in service, just squashes the targets.
-     * @param threadNum The thread to squash.
-     */
-    void squash(int threadNum);
-
     /**
      * Deallocate top target, possibly freeing the MSHR
      * @return if MSHR queue is no longer full
@@ -220,42 +146,16 @@ class MSHRQueue : public Drainable
         return !readyList.empty();
     }
 
-    /**
-     * Returns true if there are no free entries.
-     * @return True if this queue is full.
-     */
-    bool isFull() const
-    {
-        return (allocated > numEntries - numReserve);
-    }
-
     /**
      * Returns true if sufficient mshrs for prefetch.
      * @return True if sufficient mshrs for prefetch.
      */
     bool canPrefetch() const
     {
-        return (allocated < numEntries - (numReserve + demandReserve));
+        // @todo we may want to revisit the +1, currently added to
+        // keep regressions unchanged
+        return (allocated < numEntries - (numReserve + 1 + demandReserve));
     }
-
-    /**
-     * Returns the MSHR at the head of the readyList.
-     * @return The next request to service.
-     */
-    MSHR *getNextMSHR() const
-    {
-        if (readyList.empty() || readyList.front()->readyTime > curTick()) {
-            return NULL;
-        }
-        return readyList.front();
-    }
-
-    Tick nextMSHRReadyTime() const
-    {
-        return readyList.empty() ? MaxTick : readyList.front()->readyTime;
-    }
-
-    DrainState drain() override;
 };
 
 #endif //__MEM_CACHE_MSHR_QUEUE_HH__