[globalisel][tablegen] Generate rule coverage and use it to identify untested rules
authorDaniel Sanders <daniel_l_sanders@apple.com>
Thu, 16 Nov 2017 00:46:35 +0000 (00:46 +0000)
committerDaniel Sanders <daniel_l_sanders@apple.com>
Thu, 16 Nov 2017 00:46:35 +0000 (00:46 +0000)
commitf76f3154361169f5b074a05ce31e0a04bcadcde5
treef68950cb8890615f3f6eda663ece17e8d4dc87ec
parent8d8a8bb7eec62b0250a2e1f0d983f0191c1ba60f
[globalisel][tablegen] Generate rule coverage and use it to identify untested rules

Summary:
This patch adds a LLVM_ENABLE_GISEL_COV which, like LLVM_ENABLE_DAGISEL_COV,
causes TableGen to instrument the generated table to collect rule coverage
information. However, LLVM_ENABLE_GISEL_COV goes a bit further than
LLVM_ENABLE_DAGISEL_COV. The information is written to files
(${CMAKE_BINARY_DIR}/gisel-coverage-* by default). These files can then be
concatenated into ${LLVM_GISEL_COV_PREFIX}-all after which TableGen will
read this information and use it to emit warnings about untested rules.

This technique could also be used by SelectionDAG and can be further
extended to detect hot rules and give them priority over colder rules.

Usage:
* Enable LLVM_ENABLE_GISEL_COV in CMake
* Build the compiler and run some tests
* cat gisel-coverage-[0-9]* > gisel-coverage-all
* Delete lib/Target/*/*GenGlobalISel.inc*
* Build the compiler

Known issues:
* ${LLVM_GISEL_COV_PREFIX}-all must be generated as a manual
  step due to a lack of a portable 'cat' command. It should be the
  concatenation of all ${LLVM_GISEL_COV_PREFIX}-[0-9]* files.
* There's no mechanism to discard coverage information when the ruleset
  changes

Depends on D39742

Reviewers: ab, qcolombet, t.p.northover, aditya_nandakumar, rovka

Reviewed By: rovka

Subscribers: vsk, arsenm, nhaehnle, mgorny, kristof.beyls, javed.absar, igorb, llvm-commits

Differential Revision: https://reviews.llvm.org/D39747

llvm-svn: 318356
17 files changed:
llvm/CMakeLists.txt
llvm/cmake/modules/TableGen.cmake
llvm/include/llvm/CodeGen/GlobalISel/InstructionSelector.h
llvm/include/llvm/CodeGen/GlobalISel/InstructionSelectorImpl.h
llvm/include/llvm/Config/config.h.cmake
llvm/include/llvm/Support/CodeGenCoverage.h [new file with mode: 0644]
llvm/lib/CodeGen/GlobalISel/InstructionSelect.cpp
llvm/lib/Support/CMakeLists.txt
llvm/lib/Support/CodeGenCoverage.cpp [new file with mode: 0644]
llvm/lib/Target/AArch64/AArch64InstructionSelector.cpp
llvm/lib/Target/AMDGPU/AMDGPUInstructionSelector.cpp
llvm/lib/Target/AMDGPU/AMDGPUInstructionSelector.h
llvm/lib/Target/ARM/ARMInstructionSelector.cpp
llvm/lib/Target/X86/X86InstructionSelector.cpp
llvm/test/TableGen/GlobalISelEmitter.td
llvm/utils/TableGen/GlobalISelEmitter.cpp
llvm/utils/llvm-gisel-cov.py [new file with mode: 0644]