Clang-tidy integrated into CMakeLists.txt
Can be called from the source directory with: utils/health/clang-tidy-run.sh
This commit is contained in:
mj-xmr
parent
4f401f6fca
commit
e591341237
|
|
@ -67,6 +67,20 @@ if (${CMAKE_VERSION} VERSION_GREATER "3.0.0" AND CMAKE_MAKE_PROGRAM MATCHES "nin
|
||||||
set_property(GLOBAL APPEND PROPERTY JOB_POOLS link_job_pool=${MONERO_PARALLEL_LINK_JOBS})
|
set_property(GLOBAL APPEND PROPERTY JOB_POOLS link_job_pool=${MONERO_PARALLEL_LINK_JOBS})
|
||||||
set(CMAKE_JOB_POOL_LINK link_job_pool)
|
set(CMAKE_JOB_POOL_LINK link_job_pool)
|
||||||
endif ()
|
endif ()
|
||||||
|
endif ()
|
||||||
|
|
||||||
|
option (USE_CLANG_TIDY_C "Lint the code with clang-tidy - variant C" OFF)
|
||||||
|
option (USE_CLANG_TIDY_CXX "Lint the code with clang-tidy - variant C++" OFF)
|
||||||
|
if (USE_CLANG_TIDY_C AND USE_CLANG_TIDY_CXX)
|
||||||
|
message(FATAL_ERROR "Enabling both USE_CLANG_TIDY_C and USE_CLANG_TIDY_CXX simultaneously crashes clang-tidy.")
|
||||||
|
endif()
|
||||||
|
if (USE_CLANG_TIDY_C OR USE_CLANG_TIDY_CXX)
|
||||||
|
include(SetClangTidy)
|
||||||
|
endif()
|
||||||
|
if (USE_CLANG_TIDY_C)
|
||||||
|
monero_clang_tidy("C")
|
||||||
|
elseif (USE_CLANG_TIDY_CXX)
|
||||||
|
monero_clang_tidy("CXX")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
enable_language(C ASM)
|
enable_language(C ASM)
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,72 @@
|
||||||
|
# Copyright (c) 2014-2020, The Monero Project
|
||||||
|
#
|
||||||
|
# All rights reserved.
|
||||||
|
#
|
||||||
|
# Redistribution and use in source and binary forms, with or without modification, are
|
||||||
|
# permitted provided that the following conditions are met:
|
||||||
|
#
|
||||||
|
# 1. Redistributions of source code must retain the above copyright notice, this list of
|
||||||
|
# conditions and the following disclaimer.
|
||||||
|
#
|
||||||
|
# 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
||||||
|
# of conditions and the following disclaimer in the documentation and/or other
|
||||||
|
# materials provided with the distribution.
|
||||||
|
#
|
||||||
|
# 3. Neither the name of the copyright holder nor the names of its contributors may be
|
||||||
|
# used to endorse or promote products derived from this software without specific
|
||||||
|
# prior written permission.
|
||||||
|
#
|
||||||
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
||||||
|
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||||
|
# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||||
|
# THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||||
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||||
|
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
||||||
|
# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
# https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_CLANG_TIDY.html
|
||||||
|
# This module sets the following variables:
|
||||||
|
# CMAKE_C_CLANG_TIDY
|
||||||
|
# CMAKE_CXX_CLANG_TIDY
|
||||||
|
# when clang-tidy is found in PATH. Afterwards, the code is being linted by the tool.
|
||||||
|
# The checks to be enabled can be manipulated with the variable MONERO_CLANG_TIDY_CHECKS
|
||||||
|
|
||||||
|
macro (monero_clang_tidy LANGUAGE)
|
||||||
|
set(TOOL_NAME "clang-tidy")
|
||||||
|
set(MONERO_CLANG_TIDY_MIN_VERSION "3.6")
|
||||||
|
if(${CMAKE_VERSION} VERSION_LESS "${MONERO_CLANG_TIDY_MIN_VERSION}")
|
||||||
|
message(FATAL_ERROR "Sorry, ${TOOL_NAME} is available for CMake from version ${MONERO_CLANG_TIDY_MIN_VERSION}")
|
||||||
|
else()
|
||||||
|
message(STATUS "Trying to enable ${TOOL_NAME}")
|
||||||
|
find_program(MONERO_CLANG_BIN ${TOOL_NAME})
|
||||||
|
if(NOT MONERO_CLANG_BIN)
|
||||||
|
message(FATAL_ERROR "${TOOL_NAME} not found! Try running: sudo apt install ${TOOL_NAME}")
|
||||||
|
else()
|
||||||
|
message(STATUS "Found ${MONERO_CLANG_BIN}")
|
||||||
|
set(MONERO_CLANG_TIDY_CHECKS
|
||||||
|
-header-filter=.; # By default the headers are excluded. This line enables them.
|
||||||
|
-checks=*; # Currently enabling all checks
|
||||||
|
# An example of selectively enabling checks:
|
||||||
|
#-checks=bugprone-*,cppcoreguidelines-avoid-goto # Have to be in one line :(
|
||||||
|
)
|
||||||
|
# Current list of checks is avaibale under:
|
||||||
|
# https://clang.llvm.org/extra/clang-tidy/
|
||||||
|
if (${LANGUAGE} STREQUAL "C")
|
||||||
|
set(CMAKE_C_CLANG_TIDY
|
||||||
|
${MONERO_CLANG_BIN}; # Mind the semicolon
|
||||||
|
${MONERO_CLANG_TIDY_CHECKS}
|
||||||
|
)
|
||||||
|
elseif (${LANGUAGE} STREQUAL "CXX")
|
||||||
|
set(CMAKE_CXX_CLANG_TIDY
|
||||||
|
${MONERO_CLANG_BIN}; # Mind the semicolon
|
||||||
|
${MONERO_CLANG_TIDY_CHECKS}
|
||||||
|
)
|
||||||
|
else()
|
||||||
|
message(FATAL_ERROR "${TOOL_NAME}: Unsupported language: ${LANGUAGE}")
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
endmacro()
|
||||||
|
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
#Intro
|
||||||
|
This directory contains tools, which can be used for checking the health of the project, like build/run time analyzers, lints, etc.
|
||||||
|
|
||||||
|
#Usage
|
||||||
|
Unless it's stated differently, these scripts should be called from a given source directory, where you want the checks to be performed, for instance:
|
||||||
|
|
||||||
|
`og@ghetto:~/dev/monero$ utils/health/clang-build-time-analyzer-run.sh`
|
||||||
|
|
||||||
|
##ClangBuildAnalyzer
|
||||||
|
`utils/health/clang-build-time-analyzer-run.sh`
|
||||||
|
The CBA helps in finding culprints of slow compilation.
|
||||||
|
On the first run, the script will complain about the missing ClangBuildAnalyzer binary and will point you to another script, which is able to clone and build the required binary.
|
||||||
|
|
||||||
|
##clang-tidy
|
||||||
|
`utils/health/clang-tidy-run.sh`
|
||||||
|
Performs Lint checks on the source code and stores the result in the build directory. More information on the [home page](https://clang.llvm.org/extra/clang-tidy/).
|
||||||
|
|
||||||
|
|
||||||
|
##Valgrind checks
|
||||||
|
`utils/health/valgrind-tests.sh`
|
||||||
|
This script is able to run valgrind's callgrind, cachegrind and memcheck for a given set of executables.
|
||||||
|
It expects ONE PARAMETER, which points to a file with paths to executables and their arguments, written line by line. For example:
|
||||||
|
|
||||||
|
```
|
||||||
|
ls -l -h
|
||||||
|
build/tests/unit_tests/unit_tests
|
||||||
|
```
|
||||||
|
|
||||||
|
The `*.out` results can be interpreted with the `kcachegrind` tool.
|
||||||
|
The memcheck output is just a readable text file with a summary at the end.
|
||||||
|
|
||||||
|
#Footer
|
||||||
|
Responsible: mj-xmr
|
||||||
|
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
#!/bin/bash -e
|
||||||
|
|
||||||
|
# Copyright (c) 2014-2020, The Monero Project
|
||||||
|
#
|
||||||
|
# All rights reserved.
|
||||||
|
#
|
||||||
|
# Redistribution and use in source and binary forms, with or without modification, are
|
||||||
|
# permitted provided that the following conditions are met:
|
||||||
|
#
|
||||||
|
# 1. Redistributions of source code must retain the above copyright notice, this list of
|
||||||
|
# conditions and the following disclaimer.
|
||||||
|
#
|
||||||
|
# 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
||||||
|
# of conditions and the following disclaimer in the documentation and/or other
|
||||||
|
# materials provided with the distribution.
|
||||||
|
#
|
||||||
|
# 3. Neither the name of the copyright holder nor the names of its contributors may be
|
||||||
|
# used to endorse or promote products derived from this software without specific
|
||||||
|
# prior written permission.
|
||||||
|
#
|
||||||
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
||||||
|
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||||
|
# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||||
|
# THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||||
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||||
|
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
||||||
|
# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
# clang-tidy runs lint checks on C & C++ sources and headers.
|
||||||
|
# Run this script from the source directory.
|
||||||
|
|
||||||
|
DIR_BUILD_BASE="build/clang-tidy"
|
||||||
|
RESULT_BASE="clang-tidy-result"
|
||||||
|
|
||||||
|
function tidy_for_language() {
|
||||||
|
LANG="${1}"
|
||||||
|
DIR_BUILD="${DIR_BUILD_BASE}-${LANG}"
|
||||||
|
RESULT="${RESULT_BASE}-${LANG}.txt"
|
||||||
|
|
||||||
|
mkdir -p "$DIR_BUILD" && pushd "$DIR_BUILD"
|
||||||
|
|
||||||
|
cmake ../.. \
|
||||||
|
-DCMAKE_C_COMPILER=clang \
|
||||||
|
-DCMAKE_CXX_COMPILER=clang++ \
|
||||||
|
-DUSE_CCACHE=ON \
|
||||||
|
-DUSE_CLANG_TIDY_${LANG}=ON \
|
||||||
|
-DBUILD_SHARED_LIBS=ON \
|
||||||
|
-DBUILD_TESTS=ON
|
||||||
|
|
||||||
|
make clean # Clean up, so that the result can be regenerated from scratch
|
||||||
|
time make -k 2>&1 | tee "$RESULT" # Build and store the result. -k means: ignore errors
|
||||||
|
#time make -k easylogging 2>&1 | tee "$RESULT" # Quick testing: build a single target
|
||||||
|
gzip -f "$RESULT" # Zip the result, because it's huge. -f overwrites the previously generated result
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "Readable result stored in: $DIR_BUILD/$RESULT.gz"
|
||||||
|
|
||||||
|
popd
|
||||||
|
}
|
||||||
|
|
||||||
|
tidy_for_language "C"
|
||||||
|
tidy_for_language "CXX"
|
||||||
|
|
||||||
Loading…
Reference in New Issue