Skip to content

Commit 792510f

Browse files
committed
[llvm-mca][docs] clarify how the quality of the perf report is affected by the quality of the scheduling models.
Differential Revision: https://reviews.llvm.org/D63556 llvm-svn: 363830
1 parent 1f6ddfb commit 792510f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

llvm/docs/CommandGuide/llvm-mca.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ Or for Intel syntax:
3838
3939
$ clang foo.c -O2 -target x86_64-unknown-unknown -mllvm -x86-asm-syntax=intel -S -o - | llvm-mca -mcpu=btver2
4040
41+
Scheduling models are not just used to compute instruction latencies and
42+
throughput, but also to understand what processor resources are available
43+
and how to simulate them.
44+
45+
By design, the quality of the analysis conducted by :program:`llvm-mca` is
46+
inevitably affected by the quality of the scheduling models in LLVM.
47+
48+
If you see that the performance report is not accurate for a processor,
49+
please `file a bug <https://bugs.llvm.org/enter_bug.cgi?product=libraries>`_
50+
against the appropriate backend.
51+
4152
OPTIONS
4253
-------
4354

0 commit comments

Comments
 (0)