summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CommandGuide
diff options
context:
space:
mode:
authorAndrea Di Biagio <Andrea_DiBiagio@sn.scee.net>2019-06-19 16:10:58 +0000
committerAndrea Di Biagio <Andrea_DiBiagio@sn.scee.net>2019-06-19 16:10:58 +0000
commit792510f86949b9c14c2f26843f612e96ffbf82ec (patch)
tree6289feb6f0ee782c109c13567990490f08350940 /llvm/docs/CommandGuide
parent1f6ddfb6a359e8459d2fae8d7a908de03a727c05 (diff)
downloadbcm5719-llvm-792510f86949b9c14c2f26843f612e96ffbf82ec.tar.gz
bcm5719-llvm-792510f86949b9c14c2f26843f612e96ffbf82ec.zip
[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
Diffstat (limited to 'llvm/docs/CommandGuide')
-rw-r--r--llvm/docs/CommandGuide/llvm-mca.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/llvm/docs/CommandGuide/llvm-mca.rst b/llvm/docs/CommandGuide/llvm-mca.rst
index d8c3b57207c..847a043fe7a 100644
--- a/llvm/docs/CommandGuide/llvm-mca.rst
+++ b/llvm/docs/CommandGuide/llvm-mca.rst
@@ -38,6 +38,17 @@ Or for Intel syntax:
$ clang foo.c -O2 -target x86_64-unknown-unknown -mllvm -x86-asm-syntax=intel -S -o - | llvm-mca -mcpu=btver2
+Scheduling models are not just used to compute instruction latencies and
+throughput, but also to understand what processor resources are available
+and how to simulate them.
+
+By design, the quality of the analysis conducted by :program:`llvm-mca` is
+inevitably affected by the quality of the scheduling models in LLVM.
+
+If you see that the performance report is not accurate for a processor,
+please `file a bug <https://bugs.llvm.org/enter_bug.cgi?product=libraries>`_
+against the appropriate backend.
+
OPTIONS
-------
OpenPOWER on IntegriCloud