2020-03-20 15:13:48 +00:00
|
|
|
# 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.com>
|
2021-08-30 16:47:27 +00:00
|
|
|
#
|
|
|
|
|
# pylint: disable=missing-module-docstring
|
|
|
|
|
# pylint: disable=missing-class-docstring
|
|
|
|
|
# pylint: disable=missing-function-docstring
|
2020-03-20 15:13:48 +00:00
|
|
|
|
|
|
|
|
import argparse
|
2023-01-18 07:24:09 +00:00
|
|
|
import hashlib
|
|
|
|
|
import io
|
2020-03-20 15:13:48 +00:00
|
|
|
import json
|
2023-01-18 07:24:09 +00:00
|
|
|
import os
|
2021-08-30 16:47:27 +00:00
|
|
|
import subprocess
|
2023-01-18 07:24:09 +00:00
|
|
|
import sys
|
2025-07-16 00:46:35 +00:00
|
|
|
from typing import Dict, Optional, Union
|
2023-01-18 07:24:09 +00:00
|
|
|
import urllib.request
|
|
|
|
|
|
2025-07-16 00:46:35 +00:00
|
|
|
MINIMAL_HTML = """<head>
|
2023-01-18 07:24:09 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/d3-flame-graph@4.1.3/dist/d3-flamegraph.css">
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div id="chart"></div>
|
|
|
|
|
<script type="text/javascript" src="https://d3js.org/d3.v7.js"></script>
|
|
|
|
|
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/d3-flame-graph@4.1.3/dist/d3-flamegraph.min.js"></script>
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
const stacks = [/** @flamegraph_json **/];
|
|
|
|
|
// Note, options is unused.
|
|
|
|
|
const options = [/** @options_json **/];
|
|
|
|
|
|
|
|
|
|
var chart = flamegraph();
|
|
|
|
|
d3.select("#chart")
|
|
|
|
|
.datum(stacks[0])
|
|
|
|
|
.call(chart);
|
|
|
|
|
</script>
|
|
|
|
|
</body>
|
|
|
|
|
"""
|
2020-03-20 15:13:48 +00:00
|
|
|
|
2021-08-30 16:47:27 +00:00
|
|
|
# pylint: disable=too-few-public-methods
|
2020-03-20 15:13:48 +00:00
|
|
|
class Node:
|
2025-07-16 00:46:35 +00:00
|
|
|
def __init__(self, name: str, libtype: str):
|
2020-03-20 15:13:48 +00:00
|
|
|
self.name = name
|
2021-08-30 16:47:27 +00:00
|
|
|
# "root" | "kernel" | ""
|
|
|
|
|
# "" indicates user space
|
2020-03-20 15:13:48 +00:00
|
|
|
self.libtype = libtype
|
2025-07-16 00:46:35 +00:00
|
|
|
self.value: int = 0
|
|
|
|
|
self.children: list[Node] = []
|
2020-03-20 15:13:48 +00:00
|
|
|
|
2025-07-16 00:46:35 +00:00
|
|
|
def to_json(self) -> Dict[str, Union[str, int, list[Dict]]]:
|
2020-03-20 15:13:48 +00:00
|
|
|
return {
|
|
|
|
|
"n": self.name,
|
|
|
|
|
"l": self.libtype,
|
|
|
|
|
"v": self.value,
|
2025-07-16 00:46:35 +00:00
|
|
|
"c": [x.to_json() for x in self.children]
|
2020-03-20 15:13:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class FlameGraphCLI:
|
|
|
|
|
def __init__(self, args):
|
|
|
|
|
self.args = args
|
2021-08-30 16:47:27 +00:00
|
|
|
self.stack = Node("all", "root")
|
2020-03-20 15:13:48 +00:00
|
|
|
|
2021-08-30 16:47:27 +00:00
|
|
|
@staticmethod
|
2025-07-16 00:46:35 +00:00
|
|
|
def get_libtype_from_dso(dso: Optional[str]) -> str:
|
2021-08-30 16:47:27 +00:00
|
|
|
"""
|
|
|
|
|
when kernel-debuginfo is installed,
|
|
|
|
|
dso points to /usr/lib/debug/lib/modules/*/vmlinux
|
|
|
|
|
"""
|
|
|
|
|
if dso and (dso == "[kernel.kallsyms]" or dso.endswith("/vmlinux")):
|
|
|
|
|
return "kernel"
|
2020-03-20 15:13:48 +00:00
|
|
|
|
2021-08-30 16:47:27 +00:00
|
|
|
return ""
|
|
|
|
|
|
|
|
|
|
@staticmethod
|
2025-07-16 00:46:35 +00:00
|
|
|
def find_or_create_node(node: Node, name: str, libtype: str) -> Node:
|
2020-03-20 15:13:48 +00:00
|
|
|
for child in node.children:
|
2021-08-30 16:47:27 +00:00
|
|
|
if child.name == name:
|
2020-03-20 15:13:48 +00:00
|
|
|
return child
|
|
|
|
|
|
|
|
|
|
child = Node(name, libtype)
|
|
|
|
|
node.children.append(child)
|
|
|
|
|
return child
|
|
|
|
|
|
2025-07-16 00:46:35 +00:00
|
|
|
def process_event(self, event) -> None:
|
2025-06-10 04:04:23 +00:00
|
|
|
# ignore events where the event name does not match
|
|
|
|
|
# the one specified by the user
|
|
|
|
|
if self.args.event_name and event.get("ev_name") != self.args.event_name:
|
|
|
|
|
return
|
|
|
|
|
|
2021-08-30 16:47:27 +00:00
|
|
|
pid = event.get("sample", {}).get("pid", 0)
|
|
|
|
|
# event["dso"] sometimes contains /usr/lib/debug/lib/modules/*/vmlinux
|
|
|
|
|
# for user-space processes; let's use pid for kernel or user-space distinction
|
|
|
|
|
if pid == 0:
|
|
|
|
|
comm = event["comm"]
|
|
|
|
|
libtype = "kernel"
|
|
|
|
|
else:
|
2025-07-16 00:46:35 +00:00
|
|
|
comm = f"{event['comm']} ({pid})"
|
2021-08-30 16:47:27 +00:00
|
|
|
libtype = ""
|
|
|
|
|
node = self.find_or_create_node(self.stack, comm, libtype)
|
|
|
|
|
|
2020-03-20 15:13:48 +00:00
|
|
|
if "callchain" in event:
|
2021-08-30 16:47:27 +00:00
|
|
|
for entry in reversed(event["callchain"]):
|
|
|
|
|
name = entry.get("sym", {}).get("name", "[unknown]")
|
|
|
|
|
libtype = self.get_libtype_from_dso(entry.get("dso"))
|
|
|
|
|
node = self.find_or_create_node(node, name, libtype)
|
2020-03-20 15:13:48 +00:00
|
|
|
else:
|
2021-08-30 16:47:27 +00:00
|
|
|
name = event.get("symbol", "[unknown]")
|
|
|
|
|
libtype = self.get_libtype_from_dso(event.get("dso"))
|
|
|
|
|
node = self.find_or_create_node(node, name, libtype)
|
2020-03-20 15:13:48 +00:00
|
|
|
node.value += 1
|
|
|
|
|
|
2025-07-16 00:46:35 +00:00
|
|
|
def get_report_header(self) -> str:
|
2021-08-30 16:47:27 +00:00
|
|
|
if self.args.input == "-":
|
|
|
|
|
# when this script is invoked with "perf script flamegraph",
|
|
|
|
|
# no perf.data is created and we cannot read the header of it
|
|
|
|
|
return ""
|
|
|
|
|
|
|
|
|
|
try:
|
2025-06-10 04:04:22 +00:00
|
|
|
# if the file name other than perf.data is given,
|
|
|
|
|
# we read the header of that file
|
|
|
|
|
if self.args.input:
|
2025-07-16 00:46:35 +00:00
|
|
|
output = subprocess.check_output(["perf", "report", "--header-only",
|
|
|
|
|
"-i", self.args.input])
|
2025-06-10 04:04:22 +00:00
|
|
|
else:
|
|
|
|
|
output = subprocess.check_output(["perf", "report", "--header-only"])
|
|
|
|
|
|
2025-06-10 04:04:23 +00:00
|
|
|
result = output.decode("utf-8")
|
|
|
|
|
if self.args.event_name:
|
|
|
|
|
result += "\nFocused event: " + self.args.event_name
|
|
|
|
|
return result
|
2021-08-30 16:47:27 +00:00
|
|
|
except Exception as err: # pylint: disable=broad-except
|
2025-07-16 00:46:35 +00:00
|
|
|
print(f"Error reading report header: {err}", file=sys.stderr)
|
2021-08-30 16:47:27 +00:00
|
|
|
return ""
|
|
|
|
|
|
2025-07-16 00:46:35 +00:00
|
|
|
def trace_end(self) -> None:
|
2021-08-30 16:47:27 +00:00
|
|
|
stacks_json = json.dumps(self.stack, default=lambda x: x.to_json())
|
2020-03-20 15:13:48 +00:00
|
|
|
|
|
|
|
|
if self.args.format == "html":
|
2021-08-30 16:47:27 +00:00
|
|
|
report_header = self.get_report_header()
|
|
|
|
|
options = {
|
|
|
|
|
"colorscheme": self.args.colorscheme,
|
|
|
|
|
"context": report_header
|
|
|
|
|
}
|
|
|
|
|
options_json = json.dumps(options)
|
|
|
|
|
|
2023-01-18 07:24:09 +00:00
|
|
|
template_md5sum = None
|
|
|
|
|
if self.args.format == "html":
|
|
|
|
|
if os.path.isfile(self.args.template):
|
|
|
|
|
template = f"file://{self.args.template}"
|
|
|
|
|
else:
|
|
|
|
|
if not self.args.allow_download:
|
|
|
|
|
print(f"""Warning: Flame Graph template '{self.args.template}'
|
|
|
|
|
does not exist. To avoid this please install a package such as the
|
|
|
|
|
js-d3-flame-graph or libjs-d3-flame-graph, specify an existing flame
|
|
|
|
|
graph template (--template PATH) or use another output format (--format
|
|
|
|
|
FORMAT).""",
|
|
|
|
|
file=sys.stderr)
|
|
|
|
|
if self.args.input == "-":
|
2025-07-16 00:46:35 +00:00
|
|
|
print(
|
|
|
|
|
"""Not attempting to download Flame Graph template as script command line
|
2023-01-18 07:24:09 +00:00
|
|
|
input is disabled due to using live mode. If you want to download the
|
|
|
|
|
template retry without live mode. For example, use 'perf record -a -g
|
|
|
|
|
-F 99 sleep 60' and 'perf script report flamegraph'. Alternatively,
|
|
|
|
|
download the template from:
|
|
|
|
|
https://cdn.jsdelivr.net/npm/d3-flame-graph@4.1.3/dist/templates/d3-flamegraph-base.html
|
|
|
|
|
and place it at:
|
|
|
|
|
/usr/share/d3-flame-graph/d3-flamegraph-base.html""",
|
|
|
|
|
file=sys.stderr)
|
2025-07-16 00:46:35 +00:00
|
|
|
sys.exit(1)
|
2023-01-18 07:24:09 +00:00
|
|
|
s = None
|
2025-07-16 00:46:35 +00:00
|
|
|
while s not in ["y", "n"]:
|
|
|
|
|
s = input("Do you wish to download a template from cdn.jsdelivr.net?" +
|
|
|
|
|
"(this warning can be suppressed with --allow-download) [yn] "
|
|
|
|
|
).lower()
|
2023-01-18 07:24:09 +00:00
|
|
|
if s == "n":
|
2025-07-16 00:46:35 +00:00
|
|
|
sys.exit(1)
|
|
|
|
|
template = ("https://cdn.jsdelivr.net/npm/d3-flame-graph@4.1.3/dist/templates/"
|
|
|
|
|
"d3-flamegraph-base.html")
|
2023-01-18 07:24:09 +00:00
|
|
|
template_md5sum = "143e0d06ba69b8370b9848dcd6ae3f36"
|
|
|
|
|
|
2020-03-20 15:13:48 +00:00
|
|
|
try:
|
2025-07-16 00:46:35 +00:00
|
|
|
with urllib.request.urlopen(template) as url_template:
|
2023-01-18 07:24:09 +00:00
|
|
|
output_str = "".join([
|
2025-07-16 00:46:35 +00:00
|
|
|
l.decode("utf-8") for l in url_template.readlines()
|
2023-01-18 07:24:09 +00:00
|
|
|
])
|
|
|
|
|
except Exception as err:
|
|
|
|
|
print(f"Error reading template {template}: {err}\n"
|
|
|
|
|
"a minimal flame graph will be generated", file=sys.stderr)
|
2025-07-16 00:46:35 +00:00
|
|
|
output_str = MINIMAL_HTML
|
2023-01-18 07:24:09 +00:00
|
|
|
template_md5sum = None
|
|
|
|
|
|
|
|
|
|
if template_md5sum:
|
|
|
|
|
download_md5sum = hashlib.md5(output_str.encode("utf-8")).hexdigest()
|
|
|
|
|
if download_md5sum != template_md5sum:
|
|
|
|
|
s = None
|
2025-07-16 00:46:35 +00:00
|
|
|
while s not in ["y", "n"]:
|
2023-01-18 07:24:09 +00:00
|
|
|
s = input(f"""Unexpected template md5sum.
|
|
|
|
|
{download_md5sum} != {template_md5sum}, for:
|
|
|
|
|
{output_str}
|
|
|
|
|
continue?[yn] """).lower()
|
|
|
|
|
if s == "n":
|
2025-07-16 00:46:35 +00:00
|
|
|
sys.exit(1)
|
2023-01-18 07:24:09 +00:00
|
|
|
|
|
|
|
|
output_str = output_str.replace("/** @options_json **/", options_json)
|
|
|
|
|
output_str = output_str.replace("/** @flamegraph_json **/", stacks_json)
|
|
|
|
|
|
2020-03-20 15:13:48 +00:00
|
|
|
output_fn = self.args.output or "flamegraph.html"
|
|
|
|
|
else:
|
2021-08-30 16:47:27 +00:00
|
|
|
output_str = stacks_json
|
2020-03-20 15:13:48 +00:00
|
|
|
output_fn = self.args.output or "stacks.json"
|
|
|
|
|
|
|
|
|
|
if output_fn == "-":
|
2020-06-19 15:32:31 +00:00
|
|
|
with io.open(sys.stdout.fileno(), "w", encoding="utf-8", closefd=False) as out:
|
|
|
|
|
out.write(output_str)
|
2020-03-20 15:13:48 +00:00
|
|
|
else:
|
2025-07-16 00:46:35 +00:00
|
|
|
print(f"dumping data to {output_fn}")
|
2020-03-20 15:13:48 +00:00
|
|
|
try:
|
2020-06-19 15:32:31 +00:00
|
|
|
with io.open(output_fn, "w", encoding="utf-8") as out:
|
2020-03-20 15:13:48 +00:00
|
|
|
out.write(output_str)
|
2021-08-30 16:47:27 +00:00
|
|
|
except IOError as err:
|
2025-07-16 00:46:35 +00:00
|
|
|
print(f"Error writing output file: {err}", file=sys.stderr)
|
2020-03-20 15:13:48 +00:00
|
|
|
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("--template",
|
|
|
|
|
default="/usr/share/d3-flame-graph/d3-flamegraph-base.html",
|
2021-08-30 16:47:27 +00:00
|
|
|
help="path to flame graph HTML template")
|
|
|
|
|
parser.add_argument("--colorscheme",
|
|
|
|
|
default="blue-green",
|
|
|
|
|
help="flame graph color scheme",
|
|
|
|
|
choices=["blue-green", "orange"])
|
2020-03-20 15:13:48 +00:00
|
|
|
parser.add_argument("-i", "--input",
|
|
|
|
|
help=argparse.SUPPRESS)
|
2023-01-18 07:24:09 +00:00
|
|
|
parser.add_argument("--allow-download",
|
|
|
|
|
default=False,
|
|
|
|
|
action="store_true",
|
|
|
|
|
help="allow unprompted downloading of HTML template")
|
2025-06-10 04:04:23 +00:00
|
|
|
parser.add_argument("-e", "--event",
|
|
|
|
|
default="",
|
|
|
|
|
dest="event_name",
|
|
|
|
|
type=str,
|
|
|
|
|
help="specify the event to generate flamegraph for")
|
2020-03-20 15:13:48 +00:00
|
|
|
|
2021-08-30 16:47:27 +00:00
|
|
|
cli_args = parser.parse_args()
|
|
|
|
|
cli = FlameGraphCLI(cli_args)
|
2020-03-20 15:13:48 +00:00
|
|
|
|
|
|
|
|
process_event = cli.process_event
|
|
|
|
|
trace_end = cli.trace_end
|
