Skip to content

Commit 7eb4364

Browse files
bratpiorkabratpiorka
committed
add CUDA provider
1 parent fb3f1f4 commit 7eb4364

27 files changed

+908
-18
lines changed

‎.github/workflows/basic.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ jobs:
133133
-DCMAKE_C_COMPILER=${{matrix.compiler.c}}
134134
-DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
135135
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=${{matrix.level_zero_provider}}
136+
-DUMF_BUILD_CUDA_PROVIDER=ON
136137
-DUMF_FORMAT_CODE_STYLE=OFF
137138
-DUMF_DEVELOPER_MODE=ON
138139
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
@@ -287,6 +288,7 @@ jobs:
287288
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
288289
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=OFF
289290
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
291+
-DUMF_BUILD_CUDA_PROVIDER=ON
290292
-DUMF_TESTS_FAIL_ON_SKIP=ON
291293
-DUMF_LINK_HWLOC_STATICALLY=ON
292294
@@ -329,6 +331,7 @@ jobs:
329331
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
330332
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=OFF
331333
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
334+
-DUMF_BUILD_CUDA_PROVIDER=ON
332335
-DUMF_TESTS_FAIL_ON_SKIP=ON
333336
-DUMF_LINK_HWLOC_STATICALLY=ON
334337

‎.github/workflows/benchmarks.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ jobs:
6363
-DUMF_FORMAT_CODE_STYLE=OFF
6464
-DUMF_DEVELOPER_MODE=OFF
6565
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
66+
-DUMF_BUILD_CUDA_PROVIDER=ON
6667
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
6768
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
6869

‎.github/workflows/codeql.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ jobs:
8484
-DUMF_DEVELOPER_MODE=ON
8585
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
8686
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
87+
-DUMF_BUILD_CUDA_PROVIDER=ON
8788
-DUMF_TESTS_FAIL_ON_SKIP=ON
8889
8990
- name: Build

‎.github/workflows/fast.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ jobs:
106106
-DUMF_BUILD_TESTS=${{matrix.build_tests}}
107107
-DUMF_BUILD_EXAMPLES=ON
108108
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
109+
-DUMF_BUILD_CUDA_PROVIDER=ON
109110
-DUMF_TESTS_FAIL_ON_SKIP=ON
110111
-DUMF_BUILD_SHARED_LIBRARY=ON
111112
${{matrix.extra_build_options}}

‎.github/workflows/gpu.yml

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ env:
1313
INSTL_DIR : "${{github.workspace}}/../install-dir"
1414

1515
jobs:
16-
gpu:
16+
gpu-l0:
1717
name: Build
1818
env:
1919
BUILD_TYPE: Release
@@ -63,6 +63,7 @@ jobs:
6363
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
6464
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
6565
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
66+
-DUMF_BUILD_CUDA_PROVIDER=OFF
6667
-DUMF_TESTS_FAIL_ON_SKIP=ON
6768
6869
- name: Configure build for Ubuntu
@@ -84,6 +85,71 @@ jobs:
8485
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
8586
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
8687
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
88+
-DUMF_BUILD_CUDA_PROVIDER=OFF
89+
-DUMF_TESTS_FAIL_ON_SKIP=ON
90+
91+
- name: Build UMF
92+
run: cmake --build ${{env.BUILD_DIR}} --config ${{env.BUILD_TYPE}} -j ${{matrix.number_of_processors}}
93+
94+
- name: Run tests
95+
working-directory: ${{env.BUILD_DIR}}
96+
run: ctest -C ${{env.BUILD_TYPE}} --output-on-failure --test-dir test
97+
98+
- name: Run examples
99+
working-directory: ${{env.BUILD_DIR}}
100+
run: ctest --output-on-failure --test-dir examples -C ${{env.BUILD_TYPE}}
101+
102+
- name: Run benchmarks
103+
working-directory: ${{env.BUILD_DIR}}
104+
run: ctest --output-on-failure --test-dir benchmark -C ${{env.BUILD_TYPE}} --exclude-regex umf-bench-multithreaded
105+
106+
gpu-cuda:
107+
name: Build
108+
env:
109+
BUILD_TYPE: Release
110+
# run only on upstream; forks will not have the HW
111+
if: github.repository == 'oneapi-src/unified-memory-framework'
112+
strategy:
113+
matrix:
114+
shared_library: ['ON', 'OFF']
115+
# TODO add windows
116+
os: ['Ubuntu']
117+
include:
118+
- os: 'Ubuntu'
119+
compiler: {c: gcc, cxx: g++}
120+
number_of_processors: '$(nproc)'
121+
122+
runs-on: ["DSS-CUDA", "DSS-${{matrix.os}}"]
123+
steps:
124+
- name: Checkout
125+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
126+
with:
127+
fetch-depth: 0
128+
129+
- name: Get information about platform
130+
if: matrix.os == 'Ubuntu'
131+
run: .github/scripts/get_system_info.sh
132+
133+
- name: Configure build for Ubuntu
134+
if: matrix.os == 'Ubuntu'
135+
run: >
136+
cmake
137+
-B ${{env.BUILD_DIR}}
138+
-DCMAKE_INSTALL_PREFIX="${{env.INSTL_DIR}}"
139+
-DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
140+
-DCMAKE_C_COMPILER=${{matrix.compiler.c}}
141+
-DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
142+
-DUMF_BUILD_SHARED_LIBRARY=${{matrix.shared_library}}
143+
-DUMF_BUILD_BENCHMARKS=ON
144+
-DUMF_BUILD_TESTS=ON
145+
-DUMF_BUILD_GPU_TESTS=ON
146+
-DUMF_BUILD_GPU_EXAMPLES=ON
147+
-DUMF_FORMAT_CODE_STYLE=OFF
148+
-DUMF_DEVELOPER_MODE=ON
149+
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
150+
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
151+
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
152+
-DUMF_BUILD_CUDA_PROVIDER=ON
87153
-DUMF_TESTS_FAIL_ON_SKIP=ON
88154
89155
- name: Build UMF

‎.github/workflows/nightly.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ jobs:
7979
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
8080
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
8181
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
82+
-DUMF_BUILD_CUDA_PROVIDER=OFF
8283
-DUMF_USE_VALGRIND=1
8384
-DUMF_TESTS_FAIL_ON_SKIP=ON
8485

‎.github/workflows/pr_push.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ jobs:
3737
-DUMF_FORMAT_CODE_STYLE=ON
3838
-DUMF_BUILD_TESTS=OFF
3939
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
40+
-DUMF_BUILD_CUDA_PROVIDER=OFF
4041
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=OFF
4142
4243
- name: Check C/C++ formatting

‎.github/workflows/sanitizers.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ jobs:
5555
-DCMAKE_C_COMPILER=${{matrix.compiler.c}}
5656
-DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
5757
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON
58+
-DUMF_BUILD_CUDA_PROVIDER=ON
5859
-DUMF_FORMAT_CODE_STYLE=OFF
5960
-DUMF_DEVELOPER_MODE=ON
6061
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
@@ -130,6 +131,7 @@ jobs:
130131
-DUMF_USE_ASAN=${{matrix.sanitizers.asan}}
131132
-DUMF_BUILD_EXAMPLES=ON
132133
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
134+
-DUMF_BUILD_CUDA_PROVIDER=OFF
133135
-DUMF_TESTS_FAIL_ON_SKIP=ON
134136
135137
- name: Build UMF

‎.github/workflows/valgrind.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ jobs:
3535
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
3636
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
3737
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
38+
-DUMF_BUILD_CUDA_PROVIDER=OFF
3839
-DUMF_USE_VALGRIND=1
3940
-DUMF_TESTS_FAIL_ON_SKIP=ON
4041

‎CMakeLists.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ find_package(PkgConfig)
3636
# Build Options
3737
option(UMF_BUILD_SHARED_LIBRARY "Build UMF as shared library" OFF)
3838
option(UMF_BUILD_LEVEL_ZERO_PROVIDER "Build Level Zero memory provider" ON)
39+
option(UMF_BUILD_CUDA_PROVIDER "Build CUDA memory provider" ON)
3940
option(UMF_BUILD_LIBUMF_POOL_DISJOINT
4041
"Build the libumf_pool_disjoint static library" OFF)
4142
option(UMF_BUILD_LIBUMF_POOL_JEMALLOC
@@ -399,6 +400,11 @@ if(UMF_BUILD_LEVEL_ZERO_PROVIDER)
399400
add_optional_symbol(umfLevelZeroMemoryProviderOps)
400401
endif()
401402

403+
# Conditional configuration for CUDA provider
404+
if(UMF_BUILD_CUDA_PROVIDER)
405+
add_optional_symbol(umfCUDAMemoryProviderOps)
406+
endif()
407+
402408
if(NOT UMF_DISABLE_HWLOC)
403409
add_optional_symbol(umfOsMemoryProviderOps)
404410
endif()

‎README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For a quick introduction to UMF usage, please see
2121
documentation, which includes the code of the
2222
[basic example](https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/basic/basic.c)
2323
and the more advanced one that allocates
24-
[USM memory from the GPU device](https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/basic/gpu_shared_memory.c)
24+
[USM memory from the Level Zero device](https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/gpu_shared_memory/level_zero_shared_memory.c)
2525
using the Level Zero API and UMF Level Zero memory provider.
2626

2727
## Build
@@ -101,6 +101,7 @@ List of options provided by CMake:
101101
| - | - | - | - |
102102
| UMF_BUILD_SHARED_LIBRARY | Build UMF as shared library | ON/OFF | OFF |
103103
| UMF_BUILD_LEVEL_ZERO_PROVIDER | Build Level Zero memory provider | ON/OFF | ON |
104+
| UMF_BUILD_CUDA_PROVIDER | Build CUDA memory provider | ON/OFF | ON |
104105
| UMF_BUILD_LIBUMF_POOL_DISJOINT | Build the libumf_pool_disjoint static library | ON/OFF | OFF |
105106
| UMF_BUILD_LIBUMF_POOL_JEMALLOC | Build the libumf_pool_jemalloc static library | ON/OFF | OFF |
106107
| UMF_BUILD_TESTS | Build UMF tests | ON/OFF | ON |
@@ -172,6 +173,10 @@ Additionally, required for tests:
172173
5) Required packages:
173174
- liblevel-zero-dev (Linux) or level-zero-sdk (Windows)
174175

176+
#### CUDA memory provider
177+
178+
TODO
179+
175180
### Memory pool managers
176181

177182
#### Proxy pool (part of libumf)

‎benchmark/CMakeLists.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ function(add_umf_benchmark)
8585
target_compile_definitions(${BENCH_NAME}
8686
PRIVATE UMF_BUILD_LEVEL_ZERO_PROVIDER=1)
8787
endif()
88+
if(UMF_BUILD_CUDA_PROVIDER)
89+
target_compile_definitions(${BENCH_NAME}
90+
PRIVATE UMF_BUILD_CUDA_PROVIDER=1)
91+
endif()
8892
if(UMF_BUILD_GPU_TESTS)
8993
target_compile_definitions(${BENCH_NAME} PRIVATE UMF_BUILD_GPU_TESTS=1)
9094
endif()

‎benchmark/ubench.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,8 @@ UBENCH_EX(ipc, disjoint_pool_with_level_zero_provider) {
505505
}
506506
#endif /* (defined UMF_BUILD_LIBUMF_POOL_DISJOINT && defined UMF_BUILD_LEVEL_ZERO_PROVIDER && defined UMF_BUILD_GPU_TESTS) */
507507

508+
// TODO add IPC benchmark for CUDA
509+
508510
UBENCH_MAIN()
509511

510512
#if defined(_MSC_VER)

‎examples/CMakeLists.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,16 @@ if(UMF_POOL_SCALABLE_ENABLED)
4141
endif()
4242
endif()
4343

44+
# TODO add CUDA examples
45+
4446
if(UMF_BUILD_GPU_EXAMPLES
4547
AND UMF_BUILD_LIBUMF_POOL_DISJOINT
4648
AND UMF_BUILD_LEVEL_ZERO_PROVIDER)
47-
set(EXAMPLE_NAME umf_example_gpu_shared_memory)
49+
set(EXAMPLE_NAME umf_example_level_zero_shared_memory)
4850

4951
add_umf_executable(
5052
NAME ${EXAMPLE_NAME}
51-
SRCS gpu_shared_memory/gpu_shared_memory.c
53+
SRCS gpu_shared_memory/level_zero_shared_memory.c
5254
LIBS disjoint_pool ze_loader umf)
5355

5456
target_include_directories(

‎examples/gpu_shared_memory/CMakeLists.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
44

55
cmake_minimum_required(VERSION 3.14.0 FATAL_ERROR)
6-
project(umf_example_gpu_shared_memory LANGUAGES C)
6+
project(umf_example_level_zero_shared_memory LANGUAGES C)
77
enable_testing()
88

99
set(UMF_EXAMPLE_DIR "${CMAKE_SOURCE_DIR}/..")
@@ -48,8 +48,8 @@ set(LEVEL_ZERO_INCLUDE_DIRS
4848
message(STATUS "Level Zero include directory: ${LEVEL_ZERO_INCLUDE_DIRS}")
4949

5050
# build the example
51-
set(EXAMPLE_NAME umf_example_gpu_shared_memory)
52-
add_executable(${EXAMPLE_NAME} gpu_shared_memory.c)
51+
set(EXAMPLE_NAME umf_example_level_zero_shared_memory)
52+
add_executable(${EXAMPLE_NAME} level_zero_shared_memory.c)
5353
target_include_directories(${EXAMPLE_NAME} PRIVATE ${LIBUMF_INCLUDE_DIRS}
5454
${UMF_EXAMPLE_DIR}/common)
5555
target_link_directories(${EXAMPLE_NAME} PRIVATE ${LIBUMF_LIBRARY_DIRS}

‎examples/gpu_shared_memory/gpu_shared_memory.c renamed to ‎examples/gpu_shared_memory/level_zero_shared_memory.c

File renamed without changes.

‎include/umf/memory_provider.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@
1717
extern "C" {
1818
#endif
1919

20+
/// @brief USM memory allocation type
21+
typedef enum umf_usm_memory_type_t {
22+
UMF_MEMORY_TYPE_UNKNOWN = 0, ///< The memory pointed to is of unknown type
23+
UMF_MEMORY_TYPE_HOST, ///< The memory pointed to is a host allocation
24+
UMF_MEMORY_TYPE_DEVICE, ///< The memory pointed to is a device allocation
25+
UMF_MEMORY_TYPE_SHARED, ///< The memory pointed to is a shared ownership allocation
26+
} umf_usm_memory_type_t;
27+
2028
/// @brief A struct containing memory provider specific set of functions
2129
typedef struct umf_memory_provider_t *umf_memory_provider_handle_t;
2230

‎include/umf/providers/provider_cuda.h

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/*
2+
* Copyright (C) 2024 Intel Corporation
3+
*
4+
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
5+
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
*/
7+
8+
#ifndef UMF_PROVIDER_CUDA_H
9+
#define UMF_PROVIDER_CUDA_H
10+
11+
#include "umf/memory_provider.h"
12+
13+
#ifdef __cplusplus
14+
extern "C" {
15+
#endif
16+
17+
/// @brief CUDA Memory Provider settings struct
18+
typedef struct cuda_memory_provider_params_t {
19+
void *cuda_context_handle; ///< Handle to the CUDA context
20+
int cuda_device_handle; ///< Handle to the CUDA device
21+
umf_usm_memory_type_t memory_type; ///< Allocation memory type
22+
} cuda_memory_provider_params_t;
23+
24+
umf_memory_provider_ops_t *umfCUDAMemoryProviderOps(void);
25+
26+
#ifdef __cplusplus
27+
}
28+
#endif
29+
30+
#endif /* UMF_PROVIDER_CUDA_H */

‎include/umf/providers/provider_level_zero.h

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,6 @@
1414
extern "C" {
1515
#endif
1616

17-
/// @brief USM memory allocation type
18-
typedef enum umf_usm_memory_type_t {
19-
UMF_MEMORY_TYPE_UNKNOWN = 0, ///< The memory pointed to is of unknown type
20-
UMF_MEMORY_TYPE_HOST, ///< The memory pointed to is a host allocation
21-
UMF_MEMORY_TYPE_DEVICE, ///< The memory pointed to is a device allocation
22-
UMF_MEMORY_TYPE_SHARED, ///< The memory pointed to is a shared ownership allocation
23-
} umf_usm_memory_type_t;
24-
2517
/// @brief Level Zero Memory Provider settings struct
2618
typedef struct level_zero_memory_provider_params_t {
2719
void *level_zero_context_handle; ///< Handle to the Level Zero context

‎scripts/docs_config/examples.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Freeing memory is as easy as can be::
111111
GPU shared memory
112112
==============================================================================
113113

114-
You can find the full example code in the `examples/gpu_shared_memory/gpu_shared_memory.c`_ file
114+
You can find the full example code in the `examples/gpu_shared_memory/level_zero_shared_memory.c`_ file
115115
in the UMF repository.
116116

117117
TODO
@@ -209,7 +209,7 @@ function is called on the consumer side. The memory mappings on the consumer sid
209209
the :any:`umfCloseIPCHandle` function is called.
210210

211211
.. _examples/basic/basic.c: https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/basic/basic.c
212-
.. _examples/gpu_shared_memory/gpu_shared_memory.c: https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/gpu_shared_memory/gpu_shared_memory.c
212+
.. _examples/gpu_shared_memory/level_zero_shared_memory.c: https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/gpu_shared_memory/level_zero_shared_memory.c
213213
.. _examples/ipc_level_zero/ipc_level_zero.c: https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/ipc_level_zero/ipc_level_zero.c
214214
.. _examples/custom_provider/file_provider.c: https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/custom_provider/file_provider.c
215215
.. _examples/memspace: https://github.com/oneapi-src/unified-memory-framework/blob/main/examples/memspace/

‎scripts/qemu/run-build.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ cd build
2121
cmake .. \
2222
-DCMAKE_BUILD_TYPE=Debug \
2323
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=ON \
24+
-DUMF_BUILD_CUDA_PROVIDER=ON \
2425
-DUMF_FORMAT_CODE_STYLE=OFF \
2526
-DUMF_DEVELOPER_MODE=ON \
2627
-DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON \

0 commit comments

Comments
 (0)