Minor improvements for perf script flamegraph
PATCH 1/1 Minor improvements for perf script flamegraph
When processing the perf data file generated with multiple events, the flamegraph script will count all the events regardless of different event names. If specify the perf data file with -i option, the script will try to read the header information regardless of the file name specified, instead it will try to access the perf.data.
This patch tries to add a -e option to specify the event name that the flamegraph will be generated accordingly. If the -e option omitted, the behavior remains unchanged. If the -i option specified, the header information will be read from that file.
--- tools/perf/scripts/python/flamegraph.py | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-)
tools/perf/scripts/python/flamegraph.py +19 -2
@@ -94,6 +94,11 @@ class FlameGraphCLI: return child def process_event(self, event): + # 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 + 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
@@ -123,8 +128,15 @@ class FlameGraphCLI: return "" try: - output = subprocess.check_output(["perf", "report", "--header-only"]) - return output.decode("utf-8") + if self.args.input: + output = subprocess.check_output(["perf", "script", "--header-only", "-i", self.args.input]) + else: + output = subprocess.check_output(["perf", "report", "--header-only"]) + + result = output.decode("utf-8") + if self.args.event_name: + result += "\nFocused event: " + self.args.event_name + return result except Exception as err: # pylint: disable=broad-except print("Error reading report header: {}".format(err), file=sys.stderr) return ""
@@ -235,6 +247,11 @@ if __name__ == "__main__": 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)
Signature · 1 line
2.43.5
Namhyung Kim
maintainerHello,
Quoted 10 lines · Tianyou Li
When processing the perf data file generated with multiple events, the flamegraph script will count all the events regardless of different event names. If specify the perf data file with -i option, the script will try to read the header information regardless of the file name specified, instead it will try to access the perf.data.
This patch tries to add a -e option to specify the event name that the flamegraph will be generated accordingly. If the -e option omitted, the behavior remains unchanged. If the -i option specified, the header information will be read from that file.
Looks like two separate changes. Can you please split them?
Thanks,
Namhyung
Quoted 59 lines
Signed-off-by Tianyou Li <[email protected]>Reviewed-by Pan Deng <[email protected]>Reviewed-by Zhiguo Zhou <[email protected]>Reviewed-by Wangyang Guo <[email protected]>Reviewed-by Tim Chen <[email protected]>--- tools/perf/scripts/python/flamegraph.py | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-)tools/perf/scripts/python/flamegraph.py +19
-2@@ -94,6 +94,11 @@ class FlameGraphCLI: return child def process_event(self, event): + # 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 + 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@@ -123,8 +128,15 @@ class FlameGraphCLI: return "" try: - output = subprocess.check_output(["perf", "report", "--header-only"]) - return output.decode("utf-8") + if self.args.input: + output = subprocess.check_output(["perf", "script", "--header-only", "-i", self.args.input]) + else: + output = subprocess.check_output(["perf", "report", "--header-only"]) + + result = output.decode("utf-8") + if self.args.event_name: + result += "\nFocused event: " + self.args.event_name + return result except Exception as err: # pylint: disable=broad-except print("Error reading report header: {}".format(err), file=sys.stderr) return ""@@ -235,6 +247,11 @@ if __name__ == "__main__": 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)Signature · 1 line
2.43.5
Hi Namhyung,
Thanks for your review and suggestions. I have split the patch into two patches. Please let me know if anything else is needed. Thanks.
Regards,
Tianyou
-----Original Message-----
From: Namhyung Kim <[email protected]>
Sent: Tuesday, June 10, 2025 9:20 AM
To: Li, Tianyou <[email protected]>
Cc: Peter Zijlstra <[email protected]>; Ingo Molnar <[email protected]>; Arnaldo Carvalho de Melo <[email protected]>; Mark Rutland <[email protected]>; Alexander Shishkin <[email protected]>; Jiri Olsa <[email protected]>; Ian Rogers <[email protected]>; Hunter, Adrian <[email protected]>; Kan Liang <[email protected]>; Guo, Wangyang <[email protected]>; Deng, Pan <[email protected]>; Zhou, Zhiguo <[email protected]>; Chen, Tim C <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH] Minor improvements for perf script flamegraph
Hello,
Quoted 10 lines · Tianyou Li
When processing the perf data file generated with multiple events, the flamegraph script will count all the events regardless of different event names. If specify the perf data file with -i option, the script will try to read the header information regardless of the file name specified, instead it will try to access the perf.data.
This patch tries to add a -e option to specify the event name that the flamegraph will be generated accordingly. If the -e option omitted, the behavior remains unchanged. If the -i option specified, the header information will be read from that file.
Looks like two separate changes. Can you please split them?
Thanks,
Namhyung
Quoted 63 lines
Signed-off-by Tianyou Li <[email protected]>Reviewed-by Pan Deng <[email protected]>Reviewed-by Zhiguo Zhou <[email protected]>Reviewed-by Wangyang Guo <[email protected]>Reviewed-by Tim Chen <[email protected]>--- tools/perf/scripts/python/flamegraph.py | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-)tools/perf/scripts/python/flamegraph.py +5
-0@@ -94,6 +94,11 @@ class FlameGraphCLI: return child def process_event(self, event): + # 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 + 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 oruser-space distinction @@ -123,8 +128,15 @@ class FlameGraphCLI:
return ""try:
tools/perf/scripts/python/flamegraph.py +16
-3- output = subprocess.check_output(["perf", "report", "--header-only"]) - return output.decode("utf-8") + if self.args.input: + output = subprocess.check_output(["perf", "script", "--header-only", "-i", self.args.input]) + else: + output = subprocess.check_output(["perf", "report", + "--header-only"]) + + result = output.decode("utf-8") + if self.args.event_name: + result += "\nFocused event: " + self.args.event_name + return result except Exception as err: # pylint: disable=broad-except print("Error reading report header: {}".format(err), file=sys.stderr) return ""@@ -235,6 +247,11 @@ if __name__ == "__main__": 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) --2.43.5