The Unified Memory Framework (UMF) is a library for constructing allocators and memory pools. It also contains broadly useful abstractions and utilities for memory management. UMF allows users to manage multiple memory pools characterized by different attributes, allowing certain allocation types to be isolated from others and allocated using different hardware resources as required.

For a quick introduction to UMF usage, see Example usage, which includes the code of the basic example.

Required packages:

• libhwloc-dev (Linux) / hwloc (Windows)
• C compiler
• CMake >= 3.14.0

For development and contributions:

• clang-format-15.0 (can be installed with python -m pip install clang-format==15.0.7)
• cmake-format-0.6 (can be installed with python -m pip install cmake-format==0.6.13)

For building tests, multithreaded benchmarks and Disjoint Pool:

• C++ compiler with C++17 support

For Level Zero memory provider tests:

• Level Zero headers and libraries
• compatible GPU with installed driver

Executable and binaries will be in build/bin

$ mkdir build
$ cd build
$ cmake {path_to_source_dir}
$ make

Generating Visual Studio Project. EXE and binaries will be in build/bin/{build_config}

$ mkdir build
$ cd build
$ cmake {path_to_source_dir} -G "Visual Studio 15 2017 Win64"

UMF comes with a single-threaded micro benchmark based on ubench. In order to build the benchmark, the UMF_BUILD_BENCHMARKS CMake configuration flag has to be turned ON.

UMF also provides multithreaded benchmarks that can be enabled by setting both UMF_BUILD_BENCHMARKS and UMF_BUILD_BENCHMARKS_MT CMake configuration flags to ON. Multithreaded benchmarks require a C++ support.

List of sanitizers available on Linux:

• AddressSanitizer
• UndefinedBehaviorSanitizer
• ThreadSanitizer
  • Is mutually exclusive with other sanitizers.
• MemorySanitizer
  • Requires linking against MSan-instrumented libraries to prevent false positive reports. More information here.

List of sanitizers available on Windows:

• AddressSanitizer

Listed sanitizers can be enabled with appropriate CMake options.

List of options provided by CMake:

A UMF memory pool is a combination of a pool allocator and a memory provider. A memory provider is responsible for coarse-grained memory allocations and management of memory pages, while the pool allocator controls memory pooling and handles fine-grained memory allocations.

Pool allocator can leverage existing allocators (e.g. jemalloc or tbbmalloc) or be written from scratch.

UMF comes with predefined pool allocators (see include/pool) and providers (see include/provider). UMF can also work with user-defined pools and providers that implement a specific interface (see include/umf/memory_pool_ops.h and include/umf/memory_provider_ops.h).

More detailed documentation is available here: https://oneapi-src.github.io/unified-memory-framework/

A memory provider that provides memory from an operating system.

Required packages for tests (Linux-only yet):

• libnuma-dev

A memory provider that provides memory from L0 device.

1. Linux or Windows OS
2. The UMF_BUILD_LEVEL_ZERO_PROVIDER option turned ON (by default)

Additionally, required for tests:

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

This memory pool is distributed as part of libumf. It forwards all requests to the underlying memory provider. Currently umfPoolRealloc, umfPoolCalloc and umfPoolMallocUsableSize functions are not supported by the proxy pool.

TODO: Add a description

To enable this feature, the UMF_BUILD_LIBUMF_POOL_DISJOINT option needs to be turned ON.

libumf_pool_jemalloc is a jemalloc-based memory pool manager built as a separate static library. The UMF_BUILD_LIBUMF_POOL_JEMALLOC option has to be turned ON to build this library.

1. The UMF_BUILD_LIBUMF_POOL_JEMALLOC option turned ON
2. Required packages:
   • libjemalloc-dev (Linux) or jemalloc (Windows)

libumf_pool_scalable is a oneTBB-based memory pool manager built as a separate static library. The UMF_BUILD_LIBUMF_POOL_SCALABLE option has to be turned ON to build this library.

1. The UMF_BUILD_LIBUMF_POOL_SCALABLE option turned ON
2. Required packages:
   • libtbb-dev (libtbbmalloc.so.2) on Linux or tbb (tbbmalloc.dll) on Windows

TODO: Add general information about memspaces.

Memspace backed by all available NUMA nodes discovered on the platform. Can be retrieved using umfMemspaceHostAllGet.

Memspace backed by all available NUMA nodes discovered on the platform sorted by capacity. Can be retrieved using umfMemspaceHighestCapacityGet.

All contributions to the UMF project are most welcome! Before submitting an issue or a Pull Request, please read Contribution Guide.