From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-dy1-f202.google.com (mail-dy1-f202.google.com [74.125.82.202]) (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 048CF3DA5A5 for ; Thu, 23 Apr 2026 03:57:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.202 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1776916647; cv=none; b=eyrzxmtfB/ll7bELQU5TvMzegGrcaGR8rToFwfQf7PYpdLl0R9GOKDCRss9soVktbMIE5k8MYovocNJruv5UzhyGKKrFaA9McnC/EeEmLt8yqGctR9ilO89MBBp+Utb9rCLRaCD7mqSTy0kTAE2+W0XGQ8PRwx+eHAazEn2YIxM= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1776916647; c=relaxed/simple; bh=uMcVqY3tLFf/EBgLaCY85EAcAR6+CrqpmehkhosaJ6A=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=OmLi6FbjhGi9RWBtMs9njlyVjznatDD/URldjdiRu8FgDflMhEXXCZq4cLvUfSvNiyHYmP3eM9STxfg6758OeC8AI9RjPx2SY5P96a9vCvkLVNRfXG/bohyW2t5gJ634H9U9wpimUEdOqiy5h+tpUrqIiQOed1+N4X5UVSejwkA= 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=tvDJcDha; arc=none smtp.client-ip=74.125.82.202 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="tvDJcDha" Received: by mail-dy1-f202.google.com with SMTP id 5a478bee46e88-2ba8013a9e3so6541188eec.0 for ; Wed, 22 Apr 2026 20:57:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1776916644; x=1777521444; 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=kptrmifDisWizsrGAKahHsaLZwGfXMmsel5Fko6HAYA=; b=tvDJcDhaHTKQ4bbL2QWBiXO+D0Jla5H1noGllQBY4mTYyokj9Aamu8ZDAvJ9MsF9J4 QCcFdetszc6WSBR8dG48/JHKEi1EY5nS3/T0i2xVCf6+6ZY+C+TQSh1x4dnSReXl3IMh emPKIGCHThB4t1Sf6pdnPzRPrAiYEdejOd44wzeBKw8mf+kWdjr2h5KKy6JzFwamqgT7 BYtJ4oroA//4RLUDjnDZhmDujXa27qheHzMjkXsQ0UjGYlyA614a2jOrVn5nMvQ3uMbJ Ztu7xv6E+NTsVCZP52ULTERaSGJswhJynQrE06HCUAdAE2q6IYWTbslZf5Nw5v795OH6 li2w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1776916644; x=1777521444; 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=kptrmifDisWizsrGAKahHsaLZwGfXMmsel5Fko6HAYA=; b=pOcfq+5aqEm5RPHi0J9IoGa81JPfzEyNmHAXCi7CPe8obZk+h2r8NTmODKBj/3Cc0e IfxzGpCgqMr57e8ofS1vzgZTNjcVxv/SCeQXowNEnmZAVMu9jZPVZPfFfD3+aNQjZ7mF T+Gf/UYA1cJ8Lztgfm4BCq/68EjdmfgHyxBrDef2/y/QwOVZ2EE+e6D2Ypsd5YIzIDuz xIDWXy1dcOJxG15upaB4x2nTG82+VqM7RNYTl9ftKKuoxHGZ+SjFxEcnJHOiSxus0skG MrDkRrEzs2ToxE8LWVsuQ62XecFwp2NdJAruMvJnXVziLchDTgKCK6PkhK+pSrkAhVTE /IMQ== X-Forwarded-Encrypted: i=1; AFNElJ9TYMl19bjVcSKA9Ogep9gBI0utDLezWB7nFaGdzVY5kcSygqlbf678K3VLtLXL8QJFI++Ui+f+JWVjicLrseTd@vger.kernel.org X-Gm-Message-State: AOJu0YyERRPURQjtY05/T5UjIZzfdLyFDnS09/mJ8kHpil4StvfvZMoR bb6sr/qLDjjG7684DAfjWvX3JY3fc1yiYFsPv5+FM8ynjTQoDjCaVjAaXp8p3iu8kAuf1VUUcf0 daanqBgb9yw== X-Received: from dlbcy15.prod.google.com ([2002:a05:7022:b8f:b0:12d:bef6:56f4]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a05:7022:f9c:b0:12b:f899:7185 with SMTP id a92af1059eb24-12c73f99df1mr13405246c88.16.1776916643844; Wed, 22 Apr 2026 20:57:23 -0700 (PDT) Date: Wed, 22 Apr 2026 20:55:17 -0700 In-Reply-To: <20260423035526.1537178-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: <20260419235911.2186050-27-irogers@google.com> <20260423035526.1537178-1-irogers@google.com> X-Mailer: git-send-email 2.54.0.rc2.533.g4f5dca5207-goog Message-ID: <20260423035526.1537178-51-irogers@google.com> Subject: [PATCH v2 50/58] perf rwtop: Port rwtop to use python module From: Ian Rogers To: irogers@google.com, acme@kernel.org, adrian.hunter@intel.com, james.clark@linaro.org, leo.yan@linux.dev, namhyung@kernel.org, tmricht@linux.ibm.com Cc: 9erthalion6@gmail.com, adityab1@linux.ibm.com, alexandre.chartre@oracle.com, alice.mei.rogers@gmail.com, ankur.a.arora@oracle.com, ashelat@redhat.com, atrajeev@linux.ibm.com, blakejones@google.com, changbin.du@huawei.com, chuck.lever@oracle.com, collin.funk1@gmail.com, coresight@lists.linaro.org, ctshao@google.com, dapeng1.mi@linux.intel.com, derek.foreman@collabora.com, dsterba@suse.com, gautam@linux.ibm.com, howardchu95@gmail.com, john.g.garry@oracle.com, jolsa@kernel.org, jonathan.cameron@huawei.com, justinstitt@google.com, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org, mike.leach@arm.com, mingo@redhat.com, morbo@google.com, nathan@kernel.org, nichen@iscas.ac.cn, nick.desaulniers+lkml@gmail.com, pan.deng@intel.com, peterz@infradead.org, ravi.bangoria@amd.com, ricky.ringler@proton.me, stephen.s.brennan@oracle.com, sun.jian.kdev@gmail.com, suzuki.poulose@arm.com, swapnil.sapkal@amd.com, tanze@kylinos.cn, terrelln@fb.com, thomas.falcon@intel.com, tianyou.li@intel.com, tycho@kernel.org, wangyang.guo@intel.com, xiaqinxin@huawei.com, yang.lee@linux.alibaba.com, yuzhuo@google.com, zhiguo.zhou@intel.com, zli94@ncsu.edu Content-Type: text/plain; charset="UTF-8" Port the legacy Perl script rwtop.pl to a python script using the perf module in tools/perf/python. The new script uses a class-based architecture and leverages the perf.session API for event processing. It periodically displays system-wide r/w call activity, broken down by PID, refreshed every interval. Complications: - Implemented periodic display based on event timestamps (sample.sample_time) instead of relying on SIGALRM, making it robust for file-based processing. - Used ANSI escape codes (\x1b[H\x1b[2J) to clear the terminal. - Fixed unused imports and indentation issues identified by pylint. - pylint warns about the module name not being snake_case, but it is kept for consistency with the original script name. Assisted-by: Gemini:gemini-3.1-pro-preview Signed-off-by: Ian Rogers --- v2: - Added Live Session Support: Updated main() to start a LiveSession when the input file does not exist (or is the default "perf.data" and doesn't exist). It traces read and write entry/exit tracepoints. - Fixed Live Mode Comm Resolution: Fixed a bug in process_event() where it would attempt to use self.session to resolve the command name when running in live mode (where self.session is None ). It now falls back to f"PID({pid})" when in live mode or if resolution fails. - Fixed Substring Matching: Replaced loose substring checks like if "sys_enter_read" in event_name: with exact matches against "evsel(syscalls:sys_enter_read)" and "evsel(raw_syscalls:sys_enter_read)" using str(sample.evsel) . This prevents unrelated syscalls with similar names (like readv or readahead ) from being incorrectly aggregated. Similar fixes were applied for exit events and write events. - Inlined Handlers and Tracked Errors: Inlined the _handle_sys_* helper methods into process_event() . Now, if a sample lacks expected fields, it is added to the self.unhandled tracker instead of being silently ignored. - Fixed Write Byte Counting: Updated the write exit handler to use sample.ret to count actual bytes written on success, and tracked requested bytes separately in the enter handler, matching the read behavior. - Added Error Tables to Output: Added tables to display failed reads and writes by PID in print_totals() , which were previously tracked but never displayed. - Fixed Offline Output (Ghosting): Removed the hardcoded ANSI clear-screen escape codes in print_totals() , as they corrupted output when processing offline trace files at CPU speed or when piping the output. - Code Cleanup: Fixed a bug where fd was printed instead of pid in the read counts table, and broke long lines to satisfy pylint. --- tools/perf/python/rwtop.py | 219 +++++++++++++++++++++++++++++++++++++ 1 file changed, 219 insertions(+) create mode 100755 tools/perf/python/rwtop.py diff --git a/tools/perf/python/rwtop.py b/tools/perf/python/rwtop.py new file mode 100755 index 000000000000..952d178e99c5 --- /dev/null +++ b/tools/perf/python/rwtop.py @@ -0,0 +1,219 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0-only +"""Periodically displays system-wide r/w call activity, broken down by pid.""" + +import argparse +from collections import defaultdict +import os +import sys +from typing import Optional, Dict, Any +import perf +from perf_live import LiveSession + +class RwTop: + """Periodically displays system-wide r/w call activity.""" + def __init__(self, interval: int = 3, nlines: int = 20) -> None: + self.interval_ns = interval * 1000000000 + self.nlines = nlines + self.reads: Dict[int, Dict[str, Any]] = defaultdict( + lambda: { + "bytes_requested": 0, + "bytes_read": 0, + "total_reads": 0, + "comm": "", + "errors": defaultdict(int), + } + ) + self.writes: Dict[int, Dict[str, Any]] = defaultdict( + lambda: { + "bytes_requested": 0, + "bytes_written": 0, + "total_writes": 0, + "comm": "", + "errors": defaultdict(int), + } + ) + self.unhandled: Dict[str, int] = defaultdict(int) + self.session: Optional[perf.session] = None + self.last_print_time: int = 0 + + def process_event(self, sample: perf.sample_event) -> None: # pylint: disable=too-many-branches + """Process events.""" + event_name = str(sample.evsel) + pid = sample.sample_pid + sample_time = sample.sample_time + + if self.last_print_time == 0: + self.last_print_time = sample_time + + # Check if interval has passed + if sample_time - self.last_print_time >= self.interval_ns: + self.print_totals() + self.last_print_time = sample_time + + try: + comm = f"PID({pid})" if not self.session else self.session.process(pid).comm() + except Exception: # pylint: disable=broad-except + comm = f"PID({pid})" + + if event_name in ("evsel(syscalls:sys_enter_read)", "evsel(raw_syscalls:sys_enter_read)"): + try: + count = sample.count + self.reads[pid]["bytes_requested"] += count + self.reads[pid]["total_reads"] += 1 + self.reads[pid]["comm"] = comm + except AttributeError: + self.unhandled[event_name] += 1 + elif event_name in ("evsel(syscalls:sys_exit_read)", "evsel(raw_syscalls:sys_exit_read)"): + try: + ret = sample.ret + if ret > 0: + self.reads[pid]["bytes_read"] += ret + else: + self.reads[pid]["errors"][ret] += 1 + except AttributeError: + self.unhandled[event_name] += 1 + elif event_name in ("evsel(syscalls:sys_enter_write)", + "evsel(raw_syscalls:sys_enter_write)"): + try: + count = sample.count + self.writes[pid]["bytes_requested"] += count + self.writes[pid]["total_writes"] += 1 + self.writes[pid]["comm"] = comm + except AttributeError: + self.unhandled[event_name] += 1 + elif event_name in ("evsel(syscalls:sys_exit_write)", "evsel(raw_syscalls:sys_exit_write)"): + try: + ret = sample.ret + if ret > 0: + self.writes[pid]["bytes_written"] += ret + else: + self.writes[pid]["errors"][ret] += 1 + except AttributeError: + self.unhandled[event_name] += 1 + else: + self.unhandled[event_name] += 1 + + def print_totals(self) -> None: + """Print summary tables.""" + print("read counts by pid:\n") + print( + f"{'pid':>6s} {'comm':<20s} {'# reads':>10s} " + f"{'bytes_req':>10s} {'bytes_read':>10s}" + ) + print(f"{'-'*6} {'-'*20} {'-'*10} {'-'*10} {'-'*10}") + + count = 0 + for pid, data in sorted(self.reads.items(), + key=lambda kv: kv[1]["bytes_read"], reverse=True): + print( + f"{pid:6d} {data['comm']:<20s} {data['total_reads']:10d} " + f"{data['bytes_requested']:10d} {data['bytes_read']:10d}" + ) + count += 1 + if count >= self.nlines: + break + + print("\nfailed reads by pid:\n") + print(f"{'pid':>6s} {'comm':<20s} {'error #':>6s} {'# errors':>10s}") + print(f"{'-'*6} {'-'*20} {'-'*6} {'-'*10}") + + errcounts = [] + for pid, data in self.reads.items(): + for error, cnt in data["errors"].items(): + errcounts.append((pid, data["comm"], error, cnt)) + + sorted_errcounts = sorted(errcounts, key=lambda x: x[3], reverse=True) + for pid, comm, error, cnt in sorted_errcounts[:self.nlines]: + print(f"{pid:6d} {comm:<20s} {error:6d} {cnt:10d}") + + print("\nwrite counts by pid:\n") + print( + f"{'pid':>6s} {'comm':<20s} {'# writes':>10s} " + f"{'bytes_req':>10s} {'bytes_written':>13s}" + ) + print(f"{'-'*6} {'-'*20} {'-'*10} {'-'*10} {'-'*13}") + + count = 0 + for pid, data in sorted(self.writes.items(), + key=lambda kv: kv[1]["bytes_written"], reverse=True): + print( + f"{pid:6d} {data['comm']:<20s} {data['total_writes']:10d} " + f"{data['bytes_requested']:10d} {data['bytes_written']:13d}" + ) + count += 1 + if count >= self.nlines: + break + + print("\nfailed writes by pid:\n") + print(f"{'pid':>6s} {'comm':<20s} {'error #':>6s} {'# errors':>10s}") + print(f"{'-'*6} {'-'*20} {'-'*6} {'-'*10}") + + errcounts = [] + for pid, data in self.writes.items(): + for error, cnt in data["errors"].items(): + errcounts.append((pid, data["comm"], error, cnt)) + + sorted_errcounts = sorted(errcounts, key=lambda x: x[3], reverse=True) + for pid, comm, error, cnt in sorted_errcounts[:self.nlines]: + print(f"{pid:6d} {comm:<20s} {error:6d} {cnt:10d}") + + # Reset counts + self.reads.clear() + self.writes.clear() + + def run(self, input_file: str) -> None: + """Run the session.""" + self.session = perf.session(perf.data(input_file), sample=self.process_event) + self.session.process_events() + + # Print final totals if there are any left + if self.reads or self.writes: + self.print_totals() + + if self.unhandled: + print("\nunhandled events:\n") + print(f"{'event':<40s} {'count':>10s}") + print(f"{'-'*40} {'-'*10}") + for event_name, count in self.unhandled.items(): + print(f"{event_name:<40s} {count:10d}") + +def main() -> None: + """Main function.""" + parser = argparse.ArgumentParser(description="Trace r/w activity by PID") + parser.add_argument( + "interval", type=int, nargs="?", default=3, help="Refresh interval in seconds" + ) + parser.add_argument("-i", "--input", default="perf.data", help="Input file") + args = parser.parse_args() + + analyzer = RwTop(args.interval) + try: + if not os.path.exists(args.input) and args.input == "perf.data": + # Live mode + events = ( + "syscalls:sys_enter_read,syscalls:sys_exit_read," + "syscalls:sys_enter_write,syscalls:sys_exit_write" + ) + try: + live_session = LiveSession(events, sample_callback=analyzer.process_event) + except OSError: + events = ( + "raw_syscalls:sys_enter_read,raw_syscalls:sys_exit_read," + "raw_syscalls:sys_enter_write,raw_syscalls:sys_exit_write" + ) + live_session = LiveSession(events, sample_callback=analyzer.process_event) + print("Live mode started. Press Ctrl+C to stop.", file=sys.stderr) + live_session.run() + else: + analyzer.run(args.input) + except IOError as e: + print(e, file=sys.stderr) + sys.exit(1) + except KeyboardInterrupt: + print("\nStopping live mode...", file=sys.stderr) + if analyzer.reads or analyzer.writes: + analyzer.print_totals() + +if __name__ == "__main__": + main() -- 2.54.0.rc2.533.g4f5dca5207-goog