Skip to content

Commit

Permalink
[Docs][llvm-exegesis] Specify platform support for different modes
Browse files Browse the repository at this point in the history
llvm-exegesis has both a capture mode and an analysis mode that can be
used independently of each other. This patch makes it clear that
analysis mode will work on other platforms that LLVM supports in the
documentation which was unclear before.

Reviewed By: courbet

Differential Revision: https://reviews.llvm.org/D150536
  • Loading branch information
boomanaiden154 committed May 16, 2023
1 parent 88a720d commit 05cca8a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
6 changes: 4 additions & 2 deletions llvm/docs/CommandGuide/llvm-exegesis.rst
Expand Up @@ -34,8 +34,10 @@ SUPPORTED PLATFORMS
-------------------

:program:`llvm-exegesis` currently only supports X86 (64-bit only), ARM (AArch64
only), MIPS, and PowerPC (PowerPC64LE only) on Linux. Not all functionality is
guaranteed to work on every platform.
only), MIPS, and PowerPC (PowerPC64LE only) on Linux for benchmarking. Not all
benchmarking functionality is guaranteed to work on every platform.
:program:`llvm-exegesis` also has a separate analysis mode that is supported
on every platform on which LLVM is.

SNIPPET ANNOTATIONS
-------------------
Expand Down
18 changes: 10 additions & 8 deletions llvm/tools/llvm-exegesis/README.md
Expand Up @@ -7,17 +7,19 @@ of performance counters.
### Currently Supported Platforms

`llvm-exegesis` is quite platform-dependent and currently only supports a couple
platform configurations.
platform configurations for benchmarking. The limitations are listed below.
Analysis mode in `llvm-exegesis` is supported on all platforms on which LLVM is.

##### Currently Supported Operating Systems
#### Currently Supported Operating Systems for Benchmarking

Currently, `llvm-exegesis` only supports Linux. This is mainly due to a
dependency on the Linux perf subsystem for reading performance counters.
Currently, `llvm-exegesis` only supports benchmarking on Linux. This is mainly
due to a dependency on the Linux perf subsystem for reading performance
counters.

##### Currently Supported Architectures

Currently, `llvm-exegesis` supports the following architectures:
#### Currently Supported Architectures for Benchmarking

Currently, using `llvm-exegesis` for benchmarking is supported on the following
architectures:
* x86
* 64-bit only due to this being the only implemented calling convention
in `llvm-exegesis` currently.
Expand All @@ -26,4 +28,4 @@ Currently, `llvm-exegesis` supports the following architectures:
* MIPS
* PowerPC (PowerPC64LE only)

Note that not all functionality is guaranteed to work on all architectures.
Note that not benchmarking functionality is guaranteed to work on all platforms.

0 comments on commit 05cca8a

Please sign in to comment.