Add tests for the proxy library

Signed-off-by: Lukasz Dorau <lukasz.dorau@intel.com>

Author: ldorau

CMakeLists.txt

@@ -25,6 +25,9 @@ option(USE_TSAN "Enable ThreadSanitizer checks" OFF)
 option(USE_MSAN "Enable MemorySanitizer checks" OFF)
 option(USE_VALGRIND "Enable Valgrind instrumentation" OFF)
 
+# set UMF_PROXY_LIB_BASED_ON_POOL to one of: SCALABLE or JEMALLOC
+set(UMF_PROXY_LIB_BASED_ON_POOL SCALABLE CACHE STRING "A UMF pool the proxy library is based on (SCALABLE or JEMALLOC)" FORCE)
+
 set(KNOWN_BUILD_TYPES Release Debug RelWithDebInfo MinSizeRel)
 string(REPLACE ";" " " KNOWN_BUILD_TYPES_STR "${KNOWN_BUILD_TYPES}")
 
@@ -131,9 +134,13 @@ install(
     EXPORT ${PROJECT_NAME}-targets)
 
 if(WINDOWS)
-    # set PATH to DLLs on Windows
-    set(DLL_PATH_LIST "PATH=path_list_append:../bin/$<CONFIG>")
     add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
+    # set PATH to DLLs on Windows
+    set(DLL_PATH_LIST "PATH=path_list_append:${PROJECT_BINARY_DIR}/bin/$<CONFIG>")
+    # add path to the proxy lib DLL
+    set(DLL_PATH_LIST "${DLL_PATH_LIST};PATH=path_list_append:${PROJECT_BINARY_DIR}/src/proxy_lib")
+    # MSVC implicitly adds $<CONFIG> to the output path
+    set(DLL_PATH_LIST "${DLL_PATH_LIST};PATH=path_list_append:${PROJECT_BINARY_DIR}/src/proxy_lib/$<CONFIG>")
 endif()
 
 pkg_check_modules(LIBHWLOC hwloc)
@@ -161,6 +168,32 @@ if(UMF_BUILD_LIBUMF_POOL_JEMALLOC AND (LINUX OR WINDOWS))
     set(DLL_PATH_LIST "${DLL_PATH_LIST};PATH=path_list_append:${JEMALLOC_LIBRARY_DIRS}/../bin")
 endif()
 
+# set UMF_PROXY_LIB_ENABLED
+if(LINUX OR WINDOWS)
+    # TODO: enable the proxy library in the Debug build on Windows
+    if(WINDOWS AND NOT (CMAKE_BUILD_TYPE STREQUAL "Release"))
+        message(STATUS "Disabling the proxy library, because it is supported only in the Release build on Windows (CMAKE_BUILD_TYPE = ${CMAKE_BUILD_TYPE})")
+    elseif(UMF_PROXY_LIB_BASED_ON_POOL STREQUAL SCALABLE)
+        if(UMF_BUILD_LIBUMF_POOL_SCALABLE)
+            set(UMF_PROXY_LIB_ENABLED ON)
+            set(PROXY_LIB_USES_SCALABLE_POOL ON)
+            set(PROXY_LIBS umf scalable_pool)
+        else()
+            message(STATUS "Disabling the proxy library, because UMF_PROXY_LIB_BASED_ON_POOL==SCALABLE but UMF_BUILD_LIBUMF_POOL_SCALABLE is OFF")
+        endif()
+    elseif(UMF_PROXY_LIB_BASED_ON_POOL STREQUAL JEMALLOC)
+        if(UMF_BUILD_LIBUMF_POOL_JEMALLOC)
+            set(UMF_PROXY_LIB_ENABLED ON)
+            set(PROXY_LIB_USES_JEMALLOC_POOL ON)
+            set(PROXY_LIBS umf jemalloc_pool)
+        else()
+            message(STATUS "Disabling the proxy library, because UMF_PROXY_LIB_BASED_ON_POOL==JEMALLOC but UMF_BUILD_LIBUMF_POOL_JEMALLOC is OFF")
+        endif()
+    else()
+        message(FATAL_ERROR "Proxy library: pool manager not chosen or set to a non-supported one (see UMF_PROXY_LIB_BASED_ON_POOL)")
+    endif()
+endif()
+
 add_subdirectory(src)
 
 if(UMF_BUILD_TESTS)

src/CMakeLists.txt

@@ -26,11 +26,6 @@ if(UMF_BUILD_LEVEL_ZERO_PROVIDER)
     message(STATUS "Level Zero include directory: ${LEVEL_ZERO_INCLUDE_DIRS}")
 endif()
 
-# set UMF_PROXY_LIB_BASED_ON_POOL to one of:
-# - SCALABLE
-# - JEMALLOC
-set(UMF_PROXY_LIB_BASED_ON_POOL SCALABLE CACHE STRING "A UMF pool the proxy library is based on (SCALABLE or JEMALLOC)" FORCE)
-
 add_subdirectory(utils)
 
 set(UMF_LIBS umf_utils)
@@ -166,24 +161,6 @@ install(TARGETS umf
 
 add_subdirectory(pool)
 
-if(LINUX OR WINDOWS)
-    if(UMF_PROXY_LIB_BASED_ON_POOL STREQUAL SCALABLE)
-        if(UMF_BUILD_LIBUMF_POOL_SCALABLE)
-            set(PROXY_LIB_USES_SCALABLE_POOL ON)
-            set(PROXY_LIBS umf scalable_pool)
-            add_subdirectory(proxy_lib)
-        else()
-            message(STATUS "Disabling the proxy library, because UMF_PROXY_LIB_BASED_ON_POOL==SCALABLE but UMF_BUILD_LIBUMF_POOL_SCALABLE is OFF")
-        endif()
-    elseif(UMF_PROXY_LIB_BASED_ON_POOL STREQUAL JEMALLOC)
-        if(UMF_BUILD_LIBUMF_POOL_JEMALLOC)
-            set(PROXY_LIB_USES_JEMALLOC_POOL ON)
-            set(PROXY_LIBS umf jemalloc_pool)
-            add_subdirectory(proxy_lib)
-        else()
-            message(STATUS "Disabling the proxy library, because UMF_PROXY_LIB_BASED_ON_POOL==JEMALLOC but UMF_BUILD_LIBUMF_POOL_JEMALLOC is OFF")
-        endif()
-    else()
-        message(FATAL_ERROR "Proxy library: pool manager not chosen or set to a non-supported one (see UMF_PROXY_LIB_BASED_ON_POOL)")
-    endif()
+if(UMF_PROXY_LIB_ENABLED)
+    add_subdirectory(proxy_lib)
 endif()

src/proxy_lib/proxy_lib.c

@@ -301,6 +301,12 @@ size_t _msize(void *ptr) {
 #else
 size_t malloc_usable_size(void *ptr) {
 #endif
+
+    // a check to verify we are running the proxy library
+    if (ptr == (void *)0x01) {
+        return 0xDEADBEEF;
+    }
+
     if (!was_called_from_umfPool && Proxy_pool) {
         was_called_from_umfPool = 1;
         size_t size = umfPoolMallocUsableSize(Proxy_pool, ptr);

test/CMakeLists.txt

@@ -37,11 +37,13 @@ function(add_umf_test)
         set(LIB_DIRS ${LIB_DIRS} ${JEMALLOC_LIBRARY_DIRS})
     endif()
 
-    set(TEST_LIBS test_common
+    set(TEST_LIBS
+        test_common
         umf
+        ${ARG_LIBS}
         GTest::gtest_main
-        ${LIBS_OPTIONAL}
-        ${ARG_LIBS})
+        ${LIBS_OPTIONAL})
+
     add_umf_executable(NAME ${TEST_TARGET_NAME} SRCS ${ARG_SRCS} LIBS ${TEST_LIBS})
 
     target_link_directories(${TEST_TARGET_NAME} PRIVATE ${LIB_DIRS})
@@ -171,3 +173,15 @@ add_umf_test(NAME base_alloc_linear
 add_umf_test(NAME base_alloc_global
             SRCS ${BA_SOURCES_FOR_TEST} pools/pool_base_alloc.cpp malloc_compliance_tests.cpp
             LIBS umf_utils)
+
+# tests for the proxy library
+if(UMF_PROXY_LIB_ENABLED AND UMF_BUILD_SHARED_LIBRARY)
+    add_umf_test(NAME proxy_lib_basic
+                SRCS test_proxy_lib.cpp
+                LIBS umf_proxy)
+
+    # the memoryPool test run with the proxy library
+    add_umf_test(NAME proxy_lib_memoryPool
+                SRCS memoryPoolAPI.cpp malloc_compliance_tests.cpp
+                LIBS umf_proxy)
+endif()

test/test_proxy_lib.cpp

@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2024 Intel Corporation
+ *
+ * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+*/
+
+#include <malloc.h>
+
+#include "base.hpp"
+#include "test_helpers.h"
+
+using umf_test::test;
+
+TEST_F(test, proxyLibBasic) {
+
+    ::free(::malloc(64));
+
+    // a check to verify we are running the proxy library
+    void *ptr = (void *)0x01;
+#ifdef _WIN32
+    size_t size = _msize(ptr);
+#elif __APPLE__
+    size_t size = ::malloc_size(ptr);
+#else
+    size_t size = ::malloc_usable_size(ptr);
+#endif
+    UT_ASSERTeq(size, 0xDEADBEEF);
+}