Skip to content

Implement purge_lazy/_force() API of the Coarse provider #780

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 2 commits into from
Oct 23, 2024
Merged

Implement purge_lazy/_force() API of the Coarse provider #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45806bb
Implement purge_lazy/_force() API of the Coarse provider
ldorau Oct 22, 2024
c878ed4
Add tests for purge_lazy/_force() of Coarse provider
ldorau Oct 22, 2024
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
38 changes: 36 additions & 2 deletions src/provider/provider_coarse.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1535,6 +1535,40 @@ coarse_memory_provider_get_stats(void *provider,
return UMF_RESULT_SUCCESS;
}

static umf_result_t coarse_memory_provider_purge_lazy(void *provider, void *ptr,
size_t size) {
if (provider == NULL || ptr == NULL) {
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}

coarse_memory_provider_t *coarse_provider =
(struct coarse_memory_provider_t *)provider;
if (coarse_provider->upstream_memory_provider == NULL) {
LOG_ERR("no upstream memory provider given");
return UMF_RESULT_ERROR_NOT_SUPPORTED;
}

return umfMemoryProviderPurgeLazy(coarse_provider->upstream_memory_provider,
ptr, size);
}

static umf_result_t coarse_memory_provider_purge_force(void *provider,
void *ptr, size_t size) {
if (provider == NULL || ptr == NULL) {
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}

coarse_memory_provider_t *coarse_provider =
(struct coarse_memory_provider_t *)provider;
if (coarse_provider->upstream_memory_provider == NULL) {
LOG_ERR("no upstream memory provider given");
return UMF_RESULT_ERROR_NOT_SUPPORTED;
}

return umfMemoryProviderPurgeForce(
coarse_provider->upstream_memory_provider, ptr, size);
}

static umf_result_t coarse_memory_provider_allocation_split(void *provider,
void *ptr,
size_t totalSize,
Expand Down Expand Up @@ -1719,12 +1753,12 @@ umf_memory_provider_ops_t UMF_COARSE_MEMORY_PROVIDER_OPS = {
.get_min_page_size = coarse_memory_provider_get_min_page_size,
.get_name = coarse_memory_provider_get_name,
.ext.free = coarse_memory_provider_free,
.ext.purge_lazy = coarse_memory_provider_purge_lazy,
.ext.purge_force = coarse_memory_provider_purge_force,
.ext.allocation_merge = coarse_memory_provider_allocation_merge,
.ext.allocation_split = coarse_memory_provider_allocation_split,
// TODO
/*
.ext.purge_lazy = coarse_memory_provider_purge_lazy,
.ext.purge_force = coarse_memory_provider_purge_force,
.ipc.get_ipc_handle_size = coarse_memory_provider_get_ipc_handle_size,
.ipc.get_ipc_handle = coarse_memory_provider_get_ipc_handle,
.ipc.put_ipc_handle = coarse_memory_provider_put_ipc_handle,
Expand Down
123 changes: 123 additions & 0 deletions test/disjointCoarseMallocPool.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,3 +1004,126 @@ TEST_P(CoarseWithMemoryStrategyTest,
umfMemoryProviderDestroy(coarse_memory_provider);
umfMemoryProviderDestroy(malloc_memory_provider);
}

TEST_P(CoarseWithMemoryStrategyTest,
disjointCoarseMallocPool_purge_no_upstream) {
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.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_SUCCESS);
ASSERT_NE(coarse_memory_provider, nullptr);

// umfMemoryProviderPurgeLazy
// provider == NULL
umf_result = umfMemoryProviderPurgeLazy(nullptr, (void *)0x01, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);

// ptr == NULL
umf_result = umfMemoryProviderPurgeLazy(coarse_memory_provider, nullptr, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);

// no upstream_memory_provider
umf_result =
umfMemoryProviderPurgeLazy(coarse_memory_provider, (void *)0x01, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_NOT_SUPPORTED);

// umfMemoryProviderPurgeForce
// provider == NULL
umf_result = umfMemoryProviderPurgeForce(nullptr, (void *)0x01, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);

// ptr == NULL
umf_result =
umfMemoryProviderPurgeForce(coarse_memory_provider, nullptr, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);

// no upstream_memory_provider
umf_result =
umfMemoryProviderPurgeForce(coarse_memory_provider, (void *)0x01, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_NOT_SUPPORTED);

umfMemoryProviderDestroy(coarse_memory_provider);
}

TEST_P(CoarseWithMemoryStrategyTest,
disjointCoarseMallocPool_purge_with_upstream) {
umf_memory_provider_handle_t malloc_memory_provider;
umf_result_t umf_result;

umf_result = umfMemoryProviderCreate(&UMF_MALLOC_MEMORY_PROVIDER_OPS, NULL,
&malloc_memory_provider);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
ASSERT_NE(malloc_memory_provider, nullptr);

const size_t init_buffer_size = 20 * MB;

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.upstream_memory_provider =
malloc_memory_provider;
coarse_memory_provider_params.immediate_init_from_upstream = true;
coarse_memory_provider_params.init_buffer = NULL;
coarse_memory_provider_params.init_buffer_size = init_buffer_size;

umf_memory_provider_handle_t coarse_memory_provider;
umf_result = umfMemoryProviderCreate(umfCoarseMemoryProviderOps(),
&coarse_memory_provider_params,
&coarse_memory_provider);
ASSERT_EQ(umf_result, UMF_RESULT_SUCCESS);
ASSERT_NE(coarse_memory_provider, nullptr);

// umfMemoryProviderPurgeLazy
// provider == NULL
umf_result = umfMemoryProviderPurgeLazy(nullptr, (void *)0x01, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);

// ptr == NULL
umf_result = umfMemoryProviderPurgeLazy(coarse_memory_provider, nullptr, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);

// malloc_memory_provider returns UMF_RESULT_ERROR_UNKNOWN
umf_result =
umfMemoryProviderPurgeLazy(coarse_memory_provider, (void *)0x01, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_UNKNOWN);

// umfMemoryProviderPurgeForce
// provider == NULL
umf_result = umfMemoryProviderPurgeForce(nullptr, (void *)0x01, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);

// ptr == NULL
umf_result =
umfMemoryProviderPurgeForce(coarse_memory_provider, nullptr, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_INVALID_ARGUMENT);

// malloc_memory_provider returns UMF_RESULT_ERROR_UNKNOWN
umf_result =
umfMemoryProviderPurgeForce(coarse_memory_provider, (void *)0x01, 1);
ASSERT_EQ(umf_result, UMF_RESULT_ERROR_UNKNOWN);

umfMemoryProviderDestroy(coarse_memory_provider);
umfMemoryProviderDestroy(malloc_memory_provider);
}
Loading