Merge pull request #1587 from bratpiorka/rrudnick_get_cacheline_size

add GetCacheLineSize() op to memory provider and use it to initialize DP min bucket size

Author: bratpiorka

examples/ctl/custom_ctl.c

@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2025 Intel Corporation
+ * Copyright (C) 2025-2026 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -92,6 +92,12 @@ static umf_result_t ctl_get_min_page_size(void *provider, const void *ptr,
     return UMF_RESULT_SUCCESS;
 }
 
+static umf_result_t ctl_get_cache_line_size(void *provider, size_t *size) {
+    (void)provider;
+    *size = 64;
+    return UMF_RESULT_SUCCESS;
+}
+
 static umf_result_t ctl_get_name(void *provider, const char **name) {
     (void)provider;
     if (name) {
@@ -243,6 +249,7 @@ static umf_memory_provider_ops_t ctl_ops = {
     .get_last_native_error = ctl_get_last_native_error,
     .get_recommended_page_size = ctl_get_recommended_page_size,
     .get_min_page_size = ctl_get_min_page_size,
+    .get_cache_line_size = ctl_get_cache_line_size,
     .get_name = ctl_get_name,
     .ext_ctl = ctl_ctl, // register CTL handler
 };

examples/custom_file_provider/custom_file_provider.c

@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2024-2025 Intel Corporation
+ * Copyright (C) 2024-2026 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -240,6 +240,12 @@ static umf_result_t file_get_min_page_size(void *provider, const void *ptr,
     return UMF_RESULT_SUCCESS;
 }
 
+static umf_result_t file_get_cache_line_size(void *provider, size_t *size) {
+    (void)provider;
+    *size = 64;
+    return UMF_RESULT_SUCCESS;
+}
+
 // File provider operations
 static umf_memory_provider_ops_t file_ops = {
     .version = UMF_PROVIDER_OPS_VERSION_CURRENT,
@@ -251,6 +257,7 @@ static umf_memory_provider_ops_t file_ops = {
     .get_last_native_error = file_get_last_native_error,
     .get_recommended_page_size = file_get_recommended_page_size,
     .get_min_page_size = file_get_min_page_size,
+    .get_cache_line_size = file_get_cache_line_size,
 };
 
 // Main function

include/umf/memory_provider.h

@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2023-2025 Intel Corporation
+ * Copyright (C) 2023-2026 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -129,6 +129,16 @@ umf_result_t
 umfMemoryProviderGetMinPageSize(umf_memory_provider_handle_t hProvider,
                                 const void *ptr, size_t *pageSize);
 
+///
+/// @brief Retrieve cache line size for memory allocated by the provider.
+/// @param hProvider handle to the memory provider
+/// @param size [out] pointer to the cache line size
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+///
+umf_result_t
+umfMemoryProviderGetCacheLineSize(umf_memory_provider_handle_t hProvider,
+                                  size_t *size);
+
 ///
 /// @brief Discard physical pages within the virtual memory mapping associated at the given addr
 ///        and \p size. This call is asynchronous and may delay purging the pages indefinitely.

include/umf/memory_provider_ops.h

@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2023-2025 Intel Corporation
+ * Copyright (C) 2023-2026 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -21,7 +21,7 @@ extern "C" {
 /// @brief Version of the Memory Provider ops structure.
 /// NOTE: This is equal to the latest UMF version, in which the ops structure
 /// has been modified.
-#define UMF_PROVIDER_OPS_VERSION_CURRENT UMF_MAKE_VERSION(1, 1)
+#define UMF_PROVIDER_OPS_VERSION_CURRENT UMF_MAKE_VERSION(1, 2)
 
 ///
 /// @brief This structure comprises function pointers used by corresponding
@@ -326,6 +326,16 @@ typedef struct umf_memory_provider_ops_t {
         void *provider, umf_memory_property_id_t memory_property_id,
         size_t *size);
 
+    // The following operations were added in ops version 1.2
+
+    ///
+    /// @brief Retrieve cache line size for memory allocated by the provider.
+    /// @param provider pointer to the memory provider
+    /// @param size [out] pointer to the cache line size
+    /// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+    ///
+    umf_result_t (*get_cache_line_size)(void *provider, size_t *size);
+
 } umf_memory_provider_ops_t;
 
 #ifdef __cplusplus

include/umf/pools/pool_disjoint.h

@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2023-2025 Intel Corporation
+ * Copyright (C) 2023-2026 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -82,7 +82,7 @@ umfDisjointPoolParamsSetCapacity(umf_disjoint_pool_params_handle_t hParams,
                                  size_t maxCapacity);
 
 /// @brief Set minimum bucket allocation size.
-/// @details Default value for minimum bucket size is 8.
+/// @details If not set, the pool uses the provider cache line size.
 /// @param hParams handle to the parameters of the disjoint pool.
 /// @param minBucketSize minimum bucket size. Must be power of 2.
 /// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.

src/libumf.def

@@ -1,12 +1,12 @@
 ;;;; Begin Copyright Notice
-; Copyright (C) 2023-2025 Intel Corporation
+; Copyright (C) 2023-2026 Intel Corporation
 ; Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 ; SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 ;;;;  End Copyright Notice
 
 LIBRARY UMF
 
-VERSION 1.1
+VERSION 1.2
 
 EXPORTS
     DllMain
@@ -158,3 +158,5 @@ EXPORTS
     umfOsMemoryProviderParamsSetName
     umfPoolTrimMemory
     umfScalablePoolParamsSetName
+; Added in UMF_1.2
+    umfMemoryProviderGetCacheLineSize

src/libumf.map

@@ -1,4 +1,4 @@
-# Copyright (C) 2023-2025 Intel Corporation
+# Copyright (C) 2023-2026 Intel Corporation
 # Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
@@ -157,3 +157,7 @@ UMF_1.1 {
     umfPoolTrimMemory;
     umfScalablePoolParamsSetName;
 } UMF_1.0;
+
+UMF_1.2 {    
+    umfMemoryProviderGetCacheLineSize;
+} UMF_1.1;

src/libumf.rc.in

@@ -1,4 +1,4 @@
-// Copyright (C) 2024-2025 Intel Corporation
+// Copyright (C) 2024-2026 Intel Corporation
 //
 // Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -53,7 +53,7 @@ BEGIN
             VALUE "CompanyName", "Intel Corporation\0"
             VALUE "FileDescription", "Unified Memory Framework (UMF) library (build options: " _UMF_CMAKE_VARS ")\0"
             VALUE "FileVersion", _UMF_VERSION "\0"
-            VALUE "LegalCopyright", "Copyright 2024-2025, Intel Corporation. All rights reserved.\0"
+            VALUE "LegalCopyright", "Copyright 2024-2026, Intel Corporation. All rights reserved.\0"
             VALUE "LegalTrademarks", "\0"
             VALUE "OriginalFilename", "umf.dll\0"
             VALUE "ProductName", "Unified Memory Framework (UMF)\0"

src/memory_provider.c

@@ -175,6 +175,13 @@ static umf_result_t umfDefaultGetAllocationPropertiesSize(
     return UMF_RESULT_ERROR_NOT_SUPPORTED;
 }
 
+static umf_result_t umfDefaultGetCacheLineSize(void *provider, size_t *size) {
+    (void)provider;
+
+    *size = 64;
+    return UMF_RESULT_SUCCESS;
+}
+
 void assignOpsExtDefaults(umf_memory_provider_ops_t *ops) {
     if (!ops->ext_purge_lazy) {
         ops->ext_purge_lazy = umfDefaultPurgeLazy;
@@ -263,6 +270,7 @@ static bool validateOps(const umf_memory_provider_ops_t *ops) {
     CHECK_OP(ops, free);
     CHECK_OP(ops, get_recommended_page_size);
     CHECK_OP(ops, get_min_page_size);
+    CHECK_OP(ops, get_cache_line_size);
     CHECK_OP(ops, initialize);
     CHECK_OP(ops, finalize);
     CHECK_OP(ops, get_last_native_error);
@@ -321,6 +329,13 @@ umf_result_t umfMemoryProviderCreate(const umf_memory_provider_ops_t *ops,
             memcpy(&compatible_ops, ops,
                    offsetof(umf_memory_provider_ops_t,
                             ext_get_allocation_properties));
+            compatible_ops.get_cache_line_size = umfDefaultGetCacheLineSize;
+        } else if (UMF_MINOR_VERSION(ops->version) == 1) {
+            LOG_INFO("Detected 1.1 version of Memory Provider ops, "
+                     "upgrading to current version");
+            memcpy(&compatible_ops, ops,
+                   offsetof(umf_memory_provider_ops_t, get_cache_line_size));
+            compatible_ops.get_cache_line_size = umfDefaultGetCacheLineSize;
         } else {
             LOG_ERR("Unsupported Memory Provider ops version: %d",
                     ops->version);
@@ -479,6 +494,19 @@ umfMemoryProviderGetMinPageSize(umf_memory_provider_handle_t hProvider,
     return res;
 }
 
+umf_result_t
+umfMemoryProviderGetCacheLineSize(umf_memory_provider_handle_t hProvider,
+                                  size_t *size) {
+    UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
+    UMF_CHECK((size != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
+
+    umf_result_t res =
+        hProvider->ops.get_cache_line_size(hProvider->provider_priv, size);
+
+    checkErrorAndSetLastProvider(res, hProvider);
+    return res;
+}
+
 umf_result_t umfMemoryProviderGetName(umf_memory_provider_handle_t hProvider,
                                       const char **name) {
     UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);