Merge pull request #297 from bratpiorka/rrudnick_L0_fetch

enable building L0 prov in CI on Linux

Author: lukaszstolarczuk

.github/workflows/basic.yml

@@ -46,15 +46,15 @@ jobs:
         -DUMF_BUILD_SHARED_LIBRARY=${{matrix.shared_library}}
         -DCMAKE_C_COMPILER=${{matrix.compiler.c}}
         -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
-        -DUMF_BUILD_OS_MEMORY_PROVIDER=${{matrix.os_provider}}
+        -DUMF_BUILD_OS_MEMORY_PROVIDER=${{matrix.os_provider}}        
+        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON  
         -DUMF_ENABLE_POOL_TRACKING=${{matrix.pool_tracking}}
         -DUMF_FORMAT_CODE_STYLE=OFF
         -DUMF_DEVELOPER_MODE=ON
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
         -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON
         -DUMF_BUILD_EXAMPLES=ON
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
 
     - name: Build UMF
       run: cmake --build build -j $(nproc)
@@ -86,39 +86,60 @@ jobs:
         pool_tracking: ['ON', 'OFF']
         shared_library: ['OFF']
         os_provider: ['ON']
+        level_zero_provider: ['ON']
         include:
           - os: 'ubuntu-20.04'
             build_type: Release
             compiler: {c: gcc-7, cxx: g++-7}
             shared_library: 'OFF'
             os_provider: 'ON'
+            pool_tracking: 'ON'
+            level_zero_provider: 'ON'
           - os: 'ubuntu-22.04'
             build_type: Release
             compiler: {c: clang, cxx: clang++}
             shared_library: 'OFF'
             os_provider: 'ON'
+            pool_tracking: 'ON'
+            level_zero_provider: 'ON'
           - os: 'ubuntu-22.04'
             build_type: Release
             compiler: {c: gcc, cxx: g++}
             shared_library: 'ON'
             os_provider: 'ON'
+            pool_tracking: 'ON'
+            level_zero_provider: 'ON'
           - os: 'ubuntu-22.04'
             build_type: Debug
             compiler: {c: gcc, cxx: g++}
             shared_library: 'ON'
             os_provider: 'ON'
+            pool_tracking: 'ON'
+            level_zero_provider: 'ON'
           # test os_provider='OFF' with shared_library='ON'
           - os: 'ubuntu-22.04'
             build_type: Release
             compiler: {c: gcc, cxx: g++}
             shared_library: 'ON'
             os_provider: 'OFF'
+            pool_tracking: 'ON'
+            level_zero_provider: 'ON'
           # test os_provider='OFF' with shared_library='OFF'
           - os: 'ubuntu-22.04'
             build_type: Release
             compiler: {c: gcc, cxx: g++}
             shared_library: 'OFF'
             os_provider: 'OFF'
+            pool_tracking: 'ON'
+            level_zero_provider: 'ON'
+          # test level_zero_provider='OFF'
+          - os: 'ubuntu-22.04'
+            build_type: Release
+            compiler: {c: gcc, cxx: g++}
+            shared_library: 'OFF'
+            os_provider: 'ON'
+            pool_tracking: 'ON'
+            level_zero_provider: 'OFF'
     runs-on: ${{matrix.os}}
 
     steps:
@@ -134,7 +155,6 @@ jobs:
       if: matrix.compiler.cxx == 'g++-7'
       run: sudo apt-get install -y ${{matrix.compiler.cxx}}
 
-    # TODO enable building Level Zero provider in all workflows
     - name: Configure build
       run: >
         cmake
@@ -145,13 +165,13 @@ jobs:
         -DCMAKE_C_COMPILER=${{matrix.compiler.c}}
         -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
         -DUMF_BUILD_OS_MEMORY_PROVIDER=${{matrix.os_provider}}
+        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=${{matrix.level_zero_provider}}
         -DUMF_ENABLE_POOL_TRACKING=${{matrix.pool_tracking}}
         -DUMF_FORMAT_CODE_STYLE=OFF
         -DUMF_DEVELOPER_MODE=ON
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
         -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
 
     - name: Build UMF
       run: cmake --build ${{env.BUILD_DIR}} -j $(nproc)
@@ -187,6 +207,7 @@ jobs:
         pool_tracking: ['ON', 'OFF']
         shared_library: ['OFF']
         os_provider: ['ON']
+        # TODO add level zero provider
         include:
           - os: 'windows-2022'
             build_type: Release

.github/workflows/benchmarks.yml

@@ -14,7 +14,12 @@ 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:
-        os: ['ubuntu-latest', 'windows-latest']
+        include:
+          - os: ubuntu-latest
+            level_zero_provider: 'ON'
+          - os: windows-latest
+            level_zero_provider: 'OFF'
+
     runs-on: ${{matrix.os}}
 
     steps:
@@ -57,7 +62,7 @@ jobs:
           -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
           -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON
           -DUMF_ENABLE_POOL_TRACKING=OFF
-          -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
+          -DUMF_BUILD_LEVEL_ZERO_PROVIDER=${{matrix.level_zero_provider}}
 
       - name: Build UMF on Linux
         if: matrix.os == 'ubuntu-latest'

.github/workflows/codeql.yml

@@ -63,6 +63,7 @@ jobs:
     - name: Install pip packages
       run: python3 -m pip install -r third_party/requirements.txt
 
+    # TODO enable Level Zero provider
     - name: Configure CMake
       run: >
         cmake

.github/workflows/coverity.yml

@@ -41,7 +41,6 @@ jobs:
         -DUMF_FORMAT_CODE_STYLE=OFF
         -DUMF_DEVELOPER_MODE=OFF
         -DUMF_ENABLE_POOL_TRACKING=ON
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
         -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON

.github/workflows/gpu.yml

@@ -37,9 +37,9 @@ jobs:
           -DUMF_BUILD_SHARED_LIBRARY=${{matrix.shared_library}}
           -DUMF_BUILD_BENCHMARKS=ON
           -DUMF_BUILD_TESTS=ON
+          -DUMF_BUILD_GPU_TESTS=ON
           -DUMF_FORMAT_CODE_STYLE=ON
           -DUMF_DEVELOPER_MODE=ON
-          -DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
           -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
           -DUMF_ENABLE_POOL_TRACKING=ON
 

.github/workflows/pr_push.yml

@@ -20,21 +20,25 @@ 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:
@@ -73,7 +77,7 @@ jobs:
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_TESTS=ON
         -DUMF_BUILD_EXAMPLES=ON
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
+        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=${{matrix.level_zero_provider}}
         ${{matrix.extra_build_options}}
 
     - name: Build

.github/workflows/proxy_lib.yml

@@ -42,7 +42,6 @@ jobs:
           -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
           -DUMF_BUILD_LIBUMF_POOL_SCALABLE=ON
           -DUMF_ENABLE_POOL_TRACKING=ON
-          -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
 
       - name: Build UMF
         run: cmake --build ${{github.workspace}}/build -j $(nproc)

.github/workflows/sanitizers.yml

@@ -43,6 +43,7 @@ jobs:
         -DCMAKE_C_COMPILER=${{matrix.compiler.c}}
         -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
         -DUMF_BUILD_OS_MEMORY_PROVIDER=ON
+        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
         -DUMF_ENABLE_POOL_TRACKING=ON
         -DUMF_FORMAT_CODE_STYLE=OFF
         -DUMF_DEVELOPER_MODE=ON
@@ -53,7 +54,6 @@ jobs:
         -DUSE_UBSAN=${{matrix.sanitizers.ubsan}}
         -DUSE_TSAN=${{matrix.sanitizers.tsan}}
         -DUMF_BUILD_EXAMPLES=ON
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
 
     - name: Build UMF
       run: cmake --build ${{env.BUILD_DIR}} -j $(nproc)
@@ -89,6 +89,7 @@ jobs:
         -DCMAKE_C_COMPILER=${{matrix.compiler.c}}
         -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
         -DUMF_BUILD_OS_MEMORY_PROVIDER=ON
+        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
         -DUMF_ENABLE_POOL_TRACKING=ON
         -DUMF_FORMAT_CODE_STYLE=OFF
         -DUMF_DEVELOPER_MODE=ON
@@ -99,7 +100,6 @@ jobs:
         -DUSE_UBSAN=${{matrix.sanitizers.ubsan}}
         -DUSE_TSAN=${{matrix.sanitizers.tsan}}
         -DUMF_BUILD_EXAMPLES=ON
-        -DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
 
     - name: Build UMF
       run: cmake --build ${{env.BUILD_DIR}} -j $(nproc)
@@ -146,6 +146,7 @@ jobs:
       run: vcpkg install
       shell: pwsh # Specifies PowerShell as the shell for running the script.
 
+    # TODO enable level zero provider
     - name: Configure build
       run: >
         cmake

CMakeLists.txt

@@ -13,6 +13,7 @@ option(UMF_BUILD_LIBUMF_POOL_DISJOINT "Build the libumf_pool_disjoint static lib
 option(UMF_BUILD_LIBUMF_POOL_JEMALLOC "Build the libumf_pool_jemalloc static library" OFF)
 option(UMF_BUILD_LIBUMF_POOL_SCALABLE "Build the libumf_pool_scalable static library" OFF)
 option(UMF_BUILD_TESTS "Build UMF tests" ON)
+option(UMF_BUILD_GPU_TESTS "Build UMF GPU tests" OFF)
 option(UMF_BUILD_BENCHMARKS "Build UMF benchmarks" OFF)
 option(UMF_BUILD_BENCHMARKS_MT "Build UMF multithreaded benchmarks" OFF)
 option(UMF_BUILD_EXAMPLES "Build UMF examples" ON)

README.md

@@ -34,7 +34,7 @@ For development and contributions:
 For building tests, multithreaded benchmarks and Disjoint Pool:
 - C++ compiler with C++17 support
 
-For Level Zero memory provider and its tests:
+For Level Zero memory provider tests:
 - Level Zero headers and libraries
 - compatible GPU with installed driver
 
@@ -91,11 +91,12 @@ List of options provided by CMake:
 | - | - | - | - |
 | UMF_BUILD_SHARED_LIBRARY | Build UMF as shared library | ON/OFF | OFF |
 | UMF_BUILD_OS_MEMORY_PROVIDER | Build OS memory provider | ON/OFF | ON |
-| UMF_BUILD_LEVEL_ZERO_PROVIDER | Build Level Zero memory provider | ON/OFF | OFF |
+| UMF_BUILD_LEVEL_ZERO_PROVIDER | Build Level Zero memory provider | ON/OFF | ON |
 | UMF_BUILD_LIBUMF_POOL_DISJOINT | Build the libumf_pool_disjoint static library | ON/OFF | OFF |
 | UMF_BUILD_LIBUMF_POOL_JEMALLOC | Build the libumf_pool_jemalloc static library | ON/OFF | OFF |
 | UMF_BUILD_LIBUMF_POOL_SCALABLE | Build the libumf_pool_scalable static library | ON/OFF | OFF |
 | UMF_BUILD_TESTS | Build UMF tests | ON/OFF | ON |
+| UMF_BUILD_GPU_TESTS | Build UMF GPU tests | ON/OFF | OFF |
 | UMF_BUILD_BENCHMARKS | Build UMF benchmarks | ON/OFF | OFF |
 | UMF_BUILD_EXAMPLES | Build UMF examples | ON/OFF | ON |
 | UMF_ENABLE_POOL_TRACKING | Build UMF with pool tracking | ON/OFF | ON |
@@ -137,11 +138,14 @@ A memory provider that provides memory from L0 device.
 
 ##### Requirements
 
-1) System with Level Zero compatible GPU
-2) Linux OS
-3) The `UMF_BUILD_LIBUMF_PROVIDER_LEVEL_ZERO` option turned `ON`
-4) Required packages:
-   - level-zero-dev (TODO: check this)
+1) Linux 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:
+   - liblevel-zero-dev
 
 ### Memory pool managers
 

src/CMakeLists.txt

@@ -3,6 +3,28 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
 include(${UMF_CMAKE_SOURCE_DIR}/cmake/helpers.cmake)
+        
+if(UMF_BUILD_LEVEL_ZERO_PROVIDER)
+    include(FetchContent)
+
+    set(LEVEL_ZERO_LOADER_REPO "https://github.com/oneapi-src/level-zero.git")
+    set(LEVEL_ZERO_LOADER_TAG v1.16.1)
+    
+    FetchContent_Declare(level-zero-loader
+        GIT_REPOSITORY    ${LEVEL_ZERO_LOADER_REPO}
+        GIT_TAG           ${LEVEL_ZERO_LOADER_TAG}
+        EXCLUDE_FROM_ALL
+    )
+
+    FetchContent_GetProperties(level-zero-loader)
+    if(NOT level-zero-loader_POPULATED)
+        FetchContent_Populate(level-zero-loader)
+    endif()
+
+    set(LEVEL_ZERO_INCLUDE_DIRS ${level-zero-loader_SOURCE_DIR}/include 
+        CACHE PATH "Path to Level Zero Headers")    
+    message(STATUS "Level Zero include directory: ${LEVEL_ZERO_INCLUDE_DIRS}")
+endif()
 
 # set UMF_PROXY_LIB_BASED_ON_POOL to one of:
 # - SCALABLE
@@ -76,16 +98,6 @@ if(UMF_BUILD_OS_MEMORY_PROVIDER)
     endif()
 endif()
 
-if(UMF_BUILD_LEVEL_ZERO_PROVIDER)
-    # Currently, Level Zero provider is only built for Linux
-    # TODO add fetch content or PkgConfig/find_package for Level Zero
-    set(UMF_SOURCES_LINUX ${UMF_SOURCES_LINUX}
-        provider/provider_level_zero.c)
-
-    set(UMF_COMPILE_DEFINITIONS ${UMF_COMPILE_DEFINITIONS}
-        "UMF_BUILD_LEVEL_ZERO_PROVIDER=1")
-endif()
-
 if(LINUX)
     set(UMF_SOURCES ${UMF_SOURCES} ${UMF_SOURCES_LINUX})
 elseif(WINDOWS)
@@ -130,12 +142,29 @@ 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)
+    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")
+
+    set(UMF_COMPILE_DEFINITIONS ${UMF_COMPILE_DEFINITIONS} 
+        "UMF_BUILD_LEVEL_ZERO_PROVIDER=1")
+endif()
+
 add_library(${PROJECT_NAME}::umf ALIAS umf)
 
 if(LIBHWLOC_INCLUDE_DIRS)
     target_include_directories(umf PRIVATE ${LIBHWLOC_INCLUDE_DIRS})
 endif()
 
+if (LEVEL_ZERO_INCLUDE_DIRS)
+    target_include_directories(umf PRIVATE ${LEVEL_ZERO_INCLUDE_DIRS})
+endif()
+
 target_include_directories(umf PUBLIC
     $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>

src/provider/provider_level_zero.c

@@ -12,7 +12,8 @@
 #include <stddef.h>
 #include <unistd.h>
 
-#include <level_zero/ze_api.h>
+// Level Zero API
+#include <ze_api.h>
 
 #include <umf.h>
 #include <umf/memory_provider_ops.h>
@@ -84,7 +85,7 @@ enum umf_result_t ze_memory_provider_initialize(void *params, void **provider) {
 
     ze_provider->context = ze_params->level_zero_context_handle;
     ze_provider->device = ze_params->level_zero_device_handle;
-    ze_provider->memory_type = ze_params->memory_type;
+    ze_provider->memory_type = (ze_memory_type_t)ze_params->memory_type;
 
     *provider = ze_provider;