From 3fb6492482d5cad867d4da90563fbcfcbbf36352 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tiago=20M=C3=BCck?= <tiago.muck@arm.com>
Date: Thu, 23 Jul 2020 20:59:07 -0500
Subject: [PATCH] mem-ruby: extended transaction profiling
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Adds additional stats to accounts for incoming and outgoing retries.

Calling incomingTransactionStart with retried==true indicates the
received request initiating the transaction is a retried request.

Calling outgoingTransactionEnd with retried==true indicates the request
was retried by the requester.

Change-Id: I22fd971d4997fce0c114b5ec030cbbf9b463d0c6
Signed-off-by: Tiago Mück <tiago.muck@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/41158
Reviewed-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: kokoro <noreply+kokoro@google.com>
---
 .../slicc_interface/AbstractController.hh     | 12 +++++++++--
 src/mem/slicc/symbols/StateMachine.py         | 21 ++++++++++++++++++-
 2 files changed, 30 insertions(+), 3 deletions(-)

diff --git a/src/mem/ruby/slicc_interface/AbstractController.hh b/src/mem/ruby/slicc_interface/AbstractController.hh
index 214b07236c..95be144988 100644
--- a/src/mem/ruby/slicc_interface/AbstractController.hh
+++ b/src/mem/ruby/slicc_interface/AbstractController.hh
@@ -216,10 +216,12 @@ class AbstractController : public ClockedObject, public Consumer
      */
     template<typename EventType, typename StateType>
     void incomingTransactionStart(Addr addr,
-        EventType type, StateType initialState)
+        EventType type, StateType initialState, bool retried)
     {
         assert(m_inTrans.find(addr) == m_inTrans.end());
         m_inTrans[addr] = {type, initialState, curTick()};
+        if (retried)
+          ++(*stats.inTransLatRetries[type]);
     }
 
     /**
@@ -237,6 +239,7 @@ class AbstractController : public ClockedObject, public Consumer
                               [iter->second.state]
                               [(unsigned)finalState]->sample(
                                 ticksToCycles(curTick() - iter->second.time));
+        ++(*stats.inTransLatTotal[iter->second.transaction]);
        m_inTrans.erase(iter);
     }
 
@@ -260,12 +263,14 @@ class AbstractController : public ClockedObject, public Consumer
      *
      * @param addr address of the line with an outstanding transaction
      */
-    void outgoingTransactionEnd(Addr addr)
+    void outgoingTransactionEnd(Addr addr, bool retried)
     {
         auto iter = m_outTrans.find(addr);
         assert(iter != m_outTrans.end());
         stats.outTransLatHist[iter->second.transaction]->sample(
             ticksToCycles(curTick() - iter->second.time));
+        if (retried)
+          ++(*stats.outTransLatHistRetries[iter->second.transaction]);
         m_outTrans.erase(iter);
     }
 
@@ -356,10 +361,13 @@ class AbstractController : public ClockedObject, public Consumer
         // states. Only histograms with samples will appear in the stats
         std::vector<std::vector<std::vector<Stats::Histogram*>>>
           inTransLatHist;
+        std::vector<Stats::Scalar*> inTransLatRetries;
+        std::vector<Stats::Scalar*> inTransLatTotal;
 
         // Initialized by the SLICC compiler for all events.
         // Only histograms with samples will appear in the stats.
         std::vector<Stats::Histogram*> outTransLatHist;
+        std::vector<Stats::Scalar*> outTransLatHistRetries;
 
         //! Counter for the number of cycles when the transitions carried out
         //! were equal to the maximum allowed
diff --git a/src/mem/slicc/symbols/StateMachine.py b/src/mem/slicc/symbols/StateMachine.py
index 23f8707cb7..012441d99c 100644
--- a/src/mem/slicc/symbols/StateMachine.py
+++ b/src/mem/slicc/symbols/StateMachine.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2020 ARM Limited
+# Copyright (c) 2019-2021 ARM Limited
 # All rights reserved.
 #
 # The license below extends only to copyright in the software and shall
@@ -849,6 +849,7 @@ $c_ident::regStats()
             }
         }
     }
+
     for (${ident}_Event event = ${ident}_Event_FIRST;
                  event < ${ident}_Event_NUM; ++event) {
         std::string stat_name =
@@ -858,9 +859,27 @@ $c_ident::regStats()
         t->init(5);
         t->flags(Stats::pdf | Stats::total |
                  Stats::oneline | Stats::nozero);
+
+        Stats::Scalar* r = new Stats::Scalar(&stats,
+                                             (stat_name + ".retries").c_str());
+        stats.outTransLatHistRetries.push_back(r);
+        r->flags(Stats::nozero);
     }
+
     for (${ident}_Event event = ${ident}_Event_FIRST;
                  event < ${ident}_Event_NUM; ++event) {
+        std::string stat_name = ".inTransLatHist." +
+                                ${ident}_Event_to_string(event);
+        Stats::Scalar* r = new Stats::Scalar(&stats,
+                                             (stat_name + ".total").c_str());
+        stats.inTransLatTotal.push_back(r);
+        r->flags(Stats::nozero);
+
+        r = new Stats::Scalar(&stats,
+                              (stat_name + ".retries").c_str());
+        stats.inTransLatRetries.push_back(r);
+        r->flags(Stats::nozero);
+
         stats.inTransLatHist.emplace_back();
         for (${ident}_State initial_state = ${ident}_State_FIRST;
              initial_state < ${ident}_State_NUM; ++initial_state) {