cmake: support sanitizers natively

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

Author: lzaoral

.github/workflows/ci.yml

@@ -37,22 +37,12 @@ jobs:
           sudo apt install -y help2man libboost-dev libboost-filesystem-dev \
             libboost-program-options-dev libboost-python-dev libboost-regex-dev
 
-      - name: '[Jammy] Add sanitizers to CXXFLAGS'
-        if: matrix.version >= 22.04
-        run: |
-          # Use ASAN and UBSAN
-          CXXFLAGS="$CXXFLAGS -fsanitize=address,undefined"
-          # Recommended for better error traces
-          CXXFLAGS="$CXXFLAGS -fno-omit-frame-pointer"
-          # Make UBSAN reports fatal
-          CXXFLAGS="$CXXFLAGS -fno-sanitize-recover=all"
-
-          # Make UBSAN print whole stack traces
-          UBSAN_OPTIONS="print_stacktrace=1"
-
-          # Store the env variables
-          echo "CXXFLAGS=$CXXFLAGS" >> "$GITHUB_ENV"
-          echo "UBSAN_OPTIONS=$UBSAN_OPTIONS" >> "$GITHUB_ENV"
-
       - name: Build and check
-        run: make distcheck
+        run: |
+          if [[ "${{ matrix.version }}" == 22.04 ]]; then
+            # Make UBSAN print whole stack traces
+            export UBSAN_OPTIONS="print_stacktrace=1"
+            make distcheck-sanitizers
+          else
+            make distcheck
+          fi

Makefile

@@ -1,4 +1,4 @@
-# Copyright (C) 2011 - 2020 Red Hat, Inc.
+# Copyright (C) 2011 - 2022 Red Hat, Inc.
 #
 # This file is part of csdiff.
 #
@@ -20,13 +20,18 @@ NUM_CPU ?= $(shell getconf _NPROCESSORS_ONLN 2>/dev/null || echo 1)
 CMAKE ?= cmake
 CTEST ?= ctest -j$(NUM_CPU) --progress
 
+SANITIZERS ?= OFF
+
 CMAKE_BUILD_TYPE ?= RelWithDebInfo
 
-.PHONY: all check clean distclean distcheck fast install version.cc src/version.cc
+.PHONY: all check clean sanitizers distclean distcheck distcheck-sanitizers \
+	fast install version.cc src/version.cc
 
 all: version.cc
 	mkdir -p csdiff_build
-	cd csdiff_build && $(CMAKE) -D 'CMAKE_BUILD_TYPE=$(CMAKE_BUILD_TYPE)' ..
+	cd csdiff_build && $(CMAKE) \
+		-D 'CMAKE_BUILD_TYPE=$(CMAKE_BUILD_TYPE)' \
+		-D SANITIZERS='$(SANITIZERS)' ..
 	$(MAKE) -sC csdiff_build -j$(NUM_CPU)
 
 fast: version.cc
@@ -38,13 +43,19 @@ check: all
 clean:
 	if test -e csdiff_build/Makefile; then $(MAKE) clean -C csdiff_build; fi
 
+sanitizers:
+	$(MAKE) -s all SANITIZERS=ON
+
 distclean:
 	if test -e .git; then rm -f src/version.cc; fi
 	rm -rf csdiff_build
 
 distcheck: distclean
 	$(MAKE) -s check
 
+distcheck-sanitizers:
+	$(MAKE) -s distcheck SANITIZERS=ON
+
 install: all
 	$(MAKE) -C csdiff_build install
 

src/CMakeLists.txt

@@ -23,6 +23,17 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic")
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
+# enable sanitizers
+option(SANITIZERS "Compile with ASan and UBSan" OFF)
+if(SANITIZERS)
+    # enable ASan and UBSan
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address,undefined")
+    # recommended for better error traces
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-omit-frame-pointer")
+    # make UBSan reports fatal
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-sanitize-recover=all")
+endif()
+
 # find Boost
 find_package(Boost REQUIRED
     COMPONENTS filesystem