Skip to content
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.

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

[Docs][llvm-exegesis] Add documentation on recently added options #75408

Merged

Conversation

boomanaiden154
Copy link
Contributor

This patch adds information on the new LLVM-EXEGESIS-SNIPPET-ADDRESS annotation and on the --benchmark-repeat-count flag.

This patch adds information on the new LLVM-EXEGESIS-SNIPPET-ADDRESS
annotation and on the --benchmark-repeat-count flag.
@llvmbot
Copy link
Collaborator

llvmbot commented Dec 14, 2023

@llvm/pr-subscribers-llvm-binary-utilities

Author: Aiden Grossman (boomanaiden154)

Changes

This patch adds information on the new LLVM-EXEGESIS-SNIPPET-ADDRESS annotation and on the --benchmark-repeat-count flag.


Full diff: https://github.com/llvm/llvm-project/pull/75408.diff

1 Files Affected:

  • (modified) llvm/docs/CommandGuide/llvm-exegesis.rst (+12)
diff --git a/llvm/docs/CommandGuide/llvm-exegesis.rst b/llvm/docs/CommandGuide/llvm-exegesis.rst
index 874bae82a1029a..a1c631e9687ba7 100644
--- a/llvm/docs/CommandGuide/llvm-exegesis.rst
+++ b/llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -81,6 +81,12 @@ properly.
   definition should start at. Note that a single memory definition can be
   mapped multiple times. Using this annotation requires the subprocess
   execution mode.
+* `LLVM-EXEGESIS-SNIPPET-ADDRESS <address>` - This annotation allows for
+  setting the address where the beginning of the snippet to be executed will
+  be mapped in at. The address is given in hexadecimal. Note that the snippet
+  also includes setup code, so the instruction exactly at the specified
+  address will not be the first instruction in the snippet. Using this
+  annotation requires the subprocess execution mode.
 
 EXAMPLE 1: benchmarking instructions
 ------------------------------------
@@ -425,6 +431,12 @@ OPTIONS
   features such as memory annotations but is currently restricted to X86-64
   on Linux.
 
+.. option:: --benchmark-repeat-count=<repeat-count>
+
+  This option enables specifying the number of times to repeat the benchmark
+  when performing latency benchmarks. By default, llvm-exegesis will repeat
+  a latency measurement 30 times and then aggregate the results.
+
 EXIT STATUS
 -----------
 

@boomanaiden154 boomanaiden154 merged commit 46fe854 into llvm:main Dec 14, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants