add set name to all pools and providers

Author: lplewa

include/umf/pools/pool_disjoint.h

@@ -109,7 +109,8 @@ umf_result_t umfDisjointPoolParamsSetSharedLimits(
 
 /// @brief Set custom name of the disjoint pool to be used in the traces.
 /// @param hParams handle to the parameters of the disjoint pool.
-/// @param name custom name of the pool. Name longer than 64 characters will be truncated.
+/// @param name custom name of the pool. Must not be NULL. Name longer than 64
+///        characters will be truncated.
 /// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
 umf_result_t
 umfDisjointPoolParamsSetName(umf_disjoint_pool_params_handle_t hParams,

include/umf/pools/pool_jemalloc.h

@@ -43,6 +43,15 @@ umf_result_t
 umfJemallocPoolParamsSetNumArenas(umf_jemalloc_pool_params_handle_t hParams,
                                   size_t numArenas);
 
+/// @brief Set custom name of the jemalloc pool used in traces.
+/// @param hParams handle to the parameters of the jemalloc pool.
+/// @param name custom name. Must not be NULL. Name longer than 63 characters
+///        will be truncated.
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+umf_result_t
+umfJemallocPoolParamsSetName(umf_jemalloc_pool_params_handle_t hParams,
+                             const char *name);
+
 const umf_memory_pool_ops_t *umfJemallocPoolOps(void);
 
 #ifdef __cplusplus

include/umf/pools/pool_scalable.h

@@ -53,6 +53,15 @@ umf_result_t
 umfScalablePoolParamsSetKeepAllMemory(umf_scalable_pool_params_handle_t hParams,
                                       bool keepAllMemory);
 
+/// @brief  Set custom name of the scalable pool used in traces.
+/// @param  hParams handle to the parameters of the scalable pool.
+/// @param  name custom name. Must not be NULL. Name longer than 63 characters
+///         will be truncated.
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+umf_result_t
+umfScalablePoolParamsSetName(umf_scalable_pool_params_handle_t hParams,
+                             const char *name);
+
 /// @brief  Return \p ops structure containing pointers to the scalable pool implementation.
 /// @return pointer to the \p umf_memory_pool_ops_t struct.
 const umf_memory_pool_ops_t *umfScalablePoolOps(void);

include/umf/providers/provider_cuda.h

@@ -61,6 +61,14 @@ umf_result_t umfCUDAMemoryProviderParamsSetMemoryType(
 umf_result_t umfCUDAMemoryProviderParamsSetAllocFlags(
     umf_cuda_memory_provider_params_handle_t hParams, unsigned int flags);
 
+/// @brief  Set custom name of the CUDA Memory Provider.
+/// @param  hParams handle to the parameters of the CUDA Memory Provider.
+/// @param  name custom name. Must not be NULL. Name longer than 63 characters
+///         will be truncated.
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+umf_result_t umfCUDAMemoryProviderParamsSetName(
+    umf_cuda_memory_provider_params_handle_t hParams, const char *name);
+
 const umf_memory_provider_ops_t *umfCUDAMemoryProviderOps(void);
 
 #ifdef __cplusplus

include/umf/providers/provider_devdax_memory.h

@@ -56,6 +56,14 @@ umf_result_t umfDevDaxMemoryProviderParamsSetDeviceDax(
 umf_result_t umfDevDaxMemoryProviderParamsSetProtection(
     umf_devdax_memory_provider_params_handle_t hParams, unsigned protection);
 
+/// @brief  Set custom name of the Devdax Memory Provider.
+/// @param  hParams handle to the parameters of the Devdax Memory Provider.
+/// @param  name custom name. Must not be NULL. Name longer than 63 characters
+///         will be truncated.
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+umf_result_t umfDevDaxMemoryProviderParamsSetName(
+    umf_devdax_memory_provider_params_handle_t hParams, const char *name);
+
 /// @brief Devdax Memory Provider operation results
 typedef enum umf_devdax_memory_provider_native_error {
     UMF_DEVDAX_RESULT_SUCCESS = UMF_DEVDAX_RESULTS_START_FROM, ///< Success

include/umf/providers/provider_file_memory.h

@@ -68,6 +68,14 @@ typedef enum umf_file_memory_provider_native_error {
 
 const umf_memory_provider_ops_t *umfFileMemoryProviderOps(void);
 
+/// @brief  Set custom name of the File Memory Provider.
+/// @param  hParams handle to the parameters of the File Memory Provider.
+/// @param  name custom name. Must not be NULL. Name longer than 63 characters
+///         will be truncated.
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+umf_result_t umfFileMemoryProviderParamsSetName(
+    umf_file_memory_provider_params_handle_t hParams, const char *name);
+
 #ifdef __cplusplus
 }
 #endif

include/umf/providers/provider_fixed_memory.h

@@ -51,6 +51,14 @@ umf_result_t umfFixedMemoryProviderParamsDestroy(
 /// @return Pointer to the umf_memory_provider_ops_t structure.
 const umf_memory_provider_ops_t *umfFixedMemoryProviderOps(void);
 
+/// @brief  Set custom name of the Fixed Memory Provider.
+/// @param  hParams [in] handle to the parameters of the Fixed Memory Provider.
+/// @param  name custom name. Must not be NULL. Name longer than 63 characters
+///         will be truncated.
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+umf_result_t umfFixedMemoryProviderParamsSetName(
+    umf_fixed_memory_provider_params_handle_t hParams, const char *name);
+
 /// @brief Fixed Memory Provider operation results
 typedef enum umf_fixed_memory_provider_native_error {
     UMF_FIXED_RESULT_SUCCESS = UMF_FIXED_RESULTS_START_FROM, ///< Success

include/umf/providers/provider_level_zero.h

@@ -91,6 +91,14 @@ umf_result_t umfLevelZeroMemoryProviderParamsSetDeviceOrdinal(
     umf_level_zero_memory_provider_params_handle_t hParams,
     uint32_t deviceOrdinal);
 
+/// @brief  Set custom name of the Level Zero Memory Provider.
+/// @param  hParams handle to the parameters of the Level Zero Memory Provider.
+/// @param  name custom name. Must not be NULL. Name longer than 63 characters
+///         will be truncated.
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+umf_result_t umfLevelZeroMemoryProviderParamsSetName(
+    umf_level_zero_memory_provider_params_handle_t hParams, const char *name);
+
 const umf_memory_provider_ops_t *umfLevelZeroMemoryProviderOps(void);
 
 #ifdef __cplusplus

include/umf/providers/provider_os_memory.h

@@ -134,6 +134,15 @@ umf_result_t umfOsMemoryProviderParamsSetPartitions(
     umf_os_memory_provider_params_handle_t hParams,
     umf_numa_split_partition_t *partitions, unsigned partitions_len);
 
+/// @brief  Set custom name of the OS memory provider.
+/// @param  hParams handle to the parameters of the OS memory provider.
+/// @param  name custom name. Must not be NULL. Name longer than 63 characters
+///         will be truncated.
+/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
+umf_result_t
+umfOsMemoryProviderParamsSetName(umf_os_memory_provider_params_handle_t hParams,
+                                 const char *name);
+
 /// @brief OS Memory Provider operation results
 typedef enum umf_os_memory_provider_native_error {
     UMF_OS_RESULT_SUCCESS = UMF_OS_RESULTS_START_FROM, ///< Success

src/libumf.def

@@ -24,12 +24,14 @@ EXPORTS
     umfDevDaxMemoryProviderParamsDestroy
     umfDevDaxMemoryProviderParamsSetDeviceDax
     umfDevDaxMemoryProviderParamsSetProtection
+    umfDevDaxMemoryProviderParamsSetName
     umfFileMemoryProviderOps
     umfFileMemoryProviderParamsCreate
     umfFileMemoryProviderParamsDestroy
     umfFileMemoryProviderParamsSetPath
     umfFileMemoryProviderParamsSetProtection
     umfFileMemoryProviderParamsSetVisibility
+    umfFileMemoryProviderParamsSetName
     umfFree
     umfGetCurrentVersion
     umfGetIPCHandle
@@ -93,6 +95,7 @@ EXPORTS
     umfOsMemoryProviderParamsSetProtection
     umfOsMemoryProviderParamsSetShmName
     umfOsMemoryProviderParamsSetVisibility
+    umfOsMemoryProviderParamsSetName
     umfPoolAlignedMalloc
     umfPoolByPtr
     umfPoolCalloc
@@ -116,8 +119,10 @@ EXPORTS
     umfScalablePoolParamsDestroy
     umfScalablePoolParamsSetGranularity
     umfScalablePoolParamsSetKeepAllMemory
+    umfScalablePoolParamsSetName
 ; Added in UMF_0.11
     umfCUDAMemoryProviderParamsSetAllocFlags
+    umfCUDAMemoryProviderParamsSetName
     umfDisjointPoolOps
     umfDisjointPoolParamsCreate
     umfDisjointPoolParamsDestroy
@@ -134,7 +139,9 @@ EXPORTS
     umfFixedMemoryProviderParamsCreate
     umfFixedMemoryProviderParamsDestroy
     umfFixedMemoryProviderParamsSetMemory
+    umfFixedMemoryProviderParamsSetName
     umfLevelZeroMemoryProviderParamsSetDeviceOrdinal
+    umfLevelZeroMemoryProviderParamsSetName
     umfLevelZeroMemoryProviderParamsSetFreePolicy
 ; Added in UMF_1.0
     umfCtlExec
@@ -143,4 +150,5 @@ EXPORTS
     umfJemallocPoolParamsCreate
     umfJemallocPoolParamsDestroy
     umfJemallocPoolParamsSetNumArenas
+    umfJemallocPoolParamsSetName
     umfPoolGetName