mirror of
https://github.com/torvalds/linux.git
synced 2026-11-10 17:11:02 +01:00
perf python: Port syscall-counts-by-pid to perf module
Port tools/perf/scripts/python/syscall-counts-by-pid.py to a standalone script in tools/perf/python/ using the perf module. Avoiding the embedded interpreter and per-event dictionary overhead improves execution speed by ~3.8x: ``` $ perf record -e raw_syscalls:sys_enter -a sleep 1 ... $ time perf script tools/perf/scripts/python/syscall-counts-by-pid.py perf ... real 0m3.852s user 0m3.512s sys 0m0.336s $ time python3 tools/perf/python/syscall-counts-by-pid.py perf ... real 0m1.011s user 0m0.963s sys 0m0.048s ``` Additional improvements compared to the legacy script: - Resolve architecture-specific syscall names via perf.syscall_name(id, session.e_machine) instead of host python-audit tables. - Support both raw_syscalls:sys_enter and individual syscalls:sys_enter_* tracepoints, and filter out invalid (> 0xffff or negative) syscall IDs. - Support filtering by numeric PID as well as command name (comm), and resolve process command names via session.find_thread(pid). Add a shell test (test_syscall_counts_by_pid_python.sh) to verify the standalone script. Assisted-by: Antigravity:gemini-3.1-pro Signed-off-by: Ian Rogers <irogers@google.com> Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
This commit is contained in:
parent
3d69731960
commit
712af96a53
112
tools/perf/python/syscall-counts-by-pid.py
Executable file
112
tools/perf/python/syscall-counts-by-pid.py
Executable file
|
|
@ -0,0 +1,112 @@
|
|||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: GPL-2.0
|
||||
"""
|
||||
Displays system-wide system call totals, broken down by syscall.
|
||||
If a [comm] arg is specified, only syscalls called by [comm] are displayed.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
from collections import defaultdict
|
||||
from typing import (Dict, Tuple)
|
||||
import perf
|
||||
|
||||
syscalls: Dict[Tuple[str, int, int], int] = defaultdict(int)
|
||||
for_comm = None
|
||||
for_pid = None
|
||||
session = None
|
||||
|
||||
|
||||
def print_syscall_totals():
|
||||
"""Print aggregated statistics."""
|
||||
if for_comm is not None:
|
||||
print(f"\nsyscall events for {for_comm}:\n")
|
||||
elif for_pid is not None:
|
||||
print(f"\nsyscall events for PID {for_pid}:\n")
|
||||
else:
|
||||
print("\nsyscall events:\n")
|
||||
|
||||
print(f"{'comm [pid]/syscalls':<40} {'count':>10}")
|
||||
print("---------------------------------------- -----------")
|
||||
|
||||
sorted_keys = sorted(syscalls.keys(), key=lambda k: (k[0], k[1], -syscalls[k], k[2]))
|
||||
current_comm_pid = None
|
||||
for comm, pid, sc_id in sorted_keys:
|
||||
if current_comm_pid != (comm, pid):
|
||||
print(f"\n{comm} [{pid}]")
|
||||
current_comm_pid = (comm, pid)
|
||||
e_machine = getattr(session, "e_machine", 0) or 0
|
||||
# Mask out the x86_64 x32 ABI bit (__X32_SYSCALL_BIT = 0x40000000) before
|
||||
# resolving the syscall number in the architecture's syscall table.
|
||||
raw_sc_id = sc_id & ~0x40000000
|
||||
if e_machine:
|
||||
name = perf.syscall_name(raw_sc_id, e_machine) or str(sc_id)
|
||||
else:
|
||||
name = perf.syscall_name(raw_sc_id) or str(sc_id)
|
||||
print(f" {name:<38} {syscalls[(comm, pid, sc_id)]:>10}")
|
||||
|
||||
|
||||
def process_event(sample):
|
||||
"""Process a single sample event."""
|
||||
event_name = str(sample.evsel)
|
||||
# Per-syscall syscalls:sys_enter_* tracepoints expose '__syscall_nr' (or 'nr')
|
||||
# and may have an unrelated syscall argument named 'id', whereas
|
||||
# raw_syscalls:sys_enter (and legacy pre-2.6.35 syscalls:sys_enter) expose 'id'.
|
||||
if event_name.startswith("evsel(syscalls:sys_enter_"):
|
||||
sc_id = getattr(sample, "__syscall_nr", None)
|
||||
if sc_id is not None and not (0 <= (sc_id & ~0x40000000) <= 0xffff):
|
||||
sc_id = None
|
||||
if sc_id is None:
|
||||
sc_id = getattr(sample, "nr", -1)
|
||||
elif event_name.startswith(("evsel(raw_syscalls:sys_enter", "evsel(syscalls:sys_enter")):
|
||||
sc_id = getattr(sample, "id", -1)
|
||||
if not (0 <= (sc_id & ~0x40000000) <= 0xffff):
|
||||
sc_id = getattr(sample, "__syscall_nr", -1)
|
||||
if not (0 <= (sc_id & ~0x40000000) <= 0xffff):
|
||||
sc_id = getattr(sample, "nr", -1)
|
||||
else:
|
||||
return
|
||||
|
||||
# Mask out __X32_SYSCALL_BIT (0x40000000) when validating the syscall ID range.
|
||||
if not (0 <= (sc_id & ~0x40000000) <= 0xffff):
|
||||
return
|
||||
|
||||
pid = sample.sample_pid
|
||||
|
||||
if for_pid is not None and pid != for_pid:
|
||||
return
|
||||
|
||||
comm = "unknown"
|
||||
try:
|
||||
if session:
|
||||
proc = session.find_thread(sample.sample_pid, sample.sample_tid)
|
||||
if proc:
|
||||
comm = proc.comm() or "unknown"
|
||||
except (TypeError, AttributeError):
|
||||
pass
|
||||
|
||||
if for_comm and comm != for_comm:
|
||||
return
|
||||
syscalls[(comm, pid, sc_id)] += 1
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
ap = argparse.ArgumentParser()
|
||||
ap.add_argument("filter", nargs="?", help="COMM or PID to filter by")
|
||||
ap.add_argument("-i", "--input", default="perf.data", help="Input file name")
|
||||
args = ap.parse_args()
|
||||
|
||||
if args.filter:
|
||||
try:
|
||||
for_pid = int(args.filter)
|
||||
except ValueError:
|
||||
for_comm = args.filter
|
||||
|
||||
try:
|
||||
session = perf.session(perf.data(args.input), sample=process_event)
|
||||
session.process_events()
|
||||
print_syscall_totals()
|
||||
finally:
|
||||
# Break the reference cycle between session and process_event (whose module
|
||||
# globals reference session) since perf.session lacks cyclic GC (tp_traverse).
|
||||
session = None
|
||||
92
tools/perf/tests/shell/test_syscall_counts_by_pid_python.sh
Executable file
92
tools/perf/tests/shell/test_syscall_counts_by_pid_python.sh
Executable file
|
|
@ -0,0 +1,92 @@
|
|||
#!/bin/bash
|
||||
# SPDX-License-Identifier: GPL-2.0
|
||||
# syscall-counts-by-pid python test
|
||||
|
||||
set -e
|
||||
|
||||
shelldir=$(dirname "$0")
|
||||
# shellcheck source=lib/setup_python.sh
|
||||
. "${shelldir}"/lib/setup_python.sh
|
||||
|
||||
# If we don't have the perf python module, we can't test
|
||||
if ! "$PYTHON" -c 'import perf' > /dev/null 2>&1; then
|
||||
echo "Skipping test, perf python module not found"
|
||||
exit 2
|
||||
fi
|
||||
|
||||
script_dir="$(dirname "$0")/../../python"
|
||||
script_path="${script_dir}/syscall-counts-by-pid.py"
|
||||
|
||||
if ! perf check feature -q libtraceevent > /dev/null 2>&1; then
|
||||
echo "Skipping test, libtraceevent is disabled"
|
||||
exit 2
|
||||
fi
|
||||
|
||||
if [ ! -f "$script_path" ]; then
|
||||
echo "Skipping test, syscall-counts-by-pid.py not found at $script_path"
|
||||
exit 2
|
||||
fi
|
||||
|
||||
err=0
|
||||
temp_data=""
|
||||
temp_out=""
|
||||
|
||||
cleanup() {
|
||||
rm -f "${temp_data}" "${temp_out}"
|
||||
}
|
||||
|
||||
trap 'cleanup' EXIT TERM INT
|
||||
|
||||
temp_data=$(mktemp /tmp/perf.data.XXXXXX)
|
||||
temp_out=$(mktemp /tmp/perf.out.XXXXXX)
|
||||
|
||||
test_file_mode() {
|
||||
echo "Testing syscall-counts-by-pid.py..."
|
||||
# Some systems might not have raw_syscalls:sys_enter
|
||||
if ! perf list | grep -q raw_syscalls:sys_enter; then
|
||||
echo "Skipping test, raw_syscalls:sys_enter not found"
|
||||
exit 2
|
||||
fi
|
||||
|
||||
# Generate some syscall events
|
||||
perf record -e raw_syscalls:sys_enter -a -o "${temp_data}" \
|
||||
-- sleep 0.5 >/dev/null 2>&1 || \
|
||||
{ echo "Skipping test, perf record failed"; exit 2; }
|
||||
|
||||
if ! "$PYTHON" "$script_path" -i "${temp_data}" > "${temp_out}"; then
|
||||
echo "File mode test failed."
|
||||
err=1
|
||||
elif ! grep -E -q "^ [a-zA-Z0-9_]+ +[0-9]+$" "${temp_out}"; then
|
||||
echo "File mode output validation failed."
|
||||
err=1
|
||||
else
|
||||
echo "File mode test passed."
|
||||
fi
|
||||
|
||||
# Test with a comm argument
|
||||
if ! "$PYTHON" "$script_path" -i "${temp_data}" "sleep" > "${temp_out}"; then
|
||||
echo "Comm filter test failed."
|
||||
err=1
|
||||
elif ! grep -E -q "^ [a-zA-Z0-9_]+ +[0-9]+$" "${temp_out}"; then
|
||||
echo "Comm filter output validation failed."
|
||||
err=1
|
||||
else
|
||||
echo "Comm filter test passed."
|
||||
fi
|
||||
|
||||
# Extract sleep PID from "sleep [<pid>]" header and test with a numeric PID filter argument
|
||||
sleep_pid=$(sed -n 's/^sleep \[\([0-9]\+\)\]$/\1/p' "${temp_out}" | head -n 1)
|
||||
if [ -z "${sleep_pid}" ] || ! "$PYTHON" "$script_path" -i "${temp_data}" "${sleep_pid}" > "${temp_out}"; then
|
||||
echo "PID filter test failed."
|
||||
err=1
|
||||
elif ! grep -E -q "^ [a-zA-Z0-9_]+ +[0-9]+$" "${temp_out}"; then
|
||||
echo "PID filter output validation failed."
|
||||
err=1
|
||||
else
|
||||
echo "PID filter test passed."
|
||||
fi
|
||||
}
|
||||
|
||||
test_file_mode
|
||||
|
||||
exit $err
|
||||
Loading…
Reference in New Issue
Block a user