Add optional coarse provider to umfPoolTest fixture

Add optional coarse provider to umfPoolTest fixture.
Add 5th argument (coarse_memory_provider_params_t *)
to the poolCreateExtParams tuple (can be nullptr).
If it is non-nullptr, coarse provider is created
with the given provider as the upstream provider.

It will be used to test the following providers:
- file provider
- devdax provider
as the upstream providers with the coarse provider
and different pool managers.

Signed-off-by: Lukasz Dorau <[email protected]>

Author: ldorau

benchmark/multithread.cpp

@@ -102,7 +102,8 @@ int main() {
 
     std::cout << "scalable_pool mt_alloc_free: ";
     mt_alloc_free(poolCreateExtParams{umfScalablePoolOps(), nullptr,
-                                      umfOsMemoryProviderOps(), &osParams},
+                                      umfOsMemoryProviderOps(), &osParams,
+                                      nullptr},
                   params);
 #else
     std::cout << "skipping scalable_pool mt_alloc_free" << std::endl;
@@ -111,7 +112,8 @@ int main() {
 #if defined(UMF_BUILD_LIBUMF_POOL_JEMALLOC)
     std::cout << "jemalloc_pool mt_alloc_free: ";
     mt_alloc_free(poolCreateExtParams{umfJemallocPoolOps(), nullptr,
-                                      umfOsMemoryProviderOps(), &osParams});
+                                      umfOsMemoryProviderOps(), &osParams,
+                                      nullptr});
 #else
     std::cout << "skipping jemalloc_pool mt_alloc_free" << std::endl;
 #endif
@@ -121,7 +123,8 @@ int main() {
 
     std::cout << "disjoint_pool mt_alloc_free: ";
     mt_alloc_free(poolCreateExtParams{umfDisjointPoolOps(), &disjointParams,
-                                      umfOsMemoryProviderOps(), &osParams});
+                                      umfOsMemoryProviderOps(), &osParams,
+                                      nullptr});
 #else
     std::cout << "skipping disjoint_pool mt_alloc_free" << std::endl;
 #endif

test/memoryPoolAPI.cpp

@@ -181,14 +181,16 @@ TEST_F(test, BasicPoolByPtrTest) {
 INSTANTIATE_TEST_SUITE_P(
     mallocPoolTest, umfPoolTest,
     ::testing::Values(poolCreateExtParams{&MALLOC_POOL_OPS, nullptr,
-                                          &UMF_NULL_PROVIDER_OPS, nullptr},
+                                          &UMF_NULL_PROVIDER_OPS, nullptr,
+                                          nullptr},
                       poolCreateExtParams{umfProxyPoolOps(), nullptr,
-                                          &MALLOC_PROVIDER_OPS, nullptr}));
+                                          &MALLOC_PROVIDER_OPS, nullptr,
+                                          nullptr}));
 
 INSTANTIATE_TEST_SUITE_P(mallocMultiPoolTest, umfMultiPoolTest,
                          ::testing::Values(poolCreateExtParams{
                              umfProxyPoolOps(), nullptr, &MALLOC_PROVIDER_OPS,
-                             nullptr}));
+                             nullptr, nullptr}));
 
 INSTANTIATE_TEST_SUITE_P(umfPoolWithCreateFlagsTest, umfPoolWithCreateFlagsTest,
                          ::testing::Values(0,

test/poolFixtures.hpp

@@ -2,11 +2,12 @@
 // Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-#ifndef UMF_TEST_MEMORY_POOL_OPS_HPP
-#define UMF_TEST_MEMORY_POOL_OPS_HPP
+#ifndef UMF_TEST_POOL_FIXTURES_HPP
+#define UMF_TEST_POOL_FIXTURES_HPP 1
 
 #include "pool.hpp"
 #include "provider.hpp"
+#include "umf/providers/provider_coarse.h"
 
 #include <array>
 #include <cstring>
@@ -17,18 +18,34 @@
 
 #include "../malloc_compliance_tests.hpp"
 
-using poolCreateExtParams = std::tuple<umf_memory_pool_ops_t *, void *,
-                                       umf_memory_provider_ops_t *, void *>;
+using poolCreateExtParams =
+    std::tuple<umf_memory_pool_ops_t *, void *, umf_memory_provider_ops_t *,
+               void *, void *>;
 
 umf::pool_unique_handle_t poolCreateExtUnique(poolCreateExtParams params) {
     umf_memory_pool_handle_t hPool;
-    auto [pool_ops, pool_params, provider_ops, provider_params] = params;
+    auto [pool_ops, pool_params, provider_ops, provider_params, coarse_params] =
+        params;
 
     umf_memory_provider_handle_t provider = nullptr;
     auto ret =
         umfMemoryProviderCreate(provider_ops, provider_params, &provider);
     EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
 
+    if (coarse_params) {
+        coarse_memory_provider_params_t *coarse_memory_provider_params =
+            (coarse_memory_provider_params_t *)coarse_params;
+        coarse_memory_provider_params->upstream_memory_provider = provider;
+        coarse_memory_provider_params->destroy_upstream_memory_provider = true;
+
+        umf_memory_provider_handle_t coarse_provider = nullptr;
+        auto ret = umfMemoryProviderCreate(umfCoarseMemoryProviderOps(),
+                                           coarse_params, &coarse_provider);
+        EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
+
+        provider = coarse_provider;
+    }
+
     ret = umfPoolCreate(pool_ops, provider, pool_params,
                         UMF_POOL_CREATE_FLAG_OWN_PROVIDER, &hPool);
     EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
@@ -407,4 +424,4 @@ TEST_P(umfPoolTest, realloc_compliance) {
 
 TEST_P(umfPoolTest, free_compliance) { free_compliance_test(pool.get()); }
 
-#endif /* UMF_TEST_MEMORY_POOL_OPS_HPP */
+#endif /* UMF_TEST_POOL_FIXTURES_HPP */

test/pools/disjoint_pool.cpp

@@ -148,17 +148,17 @@ auto defaultPoolConfig = poolConfig();
 INSTANTIATE_TEST_SUITE_P(disjointPoolTests, umfPoolTest,
                          ::testing::Values(poolCreateExtParams{
                              umfDisjointPoolOps(), (void *)&defaultPoolConfig,
-                             &MALLOC_PROVIDER_OPS, nullptr}));
+                             &MALLOC_PROVIDER_OPS, nullptr, nullptr}));
 
 INSTANTIATE_TEST_SUITE_P(
     disjointPoolTests, umfMemTest,
     ::testing::Values(std::make_tuple(
         poolCreateExtParams{umfDisjointPoolOps(), (void *)&defaultPoolConfig,
                             &MOCK_OUT_OF_MEM_PROVIDER_OPS,
-                            (void *)&defaultPoolConfig.Capacity},
+                            (void *)&defaultPoolConfig.Capacity, nullptr},
         static_cast<int>(defaultPoolConfig.Capacity) / 2)));
 
 INSTANTIATE_TEST_SUITE_P(disjointMultiPoolTests, umfMultiPoolTest,
                          ::testing::Values(poolCreateExtParams{
                              umfDisjointPoolOps(), (void *)&defaultPoolConfig,
-                             &MALLOC_PROVIDER_OPS, nullptr}));
+                             &MALLOC_PROVIDER_OPS, nullptr, nullptr}));

test/pools/jemalloc_pool.cpp

@@ -15,7 +15,8 @@ auto defaultParams = umfOsMemoryProviderParamsDefault();
 INSTANTIATE_TEST_SUITE_P(jemallocPoolTest, umfPoolTest,
                          ::testing::Values(poolCreateExtParams{
                              umfJemallocPoolOps(), nullptr,
-                             umfOsMemoryProviderOps(), &defaultParams}));
+                             umfOsMemoryProviderOps(), &defaultParams,
+                             nullptr}));
 
 // this test makes sure that jemalloc does not use
 // memory provider to allocate metadata (and hence
@@ -30,8 +31,9 @@ TEST_F(test, metadataNotAllocatedUsingProvider) {
     auto params = umfOsMemoryProviderParamsDefault();
     params.protection = UMF_PROTECTION_NONE;
 
-    auto pool = poolCreateExtUnique(
-        {umfJemallocPoolOps(), nullptr, umfOsMemoryProviderOps(), &params});
+    auto pool =
+        poolCreateExtUnique({umfJemallocPoolOps(), nullptr,
+                             umfOsMemoryProviderOps(), &params, nullptr});
 
     std::vector<std::shared_ptr<void>> allocs;
     for (size_t i = 0; i < numAllocs; i++) {

test/pools/pool_base_alloc.cpp

@@ -48,4 +48,4 @@ umf_memory_pool_ops_t BA_POOL_OPS = umf::poolMakeCOps<base_alloc_pool, void>();
 INSTANTIATE_TEST_SUITE_P(baPool, umfPoolTest,
                          ::testing::Values(poolCreateExtParams{
                              &BA_POOL_OPS, nullptr,
-                             &umf_test::BASE_PROVIDER_OPS, nullptr}));
+                             &umf_test::BASE_PROVIDER_OPS, nullptr, nullptr}));

test/pools/scalable_pool.cpp

@@ -12,4 +12,5 @@ auto defaultParams = umfOsMemoryProviderParamsDefault();
 INSTANTIATE_TEST_SUITE_P(scalablePoolTest, umfPoolTest,
                          ::testing::Values(poolCreateExtParams{
                              umfScalablePoolOps(), nullptr,
-                             umfOsMemoryProviderOps(), &defaultParams}));
+                             umfOsMemoryProviderOps(), &defaultParams,
+                             nullptr}));