From 397b92e02dbe7996a9da14aac73003fc8ddd1674 Mon Sep 17 00:00:00 2001 From: dundargoc Date: Sat, 7 Oct 2023 15:07:45 +0200 Subject: [PATCH] build: enable ASAN for MSVC It is enabled with ENABLE_ASAN_UBSAN like other compilers. Technically it only enables ASAN as UBSAN is not available, meaning to make the variable names fully correct we'd need to separate it into two checks: ENABLE_ASAN and ENABLE_UBSAN, but the convenience of combining them into the same flag outweighs the theoretical correctness. Also note in CONTRIBUTING.md that debug builds in ASAN is not supported. Technically it is the debug runtime that is not supported, which cmake automatically enables when using the debug build type. However, neovim can't be built with debug builds without linking to the debug runtime since the third party libraries has likely been linked to the debug runtime if it was built with debug build type. This technicality is likely uninteresting to the potential developer and it's easier to just say to use a release build type. --- CMakeLists.txt | 6 ------ CONTRIBUTING.md | 3 ++- src/nvim/CMakeLists.txt | 23 +++++++++++++---------- 3 files changed, 15 insertions(+), 17 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index a360c6043f..a7b7ef9c0f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -157,12 +157,6 @@ if((ENABLE_ASAN_UBSAN AND ENABLE_MSAN) message(FATAL_ERROR "Sanitizers cannot be enabled simultaneously") endif() -if(ENABLE_ASAN_UBSAN OR ENABLE_MSAN OR ENABLE_TSAN) - if(NOT CMAKE_C_COMPILER_ID MATCHES "Clang" AND NOT CMAKE_C_COMPILER_ID MATCHES "GNU") - message(FATAL_ERROR "Sanitizers are only supported for Clang and GCC") - endif() -endif() - # Place targets in bin/ or lib/ for all build configurations set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2128b3af13..c39f6db5d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -125,7 +125,8 @@ Each pull request must pass the automated builds on [Cirrus CI] and [GitHub Acti - If any tests fail, the build will fail. See [test/README.md#running-tests][run-tests] to run tests locally. - CI runs [ASan] and other analyzers. - To run valgrind locally: `VALGRIND=1 make test` - - To run Clang ASan/UBSan locally: `CC=clang make CMAKE_FLAGS="-DENABLE_ASAN_UBSAN=ON"` + - To run ASan/UBSan locally: `CC=clang make CMAKE_FLAGS="-DENABLE_ASAN_UBSAN=ON"`. + Note that MSVC requires Release or RelWithDebInfo build type to work properly. - The [lint](#lint) build checks modified lines _and their immediate neighbors_, to encourage incrementally updating the legacy style to meet our [style](#style). (See [#3174][3174] for background.) diff --git a/src/nvim/CMakeLists.txt b/src/nvim/CMakeLists.txt index 71e99538c7..e881214f40 100644 --- a/src/nvim/CMakeLists.txt +++ b/src/nvim/CMakeLists.txt @@ -764,17 +764,20 @@ target_link_libraries(libnvim PRIVATE main_lib PUBLIC libuv) if(ENABLE_ASAN_UBSAN) message(STATUS "Enabling address sanitizer and undefined behavior sanitizer for nvim.") - if(CI_BUILD) - # Try to recover from all sanitize issues so we get reports about all failures - target_compile_options(nvim PRIVATE -fsanitize-recover=all) - else() - target_compile_options(nvim PRIVATE -fno-sanitize-recover=all) + if(NOT MSVC) + if(CI_BUILD) + # Try to recover from all sanitize issues so we get reports about all failures + target_compile_options(nvim PRIVATE -fsanitize-recover=all) + else() + target_compile_options(nvim PRIVATE -fno-sanitize-recover=all) + endif() + target_compile_options(nvim PRIVATE + -fno-omit-frame-pointer + -fno-optimize-sibling-calls + -fsanitize=undefined) endif() - target_compile_options(nvim PRIVATE - -fno-omit-frame-pointer - -fno-optimize-sibling-calls - -fsanitize=address - -fsanitize=undefined) + + target_compile_options(nvim PRIVATE -fsanitize=address) target_link_libraries(nvim PRIVATE -fsanitize=address -fsanitize=undefined) target_compile_definitions(nvim PRIVATE ENABLE_ASAN_UBSAN) elseif(ENABLE_MSAN)