Assert in umf_ba_destroy() in DEBUG and UMF_DEVELOPER_MODE

if (NDEBUG is not defined) and (UMF_DEVELOPER_MODE is defined)
assert in umf_ba_destroy() if there are any memory leaks
in the base allocator.

Signed-off-by: Lukasz Dorau <[email protected]>

Author: ldorau

.github/workflows/reusable_proxy_lib.yml

@@ -49,7 +49,7 @@ jobs:
           -DUMF_BUILD_BENCHMARKS=OFF
           -DUMF_BUILD_TESTS=ON
           -DUMF_FORMAT_CODE_STYLE=OFF
-          -DUMF_DEVELOPER_MODE=OFF
+          -DUMF_DEVELOPER_MODE=ON
           -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
           -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
           -DUMF_TESTS_FAIL_ON_SKIP=ON

CMakeLists.txt

@@ -111,6 +111,16 @@ else()
     message(FATAL_ERROR "Unknown OS type")
 endif()
 
+if((DEFINED ENV{CI}) AND (DEFINED ENV{GITHUB_ACTION}))
+    set(UMF_COMMON_COMPILE_DEFINITIONS ${UMF_COMMON_COMPILE_DEFINITIONS}
+                                       UMF_CI_GITHUB_ACTION=1)
+endif()
+
+if(UMF_DEVELOPER_MODE)
+    set(UMF_COMMON_COMPILE_DEFINITIONS ${UMF_COMMON_COMPILE_DEFINITIONS}
+                                       UMF_DEVELOPER_MODE=1)
+endif()
+
 if(NOT UMF_BUILD_LIBUMF_POOL_JEMALLOC)
     set(UMF_POOL_JEMALLOC_ENABLED FALSE)
     set(JEMALLOC_FOUND FALSE)

src/CMakeLists.txt

@@ -14,7 +14,8 @@ set(UMF_CUDA_INCLUDE_DIR
 # Compile definitions for UMF library.
 #
 # TODO: Cleanup the compile definitions across all the CMake files
-set(UMF_COMMON_COMPILE_DEFINITIONS UMF_VERSION=${UMF_VERSION})
+set(UMF_COMMON_COMPILE_DEFINITIONS ${UMF_COMMON_COMPILE_DEFINITIONS}
+                                   UMF_VERSION=${UMF_VERSION})
 
 set(BA_SOURCES
     ${CMAKE_CURRENT_SOURCE_DIR}/base_alloc/base_alloc.c

src/base_alloc/base_alloc.c

@@ -303,7 +303,18 @@ void umf_ba_destroy(umf_ba_pool_t *pool) {
 #ifndef NDEBUG
     ba_debug_checks(pool);
     if (pool->metadata.n_allocs) {
-        LOG_ERR("pool->metadata.n_allocs = %zu", pool->metadata.n_allocs);
+        LOG_ERR("number of base allocator memory leaks: %zu",
+                pool->metadata.n_allocs);
+
+#ifdef UMF_DEVELOPER_MODE
+        assert(pool->metadata.n_allocs == 0 &&
+               "memory leaks in base allocator occurred");
+#endif
+
+// UMF_DEVELOPER_MODE should be turned on in CI
+#if defined(UMF_CI_GITHUB_ACTION) && !defined(UMF_DEVELOPER_MODE)
+#error UMF_DEVELOPER_MODE is not defined!
+#endif
     }
 #endif /* NDEBUG */