enable building L0 provider on Windows

Author: bratpiorka

.github/workflows/basic.yml

@@ -214,26 +214,37 @@ jobs:
         pool_tracking: ['ON', 'OFF']
         shared_library: ['OFF']
         os_provider: ['ON']
-        # TODO add level zero provider
+        level_zero_provider: ['ON']
         include:
           - os: 'windows-2022'
             build_type: Release
             compiler: {c: clang-cl, cxx: clang-cl}
             pool_tracking: 'ON'
             os_provider: 'ON'
+            level_zero_provider: 'ON'
             toolset: "-T ClangCL"
           - os: 'windows-2022'
             build_type: Release
             compiler: {c: cl, cxx: cl}
             pool_tracking: 'ON'
             shared_library: 'ON'
             os_provider: 'ON'
+            level_zero_provider: 'ON'
           - os: 'windows-2022'
             build_type: Release
             compiler: {c: cl, cxx: cl}
             pool_tracking: 'ON'
             shared_library: 'ON'
             os_provider: 'OFF'
+            level_zero_provider: 'ON'
+          - os: 'windows-2022'
+            build_type: Release
+            compiler: {c: cl, cxx: cl}
+            pool_tracking: 'ON'
+            shared_library: 'ON'
+            os_provider: 'ON'
+            level_zero_provider: 'OFF'
+
     runs-on: ${{matrix.os}}
 
     steps:
@@ -267,7 +278,7 @@ jobs:
         -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_OS_MEMORY_PROVIDER=${{matrix.os_provider}}
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
+        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=${{matrix.level_zero_provider}}
 
     - name: Build UMF
       run: cmake --build ${{env.BUILD_DIR}} --config ${{matrix.build_type}} -j $Env:NUMBER_OF_PROCESSORS

.github/workflows/benchmarks.yml

@@ -14,12 +14,7 @@ jobs:
       VCPKG_PATH: "${{github.workspace}}/build/vcpkg/packages/hwloc_x64-windows;${{github.workspace}}/build/vcpkg/packages/tbb_x64-windows;${{github.workspace}}/build/vcpkg/packages/jemalloc_x64-windows"
     strategy:
       matrix:
-        include:
-          - os: ubuntu-latest
-            level_zero_provider: 'ON'
-          - os: windows-latest
-            level_zero_provider: 'OFF'
-
+        os: ['ubuntu-latest', 'windows-latest']
     runs-on: ${{matrix.os}}
 
     steps:
@@ -57,12 +52,12 @@ jobs:
           -DUMF_BUILD_TESTS=OFF
           -DUMF_FORMAT_CODE_STYLE=OFF
           -DUMF_DEVELOPER_MODE=OFF
+          -DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
           -DUMF_BUILD_OS_MEMORY_PROVIDER=ON
           -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
           -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
           -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON
           -DUMF_ENABLE_POOL_TRACKING=OFF
-          -DUMF_BUILD_LEVEL_ZERO_PROVIDER=${{matrix.level_zero_provider}}
 
       - name: Build UMF on Linux
         if: matrix.os == 'ubuntu-latest'

.github/workflows/codeql.yml

@@ -75,7 +75,7 @@ jobs:
         -DUMF_ENABLE_POOL_TRACKING=ON
         -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
+        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
 
     - name: Build
       run: cmake --build ${{github.workspace}}/build --config Release -j

.github/workflows/gpu.yml

@@ -9,9 +9,9 @@ permissions:
   contents: read
 
 jobs:
-  # TODO: add support for Windows
-  ubuntu-build:
-    name: Build - Ubuntu
+  # TODO: add support for tests on Windows
+  gpu:
+    name: Build
     # run only on upstream; forks will not have the HW
     if: github.repository == 'oneapi-src/unified-memory-framework'
 
@@ -20,6 +20,7 @@ jobs:
         build_type: [Release]
         compiler: [{c: gcc, cxx: g++}]
         shared_library: ['ON', 'OFF']
+    # TODO enable testing on DSS-WINDOWS
     runs-on:  [ "DSS-LEVEL_ZERO", "DSS-UBUNTU" ]
 
     steps:

.github/workflows/pr_push.yml

@@ -20,25 +20,21 @@ jobs:
         include:
           - os: windows-latest
             disjoint: 'OFF'
-            level_zero_provider: 'OFF' # TODO enable
           # pure C build (Windows)
           - os: windows-latest
             disjoint: 'OFF'
             # Tests' building is off for a pure C build
             extra_build_options: '-DUMF_BUILD_TESTS=OFF'
-            level_zero_provider: 'OFF' # TODO enable
           - os: ubuntu-latest
             disjoint: 'ON'
             # Windows doesn't recognize 'CMAKE_BUILD_TYPE', it uses '--config' param in build command
             extra_build_options: '-DCMAKE_BUILD_TYPE=Release -DUMF_BUILD_BENCHMARKS=ON -DUMF_BUILD_BENCHMARKS_MT=ON'
-            level_zero_provider: 'ON'
           # pure C build (Linux)
           - os: ubuntu-latest
             disjoint: 'OFF'
             # Windows doesn't recognize 'CMAKE_BUILD_TYPE', it uses '--config' param in build command
             # Tests' building is off for a pure C build
             extra_build_options: '-DCMAKE_BUILD_TYPE=Release -DUMF_BUILD_BENCHMARKS=ON -DUMF_BUILD_TESTS=OFF'
-            level_zero_provider: 'ON'
     runs-on: ${{matrix.os}}
 
     steps:
@@ -77,7 +73,7 @@ jobs:
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_TESTS=ON
         -DUMF_BUILD_EXAMPLES=ON
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=${{matrix.level_zero_provider}}
+        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
         ${{matrix.extra_build_options}}
 
     - name: Build

README.md

@@ -138,13 +138,14 @@ A memory provider that provides memory from L0 device.
 
 ##### Requirements
 
-1) Linux OS
+1) Linux or Windows OS
 2) The `UMF_BUILD_LEVEL_ZERO_PROVIDER` option turned `ON` (by default)
 
 Additionally, required for tests: 
-3) The `UMF_BUILD_GPU_TESTS` option turned `ON`
-4) System with Level Zero compatible GPU
-5) Required packages:
+3) Linux OS
+4) The `UMF_BUILD_GPU_TESTS` option turned `ON`
+5) System with Level Zero compatible GPU
+6) Required packages:
    - liblevel-zero-dev
 
 ### Memory pool managers

scripts/qemu/run-build.sh

@@ -23,15 +23,15 @@ cd build
 
 cmake .. \
     -DCMAKE_BUILD_TYPE=Debug \
+    -DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON \
     -DUMF_BUILD_OS_MEMORY_PROVIDER=ON \
     -DUMF_ENABLE_POOL_TRACKING=ON \
     -DUMF_FORMAT_CODE_STYLE=OFF \
     -DUMF_DEVELOPER_MODE=ON \
     -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON \
     -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON \
     -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON \
-    -DUMF_BUILD_EXAMPLES=ON \
-    -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
+    -DUMF_BUILD_EXAMPLES=ON
 
 make -j $(nproc)
 

src/CMakeLists.txt

@@ -142,14 +142,16 @@ else()
     target_sources(umf PRIVATE memory_pool_default.c)
 endif()
 
-# Currently, Level Zero provider is only built for Linux
-if(LINUX AND UMF_BUILD_LEVEL_ZERO_PROVIDER)
+# Currently, Level Zero provider is only built for Linux and Windows
+if((LINUX OR WINDOWS) AND UMF_BUILD_LEVEL_ZERO_PROVIDER)
     target_sources(umf PRIVATE
         provider/provider_level_zero.c)
 
-    # WA for error ze_api.h:14234:20: no newline at end of file [-Werror,-Wnewline-eof]
-    set_source_files_properties(provider/provider_level_zero.c 
-        PROPERTIES APPEND_STRING PROPERTY COMPILE_FLAGS "-Wno-newline-eof")
+    if(LINUX)
+        # WA for error ze_api.h:14234:20: no newline at end of file [-Werror,-Wnewline-eof]
+        set_source_files_properties(provider/provider_level_zero.c 
+            PROPERTIES APPEND_STRING PROPERTY COMPILE_FLAGS "-Wno-newline-eof")
+    endif()
 
     set(UMF_COMPILE_DEFINITIONS ${UMF_COMPILE_DEFINITIONS} 
         "UMF_BUILD_LEVEL_ZERO_PROVIDER=1")

src/provider/provider_level_zero.c

@@ -6,11 +6,8 @@
 */
 
 #include <assert.h>
-#include <dlfcn.h>
-#include <pthread.h>
 #include <stdbool.h>
 #include <stddef.h>
-#include <unistd.h>
 
 // Level Zero API
 #include <ze_api.h>
@@ -22,6 +19,7 @@
 #include "base_alloc_global.h"
 #include "utils_common.h"
 #include "utils_concurrency.h"
+#include "utils_load_library.h"
 #include "utils_sanitizers.h"
 
 typedef struct ze_memory_provider_t {
@@ -51,10 +49,13 @@ static bool Init_ze_global_state_failed;
 static void init_ze_global_state(void) {
     // check if Level Zero shared library is already loaded
     // we pass 0 as a handle to search the global symbol table
-    *(void **)&g_ze_ops.zeMemAllocHost = dlsym(0, "zeMemAllocHost");
-    *(void **)&g_ze_ops.zeMemAllocDevice = dlsym(0, "zeMemAllocDevice");
-    *(void **)&g_ze_ops.zeMemAllocShared = dlsym(0, "zeMemAllocShared");
-    *(void **)&g_ze_ops.zeMemFree = dlsym(0, "zeMemFree");
+    *(void **)&g_ze_ops.zeMemAllocHost =
+        util_get_symbol_addr(0, "zeMemAllocHost");
+    *(void **)&g_ze_ops.zeMemAllocDevice =
+        util_get_symbol_addr(0, "zeMemAllocDevice");
+    *(void **)&g_ze_ops.zeMemAllocShared =
+        util_get_symbol_addr(0, "zeMemAllocShared");
+    *(void **)&g_ze_ops.zeMemFree = util_get_symbol_addr(0, "zeMemFree");
 
     if (!g_ze_ops.zeMemAllocHost || !g_ze_ops.zeMemAllocDevice ||
         !g_ze_ops.zeMemAllocShared || !g_ze_ops.zeMemFree) {