mem props POC

Author: bratpiorka

benchmark/ubench.c

@@ -28,6 +28,14 @@ memory as well as functions that create, destroy and operate on the pool.
 .. doxygenfile:: memory_pool.h
     :sections: define enum typedef func var
 
+TODO
+------------------------------------------
+
+TODO
+
+.. doxygenfile:: memory_props.h
+    :sections: define enum typedef func var
+
 Disjoint Pool
 ------------------------------------------
 

docs/config/api.rst

@@ -51,6 +51,39 @@ typedef enum umf_result_t {
     UMF_RESULT_ERROR_UNKNOWN = 0x7ffffffe  ///< Unknown error
 } umf_result_t;
 
+/// @brief TODO
+typedef struct umf_memory_properties_t *umf_memory_properties_handle_t;
+
+/// @brief TODO
+// write about experimental api
+typedef enum umf_memory_property_id_t {
+    UMF_MEMORY_PROPERTY_INVALID = -1, ///< TODO
+
+    // UMF specyfic
+    UMF_MEMORY_PROVIDER_HANDLE,
+    UMF_MEMORY_PROVIDER_OPS, // == type?
+    UMF_MEMORY_POOL_HANDLE,
+    UMF_MEMORY_POOL_OPS, // == type?
+
+    // generic pointer properties
+    UMF_MEMORY_PROPERTY_POINTER_TYPE, // unreg host, reg host ??, dev, managed or umf_usm_memory_type_t?
+    UMF_MEMORY_PROPERTY_BASE_ADDRESS, // base address
+    UMF_MEMORY_PROPERTY_BASE_SIZE,    // base size
+
+    // GPU specific
+    UMF_MEMORY_PROPERTY_DEVICE, // handle (ze) or id (cuda)
+    UMF_MEMORY_PROPERTY_BUFFER_ID, // unique id NOTE: this id is unique across all UMF allocs and != L0 or CUDA ID
+    UMF_MEMORY_PROPERTY_DEVICE_ATTRIBUTES, // ze_memory_allocation_properties_t ?
+
+    // all cuda + l0
+    // next other providers?
+    // todo return type?
+
+    /// @cond
+    UMF_MEMORY_PROPERTY_MAX_RESERVED = 0x1000, ///< Maximum reserved value
+    /// @endcond
+} umf_memory_property_id_t;
+
 /// @brief Type of the CTL query
 typedef enum umf_ctl_query_type {
     CTL_QUERY_READ,

include/umf/base.h

@@ -0,0 +1,33 @@
+/*
+ *
+ * Copyright (C) 2025 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_MEMORY_PROPS_H
+#define UMF_MEMORY_PROPS_H 1
+
+#include <umf/base.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/// @brief TODO
+umf_result_t
+umfGetMemoryPropertiesHandle(void *ptr,
+                             umf_memory_properties_handle_t *props_handle);
+
+/// @brief TODO
+umf_result_t umfGetMemoryProperty(umf_memory_properties_handle_t props_handle,
+                                  umf_memory_property_id_t memory_property_id,
+                                  void *value);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* UMF_MEMORY_PROPS_H */

include/umf/memory_props.h

@@ -260,6 +260,13 @@ umf_result_t
 umfMemoryProviderAllocationMerge(umf_memory_provider_handle_t hProvider,
                                  void *lowPtr, void *highPtr, size_t totalSize);
 
+/// TODO
+umf_result_t
+umfMemoryProviderGetAllocationProperties(umf_memory_provider_handle_t hProvider,
+                                         umf_memory_properties_handle_t hProps,
+                                         umf_memory_property_id_t propertyId,
+                                         void *value);
+
 #ifdef __cplusplus
 }
 #endif

include/umf/memory_provider.h

@@ -268,6 +268,11 @@ typedef struct umf_memory_provider_ops_t {
                             void *arg, size_t size,
                             umf_ctl_query_type_t queryType);
 
+    /// TODO
+    umf_result_t (*ext_get_allocation_properties)(void *provider,
+                                  umf_memory_properties_handle_t props_handle,
+                                  umf_memory_property_id_t memory_property_id,
+                                  void *value);
 } umf_memory_provider_ops_t;
 
 #ifdef __cplusplus

include/umf/memory_provider_ops.h

@@ -44,6 +44,7 @@ set(UMF_SOURCES
     ipc.c
     ipc_cache.c
     memory_pool.c
+    memory_props.c
     memory_provider.c
     memory_provider_get_last_failed.c
     memtarget.c

src/CMakeLists.txt

@@ -65,7 +65,7 @@ umf_result_t umfGetIPCHandle(const void *ptr, umf_ipc_handle_t *umfIPCHandle,
         return ret;
     }
 
-    ret = umfPoolGetIPCHandleSize(allocInfo.pool, &ipcHandleSize);
+    ret = umfPoolGetIPCHandleSize(allocInfo.props->pool, &ipcHandleSize);
     if (ret != UMF_RESULT_SUCCESS) {
         LOG_ERR("cannot get IPC handle size.");
         return ret;
@@ -79,7 +79,7 @@ umf_result_t umfGetIPCHandle(const void *ptr, umf_ipc_handle_t *umfIPCHandle,
 
     // We cannot use umfPoolGetMemoryProvider function because it returns
     // upstream provider but we need tracking one
-    umf_memory_provider_handle_t provider = allocInfo.pool->provider;
+    umf_memory_provider_handle_t provider = allocInfo.props->pool->provider;
     assert(provider);
 
     ret = umfMemoryProviderGetIPCHandle(provider, allocInfo.base,

src/ipc.c

@@ -139,6 +139,8 @@ EXPORTS
     umfCtlExec
     umfCtlGet
     umfCtlSet
+    umfGetMemoryPropertiesHandle
+    umfGetMemoryProperty
     umfJemallocPoolParamsCreate
     umfJemallocPoolParamsDestroy
     umfJemallocPoolParamsSetNumArenas

src/libumf.def

@@ -139,6 +139,8 @@ UMF_0.12 {
         umfCtlExec;
         umfCtlGet;
         umfCtlSet;
+        umfGetMemoryPropertiesHandle;
+        umfGetMemoryProperty;
         umfJemallocPoolParamsCreate;
         umfJemallocPoolParamsDestroy;
         umfJemallocPoolParamsSetNumArenas;