add Level Zero memory provider

bratpiorka · bratpiorka · commit 1dd0cb73af3c · 2024-02-29T11:08:06.000+01:00
diff --git a/.github/workflows/gpu.yml b/.github/workflows/gpu.yml
@@ -0,0 +1,49 @@
+# This workflow builds and tests providers using GPU memory. It requires 
+# "level_zero" labeled self-hosted runners installed on systems with the 
+# appropriate GPU and drivers.
+name: GPU
+
+on: [workflow_call]
+
+permissions:
+  contents: read
+
+jobs:
+  # TODO: add support for Windows
+  ubuntu-build:
+    name: Build - Ubuntu
+
+    strategy:
+      matrix:
+        os: ['ubuntu-22.04']
+        build_type: [Release]
+        compiler: [{c: gcc, cxx: g++}]
+        shared_library: ['ON', 'OFF']
+    runs-on: level_zero
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - name: Configure build
+        run: >
+          cmake
+          -B ${{github.workspace}}/build
+          -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}}
+          -DUMF_BUILD_BENCHMARKS=ON
+          -DUMF_BUILD_TESTS=ON
+          -DUMF_FORMAT_CODE_STYLE=ON
+          -DUMF_DEVELOPER_MODE=ON
+          -DUMF_BUILD_LIBUMF_PROVIDER_LEVEL_ZERO=ON
+          -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
+          -DUMF_ENABLE_POOL_TRACKING=ON
+
+      - name: Build UMF
+        run: cmake --build ${{github.workspace}}/build -j $(nproc)
+
+      - name: Run tests
+        working-directory: ${{github.workspace}}/build
+        run: ctest --output-on-failure --test-dir test
diff --git a/.github/workflows/pr_push.yml b/.github/workflows/pr_push.yml
@@ -117,3 +117,6 @@ jobs:
   ProxyLib:
     needs: [Build]
     uses: ./.github/workflows/proxy_lib.yml
+  GPU:
+    needs: [Build]
+    uses: ./.github/workflows/gpu.yml
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -8,6 +8,7 @@ project(unified-memory-framework VERSION 0.1.0 LANGUAGES C)
 # Build Options
 option(UMF_BUILD_SHARED_LIBRARY "Build UMF as shared library" OFF)
 option(UMF_BUILD_OS_MEMORY_PROVIDER "Build OS memory provider" ON)
+option(UMF_BUILD_LIBUMF_PROVIDER_LEVEL_ZERO "Build Level Zero memory provider" OFF)
 option(UMF_BUILD_LIBUMF_POOL_DISJOINT "Build the libumf_pool_disjoint static library" OFF)
 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)
diff --git a/README.md b/README.md
@@ -31,6 +31,10 @@ 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:
+- Level Zero headers and libraries
+- compatible GPU with installed driver
+
 ### Linux
 
 Executable and binaries will be in **build/bin**
@@ -84,6 +88,7 @@ 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_LIBUMF_PROVIDER_LEVEL_ZERO | Build Level Zero memory provider | ON/OFF | OFF |
 | 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 |
@@ -123,6 +128,18 @@ A memory provider that provides memory from an operating system.
 4) Required packages for tests:
    - libnuma-dev
 
+#### Level Zero memory provider (Linux-only yet)
+
+A memory provider that provides memory from a graphics 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:
+   - TODO
+
 ### Memory pool managers
 
 #### proxy_pool (part of libumf)
diff --git a/benchmark/CMakeLists.txt b/benchmark/CMakeLists.txt
@@ -52,6 +52,10 @@ if (UMF_BUILD_OS_MEMORY_PROVIDER)
 	endif()
 endif()
 
+if (UMF_BUILD_LIBUMF_PROVIDER_LEVEL_ZERO)
+	target_compile_definitions(ubench PRIVATE UMF_BUILD_LIBUMF_PROVIDER_LEVEL_ZERO=1)
+endif()
+
 if (UMF_BUILD_LIBUMF_POOL_DISJOINT)
 	target_compile_definitions(ubench PRIVATE UMF_BUILD_LIBUMF_POOL_DISJOINT=1)
 
diff --git a/include/umf/providers/provider_level_zero.h b/include/umf/providers/provider_level_zero.h
@@ -0,0 +1,41 @@
+/*
+ * 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
+*/
+
+#ifndef UMF_PROVIDER_LEVEL_ZERO_H
+#define UMF_PROVIDER_LEVEL_ZERO_H
+
+#include "umf/memory_provider.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/// @brief USM memory allocation type
+typedef enum umf_usm_memory_type_t {
+    UMF_MEMORY_TYPE_UNKNOWN = 0,
+    UMF_MEMORY_TYPE_HOST,
+    UMF_MEMORY_TYPE_DEVICE,
+    UMF_MEMORY_TYPE_SHARED,
+} umf_usm_memory_type_t;
+
+/// @brief Level Zero Memory Provider settings struct
+typedef struct level_zero_memory_provider_params_t {
+    void *level_zero_context_handle;
+    void *level_zero_device_handle;
+    umf_usm_memory_type_t memory_type;
+    uint32_t level_zero_host_mem_alloc_flags;
+    uint32_t level_zero_device_mem_alloc_flags;
+    uint32_t level_zero_device_local_mem_ordinal;
+} level_zero_memory_provider_params_t;
+
+umf_memory_provider_ops_t *umfLevelZeroMemoryProviderOps(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* UMF_PROVIDER_LEVEL_ZERO_H */
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -115,6 +115,7 @@ install(TARGETS umf
 )
 
 add_subdirectory(pool)
+add_subdirectory(provider)
 
 # TODO: enable proxy_lib on Windows
 if(LINUX)
diff --git a/src/libumf.map b/src/libumf.map
@@ -6,6 +6,7 @@ UMF_1.0 {
     global:
         umfFree;
         umfGetLastFailedMemoryProvider;
+        umfLevelZeroMemoryProviderOps;
         umfMemoryProviderAlloc;
         umfMemoryProviderAllocationMerge;
         umfMemoryProviderAllocationSplit;
diff --git a/src/pool/pool_scalable.c b/src/pool/pool_scalable.c
@@ -13,7 +13,6 @@
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdio.h>
-#include <stdlib.h>
 #include <string.h>
 
 #include "umf/pools/pool_scalable.h"
diff --git a/src/provider/CMakeLists.txt b/src/provider/CMakeLists.txt
@@ -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
+
+# libumf_provider_level_zero
+if(UMF_BUILD_LIBUMF_PROVIDER_LEVEL_ZERO)
+    add_umf_library(NAME level_zero_provider
+                    TYPE STATIC
+                    SRCS provider_level_zero.c ${BA_SOURCES}
+                    LIBS umf_utils)
+    target_compile_definitions(level_zero_provider PUBLIC ${PROVIDER_COMPILE_DEFINITIONS})
+
+    add_library(${PROJECT_NAME}::level_zero_provider ALIAS level_zero_provider)
+
+    add_dependencies(level_zero_provider
+        umf)
+
+    target_link_libraries(level_zero_provider PRIVATE
+        umf)
+
+    target_include_directories(level_zero_provider PUBLIC
+        $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include/umf/providers>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+    )
+
+    install(TARGETS level_zero_provider
+        EXPORT ${PROJECT_NAME}-targets
+    )
+endif()
diff --git a/src/provider/provider_level_zero.c b/src/provider/provider_level_zero.c
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
diff --git a/test/providers/provider_level_zero.cpp b/test/providers/provider_level_zero.cpp
diff --git a/test/test_make_install.txt b/test/test_make_install.txt

Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,7 @@ install(TARGETS umf`
`115`	`115`	`)`
`116`	`116`
`117`	`117`	`add_subdirectory(pool)`
	`118`	`+add_subdirectory(provider)`
`118`	`119`
`119`	`120`	`# TODO: enable proxy_lib on Windows`
`120`	`121`	`if(LINUX)`