Skip to content

Add parameter to destroy upstream_memory_provider in finalize() #806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Add parameter to destroy upstream_memory_provider in finalize() #806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions include/umf/providers/provider_coarse.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ typedef struct coarse_memory_provider_params_t {
/// the init_buffer is always used instead
/// (regardless of the value of this parameter).
bool immediate_init_from_upstream;

/// Destroy upstream_memory_provider in finalize().
bool destroy_upstream_memory_provider;
} coarse_memory_provider_params_t;

/// @brief Coarse Memory Provider stats (TODO move to CTL)
Expand Down
17 changes: 17 additions & 0 deletions src/provider/provider_coarse.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@
typedef struct coarse_memory_provider_t {
umf_memory_provider_handle_t upstream_memory_provider;

// destroy upstream_memory_provider in finalize()
bool destroy_upstream_memory_provider;

// memory allocation strategy
coarse_memory_provider_strategy_t allocation_strategy;

Expand Down Expand Up @@ -898,6 +901,13 @@ static umf_result_t coarse_memory_provider_initialize(void *params,
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}

if (coarse_params->destroy_upstream_memory_provider &&
!coarse_params->upstream_memory_provider) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the coarse provider always require the upstream provider to be specified?

What is the reason for not specifying the upstream provider? @bratpiorka what do you think?

P.S. I understand that it is out of scope for this particular PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The coarse provider contains the fixed provider yet - in the case of the fixed provider the upstream provider is not required. The fixed provider will be moved to a separate provider and the upstream provider will be always required then.

LOG_ERR("destroy_upstream_memory_provider is true, but an upstream "
"provider is not provided");
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}

coarse_memory_provider_t *coarse_provider =
umf_ba_global_alloc(sizeof(*coarse_provider));
if (!coarse_provider) {
Expand All @@ -909,6 +919,8 @@ static umf_result_t coarse_memory_provider_initialize(void *params,

coarse_provider->upstream_memory_provider =
coarse_params->upstream_memory_provider;
coarse_provider->destroy_upstream_memory_provider =
coarse_params->destroy_upstream_memory_provider;
coarse_provider->allocation_strategy = coarse_params->allocation_strategy;
coarse_provider->init_buffer = coarse_params->init_buffer;

Expand Down Expand Up @@ -1081,6 +1093,11 @@ static void coarse_memory_provider_finalize(void *provider) {

umf_ba_global_free(coarse_provider->name);

if (coarse_provider->destroy_upstream_memory_provider &&
coarse_provider->upstream_memory_provider) {
umfMemoryProviderDestroy(coarse_provider->upstream_memory_provider);
}

umf_ba_global_free(coarse_provider);
}

Expand Down
45 changes: 41 additions & 4 deletions test/disjointCoarseMallocPool.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ TEST_F(test, disjointCoarseMallocPool_name_upstream) {
sizeof(coarse_memory_provider_params));
coarse_memory_provider_params.upstream_memory_provider =
malloc_memory_provider;
coarse_memory_provider_params.destroy_upstream_memory_provider = true;
coarse_memory_provider_params.immediate_init_from_upstream = true;
coarse_memory_provider_params.init_buffer = nullptr;
coarse_memory_provider_params.init_buffer_size = init_buffer_size;
Expand All @@ -75,7 +76,9 @@ TEST_F(test, disjointCoarseMallocPool_name_upstream) {
0);

umfMemoryProviderDestroy(coarse_memory_provider);
umfMemoryProviderDestroy(malloc_memory_provider);
// malloc_memory_provider has already been destroyed
// by umfMemoryProviderDestroy(coarse_memory_provider), because:
// coarse_memory_provider_params.destroy_upstream_memory_provider = true;
}

TEST_F(test, disjointCoarseMallocPool_name_no_upstream) {
Expand Down Expand Up @@ -129,6 +132,7 @@ TEST_P(CoarseWithMemoryStrategyTest, disjointCoarseMallocPool_basic) {
coarse_memory_provider_params.allocation_strategy = allocation_strategy;
coarse_memory_provider_params.upstream_memory_provider =
malloc_memory_provider;
coarse_memory_provider_params.destroy_upstream_memory_provider = true;
coarse_memory_provider_params.immediate_init_from_upstream = true;
coarse_memory_provider_params.init_buffer = nullptr;
coarse_memory_provider_params.init_buffer_size = init_buffer_size;
Expand All @@ -150,7 +154,7 @@ TEST_P(CoarseWithMemoryStrategyTest, disjointCoarseMallocPool_basic) {
umf_memory_pool_handle_t pool;
umf_result = umfPoolCreate(umfDisjointPoolOps(), coarse_memory_provider,
&disjoint_memory_pool_params,
UMF_POOL_CREATE_FLAG_NONE, &pool);
UMF_POOL_CREATE_FLAG_OWN_PROVIDER, &pool);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
ASSERT_NE(pool, nullptr);

Expand Down Expand Up @@ -282,8 +286,10 @@ TEST_P(CoarseWithMemoryStrategyTest, disjointCoarseMallocPool_basic) {
ASSERT_EQ(GetStats(prov).alloc_size, init_buffer_size);

umfPoolDestroy(pool);
umfMemoryProviderDestroy(coarse_memory_provider);
umfMemoryProviderDestroy(malloc_memory_provider);
// Both coarse_memory_provider and malloc_memory_provider
// have already been destroyed by umfPoolDestroy(), because:
// UMF_POOL_CREATE_FLAG_OWN_PROVIDER was set in umfPoolCreate() and
// coarse_memory_provider_params.destroy_upstream_memory_provider = true;
}

TEST_P(CoarseWithMemoryStrategyTest, disjointCoarseMallocPool_simple1) {
Expand Down Expand Up @@ -760,6 +766,37 @@ TEST_P(CoarseWithMemoryStrategyTest, disjointCoarseMallocPool_wrong_params_4) {
umfMemoryProviderDestroy(malloc_memory_provider);
}

// wrong parameters: destroy_upstream_memory_provider is true, but an upstream provider is not provided
TEST_P(CoarseWithMemoryStrategyTest, disjointCoarseMallocPool_wrong_params_5) {
umf_result_t umf_result;

const size_t init_buffer_size = 20 * MB;

// Preallocate some memory
std::unique_ptr<char[]> buffer(new char[init_buffer_size]);
void *buf = buffer.get();
ASSERT_NE(buf, nullptr);
memset(buf, 0, init_buffer_size);

coarse_memory_provider_params_t coarse_memory_provider_params;
// make sure there are no undefined members - prevent a UB
memset(&coarse_memory_provider_params, 0,
sizeof(coarse_memory_provider_params));
coarse_memory_provider_params.allocation_strategy = allocation_strategy;
coarse_memory_provider_params.upstream_memory_provider = nullptr;
coarse_memory_provider_params.destroy_upstream_memory_provider = true;
coarse_memory_provider_params.immediate_init_from_upstream = false;
coarse_memory_provider_params.init_buffer = buf;
coarse_memory_provider_params.init_buffer_size = init_buffer_size;

umf_memory_provider_handle_t coarse_memory_provider = nullptr;
umf_result = umfMemoryProviderCreate(umfCoarseMemoryProviderOps(),
&coarse_memory_provider_params,
&coarse_memory_provider);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);
ASSERT_EQ(coarse_memory_provider, nullptr);
}

TEST_P(CoarseWithMemoryStrategyTest, disjointCoarseMallocPool_split_merge) {
umf_memory_provider_handle_t malloc_memory_provider;
umf_result_t umf_result;
Expand Down
Loading