mem: Add memory footprint probe

Signed-off-by: Jason Lowe-Power <jason@lowepower.com>

4 files changed, 280 insertions, 0 deletions

diff --git a/src/mem/probes/MemFootprintProbe.py b/src/mem/probes/MemFootprintProbe.py
new file mode 100644
index 000000000..7a6551207
--- /dev/null
+++ b/src/mem/probes/MemFootprintProbe.py
@@ -0,0 +1,48 @@
+# Copyright (c) 2016 Google Inc.
+# 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
+# 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: Rahul Thakur
+
+from m5.params import *
+from m5.proxy import *
+from BaseMemProbe import BaseMemProbe
+
+class MemFootprintProbe(BaseMemProbe):
+    type = "MemFootprintProbe"
+    cxx_header = "mem/probes/mem_footprint.hh"
+    system = Param.System(Parent.any,
+                          "System pointer to get cache line and mem size")
+    page_size = Param.Unsigned(4096, "Page size for page-level footprint")
diff --git a/src/mem/probes/SConscript b/src/mem/probes/SConscript
index 78423c5d6..3922f711c 100644
--- a/src/mem/probes/SConscript
+++ b/src/mem/probes/SConscript
@@ -45,6 +45,9 @@ Source('base.cc')
 SimObject('StackDistProbe.py')
 Source('stack_dist.cc')
 
+SimObject('MemFootprintProbe.py')
+Source('mem_footprint.cc')
+
 # Packet tracing requires protobuf support
 if env['HAVE_PROTOBUF']:
     SimObject('MemTraceProbe.py')
diff --git a/src/mem/probes/mem_footprint.cc b/src/mem/probes/mem_footprint.cc
new file mode 100644
index 000000000..0c14389ed
--- /dev/null
+++ b/src/mem/probes/mem_footprint.cc
@@ -0,0 +1,132 @@
+/*
+ * Copyright (c) 2016 Google Inc.
+ * 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
+ * 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: Rahul Thakur
+ */
+
+#include "mem/probes/mem_footprint.hh"
+
+#include "base/intmath.hh"
+#include "params/MemFootprintProbe.hh"
+
+MemFootprintProbe::MemFootprintProbe(MemFootprintProbeParams *p)
+    : BaseMemProbe(p),
+      cacheLineSizeLg2(floorLog2(p->system->cacheLineSize())),
+      pageSizeLg2(floorLog2(p->page_size)),
+      totalCacheLinesInMem(p->system->memSize() / p->system->cacheLineSize()),
+      totalPagesInMem(p->system->memSize() / p->page_size),
+      cacheLines(),
+      cacheLinesAll(),
+      pages(),
+      pagesAll(),
+      system(p->system)
+{
+    fatal_if(!isPowerOf2(system->cacheLineSize()),
+             "MemFootprintProbe expects cache line size is power of 2.");
+    fatal_if(!isPowerOf2(p->page_size),
+             "MemFootprintProbe expects page size parameter is power of 2");
+}
+
+void
+MemFootprintProbe::regStats()
+{
+    BaseMemProbe::regStats();
+
+    using namespace Stats;
+    // clang-format off
+    fpCacheLine.name(name() + ".cacheline")
+        .desc("Memory footprint at cache line granularity")
+        .flags(nozero | nonan);
+    fpCacheLineTotal.name(name() + ".cacheline_total")
+        .desc("Total memory footprint at cache line granularity since "
+              "simulation begin")
+        .flags(nozero | nonan);
+    fpPage.name(name() + ".page")
+        .desc("Memory footprint at page granularity")
+        .flags(nozero | nonan);
+    fpPageTotal.name(name() + ".page_total")
+        .desc("Total memory footprint at page granularity since simulation "
+              "begin")
+        .flags(nozero | nonan);
+    // clang-format on
+
+    registerResetCallback(
+        new MakeCallback<MemFootprintProbe, &MemFootprintProbe::statReset>(
+            this));
+}
+
+void
+MemFootprintProbe::insertAddr(Addr addr, AddrSet *set, uint64_t limit)
+{
+    set->insert(addr);
+    assert(set->size() <= limit);
+}
+
+void
+MemFootprintProbe::handleRequest(const ProbePoints::PacketInfo &pi)
+{
+    if (!pi.cmd.isRequest() || !system->isMemAddr(pi.addr))
+        return;
+
+    const Addr cl_addr = (pi.addr >> cacheLineSizeLg2) << cacheLineSizeLg2;
+    const Addr page_addr = (pi.addr >> pageSizeLg2) << pageSizeLg2;
+    insertAddr(cl_addr, &cacheLines, totalCacheLinesInMem);
+    insertAddr(cl_addr, &cacheLinesAll, totalCacheLinesInMem);
+    insertAddr(page_addr, &pages, totalPagesInMem);
+    insertAddr(page_addr, &pagesAll, totalPagesInMem);
+
+    assert(cacheLines.size() <= cacheLinesAll.size());
+    assert(pages.size() <= pagesAll.size());
+
+    fpCacheLine = cacheLines.size() << cacheLineSizeLg2;
+    fpCacheLineTotal = cacheLinesAll.size() << cacheLineSizeLg2;
+    fpPage = pages.size() << pageSizeLg2;
+    fpPageTotal = pagesAll.size() << pageSizeLg2;
+}
+
+void
+MemFootprintProbe::statReset()
+{
+    cacheLines.clear();
+    pages.clear();
+}
+
+MemFootprintProbe *
+MemFootprintProbeParams::create()
+{
+    return new MemFootprintProbe(this);
+}
diff --git a/src/mem/probes/mem_footprint.hh b/src/mem/probes/mem_footprint.hh
new file mode 100644
index 000000000..821d61ae1
--- /dev/null
+++ b/src/mem/probes/mem_footprint.hh
@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2016 Google Inc.
+ * 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
+ * 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: Rahul Thakur
+ */
+
+#ifndef __MEM_PROBES_MEM_FOOTPRINT_HH__
+#define __MEM_PROBES_MEM_FOOTPRINT_HH__
+
+#include <unordered_map>
+
+#include "base/callback.hh"
+#include "mem/packet.hh"
+#include "mem/probes/base.hh"
+#include "sim/stats.hh"
+#include "sim/system.hh"
+
+struct MemFootprintProbeParams;
+
+/// Probe to track footprint of accessed memory
+/// Two granularity of footprint measurement i.e. cache line and page
+class MemFootprintProbe : public BaseMemProbe
+{
+  public:
+    typedef std::unordered_set<Addr> AddrSet;
+
+    MemFootprintProbe(MemFootprintProbeParams *p);
+    void regStats() override;
+    // Fix footprint tracking state on stat reset
+    void statReset();
+
+  protected:
+    /// Cache Line size for footprint measurement (log2)
+    const uint8_t cacheLineSizeLg2;
+    /// Page size for footprint measurement (log2)
+    const uint8_t pageSizeLg2;
+    const uint64_t totalCacheLinesInMem;
+    const uint64_t totalPagesInMem;
+
+    void insertAddr(Addr addr, AddrSet *set, uint64_t limit);
+    void handleRequest(const ProbePoints::PacketInfo &pkt_info) override;
+
+    /// Footprint at cache line size granularity
+    Stats::Scalar fpCacheLine;
+    /// Footprint at cache line size granularity, since simulation begin
+    Stats::Scalar fpCacheLineTotal;
+    /// Footprint at page granularity
+    Stats::Scalar fpPage;
+    /// Footprint at page granularity, since simulation begin
+    Stats::Scalar fpPageTotal;
+
+    // Addr set to track unique cache lines accessed
+    AddrSet cacheLines;
+    // Addr set to track unique cache lines accessed since simulation begin
+    AddrSet cacheLinesAll;
+    // Addr set to track unique pages accessed
+    AddrSet pages;
+    // Addr set to track unique pages accessed since simulation begin
+    AddrSet pagesAll;
+    System *system;
+};
+
+#endif  //__MEM_PROBES_MEM_FOOTPRINT_HH__