Add devdax memory provider

Signed-off-by: Lukasz Dorau <[email protected]>

Author: ldorau

CMakeLists.txt

@@ -61,6 +61,18 @@ option(UMF_FORMAT_CODE_STYLE
        OFF)
 # Only a part of skips is treated as a failure now. TODO: extend to all tests
 option(UMF_TESTS_FAIL_ON_SKIP "Treat skips in tests as fail" OFF)
+set(UMF_TESTS_DEVDAX_PATH
+    ""
+    CACHE
+        PATH
+        "Path of the device DAX used in tests. The test is skipped if it is not set or empty."
+)
+set(UMF_TESTS_DEVDAX_SIZE
+    ""
+    CACHE
+        STRING
+        "Size of the device DAX used in tests. The test is skipped if it is not set or empty."
+)
 option(UMF_USE_ASAN "Enable AddressSanitizer checks" OFF)
 option(UMF_USE_UBSAN "Enable UndefinedBehaviorSanitizer checks" OFF)
 option(UMF_USE_TSAN "Enable ThreadSanitizer checks" OFF)
@@ -402,11 +414,20 @@ endif()
 
 if(NOT UMF_DISABLE_HWLOC)
     add_optional_symbol(umfOsMemoryProviderOps)
+    if(LINUX)
+        add_optional_symbol(umfDevDaxMemoryProviderOps)
+    endif()
 endif()
 
 add_subdirectory(src)
 
 if(UMF_BUILD_TESTS)
+    if(UMF_TESTS_DEVDAX_PATH OR UMF_TESTS_DEVDAX_SIZE)
+        message(
+            STATUS "UMF_TESTS_DEVDAX_PATH is set to: ${UMF_TESTS_DEVDAX_PATH}")
+        message(
+            STATUS "UMF_TESTS_DEVDAX_SIZE is set to: ${UMF_TESTS_DEVDAX_SIZE}")
+    endif()
     add_subdirectory(test)
 endif()
 

README.md

@@ -112,6 +112,8 @@ List of options provided by CMake:
 | UMF_DEVELOPER_MODE | Enable additional developer checks | ON/OFF | OFF |
 | UMF_FORMAT_CODE_STYLE | Add clang, cmake, and black -format-check and -format-apply targets to make | ON/OFF | OFF |
 | UMF_TESTS_FAIL_ON_SKIP | Treat skips in tests as fail | ON/OFF | OFF |
+| UMF_TESTS_DEVDAX_PATH | Path of the device DAX used in tests. The test is skipped if it is not set or empty. | path | "" |
+| UMF_TESTS_DEVDAX_SIZE | Size of the device DAX used in tests. The test is skipped if it is not set or empty. | size | "" |
 | UMF_USE_ASAN | Enable AddressSanitizer checks | ON/OFF | OFF |
 | UMF_USE_UBSAN | Enable UndefinedBehaviorSanitizer checks | ON/OFF | OFF |
 | UMF_USE_TSAN | Enable ThreadSanitizer checks | ON/OFF | OFF |
@@ -172,6 +174,24 @@ Additionally, required for tests:
 5) Required packages:
    - liblevel-zero-dev (Linux) or level-zero-sdk (Windows)
 
+#### DevDax memory provider (Linux only)
+
+A memory provider that provides memory from a device DAX (a character device file /dev/daxX.Y).
+It can be used when gigantic memory mappings are needed.
+
+The DevDax memory provider does not support the free operation
+(`umfMemoryProviderFree()` always returns `UMF_RESULT_ERROR_NOT_SUPPORTED`),
+so it should be used with a pool manager that will take over
+the managing of the provided memory - for example the jemalloc pool
+with the `disable_provider_free` parameter set to true.
+
+##### Requirements
+
+1) Linux OS
+2) A character device file /dev/daxX.Y created in the OS.
+3) `UMF_TESTS_DEVDAX_PATH` set to the path of the device DAX ("/dev/daxX.Y").
+4) `UMF_TESTS_DEVDAX_SIZE` set to the size of the "/dev/daxX.Y" device DAX.
+
 ### Memory pool managers
 
 #### Proxy pool (part of libumf)

include/umf/providers/provider_devdax_memory.h

@@ -0,0 +1,60 @@
+/*
+ * 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_DEVDAX_MEMORY_PROVIDER_H
+#define UMF_DEVDAX_MEMORY_PROVIDER_H
+
+#include "umf/memory_provider.h"
+#include <umf/providers/provider_os_memory.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/// @cond
+#define UMF_DEVDAX_RESULTS_START_FROM 2000
+/// @endcond
+
+/// @brief Memory provider settings struct
+typedef struct umf_devdax_memory_provider_params_t {
+    /// path of the device DAX
+    char *path;
+    /// size of the device DAX
+    size_t size;
+    /// combination of 'umf_mem_protection_flags_t' flags
+    unsigned protection;
+} umf_devdax_memory_provider_params_t;
+
+/// @brief Devdax Memory Provider operation results
+typedef enum umf_devdax_memory_provider_native_error {
+    UMF_DEVDAX_RESULT_SUCCESS = UMF_DEVDAX_RESULTS_START_FROM, ///< Success
+    UMF_DEVDAX_RESULT_ERROR_ALLOC_FAILED,        ///< Memory allocation failed
+    UMF_DEVDAX_RESULT_ERROR_ADDRESS_NOT_ALIGNED, ///< Allocated address is not aligned
+    UMF_DEVDAX_RESULT_ERROR_FREE_FAILED,         ///< Memory deallocation failed
+    UMF_DEVDAX_RESULT_ERROR_PURGE_LAZY_FAILED,  ///< Lazy purging failed
+    UMF_DEVDAX_RESULT_ERROR_PURGE_FORCE_FAILED, ///< Force purging failed
+} umf_devdax_memory_provider_native_error_t;
+
+umf_memory_provider_ops_t *umfDevDaxMemoryProviderOps(void);
+
+/// @brief Create default params for os memory provider
+static inline umf_devdax_memory_provider_params_t
+umfDevDaxMemoryProviderParamsDefault(char *path, size_t size) {
+    umf_devdax_memory_provider_params_t params = {
+        path,                                       /* path of the device DAX */
+        size,                                       /* size of the device DAX */
+        UMF_PROTECTION_READ | UMF_PROTECTION_WRITE, /* protection */
+    };
+
+    return params;
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* UMF_DEVDAX_MEMORY_PROVIDER_H */

src/CMakeLists.txt

@@ -89,6 +89,7 @@ set(UMF_SOURCES_MACOSX libumf_linux.c)
 set(UMF_SOURCES_WINDOWS libumf_windows.c)
 
 set(UMF_SOURCES_COMMON_LINUX_MACOSX
+    provider/provider_devdax_memory.c
     provider/provider_os_memory.c
     provider/provider_os_memory_posix.c
     memtargets/memtarget_numa.c