Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
From:   Andreas Gerstmayr <agerstmayr@redhat.com>
To:     linux-perf-users@vger.kernel.org
Cc:     Martin Spier <mspier@netflix.com>,
        Brendan Gregg <bgregg@netflix.com>,
        Andreas Gerstmayr <agerstmayr@redhat.com>,
        Peter Zijlstra <peterz@infradead.org>,
        Ingo Molnar <mingo@redhat.com>,
        Arnaldo Carvalho de Melo <acme@kernel.org>,
        Mark Rutland <mark.rutland@arm.com>,
        Alexander Shishkin <alexander.shishkin@linux.intel.com>,
        Jiri Olsa <jolsa@redhat.com>,
        Namhyung Kim <namhyung@kernel.org>,
        linux-kernel@vger.kernel.org
Subject: [PATCH] perf script: add flamegraph.py script
Date:   Fri, 20 Mar 2020 16:13:48 +0100
Message-Id: <20200320151355.66302-1-agerstmayr@redhat.com>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

This script works in tandem with d3-flame-graph to generate flame graphs
from perf. It supports two output formats: JSON and HTML (the default).
The HTML format will look for a standalone d3-flame-graph template file i=
n
/usr/share/d3-flame-graph/d3-flamegraph-base.html and fill in the collect=
ed
stacks.

Usage:

    perf record -a -g -F 99 sleep 60
    perf script report flamegraph

Combined:

    perf script flamegraph -a -F 99 sleep 60

Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com>
---
Package for d3-flame-graph is currently under review, in the meantime you=
 can=20
download the template from:
https://cdn.jsdelivr.net/npm/d3-flame-graph@3.0.2/dist/templates/d3-flame=
graph-base.html
and move it to /usr/share/d3-flame-graph/d3-flamegraph-base.html

 .../perf/scripts/python/bin/flamegraph-record |   2 +
 .../perf/scripts/python/bin/flamegraph-report |   3 +
 tools/perf/scripts/python/flamegraph.py       | 126 ++++++++++++++++++
 3 files changed, 131 insertions(+)
 create mode 100755 tools/perf/scripts/python/bin/flamegraph-record
 create mode 100755 tools/perf/scripts/python/bin/flamegraph-report
 create mode 100755 tools/perf/scripts/python/flamegraph.py

diff --git a/tools/perf/scripts/python/bin/flamegraph-record b/tools/perf=
/scripts/python/bin/flamegraph-record
new file mode 100755
index 000000000000..725d66e71570
--- /dev/null
+++ b/tools/perf/scripts/python/bin/flamegraph-record
@@ -0,0 +1,2 @@
+#!/usr/bin/sh
+perf record -g "$@"
diff --git a/tools/perf/scripts/python/bin/flamegraph-report b/tools/perf=
/scripts/python/bin/flamegraph-report
new file mode 100755
index 000000000000..b1a79afd903b
--- /dev/null
+++ b/tools/perf/scripts/python/bin/flamegraph-report
@@ -0,0 +1,3 @@
+#!/usr/bin/sh
+# description: create flame graphs
+perf script -s "$PERF_EXEC_PATH"/scripts/python/flamegraph.py -- "$@"
diff --git a/tools/perf/scripts/python/flamegraph.py b/tools/perf/scripts=
/python/flamegraph.py
new file mode 100755
index 000000000000..5835d190ca42
--- /dev/null
+++ b/tools/perf/scripts/python/flamegraph.py
@@ -0,0 +1,126 @@
+# flamegraph.py - create flame graphs from perf samples
+# SPDX-License-Identifier: GPL-2.0
+#
+# Usage:
+#
+#     perf record -a -g -F 99 sleep 60
+#     perf script report flamegraph
+#
+# Combined:
+#
+#     perf script flamegraph -a -F 99 sleep 60
+#
+# Written by Andreas Gerstmayr <agerstmayr@redhat.com>
+# Flame Graphs invented by Brendan Gregg <bgregg@netflix.com>
+# Works in tandem with d3-flame-graph by Martin Spier <mspier@netflix.co=
m>
+
+import sys
+import os
+import argparse
+import json
+
+
+class Node:
+    def __init__(self, name, libtype=3D""):
+        self.name =3D name
+        self.libtype =3D libtype
+        self.value =3D 0
+        self.children =3D []
+
+    def toJSON(self):
+        return {
+            "n": self.name,
+            "l": self.libtype,
+            "v": self.value,
+            "c": self.children
+        }
+
+
+class FlameGraphCLI:
+    def __init__(self, args):
+        self.args =3D args
+        self.stack =3D Node("root")
+
+        if self.args.format =3D=3D "html" and \
+                not os.path.isfile(self.args.template):
+            print(f"Flame Graph template {self.args.template} does not "=
 +
+                  f"exist. Please install the js-d3-flame-graph (RPM) or=
 " +
+                  f"libjs-d3-flame-graph (deb) package, specify an " +
+                  f"existing flame graph template (--template PATH) or "=
 +
+                  f"another output format (--format FORMAT).",
+                  file=3Dsys.stderr)
+            sys.exit(1)
+
+    def find_or_create_node(self, node, name, dso):
+        libtype =3D "kernel" if dso =3D=3D "[kernel.kallsyms]" else ""
+        if name is None:
+            name =3D "[unknown]"
+
+        for child in node.children:
+            if child.name =3D=3D name and child.libtype =3D=3D libtype:
+                return child
+
+        child =3D Node(name, libtype)
+        node.children.append(child)
+        return child
+
+    def process_event(self, event):
+        node =3D self.find_or_create_node(self.stack, event["comm"], Non=
e)
+        if "callchain" in event:
+            for entry in reversed(event['callchain']):
+                node =3D self.find_or_create_node(
+                    node, entry.get("sym", {}).get("name"), event.get("d=
so"))
+        else:
+            node =3D self.find_or_create_node(
+                node, entry.get("symbol"), event.get("dso"))
+        node.value +=3D 1
+
+    def trace_end(self):
+        json_str =3D json.dumps(self.stack, default=3Dlambda x: x.toJSON=
(),
+                              indent=3Dself.args.indent)
+
+        if self.args.format =3D=3D "html":
+            try:
+                with open(self.args.template) as f:
+                    output_str =3D f.read().replace("/** @flamegraph_jso=
n **/",
+                                                  json_str)
+            except IOError as e:
+                print(f"Error reading template file: {e}", file=3Dsys.st=
derr)
+                sys.exit(1)
+            output_fn =3D self.args.output or "flamegraph.html"
+        else:
+            output_str =3D json_str
+            output_fn =3D self.args.output or "stacks.json"
+
+        if output_fn =3D=3D "-":
+            sys.stdout.write(output_str)
+        else:
+            print(f"dumping data to {output_fn}")
+            try:
+                with open(output_fn, "w") as out:
+                    out.write(output_str)
+            except IOError as e:
+                print(f"Error writing output file: {e}", file=3Dsys.stde=
rr)
+                sys.exit(1)
+
+
+if __name__ =3D=3D "__main__":
+    parser =3D argparse.ArgumentParser(description=3D"Create flame graph=
s.")
+    parser.add_argument("-F", "--format",
+                        default=3D"html", choices=3D["json", "html"],
+                        help=3D"output file format")
+    parser.add_argument("-o", "--output",
+                        help=3D"output file name")
+    parser.add_argument("--indent",
+                        type=3Dint, help=3D"JSON indentation")
+    parser.add_argument("--template",
+                        default=3D"/usr/share/d3-flame-graph/d3-flamegra=
ph-base.html",
+                        help=3D"path to flamegraph HTML template")
+    parser.add_argument("-i", "--input",
+                        help=3Dargparse.SUPPRESS)
+
+    args =3D parser.parse_args()
+    cli =3D FlameGraphCLI(args)
+
+    process_event =3D cli.process_event
+    trace_end =3D cli.trace_end
--=20
2.25.1