Skip to contentSkip to conversation

perf script: add flamegraph.py script

RFC In review Andreas Gerstmayr 2 participants 6 messages Feb 21, 2020 – Feb 27, 2020 perf events

lore
Share & tools
lore
#0 lore raw

RFC 1/1 perf script: add flamegraph.py script

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 in /usr/share/d3-flame-graph/template.html and fill in the collected stacks.

Usage:

perf script flamegraph -a -F 99 sleep 60

Alternative usage:

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

Cc Peter Zijlstra <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Mark Rutland <[email protected]>
Cc Alexander Shishkin <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>

---

I'm currently preparing packages for d3-flame-graph. For Fedora, the copr at
https://copr.fedorainfracloud.org/coprs/agerstmayr/reviews/package/js-d3-flame-graph/
can be installed, or alternatively the prebuilt standalone d3-flame-graph template can be downloaded from
https://raw.githubusercontent.com/andreasgerstmayr/specs/master/reviews/js-d3-flame-graph/template.html
and moved into /usr/share/d3-flame-graph/template.html

 .../perf/scripts/python/bin/flamegraph-record |   2 +
 .../perf/scripts/python/bin/flamegraph-report |   3 +
 tools/perf/scripts/python/flamegraph.py       | 117 ++++++++++++++++++
 3 files changed, 122 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
tools/perf/scripts/python/bin/flamegraph-record new file +2 -0
new file mode 100755
index 000000000000..725d66e71570
@@ -0,0 +1,2 @@
+#!/usr/bin/sh
+perf record -g "$@"
tools/perf/scripts/python/bin/flamegraph-report new file +3 -0
new file mode 100755
index 000000000000..b1a79afd903b
@@ -0,0 +1,3 @@
+#!/usr/bin/sh
+# description: create flame graphs
+perf script -s "$PERF_EXEC_PATH"/scripts/python/flamegraph.py -- "$@"
tools/perf/scripts/python/flamegraph.py new file +117 -0

117 lines not on this page · raw message

Signature · 1 line
2.24.1
#1 lore raw
Quoted 5 lines · Andreas Gerstmayr

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 in /usr/share/d3-flame-graph/template.html and fill in the collected stacks.

Quoted 8 lines

Usage:

perf script flamegraph -a -F 99 sleep 60

Alternative usage:

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

nice, could this output the output file, like:

     # perf script report flamegraph --output krava.html
     dumping data to krava.html

or something in that sense

other than that it looks good to me

thanks,
jirka

Quoted 170 lines
Cc Peter Zijlstra <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Mark Rutland <[email protected]>
Cc Alexander Shishkin <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>

---

I'm currently preparing packages for d3-flame-graph. For Fedora, the copr at
https://copr.fedorainfracloud.org/coprs/agerstmayr/reviews/package/js-d3-flame-graph/
can be installed, or alternatively the prebuilt standalone d3-flame-graph template can be downloaded from
https://raw.githubusercontent.com/andreasgerstmayr/specs/master/reviews/js-d3-flame-graph/template.html
and moved into /usr/share/d3-flame-graph/template.html

 .../perf/scripts/python/bin/flamegraph-record |   2 +
 .../perf/scripts/python/bin/flamegraph-report |   3 +
 tools/perf/scripts/python/flamegraph.py       | 117 ++++++++++++++++++
 3 files changed, 122 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
tools/perf/scripts/python/bin/flamegraph-record new file +2 -0
new file mode 100755
index 000000000000..725d66e71570
@@ -0,0 +1,2 @@
+#!/usr/bin/sh
+perf record -g "$@"
tools/perf/scripts/python/bin/flamegraph-report new file +3 -0
new file mode 100755
index 000000000000..b1a79afd903b
@@ -0,0 +1,3 @@
+#!/usr/bin/sh
+# description: create flame graphs
+perf script -s "$PERF_EXEC_PATH"/scripts/python/flamegraph.py -- "$@"
tools/perf/scripts/python/flamegraph.py new file +117 -0
new file mode 100755
index 000000000000..2e9139ef2c4a
@@ -0,0 +1,117 @@
+# 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 data collection and flamegraph generation:
+#
+#  perf script flamegraph -a -F 99 sleep 60
+#
+# Written by Andreas Gerstmayr <[email protected]>
+# Flame Graphs invented by Brendan Gregg <[email protected]>
+# Works in tandem with d3-flame-graph by Martin Spier <[email protected]>
+
+import sys
+import os
+import argparse
+import json
+
+
+class Node:
+    def __init__(self, name, libtype=""):
+        self.name = name
+        self.libtype = libtype
+        self.value = 0
+        self.children = []
+
+
+class FlameGraphCLI:
+    def __init__(self, args):
+        self.args = args
+        self.stack = Node("root")
+
+        if self.args.format == "html" and \
+                not os.path.isfile(self.args.template):
+            print(f"Flame Graph template '{self.args.template}' does not " +
+                  f"exist. Please install the d3-flame-graph package, " +
+                  f"specify an existing flame graph template " +
+                  f"(--template PATH) or another output format " +
+                  f"(--format FORMAT).", file=sys.stderr)
+            sys.exit(1)
+
+    def find_or_create_node(self, node, name, dso):
+        libtype = "kernel" if dso == "[kernel.kallsyms]" else ""
+        if name is None:
+            name = "[unknown]"
+
+        for child in node.children:
+            if child.name == name and child.libtype == libtype:
+                return child
+
+        child = Node(name, libtype)
+        node.children.append(child)
+        return child
+
+    def process_event(self, event):
+        node = self.find_or_create_node(self.stack, event["comm"], None)
+        if "callchain" in event:
+            for entry in reversed(event['callchain']):
+                node = self.find_or_create_node(
+                    node, entry.get("sym", {}).get("name"), event.get("dso"))
+        else:
+            node = self.find_or_create_node(
+                node, entry.get("symbol"), event.get("dso"))
+        node.value += 1
+
+    def trace_end(self):
+        def encoder(x): return x.__dict__
+        json_str = json.dumps(self.stack, default=encoder,
+                              indent=self.args.indent)
+
+        if self.args.format == "html":
+            try:
+                with open(self.args.template) as f:
+                    output_str = f.read().replace("/** @flamegraph_params **/",
+                                                  json_str)
+            except IOError as e:
+                print(f"Error reading template file: {e}", file=sys.stderr)
+                sys.exit(1)
+            output_fn = self.args.output or "flamegraph.html"
+        else:
+            output_str = json_str
+            output_fn = self.args.output or "stacks.json"
+
+        if output_fn == "-":
+            sys.stdout.write(output_str)
+        else:
+            try:
+                with open(output_fn, "w") as out:
+                    out.write(output_str)
+            except IOError as e:
+                print(f"Error writing output file: {e}", file=sys.stderr)
+                sys.exit(1)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Create flame graphs.")
+    parser.add_argument("-F", "--format",
+                        default="html", choices=["json", "html"],
+                        help="output file format")
+    parser.add_argument("-o", "--output",
+                        help="output file name")
+    parser.add_argument("--indent",
+                        type=int, help="JSON indentation")
+    parser.add_argument("--template",
+                        default="/usr/share/d3-flame-graph/template.html",
+                        help="path to flamegraph HTML template")
+    parser.add_argument("-i", "--input",
+                        help=argparse.SUPPRESS)
+
+    args = parser.parse_args()
+    cli = FlameGraphCLI(args)
+
+    process_event = cli.process_event
+    trace_end = cli.trace_end
Signature · 1 line
2.24.1
#2 lore raw
Quoted 15 lines · Jiri Olsa
Quoted 5 lines · Andreas Gerstmayr

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 in /usr/share/d3-flame-graph/template.html and fill in the collected stacks.

Quoted 8 lines

Usage:

perf script flamegraph -a -F 99 sleep 60

Alternative usage:

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

Quoted 8 lines

nice, could this output the output file, like:

      # perf script report flamegraph --output krava.html
      dumping data to krava.html

or something in that sense

other than that it looks good to me

Yes, it's already implemented.

$ perf script report flamegraph --output krava.html

writes the output to krava.html

$ perf script report flamegraph --help

shows the supported arguments.

The only gotcha is that you need to have a perf.data in the same directory when calling this command, otherwise perf complains about a missing perf.data and doesn't call the flamegraph.py script.

Cheers,
Andreas

Quoted 176 lines

thanks,
jirka

Quoted 170 lines
Cc Peter Zijlstra <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Mark Rutland <[email protected]>
Cc Alexander Shishkin <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>

---

I'm currently preparing packages for d3-flame-graph. For Fedora, the copr at
https://copr.fedorainfracloud.org/coprs/agerstmayr/reviews/package/js-d3-flame-graph/
can be installed, or alternatively the prebuilt standalone d3-flame-graph template can be downloaded from
https://raw.githubusercontent.com/andreasgerstmayr/specs/master/reviews/js-d3-flame-graph/template.html
and moved into /usr/share/d3-flame-graph/template.html

  .../perf/scripts/python/bin/flamegraph-record |   2 +
  .../perf/scripts/python/bin/flamegraph-report |   3 +
  tools/perf/scripts/python/flamegraph.py       | 117 ++++++++++++++++++
  3 files changed, 122 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

tools/perf/scripts/python/bin/flamegraph-record new file +2 -0
new file mode 100755
index 000000000000..725d66e71570
@@ -0,0 +1,2 @@
+#!/usr/bin/sh
+perf record -g "$@"
tools/perf/scripts/python/bin/flamegraph-report new file +3 -0
new file mode 100755
index 000000000000..b1a79afd903b
@@ -0,0 +1,3 @@
+#!/usr/bin/sh
+# description: create flame graphs
+perf script -s "$PERF_EXEC_PATH"/scripts/python/flamegraph.py -- "$@"
tools/perf/scripts/python/flamegraph.py new file +117 -0
new file mode 100755
index 000000000000..2e9139ef2c4a
@@ -0,0 +1,117 @@
+# 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 data collection and flamegraph generation:
+#
+#  perf script flamegraph -a -F 99 sleep 60
+#
+# Written by Andreas Gerstmayr <[email protected]>
+# Flame Graphs invented by Brendan Gregg <[email protected]>
+# Works in tandem with d3-flame-graph by Martin Spier <[email protected]>
+
+import sys
+import os
+import argparse
+import json
+
+
+class Node:
+    def __init__(self, name, libtype=""):
+        self.name = name
+        self.libtype = libtype
+        self.value = 0
+        self.children = []
+
+
+class FlameGraphCLI:
+    def __init__(self, args):
+        self.args = args
+        self.stack = Node("root")
+
+        if self.args.format == "html" and \
+                not os.path.isfile(self.args.template):
+            print(f"Flame Graph template '{self.args.template}' does not " +
+                  f"exist. Please install the d3-flame-graph package, " +
+                  f"specify an existing flame graph template " +
+                  f"(--template PATH) or another output format " +
+                  f"(--format FORMAT).", file=sys.stderr)
+            sys.exit(1)
+
+    def find_or_create_node(self, node, name, dso):
+        libtype = "kernel" if dso == "[kernel.kallsyms]" else ""
+        if name is None:
+            name = "[unknown]"
+
+        for child in node.children:
+            if child.name == name and child.libtype == libtype:
+                return child
+
+        child = Node(name, libtype)
+        node.children.append(child)
+        return child
+
+    def process_event(self, event):
+        node = self.find_or_create_node(self.stack, event["comm"], None)
+        if "callchain" in event:
+            for entry in reversed(event['callchain']):
+                node = self.find_or_create_node(
+                    node, entry.get("sym", {}).get("name"), event.get("dso"))
+        else:
+            node = self.find_or_create_node(
+                node, entry.get("symbol"), event.get("dso"))
+        node.value += 1
+
+    def trace_end(self):
+        def encoder(x): return x.__dict__
+        json_str = json.dumps(self.stack, default=encoder,
+                              indent=self.args.indent)
+
+        if self.args.format == "html":
+            try:
+                with open(self.args.template) as f:
+                    output_str = f.read().replace("/** @flamegraph_params **/",
+                                                  json_str)
+            except IOError as e:
+                print(f"Error reading template file: {e}", file=sys.stderr)
+                sys.exit(1)
+            output_fn = self.args.output or "flamegraph.html"
+        else:
+            output_str = json_str
+            output_fn = self.args.output or "stacks.json"
+
+        if output_fn == "-":
+            sys.stdout.write(output_str)
+        else:
+            try:
+                with open(output_fn, "w") as out:
+                    out.write(output_str)
+            except IOError as e:
+                print(f"Error writing output file: {e}", file=sys.stderr)
+                sys.exit(1)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Create flame graphs.")
+    parser.add_argument("-F", "--format",
+                        default="html", choices=["json", "html"],
+                        help="output file format")
+    parser.add_argument("-o", "--output",
+                        help="output file name")
+    parser.add_argument("--indent",
+                        type=int, help="JSON indentation")
+    parser.add_argument("--template",
+                        default="/usr/share/d3-flame-graph/template.html",
+                        help="path to flamegraph HTML template")
+    parser.add_argument("-i", "--input",
+                        help=argparse.SUPPRESS)
+
+    args = parser.parse_args()
+    cli = FlameGraphCLI(args)
+
+    process_event = cli.process_event
+    trace_end = cli.trace_end
Signature · 1 line
2.24.1
#3 lore raw
Quoted 13 lines · Andreas Gerstmayr
Quoted 12 lines · Jiri Olsa
Quoted 11 lines · Andreas Gerstmayr

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 in /usr/share/d3-flame-graph/template.html and fill in the collected stacks.

Usage:

perf script flamegraph -a -F 99 sleep 60

Alternative usage:

Quoted 7 lines
Quoted 7 lines
Quoted 2 lines

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

nice, could this output the output file, like:

      # perf script report flamegraph --output krava.html
      dumping data to krava.html

I meant the actual line ^^^^, saying that it's writing to the file

thanks,
jirka

Quoted 201 lines
Quoted 4 lines

or something in that sense

other than that it looks good to me

Yes, it's already implemented.

$ perf script report flamegraph --output krava.html

writes the output to krava.html

$ perf script report flamegraph --help

shows the supported arguments.

The only gotcha is that you need to have a perf.data in the same directory when calling this command, otherwise perf complains about a missing perf.data and doesn't call the flamegraph.py script.

Cheers,
Andreas

Quoted 176 lines

thanks,
jirka

Quoted 170 lines
Cc Peter Zijlstra <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Mark Rutland <[email protected]>
Cc Alexander Shishkin <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>

---

I'm currently preparing packages for d3-flame-graph. For Fedora, the copr at
https://copr.fedorainfracloud.org/coprs/agerstmayr/reviews/package/js-d3-flame-graph/
can be installed, or alternatively the prebuilt standalone d3-flame-graph template can be downloaded from
https://raw.githubusercontent.com/andreasgerstmayr/specs/master/reviews/js-d3-flame-graph/template.html
and moved into /usr/share/d3-flame-graph/template.html

  .../perf/scripts/python/bin/flamegraph-record |   2 +
  .../perf/scripts/python/bin/flamegraph-report |   3 +
  tools/perf/scripts/python/flamegraph.py       | 117 ++++++++++++++++++
  3 files changed, 122 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

tools/perf/scripts/python/bin/flamegraph-record new file +2 -0
new file mode 100755
index 000000000000..725d66e71570
@@ -0,0 +1,2 @@
+#!/usr/bin/sh
+perf record -g "$@"
tools/perf/scripts/python/bin/flamegraph-report new file +3 -0
new file mode 100755
index 000000000000..b1a79afd903b
@@ -0,0 +1,3 @@
+#!/usr/bin/sh
+# description: create flame graphs
+perf script -s "$PERF_EXEC_PATH"/scripts/python/flamegraph.py -- "$@"
tools/perf/scripts/python/flamegraph.py new file +117 -0
new file mode 100755
index 000000000000..2e9139ef2c4a
@@ -0,0 +1,117 @@
+# 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 data collection and flamegraph generation:
+#
+#  perf script flamegraph -a -F 99 sleep 60
+#
+# Written by Andreas Gerstmayr <[email protected]>
+# Flame Graphs invented by Brendan Gregg <[email protected]>
+# Works in tandem with d3-flame-graph by Martin Spier <[email protected]>
+
+import sys
+import os
+import argparse
+import json
+
+
+class Node:
+    def __init__(self, name, libtype=""):
+        self.name = name
+        self.libtype = libtype
+        self.value = 0
+        self.children = []
+
+
+class FlameGraphCLI:
+    def __init__(self, args):
+        self.args = args
+        self.stack = Node("root")
+
+        if self.args.format == "html" and \
+                not os.path.isfile(self.args.template):
+            print(f"Flame Graph template '{self.args.template}' does not " +
+                  f"exist. Please install the d3-flame-graph package, " +
+                  f"specify an existing flame graph template " +
+                  f"(--template PATH) or another output format " +
+                  f"(--format FORMAT).", file=sys.stderr)
+            sys.exit(1)
+
+    def find_or_create_node(self, node, name, dso):
+        libtype = "kernel" if dso == "[kernel.kallsyms]" else ""
+        if name is None:
+            name = "[unknown]"
+
+        for child in node.children:
+            if child.name == name and child.libtype == libtype:
+                return child
+
+        child = Node(name, libtype)
+        node.children.append(child)
+        return child
+
+    def process_event(self, event):
+        node = self.find_or_create_node(self.stack, event["comm"], None)
+        if "callchain" in event:
+            for entry in reversed(event['callchain']):
+                node = self.find_or_create_node(
+                    node, entry.get("sym", {}).get("name"), event.get("dso"))
+        else:
+            node = self.find_or_create_node(
+                node, entry.get("symbol"), event.get("dso"))
+        node.value += 1
+
+    def trace_end(self):
+        def encoder(x): return x.__dict__
+        json_str = json.dumps(self.stack, default=encoder,
+                              indent=self.args.indent)
+
+        if self.args.format == "html":
+            try:
+                with open(self.args.template) as f:
+                    output_str = f.read().replace("/** @flamegraph_params **/",
+                                                  json_str)
+            except IOError as e:
+                print(f"Error reading template file: {e}", file=sys.stderr)
+                sys.exit(1)
+            output_fn = self.args.output or "flamegraph.html"
+        else:
+            output_str = json_str
+            output_fn = self.args.output or "stacks.json"
+
+        if output_fn == "-":
+            sys.stdout.write(output_str)
+        else:
+            try:
+                with open(output_fn, "w") as out:
+                    out.write(output_str)
+            except IOError as e:
+                print(f"Error writing output file: {e}", file=sys.stderr)
+                sys.exit(1)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Create flame graphs.")
+    parser.add_argument("-F", "--format",
+                        default="html", choices=["json", "html"],
+                        help="output file format")
+    parser.add_argument("-o", "--output",
+                        help="output file name")
+    parser.add_argument("--indent",
+                        type=int, help="JSON indentation")
+    parser.add_argument("--template",
+                        default="/usr/share/d3-flame-graph/template.html",
+                        help="path to flamegraph HTML template")
+    parser.add_argument("-i", "--input",
+                        help=argparse.SUPPRESS)
+
+    args = parser.parse_args()
+    cli = FlameGraphCLI(args)
+
+    process_event = cli.process_event
+    trace_end = cli.trace_end
Signature · 1 line
2.24.1
#4 lore raw
Quoted 17 lines · Jiri Olsa
Quoted 16 lines · Andreas Gerstmayr
Quoted 15 lines · Jiri Olsa
Quoted 13 lines · Andreas Gerstmayr

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 in /usr/share/d3-flame-graph/template.html and fill in the collected stacks.

Usage:

perf script flamegraph -a -F 99 sleep 60

Alternative usage:

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

Quoted 6 lines
Quoted 4 lines
Quoted 4 lines

nice, could this output the output file, like:

       # perf script report flamegraph --output krava.html
       dumping data to krava.html

I meant the actual line ^^^^, saying that it's writing to the file

Ah! Sorry, I misunderstood.
Yep, sure, I can add that.

I also have one other change lined up to reduce the JSON output, and I'm testing it with huge flamegraphs right now. Will send an update this week.

Cheers,
Andreas

Quoted 206 lines

thanks,
jirka

Quoted 201 lines
Quoted 4 lines

or something in that sense

other than that it looks good to me

Yes, it's already implemented.

$ perf script report flamegraph --output krava.html

writes the output to krava.html

$ perf script report flamegraph --help

shows the supported arguments.

The only gotcha is that you need to have a perf.data in the same directory when calling this command, otherwise perf complains about a missing perf.data and doesn't call the flamegraph.py script.

Cheers,
Andreas

Quoted 176 lines

thanks,
jirka

Quoted 170 lines
Cc Peter Zijlstra <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Mark Rutland <[email protected]>
Cc Alexander Shishkin <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>

---

I'm currently preparing packages for d3-flame-graph. For Fedora, the copr at
https://copr.fedorainfracloud.org/coprs/agerstmayr/reviews/package/js-d3-flame-graph/
can be installed, or alternatively the prebuilt standalone d3-flame-graph template can be downloaded from
https://raw.githubusercontent.com/andreasgerstmayr/specs/master/reviews/js-d3-flame-graph/template.html
and moved into /usr/share/d3-flame-graph/template.html

   .../perf/scripts/python/bin/flamegraph-record |   2 +
   .../perf/scripts/python/bin/flamegraph-report |   3 +
   tools/perf/scripts/python/flamegraph.py       | 117 ++++++++++++++++++
   3 files changed, 122 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

tools/perf/scripts/python/bin/flamegraph-record new file +2 -0
new file mode 100755
index 000000000000..725d66e71570
@@ -0,0 +1,2 @@
+#!/usr/bin/sh
+perf record -g "$@"
tools/perf/scripts/python/bin/flamegraph-report new file +3 -0
new file mode 100755
index 000000000000..b1a79afd903b
@@ -0,0 +1,3 @@
+#!/usr/bin/sh
+# description: create flame graphs
+perf script -s "$PERF_EXEC_PATH"/scripts/python/flamegraph.py -- "$@"
tools/perf/scripts/python/flamegraph.py new file +117 -0
new file mode 100755
index 000000000000..2e9139ef2c4a
@@ -0,0 +1,117 @@
+# 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 data collection and flamegraph generation:
+#
+#  perf script flamegraph -a -F 99 sleep 60
+#
+# Written by Andreas Gerstmayr <[email protected]>
+# Flame Graphs invented by Brendan Gregg <[email protected]>
+# Works in tandem with d3-flame-graph by Martin Spier <[email protected]>
+
+import sys
+import os
+import argparse
+import json
+
+
+class Node:
+    def __init__(self, name, libtype=""):
+        self.name = name
+        self.libtype = libtype
+        self.value = 0
+        self.children = []
+
+
+class FlameGraphCLI:
+    def __init__(self, args):
+        self.args = args
+        self.stack = Node("root")
+
+        if self.args.format == "html" and \
+                not os.path.isfile(self.args.template):
+            print(f"Flame Graph template '{self.args.template}' does not " +
+                  f"exist. Please install the d3-flame-graph package, " +
+                  f"specify an existing flame graph template " +
+                  f"(--template PATH) or another output format " +
+                  f"(--format FORMAT).", file=sys.stderr)
+            sys.exit(1)
+
+    def find_or_create_node(self, node, name, dso):
+        libtype = "kernel" if dso == "[kernel.kallsyms]" else ""
+        if name is None:
+            name = "[unknown]"
+
+        for child in node.children:
+            if child.name == name and child.libtype == libtype:
+                return child
+
+        child = Node(name, libtype)
+        node.children.append(child)
+        return child
+
+    def process_event(self, event):
+        node = self.find_or_create_node(self.stack, event["comm"], None)
+        if "callchain" in event:
+            for entry in reversed(event['callchain']):
+                node = self.find_or_create_node(
+                    node, entry.get("sym", {}).get("name"), event.get("dso"))
+        else:
+            node = self.find_or_create_node(
+                node, entry.get("symbol"), event.get("dso"))
+        node.value += 1
+
+    def trace_end(self):
+        def encoder(x): return x.__dict__
+        json_str = json.dumps(self.stack, default=encoder,
+                              indent=self.args.indent)
+
+        if self.args.format == "html":
+            try:
+                with open(self.args.template) as f:
+                    output_str = f.read().replace("/** @flamegraph_params **/",
+                                                  json_str)
+            except IOError as e:
+                print(f"Error reading template file: {e}", file=sys.stderr)
+                sys.exit(1)
+            output_fn = self.args.output or "flamegraph.html"
+        else:
+            output_str = json_str
+            output_fn = self.args.output or "stacks.json"
+
+        if output_fn == "-":
+            sys.stdout.write(output_str)
+        else:
+            try:
+                with open(output_fn, "w") as out:
+                    out.write(output_str)
+            except IOError as e:
+                print(f"Error writing output file: {e}", file=sys.stderr)
+                sys.exit(1)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Create flame graphs.")
+    parser.add_argument("-F", "--format",
+                        default="html", choices=["json", "html"],
+                        help="output file format")
+    parser.add_argument("-o", "--output",
+                        help="output file name")
+    parser.add_argument("--indent",
+                        type=int, help="JSON indentation")
+    parser.add_argument("--template",
+                        default="/usr/share/d3-flame-graph/template.html",
+                        help="path to flamegraph HTML template")
+    parser.add_argument("-i", "--input",
+                        help=argparse.SUPPRESS)
+
+    args = parser.parse_args()
+    cli = FlameGraphCLI(args)
+
+    process_event = cli.process_event
+    trace_end = cli.trace_end
Signature · 1 line
2.24.1
#5 lore raw
Quoted 18 lines · Andreas Gerstmayr
Quoted 17 lines · Jiri Olsa
Quoted 15 lines · Andreas Gerstmayr
Quoted 14 lines · Jiri Olsa
Quoted 8 lines · Andreas Gerstmayr

Usage:

      perf script flamegraph -a -F 99 sleep 60

Alternative usage:

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

nice, could this output the output file, like:

       # perf script report flamegraph --output krava.html
       dumping data to krava.html
Quoted 6 lines
Quoted 1 line

I meant the actual line ^^^^, saying that it's writing to the file

Ah! Sorry, I misunderstood.
Yep, sure, I can add that.

I also have one other change lined up to reduce the JSON output, and I'm testing it with huge flamegraphs right now. Will send an update this week.

Ok, I'll need some more time to properly test this with huge flame graphs and different browsers. I'll get back to this in ~2 weeks after my PTO.

Cheers,
Andreas

Quoted 225 lines

Cheers,
Andreas

Quoted 219 lines

thanks,
jirka

Quoted 214 lines
Quoted 4 lines

or something in that sense

other than that it looks good to me

Yes, it's already implemented.

$ perf script report flamegraph --output krava.html

writes the output to krava.html

$ perf script report flamegraph --help

shows the supported arguments.

The only gotcha is that you need to have a perf.data in the same directory when calling this command, otherwise perf complains about a missing perf.data and doesn't call the flamegraph.py script.

Cheers,
Andreas

Quoted 189 lines

thanks,
jirka

Quoted 183 lines
Cc Peter Zijlstra <[email protected]>
Cc Ingo Molnar <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Mark Rutland <[email protected]>
Cc Alexander Shishkin <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>

---

I'm currently preparing packages for d3-flame-graph. For Fedora, the copr at
https://copr.fedorainfracloud.org/coprs/agerstmayr/reviews/package/js-d3-flame-graph/

can be installed, or alternatively the prebuilt standalone d3-flame-graph template can be downloaded from
https://raw.githubusercontent.com/andreasgerstmayr/specs/master/reviews/js-d3-flame-graph/template.html

and moved into /usr/share/d3-flame-graph/template.html

   .../perf/scripts/python/bin/flamegraph-record |   2 + .../perf/scripts/python/bin/flamegraph-report |   3 + tools/perf/scripts/python/flamegraph.py       | 117
++++++++++++++++++

   3 files changed, 122 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

tools/perf/scripts/python/bin/flamegraph-record new file +2 -0
new file mode 100755
index 000000000000..725d66e71570
@@ -0,0 +1,2 @@
+#!/usr/bin/sh
+perf record -g "$@"
tools/perf/scripts/python/bin/flamegraph-report new file +3 -0
new file mode 100755
index 000000000000..b1a79afd903b
@@ -0,0 +1,3 @@
+#!/usr/bin/sh
+# description: create flame graphs
+perf script -s "$PERF_EXEC_PATH"/scripts/python/flamegraph.py -- "$@"
tools/perf/scripts/python/flamegraph.py new file +15 -0
new file mode 100755
index 000000000000..2e9139ef2c4a
@@ -0,0 +1,117 @@
+# 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 data collection and flamegraph generation:
+#
+#  perf script flamegraph -a -F 99 sleep 60
+#
+# Written by Andreas Gerstmayr <[email protected]>
+# Flame Graphs invented by Brendan Gregg <[email protected]>
+# Works in tandem with d3-flame-graph by Martin Spier 

<[email protected]>

tools/perf/scripts/python/flamegraph.py new file +23 -0
+
+import sys
+import os
+import argparse
+import json
+
+
+class Node:
+    def __init__(self, name, libtype=""):
+        self.name = name
+        self.libtype = libtype
+        self.value = 0
+        self.children = []
+
+
+class FlameGraphCLI:
+    def __init__(self, args):
+        self.args = args
+        self.stack = Node("root")
+
+        if self.args.format == "html" and \
+                not os.path.isfile(self.args.template):
+            print(f"Flame Graph template '{self.args.template}' 

does not " +
+                  f"exist. Please install the d3-flame-graph package, " +
+                  f"specify an existing flame graph template " + +                  f"(--template PATH) or another output format " + +                  f"(--format FORMAT).", file=sys.stderr) +            sys.exit(1)

tools/perf/scripts/python/flamegraph.py new file +16 -0
+
+    def find_or_create_node(self, node, name, dso):
+        libtype = "kernel" if dso == "[kernel.kallsyms]" else ""
+        if name is None:
+            name = "[unknown]"
+
+        for child in node.children:
+            if child.name == name and child.libtype == libtype:
+                return child
+
+        child = Node(name, libtype)
+        node.children.append(child)
+        return child
+
+    def process_event(self, event):
+        node = self.find_or_create_node(self.stack, event["comm"], 

None)
+        if "callchain" in event:
+            for entry in reversed(event['callchain']):
+                node = self.find_or_create_node(
+                    node, entry.get("sym", {}).get("name"), event.get("dso"))
+        else:
+            node = self.find_or_create_node(
+                node, entry.get("symbol"), event.get("dso")) +        node.value += 1

tools/perf/scripts/python/flamegraph.py new file +10 -0
+
+    def trace_end(self):
+        def encoder(x): return x.__dict__
+        json_str = json.dumps(self.stack, default=encoder,
+                              indent=self.args.indent)
+
+        if self.args.format == "html":
+            try:
+                with open(self.args.template) as f:
+                    output_str = f.read().replace("/** 

@flamegraph_params **/",
+                                                  json_str) +            except IOError as e:
+                print(f"Error reading template file: {e}", file=sys.stderr)
+                sys.exit(1)
+            output_fn = self.args.output or "flamegraph.html" +        else:
+            output_str = json_str
+            output_fn = self.args.output or "stacks.json" +
+        if output_fn == "-":
+            sys.stdout.write(output_str)
+        else:
+            try:
+                with open(output_fn, "w") as out:
+                    out.write(output_str)
+            except IOError as e:
+                print(f"Error writing output file: {e}", file=sys.stderr)
+                sys.exit(1)

tools/perf/scripts/python/flamegraph.py new file +4 -0
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Create flame 

graphs.")
+    parser.add_argument("-F", "--format",
+                        default="html", choices=["json", "html"], +                        help="output file format")
+    parser.add_argument("-o", "--output",
+                        help="output file name")
+    parser.add_argument("--indent",
+                        type=int, help="JSON indentation") +    parser.add_argument("--template",
+
default="/usr/share/d3-flame-graph/template.html",
+                        help="path to flamegraph HTML template") +    parser.add_argument("-i", "--input",
+                        help=argparse.SUPPRESS)

tools/perf/scripts/python/flamegraph.py new file +6 -0
+
+    args = parser.parse_args()
+    cli = FlameGraphCLI(args)
+
+    process_event = cli.process_event
+    trace_end = cli.trace_end
Signature · 1 line
2.24.1