[PATCH] D149378: [Docs][llvm-exegesis] Specify supported platforms and architectures

[Aiden Grossman via Phabricator via llvm-commits]

aidengrossman updated this revision to Diff 518138.
aidengrossman added a comment.

Update.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D149378/new/

https://reviews.llvm.org/D149378

Files:
  llvm/docs/CommandGuide/llvm-exegesis.rst
  llvm/tools/llvm-exegesis/README.md


Index: llvm/tools/llvm-exegesis/README.md
===================================================================
--- /dev/null
+++ llvm/tools/llvm-exegesis/README.md
@@ -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.
Index: llvm/docs/CommandGuide/llvm-exegesis.rst
===================================================================
--- llvm/docs/CommandGuide/llvm-exegesis.rst
+++ llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -30,6 +30,13 @@
 :program:`llvm-exegesis` can also benchmark arbitrary user-provided code
 snippets.
 
+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.
+
 SNIPPET ANNOTATIONS
 -------------------
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D149378.518138.patch
Type: text/x-patch
Size: 1704 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230429/eeb5ac2a/attachment.bin>