Add support for enabling UBSAN

Author: solidpixel

CMakeLists.txt

@@ -44,6 +44,7 @@ option(ASTCENC_DECOMPRESSOR "Enable astcenc builds for decompression only")
 option(ASTCENC_SHAREDLIB "Enable astcenc builds with core library shared objects")
 option(ASTCENC_DIAGNOSTICS "Enable astcenc builds with diagnostic trace")
 option(ASTCENC_ASAN "Enable astcenc builds with address sanitizer")
+option(ASTCENC_UBSAN "Enable astcenc builds with undefined behavior sanitizer")
 option(ASTCENC_UNITTEST "Enable astcenc builds with unit tests")
 option(ASTCENC_INVARIANCE "Enable astcenc floating point invariance" ON)
 option(ASTCENC_CLI "Enable build of astcenc command line tools" ON)
@@ -129,6 +130,7 @@ printopt("Shared libs    " ${ASTCENC_SHAREDLIB})
 printopt("Decompressor   " ${ASTCENC_DECOMPRESSOR})
 printopt("Diagnostics    " ${ASTCENC_DIAGNOSTICS})
 printopt("ASAN           " ${ASTCENC_ASAN})
+printopt("UBSAN          " ${ASTCENC_UBSAN})
 printopt("Unit tests     " ${ASTCENC_UNITTEST})
 
 # Subcomponents

Docs/Building.md

@@ -225,11 +225,15 @@ cd build
 ctest --verbose
 ```
 
-### Address sanitizer builds
+### Sanitizer builds
 
-We support building with ASAN on Linux and macOS when using a compiler that
-supports it. To build binaries with ASAN checking enabled add `-DASTCENC_ASAN=ON`
-to the CMake command line when configuring.
+We support building with sanitizers on Linux and macOS when using Clang.
+
+To build binaries with ASAN checking enabled add `-DASTCENC_ASAN=ON` to the
+CMake command line when configuring.
+
+To build binaries with UBSAN checking enabled add `-DASTCENC_UBSAN=ON` to the
+CMake command line when configuring.
 
 ### Android builds
 
@@ -297,4 +301,4 @@ details.
 
 - - -
 
-_Copyright © 2019-2023, Arm Limited and contributors. All rights reserved._
+_Copyright © 2019-2024, Arm Limited and contributors. All rights reserved._

Docs/ChangeLog-4x.md

@@ -16,6 +16,8 @@ The 4.8.0 release is a minor maintenance release.
 * **General:**
   * **Bug fix:** Native builds on macOS will now correctly build for arm64 when
     run outside of Rosetta on an Apple silicon device.
+  * **Feature:** Builds using Clang can now build with undefined behavior
+    sanitizer by setting `-DASTCENC_UBSAN=ON` on the CMake configure line.
 
 <!-- ---------------------------------------------------------------------- -->
 ## 4.7.0

Source/cmake_core.cmake

@@ -207,6 +207,16 @@ macro(astcenc_set_properties ASTCENC_TARGET_NAME ASTCENC_IS_VENEER)
                 $<${is_clang}:-fsanitize=address>)
     endif()
 
+    if(${ASTCENC_UBSAN})
+        target_compile_options(${ASTCENC_TARGET_NAME}
+            PRIVATE
+                $<${is_clang}:-fsanitize=undefined>)
+
+        target_link_options(${ASTCENC_TARGET_NAME}
+            PRIVATE
+                $<${is_clang}:-fsanitize=undefined>)
+    endif()
+
     if(NOT ${ASTCENC_INVARIANCE})
         target_compile_definitions(${ASTCENC_TARGET_NAME}
             PRIVATE