Merge pull request #342 from Distributive-Network/caleb/build/sanitize

feat(build): implement Sanitize build using AddressSanitizer

Author: zollqir

.github/workflows/test-and-publish.yaml

@@ -39,6 +39,7 @@ on:
         options:
         - 'Debug'
         - 'Profile'
+        - 'Sanitize'
         - 'DRelease'
         - 'Release'
         - 'None'

CMakeLists.txt

@@ -37,6 +37,7 @@ if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
     SET(KEEP_SYMBOLS "/DEBUG:FULL")
     SET(STRIP_SYMBOLS "/DEBUG:NONE")
     SET(PROFILE "/PROFILE")
+    SET(ADDRESS_SANITIZE "/fsanitize=address /Oy-")
   else()
     SET(COMPILE_FLAGS "-fno-rtti -Wno-invalid-offsetof")
 
@@ -45,20 +46,24 @@ if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
     SET(KEEP_SYMBOLS "-ggdb")
     SET(STRIP_SYMBOLS "-s")
     SET(PROFILE "-pg")
+    SET(ADDRESS_SANITIZE "-fsanitize=address -fno-omit-frame-pointer")
   endif()
   SET(PROFILE_FLAGS  "${UNOPTIMIZED} ${KEEP_SYMBOLS} ${PROFILE}")
+  SET(SANITIZE_FLAGS "${UNOPTIMIZED} ${KEEP_SYMBOLS} ${ADDRESS_SANITIZE}")
   SET(DEBUG_FLAGS    "${UNOPTIMIZED} ${KEEP_SYMBOLS}")
   SET(DRELEASE_FLAGS   "${OPTIMIZED} ${KEEP_SYMBOLS}")
   SET(RELEASE_FLAGS    "${OPTIMIZED} ${STRIP_SYMBOLS}")
 
   if(GENERATOR_IS_MULTI_CONFIG)
-    set(CMAKE_CONFIGURATION_TYPES "Profile;Debug;DRelease;Release;None" CACHE STRING "" FORCE)
-    string(APPEND COMPILE_FLAGS "$<$<CONFIG:Profile>:${PROFILE_FLAGS}> $<$<CONFIG:Debug>:${DEBUG_FLAGS}> $<$<CONFIG:DRelease>:${DRELEASE_FLAGS}> $<$<CONFIG:Release>:${RELEASE_FLAGS}>")
+    set(CMAKE_CONFIGURATION_TYPES "Profile;Sanitize;Debug;DRelease;Release;None" CACHE STRING "" FORCE)
+    string(APPEND COMPILE_FLAGS "$<$<CONFIG:Profile>:${PROFILE_FLAGS}> $<$<CONFIG:Sanitize>:${SANITIZE_FLAGS}> $<$<CONFIG:Debug>:${DEBUG_FLAGS}> $<$<CONFIG:DRelease>:${DRELEASE_FLAGS}> $<$<CONFIG:Release>:${RELEASE_FLAGS}>")
   else()
     set_property(CACHE PM_BUILD_TYPE PROPERTY HELPSTRING "Choose the type of build")
-    set_property(CACHE PM_BUILD_TYPE PROPERTY STRINGS "Profile;Debug;DRelease;Release;None")
+    set_property(CACHE PM_BUILD_TYPE PROPERTY STRINGS "Profile;Sanitize;Debug;DRelease;Release;None")
     if(PM_BUILD_TYPE STREQUAL "Profile")
       list(APPEND COMPILE_FLAGS "${PROFILE_FLAGS}")
+    elseif(PM_BUILD_TYPE STREQUAL "Sanitize")
+      list(APPEND COMPILE_FLAGS "${SANITIZE_FLAGS}")
     elseif(PM_BUILD_TYPE STREQUAL "Debug")
       list(APPEND COMPILE_FLAGS "${DEBUG_FLAGS}")
     elseif(PM_BUILD_TYPE STREQUAL "DRelease")

Makefile

@@ -4,7 +4,7 @@
 # @date         March 2024
 #
 
-BUILD = Debug	# (case-insensitive) Release, DRelease, Debug, Profile, or None
+BUILD = Debug	# (case-insensitive) Release, DRelease, Debug, Sanitize, Profile, or None
 DOCS = false
 VERBOSE = true
 PYTHON = python3
@@ -21,6 +21,8 @@ endif
 
 ifeq ($(BUILD),Profile)
 PYTHON_BUILD_ENV += BUILD_TYPE=Profile
+else ifeq ($(BUILD),Sanitize)
+PYTHON_BUILD_ENV += BUILD_TYPE=Sanitize
 else ifeq ($(BUILD),Debug)
 PYTHON_BUILD_ENV += BUILD_TYPE=Debug
 else ifeq ($(BUILD),DRelease)

README.md

@@ -83,6 +83,7 @@ PythonMonkey supports multiple build types, which you can build by setting the `
 - `Release`: stripped symbols, maximum optimizations (default)
 - `DRelease`: same as `Release`, except symbols are not stripped
 - `Debug`: minimal optimizations
+- `Sanitize`: same as `Debug`, except with [AddressSanitizer](https://github.com/google/sanitizers/wiki/AddressSanitizer) enabled
 - `Profile`: same as `Debug`, except profiling is enabled 
 - `None`: don't compile (useful if you only want to build the docs)