llvm-project/clang/test/Profile
Petr Hosek 7bdad08429 Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM"
This patch contains the basic functionality for reporting potentially
incorrect usage of __builtin_expect() by comparing the developer's
annotation against a collected PGO profile. A more detailed proposal and
discussion appears on the CFE-dev mailing list
(http://lists.llvm.org/pipermail/cfe-dev/2019-July/062971.html) and a
prototype of the initial frontend changes appear here in D65300

We revised the work in D65300 by moving the misexpect check into the
LLVM backend, and adding support for IR and sampling based profiles, in
addition to frontend instrumentation.

We add new misexpect metadata tags to those instructions directly
influenced by the llvm.expect intrinsic (branch, switch, and select)
when lowering the intrinsics. The misexpect metadata contains
information about the expected target of the intrinsic so that we can
check against the correct PGO counter when emitting diagnostics, and the
compiler's values for the LikelyBranchWeight and UnlikelyBranchWeight.
We use these branch weight values to determine when to emit the
diagnostic to the user.

A future patch should address the comment at the top of
LowerExpectIntrisic.cpp to hoist the LikelyBranchWeight and
UnlikelyBranchWeight values into a shared space that can be accessed
outside of the LowerExpectIntrinsic pass. Once that is done, the
misexpect metadata can be updated to be smaller.

In the long term, it is possible to reconstruct portions of the
misexpect metadata from the existing profile data. However, we have
avoided this to keep the code simple, and because some kind of metadata
tag will be required to identify which branch/switch/select instructions
are influenced by the use of llvm.expect

Patch By: paulkirth
Differential Revision: https://reviews.llvm.org/D66324

llvm-svn: 371635
2019-09-11 16:19:50 +00:00
..
Inputs Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
README
c-avoid-direct-call.c
c-captured.c [FileCheck] Add -allow-deprecated-dag-overlap to failing clang tests 2018-07-11 20:26:20 +00:00
c-counter-overflows.c
c-general.c [PGO] Fix buildbot failure in 359215 2019-04-25 21:16:41 +00:00
c-generate.c
c-indirect-call.c
c-linkage-available_externally.c
c-linkage.c
c-outdated-data.c [PGO] Detect more structural changes with the stable hash 2017-11-14 23:56:53 +00:00
c-ternary.c
c-unprofiled-blocks.c
c-unprofiled.c
c-unreachable-after-switch.c
cxx-abc-deleting-dtor.cpp [MS] Don't emit coverage for deleting dtors 2019-02-26 20:42:52 +00:00
cxx-class.cpp
cxx-hash-v2.cpp [PGO] Detect more structural changes with the stable hash 2017-11-14 23:56:53 +00:00
cxx-implicit.cpp
cxx-indirect-call.cpp
cxx-lambda.cpp Fix clang tests broken by r353547 that depend on InstrProf 2019-02-10 20:17:07 +00:00
cxx-linkage.cpp
cxx-missing-bodies.cpp
cxx-rangefor.cpp Fix clang tests broken by r353547 that depend on InstrProf 2019-02-10 20:17:07 +00:00
cxx-stmt-initializers.cpp Fix clang tests broken by r353547 that depend on InstrProf 2019-02-10 20:17:07 +00:00
cxx-structors.cpp
cxx-templates.cpp [InstrProf] Use separate comdat group for data and counters 2019-02-27 23:38:44 +00:00
cxx-throws.cpp Fix clang tests broken by r353547 that depend on InstrProf 2019-02-10 20:17:07 +00:00
cxx-virtual-destructor-calls.cpp Fix clang tests broken by r353547 that depend on InstrProf 2019-02-10 20:17:07 +00:00
def-assignop.cpp
def-ctors.cpp
def-dtors.cpp
func-entry.c
gcc-flag-compatibility.c [PGO] Fix bolt failures from r367628 2019-08-02 07:21:50 +00:00
misexpect-branch-cold.c Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
misexpect-branch-nonconst-expected-val.c Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
misexpect-branch-unpredictable.c Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
misexpect-branch.c Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
misexpect-switch-default.c Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
misexpect-switch-nonconst.c Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
misexpect-switch-only-default-case.c Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
misexpect-switch.c Reland "clang-misexpect: Profile Guided Validation of Performance Annotations in LLVM" 2019-09-11 16:19:50 +00:00
objc-general.m [PGO] Detect more structural changes with the stable hash 2017-11-14 23:56:53 +00:00
profile-does-not-exist.c
profile-summary.c

README

These are tests for instrumentation based profiling.  This specifically means
the -fprofile-instr-generate and -fprofile-instr-use driver flags.

Tests in this directory should usually test both:

  - the generation of instrumentation (-fprofile-instr-generate), and
  - the use of profile data from instrumented runs (-fprofile-instr-use).

In order to test -fprofile-instr-use without actually running an instrumented
program, .profdata files are checked into Inputs/.

The input source files must include a main function such that building with
-fprofile-instr-generate and running the resulting program generates the same
.profdata file that is consumed by the tests for -fprofile-instr-use.  Even
tests that only check -fprofile-instr-use should include such a main function,
so that profile data can be regenerated as the .profdata file format evolves.