Enable the proxy library on Windows

Co-developed-by: Rafał Rudnicki <rafal.rudnicki@intel.com>

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

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}}

src/CMakeLists.txt

@@ -166,20 +166,19 @@ install(TARGETS umf
 
 add_subdirectory(pool)
 
-# TODO: enable proxy_lib on Windows
-if(LINUX)
+if(LINUX OR WINDOWS)
     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)
+            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)
-        set(PROXY_LIB_USES_JEMALLOC_POOL ON)
-        set(PROXY_LIBS umf jemalloc_pool)
         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")

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);
 }
 
 /*****************************************************************************/
@@ -223,6 +252,13 @@ void free(void *ptr) {
     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);
@@ -260,7 +296,11 @@ 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
     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/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}")