sim, stats: Move global stats to Root
authorAndreas Sandberg <andreas.sandberg@arm.com>
Mon, 5 Oct 2020 14:21:59 +0000 (15:21 +0100)
committerAndreas Sandberg <andreas.sandberg@arm.com>
Fri, 9 Oct 2020 09:56:52 +0000 (09:56 +0000)
Global stats are currently exposed using the legacy stat system (i.e.,
without a parent group). This change moves global stats from
stat_control.cc to a group that gets exported from the Root object.

The implementation adds the Root::Stats class which has a single
global instance. This instance is exposed to the rest of the simulator
using the global rootStats symbol. The intention is that objects that
need global statistics in formulas access them through the rootStats
object.

The global names simSeconds, simTicks, simFreq, and hostSeconds are
now references to their respective members in the rootStats object.

Change-Id: I267b5244a0bcca93dd2dcf03388e7085bdd79c9e
Signed-off-by: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/35616
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: kokoro <noreply+kokoro@google.com>
src/sim/SConscript
src/sim/root.cc
src/sim/root.hh
src/sim/stat_control.cc
src/sim/stat_control.hh
src/sim/stats.cc [new file with mode: 0644]
src/sim/stats.hh

index 6bda82859b026018537c8840445f424d08a1c2f3..78d9bf535f8f31f664d9de2471618ef2a4b9da4a 100644 (file)
@@ -81,6 +81,7 @@ Source('clocked_object.cc')
 Source('mathexpr.cc')
 Source('power_state.cc')
 Source('power_domain.cc')
+Source('stats.cc')
 
 GTest('byteswap.test', 'byteswap.test.cc', '../base/types.cc')
 GTest('guest_abi.test', 'guest_abi.test.cc')
index 5a174424e3cb69f3af74735dd1de6d870cf44598..e1c6a7b6ff82cfe18b090a1bee26a259864c1901 100644 (file)
@@ -1,4 +1,16 @@
 /*
+ * Copyright (c) 2020 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) 2002-2005 The Regents of The University of Michigan
  * Copyright (c) 2011 Advanced Micro Devices, Inc.
  * All rights reserved.
@@ -27,6 +39,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+#include "base/hostinfo.hh"
 #include "base/logging.hh"
 #include "base/trace.hh"
 #include "config/the_isa.hh"
 #include "sim/root.hh"
 
 Root *Root::_root = NULL;
+Root::Stats Root::Stats::instance;
+Root::Stats &rootStats = Root::Stats::instance;
+
+Root::Stats::Stats()
+    : Stats::Group(nullptr),
+    simSeconds(this, "sim_seconds", "Number of seconds simulated"),
+    simTicks(this, "sim_ticks", "Number of ticks simulated"),
+    finalTick(this, "final_tick",
+              "Number of ticks from beginning of simulation "
+              "(restored from checkpoints and never reset)"),
+    simFreq(this, "sim_freq", "Frequency of simulated ticks"),
+    hostSeconds(this, "host_seconds", "Real time elapsed on the host"),
+    hostTickRate(this, "host_tick_rate", "Simulator tick rate (ticks/s)"),
+    hostMemory(this, "host_mem_usage", "Number of bytes of host memory used"),
+
+    statTime(true),
+    startTick(0)
+{
+    simFreq.scalar(SimClock::Frequency);
+    simTicks.functor([this]() { return curTick() - startTick; });
+    finalTick.functor(curTick);
+
+    hostMemory
+        .functor(memUsage)
+        .prereq(hostMemory)
+        ;
+
+    hostSeconds
+        .functor([this]() {
+                Time now;
+                now.setTimer();
+                return now - statTime;
+            })
+        .precision(2)
+        ;
+
+    hostTickRate.precision(0);
+
+    simSeconds = simTicks / simFreq;
+    hostTickRate = simTicks / hostSeconds;
+}
+
+void
+Root::Stats::resetStats()
+{
+    statTime.setTimer();
+    startTick = curTick();
+
+    Stats::Group::resetStats();
+}
 
 /*
  * This function is called periodically by an event in M5 and ensures that
@@ -112,6 +175,12 @@ Root::Root(RootParams *p)
     lastTime.setTimer();
 
     simQuantum = p->sim_quantum;
+
+    // Some of the statistics are global and need to be accessed by
+    // stat formulas. The most convenient way to implement that is by
+    // having a single global stat group for global stats. Merge that
+    // group into the root object here.
+    mergeStatGroup(&Root::Stats::instance);
 }
 
 void
index 0638559a7238cae9b1bf51bf4112e2d65f6ceea1..a88673a7b746909dfac847887fe12f425251ca3b 100644 (file)
@@ -1,4 +1,16 @@
 /*
+ * Copyright (c) 2020 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) 2011 Advanced Micro Devices, Inc.
  * All rights reserved.
  *
@@ -39,6 +51,7 @@
 #ifndef __SIM_ROOT_HH__
 #define __SIM_ROOT_HH__
 
+#include "base/statistics.hh"
 #include "base/time.hh"
 #include "params/Root.hh"
 #include "sim/eventq.hh"
@@ -76,6 +89,32 @@ class Root : public SimObject
         return _root;
     }
 
+  public: // Global statistics
+    struct Stats : public ::Stats::Group
+    {
+        void resetStats() override;
+
+        ::Stats::Formula simSeconds;
+        ::Stats::Value simTicks;
+        ::Stats::Value finalTick;
+        ::Stats::Value simFreq;
+        ::Stats::Value hostSeconds;
+
+        ::Stats::Formula hostTickRate;
+        ::Stats::Value hostMemory;
+
+        static Stats instance;
+
+      private:
+        Stats();
+
+        Stats(const Stats &) = delete;
+        Stats &operator=(const Stats &) = delete;
+
+        Time statTime;
+        Tick startTick;
+    };
+
   public:
 
     /// Check whether time syncing is enabled.
@@ -108,4 +147,10 @@ class Root : public SimObject
     void serialize(CheckpointOut &cp) const override;
 };
 
+/**
+ * Global simulator statistics that are not associated with a
+ * specific SimObject.
+ */
+extern Root::Stats &rootStats;
+
 #endif // __SIM_ROOT_HH__
index 5b667860b036d8d97f5b0422343550bd6e92ed66..8189bfe349d08c5e887b121b81c9af7195175f5b 100644 (file)
 #include <list>
 
 #include "base/callback.hh"
-#include "base/hostinfo.hh"
 #include "base/statistics.hh"
 #include "base/time.hh"
 #include "sim/global_event.hh"
 
 using namespace std;
 
-Stats::Formula simSeconds;
-Stats::Value simTicks;
-Stats::Value finalTick;
-Stats::Value simFreq;
-Stats::Value hostSeconds;
-
 namespace Stats {
 
-Time statTime(true);
-Tick startTick;
-
 GlobalEvent *dumpEvent;
 
-double
-statElapsedTime()
-{
-    Time now;
-    now.setTimer();
-
-    Time elapsed = now - statTime;
-    return elapsed;
-}
-
-Tick
-statElapsedTicks()
-{
-    return curTick() - startTick;
-}
-
-Tick
-statFinalTick()
-{
-    return curTick();
-}
-
-struct Global
-{
-    Stats::Formula hostTickRate;
-    Stats::Value hostMemory;
-
-    Global();
-};
-
-Global::Global()
-{
-    simSeconds
-        .name("sim_seconds")
-        .desc("Number of seconds simulated")
-        ;
-
-    simFreq
-        .scalar(SimClock::Frequency)
-        .name("sim_freq")
-        .desc("Frequency of simulated ticks")
-        ;
-
-    simTicks
-        .functor(statElapsedTicks)
-        .name("sim_ticks")
-        .desc("Number of ticks simulated")
-        ;
-
-    finalTick
-        .functor(statFinalTick)
-        .name("final_tick")
-        .desc("Number of ticks from beginning of simulation "
-              "(restored from checkpoints and never reset)")
-        ;
-
-    hostMemory
-        .functor(memUsage)
-        .name("host_mem_usage")
-        .desc("Number of bytes of host memory used")
-        .prereq(hostMemory)
-        ;
-
-    hostSeconds
-        .functor(statElapsedTime)
-        .name("host_seconds")
-        .desc("Real time elapsed on the host")
-        .precision(2)
-        ;
-
-    hostTickRate
-        .name("host_tick_rate")
-        .desc("Simulator tick rate (ticks/s)")
-        .precision(0)
-        ;
-
-    simSeconds = simTicks / simFreq;
-    hostTickRate = simTicks / hostSeconds;
-
-    registerResetCallback([]() {
-        statTime.setTimer();
-        startTick = curTick();
-    });
-}
-
 void
 initSimStats()
 {
-    static Global global;
 }
 
 /**
index 3b869ad4f1e7875df94d654da15e0ff3b990d54d..55930b45617a31b25155930d6539f9bedf6fc3ea 100644 (file)
 
 namespace Stats {
 
-double statElapsedTime();
-
-Tick statElapsedTicks();
-
-Tick statFinalTick();
 
 void initSimStats();
 
diff --git a/src/sim/stats.cc b/src/sim/stats.cc
new file mode 100644 (file)
index 0000000..b5a3ca1
--- /dev/null
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2020 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
+ * 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.
+ */
+
+#include "sim/stats.hh"
+
+#include "sim/root.hh"
+
+Stats::Formula &simSeconds = rootStats.simSeconds;
+Stats::Value &simTicks = rootStats.simTicks;
+Stats::Value &simFreq = rootStats.simFreq;
+Stats::Value &hostSeconds = rootStats.hostSeconds;
index 4e17f64f06d7963eb5ea9df4f40f9ca19c9c0a12..a46539e27de410382dc9efb56acdac0fa071b41e 100644 (file)
@@ -31,9 +31,9 @@
 
 #include "base/statistics.hh"
 
-extern Stats::Formula simSeconds;
-extern Stats::Value simTicks;
-extern Stats::Value simFreq;
-extern Stats::Value hostSeconds;
+extern Stats::Formula &simSeconds;
+extern Stats::Value &simTicks;
+extern Stats::Value &simFreq;
+extern Stats::Value &hostSeconds;
 
 #endif // __SIM_SIM_STATS_HH__