Skip to content

Commit

Permalink
Updated documenatation with instructions on PMU usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Mani-D committed Jul 4, 2024
1 parent 5b1859b commit ae7a6f5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,11 @@ In reports with multiple benchmarks, the reference benchmark can be change by us

## Hardware performance counters <a name="pmc"></a>

Xpedite uses linux perf events api to program and collect hardware performance counters in the cpu.
To enable this feature, ensure cpu level event access is permitted for the current user running Xpedite.
Cpu level event access for all users can be enabled by setting /proc/sys/kernel/perf_event_paranoid to a value <=0.
More details can found at perf_event_paranoid section of the linux kernel documentation [here](https://www.kernel.org/doc/Documentation/sysctl/kernel.txt)

Xpedite can collect any of the core and offcore hardware performance counters, for bottleneck or topdown analysis.
The list of counters supported, depends on processor's micro architecture and can be listed by running ```xpedite list```

Expand Down
9 changes: 9 additions & 0 deletions ko/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# Xpedite kernel module is deprecated

Xpedite no longer requires kernel module to use hardware performance counters.
Xpedite now uses perf events api to program and collect PMU data from user space.

For more details checkout the section on "Hardware performance counters" in Xpedite readme docs.



# Xpedite kernel module

Xpedite provides a minimalistic kernel module to support programming and collection of performance counters from user space.
Expand Down

0 comments on commit ae7a6f5

Please sign in to comment.