Merge pull request #1430 from igchor/umf_dynamic_linking

Bump UMF version and switch to dynamic linking

.github/docker/ubuntu-22.04.Dockerfile

@@ -32,7 +32,8 @@ ARG BASE_DEPS="\
 ARG UR_DEPS="\
  doxygen \
  python3 \
- python3-pip"
+ python3-pip \
+ libhwloc-dev"
 
 # Unified Runtime's dependencies (installed via pip)
 ARG UR_PYTHON_DEPS="\

.github/scripts/install_hwloc.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+# Copyright (C) 2024 Intel Corporation
+# Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
+# See LICENSE.TXT
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# install_hwloc.sh - Script for building and installing HWLOC library from source code
+
+set -e
+
+git clone -b hwloc-2.3.0 https://github.com/open-mpi/hwloc.git
+pushd hwloc
+./autogen.sh
+./configure
+make -j$(nproc)
+sudo make install -j$(nproc)
+popd

.github/workflows/cmake.yml

@@ -47,6 +47,9 @@ jobs:
  sudo apt-get update
  sudo apt-get install -y doxygen ${{matrix.compiler.c}}
 
+ - name: Install libhwloc
+ run: .github/scripts/install_hwloc.sh
+
  - name: Install g++-7
  if: matrix.compiler.cxx == 'g++-7'
  run: |
@@ -224,11 +227,17 @@ jobs:
  Expand-Archive -Path "$WorkingDir\doxygen.zip"
  Add-Content $env:GITHUB_PATH "$WorkingDir\doxygen"
 
+ - name: Install hwloc
+ run: vcpkg install hwloc:x64-windows
+
  - name: Configure CMake
+ env:
+ VCPKG_PATH: "C:/vcpkg/packages/hwloc_x64-windows"
  run: >
  cmake
  -B${{github.workspace}}/build
  ${{matrix.toolset}}
+ -DCMAKE_PREFIX_PATH="${{env.VCPKG_PATH}}"
  -DCMAKE_C_COMPILER=${{matrix.compiler.c}}
  -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
  -DCMAKE_POLICY_DEFAULT_CMP0094=NEW
@@ -267,6 +276,9 @@ jobs:
  - name: Install prerequisites
  run: python3 -m pip install -r third_party/requirements.txt
 
+ - name: Install hwloc
+ run: brew install hwloc
+
  - name: Configure CMake
  run: >
  cmake

.github/workflows/codeql.yml

@@ -31,6 +31,11 @@ jobs:
  - name: Install pip packages
  run: pip install -r third_party/requirements.txt
 
+ - name: Install apt packages
+ run: |
+ sudo apt-get update
+ sudo apt-get install -y libhwloc-dev
+
  - name: Configure CMake
  run: cmake -B ${{github.workspace}}/build -DUR_DEVELOPER_MODE=ON -DUR_BUILD_TESTS=ON -DUR_ENABLE_TRACING=ON -DUR_BUILD_TOOLS=ON -DUMF_ENABLE_POOL_TRACKING=ON
 
@@ -61,8 +66,13 @@ jobs:
  - name: Install pip packages
  run: python3 -m pip install -r third_party/requirements.txt
 
+ - name: Install hwloc
+ run: vcpkg install hwloc:x64-windows
+
  - name: Configure CMake
- run: cmake -B ${{github.workspace}}/build -DCMAKE_POLICY_DEFAULT_CMP0094=NEW -DUR_DEVELOPER_MODE=ON -DUR_BUILD_TESTS=ON -DUR_ENABLE_TRACING=ON -DUR_BUILD_TOOLS=ON -DUMF_ENABLE_POOL_TRACKING=ON
+ env:
+ VCPKG_PATH: "C:/vcpkg/packages/hwloc_x64-windows"
+ run: cmake -B ${{github.workspace}}/build -DCMAKE_POLICY_DEFAULT_CMP0094=NEW -DUR_DEVELOPER_MODE=ON -DUR_BUILD_TESTS=ON -DUR_ENABLE_TRACING=ON -DUR_BUILD_TOOLS=ON -DUMF_ENABLE_POOL_TRACKING=ON -DCMAKE_PREFIX_PATH="${{env.VCPKG_PATH}}"
 
  - name: Build
  run: cmake --build ${{github.workspace}}/build -j $(nproc) --config Release

.github/workflows/coverity.yml

@@ -38,6 +38,11 @@ jobs:
  - name: Install pip packages
  run: pip install -r third_party/requirements.txt
 
+ - name: Install apt packages
+ run: |
+ sudo apt-get update
+ sudo apt-get install -y libhwloc-dev
+
  - name: Configure CMake
  run: >
  cmake

CMakeLists.txt

@@ -37,7 +37,7 @@ option(UR_USE_MSAN "enable MemorySanitizer" OFF)
 option(UR_USE_TSAN "enable ThreadSanitizer" OFF)
 option(UR_ENABLE_TRACING "enable api tracing through xpti" OFF)
 option(UR_ENABLE_SANITIZER "enable device sanitizer" ON)
-option(UMF_BUILD_SHARED_LIBRARY "Build UMF as shared library" OFF)
+option(UMF_BUILD_SHARED_LIBRARY "Build UMF as shared library" ON)
 option(UMF_ENABLE_POOL_TRACKING "Build UMF with pool tracking" ON)
 option(UR_BUILD_ADAPTER_L0 "Build the Level-Zero adapter" OFF)
 option(UR_BUILD_ADAPTER_OPENCL "Build the OpenCL adapter" OFF)

source/adapters/cuda/CMakeLists.txt

@@ -114,6 +114,7 @@ endif()
 target_link_libraries(${TARGET_NAME} PRIVATE
  ${PROJECT_NAME}::headers
  ${PROJECT_NAME}::common
+ ${PROJECT_NAME}::umf
  Threads::Threads
  cudadrv
  ${EXTRA_LIBS}

source/adapters/cuda/usm.cpp

@@ -398,7 +398,7 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
 
  HostMemPool =
  umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs.Configs[usm::DisjointPoolMemType::Host])
  .second;
 
@@ -407,15 +407,15 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
  umf::memoryProviderMakeUnique<USMDeviceMemoryProvider>(Context, Device)
  .second;
  DeviceMemPool = umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs
  .Configs[usm::DisjointPoolMemType::Device])
  .second;
  MemProvider =
  umf::memoryProviderMakeUnique<USMSharedMemoryProvider>(Context, Device)
  .second;
  SharedMemPool = umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs
  .Configs[usm::DisjointPoolMemType::Shared])
  .second;

source/adapters/cuda/usm.hpp

@@ -81,6 +81,12 @@ class USMMemoryProvider {
  umf_result_t purge_force(void *, size_t) {
  return UMF_RESULT_ERROR_NOT_SUPPORTED;
  };
+ umf_result_t allocation_merge(void *, void *, size_t) {
+ return UMF_RESULT_ERROR_UNKNOWN;
+ }
+ umf_result_t allocation_split(void *, size_t, size_t) {
+ return UMF_RESULT_ERROR_UNKNOWN;
+ }
  virtual const char *get_name() = 0;
 
  virtual ~USMMemoryProvider() = default;

source/adapters/hip/CMakeLists.txt

@@ -140,6 +140,7 @@ if("${UR_HIP_PLATFORM}" STREQUAL "AMD")
  target_link_libraries(${TARGET_NAME} PRIVATE
  ${PROJECT_NAME}::headers
  ${PROJECT_NAME}::common
+ ${PROJECT_NAME}::umf
  rocmdrv
  )
 
@@ -174,6 +175,7 @@ elseif("${UR_HIP_PLATFORM}" STREQUAL "NVIDIA")
  target_link_libraries(${TARGET_NAME} PRIVATE
  ${PROJECT_NAME}::headers
  ${PROJECT_NAME}::common
+ ${PROJECT_NAME}::umf
  Threads::Threads
  cudadrv
  cudart

source/adapters/hip/usm.cpp

@@ -340,7 +340,7 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
 
  HostMemPool =
  umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs.Configs[usm::DisjointPoolMemType::Host])
  .second;
 
@@ -349,7 +349,7 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
  umf::memoryProviderMakeUnique<USMDeviceMemoryProvider>(Context, Device)
  .second;
  DeviceMemPool = umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs
  .Configs[usm::DisjointPoolMemType::Device])
  .second;
@@ -358,7 +358,7 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
  umf::memoryProviderMakeUnique<USMSharedMemoryProvider>(Context, Device)
  .second;
  SharedMemPool = umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs
  .Configs[usm::DisjointPoolMemType::Shared])
  .second;

source/adapters/hip/usm.hpp

@@ -81,6 +81,12 @@ class USMMemoryProvider {
  umf_result_t purge_force(void *, size_t) {
  return UMF_RESULT_ERROR_NOT_SUPPORTED;
  };
+ umf_result_t allocation_merge(void *, void *, size_t) {
+ return UMF_RESULT_ERROR_UNKNOWN;
+ }
+ umf_result_t allocation_split(void *, size_t, size_t) {
+ return UMF_RESULT_ERROR_UNKNOWN;
+ }
  virtual const char *get_name() = 0;
 
  virtual ~USMMemoryProvider() = default;

source/adapters/level_zero/CMakeLists.txt

@@ -166,6 +166,7 @@ endif()
 target_link_libraries(${TARGET_NAME} PRIVATE
  ${PROJECT_NAME}::headers
  ${PROJECT_NAME}::common
+ ${PROJECT_NAME}::umf
  LevelZeroLoader
  LevelZeroLoader-Headers
 )

source/adapters/level_zero/context.cpp

@@ -195,7 +195,7 @@ ur_result_t ur_context_handle_t_::initialize() {
  DeviceMemPools.emplace(
  std::piecewise_construct, std::make_tuple(Device->ZeDevice),
  std::make_tuple(umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &DisjointPoolConfigInstance
  .Configs[usm::DisjointPoolMemType::Device])
  .second));
@@ -206,7 +206,7 @@ ur_result_t ur_context_handle_t_::initialize() {
  SharedMemPools.emplace(
  std::piecewise_construct, std::make_tuple(Device->ZeDevice),
  std::make_tuple(umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &DisjointPoolConfigInstance
  .Configs[usm::DisjointPoolMemType::Shared])
  .second));
@@ -218,7 +218,7 @@ ur_result_t ur_context_handle_t_::initialize() {
  std::piecewise_construct, std::make_tuple(Device->ZeDevice),
  std::make_tuple(
  umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &DisjointPoolConfigInstance
  .Configs[usm::DisjointPoolMemType::SharedReadOnly])
  .second));
@@ -271,7 +271,7 @@ ur_result_t ur_context_handle_t_::initialize() {
  .second;
  HostMemPool =
  umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &DisjointPoolConfigInstance.Configs[usm::DisjointPoolMemType::Host])
  .second;
 

source/adapters/level_zero/usm.cpp

@@ -827,7 +827,7 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
 
  HostMemPool =
  umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs.Configs[usm::DisjointPoolMemType::Host])
  .second;
 
@@ -838,7 +838,7 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
  DeviceMemPools.emplace(
  std::piecewise_construct, std::make_tuple(device),
  std::make_tuple(umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs
  .Configs[usm::DisjointPoolMemType::Device])
  .second));
@@ -849,7 +849,7 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
  SharedMemPools.emplace(
  std::piecewise_construct, std::make_tuple(device),
  std::make_tuple(umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs
  .Configs[usm::DisjointPoolMemType::Shared])
  .second));
@@ -861,7 +861,7 @@ ur_usm_pool_handle_t_::ur_usm_pool_handle_t_(ur_context_handle_t Context,
  std::piecewise_construct, std::make_tuple(device),
  std::make_tuple(
  umf::poolMakeUniqueFromOps(
- &UMF_DISJOINT_POOL_OPS, std::move(MemProvider),
+ umfDisjointPoolOps(), std::move(MemProvider),
  &this->DisjointPoolConfigs
  .Configs[usm::DisjointPoolMemType::SharedReadOnly])
  .second));

source/adapters/level_zero/usm.hpp

@@ -85,6 +85,12 @@ class USMMemoryProviderBase {
  virtual umf_result_t purge_force(void *, size_t) {
  return UMF_RESULT_ERROR_NOT_SUPPORTED;
  };
+ umf_result_t allocation_merge(void *, void *, size_t) {
+ return UMF_RESULT_ERROR_UNKNOWN;
+ }
+ umf_result_t allocation_split(void *, size_t, size_t) {
+ return UMF_RESULT_ERROR_UNKNOWN;
+ }
  virtual const char *get_name() { return ""; };
  virtual ~USMMemoryProviderBase() = default;
 };

source/adapters/native_cpu/CMakeLists.txt

@@ -52,6 +52,7 @@ find_package(Threads REQUIRED)
 target_link_libraries(${TARGET_NAME} PRIVATE
  ${PROJECT_NAME}::headers
  ${PROJECT_NAME}::common
+ ${PROJECT_NAME}::umf
  Threads::Threads
 )
 

source/adapters/opencl/CMakeLists.txt

@@ -96,6 +96,7 @@ target_include_directories(${TARGET_NAME} PRIVATE
 target_link_libraries(${TARGET_NAME} PRIVATE
  ${PROJECT_NAME}::headers
  ${PROJECT_NAME}::common
+ ${PROJECT_NAME}::umf
  Threads::Threads
  ${OpenCLICDLoaderLibrary}
 )

source/common/CMakeLists.txt

@@ -4,9 +4,6 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
 add_ur_library(ur_common STATIC
- umf_helpers.hpp
- umf_pools/disjoint_pool_config_parser.cpp
- ur_pool_manager.hpp
  ur_util.cpp
  ur_util.hpp
  $<$<PLATFORM_ID:Windows>:windows/ur_lib_loader.cpp>
@@ -26,8 +23,8 @@ if (NOT DEFINED UMF_REPO)
 endif()
 
 if (NOT DEFINED UMF_TAG)
- # Merge pull request #119 from ldorau/Fix_arena_extent_split_and_arena_extent_merge
- set(UMF_TAG 9bf7a0dc4dff76844e10edbb5c6e9d917536ef6d)
+ # Merge pull request #637 from kswiecicki/fix-dpool-poison-macro
+ set(UMF_TAG 1c34aae4c804e133c1273f30b1d6441ebb766f2f)
 endif()
 
 message(STATUS "Will fetch Unified Memory Framework from ${UMF_REPO}")
@@ -38,21 +35,17 @@ FetchContent_Declare(unified-memory-framework
  GIT_TAG ${UMF_TAG}
 )
 
-if(UR_BUILD_TESTS)
- set(UMF_BUILD_TESTS ON CACHE INTERNAL "Build UMF tests")
-else()
- set(UMF_BUILD_TESTS OFF CACHE INTERNAL "Build UMF tests")
-endif()
+set(UMF_BUILD_TESTS OFF CACHE INTERNAL "Build UMF tests")
+set(UMF_BUILD_EXAMPLES OFF CACHE INTERNAL "Build UMF examples")
+# TODO: L0 provider not ready yet
+set(UMF_BUILD_LEVEL_ZERO_PROVIDER OFF CACHE INTERNAL "Build Level Zero Provider")
+set(UMF_BUILD_SHARED_LIBRARY ${UMF_BUILD_SHARED_LIBRARY} CACHE INTERNAL "Build UMF shared library")
 set(UMF_BUILD_LIBUMF_POOL_DISJOINT ON CACHE INTERNAL "Build Disjoint Pool")
-set(UMF_BUILD_OS_MEMORY_PROVIDER OFF CACHE INTERNAL "Build OS Provider")
 
 FetchContent_MakeAvailable(unified-memory-framework)
 FetchContent_GetProperties(unified-memory-framework)
 
 target_link_libraries(ur_common PUBLIC
- unified-memory-framework::umf
- unified-memory-framework::headers
- unified-memory-framework::disjoint_pool
  ${CMAKE_DL_LIBS}
  ${PROJECT_NAME}::headers
 )
@@ -70,3 +63,18 @@ install(TARGETS ur_common
  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
 )
+
+add_library(ur_umf INTERFACE)
+target_sources(ur_umf INTERFACE
+ umf_helpers.hpp
+ umf_pools/disjoint_pool_config_parser.cpp
+ ur_pool_manager.hpp
+)
+
+add_library(${PROJECT_NAME}::umf ALIAS ur_umf)
+
+target_link_libraries(ur_umf INTERFACE
+ umf::umf
+ umf::headers
+ umf::disjoint_pool
+)