Merge pull request #742 from vinser52/umf_cosmetic_fixes

[umf] Cosmetic changes in UMF
oneapi-src · Jul 24, 2023 · d3fa9ca · d3fa9ca
2 parents 2620159 + 8ed1cee
commit d3fa9ca
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 14 deletions.
diff --git a/source/common/unified_malloc_framework/include/umf/memory_pool.h b/source/common/unified_malloc_framework/include/umf/memory_pool.h
@@ -32,7 +32,7 @@ struct umf_memory_pool_ops_t;
 /// \param hPool [out] handle to the newly created memory pool
 /// \return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
 ///
-enum umf_result_t umfPoolCreate(struct umf_memory_pool_ops_t *ops,
+enum umf_result_t umfPoolCreate(const struct umf_memory_pool_ops_t *ops,
                                 umf_memory_provider_handle_t *providers,
                                 size_t numProviders, void *params,
                                 umf_memory_pool_handle_t *hPool);

diff --git a/source/common/unified_malloc_framework/include/umf/memory_provider.h b/source/common/unified_malloc_framework/include/umf/memory_provider.h
@@ -28,8 +28,8 @@ typedef struct umf_memory_provider_t *umf_memory_provider_handle_t;
 /// \return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
 ///
 enum umf_result_t
-umfMemoryProviderCreate(struct umf_memory_provider_ops_t *ops, void *params,
-                        umf_memory_provider_handle_t *hProvider);
+umfMemoryProviderCreate(const struct umf_memory_provider_ops_t *ops,
+                        void *params, umf_memory_provider_handle_t *hProvider);
 
 ///
 /// \brief Destroys memory provider.
@@ -110,7 +110,7 @@ umfMemoryProviderGetMinPageSize(umf_memory_provider_handle_t hProvider,
 
 ///
 /// \brief Discard physical pages within the virtual memory mapping associated at given addr and size.
-///        This call is asynchronous and may delay puring the pages indefinitely.
+///        This call is asynchronous and may delay purging the pages indefinitely.
 /// \param hProvider handle to the memory provider
 /// \param ptr beginning of the virtual memory range
 /// \param size size of the virtual memory range

diff --git a/source/common/unified_malloc_framework/include/umf/memory_provider_ops.h b/source/common/unified_malloc_framework/include/umf/memory_provider_ops.h
@@ -26,16 +26,16 @@ struct umf_memory_provider_ops_t {
     uint32_t version;
 
     ///
-    /// \brief Initializes memory pool.
-    /// \param params pool-specific params
-    /// \param pool returns pointer to the pool
+    /// \brief Initializes memory provider.
+    /// \param params provider-specific params
+    /// \param provider returns pointer to the provider
     /// \return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
-    enum umf_result_t (*initialize)(void *params, void **pool);
+    enum umf_result_t (*initialize)(void *params, void **provider);
 
     ///
-    /// \brief Finalizes memory pool.
-    /// \param pool pool to finalize
-    void (*finalize)(void *pool);
+    /// \brief Finalizes memory provider.
+    /// \param provider provider to finalize
+    void (*finalize)(void *provider);
 
     /// Refer to memory_provider.h for description of those functions
     enum umf_result_t (*alloc)(void *provider, size_t size, size_t alignment,

diff --git a/source/common/unified_malloc_framework/src/memory_pool.c b/source/common/unified_malloc_framework/src/memory_pool.c
@@ -38,7 +38,7 @@ destroyMemoryProviderWrappers(umf_memory_provider_handle_t *providers,
     free(providers);
 }
 
-enum umf_result_t umfPoolCreate(struct umf_memory_pool_ops_t *ops,
+enum umf_result_t umfPoolCreate(const struct umf_memory_pool_ops_t *ops,
                                 umf_memory_provider_handle_t *providers,
                                 size_t numProviders, void *params,
                                 umf_memory_pool_handle_t *hPool) {

diff --git a/source/common/unified_malloc_framework/src/memory_provider.c b/source/common/unified_malloc_framework/src/memory_provider.c
@@ -20,8 +20,8 @@ struct umf_memory_provider_t {
 };
 
 enum umf_result_t
-umfMemoryProviderCreate(struct umf_memory_provider_ops_t *ops, void *params,
-                        umf_memory_provider_handle_t *hProvider) {
+umfMemoryProviderCreate(const struct umf_memory_provider_ops_t *ops,
+                        void *params, umf_memory_provider_handle_t *hProvider) {
     umf_memory_provider_handle_t provider =
         malloc(sizeof(struct umf_memory_provider_t));
     if (!provider) {