Merge pull request #90 from ldorau/Make_alignment_of_umfMemoryProvide…

…rAlloc_more_specific Make alignment of umfMemoryProviderAlloc() more specific
oneapi-src · Dec 21, 2023 · 0d85f36 · 0d85f36
2 parents e7a709b + bb522d8
commit 0d85f36
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/include/umf/memory_provider.h b/include/umf/memory_provider.h
@@ -42,7 +42,7 @@ void umfMemoryProviderDestroy(umf_memory_provider_handle_t hProvider);
 ///        with the specified \p alignment
 /// @param hProvider handle to the memory provider
 /// @param size number of bytes to allocate
-/// @param alignment alignment of the allocation in bytes
+/// @param alignment alignment of the allocation in bytes, it has to be a multiple or a divider of the minimum page size
 /// @param ptr [out] pointer to the allocated memory
 /// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure
 ///

diff --git a/include/umf/memory_provider_ops.h b/include/umf/memory_provider_ops.h
@@ -45,7 +45,7 @@ typedef struct umf_memory_provider_ops_t {
     ///        with the specified \p alignment
     /// @param provider pointer to the memory provider
     /// @param size number of bytes to allocate
-    /// @param alignment alignment of the allocation in bytes
+    /// @param alignment alignment of the allocation in bytes, it has to be a multiple or a divider of the minimum page size
     /// @param ptr [out] pointer to the allocated memory
     /// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure
     ///