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

[Aiden Grossman via llvm-commits]

https://github.com/boomanaiden154 created https://github.com/llvm/llvm-project/pull/82132

This patch documents the --validation-counter flag.

>From 7f757c5a4534009864d94cd0da8a01d0164fe27d Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Sat, 17 Feb 2024 21:16:57 +0000
Subject: [PATCH] [Docs][llvm-exegesis] Add documentation on validation
 counters option

This patch documents the --validation-counter flag.
---
 llvm/docs/CommandGuide/llvm-exegesis.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

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
 -----------