Merge pull request #320 from ldorau/Enable_the_proxy_library_on_Windows

Enable the proxy library on windows

Author: ldorau

.github/workflows/basic.yml

@@ -232,6 +232,7 @@ jobs:
         -B ${{env.BUILD_DIR}}
         ${{matrix.toolset}}
         -DCMAKE_PREFIX_PATH="${{env.VCPKG_PATH}}"
+        -DCMAKE_BUILD_TYPE=${{matrix.build_type}}
         -DCMAKE_C_COMPILER=${{matrix.compiler.c}}
         -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
         -DUMF_BUILD_SHARED_LIBRARY=${{matrix.shared_library}}

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,25 +161,6 @@ install(TARGETS umf
 
 add_subdirectory(pool)
 
-# TODO: enable proxy_lib on Windows
-if(LINUX)
-    if(UMF_PROXY_LIB_BASED_ON_POOL STREQUAL SCALABLE)
-        set(PROXY_LIB_USES_SCALABLE_POOL ON)
-        set(PROXY_LIBS umf scalable_pool)
-        if(UMF_BUILD_LIBUMF_POOL_SCALABLE)
-            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)
-        set(PROXY_LIB_USES_JEMALLOC_POOL ON)
-        set(PROXY_LIBS umf jemalloc_pool)
-        if(UMF_BUILD_LIBUMF_POOL_JEMALLOC)
-            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/CMakeLists.txt

@@ -37,6 +37,8 @@ add_umf_library(NAME umf_proxy
 
 add_library(${PROJECT_NAME}::proxy ALIAS umf_proxy)
 
+target_link_directories(umf_proxy PRIVATE ${LIBHWLOC_LIBRARY_DIRS})
+
 if(PROXY_LIB_USES_SCALABLE_POOL)
     target_compile_definitions(umf_proxy PRIVATE PROXY_LIB_USES_SCALABLE_POOL=1)
 elseif(PROXY_LIB_USES_JEMALLOC_POOL)

src/proxy_lib/proxy_lib.c

@@ -28,8 +28,7 @@
 #endif
 
 #include <assert.h>
-#include <stdlib.h>
-#include <string.h>
+#include <stdio.h>
 
 #include <umf/memory_pool.h>
 #include <umf/memory_provider.h>
@@ -38,8 +37,27 @@
 #include "base_alloc_linear.h"
 #include "proxy_lib.h"
 #include "utils_common.h"
+
+#ifdef _WIN32 /* Windows ***************************************/
+
+#define _X86_
+#include <process.h>
+#include <synchapi.h>
+
+#define UTIL_ONCE_FLAG INIT_ONCE
+#define UTIL_ONCE_FLAG_INIT INIT_ONCE_STATIC_INIT
+
+void util_init_once(UTIL_ONCE_FLAG *flag, void (*onceCb)(void));
+
+#else /* Linux *************************************************/
+
+#include <stdlib.h>
+#include <string.h>
+
 #include "utils_concurrency.h"
 
+#endif /* _WIN32 ***********************************************/
+
 /*
  * The UMF proxy library uses two memory allocators:
  * 1) the "LEAK" internal linear base allocator based on the anonymous mapped
@@ -100,9 +118,20 @@ void proxy_lib_create_common(void) {
 }
 
 void proxy_lib_destroy_common(void) {
-    // We cannot destroy 'Base_alloc_leak' nor 'Proxy_pool' nor 'OS_memory_provider',
-    // because it could lead to use-after-free in the program's unloader
-    // (for example _dl_fini() on Linux).
+    if (util_is_running_in_proxy_lib()) {
+        // We cannot destroy 'Base_alloc_leak' nor 'Proxy_pool' nor 'OS_memory_provider',
+        // because it could lead to use-after-free in the program's unloader
+        // (for example _dl_fini() on Linux).
+        return;
+    }
+
+    umf_memory_pool_handle_t pool = Proxy_pool;
+    Proxy_pool = NULL;
+    umfPoolDestroy(pool);
+
+    umf_memory_provider_handle_t provider = OS_memory_provider;
+    OS_memory_provider = NULL;
+    umfMemoryProviderDestroy(provider);
 }
 
 /*****************************************************************************/
@@ -202,6 +231,34 @@ void *calloc(size_t nmemb, size_t size) {
     return ba_leak_calloc(nmemb, size);
 }
 
+void free(void *ptr) {
+    if (ptr == NULL) {
+        return;
+    }
+
+    if (ba_leak_free(ptr) == 0) {
+        return;
+    }
+
+    if (Proxy_pool) {
+        if (umfPoolFree(Proxy_pool, ptr) != UMF_RESULT_SUCCESS) {
+            fprintf(stderr, "error: umfPoolFree() failed\n");
+            assert(0);
+        }
+        return;
+    }
+
+    assert(0);
+    return;
+}
+
+#ifdef _WIN32
+void _free_dbg(void *userData, int blockType) {
+    (void)blockType; // unused
+    free(userData);
+}
+#endif
+
 void *realloc(void *ptr, size_t size) {
     if (ptr == NULL) {
         return malloc(size);
@@ -228,27 +285,6 @@ void *realloc(void *ptr, size_t size) {
     return NULL;
 }
 
-void free(void *ptr) {
-    if (ptr == NULL) {
-        return;
-    }
-
-    if (ba_leak_free(ptr) == 0) {
-        return;
-    }
-
-    if (Proxy_pool) {
-        if (umfPoolFree(Proxy_pool, ptr) != UMF_RESULT_SUCCESS) {
-            fprintf(stderr, "error: umfPoolFree() failed\n");
-            assert(0);
-        }
-        return;
-    }
-
-    assert(0);
-    return;
-}
-
 void *aligned_alloc(size_t alignment, size_t size) {
     if (!was_called_from_umfPool && Proxy_pool) {
         was_called_from_umfPool = 1;
@@ -260,7 +296,17 @@ void *aligned_alloc(size_t alignment, size_t size) {
     return ba_leak_aligned_alloc(alignment, size);
 }
 
+#ifdef _WIN32
+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);

src/proxy_lib/proxy_lib.def

@@ -9,7 +9,8 @@ EXPORTS
 	DllMain
 	aligned_alloc
 	calloc
+	_free_dbg
 	free
 	malloc
-	malloc_usable_size
+	_msize
 	realloc

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_installation.py

@@ -69,10 +69,20 @@ def _create_match_list(self) -> List[str]:
             lib_ext_shared = "dylib"
             lib_prefix = "lib"
 
+        # Currently the proxy library uses and requires the scalable pool
+        # The proxy library does not work in the Debug build on Windows yet.
+        if ("scalable_pool" in self.pools) and not (platform.system() == "Windows" and self.build_type == "debug"):
+            is_umf_proxy = True
+        else:
+            is_umf_proxy = False
+
         bin = []
-        if platform.system() == "Windows" and self.shared_library:
+        if platform.system() == "Windows" and (self.shared_library or is_umf_proxy):
             bin.append("bin")
-            bin.append("bin/umf.dll")
+            if self.shared_library:
+                bin.append("bin/umf.dll")
+            if is_umf_proxy:
+                bin.append("bin/umf_proxy.dll")
 
         include_dir = Path(self.workspace_dir, "include")
         include = [
@@ -94,9 +104,7 @@ def _create_match_list(self) -> List[str]:
             lib.append(f"lib/{lib_prefix}{pool}.{lib_ext_static}")
         lib_ext = lib_ext_shared if self.shared_library else lib_ext_static
         lib.append(f"lib/{lib_prefix}umf.{lib_ext}")
-        if platform.system() != "Windows" and (
-            "jemalloc_pool" in self.pools or "scalable_pool" in self.pools
-        ):
+        if is_umf_proxy:
             lib.append(f"lib/{lib_prefix}umf_proxy.{lib_ext_shared}")
         lib.append(f"lib/{lib_prefix}umf_utils.{lib_ext_static}")
 

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);
+}