mem: Add explicit Cache subclass and make BaseCache abstract
authorAndreas Hansson <andreas.hansson@arm.com>
Fri, 21 Aug 2015 11:03:23 +0000 (07:03 -0400)
committerAndreas Hansson <andreas.hansson@arm.com>
Fri, 21 Aug 2015 11:03:23 +0000 (07:03 -0400)
Open up for other subclasses to BaseCache and transition to using the
explicit Cache subclass.

--HG--
rename : src/mem/cache/BaseCache.py => src/mem/cache/Cache.py

13 files changed:
configs/common/Caches.py
configs/common/O3_ARM_v7a.py
configs/example/memcheck.py
configs/example/memtest.py
configs/splash2/cluster.py
configs/splash2/run.py
src/mem/cache/BaseCache.py [deleted file]
src/mem/cache/Cache.py [new file with mode: 0644]
src/mem/cache/SConscript
src/mem/cache/base.cc
src/mem/cache/base.hh
src/mem/cache/cache.cc
src/mem/cache/cache.hh

index cfb873b5edb564278cf40ec5591019df881c5463..0a3c562971fc10f47d89ca0d40b60a414f14cbc5 100644 (file)
@@ -46,7 +46,7 @@ from m5.objects import *
 # starting point, and specific parameters can be overridden in the
 # specific instantiations.
 
-class L1Cache(BaseCache):
+class L1Cache(Cache):
     assoc = 2
     hit_latency = 2
     response_latency = 2
@@ -59,7 +59,7 @@ class L1_ICache(L1Cache):
 class L1_DCache(L1Cache):
     pass
 
-class L2Cache(BaseCache):
+class L2Cache(Cache):
     assoc = 8
     hit_latency = 20
     response_latency = 20
@@ -67,7 +67,7 @@ class L2Cache(BaseCache):
     tgts_per_mshr = 12
     write_buffers = 8
 
-class IOCache(BaseCache):
+class IOCache(Cache):
     assoc = 8
     hit_latency = 50
     response_latency = 50
@@ -76,7 +76,7 @@ class IOCache(BaseCache):
     tgts_per_mshr = 12
     forward_snoops = False
 
-class PageTableWalkerCache(BaseCache):
+class PageTableWalkerCache(Cache):
     assoc = 2
     hit_latency = 2
     response_latency = 2
index dbfdf6c4112d0fcaf28ff79ce96c6b3ca72a00a2..9f250f57d2d391110f3542d8d85e3d5da9930d31 100644 (file)
@@ -142,7 +142,7 @@ class O3_ARM_v7a_3(DerivO3CPU):
     branchPred = O3_ARM_v7a_BP()
 
 # Instruction Cache
-class O3_ARM_v7a_ICache(BaseCache):
+class O3_ARM_v7a_ICache(Cache):
     hit_latency = 1
     response_latency = 1
     mshrs = 2
@@ -153,7 +153,7 @@ class O3_ARM_v7a_ICache(BaseCache):
     is_read_only = True
 
 # Data Cache
-class O3_ARM_v7a_DCache(BaseCache):
+class O3_ARM_v7a_DCache(Cache):
     hit_latency = 2
     response_latency = 2
     mshrs = 6
@@ -164,7 +164,7 @@ class O3_ARM_v7a_DCache(BaseCache):
 
 # TLB Cache
 # Use a cache as a L2 TLB
-class O3_ARM_v7aWalkCache(BaseCache):
+class O3_ARM_v7aWalkCache(Cache):
     hit_latency = 4
     response_latency = 4
     mshrs = 6
@@ -176,7 +176,7 @@ class O3_ARM_v7aWalkCache(BaseCache):
     is_read_only = True
 
 # L2 Cache
-class O3_ARM_v7aL2(BaseCache):
+class O3_ARM_v7aL2(Cache):
     hit_latency = 12
     response_latency = 12
     mshrs = 16
index ca2659ed0960218ccd2f5fc123765dd28011a58f..18c75376f96875a6be54878fed03f71372c907d7 100644 (file)
@@ -152,9 +152,9 @@ for t, m in zip(testerspec, multiplier):
      numtesters += t * m
 
 # Define a prototype L1 cache that we scale for all successive levels
-proto_l1 = BaseCache(size = '32kB', assoc = 4,
-                     hit_latency = 1, response_latency = 1,
-                     tgts_per_mshr = 8)
+proto_l1 = Cache(size = '32kB', assoc = 4,
+                 hit_latency = 1, response_latency = 1,
+                 tgts_per_mshr = 8)
 
 if options.blocking:
      proto_l1.mshrs = 1
index a51bd27964cbc13827ece921a86c7033d9bf138a..08f13453368ec4c85793442983908cddc8b0dc8a 100644 (file)
@@ -175,9 +175,9 @@ else:
           sys.exit(1)
 
 # Define a prototype L1 cache that we scale for all successive levels
-proto_l1 = BaseCache(size = '32kB', assoc = 4,
-                     hit_latency = 1, response_latency = 1,
-                     tgts_per_mshr = 8)
+proto_l1 = Cache(size = '32kB', assoc = 4,
+                 hit_latency = 1, response_latency = 1,
+                 tgts_per_mshr = 8)
 
 if options.blocking:
      proto_l1.mshrs = 1
index 9fafcb70cc1239c288befc83c2736bea6c71c5bb..5991e7428f2b32718faabb9bbe75abb2f4b045d6 100644 (file)
@@ -137,7 +137,7 @@ class Water_spatial(LiveProcess):
 # Base L1 Cache Definition
 # ====================
 
-class L1(BaseCache):
+class L1(Cache):
     latency = options.l1latency
     mshrs = 12
     tgts_per_mshr = 8
@@ -146,7 +146,7 @@ class L1(BaseCache):
 # Base L2 Cache Definition
 # ----------------------
 
-class L2(BaseCache):
+class L2(Cache):
     latency = options.l2latency
     mshrs = 92
     tgts_per_mshr = 16
index 14e5f47d4dcdceeb3876c1a9f4d6600137d803a7..bf7d1331e6893d9da5a99097a7b2416296148dfa 100644 (file)
@@ -158,7 +158,7 @@ class Water_spatial(LiveProcess):
 # Base L1 Cache Definition
 # ====================
 
-class L1(BaseCache):
+class L1(Cache):
     latency = options.l1latency
     mshrs = 12
     tgts_per_mshr = 8
@@ -167,7 +167,7 @@ class L1(BaseCache):
 # Base L2 Cache Definition
 # ----------------------
 
-class L2(BaseCache):
+class L2(Cache):
     latency = options.l2latency
     mshrs = 92
     tgts_per_mshr = 16
diff --git a/src/mem/cache/BaseCache.py b/src/mem/cache/BaseCache.py
deleted file mode 100644 (file)
index d908430..0000000
+++ /dev/null
@@ -1,83 +0,0 @@
-# Copyright (c) 2012-2013, 2015 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.
-#
-# Copyright (c) 2005-2007 The Regents of The University of Michigan
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met: redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer;
-# redistributions in binary form must reproduce the above copyright
-# notice, this list of conditions and the following disclaimer in the
-# documentation and/or other materials provided with the distribution;
-# neither the name of the copyright holders nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (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: Nathan Binkert
-
-from m5.params import *
-from m5.proxy import *
-from MemObject import MemObject
-from Prefetcher import BasePrefetcher
-from Tags import *
-
-class BaseCache(MemObject):
-    type = 'BaseCache'
-    cxx_header = "mem/cache/base.hh"
-
-    size = Param.MemorySize("Capacity")
-    assoc = Param.Unsigned("Associativity")
-
-    hit_latency = Param.Cycles("Hit latency")
-    response_latency = Param.Cycles("Latency for the return path on a miss");
-
-    max_miss_count = Param.Counter(0,
-        "Number of misses to handle before calling exit")
-
-    mshrs = Param.Unsigned("Number of MSHRs (max outstanding requests)")
-    demand_mshr_reserve = Param.Unsigned(1, "MSHRs reserved for demand access")
-    tgts_per_mshr = Param.Unsigned("Max number of accesses per MSHR")
-    write_buffers = Param.Unsigned(8, "Number of write buffers")
-
-    forward_snoops = Param.Bool(True,
-        "Forward snoops from mem side to cpu side")
-    is_read_only = Param.Bool(False, "Is this cache read only (e.g. inst)")
-
-    prefetcher = Param.BasePrefetcher(NULL,"Prefetcher attached to cache")
-    prefetch_on_access = Param.Bool(False,
-         "Notify the hardware prefetcher on every access (not just misses)")
-
-    tags = Param.BaseTags(LRU(), "Tag store (replacement policy)")
-    sequential_access = Param.Bool(False,
-        "Whether to access tags and data sequentially")
-
-    cpu_side = SlavePort("Upstream port closer to the CPU and/or device")
-    mem_side = MasterPort("Downstream port closer to memory")
-
-    addr_ranges = VectorParam.AddrRange([AllMemory],
-         "Address range for the CPU-side port (to allow striping)")
-
-    system = Param.System(Parent.any, "System we belong to")
diff --git a/src/mem/cache/Cache.py b/src/mem/cache/Cache.py
new file mode 100644 (file)
index 0000000..8ad1177
--- /dev/null
@@ -0,0 +1,89 @@
+# Copyright (c) 2012-2013, 2015 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.
+#
+# Copyright (c) 2005-2007 The Regents of The University of Michigan
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (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: Nathan Binkert
+#          Andreas Hansson
+
+from m5.params import *
+from m5.proxy import *
+from MemObject import MemObject
+from Prefetcher import BasePrefetcher
+from Tags import *
+
+class BaseCache(MemObject):
+    type = 'BaseCache'
+    abstract = True
+    cxx_header = "mem/cache/base.hh"
+
+    size = Param.MemorySize("Capacity")
+    assoc = Param.Unsigned("Associativity")
+
+    hit_latency = Param.Cycles("Hit latency")
+    response_latency = Param.Cycles("Latency for the return path on a miss");
+
+    max_miss_count = Param.Counter(0,
+        "Number of misses to handle before calling exit")
+
+    mshrs = Param.Unsigned("Number of MSHRs (max outstanding requests)")
+    demand_mshr_reserve = Param.Unsigned(1, "MSHRs reserved for demand access")
+    tgts_per_mshr = Param.Unsigned("Max number of accesses per MSHR")
+    write_buffers = Param.Unsigned(8, "Number of write buffers")
+
+    forward_snoops = Param.Bool(True,
+        "Forward snoops from mem side to cpu side")
+    is_read_only = Param.Bool(False, "Is this cache read only (e.g. inst)")
+
+    prefetcher = Param.BasePrefetcher(NULL,"Prefetcher attached to cache")
+    prefetch_on_access = Param.Bool(False,
+         "Notify the hardware prefetcher on every access (not just misses)")
+
+    tags = Param.BaseTags(LRU(), "Tag store (replacement policy)")
+    sequential_access = Param.Bool(False,
+        "Whether to access tags and data sequentially")
+
+    cpu_side = SlavePort("Upstream port closer to the CPU and/or device")
+    mem_side = MasterPort("Downstream port closer to memory")
+
+    addr_ranges = VectorParam.AddrRange([AllMemory],
+         "Address range for the CPU-side port (to allow striping)")
+
+    system = Param.System(Parent.any, "System we belong to")
+
+class Cache(BaseCache):
+    type = 'Cache'
+    cxx_header = 'mem/cache/cache.hh'
index a4fbe04c0bc59ddc44a910152024f1325dd9b3cd..1c356ef6ad18ab7f1a7a5cabc9ab1611edc3bb7b 100644 (file)
@@ -30,7 +30,7 @@
 
 Import('*')
 
-SimObject('BaseCache.py')
+SimObject('Cache.py')
 
 Source('base.cc')
 Source('cache.cc')
index c270d5b65a9fb424979e9b0f51116b3ffd3ffc24..41b6f38aab936478ee9e452aecc7030f79ea920c 100644 (file)
@@ -65,13 +65,13 @@ BaseCache::CacheSlavePort::CacheSlavePort(const std::string &_name,
 {
 }
 
-BaseCache::BaseCache(const Params *p)
+BaseCache::BaseCache(const BaseCacheParams *p, unsigned blk_size)
     : MemObject(p),
       cpuSidePort(nullptr), memSidePort(nullptr),
       mshrQueue("MSHRs", p->mshrs, 4, p->demand_mshr_reserve, MSHRQueue_MSHRs),
       writeBuffer("write buffer", p->write_buffers, p->mshrs+1000, 0,
                   MSHRQueue_WriteBuffer),
-      blkSize(p->system->cacheLineSize()),
+      blkSize(blk_size),
       lookupLatency(p->hit_latency),
       forwardLatency(p->hit_latency),
       fillLatency(p->response_latency),
@@ -774,11 +774,3 @@ BaseCache::regStats()
         ;
 
 }
-
-BaseCache *
-BaseCacheParams::create()
-{
-    assert(tags);
-
-    return new Cache(this);
-}
index 3e6f5cab2e4f739653500fc93726f5e1503d759d..3baec36d90d7c99cb357b117115da75c29f2c17c 100644 (file)
@@ -473,8 +473,7 @@ class BaseCache : public MemObject
     virtual void regStats();
 
   public:
-    typedef BaseCacheParams Params;
-    BaseCache(const Params *p);
+    BaseCache(const BaseCacheParams *p, unsigned blk_size);
     ~BaseCache() {}
 
     virtual void init();
index 2426a0636e7f3fb5b47bb9eb7ad2e00d070fbdba..91178547953f1bf1c84a6cc37fae285b5a52c501 100644 (file)
@@ -63,8 +63,8 @@
 #include "mem/cache/prefetch/base.hh"
 #include "sim/sim_exit.hh"
 
-Cache::Cache(const Params *p)
-    : BaseCache(p),
+Cache::Cache(const CacheParams *p)
+    : BaseCache(p, p->system->cacheLineSize()),
       tags(p->tags),
       prefetcher(p->prefetcher),
       doFastWrites(true),
@@ -2382,6 +2382,13 @@ CpuSidePort::CpuSidePort(const std::string &_name, Cache *_cache,
 {
 }
 
+Cache*
+CacheParams::create()
+{
+    assert(tags);
+
+    return new Cache(this);
+}
 ///////////////
 //
 // MemSidePort
index 06d78a272e0eeff2876db1bce038dbe0b4cfae78..447a552294a00b6f5f5785e764952aa4508d3449 100644 (file)
@@ -57,6 +57,7 @@
 #include "mem/cache/blk.hh"
 #include "mem/cache/mshr.hh"
 #include "mem/cache/tags/base.hh"
+#include "params/Cache.hh"
 #include "sim/eventq.hh"
 
 //Forward decleration
@@ -419,7 +420,7 @@ class Cache : public BaseCache
 
   public:
     /** Instantiates a basic cache object. */
-    Cache(const Params *p);
+    Cache(const CacheParams *p);
 
     /** Non-default destructor is needed to deallocate memory. */
     virtual ~Cache();