From cb51ea981a4506d1adbb9346b1b39502994bf35e Mon Sep 17 00:00:00 2001
From: Ell <ell_se@yahoo.com>
Date: Wed, 10 Oct 2018 15:16:11 -0400
Subject: [PATCH] tools: add performance-log-coalesce.py; use in
 performance-log-viewer

Add a new performance-log-coalesce.py tool, which groups together
performance-log address-map entries belonging to the same function
into a single symbol, by filling-in missing base symbol addresses.
The addresses are grouped such that each set of addresses
corresponding to a symbol of the same name, in the same source
file, are given the same (unique, but arbitrary) base address.
See the previous commit for why this is necessary.

This should work fine in most cases, however, for logs produced on
Windows, it can over-coalesce addresses belonging to different C++
lambda-functions in the same source file, since they all seem to be
given the same _FUN symbol name.

Use the new tool as part of the pipeline in performance-log-viewer.
---
 tools/performance-log-coalesce.py | 62 +++++++++++++++++++++++++++++++
 tools/performance-log-viewer      |  7 ++--
 2 files changed, 66 insertions(+), 3 deletions(-)
 create mode 100755 tools/performance-log-coalesce.py

diff --git a/tools/performance-log-coalesce.py b/tools/performance-log-coalesce.py
new file mode 100755
index 0000000000..fbbaca3a5f
--- /dev/null
+++ b/tools/performance-log-coalesce.py
@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+
+"""
+performance-log-coalesce.py -- Coalesce GIMP performance log symbols, by
+                               filling-in missing base addresses
+Copyright (C) 2018  Ell
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+
+Usage: performance-log-coalesce.py < infile > outfile
+"""
+
+from xml.etree import ElementTree
+import sys
+
+empty_element = ElementTree.Element ("")
+
+# Read performance log from STDIN
+log = ElementTree.fromstring (sys.stdin.buffer.read ())
+
+address_map = log.find ("address-map")
+
+if address_map:
+    addresses = []
+
+    # Create base addresses dictionary
+    base_addresses = {}
+
+    for address in address_map.iterfind ("address"):
+        symbol = address.find ("symbol").text
+        source = address.find ("source").text
+        base   = address.find ("base").text
+
+        if symbol and source and not base:
+            key   = (symbol, source)
+            value = int (address.get ("value"), 0)
+
+            base_addresses[key] = min (value, base_addresses.get (key, value))
+
+            addresses.append (address)
+
+    # Fill-in missing base addresses
+    for address in addresses:
+        symbol = address.find ("symbol").text
+        source = address.find ("source").text
+
+        address.find ("base").text = hex (base_addresses[(symbol, source)])
+
+# Write performance log to STDOUT
+sys.stdout.buffer.write (ElementTree.tostring (log))
diff --git a/tools/performance-log-viewer b/tools/performance-log-viewer
index 2349ec3a11..ee60298f43 100755
--- a/tools/performance-log-viewer
+++ b/tools/performance-log-viewer
@@ -30,7 +30,8 @@ file="$1"
 
 < "$file" || exit 1
 
-< "$file"                                \
-"$tools_dir/performance-log-expand.py" | \
-"$tools_dir/performance-log-deduce.py" | \
+< "$file"                                  \
+"$tools_dir/performance-log-expand.py"   | \
+"$tools_dir/performance-log-coalesce.py" | \
+"$tools_dir/performance-log-deduce.py"   | \
 "$tools_dir/performance-log-viewer.py"