Implement sanitizer support via CMake (#822)

Fixes #302

CMake/CheckCompiler.cmake

@@ -1,15 +1,42 @@
 if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
-  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 14)
-    message(FATAL_ERROR "Clang 14+ required for building clio")
-  endif()
+  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 14)
+    message (FATAL_ERROR "Clang 14+ required for building clio")
+  endif ()
+  set (is_clang TRUE)
 elseif (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
-  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 14)
-    message(FATAL_ERROR "AppleClang 14+ required for building clio")
-  endif()
+  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 14)
+    message (FATAL_ERROR "AppleClang 14+ required for building clio")
+  endif ()
+  set (is_appleclang TRUE)
 elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 11)
-    message(FATAL_ERROR "GCC 11+ required for building clio")
-  endif()
-else()
-  message(FATAL_ERROR "Supported compilers: AppleClang 14+, Clang 14+, GCC 11+")
-endif()
+  if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 11)
+    message (FATAL_ERROR "GCC 11+ required for building clio")
+  endif ()
+  set (is_gcc TRUE)
+else ()
+  message (FATAL_ERROR "Supported compilers: AppleClang 14+, Clang 14+, GCC 11+")
+endif ()
+
+if (san)
+  string (TOLOWER ${san} san)
+  set (SAN_FLAG "-fsanitize=${san}")
+  set (SAN_LIB "")
+  if (is_gcc)
+    if (san STREQUAL "address")
+      set (SAN_LIB "asan")
+    elseif (san STREQUAL "thread")
+      set (SAN_LIB "tsan")
+    elseif (san STREQUAL "memory")
+      set (SAN_LIB "msan")
+    elseif (san STREQUAL "undefined")
+      set (SAN_LIB "ubsan")
+    endif ()
+  endif ()
+  set (_saved_CRL ${CMAKE_REQUIRED_LIBRARIES})
+  set (CMAKE_REQUIRED_LIBRARIES "${SAN_FLAG};${SAN_LIB}")
+  CHECK_CXX_COMPILER_FLAG (${SAN_FLAG} COMPILER_SUPPORTS_SAN)
+  set (CMAKE_REQUIRED_LIBRARIES ${_saved_CRL})
+  if (NOT COMPILER_SUPPORTS_SAN)
+    message (FATAL_ERROR "${san} sanitizer does not seem to be supported by your compiler")
+  endif ()
+endif ()

CMake/ClioVersion.cmake

@@ -2,32 +2,32 @@
    write version to source
 #]===================================================================]
 
-find_package(Git REQUIRED)
+find_package (Git REQUIRED)
 
-set(GIT_COMMAND rev-parse --short HEAD)
-execute_process(COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} OUTPUT_VARIABLE REV OUTPUT_STRIP_TRAILING_WHITESPACE)
+set (GIT_COMMAND rev-parse --short HEAD)
+execute_process (COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} OUTPUT_VARIABLE REV OUTPUT_STRIP_TRAILING_WHITESPACE)
 
-set(GIT_COMMAND branch --show-current)
-execute_process(COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} OUTPUT_VARIABLE BRANCH OUTPUT_STRIP_TRAILING_WHITESPACE)
+set (GIT_COMMAND branch --show-current)
+execute_process (COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} OUTPUT_VARIABLE BRANCH OUTPUT_STRIP_TRAILING_WHITESPACE)
 
-if(BRANCH STREQUAL "")
-  set(BRANCH "dev")
-endif()
+if (BRANCH STREQUAL "")
+  set (BRANCH "dev")
+endif ()
 
-if(NOT (BRANCH MATCHES master OR BRANCH MATCHES release/*)) # for develop and any other branch name YYYYMMDDHMS-<branch>-<git-ref>
-  execute_process(COMMAND date +%Y%m%d%H%M%S OUTPUT_VARIABLE DATE OUTPUT_STRIP_TRAILING_WHITESPACE)
-  set(VERSION "${DATE}-${BRANCH}-${REV}")
-else()
-  set(GIT_COMMAND describe --tags)
-  execute_process(COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} OUTPUT_VARIABLE TAG_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
-  set(VERSION "${TAG_VERSION}-${REV}")
-endif()
+if (NOT (BRANCH MATCHES master OR BRANCH MATCHES release/*)) # for develop and any other branch name YYYYMMDDHMS-<branch>-<git-ref>
+  execute_process (COMMAND date +%Y%m%d%H%M%S OUTPUT_VARIABLE DATE OUTPUT_STRIP_TRAILING_WHITESPACE)
+  set (VERSION "${DATE}-${BRANCH}-${REV}")
+else ()
+  set (GIT_COMMAND describe --tags)
+  execute_process (COMMAND ${GIT_EXECUTABLE} ${GIT_COMMAND} OUTPUT_VARIABLE TAG_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
+  set (VERSION "${TAG_VERSION}-${REV}")
+endif ()
 
-if(CMAKE_BUILD_TYPE MATCHES Debug)
-  set(VERSION "${VERSION}+DEBUG")
-endif()
+if (CMAKE_BUILD_TYPE MATCHES Debug)
+  set (VERSION "${VERSION}+DEBUG")
+endif ()
 
-message(STATUS "Build version: ${VERSION}")
-set(clio_version "${VERSION}")
+message (STATUS "Build version: ${VERSION}")
+set (clio_version "${VERSION}")
 
-configure_file(CMake/Build.cpp.in ${CMAKE_SOURCE_DIR}/src/main/impl/Build.cpp)
+configure_file (CMake/Build.cpp.in ${CMAKE_SOURCE_DIR}/src/main/impl/Build.cpp)

CMake/Coverage.cmake

@@ -1,48 +1,45 @@
 # call add_coverage(module_name) to add coverage targets for the given module
-function(add_coverage module)
-  if("${CMAKE_C_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang"
+function (add_coverage module)
+  if ("${CMAKE_C_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang"
      OR "${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
-    message("[Coverage] Building with llvm Code Coverage Tools")
+    message ("[Coverage] Building with llvm Code Coverage Tools")
     # Using llvm gcov ; llvm install by xcode
-    set(LLVM_COV_PATH /Library/Developer/CommandLineTools/usr/bin)
-    if(NOT EXISTS ${LLVM_COV_PATH}/llvm-cov)
-      message(FATAL_ERROR "llvm-cov not found! Aborting.")
-    endif()
+    set (LLVM_COV_PATH /Library/Developer/CommandLineTools/usr/bin)
+    if (NOT EXISTS ${LLVM_COV_PATH}/llvm-cov)
+      message (FATAL_ERROR "llvm-cov not found! Aborting.")
+    endif ()
 
     # set Flags
-    target_compile_options(${module} PRIVATE 
+    target_compile_options (${module} PRIVATE 
       -fprofile-instr-generate
       -fcoverage-mapping)
     
-    target_link_options(${module} PUBLIC 
+    target_link_options (${module} PUBLIC 
       -fprofile-instr-generate
       -fcoverage-mapping)
 
-    target_compile_options(clio PRIVATE 
+    target_compile_options (clio PRIVATE 
       -fprofile-instr-generate
       -fcoverage-mapping)
     
-    target_link_options(clio PUBLIC 
+    target_link_options (clio PUBLIC 
       -fprofile-instr-generate
       -fcoverage-mapping)
 
     # llvm-cov
-    add_custom_target(
-      ${module}-ccov-preprocessing
+    add_custom_target (${module}-ccov-preprocessing
       COMMAND LLVM_PROFILE_FILE=${module}.profraw $<TARGET_FILE:${module}>
       COMMAND ${LLVM_COV_PATH}/llvm-profdata merge -sparse ${module}.profraw -o
               ${module}.profdata
       DEPENDS ${module})
 
-    add_custom_target(
-      ${module}-ccov-show
+    add_custom_target (${module}-ccov-show
       COMMAND ${LLVM_COV_PATH}/llvm-cov show $<TARGET_FILE:${module}>
               -instr-profile=${module}.profdata -show-line-counts-or-regions
       DEPENDS ${module}-ccov-preprocessing)
 
     # add summary for CI parse
-    add_custom_target(
-      ${module}-ccov-report
+    add_custom_target (${module}-ccov-report
       COMMAND
         ${LLVM_COV_PATH}/llvm-cov report $<TARGET_FILE:${module}>
         -instr-profile=${module}.profdata
@@ -51,8 +48,7 @@ function(add_coverage module)
       DEPENDS ${module}-ccov-preprocessing)
 
     # exclude libs and unittests self
-    add_custom_target(
-      ${module}-ccov
+    add_custom_target (${module}-ccov
       COMMAND
         ${LLVM_COV_PATH}/llvm-cov show $<TARGET_FILE:${module}>
         -instr-profile=${module}.profdata -show-line-counts-or-regions
@@ -60,37 +56,36 @@ function(add_coverage module)
         -ignore-filename-regex=".*_makefiles|.*unittests|.*_deps" > /dev/null 2>&1
       DEPENDS ${module}-ccov-preprocessing)
 
-    add_custom_command(
+    add_custom_command (
       TARGET ${module}-ccov
       POST_BUILD
       COMMENT
         "Open ${module}-llvm-cov/index.html in your browser to view the coverage report."
     )
-  elseif("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR "${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU")
-    message("[Coverage] Building with Gcc Code Coverage Tools")
+  elseif ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR "${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU")
+    message ("[Coverage] Building with Gcc Code Coverage Tools")
 
-    find_program(GCOV_PATH gcov)
-    if(NOT GCOV_PATH)
-      message(FATAL_ERROR "gcov not found! Aborting...")
-    endif() # NOT GCOV_PATH
-    find_program(GCOVR_PATH gcovr)
-    if(NOT GCOVR_PATH)
-      message(FATAL_ERROR "gcovr not found! Aborting...")
-    endif() # NOT GCOVR_PATH
+    find_program (GCOV_PATH gcov)
+    if (NOT GCOV_PATH)
+      message (FATAL_ERROR "gcov not found! Aborting...")
+    endif () # NOT GCOV_PATH
+    find_program (GCOVR_PATH gcovr)
+    if (NOT GCOVR_PATH)
+      message (FATAL_ERROR "gcovr not found! Aborting...")
+    endif () # NOT GCOVR_PATH
 
-    set(COV_OUTPUT_PATH ${module}-gcc-cov)
-    target_compile_options(${module} PRIVATE -fprofile-arcs -ftest-coverage
+    set (COV_OUTPUT_PATH ${module}-gcc-cov)
+    target_compile_options (${module} PRIVATE -fprofile-arcs -ftest-coverage
                                              -fPIC)
-    target_link_libraries(${module} PRIVATE gcov)
+    target_link_libraries (${module} PRIVATE gcov)
 
-    target_compile_options(clio PRIVATE -fprofile-arcs -ftest-coverage
+    target_compile_options (clio PRIVATE -fprofile-arcs -ftest-coverage
                                              -fPIC)
-    target_link_libraries(clio PRIVATE gcov)
+    target_link_libraries (clio PRIVATE gcov)
     # this target is used for CI as well generate the summary out.xml will send
     # to github action to generate markdown, we can paste it to comments or
     # readme
-    add_custom_target(
-      ${module}-ccov
+    add_custom_target (${module}-ccov
       COMMAND ${module} ${TEST_PARAMETER}
       COMMAND rm -rf ${COV_OUTPUT_PATH}
       COMMAND mkdir ${COV_OUTPUT_PATH}
@@ -107,8 +102,7 @@ function(add_coverage module)
       COMMENT "Running gcovr to produce Cobertura code coverage report.")
 
     # generate the detail report
-    add_custom_target(
-      ${module}-ccov-report
+    add_custom_target (${module}-ccov-report
       COMMAND ${module} ${TEST_PARAMETER}
       COMMAND rm -rf ${COV_OUTPUT_PATH}
       COMMAND mkdir ${COV_OUTPUT_PATH}
@@ -119,13 +113,13 @@ function(add_coverage module)
         --exclude='${PROJECT_BINARY_DIR}/'
       WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
       COMMENT "Running gcovr to produce Cobertura code coverage report.")
-    add_custom_command(
+    add_custom_command (
       TARGET ${module}-ccov-report
       POST_BUILD
       COMMENT
         "Open ${COV_OUTPUT_PATH}/index.html in your browser to view the coverage report."
     )
-  else()
-    message(FATAL_ERROR "Complier not support yet")
-  endif()
-endfunction()
+  else ()
+    message (FATAL_ERROR "Complier not support yet")
+  endif ()
+endfunction ()

CMake/Docs.cmake

@@ -1,10 +1,10 @@
-find_package(Doxygen REQUIRED)
+find_package (Doxygen REQUIRED)
 
-set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
-set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+set (DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
+set (DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
-configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
-add_custom_target(docs
+configure_file (${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+add_custom_target (docs
     COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     COMMENT "Generating API documentation with Doxygen"

CMake/Settings.cmake

@@ -1,4 +1,4 @@
-target_compile_options(clio PUBLIC
+target_compile_options (clio PUBLIC
   -Wall
   -Werror
   -Wno-narrowing

CMake/SourceLocation.cmake

@@ -1,11 +1,11 @@
-include(CheckIncludeFileCXX)
+include (CheckIncludeFileCXX)
 
-check_include_file_cxx("source_location" SOURCE_LOCATION_AVAILABLE)
-if(SOURCE_LOCATION_AVAILABLE) 
-    target_compile_definitions(clio PUBLIC "HAS_SOURCE_LOCATION")
-endif()
+check_include_file_cxx ("source_location" SOURCE_LOCATION_AVAILABLE)
+if (SOURCE_LOCATION_AVAILABLE) 
+    target_compile_definitions (clio PUBLIC "HAS_SOURCE_LOCATION")
+endif ()
 
-check_include_file_cxx("experimental/source_location" EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)
-if(EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)     
-    target_compile_definitions(clio PUBLIC "HAS_EXPERIMENTAL_SOURCE_LOCATION")
-endif()
+check_include_file_cxx ("experimental/source_location" EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)
+if (EXPERIMENTAL_SOURCE_LOCATION_AVAILABLE)     
+    target_compile_definitions (clio PUBLIC "HAS_EXPERIMENTAL_SOURCE_LOCATION")
+endif ()

CMake/deps/Boost.cmake

@@ -1,7 +1,7 @@
-set(Boost_USE_STATIC_LIBS ON)
-set(Boost_USE_STATIC_RUNTIME ON)
+set (Boost_USE_STATIC_LIBS ON)
+set (Boost_USE_STATIC_RUNTIME ON)
 
-find_package(Boost 1.82 REQUIRED
+find_package (Boost 1.82 REQUIRED
   COMPONENTS
     program_options
     coroutine

CMake/deps/OpenSSL.cmake

@@ -1,5 +1,5 @@
-find_package(OpenSSL 1.1.1 REQUIRED)
+find_package (OpenSSL 1.1.1 REQUIRED)
 
-set_target_properties(OpenSSL::SSL PROPERTIES
+set_target_properties (OpenSSL::SSL PROPERTIES
   INTERFACE_COMPILE_DEFINITIONS OPENSSL_NO_SSL2
 )

CMake/deps/Threads.cmake

@@ -1,2 +1,2 @@
-set(THREADS_PREFER_PTHREAD_FLAG ON)
-find_package(Threads)
+set (THREADS_PREFER_PTHREAD_FLAG ON)
+find_package (Threads)

CMake/deps/cassandra.cmake

@@ -1 +1 @@
-find_package(cassandra-cpp-driver REQUIRED)
+find_package (cassandra-cpp-driver REQUIRED)

CMake/deps/gtest.cmake

@@ -1,4 +1,4 @@
-find_package(GTest REQUIRED)
+find_package (GTest REQUIRED)
 
-enable_testing()
-include(GoogleTest)
+enable_testing ()
+include (GoogleTest)

CMake/deps/libfmt.cmake

@@ -1 +1 @@
-find_package(fmt REQUIRED)
+find_package (fmt REQUIRED)

CMake/deps/libxrpl.cmake

@@ -1 +1 @@
-find_package(xrpl REQUIRED)
+find_package (xrpl REQUIRED)

CMake/install/install.cmake

@@ -1,16 +1,14 @@
-set(CLIO_INSTALL_DIR "/opt/clio")
-set(CMAKE_INSTALL_PREFIX ${CLIO_INSTALL_DIR})
+set (CLIO_INSTALL_DIR "/opt/clio")
+set (CMAKE_INSTALL_PREFIX ${CLIO_INSTALL_DIR})
 
-install(TARGETS clio_server DESTINATION bin)
-# install(TARGETS clio_tests DESTINATION bin) # NOTE: Do we want to install the tests?
+install (TARGETS clio_server DESTINATION bin)
 
-#install(FILES example-config.json DESTINATION etc RENAME config.json)
-file(READ example-config.json config)
-string(REGEX REPLACE "./clio_log" "/var/log/clio/" config "${config}")
-file(WRITE ${CMAKE_BINARY_DIR}/install-config.json "${config}")
-install(FILES ${CMAKE_BINARY_DIR}/install-config.json DESTINATION etc RENAME config.json)
+file (READ example-config.json config)
+string (REGEX REPLACE "./clio_log" "/var/log/clio/" config "${config}")
+file (WRITE ${CMAKE_BINARY_DIR}/install-config.json "${config}")
+install (FILES ${CMAKE_BINARY_DIR}/install-config.json DESTINATION etc RENAME config.json)
 
-configure_file("${CMAKE_SOURCE_DIR}/CMake/install/clio.service.in" "${CMAKE_BINARY_DIR}/clio.service")
+configure_file ("${CMAKE_SOURCE_DIR}/CMake/install/clio.service.in" "${CMAKE_BINARY_DIR}/clio.service")
 
-install(FILES "${CMAKE_BINARY_DIR}/clio.service" DESTINATION /lib/systemd/system)
+install (FILES "${CMAKE_BINARY_DIR}/clio.service" DESTINATION /lib/systemd/system)