cmake: support sanitizers natively

... so that users can easily test sanitized binaries themselves.

.github/workflows/ci.yml

@@ -33,27 +33,10 @@ jobs:
           sudo apt update
           sudo apt install -y clang
 
-      - name: '[Jammy] Add sanitizers to CFLAGS'
-        if: matrix.version >= 22.04
-        run: |
-          # Use ASAN and UBSAN
-          CFLAGS="$CFLAGS -fsanitize=address,undefined"
-          # Recommended for better error traces
-          CFLAGS="$CFLAGS -fno-omit-frame-pointer"
-          # Make UBSAN reports fatal
-          CFLAGS="$CFLAGS -fno-sanitize-recover=all"
-
-          # FIXME: release also the memory allocated by asprintf() and
-          # read_custom_opts()
-          ASAN_OPTIONS="detect_leaks=0"
-
-          # Make UBSAN print whole stack traces
-          UBSAN_OPTIONS="print_stacktrace=1"
-
-          # Store the env variables
-          echo "CFLAGS=$CFLAGS" >> "$GITHUB_ENV"
-          echo "ASAN_OPTIONS=$ASAN_OPTIONS" >> "$GITHUB_ENV"
-          echo "UBSAN_OPTIONS=$UBSAN_OPTIONS" >> "$GITHUB_ENV"
-
       - name: Build and check
-        run: make distcheck
+        run: |
+          if [[ "${{ matrix.version }}" == 22.04 ]]; then
+            make distcheck-sanitizers
+          else
+            make distcheck
+          fi

Makefile

@@ -21,21 +21,27 @@ CMAKE ?= cmake
 CTEST ?= ctest -j$(NUM_CPU)
 
 STATIC ?= OFF
+SANITIZERS ?= OFF
 
 CMAKE_BUILD_TYPE ?= RelWithDebInfo
 
-.PHONY: all check clean static distclean distcheck distcheck-static install
+.PHONY: all check clean static sanitizers distclean distcheck \
+	distcheck-static distcheck-sanitizers install
 
 all:
 	mkdir -p cscppc_build
 	cd cscppc_build && $(CMAKE) \
 		-DCMAKE_BUILD_TYPE="$(CMAKE_BUILD_TYPE)" \
-		-DSTATIC_LINKING="$(STATIC)" ..
+		-DSTATIC_LINKING="$(STATIC)" \
+		-DSANITIZERS="$(SANITIZERS)" ..
 	$(MAKE) -sC cscppc_build -j$(NUM_CPU)
 
 static:
 	$(MAKE) -s all STATIC=ON
 
+sanitizers:
+	$(MAKE) -s all SANITIZERS=ON
+
 check: all
 	cd cscppc_build && $(CTEST) --output-on-failure
 
@@ -51,5 +57,8 @@ distcheck: distclean
 distcheck-static:
 	$(MAKE) -s distcheck STATIC=ON
 
+distcheck-sanitizers:
+	$(MAKE) -s distcheck SANITIZERS=ON
+
 install: all
 	$(MAKE) -C cscppc_build install

src/CMakeLists.txt

@@ -22,6 +22,17 @@ set(CMAKE_C_STANDARD_REQUIRED ON)
 set(CMAKE_C_EXTENSIONS OFF)
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -pedantic")
 
+# enable sanitizers
+option(SANITIZERS "Compile with ASan and UBSan" OFF)
+if (SANITIZERS)
+    # enable ASan and UBSan
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address,undefined")
+    # recommended for better error traces
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fno-omit-frame-pointer")
+    # make UBSan reports fatal
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fno-sanitize-recover=all")
+endif()
+
 # link to libc statically
 option(STATIC_LINKING "Link to libc statically" OFF)
 if(STATIC_LINKING)

tests/0003-translation-of-args/runtest.sh

@@ -29,7 +29,7 @@ ln -fs "$PATH_TO_WRAP/csclng++" csclng++/g++                        || exit $?
 
 # run the wrappers through valgrind if available
 EXEC_PREFIX=
-if valgrind --version; then
+if [[ "$HAS_SANITIZERS" -eq 1 ]] && valgrind --version; then
     EXEC_PREFIX="valgrind -q --undef-value-errors=no --error-exitcode=7"
     printf "%s " "$EXEC_PREFIX" >> tools/g++
     printf "%s " "$EXEC_PREFIX" >> tools/gcc

tests/testlib.sh

@@ -12,6 +12,20 @@ TEST_DST_DIR="$2"
 # path to binaries of the wrappers
 PATH_TO_WRAP="$3"
 
+# sanitizer build is used
+grep -q "SANITIZERS:BOOL=ON" "$PATH_TO_WRAP/../CMakeCache.txt"
+HAS_SANITIZERS="$?"
+
+if [[ "$HAS_SANITIZERS" -eq 0 ]]; then
+    # make UBSan print whole stack traces
+    export UBSAN_OPTIONS="print_stacktrace=1"
+
+    # disable LSan because the fork&exec machinery in 0003-translation-of-args
+    # test produces incomplete stack traces making the leak suppression of
+    # these deliberate leaks useless on some distributions (Arch, Ubuntu, ...)
+    export ASAN_OPTIONS="detect_leaks=0"
+fi
+
 # create $TEST_DST_DIR (if it does not exist already)
 mkdir -p "$TEST_DST_DIR" || exit $?