Skip to content

Add IPC tests (umfIpcTest) to the devdax provider #845

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 3 commits into from
Nov 4, 2024
Merged

Add IPC tests (umfIpcTest) to the devdax provider #845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff242b7
Make error messages in utils_mmap_file() more verbose
ldorau Oct 28, 2024
ed0332a
Enable running umfIpcTest tests when free() is not supported
ldorau Oct 28, 2024
486b3e4
Add IPC tests (umfIpcTest) to the devdax provider
ldorau Nov 4, 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
12 changes: 9 additions & 3 deletions src/utils/utils_linux_common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ void *utils_mmap_file(void *hint_addr, size_t length, int prot, int flags,
if (flags & MAP_PRIVATE) {
addr = utils_mmap(hint_addr, length, prot, flags, fd, fd_offset);
if (addr == MAP_FAILED) {
LOG_PERR("mapping file with the MAP_PRIVATE flag failed");
LOG_PERR("mapping file with the MAP_PRIVATE flag failed (fd=%i, "
"offset=%zu, length=%zu)",
fd, fd_offset, length);
return NULL;
}

Expand All @@ -81,7 +83,9 @@ void *utils_mmap_file(void *hint_addr, size_t length, int prot, int flags,
return addr;
}

LOG_PERR("mapping file with the MAP_SYNC flag failed");
LOG_PERR("mapping file with the MAP_SYNC flag failed (fd=%i, "
"offset=%zu, length=%zu)",
fd, fd_offset, length);
}

if ((!(flags & MAP_SYNC)) || errno == EINVAL || errno == ENOTSUP ||
Expand All @@ -96,7 +100,9 @@ void *utils_mmap_file(void *hint_addr, size_t length, int prot, int flags,
return addr;
}

LOG_PERR("mapping file with the MAP_SHARED flag failed");
LOG_PERR("mapping file with the MAP_SHARED flag failed (fd=%i, "
"offset=%zu, length=%zu)",
fd, fd_offset, length);
}

return NULL;
Expand Down
16 changes: 15 additions & 1 deletion test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,16 @@ function(build_umf_test)
SRCS ${ARG_SRCS}
LIBS ${TEST_LIBS})

if(UMF_POOL_JEMALLOC_ENABLED)
target_compile_definitions(${TEST_TARGET_NAME}
PRIVATE UMF_POOL_JEMALLOC_ENABLED=1)
endif()

if(UMF_POOL_SCALABLE_ENABLED)
target_compile_definitions(${TEST_TARGET_NAME}
PRIVATE UMF_POOL_SCALABLE_ENABLED=1)
endif()

if(NOT MSVC)
# Suppress 'cast discards const qualifier' warnings. Parametrized GTEST
# tests retrieve arguments using 'GetParam()', which applies a 'const'
Expand Down Expand Up @@ -136,6 +146,10 @@ if(UMF_BUILD_SHARED_LIBRARY)
endif()
endif()

if(UMF_POOL_JEMALLOC_ENABLED)
set(LIB_JEMALLOC_POOL jemalloc_pool)
endif()

add_umf_test(NAME base SRCS base.cpp)
add_umf_test(
NAME memoryPool
Expand Down Expand Up @@ -253,7 +267,7 @@ if(LINUX AND (NOT UMF_DISABLE_HWLOC)) # OS-specific functions are implemented
add_umf_test(
NAME provider_devdax_memory
SRCS provider_devdax_memory.cpp
LIBS ${UMF_UTILS_FOR_TEST})
LIBS ${UMF_UTILS_FOR_TEST} ${LIB_JEMALLOC_POOL})
add_umf_test(
NAME provider_file_memory
SRCS provider_file_memory.cpp
Expand Down
2 changes: 1 addition & 1 deletion test/ipcAPI.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@ HostMemoryAccessor hostMemoryAccessor;
INSTANTIATE_TEST_SUITE_P(umfIpcTestSuite, umfIpcTest,
::testing::Values(ipcTestParams{
umfProxyPoolOps(), nullptr, &IPC_MOCK_PROVIDER_OPS,
nullptr, &hostMemoryAccessor}));
nullptr, &hostMemoryAccessor, false}));
50 changes: 37 additions & 13 deletions test/ipcFixtures.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,22 +46,26 @@ class HostMemoryAccessor : public MemoryAccessor {
}
};

// ipcTestParams:
// pool_ops, pool_params, provider_ops, provider_params, memoryAccessor, free_not_supp
// free_not_supp (bool) - provider does not support the free() op
using ipcTestParams =
std::tuple<umf_memory_pool_ops_t *, void *, umf_memory_provider_ops_t *,
void *, MemoryAccessor *>;
void *, MemoryAccessor *, bool>;

struct umfIpcTest : umf_test::test,
::testing::WithParamInterface<ipcTestParams> {
umfIpcTest() {}
void SetUp() override {
test::SetUp();
auto [pool_ops, pool_params, provider_ops, provider_params, accessor] =
this->GetParam();
auto [pool_ops, pool_params, provider_ops, provider_params, accessor,
free_not_supp] = this->GetParam();
poolOps = pool_ops;
poolParams = pool_params;
providerOps = provider_ops;
providerParams = provider_params;
memAccessor = accessor;
freeNotSupported = free_not_supp;
}

void TearDown() override { test::TearDown(); }
Expand Down Expand Up @@ -120,8 +124,18 @@ struct umfIpcTest : umf_test::test,
void *poolParams = nullptr;
umf_memory_provider_ops_t *providerOps = nullptr;
void *providerParams = nullptr;
bool freeNotSupported = false;
};

static inline umf_result_t
get_umf_result_of_free(bool freeNotSupported, umf_result_t expected_result) {
if (freeNotSupported) {
return UMF_RESULT_ERROR_NOT_SUPPORTED;
}

return expected_result;
}

TEST_P(umfIpcTest, GetIPCHandleSize) {
size_t size = 0;
umf::pool_unique_handle_t pool = makePool();
Expand Down Expand Up @@ -163,7 +177,8 @@ TEST_P(umfIpcTest, GetIPCHandleInvalidArgs) {
EXPECT_EQ(ret, UMF_RESULT_ERROR_INVALID_ARGUMENT);

ret = umfFree(ptr);
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
EXPECT_EQ(ret,
get_umf_result_of_free(freeNotSupported, UMF_RESULT_SUCCESS));
}

TEST_P(umfIpcTest, BasicFlow) {
Expand Down Expand Up @@ -218,7 +233,8 @@ TEST_P(umfIpcTest, BasicFlow) {
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);

ret = umfPoolFree(pool.get(), ptr);
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
EXPECT_EQ(ret,
get_umf_result_of_free(freeNotSupported, UMF_RESULT_SUCCESS));

pool.reset(nullptr);
EXPECT_EQ(stat.getCount, 1);
Expand Down Expand Up @@ -282,7 +298,8 @@ TEST_P(umfIpcTest, GetPoolByOpenedHandle) {

for (size_t i = 0; i < NUM_ALLOCS; ++i) {
umf_result_t ret = umfFree(ptrs[i]);
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
EXPECT_EQ(ret,
get_umf_result_of_free(freeNotSupported, UMF_RESULT_SUCCESS));
}
}

Expand All @@ -308,7 +325,8 @@ TEST_P(umfIpcTest, AllocFreeAllocTest) {
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);

ret = umfPoolFree(pool.get(), ptr);
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
EXPECT_EQ(ret,
get_umf_result_of_free(freeNotSupported, UMF_RESULT_SUCCESS));

ptr = umfPoolMalloc(pool.get(), SIZE);
ASSERT_NE(ptr, nullptr);
Expand All @@ -330,12 +348,15 @@ TEST_P(umfIpcTest, AllocFreeAllocTest) {
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);

ret = umfPoolFree(pool.get(), ptr);
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
EXPECT_EQ(ret,
get_umf_result_of_free(freeNotSupported, UMF_RESULT_SUCCESS));

pool.reset(nullptr);
EXPECT_EQ(stat.allocCount, stat.getCount);
// TODO fix it - it does not work in case of IPC cache hit
// EXPECT_EQ(stat.allocCount, stat.getCount);
EXPECT_EQ(stat.getCount, stat.putCount);
EXPECT_EQ(stat.openCount, stat.getCount);
// TODO fix it - it does not work in case of IPC cache hit
// EXPECT_EQ(stat.openCount, stat.getCount);
EXPECT_EQ(stat.openCount, stat.closeCount);
}

Expand Down Expand Up @@ -382,7 +403,8 @@ TEST_P(umfIpcTest, openInTwoPools) {
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);

ret = umfPoolFree(pool1.get(), ptr);
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
EXPECT_EQ(ret,
get_umf_result_of_free(freeNotSupported, UMF_RESULT_SUCCESS));

pool1.reset(nullptr);
pool2.reset(nullptr);
Expand Down Expand Up @@ -433,7 +455,8 @@ TEST_P(umfIpcTest, ConcurrentGetPutHandles) {

for (void *ptr : ptrs) {
umf_result_t ret = umfPoolFree(pool.get(), ptr);
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
EXPECT_EQ(ret,
get_umf_result_of_free(freeNotSupported, UMF_RESULT_SUCCESS));
}

pool.reset(nullptr);
Expand Down Expand Up @@ -495,7 +518,8 @@ TEST_P(umfIpcTest, ConcurrentOpenCloseHandles) {

for (void *ptr : ptrs) {
umf_result_t ret = umfPoolFree(pool.get(), ptr);
EXPECT_EQ(ret, UMF_RESULT_SUCCESS);
EXPECT_EQ(ret,
get_umf_result_of_free(freeNotSupported, UMF_RESULT_SUCCESS));
}

pool.reset(nullptr);
Expand Down
50 changes: 48 additions & 2 deletions test/provider_devdax_memory.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,17 @@
#include "base.hpp"

#include "cpp_helpers.hpp"
#include "ipcFixtures.hpp"
#include "test_helpers.h"

#include <umf/memory_provider.h>
#include <umf/providers/provider_devdax_memory.h>
#ifdef UMF_POOL_JEMALLOC_ENABLED
#include <umf/pools/pool_jemalloc.h>
#endif
#ifdef UMF_POOL_SCALABLE_ENABLED
#include <umf/pools/pool_scalable.h>
#endif

using umf_test::test;

Expand Down Expand Up @@ -179,14 +186,15 @@ TEST_F(test, test_if_mapped_with_MAP_SYNC) {

// positive tests using test_alloc_free_success

auto defaultParams = umfDevDaxMemoryProviderParamsDefault(
auto defaultDevDaxParams = umfDevDaxMemoryProviderParamsDefault(
getenv("UMF_TESTS_DEVDAX_PATH"),
atol(getenv("UMF_TESTS_DEVDAX_SIZE") ? getenv("UMF_TESTS_DEVDAX_SIZE")
: "0"));

INSTANTIATE_TEST_SUITE_P(devdaxProviderTest, umfProviderTest,
::testing::Values(providerCreateExtParams{
umfDevDaxMemoryProviderOps(), &defaultParams}));
umfDevDaxMemoryProviderOps(),
&defaultDevDaxParams}));

TEST_P(umfProviderTest, create_destroy) {}

Expand Down Expand Up @@ -349,3 +357,41 @@ TEST_F(test, create_wrong_size_0) {
EXPECT_EQ(ret, UMF_RESULT_ERROR_INVALID_ARGUMENT);
EXPECT_EQ(hProvider, nullptr);
}

HostMemoryAccessor hostAccessor;

static std::vector<ipcTestParams> getIpcProxyPoolTestParamsList(void) {
std::vector<ipcTestParams> ipcProxyPoolTestParamsList = {};

char *path = getenv("UMF_TESTS_DEVDAX_PATH");
if (path == nullptr || path[0] == 0) {
// Test skipped, UMF_TESTS_DEVDAX_PATH is not set
return ipcProxyPoolTestParamsList;
}

char *size = getenv("UMF_TESTS_DEVDAX_SIZE");
if (size == nullptr || size[0] == 0) {
// Test skipped, UMF_TESTS_DEVDAX_PATH is not set
return ipcProxyPoolTestParamsList;
}

ipcProxyPoolTestParamsList = {
{umfProxyPoolOps(), nullptr, umfDevDaxMemoryProviderOps(),
&defaultDevDaxParams, &hostAccessor, true},
#ifdef UMF_POOL_JEMALLOC_ENABLED
{umfJemallocPoolOps(), nullptr, umfDevDaxMemoryProviderOps(),
&defaultDevDaxParams, &hostAccessor, false},
#endif
#ifdef UMF_POOL_SCALABLE_ENABLED
{umfScalablePoolOps(), nullptr, umfDevDaxMemoryProviderOps(),
&defaultDevDaxParams, &hostAccessor, false},
#endif
};

return ipcProxyPoolTestParamsList;
}

GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(umfIpcTest);

INSTANTIATE_TEST_SUITE_P(DevDaxProviderDifferentPoolsTest, umfIpcTest,
::testing::ValuesIn(getIpcProxyPoolTestParamsList()));
2 changes: 1 addition & 1 deletion test/provider_os_memory.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ umf_disjoint_pool_params_t disjointParams = disjointPoolParams();
static std::vector<ipcTestParams> ipcTestParamsList = {
#if (defined UMF_POOL_DISJOINT_ENABLED)
{umfDisjointPoolOps(), &disjointParams, umfOsMemoryProviderOps(),
&os_params, &hostAccessor},
&os_params, &hostAccessor, false},
#endif
};

Expand Down
2 changes: 1 addition & 1 deletion test/providers/provider_level_zero.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,5 +332,5 @@ INSTANTIATE_TEST_SUITE_P(umfLevelZeroProviderTestSuite, umfIpcTest,
::testing::Values(ipcTestParams{
umfProxyPoolOps(), nullptr,
umfLevelZeroMemoryProviderOps(),
&l0Params_device_memory, &l0Accessor}));
&l0Params_device_memory, &l0Accessor, false}));
#endif
Loading