From 7223d1e05c50e96f79238ebb8fe6ad1cb7b87bba Mon Sep 17 00:00:00 2001
From: Ross Thompson <ross1728@gmail.com>
Date: Fri, 6 Jan 2023 15:15:54 -0600
Subject: [PATCH] Added python script to post process performance counter
 metrics.

---
 bin/parseHPMC.py                 | 108 +++++++++++++++++++++++++++++++
 pipelined/testbench/testbench.sv |   4 +-
 2 files changed, 110 insertions(+), 2 deletions(-)
 create mode 100755 bin/parseHPMC.py

diff --git a/bin/parseHPMC.py b/bin/parseHPMC.py
new file mode 100755
index 000000000..8830adf68
--- /dev/null
+++ b/bin/parseHPMC.py
@@ -0,0 +1,108 @@
+#!/usr/bin/python3
+
+import os
+import sys
+
+def ComputeCPI(benchmark):
+    'Computes and inserts CPI into benchmark stats.'
+    (nameString, opt, dataDict) = benchmark
+    CPI = 1.0 * int(dataDict['Mcycle']) / int(dataDict['InstRet'])
+    dataDict['CPI'] = CPI
+
+def ComputeBranchDirMissRate(benchmark):
+    'Computes and inserts branch direction miss prediction rate.'
+    (nameString, opt, dataDict) = benchmark
+    branchDirMissRate = 100.0 * int(dataDict['Br Dir Wrong']) / int(dataDict['Br Count'])
+    dataDict['BDMR'] = branchDirMissRate
+
+def ComputeBranchTargetMissRate(benchmark):
+    'Computes and inserts branch target miss prediction rate.'
+    # *** this is wrong in the verilog test bench
+    (nameString, opt, dataDict) = benchmark
+    branchTargetMissRate = 100.0 * int(dataDict['Br Target Wrong']) / (int(dataDict['Br Count']) + int(dataDict['Jump, JR, ret']) + int(dataDict['ret']))
+    dataDict['BTMR'] = branchTargetMissRate
+
+def ComputeRASMissRate(benchmark):
+    'Computes and inserts return address stack miss prediction rate.'
+    (nameString, opt, dataDict) = benchmark
+    RASMPR = 100.0 * int(dataDict['RAS Wrong']) / int(dataDict['ret'])
+    dataDict['RASMPR'] = RASMPR
+
+def ComputeInstrClassMissRate(benchmark):
+    'Computes and inserts instruction class miss prediction rate.'
+    (nameString, opt, dataDict) = benchmark
+    ClassMPR = 100.0 * int(dataDict['Instr Class Wrong']) / int(dataDict['InstRet'])
+    dataDict['ClassMPR'] = ClassMPR
+    
+def ComputeICacheMissRate(benchmark):
+    'Computes and inserts instruction class miss prediction rate.'
+    (nameString, opt, dataDict) = benchmark
+    ICacheMR = 100.0 * int(dataDict['I Cache Miss']) / int(dataDict['I Cache Access'])
+    dataDict['ICacheMR'] = ICacheMR
+
+def ComputeDCacheMissRate(benchmark):
+    'Computes and inserts instruction class miss prediction rate.'
+    (nameString, opt, dataDict) = benchmark
+    DCacheMR = 100.0 * int(dataDict['D Cache Miss']) / int(dataDict['D Cache Access'])
+    dataDict['DCacheMR'] = DCacheMR
+    
+    
+def printStats(benchmark):
+    (nameString, opt, dataDict) = benchmark
+    CPI = dataDict['CPI']
+    BDMR = dataDict['BDMR']
+    BTMR = dataDict['BTMR']
+    RASMPR = dataDict['RASMPR']
+    print('Test', nameString)
+    print('Compile configuration', opt)
+    print('CPI \t\t\t  %1.2f' % CPI)
+    print('Branch Dir Pred Miss Rate %2.2f' % BDMR)
+    print('Branch Target Pred Miss Rate %2.2f' % BTMR)
+    print('RAS Miss Rate \t\t  %1.2f' % RASMPR)
+    print('Instr Class Miss Rate  %1.2f' % dataDict['ClassMPR'])
+    print('I Cache Miss Rate  %1.4f' % dataDict['ICacheMR'])
+    print('D Cache Miss Rate  %1.4f' % dataDict['DCacheMR'])
+    print()
+
+
+# 1 find lines with Read memfile and extract test name
+# 2 parse counters into a list of (name, value) tuples (dictionary maybe?)
+# 3 process into useful data
+  # cache hit rates
+  # cache fill time
+  # branch predictor status
+  # hazard counts
+  # CPI
+  # instruction distribution
+
+# steps 1 and 2
+benchmarks = []
+transcript = open(sys.argv[1], 'r')
+HPMClist = { }
+testName = ''
+for line in transcript.readlines():
+    lineToken = line.split()
+    if(len(lineToken) > 3 and lineToken[1] == 'Read' and lineToken[2] == 'memfile'):
+        opt = lineToken[3].split('/')[-4]
+        testName = lineToken[3].split('/')[-1].split('.')[0]
+        HPMClist = { }
+    elif(len(lineToken) > 4 and lineToken[1][0:3] == 'Cnt'):
+        countToken = line.split('=')[1].split()
+        value = countToken[0]
+        name = ' '.join(countToken[1:])
+        HPMClist[name] = value
+    elif ('is done' in line):
+        benchmarks.append((testName, opt, HPMClist))
+
+#print(benchmarks[0])
+
+for benchmark in benchmarks:
+    ComputeCPI(benchmark)
+    ComputeBranchDirMissRate(benchmark)
+    ComputeBranchTargetMissRate(benchmark)
+    ComputeRASMissRate(benchmark)
+    ComputeInstrClassMissRate(benchmark)
+    ComputeICacheMissRate(benchmark)
+    ComputeDCacheMissRate(benchmark)
+    printStats(benchmark)
+
diff --git a/pipelined/testbench/testbench.sv b/pipelined/testbench/testbench.sv
index 48cd58c8d..e847e8397 100644
--- a/pipelined/testbench/testbench.sv
+++ b/pipelined/testbench/testbench.sv
@@ -32,7 +32,7 @@
 `include "wally-config.vh"
 `include "tests.vh"
 
-`define PrintHPMCounters 0
+`define PrintHPMCounters 1
 
 module testbench;
   parameter DEBUG=0;
@@ -413,7 +413,7 @@ logic [3:0] dummy;
                             "Br Dir Wrong",
                             "Br Count",
                             "Br Target Wrong",
-                            "Jump, JR, ret",
+                            "Jump, JR, Jal",
                             "RAS Wrong",
                             "ret",
                             "Instr Class Wrong",