-
Notifications
You must be signed in to change notification settings - Fork 11.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs][llvm-exegesis] Specify supported platforms and architectures
Currently, there is no documentation on what platforms and architectures llvm-exegesis is supported on. This patch adds in user-facing documentation in the CommandGuide about what architectures are supported as well as developer facing documentation detailing the technical reasons for why certain platforms are supported and some aren't. This is a follow-up after discussion in https://discourse.llvm.org/t/clarification-on-platform-support-for-llvm-exegesis/70206. Reviewed By: kpdev42 Differential Revision: https://reviews.llvm.org/D149378
- Loading branch information
1 parent
88c1242
commit 9fe45fc
Showing
2 changed files
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# llvm-exegesis | ||
|
||
`llvm-exegesis` is a benchmarking tool that accepts or assembles a snippet and | ||
can measure characteristics of that snippet by executing it while keeping track | ||
of performance counters. | ||
|
||
### Currently Supported Platforms | ||
|
||
`llvm-exegesis` is quite platform-dependent and currently only supports a couple | ||
platform configurations. | ||
|
||
##### Currently Supported Operating Systems | ||
|
||
Currently, `llvm-exegesis` only supports 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: | ||
|
||
* x86 | ||
* 64-bit only due to this being the only implemented calling convention | ||
in `llvm-exegesis` currently. | ||
* ARM | ||
* AArch64 only | ||
* MIPS | ||
* PowerPC (PowerPC64LE only) | ||
|
||
Note that not all functionality is guaranteed to work on all architectures. |