Update Sanitizers with PR feedback and edge cases

Updates the Sanitizers to handle whitespace anywhere in the selected
sanitizer mode
Fixes an issue where undefined sanitizer would not work (generator
expressions do not handle whitespace)
Updates documentation following some feedback, and drops some old
information (such as min CMake version)

Fix indentation and suppress all Python warnings

Reverts the indentation changes introduced in an earlier commit by auto
formatting tools. Changes the regex for the address suppressions so we
match Python 2 and 3

Author: DavidFair

buildconfig/CMake/Sanitizers.cmake

@@ -9,10 +9,15 @@ set_property(CACHE USE_SANITIZER PROPERTY STRINGS
 string(TOLOWER "${USE_SANITIZER}" USE_SANITIZERS_LOWER)
 
 if(NOT ${USE_SANITIZERS_LOWER} MATCHES "off")
+    # Check we have a supported compiler
     if(WIN32)
         message(FATAL_ERROR "Windows does not support sanitizers")
     endif()
 
+    if(CMAKE_COMPILER_IS_GNUCXX AND (NOT CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 8))
+        message(FATAL_ERROR "GCC 7 and below do not support sanitizers")
+    endif()
+
     # Check and warn if we are not in a mode without debug symbols
     string(TOLOWER "${CMAKE_BUILD_TYPE}" build_type_lower)
     if("${build_type_lower}" MATCHES "release" OR "${build_type_lower}" MATCHES "minsizerel" )
@@ -35,22 +40,24 @@ if(NOT ${USE_SANITIZERS_LOWER} MATCHES "off")
 
     # Address
     add_compile_options(
-        $<$<STREQUAL:$<LOWER_CASE:${USE_SANITIZER}>,"address">:-fsanitize=address>)
+        $<$<STREQUAL:$<LOWER_CASE:"${USE_SANITIZER}">,"address">:-fsanitize=address>)
     add_link_options(
-        $<$<STREQUAL:$<LOWER_CASE:${USE_SANITIZER}>,"address">:-fsanitize=address>)
+        $<$<STREQUAL:$<LOWER_CASE:"${USE_SANITIZER}">,"address">:-fsanitize=address>)
 
     # Thread
     add_compile_options(
-        $<$<STREQUAL:$<LOWER_CASE:${USE_SANITIZER}>,"thread">:-fsanitize=thread>)
+        $<$<STREQUAL:$<LOWER_CASE:"${USE_SANITIZER}">,"thread">:-fsanitize=thread>)
     add_link_options(
-        $<$<STREQUAL:$<LOWER_CASE:${USE_SANITIZER}>,"thread">:-fsanitize=thread>)
+        $<$<STREQUAL:$<LOWER_CASE:"${USE_SANITIZER}">,"thread">:-fsanitize=thread>)
 
     # Undefined
     # RTTI information is not exported for some classes causing the
     # linker to fail whilst adding vptr instrumentation
     add_compile_options(
-        $<$<STREQUAL:$<LOWER_CASE:${USE_SANITIZER}>,"undefined">:-fsanitize=undefined -fno-sanitize=vptr>)
+        $<$<STREQUAL:$<LOWER_CASE:"${USE_SANITIZER}">,"undefined">:-fsanitize=undefined>
+        $<$<STREQUAL:$<LOWER_CASE:"${USE_SANITIZER}">,"undefined">:-fno-sanitize=vptr>)
+
     add_link_options(
-        $<$<STREQUAL:$<LOWER_CASE:${USE_SANITIZER}>,"undefined">:-fsanitize=undefined>)
+        $<$<STREQUAL:$<LOWER_CASE:"${USE_SANITIZER}">,"undefined">:-fsanitize=undefined>)
 
 endif()

buildconfig/Jenkins/buildscript

@@ -317,13 +317,13 @@ SANITIZER_FLAGS=''
 if [[ ${JOB_NAME} == *address* ]]; then
     SANITIZER_FLAGS="-DUSE_SANITIZER=Address"
 
-    elif [[ ${JOB_NAME} == *memory* ]]; then
+elif [[ ${JOB_NAME} == *memory* ]]; then
     SANITIZER_FLAGS="-DUSE_SANITIZER=memory"
 
-    elif [[ ${JOB_NAME} == *thread* ]]; then
+elif [[ ${JOB_NAME} == *thread* ]]; then
     SANITIZER_FLAGS="-DUSE_SANITIZER=thread"
 
-    elif [[ ${JOB_NAME} == *undefined* ]]; then
+elif [[ ${JOB_NAME} == *undefined* ]]; then
     SANITIZER_FLAGS="-DUSE_SANITIZER=undefined"
 fi
 

dev-docs/source/RunningSanitizers.rst

@@ -18,8 +18,8 @@ Pre-requisites
 
 The following tooling is required:
 
-- CMake 13.0 onwards (instructions for Ubuntu `here <https://apt.kitware.com/>`__)
 - GCC-8 onwards
+- Clang 3.2 onwards
 
 
 Switching to Sanitizer Build
@@ -28,7 +28,6 @@ Switching to Sanitizer Build
 The following sanitizers modes are available:
 
 - Address
-- Memory (Not implemented yet, requires clang support)
 - Thread
 - Undefined
 

tools/Sanitizer/Address.supp

@@ -0,0 +1,2 @@
+# This file is a placeholder for future suppressions. It is passed through
+# the ctest harness to the currently running test

tools/Sanitizer/Leak.supp

@@ -1,2 +1,25 @@
+# NeXus has a known memory leak when reading attributes.
+# It is fixed upstream but not made it to distribution packages
+# Direct leak of 12114 byte(s) in 1346 object(s) allocated from:
+#     #0 0x7fb126db5538 in strdup (/usr/lib/x86_64-linux-gnu/libasan.so.4+0x77538)
+#     #1 0x7fb120a534cb  (/usr/lib/libNeXus.so.0+0xc4cb)
+#     #2 0x7fb100000000  (<unknown module>)
 leak:libNeXus
-leak:libTKernel
+
+# OpenCascade memory allocation seems to confuse ASAN
+# Direct leak of 544 byte(s) in 1 object(s) allocated from:
+#     #0 0x7f77eec3a618 in operator new[](unsigned long) (/usr/lib/x86_64-linux-gnu/libasan.so.4+0xe0618)
+#     #1 0x7f77e4141b08  (/usr/lib/x86_64-linux-gnu/libTKernel.so.11+0x7bb08)
+leak:libTKernel
+
+# TBB leaks some memory allocated in singleton depending on deinitialization order
+# Direct leak of 1560 byte(s) in 3 object(s) allocated from:
+#     #0 0x7f7ae72a80a0 in operator new[](unsigned long) (/usr/lib/x86_64-linux-gnu/libasan.so.3+0xc80a0)
+#     #1 0x7f7ae595d13e  (/usr/lib/x86_64-linux-gnu/libtbb.so.2+0x2213e)
+leak:libtbb
+
+# Python and associated libraries *appears* to leak memory.
+leak:libpython
+leak:umath
+leak:multiarray
+leak:_ctypes