From d60b1f92213ace6a8ab6a4a60cb01a43f45d3955 Mon Sep 17 00:00:00 2001
From: Nat Goodspeed <nat@lindenlab.com>
Date: Thu, 12 Sep 2024 13:43:36 -0400
Subject: [PATCH] Add script to convert frame profile JSON file to CSV.

Also slightly refactor profile_pretty.py.
---
 scripts/perf/profile_csv.py    | 72 ++++++++++++++++++++++++++++++++++
 scripts/perf/profile_pretty.py | 26 ++++++------
 2 files changed, 85 insertions(+), 13 deletions(-)
 create mode 100644 scripts/perf/profile_csv.py

diff --git a/scripts/perf/profile_csv.py b/scripts/perf/profile_csv.py
new file mode 100644
index 0000000000..273e3b7434
--- /dev/null
+++ b/scripts/perf/profile_csv.py
@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+"""\
+@file   profile_csv.py
+@author Nat Goodspeed
+@date   2024-09-12
+@brief  Convert a JSON file from Develop -> Render Tests -> Frame Profile to CSV
+
+$LicenseInfo:firstyear=2024&license=viewerlgpl$
+Copyright (c) 2024, Linden Research, Inc.
+$/LicenseInfo$
+"""
+
+import logsdir
+import json
+from pathlib import Path
+import sys
+
+class Error(Exception):
+    pass
+
+def convert(path, totals=True, unused=True, file=sys.stdout):
+    with open(path) as inf:
+        data = json.load(inf)
+    print('"name", "file1", "file2", "time", "binds", "samples", "triangles"', file=file)
+
+    if totals:
+        t = data['totals']
+        print(f'"totals", "", "", {t["time"]}, {t["binds"]}, {t["samples"]}, {t["triangles"]}',
+              file=file)
+
+    for sh in data['shaders']:
+        print(f'"{sh["name"]}", "{sh["files"][0]}", "{sh["files"][1]}", '
+              f'{sh["time"]}, {sh["binds"]}, {sh["samples"]}, {sh["triangles"]}', file=file)
+
+    if unused:
+        for u in data['unused']:
+            print(f'"{u}", "", "", 0, 0, 0, 0', file=file)
+
+def main(*raw_args):
+    from argparse import ArgumentParser
+    parser = ArgumentParser(description="""
+%(prog)s converts a JSON file from Develop -> Render Tests -> Frame Profile to
+a more-or-less equivalent CSV file. It expands the totals stats and unused
+shaders list to full shaders lines.
+""")
+    parser.add_argument('-t', '--totals', action='store_false', default=True,
+                        help="""omit totals from CSV file""")
+    parser.add_argument('-u', '--unused', action='store_false', default=True,
+                        help="""omit unused shaders from CSV file""")
+    parser.add_argument('path', nargs='?',
+                        help="""profile filename to convert (default is most recent)""")
+
+    args = parser.parse_args(raw_args)
+    if not args.path:
+        logs = logsdir.logsdir()
+        profiles = Path(logs).glob('profile.*.json')
+        sort = [(p.stat().st_mtime, p) for p in profiles]
+        sort.sort(reverse=True)
+        try:
+            args.path = sort[0][1]
+        except IndexError:
+            raise Error(f'No profile.*.json files in {logs}')
+        # print path to sys.stderr in case user is redirecting stdout
+        print(args.path, file=sys.stderr)
+
+    convert(args.path, totals=args.totals, unused=args.unused)
+
+if __name__ == "__main__":
+    try:
+        sys.exit(main(*sys.argv[1:]))
+    except (Error, OSError, json.JSONDecodeError) as err:
+        sys.exit(str(err))
diff --git a/scripts/perf/profile_pretty.py b/scripts/perf/profile_pretty.py
index ca52fe366a..15b6efd94d 100644
--- a/scripts/perf/profile_pretty.py
+++ b/scripts/perf/profile_pretty.py
@@ -18,19 +18,7 @@
 class Error(Exception):
     pass
 
-def pretty(path=None):
-    if not path:
-        logs = logsdir.logsdir()
-        profiles = Path(logs).glob('profile.*.json')
-        sort = [(p.stat().st_mtime, p) for p in profiles]
-        sort.sort(reverse=True)
-        try:
-            path = sort[0][1]
-        except IndexError:
-            raise Error(f'No profile.*.json files in {logs}')
-        # print path to sys.stderr in case user is redirecting stdout
-        print(path, file=sys.stderr)
-
+def pretty(path):
     with open(path) as inf:
         data = json.load(inf)
     json.dump(data, sys.stdout, indent=4)
@@ -45,6 +33,18 @@ def main(*raw_args):
                         help="""profile filename to pretty-print (default is most recent)""")
 
     args = parser.parse_args(raw_args)
+    if not args.path:
+        logs = logsdir.logsdir()
+        profiles = Path(logs).glob('profile.*.json')
+        sort = [(p.stat().st_mtime, p) for p in profiles]
+        sort.sort(reverse=True)
+        try:
+            args.path = sort[0][1]
+        except IndexError:
+            raise Error(f'No profile.*.json files in {logs}')
+        # print path to sys.stderr in case user is redirecting stdout
+        print(args.path, file=sys.stderr)
+
     pretty(args.path)
 
 if __name__ == "__main__":