DAOS-16501 build: Support of mercury with ASan

Instrument mercury with libasan according to build option SANITIZERS

Signed-off-by: Cedric Koch-Hofer <cedric.koch-hofer@hpe.com>

Author: kanard38

deps/patches/mercury/0004_asan_workaround.patch

@@ -0,0 +1,17 @@
+diff --git a/CMakeLists.txt b/CMakeLists.txt
+index b075819..a764bc6 100644
+--- a/CMakeLists.txt
++++ b/CMakeLists.txt
+@@ -229,9 +229,9 @@ function(mercury_set_lib_options libtarget libname libtype var_prefix)
+       OUTPUT_NAME_RELEASE        ${LIB_RELEASE_NAME}
+       OUTPUT_NAME_MINSIZEREL     ${LIB_RELEASE_NAME}
+       OUTPUT_NAME_RELWITHDEBINFO ${LIB_RELEASE_NAME}
+-      OUTPUT_NAME_ASAN           ${LIB_DEBUG_NAME}
+-      OUTPUT_NAME_TSAN           ${LIB_DEBUG_NAME}
+-      OUTPUT_NAME_UBSAN          ${LIB_DEBUG_NAME}
++      OUTPUT_NAME_ASAN           ${LIB_RELEASE_NAME}
++      OUTPUT_NAME_TSAN           ${LIB_RELEASE_NAME}
++      OUTPUT_NAME_UBSAN          ${LIB_RELEASE_NAME}
+   )
+   if(${libtype} MATCHES "SHARED")
+     set_target_properties(${libtarget}

docs/dev/development.md

@@ -138,11 +138,12 @@ such as maximum function stack size, may lead to unexpected behavior in the inst
 binaries.
 
 #### Customizing ASan Behavior
+
 ASan behavior can be configured using the `ASAN_OPTIONS` environment variable. For example, you can
 add the following entry to the `env_vars` section of the `daos_server.yml` configuration file:
 ```yaml
 engines:
-- ..
+- ...
   env_vars:
   ...
   - ASAN_OPTIONS=atexit=1:print_stats=1:log_path=/tmp/daos_engine0.asan:disable_coredump=1:handle_segv=2:handle_abort=2:handle_sigfpe=2:handle_sigill=2:handle_sigbus=2:use_sigaltstack=1

site_scons/components/__init__.py

@@ -187,7 +187,6 @@ def define_mercury(reqs):
 
     mercury_build = ['cmake',
                      '-DBUILD_SHARED_LIBS:BOOL=ON',
-                     '-DCMAKE_BUILD_TYPE:STRING=RelWithDebInfo',
                      '-DCMAKE_CXX_FLAGS:STRING="-std=c++11"',
                      '-DCMAKE_INSTALL_PREFIX:PATH=$MERCURY_PREFIX',
                      '-DMERCURY_INSTALL_LIB_DIR:PATH=$MERCURY_PREFIX/lib64',
@@ -208,6 +207,19 @@ def define_mercury(reqs):
                      '-DNA_USE_UCX:BOOL=ON',
                      '../mercury']
 
+    build_type = "RelWithDebInfo"
+    try:
+        sanitizers = reqs.get_env('SANITIZERS').split(',')
+        if 'address' in sanitizers:
+            build_type = "Asan"
+        elif 'thread' in sanitizers:
+            build_type = "Tsan"
+        elif 'undefined' in sanitizers:
+            build_type = "Ubsan"
+    except KeyError:
+        pass
+    mercury_build.append(f'-DCMAKE_BUILD_TYPE:STRING={build_type}')
+
     if reqs.target_type == 'debug':
         mercury_build.append('-DMERCURY_ENABLE_DEBUG:BOOL=ON')
     else:

site_scons/prereq_tools/base.py

@@ -517,7 +517,7 @@ def __init__(self, env, opts):
                               ['gcc', 'covc', 'clang', 'icc'], ignorecase=2))
         opts.Add(EnumVariable('WARNING_LEVEL', "Set default warning level", 'error',
                               ['warning', 'warn', 'error'], ignorecase=2))
-        opts.Add(('SANITIZERS', 'Instrument C code with google sanitizers', None))
+        opts.Add(('SANITIZERS', 'Instrument C code with Google Sanitizers', None))
 
         opts.Update(self.__env)
 

utils/build.config

@@ -27,5 +27,5 @@ ucx=https://github.com/openucx/ucx.git
 
 [patch_versions]
 spdk=0001_b0aba3fcd5aceceea530a702922153bc75664978.diff,0002_445a4c808badbad3942696ecf16fa60e8129a747.diff
-mercury=0001_na_ucx.patch,0002_na_ucx_ep_flush.patch,0003_combined_plugin_path.patch
+mercury=0001_na_ucx.patch,0002_na_ucx_ep_flush.patch,0003_combined_plugin_path.patch,0004_asan_workaround.patch
 argobots=0001_411e5b344642ebc82190fd8b125db512e5b449d1.diff,0002_bb0c908abfac4bfe37852eee621930634183c6aa.diff