Skip to content

Perf fix _get_available_events #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Perf fix _get_available_events #231

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ec1692
fix _get_available_events
matsvanmolle May 2, 2025
119e4e7
cleanup
matsvanmolle May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 68 additions & 38 deletions benchkit/commandwrappers/perf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,86 +111,116 @@ def _validate_record_data_dir(record_data_dir: PathType) -> None:
@cache
def _get_available_events(
perf_bin: PathType,
) -> Tuple[List[PerfEvent], Dict[str, Dict[PerfEvent, str]]]:
) -> Tuple[List[str], Dict[str, Dict[str, str]]]:
from subprocess import check_output

def shell_out(command, print_input=False, print_output=False):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be no reason to create another version of shell_out.
What was the reasoning behind this?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than this, I see nothing wrong with the commit but I do hope that Ubuntu and other os quickly update their perf version, as somewhere in V6 they added the option to just output perf list to a JSON.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aaronbog As you can see, the code you are referring to is outdated. It was there for debugging purposes, but I initially forgot to remove it. This was removed with 119e4e7.

return check_output(command, shell=True, text=True)

raw_output = shell_out(
command=f"{perf_bin} list --no-desc",
print_input=False,
print_output=False,
)
events = []
events_dict = {}

events: List[str] = []
events_dict: Dict[str, Dict[str, str]] = {}
current_group = "no_group"
events_dict[current_group] = {}

iterlines = iter(raw_output.splitlines())
event_id = None

for line in iterlines:
sline = line.strip()

m = re.match(pattern=r"^([-_/:A-Za-z0-9\s]+):$", string=sline)
if m is not None:
# New group section (e.g., 'hwmon:')
m = re.match(r"^([-_/:A-Za-z0-9\s]+):$", sline)
if m:
(group_name,) = m.groups()
current_group = group_name
events_dict[current_group] = {}
continue

m = re.match(pattern=r"([-_/:.a-zA-Z0-9]+)\s+\[(.*)\]", string=sline)
if m is not None:
event_id, event_desc = m.groups()
events.append(event_id)
events_dict[current_group][event_id] = event_desc
continue

m = re.match(
pattern=r"([-_/:.a-zA-Z0-9]+)\s+OR\s+([-_/:.a-zA-Z0-9]+)\s*\[(.*)\]",
string=sline,
)
if m is not None:
# event OR alias [description] (all on one line)
m = re.match(r"([-_/:.a-zA-Z0-9]+)\s+OR\s+([-_/:.a-zA-Z0-9]+)\s*\[(.*)\]", sline)
if m:
event_left, event_right, event_desc = m.groups()
events.append(event_left)
events.append(event_right)
events.extend([event_left, event_right])
events_dict[current_group][event_left] = event_desc
events_dict[current_group][event_right] = event_desc
continue

m = re.match(pattern=r"(^[-_/:.a-zA-Z0-9]+)$", string=sline)
if m is not None:
# event OR alias (description is on next line)
m = re.match(r"([-_/:.a-zA-Z0-9]+)\s+OR\s+([-_/:.a-zA-Z0-9]+)$", sline)
if m:
event_left, event_right = m.groups()
events.extend([event_left, event_right])
event_id = (event_left, event_right)
continue

# event [description] (canonical case)
m = re.match(r"([-_/:.a-zA-Z0-9]+)\s+\[(.*)\]", sline)
if m:
event_id, event_desc = m.groups()
events.append(event_id)
events_dict[current_group][event_id] = event_desc
continue

# Single event name only (description may follow)
m = re.match(r"(^[-_/:.a-zA-Z0-9]+)$", sline)
if m:
(event_id,) = m.groups()
events.append(event_id)
continue

m = re.match(pattern=r"^\[(.*)\]$", string=sline)
if m is not None:
# Description line in brackets (follows previous event_id)
m = re.match(r"^\[(.*)\]$", sline)
if m:
(event_desc,) = m.groups()
if event_id is not None:
# use event_id set at the previous iteration
if isinstance(event_id, tuple):
for eid in event_id:
events_dict[current_group][eid] = event_desc
elif event_id:
events_dict[current_group][event_id] = event_desc
continue

m = re.match(pattern=r"^\[(.*)$", string=sline)
if m is not None:
# Opened bracket, starts multi-line desc
m = re.match(r"^\[(.*)$", sline)
if m:
(event_desc,) = m.groups()
if event_id is not None:
# use event_id set at the previous iteration
if isinstance(event_id, tuple):
for eid in event_id:
events_dict[current_group][eid] = event_desc
elif event_id:
events_dict[current_group][event_id] = event_desc
continue
m = re.match(pattern=r"^\s+(.*)\]$", string=line)
if m is not None:

# Continuation of multi-line description (closing)
m = re.match(r"^\s+(.*)\]$", line)
if m:
(event_desc,) = m.groups()
if event_id is not None:
# use event_id set at the previous iteration (description over 2 lines)
if isinstance(event_id, tuple):
for eid in event_id:
events_dict[current_group][eid] += " " + event_desc
elif event_id:
events_dict[current_group][event_id] += " " + event_desc
continue
m = re.match(pattern=r"^\s+(.*)$", string=line)
if m is not None:

# Continuation of multi-line description (middle)
m = re.match(r"^\s+(.*)$", line)
if m:
(event_desc,) = m.groups()
if event_id is not None:
# use event_id set at the previous iteration (description over 3 lines)
if event_id not in events_dict:
if isinstance(event_id, tuple):
for eid in event_id:
events_dict[current_group][eid] += " " + event_desc
elif event_id:
if event_id not in events_dict[current_group]:
events_dict[current_group][event_id] = ""
events_dict[current_group][event_id] += " " + event_desc
continue

# Skip known unstructured lines
if "[Raw hardware event descriptor]" in sline:
continue
if "[Hardware breakpoint]" in sline:
Expand Down