cmake: add support for sanitizers

problem: using address or other sanitizers is currently very manual and
error prone

solution: add support into the build system to select appropriate
sanitizers and link them in.  This uses an external project which has
been pulled in as a git subtree (NOT a submodule, it's a single squashed
out commit that pulls in the directory).

Author: trws

CMakeLists.txt

@@ -36,7 +36,6 @@ if("${isSystemDir}" STREQUAL "-1")
   set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
 endif("${isSystemDir}" STREQUAL "-1")
 
-
 # Setting the include directory for the application to find config.h
 include_directories( ${CMAKE_BINARY_DIR} )
 # Since we have created a config.h add a global define for it
@@ -46,11 +45,12 @@ add_definitions( "-DPACKAGE_VERSION=\"${FLUX_SCHED_VER}\"" )
 # We build a lot of shared libs, build them all with PIC
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
-# variable to store paths to add to module path for tests
-
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/sanitizers-cmake/cmake)
 list(APPEND CMAKE_PREFIX_PATH ${CMAKE_INSTALL_PREFIX})
 
+include(FindSanitizers)
+
 # external dependencies
 find_package(PkgConfig REQUIRED)
 set(ENV{PKG_CONFIG_PATH} "$ENV{PKG_CONFIG_PATH}:${CMAKE_INSTALL_PREFIX}/lib/pkgconfig")
@@ -147,6 +147,7 @@ function(flux_add_plugin TargetName PluginType)
     )
   target_link_options(${TargetName} PRIVATE
     "LINKER:--version-script=${CMAKE_SOURCE_DIR}/flux-plugin.map" ${LinkerOpts})
+  add_sanitizers(${TargetName})
   target_link_libraries(${TargetName} PRIVATE flux::core)
   if (NOT ARG_NOINSTALL)
     install(TARGETS ${TargetName}

resource/CMakeLists.txt

@@ -87,6 +87,7 @@ target_link_libraries(resource PUBLIC
     jobspec_conv
     Boost::filesystem
     )
+add_sanitizers(resource)
 
 add_subdirectory(modules)
 add_subdirectory(reapi)

resource/libjobspec/CMakeLists.txt

@@ -9,6 +9,7 @@ add_library ( jobspec_conv STATIC
     ${CMAKE_CURRENT_SOURCE_DIR}/rank_constraint.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/rank_constraint.hpp
     )
+add_sanitizers(jobspec_conv)
 target_link_libraries(jobspec_conv PUBLIC flux::hostlist flux::idset
     flux::core yaml-cpp PkgConfig::JANSSON 
     PkgConfig::UUID

resource/planner/c++/CMakeLists.txt

@@ -8,6 +8,7 @@ add_library(planner_cxx STATIC
 	./planner_internal_tree.hpp
 	./scheduled_point_tree.hpp
  )
+add_sanitizers(planner_cxx) 
 target_link_libraries(planner_cxx yggdrasil)
 
 

resource/planner/c/CMakeLists.txt

@@ -4,6 +4,7 @@ add_library(planner STATIC
 	./planner.h
 	./planner_multi.h
 )
+add_sanitizers(planner)
 target_include_directories(planner PUBLIC ./)
 target_link_libraries(planner PUBLIC planner_cxx)
 

resource/planner/test/CMakeLists.txt

@@ -1,9 +1,11 @@
 add_executable(planner_test01 planner_test01.cpp)
+add_sanitizers(planner_test01)
 target_link_libraries(planner_test01 planner libtap)
 flux_add_test(NAME planner_test01 COMMAND planner_test01)
 set_property(TEST planner_test01 PROPERTY ENVIRONMENT "TESTRESRC_INPUT_FILE=$(CMAKE_SOURCE_DIR)/conf/hype.lua")
 
 add_executable(planner_test02 planner_test02.cpp)
+add_sanitizers(planner_test02)
 target_link_libraries(planner_test02 planner libtap)
 flux_add_test(NAME planner_test02 COMMAND planner_test02)
 set_property(TEST planner_test02 PROPERTY ENVIRONMENT "TESTRESRC_INPUT_FILE=$(CMAKE_SOURCE_DIR)/conf/hype.lua")

resource/policies/base/test/CMakeLists.txt

@@ -4,4 +4,5 @@ add_executable(matcher_util_api_test
 target_link_libraries(matcher_util_api_test PRIVATE libtap resource
   PkgConfig::JANSSON
   )
+add_sanitizers(matcher_util_api_test)
 flux_add_test(NAME matcher_util_api_test COMMAND matcher_util_api_test)

resource/utilities/CMakeLists.txt

@@ -1,6 +1,7 @@
 add_executable(grug2dot
   grug2dot.cpp
   )
+add_sanitizers(grug2dot)
 target_link_libraries(grug2dot
   resource
   Boost::headers
@@ -11,6 +12,7 @@ add_executable(resource-query
   command.cpp
   command.hpp
   )
+add_sanitizers(resource-query)
 target_link_libraries(resource-query
   resource
   PkgConfig::LIBEDIT
@@ -23,6 +25,7 @@ add_executable(rq2
   rq2.cpp
   rq2.hpp
   )
+add_sanitizers(rq2)
 target_link_libraries(rq2
   resource
   PkgConfig::LIBEDIT