linux/tools/perf/python/counting.py
Ian Rogers 4b15226c14 perf python: Improve perf script -l descriptions
Add module docstrings to counting.py, tracepoint.py, and twatch.py. This
satisfies pylint's missing-module-docstring check and prepares these
existing standalone scripts in tools/perf/python/ for the later commit
in this series ("perf script: Support standalone scripts and remove
embedded scripting"), which updates 'perf script -l' to scan
tools/perf/python/ and display each script's module docstring:

```
$ perf script -l
List of available scripts:
...
  counting
    Example for counting perf events.
...
  tracepoint
    Example showing how to enable a tracepoint and access its fields.
  twatch
    Example to show how to enable a software event and track
    context switches.
...
```

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>
2026-09-26 20:49:27 +02:00

38 lines
937 B
Python
Executable File

#!/usr/bin/env python3
# SPDX-License-Identifier: GPL-2.0
"""Example for counting perf events."""
# -*- python -*-
# -*- coding: utf-8 -*-
import argparse
import perf
def main(event: str):
evlist = perf.parse_events(event)
for evsel in evlist:
evsel.read_format = perf.FORMAT_TOTAL_TIME_ENABLED | perf.FORMAT_TOTAL_TIME_RUNNING
evlist.open()
evlist.enable()
count = 100000
while count > 0:
count -= 1
evlist.disable()
for evsel in evlist:
for cpu in evsel.cpus():
for thread in evsel.threads():
counts = evsel.read(cpu, thread)
print(f"For {evsel} val: {counts.val} enable: {counts.ena} run: {counts.run}")
evlist.close()
if __name__ == '__main__':
ap = argparse.ArgumentParser()
ap.add_argument('-e', '--event', help="Events to open", default="cpu-clock,task-clock")
args = ap.parse_args()
main(args.event)