From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-dl1-f74.google.com (mail-dl1-f74.google.com [74.125.82.74]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DBADD346E50 for ; Thu, 23 Apr 2026 19:44:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.74 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1776973478; cv=none; b=IArTeCVsmGqdlU6397MqTk+almfbIKiM3TXaqY2VtEvhq6rwvZVdjj5GodvWyo8DpAhG0OGK4SJeq8dE2eJ7u8cLFSsDAFEqHO86JDJwiuqD6t3GSOEMMJkhv1OASwNXz+m/k+UBQ9dbqhYtwAG12DT+w+5rEd4oONVpHk4GdLA= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1776973478; c=relaxed/simple; bh=aTJWP2en8u3aj8NVo9rSRz5H6tmLcD8c7RQ3dX5VpXA=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=hBl/k5MVVV2G5UgSgwCabTdtrtORndPulSONhi7+8n0wd5fSpsdF1V1vXuNiADuijYK14CAWWdZtCJOal/YaCEg0FWLpEmOB6rDj+Nl3+yg19SHio5resZZPnubM7BhR0yEJwLiMpJzOjoyCC7JXXqV84POfz9HGWSwuoFM9zuk= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=XrujCb2c; arc=none smtp.client-ip=74.125.82.74 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="XrujCb2c" Received: by mail-dl1-f74.google.com with SMTP id a92af1059eb24-12dc1c0b7ccso615076c88.1 for ; Thu, 23 Apr 2026 12:44:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1776973476; x=1777578276; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=7bLQwsmlqVDpRTAl9gEsW6zXdb8CQSakza6w5XcFux0=; b=XrujCb2cZBSAhca47aqkeUFLom/z/Oa9qf4wohou4YQ68zfQar7KDHuOOEJkszV217 rDNfDfcWjvIJQDl3BU3WsJJWIOKQLbl8YSYcQUgGg91gu64WStYMC3432BpNo71tJsQ8 d4JsE+KLReoWIhLoNMX2gbw0CJZpZrortSWc1Jgj1UkCcODg53Bz1dPlKzLoUN38Xtb5 sVOjieIolc939Wdu265FofoROwKtt4zOBqz+ZVb6YTR6A6qgEBzC2r85IvLEp1BxvzEG B0WtB3DiFUHo0LACQgEy2HvUgcTADrv6MmvuW3Qs5SP0UL4+0/NPbV/afMwEqc724pZ9 7emA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1776973476; x=1777578276; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=7bLQwsmlqVDpRTAl9gEsW6zXdb8CQSakza6w5XcFux0=; b=Cd6QWHBqJR2oatt+7UaUddZMNcHKqtQI6Z37oEPXA/5yp5aritwagiOIMpOtTAf7wL 7ngzirBpgYGtVsZ8a8916empUJk2epvg5AGjPk0MeljY7kNpui2SxSM+DvqPpKlFDXZL PB2G6O2pBzHzSEISvbPH4BgW7UnxJTo8phihSdmXr0LyhGjF5DkIQJ9T2MpiDTtZU5JR cnr8eKFWP/FUeNy6OefVl/ucNO0RFrMhGmZlljRGIcAxT1yZOxkrAmWvjQnfPsBJbRqi bUOd4LLRBZ5q3xTzxeuhvUsr6VZbhltqebMl+/MLhoBo8MjtS+7lE4p19XatTo8Hr+fB XQAg== X-Forwarded-Encrypted: i=1; AFNElJ+DVq03JjXG8pnBIx2EgS3dyh0IsIEue10h/unvPcZyEjD/9nBC2dt0razyRVRosGD9aVGCDA63QUUSXIfJ/sZO@vger.kernel.org X-Gm-Message-State: AOJu0Yyh0P8aZdKEsgpfusSkQb6Z33Z+q28o5ij1tQ/f4Mr6950rB+3a ruNiigJIWIjgHXmBDgSlN6xAaFtx2+Azc4Iya8mXPGzJWPUQc8IqmNbHpoaq7ROBlYTHpm+dJHq /OWaT9SnjMQ== X-Received: from dled13-n1.prod.google.com ([2002:a05:701b:42cd:10b0:12a:ad8d:be18]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a05:7022:2395:b0:12c:839:7462 with SMTP id a92af1059eb24-12c73b2700cmr12088017c88.12.1776973475774; Thu, 23 Apr 2026 12:44:35 -0700 (PDT) Date: Thu, 23 Apr 2026 12:43:59 -0700 In-Reply-To: <20260423194428.1846255-1-irogers@google.com> Precedence: bulk X-Mailing-List: linux-perf-users@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20260423161006.1762700-1-irogers@google.com> <20260423194428.1846255-1-irogers@google.com> X-Mailer: git-send-email 2.54.0.545.g6539524ca2-goog Message-ID: <20260423194428.1846255-3-irogers@google.com> Subject: [PATCH v4 30/58] perf flamegraph: Port flamegraph to use python module From: Ian Rogers To: acme@kernel.org, adrian.hunter@intel.com, james.clark@linaro.org, leo.yan@linux.dev, namhyung@kernel.org, tmricht@linux.ibm.com Cc: alice.mei.rogers@gmail.com, dapeng1.mi@linux.intel.com, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org, mingo@redhat.com, peterz@infradead.org, Ian Rogers Content-Type: text/plain; charset="UTF-8" Add a port of the flamegraph script that uses the perf python module directly. This approach is significantly faster than using perf script callbacks as it avoids creating intermediate dictionaries for all event fields. Assisted-by: Gemini:gemini-3.1-pro-preview Signed-off-by: Ian Rogers --- v2: 1. Performance Optimization: Changed Node.children from a list to a dictionary, reducing the lookup time in find_or_create_node from O(N) to O(1) and avoiding performance bottlenecks on wide call graphs. 2. Callchain Fallback: Added a fallback to use the sample's top-level symbol or instruction pointer if no callchain is present, ensuring the script still generates meaningful output rather than just process names. 3. Template Downloading Fix: Corrected the logic handling the --allow-download flag and custom HTTP URLs. It no longer warns about missing local files when a URL is provided, and won't silently overwrite custom URLs with the default one. 4. Output Stream Separation: Moved informational warnings to sys.stderr to prevent them from corrupting the resulting HTML/JSON file when the user streams the output to stdout (e.g., using -o - ). 5. XSS Protection: Added basic HTML entity escaping for < , > , and & within the embedded JSON data blocks. This mitigates the risk of cross-site scripting if trace data contains maliciously formed process or symbol names. --- tools/perf/python/flamegraph.py | 250 ++++++++++++++++++++++++++++++++ 1 file changed, 250 insertions(+) create mode 100755 tools/perf/python/flamegraph.py diff --git a/tools/perf/python/flamegraph.py b/tools/perf/python/flamegraph.py new file mode 100755 index 000000000000..f3f69e5a88c2 --- /dev/null +++ b/tools/perf/python/flamegraph.py @@ -0,0 +1,250 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 +""" +flamegraph.py - create flame graphs from perf samples using perf python module +""" + +import argparse +import hashlib +import json +import os +import subprocess +import sys +import urllib.request +from typing import Dict, Optional, Union +import perf + +MINIMAL_HTML = """ + + + +
+ + + + +""" + +class Node: + """A node in the flame graph tree.""" + def __init__(self, name: str, libtype: str): + self.name = name + self.libtype = libtype + self.value: int = 0 + self.children: dict[str, Node] = {} + + def to_json(self) -> Dict[str, Union[str, int, list[Dict]]]: + """Convert the node to a JSON-serializable dictionary.""" + return { + "n": self.name, + "l": self.libtype, + "v": self.value, + "c": [x.to_json() for x in self.children.values()] + } + + +class FlameGraphCLI: + """Command-line interface for generating flame graphs.""" + def __init__(self, args): + self.args = args + self.stack = Node("all", "root") + self.session = None + + @staticmethod + def get_libtype_from_dso(dso: Optional[str]) -> str: + """Determine the library type from the DSO name.""" + if dso and (dso == "[kernel.kallsyms]" or dso.endswith("/vmlinux") or dso == "[kernel]"): + return "kernel" + return "" + + @staticmethod + def find_or_create_node(node: Node, name: str, libtype: str) -> Node: + """Find a child node with the given name or create a new one.""" + if name in node.children: + return node.children[name] + child = Node(name, libtype) + node.children[name] = child + return child + + def process_event(self, sample) -> None: + """Process a single perf sample event.""" + if self.args.event_name and str(sample.evsel) != self.args.event_name: + return + + pid = sample.sample_pid + dso_type = "" + try: + thread = self.session.process(sample.sample_tid) + comm = thread.comm() + except Exception: + comm = "[unknown]" + + if pid == 0: + comm = "swapper" + dso_type = "kernel" + else: + comm = f"{comm} ({pid})" + + node = self.find_or_create_node(self.stack, comm, dso_type) + + callchain = sample.callchain + if callchain: + # We want to traverse from root to leaf. + # perf callchain iterator gives leaf to root. + # We collect them and reverse. + frames = list(callchain) + for entry in reversed(frames): + name = entry.symbol or "[unknown]" + libtype = self.get_libtype_from_dso(entry.dso) + node = self.find_or_create_node(node, name, libtype) + else: + # Fallback if no callchain + name = getattr(sample, "symbol", "[unknown]") + libtype = self.get_libtype_from_dso(getattr(sample, "dso", "[unknown]")) + node = self.find_or_create_node(node, name, libtype) + + node.value += 1 + + def get_report_header(self) -> str: + """Get the header from the perf report.""" + try: + input_file = self.args.input or "perf.data" + output = subprocess.check_output(["perf", "report", "--header-only", "-i", input_file]) + result = output.decode("utf-8") + if self.args.event_name: + result += "\nFocused event: " + self.args.event_name + return result + except Exception: + return "" + + def run(self) -> None: + """Run the flame graph generation.""" + input_file = self.args.input or "perf.data" + if not os.path.exists(input_file): + print(f"Error: {input_file} not found. (try 'perf record' first)", file=sys.stderr) + sys.exit(1) + + try: + self.session = perf.session(perf.data(input_file), + sample=self.process_event) + except Exception as e: + print(f"Error opening session: {e}", file=sys.stderr) + sys.exit(1) + + self.session.process_events() + + stacks_json = json.dumps(self.stack, default=lambda x: x.to_json()) + # Escape HTML special characters to prevent XSS + stacks_json = stacks_json.replace("<", "\\u003c") \ + .replace(">", "\\u003e").replace("&", "\\u0026") + + if self.args.format == "html": + report_header = self.get_report_header() + options = { + "colorscheme": self.args.colorscheme, + "context": report_header + } + options_json = json.dumps(options) + options_json = options_json.replace("<", "\\u003c") \ + .replace(">", "\\u003e").replace("&", "\\u0026") + + template = self.args.template + template_md5sum = None + output_str = None + + if not os.path.isfile(template): + if template.startswith("http://") or template.startswith("https://"): + if not self.args.allow_download: + print("Warning: Downloading templates is disabled. " + "Use --allow-download.", file=sys.stderr) + template = None + else: + print(f"Warning: Template file '{template}' not found.", file=sys.stderr) + if self.args.allow_download: + print("Using default CDN template.", file=sys.stderr) + template = ( + "https://cdn.jsdelivr.net/npm/d3-flame-graph@4.1.3/dist/templates/" + "d3-flamegraph-base.html" + ) + template_md5sum = "143e0d06ba69b8370b9848dcd6ae3f36" + else: + template = None + + use_minimal = False + try: + if not template: + use_minimal = True + elif template.startswith("http"): + with urllib.request.urlopen(template) as url_template: + output_str = "".join([l.decode("utf-8") for l in url_template.readlines()]) + else: + with open(template, "r", encoding="utf-8") as f: + output_str = f.read() + except Exception as err: + print(f"Error reading template {template}: {err}\n", file=sys.stderr) + use_minimal = True + + if use_minimal: + print("Using internal minimal HTML that refers to d3's web site. JavaScript " + + "loaded this way from a local file may be blocked unless your " + + "browser has relaxed permissions. Run with '--allow-download' to fetch" + + "the full D3 HTML template.", file=sys.stderr) + output_str = MINIMAL_HTML + + elif template_md5sum: + assert output_str is not None + download_md5sum = hashlib.md5(output_str.encode("utf-8")).hexdigest() + if download_md5sum != template_md5sum: + s = None + while s not in ["y", "n"]: + s = input(f"""Unexpected template md5sum. +{download_md5sum} != {template_md5sum}, for: +{output_str} +continue?[yn] """).lower() + if s == "n": + sys.exit(1) + + assert output_str is not None + output_str = output_str.replace("/** @options_json **/", options_json) + output_str = output_str.replace("/** @flamegraph_json **/", stacks_json) + output_fn = self.args.output or "flamegraph.html" + else: + output_str = stacks_json + output_fn = self.args.output or "stacks.json" + + if output_fn == "-": + sys.stdout.write(output_str) + else: + print(f"dumping data to {output_fn}") + with open(output_fn, "w", encoding="utf-8") as out: + out.write(output_str) + + +if __name__ == "__main__": + parser = argparse.ArgumentParser(description="Create flame graphs using perf python module.") + 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", + help="path to flame graph HTML template") + parser.add_argument("--colorscheme", default="blue-green", + help="flame graph color scheme", choices=["blue-green", "orange"]) + parser.add_argument("-i", "--input", help="input perf.data file") + parser.add_argument("--allow-download", default=False, action="store_true", + help="allow unprompted downloading of HTML template") + parser.add_argument("-e", "--event", default="", dest="event_name", type=str, + help="specify the event to generate flamegraph for") + + cli_args = parser.parse_args() + cli = FlameGraphCLI(cli_args) + cli.run() -- 2.54.0.rc2.533.g4f5dca5207-goog