thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-15 03:53:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
1abcf26df6
ClickHouse/cmake/warnings.cmake

51 lines
2.3 KiB
CMake
Raw Normal View History

Enable extra warnings for base, utils, programs
2020-05-09 22:59:34 +00:00
# Our principle is to enable as many warnings as possible and always do it with "warnings as errors" flag.
#
# But it comes with some cost:
# - we have to disable some warnings in 3rd party libraries (they are located in "contrib" directory)
# - we have to include headers of these libraries as -isystem to avoid warnings from headers
# (this is the same behaviour as if these libraries were located in /usr/include)
# - sometimes warnings from 3rd party libraries may come from macro substitutions in our code
# and we have to wrap them with #pragma GCC/clang diagnostic ignored
Simplify: Move warnings stuff into cmake/warnings.cmake
2022-05-12 18:07:41 +00:00
set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra")
Enable extra warnings for base, utils, programs
2020-05-09 22:59:34 +00:00
Avoid too large stack frames
2020-06-08 17:35:45 +00:00
# Control maximum size of stack frames. It can be important if the code is run in fibers with small stack size.
Relax the limit
2020-08-02 21:10:57 +00:00
# Only in release build because debug has too large stack frames.
Fix CMake generation and build for native Xcode and AppleClang
2020-11-27 16:33:16 +00:00
if ((NOT CMAKE_BUILD_TYPE_UC STREQUAL "DEBUG") AND (NOT SANITIZE) AND (NOT CMAKE_CXX_COMPILER_ID MATCHES "AppleClang"))
ANTLR4 Grammar for ClickHouse and new parser (#11298)
2020-12-04 02:15:44 +00:00
add_warning(frame-larger-than=65536)
Relax the limit
2020-08-02 21:10:57 +00:00
endif ()
Avoid too large stack frames
2020-06-08 17:35:45 +00:00
Enable extra warnings for base, utils, programs
2020-05-09 22:59:34 +00:00
if (COMPILER_CLANG)
Update warnings.cmake
2022-05-20 00:12:44 +00:00
# Add some warnings that are not available even with -Wall -Wextra -Wpedantic.
# We want to get everything out of the compiler for code quality.
Throw option WEVERYTHING out WEVERYTHING enables on Clang literally every warning. People on the internet are divided if this is a good thing or not but ClickHouse compiles with -Weverything + some exceptions for noisy warnings since at least a year. I tried to build with WEVERYTHING = OFF and the build was badly broken. It seems nobody actually turns WEVERYTHING off. Actually, why would one if the CI builds (configured with WEVERYTHING = ON) potentially generate errors not generated in local development. To simplify the build scripts and to remove the need to maintain two sets of compiler warnings, I made WEVERYTHING the default and threw WEVERYTHING = OFF out.
2022-05-16 18:44:24 +00:00
add_warning(everything)
Enable extra warnings for base, utils, programs
2020-05-09 22:59:34 +00:00
add_warning(pedantic)
no_warning(zero-length-array)
Throw option WEVERYTHING out WEVERYTHING enables on Clang literally every warning. People on the internet are divided if this is a good thing or not but ClickHouse compiles with -Weverything + some exceptions for noisy warnings since at least a year. I tried to build with WEVERYTHING = OFF and the build was badly broken. It seems nobody actually turns WEVERYTHING off. Actually, why would one if the CI builds (configured with WEVERYTHING = ON) potentially generate errors not generated in local development. To simplify the build scripts and to remove the need to maintain two sets of compiler warnings, I made WEVERYTHING the default and threw WEVERYTHING = OFF out.
2022-05-16 18:44:24 +00:00
no_warning(c++98-compat-pedantic)
no_warning(c++98-compat)
Clean up constinit usage and add a comment
2022-08-11 11:27:53 +00:00
no_warning(c++20-compat) # Use constinit in C++20 without warnings
Fix 3/4 of trash
2022-09-10 02:34:56 +00:00
no_warning(sign-conversion)
no_warning(implicit-int-conversion)
no_warning(implicit-int-float-conversion)
Throw option WEVERYTHING out WEVERYTHING enables on Clang literally every warning. People on the internet are divided if this is a good thing or not but ClickHouse compiles with -Weverything + some exceptions for noisy warnings since at least a year. I tried to build with WEVERYTHING = OFF and the build was badly broken. It seems nobody actually turns WEVERYTHING off. Actually, why would one if the CI builds (configured with WEVERYTHING = ON) potentially generate errors not generated in local development. To simplify the build scripts and to remove the need to maintain two sets of compiler warnings, I made WEVERYTHING the default and threw WEVERYTHING = OFF out.
2022-05-16 18:44:24 +00:00
no_warning(ctad-maybe-unsupported) # clang 9+, linux-only
no_warning(disabled-macro-expansion)
no_warning(documentation-unknown-command)
no_warning(double-promotion)
no_warning(exit-time-destructors)
no_warning(float-equal)
no_warning(global-constructors)
no_warning(missing-prototypes)
no_warning(missing-variable-declarations)
no_warning(padded)
no_warning(switch-enum)
no_warning(undefined-func-template)
no_warning(unused-template)
no_warning(vla)
no_warning(weak-template-vtables)
no_warning(weak-vtables)
Support for Clang Thread Safety Analysis (TSA) - TSA is a static analyzer build by Google which finds race conditions and deadlocks at compile time. - It works by associating a shared member variable with a synchronization primitive that protects it. The compiler can then check at each access if proper locking happened before. A good introduction are [0] and [1]. - TSA requires some help by the programmer via annotations. Luckily, LLVM's libcxx already has annotations for std::mutex, std::lock_guard, std::shared_mutex and std::scoped_lock. This commit enables them (--> contrib/libcxx-cmake/CMakeLists.txt). - Further, this commit adds convenience macros for the low-level annotations for use in ClickHouse (--> base/defines.h). For demonstration, they are leveraged in a few places. - As we compile with "-Wall -Wextra -Weverything", the required compiler flag "-Wthread-safety-analysis" was already enabled. Negative checks are an experimental feature of TSA and disabled (--> cmake/warnings.cmake). Compile times did not increase noticeably. - TSA is used in a few places with simple locking. I tried TSA also where locking is more complex. The problem was usually that it is unclear which data is protected by which lock :-(. But there was definitely some weird code where locking looked broken. So there is some potential to find bugs. *** Limitations of TSA besides the ones listed in [1]: - The programmer needs to know which lock protects which piece of shared data. This is not always easy for large classes. - Two synchronization primitives used in ClickHouse are not annotated in libcxx: (1) std::unique_lock: A releaseable lock handle often together with std::condition_variable, e.g. in solve producer-consumer problems. (2) std::recursive_mutex: A re-entrant mutex variant. Its usage can be considered a design flaw + typically it is slower than a standard mutex. In this commit, one std::recursive_mutex was converted to std::mutex and annotated with TSA. - For free-standing functions (e.g. helper functions) which are passed shared data members, it can be tricky to specify the associated lock. This is because the annotations use the normal C++ rules for symbol resolution. [0] https://clang.llvm.org/docs/ThreadSafetyAnalysis.html [1] https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42958.pdf
2022-06-14 22:35:55 +00:00
no_warning(thread-safety-negative) # experimental flag, too many false positives
Support build with clang-16
2022-08-13 04:06:01 +00:00
no_warning(enum-constexpr-conversion) # breaks magic-enum library in clang-16
Update flags
2023-02-28 14:45:33 +00:00
no_warning(unsafe-buffer-usage) # too aggressive
Throw option WEVERYTHING out WEVERYTHING enables on Clang literally every warning. People on the internet are divided if this is a good thing or not but ClickHouse compiles with -Weverything + some exceptions for noisy warnings since at least a year. I tried to build with WEVERYTHING = OFF and the build was badly broken. It seems nobody actually turns WEVERYTHING off. Actually, why would one if the CI builds (configured with WEVERYTHING = ON) potentially generate errors not generated in local development. To simplify the build scripts and to remove the need to maintain two sets of compiler warnings, I made WEVERYTHING the default and threw WEVERYTHING = OFF out.
2022-05-16 18:44:24 +00:00
# TODO Enable conversion, sign-conversion, double-promotion warnings.
Enable extra warnings for base, utils, programs
2020-05-09 22:59:34 +00:00
endif ()
Reference in New Issue Copy Permalink