Skip to content

Commit b0cdd84

Browse files
committed
[disjoint] Set default parameters for disjoint pool
1 parent cde4cb8 commit b0cdd84

File tree

4 files changed

+68
-6
lines changed

4 files changed

+68
-6
lines changed

include/umf/pools/pool_disjoint.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ umf_result_t
5252
umfDisjointPoolParamsDestroy(umf_disjoint_pool_params_handle_t hParams);
5353

5454
/// @brief Set minimum allocation size that will be requested from the memory provider.
55+
/// @details Default value for minimum size of slab's is 64KB.
5556
/// @param hParams handle to the parameters of the disjoint pool.
5657
/// @param slabMinSize minimum allocation size.
5758
/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
@@ -60,6 +61,7 @@ umfDisjointPoolParamsSetSlabMinSize(umf_disjoint_pool_params_handle_t hParams,
6061
size_t slabMinSize);
6162

6263
/// @brief Set size limit for allocations that are subject to pooling.
64+
/// @details Default value for maximum poolable size is 2MB.
6365
/// @param hParams handle to the parameters of the disjoint pool.
6466
/// @param maxPoolableSize maximum poolable size.
6567
/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.
@@ -68,6 +70,7 @@ umf_result_t umfDisjointPoolParamsSetMaxPoolableSize(
6870

6971
/// @brief Set maximum capacity of each bucket. Each bucket will hold a
7072
/// max of \p maxCapacity unfreed slabs.
73+
/// @details Default value for capacity is 4.
7174
/// @param hParams handle to the parameters of the disjoint pool.
7275
/// @param maxCapacity maximum capacity of each bucket.
7376
/// @return UMF_RESULT_SUCCESS on success or appropriate error code on failure.

src/pool/pool_disjoint.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1085,9 +1085,9 @@ umfDisjointPoolParamsCreate(umf_disjoint_pool_params_handle_t *hParams) {
10851085
}
10861086

10871087
*params = (umf_disjoint_pool_params_t){
1088-
.slab_min_size = 0,
1089-
.max_poolable_size = 0,
1090-
.capacity = 0,
1088+
.slab_min_size = 64 * 1024, // 64K
1089+
.max_poolable_size = 2 * 1024 * 1024, // 2MB
1090+
.capacity = 4,
10911091
.min_bucket_size = UMF_DISJOINT_POOL_MIN_BUCKET_DEFAULT_SIZE,
10921092
.cur_pool_size = 0,
10931093
.pool_trace = 0,

src/pool/pool_disjoint_internal.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,13 +110,13 @@ typedef struct umf_disjoint_pool_shared_limits_t {
110110

111111
typedef struct umf_disjoint_pool_params_t {
112112
// Minimum allocation size that will be requested from the memory provider.
113-
size_t slab_min_size;
113+
size_t slab_min_size; // Default: 64KB
114114

115115
// Allocations up to this limit will be subject to chunking/pooling
116-
size_t max_poolable_size;
116+
size_t max_poolable_size; // Default: 2MB
117117

118118
// When pooling, each bucket will hold a max of 'capacity' unfreed slabs
119-
size_t capacity;
119+
size_t capacity; // Default: 4
120120

121121
// Holds the minimum bucket size valid for allocation of a memory type.
122122
// This value must be a power of 2.

test/pools/disjoint_pool.cpp

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,65 @@ TEST_F(test, disjointPoolName) {
356356
umfDisjointPoolParamsDestroy(params);
357357
}
358358

359+
TEST_F(test, disjointPoolDefaultParams) {
360+
umf_disjoint_pool_params_handle_t params = nullptr;
361+
umf_memory_pool_handle_t pool = nullptr;
362+
umf_memory_provider_handle_t provider_handle = nullptr;
363+
364+
// Create disjoint pool parameters with default settings
365+
umf_result_t res = umfDisjointPoolParamsCreate(&params);
366+
EXPECT_EQ(res, UMF_RESULT_SUCCESS);
367+
368+
static int free_counter = 0;
369+
struct memory_provider : public umf_test::provider_base_t {
370+
umf_result_t alloc(size_t size, size_t alignment, void **ptr) noexcept {
371+
printf("Allocating %zu bytes with alignment %zu\n", size,
372+
alignment);
373+
*ptr = umf_ba_global_aligned_alloc(size, alignment);
374+
return UMF_RESULT_SUCCESS;
375+
}
376+
377+
umf_result_t free(void *ptr, [[maybe_unused]] size_t size) noexcept {
378+
// do the actual free only when we expect the success
379+
printf("Freeing memory at %p\n", ptr);
380+
umf_ba_global_free(ptr);
381+
free_counter++;
382+
return UMF_RESULT_SUCCESS;
383+
}
384+
};
385+
386+
umf_memory_provider_ops_t provider_ops =
387+
umf_test::providerMakeCOps<memory_provider, void>();
388+
389+
auto providerUnique =
390+
wrapProviderUnique(createProviderChecked(&provider_ops, nullptr));
391+
provider_handle = providerUnique.get();
392+
393+
umf_result_t ret = umfPoolCreate(umfDisjointPoolOps(), provider_handle,
394+
params, UMF_POOL_CREATE_FLAG_NONE, &pool);
395+
ASSERT_EQ(ret, UMF_RESULT_SUCCESS);
396+
397+
// Test allocation and deallocation
398+
// This will use the default disjoint pool parameters
399+
void *ptr = umfPoolMalloc(pool, 64);
400+
ASSERT_NE(ptr, nullptr);
401+
ret = umfPoolFree(pool, ptr);
402+
ASSERT_EQ(ret, UMF_RESULT_SUCCESS);
403+
ASSERT_EQ(free_counter, 0);
404+
405+
// Test allocation and deallocation with a different size
406+
ptr = umfPoolMalloc(pool, 4 * 1024 * 1024);
407+
ASSERT_NE(ptr, nullptr);
408+
ret = umfPoolFree(pool, ptr);
409+
ASSERT_EQ(ret, UMF_RESULT_SUCCESS);
410+
ASSERT_EQ(free_counter, 1);
411+
412+
// Cleaning up
413+
umfPoolDestroy(pool);
414+
umfDisjointPoolParamsDestroy(params);
415+
ASSERT_EQ(free_counter, 2);
416+
}
417+
359418
INSTANTIATE_TEST_SUITE_P(disjointPoolTests, umfPoolTest,
360419
::testing::Values(poolCreateExtParams{
361420
umfDisjointPoolOps(), defaultDisjointPoolConfig,

0 commit comments

Comments
 (0)