From nobody Tue Sep 29 10:31:59 2026 Received: from mail-pg1-f197.google.com (mail-pg1-f197.google.com [209.85.215.197]) (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 C6EE238E126 for ; Sun, 9 Aug 2026 05:18:26 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.197 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786252708; cv=none; b=K9L1FmMDBPnLGDc6K+8CeTtuTUzayMOhZgm+btifT7bBse0LbUZ5hVe2/D2DAoQeOeDzjKNtzj9BmjWuG57/aGcBm3lB/xvdQ8lYWKfg7FFANjuG12n1/5sYxbFp/tz1TgA/BVn0QfvV9v0Yz1E2WrW01MKAlKJDpGYjMdleBDw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786252708; c=relaxed/simple; bh=cB/Ee2CPJOLT8BzqucrjIUxTPNHq7zvXTAln082REis=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=pC0ExMNpM107d75N/lyzWexpUo9Ozmj7HTjAfdsUM05tXP5eBtVSdQqqza+lsz4IWlye60j/eqwFnX2eV6iQ5ECwZc9BWl3/hccMFW6LdXCNAiaOZXPzMGPWCmyW0B86QZYHP2FTlwejZ6mKjwiA4aNf4WP0ggmEik2r1ujHWhw= 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=NF52ONwh; arc=none smtp.client-ip=209.85.215.197 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="NF52ONwh" Received: by mail-pg1-f197.google.com with SMTP id 41be03b00d2f7-c856470fe9fso547724a12.2 for ; Sat, 08 Aug 2026 22:18:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1786252706; x=1786857506; darn=vger.kernel.org; h=content-transfer-encoding:content-type:cc:to:from:subject :message-id:references:mime-version:in-reply-to:date:from:to:cc :subject:date:message-id:reply-to:content-type; bh=wDdrpzVPlZPTXmEKpVgqlFgbaNYSa80YG48sAkfYj4c=; b=NF52ONwhO0ZSUv96VRLIhIMosCFJXzjKHO4ZtDx//HJUqdBxXFVaT27tekb4UiDXSm kDymURLhW2QPZHYN758HVL9EoknIp0FsuIaODWQpco9HkEDsad7aHCc/TvAVO5w/mH9+ eTwpl7PaS4JVy+CI+8T6B3MN/ilBl5sfkyrFuRgGeNRFIs0HdVH77kd90YizDFsgfEHR CA4j3PxxncTrjwgETrjzU9ncg/DWw0iDhC7t2WxQHqayCWH5YZA/zSUYRnLZB6JuDR7v LGTJAa6ChS+nCHq3IS9UcBMKlmyiHVJ2NZIf0GF76OyfXI/ipdDAt80wBmTm1BrKJWX9 nKig== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1786252706; x=1786857506; h=content-transfer-encoding:content-type: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 :content-type; bh=wDdrpzVPlZPTXmEKpVgqlFgbaNYSa80YG48sAkfYj4c=; b=E6hiAjvRhcx8TAy7mrDgBRN0TAQ96gFnd7B8fEa5WCN7O2ScFMDShdIHKdwNhOhNUu yfDRkGQ93P8DATrwQc+CS9yikqVxd3pIIPG5dSr6tRPnpODQpZGkIP8paLxRNTBKQoGA imoCkQg6r15YJV7LdHiRmnBB2tnPg/72zF072dHYlnraX416o+vjH0g5L+0ccYdks1b5 +DbpfMQbE6Uga/UrLpgpT4ilXNhJclz34P+IWNXxv+e99qGFJtpny4p/IvNKlNdL9OEf Wv9qkaeCNMKsPx1BVuqYlp1TumOd44DaQCo1TtUX94rXl5GyYKD0S7zgi1r9Qj1sPc0T J1EQ== X-Forwarded-Encrypted: i=1; AHgh+Ro6CZo/j12CLhdRx8b4Yoi7JWyFFp5VsMx8oIQPZ8JmTCxZ2aWsRysBuukEcKTU5qYVicNQh4h55i6v/ww=@vger.kernel.org X-Gm-Message-State: AOJu0YwZyVNTax1962k2RBnhsrnq/Nl/MFp2vNVathnWDUsrmyaj5ooF +K90TfdN9nzF8TbXqQMPeAx6vZym43pnVA1YWS9x9oUVqILWO8ToFJ0oIAGbc3PbrN68K9T8Qhj faSiE2/Y+KQ== X-Received: from dlbts18-n2.prod.google.com ([2002:a05:7022:b052:20b0:140:f2bb:6f2b]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a21:6f17:b0:3c3:a20f:f720 with SMTP id adf61e73a8af0-3cbcea2fed2mr14640535637.36.1786252705852; Sat, 08 Aug 2026 22:18:25 -0700 (PDT) Date: Sat, 8 Aug 2026 22:18:18 -0700 In-Reply-To: <20260809051820.2436530-1-irogers@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20260809041638.2402705-1-irogers@google.com> <20260809051820.2436530-1-irogers@google.com> X-Mailer: git-send-email 2.55.0.654.g21b8a5bc05-goog Message-ID: <20260809051820.2436530-2-irogers@google.com> Subject: [PATCH v4 1/2] perf python: New treport script From: Ian Rogers To: irogers@google.com, acme@kernel.org, alice.mei.rogers@gmail.com, namhyung@kernel.org Cc: adrian.hunter@intel.com, jolsa@kernel.org, laixintaoo@gmail.com, linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org, mingo@redhat.com, peterz@infradead.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Alice Rogers A textual app that displays the results of processing samples similar to perf report. The app displays a tree of first processes and then functions which drop down to show more detail on the functions they call. The functions with the largest number of samples are sorted first, after each function the percentage of time spent within it is highlighted. If more than one event is recorded then each event appears first, with the processes and functions sorted for that event beneath it. The app is written in python and requires the textual framework. Using the textual framework means that in most modern terminals the mouse is supported, the color scheme can be configured, and screenshots made. With perf report: ``` $ perf record -e cycles:u -g perf test -w brstack [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.008 MB perf.data (57 samples) ] $ perf report ... Samples: 57 of event 'cycles:u', Event count (approx.): 15907831 Children Self Command Shared Object Symbol - 88.86% 0.00% perf libc.so.6 [.] 0x000079b17df69ca8 0x79b17df69ca8 main handle_internal_command cmd_test - brstack - 84.27% brstack_bench - 40.69% brstack_foo brstack_bar 3.32% brstack_bar 3.31% brstack_bar 1.27% brstack_foo + 88.86% 0.00% perf perf [.] main + 88.86% 0.00% perf perf [.] handle_internal_co= mmand + 88.86% 0.00% perf perf [.] cmd_test + 88.86% 0.00% perf perf [.] brstack + 84.27% 40.26% perf perf [.] brstack_bench + 41.96% 30.71% perf perf [.] brstack_foo + 17.89% 17.89% perf perf [.] brstack_bar ``` With the treport script: ``` $ perf record -e cycles:u -g perf test -w brstack [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.008 MB perf.data (57 samples) ] $ tools/perf/python/treport.py O ReportApp Report =E2=95=B8=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=95=BA=E2= =94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94= =81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81= =E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2= =94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94= =81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81= =E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2=94=81=E2= =94=81=E2=94=81=E2=94=81=E2=94=81 =E2=96=BC Profile =E2=94=94=E2=94=80=E2=94=80 =E2=96=BC cycles:u 100% =E2=94=94=E2=94=80=E2=94=80 =E2=96=BC perf (32963) 100% =E2=94=9C=E2=94=80=E2=94=80 =E2=96=BC /usr/lib/x86_64-linux-gnu/lib= c.so.6 0x79b17df6 =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 =E2=96=BC main 56.1% =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 =E2=96=BC handle_intern= al_command 56.1% =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 =E2=96=BC cmd_test = 56.1% =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 =E2=96=BC brsta= ck 56.1% =E2=96=81=E2=96=81 =E2=94=82 =E2=94=9C=E2=94=80=E2=94=80 =E2=96=BC b= rstack_bench 52.6% =E2=94=82 =E2=94=82 =E2=94=9C=E2=94=80=E2=94=80= =E2=96=B6 brstack_foo 24.6% =E2=94=82 =E2=94=82 =E2=94=94=E2=94=80=E2=94=80= brstack_bar 1.75% =E2=94=82 =E2=94=9C=E2=94=80=E2=94=80 brstack_foo= 1.75% =E2=94=82 =E2=94=94=E2=94=80=E2=94=80 brstack_bar= 1.75% =E2=94=9C=E2=94=80=E2=94=80 =E2=96=B6 /usr/lib/x86_64-linux-gnu/ld-= linux-x86-64.so.2 =E2=96=8C ^q Quit =E2=96=8F^p palette ``` Co-developed-by: Ian Rogers Signed-off-by: Ian Rogers Signed-off-by: Alice Rogers --- tools/perf/python/treport.py | 207 +++++++++++++++++++++++++++++++++++ 1 file changed, 207 insertions(+) create mode 100755 tools/perf/python/treport.py diff --git a/tools/perf/python/treport.py b/tools/perf/python/treport.py new file mode 100755 index 000000000000..71a91775bd6a --- /dev/null +++ b/tools/perf/python/treport.py @@ -0,0 +1,207 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: MIT +"""treport.py - perf report like tool written using textual.""" +from typing import Dict, Optional +import argparse +import os +import sys +import perf +from textual.app import App, ComposeResult +from textual.binding import Binding +from textual.widgets import Footer, Header, TabbedContent, TabPane, Tree +from textual.widgets.tree import TreeNode + +# Global session. +session :Optional[perf.session] =3D None + +class ProfileNode: + """Represents a single node in a call stack tree. + + Generally a ProfileNode corresponds to a symbol in a call stack. + The root is special, its children are events and the events + children are process names. After the process name come the + samples. + + Attributes: + name (str): The name of the function, process or event. + value (int): The sample count for this node including counts from = its + children. + parent (ProfileNode): The parent of this node, this node belongs t= o its + children. + children (Dict[str, ProfileNode]): A dictionary of child nodes, ke= yed by + their names. + """ + def __init__(self, name: str, parent: "ProfileNode"): + """Initializes a ProfileNode.""" + self.name =3D name + self.value: int =3D 0 + self.parent =3D parent if parent else self + self.children: Dict[str, ProfileNode] =3D {} + + def find_or_create_node(self, name: str) -> "ProfileNode": + """Finds a child node by name or creates it if it doesn't exist.""" + if name in self.children: + return self.children[name] + child =3D ProfileNode(name, self) + self.children[name] =3D child + return child + + def depth(self) -> int: + """The maximum depth of the call stack tree from this node down.""" + if not self.children: + return 1 + return max(child.depth() for child in self.children.values()) + 1 + + def process_event(self, sample) -> None: + """Processes a single profiling event to update the call stack tre= e. + + Args: + sample: a single profiling sample. + """ + pid =3D sample.sample_pid + try: + assert session + thread =3D session.find_thread(sample.sample_tid) + comm =3D thread.comm() + except Exception: + comm =3D f"unknown ({pid})" + + period =3D sample.sample_period + self.value +=3D period + + node =3D self.find_or_create_node(comm) + node.value +=3D period + + if sample.callchain: + for entry in reversed(sample.callchain): + name =3D entry.symbol + if not name or name =3D=3D "[unknown]": + name =3D entry.dso or "unknown" + if entry.ip: + name +=3D f" 0x{entry.ip:x}" + node =3D node.find_or_create_node(name) + node.value +=3D period + else: + name =3D sample.symbol + if not name or name =3D=3D "[unknown]": + name =3D sample.dso or "unknown" + if sample.sample_ip: + name +=3D f" 0x{sample.sample_ip:x}" + node =3D node.find_or_create_node(name) + node.value +=3D period + + def add_to_tree(self, node: TreeNode, root_value: int) -> None: + """Recursively adds this node and its children to a textual TreeNo= de. + + Args: + node (TreeNode): The textual `TreeNode` object to which this + ProfileNode should be added. + root_value (int): Value at the root of the tree. + """ + if root_value =3D=3D 0: + root_value =3D self.value + + # Calculate the percentage for the node, highlighting the + # percentage with reversed colors. + if root_value !=3D 0: + percent =3D self.value / root_value * 100 + label =3D f"{self.name} [r]{percent:.3g}%[/]" + else: + label =3D self.name + + # Add a standalone leaf. + if not self.children: + node.add_leaf(label) + return + + # Recursively add children. + new_node =3D node.add(label) + for pnode in sorted(self.children.values(), + key=3Dlambda pnode: pnode.value, reverse=3DTru= e): + pnode.add_to_tree(new_node, root_value) + + +class ReportApp(App): + """A Textual application to display profiling data.""" + + # The ^q binding is implied but having it here adds it in the Footer. + BINDINGS =3D [ + Binding(key=3D"^q", action=3D"quit", description=3D"Quit", + tooltip=3D"Quit the app"), + ] + + def __init__(self, root: ProfileNode): + """Initialize the application.""" + super().__init__() + self.root =3D root + + def make_report_tree(self) -> Tree: + """Make a Tree widget from the profile data.""" + tree: Tree[None] =3D Tree("Profile") + # Add events to tree skipping the root. + for pnode in sorted(self.root.children.values(), + key=3Dlambda node: node.value, reverse=3DTrue): + pnode.add_to_tree(tree.root, root_value=3D0) + + # Expand the root tree (shows all events) and the largest of the c= hildren + # for each event. + def expand_first_child(tnode: TreeNode) -> None: + """Recursively expand the first child node""" + if not tnode.children: + return + first =3D tnode.children[0] + first.expand() + expand_first_child(first) + tree.root.expand() + for tnode in tree.root.children: + expand_first_child(tnode) + + # If there is only one event, expand it also. + if len(tree.root.children) =3D=3D 1: + tree.root.children[0].expand() + + return tree + + def compose(self) -> ComposeResult: + """Composes the user interface of the application.""" + yield Header() + with TabbedContent(initial=3D"report"): + with TabPane("Report", id=3D"report"): + yield self.make_report_tree() + yield Footer() + + +class ProfileBuilder: + """Constructs a profile tree from a stream of events.""" + def __init__(self): + self.root =3D ProfileNode("root", parent=3DNone) + + def process_event(self, sample) -> None: + """Called by session.process_events to update the profile tree.""" + ev_name =3D str(sample.evsel)[6:-1] + ev_root =3D self.root.find_or_create_node(ev_name) + ev_root.process_event(sample) + +if __name__ =3D=3D "__main__": + parser =3D argparse.ArgumentParser(description=3D"TUI report using per= f python module.") + parser.add_argument("-i", "--input", help=3D"input perf.data file") + args =3D parser.parse_args() + + input_file =3D args.input or "perf.data" + if not os.path.exists(input_file): + print(f"Error: {input_file} not found. (try 'perf record' first)",= file=3Dsys.stderr) + sys.exit(1) + + profile =3D ProfileBuilder() + try: + session =3D perf.session(perf.data(input_file), sample=3Dprofile.p= rocess_event) + except Exception as e: + print(f"Error opening session: {e}", file=3Dsys.stderr) + sys.exit(1) + + # profile.process_event is called for each perf event to build the pro= file. + session.process_events() + + # Visualize data. + app =3D ReportApp(profile.root) + app.run() --=20 2.55.0.654.g21b8a5bc05-goog From nobody Tue Sep 29 10:31:59 2026 Received: from mail-pl1-f199.google.com (mail-pl1-f199.google.com [209.85.214.199]) (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 224B31F16B for ; Sun, 9 Aug 2026 05:18:28 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.199 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786252710; cv=none; b=dmQAN/E8uNsKI/2Ihq28/2PoMIGbuowbQQDI7YyMMn0d1tDoIHQW60Y8flBO26j9rdjAxtj+3C5Q7Gi1yiYvujctnZeEbfFuz7mcC1qPFYZpmvs1PDagjiis+YaLDKExTwd2+tM2qLg2xeOM4wx87QzY8kNOaWjMfMoUbDRUesY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786252710; c=relaxed/simple; bh=JvP2i0WAvqoITmfRsBEkoBJ1ij4YnjR4bD6xFdNPDxM=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=FIR/lG8v6MywZNc4zv8oTT3/9ZYIFR2RaX6G8B4MV3hJKO9L5GZ7QWoExr3Eu8ZFWfIyos03CG79uEmPFdfmhkSb2S4hpgTim3OgsCw4FP2UmDDTjmFXPbdl29N7k2kbECooKWcWMuAolt9wq76nU1inXbjHMfLx96uEIVIcYuI= 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=lHsGILWM; arc=none smtp.client-ip=209.85.214.199 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="lHsGILWM" Received: by mail-pl1-f199.google.com with SMTP id d9443c01a7336-2cc640dfde3so11503685ad.1 for ; Sat, 08 Aug 2026 22:18:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1786252708; x=1786857508; darn=vger.kernel.org; h=content-transfer-encoding:content-type:cc:to:from:subject :message-id:references:mime-version:in-reply-to:date:from:to:cc :subject:date:message-id:reply-to:content-type; bh=OTg5G5SfPRSqVv9oRCS6WW31alsd2+rPFPMWfnGw3Ck=; b=lHsGILWMPSBCaZGECA5u5xp7z9ZbfziZuZ3onJveozMtbFGZHFm1Ww4XlA9Ru+NMPF 8mAzkOXNHOtYaxYWEloOnCVRkTA19cms2NRjzQPvaDfLPxYoRc4vGuAK2Efvsus7KvJV gNIYNhXAl0qexPvTdmthbEVSrAGsKcpCwGeRXQAp3HuPpt21Yj7nN1Oa7qD8AUbiozuM SLZmE9aG33dxOOR6HVv0XhQrQQzuEIlr58zm9L417t333Wn8EHyX1nBZkpwySyycs/Nk WJH89Lu9ggd1AqypFoR5X7QwVdhgDw0ibZQhmljAKoCNVOFJH4BuH5VItJset/oDcyEH Qafw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1786252708; x=1786857508; h=content-transfer-encoding:content-type: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 :content-type; bh=OTg5G5SfPRSqVv9oRCS6WW31alsd2+rPFPMWfnGw3Ck=; b=KHtvCFlqHU4h8Sj+U8jM+jUx+VvgUknWabcDflim+9GPEjltzf8e+8VFBI+wSDS04F gnb4OMadPvvfwVV5WdaNA68XeJzwiaiEu+zZTrPDao/JcJpDSRJHVyxUewqWAZrR8SDL xKGgD+S2x02y/M26Z79heIqKnSJ9a3sgUAdpwCXFGFBq6kKa5AxpsReFH6OregVKG0iv ojj/fVl7ngvF/gkqQfTGHEsXY+EERtn2NaA973ihzUFthRwOjJiowq6qJb0AjzuUzbXC AxBygyzEbuzP0YKr9C7VyVHHxP/ER1jCgKvesbZDjgKBssmvSEO0xr413A2qLVsiulkE G3dw== X-Forwarded-Encrypted: i=1; AHgh+RqWkX6Rs/z7d8kJYLu5PInnDRSVCrKJ8DXrDq/Wo1ZQHbZk20Mtel4hSDpXVfnvgtZlBOVVPPokP5HgGBw=@vger.kernel.org X-Gm-Message-State: AOJu0YxpsUILLCtWmLzN2hyQa7iMuqrG5giOlyfyFa7jBIAZedql7rLN dxX8CdhG+yUXuvsPfZqx/0q0LiAhDUi8a4huv0Va8+CxB5647FCeuoItlKRJhgA+IiegNzCN4sE az5czzxG3DA== X-Received: from dly27-n1.prod.google.com ([2002:a05:701b:205b:10b0:139:c655:b2de]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a20:7f89:b0:3bf:a489:1483 with SMTP id adf61e73a8af0-3cbce9b63fcmr12539016637.33.1786252708173; Sat, 08 Aug 2026 22:18:28 -0700 (PDT) Date: Sat, 8 Aug 2026 22:18:19 -0700 In-Reply-To: <20260809051820.2436530-1-irogers@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20260809041638.2402705-1-irogers@google.com> <20260809051820.2436530-1-irogers@google.com> X-Mailer: git-send-email 2.55.0.654.g21b8a5bc05-goog Message-ID: <20260809051820.2436530-3-irogers@google.com> Subject: [PATCH v4 2/2] perf python: treport add flamegraph support From: Ian Rogers To: irogers@google.com, acme@kernel.org, alice.mei.rogers@gmail.com, namhyung@kernel.org Cc: adrian.hunter@intel.com, jolsa@kernel.org, laixintaoo@gmail.com, linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org, mingo@redhat.com, peterz@infradead.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Alice Rogers Implement a flamegraph widget that recursively walks down a tree splitting line segments based on their value (summed up periods across call chains). A visitor pattern is used so that the same logic can both draw the line segments and locate which segment had a mouse click. Add a tab for the flame graph widget. Co-developed-by: Ian Rogers Signed-off-by: Ian Rogers Signed-off-by: Alice Rogers --- tools/perf/python/treport.py | 356 ++++++++++++++++++++++++++++++++++- 1 file changed, 355 insertions(+), 1 deletion(-) diff --git a/tools/perf/python/treport.py b/tools/perf/python/treport.py index 71a91775bd6a..43542599a884 100755 --- a/tools/perf/python/treport.py +++ b/tools/perf/python/treport.py @@ -1,19 +1,49 @@ #!/usr/bin/env python3 # SPDX-License-Identifier: MIT """treport.py - perf report like tool written using textual.""" +from abc import ABC, abstractmethod from typing import Dict, Optional import argparse import os import sys import perf +from rich.segment import Segment +from rich.style import Style +from textual import events from textual.app import App, ComposeResult from textual.binding import Binding +from textual.color import Color +from textual.scroll_view import ScrollView +from textual.strip import Strip from textual.widgets import Footer, Header, TabbedContent, TabPane, Tree from textual.widgets.tree import TreeNode =20 # Global session. session :Optional[perf.session] =3D None =20 +def make_fixed_length_string(s: str, length: int, pad_char=3D' '): + """Make the string s a fixed length. + + Increases or decreases the length of s to be length. If the length is + increased then pad_char is inserted on the right. + """ + return s[:length] if len(s) > length else s.ljust(length, pad_char) + + +class FlameVisitor(ABC): + """Parent for visitor used by ProfileNode.flame_walk""" + @abstractmethod + def visit(self, node: Optional["ProfileNode"], width: int) -> None: + """Visit a profile node width the specified flame graph width. + + Args: + node: The `ProfileNode` for the current segment. This may be `= None` + to represent a gap or an unknown portion of the stack. + width: The calculated width of the flame graph rectangle for t= his + node, which is proportional to its sample count. + """ + + class ProfileNode: """Represents a single node in a call stack tree. =20 @@ -120,6 +150,327 @@ class ProfileNode: key=3Dlambda pnode: pnode.value, reverse=3DTru= e): pnode.add_to_tree(new_node, root_value) =20 + def largest_child(self) -> "ProfileNode": + """Finds the child with the highest value (sample count).""" + if self.children: + return max(self.children.values(), key=3Dlambda node: node.val= ue) + return self + + def child_after(self, sought: "ProfileNode") -> "ProfileNode": + """Finds the next sibling after the given node, sorted by value.""" + found =3D False + for child in sorted(self.children.values(), key=3Dlambda node: nod= e.value, + reverse=3DTrue): + if child =3D=3D sought: + found =3D True + elif found: + return child + return sought + + def child_before(self, sought: "ProfileNode") -> "ProfileNode": + """Finds the previous sibling before the given node, sorted by val= ue.""" + last =3D None + for child in sorted(self.children.values(), key=3Dlambda node: nod= e.value, + reverse=3DTrue): + if child =3D=3D sought: + return last if last else sought + last =3D child + return sought + + def has_parent(self, parent: "ProfileNode") -> bool: + """Checks if the parent node is an ancestor of this node.""" + p =3D self.parent + while True: + if p =3D=3D parent: + return True + new_p =3D p.parent + if new_p =3D=3D p: + break + p =3D new_p + return False + + def has_child(self, sought: "ProfileNode") -> bool: + """Checks if the sought node is a descendant of this node.""" + return sought.has_parent(self) + + def flame_walk(self, wanted_strip: int, cur_strip: int, parent_width: = int, + selected: "ProfileNode", visitor: FlameVisitor) -> None: + """Recursively walks the tree to visit a single flame graph row. + + This method calculates the proportional width for each child + based on its value (sample count) relative to its parent. It + then invokes a `visitor` to process each segment of the flame + graph row. + + Args: + wanted_strip (int): The target depth (Y-axis) of the flame gra= ph row + to generate. + cur_strip (int): The current depth of the traversal. + parent_width (int): The width of the parent of this node. + selected (ProfileNode): The currently selected node in the UI,= used + to adjust rendering to highlight the + selected path. + visitor (FlameVisitor): A visitor object whose `visit` method = is + called for each segment of the flame g= raph + row. + """ + if parent_width =3D=3D 0: + return + + parent_selected =3D selected =3D=3D self or self.has_parent(select= ed) + child_selected =3D not parent_selected and self.has_child(selected) + if not parent_selected and not child_selected: + # Branches of the tree with no node selected aren't drawn. + return + + # left_over is used to check for a gap after the children due + # to samples being in the parent. + left_over =3D parent_width + for child in sorted(self.children.values(), key=3Dlambda node: nod= e.value, + reverse=3DTrue): + if parent_selected: + if self.value: + desired_width =3D int((parent_width * child.value) / s= elf.value) + else: + desired_width =3D parent_width // len(self.children) + if desired_width =3D=3D 0: + # Nothing can be drawn for this node or later smaller = children. + break + elif child =3D=3D selected or child.has_child(selected): + desired_width =3D parent_width + else: + # A sibling or its child are selected, but not this branch. + continue + + # Either visit the wanted_strip or recurse to the next level. + if wanted_strip =3D=3D cur_strip: + visitor.visit(child, desired_width) + else: + child.flame_walk(wanted_strip, cur_strip + 1, desired_widt= h, + selected, visitor) + left_over -=3D desired_width + if left_over =3D=3D 0: + # No space left to draw in. + break + + # Always visit the left_over regardless of the wanted_strip as the= re + # may be additional gap added to a line by a parent. + if left_over: + visitor.visit(None, left_over) + + def make_flame_strip(self, wanted_strip: int, parent_width: int, + cursor: "ProfileNode", selected: "ProfileNode", + theme_variables: Dict[str, str]) -> Strip: + """Creates a renderable 'Strip' for a single row of a flame graph. + + This method orchestrates the `flame_walk` traversal with a special= ized + visitor to generate a list of segments. The segments are used by a= `Strip` + object for rendering in the terminal. + + Args: + wanted_strip (int): The target depth (Y-axis) of the flame gra= ph row. + parent_width (int): The total width (in characters) of the dis= play + area. + cursor (ProfileNode): The node currently under the cursor, for + highlighting. + selected (ProfileNode): The node that is actively selected. + theme_variables(Dict): Values of colors for the textual theme. + + Returns: + Strip: A renderable strip of segments for the specified row. + """ + primary =3D Color.parse(theme_variables["primary"]) + secondary =3D Color.parse(theme_variables["secondary"]) + surface =3D Color.parse(theme_variables["surface"]) + def luminance(color: Color) -> float: + """Computes the luminance of a color from the rgb""" + return color.r * 0.299 + color.g * 0.587 + color.b * 0.114 + + # Set of styles for different flamegraph segments, the styles are + # cycled through to provide contrast. + normal_styles =3D [] + for x in range(0, 125, 25): + fgcolor =3D secondary.blend(primary, x/100) + if luminance(fgcolor) > luminance(surface): + bgcolor =3D surface.lighten(0.05+x/500) + else: + bgcolor =3D surface.darken(0.05+x/500) + normal_styles.append(Style(color=3Dfgcolor.rich_color, + bgcolor=3Dbgcolor.rich_color)) + + # Style for the selected flame graph node. + accent =3D Color.parse(theme_variables["accent"]) + accent_muted =3D Color.parse(theme_variables["accent-muted"]) + cursor_style =3D Style(color=3Daccent.rich_color, bgcolor=3Daccent= _muted.rich_color) + + class StripVisitor(FlameVisitor): + """Visitor creating textual flame graph segments. + + Attributes: + segments (list): The textual segments that will be placed = in a + `Strip`. + gap_width (int): The width of any outstanding gap between = the + last and next node. + ctr (int): Used to adjust the flame graph segment's color. + """ + def __init__(self): + self.segments =3D [] + self.gap_width =3D 0 + self.ctr =3D wanted_strip + + def visit(self, node: Optional[ProfileNode], width: int) -> No= ne: + if node: + if self.gap_width > 0: + self.segments.append(Segment( + make_fixed_length_string(" ", self.gap_width))) + self.gap_width =3D 0 + style =3D cursor_style + if node !=3D cursor: + style =3D normal_styles[self.ctr % len(normal_styl= es)] + self.segments.append(Segment( + make_fixed_length_string(node.name, width), style)) + else: + self.gap_width +=3D width + self.ctr +=3D 1 + + visitor =3D StripVisitor() + self.flame_walk(wanted_strip, 0, parent_width, selected, visitor) + return Strip(visitor.segments) if visitor.segments else Strip.blan= k(parent_width) + + def find_node(self, sought_x: int, sought_y: int, parent_width: int, + selected: "ProfileNode") -> "ProfileNode": + """Finds the ProfileNode corresponding to specific X, Y coordinate= s. + + This translates a mouse click on a flame graph back to the + `ProfileNode` that it represents. + + Args: + sought_x (int): The X coordinate (character column). + sought_y (int): The Y coordinate (row or depth). + parent_width (int): The total width of the display area. + selected (ProfileNode): The currently selected node, which aff= ects + layout. + + Returns: + Optional[ProfileNode]: The node found at the coordinates, or N= one. + + """ + class FindVisitor(FlameVisitor): + """Visitor locating a `ProfileNode`. + + Attributes: + x (int): offset within line. + found (Optional[ProfileNode]): located node + gap_width (int): The width of any outstanding gap between = the + last and next node. + ctr (int): Used to adjust the flame graph segment's color. + """ + def __init__(self): + self.x =3D 0 + self.found =3D None + + def visit(self, node: Optional[ProfileNode], width: int) -> No= ne: + if self.x <=3D sought_x < self.x + width: + self.found =3D node + self.x +=3D width + + visitor =3D FindVisitor() + self.flame_walk(sought_y, 0, parent_width, selected, visitor) + return visitor.found + + +class FlameGraph(ScrollView): + """A scrollable widget to display a flame graph from a profile. + + Attributes: + root (ProfileNode): Root of the profile tree. + cursor (ProfileNode): Currently highlighted cursor node. + selected (ProfileNode): The currently selected node for zooming. + """ + + # Define key bindings for navigating the flame graph. + # Allows movement with vim-style keys (h,j,k,l) and arrow keys. + BINDINGS =3D [ + Binding("j,down", "move_down", "Down", key_display=3D"=E2=86=93", + tooltip=3D"Move cursor down to largest child"), + Binding("k,up", "move_up", "Up", key_display=3D"=E2=86=91", + tooltip=3D"Move cursor up to parent"), + Binding("l,right", "move_right", "Right", key_display=3D"=E2=86=92= ", + tooltip=3D"Move cursor to the right sibling"), + Binding("h,left", "move_left", "Left", key_display=3D"=E2=86=90", + tooltip=3D"Move cursor to the left sibling"), + Binding("enter", "zoom_in", "Zoom In", + tooltip=3D"Expand the cursor's node to be screen width"), + Binding("escape", "zoom_out", "Zoom Out", + tooltip=3D"Zoom out to initial view."), + ] + + # Default CSS for the widget to ensure it fills its container's width. + DEFAULT_CSS =3D """ + FlameGraph { + width: 100%; + } + """ + + def __init__(self, root: ProfileNode, *args, **kwargs): + """Initialize the FlameGraph widget.""" + super().__init__(*args, **kwargs) + self.root =3D root + self.cursor =3D root + self.selected =3D root + + def action_move_down(self) -> None: + """Handle key press down.""" + self.cursor =3D self.cursor.largest_child() + self.refresh() + + def action_move_up(self) -> None: + """Handle key press up.""" + if self.cursor.parent !=3D self.cursor.parent.parent: + self.cursor =3D self.cursor.parent + self.refresh() + + def action_move_right(self) -> None: + """Handle key press right.""" + self.cursor =3D self.cursor.parent.child_after(self.cursor) + self.refresh() + + def action_move_left(self) -> None: + """Handle key press left.""" + self.cursor =3D self.cursor.parent.child_before(self.cursor) + self.refresh() + + def action_zoom_in(self) -> None: + """Handle key press zoom in.""" + self.selected =3D self.cursor + self.refresh() + + def action_zoom_out(self) -> None: + """Handle key press zoom out.""" + self.selected =3D self.root + self.refresh() + + def render_line(self, y: int) -> Strip: + """Render a single line (row) of the flame graph.""" + _, scroll_y =3D self.scroll_offset + y +=3D scroll_y + return self.root.make_flame_strip(y, self.size.width, self.cursor, + self.selected, self.app.theme_va= riables) + + def on_mount(self) -> None: + """Set the height of the widget when it is displayed.""" + self.styles.height =3D self.root.depth() + + def on_click(self, click: events.Click) -> None: + """Handles a mouse click and update the cursor position.""" + _, scroll_y =3D self.scroll_offset + y =3D scroll_y + click.y + clicked_node =3D self.root.find_node(click.x, y, self.size.width, + self.selected) + if clicked_node: + self.cursor =3D clicked_node + self.refresh() + =20 class ReportApp(App): """A Textual application to display profiling data.""" @@ -168,6 +519,8 @@ class ReportApp(App): with TabbedContent(initial=3D"report"): with TabPane("Report", id=3D"report"): yield self.make_report_tree() + with TabPane("Flame Graph", id=3D"flame"): + yield FlameGraph(self.root) yield Footer() =20 =20 @@ -183,7 +536,8 @@ class ProfileBuilder: ev_root.process_event(sample) =20 if __name__ =3D=3D "__main__": - parser =3D argparse.ArgumentParser(description=3D"TUI report using per= f python module.") + parser =3D argparse.ArgumentParser( + description=3D"TUI report and flame graph using perf python module= .") parser.add_argument("-i", "--input", help=3D"input perf.data file") args =3D parser.parse_args() =20 --=20 2.55.0.654.g21b8a5bc05-goog