[llvm] 0c1f620 - [Docs][llvm-exegesis] Add documentation on validation counters option (#82132)

[via llvm-commits]

Author: Aiden Grossman
Date: 2024-02-19T01:39:01-08:00
New Revision: 0c1f62073fd48f7dcf16f8dc38d825bb211745d4

URL: https://github.com/llvm/llvm-project/commit/0c1f62073fd48f7dcf16f8dc38d825bb211745d4
DIFF: https://github.com/llvm/llvm-project/commit/0c1f62073fd48f7dcf16f8dc38d825bb211745d4.diff

LOG: [Docs][llvm-exegesis] Add documentation on validation counters option (#82132)

This patch documents the --validation-counter flag.

Added: 
    

Modified: 
    llvm/docs/CommandGuide/llvm-exegesis.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/llvm-exegesis.rst b/llvm/docs/CommandGuide/llvm-exegesis.rst
index 601082a78f1e2e..9e3c19078f1cce 100644
--- a/llvm/docs/CommandGuide/llvm-exegesis.rst
+++ b/llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -443,6 +443,17 @@ OPTIONS
   when performing latency measurements. By default, llvm-exegesis will repeat
   a latency measurement enough times to balance run-time and noise reduction.
 
+.. option:: --validation-counter=[instructions-retired,l1d-cache-load-misses,
+   l1d-cache-store-misses,l1i-cache-load-misses,data-tlb-load-misses,
+   data-tld-store-misses,instruction-tlb-load-misses]
+
+   This option enables the use of validation counters, which measure additional
+   microarchitectural events like cache misses to validate snippet execution
+   conditions. These events are measured using the perf subsystem in a group
+   with the performance counter used to measure the value of interest. This
+   flag can be specified multiple times to measure multiple events. The maximum
+   number of validation counters is platform dependent.
+
 EXIT STATUS
 -----------