Skip to content

Commit 46fe854

Browse files
[Docs][llvm-exegesis] Add documentation on recently added options (llvm#75408)
This patch adds information on the new LLVM-EXEGESIS-SNIPPET-ADDRESS annotation and on the --benchmark-repeat-count flag.
1 parent aa20767 commit 46fe854

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

llvm/docs/CommandGuide/llvm-exegesis.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,14 @@ properly.
8181
definition should start at. Note that a single memory definition can be
8282
mapped multiple times. Using this annotation requires the subprocess
8383
execution mode.
84+
* `LLVM-EXEGESIS-SNIPPET-ADDRESS <address>` - This annotation allows for
85+
setting the address where the beginning of the snippet to be executed will
86+
be mapped in at. The address is given in hexadecimal. Note that the snippet
87+
also includes setup code, so the instruction exactly at the specified
88+
address will not be the first instruction in the snippet. Using this
89+
annotation requires the subprocess execution mode. This is useful in
90+
cases where the memory accessed by the snippet depends on the location
91+
of the snippet, like RIP-relative addressing.
8492

8593
EXAMPLE 1: benchmarking instructions
8694
------------------------------------
@@ -425,6 +433,12 @@ OPTIONS
425433
features such as memory annotations but is currently restricted to X86-64
426434
on Linux.
427435

436+
.. option:: --benchmark-repeat-count=<repeat-count>
437+
438+
This option enables specifying the number of times to repeat the measurement
439+
when performing latency measurements. By default, llvm-exegesis will repeat
440+
a latency measurement enough times to balance run-time and noise reduction.
441+
428442
EXIT STATUS
429443
-----------
430444

0 commit comments

Comments
 (0)