From ea0a5f90e2fc9816ba19d5f9e1853adcc2ec8358 Mon Sep 17 00:00:00 2001
From: Horst Schirmeier <horst.schirmeier@tu-dortmund.de>
Date: Sun, 14 Feb 2016 16:20:23 +0100
Subject: [PATCH] faultspaceplot: add ticks for symbols if available

+ use helper scripts from the same dir, not from $PATH

Change-Id: I7aba773c8dbff5f8643a39fa1ed8d26867f3a86d
---
 .../analysis/faultspaceplot/faultspaceplot.sh | 30 +++++++++-
 tools/analysis/faultspaceplot/fsp.plot.py     | 60 ++++++++++++++++++-
 2 files changed, 86 insertions(+), 4 deletions(-)

diff --git a/tools/analysis/faultspaceplot/faultspaceplot.sh b/tools/analysis/faultspaceplot/faultspaceplot.sh
index 3730a44e..db4425aa 100755
--- a/tools/analysis/faultspaceplot/faultspaceplot.sh
+++ b/tools/analysis/faultspaceplot/faultspaceplot.sh
@@ -9,9 +9,17 @@ fi
 DATABASE=$1
 VARIANT=$2
 BENCHMARK=$3
-# add "-t" for more readable output
 MYSQL="mysql -B --quick $DATABASE"
 
+MYDIR=$(dirname $0)
+
+function table_exists()
+{
+	N=$(echo "SHOW TABLES LIKE '$1'" | $MYSQL $DATABASE | wc -l)
+	[ $N -gt 0 ]
+	return
+}
+
 # get data
 echo "getting faultspace data.."
 $MYSQL <<EOT > "$VARIANT"_"$BENCHMARK"-raw.csv
@@ -44,8 +52,24 @@ EOT
 
 # compact data
 echo "compacting data.."
-fsp.compact.sh "$VARIANT"_"$BENCHMARK"-raw.csv "$VARIANT"_"$BENCHMARK"-plot.csv
+"$MYDIR"/fsp.compact.sh "$VARIANT"_"$BENCHMARK"-raw.csv "$VARIANT"_"$BENCHMARK"-plot.csv
+
+# fetch symbols if available
+if table_exists symbol; then
+	echo "getting symbol information ..."
+	$MYSQL <<EOT > "$VARIANT"_"$BENCHMARK"-symbols.csv
+	SELECT s.address, s.size, s.name
+	FROM variant v
+	JOIN symbol s ON s.variant_id = v.id
+	WHERE v.variant = '$VARIANT' AND v.benchmark = '$BENCHMARK'
+	ORDER BY s.address
+EOT
+fi
 
 # plot data
 echo "plotting.."
-fsp.plot.py "$VARIANT"_"$BENCHMARK"-plot.csv
+if [ -e "$VARIANT"_"$BENCHMARK"-symbols.csv -a $(wc -l < "$VARIANT"_"$BENCHMARK"-symbols.csv) -gt 1 ]; then
+	"$MYDIR"/fsp.plot.py "$VARIANT"_"$BENCHMARK"-plot.csv "$VARIANT"_"$BENCHMARK"-symbols.csv
+else
+	"$MYDIR"/fsp.plot.py "$VARIANT"_"$BENCHMARK"-plot.csv
+fi
diff --git a/tools/analysis/faultspaceplot/fsp.plot.py b/tools/analysis/faultspaceplot/fsp.plot.py
index a772f69d..26ef91bb 100755
--- a/tools/analysis/faultspaceplot/fsp.plot.py
+++ b/tools/analysis/faultspaceplot/fsp.plot.py
@@ -42,7 +42,7 @@ if sys.argv[1] == '-h':
     print "DATA_FILE is a CSV-file, storing the tab-separated values"
     print "retrieved by the experiment run. USER_TAG_FILE is an optional"
     print "CSV-file which can be used to add user-specific marks to the"
-    print "plot (not implemented yet)." # TODO: be more precise here
+    print "plot." # TODO: be more precise here
     exit(0)
 
 print "Opening and processing \"" + sys.argv[1] + "\"..."
@@ -52,6 +52,17 @@ file.seek(0)
 reader = csv.reader(file, dialect)
 reader.next() # Move down a line to skip the header
 
+if len(sys.argv) >= 3:
+    print "Opening and processing \"" + sys.argv[2] + "\"..."
+    symbolfile = open(sys.argv[2], "r")
+    dialect = csv.Sniffer().sniff(symbolfile.read(1024))
+    symbolfile.seek(0)
+    symbolreader = csv.reader(symbolfile, dialect)
+    symbolreader.next() # Move down a line to skip the header
+    have_symbols = True
+else:
+    have_symbols = False
+
 fig = plt.figure()
 
 xmin = 99999999
@@ -104,5 +115,52 @@ plt.ylim(ymin, ymax)
 plt.ylabel('Data Memory (RAM)')
 plt.xlabel('Time (Cycles)')
 
+# show symbols
+if have_symbols:
+    # Adding 2nd y-axis for object names
+    ax1 = fig.add_subplot(111)
+    ax2 = ax1.twinx()
+    ax2.set_ylabel('Symbols')
+
+    # necessary for proper symbol placement
+    plt.ylim(ymin, ymax)
+
+    ticks = []
+    symbols = []
+
+    IDX_SYMBOL_ADDRESS = 0; IDX_SYMBOL_SIZE = 1; IDX_SYMBOL_NAME = 2;
+
+    for row in symbolreader:
+        # TODO: somehow plot size as well
+        address = int(row[IDX_SYMBOL_ADDRESS])
+        size = int(row[IDX_SYMBOL_SIZE])
+        if (address >= ymin) and (address <= ymax):
+            ticks.append(address)
+            symbols.append(row[IDX_SYMBOL_NAME])
+            #print "symbol: " + str(address) + " " + str(size) + " " + row[IDX_SYMBOL_NAME]
+        elif (address < ymin) and (address + size >= ymin):
+            ticks.append(ymin)
+            symbols.append("(" + row[IDX_SYMBOL_NAME] + ")")
+            #print "partial symbol: " + str(address) + " " + str(size) + " " + row[IDX_SYMBOL_NAME]
+        else:
+            #print "skipped symbol: " + str(address) + " " + str(size) + " " + row[IDX_SYMBOL_NAME]
+            pass
+
+    # list of interesting addresses
+    ax2.yaxis.set_ticks(ticks)
+    ax2.yaxis.grid(b=True, color='gray')
+
+    # create minor ticks centered between major tick marks
+    centered_ticks = []
+    major_locator = ax2.yaxis.get_major_locator()
+    major_locs = major_locator()
+    for i in range(1,len(major_locs)):
+        y_last,y = major_locs[i-1],major_locs[i]
+        centered_ticks.append(0.5*(y+y_last))
+    ax2.yaxis.set_ticks(centered_ticks, minor=True)
+
+    # list of corresponding symbol names
+    ax2.set_yticklabels(symbols, minor=False, rotation=0, rotation_mode='anchor')
+
 plt.show()
 #pylab.savefig('baseline.pdf', bbox_inches='tight')