[CMake] Add missing UMF_ prefix in 'public' umf options

Author: lukaszstolarczuk

.github/workflows/nightly.yml

@@ -79,7 +79,7 @@ jobs:
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
-        -DUSE_VALGRIND=1
+        -DUMF_USE_VALGRIND=1
         -DUMF_TESTS_FAIL_ON_SKIP=ON
 
     - name: Build

.github/workflows/sanitizers.yml

@@ -59,9 +59,9 @@ jobs:
         -DUMF_DEVELOPER_MODE=ON
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
-        -DUSE_ASAN=${{matrix.sanitizers.asan}}
-        -DUSE_UBSAN=${{matrix.sanitizers.ubsan}}
-        -DUSE_TSAN=${{matrix.sanitizers.tsan}}
+        -DUMF_USE_ASAN=${{matrix.sanitizers.asan}}
+        -DUMF_USE_UBSAN=${{matrix.sanitizers.ubsan}}
+        -DUMF_USE_TSAN=${{matrix.sanitizers.tsan}}
         -DUMF_BUILD_EXAMPLES=ON
         -DUMF_TESTS_FAIL_ON_SKIP=ON
 
@@ -127,7 +127,7 @@ jobs:
         -DUMF_FORMAT_CODE_STYLE=OFF
         -DUMF_DEVELOPER_MODE=ON
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
-        -DUSE_ASAN=${{matrix.sanitizers.asan}}
+        -DUMF_USE_ASAN=${{matrix.sanitizers.asan}}
         -DUMF_BUILD_EXAMPLES=ON
         -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
         -DUMF_TESTS_FAIL_ON_SKIP=ON

.github/workflows/valgrind.yml

@@ -35,7 +35,7 @@ jobs:
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
-        -DUSE_VALGRIND=1
+        -DUMF_USE_VALGRIND=1
         -DUMF_TESTS_FAIL_ON_SKIP=ON
 
     - name: Build

CMakeLists.txt

@@ -57,12 +57,12 @@ option(UMF_FORMAT_CODE_STYLE
        OFF)
 # Only a part of skips is treated as a failure now. TODO: extend to all tests
 option(UMF_TESTS_FAIL_ON_SKIP "Treat skips in tests as fail" OFF)
-option(USE_ASAN "Enable AddressSanitizer checks" OFF)
-option(USE_UBSAN "Enable UndefinedBehaviorSanitizer checks" OFF)
-option(USE_TSAN "Enable ThreadSanitizer checks" OFF)
-option(USE_MSAN "Enable MemorySanitizer checks" OFF)
-option(USE_VALGRIND "Enable Valgrind instrumentation" OFF)
-option(USE_GCOV "Enable gcov support" OFF)
+option(UMF_USE_ASAN "Enable AddressSanitizer checks" OFF)
+option(UMF_USE_UBSAN "Enable UndefinedBehaviorSanitizer checks" OFF)
+option(UMF_USE_TSAN "Enable ThreadSanitizer checks" OFF)
+option(UMF_USE_MSAN "Enable MemorySanitizer checks" OFF)
+option(UMF_USE_VALGRIND "Enable Valgrind instrumentation" OFF)
+option(UMF_USE_GCOV "Enable gcov support" OFF)
 option(
     UMF_DISABLE_HWLOC
     "Disable features that requires hwloc (OS provider, memory targets, topology discovery)"
@@ -266,16 +266,16 @@ if(MSVC)
 endif()
 
 # Sanitizer flags
-if(USE_ASAN)
+if(UMF_USE_ASAN)
     add_sanitizer_flag(address)
 endif()
-if(USE_UBSAN)
+if(UMF_USE_UBSAN)
     add_sanitizer_flag(undefined)
 endif()
-if(USE_TSAN)
+if(UMF_USE_TSAN)
     add_sanitizer_flag(thread)
 endif()
-if(USE_MSAN)
+if(UMF_USE_MSAN)
     message(WARNING "MemorySanitizer requires instrumented libraries to "
                     "prevent reporting false-positives")
     add_sanitizer_flag(memory)

CONTRIBUTING.md

@@ -207,12 +207,12 @@ origin: https://dependency_origin.com
 ## Code coverage
 
 After adding a new functionality add tests and check coverage before and after the change.
-To do this, enable coverage instrumentation by turning on the USE_GCOV flag in CMake.
+To do this, enable coverage instrumentation by turning on the UMF_USE_GCOV flag in CMake.
 Coverage instrumentation feature is supported only by GCC and Clang.
 An example flow might look like the following:
 
 ```bash
-$ cmake -B build -DUSE_GCOV=1 -DCMAKE_BUILD_TYPE=Debug
+$ cmake -B build -DUMF_USE_GCOV=1 -DCMAKE_BUILD_TYPE=Debug
 $ cmake --build build -j
 $ cd build
 $ ctest

README.md

@@ -112,12 +112,12 @@ List of options provided by CMake:
 | UMF_DEVELOPER_MODE | Enable additional developer checks | ON/OFF | OFF |
 | UMF_FORMAT_CODE_STYLE | Add clang, cmake, and black -format-check and -format-apply targets to make | ON/OFF | OFF |
 | UMF_TESTS_FAIL_ON_SKIP | Treat skips in tests as fail | ON/OFF | OFF |
-| USE_ASAN | Enable AddressSanitizer checks | ON/OFF | OFF |
-| USE_UBSAN | Enable UndefinedBehaviorSanitizer checks | ON/OFF | OFF |
-| USE_TSAN | Enable ThreadSanitizer checks | ON/OFF | OFF |
-| USE_MSAN | Enable MemorySanitizer checks | ON/OFF | OFF |
-| USE_VALGRIND | Enable Valgrind instrumentation | ON/OFF | OFF |
-| USE_GCOV | Enable gcov support (Linux only) | ON/OFF | OFF |
+| UMF_USE_ASAN | Enable AddressSanitizer checks | ON/OFF | OFF |
+| UMF_USE_UBSAN | Enable UndefinedBehaviorSanitizer checks | ON/OFF | OFF |
+| UMF_USE_TSAN | Enable ThreadSanitizer checks | ON/OFF | OFF |
+| UMF_USE_MSAN | Enable MemorySanitizer checks | ON/OFF | OFF |
+| UMF_USE_VALGRIND | Enable Valgrind instrumentation | ON/OFF | OFF |
+| UMF_USE_GCOV | Enable gcov support (Linux only) | ON/OFF | OFF |
 | UMF_LINK_HWLOC_STATICALLY | Link UMF with HWLOC library statically (Windows+Release only) | ON/OFF | OFF |
 | UMF_DISABLE_HWLOC | Disable features that requires hwloc (OS provider, memory targets, topology discovery) | ON/OFF | OFF |
 

cmake/helpers.cmake

@@ -218,7 +218,7 @@ function(add_umf_target_compile_options name)
             target_compile_options(${name} PRIVATE -fno-omit-frame-pointer
                                                    -fstack-protector-strong)
         endif()
-        if(USE_GCOV)
+        if(UMF_USE_GCOV)
             if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
                 message(FATAL_ERROR "To use gcov, the build type must be Debug")
             endif()
@@ -254,7 +254,7 @@ function(add_umf_target_link_options name)
     if(NOT MSVC)
         if(NOT APPLE)
             target_link_options(${name} PRIVATE "LINKER:-z,relro,-z,now")
-            if(USE_GCOV)
+            if(UMF_USE_GCOV)
                 if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
                     message(
                         FATAL_ERROR "To use gcov, the build type must be Debug")

src/utils/CMakeLists.txt

@@ -13,11 +13,11 @@ set(UMF_UTILS_SOURCES_POSIX utils_posix_common.c utils_posix_concurrency.c
 set(UMF_UTILS_SOURCES_WINDOWS utils_windows_common.c
                               utils_windows_concurrency.c utils_windows_math.c)
 
-if(USE_VALGRIND)
-    if(USE_ASAN
-       OR USE_TSAN
-       OR USE_UBSAN
-       OR USE_MSAN)
+if(UMF_USE_VALGRIND)
+    if(UMF_USE_ASAN
+       OR UMF_USE_TSAN
+       OR UMF_USE_UBSAN
+       OR UMF_USE_MSAN)
         message(FATAL_ERROR "Cannot use valgrind and sanitizers together")
     endif()
 
@@ -51,7 +51,7 @@ target_include_directories(
               $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
               $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>)
 
-if(USE_VALGRIND)
+if(UMF_USE_VALGRIND)
     set(UMF_UTILS_INTERFACE_DEFS "UMF_VG_ENABLED=1")
 endif()
 

test/CMakeLists.txt

@@ -394,10 +394,10 @@ endif()
 if(LINUX
    AND UMF_BUILD_SHARED_LIBRARY
    AND NOT
-       (USE_ASAN
-        OR USE_UBSAN
-        OR USE_TSAN
-        OR USE_MSAN))
+       (UMF_USE_ASAN
+        OR UMF_USE_UBSAN
+        OR UMF_USE_TSAN
+        OR UMF_USE_MSAN))
     set(EXAMPLES "")
     if(UMF_POOL_SCALABLE_ENABLED)
         set(EXAMPLES ${EXAMPLES} basic)